1 // SPDX-License-Identifier: GPL-2.0+
4 * Stefano Babic, DENX Software Engineering, sbabic@denx.de.
7 * Marvell Semiconductor <www.marvell.com>
8 * Written-by: Prafulla Wadaskar <prafulla@marvell.com>
11 #include "imagetool.h"
15 #define UNDEFINED 0xFFFFFFFF
18 * Supported commands for configuration file
20 static table_entry_t imximage_cmds
[] = {
21 {CMD_BOOT_FROM
, "BOOT_FROM", "boot command", },
22 {CMD_BOOT_OFFSET
, "BOOT_OFFSET", "Boot offset", },
23 {CMD_WRITE_DATA
, "DATA", "Reg Write Data", },
24 {CMD_WRITE_CLR_BIT
, "CLR_BIT", "Reg clear bit", },
25 {CMD_WRITE_SET_BIT
, "SET_BIT", "Reg set bit", },
26 {CMD_CHECK_BITS_SET
, "CHECK_BITS_SET", "Reg Check bits set", },
27 {CMD_CHECK_BITS_CLR
, "CHECK_BITS_CLR", "Reg Check bits clr", },
28 {CMD_CSF
, "CSF", "Command Sequence File", },
29 {CMD_IMAGE_VERSION
, "IMAGE_VERSION", "image version", },
30 {CMD_PLUGIN
, "PLUGIN", "file plugin_addr", },
35 * Supported Boot options for configuration file
36 * this is needed to set the correct flash offset
38 static table_entry_t imximage_boot_offset
[] = {
39 {FLASH_OFFSET_ONENAND
, "onenand", "OneNAND Flash",},
40 {FLASH_OFFSET_NAND
, "nand", "NAND Flash", },
41 {FLASH_OFFSET_NOR
, "nor", "NOR Flash", },
42 {FLASH_OFFSET_SATA
, "sata", "SATA Disk", },
43 {FLASH_OFFSET_SD
, "sd", "SD Card", },
44 {FLASH_OFFSET_SPI
, "spi", "SPI Flash", },
45 {FLASH_OFFSET_QSPI
, "qspi", "QSPI NOR Flash",},
46 {-1, "", "Invalid", },
50 * Supported Boot options for configuration file
51 * this is needed to determine the initial load size
53 static table_entry_t imximage_boot_loadsize
[] = {
54 {FLASH_LOADSIZE_ONENAND
, "onenand", "OneNAND Flash",},
55 {FLASH_LOADSIZE_NAND
, "nand", "NAND Flash", },
56 {FLASH_LOADSIZE_NOR
, "nor", "NOR Flash", },
57 {FLASH_LOADSIZE_SATA
, "sata", "SATA Disk", },
58 {FLASH_LOADSIZE_SD
, "sd", "SD Card", },
59 {FLASH_LOADSIZE_SPI
, "spi", "SPI Flash", },
60 {FLASH_LOADSIZE_QSPI
, "qspi", "QSPI NOR Flash",},
61 {-1, "", "Invalid", },
65 * IMXIMAGE version definition for i.MX chips
67 static table_entry_t imximage_versions
[] = {
68 {IMXIMAGE_V1
, "", " (i.MX25/35/51 compatible)", },
69 {IMXIMAGE_V2
, "", " (i.MX53/6/7 compatible)", },
70 {-1, "", " (Invalid)", },
73 static struct imx_header imximage_header
;
74 static uint32_t imximage_version
;
76 * Image Vector Table Offset
77 * Initialized to a wrong not 4-bytes aligned address to
78 * check if it is was set by the cfg file.
80 static uint32_t imximage_ivt_offset
= UNDEFINED
;
81 static uint32_t imximage_csf_size
= UNDEFINED
;
82 /* Initial Load Region Size */
83 static uint32_t imximage_init_loadsize
;
84 static uint32_t imximage_iram_free_start
;
85 static uint32_t imximage_plugin_size
;
86 static uint32_t plugin_image
;
88 static set_dcd_val_t set_dcd_val
;
89 static set_dcd_param_t set_dcd_param
;
90 static set_dcd_rst_t set_dcd_rst
;
91 static set_imx_hdr_t set_imx_hdr
;
92 static uint32_t max_dcd_entries
;
93 static uint32_t *header_size_ptr
;
94 static uint32_t *csf_ptr
;
96 static uint32_t get_cfg_value(char *token
, char *name
, int linenr
)
102 value
= strtoul(token
, &endptr
, 16);
103 if (errno
|| (token
== endptr
)) {
104 fprintf(stderr
, "Error: %s[%d] - Invalid hex data(%s)\n",
105 name
, linenr
, token
);
111 static uint32_t detect_imximage_version(struct imx_header
*imx_hdr
)
113 imx_header_v1_t
*hdr_v1
= &imx_hdr
->header
.hdr_v1
;
114 imx_header_v2_t
*hdr_v2
= &imx_hdr
->header
.hdr_v2
;
115 flash_header_v1_t
*fhdr_v1
= &hdr_v1
->fhdr
;
116 flash_header_v2_t
*fhdr_v2
= &hdr_v2
->fhdr
;
118 /* Try to detect V1 */
119 if ((fhdr_v1
->app_code_barker
== APP_CODE_BARKER
) &&
120 (hdr_v1
->dcd_table
.preamble
.barker
== DCD_BARKER
))
123 /* Try to detect V2 */
124 if ((fhdr_v2
->header
.tag
== IVT_HEADER_TAG
) &&
125 (hdr_v2
->data
.dcd_table
.header
.tag
== DCD_HEADER_TAG
))
128 if ((fhdr_v2
->header
.tag
== IVT_HEADER_TAG
) &&
129 hdr_v2
->boot_data
.plugin
)
132 return IMXIMAGE_VER_INVALID
;
135 static void err_imximage_version(int version
)
138 "Error: Unsupported imximage version:%d\n", version
);
143 static void set_dcd_val_v1(struct imx_header
*imxhdr
, char *name
, int lineno
,
144 int fld
, uint32_t value
, uint32_t off
)
146 dcd_v1_t
*dcd_v1
= &imxhdr
->header
.hdr_v1
.dcd_table
;
150 /* Byte, halfword, word */
151 if ((value
!= 1) && (value
!= 2) && (value
!= 4)) {
152 fprintf(stderr
, "Error: %s[%d] - "
153 "Invalid register size " "(%d)\n",
154 name
, lineno
, value
);
157 dcd_v1
->addr_data
[off
].type
= value
;
159 case CFG_REG_ADDRESS
:
160 dcd_v1
->addr_data
[off
].addr
= value
;
163 dcd_v1
->addr_data
[off
].value
= value
;
171 static struct dcd_v2_cmd
*gd_last_cmd
;
173 static void set_dcd_param_v2(struct imx_header
*imxhdr
, uint32_t dcd_len
,
176 dcd_v2_t
*dcd_v2
= &imxhdr
->header
.hdr_v2
.data
.dcd_table
;
177 struct dcd_v2_cmd
*d
= gd_last_cmd
;
178 struct dcd_v2_cmd
*d2
;
182 d
= &dcd_v2
->dcd_cmd
;
184 len
= be16_to_cpu(d
->write_dcd_command
.length
);
186 d2
= (struct dcd_v2_cmd
*)(((char *)d
) + len
);
190 if ((d
->write_dcd_command
.tag
== DCD_WRITE_DATA_COMMAND_TAG
) &&
191 (d
->write_dcd_command
.param
== DCD_WRITE_DATA_PARAM
))
194 d
->write_dcd_command
.tag
= DCD_WRITE_DATA_COMMAND_TAG
;
195 d
->write_dcd_command
.length
= cpu_to_be16(4);
196 d
->write_dcd_command
.param
= DCD_WRITE_DATA_PARAM
;
198 case CMD_WRITE_CLR_BIT
:
199 if ((d
->write_dcd_command
.tag
== DCD_WRITE_DATA_COMMAND_TAG
) &&
200 (d
->write_dcd_command
.param
== DCD_WRITE_CLR_BIT_PARAM
))
203 d
->write_dcd_command
.tag
= DCD_WRITE_DATA_COMMAND_TAG
;
204 d
->write_dcd_command
.length
= cpu_to_be16(4);
205 d
->write_dcd_command
.param
= DCD_WRITE_CLR_BIT_PARAM
;
207 case CMD_WRITE_SET_BIT
:
208 if ((d
->write_dcd_command
.tag
== DCD_WRITE_DATA_COMMAND_TAG
) &&
209 (d
->write_dcd_command
.param
== DCD_WRITE_SET_BIT_PARAM
))
212 d
->write_dcd_command
.tag
= DCD_WRITE_DATA_COMMAND_TAG
;
213 d
->write_dcd_command
.length
= cpu_to_be16(4);
214 d
->write_dcd_command
.param
= DCD_WRITE_SET_BIT_PARAM
;
217 * Check data command only supports one entry,
219 case CMD_CHECK_BITS_SET
:
221 d
->write_dcd_command
.tag
= DCD_CHECK_DATA_COMMAND_TAG
;
222 d
->write_dcd_command
.length
= cpu_to_be16(4);
223 d
->write_dcd_command
.param
= DCD_CHECK_BITS_SET_PARAM
;
225 case CMD_CHECK_BITS_CLR
:
227 d
->write_dcd_command
.tag
= DCD_CHECK_DATA_COMMAND_TAG
;
228 d
->write_dcd_command
.length
= cpu_to_be16(4);
229 d
->write_dcd_command
.param
= DCD_CHECK_BITS_CLR_PARAM
;
237 static void set_dcd_val_v2(struct imx_header
*imxhdr
, char *name
, int lineno
,
238 int fld
, uint32_t value
, uint32_t off
)
240 struct dcd_v2_cmd
*d
= gd_last_cmd
;
243 len
= be16_to_cpu(d
->write_dcd_command
.length
);
244 off
= (len
- 4) >> 3;
247 case CFG_REG_ADDRESS
:
248 d
->addr_data
[off
].addr
= cpu_to_be32(value
);
251 d
->addr_data
[off
].value
= cpu_to_be32(value
);
253 d
->write_dcd_command
.length
= cpu_to_be16((off
<< 3) + 4);
262 * Complete setting up the rest field of DCD of V1
263 * such as barker code and DCD data length.
265 static void set_dcd_rst_v1(struct imx_header
*imxhdr
, uint32_t dcd_len
,
266 char *name
, int lineno
)
268 dcd_v1_t
*dcd_v1
= &imxhdr
->header
.hdr_v1
.dcd_table
;
270 dcd_v1
->preamble
.barker
= DCD_BARKER
;
271 dcd_v1
->preamble
.length
= dcd_len
* sizeof(dcd_type_addr_data_t
);
275 * Complete setting up the reset field of DCD of V2
276 * such as DCD tag, version, length, etc.
278 static void set_dcd_rst_v2(struct imx_header
*imxhdr
, uint32_t dcd_len
,
279 char *name
, int lineno
)
281 if (!imxhdr
->header
.hdr_v2
.boot_data
.plugin
) {
282 dcd_v2_t
*dcd_v2
= &imxhdr
->header
.hdr_v2
.data
.dcd_table
;
283 struct dcd_v2_cmd
*d
= gd_last_cmd
;
287 d
= &dcd_v2
->dcd_cmd
;
288 len
= be16_to_cpu(d
->write_dcd_command
.length
);
290 d
= (struct dcd_v2_cmd
*)(((char *)d
) + len
);
292 len
= (char *)d
- (char *)&dcd_v2
->header
;
293 dcd_v2
->header
.tag
= DCD_HEADER_TAG
;
294 dcd_v2
->header
.length
= cpu_to_be16(len
);
295 dcd_v2
->header
.version
= DCD_VERSION
;
299 static void set_imx_hdr_v1(struct imx_header
*imxhdr
, uint32_t dcd_len
,
300 uint32_t entry_point
, uint32_t flash_offset
)
302 imx_header_v1_t
*hdr_v1
= &imxhdr
->header
.hdr_v1
;
303 flash_header_v1_t
*fhdr_v1
= &hdr_v1
->fhdr
;
304 dcd_v1_t
*dcd_v1
= &hdr_v1
->dcd_table
;
306 uint32_t header_length
= (((char *)&dcd_v1
->addr_data
[dcd_len
].addr
)
309 /* Set magic number */
310 fhdr_v1
->app_code_barker
= APP_CODE_BARKER
;
312 hdr_base
= entry_point
- imximage_init_loadsize
+ flash_offset
;
313 fhdr_v1
->app_dest_ptr
= hdr_base
- flash_offset
;
314 fhdr_v1
->app_code_jump_vector
= entry_point
;
316 fhdr_v1
->dcd_ptr_ptr
= hdr_base
+ offsetof(flash_header_v1_t
, dcd_ptr
);
317 fhdr_v1
->dcd_ptr
= hdr_base
+ offsetof(imx_header_v1_t
, dcd_table
);
319 /* Security feature are not supported */
320 fhdr_v1
->app_code_csf
= 0;
321 fhdr_v1
->super_root_key
= 0;
322 header_size_ptr
= (uint32_t *)(((char *)imxhdr
) + header_length
- 4);
325 static void set_imx_hdr_v2(struct imx_header
*imxhdr
, uint32_t dcd_len
,
326 uint32_t entry_point
, uint32_t flash_offset
)
328 imx_header_v2_t
*hdr_v2
= &imxhdr
->header
.hdr_v2
;
329 flash_header_v2_t
*fhdr_v2
= &hdr_v2
->fhdr
;
332 /* Set magic number */
333 fhdr_v2
->header
.tag
= IVT_HEADER_TAG
; /* 0xD1 */
334 fhdr_v2
->header
.length
= cpu_to_be16(sizeof(flash_header_v2_t
));
335 fhdr_v2
->header
.version
= IVT_VERSION
; /* 0x40 */
337 if (!hdr_v2
->boot_data
.plugin
) {
338 fhdr_v2
->entry
= entry_point
;
339 fhdr_v2
->reserved1
= 0;
340 fhdr_v2
->reserved1
= 0;
341 hdr_base
= entry_point
- imximage_init_loadsize
+
343 fhdr_v2
->self
= hdr_base
;
345 fhdr_v2
->dcd_ptr
= hdr_base
+
346 offsetof(imx_header_v2_t
, data
);
348 fhdr_v2
->dcd_ptr
= 0;
349 fhdr_v2
->boot_data_ptr
= hdr_base
350 + offsetof(imx_header_v2_t
, boot_data
);
351 hdr_v2
->boot_data
.start
= entry_point
- imximage_init_loadsize
;
355 header_size_ptr
= &hdr_v2
->boot_data
.size
;
356 csf_ptr
= &fhdr_v2
->csf
;
358 imx_header_v2_t
*next_hdr_v2
;
359 flash_header_v2_t
*next_fhdr_v2
;
361 if (imximage_csf_size
!= 0) {
362 fprintf(stderr
, "Error: Header v2: SECURE_BOOT is only supported in DCD mode!");
366 fhdr_v2
->entry
= imximage_iram_free_start
+
367 flash_offset
+ sizeof(flash_header_v2_t
) +
370 fhdr_v2
->reserved1
= 0;
371 fhdr_v2
->reserved2
= 0;
372 fhdr_v2
->self
= imximage_iram_free_start
+ flash_offset
;
374 fhdr_v2
->dcd_ptr
= 0;
376 fhdr_v2
->boot_data_ptr
= fhdr_v2
->self
+
377 offsetof(imx_header_v2_t
, boot_data
);
379 hdr_v2
->boot_data
.start
= imximage_iram_free_start
;
381 * The actural size of plugin image is "imximage_plugin_size +
382 * sizeof(flash_header_v2_t) + sizeof(boot_data_t)", plus the
383 * flash_offset space.The ROM code only need to copy this size
384 * to run the plugin code. However, later when copy the whole
385 * U-Boot image to DDR, the ROM code use memcpy to copy the
386 * first part of the image, and use the storage read function
387 * to get the remaining part. This requires the dividing point
388 * must be multiple of storage sector size. Here we set the
389 * first section to be MAX_PLUGIN_CODE_SIZE(64KB) for this
392 hdr_v2
->boot_data
.size
= MAX_PLUGIN_CODE_SIZE
;
394 /* Security feature are not supported */
397 next_hdr_v2
= (imx_header_v2_t
*)((char *)hdr_v2
+
398 imximage_plugin_size
);
400 next_fhdr_v2
= &next_hdr_v2
->fhdr
;
402 next_fhdr_v2
->header
.tag
= IVT_HEADER_TAG
; /* 0xD1 */
403 next_fhdr_v2
->header
.length
=
404 cpu_to_be16(sizeof(flash_header_v2_t
));
405 next_fhdr_v2
->header
.version
= IVT_VERSION
; /* 0x40 */
407 next_fhdr_v2
->entry
= entry_point
;
408 hdr_base
= entry_point
- sizeof(struct imx_header
);
409 next_fhdr_v2
->reserved1
= 0;
410 next_fhdr_v2
->reserved2
= 0;
411 next_fhdr_v2
->self
= hdr_base
+ imximage_plugin_size
;
413 next_fhdr_v2
->dcd_ptr
= 0;
414 next_fhdr_v2
->boot_data_ptr
= next_fhdr_v2
->self
+
415 offsetof(imx_header_v2_t
, boot_data
);
417 next_hdr_v2
->boot_data
.start
= hdr_base
- flash_offset
;
419 header_size_ptr
= &next_hdr_v2
->boot_data
.size
;
421 next_hdr_v2
->boot_data
.plugin
= 0;
423 next_fhdr_v2
->csf
= 0;
427 static void set_hdr_func(void)
429 switch (imximage_version
) {
431 set_dcd_val
= set_dcd_val_v1
;
432 set_dcd_param
= NULL
;
433 set_dcd_rst
= set_dcd_rst_v1
;
434 set_imx_hdr
= set_imx_hdr_v1
;
435 max_dcd_entries
= MAX_HW_CFG_SIZE_V1
;
439 set_dcd_val
= set_dcd_val_v2
;
440 set_dcd_param
= set_dcd_param_v2
;
441 set_dcd_rst
= set_dcd_rst_v2
;
442 set_imx_hdr
= set_imx_hdr_v2
;
443 max_dcd_entries
= MAX_HW_CFG_SIZE_V2
;
446 err_imximage_version(imximage_version
);
451 static void print_hdr_v1(struct imx_header
*imx_hdr
)
453 imx_header_v1_t
*hdr_v1
= &imx_hdr
->header
.hdr_v1
;
454 flash_header_v1_t
*fhdr_v1
= &hdr_v1
->fhdr
;
455 dcd_v1_t
*dcd_v1
= &hdr_v1
->dcd_table
;
456 uint32_t size
, length
, ver
;
458 size
= dcd_v1
->preamble
.length
;
459 if (size
> (MAX_HW_CFG_SIZE_V1
* sizeof(dcd_type_addr_data_t
))) {
461 "Error: Image corrupt DCD size %d exceed maximum %d\n",
462 (uint32_t)(size
/ sizeof(dcd_type_addr_data_t
)),
467 length
= dcd_v1
->preamble
.length
/ sizeof(dcd_type_addr_data_t
);
468 ver
= detect_imximage_version(imx_hdr
);
470 printf("Image Type: Freescale IMX Boot Image\n");
471 printf("Image Ver: %x", ver
);
472 printf("%s\n", get_table_entry_name(imximage_versions
, NULL
, ver
));
473 printf("Data Size: ");
474 genimg_print_size(dcd_v1
->addr_data
[length
].type
);
475 printf("Load Address: %08x\n", (uint32_t)fhdr_v1
->app_dest_ptr
);
476 printf("Entry Point: %08x\n", (uint32_t)fhdr_v1
->app_code_jump_vector
);
479 static void print_hdr_v2(struct imx_header
*imx_hdr
)
481 imx_header_v2_t
*hdr_v2
= &imx_hdr
->header
.hdr_v2
;
482 flash_header_v2_t
*fhdr_v2
= &hdr_v2
->fhdr
;
483 dcd_v2_t
*dcd_v2
= &hdr_v2
->data
.dcd_table
;
484 uint32_t size
, version
, plugin
;
486 plugin
= hdr_v2
->boot_data
.plugin
;
488 size
= be16_to_cpu(dcd_v2
->header
.length
);
489 if (size
> (MAX_HW_CFG_SIZE_V2
* sizeof(dcd_addr_data_t
))) {
491 "Error: Image corrupt DCD size %d exceed maximum %d\n",
492 (uint32_t)(size
/ sizeof(dcd_addr_data_t
)),
498 version
= detect_imximage_version(imx_hdr
);
500 printf("Image Type: Freescale IMX Boot Image\n");
501 printf("Image Ver: %x", version
);
502 printf("%s\n", get_table_entry_name(imximage_versions
, NULL
, version
));
503 printf("Mode: %s\n", plugin
? "PLUGIN" : "DCD");
505 printf("Data Size: ");
506 genimg_print_size(hdr_v2
->boot_data
.size
);
507 printf("Load Address: %08x\n", (uint32_t)fhdr_v2
->boot_data_ptr
);
508 printf("Entry Point: %08x\n", (uint32_t)fhdr_v2
->entry
);
513 dcdlen
= hdr_v2
->data
.dcd_table
.header
.length
;
514 offs
= (char *)&hdr_v2
->data
.dcd_table
518 * The HAB block is the first part of the image, from
519 * start of IVT header (fhdr_v2->self) to the start of
520 * the CSF block (fhdr_v2->csf). So HAB size is
522 * HAB_size = fhdr_v2->csf - fhdr_v2->self
524 printf("HAB Blocks: 0x%08x 0x%08x 0x%08x\n",
525 (uint32_t)fhdr_v2
->self
, 0,
526 (uint32_t)(fhdr_v2
->csf
- fhdr_v2
->self
));
527 printf("DCD Blocks: 0x00910000 0x%08x 0x%08x\n",
528 offs
, be16_to_cpu(dcdlen
));
531 imx_header_v2_t
*next_hdr_v2
;
532 flash_header_v2_t
*next_fhdr_v2
;
535 printf("Plugin Data Size: ");
536 genimg_print_size(hdr_v2
->boot_data
.size
);
537 printf("Plugin Code Size: ");
538 genimg_print_size(imximage_plugin_size
);
539 printf("Plugin Load Address: %08x\n", hdr_v2
->boot_data
.start
);
540 printf("Plugin Entry Point: %08x\n", (uint32_t)fhdr_v2
->entry
);
543 next_hdr_v2
= (imx_header_v2_t
*)((char *)hdr_v2
+
544 imximage_plugin_size
);
545 next_fhdr_v2
= &next_hdr_v2
->fhdr
;
546 printf("U-Boot Data Size: ");
547 genimg_print_size(next_hdr_v2
->boot_data
.size
);
548 printf("U-Boot Load Address: %08x\n",
549 next_hdr_v2
->boot_data
.start
);
550 printf("U-Boot Entry Point: %08x\n",
551 (uint32_t)next_fhdr_v2
->entry
);
555 static void copy_plugin_code(struct imx_header
*imxhdr
, char *plugin_file
)
559 char *plugin_buf
= imxhdr
->header
.hdr_v2
.data
.plugin_code
;
562 ifd
= open(plugin_file
, O_RDONLY
|O_BINARY
);
564 fprintf(stderr
, "Can't open %s: %s\n",
570 if (fstat(ifd
, &sbuf
) < 0) {
571 fprintf(stderr
, "Can't stat %s: %s\n",
577 ptr
= mmap(0, sbuf
.st_size
, PROT_READ
, MAP_SHARED
, ifd
, 0);
578 if (ptr
== MAP_FAILED
) {
579 fprintf(stderr
, "Can't read %s: %s\n",
585 if (sbuf
.st_size
> MAX_PLUGIN_CODE_SIZE
) {
586 printf("plugin binary size too large\n");
590 memcpy(plugin_buf
, ptr
, sbuf
.st_size
);
591 imximage_plugin_size
= sbuf
.st_size
;
593 (void) munmap((void *)ptr
, sbuf
.st_size
);
596 imxhdr
->header
.hdr_v2
.boot_data
.plugin
= 1;
599 static void parse_cfg_cmd(struct imx_header
*imxhdr
, int32_t cmd
, char *token
,
600 char *name
, int lineno
, int fld
, int dcd_len
)
603 static int cmd_ver_first
= ~0;
606 case CMD_IMAGE_VERSION
:
607 imximage_version
= get_cfg_value(token
, name
, lineno
);
608 if (cmd_ver_first
== 0) {
609 fprintf(stderr
, "Error: %s[%d] - IMAGE_VERSION "
610 "command need be the first before other "
611 "valid command in the file\n", name
, lineno
);
618 imximage_ivt_offset
= get_table_entry_id(imximage_boot_offset
,
619 "imximage boot option", token
);
620 if (imximage_ivt_offset
== -1) {
621 fprintf(stderr
, "Error: %s[%d] -Invalid boot device"
622 "(%s)\n", name
, lineno
, token
);
626 imximage_init_loadsize
=
627 get_table_entry_id(imximage_boot_loadsize
,
628 "imximage boot option", token
);
630 if (imximage_init_loadsize
== -1) {
632 "Error: %s[%d] -Invalid boot device(%s)\n",
633 name
, lineno
, token
);
638 * The SOC loads from the storage starting at address 0
639 * then ensures that the load size contains the offset
641 if (imximage_init_loadsize
< imximage_ivt_offset
)
642 imximage_init_loadsize
= imximage_ivt_offset
;
643 if (unlikely(cmd_ver_first
!= 1))
646 case CMD_BOOT_OFFSET
:
647 imximage_ivt_offset
= get_cfg_value(token
, name
, lineno
);
648 if (unlikely(cmd_ver_first
!= 1))
652 case CMD_WRITE_CLR_BIT
:
653 case CMD_WRITE_SET_BIT
:
654 case CMD_CHECK_BITS_SET
:
655 case CMD_CHECK_BITS_CLR
:
656 value
= get_cfg_value(token
, name
, lineno
);
658 (*set_dcd_param
)(imxhdr
, dcd_len
, cmd
);
659 (*set_dcd_val
)(imxhdr
, name
, lineno
, fld
, value
, dcd_len
);
660 if (unlikely(cmd_ver_first
!= 1))
664 if (imximage_version
!= 2) {
666 "Error: %s[%d] - CSF only supported for VERSION 2(%s)\n",
667 name
, lineno
, token
);
670 imximage_csf_size
= get_cfg_value(token
, name
, lineno
);
671 if (unlikely(cmd_ver_first
!= 1))
676 copy_plugin_code(imxhdr
, token
);
681 static void parse_cfg_fld(struct imx_header
*imxhdr
, int32_t *cmd
,
682 char *token
, char *name
, int lineno
, int fld
, int *dcd_len
)
688 *cmd
= get_table_entry_id(imximage_cmds
,
689 "imximage commands", token
);
691 fprintf(stderr
, "Error: %s[%d] - Invalid command"
692 "(%s)\n", name
, lineno
, token
);
697 parse_cfg_cmd(imxhdr
, *cmd
, token
, name
, lineno
, fld
, *dcd_len
);
699 case CFG_REG_ADDRESS
:
703 case CMD_WRITE_CLR_BIT
:
704 case CMD_WRITE_SET_BIT
:
705 case CMD_CHECK_BITS_SET
:
706 case CMD_CHECK_BITS_CLR
:
708 value
= get_cfg_value(token
, name
, lineno
);
710 (*set_dcd_param
)(imxhdr
, *dcd_len
, *cmd
);
711 (*set_dcd_val
)(imxhdr
, name
, lineno
, fld
, value
,
714 if (fld
== CFG_REG_VALUE
) {
716 if (*dcd_len
> max_dcd_entries
) {
717 fprintf(stderr
, "Error: %s[%d] -"
718 "DCD table exceeds maximum size(%d)\n",
719 name
, lineno
, max_dcd_entries
);
725 value
= get_cfg_value(token
, name
, lineno
);
726 imximage_iram_free_start
= value
;
736 static uint32_t parse_cfg_file(struct imx_header
*imxhdr
, char *name
)
740 char *token
, *saveptr1
, *saveptr2
;
747 fd
= fopen(name
, "r");
749 fprintf(stderr
, "Error: %s - Can't open DCD file\n", name
);
754 * Very simple parsing, line starting with # are comments
757 while ((getline(&line
, &len
, fd
)) > 0) {
760 token
= strtok_r(line
, "\r\n", &saveptr1
);
764 /* Check inside the single line */
765 for (fld
= CFG_COMMAND
, cmd
= CMD_INVALID
,
766 line
= token
; ; line
= NULL
, fld
++) {
767 token
= strtok_r(line
, " \t", &saveptr2
);
771 /* Drop all text starting with '#' as comments */
775 parse_cfg_fld(imxhdr
, &cmd
, token
, name
,
776 lineno
, fld
, &dcd_len
);
781 (*set_dcd_rst
)(imxhdr
, dcd_len
, name
, lineno
);
784 /* Exit if there is no BOOT_FROM field specifying the flash_offset */
785 if (imximage_ivt_offset
== FLASH_OFFSET_UNDEFINED
) {
786 fprintf(stderr
, "Error: No BOOT_FROM tag in %s\n", name
);
793 static int imximage_check_image_types(uint8_t type
)
795 if (type
== IH_TYPE_IMXIMAGE
)
801 static int imximage_verify_header(unsigned char *ptr
, int image_size
,
802 struct image_tool_params
*params
)
804 struct imx_header
*imx_hdr
= (struct imx_header
*) ptr
;
806 if (detect_imximage_version(imx_hdr
) == IMXIMAGE_VER_INVALID
)
807 return -FDT_ERR_BADSTRUCTURE
;
812 static void imximage_print_header(const void *ptr
)
814 struct imx_header
*imx_hdr
= (struct imx_header
*) ptr
;
815 uint32_t version
= detect_imximage_version(imx_hdr
);
819 print_hdr_v1(imx_hdr
);
822 print_hdr_v2(imx_hdr
);
825 err_imximage_version(version
);
830 static void imximage_set_header(void *ptr
, struct stat
*sbuf
, int ifd
,
831 struct image_tool_params
*params
)
833 struct imx_header
*imxhdr
= (struct imx_header
*)ptr
;
835 uint32_t header_size
;
838 * In order to not change the old imx cfg file
839 * by adding VERSION command into it, here need
840 * set up function ptr group to V1 by default.
842 imximage_version
= IMXIMAGE_V1
;
843 /* Be able to detect if the cfg file has no BOOT_FROM tag */
844 imximage_ivt_offset
= FLASH_OFFSET_UNDEFINED
;
845 imximage_csf_size
= 0;
848 /* Parse dcd configuration file */
849 dcd_len
= parse_cfg_file(imxhdr
, params
->imagename
);
851 if (imximage_version
== IMXIMAGE_V1
)
852 header_size
= sizeof(flash_header_v1_t
);
854 header_size
= sizeof(flash_header_v2_t
) + sizeof(boot_data_t
);
856 header_size
+= sizeof(dcd_v2_t
);
858 header_size
+= MAX_PLUGIN_CODE_SIZE
;
861 if (imximage_init_loadsize
< imximage_ivt_offset
+ header_size
)
862 imximage_init_loadsize
= imximage_ivt_offset
+ header_size
;
864 /* Set the imx header */
865 (*set_imx_hdr
)(imxhdr
, dcd_len
, params
->ep
, imximage_ivt_offset
);
870 * MX53 only loads 512 byte multiples in case of SD boot.
871 * MX53 only loads NAND page multiples in case of NAND boot and
872 * supports up to 4096 byte large pages, thus align to 4096.
874 * The remaining fraction of a block bytes would not be loaded!
876 *header_size_ptr
= ROUND((sbuf
->st_size
+ imximage_ivt_offset
), 4096);
878 if (csf_ptr
&& imximage_csf_size
) {
879 *csf_ptr
= params
->ep
- imximage_init_loadsize
+
881 *header_size_ptr
+= imximage_csf_size
;
885 int imximage_check_params(struct image_tool_params
*params
)
889 if (!strlen(params
->imagename
)) {
890 fprintf(stderr
, "Error: %s - Configuration file not specified, "
891 "it is needed for imximage generation\n",
897 * XIP is not allowed and verify that incompatible
898 * parameters are not sent at the same time
899 * For example, if list is required a data image must not be provided
901 return (params
->dflag
&& (params
->fflag
|| params
->lflag
)) ||
902 (params
->fflag
&& (params
->dflag
|| params
->lflag
)) ||
903 (params
->lflag
&& (params
->dflag
|| params
->fflag
)) ||
904 (params
->xflag
) || !(strlen(params
->imagename
));
907 static int imximage_generate(struct image_tool_params
*params
,
908 struct image_type_params
*tparams
)
910 struct imx_header
*imxhdr
;
913 char *datafile
= params
->datafile
;
914 uint32_t pad_len
, header_size
;
916 memset(&imximage_header
, 0, sizeof(imximage_header
));
919 * In order to not change the old imx cfg file
920 * by adding VERSION command into it, here need
921 * set up function ptr group to V1 by default.
923 imximage_version
= IMXIMAGE_V1
;
924 /* Be able to detect if the cfg file has no BOOT_FROM tag */
925 imximage_ivt_offset
= FLASH_OFFSET_UNDEFINED
;
926 imximage_csf_size
= 0;
929 /* Parse dcd configuration file */
930 parse_cfg_file(&imximage_header
, params
->imagename
);
932 if (imximage_version
== IMXIMAGE_V1
)
933 header_size
= sizeof(imx_header_v1_t
);
935 header_size
= sizeof(flash_header_v2_t
) + sizeof(boot_data_t
);
937 header_size
+= sizeof(dcd_v2_t
);
939 header_size
+= MAX_PLUGIN_CODE_SIZE
;
942 if (imximage_init_loadsize
< imximage_ivt_offset
+ header_size
)
943 imximage_init_loadsize
= imximage_ivt_offset
+ header_size
;
945 alloc_len
= imximage_init_loadsize
- imximage_ivt_offset
;
947 if (alloc_len
< header_size
) {
948 fprintf(stderr
, "%s: header error\n",
953 imxhdr
= malloc(alloc_len
);
956 fprintf(stderr
, "%s: malloc return failure: %s\n",
957 params
->cmdname
, strerror(errno
));
961 memset(imxhdr
, 0, alloc_len
);
963 tparams
->header_size
= alloc_len
;
964 tparams
->hdr
= imxhdr
;
966 /* determine data image file length */
968 if (stat(datafile
, &sbuf
) < 0) {
969 fprintf(stderr
, "%s: Can't stat %s: %s\n",
970 params
->cmdname
, datafile
, strerror(errno
));
974 pad_len
= ROUND(sbuf
.st_size
, 4096) - sbuf
.st_size
;
981 * imximage parameters
985 "Freescale i.MX Boot Image support",
988 imximage_check_params
,
989 imximage_verify_header
,
990 imximage_print_header
,
993 imximage_check_image_types
,