gr55xx_hal_adc.h

Go to the documentation of this file.

/**
 ****************************************************************************************
 *
 * @file    gr55xx_hal_adc.h
 * @author  BLE Driver Team
 * @brief   Header file containing functions prototypes of ADC HAL library.
 *
 ****************************************************************************************
 * @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.
 ****************************************************************************************
 */
 
/** @addtogroup PERIPHERAL Peripheral Driver
  * @{
  */
 
/** @addtogroup HAL_DRIVER HAL Driver
  * @{
  */
 
/** @defgroup HAL_ADC ADC
  * @brief ADC HAL module driver.
  * @{
  */
 
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __GR55xx_HAL_ADC_H__
#define __GR55xx_HAL_ADC_H__
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Includes ------------------------------------------------------------------*/
#include "gr55xx_ll_adc.h"
#include "gr55xx_hal_def.h"
#include "gr55xx_hal_dma.h"
 
/* Exported types ------------------------------------------------------------*/
/** @addtogroup HAL_ADC_ENUMERATIONS Enumerations
  * @{
  */
 
/** @defgroup HAL_ADC_state HAL ADC State
  * @{
  */
 
/**
  * @brief HAL ADC State Enumerations definition
  */
typedef enum
{
    HAL_ADC_STATE_RESET        = 0x00,    /**< Peripheral not initialized                          */
    HAL_ADC_STATE_READY        = 0x01,    /**< Peripheral initialized and ready for use            */
    HAL_ADC_STATE_BUSY         = 0x02,    /**< An internal process is ongoing                      */
    HAL_ADC_STATE_ERROR        = 0x04     /**< Peripheral in error                                 */
 
} hal_adc_state_t;
 
/** @} */
 
/** @} */
 
/** @addtogroup HAL_ADC_STRUCTURES Structures
  * @{
  */
 
/**@brief ADC trim parameter information definition.
  * @{
*/
typedef struct
{
    uint16_t adc_temp;                /**< ADC TEMP. */
    uint16_t slope_int_0p8;           /**< Internal reference 0.8v. */
    uint16_t offset_int_0p8;          /**< Internal reference 0.8v. */
    uint16_t slope_int_1p2;           /**< Internal reference 1.2v. */
    uint16_t offset_int_1p2;          /**< Internal reference 1.2v. */
    uint16_t slope_int_1p6;           /**< Internal reference 1.6v. */
    uint16_t offset_int_1p6;          /**< Internal reference 1.6v. */
    uint16_t slope_int_2p0;           /**< Internal reference 2.0v. */
    uint16_t offset_int_2p0;          /**< Internal reference 2.0v. */
    uint16_t slope_ext_1p0;           /**< External reference 1.0v. */
    uint16_t offset_ext_1p0;          /**< External reference 1.0v. */
} adc_trim_info_t;
/** @} */
 
/** @defgroup ADC_Configuration ADC Configuration
  * @{
  */
 
/**
  * @brief   ADC init structure definition
  */
typedef ll_adc_init_t       adc_init_t;
/** @} */
 
/** @defgroup ADC_handle ADC Handle
  * @{
  */
 
/**
  * @brief ADC handle Structure definition
  */
typedef struct _adc_handle
{
    adc_init_t              init;           /**< ADC configuration parameters      */
 
    uint16_t               *p_buffer;       /**< Pointer to ADC conversion buffer  */
 
    __IO uint32_t           buff_size;      /**< Conversion buffer size            */
 
    __IO uint32_t           buff_count;     /**< Conversion buffer counter         */
 
    dma_handle_t           *p_dma;          /**< ADC DMA Handle parameters         */
 
    __IO hal_lock_t         lock;           /**< Locking object                    */
 
    __IO hal_adc_state_t    state;          /**< ADC communication state           */
 
    __IO uint32_t           error_code;     /**< ADC error code                    */
 
    uint32_t                retention[2];   /**< ADC important register information. */
 
} adc_handle_t;
/** @} */
 
/** @} */
 
