---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > TPG / dev

Constituent: tpg     Tag: sun-gcc

---

         

---

tpg.c File Reference

Trigger Pattern Generator command-line user interface. More...

#include "TPG/TPG_msgs.h"
#include "tpg_p.h"
#include "GNAT/ginit.h"
#include "GNAT/gio.h"
#include "MSG/MSG_pubdefs.h"
#include "MSG/MSG_msgs.h"
#include "MSG/MSG_printProc.h"
#include "PBS/PBS.h"
#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>
#include <string.h>

Include dependency graph for tpg.c:

Functions
unsigned	TPGcomPresent (TPG *this, unsigned boardId)
	Test for board presence.
unsigned	TPGusingPTEM (TPG *this)
unsigned	TPGusingRTEM (TPG *this)
TPG *	TPGnew (unsigned *commAddr)
	Calls calloc to allocate memory for the struct and associated buffers then sets the buffer pointers to the correct offsets.
void	TPGclear (TPG *this)
	Sets all the buffers to 0.
void	TPGclearBuf (TPG *this, unsigned bufferId)
	Sets the buffer indicated by bufferId to 0.
unsigned	TPGsetTEM (TPG *this, unsigned tem_id, unsigned trg, unsigned start, unsigned pattern, unsigned pat_len, unsigned repetitions)
	Places the pat_len LSBs of pattern into the channel and buffer indicated by tem_id and trg.
unsigned	TPGsetVETO (TPG *this, unsigned free_id, unsigned veto_id, unsigned start, unsigned pattern, unsigned pat_len, unsigned repetitions)
	Places the pat_len LSBs of pattern into the channel and buffer indicated by free_id and veto_id.
unsigned	TPGsetCNO (TPG *this, unsigned free_id, unsigned start, unsigned pattern, unsigned pat_len, unsigned repetitions)
	Places the pat_len LSBs of pattern into the channel and buffer indicated by free_id and veto_id.
unsigned	TPGsetTEMv (TPG *this, unsigned tem_id, unsigned trg, unsigned start, unsigned *pattern, unsigned pat_len, unsigned repetitions)
	Places the pat_len LSBs of pattern into the channel and buffer indicated by tem_id and trg.
unsigned	TPGsetVETOv (TPG *this, unsigned free_id, unsigned veto_id, unsigned start, unsigned *pattern, unsigned pat_len, unsigned repetitions)
	Places the pat_len LSBs of pattern into the channel and buffer indicated by free_id and veto_id.
unsigned	TPGsetCNOv (TPG *this, unsigned free_id, unsigned start, unsigned *pattern, unsigned pat_len, unsigned repetitions)
	Places the pat_len LSBs of pattern into the channel and buffer indicated by free_id and veto_id.
unsigned	TPGdelay (TPG *this, int comBoard, int clkDelay)
unsigned	TPGload (TPG *this, unsigned char *clkDelay)
	Use Programmed I/O to fill the COMM board FIFOs.
unsigned	TPGstart (TPG *this)
	Start the playback.
unsigned	TPGdumpFREE (TPG *this, unsigned free_id, unsigned start, unsigned len)
	Print out the bit patterns in the free board.
unsigned	TPGdumpCNO (TPG *this, unsigned start, unsigned len)
	Print out the bit patterns in the CNO buffer.
unsigned	TPGdumpTEM (TPG *this, unsigned start, unsigned len)
	Print out the bit patterns in the TEM buffer.
unsigned	TPGdump (TPG *this, unsigned boardId, unsigned start, unsigned len)
	Print out the bit patterns in the requested board.
unsigned	_checkBounds (unsigned start, unsigned pat_len, unsigned repetitions)
	Checks that the requested addition to the buffer does not exceed the boundaries.
unsigned	_checkTEM (unsigned tem_id, unsigned trg)
	Checks that the tem_id and trg are valid.
unsigned	_checkFREE (unsigned free_id, unsigned veto_id)
	Checks that the free_id and veto_id are valid.
unsigned	_checkCNO (unsigned free_id)
	Checks that the free_id is valid.
void	_setBits (unsigned *fifo, unsigned channel, unsigned start, unsigned pattern, unsigned pat_len, unsigned repetitions)
	Places the pat_len LSBs of pattern into channel and in buffer indicated by board.
void	_setSticky (unsigned *fifo, unsigned channel)
	Sets the last bit of channel in fifo.
void	_clrSticky (unsigned *fifo, unsigned channel)
	Clears the last bit of channel in fifo.
void	_setBitsv (unsigned *fifo, unsigned channel, unsigned start, unsigned *pattern, unsigned pat_len, unsigned repetitions)
	Places the pat_len LSBs of pattern into channel and in buffer indicated by board.
