1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2026-01-01 01:41:18 +01:00

boards/nucleo-l432kc: add Doxygen doc

This commit is contained in:
krzysztof-cabaj 2025-06-10 15:30:12 +02:00
parent 5cc59a0a1e
commit ac4b20beb1

View File

@ -115,6 +115,29 @@ static const spi_conf_t spi_config[] = {
#define SPI_NUMOF ARRAY_SIZE(spi_config)
/** @} */
/**
* @brief ADC configuration
*
* Note that we do not configure all ADC channels,
* and not in the STM32L432KC order. Instead, we
* just define 5 ADC channels, for the Nucleo
* Arduino Nano header pins A0-A3 and A6 - all which are
* enabled by default and without collision with other
* features, for example, I2C or VCP_TX.
*
* To find appropriate device and channel find in the
* board manual, table showing pin assignments and
* information about ADC - a text similar to ADC[X]_IN[Y],
* where:
* [X] - describes used device - indexed from 0,
* for example ADC1_IN10 is device 0,
* [Y] - describes used channel - indexed from 1,
* for example ADC1_IN10 is channel 10
*
* For Nucleo-L432KC this information is in board manual,
* Table 16 or STM32L432KC MCU datasheet - Table 14.
* @{
*/
static const adc_conf_t adc_config[] = {
{GPIO_PIN(PORT_A, 0), .dev = 0, .chan = 5}, /* ADC12_IN5 */
{GPIO_PIN(PORT_A, 1), .dev = 0, .chan = 6}, /* ADC12_IN6 */
@ -123,8 +146,13 @@ static const adc_conf_t adc_config[] = {
{GPIO_PIN(PORT_A, 7), .dev = 0, .chan = 12}, /* ADC12_IN12 */
};
/**
* @brief Number of ADC devices
*/
#define ADC_NUMOF ARRAY_SIZE(adc_config)
/** @} */
#ifdef __cplusplus
}
#endif