/** @addtogroup HAL_ADC_CALLBACK_STRUCTURES Callback Structures
  * @{
  */
 
/** @defgroup ADC_Callback ADC Callback
  * @{
  */
 
/**
  * @brief HAL ADC Callback function definition
  */
typedef struct _hal_adc_callback
{
    void (*adc_msp_init)(adc_handle_t *p_adc);                  /**< ADC init MSP callback                  */
    void (*adc_msp_deinit)(adc_handle_t *p_adc);                /**< ADC de-init MSP callback               */
    void (*adc_conv_cplt_callback)(adc_handle_t *p_adc);        /**< ADC conversion completed callback      */
    uint16_t (*adc_get_trim_func)(adc_trim_info_t *p_adc_trim); /**< ADC get trim information callback(must return 0x0000 when successful)*/
} hal_adc_callback_t;
 
/** @} */
 
/** @} */
 
/**
  * @defgroup  HAL_ADC_MACRO Defines
  * @{
  */
 
/* Exported constants --------------------------------------------------------*/
/** @defgroup ADC_Exported_Constants ADC Exported Constants
  * @{
  */
 
/** @defgroup ADC_Error_Code ADC Error Code
  * @{
  */
#define HAL_ADC_ERROR_NONE              ((uint32_t)0x00000000)  /**< No error           */
#define HAL_ADC_ERROR_TIMEOUT           ((uint32_t)0x00000001)  /**< Timeout error      */
#define HAL_ADC_ERROR_DMA               ((uint32_t)0x00000004)  /**< DMA transfer error */
#define HAL_ADC_ERROR_INVALID_PARAM     ((uint32_t)0x00000008)  /**< Invalid parameter error */
/** @} */
 
/** @defgroup ADC_CLK ADC Clock Select
  * @{
  */
#if defined(GR552xx)
#define ADC_CLK_16M                 LL_ADC_CLK_16M           /**< ADC Clock = 16 MHz  */
#define ADC_CLK_8M                  LL_ADC_CLK_8M            /**< ADC Clock = 8 MHz  */
#define ADC_CLK_4M                  LL_ADC_CLK_4M            /**< ADC Clock = 4 MHz  */
#define ADC_CLK_1M                  LL_ADC_CLK_1M          /**< ADC Clock = 1MHz  */
#define ADC_CLK_16K                 LL_ADC_CLK_16K           /**< ADC Clock = 16KHz  */
#define ADC_CLK_8K                  LL_ADC_CLK_8K            /**< ADC Clock = 8KHz  */
#define ADC_CLK_4K                  LL_ADC_CLK_4K            /**< ADC Clock = 4KHz  */
#define ADC_CLK_NONE                LL_ADC_CLK_NONE          /**< Close ADC Clock */
#endif
/** @} */
 
/** @defgroup ADC_REFERENCE ADC Reference Value Select
  * @{
  */
#define ADC_REF_VALUE_0P8           LL_ADC_REF_VALUE_0P8    /**< Reference = 0.85 V   */
#define ADC_REF_VALUE_1P2           LL_ADC_REF_VALUE_1P2    /**< Reference = 1.28 V   */
#define ADC_REF_VALUE_1P6           LL_ADC_REF_VALUE_1P6    /**< Reference = 1.60 V   */
#define ADC_REF_VALUE_2P0           LL_ADC_REF_VALUE_2P0    /**< Reference = 2.00 V   */
/** @} */
 
/** @defgroup ADC_INPUT_MODE ADC Input Mode
  * @brief Single or Differential mode
  * @{
  */
#define ADC_INPUT_SINGLE            LL_ADC_INPUT_SINGLE      /**< Single ended mode */
#define ADC_INPUT_DIFFERENTIAL      LL_ADC_INPUT_DIFFERENTIAL/**< Differential mode */
/** @} */
 
/** @defgroup ADC_INPUT_SOURCE ADC Input Channel Select
  * @{
  */
