Lines Matching refs:file
76 #. :file:`soc.yml`: a YAML file describing the high-level meta data of the
84 #. :file:`soc.h`: a header file which can be used to describe or provide
85 configuration macros for the SoC. The :file:`soc.h` will often be included in
88 #. :file:`Kconfig.soc`: the base SoC configuration which defines a Kconfig SoC
92 be defined in this file. Kconfig settings outside of the SoC tree must not be
93 selected. To select general Zephyr Kconfig settings the :file:`Kconfig` file
96 #. :file:`CMakeLists.txt`: CMake file loaded by the Zephyr build system. This
97 CMake file can define additional include paths and/or source files to be used
103 - :file:`Kconfig`, :file:`Kconfig.defconfig` software configuration in
110 The SoC YAML file describes the SoC family, SoC series, and SoC at a high level.
115 The skeleton of a simple SoC YAML file containing just one SoC is:
126 :file:`soc.yml` file as:
148 SoC devicetree include files are located in the :file:`<zephyr-repo>/dts` folder
149 under a corresponding :file:`<ARCH>/<VENDOR>`.
151 The SoC :file:`dts/<ARCH>/<VENDOR>/<soc>.dtsi` describes your SoC hardware in
155 If a highlevel :file:`<arch>.dtsi` file exists, then a good starting point is to
156 include this file in your :file:`<soc>.dtsi`.
158 In general, :file:`<soc>.dtsi` should look like this:
186 It is possible to structure multiple :file:`<VENDOR>/<soc>.dtsi` files in
187 sub-directories for a cleaner file system structure. For example organized
188 pre SoC series, like this: :file:`<VENDOR>/<SERIES>/<soc>.dtsi`.
196 CPU cluster will often have its own :file:`.dtsi` file.
198 CPU cluster :file:`.dtsi` files should follow the naming scheme
199 :file:`<soc>_<cluster>.dtsi`. A :file:`<soc>_<cluster>.dtsi` file will look
200 similar to a SoC :file:`.dtsi` without CPU clusters.
212 There is one mandatory Kconfig file in the SoC directory, and two optional
222 :file:`Kconfig.soc`
223 A shared Kconfig file which can be sourced both in Zephyr Kconfig and sysbuild
226 This file selects the SoC family and series in the Kconfig tree and potential
228 This file must not select anything outside the re-usable Kconfig SoC tree.
230 A :file:`Kconfig.soc` may look like this:
247 :file:`Kconfig.soc` file shall only define the default string value and not
249 :file:`soc.yml` file.
251 :file:`Kconfig`
254 This file can add Kconfig settings which are specific to the current SoC.
256 The :file:`Kconfig` will often indicate given hardware support using a setting
267 :file:`Kconfig.defconfig` should be used instead.
269 :file:`Kconfig.defconfig`
272 Not all SoCs have a :file:`Kconfig.defconfig` file.
274 The entire file should be inside a pair of ``if SOC_<SOC_NAME>`` / ``endif``
289 CPU clusters must provide additional Kconfig settings in the :file:`Kconfig.soc`
290 file. This will usually be in the form of ``SOC_<SOC_NAME>_<CLUSTER>`` so for