GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LFS / V1-12-3 > lfs_lcp / rhel5-32


Interface   Data Structures   File List   Data Fields   Globals  

LFS_cmddefs.h File Reference

Structures associated with CCSDS commands to subsystem LFS \ This file was auto-generated on Mon Jul 30 10:45:58 2007 \ LCAT version: V1-21-8. More...

#include <PBI/Endianness.h>

Classes

struct  _LFS_NODEPAD_Bfl
 Compound of node ID and padding. More...
union  _LFS_NODEPAD
 Union for command bitfield _LFS_NODEPAD_Bfl. More...
struct  _LFS_NODETRANID_Bfl
 Compound of node and transaction ID. More...
union  _LFS_NODETRANID
 Union for command bitfield _LFS_NODETRANID_Bfl. More...
struct  _LFS_FileDelete_Prm
 File Delete \ APID 0x648 \ function code 0. More...
struct  _LFS_FileCopy_Prm
 File Copy Local \ APID 0x648 \ function code 1. More...
struct  _LFS_DirCreate_Prm
 Directory Create \ APID 0x648 \ function code 2. More...
struct  _LFS_DirDelete_Prm
 Directory Delete \ APID 0x648 \ function code 3. More...
struct  _LFS_FileDumpCTDB_Prm
 File Dump CTDB \ APID 0x648 \ function code 4. More...
struct  _LFS_DirDump_Prm
 Directory Dump \ APID 0x648 \ function code 5. More...
struct  _LFS_SysStatus_Prm
 File System Status \ APID 0x648 \ function code 6. More...
struct  _LFS_SysFormat_Prm
 File System Format \ APID 0x649 \ function code 0. More...
struct  _LFS_SysCheck_Prm
 File System Check \ APID 0x648 \ function code 7. More...
struct  _LFS_SysMount_Prm
 File System Mount \ APID 0x649 \ function code 1. More...
struct  _LFS_FileDumpSSR_Prm
 File Dump SSR \ APID 0x648 \ function code 8. More...
struct  _LFS_Noop_Prm
 LFS No-Op \ APID 0x648 \ function code 9. More...
struct  _LFS_SysRepair_Prm
 File System Repair \ APID 0x649 \ function code 2. More...
struct  _LFS_FileDelete_Pkt
 File Delete \ APID 0x648 \ function code 0. More...
struct  _LFS_FileCopy_Pkt
 File Copy Local \ APID 0x648 \ function code 1. More...
struct  _LFS_DirCreate_Pkt
 Directory Create \ APID 0x648 \ function code 2. More...
struct  _LFS_DirDelete_Pkt
 Directory Delete \ APID 0x648 \ function code 3. More...
struct  _LFS_FileDumpCTDB_Pkt
 File Dump CTDB \ APID 0x648 \ function code 4. More...
struct  _LFS_DirDump_Pkt
 Directory Dump \ APID 0x648 \ function code 5. More...
struct  _LFS_SysStatus_Pkt
 File System Status \ APID 0x648 \ function code 6. More...
struct  _LFS_SysFormat_Pkt
 File System Format \ APID 0x649 \ function code 0. More...
struct  _LFS_SysCheck_Pkt
 File System Check \ APID 0x648 \ function code 7. More...
struct  _LFS_SysMount_Pkt
 File System Mount \ APID 0x649 \ function code 1. More...
struct  _LFS_FileDumpSSR_Pkt
 File Dump SSR \ APID 0x648 \ function code 8. More...
struct  _LFS_Noop_Pkt
 LFS No-Op \ APID 0x648 \ function code 9. More...
struct  _LFS_SysRepair_Pkt
 File System Repair \ APID 0x649 \ function code 2. More...

Typedefs

typedef enum _LFS_LFSNODEID LFS_LFSNODEID
 Typedef for enumeration _LFS_LFSNODEID.
typedef struct _LFS_NODEPAD_Bfl LFS_NODEPAD_Bfl
 Typedef for command bitfield structure _LFS_NODEPAD_Bfl.
typedef union _LFS_NODEPAD LFS_NODEPAD
 Typedef for union _LFS_NODEPAD.
