---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > IMM / V0-0-2

Constituent: imm     Tag: linux-gcc

---

         

---

FPM_prvdefs.h File Reference

Private definitions for the FPM package. More...

#include "PBS/FPA.h"
#include "PBS/MTX.h"
#include "PBS/RW.ih"
#include "IMM/FPM_pubdefs.h"

Include dependency graph for FPM_prvdefs.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	_FPM_Allocator
	Structure to record the locations of FPA memory and it's handle. More...
struct	_FPM_Control
	Structure to hold the FPM control block. More...
struct	_FPM_Pool
	Structure to store a memory pool controller. More...
Defines
#define	FPM_K_POOLPKT   (4)
	Pool packet size minimum (1 << FPM_K_POOLPKT ).
#define	FPM_L_POOLPKT   (16)
	Pool packet size range.
#define	FPM_L_MEM_STATES   (4)
	Number of control states.
Typedefs
typedef enum _FPM_PoolState	FPM_PoolState
	Typedef for enum _FPM_PoolState.
typedef _FPM_Allocator	FPM_Allocator
	Typedef for struct _FPM_Allocator.
typedef _FPM_Control	FPM_Control
	Typedef for struct _FPM_Control.
Enumerations
enum	_FPM_PoolState {   FPM_MEM_UNINITIALIZED = 0,   FPM_MEM_INITIALIZED = 1,   FPM_MEM_STARTED = 2,   FPM_MEM_STOPPING = 3 }
	Enumeration of states a memory pool can be in. More...
Functions
void	FPM_stopCheck (FPM_Pool *pcb)
	Check if pool is drained (and if it is, complete stop processing).
Variables
FPM_Control *	FPM_fcb
	Control block for the memory pool management system.
const char *	FPM_mem_states [FPM_L_MEM_STATES]
	String constants for FPM memory states.

---

Detailed Description

Private definitions for the FPM package.

CVS $Id: FPM_prvdefs.h,v 1.1.1.1 2005/03/18 02:22:08 apw Exp $

Author:

A.P.Waite

---

Enumeration Type Documentation

enum _FPM_PoolState

Enumeration of states a memory pool can be in. Enumeration values: FPM_MEM_UNINITIALIZED  Uninitialized FPM_MEM_INITIALIZED  Initialized (cannot allocate pkts) FPM_MEM_STARTED  Started (can allocate pkts) FPM_MEM_STOPPING  Stopping (won't allocate pkts)

---

Function Documentation

void FPM_stopCheck (  FPM_Pool *  pcb  )

Check if pool is drained (and if it is, complete stop processing). Parameters: pcb  (in) Memory pool control block FPM_stopCheck() checks a pool to see if all the packets are back on the free lists, and if so, completes the process of stopping the pool.

---

Variable Documentation

FPM_Control * FPM_fcb

Control block for the memory pool management system. Control block for the memory pool management system. This is global, so care must be taken when writing elements of this block that the code is properly protected.

---