ar71xx: create WZR-HP-G300NH network config from uci-defaults
[openwrt.git] / tools / firmware-utils / src / mktplinkfw.c
index 6da9aa5..f21c179 100644 (file)
 #endif
 
 #define HEADER_VERSION_V1      0x01000000
-#define HWID_TL_WR941ND_V2     0x09410002
+#define HWID_TL_MR3220_V1      0x32200001
+#define HWID_TL_MR3420_V1      0x34200001
+#define HWID_TL_WA901ND_V1     0x09010001
+#define HWID_TL_WA901ND_V2     0x09010002
+#define HWID_TL_WR703N_V1      0x07030101
+#define HWID_TL_WR741ND_V1     0x07410001
+#define HWID_TL_WR741ND_V4     0x07410004
+#define HWID_TL_WR740N_V1      0x07400001
+#define HWID_TL_WR740N_V3      0x07400003
+#define HWID_TL_WR743ND_V1     0x07430001
+#define HWID_TL_WR841N_V1_5    0x08410002
 #define HWID_TL_WR841ND_V3     0x08410003
+#define HWID_TL_WR841ND_V5     0x08410005
+#define HWID_TL_WR841ND_V7     0x08410007
+#define HWID_TL_WR941ND_V2     0x09410002
+#define HWID_TL_WR941ND_V4     0x09410004
+#define HWID_TL_WR1043ND_V1    0x10430001
 
 #define MD5SUM_LEN     16
 
@@ -87,8 +102,16 @@ static char *version = "ver. 1.0";
 static char *board_id;
 static struct board_info *board;
 static struct file_info kernel_info;
+static uint32_t kernel_la = 0;
+static uint32_t kernel_ep = 0;
 static struct file_info rootfs_info;
+static uint32_t rootfs_ofs = 0;
 static struct file_info boot_info;
