diff --git a/boards/stm32f030f4-demo/doc.txt b/boards/stm32f030f4-demo/doc.md similarity index 99% rename from boards/stm32f030f4-demo/doc.txt rename to boards/stm32f030f4-demo/doc.md index 24cd04710d..26e0999a64 100644 --- a/boards/stm32f030f4-demo/doc.txt +++ b/boards/stm32f030f4-demo/doc.md @@ -1,4 +1,3 @@ -/** @defgroup boards_stm32f030f4-demo STM32F030F4 Demo Board @ingroup boards @brief Support for the STM32F030F4 Demo Board @@ -50,5 +49,3 @@ and debug via GDB by simply typing ``` make BOARD=stm32f030f4-demo debug ``` - - */ diff --git a/boards/stm32f0discovery/doc.md b/boards/stm32f0discovery/doc.md new file mode 100644 index 0000000000..938adfca6e --- /dev/null +++ b/boards/stm32f0discovery/doc.md @@ -0,0 +1,8 @@ +@defgroup boards_stm32f0discovery STM32F0Discovery +@ingroup boards +@brief Support for the STM32F0Discovery board + +## Overview + +The STM32F0Discovery is a board from ST's Discovery family supporting +ARM Cortex-M0 STM32F051 microcontroller with 8KiB of RAM and 64KiB of Flash. diff --git a/boards/stm32f0discovery/doc.txt b/boards/stm32f0discovery/doc.txt deleted file mode 100644 index 540451ac91..0000000000 --- a/boards/stm32f0discovery/doc.txt +++ /dev/null @@ -1,5 +0,0 @@ -/** -@defgroup boards_stm32f0discovery STM32F0Discovery -@ingroup boards -@brief Support for the STM32F0Discovery board - */ diff --git a/boards/stm32f3discovery/doc.txt b/boards/stm32f3discovery/doc.md similarity index 99% rename from boards/stm32f3discovery/doc.txt rename to boards/stm32f3discovery/doc.md index fe9d405104..e1c4d723a7 100644 --- a/boards/stm32f3discovery/doc.txt +++ b/boards/stm32f3discovery/doc.md @@ -1,4 +1,3 @@ -/** @defgroup boards_stm32f3discovery STM32F3Discovery @ingroup boards @brief Support for the STM32F3Discovery board @@ -158,4 +157,3 @@ toolchain. - **PA10** is connected with **TX** on the UART converter - **PA9** is connected with **RX** on the UART converter 2. done - */ diff --git a/boards/stm32f429i-disc1/doc.md b/boards/stm32f429i-disc1/doc.md new file mode 100644 index 0000000000..40929b1066 --- /dev/null +++ b/boards/stm32f429i-disc1/doc.md @@ -0,0 +1,10 @@ +@defgroup boards_stm32f429i-disc1 STM32F429I-DISC1 +@ingroup boards +@brief Support for the STM32F429I-DISC1 board + +## Overview + +The STM32F429I-DISC1 is a board from ST's Discovery family supporting ARM +Cortex-M4 STM32F429ZI microcontroller with 256KiB of RAM and 2MiB of Flash. + +This board is a replacement for older STM32F429I-DISCO board. diff --git a/boards/stm32f429i-disc1/doc.txt b/boards/stm32f429i-disc1/doc.txt deleted file mode 100644 index 5c6107a373..0000000000 --- a/boards/stm32f429i-disc1/doc.txt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * @defgroup boards_stm32f429i-disc1 STM32F429I-DISC1 - * @ingroup boards - * @brief Support for the STM32F429I-DISC1 board - */ \ No newline at end of file diff --git a/boards/stm32f429i-disco/doc.txt b/boards/stm32f429i-disco/doc.md similarity index 67% rename from boards/stm32f429i-disco/doc.txt rename to boards/stm32f429i-disco/doc.md index 060e7b4235..0543c3f3bc 100644 --- a/boards/stm32f429i-disco/doc.txt +++ b/boards/stm32f429i-disco/doc.md @@ -1,8 +1,6 @@ -/** - * @defgroup boards_stm32f429i-disco STM32F429I-DISCO - * @ingroup boards - * @brief Support for the STM32F429I-DISCO board - */ +@defgroup boards_stm32f429i-disco STM32F429I-DISCO +@ingroup boards +@brief Support for the STM32F429I-DISCO board ### General information diff --git a/boards/stm32f4discovery/doc.txt b/boards/stm32f4discovery/doc.md similarity index 99% rename from boards/stm32f4discovery/doc.txt rename to boards/stm32f4discovery/doc.md index 5ba330f61f..273bcdec1c 100644 --- a/boards/stm32f4discovery/doc.txt +++ b/boards/stm32f4discovery/doc.md @@ -1,4 +1,3 @@ -/** @defgroup boards_stm32f4discovery STM32F4Discovery @ingroup boards @brief Support for the STM32F4Discovery board @@ -260,5 +259,4 @@ is a good value to start with. ### macOS & make term If you want the terminal to work using `make term` command and get a message about missing tty device install the driver from -https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers . - */ +https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers . \ No newline at end of file diff --git a/boards/stm32f723e-disco/doc.txt b/boards/stm32f723e-disco/doc.md similarity index 99% rename from boards/stm32f723e-disco/doc.txt rename to boards/stm32f723e-disco/doc.md index bc5a163429..abf9948898 100644 --- a/boards/stm32f723e-disco/doc.txt +++ b/boards/stm32f723e-disco/doc.md @@ -1,4 +1,3 @@ -/** @defgroup boards_stm32f723e-disco STM32F723E-DISCO board @ingroup boards @brief Support for the STM32F723E-DISCO board @@ -34,4 +33,3 @@ By default, the USB OTG FS port is used. To use the USB OTG HS port with the internal UTMI+ HS PHY, enable the module `periph_usbdev_hs_utmi`: make BOARD=stm32f723e-disco USEMODULE=periph_usbdev_hs_utmi -C examples/advanced/usbus_minimal - */ diff --git a/boards/stm32f746g-disco/doc.txt b/boards/stm32f746g-disco/doc.md similarity index 91% rename from boards/stm32f746g-disco/doc.txt rename to boards/stm32f746g-disco/doc.md index b984be636c..1d09f33b81 100644 --- a/boards/stm32f746g-disco/doc.txt +++ b/boards/stm32f746g-disco/doc.md @@ -1,7 +1,6 @@ -/** - * @defgroup boards_stm32f746g-disco STM32F746G-DISCO - * @ingroup boards - * @brief Support for the STM32F746G-DISCO board. +@defgroup boards_stm32f746g-disco STM32F746G-DISCO +@ingroup boards +@brief Support for the STM32F746G-DISCO board. ## Overview @@ -54,5 +53,3 @@ make BOARD=stm32f746g-disco debug For using the STM32F746G-DISCO board we recommend the usage of the [GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded) toolchain. - - */ diff --git a/boards/stm32f7508-dk/doc.txt b/boards/stm32f7508-dk/doc.md similarity index 91% rename from boards/stm32f7508-dk/doc.txt rename to boards/stm32f7508-dk/doc.md index aceaece7c2..e56bd6311c 100644 --- a/boards/stm32f7508-dk/doc.txt +++ b/boards/stm32f7508-dk/doc.md @@ -1,7 +1,6 @@ -/** - * @defgroup boards_stm32f750n8-dk STM32F750N8-DK - * @ingroup boards - * @brief Support for the STM32F750N8-DK board. +@defgroup boards_stm32f750n8-dk STM32F750N8-DK +@ingroup boards +@brief Support for the STM32F750N8-DK board. ## Overview @@ -56,5 +55,3 @@ make BOARD=stm32f750n8-dk debug For using the STM32F750N8-DK board we recommend the usage of the [GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded) toolchain. - - */ diff --git a/boards/stm32f769i-disco/doc.md b/boards/stm32f769i-disco/doc.md new file mode 100644 index 0000000000..56584336ee --- /dev/null +++ b/boards/stm32f769i-disco/doc.md @@ -0,0 +1,8 @@ +@defgroup boards_stm32f769i-disco STM32F769I-DISCO board +@ingroup boards +@brief Support for the STM32F769I-DISCO board + +## Overview + +The STM32F769I-DISCO is a board from ST's Discovery family supporting ARM +Cortex-M7 STM32F769NI microcontroller with 532KiB of RAM and 2MiB of Flash. diff --git a/boards/stm32f769i-disco/doc.txt b/boards/stm32f769i-disco/doc.txt deleted file mode 100644 index 5f2b304510..0000000000 --- a/boards/stm32f769i-disco/doc.txt +++ /dev/null @@ -1,5 +0,0 @@ -/** -@defgroup boards_stm32f769i-disco STM32F769I-DISCO board -@ingroup boards -@brief Support for the STM32F769I-DISCO board - */ diff --git a/boards/stm32g0316-disco/doc.md b/boards/stm32g0316-disco/doc.md new file mode 100644 index 0000000000..185880dfbc --- /dev/null +++ b/boards/stm32g0316-disco/doc.md @@ -0,0 +1,32 @@ +@defgroup boards_stm32g0316-disco STM32G0316-DISCO +@ingroup boards +@brief Support for the STM32G0316-DISCO board. + +### General information + +The ST [STM32G0316-DISCO](https://www.st.com/en/evaluation-tools/stm32g0316-disco.html) +is an evaluation board supporting a ARM Cortex-M0 STM32G031J6 microcontroller +with 8KB of RAM and 32KB of ROM Flash. + +### Pinout + +In an SO8 package, this MCU uses multi-bonding to run multiple ports to the same pins. +See [this application note as reference](https://www.st.com/resource/en/application_note/dm00443870-getting-started-with-stm32g0-series-hardware-development-stmicroelectronics.pdf). +This means the responsibility is on the firmware configurer to take special care when configured IO, ensuring that +ports are not conflicting on each pin. + +### Flash the board + +The STM32G0316-DISCO board includes an on-board ST-LINK programmer and can be +flashed using OpenOCD. + +To flash this board, just use the following command: +``` + make BOARD=stm32g0316-disco flash -C examples/basic/hello-world + ``` +### UART Terminal Interaction + +Due to the limited number of pins, to get stdio UART traffic, use a USB->UART adapter +like the CP2104 from Adafruit (http://adafru.it/954). Connect the adapter's TX line +to the MCU RX pin (PB6, Pin 8) and the adapter's RX line to the MCU's TX pin - +(PB7, pin 1). diff --git a/boards/stm32g0316-disco/doc.txt b/boards/stm32g0316-disco/doc.txt deleted file mode 100644 index 85bf4891fd..0000000000 --- a/boards/stm32g0316-disco/doc.txt +++ /dev/null @@ -1,36 +0,0 @@ -/** - * @defgroup boards_stm32g0316-disco STM32G0316-DISCO - * @ingroup boards - * @brief Support for the STM32G0316-DISCO board. - * - * ### General information - * - * The ST [STM32G0316-DISCO](https://www.st.com/en/evaluation-tools/stm32g0316-disco.html) - * is an evaluation board supporting a ARM Cortex-M0 STM32G031J6 microcontroller - * with 8KB of RAM and 32KB of ROM Flash. - * - * ### Pinout - * - * In an SO8 package, this MCU uses multi-bonding to run multiple ports to the same pins. - * See [this application note as reference](https://www.st.com/resource/en/application_note/dm00443870-getting-started-with-stm32g0-series-hardware-development-stmicroelectronics.pdf). - * This means the responsibility is on the firmware configurer to take special care when configured IO, ensuring that - * ports are not conflicting on each pin. - * - * ### Flash the board - * - * The STM32G0316-DISCO board includes an on-board ST-LINK programmer and can be - * flashed using OpenOCD. - * - * To flash this board, just use the following command: - * - * ``` - * make BOARD=stm32g0316-disco flash -C examples/basic/hello-world - * ``` - * - * ### UART Terminal Interaction - * - * Due to the limited number of pins, to get stdio UART traffic, use a USB->UART adapter - * like the CP2104 from Adafruit (http://adafru.it/954). Connect the adapter's TX line - * to the MCU RX pin (PB6, Pin 8) and the adapter's RX line to the MCU's TX pin - - * (PB7, pin 1) - */ diff --git a/boards/stm32l0538-disco/doc.txt b/boards/stm32l0538-disco/doc.md similarity index 96% rename from boards/stm32l0538-disco/doc.txt rename to boards/stm32l0538-disco/doc.md index c5ac26751b..a4e4b28c68 100644 --- a/boards/stm32l0538-disco/doc.txt +++ b/boards/stm32l0538-disco/doc.md @@ -1,7 +1,6 @@ -/** - * @defgroup boards_stm32l0538-disco STM32L0538-DISCO - * @ingroup boards - * @brief Support for the STM32L0538-DISCO board +@defgroup boards_stm32l0538-disco STM32L0538-DISCO +@ingroup boards +@brief Support for the STM32L0538-DISCO board ### Introduction @@ -76,5 +75,3 @@ required. Use the `term` target to open a terminal: If an external ST-Link adapter is used, RX and TX pins can be directly connected to it. In this case, STDIO is available on /dev/ttyACMx (Linux case). - - */ diff --git a/boards/stm32l476g-disco/doc.txt b/boards/stm32l476g-disco/doc.md similarity index 94% rename from boards/stm32l476g-disco/doc.txt rename to boards/stm32l476g-disco/doc.md index e608ef3e7b..3d4d771f7b 100644 --- a/boards/stm32l476g-disco/doc.txt +++ b/boards/stm32l476g-disco/doc.md @@ -1,7 +1,6 @@ -/** - * @defgroup boards_stm32l476g-disco STM32L476G-DISCO - * @ingroup boards - * @brief Support for the STM32L476G-DISCO board. +@defgroup boards_stm32l476g-disco STM32L476G-DISCO +@ingroup boards +@brief Support for the STM32L476G-DISCO board. ## Overview @@ -60,5 +59,3 @@ provided by integrated ST-LINK programmer. ST-LINK is connected to the microcontroller USART2. The default baud rate is 115200. - - */ diff --git a/boards/stm32mp157c-dk2/doc.txt b/boards/stm32mp157c-dk2/doc.md similarity index 99% rename from boards/stm32mp157c-dk2/doc.txt rename to boards/stm32mp157c-dk2/doc.md index 0cddcf204e..c19a93799d 100644 --- a/boards/stm32mp157c-dk2/doc.txt +++ b/boards/stm32mp157c-dk2/doc.md @@ -1,4 +1,3 @@ -/** @defgroup boards_stm32mp157c-dk2 STM32MP157C-DK2 board @ingroup boards @brief Support for the STM32MP157C-DK2 board @@ -101,4 +100,3 @@ echo stop > /sys/class/remoteproc/remoteproc0/state For using the STM32MP157C-DK2 board we strongly recommend the usage of the [GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded) toolchain. - */