GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> MEM / V5-8-2 > mem_scp / mv2304

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » SVC » source » MEM » V5-8-2 » src

QMEM_dump.c File Reference

Display MEM package SSR datagrams. More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <LSF/LSF.h>
#include <LSF/LSF_ids.h>
#include <MEM/QMEM.h>

Classes

struct  _Qmem_Field
 Description of a datagram field. More...

Typedefs

typedef struct _Qmem_Field Qmem_Field
 Typedef for _Qmem_Field.

Functions

static void qmem_dump_boilerplate (char *dgm_name)
 Display some boilerplate header information.
static void qmem_dump_header (char *desc)
 Display some header information.
static void qmem_interp_ctb_type (unsigned int value)
 Interpret a contribution type field value.
static void qmem_interp_dec (unsigned int value)
 Interpret a field value as a decimal number.
static void qmem_interp_dgm_type (unsigned int value)
 Interpret a datagram type field value.
static void qmem_interp_dir (unsigned int value)
 Interpret a dir field value.
static void qmem_interp_extra (unsigned int value)
 Interpret an extra field value.
static void qmem_interp_lat_unit (unsigned int value)
 Interpret a lat_unit field value.
static void qmem_interp_length (unsigned int value)
 Interpret a length field value.
static void qmem_interp_spare (unsigned int value)
 Interpret a spare field value.
static void qmem_interp_u32 (unsigned int value)
 Interpret a 32-bit field value as an unsigned number.
static void qmem_show_field (unsigned char *buf_p, unsigned int start_byte, unsigned int end_byte, unsigned int start_bit, unsigned int end_bit, char *desc_p, void(*interp_p)(unsigned int val))
 Show a field from a buffer.
static unsigned int qmem_dump_fields (Qmem_Field *field_p, unsigned int num_fields, unsigned char *buf_p, unsigned int start_byte)
 Dump fields from a buffer.
static unsigned int qmem_dump_extra (unsigned char *buf_p, unsigned int buf_bytes, unsigned int offset)
 Dump extra data bytes.
static unsigned int qmem_dump_dgm_hdr (unsigned char *buf_p, unsigned int buf_bytes, unsigned int offset)
 Dump a datagram header.
static unsigned int qmem_dump_ctb_hdr (unsigned char *buf_p, unsigned int buf_bytes, unsigned int offset)
 Dump a contribution header.
static unsigned int qmem_dump_desc_ctb (unsigned char *buf_p, unsigned int buf_bytes, unsigned int offset)
 Dump a memory dump description contribution body.
static unsigned int qmem_dump_data_ctb (unsigned char *buf_p, unsigned int buf_bytes, unsigned int offset)
 Dump a memory dump data contribution body.
static unsigned int qmem_dump_ctb (unsigned char *buf_p, unsigned int buf_bytes, unsigned int offset)
 Dump a memory dump datagram contribution.
void QMEM_dump (char *buf_p, unsigned int buf_bytes)
 Dump a MEM package datagram.

Detailed Description

Display MEM package SSR datagrams. 

**  CVS $Id: QMEM_dump.c,v 1.2 2011/03/29 01:58:52 apw Exp $
**

These functions display the contents of SSR datagrams sent by the MEM package.

Function Documentation

void QMEM_dump ( char *  buf_p,
unsigned int  buf_bytes 
)

Dump a MEM package datagram.

Parameters:
buf_p Pointer to buffer containing the datagram.
buf_bytes Number of valid bytes in the buffer.
Returns:
Nothing.

References qmem_dump_ctb(), qmem_dump_dgm_hdr(), qmem_dump_extra(), and qmem_dump_header().

Referenced by MEM_dispatchSsrTlm().

void qmem_dump_boilerplate ( char *  dgm_name  )  [static]

Display some boilerplate header information.

Parameters:
dgm_name Datagram description string.
Returns:
Nothing.

Referenced by qmem_dump_dgm_hdr().

