scripts/kconfig/cmake: Generate/use env file for zephyr module paths

Adds a output env file that lists the paths of zephyr modules
which can be used in Kconfig files and uses this in Kconfig. Also
updates Kconfig doc output to generate and use this

Signed-off-by: Jamie McCrae <[email protected]>

Author: nordicjm

Kconfig.zephyr

@@ -6,6 +6,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 source "Kconfig.constants"
+source "$(KCONFIG_ENV_FILE)"
 
 osource "$(APPLICATION_SOURCE_DIR)/VERSION"
 

cmake/modules/kconfig.cmake

@@ -134,6 +134,7 @@ zephyr_get(APP_DIR VAR APP_DIR APPLICATION_SOURCE_DIR)
 
 set(COMMON_KCONFIG_ENV_SETTINGS
   PYTHON_EXECUTABLE=${PYTHON_EXECUTABLE}
+  KCONFIG_ENV_FILE=${KCONFIG_BINARY_DIR}/kconfig_module_dirs.env
   srctree=${ZEPHYR_BASE}
   KERNELVERSION=${KERNELVERSION}
   APPVERSION=${APP_VERSION_STRING}

doc/_extensions/zephyr/kconfig/__init__.py

@@ -76,12 +76,18 @@ def kconfig_load(app: Sphinx) -> tuple[kconfiglib.Kconfig, kconfiglib.Kconfig, d
         modules = zephyr_module.parse_modules(ZEPHYR_BASE)
 
         # generate Kconfig.modules file
+        kconfig_module_dirs = ""
         kconfig = ""
         sysbuild_kconfig = ""
         for module in modules:
+            kconfig_module_dirs += zephyr_module.process_kconfig_module_dir(module.project,
+                                                                            module.meta)
             kconfig += zephyr_module.process_kconfig(module.project, module.meta)
             sysbuild_kconfig += zephyr_module.process_sysbuildkconfig(module.project, module.meta)
 
+        with open(Path(td) / "kconfig_module_dirs.env", "w") as f:
+            f.write(kconfig_module_dirs)
+
         with open(Path(td) / "Kconfig.modules", "w") as f:
             f.write(kconfig)
 
@@ -149,6 +155,7 @@ def kconfig_load(app: Sphinx) -> tuple[kconfiglib.Kconfig, kconfiglib.Kconfig, d
 
         os.environ["BOARD"] = "boards"
         os.environ["KCONFIG_BOARD_DIR"] = str(Path(td) / "boards")
+        os.environ["KCONFIG_ENV_FILE"] = str(Path(td) / "kconfig_module_dirs.env")
 
         # Sysbuild runs first
         os.environ["CONFIG_"] = "SB_CONFIG_"

scripts/ci/check_compliance.py

@@ -515,7 +515,7 @@ def run(self):
         self.check_no_undef_outside_kconfig(kconf)
         self.check_disallowed_defconfigs(kconf)
 
-    def get_modules(self, modules_file, sysbuild_modules_file, settings_file):
+    def get_modules(self, _module_dirs_file, modules_file, sysbuild_modules_file, settings_file):
         """
         Get a list of modules and put them in a file that is parsed by
         Kconfig
@@ -700,13 +700,15 @@ def parse_kconfig(self):
         os.environ["KCONFIG_BINARY_DIR"] = kconfiglib_dir
         os.environ['DEVICETREE_CONF'] = "dummy"
         os.environ['TOOLCHAIN_HAS_NEWLIB'] = "y"
+        os.environ['KCONFIG_ENV_FILE'] = os.path.join(kconfiglib_dir, "kconfig_module_dirs.env")
 
         # Older name for DEVICETREE_CONF, for compatibility with older Zephyr
         # versions that don't have the renaming
         os.environ["GENERATED_DTS_BOARD_CONF"] = "dummy"
 
         # For multi repo support
-        self.get_modules(os.path.join(kconfiglib_dir, "Kconfig.modules"),
+        self.get_modules(os.environ['KCONFIG_ENV_FILE'],
+                         os.path.join(kconfiglib_dir, "Kconfig.modules"),
                          os.path.join(kconfiglib_dir, "Kconfig.sysbuild.modules"),
                          os.path.join(kconfiglib_dir, "settings_file.txt"))
         # For Kconfig.dts support
@@ -1365,13 +1367,17 @@ class KconfigBasicNoModulesCheck(KconfigBasicCheck):
     """
     name = "KconfigBasicNoModules"
     path_hint = "<zephyr-base>"
+    EMPTY_FILE_CONTENTS = "# Empty\n"
+
+    def get_modules(self, module_dirs_file, modules_file, sysbuild_modules_file, settings_file):
+        with open(module_dirs_file, 'w') as fp_module_file:
+            fp_module_file.write(self.EMPTY_FILE_CONTENTS)
 
-    def get_modules(self, modules_file, sysbuild_modules_file, settings_file):
         with open(modules_file, 'w') as fp_module_file:
-            fp_module_file.write("# Empty\n")
+            fp_module_file.write(self.EMPTY_FILE_CONTENTS)
 
         with open(sysbuild_modules_file, 'w') as fp_module_file:
-            fp_module_file.write("# Empty\n")
+            fp_module_file.write(self.EMPTY_FILE_CONTENTS)
 
 
 class KconfigHWMv2Check(KconfigBasicCheck):

scripts/zephyr_module.py

@@ -386,18 +386,22 @@ def kconfig_snippet(meta, path, kconfig_file=None, blobs=False, taint_blobs=Fals
     return '\n'.join(snippet)
 
 
+def process_kconfig_module_dir(module, meta):
+    module_path = PurePath(module)
+    name_sanitized = meta['name-sanitized']
+    return f'ZEPHYR_{name_sanitized.upper()}_MODULE_DIR={module_path.as_posix()}\n'
+
+
 def process_kconfig(module, meta):
     blobs = process_blobs(module, meta)
     taint_blobs = any(b['status'] != BLOB_NOT_PRESENT for b in blobs)
     section = meta.get('build', dict())
     module_path = PurePath(module)
     module_yml = module_path.joinpath('zephyr/module.yml')
     kconfig_extern = section.get('kconfig-ext', False)
-    name_sanitized = meta['name-sanitized']
-    snippet = f'ZEPHYR_{name_sanitized.upper()}_MODULE_DIR := {module_path.as_posix()}\n'
 
     if kconfig_extern:
-        return snippet + kconfig_snippet(meta, module_path, blobs=blobs, taint_blobs=taint_blobs)
+        return kconfig_snippet(meta, module_path, blobs=blobs, taint_blobs=taint_blobs)
 
     kconfig_setting = section.get('kconfig', None)
     if not validate_setting(kconfig_setting, module):
@@ -407,10 +411,11 @@ def process_kconfig(module, meta):
 
     kconfig_file = os.path.join(module, kconfig_setting or 'zephyr/Kconfig')
     if os.path.isfile(kconfig_file):
-        return snippet + kconfig_snippet(meta, module_path, Path(kconfig_file),
-                                         blobs=blobs, taint_blobs=taint_blobs)
+        return kconfig_snippet(meta, module_path, Path(kconfig_file),
+                               blobs=blobs, taint_blobs=taint_blobs)
     else:
-        return snippet + '\n'.join(kconfig_module_opts(name_sanitized, blobs, taint_blobs)) + '\n'
+        name_sanitized = meta['name-sanitized']
+        return '\n'.join(kconfig_module_opts(name_sanitized, blobs, taint_blobs)) + '\n'
 
 
 def process_sysbuildkconfig(module, meta):
@@ -419,10 +424,9 @@ def process_sysbuildkconfig(module, meta):
     module_yml = module_path.joinpath('zephyr/module.yml')
     kconfig_extern = section.get('sysbuild-kconfig-ext', False)
     name_sanitized = meta['name-sanitized']
-    snippet = f'ZEPHYR_{name_sanitized.upper()}_MODULE_DIR := {module_path.as_posix()}\n'
 
     if kconfig_extern:
-        return snippet + kconfig_snippet(meta, module_path, sysbuild=True)
+        return kconfig_snippet(meta, module_path, sysbuild=True)
 
     kconfig_setting = section.get('sysbuild-kconfig', None)
     if not validate_setting(kconfig_setting, module):
@@ -433,10 +437,9 @@ def process_sysbuildkconfig(module, meta):
     if kconfig_setting is not None:
         kconfig_file = os.path.join(module, kconfig_setting)
         if os.path.isfile(kconfig_file):
-            return snippet + kconfig_snippet(meta, module_path, Path(kconfig_file))
+            return kconfig_snippet(meta, module_path, Path(kconfig_file))
 
-    return snippet + \
-           (f'config ZEPHYR_{name_sanitized.upper()}_MODULE\n'
+    return (f'config ZEPHYR_{name_sanitized.upper()}_MODULE\n'
             f'   bool\n'
             f'   default y\n')
 
@@ -866,6 +869,7 @@ def main():
                         help='Path to zephyr repository')
     args = parser.parse_args()
 
+    kconfig_module_dirs = ""
     kconfig = ""
     cmake = ""
     sysbuild_kconfig = ""
@@ -878,6 +882,7 @@ def main():
                             args.modules, args.extra_modules)
 
     for module in modules:
+        kconfig_module_dirs += process_kconfig_module_dir(module.project, module.meta)
         kconfig += process_kconfig(module.project, module.meta)
         cmake += process_cmake(module.project, module.meta)
         sysbuild_kconfig += process_sysbuildkconfig(
@@ -886,6 +891,16 @@ def main():
         settings += process_settings(module.project, module.meta)
         twister += process_twister(module.project, module.meta)
 
+    if args.kconfig_out or args.sysbuild_kconfig_out:
+        if args.kconfig_out:
+            kconfig_module_dirs_out = PurePath(args.kconfig_out).parent / 'kconfig_module_dirs.env'
+        elif args.sysbuild_kconfig_out:
+            kconfig_module_dirs_out = PurePath(args.sysbuild_kconfig_out).parent / \
+                                      'kconfig_module_dirs.env'
+
+        with open(kconfig_module_dirs_out, 'w', encoding="utf-8") as fp:
+            fp.write(kconfig_module_dirs)
+
     if args.kconfig_out:
         with open(args.kconfig_out, 'w', encoding="utf-8") as fp:
             fp.write(kconfig)

share/sysbuild/Kconfig

@@ -2,6 +2,8 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+source "$(KCONFIG_ENV_FILE)"
+
 config BOARD
 	string
 	default "$(BOARD)"