[HAL][ADC] Update description field in HAL_ADCEx_EnableVREFINT() API and HAL_ADCEx_EnableVREFINTTempSensor() API
diff --git a/Src/stm32l0xx_hal_adc.c b/Src/stm32l0xx_hal_adc.c
index a02b8bd..4c1d2c1 100644
--- a/Src/stm32l0xx_hal_adc.c
+++ b/Src/stm32l0xx_hal_adc.c
@@ -134,12 +134,6 @@
monitored, thresholds, ...)
using function HAL_ADC_AnalogWDGConfig().
-
- (#) When device is in mode low-power (low-power run, low-power sleep or stop mode),
- function "HAL_ADCEx_EnableVREFINT()" must be called before function HAL_ADC_Init().
- In case of internal temperature sensor to be measured:
- function "HAL_ADCEx_EnableVREFINTTempSensor()" must be called similarilly
-
*** Execution of ADC conversions ***
====================================
[..]
@@ -382,11 +376,6 @@
* @note This function configures the ADC within 2 scopes: scope of entire
* ADC and scope of regular group. For parameters details, see comments
* of structure "ADC_InitTypeDef".
- * @note When device is in mode low-power (low-power run, low-power sleep or stop mode),
- * function "HAL_ADCEx_EnableVREFINT()" must be called before function HAL_ADC_Init()
- * (in case of previous ADC operations: function HAL_ADC_DeInit() must be called first).
- * In case of internal temperature sensor to be measured:
- * function "HAL_ADCEx_EnableVREFINTTempSensor()" must be called similarilly.
* @param hadc ADC handle
* @retval HAL status
*/
diff --git a/Src/stm32l0xx_hal_adc_ex.c b/Src/stm32l0xx_hal_adc_ex.c
index 39fcd1b..6f5d729 100644
--- a/Src/stm32l0xx_hal_adc_ex.c
+++ b/Src/stm32l0xx_hal_adc_ex.c
@@ -255,11 +255,11 @@
/**
* @brief Enables the buffer of Vrefint for the ADC, required when device is in mode low-power (low-power run, low-power sleep or stop mode)
- * This function must be called before function HAL_ADC_Init()
- * (in case of previous ADC operations: function HAL_ADC_DeInit() must be called first)
+ * However ADC is not functional in low-power mode, therefore these functions is not targeted for ADC (obsolete)
* For more details on procedure and buffer current consumption, refer to device reference manual.
* @note This is functional only if the LOCK is not set.
- * @note This API is obsolete. This configuration is done in HAL_ADC_ConfigChannel().
+ * @note This API is obsolete. This equivalent configuration is done in HAL_ADC_ConfigChannel().
+ bit fields in ADC_CCR and SYSCFG_CFGR3 control the same signals to VREFINT and TempSensor buffers
* @retval None
*/
HAL_StatusTypeDef HAL_ADCEx_EnableVREFINT(void)
@@ -291,7 +291,8 @@
/**
* @brief Disables the Buffer Vrefint for the ADC.
* @note This is functional only if the LOCK is not set.
- * @note This API is obsolete. This configuration is done in HAL_ADC_ConfigChannel().
+ * @note This API is obsolete. This equivalent configuration is done in HAL_ADC_ConfigChannel().
+ bit fields in ADC_CCR and SYSCFG_CFGR3 control the same signals to VREFINT and TempSensor buffers.
* @retval None
*/
void HAL_ADCEx_DisableVREFINT(void)
@@ -301,12 +302,12 @@
}
/**
- * @brief Enables the buffer of temperature sensor for the ADC, required when device is in mode low-power (low-power run, low-power sleep or stop mode)
- * This function must be called before function HAL_ADC_Init()
- * (in case of previous ADC operations: function HAL_ADC_DeInit() must be called first)
+ * @brief Enables the buffer of temperature sensor, when device is in mode low-power (low-power run, low-power sleep or stop mode)
+ * However ADC is not functional in low-power mode, therefore these functions is not targeted for ADC (obsolete)
* For more details on procedure and buffer current consumption, refer to device reference manual.
* @note This is functional only if the LOCK is not set.
- * @note This API is obsolete. This configuration is done in HAL_ADC_ConfigChannel().
+ * @note This API is obsolete. This equivalent configuration is done in HAL_ADC_ConfigChannel().
+ bit fields in ADC_CCR and SYSCFG_CFGR3 control the same signals to VREFINT and TempSensor buffers
* @retval None
*/
HAL_StatusTypeDef HAL_ADCEx_EnableVREFINTTempSensor(void)
@@ -338,7 +339,8 @@
/**
* @brief Disables the VREFINT and Sensor for the ADC.
* @note This is functional only if the LOCK is not set.
- * @note This API is obsolete. This configuration is done in HAL_ADC_ConfigChannel().
+ * @note This API is obsolete. This equivalent configuration is done in HAL_ADC_ConfigChannel().
+ bit fields in ADC_CCR and SYSCFG_CFGR3 control the same signals to VREFINT and TempSensor buffers.
* @retval None
*/
void HAL_ADCEx_DisableVREFINTTempSensor(void)
