GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > FILE / V3-11-0

Constituent: file_lcp     Tag: sun-gcc


Interface   Data Structures   File List   Data Fields   Globals  

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"

Include dependency graph for FILE_cmddefs.h:

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


Data Structures

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 _FILE_NODEPAD_Bfl FILE_NODEPAD_Bfl
 Typedef for command bitfield structure _FILE_NODEPAD_Bfl.
typedef _FILE_NODEPAD FILE_NODEPAD
 Typedef for union _FILE_NODEPAD.
typedef _FILE_UploadStart_Prm FILE_UploadStart_Prm
 Typedef for structure _FILE_UploadStart_Prm.
typedef _FILE_UploadCancel_Prm FILE_UploadCancel_Prm
 Typedef for structure _FILE_UploadCancel_Prm.
typedef _FILE_UploadCommit_Prm FILE_UploadCommit_Prm
 Typedef for structure _FILE_UploadCommit_Prm.
typedef _FILE_UploadData_Prm FILE_UploadData_Prm
 Typedef for structure _FILE_UploadData_Prm.
typedef _FILE_UploadEPU_Prm FILE_UploadEPU_Prm
 Typedef for structure _FILE_UploadEPU_Prm.
typedef _FILE_UploadStart_Pkt FILE_UploadStart_Pkt
 Typedef for packet _FILE_UploadStart_Pkt.
typedef _FILE_UploadCancel_Pkt FILE_UploadCancel_Pkt
 Typedef for packet _FILE_UploadCancel_Pkt.
typedef _FILE_UploadCommit_Pkt FILE_UploadCommit_Pkt
 Typedef for packet _FILE_UploadCommit_Pkt.
typedef _FILE_UploadData_Pkt FILE_UploadData_Pkt
 Typedef for packet _FILE_UploadData_Pkt.
typedef _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.

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.

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.

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.

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.


Generated on Wed Dec 5 08:23:49 2007 by  doxygen 1.4.4