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

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » APP » source » LFS » V1-12-3 » src

LFS_lcp_private.h File Reference

Private definitions for the LFS LCP constituents. More...

#include <PBS/RW.ih>
#include <PBS/SEM.h>
#include <PBS/WUT.h>
#include <IMM/FPM_pubdefs.h>
#include <ITC/ITC_pubdefs.h>
#include <FILE_DB/FILE_DB_schema.h>

Classes

struct  _LFS_Control
 LFS LCP control block. More...

Defines

#define LFS_APID_CMD   0x648
#define LFS_APID_CRIT   0x649
#define LFS_FILE_DUMP_PARAM_SIZE   14

Typedefs

typedef enum _LFS_ControlState LFS_ControlState
 Typedef for enum _LFS_ControlState.
typedef struct _LFS_Control LFS_Control
 Typedef for structure _LFS_Control.

Enumerations

enum  _LFS_ControlState {
  LFS_CTL_UNINITIALIZED = 0,
  LFS_CTL_INITIALIZING = 1,
  LFS_CTL_DEINITIALIZING = 2,
  LFS_CTL_INITIALIZED = 3,
  LFS_CTL_STARTING = 4,
  LFS_CTL_RUNNING = 5,
  LFS_CTL_STOPPING = 6,
  LFS_CTL_BROKEN = 7
}
 Enumeration of LFS LCP control states. More...

Functions

unsigned int LFS_bootDumpFile (LFS_Control *ctl, unsigned int cpu, unsigned int fileNum, unsigned int xactId)
 Dump a TFFS boot partition file to the CTDB interface.
unsigned int LFS_bootDumpFileSSR (LFS_Control *ctl, unsigned int cpu, unsigned int fileNum, unsigned int xactId)
 Dump a TFFS boot partition file to the SSR interface.
unsigned int LFS_bootDumpDir (LFS_Control *ctl, unsigned int cpu, unsigned int xactId)
 Dump a TFFS boot directory.
void LFS_freeTelem (ITC_QueueItem *qitem, unsigned int status, LFS_Control *ctl, void *prm1, void *prm2)
 Free telemetry packet memory.
void LFS_freeTelemSSR (ITC_QueueItem *qitem, unsigned int status, LFS_Control *ctl, void *prm1, void *prm2)
 Free telemetry packet memory.
unsigned short LFS_apidMap (unsigned short itcNode)
 Translate an ITC node ID to a SSR science data file dump CCSDS APID.

Detailed Description

Private definitions for the LFS LCP constituents.

Author:
D.L. Wood

Define Documentation

#define LFS_APID_CMD   0x648

The telecommand APID to use for nominal LFS command packets.

#define LFS_APID_CRIT   0x649

The telecommand APID to use for critical LFS command packets.

#define LFS_FILE_DUMP_PARAM_SIZE   14

The number of bytes needed to hold the parameter section of a file dump data packet.

Referenced by LFS_bootDumpFile(), LFS_bootDumpRam(), and LFS_FileDumpCTDB().

Enumeration Type Documentation

enum _LFS_ControlState

Enumeration of LFS LCP control states.

Enumerator:
LFS_CTL_UNINITIALIZED  Uninitialized
LFS_CTL_INITIALIZING  Initializing
LFS_CTL_DEINITIALIZING  De-initializing
LFS_CTL_INITIALIZED  Initialized
LFS_CTL_STARTING  Starting
LFS_CTL_RUNNING  Running
LFS_CTL_STOPPING  Stopping
LFS_CTL_BROKEN  Broken (irrecoverable)

Function Documentation

unsigned short LFS_apidMap ( unsigned short  itcNode  ) 

Translate an ITC node ID to a SSR science data file dump CCSDS APID.

Translate an ITC node ID to a SSR science data file dump CCSDS APID.

Parameters:
itcNode The ITC node ID.
Returns:
The APID value.

References apidMap.

Referenced by LFS_bootDumpFileSSR(), LFS_bootDumpRamSSR(), and LFS_FileDumpSSR().

unsigned int LFS_bootDumpDir ( LFS_Control *  ctl,
unsigned int  cpu,
unsigned int  xactId 
)

Dump a TFFS boot directory.

Dumps the contents of a boot partition. For each valid file found in a TFFS boot partition (and PBC RAM buffers for RAD750 targets), one LLFSDIRLIST telemetry packet is sent to the CTDB interface.

Parameters:
ctl LFS control structure.
cpu The LAT CPU unit number.
xactId The transaction ID.
Returns:
A LFS MSG code.

References _LFS_Control::bnk_buf, FILE_NUM_EE0_RTOS, FILE_NUM_EE0_SBC_0, FILE_NUM_EE0_SBC_1, FILE_NUM_EE1_RTOS, FILE_NUM_EE1_SBC_0, FILE_NUM_EE1_SBC_1, and LFS_bootDumpEntry().

Referenced by LFS_DirDump().

