Peripheral State And Errors Functions; Detailed Description Of Functions - ST STM32F2 User Manual

HAL ADC Generic Driver
This section contains the following APIs:
HAL_ADC_ConfigChannel()
HAL_ADC_AnalogWDGConfig()
6.2.6

Peripheral State and errors functions

This subsection provides functions allowing to
Check the ADC state
Check the ADC Error
This section contains the following APIs:
HAL_ADC_GetState()
HAL_ADC_GetError()
6.2.7

Detailed description of functions

HAL_ADC_Init
Function name
Function description
Parameters
Return values
Notes
HAL_ADC_DeInit
Function name
Function description
Parameters
Return values
HAL_ADC_MspInit
Function name
Function description
Parameters
84/1371
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.
hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
HAL: status
This function is used to configure the global features of the
ADC ( ClockPrescaler, Resolution, Data Alignment and
number of conversion), however, the rest of the configuration
parameters are specific to the regular channels group (scan
mode activation, continuous mode activation, External trigger
source and edge, DMA continuous request after the last
transfer and End of conversion selection).
HAL_StatusTypeDef HAL_ADC_DeInit (ADC_HandleTypeDef *
hadc)
Deinitializes the ADCx peripheral registers to their default reset
values.
hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
HAL: status
void HAL_ADC_MspInit (ADC_HandleTypeDef * hadc)
Initializes the ADC MSP.
hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
DocID028236 Rev 2
UM1940