DAPHNEEthStreamFrame.hpp

Go to the documentation of this file.

 
#ifndef FDDETDATAFORMATS_INCLUDE_FDDETDATAFORMATS_DAPHNEETHSTREAMFRAME_HPP_
#define FDDETDATAFORMATS_INCLUDE_FDDETDATAFORMATS_DAPHNEETHSTREAMFRAME_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 <stdexcept> // For std::out_of_range
 
namespace dunedaq::fddetdataformats {
 
class DAPHNEEthStreamFrame
{
public:
  // ===============================================================
  // Preliminaries
  // ===============================================================
 
  // The definition of the format is in terms of 64-bit words
  typedef uint64_t word_t; // NOLINT
 
  // 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;
  };
 
  struct Header
  {    
    ChannelWord channel_words[s_num_channels];
  };
 
  // ===============================================================
  // Data members
  // ===============================================================
  detdataformats::DAQEthHeader daq_header;
  Header header;
  word_t adc_words[s_num_adc_words]; // NOLINT
 
// ===============================================================
// Accessors
// ===============================================================
 
uint16_t get_adc(uint i, uint chn) const // NOLINT
{
 
    if (i >= s_adcs_per_channel)
      throw std::out_of_range("ADC index out of range");
 
    if (chn >= s_num_channels)
      throw std::out_of_range("Channel index out of range");
 
    // find absolute index in frame
    uint j = i*s_num_channels+chn;
    // The index of the first (and sometimes only) word containing the required ADC value
    uint word_index = s_bits_per_adc * j / s_bits_per_word;
    assert(word_index < s_num_adc_words);
    // Where in the word the lowest bit of our ADC value is located
    int first_bit_position = (s_bits_per_adc * j) % s_bits_per_word;
    // How many bits of our desired ADC are located in the `word_index`th word
    int bits_from_first_word = std::min(s_bits_per_adc, s_bits_per_word - first_bit_position);
    uint16_t adc = adc_words[word_index] >> first_bit_position; // NOLINT(build/unsigned)
 
    if (bits_from_first_word < s_bits_per_adc) {
      assert(word_index + 1 < s_num_adc_words);
      adc |= adc_words[word_index + 1] << bits_from_first_word;
    }
    // Mask out all but the lowest 14 bits;
    return adc & 0x3FFFu;
}
 
void set_adc(uint chn, uint i, uint16_t val) // NOLINT
{
    if (chn >= s_num_channels)
      throw std::out_of_range("Channel index out of range");
 
    if (i >= s_adcs_per_channel)
      throw std::out_of_range("ADC index out of range");
 
    if (val >= (1 << s_bits_per_adc))
      throw std::out_of_range("ADC value out of range");
 
 
    // find absolute index in frame
    uint j = i*s_num_channels+chn;
    // The index of the first (and sometimes only) word containing the required ADC value
    int word_index = s_bits_per_adc * j / s_bits_per_word;
    assert(word_index < s_num_adc_words);
    // Where in the word the lowest bit of our ADC value is located
    int first_bit_position = (s_bits_per_adc * j) % s_bits_per_word;
    // How many bits of our desired ADC are located in the `word_index`th word
    int bits_in_first_word = std::min(s_bits_per_adc, s_bits_per_word - first_bit_position);
    uint32_t mask = (1 << (first_bit_position)) - 1;
    adc_words[word_index] = ((val << first_bit_position) & ~mask) | (adc_words[word_index] & mask);
    // If we didn't put the full 14 bits in this word, we need to put the rest in the next word
    if (bits_in_first_word < s_bits_per_adc) {
      assert(word_index + 1 < s_num_adc_words);
      mask = (1 << (s_bits_per_adc - bits_in_first_word)) - 1;
      adc_words[word_index + 1] = ((val >> bits_in_first_word) & mask) | (adc_words[word_index + 1] & ~mask);
    }
 
  }
  uint64_t get_timestamp() const // NOLINT(build/unsigned)
  {
    return daq_header.get_timestamp() ; // NOLINT(build/unsigned)
  }
 
  void set_timestamp(const uint64_t new_timestamp) // NOLINT(build/unsigned)
  {
    daq_header.timestamp = new_timestamp;
  }
 
  uint8_t get_channel(uint ch) const // NOLINT(build/unsigned)
  {
    if (ch >= s_num_channels)
      throw std::out_of_range("Channel index out of range");
 
    return header.channel_words[ch].channel ; // NOLINT(build/unsigned)
  }
 
  void set_channel(uint channel_index, const uint8_t new_channel_val) // NOLINT(build/unsigned)
  {
    if (channel_index >= s_num_channels)
      throw std::out_of_range("Channel index out of range");
 
    header.channel_words[channel_index].channel = new_channel_val;
  }
  
  uint8_t get_channel0() const { return header.channel_words[0].channel; } // NOLINT(build/unsigned)                                                                                        
 
  uint8_t get_channel1() const { return header.channel_words[1].channel; } // NOLINT(build/unsigned)                                                                                        
 
  uint8_t get_channel2() const { return header.channel_words[2].channel; } // NOLINT(build/unsigned)                                                                                        
 
  uint8_t get_channel3() const { return header.channel_words[3].channel; } // NOLINT(build/unsigned)  
 
};
 
} // namespace dunedaq::fddetdataformats
 
#endif // FDDETDATAFORMATS_INCLUDE_FDDETDATAFORMATS_DAPHNEETHSTREAMFRAME_HPP_