Skip to content

Commit 9abfc83

Browse files
kartbenkartben
committed
doc: nxp: adopt zephyr:board-supported-hw directive
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>
1 parent f61c94b commit 9abfc83

File tree

57 files changed

+197
-2437
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+197
-2437
lines changed

‎boards/nxp/frdm_k22f/doc/index.rst

Lines changed: 9 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -50,55 +50,15 @@ For more information about the K22F SoC and FRDM-K22F board:
5050
Supported Features
5151
==================
5252

53-
The frdm_k22f board configuration supports the hardware features listed
54-
below. For additional features not yet supported, please also refer to the
55-
:zephyr:board:`frdm_k64f`, which is the superset board in NXP's Kinetis K series.
56-
NXP prioritizes enabling the superset board with NXP's Full Platform Support for
57-
Zephyr. Therefore, the frdm_k64f board may have additional features
58-
already supported, which can also be re-used on this frdm_k22f board:
59-
60-
+-----------+------------+-------------------------------------+
61-
| Interface | Controller | Driver/Component |
62-
+===========+============+=====================================+
63-
| NVIC | on-chip | nested vector interrupt controller |
64-
+-----------+------------+-------------------------------------+
65-
| SYSTICK | on-chip | systick |
66-
+-----------+------------+-------------------------------------+
67-
| PINMUX | on-chip | pinmux |
68-
+-----------+------------+-------------------------------------+
69-
| GPIO | on-chip | gpio |
70-
+-----------+------------+-------------------------------------+
71-
| I2C | on-chip | i2c |
72-
+-----------+------------+-------------------------------------+
73-
| SPI | on-chip | spi |
74-
+-----------+------------+-------------------------------------+
75-
| WATCHDOG | on-chip | watchdog |
76-
+-----------+------------+-------------------------------------+
77-
| ADC | on-chip | adc |
78-
+-----------+------------+-------------------------------------+
79-
| PWM | on-chip | pwm |
80-
+-----------+------------+-------------------------------------+
81-
| UART | on-chip | serial port-polling; |
82-
| | | serial port-interrupt |
83-
+-----------+------------+-------------------------------------+
84-
| FLASH | on-chip | soc flash |
85-
+-----------+------------+-------------------------------------+
86-
| USB | on-chip | USB device |
87-
+-----------+------------+-------------------------------------+
88-
| SENSOR | off-chip | fxos8700 polling; |
89-
| | | fxos8700 trigger |
90-
+-----------+------------+-------------------------------------+
91-
| RNGA | on-chip | entropy; |
92-
| | | random |
93-
+-----------+------------+-------------------------------------+
94-
| FTFE | on-chip | flash programming |
95-
+-----------+------------+-------------------------------------+
96-
97-
The default configuration can be found in the defconfig file:
98-
99-
:zephyr_file:`boards/nxp/frdm_k22f/frdm_k22f_defconfig`
100-
101-
Other hardware features are not currently supported by the port.
53+
.. zephyr:board-supported-hw::
54+
55+
.. note::
56+
57+
For additional features not yet supported, please also refer to the
58+
:zephyr:board:`frdm_k64f`, which is the superset board in NXP's Kinetis K series.
59+
NXP prioritizes enabling the superset board with NXP's Full Platform Support for
60+
Zephyr. Therefore, the frdm_k64f board may have additional features
61+
already supported, which can also be re-used on this frdm_k22f board.
10262

10363
Connections and IOs
10464
===================

‎boards/nxp/frdm_k64f/doc/index.rst

