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 hw_ver_add
; /* 0x3c: additional hardware version */
47 uint8_t md5sum1
[MD5SUM_LEN
]; /* 0x40 */
48 uint32_t unk2
; /* 0x50: 0x00000000 */
49 uint8_t md5sum2
[MD5SUM_LEN
]; /* 0x54 */
50 uint32_t unk3
; /* 0x64: 0xffffffff */
52 uint32_t kernel_la
; /* 0x68: kernel load address */
53 uint32_t kernel_ep
; /* 0x6c: kernel entry point */
54 uint32_t fw_length
; /* 0x70: total length of the image */
55 uint32_t kernel_ofs
; /* 0x74: kernel data offset */
56 uint32_t kernel_len
; /* 0x78: kernel data length */
57 uint32_t rootfs_ofs
; /* 0x7c: rootfs data offset */
58 uint32_t rootfs_len
; /* 0x80: rootfs data length */
59 uint32_t boot_ofs
; /* 0x84: bootloader offset */
60 uint32_t boot_len
; /* 0x88: bootloader length */
61 uint16_t unk4
; /* 0x8c: 0x55aa */
62 uint8_t sver_hi
; /* 0x8e */
63 uint8_t sver_lo
; /* 0x8f */
64 uint8_t unk5
; /* 0x90: magic: 0xa5 */
65 uint8_t ver_hi
; /* 0x91 */
66 uint8_t ver_mid
; /* 0x92 */
67 uint8_t ver_lo
; /* 0x93 */
69 } __attribute__ ((packed
));
79 #define FLAG_LE_KERNEL_LA_EP 0x00000001 /* Little-endian used for kernel load address & entry point */
95 static char *progname
;
96 static char *vendor
= "TP-LINK Technologies";
97 static char *version
= "ver. 1.0";
98 static char *fw_ver
= "0.0.0";
99 static char *sver
= "1.0";
100 static uint32_t hdr_ver
= 2;
102 static struct board_info custom_board
;
104 static struct board_info
*board
;
105 static char *layout_id
;
106 static struct flash_layout
*layout
;
107 static char *opt_hw_id
;
108 static char *opt_hw_rev
;
109 static char *opt_hw_ver_add
;
110 static int fw_ver_lo
;
111 static int fw_ver_mid
;
112 static int fw_ver_hi
;
115 static struct file_info kernel_info
;
116 static uint32_t kernel_la
= 0;
117 static uint32_t kernel_ep
= 0;
118 static uint32_t kernel_len
= 0;
119 static struct file_info rootfs_info
;
120 static uint32_t rootfs_ofs
= 0;
121 static uint32_t rootfs_align
;
122 static struct file_info boot_info
;
124 static int strip_padding
;
125 static int add_jffs2_eof
;
126 static unsigned char jffs2_eof_mark
[4] = {0xde, 0xad, 0xc0, 0xde};
128 static struct file_info inspect_info
;
129 static int extract
= 0;
131 char md5salt_normal
[MD5SUM_LEN
] = {
132 0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
133 0xdc, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x37,
136 char md5salt_boot
[MD5SUM_LEN
] = {
137 0x8c, 0xef, 0x33, 0x5f, 0xd5, 0xc5, 0xce, 0xfa,
138 0xac, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
141 static struct flash_layout layouts
[] = {
144 .fw_max_len
= 0x7a0000,
145 .kernel_la
= 0x80002000,
146 .kernel_ep
= 0x80002000,
147 .rootfs_ofs
= 0x140000,
150 .fw_max_len
= 0xf90000,
151 .kernel_la
= 0x80002000,
152 .kernel_ep
= 0x800061b0,
153 .rootfs_ofs
= 0x140000,
156 .fw_max_len
= 0x7a0000,
157 .kernel_la
= 0x80000000,
158 .kernel_ep
= 0x80000000,
159 .rootfs_ofs
= 0x140000,
162 .fw_max_len
= 0x7b0000,
163 .kernel_la
= 0x80000000,
164 .kernel_ep
= 0x80000000,
165 .rootfs_ofs
= 0x140000,
167 /* terminating entry */
174 #define ERR(fmt, ...) do { \
176 fprintf(stderr, "[%s] *** error: " fmt "\n", \
177 progname, ## __VA_ARGS__ ); \
180 #define ERRS(fmt, ...) do { \
183 fprintf(stderr, "[%s] *** error: " fmt ": %s\n", \
184 progname, ## __VA_ARGS__, strerror(save)); \
187 #define DBG(fmt, ...) do { \
188 fprintf(stderr, "[%s] " fmt "\n", progname, ## __VA_ARGS__ ); \
191 static struct flash_layout
*find_layout(char *id
)
193 struct flash_layout
*ret
;
194 struct flash_layout
*l
;
197 for (l
= layouts
; l
->id
!= NULL
; l
++){
198 if (strcasecmp(id
, l
->id
) == 0) {
207 static void usage(int status
)
209 FILE *stream
= (status
!= EXIT_SUCCESS
) ? stderr
: stdout
;
210 struct board_info
*board
;
212 fprintf(stream
, "Usage: %s [OPTIONS...]\n", progname
);
216 " -c use combined kernel image\n"
217 " -e swap endianness in kernel load address and entry point\n"
218 " -E <ep> overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
219 " -L <la> overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
220 " -H <hwid> use hardware id specified with <hwid>\n"
221 " -W <hwrev> use hardware revision specified with <hwrev>\n"
222 " -w <hwveradd> use additional hardware version specified with <hwveradd>\n"
223 " -F <id> use flash layout specified with <id>\n"
224 " -k <file> read kernel image from the file <file>\n"
225 " -r <file> read rootfs image from the file <file>\n"
226 " -a <align> align the rootfs start on an <align> bytes boundary\n"
227 " -R <offset> overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
228 " -o <file> write output to the file <file>\n"
229 " -s strip padding from the end of the image\n"
230 " -j add jffs2 end-of-filesystem markers\n"
231 " -N <vendor> set image vendor to <vendor>\n"
232 " -T <version> set header version to <version>\n"
233 " -V <version> set image version to <version>\n"
234 " -v <version> set firmware version to <version>\n"
235 " -y <version> set secondary version to <version>\n"
236 " -i <file> inspect given firmware file <file>\n"
237 " -x extract kernel and rootfs while inspecting (requires -i)\n"
238 " -h show this screen\n"
244 static int get_md5(char *data
, int size
, char *md5
)
249 MD5_Update(&ctx
, data
, size
);
250 MD5_Final(md5
, &ctx
);
253 static int get_file_stat(struct file_info
*fdata
)
258 if (fdata
->file_name
== NULL
)
261 res
= stat(fdata
->file_name
, &st
);
263 ERRS("stat failed on %s", fdata
->file_name
);
267 fdata
->file_size
= st
.st_size
;
271 static int read_to_buf(struct file_info
*fdata
, char *buf
)
274 int ret
= EXIT_FAILURE
;
276 f
= fopen(fdata
->file_name
, "r");
278 ERRS("could not open \"%s\" for reading", fdata
->file_name
);
283 fread(buf
, fdata
->file_size
, 1, f
);
285 ERRS("unable to read from file \"%s\"", fdata
->file_name
);
297 static int check_options(void)
301 if (inspect_info
.file_name
) {
302 ret
= get_file_stat(&inspect_info
);
307 } else if (extract
) {
308 ERR("no firmware for inspection specified");
312 if (opt_hw_id
== NULL
) {
313 ERR("hardware id must be specified");
317 board
= &custom_board
;
319 if (layout_id
== NULL
) {
320 ERR("flash layout is not specified");
324 board
->hw_id
= strtoul(opt_hw_id
, NULL
, 0);
327 board
->hw_ver_add
= 0;
330 board
->hw_rev
= strtoul(opt_hw_rev
, NULL
, 0);
332 board
->hw_ver_add
= strtoul(opt_hw_ver_add
, NULL
, 0);
334 layout
= find_layout(layout_id
);
335 if (layout
== NULL
) {
336 ERR("unknown flash layout \"%s\"", layout_id
);
341 kernel_la
= layout
->kernel_la
;
343 kernel_ep
= layout
->kernel_ep
;
345 rootfs_ofs
= layout
->rootfs_ofs
;
347 if (kernel_info
.file_name
== NULL
) {
348 ERR("no kernel image specified");
352 ret
= get_file_stat(&kernel_info
);
356 kernel_len
= kernel_info
.file_size
;
359 if (kernel_info
.file_size
>
360 layout
->fw_max_len
- sizeof(struct fw_header
)) {
361 ERR("kernel image is too big");
365 if (rootfs_info
.file_name
== NULL
) {
366 ERR("no rootfs image specified");
370 ret
= get_file_stat(&rootfs_info
);
375 kernel_len
+= sizeof(struct fw_header
);
376 kernel_len
= ALIGN(kernel_len
, rootfs_align
);
377 kernel_len
-= sizeof(struct fw_header
);
379 DBG("kernel length aligned to %u", kernel_len
);
381 if (kernel_len
+ rootfs_info
.file_size
>
382 layout
->fw_max_len
- sizeof(struct fw_header
)) {
383 ERR("images are too big");
387 if (kernel_info
.file_size
>
388 rootfs_ofs
- sizeof(struct fw_header
)) {
389 ERR("kernel image is too big");
393 if (rootfs_info
.file_size
>
394 (layout
->fw_max_len
- rootfs_ofs
)) {
395 ERR("rootfs image is too big");
401 if (ofname
== NULL
) {
402 ERR("no output file specified");
406 ret
= sscanf(fw_ver
, "%d.%d.%d", &fw_ver_hi
, &fw_ver_mid
, &fw_ver_lo
);
408 ERR("invalid firmware version '%s'", fw_ver
);
412 ret
= sscanf(sver
, "%d.%d", &sver_hi
, &sver_lo
);
414 ERR("invalid secondary version '%s'", sver
);
421 static void fill_header(char *buf
, int len
)
423 struct fw_header
*hdr
= (struct fw_header
*)buf
;
426 memset(hdr
, '\xff', sizeof(struct fw_header
));
428 hdr
->version
= htonl(bswap_32(hdr_ver
));
429 ver_len
= strlen(version
);
430 if (ver_len
> (sizeof(hdr
->fw_version
) - 1))
431 ver_len
= sizeof(hdr
->fw_version
) - 1;
433 memcpy(hdr
->fw_version
, version
, ver_len
);
434 hdr
->fw_version
[ver_len
] = 0;
436 hdr
->hw_id
= htonl(board
->hw_id
);
437 hdr
->hw_rev
= htonl(board
->hw_rev
);
438 hdr
->hw_ver_add
= htonl(board
->hw_ver_add
);
440 if (boot_info
.file_size
== 0) {
441 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(hdr
->md5sum1
));
442 hdr
->boot_ofs
= htonl(0);
443 hdr
->boot_len
= htonl(0);
445 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(hdr
->md5sum1
));
446 hdr
->boot_ofs
= htonl(rootfs_ofs
+ rootfs_info
.file_size
);
447 hdr
->boot_len
= htonl(rootfs_info
.file_size
);
450 hdr
->kernel_la
= htonl(kernel_la
);
451 hdr
->kernel_ep
= htonl(kernel_ep
);
452 hdr
->fw_length
= htonl(layout
->fw_max_len
);
453 hdr
->kernel_ofs
= htonl(sizeof(struct fw_header
));
454 hdr
->kernel_len
= htonl(kernel_len
);
456 hdr
->rootfs_ofs
= htonl(rootfs_ofs
);
457 hdr
->rootfs_len
= htonl(rootfs_info
.file_size
);
460 hdr
->boot_ofs
= htonl(0);
461 hdr
->boot_len
= htonl(boot_info
.file_size
);
463 hdr
->unk2
= htonl(0);
464 hdr
->unk3
= htonl(0xffffffff);
465 hdr
->unk4
= htons(0x55aa);
468 hdr
->sver_hi
= sver_hi
;
469 hdr
->sver_lo
= sver_lo
;
471 hdr
->ver_hi
= fw_ver_hi
;
472 hdr
->ver_mid
= fw_ver_mid
;
473 hdr
->ver_lo
= fw_ver_lo
;
475 if (board
->flags
& FLAG_LE_KERNEL_LA_EP
) {
476 hdr
->kernel_la
= bswap_32(hdr
->kernel_la
);
477 hdr
->kernel_ep
= bswap_32(hdr
->kernel_ep
);
480 get_md5(buf
, len
, hdr
->md5sum1
);
483 static int pad_jffs2(char *buf
, int currlen
)
489 pad_mask
= (64 * 1024);
490 while ((len
< layout
->fw_max_len
) && (pad_mask
!= 0)) {
494 for (i
= 10; i
< 32; i
++) {
500 len
= ALIGN(len
, mask
);
502 for (i
= 10; i
< 32; i
++) {
504 if ((len
& (mask
- 1)) == 0)
508 for (i
= 0; i
< sizeof(jffs2_eof_mark
); i
++)
509 buf
[len
+ i
] = jffs2_eof_mark
[i
];
511 len
+= sizeof(jffs2_eof_mark
);
517 static int write_fw(char *data
, int len
)
520 int ret
= EXIT_FAILURE
;
522 f
= fopen(ofname
, "w");
524 ERRS("could not open \"%s\" for writing", ofname
);
529 fwrite(data
, len
, 1, f
);
531 ERRS("unable to write output file");
535 DBG("firmware file \"%s\" completed", ofname
);
542 if (ret
!= EXIT_SUCCESS
) {
549 static int build_fw(void)
554 int ret
= EXIT_FAILURE
;
557 buflen
= layout
->fw_max_len
;
559 buf
= malloc(buflen
);
561 ERR("no memory for buffer\n");
565 memset(buf
, 0xff, buflen
);
566 p
= buf
+ sizeof(struct fw_header
);
567 ret
= read_to_buf(&kernel_info
, p
);
571 writelen
= sizeof(struct fw_header
) + kernel_len
;
577 p
= buf
+ rootfs_ofs
;
579 ret
= read_to_buf(&rootfs_info
, p
);
584 writelen
+= rootfs_info
.file_size
;
586 writelen
= rootfs_ofs
+ rootfs_info
.file_size
;
589 writelen
= pad_jffs2(buf
, writelen
);
595 fill_header(buf
, writelen
);
596 ret
= write_fw(buf
, writelen
);
608 /* Helper functions to inspect_fw() representing different output formats */
609 static inline void inspect_fw_pstr(char *label
, char *str
)
611 printf("%-23s: %s\n", label
, str
);
614 static inline void inspect_fw_phex(char *label
, uint32_t val
)
616 printf("%-23s: 0x%08x\n", label
, val
);
619 static inline void inspect_fw_phexpost(char *label
,
620 uint32_t val
, char *post
)
622 printf("%-23s: 0x%08x (%s)\n", label
, val
, post
);
625 static inline void inspect_fw_phexdef(char *label
,
626 uint32_t val
, uint32_t defval
)
628 printf("%-23s: 0x%08x ", label
, val
);
631 printf("(== OpenWrt default)\n");
633 printf("(OpenWrt default: 0x%08x)\n", defval
);
636 static inline void inspect_fw_phexexp(char *label
,
637 uint32_t val
, uint32_t expval
)
639 printf("%-23s: 0x%08x ", label
, val
);
644 printf("(expected: 0x%08x)\n", expval
);
647 static inline void inspect_fw_phexdec(char *label
, uint32_t val
)
649 printf("%-23s: 0x%08x / %8u bytes\n", label
, val
, val
);
652 static inline void inspect_fw_phexdecdef(char *label
,
653 uint32_t val
, uint32_t defval
)
655 printf("%-23s: 0x%08x / %8u bytes ", label
, val
, val
);
658 printf("(== OpenWrt default)\n");
660 printf("(OpenWrt default: 0x%08x)\n", defval
);
663 static inline void inspect_fw_pmd5sum(char *label
, uint8_t *val
, char *text
)
667 printf("%-23s:", label
);
668 for (i
=0; i
<MD5SUM_LEN
; i
++)
669 printf(" %02x", val
[i
]);
670 printf(" %s\n", text
);
673 static int inspect_fw(void)
676 struct fw_header
*hdr
;
677 uint8_t md5sum
[MD5SUM_LEN
];
678 struct board_info
*board
;
679 int ret
= EXIT_FAILURE
;
681 buf
= malloc(inspect_info
.file_size
);
683 ERR("no memory for buffer!\n");
687 ret
= read_to_buf(&inspect_info
, buf
);
690 hdr
= (struct fw_header
*)buf
;
692 board
= &custom_board
;
694 if (board
->flags
& FLAG_LE_KERNEL_LA_EP
) {
695 hdr
->kernel_la
= bswap_32(hdr
->kernel_la
);
696 hdr
->kernel_ep
= bswap_32(hdr
->kernel_ep
);
699 inspect_fw_pstr("File name", inspect_info
.file_name
);
700 inspect_fw_phexdec("File size", inspect_info
.file_size
);
702 switch(bswap_32(ntohl(hdr
->version
))) {
707 ERR("file does not seem to have V2/V3 header!\n");
711 inspect_fw_phexdec("Version 2 Header size", sizeof(struct fw_header
));
713 memcpy(md5sum
, hdr
->md5sum1
, sizeof(md5sum
));
714 if (ntohl(hdr
->boot_len
) == 0)
715 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(md5sum
));
717 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(md5sum
));
718 get_md5(buf
, inspect_info
.file_size
, hdr
->md5sum1
);
720 if (memcmp(md5sum
, hdr
->md5sum1
, sizeof(md5sum
))) {
721 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(*ERROR*)");
722 inspect_fw_pmd5sum(" --> expected", hdr
->md5sum1
, "");
724 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(ok)");
726 if (ntohl(hdr
->unk2
) != 0)
727 inspect_fw_phexdec("Unknown value 2", hdr
->unk2
);
728 inspect_fw_pmd5sum("Header MD5Sum2", hdr
->md5sum2
,
729 "(purpose yet unknown, unchecked here)");
731 if (ntohl(hdr
->unk3
) != 0xffffffff)
732 inspect_fw_phexdec("Unknown value 3", hdr
->unk3
);
734 if (ntohs(hdr
->unk4
) != 0x55aa)
735 inspect_fw_phexdec("Unknown value 4", hdr
->unk4
);
737 if (hdr
->unk5
!= 0xa5)
738 inspect_fw_phexdec("Unknown value 5", hdr
->unk5
);
742 inspect_fw_pstr("Firmware version", hdr
->fw_version
);
744 inspect_fw_phexpost("Hardware ID",
745 ntohl(hdr
->hw_id
), "unknown");
746 inspect_fw_phex("Hardware Revision",
748 inspect_fw_phex("Additional HW Version",
749 ntohl(hdr
->hw_ver_add
));
751 printf("%-23s: %d.%d.%d-%d.%d\n", "Software version",
752 hdr
->ver_hi
, hdr
->ver_mid
, hdr
->ver_lo
,
753 hdr
->sver_hi
, hdr
->sver_lo
);
757 inspect_fw_phexdec("Kernel data offset",
758 ntohl(hdr
->kernel_ofs
));
759 inspect_fw_phexdec("Kernel data length",
760 ntohl(hdr
->kernel_len
));
761 inspect_fw_phex("Kernel load address",
762 ntohl(hdr
->kernel_la
));
763 inspect_fw_phex("Kernel entry point",
764 ntohl(hdr
->kernel_ep
));
765 inspect_fw_phexdec("Rootfs data offset",
766 ntohl(hdr
->rootfs_ofs
));
767 inspect_fw_phexdec("Rootfs data length",
768 ntohl(hdr
->rootfs_len
));
769 inspect_fw_phexdec("Boot loader data offset",
770 ntohl(hdr
->boot_ofs
));
771 inspect_fw_phexdec("Boot loader data length",
772 ntohl(hdr
->boot_len
));
773 inspect_fw_phexdec("Total firmware length",
774 ntohl(hdr
->fw_length
));
782 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
783 sprintf(filename
, "%s-kernel", inspect_info
.file_name
);
784 printf("Extracting kernel to \"%s\"...\n", filename
);
785 fp
= fopen(filename
, "w");
787 if (!fwrite(buf
+ ntohl(hdr
->kernel_ofs
),
788 ntohl(hdr
->kernel_len
), 1, fp
)) {
789 ERR("error in fwrite(): %s", strerror(errno
));
793 ERR("error in fopen(): %s", strerror(errno
));
797 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
798 sprintf(filename
, "%s-rootfs", inspect_info
.file_name
);
799 printf("Extracting rootfs to \"%s\"...\n", filename
);
800 fp
= fopen(filename
, "w");
802 if (!fwrite(buf
+ ntohl(hdr
->rootfs_ofs
),
803 ntohl(hdr
->rootfs_len
), 1, fp
)) {
804 ERR("error in fwrite(): %s", strerror(errno
));
808 ERR("error in fopen(): %s", strerror(errno
));
819 int main(int argc
, char *argv
[])
821 int ret
= EXIT_FAILURE
;
826 progname
= basename(argv
[0]);
831 c
= getopt(argc
, argv
, "a:H:E:F:L:V:N:W:w:ci:k:r:R:o:xhsjv:y:T:e");
837 sscanf(optarg
, "0x%x", &rootfs_align
);
843 sscanf(optarg
, "0x%x", &kernel_ep
);
852 opt_hw_ver_add
= optarg
;
855 sscanf(optarg
, "0x%x", &kernel_la
);
873 kernel_info
.file_name
= optarg
;
876 rootfs_info
.file_name
= optarg
;
879 sscanf(optarg
, "0x%x", &rootfs_ofs
);
888 inspect_info
.file_name
= optarg
;
897 hdr_ver
= atoi(optarg
);
900 custom_board
.flags
= FLAG_LE_KERNEL_LA_EP
;
911 ret
= check_options();
915 if (!inspect_info
.file_name
)