GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > PBC / V4-5-0

Constituent: pbc_bootshell     Tag: rad750

Interface   Data Structures   File List   Data Fields   Globals  

cmd_boot.c File Reference

More...

#include "PBC/PBC.h"
#include "bootshell.h"
#include "rom_defs.h"
#include "cmdtlm.h"
#include "pbc_sio.h"
#include "PBC/PBC_msgs.h"
#include "PBC/PBC_string.h"
#include "CCSDS/CCSDS_pkt.h"
#include "CCSDS/CCSDS_msg.h"
#include "BootDiagnostics.h"
#include "MSG/MSG_macdefs.h"

Include dependency graph for cmd_boot.c:

Include dependency graph

Functions

unsigned int pbc_VerifyCmdPktSize (const unsigned int pktSize, const unsigned int paramSize)
 Verify a command packet size.

unsigned int pbc_ProcessBootRtosExecute (const void *rtosExec, const unsigned int pktSize)
 Process LAT Boot RTOS execute telecommand.

unsigned int Pbc_ProcessLatBoot (const unsigned short apid, unsigned short funcCode, const void *latBoot, const unsigned int pktSize)
 Process LAT boot telecommands.

unsigned int PBC_LBTSTART (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 ITC callback for the Boot Start telecommand.

unsigned int PBC_LBTRESET (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 ITC callback for the Boot Reset telecommand.

unsigned int PBC_LBTERRDUMP (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 ITC callback for the Boot Error Dump telecommand.

unsigned int PBC_LBTRTOSEXEC (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 ITC callback for the Boot RTOS Execute telecommand.

unsigned int PBC_LBTBAD (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
 ITC callback for the Invalid Boot telecommand.

Detailed Description

Author:
Ray Caperoon
Date:
Thu Dec 18 07:30:31 2003
  CVS $Id: cmd_boot.c,v 1.7 2005/05/02 15:12:58 dmay Exp $

description...

Function Documentation

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

ITC callback for the Invalid Boot telecommand.

Callback function for ITC that handles the Invalid Boot telecommand.

Parameters:
prm Unused generic pointer parameter.
qitem Pointer to queue item from ITC.
pay Pointer to CCSDS packet containing the command.
len Length of the CCSDS packet, in bytes.
Returns:
A PBC MSG code.

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

ITC callback for the Boot Error Dump telecommand.

Callback function for ITC that handles the Boot Error Dump telecommand.

Parameters:
prm Unused generic pointer parameter.
qitem Pointer to queue item from ITC.
pay Pointer to CCSDS packet containing the command.
len Length of the CCSDS packet, in bytes.
Returns:
A PBC MSG code.

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

ITC callback for the Boot Reset telecommand.

Callback function for ITC that handles the Boot Reset telecommand.

Parameters:
prm Unused generic pointer parameter.
qitem Pointer to queue item from ITC.
pay Pointer to CCSDS packet containing the command.
len Length of the CCSDS packet, in bytes.
Returns:
A PBC MSG code.

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

ITC callback for the Boot RTOS Execute telecommand.

Callback function for ITC that handles the Boot RTOS Execute telecommand.

Parameters:
prm Unused generic pointer parameter.
qitem Pointer to queue item from ITC.
pay Pointer to CCSDS packet containing the command.
len Length of the CCSDS packet, in bytes.
Returns:
A PBC MSG code.

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

ITC callback for the Boot Start telecommand.

Callback function for ITC that handles the Boot Start telecommand.

Parameters:
prm Unused generic pointer parameter.
qitem Pointer to queue item from ITC.
pay Pointer to CCSDS packet containing the command.
len Length of the CCSDS packet, in bytes.
Returns:
A PBC MSG code.

unsigned int pbc_ProcessBootRtosExecute (  const void *  rtosExec,
const unsigned int  pktSize
)  [static]
 

Process LAT Boot RTOS execute telecommand.

This function will process LAT boot RTOS execute telecommands received by the LAT. Validates parameters of the command. If parameters are valid the secondary boot is executed.

Parameters:
rtosExec Contents of packet, including header.
pktSize Size of packet, including header.
Returns:
See return values of Pbc_ExecuteSecondary() for failures executing secondary.
Return values:
PBC_PKTSIZE pktSize was not correct.
PBC_BADPARM Bad parameter.

Here is the call graph for this function:

unsigned int Pbc_ProcessLatBoot (  const unsigned short  apid,
unsigned short  funcCode,
const void *  latBoot,
const unsigned int  pktSize
) 
 

Process LAT boot telecommands.

This function will process boot telecommands received by the LAT. Processing depends on function code.

Parameters:
apid Application ID, shall be PBC_APID_LAT_BOOT.
funcCode Function code of packet.
latBoot Contents of packet, including header.
pktSize size of packet, including header.
Return values:
PBC_SUCCESS Successful command processing.
PBC_CMDIGN Command ignored (consider this successful processing).
PBC_BADPID apid was not PBC_APID_LAT_BOOT.
PBC_NULLPTR pkt was NULL pointer.
PBC_PKTSIZE pktSize was not correct.
PBC_CMDBDFC Bad function code encountered.

Here is the call graph for this function:

unsigned int pbc_VerifyCmdPktSize (  const unsigned int  pktSize,
const unsigned int  paramSize
) 
 

Verify a command packet size.

This function combines some of the common work needed to check a command packet size. The parameter pktSize is the size of the packet as extracted from the command received on the command and telemetry interface. This is the size that is verified. The parameter paramSize is the expected size of the parameter region as defined by the packet application id and function code. The header size and checksum are accounted for in this funciton.

Parameters:
pktSize Size of packet extracted from command packet.
paramSize Expected size of parameter region
Return values:
PBC_SUCCESS pktSize was correct.
PBC_PKTSIZE pktSize was not correct.

Here is the call graph for this function:

Generated on Fri Jul 22 20:17:11 2005 by doxygen 1.3.3