Initialization and de-initialization functions

Initialization and Configuration functions. 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.
HAL_StatusTypeDef	HAL_ADC_DeInit (ADC_HandleTypeDef *hadc)
	Deinitializes the ADCx peripheral registers to their default reset values.
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.
__weak void	HAL_ADC_MspInit (ADC_HandleTypeDef *hadc)
	Initializes the ADC MSP.
__weak void	HAL_ADC_MspDeInit (ADC_HandleTypeDef *hadc)
	DeInitializes the ADC MSP.

---

Detailed Description

Initialization and Configuration functions.

 ===============================================================================
              ##### Initialization and de-initialization functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Initialize and configure the ADC. 
      (+) De-initialize the ADC. 
         

---

Function Documentation

HAL_StatusTypeDef HAL_ADC_DeInit

(

ADC_HandleTypeDef *

hadc

)

Deinitializes the ADCx peripheral registers to their default reset values.

Parameters:

hadc	pointer to a ADC_HandleTypeDef structure that contains the configuration information for the specified ADC.

Return values:

HAL

status

Definition at line 406 of file stm32f4xx_hal_adc.c.

References __HAL_ADC_DISABLE, ADC_CLEAR_ERRORCODE, assert_param, HAL_ADC_MspDeInit(), HAL_ADC_STATE_BUSY_INTERNAL, HAL_ADC_STATE_RESET, __ADC_HandleTypeDef::Instance, __ADC_HandleTypeDef::MspDeInitCallback, and __ADC_HandleTypeDef::State.

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.

Note:

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).

Parameters:

hadc	pointer to a ADC_HandleTypeDef structure that contains the configuration information for the specified ADC.

Return values:

HAL

status

Definition at line 312 of file stm32f4xx_hal_adc.c.

References ADC_CLEAR_ERRORCODE, ADC_Init(), ADC_SOFTWARE_START, ADC_STATE_CLR_SET, assert_param, ADC_InitTypeDef::ClockPrescaler, ADC_InitTypeDef::ContinuousConvMode, __ADC_HandleTypeDef::ConvCpltCallback, __ADC_HandleTypeDef::ConvHalfCpltCallback, ADC_InitTypeDef::DataAlign, ADC_InitTypeDef::DiscontinuousConvMode, ADC_InitTypeDef::DMAContinuousRequests, ADC_InitTypeDef::EOCSelection, __ADC_HandleTypeDef::ErrorCallback, ADC_InitTypeDef::ExternalTrigConv, ADC_InitTypeDef::ExternalTrigConvEdge, HAL_ADC_ConvCpltCallback(), HAL_ADC_ConvHalfCpltCallback(), HAL_ADC_ErrorCallback(), HAL_ADC_LevelOutOfWindowCallback(), HAL_ADC_MspInit(), HAL_ADC_STATE_BUSY_INTERNAL, HAL_ADC_STATE_ERROR_INTERNAL, HAL_ADC_STATE_INJ_BUSY, HAL_ADC_STATE_READY, HAL_ADC_STATE_REG_BUSY, HAL_ADC_STATE_RESET, HAL_ADCEx_InjectedConvCpltCallback(), __ADC_HandleTypeDef::Init, __ADC_HandleTypeDef::InjectedConvCpltCallback, __ADC_HandleTypeDef::Instance, IS_ADC_CLOCKPRESCALER, IS_ADC_DATA_ALIGN, IS_ADC_EOCSelection, IS_ADC_EXT_TRIG, IS_ADC_EXT_TRIG_EDGE, IS_ADC_REGULAR_LENGTH, IS_ADC_RESOLUTION, __ADC_HandleTypeDef::LevelOutOfWindowCallback, __ADC_HandleTypeDef::Lock, __ADC_HandleTypeDef::MspInitCallback, ADC_InitTypeDef::NbrOfConversion, ADC_InitTypeDef::Resolution, ADC_InitTypeDef::ScanConvMode, and __ADC_HandleTypeDef::State.

void HAL_ADC_MspDeInit

(

ADC_HandleTypeDef *

hadc

)

DeInitializes the ADC MSP.

Parameters:

hadc	pointer to a ADC_HandleTypeDef structure that contains the configuration information for the specified ADC.

Return values:

None

Definition at line 678 of file stm32f4xx_hal_adc.c.

Referenced by HAL_ADC_DeInit(), and HAL_ADC_UnRegisterCallback().

void HAL_ADC_MspInit

(

ADC_HandleTypeDef *

hadc

)

Initializes the ADC MSP.

Parameters:

hadc	pointer to a ADC_HandleTypeDef structure that contains the configuration information for the specified ADC.

