dunedaq::timing::GIBV3IONode Class Reference

Class for the timing FMC board. More...

#include <GIBV3IONode.hpp>

Inheritance diagram for dunedaq::timing::GIBV3IONode:

Collaboration diagram for dunedaq::timing::GIBV3IONode:

Public Member Functions
	GIBV3IONode (const uhal::Node &node)
virtual	~GIBV3IONode ()
std::string	get_status (bool print_out=false) const override
	Get status string, optionally print.
uint32_t	read_io_expanders () const override
	Read the contents of the IO expanders.
uint8_t	read_sfps_los () const override
	Retrive SFP LOS status for all SFPs.
uint8_t	read_sfps_fault () const override
	Retrive SFP fault status for all SFPs.
Public Member Functions inherited from dunedaq::timing::GIBV2IONode
	GIBV2IONode (const uhal::Node &node)
virtual	~GIBV2IONode ()
bool	clocks_ok () const override
	Clocks ready?
void	switch_sfp_tx (uint32_t sfp_id, bool turn_on) const override
	control tx laser of on-board SFP softly (I2C command)
Public Member Functions inherited from dunedaq::timing::GIBIONode
	GIBIONode (const uhal::Node &node)
	GIBIONode (const uhal::Node &node, std::string uid_i2c_bus, std::string pll_i2c_bus, std::string pll_i2c_device, std::vector< std::string > clock_names, std::vector< std::string > sfp_i2c_buses)
virtual	~GIBIONode ()
std::string	get_uid_address_parameter_name () const override
	Get the UID address parameter name.
std::unique_ptr< const SI534xSlave >	get_pll () const override
	GET PLL I2C interface.
std::string	get_hardware_info (bool print_out) const override
	Print hardware information.
void	set_up_io_infrastructure () const override
	Set up i2c buses, enable ICs.
void	reset (const std::string &clock_config_file) const override
	Reset GIB IO.
void	configure_expander () const
	Configure the GIB expander.
void	reset_pll () const override
	Reset PLL.
std::string	get_sfp_status (uint32_t sfp_id, bool print_out=false) const override
	Print status of on-board SFP.
void	switch_sfp_soft_tx_control_bit (uint32_t sfp_id, bool turn_on) const override
	control tx laser of on-board SFP softly (I2C command)
void	set_i2c_mux_channels (uint8_t mux_channel_bitmask) const
	Fill hardware monitoring structure.
float	read_board_temperature () const
	Read board temp.
virtual void	reset (const ClockSource &clock_source) const
	Reset timing node with clock file lookup.
Public Member Functions inherited from dunedaq::timing::IONode
	IONode (const uhal::Node &node, std::string uid_i2c_bus, std::string pll_i2c_bus, std::string pll_i2c_device, std::vector< std::string > clock_names, std::vector< std::string > sfp_i2c_buses)
virtual	~IONode ()
virtual uint32_t	read_board_type () const
	Read the word identifying the timing board.
virtual uint32_t	read_carrier_type () const
	Read the word identifying the FPFA carrier board.
virtual uint32_t	read_design_type () const
	Read the word identifying the firmware design in the FPGA.
virtual uint32_t	read_firmware_frequency () const
	Read the word identifying the frequency [units of Hz] of the firmware in the FPGA.
virtual uint64_t	read_board_uid () const
	Read the word containing the timing board UID.
virtual BoardRevision	get_board_revision () const
	Read the word identifying the timing board.
virtual std::string	get_full_clock_config_file_path (const ClockSource &clock_source) const
	Get the full config path.
template<class T >
std::unique_ptr< const T >	get_i2c_device (const std::string &i2c_bus_name, const std::string &i2c_device_name) const
	Get the an I2C chip.
virtual void	configure_pll (const std::string &clock_config_file="") const
	Configure clock chip.
virtual std::vector< double >	read_clock_frequencies () const
	Read frequencies of on-board clocks.
virtual std::string	get_clock_frequencies_table (bool print_out=false) const
	Print frequencies of on-board clocks.
virtual std::string	get_pll_status (bool print_out=false) const
	Print status of on-board PLL.
virtual void	soft_reset () const
	Reset timing node.
virtual void	get_info (timinghardwareinfo::TimingPLLMonitorData &mon_data) const
Public Member Functions inherited from dunedaq::timing::TimingNode
	TimingNode (const uhal::Node &node)
virtual	~TimingNode ()
std::map< std::string, uhal::ValWord< uint32_t > >	read_sub_nodes (const uhal::Node &node, bool dispatch=true) const
	Read subnodes.
void	reset_sub_nodes (const uhal::Node &node, uint32_t aValue=0x0, bool dispatch=true) const
	Reset subnodes.

Additional Inherited Members
Static Public Member Functions inherited from dunedaq::timing::IONode
static const std::map< BoardType, std::string > &	get_board_type_map ()
static const std::map< CarrierType, std::string > &	get_carrier_type_map ()
static const std::map< BoardRevision, std::string > &	get_board_revision_map ()
static const std::map< uint64_t, BoardRevision > &	get_board_uid_revision_map ()
static const std::map< DesignType, std::string > &	get_design_type_map ()
static const std::map< std::string, std::string > &	get_clock_config_map ()
static const std::vector< BoardType > &	get_library_supported_boards ()
static const std::vector< DesignType > &	get_library_supported_designs ()
Protected Member Functions inherited from dunedaq::timing::GIBV2IONode
uint8_t	get_sfp_tx_disable_bitmap () const override
uint8_t	get_num_sfps () const override
Protected Member Functions inherited from dunedaq::timing::GIBIONode
void	validate_sfp_id (uint32_t sfp_id) const
Protected Member Functions inherited from dunedaq::timing::IONode
virtual void	write_soft_reset_register () const
	Write soft reset register.
