GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > FILE / V3-9-4

Constituent: file_upl     Tag: rad750

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » SVC » source » FILE » V3-9-4 » src

FILE_upl.c File Reference

Function definitions for file upload state machine. More...

#include "string.h"
#include "CCSDS/CCSDS_pkt.h"
#include "MDB/MDB_pubdefs.h"
#include "ZLIB/zlib.h"
#include "PBS/RW.h"
#include "FBS/FBS_pubrtos.h"
#include "FILE/FILE_upl.h"
#include "FILE/FILE_upl_cmd.h"
#include "FILE/FILE_upl_msg.h"
#include "FILE_upl_private.h"

Include dependency graph for FILE_upl.c:


Functions

static unsigned int FILE_uplPktStart (FILE_Upl *upl, const unsigned char *pkt, unsigned short length)
static unsigned int FILE_uplPktData (FILE_Upl *upl, const unsigned char *pkt, unsigned short length)
static unsigned int FILE_uplPktCancel (FILE_Upl *upl, const unsigned char *pkt, unsigned short length)
static unsigned int FILE_uplPktCommit (FILE_Upl *upl, const unsigned char *pkt, unsigned short length)
static unsigned int FILE_uplVerify (FILE_Upl *upl, int validateOnly)
static unsigned int FILE_uplError (FILE_Upl *upl, unsigned int errCode, unsigned int errInfo)
FILE_Upl * FILE_uplGet (void)
 Get a pointer to the file upload state machine descriptor.
unsigned int FILE_uplInit (FILE_Upl *upl, void *fileBuf, unsigned int bufSize)
 Initialize the file upload state machine.
unsigned int FILE_uplExit (FILE_Upl *upl)
 Shutdown the file upload state machine.
unsigned int FILE_uplReset (FILE_Upl *upl)
 Reset the file upload state machine.
unsigned int FILE_uplInfo (FILE_Upl *upl, FILE_Upl_Info *info)
 Get information about the file upload current state.
unsigned int FILE_uplPkt (FILE_Upl *upl, const void *pkt, FILE_Upl_Info *info)
 Announce the arrival of a packet to the state machine.
unsigned int FILE_uplCommit (FILE_Upl *upl, unsigned int id, int validateOnly)
 Announce a file upload commit operation to the state machine.
unsigned int FILE_uplStart (FILE_Upl *upl, unsigned int size)
 Announce a file upload start operation to the state machine.
unsigned int FILE_uplData (FILE_Upl *upl, unsigned int offset, unsigned int size, const void *data)
 Announce a file upload next data operation to the state machine.
unsigned int FILE_uplCancel (FILE_Upl *upl)
 Announce a file upload cancel operation to the state machine.

Variables

static FILE_Upl uplDesc

Detailed Description

Function definitions for file upload state machine.

Author:
D.L. Wood

Function Documentation

unsigned int FILE_uplCancel (  FILE_Upl *  upl  ) 
 

Announce a file upload cancel operation to the state machine.

Announces the arrival of a new file upload File Upload Data telecommand to the file upload state machine.

Parameters:
upl The upload state machine descriptor.
Returns:
A FILE MSG code.

unsigned int FILE_uplCommit (  FILE_Upl *  upl,
unsigned int  id,
int  validateOnly
) 
 

Announce a file upload commit operation to the state machine.

PS

Prepares the file data in the upload buffer for writing to storage. Because the actual commit operation is environment specific, this function simple verifies that the file header information and file checksum are valid. Success will set the state of the file upload state machine to FILE_UPL_STATE_COMMIT. This is really a null state, and simply means that the user may now write the data in the upload buffer to storage. Call FILE_uplReset() when done to prepare the state machine for a new upload. The id_commit, and size_commit members are updated in the info structure.

Parameters:
upl The upload state machine descriptor.
id The file ID storage value.
validateOnly 0 = set state to FILE_UPL_STATE_ERROR if validation fails 1 = only return error code if validation fails
Returns:
A FILE MSG code.

unsigned int FILE_uplData (  FILE_Upl *  upl,
unsigned int  offset,
unsigned int  size,
const void *  data
) 
 

Announce a file upload next data operation to the state machine.

Announces the arrival of a new file upload File Upload Data telecommand to the file upload state machine.

Parameters:
upl The upload state machine descriptor.
offset The offset in bytes of the data from the beginning of the file.
size The size in bytes of the upload data.
data A pointer to the upload data.
Returns:
A FILE MSG code.

static unsigned int FILE_uplError (  FILE_Upl *  upl,
unsigned int  errCode,
unsigned int  errInfo
)  [static]
 

Records error information about file uploads.

Parameters:
upl The upload state machine descriptor.
errCode The FILE MSG code indicating the error.
errInfo Parameter value to use when reporting error.
Returns:
A FILE MSG code.

unsigned int FILE_uplExit (  FILE_Upl *  upl  ) 
 

Shutdown the file upload state machine.

Released resources allocated by the file upload state machine. Note that releasing the file upload assembly buffer passed in the call to FILE_uplInit() is the user's responsibility.