+static int combined;
+static int strip_padding;
+
+static struct file_info inspect_info;
+static int extract = 0;
 
 char md5salt_normal[MD5SUM_LEN] = {
        0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
@@ -102,13 +125,109 @@ char md5salt_boot[MD5SUM_LEN] = {
 
 static struct board_info boards[] = {
        {
+               .id             = "TL-MR3220v1",
+               .hw_id          = HWID_TL_MR3220_V1,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-MR3420v1",
+               .hw_id          = HWID_TL_MR3420_V1,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WA901NDv1",
+               .hw_id          = HWID_TL_WA901ND_V1,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WA901NDv2",
+               .hw_id          = HWID_TL_WA901ND_V2,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WR741NDv1",
+               .hw_id          = HWID_TL_WR741ND_V1,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WR741NDv4",
+               .hw_id          = HWID_TL_WR741ND_V4,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x100000,
+       }, {
+               .id             = "TL-WR740Nv1",
+               .hw_id          = HWID_TL_WR740N_V1,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WR740Nv3",
+               .hw_id          = HWID_TL_WR740N_V3,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WR743NDv1",
+               .hw_id          = HWID_TL_WR743ND_V1,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WR841Nv1.5",
+               .hw_id          = HWID_TL_WR841N_V1_5,
+               .hw_rev         = 2,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
                .id             = "TL-WR841NDv3",
                .hw_id          = HWID_TL_WR841ND_V3,
                .hw_rev         = 3,
                .fw_max_len     = 0x3c0000,
                .kernel_la      = 0x80060000,
                .kernel_ep      = 0x80060000,
-               .rootfs_ofs     = 0x120000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WR841NDv5",
+               .hw_id          = HWID_TL_WR841ND_V5,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WR841NDv7",
+               .hw_id          = HWID_TL_WR841ND_V7,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
        }, {
                .id             = "TL-WR941NDv2",
                .hw_id          = HWID_TL_WR941ND_V2,
@@ -116,7 +235,31 @@ static struct board_info boards[] = {
                .fw_max_len     = 0x3c0000,
                .kernel_la      = 0x80060000,
                .kernel_ep      = 0x80060000,
-               .rootfs_ofs     = 0x120000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WR941NDv4",
+               .hw_id          = HWID_TL_WR941ND_V4,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WR1043NDv1",
+               .hw_id          = HWID_TL_WR1043ND_V1,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x7c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x140000,
+       }, {
+               .id             = "TL-WR703Nv1",
+               .hw_id          = HWID_TL_WR703N_V1,
+               .hw_rev         = 1,
+               .fw_max_len     = 0x3c0000,
+               .kernel_la      = 0x80060000,
+               .kernel_ep      = 0x80060000,
+               .rootfs_ofs     = 0x100000,
        }, {
                /* terminating entry */
        }
@@ -158,6 +301,19 @@ static struct board_info *find_board(char *id)
        return ret;
 }
 
+static struct board_info *find_board_by_hwid(uint32_t hw_id)
+{
+       struct board_info *board;
+
+       for (board = boards; board->id != NULL; board++) {
+               if (hw_id == board->hw_id)
+                       return board;
+       };
+
+       return NULL;
+}
+
+
 static void usage(int status)
 {
        FILE *stream = (status != EXIT_SUCCESS) ? stderr : stdout;
@@ -168,10 +324,18 @@ static void usage(int status)
 "\n"
 "Options:\n"
 "  -B <board>      create image for the board specified with <board>\n"
+"  -c              use combined kernel image\n"
+"  -E <ep>         overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
+"  -L <la>         overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
 "  -k <file>       read kernel image from the file <file>\n"
 "  -r <file>       read rootfs image from the file <file>\n"
+"  -R <offset>     overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
 "  -o <file>       write output to the file <file>\n"
-"  -v <version>    set image version to <version>\n"
+"  -s              strip padding from the end of the image\n"
+"  -N <vendor>     set image vendor to <vendor>\n"
+"  -V <version>    set image version to <version>\n"
+"  -i <file>       inspect given firmware file <file>\n"
+"  -x              extract kernel and rootfs while inspecting (requires -i)\n"
 "  -h              show this screen\n"
        );
 
@@ -235,6 +399,17 @@ static int check_options(void)
 {
        int ret;
 
+       if (inspect_info.file_name) {
+               ret = get_file_stat(&inspect_info);
+               if (ret)
+                       return ret;
+
+               return 0;
+       } else if (extract) {
+               ERR("no firmware for inspection specified");
+               return -1;
+       }
+
        if (board_id == NULL) {
                ERR("no board specified");
                return -1;
@@ -245,6 +420,12 @@ static int check_options(void)
                ERR("unknown/unsupported board id \"%s\"", board_id);
                return -1;
        }
+       if (!kernel_la)
+               kernel_la = board->kernel_la;
+       if (!kernel_ep)
+               kernel_ep = board->kernel_ep;
+       if (!rootfs_ofs)
+               rootfs_ofs = board->rootfs_ofs;
 
        if (kernel_info.file_name == NULL) {
                ERR("no kernel image specified");
@@ -255,23 +436,32 @@ static int check_options(void)
        if (ret)
                return ret;
 
-       if (kernel_info.file_size > board->rootfs_ofs - sizeof(struct fw_header)) {
-               ERR("kernel image is too big");
-               return -1;
-       }
+       if (combined) {
+               if (kernel_info.file_size >
+                   board->fw_max_len - sizeof(struct fw_header)) {
+                       ERR("kernel image is too big");
+                       return -1;
+               }
+       } else {
+               if (kernel_info.file_size >
+                   rootfs_ofs - sizeof(struct fw_header)) {
+                       ERR("kernel image is too big");
+                       return -1;
+               }
+               if (rootfs_info.file_name == NULL) {
+                       ERR("no rootfs image specified");
+                       return -1;
+               }
 
-       if (rootfs_info.file_name == NULL) {
-               ERR("no rootfs image specified");
-               return -1;
-       }
+               ret = get_file_stat(&rootfs_info);
+               if (ret)
+                       return ret;
 
-       ret = get_file_stat(&rootfs_info);
-       if (ret)
-               return ret;
-
-       if (rootfs_info.file_size > (board->fw_max_len - board->rootfs_ofs)) {
-               ERR("rootfs image is too big");
-               return -1;
+               if (rootfs_info.file_size >
+                    (board->fw_max_len - rootfs_ofs)) {
+                       ERR("rootfs image is too big");
+                       return -1;
+               }
        }
 
        if (ofname == NULL) {
@@ -299,13 +489,15 @@ static void fill_header(char *buf, int len)
        else
                memcpy(hdr->md5sum1, md5salt_boot, sizeof(hdr->md5sum1));
 
-       hdr->kernel_la = HOST_TO_BE32(board->kernel_la);
-       hdr->kernel_ep = HOST_TO_BE32(board->kernel_ep);
+       hdr->kernel_la = HOST_TO_BE32(kernel_la);
+       hdr->kernel_ep = HOST_TO_BE32(kernel_ep);
        hdr->fw_length = HOST_TO_BE32(board->fw_max_len);
        hdr->kernel_ofs = HOST_TO_BE32(sizeof(struct fw_header));
        hdr->kernel_len = HOST_TO_BE32(kernel_info.file_size);
-       hdr->rootfs_ofs = HOST_TO_BE32(board->rootfs_ofs);
-       hdr->rootfs_len = HOST_TO_BE32(rootfs_info.file_size);
+       if (!combined) {
+               hdr->rootfs_ofs = HOST_TO_BE32(rootfs_ofs);
+               hdr->rootfs_len = HOST_TO_BE32(rootfs_info.file_size);
+       }
 
        get_md5(buf, len, hdr->md5sum1);
 }
@@ -348,6 +540,7 @@ static int build_fw(void)
        char *buf;
        char *p;
        int ret = EXIT_FAILURE;
+       int writelen = 0;
 
        buflen = board->fw_max_len;
 
@@ -363,18 +556,236 @@ static int build_fw(void)
        if (ret)
                goto out_free_buf;
 
-       p = buf + board->rootfs_ofs;
-       ret = read_to_buf(&rootfs_info, p);
+       writelen = kernel_info.file_size;
+
+       if (!combined) {
+               p = buf + rootfs_ofs;
+               ret = read_to_buf(&rootfs_info, p);
+               if (ret)
+                       goto out_free_buf;
+
+               writelen = rootfs_ofs + rootfs_info.file_size;
+       }
+
+       if (!strip_padding)
+               writelen = buflen;
+
+       fill_header(buf, writelen);
+       ret = write_fw(buf, writelen);
        if (ret)
                goto out_free_buf;
 
-       fill_header(buf, buflen);
+       ret = EXIT_SUCCESS;
+
+ out_free_buf:
+       free(buf);
+ out:
+       return ret;
+}
+
+/* Helper functions to inspect_fw() representing different output formats */
+static inline void inspect_fw_pstr(char *label, char *str)
+{
+       printf("%-23s: %s\n", label, str);
+}
+
+static inline void inspect_fw_phex(char *label, uint32_t val)
+{
+       printf("%-23s: 0x%08x\n", label, val);
+}
+
+static inline void inspect_fw_phexpost(char *label,
+                                       uint32_t val, char *post)
+{
+       printf("%-23s: 0x%08x (%s)\n", label, val, post);
+}
+
+static inline void inspect_fw_phexdef(char *label,
+                                      uint32_t val, uint32_t defval)
+{
+       printf("%-23s: 0x%08x                  ", label, val);
+
+       if (val == defval)
+               printf("(== OpenWrt default)\n");
+       else
+               printf("(OpenWrt default: 0x%08x)\n", defval);
+}
+
+static inline void inspect_fw_phexexp(char *label,
+                                      uint32_t val, uint32_t expval)
+{
+       printf("%-23s: 0x%08x ", label, val);
+
+       if (val == expval)
+               printf("(ok)\n");
+       else
+               printf("(expected: 0x%08x)\n", expval);
+}
+
+static inline void inspect_fw_phexdec(char *label, uint32_t val)
+{
+       printf("%-23s: 0x%08x / %8u bytes\n", label, val, val);
+}
+
+static inline void inspect_fw_phexdecdef(char *label,
+                                         uint32_t val, uint32_t defval)
+{
+       printf("%-23s: 0x%08x / %8u bytes ", label, val, val);
+
+       if (val == defval)
+               printf("(== OpenWrt default)\n");
+       else
+               printf("(OpenWrt default: 0x%08x)\n", defval);
+}
+
+static inline void inspect_fw_pmd5sum(char *label, uint8_t *val, char *text)
+{
+       int i;
+
+       printf("%-23s:", label);
+       for (i=0; i<MD5SUM_LEN; i++)
+               printf(" %02x", val[i]);
+       printf(" %s\n", text);
+}
+
+static int inspect_fw(void)
+{
+       char *buf;
+       struct fw_header *hdr;
+       uint8_t md5sum[MD5SUM_LEN];
+       struct board_info *board;
+       int ret = EXIT_FAILURE;
+
+       buf = malloc(inspect_info.file_size);
+       if (!buf) {
+               ERR("no memory for buffer!\n");
+               goto out;
+       }
 
-       ret = write_fw(buf, buflen);
+       ret = read_to_buf(&inspect_info, buf);
        if (ret)
                goto out_free_buf;
+       hdr = (struct fw_header *)buf;
 
-       ret = EXIT_SUCCESS;
+       inspect_fw_pstr("File name", inspect_info.file_name);
+       inspect_fw_phexdec("File size", inspect_info.file_size);
+
+       if (BE32_TO_HOST(hdr->version) != HEADER_VERSION_V1) {
+               ERR("file does not seem to have V1 header!\n");
+               goto out_free_buf;
+       }
+
+       inspect_fw_phexdec("Version 1 Header size", sizeof(struct fw_header));
+
+       if (BE32_TO_HOST(hdr->unk1) != 0)
+               inspect_fw_phexdec("Unknown value 1", hdr->unk1);
+
+       memcpy(md5sum, hdr->md5sum1, sizeof(md5sum));
+       if (BE32_TO_HOST(hdr->boot_len) == 0)
+               memcpy(hdr->md5sum1, md5salt_normal, sizeof(md5sum));
+       else
+               memcpy(hdr->md5sum1, md5salt_boot, sizeof(md5sum));
+       get_md5(buf, inspect_info.file_size, hdr->md5sum1);
+
+       if (memcmp(md5sum, hdr->md5sum1, sizeof(md5sum))) {
+               inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(*ERROR*)");
+               inspect_fw_pmd5sum("          --> expected", hdr->md5sum1, "");
+       } else {
+               inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(ok)");
+       }
+       if (BE32_TO_HOST(hdr->unk2) != 0)
+               inspect_fw_phexdec("Unknown value 2", hdr->unk2);
+       inspect_fw_pmd5sum("Header MD5Sum2", hdr->md5sum2,
+                          "(purpose yet unknown, unchecked here)");
+       if (BE32_TO_HOST(hdr->unk3) != 0)
+               inspect_fw_phexdec("Unknown value 3", hdr->unk3);
+
+       printf("\n");
+
+       inspect_fw_pstr("Vendor name", hdr->vendor_name);
+       inspect_fw_pstr("Firmware version", hdr->fw_version);
+       board = find_board_by_hwid(BE32_TO_HOST(hdr->hw_id));
+       if (board) {
+               inspect_fw_phexpost("Hardware ID",
+                                   BE32_TO_HOST(hdr->hw_id), board->id);
+               inspect_fw_phexexp("Hardware Revision",
+                                  BE32_TO_HOST(hdr->hw_rev), board->hw_rev);
+       } else {
+               inspect_fw_phexpost("Hardware ID",
+                                   BE32_TO_HOST(hdr->hw_id), "unknown");
+               inspect_fw_phex("Hardware Revision",
+                               BE32_TO_HOST(hdr->hw_rev));
+       }
+
+       printf("\n");
+
+       inspect_fw_phexdec("Kernel data offset",
+                          BE32_TO_HOST(hdr->kernel_ofs));
+       inspect_fw_phexdec("Kernel data length",
+                          BE32_TO_HOST(hdr->kernel_len));
+       if (board) {
+               inspect_fw_phexdef("Kernel load address",
+                                  BE32_TO_HOST(hdr->kernel_la),
+                                  board->kernel_la);
+               inspect_fw_phexdef("Kernel entry point",
+                                  BE32_TO_HOST(hdr->kernel_ep),
+                                  board->kernel_ep);
+               inspect_fw_phexdecdef("Rootfs data offset",
+                                     BE32_TO_HOST(hdr->rootfs_ofs),
+                                     board->rootfs_ofs);
+       } else {
+               inspect_fw_phex("Kernel load address",
+                               BE32_TO_HOST(hdr->kernel_la));
+               inspect_fw_phex("Kernel entry point",
+                               BE32_TO_HOST(hdr->kernel_ep));
+               inspect_fw_phexdec("Rootfs data offset",
+                                  BE32_TO_HOST(hdr->rootfs_ofs));
+       }
+       inspect_fw_phexdec("Rootfs data length",
+                          BE32_TO_HOST(hdr->rootfs_len));
+       inspect_fw_phexdec("Boot loader data offset",
+                          BE32_TO_HOST(hdr->boot_ofs));
+       inspect_fw_phexdec("Boot loader data length",
+                          BE32_TO_HOST(hdr->boot_len));
+       inspect_fw_phexdec("Total firmware length",
+                          BE32_TO_HOST(hdr->fw_length));
+
+       if (extract) {
+               FILE *fp;
+               char *filename;
+
+               printf("\n");
+
+               filename = malloc(strlen(inspect_info.file_name) + 8);
+               sprintf(filename, "%s-kernel", inspect_info.file_name);
+               printf("Extracting kernel to \"%s\"...\n", filename);
+               fp = fopen(filename, "w");
+               if (fp) {
+                       if (!fwrite(buf + BE32_TO_HOST(hdr->kernel_ofs),
+                                   BE32_TO_HOST(hdr->kernel_len), 1, fp)) {
+                               ERR("error in fwrite(): %s", strerror(errno));
+                       }
+                       fclose(fp);
+               } else {
+                       ERR("error in fopen(): %s", strerror(errno));
+               }
+               free(filename);
+
+               filename = malloc(strlen(inspect_info.file_name) + 8);
+               sprintf(filename, "%s-rootfs", inspect_info.file_name);
+               printf("Extracting rootfs to \"%s\"...\n", filename);
+               fp = fopen(filename, "w");
+               if (fp) {
+                       if (!fwrite(buf + BE32_TO_HOST(hdr->rootfs_ofs),
+                                   BE32_TO_HOST(hdr->rootfs_len), 1, fp)) {
+                               ERR("error in fwrite(): %s", strerror(errno));
+                       }
+                       fclose(fp);
+               } else {
+                       ERR("error in fopen(): %s", strerror(errno));
+               }
+               free(filename);
+       }
 
  out_free_buf:
        free(buf);
@@ -394,7 +805,7 @@ int main(int argc, char *argv[])
        while ( 1 ) {
                int c;
 
-               c = getopt(argc, argv, "B:V:N:k:r:o:v:h:");
+               c = getopt(argc, argv, "B:E:L:V:N:ci:k:r:R:o:xhs");
                if (c == -1)
                        break;
 
@@ -402,23 +813,41 @@ int main(int argc, char *argv[])
                case 'B':
                        board_id = optarg;
                        break;
+               case 'E':
+                       sscanf(optarg, "0x%x", &kernel_ep);
+                       break;
+               case 'L':
+                       sscanf(optarg, "0x%x", &kernel_la);
+                       break;
                case 'V':
                        version = optarg;
                        break;
                case 'N':
                        vendor = optarg;
                        break;
+               case 'c':
+                       combined++;
+                       break;
                case 'k':
                        kernel_info.file_name = optarg;
                        break;
                case 'r':
                        rootfs_info.file_name = optarg;
                        break;
+               case 'R':
+                       sscanf(optarg, "0x%x", &rootfs_ofs);
+                       break;
                case 'o':
                        ofname = optarg;
                        break;
-               case 'v':
-                       version = optarg;
+               case 's':
+                       strip_padding = 1;
+                       break;
+               case 'i':
+                       inspect_info.file_name = optarg;
+                       break;
+               case 'x':
+                       extract = 1;
                        break;
                case 'h':
                        usage(EXIT_SUCCESS);
@@ -433,7 +862,10 @@ int main(int argc, char *argv[])
        if (ret)
                goto out;
 
-       ret = build_fw();
+       if (!inspect_info.file_name)
+               ret = build_fw();
+       else
+               ret = inspect_fw();
 
  out:
        return ret;
This page took 0.039462 seconds and 4 git commands to generate.