PBC_scpside.h File Reference

Interface to the PBC_scpside.c functions. More...

#include <CLI/CLI_pubdefs.h>

Functions
unsigned int	PBC_dispatchTlm (void *prm, unsigned char *pkt)
	Dispatch routine for arriving boot housekeeping telemetry.
unsigned int	PBC_sendBoot (unsigned short unit, unsigned short rtos, unsigned short ssb0, unsigned short ssb1)
	Send the Boot RTOS Execute command.
unsigned int	PBC_sendErrDump (unsigned short unit)
	Send the Boot Error Dump command.
unsigned int	PBC_sendReset (unsigned short unit, unsigned int flags)
	Send the Boot Reset command.
unsigned int	PBC_sendStart (unsigned short unit)
	Send the Boot Start command.
int	PBC_setDisplayLevelCmd (int level)
	Set the verbosity level of the PBC command display.
int	PBC_setDisplayLevelTlm (int level)
	Set the verbosity level of the PBC telemetry display.
int	PBC_setDisplayThrottleTlm (int enable)
	Set the throttle flag for the PBC telemetry display.
unsigned int	PBC_addSyntaxSCP (CLI_Syntax *syntax)
	Add PBC commands to the command-line syntax.

---

Detailed Description

Interface to the PBC_scpside.c functions.

    CVS $Id: PBC_scpside.h,v 1.8 2011/03/29 23:14:58 apw Exp $
    

Defines the interface to the functions found in PBC_scpside.c.

---

Function Documentation

unsigned int PBC_addSyntaxSCP

(

CLI_Syntax *

syntax

)

Add PBC commands to the command-line syntax.

Parameters:

syntax

Syntax handle.

Returns:

MSG code.

References PBC_sendBoot_cli(), PBC_sendErrDump_cli(), PBC_sendReset_cli(), PBC_sendStart_cli(), PBC_setDisplayLevelCmd_cli(), PBC_setDisplayLevelTlm_cli(), and PBC_setDumpDisplayLimit_cli().

unsigned int PBC_dispatchTlm	(	void *	prm,
		unsigned char *	pkt
	)

Dispatch routine for arriving boot housekeeping telemetry.

Parameters:

	prm	User parameter (unused).
	pkt	Pointer to CCSDS packet.

Returns:

MSG code.

References _PBC_LBTHKP_Tlm::bootSoftwareMode, _PBC_LBTHKP_Tlm::bootType, _PBC_LBTHKP_Tlm::errorWord, _PBC_LBTHKP_Tlm::fileUploadPktCnt, _PBC_LBTHKP_Tlm::fileUploadState, _PBC_LBTHKP_Tlm::lastCommand, _PBC_LBTHKP_Tlm::latestErrorWord, _PBC_LBTHKP_Tlm::memDumpAddress, _PBC_LBTHKP_Tlm::memDumpData, _PBC_LBTHKP_Tlm::memDumpWordCount, PBC_dumpHouse(), PBC_dumpHouseBgHigh(), PBC_dumpHouseBgLow(), PBC_dumpHouseData(), _PBC_LBTHKP_Tlm::queuedErrorCount, _PBC_LBTHKP_Tlm::scrubAddrHi, _PBC_LBTHKP_Tlm::tcPktAcceptCount, _PBC_LBTHKP_Tlm::tcPktReceiveCount, _PBC_LBTHKP_Tlm::tcPktScCount, _PBC_LBTHKP_Tlm::tcPktUnsupportCount, _PBC_LBTHKP_Tlm::totalErrorCount, and _PBC_BOOTCOMMAND::us.

unsigned int PBC_sendBoot	(	unsigned short	unit,
		unsigned short	rtos,
		unsigned short	ssb0,
		unsigned short	ssb1
	)

Send the Boot RTOS Execute command.

Parameters:

	unit	LAT unit to receive the command (0 => SIU, 1 => EPU0, ...).
	rtos	Location of RTOS (0 => RAM, 1 => EE lower, 2 => EE upper).
	ssb0	Location of SBC module 0 (0 => RAM, 1 => EE lower, ...).
	ssb1	Location of SBC module 1 (0 => RAM, 1 => EE lower, ...).

Returns:

MSG code.

References PBC_dumpBoot(), and pbc_send_command().

Referenced by PBC_sendBoot_cli().

unsigned int PBC_sendErrDump

(

unsigned short

unit

)

Send the Boot Error Dump command.

Parameters:

unit

LAT unit to receive the command (0 => SIU, 1 => EPU0, ...).

Returns:

MSG code.

References PBC_dumpErrDump(), and pbc_send_command().

Referenced by PBC_sendErrDump_cli().

unsigned int PBC_sendReset	(	unsigned short	unit,
		unsigned int	flags
	)

Send the Boot Reset command.

Parameters:

	unit	LAT unit to receive the command (0 => SIU, 1 => EPU0, ...).
	flags	Primary boot flags.

Returns:

MSG code.

References PBC_dumpReset(), and pbc_send_command().

Referenced by PBC_sendReset_cli().

unsigned int PBC_sendStart

(

unsigned short

unit

)

Send the Boot Start command.

Parameters:

unit

LAT unit to receive the command (0 => SIU, 1 => EPU0, ...).

Returns:

MSG code.

References PBC_dumpStart(), and pbc_send_command().

Referenced by PBC_sendStart_cli().

int PBC_setDisplayLevelCmd

(

int

level

)

Set the verbosity level of the PBC command display.

Parameters:

level

Level of verbosity - set higher to display more.

Returns:

Previous verbosity level.

Referenced by PBC_setDisplayLevelCmd_cli().

int PBC_setDisplayLevelTlm

(

int

level

)

Set the verbosity level of the PBC telemetry display.

Parameters:

level

Level of verbosity - set higher to display more.

Returns:

Previous verbosity level.

Referenced by PBC_setDisplayLevelTlm_cli().

int PBC_setDisplayThrottleTlm

(

int

enable

)

Set the throttle flag for the PBC telemetry display.

Parameters:

enable

Enable flag - set to nonzero to enable throttling.

Returns:

Previous throttle flag value.