stm32:adcv1: correct documentation for AWD

remove misleading atttempt at describing that the thresholds are
compared before any alignment changes takes place.
This commit is contained in:
Karl Palsson 2017-06-23 23:05:54 +00:00
parent 860d10940b
commit 5a517f7854

View File

@ -113,8 +113,7 @@ void adc_power_off(uint32_t adc)
/** @brief ADC Enable Analog Watchdog for Regular Conversions
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.
threshold levels. The thresholds must be preset.
@param[in] adc Unsigned int32. ADC block register address base @ref
adc_reg_base.
@ -529,7 +528,7 @@ void adc_set_single_conversion_mode(uint32_t adc)
/** @brief ADC Set Analog Watchdog Upper Threshold
@param[in] adc Unsigned int32. ADC block register address base @ref adc_reg_base
@param[in] threshold Unsigned int8. Upper threshold value
@param[in] threshold Upper threshold value, 12bit right aligned.
*/
void adc_set_watchdog_high_threshold(uint32_t adc, uint16_t threshold)
@ -545,7 +544,7 @@ void adc_set_watchdog_high_threshold(uint32_t adc, uint16_t threshold)
/** @brief ADC Set Analog Watchdog Lower Threshold
@param[in] adc Unsigned int32. ADC block register address base @ref adc_reg_base
@param[in] threshold Unsigned int8. Lower threshold value
@param[in] threshold Lower threshold value, 12bit right aligned.
*/
void adc_set_watchdog_low_threshold(uint32_t adc, uint16_t threshold)