GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > PIG / V10-0-1

Constituent: pig_flying     Tag: linux-gcc

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

pig.h File Reference

Interface to Power and the Initialisation of the GASU routines. More...

#include "PIG/structs.h"
#include "ITC/ITC_pubdefs.h"

Include dependency graph for pig.h:

This graph shows which files directly or indirectly include this file:


Functions

unsigned PIG_siu_init (PIG_siu_cfg cfg)
 Configure the SIU in response to the MAIN_FEED_ON notification.
unsigned PIG_insert (PIG_cfg *cfg)
 Insert one or more nodes into the C/R fabric, possibly powering on said node on at the same time.
unsigned PIG_extract (PIG_cfg *cfg)
 Extract one or more nodes from the C/R fabric, possibly powering off said node at the same time.
unsigned PIG_insert_evt (PIG_evt_cfg *cfg)
 Insert one or more nodes into the event fabric.
unsigned PIG_extract_evt (PIG_evt_cfg *cfg)
 Extract one or more nodes from the event fabric.
unsigned PIG_enter_SAA (void)
 Write registers to place the LAT into SAA mode.
unsigned PIG_exit_SAA (void)
 Write registers to pull the LAT out of SAA mode.
unsigned PIG_shed (void)
 Shed the LAT power load.
unsigned PIG_safe (void)
 Powers off all the LAT components.
unsigned PIG_get_pdus (void)
 Get PDUs present.
void PIG_set_epu_delay (unsigned delay)
 Set the delay after EPU power on.
void PIG_set_on_delay (unsigned delay)
 Set the delay after power-on of a component.
void PIG_set_off_delay (unsigned delay)
 Set the delay after power-off of a component.
unsigned PIG_order_EPU (unsigned order[N_EPU])
 Change the power-on order of the EPUs from the default to order.
unsigned PIG_order_TEM (unsigned order[N_TEM])
 Change the power-on order of the TEMs from the default to order.
unsigned PIG_order_FREE (unsigned order[N_FREE])
 Change the power-on order of the FREE boards from the default to order.
unsigned PIG_bias_ACD (PIG_acd_bias *bias)
 Load the ACD bias DAC registers.
unsigned PIG_bias_CAL (PIG_cal_bias *bias)
 Load the CAL bias DAC registers.
unsigned PIG_bias_TKR (PIG_tkr_bias *bias)
 Load the TKR bias DAC registers.
size_t PIG_sizeofRecord (void)
 Get the size of a PIG datagram.
unsigned PIG_record (void *buf, ITC_cb_Completion *rtn, void *prm0, void *prm1, void *prm2)
 Record the PIG registers to the SSR.
unsigned PIG_get_ebmState (unsigned int *inputs, unsigned int *contributors, unsigned int *destinations)
 Return the EBM configuration masks.

Detailed Description

Interface to Power and the Initialisation of the GASU routines.

Author:
James Swain & Owen Saxton
Id
pig.h,v 1.31 2007/09/20 20:06:23 saxton Exp

Function Documentation

unsigned PIG_bias_ACD (  PIG_acd_bias *  bias  ) 
 

Load the ACD bias DAC registers.

Parameters:
bias Pointer to structure containing the bias voltage values
Return values:
PIG_INMUD Success
LEM error Error in the command list

unsigned PIG_bias_CAL (  PIG_cal_bias *  bias  ) 
 

Load the CAL bias DAC registers.

Parameters:
bias Pointer to structure containing the bias voltage values
Return values:
PIG_INMUD Success
LEM error Error in the command list

unsigned PIG_bias_TKR (  PIG_tkr_bias *  bias  ) 
 

Load the TKR bias DAC registers.

Parameters:
bias Pointer to structure containing the bias voltage values
Return values:
PIG_INMUD Success
LEM error Error in the command list

unsigned PIG_enter_SAA (  void   ) 
 

Write registers to place the LAT into SAA mode.

Return values:
PIG_INMUD Success
PIG_CRLSMALL Couldn't initialize C/R list
LEM_xxxxx Various LEM/LCBD errors

unsigned PIG_exit_SAA (  void   ) 
 

Write registers to pull the LAT out of SAA mode.

Return values:
PIG_INMUD Success
PIG_CRLSMALL Couldn't initialize C/R list
LEM_xxxxx Various LEM/LCBD errors

unsigned PIG_extract (  PIG_cfg *  cfg  ) 
 

Extract one or more nodes from the C/R fabric, possibly powering off said node at the same time.

