#include <NSWElink.h>

Collaboration diagram for Muon::nsw::NSWElink:

Public Member Functions
	NSWElink (const uint32_t *bs, uint32_t remaining)
virtual	~NSWElink ()
	NSWElink (const NSWElink &)=delete
NSWElink &	operator= (const NSWElink &)=delete
const std::vector< Muon::nsw::VMMChannel * > &	get_channels () const
unsigned int	nwords () const
unsigned int	nhits () const
unsigned int	status () const
uint32_t	elinkWord () const
const Muon::nsw::NSWResourceId *	elinkId () const
Muon::nsw::NSWResourceId *	elinkId ()
bool	isNull () const
bool	noTdc () const
uint16_t	l1Id () const
uint16_t	rocId () const
uint16_t	bcId () const
uint16_t	orbit () const
bool	tout () const
bool	extended () const
uint8_t	checksum () const
uint16_t	nhitsTrail () const
uint16_t	l0Id () const
uint16_t	flagMiss () const

Private Member Functions
unsigned int	test_checksum (const uint8_t *buffer, unsigned int buflen)

Private Attributes
unsigned int	m_wordCount
unsigned int	m_nhits
unsigned int	m_running_checksum
unsigned int	m_packet_status
bool	m_isNull
bool	m_noTdc
bool	m_tout
bool	m_extended
uint8_t	m_checksum
uint16_t	m_l1Id
uint16_t	m_rocId
uint16_t	m_bcId
uint16_t	m_orbit
uint16_t	m_nhitsTrail
uint16_t	m_l0Id
uint16_t	m_flagMiss
uint32_t	m_elinkWord
Muon::nsw::NSWResourceId *	m_elinkId
std::vector< Muon::nsw::VMMChannel * >	m_channels

Static Private Attributes
static const unsigned int	s_null_packet_length = 10

Detailed Description

Definition at line 20 of file NSWElink.h.

Constructor & Destructor Documentation

◆ NSWElink() [1/2]

Muon::nsw::NSWElink::NSWElink	(	const uint32_t *	bs,
		uint32_t	remaining )