Parameters:
upl The upload state machine descriptor.
Returns:
A FILE MSG code.

FILE_Upl * FILE_uplGet (  void   ) 
 

Get a pointer to the file upload state machine descriptor.

Returns a pointer to the global file upload state machine descriptor.

Returns:
The upload state machine descriptor.

unsigned int FILE_uplInfo (  FILE_Upl *  upl,
FILE_Upl_Info *  info
) 
 

Get information about the file upload current state.

Returns information about the current file upload state.

Parameters:
upl The upload state machine descriptor.
info Filled in with current state info upon return.
Returns:
A FILE MSG code.

unsigned int FILE_uplInit (  FILE_Upl *  upl,
void *  fileBuf,
unsigned int  bufSize
) 
 

Initialize the file upload state machine.

Initializes the file upload state machine.

Parameters:
upl The upload state machine descriptor.
fileBuf A pointer to a buffer that the loader can use for assembly of complete files from packet data fragments.
bufSize The size in bytes of fileBuf. This is also the largest size for a file upload.
Returns:
A FILE MSG code.

unsigned int FILE_uplPkt (  FILE_Upl *  upl,
const void *  pkt,
FILE_Upl_Info *  info
) 
 

Announce the arrival of a packet to the state machine.

Announces the arrival of a new file upload telecommand CCSDS packet to the file upload state machine. On return, the state of the file upload, after processing the current packet, is given in info. If an error is encoutered, the upload state is set to FILE_UPL_STATE_ERROR.

Parameters:
upl The upload state machine descriptor.
pkt A pointer to the CCSDS file upload telecommand packet.
info Filled in with current state info upon return.
Returns:
A FILE MSG code.

static unsigned int FILE_uplPktCancel (  FILE_Upl *  upl,
const unsigned char *  pkt,
unsigned short  length
)  [static]
 

Announces the arrival of a new file upload File Upload Data telecommand CCSDS packet to the file upload state machine.

Parameters:
upl The upload state machine descriptor.
pkt A pointer to the CCSDS file upload telecommand packet.
length The size in bytes of the telecommand packet application data.
Returns:
A FILE MSG code.

static unsigned int FILE_uplPktCommit (  FILE_Upl *  upl,
const unsigned char *  pkt,
unsigned short  length
)  [static]
 

Prepares the file data in the upload buffer for writing to storage. Because the actual commit operation is environment specific, this function simple verifies that the file header information and file checksum are valid. Success will set the state of the file upload state machine to FILE_UPL_STATE_COMMIT. This is really a null state, and simply means that the user may now write the data in the upload buffer to storage. Call FILE_uplReset() when done to prepare the state machine for a new upload. The id_commit, and size_commit members are updated in the info structure.

Parameters:
upl The upload state machine descriptor.
pkt A pointer to the CCSDS file upload telecommand packet.
length The size in bytes of the telecommand packet application data.
Returns:
A FILE MSG code.

static unsigned int FILE_uplPktData (  FILE_Upl *  upl,
const unsigned char *  pkt,
unsigned short  length
)  [static]
 

Announces the arrival of a new file upload File Upload Data telecommand CCSDS packet to the file upload state machine.

Parameters:
upl The upload state machine descriptor.
pkt A pointer to the CCSDS file upload telecommand packet.
length The size in bytes of the telecommand packet application data.
Returns:
A FILE MSG code.

static unsigned int FILE_uplPktStart (  FILE_Upl *  upl,
const unsigned char *  pkt,
unsigned short  length
)  [static]
 

Announces the arrival of a new file upload File Upload Start telecommand CCSDS packet to the file upload state machine.

Parameters:
upl The upload state machine descriptor.
pkt A pointer to the CCSDS file upload telecommand packet.
length The size in bytes of the telecommand packet application data.
Returns:
A FILE MSG code.

unsigned int FILE_uplReset (  FILE_Upl *  upl  ) 
 

Reset the file upload state machine.

Resets the file upload state machine. All error conditions and previous file load state are cleared. A File Upload Start telecommand must be issued to start a new upload.

Parameters:
upl The upload state machine descriptor.
Returns:
A FILE MSG code.

unsigned int FILE_uplStart (  FILE_Upl *  upl,
unsigned int  size
) 
 

Announce a file upload start operation to the state machine.

Announces the arrival of a new file upload File Upload Start telecommand CCSDS packet to the file upload state machine.

Parameters:
upl The upload state machine descriptor.
size The maximum size in bytes of the upload data set.
Returns:
A FILE MSG code.

static unsigned int FILE_uplVerify (  FILE_Upl *  upl,
int  validateOnly
)  [static]
 

Verifies that the complete file data set has arrived correctly. The file header is examined for integrety, and the file data checksum is validated.

Parameters:
upl The upload state machine descriptor.
validateOnly 0 = set state to FILE_UPL_STATE_ERROR if validation fails 1 = only return error code if validation fails
Returns:
A FILE MSG code.

Variable Documentation

uplDesc [static]
 

Private data descriptor for file upload state machine.

Generated on Wed Jun 28 20:29:36 2006 by  doxygen 1.4.4