Skip to content

Commit

Permalink
boards: seeed: adopt zephyr:board-supported-hw Sphinx directive
Browse files Browse the repository at this point in the history 
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é <benjamin@zephyrproject.org>
  • Loading branch information
@kartben
kartben committed Feb 26, 2025
1 parent 8081008 commit 8c1d26f
Show file tree
Hide file tree
Showing 9 changed files with 9 additions and 345 deletions.
44 changes: 1 addition & 43 deletions boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,49 +66,7 @@ More information about LoRa-E5 STM32WLE5JC Module can be found here:
Supported Features
==================

The Zephyr LoRa-E5 Dev Board configuration supports the following hardware
features:

+-----------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+=====================================+
| ADC | on-chip | adc |
+-----------+------------+-------------------------------------+
| AES | on-chip | crypto |
+-----------+------------+-------------------------------------+
| COUNTER | on-chip | rtc |
+-----------+------------+-------------------------------------+
| CLOCK | on-chip | reset and clock control |
+-----------+------------+-------------------------------------+
| FLASH | on-chip | flash |
+-----------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+-----------+------------+-------------------------------------+
| I2C | on-chip | i2c |
+-----------+------------+-------------------------------------+
| MPU | on-chip | arch/arm |
+-----------+------------+-------------------------------------+
| NVIC | on-chip | arch/arm |
+-----------+------------+-------------------------------------+
| PINMUX | on-chip | pinmux |
+-----------+------------+-------------------------------------+
| RADIO | on-chip | LoRa |
+-----------+------------+-------------------------------------+
| SPI | on-chip | spi |
+-----------+------------+-------------------------------------+
| UART | on-chip | serial port-polling; |
| | | serial port-interrupt |
+-----------+------------+-------------------------------------+
| WATCHDOG | on-chip | independent watchdog |
+-----------+------------+-------------------------------------+

Other hardware features are not yet supported on this Zephyr port.

The default configuration can be found in:

- :zephyr_file:`boards/seeed/lora_e5_dev_board/lora_e5_dev_board_defconfig`
- :zephyr_file:`boards/seeed/lora_e5_dev_board/lora_e5_dev_board.dts`

.. zephyr:board-supported-hw::
Connections and IOs
===================
Expand Down
43 changes: 1 addition & 42 deletions boards/seeed/lora_e5_mini/doc/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,48 +56,7 @@ More information about LoRa-E5 STM32WLE5JC Module can be found here:
Supported Features
==================

The Zephyr LoRa-E5 mini configuration supports the following hardware features:

+-----------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+=====================================+
| ADC | on-chip | adc |
+-----------+------------+-------------------------------------+
| AES | on-chip | crypto |
+-----------+------------+-------------------------------------+
| COUNTER | on-chip | rtc |
+-----------+------------+-------------------------------------+
| CLOCK | on-chip | reset and clock control |
+-----------+------------+-------------------------------------+
| FLASH | on-chip | flash |
+-----------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+-----------+------------+-------------------------------------+
| I2C | on-chip | i2c |
+-----------+------------+-------------------------------------+
| MPU | on-chip | arch/arm |
+-----------+------------+-------------------------------------+
| NVIC | on-chip | arch/arm |
+-----------+------------+-------------------------------------+
| PINMUX | on-chip | pinmux |
+-----------+------------+-------------------------------------+
| RADIO | on-chip | LoRa |
+-----------+------------+-------------------------------------+
| SPI | on-chip | spi |
+-----------+------------+-------------------------------------+
| UART | on-chip | serial port-polling; |
| | | serial port-interrupt |
+-----------+------------+-------------------------------------+
| WATCHDOG | on-chip | independent watchdog |
+-----------+------------+-------------------------------------+

Other hardware features are not yet supported on this Zephyr port.

The default configuration can be found in:

- :zephyr_file:`boards/seeed/lora_e5_mini/lora_e5_mini_defconfig`
- :zephyr_file:`boards/seeed/lora_e5_mini/lora_e5_mini.dts`

.. zephyr:board-supported-hw::
Connections and IOs
===================
Expand Down
36 changes: 1 addition & 35 deletions boards/seeed/seeeduino_xiao/doc/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,41 +18,7 @@ Hardware
Supported Features
==================

The seeeduino_xiao board configuration supports the following hardware
features:

