GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> PIG / V10-1-3 > pig_flying / sun-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » ICS » source » PIG » V10-1-3 » src

pig_p.h File Reference

Private definitions for the PIG (Power and the Initialisation of the GASU) routines. More...

#include "PIG/state.h"
#include "LEM/list.h"

Functions

void getCruState (PIG_cruState *state)
 Get the saved copy of the contents of the CRU registers.
void getDbState (PIG_dbState *state)
 Get the saved copy of the contents of the database registers.
void getEbmState (PIG_ebmState *state)
 Get the saved copy of the contents of the EBM registers.
void getPduState (PIG_pduState *state)
 Get the saved copy of the contents of the PDU registers.
void getPwrState (PIG_pwrState *state)
 Get the saved copy of the contents of the power registers.
void getState (PIG_state *state)
 Get a copy of the state of all PIG registers.
unsigned initCrList (void *lists, unsigned int len, LEM_micr *cr)
 Initialize a multi-item command/response list.
unsigned readCruState (LEM_micr *cr, PIG_cruState *state)
 Take a snapshot of the state of the CRU.
unsigned readDbState (LEM_micr *cr, PIG_dbState *state)
 Take a snapshot of the current contents of the registers controlled by PIG_DB.
unsigned readEbmState (LEM_micr *cr, PIG_ebmState *state)
 Take a snapshot of the state of the EBM.
unsigned readPduState (LEM_micr *cr, PIG_pduState *state, const PIG_cruState *cru)
 Take a snapshot of the state of the PDU(s).
unsigned readPwrState (LEM_micr *cr, int all, PIG_pwrState *state)
 Take a snapshot of the current contents of the power registers.
unsigned readState (LEM_micr *cr, int all, PIG_state *state)
 Take a snapshot of the state of all PIG registers.
void saveCruState (const PIG_cruState *state)
 Save a copy of the contents of the CRU registers.
void saveDbState (const PIG_dbState *state)
 Save a copy of the contents of the database registers.
void saveEbmState (const PIG_ebmState *state)
 Save a copy of the contents of the EBM registers.
void savePduState (const PIG_pduState *state)
 Save a copy of the contents of the PDU registers.
void savePwrState (const PIG_pwrState *state)
 Save a copy of the contents of the power registers.
void saveState (const PIG_state *state)
 Save a copy of the state of all PIG registers.

Detailed Description

Private definitions for the PIG (Power and the Initialisation of the GASU) routines.

Author:
James Swain & Owen Saxton
$Id: pig_p.h,v 1.18 2009/07/31 21:32:23 saxton Exp $

Function Documentation

void getCruState ( PIG_cruState *  state  ) 

Get the saved copy of the contents of the CRU registers.

Parameters:
state Pointer to a structure to receive the state of the CRU registers

void getDbState ( PIG_dbState *  state  ) 

Get the saved copy of the contents of the database registers.

Parameters:
state Pointer to a structure to receive the state of the database registers

void getEbmState ( PIG_ebmState *  state  ) 

Get the saved copy of the contents of the EBM registers.

Parameters:
state Pointer to a structure to receive the state of the EBM registers

void getPduState ( PIG_pduState *  state  ) 

Get the saved copy of the contents of the PDU registers.

Parameters:
state Pointer to a structure to receive the state of the PDU registers

void getPwrState ( PIG_pwrState *  state  ) 

Get the saved copy of the contents of the power registers.

Parameters:
state Pointer to a structure to receive the state of the power registers

void getState ( PIG_state *  state  ) 

Get a copy of the state of all PIG registers.

Parameters:
state Pointer to a structure to receive the state of the PIG registers

unsigned initCrList ( void *  lists,
unsigned int  len,
LEM_micr *  crl 
)

Initialize a multi-item command/response list.

This routine optimally assigns portions of a supplied region to the various components of a LEM-style multi-item command/response list, and initializes the supplied list anchor block.

Because of RAD750 hardware restrictions, the assigned command list, rounded down to a cache line boundary (32-byte aligned) then extended by six cache lines (192 bytes), must not be accessed by the CPU while the operation is in progress. The result list, on the other hand, cannot have simultaneous CPU acces of the first six cache lines beyond the beginning of the list proper. These restrictions mean that the effective length of these lists is increased when determining whether they fit within the supplied region, but impose no extra restrictions on the relative arrangement of the three lists within the region.

Parameters:
lists The address of the region to be used.
len The length of the region to be used.
crl The address of the list's anchor block to be filled.
Return values:
PIG_INMUD Success
PIG_CRLSMALL Region too small for a MICR list

CDR

CRD

DCR

DRC

RCD

RDC

unsigned readCruState ( LEM_micr *  cr,
PIG_cruState *  state 
)

Take a snapshot of the state of the CRU.

Parameters:
cr Pointer to a multi-item command and response list
state Pointer to a structure to receive the state of the CRU registers

unsigned readDbState ( LEM_micr *  cr,
PIG_dbState *  state 
)

Take a snapshot of the current contents of the registers controlled by PIG_DB.

Parameters:
cr Pointer to a multi-item command and response list
state Pointer to a structure to receive the state of the PIG_DB controlled registers

unsigned readEbmState ( LEM_micr *  cr,
PIG_ebmState *  state 
)

Take a snapshot of the state of the EBM.

Parameters:
cr Pointer to a multi-item command and response list
state Pointer to a structure to receive the state of the EBM registers

unsigned readPduState ( LEM_micr *  cr,
PIG_pduState *  state,
const PIG_cruState *  cru 
)

Take a snapshot of the state of the PDU(s).

Parameters:
cr Pointer to a multi-item command and response list
state Pointer to a structure to receive the state of the PDU registers
cru Pointer to a structure holding the state of the CRU registers

unsigned readPwrState ( LEM_micr *  cr,
int  all,
PIG_pwrState *  state 
)

Take a snapshot of the current contents of the power registers.

Parameters:
cr Pointer to a multi-item command and response list
all If TRUE, read all the registers. Otherwise omit the reading of some sensitive registers.
state Pointer to a structure to receive the state of the power registers

unsigned readState ( LEM_micr *  cr,
int  all,
PIG_state *  state 
)

Take a snapshot of the state of all PIG registers.

Parameters:
cr Pointer to a multi-item command and response list
all If TRUE, read all the registers. Otherwise omit the reading of some sensitive registers.
state Pointer to a structure to receive the state of the PIG registers

void saveCruState ( const PIG_cruState *  state  ) 

Save a copy of the contents of the CRU registers.

Parameters:
state Pointer to a structure containing the state of the CRU registers

void saveDbState ( const PIG_dbState *  state  ) 

Save a copy of the contents of the database registers.

Parameters:
state Pointer to a structure containing the state of the database registers

void saveEbmState ( const PIG_ebmState *  state  ) 

Save a copy of the contents of the EBM registers.

Parameters:
state Pointer to a structure containing the state of the EBM registers

void savePduState ( const PIG_pduState *  state  ) 

Save a copy of the contents of the PDU registers.

Parameters:
state Pointer to a structure containing the state of the PDU registers

void savePwrState ( const PIG_pwrState *  state  ) 

Save a copy of the contents of the power registers.

Parameters:
state Pointer to a structure containing the state of the power registers

void saveState ( const PIG_state *  state  ) 

Save a copy of the state of all PIG registers.

Parameters:
state Pointer to a structure to receive the state of the PIG registers

Generated on Fri Jul 31 14:50:11 2009 by  doxygen 1.5.3