typedef struct _LFS_NODETRANID_Bfl LFS_NODETRANID_Bfl
 Typedef for command bitfield structure _LFS_NODETRANID_Bfl.
typedef union _LFS_NODETRANID LFS_NODETRANID
 Typedef for union _LFS_NODETRANID.
typedef struct _LFS_FileDelete_Prm LFS_FileDelete_Prm
 Typedef for structure _LFS_FileDelete_Prm.
typedef struct _LFS_FileCopy_Prm LFS_FileCopy_Prm
 Typedef for structure _LFS_FileCopy_Prm.
typedef struct _LFS_DirCreate_Prm LFS_DirCreate_Prm
 Typedef for structure _LFS_DirCreate_Prm.
typedef struct _LFS_DirDelete_Prm LFS_DirDelete_Prm
 Typedef for structure _LFS_DirDelete_Prm.
typedef struct
_LFS_FileDumpCTDB_Prm 
LFS_FileDumpCTDB_Prm
 Typedef for structure _LFS_FileDumpCTDB_Prm.
typedef struct _LFS_DirDump_Prm LFS_DirDump_Prm
 Typedef for structure _LFS_DirDump_Prm.
typedef struct _LFS_SysStatus_Prm LFS_SysStatus_Prm
 Typedef for structure _LFS_SysStatus_Prm.
typedef struct _LFS_SysFormat_Prm LFS_SysFormat_Prm
 Typedef for structure _LFS_SysFormat_Prm.
typedef struct _LFS_SysCheck_Prm LFS_SysCheck_Prm
 Typedef for structure _LFS_SysCheck_Prm.
typedef struct _LFS_SysMount_Prm LFS_SysMount_Prm
 Typedef for structure _LFS_SysMount_Prm.
typedef struct _LFS_FileDumpSSR_Prm LFS_FileDumpSSR_Prm
 Typedef for structure _LFS_FileDumpSSR_Prm.
typedef struct _LFS_Noop_Prm LFS_Noop_Prm
 Typedef for structure _LFS_Noop_Prm.
typedef struct _LFS_SysRepair_Prm LFS_SysRepair_Prm
 Typedef for structure _LFS_SysRepair_Prm.
typedef struct _LFS_FileDelete_Pkt LFS_FileDelete_Pkt
 Typedef for packet _LFS_FileDelete_Pkt.
typedef struct _LFS_FileCopy_Pkt LFS_FileCopy_Pkt
 Typedef for packet _LFS_FileCopy_Pkt.
typedef struct _LFS_DirCreate_Pkt LFS_DirCreate_Pkt
 Typedef for packet _LFS_DirCreate_Pkt.
typedef struct _LFS_DirDelete_Pkt LFS_DirDelete_Pkt
 Typedef for packet _LFS_DirDelete_Pkt.
typedef struct
_LFS_FileDumpCTDB_Pkt 
LFS_FileDumpCTDB_Pkt
 Typedef for packet _LFS_FileDumpCTDB_Pkt.
typedef struct _LFS_DirDump_Pkt LFS_DirDump_Pkt
 Typedef for packet _LFS_DirDump_Pkt.
typedef struct _LFS_SysStatus_Pkt LFS_SysStatus_Pkt
 Typedef for packet _LFS_SysStatus_Pkt.
typedef struct _LFS_SysFormat_Pkt LFS_SysFormat_Pkt
 Typedef for packet _LFS_SysFormat_Pkt.
typedef struct _LFS_SysCheck_Pkt LFS_SysCheck_Pkt
 Typedef for packet _LFS_SysCheck_Pkt.
typedef struct _LFS_SysMount_Pkt LFS_SysMount_Pkt
 Typedef for packet _LFS_SysMount_Pkt.
typedef struct _LFS_FileDumpSSR_Pkt LFS_FileDumpSSR_Pkt
 Typedef for packet _LFS_FileDumpSSR_Pkt.
typedef struct _LFS_Noop_Pkt LFS_Noop_Pkt
 Typedef for packet _LFS_Noop_Pkt.
