ires.h File Reference

Detailed Description

IRES Interface Definitions - Allows algorithms to request and receive handles representing private logical resources.

#include "ires_common.h"

Include dependency graph for ires.h:

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

Go to the source code of this file.

Data Structures
struct	IRES_YieldContext
	Specifies the algorithm specific handles and context save & restore function pointers and arguments that the framework will call during a context switch. More...
struct	IRES_Fxns
	These fxns are used to query/grant the resources requested by the algorithm at initialization time, and to change these resources at runtime. All these fxns are implemented by the algorithm, and called by the client of the algorithm. More...

Typedefs
typedef enum IRES_YieldResourceType	IRES_YieldResourceType
typedef Void(*	IRES_ContextSaveFxn) (IALG_Handle algHandle, Void *contextArgs)
typedef Void(*	IRES_ContextRestoreFxn) (IALG_Handle algHandle, Void *contextArgs)
typedef struct IRES_YieldContext	IRES_YieldContext
	Specifies the algorithm specific handles and context save & restore function pointers and arguments that the framework will call during a context switch. More...
typedef IRES_YieldContext *	IRES_YieldContextHandle
typedef Void *	IRES_YieldArgs
typedef Void(*	IRES_YieldFxn) (IRES_YieldResourceType resourceType, IRES_YieldContextHandle algYieldContext, IRES_YieldArgs yieldArgs)
	The 'yield function' pointer and 'yield arguments' are supplied to an algorithm during its IRES interface 'initialization'. The algorithm optionally calls the yield function during its 'process' stages for co-operative multi-tasking and pre-emption by a higher priority algorithm. More...
typedef struct IRES_Fxns	IRES_Fxns
	These fxns are used to query/grant the resources requested by the algorithm at initialization time, and to change these resources at runtime. All these fxns are implemented by the algorithm, and called by the client of the algorithm. More...

Enumerations
enum	IRES_YieldResourceType {   IRES_ALL = 0,   IRES_SCRATCHMEMORY,   IRES_SCRATCHDMA,   IRES_RESOURCEHANDLE }