# EDMA3 Data Structures
[EDMA3]

## Data Structures

struct | CSL_Edma3CfgInfo
| EDMA3 Configuration Information This describes the configuration information for each EDMA instance. This is populated by the SOC layer for each instance. More...
struct | CSL_Edma3Obj
| This object contains the reference to the instance of Edma Module opened using the CSL_edma3Open(). More...
struct | CSL_Edma3ParamSetup
| Edma ParamSetup Structure. More...
struct | CSL_Edma3ChannelObj
| Edma Object Structure. More...
struct | CSL_Edma3MemFaultStat
| Edma Memory Protection Fault Error Status. More...
struct | CSL_Edma3CtrlErrStat
| Edma Controller Error Status. More...
struct | CSL_Edma3QueryInfo
| Edma Controller Information. More...
struct | CSL_Edma3ActivityStat
| Edma Channel Controller Activity Status. More...
struct | CSL_Edma3QueStat
| Edma Controller Que Status. More...
struct | CSL_Edma3CmdRegion
| Edma Control/Query Command Structure for querying region specific attributes. More...
struct | CSL_Edma3CmdQrae
| Edma Control/Query Command Structure for querying qdma region access enable attributes. More...
struct | CSL_Edma3CmdIntr
| Edma Control/Query Control Command structure for issuing commands for Interrupt related APIs An object of this type is allocated by the user and its address is passed to the Control API. More...
struct | CSL_Edma3CmdDrae
| Edma Command Structure for setting region specific attributes. More...
struct | CSL_Edma3CmdQuePri
| Edma Command Structure used for setting Event Que priority level. More...
struct | CSL_Edma3CmdQueThr
| Edma Command Structure used for setting Event Que threshold level. More...
struct | CSL_Edma3ModuleBaseAddress
| This will have the base-address information for the module instance. More...
struct | CSL_Edma3ChannelAttr
| Edma Channel parameter structure used for opening a channel. More...
struct | CSL_Edma3ChannelErr
| Edma Channel Error . More...
struct | CSL_Edma3HwQdmaChannelSetup
| QDMA Edma Channel Setup. More...
struct | CSL_Edma3HwDmaChannelSetup
| QDMA Edma Channel Setup. More...
struct | CSL_Edma3HwSetup
| Edma Hw Setup Structure. More...

## Typedefs

typedef void * | CSL_Edma3Context
| Module specific context information. This is a dummy handle.
typedef void * | CSL_Edma3ModuleAttr
| Module Attributes specific information. This is a dummy handle.
typedef struct CSL_Edma3CfgInfo | CSL_Edma3CfgInfo
| EDMA3 Configuration Information This describes the configuration information for each EDMA instance. This is populated by the SOC layer for each instance.
typedef struct CSL_Edma3Obj | CSL_Edma3Obj
| This object contains the reference to the instance of Edma Module opened using the CSL_edma3Open().
typedef struct CSL_Edma3Obj * | CSL_Edma3Handle
| EDMA handle.
typedef volatile CSL_TPCC_ParamsetRegs * | CSL_Edma3ParamHandle
typedef struct CSL_Edma3ParamSetup | CSL_Edma3ParamSetup
| Edma ParamSetup Structure.
typedef struct CSL_Edma3ChannelObj | CSL_Edma3ChannelObj
| Edma Object Structure.
typedef struct CSL_Edma3ChannelObj * | CSL_Edma3ChannelHandle
typedef struct CSL_Edma3MemFaultStat | CSL_Edma3MemFaultStat
| Edma Memory Protection Fault Error Status.
typedef struct CSL_Edma3CtrlErrStat | CSL_Edma3CtrlErrStat
| Edma Controller Error Status.
typedef struct CSL_Edma3QueryInfo | CSL_Edma3QueryInfo
| Edma Controller Information.
typedef struct CSL_Edma3ActivityStat | CSL_Edma3ActivityStat
| Edma Channel Controller Activity Status.
typedef struct CSL_Edma3QueStat | CSL_Edma3QueStat
| Edma Controller Que Status.
typedef struct CSL_Edma3CmdRegion | CSL_Edma3CmdRegion
| Edma Control/Query Command Structure for querying region specific attributes.
typedef struct CSL_Edma3CmdQrae | CSL_Edma3CmdQrae
| Edma Control/Query Command Structure for querying qdma region access enable attributes.
typedef struct CSL_Edma3CmdIntr | CSL_Edma3CmdIntr
| Edma Control/Query Control Command structure for issuing commands for Interrupt related APIs An object of this type is allocated by the user and its address is passed to the Control API.
typedef struct CSL_Edma3CmdDrae | CSL_Edma3CmdDrae
| Edma Command Structure for setting region specific attributes.
typedef struct CSL_Edma3CmdQuePri | CSL_Edma3CmdQuePri
| Edma Command Structure used for setting Event Que priority level.
typedef struct CSL_Edma3CmdQueThr | CSL_Edma3CmdQueThr
| Edma Command Structure used for setting Event Que threshold level.
typedef struct CSL_Edma3ChannelErr | CSL_Edma3ChannelErr
| Edma Channel Error .
typedef struct CSL_Edma3HwQdmaChannelSetup | CSL_Edma3HwQdmaChannelSetup
| QDMA Edma Channel Setup.
typedef struct CSL_Edma3HwDmaChannelSetup | CSL_Edma3HwDmaChannelSetup
| QDMA Edma Channel Setup.

