dunedaq::timing::PC059IONode Class Reference

Class for the PC059 board. More...

#include <PC059IONode.hpp>

Inheritance diagram for dunedaq::timing::PC059IONode:

Collaboration diagram for dunedaq::timing::PC059IONode:

Public Member Functions
	PC059IONode (const uhal::Node &node)
virtual	~PC059IONode ()
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 pc059 node.
void	switch_sfp_mux_channel (uint32_t mux_channel) const override
	Switch the SFP mux channel.
uint32_t	read_active_sfp_mux_channel () const override
	Read the active SFP mux channel.
void	switch_sfp_i2c_mux_channel (uint32_t sfp_id) const
	Switch the SFP I2C mux channel.
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)
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)
virtual void	reset (const ClockSource &clock_source) const
	Reset IO, with clock file look up.
Public Member Functions inherited from dunedaq::timing::SFPMuxIONode
	SFPMuxIONode (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	~SFPMuxIONode ()
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::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.

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 PC059 board.

Definition at line 33 of file PC059IONode.hpp.

Constructor & Destructor Documentation

PC059IONode()

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

explicit

Definition at line 21 of file PC059IONode.cpp.

  : SFPMuxIONode(node, "i2c", "i2c", "SI5345", { "PLL", "CDR" }, { "usfp_i2c", "i2c" })
{}

~PC059IONode()

dunedaq::timing::PC059IONode::~PC059IONode ( )

virtual

Definition at line 27 of file PC059IONode.cpp.

{}

Member Function Documentation

clocks_ok()

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

overridevirtual

Clocks ready?

Implements dunedaq::timing::IONode.

Definition at line 181 of file PC059IONode.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) << "pll ok: " << pll_ok << ", mmcm ok: " << mmcm_ok;
 
  return pll_ok && mmcm_ok;
}

get_sfp_status()

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

{
  // on this board the upstream sfp has its own i2c bus, and the 8 downstream sfps are muxed onto the main i2c bus
  std::stringstream status;
  uint32_t sfp_bus_index; // NOLINT(build/unsigned)
  if (sfp_id == 0) {
    sfp_bus_index = 0;
    status << "Upstream SFP:" << std::endl;
  } else if (sfp_id > 0 && sfp_id < 9) {
    switch_sfp_i2c_mux_channel(sfp_id - 1);
    status << "Fanout SFP " << sfp_id - 1 << ":" << std::endl;
    sfp_bus_index = 1;
  } else {
    throw InvalidSFPId(ERS_HERE, format_reg_value(sfp_id));
  }
  auto sfp = get_i2c_device<I2CSFPSlave>(m_sfp_i2c_buses.at(sfp_bus_index), "SFP_EEProm");
 
  status << sfp->get_status();
 
  if (print_out)
    TLOG() << status.str();
  return status.str();
}

get_status()

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

overridevirtual

Get status string, optionally print.

Implements dunedaq::timing::TimingNode.

Definition at line 40 of file PC059IONode.cpp.

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

get_uid_address_parameter_name()

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

{
  return "FMC_UID_PROM";
}

read_active_sfp_mux_channel()

uint32_t dunedaq::timing::PC059IONode::read_active_sfp_mux_channel ( ) const

overridevirtual

Read the active SFP mux channel.

Implements dunedaq::timing::SFPMuxIONode.

Definition at line 127 of file PC059IONode.cpp.

{
  auto active_sfp_mux_channel = getNode("csr.ctrl.mux").read();
  getClient().dispatch();
  return active_sfp_mux_channel.value();
}

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

overridevirtual

Reset pc059 node.

Implements dunedaq::timing::IONode.

Definition at line 54 of file PC059IONode.cpp.

