#include <commander.hpp>

Inheritance diagram for itk::itkpix::Commander:

Collaboration diagram for itk::itkpix::Commander:

Public Member Functions
virtual void	idle ()=0
	Writing 'idle' frame.

virtual void	sync ()=0
	Writing 'sync' frame.

virtual void	trig (uint16_t bc, uint16_t tag)=0
	Writing 'trigger' command. More...

virtual void	read_trig (uint8_t chip_id, uint8_t ext_tag)=0
	Writing 'trigger read' command. More...

virtual void	clear (uint8_t chip_id)=0
	Writing 'clear' command. More...

virtual void	global (uint8_t chip_id)=0
	Writing 'global' 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
	Writing 'calib' command. More...

virtual void	read_reg (uint8_t chip_id, uint16_t addr)=0
	Writing 'read register' command. More...

virtual void	write_reg (uint8_t chip_id, uint16_t addr, uint16_t data)=0
	Writing 'write register' command. More...

virtual void	write_pix_start (uint8_t chip_id)=0
	Writing 'write pixel' start command. More...

virtual void	write_pix_next (uint16_t data)=0
	Writing 'write pixel' next command. More...

virtual void	write_pix_portal (uint8_t chip_id, std::span< const uint16_t > data)=0
	Writing data block to pixel portal. More...

virtual void	trig_fw (uint count, uint delay)=0
	Writing firmware trigger command. 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

ITkPix Commander interface.

Member Function Documentation

◆ calib()

virtual void itk::itkpix::Commander::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

Writing 'calib' command.

Parameters

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

◆ clear()

virtual void itk::itkpix::Commander::clear ( uint8_t chip_id )

pure virtual

Writing 'clear' command.

Parameters

chip_id - chip id

◆ global()

virtual void itk::itkpix::Commander::global ( uint8_t chip_id )

pure virtual

Writing 'global' command.

Parameters

chip_id - chip id

◆ read_reg()

virtual void itk::itkpix::Commander::read_reg	(	uint8_t	chip_id,
		uint16_t	addr
	)

pure virtual

Writing 'read register' command.

Parameters

chip_id	- chip id
addr	- read address

◆ read_trig()

virtual void itk::itkpix::Commander::read_trig	(	uint8_t	chip_id,
		uint8_t	ext_tag
	)

pure virtual

Writing 'trigger read' command.

Parameters

chip_id	- chip id
ext_tag	- extended tag [0..255]

◆ trig()

virtual void itk::itkpix::Commander::trig	(	uint16_t	bc,
		uint16_t	tag
	)

pure virtual

Writing 'trigger' command.

Parameters

bc	- 4-bit bunch crossing mask
tag	- trigger tag [0..53]

◆ trig_fw()

virtual void itk::itkpix::Commander::trig_fw	(	uint	count,
		uint	delay
	)

pure virtual

Writing firmware trigger command.

Parameters

count	- trigger count [0..127]
delay	- delay period [1..31] in step of 128 idles

◆ write_pix_next()

virtual void itk::itkpix::Commander::write_pix_next ( uint16_t data )

pure virtual

Writing 'write pixel' next command.

Parameters

data	- data to PIX_PORTAL

◆ write_pix_portal()

virtual void itk::itkpix::Commander::write_pix_portal	(	uint8_t	chip_id,
		std::span< const uint16_t >	data
	)

pure virtual

Writing data block to pixel portal.

Parameters

chip_id	- chip id
data	- data block to PIX_PORTAL

◆ write_pix_start()

virtual void itk::itkpix::Commander::write_pix_start ( uint8_t chip_id )

pure virtual

Writing 'write pixel' start command.

Parameters

chip_id - chip id

◆ write_reg()

virtual void itk::itkpix::Commander::write_reg	(	uint8_t	chip_id,
		uint16_t	addr,
		uint16_t	data
	)

pure virtual

Writing 'write register' command.

Parameters

chip_id	- chip id
addr	- read address
data	- data value

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

itksw/itk/itkpix/commander.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ calib()

◆ clear()

◆ global()

◆ read_reg()

◆ read_trig()

◆ trig()

◆ trig_fw()

◆ write_pix_next()

◆ write_pix_portal()

◆ write_pix_start()

◆ write_reg()