Data Structures | Typedefs | Functions
UDMACC32XX.h File Reference

Detailed Description

uDMA driver implementation for CC32XX.

============================================================================

This driver is intended for use only by drivers that use the uDMA peripheral (e.g., SPI and I2S). This driver is mainly used for Power management of the UDMA peripheral.

The application should only define the memory for the control table and set up the UDMACC32XX_HWAttrs and UDMACC32XX_Config structures.

The UDMACC32XX header file should be included in an application as follows:


#include <stdint.h>
#include <stdbool.h>
#include <ti/drivers/dpl/HwiP.h>
Include dependency graph for UDMACC32XX.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  UDMACC32XX_HWAttrs
 UDMACC32XX Hardware attributes. More...
 
struct  UDMACC32XX_Config
 UDMACC32XX Global configuration. More...
 
struct  UDMACC32XX_Object
 UDMACC32XX object. More...
 

Typedefs

typedef void(* UDMACC32XX_ErrorFxn) (uintptr_t arg)
 UDMA error function pointer. More...
 
typedef UDMACC32XX_ConfigUDMACC32XX_Handle
 A handle that is returned from a UDMACC32XX_open() call. More...
 

Functions

void UDMACC32XX_close (UDMACC32XX_Handle handle)
 Function to close the DMA driver. More...
 
void UDMACC32XX_init ()
 Function to initialize the CC32XX DMA driver. More...
 
UDMACC32XX_Handle UDMACC32XX_open ()
 Function to initialize the CC32XX DMA peripheral. More...
 

Typedef Documentation

§ UDMACC32XX_ErrorFxn

typedef void(* UDMACC32XX_ErrorFxn) (uintptr_t arg)

UDMA error function pointer.

§ UDMACC32XX_Handle

A handle that is returned from a UDMACC32XX_open() call.

Function Documentation

§ UDMACC32XX_close()

void UDMACC32XX_close ( UDMACC32XX_Handle  handle)

Function to close the DMA driver.

This function releases Power dependency on UDMA that was previously set with a call to UDMACC32XX_open(). If there is only one outstanding UDMACC32XX_open() call (i.e. all but one UDMACC32XX_open() calls have been matched by a corresponding call to UDMACC32XX_close()), this function will disable the UDMA.

Precondition
UDMACC32XX_open() has to be called first. Calling context: Task
Parameters
handleA UDMACC32XX_Handle returned from UDMACC32XX_open()
Returns
none
See also
UDMACC32XX_open

§ UDMACC32XX_init()

void UDMACC32XX_init ( )

Function to initialize the CC32XX DMA driver.

The function will set the isOpen flag to false, and should be called prior to opening the DMA driver.

Returns
none
See also
UDMACC32XX_open()

§ UDMACC32XX_open()

UDMACC32XX_Handle UDMACC32XX_open ( )

Function to initialize the CC32XX DMA peripheral.

UDMACC32XX_open() can be called multiple times. Each time the function is called, it will set a dependency on the peripheral and enable the clock. The Power dependency count on the UDMA will be equal to the number of outstanding calls to UDMACC32XX_open(). Calling UDMACC32XX_close() will decrement the Power dependency count, and the last call to UDMACC32XX_close() will disable the UDMA.

Precondition
UDMACC32XX_init() has to be called first. Calling context: Task
Returns
UDMACC32XX_Handle on success or NULL if an error has occurred.
See also
UDMACC32XX_close()
© Copyright 1995-2019, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale