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

Chip interface for ITkPix. More...

#include <chip.hpp>

Inheritance diagram for itk::itkpix::Chip:
Inheritance graph
[legend]
Collaboration diagram for itk::itkpix::Chip:
Collaboration graph
[legend]

Classes

struct  Factory
 

Public Member Functions

virtual void write_idle (uint32_t count=1)=0
 
virtual void write_sync ()=0
 
virtual void read_trig (uint8_t ext_tag)=0
 
virtual void cmd_clear ()=0
 
virtual void cmd_global ()=0
 
virtual void cmd_calib (uint8_t edg_mode, uint8_t edg_delay, uint8_t edg_width, uint8_t aux_mode, uint8_t aux_delay)=0
 
virtual void write_pix_start ()=0
 
virtual void write_pix_data (uint16_t data)=0
 
virtual void write_pix (std::span< const uint16_t > data)=0
 
virtual void update_pix_reg ()=0
 
virtual void update_pix_mask ()=0
 
virtual void update_pix_tdac ()=0
 
virtual void config_init ()=0
 
virtual void config_global ()=0
 
virtual void config_pixels ()=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 ITkPix.


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