ITkPix command frame makers and parsers. More...

#include "itk/logger.hpp"
#include "itk/utils.hpp"
#include "cmdluts.hpp"

Include dependency graph for cmdfuncs.hpp:

Functions
uint8_t	itk::itkpix::cmd::enc_data (uint8_t data5)
	Encode data. More...

uint8_t	itk::itkpix::cmd::enc_trig (uint8_t trig)
	Encode 4 BC trigger pattern. More...

uint8_t	itk::itkpix::cmd::enc_tag (uint8_t tag)
	Encode trigger tag. More...

bool	itk::itkpix::cmd::is_data_tag (uint8_t tag)
	Check if data tag. More...

bool	itk::itkpix::cmd::is_trig_tag (uint8_t tag)
	Check if trigger tag. More...

bool	itk::itkpix::cmd::is_cmd_tag (uint8_t tag)
	Check if command tag. More...

bool	itk::itkpix::cmd::is_data (uint8_t code)
	Check if encoded symbol is data. More...

bool	itk::itkpix::cmd::is_trig (uint8_t code)
	Check if encoded symbol is trigger. More...

bool	itk::itkpix::cmd::is_cmd (uint8_t code)
	Check if encoded symbol is command. More...

uint8_t	itk::itkpix::cmd::encode5b (uint8_t data5)
	Encode 5-bit data to 8-bit. More...

uint16_t	itk::itkpix::cmd::encode10b (uint8_t data5a, uint8_t data5b)
	Encode two 5-bit data to 16-bit command frame. More...

uint16_t	itk::itkpix::cmd::encode10b (uint32_t data)
	Encodes only lowest 10 bits. More...

uint8_t	itk::itkpix::cmd::decode8b (uint8_t code)
	Decoding encoded symbol. More...

auto	itk::itkpix::cmd::decode16b (uint16_t frame)
	Decode command frame. More...

uint32_t	itk::itkpix::cmd::decode_data (uint16_t frame)

uint16_t	itk::itkpix::cmd::make_head (uint8_t cmd, uint8_t chip_id)

auto	itk::itkpix::cmd::parse_head (uint16_t frame)

std::array< uint16_t, 1 >	itk::itkpix::cmd::make_idle ()
	Make idle frame. More...

std::array< uint16_t, 1 >	itk::itkpix::cmd::make_sync ()
	Make sync frame. More...

std::array< uint16_t, 1 >	itk::itkpix::cmd::make_trig (uint8_t bc, uint8_t tag)
	Make trigger command, if bc = 0 returns IDLE frame. More...

auto	itk::itkpix::cmd::parse_trig (std::array< uint16_t, 1 > frames)
	Parse trigger command. More...

std::array< uint16_t, 1 >	itk::itkpix::cmd::make_clear (uint8_t chip_id)
	Make 'clear' command. More...

auto	itk::itkpix::cmd::parse_clear (std::array< uint16_t, 1 > frames)
	Parse 'clear' command. More...

std::array< uint16_t, 2 >	itk::itkpix::cmd::make_read_trig (uint8_t chip_id, uint8_t ext_tag)
	Make 'ReadTrigger' command. More...

auto	itk::itkpix::cmd::parse_read_trig (std::array< uint16_t, 2 > frames)
	Parse 'ReadTrigger' command. More...

std::array< uint16_t, 1 >	itk::itkpix::cmd::make_global (uint8_t chip_id)

auto	itk::itkpix::cmd::parse_global (std::array< uint16_t, 1 > frames)

std::array< uint16_t, 3 >	itk::itkpix::cmd::make_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)
	'Cal' command format: More...

auto	itk::itkpix::cmd::parse_calib (std::array< uint16_t, 3 > frames)
	Parse 'Cal' command. More...

std::array< uint16_t, 2 >	itk::itkpix::cmd::make_read_reg (uint8_t chip_id, uint16_t addr)
	'ReadReg' command format More...

auto	itk::itkpix::cmd::parse_read_reg (std::array< uint16_t, 2 > frames)
	Parse 'ReadReg' command. More...

std::array< uint16_t, 4 >	itk::itkpix::cmd::make_write_reg (uint8_t chip_id, uint16_t addr, uint16_t data)
	Write register command. More...

