Skip to content

Commit 5736aed

Browse files
kartbenkartben
committed
boards: seeed: adopt zephyr:board-supported-hw Sphinx directive
Replace manually authored "Supported Features" tables 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 d627804 commit 5736aed

File tree

9 files changed

+9
-345
lines changed

9 files changed

+9
-345
lines changed

‎boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst‎

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -66,49 +66,7 @@ More information about LoRa-E5 STM32WLE5JC Module can be found here:
6666
Supported Features
6767
==================
6868

69-
The Zephyr LoRa-E5 Dev Board configuration supports the following hardware
70-
features:
71-
72-
+-----------+------------+-------------------------------------+
73-
| Interface | Controller | Driver/Component |
74-
+===========+============+=====================================+
75-
| ADC | on-chip | adc |
76-
+-----------+------------+-------------------------------------+
77-
| AES | on-chip | crypto |
78-
+-----------+------------+-------------------------------------+
79-
| COUNTER | on-chip | rtc |
80-
+-----------+------------+-------------------------------------+
81-
| CLOCK | on-chip | reset and clock control |
82-
+-----------+------------+-------------------------------------+
83-
| FLASH | on-chip | flash |
84-
+-----------+------------+-------------------------------------+
85-
| GPIO | on-chip | gpio |
86-
+-----------+------------+-------------------------------------+
87-
| I2C | on-chip | i2c |
88-
+-----------+------------+-------------------------------------+
89-
| MPU | on-chip | arch/arm |
90-
+-----------+------------+-------------------------------------+
91-
| NVIC | on-chip | arch/arm |
92-
+-----------+------------+-------------------------------------+
93-
| PINMUX | on-chip | pinmux |
94-
+-----------+------------+-------------------------------------+
95-
| RADIO | on-chip | LoRa |
96-
+-----------+------------+-------------------------------------+
97-
| SPI | on-chip | spi |
98-
+-----------+------------+-------------------------------------+
99-
| UART | on-chip | serial port-polling; |
100-
| | | serial port-interrupt |
101-
+-----------+------------+-------------------------------------+
102-
| WATCHDOG | on-chip | independent watchdog |
103-
+-----------+------------+-------------------------------------+
104-
105-
Other hardware features are not yet supported on this Zephyr port.
106-
107-
The default configuration can be found in:
108-
109-
- :zephyr_file:`boards/seeed/lora_e5_dev_board/lora_e5_dev_board_defconfig`
110-
- :zephyr_file:`boards/seeed/lora_e5_dev_board/lora_e5_dev_board.dts`
111-
69+
.. zephyr:board-supported-hw::
11270
11371
Connections and IOs
11472
===================

‎boards/seeed/lora_e5_mini/doc/index.rst‎

Lines changed: 1 addition & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -56,48 +56,7 @@ More information about LoRa-E5 STM32WLE5JC Module can be found here:
5656
Supported Features
5757
==================
5858

59-
The Zephyr LoRa-E5 mini configuration supports the following hardware features:
60-
61-
+-----------+------------+-------------------------------------+
62-
| Interface | Controller | Driver/Component |
63-
+===========+============+=====================================+
64-
| ADC | on-chip | adc |
65-
+-----------+------------+-------------------------------------+
66-
| AES | on-chip | crypto |
67-
+-----------+------------+-------------------------------------+
68-
| COUNTER | on-chip | rtc |
69-
+-----------+------------+-------------------------------------+
70-
| CLOCK | on-chip | reset and clock control |
71-
+-----------+------------+-------------------------------------+
72-
| FLASH | on-chip | flash |
73-
+-----------+------------+-------------------------------------+
74-
| GPIO | on-chip | gpio |
75-
+-----------+------------+-------------------------------------+
76-
| I2C | on-chip | i2c |
77-
+-----------+------------+-------------------------------------+
78-
| MPU | on-chip | arch/arm |
79-
+-----------+------------+-------------------------------------+
80-
| NVIC | on-chip | arch/arm |
81-
+-----------+------------+-------------------------------------+
82-
| PINMUX | on-chip | pinmux |
83-
+-----------+------------+-------------------------------------+
84-
| RADIO | on-chip | LoRa |
85-
+-----------+------------+-------------------------------------+
86-
| SPI | on-chip | spi |
87-
+-----------+------------+-------------------------------------+
88-
| UART | on-chip | serial port-polling; |
89-
| | | serial port-interrupt |
90-
+-----------+------------+-------------------------------------+
91-
| WATCHDOG | on-chip | independent watchdog |
92-
+-----------+------------+-------------------------------------+
93-
94-
Other hardware features are not yet supported on this Zephyr port.
95-
96-
The default configuration can be found in:
97-
98-
- :zephyr_file:`boards/seeed/lora_e5_mini/lora_e5_mini_defconfig`
99-
- :zephyr_file:`boards/seeed/lora_e5_mini/lora_e5_mini.dts`
100-
59+
.. zephyr:board-supported-hw::
10160
10261
Connections and IOs
10362
===================

