app_adc.h
Go to the documentation of this file.
1 /**
2 ****************************************************************************************
3 *
4 * @file app_adc.h
5 * @author BLE Driver Team
6 * @brief Header file containing functions prototypes of ADC app library.
7 *
8 ****************************************************************************************
9 * @attention
10 #####Copyright (c) 2019 GOODIX
11 All rights reserved.
12
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions are met:
15 * Redistributions of source code must retain the above copyright
16 notice, this list of conditions and the following disclaimer.
17 * Redistributions in binary form must reproduce the above copyright
18 notice, this list of conditions and the following disclaimer in the
19 documentation and/or other materials provided with the distribution.
20 * Neither the name of GOODIX nor the names of its contributors may be used
21 to endorse or promote products derived from this software without
22 specific prior written permission.
23
24 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 POSSIBILITY OF SUCH DAMAGE.
35 ****************************************************************************************
36 */
37
38 /** @addtogroup PERIPHERAL Peripheral Driver
39 * @{
40 */
41
42 /** @addtogroup APP_DRIVER APP DRIVER
43 * @{
44 */
45
46 /** @defgroup APP_ADC ADC
47 * @brief ADC APP module driver.
48 * @{
49 */
50
51
52 #ifndef _APP_ADC_H_
53 #define _APP_ADC_H_
54
55 #include "grx_hal.h"
56 #include "app_io.h"
57 #include "app_dma.h"
58 #include "app_drv_error.h"
59 #include "app_drv_config.h"
60
61 #ifdef __cplusplus
62 extern "C" {
63 #endif
64
65 #ifdef HAL_ADC_MODULE_ENABLED
66
67 /** @addtogroup APP_ADC_ENUM Enumerations
68 * @{
69 */
70
71 /**
72 * @brief ADC event Enumerations definition
73 */
74 typedef enum
75 {
76 APP_ADC_EVT_CONV_CPLT, /**< Conversion completed by ADC peripheral. */
77 } app_adc_evt_type_t;
78
79 /**@brief App adc state types. */
80 typedef enum
81 {
82 APP_ADC_INVALID = 0,
83 APP_ADC_ACTIVITY,
84 #ifdef APP_DRIVER_WAKEUP_CALL_FUN
85 APP_ADC_SLEEP,
86 #endif
87 } app_adc_state_t;
88
89 /**@brief App adc dma state types. */
90 typedef enum
91 {
92 APP_ADC_DMA_INVALID = 0,
93 APP_ADC_DMA_ACTIVITY,
94 } app_adc_dma_state_t;
95
96 /** @} */
97
98
99 /** @addtogroup APP_ADC_STRUCTURES Structures
100 * @{
101 */
102
103 /**
104 * @brief ADC pins Structures
105 */
106 typedef struct
107 {
108 app_io_type_t type; /**< Specifies the type of ADC IO. */
109 app_io_mux_t mux; /**< Specifies the Peripheral to be connected to the selected pins. */
110 uint32_t pin; /**< Specifies the IO pins to be configured.
111 This parameter can be any value of @ref GR5xxx_pins. */
112 } app_adc_pin_t;
113
114 /**
115 * @brief ADC pins config Structures
116 */
117 typedef struct
118 {
119 app_adc_pin_t channel_p; /**< Set the configuration of ADC pin. */
120 app_adc_pin_t channel_n; /**< Set the configuration of ADC pin. */
121 app_adc_pin_t extern_ref; /**< Set the configuration of extern reference pin. */
122 } app_adc_pin_cfg_t;
123
124 /**
125 * @brief ADC DMA configuration Structures
126 */
127 typedef struct
128 {
129 dma_regs_t * dma_instance; /**< Specifies the dma instance of ADC. */
130 dma_channel_t dma_channel; /**< Specifies the dma channel of ADC. */
131 } app_adc_dma_cfg_t;
132
133 /**
134 * @brief ADC event structure definition
135 */
136 typedef struct
137 {
138 app_adc_evt_type_t type; /**< Type of event. */
139 } app_adc_evt_t;
140
141 /** @} */
142
143 /** @addtogroup APP_ADC_TYPEDEFS Type definitions
144 * @{
145 */
146 /**
147 * @brief ADC event callback definition
148 */
149 typedef void (*app_adc_evt_handler_t)(app_adc_evt_t *p_evt);
150
151 /** @} */
152
153 /** @addtogroup APP_ADC_STRUCTURES Structures
154 * @{
155 */
156
157 /**
158 * @brief ADC sample-node definition
159 */
160 typedef struct link_node
161 {
162 uint32_t channel; /**< Which channel to be sample; This parameter can be any value of ADC_INPUT_SOURCE:ADC_INPUT_SRC_IO0~ADC_INPUT_SRC_REF*/
163 uint16_t *p_buf; /**< Buffer pointer of current channel sample codes. Note:pointer must be 4-byte aligned as it is filled in datas by DMA */
164 uint32_t len; /**< Sample len codes on current channel. */
165 struct link_node *next; /**< Point to the next sample node. */
166 } app_adc_sample_node_t;
167
168 /**
169 * @brief ADC device structure definition
170 */
171 typedef struct
172 {
173 app_adc_evt_handler_t evt_handler; /**< ADC event callback definition. */
174 adc_handle_t handle; /**< ADC handle definition. */
175 dma_id_t dma_id; /**< DMA id definition . */
176 app_adc_state_t adc_state; /**< ADC state types. */
177 app_adc_dma_state_t adc_dma_state; /**< ADC dma state types. */
178 app_adc_sample_node_t *p_current_sample_node; /**< ADC sample-node definition. */
179 uint32_t multi_channel; /**< multi channel definition. */
180 } adc_env_t;
181
182 /**
183 * @brief ADC parameters structure definition
184 */
185 typedef struct
186 {
187 app_adc_pin_cfg_t pin_cfg; /**< the pin configuration information for the specified ADC module. */
188 app_adc_dma_cfg_t dma_cfg; /**< ADC DMA configuration. */
189 adc_init_t init; /**< ADC configuration parameters. */
190 adc_env_t adc_env; /**< ADC device structure definition. */
191 } app_adc_params_t;
192
193 /** @} */
194
195 /* Exported functions --------------------------------------------------------*/
196 /** @addtogroup APP_ADC_DRIVER_FUNCTIONS Functions
197 * @{
198 */
199
200 /**
201 ****************************************************************************************
202 * @brief Initialize the APP ADC DRIVER according to the specified parameters
203 * in the app_adc_params_t and app_adc_evt_handler_t.
204 * @note If DMA mode is set, you can use blocking mode. Conversely, if blocking mode
205 * is set, you can't use DMA mode.
206 *
207 * @param[in] p_params: Pointer to app_adc_params_t parameter which contains the
208 * configuration information for the specified ADC module.
209 * @param[in] evt_handler: ADC user callback function.
210 *
211 * @return Result of initialization.
212 ****************************************************************************************
213 */
214 uint16_t app_adc_init(app_adc_params_t *p_params, app_adc_evt_handler_t evt_handler);
215
216 /**
217 ****************************************************************************************
218 * @brief De-initialize the APP ADC DRIVER peripheral.
219 *
220 * @return Result of De-initialization.
221 ****************************************************************************************
222 */
223 uint16_t app_adc_deinit(void);
224
225 /**
226 ****************************************************************************************
227 * @brief Polling for conversion.
228 *
229 * @param[in] p_data: Pointer to data buffer which to storage ADC conversion results.
230 * @param[in] length: Length of data buffer.
231 * @param[in] timeout : Timeout duration
232 *
233 * @return Result of operation.
234 ****************************************************************************************
235 */
236 uint16_t app_adc_conversion_sync(uint16_t *p_data, uint32_t length, uint32_t timeout);
237
238 /**
239 ****************************************************************************************
240 * @brief DMA for conversion.
241 *
242 * @param[in] p_data: Pointer to data buffer which to storage ADC conversion results.
243 * @param[in] length: Length of data buffer, ranging between 0 and 4095.
244 *
245 * @return Result of operation.
246 ****************************************************************************************
247 */
248 uint16_t app_adc_conversion_async(uint16_t *p_data, uint32_t length);
249
250 /**
251 ****************************************************************************************
252 * @brief Convert the ADC conversion results to a voltage value(internal reference).
253 *
254 * @param[in] inbuf: Pointer to data buffer which storage ADC conversion results.
255 * @param[out] outbuf: Pointer to data buffer which to storage voltage results.
256 * @param[in] buflen: Length of data buffer.
257 *
258 * @return Result of operation.
259 ****************************************************************************************
260 */
261 uint16_t app_adc_voltage_intern(uint16_t *inbuf, double *outbuf, uint32_t buflen);
262
263 /**
264 ****************************************************************************************
265 * @brief Convert the ADC conversion results to a voltage value(external reference).
266 *
267 * @param[in] ref: slope of ADC.
268 * @param[in] inbuf: Pointer to data buffer which storage ADC conversion results.
269 * @param[out] outbuf: Pointer to data buffer which to storage voltage results.
270 * @param[in] buflen: Length of data buffer.
271 *
272 * @return Result of operation.
273 ****************************************************************************************
274 */
275 uint16_t app_adc_voltage_extern(double ref, uint16_t *inbuf, double *outbuf, uint32_t buflen);
276
277 #if (APP_DRIVER_CHIP_TYPE != APP_DRIVER_GR551X)
278 /**
279 ****************************************************************************************
280 * @brief Convert the ADC conversion results to temperature value.
281 *
282 * @param[in] inbuf: Pointer to data buffer which storage ADC conversion results.
283 * @param[out] outbuf: Pointer to data buffer which to storage voltage results.
284 * @param[in] buflen: Length of data buffer.
285 *
286 * @return Result of operation.
287 ****************************************************************************************
288 */
289 uint16_t app_adc_temperature_conv(uint16_t *inbuf, double *outbuf, uint32_t buflen);
290
291 /**
292 ****************************************************************************************
293 * @brief Convert the ADC conversion results to battery value.
294 *
295 * @param[in] inbuf: Pointer to data buffer which storage ADC codes.
296 * @param[out] outbuf: Pointer to data buffer which to storage conversion results.
297 * @param[in] buflen: Length of data buffer.
298 *
299 * @return Result of operation.
300 ****************************************************************************************
301 */
302 uint16_t app_adc_vbat_conv(uint16_t *inbuf, double *outbuf, uint32_t buflen);
303 #endif
304
305 /**
306 ****************************************************************************************
307 * @brief Return the ADC handle.
308 *
309 * @return Pointer to the ADC handle.
310 ****************************************************************************************
311 */
312 adc_handle_t *app_adc_get_handle(void);
313
314 /**
315 ****************************************************************************************
316 * @brief DMA for multi channels conversion; evt_handler in app_adc_init will callback when all channels finish.
317 *
318 * @param[in] p_begin_node: Pointer to the multi sample channels list node.
319 * @param[in] total_nodes: total sample channels.
320 *
321 * @return Result of operation.
322 ****************************************************************************************
323 */
324 uint16_t app_adc_multi_channel_conversion_async(app_adc_sample_node_t *p_begin_node, uint32_t total_nodes);
325
326 #if (APP_DRIVER_CHIP_TYPE == APP_DRIVER_GR5526X)
327 /**
328 ****************************************************************************************
329 * @brief Clear the ADC FIFO, filter the first two incorrect code values , and start the ADC clock.
330 *
331 * @return Result of operation.
332 ****************************************************************************************
333 */
334 uint16_t app_adc_clock_start(void);
335
336 /**
337 ****************************************************************************************
338 * @brief Get the ADC sampling code by polling, and convert sampling code of the specified length to the average voltage.
339 *
340 * @param[out] avg_voltage: Pointer to data which to storage average voltage results.
341 * @param[in] length: Length of the ADC sample values to be averaged.
342 *
343 * @return Result of operation.
344 ****************************************************************************************
345 */
346 uint16_t app_adc_get_avg_voltage(float *avg_voltage, uint32_t length);
347
348 #endif
349
350
351 /** @} */
352
353 #endif
354
355 #ifdef __cplusplus
356 }
357 #endif
358
359 #endif
360
361 /** @} */
362
363 /** @} */
364
365 /** @} */
366
app_adc_voltage_extern
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).
APP_ADC_INVALID
@ APP_ADC_INVALID
Definition: app_adc.h:82
app_adc_evt_handler_t
void(* app_adc_evt_handler_t)(app_adc_evt_t *p_evt)
ADC event callback definition.
Definition: app_adc.h:149
APP_ADC_EVT_CONV_CPLT
@ APP_ADC_EVT_CONV_CPLT
Definition: app_adc.h:76
app_adc_pin_t::mux
app_io_mux_t mux
Definition: app_adc.h:109
app_adc_dma_cfg_t::dma_channel
dma_channel_t dma_channel
Definition: app_adc.h:130
app_adc_multi_channel_conversion_async
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...
app_adc_params_t::adc_env
adc_env_t adc_env
Definition: app_adc.h:190
adc_env_t::adc_state
app_adc_state_t adc_state
Definition: app_adc.h:176
APP_ADC_DMA_INVALID
@ APP_ADC_DMA_INVALID
Definition: app_adc.h:92
adc_env_t
ADC device structure definition.
Definition: app_adc.h:172
app_adc_evt_t::type
app_adc_evt_type_t type
Definition: app_adc.h:138
app_io_type_t
app_io_type_t
GPIO type Enumerations definition.
Definition: app_io.h:147
adc_env_t::adc_dma_state
app_adc_dma_state_t adc_dma_state
Definition: app_adc.h:177
app_adc_params_t
ADC parameters structure definition.
Definition: app_adc.h:186
app_adc_pin_t::pin
uint32_t pin
Definition: app_adc.h:110
app_adc_dma_cfg_t
ADC DMA configuration Structures.
Definition: app_adc.h:128
APP_ADC_DMA_ACTIVITY
@ APP_ADC_DMA_ACTIVITY
Definition: app_adc.h:93
app_adc_state_t
app_adc_state_t
App adc state types.
Definition: app_adc.h:81
app_adc_params_t::pin_cfg
app_adc_pin_cfg_t pin_cfg
Definition: app_adc.h:187
app_io.h
Header file containing functions prototypes of GPIO app library.
app_adc_evt_t
ADC event structure definition.
Definition: app_adc.h:137
app_adc_evt_type_t
app_adc_evt_type_t
ADC event Enumerations definition.
Definition: app_adc.h:75
app_adc_voltage_intern
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).
adc_env_t::evt_handler
app_adc_evt_handler_t evt_handler
Definition: app_adc.h:173
grx_hal.h
This file contains all the functions prototypes for the HAL module driver.
app_adc_sample_node_t
struct link_node app_adc_sample_node_t
ADC sample-node definition.
app_adc_conversion_sync
uint16_t app_adc_conversion_sync(uint16_t *p_data, uint32_t length, uint32_t timeout)
Polling for conversion.
_adc_handle
ADC handle Structure definition.
Definition: gr533x_hal_adc.h:111
app_adc_pin_t::type
app_io_type_t type
Definition: app_adc.h:108
app_adc_pin_cfg_t::extern_ref
app_adc_pin_t extern_ref
Definition: app_adc.h:121
link_node::next
struct link_node * next
Definition: app_adc.h:165
app_adc_params_t::init
adc_init_t init
Definition: app_adc.h:189
link_node::len
uint32_t len
Definition: app_adc.h:164
link_node::p_buf
uint16_t * p_buf
Definition: app_adc.h:163
APP_ADC_ACTIVITY
@ APP_ADC_ACTIVITY
Definition: app_adc.h:83
app_dma.h
Header file containing functions prototypes of DMA app library.
app_adc_deinit
uint16_t app_adc_deinit(void)
De-initialize the APP ADC DRIVER peripheral.
link_node
ADC sample-node definition.
Definition: app_adc.h:161
link_node::channel
uint32_t channel
Definition: app_adc.h:162
adc_init_t
ll_adc_init_t adc_init_t
ADC init structure definition.
Definition: gr533x_hal_adc.h:100
app_adc_pin_cfg_t::channel_n
app_adc_pin_t channel_n
Definition: app_adc.h:120
app_adc_get_handle
adc_handle_t * app_adc_get_handle(void)
Return the ADC handle.
app_io_mux_t
app_io_mux_t
GPIO mux Enumerations definition.
Definition: app_io.h:255
adc_env_t::handle
adc_handle_t handle
Definition: app_adc.h:174
adc_env_t::multi_channel
uint32_t multi_channel
Definition: app_adc.h:179
app_adc_conversion_async
uint16_t app_adc_conversion_async(uint16_t *p_data, uint32_t length)
DMA for conversion.
app_adc_pin_cfg_t::channel_p
app_adc_pin_t channel_p
Definition: app_adc.h:119
adc_env_t::dma_id
dma_id_t dma_id
Definition: app_adc.h:175
app_drv_error.h
Header file of app driver error code.
app_drv_config.h
Header file of app driver config code.
app_adc_dma_cfg_t::dma_instance
dma_regs_t * dma_instance
Definition: app_adc.h:129
app_adc_dma_state_t
app_adc_dma_state_t
App adc dma state types.
Definition: app_adc.h:91
dma_id_t
int16_t dma_id_t
DMA id definition.
Definition: app_dma.h:98
app_adc_pin_cfg_t
ADC pins config Structures.
Definition: app_adc.h:118
dma_channel_t
dma_channel_t
HAL DMA Channel Enumerations definition.
Definition: gr533x_hal_dma.h:94
adc_env_t::p_current_sample_node
app_adc_sample_node_t * p_current_sample_node
Definition: app_adc.h:178
app_adc_params_t::dma_cfg
app_adc_dma_cfg_t dma_cfg
Definition: app_adc.h:188
app_adc_pin_t
ADC pins Structures.
Definition: app_adc.h:107
app_adc_init
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_a...