|
|
uDMA driver implementation for MSP432.
============================================================================
This driver is intended for use only by TI-RTOS drivers that use the uDMA peripheral (e.g., SPI). This driver is mainly used for management of the control table base address of the UDMA peripheral, and to create the DMA error Hwi.
The application should only define the memory for the control table and set up the UDMAMSP432_HWAttrs and UDMAMSP432_Config structures.
The UDMAMSP432 header file should be included in an application as follows:
Go to the source code of this file.
Data Structures | |
| struct | UDMAMSP432_HWAttrs |
| UDMAMSP432 Hardware attributes. More... | |
| struct | UDMAMSP432_Config |
| UDMAMSP432 Global configuration. More... | |
| struct | UDMAMSP432_Object |
| UDMAMSP432 object. More... | |
Typedefs | |
| typedef void(* | UDMAMSP432_ErrorFxn) (uintptr_t arg) |
| UDMA error function pointer. More... | |
| typedef struct UDMAMSP432_HWAttrs | UDMAMSP432_HWAttrs |
| UDMAMSP432 Hardware attributes. More... | |
| typedef struct UDMAMSP432_Config | UDMAMSP432_Config |
| UDMAMSP432 Global configuration. More... | |
| typedef struct UDMAMSP432_Config * | UDMAMSP432_Handle |
| A handle that is returned from a UDMAMSP432_open() call. More... | |
| typedef struct UDMAMSP432_Object | UDMAMSP432_Object |
| UDMAMSP432 object. More... | |
Functions | |
| void | UDMAMSP432_close (UDMAMSP432_Handle handle) |
| Function to close the DMA driver. More... | |
| void | UDMAMSP432_init () |
| Function to initialize the MSP432 DMA driver. More... | |
| UDMAMSP432_Handle | UDMAMSP432_open () |
| Function to initialize the MSP432 DMA peripheral. More... | |
| typedef void(* UDMAMSP432_ErrorFxn) (uintptr_t arg) |
UDMA error function pointer.
| typedef struct UDMAMSP432_HWAttrs UDMAMSP432_HWAttrs |
UDMAMSP432 Hardware attributes.
This structure contains the base address of the uDMA control table, and uDMA error interrupt attributes.
The control table is used by the uDMA controller to store channel control structures. The control table can be located anywhere in system memory, but must be contiguous and aligned on a 1024-byte boundary.
dmaErrorFxn is the uDMA peripheral's error interrupt handler.
intPriority is priority of the uDMA peripheral's error interrupt, as defined by the underlying OS. It is passed unmodified to the underlying OS's interrupt handler creation code, so you need to refer to the OS documentation for usage. For example, for SYS/BIOS applications, refer to the ti.sysbios.family.arm.m3.Hwi documentation for SYS/BIOS usage of interrupt priorities. If the driver uses the ti.drivers.ports interface instead of making OS calls directly, then the HwiP port handles the interrupt priority in an OS specific way. In the case of the SYS/BIOS port, intPriority is passed unmodified to Hwi_create().
A sample structure is shown below:
| typedef struct UDMAMSP432_Config UDMAMSP432_Config |
UDMAMSP432 Global configuration.
The UDMAMSP432_Config structure contains pointers used by the UDMAMSP432 driver.
This structure needs to be defined before calling UDMAMSP432_init() and it must not be changed thereafter.
| typedef struct UDMAMSP432_Config* UDMAMSP432_Handle |
A handle that is returned from a UDMAMSP432_open() call.
| typedef struct UDMAMSP432_Object UDMAMSP432_Object |
UDMAMSP432 object.
The application must not access any member variables of this structure!
| void UDMAMSP432_close | ( | UDMAMSP432_Handle | handle | ) |
Function to close the DMA driver.
Close a DMA handle returned from UDMAMSP432_open().
| handle | A UDMAMSP432_Handle returned from UDMAMSP432_open() |
| void UDMAMSP432_init | ( | ) |
Function to initialize the MSP432 DMA driver.
The function will set the isOpen flag to false, and should be called prior to opening the DMA driver.
| UDMAMSP432_Handle UDMAMSP432_open | ( | ) |
Function to initialize the MSP432 DMA peripheral.
UDMAMSP432_open() can be called multiple times. *
