tools/firmware-utils/src/mktplinkfw2.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 <errno.h>
  23 #include <stdbool.h>
  24 #include <endian.h>
  25 #include <sys/stat.h>
  26
  27 #include <arpa/inet.h>
  28 #include <netinet/in.h>
  29
  30 #include "md5.h"
  31
  32 #define ALIGN(x,a) ({ typeof(a) __a = (a); (((x) + __a - 1) & ~(__a - 1)); })
  33
  34 #define MD5SUM_LEN      16
  35
  36 struct file_info {
  37         char            *file_name;     /* name of the file */
  38         uint32_t        file_size;      /* length of the file */
  39 };
  40
  41 struct fw_header {
  42         uint32_t        version;                        /* 0x00: header version */
  43         char            fw_version[48];                 /* 0x04: fw version string */
  44         uint32_t        hw_id;                          /* 0x34: hardware id */
  45         uint32_t        hw_rev;                         /* 0x38: FIXME: hardware revision? */
  46         uint32_t        hw_ver_add;                     /* 0x3c: additional hardware version */
  47         uint8_t         md5sum1[MD5SUM_LEN];            /* 0x40 */
  48         uint32_t        unk2;                           /* 0x50: 0x00000000 */
  49         uint8_t         md5sum2[MD5SUM_LEN];            /* 0x54 */
  50         uint32_t        unk3;                           /* 0x64: 0xffffffff */
  51
  52         uint32_t        kernel_la;                      /* 0x68: kernel load address */
  53         uint32_t        kernel_ep;                      /* 0x6c: kernel entry point */
  54         uint32_t        fw_length;                      /* 0x70: total length of the image */
  55         uint32_t        kernel_ofs;                     /* 0x74: kernel data offset */
  56         uint32_t        kernel_len;                     /* 0x78: kernel data length */
  57         uint32_t        rootfs_ofs;                     /* 0x7c: rootfs data offset */
  58         uint32_t        rootfs_len;                     /* 0x80: rootfs data length */
  59         uint32_t        boot_ofs;                       /* 0x84: bootloader offset */
  60         uint32_t        boot_len;                       /* 0x88: bootloader length */
  61         uint16_t        unk4;                           /* 0x8c: 0x55aa */
  62         uint8_t         sver_hi;                        /* 0x8e */
  63         uint8_t         sver_lo;                        /* 0x8f */
  64         uint8_t         unk5;                           /* 0x90: magic: 0xa5 */
  65         uint8_t         ver_hi;                         /* 0x91 */
  66         uint8_t         ver_mid;                        /* 0x92 */
  67         uint8_t         ver_lo;                         /* 0x93 */
  68         uint8_t         pad[364];
  69 } __attribute__ ((packed));
  70
  71 struct flash_layout {
  72         char            *id;
  73         uint32_t        fw_max_len;
  74         uint32_t        kernel_la;
  75         uint32_t        kernel_ep;
  76         uint32_t        rootfs_ofs;
  77 };
  78
  79 #define FLAG_LE_KERNEL_LA_EP                    0x00000001      /* Little-endian used for kernel load address & entry point */
  80
  81 struct board_info {
  82         char            *id;
  83         uint32_t        hw_id;
  84         uint32_t        hw_rev;
  85         uint32_t        hw_ver_add;
  86         char            *layout_id;
  87         uint32_t        hdr_ver;
  88         uint32_t        flags;
  89 };
  90
  91 /*
  92  * Globals
  93  */
  94 static char *ofname;
  95 static char *progname;
  96 static char *vendor = "TP-LINK Technologies";
  97 static char *version = "ver. 1.0";
  98 static char *fw_ver = "0.0.0";
  99 static char *sver = "1.0";
 100 static uint32_t hdr_ver = 2;
 101
 102 static struct board_info custom_board;
 103
 104 static char *board_id;
 105 static struct board_info *board;
 106 static char *layout_id;
 107 static struct flash_layout *layout;
 108 static char *opt_hw_id;
 109 static char *opt_hw_rev;
 110 static char *opt_hw_ver_add;
 111 static int fw_ver_lo;
 112 static int fw_ver_mid;
 113 static int fw_ver_hi;
 114 static int sver_lo;
 115 static int sver_hi;
 116 static struct file_info kernel_info;
 117 static uint32_t kernel_la = 0;
 118 static uint32_t kernel_ep = 0;
 119 static uint32_t kernel_len = 0;
 120 static struct file_info rootfs_info;
 121 static uint32_t rootfs_ofs = 0;
 122 static uint32_t rootfs_align;
 123 static struct file_info boot_info;
 124 static int combined;
 125 static int strip_padding;
 126 static int add_jffs2_eof;
 127 static unsigned char jffs2_eof_mark[4] = {0xde, 0xad, 0xc0, 0xde};
 128
 129 static struct file_info inspect_info;
 130 static int extract = 0;
 131
 132 char md5salt_normal[MD5SUM_LEN] = {
 133         0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
 134         0xdc, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x37,
 135 };
 136
 137 char md5salt_boot[MD5SUM_LEN] = {
 138         0x8c, 0xef, 0x33, 0x5f, 0xd5, 0xc5, 0xce, 0xfa,
 139         0xac, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
 140 };
 141
 142 static struct flash_layout layouts[] = {
 143         {
 144                 .id             = "8Mltq",
 145                 .fw_max_len     = 0x7a0000,
 146                 .kernel_la      = 0x80002000,
 147                 .kernel_ep      = 0x80002000,
 148                 .rootfs_ofs     = 0x140000,
 149         }, {
 150                 .id             = "16Mltq",
 151                 .fw_max_len     = 0xf90000,
 152                 .kernel_la      = 0x80002000,
 153                 .kernel_ep      = 0x800061b0,
 154                 .rootfs_ofs     = 0x140000,
 155         }, {
 156                 .id             = "8Mmtk",
 157                 .fw_max_len     = 0x7a0000,
 158                 .kernel_la      = 0x80000000,
 159                 .kernel_ep      = 0x80000000,
 160                 .rootfs_ofs     = 0x140000,
 161         }, {
 162                 .id             = "8MLmtk",
 163                 .fw_max_len     = 0x7b0000,
 164                 .kernel_la      = 0x80000000,
 165                 .kernel_ep      = 0x80000000,
 166                 .rootfs_ofs     = 0x140000,
 167         }, {
 168                 /* terminating entry */
 169         }
 170 };
 171
 172 static struct board_info boards[] = {
 173         {
 174                 .id             = "TD-W8970v1",
 175                 .hw_id          = 0x89700001,
 176                 .hw_rev         = 1,
 177                 .layout_id      = "8Mltq",
 178         }, {
 179                 .id             = "TD-W8980v1",
 180                 .hw_id          = 0x89800001,
 181                 .hw_rev         = 14,
 182                 .layout_id      = "8Mltq",
 183         }, {
 184                 .id             = "ArcherC20i",
 185                 .hw_id          = 0xc2000001,
 186                 .hw_rev         = 58,
 187                 .layout_id      = "8Mmtk",
 188                 .hdr_ver        = 3,
 189                 .flags          = FLAG_LE_KERNEL_LA_EP,
 190         }, {
 191                 .id             = "ArcherVR200V",
 192                 .hw_id          = 0x73b70801,
 193                 .hw_rev         = 0x2f,
 194                 .layout_id      = "16Mltq",
 195                 .hdr_ver        = 2,
 196         }, {
 197                 .id             = "ArcherC50",
 198                 .hw_id          = 0xc7500001,
 199                 .hw_rev         = 69,
 200                 .layout_id      = "8Mmtk",
 201                 .hdr_ver        = 3,
 202                 .flags          = FLAG_LE_KERNEL_LA_EP,
 203         }, {
 204                 .id             = "ArcherMR200",
 205                 .hw_id          = 0xd7500001,
 206                 .hw_rev         = 0x4a,
 207                 .layout_id      = "8MLmtk",
 208                 .hdr_ver        = 3,
 209                 .flags          = FLAG_LE_KERNEL_LA_EP,
 210         }, {
 211                 .id             = "TL-WR840NV4",
 212                 .hw_id          = 0x08400004,
 213                 .hw_rev         = 0x1,
 214                 .hw_ver_add     = 0x4,
 215                 .layout_id      = "8Mmtk",
 216                 .hdr_ver        = 3,
 217                 .flags          = FLAG_LE_KERNEL_LA_EP,
 218         }, {
 219                 .id             = "TL-WR841NV13",
 220                 .hw_id          = 0x08410013,
 221                 .hw_rev         = 0x268,
 222                 .hw_ver_add     = 0x13,
 223                 .layout_id      = "8Mmtk",
 224                 .hdr_ver        = 3,
 225                 .flags          = FLAG_LE_KERNEL_LA_EP,
 226         }, {
 227                 /* terminating entry */
 228         }
 229 };
 230
 231 /*
 232  * Message macros
 233  */
 234 #define ERR(fmt, ...) do { \
 235         fflush(0); \
 236         fprintf(stderr, "[%s] *** error: " fmt "\n", \
 237                         progname, ## __VA_ARGS__ ); \
 238 } while (0)
 239
 240 #define ERRS(fmt, ...) do { \
 241         int save = errno; \
 242         fflush(0); \
 243         fprintf(stderr, "[%s] *** error: " fmt ": %s\n", \
 244                         progname, ## __VA_ARGS__, strerror(save)); \
 245 } while (0)
 246
 247 #define DBG(fmt, ...) do { \
 248         fprintf(stderr, "[%s] " fmt "\n", progname, ## __VA_ARGS__ ); \
 249 } while (0)
 250
 251 static struct board_info *find_board(char *id)
 252 {
 253         struct board_info *ret;
 254         struct board_info *board;
 255
 256         ret = NULL;
 257         for (board = boards; board->id != NULL; board++){
 258                 if (strcasecmp(id, board->id) == 0) {
 259                         ret = board;
 260                         break;
 261                 }
 262         };
 263
 264         return ret;
 265 }
 266
 267 static struct board_info *find_board_by_hwid(uint32_t hw_id)
 268 {
 269         struct board_info *board;
 270
 271         for (board = boards; board->id != NULL; board++) {
 272                 if (hw_id == board->hw_id)
 273                         return board;
 274         };
 275
 276         return NULL;
 277 }
 278
 279 static struct flash_layout *find_layout(char *id)
 280 {
 281         struct flash_layout *ret;
 282         struct flash_layout *l;
 283
 284         ret = NULL;
 285         for (l = layouts; l->id != NULL; l++){
 286                 if (strcasecmp(id, l->id) == 0) {
 287                         ret = l;
 288                         break;
 289                 }
 290         };
 291
 292         return ret;
 293 }
 294
 295 static void usage(int status)
 296 {
 297         FILE *stream = (status != EXIT_SUCCESS) ? stderr : stdout;
 298         struct board_info *board;
 299
 300         fprintf(stream, "Usage: %s [OPTIONS...]\n", progname);
 301         fprintf(stream,
 302 "\n"
 303 "Options:\n"
 304 "  -B <board>      create image for the board specified with <board>\n"
 305 "  -c              use combined kernel image\n"
 306 "  -e              swap endianness in kernel load address and entry point\n"
 307 "  -E <ep>         overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
 308 "  -L <la>         overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
 309 "  -H <hwid>       use hardware id specified with <hwid>\n"
 310 "  -W <hwrev>      use hardware revision specified with <hwrev>\n"
 311 "  -w <hwveradd>   use additional hardware version specified with <hwveradd>\n"
 312 "  -F <id>         use flash layout specified with <id>\n"
 313 "  -k <file>       read kernel image from the file <file>\n"
 314 "  -r <file>       read rootfs image from the file <file>\n"
 315 "  -a <align>      align the rootfs start on an <align> bytes boundary\n"
 316 "  -R <offset>     overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
 317 "  -o <file>       write output to the file <file>\n"
 318 "  -s              strip padding from the end of the image\n"
 319 "  -j              add jffs2 end-of-filesystem markers\n"
 320 "  -N <vendor>     set image vendor to <vendor>\n"
 321 "  -T <version>    set header version to <version>\n"
 322 "  -V <version>    set image version to <version>\n"
 323 "  -v <version>    set firmware version to <version>\n"
 324 "  -y <version>    set secondary version to <version>\n"
 325 "  -i <file>       inspect given firmware file <file>\n"
 326 "  -x              extract kernel and rootfs while inspecting (requires -i)\n"
 327 "  -h              show this screen\n"
 328         );
 329
 330         exit(status);
 331 }
 332
 333 static int get_md5(char *data, int size, char *md5)
 334 {
 335         MD5_CTX ctx;
 336
 337         MD5_Init(&ctx);
 338         MD5_Update(&ctx, data, size);
 339         MD5_Final(md5, &ctx);
 340 }
 341
 342 static int get_file_stat(struct file_info *fdata)
 343 {
 344         struct stat st;
 345         int res;
 346
 347         if (fdata->file_name == NULL)
 348                 return 0;
 349
 350         res = stat(fdata->file_name, &st);
 351         if (res){
 352                 ERRS("stat failed on %s", fdata->file_name);
 353                 return res;
 354         }
 355
 356         fdata->file_size = st.st_size;
 357         return 0;
 358 }
 359
 360 static int read_to_buf(struct file_info *fdata, char *buf)
 361 {
 362         FILE *f;
 363         int ret = EXIT_FAILURE;
 364
 365         f = fopen(fdata->file_name, "r");
 366         if (f == NULL) {
 367                 ERRS("could not open \"%s\" for reading", fdata->file_name);
 368                 goto out;
 369         }
 370
 371         errno = 0;
 372         fread(buf, fdata->file_size, 1, f);
 373         if (errno != 0) {
 374                 ERRS("unable to read from file \"%s\"", fdata->file_name);
 375                 goto out_close;
 376         }
 377
 378         ret = EXIT_SUCCESS;
 379
 380  out_close:
 381         fclose(f);
 382  out:
 383         return ret;
 384 }
 385
 386 static int check_options(void)
 387 {
 388         int ret;
 389
 390         if (inspect_info.file_name) {
 391                 ret = get_file_stat(&inspect_info);
 392                 if (ret)
 393                         return ret;
 394
 395                 return 0;
 396         } else if (extract) {
 397                 ERR("no firmware for inspection specified");
 398                 return -1;
 399         }
 400
 401         if (board_id == NULL && opt_hw_id == NULL) {
 402                 ERR("either board or hardware id must be specified");
 403                 return -1;
 404         }
 405
 406         if (board_id) {
 407                 board = find_board(board_id);
 408                 if (board == NULL) {
 409                         ERR("unknown/unsupported board id \"%s\"", board_id);
 410                         return -1;
 411                 }
 412                 if (layout_id == NULL)
 413                         layout_id = board->layout_id;
 414
 415                 if (board->hdr_ver)
 416                         hdr_ver = board->hdr_ver;
 417         } else {
 418                 board = &custom_board;
 419
 420                 if (layout_id == NULL) {
 421                         ERR("flash layout is not specified");
 422                         return -1;
 423                 }
 424
 425                 board->hw_id = strtoul(opt_hw_id, NULL, 0);
 426
 427                 board->hw_rev = 1;
 428                 board->hw_ver_add = 0;
 429         }
 430
 431         if (opt_hw_rev)
 432                 board->hw_rev = strtoul(opt_hw_rev, NULL, 0);
 433         if (opt_hw_ver_add)
 434                 board->hw_ver_add = strtoul(opt_hw_ver_add, NULL, 0);
 435
 436         layout = find_layout(layout_id);
 437         if (layout == NULL) {
 438                 ERR("unknown flash layout \"%s\"", layout_id);
 439                 return -1;
 440         }
 441
 442         if (!kernel_la)
 443                 kernel_la = layout->kernel_la;
 444         if (!kernel_ep)
 445                 kernel_ep = layout->kernel_ep;
 446         if (!rootfs_ofs)
 447                 rootfs_ofs = layout->rootfs_ofs;
 448
 449         if (kernel_info.file_name == NULL) {
 450                 ERR("no kernel image specified");
 451                 return -1;
 452         }
 453
 454         ret = get_file_stat(&kernel_info);
 455         if (ret)
 456                 return ret;
 457
 458         kernel_len = kernel_info.file_size;
 459
 460         if (combined) {
 461                 if (kernel_info.file_size >
 462                     layout->fw_max_len - sizeof(struct fw_header)) {
 463                         ERR("kernel image is too big");
 464                         return -1;
 465                 }
 466         } else {
 467                 if (rootfs_info.file_name == NULL) {
 468                         ERR("no rootfs image specified");
 469                         return -1;
 470                 }
 471
 472                 ret = get_file_stat(&rootfs_info);
 473                 if (ret)
 474                         return ret;
 475
 476                 if (rootfs_align) {
 477                         kernel_len += sizeof(struct fw_header);
 478                         kernel_len = ALIGN(kernel_len, rootfs_align);
 479                         kernel_len -= sizeof(struct fw_header);
 480
 481                         DBG("kernel length aligned to %u", kernel_len);
 482
 483                         if (kernel_len + rootfs_info.file_size >
 484                             layout->fw_max_len - sizeof(struct fw_header)) {
 485                                 ERR("images are too big");
 486                                 return -1;
 487                         }
 488                 } else {
 489                         if (kernel_info.file_size >
 490                             rootfs_ofs - sizeof(struct fw_header)) {
 491                                 ERR("kernel image is too big");
 492                                 return -1;
 493                         }
 494
 495                         if (rootfs_info.file_size >
 496                             (layout->fw_max_len - rootfs_ofs)) {
 497                                 ERR("rootfs image is too big");
 498                                 return -1;
 499                         }
 500                 }
 501         }
 502
 503         if (ofname == NULL) {
 504                 ERR("no output file specified");
 505                 return -1;
 506         }
 507
 508         ret = sscanf(fw_ver, "%d.%d.%d", &fw_ver_hi, &fw_ver_mid, &fw_ver_lo);
 509         if (ret != 3) {
 510                 ERR("invalid firmware version '%s'", fw_ver);
 511                 return -1;
 512         }
 513
 514         ret = sscanf(sver, "%d.%d", &sver_hi, &sver_lo);
 515         if (ret != 2) {
 516                 ERR("invalid secondary version '%s'", sver);
 517                 return -1;
 518         }
 519
 520         return 0;
 521 }
 522
 523 static void fill_header(char *buf, int len)
 524 {
 525         struct fw_header *hdr = (struct fw_header *)buf;
 526         unsigned ver_len;
 527
 528         memset(hdr, '\xff', sizeof(struct fw_header));
 529
 530         hdr->version = htonl(bswap_32(hdr_ver));
 531         ver_len = strlen(version);
 532         if (ver_len > (sizeof(hdr->fw_version) - 1))
 533                 ver_len = sizeof(hdr->fw_version) - 1;
 534
 535         memcpy(hdr->fw_version, version, ver_len);
 536         hdr->fw_version[ver_len] = 0;
 537
 538         hdr->hw_id = htonl(board->hw_id);
 539         hdr->hw_rev = htonl(board->hw_rev);
 540         hdr->hw_ver_add = htonl(board->hw_ver_add);
 541
 542         if (boot_info.file_size == 0) {
 543                 memcpy(hdr->md5sum1, md5salt_normal, sizeof(hdr->md5sum1));
 544                 hdr->boot_ofs = htonl(0);
 545                 hdr->boot_len = htonl(0);
 546         } else {
 547                 memcpy(hdr->md5sum1, md5salt_boot, sizeof(hdr->md5sum1));
 548                 hdr->boot_ofs = htonl(rootfs_ofs + rootfs_info.file_size);
 549                 hdr->boot_len = htonl(rootfs_info.file_size);
 550         }
 551
 552         hdr->kernel_la = htonl(kernel_la);
 553         hdr->kernel_ep = htonl(kernel_ep);
 554         hdr->fw_length = htonl(layout->fw_max_len);
 555         hdr->kernel_ofs = htonl(sizeof(struct fw_header));
 556         hdr->kernel_len = htonl(kernel_len);
 557         if (!combined) {
 558                 hdr->rootfs_ofs = htonl(rootfs_ofs);
 559                 hdr->rootfs_len = htonl(rootfs_info.file_size);
 560         }
 561
 562         hdr->boot_ofs = htonl(0);
 563         hdr->boot_len = htonl(boot_info.file_size);
 564
 565         hdr->unk2 = htonl(0);
 566         hdr->unk3 = htonl(0xffffffff);
 567         hdr->unk4 = htons(0x55aa);
 568         hdr->unk5 = 0xa5;
 569
 570         hdr->sver_hi = sver_hi;
 571         hdr->sver_lo = sver_lo;
 572
 573         hdr->ver_hi = fw_ver_hi;
 574         hdr->ver_mid = fw_ver_mid;
 575         hdr->ver_lo = fw_ver_lo;
 576
 577         if (board->flags & FLAG_LE_KERNEL_LA_EP) {
 578                 hdr->kernel_la = bswap_32(hdr->kernel_la);
 579                 hdr->kernel_ep = bswap_32(hdr->kernel_ep);
 580         }
 581
 582         get_md5(buf, len, hdr->md5sum1);
 583 }
 584
 585 static int pad_jffs2(char *buf, int currlen)
 586 {
 587         int len;
 588         uint32_t pad_mask;
 589
 590         len = currlen;
 591         pad_mask = (64 * 1024);
 592         while ((len < layout->fw_max_len) && (pad_mask != 0)) {
 593                 uint32_t mask;
 594                 int i;
 595
 596                 for (i = 10; i < 32; i++) {
 597                         mask = 1 << i;
 598                         if (pad_mask & mask)
 599                                 break;
 600                 }
 601
 602                 len = ALIGN(len, mask);
 603
 604                 for (i = 10; i < 32; i++) {
 605                         mask = 1 << i;
 606                         if ((len & (mask - 1)) == 0)
 607                                 pad_mask &= ~mask;
 608                 }
 609
 610                 for (i = 0; i < sizeof(jffs2_eof_mark); i++)
 611                         buf[len + i] = jffs2_eof_mark[i];
 612
 613                 len += sizeof(jffs2_eof_mark);
 614         }
 615
 616         return len;
 617 }
 618
 619 static int write_fw(char *data, int len)
 620 {
 621         FILE *f;
 622         int ret = EXIT_FAILURE;
 623
 624         f = fopen(ofname, "w");
 625         if (f == NULL) {
 626                 ERRS("could not open \"%s\" for writing", ofname);
 627                 goto out;
 628         }
 629
 630         errno = 0;
 631         fwrite(data, len, 1, f);
 632         if (errno) {
 633                 ERRS("unable to write output file");
 634                 goto out_flush;
 635         }
 636
 637         DBG("firmware file \"%s\" completed", ofname);
 638
 639         ret = EXIT_SUCCESS;
 640
 641  out_flush:
 642         fflush(f);
 643         fclose(f);
 644         if (ret != EXIT_SUCCESS) {
 645                 unlink(ofname);
 646         }
 647  out:
 648         return ret;
 649 }
 650
 651 static int build_fw(void)
 652 {
 653         int buflen;
 654         char *buf;
 655         char *p;
 656         int ret = EXIT_FAILURE;
 657         int writelen = 0;
 658
 659         buflen = layout->fw_max_len;
 660
 661         buf = malloc(buflen);
 662         if (!buf) {
 663                 ERR("no memory for buffer\n");
 664                 goto out;
 665         }
 666
 667         memset(buf, 0xff, buflen);
 668         p = buf + sizeof(struct fw_header);
 669         ret = read_to_buf(&kernel_info, p);
 670         if (ret)
 671                 goto out_free_buf;
 672
 673         writelen = sizeof(struct fw_header) + kernel_len;
 674
 675         if (!combined) {
 676                 if (rootfs_align)
 677                         p = buf + writelen;
 678                 else
 679                         p = buf + rootfs_ofs;
 680
 681                 ret = read_to_buf(&rootfs_info, p);
 682                 if (ret)
 683                         goto out_free_buf;
 684
 685                 if (rootfs_align)
 686                         writelen += rootfs_info.file_size;
 687                 else
 688                         writelen = rootfs_ofs + rootfs_info.file_size;
 689
 690                 if (add_jffs2_eof)
 691                         writelen = pad_jffs2(buf, writelen);
 692         }
 693
 694         if (!strip_padding)
 695                 writelen = buflen;
 696
 697         fill_header(buf, writelen);
 698         ret = write_fw(buf, writelen);
 699         if (ret)
 700                 goto out_free_buf;
 701
 702         ret = EXIT_SUCCESS;
 703
 704  out_free_buf:
 705         free(buf);
 706  out:
 707         return ret;
 708 }
 709
 710 /* Helper functions to inspect_fw() representing different output formats */
 711 static inline void inspect_fw_pstr(char *label, char *str)
 712 {
 713         printf("%-23s: %s\n", label, str);
 714 }
 715
 716 static inline void inspect_fw_phex(char *label, uint32_t val)
 717 {
 718         printf("%-23s: 0x%08x\n", label, val);
 719 }
 720
 721 static inline void inspect_fw_phexpost(char *label,
 722                                        uint32_t val, char *post)
 723 {
 724         printf("%-23s: 0x%08x (%s)\n", label, val, post);
 725 }
 726
 727 static inline void inspect_fw_phexdef(char *label,
 728                                       uint32_t val, uint32_t defval)
 729 {
 730         printf("%-23s: 0x%08x                  ", label, val);
 731
 732         if (val == defval)
 733                 printf("(== OpenWrt default)\n");
 734         else
 735                 printf("(OpenWrt default: 0x%08x)\n", defval);
 736 }
 737
 738 static inline void inspect_fw_phexexp(char *label,
 739                                       uint32_t val, uint32_t expval)
 740 {
 741         printf("%-23s: 0x%08x ", label, val);
 742
 743         if (val == expval)
 744                 printf("(ok)\n");
 745         else
 746                 printf("(expected: 0x%08x)\n", expval);
 747 }
 748
 749 static inline void inspect_fw_phexdec(char *label, uint32_t val)
 750 {
 751         printf("%-23s: 0x%08x / %8u bytes\n", label, val, val);
 752 }
 753
 754 static inline void inspect_fw_phexdecdef(char *label,
 755                                          uint32_t val, uint32_t defval)
 756 {
 757         printf("%-23s: 0x%08x / %8u bytes ", label, val, val);
 758
 759         if (val == defval)
 760                 printf("(== OpenWrt default)\n");
 761         else
 762                 printf("(OpenWrt default: 0x%08x)\n", defval);
 763 }
 764
 765 static inline void inspect_fw_pmd5sum(char *label, uint8_t *val, char *text)
 766 {
 767         int i;
 768
 769         printf("%-23s:", label);
 770         for (i=0; i<MD5SUM_LEN; i++)
 771                 printf(" %02x", val[i]);
 772         printf(" %s\n", text);
 773 }
 774
 775 static int inspect_fw(void)
 776 {
 777         char *buf;
 778         struct fw_header *hdr;
 779         uint8_t md5sum[MD5SUM_LEN];
 780         struct board_info *board;
 781         int ret = EXIT_FAILURE;
 782
 783         buf = malloc(inspect_info.file_size);
 784         if (!buf) {
 785                 ERR("no memory for buffer!\n");
 786                 goto out;
 787         }
 788
 789         ret = read_to_buf(&inspect_info, buf);
 790         if (ret)
 791                 goto out_free_buf;
 792         hdr = (struct fw_header *)buf;
 793
 794         board = find_board_by_hwid(ntohl(hdr->hw_id));
 795         if (!board)
 796                 board = &custom_board;
 797
 798         if (board->flags & FLAG_LE_KERNEL_LA_EP) {
 799                 hdr->kernel_la = bswap_32(hdr->kernel_la);
 800                 hdr->kernel_ep = bswap_32(hdr->kernel_ep);
 801         }
 802
 803         inspect_fw_pstr("File name", inspect_info.file_name);
 804         inspect_fw_phexdec("File size", inspect_info.file_size);
 805
 806         switch(bswap_32(ntohl(hdr->version))) {
 807         case 2:
 808         case 3:
 809                 break;
 810         default:
 811                 ERR("file does not seem to have V2/V3 header!\n");
 812                 goto out_free_buf;
 813         }
 814
 815         inspect_fw_phexdec("Version 2 Header size", sizeof(struct fw_header));
 816
 817         memcpy(md5sum, hdr->md5sum1, sizeof(md5sum));
 818         if (ntohl(hdr->boot_len) == 0)
 819                 memcpy(hdr->md5sum1, md5salt_normal, sizeof(md5sum));
 820         else
 821                 memcpy(hdr->md5sum1, md5salt_boot, sizeof(md5sum));
 822         get_md5(buf, inspect_info.file_size, hdr->md5sum1);
 823
 824         if (memcmp(md5sum, hdr->md5sum1, sizeof(md5sum))) {
 825                 inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(*ERROR*)");
 826                 inspect_fw_pmd5sum("          --> expected", hdr->md5sum1, "");
 827         } else {
 828                 inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(ok)");
 829         }
 830         if (ntohl(hdr->unk2) != 0)
 831                 inspect_fw_phexdec("Unknown value 2", hdr->unk2);
 832         inspect_fw_pmd5sum("Header MD5Sum2", hdr->md5sum2,
 833                            "(purpose yet unknown, unchecked here)");
 834
 835         if (ntohl(hdr->unk3) != 0xffffffff)
 836                 inspect_fw_phexdec("Unknown value 3", hdr->unk3);
 837
 838         if (ntohs(hdr->unk4) != 0x55aa)
 839                 inspect_fw_phexdec("Unknown value 4", hdr->unk4);
 840
 841         if (hdr->unk5 != 0xa5)
 842                 inspect_fw_phexdec("Unknown value 5", hdr->unk5);
 843
 844         printf("\n");
 845
 846         inspect_fw_pstr("Firmware version", hdr->fw_version);
 847
 848         if (board != &custom_board) {
 849                 layout = find_layout(board->layout_id);
 850                 inspect_fw_phexpost("Hardware ID",
 851                                     ntohl(hdr->hw_id), board->id);
 852                 inspect_fw_phexexp("Hardware Revision",
 853                                    ntohl(hdr->hw_rev), board->hw_rev);
 854                 inspect_fw_phexexp("Additional HW Version",
 855                                    ntohl(hdr->hw_ver_add), board->hw_ver_add);
 856         } else {
 857                 inspect_fw_phexpost("Hardware ID",
 858                                     ntohl(hdr->hw_id), "unknown");
 859                 inspect_fw_phex("Hardware Revision",
 860                                 ntohl(hdr->hw_rev));
 861                 inspect_fw_phex("Additional HW Version",
 862                                 ntohl(hdr->hw_ver_add));
 863         }
 864
 865         printf("%-23s: %d.%d.%d-%d.%d\n", "Software version",
 866                hdr->ver_hi, hdr->ver_mid, hdr->ver_lo,
 867                hdr->sver_hi, hdr->sver_lo);
 868
 869         printf("\n");
 870
 871         inspect_fw_phexdec("Kernel data offset",
 872                            ntohl(hdr->kernel_ofs));
 873         inspect_fw_phexdec("Kernel data length",
 874                            ntohl(hdr->kernel_len));
 875         if (board != &custom_board) {
 876                 inspect_fw_phexdef("Kernel load address",
 877                                    ntohl(hdr->kernel_la),
 878                                    layout ? layout->kernel_la : 0xffffffff);
 879                 inspect_fw_phexdef("Kernel entry point",
 880                                    ntohl(hdr->kernel_ep),
 881                                    layout ? layout->kernel_ep : 0xffffffff);
 882                 inspect_fw_phexdecdef("Rootfs data offset",
 883                                       ntohl(hdr->rootfs_ofs),
 884                                       layout ? layout->rootfs_ofs : 0xffffffff);
 885         } else {
 886                 inspect_fw_phex("Kernel load address",
 887                                 ntohl(hdr->kernel_la));
 888                 inspect_fw_phex("Kernel entry point",
 889                                 ntohl(hdr->kernel_ep));
 890                 inspect_fw_phexdec("Rootfs data offset",
 891                                    ntohl(hdr->rootfs_ofs));
 892         }
 893         inspect_fw_phexdec("Rootfs data length",
 894                            ntohl(hdr->rootfs_len));
 895         inspect_fw_phexdec("Boot loader data offset",
 896                            ntohl(hdr->boot_ofs));
 897         inspect_fw_phexdec("Boot loader data length",
 898                            ntohl(hdr->boot_len));
 899         inspect_fw_phexdec("Total firmware length",
 900                            ntohl(hdr->fw_length));
 901
 902         if (extract) {
 903                 FILE *fp;
 904                 char *filename;
 905
 906                 printf("\n");
 907
 908                 filename = malloc(strlen(inspect_info.file_name) + 8);
 909                 sprintf(filename, "%s-kernel", inspect_info.file_name);
 910                 printf("Extracting kernel to \"%s\"...\n", filename);
 911                 fp = fopen(filename, "w");
 912                 if (fp) {
 913                         if (!fwrite(buf + ntohl(hdr->kernel_ofs),
 914                                     ntohl(hdr->kernel_len), 1, fp)) {
 915                                 ERR("error in fwrite(): %s", strerror(errno));
 916                         }
 917                         fclose(fp);
 918                 } else {
 919                         ERR("error in fopen(): %s", strerror(errno));
 920                 }
 921                 free(filename);
 922
 923                 filename = malloc(strlen(inspect_info.file_name) + 8);
 924                 sprintf(filename, "%s-rootfs", inspect_info.file_name);
 925                 printf("Extracting rootfs to \"%s\"...\n", filename);
 926                 fp = fopen(filename, "w");
 927                 if (fp) {
 928                         if (!fwrite(buf + ntohl(hdr->rootfs_ofs),
 929                                     ntohl(hdr->rootfs_len), 1, fp)) {
 930                                 ERR("error in fwrite(): %s", strerror(errno));
 931                         }
 932                         fclose(fp);
 933                 } else {
 934                         ERR("error in fopen(): %s", strerror(errno));
 935                 }
 936                 free(filename);
 937         }
 938
 939  out_free_buf:
 940         free(buf);
 941  out:
 942         return ret;
 943 }
 944
 945 int main(int argc, char *argv[])
 946 {
 947         int ret = EXIT_FAILURE;
 948         int err;
 949
 950         FILE *outfile;
 951
 952         progname = basename(argv[0]);
 953
 954         while ( 1 ) {
 955                 int c;
 956
 957                 c = getopt(argc, argv, "a:B:H:E:F:L:V:N:W:w:ci:k:r:R:o:xhsjv:y:T:e");
 958                 if (c == -1)
 959                         break;
 960
 961                 switch (c) {
 962                 case 'a':
 963                         sscanf(optarg, "0x%x", &rootfs_align);
 964                         break;
 965                 case 'B':
 966                         board_id = optarg;
 967                         break;
 968                 case 'H':
 969                         opt_hw_id = optarg;
 970                         break;
 971                 case 'E':
 972                         sscanf(optarg, "0x%x", &kernel_ep);
 973                         break;
 974                 case 'F':
 975                         layout_id = optarg;
 976                         break;
 977                 case 'W':
 978                         opt_hw_rev = optarg;
 979                         break;
 980                 case 'w':
 981                         opt_hw_ver_add = optarg;
 982                         break;
 983                 case 'L':
 984                         sscanf(optarg, "0x%x", &kernel_la);
 985                         break;
 986                 case 'V':
 987                         version = optarg;
 988                         break;
 989                 case 'v':
 990                         fw_ver = optarg;
 991                         break;
 992                 case 'y':
 993                         sver = optarg;
 994                         break;
 995                 case 'N':
 996                         vendor = optarg;
 997                         break;
 998                 case 'c':
 999                         combined++;
1000                         break;
1001                 case 'k':
1002                         kernel_info.file_name = optarg;
1003                         break;
1004                 case 'r':
1005                         rootfs_info.file_name = optarg;
1006                         break;
1007                 case 'R':
1008                         sscanf(optarg, "0x%x", &rootfs_ofs);
1009                         break;
1010                 case 'o':
1011                         ofname = optarg;
1012                         break;
1013                 case 's':
1014                         strip_padding = 1;
1015                         break;
1016                 case 'i':
1017                         inspect_info.file_name = optarg;
1018                         break;
1019                 case 'j':
1020                         add_jffs2_eof = 1;
1021                         break;
1022                 case 'x':
1023                         extract = 1;
1024                         break;
1025                 case 'T':
1026                         hdr_ver = atoi(optarg);
1027                         break;
1028                 case 'e':
1029                         custom_board.flags = FLAG_LE_KERNEL_LA_EP;
1030                         break;
1031                 case 'h':
1032                         usage(EXIT_SUCCESS);
1033                         break;
1034                 default:
1035                         usage(EXIT_FAILURE);
1036                         break;
1037                 }
1038         }
1039
1040         ret = check_options();
1041         if (ret)
1042                 goto out;
1043
1044         if (!inspect_info.file_name)
1045                 ret = build_fw();
1046         else
1047                 ret = inspect_fw();
1048
1049  out:
1050         return ret;
1051 }
1052