‎boards/seeed/seeeduino_xiao/doc/index.rst‎

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -18,41 +18,7 @@ Hardware
1818
Supported Features
1919
==================
2020

21-
The seeeduino_xiao board configuration supports the following hardware
22-
features:
23-
24-
+-----------+------------+------------------------------------------+
25-
| Interface | Controller | Driver/Component |
26-
+===========+============+==========================================+
27-
| DMA | on-chip | Direct memory access |
28-
+-----------+------------+------------------------------------------+
29-
| DAC | on-chip | Digital to analogue converter |
30-
+-----------+------------+------------------------------------------+
31-
| Flash | on-chip | Can be used with LittleFS to store files |
32-
+-----------+------------+------------------------------------------+
33-
| GPIO | on-chip | I/O ports |
34-
+-----------+------------+------------------------------------------+
35-
| HWINFO | on-chip | Hardware info |
36-
+-----------+------------+------------------------------------------+
37-
| I2C | on-chip | Inter-Integrated Circuit |
38-
+-----------+------------+------------------------------------------+
39-
| NVIC | on-chip | nested vector interrupt controller |
40-
+-----------+------------+------------------------------------------+
41-
| SPI | on-chip | Serial Peripheral Interface ports |
42-
+-----------+------------+------------------------------------------+
43-
| SYSTICK | on-chip | systick |
44-
+-----------+------------+------------------------------------------+
45-
| USART | on-chip | Serial ports |
46-
+-----------+------------+------------------------------------------+
47-
| USB | on-chip | USB device |
48-
+-----------+------------+------------------------------------------+
49-
| WDT | on-chip | Watchdog |
50-
+-----------+------------+------------------------------------------+
51-
52-
Other hardware features are not currently supported by Zephyr.
53-
54-
The default configuration can be found in the Kconfig file
55-
:zephyr_file:`boards/seeed/seeeduino_xiao/seeeduino_xiao_defconfig`.
21+
.. zephyr:board-supported-hw::
5622
5723
Connections and IOs
5824
===================

‎boards/seeed/wio_terminal/doc/index.rst‎

Lines changed: 1 addition & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -33,58 +33,7 @@ Hardware
3333
Supported Features
3434
==================
3535

