ires_common.h File Reference

---

Detailed Description

IRES Resource Protocol Definitions - IRES Resource.

#include "ialg.h"

Include dependency graph for ires_common.h:

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

Go to the source code of this file.

Data Structures
struct	IRES_ProtocolRevision
	Protocol revision type. Used to ensure the given 'protocol' revision can be validated. More...
struct	IRES_ProtocolArgs
	Abstract Protocol Arguments structure definition. Actual arguments passed by the algorithm to request a resource from a specific IRES Protocol will extend and supply the concrete definitions. More...
struct	IRES_ResourceDescriptor
	Descriptor to Logical Resource. More...
struct	IRES_Properties
	Abstract Resource Properties structure/pointer definition. Actual resource protocol will supply the concrete property definitions. The list of attributes for the actual resource will expose the relevant features that needs to be known to a client to use the resource, such as: resource register base addresses and offsets, critical register and memory region addresses, ... More...
struct	IRES_Obj
	IRES_Obj holds the private state associated with each logical resource. More...
enum	IRES_Status {   IRES_OK = 0,   IRES_EALG = 1,   IRES_EEXISTS = 2,   IRES_EFAIL = 3,   IRES_EINIT = 4,   IRES_ENOINIT = 5,   IRES_ENOMEM = 6,   IRES_ENORESOURCE = 7,   IRES_ENOTFOUND = 8 }
	IRES_Status defines the standard error and success codes returned by IRES APIs. More...
enum	IRES_RequestMode {   IRES_SCRATCH,   IRES_PERSISTENT,   IRES_LATEACQUIRE }
	Mode in which resources can be requested. More...
typedef enum IRES_Status	IRES_Status
	IRES_Status defines the standard error and success codes returned by IRES APIs.
typedef struct IRES_ProtocolRevision	IRES_ProtocolRevision
	Protocol revision type. Used to ensure the given 'protocol' revision can be validated.
typedef enum IRES_RequestMode	IRES_RequestMode
	Mode in which resources can be requested.
typedef struct IRES_ProtocolArgs	IRES_ProtocolArgs
	Abstract Protocol Arguments structure definition. Actual arguments passed by the algorithm to request a resource from a specific IRES Protocol will extend and supply the concrete definitions.
typedef struct IRES_ResourceDescriptor	IRES_ResourceDescriptor
	Descriptor to Logical Resource.
typedef struct IRES_Properties	IRES_Properties
	Abstract Resource Properties structure/pointer definition. Actual resource protocol will supply the concrete property definitions. The list of attributes for the actual resource will expose the relevant features that needs to be known to a client to use the resource, such as: resource register base addresses and offsets, critical register and memory region addresses, ...
typedef struct IRES_Obj	IRES_Obj
	IRES_Obj holds the private state associated with each logical resource.
typedef struct IRES_Obj *	IRES_Handle
	Handle to "logical" resource.