dunedaq::timing::TLUIONode Class Reference

Class for the TLU board. More...

#include <TLUIONode.hpp>

Inheritance diagram for dunedaq::timing::TLUIONode:

Collaboration diagram for dunedaq::timing::TLUIONode:

Public Member Functions
	TLUIONode (const uhal::Node &node)
virtual	~TLUIONode ()
std::string	get_uid_address_parameter_name () const override
	Get the UID address parameter name.
std::string	get_status (bool print_out=false) const
	Print the status of the timing node.
void	reset (const std::string &clock_config_file) const override
	Reset IO node.
void	configure_dac (uint32_t dac_id, uint32_t dac_value, bool internal_ref=false) const
	Configure on-board DAC.
std::string	get_sfp_status (uint32_t sfp_id, bool print_out=false) const override
	Print status of on-board SFP.
bool	clocks_ok () const override
	Clocks ready?
void	switch_sfp_soft_tx_control_bit (uint32_t, bool) const override
	Control tx laser of on-board SFP softly (I2C command)
void	switch_sfp_tx (uint32_t, bool) 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::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.

Protected Attributes
const std::vector< std::string >	m_dac_devices
	Fill hardware monitoring structure.
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

Private Member Functions
void	validate_sfp_id (uint32_t sfp_id) const

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)
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 TLU board.

Definition at line 33 of file TLUIONode.hpp.

Constructor & Destructor Documentation

TLUIONode()

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

explicit

Definition at line 19 of file TLUIONode.cpp.

  : IONode(node, "i2c", "i2c", "SI5345", { "PLL" }, {})
  , m_dac_devices({ "DAC1", "DAC2" })
{}

~TLUIONode()

dunedaq::timing::TLUIONode::~TLUIONode ( )

virtual

Definition at line 26 of file TLUIONode.cpp.

{}

Member Function Documentation

clocks_ok()

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

overridevirtual

Clocks ready?

Implements dunedaq::timing::IONode.

Definition at line 151 of file TLUIONode.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 check pll lock when appropiate
}

configure_dac()

void dunedaq::timing::TLUIONode::configure_dac	(	uint32_t	dac_id,
		uint32_t	dac_value,
		bool	internal_ref = false ) const

Configure on-board DAC.

Definition at line 126 of file TLUIONode.cpp.

{
  std::string dac_device;
  try {
    dac_device = m_dac_devices.at(dac_id);
  } catch (const std::out_of_range& e) {
    throw InvalidDACId(ERS_HERE, format_reg_value(dac_id));
  }
  auto dac = get_i2c_device<DACSlave>(m_uid_i2c_bus, dac_device);
  dac->set_interal_ref(internal_ref);
  dac->set_dac(7, dac_value);
}

get_sfp_status()

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

{
  TLOG() << "TLU does not support SFP I2C";
  return "";
}

get_status()

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

virtual

Print the status of the timing node.

Implements dunedaq::timing::TimingNode.

Definition at line 39 of file TLUIONode.cpp.

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

get_uid_address_parameter_name()

std::string dunedaq::timing::TLUIONode::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 TLUIONode.cpp.

{
  return "UID_PROM";
}

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

overridevirtual

Reset IO node.

Implements dunedaq::timing::IONode.

Definition at line 53 of file TLUIONode.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);
 
  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);
 
  // Tweak the PLL swing
  auto si_chip = get_pll();
  si_chip->write_i2cArray(0x113, { 0x9, 0x33 });
 
  // Reset mmcm
  getNode("csr.ctrl.rst").write(0x1);
  getNode("csr.ctrl.rst").write(0x0);
  getClient().dispatch();
 
  // configure tlu io expanders
  auto ic_6 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "Expander1");
  auto ic_7 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "Expander2");
 
  // Bank 0
  ic_6->set_inversion(0, 0x00);
  ic_6->set_io(0, 0x00);
  ic_6->set_outputs(0, 0x00);
 
  // Bank 1
  ic_6->set_inversion(1, 0x00);
  ic_6->set_io(1, 0x00);
  ic_6->set_outputs(1, 0x88);
 
  // Bank 0
  ic_7->set_inversion(0, 0x00);
  ic_7->set_io(0, 0x00);
  ic_7->set_outputs(0, 0xf0);
 
  // Bank 1
  ic_7->set_inversion(1, 0x00);
  ic_7->set_io(1, 0x00);
  ic_7->set_outputs(1, 0xf0);
 
  // BI signals are NIM
  uint32_t bi_signal_threshold = 0x589D; // NOLINT(build/unsigned)
 
  configure_dac(0, bi_signal_threshold);
  configure_dac(1, bi_signal_threshold);
 
  TLOG_DEBUG(0) << "DAC1 and DAC2 set to " << std::hex << bi_signal_threshold;
 
  TLOG() << "Reset done";
}

switch_sfp_soft_tx_control_bit()

void dunedaq::timing::TLUIONode::switch_sfp_soft_tx_control_bit ( uint32_t , bool  ) const

overridevirtual

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

Reimplemented from dunedaq::timing::IONode.

Definition at line 167 of file TLUIONode.cpp.

{
  TLOG() << "TLU does not support SFP I2C";
}

switch_sfp_tx()

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

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

validate_sfp_id()

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

private

Definition at line 186 of file TLUIONode.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));
  }
}

Member Data Documentation

m_dac_devices

const std::vector<std::string> dunedaq::timing::TLUIONode::m_dac_devices

protected

Fill hardware monitoring structure.

Give info to collector.

Definition at line 99 of file TLUIONode.hpp.

---

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

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