dunedaq::timing::FIBIONode Class Reference

Class for the FIB board. More...

#include <FIBIONode.hpp>

Inheritance diagram for dunedaq::timing::FIBIONode:

Collaboration diagram for dunedaq::timing::FIBIONode:

Public Member Functions
	FIBIONode (const uhal::Node &aNode)
virtual	~FIBIONode ()
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 FIB 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.
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	reset_pll () const
	reset on-board PLL using I2C IO expanders
uint8_t	read_sfp_los_flag (uint32_t sfp_id) const
	reset on-board SFP flags using I2C IO expanders
uint8_t	read_sfp_fault_flag (uint32_t sfp_id) const
	reset on-board SFP flags using I2C IO expanders
uint8_t	read_sfp_los_flags () const
	reset on-board SFP flags using I2C IO expanders
uint8_t	read_sfp_fault_flags () const
	reset on-board SFP flags using I2C IO expanders
void	switch_sfp_tx (uint32_t sfp_id, bool turn_on) const override
	reset on-board SFP flags using I2C IO expanders
bool	clocks_ok () const override
	Clocks ready?
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 FIB board.

Definition at line 32 of file FIBIONode.hpp.

Constructor & Destructor Documentation

FIBIONode()

dunedaq::timing::FIBIONode::FIBIONode ( const uhal::Node & aNode )

explicit

Definition at line 22 of file FIBIONode.cpp.

                                          :
    SFPMuxIONode(aNode, "i2c", "i2c", "SI5345", {"PLL", "BKP DATA"}, {"i2c_sfp0", "i2c_sfp1", "i2c_sfp2", "i2c_sfp3", "i2c_sfp4", "i2c_sfp5", "i2c_sfp6", "i2c_sfp7"}) {
}

~FIBIONode()

dunedaq::timing::FIBIONode::~FIBIONode ( )

virtual

Definition at line 29 of file FIBIONode.cpp.

                      {
}

Member Function Documentation

clocks_ok()

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

overridevirtual

Clocks ready?

Implements dunedaq::timing::IONode.

Definition at line 264 of file FIBIONode.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::FIBIONode::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 163 of file FIBIONode.cpp.

                                                               { // NOLINT(build/unsigned)
    std::stringstream status;
    
    validate_sfp_id(sfp_id);
 
    std::string sfp_i2c_bus = "i2c_sfp" + std::to_string(sfp_id);
    auto sfp = get_i2c_device<I2CSFPSlave>(sfp_i2c_bus, "SFP_EEProm");
    status << "Fanout SFP " << sfp_id << ":" << std::endl;
    status << sfp->get_status();    
    
    if (print_out)
        TLOG() << status.str();
 
    return status.str();
}

get_status()

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

overridevirtual

Get status string, optionally print.

Implements dunedaq::timing::TimingNode.

Definition at line 43 of file FIBIONode.cpp.

                                          {
    std::stringstream status;
    auto subnodes = read_sub_nodes(getNode("csr.stat"));
 
    uint32_t sfp_los_flags = read_sfp_los_flags(); // NOLINT(build/unsigned)
    uint32_t sfp_fault_flags = read_sfp_fault_flags(); // NOLINT(build/unsigned)
    
    std::vector<std::pair<std::string, std::string>> sfps_summary;
    sfps_summary.push_back(std::make_pair("SFP LOS flags", format_reg_value(sfp_los_flags, 16)));
    sfps_summary.push_back(std::make_pair("SFP fault flags", format_reg_value(sfp_fault_flags, 16)));
 
    status << format_reg_table(subnodes, "FIB IO state") << std::endl;
    status << format_reg_table(sfps_summary, "FIB SFPs state");
 
    if (print_out)
      TLOG() << status.str();
 
    return status.str();
}

get_uid_address_parameter_name()

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

{
  return "UID_PROM";
}

read_active_sfp_mux_channel()

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

overridevirtual

Read the active SFP mux channel.

Implements dunedaq::timing::SFPMuxIONode.

Definition at line 153 of file FIBIONode.cpp.

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

read_sfp_fault_flag()

uint8_t dunedaq::timing::FIBIONode::read_sfp_fault_flag

(

uint32_t

sfp_id

)

const

reset on-board SFP flags using I2C IO expanders

Definition at line 234 of file FIBIONode.cpp.

                                                    { // NOLINT(build/unsigned)
    return read_sfp_fault_flags() & (1UL << sfp_id);
}

read_sfp_fault_flags()

uint8_t dunedaq::timing::FIBIONode::read_sfp_fault_flags

(

)

const

reset on-board SFP flags using I2C IO expanders

Definition at line 216 of file FIBIONode.cpp.

                                      {
    auto ic_10 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "Expander1");
    
    uint8_t sfp_fault_flags = ic_10->read_inputs(0x01); // NOLINT(build/unsigned)
    return sfp_fault_flags;
}

read_sfp_los_flag()

