Skip to content

Commit 9b1969a

Browse files
PaulSchaetzlekartben
authored andcommitted
doc: dts: explain the usage of pre_dt_shield.cmake
Mention the possible use of pre_dt_shield.cmake in the devicetree and shield documentation. Signed-off-by: Paul Schaetzle <paulschaetzle@mailbox.org>
1 parent 269799e commit 9b1969a

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

doc/build/dts/intro-input-output.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,9 @@ this:
112112
113113
list(APPEND EXTRA_DTC_FLAGS "-Wno-simple_bus_reg")
114114
115+
Shield directories can contain a file named :file:`pre_dt_shield.cmake` which
116+
has the same functionality as the aforementioned :file:`pre_dt_board.cmake`.
117+
115118
.. _dt-outputs:
116119

117120
Output files

doc/hardware/porting/shields.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ under :zephyr_file:`boards/shields`:
1919
boards/shields/<shield>
2020
├── <shield>.overlay
2121
├── Kconfig.shield
22-
└── Kconfig.defconfig
22+
├── Kconfig.defconfig
23+
└── pre_dt_shield.cmake
2324
2425
These files provides shield configuration as follows:
2526

@@ -37,6 +38,9 @@ These files provides shield configuration as follows:
3738
shield configuration should be done by keeping in mind that features
3839
activation is application responsibility.
3940

41+
* **pre_dt_shield.cmake**: This optional file can be used to pass additional
42+
arguments to the devicetree compiler ``dtc``.
43+
4044
Besides, in order to avoid name conflicts with devices that may be defined at
4145
board level, it is advised, specifically for shields devicetree descriptions,
4246
to provide a device nodelabel is the form <device>_<shield>, for instance:

0 commit comments

Comments
 (0)