int	TPGmsgInit (void)
	Starts a simple printf MSG processor.
unsigned	TPGsetTEMsticky (TPG *this, unsigned tem_id, unsigned trg)
	Sets the last bit of the buffer, which will "stick" on the COMM I/O outputs.
unsigned	TPGclrTEMsticky (TPG *this, unsigned tem_id, unsigned trg)
	Clears the last bit of the buffer, which will "stick" on the COMM I/O outputs.
unsigned	TPGsetVETOsticky (TPG *this, unsigned free_id, unsigned veto_id)
	Sets the last bit of the buffer, which will "stick" on the COMM I/O outputs.
unsigned	TPGclrVETOsticky (TPG *this, unsigned free_id, unsigned veto_id)
	Clears the last bit of the buffer, which will "stick" on the COMM I/O outputs.
unsigned	TPGsetCNOsticky (TPG *this, unsigned free_id)
	Clears the last bit of the buffer, which will "stick" on the COMM I/O outputs.
unsigned	TPGclrCNOsticky (TPG *this, unsigned free_id)
	Clears the last bit of the buffer, which will "stick" on the COMM I/O outputs.
void	TPGcommSetupShow (TPG *this)
void	TPGshow (TPG *this, unsigned detail)
Variables
unsigned	TPG_BUSY = 0
unsigned	TPG_TIAR = 1
unsigned	TPG_CALHI = 2
unsigned	TPG_CALLO = 3
unsigned	TPG_N_TRG = 4
unsigned	TPG_TEM_BOARD = -1
unsigned	TPG_LASTWORD = TPG_BUFFER_DEPTH - sizeof(unsigned)

---

Detailed Description

Trigger Pattern Generator command-line user interface.

Author:

James Swain -- jswain@slac.stanford.edu

---

Function Documentation

unsigned _checkBounds (  unsigned  start, unsigned  pat_len, unsigned  repetitions )

Checks that the requested addition to the buffer does not exceed the boundaries. Parameters: start  Bit that this pattern begins at pat_len  length of pattern repetitions  Number of times to repeat the pattern in the buffer Returns: One of TPG_msgs, TPG_SUCCESS when all is well

unsigned _checkCNO (  unsigned  free_id  )

Checks that the free_id is valid. Parameters: free_id  ID of the FREE board Returns: One of TPG_msgs, TPG_SUCCESS when all is well

unsigned _checkFREE (  unsigned  free_id, unsigned  veto_id )

Checks that the free_id and veto_id are valid. Parameters: free_id  ID of the FREE board veto_id  ID of the VETO line Returns: One of TPG_msgs, TPG_SUCCESS when all is well

unsigned _checkTEM (  unsigned  tem_id, unsigned  trg )

Checks that the tem_id and trg are valid. Parameters: tem_id  ID of the TEM trg  Trg of the TEM Returns: One of TPG_msgs, TPG_SUCCESS when all is well

void _clrSticky (  unsigned *  fifo, unsigned  channel )

Clears the last bit of channel in fifo. Parameters: fifo  Array of unsigned representing the Playback FIFO of one COMM I/O board channel  Channel this pattern is destined for

void _setBits (  unsigned *  fifo, unsigned  channel, unsigned  start, unsigned  pattern, unsigned  pat_len, unsigned  repetitions )

Places the pat_len LSBs of pattern into channel and in buffer indicated by board. Parameters: fifo  Array of unsigned representing the Playback FIFO of one COMM I/O board channel  Channel this pattern is destined for start  Start bit for the pattern, 0 ... (32*1024)-1 pattern  Up to 32 bit pattern to use (LSB first) pat_len  Pattern length 1 ... 32 repetitions  Number of times to repeat the same pattern on this channel, use 0 to request as many reps as will fit in remaining FIFO depth

void _setBitsv (  unsigned *  fifo, unsigned  channel, unsigned  start, unsigned *  pattern, unsigned  pat_len, unsigned  repetitions )

Places the pat_len LSBs of pattern into channel and in buffer indicated by board. Parameters: fifo  Array of unsigned representing the Playback FIFO of one COMM I/O board channel  Channel this pattern is destined for start  Start bit for the pattern, 0 ... (32*1024)-1 pattern  Up to 32 bit pattern to use (LSB first) pat_len  Pattern length 1 ... (32*1024)-1 repetitions  Number of times to repeat the same pattern on this channel, use 0 to request as many reps as will fit in remaining FIFO depth

void _setSticky (  unsigned *  fifo, unsigned  channel )

Sets the last bit of channel in fifo. Parameters: fifo  Array of unsigned representing the Playback FIFO of one COMM I/O board channel  Channel this pattern is destined for

void TPGclear (  TPG *  this  )

Sets all the buffers to 0. Parameters: this  TPG structure to clear

