LCM_cmddefs.h File Reference

Structures associated with CCSDS commands to subsystem LCM \ This file was auto-generated on Mon 28 Jan 2008 07:50:32 PM PST \ LCAT version: V1-22-2. More...

#include "PBI/Endianness.h"

Include dependency graph for LCM_cmddefs.h:

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


Data Structures
struct	_LCM_NODEPAD_Bfl
	Compound of node ID and padding. More...
union	_LCM_NODEPAD
	Union for command bitfield _LCM_NODEPAD_Bfl. More...
struct	_LCM_NODETRANID_Bfl
	Compound of node and transaction ID. More...
union	_LCM_NODETRANID
	Union for command bitfield _LCM_NODETRANID_Bfl. More...
struct	_LCM_MsgResponse_Prm
	Change task messaging level \ APID 0x695 \ function code 0. More...
struct	_LCM_CmdResponse_Prm
	Change task command confirmation level \ APID 0x695 \ function code 1. More...
struct	_LCM_ModuleDump_Prm
	Generate CPU code module listing \ APID 0x695 \ function code 2. More...
struct	_LCM_TaskDump_Prm
	Generate CPU task listing \ APID 0x695 \ function code 3. More...
struct	_LCM_ScrubRun_Prm
	Run memory scrubber \ APID 0x694 \ function code 0. More...
struct	_LCM_ScrubCfg_Prm
	Configure the memory scrubber \ APID 0x694 \ function code 1. More...
struct	_LCM_ErrorCfg_Prm
	Configure CPU error handling \ APID 0x694 \ function code 2. More...
struct	_LCM_Stats_Prm
	Set up the SMON statistics monitor \ APID 0x695 \ function code 5. More...
struct	_LCM_Noop_Prm
	LCM no-op \ APID 0x695 \ function code 6. More...
struct	_LCM_MsgOutCfg_Prm
	Configure MSG output interface \ APID 0x695 \ function code 7. More...
struct	_LCM_MsgResponse_Pkt
	Change task messaging level \ APID 0x695 \ function code 0. More...
struct	_LCM_CmdResponse_Pkt
	Change task command confirmation level \ APID 0x695 \ function code 1. More...
struct	_LCM_ModuleDump_Pkt
	Generate CPU code module listing \ APID 0x695 \ function code 2. More...
struct	_LCM_TaskDump_Pkt
	Generate CPU task listing \ APID 0x695 \ function code 3. More...
struct	_LCM_ScrubRun_Pkt
	Run memory scrubber \ APID 0x694 \ function code 0. More...
struct	_LCM_ScrubCfg_Pkt
	Configure the memory scrubber \ APID 0x694 \ function code 1. More...
struct	_LCM_ErrorCfg_Pkt
	Configure CPU error handling \ APID 0x694 \ function code 2. More...
struct	_LCM_Stats_Pkt
	Set up the SMON statistics monitor \ APID 0x695 \ function code 5. More...
struct	_LCM_Noop_Pkt
	LCM no-op \ APID 0x695 \ function code 6. More...
struct	_LCM_MsgOutCfg_Pkt
	Configure MSG output interface \ APID 0x695 \ function code 7. More...
Typedefs
typedef enum _LCM_LCMERRCLASS	LCM_LCMERRCLASS
	Typedef for enumeration _LCM_LCMERRCLASS.
typedef enum _LCM_LCMERRLEVEL	LCM_LCMERRLEVEL
	Typedef for enumeration _LCM_LCMERRLEVEL.
typedef enum _LCM_LCMMSGINTER	LCM_LCMMSGINTER
	Typedef for enumeration _LCM_LCMMSGINTER.
typedef enum _LCM_LCMMSGLEVEL	LCM_LCMMSGLEVEL
	Typedef for enumeration _LCM_LCMMSGLEVEL.
typedef enum _LCM_LCMNODEID	LCM_LCMNODEID
	Typedef for enumeration _LCM_LCMNODEID.