36-
The wio_terminal board configuration supports the following hardware features:
37-
38-
.. list-table::
39-
:header-rows: 1
40-
41-
* - Interface
42-
- Controller
43-
- Driver / Component
44-
* - NVIC
45-
- on-chip
46-
- Nested vector interrupt controller
47-
* - Flash
48-
- on-chip
49-
- Can be used with LittleFS to store files
50-
* - SYSTICK
51-
- on-chip
52-
- Systick
53-
* - WDT
54-
- on-chip
55-
- Watchdog
56-
* - GPIO
57-
- on-chip
58-
- I/O ports
59-
* - USART
60-
- on-chip
61-
- Serial port
62-
* - I2C
63-
- on-chip
64-
- Inter-Integrated Circuit
65-
* - SPI
66-
- on-chip
67-
- Serial Peripheral Interface port
68-
* - TRNG
69-
- on-chip
70-
- True Random Number Generator
71-
* - HWINFO
72-
- on-chip
73-
- Unique 128 bit serial number
74-
* - RTC
75-
- on-chip
76-
- Real-Time Counter
77-
* - USB
78-
- on-chip
79-
- USB device
80-
* - PWM
81-
- on-chip
82-
- PWM
83-
84-
Other hardware features are not currently supported by Zephyr.
85-
86-
The default configuration can be found in the Kconfig file
87-
:zephyr_file:`boards/seeed/wio_terminal/wio_terminal_defconfig`.
36+
.. zephyr:board-supported-hw::
8837
8938
Zephyr can use the default Cortex-M SYSTICK timer or the SAM0 specific RTC.
9039
To use the RTC, set :kconfig:option:`CONFIG_CORTEX_M_SYSTICK=n` and set

‎boards/seeed/xiao_ble/doc/index.rst‎

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -23,42 +23,7 @@ Hardware
2323
Supported Features
2424
==================
2525

26-
The xiao_ble board configuration supports the following hardware features:
27-
28-
+-----------+------------+----------------------+
29-
| Interface | Controller | Driver/Component |
30-
+===========+============+======================+
31-
| ADC | on-chip | adc |
32-
+-----------+------------+----------------------+
33-
| CLOCK | on-chip | clock_control |
34-
+-----------+------------+----------------------+
35-
| FLASH | on-chip | flash, QSPI flash |
36-
+-----------+------------+----------------------+
37-
| GPIO | on-chip | gpio |
38-
+-----------+------------+----------------------+
39-
| I2C(M) | on-chip | i2c |
40-
+-----------+------------+----------------------+
41-
| MPU | on-chip | arch/arm |
42-
+-----------+------------+----------------------+
43-
| NVIC | on-chip | arch/arm |
44-
+-----------+------------+----------------------+
45-
| PWM | on-chip | pwm |
46-
+-----------+------------+----------------------+
47-
| RADIO | on-chip | Bluetooth, |
48-
| | | ieee802154 |
49-
+-----------+------------+----------------------+
50-
| RTC | on-chip | system clock |
51-
+-----------+------------+----------------------+
52-
| SPI(M/S) | on-chip | spi |
53-
+-----------+------------+----------------------+
54-
| UART | on-chip | serial |
55-
+-----------+------------+----------------------+
56-
| USB | on-chip | usb |
57-
+-----------+------------+----------------------+
58-
| WDT | on-chip | watchdog |
59-
+-----------+------------+----------------------+
60-
61-
Other hardware features have not been enabled yet for this board.
26+
.. zephyr:board-supported-hw::
6227
6328
Connections and IOs
6429
===================

‎boards/seeed/xiao_esp32c3/doc/index.rst‎

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,29 +19,7 @@ pinout.
1919
Supported Features
2020
==================
2121

22-
The XIAO ESP32C3 board configuration supports the following hardware features:
23-
24-
+-----------+------------+------------------+
25-
| Interface | Controller | Driver/Component |
26-
+===========+============+==================+
27-
| PMP | on-chip | arch/riscv |
28-
+-----------+------------+------------------+
29-
| INTMTRX | on-chip | intc_esp32c3 |
30-
+-----------+------------+------------------+
31-
| PINMUX | on-chip | pinctrl_esp32 |
32-
+-----------+------------+------------------+
33-
| USB UART | on-chip | serial_esp32_usb |
34-
+-----------+------------+------------------+
35-
| GPIO | on-chip | gpio_esp32 |
36-
+-----------+------------+------------------+
37-
| UART | on-chip | uart_esp32 |
38-
+-----------+------------+------------------+
39-
| I2C | on-chip | i2c_esp32 |
40-
+-----------+------------+------------------+
41-
| SPI | on-chip | spi_esp32_spim |
42-
+-----------+------------+------------------+
43-
| TWAI | on-chip | can_esp32_twai |
44-
+-----------+------------+------------------+
22+
.. zephyr:board-supported-hw::
4523
4624
Connections and IOs
4725
===================