uint8_t dunedaq::timing::FIBIONode::read_sfp_los_flag

(

uint32_t

sfp_id

)

const

reset on-board SFP flags using I2C IO expanders

Definition at line 226 of file FIBIONode.cpp.

                                                  { // NOLINT(build/unsigned)
    return read_sfp_los_flags() & (1UL << sfp_id);
}

read_sfp_los_flags()

uint8_t dunedaq::timing::FIBIONode::read_sfp_los_flags

(

)

const

reset on-board SFP flags using I2C IO expanders

Definition at line 205 of file FIBIONode.cpp.

                                    {
    auto ic_23 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "Expander2");
 
    uint8_t sfp_los_flags = ic_23->read_inputs(0x01); // NOLINT(build/unsigned)
    return sfp_los_flags;
}

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

overridevirtual

Reset FIB node.

Implements dunedaq::timing::IONode.

Definition at line 67 of file FIBIONode.cpp.

                                                         {
    
    // Soft reset
    write_soft_reset_register();
    
    millisleep(1000);
 
    // Reset I2C
    getNode("csr.ctrl.rstb_i2c").write(0x1);
    getNode("csr.ctrl.rstb_i2c").write(0x0);
 
    getNode("csr.ctrl.rst").write(0x1);
    getNode("csr.ctrl.rst").write(0x0);
 
    getClient().dispatch();
 
    const CarrierType carrier_type = convert_value_to_carrier_type(read_carrier_type());
 
    if (carrier_type == kCarrierEnclustraA35) {
        // 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));
        }
    }
    
    // Configure I2C IO expanders
    auto ic_10 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "Expander1");
    auto ic_23 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "Expander2");
 
    // Bank 0
    ic_10->set_inversion(0, 0x00);
    
    //  all out, sfp tx disable
    ic_10->set_io(0, 0x00);
    // sfp laser on by default
    ic_10->set_outputs(0, 0x00);
 
    // Bank 1
    ic_10->set_inversion(1, 0x00);
    // all inputs, sfp fault
    ic_10->set_io(1, 0xff);
 
    // Bank 0
    ic_23->set_inversion(0, 0x00);
    // pin 0 - out: pll rst, pins 1-4 pll and cdr flags
    ic_23->set_io(0, 0xfe);
    ic_23->set_outputs(0, 0x01);
 
    // Bank 1
    ic_23->set_inversion(1, 0x00);
    // all inputs, sfp los
    ic_23->set_io(1, 0xff);
 
    // reset pll via I2C IO expanders
    reset_pll();
 
    // Upload config file to PLL
    configure_pll(clock_config_file);
    
    //getNode("csr.ctrl.inmux").write(0);
    //getClient().dispatch();
    
// 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";
}

reset_pll()

void dunedaq::timing::FIBIONode::reset_pll

(

)

const

reset on-board PLL using I2C IO expanders

Definition at line 196 of file FIBIONode.cpp.

                           {
    auto ic_23 = get_i2c_device<I2CExpanderSlave>(m_uid_i2c_bus, "Expander2");
    ic_23->set_outputs(0, 0x00);
    ic_23->set_outputs(0, 0x01);
}

switch_sfp_mux_channel()

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

overridevirtual

Switch the SFP mux channel.

Implements dunedaq::timing::SFPMuxIONode.

Definition at line 142 of file FIBIONode.cpp.

                                                            { // NOLINT(build/unsigned)
    validate_sfp_id(mux_channel);
    getNode("csr.ctrl.inmux").write(mux_channel);
    getClient().dispatch(); 
    TLOG_DEBUG(0) << "SFP input mux set to " << read_active_sfp_mux_channel();
}

switch_sfp_soft_tx_control_bit()

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

                                                                             { // NOLINT(build/unsigned)
    validate_sfp_id(sfp_id);
 
    // on this board the 8 downstream sfps have their own i2c bus
    std::string sfp_i2c_bus = "i2c_sfp" + std::to_string(sfp_id);
    auto sfp = get_i2c_device<I2CSFPSlave>(sfp_i2c_bus, "SFP_EEProm");
    sfp->switch_soft_tx_control_bit(turn_on);
}

switch_sfp_tx()

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

overridevirtual

reset on-board SFP flags using I2C IO expanders

Switch on or off the SFP tx laser via the I2C IO expander controlling the sfp tx disable pin. aOn=1: laster transmitting, tx disable pin = 0; aOn=0: laster NOT transmitting, tx disable pin = 1.

Implements dunedaq::timing::IONode.

Definition at line 242 of file FIBIONode.cpp.

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

validate_sfp_id()

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

private

Fill hardware monitoring structure.

Give info to collector.

Definition at line 280 of file FIBIONode.cpp.

                                                { // NOLINT(build/unsigned)
    // 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/FIBIONode.hpp
• /github/workspace/dunedaq/sourcecode/timing/src/FIBIONode.cpp