IDMA3 - Interface for requesting EDMA3 resources

Data Structures
struct	IDMA3_MemRec
	Record containing attributes of the IDMA3 Channel environment memory when (optionally) the IDMA3 Channel is requested with a non-NULL IDMA3_ProtocolObj. More...
struct	IDMA3_ChannelRec
	DMA Channel Descriptor to logical DMA channels. More...
struct	IDMA3_Fxns
	These fxns are used to query/grant the DMA 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...
struct	IDMA3_ProtocolObj
	These functions are used to determine memory requirements for and initialize the IDMA3 protocol's environment that will be allocated by the DMA manager. More...
struct	IDMA3_Obj
	IDMA3_Obj holds the private state associated with each logical DMA channel. More...

Macros
#define	IDMA3_PROTOCOL_NULL   ((IDMA3_ProtocolHandle)NULL)
	NULL protocol definition.

Typedefs
typedef enum IDMA3_MemType	IDMA3_MemType
	Memory space descriptors for IDMA3_MemRec.
typedef struct IDMA3_MemRec	IDMA3_MemRec
	Record containing attributes of the IDMA3 Channel environment memory when (optionally) the IDMA3 Channel is requested with a non-NULL IDMA3_ProtocolObj.
typedef struct IDMA3_Obj *	IDMA3_Handle
	Handle to "logical" DMA channel.
typedef struct IDMA3_ProtocolObj *	IDMA3_ProtocolHandle
	Handle to IDMA3 protocol object.
typedef enum IDMA3_Priority	IDMA3_Priority
	IDMA3 Priority Levels.
typedef struct IDMA3_ChannelRec	IDMA3_ChannelRec
	DMA Channel Descriptor to logical DMA channels.
typedef struct IDMA3_Fxns	IDMA3_Fxns
	These fxns are used to query/grant the DMA 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.
typedef struct IDMA3_ProtocolObj	IDMA3_ProtocolObj
	These functions are used to determine memory requirements for and initialize the IDMA3 protocol's environment that will be allocated by the DMA manager.
typedef struct IDMA3_Obj	IDMA3_Obj
	IDMA3_Obj holds the private state associated with each logical DMA channel.

Enumerations
enum	IDMA3_MemType {   IDMA3_INTERNAL,   IDMA3_EXTERNAL }
	Memory space descriptors for IDMA3_MemRec. More...
enum	IDMA3_Priority {   IDMA3_PRIORITY_URGENT,   IDMA3_PRIORITY_HIGH,   IDMA3_PRIORITY_MEDIUM,   IDMA3_PRIORITY_LOW }
	IDMA3 Priority Levels. More...

---

Detailed Description

The IDMA3 interface enables algorithms to request and receive handles representing private logical DMA resources.

Deprecated:

This IDMA3 interface has been deprecated, and superceeded by newer IRES-based interfaces.

---

Macro Definition Documentation

#define IDMA3_PROTOCOL_NULL   ((IDMA3_ProtocolHandle)NULL)

NULL protocol definition.

The NULL protocol can be used when no protocol is needed, e.g. when the algorithm directly accesses the eDMA PaRAM registers, or when the DMA driver library used does not retain any state. When the NULL protocol is used 'env' buffer is not allocated

---

Typedef Documentation

typedef enum IDMA3_MemType IDMA3_MemType

Memory space descriptors for IDMA3_MemRec.

typedef struct IDMA3_MemRec IDMA3_MemRec

Record containing attributes of the IDMA3 Channel environment memory when (optionally) the IDMA3 Channel is requested with a non-NULL IDMA3_ProtocolObj.

typedef struct IDMA3_Obj* IDMA3_Handle

Handle to "logical" DMA channel.

typedef struct IDMA3_ProtocolObj* IDMA3_ProtocolHandle

Handle to IDMA3 protocol object.

typedef enum IDMA3_Priority IDMA3_Priority

IDMA3 Priority Levels.

typedef struct IDMA3_ChannelRec IDMA3_ChannelRec

DMA Channel Descriptor to logical DMA channels.

typedef struct IDMA3_Fxns IDMA3_Fxns

These fxns are used to query/grant the DMA 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.

typedef struct IDMA3_ProtocolObj IDMA3_ProtocolObj

These functions are used to determine memory requirements for and initialize the IDMA3 protocol's environment that will be allocated by the DMA manager.

Remarks:

These fxns are implemented by the IDMA3 protocol that is used for a given channel (e.g, ACPY3), and are passed in the IDMA3_ChannelRec structure to request a logical DMA channel. If the IDMA3 protocol does not require any particular one of these functions, it may be set to NULL.

getEnvMemRec() - Called by the DMA manager when creating a logical DMA channel, to query the IDMA3 protocol's memory requirements for its environment.

initHandle() - Called by the DMA manager after allocation the environment, to allow the IDMA3 protocol to do any initialization of its environment.

deInitHandle() - Called by the DMA manager when a channel is freed, so that the IDMA3 protocol can do any required de-initialization or freeing any memory that may have been allocated in initHandle().

typedef struct IDMA3_Obj IDMA3_Obj

IDMA3_Obj holds the private state associated with each logical DMA channel.

---

Enumeration Type Documentation

enum IDMA3_MemType

Memory space descriptors for IDMA3_MemRec.

Enumerator:

IDMA3_INTERNAL	Internal data memory.
IDMA3_EXTERNAL	External data memory.

enum IDMA3_Priority

IDMA3 Priority Levels.

Enumerator:

IDMA3_PRIORITY_URGENT
IDMA3_PRIORITY_HIGH
IDMA3_PRIORITY_MEDIUM
IDMA3_PRIORITY_LOW