+-----------+------------+------------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+==========================================+
| DMA | on-chip | Direct memory access |
+-----------+------------+------------------------------------------+
| DAC | on-chip | Digital to analogue converter |
+-----------+------------+------------------------------------------+
| Flash | on-chip | Can be used with LittleFS to store files |
+-----------+------------+------------------------------------------+
| GPIO | on-chip | I/O ports |
+-----------+------------+------------------------------------------+
| HWINFO | on-chip | Hardware info |
+-----------+------------+------------------------------------------+
| I2C | on-chip | Inter-Integrated Circuit |
+-----------+------------+------------------------------------------+
| NVIC | on-chip | nested vector interrupt controller |
+-----------+------------+------------------------------------------+
| SPI | on-chip | Serial Peripheral Interface ports |
+-----------+------------+------------------------------------------+
| SYSTICK | on-chip | systick |
+-----------+------------+------------------------------------------+
| USART | on-chip | Serial ports |
+-----------+------------+------------------------------------------+
| USB | on-chip | USB device |
+-----------+------------+------------------------------------------+
| WDT | on-chip | Watchdog |
+-----------+------------+------------------------------------------+

Other hardware features are not currently supported by Zephyr.

The default configuration can be found in the Kconfig file
:zephyr_file:`boards/seeed/seeeduino_xiao/seeeduino_xiao_defconfig`.
.. zephyr:board-supported-hw::
Connections and IOs
===================
Expand Down
53 changes: 1 addition & 52 deletions boards/seeed/wio_terminal/doc/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,58 +33,7 @@ Hardware
Supported Features
==================

The wio_terminal board configuration supports the following hardware features:

.. list-table::
:header-rows: 1

* - Interface
- Controller
- Driver / Component
* - NVIC
- on-chip
- Nested vector interrupt controller
* - Flash
- on-chip
- Can be used with LittleFS to store files
* - SYSTICK
- on-chip
- Systick
* - WDT
- on-chip
- Watchdog
* - GPIO
- on-chip
- I/O ports
* - USART
- on-chip
- Serial port
* - I2C
- on-chip
- Inter-Integrated Circuit
* - SPI
- on-chip
- Serial Peripheral Interface port
* - TRNG
- on-chip
- True Random Number Generator
* - HWINFO
- on-chip
- Unique 128 bit serial number
* - RTC
- on-chip
- Real-Time Counter
* - USB
- on-chip
- USB device
* - PWM
- on-chip
- PWM

Other hardware features are not currently supported by Zephyr.

The default configuration can be found in the Kconfig file
:zephyr_file:`boards/seeed/wio_terminal/wio_terminal_defconfig`.
.. zephyr:board-supported-hw::
Zephyr can use the default Cortex-M SYSTICK timer or the SAM0 specific RTC.
To use the RTC, set :kconfig:option:`CONFIG_CORTEX_M_SYSTICK=n` and set
Expand Down
37 changes: 1 addition & 36 deletions boards/seeed/xiao_ble/doc/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,42 +23,7 @@ Hardware
Supported Features
==================

The xiao_ble board configuration supports the following hardware features:

+-----------+------------+----------------------+
| Interface | Controller | Driver/Component |
+===========+============+======================+
| ADC | on-chip | adc |
+-----------+------------+----------------------+
| CLOCK | on-chip | clock_control |
+-----------+------------+----------------------+
| FLASH | on-chip | flash, QSPI flash |
+-----------+------------+----------------------+
| GPIO | on-chip | gpio |
+-----------+------------+----------------------+
| I2C(M) | on-chip | i2c |
+-----------+------------+----------------------+
| MPU | on-chip | arch/arm |
+-----------+------------+----------------------+
| NVIC | on-chip | arch/arm |
+-----------+------------+----------------------+
| PWM | on-chip | pwm |
+-----------+------------+----------------------+
| RADIO | on-chip | Bluetooth, |
| | | ieee802154 |
+-----------+------------+----------------------+
| RTC | on-chip | system clock |
+-----------+------------+----------------------+
| SPI(M/S) | on-chip | spi |
+-----------+------------+----------------------+
| UART | on-chip | serial |
+-----------+------------+----------------------+
| USB | on-chip | usb |
+-----------+------------+----------------------+
| WDT | on-chip | watchdog |
+-----------+------------+----------------------+

