GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> EBC / dev > ebc_epu / mv2304


Interface   Data Structures   File List   Data Fields   Globals  

EBC_prvdefs.h File Reference

Private definitions for the EBC package. More...

#include <IMM/FPM_pubdefs.h>
#include <IMM/RBM_pubdefs.h>
#include <ITC/ITC_pubdefs.h>
#include <PBS/MTX.h>
#include <PBS/RW.h>

Classes

struct  _EBC_Control
 Structure to hold the EBC control block. More...

Typedefs

typedef enum _EBC_ControlState EBC_ControlState
 Typedef for enum _EBC_ControlState.
typedef struct _EBC_Control EBC_Control
 Typedef for struct _EBC_Control.

Enumerations

enum  _EBC_ControlState {
  EBC_CTL_UNKNOWN = -1,
  EBC_CTL_UNINITIALIZED = 0,
  EBC_CTL_INITIALIZED = 1,
  EBC_CTL_STARTED = 2,
  EBC_CTL_BROKEN = 3
}
 Enumeration of EBC control states. More...

Functions

void EBC_check (unsigned int status, unsigned int index, unsigned int data)
 Check an EBC call for errors.
unsigned int EBC_cmd_init (ITC_TaskID tid)
void EBC_diag_set (unsigned int status, unsigned int index, unsigned int data)
 Set the SBC values within the boot diagnostic region of memory.
unsigned int EBC_fakeCtdbCounts (void)
unsigned int EBC_fakeLsmInitialize (ITC_TaskID tid)
 Initialize the ECB control block.
unsigned int EBC_fakeLsmStart (void)
 Start the fake LSM task.
unsigned int EBC_ignore (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Command handler to turn command into a no-op.
unsigned int EBC_timetone (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Command handler for timetone messages.

Variables

EBC_ControlEBC_ecb
 Control block for EBC facility.


Detailed Description

Private definitions for the EBC package.

CVS $Id: EBC_prvdefs.h,v 1.2 2011/03/30 01:32:56 apw Exp $
Author:
A.P.Waite

Enumeration Type Documentation

Enumeration of EBC control states.

Enumerator:
EBC_CTL_UNKNOWN  Unknown (guard value)
EBC_CTL_UNINITIALIZED  Uninitialized
EBC_CTL_INITIALIZED  Initialized
EBC_CTL_STARTED  Successfully started
EBC_CTL_BROKEN  Fatal error


Function Documentation

void EBC_check ( unsigned int  status,
unsigned int  index,
unsigned int  data 
)

Check an EBC call for errors.

Parameters:
status (in) MSG status code
index (in) Current progress index
data (in) Error-specific data value
Returns:
Nothing

References EBC_diag_set().

Referenced by SBC_init().

void EBC_diag_set ( unsigned int  status,
unsigned int  index,
unsigned int  data 
)

Set the SBC values within the boot diagnostic region of memory.

Parameters:
status (in) MSG status code
index (in) Current progress index
data (in) Error-specific data value
Returns:
Nothing

Referenced by EBC_check(), and SBC_init().

unsigned int EBC_fakeLsmInitialize ( ITC_TaskID  tid  ) 

Initialize the ECB control block.

Parameters:
tid (in) Task ID for the LSM task to be faked
Returns:
A MSG code

References EBC_CTL_BROKEN, EBC_CTL_INITIALIZED, EBC_CTL_UNINITIALIZED, fakeLsmInitialize(), _EBC_Control::mtx, _EBC_Control::rwi, _EBC_Control::state, and _EBC_Control::tid.

Referenced by SBC_init().

unsigned int EBC_fakeLsmStart ( void   ) 

Start the fake LSM task.

EBC_fakeLsmStart() starts the LSM task simulation.

References EBC_CTL_BROKEN, EBC_CTL_INITIALIZED, _EBC_Control::itc, _EBC_Control::mtx, _EBC_Control::state, and _EBC_Control::tid.

Referenced by SBC_init().

unsigned int EBC_ignore ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pay,
unsigned int  len 
)

Command handler to turn command into a no-op.

Parameters:
prm (in) Context parameter
qitem (in) Queue item
pay (in) Command payload
len (in) Length of payload (bytes)
Return values:
EBC_SUCCESS Always

unsigned int EBC_timetone ( void *  prm,
const struct _ITC_QueueItem *  qitem,
void *  pay,
unsigned int  len 
)

Command handler for timetone messages.

Parameters:
prm (in) Context parameter
qitem (in) Queue item
pay (in) Command payload
len (in) Length of payload (bytes)
Return values:
EBC_SUCCESS Always

References _timetone::sec.


Generated on Tue Mar 29 18:37:21 2011 by  doxygen 1.5.8