michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: mikroe: 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:03 +01:00 • committed by Fabio Baltieri
commit 3bc3340d22
4 changed files with 4 additions and 102 deletions
Download patch file Download diff file Expand all files Collapse all files

25
boards/mikroe/clicker_2/doc/mikroe_clicker_2.rst
View file

@ -21,31 +21,8 @@ to the microcontroller.
Supported Features Supported Features
================== ==================
The Zephyr MikroE Clicker 2 configuration supports the following hardware features:
+-----------+------------+-------------------------------------+ .. zephyr:board-supported-hw::
| Interface | Controller | Driver/Component |
+===========+============+=====================================+
| NVIC | on-chip | nested vector interrupt controller |
+-----------+------------+-------------------------------------+
| UART | on-chip | serial port-polling; |
| | | serial port-interrupt |
+-----------+------------+-------------------------------------+
| PINMUX | on-chip | pinmux |
+-----------+------------+-------------------------------------+
| I2C | on-chip | i2c |
+-----------+------------+-------------------------------------+
| SPI | on-chip | spi |
+-----------+------------+-------------------------------------+
| ADC | on-chip | adc |
+-----------+------------+-------------------------------------+
| USB | on-chip | usb |
+-----------+------------+-------------------------------------+
Other hardware features have not been enabled yet for this board.
The default configuration can be found in
:zephyr_file:`boards/mikroe/clicker_2/mikroe_clicker_2_defconfig`
Connections and IOs Connections and IOs
=================== ===================

21
boards/mikroe/clicker_ra4m1/doc/index.rst
View file

@ -18,26 +18,7 @@ development board see the `Clicker RA4M1 website`_.
Supported Features Supported Features
================== ==================
The Zephyr Mikroe Clicker RA4M1 configuration supports the following hardware .. zephyr:board-supported-hw::
features:
+-----------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+=====================================+
| NVIC | on-chip | nested vector interrupt controller |
+-----------+------------+-------------------------------------+
| UART | on-chip | serial port-polling |
+-----------+------------+-------------------------------------+
| PINMUX | on-chip | pinmux |
+-----------+------------+-------------------------------------+
| GPIO | on-chip | GPIO output |
| | | GPIO input |
+-----------+------------+-------------------------------------+
Other hardware features have not been enabled yet for this board.
The default configuration can be found in the defconfig file:
:zephyr_file:`boards/mikroe/clicker_ra4m1/mikroe_clicker_ra4m1_defconfig`.
Programming and debugging Programming and debugging
************************* *************************

32
boards/mikroe/mini_m4_for_stm32/doc/mikroe_mini_m4_for_stm32.rst
View file

@ -49,37 +49,7 @@ The board can be flashed by using STLinkV2 with the following connections.
Supported Features Supported Features
================== ==================
The MINI-M4 for STM32 board configuration supports the following hardware .. zephyr:board-supported-hw::
features:
+-----------+------------+----------------------+
| Interface | Controller | Driver/Component |
+===========+============+======================+
| CRYP | on-chip | crypto |
+-----------+------------+----------------------+
| NVIC | on-chip | nested vectored |
| | | interrupt controller |
+-----------+------------+----------------------+
| PINMUX | on-chip | pinmux |
+-----------+------------+----------------------+
| UART | on-chip | serial port |
+-----------+------------+----------------------+
| GPIO | on-chip | gpio |
+-----------+------------+----------------------+
| I2C | on-chip | i2c |
+-----------+------------+----------------------+
| SPI | on-chip | spi |
+-----------+------------+----------------------+
| PWM | on-chip | PWM |
+-----------+------------+----------------------+
| USB | on-chip | USB |
+-----------+------------+----------------------+
Other hardware features have not been enabled yet for this board.
The default configuration can be found in
:zephyr_file:`boards/mikroe/mini_m4_for_stm32/mikroe_mini_m4_for_stm32_defconfig`
Serial Port Serial Port
=========== ===========

28
boards/mikroe/stm32_m4_clicker/doc/index.rst
View file

@ -18,33 +18,7 @@ board see the `STM32 M4 Clicker website`_.
Supported Features Supported Features
================== ==================
The ``mikroe_stm32_m4_clicker`` board target supports the following hardware .. zephyr:board-supported-hw::
features:
+-----------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+=====================================+
| NVIC | on-chip | nested vector interrupt controller |
+-----------+------------+-------------------------------------+
| UART | on-chip | serial port-polling; |
| | | serial port-interrupt |
+-----------+------------+-------------------------------------+
| PINMUX | on-chip | pinmux |
+-----------+------------+-------------------------------------+
| I2C | on-chip | i2c |
+-----------+------------+-------------------------------------+
| SPI | on-chip | spi |
+-----------+------------+-------------------------------------+
| GPIO | on-chip | GPIO output |
| | | GPIO input |
+-----------+------------+-------------------------------------+
| USB | on-chip | USB |
+-----------+------------+-------------------------------------+
Other hardware features have not yet been enabled for this board.
The default configuration can be found in the defconfig file:
:zephyr_file:`boards/mikroe/stm32_m4_clicker/mikroe_stm32_m4_clicker_defconfig`.
Programming and debugging Programming and debugging
************************* *************************