## Typedef Documentation

typedef struct CSL_Edma3ActivityStat CSL_Edma3ActivityStat

Edma Channel Controller Activity Status.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3GetActivityStatus() /CSL_edma3GetHwStatus().

typedef struct CSL_Edma3ChannelErr CSL_Edma3ChannelErr

Edma Channel Error .

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3GetChannelError() /CSL_edma3GetHwStatus()/ CSL_edma3ChannelErrorClear() /CSL_edma3HwChannelControl().

typedef struct CSL_Edma3ChannelObj* CSL_Edma3ChannelHandle

CSL Channel Handle All channel level API calls must be made with this handle.

typedef struct CSL_Edma3ChannelObj CSL_Edma3ChannelObj

Edma Object Structure.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3ChannelOpen() The CSL_edma3ChannelOpen() updates all the members of the data structure and returns the objects address as a CSL_Edma3ChannelHandle. The CSL_Edma3ChannelHandle is used in all subsequent function calls.

typedef struct CSL_Edma3CmdDrae CSL_Edma3CmdDrae

Edma Command Structure for setting region specific attributes.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3GetHwStatus when

typedef struct CSL_Edma3CmdQrae CSL_Edma3CmdQrae

Edma Control/Query Command Structure for querying qdma region access enable attributes.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3GetHwStatus/CSL_edma3HwControl with the relevant command.

typedef struct CSL_Edma3CmdQuePri CSL_Edma3CmdQuePri

Edma Command Structure used for setting Event Que priority level.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3HwControl API.

typedef struct CSL_Edma3CmdQueThr CSL_Edma3CmdQueThr

Edma Command Structure used for setting Event Que threshold level.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3HwControl API.

typedef struct CSL_Edma3CmdRegion CSL_Edma3CmdRegion

Edma Control/Query Command Structure for querying region specific attributes.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3GetHwStatus/CSL_edma3HwControl with the relevant command.

typedef struct CSL_Edma3CtrlErrStat CSL_Edma3CtrlErrStat

Edma Controller Error Status.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3GetControllerError() /CSL_edma3GetHwStatus().

typedef struct CSL_Edma3HwDmaChannelSetup CSL_Edma3HwDmaChannelSetup

QDMA Edma Channel Setup.

An array of such objects are allocated by the user and address initialized in the CSL_Edma3HwSetup structure which is passed CSL_edma3HwSetup()

typedef struct CSL_Edma3HwQdmaChannelSetup CSL_Edma3HwQdmaChannelSetup

QDMA Edma Channel Setup.

An array of such objects are allocated by the user and address initialized in the CSL_Edma3HwSetup structure which is passed CSL_edma3HwSetup()

typedef struct CSL_Edma3MemFaultStat CSL_Edma3MemFaultStat

Edma Memory Protection Fault Error Status.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3GetMemoryFaultError() / CSL_edma3GetHwStatus() with the relevant command. This is relevant only is MPEXIST is present for a given device.

typedef struct CSL_Edma3Obj CSL_Edma3Obj

This object contains the reference to the instance of Edma Module opened using the CSL_edma3Open().

A pointer to this object is passed to all Edma Module level CSL APIs.

typedef volatile CSL_TPCC_ParamsetRegs* CSL_Edma3ParamHandle

CSL Parameter Set Handle

typedef struct CSL_Edma3ParamSetup CSL_Edma3ParamSetup

Edma ParamSetup Structure.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3ParamSetup(). This structure is used to program the Param Set for EDMA/QDMA. The macros can be used to assign values to the fields of the structure. The setup structure should be setup using the macros provided OR as per the bit descriptions in the user guide..

typedef struct CSL_Edma3QueryInfo CSL_Edma3QueryInfo

Edma Controller Information.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3GetInfo() /CSL_edma3GetHwStatus().

typedef struct CSL_Edma3QueStat CSL_Edma3QueStat

Edma Controller Que Status.

An object of this type is allocated by the user and its address is passed as a parameter to the CSL_edma3GetQueStatus() /CSL_edma3GetHwStatus().

Copyright 2012, Texas Instruments Incorporated