phenixOnline.h File Reference

#include "phenixTypes.h"
#include <memory.h>
#include <assert.h>

Include dependency graph for phenixOnline.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	CONSTANT   static
#define	INLINE_P   inline
#define	INLINE_D   inline
#define	Debug_Output
#define	DWORD_SIZE   sizeof(PHDWORD)
#define	SWORD_SIZE   sizeof(SWORD)
#define	PRDF_BIG_ENDIAN   2
#define	PRDF_LITTLE_ENDIAN   1
#define	PRDF_LOCAL_ENDIANISM   PRDF_LITTLE_ENDIAN
#define	dwordCopy(out_ptr, in_ptr, numDwords)   memcpy (out_ptr, in_ptr, 4*(numDwords))
#define	dwordClear(out_ptr, numDwords)   memset (out_ptr, 0, 4*(numDwords))
#define	byteClear(out_ptr, numBytes)   memset (out_ptr, 0, numBytes)
#define	byteCopy(out_ptr, in_ptr, numBytes)   memcpy (out_ptr, in_ptr, numBytes)
#define	getWordMACRO(packet_ptr, offsetOfDWORD)   (*((packet_ptr)+(offsetOfDWORD)))
#define	getBitsMACRO(packet_ptr, offsetOfDWORD, offsetInDWORD, mask)   (((*((packet_ptr)+(offsetOfDWORD)))&(mask))>>offsetInDWORD)
#define	setWordMACRO(packet_ptr, offsetOfDword, value)   (*(packet_ptr+offsetOfDword))=value
#define	setBitsMACRO(packet_ptr, offsetOfDword, offsetInDword, mask, value)

Typedefs
typedef int	LOGIC_ret
typedef UINT	VALUE_ret
typedef PHDWORD *	PTR_ret

Functions
INLINE_D PHDWORD	singleDwordByteSwap (PHDWORD inDword)
void	dwordByteSwap (PHDWORD *out_ptr, PHDWORD *in_ptr, PHDWORD numDwords)

Variables
CONSTANT UINT	DwordSize = DWORD_SIZE
CONSTANT UINT	SwordSize = SWORD_SIZE
CONSTANT UINT	PRDFbigEndian = PRDF_BIG_ENDIAN
CONSTANT UINT	PRDFlittleEndian = PRDF_LITTLE_ENDIAN
CONSTANT UINT	PRDFlocalEndianism = PRDF_LOCAL_ENDIANISM
CONSTANT LOGIC_ret	TRUE = 1
CONSTANT LOGIC_ret	FALSE = 0
CONSTANT VALUE_ret	valueFailure = 0xffffffff
PTR_ret CONSTANT	ptrFailure = 0
CONSTANT LOGIC_ret	logicFailure = FALSE
CONSTANT LOGIC_ret	logicSuccess = TRUE
CONSTANT UINT	maxByteValue = 0xff
CONSTANT UINT	maxSwordValue = 0xffff
CONSTANT UINT	maxDwordValue = 0xfffffffe

Macro Definition Documentation

#define byteClear	(		out_ptr,
			numBytes
	)		memset (out_ptr, 0, numBytes)

Definition at line 98 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 98 of file phenixOnline.h

Referenced by storePacketHits().

#define byteCopy	(		out_ptr,
			in_ptr,
			numBytes
	)		memcpy (out_ptr, in_ptr, numBytes)

Definition at line 101 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 101 of file phenixOnline.h

Referenced by fetchPacketHits(), and storePacketHits().

#define CONSTANT   static

Definition at line 20 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 20 of file phenixOnline.h

#define Debug_Output

Definition at line 40 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 40 of file phenixOnline.h

Referenced by fakeFrame().

#define DWORD_SIZE   sizeof(PHDWORD)

Definition at line 42 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 42 of file phenixOnline.h

Referenced by extendUnstructPacketDataBlock(), and getUnstructPacketDataLengthBytes().

#define dwordClear	(		out_ptr,
			numDwords
	)		memset (out_ptr, 0, 4*(numDwords))

Definition at line 95 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 95 of file phenixOnline.h

Referenced by adjustFrameLength(), fakeFrame(), makeFrameHdrV1(), and makePacketV1Hdr().

#define dwordCopy	(		out_ptr,
			in_ptr,
			numDwords
	)		memcpy (out_ptr, in_ptr, 4*(numDwords))

Definition at line 92 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 92 of file phenixOnline.h