Return values:

None

Definition at line 663 of file stm32f4xx_hal_adc.c.

Referenced by HAL_ADC_Init(), and HAL_ADC_UnRegisterCallback().

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.

Parameters:

hadc	Pointer to a ADC_HandleTypeDef structure that contains the configuration information for the specified ADC.
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_ADC_CONVERSION_COMPLETE_CB_ID ADC conversion complete callback ID HAL_ADC_CONVERSION_HALF_CB_ID ADC conversion DMA half-transfer callback ID HAL_ADC_LEVEL_OUT_OF_WINDOW_1_CB_ID ADC analog watchdog 1 callback ID HAL_ADC_ERROR_CB_ID ADC error callback ID HAL_ADC_INJ_CONVERSION_COMPLETE_CB_ID ADC group injected conversion complete callback ID HAL_ADC_MSPINIT_CB_ID ADC Msp Init callback ID HAL_ADC_MSPDEINIT_CB_ID ADC Msp DeInit callback ID
pCallback	pointer to the Callback function

Return values:

HAL

status

Definition at line 475 of file stm32f4xx_hal_adc.c.

References __ADC_HandleTypeDef::ConvCpltCallback, __ADC_HandleTypeDef::ConvHalfCpltCallback, __ADC_HandleTypeDef::ErrorCallback, __ADC_HandleTypeDef::ErrorCode, HAL_ADC_CONVERSION_COMPLETE_CB_ID, HAL_ADC_CONVERSION_HALF_CB_ID, HAL_ADC_ERROR_CB_ID, HAL_ADC_ERROR_INVALID_CALLBACK, HAL_ADC_INJ_CONVERSION_COMPLETE_CB_ID, HAL_ADC_LEVEL_OUT_OF_WINDOW_1_CB_ID, HAL_ADC_MSPDEINIT_CB_ID, HAL_ADC_MSPINIT_CB_ID, HAL_ADC_STATE_READY, HAL_ADC_STATE_RESET, __ADC_HandleTypeDef::InjectedConvCpltCallback, __ADC_HandleTypeDef::LevelOutOfWindowCallback, __ADC_HandleTypeDef::MspDeInitCallback, __ADC_HandleTypeDef::MspInitCallback, and __ADC_HandleTypeDef::State.

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.

Parameters:

hadc

Pointer to a ADC_HandleTypeDef structure that contains the configuration information for the specified ADC.

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_ADC_CONVERSION_COMPLETE_CB_ID ADC conversion complete callback ID HAL_ADC_CONVERSION_HALF_CB_ID ADC conversion DMA half-transfer callback ID HAL_ADC_LEVEL_OUT_OF_WINDOW_1_CB_ID ADC analog watchdog 1 callback ID HAL_ADC_ERROR_CB_ID ADC error callback ID HAL_ADC_INJ_CONVERSION_COMPLETE_CB_ID ADC group injected conversion complete callback ID HAL_ADC_MSPINIT_CB_ID ADC Msp Init callback ID HAL_ADC_MSPDEINIT_CB_ID ADC Msp DeInit callback ID

Return values:

HAL

status

Definition at line 577 of file stm32f4xx_hal_adc.c.

References __ADC_HandleTypeDef::ConvCpltCallback, __ADC_HandleTypeDef::ConvHalfCpltCallback, __ADC_HandleTypeDef::ErrorCallback, __ADC_HandleTypeDef::ErrorCode, HAL_ADC_ConvCpltCallback(), HAL_ADC_CONVERSION_COMPLETE_CB_ID, HAL_ADC_CONVERSION_HALF_CB_ID, HAL_ADC_ConvHalfCpltCallback(), HAL_ADC_ERROR_CB_ID, HAL_ADC_ERROR_INVALID_CALLBACK, HAL_ADC_ErrorCallback(), HAL_ADC_INJ_CONVERSION_COMPLETE_CB_ID, HAL_ADC_LEVEL_OUT_OF_WINDOW_1_CB_ID, HAL_ADC_LevelOutOfWindowCallback(), HAL_ADC_MspDeInit(), HAL_ADC_MSPDEINIT_CB_ID, HAL_ADC_MspInit(), HAL_ADC_MSPINIT_CB_ID, HAL_ADC_STATE_READY, HAL_ADC_STATE_RESET, HAL_ADCEx_InjectedConvCpltCallback(), __ADC_HandleTypeDef::InjectedConvCpltCallback, __ADC_HandleTypeDef::LevelOutOfWindowCallback, __ADC_HandleTypeDef::MspDeInitCallback, __ADC_HandleTypeDef::MspInitCallback, and __ADC_HandleTypeDef::State.