xbrd_trg.h File Reference

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

#include "GNAT/xbrd_hw.h"

Include dependency graph for xbrd_trg.h:

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


Functions
int	xbrd_IntTrg (xbrdHandle gx)
	Creates a self trigger source to the GLT.
int	xbrd_GetTrgEvtNum (xbrdHandle gx, unsigned short *ev)
	Gets the event number of the trigger message.
int	xbrd_SetTrgEvtNum (xbrdHandle gx, unsigned short ev)
	Sets the event number of the trigger message.
int	xbrd_GetTrgTag (xbrdHandle gx, unsigned short *tag)
	Gets the tag bits of the trigger message.
int	xbrd_SetTrgTag (xbrdHandle gx, unsigned short tag)
	Sets the tag bits of the trigger message.
int	xbrd_GetTrgCalStrb (xbrdHandle gx, unsigned short *calStrb)
	Gets the CALSTROBE bit of the trigger message.
int	xbrd_SetTrgCalStrb (xbrdHandle gx, unsigned short calStrb)
	Sets the CALSTROBE bit of the trigger message.
int	xbrd_GetTrgTACK (xbrdHandle gx, unsigned short *tack)
	Gets the TACK bit of the trigger message.
int	xbrd_SetTrgTACK (xbrdHandle gx, unsigned short tack)
	Sets the TACK bit of the trigger message.
int	xbrd_GetTrg4range (xbrdHandle gx, unsigned short *range4)
	Gets the 4 range bit of the trigger message.
int	xbrd_SetTrg4range (xbrdHandle gx, unsigned short range4)
	Sets the 4 range bit of the trigger message.
int	xbrd_GetTrgZeroSupress (xbrdHandle gx, unsigned short *zSup)
	Gets the zero suppression bit of the trigger message.
int	xbrd_SetTrgZeroSupress (xbrdHandle gx, unsigned short zSup)
	Sets the zero suppression bit of the trigger message.
int	xbrd_GetTrgMarker (xbrdHandle gx, unsigned short *marker)
	Gets the 3 bit marker field of the trigger message.
int	xbrd_SetTrgMarker (xbrdHandle gx, unsigned short marker)
	Sets the 3 bit marker field of the trigger message.
int	xbrd_GetTrgDest (xbrdHandle gx, unsigned short *dest)
	Gets the LATp destination field of the trigger message.
int	xbrd_SetTrgDest (xbrdHandle gx, unsigned short dest)
	Sets the LATp destination for event data.
int	xbrd_SetTrgMask (xbrdHandle gx, unsigned int mask)
	Sets the trigger source mask.
int	xbrd_GetTrgMask (xbrdHandle gx, unsigned int *mask)
	Gets the trigger source mask.
int	xbrd_SetTrgAB (xbrdHandle gx, unsigned short ab)
	Sets the A/B Select setting bit.
int	xbrd_GetTrgAB (xbrdHandle gx, unsigned short *ab)
	Gets the A/B channel select setting bit.
int	xbrd_SetTrgExtEventRO (xbrdHandle gx, unsigned short extEventRO)
	Sets the external event readout setting bit.
int	xbrd_GetTrgExtEventRO (xbrdHandle gx, unsigned short *extEventRO)
	Gets the external event readout setting bit.
int	xbrd_GetTrgParity (xbrdHandle gx, unsigned short *parity)
	Gets the parity definition for the trigger message.
int	xbrd_SetTrgParity (xbrdHandle gx, unsigned short parity)
	Sets the parity definition for the trigger message.
int	xbrd_SetTrgThrottleDefeat (xbrdHandle gx, unsigned short defeat)
	Sets the TEM throttle defeat setting bit.
int	xbrd_GetTrgThrottleDefeat (xbrdHandle gx, unsigned short *defeat)
	Gets the TEM throttle defeat setting bit.
int	xbrd_SetTrgCntMask (xbrdHandle gx, unsigned int mask)
	Sets the trigger source counter mask.
