Doxygen Documentation

Main Index

Package Index

Package:

GDAB

Version:

dev

Marked:

(not marked)

Constituent:

gdab

Tag:

mv2304


Interface   Compound List   File List   Compound Members   File Members  

gPDUC.h File Reference

command/response methods for the PDU Controller register block More...

#include "GDAB/gdab.h"

Functions

int gPDUCcmd (gdabHandle gdab, unsigned short pduAddr, unsigned short opcode)
 Sends a dataless command to the PDU.

int gPDUCload (gdabHandle gdab, unsigned short pduAddr, unsigned short regId, unsigned int value)
 Loads a register with value.

int gPDUCread (gdabHandle gdab, unsigned short pduAddr, unsigned short regId, unsigned int *value)
 Reads a register returing value in val.


Detailed Description

command/response methods for the PDU Controller register block

Author:
James Swain - jswain@slac.stanford.edu

Function Documentation

int gPDUCcmd gdabHandle  gdab,
unsigned short  pduAddr,
unsigned short  opcode
 

Sends a dataless command to the PDU.

Parameters:
gdab gdabHandle containing the COM I/O (gnat) handle
pduAddr PDU address of command
opcode opcode of command to send
Returns:
G_OK on success
Sends the dataless command specified by opcode to the PDU address specified by pduAddr.

int gPDUCload gdabHandle  gdab,
unsigned short  pduAddr,
unsigned short  reg,
unsigned int  value
 

Loads a register with value.

Parameters:
gdab gdabHandle containing the COM I/O (gnat) handle
pduAddr PDU address of command
reg register to load
value 32-bit value to load
Returns:
G_OK on success
Loads the PDU Control register specified by reg with value

int gPDUCread gdabHandle  gdab,
unsigned short  pduAddr,
unsigned short  reg,
unsigned int *  val
 

Reads a register returing value in val.

Parameters:
gdab gdabHandle containing the COM I/O (gant) handle.
pduAddr PDU address of command
reg register to read
val pointer t storage to hold the response of the read command
Returns:
G_OK on success
Reads the PDU Control register specified by reg. val is filled on return.

The following error codes are returned when LATp errors occur:

  • GERR_LATP_HEADER_PARITY
  • GERR_LATP_CELL_PARITY
  • GERR_LATP_TRUNCATE


Generated on Wed Nov 19 14:55:04 2003 by doxygen 1.3.3