Referenced by appendPacketError(), getAlignBlockV1(), setAlignBlockV1(), storeFrameData(), and storeFrameHistory().

#define getBitsMACRO	(		packet_ptr,
			offsetOfDWORD,
			offsetInDWORD,
			mask
	)		(((*((packet_ptr)+(offsetOfDWORD)))&(mask))>>offsetInDWORD)

Definition at line 145 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 145 of file phenixOnline.h

Referenced by getFrameAlignLengthV1(), getFrameDataTypeV1(), getFrameErrorLengthV1(), getFrameHdrLength(), getFrameHdrVersion(), getFrameHistoryLengthV1(), getFramePaddingV1(), getFrameSourceIdV1(), getFrameStatusV1(), getFrameTypeV1(), getPacketHdrLength(), getPacketHdrVersion(), getPacketV1DataDescrLength(), getPacketV1DebugLength(), getPacketV1Endianism(), getPacketV1ErrorLength(), getPacketV1Padding(), getPacketV1Status(), getPacketV1Structure(), getUnstructDescrDataPadding(), getUnstructDescrHitFormat(), getUnstructDescrWordSize(), orFrameStatusV1(), and orPacketV1Status().

#define getWordMACRO	(		packet_ptr,
			offsetOfDWORD
	)		(*((packet_ptr)+(offsetOfDWORD)))

Definition at line 143 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 143 of file phenixOnline.h

Referenced by getFrameLength(), getFrameMark(), getPacketLength(), and getPacketV1Id().

#define INLINE_D   inline

Definition at line 28 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 28 of file phenixOnline.h

#define INLINE_P   inline

Definition at line 27 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 27 of file phenixOnline.h

#define PRDF_BIG_ENDIAN   2

Definition at line 48 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 48 of file phenixOnline.h

#define PRDF_LITTLE_ENDIAN   1

Definition at line 49 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 49 of file phenixOnline.h

#define PRDF_LOCAL_ENDIANISM   PRDF_LITTLE_ENDIAN

Definition at line 55 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 55 of file phenixOnline.h

#define setBitsMACRO	(		packet_ptr,
			offsetOfDword,
			offsetInDword,
			mask,
			value
	)

Value:

(*(packet_ptr+offsetOfDword))&=(~mask); \
             (*(packet_ptr+offsetOfDword))|=(value<<offsetInDword)

Definition at line 153 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 153 of file phenixOnline.h

Referenced by adjustFrameErrorLengthV1(), adjustFrameHistoryLengthV1(), orFrameStatusV1(), orPacketV1Status(), setDataTypeV1(), setFrameAlignLengthV1(), setFrameErrorLengthV1(), setFrameHdrLength(), setFrameHdrVersion(), setFrameHistoryLengthV1(), setFramePaddingV1(), setFrameStatusV1(), setFrameTypeV1(), setPacketHdrLength(), setPacketHdrVersion(), setPacketV1DataDescrLength(), setPacketV1DebugLength(), setPacketV1Endianism(), setPacketV1ErrorLength(), setPacketV1Padding(), setPacketV1Status(), setPacketV1Structure(), setSourceIdV1(), setUnstructDescrDataPadding(), setUnstructDescrHitFormat(), and setUnstructDescrWordSize().

#define setWordMACRO	(		packet_ptr,
			offsetOfDword,
			value
	)		(*(packet_ptr+offsetOfDword))=value

Definition at line 149 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 149 of file phenixOnline.h

Referenced by setFrameLength(), setFrameMark(), setPacketLength(), and setPacketV1Id().

#define SWORD_SIZE   sizeof(SWORD)

Definition at line 43 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 43 of file phenixOnline.h

Typedef Documentation

typedef int LOGIC_ret

Definition at line 64 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 64 of file phenixOnline.h

typedef PHDWORD* PTR_ret

Definition at line 66 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 66 of file phenixOnline.h

typedef UINT VALUE_ret

Definition at line 65 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 65 of file phenixOnline.h

Function Documentation

void dwordByteSwap ( PHDWORD *  out_ptr, PHDWORD *  in_ptr, PHDWORD  numDwords  )

inline

Definition at line 133 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 133 of file phenixOnline.h

References i, and singleDwordByteSwap().

Referenced by byteSwapFrame(), and checkFrameEndianism().

Here is the call graph for this function:

Here is the caller graph for this function:

INLINE_D PHDWORD singleDwordByteSwap

(

PHDWORD

inDword

)

Definition at line 116 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 116 of file phenixOnline.h

Referenced by byteSwapFrame(), dwordByteSwap(), and main().

Here is the caller graph for this function:

Variable Documentation

CONSTANT UINT DwordSize = DWORD_SIZE

Definition at line 45 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 45 of file phenixOnline.h

CONSTANT LOGIC_ret FALSE = 0

Definition at line 76 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 76 of file phenixOnline.h

Referenced by extendFrameDataNopad(), extendFrameHistoryNopad(), isLastFramePacket(), setAlignBlock(), setAlignBlockV1(), setDataType(), setDataTypeV1(), setFrameAlignLength(), setFrameAlignLengthV1(), setFrameErrorLength(), setFrameErrorLengthV1(), setFrameHistoryLength(), setFrameHistoryLengthV1(), setFrameStatus(), setFrameStatusV1(), setFrameType(), setFrameTypeV1(), setPacketHdrLength(), setPacketLength(), setSourceId(), setSourceIdV1(), validFrameHdrV1(), validFrameMark(), and validPacketV1Hdr().

CONSTANT LOGIC_ret logicFailure = FALSE

Definition at line 85 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 85 of file phenixOnline.h

Referenced by appendPacketError(), emptyPacket(), findPacketEnd(), makeUnstructPacketDataDescr(), removePacketPadding(), setPacketDataDescrLength(), setPacketDebugLenth(), setPacketEndianism(), setPacketErrorLength(), setPacketPadding(), setPacketStatus(), setPacketStructure(), setPacketUnstructured(), and validPacketHdr().

CONSTANT LOGIC_ret logicSuccess = TRUE

Definition at line 86 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 86 of file phenixOnline.h

Referenced by appendPacketError(), makeUnstructDataDescr(), removePacketPadding(), and setPacketUnstructured().

CONSTANT UINT maxByteValue = 0xff

Definition at line 87 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 87 of file phenixOnline.h

Referenced by setDataTypeV1(), setFrameAlignLengthV1(), and setFrameTypeV1().

CONSTANT UINT maxDwordValue = 0xfffffffe

Definition at line 89 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 89 of file phenixOnline.h

Referenced by adjustFrameLength().

CONSTANT UINT maxSwordValue = 0xffff

Definition at line 88 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 88 of file phenixOnline.h

Referenced by adjustFrameErrorLengthV1(), adjustFrameHistoryLengthV1(), setFrameErrorLengthV1(), setFrameHistoryLengthV1(), setFrameStatusV1(), and setSourceIdV1().

CONSTANT UINT PRDFbigEndian = PRDF_BIG_ENDIAN

Definition at line 57 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 57 of file phenixOnline.h

CONSTANT UINT PRDFlittleEndian = PRDF_LITTLE_ENDIAN

Definition at line 58 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 58 of file phenixOnline.h

CONSTANT UINT PRDFlocalEndianism = PRDF_LOCAL_ENDIANISM

Definition at line 59 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 59 of file phenixOnline.h

PTR_ret CONSTANT ptrFailure = 0

Definition at line 84 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 84 of file phenixOnline.h

Referenced by appendEmptyFramePacket(), X_Event::change_hf(), X_Event::change_id(), A_Event::createMap(), dumpFramePackets(), findFrameAlignBlock(), findFrameDataEnd(), findFrameDataStart(), findFrameEnd(), findFrameErrorStart(), findFrameHistoryStart(), findFramePacketId(), findFramePacketIndex(), findLastFramePacket(), findNextError(), findNextErrorV1(), findNextFramePacket(), findNextFramePacketId(), findPacketDataDescr(), findPacketDataEnd(), findPacketDataStart(), findPacketDebugStart(), findPacketEnd(), findPacketErrorStart(), finishUnstructDataWrite(), frameNumPackets(), A_Event::getFrameEntry(), A_Event::getPacketList(), getUnstructPacketDataPadding(), getUnstructPacketHitFormat(), getUnstructPacketWordSize(), A_Event::listError(), A_Event::listFrame(), A_Event::listHistory(), makeEmptyPacket(), makeUnstructPacket(), makeUnstructPacketDataDescr(), reservePacketDebugData(), setUnstructPacketDataPadding(), setUnstructPacketHitFormat(), setUnstructPacketWordSize(), startUnstructDataWrite(), storeFrameData(), and storeFrameHistory().

CONSTANT UINT SwordSize = SWORD_SIZE

Definition at line 46 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 46 of file phenixOnline.h

CONSTANT LOGIC_ret TRUE = 1

