From patchwork Tue Nov 7 13:25:53 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Glass X-Patchwork-Id: 162460 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:aa0b:0:b0:403:3b70:6f57 with SMTP id k11csp231800vqo; Tue, 7 Nov 2023 05:27:21 -0800 (PST) X-Google-Smtp-Source: AGHT+IF0B8RoFEvMDMR/Uv03KM+Xm8FS+XHEpfqp2B9AZDYfu+xyooHxjeyyPiDS8n+dsVQogoXW X-Received: by 2002:a05:6a21:4881:b0:181:15:5755 with SMTP id av1-20020a056a21488100b0018100155755mr24139049pzc.56.1699363641110; Tue, 07 Nov 2023 05:27:21 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1699363641; cv=none; d=google.com; s=arc-20160816; b=R/i63fVWYT1P+VhKQzcEuysNTSa0ZClwb016KY2LhmLFS3fbHA5WrVpq72WN6IqrGO wApzDXWnHuA/Ttnwfo3Ycu4iV+4q8XMhh+4ZpuVbTTSmGySItH7vi7hPqwJL2l3zo2oN F+9XRk5hANEW9BfRE6oDPPbTM7n/gFTrpLeCibbmfpQxWE4uOdssPahtIQr0bMn5e+rZ KFVhQQkkrQrq+w5OoTZ1dyTU0NGBKAwaxlJb5m58QbnaaOEJpQVF1gYZ32oOinRBaul6 NCZbZpPZv9DVXDFYpFaVThtaUtcxmbkgQ0YD893qmzpLr+RTxkQ6utNHIEua6NI2+Zi9 iSbw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=mUczbla/3nICzQP9ZmDHPTBpFCCiTIH02+1QSP6Uf6s=; fh=+2WA7Grc9VRiVAdce+KBOM2OHH/h6JCb5mkdcbEwcg4=; b=xGlhiiCLbmK10vQe54pjlFwxQg2g1HuUntJiZxK18E5U+cIrAnPUNQ8t03r7mgM4Lq Iomo7oae46//KBOOFLW91wY3hnwIgJT7PwvlW3LRDVqk9jgxWr2U0xXQz7QvmV4JeRaF szaHjVajivWs9aOS9iqBB5nrJexUFF1pU+jmCZ5qxKD3CbxSYYe1rq97uC4KH89qlhR2 4MqPUEPi8FDBxY9GnA2VvTSLjN0VTG6a0hOU1SpY1WHrMlxgAqFNy0m81uN/HFjKhdGa HRmSjU1xMstw+IG2Okmy1bbNObEzjbp9BeE2DRCSYSCvZ0KmiX05ZCuywsMX+vCKH8mJ idFQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=kHusprIM; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.32 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: from agentk.vger.email (agentk.vger.email. [23.128.96.32]) by mx.google.com with ESMTPS id x14-20020a170902ec8e00b001cc407388a8si12029341plg.337.2023.11.07.05.27.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Nov 2023 05:27:21 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.32 as permitted sender) client-ip=23.128.96.32; Authentication-Results: mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=kHusprIM; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.32 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by agentk.vger.email (Postfix) with ESMTP id E9D6F80264BE; Tue, 7 Nov 2023 05:27:18 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at agentk.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234527AbjKGN0j (ORCPT + 32 others); Tue, 7 Nov 2023 08:26:39 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44948 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234167AbjKGN0f (ORCPT ); Tue, 7 Nov 2023 08:26:35 -0500 Received: from mail-io1-xd2d.google.com (mail-io1-xd2d.google.com [IPv6:2607:f8b0:4864:20::d2d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 246529E for ; Tue, 7 Nov 2023 05:26:32 -0800 (PST) Received: by mail-io1-xd2d.google.com with SMTP id ca18e2360f4ac-7a94a3b0a49so204474239f.2 for ; Tue, 07 Nov 2023 05:26:32 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1699363591; x=1699968391; darn=vger.kernel.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=mUczbla/3nICzQP9ZmDHPTBpFCCiTIH02+1QSP6Uf6s=; b=kHusprIMaj5aHX467GCbunc3iTkxfEPkGHGYqIcJgrDBba86R4LYxPwqiLmhfME2uo BGFK53qsVTLyeV/oCUwbCp7uSINAhFybNPtG0AIR/wSPd1KOneogMi6jzYfFXyB6HHBP I1m6MkhtsQCOp2VxgRx4MO5GEZfSf/lMUuC2g= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699363591; x=1699968391; 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=mUczbla/3nICzQP9ZmDHPTBpFCCiTIH02+1QSP6Uf6s=; b=WASg/rzq3wJ+MhKut7KXGGnvqnR4Pl/StzQ92Ms6rbJspVqNLpx7aPv0YJcuYk2vf2 7/G6UYGLzJp8r4Hdrn73RkQROQ1NrAHuAY89wGQCt6vpJzTtgqC9+POU0DZ99OizFLtB VjgicTJCMCwGmZdHBR84VIQRfUwaBClEolij4xyR+2iSU8WYsWZu1WiCqFe8d2xYBqfa +GKcAHLZcbbzd6FBghWyPoe8Rh8dni//LJwbn1kSdFL3MAgEZxFExJ9yerpzu180AArJ jHzI5rT/r1zIIjdQiNf5SYrYAMtnUrvWnP5/KiqM94AdR8B9R1QBK8L7n7GPqpzqTjwg TO4w== X-Gm-Message-State: AOJu0Yz7px3NWDZ+s0Y7Qmm03rzzXL+mpreElOC5pCPnBf8fcsQM4KRy YEzyvJfXZCfFbShWM5EB3rn99Q== X-Received: by 2002:a05:6e02:1847:b0:359:4199:1fe4 with SMTP id b7-20020a056e02184700b0035941991fe4mr3384295ilv.10.1699363591508; Tue, 07 Nov 2023 05:26:31 -0800 (PST) Received: from sjg1.lan (c-73-14-173-85.hsd1.co.comcast.net. [73.14.173.85]) by smtp.gmail.com with ESMTPSA id db8-20020a056e023d0800b003596056a051sm3141589ilb.71.2023.11.07.05.26.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Nov 2023 05:26:31 -0800 (PST) From: Simon Glass To: linux-arm-kernel@lists.infradead.org Cc: U-Boot Mailing List , Tom Rini , Masahiro Yamada , Simon Glass , Catalin Marinas , Will Deacon , linux-kernel@vger.kernel.org Subject: [PATCH v3 1/2] kbuild: arm64: Add BOOT_TARGETS variable Date: Tue, 7 Nov 2023 06:25:53 -0700 Message-ID: <20231107132619.34062-2-sjg@chromium.org> X-Mailer: git-send-email 2.42.0.869.gea05f2083d-goog In-Reply-To: <20231107132619.34062-1-sjg@chromium.org> References: <20231107132619.34062-1-sjg@chromium.org> MIME-Version: 1.0 X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on agentk.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (agentk.vger.email [0.0.0.0]); Tue, 07 Nov 2023 05:27:19 -0800 (PST) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1781911929288716620 X-GMAIL-MSGID: 1781911929288716620 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 v1) arch/arm64/Makefile | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/arch/arm64/Makefile b/arch/arm64/Makefile index 4bd85cc0d32b..7b77b63e978f 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.gz vmlinuz.efi + +PHONY += $(BOOT_TARGETS) + ifeq ($(CONFIG_EFI_ZBOOT),) KBUILD_IMAGE := $(boot)/Image.gz else @@ -159,7 +163,7 @@ endif all: $(notdir $(KBUILD_IMAGE)) -Image vmlinuz.efi: vmlinux +$(BOOT_TARGETS): vmlinux $(Q)$(MAKE) $(build)=$(boot) $(boot)/$@ Image.%: Image From patchwork Tue Nov 7 13:25: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: 162461 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:aa0b:0:b0:403:3b70:6f57 with SMTP id k11csp231880vqo; Tue, 7 Nov 2023 05:27:29 -0800 (PST) X-Google-Smtp-Source: AGHT+IGWOryPrSP7gPWwFQ4nSIKMO28jscAc5tm9E5nkI2mRSpjkrpmUAWI9YC7p+gy3gJiHSc4u X-Received: by 2002:a17:90b:4c8f:b0:280:2609:6d51 with SMTP id my15-20020a17090b4c8f00b0028026096d51mr21926196pjb.18.1699363649483; Tue, 07 Nov 2023 05:27:29 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1699363649; cv=none; d=google.com; s=arc-20160816; b=UhGWIiB0vn+qTpME1XkyS0Wr2sw0X4yuTHNAbW2N5kDERCiyglbaYOVyQ/hKgvGSfl SkpRBSyfE6Cbk9LKNDdGzZvYpKfH1b5aMmFF3xxsSjLjFjzKAPWyytkGz4DOiT0XZLZi L199Of2x3Nl7Rc9EPdhAf6GKIKtVZ+ZK+YnfJdVZ5fa+aVNrov2ASHnMf3kY927GjMn2 6Dmln5pTDIT6e6DqJVfa2kpkbz375wh/VwGzkVjdBQtCnQZV1HEJu6aFFCZQdGsWIPfW qUdP+ru53ovHNkaiA9iw4wTR/5LO2jK2b1st9Rh9vp7+q3IN2ik1OZJjLd3u0B4oYEdO 3k8g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=97c322HV1j2Vuxao1nksdvHEyNLgztBkN03VclNTEjE=; fh=gMYtiOnikXPU57D4E0yjzqpcGVTKtIdXI7et5S29+d4=; b=B0PsAJFb00R0uA7mT9jnm02oYq+Ep1YLVZXHgsyAhEJsXxZl2Wqe9khSFMRJUh/Xl/ Ot/4O7hMvLDk1TPqz+wZRWzqVz4leP/3DASZe/YpOC3l8j0ytpwN2bwK1sx36z2aMadL QRhCvZ30t37X65ciyC4RRVU0Pb514Bz0lgSeNp7l/m5V+IiWQy6pLOwvEKVf6fvKYRg6 CC35dToU9ROklMF1uiiOt9xMXO9iNloaQnwrONjMllaTQ3b6AtqDY8Zku639H0LOAndB uphgFGVjPEwu18tcCH0olJHU7cE9E694OA/wuF7hqALfCT7lTUSh6AXp4v914NyFycer jGdA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=FoXs0uXa; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: from fry.vger.email (fry.vger.email. [23.128.96.38]) by mx.google.com with ESMTPS id ms11-20020a17090b234b00b00280cc57b23fsi10107239pjb.94.2023.11.07.05.27.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Nov 2023 05:27:29 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) client-ip=23.128.96.38; Authentication-Results: mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=FoXs0uXa; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by fry.vger.email (Postfix) with ESMTP id 11386801B836; Tue, 7 Nov 2023 05:27:26 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at fry.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234582AbjKGN0m (ORCPT + 32 others); Tue, 7 Nov 2023 08:26:42 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44966 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234490AbjKGN0h (ORCPT ); Tue, 7 Nov 2023 08:26:37 -0500 Received: from mail-il1-x12d.google.com (mail-il1-x12d.google.com [IPv6:2607:f8b0:4864:20::12d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3D4A893 for ; Tue, 7 Nov 2023 05:26:33 -0800 (PST) Received: by mail-il1-x12d.google.com with SMTP id e9e14a558f8ab-35961c61ffaso14932555ab.3 for ; Tue, 07 Nov 2023 05:26:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1699363592; x=1699968392; darn=vger.kernel.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=97c322HV1j2Vuxao1nksdvHEyNLgztBkN03VclNTEjE=; b=FoXs0uXaGiHs51/6BPv+TAhAxfnY2zrYyVpcrOHJ0ZMTqjm27jpKU9deIukfDPjIT1 rJW3gCFomHv0eUx/UZX7HZXHeurHW+9CXDR4TYFbMdhESwL3BggA2RjuNIskLC8NUF+8 B38oL7okWIkHq4YVEeDjCgOzKck5c2r6cF4FI= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699363592; x=1699968392; 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=97c322HV1j2Vuxao1nksdvHEyNLgztBkN03VclNTEjE=; b=Z6+yGVXsbdfrHbhWRTPFTZ/PFfSbSxwKcva0Jy1z6BfAbZlbICXUCTYAS8Iu0ZPZSV W77TFJUYlW5caXfz+Nnid89UgGLDTtzAEQIB0jko76z++c8+Qs4KUVjVr/ZbP2z7ANCP k3ghBhl8on5musOcrdL70ao7uqJGGYkd/FrLUwnM+73PH0yiKR6UhDzGXvpemneziPu8 o4qXjek7DDg2NsRL3j+t/0lmpgLwefv7OceLiZoC0+jiE2mdKrZBiFmtVcQhpTk/fnqR hbwyh/24QFeS4J9HnE0wrlcQszOG0RApe+n6OKdd7Td6pXZqjbdBMafxj8baTmVy0qN1 a2rg== X-Gm-Message-State: AOJu0Yyi8fzlAzYquNnZiij03O69ygazWadRco/Lzo7B8JTN6f3Xv0A0 AHIzFOAJUvnPBNC0n10KKONZnA== X-Received: by 2002:a05:6e02:2169:b0:359:3dc6:4f4b with SMTP id s9-20020a056e02216900b003593dc64f4bmr2949983ilv.5.1699363592556; Tue, 07 Nov 2023 05:26:32 -0800 (PST) Received: from sjg1.lan (c-73-14-173-85.hsd1.co.comcast.net. [73.14.173.85]) by smtp.gmail.com with ESMTPSA id db8-20020a056e023d0800b003596056a051sm3141589ilb.71.2023.11.07.05.26.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Nov 2023 05:26:32 -0800 (PST) From: Simon Glass To: linux-arm-kernel@lists.infradead.org Cc: U-Boot Mailing List , Tom Rini , Masahiro Yamada , Simon Glass , Catalin Marinas , Nathan Chancellor , Nick Desaulniers , Nick Terrell , Nicolas Schier , Will Deacon , linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 2/2] arm64: boot: Support Flat Image Tree Date: Tue, 7 Nov 2023 06:25:54 -0700 Message-ID: <20231107132619.34062-3-sjg@chromium.org> X-Mailer: git-send-email 2.42.0.869.gea05f2083d-goog In-Reply-To: <20231107132619.34062-1-sjg@chromium.org> References: <20231107132619.34062-1-sjg@chromium.org> MIME-Version: 1.0 X-Spam-Status: No, score=0.8 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,T_PDS_OTHER_BAD_TLD, T_SCC_BODY_TEXT_LINE,URIBL_BLACK autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on fry.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (fry.vger.email [0.0.0.0]); Tue, 07 Nov 2023 05:27:26 -0800 (PST) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1781911937929896236 X-GMAIL-MSGID: 1781911937929896236 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 v3: - Drop temporary file image.itk - Drop patch 'Use double quotes for image name' - Drop double quotes in use of UIMAGE_NAME - Drop unnecessary CONFIG_EFI_ZBOOT condition for help - Avoid hard-coding "arm64" for the DT architecture Changes in v2: - Drop patch previously applied - Add .gitignore file - Move fit rule to Makefile.lib using an intermediate file - Drop dependency on CONFIG_EFI_ZBOOT - Pick up .dtb files separately from the kernel - Correct pylint too-many-args warning for write_kernel() - Include the kernel image in the file count - Add a pointer to the FIT spec and mention of its wide industry usage - Mention the kernel version in the FIT description MAINTAINERS | 7 + arch/arm64/Makefile | 3 +- arch/arm64/boot/.gitignore | 1 + arch/arm64/boot/Makefile | 6 +- scripts/Makefile.lib | 16 ++ scripts/make_fit.py | 289 +++++++++++++++++++++++++++++++++++++ 6 files changed, 320 insertions(+), 2 deletions(-) create mode 100755 scripts/make_fit.py diff --git a/MAINTAINERS b/MAINTAINERS index 466298fe9f65..d260ccb847e5 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1577,6 +1577,13 @@ F: Documentation/process/maintainer-soc*.rst F: arch/arm/boot/dts/Makefile F: arch/arm64/boot/dts/Makefile +ARM64 FIT SUPPORT +M: Simon Glass +L: linux-arm-kernel@lists.infradead.org (moderated for non-subscribers) +S: Maintained +F: arch/arm64/boot/Makefile +F: scripts/make_fit.py + ARM ARCHITECTED TIMER DRIVER M: Mark Rutland M: Marc Zyngier diff --git a/arch/arm64/Makefile b/arch/arm64/Makefile index 7b77b63e978f..9ebd7612b181 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.gz vmlinuz.efi +BOOT_TARGETS := Image.gz vmlinuz.efi image.fit PHONY += $(BOOT_TARGETS) @@ -215,6 +215,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..b835c0880d1c 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 68d0134bdbf9..28acc5e7befa 100644 --- a/scripts/Makefile.lib +++ b/scripts/Makefile.lib @@ -496,6 +496,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 + +quiet_cmd_fit = FIT $@ + cmd_fit = $(MAKE_FIT) -f $@ --arch $(UIMAGE_ARCH) --os linux \ + --name $(UIMAGE_NAME) \ + --compress $(UIMAGE_COMPRESSION) -k $< \ + $(dir $<)/dts + +$(obj)/%.fit: $(obj)/%.itk $(MAKE_FIT) FORCE + $(call if_changed,fit,gzip) + # 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..e1059825de9c --- /dev/null +++ b/scripts/make_fit.py @@ -0,0 +1,289 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0+ +# +# Copyright 2023 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 + /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 + +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())