gtrg.h File Reference

Defines public structs and methods for trigger messaging. More...

Classes
struct	_BFtrgMsg
	Bit field definitions for a 32-bit trigger message. More...
union	_trgMsg
	union for 32-bit trigger message More...
Defines
#define	TRG_DISABLE_THROTTLE   ((unsigned short)(1<<5))
	mask enable bit of the trgMaskCfg register for the trigger throttle
#define	TRG_DISABLE_3_IN_A_ROW   ((unsigned short)(1<<4))
	mask enable bit of the trgMaskCfg register for the 3-in-a-row trigger source.
#define	TRG_DISABLE_CAL_HIGH   ((unsigned short)(1<<3))
	mask enable bit of the trgMaskCfg register for the CAL_high trigger source.
#define	TRG_DISABLE_CAL_LOW   ((unsigned short)(1<<2))
	mask enable bit of the trgMaskCfg register for the CAL_low trigger source.
#define	TRG_DISABLE_EXT_TRG   ((unsigned short)(1<<1))
	mask enable bit of the trgMaskCfg register for the external trigger source.
#define	TRG_DISABLE_INT_TRG   ((unsigned short)1)
	mask enable bit of the trgMaskCfg register for the internal trigger source.
Typedefs
typedef union _trgMsg	trgMsg
	typedef for union _trgMsg
Functions
int	gGetTrgMaskCfgReg (gnatHandle gh, unsigned int *val)
	returns the contents of the trigger mask / config register
int	gSetTrgMaskCfgReg (gnatHandle gh, unsigned int val)
	sets the contents of the trigger mask / config register
int	gGetTrgOptReg (gnatHandle gh, unsigned int *val)
	returns the contents of the trigger options register
int	gSetTrgOptReg (gnatHandle gh, unsigned int val)
	sets the contents of the trigger options register
int	gSetTrgSelfTrg (gnatHandle gh)
	Creates a self trigger signal.
int	gReadTrgMsg (gnatHandle gh, gResponse *rsp)
	Attempts to read a trigger message from record FIFO.

---

Detailed Description

Defines public structs and methods for trigger messaging.

Author:

Curt Brune -- curt@slac.stanford.edu

---

Function Documentation

int gGetTrgMaskCfgReg	(	gnatHandle	gh,
		unsigned int *	val
	)

returns the contents of the trigger mask / config register

Parameters:

	gh	handle of device
	val	pointer to storage to hold register on return

Returns:

OK on success

See also:

gSetTrgMaskCfgReg()

References G_OK, GERR_BAD_PARAM, _gnat::m_baseAddr, _regBlock::m_maskCfgReg, and VERIFY_HANDLE.

int gGetTrgOptReg	(	gnatHandle	gh,
		unsigned int *	val
	)

returns the contents of the trigger options register

Parameters:

	gh	handle of device
	val	pointer to storage to hold register on return

Returns:

OK on success

See also:

gSetTrgOptReg()

References G_OK, GERR_BAD_PARAM, _gnat::m_baseAddr, _regBlock::m_optReg, and VERIFY_HANDLE.

int gReadTrgMsg	(	gnatHandle	gh,
		gResponse *	rsp
	)

Attempts to read a trigger message from record FIFO.

Parameters:

	gh	handle of device
	rsp	pointer to response structure to hold the result

Returns:

OK on success

The trigger message is 32 bits long and looks like this in the record FIFO (18 bits wide).

        -----------------------------------
        1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0
        7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
        -----------------------------------
Word 1  1 M M M M M M M M M M M M M M M M M
Word 2  D D M M M M M M M M M M M M M M Z Z
Word 3  D D Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z
Word 4  D D Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z
Word 5  D D Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z
Word 6  D D Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z
Word 7  D D Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z
Word 8  D D Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z
Word 9  D D Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z
Word 10 D D Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z

  Legend:

      1  --  Start Bit, first bit of trigger message
      M  --  Message bit, 31 in all
      D  --  Do not care, ignored
      Z  --  Zero
  

I want to return the start bit plus the 31 message bits.

References _LOG1, G_OK, GERR_BAD_RSP, GERR_RSP_TIMEOUT, _gnat::m_latpIntr, and VERIFY_HANDLE.

int gSetTrgMaskCfgReg	(	gnatHandle	gh,
		unsigned int	val
	)

sets the contents of the trigger mask / config register

Parameters:

	gh	handle of device
	val	value to put in register

Returns:

OK on success

See also:

gGetTrgMaskCfgReg()

References G_OK, _gnat::m_baseAddr, _regBlock::m_maskCfgReg, and VERIFY_HANDLE.

int gSetTrgOptReg	(	gnatHandle	gh,
		unsigned int	val
	)

sets the contents of the trigger options register

Parameters:

	gh	handle of device
	val	value to put in register

Returns:

OK on success

See also:

gGetTrgOptReg()

References G_OK, _gnat::m_baseAddr, _regBlock::m_optReg, and VERIFY_HANDLE.

int gSetTrgSelfTrg

(

gnatHandle

gh

)

Creates a self trigger signal.

Parameters:

gh

handle of device

Returns:

OK on success

Raises the self trigger signal -- the COMM board may ignore this signal if the internal trigger is disable (see gSetTrgMask() ).

References G_OK, _gnat::m_baseAddr, _regBlock::m_trgReg, and VERIFY_HANDLE.