Skip to content

Commit 234e01c

Browse files
kartbenfabiobaltieri
kartben
authored and
fabiobaltieri
committed
doc: weact: adopt zephyr:board-supported-hw directive
Replace manually authored hardware features table with the new Zephyr board supported hardware directive which automatically generates an up-to-date table based on the boards' Devicetree. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 6715d46 commit 234e01c

File tree

9 files changed

+9
-253
lines changed

9 files changed

+9
-253
lines changed

‎boards/weact/blackpill_f401cc/doc/index.rst‎

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -37,35 +37,7 @@ hardware components:
3737
Supported Features
3838
==================
3939

40-
The Zephyr blackpill_f401cc board configuration supports the following
41-
hardware features:
42-
43-
+------------+------------+-------------------------------------+
44-
| Interface | Controller | Driver/Component |
45-
+============+============+=====================================+
46-
| NVIC | on-chip | nested vector interrupt controller |
47-
+------------+------------+-------------------------------------+
48-
| SYSTICK | on-chip | system clock |
49-
+------------+------------+-------------------------------------+
50-
| UART | on-chip | serial port |
51-
+------------+------------+-------------------------------------+
52-
| GPIO | on-chip | gpio |
53-
+------------+------------+-------------------------------------+
54-
| PINMUX | on-chip | pinmux |
55-
+------------+------------+-------------------------------------+
56-
| FLASH | on-chip | flash |
57-
+------------+------------+-------------------------------------+
58-
| SPI | on-chip | spi |
59-
+------------+------------+-------------------------------------+
60-
| I2C | on-chip | i2c |
61-
+------------+------------+-------------------------------------+
62-
| ADC | on-chip | ADC Controller |
63-
+------------+------------+-------------------------------------+
64-
| USB OTG FS | on-chip | USB device |
65-
+------------+------------+-------------------------------------+
66-
67-
The default configuration can be found in
68-
:zephyr_file:`boards/weact/blackpill_f401cc/blackpill_f401cc_defconfig`
40+
.. zephyr:board-supported-hw::
6941
7042
Pin Mapping
7143
===========

‎boards/weact/blackpill_f401ce/doc/index.rst‎

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -37,35 +37,7 @@ hardware components:
3737
Supported Features
3838
==================
3939

40-
The Zephyr blackpill_f401ce board configuration supports the following
41-
hardware features:
42-
43-
+------------+------------+-------------------------------------+
44-
| Interface | Controller | Driver/Component |
45-
+============+============+=====================================+
46-
| NVIC | on-chip | nested vector interrupt controller |
47-
+------------+------------+-------------------------------------+
48-
| SYSTICK | on-chip | system clock |
49-
+------------+------------+-------------------------------------+
50-
| UART | on-chip | serial port |
51-
+------------+------------+-------------------------------------+
52-
| GPIO | on-chip | gpio |
53-
+------------+------------+-------------------------------------+
54-
| PINMUX | on-chip | pinmux |
55-
+------------+------------+-------------------------------------+
56-
| FLASH | on-chip | flash |
57-
+------------+------------+-------------------------------------+
58-
| SPI | on-chip | spi |
59-
+------------+------------+-------------------------------------+
60-
| I2C | on-chip | i2c |
61-
+------------+------------+-------------------------------------+
62-
| ADC | on-chip | ADC Controller |
63-
+------------+------------+-------------------------------------+
64-
| USB OTG FS | on-chip | USB device |
65-
+------------+------------+-------------------------------------+
66-
67-
The default configuration can be found in
68-
:zephyr_file:`boards/weact/blackpill_f401ce/blackpill_f401ce_defconfig`
40+
.. zephyr:board-supported-hw::
6941
7042
Pin Mapping
7143
===========

‎boards/weact/blackpill_f411ce/doc/index.rst‎

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -37,35 +37,7 @@ hardware components:
3737
Supported Features
3838
==================
3939

40-
The Zephyr blackpill_f411ce board configuration supports the following
41-
hardware features:
42-
43-
+------------+------------+-------------------------------------+
44-
| Interface | Controller | Driver/Component |
45-
+============+============+=====================================+
46-
| NVIC | on-chip | nested vector interrupt controller |
47-
+------------+------------+-------------------------------------+
48-
| SYSTICK | on-chip | system clock |
49-
+------------+------------+-------------------------------------+
50-
| UART | on-chip | serial port |
51-
+------------+------------+-------------------------------------+
52-
| GPIO | on-chip | gpio |
53-
+------------+------------+-------------------------------------+
54-
| PINMUX | on-chip | pinmux |
55-
+------------+------------+-------------------------------------+
56-
| FLASH | on-chip | flash |
57-
+------------+------------+-------------------------------------+
58-
| SPI | on-chip | spi |
59-
+------------+------------+-------------------------------------+
60-
| I2C | on-chip | i2c |
61-
+------------+------------+-------------------------------------+
62-
| ADC | on-chip | ADC Controller |
63-
+------------+------------+-------------------------------------+
64-
| USB OTG FS | on-chip | USB device |
65-
+------------+------------+-------------------------------------+
66-
67-
The default configuration can be found in
68-
:zephyr_file:`boards/weact/blackpill_f411ce/blackpill_f411ce_defconfig`
40+
.. zephyr:board-supported-hw::
6941
7042
Pin Mapping
7143
===========

