From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 9C8F6ECAAA1 for ; Mon, 19 Sep 2022 21:38:11 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 36CE284AB6; Mon, 19 Sep 2022 23:38:09 +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="mmkmGqC+"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id CC6AF84AD6; Mon, 19 Sep 2022 23:38:07 +0200 (CEST) Received: from mail-pj1-x1034.google.com (mail-pj1-x1034.google.com [IPv6:2607:f8b0:4864:20::1034]) (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 D75BB84934 for ; Mon, 19 Sep 2022 23:38:04 +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=jaswinder.singh@linaro.org Received: by mail-pj1-x1034.google.com with SMTP id s14-20020a17090a6e4e00b0020057c70943so8744601pjm.1 for ; Mon, 19 Sep 2022 14:38:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date; bh=AULkfh5+AiVL2Yz2EGbfpU//518RLP4P4kbqaQ93nbY=; b=mmkmGqC+Oc9ZOvIPiy7R4GThe43/I+rqCTknGu4TF0bILvrNGdDIGuBgL/JuuBXJuo ll10bP+Ok6Pu4Wz8qDADp6leUej5+lIuV9fyHViVVFp636oXx0or1ryjxG+MN1iWBBpd PYAoyB/ZlaaxkoYTikOtNhcwy97VCqYa7I6vB2nhdshXIw9ajuWqqc7SjjhLRCsVFJVN CzNd3QkUKPVJwjLC0u9lSpbpVvCHxERcAxWMiHv4WAeDPxLZaaoeHOksY3CCd3w2vs5J +UF3NgBgtwFKuiHmP8WfthBt/bQwN7yaH85cghrDS3pJ+Bf1WDsG0ChkGesSUPG1dujj AL2Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date; bh=AULkfh5+AiVL2Yz2EGbfpU//518RLP4P4kbqaQ93nbY=; b=gx7opOLiwQMm9Q0MnRyxG6p5u33jaorNiMfTTD0gh2ZU1CbzUorTTKPa5YphR92kR7 nRHp5zqQSAyzYnXXYNakpHxxIJIViWZy/wHkk7HOmcZI2igqMIWqIyt2ppm/SlusOCbZ atAjhtei+TwC+33Ho+jVHPIvCtCbXpBvabzVu4gI/GOFBQTghSlIzDH+m6kqnPTjgQdr dd+JodCkN4NnrskEXwMQIneLtV2w/cqaFQ/Hrg7dT8z9X1cYzYmPCOAfLBv9LHvYCDud NGUs1TYVJ9IEUwI6AILfNrLtrtgiuSCSHceH2CR/u1zOOq8AtwBJvmGAfAan+o4hbLQf HLSA== X-Gm-Message-State: ACrzQf0h2C1y0kJsJmtpC4UrqcRD61xNMLSvUsZjBz5glmr/l7h/i8Qk ylpDld927JCDlTS2JJsnVPea33Rf56MnMSRGQR/Z+Q== X-Google-Smtp-Source: AMsMyM4q9hGrRlD43vxm5lOfSfJGvvfjyRIKf0/iAIAkm7TL5u3cdjAkjMl2YVMp2bOzjHv+HkhS3jUANwlWWILiQ28= X-Received: by 2002:a17:902:8c92:b0:178:29d4:600f with SMTP id t18-20020a1709028c9200b0017829d4600fmr1766825plo.40.1663623482977; Mon, 19 Sep 2022 14:38:02 -0700 (PDT) MIME-Version: 1.0 References: <20220915081451.633983-1-sughosh.ganu@linaro.org> <20220915081451.633983-16-sughosh.ganu@linaro.org> In-Reply-To: <20220915081451.633983-16-sughosh.ganu@linaro.org> From: Jassi Brar Date: Mon, 19 Sep 2022 16:37:51 -0500 Message-ID: Subject: Re: [PATCH v10 15/15] FWU: doc: Add documentation for the FWU feature To: Sughosh Ganu Cc: u-boot@lists.denx.de, Heinrich Schuchardt , Ilias Apalodimas , Takahiro Akashi , Patrick Delaunay , Patrice Chotard , Simon Glass , Bin Meng , Tom Rini , Etienne Carriere , Michal Simek Content-Type: text/plain; charset="UTF-8" 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 On Thu, 15 Sept 2022 at 03:16, Sughosh Ganu wrote: > diff --git a/doc/develop/uefi/fwu_updates.rst b/doc/develop/uefi/fwu_updates.rst > new file mode 100644 > index 0000000000..fad3fbb3a8 > --- /dev/null > +++ b/doc/develop/uefi/fwu_updates.rst > @@ -0,0 +1,165 @@ > +.. SPDX-License-Identifier: GPL-2.0+ > +.. Copyright (c) 2022 Linaro Limited > + > +FWU Multi Bank Updates in U-Boot > +================================ > + > +The FWU Multi Bank Update feature implements the firmware update > +mechanism described in the PSA Firmware Update for A-profile Arm > +Architecture specification [1]. Certain aspects of the Dependable > +Boot specification [2] are also implemented. The feature provides a > +mechanism to have multiple banks of updatable firmware images and for > +updating the firmware images on the non-booted bank. On a successful > +update, the platform boots from the updated bank on subsequent > +boot. The UEFI capsule-on-disk update feature is used for performing > +the actual updates of the updatable firmware images. > + > +The bookkeeping of the updatable images is done through a structure > +called metadata. Currently, the FWU metadata supports identification > +of images based on image GUIDs stored on a GPT partitioned storage > +media. There are plans to extend the metadata structure for non GPT > +partitioned devices as well. > + > +Accessing the FWU metadata is done through generic API's which are > +defined in a driver which complies with the U-Boot's driver model. A > +new uclass UCLASS_FWU_MDATA has been added for accessing the FWU > +metadata. Individual drivers can be added based on the type of storage > +media, and it's partitioning method. Details of the storage device > +containing the FWU metadata partitions are specified through a U-Boot > +specific device tree property `fwu-mdata-store`. Please refer to > +U-Boot `doc `__ > +for the device tree bindings. > + > +Enabling the FWU Multi Bank Update feature > +------------------------------------------ > + > +The feature can be enabled by specifying the following configs:: > + > + CONFIG_EFI_CAPSULE_ON_DISK=y > + CONFIG_EFI_CAPSULE_FIRMWARE_MANAGEMENT=y > + CONFIG_EFI_CAPSULE_FIRMWARE=y > + CONFIG_EFI_CAPSULE_FIRMWARE_RAW=y > + > + CONFIG_FWU_MULTI_BANK_UPDATE=y > + CONFIG_CMD_FWU_METADATA=y > + CONFIG_DM_FWU_MDATA=y > s/CONFIG_DM_FWU_MDATA/CONFIG_FWU_MDATA