From 684b4c69fa4de864b036f6e1aa886abc6ceeeb0a Mon Sep 17 00:00:00 2001 From: Peter Ujfalusi Date: Fri, 15 Dec 2023 14:11:08 +0200 Subject: [PATCH 1/4] xtensa-build-zephyr.py: Remove IPC4_CONFIG_OVERLAY from PlatformConfig The IPC4_CONFIG_OVERLAY is no longer used, remove it. Signed-off-by: Peter Ujfalusi --- scripts/xtensa-build-zephyr.py | 1 - 1 file changed, 1 deletion(-) diff --git a/scripts/xtensa-build-zephyr.py b/scripts/xtensa-build-zephyr.py index 01347e1cce83..b2fe259d682a 100755 --- a/scripts/xtensa-build-zephyr.py +++ b/scripts/xtensa-build-zephyr.py @@ -82,7 +82,6 @@ class PlatformConfig: XTENSA_CORE: str DEFAULT_TOOLCHAIN_VARIANT: str = "xt-clang" RIMAGE_KEY: pathlib.Path = pathlib.Path(SOF_TOP, "keys", "otc_private_key_3k.pem") - IPC4_CONFIG_OVERLAY: str = "ipc4_overlay.conf" aliases: list = dataclasses.field(default_factory=list) # These can all be built out of the box. --all builds all these. From 8779ab2839b4e64203d54f51a894018635f300c5 Mon Sep 17 00:00:00 2001 From: Peter Ujfalusi Date: Mon, 18 Dec 2023 09:05:35 +0200 Subject: [PATCH 2/4] xtensa-build-zephyr.py: Fill in missing platform aliases The following aliases are missing: tgl: adl-n, rpl tgl-h: rpl-s mtl: arl Update the aliases list accordingly. Signed-off-by: Peter Ujfalusi --- scripts/xtensa-build-zephyr.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/scripts/xtensa-build-zephyr.py b/scripts/xtensa-build-zephyr.py index b2fe259d682a..0f15e37eaf62 100755 --- a/scripts/xtensa-build-zephyr.py +++ b/scripts/xtensa-build-zephyr.py @@ -93,19 +93,20 @@ class PlatformConfig: f"RG-2017.8{xtensa_tools_version_postfix}", "cavs2x_LX6HiFi3_2017_8", "xcc", - aliases = ['adl', 'ehl'] + aliases = ['adl', 'adl-n', 'ehl', 'rpl'] ), "tgl-h" : PlatformConfig( "tgl-h", "intel_adsp_cavs25_tgph", f"RG-2017.8{xtensa_tools_version_postfix}", "cavs2x_LX6HiFi3_2017_8", "xcc", - aliases = ['adl-s'] + aliases = ['adl-s', 'rpl-s'] ), "mtl" : PlatformConfig( "mtl", "intel_adsp_ace15_mtpm", f"RI-2022.10{xtensa_tools_version_postfix}", "ace10_LX7HiFi4_2022_10", + aliases = ['arl'] ), "lnl" : PlatformConfig( "lnl", "intel_adsp_ace20_lnl", From 6127c71cfbe9fe988dadbd1a70294838da4a8a03 Mon Sep 17 00:00:00 2001 From: Peter Ujfalusi Date: Mon, 18 Dec 2023 10:01:17 +0200 Subject: [PATCH 3/4] xtensa-build-zephyr.py: Print out the platform aliases in help Print platform alias information to reduce the need for guessing when trying to figure out what platform supports what platform. Signed-off-by: Peter Ujfalusi --- scripts/xtensa-build-zephyr.py | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/scripts/xtensa-build-zephyr.py b/scripts/xtensa-build-zephyr.py index 0f15e37eaf62..750eaf02b2b6 100755 --- a/scripts/xtensa-build-zephyr.py +++ b/scripts/xtensa-build-zephyr.py @@ -178,8 +178,10 @@ def parse_args(): " └── RG-2017.8{}/\n".format(xtensa_tools_version_postfix) + " └── XtensaTools/\n" + "$XTENSA_TOOLS_ROOT=/path/to/myXtensa ...\n" + - f"Supported platforms: {list(platform_configs)}")) + f"\nSupported platforms: {list(platform_configs)}"), add_help=False) + + parser.add_argument('-h', '--help', action='store_true', help='show help') parser.add_argument("-a", "--all", required=False, action="store_true", help="Build all currently supported platforms") parser.add_argument("platforms", nargs="*", action=validate_platforms_arguments, @@ -264,9 +266,14 @@ def parse_args(): args.platforms = list(platform_configs_all) # print help message if no arguments provided - if len(sys.argv) == 1: - parser.print_help() - sys.exit(0) + if len(sys.argv) == 1 or args.help: + for platform in platform_configs: + if platform_configs[platform].aliases: + parser.epilog += "\nPlatform aliases for '" + platform + "':\t" + parser.epilog += f"{list(platform_configs[platform].aliases)}" + + parser.print_help() + sys.exit(0) if args.fw_naming == 'AVS': if not args.use_platform_subdir: From 03abba172bc30cd0b474bd9949a050a162fd6d9d Mon Sep 17 00:00:00 2001 From: Peter Ujfalusi Date: Mon, 18 Dec 2023 13:31:31 +0200 Subject: [PATCH 4/4] xtensa-build-zephyr.py: Add option to create deployable build MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The default firmware file path is standardized among vendors as follows: IPC3 /lib/firmware/VENDOR/sof/ ├── community │ └── sof-PLAT.ri ├── dbgkey │ └── sof-PLAT.ri └── sof-PLAT.ri IPC4 /lib/firmware/VENDOR/sof-ipc4/ └── PLAT ├── community │ └── sof-PLAT.ri ├── dbgkey │ └── sof-PLAT.ri └── sof-PLAT.ri\n Currently the binaries created by the build can only be used for direct deployment on IPC3 platforms but if one builds different vendor firmwares the files have to be manually picked and sorted out. We have two flags: --fw-naming and --use-platform-subdir which can be played with but still not going to produce deployable build. Introduce a new flag: --deployable-build With the flag specified all other modificators are going to be ignored and the build will do the 'right thing' to create a directory structure which can be deployed as it is to the target's firmware directory. To achieve this several changes needed: PlatformConfig: - drop the name member and replace it with a vendor string - add a flag to indicate IPC4 platforms Later a new option can be added if needed for platforms which can be IPC3 or IPC4 Ignore fw-naming and use-platform-subdir in case of deployable build. The options will be reset to their default in case they are changed. symlink_or_copy extended to handle relative symlinks when the target and link is not under the same directory. The --deployable-build is disabled by default, it has to be enabled to create deployable build for now. Signed-off-by: Peter Ujfalusi --- scripts/xtensa-build-zephyr.py | 131 +++++++++++++++++++++++++-------- 1 file changed, 100 insertions(+), 31 deletions(-) diff --git a/scripts/xtensa-build-zephyr.py b/scripts/xtensa-build-zephyr.py index 750eaf02b2b6..41693e5f03f4 100755 --- a/scripts/xtensa-build-zephyr.py +++ b/scripts/xtensa-build-zephyr.py @@ -76,65 +76,70 @@ # pylint:disable=too-many-instance-attributes class PlatformConfig: "Product parameters" - name: str + vendor: str PLAT_CONFIG: str XTENSA_TOOLS_VERSION: str XTENSA_CORE: str DEFAULT_TOOLCHAIN_VARIANT: str = "xt-clang" RIMAGE_KEY: pathlib.Path = pathlib.Path(SOF_TOP, "keys", "otc_private_key_3k.pem") aliases: list = dataclasses.field(default_factory=list) + ipc4: bool = False # These can all be built out of the box. --all builds all these. # Some of these values are duplicated in sof/scripts/set_xtensa_param.sh: keep them in sync. platform_configs_all = { # Intel platforms "tgl" : PlatformConfig( - "tgl", "intel_adsp_cavs25", + "intel", "intel_adsp_cavs25", f"RG-2017.8{xtensa_tools_version_postfix}", "cavs2x_LX6HiFi3_2017_8", "xcc", - aliases = ['adl', 'adl-n', 'ehl', 'rpl'] + aliases = ['adl', 'adl-n', 'ehl', 'rpl'], + ipc4 = True ), "tgl-h" : PlatformConfig( - "tgl-h", "intel_adsp_cavs25_tgph", + "intel", "intel_adsp_cavs25_tgph", f"RG-2017.8{xtensa_tools_version_postfix}", "cavs2x_LX6HiFi3_2017_8", "xcc", - aliases = ['adl-s', 'rpl-s'] + aliases = ['adl-s', 'rpl-s'], + ipc4 = True ), "mtl" : PlatformConfig( - "mtl", "intel_adsp_ace15_mtpm", + "intel", "intel_adsp_ace15_mtpm", f"RI-2022.10{xtensa_tools_version_postfix}", "ace10_LX7HiFi4_2022_10", - aliases = ['arl'] + aliases = ['arl'], + ipc4 = True ), "lnl" : PlatformConfig( - "lnl", "intel_adsp_ace20_lnl", + "intel", "intel_adsp_ace20_lnl", f"RI-2022.10{xtensa_tools_version_postfix}", "ace10_LX7HiFi4_2022_10", + ipc4 = True ), # NXP platforms "imx8" : PlatformConfig( - "imx8", "nxp_adsp_imx8", + "imx", "nxp_adsp_imx8", f"RI-2023.11{xtensa_tools_version_postfix}", "hifi4_nxp_v5_3_1_prod", RIMAGE_KEY = "key param ignored by imx8", ), "imx8x" : PlatformConfig( - "imx8x", "nxp_adsp_imx8x", + "imx", "nxp_adsp_imx8x", f"RI-2023.11{xtensa_tools_version_postfix}", "hifi4_nxp_v5_3_1_prod", RIMAGE_KEY = "key param ignored by imx8x" ), "imx8m" : PlatformConfig( - "imx8m", "nxp_adsp_imx8m", + "imx", "nxp_adsp_imx8m", f"RI-2023.11{xtensa_tools_version_postfix}", "hifi4_mscale_v2_0_2_prod", RIMAGE_KEY = "key param ignored by imx8m" ), "imx8ulp" : PlatformConfig( - "imx8ulp", "nxp_adsp_imx8ulp", + "imx", "nxp_adsp_imx8ulp", f"RI-2023.11{xtensa_tools_version_postfix}", "hifi4_nxp2_s7_v2_1a_prod", RIMAGE_KEY = "key param ignored by imx8ulp" @@ -257,6 +262,28 @@ def parse_args(): help="""Run script in non-interactive mode when user input can not be provided. This should be used with programmatic script invocations (eg. Continuous Integration). """) + + parser.add_argument("--deployable-build", default=False, action="store_true", + help="""Create a directory structure for the firmware files which can be deployed on target as it is. +This option will cause the --fw-naming and --use-platform-subdir options to be ignored! +The generic, default directory and file structure is IPC version dependent: +IPC3 + build-sof-staging/sof/VENDOR/sof/ (on target: /lib/firmware/VENDOR/sof/) + ├── community + │ └── sof-PLAT.ri + ├── dbgkey + │ └── sof-PLAT.ri + └── sof-PLAT.ri +IPC4 + build-sof-staging/sof/VENDOR/sof-ipc4/ (on target: /lib/firmware/VENDOR/sof-ipc4/) + └── PLAT + ├── community + │ └── sof-PLAT.ri + ├── dbgkey + │ └── sof-PLAT.ri + └── sof-PLAT.ri\n + """) + parser.add_argument("--version", required=False, action="store_true", help="Prints version of this script.") @@ -275,6 +302,14 @@ def parse_args(): parser.print_help() sys.exit(0) + if args.deployable_build: + if args.fw_naming == 'AVS': + args.fw_naming = 'SOF' + print("The option '--fw-naming AVS' is ignored for deployable builds.") + if args.use_platform_subdir: + args.use_platform_subdir = False + print("The option '--use-platform-subdir' is ignored for deployable builds.") + if args.fw_naming == 'AVS': if not args.use_platform_subdir: args.use_platform_subdir=True @@ -311,18 +346,18 @@ def execute_command(*run_args, **run_kwargs): return subprocess.run(*run_args, **run_kwargs) -def symlink_or_copy(directory, origbase, newbase): - """Create a symbolic link or copy in the same directory. Don't - bother Windows users with symbolic links because they require - special privileges. Windows don't care about /lib/firmware/sof/ - anyway. Make a copy instead to preserve cross-platform consistency. - +def symlink_or_copy(targetdir, targetfile, linkdir, linkfile): + """Create a relative symbolic link or copy. Don't bother Windows users + with symbolic links because they require special privileges. + Windows don't care about /lib/firmware/sof/ anyway. + Make a copy instead to preserve cross-platform consistency. """ - new = pathlib.Path(directory) / newbase + target = pathlib.Path(targetdir) / targetfile + link = pathlib.Path(linkdir) / linkfile if py_platform.system() == "Windows": - shutil.copy2(pathlib.Path(directory) / origbase, new) + shutil.copy2(target, link) else: - new.symlink_to(origbase) + link.symlink_to(os.path.relpath(target, linkdir)) def show_installed_files(): """[summary] Scans output directory building binary tree from files and folders @@ -520,6 +555,12 @@ def clean_staging(platform): for f in sof_output_dir.glob(f"**/sof-{p}.*"): os.remove(f) + # remove IPC4 deployable build directories + if platform_configs[platform].ipc4: + sof_platform_output_dir = sof_output_dir / platform_configs[platform].vendor / "sof-ipc4" + rmtree_if_exists(sof_platform_output_dir / platform) + for p_alias in platform_configs[platform].aliases: + rmtree_if_exists(sof_platform_output_dir / p_alias) RIMAGE_BUILD_DIR = west_top / "build-rimage" @@ -663,11 +704,21 @@ def build_platforms(): sof_output_dir.mkdir(parents=True, exist_ok=True) for platform in args.platforms: platf_build_environ = os.environ.copy() - if args.use_platform_subdir: - sof_platform_output_dir = pathlib.Path(sof_output_dir, platform) + + if args.deployable_build: + vendor_output_dir = pathlib.Path(sof_output_dir, platform_configs[platform].vendor) + if platform_configs[platform].ipc4: + sof_platform_output_dir = pathlib.Path(vendor_output_dir, "sof-ipc4") + else: + sof_platform_output_dir = pathlib.Path(vendor_output_dir, "sof") + sof_platform_output_dir.mkdir(parents=True, exist_ok=True) else: - sof_platform_output_dir = sof_output_dir + if args.use_platform_subdir: + sof_platform_output_dir = pathlib.Path(sof_output_dir, platform) + sof_platform_output_dir.mkdir(parents=True, exist_ok=True) + else: + sof_platform_output_dir = sof_output_dir # For now convert the new dataclass to what it used to be _dict = dataclasses.asdict(platform_configs[platform]) @@ -770,7 +821,7 @@ def build_platforms(): execute_command([str(smex_executable), "-l", str(fw_ldc_file), str(input_elf_file)]) for p_alias in platform_configs[platform].aliases: - symlink_or_copy(sof_platform_output_dir, f"sof-{platform}.ldc", f"sof-{p_alias}.ldc") + symlink_or_copy(sof_platform_output_dir, f"sof-{platform}.ldc", sof_platform_output_dir, f"sof-{p_alias}.ldc") # reproducible-zephyr.ri is less useful now that show_installed_files() shows # checksums too. However: - it's still useful when only the .ri file is @@ -812,7 +863,7 @@ def build_platforms(): symlinks=True, ignore_dangling_symlinks=True, dirs_exist_ok=True) -def install_platform(platform, sof_platform_output_dir, platf_build_environ): +def install_platform(platform, sof_output_dir, platf_build_environ): # Keep in sync with caller platform_build_dir_name = f"build-{platform}" @@ -824,10 +875,14 @@ def install_platform(platform, sof_platform_output_dir, platf_build_environ): # Disguise ourselves for local testing purposes output_fwname = "dsp_basefw.bin" else: - # Regular name + # Regular name (deployable build also uses SOF naming convention) output_fwname = "".join(["sof-", platform, ".ri"]) - install_key_dir = sof_platform_output_dir + if args.deployable_build and platform_configs[platform].ipc4: + install_key_dir = pathlib.Path(sof_output_dir, platform) + else: + install_key_dir = sof_output_dir + if args.key_type_subdir != "none": install_key_dir = install_key_dir / args.key_type_subdir @@ -835,10 +890,24 @@ def install_platform(platform, sof_platform_output_dir, platf_build_environ): # looses file owner and group - file is commonly accessible shutil.copy2(abs_build_dir / "zephyr.ri", install_key_dir / output_fwname) - # The production key is usually different - if args.key_type_subdir != "none" and args.fw_naming != "AVS": + if args.deployable_build and platform_configs[platform].ipc4: + # IPC4 deployable builds are using separate directories per platforms + # create the structure and symlinks for the alias platforms for p_alias in platform_configs[platform].aliases: - symlink_or_copy(install_key_dir, output_fwname, f"sof-{p_alias}.ri") + alias_fwname = "".join(["sof-", p_alias, ".ri"]) + + alias_key_dir = pathlib.Path(sof_output_dir, p_alias) + if args.key_type_subdir != "none": + alias_key_dir = alias_key_dir / args.key_type_subdir + + os.makedirs(alias_key_dir, exist_ok=True) + symlink_or_copy(install_key_dir, output_fwname, alias_key_dir, alias_fwname) + else: + # non deployable builds and IPC3 deployable builds are using the same symlink scheme + # The production key is usually different + if args.key_type_subdir != "none" and args.fw_naming != "AVS": + for p_alias in platform_configs[platform].aliases: + symlink_or_copy(install_key_dir, output_fwname, install_key_dir, f"sof-{p_alias}.ri") # sof-info/ directory