LSW_cmddefs.h File Reference

Structures associated with CCSDS commands to subsystem LSW \ This file was auto-generated on Tue 29 May 2007 05:23:17 PM PDT \ LCAT version: V1-21-4. More...

#include <PBI/Endianness.h>

Classes
struct	_LSW_CONFIGBITS_Bfl
	Definition of trace enable bits. More...
union	_LSW_CONFIGBITS
	Union for command bitfield _LSW_CONFIGBITS_Bfl. More...
struct	_LSW_NODETRANID_Bfl
	Compound of node and transaction ID. More...
union	_LSW_NODETRANID
	Union for command bitfield _LSW_NODETRANID_Bfl. More...
struct	_LSW_Noop_Prm
	No-Op \ APID 0x64c \ function code 0. More...
struct	_LSW_DumpStart_Prm
	Dump the start line system trace \ APID 0x64c \ function code 1. More...
struct	_LSW_DumpTraceById_Prm
	Dump a code trace by numeric identifier \ APID 0x64c \ function code 2. More...
struct	_LSW_DumpTraceByName_Prm
	Dump a code trace by name. \ APID 0x64c \ function code 3. More...
struct	_LSW_SetTraceConfig_Prm
	Set the values of the trace enable bits. \ APID 0x64c \ function code 4. More...
struct	_LSW_Noop_Pkt
	No-Op \ APID 0x64c \ function code 0. More...
struct	_LSW_DumpStart_Pkt
	Dump the start line system trace \ APID 0x64c \ function code 1. More...
struct	_LSW_DumpTraceById_Pkt
	Dump a code trace by numeric identifier \ APID 0x64c \ function code 2. More...
struct	_LSW_DumpTraceByName_Pkt
	Dump a code trace by name. \ APID 0x64c \ function code 3. More...
struct	_LSW_SetTraceConfig_Pkt
	Set the values of the trace enable bits. \ APID 0x64c \ function code 4. More...
Typedefs
typedef enum _LSW_LSWNODEID	LSW_LSWNODEID
	Typedef for enumeration _LSW_LSWNODEID.
typedef enum _LSW_LSWDEST	LSW_LSWDEST
	Typedef for enumeration _LSW_LSWDEST.
typedef struct _LSW_CONFIGBITS_Bfl	LSW_CONFIGBITS_Bfl
	Typedef for command bitfield structure _LSW_CONFIGBITS_Bfl.
typedef union _LSW_CONFIGBITS	LSW_CONFIGBITS
	Typedef for union _LSW_CONFIGBITS.
typedef struct _LSW_NODETRANID_Bfl	LSW_NODETRANID_Bfl
	Typedef for command bitfield structure _LSW_NODETRANID_Bfl.
typedef union _LSW_NODETRANID	LSW_NODETRANID
	Typedef for union _LSW_NODETRANID.
typedef struct _LSW_Noop_Prm	LSW_Noop_Prm
	Typedef for structure _LSW_Noop_Prm.
typedef struct _LSW_DumpStart_Prm	LSW_DumpStart_Prm
	Typedef for structure _LSW_DumpStart_Prm.
typedef struct _LSW_DumpTraceById_Prm	LSW_DumpTraceById_Prm
	Typedef for structure _LSW_DumpTraceById_Prm.
typedef struct _LSW_DumpTraceByName_Prm	LSW_DumpTraceByName_Prm
	Typedef for structure _LSW_DumpTraceByName_Prm.
typedef struct _LSW_SetTraceConfig_Prm	LSW_SetTraceConfig_Prm
	Typedef for structure _LSW_SetTraceConfig_Prm.
typedef struct _LSW_Noop_Pkt	LSW_Noop_Pkt
	Typedef for packet _LSW_Noop_Pkt.
typedef struct _LSW_DumpStart_Pkt	LSW_DumpStart_Pkt
	Typedef for packet _LSW_DumpStart_Pkt.
typedef struct _LSW_DumpTraceById_Pkt	LSW_DumpTraceById_Pkt
	Typedef for packet _LSW_DumpTraceById_Pkt.
typedef struct _LSW_DumpTraceByName_Pkt	LSW_DumpTraceByName_Pkt
	Typedef for packet _LSW_DumpTraceByName_Pkt.
typedef struct _LSW_SetTraceConfig_Pkt	LSW_SetTraceConfig_Pkt
	Typedef for packet _LSW_SetTraceConfig_Pkt.
