tools/imximage.c

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