FILE_cmddefs.h File Reference

Structures associated with CCSDS commands to subsystem FILE \ This file was auto-generated on Fri 08 Sep 2006 12:20:29 PM PDT \ LCAT version: V1-16-0. More...

#include <PBI/Endianness.h>

Classes
struct	_FILE_NODEPAD_Bfl
	Compound of node ID and padding. More...
union	_FILE_NODEPAD
	Union for command bitfield _FILE_NODEPAD_Bfl. More...
struct	_FILE_UploadStart_Prm
	File Upload Start \ APID 0x641 \ function code 0. More...
struct	_FILE_UploadCancel_Prm
	File Upload Cancel \ APID 0x641 \ function code 1. More...
struct	_FILE_UploadCommit_Prm
	File Upload Commit \ APID 0x641 \ function code 2. More...
struct	_FILE_UploadData_Prm
	File Upload Data \ APID 0x641 \ function code 3. More...
struct	_FILE_UploadEPU_Prm
	File Upload to EPU \ APID 0x641 \ function code 4. More...
struct	_FILE_UploadStart_Pkt
	File Upload Start \ APID 0x641 \ function code 0. More...
struct	_FILE_UploadCancel_Pkt
	File Upload Cancel \ APID 0x641 \ function code 1. More...
struct	_FILE_UploadCommit_Pkt
	File Upload Commit \ APID 0x641 \ function code 2. More...
struct	_FILE_UploadData_Pkt
	File Upload Data \ APID 0x641 \ function code 3. More...
struct	_FILE_UploadEPU_Pkt
	File Upload to EPU \ APID 0x641 \ function code 4. More...
Typedefs
typedef enum _FILE_LFILENODEID	FILE_LFILENODEID
	Typedef for enumeration _FILE_LFILENODEID.
typedef struct _FILE_NODEPAD_Bfl	FILE_NODEPAD_Bfl
	Typedef for command bitfield structure _FILE_NODEPAD_Bfl.
typedef union _FILE_NODEPAD	FILE_NODEPAD
	Typedef for union _FILE_NODEPAD.
typedef struct _FILE_UploadStart_Prm	FILE_UploadStart_Prm
	Typedef for structure _FILE_UploadStart_Prm.
typedef struct _FILE_UploadCancel_Prm	FILE_UploadCancel_Prm
	Typedef for structure _FILE_UploadCancel_Prm.
typedef struct _FILE_UploadCommit_Prm	FILE_UploadCommit_Prm
	Typedef for structure _FILE_UploadCommit_Prm.
typedef struct _FILE_UploadData_Prm	FILE_UploadData_Prm
	Typedef for structure _FILE_UploadData_Prm.
typedef struct _FILE_UploadEPU_Prm	FILE_UploadEPU_Prm
	Typedef for structure _FILE_UploadEPU_Prm.
typedef struct _FILE_UploadStart_Pkt	FILE_UploadStart_Pkt
	Typedef for packet _FILE_UploadStart_Pkt.
typedef struct _FILE_UploadCancel_Pkt	FILE_UploadCancel_Pkt
	Typedef for packet _FILE_UploadCancel_Pkt.
typedef struct _FILE_UploadCommit_Pkt	FILE_UploadCommit_Pkt
	Typedef for packet _FILE_UploadCommit_Pkt.
typedef struct _FILE_UploadData_Pkt	FILE_UploadData_Pkt
	Typedef for packet _FILE_UploadData_Pkt.
typedef struct _FILE_UploadEPU_Pkt	FILE_UploadEPU_Pkt
	Typedef for packet _FILE_UploadEPU_Pkt.
typedef enum _FILE_Apid641Fcodes	FILE_Apid641Fcodes
	Typedef for enumeration _FILE_Apid641Fcodes.
Enumerations
enum	_FILE_LFILENODEID {   FILE_LFILENODEID_EPU0 = 1,   FILE_LFILENODEID_EPU1 = 2,   FILE_LFILENODEID_EPU2 = 3,   FILE_LFILENODEID_EPU3 = 4,   FILE_LFILENODEID_SIU = 0 }
	List of CPU nodes addressable with FILE commands. More...
enum	_FILE_Apid641Fcodes {   FILE_UPLOADSTART_FCODE = 0,   FILE_UPLOADCANCEL_FCODE = 1,   FILE_UPLOADCOMMIT_FCODE = 2,   FILE_UPLOADDATA_FCODE = 3,   FILE_UPLOADEPU_FCODE = 4 }
	Function code enumerations for apid 0x641. More...