auto	itk::itkpix::cmd::parse_write_reg (std::array< uint16_t, 4 > frames)
	Parse 'WriteReg' command. More...

std::array< uint16_t, 2 >	itk::itkpix::cmd::make_write_pix_start (uint8_t chip_id)
	Start of multi-write to pixel portal 'PIX_PORTAL'. More...

auto	itk::itkpix::cmd::parse_write_pix_start (std::array< uint16_t, 2 > frames)
	Parse multi-write start command. More...

uint16_t	itk::itkpix::cmd::make_write_pix_next (uint16_t data)

Variables
itk::Logger	itk::itkpix::cmd::log

const uint16_t	itk::itkpix::cmd::SYNC = 0x817E
	sync and idle (pll_lock) words More...

const uint16_t	itk::itkpix::cmd::IDLE = 0xAAAA
	idle command

constexpr uint8_t	itk::itkpix::cmd::TAG_CALIB = 32
	Symbols. More...

constexpr uint8_t	itk::itkpix::cmd::TAG_CLEAR = 33
	'Clear' command tag

constexpr uint8_t	itk::itkpix::cmd::TAG_GLOBAL = 34
	'GlobalPulse' command tag

constexpr uint8_t	itk::itkpix::cmd::TAG_PLLLOCK = 35
	'Pll Lock' tag

constexpr uint8_t	itk::itkpix::cmd::TAG_REGRD = 36
	'Read Register' command tag

constexpr uint8_t	itk::itkpix::cmd::TAG_TRIGRD = 37
	'Read Trigger' command tag

constexpr uint8_t	itk::itkpix::cmd::TAG_REGWR = 53
	'Write Register' command tag

constexpr uint8_t	itk::itkpix::cmd::TAG_TRIG0 = 37
	pseudo-tag for bc = '0000'

constexpr uint8_t	itk::itkpix::cmd::TAG_TRIG1 = 38
	Trigger tag for bc ='000T'.

constexpr uint8_t	itk::itkpix::cmd::TAG_TRIGF = TAG_TRIG1 + 15
	Trigger tag for bc = 'TTTT'.

constexpr uint8_t	itk::itkpix::cmd::PLLLOCK = enc_symb[TAG_PLLLOCK]
	Commands. More...

constexpr uint8_t	itk::itkpix::cmd::TRIGRD = enc_symb[TAG_TRIGRD]
	0x69

constexpr uint8_t	itk::itkpix::cmd::CLEAR = enc_symb[TAG_CLEAR]
	0x5A

constexpr uint8_t	itk::itkpix::cmd::GLOBAL = enc_symb[TAG_GLOBAL]
	0x5C

constexpr uint8_t	itk::itkpix::cmd::CALIB = enc_symb[TAG_CALIB]
	0x63

constexpr uint8_t	itk::itkpix::cmd::REGWR = enc_symb[TAG_REGWR]
	0x66

constexpr uint8_t	itk::itkpix::cmd::REGRD = enc_symb[TAG_REGRD]
	0x65

Detailed Description

ITkPix command frame makers and parsers.

Author: Orion

Function Documentation

◆ decode16b()

auto itk::itkpix::cmd::decode16b ( uint16_t frame )

inline

Decode command frame.

Parameters

frame - 16-bit command frame

Returns: pair of decoded symbols

◆ decode8b()

uint8_t itk::itkpix::cmd::decode8b ( uint8_t code )

inline

Decoding encoded symbol.

Parameters

code	- encoded symbol

Returns: decoded symbol

◆ enc_data()

uint8_t itk::itkpix::cmd::enc_data ( uint8_t data5 )

inline

Encode data.

Parameters

data5 - 5-bit data symbol

◆ enc_tag()

uint8_t itk::itkpix::cmd::enc_tag ( uint8_t tag )

inline

Encode trigger tag.

Parameters

tag	- trigger tag [0..53]

◆ enc_trig()

uint8_t itk::itkpix::cmd::enc_trig ( uint8_t trig )

inline

Encode 4 BC trigger pattern.

Parameters

trig	- trigger pattern in 4 BC

◆ encode10b() [1/2]

uint16_t itk::itkpix::cmd::encode10b ( uint32_t data )