#define ADC_INPUT_SRC_IO0           LL_ADC_INPUT_SRC_IO0    /**< Select MSIO0 as input       */
#define ADC_INPUT_SRC_IO1           LL_ADC_INPUT_SRC_IO1    /**< Select MSIO1 as input       */
#define ADC_INPUT_SRC_IO2           LL_ADC_INPUT_SRC_IO2    /**< Select MSIO2 as input       */
#define ADC_INPUT_SRC_IO3           LL_ADC_INPUT_SRC_IO3    /**< Select MSIO3 as input       */
#define ADC_INPUT_SRC_IO4           LL_ADC_INPUT_SRC_IO4    /**< Select MSIO4 as input       */
#define ADC_INPUT_SRC_IO5           LL_ADC_INPUT_SRC_IO5    /**< Select MSIO5 as input       */
#define ADC_INPUT_SRC_IO6           LL_ADC_INPUT_SRC_IO6    /**< Select MSIO6 as input       */
#define ADC_INPUT_SRC_IO7           LL_ADC_INPUT_SRC_IO7    /**< Select MSIO7 as input       */
#define ADC_INPUT_SRC_TMP           LL_ADC_INPUT_SRC_TMP    /**< Select temperature as input */
#define ADC_INPUT_SRC_BAT           LL_ADC_INPUT_SRC_BAT    /**< Select Vbattery as input    */
#define ADC_INPUT_SRC_REF           LL_ADC_INPUT_SRC_REF    /**< Select reference as input   */
 
/** @} */
 
/** @defgroup ADC_REFERENCE_SOURCE ADC Reference Source Select
  * @{
  */
#define ADC_REF_SRC_BUF_INT         LL_ADC_REF_SRC_BUF_INT  /**< Select buffered internal reference as reference   */
#define ADC_REF_SRC_IO0             LL_ADC_REF_SRC_IO0      /**< Select MSIO0 as reference                         */
#define ADC_REF_SRC_IO1             LL_ADC_REF_SRC_IO1      /**< Select MSIO1 as reference                         */
#define ADC_REF_SRC_IO2             LL_ADC_REF_SRC_IO2      /**< Select MSIO2 as reference                         */
#define ADC_REF_SRC_IO3             LL_ADC_REF_SRC_IO3      /**< Select MSIO3 as reference                         */
/** @} */
 
/**
  * @brief ADC_default_config initStruct default configuartion
  */
#define ADC_DEFAULT_CONFIG          LL_ADC_DEFAULT_CONFIG
/** @} */
 
/* Exported macro ------------------------------------------------------------*/
/** @defgroup ADC_Exported_Macros ADC Exported Macros
  * @{
  */
 
/** @brief  Reset ADC handle states.
  * @param  __HANDLE__ ADC handle.
  * @retval None
  */
#define __HAL_ADC_RESET_HANDLE_STATE(__HANDLE__)               ((__HANDLE__)->state = HAL_ADC_STATE_RESET)
 
/** @brief  Enable the specified ADC peripheral.
  * @param  __HANDLE__ Specify the ADC Handle.
  * @retval None
  */
#define __HAL_ADC_ENABLE(__HANDLE__)                           ll_adc_enable()
 
/** @brief  Disable the specified ADC peripheral.
  * @param  __HANDLE__ Specify the ADC Handle.
  * @retval None
  */
#define __HAL_ADC_DISABLE(__HANDLE__)                          ll_adc_disable()
 
/** @brief  Check the FIFO is not empty.
  * @param  __HANDLE__ Specify the ADC Handle.
  * @retval The new state of notempty flag (TRUE or FALSE).
  */
#define __HAL_ADC_GET_FLAG_NOTEMPTY(__HANDLE__)                ll_adc_is_fifo_notempty()
 
/** @brief  Try to lock ADC token by SW.
  * @param  __HANDLE__ Specify the ADC Handle.
  * @retval if the token locked by SW is success (TRUE or FALSE).
  */
#define __HAL_ADC_TRY_SWTOKEN_LOCK(__HANDLE__)                 ll_adc_try_lock_sw_token()
 
/** @brief  Flush the FIFO.
  * @param  __HANDLE__ Specify the ADC Handle.
  * @retval None
  */
#define __HAL_ADC_FLUSH_FIFO(__HANDLE__)                       do {                                 \
                                                                   while(ll_adc_is_fifo_notempty()) \
                                                                   {                                \
                                                                       ll_adc_flush_fifo();         \
                                                                   }                                \
                                                               } while(0)
 
/** @} */
 
/* Private macros ------------------------------------------------------------*/
/** @addtogroup ADC_Private_Macros ADC Private Macros
  * @{
  */
 
/**
  * @brief Check if ADC input source is valid.
  * @param __INPUT__ ADC input source.
  * @retval SET (__INPUT__ is valid) or RESET (__INPUT__ is invalid)
  */
#define IS_ADC_INPUT(__INPUT__)             (((__INPUT__) == ADC_INPUT_SRC_IO0) || \
                                             ((__INPUT__) == ADC_INPUT_SRC_IO1) || \
                                             ((__INPUT__) == ADC_INPUT_SRC_IO2) || \
                                             ((__INPUT__) == ADC_INPUT_SRC_IO3) || \
                                             ((__INPUT__) == ADC_INPUT_SRC_IO4) || \
                                             ((__INPUT__) == ADC_INPUT_SRC_IO5) || \
                                             ((__INPUT__) == ADC_INPUT_SRC_IO6) || \
                                             ((__INPUT__) == ADC_INPUT_SRC_IO7) || \
                                             ((__INPUT__) == ADC_INPUT_SRC_TMP) || \
                                             ((__INPUT__) == ADC_INPUT_SRC_BAT) || \
                                             ((__INPUT__) == ADC_INPUT_SRC_REF))
 
/**
  * @brief Check if ADC input mode is valid.
  * @param __MODE__ ADC input mode.
  * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
  */
#define IS_ADC_INPUT_MODE(__MODE__)         (((__MODE__) == ADC_INPUT_SINGLE) || \
                                             ((__MODE__) == ADC_INPUT_DIFFERENTIAL)
 
/**
  * @brief Check if ADC reference source is valid.
  * @param __INPUT__ ADC reference source.
  * @retval SET (__INPUT__ is valid) or RESET (__INPUT__ is invalid)
  */
#define IS_ADC_REF(__INPUT__)               (((__INPUT__) == ADC_REF_SRC_BUF_INT) || \
                                             ((__INPUT__) == ADC_REF_SRC_INT)     || \
                                             ((__INPUT__) == ADC_REF_SRC_IO0)     || \
                                             ((__INPUT__) == ADC_REF_SRC_IO1)     || \
                                             ((__INPUT__) == ADC_REF_SRC_IO2)     || \
                                             ((__INPUT__) == ADC_REF_SRC_IO3))
 
/**
  * @brief Check if ADC reference value is valid.
  * @param __VALUE__ ADC reference value.
  * @retval SET (__VALUE__ is valid) or RESET (__VALUE__ is invalid)
  */
#define IS_ADC_REF_VALUE(__VALUE__)         (((__VALUE__) >= ADC_REF_VALUE_0P5) && \
                                             ((__VALUE__) <= ADC_REF_VALUE_2P0))
 
/**
  * @brief Check if ADC clock is valid.
  * @param __CLOCK__ ADC clock.
  * @retval SET (__CLOCK__ is valid) or RESET (__CLOCK__ is invalid)
  */
#if defined(GR552xx)
#define IS_ADC_CLOCK(__CLOCK__)             (((__CLOCK__) == ADC_CLK_16M) || \
                                             ((__CLOCK__) == ADC_CLK_8M)  || \
                                             ((__CLOCK__) == ADC_CLK_1M)  || \
                                             ((__CLOCK__) == ADC_CLK_250K)|| \
                                             ((__CLOCK__) == ADC_CLK_16K)|| \
                                             ((__CLOCK__) == ADC_CLK_8K)|| \
                                             ((__CLOCK__) == ADC_CLK_1K)|| \
                                             ((__CLOCK__) == ADC_CLK_NONE))
#else
#define IS_ADC_CLOCK(__CLOCK__)             (((__CLOCK__) == ADC_CLK_16M) || \
                                             ((__CLOCK__) == ADC_CLK_8M)  || \
                                             ((__CLOCK__) == ADC_CLK_4M)  || \
                                             ((__CLOCK__) == ADC_CLK_2M)  || \
                                             ((__CLOCK__) == ADC_CLK_1M)  || \
                                             ((__CLOCK__) == ADC_CLK_1P6M))
#endif
 
/** @} */
 
/** @} */
 
/* Exported functions --------------------------------------------------------*/
/** @addtogroup HAL_ADC_DRIVER_FUNCTIONS Functions
  * @{
  */
 
/** @addtogroup ADC_Exported_Functions_Group1 Initialization and de-initialization Functions
  *  @brief    Initialization and Configuration functions
  * @{
  */
 
/**
 ****************************************************************************************
 * @brief  Initialize the ADC according to the specified parameters
 *         in the adc_init_t and initialize the associated handle.
 *
 * @param[in]  p_adc: Pointer to an ADC handle which contains the configuration information for
 *                    the specified ADC module.
 *
 * @retval ::HAL_OK: Operation is OK.
 * @retval ::HAL_ERROR: Parameter error or operation not supported.
 * @retval ::HAL_BUSY: Driver is busy.
 * @retval ::HAL_TIMEOUT: Timeout occurred.
 ****************************************************************************************
 */
hal_status_t hal_adc_init(adc_handle_t *p_adc);
 
/**
 ****************************************************************************************
 * @brief  De-initialize the ADC peripheral.
 *
 * @param[in]  p_adc: Pointer to an ADC handle which contains the configuration information for
 *                    the specified ADC module.
 *
 * @retval ::HAL_OK: Operation is OK.
 * @retval ::HAL_ERROR: Parameter error or operation not supported.
 * @retval ::HAL_BUSY: Driver is busy.
 * @retval ::HAL_TIMEOUT: Timeout occurred.
 ****************************************************************************************
 */
hal_status_t hal_adc_deinit(adc_handle_t *p_adc);
 
/**
 ****************************************************************************************
 * @brief  Initialize the ADC MSP.
 *
 * @note   This function should not be modified. When the callback is needed,
 *          the hal_adc_msp_deinit can be implemented in the user file.
 *
 * @param[in]  p_adc: Pointer to an ADC handle which contains the configuration information for
 *                the specified ADC module.
 ****************************************************************************************
 */
void hal_adc_msp_init(adc_handle_t *p_adc);
 
/**
 ****************************************************************************************
 * @brief  De-initialize the ADC MSP.
 *
 * @note   This function should not be modified. When the callback is needed,
 *          the hal_adc_msp_deinit can be implemented in the user file.
 *
 * @param[in]  p_adc: Pointer to an ADC handle which contains the configuration information for
 *                    the specified ADC module.
 ****************************************************************************************
 */
void hal_adc_msp_deinit(adc_handle_t *p_adc);
 
/**
 ****************************************************************************************
 * @brief  adc_get_trim_func.
 *
 * @note   This function should not be modified. When the callback is needed,
 *          the adc_get_trim_func can be implemented in the user file.
 *
 * @param[in]  p_adc_trim: Pointer to save the trim information.
 ****************************************************************************************
 */
uint16_t adc_get_trim_func(adc_trim_info_t *p_adc_trim);
 
/** @} */
 
/** @addtogroup ADC_Exported_Functions_Group2 IO Operation Functions
 *  @brief ADC polling and DMA conversion management functions.
 * @{
 */
 
/**
 ****************************************************************************************
 * @brief  Polling for conversion.
 *
 * @param[in]  p_adc:  Pointer to an ADC handle.
 * @param[in]  p_data: Pointer to data buffer which to store ADC conversion results.
 * @param[in]  length: Length of data buffer.
 *
 * @retval ::HAL_OK: Operation is OK.
 * @retval ::HAL_ERROR: Parameter error or operation not supported.
 * @retval ::HAL_BUSY: Driver is busy.
 * @retval ::HAL_TIMEOUT: Timeout occurred.
 ****************************************************************************************
 */
hal_status_t hal_adc_poll_for_conversion(adc_handle_t *p_adc, uint16_t *p_data, uint32_t length);
 
/**
 ****************************************************************************************
 * @brief  DMA for conversion.
 *
 * @param[in]  p_adc:  Pointer to an ADC handle.
 * @param[in]  p_data: Pointer to data buffer which to store ADC conversion results.
 * @param[in]  length: Length of data buffer,  ranging between 0 and 4095.
 *
 * @retval ::HAL_OK: Operation is OK.
 * @retval ::HAL_ERROR: Parameter error or operation not supported.
 * @retval ::HAL_BUSY: Driver is busy.
 * @retval ::HAL_TIMEOUT: Timeout occurred.
 ****************************************************************************************
 */
hal_status_t hal_adc_start_dma(adc_handle_t *p_adc, uint16_t *p_data, uint32_t length);
 
/**
 ****************************************************************************************
 * @brief  DMA for conversion.
 *
 * @param[in]  p_adc:  Pointer to an ADC handle.
 * @param[in]  p_data: Pointer to data buffer which to store ADC conversion results.
 * @param[in]  length: Length of data buffer,  ranging between 0 and 4095.
 * @param[in] sg_llp_config: The config of source and destination's SG and LLP functions.
 *
 * @retval ::HAL_OK: Operation is OK.
 * @retval ::HAL_ERROR: Parameter error or operation not supported.
 * @retval ::HAL_BUSY: Driver is busy.
 * @retval ::HAL_TIMEOUT: Timeout occurred.
 ****************************************************************************************
 */
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);
 
/**
 ****************************************************************************************
 * @brief  Abort ongoing conversion (blocking mode).
 *
 * @note   This procedure could be only used for aborting conversion started in DMA mode.
 *         This procedure performs following operations:
 *           - Disable ADC clock, stop conversion
 *           - Abort DMA transfer by calling hal_dma_abort (in case of transfer in DMA mode)
 *           - Set handle State to READY.
 *         This procedure is executed in blocking mode: when exiting function, Abort is considered as completed.
 *
 * @param[in]  p_adc: ADC handle.
 *
 * @retval ::HAL_OK: Operation is OK.
 * @retval ::HAL_ERROR: Parameter error or operation not supported.
 * @retval ::HAL_BUSY: Driver is busy.
 * @retval ::HAL_TIMEOUT: Timeout occurred.
 ****************************************************************************************
 */
hal_status_t hal_adc_stop_dma(adc_handle_t *p_adc);
 
/**
 ****************************************************************************************
 * @brief  Conversion completed callback.
 *
 * @note   This function should not be modified. When the callback is needed,
 *          the hal_adc_conv_cplt_callback can be implemented in the user file.
 *
 * @param[in]  p_adc: Pointer to an ADC handle which contains the configuration information for
 *                    the specified ADC module.
 ****************************************************************************************
 */
void hal_adc_conv_cplt_callback(adc_handle_t* p_adc);
 
/** @} */
 
/** @defgroup ADC_Exported_Functions_Group3 Peripheral State and Errors Functions
  * @brief   ADC control functions
  *
@verbatim
 ===============================================================================
                      ##### Peripheral State and Errors functions #####
 ===============================================================================
    [..]
    This subsection provides a set of functions allowing to control the ADC.
     (+) hal_adc_get_state() API can be helpful to check in run-time the state of the ADC peripheral.
     (+) hal_adc_get_error() check in run-time Errors occurring during communication.
@endverbatim
  * @{
  */
 
/**
 ****************************************************************************************
 * @brief  Return the ADC handle state.
 *
 * @param[in]  p_adc: Pointer to an ADC handle which contains the configuration information for
 *                    the specified ADC module.
 *
 * @retval ::HAL_ADC_STATE_RESET: Peripheral not initialized.
 * @retval ::HAL_ADC_STATE_READY: Peripheral initialized and ready for use.
 * @retval ::HAL_ADC_STATE_BUSY: An internal process is ongoing.
 * @retval ::HAL_ADC_STATE_ERROR: Peripheral in error.
 ****************************************************************************************
 */
