tools/firmware-utils/src/mktplinkfw.c

   1 /*
   2  * Copyright (C) 2009 Gabor Juhos <juhosg@openwrt.org>
   3  *
   4  * This tool was based on:
   5  *   TP-Link WR941 V2 firmware checksum fixing tool.
   6  *   Copyright (C) 2008,2009 Wang Jian <lark@linux.net.cn>
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License version 2 as published
  10  * by the Free Software Foundation.
  11  *
  12  */
  13
  14 #include <stdio.h>
  15 #include <stdlib.h>
  16 #include <stdint.h>
  17 #include <string.h>
  18 #include <unistd.h>     /* for unlink() */
  19 #include <libgen.h>
  20 #include <getopt.h>     /* for getopt() */
  21 #include <stdarg.h>
  22 #include <stdbool.h>
  23 #include <endian.h>
  24 #include <errno.h>
  25 #include <sys/stat.h>
  26
  27 #include <arpa/inet.h>
  28 #include <netinet/in.h>
  29
  30 #include "md5.h"
  31 #include "mktplinkfw-lib.h"
  32
  33 #define HEADER_VERSION_V1       0x01000000
  34 #define HEADER_VERSION_V2       0x02000000
  35
  36 struct fw_header {
  37         uint32_t        version;        /* header version */
  38         char            vendor_name[24];
  39         char            fw_version[36];
  40         uint32_t        hw_id;          /* hardware id */
  41         uint32_t        hw_rev;         /* hardware revision */
  42         uint32_t        region_code;    /* region code */
  43         uint8_t         md5sum1[MD5SUM_LEN];
  44         uint32_t        unk2;
  45         uint8_t         md5sum2[MD5SUM_LEN];
  46         uint32_t        unk3;
  47         uint32_t        kernel_la;      /* kernel load address */
  48         uint32_t        kernel_ep;      /* kernel entry point */
  49         uint32_t        fw_length;      /* total length of the firmware */
  50         uint32_t        kernel_ofs;     /* kernel data offset */
  51         uint32_t        kernel_len;     /* kernel data length */
  52         uint32_t        rootfs_ofs;     /* rootfs data offset */
  53         uint32_t        rootfs_len;     /* rootfs data length */
  54         uint32_t        boot_ofs;       /* bootloader data offset */
  55         uint32_t        boot_len;       /* bootloader data length */
  56         uint16_t        ver_hi;
  57         uint16_t        ver_mid;
  58         uint16_t        ver_lo;
  59         uint8_t         pad[130];
  60         char            region_str1[32];
  61         char            region_str2[32];
  62         uint8_t         pad2[160];
  63 } __attribute__ ((packed));
  64
  65 struct fw_region {
  66         char            name[4];
  67         uint32_t        code;
  68 };
  69
  70
  71 /*
  72  * Globals
  73  */
  74 char *ofname;
  75 char *progname;
  76 static char *vendor = "TP-LINK Technologies";
  77 static char *version = "ver. 1.0";
  78 static char *fw_ver = "0.0.0";
  79 static uint32_t hdr_ver = HEADER_VERSION_V1;
  80
  81 static char *layout_id;
  82 struct flash_layout *layout;
  83 static char *opt_hw_id;
  84 static uint32_t hw_id;
  85 static char *opt_hw_rev;
  86 static uint32_t hw_rev;
  87 static uint32_t opt_hdr_ver = 1;
  88 static char *country;
  89 static const struct fw_region *region;
  90 static int fw_ver_lo;
  91 static int fw_ver_mid;
  92 static int fw_ver_hi;
  93 struct file_info kernel_info;
  94 static uint32_t kernel_la = 0;
  95 static uint32_t kernel_ep = 0;
  96 uint32_t kernel_len = 0;
  97 struct file_info rootfs_info;
  98 uint32_t rootfs_ofs = 0;
  99 uint32_t rootfs_align;
 100 static struct file_info boot_info;
 101 int combined;
 102 int strip_padding;
 103 int add_jffs2_eof;
 104 static uint32_t fw_max_len;
 105 static uint32_t reserved_space;
 106
 107 static struct file_info inspect_info;
 108 static int extract = 0;
 109 static bool endian_swap = false;
 110
 111 static const char md5salt_normal[MD5SUM_LEN] = {
 112         0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
 113         0xdd, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x38,
 114 };
 115
 116 static const char md5salt_boot[MD5SUM_LEN] = {
 117         0x8c, 0xef, 0x33, 0x5b, 0xd5, 0xc5, 0xce, 0xfa,
 118         0xa7, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
 119 };
 120
 121 static struct flash_layout layouts[] = {
 122         {
 123                 .id             = "4M",
 124                 .fw_max_len     = 0x3c0000,
 125                 .kernel_la      = 0x80060000,
 126                 .kernel_ep      = 0x80060000,
 127                 .rootfs_ofs     = 0x140000,
 128         }, {
 129                 .id             = "4Mlzma",
 130                 .fw_max_len     = 0x3c0000,
 131                 .kernel_la      = 0x80060000,
 132                 .kernel_ep      = 0x80060000,
 133                 .rootfs_ofs     = 0x100000,
 134         }, {
 135                 .id             = "8M",
 136                 .fw_max_len     = 0x7c0000,
 137                 .kernel_la      = 0x80060000,
 138                 .kernel_ep      = 0x80060000,
 139                 .rootfs_ofs     = 0x140000,
 140         }, {
 141                 .id             = "8Mlzma",
 142                 .fw_max_len     = 0x7c0000,
 143                 .kernel_la      = 0x80060000,
 144                 .kernel_ep      = 0x80060000,
 145                 .rootfs_ofs     = 0x100000,
 146         }, {
 147                 .id             = "16M",
 148                 .fw_max_len     = 0xf80000,
 149                 .kernel_la      = 0x80060000,
 150                 .kernel_ep      = 0x80060000,
 151                 .rootfs_ofs     = 0x140000,
 152         }, {
 153                 .id             = "16Mlzma",
 154                 .fw_max_len     = 0xf80000,
 155                 .kernel_la      = 0x80060000,
 156                 .kernel_ep      = 0x80060000,
 157                 .rootfs_ofs     = 0x100000,
 158         }, {
 159                 .id             = "16Mppc",
 160                 .fw_max_len     = 0xf80000,
 161                 .kernel_la      = 0x00000000 ,
 162                 .kernel_ep      = 0xc0000000,
 163                 .rootfs_ofs     = 0x2a0000,
 164         }, {
 165                 /* terminating entry */
 166         }
 167 };
 168
 169 static const struct fw_region regions[] = {
 170         /* Default region (universal) uses code 0 as well */
 171         {"US", 1},
 172         {"EU", 0},
 173 };
 174
 175 static const struct fw_region * find_region(const char *country) {
 176         size_t i;
 177
 178         for (i = 0; i < ARRAY_SIZE(regions); i++) {
 179                 if (strcasecmp(regions[i].name, country) == 0)
 180                         return &regions[i];
 181         }
 182
 183         return NULL;
 184 }
 185
 186 static void usage(int status)
 187 {
 188         fprintf(stderr, "Usage: %s [OPTIONS...]\n", progname);
 189         fprintf(stderr,
 190 "\n"
 191 "Options:\n"
 192 "  -c              use combined kernel image\n"
 193 "  -e              swap endianness in kernel load address and entry point\n"
 194 "  -E <ep>         overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
 195 "  -L <la>         overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
 196 "  -H <hwid>       use hardware id specified with <hwid>\n"
 197 "  -W <hwrev>      use hardware revision specified with <hwrev>\n"
 198 "  -C <country>    set region code to <country>\n"
 199 "  -F <id>         use flash layout specified with <id>\n"
 200 "  -k <file>       read kernel image from the file <file>\n"
 201 "  -r <file>       read rootfs image from the file <file>\n"
 202 "  -a <align>      align the rootfs start on an <align> bytes boundary\n"
 203 "  -R <offset>     overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
 204 "  -o <file>       write output to the file <file>\n"
 205 "  -s              strip padding from the end of the image\n"
 206 "  -j              add jffs2 end-of-filesystem markers\n"
 207 "  -N <vendor>     set image vendor to <vendor>\n"
 208 "  -V <version>    set image version to <version>\n"
 209 "  -v <version>    set firmware version to <version>\n"
 210 "  -m <version>    set header version to <version>\n"
 211 "  -i <file>       inspect given firmware file <file>\n"
 212 "  -x              extract kernel and rootfs while inspecting (requires -i)\n"
 213 "  -X <size>       reserve <size> bytes in the firmware image (hexval prefixed with 0x)\n"
 214 "  -h              show this screen\n"
 215         );
 216
 217         exit(status);
 218 }
 219
 220 static int check_options(void)
 221 {
 222         int ret;
 223         int exceed_bytes;
 224
 225         if (inspect_info.file_name) {
 226                 ret = get_file_stat(&inspect_info);
 227                 if (ret)
 228                         return ret;
 229
 230                 return 0;
 231         } else if (extract) {
 232                 ERR("no firmware for inspection specified");
 233                 return -1;
 234         }
 235
 236         if (opt_hw_id == NULL) {
 237                 ERR("hardware id not specified");
 238                 return -1;
 239         }
 240         hw_id = strtoul(opt_hw_id, NULL, 0);
 241
 242         if (!combined && layout_id == NULL) {
 243                 ERR("flash layout is not specified");
 244                 return -1;
 245         }
 246
 247         if (opt_hw_rev)
 248                 hw_rev = strtoul(opt_hw_rev, NULL, 0);
 249         else
 250                 hw_rev = 1;
 251
 252         if (country) {
 253                 region = find_region(country);
 254                 if (!region) {
 255                         ERR("unknown region code \"%s\"", country);
 256                         return -1;
 257                 }
 258         }
 259
 260         if (combined) {
 261                 if (!kernel_la || !kernel_ep) {
 262                         ERR("kernel loading address and entry point must be specified for combined image");
 263                         return -1;
 264                 }
 265         } else {
 266                 layout = find_layout(layouts, layout_id);
 267                 if (layout == NULL) {
 268                         ERR("unknown flash layout \"%s\"", layout_id);
 269                         return -1;
 270                 }
 271
 272                 if (!kernel_la)
 273                         kernel_la = layout->kernel_la;
 274                 if (!kernel_ep)
 275                         kernel_ep = layout->kernel_ep;
 276                 if (!rootfs_ofs)
 277                         rootfs_ofs = layout->rootfs_ofs;
 278
 279                 if (reserved_space > layout->fw_max_len) {
 280                         ERR("reserved space is not valid");
 281                         return -1;
 282                 }
 283         }
 284
 285         if (kernel_info.file_name == NULL) {
 286                 ERR("no kernel image specified");
 287                 return -1;
 288         }
 289
 290         ret = get_file_stat(&kernel_info);
 291         if (ret)
 292                 return ret;
 293
 294         kernel_len = kernel_info.file_size;
 295
 296         if (!combined) {
 297                 fw_max_len = layout->fw_max_len - reserved_space;
 298
 299                 if (rootfs_info.file_name == NULL) {
 300                         ERR("no rootfs image specified");
 301                         return -1;
 302                 }
 303
 304                 ret = get_file_stat(&rootfs_info);
 305                 if (ret)
 306                         return ret;
 307
 308                 if (rootfs_align) {
 309                         kernel_len += sizeof(struct fw_header);
 310                         rootfs_ofs = ALIGN(kernel_len, rootfs_align);
 311                         kernel_len -= sizeof(struct fw_header);
 312
 313                         DBG("rootfs offset aligned to 0x%u", rootfs_ofs);
 314
 315                         exceed_bytes = kernel_len + rootfs_info.file_size - (fw_max_len - sizeof(struct fw_header));
 316                         if (exceed_bytes > 0) {
 317                                 ERR("images are too big by %i bytes", exceed_bytes);
 318                                 return -1;
 319                         }
 320                 } else {
 321                         exceed_bytes = kernel_info.file_size - (rootfs_ofs - sizeof(struct fw_header));
 322                         if (exceed_bytes > 0) {
 323                                 ERR("kernel image is too big by %i bytes", exceed_bytes);
 324                                 return -1;
 325                         }
 326
 327                         exceed_bytes = rootfs_info.file_size - (fw_max_len - rootfs_ofs);
 328                         if (exceed_bytes > 0) {
 329                                 ERR("rootfs image is too big by %i bytes", exceed_bytes);
 330                                 return -1;
 331                         }
 332                 }
 333         }
 334
 335         if (ofname == NULL) {
 336                 ERR("no output file specified");
 337                 return -1;
 338         }
 339
 340         ret = sscanf(fw_ver, "%d.%d.%d", &fw_ver_hi, &fw_ver_mid, &fw_ver_lo);
 341         if (ret != 3) {
 342                 ERR("invalid firmware version '%s'", fw_ver);
 343                 return -1;
 344         }
 345
 346         if (opt_hdr_ver == 1) {
 347                 hdr_ver = HEADER_VERSION_V1;
 348         } else if (opt_hdr_ver == 2) {
 349                 hdr_ver = HEADER_VERSION_V2;
 350         } else {
 351                 ERR("invalid header version '%u'", opt_hdr_ver);
 352                 return -1;
 353         }
 354
 355         return 0;
 356 }
 357
 358 void fill_header(char *buf, int len)
 359 {
 360         struct fw_header *hdr = (struct fw_header *)buf;
 361
 362         memset(hdr, 0, sizeof(struct fw_header));
 363
 364         hdr->version = htonl(hdr_ver);
 365         strncpy(hdr->vendor_name, vendor, sizeof(hdr->vendor_name));
 366         strncpy(hdr->fw_version, version, sizeof(hdr->fw_version));
 367         hdr->hw_id = htonl(hw_id);
 368         hdr->hw_rev = htonl(hw_rev);
 369
 370         hdr->kernel_la = htonl(kernel_la);
 371         hdr->kernel_ep = htonl(kernel_ep);
 372         hdr->kernel_ofs = htonl(sizeof(struct fw_header));
 373         hdr->kernel_len = htonl(kernel_len);
 374
 375         if (!combined) {
 376                 if (boot_info.file_size == 0)
 377                         memcpy(hdr->md5sum1, md5salt_normal, sizeof(hdr->md5sum1));
 378                 else
 379                         memcpy(hdr->md5sum1, md5salt_boot, sizeof(hdr->md5sum1));
 380
 381                 hdr->fw_length = htonl(layout->fw_max_len);
 382                 hdr->rootfs_ofs = htonl(rootfs_ofs);
 383                 hdr->rootfs_len = htonl(rootfs_info.file_size);
 384         }
 385
 386         hdr->ver_hi = htons(fw_ver_hi);
 387         hdr->ver_mid = htons(fw_ver_mid);
 388         hdr->ver_lo = htons(fw_ver_lo);
 389
 390         if (region) {
 391                 hdr->region_code = htonl(region->code);
 392                 snprintf(
 393                         hdr->region_str1, sizeof(hdr->region_str1), "00000000;%02X%02X%02X%02X;",
 394                         region->name[0], region->name[1], region->name[2], region->name[3]
 395                 );
 396                 snprintf(
 397                         hdr->region_str2, sizeof(hdr->region_str2), "%02X%02X%02X%02X",
 398                         region->name[0], region->name[1], region->name[2], region->name[3]
 399                 );
 400         }
 401
 402         if (endian_swap) {
 403                 hdr->kernel_la = bswap_32(hdr->kernel_la);
 404                 hdr->kernel_ep = bswap_32(hdr->kernel_ep);
 405         }
 406
 407         if (!combined)
 408                 get_md5(buf, len, hdr->md5sum1);
 409 }
 410
 411 static int inspect_fw(void)
 412 {
 413         char *buf;
 414         struct fw_header *hdr;
 415         uint8_t md5sum[MD5SUM_LEN];
 416         int ret = EXIT_FAILURE;
 417
 418         buf = malloc(inspect_info.file_size);
 419         if (!buf) {
 420                 ERR("no memory for buffer!\n");
 421                 goto out;
 422         }
 423
 424         ret = read_to_buf(&inspect_info, buf);
 425         if (ret)
 426                 goto out_free_buf;
 427         hdr = (struct fw_header *)buf;
 428
 429         inspect_fw_pstr("File name", inspect_info.file_name);
 430         inspect_fw_phexdec("File size", inspect_info.file_size);
 431
 432         if ((ntohl(hdr->version) != HEADER_VERSION_V1) &&
 433             (ntohl(hdr->version) != HEADER_VERSION_V2)) {
 434                 ERR("file does not seem to have V1/V2 header!\n");
 435                 goto out_free_buf;
 436         }
 437
 438         inspect_fw_phexdec("Version 1 Header size", sizeof(struct fw_header));
 439
 440         memcpy(md5sum, hdr->md5sum1, sizeof(md5sum));
 441         if (ntohl(hdr->boot_len) == 0)
 442                 memcpy(hdr->md5sum1, md5salt_normal, sizeof(md5sum));
 443         else
 444                 memcpy(hdr->md5sum1, md5salt_boot, sizeof(md5sum));
 445         get_md5(buf, inspect_info.file_size, hdr->md5sum1);
 446
 447         if (memcmp(md5sum, hdr->md5sum1, sizeof(md5sum))) {
 448                 inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(*ERROR*)");
 449                 inspect_fw_pmd5sum("          --> expected", hdr->md5sum1, "");
 450         } else {
 451                 inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(ok)");
 452         }
 453         if (ntohl(hdr->unk2) != 0)
 454                 inspect_fw_phexdec("Unknown value 2", hdr->unk2);
 455         inspect_fw_pmd5sum("Header MD5Sum2", hdr->md5sum2,
 456                            "(purpose yet unknown, unchecked here)");
 457         if (ntohl(hdr->unk3) != 0)
 458                 inspect_fw_phexdec("Unknown value 3", hdr->unk3);
 459
 460         printf("\n");
 461
 462         inspect_fw_pstr("Vendor name", hdr->vendor_name);
 463         inspect_fw_pstr("Firmware version", hdr->fw_version);
 464         inspect_fw_phex("Hardware ID", ntohl(hdr->hw_id));
 465         inspect_fw_phex("Hardware Revision", ntohl(hdr->hw_rev));
 466         inspect_fw_phex("Region code", ntohl(hdr->region_code));
 467
 468         printf("\n");
 469
 470         inspect_fw_phexdec("Kernel data offset",
 471                            ntohl(hdr->kernel_ofs));
 472         inspect_fw_phexdec("Kernel data length",
 473                            ntohl(hdr->kernel_len));
 474         inspect_fw_phex("Kernel load address",
 475                         ntohl(hdr->kernel_la));
 476         inspect_fw_phex("Kernel entry point",
 477                         ntohl(hdr->kernel_ep));
 478         inspect_fw_phexdec("Rootfs data offset",
 479                            ntohl(hdr->rootfs_ofs));
 480         inspect_fw_phexdec("Rootfs data length",
 481                            ntohl(hdr->rootfs_len));
 482         inspect_fw_phexdec("Boot loader data offset",
 483                            ntohl(hdr->boot_ofs));
 484         inspect_fw_phexdec("Boot loader data length",
 485                            ntohl(hdr->boot_len));
 486         inspect_fw_phexdec("Total firmware length",
 487                            ntohl(hdr->fw_length));
 488
 489         if (extract) {
 490                 FILE *fp;
 491                 char *filename;
 492
 493                 printf("\n");
 494
 495                 filename = malloc(strlen(inspect_info.file_name) + 8);
 496                 sprintf(filename, "%s-kernel", inspect_info.file_name);
 497                 printf("Extracting kernel to \"%s\"...\n", filename);
 498                 fp = fopen(filename, "w");
 499                 if (fp) {
 500                         if (!fwrite(buf + ntohl(hdr->kernel_ofs),
 501                                     ntohl(hdr->kernel_len), 1, fp)) {
 502                                 ERR("error in fwrite(): %s", strerror(errno));
 503                         }
 504                         fclose(fp);
 505                 } else {
 506                         ERR("error in fopen(): %s", strerror(errno));
 507                 }
 508                 free(filename);
 509
 510                 filename = malloc(strlen(inspect_info.file_name) + 8);
 511                 sprintf(filename, "%s-rootfs", inspect_info.file_name);
 512                 printf("Extracting rootfs to \"%s\"...\n", filename);
 513                 fp = fopen(filename, "w");
 514                 if (fp) {
 515                         if (!fwrite(buf + ntohl(hdr->rootfs_ofs),
 516                                     ntohl(hdr->rootfs_len), 1, fp)) {
 517                                 ERR("error in fwrite(): %s", strerror(errno));
 518                         }
 519                         fclose(fp);
 520                 } else {
 521                         ERR("error in fopen(): %s", strerror(errno));
 522                 }
 523                 free(filename);
 524         }
 525
 526  out_free_buf:
 527         free(buf);
 528  out:
 529         return ret;
 530 }
 531
 532 int main(int argc, char *argv[])
 533 {
 534         int ret = EXIT_FAILURE;
 535
 536         progname = basename(argv[0]);
 537
 538         while ( 1 ) {
 539                 int c;
 540
 541                 c = getopt(argc, argv, "a:H:E:F:L:m:V:N:W:C:ci:k:r:R:o:xX:ehsjv:");
 542                 if (c == -1)
 543                         break;
 544
 545                 switch (c) {
 546                 case 'a':
 547                         sscanf(optarg, "0x%x", &rootfs_align);
 548                         break;
 549                 case 'H':
 550                         opt_hw_id = optarg;
 551                         break;
 552                 case 'E':
 553                         sscanf(optarg, "0x%x", &kernel_ep);
 554                         break;
 555                 case 'F':
 556                         layout_id = optarg;
 557                         break;
 558                 case 'W':
 559                         opt_hw_rev = optarg;
 560                         break;
 561                 case 'C':
 562                         country = optarg;
 563                         break;
 564                 case 'L':
 565                         sscanf(optarg, "0x%x", &kernel_la);
 566                         break;
 567                 case 'm':
 568                         sscanf(optarg, "%u", &opt_hdr_ver);
 569                         break;
 570                 case 'V':
 571                         version = optarg;
 572                         break;
 573                 case 'v':
 574                         fw_ver = optarg;
 575                         break;
 576                 case 'N':
 577                         vendor = optarg;
 578                         break;
 579                 case 'c':
 580                         combined++;
 581                         break;
 582                 case 'k':
 583                         kernel_info.file_name = optarg;
 584                         break;
 585                 case 'r':
 586                         rootfs_info.file_name = optarg;
 587                         break;
 588                 case 'R':
 589                         sscanf(optarg, "0x%x", &rootfs_ofs);
 590                         break;
 591                 case 'o':
 592                         ofname = optarg;
 593                         break;
 594                 case 's':
 595                         strip_padding = 1;
 596                         break;
 597                 case 'i':
 598                         inspect_info.file_name = optarg;
 599                         break;
 600                 case 'j':
 601                         add_jffs2_eof = 1;
 602                         break;
 603                 case 'x':
 604                         extract = 1;
 605                         break;
 606                 case 'e':
 607                         endian_swap = true;
 608                         break;
 609                 case 'h':
 610                         usage(EXIT_SUCCESS);
 611                         break;
 612                 case 'X':
 613                         sscanf(optarg, "0x%x", &reserved_space);
 614                         break;
 615                 default:
 616                         usage(EXIT_FAILURE);
 617                         break;
 618                 }
 619         }
 620
 621         ret = check_options();
 622         if (ret)
 623                 goto out;
 624
 625         if (!inspect_info.file_name)
 626                 ret = build_fw(sizeof(struct fw_header));
 627         else
 628                 ret = inspect_fw();
 629
 630  out:
 631         return ret;
 632 }