dunedaq::timing::FMCIONode Class Reference

Class for the timing FMC board. More...

#include <FMCIONode.hpp>

Inheritance diagram for dunedaq::timing::FMCIONode:

Collaboration diagram for dunedaq::timing::FMCIONode:

Public Member Functions
	FMCIONode (const uhal::Node &node)
virtual	~FMCIONode ()
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.
void	reset (const std::string &clock_config_file) const override
	Reset FMC IO.
std::vector< double >	read_clock_frequencies () const override
	Read frequencies of on-board clocks.
std::string	get_clock_frequencies_table (bool print_out=false) const override
	Print frequencies of on-board clocks.
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
virtual void	reset (const ClockSource &clock_source) const
	Reset IO, with clock file look up.
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_hardware_info (bool print_out=false) const
	Print hardware information.
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 std::unique_ptr< const SI534xSlave >	get_pll () const
	Get the PLL chip.
virtual void	configure_pll (const std::string &clock_config_file="") const
	Configure clock chip.
virtual std::string	get_pll_status (bool print_out=false) const
	Print status of on-board PLL.
virtual std::string	get_sfp_status (uint32_t sfp_id, bool print_out=false) const
	Print status of on-board SFP.
virtual void	switch_sfp_soft_tx_control_bit (uint32_t sfp_id, bool turn_on) const
	control tx laser of on-board SFP softly (I2C command)
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.

Private Member Functions
void	validate_sfp_id (uint32_t sfp_id) const
	Fill hardware monitoring structure.

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::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 FMCIONode.hpp.

Constructor & Destructor Documentation

FMCIONode()

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

explicit

Definition at line 19 of file FMCIONode.cpp.

  : IONode(node, "uid_i2c", "pll_i2c", "i2caddr", { "PLL", "CDR" }, { "sfp_i2c" })
{
}

~FMCIONode()

dunedaq::timing::FMCIONode::~FMCIONode ( )

virtual

Definition at line 26 of file FMCIONode.cpp.

{}

Member Function Documentation

clocks_ok()

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

overridevirtual

Clocks ready?

Implements dunedaq::timing::IONode.

Definition at line 160 of file FMCIONode.cpp.

{
  std::stringstream status;
 
  auto states = read_sub_nodes(getNode("csr.stat"));
  //bool pll_ok = states.find("pll_ok")->second.value();
  bool mmcm_ok = states.find("mmcm_ok")->second.value();
  
  TLOG_DEBUG(5) << ", mmcm ok: " << mmcm_ok;
 
  return mmcm_ok; // TODO for EPT, check pll lock
}

get_clock_frequencies_table()

std::string dunedaq::timing::FMCIONode::get_clock_frequencies_table ( bool print_out = false ) const

overridevirtual

Print frequencies of on-board clocks.

Reimplemented from dunedaq::timing::IONode.

Definition at line 136 of file FMCIONode.cpp.

{
  std::vector<std::string> clock_names( {"PLL", "CDR"});
  // using cdr...?
  auto no_cdr = getNode("config.no_cdr").read();
  getClient().dispatch();
  if (no_cdr)
  {
    clock_names.push_back("SMPL");
  }
  std::stringstream table;
  std::vector<double> frequencies = read_clock_frequencies();
  for (uint8_t i = 0; i < frequencies.size(); ++i) { // NOLINT(build/unsigned)
    table << clock_names.at(i) << " freq: " << std::setprecision(12) << frequencies.at(i) << std::endl;
  }
  // TODO add freq validation Stoyan Trilov stoyan.trilov@cern.ch
  if (print_out)
    TLOG() << table.str();
  return table.str();
}

get_status()

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

overridevirtual

Get status string, optionally print.

Implements dunedaq::timing::TimingNode.

Definition at line 45 of file FMCIONode.cpp.

{
  std::stringstream status;
 
  auto subnodes = read_sub_nodes(getNode("csr.stat"));
  status << format_reg_table(subnodes, "FMC IO state");
 
  if (print_out)
    TLOG() << std::endl << status.str();
  return status.str();
}