typedef struct _LFS_SysRepair_Pkt LFS_SysRepair_Pkt
 Typedef for packet _LFS_SysRepair_Pkt.
typedef enum _LFS_Apid648Fcodes LFS_Apid648Fcodes
 Typedef for enumeration _LFS_Apid648Fcodes.
typedef enum _LFS_Apid649Fcodes LFS_Apid649Fcodes
 Typedef for enumeration _LFS_Apid649Fcodes.

Enumerations

enum  _LFS_LFSNODEID {
  LFS_LFSNODEID_EPU0 = 1,
  LFS_LFSNODEID_EPU1 = 2,
  LFS_LFSNODEID_EPU2 = 3,
  LFS_LFSNODEID_EPU3 = 4,
  LFS_LFSNODEID_SIU = 0
}
 List of CPU nodes addressable with LFS commands. More...
enum  _LFS_Apid648Fcodes {
  LFS_FILEDELETE_FCODE = 0,
  LFS_FILECOPY_FCODE = 1,
  LFS_DIRCREATE_FCODE = 2,
  LFS_DIRDELETE_FCODE = 3,
  LFS_FILEDUMPCTDB_FCODE = 4,
  LFS_DIRDUMP_FCODE = 5,
  LFS_SYSSTATUS_FCODE = 6,
  LFS_SYSCHECK_FCODE = 7,
  LFS_FILEDUMPSSR_FCODE = 8,
  LFS_NOOP_FCODE = 9
}
 Function code enumerations for apid 0x648. More...
enum  _LFS_Apid649Fcodes {
  LFS_SYSFORMAT_FCODE = 0,
  LFS_SYSMOUNT_FCODE = 1,
  LFS_SYSREPAIR_FCODE = 2
}
 Function code enumerations for apid 0x649. More...

Functions

