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 326FAC433EF for ; Wed, 13 Apr 2022 07:33:27 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 163E383B2D; Wed, 13 Apr 2022 09:33:25 +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="p835Fqng"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 4B1208394C; Wed, 13 Apr 2022 09:33:23 +0200 (CEST) Received: from mail-pg1-x52c.google.com (mail-pg1-x52c.google.com [IPv6:2607:f8b0:4864:20::52c]) (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 7CD1E83C01 for ; Wed, 13 Apr 2022 09:33:12 +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=takahiro.akashi@linaro.org Received: by mail-pg1-x52c.google.com with SMTP id k29so1012550pgm.12 for ; Wed, 13 Apr 2022 00:33:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:mail-followup-to:references :mime-version:content-disposition:in-reply-to; bh=UX7ntP+T7Ae7d4NsCwixzW3HyxZMnH76K+G4uOhZEZo=; b=p835Fqngp8Zk2HItmuc9PItLAo00YeO+aP0yMnXOif7agpe3HGEk0/3YEuJuRujgQ0 ECkmBKrYg0oheRWuxk9ZjQqUhn9FKxZrx5LOdC3z/87iNtkbv0+PfkiVI6UOaSjwHgsb m2bk/15/ztVPHUgN4Ri31PE3SpJchDYz7+/+A9sLFUdUtaMhlkxPGiqeys3DcYB5Oqxd D1U4C7A8kp6EwOAGSM74NQV9LFoxltB2m6DQUl/2pcey0zG0uoNhhoK34+ZrK6qbJSbD zFQF5XSDE4e9ebcXZOjhHZH/armbSPx/i+eEt9Um0DARf6H089/SHiSoYlfWvWyEykB0 oFbw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:from:to:cc:subject:message-id :mail-followup-to:references:mime-version:content-disposition :in-reply-to; bh=UX7ntP+T7Ae7d4NsCwixzW3HyxZMnH76K+G4uOhZEZo=; b=2Ij2mbwvZTGxeF8JUgWf4EB1Ylx9Jl2xAw3M5wk64Z04i1YoYD/VqUinyQdMgDmrJa cTOmzKVWo7zhKa2Fg/3GfEHoR09teEtYuEd4nNy8d2QRgtrAVHLbupAM9WNH/roYAg89 IFyFfJVDf5EUEja+5ZI6bjyqxgkcvKnDGuXm8fTNYVwHX6XaPUoJsmWWpuT9qH6QyaJ4 u017/GkShroCprtqv28AsqKfvqyogCfcRjCW+l0dww+1cjUV2Sf3AjdgnGu7V1NAMFMl 7hpbouij6PStxz4yEeEAbVFhKdrojQh10CLzSQKpA99IcEHuFB4ltNBMzPD+NrPgAaur JOEA== X-Gm-Message-State: AOAM530wdvgvcgZEP36G54tTdJcD/EuotW8HZDMphq5kpMduxNHgVojR l9Ap05wOYPT/MK40U5/eeVfMDQ== X-Google-Smtp-Source: ABdhPJzLk058yTa58VJoAHhgli4XGEa9h26tQ7VZbncq/t/cOGTOwve5I4indrTEpnGO3tOjw5p1Fw== X-Received: by 2002:a63:d842:0:b0:398:f14c:f86b with SMTP id k2-20020a63d842000000b00398f14cf86bmr34100489pgj.216.1649835189796; Wed, 13 Apr 2022 00:33:09 -0700 (PDT) Received: from laputa ([2400:4050:c3e1:100:18ba:fbb1:88b:4642]) by smtp.gmail.com with ESMTPSA id k8-20020aa790c8000000b00505d6016097sm7672640pfk.94.2022.04.13.00.33.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Apr 2022 00:33:09 -0700 (PDT) Date: Wed, 13 Apr 2022 16:33:03 +0900 From: AKASHI Takahiro To: Sughosh Ganu Cc: 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 Subject: Re: [PATCH v6 8/8] doc: uefi: Update the capsule update related documentation Message-ID: <20220413073303.GF87648@laputa> Mail-Followup-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 References: <20220412130447.300574-1-sughosh.ganu@linaro.org> <20220412130447.300574-9-sughosh.ganu@linaro.org> <20220413061833.GB87648@laputa> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: 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, Apr 13, 2022 at 12:38:05PM +0530, Sughosh Ganu wrote: > 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? This structure (not a variable like struct efi_fw_image foo_images[]) can only hold/represent one firmware image, right? If so, efi_fw_image looks better. > > > > > + 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? I hope that it will cover not only index, but example arrays of struct efi_fw_image and struct efi_capsule_update_info as well as an example "dfu_alto_info". -Takahiro Akashi > -sughosh > > > > > -Takahiro Akashi > > > > > + > > > Finally, the capsule update can be initiated by rebooting the board. > > > > > > Enabling Capsule Authentication > > > -- > > > 2.25.1 > > >