From patchwork Fri Feb 2 17:30:33 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Glass X-Patchwork-Id: 13543184 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 3FCBFC48291 for ; Fri, 2 Feb 2024 17:31:02 +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=hGFygaMjewxxeKE5/dIo5CIblMfKlQJNOnzcvacTpQA=; b=4OwWKUnaLs5Rar Phq1qYxcybfRZHNwvvCe0cc+KpAv/S8E4Qe+iEjX9Tu9+4QLBejawU9VnFQ/Mz6dapdJfJUzwguLI B0tXcN5i1CUXD7vdsCLf6MuRv2ut2EHPxuxi55JjY8/pEl9g+KAN3X7gQmX46JZ8F6om1VwV3urB5 Ytzt5ve50qFDC28a9bARfyq76Ggg5Gn9yJNZOZaNuw8skiBzkp57ZDCP2WhOtVIzX+a31RW5TBXJy cG7UTNGNYCdoaxPVd1KWlt2BDrJVByv5TH0IBrwmURzy7HF9VL3GBTQ9cdQCxbtE6ALDWqr+b/mpJ veQqO/en/vm4pNy8d2SQ==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1rVxNI-0000000Cb3w-32aF; Fri, 02 Feb 2024 17:30:48 +0000 Received: from mail-ej1-x630.google.com ([2a00:1450:4864:20::630]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1rVxNE-0000000Cb1O-1b6i for linux-arm-kernel@lists.infradead.org; Fri, 02 Feb 2024 17:30:46 +0000 Received: by mail-ej1-x630.google.com with SMTP id a640c23a62f3a-a3122b70439so324606566b.3 for ; Fri, 02 Feb 2024 09:30:42 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1706895041; x=1707499841; 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=Tzgmnc/dVe67zqThKg2HRZiMqYk93YXXRdjM9PXNfFY=; b=DHsQMzTvnn2S/2QP5Y9mIq9wE8Kfm9jWp8FGLI7Q9yMyxhE0KE7FcyOrDP3yRjS06h a5DT6IT4KanUCS1KAxSGl/8CnMVXvXZllnbwAIZZeyLOrhrVI6COeo9+xwY0PDCEzXlU 73dEx1rn9b6b654Vxgq9gKj/7UWtq7Myqu578= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1706895041; x=1707499841; 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=Tzgmnc/dVe67zqThKg2HRZiMqYk93YXXRdjM9PXNfFY=; b=EmAaj917x32LNnMgFN3OxP/eFkAA9Jia7mn+lg3jJ/B9kps1xdEP/sdrCRlzqXpf+/ spdAZfYAb86eTTdgLk5c2U7s073HOHzjq/W/ac0C35TJRqqLPEPOhpj/rV30lXhHxHvd M7shpQYTGOm1tjQgU3nGXB//JojancmBeQoExrpMg03AvzfEWzfVDhH/TmJbUJXqXdk5 mMdkzNbMX/UnAYx7pzY7wu0KtvMa2TnW8Epxxuq0+kuRVYJryuztcQ18hbgM0uPKPseC OdzJx4Cf3NQoXPZAtf3/fXvzZ4PThP1bPEQIxpH0T8IFrA/nvj2wmWS3MMufrX1sX8Ln SNBg== X-Gm-Message-State: AOJu0YyFhsmyrpJt8Ztcm9aPUC+0kN8vdidJ4FrvUWlpna5D7h8Lz3ar MSUOiDgWdoE1aLBkohKnyOW4Lw7WRLeG8HzZXuC5UCDaMSsA/aJJIZEJlYLxrDiBB8NjvMSJiEH mGeoa X-Google-Smtp-Source: AGHT+IHP/5ZRaiYDK4PC6NOpbhF4S/tt6Owof3FS9hi+3Z07dQE03DFVssqBWWiemWc6kEze73Kx1g== X-Received: by 2002:a17:906:3953:b0:a36:bc20:9a40 with SMTP id g19-20020a170906395300b00a36bc209a40mr4037025eje.48.1706895041195; Fri, 02 Feb 2024 09:30:41 -0800 (PST) X-Forwarded-Encrypted: i=0; AJvYcCVB+aeDQCmsjLIJCF1+hLEAB2MNuxDgtEcELXJAQrzVS+FKMfLPsHVNuRO0/x/w2ifw58p98oInEOeEGBFF/BoteWFKMfzmLbWwwF+yXGN5t8EZcLqc2POFH42h1uQwwSuLnVaQdpOEivnGT6yndjNtKffsMy/xOY63No5NoFBQA5+/AIROegXmnUIb/JrIbajw2npi4/Iw43KUERPlznK5KkPo5ADrHLBagAy8HrwKygw= Received: from chromium.org (66.224-78-194.adsl-static.isp.belgacom.be. [194.78.224.66]) by smtp.gmail.com with ESMTPSA id hd34-20020a17090796a200b00a36f314daa6sm1083392ejc.46.2024.02.02.09.30.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 02 Feb 2024 09:30:40 -0800 (PST) From: Simon Glass To: linux-arm-kernel@lists.infradead.org Cc: Ahmad Fatoum , Masahiro Yamada , Nicolas Schier , Simon Glass , Catalin Marinas , Will Deacon , linux-kernel@vger.kernel.org Subject: [PATCH v10 1/2] arm64: Add BOOT_TARGETS variable Date: Fri, 2 Feb 2024 10:30:33 -0700 Message-Id: <20240202173034.221790-2-sjg@chromium.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240202173034.221790-1-sjg@chromium.org> References: <20240202173034.221790-1-sjg@chromium.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240202_093044_468294_C8E4E7E1 X-CRM114-Status: GOOD ( 11.11 ) 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 47ecc4cff9d2..83cd2b7234b9 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 Fri Feb 2 17:30:34 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Glass X-Patchwork-Id: 13543186 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 1B60BC48291 for ; Fri, 2 Feb 2024 17:31:09 +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=pScSF9NB8mpMw2YFQutkockjPwfA2sl6aR5F87wJMYE=; b=IMjfivwJLn9deH Q8vi8QbwFC2hvT3aYxuRtQJj5uQ8pLwFvzvFkILNS7EEfhKv8xLuQmQDGbt+/hNBquDffQTFx0y5u uiMNuyjENSKo0wU3sQFH0CksePRg4/ECTWbXjoDoDHGZIuHw8ZnIDwujLMorsRt+9L3aRtWbMMmQA iIxZL6ef5hFYQGjqme/UpRNAyTVifeL09JWoeYCH+mYcf5wl2WUkhjDaayTmweRby9F609bAQ+kgb 5Ly7IsluPMB43Hauo4IeVfg/CirwZ5ETg66MJkrBtZc8OI6djVEv4c3ZP0aWshTdEaTV1/+ita/y2 3jDHLa/ex8RoYXL58yNg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1rVxNL-0000000Cb5u-2e0L; Fri, 02 Feb 2024 17:30:51 +0000 Received: from mail-ej1-x636.google.com ([2a00:1450:4864:20::636]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1rVxNI-0000000Cb2T-1vLy for linux-arm-kernel@lists.infradead.org; Fri, 02 Feb 2024 17:30:50 +0000 Received: by mail-ej1-x636.google.com with SMTP id a640c23a62f3a-a350bfcc621so288811566b.0 for ; Fri, 02 Feb 2024 09:30:45 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1706895044; x=1707499844; 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=mUjd9mNFW9Xo6zVRo6Wb/Ij0ln3xwo6VigqykVmxzxo=; b=CKLLTLLZDfhXKgN3zbcjnl5xmfdmR5mTCvm6A/VfptGYW3umNJealiiVBuPL2IjtzN zlPuUfQ6vv3kbtgdtbHxr+aftrfie1lP0DQvxhTdlirbAGQ9cl3kyVV+p1htRT4RBe0p yH9xFlVBB6Zz5l1HPtM3bjo3Z3U7tzAD4WsgE= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1706895044; x=1707499844; 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=mUjd9mNFW9Xo6zVRo6Wb/Ij0ln3xwo6VigqykVmxzxo=; b=li5V80q7J+IbCXUwq3CU6zFisVz1XumXSuw7EiGpUA9+GU/j7Dv0rRKTt0B2msvpE8 TfUINvsunqPioPU08H2VQJjbOOClBIoQsT8I3wQMObLH3fdfiq4RFEcNoAlx0D43t98g 7EKv1UAv9426+33y9+5/4LVtLFOfy5AR62A9yB2b+DoG6zrhkvdRPWMVP64Q3KxVMpGF rdGLv1i/WQirMmeCJLyzM947Dv1iEQ6DP4tCLiqcwoGioLm29eZsJsjrnGhFK3a625ru gcr9QnHPBTjvWlP15dJglwTT9FJBw89CT7FHGhTy86IcjVBYzBTXChAXXCgmylC3MH7x y7CA== X-Gm-Message-State: AOJu0YxmcPsuETCWpYG0D6fRsXavdvsl2IFRxwvbhQFx5W/jf1DJChVZ a8spGzJ6L8lEvspPxM5k+mJov5Uc3NWJz7lb5J2gUTwj0MVjCucQsvCOCs0QDI2Q9vyDUuQrkXh ZGnMS X-Google-Smtp-Source: AGHT+IEu4yiHnceMrb9CvB8px4GsG1m5WOHmxkjgGxCkUHPhhmkw6Cl96PnLbUAXd0Dl6BEW/xlNRA== X-Received: by 2002:a17:907:788e:b0:a37:3abb:99c2 with SMTP id ku14-20020a170907788e00b00a373abb99c2mr67433ejc.74.1706895044091; Fri, 02 Feb 2024 09:30:44 -0800 (PST) X-Forwarded-Encrypted: i=0; AJvYcCX1WmyEW96BkinfCnY3RLD+m6tFijx2cAvuMjzuz4wFs74vxRHDww0NLru4eBkxCIDndDkeE8LjB4EeTt4ZHO8GqN4Q2qoSno+8eT6NhLm227tj3oNU6ly9Vbm02EiVFLXB+wJZppg91gkRWkBGgZ1AGIBbju5R+ZBw6KeQaBsMQgy62Mk3aGhvaKhTpmwnyf9Z9q05Ytr+ZiB+0IcholmXt4GcI0y3hHXgyTYpVVMVkFBbaeDYJN061sgJv+AeSmDq5k+4fbPPb63ifQ/ULzLoBijUH5y6Z/9KRdghymNTa8T8hZutkpyylje51RQQ0ntRQDc7hPKnsmgRJt/6k6VTbhrDIWI24np5r2iTpXX8NAC/+xybdFlEhvN2eyYyOK2mAxjXmjc+ILN+Dh+rOx+h7pMlEL9Dc+aG Received: from chromium.org (66.224-78-194.adsl-static.isp.belgacom.be. [194.78.224.66]) by smtp.gmail.com with ESMTPSA id hd34-20020a17090796a200b00a36f314daa6sm1083392ejc.46.2024.02.02.09.30.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 02 Feb 2024 09:30:43 -0800 (PST) From: Simon Glass To: linux-arm-kernel@lists.infradead.org Cc: Ahmad Fatoum , Masahiro Yamada , Nicolas Schier , Simon Glass , Catalin Marinas , Jonathan Corbet , Nathan Chancellor , Nick Terrell , Will Deacon , linux-doc@vger.kernel.org, linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org, workflows@vger.kernel.org Subject: [PATCH v10 2/2] arm64: boot: Support Flat Image Tree Date: Fri, 2 Feb 2024 10:30:34 -0700 Message-Id: <20240202173034.221790-3-sjg@chromium.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240202173034.221790-1-sjg@chromium.org> References: <20240202173034.221790-1-sjg@chromium.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240202_093048_567459_2A3DA6E4 X-CRM114-Status: GOOD ( 35.15 ) 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 uses the 'dtbs-list' file but processes only .dtb files, ignoring the overlay .dtbo files. 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. Use FIT_COMPRESSION to select an algorithm other than gzip. 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 v10: - Make use of dtbs-list file - Mention dtbs-list and FIT_COMPRESSION - Update copyright year - Update cover letter to take account of an applied patch Changes in v9: - Move the compression control into Makefile.lib 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 83cd2b7234b9..5de2b02f549a 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 a5a787371117..ab21af82913e 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,9 @@ $(obj)/Image.lzo: $(obj)/Image FORCE $(obj)/Image.zst: $(obj)/Image FORCE $(call if_changed,zstd) +$(obj)/image.fit: $(obj)/Image FORCE + $(call cmd,fit) + 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 b35d39022a30..4efb5ad07fd7 100644 --- a/scripts/Makefile.lib +++ b/scripts/Makefile.lib @@ -502,6 +502,22 @@ 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 + +# Use this to override the compression algorithm +FIT_COMPRESSION ?= gzip + +quiet_cmd_fit = FIT $@ + cmd_fit = $(MAKE_FIT) -f $@ --arch $(UIMAGE_ARCH) --os linux \ + --name '$(UIMAGE_NAME)' \ + --compress $(FIT_COMPRESSION) -k $< \ + @arch/$(SRCARCH)/boot/dts/dtbs-list + # XZ # --------------------------------------------------------------------------- # Use xzkern to compress the kernel image and xzmisc to compress other things. diff --git a/scripts/make_fit.py b/scripts/make_fit.py new file mode 100755 index 000000000000..69eee32960ae --- /dev/null +++ b/scripts/make_fit.py @@ -0,0 +1,298 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0+ +# +# Copyright 2024 Google LLC +# Written by Simon Glass +# + +"""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 + @arch/arm64/boot/dts/dtbs-list -E -c gzip + +Creates a FIT containing the supplied kernel and a set of devicetree files, +either specified individually or listed in a file (with an '@' prefix). Files +which don't end in '.dtb' are silently ignored. + +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 + """ + def add_file(fname): + nonlocal seq, size + + if os.path.splitext(fname)[1] == '.dtb': + seq += 1 + size += os.path.getsize(fname) + model, compat = output_dtb(fsw, seq, fname, args.arch, + args.compress) + entries.append([model, compat]) + return True + + seq = 0 + size = 0 + fsw = libfdt.FdtSw() + setup_fit(fsw, args.name) + 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 a list of devicetree files + if path.startswith('@'): + with open(path[1:], 'r', encoding='utf-8') as inf: + for fname in inf.read().splitlines(): + add_file(fname) + else: + add_file(path) + + 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())