get_uid_address_parameter_name()

std::string dunedaq::timing::FMCIONode::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 31 of file FMCIONode.cpp.

{
  CarrierType carrier_type = convert_value_to_carrier_type(read_carrier_type());
 
  if (carrier_type == kCarrierNexusVideo || carrier_type == kCarrierAFC) {
    return "FMC_UID_PROM_NEXUS";
  } else {
    return "FMC_UID_PROM";
  }
}

read_clock_frequencies()

std::vector< double > dunedaq::timing::FMCIONode::read_clock_frequencies ( ) const

overridevirtual

Read frequencies of on-board clocks.

Reimplemented from dunedaq::timing::IONode.

Definition at line 119 of file FMCIONode.cpp.

{
  std::vector<std::string> clock_names( {"PLL", "CDR"});
  // using cdr...?
  auto no_cdr = getNode("config.no_cdr").read();
  getClient().dispatch();
  if (no_cdr)
  {
    clock_names.push_back("SMPL");
  }
  
  return getNode<FrequencyCounterNode>("freq").measure_frequencies(clock_names.size());
}

reset() [1/2]

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

virtual

Reset IO, with clock file look up.

Reimplemented from dunedaq::timing::IONode.

Definition at line 179 of file IONode.cpp.

{
  // 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::FMCIONode::reset ( const std::string & clock_config_file ) const

overridevirtual

Reset FMC IO.

Implements dunedaq::timing::IONode.

Definition at line 60 of file FMCIONode.cpp.

{
  write_soft_reset_register();
 
  millisleep(1000);
 
  // Reset PLL
  getNode("csr.ctrl.pll_rst").write(0x1);
  getNode("csr.ctrl.pll_rst").write(0x0);
  getClient().dispatch();
 
  CarrierType carrier_type = convert_value_to_carrier_type(read_carrier_type());
 
  // enclustra i2c switch stuff
  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));
    }
  }
 
  // Upload config file to PLL
  configure_pll(clock_config_file);
 
  // Reset mmcm
  getNode("csr.ctrl.rst").write(0x1);
  getNode("csr.ctrl.rst").write(0x0);
  getClient().dispatch();
 
  // Enable sfp tx laser
  getNode("csr.ctrl.sfp_tx_dis").write(0x0);
 
  // rx edges
  uint32_t cdr_rx_edge = 0x0; // NOLINT(build/unsigned)
  uint32_t sfp_rx_edge = 0x0; // NOLINT(build/unsigned)
  uint32_t rj45_rx_edge = 0x0; // NOLINT(build/unsigned)
 
  // tx edges
  uint32_t sfp_tx_edge = 0x0; // NOLINT(build/unsigned)
  uint32_t rj45_tx_edge = 0x0; // NOLINT(build/unsigned)
 
  // rx edges
  getNode("csr.ctrl.cdr_rx_edge").write(cdr_rx_edge);
  getNode("csr.ctrl.sfp_rx_edge").write(sfp_rx_edge);
  getNode("csr.ctrl.rj45_rx_edge").write(rj45_rx_edge);
 
  // tx edges
  getNode("csr.ctrl.sfp_tx_edge").write(sfp_tx_edge);
  getNode("csr.ctrl.rj45_tx_edge").write(rj45_tx_edge);
 
  getClient().dispatch();
 
  TLOG() << "Reset done";
}

switch_sfp_tx()

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

overridevirtual

control tx laser of on-board SFP

Implements dunedaq::timing::IONode.

Definition at line 219 of file FMCIONode.cpp.

{
  validate_sfp_id(sfp_id);
 
  getNode("csr.ctrl.sfp_tx_dis").write(!turn_on);
  getClient().dispatch();
}

validate_sfp_id()

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

private

Fill hardware monitoring structure.

Give info to collector.

Definition at line 230 of file FMCIONode.cpp.

{ // NOLINT(build/unsigned)
  // on this board we have 3 upstream SFPs
  if (sfp_id != 0)
  {
    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/FMCIONode.hpp
• /github/workspace/dunedaq/sourcecode/timing/src/FMCIONode.cpp