SSPTypes.hpp

Go to the documentation of this file.

 
#ifndef SSPMODULES_SRC_ANLBOARD_SSPTYPES_HPP_
#define SSPMODULES_SRC_ANLBOARD_SSPTYPES_HPP_
 
#include <cstdlib>
 
namespace dunedaq::sspmodules {
 
static const constexpr int max_control_data = 256; // Maximum size of packet payload on comms channel
 
//==============================================================================
// Enumerated Constants
// These are defined by the SSP hardware spec
//==============================================================================
 
// Command to send to SSP
enum commandConstants
{
  cmdNone = 0,
  // Basic Commands
  cmdRead = 1,
  cmdReadMask = 2,
  cmdWrite = 3,
  cmdWriteMask = 4,
  // Array Commands
  cmdArrayRead = 5,
  cmdArrayWrite = 6,
  // Fifo Commands
  cmdFifoRead = 7,
  cmdFifoWrite = 8,
  numCommands
};
 
// Holder for status returned from SSP
enum statusConstants
{
  statusNoError = 0,
  statusSendError = 1,
  statusReceiveError = 2,
  statusTimeoutError = 3,
  statusAddressError = 4,
  statusAlignError = 5,
  statusCommandError = 6,
  statusSizeError = 7,
  statusWriteError = 8 // Returned if read-only address is written
};
 
//==============================================================================
// Types
//==============================================================================
 
 
// Structure defined by hardware, i.e. hardware output can be written straight into this struct
struct EventHeader
{                                 // NOTE: Group fields are listed from MSB to LSB
  unsigned int header;            // NOLINT // 0xAAAAAAAA
  unsigned short length;          // NOLINT // Packet Length in unsigned ints (including header)
  unsigned short group1;          // NOLINT // Trigger Type, Status Flags, Header Type
  unsigned short triggerID;       // NOLINT // Trigger ID
  unsigned short group2;          // NOLINT // Module ID, Channel ID
  unsigned short timestamp[4];    // NOLINT // External Timestamp
                                  // Words 0-1 = Clocks since last sync pulse
                                  // Words 2-3 = Sync pulse count
  unsigned short peakSumLow;      // NOLINT // Lower 16 bits of Peak Sum
  unsigned short group3;          // NOLINT // Offset of Peak, Higher 8 bits of Peak Sum
  unsigned short preriseLow;      // NOLINT // Lower 16 bits of Prerise
  unsigned short group4;          // NOLINT // Lower 8 bits of integratedSum, Higher 8 bits of Prerise
  unsigned short intSumHigh;      // NOLINT // Upper 16 bits of integratedSum
  unsigned short baseline;        // NOLINT // Baseline
  unsigned short cfdPoint[4];     // NOLINT // CFD Timestamp Interpolation Points
  unsigned short intTimestamp[4]; // NOLINT // Internal Timestamp
                                  // Word 0 = Reserved for interpolation
                                  // Words 1-3 = 48 bit Timestamp
};
 
// static_assert(sizeof(struct EventHeader) == 12, "Check your assumptions on SSP EventHeader size");
 
// byte-level structure of command header to send to SSP
struct CtrlHeader
{
  unsigned int length;
  unsigned int address;
  unsigned int command;
  unsigned int size;
  unsigned int status;
};
 
// Struct containing header followed by payload.
// Since control packets are small, just allocate enough space to accommodate
// longest possible message
struct CtrlPacket
{
  CtrlHeader header;
  unsigned int data[max_control_data];
};
 
} // namespace dunedaq::sspmodules
 
#endif // SSPMODULES_SRC_ANLBOARD_SSPTYPES_HPP_