STM32F4xx_HAL_Driver  1.8.3
stm32f4xx_hal_adc.h File Reference

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

Go to the source code of this file.

Data Structures

struct  ADC_InitTypeDef
 Structure definition of ADC and regular group initialization. More...
 
struct  ADC_ChannelConfTypeDef
 Structure definition of ADC channel for regular group. More...
 
struct  ADC_AnalogWDGConfTypeDef
 ADC Configuration multi-mode structure definition. More...
 
struct  endif
 ADC handle Structure definition. More...
 

Typedefs

typedef struct __ADC_HandleTypeDef else typedef struct endif ADC_HandleTypeDef
 ADC handle Structure definition.
 
typedef void(* pADC_CallbackTypeDef) (ADC_HandleTypeDef *hadc)
 HAL ADC Callback pointer definition. More...
 

Enumerations

enum  HAL_ADC_CallbackIDTypeDef {
  HAL_ADC_CONVERSION_COMPLETE_CB_ID = 0x00U , HAL_ADC_CONVERSION_HALF_CB_ID = 0x01U , HAL_ADC_LEVEL_OUT_OF_WINDOW_1_CB_ID = 0x02U , HAL_ADC_ERROR_CB_ID = 0x03U ,
  HAL_ADC_INJ_CONVERSION_COMPLETE_CB_ID = 0x04U , HAL_ADC_MSPINIT_CB_ID = 0x05U , HAL_ADC_MSPDEINIT_CB_ID = 0x06U
}
 HAL ADC Callback ID enumeration definition. More...
 

Functions

HAL_StatusTypeDef HAL_ADC_Init (ADC_HandleTypeDef *hadc)
 Initializes the ADCx peripheral according to the specified parameters in the ADC_InitStruct and initializes the ADC MSP. More...
 
HAL_StatusTypeDef HAL_ADC_DeInit (ADC_HandleTypeDef *hadc)
 Deinitializes the ADCx peripheral registers to their default reset values. More...
 
void HAL_ADC_MspInit (ADC_HandleTypeDef *hadc)
 Initializes the ADC MSP. More...
 
void HAL_ADC_MspDeInit (ADC_HandleTypeDef *hadc)
 DeInitializes the ADC MSP. More...
 
HAL_StatusTypeDef HAL_ADC_RegisterCallback (ADC_HandleTypeDef *hadc, HAL_ADC_CallbackIDTypeDef CallbackID, pADC_CallbackTypeDef pCallback)
 Register a User ADC Callback To be used instead of the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_ADC_UnRegisterCallback (ADC_HandleTypeDef *hadc, HAL_ADC_CallbackIDTypeDef CallbackID)
 Unregister a ADC Callback ADC callback is redirected to the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_ADC_Start (ADC_HandleTypeDef *hadc)
 Enables ADC and starts conversion of the regular channels. More...
 
HAL_StatusTypeDef HAL_ADC_Stop (ADC_HandleTypeDef *hadc)
 Disables ADC and stop conversion of regular channels. More...
 
HAL_StatusTypeDef HAL_ADC_PollForConversion (ADC_HandleTypeDef *hadc, uint32_t Timeout)
 Poll for regular conversion complete. More...
 
HAL_StatusTypeDef HAL_ADC_PollForEvent (ADC_HandleTypeDef *hadc, uint32_t EventType, uint32_t Timeout)
 Poll for conversion event. More...
 
HAL_StatusTypeDef HAL_ADC_Start_IT (ADC_HandleTypeDef *hadc)
 Enables the interrupt and starts ADC conversion of regular channels. More...
 
HAL_StatusTypeDef HAL_ADC_Stop_IT (ADC_HandleTypeDef *hadc)
 Disables the interrupt and stop ADC conversion of regular channels. More...
 
void HAL_ADC_IRQHandler (ADC_HandleTypeDef *hadc)
 Handles ADC interrupt request. More...
 
HAL_StatusTypeDef HAL_ADC_Start_DMA (ADC_HandleTypeDef *hadc, uint32_t *pData, uint32_t Length)
 Enables ADC DMA request after last transfer (Single-ADC mode) and enables ADC peripheral. More...
 
HAL_StatusTypeDef HAL_ADC_Stop_DMA (ADC_HandleTypeDef *hadc)
 Disables ADC DMA (Single-ADC mode) and disables ADC peripheral. More...
 
uint32_t HAL_ADC_GetValue (ADC_HandleTypeDef *hadc)
 Gets the converted value from data register of regular channel. More...
 
void HAL_ADC_ConvCpltCallback (ADC_HandleTypeDef *hadc)
 Regular conversion complete callback in non blocking mode. More...
 
void HAL_ADC_ConvHalfCpltCallback (ADC_HandleTypeDef *hadc)
 Regular conversion half DMA transfer callback in non blocking mode. More...
 
void HAL_ADC_LevelOutOfWindowCallback (ADC_HandleTypeDef *hadc)
 Analog watchdog callback in non blocking mode. More...
 
void HAL_ADC_ErrorCallback (ADC_HandleTypeDef *hadc)
 Error ADC callback. More...
 
HAL_StatusTypeDef HAL_ADC_ConfigChannel (ADC_HandleTypeDef *hadc, ADC_ChannelConfTypeDef *sConfig)
 Configures for the selected ADC regular channel its corresponding rank in the sequencer and its sample time. More...
 
HAL_StatusTypeDef HAL_ADC_AnalogWDGConfig (ADC_HandleTypeDef *hadc, ADC_AnalogWDGConfTypeDef *AnalogWDGConfig)
 Configures the analog watchdog. More...
 
uint32_t HAL_ADC_GetState (ADC_HandleTypeDef *hadc)
 return the ADC state More...
 
uint32_t HAL_ADC_GetError (ADC_HandleTypeDef *hadc)
 Return the ADC error code. More...
 

Detailed Description

Header file containing functions prototypes of ADC HAL library.

Author
MCD Application Team
Attention

Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_adc.h.