Hi Sughosh

On Thu, Oct 06, 2022 at 02:36:16PM +0530, Sughosh Ganu wrote:

In the FWU Multi Bank Update feature, the information about the updatable images is stored as part of the metadata, which is stored on a dedicated partition. Add the metadata structure, and a driver model uclass which provides functions to access the metadata. These are generic API's, and implementations can be added based on parameters like how the metadata partition is accessed and what type of storage device houses the metadata.

Signed-off-by: Sughosh Ganu sughosh.ganu@linaro.org Reviewed-by: Patrick Delaunay patrick.delaunay@foss.st.com Reviewed-by: Etienne Carriere etienne.carriere@linaro.org

---

Changes since V12: None

drivers/fwu-mdata/fwu-mdata-uclass.c | 107 ++++++++ include/dm/uclass-id.h | 1 + include/fwu.h | 211 ++++++++++++++++ include/fwu_mdata.h | 67 +++++ lib/fwu_updates/fwu.c | 364 +++++++++++++++++++++++++++ 5 files changed, 750 insertions(+) create mode 100644 drivers/fwu-mdata/fwu-mdata-uclass.c create mode 100644 include/fwu.h create mode 100644 include/fwu_mdata.h create mode 100644 lib/fwu_updates/fwu.c

diff --git a/drivers/fwu-mdata/fwu-mdata-uclass.c b/drivers/fwu-mdata/fwu-mdata-uclass.c new file mode 100644 index 0000000000..4237b89520 --- /dev/null +++ b/drivers/fwu-mdata/fwu-mdata-uclass.c @@ -0,0 +1,107 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/*

• • Copyright (c) 2022, Linaro Limited
• */

+#define LOG_CATEGORY UCLASS_FWU_MDATA

+#include <common.h> +#include <dm.h> +#include <efi_loader.h> +#include <fwu.h> +#include <fwu_mdata.h> +#include <log.h>

+#include <linux/errno.h> +#include <linux/types.h> +#include <u-boot/crc.h>

+/**

• • fwu_mdata_check() - Check if the FWU metadata is valid
• • @dev: FWU metadata device
• • Validate both copies of the FWU metadata. If one of the copies
• • has gone bad, restore it from the other copy.
• • Return: 0 if OK, -ve on error
• */

+int fwu_mdata_check(struct udevice *dev) +{

• const struct fwu_mdata_ops *ops = device_get_ops(dev);
• if (!ops->check_mdata) {

• log_debug("check_mdata() method not defined\n");
  

• return -ENOSYS;
  

• }
• return ops->check_mdata(dev);

+}

+/**

• • fwu_get_mdata() - Get a FWU metadata copy
• • @dev: FWU metadata device
• • @mdata: Copy of the FWU metadata
• • Get a valid copy of the FWU metadata.
• • Note: This function is to be called first when modifying any fields
• • in the metadata. The sequence of calls to modify any field in the
• • metadata would be 1) fwu_get_mdata 2) Modify metadata, followed by
• • 3. fwu_update_mdata
• • Return: 0 if OK, -ve on error
• */

+int fwu_get_mdata(struct udevice *dev, struct fwu_mdata *mdata) +{

• const struct fwu_mdata_ops *ops = device_get_ops(dev);
• if (!ops->get_mdata) {

• log_debug("get_mdata() method not defined\n");
  

• return -ENOSYS;
  

• }
• return ops->get_mdata(dev, mdata);

+}

+/**

• • fwu_update_mdata() - Update the FWU metadata
• • @dev: FWU metadata device
• • @mdata: Copy of the FWU metadata
• • Update the FWU metadata structure by writing to the
• • FWU metadata partitions.
• • Note: This function is not to be called directly to update the
• • metadata fields. The sequence of function calls should be
• • 1. fwu_get_mdata() 2) Modify the medata fields 3) fwu_update_mdata()
• • Return: 0 if OK, -ve on error
• */

+int fwu_update_mdata(struct udevice *dev, struct fwu_mdata *mdata) +{

• void *buf;
• const struct fwu_mdata_ops *ops = device_get_ops(dev);
• if (!ops->update_mdata) {

• log_debug("get_mdata() method not defined\n");
  

• return -ENOSYS;
  

• }
• /*

• * Calculate the crc32 for the updated FWU metadata
  

• * and put the updated value in the FWU metadata crc32
  

• * field
  

• */
  

• buf = &mdata->version;
• mdata->crc32 = crc32(0, buf, sizeof(*mdata) - sizeof(u32));
• return ops->update_mdata(dev, mdata);

+}

+UCLASS_DRIVER(fwu_mdata) = {

• .id = UCLASS_FWU_MDATA,
• .name = "fwu-mdata",

+}; diff --git a/include/dm/uclass-id.h b/include/dm/uclass-id.h index a432e43871..598a8c10a0 100644 --- a/include/dm/uclass-id.h +++ b/include/dm/uclass-id.h @@ -58,6 +58,7 @@ enum uclass_id { UCLASS_FIRMWARE, /* Firmware */ UCLASS_FUZZING_ENGINE, /* Fuzzing engine */ UCLASS_FS_FIRMWARE_LOADER, /* Generic loader */

• UCLASS_FWU_MDATA, /* FWU Metadata Access */ UCLASS_GPIO, /* Bank of general-purpose I/O pins */ UCLASS_HASH, /* Hash device */ UCLASS_HWSPINLOCK, /* Hardware semaphores */

diff --git a/include/fwu.h b/include/fwu.h new file mode 100644 index 0000000000..a4d2d35d9a --- /dev/null +++ b/include/fwu.h @@ -0,0 +1,211 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/*

• • Copyright (c) 2022, Linaro Limited
• */

+#if !defined _FWU_H_ +#define _FWU_H_

+#include <blk.h> +#include <efi.h>

+#include <linux/types.h>

+struct fwu_mdata; +struct udevice;

+/**

• • @mdata_check: check the validity of the FWU metadata partitions
• • @get_mdata() - Get a FWU metadata copy
• • @update_mdata() - Update the FWU metadata copy
• */

+struct fwu_mdata_ops {

• /**

• * check_mdata() - Check if the FWU metadata is valid
  

• * @dev:	FWU device
  

• *
  

• * Validate both copies of the FWU metadata. If one of the copies
  

• * has gone bad, restore it from the other copy.
  

• *
  

• * Return: 0 if OK, -ve on error
  

• */
  

• int (*check_mdata)(struct udevice *dev);
• /**

• * get_mdata() - Get a FWU metadata copy
  

• * @dev:	FWU device
  

• * @mdata:	Pointer to FWU metadata
  

• *
  

• * Get a valid copy of the FWU metadata.
  

• *
  

• * Return: 0 if OK, -ve on error
  

• */
  

• int (*get_mdata)(struct udevice *dev, struct fwu_mdata *mdata);
• /**

• * update_mdata() - Update the FWU metadata
  

• * @dev:	FWU device
  

• * @mdata:	Copy of the FWU metadata
  

• *
  

• * Update the FWU metadata structure by writing to the
  

• * FWU metadata partitions.
  

• *
  

• * Return: 0 if OK, -ve on error
  

• */
  

• int (*update_mdata)(struct udevice *dev, struct fwu_mdata *mdata);

+};

+#define FWU_MDATA_VERSION 0x1

+/* +* GUID value defined in the FWU specification for identification +* of the FWU metadata partition. +*/ +#define FWU_MDATA_GUID \

• EFI_GUID(0x8a7a84a0, 0x8387, 0x40f6, 0xab, 0x41, \

•  0xa8, 0xb9, 0xa5, 0xa6, 0x0d, 0x23)
  

+/**

• • fwu_get_mdata() - Get a FWU metadata copy
• • @dev: FWU metadata device
• • @mdata: Copy of the FWU metadata
• • Get a valid copy of the FWU metadata.
• • Note: This function is to be called first when modifying any fields
• • in the metadata. The sequence of calls to modify any field in the
• • metadata would be 1) fwu_get_mdata 2) Modify metadata, followed by
• • 3. fwu_update_mdata
• • Return: 0 if OK, -ve on error
• */

+int fwu_get_mdata(struct udevice *dev, struct fwu_mdata *mdata);

+/**

• • fwu_update_mdata() - Update the FWU metadata
• • @dev: FWU metadata device
• • @mdata: Copy of the FWU metadata
• • Update the FWU metadata structure by writing to the
• • FWU metadata partitions.
• • Note: This function is not to be called directly to update the
• • metadata fields. The sequence of function calls should be
• • 1. fwu_get_mdata() 2) Modify the medata fields 3) fwu_update_mdata()
• • Return: 0 if OK, -ve on error
• */

+int fwu_update_mdata(struct udevice *dev, struct fwu_mdata *mdata);

+/**

• • fwu_get_active_index() - Get active_index from the FWU metadata
• • @active_idxp: active_index value to be read
• • Read the active_index field from the FWU metadata and place it in
• • the variable pointed to be the function argument.
• • Return: 0 if OK, -ve on error
• */

+int fwu_get_active_index(uint *active_idxp);

+/**

• • fwu_set_active_index() - Set active_index in the FWU metadata
• • @active_idx: active_index value to be set
• • Update the active_index field in the FWU metadata
• • Return: 0 if OK, -ve on error
• */

+int fwu_set_active_index(uint active_idx);

+/**

• • fwu_get_image_index() - Get the Image Index to be used for capsule update
• • @image_index: The Image Index for the image
• • The FWU multi bank update feature computes the value of image_index at
• • runtime, based on the bank to which the image needs to be written to.
• • Derive the image_index value for the image.
• • Currently, the capsule update driver uses the DFU framework for
• • the updates. This function gets the DFU alt number which is to
• • be used as the Image Index
• • Return: 0 if OK, -ve on error
• */

+int fwu_get_image_index(u8 *image_index);

+/**

• • fwu_mdata_check() - Check if the FWU metadata is valid
• • @dev: FWU metadata device
• • Validate both copies of the FWU metadata. If one of the copies
• • has gone bad, restore it from the other copy.
• • Return: 0 if OK, -ve on error
• */

+int fwu_mdata_check(struct udevice *dev);

+/**

• • fwu_revert_boot_index() - Revert the active index in the FWU metadata
• • Revert the active_index value in the FWU metadata, by swapping the values
• • of active_index and previous_active_index in both copies of the
• • FWU metadata.
• • Return: 0 if OK, -ve on error
• */

+int fwu_revert_boot_index(void);

+/**

• • fwu_verify_mdata() - Verify the FWU metadata
• • @mdata: FWU metadata structure
• • @pri_part: FWU metadata partition is primary or secondary
• • Verify the FWU metadata by computing the CRC32 for the metadata
• • structure and comparing it against the CRC32 value stored as part
• • of the structure.
• • Return: 0 if OK, -ve on error
• */

+int fwu_verify_mdata(struct fwu_mdata *mdata, bool pri_part);

+/**

• • fwu_accept_image() - Set the Acceptance bit for the image
• • @img_type_id: GUID of the image type for which the accepted bit is to be

• •           cleared
    

• • @bank: Bank of which the image's Accept bit is to be set
• • Set the accepted bit for the image specified by the img_guid parameter. This
• • indicates acceptance of image for subsequent boots by some governing component
• • like OS(or firmware).
• • Return: 0 if OK, -ve on error
• */

+int fwu_accept_image(efi_guid_t *img_type_id, u32 bank);

+/**

• • fwu_clear_accept_image() - Clear the Acceptance bit for the image
• • @img_type_id: GUID of the image type for which the accepted bit is to be

• •           cleared
    

• • @bank: Bank of which the image's Accept bit is to be cleared
• • Clear the accepted bit for the image type specified by the img_type_id parameter.
• • This function is called after the image has been updated. The accepted bit is
• • cleared to be set subsequently after passing the image acceptance criteria, by
• • either the OS(or firmware)
• • Return: 0 if OK, -ve on error
• */

+int fwu_clear_accept_image(efi_guid_t *img_type_id, u32 bank);

+#endif /* _FWU_H_ */ diff --git a/include/fwu_mdata.h b/include/fwu_mdata.h new file mode 100644 index 0000000000..8fda4f4ac2 --- /dev/null +++ b/include/fwu_mdata.h @@ -0,0 +1,67 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/*

• • Copyright (c) 2022, Linaro Limited
• */

+#if !defined _FWU_MDATA_H_ +#define _FWU_MDATA_H_

+#include <efi.h>

+/**

• • struct fwu_image_bank_info - firmware image information
• • @image_uuid: Guid value of the image in this bank
• • @accepted: Acceptance status of the image
• • @reserved: Reserved
• • The structure contains image specific fields which are
• • used to identify the image and to specify the image's
• • acceptance status
• */

+struct fwu_image_bank_info {

• efi_guid_t image_uuid;
• uint32_t accepted;
• uint32_t reserved;

+};

+/**

• • struct fwu_image_entry - information for a particular type of image
• • @image_type_uuid: Guid value for identifying the image type
• • @location_uuid: Guid of the storage volume where the image is located
• • @img_bank_info: Array containing properties of images
• • This structure contains information on various types of updatable
• • firmware images. Each image type then contains an array of image
• • information per bank.
• */

+struct fwu_image_entry {

• efi_guid_t image_type_uuid;
• efi_guid_t location_uuid;
• struct fwu_image_bank_info img_bank_info[CONFIG_FWU_NUM_BANKS];

+};

+/**

• • struct fwu_mdata - FWU metadata structure for multi-bank updates
• • @crc32: crc32 value for the FWU metadata
• • @version: FWU metadata version
• • @active_index: Index of the bank currently used for booting images
• • @previous_active_inde: Index of the bank used before the current bank

• •                    being used for booting
    

• • @img_entry: Array of information on various firmware images that can

• •         be updated
    

• • This structure is used to store all the needed information for performing
• • multi bank updates on the platform. This contains info on the bank being
• • used to boot along with the information needed for identification of
• • individual images
• */

+struct fwu_mdata {

• uint32_t crc32;
• uint32_t version;
• uint32_t active_index;
• uint32_t previous_active_index;
• struct fwu_image_entry img_entry[CONFIG_FWU_NUM_IMAGES_PER_BANK];

+};

+#endif /* _FWU_MDATA_H_ */ diff --git a/lib/fwu_updates/fwu.c b/lib/fwu_updates/fwu.c new file mode 100644 index 0000000000..439f66aee4 --- /dev/null +++ b/lib/fwu_updates/fwu.c @@ -0,0 +1,364 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/*

• • Copyright (c) 2022, Linaro Limited
• */

+#include <dm.h> +#include <efi_loader.h> +#include <fwu.h> +#include <fwu_mdata.h> +#include <log.h>

+#include <linux/errno.h> +#include <linux/types.h> +#include <u-boot/crc.h>

+enum {

• IMAGE_ACCEPT_SET = 1,
• IMAGE_ACCEPT_CLEAR,

+};

+static int fwu_get_dev_mdata(struct udevice **dev, struct fwu_mdata *mdata) +{

• int ret;
• ret = uclass_first_device_err(UCLASS_FWU_MDATA, dev);
• if (ret) {

• log_debug("Cannot find fwu device\n");
  

• return ret;
  

• }
• ret = fwu_get_mdata(*dev, mdata);
• if (ret < 0)

• log_debug("Unable to get valid FWU metadata\n");
  

• return ret;

+}

+static int fwu_get_image_type_id(u8 *image_index, efi_guid_t *image_type_id) +{

• u8 index;
• int i;
• struct efi_fw_image *image;
• index = *image_index;
• image = update_info.images;
• for (i = 0; i < num_image_type_guids; i++) {

• if (index == image[i].image_index) {
  

• 	guidcpy(image_type_id, &image[i].image_type_id);
  

• 	return 0;
  

• }
  

• }
• return -ENOENT;

+}

+/**

• • fwu_verify_mdata() - Verify the FWU metadata
• • @mdata: FWU metadata structure
• • @pri_part: FWU metadata partition is primary or secondary
• • Verify the FWU metadata by computing the CRC32 for the metadata
• • structure and comparing it against the CRC32 value stored as part
• • of the structure.
• • Return: 0 if OK, -ve on error
• */

+int fwu_verify_mdata(struct fwu_mdata *mdata, bool pri_part) +{

• u32 calc_crc32;
• void *buf;
• buf = &mdata->version;
• calc_crc32 = crc32(0, buf, sizeof(*mdata) - sizeof(u32));
• if (calc_crc32 != mdata->crc32) {

• log_debug("crc32 check failed for %s FWU metadata partition\n",
  

• 	  pri_part ? "primary" : "secondary");
  

• return -EINVAL;
  

• }
• return 0;

+}

+/**

• • fwu_get_active_index() - Get active_index from the FWU metadata
• • @active_idx: active_index value to be read
• • Read the active_index field from the FWU metadata and place it in
• • the variable pointed to be the function argument.
• • Return: 0 if OK, -ve on error
• */

+int fwu_get_active_index(uint *active_idx) +{

• int ret;
• struct udevice *dev;
• struct fwu_mdata mdata = { 0 };
• ret = fwu_get_dev_mdata(&dev, &mdata);
• if (ret)

• return ret;
  

• /*

• * Found the FWU metadata partition, now read the active_index
  

• * value
  

• */
  

• *active_idx = mdata.active_index;
• if (*active_idx >= CONFIG_FWU_NUM_BANKS) {

• log_debug("Active index value read is incorrect\n");
  

• ret = -EINVAL;
  

• }
• return ret;

+}

+/**

• • fwu_set_active_index() - Set active_index in the FWU metadata
• • @active_idx: active_index value to be set
• • Update the active_index field in the FWU metadata
• • Return: 0 if OK, -ve on error
• */

+int fwu_set_active_index(uint active_idx) +{

• int ret;
• struct udevice *dev;
• struct fwu_mdata mdata = { 0 };
• if (active_idx >= CONFIG_FWU_NUM_BANKS) {

• log_debug("Invalid active index value\n");
  

• return -EINVAL;
  

• }
• ret = fwu_get_dev_mdata(&dev, &mdata);
• if (ret)

• return ret;
  

• /*

• * Update the active index and previous_active_index fields
  

• * in the FWU metadata
  

• */
  

• mdata.previous_active_index = mdata.active_index;
• mdata.active_index = active_idx;
• /*

• * Now write this updated FWU metadata to both the
  

• * FWU metadata partitions
  

• */
  

• ret = fwu_update_mdata(dev, &mdata);
• if (ret) {

• log_debug("Failed to update FWU metadata partitions\n");
  

• ret = -EIO;
  

• }
• return ret;

+}

+/**

• • fwu_get_image_index() - Get the Image Index to be used for capsule update
• • @image_index: The Image Index for the image
• • The FWU multi bank update feature computes the value of image_index at
• • runtime, based on the bank to which the image needs to be written to.
• • Derive the image_index value for the image.
• • Currently, the capsule update driver uses the DFU framework for
• • the updates. This function gets the DFU alt number which is to
• • be used as the Image Index
• • Return: 0 if OK, -ve on error
• */

+int fwu_get_image_index(u8 *image_index) +{

• int ret, i;
• u8 alt_num;
• u32 update_bank;
• efi_guid_t *image_guid, image_type_id;
• struct udevice *dev;
• struct fwu_mdata mdata = { 0 };
• struct fwu_image_entry *img_entry;
• struct fwu_image_bank_info *img_bank_info;
• ret = fwu_get_dev_mdata(&dev, &mdata);
• if (ret)

• return ret;
  

• ret = fwu_plat_get_update_index(&update_bank);
• if (ret) {

• log_debug("Failed to get the FWU update bank\n");
  

• goto out;
  

• }
• ret = fwu_get_image_type_id(image_index, &image_type_id);
• if (ret) {

• log_debug("Unable to get image_type_id for image_index %u\n",
  

• 	  *image_index);
  

• goto out;
  

• }
• ret = -EINVAL;
• /*

• * The FWU metadata has been read. Now get the image_uuid for the
  

• * image with the update_bank.
  

• */
  

• for (i = 0; i < CONFIG_FWU_NUM_IMAGES_PER_BANK; i++) {

• if (!guidcmp(&image_type_id,
  

• 	     &mdata.img_entry[i].image_type_uuid)) {
  

• 	img_entry = &mdata.img_entry[i];
  

• 	img_bank_info = &img_entry->img_bank_info[update_bank];
  

• 	image_guid = &img_bank_info->image_uuid;
  

• 	ret = fwu_plat_get_alt_num(dev, image_guid, &alt_num);
  

• 	if (ret) {
  

• 		log_debug("alt_num not found for partition with GUID %pUs\n",
  

• 			  image_guid);
  

• 	} else {
  

• 		log_debug("alt_num %d for partition %pUs\n",
  

• 			  alt_num, image_guid);
  

• 		*image_index = alt_num + 1;
  

• 	}
  

• 	goto out;
  

• }
  

• }
• log_debug("Partition with the image type %pUs not found\n",

•   &image_type_id);
  

+out:

• return ret;

+}

+/**

• • fwu_revert_boot_index() - Revert the active index in the FWU metadata
• • Revert the active_index value in the FWU metadata, by swapping the values
• • of active_index and previous_active_index in both copies of the
• • FWU metadata.
• • Return: 0 if OK, -ve on error
• */

+int fwu_revert_boot_index(void) +{

• int ret;
• u32 cur_active_index;
• struct udevice *dev;
• struct fwu_mdata mdata = { 0 };
• ret = fwu_get_dev_mdata(&dev, &mdata);
• if (ret)

• return ret;
  

• /*

• * Swap the active index and previous_active_index fields
  

• * in the FWU metadata
  

• */
  

• cur_active_index = mdata.active_index;
• mdata.active_index = mdata.previous_active_index;
• mdata.previous_active_index = cur_active_index;
• /*

• * Now write this updated FWU metadata to both the
  

• * FWU metadata partitions
  

• */
  

• ret = fwu_update_mdata(dev, &mdata);
• if (ret) {

• log_debug("Failed to update FWU metadata partitions\n");
  

• ret = -EIO;
  

• }
• return ret;

+}

+/**

• • fwu_clrset_image_accept() - Set or Clear the Acceptance bit for the image
• • @img_type_id: GUID of the image type for which the accepted bit is to be

• •           set or cleared
    

• • @bank: Bank of which the image's Accept bit is to be set or cleared
• • @action: Action which specifies whether image's Accept bit is to be set or

• •      cleared
    

• • Set/Clear the accepted bit for the image specified by the img_guid parameter.
• • This indicates acceptance or rejection of image for subsequent boots by some
• • governing component like OS(or firmware).
• • Return: 0 if OK, -ve on error
• */

+static int fwu_clrset_image_accept(efi_guid_t *img_type_id, u32 bank, u8 action) +{

• int ret, i;
• struct udevice *dev;
• struct fwu_mdata mdata = { 0 };
• struct fwu_image_entry *img_entry;
• struct fwu_image_bank_info *img_bank_info;
• ret = fwu_get_dev_mdata(&dev, &mdata);
• if (ret)

• return ret;
  

• img_entry = &mdata.img_entry[0];
• for (i = 0; i < CONFIG_FWU_NUM_IMAGES_PER_BANK; i++) {

• if (!guidcmp(&img_entry[i].image_type_uuid, img_type_id)) {
  

• 	img_bank_info = &img_entry[i].img_bank_info[bank];
  

• 	if (action == IMAGE_ACCEPT_SET)
  

• 		img_bank_info->accepted |= FWU_IMAGE_ACCEPTED;
  

• 	else
  

• 		img_bank_info->accepted = 0;
  

• 	ret = fwu_update_mdata(dev, &mdata);
  

• 	goto out;
  

• }
  

• }
• /* Image not found */
• ret = -ENOENT;

+out:

• return ret;

+}

+/**

• • fwu_accept_image() - Set the Acceptance bit for the image
• • @img_type_id: GUID of the image type for which the accepted bit is to be

• •           cleared
    

• • @bank: Bank of which the image's Accept bit is to be set
• • Set the accepted bit for the image specified by the img_guid parameter. This
• • indicates acceptance of image for subsequent boots by some governing component
• • like OS(or firmware).
• • Return: 0 if OK, -ve on error
• */

+int fwu_accept_image(efi_guid_t *img_type_id, u32 bank) +{

• return fwu_clrset_image_accept(img_type_id, bank,

• 		       IMAGE_ACCEPT_SET);
  

+}

+/**

• • fwu_clear_accept_image() - Clear the Acceptance bit for the image
• • @img_type_id: GUID of the image type for which the accepted bit is to be

• •           cleared
    

• • @bank: Bank of which the image's Accept bit is to be cleared
• • Clear the accepted bit for the image type specified by the img_type_id parameter.
• • This function is called after the image has been updated. The accepted bit is
• • cleared to be set subsequently after passing the image acceptance criteria, by
• • either the OS(or firmware)
• • Return: 0 if OK, -ve on error
• */

+int fwu_clear_accept_image(efi_guid_t *img_type_id, u32 bank) +{

• return fwu_clrset_image_accept(img_type_id, bank,

• 		       IMAGE_ACCEPT_CLEAR);
  

+}

2.34.1

Reviewed-by: Ilias Apalodimas ilias.apalodimas@linaro.org

On Thu, Oct 06, 2022 at 02:36:17PM +0530, Sughosh Ganu wrote:

In the FWU Multi Bank Update feature, the information about the updatable images is stored as part of the metadata, on a separate partition. Add a driver for reading from and writing to the metadata when the updatable images and the metadata are stored on a block device which is formatted with GPT based partition scheme.

Signed-off-by: Sughosh Ganu sughosh.ganu@linaro.org Reviewed-by: Patrick Delaunay patrick.delaunay@foss.st.com Reviewed-by: Etienne Carriere etienne.carriere@linaro.org

---

Changes since V12: None

drivers/fwu-mdata/Kconfig | 16 ++ drivers/fwu-mdata/Makefile | 8 + drivers/fwu-mdata/gpt_blk.c | 357 ++++++++++++++++++++++++++++++++++++ include/fwu.h | 4 + 4 files changed, 385 insertions(+) create mode 100644 drivers/fwu-mdata/Kconfig create mode 100644 drivers/fwu-mdata/Makefile create mode 100644 drivers/fwu-mdata/gpt_blk.c

diff --git a/drivers/fwu-mdata/Kconfig b/drivers/fwu-mdata/Kconfig new file mode 100644 index 0000000000..36c4479a59 --- /dev/null +++ b/drivers/fwu-mdata/Kconfig @@ -0,0 +1,16 @@ +config FWU_MDATA

• bool "Driver support for accessing FWU Metadata"
  

• depends on DM
  

• help
  

•   Enable support for accessing FWU Metadata partitions. The
  

•   FWU Metadata partitions reside on the same storage device
  

•   which contains the other FWU updatable firmware images.
  

+config FWU_MDATA_GPT_BLK

• bool "FWU Metadata access for GPT partitioned Block devices"
  

• select PARTITION_TYPE_GUID
  

• select PARTITION_UUIDS
  

• depends on FWU_MDATA && BLK && EFI_PARTITION
  

• help
  

•   Enable support for accessing FWU Metadata on GPT partitioned
  

•   block devices.
  

diff --git a/drivers/fwu-mdata/Makefile b/drivers/fwu-mdata/Makefile new file mode 100644 index 0000000000..3fee64c10c --- /dev/null +++ b/drivers/fwu-mdata/Makefile @@ -0,0 +1,8 @@ +# SPDX-License-Identifier: GPL-2.0-or-later +# +# Copyright (c) 2022, Linaro Limited +#

+obj-$(CONFIG_FWU_MDATA) += fwu-mdata-uclass.o +obj-$(CONFIG_FWU_MDATA_GPT_BLK) += gpt_blk.o diff --git a/drivers/fwu-mdata/gpt_blk.c b/drivers/fwu-mdata/gpt_blk.c new file mode 100644 index 0000000000..131c86bc55 --- /dev/null +++ b/drivers/fwu-mdata/gpt_blk.c @@ -0,0 +1,357 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/*

• • Copyright (c) 2022, Linaro Limited
• */

+#define LOG_CATEGORY UCLASS_FWU_MDATA

+#include <blk.h> +#include <dm.h> +#include <efi_loader.h> +#include <fwu.h> +#include <fwu_mdata.h> +#include <log.h> +#include <memalign.h> +#include <part.h> +#include <part_efi.h>

+#include <dm/device-internal.h> +#include <linux/errno.h> +#include <linux/types.h>

+#define PRIMARY_PART BIT(0) +#define SECONDARY_PART BIT(1) +#define BOTH_PARTS (PRIMARY_PART | SECONDARY_PART)

+#define MDATA_READ BIT(0) +#define MDATA_WRITE BIT(1)

+static int gpt_get_mdata_partitions(struct blk_desc *desc,

•                             uint mdata_parts[2])
  

This feels a bit weird. I'd prefer uint mdata_parts[] here

+{

• int i, ret;
  

• u32 nparts;
  

• efi_guid_t part_type_guid;
  

• struct disk_partition info;
  

• const efi_guid_t fwu_mdata_guid = FWU_MDATA_GUID;
  

• nparts = 0;
  

• for (i = 1; i < MAX_SEARCH_PARTITIONS && nparts < 2; i++) {
  

•         if (part_get_info(desc, i, &info))
  

•                 continue;
  

•         uuid_str_to_bin(info.type_guid, part_type_guid.b,
  

•                         UUID_STR_FORMAT_GUID);
  

•         if (!guidcmp(&fwu_mdata_guid, &part_type_guid)) {
  

•                 mdata_parts[nparts] = i;
  

•                 ++nparts;
  

•         }
  

• }
  

• if (nparts != 2) {
  

•         log_debug("Expect two copies of the FWU metadata instead of %d\n",
  

•                   nparts);
  

•         ret = -EINVAL;
  

• } else {
  

•         ret = 0;
  

• }
  

• return ret;
  

+}

+static int gpt_get_mdata_disk_part(struct blk_desc *desc,

•                            struct disk_partition *info,
  

•                            u32 part_num)
  

+{

• int ret;
  

• char *mdata_guid_str = "8a7a84a0-8387-40f6-ab41-a8b9a5a60d23";
  

• ret = part_get_info(desc, part_num, info);
  

• if (ret < 0) {
  

•         log_debug("Unable to get the partition info for the FWU metadata part %d\n",
  

•                   part_num);
  

•         return -ENOENT;
  

• }
  

• /* Check that it is indeed the FWU metadata partition */
  

• if (!strncmp(info->type_guid, mdata_guid_str, UUID_STR_LEN)) {
  

•         /* Found the FWU metadata partition */
  

•         return 0;
  

• }
  

• return -ENOENT;
  

+}

[...]

With the argument fixed Reviewed-by: Ilias Apalodimas ilias.apalodimas@linaro.org

On Thu, Oct 06, 2022 at 02:36:20PM +0530, Sughosh Ganu wrote:

Add weak functions for getting the update index value and dfu alternate number needed for FWU Multi Bank update functionality.

The current implementation for getting the update index value is for platforms with 2 banks. If a platform supports more than 2 banks, it can implement it's own function. The function to get the dfu alternate number has been added for platforms with GPT partitioned storage devices. Platforms with other storage partition scheme need to implement their own function.

Signed-off-by: Sughosh Ganu sughosh.ganu@linaro.org Reviewed-by: Patrick Delaunay patrick.delaunay@foss.st.com Acked-by: Etienne Carriere etienne.carriere@linaro.org

---

Changes since V12:

• Initialise and increment the variable i in fwu_gpt_get_alt_num()
• Check the return value of dfu_init_env_entities()

include/fwu.h | 29 +++++++++ lib/fwu_updates/fwu.c | 27 +++++++++ lib/fwu_updates/fwu_gpt.c | 123 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 179 insertions(+) create mode 100644 lib/fwu_updates/fwu_gpt.c

diff --git a/include/fwu.h b/include/fwu.h index 167f91388e..99f43f07b0 100644 --- a/include/fwu.h +++ b/include/fwu.h @@ -212,4 +212,33 @@ int fwu_accept_image(efi_guid_t *img_type_id, u32 bank); */ int fwu_clear_accept_image(efi_guid_t *img_type_id, u32 bank);

+/**

• • fwu_plat_get_alt_num() - Get the DFU Alt Num for the image from the platform
• • @dev: FWU device
• • @image_guid: Image GUID for which DFU alt number needs to be retrieved
• • @alt_num: Pointer to the alt_num
• • Get the DFU alt number from the platform for the image specified by the
• • image GUID.
• • Return: 0 if OK, -ve on error
• */

+int fwu_plat_get_alt_num(struct udevice *dev, efi_guid_t *image_guid,

• 	 u8 *alt_num);
  

+/**

• • fwu_plat_get_update_index() - Get the value of the update bank
• • @update_idx: Bank number to which images are to be updated
• • Get the value of the bank(partition) to which the update needs to be
• • made.
• • Note: This is a weak function and platforms can override this with
• • their own implementation for selection of the update bank.
• • Return: 0 if OK, -ve on error
• */

+int fwu_plat_get_update_index(uint *update_idx); #endif /* _FWU_H_ */ diff --git a/lib/fwu_updates/fwu.c b/lib/fwu_updates/fwu.c index 439f66aee4..70482d14a0 100644 --- a/lib/fwu_updates/fwu.c +++ b/lib/fwu_updates/fwu.c @@ -362,3 +362,30 @@ int fwu_clear_accept_image(efi_guid_t *img_type_id, u32 bank) return fwu_clrset_image_accept(img_type_id, bank, IMAGE_ACCEPT_CLEAR); }

+/**

• • fwu_plat_get_update_index() - Get the value of the update bank
• • @update_idx: Bank number to which images are to be updated
• • Get the value of the bank(partition) to which the update needs to be
• • made.
• • Note: This is a weak function and platforms can override this with
• • their own implementation for selection of the update bank.
• • Return: 0 if OK, -ve on error
• */

+__weak int fwu_plat_get_update_index(uint *update_idx) +{

• int ret;
• u32 active_idx;
• ret = fwu_get_active_index(&active_idx);
• if (ret < 0)

• return -1;
  

• *update_idx = (active_idx + 1) % CONFIG_FWU_NUM_BANKS;
• return ret;

+} diff --git a/lib/fwu_updates/fwu_gpt.c b/lib/fwu_updates/fwu_gpt.c new file mode 100644 index 0000000000..21a573c934 --- /dev/null +++ b/lib/fwu_updates/fwu_gpt.c @@ -0,0 +1,123 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/*

• • Copyright (c) 2022, Linaro Limited
• */

+#include <blk.h> +#include <dfu.h> +#include <efi.h> +#include <efi_loader.h> +#include <fwu.h> +#include <log.h> +#include <part.h>

+#include <linux/errno.h>

+static int get_gpt_dfu_identifier(struct blk_desc *desc, efi_guid_t *image_guid) +{

• int i;
• struct disk_partition info;
• efi_guid_t unique_part_guid;
• for (i = 1; i < MAX_SEARCH_PARTITIONS; i++) {

• if (part_get_info(desc, i, &info))
  

• 	continue;
  

• uuid_str_to_bin(info.uuid, unique_part_guid.b,
  

• 		UUID_STR_FORMAT_GUID);
  

• if (!guidcmp(&unique_part_guid, image_guid))
  

• 	return i;
  

• }
• log_err("No partition found with image_guid %pUs\n", image_guid);
• return -ENOENT;

+}

+static int fwu_alt_num_for_dfu_dev(struct dfu_entity *dfu, int dev_num,

• 		   int part, unsigned char dfu_dev,
  

• 		   u8 *alt_num)
  

+{

• int ret;
• switch(dfu_dev) {
• case DFU_DEV_MMC:

• if (dfu->layout == DFU_RAW_ADDR &&
  

•     dfu->data.mmc.dev_num == dev_num &&
  

•     dfu->data.mmc.part == part) {
  

• 	*alt_num = dfu->alt;
  

• 	ret = 0;
  

• } else {
  

• 	ret = -ENOENT;
  

• }
  

• break;
  

• default:

• ret = -ENOENT;
  

• }
• return ret;

+}

+static int fwu_gpt_get_alt_num(struct blk_desc *desc, efi_guid_t *image_guid,

• 	       u8 *alt_num, unsigned char dfu_dev)
  

+{

• int ret = -1;
• int i, part, dev_num;
• struct dfu_entity *dfu;
• dev_num = desc->devnum;
• part = get_gpt_dfu_identifier(desc, image_guid);
• if (part < 0)

• return -ENOENT;
  

• ret = dfu_init_env_entities(NULL, NULL);
• if (ret)

• goto out;
  

• i = 0;
• while (true) {

• dfu = dfu_get_entity(i++);
  

• if (!dfu) {
  

• 	ret = -ENOENT;
  

• 	break;
  

• }
  

• if (dfu->dev_type != dfu_dev)
  

• 	continue;
  

• ret = fwu_alt_num_for_dfu_dev(dfu, dev_num, part, dfu_dev,
  

• 			      alt_num);
  

• if (!ret)
  

• 	break;
  

• }

+out:

• dfu_free_entities();
• return ret;

+}

+/**

• • fwu_plat_get_alt_num() - Get the DFU alt number
• • @dev: FWU metadata device
• • @image_guid: GUID value of the image for which the alt num is to

• •          be obtained
    

• • @alt_num: The DFU alt number for the image that is to be updated
• • Get the DFU alt number for the image that is to be updated. The
• • image is identified with the image_guid parameter that is passed
• • to the function.
• • Note: This is a weak function and platforms can override this with
• • their own implementation for obtaining the alt number value.
• • Return: 0 if OK, -ve on error
• */

+__weak int fwu_plat_get_alt_num(struct udevice *dev, efi_guid_t *image_guid,

• 		u8 *alt_num)
  

+{

• struct fwu_mdata_gpt_blk_priv *priv = dev_get_priv(dev);
• return fwu_gpt_get_alt_num(dev_get_uclass_plat(priv->blk_dev),

• 		   image_guid, alt_num, DFU_DEV_MMC);
  

+}

2.34.1

Reviewed-by: Ilias Apalodimas ilias.apalodimas@linaro.org

On Thu, Oct 06, 2022 at 02:36:23PM +0530, 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 sughosh.ganu@linaro.org Reviewed-by: Etienne Carriere etienne.carriere@linaro.org

---

Changes since V12: None

include/fwu.h | 13 +++ lib/fwu_updates/fwu.c | 191 +++++++++++++++++++++++++++++++++++++++++- 2 files changed, 203 insertions(+), 1 deletion(-)

diff --git a/include/fwu.h b/include/fwu.h index 71a03cf70b..2effa7da38 100644 --- a/include/fwu.h +++ b/include/fwu.h @@ -253,4 +253,17 @@ int fwu_plat_get_update_index(uint *update_idx);

*/ void fwu_plat_get_bootidx(uint *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/fwu_updates/fwu.c b/lib/fwu_updates/fwu.c index 70482d14a0..b14c0dfadd 100644 --- a/lib/fwu_updates/fwu.c +++ b/lib/fwu_updates/fwu.c @@ -4,10 +4,19 @@ */

#include <dm.h> +#include <efi.h> #include <efi_loader.h> +#include <efi_variable.h> +#include <event.h> #include <fwu.h> #include <fwu_mdata.h> -#include <log.h> +#include <malloc.h>

+#include <linux/errno.h> +#include <linux/types.h>

+static u8 trial_state; +static u8 boottime_check;

#include <linux/errno.h> #include <linux/types.h> @@ -18,6 +27,112 @@ enum { IMAGE_ACCEPT_CLEAR, };

+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;
• struct fwu_mdata mdata = { 0 };
• ret = fwu_get_mdata(dev, &mdata);
• if (ret)

• return ret;
  

• trial_state = in_trial_state(&mdata);
• if (trial_state) {

• 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;
  

Why are we setting those before a get_variable?

• 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");
  

• 	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_mdata(struct udevice **dev, struct fwu_mdata *mdata) { int ret; @@ -28,6 +143,9 @@ static int fwu_get_dev_mdata(struct udevice **dev, struct fwu_mdata *mdata) return ret; }

• if (!mdata)

• return 0;
  

• ret = fwu_get_mdata(*dev, mdata); if (ret < 0) log_debug("Unable to get valid FWU metadata\n");

@@ -389,3 +507,74 @@ __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_mdata(&dev, NULL);
• 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_set_active_index(boot_idx);
  

• if (!ret)
  

• 	boottime_check = 1;
  

• return 0;
  

Why are we returning 0 here? If fwu_set_active_index() failed, shouldn't we report that to upper layers?

• }
• if (efi_init_obj_list() != EFI_SUCCESS)

• return 0;
  

• ret = fwu_trial_state_check(dev);
• if (!ret)

• boottime_check = 1;
  

ditto

• return 0;

+}

+EVENT_SPY(EVT_MAIN_LOOP, fwu_boottime_checks);

2.34.1

Hi Sughosh,

On Thu, 6 Oct 2022 at 03:07, Sughosh Ganu sughosh.ganu@linaro.org 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 sughosh.ganu@linaro.org Reviewed-by: Etienne Carriere etienne.carriere@linaro.org

---

Changes since V12: None

include/fwu.h | 13 +++ lib/fwu_updates/fwu.c | 191 +++++++++++++++++++++++++++++++++++++++++- 2 files changed, 203 insertions(+), 1 deletion(-)

diff --git a/include/fwu.h b/include/fwu.h index 71a03cf70b..2effa7da38 100644 --- a/include/fwu.h +++ b/include/fwu.h @@ -253,4 +253,17 @@ int fwu_plat_get_update_index(uint *update_idx);

*/ void fwu_plat_get_bootidx(uint *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/fwu_updates/fwu.c b/lib/fwu_updates/fwu.c index 70482d14a0..b14c0dfadd 100644 --- a/lib/fwu_updates/fwu.c +++ b/lib/fwu_updates/fwu.c @@ -4,10 +4,19 @@ */

#include <dm.h> +#include <efi.h> #include <efi_loader.h> +#include <efi_variable.h> +#include <event.h> #include <fwu.h> #include <fwu_mdata.h> -#include <log.h> +#include <malloc.h>

+#include <linux/errno.h> +#include <linux/types.h>

+static u8 trial_state; +static u8 boottime_check;

#include <linux/errno.h> #include <linux/types.h> @@ -18,6 +27,112 @@ enum { IMAGE_ACCEPT_CLEAR, };

+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;
  

•   struct fwu_mdata mdata = { 0 };
  

•   ret = fwu_get_mdata(dev, &mdata);
  

•   if (ret)
  

•           return ret;
  

•   trial_state = in_trial_state(&mdata);
  

•   if (trial_state) {
  

•           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");
  

•                   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_mdata(struct udevice **dev, struct fwu_mdata *mdata) { int ret; @@ -28,6 +143,9 @@ static int fwu_get_dev_mdata(struct udevice **dev, struct fwu_mdata *mdata) return ret; }

•   if (!mdata)
  

•           return 0;
  

•   ret = fwu_get_mdata(*dev, mdata);
    if (ret < 0)
            log_debug("Unable to get valid FWU metadata\n");
  

@@ -389,3 +507,74 @@ __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_mdata(&dev, NULL);
  

•   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_set_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);

Do you have a command to initiate these checks? If not, please add one. This is how things are done in U-Boot and it will be needed for tests so you don't have to reboot to run this code!

Regards, Simon

On Fri, 14 Oct 2022 at 12:12, Ilias Apalodimas ilias.apalodimas@linaro.org wrote:

On Thu, Oct 06, 2022 at 02:36:24PM +0530, Sughosh Ganu wrote:

...

The FWU Multi Bank Update feature supports updation of firmware images

s/updation/updating

...

to one of multiple sets(also called banks) of images. The firmware images are clubbed together in banks, with the system booting images from the active bank. Information on the images such as which bank they belong to is stored as part of the metadata structure, which is stored on the same storage media as the firmware images on a dedicated partition.

At the time of update, the metadata is read to identify the bank to which the images need to be flashed(update bank). On a successful update, the metadata is modified to set the updated bank as active bank to subsequently boot from.

Signed-off-by: Sughosh Ganu sughosh.ganu@linaro.org

Changes since V12: None

drivers/Kconfig | 2 + drivers/Makefile | 1 + include/fwu.h | 30 +++++ lib/Kconfig | 6 + lib/Makefile | 1 + lib/efi_loader/efi_capsule.c | 207 +++++++++++++++++++++++++++++++++- lib/efi_loader/efi_firmware.c | 14 +++ lib/fwu_updates/Kconfig | 33 ++++++ lib/fwu_updates/Makefile | 7 ++ lib/fwu_updates/fwu.c | 22 ++++ 10 files changed, 321 insertions(+), 2 deletions(-) create mode 100644 lib/fwu_updates/Kconfig create mode 100644 lib/fwu_updates/Makefile

diff --git a/drivers/Kconfig b/drivers/Kconfig index 8b6fead351..75ac149d31 100644 --- a/drivers/Kconfig +++ b/drivers/Kconfig @@ -44,6 +44,8 @@ source "drivers/fuzz/Kconfig"

source "drivers/fpga/Kconfig"

+source "drivers/fwu-mdata/Kconfig"

source "drivers/gpio/Kconfig"

source "drivers/hwspinlock/Kconfig" diff --git a/drivers/Makefile b/drivers/Makefile index 9d9f69a3c9..253cbfb71d 100644 --- a/drivers/Makefile +++ b/drivers/Makefile @@ -85,6 +85,7 @@ obj-y += cache/ obj-$(CONFIG_CPU) += cpu/ obj-y += crypto/ obj-$(CONFIG_FASTBOOT) += fastboot/ +obj-$(CONFIG_FWU_MDATA) += fwu-mdata/ obj-y += misc/ obj-$(CONFIG_MMC) += mmc/ obj-$(CONFIG_NVME) += nvme/ diff --git a/include/fwu.h b/include/fwu.h index 2effa7da38..b5c59dc161 100644 --- a/include/fwu.h +++ b/include/fwu.h @@ -60,6 +60,7 @@ struct fwu_mdata_ops { };

@@ -388,6 +395,130 @@ efi_status_t efi_capsule_authenticate(const void *capsule, efi_uintn_t capsule_s } #endif /* CONFIG_EFI_CAPSULE_AUTHENTICATE */

+static __maybe_unused bool fwu_empty_capsule(struct efi_capsule_header *capsule) +{

• return !guidcmp(&capsule->capsule_guid,
  

•                 &fwu_guid_os_request_fw_revert) ||
  

•         !guidcmp(&capsule->capsule_guid,
  

•                  &fwu_guid_os_request_fw_accept);
  

+}

+static __maybe_unused efi_status_t fwu_to_efi_error(int err) +{

• efi_status_t ret;
  

• switch(err) {
  

• case 0:
  

•         ret = EFI_SUCCESS;
  

•         break;
  

• case -ENODEV:
  

ENODEV should return EFI_INVALID_PARAMETER. The device was not found, EFI_DEVICE_ERROR usually means something bad happened to the device

...

• case -ERANGE:
  

• case -EIO:
  

•         ret = EFI_DEVICE_ERROR;
  

•         break;
  

• case -EINVAL:
  

•         ret = EFI_INVALID_PARAMETER;
  

•         break;
  

• default:
  

•         ret = EFI_OUT_OF_RESOURCES;
  

• }
  

• return ret;
  

+}

+static __maybe_unused efi_status_t fwu_empty_capsule_process(

• struct efi_capsule_header *capsule)
  

+{

• int status;
  

• u32 active_idx;
  

• efi_status_t ret;
  

• efi_guid_t *image_guid;
  

• if (!guidcmp(&capsule->capsule_guid,
  

•              &fwu_guid_os_request_fw_revert)) {
  

•         /*
  

•          * One of the previously updated image has
  

•          * failed the OS acceptance test. OS has
  

•          * requested to revert back to the earlier
  

•          * boot index
  

•          */
  

•         status = fwu_revert_boot_index();
  

•         ret = fwu_to_efi_error(status);
  

•         if (ret == EFI_SUCCESS)
  

•                 log_info("Reverted the FWU active_index. Recommend rebooting the system\n");
  

•         else
  

•                 log_err("Failed to revert the FWU boot index\n");
  

• } else {
  

We should be explicit on the GUID checking here. IOW if someone hands you over and empty capsule with a guid !fwu_guid_os_request_fw_revert you'll accept the capsule

This won't happen since this function is called only for empty capsules. Will handle the other two review comments.

-sughosh

...

•         /*
  

•          * Image accepted by the OS. Set the acceptance
  

•          * status for the image.
  

•          */
  

•         image_guid = (void *)(char *)capsule +
  

•                 capsule->header_size;
  

•         status = fwu_get_active_index(&active_idx);
  

•         ret = fwu_to_efi_error(status);
  

•         if (ret != EFI_SUCCESS) {
  

•                 log_err("Unable to get the active_index from the FWU metadata\n");
  

•                 return ret;
  

•         }
  

•         status = fwu_accept_image(image_guid, active_idx);
  

•         ret = fwu_to_efi_error(status);
  

•         if (ret != EFI_SUCCESS)
  

•                 log_err("Unable to set the Accept bit for the image %pUs\n",
  

•                         image_guid);
  

• }
  

• return ret;
  

+}

+static __maybe_unused void fwu_post_update_checks(

• struct efi_capsule_header *capsule,
  

• bool *fw_accept_os, bool *capsule_update)
  

+{

• if (fwu_empty_capsule(capsule))
  

•         *capsule_update = false;
  

• else
  

•         if (!*fw_accept_os)
  

This line should fold to the upper one

...

•                 *fw_accept_os =
  

•                         capsule->flags & FW_ACCEPT_OS ? true : false;
  

+}

+static __maybe_unused efi_status_t fwu_post_update_process(bool fw_accept_os) +{

• int status;
  

• u32 update_index;
  

• efi_status_t ret;
  

• status = fwu_plat_get_update_index(&update_index);
  

• if (status < 0) {
  

•         log_err("Failed to get the FWU update_index value\n");
  

•         return EFI_DEVICE_ERROR;
  

• }
  

• /*
  

•  * All the capsules have been updated successfully,
  

•  * update the FWU metadata.
  

•  */
  

• log_debug("Update Complete. Now updating active_index to %u\n",
  

•           update_index);
  

• status = fwu_set_active_index(update_index);
  

• ret = fwu_to_efi_error(status);
  

• if (ret != EFI_SUCCESS) {
  

•         log_err("Failed to update FWU metadata index values\n");
  

• } else {
  

•         log_debug("Successfully updated the active_index\n");
  

[...]

Thanks /Ilias

hi Ilias,

On Fri, 14 Oct 2022 at 13:02, Ilias Apalodimas ilias.apalodimas@linaro.org wrote:

On Fri, 14 Oct 2022 at 10:06, Sughosh Ganu sughosh.ganu@linaro.org wrote:

...

On Fri, 14 Oct 2022 at 12:12, Ilias Apalodimas ilias.apalodimas@linaro.org wrote:

...

On Thu, Oct 06, 2022 at 02:36:24PM +0530, Sughosh Ganu wrote:

...

The FWU Multi Bank Update feature supports updation of firmware images

s/updation/updating

...

to one of multiple sets(also called banks) of images. The firmware images are clubbed together in banks, with the system booting images from the active bank. Information on the images such as which bank they belong to is stored as part of the metadata structure, which is stored on the same storage media as the firmware images on a dedicated partition.

At the time of update, the metadata is read to identify the bank to which the images need to be flashed(update bank). On a successful update, the metadata is modified to set the updated bank as active bank to subsequently boot from.

Signed-off-by: Sughosh Ganu sughosh.ganu@linaro.org

Changes since V12: None

drivers/Kconfig | 2 + drivers/Makefile | 1 + include/fwu.h | 30 +++++ lib/Kconfig | 6 + lib/Makefile | 1 + lib/efi_loader/efi_capsule.c | 207 +++++++++++++++++++++++++++++++++- lib/efi_loader/efi_firmware.c | 14 +++ lib/fwu_updates/Kconfig | 33 ++++++ lib/fwu_updates/Makefile | 7 ++ lib/fwu_updates/fwu.c | 22 ++++ 10 files changed, 321 insertions(+), 2 deletions(-) create mode 100644 lib/fwu_updates/Kconfig create mode 100644 lib/fwu_updates/Makefile

diff --git a/drivers/Kconfig b/drivers/Kconfig index 8b6fead351..75ac149d31 100644 --- a/drivers/Kconfig +++ b/drivers/Kconfig @@ -44,6 +44,8 @@ source "drivers/fuzz/Kconfig"

source "drivers/fpga/Kconfig"

+source "drivers/fwu-mdata/Kconfig"

source "drivers/gpio/Kconfig"

source "drivers/hwspinlock/Kconfig" diff --git a/drivers/Makefile b/drivers/Makefile index 9d9f69a3c9..253cbfb71d 100644 --- a/drivers/Makefile +++ b/drivers/Makefile @@ -85,6 +85,7 @@ obj-y += cache/ obj-$(CONFIG_CPU) += cpu/ obj-y += crypto/ obj-$(CONFIG_FASTBOOT) += fastboot/ +obj-$(CONFIG_FWU_MDATA) += fwu-mdata/ obj-y += misc/ obj-$(CONFIG_MMC) += mmc/ obj-$(CONFIG_NVME) += nvme/ diff --git a/include/fwu.h b/include/fwu.h index 2effa7da38..b5c59dc161 100644 --- a/include/fwu.h +++ b/include/fwu.h @@ -60,6 +60,7 @@ struct fwu_mdata_ops { };

@@ -388,6 +395,130 @@ efi_status_t efi_capsule_authenticate(const void *capsule, efi_uintn_t capsule_s } #endif /* CONFIG_EFI_CAPSULE_AUTHENTICATE */

+static __maybe_unused bool fwu_empty_capsule(struct efi_capsule_header *capsule) +{

• return !guidcmp(&capsule->capsule_guid,
  

•                 &fwu_guid_os_request_fw_revert) ||
  

•         !guidcmp(&capsule->capsule_guid,
  

•                  &fwu_guid_os_request_fw_accept);
  

+}

+static __maybe_unused efi_status_t fwu_to_efi_error(int err) +{

• efi_status_t ret;
  

• switch(err) {
  

• case 0:
  

•         ret = EFI_SUCCESS;
  

•         break;
  

• case -ENODEV:
  

ENODEV should return EFI_INVALID_PARAMETER. The device was not found, EFI_DEVICE_ERROR usually means something bad happened to the device

...

• case -ERANGE:
  

• case -EIO:
  

•         ret = EFI_DEVICE_ERROR;
  

•         break;
  

• case -EINVAL:
  

•         ret = EFI_INVALID_PARAMETER;
  

•         break;
  

• default:
  

•         ret = EFI_OUT_OF_RESOURCES;
  

• }
  

• return ret;
  

+}

+static __maybe_unused efi_status_t fwu_empty_capsule_process(

• struct efi_capsule_header *capsule)
  

+{

• int status;
  

• u32 active_idx;
  

• efi_status_t ret;
  

• efi_guid_t *image_guid;
  

• if (!guidcmp(&capsule->capsule_guid,
  

•              &fwu_guid_os_request_fw_revert)) {
  

•         /*
  

•          * One of the previously updated image has
  

•          * failed the OS acceptance test. OS has
  

•          * requested to revert back to the earlier
  

•          * boot index
  

•          */
  

•         status = fwu_revert_boot_index();
  

•         ret = fwu_to_efi_error(status);
  

•         if (ret == EFI_SUCCESS)
  

•                 log_info("Reverted the FWU active_index. Recommend rebooting the system\n");
  

•         else
  

•                 log_err("Failed to revert the FWU boot index\n");
  

• } else {
  

We should be explicit on the GUID checking here. IOW if someone hands you over and empty capsule with a guid !fwu_guid_os_request_fw_revert you'll accept the capsule

This won't happen since this function is called only for empty capsules. Will handle the other two review comments.

I am not sure I am following. Why can't it happen? If someone create an empty capsule with an invalid (by invalid I mean none of the 2 GUIDs the spec expects), you'll end up trying to accept the firmware no?

That will be checked in the fwu_empty_capsule(). Only if this function returns true, will the fwu_empty_capsule_process() get called. So the capsule_guid should either be one for accept or a revert capsule.

-sughosh

Thanks /Ilias

...

-sughosh

...

...

•         /*
  

•          * Image accepted by the OS. Set the acceptance
  

•          * status for the image.
  

•          */
  

•         image_guid = (void *)(char *)capsule +
  

•                 capsule->header_size;
  

•         status = fwu_get_active_index(&active_idx);
  

•         ret = fwu_to_efi_error(status);
  

•         if (ret != EFI_SUCCESS) {
  

•                 log_err("Unable to get the active_index from the FWU metadata\n");
  

•                 return ret;
  

•         }
  

•         status = fwu_accept_image(image_guid, active_idx);
  

•         ret = fwu_to_efi_error(status);
  

•         if (ret != EFI_SUCCESS)
  

•                 log_err("Unable to set the Accept bit for the image %pUs\n",
  

•                         image_guid);
  

• }
  

• return ret;
  

+}

+static __maybe_unused void fwu_post_update_checks(

• struct efi_capsule_header *capsule,
  

• bool *fw_accept_os, bool *capsule_update)
  

+{

• if (fwu_empty_capsule(capsule))
  

•         *capsule_update = false;
  

• else
  

•         if (!*fw_accept_os)
  

This line should fold to the upper one

...

•                 *fw_accept_os =
  

•                         capsule->flags & FW_ACCEPT_OS ? true : false;
  

+}

+static __maybe_unused efi_status_t fwu_post_update_process(bool fw_accept_os) +{

• int status;
  

• u32 update_index;
  

• efi_status_t ret;
  

• status = fwu_plat_get_update_index(&update_index);
  

• if (status < 0) {
  

•         log_err("Failed to get the FWU update_index value\n");
  

•         return EFI_DEVICE_ERROR;
  

• }
  

• /*
  

•  * All the capsules have been updated successfully,
  

•  * update the FWU metadata.
  

•  */
  

• log_debug("Update Complete. Now updating active_index to %u\n",
  

•           update_index);
  

• status = fwu_set_active_index(update_index);
  

• ret = fwu_to_efi_error(status);
  

• if (ret != EFI_SUCCESS) {
  

•         log_err("Failed to update FWU metadata index values\n");
  

• } else {
  

•         log_debug("Successfully updated the active_index\n");
  

[...]

Thanks /Ilias

hi Ilias,

On Fri, 14 Oct 2022 at 12:12, Ilias Apalodimas ilias.apalodimas@linaro.org wrote:

On Thu, Oct 06, 2022 at 02:36:24PM +0530, Sughosh Ganu wrote:

...

The FWU Multi Bank Update feature supports updation of firmware images

s/updation/updating

Umm, is the current sentence wrong? The meaning of updation (as per google) is "the process of updating something."

...

to one of multiple sets(also called banks) of images. The firmware images are clubbed together in banks, with the system booting images from the active bank. Information on the images such as which bank they belong to is stored as part of the metadata structure, which is stored on the same storage media as the firmware images on a dedicated partition.

At the time of update, the metadata is read to identify the bank to which the images need to be flashed(update bank). On a successful update, the metadata is modified to set the updated bank as active bank to subsequently boot from.

Signed-off-by: Sughosh Ganu sughosh.ganu@linaro.org

Changes since V12: None

drivers/Kconfig | 2 + drivers/Makefile | 1 + include/fwu.h | 30 +++++ lib/Kconfig | 6 + lib/Makefile | 1 + lib/efi_loader/efi_capsule.c | 207 +++++++++++++++++++++++++++++++++- lib/efi_loader/efi_firmware.c | 14 +++ lib/fwu_updates/Kconfig | 33 ++++++ lib/fwu_updates/Makefile | 7 ++ lib/fwu_updates/fwu.c | 22 ++++ 10 files changed, 321 insertions(+), 2 deletions(-) create mode 100644 lib/fwu_updates/Kconfig create mode 100644 lib/fwu_updates/Makefile

diff --git a/drivers/Kconfig b/drivers/Kconfig index 8b6fead351..75ac149d31 100644 --- a/drivers/Kconfig +++ b/drivers/Kconfig @@ -44,6 +44,8 @@ source "drivers/fuzz/Kconfig"

source "drivers/fpga/Kconfig"

+source "drivers/fwu-mdata/Kconfig"

source "drivers/gpio/Kconfig"

source "drivers/hwspinlock/Kconfig" diff --git a/drivers/Makefile b/drivers/Makefile index 9d9f69a3c9..253cbfb71d 100644 --- a/drivers/Makefile +++ b/drivers/Makefile @@ -85,6 +85,7 @@ obj-y += cache/ obj-$(CONFIG_CPU) += cpu/ obj-y += crypto/ obj-$(CONFIG_FASTBOOT) += fastboot/ +obj-$(CONFIG_FWU_MDATA) += fwu-mdata/ obj-y += misc/ obj-$(CONFIG_MMC) += mmc/ obj-$(CONFIG_NVME) += nvme/ diff --git a/include/fwu.h b/include/fwu.h index 2effa7da38..b5c59dc161 100644 --- a/include/fwu.h +++ b/include/fwu.h @@ -60,6 +60,7 @@ struct fwu_mdata_ops { };

@@ -388,6 +395,130 @@ efi_status_t efi_capsule_authenticate(const void *capsule, efi_uintn_t capsule_s } #endif /* CONFIG_EFI_CAPSULE_AUTHENTICATE */

+static __maybe_unused bool fwu_empty_capsule(struct efi_capsule_header *capsule) +{

• return !guidcmp(&capsule->capsule_guid,
  

•                 &fwu_guid_os_request_fw_revert) ||
  

•         !guidcmp(&capsule->capsule_guid,
  

•                  &fwu_guid_os_request_fw_accept);
  

+}

+static __maybe_unused efi_status_t fwu_to_efi_error(int err) +{

• efi_status_t ret;
  

• switch(err) {
  

• case 0:
  

•         ret = EFI_SUCCESS;
  

•         break;
  

• case -ENODEV:
  

ENODEV should return EFI_INVALID_PARAMETER. The device was not found, EFI_DEVICE_ERROR usually means something bad happened to the device

Should this not be EFI_NOT_FOUND instead? I see it being used in places in the UEFI spec where a device is not found, for e.g. EFI_SD_MMC_PASS_THRU_PROTOCOL.BuildDevicePath.

-sughosh

...

• case -ERANGE:
  

• case -EIO:
  

•         ret = EFI_DEVICE_ERROR;
  

•         break;
  

• case -EINVAL:
  

•         ret = EFI_INVALID_PARAMETER;
  

•         break;
  

• default:
  

•         ret = EFI_OUT_OF_RESOURCES;
  

• }
  

• return ret;
  

+}

+static __maybe_unused efi_status_t fwu_empty_capsule_process(

• struct efi_capsule_header *capsule)
  

+{

• int status;
  

• u32 active_idx;
  

• efi_status_t ret;
  

• efi_guid_t *image_guid;
  

• if (!guidcmp(&capsule->capsule_guid,
  

•              &fwu_guid_os_request_fw_revert)) {
  

•         /*
  

•          * One of the previously updated image has
  

•          * failed the OS acceptance test. OS has
  

•          * requested to revert back to the earlier
  

•          * boot index
  

•          */
  

•         status = fwu_revert_boot_index();
  

•         ret = fwu_to_efi_error(status);
  

•         if (ret == EFI_SUCCESS)
  

•                 log_info("Reverted the FWU active_index. Recommend rebooting the system\n");
  

•         else
  

•                 log_err("Failed to revert the FWU boot index\n");
  

• } else {
  

We should be explicit on the GUID checking here. IOW if someone hands you over and empty capsule with a guid !fwu_guid_os_request_fw_revert you'll accept the capsule

...

•         /*
  

•          * Image accepted by the OS. Set the acceptance
  

•          * status for the image.
  

•          */
  

•         image_guid = (void *)(char *)capsule +
  

•                 capsule->header_size;
  

•         status = fwu_get_active_index(&active_idx);
  

•         ret = fwu_to_efi_error(status);
  

•         if (ret != EFI_SUCCESS) {
  

•                 log_err("Unable to get the active_index from the FWU metadata\n");
  

•                 return ret;
  

•         }
  

•         status = fwu_accept_image(image_guid, active_idx);
  

•         ret = fwu_to_efi_error(status);
  

•         if (ret != EFI_SUCCESS)
  

•                 log_err("Unable to set the Accept bit for the image %pUs\n",
  

•                         image_guid);
  

• }
  

• return ret;
  

+}

+static __maybe_unused void fwu_post_update_checks(

• struct efi_capsule_header *capsule,
  

• bool *fw_accept_os, bool *capsule_update)
  

+{

• if (fwu_empty_capsule(capsule))
  

•         *capsule_update = false;
  

• else
  

•         if (!*fw_accept_os)
  

This line should fold to the upper one

...

•                 *fw_accept_os =
  

•                         capsule->flags & FW_ACCEPT_OS ? true : false;
  

+}

+static __maybe_unused efi_status_t fwu_post_update_process(bool fw_accept_os) +{

• int status;
  

• u32 update_index;
  

• efi_status_t ret;
  

• status = fwu_plat_get_update_index(&update_index);
  

• if (status < 0) {
  

•         log_err("Failed to get the FWU update_index value\n");
  

•         return EFI_DEVICE_ERROR;
  

• }
  

• /*
  

•  * All the capsules have been updated successfully,
  

•  * update the FWU metadata.
  

•  */
  

• log_debug("Update Complete. Now updating active_index to %u\n",
  

•           update_index);
  

• status = fwu_set_active_index(update_index);
  

• ret = fwu_to_efi_error(status);
  

• if (ret != EFI_SUCCESS) {
  

•         log_err("Failed to update FWU metadata index values\n");
  

• } else {
  

•         log_debug("Successfully updated the active_index\n");
  

[...]

Thanks /Ilias