projects / openwrt / openwrt.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
firmware-utils: mktplinkfw2: update firmware header
[openwrt/openwrt.git] / tools / firmware-utils / src / mktplinkfw2.c
1 /*
2 * Copyright (C) 2009 Gabor Juhos <juhosg@openwrt.org>
3 *
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>
7 *
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.
11 *
12 */
13
14 #include <stdio.h>
15 #include <stdlib.h>
16 #include <stdint.h>
17 #include <string.h>
18 #include <unistd.h> /* for unlink() */
19 #include <libgen.h>
20 #include <getopt.h> /* for getopt() */
21 #include <stdarg.h>
22 #include <errno.h>
23 #include <stdbool.h>
24 #include <endian.h>
25 #include <sys/stat.h>
26
27 #include <arpa/inet.h>
28 #include <netinet/in.h>
29
30 #include "md5.h"
31
32 #define ALIGN(x,a) ({ typeof(a) __a = (a); (((x) + __a - 1) & ~(__a - 1)); })
33
34 #define MD5SUM_LEN 16
35
36 struct file_info {
37 char *file_name; /* name of the file */
38 uint32_t file_size; /* length of the file */
39 };
40
41 struct fw_header {
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 */
51
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 */
68 uint8_t pad[364];
69 } __attribute__ ((packed));
70
71 struct flash_layout {
72 char *id;
73 uint32_t fw_max_len;
74 uint32_t kernel_la;
75 uint32_t kernel_ep;
76 uint32_t rootfs_ofs;
77 };
78
79 struct board_info {
80 char *id;
81 uint32_t hw_id;
82 uint32_t hw_rev;
83 uint32_t hw_ver_add;
84 char *layout_id;
85 uint32_t hdr_ver;
86 bool endian_swap;
87 };
88
89 /*
90 * Globals
91 */
92 static char *ofname;
93 static char *progname;
94 static char *vendor = "TP-LINK Technologies";
95 static char *version = "ver. 1.0";
96 static char *fw_ver = "0.0.0";
97 static char *sver = "1.0";
98 static uint32_t hdr_ver = 2;
99
100 static char *board_id;
101 static struct board_info *board;
102 static char *layout_id;
103 static struct flash_layout *layout;
104 static char *opt_hw_id;
105 static uint32_t hw_id;
106 static char *opt_hw_rev;
107 static uint32_t hw_rev;
108 static char *opt_hw_ver_add;
109 static uint32_t hw_ver_add;
110 static int fw_ver_lo;
111 static int fw_ver_mid;
112 static int fw_ver_hi;
113 static int sver_lo;
114 static int sver_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;
123 static int combined;
124 static int strip_padding;
125 static int add_jffs2_eof;
126 static unsigned char jffs2_eof_mark[4] = {0xde, 0xad, 0xc0, 0xde};
127
128 static struct file_info inspect_info;
129 static int extract = 0;
130 static bool endian_swap = false;
131
132 char md5salt_normal[MD5SUM_LEN] = {
133 0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
134 0xdc, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x37,
135 };
136
137 char md5salt_boot[MD5SUM_LEN] = {
138 0x8c, 0xef, 0x33, 0x5f, 0xd5, 0xc5, 0xce, 0xfa,
139 0xac, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
140 };
141
142 static struct flash_layout layouts[] = {
143 {
144 .id = "8Mltq",
145 .fw_max_len = 0x7a0000,
146 .kernel_la = 0x80002000,
147 .kernel_ep = 0x80002000,
148 .rootfs_ofs = 0x140000,
149 }, {
150 .id = "16Mltq",
151 .fw_max_len = 0xf90000,
152 .kernel_la = 0x80002000,
153 .kernel_ep = 0x800061b0,
154 .rootfs_ofs = 0x140000,
155 }, {
156 .id = "8Mmtk",
157 .fw_max_len = 0x7a0000,
158 .kernel_la = 0x80000000,
159 .kernel_ep = 0x80000000,
160 .rootfs_ofs = 0x140000,
161 }, {
162 .id = "8MLmtk",
163 .fw_max_len = 0x7b0000,
164 .kernel_la = 0x80000000,
165 .kernel_ep = 0x80000000,
166 .rootfs_ofs = 0x140000,
167 }, {
168 /* terminating entry */
169 }
170 };
171
172 static struct board_info boards[] = {
173 {
174 .id = "TD-W8970v1",
175 .hw_id = 0x89700001,
176 .hw_rev = 1,
177 .layout_id = "8Mltq",
178 }, {
179 .id = "TD-W8980v1",
180 .hw_id = 0x89800001,
181 .hw_rev = 14,
182 .layout_id = "8Mltq",
183 }, {
184 .id = "ArcherC20i",
185 .hw_id = 0xc2000001,
186 .hw_rev = 58,
187 .layout_id = "8Mmtk",
188 .hdr_ver = 3,
189 .endian_swap = true,
190 }, {
191 .id = "ArcherVR200V",
192 .hw_id = 0x73b70801,
193 .hw_rev = 0x2f,
194 .layout_id = "16Mltq",
195 .hdr_ver = 2,
196 }, {
197 .id = "ArcherC50",
198 .hw_id = 0xc7500001,
199 .hw_rev = 69,
200 .layout_id = "8Mmtk",
201 .hdr_ver = 3,
202 .endian_swap = true,
203 }, {
204 .id = "ArcherMR200",
205 .hw_id = 0xd7500001,
206 .hw_rev = 0x4a,
207 .layout_id = "8MLmtk",
208 .hdr_ver = 3,
209 .endian_swap = true,
210 }, {
211 .id = "TL-WR840NV4",
212 .hw_id = 0x08400004,
213 .hw_rev = 0x1,
214 .hw_ver_add = 0x4,
215 .layout_id = "8Mmtk",
216 .hdr_ver = 3,
217 .endian_swap = true,
218 }, {
219 .id = "TL-WR841NV13",
220 .hw_id = 0x08410013,
221 .hw_rev = 0x268,
222 .hw_ver_add = 0x13,
223 .layout_id = "8Mmtk",
224 .hdr_ver = 3,
225 .endian_swap = true,
226 }, {
227 /* terminating entry */
228 }
229 };
230
231 /*
232 * Message macros
233 */
234 #define ERR(fmt, ...) do { \
235 fflush(0); \
236 fprintf(stderr, "[%s] *** error: " fmt "\n", \
237 progname, ## __VA_ARGS__ ); \
238 } while (0)
239
240 #define ERRS(fmt, ...) do { \
241 int save = errno; \
242 fflush(0); \
243 fprintf(stderr, "[%s] *** error: " fmt ": %s\n", \
244 progname, ## __VA_ARGS__, strerror(save)); \
245 } while (0)
246
247 #define DBG(fmt, ...) do { \
248 fprintf(stderr, "[%s] " fmt "\n", progname, ## __VA_ARGS__ ); \
249 } while (0)
250
251 static struct board_info *find_board(char *id)
252 {
253 struct board_info *ret;
254 struct board_info *board;
255
256 ret = NULL;
257 for (board = boards; board->id != NULL; board++){
258 if (strcasecmp(id, board->id) == 0) {
259 ret = board;
260 break;
261 }
262 };
263
264 return ret;
265 }
266
267 static struct board_info *find_board_by_hwid(uint32_t hw_id)
268 {
269 struct board_info *board;
270
271 for (board = boards; board->id != NULL; board++) {
272 if (hw_id == board->hw_id)
273 return board;
274 };
275
276 return NULL;
277 }
278
279 static struct flash_layout *find_layout(char *id)
280 {
281 struct flash_layout *ret;
282 struct flash_layout *l;
283
284 ret = NULL;
285 for (l = layouts; l->id != NULL; l++){
286 if (strcasecmp(id, l->id) == 0) {
287 ret = l;
288 break;
289 }
290 };
291
292 return ret;
293 }
294
295 static void usage(int status)
296 {
297 FILE *stream = (status != EXIT_SUCCESS) ? stderr : stdout;
298 struct board_info *board;
299
300 fprintf(stream, "Usage: %s [OPTIONS...]\n", progname);
301 fprintf(stream,
302 "\n"
303 "Options:\n"
304 " -B <board> create image for the board specified with <board>\n"
305 " -c use combined kernel image\n"
306 " -e swap endianness in kernel load address and entry point\n"
307 " -E <ep> overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
308 " -L <la> overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
309 " -H <hwid> use hardware id specified with <hwid>\n"
310 " -W <hwrev> use hardware revision specified with <hwrev>\n"
311 " -w <hwveradd> use additional hardware version specified with <hwveradd>\n"
312 " -F <id> use flash layout specified with <id>\n"
313 " -k <file> read kernel image from the file <file>\n"
314 " -r <file> read rootfs image from the file <file>\n"
315 " -a <align> align the rootfs start on an <align> bytes boundary\n"
316 " -R <offset> overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
317 " -o <file> write output to the file <file>\n"
318 " -s strip padding from the end of the image\n"
319 " -j add jffs2 end-of-filesystem markers\n"
320 " -N <vendor> set image vendor to <vendor>\n"
321 " -T <version> set header version to <version>\n"
322 " -V <version> set image version to <version>\n"
323 " -v <version> set firmware version to <version>\n"
324 " -y <version> set secondary version to <version>\n"
325 " -i <file> inspect given firmware file <file>\n"
326 " -x extract kernel and rootfs while inspecting (requires -i)\n"
327 " -h show this screen\n"
328 );
329
330 exit(status);
331 }
332
333 static int get_md5(char *data, int size, char *md5)
334 {
335 MD5_CTX ctx;
336
337 MD5_Init(&ctx);
338 MD5_Update(&ctx, data, size);
339 MD5_Final(md5, &ctx);
340 }
341
342 static int get_file_stat(struct file_info *fdata)
343 {
344 struct stat st;
345 int res;
346
347 if (fdata->file_name == NULL)
348 return 0;
349
350 res = stat(fdata->file_name, &st);
351 if (res){
352 ERRS("stat failed on %s", fdata->file_name);
353 return res;
354 }
355
356 fdata->file_size = st.st_size;
357 return 0;
358 }
359
360 static int read_to_buf(struct file_info *fdata, char *buf)
361 {
362 FILE *f;
363 int ret = EXIT_FAILURE;
364
365 f = fopen(fdata->file_name, "r");
366 if (f == NULL) {
367 ERRS("could not open \"%s\" for reading", fdata->file_name);
368 goto out;
369 }
370
371 errno = 0;
372 fread(buf, fdata->file_size, 1, f);
373 if (errno != 0) {
374 ERRS("unable to read from file \"%s\"", fdata->file_name);
375 goto out_close;
376 }
377
378 ret = EXIT_SUCCESS;
379
380 out_close:
381 fclose(f);
382 out:
383 return ret;
384 }
385
386 static int check_options(void)
387 {
388 int ret;
389
390 if (inspect_info.file_name) {
391 ret = get_file_stat(&inspect_info);
392 if (ret)
393 return ret;
394
395 return 0;
396 } else if (extract) {
397 ERR("no firmware for inspection specified");
398 return -1;
399 }
400
401 if (board_id == NULL && opt_hw_id == NULL) {
402 ERR("either board or hardware id must be specified");
403 return -1;
404 }
405
406 if (board_id) {
407 board = find_board(board_id);
408 if (board == NULL) {
409 ERR("unknown/unsupported board id \"%s\"", board_id);
410 return -1;
411 }
412 if (layout_id == NULL)
413 layout_id = board->layout_id;
414
415 hw_id = board->hw_id;
416 hw_rev = board->hw_rev;
417 hw_ver_add = board->hw_ver_add;
418 if (board->hdr_ver)
419 hdr_ver = board->hdr_ver;
420 endian_swap = board->endian_swap;
421 } else {
422 if (layout_id == NULL) {
423 ERR("flash layout is not specified");
424 return -1;
425 }
426 hw_id = strtoul(opt_hw_id, NULL, 0);
427
428 if (opt_hw_rev)
429 hw_rev = strtoul(opt_hw_rev, NULL, 0);
430 else
431 hw_rev = 1;
432
433 if (opt_hw_ver_add)
434 hw_ver_add = strtoul(opt_hw_ver_add, NULL, 0);
435 else
436 hw_ver_add = 0;
437 }
438
439 layout = find_layout(layout_id);
440 if (layout == NULL) {
441 ERR("unknown flash layout \"%s\"", layout_id);
442 return -1;
443 }
444
445 if (!kernel_la)
446 kernel_la = layout->kernel_la;
447 if (!kernel_ep)
448 kernel_ep = layout->kernel_ep;
449 if (!rootfs_ofs)
450 rootfs_ofs = layout->rootfs_ofs;
451
452 if (kernel_info.file_name == NULL) {
453 ERR("no kernel image specified");
454 return -1;
455 }
456
457 ret = get_file_stat(&kernel_info);
458 if (ret)
459 return ret;
460
461 kernel_len = kernel_info.file_size;
462
463 if (combined) {
464 if (kernel_info.file_size >
465 layout->fw_max_len - sizeof(struct fw_header)) {
466 ERR("kernel image is too big");
467 return -1;
468 }
469 } else {
470 if (rootfs_info.file_name == NULL) {
471 ERR("no rootfs image specified");
472 return -1;
473 }
474
475 ret = get_file_stat(&rootfs_info);
476 if (ret)
477 return ret;
478
479 if (rootfs_align) {
480 kernel_len += sizeof(struct fw_header);
481 kernel_len = ALIGN(kernel_len, rootfs_align);
482 kernel_len -= sizeof(struct fw_header);
483
484 DBG("kernel length aligned to %u", kernel_len);
485
486 if (kernel_len + rootfs_info.file_size >
487 layout->fw_max_len - sizeof(struct fw_header)) {
488 ERR("images are too big");
489 return -1;
490 }
491 } else {
492 if (kernel_info.file_size >
493 rootfs_ofs - sizeof(struct fw_header)) {
494 ERR("kernel image is too big");
495 return -1;
496 }
497
498 if (rootfs_info.file_size >
499 (layout->fw_max_len - rootfs_ofs)) {
500 ERR("rootfs image is too big");
501 return -1;
502 }
503 }
504 }
505
506 if (ofname == NULL) {
507 ERR("no output file specified");
508 return -1;
509 }
510
511 ret = sscanf(fw_ver, "%d.%d.%d", &fw_ver_hi, &fw_ver_mid, &fw_ver_lo);
512 if (ret != 3) {
513 ERR("invalid firmware version '%s'", fw_ver);
514 return -1;
515 }
516
517 ret = sscanf(sver, "%d.%d", &sver_hi, &sver_lo);
518 if (ret != 2) {
519 ERR("invalid secondary version '%s'", sver);
520 return -1;
521 }
522
523 return 0;
524 }
525
526 static void fill_header(char *buf, int len)
527 {
528 struct fw_header *hdr = (struct fw_header *)buf;
529 unsigned ver_len;
530
531 memset(hdr, '\xff', sizeof(struct fw_header));
532
533 hdr->version = htonl(bswap_32(hdr_ver));
534 ver_len = strlen(version);
535 if (ver_len > (sizeof(hdr->fw_version) - 1))
536 ver_len = sizeof(hdr->fw_version) - 1;
537
538 memcpy(hdr->fw_version, version, ver_len);
539 hdr->fw_version[ver_len] = 0;
540
541 hdr->hw_id = htonl(hw_id);
542 hdr->hw_rev = htonl(hw_rev);
543 hdr->hw_ver_add = htonl(hw_ver_add);
544
545 if (boot_info.file_size == 0) {
546 memcpy(hdr->md5sum1, md5salt_normal, sizeof(hdr->md5sum1));
547 hdr->boot_ofs = htonl(0);
548 hdr->boot_len = htonl(0);
549 } else {
550 memcpy(hdr->md5sum1, md5salt_boot, sizeof(hdr->md5sum1));
551 hdr->boot_ofs = htonl(rootfs_ofs + rootfs_info.file_size);
552 hdr->boot_len = htonl(rootfs_info.file_size);
553 }
554
555 hdr->kernel_la = htonl(kernel_la);
556 hdr->kernel_ep = htonl(kernel_ep);
557 hdr->fw_length = htonl(layout->fw_max_len);
558 hdr->kernel_ofs = htonl(sizeof(struct fw_header));
559 hdr->kernel_len = htonl(kernel_len);
560 if (!combined) {
561 hdr->rootfs_ofs = htonl(rootfs_ofs);
562 hdr->rootfs_len = htonl(rootfs_info.file_size);
563 }
564
565 hdr->boot_ofs = htonl(0);
566 hdr->boot_len = htonl(boot_info.file_size);
567
568 hdr->unk2 = htonl(0);
569 hdr->unk3 = htonl(0xffffffff);
570 hdr->unk4 = htons(0x55aa);
571 hdr->unk5 = 0xa5;
572
573 hdr->sver_hi = sver_hi;
574 hdr->sver_lo = sver_lo;
575
576 hdr->ver_hi = fw_ver_hi;
577 hdr->ver_mid = fw_ver_mid;
578 hdr->ver_lo = fw_ver_lo;
579
580 if (endian_swap) {
581 hdr->kernel_la = bswap_32(hdr->kernel_la);
582 hdr->kernel_ep = bswap_32(hdr->kernel_ep);
583 }
584
585 get_md5(buf, len, hdr->md5sum1);
586 }
587
588 static int pad_jffs2(char *buf, int currlen)
589 {
590 int len;
591 uint32_t pad_mask;
592
593 len = currlen;
594 pad_mask = (64 * 1024);
595 while ((len < layout->fw_max_len) && (pad_mask != 0)) {
596 uint32_t mask;
597 int i;
598
599 for (i = 10; i < 32; i++) {
600 mask = 1 << i;
601 if (pad_mask & mask)
602 break;
603 }
604
605 len = ALIGN(len, mask);
606
607 for (i = 10; i < 32; i++) {
608 mask = 1 << i;
609 if ((len & (mask - 1)) == 0)
610 pad_mask &= ~mask;
611 }
612
613 for (i = 0; i < sizeof(jffs2_eof_mark); i++)
614 buf[len + i] = jffs2_eof_mark[i];
615
616 len += sizeof(jffs2_eof_mark);
617 }
618
619 return len;
620 }
621
622 static int write_fw(char *data, int len)
623 {
624 FILE *f;
625 int ret = EXIT_FAILURE;
626
627 f = fopen(ofname, "w");
628 if (f == NULL) {
629 ERRS("could not open \"%s\" for writing", ofname);
630 goto out;
631 }
632
633 errno = 0;
634 fwrite(data, len, 1, f);
635 if (errno) {
636 ERRS("unable to write output file");
637 goto out_flush;
638 }
639
640 DBG("firmware file \"%s\" completed", ofname);
641
642 ret = EXIT_SUCCESS;
643
644 out_flush:
645 fflush(f);
646 fclose(f);
647 if (ret != EXIT_SUCCESS) {
648 unlink(ofname);
649 }
650 out:
651 return ret;
652 }
653
654 static int build_fw(void)
655 {
656 int buflen;
657 char *buf;
658 char *p;
659 int ret = EXIT_FAILURE;
660 int writelen = 0;
661
662 buflen = layout->fw_max_len;
663
664 buf = malloc(buflen);
665 if (!buf) {
666 ERR("no memory for buffer\n");
667 goto out;
668 }
669
670 memset(buf, 0xff, buflen);
671 p = buf + sizeof(struct fw_header);
672 ret = read_to_buf(&kernel_info, p);
673 if (ret)
674 goto out_free_buf;
675
676 writelen = sizeof(struct fw_header) + kernel_len;
677
678 if (!combined) {
679 if (rootfs_align)
680 p = buf + writelen;
681 else
682 p = buf + rootfs_ofs;
683
684 ret = read_to_buf(&rootfs_info, p);
685 if (ret)
686 goto out_free_buf;
687
688 if (rootfs_align)
689 writelen += rootfs_info.file_size;
690 else
691 writelen = rootfs_ofs + rootfs_info.file_size;
692
693 if (add_jffs2_eof)
694 writelen = pad_jffs2(buf, writelen);
695 }
696
697 if (!strip_padding)
698 writelen = buflen;
699
700 fill_header(buf, writelen);
701 ret = write_fw(buf, writelen);
702 if (ret)
703 goto out_free_buf;
704
705 ret = EXIT_SUCCESS;
706
707 out_free_buf:
708 free(buf);
709 out:
710 return ret;
711 }
712
713 /* Helper functions to inspect_fw() representing different output formats */
714 static inline void inspect_fw_pstr(char *label, char *str)
715 {
716 printf("%-23s: %s\n", label, str);
717 }
718
719 static inline void inspect_fw_phex(char *label, uint32_t val)
720 {
721 printf("%-23s: 0x%08x\n", label, val);
722 }
723
724 static inline void inspect_fw_phexpost(char *label,
725 uint32_t val, char *post)
726 {
727 printf("%-23s: 0x%08x (%s)\n", label, val, post);
728 }
729
730 static inline void inspect_fw_phexdef(char *label,
731 uint32_t val, uint32_t defval)
732 {
733 printf("%-23s: 0x%08x ", label, val);
734
735 if (val == defval)
736 printf("(== OpenWrt default)\n");
737 else
738 printf("(OpenWrt default: 0x%08x)\n", defval);
739 }
740
741 static inline void inspect_fw_phexexp(char *label,
742 uint32_t val, uint32_t expval)
743 {
744 printf("%-23s: 0x%08x ", label, val);
745
746 if (val == expval)
747 printf("(ok)\n");
748 else
749 printf("(expected: 0x%08x)\n", expval);
750 }
751
752 static inline void inspect_fw_phexdec(char *label, uint32_t val)
753 {
754 printf("%-23s: 0x%08x / %8u bytes\n", label, val, val);
755 }
756
757 static inline void inspect_fw_phexdecdef(char *label,
758 uint32_t val, uint32_t defval)
759 {
760 printf("%-23s: 0x%08x / %8u bytes ", label, val, val);
761
762 if (val == defval)
763 printf("(== OpenWrt default)\n");
764 else
765 printf("(OpenWrt default: 0x%08x)\n", defval);
766 }
767
768 static inline void inspect_fw_pmd5sum(char *label, uint8_t *val, char *text)
769 {
770 int i;
771
772 printf("%-23s:", label);
773 for (i=0; i<MD5SUM_LEN; i++)
774 printf(" %02x", val[i]);
775 printf(" %s\n", text);
776 }
777
778 static int inspect_fw(void)
779 {
780 char *buf;
781 struct fw_header *hdr;
782 uint8_t md5sum[MD5SUM_LEN];
783 struct board_info *board;
784 int ret = EXIT_FAILURE;
785
786 buf = malloc(inspect_info.file_size);
787 if (!buf) {
788 ERR("no memory for buffer!\n");
789 goto out;
790 }
791
792 ret = read_to_buf(&inspect_info, buf);
793 if (ret)
794 goto out_free_buf;
795 hdr = (struct fw_header *)buf;
796
797 inspect_fw_pstr("File name", inspect_info.file_name);
798 inspect_fw_phexdec("File size", inspect_info.file_size);
799
800 switch(bswap_32(ntohl(hdr->version))) {
801 case 2:
802 case 3:
803 break;
804 default:
805 ERR("file does not seem to have V2/V3 header!\n");
806 goto out_free_buf;
807 }
808
809 inspect_fw_phexdec("Version 2 Header size", sizeof(struct fw_header));
810
811 memcpy(md5sum, hdr->md5sum1, sizeof(md5sum));
812 if (ntohl(hdr->boot_len) == 0)
813 memcpy(hdr->md5sum1, md5salt_normal, sizeof(md5sum));
814 else
815 memcpy(hdr->md5sum1, md5salt_boot, sizeof(md5sum));
816 get_md5(buf, inspect_info.file_size, hdr->md5sum1);
817
818 if (memcmp(md5sum, hdr->md5sum1, sizeof(md5sum))) {
819 inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(*ERROR*)");
820 inspect_fw_pmd5sum(" --> expected", hdr->md5sum1, "");
821 } else {
822 inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(ok)");
823 }
824 if (ntohl(hdr->unk2) != 0)
825 inspect_fw_phexdec("Unknown value 2", hdr->unk2);
826 inspect_fw_pmd5sum("Header MD5Sum2", hdr->md5sum2,
827 "(purpose yet unknown, unchecked here)");
828
829 if (ntohl(hdr->unk3) != 0xffffffff)
830 inspect_fw_phexdec("Unknown value 3", hdr->unk3);
831
832 if (ntohs(hdr->unk4) != 0x55aa)
833 inspect_fw_phexdec("Unknown value 4", hdr->unk4);
834
835 if (hdr->unk5 != 0xa5)
836 inspect_fw_phexdec("Unknown value 5", hdr->unk5);
837
838 printf("\n");
839
840 inspect_fw_pstr("Firmware version", hdr->fw_version);
841
842 board = find_board_by_hwid(ntohl(hdr->hw_id));
843 if (board) {
844 layout = find_layout(board->layout_id);
845 inspect_fw_phexpost("Hardware ID",
846 ntohl(hdr->hw_id), board->id);
847 inspect_fw_phexexp("Hardware Revision",
848 ntohl(hdr->hw_rev), board->hw_rev);
849 inspect_fw_phexexp("Additional HW Version",
850 ntohl(hdr->hw_ver_add), board->hw_ver_add);
851 } else {
852 inspect_fw_phexpost("Hardware ID",
853 ntohl(hdr->hw_id), "unknown");
854 inspect_fw_phex("Hardware Revision",
855 ntohl(hdr->hw_rev));
856 inspect_fw_phex("Additional HW Version",
857 ntohl(hdr->hw_ver_add));
858 }
859
860 printf("%-23s: %d.%d.%d-%d.%d\n", "Software version",
861 hdr->ver_hi, hdr->ver_mid, hdr->ver_lo,
862 hdr->sver_hi, hdr->sver_lo);
863
864 printf("\n");
865
866 inspect_fw_phexdec("Kernel data offset",
867 ntohl(hdr->kernel_ofs));
868 inspect_fw_phexdec("Kernel data length",
869 ntohl(hdr->kernel_len));
870 if (board) {
871 inspect_fw_phexdef("Kernel load address",
872 ntohl(hdr->kernel_la),
873 layout ? layout->kernel_la : 0xffffffff);
874 inspect_fw_phexdef("Kernel entry point",
875 ntohl(hdr->kernel_ep),
876 layout ? layout->kernel_ep : 0xffffffff);
877 inspect_fw_phexdecdef("Rootfs data offset",
878 ntohl(hdr->rootfs_ofs),
879 layout ? layout->rootfs_ofs : 0xffffffff);
880 } else {
881 inspect_fw_phex("Kernel load address",
882 ntohl(hdr->kernel_la));
883 inspect_fw_phex("Kernel entry point",
884 ntohl(hdr->kernel_ep));
885 inspect_fw_phexdec("Rootfs data offset",
886 ntohl(hdr->rootfs_ofs));
887 }
888 inspect_fw_phexdec("Rootfs data length",
889 ntohl(hdr->rootfs_len));
890 inspect_fw_phexdec("Boot loader data offset",
891 ntohl(hdr->boot_ofs));
892 inspect_fw_phexdec("Boot loader data length",
893 ntohl(hdr->boot_len));
894 inspect_fw_phexdec("Total firmware length",
895 ntohl(hdr->fw_length));
896
897 if (extract) {
898 FILE *fp;
899 char *filename;
900
901 printf("\n");
902
903 filename = malloc(strlen(inspect_info.file_name) + 8);
904 sprintf(filename, "%s-kernel", inspect_info.file_name);
905 printf("Extracting kernel to \"%s\"...\n", filename);
906 fp = fopen(filename, "w");
907 if (fp) {
908 if (!fwrite(buf + ntohl(hdr->kernel_ofs),
909 ntohl(hdr->kernel_len), 1, fp)) {
910 ERR("error in fwrite(): %s", strerror(errno));
911 }
912 fclose(fp);
913 } else {
914 ERR("error in fopen(): %s", strerror(errno));
915 }
916 free(filename);
917
918 filename = malloc(strlen(inspect_info.file_name) + 8);
919 sprintf(filename, "%s-rootfs", inspect_info.file_name);
920 printf("Extracting rootfs to \"%s\"...\n", filename);
921 fp = fopen(filename, "w");
922 if (fp) {
923 if (!fwrite(buf + ntohl(hdr->rootfs_ofs),
924 ntohl(hdr->rootfs_len), 1, fp)) {
925 ERR("error in fwrite(): %s", strerror(errno));
926 }
927 fclose(fp);
928 } else {
929 ERR("error in fopen(): %s", strerror(errno));
930 }
931 free(filename);
932 }
933
934 out_free_buf:
935 free(buf);
936 out:
937 return ret;
938 }
939
940 int main(int argc, char *argv[])
941 {
942 int ret = EXIT_FAILURE;
943 int err;
944
945 FILE *outfile;
946
947 progname = basename(argv[0]);
948
949 while ( 1 ) {
950 int c;
951
952 c = getopt(argc, argv, "a:B:H:E:F:L:V:N:W:w:ci:k:r:R:o:xhsjv:y:T:e");
953 if (c == -1)
954 break;
955
956 switch (c) {
957 case 'a':
958 sscanf(optarg, "0x%x", &rootfs_align);
959 break;
960 case 'B':
961 board_id = optarg;
962 break;
963 case 'H':
964 opt_hw_id = optarg;
965 break;
966 case 'E':
967 sscanf(optarg, "0x%x", &kernel_ep);
968 break;
969 case 'F':
970 layout_id = optarg;
971 break;
972 case 'W':
973 opt_hw_rev = optarg;
974 break;
975 case 'w':
976 opt_hw_ver_add = optarg;
977 break;
978 case 'L':
979 sscanf(optarg, "0x%x", &kernel_la);
980 break;
981 case 'V':
982 version = optarg;
983 break;
984 case 'v':
985 fw_ver = optarg;
986 break;
987 case 'y':
988 sver = optarg;
989 break;
990 case 'N':
991 vendor = optarg;
992 break;
993 case 'c':
994 combined++;
995 break;
996 case 'k':
997 kernel_info.file_name = optarg;
998 break;
999 case 'r':
1000 rootfs_info.file_name = optarg;
1001 break;
1002 case 'R':
1003 sscanf(optarg, "0x%x", &rootfs_ofs);
1004 break;
1005 case 'o':
1006 ofname = optarg;
1007 break;
1008 case 's':
1009 strip_padding = 1;
1010 break;
1011 case 'i':
1012 inspect_info.file_name = optarg;
1013 break;
1014 case 'j':
1015 add_jffs2_eof = 1;
1016 break;
1017 case 'x':
1018 extract = 1;
1019 break;
1020 case 'T':
1021 hdr_ver = atoi(optarg);
1022 break;
1023 case 'e':
1024 endian_swap = true;
1025 break;
1026 case 'h':
1027 usage(EXIT_SUCCESS);
1028 break;
1029 default:
1030 usage(EXIT_FAILURE);
1031 break;
1032 }
1033 }
1034
1035 ret = check_options();
1036 if (ret)
1037 goto out;
1038
1039 if (!inspect_info.file_name)
1040 ret = build_fw();
1041 else
1042 ret = inspect_fw();
1043
1044 out:
1045 return ret;
1046 }
1047
OpenWrt Source Repository