gr55xx_hal_adc.h
Go to the documentation of this file.
1 /**
2  ****************************************************************************************
3  *
4  * @file gr55xx_hal_adc.h
5  * @author BLE Driver Team
6  * @brief Header file containing functions prototypes of ADC HAL 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 HAL_DRIVER HAL Driver
43  * @{
44  */
45 
46 /** @defgroup HAL_ADC ADC
47  * @brief ADC HAL module driver.
48  * @{
49  */
50 
51 /* Define to prevent recursive inclusion -------------------------------------*/
52 #ifndef __GR55xx_HAL_ADC_H__
53 #define __GR55xx_HAL_ADC_H__
54 
55 #ifdef __cplusplus
56 extern "C" {
57 #endif
58 
59 /* Includes ------------------------------------------------------------------*/
60 #include "gr55xx_ll_adc.h"
61 #include "gr55xx_hal_def.h"
62 #include "gr55xx_hal_dma.h"
63 
64 /* Exported types ------------------------------------------------------------*/
65 /** @addtogroup HAL_ADC_ENUMERATIONS Enumerations
66  * @{
67  */
68 
69 /** @defgroup HAL_ADC_state HAL ADC State
70  * @{
71  */
72 
73 /**
74  * @brief HAL ADC State Enumerations definition
75  */
76 typedef enum
77 {
78  HAL_ADC_STATE_RESET = 0x00, /**< Peripheral not initialized */
79  HAL_ADC_STATE_READY = 0x01, /**< Peripheral initialized and ready for use */
80  HAL_ADC_STATE_BUSY = 0x02, /**< An internal process is ongoing */
81  HAL_ADC_STATE_ERROR = 0x04 /**< Peripheral in error */
82 
84 
85 /** @} */
86 
87 /**@brief ADC trim parameter information definition.
88  * @{
89 */
90 typedef struct
91 {
92  uint16_t adc_temp; /**< ADC TEMP. */
93  uint16_t slope_int_0p8; /**< Internal reference 0.8v. */
94  uint16_t offset_int_0p8; /**< Internal reference 0.8v. */
95  uint16_t slope_int_1p2; /**< Internal reference 1.2v. */
96  uint16_t offset_int_1p2; /**< Internal reference 1.2v. */
97  uint16_t slope_int_1p6; /**< Internal reference 1.6v. */
98  uint16_t offset_int_1p6; /**< Internal reference 1.6v. */
99  uint16_t slope_int_2p0; /**< Internal reference 2.0v. */
100  uint16_t offset_int_2p0; /**< Internal reference 2.0v. */
101  uint16_t slope_ext_1p0; /**< External reference 1.0v. */
102  uint16_t offset_ext_1p0; /**< External reference 1.0v. */
104 /** @} */
105 
106 /** @} */
107 
108 /** @addtogroup HAL_ADC_STRUCTURES Structures
109  * @{
110  */
111 
112 /** @defgroup ADC_Configuration ADC Configuration
113  * @{
114  */
115 
116 /**
117  * @brief ADC init structure definition
118  */
120 /** @} */
121 
122 /** @defgroup ADC_handle ADC Handle
123  * @{
124  */
125 
126 /**
127  * @brief ADC handle Structure definition
128  */
129 typedef struct _adc_handle
130 {
131  adc_init_t init; /**< ADC configuration parameters */
132 
133  uint16_t *p_buffer; /**< Pointer to ADC conversion buffer */
134 
135  __IO uint32_t buff_size; /**< Conversion buffer size */
136 
137  __IO uint32_t buff_count; /**< Conversion buffer counter */
138 
139  dma_handle_t *p_dma; /**< ADC DMA Handle parameters */
140 
141  __IO hal_lock_t lock; /**< Locking object */
142 
143  __IO hal_adc_state_t state; /**< ADC communication state */
144 
145  __IO uint32_t error_code; /**< ADC error code */
146 
147  uint32_t retention[2]; /**< ADC important register information. */
148 
150 /** @} */
151 
152 /** @} */
153 
154 /** @addtogroup HAL_ADC_CALLBACK_STRUCTURES Callback Structures
155  * @{
156  */
157 
158 /** @defgroup ADC_Callback ADC Callback
159  * @{
160  */
161 
162 /**
163  * @brief HAL ADC Callback function definition
164  */
165 typedef struct _adc_callback
166 {
167  void (*adc_msp_init)(adc_handle_t *p_adc); /**< ADC init MSP callback */
168  void (*adc_msp_deinit)(adc_handle_t *p_adc); /**< ADC de-init MSP callback */
169  void (*adc_conv_cplt_callback)(adc_handle_t *p_adc); /**< ADC conversion completed callback */
171 
172 /** @} */
173 
174 /** @} */
175 
176 /**
177  * @defgroup HAL_ADC_MACRO Defines
178  * @{
179  */
180 
181 /* Exported constants --------------------------------------------------------*/
182 /** @defgroup ADC_Exported_Constants ADC Exported Constants
183  * @{
184  */
185 
186 /** @defgroup ADC_Error_Code ADC Error Code
187  * @{
188  */
189 #define HAL_ADC_ERROR_NONE ((uint32_t)0x00000000) /**< No error */
190 #define HAL_ADC_ERROR_TIMEOUT ((uint32_t)0x00000001) /**< Timeout error */
191 #define HAL_ADC_ERROR_DMA ((uint32_t)0x00000004) /**< DMA transfer error */
192 #define HAL_ADC_ERROR_INVALID_PARAM ((uint32_t)0x00000008) /**< Invalid parameter error */
193 /** @} */
194 
195 /** @defgroup ADC_CLK ADC Clock Select
196  * @{
197  */
198 #if defined(GR552xx)
199 #define ADC_CLK_16M LL_ADC_CLK_16M /**< ADC Clock = 16 MHz */
200 #define ADC_CLK_8M LL_ADC_CLK_8M /**< ADC Clock = 8 MHz */
201 #define ADC_CLK_4M LL_ADC_CLK_4M /**< ADC Clock = 4 MHz */
202 #define ADC_CLK_1M LL_ADC_CLK_1M /**< ADC Clock = 1MHz */
203 #define ADC_CLK_16K LL_ADC_CLK_16K /**< ADC Clock = 16KHz */
204 #define ADC_CLK_8K LL_ADC_CLK_8K /**< ADC Clock = 8KHz */
205 #define ADC_CLK_4K LL_ADC_CLK_4K /**< ADC Clock = 4KHz */
206 #define ADC_CLK_NONE LL_ADC_CLK_NONE /**< Close ADC Clock */
207 #endif
208 /** @} */
209 
210 /** @defgroup ADC_REFERENCE ADC Reference Value Select
211  * @{
212  */
213 #define ADC_REF_VALUE_0P8 LL_ADC_REF_VALUE_0P8 /**< Reference = 0.85 V */
214 #define ADC_REF_VALUE_1P2 LL_ADC_REF_VALUE_1P2 /**< Reference = 1.28 V */
215 #define ADC_REF_VALUE_1P6 LL_ADC_REF_VALUE_1P6 /**< Reference = 1.60 V */
216 #define ADC_REF_VALUE_2P0 LL_ADC_REF_VALUE_2P0 /**< Reference = 2.00 V */
217 /** @} */
218 
219 /** @defgroup ADC_INPUT_MODE ADC Input Mode
220  * @brief Single or Differential mode
221  * @{
222  */
223 #define ADC_INPUT_SINGLE LL_ADC_INPUT_SINGLE /**< Single ended mode */
224 #define ADC_INPUT_DIFFERENTIAL LL_ADC_INPUT_DIFFERENTIAL/**< Differential mode */
225 /** @} */
226 
227 /** @defgroup ADC_INPUT_SOURCE ADC Input Channel Select
228  * @{
229  */
230 #define ADC_INPUT_SRC_IO0 LL_ADC_INPUT_SRC_IO0 /**< Select MSIO0 as input */
231 #define ADC_INPUT_SRC_IO1 LL_ADC_INPUT_SRC_IO1 /**< Select MSIO1 as input */
232 #define ADC_INPUT_SRC_IO2 LL_ADC_INPUT_SRC_IO2 /**< Select MSIO2 as input */
233 #define ADC_INPUT_SRC_IO3 LL_ADC_INPUT_SRC_IO3 /**< Select MSIO3 as input */
234 #define ADC_INPUT_SRC_IO4 LL_ADC_INPUT_SRC_IO4 /**< Select MSIO4 as input */
235 #define ADC_INPUT_SRC_IO5 LL_ADC_INPUT_SRC_IO5 /**< Select MSIO5 as input */
236 #define ADC_INPUT_SRC_IO6 LL_ADC_INPUT_SRC_IO6 /**< Select MSIO6 as input */
237 #define ADC_INPUT_SRC_IO7 LL_ADC_INPUT_SRC_IO7 /**< Select MSIO7 as input */
238 #define ADC_INPUT_SRC_TMP LL_ADC_INPUT_SRC_TMP /**< Select temperature as input */
239 #define ADC_INPUT_SRC_BAT LL_ADC_INPUT_SRC_BAT /**< Select Vbattery as input */
240 #define ADC_INPUT_SRC_REF LL_ADC_INPUT_SRC_REF /**< Select reference as input */
241 
242 /** @} */
243 
244 /** @defgroup ADC_REFERENCE_SOURCE ADC Reference Source Select
245  * @{
246  */
247 #define ADC_REF_SRC_BUF_INT LL_ADC_REF_SRC_BUF_INT /**< Select buffered internal reference as reference */
248 #define ADC_REF_SRC_IO0 LL_ADC_REF_SRC_IO0 /**< Select MSIO0 as reference */
249 #define ADC_REF_SRC_IO1 LL_ADC_REF_SRC_IO1 /**< Select MSIO1 as reference */
250 #define ADC_REF_SRC_IO2 LL_ADC_REF_SRC_IO2 /**< Select MSIO2 as reference */
251 #define ADC_REF_SRC_IO3 LL_ADC_REF_SRC_IO3 /**< Select MSIO3 as reference */
252 /** @} */
253 
254 /**
255  * @brief ADC_default_config initStruct default configuartion
256  */
257 #define ADC_DEFAULT_CONFIG LL_ADC_DEFAULT_CONFIG
258 /** @} */
259 
260 /* Exported macro ------------------------------------------------------------*/
261 /** @defgroup ADC_Exported_Macros ADC Exported Macros
262  * @{
263  */
264 
265 /** @brief Reset ADC handle states.
266  * @param __HANDLE__ ADC handle.
267  * @retval None
268  */
269 #define __HAL_ADC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->state = HAL_ADC_STATE_RESET)
270 
271 /** @brief Enable the specified ADC peripheral.
272  * @param __HANDLE__ Specify the ADC Handle.
273  * @retval None
274  */
275 #define __HAL_ADC_ENABLE(__HANDLE__) ll_adc_enable()
276 
277 /** @brief Disable the specified ADC peripheral.
278  * @param __HANDLE__ Specify the ADC Handle.
279  * @retval None
280  */
281 #define __HAL_ADC_DISABLE(__HANDLE__) ll_adc_disable()
282 
283 /** @brief Check the FIFO is not empty.
284  * @param __HANDLE__ Specify the ADC Handle.
285  * @retval The new state of notempty flag (TRUE or FALSE).
286  */
287 #define __HAL_ADC_GET_FLAG_NOTEMPTY(__HANDLE__) ll_adc_is_fifo_notempty()
288 
289 /** @brief Try to lock ADC token by SW.
290  * @param __HANDLE__ Specify the ADC Handle.
291  * @retval if the token locked by SW is success (TRUE or FALSE).
292  */
293 #define __HAL_ADC_TRY_SWTOKEN_LOCK(__HANDLE__) ll_adc_try_lock_sw_token()
294 
295 /** @brief Flush the FIFO.
296  * @param __HANDLE__ Specify the ADC Handle.
297  * @retval None
298  */
299 #define __HAL_ADC_FLUSH_FIFO(__HANDLE__) do { \
300  while(ll_adc_is_fifo_notempty()) \
301  { \
302  ll_adc_flush_fifo(); \
303  } \
304  } while(0)
305 
306 /** @} */
307 
308 /* Private macros ------------------------------------------------------------*/
309 /** @addtogroup ADC_Private_Macros ADC Private Macros
310  * @{
311  */
312 
313 /**
314  * @brief Check if ADC input source is valid.
315  * @param __INPUT__ ADC input source.
316  * @retval SET (__INPUT__ is valid) or RESET (__INPUT__ is invalid)
317  */
318 #define IS_ADC_INPUT(__INPUT__) (((__INPUT__) == ADC_INPUT_SRC_IO0) || \
319  ((__INPUT__) == ADC_INPUT_SRC_IO1) || \
320  ((__INPUT__) == ADC_INPUT_SRC_IO2) || \
321  ((__INPUT__) == ADC_INPUT_SRC_IO3) || \
322  ((__INPUT__) == ADC_INPUT_SRC_IO4) || \
323  ((__INPUT__) == ADC_INPUT_SRC_IO5) || \
324  ((__INPUT__) == ADC_INPUT_SRC_IO6) || \
325  ((__INPUT__) == ADC_INPUT_SRC_IO7) || \
326  ((__INPUT__) == ADC_INPUT_SRC_TMP) || \
327  ((__INPUT__) == ADC_INPUT_SRC_BAT) || \
328  ((__INPUT__) == ADC_INPUT_SRC_REF))
329 
330 /**
331  * @brief Check if ADC input mode is valid.
332  * @param __MODE__ ADC input mode.
333  * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
334  */
335 #define IS_ADC_INPUT_MODE(__MODE__) (((__MODE__) == ADC_INPUT_SINGLE) || \
336  ((__MODE__) == ADC_INPUT_DIFFERENTIAL)
337 
338 /**
339  * @brief Check if ADC reference source is valid.
340  * @param __INPUT__ ADC reference source.
341  * @retval SET (__INPUT__ is valid) or RESET (__INPUT__ is invalid)
342  */
343 #define IS_ADC_REF(__INPUT__) (((__INPUT__) == ADC_REF_SRC_BUF_INT) || \
344  ((__INPUT__) == ADC_REF_SRC_INT) || \
345  ((__INPUT__) == ADC_REF_SRC_IO0) || \
346  ((__INPUT__) == ADC_REF_SRC_IO1) || \
347  ((__INPUT__) == ADC_REF_SRC_IO2) || \
348  ((__INPUT__) == ADC_REF_SRC_IO3))
349 
350 /**
351  * @brief Check if ADC reference value is valid.
352  * @param __VALUE__ ADC reference value.
353  * @retval SET (__VALUE__ is valid) or RESET (__VALUE__ is invalid)
354  */
355 #define IS_ADC_REF_VALUE(__VALUE__) (((__VALUE__) >= ADC_REF_VALUE_0P5) && \
356  ((__VALUE__) <= ADC_REF_VALUE_2P0))
357 
358 /**
359  * @brief Check if ADC clock is valid.
360  * @param __CLOCK__ ADC clock.
361  * @retval SET (__CLOCK__ is valid) or RESET (__CLOCK__ is invalid)
362  */
363 #if defined(GR552xx)
364 #define IS_ADC_CLOCK(__CLOCK__) (((__CLOCK__) == ADC_CLK_16M) || \
365  ((__CLOCK__) == ADC_CLK_8M) || \
366  ((__CLOCK__) == ADC_CLK_1M) || \
367  ((__CLOCK__) == ADC_CLK_250K)|| \
368  ((__CLOCK__) == ADC_CLK_16K)|| \
369  ((__CLOCK__) == ADC_CLK_8K)|| \
370  ((__CLOCK__) == ADC_CLK_1K)|| \
371  ((__CLOCK__) == ADC_CLK_NONE))
372 #else
373 #define IS_ADC_CLOCK(__CLOCK__) (((__CLOCK__) == ADC_CLK_16M) || \
374  ((__CLOCK__) == ADC_CLK_8M) || \
375  ((__CLOCK__) == ADC_CLK_4M) || \
376  ((__CLOCK__) == ADC_CLK_2M) || \
377  ((__CLOCK__) == ADC_CLK_1M) || \
378  ((__CLOCK__) == ADC_CLK_1P6M))
379 #endif
380 
381 /** @} */
382 
383 /** @} */
384 
385 /* Exported functions --------------------------------------------------------*/
386 /** @addtogroup HAL_ADC_DRIVER_FUNCTIONS Functions
387  * @{
388  */
389 
390 /** @addtogroup ADC_Exported_Functions_Group1 Initialization and de-initialization Functions
391  * @brief Initialization and Configuration functions
392  * @{
393  */
394 
395 /**
396  ****************************************************************************************
397  * @brief Initialize the ADC according to the specified parameters
398  * in the adc_init_t and initialize the associated handle.
399  *
400  * @param[in] p_adc: Pointer to an ADC handle which contains the configuration information for
401  * the specified ADC module.
402  *
403  * @retval ::HAL_OK: Operation is OK.
404  * @retval ::HAL_ERROR: Parameter error or operation not supported.
405  * @retval ::HAL_BUSY: Driver is busy.
406  * @retval ::HAL_TIMEOUT: Timeout occurred.
407  ****************************************************************************************
408  */
410 
411 /**
412  ****************************************************************************************
413  * @brief De-initialize the ADC peripheral.
414  *
415  * @param[in] p_adc: Pointer to an ADC handle which contains the configuration information for
416  * the specified ADC module.
417  *
418  * @retval ::HAL_OK: Operation is OK.
419  * @retval ::HAL_ERROR: Parameter error or operation not supported.
420  * @retval ::HAL_BUSY: Driver is busy.
421  * @retval ::HAL_TIMEOUT: Timeout occurred.
422  ****************************************************************************************
423  */
425 
426 /**
427  ****************************************************************************************
428  * @brief Initialize the ADC MSP.
429  *
430  * @note This function should not be modified. When the callback is needed,
431  * the hal_adc_msp_deinit can be implemented in the user file.
432  *
433  * @param[in] p_adc: Pointer to an ADC handle which contains the configuration information for
434  * the specified ADC module.
435  ****************************************************************************************
436  */
438 
439 /**
440  ****************************************************************************************
441  * @brief De-initialize the ADC MSP.
442  *
443  * @note This function should not be modified. When the callback is needed,
444  * the hal_adc_msp_deinit can be implemented in the user file.
445  *
446  * @param[in] p_adc: Pointer to an ADC handle which contains the configuration information for
447  * the specified ADC module.
448  ****************************************************************************************
449  */
451 
452 /** @} */
453 
454 /** @addtogroup ADC_Exported_Functions_Group2 IO Operation Functions
455  * @brief ADC polling and DMA conversion management functions.
456  * @{
457  */
458 
459 /**
460  ****************************************************************************************
461  * @brief Polling for conversion.
462  *
463  * @param[in] p_adc: Pointer to an ADC handle.
464  * @param[in] p_data: Pointer to data buffer which to store ADC conversion results.
465  * @param[in] length: Length of data buffer.
466  *
467  * @retval ::HAL_OK: Operation is OK.
468  * @retval ::HAL_ERROR: Parameter error or operation not supported.
469  * @retval ::HAL_BUSY: Driver is busy.
470  * @retval ::HAL_TIMEOUT: Timeout occurred.
471  ****************************************************************************************
472  */
473 hal_status_t hal_adc_poll_for_conversion(adc_handle_t *p_adc, uint16_t *p_data, uint32_t length);
474 
475 /**
476  ****************************************************************************************
477  * @brief DMA for conversion.
478  *
479  * @param[in] p_adc: Pointer to an ADC handle.
480  * @param[in] p_data: Pointer to data buffer which to store ADC conversion results.
481  * @param[in] length: Length of data buffer, ranging between 0 and 4095.
482  *
483  * @retval ::HAL_OK: Operation is OK.
484  * @retval ::HAL_ERROR: Parameter error or operation not supported.
485  * @retval ::HAL_BUSY: Driver is busy.
486  * @retval ::HAL_TIMEOUT: Timeout occurred.
487  ****************************************************************************************
488  */
489 hal_status_t hal_adc_start_dma(adc_handle_t *p_adc, uint16_t *p_data, uint32_t length);
490 
491 /**
492  ****************************************************************************************
493  * @brief DMA for conversion.
494  *
495  * @param[in] p_adc: Pointer to an ADC handle.
496  * @param[in] p_data: Pointer to data buffer which to store ADC conversion results.
497  * @param[in] length: Length of data buffer, ranging between 0 and 4095.
498  * @param[in] sg_llp_config: The config of source and destination's SG and LLP functions.
499  *
500  * @retval ::HAL_OK: Operation is OK.
501  * @retval ::HAL_ERROR: Parameter error or operation not supported.
502  * @retval ::HAL_BUSY: Driver is busy.
503  * @retval ::HAL_TIMEOUT: Timeout occurred.
504  ****************************************************************************************
505  */
506 hal_status_t hal_adc_start_dma_sg_llp(adc_handle_t *p_adc, uint16_t *p_data, uint32_t length, dma_sg_llp_config_t *sg_llp_config);
507 
508 /**
509  ****************************************************************************************
510  * @brief Abort ongoing conversion (blocking mode).
511  *
512  * @note This procedure could be only used for aborting conversion started in DMA mode.
513  * This procedure performs following operations:
514  * - Disable ADC clock, stop conversion
515  * - Abort DMA transfer by calling hal_dma_abort (in case of transfer in DMA mode)
516  * - Set handle State to READY.
517  * This procedure is executed in blocking mode: when exiting function, Abort is considered as completed.
518  *
519  * @param[in] p_adc: ADC handle.
520  *
521  * @retval ::HAL_OK: Operation is OK.
522  * @retval ::HAL_ERROR: Parameter error or operation not supported.
523  * @retval ::HAL_BUSY: Driver is busy.
524  * @retval ::HAL_TIMEOUT: Timeout occurred.
525  ****************************************************************************************
526  */
528 
529 /**
530  ****************************************************************************************
531  * @brief Conversion completed callback.
532  *
533  * @note This function should not be modified. When the callback is needed,
534  * the hal_adc_conv_cplt_callback can be implemented in the user file.
535  *
536  * @param[in] p_adc: Pointer to an ADC handle which contains the configuration information for
537  * the specified ADC module.
538  ****************************************************************************************
539  */
541 
542 /** @} */
543 
544 /** @defgroup ADC_Exported_Functions_Group3 Peripheral State and Errors Functions
545  * @brief ADC control functions
546  *
547 @verbatim
548  ===============================================================================
549  ##### Peripheral State and Errors functions #####
550  ===============================================================================
551  [..]
552  This subsection provides a set of functions allowing to control the ADC.
553  (+) hal_adc_get_state() API can be helpful to check in run-time the state of the ADC peripheral.
554  (+) hal_adc_get_error() check in run-time Errors occurring during communication.
555 @endverbatim
556  * @{
557  */
558 
559 /**
560  ****************************************************************************************
561  * @brief Return the ADC handle state.
562  *
563  * @param[in] p_adc: Pointer to an ADC handle which contains the configuration information for
564  * the specified ADC module.
565  *
566  * @retval ::HAL_ADC_STATE_RESET: Peripheral not initialized.
567  * @retval ::HAL_ADC_STATE_READY: Peripheral initialized and ready for use.
568  * @retval ::HAL_ADC_STATE_BUSY: An internal process is ongoing.
569  * @retval ::HAL_ADC_STATE_ERROR: Peripheral in error.
570  ****************************************************************************************
571  */
573 
574 /**
575  ****************************************************************************************
576  * @brief Return the ADC error code.
577  *
578  * @param[in] p_adc: Pointer to an ADC handle which contains the configuration information for
579  * the specified ADC module.
580  *
581  * @return ADC error code in bitmap format
582  ****************************************************************************************
583  */
585 
586 /**
587  ****************************************************************************************
588  * @brief Suspend some registers related to ADC configuration before sleep.
589  * @param[in] p_adc: Pointer to a ADC handle which contains the configuration
590  * information for the specified ADC module.
591  * @retval ::HAL_OK: Operation is OK.
592  * @retval ::HAL_ERROR: Parameter error or operation not supported.
593  * @retval ::HAL_BUSY: Driver is busy.
594  * @retval ::HAL_TIMEOUT: Timeout occurred.
595  ****************************************************************************************
596  */
598 
599 /**
600  ****************************************************************************************
601  * @brief Restore some registers related to ADC configuration after sleep.
602  * This function must be used in conjunction with the hal_adc_suspend_reg().
603  * @param[in] p_adc: Pointer to a ADC handle which contains the configuration
604  * information for the specified ADC module.
605  * @retval ::HAL_OK: Operation is OK.
606  * @retval ::HAL_ERROR: Parameter error or operation not supported.
607  * @retval ::HAL_BUSY: Driver is busy.
608  * @retval ::HAL_TIMEOUT: Timeout occurred.
609  ****************************************************************************************
610  */
612 
613 
614 /**
615  ****************************************************************************************
616  * @brief Set the new channels parameter to ADC
617  *
618  * @param[in] p_adc: Pointer to a ADC handle which contains the new channels parameter.
619  *
620  * @retval ::HAL_OK: Operation is OK.
621  * @retval ::HAL_ERROR: Parameter error or operation not supported.
622  * @retval ::HAL_BUSY: Driver is busy.
623  * @retval ::HAL_TIMEOUT: Timeout occurred.
624  ****************************************************************************************
625  */
627 
628 /** @} */
629 
630 /** @} */
631 
632 
633 #ifdef __cplusplus
634 }
635 #endif
636 
637 #endif /* __GR55xx_HAL_ADC_H__ */
638 
639 /** @} */
640 
641 /** @} */
642 
643 /** @} */
hal_adc_poll_for_conversion
hal_status_t hal_adc_poll_for_conversion(adc_handle_t *p_adc, uint16_t *p_data, uint32_t length)
Polling for conversion.
adc_trim_info_t::offset_int_1p2
uint16_t offset_int_1p2
Definition: gr55xx_hal_adc.h:96
hal_adc_get_error
uint32_t hal_adc_get_error(adc_handle_t *p_adc)
Return the ADC error code.
adc_trim_info_t::offset_int_2p0
uint16_t offset_int_2p0
Definition: gr55xx_hal_adc.h:100
adc_trim_info_t::slope_int_1p6
uint16_t slope_int_1p6
Definition: gr55xx_hal_adc.h:97
hal_lock_t
hal_lock_t
HAL Lock structures definition.
Definition: gr55xx_hal_def.h:81
_adc_handle::error_code
__IO uint32_t error_code
Definition: gr55xx_hal_adc.h:145
HAL_ADC_STATE_BUSY
@ HAL_ADC_STATE_BUSY
Definition: gr55xx_hal_adc.h:80
hal_adc_start_dma_sg_llp
hal_status_t hal_adc_start_dma_sg_llp(adc_handle_t *p_adc, uint16_t *p_data, uint32_t length, dma_sg_llp_config_t *sg_llp_config)
DMA for conversion.
gr55xx_ll_adc.h
Header file containing functions prototypes of ADC LL library.
HAL_ADC_STATE_RESET
@ HAL_ADC_STATE_RESET
Definition: gr55xx_hal_adc.h:78
_adc_callback::adc_conv_cplt_callback
void(* adc_conv_cplt_callback)(adc_handle_t *p_adc)
Definition: gr55xx_hal_adc.h:169
adc_trim_info_t::offset_int_0p8
uint16_t offset_int_0p8
Definition: gr55xx_hal_adc.h:94
_adc_handle::p_buffer
uint16_t * p_buffer
Definition: gr55xx_hal_adc.h:133
hal_adc_stop_dma
hal_status_t hal_adc_stop_dma(adc_handle_t *p_adc)
Abort ongoing conversion (blocking mode).
adc_trim_info_t::slope_ext_1p0
uint16_t slope_ext_1p0
Definition: gr55xx_hal_adc.h:101
hal_adc_init
hal_status_t hal_adc_init(adc_handle_t *p_adc)
Initialize the ADC according to the specified parameters in the adc_init_t and initialize the associa...
hal_adc_resume_reg
hal_status_t hal_adc_resume_reg(adc_handle_t *p_adc)
Restore some registers related to ADC configuration after sleep. This function must be used in conjun...
adc_trim_info_t::slope_int_0p8
uint16_t slope_int_0p8
Definition: gr55xx_hal_adc.h:93
dma_sg_llp_config
LL DMA sg and llp config definition.
Definition: gr55xx_hal_dma.h:219
adc_handle_t
struct _adc_handle adc_handle_t
ADC handle Structure definition.
hal_adc_suspend_reg
hal_status_t hal_adc_suspend_reg(adc_handle_t *p_adc)
Suspend some registers related to ADC configuration before sleep.
_ll_adc_init
LL ADC init Structure definition.
Definition: gr55xx_ll_adc.h:77
_adc_callback::adc_msp_init
void(* adc_msp_init)(adc_handle_t *p_adc)
Definition: gr55xx_hal_adc.h:167
adc_trim_info_t::slope_int_2p0
uint16_t slope_int_2p0
Definition: gr55xx_hal_adc.h:99
hal_adc_state_t
hal_adc_state_t
HAL ADC State Enumerations definition.
Definition: gr55xx_hal_adc.h:77
hal_adc_msp_init
void hal_adc_msp_init(adc_handle_t *p_adc)
Initialize the ADC MSP.
_adc_handle::state
__IO hal_adc_state_t state
Definition: gr55xx_hal_adc.h:143
hal_adc_conv_cplt_callback
void hal_adc_conv_cplt_callback(adc_handle_t *p_adc)
Conversion completed callback.
adc_trim_info_t::adc_temp
uint16_t adc_temp
Definition: gr55xx_hal_adc.h:92
_adc_callback::adc_msp_deinit
void(* adc_msp_deinit)(adc_handle_t *p_adc)
Definition: gr55xx_hal_adc.h:168
_adc_handle
ADC handle Structure definition.
Definition: gr55xx_hal_adc.h:130
gr55xx_hal_dma.h
Header file containing functions prototypes of DMA HAL library.
adc_trim_info_t::offset_ext_1p0
uint16_t offset_ext_1p0
Definition: gr55xx_hal_adc.h:102
hal_status_t
hal_status_t
HAL Status structures definition.
Definition: gr55xx_hal_def.h:70
hal_adc_msp_deinit
void hal_adc_msp_deinit(adc_handle_t *p_adc)
De-initialize the ADC MSP.
adc_callback_t
struct _adc_callback adc_callback_t
HAL ADC Callback function definition.
adc_trim_info_t
ADC trim parameter information definition.
Definition: gr55xx_hal_adc.h:91
adc_init_t
ll_adc_init_t adc_init_t
ADC init structure definition.
Definition: gr55xx_hal_adc.h:119
hal_adc_start_dma
hal_status_t hal_adc_start_dma(adc_handle_t *p_adc, uint16_t *p_data, uint32_t length)
DMA for conversion.
adc_trim_info_t::slope_int_1p2
uint16_t slope_int_1p2
Definition: gr55xx_hal_adc.h:95
_adc_callback
HAL ADC Callback function definition.
Definition: gr55xx_hal_adc.h:166
hal_adc_change_channels
hal_status_t hal_adc_change_channels(adc_handle_t *p_adc)
Set the new channels parameter to ADC.
_adc_handle::init
adc_init_t init
Definition: gr55xx_hal_adc.h:131
HAL_ADC_STATE_ERROR
@ HAL_ADC_STATE_ERROR
Definition: gr55xx_hal_adc.h:81
hal_adc_deinit
hal_status_t hal_adc_deinit(adc_handle_t *p_adc)
De-initialize the ADC peripheral.
_adc_handle::p_dma
dma_handle_t * p_dma
Definition: gr55xx_hal_adc.h:139
adc_trim_info_t::offset_int_1p6
uint16_t offset_int_1p6
Definition: gr55xx_hal_adc.h:98
_adc_handle::retention
uint32_t retention[2]
Definition: gr55xx_hal_adc.h:147
HAL_ADC_STATE_READY
@ HAL_ADC_STATE_READY
Definition: gr55xx_hal_adc.h:79
_adc_handle::lock
__IO hal_lock_t lock
Definition: gr55xx_hal_adc.h:141
_dma_handle
DMA handle Structure definition.
Definition: gr55xx_hal_dma.h:277
gr55xx_hal_def.h
This file contains HAL common definitions, enumeration, macros and structures definitions.
_adc_handle::buff_count
__IO uint32_t buff_count
Definition: gr55xx_hal_adc.h:137
_adc_handle::buff_size
__IO uint32_t buff_size
Definition: gr55xx_hal_adc.h:135
hal_adc_get_state
hal_adc_state_t hal_adc_get_state(adc_handle_t *p_adc)
Return the ADC handle state.