michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: dts: explain the usage of pre_dt_shield.cmake

Browse source 
Mention the possible use of pre_dt_shield.cmake in the devicetree and
shield documentation.

Signed-off-by: Paul Schaetzle <paulschaetzle@mailbox.org>
This commit is contained in:
Paul Schaetzle 2025-05-05 13:35:42 +02:00 • committed by Benjamin Cabé
commit 9b1969a206
2 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
doc/build/dts/intro-input-output.rst vendored
View file

@ -112,6 +112,9 @@ this:
list(APPEND EXTRA_DTC_FLAGS "-Wno-simple_bus_reg") list(APPEND EXTRA_DTC_FLAGS "-Wno-simple_bus_reg")
Shield directories can contain a file named :file:`pre_dt_shield.cmake` which
has the same functionality as the aforementioned :file:`pre_dt_board.cmake`.
.. _dt-outputs: .. _dt-outputs:
Output files Output files

6
doc/hardware/porting/shields.rst
View file

@ -19,7 +19,8 @@ under :zephyr_file:`boards/shields`:
boards/shields/<shield> boards/shields/<shield>
├── <shield>.overlay ├── <shield>.overlay
├── Kconfig.shield ├── Kconfig.shield
└── Kconfig.defconfig ├── Kconfig.defconfig
└── pre_dt_shield.cmake
These files provides shield configuration as follows: These files provides shield configuration as follows:
@ -37,6 +38,9 @@ These files provides shield configuration as follows:
shield configuration should be done by keeping in mind that features shield configuration should be done by keeping in mind that features
activation is application responsibility. activation is application responsibility.
* **pre_dt_shield.cmake**: This optional file can be used to pass additional
arguments to the devicetree compiler ``dtc``.
Besides, in order to avoid name conflicts with devices that may be defined at Besides, in order to avoid name conflicts with devices that may be defined at
board level, it is advised, specifically for shields devicetree descriptions, board level, it is advised, specifically for shields devicetree descriptions,
to provide a device nodelabel is the form <device>_<shield>, for instance: to provide a device nodelabel is the form <device>_<shield>, for instance: