GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> GNAT / V2-0-1 > gnat_trg / linux-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » TSS » source » GNAT » V2-0-1 » GNAT

vasu_trg.h File Reference

Defines the trigger related methods for the VME VASU interface. More...


Functions

int vasu_IntTrg (gnatHandle gh)
 Creates a self trigger source to the GLT.
int vasu_GetTrgEvtNum (gnatHandle gh, unsigned short *ev)
 Gets the event number of the trigger message.
int vasu_SetTrgEvtNum (gnatHandle gh, unsigned short ev)
 Sets the event number of the trigger message.
int vasu_GetTrgTag (gnatHandle gh, unsigned short *tag)
 Gets the tag bits of the trigger message.
int vasu_SetTrgTag (gnatHandle gh, unsigned short tag)
 Sets the tag bits of the trigger message.
int vasu_GetTrgCalStrb (gnatHandle gh, unsigned short *calStrb)
 Gets the CALSTROBE bit of the trigger message.
int vasu_SetTrgCalStrb (gnatHandle gh, unsigned short calStrb)
 Sets the CALSTROBE bit of the trigger message.
int vasu_GetTrgTACK (gnatHandle gh, unsigned short *tack)
 Gets the TACK bit of the trigger message.
int vasu_SetTrgTACK (gnatHandle gh, unsigned short tack)
 Sets the TACK bit of the trigger message.
int vasu_GetTrgExtCalStrb (gnatHandle gh, unsigned short *calStrb)
 Gets the external CALSTROBE bit of the trigger message.
int vasu_SetTrgExtCalStrb (gnatHandle gh, unsigned short calStrb)
 Sets the external CALSTROBE bit of the trigger message.
int vasu_GetTrgExtTACK (gnatHandle gh, unsigned short *tack)
 Gets the external TACK bit of the trigger message.
int vasu_SetTrgExtTACK (gnatHandle gh, unsigned short tack)
 Sets the external TACK bit of the trigger message.
int vasu_GetTrg4range (gnatHandle gh, unsigned short *range4)
 Gets the 4 range bit of the trigger message.
int vasu_SetTrg4range (gnatHandle gh, unsigned short range4)
 Sets the 4 range bit of the trigger message.
int vasu_GetTrgZeroSupress (gnatHandle gh, unsigned short *zSup)
 Gets the zero suppression bit of the trigger message.
int vasu_SetTrgZeroSupress (gnatHandle gh, unsigned short zSup)
 Sets the zero suppression bit of the trigger message.
int vasu_GetTrgMarker (gnatHandle gh, unsigned short *marker)
 Gets the 3 bit marker field of the trigger message.
int vasu_SetTrgMarker (gnatHandle gh, unsigned short marker)
 Sets the 3 bit marker field of the trigger message.
int vasu_GetTrgDest (gnatHandle gh, unsigned short *dest)
 Gets the LATp destination field of the trigger message.
int vasu_SetTrgDest (gnatHandle gh, unsigned short dest)
 Sets the LATp destination for event data.
int vasu_SetTrgMask (gnatHandle gh, unsigned int mask)
 Sets the trigger source mask.
int vasu_GetTrgMask (gnatHandle gh, unsigned int *mask)
 Gets the trigger source mask.
int vasu_SetTrgCntMask (gnatHandle gh, unsigned int mask)
 Sets the trigger source counter mask.
int vasu_GetTrgCntMask (gnatHandle gh, unsigned int *mask)
 Gets the trigger source counter mask.
int vasu_SetTrgCounter (gnatHandle gh, unsigned int cnt)
 Clears the trigger source mask.
int vasu_GetTrgCounter (gnatHandle gh, unsigned int *cnt)
 Gets the trigger source counter.
int vasu_SetTrgSeq (gnatHandle gh, unsigned int seq)
 Sets the trigger sequencing register.
int vasu_GetTrgSeq (gnatHandle gh, unsigned int *seq)
 Gets the trigger sequencing register.
int vasu_SetDataMode (gnatHandle gh, unsigned short mode)
 Sets the VASU data mode.
int vasu_GetDataMode (gnatHandle gh, unsigned short *mode)
 Gets the VASU data mode.
