2 * Image manipulator for Marvell SoCs
3 * supports Kirkwood, Dove, Armada 370, and Armada XP
5 * (C) Copyright 2013 Thomas Petazzoni
8 * SPDX-License-Identifier: GPL-2.0+
10 * Not implemented: support for the register headers and secure
11 * headers in v1 images
14 #include "imagetool.h"
20 static struct image_cfg_element *image_cfg;
28 struct boot_mode boot_modes[] = {
39 struct nand_ecc_mode {
44 struct nand_ecc_mode nand_ecc_modes[] = {
52 /* Used to identify an undefined execution or destination address */
53 #define ADDR_INVALID ((uint32_t)-1)
55 #define BINARY_MAX_ARGS 8
57 /* In-memory representation of a line of the configuration file */
58 struct image_cfg_element {
60 IMAGE_CFG_VERSION = 0x1,
65 IMAGE_CFG_NAND_BADBLK_LOCATION,
66 IMAGE_CFG_NAND_ECC_MODE,
67 IMAGE_CFG_NAND_PAGESZ,
74 unsigned int bootfrom;
77 unsigned int args[BINARY_MAX_ARGS];
82 unsigned int execaddr;
83 unsigned int nandblksz;
84 unsigned int nandbadblklocation;
85 unsigned int nandeccmode;
86 unsigned int nandpagesz;
87 struct ext_hdr_v0_reg regdata;
91 #define IMAGE_CFG_ELEMENT_MAX 256
94 * Utility functions to manipulate boot mode and ecc modes (convert
95 * them back and forth between description strings and the
96 * corresponding numerical identifiers).
99 static const char *image_boot_mode_name(unsigned int id)
102 for (i = 0; boot_modes[i].name; i++)
103 if (boot_modes[i].id == id)
104 return boot_modes[i].name;
108 int image_boot_mode_id(const char *boot_mode_name)
111 for (i = 0; boot_modes[i].name; i++)
112 if (!strcmp(boot_modes[i].name, boot_mode_name))
113 return boot_modes[i].id;
118 int image_nand_ecc_mode_id(const char *nand_ecc_mode_name)
121 for (i = 0; nand_ecc_modes[i].name; i++)
122 if (!strcmp(nand_ecc_modes[i].name, nand_ecc_mode_name))
123 return nand_ecc_modes[i].id;
127 static struct image_cfg_element *
128 image_find_option(unsigned int optiontype)
132 for (i = 0; i < cfgn; i++) {
133 if (image_cfg[i].type == optiontype)
134 return &image_cfg[i];
141 image_count_options(unsigned int optiontype)
144 unsigned int count = 0;
146 for (i = 0; i < cfgn; i++)
147 if (image_cfg[i].type == optiontype)
154 * Compute a 8-bit checksum of a memory area. This algorithm follows
155 * the requirements of the Marvell SoC BootROM specifications.
157 static uint8_t image_checksum8(void *start, uint32_t len)
162 /* check len and return zero checksum if invalid */
174 static uint32_t image_checksum32(void *start, uint32_t len)
179 /* check len and return zero checksum if invalid */
183 if (len % sizeof(uint32_t)) {
184 fprintf(stderr, "Length %d is not in multiple of %zu\n",
185 len, sizeof(uint32_t));
192 len -= sizeof(uint32_t);
198 static void *image_create_v0(size_t *imagesz, struct image_tool_params *params,
201 struct image_cfg_element *e;
203 struct main_hdr_v0 *main_hdr;
204 struct ext_hdr_v0 *ext_hdr;
209 * Calculate the size of the header and the size of the
212 headersz = sizeof(struct main_hdr_v0);
214 if (image_count_options(IMAGE_CFG_DATA) > 0) {
216 headersz += sizeof(struct ext_hdr_v0);
219 if (image_count_options(IMAGE_CFG_PAYLOAD) > 1) {
220 fprintf(stderr, "More than one payload, not possible\n");
224 image = malloc(headersz);
226 fprintf(stderr, "Cannot allocate memory for image\n");
230 memset(image, 0, headersz);
234 /* Fill in the main header */
235 main_hdr->blocksize = payloadsz + sizeof(uint32_t) - headersz;
236 main_hdr->srcaddr = headersz;
237 main_hdr->ext = has_ext;
238 main_hdr->destaddr = params->addr;
239 main_hdr->execaddr = params->ep;
241 e = image_find_option(IMAGE_CFG_BOOT_FROM);
243 main_hdr->blockid = e->bootfrom;
244 e = image_find_option(IMAGE_CFG_NAND_ECC_MODE);
246 main_hdr->nandeccmode = e->nandeccmode;
247 e = image_find_option(IMAGE_CFG_NAND_PAGESZ);
249 main_hdr->nandpagesize = e->nandpagesz;
250 main_hdr->checksum = image_checksum8(image,
251 sizeof(struct main_hdr_v0));
253 /* Generate the ext header */
257 ext_hdr = image + sizeof(struct main_hdr_v0);
258 ext_hdr->offset = 0x40;
260 for (cfgi = 0, datai = 0; cfgi < cfgn; cfgi++) {
261 e = &image_cfg[cfgi];
262 if (e->type != IMAGE_CFG_DATA)
265 ext_hdr->rcfg[datai].raddr = e->regdata.raddr;
266 ext_hdr->rcfg[datai].rdata = e->regdata.rdata;
270 ext_hdr->checksum = image_checksum8(ext_hdr,
271 sizeof(struct ext_hdr_v0));
278 static size_t image_headersz_v1(struct image_tool_params *params,
281 struct image_cfg_element *binarye;
286 * Calculate the size of the header and the size of the
289 headersz = sizeof(struct main_hdr_v1);
291 if (image_count_options(IMAGE_CFG_BINARY) > 1) {
292 fprintf(stderr, "More than one binary blob, not supported\n");
296 if (image_count_options(IMAGE_CFG_PAYLOAD) > 1) {
297 fprintf(stderr, "More than one payload, not possible\n");
301 binarye = image_find_option(IMAGE_CFG_BINARY);
305 ret = stat(binarye->binary.file, &s);
310 memset(cwd, 0, sizeof(cwd));
311 if (!getcwd(cwd, sizeof(cwd))) {
312 dir = "current working directory";
313 perror("getcwd() failed");
317 "Didn't find the file '%s' in '%s' which is mandatory to generate the image\n"
318 "This file generally contains the DDR3 training code, and should be extracted from an existing bootable\n"
319 "image for your board. See 'kwbimage -x' to extract it from an existing image.\n",
320 binarye->binary.file, dir);
324 headersz += s.st_size +
325 binarye->binary.nargs * sizeof(unsigned int);
330 #if defined(CONFIG_SYS_U_BOOT_OFFS)
331 if (headersz > CONFIG_SYS_U_BOOT_OFFS) {
332 fprintf(stderr, "Error: Image header (incl. SPL image) too big!\n");
333 fprintf(stderr, "header=0x%x CONFIG_SYS_U_BOOT_OFFS=0x%x!\n",
334 (int)headersz, CONFIG_SYS_U_BOOT_OFFS);
335 fprintf(stderr, "Increase CONFIG_SYS_U_BOOT_OFFS!\n");
338 headersz = CONFIG_SYS_U_BOOT_OFFS;
343 * The payload should be aligned on some reasonable
346 return ALIGN_SUP(headersz, 4096);
349 static void *image_create_v1(size_t *imagesz, struct image_tool_params *params,
352 struct image_cfg_element *e, *binarye;
353 struct main_hdr_v1 *main_hdr;
360 * Calculate the size of the header and the size of the
363 headersz = image_headersz_v1(params, &hasext);
367 image = malloc(headersz);
369 fprintf(stderr, "Cannot allocate memory for image\n");
373 memset(image, 0, headersz);
375 cur = main_hdr = image;
376 cur += sizeof(struct main_hdr_v1);
378 /* Fill the main header */
379 main_hdr->blocksize = payloadsz - headersz + sizeof(uint32_t);
380 main_hdr->headersz_lsb = headersz & 0xFFFF;
381 main_hdr->headersz_msb = (headersz & 0xFFFF0000) >> 16;
382 main_hdr->destaddr = params->addr;
383 main_hdr->execaddr = params->ep;
384 main_hdr->srcaddr = headersz;
385 main_hdr->ext = hasext;
386 main_hdr->version = 1;
387 e = image_find_option(IMAGE_CFG_BOOT_FROM);
389 main_hdr->blockid = e->bootfrom;
390 e = image_find_option(IMAGE_CFG_NAND_BLKSZ);
392 main_hdr->nandblocksize = e->nandblksz / (64 * 1024);
393 e = image_find_option(IMAGE_CFG_NAND_BADBLK_LOCATION);
395 main_hdr->nandbadblklocation = e->nandbadblklocation;
397 binarye = image_find_option(IMAGE_CFG_BINARY);
399 struct opt_hdr_v1 *hdr = cur;
406 hdr->headertype = OPT_HDR_V1_BINARY_TYPE;
408 bin = fopen(binarye->binary.file, "r");
410 fprintf(stderr, "Cannot open binary file %s\n",
411 binarye->binary.file);
415 fstat(fileno(bin), &s);
417 binhdrsz = sizeof(struct opt_hdr_v1) +
418 (binarye->binary.nargs + 1) * sizeof(unsigned int) +
422 * The size includes the binary image size, rounded
423 * up to a 4-byte boundary. Plus 4 bytes for the
424 * next-header byte and 3-byte alignment at the end.
426 binhdrsz = ALIGN_SUP(binhdrsz, 4) + 4;
427 hdr->headersz_lsb = binhdrsz & 0xFFFF;
428 hdr->headersz_msb = (binhdrsz & 0xFFFF0000) >> 16;
430 cur += sizeof(struct opt_hdr_v1);
433 *args = binarye->binary.nargs;
435 for (argi = 0; argi < binarye->binary.nargs; argi++)
436 args[argi] = binarye->binary.args[argi];
438 cur += (binarye->binary.nargs + 1) * sizeof(unsigned int);
440 ret = fread(cur, s.st_size, 1, bin);
443 "Could not read binary image %s\n",
444 binarye->binary.file);
450 cur += ALIGN_SUP(s.st_size, 4);
453 * For now, we don't support more than one binary
454 * header, and no other header types are
455 * supported. So, the binary header is necessarily the
458 *((uint32_t *)cur) = 0x00000000;
460 cur += sizeof(uint32_t);
463 /* Calculate and set the header checksum */
464 main_hdr->checksum = image_checksum8(main_hdr, headersz);
470 static int image_create_config_parse_oneline(char *line,
471 struct image_cfg_element *el)
473 char *keyword, *saveptr;
474 char deliminiters[] = " \t";
476 keyword = strtok_r(line, deliminiters, &saveptr);
477 if (!strcmp(keyword, "VERSION")) {
478 char *value = strtok_r(NULL, deliminiters, &saveptr);
479 el->type = IMAGE_CFG_VERSION;
480 el->version = atoi(value);
481 } else if (!strcmp(keyword, "BOOT_FROM")) {
482 char *value = strtok_r(NULL, deliminiters, &saveptr);
483 int ret = image_boot_mode_id(value);
486 "Invalid boot media '%s'\n", value);
489 el->type = IMAGE_CFG_BOOT_FROM;
491 } else if (!strcmp(keyword, "NAND_BLKSZ")) {
492 char *value = strtok_r(NULL, deliminiters, &saveptr);
493 el->type = IMAGE_CFG_NAND_BLKSZ;
494 el->nandblksz = strtoul(value, NULL, 16);
495 } else if (!strcmp(keyword, "NAND_BADBLK_LOCATION")) {
496 char *value = strtok_r(NULL, deliminiters, &saveptr);
497 el->type = IMAGE_CFG_NAND_BADBLK_LOCATION;
498 el->nandbadblklocation =
499 strtoul(value, NULL, 16);
500 } else if (!strcmp(keyword, "NAND_ECC_MODE")) {
501 char *value = strtok_r(NULL, deliminiters, &saveptr);
502 int ret = image_nand_ecc_mode_id(value);
505 "Invalid NAND ECC mode '%s'\n", value);
508 el->type = IMAGE_CFG_NAND_ECC_MODE;
509 el->nandeccmode = ret;
510 } else if (!strcmp(keyword, "NAND_PAGE_SIZE")) {
511 char *value = strtok_r(NULL, deliminiters, &saveptr);
512 el->type = IMAGE_CFG_NAND_PAGESZ;
513 el->nandpagesz = strtoul(value, NULL, 16);
514 } else if (!strcmp(keyword, "BINARY")) {
515 char *value = strtok_r(NULL, deliminiters, &saveptr);
518 el->type = IMAGE_CFG_BINARY;
519 el->binary.file = strdup(value);
521 value = strtok_r(NULL, deliminiters, &saveptr);
524 el->binary.args[argi] = strtoul(value, NULL, 16);
526 if (argi >= BINARY_MAX_ARGS) {
528 "Too many argument for binary\n");
532 el->binary.nargs = argi;
533 } else if (!strcmp(keyword, "DATA")) {
534 char *value1 = strtok_r(NULL, deliminiters, &saveptr);
535 char *value2 = strtok_r(NULL, deliminiters, &saveptr);
537 if (!value1 || !value2) {
539 "Invalid number of arguments for DATA\n");
543 el->type = IMAGE_CFG_DATA;
544 el->regdata.raddr = strtoul(value1, NULL, 16);
545 el->regdata.rdata = strtoul(value2, NULL, 16);
547 fprintf(stderr, "Ignoring unknown line '%s'\n", line);
554 * Parse the configuration file 'fcfg' into the array of configuration
555 * elements 'image_cfg', and return the number of configuration
556 * elements in 'cfgn'.
558 static int image_create_config_parse(FILE *fcfg)
563 /* Parse the configuration file */
564 while (!feof(fcfg)) {
568 /* Read the current line */
569 memset(buf, 0, sizeof(buf));
570 line = fgets(buf, sizeof(buf), fcfg);
574 /* Ignore useless lines */
575 if (line[0] == '\n' || line[0] == '#')
578 /* Strip final newline */
579 if (line[strlen(line) - 1] == '\n')
580 line[strlen(line) - 1] = 0;
582 /* Parse the current line */
583 ret = image_create_config_parse_oneline(line,
590 if (cfgi >= IMAGE_CFG_ELEMENT_MAX) {
592 "Too many configuration elements in .cfg file\n");
601 static int image_get_version(void)
603 struct image_cfg_element *e;
605 e = image_find_option(IMAGE_CFG_VERSION);
612 static int image_version_file(const char *input)
618 fcfg = fopen(input, "r");
620 fprintf(stderr, "Could not open input file %s\n", input);
624 image_cfg = malloc(IMAGE_CFG_ELEMENT_MAX *
625 sizeof(struct image_cfg_element));
627 fprintf(stderr, "Cannot allocate memory\n");
633 IMAGE_CFG_ELEMENT_MAX * sizeof(struct image_cfg_element));
636 ret = image_create_config_parse(fcfg);
643 version = image_get_version();
644 /* Fallback to version 0 is no version is provided in the cfg file */
653 static void kwbimage_set_header(void *ptr, struct stat *sbuf, int ifd,
654 struct image_tool_params *params)
664 fcfg = fopen(params->imagename, "r");
666 fprintf(stderr, "Could not open input file %s\n",
671 image_cfg = malloc(IMAGE_CFG_ELEMENT_MAX *
672 sizeof(struct image_cfg_element));
674 fprintf(stderr, "Cannot allocate memory\n");
680 IMAGE_CFG_ELEMENT_MAX * sizeof(struct image_cfg_element));
683 ret = image_create_config_parse(fcfg);
690 /* The MVEBU BootROM does not allow non word aligned payloads */
691 sbuf->st_size = ALIGN_SUP(sbuf->st_size, 4);
693 version = image_get_version();
696 * Fallback to version 0 if no version is provided in the
701 image = image_create_v0(&headersz, params, sbuf->st_size);
705 image = image_create_v1(&headersz, params, sbuf->st_size);
709 fprintf(stderr, "Unsupported version %d\n", version);
715 fprintf(stderr, "Could not create image\n");
722 /* Build and add image checksum header */
723 checksum = image_checksum32((uint32_t *)ptr, sbuf->st_size);
724 size = write(ifd, &checksum, sizeof(uint32_t));
725 if (size != sizeof(uint32_t)) {
726 fprintf(stderr, "Error:%s - Checksum write %d bytes %s\n",
727 params->cmdname, size, params->imagefile);
731 sbuf->st_size += sizeof(uint32_t);
733 /* Finally copy the header into the image area */
734 memcpy(ptr, image, headersz);
739 static void kwbimage_print_header(const void *ptr)
741 struct main_hdr_v0 *mhdr = (struct main_hdr_v0 *)ptr;
743 printf("Image Type: MVEBU Boot from %s Image\n",
744 image_boot_mode_name(mhdr->blockid));
745 printf("Image version:%d\n", image_version((void *)ptr));
746 printf("Data Size: ");
747 genimg_print_size(mhdr->blocksize - sizeof(uint32_t));
748 printf("Load Address: %08x\n", mhdr->destaddr);
749 printf("Entry Point: %08x\n", mhdr->execaddr);
752 static int kwbimage_check_image_types(uint8_t type)
754 if (type == IH_TYPE_KWBIMAGE)
760 static int kwbimage_verify_header(unsigned char *ptr, int image_size,
761 struct image_tool_params *params)
763 struct main_hdr_v0 *main_hdr;
764 struct ext_hdr_v0 *ext_hdr;
767 main_hdr = (void *)ptr;
768 checksum = image_checksum8(ptr,
769 sizeof(struct main_hdr_v0)
771 if (checksum != main_hdr->checksum)
772 return -FDT_ERR_BADSTRUCTURE;
774 /* Only version 0 extended header has checksum */
775 if (image_version((void *)ptr) == 0) {
776 ext_hdr = (void *)ptr + sizeof(struct main_hdr_v0);
777 checksum = image_checksum8(ext_hdr,
778 sizeof(struct ext_hdr_v0)
780 if (checksum != ext_hdr->checksum)
781 return -FDT_ERR_BADSTRUCTURE;
787 static int kwbimage_generate(struct image_tool_params *params,
788 struct image_type_params *tparams)
794 version = image_version_file(params->imagename);
796 alloc_len = sizeof(struct main_hdr_v0) +
797 sizeof(struct ext_hdr_v0);
799 alloc_len = image_headersz_v1(params, NULL);
802 hdr = malloc(alloc_len);
804 fprintf(stderr, "%s: malloc return failure: %s\n",
805 params->cmdname, strerror(errno));
809 memset(hdr, 0, alloc_len);
810 tparams->header_size = alloc_len;
814 * The resulting image needs to be 4-byte aligned. At least
815 * the Marvell hdrparser tool complains if its unaligned.
816 * By returning 1 here in this function, called via
817 * tparams->vrec_header() in mkimage.c, mkimage will
818 * automatically pad the the resulting image to a 4-byte
825 * Report Error if xflag is set in addition to default
827 static int kwbimage_check_params(struct image_tool_params *params)
829 if (!strlen(params->imagename)) {
830 fprintf(stderr, "Error:%s - Configuration file not specified, "
831 "it is needed for kwbimage generation\n",
836 return (params->dflag && (params->fflag || params->lflag)) ||
837 (params->fflag && (params->dflag || params->lflag)) ||
838 (params->lflag && (params->dflag || params->fflag)) ||
839 (params->xflag) || !(strlen(params->imagename));
843 * kwbimage type parameters definition
847 "Marvell MVEBU Boot Image support",
850 kwbimage_check_params,
851 kwbimage_verify_header,
852 kwbimage_print_header,
855 kwbimage_check_image_types,