‎boards/seeed/xiao_esp32c6/doc/index.rst‎

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -21,37 +21,7 @@ It is based on a standard XIAO 14 pin pinout.
2121
Supported Features
2222
==================
2323

24-
The Zephyr ``xiao_esp32c6`` board target supports the following hardware features:
25-
26-
+------------+------------+-------------------------------------+
27-
| Interface | Controller | Driver/Component |
28-
+============+============+=====================================+
29-
| UART | on-chip | serial port |
30-
+------------+------------+-------------------------------------+
31-
| GPIO | on-chip | gpio |
32-
+------------+------------+-------------------------------------+
33-
| PINMUX | on-chip | pinmux |
34-
+------------+------------+-------------------------------------+
35-
| USB-JTAG | on-chip | hardware interface |
36-
+------------+------------+-------------------------------------+
37-
| SPI Master | on-chip | spi |
38-
+------------+------------+-------------------------------------+
39-
| I2C | on-chip | i2c |
40-
+------------+------------+-------------------------------------+
41-
| Watchdog | on-chip | watchdog |
42-
+------------+------------+-------------------------------------+
43-
| LEDC | on-chip | pwm |
44-
+------------+------------+-------------------------------------+
45-
| SPI DMA | on-chip | spi |
46-
+------------+------------+-------------------------------------+
47-
| GDMA | on-chip | dma |
48-
+------------+------------+-------------------------------------+
49-
| TRNG | on-chip | entropy |
50-
+------------+------------+-------------------------------------+
51-
| USB-CDC | on-chip | serial |
52-
+------------+------------+-------------------------------------+
53-
| Wi-Fi | on-chip | |
54-
+------------+------------+-------------------------------------+
24+
.. zephyr:board-supported-hw::
5525
5626
The board uses a standard XIAO pinout, the default pin mapping is the following:
5727

‎boards/seeed/xiao_esp32s3/doc/index.rst‎

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -38,41 +38,7 @@ Additionally, Sense variant integrates a OV2640 camera sensor, microphone and sd
3838
Supported Features
3939
==================
4040

41-
Current Zephyr's XIAO ESP32S3 board supports the following features:
42-
43-
+------------+------------+-------------------------------------+
44-
| Interface | Controller | Driver/Component |
45-
+============+============+=====================================+
46-
| UART | on-chip | serial port |
47-
+------------+------------+-------------------------------------+
48-
| GPIO | on-chip | gpio |
49-
+------------+------------+-------------------------------------+
50-
| PINMUX | on-chip | pinmux |
51-
+------------+------------+-------------------------------------+
52-
| USB-JTAG | on-chip | hardware interface |
53-
+------------+------------+-------------------------------------+
54-
| SPI Master | on-chip | spi |
55-
+------------+------------+-------------------------------------+
56-
| TWAI/CAN | on-chip | can |
57-
+------------+------------+-------------------------------------+
58-
| ADC | on-chip | adc |
59-
+------------+------------+-------------------------------------+
60-
| Timers | on-chip | counter |
61-
+------------+------------+-------------------------------------+
62-
| Watchdog | on-chip | watchdog |
63-
+------------+------------+-------------------------------------+
64-
| TRNG | on-chip | entropy |
65-
+------------+------------+-------------------------------------+
66-
| LEDC | on-chip | pwm |
67-
+------------+------------+-------------------------------------+
68-
| MCPWM | on-chip | pwm |
69-
+------------+------------+-------------------------------------+
70-
| PCNT | on-chip | qdec |
71-
+------------+------------+-------------------------------------+
72-
| GDMA | on-chip | dma |
73-
+------------+------------+-------------------------------------+
74-
| LCD_CAM | on-chip | lcd_cam |
75-
+------------+------------+-------------------------------------+
41+
.. zephyr:board-supported-hw::
7642
7743
Connections and IOs
7844
===================

0 commit comments

Comments
 (0)