Data Structures | Enumerations | Functions

base Namespace Reference

Data Structures

class  Board
class  BoardFactory
class  Gpio
 Device class with all GPIO access methods. More...
struct  Oper
class  OperList
class  Peripheral
 Base class to represent ROC peripherals. More...
class  Url

Enumerations

enum  ClientRole { roleNone = 0, roleObserver = 1, roleControl = 2, roleDAQ = 3 }
enum  EFrontendKinds {
  kind_nXYTER = 1, kind_oldFEET = 2, kind_FEET = 3, kind_newNX = 4,
  kind_SPADIC = 5
}
enum  EBackendKinds {
  kind_Optic = 1, kind_FX20 = 2, kind_FX40 = 3, kind_FX60 = 4,
  kind_newOptic = 5
}
enum  ETransportKinds { kind_UDP = 0, kind_ABB = 1, kind_File = 2, kind_USB = 3 }
enum  BasicAddresses { addr_HardwareType = 0x00, addr_HardwareVersion = 0x04, addr_BoardId = 0x10 }
enum  GpioRegisters {
  GPIO_CONFIG = 0x010000, GPIO_SYNCM_BAUD_START = 0x010100, GPIO_SYNCM_BAUD1 = 0x010104, GPIO_SYNCM_BAUD2 = 0x010108,
  GPIO_SYNCM_SCALEDOWN = 0x01010C, GPIO_SYNCS0_BAUD_START = 0x010200, GPIO_SYNCS0_BAUD1 = 0x010204, GPIO_SYNCS0_BAUD2 = 0x010208,
  GPIO_SYNCS1_BAUD_START = 0x010300, GPIO_SYNCS1_BAUD1 = 0x010304, GPIO_SYNCS1_BAUD2 = 0x010308
}
enum  GpioChannels {
  SYNC_M = 1, SYNC_S0 = 2, SYNC_S1 = 3, AUX0 = 4,
  AUX1 = 5, AUX2 = 6, AUX3 = 7, NumGpio = 7
}

Functions

const char * roleToString (ClientRole role)
 Convert role state to a string representation.
ClientRole defineClientRole (const char *name, ClientRole dflt=roleObserver)
 Setup the role of the client application.

Enumeration Type Documentation

Enumerator:
addr_HardwareType 
addr_HardwareVersion 
addr_BoardId 

Definition at line 51 of file Board.h.

Enumerator:
roleNone 

no defined role

roleObserver 

pure observer, no changes

roleControl 

allowed to change state, no DAQ

roleDAQ 

full control including DAQ

Definition at line 16 of file Board.h.

Enumerator:
kind_Optic 
kind_FX20 
kind_FX40 
kind_FX60 
kind_newOptic 

Definition at line 35 of file Board.h.

Enumerator:
kind_nXYTER 
kind_oldFEET 
kind_FEET 
kind_newNX 
kind_SPADIC 

Definition at line 27 of file Board.h.

Enumerator:
kind_UDP 
kind_ABB 
kind_File 
kind_USB 

Definition at line 44 of file Board.h.

Enumerator:
SYNC_M 
SYNC_S0 
SYNC_S1 
AUX0 
AUX1 
AUX2 
AUX3 
NumGpio 

Definition at line 110 of file defines_gpio.h.

Enumerator:
GPIO_CONFIG 

{ROC, read/write, 32 bit} Part of Sync message receiver interface and AUXilliary signal interface.

GPIO_SYNCM_BAUD_START 

{ROC, read/write, 8 bit} This 8 bit register is implemented but has no hardware function. It does despite its name not control any sync master transmitter timing, since it is only used for receivers.

GPIO_SYNCM_BAUD1 

{ROC, read/write, 8 bit} Controls for sync master how many 250 MHz clock cycles the serial transmitter waits after an odd numbered bit. The register contains cycles minus 1, so 4 cycles --> register setting 3

Part of Sync message sender interface.

GPIO_SYNCM_BAUD2 

{ROC, read/write, 8 bit} Controls for sync master how many 250 MHz clock cycles the serial transmitter waits after an even numbered bit. The register contains cycles minus 1, so 4 cycles --> register setting 3

Part of Sync message sender interface.

GPIO_SYNCM_SCALEDOWN 

{ROC, read/write, 8 bit} Determines the rate of sending sync messages out of the sync message sender GPIO port. The scale down is settable in powers of two, a value of 0 causes a sync message for each epoch, a value of 1,2,3,... for each 2nd, 4th, 8th,... epoch. Even though the register is 8 bit, only the values 0 to 23 are valid.

Part of Sync message sender interface.

GPIO_SYNCS0_BAUD_START 

{ROC, read/write, 8 bit} Controls how many 250 MHz clock cycles the serial receiver waits after the first falling edge (of the start bit) to sample in the middle of the bit cell. Use max(2, 250MHz/(baudrate/2)). The register contains cycles minus 1, so 4 cycles --> register setting 3

Part of Sync message receiver interface.

GPIO_SYNCS0_BAUD1 

{ROC, read/write, 8 bit} Controls for sync slave channel 0 how many 250 MHz clock cycles the serial receiver waits after an odd numbered bit. Use 250MHz/baudrate. The register contains cycles minus 1, so 4 cycles --> register setting 3

Part of Sync message receiver interface.

GPIO_SYNCS0_BAUD2 

{ROC, read/write, 8 bit} Controls for sync slave channel 0 how many 250 MHz clock cycles the serial receiver waits after an even numbered bit. Use 250MHz/baudrate. The register contains cycles minus 1, so 4 cycles --> register setting 3

Part of Sync message receiver interface.

GPIO_SYNCS1_BAUD_START 

{ROC, read/write, 8 bit} Like ROC_SYNC2_BAUD_START for sync slave channel 1. Part of Sync message receiver interface.

GPIO_SYNCS1_BAUD1 

{ROC, read/write, 8 bit} Like ROC_SYNC2_BAUD1 for sync slave channel 1. Part of Sync message receiver interface.

GPIO_SYNCS1_BAUD2 

{ROC, read/write, 8 bit} Like ROC_SYNC2_BAUD2 for sync slave channel 1. Part of Sync message receiver interface.

Definition at line 6 of file defines_gpio.h.


Function Documentation

base::ClientRole base::defineClientRole ( const char *  name,
base::ClientRole  dflt = roleObserver 
)

Setup the role of the client application.

Definition at line 24 of file Board.cxx.

Referenced by roc::UdpDevice::UdpDevice().

const char * base::roleToString ( base::ClientRole  role  )