35db848bbab9f8315526dfa24ed351ad58878dde
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"
34 uint32_t version
; /* 0x00: header version */
35 char fw_version
[48]; /* 0x04: fw version string */
36 uint32_t hw_id
; /* 0x34: hardware id */
37 uint32_t hw_rev
; /* 0x38: FIXME: hardware revision? */
38 uint32_t hw_ver_add
; /* 0x3c: additional hardware version */
39 uint8_t md5sum1
[MD5SUM_LEN
]; /* 0x40 */
40 uint32_t unk2
; /* 0x50: 0x00000000 */
41 uint8_t md5sum2
[MD5SUM_LEN
]; /* 0x54 */
42 uint32_t unk3
; /* 0x64: 0xffffffff */
44 uint32_t kernel_la
; /* 0x68: kernel load address */
45 uint32_t kernel_ep
; /* 0x6c: kernel entry point */
46 uint32_t fw_length
; /* 0x70: total length of the image */
47 uint32_t kernel_ofs
; /* 0x74: kernel data offset */
48 uint32_t kernel_len
; /* 0x78: kernel data length */
49 uint32_t rootfs_ofs
; /* 0x7c: rootfs data offset */
50 uint32_t rootfs_len
; /* 0x80: rootfs data length */
51 uint32_t boot_ofs
; /* 0x84: bootloader offset */
52 uint32_t boot_len
; /* 0x88: bootloader length */
53 uint16_t unk4
; /* 0x8c: 0x55aa */
54 uint8_t sver_hi
; /* 0x8e */
55 uint8_t sver_lo
; /* 0x8f */
56 uint8_t unk5
; /* 0x90: magic: 0xa5 */
57 uint8_t ver_hi
; /* 0x91 */
58 uint8_t ver_mid
; /* 0x92 */
59 uint8_t ver_lo
; /* 0x93 */
61 } __attribute__ ((packed
));
63 #define FLAG_LE_KERNEL_LA_EP 0x00000001 /* Little-endian used for kernel load address & entry point */
80 static char *vendor
= "TP-LINK Technologies";
81 static char *version
= "ver. 1.0";
82 static char *fw_ver
= "0.0.0";
83 static char *sver
= "1.0";
84 static uint32_t hdr_ver
= 2;
86 static struct board_info custom_board
;
88 static struct board_info
*board
;
89 static char *layout_id
;
90 struct flash_layout
*layout
;
91 static char *opt_hw_id
;
92 static char *opt_hw_rev
;
93 static char *opt_hw_ver_add
;
95 static int fw_ver_mid
;
99 struct file_info kernel_info
;
100 static uint32_t kernel_la
= 0;
101 static uint32_t kernel_ep
= 0;
102 uint32_t kernel_len
= 0;
103 struct file_info rootfs_info
;
104 uint32_t rootfs_ofs
= 0;
105 uint32_t rootfs_align
;
106 static struct file_info boot_info
;
111 static struct file_info inspect_info
;
112 static int extract
= 0;
114 char md5salt_normal
[MD5SUM_LEN
] = {
115 0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
116 0xdc, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x37,
119 char md5salt_boot
[MD5SUM_LEN
] = {
120 0x8c, 0xef, 0x33, 0x5f, 0xd5, 0xc5, 0xce, 0xfa,
121 0xac, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
124 static struct flash_layout layouts
[] = {
127 .fw_max_len
= 0x3d0000,
128 .kernel_la
= 0x80000000,
129 .kernel_ep
= 0x80000000,
130 .rootfs_ofs
= 0x140000,
133 .fw_max_len
= 0x7a0000,
134 .kernel_la
= 0x80002000,
135 .kernel_ep
= 0x80002000,
136 .rootfs_ofs
= 0x140000,
139 .fw_max_len
= 0xf90000,
140 .kernel_la
= 0x80002000,
141 .kernel_ep
= 0x800061b0,
142 .rootfs_ofs
= 0x140000,
145 .fw_max_len
= 0x7a0000,
146 .kernel_la
= 0x80000000,
147 .kernel_ep
= 0x80000000,
148 .rootfs_ofs
= 0x140000,
150 .id
= "8MSUmtk", /* Split U-Boot OS */
151 .fw_max_len
= 0x770000,
152 .kernel_la
= 0x80000000,
153 .kernel_ep
= 0x80000000,
154 .rootfs_ofs
= 0x140000,
157 .fw_max_len
= 0x7b0000,
158 .kernel_la
= 0x80000000,
159 .kernel_ep
= 0x80000000,
160 .rootfs_ofs
= 0x140000,
162 /* terminating entry */
166 static void usage(int status
)
168 FILE *stream
= (status
!= EXIT_SUCCESS
) ? stderr
: stdout
;
169 struct board_info
*board
;
171 fprintf(stream
, "Usage: %s [OPTIONS...]\n", progname
);
175 " -c use combined kernel image\n"
176 " -e swap endianness in kernel load address and entry point\n"
177 " -E <ep> overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
178 " -L <la> overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
179 " -H <hwid> use hardware id specified with <hwid>\n"
180 " -W <hwrev> use hardware revision specified with <hwrev>\n"
181 " -w <hwveradd> use additional hardware version specified with <hwveradd>\n"
182 " -F <id> use flash layout specified with <id>\n"
183 " -k <file> read kernel image from the file <file>\n"
184 " -r <file> read rootfs image from the file <file>\n"
185 " -a <align> align the rootfs start on an <align> bytes boundary\n"
186 " -R <offset> overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
187 " -o <file> write output to the file <file>\n"
188 " -s strip padding from the end of the image\n"
189 " -j add jffs2 end-of-filesystem markers\n"
190 " -N <vendor> set image vendor to <vendor>\n"
191 " -T <version> set header version to <version>\n"
192 " -V <version> set image version to <version>\n"
193 " -v <version> set firmware version to <version>\n"
194 " -y <version> set secondary version to <version>\n"
195 " -i <file> inspect given firmware file <file>\n"
196 " -x extract kernel and rootfs while inspecting (requires -i)\n"
197 " -h show this screen\n"
203 static int check_options(void)
207 if (inspect_info
.file_name
) {
208 ret
= get_file_stat(&inspect_info
);
213 } else if (extract
) {
214 ERR("no firmware for inspection specified");
218 if (opt_hw_id
== NULL
) {
219 ERR("hardware id must be specified");
223 board
= &custom_board
;
225 if (layout_id
== NULL
) {
226 ERR("flash layout is not specified");
230 board
->hw_id
= strtoul(opt_hw_id
, NULL
, 0);
233 board
->hw_ver_add
= 0;
236 board
->hw_rev
= strtoul(opt_hw_rev
, NULL
, 0);
238 board
->hw_ver_add
= strtoul(opt_hw_ver_add
, NULL
, 0);
240 layout
= find_layout(layouts
, layout_id
);
241 if (layout
== NULL
) {
242 ERR("unknown flash layout \"%s\"", layout_id
);
247 kernel_la
= layout
->kernel_la
;
249 kernel_ep
= layout
->kernel_ep
;
251 rootfs_ofs
= layout
->rootfs_ofs
;
253 if (kernel_info
.file_name
== NULL
) {
254 ERR("no kernel image specified");
258 ret
= get_file_stat(&kernel_info
);
262 kernel_len
= kernel_info
.file_size
;
265 if (kernel_info
.file_size
>
266 layout
->fw_max_len
- sizeof(struct fw_header
)) {
267 ERR("kernel image is too big");
271 if (rootfs_info
.file_name
== NULL
) {
272 ERR("no rootfs image specified");
276 ret
= get_file_stat(&rootfs_info
);
281 kernel_len
+= sizeof(struct fw_header
);
282 rootfs_ofs
= ALIGN(kernel_len
, rootfs_align
);
283 kernel_len
-= sizeof(struct fw_header
);
285 DBG("rootfs offset aligned to 0x%u", rootfs_ofs
);
287 if (kernel_len
+ rootfs_info
.file_size
>
288 layout
->fw_max_len
- sizeof(struct fw_header
)) {
289 ERR("images are too big");
293 if (kernel_info
.file_size
>
294 rootfs_ofs
- sizeof(struct fw_header
)) {
295 ERR("kernel image is too big");
299 if (rootfs_info
.file_size
>
300 (layout
->fw_max_len
- rootfs_ofs
)) {
301 ERR("rootfs image is too big");
307 if (ofname
== NULL
) {
308 ERR("no output file specified");
312 ret
= sscanf(fw_ver
, "%d.%d.%d", &fw_ver_hi
, &fw_ver_mid
, &fw_ver_lo
);
314 ERR("invalid firmware version '%s'", fw_ver
);
318 ret
= sscanf(sver
, "%d.%d", &sver_hi
, &sver_lo
);
320 ERR("invalid secondary version '%s'", sver
);
327 void fill_header(char *buf
, int len
)
329 struct fw_header
*hdr
= (struct fw_header
*)buf
;
332 memset(hdr
, '\xff', sizeof(struct fw_header
));
334 hdr
->version
= htonl(bswap_32(hdr_ver
));
335 ver_len
= strlen(version
);
336 if (ver_len
> (sizeof(hdr
->fw_version
) - 1))
337 ver_len
= sizeof(hdr
->fw_version
) - 1;
339 memcpy(hdr
->fw_version
, version
, ver_len
);
340 hdr
->fw_version
[ver_len
] = 0;
342 hdr
->hw_id
= htonl(board
->hw_id
);
343 hdr
->hw_rev
= htonl(board
->hw_rev
);
344 hdr
->hw_ver_add
= htonl(board
->hw_ver_add
);
346 if (boot_info
.file_size
== 0) {
347 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(hdr
->md5sum1
));
348 hdr
->boot_ofs
= htonl(0);
349 hdr
->boot_len
= htonl(0);
351 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(hdr
->md5sum1
));
352 hdr
->boot_ofs
= htonl(rootfs_ofs
+ rootfs_info
.file_size
);
353 hdr
->boot_len
= htonl(rootfs_info
.file_size
);
356 hdr
->kernel_la
= htonl(kernel_la
);
357 hdr
->kernel_ep
= htonl(kernel_ep
);
358 hdr
->fw_length
= htonl(layout
->fw_max_len
);
359 hdr
->kernel_ofs
= htonl(sizeof(struct fw_header
));
360 hdr
->kernel_len
= htonl(kernel_len
);
362 hdr
->rootfs_ofs
= htonl(rootfs_ofs
);
363 hdr
->rootfs_len
= htonl(rootfs_info
.file_size
);
366 hdr
->boot_ofs
= htonl(0);
367 hdr
->boot_len
= htonl(boot_info
.file_size
);
369 hdr
->unk2
= htonl(0);
370 hdr
->unk3
= htonl(0xffffffff);
371 hdr
->unk4
= htons(0x55aa);
374 hdr
->sver_hi
= sver_hi
;
375 hdr
->sver_lo
= sver_lo
;
377 hdr
->ver_hi
= fw_ver_hi
;
378 hdr
->ver_mid
= fw_ver_mid
;
379 hdr
->ver_lo
= fw_ver_lo
;
381 if (board
->flags
& FLAG_LE_KERNEL_LA_EP
) {
382 hdr
->kernel_la
= bswap_32(hdr
->kernel_la
);
383 hdr
->kernel_ep
= bswap_32(hdr
->kernel_ep
);
386 get_md5(buf
, len
, hdr
->md5sum1
);
389 static int inspect_fw(void)
392 struct fw_header
*hdr
;
393 uint8_t md5sum
[MD5SUM_LEN
];
394 struct board_info
*board
;
395 int ret
= EXIT_FAILURE
;
397 buf
= malloc(inspect_info
.file_size
);
399 ERR("no memory for buffer!\n");
403 ret
= read_to_buf(&inspect_info
, buf
);
406 hdr
= (struct fw_header
*)buf
;
408 board
= &custom_board
;
410 if (board
->flags
& FLAG_LE_KERNEL_LA_EP
) {
411 hdr
->kernel_la
= bswap_32(hdr
->kernel_la
);
412 hdr
->kernel_ep
= bswap_32(hdr
->kernel_ep
);
415 inspect_fw_pstr("File name", inspect_info
.file_name
);
416 inspect_fw_phexdec("File size", inspect_info
.file_size
);
418 switch(bswap_32(ntohl(hdr
->version
))) {
423 ERR("file does not seem to have V2/V3 header!\n");
427 inspect_fw_phexdec("Version 2 Header size", sizeof(struct fw_header
));
429 memcpy(md5sum
, hdr
->md5sum1
, sizeof(md5sum
));
430 if (ntohl(hdr
->boot_len
) == 0)
431 memcpy(hdr
->md5sum1
, md5salt_normal
, sizeof(md5sum
));
433 memcpy(hdr
->md5sum1
, md5salt_boot
, sizeof(md5sum
));
434 get_md5(buf
, inspect_info
.file_size
, hdr
->md5sum1
);
436 if (memcmp(md5sum
, hdr
->md5sum1
, sizeof(md5sum
))) {
437 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(*ERROR*)");
438 inspect_fw_pmd5sum(" --> expected", hdr
->md5sum1
, "");
440 inspect_fw_pmd5sum("Header MD5Sum1", md5sum
, "(ok)");
442 if (ntohl(hdr
->unk2
) != 0)
443 inspect_fw_phexdec("Unknown value 2", hdr
->unk2
);
444 inspect_fw_pmd5sum("Header MD5Sum2", hdr
->md5sum2
,
445 "(purpose yet unknown, unchecked here)");
447 if (ntohl(hdr
->unk3
) != 0xffffffff)
448 inspect_fw_phexdec("Unknown value 3", hdr
->unk3
);
450 if (ntohs(hdr
->unk4
) != 0x55aa)
451 inspect_fw_phexdec("Unknown value 4", hdr
->unk4
);
453 if (hdr
->unk5
!= 0xa5)
454 inspect_fw_phexdec("Unknown value 5", hdr
->unk5
);
458 inspect_fw_pstr("Firmware version", hdr
->fw_version
);
459 inspect_fw_phex("Hardware ID", ntohl(hdr
->hw_id
));
460 inspect_fw_phex("Hardware Revision",
462 inspect_fw_phex("Additional HW Version",
463 ntohl(hdr
->hw_ver_add
));
465 printf("%-23s: %d.%d.%d-%d.%d\n", "Software version",
466 hdr
->ver_hi
, hdr
->ver_mid
, hdr
->ver_lo
,
467 hdr
->sver_hi
, hdr
->sver_lo
);
471 inspect_fw_phexdec("Kernel data offset",
472 ntohl(hdr
->kernel_ofs
));
473 inspect_fw_phexdec("Kernel data length",
474 ntohl(hdr
->kernel_len
));
475 inspect_fw_phex("Kernel load address",
476 ntohl(hdr
->kernel_la
));
477 inspect_fw_phex("Kernel entry point",
478 ntohl(hdr
->kernel_ep
));
479 inspect_fw_phexdec("Rootfs data offset",
480 ntohl(hdr
->rootfs_ofs
));
481 inspect_fw_phexdec("Rootfs data length",
482 ntohl(hdr
->rootfs_len
));
483 inspect_fw_phexdec("Boot loader data offset",
484 ntohl(hdr
->boot_ofs
));
485 inspect_fw_phexdec("Boot loader data length",
486 ntohl(hdr
->boot_len
));
487 inspect_fw_phexdec("Total firmware length",
488 ntohl(hdr
->fw_length
));
496 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
497 sprintf(filename
, "%s-kernel", inspect_info
.file_name
);
498 printf("Extracting kernel to \"%s\"...\n", filename
);
499 fp
= fopen(filename
, "w");
501 if (!fwrite(buf
+ ntohl(hdr
->kernel_ofs
),
502 ntohl(hdr
->kernel_len
), 1, fp
)) {
503 ERR("error in fwrite(): %s", strerror(errno
));
507 ERR("error in fopen(): %s", strerror(errno
));
511 filename
= malloc(strlen(inspect_info
.file_name
) + 8);
512 sprintf(filename
, "%s-rootfs", inspect_info
.file_name
);
513 printf("Extracting rootfs to \"%s\"...\n", filename
);
514 fp
= fopen(filename
, "w");
516 if (!fwrite(buf
+ ntohl(hdr
->rootfs_ofs
),
517 ntohl(hdr
->rootfs_len
), 1, fp
)) {
518 ERR("error in fwrite(): %s", strerror(errno
));
522 ERR("error in fopen(): %s", strerror(errno
));
533 int main(int argc
, char *argv
[])
535 int ret
= EXIT_FAILURE
;
537 progname
= basename(argv
[0]);
542 c
= getopt(argc
, argv
, "a:H:E:F:L:V:N:W:w:ci:k:r:R:o:xhsjv:y:T:e");
548 sscanf(optarg
, "0x%x", &rootfs_align
);
554 sscanf(optarg
, "0x%x", &kernel_ep
);
563 opt_hw_ver_add
= optarg
;
566 sscanf(optarg
, "0x%x", &kernel_la
);
584 kernel_info
.file_name
= optarg
;
587 rootfs_info
.file_name
= optarg
;
590 sscanf(optarg
, "0x%x", &rootfs_ofs
);
599 inspect_info
.file_name
= optarg
;
608 hdr_ver
= atoi(optarg
);
611 custom_board
.flags
= FLAG_LE_KERNEL_LA_EP
;
622 ret
= check_options();
626 if (!inspect_info
.file_name
)
627 ret
= build_fw(sizeof(struct fw_header
));