jackcartersmith/blackmagic
1
0
Fork 0
Code Issues Pull Requests Releases Activity

stm32: adc-v1m: doc cleanups

Browse Source 
Try and fix some of the specifics from old f4 source material.
This commit is contained in:
Karl Palsson 2019-05-10 23:15:42 +00:00
parent 13d46e81df
commit e77bc94b8c
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
lib/stm32/common/adc_common_v1_multi.c
View File

@ -14,10 +14,14 @@ registers. However all the A/D converters share a common clock which is
prescaled from the APB2 clock by default by a minimum factor of 2 to a maximum prescaled from the APB2 clock by default by a minimum factor of 2 to a maximum
of 8. The ADC resolution can be set to 12, 10, 8 or 6 bits. of 8. The ADC resolution can be set to 12, 10, 8 or 6 bits.
Each A/D converter has up to 19 channels: Each A/D converter has multiple channels, not all of which might be available
@li On ADC1 the analog channels 16 is internally connected to the temperature externally. Internal channels can be used for the the temperature sensor,
sensor, channel 17 to V<sub>REFINT</sub>, and channel 18 to V<sub>BAT</sub>. VBat monitoring, and the internal reference voltage VREFINT. Consult the
@li On ADC2 and ADC3 the analog channels 16 - 18 are not used. Reference manual for the specifics of your part.
@sa ADC_MAX_CHANNELS
@sa ADC_CHANNEL_TEMP
@sa ADC_CHANNEL_VREF
@sa ADC_CHANNEL_VBAT
The conversions can occur as a one-off conversion whereby the process stops The conversions can occur as a one-off conversion whereby the process stops
once conversion is complete. The conversions can also be continuous wherein a once conversion is complete. The conversions can also be continuous wherein a
@ -36,7 +40,7 @@ Injected conversions allow a second group of channels to be converted
separately from the regular group. An interrupt can be set to occur at the end separately from the regular group. An interrupt can be set to occur at the end
of conversion, which occurs after all channels have been scanned. of conversion, which occurs after all channels have been scanned.
@section adc_f4_api_ex Basic ADC Handling API. @section adc_api_ex Basic ADC Handling API.
Example 1: Simple single channel conversion polled. Enable the peripheral clock Example 1: Simple single channel conversion polled. Enable the peripheral clock
and ADC, reset ADC and set the prescaler divider. Set the sample time to a and ADC, reset ADC and set the prescaler divider. Set the sample time to a
@ -102,11 +106,9 @@ void adc_power_on(uint32_t adc)
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @brief ADC Set Clock Prescale /** @brief ADC Set Clock Prescale
The ADC clock can be prescaled.
The ADC clock taken from the APB2 clock can be scaled down by 2, 4, 6 or 8. The Clock sources and scaler values are part specific.
@param[in] prescale Prescale value for ADC Clock @ref adc_ccr_adcpre
@param[in] prescale Unsigned int32. Prescale value for ADC Clock @ref
adc_ccr_adcpre
*/ */
void adc_set_clk_prescale(uint32_t prescale) void adc_set_clk_prescale(uint32_t prescale)
@ -332,8 +334,8 @@ bool adc_awd(uint32_t adc)
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @brief ADC Enable The Temperature Sensor /** @brief ADC Enable The Temperature Sensor
This enables both the sensor and the reference voltage measurements on ADC1 This enables both the sensor and the reference voltage measurements on ADC1.
channels 16 and 17. On STM32F42x and STM32F43x, the temperature sensor is On STM32F42x and STM32F43x, the temperature sensor is
connected to ADC1 channel 18, the same as VBat. If both are enabled, only the connected to ADC1 channel 18, the same as VBat. If both are enabled, only the
VBat conversion is performed. VBat conversion is performed.
*/ */
@ -355,6 +357,4 @@ void adc_disable_temperature_sensor(void)
ADC_CCR &= ~ADC_CCR_TSVREFE; ADC_CCR &= ~ADC_CCR_TSVREFE;
} }
/**@}*/ /**@}*/