typedef enum _LCM_LCMTASKID	LCM_LCMTASKID
	Typedef for enumeration _LCM_LCMTASKID.
typedef enum _LCM_LCMCMDCLASS	LCM_LCMCMDCLASS
	Typedef for enumeration _LCM_LCMCMDCLASS.
typedef enum _LCM_LCMCMDACTION	LCM_LCMCMDACTION
	Typedef for enumeration _LCM_LCMCMDACTION.
typedef enum _LCM_LCMCMDLEVEL	LCM_LCMCMDLEVEL
	Typedef for enumeration _LCM_LCMCMDLEVEL.
typedef _LCM_NODEPAD_Bfl	LCM_NODEPAD_Bfl
	Typedef for command bitfield structure _LCM_NODEPAD_Bfl.
typedef _LCM_NODEPAD	LCM_NODEPAD
	Typedef for union _LCM_NODEPAD.
typedef _LCM_NODETRANID_Bfl	LCM_NODETRANID_Bfl
	Typedef for command bitfield structure _LCM_NODETRANID_Bfl.
typedef _LCM_NODETRANID	LCM_NODETRANID
	Typedef for union _LCM_NODETRANID.
typedef _LCM_MsgResponse_Prm	LCM_MsgResponse_Prm
	Typedef for structure _LCM_MsgResponse_Prm.
typedef _LCM_CmdResponse_Prm	LCM_CmdResponse_Prm
	Typedef for structure _LCM_CmdResponse_Prm.
typedef _LCM_ModuleDump_Prm	LCM_ModuleDump_Prm
	Typedef for structure _LCM_ModuleDump_Prm.
typedef _LCM_TaskDump_Prm	LCM_TaskDump_Prm
	Typedef for structure _LCM_TaskDump_Prm.
typedef _LCM_ScrubRun_Prm	LCM_ScrubRun_Prm
	Typedef for structure _LCM_ScrubRun_Prm.
typedef _LCM_ScrubCfg_Prm	LCM_ScrubCfg_Prm
	Typedef for structure _LCM_ScrubCfg_Prm.
typedef _LCM_ErrorCfg_Prm	LCM_ErrorCfg_Prm
	Typedef for structure _LCM_ErrorCfg_Prm.
typedef _LCM_Stats_Prm	LCM_Stats_Prm
	Typedef for structure _LCM_Stats_Prm.
typedef _LCM_Noop_Prm	LCM_Noop_Prm
	Typedef for structure _LCM_Noop_Prm.
typedef _LCM_MsgOutCfg_Prm	LCM_MsgOutCfg_Prm
	Typedef for structure _LCM_MsgOutCfg_Prm.
typedef _LCM_MsgResponse_Pkt	LCM_MsgResponse_Pkt
	Typedef for packet _LCM_MsgResponse_Pkt.
typedef _LCM_CmdResponse_Pkt	LCM_CmdResponse_Pkt
	Typedef for packet _LCM_CmdResponse_Pkt.
typedef _LCM_ModuleDump_Pkt	LCM_ModuleDump_Pkt
	Typedef for packet _LCM_ModuleDump_Pkt.
typedef _LCM_TaskDump_Pkt	LCM_TaskDump_Pkt
	Typedef for packet _LCM_TaskDump_Pkt.
typedef _LCM_ScrubRun_Pkt	LCM_ScrubRun_Pkt
	Typedef for packet _LCM_ScrubRun_Pkt.
typedef _LCM_ScrubCfg_Pkt	LCM_ScrubCfg_Pkt
	Typedef for packet _LCM_ScrubCfg_Pkt.
typedef _LCM_ErrorCfg_Pkt	LCM_ErrorCfg_Pkt
	Typedef for packet _LCM_ErrorCfg_Pkt.
typedef _LCM_Stats_Pkt	LCM_Stats_Pkt
	Typedef for packet _LCM_Stats_Pkt.
typedef _LCM_Noop_Pkt	LCM_Noop_Pkt
	Typedef for packet _LCM_Noop_Pkt.
