Skip to content

Commit f37b0c4

Browse files
authored
Merge pull request #14905 from jeromecoutant/PR_STM32CUSTOM
STM32 : README updates about custom boards
2 parents 46b411d + 2bdd68f commit f37b0c4

File tree

2 files changed

+53
-3
lines changed

2 files changed

+53
-3
lines changed

targets/TARGET_STM/README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
Table of Contents
44
=================
55

6-
* [README for Mbed OS STM32 targets](#readme-for-mbed-os-stm32-targets)
76
* [ST TOOLS](#st-tools)
87
* [USB drivers](#usb-drivers)
98
* [ST-Link FW](#st-link-fw)
@@ -19,16 +18,19 @@ Table of Contents
1918
* [Add a custom board](#add-a-custom-board)
2019
* [Board specific files (pinmap)](#board-specific-files-pinmap)
2120
* [Use of custom_targets.json](#use-of-custom_targetsjson)
21+
* [Make your custom board public](#make-you-custom-board-public)
2222
* [ST specific implementation](#st-specific-implementation)
2323
* [Pin configuration](#pin-configuration)
2424
* [Alternate feature](#alternate-feature)
2525
* [Conflict pins](#conflict-pins)
2626
* [Clock selection](#clock-selection)
2727
* [System clock](#system-clock)
2828
* [Low power clock](#low-power-clock)
29+
* [I2C Timing calculation algorithm](#i2c-timing-calculation-algorithm)
2930
* [Sleep feature](#sleep-feature)
3031
* [WiFi configuration](#wifi-configuration)
3132
* [Ethernet configuration](#ethernet-configuration)
33+
* [Asynchronous SPI limitation](#asynchronous-spi-limitation)
3234
* [Mbed OS Wiki pages](#mbed-os-wiki-pages)
3335

3436

@@ -65,6 +67,14 @@ $ mbedls
6567
| DISCO_L475VG_IOT01A | DISCO_L475VG_IOT01A[0] | E: | COM9 | 07640221683B630A577FF553 | V2J37M26 |
6668
```
6769

70+
```
71+
$ mbedtools detect
72+
Board name Serial number Serial port Mount point(s) Build target(s) Interface Version
73+
--------------- ------------------------ ------------- ---------------- ----------------- -------------------
74+
NUCLEO-U575ZI-Q 0022003c5553500d20393256 COM25 D: NUCLEO_U575ZI_Q V3J7M3
75+
```
76+
77+
6878
### STM32 Cube
6979

7080
https://www.st.com/en/embedded-software/stm32cube-mcu-packages.html
@@ -150,6 +160,9 @@ Tool is not used in Mbed OS, but it can be useful for you.
150160

151161
It should be "easy" to add your custom board with a STM32 MCU in Mbed OS
152162

163+
You can also check in https://github.com/ARMmbed/stm32customtargets
164+
165+
153166
### STM32 organisation
154167

155168
STM32 root directory is https://github.com/ARMmbed/mbed-os/tree/master/targets/TARGET_STM
@@ -259,7 +272,7 @@ STM32_open_pin_data DB version STM32CubeMX-DB.6.0.10
259272

260273
### Use of custom_targets.json
261274

262-
https://os.mbed.com/docs/mbed-os/v6.0/porting/porting-a-custom-board.html
275+
https://os.mbed.com/docs/mbed-os/latest/porting/porting-a-custom-board.html
263276

264277
Example with a board based on STM32F103C8 (like BluePill):
265278
- MCU_STM32F103x8 generic configuration is already available in targets.json file
@@ -321,6 +334,13 @@ $ mv TARGET_STM32H745ZIT TARGET_H745ZI_BOARD
321334
```
322335

323336

337+
### Make your custom board public
338+
339+
We will be happy to add every public board in https://github.com/ARMmbed/stm32customtargets
340+
341+
Make a Pull request, we will check consistency and build.
342+
343+
324344
## ST specific implementation
325345

326346
### Pin configuration
@@ -408,7 +428,7 @@ You can change this in you local mbed_app.json:
408428
}
409429
```
410430

411-
#### I2C TIming calculation algorothm
431+
#### I2C Timing calculation algorithm
412432

413433
I2C drivers version 2 use I2C timing register.
414434

targets/TARGET_STM/TARGET_STM32WL/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@ This ST MCU family is dual-core : based on an Arm Cortex-M4 core and an Arm Cort
66

77
Only M4 core is currently used by mbed-os applications.
88

9+
* [Supported boards](#supported-boards)
10+
* [NUCLEO_WL55JC](#nucleo_wl55jc)
11+
* [CUSTOM boards](#custom-boards)
12+
* [LoRa](#lora)
13+
* [MBED-OS support](#mbed-os-support)
14+
* [baremetal support](#baremetal-support)
15+
* [Antenna configuration](#antenna-configuration)
16+
* [GPIO debug pins](#gpio-debug-pins)
17+
* [mbed-os test](#mbed-os-test)
18+
* [Application example](#application-example)
19+
20+
921
# Supported boards
1022

1123
## NUCLEO_WL55JC
@@ -19,6 +31,12 @@ Only M4 core is currently used by mbed-os applications.
1931
- Total FLASH is 256KB
2032
- RAM: 64 KB
2133

34+
35+
## CUSTOM boards
36+
37+
Check https://github.com/ARMmbed/stm32customtargets
38+
39+
2240
# LoRa
2341

2442
## MBED-OS support
@@ -37,6 +55,18 @@ mbed_app.json:
3755
```
3856

3957

58+
## Antenna configuration
59+
60+
NUCLEO HW configuration is provided as the default configuration.
61+
62+
https://github.com/ARMmbed/mbed-os/blob/master/connectivity/drivers/lora/TARGET_STM32WL/STM32WL_radio_driver.cpp#L23
63+
```
64+
MBED_WEAK void set_antenna_switch(RBI_Switch_TypeDef state)
65+
```
66+
67+
So you can overwrite it for your custom board.
68+
69+
4070
## GPIO debug pins
4171

4272
2 pins can be configured to check RX and TX activity.

0 commit comments

Comments
 (0)