9eb226fba83f25894fbe73185ee66557a8529498
2 * Copyright (C) 2009 Gabor Juhos <juhosg@openwrt.org>
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>
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.
18 #include <unistd.h> /* for unlink() */
20 #include <getopt.h> /* for getopt() */
27 #include <arpa/inet.h>
28 #include <netinet/in.h>
31 #include "mktplinkfw-lib.h"
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 */
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 */
61 } __attribute__ ((packed
));
63 #define FLAG_LE_KERNEL_LA_EP 0x00000001 /* Little-endian used for kernel load address & entry point */
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;
86 static struct board_info custom_board
;
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
;
95 static int fw_ver_mid
;
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
= { 0 };
111 static struct file_info inspect_info
;
112 static int extract
= 0;
114 char md5salt_normal
[MD5SUM_LEN
] = {
115 0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
116 0xdc, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x37,
119 char md5salt_boot
[MD5SUM_LEN
] = {
120 0x8c, 0xef, 0x33, 0x5f, 0xd5, 0xc5, 0xce, 0xfa,
121 0xac, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
124 static struct flash_layout layouts
[] = {
127 .fw_max_len
= 0x3d0000,
128 .kernel_la
= 0x80000000,
129 .kernel_ep
= 0x80000000,
130 .rootfs_ofs
= 0x140000,
133 .fw_max_len
= 0x7a0000,
134 .kernel_la
= 0x80002000,
135 .kernel_ep
= 0x80002000,
136 .rootfs_ofs
= 0x140000,
139 .fw_max_len
= 0xf90000,
140 .kernel_la
= 0x80002000,
141 .kernel_ep
= 0x800061b0,
142 .rootfs_ofs
= 0x140000,
145 .fw_max_len
= 0x7a0000,
146 .kernel_la
= 0x80000000,
147 .kernel_ep
= 0x80000000,
148 .rootfs_ofs
= 0x140000,
150 .id
= "8MSUmtk", /* Split U-Boot OS */
151 .fw_max_len
= 0x770000,
152 .kernel_la
= 0x80000000,
153 .kernel_ep
= 0x80000000,
154 .rootfs_ofs
= 0x140000,
157 .fw_max_len
= 0x7b0000,
158 .kernel_la
= 0x80000000,
159 .kernel_ep
= 0x80000000,
160 .rootfs_ofs
= 0x140000,
163 .fw_max_len
= 0x7a0000,
164 .kernel_la
= 0x80060000,
165 .kernel_ep
= 0x80060000,
166 .rootfs_ofs
= 0x140000,
169 .fw_max_len
= 0xf90000,
170 .kernel_la
= 0x80060000,
171 .kernel_ep
= 0x80060000,
172 .rootfs_ofs
= 0x140000,
174 /* terminating entry */
178 static void usage(int status
)
180 FILE *stream
= (status
!= EXIT_SUCCESS
) ? stderr
: stdout
;
181 struct board_info
*board
;
183 fprintf(stream
, "Usage: %s [OPTIONS...]\n", progname
);
187 " -c use combined kernel image\n"
188 " -e swap endianness in kernel load address and entry point\n"
189 " -E <ep> overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
190 " -L <la> overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
191 " -H <hwid> use hardware id specified with <hwid>\n"
192 " -W <hwrev> use hardware revision specified with <hwrev>\n"
193 " -w <hwveradd> use additional hardware version specified with <hwveradd>\n"
194 " -F <id> use flash layout specified with <id>\n"
195 " -k <file> read kernel image from the file <file>\n"
196 " -r <file> read rootfs image from the file <file>\n"
197 " -b <file> read bootloader image from the file <file>\n"
198 " -a <align> align the rootfs start on an <align> bytes boundary\n"
199 " -R <offset> overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
200 " -o <file> write output to the file <file>\n"
201 " -s strip padding from the end of the image\n"
202 " -j add jffs2 end-of-filesystem markers\n"
203 " -N <vendor> set image vendor to <vendor>\n"
204 " -T <version> set header version to <version>\n"
205 " -V <version> set image version to <version>\n"
206 " -v <version> set firmware version to <version>\n"
207 " -y <version> set secondary version to <version>\n"
208 " -i <file> inspect given firmware file <file>\n"
209 " -x extract bootloader, kernel and rootfs while inspecting (requires -i)\n"
210 " -h show this screen\n"
216 static int check_options(void)
220 if (inspect_info
.file_name
) {
221 ret
= get_file_stat(&inspect_info
);
226 } else if (extract
) {
227 ERR("no firmware for inspection specified");
231 if (opt_hw_id
== NULL
) {
232 ERR("hardware id must be specified");
236 board
= &custom_board
;
238 if (layout_id
== NULL
) {
239 ERR("flash layout is not specified");
243 board
->hw_id
= strtoul(opt_hw_id
, NULL
, 0);
246 board
->hw_ver_add
= 0;
249 board
->hw_rev
= strtoul(opt_hw_rev
, NULL
, 0);
251 board
->hw_ver_add
= strtoul(opt_hw_ver_add
, NULL
, 0);
253 layout
= find_layout(layouts
, layout_id
);
254 if (layout
== NULL
) {
255 ERR("unknown flash layout \"%s\"", layout_id
);
260 kernel_la
= layout
->kernel_la
;
262 kernel_ep
= layout
->kernel_ep
;
264 rootfs_ofs
= layout
->rootfs_ofs
;
266 /* check bootloader */
267 ret
= get_file_stat(&boot_info
);
269 ERR("Can not load bootloader image.");
273 if (boot_info
.file_size
> 2 * 64 * 1024) {
274 /* the offset in fill_header is hardcoded to 128k */
275 ERR("Bootloader image is bigger than 128k.");
279 if (kernel_info
.file_name
== NULL
) {
280 ERR("no kernel image specified");
283 ret
= get_file_stat(&kernel_info
);
287 kernel_len
= kernel_info
.file_size
;
290 if (kernel_info
.file_size
>
291 layout
->fw_max_len
- sizeof(struct fw_header
)) {
292 ERR("kernel image is too big");
296 if (rootfs_info
.file_name
== NULL
) {
297 ERR("no rootfs image specified");
301 ret
= get_file_stat(&rootfs_info
);
306 kernel_len
+= sizeof(struct fw_header
);
307 rootfs_ofs
= ALIGN(kernel_len
, rootfs_align
);
308 kernel_len
-= sizeof(struct fw_header
);
310 DBG("rootfs offset aligned to 0x%u", rootfs_ofs
);
312 if (kernel_len
+ rootfs_info
.file_size
>
313 layout
->fw_max_len
- sizeof(struct fw_header
)) {
314 ERR("images are too big");
318 if (kernel_info
.file_size
>
319 rootfs_ofs
- sizeof(struct fw_header
)) {
320 ERR("kernel image is too big");
324 if (rootfs_info
.file_size
>
325 (layout
->fw_max_len
- rootfs_ofs
)) {
326 ERR("rootfs image is too big");
332 if (ofname
== NULL
) {
333 ERR("no output file specified");
337 ret
= sscanf(fw_ver
, "%d.%d.%d", &fw_ver_hi
, &fw_ver_mid
, &fw_ver_lo
);
339 ERR("invalid firmware version '%s'", fw_ver
);
343 ret
= sscanf(sver
, "%d.%d", &sver_hi
, &sver_lo
);
345 ERR("invalid secondary version '%s'", sver
);
352 void _fill_header(char *buf
, int len
, int with_bootloader
)
354 struct fw_header
*hdr
= (struct fw_header
*)buf
;
356 unsigned int offset
= 0;
358 if (with_bootloader
) {
359 /* ensure the bootloader is padded to 64k */
360 offset
= boot_info
.file_size
& (64 * 1024);
361 if (offset
< boot_info
.file_size
)
364 offset
+= sizeof(struct fw_header
);
367 memset(hdr
, '\xff', sizeof(struct fw_header
));
369 hdr
->version
= htonl(bswap_32(hdr_ver
));
370 ver_len
= strlen(version
);
371 if (ver_len
> (sizeof(hdr
->fw_version
) - 1))
372 ver_len
= sizeof(hdr
->fw_version
) - 1;
374 memcpy(hdr
->fw_version
, version
, ver_len
);
375 hdr
->fw_version
[ver_len
] = 0;
377 hdr
->hw_id
= htonl(board
->hw_id
);
378 hdr
->hw_rev
= htonl(board
->hw_rev
);
379 hdr
->hw_ver_add
= htonl(board
->hw_ver_add
);
381 if (boot_info
.file_size
== 0 || !with_bootloader
) {
382 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(hdr
->md5sum1
));
383 hdr
->boot_ofs
= htonl(0);
384 hdr
->boot_len
= htonl(0);
386 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(hdr
->md5sum1
));
387 hdr
->boot_ofs
= htonl(0);
388 hdr
->boot_len
= htonl(boot_info
.file_size
);
391 hdr
->kernel_la
= htonl(kernel_la
);
392 hdr
->kernel_ep
= htonl(kernel_ep
);
393 hdr
->fw_length
= htonl(layout
->fw_max_len
+ offset
);
394 hdr
->kernel_ofs
= htonl(sizeof(struct fw_header
) + offset
);
395 hdr
->kernel_len
= htonl(kernel_len
);
397 /* even the bootloader doesnt increased the root_ofs. Unsure if this parser
398 * always ignores the rootfs or only in the 841v13
400 hdr
->rootfs_ofs
= htonl(rootfs_ofs
);
401 hdr
->rootfs_len
= htonl(rootfs_info
.file_size
);
404 hdr
->unk2
= htonl(0);
405 hdr
->unk3
= htonl(0xffffffff);
406 hdr
->unk4
= htons(0x55aa);
409 hdr
->sver_hi
= sver_hi
;
410 hdr
->sver_lo
= sver_lo
;
412 hdr
->ver_hi
= fw_ver_hi
;
413 hdr
->ver_mid
= fw_ver_mid
;
414 hdr
->ver_lo
= fw_ver_lo
;
416 if (board
->flags
& FLAG_LE_KERNEL_LA_EP
) {
417 hdr
->kernel_la
= bswap_32(hdr
->kernel_la
);
418 hdr
->kernel_ep
= bswap_32(hdr
->kernel_ep
);
421 get_md5(buf
, len
, hdr
->md5sum1
);
424 /* fill_header get called by mktplinkfw_lib to fill the header in front of the kernel. */
425 void fill_header(char *buf
, int len
) {
426 _fill_header(buf
, len
, 0);
429 static int inspect_fw(void)
432 struct fw_header
*hdr
;
433 uint8_t md5sum
[MD5SUM_LEN
];
434 struct board_info
*board
;
435 int ret
= EXIT_FAILURE
;
437 buf
= malloc(inspect_info
.file_size
);
439 ERR("no memory for buffer!\n");
443 ret
= read_to_buf(&inspect_info
, buf
);
446 hdr
= (struct fw_header
*)buf
;
448 board
= &custom_board
;
450 if (board
->flags
& FLAG_LE_KERNEL_LA_EP
) {
451 hdr
->kernel_la
= bswap_32(hdr
->kernel_la
);
452 hdr
->kernel_ep
= bswap_32(hdr
->kernel_ep
);
455 inspect_fw_pstr("File name", inspect_info
.file_name
);
456 inspect_fw_phexdec("File size", inspect_info
.file_size
);
458 switch(bswap_32(ntohl(hdr
->version
))) {
463 ERR("file does not seem to have V2/V3 header!\n");
467 inspect_fw_phexdec("Version 2 Header size", sizeof(struct fw_header
));
469 memcpy(md5sum
, hdr
->md5sum1
, sizeof(md5sum
));
470 if (ntohl(hdr
->boot_len
) == 0)
471 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(md5sum
));
473 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(md5sum
));
474 get_md5(buf
, inspect_info
.file_size
, hdr
->md5sum1
);
476 if (memcmp(md5sum
, hdr
->md5sum1
, sizeof(md5sum
))) {
477 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(*ERROR*)");
478 inspect_fw_pmd5sum(" --> expected", hdr
->md5sum1
, "");
480 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(ok)");
482 if (ntohl(hdr
->unk2
) != 0)
483 inspect_fw_phexdec("Unknown value 2", hdr
->unk2
);
484 inspect_fw_pmd5sum("Header MD5Sum2", hdr
->md5sum2
,
485 "(purpose yet unknown, unchecked here)");
487 if (ntohl(hdr
->unk3
) != 0xffffffff)
488 inspect_fw_phexdec("Unknown value 3", hdr
->unk3
);
490 if (ntohs(hdr
->unk4
) != 0x55aa)
491 inspect_fw_phexdec("Unknown value 4", hdr
->unk4
);
493 if (hdr
->unk5
!= 0xa5)
494 inspect_fw_phexdec("Unknown value 5", hdr
->unk5
);
498 inspect_fw_pstr("Firmware version", hdr
->fw_version
);
499 inspect_fw_phex("Hardware ID", ntohl(hdr
->hw_id
));
500 inspect_fw_phex("Hardware Revision",
502 inspect_fw_phex("Additional HW Version",
503 ntohl(hdr
->hw_ver_add
));
505 printf("%-23s: %d.%d.%d-%d.%d\n", "Software version",
506 hdr
->ver_hi
, hdr
->ver_mid
, hdr
->ver_lo
,
507 hdr
->sver_hi
, hdr
->sver_lo
);
511 inspect_fw_phexdec("Kernel data offset",
512 ntohl(hdr
->kernel_ofs
));
513 inspect_fw_phexdec("Kernel data length",
514 ntohl(hdr
->kernel_len
));
515 inspect_fw_phex("Kernel load address",
516 ntohl(hdr
->kernel_la
));
517 inspect_fw_phex("Kernel entry point",
518 ntohl(hdr
->kernel_ep
));
519 inspect_fw_phexdec("Rootfs data offset",
520 ntohl(hdr
->rootfs_ofs
));
521 inspect_fw_phexdec("Rootfs data length",
522 ntohl(hdr
->rootfs_len
));
523 inspect_fw_phexdec("Boot loader data offset",
524 ntohl(hdr
->boot_ofs
));
525 inspect_fw_phexdec("Boot loader data length",
526 ntohl(hdr
->boot_len
));
527 inspect_fw_phexdec("Total firmware length",
528 ntohl(hdr
->fw_length
));
537 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
538 sprintf(filename
, "%s-bootloader", inspect_info
.file_name
);
539 printf("Extracting bootloader to \"%s\"...\n", filename
);
540 fp
= fopen(filename
, "w");
542 if (!fwrite(buf
+ sizeof(struct fw_header
) + ntohl(hdr
->boot_ofs
),
543 ntohl(hdr
->boot_len
), 1, fp
)) {
544 ERR("error in fwrite(): %s", strerror(errno
));
548 ERR("error in fopen(): %s", strerror(errno
));
553 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
554 sprintf(filename
, "%s-kernel", inspect_info
.file_name
);
555 printf("Extracting kernel to \"%s\"...\n", filename
);
556 fp
= fopen(filename
, "w");
558 if (!fwrite(buf
+ ntohl(hdr
->kernel_ofs
),
559 ntohl(hdr
->kernel_len
), 1, fp
)) {
560 ERR("error in fwrite(): %s", strerror(errno
));
564 ERR("error in fopen(): %s", strerror(errno
));
568 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
569 sprintf(filename
, "%s-rootfs", inspect_info
.file_name
);
570 printf("Extracting rootfs to \"%s\"...\n", filename
);
571 fp
= fopen(filename
, "w");
573 if (!fwrite(buf
+ ntohl(hdr
->rootfs_ofs
),
574 ntohl(hdr
->rootfs_len
), 1, fp
)) {
575 ERR("error in fwrite(): %s", strerror(errno
));
579 ERR("error in fopen(): %s", strerror(errno
));
590 /* prepend a second image header and the bootloader.
606 * The padding is optional. The second image header should begin a 64k boundary.
608 int prepend_bootloader() {
609 unsigned int buflen
= 0;
610 int ret
= 0, bootloader_padded
= 0;
611 char *buf
= 0, *p
= 0;
612 struct file_info image
;
614 /* calculate blocks to ensure padding */
615 bootloader_padded
= boot_info
.file_size
& (64 * 1024);
616 if (bootloader_padded
< boot_info
.file_size
)
617 bootloader_padded
+= 64 * 1024;
619 image
.file_name
= ofname
;
620 ret
= get_file_stat(&image
);
622 ERR("Can not load the output image");
626 buflen
= image
.file_size
+ bootloader_padded
+ sizeof(struct fw_header
);
627 buf
= malloc(buflen
);
629 ERR("Can not allocate buffer %d bytes", buflen
);
632 memset(buf
, 0xff, buflen
);
635 p
= buf
+ bootloader_padded
+ sizeof(struct fw_header
);
636 ret
= read_to_buf(&image
, p
);
638 ERR("Can not read output image");
642 p
= buf
+ sizeof(struct fw_header
);
643 ret
= read_to_buf(&boot_info
, p
);
645 _fill_header(buf
, buflen
, 1);
647 ret
= write_fw(ofname
, buf
, buflen
);
659 int main(int argc
, char *argv
[])
661 int ret
= EXIT_FAILURE
;
663 progname
= basename(argv
[0]);
668 c
= getopt(argc
, argv
, "a:b:H:E:F:L:V:N:W:w:ci:k:r:R:o:xhsjv:y:T:e");
674 sscanf(optarg
, "0x%x", &rootfs_align
);
677 boot_info
.file_name
= optarg
;
683 sscanf(optarg
, "0x%x", &kernel_ep
);
692 opt_hw_ver_add
= optarg
;
695 sscanf(optarg
, "0x%x", &kernel_la
);
713 kernel_info
.file_name
= optarg
;
716 rootfs_info
.file_name
= optarg
;
719 sscanf(optarg
, "0x%x", &rootfs_ofs
);
728 inspect_info
.file_name
= optarg
;
737 hdr_ver
= atoi(optarg
);
740 custom_board
.flags
= FLAG_LE_KERNEL_LA_EP
;
751 ret
= check_options();
755 if (!inspect_info
.file_name
) {
756 ret
= build_fw(sizeof(struct fw_header
));
757 if (ret
== 0 && boot_info
.file_size
> 0)
758 ret
= prepend_bootloader();