inline

Encodes only lowest 10 bits.

Parameters

data	- data, only last 10 bits are used

Returns: encoded 16-bit command frame

◆ encode10b() [2/2]

uint16_t itk::itkpix::cmd::encode10b	(	uint8_t	data5a,
		uint8_t	data5b
	)

inline

Encode two 5-bit data to 16-bit command frame.

Parameters

data5a	- 5-bit data (a)
data5b	- 5-bit data (b)

Returns: encoded 16-bit command frame

◆ encode5b()

uint8_t itk::itkpix::cmd::encode5b ( uint8_t data5 )

inline

Encode 5-bit data to 8-bit.

Parameters

data5 - 5-bit data

Returns: encoded byte

◆ is_cmd()

bool itk::itkpix::cmd::is_cmd ( uint8_t code )

inline

Check if encoded symbol is command.

Parameters

code	- encoded symbol

Returns: true if command code

◆ is_cmd_tag()

bool itk::itkpix::cmd::is_cmd_tag ( uint8_t tag )

inline

Check if command tag.

Parameters

tag	- symbol tag

Returns: true if command tag

◆ is_data()

bool itk::itkpix::cmd::is_data ( uint8_t code )

inline

Check if encoded symbol is data.

Parameters

code	- encoded symbol

Returns: true if data code

◆ is_data_tag()

bool itk::itkpix::cmd::is_data_tag ( uint8_t tag )

inline

Check if data tag.

Parameters

tag	- symbol tag

Returns: true if data tag

◆ is_trig()

bool itk::itkpix::cmd::is_trig ( uint8_t code )

inline

Check if encoded symbol is trigger.

Parameters

code	- encoded symbol

Returns: true if trigger bc code

◆ is_trig_tag()

bool itk::itkpix::cmd::is_trig_tag ( uint8_t tag )

inline

Check if trigger tag.

Parameters

tag	- symbol tag

Returns: true if trigger tag

◆ make_calib()

std::array<uint16_t, 3> itk::itkpix::cmd::make_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
	)

inline

'Cal' command format:

Parameters

i	- chip_id[5]
m	- edge_mode
d	- edge_delay[5]
w	- edge_width[8]
a	- aux_mode
b	- aux_delay[5]

[cmd].iiiii mdddd.dwwww wwwwa.bbbbb

Make 'Cal' command.

Parameters

chip_id
edg_mode
edg_delay
edg_width
aux_mode
aux_delay

Returns: 3 command frames

◆ make_clear()

std::array<uint16_t, 1> itk::itkpix::cmd::make_clear ( uint8_t chip_id )

inline

Make 'clear' command.

Parameters

chip_id - chip id

Returns: 16-bit command frame

◆ make_idle()

std::array<uint16_t, 1> itk::itkpix::cmd::make_idle ( )

inline

Make idle frame.

Returns: idle frame

◆ make_read_reg()

std::array<uint16_t, 2> itk::itkpix::cmd::make_read_reg	(	uint8_t	chip_id,
		uint16_t	addr
	)

inline

'ReadReg' command format

Parameters

i	- chip_id[5]
a	- addr[9]
[cmd].iiiii	0aaaa.aaaaa

Make 'ReadReg' command.

Parameters

chip_id
addr

Returns: 2 command frames

◆ make_read_trig()

std::array<uint16_t, 2> itk::itkpix::cmd::make_read_trig	(	uint8_t	chip_id,
		uint8_t	ext_tag
	)

inline

Make 'ReadTrigger' command.

Parameters

chip_id	- 5-bit chip id
ext_tag	- 8-bit extended tag

Returns: 2 command frames

◆ make_sync()

std::array<uint16_t, 1> itk::itkpix::cmd::make_sync ( )

inline

Make sync frame.

Returns: sync frame

◆ make_trig()

std::array<uint16_t, 1> itk::itkpix::cmd::make_trig	(	uint8_t	bc,
		uint8_t	tag
	)

inline

Make trigger command, if bc = 0 returns IDLE frame.

Parameters

bc	- 4-bit BC
tag	- trigger tag [0..53]

Returns: command sequence 1-frame

◆ make_write_pix_start()