‎boards/weact/mini_stm32h743/doc/index.rst‎

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -71,34 +71,7 @@ More information about STM32H743 can be found here:
7171
Supported Features
7272
==================
7373

74-
The mini_stm32h743 board configuration supports the following hardware features:
75-
76-
+-----------+------------+-------------------------------------+
77-
| Interface | Controller | Driver/Component |
78-
+===========+============+=====================================+
79-
| NVIC | on-chip | nested vector interrupt controller |
80-
+-----------+------------+-------------------------------------+
81-
| WDT | on-chip | watchdog |
82-
+-----------+------------+-------------------------------------+
83-
| PINMUX | on-chip | pinmux |
84-
+-----------+------------+-------------------------------------+
85-
| FLASH | on-chip | flash memory |
86-
+-----------+------------+-------------------------------------+
87-
| GPIO | on-chip | gpio |
88-
+-----------+------------+-------------------------------------+
89-
| SPI | on-chip | spi |
90-
+-----------+------------+-------------------------------------+
91-
| QSPI NOR | on-chip | off-chip flash |
92-
+-----------+------------+-------------------------------------+
93-
| SDMMC | on-chip | disk access |
94-
+-----------+------------+-------------------------------------+
95-
| DISPLAY | on-chip | display |
96-
+-----------+------------+-------------------------------------+
97-
98-
Other hardware features have not been enabled yet for this board.
99-
100-
The default configuration per core can be found in the defconfig file:
101-
``boards/weact/mini_stm32h743/mini_stm32h743_defconfig``
74+
.. zephyr:board-supported-hw::
10275
10376
Pin Mapping
10477
===========

‎boards/weact/mini_stm32h7b0/doc/index.rst‎

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -72,34 +72,7 @@ More information about STM32H7BO can be found here:
7272
Supported Features
7373
==================
7474

75-
The ``mini_stm32h7b0`` board target supports the following hardware features:
76-
77-
+-----------+------------+-------------------------------------+
78-
| Interface | Controller | Driver/Component |
79-
+===========+============+=====================================+
80-
| NVIC | on-chip | nested vector interrupt controller |
81-
+-----------+------------+-------------------------------------+
82-
| WDT | on-chip | watchdog |
83-
+-----------+------------+-------------------------------------+
84-
| PINMUX | on-chip | pinmux |
85-
+-----------+------------+-------------------------------------+
86-
| FLASH | on-chip | flash memory |
87-
+-----------+------------+-------------------------------------+
88-
| GPIO | on-chip | gpio |
89-
+-----------+------------+-------------------------------------+
90-
| SPI | on-chip | spi |
91-
+-----------+------------+-------------------------------------+
92-
| QSPI NOR | on-chip | off-chip flash |
93-
+-----------+------------+-------------------------------------+
94-
| SDMMC | on-chip | disk access |
95-
+-----------+------------+-------------------------------------+
96-
| DISPLAY | on-chip | display |
97-
+-----------+------------+-------------------------------------+
98-
99-
Other hardware features have not been enabled yet for this board.
100-
101-
The default configuration per core can be found in the defconfig file:
102-
:zephyr_file:`boards/weact/mini_stm32h7b0/mini_stm32h7b0_defconfig`
75+
.. zephyr:board-supported-hw::
10376
10477
Pin Mapping
10578
===========

‎boards/weact/stm32f405_core/doc/index.rst‎

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -45,35 +45,7 @@ hardware components:
4545
Supported Features
4646
==================
4747

48-
The Zephyr weact_stm32f405_core board configuration supports the following
49-
hardware features:
50-
51-
+------------+------------+-------------------------------------+
52-
| Interface | Controller | Driver/Component |
53-
+============+============+=====================================+
54-
| NVIC | on-chip | nested vector interrupt controller |
55-
+------------+------------+-------------------------------------+
56-
| SYSTICK | on-chip | system clock |
57-
+------------+------------+-------------------------------------+
58-
| UART | on-chip | serial port |
59-
+------------+------------+-------------------------------------+
60-
| GPIO | on-chip | gpio |
61-
+------------+------------+-------------------------------------+
62-
| PINMUX | on-chip | pinmux |
63-
+------------+------------+-------------------------------------+
64-
| FLASH | on-chip | flash |
65-
+------------+------------+-------------------------------------+
66-
| SPI | on-chip | spi |
67-
+------------+------------+-------------------------------------+
68-
| I2C | on-chip | i2c |
69-
+------------+------------+-------------------------------------+
70-
| ADC | on-chip | ADC Controller |
71-
+------------+------------+-------------------------------------+
72-
| USB OTG FS | on-chip | USB device |
73-
+------------+------------+-------------------------------------+
74-
75-
The default configuration can be found in
76-
:zephyr_file:`boards/weact/stm32f405_core/weact_stm32f405_core_defconfig`
48+
.. zephyr:board-supported-hw::
7749
7850
Pin Mapping
7951
===========