Parameters:
cfg Pointer to a PIG configuration structure
Return values:
PIG_INMUD Success
PIG_CRLSMALL Couldn't initialize C/R list
LEM_xxxxx Various LEM/LCBD errors

unsigned PIG_extract_evt (  PIG_evt_cfg *  cfg  ) 
 

Extract one or more nodes from the event fabric.

Parameters:
cfg Pointer to a PIG configuration structure
Returns:
one of the PIG_msgs

unsigned PIG_get_ebmState (  unsigned int *  inputs,
unsigned int *  contributors,
unsigned int *  destinations
) 
 

Return the EBM configuration masks.

Parameters:
inputs Source processor input enables
contributors EBM scheduler contributor enables
destinations Broadcast masks (round-robin, ...)
Return values:
PIG_INMUD Success

unsigned PIG_get_pdus (  void   ) 
 

Get PDUs present.

Returns a two bit mask indicating the PDU(s) present in the C/R fabric

Returns:
PDU mask

unsigned PIG_insert (  PIG_cfg *  cfg  ) 
 

Insert one or more nodes into the C/R fabric, possibly powering on said node on at the same time.

Parameters:
cfg Pointer to a PIG configuration structure
Return values:
PIG_INMUD Success
PIG_CRLSMALL Couldn't initialize C/R list
LEM_xxxxx Various LEM/LCBD errors

unsigned PIG_insert_evt (  PIG_evt_cfg *  cfg  ) 
 

Insert one or more nodes into the event fabric.

Parameters:
cfg Pointer to a PIG configuration structure
Returns:
one of the PIG_msgs

unsigned PIG_order_EPU (  unsigned  order[N_EPU]  ) 
 

Change the power-on order of the EPUs from the default to order.

Parameters:
order Array of EPU ids specifying the power on order
Return values:
PIG_INMUD Success
PIG_BADORD Array of IDs contains duplicate or out of range values

unsigned PIG_order_FREE (  unsigned  order[N_FREE]  ) 
 

Change the power-on order of the FREE boards from the default to order.

Parameters:
order Array of FREE ids specifying the power on order
Return values:
PIG_INMUD Success
PIG_BADORD Array of IDs contains duplicate or out of range values

unsigned PIG_order_TEM (  unsigned  order[N_TEM]  ) 
 

Change the power-on order of the TEMs from the default to order.

Parameters:
order Array of TEM ids specifying the power on order
Return values:
PIG_INMUD Success
PIG_BADORD Array of IDs contains duplicate or out of range values

unsigned PIG_record (  void *  buf,
ITC_cb_Completion *  rtn,
void *  prm0,
void *  prm1,
void *  prm2
) 
 

Record the PIG registers to the SSR.

Takes a snapshot of the registers controlled by PIG and sends the resulting record to the SSR

Parameters:
buf Pointer to a buffer to use for the record
rtn Completion routine
prm0 Completion routine user parameter 0
prm1 Completion routine user parameter 1
prm2 Completion routine user parameter 2

unsigned PIG_safe (  void   ) 
 

Powers off all the LAT components.

Return values:
PIG_INMUD Success
PIG_CRLSMALL Couldn't initialize C/R list
LEM_xxxxx Various LEM/LCBD errors

void PIG_set_epu_delay (  unsigned  delay  ) 
 

Set the delay after EPU power on.

Parameters:
delay Time (in 100ths of a second) to wait after powering on an EPU

void PIG_set_off_delay (  unsigned  delay  ) 
 

Set the delay after power-off of a component.

Parameters:
delay Time (in 100ths of a second) to wait after powering off a component

void PIG_set_on_delay (  unsigned  delay  ) 
 

Set the delay after power-on of a component.

Parameters:
delay Time (in 100ths of a second) to wait after powering on a component

unsigned PIG_shed (  void   ) 
 

Shed the LAT power load.

Calls PIG_safe, then opens the LAT side of the main feed switch to reduce the load on the SC

Return values:
PIG_INMUD Success
PIG_CRLSMALL Couldn't initialize C/R list
LEM_xxxxx Various LEM/LCBD errors

unsigned PIG_siu_init (  PIG_siu_cfg  cfg  ) 
 

Configure the SIU in response to the MAIN_FEED_ON notification.

Parameters:
cfg SIU configuration structure
Returns:
One of the PIG_msgs

size_t PIG_sizeofRecord (  void   ) 
 

Get the size of a PIG datagram.

Calculates the space required to send a record of the registers controlled by PIG to the SSR.

Returns:
Size of a record in bytes

Generated on Thu Oct 11 05:40:47 2007 by  doxygen 1.4.4