dunedaq::timinglibs::TimingEndpointControllerBase Class Reference

TimingEndpointControllerBase is a DAQModule implementation that provides that provides a control interface for a timing endpoint. More...

#include <TimingEndpointControllerBase.hpp>

Inheritance diagram for dunedaq::timinglibs::TimingEndpointControllerBase:

Collaboration diagram for dunedaq::timinglibs::TimingEndpointControllerBase:

Public Member Functions
	TimingEndpointControllerBase (const std::string &name, uint number_hw_commands)
	TimingEndpointControllerBase Constructor.
	TimingEndpointControllerBase (const TimingEndpointControllerBase &)=delete
	TimingEndpointControllerBase is not copy-constructible.
TimingEndpointControllerBase &	operator= (const TimingEndpointControllerBase &)=delete
	TimingEndpointControllerBase is not copy-assignable.
	TimingEndpointControllerBase (TimingEndpointControllerBase &&)=delete
	TimingEndpointControllerBase is not move-constructible.
TimingEndpointControllerBase &	operator= (TimingEndpointControllerBase &&)=delete
	TimingEndpointControllerBase is not move-assignable.

Protected Member Functions
void	do_configure (const nlohmann::json &data) override
void	send_configure_hardware_commands (const nlohmann::json &data) override
timingcmd::TimingHwCmd	construct_endpoint_hw_cmd (const std::string &cmd_id, uint endpoint_id)
virtual void	do_endpoint_enable (const nlohmann::json &data)
virtual void	do_endpoint_disable (const nlohmann::json &data)
virtual void	do_endpoint_reset (const nlohmann::json &data)
void	process_device_info (nlohmann::json info) override

Protected Attributes
uint	m_managed_endpoint_id
std::atomic< uint >	m_endpoint_state

Detailed Description

TimingEndpointControllerBase is a DAQModule implementation that provides that provides a control interface for a timing endpoint.

Definition at line 36 of file TimingEndpointControllerBase.hpp.

Constructor & Destructor Documentation

TimingEndpointControllerBase() [1/3]

dunedaq::timinglibs::TimingEndpointControllerBase::TimingEndpointControllerBase ( const std::string & name, uint number_hw_commands )

explicit

TimingEndpointControllerBase Constructor.

Parameters

name	Instance name for this TimingEndpointControllerBase instance

Definition at line 34 of file TimingEndpointControllerBase.cpp.

  : dunedaq::timinglibs::TimingController(name, number_hw_commands) // 2nd arg: how many hw commands can this module send?
{
  // timing endpoint hardware commands
  register_command("endpoint_enable", &TimingEndpointControllerBase::do_endpoint_enable);
  register_command("endpoint_disable", &TimingEndpointControllerBase::do_endpoint_disable);
  register_command("endpoint_reset", &TimingEndpointControllerBase::do_endpoint_reset);
}

TimingEndpointControllerBase() [2/3]

dunedaq::timinglibs::TimingEndpointControllerBase::TimingEndpointControllerBase ( const TimingEndpointControllerBase & )

delete

TimingEndpointControllerBase is not copy-constructible.

TimingEndpointControllerBase() [3/3]

dunedaq::timinglibs::TimingEndpointControllerBase::TimingEndpointControllerBase ( TimingEndpointControllerBase && )

delete

TimingEndpointControllerBase is not move-constructible.

Member Function Documentation

construct_endpoint_hw_cmd()

timingcmd::TimingHwCmd dunedaq::timinglibs::TimingEndpointControllerBase::construct_endpoint_hw_cmd ( const std::string & cmd_id, uint endpoint_id )

protected

Definition at line 67 of file TimingEndpointControllerBase.cpp.

{
  timingcmd::TimingHwCmd hw_cmd;
  timingcmd::TimingEndpointCmdPayload cmd_payload;
  // where to check endpoint id validity
  cmd_payload.endpoint_id = endpoint_id;
  timingcmd::to_json(hw_cmd.payload, cmd_payload);
 
  hw_cmd.id = cmd_id;
  hw_cmd.device = m_timing_device;
  return hw_cmd;
}

do_configure()

void dunedaq::timinglibs::TimingEndpointControllerBase::do_configure ( const nlohmann::json & data )

overrideprotected

Definition at line 44 of file TimingEndpointControllerBase.cpp.

{
  auto mdal = m_params->cast<dal::TimingEndpointControllerConf>();
 
  TimingController::do_configure(data); // configure hw command connection
 
  // endpoint per device in config for now...
  m_managed_endpoint_id = {mdal->get_endpoint_id()};
 
  configure_hardware_or_recover_state<TimingEndpointNotReady>(data, "Timing endpoint", m_endpoint_state);
 
  TLOG() << get_name() << " conf done for endpoint, device: " << m_timing_device;
}

do_endpoint_disable()

void dunedaq::timinglibs::TimingEndpointControllerBase::do_endpoint_disable ( const nlohmann::json & data )

protectedvirtual

Definition at line 96 of file TimingEndpointControllerBase.cpp.

{
  timingcmd::TimingHwCmd hw_cmd =
  construct_hw_cmd( "endpoint_disable", data);
  send_hw_cmd(std::move(hw_cmd));
  ++(m_sent_hw_command_counters.at(3).atomic);
}

do_endpoint_enable()

void dunedaq::timinglibs::TimingEndpointControllerBase::do_endpoint_enable ( const nlohmann::json & data )

protectedvirtual

Definition at line 81 of file TimingEndpointControllerBase.cpp.

{
  timingcmd::TimingHwCmd hw_cmd =
  construct_hw_cmd( "endpoint_enable", data);
 
  // print out some debug info
  timingcmd::TimingEndpointConfigureCmdPayload cmd_payload;
  timingcmd::from_json(data, cmd_payload);
 
  TLOG_DEBUG(0) << "ept enable hw cmd; a: " << cmd_payload.address;
  send_hw_cmd(std::move(hw_cmd));
  ++(m_sent_hw_command_counters.at(2).atomic);
}

do_endpoint_reset()

void dunedaq::timinglibs::TimingEndpointControllerBase::do_endpoint_reset ( const nlohmann::json & data )

protectedvirtual

Definition at line 105 of file TimingEndpointControllerBase.cpp.

{
  timingcmd::TimingHwCmd hw_cmd =
  construct_hw_cmd( "endpoint_reset", data);
 
  send_hw_cmd(std::move(hw_cmd));
  ++(m_sent_hw_command_counters.at(4).atomic);
}

operator=() [1/2]

TimingEndpointControllerBase & dunedaq::timinglibs::TimingEndpointControllerBase::operator= ( const TimingEndpointControllerBase & )

delete

TimingEndpointControllerBase is not copy-assignable.

operator=() [2/2]

TimingEndpointControllerBase & dunedaq::timinglibs::TimingEndpointControllerBase::operator= ( TimingEndpointControllerBase && )

delete

TimingEndpointControllerBase is not move-assignable.

process_device_info()

void dunedaq::timinglibs::TimingEndpointControllerBase::process_device_info ( nlohmann::json info )

overrideprotected

Definition at line 131 of file TimingEndpointControllerBase.cpp.

{
  ++m_device_infos_received_count;
  
  timing::timingfirmwareinfo::TimingDeviceInfo device_info;
  from_json(info, device_info);
 
  auto ept_info = device_info.endpoint_info;
 
  m_endpoint_state = ept_info.state;
  bool ready = ept_info.ready;
 
  TLOG_DEBUG(3) << "state: 0x" << std::hex << m_endpoint_state << ", ready: " << ready << std::dec << ", infos received: " << m_device_infos_received_count;
 
  if (m_endpoint_state == 0x8 && ready)
  {
    if (!m_device_ready)
    {
      m_device_ready = true;
      TLOG_DEBUG(2) << "Timing endpoint became ready";
    }
  }
  else
 {
    if (m_device_ready)
    {
      m_device_ready = false;
      TLOG_DEBUG(2) << "Timing endpoint no longer ready";
    }
  }
}

send_configure_hardware_commands()

void dunedaq::timinglibs::TimingEndpointControllerBase::send_configure_hardware_commands ( const nlohmann::json & data )

overrideprotected

Definition at line 59 of file TimingEndpointControllerBase.cpp.

{
  do_io_reset(data);
  std::this_thread::sleep_for(std::chrono::microseconds(7000000));
  do_endpoint_enable(data);
}

Member Data Documentation

m_endpoint_state

std::atomic<uint> dunedaq::timinglibs::TimingEndpointControllerBase::m_endpoint_state

protected

Definition at line 69 of file TimingEndpointControllerBase.hpp.

m_managed_endpoint_id

uint dunedaq::timinglibs::TimingEndpointControllerBase::m_managed_endpoint_id

protected

Definition at line 54 of file TimingEndpointControllerBase.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/timinglibs/include/timinglibs/TimingEndpointControllerBase.hpp
• /github/workspace/dunedaq/sourcecode/timinglibs/src/TimingEndpointControllerBase.cpp