typedef enum _LSW_Apid64cFcodes	LSW_Apid64cFcodes
	Typedef for enumeration _LSW_Apid64cFcodes.
Enumerations
enum	_LSW_LSWNODEID {   LSW_LSWNODEID_EPU0 = 1,   LSW_LSWNODEID_EPU1 = 2,   LSW_LSWNODEID_EPU2 = 3,   LSW_LSWNODEID_EPU3 = 4,   LSW_LSWNODEID_SIU = 0 }
	List of CPU nodes addressable with LSW commands. More...
enum	_LSW_LSWDEST {   LSW_LSWDEST_CTDB = 0,   LSW_LSWDEST_SDI = 1 }
	Enumerate the possible destinations of a trace dump. More...
enum	_LSW_Apid64cFcodes {   LSW_NOOP_FCODE = 0,   LSW_DUMPSTART_FCODE = 1,   LSW_DUMPTRACEBYID_FCODE = 2,   LSW_DUMPTRACEBYNAME_FCODE = 3,   LSW_SETTRACECONFIG_FCODE = 4 }
	Function code enumerations for apid 0x64c. More...
Functions
unsigned int	LSW_Noop (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the Noop command.
unsigned int	LSW_DumpStart (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function to dump the start line system trace.
unsigned int	LSW_DumpTraceById (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function to dump the start line system trace.
unsigned int	LSW_DumpTraceByName (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function to dump the start line system trace.
unsigned int	LSW_SetTraceConfig (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function to dump the start line system trace.

---

Detailed Description

Structures associated with CCSDS commands to subsystem LSW \ This file was auto-generated on Tue 29 May 2007 05:23:17 PM PDT \ LCAT version: V1-21-4.

Warning:

Machine generated code - NEVER edit by hand

---

Enumeration Type Documentation

enum _LSW_Apid64cFcodes

Function code enumerations for apid 0x64c.

Enumerator:

LSW_NOOP_FCODE	APID 0x64c function code 0
LSW_DUMPSTART_FCODE	APID 0x64c function code 1
LSW_DUMPTRACEBYID_FCODE	APID 0x64c function code 2
LSW_DUMPTRACEBYNAME_FCODE	APID 0x64c function code 3
LSW_SETTRACECONFIG_FCODE	APID 0x64c function code 4

enum _LSW_LSWDEST

Enumerate the possible destinations of a trace dump.

Enumerator:

LSW_LSWDEST_CTDB	Command and telemetry data bus
LSW_LSWDEST_SDI	Science data interface

enum _LSW_LSWNODEID

List of CPU nodes addressable with LSW commands.

Enumerator:

LSW_LSWNODEID_EPU0	The EPU0 computer
LSW_LSWNODEID_EPU1	The EPU1 computer
LSW_LSWNODEID_EPU2	The EPU2 computer
LSW_LSWNODEID_EPU3	The EPU3 computer (external crate)
LSW_LSWNODEID_SIU	The SIU computer

---

Function Documentation

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

Callback function to dump the start line system trace.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

References _LSW_NODETRANID::bf, _LSW_DumpStart_Prm::dest, _LSW_DumpStart_Prm::flag, _LSW_DumpStart_Pkt::pay, and _LSW_NODETRANID::us.

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

Callback function to dump the start line system trace.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

References _LSW_NODETRANID::bf, _LSW_DumpTraceById_Prm::dest, _LSW_DumpTraceById_Prm::flag, _LSW_DumpTraceById_Prm::id, _LSW_DumpTraceById_Pkt::pay, and _LSW_NODETRANID::us.

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

Callback function to dump the start line system trace.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

References _LSW_NODETRANID::bf, _LSW_DumpTraceByName_Prm::dest, _LSW_DumpTraceByName_Prm::flag, _LSW_DumpTraceByName_Prm::name, _LSW_DumpTraceByName_Pkt::pay, and _LSW_NODETRANID::us.

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

Callback function for the Noop command.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

References _LSW_NODETRANID::bf, _LSW_Noop_Prm::flag, _LSW_Noop_Pkt::pay, and _LSW_NODETRANID::us.

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

Callback function to dump the start line system trace.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

References _LSW_NODETRANID::bf, _LSW_SetTraceConfig_Prm::flag, _LSW_SetTraceConfig_Prm::mask, _LSW_SetTraceConfig_Pkt::pay, _LSW_CONFIGBITS::ui, _LSW_NODETRANID::us, and _LSW_SetTraceConfig_Prm::valu.