int vasu_GetTrgParity (gnatHandle gh, unsigned short *parity)
 Gets the parity definition for the trigger message.
int vasu_SetTrgParity (gnatHandle gh, unsigned short parity)
 Sets the parity definition for the trigger message.
int vasu_GetTrgMsg (gnatHandle gh, unsigned int *msg)
 Gets the entire trigger message register.
int vasu_SetTrgThrottleDefeat (gnatHandle gh, unsigned short defeat)
 Sets the TEM throttle defeat setting bit.
int vasu_GetTrgThrottleDefeat (gnatHandle gh, unsigned short *defeat)
 Gets the TEM throttle defeat setting bit.

Detailed Description

Defines the trigger related methods for the VME VASU interface.

Author:
Curt Brune -- curt@slac.stanford.edu

Function Documentation

int vasu_GetDataMode ( gnatHandle  gh,
unsigned short *  mode 
)

Gets the VASU data mode.

Parameters:
gh handle of VASU
mode pointer to storage to hold setting bit
See also:
vasu_SetDataMode()
Returns:
OK on success

References _vasu_regTestFeature::bf, _BFvasu_regTestFeature::dataMode, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_testFeat, _gnat::m_vasu, _vasu_regTestFeature::ui, and VERIFY_HANDLE.

int vasu_GetTrg4range ( gnatHandle  gh,
unsigned short *  range4 
)

Gets the 4 range bit of the trigger message.

Parameters:
gh handle of VASU
range4 pointer to storage to hold bit
See also:
vasu_SetTrg4range()
Returns:
OK on success

References _vasu_regTrgMsg::bf, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _BFvasu_regTrgMsg::readout4, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_GetTrgCalStrb ( gnatHandle  gh,
unsigned short *  calStrb 
)

Gets the CALSTROBE bit of the trigger message.

Parameters:
gh handle of VASU
calStrb pointer to storage to hold bit
See also:
vasu_SetTrgCalStrb()
Returns:
OK on success

References _vasu_regTrgMsg::bf, _BFvasu_regTrgMsg::calStrobe, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_GetTrgCntMask ( gnatHandle  gh,
unsigned int *  mask 
)

Gets the trigger source counter mask.

Parameters:
gh handle of VASU
mask pointer to storage to hold the bit mask
See also:
vasu_SetTrgCntMask()
Returns:
OK on success

References G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_trgCntMask, _gnat::m_vasu, and VERIFY_HANDLE.

int vasu_GetTrgCounter ( gnatHandle  gh,
unsigned int *  cnt 
)

Gets the trigger source counter.

Parameters:
gh handle of VASU
cnt pointer to storage to hold the count
See also:
vasu_SetTrgCounter()
Returns:
OK on success

References G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_trgCounter, _gnat::m_vasu, and VERIFY_HANDLE.

int vasu_GetTrgDest ( gnatHandle  gh,
unsigned short *  dest 
)

Gets the LATp destination field of the trigger message.

Parameters:
gh handle of VASU
dest pointer to storage to hold destination (5 bits)
See also:
vasu_SetTrgDest()
Returns:
OK on success

References _vasu_regTrgMsg::bf, _BFvasu_regTrgMsg::dest, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_GetTrgEvtNum ( gnatHandle  gh,
unsigned short *  ev 
)

Gets the event number of the trigger message.

Parameters:
gh handle of VASU
ev pointer to storage to hold event number
See also:
vasu_SetTrgEvtNum()
Returns:
OK on success

References _vasu_regEvtNum::bf, _BFvasu_regEvtNum::eventNum, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_EvtNum, _gnat::m_vasu, _vasu_regEvtNum::ui, and VERIFY_HANDLE.

int vasu_GetTrgExtCalStrb ( gnatHandle  gh,
unsigned short *  calStrb 
)

Gets the external CALSTROBE bit of the trigger message.

Parameters:
gh handle of VASU
calStrb pointer to storage to hold bit
See also:
vasu_SetTrgExtCalStrb()
Returns:
OK on success

References _vasu_regTrgMsg::bf, _BFvasu_regTrgMsg::extCS, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_GetTrgExtTACK ( gnatHandle  gh,
unsigned short *  tack 
)

