MEM_control.h File Reference

Interface to the MEM_control.c functions. More...

#include <ITC/ITC_pubdefs.h>
#include <MEM/MEM_cmddefs.h>
#include <MEM/MEM_dump.h>
#include <MEM/MEM_pubdefs.h>
#include <MEM/MEM_tlmdefs.h>
#include <PBS/FPA.h>
#include <PBS/MTX.h>
#include <PBS/WUT.h>

Classes
struct	_MEM_Control
	MEM control information block. More...
struct	_MEM_SDI_Tlm
	Format of memory dump data sent to the SDI. More...
union	_MEM_Cmd_Tlm
	Union of MEM command and telemetry packets. More...
Typedefs
typedef enum _MEM_Control_State	MEM_Control_State
	Typedef for _MEM_Control_State.
typedef struct _MEM_Control	MEM_Control
	Typedef for _MEM_Control.
typedef struct _MEM_SDI_Tlm	MEM_SDI_Tlm
	Typedef for _MEM_SDI_Tlm.
typedef union _MEM_Cmd_Tlm	MEM_Cmd_Tlm
	Typedef for _MEM_Cmd_Tlm.
Enumerations
enum	_MEM_Control_State {   MEM_STATE_UNINITIALIZED = 1 << 0,   MEM_STATE_INITIALIZING = 1 << 1,   MEM_STATE_INIT_FAIL = 1 << 2,   MEM_STATE_INITIALIZED = 1 << 3,   MEM_STATE_SHUTDOWN = 1 << 4,   MEM_STATE_SHUTDOWN_FAIL = 1 << 5 }
	MEM control state. More...
Functions
unsigned int	MEM_updateStats (MEM_Control *ctl_p, unsigned int msg_status, unsigned int fcode)
	Common routine to update MEM command statistics.
Variables
MEM_Control *	Mem_control_p
	Pointer to the MEM control information block.

---

Detailed Description

Interface to the MEM_control.c functions.

    CVS $Id: MEM_control.h,v 1.20 2011/03/29 01:58:52 apw Exp $
    

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

---

Enumeration Type Documentation

enum _MEM_Control_State

MEM control state.

Enumerator:

MEM_STATE_UNINITIALIZED	The MEM functions have not been initialized. Use MEM_initialize() to initialize them.
MEM_STATE_INITIALIZING	The MEM functions are in the process of being initialized by MEM_initialize().
MEM_STATE_INIT_FAIL	MEM_initialize() failed - use MEM_shutdown() to return to MEM_STATE_UNINITIALIZED.
MEM_STATE_INITIALIZED	The MEM functions have been initialized by MEM_initialize() and are ready to be used.
MEM_STATE_SHUTDOWN	The MEM functions are in the process of being shutdown by MEM_shutdown().
MEM_STATE_SHUTDOWN_FAIL	MEM_shutdown() failed - use MEM_shutdown() again to return to MEM_STATE_UNINITIALIZED.

---

Function Documentation

unsigned int MEM_updateStats	(	MEM_Control *	ctl_p,
		unsigned int	msg_status,
		unsigned int	fcode
	)

Common routine to update MEM command statistics.

Parameters:

	ctl_p	Pointer to MEM control block.
	msg_status	Status MSG code for the command.
	fcode	Function code for the command.

Returns:

MSG code.

References _MEM_Descriptor::addr, _MEM_Descriptor::bytes, _MEM_DumpInfo::current_addr, _MEM_Control::dump_active, _MEM_Info::dump_active, _MEM_Info::dump_addr, _MEM_Info::dump_bytes, _MEM_Control::dump_dest_nid, _MEM_Control::dump_fcode, _MEM_Info::dump_fcode, _MEM_Control::dump_handle, _MEM_Info::dump_start, _MEM_Info::dump_status, _MEM_Control::dump_tran_id, _MEM_Info::dump_tran_id, _MEM_Control::info, _MEM_LoadInfo::is_active, _MEM_Info::last_fcode, _MEM_Info::last_status, _MEM_Info::load_active, _MEM_Info::load_bytes, _MEM_Control::load_handle, _MEM_Info::load_offset, _MEM_Info::load_start, _MEM_Info::load_status, _MEM_DumpInfo::md, MEM_dumpGetInfo(), MEM_loadGetInfo(), mem_lock_access(), mem_unlock_access(), _MEM_LoadInfo::offset, _MEM_LoadInfo::start_addr, _MEM_DumpInfo::status, _MEM_LoadInfo::status, and _MEM_LoadInfo::total_bytes.

Referenced by mem_handle_dump(), MEM_initialize(), MEM_LMEMDUMPCANCEL(), MEM_LMEMDUMPNEXT(), MEM_LMEMDUMPPOOL(), MEM_LMEMDUMPSYMREL(), MEM_LMEMDUMPSYMVAL(), MEM_LMEMLOADMEM(), MEM_LMEMLOADPCI(), MEM_LMEMLOADREG(), MEM_LMEMNOOP(), and MEM_shutdown().

---

Variable Documentation

MEM_Control * Mem_control_p

Pointer to the MEM control information block.

Control block for MEM.

Pointer to the control block (state) for the MEM application-level functions.

Referenced by MEM_LMEMDUMPCANCEL(), MEM_LMEMDUMPMEM(), MEM_LMEMDUMPNEXT(), MEM_LMEMDUMPPCI(), MEM_LMEMDUMPPOOL(), MEM_LMEMDUMPREG(), MEM_LMEMDUMPSYMREL(), MEM_LMEMDUMPSYMVAL(), MEM_LMEMLOADMEM(), MEM_LMEMLOADPCI(), MEM_LMEMLOADREG(), and MEM_LMEMNOOP().