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 * See file CREDITS for list of people who contributed to this 10 * project. 11 * 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. 16 * 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. 21 * 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, 25 * MA 02111-1307 USA 26 */ 27 28 /* Required to obtain the getline prototype from stdio.h */ 29 #define _GNU_SOURCE 30 31 #include "mkimage.h" 32 #include <image.h> 33 #include "imximage.h" 34 35 /* 36 * Supported commands for configuration file 37 */ 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", }, 42 {-1, "", "", }, 43 }; 44 45 /* 46 * Supported Boot options for configuration file 47 * this is needed to set the correct flash offset 48 */ 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", }, 57 }; 58 59 /* 60 * IMXIMAGE version definition for i.MX chips 61 */ 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)", }, 66 }; 67 68 static struct imx_header imximage_header; 69 static uint32_t imximage_version; 70 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 76 static uint32_t get_cfg_value(char *token, char *name, int linenr) 77 { 78 char *endptr; 79 uint32_t value; 80 81 errno = 0; 82 value = strtoul(token, &endptr, 16); 83 if (errno || (token == endptr)) { 84 fprintf(stderr, "Error: %s[%d] - Invalid hex data(%s)\n", 85 name, linenr, token); 86 exit(EXIT_FAILURE); 87 } 88 return value; 89 } 90 91 static uint32_t detect_imximage_version(struct imx_header *imx_hdr) 92 { 93 imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1; 94 imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2; 95 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr; 96 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr; 97 98 /* Try to detect V1 */ 99 if ((fhdr_v1->app_code_barker == APP_CODE_BARKER) && 100 (hdr_v1->dcd_table.preamble.barker == DCD_BARKER)) 101 return IMXIMAGE_V1; 102 103 /* Try to detect V2 */ 104 if ((fhdr_v2->header.tag == IVT_HEADER_TAG) && 105 (hdr_v2->dcd_table.header.tag == DCD_HEADER_TAG)) 106 return IMXIMAGE_V2; 107 108 return IMXIMAGE_VER_INVALID; 109 } 110 111 static void err_imximage_version(int version) 112 { 113 fprintf(stderr, 114 "Error: Unsupported imximage version:%d\n", version); 115 116 exit(EXIT_FAILURE); 117 } 118 119 static void set_dcd_val_v1(struct imx_header *imxhdr, char *name, int lineno, 120 int fld, uint32_t value, uint32_t off) 121 { 122 dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table; 123 124 switch (fld) { 125 case CFG_REG_SIZE: 126 /* Byte, halfword, word */ 127 if ((value != 1) && (value != 2) && (value != 4)) { 128 fprintf(stderr, "Error: %s[%d] - " 129 "Invalid register size " "(%d)\n", 130 name, lineno, value); 131 exit(EXIT_FAILURE); 132 } 133 dcd_v1->addr_data[off].type = value; 134 break; 135 case CFG_REG_ADDRESS: 136 dcd_v1->addr_data[off].addr = value; 137 break; 138 case CFG_REG_VALUE: 139 dcd_v1->addr_data[off].value = value; 140 break; 141 default: 142 break; 143 144 } 145 } 146 147 static void set_dcd_val_v2(struct imx_header *imxhdr, char *name, int lineno, 148 int fld, uint32_t value, uint32_t off) 149 { 150 dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table; 151 152 switch (fld) { 153 case CFG_REG_ADDRESS: 154 dcd_v2->addr_data[off].addr = cpu_to_be32(value); 155 break; 156 case CFG_REG_VALUE: 157 dcd_v2->addr_data[off].value = cpu_to_be32(value); 158 break; 159 default: 160 break; 161 162 } 163 } 164 165 /* 166 * Complete setting up the rest field of DCD of V1 167 * such as barker code and DCD data length. 168 */ 169 static void set_dcd_rst_v1(struct imx_header *imxhdr, uint32_t dcd_len, 170 char *name, int lineno) 171 { 172 dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table; 173 174 dcd_v1->preamble.barker = DCD_BARKER; 175 dcd_v1->preamble.length = dcd_len * sizeof(dcd_type_addr_data_t); 176 } 177 178 /* 179 * Complete setting up the reset field of DCD of V2 180 * such as DCD tag, version, length, etc. 181 */ 182 static void set_dcd_rst_v2(struct imx_header *imxhdr, uint32_t dcd_len, 183 char *name, int lineno) 184 { 185 dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table; 186 187 dcd_v2->header.tag = DCD_HEADER_TAG; 188 dcd_v2->header.length = cpu_to_be16( 189 dcd_len * sizeof(dcd_addr_data_t) + 8); 190 dcd_v2->header.version = DCD_VERSION; 191 dcd_v2->write_dcd_command.tag = DCD_COMMAND_TAG; 192 dcd_v2->write_dcd_command.length = cpu_to_be16( 193 dcd_len * sizeof(dcd_addr_data_t) + 4); 194 dcd_v2->write_dcd_command.param = DCD_COMMAND_PARAM; 195 } 196 197 static void set_imx_hdr_v1(struct imx_header *imxhdr, uint32_t dcd_len, 198 struct stat *sbuf, 199 struct mkimage_params *params) 200 { 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 206 /* Exit if there is no BOOT_FROM field specifying the flash_offset */ 207 if(imxhdr->flash_offset == FLASH_OFFSET_UNDEFINED) { 208 fprintf(stderr, "Error: Header v1: No BOOT_FROM tag in %s\n", 209 params->imagename); 210 exit(EXIT_FAILURE); 211 } 212 213 /* Set magic number */ 214 fhdr_v1->app_code_barker = APP_CODE_BARKER; 215 216 fhdr_v1->app_dest_ptr = params->ep - imxhdr->flash_offset - 217 sizeof(struct imx_header); 218 fhdr_v1->app_code_jump_vector = params->ep; 219 220 base_offset = fhdr_v1->app_dest_ptr + imxhdr->flash_offset ; 221 fhdr_v1->dcd_ptr_ptr = 222 (uint32_t) (offsetof(flash_header_v1_t, dcd_ptr) - 223 offsetof(flash_header_v1_t, app_code_jump_vector) + 224 base_offset); 225 226 fhdr_v1->dcd_ptr = base_offset + 227 offsetof(imx_header_v1_t, dcd_table); 228 229 /* The external flash header must be at the end of the DCD table */ 230 dcd_v1->addr_data[dcd_len].type = sbuf->st_size + 231 imxhdr->flash_offset + 232 sizeof(struct imx_header); 233 234 /* Security feature are not supported */ 235 fhdr_v1->app_code_csf = 0; 236 fhdr_v1->super_root_key = 0; 237 } 238 239 static void set_imx_hdr_v2(struct imx_header *imxhdr, uint32_t dcd_len, 240 struct stat *sbuf, 241 struct mkimage_params *params) 242 { 243 imx_header_v2_t *hdr_v2 = &imxhdr->header.hdr_v2; 244 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr; 245 246 /* Exit if there is no BOOT_FROM field specifying the flash_offset */ 247 if(imxhdr->flash_offset == FLASH_OFFSET_UNDEFINED) { 248 fprintf(stderr, "Error: Header v2: No BOOT_FROM tag in %s\n", 249 params->imagename); 250 exit(EXIT_FAILURE); 251 } 252 253 /* Set magic number */ 254 fhdr_v2->header.tag = IVT_HEADER_TAG; /* 0xD1 */ 255 fhdr_v2->header.length = cpu_to_be16(sizeof(flash_header_v2_t)); 256 fhdr_v2->header.version = IVT_VERSION; /* 0x40 */ 257 258 fhdr_v2->entry = params->ep; 259 fhdr_v2->reserved1 = fhdr_v2->reserved2 = 0; 260 fhdr_v2->self = params->ep - sizeof(struct imx_header); 261 262 fhdr_v2->dcd_ptr = fhdr_v2->self + 263 offsetof(imx_header_v2_t, dcd_table); 264 265 fhdr_v2->boot_data_ptr = fhdr_v2->self + 266 offsetof(imx_header_v2_t, boot_data); 267 268 hdr_v2->boot_data.start = fhdr_v2->self - imxhdr->flash_offset; 269 hdr_v2->boot_data.size = sbuf->st_size + 270 imxhdr->flash_offset + 271 sizeof(struct imx_header); 272 273 /* Security feature are not supported */ 274 fhdr_v2->csf = 0; 275 } 276 277 static void set_hdr_func(struct imx_header *imxhdr) 278 { 279 switch (imximage_version) { 280 case IMXIMAGE_V1: 281 set_dcd_val = set_dcd_val_v1; 282 set_dcd_rst = set_dcd_rst_v1; 283 set_imx_hdr = set_imx_hdr_v1; 284 max_dcd_entries = MAX_HW_CFG_SIZE_V1; 285 break; 286 case IMXIMAGE_V2: 287 set_dcd_val = set_dcd_val_v2; 288 set_dcd_rst = set_dcd_rst_v2; 289 set_imx_hdr = set_imx_hdr_v2; 290 max_dcd_entries = MAX_HW_CFG_SIZE_V2; 291 break; 292 default: 293 err_imximage_version(imximage_version); 294 break; 295 } 296 } 297 298 static void print_hdr_v1(struct imx_header *imx_hdr) 299 { 300 imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1; 301 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr; 302 dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table; 303 uint32_t size, length, ver; 304 305 size = dcd_v1->preamble.length; 306 if (size > (MAX_HW_CFG_SIZE_V1 * sizeof(dcd_type_addr_data_t))) { 307 fprintf(stderr, 308 "Error: Image corrupt DCD size %d exceed maximum %d\n", 309 (uint32_t)(size / sizeof(dcd_type_addr_data_t)), 310 MAX_HW_CFG_SIZE_V1); 311 exit(EXIT_FAILURE); 312 } 313 314 length = dcd_v1->preamble.length / sizeof(dcd_type_addr_data_t); 315 ver = detect_imximage_version(imx_hdr); 316 317 printf("Image Type: Freescale IMX Boot Image\n"); 318 printf("Image Ver: %x", ver); 319 printf("%s\n", get_table_entry_name(imximage_versions, NULL, ver)); 320 printf("Data Size: "); 321 genimg_print_size(dcd_v1->addr_data[length].type); 322 printf("Load Address: %08x\n", (uint32_t)fhdr_v1->app_dest_ptr); 323 printf("Entry Point: %08x\n", (uint32_t)fhdr_v1->app_code_jump_vector); 324 } 325 326 static void print_hdr_v2(struct imx_header *imx_hdr) 327 { 328 imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2; 329 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr; 330 dcd_v2_t *dcd_v2 = &hdr_v2->dcd_table; 331 uint32_t size, version; 332 333 size = be16_to_cpu(dcd_v2->header.length) - 8; 334 if (size > (MAX_HW_CFG_SIZE_V2 * sizeof(dcd_addr_data_t))) { 335 fprintf(stderr, 336 "Error: Image corrupt DCD size %d exceed maximum %d\n", 337 (uint32_t)(size / sizeof(dcd_addr_data_t)), 338 MAX_HW_CFG_SIZE_V2); 339 exit(EXIT_FAILURE); 340 } 341 342 version = detect_imximage_version(imx_hdr); 343 344 printf("Image Type: Freescale IMX Boot Image\n"); 345 printf("Image Ver: %x", version); 346 printf("%s\n", get_table_entry_name(imximage_versions, NULL, version)); 347 printf("Data Size: "); 348 genimg_print_size(hdr_v2->boot_data.size); 349 printf("Load Address: %08x\n", (uint32_t)fhdr_v2->boot_data_ptr); 350 printf("Entry Point: %08x\n", (uint32_t)fhdr_v2->entry); 351 } 352 353 static void parse_cfg_cmd(struct imx_header *imxhdr, int32_t cmd, char *token, 354 char *name, int lineno, int fld, int dcd_len) 355 { 356 int value; 357 static int cmd_ver_first = ~0; 358 359 switch (cmd) { 360 case CMD_IMAGE_VERSION: 361 imximage_version = get_cfg_value(token, name, lineno); 362 if (cmd_ver_first == 0) { 363 fprintf(stderr, "Error: %s[%d] - IMAGE_VERSION " 364 "command need be the first before other " 365 "valid command in the file\n", name, lineno); 366 exit(EXIT_FAILURE); 367 } 368 cmd_ver_first = 1; 369 set_hdr_func(imxhdr); 370 break; 371 case CMD_BOOT_FROM: 372 imxhdr->flash_offset = get_table_entry_id(imximage_bootops, 373 "imximage boot option", token); 374 if (imxhdr->flash_offset == -1) { 375 fprintf(stderr, "Error: %s[%d] -Invalid boot device" 376 "(%s)\n", name, lineno, token); 377 exit(EXIT_FAILURE); 378 } 379 if (unlikely(cmd_ver_first != 1)) 380 cmd_ver_first = 0; 381 break; 382 case CMD_DATA: 383 value = get_cfg_value(token, name, lineno); 384 (*set_dcd_val)(imxhdr, name, lineno, fld, value, dcd_len); 385 if (unlikely(cmd_ver_first != 1)) 386 cmd_ver_first = 0; 387 break; 388 } 389 } 390 391 static void parse_cfg_fld(struct imx_header *imxhdr, int32_t *cmd, 392 char *token, char *name, int lineno, int fld, int *dcd_len) 393 { 394 int value; 395 396 switch (fld) { 397 case CFG_COMMAND: 398 *cmd = get_table_entry_id(imximage_cmds, 399 "imximage commands", token); 400 if (*cmd < 0) { 401 fprintf(stderr, "Error: %s[%d] - Invalid command" 402 "(%s)\n", name, lineno, token); 403 exit(EXIT_FAILURE); 404 } 405 break; 406 case CFG_REG_SIZE: 407 parse_cfg_cmd(imxhdr, *cmd, token, name, lineno, fld, *dcd_len); 408 break; 409 case CFG_REG_ADDRESS: 410 case CFG_REG_VALUE: 411 if (*cmd != CMD_DATA) 412 return; 413 414 value = get_cfg_value(token, name, lineno); 415 (*set_dcd_val)(imxhdr, name, lineno, fld, value, *dcd_len); 416 417 if (fld == CFG_REG_VALUE) { 418 (*dcd_len)++; 419 if (*dcd_len > max_dcd_entries) { 420 fprintf(stderr, "Error: %s[%d] -" 421 "DCD table exceeds maximum size(%d)\n", 422 name, lineno, max_dcd_entries); 423 exit(EXIT_FAILURE); 424 } 425 } 426 break; 427 default: 428 break; 429 } 430 } 431 static uint32_t parse_cfg_file(struct imx_header *imxhdr, char *name) 432 { 433 FILE *fd = NULL; 434 char *line = NULL; 435 char *token, *saveptr1, *saveptr2; 436 int lineno = 0; 437 int fld; 438 size_t len; 439 int dcd_len = 0; 440 int32_t cmd; 441 442 fd = fopen(name, "r"); 443 if (fd == 0) { 444 fprintf(stderr, "Error: %s - Can't open DCD file\n", name); 445 exit(EXIT_FAILURE); 446 } 447 448 /* Very simple parsing, line starting with # are comments 449 * and are dropped 450 */ 451 while ((getline(&line, &len, fd)) > 0) { 452 lineno++; 453 454 token = strtok_r(line, "\r\n", &saveptr1); 455 if (token == NULL) 456 continue; 457 458 /* Check inside the single line */ 459 for (fld = CFG_COMMAND, cmd = CMD_INVALID, 460 line = token; ; line = NULL, fld++) { 461 token = strtok_r(line, " \t", &saveptr2); 462 if (token == NULL) 463 break; 464 465 /* Drop all text starting with '#' as comments */ 466 if (token[0] == '#') 467 break; 468 469 parse_cfg_fld(imxhdr, &cmd, token, name, 470 lineno, fld, &dcd_len); 471 } 472 473 } 474 475 (*set_dcd_rst)(imxhdr, dcd_len, name, lineno); 476 fclose(fd); 477 478 return dcd_len; 479 } 480 481 482 static int imximage_check_image_types(uint8_t type) 483 { 484 if (type == IH_TYPE_IMXIMAGE) 485 return EXIT_SUCCESS; 486 else 487 return EXIT_FAILURE; 488 } 489 490 static int imximage_verify_header(unsigned char *ptr, int image_size, 491 struct mkimage_params *params) 492 { 493 struct imx_header *imx_hdr = (struct imx_header *) ptr; 494 495 if (detect_imximage_version(imx_hdr) == IMXIMAGE_VER_INVALID) 496 return -FDT_ERR_BADSTRUCTURE; 497 498 return 0; 499 } 500 501 static void imximage_print_header(const void *ptr) 502 { 503 struct imx_header *imx_hdr = (struct imx_header *) ptr; 504 uint32_t version = detect_imximage_version(imx_hdr); 505 506 switch (version) { 507 case IMXIMAGE_V1: 508 print_hdr_v1(imx_hdr); 509 break; 510 case IMXIMAGE_V2: 511 print_hdr_v2(imx_hdr); 512 break; 513 default: 514 err_imximage_version(version); 515 break; 516 } 517 } 518 519 static void imximage_set_header(void *ptr, struct stat *sbuf, int ifd, 520 struct mkimage_params *params) 521 { 522 struct imx_header *imxhdr = (struct imx_header *)ptr; 523 uint32_t dcd_len; 524 525 /* 526 * In order to not change the old imx cfg file 527 * by adding VERSION command into it, here need 528 * set up function ptr group to V1 by default. 529 */ 530 imximage_version = IMXIMAGE_V1; 531 /* Be able to detect if the cfg file has no BOOT_FROM tag */ 532 imxhdr->flash_offset = FLASH_OFFSET_UNDEFINED; 533 set_hdr_func(imxhdr); 534 535 /* Parse dcd configuration file */ 536 dcd_len = parse_cfg_file(imxhdr, params->imagename); 537 538 /* Set the imx header */ 539 (*set_imx_hdr)(imxhdr, dcd_len, sbuf, params); 540 } 541 542 int imximage_check_params(struct mkimage_params *params) 543 { 544 if (!params) 545 return CFG_INVALID; 546 if (!strlen(params->imagename)) { 547 fprintf(stderr, "Error: %s - Configuration file not specified, " 548 "it is needed for imximage generation\n", 549 params->cmdname); 550 return CFG_INVALID; 551 } 552 /* 553 * Check parameters: 554 * XIP is not allowed and verify that incompatible 555 * parameters are not sent at the same time 556 * For example, if list is required a data image must not be provided 557 */ 558 return (params->dflag && (params->fflag || params->lflag)) || 559 (params->fflag && (params->dflag || params->lflag)) || 560 (params->lflag && (params->dflag || params->fflag)) || 561 (params->xflag) || !(strlen(params->imagename)); 562 } 563 564 /* 565 * imximage parameters 566 */ 567 static struct image_type_params imximage_params = { 568 .name = "Freescale i.MX 5x Boot Image support", 569 .header_size = sizeof(struct imx_header), 570 .hdr = (void *)&imximage_header, 571 .check_image_type = imximage_check_image_types, 572 .verify_header = imximage_verify_header, 573 .print_header = imximage_print_header, 574 .set_header = imximage_set_header, 575 .check_params = imximage_check_params, 576 }; 577 578 void init_imx_image_type(void) 579 { 580 mkimage_register(&imximage_params); 581 } 582