Static Protected Member Functions inherited from dunedaq::timing::IONode
static std::string	clock_source_to_string (const ClockSource &source)
Protected Attributes inherited from dunedaq::timing::IONode
const std::string	m_uid_i2c_bus
const std::string	m_pll_i2c_bus
const std::string	m_pll_i2c_device
const std::vector< std::string >	m_clock_names
const std::vector< std::string >	m_sfp_i2c_buses
Static Protected Attributes inherited from dunedaq::timing::IONode
static const std::map< BoardType, std::string >	board_type_map
static const std::map< CarrierType, std::string >	carrier_type_map
static const std::map< BoardRevision, std::string >	board_revision_map
static const std::map< DesignType, std::string >	design_type_map
static const std::map< uint64_t, BoardRevision >	board_uid_revision_map
static const std::map< ClockSource, std::string >	clock_source_map
static const std::map< std::string, std::string >	clock_config_map
static const std::vector< BoardType >	library_supported_boards
static const std::vector< DesignType >	library_supported_designs

Detailed Description

Class for the timing FMC board.

Definition at line 32 of file GIBV3IONode.hpp.

Constructor & Destructor Documentation

GIBV3IONode()

dunedaq::timing::GIBV3IONode::GIBV3IONode ( const uhal::Node & node )

explicit

Definition at line 20 of file GIBV3IONode.cpp.

  : GIBV2IONode(node)
{
}

~GIBV3IONode()

dunedaq::timing::GIBV3IONode::~GIBV3IONode ( )

virtual

Definition at line 27 of file GIBV3IONode.cpp.

{}

Member Function Documentation

get_status()

std::string dunedaq::timing::GIBV3IONode::get_status ( bool print_out = false ) const

overridevirtual

Get status string, optionally print.

Reimplemented from dunedaq::timing::GIBIONode.

Definition at line 32 of file GIBV3IONode.cpp.

{
  std::stringstream status;
 
  auto subnodes = read_sub_nodes(getNode("csr.stat"));
  status << format_reg_table(subnodes, "GIB IO state");
 
  auto subnodes_2 = read_sub_nodes(getNode("csr.ctrl"));
  status << format_reg_table(subnodes_2, "GIB IO control");
 
  uint8_t sfp_los = read_sfps_los();
  uint8_t sfp_fault = read_sfps_fault();
 
  std::vector<std::string> sfp_vec;
  std::vector<uint8_t> los_vec;
  std::vector<uint8_t> fault_vec;
 
  for (int i=0; i<get_num_sfps(); i++) {
    sfp_vec.push_back(to_string(i));
    // L is 0x4C, H is L - 4
    los_vec.push_back(0x4C - 4*((sfp_los >> i) & 1));
    fault_vec.push_back(0x4C - 4*((sfp_fault >> i) & 1));
  }
  
  status << "-----IO expander------" << std::endl;
  status << "SFP:   " << vec_fmt(sfp_vec) << std::endl;
  status << "LOS:   " << vec_fmt(los_vec) << std::endl;
  status << "Fault: " << vec_fmt(fault_vec) << std::endl;
 
  // removed temperature readout
 
  if (print_out)
    TLOG() << std::endl << status.str();
  return status.str();
}

read_io_expanders()

uint32_t dunedaq::timing::GIBV3IONode::read_io_expanders ( ) const

overridevirtual

Read the contents of the IO expanders.

Reimplemented from dunedaq::timing::GIBIONode.

Definition at line 71 of file GIBV3IONode.cpp.

                                     { // NOLINT(build/unsigned)
  auto sfp_expander_0 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander0");
 
  uint32_t expander_bits = sfp_expander_0->read_inputs(1);
  expander_bits = (expander_bits << 8) + sfp_expander_0->read_inputs(0);
 
  return expander_bits;
}

read_sfps_fault()

uint8_t dunedaq::timing::GIBV3IONode::read_sfps_fault ( ) const

overridevirtual

Retrive SFP fault status for all SFPs.

Reimplemented from dunedaq::timing::GIBV2IONode.

Definition at line 102 of file GIBV3IONode.cpp.

                                   { // NOLINT(build/unsigned)
  uint32_t expander_bits = read_io_expanders();
 
  // A-CLK fault is 2nd bit
  uint8_t fault_bits = static_cast<uint8_t>((expander_bits >> 1) & 1);
 
  for (uint8_t sfp = 0; sfp<6; sfp++) {
    // SFP faults are 0-5 on second bus of first expander
    // Adds the SFPs in reverse order
    fault_bits = (fault_bits << 1) + ((expander_bits >> (8 + 5 - sfp)) & 1);
  }
 
  return fault_bits;
}

read_sfps_los()

uint8_t dunedaq::timing::GIBV3IONode::read_sfps_los ( ) const

overridevirtual

Retrive SFP LOS status for all SFPs.

Reimplemented from dunedaq::timing::GIBV2IONode.

Definition at line 83 of file GIBV3IONode.cpp.

                                 { // NOLINT(build/unsigned)
  uint32_t expander_bits = read_io_expanders();
 
  // A-CLK LOS is 1st bit
  uint8_t los_bits = static_cast<uint8_t>(expander_bits & 1);
 
  uint32_t los_bitmask = 0x003f;
 
  uhal::ValWord<uint32_t> los_reg_data = getNode("csr.stat.sfp_los").read();
  getClient().dispatch();
 
  los_bits = (los_bits << 6) + static_cast<uint8_t>(los_reg_data & los_bitmask);
 
  return los_bits;
}

---

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

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