Classes | Typedefs | Enumerations | Functions
app_dma.h File Reference

Header file containing functions prototypes of DMA app library. More...

`#include "grx_hal.h"`
`#include "app_drv_error.h"`
`#include "app_drv_config.h"`
Include dependency graph for app_dma.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Classes
struct | dma_env_t
| DMA device structure definition. More...
struct | app_dma_params_t
| DMA parameters structure definition. More...

## Typedefs
typedef int16_t | dma_id_t
| DMA id definition. More...
typedef void(* | app_dma_evt_handler_t) (app_dma_evt_type_t type)
| DMA event callback definition. More...

## Enumerations
enum | app_dma_evt_type_t { APP_DMA_EVT_ERROR, APP_DMA_EVT_TFR, APP_DMA_EVT_BLK }
| DMA event Enumerations definition. More...
enum | app_dma_state_t { APP_DMA_INVALID = 0, APP_DMA_ACTIVITY }
| App dma state types. More...

## Functions
dma_id_t | app_dma_init (app_dma_params_t *p_params, app_dma_evt_handler_t evt_handler)
| Initialize the APP DMA DRIVER according to the specified parameters in the app_dma_params_t and app_dma_evt_handler_t. More...
uint16_t | app_dma_deinit (dma_id_t ins_id)
| De-initialize the APP ADC DRIVER peripheral. More...
uint16_t | app_dma_start (dma_id_t id, uint32_t src_address, uint32_t dst_address, uint32_t data_length)
| Start the DMA Transfer. More...
dma_handle_t * | app_dma_get_handle (dma_id_t id)
| Return the DMA handle. More...

## Detailed Description

Header file containing functions prototypes of DMA app library.

Author
  BLE Driver Team

Attention

  ##### Copyright (c) 2019 GOODIX

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file app_dma.h.