hal_adc_state_t hal_adc_get_state(adc_handle_t *p_adc);
 
/**
 ****************************************************************************************
 * @brief  Return the ADC error code.
 *
 * @param[in]  p_adc: Pointer to an ADC handle which contains the configuration information for
 *                    the specified ADC module.
 *
 * @return ADC error code in bitmap format
 ****************************************************************************************
 */
uint32_t hal_adc_get_error(adc_handle_t *p_adc);
 
/**
 ****************************************************************************************
 * @brief  Suspend some registers related to ADC configuration before sleep.
 * @param[in] p_adc: Pointer to a ADC handle which contains the configuration
 *                 information for the specified ADC module.
 * @retval ::HAL_OK: Operation is OK.
 * @retval ::HAL_ERROR: Parameter error or operation not supported.
 * @retval ::HAL_BUSY: Driver is busy.
 * @retval ::HAL_TIMEOUT: Timeout occurred.
 ****************************************************************************************
 */
hal_status_t hal_adc_suspend_reg(adc_handle_t *p_adc);
 
/**
 ****************************************************************************************
 * @brief  Restore some registers related to ADC configuration after sleep.
 *         This function must be used in conjunction with the hal_adc_suspend_reg().
 * @param[in] p_adc: Pointer to a ADC handle which contains the configuration
 *                 information for the specified ADC module.
 * @retval ::HAL_OK: Operation is OK.
 * @retval ::HAL_ERROR: Parameter error or operation not supported.
 * @retval ::HAL_BUSY: Driver is busy.
 * @retval ::HAL_TIMEOUT: Timeout occurred.
 ****************************************************************************************
 */
hal_status_t hal_adc_resume_reg(adc_handle_t *p_adc);
 
 
/**
 ****************************************************************************************
 * @brief  Set the new channels parameter to ADC
 *
 * @param[in]  p_adc: Pointer to a ADC handle which contains the new channels parameter.
 *
 * @retval ::HAL_OK: Operation is OK.
 * @retval ::HAL_ERROR: Parameter error or operation not supported.
 * @retval ::HAL_BUSY: Driver is busy.
 * @retval ::HAL_TIMEOUT: Timeout occurred.
 ****************************************************************************************
 */
hal_status_t hal_adc_change_channels(adc_handle_t *p_adc);
 
/**
 ****************************************************************************************
 * @brief  Start the ADC clock
 *
 * @param[in]  p_adc: Pointer to an ADC handle which contains the configuration information for
 *                    the specified ADC module.
 *
 * @retval ::HAL_OK: Operation is OK.
 * @retval ::HAL_ERROR: Parameter error or operation not supported.
 * @retval ::HAL_BUSY: Driver is busy.
 * @retval ::HAL_TIMEOUT: Timeout occurred.
 ****************************************************************************************
 */
hal_status_t hal_adc_clock_start(adc_handle_t *p_adc);
 
/**
 ****************************************************************************************
 * @brief  Get the ADC sampling code by polling, and convert sampling code of the specified length to the average voltage.
 *
 * @param[in]  p_adc: Pointer to a ADC handle which contains the new channels parameter.
 * @param[in]  p_data: Pointer to data which to storage average voltage results.
 * @param[in]  length: Length of the ADC sample values to be averaged.
 *
 * @retval ::HAL_OK: Operation is OK.
 * @retval ::HAL_ERROR: Parameter error or operation not supported.
 * @retval ::HAL_BUSY: Driver is busy.
 * @retval ::HAL_TIMEOUT: Timeout occurred.
 ****************************************************************************************
 */
hal_status_t hal_adc_get_avg_voltage(adc_handle_t *p_adc, float *p_data, uint32_t length);
 
/** @} */
 
/** @} */
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* __GR55xx_HAL_ADC_H__ */
 
/** @} */
 
/** @} */
 
/** @} */