STM32L486xx HAL User Manual: stm32l4xx_hal

Header file of ADC HAL module. More...

#include "stm32l4xx_hal_def.h"
#include "stm32l4xx_ll_adc.h"
#include "stm32l4xx_hal_adc_ex.h"

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	__ADC_HandleTypeDef
	ADC handle Structure definition. More...
Defines
#define	HAL_ADC_STATE_RESET (0x00000000U)
	HAL ADC state machine: ADC states definition (bitfields)
#define	HAL_ADC_STATE_READY (0x00000001U)
#define	HAL_ADC_STATE_BUSY_INTERNAL (0x00000002U)
#define	HAL_ADC_STATE_TIMEOUT (0x00000004U)
#define	HAL_ADC_STATE_ERROR_INTERNAL (0x00000010U)
#define	HAL_ADC_STATE_ERROR_CONFIG (0x00000020U)
#define	HAL_ADC_STATE_ERROR_DMA (0x00000040U)
#define	HAL_ADC_STATE_REG_BUSY (0x00000100U)
#define	HAL_ADC_STATE_REG_EOC (0x00000200U)
#define	HAL_ADC_STATE_REG_OVR (0x00000400U)
#define	HAL_ADC_STATE_REG_EOSMP (0x00000800U)
#define	HAL_ADC_STATE_INJ_BUSY (0x00001000U)
#define	HAL_ADC_STATE_INJ_EOC (0x00002000U)
#define	HAL_ADC_STATE_INJ_JQOVF (0x00004000U)
#define	HAL_ADC_STATE_AWD1 (0x00010000U)
#define	HAL_ADC_STATE_AWD2 (0x00020000U)
#define	HAL_ADC_STATE_AWD3 (0x00040000U)
#define	HAL_ADC_STATE_MULTIMODE_SLAVE (0x00100000U)
#define	HAL_ADC_ERROR_NONE (0x00U)
#define	HAL_ADC_ERROR_INTERNAL (0x01U)
#define	HAL_ADC_ERROR_OVR (0x02U)
#define	HAL_ADC_ERROR_DMA (0x04U)
#define	HAL_ADC_ERROR_JQOVF (0x08U)
#define	HAL_ADC_ERROR_INVALID_CALLBACK (0x10U)
#define	ADC_CLOCK_SYNC_PCLK_DIV1 (LL_ADC_CLOCK_SYNC_PCLK_DIV1)
#define	ADC_CLOCK_SYNC_PCLK_DIV2 (LL_ADC_CLOCK_SYNC_PCLK_DIV2)
#define	ADC_CLOCK_SYNC_PCLK_DIV4 (LL_ADC_CLOCK_SYNC_PCLK_DIV4)
#define	ADC_CLOCK_ASYNC_DIV1 (LL_ADC_CLOCK_ASYNC_DIV1)
#define	ADC_CLOCK_ASYNC_DIV2 (LL_ADC_CLOCK_ASYNC_DIV2)
#define	ADC_CLOCK_ASYNC_DIV4 (LL_ADC_CLOCK_ASYNC_DIV4)
#define	ADC_CLOCK_ASYNC_DIV6 (LL_ADC_CLOCK_ASYNC_DIV6)
#define	ADC_CLOCK_ASYNC_DIV8 (LL_ADC_CLOCK_ASYNC_DIV8)
#define	ADC_CLOCK_ASYNC_DIV10 (LL_ADC_CLOCK_ASYNC_DIV10)
#define	ADC_CLOCK_ASYNC_DIV12 (LL_ADC_CLOCK_ASYNC_DIV12)
#define	ADC_CLOCK_ASYNC_DIV16 (LL_ADC_CLOCK_ASYNC_DIV16)
#define	ADC_CLOCK_ASYNC_DIV32 (LL_ADC_CLOCK_ASYNC_DIV32)
#define	ADC_CLOCK_ASYNC_DIV64 (LL_ADC_CLOCK_ASYNC_DIV64)
#define	ADC_CLOCK_ASYNC_DIV128 (LL_ADC_CLOCK_ASYNC_DIV128)
#define	ADC_CLOCK_ASYNC_DIV256 (LL_ADC_CLOCK_ASYNC_DIV256)
#define	ADC_CLOCKPRESCALER_PCLK_DIV1 ADC_CLOCK_SYNC_PCLK_DIV1
#define	ADC_CLOCKPRESCALER_PCLK_DIV2 ADC_CLOCK_SYNC_PCLK_DIV2
#define	ADC_CLOCKPRESCALER_PCLK_DIV4 ADC_CLOCK_SYNC_PCLK_DIV4
#define	ADC_RESOLUTION_12B (LL_ADC_RESOLUTION_12B)
#define	ADC_RESOLUTION_10B (LL_ADC_RESOLUTION_10B)
#define	ADC_RESOLUTION_8B (LL_ADC_RESOLUTION_8B)
#define	ADC_RESOLUTION_6B (LL_ADC_RESOLUTION_6B)
#define	ADC_DATAALIGN_RIGHT (LL_ADC_DATA_ALIGN_RIGHT)
#define	ADC_DATAALIGN_LEFT (LL_ADC_DATA_ALIGN_LEFT)
#define	ADC_SCAN_DISABLE (0x00000000U)
#define	ADC_SCAN_ENABLE (0x00000001U)
#define	ADC_SOFTWARE_START (LL_ADC_REG_TRIG_SOFTWARE)
#define	ADC_EXTERNALTRIG_T1_TRGO (LL_ADC_REG_TRIG_EXT_TIM1_TRGO)
#define	ADC_EXTERNALTRIG_T1_TRGO2 (LL_ADC_REG_TRIG_EXT_TIM1_TRGO2)
#define	ADC_EXTERNALTRIG_T1_CC1 (LL_ADC_REG_TRIG_EXT_TIM1_CH1)
#define	ADC_EXTERNALTRIG_T1_CC2 (LL_ADC_REG_TRIG_EXT_TIM1_CH2)
#define	ADC_EXTERNALTRIG_T1_CC3 (LL_ADC_REG_TRIG_EXT_TIM1_CH3)
#define	ADC_EXTERNALTRIG_T2_TRGO (LL_ADC_REG_TRIG_EXT_TIM2_TRGO)
#define	ADC_EXTERNALTRIG_T2_CC2 (LL_ADC_REG_TRIG_EXT_TIM2_CH2)
#define	ADC_EXTERNALTRIG_T3_TRGO (LL_ADC_REG_TRIG_EXT_TIM3_TRGO)
#define	ADC_EXTERNALTRIG_T3_CC4 (LL_ADC_REG_TRIG_EXT_TIM3_CH4)
#define	ADC_EXTERNALTRIG_T4_TRGO (LL_ADC_REG_TRIG_EXT_TIM4_CH4)
#define	ADC_EXTERNALTRIG_T4_CC4 (LL_ADC_REG_TRIG_EXT_TIM4_CH4)
#define	ADC_EXTERNALTRIG_T6_TRGO (LL_ADC_REG_TRIG_EXT_TIM6_TRGO)
#define	ADC_EXTERNALTRIG_T8_TRGO (LL_ADC_REG_TRIG_EXT_TIM8_TRGO)
#define	ADC_EXTERNALTRIG_T8_TRGO2 (LL_ADC_REG_TRIG_EXT_TIM8_TRGO2)
#define	ADC_EXTERNALTRIG_T15_TRGO (LL_ADC_REG_TRIG_EXT_TIM15_TRGO)
#define	ADC_EXTERNALTRIG_EXT_IT11 (LL_ADC_REG_TRIG_EXT_EXTI_LINE11)
#define	ADC_EXTERNALTRIGCONVEDGE_NONE (0x00000000)
#define	ADC_EXTERNALTRIGCONVEDGE_RISING (ADC_CFGR_EXTEN_0)
#define	ADC_EXTERNALTRIGCONVEDGE_FALLING (ADC_CFGR_EXTEN_1)
#define	ADC_EXTERNALTRIGCONVEDGE_RISINGFALLING (ADC_CFGR_EXTEN)
#define	ADC_EOC_SINGLE_CONV (ADC_ISR_EOC)
#define	ADC_EOC_SEQ_CONV (ADC_ISR_EOS)
#define	ADC_OVR_DATA_PRESERVED (LL_ADC_REG_OVR_DATA_PRESERVED)
#define	ADC_OVR_DATA_OVERWRITTEN (LL_ADC_REG_OVR_DATA_OVERWRITTEN)
#define	ADC_REGULAR_RANK_1 (LL_ADC_REG_RANK_1)
#define	ADC_REGULAR_RANK_2 (LL_ADC_REG_RANK_2)
#define	ADC_REGULAR_RANK_3 (LL_ADC_REG_RANK_3)
#define	ADC_REGULAR_RANK_4 (LL_ADC_REG_RANK_4)
#define	ADC_REGULAR_RANK_5 (LL_ADC_REG_RANK_5)
#define	ADC_REGULAR_RANK_6 (LL_ADC_REG_RANK_6)
#define	ADC_REGULAR_RANK_7 (LL_ADC_REG_RANK_7)
#define	ADC_REGULAR_RANK_8 (LL_ADC_REG_RANK_8)
#define	ADC_REGULAR_RANK_9 (LL_ADC_REG_RANK_9)
#define	ADC_REGULAR_RANK_10 (LL_ADC_REG_RANK_10)
#define	ADC_REGULAR_RANK_11 (LL_ADC_REG_RANK_11)
#define	ADC_REGULAR_RANK_12 (LL_ADC_REG_RANK_12)
#define	ADC_REGULAR_RANK_13 (LL_ADC_REG_RANK_13)
#define	ADC_REGULAR_RANK_14 (LL_ADC_REG_RANK_14)
#define	ADC_REGULAR_RANK_15 (LL_ADC_REG_RANK_15)
#define	ADC_REGULAR_RANK_16 (LL_ADC_REG_RANK_16)
#define	ADC_SAMPLETIME_2CYCLES_5 (LL_ADC_SAMPLINGTIME_2CYCLES_5)
#define	ADC_SAMPLETIME_6CYCLES_5 (LL_ADC_SAMPLINGTIME_6CYCLES_5)
#define	ADC_SAMPLETIME_12CYCLES_5 (LL_ADC_SAMPLINGTIME_12CYCLES_5)
#define	ADC_SAMPLETIME_24CYCLES_5 (LL_ADC_SAMPLINGTIME_24CYCLES_5)
#define	ADC_SAMPLETIME_47CYCLES_5 (LL_ADC_SAMPLINGTIME_47CYCLES_5)
#define	ADC_SAMPLETIME_92CYCLES_5 (LL_ADC_SAMPLINGTIME_92CYCLES_5)
#define	ADC_SAMPLETIME_247CYCLES_5 (LL_ADC_SAMPLINGTIME_247CYCLES_5)
#define	ADC_SAMPLETIME_640CYCLES_5 (LL_ADC_SAMPLINGTIME_640CYCLES_5)
#define	ADC_CHANNEL_0 (LL_ADC_CHANNEL_0)
#define	ADC_CHANNEL_1 (LL_ADC_CHANNEL_1)
#define	ADC_CHANNEL_2 (LL_ADC_CHANNEL_2)
#define	ADC_CHANNEL_3 (LL_ADC_CHANNEL_3)
#define	ADC_CHANNEL_4 (LL_ADC_CHANNEL_4)
#define	ADC_CHANNEL_5 (LL_ADC_CHANNEL_5)
#define	ADC_CHANNEL_6 (LL_ADC_CHANNEL_6)
#define	ADC_CHANNEL_7 (LL_ADC_CHANNEL_7)
#define	ADC_CHANNEL_8 (LL_ADC_CHANNEL_8)
#define	ADC_CHANNEL_9 (LL_ADC_CHANNEL_9)
#define	ADC_CHANNEL_10 (LL_ADC_CHANNEL_10)
#define	ADC_CHANNEL_11 (LL_ADC_CHANNEL_11)
#define	ADC_CHANNEL_12 (LL_ADC_CHANNEL_12)
#define	ADC_CHANNEL_13 (LL_ADC_CHANNEL_13)
#define	ADC_CHANNEL_14 (LL_ADC_CHANNEL_14)
#define	ADC_CHANNEL_15 (LL_ADC_CHANNEL_15)
#define	ADC_CHANNEL_16 (LL_ADC_CHANNEL_16)
#define	ADC_CHANNEL_17 (LL_ADC_CHANNEL_17)
#define	ADC_CHANNEL_18 (LL_ADC_CHANNEL_18)
#define	ADC_CHANNEL_VREFINT (LL_ADC_CHANNEL_VREFINT)
#define	ADC_CHANNEL_TEMPSENSOR (LL_ADC_CHANNEL_TEMPSENSOR)
#define	ADC_CHANNEL_VBAT (LL_ADC_CHANNEL_VBAT)
#define	ADC_CHANNEL_DAC1CH1_ADC2 (LL_ADC_CHANNEL_DAC1CH1_ADC2)
#define	ADC_CHANNEL_DAC1CH2_ADC2 (LL_ADC_CHANNEL_DAC1CH2_ADC2)
#define	ADC_CHANNEL_DAC1CH1_ADC3 (LL_ADC_CHANNEL_DAC1CH1_ADC3)
#define	ADC_CHANNEL_DAC1CH2_ADC3 (LL_ADC_CHANNEL_DAC1CH2_ADC3)
#define	ADC_ANALOGWATCHDOG_1 (LL_ADC_AWD1)
#define	ADC_ANALOGWATCHDOG_2 (LL_ADC_AWD2)
#define	ADC_ANALOGWATCHDOG_3 (LL_ADC_AWD3)
#define	ADC_ANALOGWATCHDOG_NONE (0x00000000U)
#define	ADC_ANALOGWATCHDOG_SINGLE_REG (ADC_CFGR_AWD1SGL \| ADC_CFGR_AWD1EN)
#define	ADC_ANALOGWATCHDOG_SINGLE_INJEC (ADC_CFGR_AWD1SGL \| ADC_CFGR_JAWD1EN)
#define	ADC_ANALOGWATCHDOG_SINGLE_REGINJEC (ADC_CFGR_AWD1SGL \| ADC_CFGR_AWD1EN \| ADC_CFGR_JAWD1EN)
#define	ADC_ANALOGWATCHDOG_ALL_REG (ADC_CFGR_AWD1EN)
#define	ADC_ANALOGWATCHDOG_ALL_INJEC (ADC_CFGR_JAWD1EN)
#define	ADC_ANALOGWATCHDOG_ALL_REGINJEC (ADC_CFGR_AWD1EN \| ADC_CFGR_JAWD1EN)
#define	ADC_OVERSAMPLING_RATIO_2 (LL_ADC_OVS_RATIO_2)
#define	ADC_OVERSAMPLING_RATIO_4 (LL_ADC_OVS_RATIO_4)
#define	ADC_OVERSAMPLING_RATIO_8 (LL_ADC_OVS_RATIO_8)
#define	ADC_OVERSAMPLING_RATIO_16 (LL_ADC_OVS_RATIO_16)
#define	ADC_OVERSAMPLING_RATIO_32 (LL_ADC_OVS_RATIO_32)
#define	ADC_OVERSAMPLING_RATIO_64 (LL_ADC_OVS_RATIO_64)
#define	ADC_OVERSAMPLING_RATIO_128 (LL_ADC_OVS_RATIO_128)
#define	ADC_OVERSAMPLING_RATIO_256 (LL_ADC_OVS_RATIO_256)
#define	ADC_RIGHTBITSHIFT_NONE (LL_ADC_OVS_SHIFT_NONE)
#define	ADC_RIGHTBITSHIFT_1 (LL_ADC_OVS_SHIFT_RIGHT_1)
#define	ADC_RIGHTBITSHIFT_2 (LL_ADC_OVS_SHIFT_RIGHT_2)
#define	ADC_RIGHTBITSHIFT_3 (LL_ADC_OVS_SHIFT_RIGHT_3)
#define	ADC_RIGHTBITSHIFT_4 (LL_ADC_OVS_SHIFT_RIGHT_4)
#define	ADC_RIGHTBITSHIFT_5 (LL_ADC_OVS_SHIFT_RIGHT_5)
#define	ADC_RIGHTBITSHIFT_6 (LL_ADC_OVS_SHIFT_RIGHT_6)
#define	ADC_RIGHTBITSHIFT_7 (LL_ADC_OVS_SHIFT_RIGHT_7)
#define	ADC_RIGHTBITSHIFT_8 (LL_ADC_OVS_SHIFT_RIGHT_8)
#define	ADC_TRIGGEREDMODE_SINGLE_TRIGGER (LL_ADC_OVS_REG_CONT)
#define	ADC_TRIGGEREDMODE_MULTI_TRIGGER (LL_ADC_OVS_REG_DISCONT)
#define	ADC_REGOVERSAMPLING_CONTINUED_MODE (LL_ADC_OVS_GRP_REGULAR_CONTINUED)
#define	ADC_REGOVERSAMPLING_RESUMED_MODE (LL_ADC_OVS_GRP_REGULAR_RESUMED)
#define	ADC_EOSMP_EVENT (ADC_FLAG_EOSMP)
#define	ADC_AWD1_EVENT (ADC_FLAG_AWD1)
#define	ADC_AWD2_EVENT (ADC_FLAG_AWD2)
#define	ADC_AWD3_EVENT (ADC_FLAG_AWD3)
#define	ADC_OVR_EVENT (ADC_FLAG_OVR)
#define	ADC_JQOVF_EVENT (ADC_FLAG_JQOVF)
#define	ADC_AWD_EVENT ADC_AWD1_EVENT
#define	ADC_IT_RDY ADC_IER_ADRDYIE
#define	ADC_IT_EOSMP ADC_IER_EOSMPIE
#define	ADC_IT_EOC ADC_IER_EOCIE
#define	ADC_IT_EOS ADC_IER_EOSIE
#define	ADC_IT_OVR ADC_IER_OVRIE
#define	ADC_IT_JEOC ADC_IER_JEOCIE
#define	ADC_IT_JEOS ADC_IER_JEOSIE
#define	ADC_IT_AWD1 ADC_IER_AWD1IE
#define	ADC_IT_AWD2 ADC_IER_AWD2IE
#define	ADC_IT_AWD3 ADC_IER_AWD3IE
#define	ADC_IT_JQOVF ADC_IER_JQOVFIE
#define	ADC_IT_AWD ADC_IT_AWD1
#define	ADC_FLAG_RDY ADC_ISR_ADRDY
#define	ADC_FLAG_EOSMP ADC_ISR_EOSMP
#define	ADC_FLAG_EOC ADC_ISR_EOC
#define	ADC_FLAG_EOS ADC_ISR_EOS
#define	ADC_FLAG_OVR ADC_ISR_OVR
#define	ADC_FLAG_JEOC ADC_ISR_JEOC
#define	ADC_FLAG_JEOS ADC_ISR_JEOS
#define	ADC_FLAG_AWD1 ADC_ISR_AWD1
#define	ADC_FLAG_AWD2 ADC_ISR_AWD2
#define	ADC_FLAG_AWD3 ADC_ISR_AWD3
#define	ADC_FLAG_JQOVF ADC_ISR_JQOVF
#define	ADC_FLAG_AWD ADC_FLAG_AWD1
#define	ADC_FLAG_ALL
#define	ADC_FLAG_POSTCONV_ALL
#define	ADC_IS_SOFTWARE_START_REGULAR(__HANDLE__) (((__HANDLE__)->Instance->CFGR & ADC_CFGR_EXTEN) == RESET)
	Test if conversion trigger of regular group is software start or external trigger.
