Initialization and de-initialization functions

Initialization and Configuration functions. More...

Collaboration diagram for Initialization and de-initialization functions:

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.
void	HAL_ADC_MspInit (ADC_HandleTypeDef *hadc)
	Initializes the ADC MSP.
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_ADC_Init()

HAL_StatusTypeDef HAL_ADC_Init

(

ADC_HandleTypeDef *

hadc

)

#include <stm32f4xx_hal_adc.h>

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 311 of file stm32f4xx_hal_adc.c.

References __HAL_UNLOCK, ADC_CLEAR_ERRORCODE, ADC_Init(), ADC_SOFTWARE_START, ADC_STATE_CLR_SET, assert_param, ADC_InitTypeDef::ClockPrescaler, ADC_InitTypeDef::ContinuousConvMode, ADC_InitTypeDef::DataAlign, ADC_InitTypeDef::DiscontinuousConvMode, ADC_InitTypeDef::DMAContinuousRequests, ADC_InitTypeDef::EOCSelection, 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(), HAL_ERROR, HAL_IS_BIT_CLR, HAL_OK, HAL_UNLOCKED, ADC_HandleTypeDef::Init, 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::Lock, ADC_InitTypeDef::NbrOfConversion, ADC_InitTypeDef::Resolution, ADC_InitTypeDef::ScanConvMode, and ADC_HandleTypeDef::State.

HAL_ADC_DeInit()

HAL_StatusTypeDef HAL_ADC_DeInit

(

ADC_HandleTypeDef *

hadc

)

#include <stm32f4xx_hal_adc.h>

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 405 of file stm32f4xx_hal_adc.c.

References __HAL_ADC_DISABLE, __HAL_UNLOCK, ADC_CLEAR_ERRORCODE, assert_param, HAL_ADC_MspDeInit(), HAL_ADC_STATE_BUSY_INTERNAL, HAL_ADC_STATE_RESET, HAL_ERROR, HAL_IS_BIT_CLR, HAL_OK, ADC_HandleTypeDef::Instance, and ADC_HandleTypeDef::State.

HAL_ADC_MspInit()

__weak void HAL_ADC_MspInit

(

ADC_HandleTypeDef *

hadc

)

#include <stm32f4xx_hal_adc.h>

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 662 of file stm32f4xx_hal_adc.c.

References UNUSED.

Referenced by HAL_ADC_Init().

HAL_ADC_MspDeInit()

__weak void HAL_ADC_MspDeInit

(

ADC_HandleTypeDef *

hadc

)

#include <stm32f4xx_hal_adc.h>

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 677 of file stm32f4xx_hal_adc.c.

References UNUSED.

Referenced by HAL_ADC_DeInit().