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

---

         

---

gTEM.h File Reference

Defines the command and response methods for the TEM. More...

Functions
int	gTEMcmd (gtemHandle gt, unsigned short temAddr, unsigned short opcode)
	Sends a dataless command to the TEM address.
int	gTEMload (gtemHandle gt, unsigned short temAddr, unsigned short regId, unsigned int val)
	Loads a register with value.
int	gTEMread (gtemHandle gt, unsigned short temAddr, unsigned short regId, unsigned int *val)
	Reads a register returing value in val.
int	gTEMlam (gtemHandle gt, unsigned short temAddr)
	Sends the "Look At Me" message to the TEM.
int	setCellHeaderParity (gtemHandle gt, unsigned short p)
	p determines if the LATp CellHeader Parity is inverted
int	getCellHeaderParity (gtemHandle gt, unsigned short *p)
	Returns the current LATp cell header parity setting in p.
int	setCellBodyParity (gtemHandle gt, unsigned short p)
	p determines if the LATp Cell Body Parity is inverted
int	getCellBodyParity (gtemHandle gt, unsigned short *p)
	Returns the current LATp cell body parity setting in p.
int	setCmdStrParityTEM (gtemHandle gt, unsigned short p)
	p determines if the TEM command string parity is inverted
int	getCmdStrParityTEM (gtemHandle gt, unsigned short *p)
	Returns the current TEM command string parity.
int	setAccessDescParityTEM (gtemHandle gt, unsigned short p)
	p determines if the TEM access descriptor parity is inverted
int	getAccessDescParityTEM (gtemHandle gt, unsigned short *p)
	Returns the current TEM access descriptor parity.
int	setCmdPayloadParityTEM (gtemHandle gt, unsigned short p)
	p determines if the TEM command payload parity is inverted
int	getCmdPayloadParityTEM (gtemHandle gt, unsigned short *p)
	Returns current TEM command payload parity.

---

Detailed Description

Defines the command and response methods for the TEM.

Author:

Curt Brune -- curt@slac.stanford.edu

---

Function Documentation

int getAccessDescParityTEM (  gtemHandle  gt, unsigned short *  p )

Returns the current TEM access descriptor parity. Parameters: gt  gtemHandle for TEM p  pointer to hold boolean value Returns: STATUS if p is non-zero then all out going TEM commands will have their access descriptor parity inverted. This is used for testing parity errors. The default value is 0.

int getCellBodyParity (  gtemHandle  gt, unsigned short *  p )

Returns the current LATp cell body parity setting in p. Parameters: gt  gtemHandle for TEM p  pointer to hold boolean value Returns: STATUS If p is non-zero then all out going LATp packets will have their cell body parity inverted. This is used for testing parity errors. The default value is 0.

int getCellHeaderParity (  gtemHandle  gt, unsigned short *  p )

Returns the current LATp cell header parity setting in p. Parameters: gt  gtemHandle for TEM p  pointer to hold boolean value Returns: STATUS If p is non-zero then all out going LATp packets will have their cell header parity inverted. This is used for testing parity errors. The default value is 0.

int getCmdPayloadParityTEM (  gtemHandle  gt, unsigned short *  p )

Returns current TEM command payload parity. Parameters: gt  gtemHandle for TEM p  pointer to hold boolean value Returns: STATUS if p is non-zero then all out going TEM commands will have their command payload parity inverted. This is used for testing parity errors. The default value is 0.

int getCmdStrParityTEM (  gtemHandle  gt, unsigned short *  p )

Returns the current TEM command string parity. Parameters: gt  gtemHandle for TEM p  pointer to hold boolean value Returns: STATUS if p is non-zero then all out going TEM commands will have their command string parity inverted. This is used for testing parity errors. The default value is 0.

int gTEMcmd (  gtemHandle  gt, unsigned short  temAddr, unsigned short  opcode )

Sends a dataless command to the TEM address. Parameters: gt  gtemHandle for TEM temAddr  TEM address of command opcode  opcode of command to send Returns: G_OK on success Sends the dataless command specified by opcode to the TEM address specified by temAddr.

int gTEMlam (  gtemHandle  gt, unsigned short  temAddr )

Sends the "Look At Me" message to the TEM. Parameters: gt  gtemHandle for TEM temAddr  TEM address of command Returns: G_OK on success Sends the "Look At Me" message to the TEM. This is used to switch the command/response wire used by the TEM. If the TEM decodes the "Look At Me" message on either it's A or B command channel it will switch to that channel for future commanding.

int gTEMload (  gtemHandle  gt, unsigned short  temAddr, unsigned short  reg, unsigned int  value )

Loads a register with value. Parameters: gt  gtemHandle for TEM temAddr  TEM address of command reg  register of TEM to load value  32-bit value to load into TEM register Returns: G_OK on success Loads the TEM register specified by reg with value

int gTEMread (  gtemHandle  gt, unsigned short  temAddr, unsigned short  reg, unsigned int *  val )

Reads a register returing value in val. Parameters: gt  gtemHandle for TEM temAddr  TEM address of command reg  register of TEM to read val  pointer to storage to hold the response of the read command Returns: G_OK on success Reads the TEM register specified by reg. val is filled on return.

int setAccessDescParityTEM (  gtemHandle  gt, unsigned short  p )

p determines if the TEM access descriptor parity is inverted Parameters: gt  gtemHandle for TEM p  boolean value Returns: G_OK if p is non-zero then all out going TEM commands will have their access descriptor parity inverted. This is used for testing parity errors. The default value is 0.

int setCellBodyParity (  gtemHandle  gt, unsigned short  p )

p determines if the LATp Cell Body Parity is inverted Parameters: gt  gtemHandle for TEM p  boolean value Returns: STATUS If p is non-zero then all out going LATp packets will have their cell body parity inverted. This is used for testing parity errors. The default value is 0.

int setCellHeaderParity (  gtemHandle  gt, unsigned short  p )

p determines if the LATp CellHeader Parity is inverted Parameters: gt  gtemHandle for TEM p  boolean value Returns: STATUS If p is non-zero then all out going LATp packets will have their cell header parity inverted. This is used for testing parity errors. The default value is 0.

int setCmdPayloadParityTEM (  gtemHandle  gt, unsigned short  p )

p determines if the TEM command payload parity is inverted Parameters: gt  gtemHandle for TEM p  boolean value Returns: G_OK if p is non-zero then all out going TEM commands will have their command payload parity inverted. This is used for testing parity errors. The default value is 0.

int setCmdStrParityTEM (  gtemHandle  gt, unsigned short  p )

p determines if the TEM command string parity is inverted Parameters: gt  gtemHandle for TEM p  boolean value Returns: G_OK if p is non-zero then all out going TEM commands will have their command string parity inverted. This is used for testing parity errors. The default value is 0.

---