#define	ADC_GET_RESOLUTION(__HANDLE__) (LL_ADC_GetResolution((__HANDLE__)->Instance))
	Return resolution bits in CFGR register RES[1:0] field.
#define	ADC_CLEAR_ERRORCODE(__HANDLE__) ((__HANDLE__)->ErrorCode = HAL_ADC_ERROR_NONE)
	Clear ADC error code (set it to no error code "HAL_ADC_ERROR_NONE").
#define	ADC_IS_ENABLE(__HANDLE__)
	Verification of ADC state: enabled or disabled.
#define	ADC_IS_CONVERSION_ONGOING_REGULAR(__HANDLE__) (LL_ADC_REG_IsConversionOngoing((__HANDLE__)->Instance))
	Check if conversion is on going on regular group.
#define	ADC_STATE_CLR_SET MODIFY_REG
	Simultaneously clear and set specific bits of the handle State.
#define	IS_ADC_RANGE(__RESOLUTION__, __ADC_VALUE__)
	Verify that a given value is aligned with the ADC resolution range.
#define	IS_ADC_REGULAR_NB_CONV(__LENGTH__) (((__LENGTH__) >= (1U)) && ((__LENGTH__) <= (16U)))
	Verify the length of the scheduled regular conversions group.
#define	IS_ADC_REGULAR_DISCONT_NUMBER(NUMBER) (((NUMBER) >= (1U)) && ((NUMBER) <= (8U)))
	Verify the number of scheduled regular conversions in discontinuous mode.
#define	IS_ADC_CLOCKPRESCALER(__ADC_CLOCK__)
	Verify the ADC clock setting.
#define	IS_ADC_RESOLUTION(__RESOLUTION__)
	Verify the ADC resolution setting.
#define	IS_ADC_RESOLUTION_8_6_BITS(__RESOLUTION__)
	Verify the ADC resolution setting when limited to 6 or 8 bits.
#define	IS_ADC_DATA_ALIGN(__ALIGN__)
	Verify the ADC converted data alignment.
#define	IS_ADC_SCAN_MODE(__SCAN_MODE__)
	Verify the ADC scan mode.
#define	IS_ADC_EXTTRIG_EDGE(__EDGE__)
	Verify the ADC edge trigger setting for regular group.
#define	IS_ADC_EXTTRIG(__HANDLE__, __REGTRIG__)
	Verify the ADC regular conversions external trigger.
#define	IS_ADC_EOC_SELECTION(__EOC_SELECTION__)
	Verify the ADC regular conversions check for converted data availability.
#define	IS_ADC_OVERRUN(__OVR__)
	Verify the ADC regular conversions overrun handling.
#define	IS_ADC_SAMPLE_TIME(__TIME__)
	Verify the ADC conversions sampling time.
#define	IS_ADC_REGULAR_RANK(__CHANNEL__)
	Verify the ADC regular channel setting.
