[U-Boot] [PATCH 0/3] tools: mkimage: Add Allwinner eGON support

So far creating a bootable SPL image for Allwinner based boards uses the mksunxiboot tool. Most other platforms seemed to have integrated this kind of functionality into the common mkimage tool.
Since there is nothing special about the Allwinner image in this respect, just add support for the so-called "eGON" image type into mkimage. If there was a particular reason this hasn't been done before, please let me know.
This will eventually allow us to remove mksunxiboot, but I leave it around for now in case of regressions and since some people depend on it from external projects.
Patch 1/3 fixes a small annoyance in mkimage -T list. Patch 2/3 adds the actually support to mkimage, patch 3/3 then switches the Makefile to use mkimage instead of mksunxiboot.
I tested all 144 Allwinner boards by building each sunxi-spl.bin and comparing it against the version created using mksunxiboot (using SOURCE_DATE_EPOCH and .scmversion to create reproducible builds). All files before and after were identical.
Cheers, Andre
Andre Przywara (3): tools: mkimage: Add missing names for imx8mimage and loadables tools: mkimage: Add Allwinner eGON support sunxi: Use mkimage -T sunxi_egon for SPL boot image generation
common/image.c | 3 ++ include/image.h | 1 + scripts/Makefile.spl | 8 +-- tools/Makefile | 1 + tools/sunxi_egon.c | 136 +++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 145 insertions(+), 4 deletions(-) create mode 100644 tools/sunxi_egon.c

At the moment "mkimage -T list" starts with two unknown entries, because their IH_TYPE_ name is not listed in the uimage_type table.
Add those two entries to get an OCD-compatible image type listing.
Signed-off-by: Andre Przywara andre.przywara@arm.com --- common/image.c | 2 ++ 1 file changed, 2 insertions(+)
diff --git a/common/image.c b/common/image.c index 0659133fcc..3ff713a521 100644 --- a/common/image.c +++ b/common/image.c @@ -140,7 +140,9 @@ static const table_entry_t uimage_type[] = { { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",}, { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",}, { IH_TYPE_IMX8IMAGE, "imx8image", "NXP i.MX8 Boot Image",}, + { IH_TYPE_IMX8MIMAGE, "imx8mimage", "NXP i.MX8M Boot Image",}, { IH_TYPE_INVALID, "invalid", "Invalid Image", }, + { IH_TYPE_LOADABLE, "loadable", "Typeless Image", }, { IH_TYPE_MULTI, "multi", "Multi-File Image", }, { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",}, { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},

On Fri, 21 Dec 2018 at 18:36, Andre Przywara andre.przywara@arm.com wrote:
At the moment "mkimage -T list" starts with two unknown entries, because their IH_TYPE_ name is not listed in the uimage_type table.
Add those two entries to get an OCD-compatible image type listing.
Signed-off-by: Andre Przywara andre.przywara@arm.com
common/image.c | 2 ++ 1 file changed, 2 insertions(+)
Reviewed-by: Simon Glass sjg@chromium.org
Would be good to have some tests for mkimage

On Sat, Dec 22, 2018 at 7:06 AM Andre Przywara andre.przywara@arm.com wrote:
At the moment "mkimage -T list" starts with two unknown entries, because their IH_TYPE_ name is not listed in the uimage_type table.
Add those two entries to get an OCD-compatible image type listing.
Signed-off-by: Andre Przywara andre.przywara@arm.com
common/image.c | 2 ++ 1 file changed, 2 insertions(+)
diff --git a/common/image.c b/common/image.c index 0659133fcc..3ff713a521 100644 --- a/common/image.c +++ b/common/image.c @@ -140,7 +140,9 @@ static const table_entry_t uimage_type[] = { { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",}, { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",}, { IH_TYPE_IMX8IMAGE, "imx8image", "NXP i.MX8 Boot Image",},
{ IH_TYPE_IMX8MIMAGE, "imx8mimage", "NXP i.MX8M Boot Image",},
This change already in, 6609c2663c9c9699f3d279ccea599e5d18578b20

So far we used the separate mksunxiboot tool for generating a bootable image for Allwinner SPLs, probably just for historical reasons.
Use the mkimage framework to generate a so called eGON image the Allwinner BROM expects. The new image type is called "sunxi_egon", to differentiate it from the (still to be implemented) secure boot TOC0 image.
Signed-off-by: Andre Przywara andre.przywara@arm.com --- common/image.c | 1 + include/image.h | 1 + tools/Makefile | 1 + tools/sunxi_egon.c | 136 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 139 insertions(+) create mode 100644 tools/sunxi_egon.c
diff --git a/common/image.c b/common/image.c index 3ff713a521..17150093d6 100644 --- a/common/image.c +++ b/common/image.c @@ -169,6 +169,7 @@ static const table_entry_t uimage_type[] = { { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",}, { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" }, { IH_TYPE_MTKIMAGE, "mtk_image", "MediaTek BootROM loadable Image" }, + { IH_TYPE_SUNXI_EGON, "sunxi_egon", "Allwinner eGON Boot Image" }, { -1, "", "", }, };
diff --git a/include/image.h b/include/image.h index 765ffecee0..35f43b3074 100644 --- a/include/image.h +++ b/include/image.h @@ -284,6 +284,7 @@ enum { IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */ IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */ IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */ + IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */
IH_TYPE_COUNT, /* Number of image types */ }; diff --git a/tools/Makefile b/tools/Makefile index 2c4d91f199..9f2533f048 100644 --- a/tools/Makefile +++ b/tools/Makefile @@ -106,6 +106,7 @@ dumpimage-mkimage-objs := aisimage.o \ stm32image.o \ $(ROCKCHIP_OBS) \ socfpgaimage.o \ + sunxi_egon.o \ lib/crc16.o \ lib/sha1.o \ lib/sha256.o \ diff --git a/tools/sunxi_egon.c b/tools/sunxi_egon.c new file mode 100644 index 0000000000..9b38149280 --- /dev/null +++ b/tools/sunxi_egon.c @@ -0,0 +1,136 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * (C) Copyright 2018 Arm Ltd. + */ + +#include "imagetool.h" +#include <image.h> + +#include "../arch/arm/include/asm/arch-sunxi/spl.h" + +/* checksum initialiser value */ +#define STAMP_VALUE 0x5F0A6C39 + +/* + * NAND requires 8K padding. SD/eMMC gets away with 512 bytes, + * but let's use the larger padding to cover both. + */ +#define PAD_SIZE 8192 + +#define ALIGN(x, a) __ALIGN_MASK((x), (typeof(x))(a)-1) +#define __ALIGN_MASK(x, mask) (((x)+(mask))&~(mask)) + +static int egon_check_params(struct image_tool_params *params) +{ + /* We just need a binary image file. */ + return !params->dflag; +} + +static int egon_verify_header(unsigned char *ptr, int image_size, + struct image_tool_params *params) +{ + const struct boot_file_head *header = (void *)ptr; + uint32_t length; + + /* First 4 bytes must be an ARM branch instruction. */ + if ((le32_to_cpu(header->b_instruction) & 0xff000000) != 0xea000000) + return EXIT_FAILURE; + + if (memcmp(header->magic, BOOT0_MAGIC, 8)) + return EXIT_FAILURE; + + length = le32_to_cpu(header->length); + /* Must be at least 512 byte aligned. */ + if (length & 511) + return EXIT_FAILURE; + + /* + * Image could also contain U-Boot proper, so could be bigger. + * But it must not be shorter. + */ + if (image_size < length) + return EXIT_FAILURE; + + return EXIT_SUCCESS; +} + +static void egon_print_header(const void *buf) +{ + const struct boot_file_head *header = buf; + + printf("Allwinner eGON header, size: %d bytes\n", + le32_to_cpu(header->length)); + if (!memcmp(header->spl_signature, SPL_SIGNATURE, 3)) + printf("\tSPL header version %d.%d\n", + header->spl_signature[3] >> SPL_MINOR_BITS, + header->spl_signature[3] & ((1U << SPL_MINOR_BITS) - 1)); + if (header->spl_signature[3] >= SPL_DT_HEADER_VERSION) + printf("\tDT name: %s\n", + (char *)buf + le32_to_cpu(header->dt_name_offset)); +} + +static void egon_set_header(void *buf, struct stat *sbuf, int infd, + struct image_tool_params *params) +{ + struct boot_file_head *header = buf; + uint32_t *buf32 = buf; + uint32_t checksum = 0, value; + int i; + + /* Generate an ARM branch instruction to jump over the header. */ + value = 0xea000000 | (sizeof(struct boot_file_head) / 4 - 2); + header->b_instruction = cpu_to_le32(value); + + memcpy(header->magic, BOOT0_MAGIC, 8); + header->check_sum = cpu_to_le32(STAMP_VALUE); + header->length = cpu_to_le32(ALIGN(sbuf->st_size, PAD_SIZE)); + + memcpy(header->spl_signature, SPL_SIGNATURE, 3); + + /* If an image name has been provided, use it as the DT name. */ + if (params->imagename && params->imagename[0]) { + header->spl_signature[3] = SPL_DT_HEADER_VERSION; + + value = offsetof(struct boot_file_head, string_pool); + header->dt_name_offset = cpu_to_le32(value); + + strncpy((char *)header->string_pool, params->imagename, 52); + /* Make sure we have a terminating zero byte. */ + ((char *)header->string_pool)[51] = 0; + } else + header->spl_signature[3] = SPL_ENV_HEADER_VERSION; + + /* Calculate the checksum. Yes, it's that simple. */ + for (i = 0; i < sbuf->st_size / 4; i++) + checksum += le32_to_cpu(buf32[i]); + header->check_sum = cpu_to_le32(checksum); +} + +static int egon_check_image_type(uint8_t type) +{ + return type == IH_TYPE_SUNXI_EGON ? 0 : 1; +} + +static int egon_vrec_header(struct image_tool_params *params, + struct image_type_params *tparams) +{ + tparams->hdr = calloc(sizeof(struct boot_file_head), 1); + + /* Return padding to 8K blocks. */ + return PAD_SIZE - (params->file_size & (PAD_SIZE - 1)); +} + +U_BOOT_IMAGE_TYPE( + sunxi_egon, + "Allwinner eGON Boot Image support", + sizeof(struct boot_file_head), + NULL, + egon_check_params, + egon_verify_header, + egon_print_header, + egon_set_header, + NULL, + egon_check_image_type, + NULL, + egon_vrec_header +);

On Fri, 21 Dec 2018 at 18:36, Andre Przywara andre.przywara@arm.com wrote:
So far we used the separate mksunxiboot tool for generating a bootable image for Allwinner SPLs, probably just for historical reasons.
Use the mkimage framework to generate a so called eGON image the Allwinner BROM expects. The new image type is called "sunxi_egon", to differentiate it from the (still to be implemented) secure boot TOC0 image.
Signed-off-by: Andre Przywara andre.przywara@arm.com
common/image.c | 1 + include/image.h | 1 + tools/Makefile | 1 + tools/sunxi_egon.c | 136 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 139 insertions(+) create mode 100644 tools/sunxi_egon.c
Good idea.
Reviewed-by: Simon Glass sjg@chromium.org

On Sat, Dec 22, 2018 at 7:06 AM Andre Przywara andre.przywara@arm.com wrote:
So far we used the separate mksunxiboot tool for generating a bootable image for Allwinner SPLs, probably just for historical reasons.
Use the mkimage framework to generate a so called eGON image the Allwinner BROM expects. The new image type is called "sunxi_egon", to differentiate it from the (still to be implemented) secure boot TOC0 image.
Signed-off-by: Andre Przywara andre.przywara@arm.com
common/image.c | 1 + include/image.h | 1 + tools/Makefile | 1 + tools/sunxi_egon.c | 136 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 139 insertions(+) create mode 100644 tools/sunxi_egon.c
diff --git a/common/image.c b/common/image.c index 3ff713a521..17150093d6 100644 --- a/common/image.c +++ b/common/image.c @@ -169,6 +169,7 @@ static const table_entry_t uimage_type[] = { { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",}, { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" }, { IH_TYPE_MTKIMAGE, "mtk_image", "MediaTek BootROM loadable Image" },
{ IH_TYPE_SUNXI_EGON, "sunxi_egon", "Allwinner eGON Boot Image" }, { -1, "", "", },
};
diff --git a/include/image.h b/include/image.h index 765ffecee0..35f43b3074 100644 --- a/include/image.h +++ b/include/image.h @@ -284,6 +284,7 @@ enum { IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */ IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */ IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */ IH_TYPE_COUNT, /* Number of image types */
}; diff --git a/tools/Makefile b/tools/Makefile index 2c4d91f199..9f2533f048 100644 --- a/tools/Makefile +++ b/tools/Makefile @@ -106,6 +106,7 @@ dumpimage-mkimage-objs := aisimage.o \ stm32image.o \ $(ROCKCHIP_OBS) \ socfpgaimage.o \
sunxi_egon.o \ lib/crc16.o \ lib/sha1.o \ lib/sha256.o \
diff --git a/tools/sunxi_egon.c b/tools/sunxi_egon.c new file mode 100644 index 0000000000..9b38149280 --- /dev/null +++ b/tools/sunxi_egon.c @@ -0,0 +1,136 @@ +// SPDX-License-Identifier: GPL-2.0+ +/*
- (C) Copyright 2018 Arm Ltd.
- */
+#include "imagetool.h" +#include <image.h>
+#include "../arch/arm/include/asm/arch-sunxi/spl.h"
This can be done as #include <asm/arch/spl.h>
Reviewed-by: Jagan Teki jagan@openedev.com Tested-by: Jagan Teki jagan@amarulasolutions.com # BPI-M64

On Fri, Jan 11, 2019 at 12:46:36PM +0530, Jagan Teki wrote:
On Sat, Dec 22, 2018 at 7:06 AM Andre Przywara andre.przywara@arm.com wrote:
So far we used the separate mksunxiboot tool for generating a bootable image for Allwinner SPLs, probably just for historical reasons.
Use the mkimage framework to generate a so called eGON image the Allwinner BROM expects. The new image type is called "sunxi_egon", to differentiate it from the (still to be implemented) secure boot TOC0 image.
Signed-off-by: Andre Przywara andre.przywara@arm.com
common/image.c | 1 + include/image.h | 1 + tools/Makefile | 1 + tools/sunxi_egon.c | 136 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 139 insertions(+) create mode 100644 tools/sunxi_egon.c
diff --git a/common/image.c b/common/image.c index 3ff713a521..17150093d6 100644 --- a/common/image.c +++ b/common/image.c @@ -169,6 +169,7 @@ static const table_entry_t uimage_type[] = { { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",}, { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" }, { IH_TYPE_MTKIMAGE, "mtk_image", "MediaTek BootROM loadable Image" },
{ IH_TYPE_SUNXI_EGON, "sunxi_egon", "Allwinner eGON Boot Image" }, { -1, "", "", },
};
diff --git a/include/image.h b/include/image.h index 765ffecee0..35f43b3074 100644 --- a/include/image.h +++ b/include/image.h @@ -284,6 +284,7 @@ enum { IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */ IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */ IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */ IH_TYPE_COUNT, /* Number of image types */
}; diff --git a/tools/Makefile b/tools/Makefile index 2c4d91f199..9f2533f048 100644 --- a/tools/Makefile +++ b/tools/Makefile @@ -106,6 +106,7 @@ dumpimage-mkimage-objs := aisimage.o \ stm32image.o \ $(ROCKCHIP_OBS) \ socfpgaimage.o \
sunxi_egon.o \ lib/crc16.o \ lib/sha1.o \ lib/sha256.o \
diff --git a/tools/sunxi_egon.c b/tools/sunxi_egon.c new file mode 100644 index 0000000000..9b38149280 --- /dev/null +++ b/tools/sunxi_egon.c @@ -0,0 +1,136 @@ +// SPDX-License-Identifier: GPL-2.0+ +/*
- (C) Copyright 2018 Arm Ltd.
- */
+#include "imagetool.h" +#include <image.h>
+#include "../arch/arm/include/asm/arch-sunxi/spl.h"
This can be done as #include <asm/arch/spl.h>
That would break host tools tho, no?

On Fri, Jan 11, 2019 at 5:54 PM Tom Rini trini@konsulko.com wrote:
On Fri, Jan 11, 2019 at 12:46:36PM +0530, Jagan Teki wrote:
On Sat, Dec 22, 2018 at 7:06 AM Andre Przywara andre.przywara@arm.com wrote:
So far we used the separate mksunxiboot tool for generating a bootable image for Allwinner SPLs, probably just for historical reasons.
Use the mkimage framework to generate a so called eGON image the Allwinner BROM expects. The new image type is called "sunxi_egon", to differentiate it from the (still to be implemented) secure boot TOC0 image.
Signed-off-by: Andre Przywara andre.przywara@arm.com
common/image.c | 1 + include/image.h | 1 + tools/Makefile | 1 + tools/sunxi_egon.c | 136 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 139 insertions(+) create mode 100644 tools/sunxi_egon.c
diff --git a/common/image.c b/common/image.c index 3ff713a521..17150093d6 100644 --- a/common/image.c +++ b/common/image.c @@ -169,6 +169,7 @@ static const table_entry_t uimage_type[] = { { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",}, { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" }, { IH_TYPE_MTKIMAGE, "mtk_image", "MediaTek BootROM loadable Image" },
{ IH_TYPE_SUNXI_EGON, "sunxi_egon", "Allwinner eGON Boot Image" }, { -1, "", "", },
};
diff --git a/include/image.h b/include/image.h index 765ffecee0..35f43b3074 100644 --- a/include/image.h +++ b/include/image.h @@ -284,6 +284,7 @@ enum { IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */ IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */ IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */ IH_TYPE_COUNT, /* Number of image types */
}; diff --git a/tools/Makefile b/tools/Makefile index 2c4d91f199..9f2533f048 100644 --- a/tools/Makefile +++ b/tools/Makefile @@ -106,6 +106,7 @@ dumpimage-mkimage-objs := aisimage.o \ stm32image.o \ $(ROCKCHIP_OBS) \ socfpgaimage.o \
sunxi_egon.o \ lib/crc16.o \ lib/sha1.o \ lib/sha256.o \
diff --git a/tools/sunxi_egon.c b/tools/sunxi_egon.c new file mode 100644 index 0000000000..9b38149280 --- /dev/null +++ b/tools/sunxi_egon.c @@ -0,0 +1,136 @@ +// SPDX-License-Identifier: GPL-2.0+ +/*
- (C) Copyright 2018 Arm Ltd.
- */
+#include "imagetool.h" +#include <image.h>
+#include "../arch/arm/include/asm/arch-sunxi/spl.h"
This can be done as #include <asm/arch/spl.h>
That would break host tools tho, no?
Didn't It still build the tools.

Switch the SPL boot image generation from using mksunxiboot to the new sunxi_egon format of mkimage.
Verified to create identical results for all 144 Allwinner boards.
Signed-off-by: Andre Przywara andre.przywara@arm.com --- scripts/Makefile.spl | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/scripts/Makefile.spl b/scripts/Makefile.spl index 2ef19bf005..9178599c4a 100644 --- a/scripts/Makefile.spl +++ b/scripts/Makefile.spl @@ -336,11 +336,11 @@ endif $(obj)/$(SPL_BIN).sfp: $(obj)/$(SPL_BIN).bin FORCE $(call if_changed,mkimage)
-quiet_cmd_mksunxiboot = MKSUNXI $@ -cmd_mksunxiboot = $(objtree)/tools/mksunxiboot \ - --default-dt $(CONFIG_DEFAULT_DEVICE_TREE) $< $@ +MKIMAGEFLAGS_sunxi-spl.bin = -T sunxi_egon \ + -n $(CONFIG_DEFAULT_DEVICE_TREE) + $(obj)/sunxi-spl.bin: $(obj)/$(SPL_BIN).bin FORCE - $(call if_changed,mksunxiboot) + $(call if_changed,mkimage)
quiet_cmd_sunxi_spl_image_builder = SUNXI_SPL_IMAGE_BUILDER $@ cmd_sunxi_spl_image_builder = $(objtree)/tools/sunxi-spl-image-builder \

On Fri, 21 Dec 2018 at 18:36, Andre Przywara andre.przywara@arm.com wrote:
Switch the SPL boot image generation from using mksunxiboot to the new sunxi_egon format of mkimage.
Verified to create identical results for all 144 Allwinner boards.
Signed-off-by: Andre Przywara andre.przywara@arm.com
scripts/Makefile.spl | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Reviewed-by: Simon Glass sjg@chromium.org
participants (4)
-
Andre Przywara
-
Jagan Teki
-
Simon Glass
-
Tom Rini