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+
16 #define UNDEFINED 0xFFFFFFFF
19 * Supported commands for configuration file
21 static table_entry_t imximage_cmds
[] = {
22 {CMD_BOOT_FROM
, "BOOT_FROM", "boot command", },
23 {CMD_BOOT_OFFSET
, "BOOT_OFFSET", "Boot offset", },
24 {CMD_DATA
, "DATA", "Reg Write Data", },
25 {CMD_CSF
, "CSF", "Command Sequence File", },
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
;
70 * Image Vector Table Offset
71 * Initialized to a wrong not 4-bytes aligned address to
72 * check if it is was set by the cfg file.
74 static uint32_t imximage_ivt_offset
= UNDEFINED
;
75 static uint32_t imximage_csf_size
= UNDEFINED
;
76 /* Initial Load Region Size */
77 static uint32_t imximage_init_loadsize
;
79 static set_dcd_val_t set_dcd_val
;
80 static set_dcd_rst_t set_dcd_rst
;
81 static set_imx_hdr_t set_imx_hdr
;
82 static uint32_t max_dcd_entries
;
83 static uint32_t *header_size_ptr
;
84 static uint32_t *csf_ptr
;
86 static uint32_t get_cfg_value(char *token
, char *name
, int linenr
)
92 value
= strtoul(token
, &endptr
, 16);
93 if (errno
|| (token
== endptr
)) {
94 fprintf(stderr
, "Error: %s[%d] - Invalid hex data(%s)\n",
101 static uint32_t detect_imximage_version(struct imx_header
*imx_hdr
)
103 imx_header_v1_t
*hdr_v1
= &imx_hdr
->header
.hdr_v1
;
104 imx_header_v2_t
*hdr_v2
= &imx_hdr
->header
.hdr_v2
;
105 flash_header_v1_t
*fhdr_v1
= &hdr_v1
->fhdr
;
106 flash_header_v2_t
*fhdr_v2
= &hdr_v2
->fhdr
;
108 /* Try to detect V1 */
109 if ((fhdr_v1
->app_code_barker
== APP_CODE_BARKER
) &&
110 (hdr_v1
->dcd_table
.preamble
.barker
== DCD_BARKER
))
113 /* Try to detect V2 */
114 if ((fhdr_v2
->header
.tag
== IVT_HEADER_TAG
) &&
115 (hdr_v2
->dcd_table
.header
.tag
== DCD_HEADER_TAG
))
118 return IMXIMAGE_VER_INVALID
;
121 static void err_imximage_version(int version
)
124 "Error: Unsupported imximage version:%d\n", version
);
129 static void set_dcd_val_v1(struct imx_header
*imxhdr
, char *name
, int lineno
,
130 int fld
, uint32_t value
, uint32_t off
)
132 dcd_v1_t
*dcd_v1
= &imxhdr
->header
.hdr_v1
.dcd_table
;
136 /* Byte, halfword, word */
137 if ((value
!= 1) && (value
!= 2) && (value
!= 4)) {
138 fprintf(stderr
, "Error: %s[%d] - "
139 "Invalid register size " "(%d)\n",
140 name
, lineno
, value
);
143 dcd_v1
->addr_data
[off
].type
= value
;
145 case CFG_REG_ADDRESS
:
146 dcd_v1
->addr_data
[off
].addr
= value
;
149 dcd_v1
->addr_data
[off
].value
= value
;
157 static void set_dcd_val_v2(struct imx_header
*imxhdr
, char *name
, int lineno
,
158 int fld
, uint32_t value
, uint32_t off
)
160 dcd_v2_t
*dcd_v2
= &imxhdr
->header
.hdr_v2
.dcd_table
;
163 case CFG_REG_ADDRESS
:
164 dcd_v2
->addr_data
[off
].addr
= cpu_to_be32(value
);
167 dcd_v2
->addr_data
[off
].value
= cpu_to_be32(value
);
176 * Complete setting up the rest field of DCD of V1
177 * such as barker code and DCD data length.
179 static void set_dcd_rst_v1(struct imx_header
*imxhdr
, uint32_t dcd_len
,
180 char *name
, int lineno
)
182 dcd_v1_t
*dcd_v1
= &imxhdr
->header
.hdr_v1
.dcd_table
;
184 dcd_v1
->preamble
.barker
= DCD_BARKER
;
185 dcd_v1
->preamble
.length
= dcd_len
* sizeof(dcd_type_addr_data_t
);
189 * Complete setting up the reset field of DCD of V2
190 * such as DCD tag, version, length, etc.
192 static void set_dcd_rst_v2(struct imx_header
*imxhdr
, uint32_t dcd_len
,
193 char *name
, int lineno
)
195 dcd_v2_t
*dcd_v2
= &imxhdr
->header
.hdr_v2
.dcd_table
;
197 dcd_v2
->header
.tag
= DCD_HEADER_TAG
;
198 dcd_v2
->header
.length
= cpu_to_be16(
199 dcd_len
* sizeof(dcd_addr_data_t
) + 8);
200 dcd_v2
->header
.version
= DCD_VERSION
;
201 dcd_v2
->write_dcd_command
.tag
= DCD_COMMAND_TAG
;
202 dcd_v2
->write_dcd_command
.length
= cpu_to_be16(
203 dcd_len
* sizeof(dcd_addr_data_t
) + 4);
204 dcd_v2
->write_dcd_command
.param
= DCD_COMMAND_PARAM
;
207 static void set_imx_hdr_v1(struct imx_header
*imxhdr
, uint32_t dcd_len
,
208 uint32_t entry_point
, uint32_t flash_offset
)
210 imx_header_v1_t
*hdr_v1
= &imxhdr
->header
.hdr_v1
;
211 flash_header_v1_t
*fhdr_v1
= &hdr_v1
->fhdr
;
212 dcd_v1_t
*dcd_v1
= &hdr_v1
->dcd_table
;
214 uint32_t header_length
= (((char *)&dcd_v1
->addr_data
[dcd_len
].addr
)
217 /* Set magic number */
218 fhdr_v1
->app_code_barker
= APP_CODE_BARKER
;
220 /* TODO: check i.MX image V1 handling, for now use 'old' style */
221 hdr_base
= entry_point
- 4096;
222 fhdr_v1
->app_dest_ptr
= hdr_base
- flash_offset
;
223 fhdr_v1
->app_code_jump_vector
= entry_point
;
225 fhdr_v1
->dcd_ptr_ptr
= hdr_base
+ offsetof(flash_header_v1_t
, dcd_ptr
);
226 fhdr_v1
->dcd_ptr
= hdr_base
+ offsetof(imx_header_v1_t
, dcd_table
);
228 /* Security feature are not supported */
229 fhdr_v1
->app_code_csf
= 0;
230 fhdr_v1
->super_root_key
= 0;
231 header_size_ptr
= (uint32_t *)(((char *)imxhdr
) + header_length
- 4);
234 static void set_imx_hdr_v2(struct imx_header
*imxhdr
, uint32_t dcd_len
,
235 uint32_t entry_point
, uint32_t flash_offset
)
237 imx_header_v2_t
*hdr_v2
= &imxhdr
->header
.hdr_v2
;
238 flash_header_v2_t
*fhdr_v2
= &hdr_v2
->fhdr
;
241 /* Set magic number */
242 fhdr_v2
->header
.tag
= IVT_HEADER_TAG
; /* 0xD1 */
243 fhdr_v2
->header
.length
= cpu_to_be16(sizeof(flash_header_v2_t
));
244 fhdr_v2
->header
.version
= IVT_VERSION
; /* 0x40 */
246 fhdr_v2
->entry
= entry_point
;
247 fhdr_v2
->reserved1
= fhdr_v2
->reserved2
= 0;
248 hdr_base
= entry_point
- imximage_init_loadsize
+
250 fhdr_v2
->self
= hdr_base
;
251 fhdr_v2
->dcd_ptr
= hdr_base
+ offsetof(imx_header_v2_t
, dcd_table
);
252 fhdr_v2
->boot_data_ptr
= hdr_base
253 + offsetof(imx_header_v2_t
, boot_data
);
254 hdr_v2
->boot_data
.start
= entry_point
- imximage_init_loadsize
;
258 header_size_ptr
= &hdr_v2
->boot_data
.size
;
259 csf_ptr
= &fhdr_v2
->csf
;
262 static void set_hdr_func(struct imx_header
*imxhdr
)
264 switch (imximage_version
) {
266 set_dcd_val
= set_dcd_val_v1
;
267 set_dcd_rst
= set_dcd_rst_v1
;
268 set_imx_hdr
= set_imx_hdr_v1
;
269 max_dcd_entries
= MAX_HW_CFG_SIZE_V1
;
272 set_dcd_val
= set_dcd_val_v2
;
273 set_dcd_rst
= set_dcd_rst_v2
;
274 set_imx_hdr
= set_imx_hdr_v2
;
275 max_dcd_entries
= MAX_HW_CFG_SIZE_V2
;
278 err_imximage_version(imximage_version
);
283 static void print_hdr_v1(struct imx_header
*imx_hdr
)
285 imx_header_v1_t
*hdr_v1
= &imx_hdr
->header
.hdr_v1
;
286 flash_header_v1_t
*fhdr_v1
= &hdr_v1
->fhdr
;
287 dcd_v1_t
*dcd_v1
= &hdr_v1
->dcd_table
;
288 uint32_t size
, length
, ver
;
290 size
= dcd_v1
->preamble
.length
;
291 if (size
> (MAX_HW_CFG_SIZE_V1
* sizeof(dcd_type_addr_data_t
))) {
293 "Error: Image corrupt DCD size %d exceed maximum %d\n",
294 (uint32_t)(size
/ sizeof(dcd_type_addr_data_t
)),
299 length
= dcd_v1
->preamble
.length
/ sizeof(dcd_type_addr_data_t
);
300 ver
= detect_imximage_version(imx_hdr
);
302 printf("Image Type: Freescale IMX Boot Image\n");
303 printf("Image Ver: %x", ver
);
304 printf("%s\n", get_table_entry_name(imximage_versions
, NULL
, ver
));
305 printf("Data Size: ");
306 genimg_print_size(dcd_v1
->addr_data
[length
].type
);
307 printf("Load Address: %08x\n", (uint32_t)fhdr_v1
->app_dest_ptr
);
308 printf("Entry Point: %08x\n", (uint32_t)fhdr_v1
->app_code_jump_vector
);
311 static void print_hdr_v2(struct imx_header
*imx_hdr
)
313 imx_header_v2_t
*hdr_v2
= &imx_hdr
->header
.hdr_v2
;
314 flash_header_v2_t
*fhdr_v2
= &hdr_v2
->fhdr
;
315 dcd_v2_t
*dcd_v2
= &hdr_v2
->dcd_table
;
316 uint32_t size
, version
;
318 size
= be16_to_cpu(dcd_v2
->header
.length
) - 8;
319 if (size
> (MAX_HW_CFG_SIZE_V2
* sizeof(dcd_addr_data_t
))) {
321 "Error: Image corrupt DCD size %d exceed maximum %d\n",
322 (uint32_t)(size
/ sizeof(dcd_addr_data_t
)),
327 version
= detect_imximage_version(imx_hdr
);
329 printf("Image Type: Freescale IMX Boot Image\n");
330 printf("Image Ver: %x", version
);
331 printf("%s\n", get_table_entry_name(imximage_versions
, NULL
, version
));
332 printf("Data Size: ");
333 genimg_print_size(hdr_v2
->boot_data
.size
);
334 printf("Load Address: %08x\n", (uint32_t)fhdr_v2
->boot_data_ptr
);
335 printf("Entry Point: %08x\n", (uint32_t)fhdr_v2
->entry
);
336 if (fhdr_v2
->csf
&& (imximage_ivt_offset
!= UNDEFINED
) &&
337 (imximage_csf_size
!= UNDEFINED
)) {
338 printf("HAB Blocks: %08x %08x %08x\n",
339 (uint32_t)fhdr_v2
->self
, 0,
340 hdr_v2
->boot_data
.size
- imximage_ivt_offset
-
345 static void parse_cfg_cmd(struct imx_header
*imxhdr
, int32_t cmd
, char *token
,
346 char *name
, int lineno
, int fld
, int dcd_len
)
349 static int cmd_ver_first
= ~0;
352 case CMD_IMAGE_VERSION
:
353 imximage_version
= get_cfg_value(token
, name
, lineno
);
354 if (cmd_ver_first
== 0) {
355 fprintf(stderr
, "Error: %s[%d] - IMAGE_VERSION "
356 "command need be the first before other "
357 "valid command in the file\n", name
, lineno
);
361 set_hdr_func(imxhdr
);
364 imximage_ivt_offset
= get_table_entry_id(imximage_boot_offset
,
365 "imximage boot option", token
);
366 if (imximage_ivt_offset
== -1) {
367 fprintf(stderr
, "Error: %s[%d] -Invalid boot device"
368 "(%s)\n", name
, lineno
, token
);
372 imximage_init_loadsize
=
373 get_table_entry_id(imximage_boot_loadsize
,
374 "imximage boot option", token
);
376 if (imximage_init_loadsize
== -1) {
378 "Error: %s[%d] -Invalid boot device(%s)\n",
379 name
, lineno
, token
);
384 * The SOC loads from the storage starting at address 0
385 * then ensures that the load size contains the offset
387 if (imximage_init_loadsize
< imximage_ivt_offset
)
388 imximage_init_loadsize
= imximage_ivt_offset
;
389 if (unlikely(cmd_ver_first
!= 1))
392 case CMD_BOOT_OFFSET
:
393 imximage_ivt_offset
= get_cfg_value(token
, name
, lineno
);
394 if (unlikely(cmd_ver_first
!= 1))
398 value
= get_cfg_value(token
, name
, lineno
);
399 (*set_dcd_val
)(imxhdr
, name
, lineno
, fld
, value
, dcd_len
);
400 if (unlikely(cmd_ver_first
!= 1))
404 if (imximage_version
!= 2) {
406 "Error: %s[%d] - CSF only supported for VERSION 2(%s)\n",
407 name
, lineno
, token
);
410 imximage_csf_size
= get_cfg_value(token
, name
, lineno
);
411 if (unlikely(cmd_ver_first
!= 1))
417 static void parse_cfg_fld(struct imx_header
*imxhdr
, int32_t *cmd
,
418 char *token
, char *name
, int lineno
, int fld
, int *dcd_len
)
424 *cmd
= get_table_entry_id(imximage_cmds
,
425 "imximage commands", token
);
427 fprintf(stderr
, "Error: %s[%d] - Invalid command"
428 "(%s)\n", name
, lineno
, token
);
433 parse_cfg_cmd(imxhdr
, *cmd
, token
, name
, lineno
, fld
, *dcd_len
);
435 case CFG_REG_ADDRESS
:
437 if (*cmd
!= CMD_DATA
)
440 value
= get_cfg_value(token
, name
, lineno
);
441 (*set_dcd_val
)(imxhdr
, name
, lineno
, fld
, value
, *dcd_len
);
443 if (fld
== CFG_REG_VALUE
) {
445 if (*dcd_len
> max_dcd_entries
) {
446 fprintf(stderr
, "Error: %s[%d] -"
447 "DCD table exceeds maximum size(%d)\n",
448 name
, lineno
, max_dcd_entries
);
457 static uint32_t parse_cfg_file(struct imx_header
*imxhdr
, char *name
)
461 char *token
, *saveptr1
, *saveptr2
;
468 fd
= fopen(name
, "r");
470 fprintf(stderr
, "Error: %s - Can't open DCD file\n", name
);
475 * Very simple parsing, line starting with # are comments
478 while ((getline(&line
, &len
, fd
)) > 0) {
481 token
= strtok_r(line
, "\r\n", &saveptr1
);
485 /* Check inside the single line */
486 for (fld
= CFG_COMMAND
, cmd
= CMD_INVALID
,
487 line
= token
; ; line
= NULL
, fld
++) {
488 token
= strtok_r(line
, " \t", &saveptr2
);
492 /* Drop all text starting with '#' as comments */
496 parse_cfg_fld(imxhdr
, &cmd
, token
, name
,
497 lineno
, fld
, &dcd_len
);
502 (*set_dcd_rst
)(imxhdr
, dcd_len
, name
, lineno
);
505 /* Exit if there is no BOOT_FROM field specifying the flash_offset */
506 if (imximage_ivt_offset
== FLASH_OFFSET_UNDEFINED
) {
507 fprintf(stderr
, "Error: No BOOT_FROM tag in %s\n", name
);
514 static int imximage_check_image_types(uint8_t type
)
516 if (type
== IH_TYPE_IMXIMAGE
)
522 static int imximage_verify_header(unsigned char *ptr
, int image_size
,
523 struct mkimage_params
*params
)
525 struct imx_header
*imx_hdr
= (struct imx_header
*) ptr
;
527 if (detect_imximage_version(imx_hdr
) == IMXIMAGE_VER_INVALID
)
528 return -FDT_ERR_BADSTRUCTURE
;
533 static void imximage_print_header(const void *ptr
)
535 struct imx_header
*imx_hdr
= (struct imx_header
*) ptr
;
536 uint32_t version
= detect_imximage_version(imx_hdr
);
540 print_hdr_v1(imx_hdr
);
543 print_hdr_v2(imx_hdr
);
546 err_imximage_version(version
);
551 static void imximage_set_header(void *ptr
, struct stat
*sbuf
, int ifd
,
552 struct mkimage_params
*params
)
554 struct imx_header
*imxhdr
= (struct imx_header
*)ptr
;
558 * In order to not change the old imx cfg file
559 * by adding VERSION command into it, here need
560 * set up function ptr group to V1 by default.
562 imximage_version
= IMXIMAGE_V1
;
563 /* Be able to detect if the cfg file has no BOOT_FROM tag */
564 imximage_ivt_offset
= FLASH_OFFSET_UNDEFINED
;
565 imximage_csf_size
= 0;
566 set_hdr_func(imxhdr
);
568 /* Parse dcd configuration file */
569 dcd_len
= parse_cfg_file(imxhdr
, params
->imagename
);
571 /* Set the imx header */
572 (*set_imx_hdr
)(imxhdr
, dcd_len
, params
->ep
, imximage_ivt_offset
);
577 * MX53 only loads 512 byte multiples in case of SD boot.
578 * MX53 only loads NAND page multiples in case of NAND boot and
579 * supports up to 4096 byte large pages, thus align to 4096.
581 * The remaining fraction of a block bytes would not be loaded!
583 *header_size_ptr
= ROUND(sbuf
->st_size
, 4096);
585 if (csf_ptr
&& imximage_csf_size
) {
586 *csf_ptr
= params
->ep
- imximage_init_loadsize
+
588 *header_size_ptr
+= imximage_csf_size
;
592 int imximage_check_params(struct mkimage_params
*params
)
596 if (!strlen(params
->imagename
)) {
597 fprintf(stderr
, "Error: %s - Configuration file not specified, "
598 "it is needed for imximage generation\n",
604 * XIP is not allowed and verify that incompatible
605 * parameters are not sent at the same time
606 * For example, if list is required a data image must not be provided
608 return (params
->dflag
&& (params
->fflag
|| params
->lflag
)) ||
609 (params
->fflag
&& (params
->dflag
|| params
->lflag
)) ||
610 (params
->lflag
&& (params
->dflag
|| params
->fflag
)) ||
611 (params
->xflag
) || !(strlen(params
->imagename
));
614 static int imximage_generate(struct mkimage_params
*params
,
615 struct image_type_params
*tparams
)
617 struct imx_header
*imxhdr
;
620 char *datafile
= params
->datafile
;
623 memset(&imximage_header
, 0, sizeof(imximage_header
));
626 * In order to not change the old imx cfg file
627 * by adding VERSION command into it, here need
628 * set up function ptr group to V1 by default.
630 imximage_version
= IMXIMAGE_V1
;
631 /* Be able to detect if the cfg file has no BOOT_FROM tag */
632 imximage_ivt_offset
= FLASH_OFFSET_UNDEFINED
;
633 imximage_csf_size
= 0;
634 set_hdr_func(imxhdr
);
636 /* Parse dcd configuration file */
637 parse_cfg_file(&imximage_header
, params
->imagename
);
639 /* TODO: check i.MX image V1 handling, for now use 'old' style */
640 if (imximage_version
== IMXIMAGE_V1
) {
643 if (imximage_init_loadsize
< imximage_ivt_offset
+
644 sizeof(imx_header_v2_t
))
645 imximage_init_loadsize
= imximage_ivt_offset
+
646 sizeof(imx_header_v2_t
);
647 alloc_len
= imximage_init_loadsize
- imximage_ivt_offset
;
650 if (alloc_len
< sizeof(struct imx_header
)) {
651 fprintf(stderr
, "%s: header error\n",
656 imxhdr
= malloc(alloc_len
);
659 fprintf(stderr
, "%s: malloc return failure: %s\n",
660 params
->cmdname
, strerror(errno
));
664 memset(imxhdr
, 0, alloc_len
);
666 tparams
->header_size
= alloc_len
;
667 tparams
->hdr
= imxhdr
;
669 /* determine data image file length */
671 if (stat(datafile
, &sbuf
) < 0) {
672 fprintf(stderr
, "%s: Can't stat %s: %s\n",
673 params
->cmdname
, datafile
, strerror(errno
));
677 pad_len
= ROUND(sbuf
.st_size
, 4096) - sbuf
.st_size
;
679 /* TODO: check i.MX image V1 handling, for now use 'old' style */
680 if (imximage_version
== IMXIMAGE_V1
)
688 * imximage parameters
690 static struct image_type_params imximage_params
= {
691 .name
= "Freescale i.MX Boot Image support",
694 .check_image_type
= imximage_check_image_types
,
695 .verify_header
= imximage_verify_header
,
696 .print_header
= imximage_print_header
,
697 .set_header
= imximage_set_header
,
698 .check_params
= imximage_check_params
,
699 .vrec_header
= imximage_generate
,
702 void init_imx_image_type(void)
704 mkimage_register(&imximage_params
);