From patchwork Wed Aug 17 12:43:10 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sughosh Ganu X-Patchwork-Id: 597849 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:b345:0:0:0:0 with SMTP id w5csp3206090maz; Wed, 17 Aug 2022 05:44:01 -0700 (PDT) X-Google-Smtp-Source: AA6agR7Djjy4kOgbit7KPqkhm7XjzzdYXL8nnG7fZTjvyllOd+umMBbgxrUq3g4Ha2FXD6TrFsrZ X-Received: by 2002:a05:651c:23a6:b0:25e:6365:65eb with SMTP id bk38-20020a05651c23a600b0025e636565ebmr8178477ljb.355.1660740241755; Wed, 17 Aug 2022 05:44:01 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1660740241; cv=none; d=google.com; s=arc-20160816; b=p+L5t0cCT6U2U88RcqsFt3/dM8Hw4Mk+5Gsyf/bnwtdtYeSaksXJOx6yXW4DnQOm4Y QJsaG1YpLJ8/0CA1pgm/kr8FraQQUr166MfPzVHSjZ4Ikt6xLf+mLRIvz0OU46canI0I p0kqT+78BuS9s/Q/SA7ujgUXGICQQfdxOjZpxd3dWZ2YnX5W3HBnb38+CFTSNOcPZIz5 j+v//S6ZWA7uFSEFcYVrbWm4FD+VmVEbmNfAJnEs/E9CAOB9LbeB+riOgC7WLWUXRy2U SIXvYJCe0rHDd5FrUXRyXddnD+RIsT9LSCNKHDHiXEmSz9tEzIEVWcLKIwvb9dH07Bo+ WZlA== 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; bh=x8B9IeFVWpLqraCvyF5NeaQT2K9qb7zjaz0+SNOdttw=; b=nxyLhc1WkrbiqwFTi3/F9CHcBWkY/guPpBYOhzRBf+jFyeHnS5PRd8rUbZOH1B5ns7 ZgKLhAK+BNWWe5HlS/ucNW9Ki85E6syMmgJhFKAlt2JPXg5sqY3tTR1sOLqHMi5g/ddM YmRIROwPsqD6A4ZFNSocFzDV+/yWcvmzHWcKr9iVhaZdLjhXO60FvPlybtX7whBo6KvH bEva5rAI1y7HJhni0MEpg5KQgUvGKQllEbfHyEl+fYBcSR8AwNWAU1n1VhaBIcRcghaV g4PIZn/i4mMLCVsMFXjwzXbYhndOYipS8emHkSTSZiHQGZLZJ52CBsQn0DcUd5Q5xu13 FcwQ== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from phobos.denx.de (phobos.denx.de. [85.214.62.61]) by mx.google.com with ESMTPS id h1-20020a056512350100b0048a0e1ecd21si8741496lfs.55.2022.08.17.05.44.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 17 Aug 2022 05:44:01 -0700 (PDT) Received-SPF: pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) client-ip=85.214.62.61; Authentication-Results: mx.google.com; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=fail (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 339C8849DB; Wed, 17 Aug 2022 14:43:59 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Received: by phobos.denx.de (Postfix, from userid 109) id 38856849D4; Wed, 17 Aug 2022 14:43:57 +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=-1.2 required=5.0 tests=BAYES_00,SPF_HELO_NONE, SPF_SOFTFAIL,T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.2 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by phobos.denx.de (Postfix) with ESMTP id 2060F8498C for ; Wed, 17 Aug 2022 14:43:54 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=fail smtp.mailfrom=sughosh.ganu@linaro.org Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id DF47D113E; Wed, 17 Aug 2022 05:43:53 -0700 (PDT) Received: from a076522.blr.arm.com (a076522.blr.arm.com [10.162.16.44]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id A73B23F67D; Wed, 17 Aug 2022 05:43:49 -0700 (PDT) From: Sughosh Ganu To: u-boot@lists.denx.de Cc: Heinrich Schuchardt , Ilias Apalodimas , Takahiro Akashi , Patrick Delaunay , Patrice Chotard , Simon Glass , Bin Meng , Tom Rini , Etienne Carriere , Michal Simek , Jassi Brar Subject: [PATCH v8 00/13] FWU: Add FWU Multi Bank Update feature support Date: Wed, 17 Aug 2022 18:13:10 +0530 Message-Id: <20220817124323.375968-1-sughosh.ganu@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.6 at phobos.denx.de X-Virus-Status: Clean The patchset adds support for the FWU Multi Bank Update[1] feature. Certain aspects of the Dependable Boot[2] specification have also been implemented. The FWU multi bank update feature is used for supporting multiple sets(also called banks) of firmware image(s), allowing the platform to boot from a different bank, in case it fails to boot from the active bank. This functionality is supported by keeping the relevant information in a structure called metadata, which provides information on the images. Among other parameters, the metadata structure contains information on the currect active bank that is being used to boot image(s). Functionality is being added to work with the UEFI capsule driver in u-boot. The metadata is read to gather information on the update bank, which is the bank to which the firmware images would be flashed to. On a successful completion of the update of all components, the active bank field in the metadata is updated, to reflect the bank from which the platform will boot on the subsequent boots. Currently, the feature is being enabled on the STM32MP157C-DK2 and Synquacer boards. The DK2 board boots a FIP image from a uSD card partitioned with the GPT partioning scheme, while the Synquacer board boots a FIP image from a MTD partitioned SPI NOR flash device. This feature also requires changes in a previous stage of bootloader, which parses the metadata and selects the bank to boot the image(s) from. Support has being added in tf-a(BL2 stage) for the STM32MP157C-DK2 board to boot the active bank images. These changes have been merged to the upstream tf-a repository. The patch for adding a python test for the feature has been developed, and was sent in the version 5 of the patches[3]. However, the test script depends on adding support for the feature on MTD SPI NOR devices, and that is being done as part of the Synquacer patches. Hence these set of patches do not have the test script for the feature. That will be added through the patches for adding support for the feauture on Synquacer platform. [1] - https://developer.arm.com/documentation/den0118/a [2] - https://git.codelinaro.org/linaro/dependable-boot/mbfw/uploads/6f7ddfe3be24e18d4319e108a758d02e/mbfw.pdf [3] - https://lists.denx.de/pipermail/u-boot/2022-June/485992.html Changes since V7: * Rephrased the error message in fwu_update_active_index as per suggestion from Ilias. * Reworked the logic in fwu_get_image_alt_num() as per the suggestion from Ilias. * Moved the API's fwu_plat_get_update_index() and fwu_plat_get_alt_num() as weak functions in common code as suggested by Ilias. * Introduce trial_counter_update() to increment and delete the TrialStateCtr variable. * Introduce in_trial_state() to check if the platform is booting in Trial State. * Introduce a new function fwu_to_efi_error() and check for all errors returned by the fwu API's through this function, as suggested by Ilias. * Call fwu_trial_state_ctr_start() only when the OS is supposed to accept/reject the updated images. * Modify the logic to check the setting of both -A and -R options being passed to the tool, as suggested by Ilias. * Handle the various review comments from Heinrich. Sughosh Ganu (13): dt/bindings: Add bindings for GPT based FWU Metadata storage device FWU: Add FWU metadata structure and driver for accessing metadata FWU: Add FWU metadata access driver for GPT partitioned block devices stm32mp1: dk2: Add a node for the FWU metadata device stm32mp1: dk2: Add image information for capsule updates FWU: Add helper functions for accessing FWU metadata FWU: STM32MP1: Add support to read boot index from backup register FWU: Add boot time checks as highlighted by the FWU specification FWU: Add support for the FWU Multi Bank Update feature FWU: cmd: Add a command to read FWU metadata mkeficapsule: Add support for generating empty capsules mkeficapsule: Add support for setting OEM flags in capsule header FWU: doc: Add documentation for the FWU feature arch/arm/dts/stm32mp157c-dk2-u-boot.dtsi | 7 + arch/arm/mach-stm32mp/include/mach/stm32.h | 5 + board/st/stm32mp1/stm32mp1.c | 36 ++ cmd/Kconfig | 7 + cmd/Makefile | 1 + cmd/fwu_mdata.c | 80 +++ common/board_r.c | 5 + doc/develop/uefi/fwu_updates.rst | 165 +++++++ doc/develop/uefi/index.rst | 1 + doc/develop/uefi/uefi.rst | 2 + .../firmware/fwu-mdata-gpt.yaml | 32 ++ doc/mkeficapsule.1 | 33 +- drivers/Kconfig | 2 + drivers/Makefile | 1 + drivers/fwu-mdata/Kconfig | 16 + drivers/fwu-mdata/Makefile | 7 + drivers/fwu-mdata/fwu-mdata-uclass.c | 463 ++++++++++++++++++ drivers/fwu-mdata/fwu_mdata_gpt_blk.c | 410 ++++++++++++++++ include/configs/stm32mp15_common.h | 4 + include/dm/uclass-id.h | 1 + include/fwu.h | 69 +++ include/fwu_mdata.h | 67 +++ lib/Kconfig | 6 + lib/Makefile | 1 + lib/efi_loader/efi_capsule.c | 213 +++++++- lib/efi_loader/efi_setup.c | 3 +- lib/fwu_updates/Kconfig | 31 ++ lib/fwu_updates/Makefile | 7 + lib/fwu_updates/fwu.c | 210 ++++++++ lib/fwu_updates/fwu_gpt.c | 104 ++++ tools/eficapsule.h | 8 + tools/mkeficapsule.c | 109 ++++- 32 files changed, 2085 insertions(+), 21 deletions(-) create mode 100644 cmd/fwu_mdata.c create mode 100644 doc/develop/uefi/fwu_updates.rst create mode 100644 doc/device-tree-bindings/firmware/fwu-mdata-gpt.yaml create mode 100644 drivers/fwu-mdata/Kconfig create mode 100644 drivers/fwu-mdata/Makefile create mode 100644 drivers/fwu-mdata/fwu-mdata-uclass.c create mode 100644 drivers/fwu-mdata/fwu_mdata_gpt_blk.c create mode 100644 include/fwu.h create mode 100644 include/fwu_mdata.h create mode 100644 lib/fwu_updates/Kconfig create mode 100644 lib/fwu_updates/Makefile create mode 100644 lib/fwu_updates/fwu.c create mode 100644 lib/fwu_updates/fwu_gpt.c