ar71xx: add support for TP-LINK Archer C7 v5
[openwrt/openwrt.git] / tools / firmware-utils / src / tplink-safeloader.c
index 0a11287f875009537eef27a9cbf4e4998421ebdf..bdefb24e0c21644ccdd222bf84d423968625877d 100644 (file)
@@ -140,10 +140,10 @@ static struct device_info boards[] = {
                        {"default-mac", 0x30000, 0x00020},
                        {"product-info", 0x31100, 0x00100},
                        {"signature", 0x32000, 0x00400},
-                       {"os-image", 0x40000, 0x170000},
-                       {"soft-version", 0x1b0000, 0x00100},
-                       {"support-list", 0x1b1000, 0x00400},
-                       {"file-system", 0x1c0000, 0x600000},
+                       {"os-image", 0x40000, 0x1c0000},
+                       {"file-system", 0x200000, 0x5b0000},
+                       {"soft-version", 0x7b0000, 0x00100},
+                       {"support-list", 0x7b1000, 0x00400},
                        {"user-config", 0x7c0000, 0x10000},
                        {"default-config", 0x7d0000, 0x10000},
                        {"log", 0x7e0000, 0x10000},
@@ -152,7 +152,7 @@ static struct device_info boards[] = {
                },
 
                .first_sysupgrade_partition = "os-image",
-               .last_sysupgrade_partition = "file-system",
+               .last_sysupgrade_partition = "support-list",
        },
 
        /** Firmware layout for the CPE510/520 */