int	xbrd_GetTrgCntMask (xbrdHandle gx, unsigned int *mask)
	Gets the trigger source counter mask.
int	xbrd_SetTrgOut (xbrdHandle gx, unsigned int bit)
	Sets the trigger source counter mask.
int	xbrd_GetTrgOut (xbrdHandle gx, unsigned int *bit)
	Gets the enable ext clock bit.
int	xbrd_ClearTrgCnt (xbrdHandle gx)
	Resets the trigger source counter.
int	xbrd_GetTrgCnt (xbrdHandle gx, unsigned int *cnt)
	Gets the trigger source counter.

Detailed Description

Defines the trigger related methods for the VME XBRD interface.

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

Function Documentation

int xbrd_ClearTrgCnt ( xbrdHandle gx )

Resets the trigger source counter.

Parameters:

gx handle of XBRD

Returns:
OK on success

int xbrd_GetTrg4range ( xbrdHandle gx,

unsigned short * range4

)

Gets the 4 range bit of the trigger message.

Parameters:

gx handle of XBRD

range4 pointer to storage to hold bit

See also:
xbrd_SetTrg4range()

Returns:
OK on success

int xbrd_GetTrgAB ( xbrdHandle gx,

unsigned short * ab

)

Gets the A/B channel select setting bit.

Parameters:

gx handle of XBRD

ab pointer to storage to hold setting bit

See also:
xbrd_SetTrgAB()

Returns:
OK on success

int xbrd_GetTrgCalStrb ( xbrdHandle gx,

unsigned short * calStrb

)

Gets the CALSTROBE bit of the trigger message.

Parameters:

gx handle of XBRD

calStrb pointer to storage to hold bit

See also:
xbrd_SetTrgCalStrb()

Returns:
OK on success

int xbrd_GetTrgCnt ( xbrdHandle gx,

unsigned int * cnt

)

Gets the trigger source counter.

Parameters:

gx handle of XBRD

cnt pointer to storage to hold the 21-bit trigger counter

Returns:
OK on success

int xbrd_GetTrgCntMask ( xbrdHandle gx,

unsigned int * mask

)

Gets the trigger source counter mask.

Parameters:

gx handle of XBRD

mask pointer to storage to hold the trigger counter bit mask

See also:
xbrd_SetTrgCntMask()

Returns:
OK on success

int xbrd_GetTrgDest ( xbrdHandle gx,

unsigned short * dest

)

Gets the LATp destination field of the trigger message.

Parameters:

gx handle of XBRD

dest pointer to storage to hold destination (5 bits)

See also:
xbrd_SetTrgDest()

Returns:
OK on success

int xbrd_GetTrgEvtNum ( xbrdHandle gx,

unsigned short * ev

)

Gets the event number of the trigger message.

Parameters:

gx handle of XBRD

ev pointer to storage to hold event number

See also:
xbrd_SetTrgEvtNum()

Returns:
OK on success

int xbrd_GetTrgExtEventRO ( xbrdHandle gx,

unsigned short * extEventRO

)

Gets the external event readout setting bit.

Parameters:

gx handle of XBRD

extEventRO pointer to storage to hold setting bit

See also:
xbrd_SetTrgExtEventRO()

Returns:
OK on success

int xbrd_GetTrgMarker ( xbrdHandle gx,

unsigned short * marker

)

Gets the 3 bit marker field of the trigger message.

Parameters:

gx handle of XBRD

marker pointer to storage to hold marker (3 bits)

See also:
xbrd_SetTrgMarker()

Returns:
OK on success

int xbrd_GetTrgMask ( xbrdHandle gx,

unsigned int * mask

)

Gets the trigger source mask.

Parameters:

gx handle of XBRD

mask pointer to storage to hold the trigger bit mask

See also:
xbrd_SetTrgMask()

Returns:
OK on success

int xbrd_GetTrgOut ( xbrdHandle gx,

unsigned int * bit

)

