QPIG.h File Reference

Interface to power state updating routines. More...

#include <QPIG/state.h>
#include <LSF/LSF.h>

Typedefs
typedef struct _QPIG	QPIG
	Data type for QPIG context block.
Functions
QPIG *	QPIG_alloc (void)
	Allocate and construct the QPIG context block.
QPIG *	QPIG_construct (QPIG *qpig, void *prm)
	Construct (initialize) the QPIG context block.
void	QPIG_destruct (QPIG *qpig)
	Destroy the QPIG context block.
unsigned int	QPIG_sizeof (void *prm)
	Return the size, in bytes, of the QPIG context block.
const QPIG_state *	QPIG_stateGet (const QPIG *qpig)
	Return the address of the QPIG register state data.
void	QPIG_updateAtDatagram (QPIG *qpig, const LSF_datagram *dgm)
	Update the register state information in the QPIG context.
int	QPIG_versionGet (const QPIG *qpig)
	Return the version of the QPIG register state data.

---

Detailed Description

Interface to power state updating routines.

Author:

James Swain & Owen Saxton

Id

QPIG.h,v 1.4 2011/03/29 20:25:28 saxton Exp

---

Function Documentation

QPIG* QPIG_alloc

(

void

)

Allocate and construct the QPIG context block.

Returns:

A pointer to the new QPIG context block (context handle)

References QPIG_construct().

QPIG* QPIG_construct	(	QPIG *	qpig,
		void *	prm
	)

Construct (initialize) the QPIG context block.

Parameters:

	qpig	The block to initialize; if specified as NULL, one will be allocated.
	prm	A run-time set parameter used to stylize the configuration (not used)

Returns:

The QPIG context handle

References _QPIG::free, QPIG_constructState(), QPIG_sizeof(), _QPIG::state, and _QPIG::version.

Referenced by QPIG_alloc().

void QPIG_destruct

(

QPIG *

qpig

)

Destroy the QPIG context block.

Parameters:

qpig

The QPIG context handle.

References _QPIG::free.

unsigned int QPIG_sizeof

(

void *

prm

)

Return the size, in bytes, of the QPIG context block.

Parameters:

prm

A run-time set parameter used to stylize the configuration

Returns:

The size, in bytes, of the context block

Referenced by QPIG_construct().

const QPIG_state* QPIG_stateGet

(

const QPIG *

qpig

)

Return the address of the QPIG register state data.

This routine is just an accessor to keep the structure of QPIG private.

Parameters:

qpig

The QPIG context handle

Returns:

A pointer to the QPIG register state data

References _QPIG::state.

void QPIG_updateAtDatagram	(	QPIG *	qpig,
		const LSF_datagram *	dgm
	)

Update the register state information in the QPIG context.

Parameters:

	qpig	The QPIG context handle
	dgm	The PIG register state datagram

References QPIG_recoverState(), _QPIG::state, and _QPIG::version.

int QPIG_versionGet

(

const QPIG *

qpig

)

Return the version of the QPIG register state data.

This routine is just an accessor to keep the structure of QPIG private.

Parameters:

qpig

The QPIG context handle

Returns:

The version of the QPIG register state data

References _QPIG::version.