michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: atmel: adopt zephyr:board-supported-hw directive

Browse source 
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é <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2025-03-05 12:01:05 +01:00 • committed by Fabio Baltieri
commit 6715d4669a
12 changed files with 12 additions and 522 deletions
Download patch file Download diff file Expand all files Collapse all files

40
boards/atmel/sam/sam4e_xpro/doc/index.rst
View file

@ -27,45 +27,7 @@ Hardware
Supported Features
==================
The sam4e_xpro board configuration supports the following hardware
features:
+-----------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+=====================================+
| NVIC | on-chip | nested vector interrupt controller |
+-----------+------------+-------------------------------------+
| SYSTICK | on-chip | systick |
+-----------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+-----------+------------+-------------------------------------+
| AFEC | on-chip | adc |
+-----------+------------+-------------------------------------+
| COUNTER | on-chip | counter |
+-----------+------------+-------------------------------------+
| ETHERNET | on-chip | ethernet |
+-----------+------------+-------------------------------------+
| HWINFO | on-chip | hwinfo |
+-----------+------------+-------------------------------------+
| HSMCI | on-chip | sdhc |
+-----------+------------+-------------------------------------+
| I2C | on-chip | i2c |
+-----------+------------+-------------------------------------+
| PWM | on-chip | pwm |
+-----------+------------+-------------------------------------+
| SPI | on-chip | spi |
+-----------+------------+-------------------------------------+
| UART | on-chip | serial port |
+-----------+------------+-------------------------------------+
| USART | on-chip | serial port |
+-----------+------------+-------------------------------------+
| WATCHDOG | on-chip | watchdog |
+-----------+------------+-------------------------------------+
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam/sam4e_xpro/sam4e_xpro_defconfig`.
.. zephyr:board-supported-hw::
Connections and IOs
===================

33
boards/atmel/sam/sam4l_ek/doc/index.rst
View file

@ -49,38 +49,7 @@ Hardware
Supported Features
==================
The sam4l_ek board configuration supports the following hardware features:
+-----------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+=====================================+
| MPU | on-chip | arch/arm |
+-----------+------------+-------------------------------------+
| NVIC | on-chip | arch/arm |
+-----------+------------+-------------------------------------+
| SYSTICK | on-chip | systick |
+-----------+------------+-------------------------------------+
| COUNTER | on-chip | counter |
+-----------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+-----------+------------+-------------------------------------+
| HWINFO | on-chip | Unique 120 bit serial number |
+-----------+------------+-------------------------------------+
| SPI | on-chip | spi |
+-----------+------------+-------------------------------------+
| TRNG | on-chip | entropy |
+-----------+------------+-------------------------------------+
| TWIM | on-chip | i2c master port-interrupt |
+-----------+------------+-------------------------------------+
| USART | on-chip | serial port |
+-----------+------------+-------------------------------------+
| USB | on-chip | usb device |
+-----------+------------+-------------------------------------+
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam/sam4l_ek/sam4l_ek_defconfig`.
.. zephyr:board-supported-hw::
Connections and IOs
===================

40
boards/atmel/sam/sam4s_xplained/doc/index.rst
View file

@ -23,45 +23,7 @@ Hardware
Supported Features
==================
The sam4s_xplained board configuration supports the following hardware
features:
+-----------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+=====================================+
| NVIC | on-chip | nested vector interrupt controller |
+-----------+------------+-------------------------------------+
| SYSTICK | on-chip | systick |
+-----------+------------+-------------------------------------+
| ADC | on-chip | adc |
+-----------+------------+-------------------------------------+
| COUNTER | on-chip | counter |
+-----------+------------+-------------------------------------+
| DAC | on-chip | dac |
+-----------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+-----------+------------+-------------------------------------+
| HWINFO | on-chip | Unique device serial number |
+-----------+------------+-------------------------------------+
| I2C | on-chip | i2c |
+-----------+------------+-------------------------------------+
| PWM | on-chip | pwm |
+-----------+------------+-------------------------------------+
| SPI | on-chip | spi |
+-----------+------------+-------------------------------------+
| SMC | on-chip | memc (PSRAM) |
+-----------+------------+-------------------------------------+
| UART | on-chip | serial port |
+-----------+------------+-------------------------------------+
| USART | on-chip | serial port |
+-----------+------------+-------------------------------------+
| WATCHDOG | on-chip | watchdog |
+-----------+------------+-------------------------------------+
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam/sam4s_xplained/sam4s_xplained_defconfig`.
.. zephyr:board-supported-hw::
Connections and IOs
===================

48
boards/atmel/sam/sam_e70_xplained/doc/index.rst
View file

@ -27,53 +27,7 @@ Hardware
Supported Features
==================
The sam_e70_xplained board configuration supports the following hardware
features:
+-----------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+=====================================+
| NVIC | on-chip | nested vector interrupt controller |
+-----------+------------+-------------------------------------+
| SYSTICK | on-chip | systick |
+-----------+------------+-------------------------------------+
| AFEC | on-chip | adc |
+-----------+------------+-------------------------------------+
| CAN FD | on-chip | can |
+-----------+------------+-------------------------------------+
| COUNTER | on-chip | counter |
+-----------+------------+-------------------------------------+
| ETHERNET | on-chip | ethernet |
+-----------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+-----------+------------+-------------------------------------+
| DAC | on-chip | dac |
+-----------+------------+-------------------------------------+
| HWINFO | on-chip | Unique device serial number |
+-----------+------------+-------------------------------------+
| I2C | on-chip | i2c |
+-----------+------------+-------------------------------------+
| I2S | on-chip | i2s |
+-----------+------------+-------------------------------------+
| PWM | on-chip | pwm |
+-----------+------------+-------------------------------------+
| SPI | on-chip | spi |
+-----------+------------+-------------------------------------+
| UART | on-chip | serial port |
+-----------+------------+-------------------------------------+
| USART | on-chip | serial port |
+-----------+------------+-------------------------------------+
| USB | on-chip | USB device |
+-----------+------------+-------------------------------------+
| WATCHDOG | on-chip | watchdog |
+-----------+------------+-------------------------------------+
| XDMAC | on-chip | dma |
+-----------+------------+-------------------------------------+
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam/sam_e70_xplained/sam_e70_xplained_same70q21_defconfig`.
.. zephyr:board-supported-hw::
Connections and IOs
===================

