mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-28 07:05:20 +00:00
444964e031
Add a new hardware features filter to the board catalog that allows users to filter boards based on their supported hardware capabilities. The features are extracted from the devicetree files and organized by binding type. Key changes: - Extract hardware feature descriptions from devicetree bindings - Add HW_FEATURES_TURBO_MODE option to skip feature generation for faster builds (similar to DT_TURBO_MODE) - Add tag-based UI for filtering boards by hardware features The feature can be disabled for faster documentation builds using -DHW_FEATURES_TURBO_MODE=1 or by using 'make html-fast'. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
54 lines
1.6 KiB
ReStructuredText
54 lines
1.6 KiB
ReStructuredText
.. _boards:
|
|
|
|
Supported Boards and Shields
|
|
############################
|
|
|
|
If you are looking to add Zephyr support for a new board, please start with the
|
|
:ref:`board_porting_guide`.
|
|
|
|
When adding support documentation for a board, remember to use the template
|
|
available under :zephyr_file:`doc/templates/board.tmpl`.
|
|
|
|
Shields are hardware add-ons that can be stacked on top of a board to add extra
|
|
functionality. They are listed separately from boards, towards :ref:`the end of
|
|
this page <boards-shields>`.
|
|
|
|
.. admonition:: Search Tips
|
|
:class: dropdown
|
|
|
|
* Use the form below to filter the list of supported boards. If a field is left empty, it will
|
|
not be used in the filtering process.
|
|
|
|
* A board must meet **all** criteria selected across different fields. For example, if you select
|
|
both a vendor and an architecture, only boards that match both will be displayed. Within a
|
|
single field, selecting multiple options (such as two architectures) will show boards matching
|
|
**either** option.
|
|
|
|
* The list of supported hardware features for each board is automatically generated using
|
|
information from the Devicetree. It may not be reflecting the full list of supported features
|
|
since some of them may not be enabled by default.
|
|
|
|
* Can't find your exact board? Don't worry! If a similar board with the same or a closely related
|
|
MCU exists, you can use it as a :ref:`starting point <create-your-board-directory>` for adding
|
|
support for your own board.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:glob:
|
|
:hidden:
|
|
|
|
*/index
|
|
|
|
.. zephyr:board-catalog::
|
|
|
|
.. _boards-shields:
|
|
|
|
Shields
|
|
#######
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
shields/**/*
|