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() */
25 #include <arpa/inet.h>
26 #include <netinet/in.h>
30 #define ALIGN(x,a) ({ typeof(a) __a = (a); (((x) + __a - 1) & ~(__a - 1)); })
32 #define HEADER_VERSION_V1 0x01000000
33 #define HEADER_VERSION_V2 0x02000000
38 char *file_name
; /* name of the file */
39 uint32_t file_size
; /* length of the file */
43 uint32_t version
; /* header version */
46 uint32_t hw_id
; /* hardware id */
47 uint32_t hw_rev
; /* hardware revision */
49 uint8_t md5sum1
[MD5SUM_LEN
];
51 uint8_t md5sum2
[MD5SUM_LEN
];
53 uint32_t kernel_la
; /* kernel load address */
54 uint32_t kernel_ep
; /* kernel entry point */
55 uint32_t fw_length
; /* total length of the firmware */
56 uint32_t kernel_ofs
; /* kernel data offset */
57 uint32_t kernel_len
; /* kernel data length */
58 uint32_t rootfs_ofs
; /* rootfs data offset */
59 uint32_t rootfs_len
; /* rootfs data length */
60 uint32_t boot_ofs
; /* bootloader data offset */
61 uint32_t boot_len
; /* bootloader data length */
66 } __attribute__ ((packed
));
80 static char *progname
;
81 static char *vendor
= "TP-LINK Technologies";
82 static char *version
= "ver. 1.0";
83 static char *fw_ver
= "0.0.0";
84 static uint32_t hdr_ver
= HEADER_VERSION_V1
;
86 static char *layout_id
;
87 static struct flash_layout
*layout
;
88 static char *opt_hw_id
;
89 static uint32_t hw_id
;
90 static char *opt_hw_rev
;
91 static uint32_t hw_rev
;
92 static uint32_t opt_hdr_ver
= 1;
94 static int fw_ver_mid
;
96 static struct file_info kernel_info
;
97 static uint32_t kernel_la
= 0;
98 static uint32_t kernel_ep
= 0;
99 static uint32_t kernel_len
= 0;
100 static struct file_info rootfs_info
;
101 static uint32_t rootfs_ofs
= 0;
102 static uint32_t rootfs_align
;
103 static struct file_info boot_info
;
105 static int strip_padding
;
106 static int ignore_size
;
107 static int add_jffs2_eof
;
108 static unsigned char jffs2_eof_mark
[4] = {0xde, 0xad, 0xc0, 0xde};
109 static uint32_t fw_max_len
;
110 static uint32_t reserved_space
;
112 static struct file_info inspect_info
;
113 static int extract
= 0;
115 static const char md5salt_normal
[MD5SUM_LEN
] = {
116 0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
117 0xdd, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x38,
120 static const char md5salt_boot
[MD5SUM_LEN
] = {
121 0x8c, 0xef, 0x33, 0x5b, 0xd5, 0xc5, 0xce, 0xfa,
122 0xa7, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
125 static struct flash_layout layouts
[] = {
128 .fw_max_len
= 0x3c0000,
129 .kernel_la
= 0x80060000,
130 .kernel_ep
= 0x80060000,
131 .rootfs_ofs
= 0x140000,
134 .fw_max_len
= 0x3c0000,
135 .kernel_la
= 0x80060000,
136 .kernel_ep
= 0x80060000,
137 .rootfs_ofs
= 0x100000,
140 .fw_max_len
= 0x7c0000,
141 .kernel_la
= 0x80060000,
142 .kernel_ep
= 0x80060000,
143 .rootfs_ofs
= 0x140000,
146 .fw_max_len
= 0x7c0000,
147 .kernel_la
= 0x80060000,
148 .kernel_ep
= 0x80060000,
149 .rootfs_ofs
= 0x100000,
152 .fw_max_len
= 0xf80000,
153 .kernel_la
= 0x80060000,
154 .kernel_ep
= 0x80060000,
155 .rootfs_ofs
= 0x140000,
158 .fw_max_len
= 0xf80000,
159 .kernel_la
= 0x80060000,
160 .kernel_ep
= 0x80060000,
161 .rootfs_ofs
= 0x100000,
164 .fw_max_len
= 0xf80000,
165 .kernel_la
= 0x00000000 ,
166 .kernel_ep
= 0xc0000000,
167 .rootfs_ofs
= 0x2a0000,
169 /* terminating entry */
176 #define ERR(fmt, ...) do { \
178 fprintf(stderr, "[%s] *** error: " fmt "\n", \
179 progname, ## __VA_ARGS__ ); \
182 #define ERRS(fmt, ...) do { \
185 fprintf(stderr, "[%s] *** error: " fmt ": %s\n", \
186 progname, ## __VA_ARGS__, strerror(save)); \
189 #define DBG(fmt, ...) do { \
190 fprintf(stderr, "[%s] " fmt "\n", progname, ## __VA_ARGS__ ); \
193 static struct flash_layout
*find_layout(const char *id
)
195 struct flash_layout
*ret
;
196 struct flash_layout
*l
;
199 for (l
= layouts
; l
->id
!= NULL
; l
++){
200 if (strcasecmp(id
, l
->id
) == 0) {
209 static void usage(int status
)
211 fprintf(stderr
, "Usage: %s [OPTIONS...]\n", progname
);
215 " -c use combined kernel image\n"
216 " -E <ep> overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
217 " -L <la> overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
218 " -H <hwid> use hardware id specified with <hwid>\n"
219 " -W <hwrev> use hardware revision specified with <hwrev>\n"
220 " -F <id> use flash layout specified with <id>\n"
221 " -k <file> read kernel image from the file <file>\n"
222 " -r <file> read rootfs image from the file <file>\n"
223 " -a <align> align the rootfs start on an <align> bytes boundary\n"
224 " -R <offset> overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
225 " -o <file> write output to the file <file>\n"
226 " -s strip padding from the end of the image\n"
227 " -S ignore firmware size limit (only for combined images)\n"
228 " -j add jffs2 end-of-filesystem markers\n"
229 " -N <vendor> set image vendor to <vendor>\n"
230 " -V <version> set image version to <version>\n"
231 " -v <version> set firmware version to <version>\n"
232 " -m <version> set header version to <version>\n"
233 " -i <file> inspect given firmware file <file>\n"
234 " -x extract kernel and rootfs while inspecting (requires -i)\n"
235 " -X <size> reserve <size> bytes in the firmware image (hexval prefixed with 0x)\n"
236 " -h show this screen\n"
242 static void get_md5(const char *data
, int size
, uint8_t *md5
)
247 MD5_Update(&ctx
, data
, size
);
248 MD5_Final(md5
, &ctx
);
251 static int get_file_stat(struct file_info
*fdata
)
256 if (fdata
->file_name
== NULL
)
259 res
= stat(fdata
->file_name
, &st
);
261 ERRS("stat failed on %s", fdata
->file_name
);
265 fdata
->file_size
= st
.st_size
;
269 static int read_to_buf(const struct file_info
*fdata
, char *buf
)
272 int ret
= EXIT_FAILURE
;
274 f
= fopen(fdata
->file_name
, "r");
276 ERRS("could not open \"%s\" for reading", fdata
->file_name
);
281 fread(buf
, fdata
->file_size
, 1, f
);
283 ERRS("unable to read from file \"%s\"", fdata
->file_name
);
295 static int check_options(void)
300 if (inspect_info
.file_name
) {
301 ret
= get_file_stat(&inspect_info
);
306 } else if (extract
) {
307 ERR("no firmware for inspection specified");
311 if (opt_hw_id
== NULL
) {
312 ERR("hardware id not specified");
315 hw_id
= strtoul(opt_hw_id
, NULL
, 0);
317 if (layout_id
== NULL
) {
318 ERR("flash layout is not specified");
323 hw_rev
= strtoul(opt_hw_rev
, NULL
, 0);
327 layout
= find_layout(layout_id
);
328 if (layout
== NULL
) {
329 ERR("unknown flash layout \"%s\"", layout_id
);
334 kernel_la
= layout
->kernel_la
;
336 kernel_ep
= layout
->kernel_ep
;
338 rootfs_ofs
= layout
->rootfs_ofs
;
340 if (reserved_space
> layout
->fw_max_len
) {
341 ERR("reserved space is not valid");
345 fw_max_len
= layout
->fw_max_len
- reserved_space
;
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 exceed_bytes
= kernel_info
.file_size
- (fw_max_len
- sizeof(struct fw_header
));
360 if (exceed_bytes
> 0) {
362 ERR("kernel image is too big by %i bytes", exceed_bytes
);
365 layout
->fw_max_len
= sizeof(struct fw_header
) +
366 kernel_info
.file_size
+
370 if (rootfs_info
.file_name
== NULL
) {
371 ERR("no rootfs image specified");
375 ret
= get_file_stat(&rootfs_info
);
380 kernel_len
+= sizeof(struct fw_header
);
381 kernel_len
= ALIGN(kernel_len
, rootfs_align
);
382 kernel_len
-= sizeof(struct fw_header
);
384 DBG("kernel length aligned to %u", kernel_len
);
386 exceed_bytes
= kernel_len
+ rootfs_info
.file_size
- (fw_max_len
- sizeof(struct fw_header
));
387 if (exceed_bytes
> 0) {
388 ERR("images are too big by %i bytes", exceed_bytes
);
392 exceed_bytes
= kernel_info
.file_size
- (rootfs_ofs
- sizeof(struct fw_header
));
393 if (exceed_bytes
> 0) {
394 ERR("kernel image is too big by %i bytes", exceed_bytes
);
398 exceed_bytes
= rootfs_info
.file_size
- (fw_max_len
- rootfs_ofs
);
399 if (exceed_bytes
> 0) {
400 ERR("rootfs image is too big by %i bytes", exceed_bytes
);
406 if (ofname
== NULL
) {
407 ERR("no output file specified");
411 ret
= sscanf(fw_ver
, "%d.%d.%d", &fw_ver_hi
, &fw_ver_mid
, &fw_ver_lo
);
413 ERR("invalid firmware version '%s'", fw_ver
);
417 if (opt_hdr_ver
== 1) {
418 hdr_ver
= HEADER_VERSION_V1
;
419 } else if (opt_hdr_ver
== 2) {
420 hdr_ver
= HEADER_VERSION_V2
;
422 ERR("invalid header version '%u'", opt_hdr_ver
);
429 static void fill_header(char *buf
, int len
)
431 struct fw_header
*hdr
= (struct fw_header
*)buf
;
433 memset(hdr
, 0, sizeof(struct fw_header
));
435 hdr
->version
= htonl(hdr_ver
);
436 strncpy(hdr
->vendor_name
, vendor
, sizeof(hdr
->vendor_name
));
437 strncpy(hdr
->fw_version
, version
, sizeof(hdr
->fw_version
));
438 hdr
->hw_id
= htonl(hw_id
);
439 hdr
->hw_rev
= htonl(hw_rev
);
441 if (boot_info
.file_size
== 0)
442 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(hdr
->md5sum1
));
444 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(hdr
->md5sum1
));
446 hdr
->kernel_la
= htonl(kernel_la
);
447 hdr
->kernel_ep
= htonl(kernel_ep
);
448 hdr
->fw_length
= htonl(layout
->fw_max_len
);
449 hdr
->kernel_ofs
= htonl(sizeof(struct fw_header
));
450 hdr
->kernel_len
= htonl(kernel_len
);
452 hdr
->rootfs_ofs
= htonl(rootfs_ofs
);
453 hdr
->rootfs_len
= htonl(rootfs_info
.file_size
);
456 hdr
->ver_hi
= htons(fw_ver_hi
);
457 hdr
->ver_mid
= htons(fw_ver_mid
);
458 hdr
->ver_lo
= htons(fw_ver_lo
);
460 get_md5(buf
, len
, hdr
->md5sum1
);
463 static int pad_jffs2(char *buf
, int currlen
)
469 pad_mask
= (64 * 1024);
470 while ((len
< layout
->fw_max_len
) && (pad_mask
!= 0)) {
474 for (i
= 10; i
< 32; i
++) {
480 len
= ALIGN(len
, mask
);
482 for (i
= 10; i
< 32; i
++) {
484 if ((len
& (mask
- 1)) == 0)
488 for (i
= 0; i
< sizeof(jffs2_eof_mark
); i
++)
489 buf
[len
+ i
] = jffs2_eof_mark
[i
];
491 len
+= sizeof(jffs2_eof_mark
);
497 static int write_fw(const char *data
, int len
)
500 int ret
= EXIT_FAILURE
;
502 f
= fopen(ofname
, "w");
504 ERRS("could not open \"%s\" for writing", ofname
);
509 fwrite(data
, len
, 1, f
);
511 ERRS("unable to write output file");
515 DBG("firmware file \"%s\" completed", ofname
);
522 if (ret
!= EXIT_SUCCESS
) {
529 static int build_fw(void)
534 int ret
= EXIT_FAILURE
;
537 buflen
= layout
->fw_max_len
;
539 buf
= malloc(buflen
);
541 ERR("no memory for buffer\n");
545 memset(buf
, 0xff, buflen
);
546 p
= buf
+ sizeof(struct fw_header
);
547 ret
= read_to_buf(&kernel_info
, p
);
551 writelen
= sizeof(struct fw_header
) + kernel_len
;
557 p
= buf
+ rootfs_ofs
;
559 ret
= read_to_buf(&rootfs_info
, p
);
564 writelen
+= rootfs_info
.file_size
;
566 writelen
= rootfs_ofs
+ rootfs_info
.file_size
;
569 writelen
= pad_jffs2(buf
, writelen
);
575 fill_header(buf
, writelen
);
576 ret
= write_fw(buf
, writelen
);
588 /* Helper functions to inspect_fw() representing different output formats */
589 static inline void inspect_fw_pstr(const char *label
, const char *str
)
591 printf("%-23s: %s\n", label
, str
);
594 static inline void inspect_fw_phex(const char *label
, uint32_t val
)
596 printf("%-23s: 0x%08x\n", label
, val
);
599 static inline void inspect_fw_phexpost(const char *label
, uint32_t val
, const char *post
)
601 printf("%-23s: 0x%08x (%s)\n", label
, val
, post
);
604 static inline void inspect_fw_phexdec(const char *label
, uint32_t val
)
606 printf("%-23s: 0x%08x / %8u bytes\n", label
, val
, val
);
609 static inline void inspect_fw_pmd5sum(const char *label
, const uint8_t *val
, const char *text
)
613 printf("%-23s:", label
);
614 for (i
=0; i
<MD5SUM_LEN
; i
++)
615 printf(" %02x", val
[i
]);
616 printf(" %s\n", text
);
619 static int inspect_fw(void)
622 struct fw_header
*hdr
;
623 uint8_t md5sum
[MD5SUM_LEN
];
624 int ret
= EXIT_FAILURE
;
626 buf
= malloc(inspect_info
.file_size
);
628 ERR("no memory for buffer!\n");
632 ret
= read_to_buf(&inspect_info
, buf
);
635 hdr
= (struct fw_header
*)buf
;
637 inspect_fw_pstr("File name", inspect_info
.file_name
);
638 inspect_fw_phexdec("File size", inspect_info
.file_size
);
640 if ((ntohl(hdr
->version
) != HEADER_VERSION_V1
) &&
641 (ntohl(hdr
->version
) != HEADER_VERSION_V2
)) {
642 ERR("file does not seem to have V1/V2 header!\n");
646 inspect_fw_phexdec("Version 1 Header size", sizeof(struct fw_header
));
648 if (ntohl(hdr
->unk1
) != 0)
649 inspect_fw_phexdec("Unknown value 1", hdr
->unk1
);
651 memcpy(md5sum
, hdr
->md5sum1
, sizeof(md5sum
));
652 if (ntohl(hdr
->boot_len
) == 0)
653 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(md5sum
));
655 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(md5sum
));
656 get_md5(buf
, inspect_info
.file_size
, hdr
->md5sum1
);
658 if (memcmp(md5sum
, hdr
->md5sum1
, sizeof(md5sum
))) {
659 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(*ERROR*)");
660 inspect_fw_pmd5sum(" --> expected", hdr
->md5sum1
, "");
662 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(ok)");
664 if (ntohl(hdr
->unk2
) != 0)
665 inspect_fw_phexdec("Unknown value 2", hdr
->unk2
);
666 inspect_fw_pmd5sum("Header MD5Sum2", hdr
->md5sum2
,
667 "(purpose yet unknown, unchecked here)");
668 if (ntohl(hdr
->unk3
) != 0)
669 inspect_fw_phexdec("Unknown value 3", hdr
->unk3
);
673 inspect_fw_pstr("Vendor name", hdr
->vendor_name
);
674 inspect_fw_pstr("Firmware version", hdr
->fw_version
);
675 inspect_fw_phex("Hardware ID", ntohl(hdr
->hw_id
));
676 inspect_fw_phex("Hardware Revision", ntohl(hdr
->hw_rev
));
680 inspect_fw_phexdec("Kernel data offset",
681 ntohl(hdr
->kernel_ofs
));
682 inspect_fw_phexdec("Kernel data length",
683 ntohl(hdr
->kernel_len
));
684 inspect_fw_phex("Kernel load address",
685 ntohl(hdr
->kernel_la
));
686 inspect_fw_phex("Kernel entry point",
687 ntohl(hdr
->kernel_ep
));
688 inspect_fw_phexdec("Rootfs data offset",
689 ntohl(hdr
->rootfs_ofs
));
690 inspect_fw_phexdec("Rootfs data length",
691 ntohl(hdr
->rootfs_len
));
692 inspect_fw_phexdec("Boot loader data offset",
693 ntohl(hdr
->boot_ofs
));
694 inspect_fw_phexdec("Boot loader data length",
695 ntohl(hdr
->boot_len
));
696 inspect_fw_phexdec("Total firmware length",
697 ntohl(hdr
->fw_length
));
705 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
706 sprintf(filename
, "%s-kernel", inspect_info
.file_name
);
707 printf("Extracting kernel to \"%s\"...\n", filename
);
708 fp
= fopen(filename
, "w");
710 if (!fwrite(buf
+ ntohl(hdr
->kernel_ofs
),
711 ntohl(hdr
->kernel_len
), 1, fp
)) {
712 ERR("error in fwrite(): %s", strerror(errno
));
716 ERR("error in fopen(): %s", strerror(errno
));
720 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
721 sprintf(filename
, "%s-rootfs", inspect_info
.file_name
);
722 printf("Extracting rootfs to \"%s\"...\n", filename
);
723 fp
= fopen(filename
, "w");
725 if (!fwrite(buf
+ ntohl(hdr
->rootfs_ofs
),
726 ntohl(hdr
->rootfs_len
), 1, fp
)) {
727 ERR("error in fwrite(): %s", strerror(errno
));
731 ERR("error in fopen(): %s", strerror(errno
));
742 int main(int argc
, char *argv
[])
744 int ret
= EXIT_FAILURE
;
746 progname
= basename(argv
[0]);
751 c
= getopt(argc
, argv
, "a:H:E:F:L:m:V:N:W:ci:k:r:R:o:xX:hsSjv:");
757 sscanf(optarg
, "0x%x", &rootfs_align
);
763 sscanf(optarg
, "0x%x", &kernel_ep
);
772 sscanf(optarg
, "0x%x", &kernel_la
);
775 sscanf(optarg
, "%u", &opt_hdr_ver
);
790 kernel_info
.file_name
= optarg
;
793 rootfs_info
.file_name
= optarg
;
796 sscanf(optarg
, "0x%x", &rootfs_ofs
);
808 inspect_info
.file_name
= optarg
;
820 sscanf(optarg
, "0x%x", &reserved_space
);
828 ret
= check_options();
832 if (!inspect_info
.file_name
)