MasterNodeInterface.hpp

Go to the documentation of this file.

 
#ifndef TIMING_INCLUDE_TIMING_MASTERNODEINTERFACE_HPP_
#define TIMING_INCLUDE_TIMING_MASTERNODEINTERFACE_HPP_
 
// PDT Headers
#include "TimingIssues.hpp"
#include "timing/EchoMonitorNode.hpp"
#include "timing/FLCmdGeneratorNode.hpp"
#include "timing/TimestampGeneratorNode.hpp"
#include "timing/TimingNode.hpp"
#include "timing/VLCmdGeneratorNode.hpp"
 
#include "timing/timingfirmware/Nljs.hpp"
#include "timing/timingfirmware/Structs.hpp"
 
#include "timing/timingfirmwareinfo/Nljs.hpp"
#include "timing/timingfirmwareinfo/Structs.hpp"
 
// uHal Headers
#include "uhal/DerivedNode.hpp"
 
// C++ Headers
#include <chrono>
 
namespace dunedaq {
namespace timing {

class MasterNodeInterface : public TimingNode
{
public:
  explicit MasterNodeInterface(const uhal::Node& node);
  virtual ~MasterNodeInterface();

  virtual uint64_t read_timestamp() const = 0; // NOLINT(build/unsigned)

  virtual void set_timestamp(TimestampSource source) const = 0; // NOLINT(build/unsigned)

  virtual void sync_timestamp(TimestampSource source) const = 0; // NOLINT(build/unsigned)

  virtual void switch_endpoint_sfp(uint32_t address, bool turn_on) const = 0; // NOLINT(build/unsigned)

  virtual void enable_upstream_endpoint() const = 0;

  virtual uint32_t measure_endpoint_rtt(uint32_t address, bool control_sfp = true) const = 0; // NOLINT(build/unsigned)

  virtual void apply_endpoint_delay(uint32_t address,      // NOLINT(build/unsigned)
                                    uint32_t coarse_delay, // NOLINT(build/unsigned)
                                    uint32_t fine_delay,   // NOLINT(build/unsigned)
                                    uint32_t phase_delay,  // NOLINT(build/unsigned)
                                    bool measure_rtt = false,
                                    bool control_sfp = true) const = 0;

  virtual void apply_endpoint_delay(const ActiveEndpointConfig& ept_config, bool measure_rtt = false) const;

  virtual void send_fl_cmd(uint32_t command,                           // NOLINT(build/unsigned)
                           uint32_t channel,                           // NOLINT(build/unsigned)
                           uint32_t number_of_commands = 1) const = 0; // NOLINT(build/unsigned)

  virtual void enable_periodic_fl_cmd(uint32_t channel, double rate, bool poisson, uint32_t clock_frequency_hz) const; // NOLINT(build/unsigned)

  virtual void enable_periodic_fl_cmd(uint32_t command, uint32_t channel, double rate, bool poisson, uint32_t clock_frequency_hz) const; // NOLINT(build/unsigned)

  virtual void disable_periodic_fl_cmd(uint32_t channel) const; // NOLINT(build/unsigned)

  virtual timingfirmware::EndpointCheckResult scan_endpoint(uint16_t endpoint_address, bool control_sfp) const = 0;

  virtual uint32_t get_required_major_firmware_version() const = 0;

  virtual uint32_t get_required_minor_firmware_version() const = 0;

  virtual uint32_t get_required_patch_firmware_version() const = 0;

  virtual void get_info(timingfirmwareinfo::MasterMonitorData& mon_data) const = 0;
 
};
 
} // namespace timing
} // namespace dunedaq
 
#endif // TIMING_INCLUDE_TIMING_MASTERNODEINTERFACE_HPP_