Class for the timing FMC board. More...

#include <GIBIONode.hpp>

Inheritance diagram for dunedaq::timing::GIBIONode:

Collaboration diagram for dunedaq::timing::GIBIONode:

Public Member Functions
	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::string	get_status (bool print_out=false) const override
	Get status string, optionally print.

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.

virtual uint32_t	read_io_expanders () const
	Read the contents of the IO expanders.

virtual uint8_t	read_sfps_los () const
	Retrive SFP LOS status for all SFPs.

virtual uint8_t	read_sfps_fault () const
	Retrive SFP fault status for all SFPs.

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)

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)

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.

Protected Member Functions
virtual uint8_t	get_sfp_tx_disable_bitmap () const

virtual uint8_t	get_num_sfps () const

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.

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 ()

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 GIBIONode.hpp.

Constructor & Destructor Documentation

◆ GIBIONode() [1/2]

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

explicit

Definition at line 21 of file GIBIONode.cpp.

  : IONode(node, "i2c", "i2c", { "PLL" }, { "PLL", "SFP CDR 0", "SFP CDR 1", "SFP CDR 2", "SFP CDR 3", "SFP CDR 4", "SFP CDR 5", "10 MHz" }, { "i2c", "i2c", "i2c", "i2c", "i2c", "i2c" })
{
}

◆ GIBIONode() [2/2]

dunedaq::timing::GIBIONode::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 )

explicit

Definition at line 28 of file GIBIONode.cpp.

  : IONode(node, uid_i2c_bus, pll_i2c_bus, pll_i2c_device, clock_names, sfp_i2c_buses)
{
}

◆ ~GIBIONode()

dunedaq::timing::GIBIONode::~GIBIONode ( )

virtual

Definition at line 40 of file GIBIONode.cpp.

40{}

Member Function Documentation

◆ clocks_ok()

bool dunedaq::timing::GIBIONode::clocks_ok ( ) const

overridevirtual

Clocks ready?

Implements dunedaq::timing::IONode.

Reimplemented in dunedaq::timing::GIBV2IONode.

Definition at line 277 of file GIBIONode.cpp.

{
  std::stringstream status;
 
  auto states = read_sub_nodes(getNode("csr.stat"));
  bool pll_lol = states.find("clk_gen_lol")->second.value();
  bool pll_interrupt = states.find("clk_gen_intr")->second.value();
  bool mmcm_ok = states.find("mmcm_ok")->second.value();
  bool mmcm_10_ok = states.find("mmcm_ok")->second.value();
 
  TLOG_DEBUG(5) << "pll lol: " << pll_lol << ", pll intr: " << pll_interrupt
                << ", mmcm ok: " << mmcm_ok << ", mmcm 10MHz ok: " << mmcm_10_ok;
 
  return !pll_lol && mmcm_ok && mmcm_10_ok;
}

◆ configure_expander()

void dunedaq::timing::GIBIONode::configure_expander ( ) const

Configure the GIB expander.

Definition at line 170 of file GIBIONode.cpp.

{
  auto sfp_expander_0 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander0");
  auto sfp_expander_1 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander1");
  
  // Set invert registers to default for both (0,1) banks
  sfp_expander_0->set_inversion(0, 0x00);
  sfp_expander_0->set_inversion(1, 0x00);
  sfp_expander_1->set_inversion(0, 0x00);
  sfp_expander_1->set_inversion(1, 0x00);
  
  // 0: pin set as output, 1: pin set as input
  sfp_expander_0->set_io(0, 0xff); // set all pins of bank 0 as inputs
  sfp_expander_0->set_io(1, 0xff); // set all pins of bank 1 as inputs
 
  sfp_expander_1->set_io(0, 0xff); // set all pins of bank 0 as inputs
  sfp_expander_1->set_io(1, 0x00); // set all pins of bank 1 as outputs
 
  // Set SFP disable 
  // Set tx disable pins low, i.e. enable the pins given in the bitmap
  //   (different between v1 and v2/3)
  sfp_expander_1->set_outputs(1, get_sfp_tx_disable_bitmap());
}

◆ get_hardware_info()

std::string dunedaq::timing::GIBIONode::get_hardware_info ( bool print_out ) const

overridevirtual

Print hardware information.

