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"
33 #define HEADER_VERSION_V1 0x01000000
34 #define HEADER_VERSION_V2 0x02000000
37 uint32_t version
; /* header version */
40 uint32_t hw_id
; /* hardware id */
41 uint32_t hw_rev
; /* hardware revision */
42 uint32_t region_code
; /* region code */
43 uint8_t md5sum1
[MD5SUM_LEN
];
45 uint8_t md5sum2
[MD5SUM_LEN
];
47 uint32_t kernel_la
; /* kernel load address */
48 uint32_t kernel_ep
; /* kernel entry point */
49 uint32_t fw_length
; /* total length of the firmware */
50 uint32_t kernel_ofs
; /* kernel data offset */
51 uint32_t kernel_len
; /* kernel data length */
52 uint32_t rootfs_ofs
; /* rootfs data offset */
53 uint32_t rootfs_len
; /* rootfs data length */
54 uint32_t boot_ofs
; /* bootloader data offset */
55 uint32_t boot_len
; /* bootloader data length */
63 } __attribute__ ((packed
));
76 static char *vendor
= "TP-LINK Technologies";
77 static char *version
= "ver. 1.0";
78 static char *fw_ver
= "0.0.0";
79 static uint32_t hdr_ver
= HEADER_VERSION_V1
;
81 static char *layout_id
;
82 static struct flash_layout
*layout
;
83 static char *opt_hw_id
;
84 static uint32_t hw_id
;
85 static char *opt_hw_rev
;
86 static uint32_t hw_rev
;
87 static uint32_t opt_hdr_ver
= 1;
89 static const struct fw_region
*region
;
91 static int fw_ver_mid
;
93 static struct file_info kernel_info
;
94 static uint32_t kernel_la
= 0;
95 static uint32_t kernel_ep
= 0;
96 static uint32_t kernel_len
= 0;
97 static struct file_info rootfs_info
;
98 static uint32_t rootfs_ofs
= 0;
99 static uint32_t rootfs_align
;
100 static struct file_info boot_info
;
102 static int strip_padding
;
103 static int add_jffs2_eof
;
104 static uint32_t fw_max_len
;
105 static uint32_t reserved_space
;
107 static struct file_info inspect_info
;
108 static int extract
= 0;
109 static bool endian_swap
= false;
111 static const char md5salt_normal
[MD5SUM_LEN
] = {
112 0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
113 0xdd, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x38,
116 static const char md5salt_boot
[MD5SUM_LEN
] = {
117 0x8c, 0xef, 0x33, 0x5b, 0xd5, 0xc5, 0xce, 0xfa,
118 0xa7, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
121 static struct flash_layout layouts
[] = {
124 .fw_max_len
= 0x3c0000,
125 .kernel_la
= 0x80060000,
126 .kernel_ep
= 0x80060000,
127 .rootfs_ofs
= 0x140000,
130 .fw_max_len
= 0x3c0000,
131 .kernel_la
= 0x80060000,
132 .kernel_ep
= 0x80060000,
133 .rootfs_ofs
= 0x100000,
136 .fw_max_len
= 0x7c0000,
137 .kernel_la
= 0x80060000,
138 .kernel_ep
= 0x80060000,
139 .rootfs_ofs
= 0x140000,
142 .fw_max_len
= 0x7c0000,
143 .kernel_la
= 0x80060000,
144 .kernel_ep
= 0x80060000,
145 .rootfs_ofs
= 0x100000,
148 .fw_max_len
= 0xf80000,
149 .kernel_la
= 0x80060000,
150 .kernel_ep
= 0x80060000,
151 .rootfs_ofs
= 0x140000,
154 .fw_max_len
= 0xf80000,
155 .kernel_la
= 0x80060000,
156 .kernel_ep
= 0x80060000,
157 .rootfs_ofs
= 0x100000,
160 .fw_max_len
= 0xf80000,
161 .kernel_la
= 0x00000000 ,
162 .kernel_ep
= 0xc0000000,
163 .rootfs_ofs
= 0x2a0000,
165 /* terminating entry */
169 static const struct fw_region regions
[] = {
170 /* Default region (universal) uses code 0 as well */
175 static const struct fw_region
* find_region(const char *country
) {
178 for (i
= 0; i
< ARRAY_SIZE(regions
); i
++) {
179 if (strcasecmp(regions
[i
].name
, country
) == 0)
186 static void usage(int status
)
188 fprintf(stderr
, "Usage: %s [OPTIONS...]\n", progname
);
192 " -c use combined kernel image\n"
193 " -e swap endianness in kernel load address and entry point\n"
194 " -E <ep> overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
195 " -L <la> overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
196 " -H <hwid> use hardware id specified with <hwid>\n"
197 " -W <hwrev> use hardware revision specified with <hwrev>\n"
198 " -C <country> set region code to <country>\n"
199 " -F <id> use flash layout specified with <id>\n"
200 " -k <file> read kernel image from the file <file>\n"
201 " -r <file> read rootfs image from the file <file>\n"
202 " -a <align> align the rootfs start on an <align> bytes boundary\n"
203 " -R <offset> overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
204 " -o <file> write output to the file <file>\n"
205 " -s strip padding from the end of the image\n"
206 " -j add jffs2 end-of-filesystem markers\n"
207 " -N <vendor> set image vendor to <vendor>\n"
208 " -V <version> set image version to <version>\n"
209 " -v <version> set firmware version to <version>\n"
210 " -m <version> set header version to <version>\n"
211 " -i <file> inspect given firmware file <file>\n"
212 " -x extract kernel and rootfs while inspecting (requires -i)\n"
213 " -X <size> reserve <size> bytes in the firmware image (hexval prefixed with 0x)\n"
214 " -h show this screen\n"
220 static int check_options(void)
225 if (inspect_info
.file_name
) {
226 ret
= get_file_stat(&inspect_info
);
231 } else if (extract
) {
232 ERR("no firmware for inspection specified");
236 if (opt_hw_id
== NULL
) {
237 ERR("hardware id not specified");
240 hw_id
= strtoul(opt_hw_id
, NULL
, 0);
242 if (!combined
&& layout_id
== NULL
) {
243 ERR("flash layout is not specified");
248 hw_rev
= strtoul(opt_hw_rev
, NULL
, 0);
253 region
= find_region(country
);
255 ERR("unknown region code \"%s\"", country
);
261 if (!kernel_la
|| !kernel_ep
) {
262 ERR("kernel loading address and entry point must be specified for combined image");
266 layout
= find_layout(layouts
, layout_id
);
267 if (layout
== NULL
) {
268 ERR("unknown flash layout \"%s\"", layout_id
);
273 kernel_la
= layout
->kernel_la
;
275 kernel_ep
= layout
->kernel_ep
;
277 rootfs_ofs
= layout
->rootfs_ofs
;
279 if (reserved_space
> layout
->fw_max_len
) {
280 ERR("reserved space is not valid");
285 if (kernel_info
.file_name
== NULL
) {
286 ERR("no kernel image specified");
290 ret
= get_file_stat(&kernel_info
);
294 kernel_len
= kernel_info
.file_size
;
297 fw_max_len
= layout
->fw_max_len
- reserved_space
;
299 if (rootfs_info
.file_name
== NULL
) {
300 ERR("no rootfs image specified");
304 ret
= get_file_stat(&rootfs_info
);
309 kernel_len
+= sizeof(struct fw_header
);
310 kernel_len
= ALIGN(kernel_len
, rootfs_align
);
311 kernel_len
-= sizeof(struct fw_header
);
313 DBG("kernel length aligned to %u", kernel_len
);
315 exceed_bytes
= kernel_len
+ rootfs_info
.file_size
- (fw_max_len
- sizeof(struct fw_header
));
316 if (exceed_bytes
> 0) {
317 ERR("images are too big by %i bytes", exceed_bytes
);
321 exceed_bytes
= kernel_info
.file_size
- (rootfs_ofs
- sizeof(struct fw_header
));
322 if (exceed_bytes
> 0) {
323 ERR("kernel image is too big by %i bytes", exceed_bytes
);
327 exceed_bytes
= rootfs_info
.file_size
- (fw_max_len
- rootfs_ofs
);
328 if (exceed_bytes
> 0) {
329 ERR("rootfs image is too big by %i bytes", exceed_bytes
);
335 if (ofname
== NULL
) {
336 ERR("no output file specified");
340 ret
= sscanf(fw_ver
, "%d.%d.%d", &fw_ver_hi
, &fw_ver_mid
, &fw_ver_lo
);
342 ERR("invalid firmware version '%s'", fw_ver
);
346 if (opt_hdr_ver
== 1) {
347 hdr_ver
= HEADER_VERSION_V1
;
348 } else if (opt_hdr_ver
== 2) {
349 hdr_ver
= HEADER_VERSION_V2
;
351 ERR("invalid header version '%u'", opt_hdr_ver
);
358 static void fill_header(char *buf
, int len
)
360 struct fw_header
*hdr
= (struct fw_header
*)buf
;
362 memset(hdr
, 0, sizeof(struct fw_header
));
364 hdr
->version
= htonl(hdr_ver
);
365 strncpy(hdr
->vendor_name
, vendor
, sizeof(hdr
->vendor_name
));
366 strncpy(hdr
->fw_version
, version
, sizeof(hdr
->fw_version
));
367 hdr
->hw_id
= htonl(hw_id
);
368 hdr
->hw_rev
= htonl(hw_rev
);
370 hdr
->kernel_la
= htonl(kernel_la
);
371 hdr
->kernel_ep
= htonl(kernel_ep
);
372 hdr
->kernel_ofs
= htonl(sizeof(struct fw_header
));
373 hdr
->kernel_len
= htonl(kernel_len
);
376 if (boot_info
.file_size
== 0)
377 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(hdr
->md5sum1
));
379 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(hdr
->md5sum1
));
381 hdr
->fw_length
= htonl(layout
->fw_max_len
);
382 hdr
->rootfs_ofs
= htonl(rootfs_ofs
);
383 hdr
->rootfs_len
= htonl(rootfs_info
.file_size
);
386 hdr
->ver_hi
= htons(fw_ver_hi
);
387 hdr
->ver_mid
= htons(fw_ver_mid
);
388 hdr
->ver_lo
= htons(fw_ver_lo
);
391 hdr
->region_code
= htonl(region
->code
);
393 hdr
->region_str1
, sizeof(hdr
->region_str1
), "00000000;%02X%02X%02X%02X;",
394 region
->name
[0], region
->name
[1], region
->name
[2], region
->name
[3]
397 hdr
->region_str2
, sizeof(hdr
->region_str2
), "%02X%02X%02X%02X",
398 region
->name
[0], region
->name
[1], region
->name
[2], region
->name
[3]
403 hdr
->kernel_la
= bswap_32(hdr
->kernel_la
);
404 hdr
->kernel_ep
= bswap_32(hdr
->kernel_ep
);
408 get_md5(buf
, len
, hdr
->md5sum1
);
411 static int build_fw(void)
416 int ret
= EXIT_FAILURE
;
419 writelen
= sizeof(struct fw_header
) + kernel_len
;
424 buflen
= layout
->fw_max_len
;
426 buf
= malloc(buflen
);
428 ERR("no memory for buffer\n");
432 memset(buf
, 0xff, buflen
);
433 p
= buf
+ sizeof(struct fw_header
);
434 ret
= read_to_buf(&kernel_info
, p
);
443 p
= buf
+ rootfs_ofs
;
445 ret
= read_to_buf(&rootfs_info
, p
);
450 writelen
+= rootfs_info
.file_size
;
452 writelen
= rootfs_ofs
+ rootfs_info
.file_size
;
455 writelen
= pad_jffs2(buf
, writelen
, layout
->fw_max_len
);
461 fill_header(buf
, writelen
);
462 ret
= write_fw(ofname
, buf
, writelen
);
474 static int inspect_fw(void)
477 struct fw_header
*hdr
;
478 uint8_t md5sum
[MD5SUM_LEN
];
479 int ret
= EXIT_FAILURE
;
481 buf
= malloc(inspect_info
.file_size
);
483 ERR("no memory for buffer!\n");
487 ret
= read_to_buf(&inspect_info
, buf
);
490 hdr
= (struct fw_header
*)buf
;
492 inspect_fw_pstr("File name", inspect_info
.file_name
);
493 inspect_fw_phexdec("File size", inspect_info
.file_size
);
495 if ((ntohl(hdr
->version
) != HEADER_VERSION_V1
) &&
496 (ntohl(hdr
->version
) != HEADER_VERSION_V2
)) {
497 ERR("file does not seem to have V1/V2 header!\n");
501 inspect_fw_phexdec("Version 1 Header size", sizeof(struct fw_header
));
503 memcpy(md5sum
, hdr
->md5sum1
, sizeof(md5sum
));
504 if (ntohl(hdr
->boot_len
) == 0)
505 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(md5sum
));
507 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(md5sum
));
508 get_md5(buf
, inspect_info
.file_size
, hdr
->md5sum1
);
510 if (memcmp(md5sum
, hdr
->md5sum1
, sizeof(md5sum
))) {
511 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(*ERROR*)");
512 inspect_fw_pmd5sum(" --> expected", hdr
->md5sum1
, "");
514 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(ok)");
516 if (ntohl(hdr
->unk2
) != 0)
517 inspect_fw_phexdec("Unknown value 2", hdr
->unk2
);
518 inspect_fw_pmd5sum("Header MD5Sum2", hdr
->md5sum2
,
519 "(purpose yet unknown, unchecked here)");
520 if (ntohl(hdr
->unk3
) != 0)
521 inspect_fw_phexdec("Unknown value 3", hdr
->unk3
);
525 inspect_fw_pstr("Vendor name", hdr
->vendor_name
);
526 inspect_fw_pstr("Firmware version", hdr
->fw_version
);
527 inspect_fw_phex("Hardware ID", ntohl(hdr
->hw_id
));
528 inspect_fw_phex("Hardware Revision", ntohl(hdr
->hw_rev
));
529 inspect_fw_phex("Region code", ntohl(hdr
->region_code
));
533 inspect_fw_phexdec("Kernel data offset",
534 ntohl(hdr
->kernel_ofs
));
535 inspect_fw_phexdec("Kernel data length",
536 ntohl(hdr
->kernel_len
));
537 inspect_fw_phex("Kernel load address",
538 ntohl(hdr
->kernel_la
));
539 inspect_fw_phex("Kernel entry point",
540 ntohl(hdr
->kernel_ep
));
541 inspect_fw_phexdec("Rootfs data offset",
542 ntohl(hdr
->rootfs_ofs
));
543 inspect_fw_phexdec("Rootfs data length",
544 ntohl(hdr
->rootfs_len
));
545 inspect_fw_phexdec("Boot loader data offset",
546 ntohl(hdr
->boot_ofs
));
547 inspect_fw_phexdec("Boot loader data length",
548 ntohl(hdr
->boot_len
));
549 inspect_fw_phexdec("Total firmware length",
550 ntohl(hdr
->fw_length
));
558 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
559 sprintf(filename
, "%s-kernel", inspect_info
.file_name
);
560 printf("Extracting kernel to \"%s\"...\n", filename
);
561 fp
= fopen(filename
, "w");
563 if (!fwrite(buf
+ ntohl(hdr
->kernel_ofs
),
564 ntohl(hdr
->kernel_len
), 1, fp
)) {
565 ERR("error in fwrite(): %s", strerror(errno
));
569 ERR("error in fopen(): %s", strerror(errno
));
573 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
574 sprintf(filename
, "%s-rootfs", inspect_info
.file_name
);
575 printf("Extracting rootfs to \"%s\"...\n", filename
);
576 fp
= fopen(filename
, "w");
578 if (!fwrite(buf
+ ntohl(hdr
->rootfs_ofs
),
579 ntohl(hdr
->rootfs_len
), 1, fp
)) {
580 ERR("error in fwrite(): %s", strerror(errno
));
584 ERR("error in fopen(): %s", strerror(errno
));
595 int main(int argc
, char *argv
[])
597 int ret
= EXIT_FAILURE
;
599 progname
= basename(argv
[0]);
604 c
= getopt(argc
, argv
, "a:H:E:F:L:m:V:N:W:C:ci:k:r:R:o:xX:ehsjv:");
610 sscanf(optarg
, "0x%x", &rootfs_align
);
616 sscanf(optarg
, "0x%x", &kernel_ep
);
628 sscanf(optarg
, "0x%x", &kernel_la
);
631 sscanf(optarg
, "%u", &opt_hdr_ver
);
646 kernel_info
.file_name
= optarg
;
649 rootfs_info
.file_name
= optarg
;
652 sscanf(optarg
, "0x%x", &rootfs_ofs
);
661 inspect_info
.file_name
= optarg
;
676 sscanf(optarg
, "0x%x", &reserved_space
);
684 ret
= check_options();
688 if (!inspect_info
.file_name
)