amc::BlockHeader Class Reference

#include <AMCSpec.h>

Public Member Functions
	BlockHeader ()
	BlockHeader (const uint64_t *data)
	BlockHeader (unsigned int amc_no, unsigned int board_id, unsigned int size, unsigned int block=0)
unsigned int	getAMCNumber () const
unsigned int	getBlocks () const
unsigned int	getBlockSize () const
unsigned int	getBoardID () const
unsigned int	getMore () const
unsigned int	getSegmented () const
unsigned int	getSize () const
	operator uint64_t () const
uint64_t	raw () const
unsigned int	validCRC () const

Private Attributes
uint64_t	data_

Static Private Attributes
static const unsigned int	AmcNo_mask = 0xf
static const unsigned int	AmcNo_shift = 16
static const unsigned int	BlkNo_mask = 0xff
static const unsigned int	BlkNo_shift = 20
static const unsigned int	BoardID_mask = 0xffff
static const unsigned int	BoardID_shift = 0
static const unsigned int	CRC_bit_shift = 56
static const unsigned int	Enabled_bit_shift = 59
static const unsigned int	Length_bit_shift = 62
static const unsigned int	More_bit_shift = 61
static const unsigned int	Present_bit_shift = 58
static const unsigned int	Segmented_bit_shift = 60
static const unsigned int	Size_mask = 0xffffff
static const unsigned int	Size_shift = 32
static const unsigned int	Valid_bit_shift = 57

Detailed Description

Definition at line 13 of file AMCSpec.h.

Constructor & Destructor Documentation

BlockHeader() [1/3]

amc::BlockHeader::BlockHeader ( )

inline

Definition at line 15 of file AMCSpec.h.

: data_(0){};

BlockHeader() [2/3]

amc::BlockHeader::BlockHeader ( const uint64_t *  data )

inline

Definition at line 16 of file AMCSpec.h.

: data_(data[0]){};

BlockHeader() [3/3]

amc::BlockHeader::BlockHeader	(	unsigned int	amc_no,
		unsigned int	board_id,
		unsigned int	size,
		unsigned int	block = 0
	)

Definition at line 11 of file AMCSpec.cc.

                                                                                                            {
    // Determine size
    unsigned int max_block_no = 0;
    if (size >= 0x13ff)
      max_block_no = (size - 1023) / 4096;
 
    if (block != max_block_no)
      size = split_block_size;
    else if (block != 0)
      size -= split_block_size * max_block_no;
 
    data_ = (static_cast<uint64_t>(size & Size_mask) << Size_shift) |
            (static_cast<uint64_t>(block & BlkNo_mask) << BlkNo_shift) |
            (static_cast<uint64_t>(amc_no & AmcNo_mask) << AmcNo_shift) |
            (static_cast<uint64_t>(board_id & BoardID_mask) << BoardID_shift) | (1llu << Enabled_bit_shift) |
            (1llu << Present_bit_shift);
 
    if (block == getBlocks() - 1) {
      // Last block
      data_ |= (1llu << CRC_bit_shift) | (1llu << Valid_bit_shift) | (1llu << Length_bit_shift);
    }
 
    if (block == 0 && getBlocks() == 1) {
      // Bits already zeroed - only one block
    } else if (block == 0) {
      // First of many blocks
      data_ |= 1llu << More_bit_shift;
    } else if (block == getBlocks() - 1) {
      // Last of many blocks
      data_ |= 1llu << Segmented_bit_shift;
    } else {
      // Intermediate of many blocks
      data_ |= (1llu << More_bit_shift) | (1llu << Segmented_bit_shift);
    }
  }

References AmcNo_mask, AmcNo_shift, BlkNo_mask, BlkNo_shift, groupFilesInBlocks::block, BoardID_mask, BoardID_shift, CRC_bit_shift, data_, Enabled_bit_shift, getBlocks(), Length_bit_shift, More_bit_shift, Present_bit_shift, Segmented_bit_shift, findQualityFiles::size, Size_mask, Size_shift, amc::split_block_size, and Valid_bit_shift.

Member Function Documentation

getAMCNumber()

unsigned int amc::BlockHeader::getAMCNumber ( ) const

inline

Definition at line 28 of file AMCSpec.h.

{ return (data_ >> AmcNo_shift) & AmcNo_mask; };

References AmcNo_mask, AmcNo_shift, and data_.

Referenced by amc::Packet::finalize(), and omtf::OmtfUnpacker::produce().

getBlocks()

unsigned int amc::BlockHeader::getBlocks

(

)

const

Definition at line 47 of file AMCSpec.cc.

                                            {
    // The first block of a segmented event has a size of 1023, all
    // following have a max size of 4096.  Segmentation only happens
    // for AMC payloads >= 0x13ff 64 bit words.
    unsigned int size = getSize();
    if (size >= 0x13ff)
      return (size - 1023) / 4096 + 1;
    return 1;
  }

References getSize(), and findQualityFiles::size.

Referenced by amc::Packet::block(), BlockHeader(), and amc::Packet::blocks().

getBlockSize()

unsigned int amc::BlockHeader::getBlockSize

(

)

const

Definition at line 57 of file AMCSpec.cc.

                                               {
    // More and not Segmented means the first of multiple blocks.  For
    // these, getSize() returns the total size of the AMC packet, not the
    // size of the first block.
    if (getMore() && !getSegmented())
      return split_block_size;
    return getSize();
  }

References getMore(), getSegmented(), getSize(), and amc::split_block_size.

getBoardID()

unsigned int amc::BlockHeader::getBoardID ( ) const

inline

Definition at line 29 of file AMCSpec.h.

{ return (data_ >> BoardID_shift) & BoardID_mask; };

References BoardID_mask, BoardID_shift, and data_.

Referenced by amc::Packet::finalize(), and omtf::OmtfUnpacker::produce().

getMore()

unsigned int amc::BlockHeader::getMore ( ) const

inline

Definition at line 31 of file AMCSpec.h.

{ return (data_ >> More_bit_shift) & 1; };

References data_, and More_bit_shift.

Referenced by getBlockSize().

getSegmented()

unsigned int amc::BlockHeader::getSegmented ( ) const

inline

Definition at line 32 of file AMCSpec.h.

{ return (data_ >> Segmented_bit_shift) & 1; };

References data_, and Segmented_bit_shift.

Referenced by getBlockSize().

getSize()

unsigned int amc::BlockHeader::getSize ( ) const

inline

Definition at line 30 of file AMCSpec.h.

{ return (data_ >> Size_shift) & Size_mask; };

References data_, Size_mask, and Size_shift.

Referenced by amc::Packet::finalize(), getBlocks(), getBlockSize(), and omtf::OmtfUnpacker::produce().

operator uint64_t()

amc::BlockHeader::operator uint64_t ( ) const

inline

Definition at line 21 of file AMCSpec.h.

{ return data_; };

References data_.

raw()

uint64_t amc::BlockHeader::raw ( ) const

inline

Definition at line 23 of file AMCSpec.h.

{ return data_; };

References data_.

Referenced by omtf::OmtfUnpacker::produce().

validCRC()

unsigned int amc::BlockHeader::validCRC ( ) const

inline

Definition at line 34 of file AMCSpec.h.

{ return (data_ >> CRC_bit_shift) & 1; };

References CRC_bit_shift, and data_.

Member Data Documentation

AmcNo_mask

const unsigned int amc::BlockHeader::AmcNo_mask = 0xf

staticprivate

Definition at line 42 of file AMCSpec.h.

Referenced by BlockHeader(), and getAMCNumber().

AmcNo_shift

const unsigned int amc::BlockHeader::AmcNo_shift = 16

staticprivate

Definition at line 41 of file AMCSpec.h.

Referenced by BlockHeader(), and getAMCNumber().

BlkNo_mask

const unsigned int amc::BlockHeader::BlkNo_mask = 0xff

staticprivate

Definition at line 40 of file AMCSpec.h.

Referenced by BlockHeader().

BlkNo_shift

const unsigned int amc::BlockHeader::BlkNo_shift = 20

staticprivate

Definition at line 39 of file AMCSpec.h.

Referenced by BlockHeader().

BoardID_mask

const unsigned int amc::BlockHeader::BoardID_mask = 0xffff

staticprivate

Definition at line 44 of file AMCSpec.h.

Referenced by BlockHeader(), and getBoardID().

BoardID_shift

const unsigned int amc::BlockHeader::BoardID_shift = 0

staticprivate

Definition at line 43 of file AMCSpec.h.

Referenced by BlockHeader(), and getBoardID().

CRC_bit_shift

const unsigned int amc::BlockHeader::CRC_bit_shift = 56

staticprivate

Definition at line 52 of file AMCSpec.h.

Referenced by BlockHeader(), and validCRC().

data_

uint64_t amc::BlockHeader::data_

private

Definition at line 54 of file AMCSpec.h.

Referenced by BlockHeader(), getAMCNumber(), getBoardID(), getMore(), getSegmented(), getSize(), operator uint64_t(), raw(), and validCRC().

Enabled_bit_shift

const unsigned int amc::BlockHeader::Enabled_bit_shift = 59

staticprivate

Definition at line 49 of file AMCSpec.h.

Referenced by BlockHeader().

Length_bit_shift

const unsigned int amc::BlockHeader::Length_bit_shift = 62

staticprivate

Definition at line 46 of file AMCSpec.h.

Referenced by BlockHeader().

More_bit_shift

const unsigned int amc::BlockHeader::More_bit_shift = 61

staticprivate

Definition at line 47 of file AMCSpec.h.

Referenced by BlockHeader(), and getMore().

Present_bit_shift

const unsigned int amc::BlockHeader::Present_bit_shift = 58

staticprivate

Definition at line 50 of file AMCSpec.h.

Referenced by BlockHeader().

Segmented_bit_shift

const unsigned int amc::BlockHeader::Segmented_bit_shift = 60

staticprivate

Definition at line 48 of file AMCSpec.h.

Referenced by BlockHeader(), and getSegmented().

Size_mask

const unsigned int amc::BlockHeader::Size_mask = 0xffffff

staticprivate

Definition at line 38 of file AMCSpec.h.

Referenced by BlockHeader(), and getSize().

Size_shift

const unsigned int amc::BlockHeader::Size_shift = 32

staticprivate

Definition at line 37 of file AMCSpec.h.

Referenced by BlockHeader(), and getSize().

Valid_bit_shift

const unsigned int amc::BlockHeader::Valid_bit_shift = 57

staticprivate

Definition at line 51 of file AMCSpec.h.

Referenced by BlockHeader().