unsigned int LFS_bootDumpFile ( LFS_Control *  ctl,
unsigned int  cpu,
unsigned int  fileNum,
unsigned int  xactId 
)

Dump a TFFS boot partition file to the CTDB interface.

Dumps the contents of a boot partition file. If the file header for the file storage location is valid, a series of LLFSDUMPCTDB telemetry packets containing the file data is sent to the CTDB interface.

Parameters:
ctl LFS control structure.
cpu The LAT CPU unit number.
fileNum The boot file number.
xactId The transaction ID.
Returns:
A LFS MSG code.

References _LFS_DUMPSTFLAGS::bf, _LFS_Control::bnk_buf, bootFileMap, _LFS_Control::config, _LFS_LLFSDUMPCTDB_Tlm::dmpFlags, _LFS_LLFSDUMPCTDB_Tlm::dmpSize, FILE_NUM_EE0_RTOS, FILE_NUM_EE0_SBC_0, FILE_NUM_EE0_SBC_1, FILE_NUM_EE1_RTOS, FILE_NUM_EE1_SBC_0, FILE_NUM_EE1_SBC_1, _LFS_LLFSDUMPCTDB_Tlm::fileData, _LFS_LLFSDUMPCTDB_Tlm::fileId, _LFS_LLFSDUMPCTDB_Tlm::fileOffset, _LFS_Control::hdr_buf, _LFS_Control::itc_hdr_size, LFS_bootDumpRam(), LFS_FILE_DUMP_PARAM_SIZE, LFS_freeTelem(), LFS_LLFSDUMPCTDB_TLM_APID, _LFS_Control::node_id, NUM_BOOT_FILE, _LFS_Control::telem_buf, _LFS_Control::telem_hdr_size, _LFS_Control::telem_pool, _LFS_Control::telem_sem, _LFS_FILESTID::ui, and _LFS_DUMPSTFLAGS::us.

Referenced by LFS_FileDumpCTDB().

unsigned int LFS_bootDumpFileSSR ( LFS_Control *  ctl,
unsigned int  cpu,
unsigned int  fileNum,
unsigned int  xactId 
)

Dump a TFFS boot partition file to the SSR interface.

Dumps the contents of a boot partition file. If the file header for the file storage location is valid, a series of QLFS datagrams embedded in telemetry packets containing the file data is sent to the SSR interface.

Parameters:
ctl LFS control structure.
cpu The LAT CPU unit number.
fileNum The boot file number.
xactId The transaction ID.
Returns:
A LFS MSG code.

References _LFS_Control::bnk_buf, bootFileMap, _LFS_Control::config, FILE_NUM_EE0_RTOS, FILE_NUM_EE0_SBC_0, FILE_NUM_EE0_SBC_1, FILE_NUM_EE1_RTOS, FILE_NUM_EE1_SBC_0, FILE_NUM_EE1_SBC_1, _LFS_Control::hdr_buf, _LFS_Control::itc_hdr_size, LFS_apidMap(), LFS_bootDumpRamSSR(), LFS_freeTelemSSR(), _LFS_Control::node_id, NUM_BOOT_FILE, _LFS_Control::telem_buf, _LFS_Control::telem_hdr_size, _LFS_Control::telem_pool, and _LFS_Control::telem_sem.

Referenced by LFS_FileDumpSSR().

void LFS_freeTelem ( ITC_QueueItem *  qitem,
unsigned int  status,
LFS_Control *  ctl,
void *  prm1,
void *  prm2 
)

Free telemetry packet memory.

Free memory after sending ITC telemetry packets. This is also used as a packet send completion callback.

Parameters:
qitem The memory buffer.
status Status of telemetry.
ctl LFS control structure.
prm1 Completion callback paramter 1.
prm2 Completion callback paramter 2.

References _LFS_Control::config, LFS_telemDelay(), _LFS_Control::node_id, _LFS_Control::telem_pool, _LFS_Control::telem_sem, and _LFS_Control::telem_timer.

Referenced by LFS_bootDumpEntry(), LFS_bootDumpFile(), LFS_bootDumpRam(), LFS_dirEmpty(), LFS_dumpDir(), LFS_dumpRoot(), LFS_FileDumpCTDB(), and LFS_SysStatus().

void LFS_freeTelemSSR ( ITC_QueueItem *  qitem,
unsigned int  status,
LFS_Control *  ctl,
void *  prm1,
void *  prm2 
)

Free telemetry packet memory.

Free memory after sending ITC telemetry packets to the SSR. This is also used as a packet send completion callback.

Parameters:
qitem The memory buffer.
status Status of telemetry.
ctl LFS control structure.
prm1 Completion callback paramter 1.
prm2 Completion callback paramter 2.

References _LFS_Control::telem_sem.

Referenced by LFS_bootDumpFileSSR(), LFS_bootDumpRamSSR(), and LFS_FileDumpSSR().

Generated on Wed Nov 21 21:50:01 2012 by  doxygen 1.5.8