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 <errno.h>
  23 #include <sys/stat.h>
  24
  25 #include <arpa/inet.h>
  26 #include <netinet/in.h>
  27
  28 #include "md5.h"
  29
  30 #define ALIGN(x,a) ({ typeof(a) __a = (a); (((x) + __a - 1) & ~(__a - 1)); })
  31
  32 #define HEADER_VERSION_V1       0x01000000
  33 #define HWID_ANTMINER_S1        0x04440001
  34 #define HWID_ANTMINER_S3        0x04440003
  35 #define HWID_GL_INET_V1         0x08000001
  36 #define HWID_GS_OOLITE_V1       0x3C000101
  37 #define HWID_ONION_OMEGA        0x04700001
  38 #define HWID_TL_MR10U_V1        0x00100101
  39 #define HWID_TL_MR13U_V1        0x00130101
  40 #define HWID_TL_MR3020_V1       0x30200001
  41 #define HWID_TL_MR3220_V1       0x32200001
  42 #define HWID_TL_MR3220_V2       0x32200002
  43 #define HWID_TL_MR3420_V1       0x34200001
  44 #define HWID_TL_MR3420_V2       0x34200002
  45 #define HWID_TL_WA701N_V1       0x07010001
  46 #define HWID_TL_WA701N_V2       0x07010002
  47 #define HWID_TL_WA7210N_V2      0x72100002
  48 #define HWID_TL_WA7510N_V1      0x75100001
  49 #define HWID_TL_WA801ND_V1      0x08010001
  50 #define HWID_TL_WA830RE_V1      0x08300010
  51 #define HWID_TL_WA830RE_V2      0x08300002
  52 #define HWID_TL_WA801ND_V2      0x08010002
  53 #define HWID_TL_WA901ND_V1      0x09010001
  54 #define HWID_TL_WA901ND_V2      0x09010002
  55 #define HWID_TL_WDR4300_V1_IL   0x43008001
  56 #define HWID_TL_WDR4900_V1      0x49000001
  57 #define HWID_TL_WR703N_V1       0x07030101
  58 #define HWID_TL_WR720N_V3       0x07200103
  59 #define HWID_TL_WR720N_V4       0x07200104
  60 #define HWID_TL_WR741ND_V1      0x07410001
  61 #define HWID_TL_WR741ND_V4      0x07410004
  62 #define HWID_TL_WR740N_V1       0x07400001
  63 #define HWID_TL_WR740N_V3       0x07400003
  64 #define HWID_TL_WR743ND_V1      0x07430001
  65 #define HWID_TL_WR743ND_V2      0x07430002
  66 #define HWID_TL_WR841N_V1_5     0x08410002
  67 #define HWID_TL_WR841ND_V3      0x08410003
  68 #define HWID_TL_WR841ND_V5      0x08410005
  69 #define HWID_TL_WR841ND_V7      0x08410007
  70 #define HWID_TL_WR941ND_V2      0x09410002
  71 #define HWID_TL_WR941ND_V4      0x09410004
  72 #define HWID_TL_WR1043ND_V1     0x10430001
  73 #define HWID_TL_WR1043ND_V2     0x10430002
  74 #define HWID_TL_WR1041N_V2      0x10410002
  75 #define HWID_TL_WR2543N_V1      0x25430001
  76
  77 #define MD5SUM_LEN      16
  78
  79 struct file_info {
  80         char            *file_name;     /* name of the file */
  81         uint32_t        file_size;      /* length of the file */
  82 };
  83
  84 struct fw_header {
  85         uint32_t        version;        /* header version */
  86         char            vendor_name[24];
  87         char            fw_version[36];
  88         uint32_t        hw_id;          /* hardware id */
  89         uint32_t        hw_rev;         /* hardware revision */
  90         uint32_t        unk1;
  91         uint8_t         md5sum1[MD5SUM_LEN];
  92         uint32_t        unk2;
  93         uint8_t         md5sum2[MD5SUM_LEN];
  94         uint32_t        unk3;
  95         uint32_t        kernel_la;      /* kernel load address */
  96         uint32_t        kernel_ep;      /* kernel entry point */
  97         uint32_t        fw_length;      /* total length of the firmware */
  98         uint32_t        kernel_ofs;     /* kernel data offset */
  99         uint32_t        kernel_len;     /* kernel data length */
 100         uint32_t        rootfs_ofs;     /* rootfs data offset */
 101         uint32_t        rootfs_len;     /* rootfs data length */
 102         uint32_t        boot_ofs;       /* bootloader data offset */
 103         uint32_t        boot_len;       /* bootloader data length */
 104         uint16_t        ver_hi;
 105         uint16_t        ver_mid;
 106         uint16_t        ver_lo;
 107         uint8_t         pad[354];
 108 } __attribute__ ((packed));
 109
 110 struct flash_layout {
 111         char            *id;
 112         uint32_t        fw_max_len;
 113         uint32_t        kernel_la;
 114         uint32_t        kernel_ep;
 115         uint32_t        rootfs_ofs;
 116 };
 117
 118 struct board_info {
 119         char            *id;
 120         uint32_t        hw_id;
 121         uint32_t        hw_rev;
 122         char            *layout_id;
 123 };
 124
 125 /*
 126  * Globals
 127  */
 128 static char *ofname;
 129 static char *progname;
 130 static char *vendor = "TP-LINK Technologies";
 131 static char *version = "ver. 1.0";
 132 static char *fw_ver = "0.0.0";
 133
 134 static char *board_id;
 135 static struct board_info *board;
 136 static char *layout_id;
 137 static struct flash_layout *layout;
 138 static char *opt_hw_id;
 139 static uint32_t hw_id;
 140 static char *opt_hw_rev;
 141 static uint32_t hw_rev;
 142 static int fw_ver_lo;
 143 static int fw_ver_mid;
 144 static int fw_ver_hi;
 145 static struct file_info kernel_info;
 146 static uint32_t kernel_la = 0;
 147 static uint32_t kernel_ep = 0;
 148 static uint32_t kernel_len = 0;
 149 static struct file_info rootfs_info;
 150 static uint32_t rootfs_ofs = 0;
 151 static uint32_t rootfs_align;
 152 static struct file_info boot_info;
 153 static int combined;
 154 static int strip_padding;
 155 static int ignore_size;
 156 static int add_jffs2_eof;
 157 static unsigned char jffs2_eof_mark[4] = {0xde, 0xad, 0xc0, 0xde};
 158 static uint32_t fw_max_len;
 159 static uint32_t reserved_space;
 160
 161 static struct file_info inspect_info;
 162 static int extract = 0;
 163
 164 char md5salt_normal[MD5SUM_LEN] = {
 165         0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
 166         0xdd, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x38,
 167 };
 168
 169 char md5salt_boot[MD5SUM_LEN] = {
 170         0x8c, 0xef, 0x33, 0x5b, 0xd5, 0xc5, 0xce, 0xfa,
 171         0xa7, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
 172 };
 173
 174 static struct flash_layout layouts[] = {
 175         {
 176                 .id             = "4M",
 177                 .fw_max_len     = 0x3c0000,
 178                 .kernel_la      = 0x80060000,
 179                 .kernel_ep      = 0x80060000,
 180                 .rootfs_ofs     = 0x140000,
 181         }, {
 182                 .id             = "4Mlzma",
 183                 .fw_max_len     = 0x3c0000,
 184                 .kernel_la      = 0x80060000,
 185                 .kernel_ep      = 0x80060000,
 186                 .rootfs_ofs     = 0x100000,
 187         }, {
 188                 .id             = "8M",
 189                 .fw_max_len     = 0x7c0000,
 190                 .kernel_la      = 0x80060000,
 191                 .kernel_ep      = 0x80060000,
 192                 .rootfs_ofs     = 0x140000,
 193         }, {
 194                 .id             = "8Mlzma",
 195                 .fw_max_len     = 0x7c0000,
 196                 .kernel_la      = 0x80060000,
 197                 .kernel_ep      = 0x80060000,
 198                 .rootfs_ofs     = 0x100000,
 199         }, {
 200                 .id             = "16M",
 201                 .fw_max_len     = 0xf80000,
 202                 .kernel_la      = 0x80060000,
 203                 .kernel_ep      = 0x80060000,
 204                 .rootfs_ofs     = 0x140000,
 205         }, {
 206                 .id             = "16Mlzma",
 207                 .fw_max_len     = 0xf80000,
 208                 .kernel_la      = 0x80060000,
 209                 .kernel_ep      = 0x80060000,
 210                 .rootfs_ofs     = 0x100000,
 211         }, {
 212                 .id             = "16Mppc",
 213                 .fw_max_len     = 0xf80000,
 214                 .kernel_la      = 0x00000000,
 215                 .kernel_ep      = 0xc0000000,
 216                 .rootfs_ofs     = 0x2a0000,
 217         }, {
 218                 /* terminating entry */
 219         }
 220 };
 221
 222 static struct board_info boards[] = {
 223         {
 224                 .id             = "TL-MR10Uv1",
 225                 .hw_id          = HWID_TL_MR10U_V1,
 226                 .hw_rev         = 1,
 227                 .layout_id      = "4Mlzma",
 228         }, {
 229                 .id             = "TL-MR13Uv1",
 230                 .hw_id          = HWID_TL_MR13U_V1,
 231                 .hw_rev         = 1,
 232                 .layout_id      = "4Mlzma",
 233         }, {
 234                 .id             = "TL-MR3020v1",
 235                 .hw_id          = HWID_TL_MR3020_V1,
 236                 .hw_rev         = 1,
 237                 .layout_id      = "4Mlzma",
 238         }, {
 239                 .id             = "TL-MR3220v1",
 240                 .hw_id          = HWID_TL_MR3220_V1,
 241                 .hw_rev         = 1,
 242                 .layout_id      = "4M",
 243         }, {
 244                 .id             = "TL-MR3220v2",
 245                 .hw_id          = HWID_TL_MR3220_V2,
 246                 .hw_rev         = 1,
 247                 .layout_id      = "4Mlzma",
 248         }, {
 249                 .id             = "TL-MR3420v1",
 250                 .hw_id          = HWID_TL_MR3420_V1,
 251                 .hw_rev         = 1,
 252                 .layout_id      = "4M",
 253         }, {
 254                 .id             = "TL-MR3420v2",
 255                 .hw_id          = HWID_TL_MR3420_V2,
 256                 .hw_rev         = 1,
 257                 .layout_id      = "4Mlzma",
 258         }, {
 259                 .id             = "TL-WA701Nv1",
 260                 .hw_id          = HWID_TL_WA701N_V1,
 261                 .hw_rev         = 1,
 262                 .layout_id      = "4M",
 263         }, {
 264                 .id             = "TL-WA701Nv2",
 265                 .hw_id          = HWID_TL_WA701N_V2,
 266                 .hw_rev         = 1,
 267                 .layout_id      = "4Mlzma",
 268         }, {
 269                 .id             = "TL-WA7210N",
 270                 .hw_id          = HWID_TL_WA7210N_V2,
 271                 .hw_rev         = 2,
 272                 .layout_id      = "4Mlzma",
 273         }, {
 274                 .id             = "TL-WA7510N",
 275                 .hw_id          = HWID_TL_WA7510N_V1,
 276                 .hw_rev         = 1,
 277                 .layout_id      = "4M",
 278         }, {
 279                 .id             = "TL-WA801NDv1",
 280                 .hw_id          = HWID_TL_WA801ND_V1,
 281                 .hw_rev         = 1,
 282                 .layout_id      = "4M",
 283         }, {
 284                 .id             = "TL-WA830REv1",
 285                 .hw_id          = HWID_TL_WA830RE_V1,
 286                 .hw_rev         = 1,
 287                 .layout_id      = "4M",
 288         }, {
 289                 .id             = "TL-WA830REv2",
 290                 .hw_id          = HWID_TL_WA830RE_V2,
 291                 .hw_rev         = 1,
 292                 .layout_id      = "4M",
 293         }, {
 294                 .id             = "TL-WA801NDv2",
 295                 .hw_id          = HWID_TL_WA801ND_V2,
 296                 .hw_rev         = 1,
 297                 .layout_id      = "4Mlzma",
 298         }, {
 299                 .id             = "TL-WA901NDv1",
 300                 .hw_id          = HWID_TL_WA901ND_V1,
 301                 .hw_rev         = 1,
 302                 .layout_id      = "4M",
 303         }, {
 304                 .id             = "TL-WA901NDv2",
 305                 .hw_id          = HWID_TL_WA901ND_V2,
 306                 .hw_rev         = 1,
 307                 .layout_id      = "4M",
 308         }, {
 309                 .id             = "TL-WDR4300v1",
 310                 .hw_id          = HWID_TL_WDR4300_V1_IL,
 311                 .hw_rev         = 1,
 312                 .layout_id      = "8Mlzma",
 313         }, {
 314                 .id             = "TL-WDR4900v1",
 315                 .hw_id          = HWID_TL_WDR4900_V1,
 316                 .hw_rev         = 1,
 317                 .layout_id      = "16Mppc",
 318         }, {
 319                 .id             = "TL-WR741NDv1",
 320                 .hw_id          = HWID_TL_WR741ND_V1,
 321                 .hw_rev         = 1,
 322                 .layout_id      = "4M",
 323         }, {
 324                 .id             = "TL-WR741NDv4",
 325                 .hw_id          = HWID_TL_WR741ND_V4,
 326                 .hw_rev         = 1,
 327                 .layout_id      = "4Mlzma",
 328         }, {
 329                 .id             = "TL-WR740Nv1",
 330                 .hw_id          = HWID_TL_WR740N_V1,
 331                 .hw_rev         = 1,
 332                 .layout_id      = "4M",
 333         }, {
 334                 .id             = "TL-WR740Nv3",
 335                 .hw_id          = HWID_TL_WR740N_V3,
 336                 .hw_rev         = 1,
 337                 .layout_id      = "4M",
 338         }, {
 339                 .id             = "TL-WR743NDv1",
 340                 .hw_id          = HWID_TL_WR743ND_V1,
 341                 .hw_rev         = 1,
 342                 .layout_id      = "4M",
 343         }, {
 344                 .id             = "TL-WR743NDv2",
 345                 .hw_id          = HWID_TL_WR743ND_V2,
 346                 .hw_rev         = 1,
 347                 .layout_id      = "4Mlzma",
 348         }, {
 349                 .id             = "TL-WR841Nv1.5",
 350                 .hw_id          = HWID_TL_WR841N_V1_5,
 351                 .hw_rev         = 2,
 352                 .layout_id      = "4M",
 353         }, {
 354                 .id             = "TL-WR841NDv3",
 355                 .hw_id          = HWID_TL_WR841ND_V3,
 356                 .hw_rev         = 3,
 357                 .layout_id      = "4M",
 358         }, {
 359                 .id             = "TL-WR841NDv5",
 360                 .hw_id          = HWID_TL_WR841ND_V5,
 361                 .hw_rev         = 1,
 362                 .layout_id      = "4M",
 363         }, {
 364                 .id             = "TL-WR841NDv7",
 365                 .hw_id          = HWID_TL_WR841ND_V7,
 366                 .hw_rev         = 1,
 367                 .layout_id      = "4M",
 368         }, {
 369                 .id             = "TL-WR941NDv2",
 370                 .hw_id          = HWID_TL_WR941ND_V2,
 371                 .hw_rev         = 2,
 372                 .layout_id      = "4M",
 373         }, {
 374                 .id             = "TL-WR941NDv4",
 375                 .hw_id          = HWID_TL_WR941ND_V4,
 376                 .hw_rev         = 1,
 377                 .layout_id      = "4M",
 378         }, {
 379                 .id             = "TL-WR1041Nv2",
 380                 .hw_id          = HWID_TL_WR1041N_V2,
 381                 .hw_rev         = 1,
 382                 .layout_id      = "4Mlzma",
 383         }, {
 384                 .id             = "TL-WR1043NDv1",
 385                 .hw_id          = HWID_TL_WR1043ND_V1,
 386                 .hw_rev         = 1,
 387                 .layout_id      = "8M",
 388         }, {
 389                 .id             = "TL-WR1043NDv2",
 390                 .hw_id          = HWID_TL_WR1043ND_V2,
 391                 .hw_rev         = 1,
 392                 .layout_id      = "8Mlzma",
 393         }, {
 394                 .id             = "TL-WR2543Nv1",
 395                 .hw_id          = HWID_TL_WR2543N_V1,
 396                 .hw_rev         = 1,
 397                 .layout_id      = "8Mlzma",
 398         }, {
 399                 .id             = "TL-WR703Nv1",
 400                 .hw_id          = HWID_TL_WR703N_V1,
 401                 .hw_rev         = 1,
 402                 .layout_id      = "4Mlzma",
 403         }, {
 404                 .id             = "TL-WR720Nv3",
 405                 .hw_id          = HWID_TL_WR720N_V3,
 406                 .hw_rev         = 1,
 407                 .layout_id      = "4Mlzma",
 408         }, {
 409                 .id             = "TL-WR720Nv4",
 410                 .hw_id          = HWID_TL_WR720N_V4,
 411                 .hw_rev         = 1,
 412                 .layout_id      = "4Mlzma",
 413         }, {
 414                 .id             = "GL-INETv1",
 415                 .hw_id          = HWID_GL_INET_V1,
 416                 .hw_rev         = 1,
 417                 .layout_id      = "8Mlzma",
 418         }, {
 419                 .id             = "GS-OOLITEv1",
 420                 .hw_id          = HWID_GS_OOLITE_V1,
 421                 .hw_rev         = 1,
 422                 .layout_id      = "16Mlzma",
 423         }, {
 424                 .id             = "ONION-OMEGA",
 425                 .hw_id          = HWID_ONION_OMEGA,
 426                 .hw_rev         = 1,
 427                 .layout_id      = "16Mlzma",
 428         }, {
 429                 .id             = "ANTMINER-S1",
 430                 .hw_id          = HWID_ANTMINER_S1,
 431                 .hw_rev         = 1,
 432                 .layout_id      = "8Mlzma",
 433         }, {
 434                 /* terminating entry */
 435         }
 436 };
 437
 438 /*
 439  * Message macros
 440  */
 441 #define ERR(fmt, ...) do { \
 442         fflush(0); \
 443         fprintf(stderr, "[%s] *** error: " fmt "\n", \
 444                         progname, ## __VA_ARGS__ ); \
 445 } while (0)
 446
 447 #define ERRS(fmt, ...) do { \
 448         int save = errno; \
 449         fflush(0); \
 450         fprintf(stderr, "[%s] *** error: " fmt "\n", \
 451                         progname, ## __VA_ARGS__, strerror(save)); \
 452 } while (0)
 453
 454 #define DBG(fmt, ...) do { \
 455         fprintf(stderr, "[%s] " fmt "\n", progname, ## __VA_ARGS__ ); \
 456 } while (0)
 457
 458 static struct board_info *find_board(char *id)
 459 {
 460         struct board_info *ret;
 461         struct board_info *board;
 462
 463         ret = NULL;
 464         for (board = boards; board->id != NULL; board++){
 465                 if (strcasecmp(id, board->id) == 0) {
 466                         ret = board;
 467                         break;
 468                 }
 469         };
 470
 471         return ret;
 472 }
 473
 474 static struct board_info *find_board_by_hwid(uint32_t hw_id)
 475 {
 476         struct board_info *board;
 477
 478         for (board = boards; board->id != NULL; board++) {
 479                 if (hw_id == board->hw_id)
 480                         return board;
 481         };
 482
 483         return NULL;
 484 }
 485
 486 static struct flash_layout *find_layout(char *id)
 487 {
 488         struct flash_layout *ret;
 489         struct flash_layout *l;
 490
 491         ret = NULL;
 492         for (l = layouts; l->id != NULL; l++){
 493                 if (strcasecmp(id, l->id) == 0) {
 494                         ret = l;
 495                         break;
 496                 }
 497         };
 498
 499         return ret;
 500 }
 501
 502 static void usage(int status)
 503 {
 504         FILE *stream = (status != EXIT_SUCCESS) ? stderr : stdout;
 505         struct board_info *board;
 506
 507         fprintf(stream, "Usage: %s [OPTIONS...]\n", progname);
 508         fprintf(stream,
 509 "\n"
 510 "Options:\n"
 511 "  -B <board>      create image for the board specified with <board>\n"
 512 "  -c              use combined kernel image\n"
 513 "  -E <ep>         overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
 514 "  -L <la>         overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
 515 "  -H <hwid>       use hardware id specified with <hwid>\n"
 516 "  -W <hwrev>      use hardware revision specified with <hwrev>\n"
 517 "  -F <id>         use flash layout specified with <id>\n"
 518 "  -k <file>       read kernel image from the file <file>\n"
 519 "  -r <file>       read rootfs image from the file <file>\n"
 520 "  -a <align>      align the rootfs start on an <align> bytes boundary\n"
 521 "  -R <offset>     overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
 522 "  -o <file>       write output to the file <file>\n"
 523 "  -s              strip padding from the end of the image\n"
 524 "  -S              ignore firmware size limit (only for combined images)\n"
 525 "  -j              add jffs2 end-of-filesystem markers\n"
 526 "  -N <vendor>     set image vendor to <vendor>\n"
 527 "  -V <version>    set image version to <version>\n"
 528 "  -v <version>    set firmware version to <version>\n"
 529 "  -i <file>       inspect given firmware file <file>\n"
 530 "  -x              extract kernel and rootfs while inspecting (requires -i)\n"
 531 "  -X <size>       reserve <size> bytes in the firmware image (hexval prefixed with 0x)\n"
 532 "  -h              show this screen\n"
 533         );
 534
 535         exit(status);
 536 }
 537
 538 static int get_md5(char *data, int size, char *md5)
 539 {
 540         MD5_CTX ctx;
 541
 542         MD5_Init(&ctx);
 543         MD5_Update(&ctx, data, size);
 544         MD5_Final(md5, &ctx);
 545 }
 546
 547 static int get_file_stat(struct file_info *fdata)
 548 {
 549         struct stat st;
 550         int res;
 551
 552         if (fdata->file_name == NULL)
 553                 return 0;
 554
 555         res = stat(fdata->file_name, &st);
 556         if (res){
 557                 ERRS("stat failed on %s", fdata->file_name);
 558                 return res;
 559         }
 560
 561         fdata->file_size = st.st_size;
 562         return 0;
 563 }
 564
 565 static int read_to_buf(struct file_info *fdata, char *buf)
 566 {
 567         FILE *f;
 568         int ret = EXIT_FAILURE;
 569
 570         f = fopen(fdata->file_name, "r");
 571         if (f == NULL) {
 572                 ERRS("could not open \"%s\" for reading", fdata->file_name);
 573                 goto out;
 574         }
 575
 576         errno = 0;
 577         fread(buf, fdata->file_size, 1, f);
 578         if (errno != 0) {
 579                 ERRS("unable to read from file \"%s\"", fdata->file_name);
 580                 goto out_close;
 581         }
 582
 583         ret = EXIT_SUCCESS;
 584
 585  out_close:
 586         fclose(f);
 587  out:
 588         return ret;
 589 }
 590
 591 static int check_options(void)
 592 {
 593         int ret;
 594         int exceed_bytes;
 595
 596         if (inspect_info.file_name) {
 597                 ret = get_file_stat(&inspect_info);
 598                 if (ret)
 599                         return ret;
 600
 601                 return 0;
 602         } else if (extract) {
 603                 ERR("no firmware for inspection specified");
 604                 return -1;
 605         }
 606
 607         if (board_id == NULL && opt_hw_id == NULL) {
 608                 ERR("either board or hardware id must be specified");
 609                 return -1;
 610         }
 611
 612         if (board_id) {
 613                 board = find_board(board_id);
 614                 if (board == NULL) {
 615                         ERR("unknown/unsupported board id \"%s\"", board_id);
 616                         return -1;
 617                 }
 618                 if (layout_id == NULL)
 619                         layout_id = board->layout_id;
 620
 621                 hw_id = board->hw_id;
 622                 hw_rev = board->hw_rev;
 623         } else {
 624                 if (layout_id == NULL) {
 625                         ERR("flash layout is not specified");
 626                         return -1;
 627                 }
 628                 hw_id = strtoul(opt_hw_id, NULL, 0);
 629
 630                 if (opt_hw_rev)
 631                         hw_rev = strtoul(opt_hw_rev, NULL, 0);
 632                 else
 633                         hw_rev = 1;
 634         }
 635
 636         layout = find_layout(layout_id);
 637         if (layout == NULL) {
 638                 ERR("unknown flash layout \"%s\"", layout_id);
 639                 return -1;
 640         }
 641
 642         if (!kernel_la)
 643                 kernel_la = layout->kernel_la;
 644         if (!kernel_ep)
 645                 kernel_ep = layout->kernel_ep;
 646         if (!rootfs_ofs)
 647                 rootfs_ofs = layout->rootfs_ofs;
 648
 649         if (reserved_space > layout->fw_max_len) {
 650                 ERR("reserved space is not valid");
 651                 return -1;
 652         }
 653
 654         fw_max_len = layout->fw_max_len - reserved_space;
 655
 656         if (kernel_info.file_name == NULL) {
 657                 ERR("no kernel image specified");
 658                 return -1;
 659         }
 660
 661         ret = get_file_stat(&kernel_info);
 662         if (ret)
 663                 return ret;
 664
 665         kernel_len = kernel_info.file_size;
 666
 667         if (combined) {
 668                 exceed_bytes = kernel_info.file_size - (fw_max_len - sizeof(struct fw_header));
 669                 if (exceed_bytes > 0) {
 670                         if (!ignore_size) {
 671                                 ERR("kernel image is too big by %i bytes", exceed_bytes);
 672                                 return -1;
 673                         }
 674                         layout->fw_max_len = sizeof(struct fw_header) +
 675                                              kernel_info.file_size +
 676                                              reserved_space;
 677                 }
 678         } else {
 679                 if (rootfs_info.file_name == NULL) {
 680                         ERR("no rootfs image specified");
 681                         return -1;
 682                 }
 683
 684                 ret = get_file_stat(&rootfs_info);
 685                 if (ret)
 686                         return ret;
 687
 688                 if (rootfs_align) {
 689                         kernel_len += sizeof(struct fw_header);
 690                         kernel_len = ALIGN(kernel_len, rootfs_align);
 691                         kernel_len -= sizeof(struct fw_header);
 692
 693                         DBG("kernel length aligned to %u", kernel_len);
 694
 695                         exceed_bytes = kernel_len + rootfs_info.file_size - (fw_max_len - sizeof(struct fw_header));
 696                         if (exceed_bytes > 0) {
 697                                 ERR("images are too big by %i bytes", exceed_bytes);
 698                                 return -1;
 699                         }
 700                 } else {
 701                         exceed_bytes = kernel_info.file_size - (rootfs_ofs - sizeof(struct fw_header));
 702                         if (exceed_bytes > 0) {
 703                                 ERR("kernel image is too big");
 704                                 return -1;
 705                         }
 706
 707                         exceed_bytes = rootfs_info.file_size - (fw_max_len - rootfs_ofs);
 708                         if (exceed_bytes > 0) {
 709                                 ERR("rootfs image is too big");
 710                                 return -1;
 711                         }
 712                 }
 713         }
 714
 715         if (ofname == NULL) {
 716                 ERR("no output file specified");
 717                 return -1;
 718         }
 719
 720         ret = sscanf(fw_ver, "%d.%d.%d", &fw_ver_hi, &fw_ver_mid, &fw_ver_lo);
 721         if (ret != 3) {
 722                 ERR("invalid firmware version '%s'", fw_ver);
 723                 return -1;
 724         }
 725
 726         return 0;
 727 }
 728
 729 static void fill_header(char *buf, int len)
 730 {
 731         struct fw_header *hdr = (struct fw_header *)buf;
 732
 733         memset(hdr, 0, sizeof(struct fw_header));
 734
 735         hdr->version = htonl(HEADER_VERSION_V1);
 736         strncpy(hdr->vendor_name, vendor, sizeof(hdr->vendor_name));
 737         strncpy(hdr->fw_version, version, sizeof(hdr->fw_version));
 738         hdr->hw_id = htonl(hw_id);
 739         hdr->hw_rev = htonl(hw_rev);
 740
 741         if (boot_info.file_size == 0)
 742                 memcpy(hdr->md5sum1, md5salt_normal, sizeof(hdr->md5sum1));
 743         else
 744                 memcpy(hdr->md5sum1, md5salt_boot, sizeof(hdr->md5sum1));
 745
 746         hdr->kernel_la = htonl(kernel_la);
 747         hdr->kernel_ep = htonl(kernel_ep);
 748         hdr->fw_length = htonl(layout->fw_max_len);
 749         hdr->kernel_ofs = htonl(sizeof(struct fw_header));
 750         hdr->kernel_len = htonl(kernel_len);
 751         if (!combined) {
 752                 hdr->rootfs_ofs = htonl(rootfs_ofs);
 753                 hdr->rootfs_len = htonl(rootfs_info.file_size);
 754         }
 755
 756         hdr->ver_hi = htons(fw_ver_hi);
 757         hdr->ver_mid = htons(fw_ver_mid);
 758         hdr->ver_lo = htons(fw_ver_lo);
 759
 760         get_md5(buf, len, hdr->md5sum1);
 761 }
 762
 763 static int pad_jffs2(char *buf, int currlen)
 764 {
 765         int len;
 766         uint32_t pad_mask;
 767
 768         len = currlen;
 769         pad_mask = (64 * 1024);
 770         while ((len < layout->fw_max_len) && (pad_mask != 0)) {
 771                 uint32_t mask;
 772                 int i;
 773
 774                 for (i = 10; i < 32; i++) {
 775                         mask = 1 << i;
 776                         if (pad_mask & mask)
 777                                 break;
 778                 }
 779
 780                 len = ALIGN(len, mask);
 781
 782                 for (i = 10; i < 32; i++) {
 783                         mask = 1 << i;
 784                         if ((len & (mask - 1)) == 0)
 785                                 pad_mask &= ~mask;
 786                 }
 787
 788                 for (i = 0; i < sizeof(jffs2_eof_mark); i++)
 789                         buf[len + i] = jffs2_eof_mark[i];
 790
 791                 len += sizeof(jffs2_eof_mark);
 792         }
 793
 794         return len;
 795 }
 796
 797 static int write_fw(char *data, int len)
 798 {
 799         FILE *f;
 800         int ret = EXIT_FAILURE;
 801
 802         f = fopen(ofname, "w");
 803         if (f == NULL) {
 804                 ERRS("could not open \"%s\" for writing", ofname);
 805                 goto out;
 806         }
 807
 808         errno = 0;
 809         fwrite(data, len, 1, f);
 810         if (errno) {
 811                 ERRS("unable to write output file");
 812                 goto out_flush;
 813         }
 814
 815         DBG("firmware file \"%s\" completed", ofname);
 816
 817         ret = EXIT_SUCCESS;
 818
 819  out_flush:
 820         fflush(f);
 821         fclose(f);
 822         if (ret != EXIT_SUCCESS) {
 823                 unlink(ofname);
 824         }
 825  out:
 826         return ret;
 827 }
 828
 829 static int build_fw(void)
 830 {
 831         int buflen;
 832         char *buf;
 833         char *p;
 834         int ret = EXIT_FAILURE;
 835         int writelen = 0;
 836
 837         buflen = layout->fw_max_len;
 838
 839         buf = malloc(buflen);
 840         if (!buf) {
 841                 ERR("no memory for buffer\n");
 842                 goto out;
 843         }
 844
 845         memset(buf, 0xff, buflen);
 846         p = buf + sizeof(struct fw_header);
 847         ret = read_to_buf(&kernel_info, p);
 848         if (ret)
 849                 goto out_free_buf;
 850
 851         writelen = sizeof(struct fw_header) + kernel_len;
 852
 853         if (!combined) {
 854                 if (rootfs_align)
 855                         p = buf + writelen;
 856                 else
 857                         p = buf + rootfs_ofs;
 858
 859                 ret = read_to_buf(&rootfs_info, p);
 860                 if (ret)
 861                         goto out_free_buf;
 862
 863                 if (rootfs_align)
 864                         writelen += rootfs_info.file_size;
 865                 else
 866                         writelen = rootfs_ofs + rootfs_info.file_size;
 867
 868                 if (add_jffs2_eof)
 869                         writelen = pad_jffs2(buf, writelen);
 870         }
 871
 872         if (!strip_padding)
 873                 writelen = buflen;
 874
 875         fill_header(buf, writelen);
 876         ret = write_fw(buf, writelen);
 877         if (ret)
 878                 goto out_free_buf;
 879
 880         ret = EXIT_SUCCESS;
 881
 882  out_free_buf:
 883         free(buf);
 884  out:
 885         return ret;
 886 }
 887
 888 /* Helper functions to inspect_fw() representing different output formats */
 889 static inline void inspect_fw_pstr(char *label, char *str)
 890 {
 891         printf("%-23s: %s\n", label, str);
 892 }
 893
 894 static inline void inspect_fw_phex(char *label, uint32_t val)
 895 {
 896         printf("%-23s: 0x%08x\n", label, val);
 897 }
 898
 899 static inline void inspect_fw_phexpost(char *label,
 900                                        uint32_t val, char *post)
 901 {
 902         printf("%-23s: 0x%08x (%s)\n", label, val, post);
 903 }
 904
 905 static inline void inspect_fw_phexdef(char *label,
 906                                       uint32_t val, uint32_t defval)
 907 {
 908         printf("%-23s: 0x%08x                  ", label, val);
 909
 910         if (val == defval)
 911                 printf("(== OpenWrt default)\n");
 912         else
 913                 printf("(OpenWrt default: 0x%08x)\n", defval);
 914 }
 915
 916 static inline void inspect_fw_phexexp(char *label,
 917                                       uint32_t val, uint32_t expval)
 918 {
 919         printf("%-23s: 0x%08x ", label, val);
 920
 921         if (val == expval)
 922                 printf("(ok)\n");
 923         else
 924                 printf("(expected: 0x%08x)\n", expval);
 925 }
 926
 927 static inline void inspect_fw_phexdec(char *label, uint32_t val)
 928 {
 929         printf("%-23s: 0x%08x / %8u bytes\n", label, val, val);
 930 }
 931
 932 static inline void inspect_fw_phexdecdef(char *label,
 933                                          uint32_t val, uint32_t defval)
 934 {
 935         printf("%-23s: 0x%08x / %8u bytes ", label, val, val);
 936
 937         if (val == defval)
 938                 printf("(== OpenWrt default)\n");
 939         else
 940                 printf("(OpenWrt default: 0x%08x)\n", defval);
 941 }
 942
 943 static inline void inspect_fw_pmd5sum(char *label, uint8_t *val, char *text)
 944 {
 945         int i;
 946
 947         printf("%-23s:", label);
 948         for (i=0; i<MD5SUM_LEN; i++)
 949                 printf(" %02x", val[i]);
 950         printf(" %s\n", text);
 951 }
 952
 953 static int inspect_fw(void)
 954 {
 955         char *buf;
 956         struct fw_header *hdr;
 957         uint8_t md5sum[MD5SUM_LEN];
 958         struct board_info *board;
 959         int ret = EXIT_FAILURE;
 960
 961         buf = malloc(inspect_info.file_size);
 962         if (!buf) {
 963                 ERR("no memory for buffer!\n");
 964                 goto out;
 965         }
 966
 967         ret = read_to_buf(&inspect_info, buf);
 968         if (ret)
 969                 goto out_free_buf;
 970         hdr = (struct fw_header *)buf;
 971
 972         inspect_fw_pstr("File name", inspect_info.file_name);
 973         inspect_fw_phexdec("File size", inspect_info.file_size);
 974
 975         if (ntohl(hdr->version) != HEADER_VERSION_V1) {
 976                 ERR("file does not seem to have V1 header!\n");
 977                 goto out_free_buf;
 978         }
 979
 980         inspect_fw_phexdec("Version 1 Header size", sizeof(struct fw_header));
 981
 982         if (ntohl(hdr->unk1) != 0)
 983                 inspect_fw_phexdec("Unknown value 1", hdr->unk1);
 984
 985         memcpy(md5sum, hdr->md5sum1, sizeof(md5sum));
 986         if (ntohl(hdr->boot_len) == 0)
 987                 memcpy(hdr->md5sum1, md5salt_normal, sizeof(md5sum));
 988         else
 989                 memcpy(hdr->md5sum1, md5salt_boot, sizeof(md5sum));
 990         get_md5(buf, inspect_info.file_size, hdr->md5sum1);
 991
 992         if (memcmp(md5sum, hdr->md5sum1, sizeof(md5sum))) {
 993                 inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(*ERROR*)");
 994                 inspect_fw_pmd5sum("          --> expected", hdr->md5sum1, "");
 995         } else {
 996                 inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(ok)");
 997         }
 998         if (ntohl(hdr->unk2) != 0)
 999                 inspect_fw_phexdec("Unknown value 2", hdr->unk2);
1000         inspect_fw_pmd5sum("Header MD5Sum2", hdr->md5sum2,
1001                            "(purpose yet unknown, unchecked here)");
1002         if (ntohl(hdr->unk3) != 0)
1003                 inspect_fw_phexdec("Unknown value 3", hdr->unk3);
1004
1005         printf("\n");
1006
1007         inspect_fw_pstr("Vendor name", hdr->vendor_name);
1008         inspect_fw_pstr("Firmware version", hdr->fw_version);
1009         board = find_board_by_hwid(ntohl(hdr->hw_id));
1010         if (board) {
1011                 layout = find_layout(board->layout_id);
1012                 inspect_fw_phexpost("Hardware ID",
1013                                     ntohl(hdr->hw_id), board->id);
1014                 inspect_fw_phexexp("Hardware Revision",
1015                                    ntohl(hdr->hw_rev), board->hw_rev);
1016         } else {
1017                 inspect_fw_phexpost("Hardware ID",
1018                                     ntohl(hdr->hw_id), "unknown");
1019                 inspect_fw_phex("Hardware Revision",
1020                                 ntohl(hdr->hw_rev));
1021         }
1022
1023         printf("\n");
1024
1025         inspect_fw_phexdec("Kernel data offset",
1026                            ntohl(hdr->kernel_ofs));
1027         inspect_fw_phexdec("Kernel data length",
1028                            ntohl(hdr->kernel_len));
1029         if (board) {
1030                 inspect_fw_phexdef("Kernel load address",
1031                                    ntohl(hdr->kernel_la),
1032                                    layout ? layout->kernel_la : 0xffffffff);
1033                 inspect_fw_phexdef("Kernel entry point",
1034                                    ntohl(hdr->kernel_ep),
1035                                    layout ? layout->kernel_ep : 0xffffffff);
1036                 inspect_fw_phexdecdef("Rootfs data offset",
1037                                       ntohl(hdr->rootfs_ofs),
1038                                       layout ? layout->rootfs_ofs : 0xffffffff);
1039         } else {
1040                 inspect_fw_phex("Kernel load address",
1041                                 ntohl(hdr->kernel_la));
1042                 inspect_fw_phex("Kernel entry point",
1043                                 ntohl(hdr->kernel_ep));
1044                 inspect_fw_phexdec("Rootfs data offset",
1045                                    ntohl(hdr->rootfs_ofs));
1046         }
1047         inspect_fw_phexdec("Rootfs data length",
1048                            ntohl(hdr->rootfs_len));
1049         inspect_fw_phexdec("Boot loader data offset",
1050                            ntohl(hdr->boot_ofs));
1051         inspect_fw_phexdec("Boot loader data length",
1052                            ntohl(hdr->boot_len));
1053         inspect_fw_phexdec("Total firmware length",
1054                            ntohl(hdr->fw_length));
1055
1056         if (extract) {
1057                 FILE *fp;
1058                 char *filename;
1059
1060                 printf("\n");
1061
1062                 filename = malloc(strlen(inspect_info.file_name) + 8);
1063                 sprintf(filename, "%s-kernel", inspect_info.file_name);
1064                 printf("Extracting kernel to \"%s\"...\n", filename);
1065                 fp = fopen(filename, "w");
1066                 if (fp) {
1067                         if (!fwrite(buf + ntohl(hdr->kernel_ofs),
1068                                     ntohl(hdr->kernel_len), 1, fp)) {
1069                                 ERR("error in fwrite(): %s", strerror(errno));
1070                         }
1071                         fclose(fp);
1072                 } else {
1073                         ERR("error in fopen(): %s", strerror(errno));
1074                 }
1075                 free(filename);
1076
1077                 filename = malloc(strlen(inspect_info.file_name) + 8);
1078                 sprintf(filename, "%s-rootfs", inspect_info.file_name);
1079                 printf("Extracting rootfs to \"%s\"...\n", filename);
1080                 fp = fopen(filename, "w");
1081                 if (fp) {
1082                         if (!fwrite(buf + ntohl(hdr->rootfs_ofs),
1083                                     ntohl(hdr->rootfs_len), 1, fp)) {
1084                                 ERR("error in fwrite(): %s", strerror(errno));
1085                         }
1086                         fclose(fp);
1087                 } else {
1088                         ERR("error in fopen(): %s", strerror(errno));
1089                 }
1090                 free(filename);
1091         }
1092
1093  out_free_buf:
1094         free(buf);
1095  out:
1096         return ret;
1097 }
1098
1099 int main(int argc, char *argv[])
1100 {
1101         int ret = EXIT_FAILURE;
1102         int err;
1103
1104         FILE *outfile;
1105
1106         progname = basename(argv[0]);
1107
1108         while ( 1 ) {
1109                 int c;
1110
1111                 c = getopt(argc, argv, "a:B:H:E:F:L:V:N:W:ci:k:r:R:o:xX:hsSjv:");
1112                 if (c == -1)
1113                         break;
1114
1115                 switch (c) {
1116                 case 'a':
1117                         sscanf(optarg, "0x%x", &rootfs_align);
1118                         break;
1119                 case 'B':
1120                         board_id = optarg;
1121                         break;
1122                 case 'H':
1123                         opt_hw_id = optarg;
1124                         break;
1125                 case 'E':
1126                         sscanf(optarg, "0x%x", &kernel_ep);
1127                         break;
1128                 case 'F':
1129                         layout_id = optarg;
1130                         break;
1131                 case 'W':
1132                         opt_hw_rev = optarg;
1133                         break;
1134                 case 'L':
1135                         sscanf(optarg, "0x%x", &kernel_la);
1136                         break;
1137                 case 'V':
1138                         version = optarg;
1139                         break;
1140                 case 'v':
1141                         fw_ver = optarg;
1142                         break;
1143                 case 'N':
1144                         vendor = optarg;
1145                         break;
1146                 case 'c':
1147                         combined++;
1148                         break;
1149                 case 'k':
1150                         kernel_info.file_name = optarg;
1151                         break;
1152                 case 'r':
1153                         rootfs_info.file_name = optarg;
1154                         break;
1155                 case 'R':
1156                         sscanf(optarg, "0x%x", &rootfs_ofs);
1157                         break;
1158                 case 'o':
1159                         ofname = optarg;
1160                         break;
1161                 case 's':
1162                         strip_padding = 1;
1163                         break;
1164                 case 'S':
1165                         ignore_size = 1;
1166                         break;
1167                 case 'i':
1168                         inspect_info.file_name = optarg;
1169                         break;
1170                 case 'j':
1171                         add_jffs2_eof = 1;
1172                         break;
1173                 case 'x':
1174                         extract = 1;
1175                         break;
1176                 case 'h':
1177                         usage(EXIT_SUCCESS);
1178                         break;
1179                 case 'X':
1180                         sscanf(optarg, "0x%x", &reserved_space);
1181                         break;
1182                 default:
1183                         usage(EXIT_FAILURE);
1184                         break;
1185                 }
1186         }
1187
1188         ret = check_options();
1189         if (ret)
1190                 goto out;
1191
1192         if (!inspect_info.file_name)
1193                 ret = build_fw();
1194         else
1195                 ret = inspect_fw();
1196
1197  out:
1198         return ret;
1199 }
1200