diff --git a/doc/build/kconfig/setting.rst b/doc/build/kconfig/setting.rst index ad62d86eb3d43..17eafc95a3bec 100644 --- a/doc/build/kconfig/setting.rst +++ b/doc/build/kconfig/setting.rst @@ -161,10 +161,10 @@ used. #. Otherwise, :file:`prj.conf` is used from the application configuration 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/_.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. +Furthermore, applications can have SoC Kconfig fragments added to the configuration, +the file :file:`socs/_.conf` will be applied if it exists, +after the main project configuration has been applied and before any board Kconfig +fragments files have been applied. All configuration files will be taken from the application's configuration directory except for files with an absolute path that are given with the diff --git a/doc/hardware/porting/soc_porting.rst b/doc/hardware/porting/soc_porting.rst index e59009ca81f0a..e383020f133b2 100644 --- a/doc/hardware/porting/soc_porting.rst +++ b/doc/hardware/porting/soc_porting.rst @@ -231,21 +231,34 @@ files for a SoC: .. code-block:: kconfig - config SOC_ + config SOC_FAMILY_ bool + config SOC_SERIES_ + bool + select SOC_FAMILY_ + config SOC_ bool - select SOC_SERIES_ + select SOC_SERIES_ + + config SOC_FAMILY + default "" if SOC_FAMILY_ + + config SOC_SERIES + default "" if SOC_SERIES_ config SOC - default "SoC name" if SOC_ + default "" if SOC_ - Notice that ``SOC_NAME`` is a pure upper case version of the SoC name. + Notice that ``SOC_NAME`` is a pure uppercase version of the SoC name, ``SOC_SERIES_NAME`` is + a pure uppercase version of SoC series name and ``SOC_FAMILY_NAME`` is a pure uppercase version + of the SoC family name, if these fields do not appear in the :file:`soc.yml` file then they + should not be present in the :file:`Kconfig.soc` file. - The Kconfig ``SOC`` setting is globally defined as a string and therefore the - :file:`Kconfig.soc` file shall only define the default string value and not - the type. Notice that the string value must match the SoC name used in the + The Kconfigs ``SOC``, ``SOC_SERIES`` and ``SOC_FAMILY`` settings are globally defined as + strings and therefore the :file:`Kconfig.soc` file shall only define the default string values + and not the types. Notice that the string values must match the values used in the :file:`soc.yml` file. :file:`Kconfig`