From e4b232d4fc1a4ebb9e0eb055230040b9b643f04a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Wed, 5 Mar 2025 12:01:05 +0100 Subject: [PATCH] doc: infineon: adopt zephyr:board-supported-hw directive MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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é --- .../infineon/cy8ckit_062s2_ai/doc/index.rst | 26 +---------- boards/infineon/cy8ckit_062s4/doc/index.rst | 20 +-------- .../cy8cproto_062_4343w/doc/index.rst | 22 +-------- .../infineon/cy8cproto_063_ble/doc/index.rst | 33 +------------- .../infineon/cyw920829m2evk_02/doc/index.rst | 21 +-------- boards/infineon/xmc45_relax_kit/doc/index.rst | 45 +------------------ boards/infineon/xmc47_relax_kit/doc/index.rst | 40 +---------------- 7 files changed, 8 insertions(+), 199 deletions(-) diff --git a/boards/infineon/cy8ckit_062s2_ai/doc/index.rst b/boards/infineon/cy8ckit_062s2_ai/doc/index.rst index 8395bcd98ce..5e86d2fcf59 100644 --- a/boards/infineon/cy8ckit_062s2_ai/doc/index.rst +++ b/boards/infineon/cy8ckit_062s2_ai/doc/index.rst @@ -28,31 +28,7 @@ For more information about the CY8C624ABZI-S2D44 MCU SoC and CY8CKIT-062S2-AI bo Supported Features ================== -The ``cy8ckit_062s2_ai/cy8c624abzi_s2d44`` board target supports the following hardware features: - -+-----------+------------+-----------------------+ -| Interface | Controller | Driver/Component | -+===========+============+=======================+ -| NVIC | on-chip | nested vectored | -| | | interrupt controller | -+-----------+------------+-----------------------+ -| SYSTICK | on-chip | system clock | -+-----------+------------+-----------------------+ -| GPIO | on-chip | GPIO | -+-----------+------------+-----------------------+ -| PINCTRL | on-chip | pin control | -+-----------+------------+-----------------------+ -| UART | on-chip | serial port-polling; | -| | | serial port-interrupt | -+-----------+------------+-----------------------+ -| WATCHDOG | on-chip | watchdog | -+-----------+------------+-----------------------+ - - -The default configuration can be found in the defconfig and dts files: - - - :zephyr_file:`boards/infineon/cy8ckit_062s2_ai/cy8ckit_062s2_ai_defconfig` - - :zephyr_file:`boards/infineon/cy8ckit_062s2_ai/cy8ckit_062s2_ai.dts` +.. zephyr:board-supported-hw:: System Clock ============ diff --git a/boards/infineon/cy8ckit_062s4/doc/index.rst b/boards/infineon/cy8ckit_062s4/doc/index.rst index b5e3e39cc1d..3b21e620ae3 100644 --- a/boards/infineon/cy8ckit_062s4/doc/index.rst +++ b/boards/infineon/cy8ckit_062s4/doc/index.rst @@ -24,25 +24,7 @@ Hardware Supported Features ================== -The board configuration supports the following hardware features: - -+-----------+------------+-----------------------+ -| Interface | Controller | Driver/Component | -+===========+============+=======================+ -| NVIC | on-chip | nested vectored | -| | | interrupt controller | -+-----------+------------+-----------------------+ -| SYSTICK | on-chip | system clock | -+-----------+------------+-----------------------+ -| PINCTRL | on-chip | pin control | -+-----------+------------+-----------------------+ -| UART | on-chip | serial port-polling; | -+-----------+------------+-----------------------+ - - -The default configuration can be found in the Kconfig - -:zephyr_file:`boards/infineon/cy8ckit_062s4/cy8ckit_062s4_defconfig` +.. zephyr:board-supported-hw:: Clock Configuration =================== diff --git a/boards/infineon/cy8cproto_062_4343w/doc/index.rst b/boards/infineon/cy8cproto_062_4343w/doc/index.rst index f04c28e5d00..874cf62c2ee 100644 --- a/boards/infineon/cy8cproto_062_4343w/doc/index.rst +++ b/boards/infineon/cy8cproto_062_4343w/doc/index.rst @@ -49,27 +49,7 @@ Kit Contents: Supported Features ================== -The board configuration supports the following hardware features: - -+-----------+------------+-----------------------+ -| Interface | Controller | Driver/Component | -+===========+============+=======================+ -| NVIC | on-chip | nested vectored | -| | | interrupt controller | -+-----------+------------+-----------------------+ -| SYSTICK | on-chip | system clock | -+-----------+------------+-----------------------+ -| GPIO | on-chip | GPIO | -+-----------+------------+-----------------------+ -| UART | on-chip | serial port-polling; | -| | | serial port-interrupt | -+-----------+------------+-----------------------+ - - -The default configuration can be found in the Kconfig - -:zephyr_file:`boards/infineon/cy8cproto_062_4343w/cy8cproto_062_4343w_defconfig` - +.. zephyr:board-supported-hw:: System Clock ============ diff --git a/boards/infineon/cy8cproto_063_ble/doc/index.rst b/boards/infineon/cy8cproto_063_ble/doc/index.rst index 90623b80382..97f43705f74 100644 --- a/boards/infineon/cy8cproto_063_ble/doc/index.rst +++ b/boards/infineon/cy8cproto_063_ble/doc/index.rst @@ -22,38 +22,7 @@ For more information about the PSOC 63 BLE MCU SoC and CY8CPROTO-063-BLE board: Supported Features ================== -The board configuration supports the following hardware features: - -+-----------+------------+-----------------------+ -| Interface | Controller | Driver/Component | -+===========+============+=======================+ -| NVIC | on-chip | nested vectored | -| | | interrupt controller | -+-----------+------------+-----------------------+ -| SYSTICK | on-chip | system clock | -+-----------+------------+-----------------------+ -| GPIO | on-chip | GPIO | -+-----------+------------+-----------------------+ -| PINCTRL | on-chip | pin control | -+-----------+------------+-----------------------+ -| SPI | on-chip | SPI | -+-----------+------------+-----------------------+ -| UART | on-chip | serial port-polling; | -| | | serial port-interrupt | -+-----------+------------+-----------------------+ -| I2C | on-chip | I2C | -+-----------+------------+-----------------------+ -| PWM | on-chip | PWM | -+-----------+------------+-----------------------+ -| Counter | on-chip | Counter | -+-----------+------------+-----------------------+ -| Bluetooth | on-chip | Bluetooth | -+-----------+------------+-----------------------+ - - -The default configuration can be found in the Kconfig - -:zephyr_file:`boards/infineon/cy8cproto_063_ble/cy8cproto_063_ble_defconfig` +.. zephyr:board-supported-hw:: System Clock ============ diff --git a/boards/infineon/cyw920829m2evk_02/doc/index.rst b/boards/infineon/cyw920829m2evk_02/doc/index.rst index d4c5193c382..5b23cff9bd4 100644 --- a/boards/infineon/cyw920829m2evk_02/doc/index.rst +++ b/boards/infineon/cyw920829m2evk_02/doc/index.rst @@ -36,26 +36,7 @@ Kit Contents: Supported Features ================== -The board configuration supports the following hardware features: - -+-----------+------------+-----------------------+ -| Interface | Controller | Driver/Component | -+===========+============+=======================+ -| NVIC | on-chip | nested vectored | -| | | interrupt controller | -+-----------+------------+-----------------------+ -| SYSTICK | on-chip | system clock | -+-----------+------------+-----------------------+ -| GPIO | on-chip | GPIO | -+-----------+------------+-----------------------+ -| UART | on-chip | serial port-polling; | -| | | serial port-interrupt | -+-----------+------------+-----------------------+ - - -The default configuration can be found in the Kconfig - -:zephyr_file:`boards/infineon/cyw920829m2evk_02/cyw920829m2evk_02_defconfig` +.. zephyr:board-supported-hw:: System Clock ============ diff --git a/boards/infineon/xmc45_relax_kit/doc/index.rst b/boards/infineon/xmc45_relax_kit/doc/index.rst index bfad619aedc..f26d4534461 100644 --- a/boards/infineon/xmc45_relax_kit/doc/index.rst +++ b/boards/infineon/xmc45_relax_kit/doc/index.rst @@ -22,50 +22,9 @@ Details on the Relax Kit development board can be found in the `Relax Kit User M Supported Features ================== -* The on-board 12-MHz crystal allows the device to run at its maximum operating speed of 120MHz. +.. zephyr:board-supported-hw:: -The Relax Kit development board configuration supports the following hardware features: - -+-----------+------------+-----------------------+ -| Interface | Controller | Driver/Component | -+===========+============+=======================+ -| NVIC | on-chip | nested vectored | -| | | interrupt controller | -+-----------+------------+-----------------------+ -| SYSTICK | on-chip | system clock | -+-----------+------------+-----------------------+ -| UART | on-chip | serial port | -+-----------+------------+-----------------------+ -| SPI | on-chip | spi | -+-----------+------------+-----------------------+ -| GPIO | on-chip | gpio | -+-----------+------------+-----------------------+ -| FLASH | on-chip | flash | -+-----------+------------+-----------------------+ -| ADC | on-chip | adc | -+-----------+------------+-----------------------+ -| DMA | on-chip | dma | -+-----------+------------+-----------------------+ -| PWM | on-chip | pwm | -+-----------+------------+-----------------------+ -| WATCHDOG | on-chip | watchdog | -+-----------+------------+-----------------------+ -| MDIO | on-chip | mdio | -+-----------+------------+-----------------------+ -| ETHERNET | on-chip | ethernet | -+-----------+------------+-----------------------+ -| PTP | on-chip | ethernet | -+-----------+------------+-----------------------+ -| RTC | on-chip | rtc | -+-----------+------------+-----------------------+ - -More details about the supported peripherals are available in `XMC4500 TRM`_ - -The default configuration can be found in the Kconfig - -:zephyr_file:`boards/infineon/xmc45_relax_kit/xmc45_relax_kit_defconfig` - -Other hardware features are not currently supported by the Zephyr kernel. +The on-board 12-MHz crystal allows the device to run at its maximum operating speed of 120MHz. Build hello world sample ************************ diff --git a/boards/infineon/xmc47_relax_kit/doc/index.rst b/boards/infineon/xmc47_relax_kit/doc/index.rst index d5796afd7ea..78b2d25fe6a 100644 --- a/boards/infineon/xmc47_relax_kit/doc/index.rst +++ b/boards/infineon/xmc47_relax_kit/doc/index.rst @@ -27,47 +27,9 @@ Details on the Relax Kit development board can be found in the `Relax Kit User M Supported Features ================== -The Relax Kit development board configuration supports the following hardware features: - -+-----------+------------+-----------------------+ -| Interface | Controller | Driver/Component | -+===========+============+=======================+ -| NVIC | on-chip | nested vectored | -| | | interrupt controller | -+-----------+------------+-----------------------+ -| SYSTICK | on-chip | system clock | -+-----------+------------+-----------------------+ -| UART | on-chip | serial port | -+-----------+------------+-----------------------+ -| SPI | on-chip | spi | -+-----------+------------+-----------------------+ -| GPIO | on-chip | gpio | -+-----------+------------+-----------------------+ -| FLASH | on-chip | flash | -+-----------+------------+-----------------------+ -| ADC | on-chip | adc | -+-----------+------------+-----------------------+ -| DMA | on-chip | dma | -+-----------+------------+-----------------------+ -| PWM | on-chip | pwm | -+-----------+------------+-----------------------+ -| WATCHDOG | on-chip | watchdog | -+-----------+------------+-----------------------+ -| MDIO | on-chip | mdio | -+-----------+------------+-----------------------+ -| ETHERNET | on-chip | ethernet | -+-----------+------------+-----------------------+ -| PTP | on-chip | ethernet | -+-----------+------------+-----------------------+ -| RTC | on-chip | rtc | -+-----------+------------+-----------------------+ +.. zephyr:board-supported-hw:: More details about the supported peripherals are available in `XMC4700 TRM`_ -Other hardware features are not currently supported by the Zephyr kernel. - -The default configuration can be found in the Kconfig - -:zephyr_file:`boards/infineon/xmc47_relax_kit/xmc47_relax_kit_defconfig` Build hello world sample ************************