typedef _LCM_MsgOutCfg_Pkt	LCM_MsgOutCfg_Pkt
	Typedef for packet _LCM_MsgOutCfg_Pkt.
typedef enum _LCM_Apid694Fcodes	LCM_Apid694Fcodes
	Typedef for enumeration _LCM_Apid694Fcodes.
typedef enum _LCM_Apid695Fcodes	LCM_Apid695Fcodes
	Typedef for enumeration _LCM_Apid695Fcodes.
Enumerations
enum	_LCM_LCMERRCLASS { LCM_LCMERRCLASS_LCMECLPCI = 1, LCM_LCMERRCLASS_LCMECLMEC = 2, LCM_LCMERRCLASS_LCMECLMEU = 3 }
	LCM Error Configuration Classes. More...
enum	_LCM_LCMERRLEVEL { LCM_LCMERRLEVEL_LCMLEVCNT = 1, LCM_LCMERRLEVEL_LCMLEVDIA = 2, LCM_LCMERRLEVEL_LCMLEVCRI = 3 }
	LCM Error Handling Level. More...
enum	_LCM_LCMMSGINTER { LCM_LCMMSGINTER_LCMMINCTDB = 1, LCM_LCMMSGINTER_LCMMINSSR = 2 }
	MSG output interfaces. More...
enum	_LCM_LCMMSGLEVEL { LCM_LCMMSGLEVEL_MSGLVLINFO = 1, LCM_LCMMSGLEVEL_MSGLVLWARNING = 2, LCM_LCMMSGLEVEL_MSGLVLERROR = 3, LCM_LCMMSGLEVEL_MSGLVLDISABLE = 4 }
	MSG output level. More...
enum	_LCM_LCMNODEID { LCM_LCMNODEID_SIU = 0, LCM_LCMNODEID_EPU0 = 1, LCM_LCMNODEID_EPU1 = 2, LCM_LCMNODEID_EPU2 = 3, LCM_LCMNODEID_EPU3 = 4 }
	List of CPU nodes addressable with LCM commands. More...
enum	_LCM_LCMTASKID { LCM_LCMTASKID_LCM_M = 1, LCM_LCMTASKID_LFS_M = 2, LCM_LCMTASKID_LHK_M = 4, LCM_LCMTASKID_LHK_S = 5, LCM_LCMTASKID_LIM_M = 6, LCM_LCMTASKID_LSM_M = 8, LCM_LCMTASKID_LSM_S = 9, LCM_LCMTASKID_LSW_M = 10, LCM_LCMTASKID_LCI_M = 12, LCM_LCMTASKID_STX_U = 30, LCM_LCMTASKID_LMC_M = 14, LCM_LCMTASKID_LPA_M = 15, LCM_LCMTASKID_LRA_M = 17, LCM_LCMTASKID_LTC_M = 18, LCM_LCMTASKID_GRB_S = 19, LCM_LCMTASKID_CRXC_U = 22, LCM_LCMTASKID_LTX0_U = 25, LCM_LCMTASKID_LRXR_U = 26, LCM_LCMTASKID_LRXE_U = 27, LCM_LCMTASKID_CTX_U = 29, LCM_LCMTASKID_LPA_S = 16 }
	Discrete list of task IDs. More...
enum	_LCM_LCMCMDCLASS { LCM_LCMCMDCLASS_NORMAL = 0, LCM_LCMCMDCLASS_BROADCAST = 1 }
	ITC Command Classes. More...
enum	_LCM_LCMCMDACTION { LCM_LCMCMDACTION_FORWARD = 1, LCM_LCMCMDACTION_EXECUTE = 0 }
	ITC Command Actions. More...
enum	_LCM_LCMCMDLEVEL { LCM_LCMCMDLEVEL_NONE = 2, LCM_LCMCMDLEVEL_ALL = 0, LCM_LCMCMDLEVEL_ERROR = 1 }
	ITC Command Response Level. More...
