PBC_dump.h File Reference

Interface to the PBC_dump.c functions. More...

Functions
void	PBC_dumpBoot (char *pkt)
	Dump the Boot RTOS Execute command.
void	PBC_dumpErrDump (char *pkt)
	Dump the Boot Error Dump command.
void	PBC_dumpHouse (unsigned char *pkt, unsigned char *prev_pkt)
	Dump boot housekeeping telemetry.
void	PBC_dumpHouseBgLow (unsigned char *pkt, unsigned char *prev_pkt)
	Dump first 64 bytes of background dump data.
void	PBC_dumpHouseBgHigh (unsigned char *pkt, unsigned char *prev_pkt)
	Dump last 64 bytes of background dump data.
void	PBC_dumpHouseData (unsigned char *pkt)
	Dump the memory data portion of boot housekeeping telemetry.
void	PBC_dumpReset (char *pkt)
	Dump the Boot Reset command.
void	PBC_dumpStart (char *pkt)
	Dump the Boot Start command.
int	PBC_setDumpDisplayLimit (int limit)
	Set the max number of words to display from a single dump.

---

Detailed Description

Interface to the PBC_dump.c functions.

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

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

---

Function Documentation

void PBC_dumpBoot

(

char *

pkt

)

Dump the Boot RTOS Execute command.

Dumps the contents of a Boot RTOS Execute command packet. The fields of the payload are assumed to be in native byte order.

Parameters:

pkt

Pointer to CCSDS packet.

Returns:

Nothing.

References pbc_dump_boilerplate(), pbc_dump_padding(), pbc_dump_unit(), and pbc_interp_source().

Referenced by PBC_sendBoot().

void PBC_dumpErrDump

(

char *

pkt

)

Dump the Boot Error Dump command.

Dumps the contents of a Boot Error Dump command packet. The fields of the payload are assumed to be in native byte order.

Parameters:

pkt

Pointer to CCSDS packet.

Returns:

Nothing.

References pbc_dump_boilerplate(), and pbc_dump_unit().

Referenced by PBC_sendErrDump().

void PBC_dumpHouse	(	unsigned char *	pkt,
		unsigned char *	prev_pkt
	)

Dump boot housekeeping telemetry.

Dumps the contents of a Boot Housekeeping telemetry packet. The fields of the payload are assumed to be in native byte order.

Parameters:

	pkt	Pointer to CCSDS packet.
	prev_pkt	Pointer to previous boot hkp telemetry CCSDS packet.

Returns:

Nothing.

References PBC_APID_TLM_EPU0, PBC_APID_TLM_EPU1, PBC_APID_TLM_EPU2, PBC_APID_TLM_SIU, pbc_dump_house_fields(), pbc_interp_boot_mode(), pbc_interp_boot_type(), pbc_interp_dump_addr(), pbc_interp_err_word(), pbc_interp_hex(), pbc_interp_qerr_count(), and pbc_interp_upl_state().

Referenced by PBC_dispatchTlm().

void PBC_dumpHouseBgHigh	(	unsigned char *	pkt,
		unsigned char *	prev_pkt
	)

Dump last 64 bytes of background dump data.

Dumps the contents of the last 64 bytes of the background dump data found in the Boot Housekeeping telemetry packet. The data is assumed to be in native byte order.

Parameters:

	pkt	Pointer to CCSDS packet.
	prev_pkt	Pointer to previous boot hkp telemetry CCSDS packet.

Returns:

Nothing.

References PBC_APID_TLM_EPU0, PBC_APID_TLM_EPU1, PBC_APID_TLM_EPU2, PBC_APID_TLM_SIU, and pbc_dump_house_fields().

Referenced by PBC_dispatchTlm().

void PBC_dumpHouseBgLow	(	unsigned char *	pkt,
		unsigned char *	prev_pkt
	)

Dump first 64 bytes of background dump data.

Dumps the contents of the first 64 bytes of the background dump data found in the Boot Housekeeping telemetry packet. The data is assumed to be in native byte order.

Parameters:

	pkt	Pointer to CCSDS packet.
	prev_pkt	Pointer to previous boot hkp telemetry CCSDS packet.

Returns:

Nothing.

References PBC_APID_TLM_EPU0, PBC_APID_TLM_EPU1, PBC_APID_TLM_EPU2, PBC_APID_TLM_SIU, pbc_dump_house_fields(), pbc_interp_byte_sel(), pbc_interp_enabled(), pbc_interp_exc_vector(), pbc_interp_failed(), pbc_interp_ram_test(), pbc_interp_reset_cause(), pbc_interp_reset_source(), pbc_interp_source(), pbc_interp_spare(), pbc_interp_test_result(), and pbc_interp_yes_no().

Referenced by PBC_dispatchTlm().

void PBC_dumpHouseData

(

unsigned char *

pkt

)

Dump the memory data portion of boot housekeeping telemetry.

Dumps the memory data dump portion of a boot housekeeping telemetry packet.

Parameters:

pkt

Pointer to CCSDS packet.

Returns:

Nothing.

Referenced by PBC_dispatchTlm().

void PBC_dumpReset

(

char *

pkt

)

Dump the Boot Reset command.

Dumps the contents of a Boot Reset command packet. The fields of the payload are assumed to be in native byte order.

Parameters:

pkt

Pointer to CCSDS packet.

Returns:

Nothing.

References pbc_dump_boilerplate(), pbc_dump_padding(), and pbc_dump_unit().

Referenced by PBC_sendReset().

void PBC_dumpStart

(

char *

pkt

)

Dump the Boot Start command.

Dumps the contents of a Boot Start command packet. The fields of the payload are assumed to be in native byte order.

Parameters:

pkt

Pointer to CCSDS packet.

Returns:

Nothing.

References pbc_dump_boilerplate(), and pbc_dump_unit().

Referenced by PBC_sendStart().

int PBC_setDumpDisplayLimit

(

int

limit

)

Set the max number of words to display from a single dump.

Parameters:

limit

Max number of words to display.

Returns:

Previous limit value.

Referenced by PBC_setDumpDisplayLimit_cli().