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 160A1ECAAA1 for ; Tue, 6 Sep 2022 06:59:36 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id C713D84A86; Tue, 6 Sep 2022 08:59:10 +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="HzQHxX8R"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 2C34584A5C; Tue, 6 Sep 2022 08:59:07 +0200 (CEST) Received: from mail-oa1-x2b.google.com (mail-oa1-x2b.google.com [IPv6:2001:4860:4864:20::2b]) (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 38F7D84A5C for ; Tue, 6 Sep 2022 08:59:03 +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=etienne.carriere@linaro.org Received: by mail-oa1-x2b.google.com with SMTP id 586e51a60fabf-11ee4649dfcso26134643fac.1 for ; Mon, 05 Sep 2022 23:59:03 -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=rF/dCQrKhxso9YJ2NUwbc3x7Y3aSQ8Mn2TLwYnfQwvo=; b=HzQHxX8R4nCrT0uVmu6bGNMn1tbkmAWxCV0y1e7IH5p9O3EexwaMEsYKO3ivWzumg8 gY+3iu++8sVKFHsJ24n5978XrRqGcvM811MSrWs5TyGG58QT9IOCjljC6H/dN6mqL4tG IvrjxqfLgO0wpuCwuaohzk6qGsuxyku/V291YbQrB8HLgD3mMzei2vefIvUf5R0zLt3m cYI13M0y2lKn3BP22hDOLdmMAH9vxL8pAQqX+dJNl2M3BREP/e6ItfgQhWT2ximZsbV9 QiX+nhpzbY0TPkjtPj4A4d4sek4N2zqIUsKHQr/lVOu3ML0ha5o5vzK+dnV8yNXhefUs McxQ== 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=rF/dCQrKhxso9YJ2NUwbc3x7Y3aSQ8Mn2TLwYnfQwvo=; b=ngKzYZNsmfWO7Z4ewJvUZruoFn7P0xy+glGZsKJu3cncO4FfoN3DT0NGvOnBPkeWtZ MQb+6HuvWOBGwq24j6p79U34ohMkPGoTr0KamZIqfyGW1YyRppc5WEznW1fNK2M2f4w4 VsABmNPyZxIJgsVDFgSLLFBu5+vMmhl8cjwkEuBszF7xv01Uop3jROwFnV3BZb/Jx5+6 r0ZvJFyCVZWxvgGWgIP6gzDdMCrvtRx6EyGt/WlIRNku2wPsHMaUN6jYf5jrE7xgii2O Ga7n3VhoKSCWrV3wQBOcphYD2gN9WTpLhrhUzOgFF0p4DeT9NkqzXnBjv7yyQAOHyVP+ b4tA== X-Gm-Message-State: ACgBeo27yqXxbzcnCCIHgj9X8YXt8DlXGWMpkOU5xFYnvanKY/jdJzfr LkKa16yC3FPnXGhT/YQXNY0Hm+w2v1WVN2hNXaJ2/w== X-Google-Smtp-Source: AA6agR6h1PZOoL1GUdwPHGAyDKkyJh/GOJoXTZTmcR086ELIYrG0B3DxKEeW3UaPc23SbrIQIHN9OEtzobgevBlja3A= X-Received: by 2002:a05:6871:725:b0:127:96e8:21c with SMTP id f37-20020a056871072500b0012796e8021cmr2739726oap.104.1662447541551; Mon, 05 Sep 2022 23:59:01 -0700 (PDT) MIME-Version: 1.0 References: <20220826095716.1676150-1-sughosh.ganu@linaro.org> <20220826095716.1676150-10-sughosh.ganu@linaro.org> In-Reply-To: <20220826095716.1676150-10-sughosh.ganu@linaro.org> From: Etienne Carriere Date: Tue, 6 Sep 2022 08:58:50 +0200 Message-ID: Subject: Re: [PATCH v9 09/15] FWU: Add boot time checks as highlighted by the FWU specification 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 , Michal Simek , Jassi Brar 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 Fri, 26 Aug 2022 at 11:58, Sughosh Ganu wrote: > > The FWU Multi Bank Update specification requires the Update Agent to > carry out certain checks at the time of platform boot. The Update > Agent is the component which is responsible for updating the firmware > components and maintaining and keeping the metadata in sync. > > The spec requires that the Update Agent perform the following checks > at the time of boot > * Sanity check of both the metadata copies maintained by the platform. > * Get the boot index passed to U-Boot by the prior stage bootloader > and use this value for metadata bookkeeping. > * Check if the system is booting in Trial State. If the system boots > in the Trial State for more than a specified number of boot counts, > change the Active Bank to be booting the platform from. > > Call these checks through the main loop event at the time of platform > boot. > > Signed-off-by: Sughosh Ganu > --- > Changes since V8: > * Call fwu_boottime_checks through the event interface > * Add comments for API functions > > include/fwu.h | 13 +++ > lib/efi_loader/efi_setup.c | 1 + > lib/fwu_updates/fwu.c | 189 ++++++++++++++++++++++++++++++++++++- > 3 files changed, 202 insertions(+), 1 deletion(-) > > diff --git a/include/fwu.h b/include/fwu.h > index b8c207deaf..31c9923ff5 100644 > --- a/include/fwu.h > +++ b/include/fwu.h > @@ -252,4 +252,17 @@ int fwu_plat_get_update_index(uint *update_idx); > * > */ > void fwu_plat_get_bootidx(void *boot_idx); > + > +/** > + * fwu_update_checks_pass() - Check if FWU update can be done > + * > + * Check if the FWU update can be executed. The updates are > + * allowed only when the platform is not in Trial State and > + * the boot time checks have passed > + * > + * Return: 1 if OK, 0 on error > + * > + */ > +u8 fwu_update_checks_pass(void); > + > #endif /* _FWU_H_ */ > diff --git a/lib/efi_loader/efi_setup.c b/lib/efi_loader/efi_setup.c > index 751beda590..23dc7a0710 100644 > --- a/lib/efi_loader/efi_setup.c > +++ b/lib/efi_loader/efi_setup.c > @@ -199,6 +199,7 @@ static efi_status_t __efi_init_early(void) > goto out; > > ret = efi_disk_init(); > + > out: > return ret; > } > diff --git a/lib/fwu_updates/fwu.c b/lib/fwu_updates/fwu.c > index 94b15859a5..27f48855af 100644 > --- a/lib/fwu_updates/fwu.c > +++ b/lib/fwu_updates/fwu.c > @@ -4,10 +4,19 @@ > */ > > #include > +#include > #include > +#include > +#include > #include > #include > -#include > +#include > + > +#include > +#include > + > +static u8 trial_state; > +static u8 boottime_check; > > #include > #include > @@ -16,6 +25,112 @@ > #define IMAGE_ACCEPT_SET BIT(0) > #define IMAGE_ACCEPT_CLEAR BIT(1) > > +static int trial_counter_update(u16 *trial_state_ctr) > +{ > + bool delete; > + u32 var_attr; > + efi_status_t status; > + efi_uintn_t var_size; > + > + delete = !trial_state_ctr ? true : false; > + var_size = !trial_state_ctr ? 0 : (efi_uintn_t)sizeof(*trial_state_ctr); > + var_attr = !trial_state_ctr ? 0 : EFI_VARIABLE_NON_VOLATILE | > + EFI_VARIABLE_BOOTSERVICE_ACCESS; > + status = efi_set_variable_int(u"TrialStateCtr", > + &efi_global_variable_guid, > + var_attr, > + var_size, trial_state_ctr, false); > + > + if ((delete && (status != EFI_NOT_FOUND && > + status != EFI_SUCCESS)) || > + (!delete && status != EFI_SUCCESS)) > + return -1; > + > + return 0; > +} > + > +static int in_trial_state(struct fwu_mdata *mdata) > +{ > + u32 i, active_bank; > + struct fwu_image_entry *img_entry; > + struct fwu_image_bank_info *img_bank_info; > + > + active_bank = mdata->active_index; > + img_entry = &mdata->img_entry[0]; > + for (i = 0; i < CONFIG_FWU_NUM_IMAGES_PER_BANK; i++) { > + img_bank_info = &img_entry[i].img_bank_info[active_bank]; > + if (!img_bank_info->accepted) { > + return 1; > + } > + } > + > + return 0; > +} > + > +static int fwu_trial_state_check(struct udevice *dev) > +{ > + int ret; > + efi_status_t status; > + efi_uintn_t var_size; > + u16 trial_state_ctr; > + u32 var_attributes, active_idx; > + struct fwu_mdata mdata = { 0 }; > + > + ret = fwu_get_mdata(dev, &mdata); > + if (ret) > + return ret; > + > + if ((trial_state = in_trial_state(&mdata))) { > + var_size = (efi_uintn_t)sizeof(trial_state_ctr); > + log_info("System booting in Trial State\n"); > + var_attributes = EFI_VARIABLE_NON_VOLATILE | > + EFI_VARIABLE_BOOTSERVICE_ACCESS; > + status = efi_get_variable_int(u"TrialStateCtr", > + &efi_global_variable_guid, > + &var_attributes, > + &var_size, &trial_state_ctr, > + NULL); > + if (status != EFI_SUCCESS) { > + log_err("Unable to read TrialStateCtr variable\n"); > + ret = -1; > + goto out; > + } > + > + ++trial_state_ctr; > + if (trial_state_ctr > CONFIG_FWU_TRIAL_STATE_CNT) { > + log_info("Trial State count exceeded. Revert back to previous_active_index\n"); > + active_idx = mdata.active_index; > + ret = fwu_revert_boot_index(); > + if (ret) { > + log_err("Unable to revert active_index\n"); > + goto out; > + } > + > + /* Delete the TrialStateCtr variable */ > + ret = trial_counter_update(NULL); > + if (ret) { > + log_err("Unable to delete TrialStateCtr variable\n"); > + goto out; > + } > + } else { > + ret = trial_counter_update(&trial_state_ctr); > + if (ret) { > + log_err("Unable to increment TrialStateCtr variable\n"); > + goto out; > + } > + } > + } else { > + /* Delete the variable */ > + ret = trial_counter_update(NULL); > + if (ret) { > + log_err("Unable to delete TrialStateCtr variable\n"); > + } > + } > + > +out: > + return ret; > +} > + > static int fwu_get_dev(struct udevice **dev) > > { > @@ -382,3 +497,75 @@ __weak int fwu_plat_get_update_index(uint *update_idx) > > return ret; > } > + > +/** > + * fwu_update_checks_pass() - Check if FWU update can be done > + * > + * Check if the FWU update can be executed. The updates are > + * allowed only when the platform is not in Trial State and > + * the boot time checks have passed > + * > + * Return: 1 if OK, 0 on error > + * > + */ > +u8 fwu_update_checks_pass(void) > +{ > + return !trial_state && boottime_check; > +} > + > +static int fwu_boottime_checks(void *ctx, struct event *event) > +{ > + int ret; > + struct udevice *dev; > + u32 boot_idx, active_idx; > + > + ret = fwu_get_dev(&dev); > + if (ret) > + return ret; > + > + ret = fwu_mdata_check(dev); > + if (ret) { > + return 0; > + } > + > + /* > + * Get the Boot Index, i.e. the bank from > + * which the platform has booted. This value > + * gets passed from the ealier stage bootloader > + * which booted u-boot, e.g. tf-a. If the > + * boot index is not the same as the > + * active_index read from the FWU metadata, > + * update the active_index. > + */ > + fwu_plat_get_bootidx(&boot_idx); > + if (boot_idx >= CONFIG_FWU_NUM_BANKS) { > + log_err("Received incorrect value of boot_index\n"); > + return 0; > + } > + > + ret = fwu_get_active_index(&active_idx); > + if (ret) { > + log_err("Unable to read active_index\n"); > + return 0; > + } > + > + if (boot_idx != active_idx) { > + log_info("Boot idx %u is not matching active idx %u, changing active_idx\n", > + boot_idx, active_idx); > + ret = fwu_update_active_index(boot_idx); > + if (!ret) > + boottime_check = 1; > + > + return 0; > + } > + > + if (efi_init_obj_list() != EFI_SUCCESS) > + return 0; > + > + ret = fwu_trial_state_check(dev); > + if (!ret) > + boottime_check = 1; > + > + return 0; > +} > +EVENT_SPY(EVT_MAIN_LOOP, fwu_boottime_checks); > -- > 2.34.1 >