#define	ADC_STOP_CONVERSION_TIMEOUT ( 5U)
#define	ADC_TEMPSENSOR_DELAY_US (LL_ADC_DELAY_TEMPSENSOR_STAB_US)
#define	__HAL_ADC_RESET_HANDLE_STATE(__HANDLE__)
	Reset ADC handle state.
#define	__HAL_ADC_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IER) \|= (__INTERRUPT__))
	Enable ADC interrupt.
#define	__HAL_ADC_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IER) &= ~(__INTERRUPT__))
	Disable ADC interrupt.
#define	__HAL_ADC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IER & (__INTERRUPT__)) == (__INTERRUPT__))
	Checks if the specified ADC interrupt source is enabled or disabled.
#define	__HAL_ADC_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->ISR) & (__FLAG__)) == (__FLAG__))
	Check whether the specified ADC flag is set or not.
#define	__HAL_ADC_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR) = (__FLAG__))
	Clear the specified ADC flag.
#define	__HAL_ADC_CHANNEL_TO_DECIMAL_NB(__CHANNEL__) __LL_ADC_CHANNEL_TO_DECIMAL_NB((__CHANNEL__))
	Helper macro to get ADC channel number in decimal format from literals ADC_CHANNEL_x.
#define	__HAL_ADC_DECIMAL_NB_TO_CHANNEL(__DECIMAL_NB__) __LL_ADC_DECIMAL_NB_TO_CHANNEL((__DECIMAL_NB__))
	Helper macro to get ADC channel in literal format ADC_CHANNEL_x from number in decimal format.
