b47b967440
Only applied to STM32 doc trees at present. Instead of declaring a group for "STM32blah" in the doc-blah.h files, and then trying to put all the common+specific peripheral code into those groups, (which is what led to the stub doxygen holder empty .c files) Just use a standard name like "Peripheral APIS" and place everything into that. Demonstrated by converting ADC and USART peripherals, which is definitely not complete, but it shows how to make things less magical, and less prone to copy/paste errors. Now, you can copy/paste and it will do the right thing, because everyone uses the same group names. This is also how to unify the mix of "STM32blah->Periphblah" and _also_ the dangling "periph_file" modules in doxygen, it merges them together properly, as they're intended to be really.
199 lines
5.9 KiB
C
199 lines
5.9 KiB
C
/** @addtogroup adc_file ADC peripheral API
|
|
@ingroup peripheral_apis
|
|
|
|
@author @htmlonly © @endhtmlonly 2014 Karl Palsson <karlp@tweak.net.au>
|
|
|
|
|
|
LGPL License Terms @ref lgpl_license
|
|
*/
|
|
/*
|
|
* This file is part of the libopencm3 project.
|
|
*
|
|
* Copyright (C) 2014 Karl Palsson <karlp@tweak.net.au>
|
|
*
|
|
* This library is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include <libopencm3/stm32/adc.h>
|
|
|
|
/**@{*/
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief ADC Power On
|
|
|
|
If the ADC is in power-down mode then it is powered up. The application needs
|
|
to wait a time of about 3 microseconds for stabilization before using the ADC.
|
|
If the ADC is already on this function call will have no effect.
|
|
* NOTE Common with F4 and F2
|
|
|
|
@param[in] adc Unsigned int32. ADC block register address base @ref adc_reg_base
|
|
*/
|
|
|
|
void adc_power_on(uint32_t adc)
|
|
{
|
|
ADC_CR2(adc) |= ADC_CR2_ADON;
|
|
}
|
|
|
|
|
|
/*----------------------------------------------------------------------------*/
|
|
|
|
/** @brief ADC Set the Sample Time for a Single Channel
|
|
|
|
The sampling time can be selected in ADC clock cycles from 4 to 384.
|
|
|
|
@param[in] adc Unsigned int32. ADC block base address @ref adc_reg_base.
|
|
@param[in] channel uint8. ADC Channel integer 0..18 or from @ref adc_channel.
|
|
@param[in] time Unsigned int8. Sampling time selection from @ref adc_sample_rg.
|
|
*/
|
|
void adc_set_sample_time(uint32_t adc, uint8_t channel, uint8_t time)
|
|
{
|
|
uint32_t reg32;
|
|
|
|
if (channel < 10) {
|
|
reg32 = ADC_SMPR3(adc);
|
|
reg32 &= ~(0x7 << (channel * 3));
|
|
reg32 |= (time << (channel * 3));
|
|
ADC_SMPR3(adc) = reg32;
|
|
} else if (channel < 20) {
|
|
reg32 = ADC_SMPR2(adc);
|
|
reg32 &= ~(0x7 << ((channel - 10) * 3));
|
|
reg32 |= (time << ((channel - 10) * 3));
|
|
ADC_SMPR2(adc) = reg32;
|
|
} else {
|
|
reg32 = ADC_SMPR1(adc);
|
|
reg32 &= ~(0x7 << ((channel - 20) * 3));
|
|
reg32 |= (time << ((channel - 20) * 3));
|
|
ADC_SMPR1(adc) = reg32;
|
|
}
|
|
}
|
|
|
|
/*----------------------------------------------------------------------------*/
|
|
/** @brief ADC Set the Sample Time for All Channels
|
|
|
|
The sampling time can be selected in ADC clock cycles, same for
|
|
all channels.
|
|
|
|
@param[in] adc Unsigned int32. ADC block base address @ref adc_reg_base.
|
|
@param[in] time Unsigned int8. Sampling time selection from @ref adc_sample_rg.
|
|
*/
|
|
|
|
void adc_set_sample_time_on_all_channels(uint32_t adc, uint8_t time)
|
|
{
|
|
uint8_t i;
|
|
uint32_t reg32 = 0;
|
|
|
|
for (i = 0; i <= 9; i++) {
|
|
reg32 |= (time << (i * 3));
|
|
}
|
|
ADC_SMPR0(adc) = reg32;
|
|
ADC_SMPR1(adc) = reg32;
|
|
ADC_SMPR2(adc) = reg32;
|
|
ADC_SMPR3(adc) = reg32;
|
|
}
|
|
|
|
/*----------------------------------------------------------------------------*/
|
|
/** @brief ADC Enable The Temperature Sensor
|
|
|
|
This enables both the sensor and the reference voltage measurements on channels
|
|
16 and 17.
|
|
|
|
*/
|
|
void adc_enable_temperature_sensor()
|
|
{
|
|
ADC_CCR |= ADC_CCR_TSVREFE;
|
|
}
|
|
|
|
/*----------------------------------------------------------------------------*/
|
|
/** @brief ADC Disable The Temperature Sensor
|
|
|
|
Disabling this will reduce power consumption from the sensor and the reference
|
|
voltage measurements.
|
|
|
|
*/
|
|
void adc_disable_temperature_sensor()
|
|
{
|
|
ADC_CCR &= ~ADC_CCR_TSVREFE;
|
|
}
|
|
|
|
/*----------------------------------------------------------------------------*/
|
|
/** @brief ADC Disable an External Trigger for Regular Channels
|
|
|
|
@param[in] adc Unsigned int32. ADC block register address base @ref adc_reg_base
|
|
*/
|
|
|
|
void adc_disable_external_trigger_regular(uint32_t adc)
|
|
{
|
|
ADC_CR2(adc) &= ~ADC_CR2_EXTEN_MASK;
|
|
}
|
|
|
|
/*----------------------------------------------------------------------------*/
|
|
/** @brief ADC Disable an External Trigger for Injected Channels
|
|
|
|
@param[in] adc Unsigned int32. ADC block base address @ref adc_reg_base.
|
|
*/
|
|
|
|
void adc_disable_external_trigger_injected(uint32_t adc)
|
|
{
|
|
ADC_CR2(adc) &= ~ADC_CR2_JEXTEN_MASK;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief ADC Enable an External Trigger for Regular Channels
|
|
|
|
This enables an external trigger for set of defined regular channels, and sets
|
|
the polarity of the trigger event: rising or falling edge or both. Note that if
|
|
the trigger polarity is zero, triggering is disabled.
|
|
|
|
@param[in] adc Unsigned int32. ADC block register address base @ref adc_reg_base
|
|
@param[in] trigger Unsigned int32. Trigger identifier @ref adc_trigger_regular
|
|
@param[in] polarity Unsigned int32. Trigger polarity @ref
|
|
adc_trigger_polarity_regular
|
|
*/
|
|
|
|
void adc_enable_external_trigger_regular(uint32_t adc, uint32_t trigger,
|
|
uint32_t polarity)
|
|
{
|
|
uint32_t reg32 = ADC_CR2(adc);
|
|
|
|
reg32 &= ~(ADC_CR2_EXTSEL_MASK | ADC_CR2_EXTEN_MASK);
|
|
reg32 |= (trigger | polarity);
|
|
ADC_CR2(adc) = reg32;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief ADC Enable an External Trigger for Injected Channels
|
|
|
|
This enables an external trigger for set of defined injected channels, and sets
|
|
the polarity of the trigger event: rising or falling edge or both.
|
|
|
|
@param[in] adc Unsigned int32. ADC block register address base @ref adc_reg_base
|
|
@param[in] trigger Unsigned int8. Trigger identifier @ref adc_trigger_injected
|
|
@param[in] polarity Unsigned int32. Trigger polarity @ref
|
|
adc_trigger_polarity_injected
|
|
*/
|
|
|
|
void adc_enable_external_trigger_injected(uint32_t adc, uint32_t trigger,
|
|
uint32_t polarity)
|
|
{
|
|
uint32_t reg32 = ADC_CR2(adc);
|
|
|
|
reg32 &= ~(ADC_CR2_JEXTSEL_MASK | ADC_CR2_JEXTEN_MASK);
|
|
reg32 |= (trigger | polarity);
|
|
ADC_CR2(adc) = reg32;
|
|
}
|
|
|
|
/**@}*/
|
|
|
|
|