Definition at line 19 of file NSWElink.cxx.

  : m_wordCount (0)
{
  m_rocId = 0; // Fix coverity warning
 
  // Felix header (2 words)
  // Packet length includes Felix header
 
  uint32_t word = bs[m_wordCount++];
  unsigned int packet_nbytes = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskFlxLENGTH, Muon::nsw::bitPosFlxLENGTH);
  m_packet_status  = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskFlxSTATUS, Muon::nsw::bitPosFlxSTATUS);
 
  if (m_packet_status != 0)
  {
    std::ostringstream s;
    s << "Packet status in FELIX header 0x" << std::hex << m_packet_status << std::dec;
    Muon::nsw::MuonNSWCommonDecoder::NSWElinkFelixHeaderException e (ERS_HERE, s.str ());
    throw e;
  }
 
  if (remaining * sizeof (uint32_t) < packet_nbytes)
  {
    std::ostringstream s;
    s << "Packet length in FELIX header " << packet_nbytes << " is larger than available data";
    Muon::nsw::MuonNSWCommonDecoder::NSWElinkFelixHeaderException e (ERS_HERE, s.str ());
    throw e;
  }
 
  m_elinkWord = bs[m_wordCount++];
  m_elinkId = new Muon::nsw::NSWResourceId (m_elinkWord);
 
  // Decode sROC header
 
  word = bs[m_wordCount++];
 
  ERS_DEBUG (2, "==============================================================");
  ERS_DEBUG (2, "FELIX HEADER: LENGTH (BYTES) = " << packet_nbytes <<
         " | STATUS = " << m_packet_status << " | RESOURCE ID = 0x" << std::hex << m_elinkWord << std::dec);
 
  if ((m_isNull = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskSRocNULL, Muon::nsw::bitPosSRocNULL)) == true)
  {
    m_l1Id  = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskSRocNullL1ID, Muon::nsw::bitPosSRocNullL1ID);
    m_rocId = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskSRocNullID, Muon::nsw::bitPosSRocNullID);
 
    ERS_DEBUG (2, "ROC HEADER: | NULL = " << m_isNull <<
           " | ROCID = " << m_rocId << " | L1ID = " << m_l1Id);
 
    // It may happen that the packet is flagged as a null packet but there are additional bytes
 
    if (packet_nbytes != s_null_packet_length)
    {
      std::ostringstream s;
      s << "Additional data detected in packet flagged as null " << packet_nbytes;
      Muon::nsw::MuonNSWCommonDecoder::NSWElinkROCHeaderException e (ERS_HERE, s.str ());
 
      // Additional words are ignored
 
      m_wordCount = packet_nbytes / sizeof (uint32_t);
    }
  }
  else
  {
    // It may happen that the null packet flag is wrong (or the size is wrong)
    // In that case, throw an exception
 
    if (packet_nbytes == s_null_packet_length)
    {
      std::ostringstream s;
      s << "Packet length in FELIX header " << packet_nbytes << " and null event flag in packet are inconsistent";
      Muon::nsw::MuonNSWCommonDecoder::NSWElinkROCHeaderException e (ERS_HERE, s.str ());
      throw e;
    }
 
    // Calculate packet checksum
 
    const uint8_t *p = reinterpret_cast <const uint8_t *> (bs + 2);
    m_running_checksum = this->test_checksum (p, (packet_nbytes - 2 * sizeof (uint32_t)));
 
    // m_noTDC will only affect data size, hit words should be re-aligned to uint32_t
 
    m_noTdc     = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskSRocNOTDC, Muon::nsw::bitPosSRocNOTDC);
    m_l1Id      = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskSRocL1ID, Muon::nsw::bitPosSRocL1ID);
    m_bcId      = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskSRocBCID, Muon::nsw::bitPosSRocBCID);
    m_orbit     = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskSRocORBIT, Muon::nsw::bitPosSRocORBIT);
 
    // Set hit bytes to correspond to the length in Flx header
    // Everything should be re-aligned in the swROD, though
 
    // const unsigned int hit_size  = m_noTdc ? 3 : 4; // set hit bytes to correspond to the length in Flx header
 
    // Hit size should always be 4, since (at least for run 3) the detector is always configured to get the TDC info
    // Please keep the previous commented out line. Having noTdc = true is a legal condition, in principle,
    // but given the actual configuration of the detector, that should never happen and a crash is provoked when it does if
    // it is taken into account. I (EP) added a warning exception to report that condition.
 
    static const unsigned int hit_size = 4;
 
    if (m_noTdc)
    {
      std::ostringstream s;
      s << "Hit size is not compatible with flags in ROC header, elink ID = " << m_elinkWord << " L1 ID = " << m_l1Id;
      Muon::nsw::MuonNSWCommonDecoder::NSWElinkROCHeaderException e (ERS_HERE, s.str ());
      ers::warning (e);
    }
 
    // Two 32-bits words for Felix header, 1 word for ROC header, 1 word for the ROC trailer
 
    m_nhits = (packet_nbytes - 4 * sizeof (uint32_t)) / hit_size;
    if (packet_nbytes % 4) ++m_nhits;
 
    ERS_DEBUG (2, "ROC HEADER: T = " << m_noTdc << " | NULL = " << m_isNull <<
           " | ORBIT = " << m_orbit << " | BCID = " << m_bcId << " | L1ID = " << m_l1Id);             
    
    // Hit Data
 
    for (unsigned int i=0; i < m_nhits; ++i)
    {
      Muon::nsw::VMMChannel *c = new Muon::nsw::VMMChannel (bs[m_wordCount++], this);
      m_channels.push_back(c);
    }
 
    // ROC Trailer (1 word)
 
    word = bs[m_wordCount++];
 
    m_checksum   = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskTrailCHECKSUM, Muon::nsw::bitPosTrailCHECKSUM);
    m_nhitsTrail = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskTrailLENGTH, Muon::nsw::bitPosTrailLENGTH);
    m_l0Id       = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskTrailL0ID, Muon::nsw::bitPosTrailL0ID);
    m_flagMiss   = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskTrailFLAGMISS, Muon::nsw::bitPosTrailFLAGMISS);
    m_tout       = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskTrailTO, Muon::nsw::bitPosTrailTO);
    m_extended   = Muon::nsw::helper::get_bits (word, Muon::nsw::bitMaskTrailEXTENDED, Muon::nsw::bitPosTrailEXTENDED);
 
    ERS_DEBUG (2, "ROC TRAILER: EXTENDED = " << m_extended << " | TIMEOUT = " << m_tout << std::hex <<
           " | FLAGMISS = 0x" << m_flagMiss << std::dec << " | L0ID = " << m_l0Id << " | NHITS = " << m_nhits <<
           " | CHECKSUM = 0x" << std::hex << static_cast <unsigned int> (m_checksum) << std::dec);             
    ERS_DEBUG (2, "PACKET CHECKSUM = " << m_running_checksum);
  }
}