#define	__HAL_ADC_IS_CHANNEL_INTERNAL(__CHANNEL__) __LL_ADC_IS_CHANNEL_INTERNAL((__CHANNEL__))
	Helper macro to determine whether the selected channel corresponds to literal definitions of driver.
#define	__HAL_ADC_CHANNEL_INTERNAL_TO_EXTERNAL(__CHANNEL__) __LL_ADC_CHANNEL_INTERNAL_TO_EXTERNAL((__CHANNEL__))
	Helper macro to convert a channel defined from parameter definition of a ADC internal channel (ADC_CHANNEL_VREFINT, ADC_CHANNEL_TEMPSENSOR, ...), to its equivalent parameter definition of a ADC external channel (ADC_CHANNEL_1, ADC_CHANNEL_2, ...).
#define	__HAL_ADC_IS_CHANNEL_INTERNAL_AVAILABLE(__ADC_INSTANCE__, __CHANNEL__) __LL_ADC_IS_CHANNEL_INTERNAL_AVAILABLE((__ADC_INSTANCE__), (__CHANNEL__))
	Helper macro to determine whether the internal channel selected is available on the ADC instance selected.
#define	__HAL_ADC_MULTI_CONV_DATA_MASTER_SLAVE(__ADC_MULTI_MASTER_SLAVE__, __ADC_MULTI_CONV_DATA__) __LL_ADC_MULTI_CONV_DATA_MASTER_SLAVE((__ADC_MULTI_MASTER_SLAVE__), (__ADC_MULTI_CONV_DATA__))
	Helper macro to get the ADC multimode conversion data of ADC master or ADC slave from raw value with both ADC conversion data concatenated.
