Skip to contentSkip to conversation

mkimage: fit_image: Make fit header and data align to 512

PATCH Superseded Kever Yang 5 participants 5 messages Mar 13, 2020 – Mar 16, 2020

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Kever Yang

author
#0 lore raw

PATCH 1/1 mkimage: fit_image: Make fit header and data align to 512

The image is usually stored in block device like emmc, SD card, make the offset of image data aligned to block(512 byte) can avoid data copy during boot process.
eg. SPL boot from FIT image with external data:
- SPL read the first block of FIT image, and then parse the header;
- SPL read image data separately;
- The first image offset is the base_offset which is the header size;
- The second image offset is just after the first image;
- If the offset of imge does not aligned, SPL will do memcpy; The header size is a ramdon number, which is very possible not aligned, so add align for FIT header and image data for better performance.

SPI device do not need to enable this feature.

---

 doc/uImage.FIT/source_file_format.txt |  5 +++++
 tools/fit_image.c                     | 16 +++++++++++-----
 tools/imagetool.h                     |  1 +
 tools/mkimage.c                       |  8 ++++++--
 4 files changed, 23 insertions(+), 7 deletions(-)
doc/uImage.FIT/source_file_format.txt +5 -0
index 18d2aedcb7..50679c4b24 100644
@@ -304,6 +304,11 @@ Normal kernel FIT image has data embedded within FIT structure. U-Boot image
 for SPL boot has external data. Existence of 'data-offset' can be used to
 identify which format is used.
 
+For FIT image with external data, it would be better to align each blob of data
+to block(512 byte) for block device, so that we don't need to do the copy when
+read the image data in SPL. Pass '-B' to mkimage to align the FIT structure and
+data to 512 byte.
+
 9) Examples
 -----------
 
tools/fit_image.c +11 -5
index 6aa4b1c733..4aeaf39536 100644
@@ -431,7 +431,7 @@ static int fit_extract_data(struct image_tool_params *params, const char *fname)
 	fit_size = fdt_totalsize(fdt);
 
 	/* Allocate space to hold the image data we will extract */
-	buf = malloc(fit_size);
+	buf = malloc(fit_size + 2048);
 	if (!buf) {
 		ret = -ENOMEM;
 		goto err_munmap;
@@ -471,17 +471,23 @@ static int fit_extract_data(struct image_tool_params *params, const char *fname)
 					buf_ptr);
 		}
 		fdt_setprop_u32(fdt, node, FIT_DATA_SIZE_PROP, len);
-
-		buf_ptr += (len + 3) & ~3;
+		if (params->bflag)
+			buf_ptr += (len + 511) & ~511;
+		else
+			buf_ptr += (len + 3) & ~3;
 	}
 
 	/* Pack the FDT and place the data after it */
 	fdt_pack(fdt);
 
+	new_size = fdt_totalsize(fdt);
+	if (params->bflag)
+		new_size = (new_size + 511) & ~511;
+	else
+		new_size = (new_size + 3) & ~3;
+	fdt_set_totalsize(fdt, new_size);
 	debug("Size reduced from %x to %x\n", fit_size, fdt_totalsize(fdt));
 	debug("External data size %x\n", buf_ptr);
-	new_size = fdt_totalsize(fdt);
-	new_size = (new_size + 3) & ~3;
 	munmap(fdt, sbuf.st_size);
 
 	if (ftruncate(fd, new_size)) {
tools/imagetool.h +1 -0
index e1c778b0df..e098cb41cc 100644
@@ -40,6 +40,7 @@ struct content_info {
  * type specific functions
  */
 struct image_tool_params {
+	int bflag;
 	int dflag;
 	int eflag;
 	int fflag;
tools/mkimage.c +6 -2
index 5f51d2cc89..03b357f869 100644
@@ -97,8 +97,9 @@ static void usage(const char *msg)
 		"          -i => input filename for ramdisk file\n");
 #ifdef CONFIG_FIT_SIGNATURE
 	fprintf(stderr,
-		"Signing / verified boot options: [-E] [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
+		"Signing / verified boot options: [-E] [-B] [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
 		"          -E => place data outside of the FIT structure\n"
+		"          -B => truncate FIT structure and header to block\n"
 		"          -k => set directory containing private keys\n"
 		"          -K => write public keys to this .dtb file\n"
 		"          -c => add comment in signature node\n"
@@ -143,7 +144,7 @@ static void process_args(int argc, char **argv)
 	int opt;
 
 	while ((opt = getopt(argc, argv,
-			     "a:A:b:c:C:d:D:e:Ef:Fk:i:K:ln:N:p:O:rR:qsT:vVx")) != -1) {
+			     "a:A:b:B:c:C:d:D:e:Ef:Fk:i:K:ln:N:p:O:rR:qsT:vVx")) != -1) {
 		switch (opt) {
 		case 'a':
 			params.addr = strtoull(optarg, &ptr, 16);
@@ -168,6 +169,9 @@ static void process_args(int argc, char **argv)
 				exit(EXIT_FAILURE);
 			}
 			break;
+		case 'B':
+			params.bflag = optarg;
+			break;
 		case 'c':
 			params.comment = optarg;
 			break;
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/1 mkimage: fit_image: Make fit header and data align to 512

Am March 13, 2020 1:50:41 AM UTC schrieb Kever Yang <[email protected]>:

Quoted 52 lines

The image is usually stored in block device like emmc, SD card, make the
offset of image data aligned to block(512 byte) can avoid data copy during boot process.
eg. SPL boot from FIT image with external data:
- SPL read the first block of FIT image, and then parse the header;
- SPL read image data separately;
- The first image offset is the base_offset which is the header size;
- The second image offset is just after the first image;
- If the offset of imge does not aligned, SPL will do memcpy; The header size is a ramdon number, which is very possible not aligned, so
add align for FIT header and image data for better performance.

SPI device do not need to enable this feature.

---

doc/uImage.FIT/source_file_format.txt |  5 +++++
tools/fit_image.c                     | 16 +++++++++++-----
tools/imagetool.h                     |  1 +
tools/mkimage.c                       |  8 ++++++--
4 files changed, 23 insertions(+), 7 deletions(-)
doc/uImage.FIT/source_file_format.txt +0 -0
index 18d2aedcb7..50679c4b24 100644
@@ -304,6 +304,11 @@ Normal kernel FIT image has data embedded within

FIT structure. U-Boot image
for SPL boot has external data. Existence of 'data-offset' can be used to
identify which format is used.

+For FIT image with external data, it would be better to align each blob of data
+to block(512 byte) for block device, so that we don't need to do the copy when
+read the image data in SPL. Pass '-B' to mkimage to align the FIT structure and

doc/uImage.FIT/source_file_format.txt +2 -0
+data to 512 byte.
+

9) Examples
-----------

tools/fit_image.c +0 -0
index 6aa4b1c733..4aeaf39536 100644

tools/fit_image.c static int fit_extract_data(struct · line 435

Quoted 6 lines
tools/fit_image.c +1 -1
@@ -431,7 +431,7 @@ static int fit_extract_data(struct
 image_tool_params *params, const char *fname)
 	fit_size = fdt_totalsize(fdt);
 
 	/* Allocate space to hold the image data we will extract */
-	buf = malloc(fit_size);
+	buf = malloc(fit_size + 2048);

Please, provide a comment in the code explaining why extra space for 4 times the block size is needed.

tools/fit_image.c static int fit_extract_data(struct · line 476

Quoted 12 lines
tools/fit_image.c +0 -0
 	if (!buf) {
 		ret = -ENOMEM;
		goto err_munmap;
tools/fit_image.c +2 -2
@@ -471,17 +471,23 @@ static int fit_extract_data(struct
 image_tool_params *params, const char *fname)
 					buf_ptr);
 		}
 		fdt_setprop_u32(fdt, node, FIT_DATA_SIZE_PROP, len);
-
-		buf_ptr += (len + 3) & ~3;
+		if (params->bflag)
+			buf_ptr += (len + 511) & ~511;

Please, use a constant defining the block size.

Isn't there an ALIGN macro for rounding up?

tools/fit_image.c static int fit_extract_data(struct image_tool_params *params, const char *fname) · line 485

Quoted 10 lines
tools/fit_image.c +5 -0
+		else
+			buf_ptr += (len + 3) & ~3;
 	}
 
 	/* Pack the FDT and place the data after it */
 	fdt_pack(fdt);
 
+	new_size = fdt_totalsize(fdt);
+	if (params->bflag)
+		new_size = (new_size + 511) & ~511;

Same here.

Best regards

Heinrich

Quoted 58 lines
tools/fit_image.c +3 -2
+	else
+		new_size = (new_size + 3) & ~3;
+	fdt_set_totalsize(fdt, new_size);
 	debug("Size reduced from %x to %x\n", fit_size, fdt_totalsize(fdt));
 	debug("External data size %x\n", buf_ptr);
-	new_size = fdt_totalsize(fdt);
-	new_size = (new_size + 3) & ~3;
 	munmap(fdt, sbuf.st_size);
 
	if (ftruncate(fd, new_size)) {
tools/imagetool.h +1 -0
index e1c778b0df..e098cb41cc 100644
@@ -40,6 +40,7 @@ struct content_info {
 * type specific functions
 */
 struct image_tool_params {
+	int bflag;
 	int dflag;
 	int eflag;
 	int fflag;
tools/mkimage.c +0 -1
index 5f51d2cc89..03b357f869 100644
@@ -97,8 +97,9 @@ static void usage(const char *msg)
 		"          -i => input filename for ramdisk file\n");
 #ifdef CONFIG_FIT_SIGNATURE
 	fprintf(stderr,
-		"Signing / verified boot options: [-E] [-k keydir] [-K dtb] [ -c

<comment>] [-p addr] [-r] [-N engine]\n"

tools/mkimage.c +1 -1
+		"Signing / verified boot options: [-E] [-B] [-k keydir] [-K dtb] [
-c <comment>] [-p addr] [-r] [-N engine]\n"

" -E => place data outside of the FIT structure\n"

tools/mkimage.c +1 -0
+		"          -B => truncate FIT structure and header to block\n"
		"          -k => set directory containing private keys\n"
		"          -K => write public keys to this .dtb file\n"
		"          -c => add comment in signature node\n"
tools/mkimage.c +4 -1
@@ -143,7 +144,7 @@ static void process_args(int argc, char **argv)
 	int opt;
 
 	while ((opt = getopt(argc, argv,
-			     "a:A:b:c:C:d:D:e:Ef:Fk:i:K:ln:N:p:O:rR:qsT:vVx")) != -1) {
+			     "a:A:b:B:c:C:d:D:e:Ef:Fk:i:K:ln:N:p:O:rR:qsT:vVx")) != -1) {
 		switch (opt) {
 		case 'a':
 			params.addr = strtoull(optarg, &ptr, 16);
@@ -168,6 +169,9 @@ static void process_args(int argc, char **argv)
 				exit(EXIT_FAILURE);
 			}
 			break;
+		case 'B':
+			params.bflag = optarg;
+			break;
 		case 'c':
 			params.comment = optarg;
 			break;
#2 lore raw

PATCH 1/1 mkimage: fit_image: Make fit header and data align to 512

Quoted 14 lines · Heinrich Schuchardt

Am March 13, 2020 1:50:41 AM UTC schrieb Kever Yang <[email protected]>:

Quoted 13 lines

The image is usually stored in block device like emmc, SD card, make the
offset of image data aligned to block(512 byte) can avoid data copy during boot process.
eg. SPL boot from FIT image with external data:
- SPL read the first block of FIT image, and then parse the header;
- SPL read image data separately;
- The first image offset is the base_offset which is the header size;
- The second image offset is just after the first image;
- If the offset of imge does not aligned, SPL will do memcpy; The header size is a ramdon number, which is very possible not aligned, so
add align for FIT header and image data for better performance.

Why not let -B take an integer argument, so the same flag can be used the day someone needs stuff to be aligned on a 4096 byte boundary?

Rasmus

#3 lore raw

PATCH 1/1 mkimage: fit_image: Make fit header and data align to 512

Quoted 16 lines · Rasmus Villemoes
Quoted 14 lines · Heinrich Schuchardt

Am March 13, 2020 1:50:41 AM UTC schrieb Kever Yang <[email protected]>:

Quoted 13 lines

The image is usually stored in block device like emmc, SD card, make the
offset of image data aligned to block(512 byte) can avoid data copy during boot process.
eg. SPL boot from FIT image with external data:
- SPL read the first block of FIT image, and then parse the header;
- SPL read image data separately;
- The first image offset is the base_offset which is the header size;
- The second image offset is just after the first image;
- If the offset of imge does not aligned, SPL will do memcpy; The header size is a ramdon number, which is very possible not aligned, so
add align for FIT header and image data for better performance.

Quoted 2 lines

Why not let -B take an integer argument, so the same flag can be used the day someone needs stuff to be aligned on a 4096 byte boundary?

Agreed, I'm not happy with the 512 byte assumption either. Thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20200313/7568431a/attachment.sig>
#4 lore raw

PATCH 1/1 mkimage: fit_image: Make fit header and data align to 512

In reply to Kever Yang

Hi Kever,

Quoted 12 lines · Kever Yang

The image is usually stored in block device like emmc, SD card, make the offset of image data aligned to block(512 byte) can avoid data copy during boot process.
eg. SPL boot from FIT image with external data:
- SPL read the first block of FIT image, and then parse the header;
- SPL read image data separately;
- The first image offset is the base_offset which is the header size;
- The second image offset is just after the first image;
- If the offset of imge does not aligned, SPL will do memcpy; The header size is a ramdon number, which is very possible not aligned, so add align for FIT header and image data for better performance.

Quoted 1 line

SPI device do not need to enable this feature.

This seems like a nice improvement.

I had a few minor comments to help readability.

Quoted 10 lines

---

 doc/uImage.FIT/source_file_format.txt |  5 +++++
 tools/fit_image.c                     | 16 +++++++++++-----
 tools/imagetool.h                     |  1 +
 tools/mkimage.c                       |  8 ++++++--
 4 files changed, 23 insertions(+), 7 deletions(-)

[...]

tools/imagetool.h struct content_info { · line 43

Quoted 9 lines
tools/imagetool.h +1 -0
index e1c778b0df..e098cb41cc 100644
@@ -40,6 +40,7 @@ struct content_info {
  * type specific functions
  */
 struct image_tool_params {
+	int bflag;

To improve readability of code, please consider naming the newly added flag to something more descriptive, e.g. "block_align_flag" or "align_flag", in future versions of the patch.

Quoted 8 lines
tools/imagetool.h +0 -0
 	int dflag;
 	int eflag;
 	int fflag;
tools/mkimage.c +0 -0
index 5f51d2cc89..03b357f869 100644

tools/mkimage.c static void usage(const char *msg) · line 102

Quoted 7 lines
tools/mkimage.c +2 -1
@@ -97,8 +97,9 @@ static void usage(const char *msg)
 		"          -i => input filename for ramdisk file\n");
 #ifdef CONFIG_FIT_SIGNATURE
 	fprintf(stderr,
-		"Signing / verified boot options: [-E] [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
+		"Signing / verified boot options: [-E] [-B] [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
 		"          -E => place data outside of the FIT structure\n"
+		"          -B => truncate FIT structure and header to block\n"
                                 "align"

tools/mkimage.c static void usage(const char *msg) · line 105

Quoted 3 lines
tools/mkimage.c +0 -0
 		"          -k => set directory containing private keys\n"
 		"          -K => write public keys to this .dtb file\n"
 		"          -c => add comment in signature node\n"

Thanks,
Punit

[...]