void TPGclearBuf (  TPG *  this, unsigned  bufferId )

Sets the buffer indicated by bufferId to 0. Parameters: this  TPG structure containing buffer to clear bufferId  ID of the buffer to clear

unsigned TPGclrCNOsticky (  TPG *  this, unsigned  free_id )

Clears the last bit of the buffer, which will "stick" on the COMM I/O outputs. Parameters: this  TPG structure being modified free_id  FREE being targeted (gives tgt board), 0 ... 3 Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGclrTEMsticky (  TPG *  this, unsigned  tem_id, unsigned  trg )

Clears the last bit of the buffer, which will "stick" on the COMM I/O outputs. Parameters: this  TPG structure being modified tem_id  TEM being targeted (gives channel range), 0 ... 3 trg  TEM trg being targeted, (gives channel number), 0 ... 3 Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGclrVETOsticky (  TPG *  this, unsigned  free_id, unsigned  veto_id )

Clears the last bit of the buffer, which will "stick" on the COMM I/O outputs. Parameters: this  TPG structure being modified free_id  FREE being targeted (gives tgt board), 0 ... 3 veto_id  VETO bit being targeted, (gives channel number), 0 ... 17 Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGcomPresent (  TPG *  this, unsigned  boardId )

Test for board presence. Parameters: this  TPG struct to use to configure COMM I/O boards boardId  0 ... N_TPG_BOARDS Returns: O if board is not present, 1 if board is present.

unsigned TPGdump (  TPG *  this, unsigned  boardId, unsigned  start, unsigned  len )

Print out the bit patterns in the requested board. Parameters: this  TPG struct to use to configure COMM I/O boards boardId  0 ... N_TPG_BOARDS start  Line of the buffer to start dump len  Number of lines to dump Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

unsigned TPGdumpCNO (  TPG *  this, unsigned  start, unsigned  len )

Print out the bit patterns in the CNO buffer. Parameters: this  TPG struct to use to configure COMM I/O boards start  Line of the buffer to start dump len  Number of lines to dump Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGdumpFREE (  TPG *  this, unsigned  free_id, unsigned  start, unsigned  len )

Print out the bit patterns in the free board. Parameters: this  TPG struct to use to configure COMM I/O boards free_id  FREE ID start  Line of the buffer to start dump len  Number of lines to dump Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGdumpTEM (  TPG *  this, unsigned  start, unsigned  len )

Print out the bit patterns in the TEM buffer. Parameters: this  TPG struct to use to configure COMM I/O boards start  Line of the buffer to start dump len  Number of lines to dump Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGload (  TPG *  this, unsigned char *  clkDelay )

Use Programmed I/O to fill the COMM board FIFOs. Parameters: this  TPG struct to use to configure COMM I/O boards clkDelay  Array of (6 bit) clock delays (TPG_N_BOARDS long) for the COMM I/O boards, to remove clock skew. Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

int TPGmsgInit (  void   )

Starts a simple printf MSG processor. Returns: 0 on success, -1 on failure

TPG* TPGnew (  unsigned *  commAddr  )

Calls calloc to allocate memory for the struct and associated buffers then sets the buffer pointers to the correct offsets. Parameters: commAddr  Array of addresses (TPG_N_BOARDS long) of the COMM I/O boards Returns: Ptr to a new TPG structure containing ptrs to buffers and gnatHandles

Here is the call graph for this function:

unsigned TPGsetCNO (  TPG *  this, unsigned  free_id, unsigned  start, unsigned  pattern, unsigned  pat_len, unsigned  repetitions )

Places the pat_len LSBs of pattern into the channel and buffer indicated by free_id and veto_id. Parameters: this  TPG structure being modified free_id  FREE being targeted (gives tgt board), 0 ... 3 start  Start bit for the pattern, 0 ... (32*1024)-1 pattern  Up to 32 bit pattern to use (LSB first) pat_len  Pattern length 1 ... 32 repetitions  Number of times to repeat the same pattern on this channel, use 0 to request as many reps as will fit in remaining FIFO depth Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGsetCNOsticky (  TPG *  this, unsigned  free_id )

Clears the last bit of the buffer, which will "stick" on the COMM I/O outputs. Parameters: this  TPG structure being modified free_id  FREE being targeted (gives tgt board), 0 ... 3 Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGsetCNOv (  TPG *  this, unsigned  free_id, unsigned  start, unsigned *  pattern, unsigned  pat_len, unsigned  repetitions )

