3 * Stefano Babic, DENX Software Engineering, sbabic@denx.de.
6 * Marvell Semiconductor <www.marvell.com>
7 * Written-by: Prafulla Wadaskar <prafulla@marvell.com>
9 * See file CREDITS for list of people who contributed to this
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License as
14 * published by the Free Software Foundation; either version 2 of
15 * the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
28 /* Required to obtain the getline prototype from stdio.h */
36 * Supported commands for configuration file
38 static table_entry_t imximage_cmds[] = {
39 {CMD_BOOT_FROM, "BOOT_FROM", "boot command", },
40 {CMD_DATA, "DATA", "Reg Write Data", },
41 {CMD_IMAGE_VERSION, "IMAGE_VERSION", "image version", },
46 * Supported Boot options for configuration file
47 * this is needed to set the correct flash offset
49 static table_entry_t imximage_bootops[] = {
50 {FLASH_OFFSET_ONENAND, "onenand", "OneNAND Flash",},
51 {FLASH_OFFSET_NAND, "nand", "NAND Flash", },
52 {FLASH_OFFSET_NOR, "nor", "NOR Flash", },
53 {FLASH_OFFSET_SATA, "sata", "SATA Disk", },
54 {FLASH_OFFSET_SD, "sd", "SD Card", },
55 {FLASH_OFFSET_SPI, "spi", "SPI Flash", },
56 {-1, "", "Invalid", },
60 * IMXIMAGE version definition for i.MX chips
62 static table_entry_t imximage_versions[] = {
63 {IMXIMAGE_V1, "", " (i.MX25/35/51 compatible)", },
64 {IMXIMAGE_V2, "", " (i.MX53/6 compatible)", },
65 {-1, "", " (Invalid)", },
68 static struct imx_header imximage_header;
69 static uint32_t imximage_version;
71 static set_dcd_val_t set_dcd_val;
72 static set_dcd_rst_t set_dcd_rst;
73 static set_imx_hdr_t set_imx_hdr;
74 static uint32_t max_dcd_entries;
75 static uint32_t *header_size_ptr;
77 static uint32_t get_cfg_value(char *token, char *name, int linenr)
83 value = strtoul(token, &endptr, 16);
84 if (errno || (token == endptr)) {
85 fprintf(stderr, "Error: %s[%d] - Invalid hex data(%s)\n",
92 static uint32_t detect_imximage_version(struct imx_header *imx_hdr)
94 imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1;
95 imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2;
96 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
97 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
99 /* Try to detect V1 */
100 if ((fhdr_v1->app_code_barker == APP_CODE_BARKER) &&
101 (hdr_v1->dcd_table.preamble.barker == DCD_BARKER))
104 /* Try to detect V2 */
105 if ((fhdr_v2->header.tag == IVT_HEADER_TAG) &&
106 (hdr_v2->dcd_table.header.tag == DCD_HEADER_TAG))
109 return IMXIMAGE_VER_INVALID;
112 static void err_imximage_version(int version)
115 "Error: Unsupported imximage version:%d\n", version);
120 static void set_dcd_val_v1(struct imx_header *imxhdr, char *name, int lineno,
121 int fld, uint32_t value, uint32_t off)
123 dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table;
127 /* Byte, halfword, word */
128 if ((value != 1) && (value != 2) && (value != 4)) {
129 fprintf(stderr, "Error: %s[%d] - "
130 "Invalid register size " "(%d)\n",
131 name, lineno, value);
134 dcd_v1->addr_data[off].type = value;
136 case CFG_REG_ADDRESS:
137 dcd_v1->addr_data[off].addr = value;
140 dcd_v1->addr_data[off].value = value;
148 static void set_dcd_val_v2(struct imx_header *imxhdr, char *name, int lineno,
149 int fld, uint32_t value, uint32_t off)
151 dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table;
154 case CFG_REG_ADDRESS:
155 dcd_v2->addr_data[off].addr = cpu_to_be32(value);
158 dcd_v2->addr_data[off].value = cpu_to_be32(value);
167 * Complete setting up the rest field of DCD of V1
168 * such as barker code and DCD data length.
170 static void set_dcd_rst_v1(struct imx_header *imxhdr, uint32_t dcd_len,
171 char *name, int lineno)
173 dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table;
175 dcd_v1->preamble.barker = DCD_BARKER;
176 dcd_v1->preamble.length = dcd_len * sizeof(dcd_type_addr_data_t);
180 * Complete setting up the reset field of DCD of V2
181 * such as DCD tag, version, length, etc.
183 static void set_dcd_rst_v2(struct imx_header *imxhdr, uint32_t dcd_len,
184 char *name, int lineno)
186 dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table;
188 dcd_v2->header.tag = DCD_HEADER_TAG;
189 dcd_v2->header.length = cpu_to_be16(
190 dcd_len * sizeof(dcd_addr_data_t) + 8);
191 dcd_v2->header.version = DCD_VERSION;
192 dcd_v2->write_dcd_command.tag = DCD_COMMAND_TAG;
193 dcd_v2->write_dcd_command.length = cpu_to_be16(
194 dcd_len * sizeof(dcd_addr_data_t) + 4);
195 dcd_v2->write_dcd_command.param = DCD_COMMAND_PARAM;
198 static void set_imx_hdr_v1(struct imx_header *imxhdr, uint32_t dcd_len,
199 uint32_t entry_point, uint32_t flash_offset)
201 imx_header_v1_t *hdr_v1 = &imxhdr->header.hdr_v1;
202 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
203 dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table;
204 uint32_t base_offset;
205 uint32_t header_length = (((char *)&dcd_v1->addr_data[dcd_len].addr)
208 /* Set magic number */
209 fhdr_v1->app_code_barker = APP_CODE_BARKER;
211 fhdr_v1->app_dest_ptr = entry_point - flash_offset -
212 sizeof(struct imx_header);
213 fhdr_v1->app_code_jump_vector = entry_point;
215 base_offset = fhdr_v1->app_dest_ptr + flash_offset;
216 fhdr_v1->dcd_ptr_ptr =
217 (uint32_t) (offsetof(flash_header_v1_t, dcd_ptr) -
218 offsetof(flash_header_v1_t, app_code_jump_vector) +
221 fhdr_v1->dcd_ptr = base_offset +
222 offsetof(imx_header_v1_t, dcd_table);
224 /* Security feature are not supported */
225 fhdr_v1->app_code_csf = 0;
226 fhdr_v1->super_root_key = 0;
227 header_size_ptr = (uint32_t *)(((char *)imxhdr) + header_length - 4);
230 static void set_imx_hdr_v2(struct imx_header *imxhdr, uint32_t dcd_len,
231 uint32_t entry_point, uint32_t flash_offset)
233 imx_header_v2_t *hdr_v2 = &imxhdr->header.hdr_v2;
234 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
236 /* Set magic number */
237 fhdr_v2->header.tag = IVT_HEADER_TAG; /* 0xD1 */
238 fhdr_v2->header.length = cpu_to_be16(sizeof(flash_header_v2_t));
239 fhdr_v2->header.version = IVT_VERSION; /* 0x40 */
241 fhdr_v2->entry = entry_point;
242 fhdr_v2->reserved1 = fhdr_v2->reserved2 = 0;
243 fhdr_v2->self = entry_point - sizeof(struct imx_header);
245 fhdr_v2->dcd_ptr = fhdr_v2->self +
246 offsetof(imx_header_v2_t, dcd_table);
248 fhdr_v2->boot_data_ptr = fhdr_v2->self +
249 offsetof(imx_header_v2_t, boot_data);
251 hdr_v2->boot_data.start = fhdr_v2->self - flash_offset;
253 /* Security feature are not supported */
255 header_size_ptr = &hdr_v2->boot_data.size;
258 static void set_hdr_func(struct imx_header *imxhdr)
260 switch (imximage_version) {
262 set_dcd_val = set_dcd_val_v1;
263 set_dcd_rst = set_dcd_rst_v1;
264 set_imx_hdr = set_imx_hdr_v1;
265 max_dcd_entries = MAX_HW_CFG_SIZE_V1;
268 set_dcd_val = set_dcd_val_v2;
269 set_dcd_rst = set_dcd_rst_v2;
270 set_imx_hdr = set_imx_hdr_v2;
271 max_dcd_entries = MAX_HW_CFG_SIZE_V2;
274 err_imximage_version(imximage_version);
279 static void print_hdr_v1(struct imx_header *imx_hdr)
281 imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1;
282 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
283 dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table;
284 uint32_t size, length, ver;
286 size = dcd_v1->preamble.length;
287 if (size > (MAX_HW_CFG_SIZE_V1 * sizeof(dcd_type_addr_data_t))) {
289 "Error: Image corrupt DCD size %d exceed maximum %d\n",
290 (uint32_t)(size / sizeof(dcd_type_addr_data_t)),
295 length = dcd_v1->preamble.length / sizeof(dcd_type_addr_data_t);
296 ver = detect_imximage_version(imx_hdr);
298 printf("Image Type: Freescale IMX Boot Image\n");
299 printf("Image Ver: %x", ver);
300 printf("%s\n", get_table_entry_name(imximage_versions, NULL, ver));
301 printf("Data Size: ");
302 genimg_print_size(dcd_v1->addr_data[length].type);
303 printf("Load Address: %08x\n", (uint32_t)fhdr_v1->app_dest_ptr);
304 printf("Entry Point: %08x\n", (uint32_t)fhdr_v1->app_code_jump_vector);
307 static void print_hdr_v2(struct imx_header *imx_hdr)
309 imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2;
310 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
311 dcd_v2_t *dcd_v2 = &hdr_v2->dcd_table;
312 uint32_t size, version;
314 size = be16_to_cpu(dcd_v2->header.length) - 8;
315 if (size > (MAX_HW_CFG_SIZE_V2 * sizeof(dcd_addr_data_t))) {
317 "Error: Image corrupt DCD size %d exceed maximum %d\n",
318 (uint32_t)(size / sizeof(dcd_addr_data_t)),
323 version = detect_imximage_version(imx_hdr);
325 printf("Image Type: Freescale IMX Boot Image\n");
326 printf("Image Ver: %x", version);
327 printf("%s\n", get_table_entry_name(imximage_versions, NULL, version));
328 printf("Data Size: ");
329 genimg_print_size(hdr_v2->boot_data.size);
330 printf("Load Address: %08x\n", (uint32_t)fhdr_v2->boot_data_ptr);
331 printf("Entry Point: %08x\n", (uint32_t)fhdr_v2->entry);
334 static void parse_cfg_cmd(struct imx_header *imxhdr, int32_t cmd, char *token,
335 char *name, int lineno, int fld, int dcd_len)
338 static int cmd_ver_first = ~0;
341 case CMD_IMAGE_VERSION:
342 imximage_version = get_cfg_value(token, name, lineno);
343 if (cmd_ver_first == 0) {
344 fprintf(stderr, "Error: %s[%d] - IMAGE_VERSION "
345 "command need be the first before other "
346 "valid command in the file\n", name, lineno);
350 set_hdr_func(imxhdr);
353 imxhdr->flash_offset = get_table_entry_id(imximage_bootops,
354 "imximage boot option", token);
355 if (imxhdr->flash_offset == -1) {
356 fprintf(stderr, "Error: %s[%d] -Invalid boot device"
357 "(%s)\n", name, lineno, token);
360 if (unlikely(cmd_ver_first != 1))
364 value = get_cfg_value(token, name, lineno);
365 (*set_dcd_val)(imxhdr, name, lineno, fld, value, dcd_len);
366 if (unlikely(cmd_ver_first != 1))
372 static void parse_cfg_fld(struct imx_header *imxhdr, int32_t *cmd,
373 char *token, char *name, int lineno, int fld, int *dcd_len)
379 *cmd = get_table_entry_id(imximage_cmds,
380 "imximage commands", token);
382 fprintf(stderr, "Error: %s[%d] - Invalid command"
383 "(%s)\n", name, lineno, token);
388 parse_cfg_cmd(imxhdr, *cmd, token, name, lineno, fld, *dcd_len);
390 case CFG_REG_ADDRESS:
392 if (*cmd != CMD_DATA)
395 value = get_cfg_value(token, name, lineno);
396 (*set_dcd_val)(imxhdr, name, lineno, fld, value, *dcd_len);
398 if (fld == CFG_REG_VALUE) {
400 if (*dcd_len > max_dcd_entries) {
401 fprintf(stderr, "Error: %s[%d] -"
402 "DCD table exceeds maximum size(%d)\n",
403 name, lineno, max_dcd_entries);
412 static uint32_t parse_cfg_file(struct imx_header *imxhdr, char *name)
416 char *token, *saveptr1, *saveptr2;
423 fd = fopen(name, "r");
425 fprintf(stderr, "Error: %s - Can't open DCD file\n", name);
429 /* Very simple parsing, line starting with # are comments
432 while ((getline(&line, &len, fd)) > 0) {
435 token = strtok_r(line, "\r\n", &saveptr1);
439 /* Check inside the single line */
440 for (fld = CFG_COMMAND, cmd = CMD_INVALID,
441 line = token; ; line = NULL, fld++) {
442 token = strtok_r(line, " \t", &saveptr2);
446 /* Drop all text starting with '#' as comments */
450 parse_cfg_fld(imxhdr, &cmd, token, name,
451 lineno, fld, &dcd_len);
456 (*set_dcd_rst)(imxhdr, dcd_len, name, lineno);
459 /* Exit if there is no BOOT_FROM field specifying the flash_offset */
460 if (imxhdr->flash_offset == FLASH_OFFSET_UNDEFINED) {
461 fprintf(stderr, "Error: No BOOT_FROM tag in %s\n", name);
468 static int imximage_check_image_types(uint8_t type)
470 if (type == IH_TYPE_IMXIMAGE)
476 static int imximage_verify_header(unsigned char *ptr, int image_size,
477 struct mkimage_params *params)
479 struct imx_header *imx_hdr = (struct imx_header *) ptr;
481 if (detect_imximage_version(imx_hdr) == IMXIMAGE_VER_INVALID)
482 return -FDT_ERR_BADSTRUCTURE;
487 static void imximage_print_header(const void *ptr)
489 struct imx_header *imx_hdr = (struct imx_header *) ptr;
490 uint32_t version = detect_imximage_version(imx_hdr);
494 print_hdr_v1(imx_hdr);
497 print_hdr_v2(imx_hdr);
500 err_imximage_version(version);
505 static void imximage_set_header(void *ptr, struct stat *sbuf, int ifd,
506 struct mkimage_params *params)
508 struct imx_header *imxhdr = (struct imx_header *)ptr;
512 * In order to not change the old imx cfg file
513 * by adding VERSION command into it, here need
514 * set up function ptr group to V1 by default.
516 imximage_version = IMXIMAGE_V1;
517 /* Be able to detect if the cfg file has no BOOT_FROM tag */
518 imxhdr->flash_offset = FLASH_OFFSET_UNDEFINED;
519 set_hdr_func(imxhdr);
521 /* Parse dcd configuration file */
522 dcd_len = parse_cfg_file(imxhdr, params->imagename);
524 /* Set the imx header */
525 (*set_imx_hdr)(imxhdr, dcd_len, params->ep, imxhdr->flash_offset);
526 *header_size_ptr = sbuf->st_size + imxhdr->flash_offset;
529 int imximage_check_params(struct mkimage_params *params)
533 if (!strlen(params->imagename)) {
534 fprintf(stderr, "Error: %s - Configuration file not specified, "
535 "it is needed for imximage generation\n",
541 * XIP is not allowed and verify that incompatible
542 * parameters are not sent at the same time
543 * For example, if list is required a data image must not be provided
545 return (params->dflag && (params->fflag || params->lflag)) ||
546 (params->fflag && (params->dflag || params->lflag)) ||
547 (params->lflag && (params->dflag || params->fflag)) ||
548 (params->xflag) || !(strlen(params->imagename));
552 * imximage parameters
554 static struct image_type_params imximage_params = {
555 .name = "Freescale i.MX 5x Boot Image support",
556 .header_size = sizeof(struct imx_header),
557 .hdr = (void *)&imximage_header,
558 .check_image_type = imximage_check_image_types,
559 .verify_header = imximage_verify_header,
560 .print_header = imximage_print_header,
561 .set_header = imximage_set_header,
562 .check_params = imximage_check_params,
565 void init_imx_image_type(void)
567 mkimage_register(&imximage_params);