enum	_LCM_Apid694Fcodes { LCM_SCRUBRUN_FCODE = 0, LCM_SCRUBCFG_FCODE = 1, LCM_ERRORCFG_FCODE = 2 }
	Function code enumerations for apid 0x694. More...
enum	_LCM_Apid695Fcodes { LCM_MSGRESPONSE_FCODE = 0, LCM_CMDRESPONSE_FCODE = 1, LCM_MODULEDUMP_FCODE = 2, LCM_TASKDUMP_FCODE = 3, LCM_STATS_FCODE = 5, LCM_NOOP_FCODE = 6, LCM_MSGOUTCFG_FCODE = 7 }
	Function code enumerations for apid 0x695. More...
Functions
unsigned int	LCM_MsgResponse (void prm, const struct _ITC_QueueItem qitem, void *pay, unsigned int len)
	Callback function for the MsgResponse command.
unsigned int	LCM_CmdResponse (void prm, const struct _ITC_QueueItem qitem, void *pay, unsigned int len)
	Callback function for the CmdResponse command.
unsigned int	LCM_ModuleDump (void prm, const struct _ITC_QueueItem qitem, void *pay, unsigned int len)
	Callback function for the LLCMMODDUMP command.
unsigned int	LCM_TaskDump (void prm, const struct _ITC_QueueItem qitem, void *pay, unsigned int len)
	Callback function for the LLCMTASKDUMP command.
unsigned int	LCM_ScrubRun (void prm, const struct _ITC_QueueItem qitem, void *pay, unsigned int len)
	Callback function for the LLCMSCRUBRUN command.
unsigned int	LCM_ScrubCfg (void prm, const struct _ITC_QueueItem qitem, void *pay, unsigned int len)
	Callback function for the LLCMSCRUBCFG command.
unsigned int	LCM_ErrorCfg (void prm, const struct _ITC_QueueItem qitem, void *pay, unsigned int len)
	Callback function for the LLCMERRORCFG command.
unsigned int	LCM_Stats (void prm, const struct _ITC_QueueItem qitem, void *pay, unsigned int len)
	Callback function for the SETSMON command.
unsigned int	LCM_Noop (void prm, const struct _ITC_QueueItem qitem, void *pay, unsigned int len)
	Callback function for the LCMNOOP command.
unsigned int	LCM_MsgOutCfg (void prm, const struct _ITC_QueueItem qitem, void *pay, unsigned int len)
	Callback function for the LLCMMSGOUT command.

Detailed Description

Structures associated with CCSDS commands to subsystem LCM \ This file was auto-generated on Mon 28 Jan 2008 07:50:32 PM PST \ LCAT version: V1-22-2.

Warning:: Machine generated code - NEVER edit by hand

Enumeration Type Documentation

enum _LCM_Apid694Fcodes

Function code enumerations for apid 0x694.

Enumerator:

LCM_SCRUBRUN_FCODE APID 0x694 function code 0

LCM_SCRUBCFG_FCODE APID 0x694 function code 1

LCM_ERRORCFG_FCODE APID 0x694 function code 2

enum _LCM_Apid695Fcodes

Function code enumerations for apid 0x695.

Enumerator:

LCM_MSGRESPONSE_FCODE APID 0x695 function code 0

LCM_CMDRESPONSE_FCODE APID 0x695 function code 1

LCM_MODULEDUMP_FCODE APID 0x695 function code 2

LCM_TASKDUMP_FCODE APID 0x695 function code 3

LCM_STATS_FCODE APID 0x695 function code 5

LCM_NOOP_FCODE APID 0x695 function code 6

LCM_MSGOUTCFG_FCODE APID 0x695 function code 7

enum _LCM_LCMCMDACTION

ITC Command Actions.

Enumerator:

LCM_LCMCMDACTION_FORWARD For forward commands

LCM_LCMCMDACTION_EXECUTE For execute commands

enum _LCM_LCMCMDCLASS

