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 D2857C433F5 for ; Wed, 13 Apr 2022 07:08:24 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 5E7DF838AE; Wed, 13 Apr 2022 09:08:22 +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="x/ezojCm"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 75C7E8393F; Wed, 13 Apr 2022 09:08:20 +0200 (CEST) Received: from mail-qk1-x732.google.com (mail-qk1-x732.google.com [IPv6:2607:f8b0:4864:20::732]) (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 6C7C8810E6 for ; Wed, 13 Apr 2022 09:08:17 +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=sughosh.ganu@linaro.org Received: by mail-qk1-x732.google.com with SMTP id j6so729819qkp.9 for ; Wed, 13 Apr 2022 00:08:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=mime-version:references:in-reply-to:from:date:message-id:subject:to; bh=EjBGaY4/1kHlc5pqmc/s5AHyOl672j+EkNPhPgf5Gok=; b=x/ezojCmJ1IWA8B0wHN8ldE5nCMAKyKeIcVhGt60ipDB8OD7Duhcqg1PwLfbZhXJr2 BUYePJqvCBQ+itLP/d+h9iLJkITm67o3if+yNMxn2pYaSRqW8L3WrjvB2hkzXkeJcBDR 6smn1hc/t+GBvqBzLTxLTijOPAbHXB8TuBrvATDd5Y/C9Z7bVdH4oIRHGYttBQwusk0m i82KQZY3vjJhuxC0fa9GxaEPE0krrl61KG3eA7Kp9Zc7EVy1rw9p3AFDs9nrqLvMgdPI Q8Dy0BsxPI0ym6f5cw0xTzGR7+rnjOB9aNSCOhiBpfVanCBkZAy+f9vipOHKXWXSV1BG 8zXg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to; bh=EjBGaY4/1kHlc5pqmc/s5AHyOl672j+EkNPhPgf5Gok=; b=xpmeoT3dMm9wrKN7J5hFTKXH0lNQ/2FSZQ8YEtTSK0v2VgUEXy8RhNMuHOWNKNk8Tv ZgLUxCNfRevHm2zdKxUkr9MKei/K4RGwS7fjee3D5S+xbN43Zzsr2J2VqN40fiYpWGPn IpsEaFNdYvmKbkXlLOtN5Y0uZb2dBNQtYnkgC95HQAT/8mCr0Ns0KNt+gVsLZQXsv2kx xiLf+qRvgd2VpSvk4TI11Yb/8WYNTeW23aBx+xXpCJpWHZJcc5sOGrrNum8qDCM6zFqL mlqIXn6r35A1Ew24OQJLMusIiNP4CFoQCwp+CCuj17Fatk+QKnmcr3UqGO5ye3cPSFaT xmNg== X-Gm-Message-State: AOAM530ttwndByhM9wehMgoWTTiPt0ila467+lj1muwRc+8a4MPpOoK/ Q8HXgr3XzGhD9leiyijqc8A386SfA4O+lhT8XEfzSA== X-Google-Smtp-Source: ABdhPJwnJzUteylhnZ+mFpFf0maWFMs0QGLUgg3nWx5EsHCxjsdZuYVAw3QLUHZJwyvz9hFhqYrCEQc6+LWlgxFbeSU= X-Received: by 2002:a37:a584:0:b0:69a:9b37:6406 with SMTP id o126-20020a37a584000000b0069a9b376406mr5678179qke.505.1649833696173; Wed, 13 Apr 2022 00:08:16 -0700 (PDT) MIME-Version: 1.0 References: <20220412130447.300574-1-sughosh.ganu@linaro.org> <20220412130447.300574-9-sughosh.ganu@linaro.org> <20220413061833.GB87648@laputa> In-Reply-To: <20220413061833.GB87648@laputa> From: Sughosh Ganu Date: Wed, 13 Apr 2022 12:38:05 +0530 Message-ID: Subject: Re: [PATCH v6 8/8] doc: uefi: Update the capsule update related documentation To: AKASHI Takahiro , Sughosh Ganu , u-boot@lists.denx.de, Heinrich Schuchardt , Ilias Apalodimas , Ying-Chun Liu , Tuomas Tynkkynen , Heiko Thiery , Frieder Schrempf , Michael Walle , Masami Hiramatsu , Jassi Brar , Michal Simek , 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.5 at phobos.denx.de X-Virus-Status: Clean On Wed, 13 Apr 2022 at 11:48, AKASHI Takahiro wrote: > > On Tue, Apr 12, 2022 at 06:34:47PM +0530, Sughosh Ganu wrote: > > Update the capsule update functionality related documentation to > > refect the additional definitions that need to be made per platform > > for supporting the capsule update feature. > > > > Signed-off-by: Sughosh Ganu > > --- > > > > Changes since V5: None > > > > doc/develop/uefi/uefi.rst | 51 +++++++++++++++++++++++++++++++++++++-- > > 1 file changed, 49 insertions(+), 2 deletions(-) > > > > diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst > > index fe337c88bd..b766aecf67 100644 > > --- a/doc/develop/uefi/uefi.rst > > +++ b/doc/develop/uefi/uefi.rst > > @@ -312,8 +312,8 @@ Run the following command > > .. code-block:: console > > > > $ mkeficapsule \ > > - --index 1 --instance 0 \ > > - [--fit | --raw ] \ > > + --index --instance 0 \ > > + --guid \ > > > > > > Performing the update > > @@ -333,6 +333,53 @@ won't be taken over across the reboot. If this is the case, you can skip > > this feature check with the Kconfig option (CONFIG_EFI_IGNORE_OSINDICATIONS) > > set. > > > > +A few values need to be defined in the board file for performing the > > +capsule update. These values are defined in the board file by > > +initialisation of a structure which provides information needed for > > +capsule updates. The following structures have been defined for > > +containing the image related information > > + > > +.. code-block:: c > > + > > + struct efi_fw_images { > > Why "images" (in the plural)? Hmm, since this is to be an array of firmware images which should be handled by the capsule update code, I used a plural form. Do you prefer efi_fw_image instead? > > > + efi_guid_t image_type_id; > > + u16 *fw_name; > > + u8 image_index; > > + }; > > Why not add "version" and "last_attempt_version" which is expected > to be easily implemented in this structure. It can be added to this structure, yes. But we will also need to add code in the capsule driver to update these fields accordingly. I can take this up as a follow up task once the FWU series upstreaming is done. > > > > + struct efi_capsule_update_info { > > + const char *dfu_string; > > + struct efi_fw_images *images; > > + }; > > + > > + > > +A string is defined which is to be used for populating the > > +dfu_alt_info variable. This string is used by the function > > +set_dfu_alt_info. Instead of taking the variable from the environment, > > +the capsule update feature requires that the variable be set through > > +the function, since that is more robust. Allowing the user to change > > +the location of the firmware updates is not a very secure > > +practice. Getting this information from the firmware itself is more > > +secure, assuming the firmware has been verified by a previous stage > > +boot loader. > > + > > +The firmware images structure defines the GUID values, image index > > +values and the name of the images that are to be updated through > > +the capsule update feature. These values are to be defined as part of > > +an array. These GUID values would be used by the Firmware Management > > +Protocol(FMP) to populate the image descriptor array and also > > +displayed as part of the ESRT table. The image index values defined in > > +the array should be one greater than the dfu alt number that > > +corresponds to the firmware image. So, if the dfu alt number for an > > +image is 2, the value of image index in the fw_images array for that > > +image should be 3. The dfu alt number can be obtained by running the > > +following command:: > > + > > + dfu list > > + > > +When using the FMP for FIT images, the image index value needs to be > > +set to 1. > > The explanation would be correct, but it's not quite easy to understand, > in particular, index in case of raw. > You should add some examples here. I have added an example above for the raw images, as to how the image index corresponds with the dfu alt number. Does it not suffice? -sughosh > > -Takahiro Akashi > > > + > > Finally, the capsule update can be initiated by rebooting the board. > > > > Enabling Capsule Authentication > > -- > > 2.25.1 > >