1 /* 2 * (C) Copyright 2009 3 * Stefano Babic, DENX Software Engineering, sbabic@denx.de. 4 * 5 * (C) Copyright 2008 6 * Marvell Semiconductor <www.marvell.com> 7 * Written-by: Prafulla Wadaskar <prafulla@marvell.com> 8 * 9 * SPDX-License-Identifier: GPL-2.0+ 10 */ 11 12 /* Required to obtain the getline prototype from stdio.h */ 13 #define _GNU_SOURCE 14 15 #include "mkimage.h" 16 #include <image.h> 17 #include "imximage.h" 18 19 /* 20 * Supported commands for configuration file 21 */ 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", }, 27 {-1, "", "", }, 28 }; 29 30 /* 31 * Supported Boot options for configuration file 32 * this is needed to set the correct flash offset 33 */ 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", }, 42 }; 43 44 /* 45 * Supported Boot options for configuration file 46 * this is needed to determine the initial load size 47 */ 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", }, 56 }; 57 58 /* 59 * IMXIMAGE version definition for i.MX chips 60 */ 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)", }, 65 }; 66 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; 73 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; 79 80 static uint32_t get_cfg_value(char *token, char *name, int linenr) 81 { 82 char *endptr; 83 uint32_t value; 84 85 errno = 0; 86 value = strtoul(token, &endptr, 16); 87 if (errno || (token == endptr)) { 88 fprintf(stderr, "Error: %s[%d] - Invalid hex data(%s)\n", 89 name, linenr, token); 90 exit(EXIT_FAILURE); 91 } 92 return value; 93 } 94 95 static uint32_t detect_imximage_version(struct imx_header *imx_hdr) 96 { 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; 101 102 /* Try to detect V1 */ 103 if ((fhdr_v1->app_code_barker == APP_CODE_BARKER) && 104 (hdr_v1->dcd_table.preamble.barker == DCD_BARKER)) 105 return IMXIMAGE_V1; 106 107 /* Try to detect V2 */ 108 if ((fhdr_v2->header.tag == IVT_HEADER_TAG) && 109 (hdr_v2->dcd_table.header.tag == DCD_HEADER_TAG)) 110 return IMXIMAGE_V2; 111 112 return IMXIMAGE_VER_INVALID; 113 } 114 115 static void err_imximage_version(int version) 116 { 117 fprintf(stderr, 118 "Error: Unsupported imximage version:%d\n", version); 119 120 exit(EXIT_FAILURE); 121 } 122 123 static void set_dcd_val_v1(struct imx_header *imxhdr, char *name, int lineno, 124 int fld, uint32_t value, uint32_t off) 125 { 126 dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table; 127 128 switch (fld) { 129 case CFG_REG_SIZE: 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); 135 exit(EXIT_FAILURE); 136 } 137 dcd_v1->addr_data[off].type = value; 138 break; 139 case CFG_REG_ADDRESS: 140 dcd_v1->addr_data[off].addr = value; 141 break; 142 case CFG_REG_VALUE: 143 dcd_v1->addr_data[off].value = value; 144 break; 145 default: 146 break; 147 148 } 149 } 150 151 static void set_dcd_val_v2(struct imx_header *imxhdr, char *name, int lineno, 152 int fld, uint32_t value, uint32_t off) 153 { 154 dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table; 155 156 switch (fld) { 157 case CFG_REG_ADDRESS: 158 dcd_v2->addr_data[off].addr = cpu_to_be32(value); 159 break; 160 case CFG_REG_VALUE: 161 dcd_v2->addr_data[off].value = cpu_to_be32(value); 162 break; 163 default: 164 break; 165 166 } 167 } 168 169 /* 170 * Complete setting up the rest field of DCD of V1 171 * such as barker code and DCD data length. 172 */ 173 static void set_dcd_rst_v1(struct imx_header *imxhdr, uint32_t dcd_len, 174 char *name, int lineno) 175 { 176 dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table; 177 178 dcd_v1->preamble.barker = DCD_BARKER; 179 dcd_v1->preamble.length = dcd_len * sizeof(dcd_type_addr_data_t); 180 } 181 182 /* 183 * Complete setting up the reset field of DCD of V2 184 * such as DCD tag, version, length, etc. 185 */ 186 static void set_dcd_rst_v2(struct imx_header *imxhdr, uint32_t dcd_len, 187 char *name, int lineno) 188 { 189 dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table; 190 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; 199 } 200 201 static void set_imx_hdr_v1(struct imx_header *imxhdr, uint32_t dcd_len, 202 uint32_t entry_point, uint32_t flash_offset) 203 { 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; 207 uint32_t hdr_base; 208 uint32_t header_length = (((char *)&dcd_v1->addr_data[dcd_len].addr) 209 - ((char *)imxhdr)); 210 211 /* Set magic number */ 212 fhdr_v1->app_code_barker = APP_CODE_BARKER; 213 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; 218 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); 221 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); 226 } 227 228 static void set_imx_hdr_v2(struct imx_header *imxhdr, uint32_t dcd_len, 229 uint32_t entry_point, uint32_t flash_offset) 230 { 231 imx_header_v2_t *hdr_v2 = &imxhdr->header.hdr_v2; 232 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr; 233 uint32_t hdr_base; 234 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 */ 239 240 fhdr_v2->entry = entry_point; 241 fhdr_v2->reserved1 = fhdr_v2->reserved2 = 0; 242 hdr_base = entry_point - imximage_init_loadsize + 243 flash_offset; 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; 249 250 /* Security feature are not supported */ 251 fhdr_v2->csf = 0; 252 header_size_ptr = &hdr_v2->boot_data.size; 253 } 254 255 static void set_hdr_func(struct imx_header *imxhdr) 256 { 257 switch (imximage_version) { 258 case IMXIMAGE_V1: 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; 263 break; 264 case IMXIMAGE_V2: 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; 269 break; 270 default: 271 err_imximage_version(imximage_version); 272 break; 273 } 274 } 275 276 static void print_hdr_v1(struct imx_header *imx_hdr) 277 { 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; 282 283 size = dcd_v1->preamble.length; 284 if (size > (MAX_HW_CFG_SIZE_V1 * sizeof(dcd_type_addr_data_t))) { 285 fprintf(stderr, 286 "Error: Image corrupt DCD size %d exceed maximum %d\n", 287 (uint32_t)(size / sizeof(dcd_type_addr_data_t)), 288 MAX_HW_CFG_SIZE_V1); 289 exit(EXIT_FAILURE); 290 } 291 292 length = dcd_v1->preamble.length / sizeof(dcd_type_addr_data_t); 293 ver = detect_imximage_version(imx_hdr); 294 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); 302 } 303 304 static void print_hdr_v2(struct imx_header *imx_hdr) 305 { 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; 310 311 size = be16_to_cpu(dcd_v2->header.length) - 8; 312 if (size > (MAX_HW_CFG_SIZE_V2 * sizeof(dcd_addr_data_t))) { 313 fprintf(stderr, 314 "Error: Image corrupt DCD size %d exceed maximum %d\n", 315 (uint32_t)(size / sizeof(dcd_addr_data_t)), 316 MAX_HW_CFG_SIZE_V2); 317 exit(EXIT_FAILURE); 318 } 319 320 version = detect_imximage_version(imx_hdr); 321 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); 329 } 330 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) 333 { 334 int value; 335 static int cmd_ver_first = ~0; 336 337 switch (cmd) { 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); 344 exit(EXIT_FAILURE); 345 } 346 cmd_ver_first = 1; 347 set_hdr_func(imxhdr); 348 break; 349 case CMD_BOOT_FROM: 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); 355 exit(EXIT_FAILURE); 356 } 357 358 imximage_init_loadsize = 359 get_table_entry_id(imximage_boot_loadsize, 360 "imximage boot option", token); 361 362 if (imximage_init_loadsize == -1) { 363 fprintf(stderr, 364 "Error: %s[%d] -Invalid boot device(%s)\n", 365 name, lineno, token); 366 exit(EXIT_FAILURE); 367 } 368 if (unlikely(cmd_ver_first != 1)) 369 cmd_ver_first = 0; 370 break; 371 case CMD_BOOT_OFFSET: 372 imximage_ivt_offset = get_cfg_value(token, name, lineno); 373 if (unlikely(cmd_ver_first != 1)) 374 cmd_ver_first = 0; 375 break; 376 case CMD_DATA: 377 value = get_cfg_value(token, name, lineno); 378 (*set_dcd_val)(imxhdr, name, lineno, fld, value, dcd_len); 379 if (unlikely(cmd_ver_first != 1)) 380 cmd_ver_first = 0; 381 break; 382 } 383 } 384 385 static void parse_cfg_fld(struct imx_header *imxhdr, int32_t *cmd, 386 char *token, char *name, int lineno, int fld, int *dcd_len) 387 { 388 int value; 389 390 switch (fld) { 391 case CFG_COMMAND: 392 *cmd = get_table_entry_id(imximage_cmds, 393 "imximage commands", token); 394 if (*cmd < 0) { 395 fprintf(stderr, "Error: %s[%d] - Invalid command" 396 "(%s)\n", name, lineno, token); 397 exit(EXIT_FAILURE); 398 } 399 break; 400 case CFG_REG_SIZE: 401 parse_cfg_cmd(imxhdr, *cmd, token, name, lineno, fld, *dcd_len); 402 break; 403 case CFG_REG_ADDRESS: 404 case CFG_REG_VALUE: 405 if (*cmd != CMD_DATA) 406 return; 407 408 value = get_cfg_value(token, name, lineno); 409 (*set_dcd_val)(imxhdr, name, lineno, fld, value, *dcd_len); 410 411 if (fld == CFG_REG_VALUE) { 412 (*dcd_len)++; 413 if (*dcd_len > max_dcd_entries) { 414 fprintf(stderr, "Error: %s[%d] -" 415 "DCD table exceeds maximum size(%d)\n", 416 name, lineno, max_dcd_entries); 417 exit(EXIT_FAILURE); 418 } 419 } 420 break; 421 default: 422 break; 423 } 424 } 425 static uint32_t parse_cfg_file(struct imx_header *imxhdr, char *name) 426 { 427 FILE *fd = NULL; 428 char *line = NULL; 429 char *token, *saveptr1, *saveptr2; 430 int lineno = 0; 431 int fld; 432 size_t len; 433 int dcd_len = 0; 434 int32_t cmd; 435 436 fd = fopen(name, "r"); 437 if (fd == 0) { 438 fprintf(stderr, "Error: %s - Can't open DCD file\n", name); 439 exit(EXIT_FAILURE); 440 } 441 442 /* Very simple parsing, line starting with # are comments 443 * and are dropped 444 */ 445 while ((getline(&line, &len, fd)) > 0) { 446 lineno++; 447 448 token = strtok_r(line, "\r\n", &saveptr1); 449 if (token == NULL) 450 continue; 451 452 /* Check inside the single line */ 453 for (fld = CFG_COMMAND, cmd = CMD_INVALID, 454 line = token; ; line = NULL, fld++) { 455 token = strtok_r(line, " \t", &saveptr2); 456 if (token == NULL) 457 break; 458 459 /* Drop all text starting with '#' as comments */ 460 if (token[0] == '#') 461 break; 462 463 parse_cfg_fld(imxhdr, &cmd, token, name, 464 lineno, fld, &dcd_len); 465 } 466 467 } 468 469 (*set_dcd_rst)(imxhdr, dcd_len, name, lineno); 470 fclose(fd); 471 472 /* Exit if there is no BOOT_FROM field specifying the flash_offset */ 473 if (imximage_ivt_offset == FLASH_OFFSET_UNDEFINED) { 474 fprintf(stderr, "Error: No BOOT_FROM tag in %s\n", name); 475 exit(EXIT_FAILURE); 476 } 477 return dcd_len; 478 } 479 480 481 static int imximage_check_image_types(uint8_t type) 482 { 483 if (type == IH_TYPE_IMXIMAGE) 484 return EXIT_SUCCESS; 485 else 486 return EXIT_FAILURE; 487 } 488 489 static int imximage_verify_header(unsigned char *ptr, int image_size, 490 struct mkimage_params *params) 491 { 492 struct imx_header *imx_hdr = (struct imx_header *) ptr; 493 494 if (detect_imximage_version(imx_hdr) == IMXIMAGE_VER_INVALID) 495 return -FDT_ERR_BADSTRUCTURE; 496 497 return 0; 498 } 499 500 static void imximage_print_header(const void *ptr) 501 { 502 struct imx_header *imx_hdr = (struct imx_header *) ptr; 503 uint32_t version = detect_imximage_version(imx_hdr); 504 505 switch (version) { 506 case IMXIMAGE_V1: 507 print_hdr_v1(imx_hdr); 508 break; 509 case IMXIMAGE_V2: 510 print_hdr_v2(imx_hdr); 511 break; 512 default: 513 err_imximage_version(version); 514 break; 515 } 516 } 517 518 static void imximage_set_header(void *ptr, struct stat *sbuf, int ifd, 519 struct mkimage_params *params) 520 { 521 struct imx_header *imxhdr = (struct imx_header *)ptr; 522 uint32_t dcd_len; 523 524 /* 525 * In order to not change the old imx cfg file 526 * by adding VERSION command into it, here need 527 * set up function ptr group to V1 by default. 528 */ 529 imximage_version = IMXIMAGE_V1; 530 /* Be able to detect if the cfg file has no BOOT_FROM tag */ 531 imximage_ivt_offset = FLASH_OFFSET_UNDEFINED; 532 set_hdr_func(imxhdr); 533 534 /* Parse dcd configuration file */ 535 dcd_len = parse_cfg_file(imxhdr, params->imagename); 536 537 /* Set the imx header */ 538 (*set_imx_hdr)(imxhdr, dcd_len, params->ep, imximage_ivt_offset); 539 540 /* 541 * ROM bug alert 542 * 543 * MX53 only loads 512 byte multiples in case of SD boot. 544 * MX53 only loads NAND page multiples in case of NAND boot and 545 * supports up to 4096 byte large pages, thus align to 4096. 546 * 547 * The remaining fraction of a block bytes would not be loaded! 548 */ 549 *header_size_ptr = ROUND(sbuf->st_size, 4096); 550 } 551 552 int imximage_check_params(struct mkimage_params *params) 553 { 554 if (!params) 555 return CFG_INVALID; 556 if (!strlen(params->imagename)) { 557 fprintf(stderr, "Error: %s - Configuration file not specified, " 558 "it is needed for imximage generation\n", 559 params->cmdname); 560 return CFG_INVALID; 561 } 562 /* 563 * Check parameters: 564 * XIP is not allowed and verify that incompatible 565 * parameters are not sent at the same time 566 * For example, if list is required a data image must not be provided 567 */ 568 return (params->dflag && (params->fflag || params->lflag)) || 569 (params->fflag && (params->dflag || params->lflag)) || 570 (params->lflag && (params->dflag || params->fflag)) || 571 (params->xflag) || !(strlen(params->imagename)); 572 } 573 574 /* 575 * imximage parameters 576 */ 577 static struct image_type_params imximage_params = { 578 .name = "Freescale i.MX Boot Image support", 579 .header_size = sizeof(struct imx_header), 580 .hdr = (void *)&imximage_header, 581 .check_image_type = imximage_check_image_types, 582 .verify_header = imximage_verify_header, 583 .print_header = imximage_print_header, 584 .set_header = imximage_set_header, 585 .check_params = imximage_check_params, 586 }; 587 588 void init_imx_image_type(void) 589 { 590 mkimage_register(&imximage_params); 591 } 592