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)); })
31 #define ARRAY_SIZE(a) (sizeof((a)) / sizeof((a)[0]))
33 #define HEADER_VERSION_V1 0x01000000
34 #define HEADER_VERSION_V2 0x02000000
39 char *file_name
; /* name of the file */
40 uint32_t file_size
; /* length of the file */
44 uint32_t version
; /* header version */
47 uint32_t hw_id
; /* hardware id */
48 uint32_t hw_rev
; /* hardware revision */
49 uint32_t region_code
; /* region code */
50 uint8_t md5sum1
[MD5SUM_LEN
];
52 uint8_t md5sum2
[MD5SUM_LEN
];
54 uint32_t kernel_la
; /* kernel load address */
55 uint32_t kernel_ep
; /* kernel entry point */
56 uint32_t fw_length
; /* total length of the firmware */
57 uint32_t kernel_ofs
; /* kernel data offset */
58 uint32_t kernel_len
; /* kernel data length */
59 uint32_t rootfs_ofs
; /* rootfs data offset */
60 uint32_t rootfs_len
; /* rootfs data length */
61 uint32_t boot_ofs
; /* bootloader data offset */
62 uint32_t boot_len
; /* bootloader data length */
70 } __attribute__ ((packed
));
90 static char *progname
;
91 static char *vendor
= "TP-LINK Technologies";
92 static char *version
= "ver. 1.0";
93 static char *fw_ver
= "0.0.0";
94 static uint32_t hdr_ver
= HEADER_VERSION_V1
;
96 static char *layout_id
;
97 static struct flash_layout
*layout
;
98 static char *opt_hw_id
;
99 static uint32_t hw_id
;
100 static char *opt_hw_rev
;
101 static uint32_t hw_rev
;
102 static uint32_t opt_hdr_ver
= 1;
103 static char *country
;
104 static const struct fw_region
*region
;
105 static int fw_ver_lo
;
106 static int fw_ver_mid
;
107 static int fw_ver_hi
;
108 static struct file_info kernel_info
;
109 static uint32_t kernel_la
= 0;
110 static uint32_t kernel_ep
= 0;
111 static uint32_t kernel_len
= 0;
112 static struct file_info rootfs_info
;
113 static uint32_t rootfs_ofs
= 0;
114 static uint32_t rootfs_align
;
115 static struct file_info boot_info
;
117 static int strip_padding
;
118 static int ignore_size
;
119 static int add_jffs2_eof
;
120 static unsigned char jffs2_eof_mark
[4] = {0xde, 0xad, 0xc0, 0xde};
121 static uint32_t fw_max_len
;
122 static uint32_t reserved_space
;
124 static struct file_info inspect_info
;
125 static int extract
= 0;
127 static const char md5salt_normal
[MD5SUM_LEN
] = {
128 0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
129 0xdd, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x38,
132 static const char md5salt_boot
[MD5SUM_LEN
] = {
133 0x8c, 0xef, 0x33, 0x5b, 0xd5, 0xc5, 0xce, 0xfa,
134 0xa7, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
137 static struct flash_layout layouts
[] = {
140 .fw_max_len
= 0x3c0000,
141 .kernel_la
= 0x80060000,
142 .kernel_ep
= 0x80060000,
143 .rootfs_ofs
= 0x140000,
146 .fw_max_len
= 0x3c0000,
147 .kernel_la
= 0x80060000,
148 .kernel_ep
= 0x80060000,
149 .rootfs_ofs
= 0x100000,
152 .fw_max_len
= 0x7c0000,
153 .kernel_la
= 0x80060000,
154 .kernel_ep
= 0x80060000,
155 .rootfs_ofs
= 0x140000,
158 .fw_max_len
= 0x7c0000,
159 .kernel_la
= 0x80060000,
160 .kernel_ep
= 0x80060000,
161 .rootfs_ofs
= 0x100000,
164 .fw_max_len
= 0xf80000,
165 .kernel_la
= 0x80060000,
166 .kernel_ep
= 0x80060000,
167 .rootfs_ofs
= 0x140000,
170 .fw_max_len
= 0xf80000,
171 .kernel_la
= 0x80060000,
172 .kernel_ep
= 0x80060000,
173 .rootfs_ofs
= 0x100000,
176 .fw_max_len
= 0xf80000,
177 .kernel_la
= 0x00000000 ,
178 .kernel_ep
= 0xc0000000,
179 .rootfs_ofs
= 0x2a0000,
182 Some devices (e.g. TL-WR1043 v4) use a mktplinkfw kernel image
183 embedded in a tplink-safeloader image as os-image partition.
185 We use a 1.5MB partition for the compressed kernel, which should
186 be sufficient, but not too wasteful (the flash of the TL-WR1043 v4
189 .id
= "16Msafeloader",
190 .fw_max_len
= 0x180000,
191 .kernel_la
= 0x80060000,
192 .kernel_ep
= 0x80060000,
195 /* terminating entry */
199 static const struct fw_region regions
[] = {
200 /* Default region (universal) uses code 0 as well */
208 #define ERR(fmt, ...) do { \
210 fprintf(stderr, "[%s] *** error: " fmt "\n", \
211 progname, ## __VA_ARGS__ ); \
214 #define ERRS(fmt, ...) do { \
217 fprintf(stderr, "[%s] *** error: " fmt ": %s\n", \
218 progname, ## __VA_ARGS__, strerror(save)); \
221 #define DBG(fmt, ...) do { \
222 fprintf(stderr, "[%s] " fmt "\n", progname, ## __VA_ARGS__ ); \
225 static struct flash_layout
*find_layout(const char *id
)
227 struct flash_layout
*ret
;
228 struct flash_layout
*l
;
231 for (l
= layouts
; l
->id
!= NULL
; l
++){
232 if (strcasecmp(id
, l
->id
) == 0) {
241 static const struct fw_region
* find_region(const char *country
) {
244 for (i
= 0; i
< ARRAY_SIZE(regions
); i
++) {
245 if (strcasecmp(regions
[i
].name
, country
) == 0)
252 static void usage(int status
)
254 fprintf(stderr
, "Usage: %s [OPTIONS...]\n", progname
);
258 " -c use combined kernel image\n"
259 " -E <ep> overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
260 " -L <la> overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
261 " -H <hwid> use hardware id specified with <hwid>\n"
262 " -W <hwrev> use hardware revision specified with <hwrev>\n"
263 " -C <country> set region code to <country>\n"
264 " -F <id> use flash layout specified with <id>\n"
265 " -k <file> read kernel image from the file <file>\n"
266 " -r <file> read rootfs image from the file <file>\n"
267 " -a <align> align the rootfs start on an <align> bytes boundary\n"
268 " -R <offset> overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
269 " -o <file> write output to the file <file>\n"
270 " -s strip padding from the end of the image\n"
271 " -S ignore firmware size limit (only for combined images)\n"
272 " -j add jffs2 end-of-filesystem markers\n"
273 " -N <vendor> set image vendor to <vendor>\n"
274 " -V <version> set image version to <version>\n"
275 " -v <version> set firmware version to <version>\n"
276 " -m <version> set header version to <version>\n"
277 " -i <file> inspect given firmware file <file>\n"
278 " -x extract kernel and rootfs while inspecting (requires -i)\n"
279 " -X <size> reserve <size> bytes in the firmware image (hexval prefixed with 0x)\n"
280 " -h show this screen\n"
286 static void get_md5(const char *data
, int size
, uint8_t *md5
)
291 MD5_Update(&ctx
, data
, size
);
292 MD5_Final(md5
, &ctx
);
295 static int get_file_stat(struct file_info
*fdata
)
300 if (fdata
->file_name
== NULL
)
303 res
= stat(fdata
->file_name
, &st
);
305 ERRS("stat failed on %s", fdata
->file_name
);
309 fdata
->file_size
= st
.st_size
;
313 static int read_to_buf(const struct file_info
*fdata
, char *buf
)
316 int ret
= EXIT_FAILURE
;
318 f
= fopen(fdata
->file_name
, "r");
320 ERRS("could not open \"%s\" for reading", fdata
->file_name
);
325 fread(buf
, fdata
->file_size
, 1, f
);
327 ERRS("unable to read from file \"%s\"", fdata
->file_name
);
339 static int check_options(void)
344 if (inspect_info
.file_name
) {
345 ret
= get_file_stat(&inspect_info
);
350 } else if (extract
) {
351 ERR("no firmware for inspection specified");
355 if (opt_hw_id
== NULL
) {
356 ERR("hardware id not specified");
359 hw_id
= strtoul(opt_hw_id
, NULL
, 0);
361 if (layout_id
== NULL
) {
362 ERR("flash layout is not specified");
367 hw_rev
= strtoul(opt_hw_rev
, NULL
, 0);
372 region
= find_region(country
);
374 ERR("unknown region code \"%s\"", country
);
379 layout
= find_layout(layout_id
);
380 if (layout
== NULL
) {
381 ERR("unknown flash layout \"%s\"", layout_id
);
386 kernel_la
= layout
->kernel_la
;
388 kernel_ep
= layout
->kernel_ep
;
390 rootfs_ofs
= layout
->rootfs_ofs
;
392 if (reserved_space
> layout
->fw_max_len
) {
393 ERR("reserved space is not valid");
397 fw_max_len
= layout
->fw_max_len
- reserved_space
;
399 if (kernel_info
.file_name
== NULL
) {
400 ERR("no kernel image specified");
404 ret
= get_file_stat(&kernel_info
);
408 kernel_len
= kernel_info
.file_size
;
411 exceed_bytes
= kernel_info
.file_size
- (fw_max_len
- sizeof(struct fw_header
));
412 if (exceed_bytes
> 0) {
414 ERR("kernel image is too big by %i bytes", exceed_bytes
);
417 layout
->fw_max_len
= sizeof(struct fw_header
) +
418 kernel_info
.file_size
+
422 if (rootfs_info
.file_name
== NULL
) {
423 ERR("no rootfs image specified");
427 ret
= get_file_stat(&rootfs_info
);
432 kernel_len
+= sizeof(struct fw_header
);
433 kernel_len
= ALIGN(kernel_len
, rootfs_align
);
434 kernel_len
-= sizeof(struct fw_header
);
436 DBG("kernel length aligned to %u", kernel_len
);
438 exceed_bytes
= kernel_len
+ rootfs_info
.file_size
- (fw_max_len
- sizeof(struct fw_header
));
439 if (exceed_bytes
> 0) {
440 ERR("images are too big by %i bytes", exceed_bytes
);
444 exceed_bytes
= kernel_info
.file_size
- (rootfs_ofs
- sizeof(struct fw_header
));
445 if (exceed_bytes
> 0) {
446 ERR("kernel image is too big by %i bytes", exceed_bytes
);
450 exceed_bytes
= rootfs_info
.file_size
- (fw_max_len
- rootfs_ofs
);
451 if (exceed_bytes
> 0) {
452 ERR("rootfs image is too big by %i bytes", exceed_bytes
);
458 if (ofname
== NULL
) {
459 ERR("no output file specified");
463 ret
= sscanf(fw_ver
, "%d.%d.%d", &fw_ver_hi
, &fw_ver_mid
, &fw_ver_lo
);
465 ERR("invalid firmware version '%s'", fw_ver
);
469 if (opt_hdr_ver
== 1) {
470 hdr_ver
= HEADER_VERSION_V1
;
471 } else if (opt_hdr_ver
== 2) {
472 hdr_ver
= HEADER_VERSION_V2
;
474 ERR("invalid header version '%u'", opt_hdr_ver
);
481 static void fill_header(char *buf
, int len
)
483 struct fw_header
*hdr
= (struct fw_header
*)buf
;
485 memset(hdr
, 0, sizeof(struct fw_header
));
487 hdr
->version
= htonl(hdr_ver
);
488 strncpy(hdr
->vendor_name
, vendor
, sizeof(hdr
->vendor_name
));
489 strncpy(hdr
->fw_version
, version
, sizeof(hdr
->fw_version
));
490 hdr
->hw_id
= htonl(hw_id
);
491 hdr
->hw_rev
= htonl(hw_rev
);
493 if (boot_info
.file_size
== 0)
494 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(hdr
->md5sum1
));
496 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(hdr
->md5sum1
));
498 hdr
->kernel_la
= htonl(kernel_la
);
499 hdr
->kernel_ep
= htonl(kernel_ep
);
500 hdr
->fw_length
= htonl(layout
->fw_max_len
);
501 hdr
->kernel_ofs
= htonl(sizeof(struct fw_header
));
502 hdr
->kernel_len
= htonl(kernel_len
);
504 hdr
->rootfs_ofs
= htonl(rootfs_ofs
);
505 hdr
->rootfs_len
= htonl(rootfs_info
.file_size
);
508 hdr
->ver_hi
= htons(fw_ver_hi
);
509 hdr
->ver_mid
= htons(fw_ver_mid
);
510 hdr
->ver_lo
= htons(fw_ver_lo
);
513 hdr
->region_code
= htonl(region
->code
);
515 hdr
->region_str1
, sizeof(hdr
->region_str1
), "00000000;%02X%02X%02X%02X;",
516 region
->name
[0], region
->name
[1], region
->name
[2], region
->name
[3]
519 hdr
->region_str2
, sizeof(hdr
->region_str2
), "%02X%02X%02X%02X",
520 region
->name
[0], region
->name
[1], region
->name
[2], region
->name
[3]
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(const 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(const char *label
, const char *str
)
655 printf("%-23s: %s\n", label
, str
);
658 static inline void inspect_fw_phex(const char *label
, uint32_t val
)
660 printf("%-23s: 0x%08x\n", label
, val
);
663 static inline void inspect_fw_phexdec(const char *label
, uint32_t val
)
665 printf("%-23s: 0x%08x / %8u bytes\n", label
, val
, val
);
668 static inline void inspect_fw_pmd5sum(const char *label
, const uint8_t *val
, const char *text
)
672 printf("%-23s:", label
);
673 for (i
=0; i
<MD5SUM_LEN
; i
++)
674 printf(" %02x", val
[i
]);
675 printf(" %s\n", text
);
678 static int inspect_fw(void)
681 struct fw_header
*hdr
;
682 uint8_t md5sum
[MD5SUM_LEN
];
683 int ret
= EXIT_FAILURE
;
685 buf
= malloc(inspect_info
.file_size
);
687 ERR("no memory for buffer!\n");
691 ret
= read_to_buf(&inspect_info
, buf
);
694 hdr
= (struct fw_header
*)buf
;
696 inspect_fw_pstr("File name", inspect_info
.file_name
);
697 inspect_fw_phexdec("File size", inspect_info
.file_size
);
699 if ((ntohl(hdr
->version
) != HEADER_VERSION_V1
) &&
700 (ntohl(hdr
->version
) != HEADER_VERSION_V2
)) {
701 ERR("file does not seem to have V1/V2 header!\n");
705 inspect_fw_phexdec("Version 1 Header size", sizeof(struct fw_header
));
707 memcpy(md5sum
, hdr
->md5sum1
, sizeof(md5sum
));
708 if (ntohl(hdr
->boot_len
) == 0)
709 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(md5sum
));
711 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(md5sum
));
712 get_md5(buf
, inspect_info
.file_size
, hdr
->md5sum1
);
714 if (memcmp(md5sum
, hdr
->md5sum1
, sizeof(md5sum
))) {
715 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(*ERROR*)");
716 inspect_fw_pmd5sum(" --> expected", hdr
->md5sum1
, "");
718 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(ok)");
720 if (ntohl(hdr
->unk2
) != 0)
721 inspect_fw_phexdec("Unknown value 2", hdr
->unk2
);
722 inspect_fw_pmd5sum("Header MD5Sum2", hdr
->md5sum2
,
723 "(purpose yet unknown, unchecked here)");
724 if (ntohl(hdr
->unk3
) != 0)
725 inspect_fw_phexdec("Unknown value 3", hdr
->unk3
);
729 inspect_fw_pstr("Vendor name", hdr
->vendor_name
);
730 inspect_fw_pstr("Firmware version", hdr
->fw_version
);
731 inspect_fw_phex("Hardware ID", ntohl(hdr
->hw_id
));
732 inspect_fw_phex("Hardware Revision", ntohl(hdr
->hw_rev
));
733 inspect_fw_phex("Region code", ntohl(hdr
->region_code
));
737 inspect_fw_phexdec("Kernel data offset",
738 ntohl(hdr
->kernel_ofs
));
739 inspect_fw_phexdec("Kernel data length",
740 ntohl(hdr
->kernel_len
));
741 inspect_fw_phex("Kernel load address",
742 ntohl(hdr
->kernel_la
));
743 inspect_fw_phex("Kernel entry point",
744 ntohl(hdr
->kernel_ep
));
745 inspect_fw_phexdec("Rootfs data offset",
746 ntohl(hdr
->rootfs_ofs
));
747 inspect_fw_phexdec("Rootfs data length",
748 ntohl(hdr
->rootfs_len
));
749 inspect_fw_phexdec("Boot loader data offset",
750 ntohl(hdr
->boot_ofs
));
751 inspect_fw_phexdec("Boot loader data length",
752 ntohl(hdr
->boot_len
));
753 inspect_fw_phexdec("Total firmware length",
754 ntohl(hdr
->fw_length
));
762 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
763 sprintf(filename
, "%s-kernel", inspect_info
.file_name
);
764 printf("Extracting kernel to \"%s\"...\n", filename
);
765 fp
= fopen(filename
, "w");
767 if (!fwrite(buf
+ ntohl(hdr
->kernel_ofs
),
768 ntohl(hdr
->kernel_len
), 1, fp
)) {
769 ERR("error in fwrite(): %s", strerror(errno
));
773 ERR("error in fopen(): %s", strerror(errno
));
777 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
778 sprintf(filename
, "%s-rootfs", inspect_info
.file_name
);
779 printf("Extracting rootfs to \"%s\"...\n", filename
);
780 fp
= fopen(filename
, "w");
782 if (!fwrite(buf
+ ntohl(hdr
->rootfs_ofs
),
783 ntohl(hdr
->rootfs_len
), 1, fp
)) {
784 ERR("error in fwrite(): %s", strerror(errno
));
788 ERR("error in fopen(): %s", strerror(errno
));
799 int main(int argc
, char *argv
[])
801 int ret
= EXIT_FAILURE
;
803 progname
= basename(argv
[0]);
808 c
= getopt(argc
, argv
, "a:H:E:F:L:m:V:N:W:C:ci:k:r:R:o:xX:hsSjv:");
814 sscanf(optarg
, "0x%x", &rootfs_align
);
820 sscanf(optarg
, "0x%x", &kernel_ep
);
832 sscanf(optarg
, "0x%x", &kernel_la
);
835 sscanf(optarg
, "%u", &opt_hdr_ver
);
850 kernel_info
.file_name
= optarg
;
853 rootfs_info
.file_name
= optarg
;
856 sscanf(optarg
, "0x%x", &rootfs_ofs
);
868 inspect_info
.file_name
= optarg
;
880 sscanf(optarg
, "0x%x", &reserved_space
);
888 ret
= check_options();
892 if (!inspect_info
.file_name
)