Skip to content

Commit af46765

Browse files
nordicjmfabiobaltieri
authored andcommitted
doc: build: Add details on SoC overlays
Adds details about Kconfig fragments and devicetree overlay files that will be included in a build if they are found in the ``socs`` folder Signed-off-by: Jamie McCrae <[email protected]>
1 parent da3007e commit af46765

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

doc/build/dts/howtos.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -237,11 +237,10 @@ If you don't set :makevar:`DTC_OVERLAY_FILE`, the build system will follow
237237
these steps, looking for files in your application configuration directory to
238238
use as devicetree overlays:
239239

240-
#. If the file :file:`boards/<BOARD>.overlay` exists, it will be used.
240+
#. If the file :file:`socs/<SOC>_<BOARD_QUALIFIERS>.overlay` exists, it will be used.
241+
#. If the file :file:`boards/<BOARD>.overlay` exists, it will be used in addition to the above.
241242
#. If the current board has :ref:`multiple revisions <porting_board_revisions>`
242-
and :file:`boards/<BOARD>_<revision>.overlay` exists, it will be used.
243-
This file will be used in addition to :file:`boards/<BOARD>.overlay`
244-
if both exist.
243+
and :file:`boards/<BOARD>_<revision>.overlay` exists, it will be used in addition to the above.
245244
#. If one or more files have been found in the previous steps, the build system
246245
stops looking and just uses those files.
247246
#. Otherwise, if :file:`<BOARD>.overlay` exists, it will be used, and the build

doc/build/kconfig/setting.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,8 @@ used.
153153
form :file:`prj_<build>.conf` and if file
154154
:file:`boards/<BOARD>_<build>.conf` exists in same folder as file
155155
:file:`prj_<build>.conf`, the result of merging :file:`prj_<build>.conf` and
156-
:file:`boards/<BOARD>_<build>.conf` is used.
156+
:file:`boards/<BOARD>_<build>.conf` is used - note that this feature is
157+
deprecated, :ref:`application-file-suffixes` should be used instead.
157158

158159
#. Otherwise, if :file:`boards/<BOARD>.conf` exists in the application
159160
configuration directory, the result of merging it with :file:`prj.conf` is
@@ -167,6 +168,11 @@ used.
167168
#. Otherwise, :file:`prj.conf` is used from the application configuration
168169
directory. If it does not exist then a fatal error will be emitted.
169170

171+
Furthermore, applications can have SoC overlay configuration that is applied to
172+
it, the file :file:`socs/<SOC>_<BOARD_QUALIFIERS>.conf` will be applied if it exists,
173+
after the main project configuration has been applied and before any board overlay
174+
configuration files have been applied.
175+
170176
All configuration files will be taken from the application's configuration
171177
directory except for files with an absolute path that are given with the
172178
``CONF_FILE``, ``EXTRA_CONF_FILE``, ``DTC_OVERLAY_FILE``, and

0 commit comments

Comments
 (0)