Definition at line 73 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 73 of file phenixOnline.h

Referenced by extendFrameData(), extendFrameHistory(), setAlignBlockV1(), setDataTypeV1(), setFrameAlignLengthV1(), setFrameErrorLengthV1(), setFrameHdrLength(), setFrameHdrVersion(), setFrameHistoryLengthV1(), setFrameLength(), setFrameMark(), setFramePaddingV1(), setFrameStatusV1(), setFrameTypeV1(), setPacketHdrLength(), setPacketHdrVersion(), setPacketLength(), setPacketV1DataDescrLength(), setPacketV1DebugLength(), setPacketV1Endianism(), setPacketV1ErrorLength(), setPacketV1Id(), setPacketV1Padding(), setPacketV1Status(), setPacketV1Structure(), setSourceIdV1(), setUnstructDescrDataPadding(), setUnstructDescrHitFormat(), setUnstructDescrWordSize(), validFrameHdrV1(), and validPacketV1Hdr().

CONSTANT VALUE_ret valueFailure = 0xffffffff

Definition at line 83 of file phenixOnline.h.

View newest version in sPHENIX GitHub at line 83 of file phenixOnline.h

Referenced by adjustFrameDataLength(), adjustFrameDataLengthV1(), adjustFrameErrorLength(), adjustFrameErrorLengthV1(), adjustFrameHistoryLength(), adjustFrameHistoryLengthV1(), adjustFrameLength(), adjustPacketDataLength(), adjustPacketDebugLength(), adjustPacketErrorLength(), adjustPacketV1DebugLength(), adjustPacketV1ErrorLength(), appendEmptyFramePacket(), appendPacketError(), calcNumErrorsV1(), checkFrameEndianism(), checkFrameHdrVersion(), dumpFrame(), dumpFrameHdr(), dumpFramePackets(), dumpPacket(), emptyPacket(), extendFrameData(), extendFrameDataNopad(), extendFrameHistory(), extendFrameHistoryNopad(), extendPacketDataBlock(), extendPacketDebugBlock(), extendPacketErrorBlock(), extendPacketLength(), extendUnstructPacketDataBlock(), fetchPacketHits(), findFrameAlignBlock(), findFrameDataEnd(), findFrameEnd(), findFrameErrorStart(), findFrameHistoryStart(), findNextError(), findPacketDataDescr(), findPacketDataEnd(), findPacketDebugStart(), findPacketEnd(), findPacketErrorStart(), finishUnstructDataWrite(), getAlignBlock(), getAlignBlockV1(), getFrameAlignLength(), getFrameDataLength(), getFrameDataLengthV1(), getFrameDataType(), getFrameErrorLength(), getFrameHdrLength(), getFrameHdrVersion(), getFrameHistoryLength(), getFrameLength(), getFramePadding(), getFrameSourceId(), getFrameStatus(), getFrameType(), getHistoryEntry(), getHistoryEntryV1(), getHistorySourceIndex(), getHistoryStage(), getHistoryStatus(), getPacketDataDescrLength(), getPacketDataLength(), getPacketDebugLength(), getPacketEndianism(), getPacketErrorLength(), getPacketHdrVersion(), getPacketId(), getPacketLength(), getPacketNumErrors(), getPacketPadding(), getPacketStatus(), getPacketStructure(), getUnstructPacketDataLengthBytes(), getUnstructPacketDataLengthWords(), getUnstructPacketDataPadding(), getUnstructPacketHitFormat(), getUnstructPacketWordSize(), makeEmptyPacket(), makeFrameHdrV1(), makePacketHdr(), makePacketV1Hdr(), makeUnstructPacket(), orFrameStatus(), orFrameStatusV1(), orPacketStatus(), orPacketV1Status(), reservePacketDebugData(), setAlignBlock(), setDataType(), setFrameAlignLength(), setFrameErrorLength(), setFrameHistoryLength(), setFramePadding(), setFrameStatus(), setFrameType(), setPacketDataDescrLength(), setPacketDebugLenth(), setPacketEndianism(), setPacketErrorLength(), setPacketHdrVersion(), setPacketId(), setPacketPadding(), setPacketStatus(), setPacketStructure(), setSourceId(), setUnstructPacketDataPadding(), setUnstructPacketHitFormat(), setUnstructPacketWordSize(), startUnstructDataWrite(), storeFrameData(), storeFrameHistory(), storePacketHits(), validFrameHdr(), and validFrameMark().