Places the pat_len LSBs of pattern into the channel and buffer indicated by free_id and veto_id. Parameters: this  TPG structure being modified free_id  FREE being targeted (gives tgt board), 0 ... 3 start  Start bit for the pattern, 0 ... (32*1024)-1 pattern  Up to 32 bit pattern to use (LSB first) pat_len  Pattern length 1 ... (32*1024) - 1 repetitions  Number of times to repeat the same pattern on this channel, use 0 to request as many reps as will fit in remaining FIFO depth Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGsetTEM (  TPG *  this, unsigned  tem_id, unsigned  trg, unsigned  start, unsigned  pattern, unsigned  pat_len, unsigned  repetitions )

Places the pat_len LSBs of pattern into the channel and buffer indicated by tem_id and trg. Parameters: this  TPG structure being modified tem_id  TEM being targeted (gives channel range), 0 ... 3 trg  TEM trg being targeted, (gives channel number), 0 ... 3 start  Start bit for the pattern, 0 ... (32*1024)-1 pattern  Up to 32 bit pattern to use (LSB first) pat_len  Pattern length 1 ... 32 repetitions  Number of times to repeat the same pattern on this channel, use 0 to request as many reps as will fit in remaining FIFO depth Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGsetTEMsticky (  TPG *  this, unsigned  tem_id, unsigned  trg )

Sets the last bit of the buffer, which will "stick" on the COMM I/O outputs. Parameters: this  TPG structure being modified tem_id  TEM being targeted (gives channel range), 0 ... 3 trg  TEM trg being targeted, (gives channel number), 0 ... 3 Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGsetTEMv (  TPG *  this, unsigned  tem_id, unsigned  trg, unsigned  start, unsigned *  pattern, unsigned  pat_len, unsigned  repetitions )

Places the pat_len LSBs of pattern into the channel and buffer indicated by tem_id and trg. Parameters: this  TPG structure being modified tem_id  TEM being targeted (gives channel range), 0 ... 3 trg  TEM trg being targeted, (gives channel number), 0 ... 3 start  Start bit for the pattern, 0 ... (32*1024)-1 pattern  Up to 32 bit pattern to use (LSB first) pat_len  Pattern length 1 ... (32*1024) - 1 repetitions  Number of times to repeat the same pattern on this channel, use 0 to request as many reps as will fit in remaining FIFO depth Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGsetVETO (  TPG *  this, unsigned  free_id, unsigned  veto_id, unsigned  start, unsigned  pattern, unsigned  pat_len, unsigned  repetitions )

Places the pat_len LSBs of pattern into the channel and buffer indicated by free_id and veto_id. Parameters: this  TPG structure being modified free_id  FREE being targeted (gives tgt board), 0 ... 3 veto_id  VETO bit being targeted, (gives channel number), 0 ... 17 start  Start bit for the pattern, 0 ... (32*1024)-1 pattern  Up to 32 bit pattern to use (LSB first) pat_len  Pattern length 1 ... 32 repetitions  Number of times to repeat the same pattern on this channel, use 0 to request as many reps as will fit in remaining FIFO depth Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGsetVETOsticky (  TPG *  this, unsigned  free_id, unsigned  veto_id )

Sets the last bit of the buffer, which will "stick" on the COMM I/O outputs. Parameters: this  TPG structure being modified free_id  FREE being targeted (gives tgt board), 0 ... 3 veto_id  VETO bit being targeted, (gives channel number), 0 ... 17 Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGsetVETOv (  TPG *  this, unsigned  free_id, unsigned  veto_id, unsigned  start, unsigned *  pattern, unsigned  pat_len, unsigned  repetitions )

Places the pat_len LSBs of pattern into the channel and buffer indicated by free_id and veto_id. Parameters: this  TPG structure being modified free_id  FREE being targeted (gives tgt board), 0 ... 3 veto_id  VETO bit being targeted, (gives channel number), 0 ... 17 start  Start bit for the pattern, 0 ... (32*1024)-1 pattern  Up to 32 bit pattern to use (LSB first) pat_len  Pattern length 1 ... (32*1024) - 1 repetitions  Number of times to repeat the same pattern on this channel, use 0 to request as many reps as will fit in remaining FIFO depth Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

unsigned TPGstart (  TPG *  this  )

Start the playback. Parameters: this  TPG struct to use to configure COMM I/O boards Returns: One of TPG_msgs, TPG_SUCCESS if all goes well.

Here is the call graph for this function:

---

Variable Documentation

unsigned TPG_BUSY = 0

Channel number for the TEM BUSY signal

unsigned TPG_CALHI = 2

Channel number for the TEM CAL HE signal

unsigned TPG_CALLO = 3

Channel number for the TEM CAL LE signal

unsigned TPG_LASTWORD = TPG_BUFFER_DEPTH - sizeof(unsigned)

first bit of last word of a pattern

unsigned TPG_N_TRG = 4

Total number of TEM triggers

unsigned TPG_TIAR = 1

Channel number for the TEM Three-in-a-row signal

---