#define	__HAL_ADC_COMMON_INSTANCE(__ADCx__) __LL_ADC_COMMON_INSTANCE((__ADCx__))
	Helper macro to select the ADC common instance to which is belonging the selected ADC instance.
#define	__HAL_ADC_IS_ENABLED_ALL_COMMON_INSTANCE(__ADCXY_COMMON__) __LL_ADC_IS_ENABLED_ALL_COMMON_INSTANCE((__ADCXY_COMMON__))
	Helper macro to check if all ADC instances sharing the same ADC common instance are disabled.
#define	__HAL_ADC_DIGITAL_SCALE(__ADC_RESOLUTION__) __LL_ADC_DIGITAL_SCALE((__ADC_RESOLUTION__))
	Helper macro to define the ADC conversion data full-scale digital value corresponding to the selected ADC resolution.
#define	__HAL_ADC_CONVERT_DATA_RESOLUTION(__DATA__, __ADC_RESOLUTION_CURRENT__, __ADC_RESOLUTION_TARGET__)
	Helper macro to convert the ADC conversion data from a resolution to another resolution.
#define	__HAL_ADC_CALC_DATA_TO_VOLTAGE(__VREFANALOG_VOLTAGE__, __ADC_DATA__, __ADC_RESOLUTION__)
	Helper macro to calculate the voltage (unit: mVolt) corresponding to a ADC conversion data (unit: digital value).
