Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
| 2 | # |
| 3 | # Copyright (c) 2019, Nordic Semiconductor ASA |
| 4 | # |
| 5 | # SPDX-License-Identifier: Apache-2.0 |
| 6 | |
| 7 | '''Tool for parsing a list of projects to determine if they are Zephyr |
| 8 | projects. If no projects are given then the output from `west list` will be |
| 9 | used as project list. |
| 10 | |
| 11 | Include file is generated for Kconfig using --kconfig-out. |
| 12 | A <name>:<path> text file is generated for use with CMake using --cmake-out. |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 13 | |
Anas Nashif | 5471398 | 2020-12-07 14:52:10 -0500 | [diff] [blame] | 14 | Using --twister-out <filename> an argument file for twister script will |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 15 | be generated which would point to test and sample roots available in modules |
Anas Nashif | 5471398 | 2020-12-07 14:52:10 -0500 | [diff] [blame] | 16 | that can be included during a twister run. This allows testing code |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 17 | maintained in modules in addition to what is available in the main Zephyr tree. |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 18 | ''' |
| 19 | |
| 20 | import argparse |
Carles Cufi | b662bc9 | 2022-08-24 15:42:55 +0200 | [diff] [blame] | 21 | import hashlib |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 22 | import os |
Torsten Rasmussen | 3d88083 | 2021-01-19 12:01:38 +0100 | [diff] [blame] | 23 | import re |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 24 | import subprocess |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 25 | import sys |
| 26 | import yaml |
| 27 | import pykwalify.core |
Torsten Rasmussen | b3da9ef | 2019-12-13 09:42:13 +0100 | [diff] [blame] | 28 | from pathlib import Path, PurePath |
Torsten Rasmussen | 3917ee5 | 2020-05-18 22:34:49 +0200 | [diff] [blame] | 29 | from collections import namedtuple |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 30 | |
Lukasz Mrugala | b2f4321 | 2024-04-19 10:37:20 +0000 | [diff] [blame] | 31 | try: |
| 32 | from yaml import CSafeLoader as SafeLoader |
| 33 | except ImportError: |
| 34 | from yaml import SafeLoader |
| 35 | |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 36 | METADATA_SCHEMA = ''' |
| 37 | ## A pykwalify schema for basic validation of the structure of a |
| 38 | ## metadata YAML file. |
| 39 | ## |
| 40 | # The zephyr/module.yml file is a simple list of key value pairs to be used by |
| 41 | # the build system. |
| 42 | type: map |
| 43 | mapping: |
Torsten Rasmussen | f24f883 | 2021-01-07 15:27:53 +0100 | [diff] [blame] | 44 | name: |
| 45 | required: false |
| 46 | type: str |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 47 | build: |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 48 | required: false |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 49 | type: map |
| 50 | mapping: |
| 51 | cmake: |
| 52 | required: false |
| 53 | type: str |
| 54 | kconfig: |
| 55 | required: false |
| 56 | type: str |
Torsten Rasmussen | 3673e28 | 2020-12-17 11:27:42 +0100 | [diff] [blame] | 57 | cmake-ext: |
| 58 | required: false |
| 59 | type: bool |
| 60 | default: false |
| 61 | kconfig-ext: |
| 62 | required: false |
| 63 | type: bool |
| 64 | default: false |
Jamie McCrae | df9027a | 2023-02-20 10:00:38 +0000 | [diff] [blame] | 65 | sysbuild-cmake: |
| 66 | required: false |
| 67 | type: str |
| 68 | sysbuild-kconfig: |
| 69 | required: false |
| 70 | type: str |
| 71 | sysbuild-cmake-ext: |
| 72 | required: false |
| 73 | type: bool |
| 74 | default: false |
| 75 | sysbuild-kconfig-ext: |
| 76 | required: false |
| 77 | type: bool |
| 78 | default: false |
Torsten Rasmussen | 3917ee5 | 2020-05-18 22:34:49 +0200 | [diff] [blame] | 79 | depends: |
| 80 | required: false |
| 81 | type: seq |
| 82 | sequence: |
| 83 | - type: str |
Torsten Rasmussen | 25d57ba | 2020-07-07 17:29:56 +0200 | [diff] [blame] | 84 | settings: |
| 85 | required: false |
| 86 | type: map |
| 87 | mapping: |
| 88 | board_root: |
| 89 | required: false |
| 90 | type: str |
| 91 | dts_root: |
| 92 | required: false |
| 93 | type: str |
Marti Bolivar | 3f282da0 | 2023-01-07 15:25:10 -0800 | [diff] [blame] | 94 | snippet_root: |
| 95 | required: false |
| 96 | type: str |
Torsten Rasmussen | 25d57ba | 2020-07-07 17:29:56 +0200 | [diff] [blame] | 97 | soc_root: |
| 98 | required: false |
| 99 | type: str |
| 100 | arch_root: |
| 101 | required: false |
| 102 | type: str |
Torsten Rasmussen | 3673e28 | 2020-12-17 11:27:42 +0100 | [diff] [blame] | 103 | module_ext_root: |
| 104 | required: false |
| 105 | type: str |
Torsten Rasmussen | cb690ec | 2022-11-30 12:14:35 +0100 | [diff] [blame] | 106 | sca_root: |
| 107 | required: false |
| 108 | type: str |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 109 | tests: |
| 110 | required: false |
| 111 | type: seq |
| 112 | sequence: |
| 113 | - type: str |
| 114 | samples: |
| 115 | required: false |
| 116 | type: seq |
| 117 | sequence: |
| 118 | - type: str |
| 119 | boards: |
| 120 | required: false |
| 121 | type: seq |
| 122 | sequence: |
| 123 | - type: str |
Carles Cufi | 336aa9d | 2022-08-04 19:08:22 +0200 | [diff] [blame] | 124 | blobs: |
| 125 | required: false |
| 126 | type: seq |
| 127 | sequence: |
| 128 | - type: map |
| 129 | mapping: |
| 130 | path: |
| 131 | required: true |
| 132 | type: str |
| 133 | sha256: |
| 134 | required: true |
| 135 | type: str |
| 136 | type: |
| 137 | required: true |
| 138 | type: str |
| 139 | enum: ['img', 'lib'] |
| 140 | version: |
| 141 | required: true |
| 142 | type: str |
| 143 | license-path: |
| 144 | required: true |
| 145 | type: str |
| 146 | url: |
| 147 | required: true |
| 148 | type: str |
| 149 | description: |
| 150 | required: true |
| 151 | type: str |
| 152 | doc-url: |
| 153 | required: false |
| 154 | type: str |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 155 | security: |
| 156 | required: false |
| 157 | type: map |
| 158 | mapping: |
| 159 | external-references: |
| 160 | required: false |
| 161 | type: seq |
| 162 | sequence: |
| 163 | - type: str |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 164 | ''' |
| 165 | |
Carles Cufi | 57e5cd4 | 2022-08-11 17:37:34 +0200 | [diff] [blame] | 166 | MODULE_YML_PATH = PurePath('zephyr/module.yml') |
Carles Cufi | 336aa9d | 2022-08-04 19:08:22 +0200 | [diff] [blame] | 167 | # Path to the blobs folder |
| 168 | MODULE_BLOBS_PATH = PurePath('zephyr/blobs') |
Carles Cufi | b662bc9 | 2022-08-24 15:42:55 +0200 | [diff] [blame] | 169 | BLOB_PRESENT = 'A' |
| 170 | BLOB_NOT_PRESENT = 'D' |
| 171 | BLOB_OUTDATED = 'M' |
Carles Cufi | 57e5cd4 | 2022-08-11 17:37:34 +0200 | [diff] [blame] | 172 | |
Lukasz Mrugala | b2f4321 | 2024-04-19 10:37:20 +0000 | [diff] [blame] | 173 | schema = yaml.load(METADATA_SCHEMA, Loader=SafeLoader) |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 174 | |
| 175 | |
| 176 | def validate_setting(setting, module_path, filename=None): |
| 177 | if setting is not None: |
| 178 | if filename is not None: |
Jack Rosenthal | f959309 | 2023-08-09 16:24:14 -0600 | [diff] [blame] | 179 | checkfile = Path(module_path) / setting / filename |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 180 | else: |
Jack Rosenthal | f959309 | 2023-08-09 16:24:14 -0600 | [diff] [blame] | 181 | checkfile = Path(module_path) / setting |
| 182 | if not checkfile.resolve().is_file(): |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 183 | return False |
| 184 | return True |
| 185 | |
| 186 | |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 187 | def process_module(module): |
Torsten Rasmussen | b3da9ef | 2019-12-13 09:42:13 +0100 | [diff] [blame] | 188 | module_path = PurePath(module) |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 189 | |
Carles Cufi | 57e5cd4 | 2022-08-11 17:37:34 +0200 | [diff] [blame] | 190 | # The input is a module if zephyr/module.{yml,yaml} is a valid yaml file |
Sebastian Bøe | bb95dce | 2019-12-19 15:49:22 +0100 | [diff] [blame] | 191 | # or if both zephyr/CMakeLists.txt and zephyr/Kconfig are present. |
| 192 | |
Carles Cufi | 57e5cd4 | 2022-08-11 17:37:34 +0200 | [diff] [blame] | 193 | for module_yml in [module_path / MODULE_YML_PATH, |
| 194 | module_path / MODULE_YML_PATH.with_suffix('.yaml')]: |
Alexander Mihajlovic | 099c126 | 2022-03-31 08:04:45 +0200 | [diff] [blame] | 195 | if Path(module_yml).is_file(): |
| 196 | with Path(module_yml).open('r') as f: |
Lukasz Mrugala | b2f4321 | 2024-04-19 10:37:20 +0000 | [diff] [blame] | 197 | meta = yaml.load(f.read(), Loader=SafeLoader) |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 198 | |
Alexander Mihajlovic | 099c126 | 2022-03-31 08:04:45 +0200 | [diff] [blame] | 199 | try: |
| 200 | pykwalify.core.Core(source_data=meta, schema_data=schema)\ |
| 201 | .validate() |
| 202 | except pykwalify.errors.SchemaError as e: |
| 203 | sys.exit('ERROR: Malformed "build" section in file: {}\n{}' |
| 204 | .format(module_yml.as_posix(), e)) |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 205 | |
Alexander Mihajlovic | 099c126 | 2022-03-31 08:04:45 +0200 | [diff] [blame] | 206 | meta['name'] = meta.get('name', module_path.name) |
| 207 | meta['name-sanitized'] = re.sub('[^a-zA-Z0-9]', '_', meta['name']) |
| 208 | return meta |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 209 | |
Sebastian Bøe | bb95dce | 2019-12-19 15:49:22 +0100 | [diff] [blame] | 210 | if Path(module_path.joinpath('zephyr/CMakeLists.txt')).is_file() and \ |
| 211 | Path(module_path.joinpath('zephyr/Kconfig')).is_file(): |
Torsten Rasmussen | f24f883 | 2021-01-07 15:27:53 +0100 | [diff] [blame] | 212 | return {'name': module_path.name, |
Torsten Rasmussen | 3d88083 | 2021-01-19 12:01:38 +0100 | [diff] [blame] | 213 | 'name-sanitized': re.sub('[^a-zA-Z0-9]', '_', module_path.name), |
Torsten Rasmussen | f24f883 | 2021-01-07 15:27:53 +0100 | [diff] [blame] | 214 | 'build': {'cmake': 'zephyr', 'kconfig': 'zephyr/Kconfig'}} |
Sebastian Bøe | bb95dce | 2019-12-19 15:49:22 +0100 | [diff] [blame] | 215 | |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 216 | return None |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 217 | |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 218 | |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 219 | def process_cmake(module, meta): |
| 220 | section = meta.get('build', dict()) |
| 221 | module_path = PurePath(module) |
| 222 | module_yml = module_path.joinpath('zephyr/module.yml') |
Torsten Rasmussen | 3673e28 | 2020-12-17 11:27:42 +0100 | [diff] [blame] | 223 | |
| 224 | cmake_extern = section.get('cmake-ext', False) |
| 225 | if cmake_extern: |
| 226 | return('\"{}\":\"{}\":\"{}\"\n' |
Andrzej Głąbek | 0281948 | 2021-01-19 07:39:47 +0100 | [diff] [blame] | 227 | .format(meta['name'], |
Torsten Rasmussen | 3673e28 | 2020-12-17 11:27:42 +0100 | [diff] [blame] | 228 | module_path.as_posix(), |
Torsten Rasmussen | 3d88083 | 2021-01-19 12:01:38 +0100 | [diff] [blame] | 229 | "${ZEPHYR_" + meta['name-sanitized'].upper() + "_CMAKE_DIR}")) |
Torsten Rasmussen | 3673e28 | 2020-12-17 11:27:42 +0100 | [diff] [blame] | 230 | |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 231 | cmake_setting = section.get('cmake', None) |
| 232 | if not validate_setting(cmake_setting, module, 'CMakeLists.txt'): |
| 233 | sys.exit('ERROR: "cmake" key in {} has folder value "{}" which ' |
Torsten Rasmussen | 25c3f8e | 2020-08-25 14:02:04 +0200 | [diff] [blame] | 234 | 'does not contain a CMakeLists.txt file.' |
| 235 | .format(module_yml.as_posix(), cmake_setting)) |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 236 | |
| 237 | cmake_path = os.path.join(module, cmake_setting or 'zephyr') |
| 238 | cmake_file = os.path.join(cmake_path, 'CMakeLists.txt') |
| 239 | if os.path.isfile(cmake_file): |
Torsten Rasmussen | ab7ec17 | 2020-08-25 13:32:33 +0200 | [diff] [blame] | 240 | return('\"{}\":\"{}\":\"{}\"\n' |
Torsten Rasmussen | f24f883 | 2021-01-07 15:27:53 +0100 | [diff] [blame] | 241 | .format(meta['name'], |
Torsten Rasmussen | ab7ec17 | 2020-08-25 13:32:33 +0200 | [diff] [blame] | 242 | module_path.as_posix(), |
Torsten Rasmussen | 25c3f8e | 2020-08-25 14:02:04 +0200 | [diff] [blame] | 243 | Path(cmake_path).resolve().as_posix())) |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 244 | else: |
Torsten Rasmussen | ab7ec17 | 2020-08-25 13:32:33 +0200 | [diff] [blame] | 245 | return('\"{}\":\"{}\":\"\"\n' |
Torsten Rasmussen | f24f883 | 2021-01-07 15:27:53 +0100 | [diff] [blame] | 246 | .format(meta['name'], |
Torsten Rasmussen | ab7ec17 | 2020-08-25 13:32:33 +0200 | [diff] [blame] | 247 | module_path.as_posix())) |
Torsten Rasmussen | 25c3f8e | 2020-08-25 14:02:04 +0200 | [diff] [blame] | 248 | |
Torsten Rasmussen | 3673e28 | 2020-12-17 11:27:42 +0100 | [diff] [blame] | 249 | |
Jamie McCrae | df9027a | 2023-02-20 10:00:38 +0000 | [diff] [blame] | 250 | def process_sysbuildcmake(module, meta): |
| 251 | section = meta.get('build', dict()) |
| 252 | module_path = PurePath(module) |
| 253 | module_yml = module_path.joinpath('zephyr/module.yml') |
| 254 | |
| 255 | cmake_extern = section.get('sysbuild-cmake-ext', False) |
| 256 | if cmake_extern: |
| 257 | return('\"{}\":\"{}\":\"{}\"\n' |
| 258 | .format(meta['name'], |
| 259 | module_path.as_posix(), |
| 260 | "${SYSBUILD_" + meta['name-sanitized'].upper() + "_CMAKE_DIR}")) |
| 261 | |
| 262 | cmake_setting = section.get('sysbuild-cmake', None) |
| 263 | if not validate_setting(cmake_setting, module, 'CMakeLists.txt'): |
| 264 | sys.exit('ERROR: "cmake" key in {} has folder value "{}" which ' |
| 265 | 'does not contain a CMakeLists.txt file.' |
| 266 | .format(module_yml.as_posix(), cmake_setting)) |
| 267 | |
| 268 | if cmake_setting is None: |
| 269 | return "" |
| 270 | |
| 271 | cmake_path = os.path.join(module, cmake_setting or 'zephyr') |
| 272 | cmake_file = os.path.join(cmake_path, 'CMakeLists.txt') |
| 273 | if os.path.isfile(cmake_file): |
| 274 | return('\"{}\":\"{}\":\"{}\"\n' |
| 275 | .format(meta['name'], |
| 276 | module_path.as_posix(), |
| 277 | Path(cmake_path).resolve().as_posix())) |
| 278 | else: |
| 279 | return('\"{}\":\"{}\":\"\"\n' |
| 280 | .format(meta['name'], |
| 281 | module_path.as_posix())) |
| 282 | |
| 283 | |
Torsten Rasmussen | 25d57ba | 2020-07-07 17:29:56 +0200 | [diff] [blame] | 284 | def process_settings(module, meta): |
| 285 | section = meta.get('build', dict()) |
| 286 | build_settings = section.get('settings', None) |
| 287 | out_text = "" |
| 288 | |
| 289 | if build_settings is not None: |
Marti Bolivar | 3f282da0 | 2023-01-07 15:25:10 -0800 | [diff] [blame] | 290 | for root in ['board', 'dts', 'snippet', 'soc', 'arch', 'module_ext', 'sca']: |
Torsten Rasmussen | 25d57ba | 2020-07-07 17:29:56 +0200 | [diff] [blame] | 291 | setting = build_settings.get(root+'_root', None) |
| 292 | if setting is not None: |
| 293 | root_path = PurePath(module) / setting |
Torsten Rasmussen | 3673e28 | 2020-12-17 11:27:42 +0100 | [diff] [blame] | 294 | out_text += f'"{root.upper()}_ROOT":' |
| 295 | out_text += f'"{root_path.as_posix()}"\n' |
Torsten Rasmussen | 25d57ba | 2020-07-07 17:29:56 +0200 | [diff] [blame] | 296 | |
| 297 | return out_text |
| 298 | |
Torsten Rasmussen | 25c3f8e | 2020-08-25 14:02:04 +0200 | [diff] [blame] | 299 | |
Carles Cufi | b662bc9 | 2022-08-24 15:42:55 +0200 | [diff] [blame] | 300 | def get_blob_status(path, sha256): |
| 301 | if not path.is_file(): |
| 302 | return BLOB_NOT_PRESENT |
| 303 | with path.open('rb') as f: |
| 304 | m = hashlib.sha256() |
| 305 | m.update(f.read()) |
| 306 | if sha256.lower() == m.hexdigest(): |
| 307 | return BLOB_PRESENT |
| 308 | else: |
| 309 | return BLOB_OUTDATED |
| 310 | |
| 311 | |
| 312 | def process_blobs(module, meta): |
| 313 | blobs = [] |
| 314 | mblobs = meta.get('blobs', None) |
| 315 | if not mblobs: |
| 316 | return blobs |
| 317 | |
| 318 | blobs_path = Path(module) / MODULE_BLOBS_PATH |
| 319 | for blob in mblobs: |
| 320 | blob['module'] = meta.get('name', None) |
| 321 | blob['abspath'] = blobs_path / Path(blob['path']) |
| 322 | blob['status'] = get_blob_status(blob['abspath'], blob['sha256']) |
| 323 | blobs.append(blob) |
| 324 | |
| 325 | return blobs |
| 326 | |
| 327 | |
Johan Hedberg | 5562bb9 | 2024-08-22 11:24:36 +0300 | [diff] [blame] | 328 | def kconfig_module_opts(name_sanitized, blobs, taint_blobs): |
| 329 | snippet = [f'config ZEPHYR_{name_sanitized.upper()}_MODULE', |
| 330 | ' bool', |
| 331 | ' default y'] |
| 332 | |
| 333 | if taint_blobs: |
| 334 | snippet += [' select TAINT_BLOBS'] |
| 335 | |
| 336 | if blobs: |
| 337 | snippet += [f'\nconfig ZEPHYR_{name_sanitized.upper()}_MODULE_BLOBS', |
| 338 | ' bool'] |
| 339 | if taint_blobs: |
| 340 | snippet += [' default y'] |
| 341 | |
| 342 | return snippet |
| 343 | |
| 344 | |
| 345 | def kconfig_snippet(meta, path, kconfig_file=None, blobs=False, taint_blobs=False, sysbuild=False): |
Torsten Rasmussen | 3d88083 | 2021-01-19 12:01:38 +0100 | [diff] [blame] | 346 | name = meta['name'] |
| 347 | name_sanitized = meta['name-sanitized'] |
| 348 | |
Johan Hedberg | 5562bb9 | 2024-08-22 11:24:36 +0300 | [diff] [blame] | 349 | snippet = [f'menu "{name} ({path.as_posix()})"'] |
Carles Cufi | 035dffc | 2022-08-24 16:56:01 +0200 | [diff] [blame] | 350 | |
Johan Hedberg | 5562bb9 | 2024-08-22 11:24:36 +0300 | [diff] [blame] | 351 | snippet += [f'osource "{kconfig_file.resolve().as_posix()}"' if kconfig_file |
| 352 | else f'osource "$(SYSBUILD_{name_sanitized.upper()}_KCONFIG)"' if sysbuild is True |
| 353 | else f'osource "$(ZEPHYR_{name_sanitized.upper()}_KCONFIG)"'] |
| 354 | |
| 355 | snippet += kconfig_module_opts(name_sanitized, blobs, taint_blobs) |
| 356 | |
| 357 | snippet += ['endmenu\n'] |
| 358 | |
Torsten Rasmussen | 3673e28 | 2020-12-17 11:27:42 +0100 | [diff] [blame] | 359 | return '\n'.join(snippet) |
| 360 | |
| 361 | |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 362 | def process_kconfig(module, meta): |
Carles Cufi | 035dffc | 2022-08-24 16:56:01 +0200 | [diff] [blame] | 363 | blobs = process_blobs(module, meta) |
Christophe Dufaza | ae9326c | 2024-07-15 15:48:13 +0200 | [diff] [blame] | 364 | taint_blobs = any(b['status'] != BLOB_NOT_PRESENT for b in blobs) |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 365 | section = meta.get('build', dict()) |
| 366 | module_path = PurePath(module) |
| 367 | module_yml = module_path.joinpath('zephyr/module.yml') |
Torsten Rasmussen | 3673e28 | 2020-12-17 11:27:42 +0100 | [diff] [blame] | 368 | kconfig_extern = section.get('kconfig-ext', False) |
| 369 | if kconfig_extern: |
Johan Hedberg | 5562bb9 | 2024-08-22 11:24:36 +0300 | [diff] [blame] | 370 | return kconfig_snippet(meta, module_path, blobs=blobs, taint_blobs=taint_blobs) |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 371 | |
| 372 | kconfig_setting = section.get('kconfig', None) |
| 373 | if not validate_setting(kconfig_setting, module): |
| 374 | sys.exit('ERROR: "kconfig" key in {} has value "{}" which does ' |
Torsten Rasmussen | 25c3f8e | 2020-08-25 14:02:04 +0200 | [diff] [blame] | 375 | 'not point to a valid Kconfig file.' |
| 376 | .format(module_yml, kconfig_setting)) |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 377 | |
| 378 | kconfig_file = os.path.join(module, kconfig_setting or 'zephyr/Kconfig') |
| 379 | if os.path.isfile(kconfig_file): |
Carles Cufi | 035dffc | 2022-08-24 16:56:01 +0200 | [diff] [blame] | 380 | return kconfig_snippet(meta, module_path, Path(kconfig_file), |
Johan Hedberg | 5562bb9 | 2024-08-22 11:24:36 +0300 | [diff] [blame] | 381 | blobs=blobs, taint_blobs=taint_blobs) |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 382 | else: |
Flavio Ceolin | 2e5c371 | 2023-05-10 21:40:04 +0000 | [diff] [blame] | 383 | name_sanitized = meta['name-sanitized'] |
Johan Hedberg | 5562bb9 | 2024-08-22 11:24:36 +0300 | [diff] [blame] | 384 | snippet = kconfig_module_opts(name_sanitized, blobs, taint_blobs) |
| 385 | return '\n'.join(snippet) + '\n' |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 386 | |
Torsten Rasmussen | 3673e28 | 2020-12-17 11:27:42 +0100 | [diff] [blame] | 387 | |
Jamie McCrae | df9027a | 2023-02-20 10:00:38 +0000 | [diff] [blame] | 388 | def process_sysbuildkconfig(module, meta): |
| 389 | section = meta.get('build', dict()) |
| 390 | module_path = PurePath(module) |
| 391 | module_yml = module_path.joinpath('zephyr/module.yml') |
| 392 | kconfig_extern = section.get('sysbuild-kconfig-ext', False) |
| 393 | if kconfig_extern: |
| 394 | return kconfig_snippet(meta, module_path, sysbuild=True) |
| 395 | |
| 396 | kconfig_setting = section.get('sysbuild-kconfig', None) |
| 397 | if not validate_setting(kconfig_setting, module): |
| 398 | sys.exit('ERROR: "kconfig" key in {} has value "{}" which does ' |
| 399 | 'not point to a valid Kconfig file.' |
| 400 | .format(module_yml, kconfig_setting)) |
| 401 | |
Jamie McCrae | acd14f8 | 2024-04-29 09:40:24 +0100 | [diff] [blame] | 402 | if kconfig_setting is not None: |
| 403 | kconfig_file = os.path.join(module, kconfig_setting) |
| 404 | if os.path.isfile(kconfig_file): |
| 405 | return kconfig_snippet(meta, module_path, Path(kconfig_file)) |
Jamie McCrae | df9027a | 2023-02-20 10:00:38 +0000 | [diff] [blame] | 406 | |
Jamie McCrae | acd14f8 | 2024-04-29 09:40:24 +0100 | [diff] [blame] | 407 | name_sanitized = meta['name-sanitized'] |
| 408 | return (f'config ZEPHYR_{name_sanitized.upper()}_MODULE\n' |
| 409 | f' bool\n' |
| 410 | f' default y\n') |
Jamie McCrae | df9027a | 2023-02-20 10:00:38 +0000 | [diff] [blame] | 411 | |
| 412 | |
Anas Nashif | 5471398 | 2020-12-07 14:52:10 -0500 | [diff] [blame] | 413 | def process_twister(module, meta): |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 414 | |
| 415 | out = "" |
| 416 | tests = meta.get('tests', []) |
| 417 | samples = meta.get('samples', []) |
| 418 | boards = meta.get('boards', []) |
| 419 | |
| 420 | for pth in tests + samples: |
| 421 | if pth: |
| 422 | dir = os.path.join(module, pth) |
Torsten Rasmussen | 25c3f8e | 2020-08-25 14:02:04 +0200 | [diff] [blame] | 423 | out += '-T\n{}\n'.format(PurePath(os.path.abspath(dir)) |
| 424 | .as_posix()) |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 425 | |
| 426 | for pth in boards: |
| 427 | if pth: |
| 428 | dir = os.path.join(module, pth) |
Torsten Rasmussen | 25c3f8e | 2020-08-25 14:02:04 +0200 | [diff] [blame] | 429 | out += '--board-root\n{}\n'.format(PurePath(os.path.abspath(dir)) |
| 430 | .as_posix()) |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 431 | |
| 432 | return out |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 433 | |
| 434 | |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 435 | def _create_meta_project(project_path): |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 436 | def git_revision(path): |
| 437 | rc = subprocess.Popen(['git', 'rev-parse', '--is-inside-work-tree'], |
| 438 | stdout=subprocess.PIPE, |
| 439 | stderr=subprocess.PIPE, |
| 440 | cwd=path).wait() |
| 441 | if rc == 0: |
| 442 | # A git repo. |
| 443 | popen = subprocess.Popen(['git', 'rev-parse', 'HEAD'], |
| 444 | stdout=subprocess.PIPE, |
| 445 | stderr=subprocess.PIPE, |
| 446 | cwd=path) |
| 447 | stdout, stderr = popen.communicate() |
| 448 | stdout = stdout.decode('utf-8') |
| 449 | |
| 450 | if not (popen.returncode or stderr): |
| 451 | revision = stdout.rstrip() |
| 452 | |
| 453 | rc = subprocess.Popen(['git', 'diff-index', '--quiet', 'HEAD', |
| 454 | '--'], |
| 455 | stdout=None, |
| 456 | stderr=None, |
| 457 | cwd=path).wait() |
| 458 | if rc: |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 459 | return revision + '-dirty', True |
| 460 | return revision, False |
| 461 | return None, False |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 462 | |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 463 | def git_remote(path): |
| 464 | popen = subprocess.Popen(['git', 'remote'], |
| 465 | stdout=subprocess.PIPE, |
| 466 | stderr=subprocess.PIPE, |
| 467 | cwd=path) |
| 468 | stdout, stderr = popen.communicate() |
| 469 | stdout = stdout.decode('utf-8') |
| 470 | |
| 471 | remotes_name = [] |
| 472 | if not (popen.returncode or stderr): |
| 473 | remotes_name = stdout.rstrip().split('\n') |
| 474 | |
| 475 | remote_url = None |
| 476 | |
| 477 | # If more than one remote, do not return any remote |
| 478 | if len(remotes_name) == 1: |
| 479 | remote = remotes_name[0] |
| 480 | popen = subprocess.Popen(['git', 'remote', 'get-url', remote], |
| 481 | stdout=subprocess.PIPE, |
| 482 | stderr=subprocess.PIPE, |
| 483 | cwd=path) |
| 484 | stdout, stderr = popen.communicate() |
| 485 | stdout = stdout.decode('utf-8') |
| 486 | |
| 487 | if not (popen.returncode or stderr): |
| 488 | remote_url = stdout.rstrip() |
| 489 | |
| 490 | return remote_url |
| 491 | |
| 492 | def git_tags(path, revision): |
| 493 | if not revision or len(revision) == 0: |
| 494 | return None |
| 495 | |
| 496 | popen = subprocess.Popen(['git', '-P', 'tag', '--points-at', revision], |
| 497 | stdout=subprocess.PIPE, |
| 498 | stderr=subprocess.PIPE, |
| 499 | cwd=path) |
| 500 | stdout, stderr = popen.communicate() |
| 501 | stdout = stdout.decode('utf-8') |
| 502 | |
| 503 | tags = None |
| 504 | if not (popen.returncode or stderr): |
| 505 | tags = stdout.rstrip().splitlines() |
| 506 | |
| 507 | return tags |
| 508 | |
| 509 | workspace_dirty = False |
| 510 | path = PurePath(project_path).as_posix() |
| 511 | |
| 512 | revision, dirty = git_revision(path) |
| 513 | workspace_dirty |= dirty |
| 514 | remote = git_remote(path) |
| 515 | tags = git_tags(path, revision) |
| 516 | |
| 517 | meta_project = {'path': path, |
| 518 | 'revision': revision} |
| 519 | |
| 520 | if remote: |
| 521 | meta_project['remote'] = remote |
| 522 | |
| 523 | if tags: |
| 524 | meta_project['tags'] = tags |
| 525 | |
| 526 | return meta_project, workspace_dirty |
| 527 | |
| 528 | |
| 529 | def _get_meta_project(meta_projects_list, project_path): |
| 530 | projects = [ prj for prj in meta_projects_list[1:] if prj["path"] == project_path ] |
| 531 | |
| 532 | return projects[0] if len(projects) == 1 else None |
| 533 | |
| 534 | |
| 535 | def process_meta(zephyr_base, west_projs, modules, extra_modules=None, |
| 536 | propagate_state=False): |
| 537 | # Process zephyr_base, projects, and modules and create a dictionary |
| 538 | # with meta information for each input. |
| 539 | # |
| 540 | # The dictionary will contain meta info in the following lists: |
| 541 | # - zephyr: path and revision |
| 542 | # - modules: name, path, and revision |
| 543 | # - west-projects: path and revision |
| 544 | # |
| 545 | # returns the dictionary with said lists |
| 546 | |
| 547 | meta = {'zephyr': None, 'modules': None, 'workspace': None} |
| 548 | |
| 549 | zephyr_project, zephyr_dirty = _create_meta_project(zephyr_base) |
| 550 | zephyr_off = zephyr_project.get("remote") is None |
| 551 | |
| 552 | workspace_dirty = zephyr_dirty |
| 553 | workspace_extra = extra_modules is not None |
| 554 | workspace_off = zephyr_off |
| 555 | |
| 556 | if zephyr_off: |
| 557 | zephyr_project['revision'] += '-off' |
| 558 | |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 559 | meta['zephyr'] = zephyr_project |
| 560 | meta['workspace'] = {} |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 561 | |
Carles Cufi | a580b3d | 2022-08-09 11:13:54 +0200 | [diff] [blame] | 562 | if west_projs is not None: |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 563 | from west.manifest import MANIFEST_REV_BRANCH |
Carles Cufi | a580b3d | 2022-08-09 11:13:54 +0200 | [diff] [blame] | 564 | projects = west_projs['projects'] |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 565 | meta_projects = [] |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 566 | |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 567 | manifest_path = projects[0].posixpath |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 568 | |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 569 | # Special treatment of manifest project |
| 570 | # Git information (remote/revision) are not provided by west for the Manifest (west.yml) |
| 571 | # To mitigate this, we check if we don't use the manifest from the zephyr repository or an other project. |
| 572 | # If it's from zephyr, reuse zephyr information |
| 573 | # If it's from an other project, ignore it, it will be added later |
| 574 | # If it's not found, we extract data manually (remote/revision) from the directory |
| 575 | |
| 576 | manifest_project = None |
| 577 | manifest_dirty = False |
| 578 | manifest_off = False |
| 579 | |
| 580 | if zephyr_base == manifest_path: |
| 581 | manifest_project = zephyr_project |
| 582 | manifest_dirty = zephyr_dirty |
| 583 | manifest_off = zephyr_off |
| 584 | elif not [ prj for prj in projects[1:] if prj.posixpath == manifest_path ]: |
| 585 | manifest_project, manifest_dirty = _create_meta_project( |
| 586 | projects[0].posixpath) |
| 587 | manifest_off = manifest_project.get("remote") is None |
| 588 | if manifest_off: |
| 589 | manifest_project["revision"] += "-off" |
| 590 | |
| 591 | if manifest_project: |
| 592 | workspace_off |= manifest_off |
| 593 | workspace_dirty |= manifest_dirty |
| 594 | meta_projects.append(manifest_project) |
| 595 | |
| 596 | # Iterates on all projects except the first one (manifest) |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 597 | for project in projects[1:]: |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 598 | meta_project, dirty = _create_meta_project(project.posixpath) |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 599 | workspace_dirty |= dirty |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 600 | meta_projects.append(meta_project) |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 601 | |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 602 | off = False |
| 603 | if not meta_project.get("remote") or project.sha(MANIFEST_REV_BRANCH) != meta_project['revision'].removesuffix("-dirty"): |
| 604 | off = True |
| 605 | if not meta_project.get('remote') or project.url != meta_project['remote']: |
| 606 | # Force manifest URL and set commit as 'off' |
| 607 | meta_project['url'] = project.url |
| 608 | off = True |
| 609 | |
| 610 | if off: |
| 611 | meta_project['revision'] += '-off' |
| 612 | workspace_off |= off |
| 613 | |
| 614 | # If manifest is in project, updates related variables |
| 615 | if project.posixpath == manifest_path: |
| 616 | manifest_dirty |= dirty |
| 617 | manifest_off |= off |
| 618 | manifest_project = meta_project |
| 619 | |
Carles Cufi | a580b3d | 2022-08-09 11:13:54 +0200 | [diff] [blame] | 620 | meta.update({'west': {'manifest': west_projs['manifest_path'], |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 621 | 'projects': meta_projects}}) |
| 622 | meta['workspace'].update({'off': workspace_off}) |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 623 | |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 624 | # Iterates on all modules |
| 625 | meta_modules = [] |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 626 | for module in modules: |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 627 | # Check if modules is not in projects |
| 628 | # It allows to have the "-off" flag since `modules` variable` does not provide URL/remote |
| 629 | meta_module = _get_meta_project(meta_projects, module.project) |
| 630 | |
| 631 | if not meta_module: |
| 632 | meta_module, dirty = _create_meta_project(module.project) |
| 633 | workspace_dirty |= dirty |
| 634 | |
| 635 | meta_module['name'] = module.meta.get('name') |
| 636 | |
| 637 | if module.meta.get('security'): |
| 638 | meta_module['security'] = module.meta.get('security') |
| 639 | meta_modules.append(meta_module) |
| 640 | |
| 641 | meta['modules'] = meta_modules |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 642 | |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 643 | meta['workspace'].update({'dirty': workspace_dirty, |
| 644 | 'extra': workspace_extra}) |
| 645 | |
Torsten Rasmussen | 1a51993 | 2021-11-04 18:35:50 +0100 | [diff] [blame] | 646 | if propagate_state: |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 647 | zephyr_revision = zephyr_project['revision'] |
Torsten Rasmussen | 1a51993 | 2021-11-04 18:35:50 +0100 | [diff] [blame] | 648 | if workspace_dirty and not zephyr_dirty: |
| 649 | zephyr_revision += '-dirty' |
| 650 | if workspace_extra: |
| 651 | zephyr_revision += '-extra' |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 652 | if workspace_off and not zephyr_off: |
Torsten Rasmussen | 1a51993 | 2021-11-04 18:35:50 +0100 | [diff] [blame] | 653 | zephyr_revision += '-off' |
| 654 | zephyr_project.update({'revision': zephyr_revision}) |
| 655 | |
Carles Cufi | a580b3d | 2022-08-09 11:13:54 +0200 | [diff] [blame] | 656 | if west_projs is not None: |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 657 | manifest_revision = manifest_project['revision'] |
Torsten Rasmussen | 1a51993 | 2021-11-04 18:35:50 +0100 | [diff] [blame] | 658 | if workspace_dirty and not manifest_dirty: |
| 659 | manifest_revision += '-dirty' |
| 660 | if workspace_extra: |
| 661 | manifest_revision += '-extra' |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 662 | if workspace_off and not manifest_off: |
Torsten Rasmussen | 1a51993 | 2021-11-04 18:35:50 +0100 | [diff] [blame] | 663 | manifest_revision += '-off' |
| 664 | manifest_project.update({'revision': manifest_revision}) |
| 665 | |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 666 | return meta |
| 667 | |
| 668 | |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 669 | def west_projects(manifest=None): |
Carles Cufi | a580b3d | 2022-08-09 11:13:54 +0200 | [diff] [blame] | 670 | manifest_path = None |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 671 | projects = [] |
| 672 | # West is imported here, as it is optional |
| 673 | # (and thus maybe not installed) |
| 674 | # if user is providing a specific modules list. |
Tristan Honscheid | dbbe802 | 2022-05-06 11:47:47 -0600 | [diff] [blame] | 675 | try: |
Martí Bolívar | 251f269 | 2023-05-19 11:22:01 -0700 | [diff] [blame] | 676 | from west.manifest import Manifest |
Tristan Honscheid | dbbe802 | 2022-05-06 11:47:47 -0600 | [diff] [blame] | 677 | except ImportError: |
| 678 | # West is not installed, so don't return any projects. |
| 679 | return None |
| 680 | |
Martí Bolívar | 251f269 | 2023-05-19 11:22:01 -0700 | [diff] [blame] | 681 | # If west *is* installed, we need all of the following imports to |
| 682 | # work. West versions that are excessively old may fail here: |
| 683 | # west.configuration.MalformedConfig was |
| 684 | # west.manifest.MalformedConfig until west v0.14.0, for example. |
| 685 | # These should be hard errors. |
| 686 | from west.manifest import \ |
| 687 | ManifestImportFailed, MalformedManifest, ManifestVersionError |
| 688 | from west.configuration import MalformedConfig |
| 689 | from west.util import WestNotFound |
| 690 | from west.version import __version__ as WestVersion |
| 691 | |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 692 | from packaging import version |
| 693 | try: |
Carles Cufi | a580b3d | 2022-08-09 11:13:54 +0200 | [diff] [blame] | 694 | if not manifest: |
| 695 | manifest = Manifest.from_file() |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 696 | if version.parse(WestVersion) >= version.parse('0.9.0'): |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 697 | projects = [p for p in manifest.get_projects([]) |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 698 | if manifest.is_active(p)] |
| 699 | else: |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 700 | projects = manifest.get_projects([]) |
Carles Cufi | a580b3d | 2022-08-09 11:13:54 +0200 | [diff] [blame] | 701 | manifest_path = manifest.path |
| 702 | return {'manifest_path': manifest_path, 'projects': projects} |
Martí Bolívar | ce2a7d9 | 2023-05-18 13:21:34 -0700 | [diff] [blame] | 703 | except (ManifestImportFailed, MalformedManifest, |
| 704 | ManifestVersionError, MalformedConfig) as e: |
| 705 | sys.exit(f'ERROR: {e}') |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 706 | except WestNotFound: |
| 707 | # Only accept WestNotFound, meaning we are not in a west |
| 708 | # workspace. Such setup is allowed, as west may be installed |
| 709 | # but the project is not required to use west. |
| 710 | pass |
| 711 | return None |
| 712 | |
| 713 | |
Carles Cufi | a580b3d | 2022-08-09 11:13:54 +0200 | [diff] [blame] | 714 | def parse_modules(zephyr_base, manifest=None, west_projs=None, modules=None, |
| 715 | extra_modules=None): |
| 716 | |
Marcin Niestroj | 248d25d | 2021-05-08 16:56:34 +0200 | [diff] [blame] | 717 | if modules is None: |
Carles Cufi | a580b3d | 2022-08-09 11:13:54 +0200 | [diff] [blame] | 718 | west_projs = west_projs or west_projects(manifest) |
| 719 | modules = ([p.posixpath for p in west_projs['projects']] |
| 720 | if west_projs else []) |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 721 | |
Marcin Niestroj | 248d25d | 2021-05-08 16:56:34 +0200 | [diff] [blame] | 722 | if extra_modules is None: |
| 723 | extra_modules = [] |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 724 | |
Torsten Rasmussen | 3917ee5 | 2020-05-18 22:34:49 +0200 | [diff] [blame] | 725 | Module = namedtuple('Module', ['project', 'meta', 'depends']) |
Damian Krolik | a505148 | 2022-03-01 18:36:16 +0100 | [diff] [blame] | 726 | |
| 727 | all_modules_by_name = {} |
Torsten Rasmussen | 3917ee5 | 2020-05-18 22:34:49 +0200 | [diff] [blame] | 728 | # dep_modules is a list of all modules that has an unresolved dependency |
| 729 | dep_modules = [] |
| 730 | # start_modules is a list modules with no depends left (no incoming edge) |
| 731 | start_modules = [] |
| 732 | # sorted_modules is a topological sorted list of the modules |
| 733 | sorted_modules = [] |
| 734 | |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 735 | for project in modules + extra_modules: |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 736 | # Avoid including Zephyr base project as module. |
Marcin Niestroj | 248d25d | 2021-05-08 16:56:34 +0200 | [diff] [blame] | 737 | if project == zephyr_base: |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 738 | continue |
| 739 | |
| 740 | meta = process_module(project) |
| 741 | if meta: |
Damian Krolik | a505148 | 2022-03-01 18:36:16 +0100 | [diff] [blame] | 742 | depends = meta.get('build', {}).get('depends', []) |
| 743 | all_modules_by_name[meta['name']] = Module(project, meta, depends) |
| 744 | |
Martí Bolívar | 34346c4 | 2020-01-29 12:38:58 -0800 | [diff] [blame] | 745 | elif project in extra_modules: |
| 746 | sys.exit(f'{project}, given in ZEPHYR_EXTRA_MODULES, ' |
| 747 | 'is not a valid zephyr module') |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 748 | |
Damian Krolik | a505148 | 2022-03-01 18:36:16 +0100 | [diff] [blame] | 749 | for module in all_modules_by_name.values(): |
| 750 | if not module.depends: |
| 751 | start_modules.append(module) |
| 752 | else: |
| 753 | dep_modules.append(module) |
| 754 | |
Torsten Rasmussen | 3917ee5 | 2020-05-18 22:34:49 +0200 | [diff] [blame] | 755 | # This will do a topological sort to ensure the modules are ordered |
| 756 | # according to dependency settings. |
| 757 | while start_modules: |
| 758 | node = start_modules.pop(0) |
| 759 | sorted_modules.append(node) |
Torsten Rasmussen | f24f883 | 2021-01-07 15:27:53 +0100 | [diff] [blame] | 760 | node_name = node.meta['name'] |
Torsten Rasmussen | 3917ee5 | 2020-05-18 22:34:49 +0200 | [diff] [blame] | 761 | to_remove = [] |
| 762 | for module in dep_modules: |
| 763 | if node_name in module.depends: |
| 764 | module.depends.remove(node_name) |
| 765 | if not module.depends: |
| 766 | start_modules.append(module) |
| 767 | to_remove.append(module) |
| 768 | for module in to_remove: |
| 769 | dep_modules.remove(module) |
| 770 | |
| 771 | if dep_modules: |
| 772 | # If there are any modules with unresolved dependencies, then the |
| 773 | # modules contains unmet or cyclic dependencies. Error out. |
| 774 | error = 'Unmet or cyclic dependencies in modules:\n' |
| 775 | for module in dep_modules: |
| 776 | error += f'{module.project} depends on: {module.depends}\n' |
| 777 | sys.exit(error) |
| 778 | |
Marcin Niestroj | 248d25d | 2021-05-08 16:56:34 +0200 | [diff] [blame] | 779 | return sorted_modules |
| 780 | |
| 781 | |
| 782 | def main(): |
| 783 | parser = argparse.ArgumentParser(description=''' |
| 784 | Process a list of projects and create Kconfig / CMake include files for |
Jamie McCrae | ec70444 | 2023-01-04 16:08:36 +0000 | [diff] [blame] | 785 | projects which are also a Zephyr module''', allow_abbrev=False) |
Marcin Niestroj | 248d25d | 2021-05-08 16:56:34 +0200 | [diff] [blame] | 786 | |
| 787 | parser.add_argument('--kconfig-out', |
| 788 | help="""File to write with resulting KConfig import |
| 789 | statements.""") |
| 790 | parser.add_argument('--twister-out', |
| 791 | help="""File to write with resulting twister |
| 792 | parameters.""") |
| 793 | parser.add_argument('--cmake-out', |
| 794 | help="""File to write with resulting <name>:<path> |
| 795 | values to use for including in CMake""") |
Jamie McCrae | df9027a | 2023-02-20 10:00:38 +0000 | [diff] [blame] | 796 | parser.add_argument('--sysbuild-kconfig-out', |
| 797 | help="""File to write with resulting KConfig import |
| 798 | statements.""") |
| 799 | parser.add_argument('--sysbuild-cmake-out', |
| 800 | help="""File to write with resulting <name>:<path> |
| 801 | values to use for including in CMake""") |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 802 | parser.add_argument('--meta-out', |
| 803 | help="""Write a build meta YaML file containing a list |
| 804 | of Zephyr modules and west projects. |
| 805 | If a module or project is also a git repository |
| 806 | the current SHA revision will also be written.""") |
Torsten Rasmussen | 1a51993 | 2021-11-04 18:35:50 +0100 | [diff] [blame] | 807 | parser.add_argument('--meta-state-propagate', action='store_true', |
| 808 | help="""Propagate state of modules and west projects |
| 809 | to the suffix of the Zephyr SHA and if west is |
| 810 | used, to the suffix of the manifest SHA""") |
Marcin Niestroj | 248d25d | 2021-05-08 16:56:34 +0200 | [diff] [blame] | 811 | parser.add_argument('--settings-out', |
| 812 | help="""File to write with resulting <name>:<value> |
| 813 | values to use for including in CMake""") |
| 814 | parser.add_argument('-m', '--modules', nargs='+', |
| 815 | help="""List of modules to parse instead of using `west |
| 816 | list`""") |
| 817 | parser.add_argument('-x', '--extra-modules', nargs='+', |
| 818 | help='List of extra modules to parse') |
| 819 | parser.add_argument('-z', '--zephyr-base', |
| 820 | help='Path to zephyr repository') |
| 821 | args = parser.parse_args() |
| 822 | |
| 823 | kconfig = "" |
| 824 | cmake = "" |
Jamie McCrae | df9027a | 2023-02-20 10:00:38 +0000 | [diff] [blame] | 825 | sysbuild_kconfig = "" |
| 826 | sysbuild_cmake = "" |
Marcin Niestroj | 248d25d | 2021-05-08 16:56:34 +0200 | [diff] [blame] | 827 | settings = "" |
| 828 | twister = "" |
| 829 | |
Carles Cufi | a580b3d | 2022-08-09 11:13:54 +0200 | [diff] [blame] | 830 | west_projs = west_projects() |
| 831 | modules = parse_modules(args.zephyr_base, None, west_projs, |
| 832 | args.modules, args.extra_modules) |
Marcin Niestroj | 248d25d | 2021-05-08 16:56:34 +0200 | [diff] [blame] | 833 | |
| 834 | for module in modules: |
Torsten Rasmussen | 3917ee5 | 2020-05-18 22:34:49 +0200 | [diff] [blame] | 835 | kconfig += process_kconfig(module.project, module.meta) |
| 836 | cmake += process_cmake(module.project, module.meta) |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 837 | sysbuild_kconfig += process_sysbuildkconfig( |
| 838 | module.project, module.meta) |
Jamie McCrae | df9027a | 2023-02-20 10:00:38 +0000 | [diff] [blame] | 839 | sysbuild_cmake += process_sysbuildcmake(module.project, module.meta) |
Torsten Rasmussen | 25d57ba | 2020-07-07 17:29:56 +0200 | [diff] [blame] | 840 | settings += process_settings(module.project, module.meta) |
Anas Nashif | 5471398 | 2020-12-07 14:52:10 -0500 | [diff] [blame] | 841 | twister += process_twister(module.project, module.meta) |
Torsten Rasmussen | 3917ee5 | 2020-05-18 22:34:49 +0200 | [diff] [blame] | 842 | |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 843 | if args.kconfig_out: |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 844 | with open(args.kconfig_out, 'w', encoding="utf-8") as fp: |
| 845 | fp.write(kconfig) |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 846 | |
| 847 | if args.cmake_out: |
Anas Nashif | 286a9ed | 2019-12-11 10:13:23 -0500 | [diff] [blame] | 848 | with open(args.cmake_out, 'w', encoding="utf-8") as fp: |
| 849 | fp.write(cmake) |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 850 | |
Jamie McCrae | df9027a | 2023-02-20 10:00:38 +0000 | [diff] [blame] | 851 | if args.sysbuild_kconfig_out: |
| 852 | with open(args.sysbuild_kconfig_out, 'w', encoding="utf-8") as fp: |
| 853 | fp.write(sysbuild_kconfig) |
| 854 | |
| 855 | if args.sysbuild_cmake_out: |
| 856 | with open(args.sysbuild_cmake_out, 'w', encoding="utf-8") as fp: |
| 857 | fp.write(sysbuild_cmake) |
| 858 | |
Torsten Rasmussen | 25d57ba | 2020-07-07 17:29:56 +0200 | [diff] [blame] | 859 | if args.settings_out: |
| 860 | with open(args.settings_out, 'w', encoding="utf-8") as fp: |
Martí Bolívar | 361956b | 2021-08-09 10:46:17 -0700 | [diff] [blame] | 861 | fp.write('''\ |
| 862 | # WARNING. THIS FILE IS AUTO-GENERATED. DO NOT MODIFY! |
| 863 | # |
| 864 | # This file contains build system settings derived from your modules. |
| 865 | # |
| 866 | # Modules may be set via ZEPHYR_MODULES, ZEPHYR_EXTRA_MODULES, |
| 867 | # and/or the west manifest file. |
| 868 | # |
| 869 | # See the Modules guide for more information. |
| 870 | ''') |
Torsten Rasmussen | 25d57ba | 2020-07-07 17:29:56 +0200 | [diff] [blame] | 871 | fp.write(settings) |
| 872 | |
Anas Nashif | 5471398 | 2020-12-07 14:52:10 -0500 | [diff] [blame] | 873 | if args.twister_out: |
| 874 | with open(args.twister_out, 'w', encoding="utf-8") as fp: |
| 875 | fp.write(twister) |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 876 | |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 877 | if args.meta_out: |
Carles Cufi | a580b3d | 2022-08-09 11:13:54 +0200 | [diff] [blame] | 878 | meta = process_meta(args.zephyr_base, west_projs, modules, |
Torsten Rasmussen | 1a51993 | 2021-11-04 18:35:50 +0100 | [diff] [blame] | 879 | args.extra_modules, args.meta_state_propagate) |
Torsten Rasmussen | 64ec6ee | 2021-11-04 14:28:21 +0100 | [diff] [blame] | 880 | |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 881 | with open(args.meta_out, 'w', encoding="utf-8") as fp: |
Thomas Gagneret | 0d05318 | 2024-01-18 17:31:46 +0100 | [diff] [blame] | 882 | # Ignore references and insert data instead |
| 883 | yaml.Dumper.ignore_aliases = lambda self, data: True |
Torsten Rasmussen | fffaf05 | 2021-10-12 23:08:36 +0200 | [diff] [blame] | 884 | fp.write(yaml.dump(meta)) |
| 885 | |
Torsten Rasmussen | 25c3f8e | 2020-08-25 14:02:04 +0200 | [diff] [blame] | 886 | |
Torsten Rasmussen | bd7569f | 2019-03-19 10:38:18 +0100 | [diff] [blame] | 887 | if __name__ == "__main__": |
| 888 | main() |