Framework Components Application Programming Interface (API)
fc-v04
|
Functions | |
String | IRESMAN_VICP_getProtocolName () |
Function to return the name of the protocol. More... | |
IRES_ProtocolRevision * | IRESMAN_VICP_getProtocolRevision () |
Function to return the revision of the protocol. More... | |
IRES_Status | IRESMAN_VICP_init (IRESMAN_Params *initArgs) |
Function to initialize the device specific resource manager implementation. More... | |
IRES_Status | IRESMAN_VICP_exit () |
Function called when RESMAN is no longer needed. Use it to free memory allocated etc. More... | |
IRES_Handle | IRESMAN_VICP_getHandles (IALG_Handle algHandle, IRES_ResourceDescriptor *resDesc, Int scratchGroupId, IRES_Status *status) |
Function that returns the IRES_Handle to the resource requested using the IRES_ResourceProtocolArgs. More... | |
IRES_Status | IRESMAN_VICP_freeHandles (IALG_Handle algHandle, IRES_Handle algResourceHandle, IRES_ResourceDescriptor *resDesc, Int scratchGroupId) |
Frees handles back to the resource pool. More... | |
Data Structures | |
struct | IRESMAN_VicpParams |
Typedefs | |
typedef struct IRESMAN_VicpParams | IRESMAN_VicpParams |
Variables | |
__FAR__ IRESMAN_PersistentAllocFxn | _RMAN_allocPersistent |
Memory allocation functions for all of RMANs and other IRES protocol's memory requirements. More... | |
__FAR__ IRESMAN_PersistentFreeFxn | _RMAN_freePersistent |
Memory free functions for all of RMANs and other IRES protocol's memory requirements. More... | |
IRESMAN_Fxns | IRESMAN_VICP |
IRES RESMAN implementation for VICP. More... | |
VICP specific Resource Manager and corresponding IRES Protocol Implementation.
String IRESMAN_VICP_getProtocolName | ( | ) |
Function to return the name of the protocol.
String | name identifying the protocol |
IRES_ProtocolRevision* IRESMAN_VICP_getProtocolRevision | ( | ) |
Function to return the revision of the protocol.
Revision | identifying the protocol |
IRES_Status IRESMAN_VICP_init | ( | IRESMAN_Params * | initArgs | ) |
Function to initialize the device specific resource manager implementation.
[in] | initArgs | Initialization arguments that may be interpreted by the device specific implementation |
IRES_Status | IRES_OK Success IRES_EEXISTS Already initialized IRES_EFAIL Error |
IRES_Status IRESMAN_VICP_exit | ( | ) |
Function called when RESMAN is no longer needed. Use it to free memory allocated etc.
IRES_Status | IRES_OK Success IRES_ENOINIT Not initialized IRES_EFAIL Error |
IRES_Handle IRESMAN_VICP_getHandles | ( | IALG_Handle | algHandle, |
IRES_ResourceDescriptor * | resDesc, | ||
Int | scratchGroupId, | ||
IRES_Status * | status | ||
) |
Function that returns the IRES_Handle to the resource requested using the IRES_ResourceProtocolArgs.
[in] | algHandle | Handle of the algorithm that is acquiring resources. |
[in] | resDesc | Arguments to be interpreted by the IRES_Manager implementation to determine which actual physical resources to obtain |
[in] | scratchGroupId | Group Id required if scratch resources are requested, -1 otherwise |
[out] | status | Status of this call |
IRES_Handle | Valid handle corresponding to the resource requested on success, or NULL on error. |
IRES_Status IRESMAN_VICP_freeHandles | ( | IALG_Handle | algHandle, |
IRES_Handle | algResourceHandle, | ||
IRES_ResourceDescriptor * | resDesc, | ||
Int | scratchGroupId | ||
) |
Frees handles back to the resource pool.
[in] | algHandle | Handle of the algorithm that is releasing resources. |
[in] | algResourceHandle | Handle that is to be released |
[in] | resDesc | Arguments that help determine which resources to free |
[in] | scratchGroupId | Group Id required if scratch resources are requested, -1 otherwise |
IRES_Status | IRES_OK Success IRES_EFAIL Failure |
typedef struct IRESMAN_VicpParams IRESMAN_VicpParams |
__FAR__ IRESMAN_PersistentAllocFxn _RMAN_allocPersistent |
Memory allocation functions for all of RMANs and other IRES protocol's memory requirements.
__FAR__ IRESMAN_PersistentFreeFxn _RMAN_freePersistent |
Memory free functions for all of RMANs and other IRES protocol's memory requirements.
IRESMAN_Fxns IRESMAN_VICP |
IRES RESMAN implementation for VICP.