From patchwork Tue Nov 17 00:27:54 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AKASHI Takahiro X-Patchwork-Id: 324536 Delivered-To: patch@linaro.org Received: by 2002:a17:906:d156:0:0:0:0 with SMTP id br22csp4491443ejb; Mon, 16 Nov 2020 16:29:02 -0800 (PST) X-Google-Smtp-Source: ABdhPJx0u7XSgPNEu/Yg6wsNBzfeuI49Esbosloo8NPFRKoWBW7B1ydaPx9lJRacxWsBO15e4DAJ X-Received: by 2002:a17:906:f286:: with SMTP id gu6mr17578565ejb.182.1605572942391; Mon, 16 Nov 2020 16:29:02 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1605572942; cv=none; d=google.com; s=arc-20160816; b=UtbAPFrIadevaxb0g9zQqkHfMwC9Wq9r5ZkoFV1Jyx3Tf8X3Gv7Ax1FeIef/x6tpY9 XvHJT5JYfgUPDhUFFOCJcb6rro6QCgrt78TrR5LxibX0zsLfA+IoWe0NStalGGbkJpQh 3/y1I3g5nkKPKG8pu5Z7YIrFWhhaP3zQKUOZZEAYj1ylKVQ8KOGxVem1ShmGASV9JiHo 6L/9DSfbmj1lPi+ikQQ/l+f8AfM6n+5AXhUFH1lOv6swclKJKhzKUiYtXbQfoxobqD8C 2gpBBZc73X/mjbTz1KL1rUHn4EAeWTr93YrkKu+EyA0c5hJ/CLu+MdYNbuCdXNyrYaf5 lulw== 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=zZJ3W+rIa/soD8GUs1SGFX8I2jFwfPzSUkxLnnBzxIA=; b=EXJCj/d/9wO61LW1Fb2ZEEiuAR8ljrG7r+wKJ0yebETCtHbnJu2zUpnZcqybPixxXF MOTmRCmek6aV29g60x2iKm0pFNcKVcFrmKnR7jV12XpR30sOU2l10q5XId7x+mw/M1Oc NJwSqN72sfD+HPWA5OdCTITLTsguQ+i2LmzL6xTpZ1uVhF3uPMshif7qP/KT+HEd7ef3 NsD3ZwmPr/HwJmiLRvAjVeVWKmD76gkzUk0vXxqEEMDuxrnjf5JUItEJqkxKnDCvIgQ8 9Us1hY2W0FEu9m2L12woHmid3QcOesXbSgvINBz4h3Yu2jr3H/X/wIX7OnH6seT7CjB6 a/RQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=wiAA+qZP; 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=pass (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 um17si12698697ejb.701.2020.11.16.16.29.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 16 Nov 2020 16:29:02 -0800 (PST) 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; dkim=pass header.i=@linaro.org header.s=google header.b=wiAA+qZP; 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=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 BE9F78241C; Tue, 17 Nov 2020 01:28:57 +0100 (CET) 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="wiAA+qZP"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 6FE77821F7; Tue, 17 Nov 2020 01:28:56 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,SPF_HELO_NONE,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.2 Received: from mail-pg1-x52a.google.com (mail-pg1-x52a.google.com [IPv6:2607:f8b0:4864:20::52a]) (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 D35BB821F7 for ; Tue, 17 Nov 2020 01:28:43 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=takahiro.akashi@linaro.org Received: by mail-pg1-x52a.google.com with SMTP id e21so14724533pgr.11 for ; Mon, 16 Nov 2020 16:28:43 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=zZJ3W+rIa/soD8GUs1SGFX8I2jFwfPzSUkxLnnBzxIA=; b=wiAA+qZPOy/f5pM0GLHUXfe+isIImbGS1Z+hR9WB7jWLx30NhMKLxRihP+Cx1Iv+9G IudC+pggTBJQb8WgCeSZIhb4R1Qu9gEsUJ1wdaHISL1ishwKBxfn2PM9Ek33pWbflYzT TsO6dAvTHOxG//VDuxcYG3fCH8J3YsoHUrG9086j4zlWrtFmDa07nvs+0Z7X8O47TFD1 EqUNtWZGDNSAHPLDjN+VUtSHHJCAFXn+HaWM9j7uDid9EWvazDoKzglnlqFgpQTxu8K/ XUhZKw+fj2ZxuRiDzWWHQ+7EohgjVtBpql20eQvvgACurJbGDgpOGdYBw+BSR1dN2QD+ /abA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=zZJ3W+rIa/soD8GUs1SGFX8I2jFwfPzSUkxLnnBzxIA=; b=D7yQ06mlkkjnZaq0Qzd+FGnnmX8UsJbsHWgyhuic3N8U4a1FAIgeiiYqGmIPv3X3v1 s6w9XVb5OIgu1/CTs+YXcG1YRDt9ZVKHjgi6QW7ejdZ3sehg3+66BISCGfcvOVkYSguh CqaBeEre0vAzVhZO5f0E9LvKSWjF0gAZu3IVixxSr1f9kGp21vduJl/5u8paIaRWVQYc +HBExwDnVQhD+txckHmmi/caz0m4KRKr+c7HuykZduNLoCCT45PO6xrGL8Az5TU+2H1z du44MIYX2tcpmT3lt9i7CFbptdh5f+mLDfpCEtme/WvJMUI4th0B9MeNplzGqkIO+q/7 ZzQA== X-Gm-Message-State: AOAM533ZGIANnbBT0AxENXYWBXLL9drKncDAMabMbNYUE3N/ysPe/guH dCU5Q57w5C2PVOs61ZT4W/ZhoQ== X-Received: by 2002:a17:90a:7504:: with SMTP id q4mr1662407pjk.213.1605572917371; Mon, 16 Nov 2020 16:28:37 -0800 (PST) Received: from localhost.localdomain (p784a5642.tkyea130.ap.so-net.ne.jp. [120.74.86.66]) by smtp.gmail.com with ESMTPSA id t64sm20116506pfd.36.2020.11.16.16.28.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 16 Nov 2020 16:28:36 -0800 (PST) From: AKASHI Takahiro To: xypron.glpk@gmx.de, agraf@csgraf.de Cc: sughosh.ganu@linaro.org, u-boot@lists.denx.de, AKASHI Takahiro Subject: [PATCH v9 00/11] efi_loader: add capsule update support Date: Tue, 17 Nov 2020 09:27:54 +0900 Message-Id: <20201117002805.13902-1-takahiro.akashi@linaro.org> X-Mailer: git-send-email 2.28.0 MIME-Version: 1.0 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.34 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.102.3 at phobos.denx.de X-Virus-Status: Clean Summary ======= 'UpdateCapsule' is one of runtime services defined in UEFI specification and its aim is to allow a caller (OS) to pass information to the firmware, i.e. U-Boot. This is mostly used to update firmware binary on devices by instructions from OS. While 'UpdateCapsule' is a runtime services function, it is, at least initially, supported only before exiting boot services alike other runtime functions, [Get/]SetVariable. This is because modifying storage which may be shared with OS must be carefully designed and there is no general assumption that we can do it. Therefore, we practically support only "capsule on disk"; any capsule can be handed over to UEFI subsystem as a file on a specific file system. In this patch series, all the related definitions and structures are given as UEFI specification describes, and basic framework for capsule support is provided. Currently supported is * firmware update (Firmware Management Protocol or simply FMP) Most of functionality of firmware update is provided by FMP driver and it can be, by nature, system/platform-specific. So you can and should implement your own FMP driver(s) based on your system requirements. Under the current implementation, we provide two basic but generic drivers with two formats: * FIT image format (as used in TFTP update and dfu) * raw image format It's totally up to users which one, or both, should be used on users' system depending on user requirements. Quick usage =========== 1. You can create a capsule file with the following host command: $ mkeficapsule [--fit | --raw ] 2. Put the file under: /EFI/UpdateCapsule of UEFI system partition 3. Specify firmware storage to be updated in "dfu_alt_info" variable (Please follow README.dfu for details.) ==> env set dfu_alt_info '...' 4. After setting up UEFI's OsIndications variable, reboot U-Boot: OsIndications <= EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED Patch structure =============== Patch#1-#6: main part of implementation Patch#7-#8: utilities Patch#9-#10: pytests Patch#11: for sandbox test [1] https://git.linaro.org/people/takahiro.akashi/u-boot.git efi/capsule Prerequisite patches ==================== None Test ==== * passed all the pytests which are included in this patch series on sandbox build locally. * In Travis CI, all tests skipped (or 'S', but it's not a failure, 'F') because "virt-make-fs" cannot be executed. Issues ====== * Timing of executing capsules-on-disk Currently, processing a capsule is triggered only as part of UEFI subsystem initialization. This means that, for example, firmware update, may not take place at system booting time and will potentially be delayed until a first call of any UEFI functions. => See patch#5 for my proposal * A bunch of warnings like WARNING: Use 'if (IS_ENABLED(CONFIG...))' instead of '#if or #ifdef' where possible I don't think that fixing those improves anything. * Add a document in uefi.rst TODO's ====== (Won't be addressed in this series.) * capsule authentication * capsule dependency (dependency expression instruction set, or depex) * loading drivers in a capsule * handling RESET flag in a capsule and QeuryCapsuleCaps * full semantics of ESRT (EFI System Resource Table) * enabling capsule API at runtime * json capsule * recovery from update failure Changes ======= v9 (November 17, 2020) * rebased on v2021.01-rc2 * removed already-merged patches * aligned with a function prototype change of efi_create_indexed_name() (Patch#1-2) # See Travis CI status in v8 below v8 (November 13, 2020) * fix a "not used" warning against update_load() in some configuration (Patch#3) * fix failures (marked as 'F') in *secure boot* test in Travis CI by making "EFI_CAPSULE_ON_DISK_EARLY" 'default n' (Patch#8) * fix failures (marked as 'E') at pytest setup in Travis CI by changing a python file's name along with removing unused definitions (Patch#16) * add Patch#18 to enable tests to be run with default sandbox config (Patch#18) v7 (October 29, 2020) * rename CONFIG_DFU_ALT to CONFIG_DFU_WRITE_ALT (Patch#1,#3,#13) v6 RESEND (October 29, 2020) * rebased on v2021.01-rc1 v6 (September 7, 2020) * temporarily drop the prerequisite patch[2] * add a missing field (dependencies) in efi_api.h (but never used) (Patch#10) * add a missing field (image_capsule_support) and related definitions in efi_api.h (Patch#10, #15) * cosmetic changes on constant definitions in efi_api.h (Patch#10) * strict check for INVALID_PARAMETER at GET_IMAGE_INFO api (Patch#11,#13) * fix warnings in pytest (Patch#16,#17) v5 (August 3, 2020) * removed superfluous type conversion at dfu_write_from_mem_addr() (Patch#2) * introduced a common helper function, efi_create_indexed_name() (Patch#6,#7,#8) * use efi_[get|set]_variable_int(), if necessary, with READ_ONLY (Patch#7,#8) * return EFI_UNSUPPORTED at Patch#7 * changed the word, number, to 'index' (Patch#7,#8) * removed 'ifdef CONFIG_EFI_CAPSULE_ON_DISK' from a header (Patch#8) * initialize 'CapsuleLast' in efi_init_obj_list() (Patch#7,#8) * added 'const' qualifier for filename argument at efi_capsule_[read|delete]_file() (Patch#8) v4 (July 22, 2020) * rebased to Heinrich's current efi-2020-10 * rework dfu-related code to align with Heinrich's change (Patch#1,#3) * change a type of 'addr' argument from int to 'void *' per Sughosh's comment (Patch#2-#3,#11-#12) * rework/simplify pytests (Patch#15-#16) - utilize virt-make-fs - drop Test Case 1 (updating U-Boot environment data) - remove useless definitions (MNT_PNT, EFI_CAPSULE_IMAGE_NAME) - apply autopep8 v3 (July 10, 2020) * rebased to Heinrich's current efi-2020-10-rc1 * refactor efi_firmware_[fit|raw]_get_image_info() (patch#11,#13) v2 (June 17, 2020) * rebased to v2020.07-rc4 * add preparatory patches for dfu (Patch#1-#5, #12) * rework FIT capsule driver to utilize dfu_alt_info instead of CONFIG_xxx (patch#11) * extend get_image_info() to correspond to dfu_alt_info (patch#11) * add a 'raw binary' capsule support (patch#13, #17) * allow multiple capsule formats (with different GUIDs) to be installed (patch#11, #13) * extend mkeficapsule command to accept additional parameters, like version/index/hardware instance for a capsule header info. (patch#15) * mkeficapsule can now also generate raw-binary capsule (patch#16) * add function descriptions * apply autopep8 to pytests and fix more against pylint v1 (April 27, 2020) * rebased to v2020.07-rc * removed already-merged patches (RFC's #1 to #4) * dropped 'variable update' capsule support (RFC's patch#10) * dropped 'variable configuration table' support (RFC's patch#11) (Those two should be discussed separately.) * add preparatory patches (patch#1/#2) * fix several build errors * rename some Kconfig options to be aligned with UEFI specification's terms (patch#3,4,6,7) * enforce UpdateCapsule API to be disabled after ExitBootServices (patch#3) * use config table, runtime_services_supported, instead of variable (patch#3) * make EFI_CAPSULE_ON_DISK buildable even if UpdateCapsule API is disabled (patch4) * support OsIndications, invoking capsule-on-disk only if the variable indicates so (patch#4) * introduced EFI_CAPSULE_ON_DISK_EARLY to invoke capsule-on-disk in U-Boot initialization (patch#4) * detect capsule files only if they are on EFI system partition (patch#4) * use printf, rather than EFI_PRINT, in error cases (patch#4) * use 'header_size' field to retrieve capsule data, adding sanity checks against capsule size (patch#6) * call fmpt driver interfaces with EFI_CALL (patch#6) * remove 'variable update capsule'-related code form mkeficapsule (patch#9) * add a test case of OsIndications not being set properly (patch#10) * adjust test scenario for EFI_CAPSULE_ON_DISK_EARLY (patch#10) * revise pytest scripts (patch#10) Initial release as RFC (March 17, 2020) AKASHI Takahiro (11): efi_loader: define UpdateCapsule api efi_loader: capsule: add capsule_on_disk support efi_loader: capsule: add memory range capsule definitions efi_loader: capsule: support firmware update efi_loader: add firmware management protocol for FIT image efi_loader: add firmware management protocol for raw image cmd: add "efidebug capsule" command tools: add mkeficapsule command for UEFI capsule update test/py: efi_capsule: test for FIT image capsule test/py: efi_capsule: test for raw image capsule sandbox: enable capsule update for testing cmd/efidebug.c | 235 +++++ common/main.c | 4 + configs/sandbox64_defconfig | 6 + configs/sandbox_defconfig | 6 + include/efi_api.h | 166 ++++ include/efi_loader.h | 27 + lib/efi_loader/Kconfig | 68 ++ lib/efi_loader/Makefile | 2 + lib/efi_loader/efi_capsule.c | 917 ++++++++++++++++++ lib/efi_loader/efi_firmware.c | 403 ++++++++ lib/efi_loader/efi_runtime.c | 104 +- lib/efi_loader/efi_setup.c | 76 +- .../py/tests/test_efi_capsule/capsule_defs.py | 5 + test/py/tests/test_efi_capsule/conftest.py | 74 ++ .../test_efi_capsule/test_capsule_firmware.py | 241 +++++ .../tests/test_efi_capsule/uboot_bin_env.its | 36 + tools/Makefile | 2 + tools/mkeficapsule.c | 239 +++++ 18 files changed, 2557 insertions(+), 54 deletions(-) create mode 100644 lib/efi_loader/efi_capsule.c create mode 100644 lib/efi_loader/efi_firmware.c create mode 100644 test/py/tests/test_efi_capsule/capsule_defs.py create mode 100644 test/py/tests/test_efi_capsule/conftest.py create mode 100644 test/py/tests/test_efi_capsule/test_capsule_firmware.py create mode 100644 test/py/tests/test_efi_capsule/uboot_bin_env.its create mode 100644 tools/mkeficapsule.c -- 2.28.0