ITC Command Classes.

Enumerator:

LCM_LCMCMDCLASS_NORMAL Normal command

LCM_LCMCMDCLASS_BROADCAST Broadcast command

enum _LCM_LCMCMDLEVEL

ITC Command Response Level.

Enumerator:

LCM_LCMCMDLEVEL_NONE Never respond to commands

LCM_LCMCMDLEVEL_ALL Respond to all commands (success or failure)

LCM_LCMCMDLEVEL_ERROR Respond to errored commands

enum _LCM_LCMERRCLASS

LCM Error Configuration Classes.

Enumerator:

LCM_LCMERRCLASS_LCMECLPCI PCI Bus Error Class

LCM_LCMERRCLASS_LCMECLMEC Correctable Memory Error Class

LCM_LCMERRCLASS_LCMECLMEU Uncorretable Memory Error Class

enum _LCM_LCMERRLEVEL

LCM Error Handling Level.

Enumerator:

LCM_LCMERRLEVEL_LCMLEVCNT Counted Error Level

LCM_LCMERRLEVEL_LCMLEVDIA Diagnostic Error Level

LCM_LCMERRLEVEL_LCMLEVCRI Crititcal Error Level

enum _LCM_LCMMSGINTER

MSG output interfaces.

Enumerator:

LCM_LCMMSGINTER_LCMMINCTDB CTDB MSG output interface

LCM_LCMMSGINTER_LCMMINSSR SSR MSG Output interface

enum _LCM_LCMMSGLEVEL

MSG output level.

Enumerator:

LCM_LCMMSGLEVEL_MSGLVLINFO INFORMATION MSG Level

LCM_LCMMSGLEVEL_MSGLVLWARNING MSG WARNING Level

LCM_LCMMSGLEVEL_MSGLVLERROR MSG ERROR Level

LCM_LCMMSGLEVEL_MSGLVLDISABLE Disable MSG Output

enum _LCM_LCMNODEID

List of CPU nodes addressable with LCM commands.

Enumerator:

LCM_LCMNODEID_SIU The SIU computer

LCM_LCMNODEID_EPU0 The EPU0 computer

LCM_LCMNODEID_EPU1 The EPU1 computer

LCM_LCMNODEID_EPU2 The EPU2 computer

LCM_LCMNODEID_EPU3 The EPU3 computer (external crate)

enum _LCM_LCMTASKID

Discrete list of task IDs.

Enumerator:

LCM_LCMTASKID_LCM_M LAT computer manager, master task

LCM_LCMTASKID_LFS_M LAT file system, master task

LCM_LCMTASKID_LHK_M LAT housekeeping system, master task

LCM_LCMTASKID_LHK_S LAT housekeeping, slave task

LCM_LCMTASKID_LIM_M LAT instrument manager, master task

LCM_LCMTASKID_LSM_M LAT spacecraft messages, master task

LCM_LCMTASKID_LSM_S LAT spacecraft messages, slave task

LCM_LCMTASKID_LSW_M LAT software watchdog, master task

LCM_LCMTASKID_LCI_M LAT charge injection calibration, master task

LCM_LCMTASKID_STX_U SDI (transmit), utility task

LCM_LCMTASKID_LMC_M LAT multiplexed rate counters, master task

LCM_LCMTASKID_LPA_M LAT physics aquisition, master task

LCM_LCMTASKID_LRA_M LAT register access, master task

LCM_LCMTASKID_LTC_M LAT thermal control, master task

LCM_LCMTASKID_GRB_S LAT gamma ray burst analysis, slave task

LCM_LCMTASKID_CRXC_U CTDB command receive, utility task

LCM_LCMTASKID_LTX0_U LCB transmit, utility task

LCM_LCMTASKID_LRXR_U LCB receive result, utility task

LCM_LCMTASKID_LRXE_U LCB receive event, utility task

LCM_LCMTASKID_CTX_U CTDB transmit, utility task

LCM_LCMTASKID_LPA_S LAT physics acquisition, slave task

