| Message ID | 20220609123010.1017463-16-sughosh.ganu@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | FWU: Add FWU Multi Bank Update feature support | expand |
On Thu, 9 Jun 2022 at 14:31, Sughosh Ganu <sughosh.ganu@linaro.org> wrote: > > From: Masami Hiramatsu <masami.hiramatsu@linaro.org> > > Add 'mkfwumdata' tool which can generate an image of the FWU metadata > which is required for initializing the platform. > > Usage: > mkfwumdata -i NR_IMAGES -b NR_BANKS [--guid] \ > LOCATION_UUID0,IMAGE_TYPE_UUID0,BANK0_IMAGE_UUID[,BANK1_IMAGE_UUID[,...]] \ > LOCATION_UUID1,... \ > IMAGE_FILE > > '-i' takes the number of images and '-b' takes the number of > banks. This takes lists of uuids for the images on arguments, > and the last argument must be the output image file name. > > '--guid' (or '-g' in short) allows user to specify the location UUID > and image IDs in GUID instead of UUID. This option is useful if the > platform uses GPT partiotion. In this case, the UUID list > (for an image) becomes; > > DiskGUID,ParitionTypeGUID,UniquePartitionGUID,... > > Signed-off-by: Masami Hiramatsu <masami.hiramatsu@linaro.org> > Signed-off-by: Sughosh Ganu <sughosh.ganu@linaro.org> > --- > tools/Kconfig | 9 ++ > tools/Makefile | 4 + > tools/mkfwumdata.c | 298 +++++++++++++++++++++++++++++++++++++++++++++ > 3 files changed, 311 insertions(+) > create mode 100644 tools/mkfwumdata.c > > diff --git a/tools/Kconfig b/tools/Kconfig > index 117c921da3..3484be99d0 100644 > --- a/tools/Kconfig > +++ b/tools/Kconfig > @@ -98,4 +98,13 @@ config TOOLS_MKEFICAPSULE > optionally sign that file. If you want to enable UEFI capsule > update feature on your target, you certainly need this. > > +config TOOLS_MKFWUMDATA > + bool "Build mkfwumdata command" > + default y if FWU_MULTI_BANK_UPDATE > + help > + This command allows users to create a raw image of the FWU > + metadata for initial installation of the FWU multi bank > + update on the board. The installation method depends on > + the platform. > + > endmenu > diff --git a/tools/Makefile b/tools/Makefile > index 9f2339666a..cd39e5ff6f 100644 > --- a/tools/Makefile > +++ b/tools/Makefile > @@ -245,6 +245,10 @@ HOSTCFLAGS_asn1_compiler.o = -idirafter $(srctree)/include > HOSTLDLIBS_mkeficapsule += -lgnutls -luuid > hostprogs-$(CONFIG_TOOLS_MKEFICAPSULE) += mkeficapsule > > +mkfwumdata-objs := mkfwumdata.o lib/crc32.o > +HOSTLDLIBS_mkfwumdata += -luuid > +hostprogs-$(CONFIG_TOOLS_MKFWUMDATA) += mkfwumdata > + > # We build some files with extra pedantic flags to try to minimize things > # that won't build on some weird host compiler -- though there are lots of > # exceptions for files that aren't complaint. > diff --git a/tools/mkfwumdata.c b/tools/mkfwumdata.c > new file mode 100644 > index 0000000000..4eb304cae3 > --- /dev/null > +++ b/tools/mkfwumdata.c > @@ -0,0 +1,298 @@ > +// SPDX-License-Identifier: GPL-2.0+ > + > +#include <errno.h> > +#include <getopt.h> > +#include <stdio.h> > +#include <stdint.h> > +#include <stdlib.h> > +#include <string.h> > +#include <u-boot/crc.h> > +#include <unistd.h> > +#include <uuid/uuid.h> > + > +/* This will dynamically allocate the fwu_mdata */ > +#define CONFIG_FWU_NUM_BANKS 0 > +#define CONFIG_FWU_NUM_IMAGES_PER_BANK 0 > + > +/* Since we can not include fwu.h, redefine version here. */ > +#define FWU_MDATA_VERSION 1 > + > +typedef uint8_t u8; > +typedef int16_t s16; > +typedef uint16_t u16; > +typedef uint32_t u32; > +typedef uint64_t u64; > + > +#include <fwu_mdata.h> > + > +/* TODO: Endianess conversion may be required for some arch. */ > + > +static const char *opts_short = "b:i:a:gh"; > + > +static struct option options[] = { > + {"banks", required_argument, NULL, 'b'}, > + {"images", required_argument, NULL, 'i'}, > + {"guid", required_argument, NULL, 'g'}, > + {"active-bank", required_argument, NULL, 'a'}, > + {"help", no_argument, NULL, 'h'}, > + {NULL, 0, NULL, 0}, > +}; > + > +static void print_usage(void) > +{ > + fprintf(stderr, "Usage: mkfwumdata [options] <UUIDs list> [<UUIDs list>...] <output file>\n"); > + fprintf(stderr, "Options:\n" > + "\t-i, --images <num> Number of images\n" > + "\t-b, --banks <num> Number of banks\n" > + "\t-a, --active-bank <num> Active bank\n" > + "\t-g, --guid Use GUID instead of UUID\n" > + "\t-h, --help print a help message\n" > + ); > + fprintf(stderr, "UUIDs list syntax:\n" > + "\t<location uuid>,<image type uuid>,<image uuid>[,<image uuid>]\n" > + "\n\tYou must specify # of banks of image-uuid and # of images of the lists.\n" It's not really explicit how many ',<image uuid>' occurrences are needed. Maybe: In a <UUIDs list> item, there must be as many <image uuid> occurrences as the given number of banks. There must be as many <UUIDs list> items as the given number of images. > + "\tIf the location uuid and image uuid are '0', those are filled with null uuid.\n" > + ); > +} > + > +static bool __use_guid; > +static u32 active_bank; > + > +struct fwu_mdata_object { > + size_t images; > + size_t banks; > + size_t size; > + struct fwu_mdata *mdata; > +}; > + > +struct fwu_mdata_object *fwu_alloc_mdata(size_t images, size_t banks) > +{ > + struct fwu_mdata_object *mobj; > + > + mobj = malloc(sizeof(*mobj)); calloc()? > + if (!mobj) > + return NULL; > + mobj->size = sizeof(struct fwu_mdata) + > + (sizeof(struct fwu_image_entry) + > + sizeof(struct fwu_image_bank_info) * banks) * images; > + mobj->images = images; > + mobj->banks = banks; > + mobj->mdata = malloc(mobj->size); calloc()? > + if (!mobj->mdata) { > + free(mobj); > + return NULL; > + } > + memset(mobj->mdata, 0, mobj->size); > + > + return mobj; > +} > + > +struct fwu_image_entry *fwu_get_image(struct fwu_mdata_object *mobj, size_t idx) > +{ > + size_t offset; > + > + offset = sizeof(struct fwu_mdata) + > + (sizeof(struct fwu_image_entry) + > + sizeof(struct fwu_image_bank_info) * mobj->banks) * idx; > + > + return (struct fwu_image_entry *)((char *)mobj->mdata + offset); > +} > + > +struct fwu_image_bank_info *fwu_get_bank(struct fwu_mdata_object *mobj, > + size_t img_idx, size_t bnk_idx) > +{ > + size_t offset; > + > + offset = sizeof(struct fwu_mdata) + > + (sizeof(struct fwu_image_entry) + > + sizeof(struct fwu_image_bank_info) * mobj->banks) * img_idx + > + sizeof(struct fwu_image_entry) + > + sizeof(struct fwu_image_bank_info) * bnk_idx; > + > + return (struct fwu_image_bank_info *)((char *)mobj->mdata + offset); > +} > + > +/** > + * convert_uuid_to_guid() - convert UUID to GUID > + * @buf: UUID binary > + * > + * UUID and GUID have the same data structure, but their binary > + * formats are different due to the endianness. See lib/uuid.c. > + * Since uuid_parse() can handle only UUID, this function must > + * be called to get correct data for GUID when parsing a string. > + * > + * The correct data will be returned in @buf. > + */ > +void convert_uuid_to_guid(unsigned char *buf) > +{ > + unsigned char c; > + > + c = buf[0]; > + buf[0] = buf[3]; > + buf[3] = c; > + c = buf[1]; > + buf[1] = buf[2]; > + buf[2] = c; > + > + c = buf[4]; > + buf[4] = buf[5]; > + buf[5] = c; > + > + c = buf[6]; > + buf[6] = buf[7]; > + buf[7] = c; > +} > + > +int uuid_guid_parse(char *uuidstr, unsigned char *uuid) > +{ > + int ret; > + > + ret = uuid_parse(uuidstr, uuid); > + if (ret < 0) > + return ret; > + > + if (__use_guid) > + convert_uuid_to_guid(uuid); > + > + return ret; > +} > + > +int fwu_parse_fill_image_uuid(struct fwu_mdata_object *mobj, > + size_t idx, char *uuids) > +{ > + struct fwu_image_entry *image = fwu_get_image(mobj, idx); > + struct fwu_image_bank_info *bank; > + char *p = uuids, *uuid; > + int i; > + > + if (!image) > + return -ENOENT; > + > + /* Image location UUID */ > + uuid = strsep(&p, ","); > + if (!uuid) > + return -EINVAL; > + > + if (strcmp(uuid, "0") && > + uuid_guid_parse(uuid, (unsigned char *)&image->location_uuid) < 0) > + return -EINVAL; > + > + /* Image type UUID */ > + uuid = strsep(&p, ","); > + if (!uuid) > + return -EINVAL; > + > + if (uuid_guid_parse(uuid, (unsigned char *)&image->image_type_uuid) < 0) > + return -EINVAL; > + > + /* Fill bank image-UUID */ > + for (i = 0; i < mobj->banks; i++) { > + bank = fwu_get_bank(mobj, idx, i); > + if (!bank) > + return -ENOENT; > + bank->accepted = 1; > + uuid = strsep(&p, ","); > + if (!uuid) > + return -EINVAL; > + > + if (strcmp(uuid, "0") && > + uuid_guid_parse(uuid, (unsigned char *)&bank->image_uuid) < 0) > + return -EINVAL; > + } > + return 0; > +} > + > +/* Caller must ensure that @uuids[] has @mobj->images entries. */ > +int fwu_parse_fill_uuids(struct fwu_mdata_object *mobj, char *uuids[]) > +{ > + struct fwu_mdata *mdata = mobj->mdata; > + int i, ret; > + > + mdata->version = FWU_MDATA_VERSION; > + mdata->active_index = active_bank; > + mdata->previous_active_index = active_bank ? 0 : > + (uint32_t)(mobj->banks - 1); This looks platform specific (see fwu_plat_get_update_index() is platform specific). Maybe a dedicated argument to this tool should define the alternate/previous active index. > + > + for (i = 0; i < mobj->images; i++) { > + ret = fwu_parse_fill_image_uuid(mobj, i, uuids[i]); > + if (ret < 0) > + return ret; > + } > + > + mdata->crc32 = crc32(0, (const unsigned char *)&mdata->version, > + mobj->size - sizeof(uint32_t)); > + > + return 0; > +} > + > +int fwu_make_mdata(size_t images, size_t banks, char *uuids[], char *output) > +{ > + struct fwu_mdata_object *mobj; > + FILE *file; > + int ret; > + > + mobj = fwu_alloc_mdata(images, banks); > + if (!mobj) > + return -ENOMEM; > + > + ret = fwu_parse_fill_uuids(mobj, uuids); > + if (ret < 0) I think this error case and those below should also free the memory allocated by fwu_alloc_mdata(). > + return ret; > + > + file = fopen(output, "w"); > + if (!file) > + return -errno; > + > + ret = fwrite(mobj->mdata, mobj->size, 1, file); > + if (ret != mobj->size) > + ret = -errno; > + else > + ret = 0; > + > + fclose(file); > + return ret; > +} > + > +int main(int argc, char *argv[]) > +{ > + unsigned long banks = 0, images = 0; > + int c, ret; > + > + do { > + c = getopt_long(argc, argv, opts_short, options, NULL); > + switch (c) { > + case 'h': > + print_usage(); > + return 0; > + case 'b': > + banks = strtoul(optarg, NULL, 0); > + break; > + case 'i': > + images = strtoul(optarg, NULL, 0); > + break; > + case 'g': > + __use_guid = true; > + break; > + case 'a': > + active_bank = strtoul(optarg, NULL, 0); > + break; > + } > + } while (c != -1); > + > + if (!banks || !images) { > + fprintf(stderr, "Error: The number of banks and images must not be 0.\n"); > + return -EINVAL; > + } > + > + /* This command takes UUIDs * images and output file. */ > + if (optind + images + 1 != argc) { > + fprintf(stderr, "Error: UUID list or output file is not specified or too much.\n"); > + print_usage(); > + return -ERANGE; > + } > + ret = fwu_make_mdata(images, banks, argv + optind, argv[argc - 1]); > + if (ret < 0) > + fprintf(stderr, "Error: Failed to parse and write image: %s\n", > + strerror(-ret)); > + return ret; > +} > -- > 2.25.1 >
Hi, one minor remark. On 6/9/22 14:30, Sughosh Ganu wrote: > From: Masami Hiramatsu <masami.hiramatsu@linaro.org> > > Add 'mkfwumdata' tool which can generate an image of the FWU metadata > which is required for initializing the platform. > > Usage: > mkfwumdata -i NR_IMAGES -b NR_BANKS [--guid] \ > LOCATION_UUID0,IMAGE_TYPE_UUID0,BANK0_IMAGE_UUID[,BANK1_IMAGE_UUID[,...]] \ > LOCATION_UUID1,... \ > IMAGE_FILE > > '-i' takes the number of images and '-b' takes the number of > banks. This takes lists of uuids for the images on arguments, > and the last argument must be the output image file name. > > '--guid' (or '-g' in short) allows user to specify the location UUID > and image IDs in GUID instead of UUID. This option is useful if the > platform uses GPT partiotion. In this case, the UUID list > (for an image) becomes; > > DiskGUID,ParitionTypeGUID,UniquePartitionGUID,... > > Signed-off-by: Masami Hiramatsu <masami.hiramatsu@linaro.org> > Signed-off-by: Sughosh Ganu <sughosh.ganu@linaro.org> > --- > tools/Kconfig | 9 ++ > tools/Makefile | 4 + > tools/mkfwumdata.c | 298 +++++++++++++++++++++++++++++++++++++++++++++ > 3 files changed, 311 insertions(+) > create mode 100644 tools/mkfwumdata.c > > diff --git a/tools/Kconfig b/tools/Kconfig > index 117c921da3..3484be99d0 100644 > --- a/tools/Kconfig > +++ b/tools/Kconfig > @@ -98,4 +98,13 @@ config TOOLS_MKEFICAPSULE > optionally sign that file. If you want to enable UEFI capsule > update feature on your target, you certainly need this. > > +config TOOLS_MKFWUMDATA > + bool "Build mkfwumdata command" > + default y if FWU_MULTI_BANK_UPDATE > + help > + This command allows users to create a raw image of the FWU > + metadata for initial installation of the FWU multi bank > + update on the board. The installation method depends on > + the platform. > + > endmenu > diff --git a/tools/Makefile b/tools/Makefile > index 9f2339666a..cd39e5ff6f 100644 > --- a/tools/Makefile > +++ b/tools/Makefile > @@ -245,6 +245,10 @@ HOSTCFLAGS_asn1_compiler.o = -idirafter $(srctree)/include > HOSTLDLIBS_mkeficapsule += -lgnutls -luuid > hostprogs-$(CONFIG_TOOLS_MKEFICAPSULE) += mkeficapsule > > +mkfwumdata-objs := mkfwumdata.o lib/crc32.o > +HOSTLDLIBS_mkfwumdata += -luuid > +hostprogs-$(CONFIG_TOOLS_MKFWUMDATA) += mkfwumdata > + > # We build some files with extra pedantic flags to try to minimize things > # that won't build on some weird host compiler -- though there are lots of > # exceptions for files that aren't complaint. > diff --git a/tools/mkfwumdata.c b/tools/mkfwumdata.c > new file mode 100644 > index 0000000000..4eb304cae3 > --- /dev/null > +++ b/tools/mkfwumdata.c > @@ -0,0 +1,298 @@ > +// SPDX-License-Identifier: GPL-2.0+ > + > +#include <errno.h> > +#include <getopt.h> > +#include <stdio.h> > +#include <stdint.h> > +#include <stdlib.h> > +#include <string.h> > +#include <u-boot/crc.h> > +#include <unistd.h> > +#include <uuid/uuid.h> > + > +/* This will dynamically allocate the fwu_mdata */ > +#define CONFIG_FWU_NUM_BANKS 0 > +#define CONFIG_FWU_NUM_IMAGES_PER_BANK 0 > + > +/* Since we can not include fwu.h, redefine version here. */ > +#define FWU_MDATA_VERSION 1 > + adding typedef should be avoided can you include "asm/types.h" or "linux/types.h" to use the generic define > +typedef uint8_t u8; > +typedef int16_t s16; > +typedef uint16_t u16; > +typedef uint32_t u32; > +typedef uint64_t u64; > + > +#include <fwu_mdata.h> > + > +/* TODO: Endianess conversion may be required for some arch. */ > + > +static const char *opts_short = "b:i:a:gh"; > + > +static struct option options[] = { > + {"banks", required_argument, NULL, 'b'}, > + {"images", required_argument, NULL, 'i'}, > + {"guid", required_argument, NULL, 'g'}, > + {"active-bank", required_argument, NULL, 'a'}, > + {"help", no_argument, NULL, 'h'}, > + {NULL, 0, NULL, 0}, > +}; > + [...] Regards Patrick
On 6/21/22 12:57, Etienne Carriere wrote: > On Thu, 9 Jun 2022 at 14:31, Sughosh Ganu <sughosh.ganu@linaro.org> wrote: >> >> From: Masami Hiramatsu <masami.hiramatsu@linaro.org> >> >> Add 'mkfwumdata' tool which can generate an image of the FWU metadata >> which is required for initializing the platform. >> >> Usage: >> mkfwumdata -i NR_IMAGES -b NR_BANKS [--guid] \ >> LOCATION_UUID0,IMAGE_TYPE_UUID0,BANK0_IMAGE_UUID[,BANK1_IMAGE_UUID[,...]] \ >> LOCATION_UUID1,... \ >> IMAGE_FILE >> >> '-i' takes the number of images and '-b' takes the number of >> banks. This takes lists of uuids for the images on arguments, >> and the last argument must be the output image file name. >> >> '--guid' (or '-g' in short) allows user to specify the location UUID >> and image IDs in GUID instead of UUID. This option is useful if the >> platform uses GPT partiotion. In this case, the UUID list >> (for an image) becomes; >> >> DiskGUID,ParitionTypeGUID,UniquePartitionGUID,... >> >> Signed-off-by: Masami Hiramatsu <masami.hiramatsu@linaro.org> >> Signed-off-by: Sughosh Ganu <sughosh.ganu@linaro.org> >> --- >> tools/Kconfig | 9 ++ >> tools/Makefile | 4 + >> tools/mkfwumdata.c | 298 +++++++++++++++++++++++++++++++++++++++++++++ >> 3 files changed, 311 insertions(+) >> create mode 100644 tools/mkfwumdata.c >> >> diff --git a/tools/Kconfig b/tools/Kconfig >> index 117c921da3..3484be99d0 100644 >> --- a/tools/Kconfig >> +++ b/tools/Kconfig >> @@ -98,4 +98,13 @@ config TOOLS_MKEFICAPSULE >> optionally sign that file. If you want to enable UEFI capsule >> update feature on your target, you certainly need this. >> >> +config TOOLS_MKFWUMDATA >> + bool "Build mkfwumdata command" >> + default y if FWU_MULTI_BANK_UPDATE >> + help >> + This command allows users to create a raw image of the FWU >> + metadata for initial installation of the FWU multi bank >> + update on the board. The installation method depends on >> + the platform. >> + >> endmenu >> diff --git a/tools/Makefile b/tools/Makefile >> index 9f2339666a..cd39e5ff6f 100644 >> --- a/tools/Makefile >> +++ b/tools/Makefile >> @@ -245,6 +245,10 @@ HOSTCFLAGS_asn1_compiler.o = -idirafter $(srctree)/include >> HOSTLDLIBS_mkeficapsule += -lgnutls -luuid >> hostprogs-$(CONFIG_TOOLS_MKEFICAPSULE) += mkeficapsule >> >> +mkfwumdata-objs := mkfwumdata.o lib/crc32.o >> +HOSTLDLIBS_mkfwumdata += -luuid >> +hostprogs-$(CONFIG_TOOLS_MKFWUMDATA) += mkfwumdata >> + >> # We build some files with extra pedantic flags to try to minimize things >> # that won't build on some weird host compiler -- though there are lots of >> # exceptions for files that aren't complaint. >> diff --git a/tools/mkfwumdata.c b/tools/mkfwumdata.c >> new file mode 100644 >> index 0000000000..4eb304cae3 >> --- /dev/null >> +++ b/tools/mkfwumdata.c >> @@ -0,0 +1,298 @@ >> +// SPDX-License-Identifier: GPL-2.0+ >> + >> +#include <errno.h> >> +#include <getopt.h> >> +#include <stdio.h> >> +#include <stdint.h> >> +#include <stdlib.h> >> +#include <string.h> >> +#include <u-boot/crc.h> >> +#include <unistd.h> >> +#include <uuid/uuid.h> >> + >> +/* This will dynamically allocate the fwu_mdata */ >> +#define CONFIG_FWU_NUM_BANKS 0 >> +#define CONFIG_FWU_NUM_IMAGES_PER_BANK 0 >> + >> +/* Since we can not include fwu.h, redefine version here. */ >> +#define FWU_MDATA_VERSION 1 >> + >> +typedef uint8_t u8; >> +typedef int16_t s16; >> +typedef uint16_t u16; >> +typedef uint32_t u32; >> +typedef uint64_t u64; >> + >> +#include <fwu_mdata.h> >> + >> +/* TODO: Endianess conversion may be required for some arch. */ >> + >> +static const char *opts_short = "b:i:a:gh"; >> + >> +static struct option options[] = { >> + {"banks", required_argument, NULL, 'b'}, >> + {"images", required_argument, NULL, 'i'}, >> + {"guid", required_argument, NULL, 'g'}, >> + {"active-bank", required_argument, NULL, 'a'}, >> + {"help", no_argument, NULL, 'h'}, >> + {NULL, 0, NULL, 0}, >> +}; >> + >> +static void print_usage(void) >> +{ >> + fprintf(stderr, "Usage: mkfwumdata [options] <UUIDs list> [<UUIDs list>...] <output file>\n"); >> + fprintf(stderr, "Options:\n" >> + "\t-i, --images <num> Number of images\n" >> + "\t-b, --banks <num> Number of banks\n" >> + "\t-a, --active-bank <num> Active bank\n" >> + "\t-g, --guid Use GUID instead of UUID\n" >> + "\t-h, --help print a help message\n" >> + ); >> + fprintf(stderr, "UUIDs list syntax:\n" >> + "\t<location uuid>,<image type uuid>,<image uuid>[,<image uuid>]\n" >> + "\n\tYou must specify # of banks of image-uuid and # of images of the lists.\n" > > It's not really explicit how many ',<image uuid>' occurrences are needed. > Maybe: > In a <UUIDs list> item, there must be as many <image uuid> > occurrences as the given number of banks. > There must be as many <UUIDs list> items as the given number of images. +1 on this. I was trying 2 bank 2 image configuration and it is not clear how it should be specified. Better description would be good. Thanks, Michal
diff --git a/tools/Kconfig b/tools/Kconfig index 117c921da3..3484be99d0 100644 --- a/tools/Kconfig +++ b/tools/Kconfig @@ -98,4 +98,13 @@ config TOOLS_MKEFICAPSULE optionally sign that file. If you want to enable UEFI capsule update feature on your target, you certainly need this. +config TOOLS_MKFWUMDATA + bool "Build mkfwumdata command" + default y if FWU_MULTI_BANK_UPDATE + help + This command allows users to create a raw image of the FWU + metadata for initial installation of the FWU multi bank + update on the board. The installation method depends on + the platform. + endmenu diff --git a/tools/Makefile b/tools/Makefile index 9f2339666a..cd39e5ff6f 100644 --- a/tools/Makefile +++ b/tools/Makefile @@ -245,6 +245,10 @@ HOSTCFLAGS_asn1_compiler.o = -idirafter $(srctree)/include HOSTLDLIBS_mkeficapsule += -lgnutls -luuid hostprogs-$(CONFIG_TOOLS_MKEFICAPSULE) += mkeficapsule +mkfwumdata-objs := mkfwumdata.o lib/crc32.o +HOSTLDLIBS_mkfwumdata += -luuid +hostprogs-$(CONFIG_TOOLS_MKFWUMDATA) += mkfwumdata + # We build some files with extra pedantic flags to try to minimize things # that won't build on some weird host compiler -- though there are lots of # exceptions for files that aren't complaint. diff --git a/tools/mkfwumdata.c b/tools/mkfwumdata.c new file mode 100644 index 0000000000..4eb304cae3 --- /dev/null +++ b/tools/mkfwumdata.c @@ -0,0 +1,298 @@ +// SPDX-License-Identifier: GPL-2.0+ + +#include <errno.h> +#include <getopt.h> +#include <stdio.h> +#include <stdint.h> +#include <stdlib.h> +#include <string.h> +#include <u-boot/crc.h> +#include <unistd.h> +#include <uuid/uuid.h> + +/* This will dynamically allocate the fwu_mdata */ +#define CONFIG_FWU_NUM_BANKS 0 +#define CONFIG_FWU_NUM_IMAGES_PER_BANK 0 + +/* Since we can not include fwu.h, redefine version here. */ +#define FWU_MDATA_VERSION 1 + +typedef uint8_t u8; +typedef int16_t s16; +typedef uint16_t u16; +typedef uint32_t u32; +typedef uint64_t u64; + +#include <fwu_mdata.h> + +/* TODO: Endianess conversion may be required for some arch. */ + +static const char *opts_short = "b:i:a:gh"; + +static struct option options[] = { + {"banks", required_argument, NULL, 'b'}, + {"images", required_argument, NULL, 'i'}, + {"guid", required_argument, NULL, 'g'}, + {"active-bank", required_argument, NULL, 'a'}, + {"help", no_argument, NULL, 'h'}, + {NULL, 0, NULL, 0}, +}; + +static void print_usage(void) +{ + fprintf(stderr, "Usage: mkfwumdata [options] <UUIDs list> [<UUIDs list>...] <output file>\n"); + fprintf(stderr, "Options:\n" + "\t-i, --images <num> Number of images\n" + "\t-b, --banks <num> Number of banks\n" + "\t-a, --active-bank <num> Active bank\n" + "\t-g, --guid Use GUID instead of UUID\n" + "\t-h, --help print a help message\n" + ); + fprintf(stderr, "UUIDs list syntax:\n" + "\t<location uuid>,<image type uuid>,<image uuid>[,<image uuid>]\n" + "\n\tYou must specify # of banks of image-uuid and # of images of the lists.\n" + "\tIf the location uuid and image uuid are '0', those are filled with null uuid.\n" + ); +} + +static bool __use_guid; +static u32 active_bank; + +struct fwu_mdata_object { + size_t images; + size_t banks; + size_t size; + struct fwu_mdata *mdata; +}; + +struct fwu_mdata_object *fwu_alloc_mdata(size_t images, size_t banks) +{ + struct fwu_mdata_object *mobj; + + mobj = malloc(sizeof(*mobj)); + if (!mobj) + return NULL; + mobj->size = sizeof(struct fwu_mdata) + + (sizeof(struct fwu_image_entry) + + sizeof(struct fwu_image_bank_info) * banks) * images; + mobj->images = images; + mobj->banks = banks; + mobj->mdata = malloc(mobj->size); + if (!mobj->mdata) { + free(mobj); + return NULL; + } + memset(mobj->mdata, 0, mobj->size); + + return mobj; +} + +struct fwu_image_entry *fwu_get_image(struct fwu_mdata_object *mobj, size_t idx) +{ + size_t offset; + + offset = sizeof(struct fwu_mdata) + + (sizeof(struct fwu_image_entry) + + sizeof(struct fwu_image_bank_info) * mobj->banks) * idx; + + return (struct fwu_image_entry *)((char *)mobj->mdata + offset); +} + +struct fwu_image_bank_info *fwu_get_bank(struct fwu_mdata_object *mobj, + size_t img_idx, size_t bnk_idx) +{ + size_t offset; + + offset = sizeof(struct fwu_mdata) + + (sizeof(struct fwu_image_entry) + + sizeof(struct fwu_image_bank_info) * mobj->banks) * img_idx + + sizeof(struct fwu_image_entry) + + sizeof(struct fwu_image_bank_info) * bnk_idx; + + return (struct fwu_image_bank_info *)((char *)mobj->mdata + offset); +} + +/** + * convert_uuid_to_guid() - convert UUID to GUID + * @buf: UUID binary + * + * UUID and GUID have the same data structure, but their binary + * formats are different due to the endianness. See lib/uuid.c. + * Since uuid_parse() can handle only UUID, this function must + * be called to get correct data for GUID when parsing a string. + * + * The correct data will be returned in @buf. + */ +void convert_uuid_to_guid(unsigned char *buf) +{ + unsigned char c; + + c = buf[0]; + buf[0] = buf[3]; + buf[3] = c; + c = buf[1]; + buf[1] = buf[2]; + buf[2] = c; + + c = buf[4]; + buf[4] = buf[5]; + buf[5] = c; + + c = buf[6]; + buf[6] = buf[7]; + buf[7] = c; +} + +int uuid_guid_parse(char *uuidstr, unsigned char *uuid) +{ + int ret; + + ret = uuid_parse(uuidstr, uuid); + if (ret < 0) + return ret; + + if (__use_guid) + convert_uuid_to_guid(uuid); + + return ret; +} + +int fwu_parse_fill_image_uuid(struct fwu_mdata_object *mobj, + size_t idx, char *uuids) +{ + struct fwu_image_entry *image = fwu_get_image(mobj, idx); + struct fwu_image_bank_info *bank; + char *p = uuids, *uuid; + int i; + + if (!image) + return -ENOENT; + + /* Image location UUID */ + uuid = strsep(&p, ","); + if (!uuid) + return -EINVAL; + + if (strcmp(uuid, "0") && + uuid_guid_parse(uuid, (unsigned char *)&image->location_uuid) < 0) + return -EINVAL; + + /* Image type UUID */ + uuid = strsep(&p, ","); + if (!uuid) + return -EINVAL; + + if (uuid_guid_parse(uuid, (unsigned char *)&image->image_type_uuid) < 0) + return -EINVAL; + + /* Fill bank image-UUID */ + for (i = 0; i < mobj->banks; i++) { + bank = fwu_get_bank(mobj, idx, i); + if (!bank) + return -ENOENT; + bank->accepted = 1; + uuid = strsep(&p, ","); + if (!uuid) + return -EINVAL; + + if (strcmp(uuid, "0") && + uuid_guid_parse(uuid, (unsigned char *)&bank->image_uuid) < 0) + return -EINVAL; + } + return 0; +} + +/* Caller must ensure that @uuids[] has @mobj->images entries. */ +int fwu_parse_fill_uuids(struct fwu_mdata_object *mobj, char *uuids[]) +{ + struct fwu_mdata *mdata = mobj->mdata; + int i, ret; + + mdata->version = FWU_MDATA_VERSION; + mdata->active_index = active_bank; + mdata->previous_active_index = active_bank ? 0 : + (uint32_t)(mobj->banks - 1); + + for (i = 0; i < mobj->images; i++) { + ret = fwu_parse_fill_image_uuid(mobj, i, uuids[i]); + if (ret < 0) + return ret; + } + + mdata->crc32 = crc32(0, (const unsigned char *)&mdata->version, + mobj->size - sizeof(uint32_t)); + + return 0; +} + +int fwu_make_mdata(size_t images, size_t banks, char *uuids[], char *output) +{ + struct fwu_mdata_object *mobj; + FILE *file; + int ret; + + mobj = fwu_alloc_mdata(images, banks); + if (!mobj) + return -ENOMEM; + + ret = fwu_parse_fill_uuids(mobj, uuids); + if (ret < 0) + return ret; + + file = fopen(output, "w"); + if (!file) + return -errno; + + ret = fwrite(mobj->mdata, mobj->size, 1, file); + if (ret != mobj->size) + ret = -errno; + else + ret = 0; + + fclose(file); + return ret; +} + +int main(int argc, char *argv[]) +{ + unsigned long banks = 0, images = 0; + int c, ret; + + do { + c = getopt_long(argc, argv, opts_short, options, NULL); + switch (c) { + case 'h': + print_usage(); + return 0; + case 'b': + banks = strtoul(optarg, NULL, 0); + break; + case 'i': + images = strtoul(optarg, NULL, 0); + break; + case 'g': + __use_guid = true; + break; + case 'a': + active_bank = strtoul(optarg, NULL, 0); + break; + } + } while (c != -1); + + if (!banks || !images) { + fprintf(stderr, "Error: The number of banks and images must not be 0.\n"); + return -EINVAL; + } + + /* This command takes UUIDs * images and output file. */ + if (optind + images + 1 != argc) { + fprintf(stderr, "Error: UUID list or output file is not specified or too much.\n"); + print_usage(); + return -ERANGE; + } + ret = fwu_make_mdata(images, banks, argv + optind, argv[argc - 1]); + if (ret < 0) + fprintf(stderr, "Error: Failed to parse and write image: %s\n", + strerror(-ret)); + return ret; +}