Gets the enable ext clock bit.

Parameters:

gx handle of XBRD

bit pointer to storage to hold the external clock enable bit

See also:
xbrd_SetTrgOut()

Returns:
OK on success
This function returns the current state of the external clock bit of the XBRD's test features register. When set(1) this bit means that the stretched OR of the selected trigger request lines will be output through the EXT CLOCK LEMO connector on the front panel. When clear(0) an external clock can be applied to the LEMO connector.

int xbrd_GetTrgParity ( xbrdHandle gx,

unsigned short * parity

)

Gets the parity definition for the trigger message.

Parameters:

gx handle of XBRD

parity pointer to storage to hold parity definition

See also:
xbrd_SetTrgParity()

Returns:
OK on success

int xbrd_GetTrgTACK ( xbrdHandle gx,

unsigned short * tack

)

Gets the TACK bit of the trigger message.

Parameters:

gx handle of XBRD

tack pointer to storage to hold bit

See also:
xbrd_SetTrgTACK()

Returns:
OK on success

int xbrd_GetTrgTag ( xbrdHandle gx,

unsigned short * tag

)

Gets the tag bits of the trigger message.

Parameters:

gx handle of XBRD

tag pointer to storage to hold bits(2)

See also:
xbrd_SetTrgTag()

Returns:
OK on success

int xbrd_GetTrgThrottleDefeat ( xbrdHandle gx,

unsigned short * defeat

)

Gets the TEM throttle defeat setting bit.

Parameters:

gx handle of XBRD

defeat pointer to storage to hold throttle defeat setting bit

See also:
xbrd_SetTrgThrottleDefeat()

Returns:
OK on success

int xbrd_GetTrgZeroSupress ( xbrdHandle gx,

unsigned short * zSup

)

Gets the zero suppression bit of the trigger message.

Parameters:

gx handle of XBRD

zSup pointer to storage to hold bit

See also:
xbrd_SetTrgZeroSupress()

Returns:
OK on success

int xbrd_IntTrg ( xbrdHandle gx )

Creates a self trigger source to the GLT.

Parameters:

gx handle of XBRD

Returns:
OK on success

Raises the self trigger signal -- the XBRD may ignore this signal if the internal trigger is disabled (
See also:
xbrd_SetTrgMask() ).

int xbrd_SetTrg4range ( xbrdHandle gx,

unsigned short range4

)

Sets the 4 range bit of the trigger message.

Parameters:

gx handle of XBRD

range4 boolean bit

See also:
xbrd_GetTrg4range()

Returns:
OK on success

int xbrd_SetTrgAB ( xbrdHandle gx,

unsigned short ab

)

Sets the A/B Select setting bit.

Parameters:

gx handle of XBRD

ab boolean bit -- A(0), B(1)

See also:
xbrd_GetTrgAB()

Returns:
OK on success

int xbrd_SetTrgCalStrb ( xbrdHandle gx,

unsigned short calStrb

)

Sets the CALSTROBE bit of the trigger message.

Parameters:

gx handle of XBRD

calStrb boolean bit

See also:
xbrd_GetTrgTACK()

Returns:
OK on success

int xbrd_SetTrgCntMask ( xbrdHandle gx,

unsigned int mask

)

Sets the trigger source counter mask.

Parameters:

gx handle of XBRD

mask bitmask of trigger sources to count

See also:
xbrd_GetTrgCntMask()

Returns:
OK on success

Controls which trigger sources are considered for counting. It is mask enabled so a value of zero means the trigger source is counted:

internal trigger bit 0

external trigger bit 1

CAL_low (TEM) bit 2

CAL_higg (TEM) bit 3

3-in-a-row (TEM) bit 4

int xbrd_SetTrgDest ( xbrdHandle gx,

unsigned short dest

)

Sets the LATp destination for event data.

Parameters:

gx handle of XBRD

dest LATp destination address

