tools: otrx: allow own magic
[project/firmware-utils.git] / 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 #include "mktplinkfw-lib.h"
32
33 struct fw_header {
34 uint32_t version; /* 0x00: header version */
35 char fw_version[48]; /* 0x04: fw version string */
36 uint32_t hw_id; /* 0x34: hardware id */
37 uint32_t hw_rev; /* 0x38: FIXME: hardware revision? */
38 uint32_t hw_ver_add; /* 0x3c: additional hardware version */
39 uint8_t md5sum1[MD5SUM_LEN]; /* 0x40 */
40 uint32_t unk2; /* 0x50: 0x00000000 */
41 uint8_t md5sum2[MD5SUM_LEN]; /* 0x54 */
42 uint32_t unk3; /* 0x64: 0xffffffff */
43
44 uint32_t kernel_la; /* 0x68: kernel load address */
45 uint32_t kernel_ep; /* 0x6c: kernel entry point */
46 uint32_t fw_length; /* 0x70: total length of the image */
47 uint32_t kernel_ofs; /* 0x74: kernel data offset */
48 uint32_t kernel_len; /* 0x78: kernel data length */
49 uint32_t rootfs_ofs; /* 0x7c: rootfs data offset */
50 uint32_t rootfs_len; /* 0x80: rootfs data length */
51 uint32_t boot_ofs; /* 0x84: bootloader offset */
52 uint32_t boot_len; /* 0x88: bootloader length */
53 uint16_t unk4; /* 0x8c: 0x55aa */
54 uint8_t sver_hi; /* 0x8e */
55 uint8_t sver_lo; /* 0x8f */
56 uint8_t unk5; /* 0x90: magic: 0xa5 */
57 uint8_t ver_hi; /* 0x91 */
58 uint8_t ver_mid; /* 0x92 */
59 uint8_t ver_lo; /* 0x93 */
60 uint8_t pad[364];
61 } __attribute__ ((packed));
62
63 #define FLAG_LE_KERNEL_LA_EP 0x00000001 /* Little-endian used for kernel load address & entry point */
64
65 struct board_info {
66 char *id;
67 uint32_t hw_id;
68 uint32_t hw_rev;
69 uint32_t hw_ver_add;
70 char *layout_id;
71 uint32_t hdr_ver;
72 uint32_t flags;
73 };
74
75 /*
76 * Globals
77 */
78 char *ofname;
79 char *progname;
80 static char *vendor = "TP-LINK Technologies";
81 static char *version = "ver. 1.0";
82 static char *fw_ver = "0.0.0";
83 static char *sver = "1.0";
84 static uint32_t hdr_ver = 2;
85
86 static struct board_info custom_board;
87
88 static struct board_info *board;
89 static char *layout_id;
90 struct flash_layout *layout;
91 static char *opt_hw_id;
92 static char *opt_hw_rev;
93 static char *opt_hw_ver_add;
94 static int fw_ver_lo;
95 static int fw_ver_mid;
96 static int fw_ver_hi;
97 static int sver_lo;
98 static int sver_hi;
99 struct file_info kernel_info;
100 static uint32_t kernel_la = 0;
101 static uint32_t kernel_ep = 0;
102 uint32_t kernel_len = 0;
103 struct file_info rootfs_info;
104 uint32_t rootfs_ofs = 0;
105 uint32_t rootfs_align;
106 static struct file_info boot_info;
107 int combined;
108 int strip_padding;
109 int add_jffs2_eof;
110
111 static struct file_info inspect_info;
112 static int extract = 0;
113
114 char md5salt_normal[MD5SUM_LEN] = {
115 0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
116 0xdc, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x37,
117 };
118
119 char md5salt_boot[MD5SUM_LEN] = {
120 0x8c, 0xef, 0x33, 0x5f, 0xd5, 0xc5, 0xce, 0xfa,
121 0xac, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
122 };
123
124 static struct flash_layout layouts[] = {
125 {
126 .id = "4Mmtk",
127 .fw_max_len = 0x3c0000,
128 .kernel_la = 0x80000000,
129 .kernel_ep = 0x80000000,
130 .rootfs_ofs = 0x140000,
131 }, {
132 .id = "4MLmtk",
133 .fw_max_len = 0x3d0000,
134 .kernel_la = 0x80000000,
135 .kernel_ep = 0x80000000,
136 .rootfs_ofs = 0x140000,
137 }, {
138 .id = "8Mltq",
139 .fw_max_len = 0x7a0000,
140 .kernel_la = 0x80002000,
141 .kernel_ep = 0x80002000,
142 .rootfs_ofs = 0x140000,
143 }, {
144 .id = "16Mltq",
145 .fw_max_len = 0xf90000,
146 .kernel_la = 0x80002000,
147 .kernel_ep = 0x800061b0,
148 .rootfs_ofs = 0x140000,
149 }, {
150 .id = "8Mmtk",
151 .fw_max_len = 0x7a0000,
152 .kernel_la = 0x80000000,
153 .kernel_ep = 0x80000000,
154 .rootfs_ofs = 0x140000,
155 }, {
156 .id = "8MSUmtk", /* Split U-Boot OS */
157 .fw_max_len = 0x770000,
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 .id = "8Mqca",
169 .fw_max_len = 0x7a0000,
170 .kernel_la = 0x80060000,
171 .kernel_ep = 0x80060000,
172 .rootfs_ofs = 0x140000,
173 }, {
174 .id = "16Mqca",
175 .fw_max_len = 0xf90000,
176 .kernel_la = 0x80060000,
177 .kernel_ep = 0x80060000,
178 .rootfs_ofs = 0x140000,
179 }, {
180 /* terminating entry */
181 }
182 };
183
184 static void usage(int status)
185 {
186 FILE *stream = (status != EXIT_SUCCESS) ? stderr : stdout;
187 struct board_info *board;
188
189 fprintf(stream, "Usage: %s [OPTIONS...]\n", progname);
190 fprintf(stream,
191 "\n"
192 "Options:\n"
193 " -c use combined kernel image\n"
194 " -e swap endianness in kernel load address and entry point\n"
195 " -E <ep> overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
196 " -L <la> overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
197 " -H <hwid> use hardware id specified with <hwid>\n"
198 " -W <hwrev> use hardware revision specified with <hwrev>\n"
199 " -w <hwveradd> use additional hardware version specified with <hwveradd>\n"
200 " -F <id> use flash layout specified with <id>\n"
201 " -k <file> read kernel image from the file <file>\n"
202 " -r <file> read rootfs image from the file <file>\n"
203 " -a <align> align the rootfs start on an <align> bytes boundary\n"
204 " -R <offset> overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
205 " -o <file> write output to the file <file>\n"
206 " -s strip padding from the end of the image\n"
207 " -j add jffs2 end-of-filesystem markers\n"
208 " -N <vendor> set image vendor to <vendor>\n"
209 " -T <version> set header version to <version>\n"
210 " -V <version> set image version to <version>\n"
211 " -v <version> set firmware version to <version>\n"
212 " -y <version> set secondary version to <version>\n"
213 " -i <file> inspect given firmware file <file>\n"
214 " -x extract kernel and rootfs while inspecting (requires -i)\n"
215 " -h show this screen\n"
216 );
217
218 exit(status);
219 }
220
221 static int check_options(void)
222 {
223 int ret;
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 must be specified");
238 return -1;
239 }
240
241 board = &custom_board;
242
243 if (layout_id == NULL) {
244 ERR("flash layout is not specified");
245 return -1;
246 }
247
248 board->hw_id = strtoul(opt_hw_id, NULL, 0);
249
250 board->hw_rev = 1;
251 board->hw_ver_add = 0;
252
253 if (opt_hw_rev)
254 board->hw_rev = strtoul(opt_hw_rev, NULL, 0);
255 if (opt_hw_ver_add)
256 board->hw_ver_add = strtoul(opt_hw_ver_add, NULL, 0);
257
258 layout = find_layout(layouts, layout_id);
259 if (layout == NULL) {
260 ERR("unknown flash layout \"%s\"", layout_id);
261 return -1;
262 }
263
264 if (!kernel_la)
265 kernel_la = layout->kernel_la;
266 if (!kernel_ep)
267 kernel_ep = layout->kernel_ep;
268 if (!rootfs_ofs)
269 rootfs_ofs = layout->rootfs_ofs;
270
271 if (kernel_info.file_name == NULL) {
272 ERR("no kernel image specified");
273 return -1;
274 }
275
276 ret = get_file_stat(&kernel_info);
277 if (ret)
278 return ret;
279
280 kernel_len = kernel_info.file_size;
281
282 if (combined) {
283 if (kernel_info.file_size >
284 layout->fw_max_len - sizeof(struct fw_header)) {
285 ERR("kernel image is too big");
286 return -1;
287 }
288 } else {
289 if (rootfs_info.file_name == NULL) {
290 ERR("no rootfs image specified");
291 return -1;
292 }
293
294 ret = get_file_stat(&rootfs_info);
295 if (ret)
296 return ret;
297
298 if (rootfs_align) {
299 kernel_len += sizeof(struct fw_header);
300 rootfs_ofs = ALIGN(kernel_len, rootfs_align);
301 kernel_len -= sizeof(struct fw_header);
302
303 DBG("rootfs offset aligned to 0x%u", rootfs_ofs);
304
305 if (kernel_len + rootfs_info.file_size >
306 layout->fw_max_len - sizeof(struct fw_header)) {
307 ERR("images are too big");
308 return -1;
309 }
310 } else {
311 if (kernel_info.file_size >
312 rootfs_ofs - sizeof(struct fw_header)) {
313 ERR("kernel image is too big");
314 return -1;
315 }
316
317 if (rootfs_info.file_size >
318 (layout->fw_max_len - rootfs_ofs)) {
319 ERR("rootfs image is too big");
320 return -1;
321 }
322 }
323 }
324
325 if (ofname == NULL) {
326 ERR("no output file specified");
327 return -1;
328 }
329
330 ret = sscanf(fw_ver, "%d.%d.%d", &fw_ver_hi, &fw_ver_mid, &fw_ver_lo);
331 if (ret != 3) {
332 ERR("invalid firmware version '%s'", fw_ver);
333 return -1;
334 }
335
336 ret = sscanf(sver, "%d.%d", &sver_hi, &sver_lo);
337 if (ret != 2) {
338 ERR("invalid secondary version '%s'", sver);
339 return -1;
340 }
341
342 return 0;
343 }
344
345 void fill_header(char *buf, int len)
346 {
347 struct fw_header *hdr = (struct fw_header *)buf;
348 unsigned ver_len;
349
350 memset(hdr, '\xff', sizeof(struct fw_header));
351
352 hdr->version = htonl(bswap_32(hdr_ver));
353 ver_len = strlen(version);
354 if (ver_len > (sizeof(hdr->fw_version) - 1))
355 ver_len = sizeof(hdr->fw_version) - 1;
356
357 memcpy(hdr->fw_version, version, ver_len);
358 hdr->fw_version[ver_len] = 0;
359
360 hdr->hw_id = htonl(board->hw_id);
361 hdr->hw_rev = htonl(board->hw_rev);
362 hdr->hw_ver_add = htonl(board->hw_ver_add);
363
364 if (boot_info.file_size == 0) {
365 memcpy(hdr->md5sum1, md5salt_normal, sizeof(hdr->md5sum1));
366 hdr->boot_ofs = htonl(0);
367 hdr->boot_len = htonl(0);
368 } else {
369 memcpy(hdr->md5sum1, md5salt_boot, sizeof(hdr->md5sum1));
370 hdr->boot_ofs = htonl(rootfs_ofs + rootfs_info.file_size);
371 hdr->boot_len = htonl(rootfs_info.file_size);
372 }
373
374 hdr->kernel_la = htonl(kernel_la);
375 hdr->kernel_ep = htonl(kernel_ep);
376 hdr->fw_length = htonl(layout->fw_max_len);
377 hdr->kernel_ofs = htonl(sizeof(struct fw_header));
378 hdr->kernel_len = htonl(kernel_len);
379 if (!combined) {
380 hdr->rootfs_ofs = htonl(rootfs_ofs);
381 hdr->rootfs_len = htonl(rootfs_info.file_size);
382 }
383
384 hdr->boot_ofs = htonl(0);
385 hdr->boot_len = htonl(boot_info.file_size);
386
387 hdr->unk2 = htonl(0);
388 hdr->unk3 = htonl(0xffffffff);
389 hdr->unk4 = htons(0x55aa);
390 hdr->unk5 = 0xa5;
391
392 hdr->sver_hi = sver_hi;
393 hdr->sver_lo = sver_lo;
394
395 hdr->ver_hi = fw_ver_hi;
396 hdr->ver_mid = fw_ver_mid;
397 hdr->ver_lo = fw_ver_lo;
398
399 if (board->flags & FLAG_LE_KERNEL_LA_EP) {
400 hdr->kernel_la = bswap_32(hdr->kernel_la);
401 hdr->kernel_ep = bswap_32(hdr->kernel_ep);
402 }
403
404 get_md5(buf, len, hdr->md5sum1);
405 }
406
407 static int inspect_fw(void)
408 {
409 char *buf;
410 struct fw_header *hdr;
411 uint8_t md5sum[MD5SUM_LEN];
412 struct board_info *board;
413 int ret = EXIT_FAILURE;
414
415 buf = malloc(inspect_info.file_size);
416 if (!buf) {
417 ERR("no memory for buffer!\n");
418 goto out;
419 }
420
421 ret = read_to_buf(&inspect_info, buf);
422 if (ret)
423 goto out_free_buf;
424 hdr = (struct fw_header *)buf;
425
426 board = &custom_board;
427
428 if (board->flags & FLAG_LE_KERNEL_LA_EP) {
429 hdr->kernel_la = bswap_32(hdr->kernel_la);
430 hdr->kernel_ep = bswap_32(hdr->kernel_ep);
431 }
432
433 inspect_fw_pstr("File name", inspect_info.file_name);
434 inspect_fw_phexdec("File size", inspect_info.file_size);
435
436 switch(bswap_32(ntohl(hdr->version))) {
437 case 2:
438 case 3:
439 break;
440 default:
441 ERR("file does not seem to have V2/V3 header!\n");
442 goto out_free_buf;
443 }
444
445 inspect_fw_phexdec("Version 2 Header size", sizeof(struct fw_header));
446
447 memcpy(md5sum, hdr->md5sum1, sizeof(md5sum));
448 if (ntohl(hdr->boot_len) == 0)
449 memcpy(hdr->md5sum1, md5salt_normal, sizeof(md5sum));
450 else
451 memcpy(hdr->md5sum1, md5salt_boot, sizeof(md5sum));
452 get_md5(buf, inspect_info.file_size, hdr->md5sum1);
453
454 if (memcmp(md5sum, hdr->md5sum1, sizeof(md5sum))) {
455 inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(*ERROR*)");
456 inspect_fw_pmd5sum(" --> expected", hdr->md5sum1, "");
457 } else {
458 inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(ok)");
459 }
460 if (ntohl(hdr->unk2) != 0)
461 inspect_fw_phexdec("Unknown value 2", hdr->unk2);
462 inspect_fw_pmd5sum("Header MD5Sum2", hdr->md5sum2,
463 "(purpose yet unknown, unchecked here)");
464
465 if (ntohl(hdr->unk3) != 0xffffffff)
466 inspect_fw_phexdec("Unknown value 3", hdr->unk3);
467
468 if (ntohs(hdr->unk4) != 0x55aa)
469 inspect_fw_phexdec("Unknown value 4", hdr->unk4);
470
471 if (hdr->unk5 != 0xa5)
472 inspect_fw_phexdec("Unknown value 5", hdr->unk5);
473
474 printf("\n");
475
476 inspect_fw_pstr("Firmware version", hdr->fw_version);
477 inspect_fw_phex("Hardware ID", ntohl(hdr->hw_id));
478 inspect_fw_phex("Hardware Revision",
479 ntohl(hdr->hw_rev));
480 inspect_fw_phex("Additional HW Version",
481 ntohl(hdr->hw_ver_add));
482
483 printf("%-23s: %d.%d.%d-%d.%d\n", "Software version",
484 hdr->ver_hi, hdr->ver_mid, hdr->ver_lo,
485 hdr->sver_hi, hdr->sver_lo);
486
487 printf("\n");
488
489 inspect_fw_phexdec("Kernel data offset",
490 ntohl(hdr->kernel_ofs));
491 inspect_fw_phexdec("Kernel data length",
492 ntohl(hdr->kernel_len));
493 inspect_fw_phex("Kernel load address",
494 ntohl(hdr->kernel_la));
495 inspect_fw_phex("Kernel entry point",
496 ntohl(hdr->kernel_ep));
497 inspect_fw_phexdec("Rootfs data offset",
498 ntohl(hdr->rootfs_ofs));
499 inspect_fw_phexdec("Rootfs data length",
500 ntohl(hdr->rootfs_len));
501 inspect_fw_phexdec("Boot loader data offset",
502 ntohl(hdr->boot_ofs));
503 inspect_fw_phexdec("Boot loader data length",
504 ntohl(hdr->boot_len));
505 inspect_fw_phexdec("Total firmware length",
506 ntohl(hdr->fw_length));
507
508 if (extract) {
509 FILE *fp;
510 char *filename;
511
512 printf("\n");
513
514 filename = malloc(strlen(inspect_info.file_name) + 8);
515 sprintf(filename, "%s-kernel", inspect_info.file_name);
516 printf("Extracting kernel to \"%s\"...\n", filename);
517 fp = fopen(filename, "w");
518 if (fp) {
519 if (!fwrite(buf + ntohl(hdr->kernel_ofs),
520 ntohl(hdr->kernel_len), 1, fp)) {
521 ERR("error in fwrite(): %s", strerror(errno));
522 }
523 fclose(fp);
524 } else {
525 ERR("error in fopen(): %s", strerror(errno));
526 }
527 free(filename);
528
529 filename = malloc(strlen(inspect_info.file_name) + 8);
530 sprintf(filename, "%s-rootfs", inspect_info.file_name);
531 printf("Extracting rootfs to \"%s\"...\n", filename);
532 fp = fopen(filename, "w");
533 if (fp) {
534 if (!fwrite(buf + ntohl(hdr->rootfs_ofs),
535 ntohl(hdr->rootfs_len), 1, fp)) {
536 ERR("error in fwrite(): %s", strerror(errno));
537 }
538 fclose(fp);
539 } else {
540 ERR("error in fopen(): %s", strerror(errno));
541 }
542 free(filename);
543 }
544
545 out_free_buf:
546 free(buf);
547 out:
548 return ret;
549 }
550
551 int main(int argc, char *argv[])
552 {
553 int ret = EXIT_FAILURE;
554
555 progname = basename(argv[0]);
556
557 while ( 1 ) {
558 int c;
559
560 c = getopt(argc, argv, "a:H:E:F:L:V:N:W:w:ci:k:r:R:o:xhsjv:y:T:e");
561 if (c == -1)
562 break;
563
564 switch (c) {
565 case 'a':
566 sscanf(optarg, "0x%x", &rootfs_align);
567 break;
568 case 'H':
569 opt_hw_id = optarg;
570 break;
571 case 'E':
572 sscanf(optarg, "0x%x", &kernel_ep);
573 break;
574 case 'F':
575 layout_id = optarg;
576 break;
577 case 'W':
578 opt_hw_rev = optarg;
579 break;
580 case 'w':
581 opt_hw_ver_add = optarg;
582 break;
583 case 'L':
584 sscanf(optarg, "0x%x", &kernel_la);
585 break;
586 case 'V':
587 version = optarg;
588 break;
589 case 'v':
590 fw_ver = optarg;
591 break;
592 case 'y':
593 sver = optarg;
594 break;
595 case 'N':
596 vendor = optarg;
597 break;
598 case 'c':
599 combined++;
600 break;
601 case 'k':
602 kernel_info.file_name = optarg;
603 break;
604 case 'r':
605 rootfs_info.file_name = optarg;
606 break;
607 case 'R':
608 sscanf(optarg, "0x%x", &rootfs_ofs);
609 break;
610 case 'o':
611 ofname = optarg;
612 break;
613 case 's':
614 strip_padding = 1;
615 break;
616 case 'i':
617 inspect_info.file_name = optarg;
618 break;
619 case 'j':
620 add_jffs2_eof = 1;
621 break;
622 case 'x':
623 extract = 1;
624 break;
625 case 'T':
626 hdr_ver = atoi(optarg);
627 break;
628 case 'e':
629 custom_board.flags = FLAG_LE_KERNEL_LA_EP;
630 break;
631 case 'h':
632 usage(EXIT_SUCCESS);
633 break;
634 default:
635 usage(EXIT_FAILURE);
636 break;
637 }
638 }
639
640 ret = check_options();
641 if (ret)
642 goto out;
643
644 if (!inspect_info.file_name)
645 ret = build_fw(sizeof(struct fw_header));
646 else
647 ret = inspect_fw();
648
649 out:
650 return ret;
651 }
652