{
  // Soft reset
  write_soft_reset_register();
 
  millisleep(1000);
 
  // Reset PLL and I2C
  getNode("csr.ctrl.pll_rst").write(0x1);
  getNode("csr.ctrl.pll_rst").write(0x0);
 
  getNode("csr.ctrl.rst_i2c").write(0x1);
  getNode("csr.ctrl.rst_i2c").write(0x0);
 
  getNode("csr.ctrl.rst_i2cmux").write(0x1);
  getNode("csr.ctrl.rst_i2cmux").write(0x0);
 
  getClient().dispatch();
 
  // enclustra i2c switch stuff
  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();
 
  getNode("csr.ctrl.mux").write(0);
  getClient().dispatch();
 
  auto sfp_expander = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander");
 
  // Set invert registers to default for both banks
  sfp_expander->set_inversion(0, 0x00);
  sfp_expander->set_inversion(1, 0x00);
 
  // Bank 0 output, bank 1 input
  sfp_expander->set_io(0, 0x00);
  sfp_expander->set_io(1, 0xff);
 
  // Bank 0 - enable all SFPGs (enable low)
  sfp_expander->set_outputs(0, 0x00);
  TLOG_DEBUG(0) << "SFPs 0-7 enabled";
 
  // To be removed from firmware address maps also
  //getNode("csr.ctrl.rst_lock_mon").write(0x1);
  //getNode("csr.ctrl.rst_lock_mon").write(0x0);
  //getClient().dispatch();
 
  TLOG() << "Reset done";
}

switch_sfp_i2c_mux_channel()

void dunedaq::timing::PC059IONode::switch_sfp_i2c_mux_channel

(

uint32_t

sfp_id

)

const

Switch the SFP I2C mux channel.

Definition at line 137 of file PC059IONode.cpp.

{
 
  getNode("csr.ctrl.rst_i2cmux").write(0x1);
  getClient().dispatch();
  getNode("csr.ctrl.rst_i2cmux").write(0x0);
  getClient().dispatch();
  millisleep(100);
 
  uint8_t channel_select_byte = 1UL << sfp_id; // NOLINT(build/unsigned)
  getNode<I2CMasterNode>(m_pll_i2c_bus).get_slave("SFP_Switch").write_i2cPrimitive({ channel_select_byte });
  TLOG_DEBUG(3) << "PC059 SFP I2C mux set to " << format_reg_value(sfp_id);
}

switch_sfp_mux_channel()

void dunedaq::timing::PC059IONode::switch_sfp_mux_channel ( uint32_t mux_channel ) const

overridevirtual

Switch the SFP mux channel.

Implements dunedaq::timing::SFPMuxIONode.

Definition at line 116 of file PC059IONode.cpp.

{
  getNode("csr.ctrl.mux").write(mux_channel);
  getClient().dispatch();
 
  TLOG_DEBUG(3) << "SFP input mux set to " << format_reg_value(read_active_sfp_mux_channel());
}

switch_sfp_soft_tx_control_bit()

void dunedaq::timing::PC059IONode::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 197 of file PC059IONode.cpp.

{
  // on this board the upstream sfp has its own i2c bus, and the 8 downstream sfps are muxed onto the main i2c bus
  uint32_t sfp_bus_index; // NOLINT(build/unsigned)
  if (sfp_id == 0) {
    sfp_bus_index = 0;
  } else if (sfp_id > 0 && sfp_id < 9) {
    switch_sfp_i2c_mux_channel(sfp_id - 1);
    sfp_bus_index = 1;
  } else {
    throw InvalidSFPId(ERS_HERE, format_reg_value(sfp_id));
  }
  auto sfp = get_i2c_device<I2CSFPSlave>(m_sfp_i2c_buses.at(sfp_bus_index), "SFP_EEProm");
  sfp->switch_soft_tx_control_bit(turn_on);
}

switch_sfp_tx()

void dunedaq::timing::PC059IONode::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.

Definition at line 216 of file PC059IONode.cpp.

                                                              { // NOLINT(build/unsigned)
 
  validate_sfp_id(sfp_id);
 
  auto sfp_expander = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "SFPExpander");
    uint8_t current_sfp_tx_control_flags = sfp_expander->read_outputs_config(0); // 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->set_outputs(0, new_sfp_tx_control_flags);
}

validate_sfp_id()

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

private

Fill hardware monitoring structure.

Give info to collector.

Definition at line 239 of file PC059IONode.cpp.

{
  // on this board we have 8 downstream SFPs
    if (sfp_id > 7)
  {
    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/PC059IONode.hpp
• /github/workspace/dunedaq/sourcecode/timing/src/PC059IONode.cpp