‎boards/weact/stm32g431_core/doc/index.rst‎

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,7 @@ considered reserved for USB-C and not available for other applications.
2828
Supported Features
2929
==================
3030

31-
The Zephyr weact_stm32g431_core board configuration supports the following hardware
32-
features:
33-
34-
+------------+------------+-------------------------------------+
35-
| Interface | Controller | Driver/Component |
36-
+============+============+=====================================+
37-
| NVIC | on-chip | nested vector interrupt controller |
38-
+------------+------------+-------------------------------------+
39-
| UART | on-chip | serial port |
40-
+------------+------------+-------------------------------------+
41-
| GPIO | on-chip | gpio |
42-
+------------+------------+-------------------------------------+
43-
| ADC | on-chip | ADC Controller |
44-
+------------+------------+-------------------------------------+
45-
| USB | on-chip | USB device |
46-
+------------+------------+-------------------------------------+
47-
| UCPD | on-chip | ucpd |
48-
+------------+------------+-------------------------------------+
49-
50-
The default configuration can be found in the defconfig file:
51-
52-
:zephyr_file:`boards/weact/stm32g431_core/weact_stm32g431_core_defconfig`
31+
.. zephyr:board-supported-hw::
5332
5433
Pin Mapping
5534
===========

‎boards/weact/stm32h5_core/doc/index.rst‎

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -69,43 +69,7 @@ More information about STM32H562RG can be found here:
6969
Supported Features
7070
==================
7171

72-
The Zephyr ``weact_stm32h5_core`` board supports the following hardware features:
73-
74-
+-----------+------------+-------------------------------------+
75-
| Interface | Controller | Driver/Component |
76-
+===========+============+=====================================+
77-
| CAN/CANFD | on-chip | CAN |
78-
+-----------+------------+-------------------------------------+
79-
| CLOCK | on-chip | reset and clock control |
80-
+-----------+------------+-------------------------------------+
81-
| GPIO | on-chip | gpio |
82-
+-----------+------------+-------------------------------------+
83-
| NVIC | on-chip | nested vector interrupt controller |
84-
+-----------+------------+-------------------------------------+
85-
| PINMUX | on-chip | pinmux |
86-
+-----------+------------+-------------------------------------+
87-
| RNG | on-chip | True Random number generator |
88-
+-----------+------------+-------------------------------------+
89-
| RTC | on-chip | Real Time Clock |
90-
+-----------+------------+-------------------------------------+
91-
| SPI | on-chip | spi bus |
92-
+-----------+------------+-------------------------------------+
93-
| I2C | on-chip | i2c bus |
94-
+-----------+------------+-------------------------------------+
95-
| UART | on-chip | serial port-polling; |
96-
| | | serial port-interrupt |
97-
+-----------+------------+-------------------------------------+
98-
| WATCHDOG | on-chip | independent watchdog |
99-
+-----------+------------+-------------------------------------+
100-
| USB | on-chip | USB full-speed host/device bus |
101-
+-----------+------------+-------------------------------------+
102-
| SDMMC | on-chip | disk access |
103-
+-----------+------------+-------------------------------------+
104-
105-
Other hardware features have not been enabled yet for this board.
106-
107-
The default configuration per core can be found in the defconfig file:
108-
:zephyr_file:`boards/weact/stm32h5_core/weact_stm32h5_core_defconfig`
72+
.. zephyr:board-supported-hw::
10973
11074
Pin Mapping
11175
===========

‎boards/weact/usb2canfdv1/doc/index.rst‎

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,7 @@ terminal block for connecting to the CAN bus, and three LEDs.
1515
Supported Features
1616
==================
1717

18-
The ``usb2canfdv1`` board configuration supports the following hardware features:
19-
20-
+-----------+------------+-------------------------------------+
21-
| Interface | Controller | Driver/Component |
22-
+===========+============+=====================================+
23-
| NVIC | on-chip | nested vector interrupt controller |
24-
+-----------+------------+-------------------------------------+
25-
| PINMUX | on-chip | pinmux |
26-
+-----------+------------+-------------------------------------+
27-
| FLASH | on-chip | flash memory |
28-
+-----------+------------+-------------------------------------+
29-
| GPIO | on-chip | gpio |
30-
+-----------+------------+-------------------------------------+
31-
| USB | on-chip | USB |
32-
+-----------+------------+-------------------------------------+
33-
| FDCAN1 | on-chip | CAN controller |
34-
+-----------+------------+-------------------------------------+
35-
36-
The default configuration can be found in the defconfig file:
37-
:zephyr_file:`boards/weact/usb2canfdv1/usb2canfdv1_defconfig`.
38-
39-
Other hardware features are not currently supported by the port.
18+
.. zephyr:board-supported-hw::
4019
4120
System Clock
4221
============

0 commit comments

Comments
 (0)