From patchwork Wed Jun 7 05:41:50 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahisa Kojima X-Patchwork-Id: 690165 Delivered-To: patch@linaro.org Received: by 2002:a5d:4d8a:0:0:0:0:0 with SMTP id b10csp139557wru; Tue, 6 Jun 2023 22:42:44 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ6IOPcmFK0knmAv662en3YstftuV6Klein4eyO6YsJNwTpGIp8hgx0g0JQQjz7ykyUUWj0f X-Received: by 2002:a17:902:d48f:b0:1ae:8892:7d27 with SMTP id c15-20020a170902d48f00b001ae88927d27mr5047454plg.42.1686116563655; Tue, 06 Jun 2023 22:42:43 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1686116563; cv=none; d=google.com; s=arc-20160816; b=PKG9PocsNvmHeiOW2bN08fpiMVmKL6VuFPhOdPJSMR2yJ2BNRIGfCVfoQeAV4iYtLZ KML9FmuGXLyBVrwjv1px8wBxDzPfRlS5JgymKZk5s5Z6RAYVw/7OZzbHQJ5VdrrwrB2x eGnD+LVaDDnBzPBN/VmR/69Z+1eivvAt2SBxVnUIL/JJR9a36Fdco6zQLbD/G7ViLZR6 KsI3AcwLwq2f26CuyzDVHbu01DjxtVJdWr5uO93I5IJSGExHeCZBgTECVaNkReTyjkyS jKF1dKQ3gK6Y9epKfkoCdRn/bvXpjK4WA814iTcVWPgT9B9DYiietxyii+wlnQj5oHTG 7pOQ== 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=v1R/qbvwLdR4SZAKY/qFNu078KQwNAUx72e4gPKy9EI=; b=MKtWkA7Q4ByAz6T88mTg1jZA1qSMC32A3kTdovMDdwWnDCM3Pr7I/GYY6By3YpeWc7 MrV9W6ewn+5vOv4nWg3quA7zGwale3cK+QSp1ZZxW6U+tTBQqCiWoFvMaj9m2A9yPixp XJcQHreEjHIPHyfwoTXkW7MfP0vh/sl89hx8JkpXZOFhhksSV72GcvhdCBWv8m/V3UEj nxzlq0uUx6WyLIOcK+wGQ7gJuDVYJTLYb9C9umda1miYsCOQ3/Y1NX7pvrkHcOZ12KaM bOL2wlQjxDo4OrOBvyk/Pm2+HgywzuhbWhbpV1VUUVK3eIcU+goyfHb+sF9l/s18sFXI 7jHA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=AUu4edmU; 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 f17-20020a170902f39100b001b24f1c07c7si597089ple.460.2023.06.06.22.42.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Jun 2023 22:42:43 -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=AUu4edmU; 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 F37B485F1F; Wed, 7 Jun 2023 07:42:37 +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="AUu4edmU"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id C065385F50; Wed, 7 Jun 2023 07:42:36 +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-pj1-x1029.google.com (mail-pj1-x1029.google.com [IPv6:2607:f8b0:4864:20::1029]) (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 1055785D4E for ; Wed, 7 Jun 2023 07:42:34 +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-pj1-x1029.google.com with SMTP id 98e67ed59e1d1-256e1d87998so5917731a91.3 for ; Tue, 06 Jun 2023 22:42:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1686116552; x=1688708552; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=v1R/qbvwLdR4SZAKY/qFNu078KQwNAUx72e4gPKy9EI=; b=AUu4edmUw4v1DUCACs/fci/4tyrRxR0RPXL+4ao4Ne9eiS+9M9oBgoiiyIDitSUEoB 6QTFnxB2xWj5GuddOWxntJ6zz4yLWz2HuTEyJuXVuUdnsaqXh24txJtrGodIc9EHzfcD 1yjNlmBrwweydsYEoykRFAciQ33aEaEHzR23Lwhco7TKm/wi6sQ81ypYk724Ly2HHf+V 0FT3LUsDHwdXqppqIQg+Kzkj1JEEzv781votYbdxgPTgnGrBmg1sqyJEnYEX/lGlwN6E ws4dG0+TMrd9E7Tz770vyMwGLypZmQk20OMmPFr8ZFTPABqq+waLZN9beSlqrLEO2jHx UlcA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686116552; x=1688708552; 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=v1R/qbvwLdR4SZAKY/qFNu078KQwNAUx72e4gPKy9EI=; b=Wlplo7VOa2Cn0NQ3xRFrIpMbDTlI3q1631ZbhJPaMDiwa4nknpGHZirrcPBoZ8Eb+9 ilB1bXef1Sk02/Fp6NwLgCevkg9ji1hERdVKyyKMVIyjsaDfhE2Gk5Ka9UlMeSHhGBX4 6GBhbYAhcJLscNB9qdLyJBD6eMX8f/36YDDBw4JB45Bf40XRNLJq8GnsF1friLBbc4zm PLpURDzik0sDAdozZ8AtgKIwEnC818vuaq7WAzWNk74wtlMg8f1fd4zrTv4STFFzUsi6 rAV79wcKzd/s1vZz1tuHaefhtuRZx3Ga9p2j+pPo+kfKL6pMheEyldkMof+r6TxDB9QP GcGg== X-Gm-Message-State: AC+VfDwv66clcduQQKZvxC+0rZ1G+5K+4jCJs60+LRBq8elkjBUNB+oj sTEwGKLe5aahe9vTmK4DMyYHDwOmKYaqKtPclqw= X-Received: by 2002:a17:90a:db54:b0:255:d878:704a with SMTP id u20-20020a17090adb5400b00255d878704amr3929422pjx.4.1686116551971; Tue, 06 Jun 2023 22:42:31 -0700 (PDT) Received: from ubuntu-SVE15129CJS.. ([240d:1a:cf7:5800:d3c2:bf07:d08b:b72d]) by smtp.gmail.com with ESMTPSA id fh2-20020a17090b034200b0024df2b712a7sm469033pjb.52.2023.06.06.22.42.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Jun 2023 22:42:31 -0700 (PDT) From: Masahisa Kojima To: u-boot@lists.denx.de Cc: Heinrich Schuchardt , Ilias Apalodimas , Simon Glass , Takahiro Akashi , malte.schmidt-oss@weidmueller.com, Masahisa Kojima Subject: [PATCH v9 00/10] FMP versioning support Date: Wed, 7 Jun 2023 14:41:50 +0900 Message-Id: <20230607054201.42702-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 v9: - This version only updates python tests(test/py/tests/test_efi_capsule) - fix pylint warnings Major Changes in v8: - This version only updates python tests(test/py/tests/test_efi_capsule) - remove excess semicolons - add comments of newly created common functions 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 | 142 +++++++++ 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 | 269 ++++++---------- .../test_capsule_firmware_signed_raw.py | 276 +++++++--------- test/py/tests/test_efi_capsule/version.dts | 24 ++ tools/eficapsule.h | 30 ++ tools/mkeficapsule.c | 37 ++- 27 files changed, 1102 insertions(+), 677 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