Lines changed: 3 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -54,62 +54,9 @@ Supported Features
5454
NXP considers the FRDM-K64F as the superset board for the Kinetis K
5555
series of MCUs. This board is a focus for NXP's Full Platform Support for
5656
Zephyr, to better enable the entire Kinetis K series. NXP prioritizes enabling
57-
this board with new support for Zephyr features. The frdm_k64f board
58-
configuration supports the following hardware features:
59-
60-
+-----------+------------+-------------------------------------+
61-
| Interface | Controller | Driver/Component |
62-
+===========+============+=====================================+
63-
| NVIC | on-chip | nested vector interrupt controller |
64-
+-----------+------------+-------------------------------------+
65-
| SYSTICK | on-chip | systick |
66-
+-----------+------------+-------------------------------------+
67-
| PINMUX | on-chip | pinmux |
68-
+-----------+------------+-------------------------------------+
69-
| GPIO | on-chip | gpio |
70-
+-----------+------------+-------------------------------------+
71-
| I2C | on-chip | i2c |
72-
+-----------+------------+-------------------------------------+
73-
| SPI | on-chip | spi |
74-
+-----------+------------+-------------------------------------+
75-
| WATCHDOG | on-chip | watchdog |
76-
+-----------+------------+-------------------------------------+
77-
| ADC | on-chip | adc |
78-
+-----------+------------+-------------------------------------+
79-
| DAC | on-chip | dac |
80-
+-----------+------------+-------------------------------------+
81-
| PWM | on-chip | pwm |
82-
+-----------+------------+-------------------------------------+
83-
| ETHERNET | on-chip | ethernet |
84-
+-----------+------------+-------------------------------------+
85-
| UART | on-chip | serial port-polling; |
86-
| | | serial port-interrupt |
87-
+-----------+------------+-------------------------------------+
88-
| FLASH | on-chip | soc flash |
89-
+-----------+------------+-------------------------------------+
90-
| USB | on-chip | USB device |
91-
+-----------+------------+-------------------------------------+
92-
| SENSOR | off-chip | fxos8700 polling; |
93-
| | | fxos8700 trigger |
94-
+-----------+------------+-------------------------------------+
95-
| CAN | on-chip | can |
96-
+-----------+------------+-------------------------------------+
97-
| RTC | on-chip | rtc |
98-
+-----------+------------+-------------------------------------+
99-
| DMA | on-chip | dma |
100-
+-----------+------------+-------------------------------------+
101-
| RNGA | on-chip | entropy; |
102-
| | | random |
103-
+-----------+------------+-------------------------------------+
104-
| FTFE | on-chip | flash programming |
105-
+-----------+------------+-------------------------------------+
106-
| PIT | on-chip | pit |
107-
+-----------+------------+-------------------------------------+
108-
109-
The default configuration can be found in
110-
:zephyr_file:`boards/nxp/frdm_k64f/frdm_k64f_defconfig`
111-
112-
Other hardware features are not currently supported by the port.
57+
this board with new support for Zephyr features.
58+
59+
.. zephyr:board-supported-hw::
11360
11461
Connections and IOs
11562
===================

‎boards/nxp/frdm_k82f/doc/index.rst

Lines changed: 9 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -51,59 +51,15 @@ For more information about the K82F SoC and FRDM-K82F board:
5151
Supported Features
5252
==================
5353

54-
The frdm_k82f board configuration supports the hardware features listed
55-
below. For additional features not yet supported, please also refer to the
56-
:zephyr:board:`frdm_k64f`, which is the superset board in NXP's Kinetis K series.
57-
NXP prioritizes enabling the superset board with NXP's Full Platform Support for
58-
Zephyr. Therefore, the frdm_k64f board may have additional features
59-
already supported, which can also be re-used on this frdm_k82f board:
60-
61-
+-----------+------------+-------------------------------------+
62-
| Interface | Controller | Driver/Component |
63-
+===========+============+=====================================+
64-
| NVIC | on-chip | nested vector interrupt controller |
65-
+-----------+------------+-------------------------------------+
66-
| SYSTICK | on-chip | systick |
67-
+-----------+------------+-------------------------------------+
68-
| PINMUX | on-chip | pinmux |
69-
+-----------+------------+-------------------------------------+
70-
| ADC | on-chip | adc |
71-
+-----------+------------+-------------------------------------+
72-
| FLASH | on-chip | soc flash |
73-
+-----------+------------+-------------------------------------+
74-
| FLASH | off-chip | QSPI flash |
75-
+-----------+------------+-------------------------------------+
76-
| GPIO | on-chip | gpio |
77-
+-----------+------------+-------------------------------------+
78-
| I2C | on-chip | i2c |
79-
+-----------+------------+-------------------------------------+
80-
| PWM | on-chip | pwm |
81-
+-----------+------------+-------------------------------------+
82-
| RTC | on-chip | rtc |
83-
+-----------+------------+-------------------------------------+
84-
| SENSOR | off-chip | fxos8700 polling; |
85-
| | | fxos8700 trigger |
86-
+-----------+------------+-------------------------------------+
87-
| SPI | on-chip | spi |
88-
+-----------+------------+-------------------------------------+
89-
| UART | on-chip | serial port-polling; |
90-
| | | serial port-interrupt |
91-
+-----------+------------+-------------------------------------+
92-
| USB | on-chip | USB device |
93-
+-----------+------------+-------------------------------------+
94-
| WATCHDOG | on-chip | watchdog |
95-
+-----------+------------+-------------------------------------+
96-
| TRNG | on-chip | entropy |
97-
+-----------+------------+-------------------------------------+
98-
| FTFA | on-chip | flash programming |
99-
+-----------+------------+-------------------------------------+
100-
| PIT | on-chip | pit |
101-
+-----------+------------+-------------------------------------+
102-
103-
The default configuration can be found in
104-
:zephyr_file:`boards/nxp/frdm_k82f/frdm_k82f_defconfig`
105-
106-
Other hardware features are not currently supported by the port.
54+
.. zephyr:board-supported-hw::
55+
56+
.. note::
57+
58+
For additional features not yet supported, please also refer to the
59+
:zephyr:board:`frdm_k64f`, which is the superset board in NXP's Kinetis K series.
60+
NXP prioritizes enabling the superset board with NXP's Full Platform Support for
61+
Zephyr. Therefore, the frdm_k64f board may have additional features
62+
already supported, which can also be re-used on this frdm_k82f board.
10763