Gets the external TACK bit of the trigger message.

Parameters:
gh handle of VASU
tack pointer to storage to hold bit
See also:
vasu_SetTrgExtTACK()
Returns:
OK on success

References _vasu_regTrgMsg::bf, _BFvasu_regTrgMsg::extTACK, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_GetTrgMarker ( gnatHandle  gh,
unsigned short *  marker 
)

Gets the 3 bit marker field of the trigger message.

Parameters:
gh handle of VASU
marker pointer to storage to hold marker (3 bits)
See also:
vasu_SetTrgMarker()
Returns:
OK on success

References _vasu_regTrgMsg::bf, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _BFvasu_regTrgMsg::marker, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_GetTrgMask ( gnatHandle  gh,
unsigned int *  mask 
)

Gets the trigger source mask.

Parameters:
gh handle of VASU
mask pointer to storage to hold the trigger bit mask
See also:
vasu_SetTrgMask()
Returns:
OK on success

References G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_trgSrcMask, _gnat::m_vasu, and VERIFY_HANDLE.

int vasu_GetTrgMsg ( gnatHandle  gh,
unsigned int *  msg 
)

Gets the entire trigger message register.

Parameters:
gh handle of VASU
msg pointer to storage to hold trigger message
Returns:
OK on success

References G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, and VERIFY_HANDLE.

int vasu_GetTrgParity ( gnatHandle  gh,
unsigned short *  parity 
)

Gets the parity definition for the trigger message.

Parameters:
gh handle of VASU
parity pointer to storage to hold parity definition
See also:
vasu_SetTrgParity()
Returns:
OK on success

References _vasu_regTestFeature::bf, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_testFeat, _gnat::m_vasu, _BFvasu_regTestFeature::trgParity, _vasu_regTestFeature::ui, and VERIFY_HANDLE.

int vasu_GetTrgSeq ( gnatHandle  gh,
unsigned int *  seq 
)

Gets the trigger sequencing register.

Parameters:
gh handle of VASU
seq pointer to storage to hold the count
See also:
vasu_SetTrgSeq()
Returns:
OK on success

References G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_trgSeq, _gnat::m_vasu, and VERIFY_HANDLE.

int vasu_GetTrgTACK ( gnatHandle  gh,
unsigned short *  tack 
)

Gets the TACK bit of the trigger message.

Parameters:
gh handle of VASU
tack pointer to storage to hold bit
See also:
vasu_SetTrgTACK()
Returns:
OK on success

References _vasu_regTrgMsg::bf, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _BFvasu_regTrgMsg::TACK, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_GetTrgTag ( gnatHandle  gh,
unsigned short *  tag 
)

Gets the tag bits of the trigger message.

Parameters:
gh handle of VASU
tag pointer to storage to hold bits(2)
See also:
vasu_SetTrgTag()
Returns:
OK on success

References _vasu_regEvtNum::bf, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_EvtNum, _gnat::m_vasu, _BFvasu_regEvtNum::tag, _vasu_regEvtNum::ui, and VERIFY_HANDLE.

int vasu_GetTrgThrottleDefeat ( gnatHandle  gh,
unsigned short *  defeat 
)

Gets the TEM throttle defeat setting bit.

Parameters:
gh handle of VASU
defeat pointer to storage to hold throttle defeat setting bit
See also:
vasu_SetTrgThrottleDefeat()
Returns:
OK on success

References _vasu_regTestFeature::bf, _BFvasu_regTestFeature::disableBusy, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_testFeat, _gnat::m_vasu, _vasu_regTestFeature::ui, and VERIFY_HANDLE.

int vasu_GetTrgZeroSupress ( gnatHandle  gh,
unsigned short *  zSup 
)

Gets the zero suppression bit of the trigger message.

Parameters:
gh handle of VASU
zSup pointer to storage to hold bit
See also:
vasu_SetTrgZeroSupress()
Returns:
OK on success

References _vasu_regTrgMsg::bf, G_OK, GERR_BAD_PARAM, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _vasu_regTrgMsg::ui, VERIFY_HANDLE, and _BFvasu_regTrgMsg::zeroSupress.

int vasu_IntTrg ( gnatHandle  gh  ) 

