Doxygen Documentation
	Main Index	Package Index
	Package:	GTEM
	Version:	V1-3-4	Marked:	(not marked)
	Constituent:	gtem	Tag:	sun-gcc

---

         

---

gTKR.c File Reference

Implements command/response for the off board tracker subsystem. More...

#include <string.h>
#include "gt_p.h"
#include "gTKR_p.h"

Functions
void	setAccDescTKR (gtemHandle gt, unsigned short gtrcAddr, unsigned short gtfeTarget, unsigned short gtfeAddr, unsigned short func, unsigned short reg, accDescTKR *ad)
	initializes an access descriptor for either a GTRC or GTFE
void	packPayloadTKR (gtemHandle gt, unsigned int tkrCmdHeader, unsigned int tkrAD, unsigned long long value, unsigned int *payload)
	Packs the tkrCmdHeader, tkrAD and value into the 64-bit payload.
int	tkrSendCmd (gtemHandle gt, unsigned short temAddr, unsigned short gtccAddr, unsigned short gtrcAddr, unsigned short ext, unsigned short gtfeAddr, unsigned short func, unsigned short reg, unsigned long long value, gResponse *rsp)
	Loads a register with value.
int	_TKRread (gtemHandle gt, unsigned short temAddr, unsigned short gtccAddr, unsigned short gtrcAddr, unsigned short ext, unsigned short gtfeAddr, unsigned short reg, unsigned long long *val)
	Reads a register returing value in val.
int	gGTRC_readEvt (gtemHandle gt, unsigned short temAddr, unsigned short gtccAddr, unsigned short gtrcAddr, unsigned short tag)
	Sends a read event command to the destination GTFE.

---

Detailed Description

Implements command/response for the off board tracker subsystem.

Author:

Curt Brune -- curt@slac.stanford.edu

---

Function Documentation

int _TKRread (  gtemHandle  gt, unsigned short  temAddr, unsigned short  gtccAddr, unsigned short  gtrcAddr, unsigned short  ext, unsigned short  gtfeAddr, unsigned short  reg, unsigned long long *  val )

Reads a register returing value in val. Parameters: gt  gtemHandle for TEM temAddr  temAddrination of command gtccAddr  GTCC address gtrcAddr  GTRC address ext  set for GTFE access gtfeAddr  GTFE address reg  register of GTRC to read val  pointer to storage to hold the response of the read command Returns: G_OK on success Reads the GTRC/GTFE register specified by gtrcAddr, gtfeAddr, reg. The following error codes are returned: GERR_LATP_HEADER_PARITY GERR_LATP_CELL_PARITY GERR_LATP_TRUNCATE GTKR_ERR_SUMMARY GTKR_ERR_PARITY

int gGTRC_readEvt (  gtemHandle  gt, unsigned short  temAddr, unsigned short  gtccAddr, unsigned short  gtrcAddr, unsigned short  tag )

Sends a read event command to the destination GTFE. Parameters: gt  gtemHandle for TEM temAddr  TEM address gtccAddr  GTCC address gtrcAddr  GTRC address tag  2-bit tag for read event command Returns: G_OK on success Most often the FE address will be the broadcast address

void packPayloadTKR (  gtemHandle  gt, unsigned int  tkrCmdHeader, unsigned int  tkrAD, unsigned long long  value, unsigned int *  payload )

Packs the tkrCmdHeader, tkrAD and value into the 64-bit payload. Parameters: gt  gtemHandle for TEM tkrCmdHeader  9-bit TKR command header word tkrAD  17-bit TKR access descriptor word value  64-bit value to load into TKR register payload  pointer to 64-bits of pre-allocated storage Returns: void Packs the bits of tkrCmdHeader, tkrAD and value into the 96-bits pointed to by payload. The packing is specific to "off board" registers for the GTRC and GTFE. Format of 64-bit payload: [1][ bits 63-48 ][1][ bits 47-32 ][1][ bits 31-16 ][1][ bits 15-0][P] Four 16 bit sections, each preceded by marker bit -- parity at end. word 0: [ 9 bits tkrCmdHeader ][ 17 bits tkrAD ][ 6 bits payload] word 1: [ 32 bits payload ] word 2: [ 30 bits payload [P][0]

static void setAccDescTKR (  gtemHandle  gt, unsigned short  gtrcAddr, unsigned short  ext, unsigned short  gtfeAddr, unsigned short  func, unsigned short  reg, accDescTKR *  ad )  [static]

initializes an access descriptor for either a GTRC or GTFE Parameters: gt  gtemHandle for TEM ad  pointer to TKR access descriptor ext  set for GTFE commands gtrcAddr  GTRC address gtfeAddr  GTFE address func  TKR fucntion code reg  register of TKR object Returns: G_OK on void Sets a tracker access descriptor, destined for either GTRC or GTFE.

int tkrSendCmd (  gtemHandle  gt, unsigned short  temAddr, unsigned short  gtccAddr, unsigned short  gtrcAddr, unsigned short  ext, unsigned short  gtfeAddr, unsigned short  func, unsigned short  reg, unsigned long long  value, gResponse *  rsp )

Loads a register with value. Parameters: gt  gtemHandle for TEM temAddr  TEM address gtccAddr  GTCC address gtrcAddr  GTRC address ext  set for GTFE access gtfeAddr  GTFE address func  function code to send reg  register of GTRC to load value  16-bit value to load into TKR register rsp  pointer to storage for response Returns: G_OK on success Sends load/read/dataless GTRC and GTFE commands

---