On Fri, 26 Aug 2022 at 11:57, Sughosh Ganu sughosh.ganu@linaro.org wrote:

Add bindings needed for accessing the FWU metadata partitions. These include the compatible string which point to the access method and the actual device which stores the FWU metadata.

The current patch adds basic bindings needed for accessing the metadata structure on GPT partitioned block devices.

Signed-off-by: Sughosh Ganu sughosh.ganu@linaro.org Reviewed-by: Heinrich Schuchardt xypron.glpk@gmx.de

---

Changes since V8: None

.../firmware/fwu-mdata-gpt.yaml | 32 +++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 doc/device-tree-bindings/firmware/fwu-mdata-gpt.yaml

Acked-by: Etienne Carriere etienne.carriere@linaro.org

diff --git a/doc/device-tree-bindings/firmware/fwu-mdata-gpt.yaml b/doc/device-tree-bindings/firmware/fwu-mdata-gpt.yaml new file mode 100644 index 0000000000..0735191ff1 --- /dev/null +++ b/doc/device-tree-bindings/firmware/fwu-mdata-gpt.yaml @@ -0,0 +1,32 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/firmware/fwu-mdata-gpt.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml#

+title: FWU metadata on device with GPT partitioned layout

+maintainers:

• • Sughosh Ganu sughosh.ganu@linaro.org

+properties:

• compatible:
• items:

•  - const: u-boot,fwu-mdata-gpt
  

• fwu-mdata-store:
• maxItems: 1
• description: Phandle of the device which contains the FWU medatata partition.

+required:

• • compatible
• • fwu-mdata-store

+additionalProperties: false

+examples:

• • |
• fwu-mdata {

•    compatible = "u-boot,fwu-mdata-gpt";
  

•    fwu-mdata-store = <&sdmmc1>;
  

• };

-- 2.34.1

On Fri, 26 Aug 2022 at 11:57, Sughosh Ganu sughosh.ganu@linaro.org 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

---

Changes since V8:

• Declare the metadata struct on the stack rather than heap
• Move the API's to fwu.c and only keep the DM ops in the uclass driver
• Fix return codes as suggested by Simon
• Change log_err to log_debug as suggested by Simon
• Remove the __packed attribute on the metadata structures as suggested by Simon
• Add comments to the API functions

Reviewed-by: Etienne Carriere etienne.carriere@linaro.org

drivers/fwu-mdata/fwu-mdata-uclass.c | 107 ++++++++ include/dm/uclass-id.h | 1 + include/fwu.h | 210 ++++++++++++++++ include/fwu_mdata.h | 67 +++++ lib/fwu_updates/fwu.c | 357 +++++++++++++++++++++++++++ 5 files changed, 742 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..65ae93c21f --- /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 bad 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->mdata_check) {
  

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

•           return -ENOSYS;
  

•   }
  

•   return ops->mdata_check(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..2335981d28 --- /dev/null +++ b/include/fwu.h @@ -0,0 +1,210 @@ +/* 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 {

•   /**
  

•    * mdata_check() - 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 bad copy.
  

•    *
  

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

•    */
  

•   int (*mdata_check)(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);
  

•   /**
  

•    * fwu_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(u32 *active_idxp);

+/**

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

+int fwu_update_active_index(uint active_idx);

+/**

• • fwu_get_image_alt_num() - Get the dfu alt number to be used for capsule update
• • @image_type_id: pointer to the image GUID as passed in the capsule
• • @update_bank: Bank to which the update is to be made
• • @alt_num: The alt_num for the image
• • Based on the GUID value passed in the capsule, along with the bank to which the
• • image needs to be updated, get the dfu alt number which will be used for the
• • capsule update
• • Return: 0 if OK, -ve on error
• */

+int fwu_get_image_alt_num(efi_guid_t *image_type_id, u32 update_bank,

•                     int *alt_num);
  

+/**

• • 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 bad 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..a871d77b4c --- /dev/null +++ b/lib/fwu_updates/fwu.c @@ -0,0 +1,357 @@ +// 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>

+#define IMAGE_ACCEPT_SET BIT(0) +#define IMAGE_ACCEPT_CLEAR BIT(1)

+static int fwu_get_dev(struct udevice **dev)

+{

•   int ret;
  

•   ret = uclass_first_device(UCLASS_FWU_MDATA, dev);
  

•   if (ret) {
  

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

•           return ret;
  

•   }
  

•   return 0;
  

+}

+/**

• • 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(u32 *active_idx) +{

•   int ret;
  

•   struct udevice *dev;
  

•   struct fwu_mdata mdata = { 0 };
  

•   ret = fwu_get_dev(&dev);
  

•   if (ret)
  

•           return ret;
  

•   ret = fwu_get_mdata(dev, &mdata);
  

•   if (ret < 0) {
  

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

•           goto out;
  

•   }
  

•   /*
  

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

•   }
  

+out:

•   return ret;
  

+}

+/**

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

+int fwu_update_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(&dev);
  

•   if (ret)
  

•           return ret;
  

•   ret = fwu_get_mdata(dev, &mdata);
  

•   if (ret < 0) {
  

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

•           goto out;
  

•   }
  

•   /*
  

•    * 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 < 0) {
  

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

•           ret = -EIO;
  

•   }
  

+out:

•   return ret;
  

+}

+/**

• • fwu_get_image_alt_num() - Get the dfu alt number to be used for capsule update
• • @image_type_id: pointer to the image GUID as passed in the capsule
• • @update_bank: Bank to which the update is to be made
• • @alt_num: The alt_num for the image
• • Based on the GUID value passed in the capsule, along with the bank to which the
• • image needs to be updated, get the dfu alt number which will be used for the
• • capsule update
• • Return: 0 if OK, -ve on error
• */

+int fwu_get_image_alt_num(efi_guid_t *image_type_id, u32 update_bank,

•                     int *alt_num)
  

+{

•   int ret, i;
  

•   efi_guid_t *image_guid;
  

•   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(&dev);
  

•   if (ret)
  

•           return ret;
  

•   ret = fwu_get_mdata(dev, &mdata);
  

•   if (ret) {
  

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

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

•                   }
  

•                   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(&dev);
  

•   if (ret)
  

•           return ret;
  

•   ret = fwu_get_mdata(dev, &mdata);
  

•   if (ret < 0) {
  

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

•           goto out;
  

•   }
  

•   /*
  

•    * 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 < 0) {
  

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

•           ret = -EIO;
  

•   }
  

+out:

•   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(&dev);
  

•   if (ret)
  

•           return ret;
  

•   ret = fwu_get_mdata(dev, &mdata);
  

•   if (ret < 0) {
  

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

•           goto out;
  

•   }
  

•   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

hi Ilias,

On Wed, 7 Sept 2022 at 12:15, Ilias Apalodimas ilias.apalodimas@linaro.org wrote:

Hi Sughosh,

On Fri, Aug 26, 2022 at 03:27:03PM +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

---

Changes since V8:

• Declare the metadata struct on the stack rather than heap
• Move the API's to fwu.c and only keep the DM ops in the uclass driver
• Fix return codes as suggested by Simon
• Change log_err to log_debug as suggested by Simon
• Remove the __packed attribute on the metadata structures as suggested by Simon
• Add comments to the API functions

drivers/fwu-mdata/fwu-mdata-uclass.c | 107 ++++++++ include/dm/uclass-id.h | 1 + include/fwu.h | 210 ++++++++++++++++ include/fwu_mdata.h | 67 +++++ lib/fwu_updates/fwu.c | 357 +++++++++++++++++++++++++++ 5 files changed, 742 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

<snip>

...

diff --git a/lib/fwu_updates/fwu.c b/lib/fwu_updates/fwu.c new file mode 100644 index 0000000000..a871d77b4c --- /dev/null +++ b/lib/fwu_updates/fwu.c @@ -0,0 +1,357 @@ +// 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>

+#define IMAGE_ACCEPT_SET BIT(0) +#define IMAGE_ACCEPT_CLEAR BIT(1)

+static int fwu_get_dev(struct udevice **dev)

+{

• int ret;
  

• ret = uclass_first_device(UCLASS_FWU_MDATA, dev);
  

• if (ret) {
  

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

•         return ret;
  

• }
  

• return 0;
  

+}

+/**

• • 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(u32 *active_idx) +{

• int ret;
  

• struct udevice *dev;
  

• struct fwu_mdata mdata = { 0 };
  

• ret = fwu_get_dev(&dev);
  

• if (ret)
  

•         return ret;
  

• ret = fwu_get_mdata(dev, &mdata);
  

• if (ret < 0) {
  

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

•         goto out;
  

• }
  

This pattern is repeated on the entire patch. Moreover the struct udevice *dev is seems only needed for calling fwu_get_mdata(). So is there any reason why can we can't change fwu_get_mdata() and fold in the fwu_get_dev()?

Sure, I will move the fetching of the device to fwu_get_mdata(). Will also remove the braces as per your other review comment. Thanks.

-sughosh

...

• /*
  

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

• }
  

+out:

• return ret;
  

+}

+/**

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

+int fwu_update_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(&dev);
  

• if (ret)
  

•         return ret;
  

• ret = fwu_get_mdata(dev, &mdata);
  

• if (ret < 0) {
  

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

•         goto out;
  

• }
  

• /*
  

•  * 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 < 0) {
  

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

•         ret = -EIO;
  

• }
  

+out:

• return ret;
  

+}

+/**

• • fwu_get_image_alt_num() - Get the dfu alt number to be used for capsule update
• • @image_type_id: pointer to the image GUID as passed in the capsule
• • @update_bank: Bank to which the update is to be made
• • @alt_num: The alt_num for the image
• • Based on the GUID value passed in the capsule, along with the bank to which the
• • image needs to be updated, get the dfu alt number which will be used for the
• • capsule update
• • Return: 0 if OK, -ve on error
• */

+int fwu_get_image_alt_num(efi_guid_t *image_type_id, u32 update_bank,

•                   int *alt_num)
  

+{

• int ret, i;
  

• efi_guid_t *image_guid;
  

• 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(&dev);
  

• if (ret)
  

•         return ret;
  

• ret = fwu_get_mdata(dev, &mdata);
  

• if (ret) {
  

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

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

•                 }
  

Nit you don't need {}

...

•                 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(&dev);
  

• if (ret)
  

•         return ret;
  

• ret = fwu_get_mdata(dev, &mdata);
  

• if (ret < 0) {
  

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

•         goto out;
  

• }
  

• /*
  

•  * 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 < 0) {
  

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

•         ret = -EIO;
  

• }
  

+out:

• 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(&dev);
  

• if (ret)
  

•         return ret;
  

• ret = fwu_get_mdata(dev, &mdata);
  

• if (ret < 0) {
  

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

•         goto out;
  

• }
  

• 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

Thanks /Ilias

Hi Sughosh,

Reviewed-by: Etienne Carriere etienne.carriere@linaro.org with comment addressed.

On Fri, 26 Aug 2022 at 11:57, Sughosh Ganu sughosh.ganu@linaro.org 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 formated with GPT based partition scheme.

formatted

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

---

Changes since V8:

• Rename fwu_mdata_gpt_blk.c as gpt_blk.c as suggested by Simon
• Use natural integer types instead of specific width integers as suggested by Simon
• Fix return codes as suggested by Simon
• Code cleanup of some superfluous error checks, like for dev_get_uclass_plat() function
• Use blk_get_from_parent() for getting the parent of the block device containing the FWU metadata
• Add comments to the API functions

drivers/fwu-mdata/Kconfig | 16 ++ drivers/fwu-mdata/Makefile | 8 + drivers/fwu-mdata/gpt_blk.c | 378 ++++++++++++++++++++++++++++++++++++ include/fwu.h | 4 + 4 files changed, 406 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..7322da48b1 --- /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 DM && HAVE_BLOCK_DEVICE && 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..4f0558825b --- /dev/null +++ b/drivers/fwu-mdata/gpt_blk.c @@ -0,0 +1,378 @@ +// 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 *primary_mpart,
  

•                               uint *secondary_mpart)
  

+{

•   int i, ret;
  

•   u32 mdata_parts;
  

•   efi_guid_t part_type_guid;
  

•   struct disk_partition info;
  

•   const efi_guid_t fwu_mdata_guid = FWU_MDATA_GUID;
  

•   mdata_parts = 0;
  

•   for (i = 1; i < MAX_SEARCH_PARTITIONS; 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;
  

•                   if (!*primary_mpart)
  

•                           *primary_mpart = i;
  

•                   else
  

•                           *secondary_mpart = i;
  

•           }
  

•   }
  

•   if (mdata_parts != 2) {
  

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

•                     mdata_parts);
  

•           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",
  

missing terminal '\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;
  

+}

+static int gpt_read_write_mdata(struct blk_desc *desc,

•                           struct fwu_mdata *mdata,
  

•                           u8 access, u32 part_num)
  

+{

•   int ret;
  

•   u32 len, blk_start, blkcnt;
  

•   struct disk_partition info;
  

•   ALLOC_CACHE_ALIGN_BUFFER_PAD(struct fwu_mdata, mdata_aligned, 1,
  

•                                desc->blksz);
  

•   ret = gpt_get_mdata_disk_part(desc, &info, part_num);
  

•   if (ret < 0) {
  

•           printf("Unable to get the FWU metadata partition\n");
  

•           return -ENOENT;
  

•   }
  

•   len = sizeof(*mdata);
  

•   blkcnt = BLOCK_CNT(len, desc);
  

•   if (blkcnt > info.size) {
  

•           log_debug("Block count exceeds FWU metadata partition size\n");
  

•           return -ERANGE;
  

•   }
  

•   blk_start = info.start;
  

•   if (access == MDATA_READ) {
  

•           if (blk_dread(desc, blk_start, blkcnt, mdata_aligned) != blkcnt) {
  

•                   log_debug("Error reading FWU metadata from the device\n");
  

•                   return -EIO;
  

•           }
  

•           memcpy(mdata, mdata_aligned, sizeof(struct fwu_mdata));
  

•   } else {
  

•           if (blk_dwrite(desc, blk_start, blkcnt, mdata) != blkcnt) {
  

•                   log_debug("Error writing FWU metadata to the device\n");
  

•                   return -EIO;
  

•           }
  

•   }
  

•   return 0;
  

+}

+static int gpt_read_mdata(struct blk_desc *desc,

•                     struct fwu_mdata *mdata, u32 part_num)
  

+{

•   return gpt_read_write_mdata(desc, mdata, MDATA_READ, part_num);
  

+}

+static int gpt_write_mdata_partition(struct blk_desc *desc,

•                                   struct fwu_mdata *mdata,
  

•                                   u32 part_num)
  

+{

•   return gpt_read_write_mdata(desc, mdata, MDATA_WRITE, part_num);
  

+}

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

•   int ret;
  

•   struct blk_desc *desc;
  

•   uint primary_mpart = 0, secondary_mpart = 0;
  

•   struct fwu_mdata_gpt_blk_priv *priv = dev_get_priv(dev);
  

•   desc = dev_get_uclass_plat(priv->blk_dev);
  

•   ret = gpt_get_mdata_partitions(desc, &primary_mpart,
  

•                                  &secondary_mpart);
  

•   if (ret < 0) {
  

•           log_debug("Error getting the FWU metadata partitions\n");
  

•           return -ENOENT;
  

•   }
  

•   /* First write the primary partition */
  

•   ret = gpt_write_mdata_partition(desc, mdata, primary_mpart);
  

•   if (ret < 0) {
  

•           log_debug("Updating primary FWU metadata partition failed\n");
  

•           return ret;
  

•   }
  

•   /* And now the replica */
  

•   ret = gpt_write_mdata_partition(desc, mdata, secondary_mpart);
  

•   if (ret < 0) {
  

•           log_debug("Updating secondary FWU metadata partition failed\n");
  

•           return ret;
  

•   }
  

•   return 0;
  

+}

+static int gpt_get_mdata(struct blk_desc *desc, struct fwu_mdata *mdata) +{

•   int ret;
  

•   uint primary_mpart = 0, secondary_mpart = 0;
  

•   ret = gpt_get_mdata_partitions(desc, &primary_mpart,
  

•                                  &secondary_mpart);
  

•   if (ret < 0) {
  

•           log_debug("Error getting the FWU metadata partitions\n");
  

•           return -ENOENT;
  

•   }
  

•   ret = gpt_read_mdata(desc, mdata, primary_mpart);
  

•   if (ret < 0) {
  

•           log_debug("Failed to read the FWU metadata from the device\n");
  

•           return -EIO;
  

•   }
  

•   ret = fwu_verify_mdata(mdata, 1);
  

•   if (!ret)
  

•           return 0;
  

•   /*
  

•    * Verification of the primary FWU metadata copy failed.
  

•    * Try to read the replica.
  

•    */
  

•   memset(mdata, '\0', sizeof(struct fwu_mdata));
  

•   ret = gpt_read_mdata(desc, mdata, secondary_mpart);
  

•   if (ret < 0) {
  

•           log_debug("Failed to read the FWU metadata from the device\n");
  

•           return -EIO;
  

•   }
  

•   ret = fwu_verify_mdata(mdata, 0);
  

•   if (!ret)
  

•           return 0;
  

•   /* Both the FWU metadata copies are corrupted. */
  

•   return -EIO;
  

+}

+static int gpt_check_mdata_validity(struct udevice *dev) +{

•   int ret;
  

•   struct blk_desc *desc;
  

•   struct fwu_mdata pri_mdata;
  

•   struct fwu_mdata secondary_mdata;
  

•   uint primary_mpart = 0, secondary_mpart = 0;
  

•   uint valid_partitions, invalid_partitions;
  

•   struct fwu_mdata_gpt_blk_priv *priv = dev_get_priv(dev);
  

•   desc = dev_get_uclass_plat(priv->blk_dev);
  

•   /*
  

•    * Two FWU metadata partitions are expected.
  

•    * If we don't have two, user needs to create
  

•    * them first
  

•    */
  

•   valid_partitions = 0;
  

•   ret = gpt_get_mdata_partitions(desc, &primary_mpart,
  

•                                  &secondary_mpart);
  

•   if (ret < 0) {
  

•           log_debug("Error getting the FWU metadata partitions\n");
  

•           return -ENOENT;
  

•   }
  

•   ret = gpt_read_mdata(desc, &pri_mdata, primary_mpart);
  

•   if (ret < 0) {
  

•           log_debug("Failed to read the FWU metadata from the device\n");
  

•           goto secondary_read;
  

•   }
  

•   ret = fwu_verify_mdata(&pri_mdata, 1);
  

•   if (!ret)
  

•           valid_partitions |= PRIMARY_PART;
  

+secondary_read:

•   /* Now check the secondary partition */
  

•   ret = gpt_read_mdata(desc, &secondary_mdata, secondary_mpart);
  

•   if (ret < 0) {
  

•           log_debug("Failed to read the FWU metadata from the device\n");
  

•           goto mdata_restore;
  

•   }
  

•   ret = fwu_verify_mdata(&secondary_mdata, 0);
  

•   if (!ret)
  

•           valid_partitions |= SECONDARY_PART;
  

+mdata_restore:

•   if (valid_partitions == (PRIMARY_PART | SECONDARY_PART)) {
  

•           ret = -1;
  

•           /*
  

•            * Before returning, check that both the
  

•            * FWU metadata copies are the same. If not,
  

•            * the FWU metadata copies need to be
  

•            * re-populated.
  

•            */
  

•           if (!memcmp(&pri_mdata, &secondary_mdata,
  

•                       sizeof(struct fwu_mdata))) {
  

•                   ret = 0;
  

•           } else {
  

•                   log_debug("Both FWU metadata copies are valid but do not match. Please check!\n");
  

•           }
  

•           goto out;
  

•   }
  

•   ret = -1;
  

•   if (!(valid_partitions & BOTH_PARTS))
  

•           goto out;
  

•   invalid_partitions = valid_partitions ^ BOTH_PARTS;
  

•   ret = gpt_write_mdata_partition(desc,
  

•                                   (invalid_partitions == PRIMARY_PART) ?
  

•                                   &secondary_mdata : &pri_mdata,
  

•                                   (invalid_partitions == PRIMARY_PART) ?
  

•                                   primary_mpart : secondary_mpart);
  

•   if (ret < 0)
  

•           log_debug("Restoring %s FWU metadata partition failed\n",
  

•                     (invalid_partitions == PRIMARY_PART) ?
  

•                     "primary" : "secondary");
  

+out:

•   return ret;
  

+}

+static int fwu_gpt_mdata_check(struct udevice *dev) +{

•   /*
  

•    * Check if both the copies of the FWU
  

•    * metadata are valid. If one has gone
  

•    * bad, restore it from the other good
  

•    * copy.
  

•    */
  

•   return gpt_check_mdata_validity(dev);
  

+}

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

•   struct fwu_mdata_gpt_blk_priv *priv = dev_get_priv(dev);
  

•   return gpt_get_mdata(dev_get_uclass_plat(priv->blk_dev), mdata);
  

+}

+static int fwu_get_mdata_device(struct udevice *dev, struct udevice **mdata_dev) +{

•   u32 phandle;
  

•   int ret, size;
  

•   struct udevice *parent;
  

•   const fdt32_t *phandle_p = NULL;
  

•   phandle_p = dev_read_prop(dev, "fwu-mdata-store", &size);
  

•   if (!phandle_p) {
  

•           log_debug("fwu-mdata-store property not found\n");
  

•           return -ENOENT;
  

•   }
  

•   phandle = fdt32_to_cpu(*phandle_p);
  

•   ret = device_get_global_by_ofnode(ofnode_get_by_phandle(phandle),
  

•                                     &parent);
  

•   if (ret)
  

•           return ret;
  

•   return blk_get_from_parent(parent, mdata_dev);
  

+}

+static int fwu_mdata_gpt_blk_probe(struct udevice *dev) +{

•   int ret;
  

•   struct udevice *mdata_dev = NULL;
  

•   struct fwu_mdata_gpt_blk_priv *priv = dev_get_priv(dev);
  

•   ret = fwu_get_mdata_device(dev, &mdata_dev);
  

•   if (ret)
  

•           return ret;
  

•   priv->blk_dev = mdata_dev;
  

•   return 0;
  

+}

+static const struct fwu_mdata_ops fwu_gpt_blk_ops = {

•   .mdata_check = fwu_gpt_mdata_check,
  

•   .get_mdata = fwu_gpt_get_mdata,
  

•   .update_mdata = fwu_gpt_update_mdata,
  

+};

+static const struct udevice_id fwu_mdata_ids[] = {

•   { .compatible = "u-boot,fwu-mdata-gpt" },
  

•   { }
  

+};

+U_BOOT_DRIVER(fwu_mdata_gpt_blk) = {

•   .name           = "fwu-mdata-gpt-blk",
  

•   .id             = UCLASS_FWU_MDATA,
  

•   .of_match       = fwu_mdata_ids,
  

•   .ops            = &fwu_gpt_blk_ops,
  

•   .probe          = fwu_mdata_gpt_blk_probe,
  

•   .priv_auto      = sizeof(struct fwu_mdata_gpt_blk_priv),
  

+}; diff --git a/include/fwu.h b/include/fwu.h index 2335981d28..ecabf11210 100644 --- a/include/fwu.h +++ b/include/fwu.h @@ -14,6 +14,10 @@ struct fwu_mdata; struct udevice;

+struct fwu_mdata_gpt_blk_priv {

•   struct udevice *blk_dev;
  

+};

/**

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

-- 2.34.1

Hello Sughosh,

On Fri, 26 Aug 2022 at 11:57, Sughosh Ganu sughosh.ganu@linaro.org wrote:

Enabling capsule update functionality on the platform requires populating information on the images that are to be updated using the functionality. Do so for the DK2 board.

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

Changes since V8:

• Use STM32MP_FIP_IMAGE_GUID for the FIP GUID value as suggested by Yann

board/st/stm32mp1/stm32mp1.c | 23 +++++++++++++++++++++++ include/configs/stm32mp15_common.h | 4 ++++ 2 files changed, 27 insertions(+)

diff --git a/board/st/stm32mp1/stm32mp1.c b/board/st/stm32mp1/stm32mp1.c index 9496890d16..bfec0a710d 100644 --- a/board/st/stm32mp1/stm32mp1.c +++ b/board/st/stm32mp1/stm32mp1.c @@ -11,6 +11,7 @@ #include <clk.h> #include <config.h> #include <dm.h> +#include <efi_loader.h> #include <env.h> #include <env_internal.h> #include <fdt_simplefb.h> @@ -87,6 +88,16 @@ #define USB_START_LOW_THRESHOLD_UV 1230000 #define USB_START_HIGH_THRESHOLD_UV 2150000

+#if CONFIG_IS_ENABLED(EFI_HAVE_CAPSULE_SUPPORT) +struct efi_fw_image fw_images[1];

+struct efi_capsule_update_info update_info = {

•   .images = fw_images,
  

+};

+u8 num_image_type_guids = ARRAY_SIZE(fw_images); +#endif /* EFI_HAVE_CAPSULE_SUPPORT */

int board_early_init_f(void) { /* nothing to do, only used in SPL */ @@ -670,6 +681,18 @@ int board_init(void)

    setup_led(LEDST_ON);

+#if CONFIG_IS_ENABLED(EFI_HAVE_CAPSULE_SUPPORT)

•   if (board_is_stm32mp15x_dk2()) {
  

Sorry for this late comment. Should this be restricted to mp15-dk2? I would remove the test and apply when CONFIG_EFI_HAVE_CAPSULE_SUPPORT is enable.

•           efi_guid_t image_type_guid = STM32MP_FIP_IMAGE_GUID;
  

•           guidcpy(&fw_images[0].image_type_id, &image_type_guid);
  

•           fw_images[0].fw_name = u"STM32MP-FIP";
  

•           /*
  

•            * For FWU multi bank update, the image
  

•            * index will be computed at runtime
  

•            */
  

•           fw_images[0].image_index = 0;
  

•   }
  

+#endif return 0; }

diff --git a/include/configs/stm32mp15_common.h b/include/configs/stm32mp15_common.h index c5412ffeb3..bb19dae945 100644 --- a/include/configs/stm32mp15_common.h +++ b/include/configs/stm32mp15_common.h @@ -34,6 +34,10 @@ #define CONFIG_SERVERIP 192.168.1.1 #endif

+#define STM32MP_FIP_IMAGE_GUID \

•   EFI_GUID(0x19d5df83, 0x11b0, 0x457b, 0xbe, 0x2c, \
  

•            0x75, 0x59, 0xc1, 0x31, 0x42, 0xa5)
  

/*****************************************************************************/ #ifdef CONFIG_DISTRO_DEFAULTS /*****************************************************************************/ -- 2.34.1

On Fri, Aug 26, 2022 at 03:27:07PM +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

---

Changes since V8:

• Add comments for API functions
• Update the logic to get the update index as suggested by Jassi

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

diff --git a/include/fwu.h b/include/fwu.h index ecabf11210..7ebd3a7115 100644 --- a/include/fwu.h +++ b/include/fwu.h @@ -211,4 +211,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,

• 	 int *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 a871d77b4c..94b15859a5 100644 --- a/lib/fwu_updates/fwu.c +++ b/lib/fwu_updates/fwu.c @@ -355,3 +355,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..a3134b80c9 --- /dev/null +++ b/lib/fwu_updates/fwu_gpt.c @@ -0,0 +1,115 @@ +// 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_gpt_get_alt_num(struct blk_desc *desc, efi_guid_t *image_guid,

• 	       int *alt_num, unsigned char dfu_dev)
  

+{

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

• return -ENOENT;
  

• dfu_init_env_entities(NULL, NULL);
• nalt = 0;
• list_for_each_entry(dfu, &dfu_list, list) {

• nalt++;
  

• }