Other hardware features have not been enabled yet for this board.
.. zephyr:board-supported-hw::
Connections and IOs
===================
Expand Down
24 changes: 1 addition & 23 deletions boards/seeed/xiao_esp32c3/doc/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,7 @@ pinout.
Supported Features
==================

The XIAO ESP32C3 board configuration supports the following hardware features:

+-----------+------------+------------------+
| Interface | Controller | Driver/Component |
+===========+============+==================+
| PMP | on-chip | arch/riscv |
+-----------+------------+------------------+
| INTMTRX | on-chip | intc_esp32c3 |
+-----------+------------+------------------+
| PINMUX | on-chip | pinctrl_esp32 |
+-----------+------------+------------------+
| USB UART | on-chip | serial_esp32_usb |
+-----------+------------+------------------+
| GPIO | on-chip | gpio_esp32 |
+-----------+------------+------------------+
| UART | on-chip | uart_esp32 |
+-----------+------------+------------------+
| I2C | on-chip | i2c_esp32 |
+-----------+------------+------------------+
| SPI | on-chip | spi_esp32_spim |
+-----------+------------+------------------+
| TWAI | on-chip | can_esp32_twai |
+-----------+------------+------------------+
.. zephyr:board-supported-hw::
Connections and IOs
===================
Expand Down
32 changes: 1 addition & 31 deletions boards/seeed/xiao_esp32c6/doc/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,37 +21,7 @@ It is based on a standard XIAO 14 pin pinout.
Supported Features
==================

The Zephyr ``xiao_esp32c6`` board target supports the following hardware features:

+------------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+============+============+=====================================+
| UART | on-chip | serial port |
+------------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+------------+------------+-------------------------------------+
| PINMUX | on-chip | pinmux |
+------------+------------+-------------------------------------+
| USB-JTAG | on-chip | hardware interface |
+------------+------------+-------------------------------------+
| SPI Master | on-chip | spi |
+------------+------------+-------------------------------------+
| I2C | on-chip | i2c |
+------------+------------+-------------------------------------+
| Watchdog | on-chip | watchdog |
+------------+------------+-------------------------------------+
| LEDC | on-chip | pwm |
+------------+------------+-------------------------------------+
| SPI DMA | on-chip | spi |
+------------+------------+-------------------------------------+
| GDMA | on-chip | dma |
+------------+------------+-------------------------------------+
| TRNG | on-chip | entropy |
+------------+------------+-------------------------------------+
| USB-CDC | on-chip | serial |
+------------+------------+-------------------------------------+
| Wi-Fi | on-chip | |
+------------+------------+-------------------------------------+
.. zephyr:board-supported-hw::
The board uses a standard XIAO pinout, the default pin mapping is the following:

Expand Down
36 changes: 1 addition & 35 deletions boards/seeed/xiao_esp32s3/doc/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,41 +38,7 @@ Additionally, Sense variant integrates a OV2640 camera sensor, microphone and sd
Supported Features
==================

Current Zephyr's XIAO ESP32S3 board supports the following features:

+------------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+============+============+=====================================+
| UART | on-chip | serial port |
+------------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+------------+------------+-------------------------------------+
| PINMUX | on-chip | pinmux |
+------------+------------+-------------------------------------+
| USB-JTAG | on-chip | hardware interface |
+------------+------------+-------------------------------------+
| SPI Master | on-chip | spi |
+------------+------------+-------------------------------------+
| TWAI/CAN | on-chip | can |
+------------+------------+-------------------------------------+
| ADC | on-chip | adc |
+------------+------------+-------------------------------------+
| Timers | on-chip | counter |
+------------+------------+-------------------------------------+
| Watchdog | on-chip | watchdog |
+------------+------------+-------------------------------------+
| TRNG | on-chip | entropy |
+------------+------------+-------------------------------------+
| LEDC | on-chip | pwm |
+------------+------------+-------------------------------------+
| MCPWM | on-chip | pwm |
+------------+------------+-------------------------------------+
| PCNT | on-chip | qdec |
+------------+------------+-------------------------------------+
| GDMA | on-chip | dma |
+------------+------------+-------------------------------------+
| LCD_CAM | on-chip | lcd_cam |
+------------+------------+-------------------------------------+
.. zephyr:board-supported-hw::
Connections and IOs
===================
Expand Down
Loading

0 comments on commit 8c1d26f

Please sign in to comment.