unsigned int qmem_dump_ctb ( unsigned char *  buf_p,
unsigned int  buf_bytes,
unsigned int  offset 
) [static]

Dump a memory dump datagram contribution.

Parameters:
buf_p Pointer to buffer containing the contribution.
buf_bytes Number of valid bytes within the buffer.
offset Starting byte offset within the buffer.
Returns:
Ending byte offset within the buffer.

References qmem_dump_ctb_hdr(), qmem_dump_data_ctb(), qmem_dump_desc_ctb(), qmem_dump_extra(), qmem_dump_header(), QMEM_ID_DATA, and QMEM_ID_DESC.

Referenced by QMEM_dump().

unsigned int qmem_dump_ctb_hdr ( unsigned char *  buf_p,
unsigned int  buf_bytes,
unsigned int  offset 
) [static]

Dump a contribution header.

Parameters:
buf_p Pointer to buffer containing the contribution header.
buf_bytes Number of valid bytes within the buffer.
offset Starting byte offset within the buffer.
Returns:
Ending byte offset within the buffer.

References qmem_dump_extra(), qmem_dump_fields(), qmem_dump_header(), qmem_interp_ctb_type(), qmem_interp_dec(), qmem_interp_dir(), qmem_interp_length(), and qmem_interp_spare().

Referenced by qmem_dump_ctb().

unsigned int qmem_dump_data_ctb ( unsigned char *  buf_p,
unsigned int  buf_bytes,
unsigned int  offset 
) [static]

Dump a memory dump data contribution body.

Parameters:
buf_p Pointer to buffer containing the contribution body.
buf_bytes Number of valid bytes within the buffer.
offset Starting byte offset within the buffer.
Returns:
Ending byte offset within the buffer.

References _Qmem_Field::num_bits, _Qmem_Field::num_bytes, qmem_dump_fields(), and qmem_dump_header().

Referenced by qmem_dump_ctb().

unsigned int qmem_dump_desc_ctb ( unsigned char *  buf_p,
unsigned int  buf_bytes,
unsigned int  offset 
) [static]

Dump a memory dump description contribution body.

Parameters:
buf_p Pointer to buffer containing the contribution body.
buf_bytes Number of valid bytes within the buffer.
offset Starting byte offset within the buffer.
Returns:
Ending byte offset within the buffer.

References qmem_dump_extra(), qmem_dump_fields(), qmem_dump_header(), qmem_interp_dec(), qmem_interp_lat_unit(), and qmem_interp_u32().

Referenced by qmem_dump_ctb().

unsigned int qmem_dump_dgm_hdr ( unsigned char *  buf_p,
unsigned int  buf_bytes,
unsigned int  offset 
) [static]

Dump a datagram header.

Parameters:
buf_p Pointer to buffer containing the datagram header.
buf_bytes Number of valid bytes within the buffer.
offset Starting byte offset within the buffer.
Returns:
Ending byte offset within the buffer.

References qmem_dump_boilerplate(), qmem_dump_extra(), qmem_dump_fields(), qmem_dump_header(), qmem_interp_dec(), qmem_interp_dgm_type(), qmem_interp_dir(), qmem_interp_length(), and qmem_interp_spare().

Referenced by QMEM_dump().

unsigned int qmem_dump_extra ( unsigned char *  buf_p,
unsigned int  buf_bytes,
unsigned int  offset 
) [static]

Dump extra data bytes.

Parameters:
buf_p Pointer to buffer containing the extra data.
buf_bytes Number of valid bytes within the buffer.
offset Starting byte offset within the buffer.
Returns:
Ending byte offset within the buffer.

References _Qmem_Field::num_bits, _Qmem_Field::num_bytes, qmem_dump_fields(), and qmem_interp_extra().

Referenced by QMEM_dump(), qmem_dump_ctb(), qmem_dump_ctb_hdr(), qmem_dump_desc_ctb(), and qmem_dump_dgm_hdr().

unsigned int qmem_dump_fields ( Qmem_Field *  field_p,
unsigned int  num_fields,
unsigned char *  buf_p,
unsigned int  start_byte 
) [static]

