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

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

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

Go to the source code of this file.

## Classes
struct | app_adc_pin_t
| ADC pins Structures. More...
struct | app_adc_pin_cfg_t
| ADC pins config Structures. More...
struct | app_adc_dma_cfg_t
| ADC DMA configuration Structures. More...
struct | app_adc_evt_t
| ADC event structure definition. More...
struct | link_node
| ADC sample-node definition. More...
struct | adc_env_t
| ADC device structure definition. More...
struct | app_adc_params_t
| ADC parameters structure definition. More...

## Typedefs
typedef void(* | app_adc_evt_handler_t) (app_adc_evt_t *p_evt)
| ADC event callback definition. More...
typedef struct link_node | app_adc_sample_node_t
| ADC sample-node definition. More...

## Enumerations
enum | app_adc_evt_type_t { APP_ADC_EVT_CONV_CPLT }
| ADC event Enumerations definition. More...
enum | app_adc_state_t { APP_ADC_INVALID = 0, APP_ADC_ACTIVITY }
| App adc state types. More...
enum | app_adc_dma_state_t { APP_ADC_DMA_INVALID = 0, APP_ADC_DMA_ACTIVITY }
| App adc dma state types. More...

## Functions
uint16_t | app_adc_init (app_adc_params_t *p_params, app_adc_evt_handler_t evt_handler)
| Initialize the APP ADC DRIVER according to the specified parameters in the app_adc_params_t and app_adc_evt_handler_t. More...
uint16_t | app_adc_deinit (void)
| De-initialize the APP ADC DRIVER peripheral. More...
uint16_t | app_adc_conversion_sync (uint16_t *p_data, uint32_t length, uint32_t timeout)
| Polling for conversion. More...
uint16_t | app_adc_conversion_async (uint16_t *p_data, uint32_t length)
| DMA for conversion. More...
uint16_t | app_adc_voltage_intern (uint16_t *inbuf, double *outbuf, uint32_t buflen)
| Convert the ADC conversion results to a voltage value(internal reference). More...
uint16_t | app_adc_voltage_extern (double ref, uint16_t *inbuf, double *outbuf, uint32_t buflen)
| Convert the ADC conversion results to a voltage value(external reference). More...
adc_handle_t * | app_adc_get_handle (void)
| Return the ADC handle. More...
uint16_t | app_adc_multi_channel_conversion_async (app_adc_sample_node_t *p_begin_node, uint32_t total_nodes)
| DMA for multi channels conversion; evt_handler in app_adc_init will callback when all channels finish. More...

## Detailed Description

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