@@ -178,10 +178,10 @@ static struct device_info boards[] = {
                        {"default-mac", 0x30000, 0x00020},
                        {"product-info", 0x31100, 0x00100},
                        {"signature", 0x32000, 0x00400},
-                       {"os-image", 0x40000, 0x170000},
-                       {"soft-version", 0x1b0000, 0x00100},
-                       {"support-list", 0x1b1000, 0x00400},
-                       {"file-system", 0x1c0000, 0x600000},
+                       {"os-image", 0x40000, 0x1c0000},
+                       {"file-system", 0x200000, 0x5b0000},
+                       {"soft-version", 0x7b0000, 0x00100},
+                       {"support-list", 0x7b1000, 0x00400},
                        {"user-config", 0x7c0000, 0x10000},
                        {"default-config", 0x7d0000, 0x10000},
                        {"log", 0x7e0000, 0x10000},
@@ -190,7 +190,7 @@ static struct device_info boards[] = {
                },
 
                .first_sysupgrade_partition = "os-image",
-               .last_sysupgrade_partition = "file-system",
+               .last_sysupgrade_partition = "support-list",
        },
 
        {
@@ -210,10 +210,10 @@ static struct device_info boards[] = {
                        {"default-mac", 0x30000, 0x00020},
                        {"product-info", 0x31100, 0x00100},
                        {"signature", 0x32000, 0x00400},
-                       {"os-image", 0x40000, 0x170000},
-                       {"soft-version", 0x1b0000, 0x00100},
-                       {"support-list", 0x1b1000, 0x00400},
-                       {"file-system", 0x1c0000, 0x600000},
+                       {"os-image", 0x40000, 0x1c0000},
+                       {"file-system", 0x200000, 0x5b0000},
+                       {"soft-version", 0x7b0000, 0x00100},
+                       {"support-list", 0x7b1000, 0x00400},
                        {"user-config", 0x7c0000, 0x10000},
                        {"default-config", 0x7d0000, 0x10000},
                        {"log", 0x7e0000, 0x10000},
@@ -222,7 +222,7 @@ static struct device_info boards[] = {
                },
 
                .first_sysupgrade_partition = "os-image",
-               .last_sysupgrade_partition = "file-system",
+               .last_sysupgrade_partition = "support-list",
        },
 
        {
@@ -242,10 +242,10 @@ static struct device_info boards[] = {
                        {"default-mac", 0x30000, 0x00020},
                        {"product-info", 0x31100, 0x00100},
                        {"signature", 0x32000, 0x00400},
-                       {"os-image", 0x40000, 0x170000},
-                       {"soft-version", 0x1b0000, 0x00100},
-                       {"support-list", 0x1b1000, 0x00400},
-                       {"file-system", 0x1c0000, 0x600000},
+                       {"os-image", 0x40000, 0x1c0000},
+                       {"file-system", 0x200000, 0x5b0000},
+                       {"soft-version", 0x7b0000, 0x00100},
+                       {"support-list", 0x7b1000, 0x00400},
                        {"user-config", 0x7c0000, 0x10000},
                        {"default-config", 0x7d0000, 0x10000},
                        {"log", 0x7e0000, 0x10000},
@@ -254,7 +254,7 @@ static struct device_info boards[] = {
                },
 
                .first_sysupgrade_partition = "os-image",
-               .last_sysupgrade_partition = "file-system",
+               .last_sysupgrade_partition = "support-list",
        },
 
        /** Firmware layout for the C2600 */
@@ -267,6 +267,11 @@ static struct device_info boards[] = {
                .support_trail = '\x00',
                .soft_ver = NULL,
 
+               /**
+                   We use a bigger os-image partition than the stock images (and thus
+                   smaller file-system), as our kernel doesn't fit in the stock firmware's
+                   2 MB os-image since kernel 4.14.
+               */
                .partitions = {
                        {"SBL1", 0x00000, 0x20000},
                        {"MIBIB", 0x20000, 0x20000},
@@ -279,8 +284,8 @@ static struct device_info boards[] = {
                        {"fs-uboot", 0x100000, 0x70000},
                        {"uboot-env", 0x170000, 0x40000},
                        {"radio", 0x1b0000, 0x40000},
-                       {"os-image", 0x1f0000, 0x200000},
-                       {"file-system", 0x3f0000, 0x1b00000},
+                       {"os-image", 0x1f0000, 0x400000}, /* Stock: base 0x1f0000 size 0x200000 */
+                       {"file-system", 0x5f0000, 0x1900000}, /* Stock: base 0x3f0000 size 0x1b00000 */
                        {"default-mac", 0x1ef0000, 0x00200},
                        {"pin", 0x1ef0200, 0x00200},
                        {"product-info", 0x1ef0400, 0x0fc00},
@@ -451,6 +456,43 @@ static struct device_info boards[] = {
                .last_sysupgrade_partition = "file-system",
        },
 
+       /** Firmware layout for the C60v2 */
+       {
+               .id     = "ARCHER-C60-V2",
+               .vendor = "",
+               .support_list =
+                       "SupportList:\r\n"
+                       "{product_name:Archer C60,product_ver:2.0.0,special_id:42520000}\r\n"
+                       "{product_name:Archer C60,product_ver:2.0.0,special_id:45550000}\r\n"
+                       "{product_name:Archer C60,product_ver:2.0.0,special_id:55530000}\r\n",
+               .support_trail = '\x00',
+               .soft_ver = "soft_ver:2.0.0\n",
+
+               .partitions = {
+                       {"factory-boot", 0x00000, 0x1fb00},
+                       {"default-mac", 0x1fb00, 0x00200},
+                       {"pin", 0x1fd00, 0x00100},
+                       {"product-info", 0x1fe00, 0x00100},
+                       {"device-id", 0x1ff00, 0x00100},
+                       {"fs-uboot", 0x20000, 0x10000},
+                       {"os-image", 0x30000, 0x180000},
+                       {"file-system", 0x1b0000, 0x620000},
+                       {"soft-version", 0x7d9500, 0x00100},
+                       {"support-list", 0x7d9600, 0x00100},
+                       {"extra-para", 0x7d9700, 0x00100},
+                       {"profile", 0x7d9800, 0x03000},
+                       {"default-config", 0x7dc800, 0x03000},
+                       {"partition-table", 0x7df800, 0x00800},
+                       {"user-config", 0x7e0000, 0x0c000},
+                       {"certificate", 0x7ec000, 0x04000},
+                       {"radio", 0x7f0000, 0x10000},
+                       {NULL, 0, 0}
+               },
+
+               .first_sysupgrade_partition = "os-image",
+               .last_sysupgrade_partition = "file-system",
+       },
+
        /** Firmware layout for the C5 */
        {
                .id = "ARCHER-C5-V2",
@@ -536,6 +578,52 @@ static struct device_info boards[] = {
                .last_sysupgrade_partition = "file-system",
        },
 
+       /** Firmware layout for the C7 v5*/
+       {
+               .id = "ARCHER-C7-V5",
+               .support_list =
+                       "SupportList:\n"
+                       "{product_name:Archer C7,product_ver:5.0.0,special_id:00000000}\n"
+                       "{product_name:Archer C7,product_ver:5.0.0,special_id:55530000}\n",
+
+               .support_trail = '\x00',
+               .soft_ver = "soft_ver:1.0.0\n",
+
+               /**
+                 We use a bigger os-image partition than the stock images (and thus
+                 smaller file-system), as our kernel doesn't fit in the stock firmware's
+                 1MB os-image.
+                 */
+               .partitions = {
+                       {"factory-boot",    0x00000,  0x20000},
+                       {"fs-uboot",        0x20000,  0x20000},
+                       {"partition-table", 0x40000,  0x10000},
+                       {"radio",           0x50000,  0x10000},
+                       {"default-mac",     0x60000,  0x00200},
+                       {"pin",             0x60200,  0x00200},
+                       {"device-id",       0x60400,  0x00100},
+                       {"product-info",    0x60500,  0x0fb00},
+                       {"soft-version",    0x70000,  0x01000},
+                       {"extra-para",      0x71000,  0x01000},
+                       {"support-list",    0x72000,  0x0a000},
+                       {"profile",         0x7c000,  0x04000},
+                       {"user-config",     0x80000,  0x40000},
+
+
+                       {"os-image",        0xc0000,  0x180000}, /* Stock: base 0xc0000  size 0x120000 */
+                       {"file-system",     0x240000, 0xd80000}, /* Stock: base 0x1e0000 size 0xde0000 */
+
+                       {"log",             0xfc0000, 0x20000},
+                       {"certificate",     0xfe0000, 0x10000},
+                       {"default-config",  0xff0000, 0x10000},
+                       {NULL, 0, 0}
+
+               },
+
+               .first_sysupgrade_partition = "os-image",
+               .last_sysupgrade_partition = "file-system",
+       },
+
        /** Firmware layout for the C9 */
        {
                .id = "ARCHERC9",
@@ -849,12 +937,12 @@ static struct device_info boards[] = {
 
                /**
                        The original os-image partition is too small,
-                       so we enlarge it to 1.6M
+                       so we enlarge it to 1.75M
                */
                .partitions = {
                        {"fs-uboot", 0x00000, 0x20000},
-                       {"os-image", 0x20000, 0x1a0000},
-                       {"file-system", 0x1c0000, 0x440000},
+                       {"os-image", 0x20000, 0x1c0000},
+                       {"file-system", 0x1e0000, 0x420000},
                        {"partition-table", 0x600000, 0x02000},
                        {"default-mac", 0x610000, 0x00020},
                        {"pin", 0x610100, 0x00020},
@@ -1343,10 +1431,11 @@ static void build_image(const char *output,
 
        /* Some devices need the extra-para partition to accept the firmware */
        if (strcasecmp(info->id, "ARCHER-C25-V1") == 0 ||
+           strcasecmp(info->id, "ARCHER-C60-V2") == 0 ||
            strcasecmp(info->id, "TLWR1043NV5") == 0) {
                const char mdat[11] = {0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00};
                parts[5] = put_data("extra-para", mdat, 11);
-       } else if (strcasecmp(info->id, "ARCHER-C7-V4") == 0) {
+       } else if (strcasecmp(info->id, "ARCHER-C7-V4") == 0 || strcasecmp(info->id, "ARCHER-C7-V5") == 0) {
                const char mdat[11] = {0x01, 0x00, 0x00, 0x02, 0x00, 0x00, 0xca, 0x00, 0x01, 0x00, 0x00};
                parts[5] = put_data("extra-para", mdat, 11);
        }
@@ -1392,7 +1481,8 @@ static void usage(const char *argv0) {
                "  -S              create sysupgrade instead of factory image\n"
                "Extract an old image:\n"
                "  -x <file>       extract all oem firmware partition\n"
-               "  -d <dir>        destination to extract the firmware partition\n",
+               "  -d <dir>        destination to extract the firmware partition\n"
+               "  -z <file>       convert an oem firmware into a sysupgade file. Use -o for output file\n",
                argv0
        );
 };
@@ -1416,9 +1506,9 @@ static int add_flash_partition(
                unsigned long base,
                unsigned long size)
 {
-       int ptr = 0;
+       int ptr;
        /* check if the list has a free entry */
-       for (int ptr=0; ptr<max_entries; ptr++, part_list++) {
+       for (ptr = 0; ptr < max_entries; ptr++, part_list++) {
                if (part_list->name == NULL &&
                                part_list->base == 0 &&
                                part_list->size == 0)
@@ -1494,7 +1584,7 @@ static int read_partition_table(
                        break;
                }
 
-               for (int i=0; i<=4; i++) {
+               for (int i = 0; i <= 4; i++) {
                        if (end_part <= ptr)
                                break;
 
@@ -1620,7 +1710,7 @@ static int extract_firmware(const char *input, const char *output_directory)
                error(1, 0, "Error can not read the partition table (fwup-ptn)");
        }
 
-       for (int i=0; i<max_entries; i++) {
+       for (int i = 0; i < max_entries; i++) {
                if (entries[i].name == NULL &&
                                entries[i].base == 0 &&
                                entries[i].size == 0)
@@ -1632,9 +1722,100 @@ static int extract_firmware(const char *input, const char *output_directory)
        return 0;
 }
 
+static struct flash_partition_entry *find_partition(
+               struct flash_partition_entry *entries, size_t max_entries,
+               const char *name, const char *error_msg)
+{
+       for (int i = 0; i < max_entries; i++, entries++) {
+               if (strcmp(entries->name, name) == 0)
+                       return entries;
+       }
+
+       error(1, 0, "%s", error_msg);
+       return NULL;
+}
+
+static void write_ff(FILE *output_file, size_t size)
+{
+       char buf[4096];
+       int offset;
+
+       memset(buf, 0xff, sizeof(buf));
+
+       for (offset = 0; offset + sizeof(buf) < size ; offset += sizeof(buf)) {
+               if (fwrite(buf, sizeof(buf), 1, output_file) < 0)
+                       error(1, errno, "Can not write 0xff to output_file");
+       }
+
+       /* write last chunk smaller than buffer */
+       if (offset < size) {
+               offset = size - offset;
+               if (fwrite(buf, offset, 1, output_file) < 0)
+                       error(1, errno, "Can not write partition to output_file");
+       }
+}
+
+static void convert_firmware(const char *input, const char *output)
+{
+       struct flash_partition_entry fwup[MAX_PARTITIONS] = { 0 };
+       struct flash_partition_entry flash[MAX_PARTITIONS] = { 0 };
+       struct flash_partition_entry *fwup_os_image = NULL, *fwup_file_system = NULL;
+       struct flash_partition_entry *flash_os_image = NULL, *flash_file_system = NULL;
+       struct flash_partition_entry *fwup_partition_table = NULL;
+       size_t firmware_offset = 0x1014;
+       FILE *input_file, *output_file;
+
+       struct stat statbuf;
+
+       /* check input file */
+       if (stat(input, &statbuf)) {
+               error(1, errno, "Can not read input firmware %s", input);
+       }
+
+       input_file = fopen(input, "rb");
+       if (!input_file)
+               error(1, 0, "Can not open input firmware %s", input);
+
+       output_file = fopen(output, "wb");
+       if (!output_file)
+               error(1, 0, "Can not open output firmware %s", output);
+
+       if (read_partition_table(input_file, firmware_offset, fwup, MAX_PARTITIONS, 0) != 0) {
+               error(1, 0, "Error can not read the partition table (fwup-ptn)");
+       }
+
+       fwup_os_image = find_partition(fwup, MAX_PARTITIONS,
+                       "os-image", "Error can not find os-image partition (fwup)");
+       fwup_file_system = find_partition(fwup, MAX_PARTITIONS,
+                       "file-system", "Error can not find file-system partition (fwup)");
+       fwup_partition_table = find_partition(fwup, MAX_PARTITIONS,
+                       "partition-table", "Error can not find partition-table partition");
+
+       /* the flash partition table has a 0x00000004 magic haeder */
+       if (read_partition_table(input_file, firmware_offset + fwup_partition_table->base + 4, flash, MAX_PARTITIONS, 1) != 0)
+               error(1, 0, "Error can not read the partition table (flash)");
+
+       flash_os_image = find_partition(flash, MAX_PARTITIONS,
+                       "os-image", "Error can not find os-image partition (flash)");
+       flash_file_system = find_partition(flash, MAX_PARTITIONS,
+                       "file-system", "Error can not find file-system partition (flash)");
+
+       /* write os_image to 0x0 */
+       write_partition(input_file, firmware_offset, fwup_os_image, output_file);
+       write_ff(output_file, flash_os_image->size - fwup_os_image->size);
+
+       /* write file-system behind os_image */
+       fseek(output_file, flash_file_system->base - flash_os_image->base, SEEK_SET);
+       write_partition(input_file, firmware_offset, fwup_file_system, output_file);
+       write_ff(output_file, flash_file_system->size - fwup_file_system->size);
+
+       fclose(output_file);
+       fclose(input_file);
+}
+
 int main(int argc, char *argv[]) {
        const char *board = NULL, *kernel_image = NULL, *rootfs_image = NULL, *output = NULL;
-       const char *extract_image = NULL, *output_directory = NULL;
+       const char *extract_image = NULL, *output_directory = NULL, *convert_image = NULL;
        bool add_jffs2_eof = false, sysupgrade = false;
        unsigned rev = 0;
        const struct device_info *info;
@@ -1643,7 +1824,7 @@ int main(int argc, char *argv[]) {
        while (true) {
                int c;
 
-               c = getopt(argc, argv, "B:k:r:o:V:jSh:x:d:");
+               c = getopt(argc, argv, "B:k:r:o:V:jSh:x:d:z:");
                if (c == -1)
                        break;
 
@@ -1688,6 +1869,10 @@ int main(int argc, char *argv[]) {
                        extract_image = optarg;
                        break;
 
+               case 'z':
+                       convert_image = optarg;
+                       break;
+
                default:
                        usage(argv[0]);
                        return 1;
@@ -1700,6 +1885,10 @@ int main(int argc, char *argv[]) {
                if (!output_directory)
                        error(1, 0, "Can not extract an image without output directory. Use -d <dir>");
                extract_firmware(extract_image, output_directory);
+       } else if (convert_image) {
+               if (!output)
+                       error(1, 0, "Can not convert a factory/oem image into sysupgrade image without output file. Use -o <file>");
+               convert_firmware(convert_image, output);
        } else {
                if (!board)
                        error(1, 0, "no board has been specified");