Dump fields from a buffer.

Parameters:
field_p Pointer to first field description.
num_fields Number of fields to dump.
buf_p Pointer to buffer.
start_byte Starting offset within the buffer.
Returns:
Ending offset within the buffer.

References _Qmem_Field::desc_p, _Qmem_Field::interp_p, _Qmem_Field::num_bits, _Qmem_Field::num_bytes, and qmem_show_field().

Referenced by qmem_dump_ctb_hdr(), qmem_dump_data_ctb(), qmem_dump_desc_ctb(), qmem_dump_dgm_hdr(), and qmem_dump_extra().

void qmem_dump_header ( char *  desc  )  [static]

Display some header information.

Parameters:
desc Header text string.
Returns:
Nothing.

Referenced by QMEM_dump(), qmem_dump_ctb(), qmem_dump_ctb_hdr(), qmem_dump_data_ctb(), qmem_dump_desc_ctb(), and qmem_dump_dgm_hdr().

void qmem_interp_ctb_type ( unsigned int  value  )  [static]

Interpret a contribution type field value.

Parameters:
value Value to interpret.
Returns:
Nothing

References QMEM_ID_DATA, and QMEM_ID_DESC.

Referenced by qmem_dump_ctb_hdr().

void qmem_interp_dec ( unsigned int  value  )  [static]

Interpret a field value as a decimal number.

Parameters:
value Value to interpret.
Returns:
Nothing

Referenced by qmem_dump_ctb_hdr(), qmem_dump_desc_ctb(), and qmem_dump_dgm_hdr().

void qmem_interp_dgm_type ( unsigned int  value  )  [static]

Interpret a datagram type field value.

Parameters:
value Value to interpret.
Returns:
Nothing

Referenced by qmem_dump_dgm_hdr().

void qmem_interp_dir ( unsigned int  value  )  [static]

Interpret a dir field value.

Parameters:
value Value to interpret.
Returns:
Nothing

Referenced by qmem_dump_ctb_hdr(), and qmem_dump_dgm_hdr().

void qmem_interp_extra ( unsigned int  value  )  [static]

Interpret an extra field value.

Parameters:
value Value to interpret.
Returns:
Nothing

Referenced by qmem_dump_extra().

void qmem_interp_lat_unit ( unsigned int  value  )  [static]

Interpret a lat_unit field value.

Parameters:
value Value to interpret.
Returns:
Nothing

Referenced by qmem_dump_desc_ctb().

void qmem_interp_length ( unsigned int  value  )  [static]

Interpret a length field value.

Parameters:
value Value to interpret.
Returns:
Nothing

Referenced by qmem_dump_ctb_hdr(), and qmem_dump_dgm_hdr().

void qmem_interp_spare ( unsigned int  value  )  [static]

Interpret a spare field value.

Parameters:
value Value to interpret.
Returns:
Nothing

Referenced by qmem_dump_ctb_hdr(), and qmem_dump_dgm_hdr().

void qmem_interp_u32 ( unsigned int  value  )  [static]

Interpret a 32-bit field value as an unsigned number.

Parameters:
value Value to interpret.
Returns:
Nothing

Referenced by qmem_dump_desc_ctb().

void qmem_show_field ( unsigned char *  buf_p,
unsigned int  start_byte,
unsigned int  end_byte,
unsigned int  start_bit,
unsigned int  end_bit,
char *  desc_p,
void(*)(unsigned int val)  interp_p 
) [static]

Show a field from a buffer.

Parameters:
buf_p Pointer to buffer.
start_byte First byte of the value within the buffer.
end_byte Last byte of the value within the buffer.
start_bit First bit of the field within the value.
end_bit Last bit of the field within the value.
desc_p Pointer to field description string.
interp_p Pointer to field interpretation function.
Returns:
Nothing.

Referenced by qmem_dump_fields().

Generated on Wed Nov 21 21:08:54 2012 by  doxygen 1.5.8