Orion
high-rate readout
Public Member Functions | List of all members
itk::itkpix::cmd::intf::CommandCallback Class Referenceabstract

Command callback interface for ITkPix. More...

#include <cmdcallback.hpp>

Inheritance diagram for itk::itkpix::cmd::intf::CommandCallback:
Inheritance graph
[legend]

Public Member Functions

virtual ~CommandCallback ()=default
 Destructor.
 
virtual void idle ()=0
 'idle' command
 
virtual void sync ()=0
 'sync' command
 
virtual void trig (uint8_t bc, uint8_t tag)=0
 trigger command More...
 
virtual void read_trig (uint8_t chip_id, uint8_t ext_tag)=0
 read trigger command More...
 
virtual void clear (uint8_t chip_id)=0
 clear command More...
 
virtual void global (uint8_t chip_id)=0
 global pulse command More...
 
virtual void calib (uint8_t chip_id, uint8_t edg_mode, uint8_t edg_delay, uint8_t edg_width, uint8_t aux_mode, uint8_t aux_delay)=0
 calibration command More...
 
virtual void read_reg (uint8_t chip_id, uint16_t addr)=0
 read register command More...
 
virtual void write_reg (uint8_t chip_id, uint16_t addr, uint16_t data)=0
 write register command More...
 
virtual void write_pix_start (uint8_t chip_id)=0
 start multi-write command to PIX_PORTAL More...
 
virtual void write_pix_next (uint16_t data)=0
 next multi-write command to PIX_PORTAL More...
 
virtual void on_warning (uint16_t frame)=0
 on_warning callback More...
 
virtual void on_error (uint16_t frame)=0
 on_error callback More...
 

Detailed Description

Command callback interface for ITkPix.

Member Function Documentation

◆ calib()

virtual void itk::itkpix::cmd::intf::CommandCallback::calib ( uint8_t  chip_id,
uint8_t  edg_mode,
uint8_t  edg_delay,
uint8_t  edg_width,
uint8_t  aux_mode,
uint8_t  aux_delay 
)
pure virtual

calibration command

Parameters
chip_id- chip id
edg_mode- edge mode
edg_delay- edge delay
edg_width- edge width
aux_mode- auxiliary mode
aux_delay- auxiliary delay

Implemented in itk::itkpix::cmd::dummy::CommandCallback.

◆ clear()

virtual void itk::itkpix::cmd::intf::CommandCallback::clear ( uint8_t  chip_id)
pure virtual

clear command

Parameters
chip_id- chip id

Implemented in itk::itkpix::cmd::dummy::CommandCallback.

◆ global()

virtual void itk::itkpix::cmd::intf::CommandCallback::global ( uint8_t  chip_id)
pure virtual

global pulse command

Parameters
chip_id- chip id

Implemented in itk::itkpix::cmd::dummy::CommandCallback.

◆ on_error()

virtual void itk::itkpix::cmd::intf::CommandCallback::on_error ( uint16_t  frame)
pure virtual

on_error callback

Parameters
frame- command frame

Implemented in itk::itkpix::cmd::dummy::CommandCallback.

◆ on_warning()

virtual void itk::itkpix::cmd::intf::CommandCallback::on_warning ( uint16_t  frame)
pure virtual

on_warning callback

Parameters
frame- command frame

Implemented in itk::itkpix::cmd::dummy::CommandCallback.

◆ read_reg()

virtual void itk::itkpix::cmd::intf::CommandCallback::read_reg ( uint8_t  chip_id,
uint16_t  addr 
)
pure virtual

read register command

Parameters
chip_id- chip id
addr- register address

Implemented in itk::itkpix::cmd::dummy::CommandCallback.

◆ read_trig()

virtual void itk::itkpix::cmd::intf::CommandCallback::read_trig ( uint8_t  chip_id,
uint8_t  ext_tag 
)
pure virtual

read trigger command

Parameters
chip_id- chip id
ext_tag- extended trigger tag

Implemented in itk::itkpix::cmd::dummy::CommandCallback.

◆ trig()

virtual void itk::itkpix::cmd::intf::CommandCallback::trig ( uint8_t  bc,
uint8_t  tag 
)
pure virtual

trigger command

Parameters
bc- 4 bit bunch crossing
tag- trigger tag

Implemented in itk::itkpix::cmd::dummy::CommandCallback.

◆ write_pix_next()

virtual void itk::itkpix::cmd::intf::CommandCallback::write_pix_next ( uint16_t  data)
pure virtual

next multi-write command to PIX_PORTAL

Parameters
data- data to write to PIX_PORTAL

Implemented in itk::itkpix::cmd::dummy::CommandCallback.

◆ write_pix_start()

virtual void itk::itkpix::cmd::intf::CommandCallback::write_pix_start ( uint8_t  chip_id)
pure virtual

start multi-write command to PIX_PORTAL

Parameters
chip_id- chip id

Implemented in itk::itkpix::cmd::dummy::CommandCallback.

◆ write_reg()

virtual void itk::itkpix::cmd::intf::CommandCallback::write_reg ( uint8_t  chip_id,
uint16_t  addr,
uint16_t  data 
)
pure virtual

write register command

Parameters
chip_id- chip id
addr- register address
data- 16 bit data to write

Implemented in itk::itkpix::cmd::dummy::CommandCallback.


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