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

Chip interface for HCCstar. More...

#include <chip_hcc.hpp>

Inheritance diagram for itk::star::hcc::Chip:
Inheritance graph
[legend]
Collaboration diagram for itk::star::hcc::Chip:
Collaboration graph
[legend]

Classes

struct  Factory
 

Public Member Functions

virtual void write_idle (uint32_t count=1)=0
 Commands. More...
 
virtual void abc_read_reg (uint8_t abc_id, uint16_t addr)=0
 Write command sequence to Commander buffer to read ABC register value from the chip, does not send any commands over the e-link. More...
 
virtual void abc_read_reg (uint8_t abc_id, abc::Register &reg)=0
 
virtual void abc_read_reg (uint8_t abc_id, const std::string &name)=0
 
virtual void abc_write_reg (uint8_t abc_id, uint16_t addr, uint32_t value)=0
 Set register value in memory and appends commands sequence to modify register value in ABC chip to Commander buffer, does not send any commands over the e-link. More...
 
virtual void abc_write_reg (uint8_t abc_id, abc::Register &reg, uint32_t value)=0
 
virtual void abc_write_reg (uint8_t abc_id, const std::string &name, uint32_t value)=0
 
- Public Member Functions inherited from itk::Chip< Field >
virtual const Register * find_reg (uint16_t addr) const=0
 Register methods. More...
 
virtual const Register * find_reg (const std::string &name) const=0
 
virtual reg_t get_reg (uint16_t addr) const=0
 Get register value from the memory by register name, address or reference. More...
 
virtual reg_t get_reg (const Register &reg) const=0
 
virtual reg_t get_reg (const std::string &name) const=0
 
virtual void set_reg (uint16_t addr, reg_t value)=0
 Set register value in memory by register name, address or reference. Does not send any commands to chip. More...
 
virtual void set_reg (const Register &reg, reg_t value)=0
 
virtual void set_reg (const std::string &name, reg_t value)=0
 
virtual void read_reg (uint16_t addr)=0
 Write command sequence to Commander buffer to read register value from the chip, does not send commands over e-link. More...
 
virtual void read_reg (const Register &reg)=0
 
virtual void read_reg (const std::string &name)=0
 
virtual void write_reg (uint16_t addr, reg_t value)=0
 Set register value in memory and appends commands sequence to modify register value in chip to Commander buffer, does not send commands over e-link. More...
 
virtual void write_reg (const Register &reg, reg_t value)=0
 
virtual void write_reg (const std::string &name, reg_t value)=0
 
virtual const Field * find_fld (const std::string &name) const=0
 Field methods. More...
 
virtual fld_t get_fld (const Field &fld) const=0
 Get field value from the memory by field name or reference. More...
 
virtual fld_t get_fld (const std::string &name) const=0
 
virtual void set_fld (const Field &fld, fld_t value)=0
 Set field value in memory by field name or reference. Does not send any commands to chip. More...
 
virtual void set_fld (const std::string &name, fld_t value)=0
 
virtual void read_fld (const Field &fld)=0
 Write command sequence to Commander buffer to read register value from the chip, does not send commands over e-link. More...
 
virtual void read_fld (const std::string &name)=0
 
virtual void write_fld (const Field &fld, fld_t value)=0
 Set field value in memory and appends commands sequence to modify field value in chip to Commander buffer, does not send commands over e-link. More...
 
virtual void write_fld (const std::string &name, fld_t value)=0
 
virtual void configure ()=0
 Configures chip, actually sends command over e-link via Commander.
 
virtual void send ()=0
 Sends data accumulated in command buffer over the e-link.
 

Additional Inherited Members

- Public Types inherited from itk::Chip< Field >
using Field = Field
 
using RegMem = IField::RegMem
 
using Register = IField::Register
 
using Commander = IField::Commander
 
using reg_t = IField::reg_t
 
using fld_t = IField::fld_t
 

Detailed Description

Chip interface for HCCstar.

Member Function Documentation

◆ abc_read_reg()

virtual void itk::star::hcc::Chip::abc_read_reg ( uint8_t  abc_id,
uint16_t  addr 
)
pure virtual

Write command sequence to Commander buffer to read ABC register value from the chip, does not send any commands over the e-link.

Parameters
abc_id- abc id
addr- register address
reg- reference to the register
name- register name

◆ abc_write_reg()

virtual void itk::star::hcc::Chip::abc_write_reg ( uint8_t  abc_id,
uint16_t  addr,
uint32_t  value 
)
pure virtual

Set register value in memory and appends commands sequence to modify register value in ABC chip to Commander buffer, does not send any commands over the e-link.

Parameters
abc_id- abc id
addr- register address
reg- reference to the register
name- register name
value- register value to be set in chip

◆ write_idle()

virtual void itk::star::hcc::Chip::write_idle ( uint32_t  count = 1)
pure virtual

Commands.

Writing 'idle' frame.


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