92775290f816f95d461829ad9eb55439d54d82f6
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>
32 #define ALIGN(x,a) ({ typeof(a) __a = (a); (((x) + __a - 1) & ~(__a - 1)); })
37 char *file_name
; /* name of the file */
38 uint32_t file_size
; /* length of the file */
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 unk1
; /* 0x3c: 0x00000000 */
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 */
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: FIXME: seems to be unused */
60 uint32_t boot_len
; /* 0x88: FIXME: seems to be unused */
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 */
69 } __attribute__ ((packed
));
92 static char *progname
;
93 static char *vendor
= "TP-LINK Technologies";
94 static char *version
= "ver. 1.0";
95 static char *fw_ver
= "0.0.0";
96 static char *sver
= "1.0";
97 static uint32_t hdr_ver
= 2;
99 static char *board_id
;
100 static struct board_info
*board
;
101 static char *layout_id
;
102 static struct flash_layout
*layout
;
103 static char *opt_hw_id
;
104 static uint32_t hw_id
;
105 static char *opt_hw_rev
;
106 static uint32_t hw_rev
;
107 static int fw_ver_lo
;
108 static int fw_ver_mid
;
109 static int fw_ver_hi
;
112 static struct file_info kernel_info
;
113 static uint32_t kernel_la
= 0;
114 static uint32_t kernel_ep
= 0;
115 static uint32_t kernel_len
= 0;
116 static struct file_info rootfs_info
;
117 static uint32_t rootfs_ofs
= 0;
118 static uint32_t rootfs_align
;
119 static struct file_info boot_info
;
121 static int strip_padding
;
122 static int add_jffs2_eof
;
123 static unsigned char jffs2_eof_mark
[4] = {0xde, 0xad, 0xc0, 0xde};
125 static struct file_info inspect_info
;
126 static int extract
= 0;
127 static bool endian_swap
= false;
129 char md5salt_normal
[MD5SUM_LEN
] = {
130 0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
131 0xdc, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x37,
134 char md5salt_boot
[MD5SUM_LEN
] = {
135 0x8c, 0xef, 0x33, 0x5b, 0xd5, 0xc5, 0xce, 0xfa,
136 0xa7, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
139 static struct flash_layout layouts
[] = {
142 .fw_max_len
= 0x7a0000,
143 .kernel_la
= 0x80002000,
144 .kernel_ep
= 0x80002000,
145 .rootfs_ofs
= 0x140000,
148 .fw_max_len
= 0x7a0000,
149 .kernel_la
= 0x80000000,
150 .kernel_ep
= 0x80000000,
151 .rootfs_ofs
= 0x140000,
153 /* terminating entry */
157 static struct board_info boards
[] = {
162 .layout_id
= "8Mltq",
167 .layout_id
= "8Mltq",
172 .layout_id
= "8Mmtk",
176 /* terminating entry */
183 #define ERR(fmt, ...) do { \
185 fprintf(stderr, "[%s] *** error: " fmt "\n", \
186 progname, ## __VA_ARGS__ ); \
189 #define ERRS(fmt, ...) do { \
192 fprintf(stderr, "[%s] *** error: " fmt ": %s\n", \
193 progname, ## __VA_ARGS__, strerror(save)); \
196 #define DBG(fmt, ...) do { \
197 fprintf(stderr, "[%s] " fmt "\n", progname, ## __VA_ARGS__ ); \
200 static struct board_info
*find_board(char *id
)
202 struct board_info
*ret
;
203 struct board_info
*board
;
206 for (board
= boards
; board
->id
!= NULL
; board
++){
207 if (strcasecmp(id
, board
->id
) == 0) {
216 static struct board_info
*find_board_by_hwid(uint32_t hw_id
)
218 struct board_info
*board
;
220 for (board
= boards
; board
->id
!= NULL
; board
++) {
221 if (hw_id
== board
->hw_id
)
228 static struct flash_layout
*find_layout(char *id
)
230 struct flash_layout
*ret
;
231 struct flash_layout
*l
;
234 for (l
= layouts
; l
->id
!= NULL
; l
++){
235 if (strcasecmp(id
, l
->id
) == 0) {
244 static void usage(int status
)
246 FILE *stream
= (status
!= EXIT_SUCCESS
) ? stderr
: stdout
;
247 struct board_info
*board
;
249 fprintf(stream
, "Usage: %s [OPTIONS...]\n", progname
);
253 " -B <board> create image for the board specified with <board>\n"
254 " -c use combined kernel image\n"
255 " -E <ep> overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
256 " -L <la> overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
257 " -H <hwid> use hardware id specified with <hwid>\n"
258 " -W <hwrev> use hardware revision specified with <hwrev>\n"
259 " -F <id> use flash layout specified with <id>\n"
260 " -k <file> read kernel image from the file <file>\n"
261 " -r <file> read rootfs image from the file <file>\n"
262 " -a <align> align the rootfs start on an <align> bytes boundary\n"
263 " -R <offset> overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
264 " -o <file> write output to the file <file>\n"
265 " -s strip padding from the end of the image\n"
266 " -j add jffs2 end-of-filesystem markers\n"
267 " -V <version> set image version to <version>\n"
268 " -v <version> set firmware version to <version>\n"
269 " -y <version> set secondary version to <version>\n"
270 " -i <file> inspect given firmware file <file>\n"
271 " -x extract kernel and rootfs while inspecting (requires -i)\n"
272 " -h show this screen\n"
278 static int get_md5(char *data
, int size
, char *md5
)
283 MD5_Update(&ctx
, data
, size
);
284 MD5_Final(md5
, &ctx
);
287 static int get_file_stat(struct file_info
*fdata
)
292 if (fdata
->file_name
== NULL
)
295 res
= stat(fdata
->file_name
, &st
);
297 ERRS("stat failed on %s", fdata
->file_name
);
301 fdata
->file_size
= st
.st_size
;
305 static int read_to_buf(struct file_info
*fdata
, char *buf
)
308 int ret
= EXIT_FAILURE
;
310 f
= fopen(fdata
->file_name
, "r");
312 ERRS("could not open \"%s\" for reading", fdata
->file_name
);
317 fread(buf
, fdata
->file_size
, 1, f
);
319 ERRS("unable to read from file \"%s\"", fdata
->file_name
);
331 static int check_options(void)
335 if (inspect_info
.file_name
) {
336 ret
= get_file_stat(&inspect_info
);
341 } else if (extract
) {
342 ERR("no firmware for inspection specified");
346 if (board_id
== NULL
&& opt_hw_id
== NULL
) {
347 ERR("either board or hardware id must be specified");
352 board
= find_board(board_id
);
354 ERR("unknown/unsupported board id \"%s\"", board_id
);
357 if (layout_id
== NULL
)
358 layout_id
= board
->layout_id
;
360 hw_id
= board
->hw_id
;
361 hw_rev
= board
->hw_rev
;
363 hdr_ver
= board
->hdr_ver
;
364 endian_swap
= board
->endian_swap
;
366 if (layout_id
== NULL
) {
367 ERR("flash layout is not specified");
370 hw_id
= strtoul(opt_hw_id
, NULL
, 0);
373 hw_rev
= strtoul(opt_hw_rev
, NULL
, 0);
378 layout
= find_layout(layout_id
);
379 if (layout
== NULL
) {
380 ERR("unknown flash layout \"%s\"", layout_id
);
385 kernel_la
= layout
->kernel_la
;
387 kernel_ep
= layout
->kernel_ep
;
389 rootfs_ofs
= layout
->rootfs_ofs
;
391 if (kernel_info
.file_name
== NULL
) {
392 ERR("no kernel image specified");
396 ret
= get_file_stat(&kernel_info
);
400 kernel_len
= kernel_info
.file_size
;
403 if (kernel_info
.file_size
>
404 layout
->fw_max_len
- sizeof(struct fw_header
)) {
405 ERR("kernel image is too big");
409 if (rootfs_info
.file_name
== NULL
) {
410 ERR("no rootfs image specified");
414 ret
= get_file_stat(&rootfs_info
);
419 kernel_len
+= sizeof(struct fw_header
);
420 kernel_len
= ALIGN(kernel_len
, rootfs_align
);
421 kernel_len
-= sizeof(struct fw_header
);
423 DBG("kernel length aligned to %u", kernel_len
);
425 if (kernel_len
+ rootfs_info
.file_size
>
426 layout
->fw_max_len
- sizeof(struct fw_header
)) {
427 ERR("images are too big");
431 if (kernel_info
.file_size
>
432 rootfs_ofs
- sizeof(struct fw_header
)) {
433 ERR("kernel image is too big");
437 if (rootfs_info
.file_size
>
438 (layout
->fw_max_len
- rootfs_ofs
)) {
439 ERR("rootfs image is too big");
445 if (ofname
== NULL
) {
446 ERR("no output file specified");
450 ret
= sscanf(fw_ver
, "%d.%d.%d", &fw_ver_hi
, &fw_ver_mid
, &fw_ver_lo
);
452 ERR("invalid firmware version '%s'", fw_ver
);
456 ret
= sscanf(sver
, "%d.%d", &sver_hi
, &sver_lo
);
458 ERR("invalid secondary version '%s'", sver
);
465 static void fill_header(char *buf
, int len
)
467 struct fw_header
*hdr
= (struct fw_header
*)buf
;
470 memset(hdr
, '\xff', sizeof(struct fw_header
));
472 hdr
->version
= htonl(bswap_32(hdr_ver
));
473 ver_len
= strlen(version
);
474 if (ver_len
> (sizeof(hdr
->fw_version
) - 1))
475 ver_len
= sizeof(hdr
->fw_version
) - 1;
477 memcpy(hdr
->fw_version
, version
, ver_len
);
478 hdr
->fw_version
[ver_len
] = 0;
480 hdr
->hw_id
= htonl(hw_id
);
481 hdr
->hw_rev
= htonl(hw_rev
);
483 if (boot_info
.file_size
== 0) {
484 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(hdr
->md5sum1
));
485 hdr
->boot_ofs
= htonl(0);
486 hdr
->boot_len
= htonl(0);
488 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(hdr
->md5sum1
));
489 hdr
->boot_ofs
= htonl(rootfs_ofs
+ rootfs_info
.file_size
);
490 hdr
->boot_len
= htonl(rootfs_info
.file_size
);
493 hdr
->kernel_la
= htonl(kernel_la
);
494 hdr
->kernel_ep
= htonl(kernel_ep
);
495 hdr
->fw_length
= htonl(layout
->fw_max_len
);
496 hdr
->kernel_ofs
= htonl(sizeof(struct fw_header
));
497 hdr
->kernel_len
= htonl(kernel_len
);
499 hdr
->rootfs_ofs
= htonl(rootfs_ofs
);
500 hdr
->rootfs_len
= htonl(rootfs_info
.file_size
);
503 hdr
->boot_ofs
= htonl(0);
504 hdr
->boot_len
= htonl(boot_info
.file_size
);
506 hdr
->unk1
= htonl(0);
507 hdr
->unk2
= htonl(0);
508 hdr
->unk3
= htonl(0xffffffff);
509 hdr
->unk4
= htons(0x55aa);
512 hdr
->sver_hi
= sver_hi
;
513 hdr
->sver_lo
= sver_lo
;
515 hdr
->ver_hi
= fw_ver_hi
;
516 hdr
->ver_mid
= fw_ver_mid
;
517 hdr
->ver_lo
= fw_ver_lo
;
520 hdr
->kernel_la
= bswap_32(hdr
->kernel_la
);
521 hdr
->kernel_ep
= bswap_32(hdr
->kernel_ep
);
524 get_md5(buf
, len
, hdr
->md5sum1
);
527 static int pad_jffs2(char *buf
, int currlen
)
533 pad_mask
= (64 * 1024);
534 while ((len
< layout
->fw_max_len
) && (pad_mask
!= 0)) {
538 for (i
= 10; i
< 32; i
++) {
544 len
= ALIGN(len
, mask
);
546 for (i
= 10; i
< 32; i
++) {
548 if ((len
& (mask
- 1)) == 0)
552 for (i
= 0; i
< sizeof(jffs2_eof_mark
); i
++)
553 buf
[len
+ i
] = jffs2_eof_mark
[i
];
555 len
+= sizeof(jffs2_eof_mark
);
561 static int write_fw(char *data
, int len
)
564 int ret
= EXIT_FAILURE
;
566 f
= fopen(ofname
, "w");
568 ERRS("could not open \"%s\" for writing", ofname
);
573 fwrite(data
, len
, 1, f
);
575 ERRS("unable to write output file");
579 DBG("firmware file \"%s\" completed", ofname
);
586 if (ret
!= EXIT_SUCCESS
) {
593 static int build_fw(void)
598 int ret
= EXIT_FAILURE
;
601 buflen
= layout
->fw_max_len
;
603 buf
= malloc(buflen
);
605 ERR("no memory for buffer\n");
609 memset(buf
, 0xff, buflen
);
610 p
= buf
+ sizeof(struct fw_header
);
611 ret
= read_to_buf(&kernel_info
, p
);
615 writelen
= sizeof(struct fw_header
) + kernel_len
;
621 p
= buf
+ rootfs_ofs
;
623 ret
= read_to_buf(&rootfs_info
, p
);
628 writelen
+= rootfs_info
.file_size
;
630 writelen
= rootfs_ofs
+ rootfs_info
.file_size
;
633 writelen
= pad_jffs2(buf
, writelen
);
639 fill_header(buf
, writelen
);
640 ret
= write_fw(buf
, writelen
);
652 /* Helper functions to inspect_fw() representing different output formats */
653 static inline void inspect_fw_pstr(char *label
, char *str
)
655 printf("%-23s: %s\n", label
, str
);
658 static inline void inspect_fw_phex(char *label
, uint32_t val
)
660 printf("%-23s: 0x%08x\n", label
, val
);
663 static inline void inspect_fw_phexpost(char *label
,
664 uint32_t val
, char *post
)
666 printf("%-23s: 0x%08x (%s)\n", label
, val
, post
);
669 static inline void inspect_fw_phexdef(char *label
,
670 uint32_t val
, uint32_t defval
)
672 printf("%-23s: 0x%08x ", label
, val
);
675 printf("(== OpenWrt default)\n");
677 printf("(OpenWrt default: 0x%08x)\n", defval
);
680 static inline void inspect_fw_phexexp(char *label
,
681 uint32_t val
, uint32_t expval
)
683 printf("%-23s: 0x%08x ", label
, val
);
688 printf("(expected: 0x%08x)\n", expval
);
691 static inline void inspect_fw_phexdec(char *label
, uint32_t val
)
693 printf("%-23s: 0x%08x / %8u bytes\n", label
, val
, val
);
696 static inline void inspect_fw_phexdecdef(char *label
,
697 uint32_t val
, uint32_t defval
)
699 printf("%-23s: 0x%08x / %8u bytes ", label
, val
, val
);
702 printf("(== OpenWrt default)\n");
704 printf("(OpenWrt default: 0x%08x)\n", defval
);
707 static inline void inspect_fw_pmd5sum(char *label
, uint8_t *val
, char *text
)
711 printf("%-23s:", label
);
712 for (i
=0; i
<MD5SUM_LEN
; i
++)
713 printf(" %02x", val
[i
]);
714 printf(" %s\n", text
);
717 static int inspect_fw(void)
720 struct fw_header
*hdr
;
721 uint8_t md5sum
[MD5SUM_LEN
];
722 struct board_info
*board
;
723 int ret
= EXIT_FAILURE
;
725 buf
= malloc(inspect_info
.file_size
);
727 ERR("no memory for buffer!\n");
731 ret
= read_to_buf(&inspect_info
, buf
);
734 hdr
= (struct fw_header
*)buf
;
736 inspect_fw_pstr("File name", inspect_info
.file_name
);
737 inspect_fw_phexdec("File size", inspect_info
.file_size
);
739 switch(bswap_32(ntohl(hdr
->version
))) {
744 ERR("file does not seem to have V2/V3 header!\n");
748 inspect_fw_phexdec("Version 2 Header size", sizeof(struct fw_header
));
750 if (ntohl(hdr
->unk1
) != 0)
751 inspect_fw_phexdec("Unknown value 1", hdr
->unk1
);
753 memcpy(md5sum
, hdr
->md5sum1
, sizeof(md5sum
));
754 if (ntohl(hdr
->boot_len
) == 0)
755 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(md5sum
));
757 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(md5sum
));
758 get_md5(buf
, inspect_info
.file_size
, hdr
->md5sum1
);
760 if (memcmp(md5sum
, hdr
->md5sum1
, sizeof(md5sum
))) {
761 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(*ERROR*)");
762 inspect_fw_pmd5sum(" --> expected", hdr
->md5sum1
, "");
764 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(ok)");
766 if (ntohl(hdr
->unk2
) != 0)
767 inspect_fw_phexdec("Unknown value 2", hdr
->unk2
);
768 inspect_fw_pmd5sum("Header MD5Sum2", hdr
->md5sum2
,
769 "(purpose yet unknown, unchecked here)");
771 if (ntohl(hdr
->unk3
) != 0xffffffff)
772 inspect_fw_phexdec("Unknown value 3", hdr
->unk3
);
774 if (ntohs(hdr
->unk4
) != 0x55aa)
775 inspect_fw_phexdec("Unknown value 4", hdr
->unk4
);
777 if (hdr
->unk5
!= 0xa5)
778 inspect_fw_phexdec("Unknown value 5", hdr
->unk5
);
782 inspect_fw_pstr("Firmware version", hdr
->fw_version
);
784 board
= find_board_by_hwid(ntohl(hdr
->hw_id
));
786 layout
= find_layout(board
->layout_id
);
787 inspect_fw_phexpost("Hardware ID",
788 ntohl(hdr
->hw_id
), board
->id
);
789 inspect_fw_phexexp("Hardware Revision",
790 ntohl(hdr
->hw_rev
), board
->hw_rev
);
792 inspect_fw_phexpost("Hardware ID",
793 ntohl(hdr
->hw_id
), "unknown");
794 inspect_fw_phex("Hardware Revision",
798 printf("%-23s: %d.%d.%d-%d.%d\n", "Software version",
799 hdr
->ver_hi
, hdr
->ver_mid
, hdr
->ver_lo
,
800 hdr
->sver_hi
, hdr
->sver_lo
);
804 inspect_fw_phexdec("Kernel data offset",
805 ntohl(hdr
->kernel_ofs
));
806 inspect_fw_phexdec("Kernel data length",
807 ntohl(hdr
->kernel_len
));
809 inspect_fw_phexdef("Kernel load address",
810 ntohl(hdr
->kernel_la
),
811 layout
? layout
->kernel_la
: 0xffffffff);
812 inspect_fw_phexdef("Kernel entry point",
813 ntohl(hdr
->kernel_ep
),
814 layout
? layout
->kernel_ep
: 0xffffffff);
815 inspect_fw_phexdecdef("Rootfs data offset",
816 ntohl(hdr
->rootfs_ofs
),
817 layout
? layout
->rootfs_ofs
: 0xffffffff);
819 inspect_fw_phex("Kernel load address",
820 ntohl(hdr
->kernel_la
));
821 inspect_fw_phex("Kernel entry point",
822 ntohl(hdr
->kernel_ep
));
823 inspect_fw_phexdec("Rootfs data offset",
824 ntohl(hdr
->rootfs_ofs
));
826 inspect_fw_phexdec("Rootfs data length",
827 ntohl(hdr
->rootfs_len
));
828 inspect_fw_phexdec("Boot loader data offset",
829 ntohl(hdr
->boot_ofs
));
830 inspect_fw_phexdec("Boot loader data length",
831 ntohl(hdr
->boot_len
));
832 inspect_fw_phexdec("Total firmware length",
833 ntohl(hdr
->fw_length
));
841 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
842 sprintf(filename
, "%s-kernel", inspect_info
.file_name
);
843 printf("Extracting kernel to \"%s\"...\n", filename
);
844 fp
= fopen(filename
, "w");
846 if (!fwrite(buf
+ ntohl(hdr
->kernel_ofs
),
847 ntohl(hdr
->kernel_len
), 1, fp
)) {
848 ERR("error in fwrite(): %s", strerror(errno
));
852 ERR("error in fopen(): %s", strerror(errno
));
856 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
857 sprintf(filename
, "%s-rootfs", inspect_info
.file_name
);
858 printf("Extracting rootfs to \"%s\"...\n", filename
);
859 fp
= fopen(filename
, "w");
861 if (!fwrite(buf
+ ntohl(hdr
->rootfs_ofs
),
862 ntohl(hdr
->rootfs_len
), 1, fp
)) {
863 ERR("error in fwrite(): %s", strerror(errno
));
867 ERR("error in fopen(): %s", strerror(errno
));
878 int main(int argc
, char *argv
[])
880 int ret
= EXIT_FAILURE
;
885 progname
= basename(argv
[0]);
890 c
= getopt(argc
, argv
, "a:B:H:E:F:L:V:N:W:ci:k:r:R:o:xhsjv:y:T:e");
896 sscanf(optarg
, "0x%x", &rootfs_align
);
905 sscanf(optarg
, "0x%x", &kernel_ep
);
914 sscanf(optarg
, "0x%x", &kernel_la
);
932 kernel_info
.file_name
= optarg
;
935 rootfs_info
.file_name
= optarg
;
938 sscanf(optarg
, "0x%x", &rootfs_ofs
);
947 inspect_info
.file_name
= optarg
;
956 hdr_ver
= atoi(optarg
);
970 ret
= check_options();
974 if (!inspect_info
.file_name
)