dunedaq::timing::SIChipSlave Class Reference

Utility class to interface to SI chips. More...

#include <SIChipSlave.hpp>

Inheritance diagram for dunedaq::timing::SIChipSlave:

Collaboration diagram for dunedaq::timing::SIChipSlave:

Public Member Functions
	SIChipSlave (const I2CMasterNode *i2c_master, uint8_t i2c_device_address)
virtual	~SIChipSlave ()
uint8_t	read_page () const
	Reads the current page.
void	switch_page (uint8_t page) const
	{ function_description }
uint32_t	read_device_version () const
	Reads a device version.
uint8_t	read_clock_register (uint16_t address) const
	Reads a clock register.
void	write_clock_register (uint16_t address, uint8_t data) const
	Writes a clock register.
Public Member Functions inherited from dunedaq::timing::I2CSlave
virtual	~I2CSlave ()
uint8_t	get_i2c_address () const
uint8_t	read_i2c (uint32_t i2c_device_address, uint32_t i2c_reg_address) const
	comodity functions
uint8_t	read_i2c (uint32_t i2c_reg_address) const
void	write_i2c (uint32_t i2c_device_address, uint32_t i2c_reg_address, uint8_t data, bool send_stop=true) const
void	write_i2c (uint32_t i2c_reg_address, uint8_t data, bool send_stop=true) const
std::vector< uint8_t >	read_i2cArray (uint32_t i2c_device_address, uint32_t i2c_reg_address, uint32_t number_of_words) const
std::vector< uint8_t >	read_i2cArray (uint32_t i2c_reg_address, uint32_t number_of_words) const
void	write_i2cArray (uint32_t i2c_device_address, uint32_t i2c_reg_address, std::vector< uint8_t > data, bool send_stop=true) const
void	write_i2cArray (uint32_t i2c_reg_address, std::vector< uint8_t > data, bool send_stop=true) const
std::vector< uint8_t >	read_i2cPrimitive (uint32_t number_of_bytes) const
void	write_i2cPrimitive (const std::vector< uint8_t > &data, bool send_stop=true) const
bool	ping () const
std::string	get_master_id () const

Additional Inherited Members
Protected Member Functions inherited from dunedaq::timing::I2CSlave
	I2CSlave (const I2CMasterNode *i2c_master, uint8_t i2c_device_address)

Detailed Description

Utility class to interface to SI chips.

Author

Alessandro Thea

Date

May 2018

Definition at line 31 of file SIChipSlave.hpp.

Constructor & Destructor Documentation

SIChipSlave()

dunedaq::timing::SIChipSlave::SIChipSlave	(	const I2CMasterNode *	i2c_master,
		uint8_t	i2c_device_address )

Definition at line 24 of file SIChipSlave.cpp.

  : I2CSlave(i2c_master, address)
{}

~SIChipSlave()

dunedaq::timing::SIChipSlave::~SIChipSlave ( )

virtual

Definition at line 30 of file SIChipSlave.cpp.

{}

Member Function Documentation

read_clock_register()

uint8_t dunedaq::timing::SIChipSlave::read_clock_register

(

uint16_t

address

)

const

Reads a clock register.

Parameters

[in]

address

A address

Returns

{ description_of_the_return_value }

Definition at line 73 of file SIChipSlave.cpp.

{
 
  uint8_t reg_address = (address & 0xff);       // NOLINT(build/unsigned)
  uint8_t page_address = (address >> 8) & 0xff; // NOLINT(build/unsigned)
  std::stringstream debug_stream;
  debug_stream << std::showbase << std::hex << "Read Address " << (uint32_t)address // NOLINT(build/unsigned)
               << " reg: " << (uint32_t)reg_address                                    // NOLINT(build/unsigned)
               << " page: " << (uint32_t)page_address;                                 // NOLINT(build/unsigned)
  TLOG_DEBUG(6) << debug_stream.str();
  // Change page only when required.
  // (The SI5344 don't like to have the page register id to be written all the time.)
  uint8_t current_address = read_page(); // NOLINT(build/unsigned)
  if (page_address != current_address) {
    switch_page(page_address);
  }
 
  // Read the register
  return read_i2c(reg_address);
}

read_device_version()

uint32_t dunedaq::timing::SIChipSlave::read_device_version

(

)

const

Reads a device version.

Returns

{ description_of_the_return_value }

Definition at line 59 of file SIChipSlave.cpp.

{
 
  // Go to the right page
  switch_page(0x0);
  // Read 2 words from 0x2
  auto version = read_i2cArray(0x2, 2);
 
  return (((uint32_t)version[1] << 8) + (uint32_t)version[0]); // NOLINT(build/unsigned)
}

read_page()

uint8_t dunedaq::timing::SIChipSlave::read_page

(

)

const

Reads the current page.

Returns

{ description_of_the_return_value }

Definition at line 35 of file SIChipSlave.cpp.

{
 
  TLOG_DEBUG(7) << "<- Reading page ";
 
  // Read from the page address (0x1?)
  return read_i2c(0x1);
}

switch_page()

void dunedaq::timing::SIChipSlave::switch_page

(

uint8_t

page

)

const

{ function_description }

Parameters

[in]

page

A page

Definition at line 47 of file SIChipSlave.cpp.

{
 
  // Prepare a data block with address and new page
  // std::vector<uint8_t> lData = {0x1, page};// NOLINT(build/unsigned)
  TLOG_DEBUG(7) << "-> Switching to page " << format_reg_value((uint32_t)page); // NOLINT(build/unsigned)
  write_i2c(0x1, page);
}

write_clock_register()

void dunedaq::timing::SIChipSlave::write_clock_register	(	uint16_t	address,
		uint8_t	data ) const

Writes a clock register.

Parameters

[in]	address	A address
[in]	data	A data

Definition at line 97 of file SIChipSlave.cpp.

{
 
  uint8_t reg_address = (address & 0xff);       // NOLINT(build/unsigned)
  uint8_t page_address = (address >> 8) & 0xff; // NOLINT(build/unsigned)
 
  std::stringstream debug_stream;
  debug_stream << std::showbase << std::hex << "Write Address " << (uint32_t)address // NOLINT(build/unsigned)
               << " reg: " << (uint32_t)reg_address                                     // NOLINT(build/unsigned)
               << " page: " << (uint32_t)page_address;                                  // NOLINT(build/unsigned)
  TLOG_DEBUG(6) << debug_stream.str();
  // Change page only when required.
  // (The SI5344 don't like to have the page register id to be written all the time.)
  uint8_t current_address = read_page(); // NOLINT(build/unsigned)
  if (page_address != current_address) {
    switch_page(page_address);
  }
 
  return write_i2c(reg_address, data);
}

---

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

• /github/workspace/dunedaq/sourcecode/timing/include/timing/SIChipSlave.hpp
• /github/workspace/dunedaq/sourcecode/timing/src/SIChipSlave.cpp