See also:
xbrd_GetTrgDest()

Returns:
OK on success

int xbrd_SetTrgEvtNum ( xbrdHandle gx,

unsigned short ev

)

Sets the event number of the trigger message.

Parameters:

gx handle of XBRD

ev event number

See also:
xbrd_GetTrgEvtNum()

Returns:
OK on success

int xbrd_SetTrgExtEventRO ( xbrdHandle gx,

unsigned short extEventRO

)

Sets the external event readout setting bit.

Parameters:

gx handle of XBRD

extEventRO boolean bit

See also:
xbrd_GetTrgExtEventRO()

Returns:
OK on success
The ExtEventRO bit of the XBRD board test features register controls whether trigger messages generated by the XBRD board in response to external trigger sources will include the current values for the CalStrogbe and TACK bits.
If the ExtEventRO bit is clear then trigger messages generated by the XBRD board in response to external trigger sources will have the CalStrobe and TACK bits cleared, i.e. a normal event read out trigger request.
If the ExtEventRO bit is set then trigger messages will contain the values of the CalStrobe and TACK bits currently assigned in the trigger message register.

int xbrd_SetTrgMarker ( xbrdHandle gx,

unsigned short marker

)

Sets the 3 bit marker field of the trigger message.

Parameters:

gx handle of XBRD

marker trigger message marker (3 bits)

See also:
xbrd_GetTrgMarker()

Returns:
OK on success

int xbrd_SetTrgMask ( xbrdHandle gx,

unsigned int mask

)

Sets the trigger source mask.

Parameters:

gx handle of XBRD

mask bitmask of trigger sources to disable

See also:
xbrd_GetTrgMask()

Returns:
OK on success

Controls which trigger sources are considered in the trigger calculation. It is mask enabled so a value of zero means the trigger source is enabled:

internal trigger bit 0

external trigger bit 1

CAL_low (TEM) bit 2

CAL_higg (TEM) bit 3

3-in-a-row (TEM) bit 4

int xbrd_SetTrgOut ( xbrdHandle gx,

unsigned int bit

)

Sets the trigger source counter mask.

Parameters:

gx handle of XBRD

bit value to set the external clock bit

See also:
xbrd_GetTrgOut()

Returns:
OK on success
If bit is non-zero the external clock bit of the test features register will be set to 1, otherwise it will be set to 0.

int xbrd_SetTrgParity ( xbrdHandle gx,

unsigned short parity

)

Sets the parity definition for the trigger message.

Parameters:

gx handle of XBRD

parity non-zero indicates odd parity, zero indicates even parity

See also:
xbrd_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".

int xbrd_SetTrgTACK ( xbrdHandle gx,

unsigned short tack

)

Sets the TACK bit of the trigger message.

Parameters:

gx handle of XBRD

tack boolean bit

See also:
xbrd_GetTrgTACK()

Returns:
OK on success

int xbrd_SetTrgTag ( xbrdHandle gx,

unsigned short tag

)

Sets the tag bits of the trigger message.

Parameters:

gx handle of XBRD

tag tag bits(2)

See also:
xbrd_GetTrgTag()

Returns:
OK on success

int xbrd_SetTrgThrottleDefeat ( xbrdHandle gx,

unsigned short defeat

)

Sets the TEM throttle defeat setting bit.

Parameters:

gx handle of XBRD

defeat non-zero (defeat throttle), zero (obey throttle)

See also:
xbrd_GetTrgThrottleDefeat()

Returns:
OK on success

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

int xbrd_SetTrgZeroSupress ( xbrdHandle gx,

unsigned short zSup

)

Sets the zero suppression bit of the trigger message.

Parameters:

gx handle of XBRD

zSup boolean bit

See also:
xbrd_GetTrgZeroSupress()

Returns:
OK on success

Generated on Fri Oct 22 04:29:14 2004 by

1.3.3

xbrd_trg.h File Reference

Functions

Detailed Description

Function Documentation