michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: build: Add details on SoC overlays

Browse source 
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 <jamie.mccrae@nordicsemi.no>
This commit is contained in:
Jamie McCrae 2024-04-11 13:44:39 +01:00 • committed by Fabio Baltieri
commit af467659de
2 changed files with 10 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/build/dts/howtos.rst vendored
View file

@ -237,11 +237,10 @@ If you don't set :makevar:`DTC_OVERLAY_FILE`, the build system will follow
these steps, looking for files in your application configuration directory to these steps, looking for files in your application configuration directory to
use as devicetree overlays: use as devicetree overlays:
#. If the file :file:`boards/<BOARD>.overlay` exists, it will be used. #. If the file :file:`socs/<SOC>_<BOARD_QUALIFIERS>.overlay` exists, it will be used.
#. If the file :file:`boards/<BOARD>.overlay` exists, it will be used in addition to the above.
#. If the current board has :ref:`multiple revisions <porting_board_revisions>` #. If the current board has :ref:`multiple revisions <porting_board_revisions>`
and :file:`boards/<BOARD>_<revision>.overlay` exists, it will be used. and :file:`boards/<BOARD>_<revision>.overlay` exists, it will be used in addition to the above.
This file will be used in addition to :file:`boards/<BOARD>.overlay`
if both exist.
#. If one or more files have been found in the previous steps, the build system #. If one or more files have been found in the previous steps, the build system
stops looking and just uses those files. stops looking and just uses those files.
#. Otherwise, if :file:`<BOARD>.overlay` exists, it will be used, and the build #. Otherwise, if :file:`<BOARD>.overlay` exists, it will be used, and the build

8
doc/build/kconfig/setting.rst vendored
View file

@ -153,7 +153,8 @@ used.
form :file:`prj_<build>.conf` and if file form :file:`prj_<build>.conf` and if file
:file:`boards/<BOARD>_<build>.conf` exists in same folder as file :file:`boards/<BOARD>_<build>.conf` exists in same folder as file
:file:`prj_<build>.conf`, the result of merging :file:`prj_<build>.conf` and :file:`prj_<build>.conf`, the result of merging :file:`prj_<build>.conf` and
:file:`boards/<BOARD>_<build>.conf` is used. :file:`boards/<BOARD>_<build>.conf` is used - note that this feature is
deprecated, :ref:`application-file-suffixes` should be used instead.
#. Otherwise, if :file:`boards/<BOARD>.conf` exists in the application #. Otherwise, if :file:`boards/<BOARD>.conf` exists in the application
configuration directory, the result of merging it with :file:`prj.conf` is configuration directory, the result of merging it with :file:`prj.conf` is
@ -167,6 +168,11 @@ used.
#. Otherwise, :file:`prj.conf` is used from the application configuration #. Otherwise, :file:`prj.conf` is used from the application configuration
directory. If it does not exist then a fatal error will be emitted. directory. If it does not exist then a fatal error will be emitted.
Furthermore, applications can have SoC overlay configuration that is applied to
it, the file :file:`socs/<SOC>_<BOARD_QUALIFIERS>.conf` will be applied if it exists,
after the main project configuration has been applied and before any board overlay
configuration files have been applied.
All configuration files will be taken from the application's configuration All configuration files will be taken from the application's configuration
directory except for files with an absolute path that are given with the directory except for files with an absolute path that are given with the
``CONF_FILE``, ``EXTRA_CONF_FILE``, ``DTC_OVERLAY_FILE``, and ``CONF_FILE``, ``EXTRA_CONF_FILE``, ``DTC_OVERLAY_FILE``, and