dunedaq::timing::ChronosDesign Class Reference

Class for timing master with integrated HSI designs. More...

#include <ChronosDesign.hpp>

Inheritance diagram for dunedaq::timing::ChronosDesign:

Collaboration diagram for dunedaq::timing::ChronosDesign:

Public Member Functions
	ChronosDesign (const uhal::Node &node)
virtual	~ChronosDesign ()
std::string	get_status (bool print_out=false) const override
	Get status string, optionally print.
void	configure (ClockSource clock_source) const override
	Prepare the timing endpoint for data taking.
uint32_t	read_firmware_version () const override
	Read endpoint firmware version.
void	validate_firmware_version () const override
	Validate endpoint firmware version.
void	get_info (timingfirmwareinfo::TimingDeviceInfo &mon_data) const override
	Give info to collector.
Public Member Functions inherited from dunedaq::timing::TopDesign
	TopDesign (const uhal::Node &node)
virtual	~TopDesign ()
const IONode *	get_io_node_plain () const override
	Get io node pointer.
void	soft_reset_io () const override
	Reset timing node.
void	reset_io (const std::string &clock_config_file) const override
	Reset timing node.
void	reset_io (const ClockSource &clock_source) const override
	Reset timing node.
void	configure (ClockSource clock_source) const override
	Prepare the timing device for data taking.
std::string	get_hardware_info (bool print_out=false) const override
	Print hardware information.
void	get_info (timingfirmwareinfo::TimingDeviceInfo &mon_data) const override
	Give info to collector.
Public Member Functions inherited from dunedaq::timing::TopDesignInterface
	TopDesignInterface (const uhal::Node &node)
virtual	~TopDesignInterface ()
template<class IO >
const IO *	get_io_node () 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.
Public Member Functions inherited from dunedaq::timing::HSIDesignInterface
	HSIDesignInterface (const uhal::Node &node)
virtual	~HSIDesignInterface ()
virtual const HSINode &	get_hsi_node () const
	Get the HSI node.
virtual void	configure_hsi (uint32_t src, uint32_t re_mask, uint32_t fe_mask, uint32_t inv_mask, double rate, bool dispatch=true) const
	Configure the HSI node.
void	get_info (timingfirmwareinfo::TimingDeviceInfo &mon_data) const override
	Give info to collector.
virtual void	get_info (timingfirmwareinfo::HSIFirmwareMonitorData &mon_data) const
	Give info to collector.
virtual void	get_info (uint32_t ept_id, timingendpointinfo::TimingEndpointInfo &mon_data) const
	Give info to collector.
Public Member Functions inherited from dunedaq::timing::EndpointDesignInterface
	EndpointDesignInterface (const uhal::Node &node)
virtual	~EndpointDesignInterface ()
virtual const EndpointNodeInterface *	get_endpoint_node_plain (uint32_t ept_id) const
	Return the timing endpoint node.
virtual uint32_t	get_number_of_endpoint_nodes () const
	Return the timing endpoint node.

Detailed Description

Class for timing master with integrated HSI designs.

Definition at line 34 of file ChronosDesign.hpp.

Constructor & Destructor Documentation

ChronosDesign()

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

explicit

Definition at line 19 of file ChronosDesign.cpp.

  : TopDesignInterface(node)
  , EndpointDesignInterface(node)
  , TopDesign(node)
  , HSIDesignInterface(node)
{}

~ChronosDesign()

dunedaq::timing::ChronosDesign::~ChronosDesign ( )

virtual

Definition at line 28 of file ChronosDesign.cpp.

{}

Member Function Documentation

configure()

void dunedaq::timing::ChronosDesign::configure ( ClockSource clock_source ) const

overridevirtual

Prepare the timing endpoint for data taking.

Implements dunedaq::timing::TopDesignInterface.

Definition at line 48 of file ChronosDesign.cpp.

{
  TopDesign::configure(clock_source);
  // TODO ept configure
  // TODO HSI configure
}

get_info()

void dunedaq::timing::ChronosDesign::get_info ( timingfirmwareinfo::TimingDeviceInfo & mon_data ) const

overridevirtual

Give info to collector.

Implements dunedaq::timing::TopDesignInterface.

Definition at line 58 of file ChronosDesign.cpp.

{
  TopDesign::get_info(mon_data);
  HSIDesignInterface::get_info(mon_data);
}

get_status()

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

overridevirtual

Get status string, optionally print.

Implements dunedaq::timing::TimingNode.

Definition at line 34 of file ChronosDesign.cpp.

{
  std::stringstream status;
  status << get_io_node_plain()->get_pll_status();
  status << get_endpoint_node_plain(0)->get_status();
  status << get_hsi_node().get_status();
  if (print_out)
    TLOG() << status.str();
  return status.str();
}

read_firmware_version()

uint32_t dunedaq::timing::ChronosDesign::read_firmware_version ( ) const

inlineoverridevirtual

Read endpoint firmware version.

Returns

{ description_of_the_return_value }

Implements dunedaq::timing::TopDesignInterface.

Definition at line 57 of file ChronosDesign.hpp.

                                                  { // NOLINT(build/unsigned)
    // current chronos firmware does not store firmware version
    return 0;
  } 

validate_firmware_version()

void dunedaq::timing::ChronosDesign::validate_firmware_version ( ) const

inlineoverridevirtual

Validate endpoint firmware version.

Implements dunedaq::timing::TopDesignInterface.

Definition at line 66 of file ChronosDesign.hpp.

{} // current chronos firmware does not store firmware version

---

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

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