GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LCM / V1-4-4

Constituent: lcm_siu     Tag: rad750

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » APP » source » LCM » V1-4-4 » src

LCM_prvdefs.h File Reference

Private definitions for the LCM package. More...

#include "IMM/FPM_pubdefs.h"
#include "IMM/RBM_pubdefs.h"
#include "ITC/ITC_pubdefs.h"
#include "LCM_DB/LCM_DB_schema.h"
#include "PBS/FORK.h"
#include "PBS/MTX.h"
#include "PBS/RW.h"
#include "PBS/SEM.h"
#include "PBS/WUT.h"
#include "PBS/WCT.h"
#include "LCM/LCM_cmddefs.h"

Include dependency graph for LCM_prvdefs.h:

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


Data Structures

struct  _CPUStatus
struct  _LCM_ScrubStatus
 Status of the memory scrubbing machine. More...
struct  _LCM_ConfigPID_bf
 Structure to capture PID bits (only on rad750). More...
union  _LCM_ConfigPID
 Union of representations of PID bits. More...
struct  _LCM_ConfigTHS_bf
 Structure to capture THS simulation status bits. More...
union  _LCM_ConfigTHS
 Union of representations of THS simulation bits. More...
struct  _LCM_FileStatus
 Status of the file upload state machine. More...
struct  _LCM_MemoryStatus
 Status of the memory load/dump state machines. More...
struct  _LCM_Record
 Structure to put a standard header on CPU to CPU records. More...
struct  _LCM_Packet
 An anonymous housekeeping packet (nearly). More...
struct  _LHK_LpaCfgSiu_Tlm
 A single capture packet for an LPA (filter) configuration record. More...
struct  _LCM_Database
 Database in which to prepare housekeeping packets. More...
struct  _LCM_Tickle
 A wake-up message for capturing assorted CPU records/packets. More...
struct  _LCM_Control
 Structure to hold the LCM control block. More...

Defines

#define LCM_HW_CONFIG_CMD_APID   (0x694)
#define LCM_SW_CONFIG_CMD_APID   (0x695)
#define LCM_INTERNAL_CMD_APID   (0x696)
#define LCM_TASK_LIST_SIZE   (64)
#define LCM_MSG_SSR_TEXT_SIZE   (2048)
#define LCM_SCRUB_INITIAL_PERIOD   (5)
#define LCM_TELEM_PKT_SIZE   (512)
#define LCM_L_RECORD_TYPES   (3)

Typedefs

typedef enum _LCM_ControlState LCM_ControlState
 Typedef for enum _LCM_ControlState.
typedef enum _LCM_RecordType LCM_RecordType
 Typedef for enum _LCM_RecordType.
typedef _CPUStatus LCM_CPUStatus
 Typedef for telemetry structure _LCM_CPUStatus.
typedef _LCM_ScrubStatus LCM_ScrubStatus
 Typedef for telemetry structure _LCM_ScrubStatus.
typedef _LCM_ConfigPID_bf LCM_ConfigPID_bf
 Typedef for struct _LCM_ConfigPID_bf.
typedef _LCM_ConfigPID LCM_ConfigPID
 Typedef for union _LCM_ConfigPID.
typedef _LCM_ConfigTHS_bf LCM_ConfigTHS_bf
 Typedef for struct _LCM_ConfigTHS_bf.
typedef _LCM_ConfigTHS LCM_ConfigTHS
 Typedef for union _LCM_ConfigTHS.
typedef _LCM_FileStatus LCM_FileStatus
 Typedef for telemetry structure _LCM_FileStatus.
typedef _LCM_MemoryStatus LCM_MemoryStatus
 Typedef for telemetry structure _LCM_MemoryStatus.
typedef _LCM_Record LCM_Record
 Typedef for struct _LCM_Record.
typedef _LCM_Packet LCM_Packet
 Typedef for struct _LCM_Packet.
typedef _LHK_LpaCfgSiu_Tlm LHK_LpaCfgSiu_Tlm
 Typedef for struct _LHK_LpaCfgSiu_Tlm.
typedef _LCM_Database LCM_Database
 Typedef for struct _LCM_Database_CPU.
typedef _LCM_Tickle LCM_Tickle
 Typedef for struct _LCM_Tickle.
typedef _LCM_Control LCM_Control
 Typedef for struct _LCM_Control.

Enumerations

enum  _LCM_ControlState {
  LCM_CTL_UNKNOWN = -1,
  LCM_CTL_UNINITIALIZED = 0,
  LCM_CTL_PARTIAL = 1,
  LCM_CTL_INITIALIZED = 2,
  LCM_CTL_STARTING = 3,
  LCM_CTL_RUNNING = 4,
  LCM_CTL_STOPPING = 5,
  LCM_CTL_BROKEN = 6
}
 Enumeration of LCM control states. More...
enum  _LCM_RecordType {
  LCM_HSK_RECORD_CPU = 0,
  LCM_HSK_RECORD_ITC = 1,
  LCM_HSK_RECORD_LPA = 2
}
 Number of records types Enumeration of housekeeping record types. More...

Functions

unsigned int LCM_CmdResponse_common (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)
void LCM_freeTelem (ITC_QueueItem *qitem, unsigned int status, LCM_Control *ctl, void *prm1, void *prm2)
 Free memory after sending ITC telemetry packets.
unsigned int LCM_houseInitialize (LCM_Control *ctl)
 Initialize the housekeeping function (common to all CPUs).
unsigned int LCM_houseInitializeSIU (LCM_Control *ctl)
 Initialize the housekeeping function (specific to SIU).
unsigned int LCM_houseSendCPU (unsigned int report)
 Acquire and send CPU metric information.
unsigned int LCM_houseSendITC (unsigned int report)
 Acquire and send ITC configuration information.
unsigned int LCM_houseSendLPA (unsigned int report)
 Acquire and send LPA (filter) configuration information.
unsigned int LCM_houseTaskInitialize (LCM_Control *ctl)
 One-time call in LCM task context to start housekeeping sub-function.
unsigned int LCM_imageInitializeEPU (LCM_Control *ctl)
unsigned int LCM_imageInitializeSIU (LCM_Control *ctl)
 Initialize the LCM module/task image dump subsystem (SIU specific).
unsigned int LCM_messageInitialize (LCM_Control *ctl)
 Initialize the LCM message handling subsystem.
unsigned int LCM_messageInitializeEPU (LCM_Control *ctl)
unsigned int LCM_messageInitializeSIU (LCM_Control *ctl)
 Initialize the LCM message handling subsystem.
unsigned int LCM_MsgOutCfg_common (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)
unsigned int LCM_MsgResponse_common (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)
unsigned int LCM_Noop_common (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)
unsigned int LCM_scrubInitialize (LCM_Control *ctl)
 Initialize the LCM memory scrubbing subsystem.
unsigned int LCM_scrubTaskInitialize (LCM_Control *ctl)
 One-time call in LCM task context to start the scrub sub-function.
unsigned int LCM_SMONInitialize (LCM_Control *ctl)
 Initialize the LCM SMON subsystem.
unsigned int LCM_SMONTaskInitialize (LCM_Control *ctl)
 One-time call in LCM task context to start SMON sub-function.
unsigned int LCM_Stats_common (void *prm, const ITC_QueueItem *qitem, void *pay, unsigned int len)

Variables

LCM_Control * LCM_lcb
 Control block for LCM facility.

Detailed Description

Private definitions for the LCM package. 

CVS $Id: LCM_prvdefs.h,v 1.28 2007/10/29 00:29:04 apw Exp $
Author:
A.P.Waite

Define Documentation

#define LCM_HW_CONFIG_CMD_APID   (0x694)
 

The CCSDS APID for LCM package HW configuration telecommands.

#define LCM_INTERNAL_CMD_APID   (0x696)
 

The CCSDS APID for LCM package internal telecommands.

#define LCM_MSG_SSR_TEXT_SIZE   (2048)
 

The maximum size in bytes of a SSR MSG output text string.

#define LCM_SCRUB_INITIAL_PERIOD   (5)
 

The initial period in minutes for the RAD750 memory scrubber.

#define LCM_SW_CONFIG_CMD_APID   (0x695)
 

The CCSDS APID for LCM package SW configuration telecommands.

#define LCM_TASK_LIST_SIZE   (64)
 

The number of task ID's allowed for LLCMTASKDUMP telecommand.

Enumeration Type Documentation

enum _LCM_ControlState
 

Enumeration of LCM control states.

Enumerator:
LCM_CTL_UNKNOWN  Unknown (guard value)
LCM_CTL_UNINITIALIZED  Uninitialized
LCM_CTL_PARTIAL  Partially initialized
LCM_CTL_INITIALIZED  Initialized
LCM_CTL_STARTING  Starting
LCM_CTL_RUNNING  Successfully started
LCM_CTL_STOPPING  Stopping
LCM_CTL_BROKEN  Fatal error

enum _LCM_RecordType
 

Number of records types Enumeration of housekeeping record types.

Enumerator:
LCM_HSK_RECORD_CPU  A CPU metrics record
LCM_HSK_RECORD_ITC  An ITC configuration record
LCM_HSK_RECORD_LPA  An ITC configuration record

Function Documentation

void LCM_freeTelem (  ITC_QueueItem *  qitem,
unsigned int  status,
LCM_Control *  ctl,
void *  prm1,
void *  prm2
) 
 

Free memory after sending ITC telemetry packets.

Parameters:
qitem (in) The memory buffer.
status (in) Status of telemetry.
ctl (in) LCM control structure.
prm1 (in) Completion callback paramter 1.
prm2 (in) Completion callback paramter 2.

unsigned int LCM_houseInitialize (  LCM_Control *  ctl  ) 
 

Initialize the housekeeping function (common to all CPUs).

Parameters:
ctl (in) LCM control block
LCM_houseInitialize() builds up the CPU common elements for providing housekeeping information.

unsigned int LCM_houseInitializeSIU (  LCM_Control *  ctl  ) 
 

Initialize the housekeeping function (specific to SIU).

Parameters:
ctl (in) LCM control block
LCM_houseInitializeSIU() builds up the SIU specific elements for providing housekeeping information.

unsigned int LCM_houseSendCPU (  unsigned int  report  ) 
 

Acquire and send CPU metric information.

Parameters:
report (in) Force a diagnostic packet on the SIU
LCM_houseSendCPU() does an immediate acquisition and send of CPU metric information to the SIU.

unsigned int LCM_houseSendITC (  unsigned int  report  ) 
 

Acquire and send ITC configuration information.

Parameters:
report (in) Force a diagnostic packet on the SIU
LCM_houseSendITC() does an immediate acquisition and send of ITC configuration information to the SIU.

unsigned int LCM_houseSendLPA (  unsigned int  report  ) 
 

Acquire and send LPA (filter) configuration information.

Parameters:
report (in) Force a diagnostic packet on the SIU
LCM_houseSendLPA() does an immediate acquisition and send of LPA (filter) configuration information to the SIU.

unsigned int LCM_houseTaskInitialize (  LCM_Control *  ctl  ) 
 

One-time call in LCM task context to start housekeeping sub-function.

Parameters:
ctl (in) LCM control block
LCM_houseTaskInitialize() performs any initialization required by the house- keeping subfunction which must be performed in the context of the LCM task.

unsigned int LCM_imageInitializeSIU (  LCM_Control *  ctl  ) 
 

Initialize the LCM module/task image dump subsystem (SIU specific).

Parameters:
ctl (in) LCM control block
LCM_imageInitializeSIU() builds up the SIU specific facilities to dump module and task decriptions.

unsigned int LCM_messageInitialize (  LCM_Control *  ctl  ) 
 

Initialize the LCM message handling subsystem.

Parameters:
ctl (in) LCM control block
LCM_messageInitialize() builds up the CPU common facilities for sending messages to CTDB/SSR.

unsigned int LCM_messageInitializeSIU (  LCM_Control *  ctl  ) 
 

Initialize the LCM message handling subsystem.

Parameters:
ctl (in) LCM control block
LCM_messageInitializeSIU() builds up the SIU specific facilities for sending messages to CTDB/SSR.

unsigned int LCM_scrubInitialize (  LCM_Control *  ctl  ) 
 

Initialize the LCM memory scrubbing subsystem.

Parameters:
ctl (in) LCM control block
LCM_scrubInitialize() builds up the CPU common facilities to run the memory scrubber.

unsigned int LCM_scrubTaskInitialize (  LCM_Control *  ctl  ) 
 

One-time call in LCM task context to start the scrub sub-function.

Parameters:
ctl (in) LCM control block
LCM_scrubTaskInitialize() is run once only in the LCM task context to do any final initialization required by the scrub subfunction.

unsigned int LCM_SMONInitialize (  LCM_Control *  ctl  ) 
 

Initialize the LCM SMON subsystem.

Parameters:
ctl (in) LCM control block
LCM_SMONInitialize() initialized the CPU common SMON subsystem.

unsigned int LCM_SMONTaskInitialize (  LCM_Control *  ctl  ) 
 

One-time call in LCM task context to start SMON sub-function.

Parameters:
ctl (in) LCM control block
LCM_SMONTaskInitialize() starts up the SMON task

Generated on Mon Nov 5 02:24:11 2007 by  doxygen 1.4.4