FPGA2Model (LSST CCS - Rafts Subsystem Buses 1.12.1 API)

java.lang.Object
- org.lsst.ccs.subsystem.rafts.fpga.compiler.FPGA2Model

All Implemented Interfaces:

Serializable
```
public class FPGA2Model
extends Object
implements Serializable
```
The FPGA-specific model.

Author:

aubourg

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FPGA2Model.AddressAndValue

static class FPGA2Model.PointerInfo
Encapsulates information about a pointer.

Nested Classes
Modifier and Type	Class and Description
`static class`	`FPGA2Model.AddressAndValue`
`static class`	`FPGA2Model.PointerInfo` Encapsulates information about a pointer.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CMD_LINES`
`static int`	`CMD_PROGEND`
`static int`	`CMD_PROGFUNC`
`static int`	`CMD_PROGFUNC_FP`
`static int`	`CMD_PROGFUNC_FRP`
`static int`	`CMD_PROGFUNC_RP`
`static int`	`CMD_PROGJUMP`
`static int`	`CMD_PROGJUMP_AP`
`static int`	`CMD_PROGJUMP_ARP`
`static int`	`CMD_PROGJUMP_RP`
`static int`	`CMD_PROGSUBE`
`static int`	`CMD_TIME`

Constructor Summary

Constructors
Constructor and Description

FPGA2Model()

Constructors
Constructor and Description
`FPGA2Model()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dump()`
`Map<String,Integer>`	`getChannels()` Return the channels (a.k.a clocks) associated with this model
`List<int[]>`	`getCommands()` Dumps out the model in the format required by the rafts subsystem.
`Map<String,Integer>`	`getFunctionAddresses()` Return a map of all functions.
`Map<String,Integer>`	`getMainAddresses()` Return the list of addresses of all routines that are main.
`List<FPGA2Model.AddressAndValue>`	`getMemoryMap()` Returns the complete register memory map for this model.
`Map<String,String>`	`getMetadata()` Return the metadata (a.k.a.
`String`	`getMetadata(String key)`
`Set<String>`	`getMetadataKeys()`
`Map<String,FPGA2Model.PointerInfo>`	`getPointerMap()`
`List<FPGA2Model.PointerInfo>`	`getPointers()` Returns a list of pointer information, with kind, name and address.
`Map<String,Integer>`	`getSubroutineAddresses()` Return the list of addresses of all subroutines.
`void`	`validate()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CMD_LINES
```
public static final int CMD_LINES
```
    See Also:
    
    Constant Field Values
  - CMD_TIME
```
public static final int CMD_TIME
```
    See Also:
    
    Constant Field Values
  - CMD_PROGFUNC
```
public static final int CMD_PROGFUNC
```
    See Also:
    
    Constant Field Values
  - CMD_PROGJUMP
```
public static final int CMD_PROGJUMP
```
    See Also:
    
    Constant Field Values
  - CMD_PROGSUBE
```
public static final int CMD_PROGSUBE
```
    See Also:
    
    Constant Field Values
  - CMD_PROGEND
```
public static final int CMD_PROGEND
```
    See Also:
    
    Constant Field Values
  - CMD_PROGFUNC_FP
```
public static final int CMD_PROGFUNC_FP
```
    See Also:
    
    Constant Field Values
  - CMD_PROGFUNC_RP
```
public static final int CMD_PROGFUNC_RP
```
    See Also:
    
    Constant Field Values
  - CMD_PROGFUNC_FRP
```
public static final int CMD_PROGFUNC_FRP
```
    See Also:
    
    Constant Field Values
  - CMD_PROGJUMP_AP
```
public static final int CMD_PROGJUMP_AP
```
    See Also:
    
    Constant Field Values
  - CMD_PROGJUMP_RP
```
public static final int CMD_PROGJUMP_RP
```
    See Also:
    
    Constant Field Values
  - CMD_PROGJUMP_ARP
```
public static final int CMD_PROGJUMP_ARP
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FPGA2Model
```
public FPGA2Model()
```
- Method Detail
  - getPointers
```
public List<FPGA2Model.PointerInfo> getPointers()
```
    Returns a list of pointer information, with kind, name and address. Within each type the order in which the pointers appear corresponds to the order in which they were declared in the source file.
    
    Returns:
    
    A list of pointer information, with kind, name, address and value.
  - getPointerMap
```
public Map<String,FPGA2Model.PointerInfo> getPointerMap()
```
  - getMainAddresses
```
public Map<String,Integer> getMainAddresses()
```
    Return the list of addresses of all routines that are main.
    
    Returns:
    
    the map of name->addresses for all main routines. The order of the elements in the list is the same as the order the elements are declared in the file.
  - getSubroutineAddresses
```
public Map<String,Integer> getSubroutineAddresses()
```
    Return the list of addresses of all subroutines.
    
    Returns:
    
    the map of name->addresses for all subroutines. The order of the elements in the map returned is the order of the elements in the input file.
  - getFunctionAddresses
```
public Map<String,Integer> getFunctionAddresses()
```
    Return a map of all functions.
    
    Returns:
    
    the map of name->ordinal for all functions. The order of the functions within the map is the order they were declared in the input file.
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Return the metadata (a.k.a. constants or parameters) associated with this model
    
    Returns:
    
    An unmodifiable map of the metadata, in the form name->value. The order of the elements in the map is the order they appear in the input file. The value is as it appears in the input file (e.g. 2000 ns).
  - getChannels
```
public Map<String,Integer> getChannels()
```
    Return the channels (a.k.a clocks) associated with this model
    
    Returns:
    
    The map of channels, in the form name->value. The order of the elements in the map is the order they appeared in the input file.
  - getMetadataKeys
```
public Set<String> getMetadataKeys()
```
  - getMetadata
```
public String getMetadata(String key)
```
  - dump
```
public void dump()
```
  - getMemoryMap
```
public List<FPGA2Model.AddressAndValue> getMemoryMap()
```
    Returns the complete register memory map for this model. Note that this method is not currently used by the rafts subsystem, but can be used for loading the sequencer simulator for generating waveforms from the model.
    
    Returns:
    
    A complete list of AddressAndValue objects representing the memory map.
  - getCommands
```
public List<int[]> getCommands()
```
    Dumps out the model in the format required by the rafts subsystem.
    
    Returns:
  - validate
```
public void validate()
```

Class FPGA2Model

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CMD_LINES

CMD_TIME

CMD_PROGFUNC

CMD_PROGJUMP

CMD_PROGSUBE

CMD_PROGEND

CMD_PROGFUNC_FP

CMD_PROGFUNC_RP

CMD_PROGFUNC_FRP

CMD_PROGJUMP_AP

CMD_PROGJUMP_RP

CMD_PROGJUMP_ARP

Constructor Detail

FPGA2Model

Method Detail

getPointers

getPointerMap

getMainAddresses

getSubroutineAddresses

getFunctionAddresses

getMetadata

getChannels

getMetadataKeys

getMetadata

dump

getMemoryMap

getCommands

validate