◆ ~NSWElink()

Muon::nsw::NSWElink::~NSWElink ( )

virtual

Definition at line 158 of file NSWElink.cxx.

{
  for (auto i = m_channels.begin (); i != m_channels.end (); ++i)
    delete *i;
 
  delete m_elinkId;
}

◆ NSWElink() [2/2]

Muon::nsw::NSWElink::NSWElink ( const NSWElink & )

delete

Member Function Documentation

◆ bcId()

uint16_t Muon::nsw::NSWElink::bcId ( ) const

inline

Definition at line 47 of file NSWElink.h.

47{return m_bcId;};

◆ checksum()

uint8_t Muon::nsw::NSWElink::checksum ( ) const

inline

Definition at line 54 of file NSWElink.h.

54{return m_checksum;};

◆ elinkId() [1/2]

Muon::nsw::NSWResourceId * Muon::nsw::NSWElink::elinkId ( )

inline

Definition at line 39 of file NSWElink.h.

39{return m_elinkId;};

◆ elinkId() [2/2]

const Muon::nsw::NSWResourceId * Muon::nsw::NSWElink::elinkId ( ) const

inline

Definition at line 38 of file NSWElink.h.

38{return m_elinkId;};

◆ elinkWord()

uint32_t Muon::nsw::NSWElink::elinkWord ( ) const

inline

Definition at line 37 of file NSWElink.h.

37{return m_elinkWord;};

◆ extended()

bool Muon::nsw::NSWElink::extended ( ) const

inline

Definition at line 52 of file NSWElink.h.

52{return m_extended;};

◆ flagMiss()

uint16_t Muon::nsw::NSWElink::flagMiss ( ) const

inline

Definition at line 58 of file NSWElink.h.

58{return m_flagMiss;};

◆ get_channels()

const std::vector< Muon::nsw::VMMChannel * > & Muon::nsw::NSWElink::get_channels ( ) const

inline

Definition at line 30 of file NSWElink.h.

30{return m_channels;};

◆ isNull()

bool Muon::nsw::NSWElink::isNull ( ) const

inline

Definition at line 42 of file NSWElink.h.

42{return m_isNull;};

◆ l0Id()

uint16_t Muon::nsw::NSWElink::l0Id ( ) const

inline

Definition at line 57 of file NSWElink.h.

57{return m_l0Id;};

◆ l1Id()

uint16_t Muon::nsw::NSWElink::l1Id ( ) const

inline

Definition at line 45 of file NSWElink.h.

45{return m_l1Id;};

◆ nhits()

unsigned int Muon::nsw::NSWElink::nhits ( ) const

inline

Definition at line 33 of file NSWElink.h.

33{return m_nhits;};

◆ nhitsTrail()

uint16_t Muon::nsw::NSWElink::nhitsTrail ( ) const

inline

Definition at line 56 of file NSWElink.h.

56{return m_nhitsTrail;};

◆ noTdc()

bool Muon::nsw::NSWElink::noTdc ( ) const

inline

Definition at line 43 of file NSWElink.h.

43{return m_noTdc;};

◆ nwords()

unsigned int Muon::nsw::NSWElink::nwords ( ) const

inline

Definition at line 32 of file NSWElink.h.

32{return m_wordCount;};

◆ operator=()

NSWElink & Muon::nsw::NSWElink::operator= ( const NSWElink & )

delete

◆ orbit()

uint16_t Muon::nsw::NSWElink::orbit ( ) const

inline

Definition at line 48 of file NSWElink.h.

48{return m_orbit;};

◆ rocId()

uint16_t Muon::nsw::NSWElink::rocId ( ) const

inline

Definition at line 46 of file NSWElink.h.

46{return m_rocId;};

◆ status()

unsigned int Muon::nsw::NSWElink::status ( ) const

inline

Definition at line 34 of file NSWElink.h.

34{return m_packet_status;};

◆ test_checksum()

unsigned int Muon::nsw::NSWElink::test_checksum	(	const uint8_t *	buffer,
		unsigned int	buflen )

inlineprivate

Definition at line 93 of file NSWElink.h.