10864
System Clock
10965
============

‎boards/nxp/frdm_ke15z/doc/index.rst

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -32,26 +32,7 @@ these NXP reference documents:
3232
Supported Features
3333
==================
3434

35-
The frdm_ke15z board configuration supports the following hardware
36-
features:
37-
38-
+-----------+------------+-------------------------------------+
39-
| Interface | Controller | Driver/Component |
40-
+===========+============+=====================================+
41-
| NVIC | on-chip | nested vector interrupt controller |
42-
+-----------+------------+-------------------------------------+
43-
| SYSTICK | on-chip | systick |
44-
+-----------+------------+-------------------------------------+
45-
| GPIO | on-chip | gpio |
46-
+-----------+------------+-------------------------------------+
47-
| UART | on-chip | uart polling; |
48-
| | | uart interrupt |
49-
+-----------+------------+-------------------------------------+
50-
51-
The default configuration can be found in the defconfig file:
52-
:zephyr_file:`boards/nxp/frdm_ke15z/frdm_ke15z_defconfig`.
53-
54-
Other hardware features are not currently supported by the port.
35+
.. zephyr:board-supported-hw::
5536
5637
System Clock
5738
============

‎boards/nxp/frdm_ke17z/doc/index.rst

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -34,43 +34,7 @@ these NXP reference documents:
3434
Supported Features
3535
==================
3636

37-
The frdm_ke17z board configuration supports the following hardware
38-
features:
39-
40-
+-----------+------------+-------------------------------------+
41-
| Interface | Controller | Driver/Component |
42-
+===========+============+=====================================+
43-
| NVIC | on-chip | nested vector interrupt controller |
44-
+-----------+------------+-------------------------------------+
45-
| SYSTICK | on-chip | systick |
46-
+-----------+------------+-------------------------------------+
47-
| PINCTRL | on-chip | pinctrl |
48-
+-----------+------------+-------------------------------------+
49-
| ADC | on-chip | adc |
50-
+-----------+------------+-------------------------------------+
51-
| GPIO | on-chip | gpio |
52-
+-----------+------------+-------------------------------------+
53-
| LPTMR | on-chip | counter |
54-
+-----------+------------+-------------------------------------+
55-
| UART | on-chip | uart |
56-
+-----------+------------+-------------------------------------+
57-
| SPI | on-chip | spi |
58-
+-----------+------------+-------------------------------------+
59-
| DMA | on-chip | dma |
60-
+-----------+------------+-------------------------------------+
61-
| FTM | on-chip | pwm |
62-
+-----------+------------+-------------------------------------+
63-
| I2C | on-chip | i2c |
64-
+-----------+------------+-------------------------------------+
65-
| ACMP | on-chip | sensor |
66-
+-----------+------------+-------------------------------------+
67-
| WATCHDOG | on-chip | watchdog |
68-
+-----------+------------+-------------------------------------+
69-
70-
The default configuration can be found in the defconfig file:
71-
:zephyr_file:`boards/nxp/frdm_ke17z/frdm_ke17z_defconfig`.
72-
73-
Other hardware features are not currently supported by the port.
37+
.. zephyr:board-supported-hw::
7438
7539
System Clock
7640
============