Functions
unsigned int	FILE_UploadStart (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the LFILUPLSTART command.
unsigned int	FILE_UploadCancel (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the LFILUPLCANCEL command.
unsigned int	FILE_UploadCommit (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the LFILUPLCOMMIT command.
unsigned int	FILE_UploadData (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the LFILUPLDATA command.
unsigned int	FILE_UploadEPU (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the LFILUPLEPU command.

---

Detailed Description

Structures associated with CCSDS commands to subsystem FILE \ This file was auto-generated on Fri 08 Sep 2006 12:20:29 PM PDT \ LCAT version: V1-16-0.

Warning:

Machine generated code - NEVER edit by hand

---

Enumeration Type Documentation

enum _FILE_Apid641Fcodes

Function code enumerations for apid 0x641.

Enumerator:

FILE_UPLOADSTART_FCODE	APID 0x641 function code 0
FILE_UPLOADCANCEL_FCODE	APID 0x641 function code 1
FILE_UPLOADCOMMIT_FCODE	APID 0x641 function code 2
FILE_UPLOADDATA_FCODE	APID 0x641 function code 3
FILE_UPLOADEPU_FCODE	APID 0x641 function code 4

enum _FILE_LFILENODEID

List of CPU nodes addressable with FILE commands.

Enumerator:

FILE_LFILENODEID_EPU0	The EPU0 computer
FILE_LFILENODEID_EPU1	The EPU1 computer
FILE_LFILENODEID_EPU2	The EPU2 computer
FILE_LFILENODEID_EPU3	The EPU3 computer (external crate)
FILE_LFILENODEID_SIU	The SIU computer

---

Function Documentation

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

Callback function for the LFILUPLCANCEL command.

Passes the file upload cancel telecommand to the file upload state machine.

Parameters:

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

Returns:

A FILE MSG code.

References _FILE_NODEPAD::bf, _FILE_Control::cmd_hdr_size, FILE_uplPkt(), _FILE_UploadCancel_Prm::flag, _FILE_Control::node_id, _FILE_Control::upl, and _FILE_NODEPAD::us.

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

Callback function for the LFILUPLCOMMIT command.

After passing the file upload commit telecommand to the file upload state machine and verifying that the commit validation was successful, the requested file is created and the contents of the file upload buffer are written out.

Parameters:

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

Returns:

A FILE MSG code.

References _FILE_NODEPAD::bf, _FILE_Upl_Info::buf_addr, _FILE_Control::cmd_hdr_size, FILE_UPL_STATE_COMMIT, FILE_uplInfo(), FILE_uplPkt(), FILE_uplReset(), FILE_uplSetError(), _FILE_UploadCommit_Prm::fileFlags, _FILE_UploadCommit_Prm::fileId, _FILE_UploadCommit_Prm::flag, _FILE_Upl_Info::id_commit, _FILE_Control::node_id, _FILE_Control::path_str, _FILE_Upl_Info::size_commit, _FILE_Upl_Info::state, _FILE_Control::upl, and _FILE_NODEPAD::us.

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

Callback function for the LFILUPLDATA command.

Passes the file upload data telecommand to the file upload state machine.

Parameters:

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

Returns:

A FILE MSG code.

References _FILE_Control::cmd_hdr_size, FILE_uplPkt(), _FILE_UploadData_Prm::fileOffset, and _FILE_Control::upl.

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

Callback function for the LFILUPLEPU command.

Parameters:

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

Returns:

A FILE MSG code.

References _FILE_NODEPAD::bf, _FILE_Control::cmd_chksum_size, _FILE_Control::cmd_hdr_size, cmdFree(), _FILE_Control::config, _FILE_Control::epu_upl_buf, _FILE_Control::epu_upl_sem, FILE_APID_LAT_FILE_LOAD, FILE_UPLOADDATA_FCODE, FILE_UPLOADSTART_FCODE, _FILE_UploadData_Prm::fileData, _FILE_UploadEPU_Prm::fileId, _FILE_UploadData_Prm::fileOffset, _FILE_UploadStart_Prm::fileSize, _FILE_UploadEPU_Prm::flag, _FILE_Control::path_str, and _FILE_NODEPAD::us.

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

Callback function for the LFILUPLSTART command.

Passes the file upload start telecommand to the file upload state machine.

Parameters:

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

Returns:

A FILE MSG code.

References _FILE_Control::cmd_hdr_size, FILE_uplPkt(), _FILE_UploadStart_Prm::fileSize, and _FILE_Control::upl.