From patchwork Wed May 31 03:35:13 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahisa Kojima X-Patchwork-Id: 687219 Delivered-To: patch@linaro.org Received: by 2002:a5d:4d8a:0:0:0:0:0 with SMTP id b10csp1054456wru; Tue, 30 May 2023 20:35:56 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ5xZmdQ+09sCZyyEOpDXNMJxbXHFe99UH0kBqtk77TKA/RMcZT07XrioUU1srf/Qv9K80gN X-Received: by 2002:a17:90b:e86:b0:256:3191:640f with SMTP id fv6-20020a17090b0e8600b002563191640fmr13492707pjb.4.1685504156569; Tue, 30 May 2023 20:35:56 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1685504156; cv=none; d=google.com; s=arc-20160816; b=07ZMzmiTidNs9S41xl7HLbBb/80UXSQzYHZugoZuGcwEGpAgzQ4XeI/Btf+fZWa6No vux+T/TuGS7r3d9EQwxOCwW9ptN9XvNlzFaB4kd6kZKXHi5k8k3uAVMKFVOGY3jEyBgI iyalF689rWnQsDm0biD5yOb1QNNQoAh3vk4gh3Z1adqSMYujnj49E6zxSQIr3Y85sQSu PuPNVHSifMwQAKnrkhrQkClbxFDrH8rtL7fLX7qZ5/Q5s+xsJ1gBHgkg+RSbuuWI0FK+ FmeXt06Prxgv8pQfVSbT3r0i13PINWnariOzyTQdhjG2HrRM/cdkc8BvE/UJDAxE/MHV 0XZA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:message-id:date:subject:cc:to:from:dkim-signature; bh=h1tY3QZdiQEfTRBLY43ffACcA+4vxKXGi7ABdW6Vozo=; b=rX0VRwA/58jjhQyzqueH1b0wZGtygYeDqWgsSLJkuBDkWIllCv2pJ1+g32tLVhX7PT yMD/WD26FlsMksEzNpmxwPxYpR2Rp/HnXU1gjWpkPSSxvibj4aqYJ145SeCapj40+BZu TKsehTpNOCg06Zx+lCgjIMbdc//Vto7vPZporZMTkpDaNcsNSOKv7mI3FmvLZ2LYkA+Y CoieU6O0T0wg8Ymw/U29qmz0Ee9WEEO2/ncRtDj2gFP4uXapROjUljrhzt4zR+AvpUC5 9nJwG9NCoSSsJ7ekXcfoqurw2gz7T5ft7eX5tvZD+RMTyJeSYWG26j+TAxFILzHacltz QlJg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=vZ+9d2uU; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from phobos.denx.de (phobos.denx.de. [2a01:238:438b:c500:173d:9f52:ddab:ee01]) by mx.google.com with ESMTPS id v23-20020a63b957000000b0053fbb2ddb4csi264563pgo.36.2023.05.30.20.35.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 30 May 2023 20:35:56 -0700 (PDT) Received-SPF: pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 as permitted sender) client-ip=2a01:238:438b:c500:173d:9f52:ddab:ee01; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=vZ+9d2uU; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id CD3D586100; Wed, 31 May 2023 05:35:49 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="vZ+9d2uU"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 432B486101; Wed, 31 May 2023 05:35:48 +0200 (CEST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.2 Received: from mail-pg1-x52b.google.com (mail-pg1-x52b.google.com [IPv6:2607:f8b0:4864:20::52b]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 1D3B986093 for ; Wed, 31 May 2023 05:35:45 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=masahisa.kojima@linaro.org Received: by mail-pg1-x52b.google.com with SMTP id 41be03b00d2f7-52cb8e5e9f5so373106a12.0 for ; Tue, 30 May 2023 20:35:45 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1685504143; x=1688096143; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=h1tY3QZdiQEfTRBLY43ffACcA+4vxKXGi7ABdW6Vozo=; b=vZ+9d2uUs1EaEHZfVQMq1yYczmq/BaWcSylaUovtEfQjLEwOtXw1qv1M1BEGoSZ4nt s67cafuYZp8zTYQxQ1JnCW5wwgfNSKfcMYy2//t9Ii7Lo/NSXZX0WITVIX83tjavILfz wTCjfj770brg+LAZ2mk80lqB4rJCrzp7Lf219XnNaomCSA2F4ZKZloTtrBhhWSetM4IP Oh+t5i4ixx7uFbrZbQm+S14iXMQH4fOxcJov7m6690ujsdICxguBuDlTjKQ9R1Hw9Cs/ hJPi4R8n6rcGBBI2zcIkM5RpzwgN2XczaJFjw6riBIdqj7+9Zx2gvFCc0ss68ycPjiS2 fuxg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1685504143; x=1688096143; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=h1tY3QZdiQEfTRBLY43ffACcA+4vxKXGi7ABdW6Vozo=; b=J2kf9OHaWhtgrBplToekpfbMkaDRstwBa9huwzg8tDlL9OniZpLAhPL0E8APMFG/a9 IP71JJDw0HXu0V/j1y7Q/NaDeTu3VM4gj+7KfASRUb/MSyUQpwJ9eXQqMWCbTII0Lu8w XYINbS04KfcziW1RoHBQLvlIxh1tE9Fs7R57hGM+ZaAF80d8L+eqlxMxXNz3ETKUQk1+ nUxPJAfXGai3rgwCqxddIAlm7mSoKh0+ZQAfcuWOWgMSRh6j9JdZUy018YsEjUt//vBX d8d9dGcSkDu7dNsFrO4kpjDaX17jawrWHSlIXOZEJvy0T3fOzBW+7b7wMAr1jOnRP7Xf ou3Q== X-Gm-Message-State: AC+VfDwesqGmHxPsU7K09D75BJEKJHlouBf2FcBcveo1b6na4bgPKPNh +IxhCe1zoChuHyD7U5K6iKFAw5gPmNJe4hUM6nc= X-Received: by 2002:a17:902:d2c5:b0:1a6:9762:6eed with SMTP id n5-20020a170902d2c500b001a697626eedmr4540157plc.22.1685504143119; Tue, 30 May 2023 20:35:43 -0700 (PDT) Received: from ubuntu-SVE15129CJS.. ([240d:1a:cf7:5800:b037:3ab0:51c1:7dff]) by smtp.gmail.com with ESMTPSA id b4-20020a170902d30400b001b0395c3ffasm85709plc.180.2023.05.30.20.35.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 30 May 2023 20:35:42 -0700 (PDT) From: Masahisa Kojima To: u-boot@lists.denx.de Cc: Heinrich Schuchardt , Ilias Apalodimas , Simon Glass , Takahiro Akashi , Masahisa Kojima Subject: [PATCH v7 00/10] FMP versioning support Date: Wed, 31 May 2023 12:35:13 +0900 Message-Id: <20230531033523.1581973-1-masahisa.kojima@linaro.org> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.8 at phobos.denx.de X-Virus-Status: Clean Firmware version management is not implemented in the current FMP implementation. This series aims to add the versioning support in FMP. Currently, there is no way to know the current running firmware version through the EFI interface. FMP->GetImageInfo() returns always 0 for the version number. So a user can not know that expected firmware is running after the capsule update. EDK II reference implementation utilizes the FMP Payload Header inserted right before the capsule payload. U-Boot also follows the EDK II implementation. With this series applied, version number can be specified in the capsule file generation with mkeficapsule tool, then user can know the running firmware version through FMP->GetImageInfo() and ESRT. There is a design consideration for lowest supported version. If the backing storage is a file we can't trust any of that information since anyone can tamper with the file, although the variables are defined as RO. With that, we store the lowest supported version in the device tree. We can trust the information from dtb as long as the former stage boot loader verifies the image containing the dtb. The firmware version can not be stored in device tree because not all the capsule files do not have a device tree. Note that this series does not mandate the FMP Payload Header, compatible with boards that are already using the existing U-Boot FMP implementation. If no FMP Payload Header is found in the capsule file, fw_version, lowest supported version, last attempt version and last attempt status is set to 0 and this is the same behavior as existing FMP implementation. Major Changes in v7: - refactor the efi_capsule python test - add test cases for the FMP versioning Major Changes in v6: - change the location of fw_version and lowest supported version - fw_version is stored in FMP Payload Header in the capsule file - lowest_supported_version is stored in the device tree Major Changes in v5: - major design changes, versioning is implemented with device tree instead of EFI variable Major Changes in v4: - add python-based test Major Changes in v3: - exclude CONFIG_FWU_MULT Masahisa Kojima (10): efi_loader: add the number of image entries in efi_capsule_update_info efi_loader: store firmware version into FmpState variable efi_loader: versioning support in GetImageInfo efi_loader: get lowest supported version from device tree efi_loader: check lowest supported version mkeficapsule: add FMP Payload Header doc: uefi: add firmware versioning documentation doc: uefi: add anti-rollback documentation test: efi_capsule: refactor efi_capsule test test/py: efi_capsule: test for FMP versioning arch/arm/mach-rockchip/board.c | 4 +- .../imx8mp_rsb3720a1/imx8mp_rsb3720a1.c | 2 +- .../imx8mm-cl-iot-gate/imx8mm-cl-iot-gate.c | 2 +- board/emulation/qemu-arm/qemu-arm.c | 2 +- board/kontron/pitx_imx8m/pitx_imx8m.c | 2 +- board/kontron/sl-mx8mm/sl-mx8mm.c | 2 +- board/kontron/sl28/sl28.c | 2 +- board/rockchip/evb_rk3399/evb-rk3399.c | 2 +- board/sandbox/sandbox.c | 2 +- board/socionext/developerbox/developerbox.c | 2 +- board/st/stm32mp1/stm32mp1.c | 2 +- board/xilinx/common/board.c | 2 +- doc/develop/uefi/uefi.rst | 66 ++++ .../firmware/firmware-version.txt | 22 ++ doc/mkeficapsule.1 | 10 + include/efi_loader.h | 3 +- lib/efi_loader/efi_firmware.c | 276 ++++++++++++++-- lib/fwu_updates/fwu.c | 2 +- .../tests/test_efi_capsule/capsule_common.py | 86 +++++ test/py/tests/test_efi_capsule/conftest.py | 82 +++++ .../test_capsule_firmware_fit.py | 213 ++++++------- .../test_capsule_firmware_raw.py | 301 +++++++----------- .../test_capsule_firmware_signed_fit.py | 267 ++++++---------- .../test_capsule_firmware_signed_raw.py | 274 ++++++---------- test/py/tests/test_efi_capsule/version.dts | 24 ++ tools/eficapsule.h | 30 ++ tools/mkeficapsule.c | 37 ++- 27 files changed, 1046 insertions(+), 673 deletions(-) create mode 100644 doc/device-tree-bindings/firmware/firmware-version.txt create mode 100644 test/py/tests/test_efi_capsule/capsule_common.py create mode 100644 test/py/tests/test_efi_capsule/version.dts