#define	__HAL_ADC_CALC_VREFANALOG_VOLTAGE(__VREFINT_ADC_DATA__, __ADC_RESOLUTION__)
	Helper macro to calculate analog reference voltage (Vref+) (unit: mVolt) from ADC conversion data of internal voltage reference VrefInt.
#define	__HAL_ADC_CALC_TEMPERATURE(__VREFANALOG_VOLTAGE__, __TEMPSENSOR_ADC_DATA__, __ADC_RESOLUTION__)
	Helper macro to calculate the temperature (unit: degree Celsius) from ADC conversion data of internal temperature sensor.
#define	__HAL_ADC_CALC_TEMPERATURE_TYP_PARAMS(__TEMPSENSOR_TYP_AVGSLOPE__, __TEMPSENSOR_TYP_CALX_V__, __TEMPSENSOR_CALX_TEMP__, __VREFANALOG_VOLTAGE__, __TEMPSENSOR_ADC_DATA__, __ADC_RESOLUTION__)
	Helper macro to calculate the temperature (unit: degree Celsius) from ADC conversion data of internal temperature sensor.
Typedefs
typedef struct __ADC_HandleTypeDef	ADC_HandleTypeDef
	ADC handle Structure definition.
typedef void(*	pADC_CallbackTypeDef )(ADC_HandleTypeDef *hadc)
	HAL ADC Callback pointer definition.
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".
HAL_StatusTypeDef	HAL_ADC_DeInit (ADC_HandleTypeDef *hadc)
	Deinitialize the ADC peripheral registers to their default reset values, with deinitialization of the ADC MSP.
