aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/platforms/STM32F4xx/adc_lld.c
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/platforms/STM32F4xx/adc_lld.c')
-rw-r--r--os/hal/platforms/STM32F4xx/adc_lld.c2
1 files changed, 2 insertions, 0 deletions
diff --git a/os/hal/platforms/STM32F4xx/adc_lld.c b/os/hal/platforms/STM32F4xx/adc_lld.c
index fef357c3b..1398ea4f3 100644
--- a/os/hal/platforms/STM32F4xx/adc_lld.c
+++ b/os/hal/platforms/STM32F4xx/adc_lld.c
@@ -399,6 +399,7 @@ void adcSTM32DisableTSVREFE(void) {
* @brief Enables the VBATE bit.
* @details The VBATE bit is required in order to sample the VBAT channel.
* @note This is an STM32-only functionality.
+ * @note This function is meant to be called after @p adcStart().
*/
void adcSTM32EnableVBATE(void) {
@@ -409,6 +410,7 @@ void adcSTM32EnableVBATE(void) {
* @brief Disables the VBATE bit.
* @details The VBATE bit is required in order to sample the VBAT channel.
* @note This is an STM32-only functionality.
+ * @note This function is meant to be called after @p adcStart().
*/
void adcSTM32DisableVBATE(void) {