DAPHNEEthStreamFrame.hpp

Go to the documentation of this file.

 
#ifndef FDDETDATAFORMATS_INCLUDE_FDDETDATAFORMATS_DAPHNEETHSTREAMFRAME_HPP_
#define FDDETDATAFORMATS_INCLUDE_FDDETDATAFORMATS_DAPHNEETHSTREAMFRAME_HPP_
 
#include "Utils.hpp"
 
#include "detdataformats/DAQEthHeader.hpp"
 
#include <algorithm> // For std::min
#include <cassert>   // For assert()
#include <cstdint>   // For uint32_t etc
#include <cstdio>
#include <cstdlib>
#include <format>
#include <stdexcept> // For std::out_of_range
 
namespace dunedaq::fddetdataformats {
 
// NOLINTBEGIN(build/unsigned)

 
class DAPHNEEthStreamFrame
{
public:
  // The definition of the format is in terms of 64-bit words
  using word_t = uint64_t;
 
  // Dataframe format version
  static constexpr uint8_t version = 1;
 
  static constexpr int s_bits_per_adc = 14;
  static constexpr int s_bits_per_word = 8 * sizeof(word_t);
  static constexpr int s_adcs_per_channel = 280;
  static constexpr int s_num_channels = 4;
  static constexpr int s_num_adc_words = s_num_channels * s_adcs_per_channel * s_bits_per_adc / s_bits_per_word;
 
  struct ChannelWord
  {
    word_t tbd : 52;
    word_t version : 4;
    word_t channel : 8;
  };
  static_assert(sizeof(ChannelWord) == 8);
 
  struct Header
  {
    ChannelWord channel_words[s_num_channels]; // NOLINT
  };
  static_assert(sizeof(Header) == sizeof(ChannelWord) * s_num_channels);
 
  detdataformats::DAQEthHeader daq_header;
  Header header;
  word_t adc_words[s_num_adc_words]; // NOLINT

  uint16_t get_adc(uint i_adc, uint i_channel) const;

 
  // WARNING: ORDER OF CHANNEL AND ADC IS REVERSED RELATIVE TO get_adc
  void set_adc(uint i_channel, uint i_adc, uint16_t val); // NOLINT

  uint64_t get_timestamp() const { return daq_header.get_timestamp(); }

  void set_timestamp(const uint64_t new_timestamp) { daq_header.timestamp = new_timestamp; }

  uint8_t get_channel(const uint i_channel) const;

  void set_channel(const uint i_channel, const uint8_t new_channel_val);

  uint8_t get_channel0() const { return header.channel_words[0].channel; }

  uint8_t get_channel1() const { return header.channel_words[1].channel; }

  uint8_t get_channel2() const { return header.channel_words[2].channel; }

  uint8_t get_channel3() const { return header.channel_words[3].channel; }
};
static_assert(sizeof(DAPHNEEthStreamFrame) ==
              sizeof(detdataformats::DAQEthHeader) + sizeof(DAPHNEEthStreamFrame::Header) +
                sizeof(DAPHNEEthStreamFrame::word_t) * DAPHNEEthStreamFrame::s_num_adc_words);
 
static_assert(std::endian::native == std::endian::little,
              "The DAPHNEEthStreamFrame bitfield layout assumes little-endian architecture");
 
static_assert(std::is_trivially_copyable_v<DAPHNEEthStreamFrame>,
              "DAPHNEEthStreamFrame isn't trivially copyable and can't be safely std::memcpy'd");
static_assert(std::is_standard_layout_v<DAPHNEEthStreamFrame>,
              "DAPHNEEthStreamFrame isn't standard layout; reinterpret_cast and offsetof can't safely be used with it");
 
} // namespace dunedaq::fddetdataformats
 
#include "detail/DAPHNEEthStreamFrame.hxx"
 
// NOLINTEND(build/unsigned)
 
#endif // FDDETDATAFORMATS_INCLUDE_FDDETDATAFORMATS_DAPHNEETHSTREAMFRAME_HPP_