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 /* Set magic number */ 207 fhdr_v1->app_code_barker = APP_CODE_BARKER; 208 209 fhdr_v1->app_dest_ptr = params->ep - imxhdr->flash_offset - 210 sizeof(struct imx_header); 211 fhdr_v1->app_code_jump_vector = params->ep; 212 213 base_offset = fhdr_v1->app_dest_ptr + imxhdr->flash_offset ; 214 fhdr_v1->dcd_ptr_ptr = 215 (uint32_t) (offsetof(flash_header_v1_t, dcd_ptr) - 216 offsetof(flash_header_v1_t, app_code_jump_vector) + 217 base_offset); 218 219 fhdr_v1->dcd_ptr = base_offset + 220 offsetof(imx_header_v1_t, dcd_table); 221 222 /* The external flash header must be at the end of the DCD table */ 223 dcd_v1->addr_data[dcd_len].type = sbuf->st_size + 224 imxhdr->flash_offset + 225 sizeof(struct imx_header); 226 227 /* Security feature are not supported */ 228 fhdr_v1->app_code_csf = 0; 229 fhdr_v1->super_root_key = 0; 230 } 231 232 static void set_imx_hdr_v2(struct imx_header *imxhdr, uint32_t dcd_len, 233 struct stat *sbuf, 234 struct mkimage_params *params) 235 { 236 imx_header_v2_t *hdr_v2 = &imxhdr->header.hdr_v2; 237 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr; 238 239 /* Set magic number */ 240 fhdr_v2->header.tag = IVT_HEADER_TAG; /* 0xD1 */ 241 fhdr_v2->header.length = cpu_to_be16(sizeof(flash_header_v2_t)); 242 fhdr_v2->header.version = IVT_VERSION; /* 0x40 */ 243 244 fhdr_v2->entry = params->ep; 245 fhdr_v2->reserved1 = fhdr_v2->reserved2 = 0; 246 fhdr_v2->self = params->ep - sizeof(struct imx_header); 247 248 fhdr_v2->dcd_ptr = fhdr_v2->self + 249 offsetof(imx_header_v2_t, dcd_table); 250 251 fhdr_v2->boot_data_ptr = fhdr_v2->self + 252 offsetof(imx_header_v2_t, boot_data); 253 254 hdr_v2->boot_data.start = fhdr_v2->self - imxhdr->flash_offset; 255 hdr_v2->boot_data.size = sbuf->st_size + 256 imxhdr->flash_offset + 257 sizeof(struct imx_header); 258 259 /* Security feature are not supported */ 260 fhdr_v2->csf = 0; 261 } 262 263 static void set_hdr_func(struct imx_header *imxhdr) 264 { 265 switch (imximage_version) { 266 case IMXIMAGE_V1: 267 set_dcd_val = set_dcd_val_v1; 268 set_dcd_rst = set_dcd_rst_v1; 269 set_imx_hdr = set_imx_hdr_v1; 270 max_dcd_entries = MAX_HW_CFG_SIZE_V1; 271 break; 272 case IMXIMAGE_V2: 273 set_dcd_val = set_dcd_val_v2; 274 set_dcd_rst = set_dcd_rst_v2; 275 set_imx_hdr = set_imx_hdr_v2; 276 max_dcd_entries = MAX_HW_CFG_SIZE_V2; 277 break; 278 default: 279 err_imximage_version(imximage_version); 280 break; 281 } 282 } 283 284 static void print_hdr_v1(struct imx_header *imx_hdr) 285 { 286 imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1; 287 flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr; 288 dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table; 289 uint32_t size, length, ver; 290 291 size = dcd_v1->preamble.length; 292 if (size > (MAX_HW_CFG_SIZE_V1 * sizeof(dcd_type_addr_data_t))) { 293 fprintf(stderr, 294 "Error: Image corrupt DCD size %d exceed maximum %d\n", 295 (uint32_t)(size / sizeof(dcd_type_addr_data_t)), 296 MAX_HW_CFG_SIZE_V1); 297 exit(EXIT_FAILURE); 298 } 299 300 length = dcd_v1->preamble.length / sizeof(dcd_type_addr_data_t); 301 ver = detect_imximage_version(imx_hdr); 302 303 printf("Image Type: Freescale IMX Boot Image\n"); 304 printf("Image Ver: %x", ver); 305 printf("%s\n", get_table_entry_name(imximage_versions, NULL, ver)); 306 printf("Data Size: "); 307 genimg_print_size(dcd_v1->addr_data[length].type); 308 printf("Load Address: %08x\n", (uint32_t)fhdr_v1->app_dest_ptr); 309 printf("Entry Point: %08x\n", (uint32_t)fhdr_v1->app_code_jump_vector); 310 } 311 312 static void print_hdr_v2(struct imx_header *imx_hdr) 313 { 314 imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2; 315 flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr; 316 dcd_v2_t *dcd_v2 = &hdr_v2->dcd_table; 317 uint32_t size, version; 318 319 size = be16_to_cpu(dcd_v2->header.length) - 8; 320 if (size > (MAX_HW_CFG_SIZE_V2 * sizeof(dcd_addr_data_t))) { 321 fprintf(stderr, 322 "Error: Image corrupt DCD size %d exceed maximum %d\n", 323 (uint32_t)(size / sizeof(dcd_addr_data_t)), 324 MAX_HW_CFG_SIZE_V2); 325 exit(EXIT_FAILURE); 326 } 327 328 version = detect_imximage_version(imx_hdr); 329 330 printf("Image Type: Freescale IMX Boot Image\n"); 331 printf("Image Ver: %x", version); 332 printf("%s\n", get_table_entry_name(imximage_versions, NULL, version)); 333 printf("Data Size: "); 334 genimg_print_size(hdr_v2->boot_data.size); 335 printf("Load Address: %08x\n", (uint32_t)fhdr_v2->boot_data_ptr); 336 printf("Entry Point: %08x\n", (uint32_t)fhdr_v2->entry); 337 } 338 339 static void parse_cfg_cmd(struct imx_header *imxhdr, int32_t cmd, char *token, 340 char *name, int lineno, int fld, int dcd_len) 341 { 342 int value; 343 static int cmd_ver_first = ~0; 344 345 switch (cmd) { 346 case CMD_IMAGE_VERSION: 347 imximage_version = get_cfg_value(token, name, lineno); 348 if (cmd_ver_first == 0) { 349 fprintf(stderr, "Error: %s[%d] - IMAGE_VERSION " 350 "command need be the first before other " 351 "valid command in the file\n", name, lineno); 352 exit(EXIT_FAILURE); 353 } 354 cmd_ver_first = 1; 355 set_hdr_func(imxhdr); 356 break; 357 case CMD_BOOT_FROM: 358 imxhdr->flash_offset = get_table_entry_id(imximage_bootops, 359 "imximage boot option", token); 360 if (imxhdr->flash_offset == -1) { 361 fprintf(stderr, "Error: %s[%d] -Invalid boot device" 362 "(%s)\n", name, lineno, token); 363 exit(EXIT_FAILURE); 364 } 365 if (unlikely(cmd_ver_first != 1)) 366 cmd_ver_first = 0; 367 break; 368 case CMD_DATA: 369 value = get_cfg_value(token, name, lineno); 370 (*set_dcd_val)(imxhdr, name, lineno, fld, value, dcd_len); 371 if (unlikely(cmd_ver_first != 1)) 372 cmd_ver_first = 0; 373 break; 374 } 375 } 376 377 static void parse_cfg_fld(struct imx_header *imxhdr, int32_t *cmd, 378 char *token, char *name, int lineno, int fld, int *dcd_len) 379 { 380 int value; 381 382 switch (fld) { 383 case CFG_COMMAND: 384 *cmd = get_table_entry_id(imximage_cmds, 385 "imximage commands", token); 386 if (*cmd < 0) { 387 fprintf(stderr, "Error: %s[%d] - Invalid command" 388 "(%s)\n", name, lineno, token); 389 exit(EXIT_FAILURE); 390 } 391 break; 392 case CFG_REG_SIZE: 393 parse_cfg_cmd(imxhdr, *cmd, token, name, lineno, fld, *dcd_len); 394 break; 395 case CFG_REG_ADDRESS: 396 case CFG_REG_VALUE: 397 if (*cmd != CMD_DATA) 398 return; 399 400 value = get_cfg_value(token, name, lineno); 401 (*set_dcd_val)(imxhdr, name, lineno, fld, value, *dcd_len); 402 403 if (fld == CFG_REG_VALUE) { 404 (*dcd_len)++; 405 if (*dcd_len > max_dcd_entries) { 406 fprintf(stderr, "Error: %s[%d] -" 407 "DCD table exceeds maximum size(%d)\n", 408 name, lineno, max_dcd_entries); 409 exit(EXIT_FAILURE); 410 } 411 } 412 break; 413 default: 414 break; 415 } 416 } 417 static uint32_t parse_cfg_file(struct imx_header *imxhdr, char *name) 418 { 419 FILE *fd = NULL; 420 char *line = NULL; 421 char *token, *saveptr1, *saveptr2; 422 int lineno = 0; 423 int fld; 424 size_t len; 425 int dcd_len = 0; 426 int32_t cmd; 427 428 fd = fopen(name, "r"); 429 if (fd == 0) { 430 fprintf(stderr, "Error: %s - Can't open DCD file\n", name); 431 exit(EXIT_FAILURE); 432 } 433 434 /* Very simple parsing, line starting with # are comments 435 * and are dropped 436 */ 437 while ((getline(&line, &len, fd)) > 0) { 438 lineno++; 439 440 token = strtok_r(line, "\r\n", &saveptr1); 441 if (token == NULL) 442 continue; 443 444 /* Check inside the single line */ 445 for (fld = CFG_COMMAND, cmd = CMD_INVALID, 446 line = token; ; line = NULL, fld++) { 447 token = strtok_r(line, " \t", &saveptr2); 448 if (token == NULL) 449 break; 450 451 /* Drop all text starting with '#' as comments */ 452 if (token[0] == '#') 453 break; 454 455 parse_cfg_fld(imxhdr, &cmd, token, name, 456 lineno, fld, &dcd_len); 457 } 458 459 } 460 461 (*set_dcd_rst)(imxhdr, dcd_len, name, lineno); 462 fclose(fd); 463 464 /* Exit if there is no BOOT_FROM field specifying the flash_offset */ 465 if (imxhdr->flash_offset == FLASH_OFFSET_UNDEFINED) { 466 fprintf(stderr, "Error: No BOOT_FROM tag in %s\n", name); 467 exit(EXIT_FAILURE); 468 } 469 return dcd_len; 470 } 471 472 473 static int imximage_check_image_types(uint8_t type) 474 { 475 if (type == IH_TYPE_IMXIMAGE) 476 return EXIT_SUCCESS; 477 else 478 return EXIT_FAILURE; 479 } 480 481 static int imximage_verify_header(unsigned char *ptr, int image_size, 482 struct mkimage_params *params) 483 { 484 struct imx_header *imx_hdr = (struct imx_header *) ptr; 485 486 if (detect_imximage_version(imx_hdr) == IMXIMAGE_VER_INVALID) 487 return -FDT_ERR_BADSTRUCTURE; 488 489 return 0; 490 } 491 492 static void imximage_print_header(const void *ptr) 493 { 494 struct imx_header *imx_hdr = (struct imx_header *) ptr; 495 uint32_t version = detect_imximage_version(imx_hdr); 496 497 switch (version) { 498 case IMXIMAGE_V1: 499 print_hdr_v1(imx_hdr); 500 break; 501 case IMXIMAGE_V2: 502 print_hdr_v2(imx_hdr); 503 break; 504 default: 505 err_imximage_version(version); 506 break; 507 } 508 } 509 510 static void imximage_set_header(void *ptr, struct stat *sbuf, int ifd, 511 struct mkimage_params *params) 512 { 513 struct imx_header *imxhdr = (struct imx_header *)ptr; 514 uint32_t dcd_len; 515 516 /* 517 * In order to not change the old imx cfg file 518 * by adding VERSION command into it, here need 519 * set up function ptr group to V1 by default. 520 */ 521 imximage_version = IMXIMAGE_V1; 522 /* Be able to detect if the cfg file has no BOOT_FROM tag */ 523 imxhdr->flash_offset = FLASH_OFFSET_UNDEFINED; 524 set_hdr_func(imxhdr); 525 526 /* Parse dcd configuration file */ 527 dcd_len = parse_cfg_file(imxhdr, params->imagename); 528 529 /* Set the imx header */ 530 (*set_imx_hdr)(imxhdr, dcd_len, sbuf, params); 531 } 532 533 int imximage_check_params(struct mkimage_params *params) 534 { 535 if (!params) 536 return CFG_INVALID; 537 if (!strlen(params->imagename)) { 538 fprintf(stderr, "Error: %s - Configuration file not specified, " 539 "it is needed for imximage generation\n", 540 params->cmdname); 541 return CFG_INVALID; 542 } 543 /* 544 * Check parameters: 545 * XIP is not allowed and verify that incompatible 546 * parameters are not sent at the same time 547 * For example, if list is required a data image must not be provided 548 */ 549 return (params->dflag && (params->fflag || params->lflag)) || 550 (params->fflag && (params->dflag || params->lflag)) || 551 (params->lflag && (params->dflag || params->fflag)) || 552 (params->xflag) || !(strlen(params->imagename)); 553 } 554 555 /* 556 * imximage parameters 557 */ 558 static struct image_type_params imximage_params = { 559 .name = "Freescale i.MX 5x Boot Image support", 560 .header_size = sizeof(struct imx_header), 561 .hdr = (void *)&imximage_header, 562 .check_image_type = imximage_check_image_types, 563 .verify_header = imximage_verify_header, 564 .print_header = imximage_print_header, 565 .set_header = imximage_set_header, 566 .check_params = imximage_check_params, 567 }; 568 569 void init_imx_image_type(void) 570 { 571 mkimage_register(&imximage_params); 572 } 573