48
boards/atmel/sam/sam_v71_xult/doc/index.rst
View file

@ -33,53 +33,7 @@ Hardware
Supported Features
==================
The sam_v71_xplained_ultra board configuration supports the following hardware
features:
+-----------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+=====================================+
| NVIC | on-chip | nested vector interrupt controller |
+-----------+------------+-------------------------------------+
| SYSTICK | on-chip | systick |
+-----------+------------+-------------------------------------+
| AFEC | on-chip | adc |
+-----------+------------+-------------------------------------+
| CAN FD | on-chip | can |
+-----------+------------+-------------------------------------+
| COUNTER | on-chip | counter |
+-----------+------------+-------------------------------------+
| ETHERNET | on-chip | ethernet |
+-----------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+-----------+------------+-------------------------------------+
| DAC | on-chip | dac |
+-----------+------------+-------------------------------------+
| HWINFO | on-chip | Unique device serial number |
+-----------+------------+-------------------------------------+
| I2C | on-chip | i2c |
+-----------+------------+-------------------------------------+
| I2S | on-chip | i2s |
+-----------+------------+-------------------------------------+
| PWM | on-chip | pwm |
+-----------+------------+-------------------------------------+
| SPI | on-chip | spi |
+-----------+------------+-------------------------------------+
| UART | on-chip | serial port |
+-----------+------------+-------------------------------------+
| USART | on-chip | serial port |
+-----------+------------+-------------------------------------+
| USB | on-chip | USB device |
+-----------+------------+-------------------------------------+
| WATCHDOG | on-chip | watchdog |
+-----------+------------+-------------------------------------+
| XDMAC | on-chip | dma |
+-----------+------------+-------------------------------------+
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam/sam_v71_xult/sam_v71_xult_samv71q21_defconfig`.
.. zephyr:board-supported-hw::
Connections and IOs
===================

48
boards/atmel/sam0/samc21n_xpro/doc/index.rst
View file

@ -25,53 +25,7 @@ Hardware
Supported Features
==================
The samc21n_xpro 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
* - ADC
- on-chip
- Analog to Digital Converter
* - GPIO
- on-chip
- I/O ports
* - PWM
- on-chip
- Pulse Width Modulation
* - USART
- on-chip
- Serial ports
* - I2C
- on-chip
- I2C ports
* - SPI
- on-chip
- Serial Peripheral Interface ports
* - CAN
- on-chip
- CAN ports
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam0/samc21n_xpro/samc21n_xpro_defconfig`.
.. zephyr:board-supported-hw::
Pin Mapping
===========

42
boards/atmel/sam0/samd20_xpro/doc/index.rst
View file

@ -23,47 +23,7 @@ Hardware
Supported Features
==================
The samd20_xpro 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
* - ADC
- on-chip
- Analog to Digital Converter
* - GPIO
- on-chip
- I/O ports
* - USART
- on-chip
- Serial ports
* - I2C
- on-chip
- I2C ports
* - SPI
- on-chip
- Serial Peripheral Interface ports
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam0/samd20_xpro/samd20_xpro_defconfig`.
.. zephyr:board-supported-hw::
Connections and IOs
===================

48
boards/atmel/sam0/samd21_xpro/doc/index.rst
View file

@ -23,53 +23,7 @@ Hardware
Supported Features
==================
The samd21_xpro 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
* - ADC
- on-chip
- Analog to Digital Converter
* - GPIO
- on-chip
- I/O ports
* - PWM
- on-chip
- Pulse Width Modulation
* - USART
- on-chip
- Serial ports
* - I2C
- on-chip
- I2C ports
* - SPI
- on-chip
- Serial Peripheral Interface ports
* - USB
- on-chip
- Universal Serial Bus device ports
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam0/samd21_xpro/samd21_xpro_defconfig`.
.. zephyr:board-supported-hw::
Pin Mapping
===========

