Skip to content

Commit add481d

Browse files
committed
codegen: Describe how 'gpio-' features are generated
1 parent 4e9236d commit add481d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

codegen/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@ from the respective GPIO internal peripheral (IP) version:
4343
- gpio-f333
4444
- gpio-f373
4545

46+
`codegen` collects those IP versions from the relevant GPIO IP description
47+
files (located at `$cubemx_db_path/mcu/IP/GPIO-*.xml`). The root `<IP>` element
48+
has a `Version` attribute with a value in the form of "STM32Fxxx_gpio_v1_0".
49+
The feature name is constructed by dropping the parts constant between all
50+
version strings and prepending "gpio-".
51+
4652
Note that the GPIO IP version names don't necessarily match the MCUs they are
4753
used in. For example, the GPIOs in `STM32F302xB` MCUs have the IP version
4854
"STM32F303_gpio_v1_0". The MCU features of the `stm32f3xx-hal` also select the

0 commit comments

Comments
 (0)