Creates a self trigger source to the GLT.

Parameters:
gh handle of VASU
Returns:
OK on success

Raises the self trigger signal -- the VASU may ignore this signal if the internal trigger is disabled (

See also:
vasu_SetTrgMask() ).

References G_OK, _vasuRegBlock::m_swTrg, _gnat::m_vasu, and VERIFY_HANDLE.

int vasu_SetDataMode ( gnatHandle  gh,
unsigned short  mode 
)

Sets the VASU data mode.

Parameters:
gh handle of VASU
mode boolean bit
See also:
vasu_GetDataMode()
Returns:
OK on success
The DataMode bit control the expected format of the data in the results FIFO. It is either (0) a response to a command or (1) event data.

References _vasu_regTestFeature::bf, _BFvasu_regTestFeature::dataMode, G_OK, _vasuRegBlock::m_testFeat, _gnat::m_vasu, _vasu_regTestFeature::ui, and VERIFY_HANDLE.

int vasu_SetTrg4range ( gnatHandle  gh,
unsigned short  range4 
)

Sets the 4 range bit of the trigger message.

Parameters:
gh handle of VASU
range4 boolean bit
See also:
vasu_GetTrg4range()
Returns:
OK on success

References _vasu_regTrgMsg::bf, G_OK, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _BFvasu_regTrgMsg::readout4, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_SetTrgCalStrb ( gnatHandle  gh,
unsigned short  calStrb 
)

Sets the CALSTROBE bit of the trigger message.

Parameters:
gh handle of VASU
calStrb boolean bit
See also:
vasu_GetTrgTACK()
Returns:
OK on success

References _vasu_regTrgMsg::bf, _BFvasu_regTrgMsg::calStrobe, G_OK, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_SetTrgCntMask ( gnatHandle  gh,
unsigned int  mask 
)

Sets the trigger source counter mask.

Parameters:
gh handle of VASU
mask bitmask of trigger sources to count
See also:
vasu_GetTrgCntMask()
Returns:
OK on success

References G_OK, _vasuRegBlock::m_trgCntMask, _gnat::m_vasu, and VERIFY_HANDLE.

int vasu_SetTrgCounter ( gnatHandle  gh,
unsigned int  cnt 
)

Clears the trigger source mask.

Parameters:
gh handle of VASU
cnt value ignored
See also:
vasu_GetTrgCounter()
Returns:
OK on success
Regardless of the value of cnt this function clears the trigger source counter.

References G_OK, _vasuRegBlock::m_trgCounter, _gnat::m_vasu, and VERIFY_HANDLE.

int vasu_SetTrgDest ( gnatHandle  gh,
unsigned short  dest 
)

Sets the LATp destination for event data.

Parameters:
gh handle of VASU
dest LATp destination address
See also:
vasu_GetTrgDest()
Returns:
OK on success

References _vasu_regTrgMsg::bf, _BFvasu_regTrgMsg::dest, G_OK, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_SetTrgEvtNum ( gnatHandle  gh,
unsigned short  ev 
)

Sets the event number of the trigger message.

Parameters:
gh handle of VASU
ev event number
See also:
vasu_GetTrgEvtNum()
Returns:
OK on success

References _vasu_regEvtNum::bf, _BFvasu_regEvtNum::eventNum, G_OK, _vasuRegBlock::m_cfgEvtNum, _gnat::m_vasu, _vasu_regEvtNum::ui, and VERIFY_HANDLE.

int vasu_SetTrgExtCalStrb ( gnatHandle  gh,
unsigned short  calStrb 
)

Sets the external CALSTROBE bit of the trigger message.

Parameters:
gh handle of VASU
calStrb boolean bit
See also:
vasu_GetTrgExtTACK()
Returns:
OK on success

References _vasu_regTrgMsg::bf, _BFvasu_regTrgMsg::extCS, G_OK, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_SetTrgExtTACK ( gnatHandle  gh,
unsigned short  tack 
)

Sets the external TACK bit of the trigger message.

Parameters:
gh handle of VASU
tack boolean bit
See also:
vasu_GetTrgExtTACK()
Returns:
OK on success