56
boards/atmel/sam0/same54_xpro/doc/index.rst
View file

@ -36,61 +36,7 @@ Hardware
Supported Features
==================
The same54_xpro board configuration supports the following hardware
features:
+---------------+------------+----------------------------+
| Interface | Controller | Driver/Component |
+===============+============+============================+
| ADC | on-chip | adc |
+---------------+------------+----------------------------+
| DAC | on-chip | dac |
+---------------+------------+----------------------------+
| DMAC | on-chip | dma |
+---------------+------------+----------------------------+
| EEPROM | i2c | eeprom, EUI-48 MAC Address |
+---------------+------------+----------------------------+
| EIC | on-chip | interrupt_controller |
+---------------+------------+----------------------------+
| GMAC | on-chip | ethernet, mdio |
+---------------+------------+----------------------------+
| GPIO | on-chip | gpio |
+---------------+------------+----------------------------+
| MPU | on-chip | arch/arm |
+---------------+------------+----------------------------+
| NVIC | on-chip | arch/arm |
+---------------+------------+----------------------------+
| NVMCTRL | on-chip | flash |
+---------------+------------+----------------------------+
| PORT | on-chip | pinctrl |
+---------------+------------+----------------------------+
| RTC | on-chip | timer |
+---------------+------------+----------------------------+
| SERCOM I2C | on-chip | i2c |
+---------------+------------+----------------------------+
| SERCOM SPI | on-chip | spi |
+---------------+------------+----------------------------+
| SERCOM USART | on-chip | serial, console |
+---------------+------------+----------------------------+
| Serial Number | on-chip | hwinfo |
+---------------+------------+----------------------------+
| SYSTICK | on-chip | timer |
+---------------+------------+----------------------------+
| TC | on-chip | counter |
+---------------+------------+----------------------------+
| TCC | on-chip | counter, pwm |
+---------------+------------+----------------------------+
| TRNG | on-chip | entropy |
+---------------+------------+----------------------------+
| USB | on-chip | usb |
+---------------+------------+----------------------------+
| WDT | on-chip | watchdog |
+---------------+------------+----------------------------+
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam0/same54_xpro/same54_xpro_defconfig`.
.. zephyr:board-supported-hw::
Pin Mapping
===========

45
boards/atmel/sam0/saml21_xpro/doc/index.rst
View file

@ -23,50 +23,7 @@ Hardware
Supported Features
==================
The saml21_xpro 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
* - PWM
- on-chip
- Pulse Width Modulation
* - USART
- on-chip
- Serial ports
* - I2C
- on-chip
- I2C ports
* - SPI
- on-chip
- Serial Peripheral Interface ports
* - TRNG
- on-chip
- True Random Number Generator
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam0/saml21_xpro/saml21_xpro_defconfig`.
.. zephyr:board-supported-hw::
Pin Mapping
===========

28
boards/atmel/sam0/samr21_xpro/doc/index.rst
View file

@ -23,33 +23,7 @@ Hardware
Supported Features
==================
The samr21_xpro board configuration supports the following hardware
features:
+-----------+------------+--------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+======================================+
| NVIC | on-chip | nested vector interrupt controller |
+-----------+------------+--------------------------------------+
| SYSTICK | on-chip | systick |
+-----------+------------+--------------------------------------+
| WDT | on-chip | Watchdog |
+-----------+------------+--------------------------------------+
| GPIO | on-chip | I/O ports |
+-----------+------------+--------------------------------------+
| PWM | on-chip | Pulse Width Modulation |
+-----------+------------+--------------------------------------+
| USART | on-chip | Serial ports |
+-----------+------------+--------------------------------------+
| SPI | on-chip | Serial Peripheral Interface ports |
+-----------+------------+--------------------------------------+
| I2C | on-chip | I2C Peripheral Interface ports |
+-----------+------------+--------------------------------------+
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam0/samr21_xpro/samr21_xpro_defconfig`.
.. zephyr:board-supported-hw::
Pin Mapping
===========

58
boards/atmel/sam0/samr34_xpro/doc/index.rst
View file

@ -28,63 +28,7 @@ Hardware
Supported Features
==================
The samr34_xpro 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
* - PWM
- on-chip
- Pulse Width Modulation
* - USART
- on-chip
- Serial ports
* - I2C
- on-chip
- I2C ports
* - SPI
- on-chip
- Serial Peripheral Interface ports
* - TRNG
- on-chip
- True Random Number Generator
The following hardware features are supported by Zephyr, but not yet fully
supported by the SOC:
.. list-table::
:header-rows: 1
* - Interface
- Controller
- Driver / Component
* - LoRa Radio
- on-chip
- Internal SX1276 LoRa Radio
Other hardware features are not currently supported by Zephyr.
The default configuration can be found in the Kconfig
:zephyr_file:`boards/atmel/sam0/samr34_xpro/samr34_xpro_defconfig`.
.. zephyr:board-supported-hw::
Pin Mapping
===========