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

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

`#include "grx_hal.h"`
`#include "app_drv_error.h"`
`#include "app_drv_config.h"`
`#include "app_io.h"`
`#include "app_dma.h"`
Include dependency graph for app_pdm.h:

Go to the source code of this file.

## Classes
struct | app_pdm_pin_t
| PDM IO configuration Structures. More...
struct | app_pdm_pin_cfg_t
| PDM IO Structures. More...
struct | app_pdm_dma_t
| PDM operate mode Enumerations definition. More...
struct | app_pdm_evt_t
| PDM event structure definition. More...
struct | pdm_env_t
| app pdm instance structure. More...
struct | app_pdm_params_t
| PDM parameters structure definition. More...

## Typedefs
typedef void(* | app_pdm_evt_handler_t) (app_pdm_evt_t *type)
| PDM event callback definition. More...

## Enumerations
enum | app_pdm_evt_type_t { APP_PDM_EVT_DMA_ERROR, APP_PDM_EVT_DMA_TFR, APP_PDM_EVT_DMA_BLK, APP_PDM_EVT_LEFT_OVERFLOW, APP_PDM_EVT_RIGHT_OVERFLOW }
| PDM event Enumerations definition. More...
enum | app_pdm_state_t { APP_PDM_INACTIVITY = 0, APP_PDM_ACTIVITY }
| pdm state types. More...

## Functions
uint16_t | app_pdm_init (app_pdm_params_t *p_params, app_pdm_evt_handler_t evt_handler)
| Initialize the APP PDM DRIVER according to the specified parameters in the app_pdm_params_t and app_pdm_evt_handler_t. More...
uint16_t | app_pdm_deinit (void)
| De-initialize the APP PDM DRIVER peripheral. More...
uint16_t | app_pdm_left_start_dma (uint16_t *p_data, uint32_t length)
| Start the pdm left channel transfer with dma. More...
uint16_t | app_pdm_right_start_dma (uint16_t *p_data, uint32_t length)
| Start the pdm right channel transfer with dma. More...
uint16_t | app_pdm_stereo_start_dma (uint32_t *p_data, uint32_t length)
| Start the pdm dual channel transfer with dma. More...
uint16_t | app_pdm_left_start_dma_sg_llp (uint16_t *p_data, uint32_t length, dma_sg_llp_config_t *sg_llp_config)
| Start the pdm left channel transfer with dma's sg and llp functions. More...
uint16_t | app_pdm_right_start_dma_sg_llp (uint16_t *p_data, uint32_t length, dma_sg_llp_config_t *sg_llp_config)
| Start the pdm right channel transfer with dma's sg and llp functions. More...
uint16_t | app_pdm_stereo_start_dma_sg_llp (uint32_t *p_data, uint32_t length, dma_sg_llp_config_t *sg_llp_config)
| Start the pdm dual channel transfer with dma's sg and llp functions. More...
uint16_t | app_pdm_abort (void)
| Abort the pdm transfer. More...
pdm_handle_t * | app_pdm_get_handle (void)
| Return the PDM handle. More...

## Detailed Description

Header file containing functions prototypes of PDM 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_pdm.h.