stm32l4xx_hal_adc.h File Reference

Header file of ADC HAL module. More...

Go to the source code of this file.

Data Structures
struct	ADC_OversamplingTypeDef
	ADC group regular oversampling structure definition. More...
struct	ADC_InitTypeDef
	Structure definition of ADC instance and ADC group regular. More...
struct	ADC_ChannelConfTypeDef
	Structure definition of ADC channel for regular group. More...
struct	ADC_AnalogWDGConfTypeDef
	Structure definition of ADC analog watchdog. More...
struct	ADC_InjectionConfigTypeDef
	ADC group injected contexts queue configuration. More...
struct	endif
	ADC handle Structure definition. More...

Typedefs
typedef struct __ADC_HandleTypeDef else typedef struct endif	ADC_HandleTypeDef
	ADC handle Structure definition. More...
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_INJ_QUEUE_OVEFLOW_CB_ID = 0x05U, HAL_ADC_LEVEL_OUT_OF_WINDOW_2_CB_ID = 0x06U, HAL_ADC_LEVEL_OUT_OF_WINDOW_3_CB_ID = 0x07U,   HAL_ADC_END_OF_SAMPLING_CB_ID = 0x08U, HAL_ADC_MSPINIT_CB_ID = 0x09U, HAL_ADC_MSPDEINIT_CB_ID = 0x0AU }
	HAL ADC Callback ID enumeration definition. More...

Functions
HAL_StatusTypeDef	HAL_ADC_Init (ADC_HandleTypeDef *hadc)
	Initialize the ADC peripheral and regular group according to parameters specified in structure "ADC_InitTypeDef". More...
HAL_StatusTypeDef	HAL_ADC_DeInit (ADC_HandleTypeDef *hadc)
	Deinitialize the ADC peripheral registers to their default reset values, with deinitialization of the ADC MSP. More...
void	HAL_ADC_MspInit (ADC_HandleTypeDef *hadc)
	Initialize the ADC MSP. More...
void	HAL_ADC_MspDeInit (ADC_HandleTypeDef *hadc)
	DeInitialize 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)
	Enable ADC, start conversion of regular group. More...
HAL_StatusTypeDef	HAL_ADC_Stop (ADC_HandleTypeDef *hadc)
	Stop ADC conversion of regular group (and injected channels in case of auto_injection mode), disable ADC peripheral. More...
HAL_StatusTypeDef	HAL_ADC_PollForConversion (ADC_HandleTypeDef *hadc, uint32_t Timeout)
	Wait for regular group conversion to be completed. More...
HAL_StatusTypeDef	HAL_ADC_PollForEvent (ADC_HandleTypeDef *hadc, uint32_t EventType, uint32_t Timeout)
	Poll for ADC event. More...
HAL_StatusTypeDef	HAL_ADC_Start_IT (ADC_HandleTypeDef *hadc)
	Enable ADC, start conversion of regular group with interruption. More...
HAL_StatusTypeDef	HAL_ADC_Stop_IT (ADC_HandleTypeDef *hadc)
	Stop ADC conversion of regular group (and injected group in case of auto_injection mode), disable interrution of end-of-conversion, disable ADC peripheral. More...
HAL_StatusTypeDef	HAL_ADC_Start_DMA (ADC_HandleTypeDef *hadc, uint32_t *pData, uint32_t Length)
	Enable ADC, start conversion of regular group and transfer result through DMA. More...
HAL_StatusTypeDef	HAL_ADC_Stop_DMA (ADC_HandleTypeDef *hadc)
	Stop ADC conversion of regular group (and injected group in case of auto_injection mode), disable ADC DMA transfer, disable ADC peripheral. More...
uint32_t	HAL_ADC_GetValue (ADC_HandleTypeDef *hadc)
	Get ADC regular group conversion result. More...
void	HAL_ADC_IRQHandler (ADC_HandleTypeDef *hadc)
	Handle ADC interrupt request. More...
void	HAL_ADC_ConvCpltCallback (ADC_HandleTypeDef *hadc)
	Conversion complete callback in non-blocking mode. More...
void	HAL_ADC_ConvHalfCpltCallback (ADC_HandleTypeDef *hadc)
	Conversion DMA half-transfer callback in non-blocking mode. More...
void	HAL_ADC_LevelOutOfWindowCallback (ADC_HandleTypeDef *hadc)
	Analog watchdog 1 callback in non-blocking mode. More...
void	HAL_ADC_ErrorCallback (ADC_HandleTypeDef *hadc)
	ADC error callback in non-blocking mode (ADC conversion with interruption or transfer by DMA). More...
HAL_StatusTypeDef	HAL_ADC_ConfigChannel (ADC_HandleTypeDef *hadc, ADC_ChannelConfTypeDef *sConfig)
	Configure a channel to be assigned to ADC group regular. More...
HAL_StatusTypeDef	HAL_ADC_AnalogWDGConfig (ADC_HandleTypeDef *hadc, ADC_AnalogWDGConfTypeDef *AnalogWDGConfig)
	Configure the analog watchdog. More...
uint32_t	HAL_ADC_GetState (ADC_HandleTypeDef *hadc)
	Return the ADC handle state. More...
uint32_t	HAL_ADC_GetError (ADC_HandleTypeDef *hadc)
	Return the ADC error code. More...
HAL_StatusTypeDef	ADC_ConversionStop (ADC_HandleTypeDef *hadc, uint32_t ConversionGroup)
	Stop ADC conversion. More...
HAL_StatusTypeDef	ADC_Enable (ADC_HandleTypeDef *hadc)
	Enable the selected ADC. More...
HAL_StatusTypeDef	ADC_Disable (ADC_HandleTypeDef *hadc)
	Disable the selected ADC. More...
void	ADC_DMAConvCplt (DMA_HandleTypeDef *hdma)
	DMA transfer complete callback. More...
void	ADC_DMAHalfConvCplt (DMA_HandleTypeDef *hdma)
	DMA half transfer complete callback. More...
void	ADC_DMAError (DMA_HandleTypeDef *hdma)
	DMA error callback. More...

Detailed Description

Header file of ADC HAL module.

Author

MCD Application Team

Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_adc.h.