References _vasu_regTrgMsg::bf, _BFvasu_regTrgMsg::extTACK, G_OK, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_SetTrgMarker ( gnatHandle  gh,
unsigned short  marker 
)

Sets the 3 bit marker field of the trigger message.

Parameters:
gh handle of VASU
marker trigger message marker (3 bits)
See also:
vasu_GetTrgMarker()
Returns:
OK on success

References _vasu_regTrgMsg::bf, G_OK, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _BFvasu_regTrgMsg::marker, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_SetTrgMask ( gnatHandle  gh,
unsigned int  mask 
)

Sets the trigger source mask.

Parameters:
gh handle of VASU
mask bitmask of trigger sources to disable
See also:
vasu_GetTrgMask()
Returns:
OK on success

References G_OK, _vasuRegBlock::m_trgSrcMask, _gnat::m_vasu, and VERIFY_HANDLE.

int vasu_SetTrgParity ( gnatHandle  gh,
unsigned short  parity 
)

Sets the parity definition for the trigger message.

Parameters:
gh handle of VASU
parity non-zero indicates odd parity, zero indicates even parity
See also:
vasu_GetTrgParity()
Returns:
OK on success

Sets the meaning of parity for the trigger message -- zero means "use even parity", while a non-zero value means "use odd parity".

References _vasu_regTestFeature::bf, G_OK, _vasuRegBlock::m_testFeat, _gnat::m_vasu, _BFvasu_regTestFeature::trgParity, _vasu_regTestFeature::ui, and VERIFY_HANDLE.

int vasu_SetTrgSeq ( gnatHandle  gh,
unsigned int  seq 
)

Sets the trigger sequencing register.

Parameters:
gh handle of VASU
seq New sequencing value
See also:
vasu_GetTrgSeq()
Returns:
OK on success
Regardless of the value of cnt this function clears the trigger source counter.

References G_OK, _vasuRegBlock::m_trgSeq, _gnat::m_vasu, and VERIFY_HANDLE.

int vasu_SetTrgTACK ( gnatHandle  gh,
unsigned short  tack 
)

Sets the TACK bit of the trigger message.

Parameters:
gh handle of VASU
tack boolean bit
See also:
vasu_GetTrgTACK()
Returns:
OK on success

References _vasu_regTrgMsg::bf, G_OK, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _BFvasu_regTrgMsg::TACK, _vasu_regTrgMsg::ui, and VERIFY_HANDLE.

int vasu_SetTrgTag ( gnatHandle  gh,
unsigned short  tag 
)

Sets the tag bits of the trigger message.

Parameters:
gh handle of VASU
tag tag bits(2)
See also:
vasu_GetTrgTag()
Returns:
OK on success

References _vasu_regEvtNum::bf, G_OK, _vasuRegBlock::m_cfgEvtNum, _gnat::m_vasu, _BFvasu_regEvtNum::tag, _vasu_regEvtNum::ui, and VERIFY_HANDLE.

int vasu_SetTrgThrottleDefeat ( gnatHandle  gh,
unsigned short  defeat 
)

Sets the TEM throttle defeat setting bit.

Parameters:
gh handle of VASU
defeat non-zero (defeat throttle), zero (obey throttle)
See also:
vasu_GetTrgThrottleDefeat()
Returns:
OK on success

When asserted the VASU ignores the TEM throttle. Used for testing only.

References _vasu_regTestFeature::bf, _BFvasu_regTestFeature::disableBusy, G_OK, _vasuRegBlock::m_testFeat, _gnat::m_vasu, _vasu_regTestFeature::ui, and VERIFY_HANDLE.

int vasu_SetTrgZeroSupress ( gnatHandle  gh,
unsigned short  zSup 
)

Sets the zero suppression bit of the trigger message.

Parameters:
gh handle of VASU
zSup boolean bit
See also:
vasu_GetTrgZeroSupress()
Returns:
OK on success

References _vasu_regTrgMsg::bf, G_OK, _vasuRegBlock::m_TrgMsg, _gnat::m_vasu, _vasu_regTrgMsg::ui, VERIFY_HANDLE, and _BFvasu_regTrgMsg::zeroSupress.

Generated on Fri Sep 30 19:18:02 2011 by  doxygen 1.5.8