‎boards/nxp/frdm_ke17z512/doc/index.rst

Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -35,44 +35,7 @@ these NXP reference documents:
3535
Supported Features
3636
==================
3737

38-
The frdm_ke17z512 board configuration supports the following hardware
39-
features:
40-
41-
+-----------+------------+-------------------------------------+
42-
| Interface | Controller | Driver/Component |
43-
+===========+============+=====================================+
44-
| NVIC | on-chip | nested vector interrupt controller |
45-
+-----------+------------+-------------------------------------+
46-
| SYSTICK | on-chip | systick |
47-
+-----------+------------+-------------------------------------+
48-
| ADC | on-chip | adc |
49-
+-----------+------------+-------------------------------------+
50-
| GPIO | on-chip | gpio |
51-
+-----------+------------+-------------------------------------+
52-
| LPTMR | on-chip | counter |
53-
+-----------+------------+-------------------------------------+
54-
| UART | on-chip | uart polling; |
55-
| | | uart interrupt |
56-
+-----------+------------+-------------------------------------+
57-
| FTM | on-chip | pwm |
58-
+-----------+------------+-------------------------------------+
59-
| I2C | on-chip | I2C |
60-
+-----------+------------+-------------------------------------+
61-
| RTC | on-chip | counter |
62-
+-----------+------------+-------------------------------------+
63-
| ACMP | on-chip | sensor |
64-
+-----------+------------+-------------------------------------+
65-
| SPI | on-chip | spi |
66-
+-----------+------------+-------------------------------------+
67-
| DMA | on-chip | dma |
68-
+-----------+------------+-------------------------------------+
69-
| WATCHDOG | on-chip | watchdog |
70-
+-----------+------------+-------------------------------------+
71-
72-
The default configuration can be found in the defconfig file:
73-
``boards/nxp/frdm_ke17z512/frdm_ke17z512_defconfig``.
74-
75-
Other hardware features are not currently supported by the port.
38+
.. zephyr:board-supported-hw::
7639
7740
System Clock
7841
============

‎boards/nxp/frdm_kl25z/doc/index.rst

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -30,35 +30,7 @@ For more information about the KL25Z SoC and FRDM-KL25Z board:
3030
Supported Features
3131
==================
3232

33-
The frdm_kl25z board configuration supports the following hardware features:
34-
35-
+-----------+------------+-------------------------------------+
36-
| Interface | Controller | Driver/Component |
37-
+===========+============+=====================================+
38-
| NVIC | on-chip | nested vector interrupt controller |
39-
+-----------+------------+-------------------------------------+
40-
| SYSTICK | on-chip | systick |
41-
+-----------+------------+-------------------------------------+
42-
| PINMUX | on-chip | pinmux |
43-
+-----------+------------+-------------------------------------+
44-
| GPIO | on-chip | gpio |
45-
+-----------+------------+-------------------------------------+
46-
| UART | on-chip | serial port-polling; |
47-
| | | serial port-interrupt |
48-
+-----------+------------+-------------------------------------+
49-
| I2C | on-chip | i2c |
50-
+-----------+------------+-------------------------------------+
51-
| ADC | on-chip | adc |
52-
+-----------+------------+-------------------------------------+
53-
| FLASH | on-chip | soc flash |
54-
+-----------+------------+-------------------------------------+
55-
| USB | on-chip | USB device |
56-
+-----------+------------+-------------------------------------+
57-
58-
The default configuration can be found in
59-
:zephyr_file:`boards/nxp/frdm_kl25z/frdm_kl25z_defconfig`
60-
61-
Other hardware features are not currently supported by the port.
33+
.. zephyr:board-supported-hw::
6234
6335
Connections and IOs
6436
===================

0 commit comments

Comments
 (0)