MEM_dump_cmd.h File Reference

Interface to the MEM_dump_cmd.c functions. More...

#include <CLI/CLI_pubdefs.h>

Functions
void	MEM_dumpCancel (char *pkt)
	Dump the Memory Dump Cancel command.
void	MEM_dumpDump (char *pkt)
	Dump the Memory Data Dump command.
void	MEM_dumpDumpTlm (unsigned char *pay)
	Dump the Memory Dump telemetry.
void	MEM_dumpHouse (unsigned char *pay)
	Dump the MEM portion of the boot housekeeping telemetry.
void	MEM_dumpLoad (char *pkt)
	Dump the Memory Write command.
void	MEM_dumpPci (char *pkt)
	Dump the PCI Device Header Dump command.
void	MEM_dumpPciLoad (char *pkt)
	Dump the PCI Device Header Write command.
void	MEM_dumpPool (char *pkt)
	Dump the Memory Pool Status Dump command.
void	MEM_dumpPoolData (unsigned char *pay)
	Dump the Memory Pool Status telemetry.
void	MEM_dumpReg (char *pkt)
	Dump the Processor Register Dump command.
void	MEM_dumpRegLoad (char *pkt)
	Dump the Processor Register Write command.
void	MEM_dumpSymRel (char *pkt)
	Dump the Memory Dump Symbol Relative command.
void	MEM_dumpSymVal (char *pkt)
	Dump the Memory Symbol Lookup command.
void	MEM_dumpSymValData (unsigned char *pay)
	Dump the Memory Symbol Lookup telemetry.
unsigned int	MEM_dispatchTlm (void *prm, unsigned char *pkt)
	Dispatch routine for arriving housekeeping telemetry.
unsigned int	MEM_dispatchDumpTlm (void *prm, unsigned char *pkt)
	Dispatch routine for arriving dump data telemetry.
unsigned int	MEM_dispatchPoolDataTlm (void *prm, unsigned char *pkt)
	Dispatch routine for arriving memory pool data telemetry.
unsigned int	MEM_dispatchSsrTlm (void *prm, unsigned char *pkt)
	Dispatch routine for arriving SSR telemetry.
unsigned int	MEM_dispatchSymValTlm (void *prm, unsigned char *pkt)
	Dispatch routine for arriving symbol value telemetry.
int	MEM_setDumpDisplayLimit (int limit)
	Set the max number of words to display from a single dump.
unsigned int	MEM_addDumpSyntax (CLI_Syntax *syntax)
	Add MEM dump commands to the command-line syntax.

---

Detailed Description

Interface to the MEM_dump_cmd.c functions.

    CVS $Id: MEM_dump_cmd.h,v 1.9 2011/03/29 01:58:51 apw Exp $
    

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

---

Function Documentation

unsigned int MEM_addDumpSyntax

(

CLI_Syntax *

syntax

)

Add MEM dump commands to the command-line syntax.

Parameters:

syntax

Syntax handle.

Returns:

MSG code.

References MEM_setDumpDisplayLimit_cli().

Referenced by MEM_addSyntaxSCP().

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

Dispatch routine for arriving dump data telemetry.

Parameters:

	prm	(in) User context parameter
	pkt	(in) The CTDB received telemetry

Return values:

	MEM_SUCCESS	Success
	MEM_GENERROR	Failure

References MEM_dumpDumpTlm().

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

Dispatch routine for arriving memory pool data telemetry.

Parameters:

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

Returns:

MSG code.

References MEM_dumpPoolData().

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

Dispatch routine for arriving SSR telemetry.

Parameters:

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

Returns:

MSG code.

References QMEM_dump().

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

Dispatch routine for arriving symbol value telemetry.

Parameters:

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

Returns:

MSG code.

References MEM_dumpSymValData().

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

Dispatch routine for arriving housekeeping telemetry.

Parameters:

	prm	(in) User context parameter
	pkt	(in) The CTDB received telemetry

Return values:

	MEM_SUCCESS	Success
	MEM_GENERROR	Failure

References MEM_dumpHouse().

void MEM_dumpCancel

(

char *

pkt

)

Dump the Memory Dump Cancel command.

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

Parameters:

pkt

Pointer to CCSDS packet.

Returns:

Nothing.

References mem_dump_boilerplate(), and mem_dump_idents().

Referenced by MEM_sendCancel().

void MEM_dumpDump

(

char *

pkt

)

Dump the Memory Data Dump command.

Dumps the contents of a Memory Data 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 mem_dump_boilerplate(), mem_dump_dest(), mem_dump_idents(), and mem_dump_padding().

Referenced by MEM_sendDump(), and MEM_sendSsrDump().

void MEM_dumpDumpTlm

(

unsigned char *

pay

)

Dump the Memory Dump telemetry.

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

Parameters:

pay

Pointer to CCSDS packet.

Returns:

Nothing.

Referenced by MEM_dispatchDumpTlm().

void MEM_dumpLoad

(

char *

pkt

)

Dump the Memory Write command.

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

Parameters:

pkt

Pointer to CCSDS packet.

Returns:

Nothing.

References mem_dump_boilerplate(), mem_dump_data_32(), and mem_dump_idents().

Referenced by mem_load_buffer(), and MEM_sendLoad().

void MEM_dumpPci

(

char *

pkt

)

Dump the PCI Device Header Dump command.

Dumps the contents of a PCI Device Header 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 mem_dump_boilerplate(), mem_dump_idents(), and mem_dump_padding().

Referenced by MEM_sendPciDump().

void MEM_dumpPciLoad

(

char *

pkt

)

Dump the PCI Device Header Write command.

Dumps the contents of a PCI Device Header Write command packet. The fields of the payload are assumed to be in native byte order.

Parameters:

pkt

Pointer to CCSDS packet.

Returns:

Nothing.

References mem_dump_boilerplate(), and mem_dump_idents().

Referenced by MEM_sendPciLoad().

void MEM_dumpPool

(

char *

pkt

)

Dump the Memory Pool Status Dump command.

Dumps the contents of a Memory Pool Status 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 mem_dump_boilerplate(), mem_dump_idents(), and mem_interp_pool().

Referenced by MEM_sendPoolDump().

void MEM_dumpPoolData

(

unsigned char *

pay

)

Dump the Memory Pool Status telemetry.

Dumps the contents of a Memory Pool Status telemetry packet. The fields of the payload are assumed to be in native byte order.

Parameters:

pay

Pointer to CCSDS packet.

Returns:

Nothing.

References mem_dump_boilerplate(), mem_dump_idents(), mem_dump_padding(), and mem_interp_pool().

Referenced by MEM_dispatchPoolDataTlm().

void MEM_dumpReg

(

char *

pkt

)

Dump the Processor Register Dump command.

Dumps the contents of a Processor Register 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 mem_dump_boilerplate(), and mem_dump_idents().

Referenced by MEM_sendRegDump().

void MEM_dumpRegLoad

(

char *

pkt

)

Dump the Processor Register Write command.

Dumps the contents of a Processor Register Write command packet. The fields of the payload are assumed to be in native byte order.

Parameters:

pkt

Pointer to CCSDS packet.

Returns:

Nothing.

References mem_dump_boilerplate(), mem_dump_data_32(), and mem_dump_idents().

Referenced by MEM_sendRegLoad().

void MEM_dumpSymRel

(

char *

pkt

)

Dump the Memory Dump Symbol Relative command.

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

Parameters:

pkt

Pointer to CCSDS packet.

Returns:

Nothing.

References mem_dump_boilerplate(), mem_dump_data_ascii(), mem_dump_dest(), mem_dump_idents(), and mem_dump_padding().

Referenced by MEM_sendSymRelDump(), and MEM_sendSymRelSsrDump().

void MEM_dumpSymVal

(

char *

pkt

)

Dump the Memory Symbol Lookup command.

Dumps the contents of a Memory Symbol Lookup command packet. The fields of the payload are assumed to be in native byte order.

Parameters:

pkt

Pointer to CCSDS packet.

Returns:

Nothing.

References mem_dump_boilerplate(), mem_dump_data_ascii(), mem_dump_idents(), and mem_dump_padding().

Referenced by MEM_sendSymValDump().

void MEM_dumpSymValData

(

unsigned char *

pay

)

Dump the Memory Symbol Lookup telemetry.

Dumps the contents of a Memory Symbol Lookup telemetry packet. The fields of the payload are assumed to be in native byte order.

Parameters:

pay

Pointer to CCSDS packet.

Returns:

Nothing.

References mem_dump_boilerplate(), mem_dump_data_ascii(), mem_dump_idents(), and mem_dump_padding().

Referenced by MEM_dispatchSymValTlm().

int MEM_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 MEM_setDumpDisplayLimit_cli().