3 * Stefano Babic, DENX Software Engineering, sbabic@denx.de.
6 * Marvell Semiconductor <www.marvell.com>
7 * Written-by: Prafulla Wadaskar <prafulla@marvell.com>
9 * SPDX-License-Identifier: GPL-2.0+
12 /* Required to obtain the getline prototype from stdio.h */
20 * Supported commands for configuration file
22 static table_entry_t imximage_cmds[] = {
23 {CMD_BOOT_FROM, "BOOT_FROM", "boot command", },
24 {CMD_BOOT_OFFSET, "BOOT_OFFSET", "Boot offset", },
25 {CMD_DATA, "DATA", "Reg Write Data", },
26 {CMD_IMAGE_VERSION, "IMAGE_VERSION", "image version", },
31 * Supported Boot options for configuration file
32 * this is needed to set the correct flash offset
34 static table_entry_t imximage_boot_offset[] = {
35 {FLASH_OFFSET_ONENAND, "onenand", "OneNAND Flash",},
36 {FLASH_OFFSET_NAND, "nand", "NAND Flash", },
37 {FLASH_OFFSET_NOR, "nor", "NOR Flash", },
38 {FLASH_OFFSET_SATA, "sata", "SATA Disk", },
39 {FLASH_OFFSET_SD, "sd", "SD Card", },
40 {FLASH_OFFSET_SPI, "spi", "SPI Flash", },
41 {-1, "", "Invalid", },
45 * Supported Boot options for configuration file
46 * this is needed to determine the initial load size
48 static table_entry_t imximage_boot_loadsize[] = {
49 {FLASH_LOADSIZE_ONENAND, "onenand", "OneNAND Flash",},
50 {FLASH_LOADSIZE_NAND, "nand", "NAND Flash", },
51 {FLASH_LOADSIZE_NOR, "nor", "NOR Flash", },
52 {FLASH_LOADSIZE_SATA, "sata", "SATA Disk", },
53 {FLASH_LOADSIZE_SD, "sd", "SD Card", },
54 {FLASH_LOADSIZE_SPI, "spi", "SPI Flash", },
55 {-1, "", "Invalid", },
59 * IMXIMAGE version definition for i.MX chips
61 static table_entry_t imximage_versions[] = {
62 {IMXIMAGE_V1, "", " (i.MX25/35/51 compatible)", },
63 {IMXIMAGE_V2, "", " (i.MX53/6 compatible)", },
64 {-1, "", " (Invalid)", },
67 static struct imx_header imximage_header;
68 static uint32_t imximage_version;
69 /* Image Vector Table Offset */
70 static uint32_t imximage_ivt_offset;
71 /* Initial Load Region Size */
72 static uint32_t imximage_init_loadsize;
74 static set_dcd_val_t set_dcd_val;
75 static set_dcd_rst_t set_dcd_rst;
76 static set_imx_hdr_t set_imx_hdr;
77 static uint32_t max_dcd_entries;
78 static uint32_t *header_size_ptr;
80 static uint32_t get_cfg_value(char *token, char *name, int linenr)
86 value = strtoul(token, &endptr, 16);
87 if (errno || (token == endptr)) {
88 fprintf(stderr, "Error: %s[%d] - Invalid hex data(%s)\n",
95 static uint32_t detect_imximage_version(struct imx_header *imx_hdr)
97 imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1;
98 imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2;
99 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
100 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
102 /* Try to detect V1 */
103 if ((fhdr_v1->app_code_barker == APP_CODE_BARKER) &&
104 (hdr_v1->dcd_table.preamble.barker == DCD_BARKER))
107 /* Try to detect V2 */
108 if ((fhdr_v2->header.tag == IVT_HEADER_TAG) &&
109 (hdr_v2->dcd_table.header.tag == DCD_HEADER_TAG))
112 return IMXIMAGE_VER_INVALID;
115 static void err_imximage_version(int version)
118 "Error: Unsupported imximage version:%d\n", version);
123 static void set_dcd_val_v1(struct imx_header *imxhdr, char *name, int lineno,
124 int fld, uint32_t value, uint32_t off)
126 dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table;
130 /* Byte, halfword, word */
131 if ((value != 1) && (value != 2) && (value != 4)) {
132 fprintf(stderr, "Error: %s[%d] - "
133 "Invalid register size " "(%d)\n",
134 name, lineno, value);
137 dcd_v1->addr_data[off].type = value;
139 case CFG_REG_ADDRESS:
140 dcd_v1->addr_data[off].addr = value;
143 dcd_v1->addr_data[off].value = value;
151 static void set_dcd_val_v2(struct imx_header *imxhdr, char *name, int lineno,
152 int fld, uint32_t value, uint32_t off)
154 dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table;
157 case CFG_REG_ADDRESS:
158 dcd_v2->addr_data[off].addr = cpu_to_be32(value);
161 dcd_v2->addr_data[off].value = cpu_to_be32(value);
170 * Complete setting up the rest field of DCD of V1
171 * such as barker code and DCD data length.
173 static void set_dcd_rst_v1(struct imx_header *imxhdr, uint32_t dcd_len,
174 char *name, int lineno)
176 dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table;
178 dcd_v1->preamble.barker = DCD_BARKER;
179 dcd_v1->preamble.length = dcd_len * sizeof(dcd_type_addr_data_t);
183 * Complete setting up the reset field of DCD of V2
184 * such as DCD tag, version, length, etc.
186 static void set_dcd_rst_v2(struct imx_header *imxhdr, uint32_t dcd_len,
187 char *name, int lineno)
189 dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table;
191 dcd_v2->header.tag = DCD_HEADER_TAG;
192 dcd_v2->header.length = cpu_to_be16(
193 dcd_len * sizeof(dcd_addr_data_t) + 8);
194 dcd_v2->header.version = DCD_VERSION;
195 dcd_v2->write_dcd_command.tag = DCD_COMMAND_TAG;
196 dcd_v2->write_dcd_command.length = cpu_to_be16(
197 dcd_len * sizeof(dcd_addr_data_t) + 4);
198 dcd_v2->write_dcd_command.param = DCD_COMMAND_PARAM;
201 static void set_imx_hdr_v1(struct imx_header *imxhdr, uint32_t dcd_len,
202 uint32_t entry_point, uint32_t flash_offset)
204 imx_header_v1_t *hdr_v1 = &imxhdr->header.hdr_v1;
205 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
206 dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table;
208 uint32_t header_length = (((char *)&dcd_v1->addr_data[dcd_len].addr)
211 /* Set magic number */
212 fhdr_v1->app_code_barker = APP_CODE_BARKER;
214 /* TODO: check i.MX image V1 handling, for now use 'old' style */
215 hdr_base = entry_point - 4096;
216 fhdr_v1->app_dest_ptr = hdr_base - flash_offset;
217 fhdr_v1->app_code_jump_vector = entry_point;
219 fhdr_v1->dcd_ptr_ptr = hdr_base + offsetof(flash_header_v1_t, dcd_ptr);
220 fhdr_v1->dcd_ptr = hdr_base + offsetof(imx_header_v1_t, dcd_table);
222 /* Security feature are not supported */
223 fhdr_v1->app_code_csf = 0;
224 fhdr_v1->super_root_key = 0;
225 header_size_ptr = (uint32_t *)(((char *)imxhdr) + header_length - 4);
228 static void set_imx_hdr_v2(struct imx_header *imxhdr, uint32_t dcd_len,
229 uint32_t entry_point, uint32_t flash_offset)
231 imx_header_v2_t *hdr_v2 = &imxhdr->header.hdr_v2;
232 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
235 /* Set magic number */
236 fhdr_v2->header.tag = IVT_HEADER_TAG; /* 0xD1 */
237 fhdr_v2->header.length = cpu_to_be16(sizeof(flash_header_v2_t));
238 fhdr_v2->header.version = IVT_VERSION; /* 0x40 */
240 fhdr_v2->entry = entry_point;
241 fhdr_v2->reserved1 = fhdr_v2->reserved2 = 0;
242 hdr_base = entry_point - imximage_init_loadsize +
244 fhdr_v2->self = hdr_base;
245 fhdr_v2->dcd_ptr = hdr_base + offsetof(imx_header_v2_t, dcd_table);
246 fhdr_v2->boot_data_ptr = hdr_base
247 + offsetof(imx_header_v2_t, boot_data);
248 hdr_v2->boot_data.start = entry_point - imximage_init_loadsize;
250 /* Security feature are not supported */
252 header_size_ptr = &hdr_v2->boot_data.size;
255 static void set_hdr_func(struct imx_header *imxhdr)
257 switch (imximage_version) {
259 set_dcd_val = set_dcd_val_v1;
260 set_dcd_rst = set_dcd_rst_v1;
261 set_imx_hdr = set_imx_hdr_v1;
262 max_dcd_entries = MAX_HW_CFG_SIZE_V1;
265 set_dcd_val = set_dcd_val_v2;
266 set_dcd_rst = set_dcd_rst_v2;
267 set_imx_hdr = set_imx_hdr_v2;
268 max_dcd_entries = MAX_HW_CFG_SIZE_V2;
271 err_imximage_version(imximage_version);
276 static void print_hdr_v1(struct imx_header *imx_hdr)
278 imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1;
279 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
280 dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table;
281 uint32_t size, length, ver;
283 size = dcd_v1->preamble.length;
284 if (size > (MAX_HW_CFG_SIZE_V1 * sizeof(dcd_type_addr_data_t))) {
286 "Error: Image corrupt DCD size %d exceed maximum %d\n",
287 (uint32_t)(size / sizeof(dcd_type_addr_data_t)),
292 length = dcd_v1->preamble.length / sizeof(dcd_type_addr_data_t);
293 ver = detect_imximage_version(imx_hdr);
295 printf("Image Type: Freescale IMX Boot Image\n");
296 printf("Image Ver: %x", ver);
297 printf("%s\n", get_table_entry_name(imximage_versions, NULL, ver));
298 printf("Data Size: ");
299 genimg_print_size(dcd_v1->addr_data[length].type);
300 printf("Load Address: %08x\n", (uint32_t)fhdr_v1->app_dest_ptr);
301 printf("Entry Point: %08x\n", (uint32_t)fhdr_v1->app_code_jump_vector);
304 static void print_hdr_v2(struct imx_header *imx_hdr)
306 imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2;
307 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
308 dcd_v2_t *dcd_v2 = &hdr_v2->dcd_table;
309 uint32_t size, version;
311 size = be16_to_cpu(dcd_v2->header.length) - 8;
312 if (size > (MAX_HW_CFG_SIZE_V2 * sizeof(dcd_addr_data_t))) {
314 "Error: Image corrupt DCD size %d exceed maximum %d\n",
315 (uint32_t)(size / sizeof(dcd_addr_data_t)),
320 version = detect_imximage_version(imx_hdr);
322 printf("Image Type: Freescale IMX Boot Image\n");
323 printf("Image Ver: %x", version);
324 printf("%s\n", get_table_entry_name(imximage_versions, NULL, version));
325 printf("Data Size: ");
326 genimg_print_size(hdr_v2->boot_data.size);
327 printf("Load Address: %08x\n", (uint32_t)fhdr_v2->boot_data_ptr);
328 printf("Entry Point: %08x\n", (uint32_t)fhdr_v2->entry);
331 static void parse_cfg_cmd(struct imx_header *imxhdr, int32_t cmd, char *token,
332 char *name, int lineno, int fld, int dcd_len)
335 static int cmd_ver_first = ~0;
338 case CMD_IMAGE_VERSION:
339 imximage_version = get_cfg_value(token, name, lineno);
340 if (cmd_ver_first == 0) {
341 fprintf(stderr, "Error: %s[%d] - IMAGE_VERSION "
342 "command need be the first before other "
343 "valid command in the file\n", name, lineno);
347 set_hdr_func(imxhdr);
350 imximage_ivt_offset = get_table_entry_id(imximage_boot_offset,
351 "imximage boot option", token);
352 if (imximage_ivt_offset == -1) {
353 fprintf(stderr, "Error: %s[%d] -Invalid boot device"
354 "(%s)\n", name, lineno, token);
358 imximage_init_loadsize =
359 get_table_entry_id(imximage_boot_loadsize,
360 "imximage boot option", token);
362 if (imximage_init_loadsize == -1) {
364 "Error: %s[%d] -Invalid boot device(%s)\n",
365 name, lineno, token);
370 * The SOC loads from the storage starting at address 0
371 * then ensures that the load size contains the offset
373 if (imximage_init_loadsize < imximage_ivt_offset)
374 imximage_init_loadsize = imximage_ivt_offset;
375 if (unlikely(cmd_ver_first != 1))
378 case CMD_BOOT_OFFSET:
379 imximage_ivt_offset = get_cfg_value(token, name, lineno);
380 if (unlikely(cmd_ver_first != 1))
384 value = get_cfg_value(token, name, lineno);
385 (*set_dcd_val)(imxhdr, name, lineno, fld, value, dcd_len);
386 if (unlikely(cmd_ver_first != 1))
392 static void parse_cfg_fld(struct imx_header *imxhdr, int32_t *cmd,
393 char *token, char *name, int lineno, int fld, int *dcd_len)
399 *cmd = get_table_entry_id(imximage_cmds,
400 "imximage commands", token);
402 fprintf(stderr, "Error: %s[%d] - Invalid command"
403 "(%s)\n", name, lineno, token);
408 parse_cfg_cmd(imxhdr, *cmd, token, name, lineno, fld, *dcd_len);
410 case CFG_REG_ADDRESS:
412 if (*cmd != CMD_DATA)
415 value = get_cfg_value(token, name, lineno);
416 (*set_dcd_val)(imxhdr, name, lineno, fld, value, *dcd_len);
418 if (fld == CFG_REG_VALUE) {
420 if (*dcd_len > max_dcd_entries) {
421 fprintf(stderr, "Error: %s[%d] -"
422 "DCD table exceeds maximum size(%d)\n",
423 name, lineno, max_dcd_entries);
432 static uint32_t parse_cfg_file(struct imx_header *imxhdr, char *name)
436 char *token, *saveptr1, *saveptr2;
443 fd = fopen(name, "r");
445 fprintf(stderr, "Error: %s - Can't open DCD file\n", name);
450 * Very simple parsing, line starting with # are comments
453 while ((getline(&line, &len, fd)) > 0) {
456 token = strtok_r(line, "\r\n", &saveptr1);
460 /* Check inside the single line */
461 for (fld = CFG_COMMAND, cmd = CMD_INVALID,
462 line = token; ; line = NULL, fld++) {
463 token = strtok_r(line, " \t", &saveptr2);
467 /* Drop all text starting with '#' as comments */
471 parse_cfg_fld(imxhdr, &cmd, token, name,
472 lineno, fld, &dcd_len);
477 (*set_dcd_rst)(imxhdr, dcd_len, name, lineno);
480 /* Exit if there is no BOOT_FROM field specifying the flash_offset */
481 if (imximage_ivt_offset == FLASH_OFFSET_UNDEFINED) {
482 fprintf(stderr, "Error: No BOOT_FROM tag in %s\n", name);
489 static int imximage_check_image_types(uint8_t type)
491 if (type == IH_TYPE_IMXIMAGE)
497 static int imximage_verify_header(unsigned char *ptr, int image_size,
498 struct mkimage_params *params)
500 struct imx_header *imx_hdr = (struct imx_header *) ptr;
502 if (detect_imximage_version(imx_hdr) == IMXIMAGE_VER_INVALID)
503 return -FDT_ERR_BADSTRUCTURE;
508 static void imximage_print_header(const void *ptr)
510 struct imx_header *imx_hdr = (struct imx_header *) ptr;
511 uint32_t version = detect_imximage_version(imx_hdr);
515 print_hdr_v1(imx_hdr);
518 print_hdr_v2(imx_hdr);
521 err_imximage_version(version);
526 static void imximage_set_header(void *ptr, struct stat *sbuf, int ifd,
527 struct mkimage_params *params)
529 struct imx_header *imxhdr = (struct imx_header *)ptr;
533 * In order to not change the old imx cfg file
534 * by adding VERSION command into it, here need
535 * set up function ptr group to V1 by default.
537 imximage_version = IMXIMAGE_V1;
538 /* Be able to detect if the cfg file has no BOOT_FROM tag */
539 imximage_ivt_offset = FLASH_OFFSET_UNDEFINED;
540 set_hdr_func(imxhdr);
542 /* Parse dcd configuration file */
543 dcd_len = parse_cfg_file(imxhdr, params->imagename);
545 /* Set the imx header */
546 (*set_imx_hdr)(imxhdr, dcd_len, params->ep, imximage_ivt_offset);
551 * MX53 only loads 512 byte multiples in case of SD boot.
552 * MX53 only loads NAND page multiples in case of NAND boot and
553 * supports up to 4096 byte large pages, thus align to 4096.
555 * The remaining fraction of a block bytes would not be loaded!
557 *header_size_ptr = ROUND(sbuf->st_size, 4096);
560 int imximage_check_params(struct mkimage_params *params)
564 if (!strlen(params->imagename)) {
565 fprintf(stderr, "Error: %s - Configuration file not specified, "
566 "it is needed for imximage generation\n",
572 * XIP is not allowed and verify that incompatible
573 * parameters are not sent at the same time
574 * For example, if list is required a data image must not be provided
576 return (params->dflag && (params->fflag || params->lflag)) ||
577 (params->fflag && (params->dflag || params->lflag)) ||
578 (params->lflag && (params->dflag || params->fflag)) ||
579 (params->xflag) || !(strlen(params->imagename));
582 static int imximage_generate(struct mkimage_params *params,
583 struct image_type_params *tparams)
585 struct imx_header *imxhdr;
588 char *datafile = params->datafile;
591 memset(&imximage_header, 0, sizeof(imximage_header));
594 * In order to not change the old imx cfg file
595 * by adding VERSION command into it, here need
596 * set up function ptr group to V1 by default.
598 imximage_version = IMXIMAGE_V1;
599 /* Be able to detect if the cfg file has no BOOT_FROM tag */
600 imximage_ivt_offset = FLASH_OFFSET_UNDEFINED;
601 imximage_csf_size = 0;
602 set_hdr_func(imxhdr);
604 /* Parse dcd configuration file */
605 parse_cfg_file(&imximage_header, params->imagename);
607 /* TODO: check i.MX image V1 handling, for now use 'old' style */
608 if (imximage_version == IMXIMAGE_V1) {
611 if (imximage_init_loadsize < imximage_ivt_offset +
612 sizeof(imx_header_v2_t))
613 imximage_init_loadsize = imximage_ivt_offset +
614 sizeof(imx_header_v2_t);
615 alloc_len = imximage_init_loadsize - imximage_ivt_offset;
618 if (alloc_len < sizeof(struct imx_header)) {
619 fprintf(stderr, "%s: header error\n",
624 imxhdr = malloc(alloc_len);
627 fprintf(stderr, "%s: malloc return failure: %s\n",
628 params->cmdname, strerror(errno));
632 memset(imxhdr, 0, alloc_len);
634 tparams->header_size = alloc_len;
635 tparams->hdr = imxhdr;
637 /* determine data image file length */
639 if (stat(datafile, &sbuf) < 0) {
640 fprintf(stderr, "%s: Can't stat %s: %s\n",
641 params->cmdname, datafile, strerror(errno));
645 pad_len = ROUND(sbuf.st_size, 4096) - sbuf.st_size;
647 /* TODO: check i.MX image V1 handling, for now use 'old' style */
648 if (imximage_version == IMXIMAGE_V1)
656 * imximage parameters
658 static struct image_type_params imximage_params = {
659 .name = "Freescale i.MX Boot Image support",
662 .check_image_type = imximage_check_image_types,
663 .verify_header = imximage_verify_header,
664 .print_header = imximage_print_header,
665 .set_header = imximage_set_header,
666 .check_params = imximage_check_params,
667 .vrec_header = imximage_generate,
670 void init_imx_image_type(void)
672 mkimage_register(&imximage_params);