Commit 5736aedd authored by Benjamin Cabé's avatar Benjamin Cabé Committed by Benjamin Cabé
Browse files

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: default avatarBenjamin Cabé <benjamin@zephyrproject.org>
parent d6278041

boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst

+1 −43
Original line number Diff line number Diff line
@@ -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

===================

boards/seeed/lora_e5_mini/doc/index.rst

+1 −42
Original line number Diff line number Diff line
@@ -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

===================

boards/seeed/seeeduino_xiao/doc/index.rst

+1 −35
Original line number Diff line number Diff line
@@ -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

===================

boards/seeed/wio_terminal/doc/index.rst

+1 −52
Original line number Diff line number Diff line
@@ -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

boards/seeed/xiao_ble/doc/index.rst

+1 −36
Original line number Diff line number Diff line
@@ -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

===================

CRA Git | Maintained and supported by SUSTech CRA and CCSE