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 80514C433EF for ; Wed, 13 Apr 2022 06:18:48 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 8FD1580086; Wed, 13 Apr 2022 08:18:46 +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="ioUxacqr"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 0A39480544; Wed, 13 Apr 2022 08:18:45 +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 3BA4980085 for ; Wed, 13 Apr 2022 08:18:42 +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-pj1-x1034.google.com with SMTP id z6-20020a17090a398600b001cb9fca3210so1105586pjb.1 for ; Tue, 12 Apr 2022 23:18:42 -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=Njy7OepEuBc1MCDbZ0d1f8/ql1KAbfPjKvc8zLKDNn4=; b=ioUxacqrKPYNlZva3ZE8daG+TK81rlGkOZDbhN3IG6H1H805/4SSKRFSUOH+AqQphb jQ/vJTvCzxXAeSj1O5OkFHRKoEcV+Z0Nuv9l+sroM6mHgLFpaKZoJPUfjskSQdI5tJUB enb5mnU+7lpnpLRnbIZTrPJaYVPQ6v+BHRJCvFNqxRGvwEmS8od+bikia9P7NZr+mhv/ bkRgOqlf7ziztGWq+cVgVVLaX466XnEWAW3BDa3WVcCbeie2choX5CzAFW8kOEArMbzU IEVJx0AjkcE8ZtH67ufariXbo5PK7M7f5zJsyVbC5arJr5MswIt4nqrw6wtIWq7v1ntm Z/QQ== 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=Njy7OepEuBc1MCDbZ0d1f8/ql1KAbfPjKvc8zLKDNn4=; b=5vwLmHcRYuVcIPS42pth0+8KIlNsMyR/JVs+t9nHqU+s5eRzx+8W/bHjUcCZBakDGs hMljlX0j+Lyfyt4v9U6EEfHC7PUyiFVW2tc3ZrJ1+B4hVSTTW2aBdTe4ErCnpDOGc8xG 6hMMZrwVWQek3oVgJSam0FmToX3qa96+F9TrRRgCDnotQCXQJJB+8cMj9jH8fVbmUtq1 E1J2edvDsfn54nS1Xyfv6JMGDyd0OOvIprxMX4ZfwegUu7/YCm9zIeyWoMBnj1h8x98a LPoum3lrd1cfktnq0sTHif2JAjKPOxHxembgf0Q3UEZOTED3b2M+XHgRIsY0aNwoReEa jByg== X-Gm-Message-State: AOAM530CWaYiK/Uq0pMAEwFmYOg4IE1qC2/5FO+xim5xx/nEbpD0JgLR hpTD+JX6TjZ1pxAnVawOsnifZQ== X-Google-Smtp-Source: ABdhPJyJL/rvb7M9RyA8lOYIM1cEqdHifj6MBsKJXohqs5Ykg3/IWA+iVuRaCI4gzDtm6+RIABH16g== X-Received: by 2002:a17:90b:124c:b0:1bc:369b:7db5 with SMTP id gx12-20020a17090b124c00b001bc369b7db5mr8962403pjb.179.1649830719629; Tue, 12 Apr 2022 23:18:39 -0700 (PDT) Received: from laputa ([2400:4050:c3e1:100:18ba:fbb1:88b:4642]) by smtp.gmail.com with ESMTPSA id s1-20020a62e701000000b00505d4799e40sm7369102pfh.67.2022.04.12.23.18.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 12 Apr 2022 23:18:39 -0700 (PDT) Date: Wed, 13 Apr 2022 15:18:33 +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: <20220413061833.GB87648@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> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220412130447.300574-9-sughosh.ganu@linaro.org> 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 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)? > + 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. > + 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. -Takahiro Akashi > + > Finally, the capsule update can be initiated by rebooting the board. > > Enabling Capsule Authentication > -- > 2.25.1 >