kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-29 00:11:16 +01:00
Code Releases Activity

boards/nucleo*: create dedicated variant doc.md files

Browse Source
This commit is contained in:
crasbe 2025-03-30 00:06:41 +01:00
parent 5afe64ec79
commit 72cf71967f
7 changed files with 71 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
boards/common/nucleo144/doc.md Normal file
View File

@ -0,0 +1,17 @@
@defgroup boards_common_nucleo144 STM32 Nucleo-144
@ingroup boards
@brief Support for STM32 Nucleo-144 boards
## Flashing the Board
A detailed description about the flashing process can be found on the
[guides page](https://guide.riot-os.org/board_specific/stm32/).
## Accessing the RIOT shell
The default RIOT OS shell access utilizes the ST-Link VCP (Virtual COM Port)
that is featured on every Nucleo board. The USART used for this connection
varies between the different Nucleo variants, so you have to consult the
`nucleo-xxxxx/include/periph_conf.h` header file for more information.
The default baud rate is 115200, 8N1.

4
boards/common/nucleo144/include/board.h
View File

@ -8,9 +8,7 @@
#pragma once
/**
* @defgroup boards_common_nucleo144 STM32 Nucleo-144
* @ingroup boards
* @brief Support for STM32 Nucleo-144 boards
* @ingroup boards_common_nucleo144
* @{
*
* @file

17
boards/common/nucleo32/doc.md Normal file
View File

@ -0,0 +1,17 @@
@defgroup boards_common_nucleo32 STM32 Nucleo-32
@ingroup boards
@brief Support for STM32 Nucleo-32 boards
## Flashing the Board
A detailed description about the flashing process can be found on the
[guides page](https://guide.riot-os.org/board_specific/stm32/).
## Accessing the RIOT shell
The default RIOT OS shell access utilizes the ST-Link VCP (Virtual COM Port)
that is featured on every Nucleo board. The USART used for this connection
varies between the different Nucleo variants, so you have to consult the
`nucleo-xxxxx/include/periph_conf.h` header file for more information.
The default baud rate is 115200, 8N1.

4
boards/common/nucleo32/include/board.h
View File

@ -6,9 +6,7 @@
#pragma once
/**
* @defgroup boards_common_nucleo32 STM32 Nucleo-32
* @ingroup boards
* @brief Support for STM32 Nucleo-32 boards
* @ingroup boards_common_nucleo32
* @{
*
* @file

26
boards/common/nucleo64/doc.md Normal file
View File

@ -0,0 +1,26 @@
@defgroup boards_common_nucleo64 STM32 Nucleo-64
@ingroup boards
@brief Support for STM32 Nucleo-64 Boards
## Using LED0 and SPI at once
Due to a pin conflict on Nucleo64 boards, you can not use
the SPI peripheral and LED0 at the same time.
A warning will be shown during compile time:
```
Warning: Using periph_spi on Nucleo64 boards will disable LED0 due to pin conflicts.
```
## Flashing the Board
A detailed description about the flashing process can be found on the
[guides page](https://guide.riot-os.org/board_specific/stm32/).
## Accessing the RIOT shell
The default RIOT OS shell access utilizes the ST-Link VCP (Virtual COM Port)
that is featured on every Nucleo board. The USART used for this connection
varies between the different Nucleo variants, so you have to consult the
`nucleo-xxxxx/include/periph_conf.h` header file for more information.
The default baud rate is 115200, 8N1.

4
boards/common/nucleo64/include/board.h
View File

@ -6,9 +6,7 @@
#pragma once
/**
* @defgroup boards_common_nucleo64 STM32 Nucleo-64
* @ingroup boards
* @brief Support for STM32 Nucleo-64 boards
* @ingroup boards_common_nucleo64
* @{
*
* @file

16
dist/tools/doccheck/exclude_simple vendored
View File

@ -4699,8 +4699,8 @@ warning: Member MODULE_PIN_P6 (macro definition) of file board_module.h is not d
warning: Member MODULE_PIN_P7 (macro definition) of file board_module.h is not documented.
warning: Member MODULE_PIN_P8 (macro definition) of file board_module.h is not documented.
warning: Member MODULE_PIN_P9 (macro definition) of file board_module.h is not documented.
warning: Member motor_driver_config[] (variable) of group boards_common_nucleo64 is not documented.
warning: Member MOTOR_DRIVER_NUMOF (macro definition) of group boards_common_nucleo64 is not documented.
warning: Member motor_driver_config[] (variable) of file board.h is not documented.
warning: Member MOTOR_DRIVER_NUMOF (macro definition) of file board.h is not documented.
warning: Member MPL3115A2_CTRL_REG1_ALT (macro definition) of file mpl3115a2_reg.h is not documented.
warning: Member MPL3115A2_CTRL_REG1_OS_MASK (macro definition) of file mpl3115a2_reg.h is not documented.
warning: Member MPL3115A2_CTRL_REG1_OS_SHIFT (macro definition) of file mpl3115a2_reg.h is not documented.
@ -4871,17 +4871,17 @@ warning: Member MRF24J40_PACON2_TXONTS1 (macro definition) of file mrf24j40_regi
warning: Member MRF24J40_PACON2_TXONTS2 (macro definition) of file mrf24j40_registers.h is not documented.
warning: Member MRF24J40_PACON2_TXONTS3 (macro definition) of file mrf24j40_registers.h is not documented.
warning: Member MRF24J40_PARAM_CS (macro definition) of file mrf24j40_params.h is not documented.
warning: Member MRF24J40_PARAM_CS (macro definition) of group boards_common_nucleo64 is not documented.
warning: Member MRF24J40_PARAM_CS (macro definition) of file board.h is not documented.
warning: Member MRF24J40_PARAM_INT (macro definition) of file mrf24j40_params.h is not documented.
warning: Member MRF24J40_PARAM_INT (macro definition) of group boards_common_nucleo64 is not documented.
warning: Member MRF24J40_PARAM_INT (macro definition) of file board.h is not documented.
warning: Member MRF24J40_PARAM_RESET (macro definition) of file mrf24j40_params.h is not documented.
warning: Member MRF24J40_PARAM_RESET (macro definition) of group boards_common_nucleo64 is not documented.
warning: Member MRF24J40_PARAM_RESET (macro definition) of file board.h is not documented.
warning: Member MRF24J40_PARAMS (macro definition) of file mrf24j40_params.h is not documented.
warning: Member MRF24J40_PARAMS (macro definition) of group boards_common_nucleo64 is not documented.
warning: Member MRF24J40_PARAMS (macro definition) of file board.h is not documented.
warning: Member MRF24J40_PARAM_SPI_CLK (macro definition) of file mrf24j40_params.h is not documented.
warning: Member MRF24J40_PARAM_SPI_CLK (macro definition) of group boards_common_nucleo64 is not documented.
warning: Member MRF24J40_PARAM_SPI_CLK (macro definition) of file board.h is not documented.
warning: Member MRF24J40_PARAM_SPI (macro definition) of file mrf24j40_params.h is not documented.
warning: Member MRF24J40_PARAM_SPI (macro definition) of group boards_common_nucleo64 is not documented.
warning: Member MRF24J40_PARAM_SPI (macro definition) of file board.h is not documented.
warning: Member MRF24J40_REG_ACKTMOUT (macro definition) of file mrf24j40_registers.h is not documented.
warning: Member MRF24J40_REG_ASSOEADR0 (macro definition) of file mrf24j40_registers.h is not documented.
warning: Member MRF24J40_REG_ASSOEADR1 (macro definition) of file mrf24j40_registers.h is not documented.