Orion
high-rate readout
Public Member Functions | List of all members
itk::star::Commander Class Referenceabstract

Star Commander interface. More...

#include <commander.hpp>

Inheritance diagram for itk::star::Commander:
Inheritance graph
[legend]
Collaboration diagram for itk::star::Commander:
Collaboration graph
[legend]

Public Member Functions

virtual void abc_write_reg (uint16_t addr, uint32_t data, uint8_t hcc_id=0xF, uint8_t abc_id=0xF)=0
 Writing ABC 'write register' command. More...
 
virtual void hcc_write_reg (uint16_t addr, uint32_t value, uint8_t hcc_id=0xF)=0
 Writing HCC 'write register' command. More...
 
virtual void abc_read_reg (uint16_t addr, uint8_t hcc_id=0xF, uint8_t abc_id=0xF)=0
 Writing ABC 'read register' command. More...
 
virtual void hcc_read_reg (uint16_t addr, uint8_t hcc_id=0xF)=0
 Writing HCC 'read register' command. More...
 
virtual void bcr_l0a_tag (uint8_t bcr, uint8_t mask, uint8_t tag)=0
 Writing BCR and L0A trigger. More...
 
virtual void l0a_tag (uint8_t mask, uint8_t tag)=0
 Writing L0A trigger. More...
 
virtual void bcr ()=0
 Writing BCR.
 
virtual void idle ()=0
 Writing 'idle' frame.
 
virtual void fast_cmd (uint8_t bc, uint8_t cmd)=0
 Writing fast command frame. More...
 
- Public Member Functions inherited from itk::Commander
virtual ~Commander ()=default
 Default destructor.
 
virtual void write (uint16_t cmd)=0
 Write 16 bit command to the Commander buffer. More...
 
virtual void write (std::span< uint16_t > cmds)=0
 Write 16 bit commands to the Commander buffer. More...
 
virtual void send ()=0
 Sends Commander buffer over the e-link.
 
virtual netio_tag_t get_fid ()=0
 Properties. More...
 
virtual void set_fid (netio_tag_t fid)=0
 Set FELIX id (fid). More...
 

Detailed Description

Star Commander interface.

Member Function Documentation

◆ abc_read_reg()

virtual void itk::star::Commander::abc_read_reg ( uint16_t  addr,
uint8_t  hcc_id = 0xF,
uint8_t  abc_id = 0xF 
)
pure virtual

Writing ABC 'read register' command.

Parameters
addr- read address
hcc_id- hcc id
abc_id- abc id

◆ abc_write_reg()

virtual void itk::star::Commander::abc_write_reg ( uint16_t  addr,
uint32_t  data,
uint8_t  hcc_id = 0xF,
uint8_t  abc_id = 0xF 
)
pure virtual

Writing ABC 'write register' command.

Parameters
addr- read address
data- data value
hcc_id- hcc id
abc_id- abc id

◆ bcr_l0a_tag()

virtual void itk::star::Commander::bcr_l0a_tag ( uint8_t  bcr,
uint8_t  mask,
uint8_t  tag 
)
pure virtual

Writing BCR and L0A trigger.

Parameters
bcr- 1-bit BCR in the latest BC covered by the L0A mask
mask- 4-bit L0A mask
tag- 7-bit trigger tag

◆ fast_cmd()

virtual void itk::star::Commander::fast_cmd ( uint8_t  bc,
uint8_t  cmd 
)
pure virtual

Writing fast command frame.

Parameters
bc- bunch crossing [0..3]
cmd- fast command [0..15]

◆ hcc_read_reg()

virtual void itk::star::Commander::hcc_read_reg ( uint16_t  addr,
uint8_t  hcc_id = 0xF 
)
pure virtual

Writing HCC 'read register' command.

Parameters
addr- read address
hcc_id- hcc id

◆ hcc_write_reg()

virtual void itk::star::Commander::hcc_write_reg ( uint16_t  addr,
uint32_t  value,
uint8_t  hcc_id = 0xF 
)
pure virtual

Writing HCC 'write register' command.

Parameters
addr- read address
data- data value
hcc_id- hcc id

◆ l0a_tag()

virtual void itk::star::Commander::l0a_tag ( uint8_t  mask,
uint8_t  tag 
)
pure virtual

Writing L0A trigger.

Parameters
mask- 4-bit L0A mask
tag- 7-bit trigger tag

The documentation for this class was generated from the following file: