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 */
19 #define UNDEFINED 0xFFFFFFFF
22 * Supported commands for configuration file
24 static table_entry_t imximage_cmds[] = {
25 {CMD_BOOT_FROM, "BOOT_FROM", "boot command", },
26 {CMD_BOOT_OFFSET, "BOOT_OFFSET", "Boot offset", },
27 {CMD_DATA, "DATA", "Reg Write Data", },
28 {CMD_CSF, "CSF", "Command Sequence File", },
29 {CMD_IMAGE_VERSION, "IMAGE_VERSION", "image version", },
34 * Supported Boot options for configuration file
35 * this is needed to set the correct flash offset
37 static table_entry_t imximage_boot_offset[] = {
38 {FLASH_OFFSET_ONENAND, "onenand", "OneNAND Flash",},
39 {FLASH_OFFSET_NAND, "nand", "NAND Flash", },
40 {FLASH_OFFSET_NOR, "nor", "NOR Flash", },
41 {FLASH_OFFSET_SATA, "sata", "SATA Disk", },
42 {FLASH_OFFSET_SD, "sd", "SD Card", },
43 {FLASH_OFFSET_SPI, "spi", "SPI Flash", },
44 {-1, "", "Invalid", },
48 * Supported Boot options for configuration file
49 * this is needed to determine the initial load size
51 static table_entry_t imximage_boot_loadsize[] = {
52 {FLASH_LOADSIZE_ONENAND, "onenand", "OneNAND Flash",},
53 {FLASH_LOADSIZE_NAND, "nand", "NAND Flash", },
54 {FLASH_LOADSIZE_NOR, "nor", "NOR Flash", },
55 {FLASH_LOADSIZE_SATA, "sata", "SATA Disk", },
56 {FLASH_LOADSIZE_SD, "sd", "SD Card", },
57 {FLASH_LOADSIZE_SPI, "spi", "SPI Flash", },
58 {-1, "", "Invalid", },
62 * IMXIMAGE version definition for i.MX chips
64 static table_entry_t imximage_versions[] = {
65 {IMXIMAGE_V1, "", " (i.MX25/35/51 compatible)", },
66 {IMXIMAGE_V2, "", " (i.MX53/6 compatible)", },
67 {-1, "", " (Invalid)", },
70 static struct imx_header imximage_header;
71 static uint32_t imximage_version;
73 * Image Vector Table Offset
74 * Initialized to a wrong not 4-bytes aligned address to
75 * check if it is was set by the cfg file.
77 static uint32_t imximage_ivt_offset = UNDEFINED;
78 static uint32_t imximage_csf_size = UNDEFINED;
79 /* Initial Load Region Size */
80 static uint32_t imximage_init_loadsize;
82 static set_dcd_val_t set_dcd_val;
83 static set_dcd_rst_t set_dcd_rst;
84 static set_imx_hdr_t set_imx_hdr;
85 static uint32_t max_dcd_entries;
86 static uint32_t *header_size_ptr;
87 static uint32_t *csf_ptr;
89 static uint32_t get_cfg_value(char *token, char *name, int linenr)
95 value = strtoul(token, &endptr, 16);
96 if (errno || (token == endptr)) {
97 fprintf(stderr, "Error: %s[%d] - Invalid hex data(%s)\n",
104 static uint32_t detect_imximage_version(struct imx_header *imx_hdr)
106 imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1;
107 imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2;
108 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
109 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
111 /* Try to detect V1 */
112 if ((fhdr_v1->app_code_barker == APP_CODE_BARKER) &&
113 (hdr_v1->dcd_table.preamble.barker == DCD_BARKER))
116 /* Try to detect V2 */
117 if ((fhdr_v2->header.tag == IVT_HEADER_TAG) &&
118 (hdr_v2->dcd_table.header.tag == DCD_HEADER_TAG))
121 return IMXIMAGE_VER_INVALID;
124 static void err_imximage_version(int version)
127 "Error: Unsupported imximage version:%d\n", version);
132 static void set_dcd_val_v1(struct imx_header *imxhdr, char *name, int lineno,
133 int fld, uint32_t value, uint32_t off)
135 dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table;
139 /* Byte, halfword, word */
140 if ((value != 1) && (value != 2) && (value != 4)) {
141 fprintf(stderr, "Error: %s[%d] - "
142 "Invalid register size " "(%d)\n",
143 name, lineno, value);
146 dcd_v1->addr_data[off].type = value;
148 case CFG_REG_ADDRESS:
149 dcd_v1->addr_data[off].addr = value;
152 dcd_v1->addr_data[off].value = value;
160 static void set_dcd_val_v2(struct imx_header *imxhdr, char *name, int lineno,
161 int fld, uint32_t value, uint32_t off)
163 dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table;
166 case CFG_REG_ADDRESS:
167 dcd_v2->addr_data[off].addr = cpu_to_be32(value);
170 dcd_v2->addr_data[off].value = cpu_to_be32(value);
179 * Complete setting up the rest field of DCD of V1
180 * such as barker code and DCD data length.
182 static void set_dcd_rst_v1(struct imx_header *imxhdr, uint32_t dcd_len,
183 char *name, int lineno)
185 dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table;
187 dcd_v1->preamble.barker = DCD_BARKER;
188 dcd_v1->preamble.length = dcd_len * sizeof(dcd_type_addr_data_t);
192 * Complete setting up the reset field of DCD of V2
193 * such as DCD tag, version, length, etc.
195 static void set_dcd_rst_v2(struct imx_header *imxhdr, uint32_t dcd_len,
196 char *name, int lineno)
198 dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table;
200 dcd_v2->header.tag = DCD_HEADER_TAG;
201 dcd_v2->header.length = cpu_to_be16(
202 dcd_len * sizeof(dcd_addr_data_t) + 8);
203 dcd_v2->header.version = DCD_VERSION;
204 dcd_v2->write_dcd_command.tag = DCD_COMMAND_TAG;
205 dcd_v2->write_dcd_command.length = cpu_to_be16(
206 dcd_len * sizeof(dcd_addr_data_t) + 4);
207 dcd_v2->write_dcd_command.param = DCD_COMMAND_PARAM;
210 static void set_imx_hdr_v1(struct imx_header *imxhdr, uint32_t dcd_len,
211 uint32_t entry_point, uint32_t flash_offset)
213 imx_header_v1_t *hdr_v1 = &imxhdr->header.hdr_v1;
214 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
215 dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table;
217 uint32_t header_length = (((char *)&dcd_v1->addr_data[dcd_len].addr)
220 /* Set magic number */
221 fhdr_v1->app_code_barker = APP_CODE_BARKER;
223 /* TODO: check i.MX image V1 handling, for now use 'old' style */
224 hdr_base = entry_point - 4096;
225 fhdr_v1->app_dest_ptr = hdr_base - flash_offset;
226 fhdr_v1->app_code_jump_vector = entry_point;
228 fhdr_v1->dcd_ptr_ptr = hdr_base + offsetof(flash_header_v1_t, dcd_ptr);
229 fhdr_v1->dcd_ptr = hdr_base + offsetof(imx_header_v1_t, dcd_table);
231 /* Security feature are not supported */
232 fhdr_v1->app_code_csf = 0;
233 fhdr_v1->super_root_key = 0;
234 header_size_ptr = (uint32_t *)(((char *)imxhdr) + header_length - 4);
237 static void set_imx_hdr_v2(struct imx_header *imxhdr, uint32_t dcd_len,
238 uint32_t entry_point, uint32_t flash_offset)
240 imx_header_v2_t *hdr_v2 = &imxhdr->header.hdr_v2;
241 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
244 /* Set magic number */
245 fhdr_v2->header.tag = IVT_HEADER_TAG; /* 0xD1 */
246 fhdr_v2->header.length = cpu_to_be16(sizeof(flash_header_v2_t));
247 fhdr_v2->header.version = IVT_VERSION; /* 0x40 */
249 fhdr_v2->entry = entry_point;
250 fhdr_v2->reserved1 = fhdr_v2->reserved2 = 0;
251 hdr_base = entry_point - imximage_init_loadsize +
253 fhdr_v2->self = hdr_base;
254 fhdr_v2->dcd_ptr = hdr_base + offsetof(imx_header_v2_t, dcd_table);
255 fhdr_v2->boot_data_ptr = hdr_base
256 + offsetof(imx_header_v2_t, boot_data);
257 hdr_v2->boot_data.start = entry_point - imximage_init_loadsize;
261 header_size_ptr = &hdr_v2->boot_data.size;
262 csf_ptr = &fhdr_v2->csf;
265 static void set_hdr_func(struct imx_header *imxhdr)
267 switch (imximage_version) {
269 set_dcd_val = set_dcd_val_v1;
270 set_dcd_rst = set_dcd_rst_v1;
271 set_imx_hdr = set_imx_hdr_v1;
272 max_dcd_entries = MAX_HW_CFG_SIZE_V1;
275 set_dcd_val = set_dcd_val_v2;
276 set_dcd_rst = set_dcd_rst_v2;
277 set_imx_hdr = set_imx_hdr_v2;
278 max_dcd_entries = MAX_HW_CFG_SIZE_V2;
281 err_imximage_version(imximage_version);
286 static void print_hdr_v1(struct imx_header *imx_hdr)
288 imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1;
289 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
290 dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table;
291 uint32_t size, length, ver;
293 size = dcd_v1->preamble.length;
294 if (size > (MAX_HW_CFG_SIZE_V1 * sizeof(dcd_type_addr_data_t))) {
296 "Error: Image corrupt DCD size %d exceed maximum %d\n",
297 (uint32_t)(size / sizeof(dcd_type_addr_data_t)),
302 length = dcd_v1->preamble.length / sizeof(dcd_type_addr_data_t);
303 ver = detect_imximage_version(imx_hdr);
305 printf("Image Type: Freescale IMX Boot Image\n");
306 printf("Image Ver: %x", ver);
307 printf("%s\n", get_table_entry_name(imximage_versions, NULL, ver));
308 printf("Data Size: ");
309 genimg_print_size(dcd_v1->addr_data[length].type);
310 printf("Load Address: %08x\n", (uint32_t)fhdr_v1->app_dest_ptr);
311 printf("Entry Point: %08x\n", (uint32_t)fhdr_v1->app_code_jump_vector);
314 static void print_hdr_v2(struct imx_header *imx_hdr)
316 imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2;
317 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
318 dcd_v2_t *dcd_v2 = &hdr_v2->dcd_table;
319 uint32_t size, version;
321 size = be16_to_cpu(dcd_v2->header.length) - 8;
322 if (size > (MAX_HW_CFG_SIZE_V2 * sizeof(dcd_addr_data_t))) {
324 "Error: Image corrupt DCD size %d exceed maximum %d\n",
325 (uint32_t)(size / sizeof(dcd_addr_data_t)),
330 version = detect_imximage_version(imx_hdr);
332 printf("Image Type: Freescale IMX Boot Image\n");
333 printf("Image Ver: %x", version);
334 printf("%s\n", get_table_entry_name(imximage_versions, NULL, version));
335 printf("Data Size: ");
336 genimg_print_size(hdr_v2->boot_data.size);
337 printf("Load Address: %08x\n", (uint32_t)fhdr_v2->boot_data_ptr);
338 printf("Entry Point: %08x\n", (uint32_t)fhdr_v2->entry);
339 if (fhdr_v2->csf && (imximage_ivt_offset != UNDEFINED) &&
340 (imximage_csf_size != UNDEFINED)) {
341 printf("HAB Blocks: %08x %08x %08x\n",
342 (uint32_t)fhdr_v2->self, 0,
343 hdr_v2->boot_data.size - imximage_ivt_offset -
348 static void parse_cfg_cmd(struct imx_header *imxhdr, int32_t cmd, char *token,
349 char *name, int lineno, int fld, int dcd_len)
352 static int cmd_ver_first = ~0;
355 case CMD_IMAGE_VERSION:
356 imximage_version = get_cfg_value(token, name, lineno);
357 if (cmd_ver_first == 0) {
358 fprintf(stderr, "Error: %s[%d] - IMAGE_VERSION "
359 "command need be the first before other "
360 "valid command in the file\n", name, lineno);
364 set_hdr_func(imxhdr);
367 imximage_ivt_offset = get_table_entry_id(imximage_boot_offset,
368 "imximage boot option", token);
369 if (imximage_ivt_offset == -1) {
370 fprintf(stderr, "Error: %s[%d] -Invalid boot device"
371 "(%s)\n", name, lineno, token);
375 imximage_init_loadsize =
376 get_table_entry_id(imximage_boot_loadsize,
377 "imximage boot option", token);
379 if (imximage_init_loadsize == -1) {
381 "Error: %s[%d] -Invalid boot device(%s)\n",
382 name, lineno, token);
387 * The SOC loads from the storage starting at address 0
388 * then ensures that the load size contains the offset
390 if (imximage_init_loadsize < imximage_ivt_offset)
391 imximage_init_loadsize = imximage_ivt_offset;
392 if (unlikely(cmd_ver_first != 1))
395 case CMD_BOOT_OFFSET:
396 imximage_ivt_offset = get_cfg_value(token, name, lineno);
397 if (unlikely(cmd_ver_first != 1))
401 value = get_cfg_value(token, name, lineno);
402 (*set_dcd_val)(imxhdr, name, lineno, fld, value, dcd_len);
403 if (unlikely(cmd_ver_first != 1))
407 if (imximage_version != 2) {
409 "Error: %s[%d] - CSF only supported for VERSION 2(%s)\n",
410 name, lineno, token);
413 imximage_csf_size = get_cfg_value(token, name, lineno);
414 if (unlikely(cmd_ver_first != 1))
420 static void parse_cfg_fld(struct imx_header *imxhdr, int32_t *cmd,
421 char *token, char *name, int lineno, int fld, int *dcd_len)
427 *cmd = get_table_entry_id(imximage_cmds,
428 "imximage commands", token);
430 fprintf(stderr, "Error: %s[%d] - Invalid command"
431 "(%s)\n", name, lineno, token);
436 parse_cfg_cmd(imxhdr, *cmd, token, name, lineno, fld, *dcd_len);
438 case CFG_REG_ADDRESS:
440 if (*cmd != CMD_DATA)
443 value = get_cfg_value(token, name, lineno);
444 (*set_dcd_val)(imxhdr, name, lineno, fld, value, *dcd_len);
446 if (fld == CFG_REG_VALUE) {
448 if (*dcd_len > max_dcd_entries) {
449 fprintf(stderr, "Error: %s[%d] -"
450 "DCD table exceeds maximum size(%d)\n",
451 name, lineno, max_dcd_entries);
460 static uint32_t parse_cfg_file(struct imx_header *imxhdr, char *name)
464 char *token, *saveptr1, *saveptr2;
471 fd = fopen(name, "r");
473 fprintf(stderr, "Error: %s - Can't open DCD file\n", name);
478 * Very simple parsing, line starting with # are comments
481 while ((getline(&line, &len, fd)) > 0) {
484 token = strtok_r(line, "\r\n", &saveptr1);
488 /* Check inside the single line */
489 for (fld = CFG_COMMAND, cmd = CMD_INVALID,
490 line = token; ; line = NULL, fld++) {
491 token = strtok_r(line, " \t", &saveptr2);
495 /* Drop all text starting with '#' as comments */
499 parse_cfg_fld(imxhdr, &cmd, token, name,
500 lineno, fld, &dcd_len);
505 (*set_dcd_rst)(imxhdr, dcd_len, name, lineno);
508 /* Exit if there is no BOOT_FROM field specifying the flash_offset */
509 if (imximage_ivt_offset == FLASH_OFFSET_UNDEFINED) {
510 fprintf(stderr, "Error: No BOOT_FROM tag in %s\n", name);
517 static int imximage_check_image_types(uint8_t type)
519 if (type == IH_TYPE_IMXIMAGE)
525 static int imximage_verify_header(unsigned char *ptr, int image_size,
526 struct mkimage_params *params)
528 struct imx_header *imx_hdr = (struct imx_header *) ptr;
530 if (detect_imximage_version(imx_hdr) == IMXIMAGE_VER_INVALID)
531 return -FDT_ERR_BADSTRUCTURE;
536 static void imximage_print_header(const void *ptr)
538 struct imx_header *imx_hdr = (struct imx_header *) ptr;
539 uint32_t version = detect_imximage_version(imx_hdr);
543 print_hdr_v1(imx_hdr);
546 print_hdr_v2(imx_hdr);
549 err_imximage_version(version);
554 static void imximage_set_header(void *ptr, struct stat *sbuf, int ifd,
555 struct mkimage_params *params)
557 struct imx_header *imxhdr = (struct imx_header *)ptr;
561 * In order to not change the old imx cfg file
562 * by adding VERSION command into it, here need
563 * set up function ptr group to V1 by default.
565 imximage_version = IMXIMAGE_V1;
566 /* Be able to detect if the cfg file has no BOOT_FROM tag */
567 imximage_ivt_offset = FLASH_OFFSET_UNDEFINED;
568 imximage_csf_size = 0;
569 set_hdr_func(imxhdr);
571 /* Parse dcd configuration file */
572 dcd_len = parse_cfg_file(imxhdr, params->imagename);
574 /* Set the imx header */
575 (*set_imx_hdr)(imxhdr, dcd_len, params->ep, imximage_ivt_offset);
580 * MX53 only loads 512 byte multiples in case of SD boot.
581 * MX53 only loads NAND page multiples in case of NAND boot and
582 * supports up to 4096 byte large pages, thus align to 4096.
584 * The remaining fraction of a block bytes would not be loaded!
586 *header_size_ptr = ROUND(sbuf->st_size, 4096);
588 if (csf_ptr && imximage_csf_size) {
589 *csf_ptr = params->ep - imximage_init_loadsize +
591 *header_size_ptr += imximage_csf_size;
595 int imximage_check_params(struct mkimage_params *params)
599 if (!strlen(params->imagename)) {
600 fprintf(stderr, "Error: %s - Configuration file not specified, "
601 "it is needed for imximage generation\n",
607 * XIP is not allowed and verify that incompatible
608 * parameters are not sent at the same time
609 * For example, if list is required a data image must not be provided
611 return (params->dflag && (params->fflag || params->lflag)) ||
612 (params->fflag && (params->dflag || params->lflag)) ||
613 (params->lflag && (params->dflag || params->fflag)) ||
614 (params->xflag) || !(strlen(params->imagename));
617 static int imximage_generate(struct mkimage_params *params,
618 struct image_type_params *tparams)
620 struct imx_header *imxhdr;
623 char *datafile = params->datafile;
626 memset(&imximage_header, 0, sizeof(imximage_header));
629 * In order to not change the old imx cfg file
630 * by adding VERSION command into it, here need
631 * set up function ptr group to V1 by default.
633 imximage_version = IMXIMAGE_V1;
634 /* Be able to detect if the cfg file has no BOOT_FROM tag */
635 imximage_ivt_offset = FLASH_OFFSET_UNDEFINED;
636 imximage_csf_size = 0;
637 set_hdr_func(imxhdr);
639 /* Parse dcd configuration file */
640 parse_cfg_file(&imximage_header, params->imagename);
642 /* TODO: check i.MX image V1 handling, for now use 'old' style */
643 if (imximage_version == IMXIMAGE_V1) {
646 if (imximage_init_loadsize < imximage_ivt_offset +
647 sizeof(imx_header_v2_t))
648 imximage_init_loadsize = imximage_ivt_offset +
649 sizeof(imx_header_v2_t);
650 alloc_len = imximage_init_loadsize - imximage_ivt_offset;
653 if (alloc_len < sizeof(struct imx_header)) {
654 fprintf(stderr, "%s: header error\n",
659 imxhdr = malloc(alloc_len);
662 fprintf(stderr, "%s: malloc return failure: %s\n",
663 params->cmdname, strerror(errno));
667 memset(imxhdr, 0, alloc_len);
669 tparams->header_size = alloc_len;
670 tparams->hdr = imxhdr;
672 /* determine data image file length */
674 if (stat(datafile, &sbuf) < 0) {
675 fprintf(stderr, "%s: Can't stat %s: %s\n",
676 params->cmdname, datafile, strerror(errno));
680 pad_len = ROUND(sbuf.st_size, 4096) - sbuf.st_size;
682 /* TODO: check i.MX image V1 handling, for now use 'old' style */
683 if (imximage_version == IMXIMAGE_V1)
691 * imximage parameters
693 static struct image_type_params imximage_params = {
694 .name = "Freescale i.MX Boot Image support",
697 .check_image_type = imximage_check_image_types,
698 .verify_header = imximage_verify_header,
699 .print_header = imximage_print_header,
700 .set_header = imximage_set_header,
701 .check_params = imximage_check_params,
702 .vrec_header = imximage_generate,
705 void init_imx_image_type(void)
707 mkimage_register(&imximage_params);