{
  const uint8_t *p = buffer;
  unsigned int running_checksum = 0;
 
  for (unsigned int i = 0; i < buflen; ++i, ++p)
    running_checksum += *p;
 
  running_checksum = (running_checksum & 0xff) + (running_checksum >> 8); // add carry bits
  running_checksum = (running_checksum & 0xff) + (running_checksum >> 8); // do it twice
  running_checksum = (~running_checksum) & 0xff;
 
  return running_checksum;
}

◆ tout()

bool Muon::nsw::NSWElink::tout ( ) const

inline

Definition at line 51 of file NSWElink.h.

51{return m_tout;};

Member Data Documentation

◆ m_bcId

uint16_t Muon::nsw::NSWElink::m_bcId

private

Definition at line 78 of file NSWElink.h.

◆ m_channels

std::vector<Muon::nsw::VMMChannel *> Muon::nsw::NSWElink::m_channels

private

Definition at line 86 of file NSWElink.h.

◆ m_checksum

uint8_t Muon::nsw::NSWElink::m_checksum

private

Definition at line 74 of file NSWElink.h.

◆ m_elinkId

Muon::nsw::NSWResourceId* Muon::nsw::NSWElink::m_elinkId

private

Definition at line 85 of file NSWElink.h.

◆ m_elinkWord

uint32_t Muon::nsw::NSWElink::m_elinkWord

private

Definition at line 84 of file NSWElink.h.

◆ m_extended

bool Muon::nsw::NSWElink::m_extended

private

Definition at line 72 of file NSWElink.h.

◆ m_flagMiss

uint16_t Muon::nsw::NSWElink::m_flagMiss

private

Definition at line 82 of file NSWElink.h.

◆ m_isNull

bool Muon::nsw::NSWElink::m_isNull

private

Definition at line 69 of file NSWElink.h.

◆ m_l0Id

uint16_t Muon::nsw::NSWElink::m_l0Id

private

Definition at line 81 of file NSWElink.h.

◆ m_l1Id

uint16_t Muon::nsw::NSWElink::m_l1Id

private

Definition at line 76 of file NSWElink.h.

◆ m_nhits

unsigned int Muon::nsw::NSWElink::m_nhits

private

Definition at line 65 of file NSWElink.h.

◆ m_nhitsTrail

uint16_t Muon::nsw::NSWElink::m_nhitsTrail

private

Definition at line 80 of file NSWElink.h.

◆ m_noTdc

bool Muon::nsw::NSWElink::m_noTdc

private

Definition at line 70 of file NSWElink.h.

◆ m_orbit

uint16_t Muon::nsw::NSWElink::m_orbit

private

Definition at line 79 of file NSWElink.h.

◆ m_packet_status

unsigned int Muon::nsw::NSWElink::m_packet_status

private

Definition at line 67 of file NSWElink.h.

◆ m_rocId

uint16_t Muon::nsw::NSWElink::m_rocId

private

Definition at line 77 of file NSWElink.h.

◆ m_running_checksum

unsigned int Muon::nsw::NSWElink::m_running_checksum

private

Definition at line 66 of file NSWElink.h.

◆ m_tout

bool Muon::nsw::NSWElink::m_tout

private

Definition at line 71 of file NSWElink.h.

◆ m_wordCount

unsigned int Muon::nsw::NSWElink::m_wordCount

private

Definition at line 64 of file NSWElink.h.

◆ s_null_packet_length

const unsigned int Muon::nsw::NSWElink::s_null_packet_length = 10

staticprivate

Definition at line 88 of file NSWElink.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NSWElink() [1/2]

◆ ~NSWElink()

◆ NSWElink() [2/2]

Member Function Documentation

◆ bcId()

◆ checksum()

◆ elinkId() [1/2]

◆ elinkId() [2/2]

◆ elinkWord()

◆ extended()

◆ flagMiss()

◆ get_channels()

◆ isNull()

◆ l0Id()

◆ l1Id()

◆ nhits()

◆ nhitsTrail()

◆ noTdc()

◆ nwords()

◆ operator=()

◆ orbit()

◆ rocId()

◆ status()

◆ test_checksum()

◆ tout()

Member Data Documentation

◆ m_bcId

◆ m_channels

◆ m_checksum

◆ m_elinkId

◆ m_elinkWord

◆ m_extended

◆ m_flagMiss

◆ m_isNull

◆ m_l0Id

◆ m_l1Id

◆ m_nhits

◆ m_nhitsTrail

◆ m_noTdc

◆ m_orbit

◆ m_packet_status

◆ m_rocId

◆ m_running_checksum

◆ m_tout

◆ m_wordCount

◆ s_null_packet_length