diff options
author | Tom Hughes <tomhughes@chromium.org> | 2022-09-21 14:08:36 -0700 |
---|---|---|
committer | Tom Hughes <tomhughes@chromium.org> | 2022-09-22 12:59:38 -0700 |
commit | c453fd704268ef72de871b0c5ac7a989de662334 (patch) | |
tree | fcf6ce5810f9ff9e3c8cce434812dd75492269ed /zephyr/zmake/zephyr_build_tools/generate_ec_version.py | |
parent | 6c1587ca70f558b4f96b3f0b18ad8b027d3ba99d (diff) | |
parent | 28712dae9d7ed1e694f7622cc083afa71090d4d5 (diff) | |
download | chrome-ec-c453fd704268ef72de871b0c5ac7a989de662334.tar.gz |
Merge remote-tracking branch cros/main into firmware-fpmcu-dartmonkey-releasefirmware-fpmcu-dartmonkey-release
Generated by: ./util/update_release_branch.py --board dartmonkey --relevant_paths_file
./util/fingerprint-relevant-paths.txt firmware-fpmcu-dartmonkey-release
Relevant changes:
git log --oneline 6c1587ca70..28712dae9d -- board/nocturne_fp
board/dartmonkey common/fpsensor docs/fingerprint driver/fingerprint
util/getversion.sh
ded9307b79 util/getversion.sh: Fix version when not in a git repo
956055e692 board: change Google USB vendor info
71b2ef709d Update license boilerplate text in source code files
33e11afda0 Revert "fpsensor: Build fpsensor source file with C++"
c8d0360723 fpsensor: Build fpsensor source file with C++
bc113abd53 fpsensor: Fix g++ compiler error
150a58a0dc fpsensor: Fix fp_set_sensor_mode return type
b33b5ce85b fpsensor: Remove nested designators for C++ compatibility
2e864b2539 tree-wide: const-ify argv for console commands
56d8b360f9 test: Add test for get ikm failure when seed not set
3a3d6c3690 test: Add test for fpsensor trivial key failure
233e6bbd08 fpsensor_crypto: Abstract calls to hmac_SHA256
0a041b285b docs/fingerprint: Typo correction
c03fab67e2 docs/fingerprint: Fix the path of fputils.py
0b5d4baf5a util/getversion.sh: Fix empty file list handling
6e128fe760 FPMCU dev board environment with Satlab
3eb29b6aa5 builtin: Move ssize_t to sys/types.h
345d62ebd1 docs/fingerprint: Update power numbers for latest dartmonkey release
c25ffdb316 common: Conditionally support printf %l and %i modifiers
9a3c514b45 test: Add a test to check if the debugger is connected
54e603413f Move standard library tests to their own file
43fa6b4bf8 docs/fingerprint: Update power numbers for latest bloonchipper release
25536f9a84 driver/fingerprint/fpc/bep/fpc_sensor_spi.c: Format with clang-format
4face99efd driver/fingerprint/fpc/libfp/fpc_sensor_pal.h: Format with clang-format
738de2b575 trng: Rename rand to trng_rand
14b8270edd docs/fingerprint: Update dragonclaw power numbers
0b268f93d1 driver/fingerprint/fpc/libfp/fpc_private.c: Format with clang-format
f80da163f2 driver/fingerprint/fpc/libfp/fpc_private.h: Format with clang-format
a0751778f4 board/nocturne_fp/ro_workarounds.c: Format with clang-format
5e9c85c9b1 driver/fingerprint/fpc/libfp/fpc_sensor_pal.c: Format with clang-format
c1f9dd3cf8 driver/fingerprint/fpc/libfp/fpc_bio_algorithm.h: Format with clang-format
eb1e1bed8d driver/fingerprint/fpc/libfp/fpc1145_private.h: Format with clang-format
6e7b611821 driver/fingerprint/fpc/bep/fpc_bio_algorithm.h: Format with clang-format
e0589cd5e2 driver/fingerprint/fpc/bep/fpc1035_private.h: Format with clang-format
58f0246dbe board/nocturne_fp/board_ro.c: Format with clang-format
7905e556a0 common/fpsensor/fpsensor_crypto.c: Format with clang-format
21289d170c driver/fingerprint/fpc/bep/fpc1025_private.h: Format with clang-format
98a20f937e common/fpsensor/fpsensor_state.c: Format with clang-format
a2d255d8af common/fpsensor/fpsensor.c: Format with clang-format
84e53a65da board/nocturne_fp/board.h: Format with clang-format
73055eeb3f driver/fingerprint/fpc/bep/fpc_private.c: Format with clang-format
0f7b5cb509 common/fpsensor/fpsensor_private.h: Format with clang-format
1ceade6e65 driver/fingerprint/fpc/bep/fpc_private.h: Format with clang-format
dca9d74321 Revert "trng: Rename rand to trng_rand"
a6b0b3554f trng: Rename rand to trng_rand
28d0b75b70 third_party/boringssl: Remove unused header
BRANCH=None
BUG=b:244387210 b:242720240 b:215613183 b:242720910 b:236386294
BUG=b:234181908 b:244781166 b:234781655 b:234143158 b:234181908
BUG=b:237344361 b:236025198 b:234181908 b:180945056 chromium:1098010
BUG=b:246424843 b:234181908 b:131913998
TEST=`make -j buildall`
TEST=./util/run_device_tests.py --board dartmonkey
Test "aes": PASSED
Test "cec": PASSED
Test "cortexm_fpu": PASSED
Test "crc": PASSED
Test "flash_physical": PASSED
Test "flash_write_protect": PASSED
Test "fpsensor_hw": PASSED
Test "fpsensor_spi_ro": PASSED
Test "fpsensor_spi_rw": PASSED
Test "fpsensor_uart_ro": PASSED
Test "fpsensor_uart_rw": PASSED
Test "mpu_ro": PASSED
Test "mpu_rw": PASSED
Test "mutex": PASSED
Test "pingpong": PASSED
Test "printf": PASSED
Test "queue": PASSED
Test "rollback_region0": PASSED
Test "rollback_region1": PASSED
Test "rollback_entropy": PASSED
Test "rtc": PASSED
Test "sha256": PASSED
Test "sha256_unrolled": PASSED
Test "static_if": PASSED
Test "stdlib": PASSED
Test "system_is_locked_wp_on": PASSED
Test "system_is_locked_wp_off": PASSED
Test "timer_dos": PASSED
Test "utils": PASSED
Test "utils_str": PASSED
Test "panic_data_dartmonkey_v2.0.2887": PASSED
Test "panic_data_nocturne_fp_v2.2.64": PASSED
Test "panic_data_nami_fp_v2.2.144": PASSED
Force-Relevant-Builds: all
Signed-off-by: Tom Hughes <tomhughes@chromium.org>
Change-Id: I2c312583a709fedae8fe11d92c22328c3b634bc7
Diffstat (limited to 'zephyr/zmake/zephyr_build_tools/generate_ec_version.py')
-rwxr-xr-x | zephyr/zmake/zephyr_build_tools/generate_ec_version.py | 169 |
1 files changed, 169 insertions, 0 deletions
diff --git a/zephyr/zmake/zephyr_build_tools/generate_ec_version.py b/zephyr/zmake/zephyr_build_tools/generate_ec_version.py new file mode 100755 index 0000000000..7d3a9450ee --- /dev/null +++ b/zephyr/zmake/zephyr_build_tools/generate_ec_version.py @@ -0,0 +1,169 @@ +#!/usr/bin/env python3 + +# Copyright 2022 The ChromiumOS Authors +# Use of this source code is governed by a BSD-style license that can be +# found in the LICENSE file. + +"""Code to generate the ec_version.h file.""" + +import argparse +import logging +import os.path +import pathlib +import sys + +import zmake.version + + +def convert_module_list_to_dict(modules: list) -> dict: + """Convert a list of string paths to modules in to a dict of module + names to paths.""" + + if not modules: + return {} + + dict_out = {} + for mod in modules: + if not mod.is_dir(): + raise FileNotFoundError(f"Module '{mod}' not found") + + dict_out[mod.name] = mod + + return dict_out + + +def main(): + """CLI entry point for generating the ec_version.h header""" + logging.basicConfig(level=logging.INFO, stream=sys.stderr) + + parser = argparse.ArgumentParser() + + parser.add_argument("header_path", help="Path to write ec_version.h to") + parser.add_argument( + "-s", + "--static", + action="store_true", + help="If set, generate a header which does not include information " + "like the username, hostname, or date, allowing the build to be" + "reproducible.", + ) + parser.add_argument( + "--base", + default=os.environ.get("ZEPHYR_BASE"), + help="Path to Zephyr base directory. Uses ZEPHYR_BASE env var if unset.", + ) + parser.add_argument( + "-m", + "--module", + action="append", + help="Specify modules paths to include in version hash. Uses " + "ZEPHYR_MODULES env var if unset", + ) + parser.add_argument( + "-n", "--name", required=True, type=str, help="Project name" + ) + + args = parser.parse_args() + + if args.base is None: + logging.error( + "No Zephyr base is defined. Pass --base or set env var ZEPHYR_BASE" + ) + return 1 + + logging.info("Zephyr Base: %s", args.base) + + if args.static: + logging.info("Using a static version string") + + # Make a dict of modules from the list. Modules can be added one at a time + # by repeating the -m flag, or once as a semicolon-separated list. In the + # later case, we need to expand the modules list. + + if args.module is None: + # No modules specified on command line. Default to environment variable. + env_modules = os.environ.get("ZEPHYR_MODULES") + args.module = env_modules.split(";") if env_modules else [] + logging.info( + "No modules passed via CLI. Getting list from ZEPHYR_MODULES" + ) + + elif len(args.module) == 1: + # In case of a single -m flag, treat value as a semicolon-delimited + # list. + args.module = args.module[0].split(";") + + try: + module_dict = convert_module_list_to_dict( + map(pathlib.Path, args.module) + ) + except FileNotFoundError as err: + logging.error("Cannot find module: %s", str(err)) + return 1 + + logging.info("Including modules: [%s]", ", ".join(args.module)) + + # Generate the version string that gets inserted in to the header. Will get + # commit IDs from Git + ver = zmake.version.get_version_string( + args.name, args.base, module_dict, args.static + ) + logging.info("Version string: %s", ver) + + # Now write the actual header file or put version string in stdout + if args.header_path == "-": + print(ver) + else: + output_path = pathlib.Path(args.header_path) + output_path.parent.mkdir(parents=True, exist_ok=True) + + logging.info("Writing header to %s", args.header_path) + zmake.version.write_version_header( + ver, output_path, sys.argv[0], args.static + ) + + return 0 + + +def maybe_reexec(): + """Re-exec using the zmake package from the EC source tree, as + opposed to the system's copy of zmake. This is useful for + development when engineers need to make changes to zmake. This + script relies on the zmake package for version string generation + logic. + + Returns: + None, if the re-exec did not happen, or never returns if the + re-exec did happen. + """ + # We only re-exec if we are inside of a chroot (since if installed + # standalone using pip, there's already an "editable install" + # feature for that in pip.) + env = dict(os.environ) + srcroot = env.get("CROS_WORKON_SRCROOT") + if not srcroot: + return + + # If for some reason we decide to move zmake in the future, then + # we don't want to use the re-exec logic. + zmake_path = ( + pathlib.Path(srcroot) / "src" / "platform" / "ec" / "zephyr" / "zmake" + ).resolve() + if not zmake_path.is_dir(): + return + + # If PYTHONPATH is set, it is either because we just did a + # re-exec, or because the user wants to run a specific copy of + # zmake. In either case, we don't want to re-exec. + if "PYTHONPATH" in env: + return + + # Set PYTHONPATH so that we run zmake from source. + env["PYTHONPATH"] = str(zmake_path) + + os.execve(sys.argv[0], sys.argv, env) + + +if __name__ == "__main__": + maybe_reexec() + sys.exit(main()) |