aboutsummaryrefslogtreecommitdiff
path: root/lib/stm32/f1/adc.c
diff options
context:
space:
mode:
Diffstat (limited to 'lib/stm32/f1/adc.c')
-rw-r--r--lib/stm32/f1/adc.c12
1 files changed, 11 insertions, 1 deletions
diff --git a/lib/stm32/f1/adc.c b/lib/stm32/f1/adc.c
index 6f4de48..433cdd2 100644
--- a/lib/stm32/f1/adc.c
+++ b/lib/stm32/f1/adc.c
@@ -272,12 +272,17 @@ void adc_disable_automatic_injected_group_conversion(u32 adc)
}
/*-----------------------------------------------------------------------------*/
-/** @brief ADC Enable Analog Watchdog for All Regular and Injected Channels
+/** @brief ADC Enable Analog Watchdog for All Regular and/or Injected Channels
The analog watchdog allows the monitoring of an analog signal between two threshold
levels. The thresholds must be preset. Comparison is done before data alignment
takes place, so the thresholds are left-aligned.
+@note The analog watchdog must be enabled for either or both of the regular or
+injected channels. If neither are enabled, the analog watchdog feature will be
+disabled.
+@ref adc_enable_analog_watchdog_injected, @ref adc_enable_analog_watchdog_regular.
+
@param[in] adc Unsigned int32. ADC block register address base @ref adc_reg_base
*/
@@ -293,6 +298,11 @@ The analog watchdog allows the monitoring of an analog signal between two thresh
levels. The thresholds must be preset. Comparison is done before data alignment
takes place, so the thresholds are left-aligned.
+@note The analog watchdog must be enabled for either or both of the regular or
+injected channels. If neither are enabled, the analog watchdog feature will be
+disabled. If both are enabled, the same channel number is monitored.
+@ref adc_enable_analog_watchdog_injected, @ref adc_enable_analog_watchdog_regular.
+
@param[in] adc Unsigned int32. ADC block register address base @ref adc_reg_base
@param[in] channel Unsigned int8. ADC channel number @ref adc_watchdog_channel
*/