Framework Components Application Programming Interface (API)  fc-v07
Functions | Data Structures | Typedefs | Variables
IRESMAN EDMA3 -

Functions

String IRESMAN_EDMA3CHAN_getProtocolName ()
 Function to return the name of the protocol. More...
 
IRES_ProtocolRevisionIRESMAN_EDMA3CHAN_getProtocolRevision ()
 Function to return the revision of the protocol. More...
 
IRES_Status IRESMAN_EDMA3CHAN_init (IRESMAN_Params *initArgs)
 Function to initialize the device specific resource manager implementation. More...
 
IRES_Status IRESMAN_EDMA3CHAN_exit ()
 Function called when RESMAN is no longer needed. Use it to free memory allocated etc. More...
 
IRES_Handle IRESMAN_EDMA3CHAN_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_EDMA3CHAN_freeHandle (IALG_Handle algHandle, IRES_Handle algResourceHandle, IRES_ResourceDescriptor *resDesc, Int scratchGroupId)
 Frees handles back to the resource pool. More...
 

Data Structures

struct  IRESMAN_Edma3ChanParams
 Configuration parameters for Edma3Chan resman implementation. More...
 

Typedefs

typedef struct IRESMAN_Edma3ChanParams IRESMAN_Edma3ChanParams
 Configuration parameters for Edma3Chan resman implementation. More...
 

Variables

__FAR__ IRESMAN_PersistentAllocFxn _RMAN_allocPersistent
 Memory allocation functions for all of RMANs and other IRES rotocol'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_EDMA3CHAN
 IRES RESMAN implementation for EDMA3 Linked transfers. More...
 

Detailed Description

EDMA3 specific Resource Manager and corresponding IRES Protocol Implementation

Function Documentation

String IRESMAN_EDMA3CHAN_getProtocolName ( )

Function to return the name of the protocol.

Return values
Stringname identifying the protocol
IRES_ProtocolRevision* IRESMAN_EDMA3CHAN_getProtocolRevision ( )

Function to return the revision of the protocol.

Return values
Revisionidentifying the protocol
IRES_Status IRESMAN_EDMA3CHAN_init ( IRESMAN_Params initArgs)

Function to initialize the device specific resource manager implementation.

Parameters
[in]initArgsInitialization arguments that may be interpreted by the device specific implementation
Return values
IRES_StatusIRES_OK Success IRES_EEXISTS Already initialized IRES_EFAIL Error
IRES_Status IRESMAN_EDMA3CHAN_exit ( )

Function called when RESMAN is no longer needed. Use it to free memory allocated etc.

Return values
IRES_StatusIRES_OK Success IRES_ENOINIT Not initialized IRES_EFAIL Error
IRES_Handle IRESMAN_EDMA3CHAN_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.

Parameters
[in]algHandleHandle of the algorithm that requests the resources
[in]resDescArguments to be interpreted by the IRES_Manager implementation to determine which actual physical resources to obtain
[in]scratchGroupIdGroup Id required if scratch resources are requested, -1 otherwise
[out]statusStatus of this call
Return values
IRES_HandleValid handle corresponding to the resource requested on success, or NULL on error.
IRES_Status IRESMAN_EDMA3CHAN_freeHandle ( IALG_Handle  algHandle,
IRES_Handle  algResourceHandle,
IRES_ResourceDescriptor resDesc,
Int  scratchGroupId 
)

Frees handles back to the resource pool.

Parameters
[in]algHandleHandle of the algorithm that frees the resources
[in]algResourceHandleHandle that is to be released
[in]resDescArguments that help determine which resources to free
[in]scratchGroupIdGroup Id required if scratch resources are requested, -1 otherwise
Return values
IRES_StatusIRES_OK Success IRES_EFAIL Failure

Typedef Documentation

Configuration parameters for Edma3Chan resman implementation.

Variable Documentation

__FAR__ IRESMAN_PersistentAllocFxn _RMAN_allocPersistent

Memory allocation functions for all of RMANs and other IRES rotocol'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_EDMA3CHAN

IRES RESMAN implementation for EDMA3 Linked transfers.

Copyright 2016, Texas Instruments Incorporated