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

---

         

---

gCAL.c File Reference

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

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

Functions
void	setAccDescCAL (gtemHandle gt, unsigned short gcrcAddr, unsigned short gcfeTarget, unsigned short gcfeAddr, unsigned short func, unsigned short reg, accDescCAL *ad)
	initializes an access descriptor for either a GCRC or GCFE
void	packPayloadCAL (gtemHandle gt, unsigned int calCmdHeader, unsigned int calAD, unsigned int value, unsigned int *payload)
	Packs the calCmdHeader, calAD and value into the 64-bit payload.
int	_CALcmd (gtemHandle gt, unsigned short temAddr, unsigned short gcccAddr, unsigned short gcrcAddr, unsigned short ext, unsigned short gcfeAddr, unsigned short func, unsigned short opcode)
	Sends a dataless command to the destination.
int	_CALload (gtemHandle gt, unsigned short temAddr, unsigned short gcccAddr, unsigned short gcrcAddr, unsigned short ext, unsigned short gcfeAddr, unsigned short func, unsigned short reg, unsigned short value)
	Loads a register with value.
int	_CALread (gtemHandle gt, unsigned short temAddr, unsigned short gcccAddr, unsigned short gcrcAddr, unsigned short ext, unsigned short gcfeAddr, unsigned short func, unsigned short reg, unsigned short *val)
	Reads a register returing value in val.

---

Detailed Description

Implements command/response for the off board calorimeter subsystem.

Author:

Curt Brune -- curt@slac.stanford.edu

---

Function Documentation

int _CALcmd (  gtemHandle  gt, unsigned short  temAddr, unsigned short  gcccAddr, unsigned short  gcrcAddr, unsigned short  ext, unsigned short  gcfeAddr, unsigned short  func, unsigned short  opcode )

Sends a dataless command to the destination. Parameters: gt  gtemHandle for TEM temAddr  TEM address gcccAddr  GCCC address gcrcAddr  GCRC address ext  set for GCFE access gcfeAddr  GCFE address func  function code to send opcode  opcode of command to send Returns: G_OK on success

int _CALload (  gtemHandle  gt, unsigned short  temAddr, unsigned short  gcccAddr, unsigned short  gcrcAddr, unsigned short  ext, unsigned short  gcfeAddr, unsigned short  func, unsigned short  reg, unsigned short  value )

Loads a register with value. Parameters: gt  gtemHandle for TEM temAddr  TEM address gcccAddr  GCCC address gcrcAddr  GCRC address ext  set for GCFE access gcfeAddr  GCFE address func  function code to send reg  register of GCRC to load value  16-bit value to load into CAL register Returns: G_OK on success Loads the GCRC/GCFE register specified by gcrcAddr, gcfeAddr, reg with value.

int _CALread (  gtemHandle  gt, unsigned short  temAddr, unsigned short  gcccAddr, unsigned short  gcrcAddr, unsigned short  ext, unsigned short  gcfeAddr, unsigned short  func, unsigned short  reg, unsigned short *  val )

Reads a register returing value in val. Parameters: gt  gtemHandle for TEM temAddr  temAddrination of command gcccAddr  GCCC address gcrcAddr  GCRC address ext  set for GCFE access gcfeAddr  GCFE address func  function code to send reg  register of GCRC to read val  pointer to storage to hold the response of the read command Returns: G_OK on success Reads the GCRC/GCFE register specified by gcrcAddr, gcfeAddr, reg. The following error codes are returned: GERR_LATP_HEADER_PARITY GERR_LATP_CELL_PARITY GERR_LATP_TRUNCATE GCAL_ERR_SUMMARY GCAL_ERR_PARITY

void packPayloadCAL (  gtemHandle  gt, unsigned int  calCmdHeader, unsigned int  calAD, unsigned int  value, unsigned int *  payload )

Packs the calCmdHeader, calAD and value into the 64-bit payload. Parameters: gt  gtemHandle for TEM calCmdHeader  32-bit CAL command header word calAD  32-bit CAL access descriptor word value  32-bit value to load into CAL register payload  pointer to 64-bits of pre-allocated storage Returns: void Packs the bits of calCmdHeader, calAD and value into the 64-bits pointed to by payload. The packing is specific to "off board" registers for the GCRC and GCFE.

static void setAccDescCAL (  gtemHandle  gt, unsigned short  gcrcAddr, unsigned short  ext, unsigned short  gcfeAddr, unsigned short  func, unsigned short  reg, accDescCAL *  ad )  [static]

initializes an access descriptor for either a GCRC or GCFE Parameters: gt  gtemHandle for TEM ad  pointer to CAL access descriptor ext  set for GCFE commands gcrcAddr  GCRC address gcfeAddr  GCFE address func  CAL fucntion code reg  register of CAL object Returns: G_OK on void Sets a calorimeter access descriptor, destined for either GCRC or GCFE.

---