From patchwork Thu Nov 30 20:33:54 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Glass X-Patchwork-Id: 13475047 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 6D517C07CA9 for ; Thu, 30 Nov 2023 20:34:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-ID:Date:Subject:Cc:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=2tXujMDre1YedX1VYR7eSg+hyl5DuuH51XRZlBymRMA=; b=M0JuHEHXLZLkpy O6dDhpeggJBbVeoMs4D4Td6B41oiEh7rquWlwJPd/ExBn2xioYuw2m7pKr1jMWAP8EgSRD3bjXuxO fO1i0D/4b+EAaqMPrNprQK4teDy9JDn/GFenTbRXA4/1dFf2TKuagbrEFLr8/k53tw5MhKtITXXib vebPnIh8IPqDm+RriDyy7S0RQ09raEcvkLFSVHXVVjWtAUEsI0zq/xR/ujspyVunWHQceZnW/t5fh Fr5MxZzNtkZ4lb0MZs9343h/6WTWzU+CnYYX0rhk86uuuV84WOREHCFOl1mVYdLTnkOxdUl/Ej22k XiagkTjATTyGeAIc2R/w==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1r8njg-00Brck-2g; Thu, 30 Nov 2023 20:34:12 +0000 Received: from mail-il1-x129.google.com ([2607:f8b0:4864:20::129]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1r8nje-00BrbS-0Z for linux-arm-kernel@lists.infradead.org; Thu, 30 Nov 2023 20:34:11 +0000 Received: by mail-il1-x129.google.com with SMTP id e9e14a558f8ab-35942cb9ef4so4114925ab.3 for ; Thu, 30 Nov 2023 12:34:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1701376448; x=1701981248; darn=lists.infradead.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=sgkNVr637iddP10kktErFCRYoJ7YouXjWqvHwiDeUcs=; b=D6TKuAOTKlwlAXEP06BO/KpH6P2aD4tqqdn+Q6wIEZTYAhLzaVgKYKaR2qrLBVrGUp zcGqZgo8UljHh1dpTk549juwgG2n8nhAro9aok5Cqq45M946l5SjGX8tXJ6WsKfiU/LJ zFdSZO9VY14LXB8F7QoWf5R4YCrcjVmRx6wcg= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1701376448; x=1701981248; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=sgkNVr637iddP10kktErFCRYoJ7YouXjWqvHwiDeUcs=; b=N3nfHP5jwRFaFF9ml7ysPXAHBo7m0WYyOKwl72OP86zud3hdijdx9epphh4KfI/HaQ o0M0OdwHak4ALipeqNZP4xeGHYajFR+aPT81TUHRLLU+vCjC3DVAPpFpwuN3HXFpAZo6 fc57iG19diTH6KdUB4X574UtsjwZ05+hdPhVTtQsxMZG/pA+VRey+TxEVvQOlIazpfy9 arzyFe/nlDxAZ8yUMwC4N2swOLfOo4wnLrMHPZG6cvQ39HZQoTn5IzLw5p4xyrs7SV4z Lt1XfUDvIc9r4EcsPSnJafdyFvRmTF28OzdrM9vwxgXBjMUWbnLzv0ycqeSnKssLhkOi hlLQ== X-Gm-Message-State: AOJu0Yy1S7165On/Sg+84pFL0ssSLuI8Rrc/2ppXbJcb7dqaV60G/55Q cIfau2+E8LOvMQBmce3536XSshPF213keHYuxT4= X-Google-Smtp-Source: AGHT+IH+ngzFDU9faV0d7Hcc2/3b486G+AlJvx/x6A8mnmzkSgzG/ZftC3rccgUkt+jcZs/DxZicRg== X-Received: by 2002:a05:6e02:1748:b0:35d:42e5:f751 with SMTP id y8-20020a056e02174800b0035d42e5f751mr3946346ill.15.1701376448283; Thu, 30 Nov 2023 12:34:08 -0800 (PST) Received: from kea.bld.corp.google.com ([2620:15c:183:200:d134:ced6:d34f:38a6]) by smtp.gmail.com with ESMTPSA id r21-20020a056638101500b004665c3f56ebsm484788jab.15.2023.11.30.12.34.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 30 Nov 2023 12:34:07 -0800 (PST) From: Simon Glass To: linux-arm-kernel@lists.infradead.org Cc: U-Boot Mailing List , lkml , Ahmad Fatoum , Nicolas Schier , Tom Rini , Masahiro Yamada , Simon Glass , Catalin Marinas , Will Deacon Subject: [PATCH v8 1/2] arm64: Add BOOT_TARGETS variable Date: Thu, 30 Nov 2023 13:33:54 -0700 Message-ID: <20231130203358.879796-2-sjg@chromium.org> X-Mailer: git-send-email 2.43.0.rc2.451.g8631bc7472-goog In-Reply-To: <20231130203358.879796-1-sjg@chromium.org> References: <20231130203358.879796-1-sjg@chromium.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20231130_123410_209212_F53E61C6 X-CRM114-Status: GOOD ( 11.32 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Add a new variable containing a list of possible targets. Mark them as phony. This matches the approach taken for arch/arm Signed-off-by: Simon Glass --- (no changes since v7) Changes in v7: - Drop the kbuild tag Changes in v6: - Drop the unwanted .gz suffix arch/arm64/Makefile | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/arch/arm64/Makefile b/arch/arm64/Makefile index 9a2d3723cd0f..1bd4fae6e806 100644 --- a/arch/arm64/Makefile +++ b/arch/arm64/Makefile @@ -150,6 +150,10 @@ libs-$(CONFIG_EFI_STUB) += $(objtree)/drivers/firmware/efi/libstub/lib.a # Default target when executing plain make boot := arch/arm64/boot +BOOT_TARGETS := Image vmlinuz.efi + +PHONY += $(BOOT_TARGETS) + ifeq ($(CONFIG_EFI_ZBOOT),) KBUILD_IMAGE := $(boot)/Image.gz else @@ -159,7 +163,7 @@ endif all: $(notdir $(KBUILD_IMAGE)) vmlinuz.efi: Image -Image vmlinuz.efi: vmlinux +$(BOOT_TARGETS): vmlinux $(Q)$(MAKE) $(build)=$(boot) $(boot)/$@ Image.%: Image From patchwork Thu Nov 30 20:33:55 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Glass X-Patchwork-Id: 13475049 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 608E8C4167B for ; Thu, 30 Nov 2023 20:34:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-ID:Date:Subject:Cc:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=GHwbWNqRmmJTFbXM7pYRWHi8MVCDnjqYYBUUao6q6AI=; b=ymwn+4EDyxc2x6 KFEmwu0e45zPviHtqB/M2SiiTYrg8M50puXArVkGqXXEeNF8NBnOXkSiLFeDaV1fQotrtwbx/t7W/ 2nPN1PreznlApTKLoU3HGxftJJORjHRS2nAp4ATTfHveM5+F1i9taJM3xYFPvPobRXNAWomF1ANTk sBYzDeZwsbnZPXQGy68kM/4a5mOo2kg2Ciy96FieeY6bPNUkGbxAaPYa5ZgTrjZaJ1FxxoHio5CmA yMc+LzgyEFAzmA8xbyFiuUNGO6ZyaU3r9Y7lrT9kXYN+9guyrIb2rknNXpO3wmPqyb8ALQEmTO5g7 0nFf2dv9r2xS/yUcw5XA==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1r8njy-00BrlH-0k; Thu, 30 Nov 2023 20:34:30 +0000 Received: from mail-il1-x135.google.com ([2607:f8b0:4864:20::135]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1r8njg-00Brbx-1S for linux-arm-kernel@lists.infradead.org; Thu, 30 Nov 2023 20:34:15 +0000 Received: by mail-il1-x135.google.com with SMTP id e9e14a558f8ab-35d42541c63so3253075ab.0 for ; Thu, 30 Nov 2023 12:34:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1701376450; x=1701981250; darn=lists.infradead.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=gZQHlY66qU8bLw4CpOjnqcQ5M6qO2ZCbtGktnVSpfz4=; b=FnavtXDfAC6e+n6GS8UN2CetdO4GuZIOTz6WqMOqxoEFK+9UCkzZqmVOwtxTve3n5V Dot8+rlB9dp2beqdWYiC/3bcFyk6qj8zKICtI5uuuRcpkv+rSP5eCQn4RBRdcFGo7GFH PvBH0gIzzutJpQwxUXswtZGIEpSSuHaBpH7AM= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1701376450; x=1701981250; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=gZQHlY66qU8bLw4CpOjnqcQ5M6qO2ZCbtGktnVSpfz4=; b=ZvGhb0BKQJ/0vMV6MsT9KzuctWbcTSJS3l+FeP1324SkB0dngaJcRU7T12DQF+etI9 iqXYQP8fnq/yJ5zYZklZpL3vSghO6FONWge1/03dgXnxTbVo5+tD30Il4dz0Gr0hFvUc h6DCZFLpF+NsAexIc55jBmwxEND25GIsh6T5SFRnz2pS5vnHtWDxaGMq1KnbWf0vo4z9 bVXoUqn1acKmvxjkb3Jt5vMQNz9PqR77z6E2DINQ70y7yFEF5ZxHkp5DNVxbp9PGWiJr 7/a/tp1SSn5cBq1ALzbhbuTalBkqzeEPy/lVDTZZRN304T20nynrDsr2zuhlaugMq0Ih nDvw== X-Gm-Message-State: AOJu0YyU/E67TE76kq9YaRKVQqKgctWjTcArwsVKJaFfuwfTNg3K4m2z Ccruib35f3dUMF3tK4E0Xtgnef3XaQvgJVcWnWQ= X-Google-Smtp-Source: AGHT+IHLYisaWUYm9ArcusKaLodxUNDQwSrxRdMyBbJCYoUFBf7wj0l15QEs2kW2Hm9PgExJNE6IRA== X-Received: by 2002:a6b:6114:0:b0:791:385c:f8b0 with SMTP id v20-20020a6b6114000000b00791385cf8b0mr26596628iob.3.1701376449665; Thu, 30 Nov 2023 12:34:09 -0800 (PST) Received: from kea.bld.corp.google.com ([2620:15c:183:200:d134:ced6:d34f:38a6]) by smtp.gmail.com with ESMTPSA id r21-20020a056638101500b004665c3f56ebsm484788jab.15.2023.11.30.12.34.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 30 Nov 2023 12:34:09 -0800 (PST) From: Simon Glass To: linux-arm-kernel@lists.infradead.org Cc: U-Boot Mailing List , lkml , Ahmad Fatoum , Nicolas Schier , Tom Rini , Masahiro Yamada , Simon Glass , Catalin Marinas , Jonathan Corbet , Nathan Chancellor , Nick Terrell , Will Deacon , linux-doc@vger.kernel.org, linux-kbuild@vger.kernel.org, workflows@vger.kernel.org Subject: [PATCH v8 2/2] arm64: boot: Support Flat Image Tree Date: Thu, 30 Nov 2023 13:33:55 -0700 Message-ID: <20231130203358.879796-3-sjg@chromium.org> X-Mailer: git-send-email 2.43.0.rc2.451.g8631bc7472-goog In-Reply-To: <20231130203358.879796-1-sjg@chromium.org> References: <20231130203358.879796-1-sjg@chromium.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20231130_123412_490722_91148B5E X-CRM114-Status: GOOD ( 35.66 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Add a script which produces a Flat Image Tree (FIT), a single file containing the built kernel and associated devicetree files. Compression defaults to gzip which gives a good balance of size and performance. The files compress from about 86MB to 24MB using this approach. The FIT can be used by bootloaders which support it, such as U-Boot and Linuxboot. It permits automatic selection of the correct devicetree, matching the compatible string of the running board with the closest compatible string in the FIT. There is no need for filenames or other workarounds. Add a 'make image.fit' build target for arm64, as well. The FIT can be examined using 'dumpimage -l'. This features requires pylibfdt (use 'pip install libfdt'). It also requires compression utilities for the algorithm being used. Supported compression options are the same as the Image.xxx files. For now there is no way to change the compression other than by editing the rule for $(obj)/image.fit While FIT supports a ramdisk / initrd, no attempt is made to support this here, since it must be built separately from the Linux build. Signed-off-by: Simon Glass --- Changes in v8: - Drop compatible string in FDT node - Correct sorting of MAINTAINERS to before ARM64 PORT - Turn compress part of the make_fit.py comment in to a sentence - Add two blank lines before parse_args() and setup_fit() - Use 'image.fit: dtbs' instead of BUILD_DTBS var - Use '$( +L: linux-arm-kernel@lists.infradead.org (moderated for non-subscribers) +S: Maintained +F: arch/arm64/boot/Makefile +F: scripts/make_fit.py + ARM64 PORT (AARCH64 ARCHITECTURE) M: Catalin Marinas M: Will Deacon diff --git a/arch/arm64/Makefile b/arch/arm64/Makefile index 1bd4fae6e806..6b893dc454b7 100644 --- a/arch/arm64/Makefile +++ b/arch/arm64/Makefile @@ -150,7 +150,7 @@ libs-$(CONFIG_EFI_STUB) += $(objtree)/drivers/firmware/efi/libstub/lib.a # Default target when executing plain make boot := arch/arm64/boot -BOOT_TARGETS := Image vmlinuz.efi +BOOT_TARGETS := Image vmlinuz.efi image.fit PHONY += $(BOOT_TARGETS) @@ -162,7 +162,9 @@ endif all: $(notdir $(KBUILD_IMAGE)) -vmlinuz.efi: Image +image.fit: dtbs + +vmlinuz.efi image.fit: Image $(BOOT_TARGETS): vmlinux $(Q)$(MAKE) $(build)=$(boot) $(boot)/$@ @@ -215,6 +217,7 @@ virtconfig: define archhelp echo '* Image.gz - Compressed kernel image (arch/$(ARCH)/boot/Image.gz)' echo ' Image - Uncompressed kernel image (arch/$(ARCH)/boot/Image)' + echo ' image.fit - Flat Image Tree (arch/$(ARCH)/boot/image.fit)' echo ' install - Install uncompressed kernel' echo ' zinstall - Install compressed kernel' echo ' Install using (your) ~/bin/installkernel or' diff --git a/arch/arm64/boot/.gitignore b/arch/arm64/boot/.gitignore index af5dc61f8b43..abaae9de1bdd 100644 --- a/arch/arm64/boot/.gitignore +++ b/arch/arm64/boot/.gitignore @@ -2,3 +2,4 @@ Image Image.gz vmlinuz* +image.fit diff --git a/arch/arm64/boot/Makefile b/arch/arm64/boot/Makefile index 1761f5972443..62efb533a9bc 100644 --- a/arch/arm64/boot/Makefile +++ b/arch/arm64/boot/Makefile @@ -16,7 +16,8 @@ OBJCOPYFLAGS_Image :=-O binary -R .note -R .note.gnu.build-id -R .comment -S -targets := Image Image.bz2 Image.gz Image.lz4 Image.lzma Image.lzo Image.zst +targets := Image Image.bz2 Image.gz Image.lz4 Image.lzma Image.lzo \ + Image.zst image.fit $(obj)/Image: vmlinux FORCE $(call if_changed,objcopy) @@ -39,6 +40,12 @@ $(obj)/Image.lzo: $(obj)/Image FORCE $(obj)/Image.zst: $(obj)/Image FORCE $(call if_changed,zstd) +# Use this to override the compression algorithm +FIT_COMPRESS ?= gzip + +$(obj)/image.fit: $(obj)/Image FORCE + $(call cmd,fit,$(FIT_COMPRESS)) + EFI_ZBOOT_PAYLOAD := Image EFI_ZBOOT_BFD_TARGET := elf64-littleaarch64 EFI_ZBOOT_MACH_TYPE := ARM64 diff --git a/scripts/Makefile.lib b/scripts/Makefile.lib index 1a965fe68e01..41b360b11552 100644 --- a/scripts/Makefile.lib +++ b/scripts/Makefile.lib @@ -496,6 +496,19 @@ quiet_cmd_uimage = UIMAGE $@ -a $(UIMAGE_LOADADDR) -e $(UIMAGE_ENTRYADDR) \ -n '$(UIMAGE_NAME)' -d $< $@ +# Flat Image Tree (FIT) +# This allows for packaging of a kernel and all devicetrees files, using +# compression. +# --------------------------------------------------------------------------- + +MAKE_FIT := $(srctree)/scripts/make_fit.py + +quiet_cmd_fit = FIT $@ + cmd_fit = $(MAKE_FIT) -f $@ --arch $(UIMAGE_ARCH) --os linux \ + --name '$(UIMAGE_NAME)' \ + --compress $(UIMAGE_COMPRESSION) -k $< \ + $( +# + +"""Build a FIT containing a lot of devicetree files + +Usage: + make_fit.py -A arm64 -n 'Linux-6.6' -O linux + -f arch/arm64/boot/image.fit -k /tmp/kern/arch/arm64/boot/image.itk + /tmp/kern/arch/arm64/boot/dts/ -E -c gzip + +Creates a FIT containing the supplied kernel and a directory containing the +devicetree files. + +Use -E to generate an external FIT (where the data is placed after the +FIT data structure). This allows parsing of the data without loading +the entire FIT. + +Use -c to compress the data, using bzip2, gzip, lz4, lzma, lzo and +zstd algorithms. + +The resulting FIT can be booted by bootloaders which support FIT, such +as U-Boot, Linuxboot, Tianocore, etc. + +Note that this tool does not yet support adding a ramdisk / initrd. +""" + +import argparse +import collections +import os +import subprocess +import sys +import tempfile +import time + +import libfdt + + +# Tool extension and the name of the command-line tools +CompTool = collections.namedtuple('CompTool', 'ext,tools') + +COMP_TOOLS = { + 'bzip2': CompTool('.bz2', 'bzip2'), + 'gzip': CompTool('.gz', 'pigz,gzip'), + 'lz4': CompTool('.lz4', 'lz4'), + 'lzma': CompTool('.lzma', 'lzma'), + 'lzo': CompTool('.lzo', 'lzop'), + 'zstd': CompTool('.zstd', 'zstd'), +} + + +def parse_args(): + """Parse the program ArgumentParser + + Returns: + Namespace object containing the arguments + """ + epilog = 'Build a FIT from a directory tree containing .dtb files' + parser = argparse.ArgumentParser(epilog=epilog) + parser.add_argument('-A', '--arch', type=str, required=True, + help='Specifies the architecture') + parser.add_argument('-c', '--compress', type=str, default='none', + help='Specifies the compression') + parser.add_argument('-E', '--external', action='store_true', + help='Convert the FIT to use external data') + parser.add_argument('-n', '--name', type=str, required=True, + help='Specifies the name') + parser.add_argument('-O', '--os', type=str, required=True, + help='Specifies the operating system') + parser.add_argument('-f', '--fit', type=str, required=True, + help='Specifies the output file (.fit)') + parser.add_argument('-k', '--kernel', type=str, required=True, + help='Specifies the (uncompressed) kernel input file (.itk)') + parser.add_argument('srcdir', type=str, nargs='*', + help='Specifies the directory tree that contains .dtb files') + + return parser.parse_args() + + +def setup_fit(fsw, name): + """Make a start on writing the FIT + + Outputs the root properties and the 'images' node + + Args: + fsw (libfdt.FdtSw): Object to use for writing + name (str): Name of kernel image + """ + fsw.INC_SIZE = 65536 + fsw.finish_reservemap() + fsw.begin_node('') + fsw.property_string('description', f'{name} with devicetree set') + fsw.property_u32('#address-cells', 1) + + fsw.property_u32('timestamp', int(time.time())) + fsw.begin_node('images') + + +def write_kernel(fsw, data, args): + """Write out the kernel image + + Writes a kernel node along with the required properties + + Args: + fsw (libfdt.FdtSw): Object to use for writing + data (bytes): Data to write (possibly compressed) + args (Namespace): Contains necessary strings: + arch: FIT architecture, e.g. 'arm64' + fit_os: Operating Systems, e.g. 'linux' + name: Name of OS, e.g. 'Linux-6.6.0-rc7' + compress: Compression algorithm to use, e.g. 'gzip' + """ + with fsw.add_node('kernel'): + fsw.property_string('description', args.name) + fsw.property_string('type', 'kernel_noload') + fsw.property_string('arch', args.arch) + fsw.property_string('os', args.os) + fsw.property_string('compression', args.compress) + fsw.property('data', data) + fsw.property_u32('load', 0) + fsw.property_u32('entry', 0) + + +def finish_fit(fsw, entries): + """Finish the FIT ready for use + + Writes the /configurations node and subnodes + + Args: + fsw (libfdt.FdtSw): Object to use for writing + entries (list of tuple): List of configurations: + str: Description of model + str: Compatible stringlist + """ + fsw.end_node() + seq = 0 + with fsw.add_node('configurations'): + for model, compat in entries: + seq += 1 + with fsw.add_node(f'conf-{seq}'): + fsw.property('compatible', bytes(compat)) + fsw.property_string('description', model) + fsw.property_string('fdt', f'fdt-{seq}') + fsw.property_string('kernel', 'kernel') + fsw.end_node() + + +def compress_data(inf, compress): + """Compress data using a selected algorithm + + Args: + inf (IOBase): Filename containing the data to compress + compress (str): Compression algorithm, e.g. 'gzip' + + Return: + bytes: Compressed data + """ + if compress == 'none': + return inf.read() + + comp = COMP_TOOLS.get(compress) + if not comp: + raise ValueError(f"Unknown compression algorithm '{compress}'") + + with tempfile.NamedTemporaryFile() as comp_fname: + with open(comp_fname.name, 'wb') as outf: + done = False + for tool in comp.tools.split(','): + try: + subprocess.call([tool, '-c'], stdin=inf, stdout=outf) + done = True + break + except FileNotFoundError: + pass + if not done: + raise ValueError(f'Missing tool(s): {comp.tools}\n') + with open(comp_fname.name, 'rb') as compf: + comp_data = compf.read() + return comp_data + + +def output_dtb(fsw, seq, fname, arch, compress): + """Write out a single devicetree to the FIT + + Args: + fsw (libfdt.FdtSw): Object to use for writing + seq (int): Sequence number (1 for first) + fmame (str): Filename containing the DTB + arch: FIT architecture, e.g. 'arm64' + compress (str): Compressed algorithm, e.g. 'gzip' + + Returns: + tuple: + str: Model name + bytes: Compatible stringlist + """ + with fsw.add_node(f'fdt-{seq}'): + # Get the compatible / model information + with open(fname, 'rb') as inf: + data = inf.read() + fdt = libfdt.FdtRo(data) + model = fdt.getprop(0, 'model').as_str() + compat = fdt.getprop(0, 'compatible') + + fsw.property_string('description', model) + fsw.property_string('type', 'flat_dt') + fsw.property_string('arch', arch) + fsw.property_string('compression', compress) + fsw.property('compatible', bytes(compat)) + + with open(fname, 'rb') as inf: + compressed = compress_data(inf, compress) + fsw.property('data', compressed) + return model, compat + + +def build_fit(args): + """Build the FIT from the provided files and arguments + + Args: + args (Namespace): Program arguments + + Returns: + tuple: + bytes: FIT data + int: Number of configurations generated + size: Total uncompressed size of data + """ + fsw = libfdt.FdtSw() + setup_fit(fsw, args.name) + seq = 0 + size = 0 + entries = [] + + # Handle the kernel + with open(args.kernel, 'rb') as inf: + comp_data = compress_data(inf, args.compress) + size += os.path.getsize(args.kernel) + write_kernel(fsw, comp_data, args) + + for path in args.srcdir: + # Handle devicetree files + if os.path.isdir(path): + for dirpath, _, fnames in os.walk(path): + for fname in fnames: + if os.path.splitext(fname)[1] != '.dtb': + continue + pathname = os.path.join(dirpath, fname) + seq += 1 + size += os.path.getsize(pathname) + model, compat = output_dtb(fsw, seq, pathname, + args.arch, args.compress) + entries.append([model, compat]) + + finish_fit(fsw, entries) + + # Include the kernel itself in the returned file count + return fsw.as_fdt().as_bytearray(), seq + 1, size + + +def run_make_fit(): + """Run the tool's main logic""" + args = parse_args() + + out_data, count, size = build_fit(args) + with open(args.fit, 'wb') as outf: + outf.write(out_data) + + ext_fit_size = None + if args.external: + mkimage = os.environ.get('MKIMAGE', 'mkimage') + subprocess.check_call([mkimage, '-E', '-F', args.fit], + stdout=subprocess.DEVNULL) + + with open(args.fit, 'rb') as inf: + data = inf.read() + ext_fit = libfdt.FdtRo(data) + ext_fit_size = ext_fit.totalsize() + + comp_size = len(out_data) + print(f'FIT size {comp_size:#x}/{comp_size / 1024 / 1024:.1f} MB', end='') + if ext_fit_size: + print(f', header {ext_fit_size:#x}/{ext_fit_size / 1024:.1f} KB', end='') + print(f', {count} files, uncompressed {size / 1024 / 1024:.1f} MB') + + +if __name__ == "__main__": + sys.exit(run_make_fit())