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 3FD75C61DA4 for ; Thu, 23 Feb 2023 08:36:09 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id CEFAF85A7F; Thu, 23 Feb 2023 09:36:06 +0100 (CET) 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="unoqrH1U"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 720EF85ADF; Thu, 23 Feb 2023 09:36:05 +0100 (CET) Received: from mail-ed1-x52f.google.com (mail-ed1-x52f.google.com [IPv6:2a00:1450:4864:20::52f]) (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 9A45D859F8 for ; Thu, 23 Feb 2023 09:36:01 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=ilias.apalodimas@linaro.org Received: by mail-ed1-x52f.google.com with SMTP id ec43so38916712edb.8 for ; Thu, 23 Feb 2023 00:36:01 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=xUrGJWBH/WBnbV/bR+Hit+qLTXpHGlFGeP4gGMckrKE=; b=unoqrH1UtBhZ0QcJk9c3VYKAufr5YsHfTEeqwbh9nl5aGT7K+78vyRFEb/4v0PuOls bAm94lCHis5TdGNAkVuvsewr2LEPmHhW8pta3vapV+DFmlB7qj3O3teoGm9qe0g14Qhx ZZI4/gMbHWqs96sHRPE4+TGInLMY+aJnJgknvvBRbq3BpEMdJhlDv4u67++TasMdP492 FwLp4+Pec9MQnZfKMLfvdjwPycOANKj10333KXzRrLdVKM1JKgi2Dbj3X8PmbIr/PT8n 25mClb2LMZ00WZVXiJfGst4B4/j15Hmd9/D5K3bGfrlUca88lremN1PSABE0gp+W5vkJ WRTg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=xUrGJWBH/WBnbV/bR+Hit+qLTXpHGlFGeP4gGMckrKE=; b=Lyl7JZgX7nbGJxSP0QMtBEkIIM8zE3HEtQMC4AKM6bzxzf5xxh4OmjEWqYPvnpxEfB 0+dU5/xBDMBf7Xr4iHuLSjGzjfKK7hY/MNOT0+4Pm0MS2whmij9F+6EOhhtZkmZisdPV x06LpEcO4GMnpX3lRW7vrhS3RcLXKFV3F85xEJD0b7GnIfWOwP2ftad69QY8yNj7GrwT uBHSlrDQ5iMPrPYiG5u3cRZ3hwLs9WewUK/GQfKCAZNrJIvZctp/jvGlzIsbCuBH698L IbjAFvAWfHhQgi1nokGt31iZ3EsY4EER9ZjIXkBc0V1E3058RNrh5XGFuvJ9PKhbRZIZ sqOA== X-Gm-Message-State: AO0yUKWJCUwrtCioO13zmsvlD183ETSH8p4FWifJUDSjT4z+dbSBbYy7 XD3cQjo9z47IyGOD+yF6mUIvJw== X-Google-Smtp-Source: AK7set+AMy0MATs/ntha10Q4R8qa1k74AbyQLy9IPi+6Sf3HO6jVan1k2WflAE8dVSuIRJ8VScCRNA== X-Received: by 2002:aa7:d688:0:b0:4a2:4a89:2331 with SMTP id d8-20020aa7d688000000b004a24a892331mr10256417edr.29.1677141361130; Thu, 23 Feb 2023 00:36:01 -0800 (PST) Received: from hera (ppp176092130041.access.hol.gr. [176.92.130.41]) by smtp.gmail.com with ESMTPSA id j19-20020a508a93000000b004a21c9facd5sm5746903edj.67.2023.02.23.00.35.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 23 Feb 2023 00:36:00 -0800 (PST) Date: Thu, 23 Feb 2023 10:35:58 +0200 From: Ilias Apalodimas To: jassisinghbrar@gmail.com Cc: u-boot@lists.denx.de, etienne.carriere@linaro.org, trini@konsulko.com, sjg@chromium.org, sughosh.ganu@linaro.org, xypron.glpk@gmx.de, patrick.delaunay@foss.st.com, patrice.chotard@foss.st.com, Jassi Brar Subject: Re: [PATCHv4 2/5] fwu: move meta-data management in core Message-ID: References: <20230205030056.61345-1-jassisinghbrar@gmail.com> <20230205030146.61432-1-jassisinghbrar@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20230205030146.61432-1-jassisinghbrar@gmail.com> 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 Hi Jassi, Apologies for the delay On Sat, Feb 04, 2023 at 09:01:46PM -0600, jassisinghbrar@gmail.com wrote: > From: Jassi Brar > > Instead of each i/f having to implement their own meta-data verification > and storage, move the logic in common code. This simplifies the i/f code > much simpler and compact. > > Signed-off-by: Jassi Brar > --- > drivers/fwu-mdata/fwu-mdata-uclass.c | 34 +++++++ > include/fwu.h | 41 ++++++++ > lib/fwu_updates/fwu.c | 135 ++++++++++++++++++++++++++- > 3 files changed, 206 insertions(+), 4 deletions(-) > > diff --git a/drivers/fwu-mdata/fwu-mdata-uclass.c b/drivers/fwu-mdata/fwu-mdata-uclass.c > index b477e9603f..e03773c584 100644 > --- a/drivers/fwu-mdata/fwu-mdata-uclass.c > +++ b/drivers/fwu-mdata/fwu-mdata-uclass.c > @@ -16,6 +16,40 @@ > #include > #include > > +/** > + * fwu_read_mdata() - Wrapper around fwu_mdata_ops.read_mdata() > + * > + * Return: 0 if OK, -ve on error > + */ > +int fwu_read_mdata(struct udevice *dev, struct fwu_mdata *mdata, bool primary) > +{ > + const struct fwu_mdata_ops *ops = device_get_ops(dev); > + > + if (!ops->read_mdata) { > + log_debug("read_mdata() method not defined\n"); > + return -ENOSYS; > + } > + > + return ops->read_mdata(dev, mdata, primary); > +} > + > +/** > + * fwu_write_mdata() - Wrapper around fwu_mdata_ops.write_mdata() > + * > + * Return: 0 if OK, -ve on error > + */ > +int fwu_write_mdata(struct udevice *dev, struct fwu_mdata *mdata, bool primary) > +{ > + const struct fwu_mdata_ops *ops = device_get_ops(dev); > + > + if (!ops->write_mdata) { > + log_debug("write_mdata() method not defined\n"); > + return -ENOSYS; > + } > + > + return ops->write_mdata(dev, mdata, primary); > +} > + > /** > * fwu_get_mdata_part_num() - Get the FWU metadata partition numbers > * @dev: FWU metadata device > diff --git a/include/fwu.h b/include/fwu.h > index 0919ced812..1a700c9e6a 100644 > --- a/include/fwu.h > +++ b/include/fwu.h > @@ -24,6 +24,26 @@ struct fwu_mdata_gpt_blk_priv { > * @update_mdata() - Update the FWU metadata copy > */ > struct fwu_mdata_ops { > + /** > + * read_mdata() - Populate the asked FWU metadata copy > + * @dev: FWU metadata device > + * @mdata: Copy of the FWU metadata > + * @primary: If primary or secondary copy of meta-data is to be read > + * > + * Return: 0 if OK, -ve on error > + */ > + int (*read_mdata)(struct udevice *dev, struct fwu_mdata *mdata, bool primary); > + > + /** > + * write_mdata() - Write the given FWU metadata copy > + * @dev: FWU metadata device > + * @mdata: Copy of the FWU metadata > + * @primary: If primary or secondary copy of meta-data is to be written > + * > + * Return: 0 if OK, -ve on error > + */ > + int (*write_mdata)(struct udevice *dev, struct fwu_mdata *mdata, bool primary); > + > /** > * check_mdata() - Check if the FWU metadata is valid > * @dev: FWU device > @@ -126,6 +146,27 @@ struct fwu_mdata_ops { > EFI_GUID(0x0c996046, 0xbcc0, 0x4d04, 0x85, 0xec, \ > 0xe1, 0xfc, 0xed, 0xf1, 0xc6, 0xf8) > > +/** > + * fwu_read_mdata() - Wrapper around fwu_mdata_ops.read_mdata() > + */ > +int fwu_read_mdata(struct udevice *dev, struct fwu_mdata *mdata, bool primary); > + > +/** > + * fwu_write_mdata() - Wrapper around fwu_mdata_ops.write_mdata() > + */ > +int fwu_write_mdata(struct udevice *dev, struct fwu_mdata *mdata, bool primary); > + > +/** > + * fwu_get_verified_mdata() - Read, verify and return the FWU metadata > + * > + * Read both the metadata copies from the storage media, verify their checksum, > + * and ascertain that both copies match. If one of the copies has gone bad, > + * restore it from the good copy. > + * > + * Return: 0 if OK, -ve on error > +*/ > +int fwu_get_verified_mdata(struct fwu_mdata *mdata); > + > /** > * fwu_check_mdata_validity() - Check for validity of the FWU metadata copies > * > diff --git a/lib/fwu_updates/fwu.c b/lib/fwu_updates/fwu.c > index 5313d07302..56299f1b2f 100644 > --- a/lib/fwu_updates/fwu.c > +++ b/lib/fwu_updates/fwu.c > @@ -15,13 +15,13 @@ > #include > #include > > +#include > + > +static struct fwu_mdata g_mdata; /* = {0} makes uninit crc32 always invalid */ > +static struct udevice *g_dev; > static u8 in_trial; > static u8 boottime_check; > > -#include > -#include > -#include > - > enum { > IMAGE_ACCEPT_SET = 1, > IMAGE_ACCEPT_CLEAR, > @@ -161,6 +161,133 @@ static int fwu_get_image_type_id(u8 *image_index, efi_guid_t *image_type_id) > return -ENOENT; > } > > +/** > + * fwu_sync_mdata() - Update given meta-data partition(s) with the copy provided > + * @mdata: FWU metadata structure > + * @part: Bitmask of FWU metadata partitions to be written to > + * > + * Return: 0 if OK, -ve on error > + */ > +static int fwu_sync_mdata(struct fwu_mdata *mdata, int part) > +{ > + void *buf = &mdata->version; > + int err = 0; > + > + /* > + * Calculate the crc32 for the updated FWU metadata > + * and put the updated value in the FWU metadata crc32 > + * field > + */ > + mdata->crc32 = crc32(0, buf, sizeof(*mdata) - sizeof(u32)); > + > + err = fwu_write_mdata(g_dev, mdata, part & PRIMARY_PART ? true : false); > + if (err) { > + log_err("Unable to write %s mdata\n", > + part & PRIMARY_PART ? "primary": "secondary"); > + return err; > + } > + > + /* update the cached copy of meta-data */ > + memcpy(&g_mdata, mdata, sizeof(struct fwu_mdata)); > + > + return 0; > +} > + > +static inline int mdata_crc_check(struct fwu_mdata *mdata) > +{ > + void *buf = &mdata->version; > + u32 calc_crc32 = crc32(0, buf, sizeof(*mdata) - sizeof(u32)); > + > + return calc_crc32 == mdata->crc32 ? 0 : -EINVAL; > +} > + > +/** > + * fwu_get_verified_mdata() - Read, verify and return the FWU metadata > + * > + * Read both the metadata copies from the storage media, verify their checksum, > + * and ascertain that both copies match. If one of the copies has gone bad, > + * restore it from the good copy. > + * > + * Return: 0 if OK, -ve on error > + */ > +int fwu_get_verified_mdata(struct fwu_mdata *mdata) > +{ > + int err; > + bool pri_ok, sec_ok; > + struct fwu_mdata s, *p_mdata, *s_mdata; > + > + p_mdata = &g_mdata; > + s_mdata = &s; > + > + /* if mdata already read and ready */ > + err = mdata_crc_check(p_mdata); > + if (!err) > + goto ret_mdata; > + /* else read, verify and, if needed, fix mdata */ > + > + pri_ok = false; > + err = fwu_read_mdata(g_dev, p_mdata, true); > + if (!err) { > + err = mdata_crc_check(p_mdata); > + if (!err) > + pri_ok = true; > + else > + log_debug("primary mdata: crc32 failed\n"); > + } > + > + sec_ok = false; > + err = fwu_read_mdata(g_dev, s_mdata, false); > + if (!err) { > + err = mdata_crc_check(s_mdata); > + if (!err) > + sec_ok = true; > + else > + log_debug("secondary mdata: crc32 failed\n"); > + } Isn't it better to define pri_ok, sec_ok and their equivalent mdata as arrays ? IOW something along the lines of bool parts_ok[2] = { false }; struct fwu_mdata parts_mdata[2]; parts_mdata[0] = &g_mdata; parts_mdata[1] = ..... for (i = 0; i < 2; i++) { err = fwu_read_mdata(g_dev, parts_mdata[i], !(i % 2) ? true : false); if (!err) err = mdata_crc_check(parts_mdata[i]); etc.... } > + > + if (pri_ok && sec_ok) { And then also adjust this part? > + /* > + * Before returning, check that both the > + * FWU metadata copies are the same. > + */ > + err = memcmp(p_mdata, s_mdata, sizeof(struct fwu_mdata)); > + if (!err) > + goto ret_mdata; > + > + /* > + * If not, populate the secondary partition from the > + * primary partition copy. > + */ > + log_info("Both FWU metadata copies are valid but do not match."); > + log_info(" Restoring the secondary partition from the primary\n"); > + sec_ok = false; > + } > + > + if (!pri_ok) { > + memcpy(p_mdata, s_mdata, sizeof(struct fwu_mdata)); > + err = fwu_sync_mdata(p_mdata, PRIMARY_PART); > + if (err) { > + log_debug("mdata : primary write failed\n"); > + return err; > + } > + } > + > + if (!sec_ok) { > + memcpy(s_mdata, p_mdata, sizeof(struct fwu_mdata)); > + err = fwu_sync_mdata(s_mdata, SECONDARY_PART); > + if (err) { > + log_debug("mdata : secondary write failed\n"); > + return err; > + } > + } And this could also be folded into a for loop > + > +ret_mdata: > + if (!err && mdata) > + memcpy(mdata, p_mdata, sizeof(struct fwu_mdata)); > + > + return err; > +} > + > /** > * fwu_verify_mdata() - Verify the FWU metadata > * @mdata: FWU metadata structure > -- > 2.34.1 > Thanks /Ilias