Reimplemented from dunedaq::timing::IONode.

Definition at line 102 of file GIBIONode.cpp.

{
  // enable pll/uid channel 0 only
  set_i2c_mux_channels(0x1);
  return IONode::get_hardware_info(print_out);
}

◆ get_num_sfps()

uint8_t dunedaq::timing::GIBIONode::get_num_sfps ( ) const

protectedvirtual

Reimplemented in dunedaq::timing::GIBV2IONode.

Definition at line 352 of file GIBIONode.cpp.

                              { // NOLINT(build/unsigned)
  // 6 SFPs on GIBv1
  return 6;
}

◆ get_pll()

std::unique_ptr< const SI534xSlave > dunedaq::timing::GIBIONode::get_pll ( ) const

overridevirtual

GET PLL I2C interface.

Reimplemented from dunedaq::timing::IONode.

Definition at line 92 of file GIBIONode.cpp.

{
  // enable pll channel 0 only
  set_i2c_mux_channels(0x1);
  return get_i2c_device<SI534xSlave>(m_pll_i2c_bus, m_pll_i2c_device);
}

◆ get_sfp_status()

std::string dunedaq::timing::GIBIONode::get_sfp_status	(	uint32_t	sfp_id,
		bool	print_out = false ) const

overridevirtual

Print status of on-board SFP.

Reimplemented from dunedaq::timing::IONode.

Definition at line 206 of file GIBIONode.cpp.

                                                               { // NOLINT(build/unsigned)
  std::stringstream status;
  
  validate_sfp_id(sfp_id);
 
  uint8_t i2c_mux_bitmask = 1UL << (sfp_id+1);
 
  set_i2c_mux_channels(i2c_mux_bitmask);
 
  auto sfp = get_i2c_device<I2CSFPSlave>(m_sfp_i2c_buses.at(sfp_id), "SFP_EEProm");
 
  status << "SFP " << sfp_id << ":" << std::endl;
  status << sfp->get_status();
 
  if (print_out)
    TLOG() << status.str();
 
  return status.str();
}

◆ get_sfp_tx_disable_bitmap()

uint8_t dunedaq::timing::GIBIONode::get_sfp_tx_disable_bitmap ( ) const

protectedvirtual

Reimplemented in dunedaq::timing::GIBV2IONode.

Definition at line 344 of file GIBIONode.cpp.

                                           { // NOLINT(build/unsigned)
  // First 6 bits are tx disable on GIBv1
  return 0xC0;
}

◆ get_status()

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

overridevirtual

Get status string, optionally print.

Implements dunedaq::timing::TimingNode.

Reimplemented in dunedaq::timing::GIBV3IONode.

Definition at line 53 of file GIBIONode.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;
 
  status << "Board temperature: " << read_board_temperature() << " [C]" << std::endl;
 
  if (print_out)
    TLOG() << std::endl << status.str();
  return status.str();
}

◆ get_uid_address_parameter_name()

std::string dunedaq::timing::GIBIONode::get_uid_address_parameter_name ( ) const

overridevirtual

Get the UID address parameter name.

Returns: { description_of_the_return_value }

Implements dunedaq::timing::IONode.

Definition at line 45 of file GIBIONode.cpp.

{
  return "UID_PROM";
}

◆ read_board_temperature()

float dunedaq::timing::GIBIONode::read_board_temperature ( ) const

Read board temp.

Definition at line 381 of file GIBIONode.cpp.

{
    auto temp_mon = get_i2c_device<LM75Node>(m_pll_i2c_bus, "TEMP_MON");
    return temp_mon->read_temperature();
}

◆ read_io_expanders()

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

virtual

Read the contents of the IO expanders.

Reimplemented in dunedaq::timing::GIBV3IONode.

