Skip to content

Commit ce69265

Browse files
crasbecrasbe
authored
Merge pull request #21337 from crasbe/pr/nucleo-doc
boards/nucleo*: Cleanup and Enhance the Documentation
2 parents 28ca3d1 + b6931af commit ce69265

File tree

54 files changed

+406
-1161
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+406
-1161
lines changed

‎boards/common/nucleo144/doc.md‎

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

‎boards/common/nucleo144/include/board.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@
88
#pragma once
99

1010
/**
11-
* @defgroup boards_common_nucleo144 STM32 Nucleo-144
12-
* @ingroup boards
13-
* @brief Support for STM32 Nucleo-144 boards
11+
* @ingroup boards_common_nucleo144
1412
* @{
1513
*
1614
* @file

‎boards/common/nucleo32/doc.md‎

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

‎boards/common/nucleo32/include/board.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
#pragma once
77

88
/**
9-
* @defgroup boards_common_nucleo32 STM32 Nucleo-32
10-
* @ingroup boards
11-
* @brief Support for STM32 Nucleo-32 boards
9+
* @ingroup boards_common_nucleo32
1210
* @{
1311
*
1412
* @file

‎boards/common/nucleo64/doc.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
@defgroup boards_common_nucleo64 STM32 Nucleo-64
2+
@ingroup boards
3+
@brief Support for STM32 Nucleo-64 Boards
4+
5+
## Using LED0 and SPI at once
6+
7+
Due to a pin conflict on Nucleo64 boards, you can not use
8+
the SPI peripheral and LED0 at the same time.
9+
A warning will be shown during compile time:
10+
```
11+
Warning: Using periph_spi on Nucleo64 boards will disable LED0 due to pin conflicts.
12+
```
13+
14+
## Flashing the Board
15+
16+
A detailed description about the flashing process can be found on the
17+
[guides page](https://guide.riot-os.org/board_specific/stm32/).
18+
19+
## Accessing the RIOT shell
20+
21+
The default RIOT OS shell access utilizes the ST-Link VCP (Virtual COM Port)
22+
that is featured on every Nucleo board. The USART used for this connection
23+
varies between the different Nucleo variants, so you have to consult the
24+
`nucleo-xxxxx/include/periph_conf.h` header file for more information.
25+
26+
The default baud rate is 115200, 8N1.

‎boards/common/nucleo64/include/board.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
#pragma once
77

88
/**
9-
* @defgroup boards_common_nucleo64 STM32 Nucleo-64
10-
* @ingroup boards
11-
* @brief Support for STM32 Nucleo-64 boards
9+
* @ingroup boards_common_nucleo64
1210
* @{
1311
*
1412
* @file

‎boards/nucleo-c031c6/doc.md‎

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
The Nucleo-C031C6 is a board from ST's Nucleo family supporting a ARM
88
Cortex-M0+ STM32C031C6 microcontroller with 12KiB of RAM and 32KiB of Flash.
99

10+
You can find general information about the Nucleo64 boards on the
11+
@ref boards_common_nucleo64 page.
12+
1013
## Pinout
1114

1215
@image html pinouts/nucleo-c031c6.svg "Pinout for the Nucleo-C031C6 (from STM user manual UM2953, https://www.st.com/resource/en/user_manual/um2953-stm32-nucleo64-board-mb1717-stmicroelectronics.pdf, page 19)" width=50%
@@ -33,17 +36,8 @@ Cortex-M0+ STM32C031C6 microcontroller with 12KiB of RAM and 32KiB of Flash.
3336
| Programming Manual | [Programming Manual](https://www.st.com/resource/en/programming_manual/pm0223-stm32-cortexm0-mcus-programming-manual-stmicroelectronics.pdf) |
3437
| Board Manual | [Board Manual](https://www.st.com/resource/en/user_manual/um2953-stm32-nucleo64-board-mb1717-stmicroelectronics.pdf) |
3538

36-
## Flashing the Board Using ST-LINK Removable Media
37-
38-
On-board ST-LINK programmer provides via composite USB device removable media.
39-
Copying the HEX file causes reprogramming of the board. This task
40-
could be performed manually; however, the cpy2remed (copy to removable
41-
media) PROGRAMMER script does this automatically. To program board in
42-
this manner, use the command:
43-
44-
```
45-
make BOARD=nucleo-c031c6 PROGRAMMER=cpy2remed flash
46-
```
39+
## Flashing the Board
4740

48-
@note This PROGRAMMER was tested using ST-LINK firmware 2.37.26. Firmware updates
49-
could be found on [this STM webpage](https://www.st.com/en/development-tools/stsw-link007.html).
41+
A detailed description about the flashing process can be found on the
42+
[guides page](https://guide.riot-os.org/board_specific/stm32/).
43+
The board name for the Nucleo-C031C6 is `nucleo-c031c6`.

‎boards/nucleo-c071rb/doc.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
The Nucleo-C071RB is a board from ST's Nucleo family supporting a ARM
88
Cortex-M0+ STM32C071RB microcontroller with 24KiB of RAM and 128KiB of Flash.
99

10+
You can find general information about the Nucleo64 boards on the
11+
@ref boards_common_nucleo64 page.
12+
1013
## Pinout
1114

1215
See Board Manual referenced below, section 7 pages 19-21.

‎boards/nucleo-f030r8/doc.md‎

Lines changed: 7 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
The Nucleo-F030R8 is a board from ST's Nucleo family supporting a ARM Cortex-M0
88
STM32F030R8 microcontroller with 8KiB of RAM and 64KiB of Flash.
99

10+
You can find general information about the Nucleo64 boards on the
11+
@ref boards_common_nucleo64 page.
12+
1013
## Hardware
1114

1215
![Nucleo64 F030R8](http://www.open-electronics.org/wp-content/uploads/2015/08/Figura2-500x467.png)
@@ -52,37 +55,8 @@ STM32F030R8 microcontroller with 8KiB of RAM and 64KiB of Flash.
5255
| | Timer | 3 16 bit timers | |
5356

5457

55-
## Flashing the device
56-
57-
### Flashing the Board Using OpenOCD
58-
59-
The ST Nucleo-F030R8 board includes an on-board ST-LINK V2 programmer. The
60-
easiest way to program the board is to use OpenOCD. Once you have installed
61-
OpenOCD (look [here](https://github.com/RIOT-OS/RIOT/wiki/OpenOCD) for
62-
installation instructions), you can flash the board simply by typing
63-
64-
```
65-
make BOARD=nucleo-f030r8 flash
66-
```
67-
and debug via GDB by simply typing
68-
```
69-
make BOARD=nucleo-f030r8 debug
70-
```
71-
72-
### Flashing the Board Using ST-LINK Removable Media
73-
74-
On-board ST-LINK programmer provides via composite USB device removable media.
75-
Copying the HEX file causes reprogramming of the board. This task
76-
could be performed manually; however, the cpy2remed (copy to removable
77-
media) PROGRAMMER script does this automatically. To program board in
78-
this manner, use the command:
79-
```
80-
make BOARD=nucleo-f030r8 PROGRAMMER=cpy2remed flash
81-
```
82-
@note This PROGRAMMER was tested using ST-LINK firmware 2.37.26. Firmware updates
83-
could be found on [this STM webpage](https://www.st.com/en/development-tools/stsw-link007.html).
58+
## Flashing the Board
8459

85-
## Supported Toolchains
86-
For using the ST Nucleo-F030R8 board we strongly recommend the usage of the
87-
[GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded)
88-
toolchain.
60+
A detailed description about the flashing process can be found on the
61+
[guides page](https://guide.riot-os.org/board_specific/stm32/).
62+
The board name for the Nucleo-F030R8 is `nucleo-f030r8`.

‎boards/nucleo-f031k6/doc.md‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
The Nucleo-F031K6 is a board from ST's Nucleo family supporting ARM Cortex-M0
88
STM32F031K6 microcontroller with 4KiB of RAM and 32KiB of Flash.
99

10+
You can find general information about the Nucleo32 boards on the
11+
@ref boards_common_nucleo32 page.
12+
1013
## Pinout
1114

1215
@image html pinouts/nucleo-f031k6-and-more.svg "Pinout for the Nucleo-F031K6 (from ST User Manual, UM1956, https://www.st.com/resource/en/user_manual/um1956-stm32-nucleo32-boards-mb1180-stmicroelectronics.pdf, page 31)" width=25%
@@ -34,15 +37,8 @@ STM32F031K6 microcontroller with 4KiB of RAM and 32KiB of Flash.
3437
| Programming Manual | [Programming Manual](https://www.st.com/resource/en/programming_manual/pm0215-stm32f0-series-cortexm0-programming-manual-stmicroelectronics.pdf) |
3538
| Board Manual | [Board Manual](https://www.st.com/resource/en/user_manual/um1956-stm32-nucleo32-boards-mb1180-stmicroelectronics.pdf) |
3639

37-
## Flashing the Board Using ST-LINK Removable Media
38-
39-
On-board ST-LINK programmer provides via composite USB device removable media.
40-
Copying the HEX file causes reprogramming of the board. This task
41-
could be performed manually; however, the cpy2remed (copy to removable
42-
media) PROGRAMMER script does this automatically. To program board in
43-
this manner, use the command:
44-
```
45-
make BOARD=nucleo-f031k6 PROGRAMMER=cpy2remed flash
46-
```
47-
@note This PROGRAMMER was tested using ST-LINK firmware 2.37.26. Firmware updates
48-
can be found on [this STM webpage](https://www.st.com/en/development-tools/stsw-link007.html).
40+
## Flashing the Board
41+
42+
A detailed description about the flashing process can be found on the
43+
[guides page](https://guide.riot-os.org/board_specific/stm32/).
44+
The board name for the Nucleo-F031K6 is `nucleo-f031k6`.

0 commit comments

Comments
 (0)