unsigned int LFS_FileDelete (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSFILEDELETE command.
unsigned int LFS_FileCopy (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSFILECOPY command.
unsigned int LFS_DirCreate (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSDIRCREATE command.
unsigned int LFS_DirDelete (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSDIRDELETE command.
unsigned int LFS_FileDumpCTDB (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSFILEDUMPC command.
unsigned int LFS_DirDump (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSDIRDUMP command.
unsigned int LFS_SysStatus (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSSYSSTATUS command.
unsigned int LFS_SysFormat (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSSYSFORMAT command.
unsigned int LFS_SysCheck (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSSYSCHECK command.
unsigned int LFS_SysMount (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSSYSMOUNT command.
unsigned int LFS_FileDumpSSR (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSFILEDUMPS command.
unsigned int LFS_Noop (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSNOOP command.
unsigned int LFS_SysRepair (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 Callback function for the LFSSYSREPAIR command.


Detailed Description

Structures associated with CCSDS commands to subsystem LFS \ This file was auto-generated on Mon Jul 30 10:45:58 2007 \ LCAT version: V1-21-8.

Warning:
Machine generated code - NEVER edit by hand

Enumeration Type Documentation

Function code enumerations for apid 0x648.

Enumerator:
LFS_FILEDELETE_FCODE  APID 0x648 function code 0
LFS_FILECOPY_FCODE  APID 0x648 function code 1
LFS_DIRCREATE_FCODE  APID 0x648 function code 2
LFS_DIRDELETE_FCODE  APID 0x648 function code 3
LFS_FILEDUMPCTDB_FCODE  APID 0x648 function code 4
LFS_DIRDUMP_FCODE  APID 0x648 function code 5
LFS_SYSSTATUS_FCODE  APID 0x648 function code 6
LFS_SYSCHECK_FCODE  APID 0x648 function code 7
LFS_FILEDUMPSSR_FCODE  APID 0x648 function code 8
LFS_NOOP_FCODE  APID 0x648 function code 9

Function code enumerations for apid 0x649.

Enumerator:
LFS_SYSFORMAT_FCODE  APID 0x649 function code 0
LFS_SYSMOUNT_FCODE  APID 0x649 function code 1
LFS_SYSREPAIR_FCODE  APID 0x649 function code 2

List of CPU nodes addressable with LFS commands.

Enumerator:
LFS_LFSNODEID_EPU0  The EPU0 computer
LFS_LFSNODEID_EPU1  The EPU1 computer
LFS_LFSNODEID_EPU2  The EPU2 computer
LFS_LFSNODEID_EPU3  The EPU3 computer (external crate)
LFS_LFSNODEID_SIU  The SIU computer


Function Documentation

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

Callback function for the LFSDIRCREATE command.

After translating the target directory path, the directory is created.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_NODETRANID::bf, _LFS_Control::cmd_hdr_size, DIR_EXISTS, _LFS_DirCreate_Prm::fileId, _LFS_DirCreate_Prm::flag, MKDIR, _LFS_Control::node_id, _LFS_Control::path_str_0, _LFS_Control::path_str_1, and _LFS_NODETRANID::us.

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

Callback function for the LFSDIRDELETE command.

After translating the target directory path, the directory is deleted.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_NODETRANID::bf, _LFS_Control::cmd_hdr_size, _LFS_DirDelete_Prm::fileId, _LFS_DirDelete_Prm::flag, _LFS_Control::node_id, _LFS_Control::path_str_0, and _LFS_NODETRANID::us.

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

Callback function for the LFSDIRDUMP command.

The target directory is opened for reading, and either LFS_dumpDir() or LFS_dumpRoot() is called to generate the telemetry response diagnostic packets.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_NODETRANID::bf, _LFS_Control::cmd_hdr_size, _LFS_DirDump_Prm::fileId, _LFS_DirDump_Prm::flag, LFS_bootDumpDir(), LFS_dumpDir(), LFS_dumpRoot(), _LFS_Control::node_id, _LFS_Control::path_str_0, and _LFS_NODETRANID::us.

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

Callback function for the LFSFILECOPY command.

After translating the file system paths, the source file contents are copied to the destination file.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_NODETRANID::bf, _LFS_Control::cmd_hdr_size, _LFS_Control::config, _LFS_Control::copy_buf, CREAT, _LFS_FileCopy_Prm::destFileId, _LFS_FileCopy_Prm::flag, _LFS_Control::node_id, _LFS_Control::path_str_0, _LFS_Control::path_str_1, _LFS_FileCopy_Prm::srcFileId, and _LFS_NODETRANID::us.

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

Callback function for the LFSFILEDELETE command.

After translating the target file path, the file is deleted.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_NODETRANID::bf, _LFS_Control::cmd_hdr_size, _LFS_FileDelete_Prm::fileId, _LFS_FileDelete_Prm::flag, _LFS_Control::node_id, _LFS_Control::path_str_0, and _LFS_NODETRANID::us.

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

Callback function for the LFSFILEDUMPC command.

After translating the file ID to a path, the file is opened for reading and a series of LLFSDUMPCTDB telemetry packets is generated. Each telemetry packet contains a portion of the file data, and the offset and size members provide the attributes of the data contained in each packet. These telemetry packets are delivered to the CTDB interface.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_DUMPSTFLAGS::bf, _LFS_NODETRANID::bf, _LFS_Control::cmd_hdr_size, _LFS_Control::config, _LFS_LLFSDUMPCTDB_Tlm::dmpFlags, _LFS_LLFSDUMPCTDB_Tlm::dmpSize, _LFS_LLFSDUMPCTDB_Tlm::fileData, _LFS_LLFSDUMPCTDB_Tlm::fileId, _LFS_FileDumpCTDB_Prm::fileId, _LFS_LLFSDUMPCTDB_Tlm::fileOffset, _LFS_FileDumpCTDB_Prm::flag, _LFS_Control::itc_hdr_size, LFS_bootDumpFile(), LFS_FILE_DUMP_PARAM_SIZE, LFS_freeTelem(), LFS_LLFSDUMPCTDB_TLM_APID, _LFS_Control::node_id, _LFS_Control::path_str_0, _LFS_Control::telem_buf, _LFS_Control::telem_hdr_size, _LFS_Control::telem_pool, _LFS_Control::telem_sem, _LFS_FILESTID::ui, _LFS_DUMPSTFLAGS::us, and _LFS_NODETRANID::us.

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

Callback function for the LFSFILEDUMPS command.

After translating the file ID to a path, the file is opened for reading and a series of LLFSDUMPSSR telemetry packets is generated. Each telemetry packet contains a portion of the file data, and the offset and size members provide the attributes of the data contained in each packet. These telemetry packets are delivered to the SSR interface. Each telemetry packet contains one QLFS datagram.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_NODETRANID::bf, _LFS_Control::cmd_hdr_size, _LFS_Control::config, _LFS_FileDumpSSR_Prm::fileId, _LFS_FileDumpSSR_Prm::flag, _LFS_Control::itc_hdr_size, LFS_apidMap(), LFS_bootDumpFileSSR(), LFS_freeTelemSSR(), _LFS_Control::node_id, _LFS_Control::path_str_0, _LFS_Control::telem_buf, _LFS_Control::telem_hdr_size, _LFS_Control::telem_sem, and _LFS_NODETRANID::us.

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

Callback function for the LFSNOOP command.

Do nothing except generate command confirm reply.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_NODEPAD::bf, _LFS_Control::cmd_hdr_size, _LFS_Noop_Prm::flag, _LFS_Control::node_id, and _LFS_NODEPAD::us.

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

Callback function for the LFSSYSCHECK command.

Consistency check an on-board file system by running the 'chkdsk' utility.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_NODEPAD::bf, _LFS_Control::cmd_hdr_size, _LFS_SysCheck_Prm::fileID, _LFS_SysCheck_Prm::flag, _LFS_Control::node_id, and _LFS_NODEPAD::us.

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

Callback function for the LFSSYSFORMAT command.

Re-format an on-board file system. This is potentially dangerous.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_NODEPAD::bf, _LFS_Control::cmd_hdr_size, _LFS_SysFormat_Prm::fileID, _LFS_SysFormat_Prm::flag, _LFS_Control::node_id, _LFS_SysFormat_Prm::sysOffset, and _LFS_NODEPAD::us.

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

Callback function for the LFSSYSMOUNT command.

Manually mount an on-board file system.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_NODEPAD::bf, _LFS_Control::cmd_hdr_size, _LFS_SysMount_Prm::fileID, _LFS_SysMount_Prm::flag, _LFS_Control::node_id, and _LFS_NODEPAD::us.

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

Callback function for the LFSSYSREPAIR command.

Repair an on-board file system by running the 'chkdsk' utility with the repair flag set to true.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_NODEPAD::bf, _LFS_Control::cmd_hdr_size, _LFS_SysRepair_Prm::fileID, _LFS_SysRepair_Prm::flag, _LFS_Control::node_id, and _LFS_NODEPAD::us.

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

Callback function for the LFSSYSSTATUS command.

After the target file system status is obtained from the system, a single LLFSSYSREPORT telemetry packet is generated to report the results.

Parameters:
prm User context parameter
qitem Queue item
pay Payload pointer
len Payload length
Returns:
A LFS MSG code.

References _LFS_DUMPSTFLAGS::bf, _LFS_NODETRANID::bf, _LFS_LLFSSYSLIST_Tlm::blkFree, _LFS_LLFSSYSLIST_Tlm::blkSize, _LFS_LLFSSYSLIST_Tlm::blkTotal, _LFS_Control::cmd_hdr_size, _LFS_LLFSSYSLIST_Tlm::dmpFlags, _LFS_LLFSSYSLIST_Tlm::fileId, _LFS_SysStatus_Prm::fileId, _LFS_SysStatus_Prm::flag, _LFS_Control::itc_hdr_size, LFS_freeTelem(), LFS_LLFSSYSLIST_TLM_APID, _LFS_Control::node_id, _LFS_Control::path_str_0, STATFS, _LFS_Control::telem_buf, _LFS_Control::telem_hdr_size, _LFS_Control::telem_pool, _LFS_Control::telem_sem, _LFS_FILESTID::ui, _LFS_DUMPSTFLAGS::us, and _LFS_NODETRANID::us.


Generated on Tue Nov 29 20:40:19 2011 by  doxygen 1.5.8