Definition at line 229 of file GIBIONode.cpp.

                                   { // NOLINT(build/unsigned)
  auto sfp_expander_0 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander0");
  auto sfp_expander_1 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander1");
 
  uint32_t expander_bits = sfp_expander_1->read_inputs(0);
  expander_bits = (expander_bits << 8) + 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::GIBIONode::read_sfps_fault ( ) const

virtual

Retrive SFP fault status for all SFPs.

Reimplemented in dunedaq::timing::GIBV2IONode, and dunedaq::timing::GIBV3IONode.

Definition at line 260 of file GIBIONode.cpp.

                                 { // NOLINT(build/unsigned)
  uint32_t expander_bits = read_io_expanders();
 
  uint8_t fault_bits = 0x00;
 
  for (uint8_t sfp = 0; sfp<6; sfp++) {
    // Each SFP has 4 bits, the 4th bit is the fault
    // Adds the SFPs in inverse order
    fault_bits = (fault_bits << 1) + ((expander_bits >> (3 + 20 - 4*sfp)) & 1);
  }
 
  return fault_bits;
}

◆ read_sfps_los()

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

virtual

Retrive SFP LOS status for all SFPs.

Reimplemented in dunedaq::timing::GIBV2IONode, and dunedaq::timing::GIBV3IONode.

Definition at line 243 of file GIBIONode.cpp.

                               { // NOLINT(build/unsigned)
  uint32_t expander_bits = read_io_expanders();
 
  uint8_t los_bits = 0x00;
 
  for (uint8_t sfp = 0; sfp<6; sfp++) {
    // Each SFP has 4 bits, the 3rd bit is the LOS
    // Adds the SFPs in inverse order
    los_bits = (los_bits << 1) + ((expander_bits >> (2 + 20 - 4*sfp)) & 1);
  }
 
  return los_bits;
}

◆ reset() [1/2]

void dunedaq::timing::IONode::reset ( const ClockSource & clock_source ) const

virtual

Reset timing node with clock file lookup.

Reimplemented from dunedaq::timing::IONode.

Definition at line 184 of file IONode.cpp.

{
  TLOG() << "Setting IO preliminaries: I2C access, etc..";
  set_up_io_infrastructure();
 
  // Find the right pll config file
  std::string clock_config = get_full_clock_config_file_path(clock_source);
  reset(clock_config);
}

◆ reset() [2/2]

void dunedaq::timing::GIBIONode::reset ( const std::string & clock_config_file ) const

overridevirtual

Reset GIB IO.

Implements dunedaq::timing::IONode.

Definition at line 144 of file GIBIONode.cpp.

{
  getNode("csr.ctrl.rst").write(0x1);
  getNode("csr.ctrl.rst").write(0x0);
  getClient().dispatch();
 
  set_up_io_infrastructure();
 
  getNode("csr.ctrl.gps_clk_en").write(0x0);
 
  // Set filter to full bandwidth mode A = B = 0x0
  getNode("csr.ctrl.gps_clk_fltr_a").write(0x0);
  getNode("csr.ctrl.gps_clk_fltr_b").write(0x0);
  getClient().dispatch();
 
  // Upload config file to PLL
  configure_pll(clock_config_file);
 
  configure_expander();
 
  TLOG() << "Reset done";
}

◆ reset_pll()

void dunedaq::timing::GIBIONode::reset_pll ( ) const

overridevirtual

Reset PLL.

Implements dunedaq::timing::IONode.

Definition at line 197 of file GIBIONode.cpp.

{
  getNode("csr.ctrl.clk_gen_rst").write(0x0);
  getNode("csr.ctrl.clk_gen_rst").write(0x1);
}

◆ set_i2c_mux_channels()

void dunedaq::timing::GIBIONode::set_i2c_mux_channels ( uint8_t mux_channel_bitmask ) const

Fill hardware monitoring structure.

Give info to collector.

Configure which mux channels are on using a bitmask

Definition at line 370 of file GIBIONode.cpp.

                                                                 { // NOLINT(build/unsigned)
 
  uint8_t mux_channel_config = mux_channel_bitmask & 0x7f;
  
  auto i2c_bus = getNode<I2CMasterNode>("i2c");
  i2c_bus.write_i2cPrimitive(0x70, {mux_channel_config});
}

◆ set_up_io_infrastructure()

void dunedaq::timing::GIBIONode::set_up_io_infrastructure ( ) const

overridevirtual

Set up i2c buses, enable ICs.

Reimplemented from dunedaq::timing::IONode.

Definition at line 112 of file GIBIONode.cpp.

{
  // enclustra i2c switch stuff
  CarrierType carrier_type = convert_value_to_carrier_type(read_carrier_type());
  if (carrier_type == kCarrierEnclustraA35) {
    try {
      getNode<I2CMasterNode>(m_uid_i2c_bus).get_slave("AX3_Switch").write_i2c(0x01, 0x7f);
    } catch (const std::exception& e) {
      ers::warning(EnclustraSwitchFailure(ERS_HERE, e));
    }
  }
 
  // Reset I2C switch and expander, active low
  getNode("csr.ctrl.i2c_sw_rst").write(0x0);
  getNode("csr.ctrl.i2c_exten_rst").write(0x0);
  getNode("csr.ctrl.clk_gen_rst").write(0x0);
  getClient().dispatch();
 
  millisleep(1);
 
  // End reset 
  getNode("csr.ctrl.i2c_sw_rst").write(0x1);
  getNode("csr.ctrl.i2c_exten_rst").write(0x1);
  getNode("csr.ctrl.clk_gen_rst").write(0x1);
  getClient().dispatch();
 
  set_i2c_mux_channels(0x1);
}

◆ switch_sfp_soft_tx_control_bit()

void dunedaq::timing::GIBIONode::switch_sfp_soft_tx_control_bit	(	uint32_t	sfp_id,
		bool	turn_on ) const

overridevirtual

control tx laser of on-board SFP softly (I2C command)

Reimplemented from dunedaq::timing::IONode.

Definition at line 296 of file GIBIONode.cpp.

                                                                             { // NOLINT(build/unsigned)
  validate_sfp_id(sfp_id);
 
  auto sfp = get_i2c_device<I2CSFPSlave>(m_sfp_i2c_buses.at(sfp_id), "SFP_EEProm");
  sfp->switch_soft_tx_control_bit(turn_on);
}

◆ switch_sfp_tx()

void dunedaq::timing::GIBIONode::switch_sfp_tx	(	uint32_t	sfp_id,
		bool	turn_on ) const

overridevirtual

control tx laser of on-board SFP softly (I2C command)

Implements dunedaq::timing::IONode.

Reimplemented in dunedaq::timing::GIBV2IONode.

Definition at line 306 of file GIBIONode.cpp.

                                                            { // NOLINT(build/unsigned)
    validate_sfp_id(sfp_id);
 
  auto sfp_expander_1 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander1");
    uint8_t current_sfp_tx_control_flags = sfp_expander_1->read_outputs_config(1); // NOLINT(build/unsigned)
 
    uint8_t new_sfp_tx_control_flags; // NOLINT(build/unsigned)
    if (turn_on)
    {
        new_sfp_tx_control_flags = current_sfp_tx_control_flags & ~(1UL << sfp_id);
    }
  else
  {
    new_sfp_tx_control_flags = current_sfp_tx_control_flags | (1UL << sfp_id);
  }
 
  sfp_expander_1->set_outputs(1, new_sfp_tx_control_flags);
}

◆ validate_sfp_id()

void dunedaq::timing::GIBIONode::validate_sfp_id ( uint32_t sfp_id ) const

protected

Definition at line 360 of file GIBIONode.cpp.

                                                { // NOLINT(build/unsigned)
  // number of sfps on board defined by get_num_sfps
  if (sfp_id >= get_num_sfps()) {
        throw InvalidSFPId(ERS_HERE, format_reg_value(sfp_id));
  }
}

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

/github/workspace/dunedaq/sourcecode/timing/include/timing/GIBIONode.hpp
/github/workspace/dunedaq/sourcecode/timing/src/GIBIONode.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GIBIONode() [1/2]

◆ GIBIONode() [2/2]

◆ ~GIBIONode()

Member Function Documentation

◆ clocks_ok()

◆ configure_expander()

◆ get_hardware_info()

◆ get_num_sfps()

◆ get_pll()

◆ get_sfp_status()

◆ get_sfp_tx_disable_bitmap()

◆ get_status()

◆ get_uid_address_parameter_name()

◆ read_board_temperature()

◆ read_io_expanders()

◆ read_sfps_fault()

◆ read_sfps_los()

◆ reset() [1/2]

◆ reset() [2/2]

◆ reset_pll()

◆ set_i2c_mux_channels()

◆ set_up_io_infrastructure()

◆ switch_sfp_soft_tx_control_bit()

◆ switch_sfp_tx()

◆ validate_sfp_id()