__weak void	HAL_ADC_MspInit (ADC_HandleTypeDef *hadc)
	Initialize the ADC MSP.
__weak void	HAL_ADC_MspDeInit (ADC_HandleTypeDef *hadc)
	DeInitialize the ADC MSP.
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.
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.
HAL_StatusTypeDef	HAL_ADC_Start (ADC_HandleTypeDef *hadc)
	Enable ADC, start conversion of regular group.
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.
HAL_StatusTypeDef	HAL_ADC_PollForConversion (ADC_HandleTypeDef *hadc, uint32_t Timeout)
	Wait for regular group conversion to be completed.
HAL_StatusTypeDef	HAL_ADC_PollForEvent (ADC_HandleTypeDef *hadc, uint32_t EventType, uint32_t Timeout)
	Poll for ADC event.
HAL_StatusTypeDef	HAL_ADC_Start_IT (ADC_HandleTypeDef *hadc)
	Enable ADC, start conversion of regular group with interruption.
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.
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.
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.
uint32_t	HAL_ADC_GetValue (ADC_HandleTypeDef *hadc)
	Get ADC regular group conversion result.
void	HAL_ADC_IRQHandler (ADC_HandleTypeDef *hadc)
	Handle ADC interrupt request.
__weak void	HAL_ADC_ConvCpltCallback (ADC_HandleTypeDef *hadc)
	Conversion complete callback in non-blocking mode.
__weak void	HAL_ADC_ConvHalfCpltCallback (ADC_HandleTypeDef *hadc)
	Conversion DMA half-transfer callback in non-blocking mode.
__weak void	HAL_ADC_LevelOutOfWindowCallback (ADC_HandleTypeDef *hadc)
	Analog watchdog 1 callback in non-blocking mode.
__weak void	HAL_ADC_ErrorCallback (ADC_HandleTypeDef *hadc)
	ADC error callback in non-blocking mode (ADC conversion with interruption or transfer by DMA).
HAL_StatusTypeDef	HAL_ADC_ConfigChannel (ADC_HandleTypeDef hadc, ADC_ChannelConfTypeDef sConfig)
	Configure a channel to be assigned to ADC group regular.
HAL_StatusTypeDef	HAL_ADC_AnalogWDGConfig (ADC_HandleTypeDef hadc, ADC_AnalogWDGConfTypeDef AnalogWDGConfig)
	Configure the analog watchdog.
uint32_t	HAL_ADC_GetState (ADC_HandleTypeDef *hadc)
	Return the ADC handle state.
uint32_t	HAL_ADC_GetError (ADC_HandleTypeDef *hadc)
	Return the ADC error code.
HAL_StatusTypeDef	ADC_ConversionStop (ADC_HandleTypeDef *hadc, uint32_t ConversionGroup)
	Stop ADC conversion.
HAL_StatusTypeDef	ADC_Enable (ADC_HandleTypeDef *hadc)
	Enable the selected ADC.
HAL_StatusTypeDef	ADC_Disable (ADC_HandleTypeDef *hadc)
	Disable the selected ADC.
void	ADC_DMAConvCplt (DMA_HandleTypeDef *hdma)
	DMA transfer complete callback.
void	ADC_DMAHalfConvCplt (DMA_HandleTypeDef *hdma)
	DMA half transfer complete callback.
void	ADC_DMAError (DMA_HandleTypeDef *hdma)
	DMA error callback.

Detailed Description

Header file of ADC HAL module.

Author:: MCD Application Team

Attention:

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. 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. 3. Neither the name of STMicroelectronics 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 THE COPYRIGHT HOLDER OR 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.

Definition in file stm32l4xx_hal_adc.h.

Data Structures

Defines

Typedefs

Enumerations

Functions

Detailed Description

© COPYRIGHT(c) 2017 STMicroelectronics