PBC_cmddefs.h File Reference

Structures associated with CCSDS commands to subsystem PBC \ This file was auto-generated on Tue May 17 10:04:45 2005 \ LCAT version: V1-4-0. More...

#include <PBI/Endianness.h>

Classes
struct	_PBC_CFLAGS32_Bfl
	32-Bit Boot Flags Bitfield More...
union	_PBC_CFLAGS32
	Union for command bitfield _PBC_CFLAGS32_Bfl. More...
struct	_PBC_CUNITBF_Bfl
	LAT Unit Bitfield. More...
union	_PBC_CUNITBF
	Union for command bitfield _PBC_CUNITBF_Bfl. More...
struct	_PBC_LBTSTART_Prm
	Boot code no-op \ APID 0x640 \ function code 0. More...
struct	_PBC_LBTRESET_Prm
	Warm reboot \ APID 0x640 \ function code 1. More...
struct	_PBC_LBTERRDUMP_Prm
	Error code pop \ APID 0x640 \ function code 2. More...
struct	_PBC_LBTRTOSEXEC_Prm
	Boot RTOS \ APID 0x640 \ function code 3. More...
struct	_PBC_LBTBAD_Prm
	Invalid boot command \ APID 0x640 \ function code 4. More...
struct	_PBC_LBTSTART_Pkt
	Boot code no-op \ APID 0x640 \ function code 0. More...
struct	_PBC_LBTRESET_Pkt
	Warm reboot \ APID 0x640 \ function code 1. More...
struct	_PBC_LBTERRDUMP_Pkt
	Error code pop \ APID 0x640 \ function code 2. More...
struct	_PBC_LBTRTOSEXEC_Pkt
	Boot RTOS \ APID 0x640 \ function code 3. More...
struct	_PBC_LBTBAD_Pkt
	Invalid boot command \ APID 0x640 \ function code 4. More...
Typedefs
typedef struct _PBC_CFLAGS32_Bfl	PBC_CFLAGS32_Bfl
	Typedef for command bitfield structure _PBC_CFLAGS32_Bfl.
typedef union _PBC_CFLAGS32	PBC_CFLAGS32
	Typedef for union _PBC_CFLAGS32.
typedef struct _PBC_CUNITBF_Bfl	PBC_CUNITBF_Bfl
	Typedef for command bitfield structure _PBC_CUNITBF_Bfl.
typedef union _PBC_CUNITBF	PBC_CUNITBF
	Typedef for union _PBC_CUNITBF.
typedef struct _PBC_LBTSTART_Prm	PBC_LBTSTART_Prm
	Typedef for structure _PBC_LBTSTART_Prm.
typedef struct _PBC_LBTRESET_Prm	PBC_LBTRESET_Prm
	Typedef for structure _PBC_LBTRESET_Prm.
typedef struct _PBC_LBTERRDUMP_Prm	PBC_LBTERRDUMP_Prm
	Typedef for structure _PBC_LBTERRDUMP_Prm.
typedef struct _PBC_LBTRTOSEXEC_Prm	PBC_LBTRTOSEXEC_Prm
	Typedef for structure _PBC_LBTRTOSEXEC_Prm.
typedef struct _PBC_LBTBAD_Prm	PBC_LBTBAD_Prm
	Typedef for structure _PBC_LBTBAD_Prm.
typedef struct _PBC_LBTSTART_Pkt	PBC_LBTSTART_Pkt
	Typedef for packet _PBC_LBTSTART_Pkt.
typedef struct _PBC_LBTRESET_Pkt	PBC_LBTRESET_Pkt
	Typedef for packet _PBC_LBTRESET_Pkt.
typedef struct _PBC_LBTERRDUMP_Pkt	PBC_LBTERRDUMP_Pkt
	Typedef for packet _PBC_LBTERRDUMP_Pkt.
typedef struct _PBC_LBTRTOSEXEC_Pkt	PBC_LBTRTOSEXEC_Pkt
	Typedef for packet _PBC_LBTRTOSEXEC_Pkt.
typedef struct _PBC_LBTBAD_Pkt	PBC_LBTBAD_Pkt
	Typedef for packet _PBC_LBTBAD_Pkt.
typedef enum _PBC_Apid640Fcodes	PBC_Apid640Fcodes
	Typedef for enumeration _PBC_Apid640Fcodes.
Enumerations
enum	_PBC_Apid640Fcodes {   PBC_LBTSTART_FCODE = 0,   PBC_LBTRESET_FCODE = 1,   PBC_LBTERRDUMP_FCODE = 2,   PBC_LBTRTOSEXEC_FCODE = 3,   PBC_LBTBAD_FCODE = 4 }
	Function code enumerations for apid 0x640. More...
Functions
unsigned int	PBC_LBTSTART (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Handle the Boot Start command.
unsigned int	PBC_LBTRESET (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Handle the Boot Reset command.
unsigned int	PBC_LBTERRDUMP (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Handle the Boot Error Dump command.
unsigned int	PBC_LBTRTOSEXEC (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Handle the Boot RTOS Execute command.
unsigned int	PBC_LBTBAD (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Handle the invalid Boot command (for testing purposes).

---

Detailed Description

Structures associated with CCSDS commands to subsystem PBC \ This file was auto-generated on Tue May 17 10:04:45 2005 \ LCAT version: V1-4-0.

Warning:

Machine generated code - NEVER edit by hand

---

Enumeration Type Documentation

enum _PBC_Apid640Fcodes

Function code enumerations for apid 0x640.

Enumerator:

PBC_LBTSTART_FCODE	APID 0x640 function code 0
PBC_LBTRESET_FCODE	APID 0x640 function code 1
PBC_LBTERRDUMP_FCODE	APID 0x640 function code 2
PBC_LBTRTOSEXEC_FCODE	APID 0x640 function code 3
PBC_LBTBAD_FCODE	APID 0x640 function code 4

---

Function Documentation

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

Handle the invalid Boot command (for testing purposes).

Parameters:

	prm	Pointer to a context parameter (unused).
	qitem	Pointer to queue item (unused).
	pay	Pointer to command payload.
	len	Length of the command payload, in bytes.

Returns:

MSG code.

References pbc_forward_cmd().

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

Handle the Boot Error Dump command.

Parameters:

	prm	Pointer to a context parameter (unused).
	qitem	Pointer to queue item (unused).
	pay	Pointer to command payload.
	len	Length of the command payload, in bytes.

Returns:

MSG code.

References pbc_forward_cmd().

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

Handle the Boot Reset command.

Parameters:

	prm	Pointer to a context parameter (unused).
	qitem	Pointer to queue item (unused).
	pay	Pointer to command payload.
	len	Length of the command payload, in bytes.

Returns:

MSG code.

References _PBC_LBTRESET_Prm::bootFlags, _PBC_LBTRESET_Pkt::pay, pbc_forward_cmd(), PBC_LBTRESET(), and _PBC_CFLAGS32::ui.

Referenced by PBC_LBTRESET().

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

Handle the Boot RTOS Execute command.

Parameters:

	prm	Pointer to a context parameter (unused).
	qitem	Pointer to queue item (unused).
	pay	Pointer to command payload.
	len	Length of the command payload, in bytes.

Returns:

MSG code.

References pbc_forward_cmd().

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

Handle the Boot Start command.

Parameters:

	prm	Pointer to a context parameter (unused).
	qitem	Pointer to queue item (unused).
	pay	Pointer to command payload.
	len	Length of the command payload, in bytes.

Returns:

MSG code.

References pbc_forward_cmd().