Function Documentation

unsigned int LCM_CmdResponse ( void * prm,

const struct _ITC_QueueItem * qitem,

void * pay,

unsigned int len

)

Callback function for the CmdResponse command.

Parameters:

prm (in) User context parameter

qitem (in) Queue item

pay (in) Payload pointer

len (in) Payload length

Return values:

ITC_SUCCESS S Success

ITC_TASKMISS E No entry in task table for task

ITC_TASKPTR E Task pointer check failed

ITC_VARRNG E Out of range variable detected

unsigned int LCM_ErrorCfg ( void * prm,

const struct _ITC_QueueItem * qitem,

void * pay,

unsigned int len

)

Callback function for the LLCMERRORCFG command.

Parameters:

prm (in) User context parameter

qitem (in) Queue item

pay (in) Payload pointer

len (in) Payload length

Return values:

ITC_FORWARD If command is forwarded to another node

LCM_ECMDPARM Error in command parameters

LCM_SUCCESS Success

unsigned int LCM_ModuleDump ( void * prm,

const struct _ITC_QueueItem * qitem,

void * pay,

unsigned int len

)

Callback function for the LLCMMODDUMP command.

Parameters:

prm (in) User context parameter

qitem Queue item

pay Payload pointer

len Payload length

Returns:

unsigned int LCM_MsgOutCfg ( void * prm,

const struct _ITC_QueueItem * qitem,

void * pay,

unsigned int len

)

Callback function for the LLCMMSGOUT command.

Parameters:

prm User context parameter

qitem Queue item

pay Payload pointer

len Payload length

Returns:

unsigned int LCM_MsgResponse ( void * prm,

const struct _ITC_QueueItem * qitem,

void * pay,

unsigned int len

)

Callback function for the MsgResponse command.

Parameters:

prm (in) User context parameter

qitem (in) Queue item

pay (in) Payload pointer

len (in) Payload length

Return values:

ITC_SUCCESS S Success

ITC_TASKMISS E No entry in task table for task

ITC_TASKPTR E Task pointer check failed

ITC_VARRNG E Out of range variable detected

unsigned int LCM_Noop ( void * prm,

const struct _ITC_QueueItem * qitem,

void * pay,

unsigned int len

)

Callback function for the LCMNOOP command.

Parameters:

prm User context parameter

qitem Queue item

pay Payload pointer

len Payload length

Returns:

unsigned int LCM_ScrubCfg ( void * prm,

const struct _ITC_QueueItem * qitem,

void * pay,

unsigned int len

)

Callback function for the LLCMSCRUBCFG command.

Parameters:

prm (in) User context parameter

qitem (in) Queue item

pay (in) Payload pointer

len (in) Payload length

Return values:

ITC_FORWARD If command is forwarded to another node

LCM_SUCCESS Success

unsigned int LCM_ScrubRun ( void * prm,

const struct _ITC_QueueItem * qitem,

void * pay,

unsigned int len

)

Callback function for the LLCMSCRUBRUN command.

Parameters:

prm (in) User context parameter

qitem (in) Queue item

pay (in) Payload pointer

len (in) Payload length

Return values:

ITC_FORWARD If command is forwarded to another node

LCM_SUCCESS Success

unsigned int LCM_Stats ( void * prm,

const struct _ITC_QueueItem * qitem,

void * pay,

unsigned int len

)

Callback function for the SETSMON command.

Parameters:

prm User context parameter

qitem Queue item

pay Payload pointer

len Payload length

Returns:

unsigned int LCM_TaskDump ( void * prm,

const struct _ITC_QueueItem * qitem,

void * pay,

unsigned int len

)

Callback function for the LLCMTASKDUMP command.

Parameters:

prm (in) User context parameter

qitem Queue item

pay Payload pointer

len Payload length

Returns:

Generated on Fri Feb 1 01:26:02 2008 by

1.4.4

LCM_cmddefs.h File Reference

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation