Doxygen Documentation
	Main Index	Package Index
	Package:	GAEM
	Version:	V2-1-2	Marked:	(not marked)
	Constituent:	vaem	Tag:	linux-gcc

---

         

---

gAEM.h File Reference

defines the command and response methods for the AEM More...

Functions
int	gAEMcmd (gaemHandle ga, unsigned short opcode)
	Sends a dataless command to the AEM.
int	gAEMload (gaemHandle ga, unsigned short regId, unsigned int val)
	Loads a register with value.
int	gAEMread (gaemHandle ga, unsigned short regId, unsigned int *val)
	Reads a register returing value in val.
int	gAEMlam (gaemHandle ga)
	Sends the "Look At Me" message to the AEM.
int	setCmdStrParityAEM (gaemHandle ga, unsigned short p)
	p determines if the AEM command string parity is inverted
int	getCmdStrParityAEM (gaemHandle ga, unsigned short *p)
	Returns current AEM command string parity.
int	setAccessDescParityAEM (gaemHandle ga, unsigned short p)
	Sets the current AEM access descriptor parity.
int	getAccessDescParityAEM (gaemHandle ga, unsigned short *p)
	Returns current AEM access descriptor parity.
int	setCmdPayloadParityAEM (gaemHandle ga, unsigned short p)
	p determines if the AEM command payload parity is inverted
int	getCmdPayloadParityAEM (gaemHandle ga, unsigned short *p)
	Returns the current AEM command payload parity.
int	gAEM_SetAddr (gaemHandle ga, unsigned short addr)
	Sets system wide AEM LATp address.
int	gAEM_GetAddr (gaemHandle ga, unsigned short *addr)
	Gets system wide AEM LATp address.

---

Detailed Description

defines the command and response methods for the AEM

Author:

Curt Brune -- curt@slac.stanford.edu

---

Function Documentation

int gAEM_GetAddr (  gaemHandle  ga, unsigned short *  aemAddr )

Gets system wide AEM LATp address. Parameters: ga  gaemHandle for AEM aemAddr  pointer to hold AEM address Returns: G_OK on success See also: gAEM_SetAddr() Gets the system-wide AEM LATp address.

int gAEM_SetAddr (  gaemHandle  ga, unsigned short  aemAddr )

Sets system wide AEM LATp address. Parameters: ga  gaemHandle for AEM aemAddr  AEM address Returns: G_OK on success Sets the system-wide AEM LATp address. This function is intended to be called once during system initialization. It might also be useful during testing.

int gAEMcmd (  gaemHandle  ga, unsigned short  opcode )

Sends a dataless command to the AEM. Parameters: ga  gaemHandle for AEM opcode  opcode of command to send Returns: G_OK on success Sends the dataless command specified by opcode to the AEM.

int gAEMlam (  gaemHandle  ga  )

Sends the "Look At Me" message to the AEM. Parameters: ga  gaemHandle for AEM Returns: G_OK on success Sends the "Look At Me" message to the AEM. This is used to switch the command/response wire used by the AEM. If the AEM 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 gAEMload (  gaemHandle  ga, unsigned short  reg, unsigned int  value )

Loads a register with value. Parameters: ga  gaemHandle for AEM reg  register of AEM to load value  32-bit value to load into AEM register Returns: G_OK on success Loads the AEM register specified by reg with value

int gAEMread (  gaemHandle  ga, unsigned short  reg, unsigned int *  val )

Reads a register returing value in val. Parameters: ga  gaemHandle for AEM reg  register of AEM to read val  pointer to storage to hold the response of the read command Returns: G_OK on success Reads the AEM register specified by reg. val is filled on return.

int getAccessDescParityAEM (  gaemHandle  ga, unsigned short *  p )

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

int getCmdPayloadParityAEM (  gaemHandle  ga, unsigned short *  p )

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

int getCmdStrParityAEM (  gaemHandle  ga, unsigned short *  p )

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

int setAccessDescParityAEM (  gaemHandle  ga, unsigned short  p )

Sets the current AEM access descriptor parity. Parameters: ga  gaemHandle for AEM p  boolean value Returns: STATUS if p is non-zero then all out going AEM commands will have their access descriptor parity inverted. This is used for testing parity errors. The default value is 0.

int setCmdPayloadParityAEM (  gaemHandle  ga, unsigned short  p )

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

int setCmdStrParityAEM (  gaemHandle  ga, unsigned short  p )

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

---