std::array<uint16_t, 2> itk::itkpix::cmd::make_write_pix_start ( uint8_t chip_id )

inline

Start of multi-write to pixel portal 'PIX_PORTAL'.

Multi-register write 'WrReg'

Parameters

i	- chip_id[5]

Returns: [cmd].iiiii 10000.00000

Parameters

chip_id - 5-bit chip id

Returns: encoded 16-bit frames

◆ make_write_reg()

std::array<uint16_t, 4> itk::itkpix::cmd::make_write_reg	(	uint8_t	chip_id,
		uint16_t	addr,
		uint16_t	data
	)

inline

Write register command.

i - id[5], a - addr[9], d - data[16]

[cmd].iiiii 0aaaa.aaaaa ddddd.ddddd ddddd.d0000

◆ parse_calib()

auto itk::itkpix::cmd::parse_calib ( std::array< uint16_t, 3 > frames )

inline

Parse 'Cal' command.

Parameters

frames - 3 command frames

Returns: { status, cmd, params ... }

◆ parse_clear()

auto itk::itkpix::cmd::parse_clear ( std::array< uint16_t, 1 > frames )

inline

Parse 'clear' command.

Parameters

frame - 16-bit command frame

Returns: { status, cmd, chip_id } if no errors status = 0

◆ parse_read_reg()

auto itk::itkpix::cmd::parse_read_reg ( std::array< uint16_t, 2 > frames )

inline

Parse 'ReadReg' command.

Parameters

frames - 2 command frames

Returns: { status, cmd, chip_id, addr } if no errors status = 0

◆ parse_read_trig()

auto itk::itkpix::cmd::parse_read_trig ( std::array< uint16_t, 2 > frames )

inline

Parse 'ReadTrigger' command.

Parameters

frames - 2 command frames

Returns: { status, cmd, chip_id, ext_tag } if no errors status = 0

◆ parse_trig()

auto itk::itkpix::cmd::parse_trig ( std::array< uint16_t, 1 > frames )

inline

Parse trigger command.

Parameters

frame - 16-bit command frame

Returns: { status, bc, tag } if no errors status = 0

◆ parse_write_pix_start()

auto itk::itkpix::cmd::parse_write_pix_start ( std::array< uint16_t, 2 > frames )

inline

Parse multi-write start command.

Parameters

frames - input frames[2]

Returns: status - status of decoding; cmd - command

◆ parse_write_reg()

auto itk::itkpix::cmd::parse_write_reg ( std::array< uint16_t, 4 > frames )

inline

Parse 'WriteReg' command.

Parameters

frames[4] - 10-bit decoded commands

Returns: { status, cmd, chip_id, addr, data }; status - if no errors status = 0; chip_id - 5-bit chip id; addr - 9-bit register address; data - 16-bit register value

Variable Documentation

◆ PLLLOCK

constexpr uint8_t itk::itkpix::cmd::PLLLOCK = enc_symb[TAG_PLLLOCK]

constexpr

Commands.

0xAA

◆ SYNC

const uint16_t itk::itkpix::cmd::SYNC = 0x817E

sync and idle (pll_lock) words

sync command

◆ TAG_CALIB

constexpr uint8_t itk::itkpix::cmd::TAG_CALIB = 32

constexpr

Symbols.

'Calib' command tag

Functions

Variables

Detailed Description

Function Documentation

◆ decode16b()

◆ decode8b()

◆ enc_data()

◆ enc_tag()

◆ enc_trig()

◆ encode10b() [1/2]

◆ encode10b() [2/2]

◆ encode5b()

◆ is_cmd()

◆ is_cmd_tag()

◆ is_data()

◆ is_data_tag()

◆ is_trig()

◆ is_trig_tag()

◆ make_calib()

◆ make_clear()

◆ make_idle()

◆ make_read_reg()

◆ make_read_trig()

◆ make_sync()

◆ make_trig()

◆ make_write_pix_start()

◆ make_write_reg()

◆ parse_calib()

◆ parse_clear()

◆ parse_read_reg()

◆ parse_read_trig()

◆ parse_trig()

◆ parse_write_pix_start()

◆ parse_write_reg()

Variable Documentation

◆ PLLLOCK

◆ SYNC

◆ TAG_CALIB