2 Copyright (c) 2014, Matthias Schiffer <mschiffer@universe-factory.net>
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions are met:
8 1. Redistributions of source code must retain the above copyright notice,
9 this list of conditions and the following disclaimer.
10 2. Redistributions in binary form must reproduce the above copyright notice,
11 this list of conditions and the following disclaimer in the documentation
12 and/or other materials provided with the distribution.
14 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
18 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
22 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 Image generation tool for the TP-LINK SafeLoader as seen on
31 TP-LINK Pharos devices (CPE210/220/510/520)
45 #include <arpa/inet.h>
47 #include <sys/types.h>
53 #define ALIGN(x,a) ({ typeof(a) __a = (a); (((x) + __a - 1) & ~(__a - 1)); })
56 #define MAX_PARTITIONS 32
58 /** An image partition table entry */
59 struct image_partition_entry {
65 /** A flash partition table entry */
66 struct flash_partition_entry {
72 /** Firmware layout description */
76 const char *support_list;
79 const struct flash_partition_entry partitions[MAX_PARTITIONS+1];
80 const char *first_sysupgrade_partition;
81 const char *last_sysupgrade_partition;
84 /** The content of the soft-version structure */
85 struct __attribute__((__packed__)) soft_version {
89 uint8_t version_major;
90 uint8_t version_minor;
91 uint8_t version_patch;
101 static const uint8_t jffs2_eof_mark[4] = {0xde, 0xad, 0xc0, 0xde};
105 Salt for the MD5 hash
107 Fortunately, TP-LINK seems to use the same salt for most devices which use
108 the new image format.
110 static const uint8_t md5_salt[16] = {
111 0x7a, 0x2b, 0x15, 0xed,
112 0x9b, 0x98, 0x59, 0x6d,
113 0xe5, 0x04, 0xab, 0x44,
114 0xac, 0x2a, 0x9f, 0x4e,
118 /** Firmware layout table */
119 static struct device_info boards[] = {
120 /** Firmware layout for the CPE210/220 */
123 .vendor = "CPE510(TP-LINK|UN|N300-5):1.0\r\n",
126 "CPE210(TP-LINK|UN|N300-2):1.0\r\n"
127 "CPE210(TP-LINK|UN|N300-2):1.1\r\n"
128 "CPE210(TP-LINK|US|N300-2):1.1\r\n"
129 "CPE210(TP-LINK|EU|N300-2):1.1\r\n"
130 "CPE220(TP-LINK|UN|N300-2):1.1\r\n"
131 "CPE220(TP-LINK|US|N300-2):1.1\r\n"
132 "CPE220(TP-LINK|EU|N300-2):1.1\r\n",
133 .support_trail = '\xff',
137 {"fs-uboot", 0x00000, 0x20000},
138 {"partition-table", 0x20000, 0x02000},
139 {"default-mac", 0x30000, 0x00020},
140 {"product-info", 0x31100, 0x00100},
141 {"signature", 0x32000, 0x00400},
142 {"os-image", 0x40000, 0x170000},
143 {"soft-version", 0x1b0000, 0x00100},
144 {"support-list", 0x1b1000, 0x00400},
145 {"file-system", 0x1c0000, 0x600000},
146 {"user-config", 0x7c0000, 0x10000},
147 {"default-config", 0x7d0000, 0x10000},
148 {"log", 0x7e0000, 0x10000},
149 {"radio", 0x7f0000, 0x10000},
153 .first_sysupgrade_partition = "os-image",
154 .last_sysupgrade_partition = "file-system",
157 /** Firmware layout for the CPE510/520 */
160 .vendor = "CPE510(TP-LINK|UN|N300-5):1.0\r\n",
163 "CPE510(TP-LINK|UN|N300-5):1.0\r\n"
164 "CPE510(TP-LINK|UN|N300-5):1.1\r\n"
165 "CPE510(TP-LINK|UN|N300-5):1.1\r\n"
166 "CPE510(TP-LINK|US|N300-5):1.1\r\n"
167 "CPE510(TP-LINK|EU|N300-5):1.1\r\n"
168 "CPE520(TP-LINK|UN|N300-5):1.1\r\n"
169 "CPE520(TP-LINK|US|N300-5):1.1\r\n"
170 "CPE520(TP-LINK|EU|N300-5):1.1\r\n",
171 .support_trail = '\xff',
175 {"fs-uboot", 0x00000, 0x20000},
176 {"partition-table", 0x20000, 0x02000},
177 {"default-mac", 0x30000, 0x00020},
178 {"product-info", 0x31100, 0x00100},
179 {"signature", 0x32000, 0x00400},
180 {"os-image", 0x40000, 0x170000},
181 {"soft-version", 0x1b0000, 0x00100},
182 {"support-list", 0x1b1000, 0x00400},
183 {"file-system", 0x1c0000, 0x600000},
184 {"user-config", 0x7c0000, 0x10000},
185 {"default-config", 0x7d0000, 0x10000},
186 {"log", 0x7e0000, 0x10000},
187 {"radio", 0x7f0000, 0x10000},
191 .first_sysupgrade_partition = "os-image",
192 .last_sysupgrade_partition = "file-system",
197 .vendor = "CPE510(TP-LINK|UN|N300-5):1.0\r\n",
200 "WBS210(TP-LINK|UN|N300-2):1.20\r\n"
201 "WBS210(TP-LINK|US|N300-2):1.20\r\n"
202 "WBS210(TP-LINK|EU|N300-2):1.20\r\n",
203 .support_trail = '\xff',
207 {"fs-uboot", 0x00000, 0x20000},
208 {"partition-table", 0x20000, 0x02000},
209 {"default-mac", 0x30000, 0x00020},
210 {"product-info", 0x31100, 0x00100},
211 {"signature", 0x32000, 0x00400},
212 {"os-image", 0x40000, 0x170000},
213 {"soft-version", 0x1b0000, 0x00100},
214 {"support-list", 0x1b1000, 0x00400},
215 {"file-system", 0x1c0000, 0x600000},
216 {"user-config", 0x7c0000, 0x10000},
217 {"default-config", 0x7d0000, 0x10000},
218 {"log", 0x7e0000, 0x10000},
219 {"radio", 0x7f0000, 0x10000},
223 .first_sysupgrade_partition = "os-image",
224 .last_sysupgrade_partition = "file-system",
229 .vendor = "CPE510(TP-LINK|UN|N300-5):1.0\r\n",
232 "WBS510(TP-LINK|UN|N300-5):1.20\r\n"
233 "WBS510(TP-LINK|US|N300-5):1.20\r\n"
234 "WBS510(TP-LINK|EU|N300-5):1.20\r\n",
235 .support_trail = '\xff',
239 {"fs-uboot", 0x00000, 0x20000},
240 {"partition-table", 0x20000, 0x02000},
241 {"default-mac", 0x30000, 0x00020},
242 {"product-info", 0x31100, 0x00100},
243 {"signature", 0x32000, 0x00400},
244 {"os-image", 0x40000, 0x170000},
245 {"soft-version", 0x1b0000, 0x00100},
246 {"support-list", 0x1b1000, 0x00400},
247 {"file-system", 0x1c0000, 0x600000},
248 {"user-config", 0x7c0000, 0x10000},
249 {"default-config", 0x7d0000, 0x10000},
250 {"log", 0x7e0000, 0x10000},
251 {"radio", 0x7f0000, 0x10000},
255 .first_sysupgrade_partition = "os-image",
256 .last_sysupgrade_partition = "file-system",
259 /** Firmware layout for the C2600 */
265 "{product_name:Archer C2600,product_ver:1.0.0,special_id:00000000}\r\n",
266 .support_trail = '\x00',
270 {"SBL1", 0x00000, 0x20000},
271 {"MIBIB", 0x20000, 0x20000},
272 {"SBL2", 0x40000, 0x20000},
273 {"SBL3", 0x60000, 0x30000},
274 {"DDRCONFIG", 0x90000, 0x10000},
275 {"SSD", 0xa0000, 0x10000},
276 {"TZ", 0xb0000, 0x30000},
277 {"RPM", 0xe0000, 0x20000},
278 {"fs-uboot", 0x100000, 0x70000},
279 {"uboot-env", 0x170000, 0x40000},
280 {"radio", 0x1b0000, 0x40000},
281 {"os-image", 0x1f0000, 0x200000},
282 {"file-system", 0x3f0000, 0x1b00000},
283 {"default-mac", 0x1ef0000, 0x00200},
284 {"pin", 0x1ef0200, 0x00200},
285 {"product-info", 0x1ef0400, 0x0fc00},
286 {"partition-table", 0x1f00000, 0x10000},
287 {"soft-version", 0x1f10000, 0x10000},
288 {"support-list", 0x1f20000, 0x10000},
289 {"profile", 0x1f30000, 0x10000},
290 {"default-config", 0x1f40000, 0x10000},
291 {"user-config", 0x1f50000, 0x40000},
292 {"qos-db", 0x1f90000, 0x40000},
293 {"usb-config", 0x1fd0000, 0x10000},
294 {"log", 0x1fe0000, 0x20000},
298 .first_sysupgrade_partition = "os-image",
299 .last_sysupgrade_partition = "file-system"
302 /** Firmware layout for the C25v1 */
304 .id = "ARCHER-C25-V1",
307 "{product_name:ArcherC25,product_ver:1.0.0,special_id:00000000}\n"
308 "{product_name:ArcherC25,product_ver:1.0.0,special_id:55530000}\n"
309 "{product_name:ArcherC25,product_ver:1.0.0,special_id:45550000}\n",
310 .support_trail = '\x00',
311 .soft_ver = "soft_ver:1.0.0\n",
314 We use a bigger os-image partition than the stock images (and thus
315 smaller file-system), as our kernel doesn't fit in the stock firmware's
319 {"factory-boot", 0x00000, 0x20000},
320 {"fs-uboot", 0x20000, 0x10000},
321 {"os-image", 0x30000, 0x180000}, /* Stock: base 0x30000 size 0x100000 */
322 {"file-system", 0x1b0000, 0x620000}, /* Stock: base 0x130000 size 0x6a0000 */
323 {"user-config", 0x7d0000, 0x04000},
324 {"default-mac", 0x7e0000, 0x00100},
325 {"device-id", 0x7e0100, 0x00100},
326 {"extra-para", 0x7e0200, 0x00100},
327 {"pin", 0x7e0300, 0x00100},
328 {"support-list", 0x7e0400, 0x00400},
329 {"soft-version", 0x7e0800, 0x00400},
330 {"product-info", 0x7e0c00, 0x01400},
331 {"partition-table", 0x7e2000, 0x01000},
332 {"profile", 0x7e3000, 0x01000},
333 {"default-config", 0x7e4000, 0x04000},
334 {"merge-config", 0x7ec000, 0x02000},
335 {"qos-db", 0x7ee000, 0x02000},
336 {"radio", 0x7f0000, 0x10000},
340 .first_sysupgrade_partition = "os-image",
341 .last_sysupgrade_partition = "file-system",
344 /** Firmware layout for the C59v1 */
346 .id = "ARCHER-C59-V1",
350 "{product_name:Archer C59,product_ver:1.0.0,special_id:00000000}\r\n"
351 "{product_name:Archer C59,product_ver:1.0.0,special_id:45550000}\r\n"
352 "{product_name:Archer C59,product_ver:1.0.0,special_id:52550000}\r\n"
353 "{product_name:Archer C59,product_ver:1.0.0,special_id:55530000}\r\n",
354 .support_trail = '\x00',
355 .soft_ver = "soft_ver:1.0.0\n",
358 {"fs-uboot", 0x00000, 0x10000},
359 {"default-mac", 0x10000, 0x00200},
360 {"pin", 0x10200, 0x00200},
361 {"device-id", 0x10400, 0x00100},
362 {"product-info", 0x10500, 0x0fb00},
363 {"os-image", 0x20000, 0x180000},
364 {"file-system", 0x1a0000, 0xcb0000},
365 {"partition-table", 0xe50000, 0x10000},
366 {"soft-version", 0xe60000, 0x10000},
367 {"support-list", 0xe70000, 0x10000},
368 {"profile", 0xe80000, 0x10000},
369 {"default-config", 0xe90000, 0x10000},
370 {"user-config", 0xea0000, 0x40000},
371 {"usb-config", 0xee0000, 0x10000},
372 {"certificate", 0xef0000, 0x10000},
373 {"qos-db", 0xf00000, 0x40000},
374 {"log", 0xfe0000, 0x10000},
375 {"radio", 0xff0000, 0x10000},
379 .first_sysupgrade_partition = "os-image",
380 .last_sysupgrade_partition = "file-system",
383 /** Firmware layout for the C60v1 */
385 .id = "ARCHER-C60-V1",
389 "{product_name:Archer C60,product_ver:1.0.0,special_id:00000000}\r\n"
390 "{product_name:Archer C60,product_ver:1.0.0,special_id:45550000}\r\n"
391 "{product_name:Archer C60,product_ver:1.0.1,special_id:45550000}\r\n"
392 "{product_name:Archer C60,product_ver:1.0.0,special_id:52550000}\r\n"
393 "{product_name:Archer C60,product_ver:1.0.0,special_id:55530000}\r\n",
394 .support_trail = '\x00',
395 .soft_ver = "soft_ver:1.0.0\n",
398 {"fs-uboot", 0x00000, 0x10000},
399 {"default-mac", 0x10000, 0x00200},
400 {"pin", 0x10200, 0x00200},
401 {"product-info", 0x10400, 0x00100},
402 {"partition-table", 0x10500, 0x00800},
403 {"soft-version", 0x11300, 0x00200},
404 {"support-list", 0x11500, 0x00100},
405 {"device-id", 0x11600, 0x00100},
406 {"profile", 0x11700, 0x03900},
407 {"default-config", 0x15000, 0x04000},
408 {"user-config", 0x19000, 0x04000},
409 {"os-image", 0x20000, 0x150000},
410 {"file-system", 0x170000, 0x678000},
411 {"certyficate", 0x7e8000, 0x08000},
412 {"radio", 0x7f0000, 0x10000},
416 .first_sysupgrade_partition = "os-image",
417 .last_sysupgrade_partition = "file-system",
420 /** Firmware layout for the C5 */
422 .id = "ARCHER-C5-V2",
426 "{product_name:ArcherC5,"
428 "special_id:00000000}\r\n",
429 .support_trail = '\x00',
433 {"fs-uboot", 0x00000, 0x40000},
434 {"os-image", 0x40000, 0x200000},
435 {"file-system", 0x240000, 0xc00000},
436 {"default-mac", 0xe40000, 0x00200},
437 {"pin", 0xe40200, 0x00200},
438 {"product-info", 0xe40400, 0x00200},
439 {"partition-table", 0xe50000, 0x10000},
440 {"soft-version", 0xe60000, 0x00200},
441 {"support-list", 0xe61000, 0x0f000},
442 {"profile", 0xe70000, 0x10000},
443 {"default-config", 0xe80000, 0x10000},
444 {"user-config", 0xe90000, 0x50000},
445 {"log", 0xee0000, 0x100000},
446 {"radio_bk", 0xfe0000, 0x10000},
447 {"radio", 0xff0000, 0x10000},
451 .first_sysupgrade_partition = "os-image",
452 .last_sysupgrade_partition = "file-system"
455 /** Firmware layout for the C9 */
461 "{product_name:ArcherC9,"
463 "special_id:00000000}\n",
464 .support_trail = '\x00',
468 {"fs-uboot", 0x00000, 0x40000},
469 {"os-image", 0x40000, 0x200000},
470 {"file-system", 0x240000, 0xc00000},
471 {"default-mac", 0xe40000, 0x00200},
472 {"pin", 0xe40200, 0x00200},
473 {"product-info", 0xe40400, 0x00200},
474 {"partition-table", 0xe50000, 0x10000},
475 {"soft-version", 0xe60000, 0x00200},
476 {"support-list", 0xe61000, 0x0f000},
477 {"profile", 0xe70000, 0x10000},
478 {"default-config", 0xe80000, 0x10000},
479 {"user-config", 0xe90000, 0x50000},
480 {"log", 0xee0000, 0x100000},
481 {"radio_bk", 0xfe0000, 0x10000},
482 {"radio", 0xff0000, 0x10000},
486 .first_sysupgrade_partition = "os-image",
487 .last_sysupgrade_partition = "file-system"
490 /** Firmware layout for the EAP120 */
493 .vendor = "EAP120(TP-LINK|UN|N300-2):1.0\r\n",
496 "EAP120(TP-LINK|UN|N300-2):1.0\r\n",
497 .support_trail = '\xff',
501 {"fs-uboot", 0x00000, 0x20000},
502 {"partition-table", 0x20000, 0x02000},
503 {"default-mac", 0x30000, 0x00020},
504 {"support-list", 0x31000, 0x00100},
505 {"product-info", 0x31100, 0x00100},
506 {"soft-version", 0x32000, 0x00100},
507 {"os-image", 0x40000, 0x180000},
508 {"file-system", 0x1c0000, 0x600000},
509 {"user-config", 0x7c0000, 0x10000},
510 {"backup-config", 0x7d0000, 0x10000},
511 {"log", 0x7e0000, 0x10000},
512 {"radio", 0x7f0000, 0x10000},
516 .first_sysupgrade_partition = "os-image",
517 .last_sysupgrade_partition = "file-system"
520 /** Firmware layout for the TL-WA850RE v2 */
526 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:55530000}\n"
527 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:00000000}\n"
528 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:55534100}\n"
529 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:45550000}\n"
530 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:4B520000}\n"
531 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:42520000}\n"
532 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:4A500000}\n"
533 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:43410000}\n"
534 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:41550000}\n"
535 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:52550000}\n",
536 .support_trail = '\x00',
540 576KB were moved from file-system to os-image
541 in comparison to the stock image
544 {"fs-uboot", 0x00000, 0x20000},
545 {"os-image", 0x20000, 0x150000},
546 {"file-system", 0x170000, 0x240000},
547 {"partition-table", 0x3b0000, 0x02000},
548 {"default-mac", 0x3c0000, 0x00020},
549 {"pin", 0x3c0100, 0x00020},
550 {"product-info", 0x3c1000, 0x01000},
551 {"soft-version", 0x3c2000, 0x00100},
552 {"support-list", 0x3c3000, 0x01000},
553 {"profile", 0x3c4000, 0x08000},
554 {"user-config", 0x3d0000, 0x10000},
555 {"default-config", 0x3e0000, 0x10000},
556 {"radio", 0x3f0000, 0x10000},
560 .first_sysupgrade_partition = "os-image",
561 .last_sysupgrade_partition = "file-system"
564 /** Firmware layout for the TL-WA855RE v1 */
570 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:00000000}\n"
571 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:55530000}\n"
572 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:45550000}\n"
573 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:4B520000}\n"
574 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:42520000}\n"
575 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:4A500000}\n"
576 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:43410000}\n"
577 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:41550000}\n"
578 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:52550000}\n",
579 .support_trail = '\x00',
583 {"fs-uboot", 0x00000, 0x20000},
584 {"os-image", 0x20000, 0x150000},
585 {"file-system", 0x170000, 0x240000},
586 {"partition-table", 0x3b0000, 0x02000},
587 {"default-mac", 0x3c0000, 0x00020},
588 {"pin", 0x3c0100, 0x00020},
589 {"product-info", 0x3c1000, 0x01000},
590 {"soft-version", 0x3c2000, 0x00100},
591 {"support-list", 0x3c3000, 0x01000},
592 {"profile", 0x3c4000, 0x08000},
593 {"user-config", 0x3d0000, 0x10000},
594 {"default-config", 0x3e0000, 0x10000},
595 {"radio", 0x3f0000, 0x10000},
599 .first_sysupgrade_partition = "os-image",
600 .last_sysupgrade_partition = "file-system"
603 /** Firmware layout for the TL-WR1043 v4 */
605 .id = "TLWR1043NDV4",
609 "{product_name:TL-WR1043ND,product_ver:4.0.0,special_id:45550000}\n",
610 .support_trail = '\x00',
614 We use a bigger os-image partition than the stock images (and thus
615 smaller file-system), as our kernel doesn't fit in the stock firmware's
619 {"fs-uboot", 0x00000, 0x20000},
620 {"os-image", 0x20000, 0x180000},
621 {"file-system", 0x1a0000, 0xdb0000},
622 {"default-mac", 0xf50000, 0x00200},
623 {"pin", 0xf50200, 0x00200},
624 {"product-info", 0xf50400, 0x0fc00},
625 {"soft-version", 0xf60000, 0x0b000},
626 {"support-list", 0xf6b000, 0x04000},
627 {"profile", 0xf70000, 0x04000},
628 {"default-config", 0xf74000, 0x0b000},
629 {"user-config", 0xf80000, 0x40000},
630 {"partition-table", 0xfc0000, 0x10000},
631 {"log", 0xfd0000, 0x20000},
632 {"radio", 0xff0000, 0x10000},
636 .first_sysupgrade_partition = "os-image",
637 .last_sysupgrade_partition = "file-system"
640 /** Firmware layout for the TL-WR942N V1 */
646 "{product_name:TL-WR942N,product_ver:1.0.0,special_id:00000000}\r\n"
647 "{product_name:TL-WR942N,product_ver:1.0.0,special_id:52550000}\r\n",
648 .support_trail = '\x00',
652 {"fs-uboot", 0x00000, 0x20000},
653 {"os-image", 0x20000, 0x150000},
654 {"file-system", 0x170000, 0xcd0000},
655 {"default-mac", 0xe40000, 0x00200},
656 {"pin", 0xe40200, 0x00200},
657 {"product-info", 0xe40400, 0x0fc00},
658 {"partition-table", 0xe50000, 0x10000},
659 {"soft-version", 0xe60000, 0x10000},
660 {"support-list", 0xe70000, 0x10000},
661 {"profile", 0xe80000, 0x10000},
662 {"default-config", 0xe90000, 0x10000},
663 {"user-config", 0xea0000, 0x40000},
664 {"qos-db", 0xee0000, 0x40000},
665 {"certificate", 0xf20000, 0x10000},
666 {"usb-config", 0xfb0000, 0x10000},
667 {"log", 0xfc0000, 0x20000},
668 {"radio-bk", 0xfe0000, 0x10000},
669 {"radio", 0xff0000, 0x10000},
673 .first_sysupgrade_partition = "os-image",
674 .last_sysupgrade_partition = "file-system",
677 /** Firmware layout for the RE450 */
683 "{product_name:RE450,product_ver:1.0.0,special_id:00000000}\r\n"
684 "{product_name:RE450,product_ver:1.0.0,special_id:55530000}\r\n"
685 "{product_name:RE450,product_ver:1.0.0,special_id:45550000}\r\n"
686 "{product_name:RE450,product_ver:1.0.0,special_id:4A500000}\r\n"
687 "{product_name:RE450,product_ver:1.0.0,special_id:43410000}\r\n"
688 "{product_name:RE450,product_ver:1.0.0,special_id:41550000}\r\n"
689 "{product_name:RE450,product_ver:1.0.0,special_id:4B520000}\r\n"
690 "{product_name:RE450,product_ver:1.0.0,special_id:55534100}\r\n",
691 .support_trail = '\x00',
695 The flash partition table for RE450;
696 it is almost the same as the one used by the stock images,
697 576KB were moved from file-system to os-image.
700 {"fs-uboot", 0x00000, 0x20000},
701 {"os-image", 0x20000, 0x150000},
702 {"file-system", 0x170000, 0x4a0000},
703 {"partition-table", 0x600000, 0x02000},
704 {"default-mac", 0x610000, 0x00020},
705 {"pin", 0x610100, 0x00020},
706 {"product-info", 0x611100, 0x01000},
707 {"soft-version", 0x620000, 0x01000},
708 {"support-list", 0x621000, 0x01000},
709 {"profile", 0x622000, 0x08000},
710 {"user-config", 0x630000, 0x10000},
711 {"default-config", 0x640000, 0x10000},
712 {"radio", 0x7f0000, 0x10000},
716 .first_sysupgrade_partition = "os-image",
717 .last_sysupgrade_partition = "file-system"
723 #define error(_ret, _errno, _str, ...) \
725 fprintf(stderr, _str ": %s\n", ## __VA_ARGS__, \
732 /** Stores a uint32 as big endian */
733 static inline void put32(uint8_t *buf, uint32_t val) {
740 /** Allocates a new image partition */
741 static struct image_partition_entry alloc_image_partition(const char *name, size_t len) {
742 struct image_partition_entry entry = {name, len, malloc(len)};
744 error(1, errno, "malloc");
749 /** Frees an image partition */
750 static void free_image_partition(struct image_partition_entry entry) {
754 static time_t source_date_epoch = -1;
755 static void set_source_date_epoch() {
756 char *env = getenv("SOURCE_DATE_EPOCH");
760 source_date_epoch = strtoull(env, &endptr, 10);
761 if (errno || (endptr && *endptr != '\0')) {
762 fprintf(stderr, "Invalid SOURCE_DATE_EPOCH");
768 /** Generates the partition-table partition */
769 static struct image_partition_entry make_partition_table(const struct flash_partition_entry *p) {
770 struct image_partition_entry entry = alloc_image_partition("partition-table", 0x800);
772 char *s = (char *)entry.data, *end = (char *)(s+entry.size);
780 for (i = 0; p[i].name; i++) {
782 size_t w = snprintf(s, len, "partition %s base 0x%05x size 0x%05x\n", p[i].name, p[i].base, p[i].size);
785 error(1, 0, "flash partition table overflow?");
792 memset(s, 0xff, end-s);
798 /** Generates a binary-coded decimal representation of an integer in the range [0, 99] */
799 static inline uint8_t bcd(uint8_t v) {
800 return 0x10 * (v/10) + v%10;
804 /** Generates the soft-version partition */
805 static struct image_partition_entry make_soft_version(uint32_t rev) {
806 struct image_partition_entry entry = alloc_image_partition("soft-version", sizeof(struct soft_version));
807 struct soft_version *s = (struct soft_version *)entry.data;
811 if (source_date_epoch != -1)
812 t = source_date_epoch;
813 else if (time(&t) == (time_t)(-1))
814 error(1, errno, "time");
816 struct tm *tm = localtime(&t);
818 s->magic = htonl(0x0000000c);
822 s->version_major = 0;
823 s->version_minor = 0;
824 s->version_patch = 0;
826 s->year_hi = bcd((1900+tm->tm_year)/100);
827 s->year_lo = bcd(tm->tm_year%100);
828 s->month = bcd(tm->tm_mon+1);
829 s->day = bcd(tm->tm_mday);
837 static struct image_partition_entry make_soft_version_from_string(const char *soft_ver) {
838 /** String length _including_ the terminating zero byte */
839 uint32_t ver_len = strlen(soft_ver) + 1;
840 /** Partition contains 64 bit header, the version string, and one additional null byte */
841 size_t partition_len = 2*sizeof(uint32_t) + ver_len + 1;
842 struct image_partition_entry entry = alloc_image_partition("soft-version", partition_len);
844 uint32_t *len = (uint32_t *)entry.data;
845 len[0] = htonl(ver_len);
847 memcpy(&len[2], soft_ver, ver_len);
849 entry.data[partition_len - 1] = 0;
854 /** Generates the support-list partition */
855 static struct image_partition_entry make_support_list(const struct device_info *info) {
856 size_t len = strlen(info->support_list);
857 struct image_partition_entry entry = alloc_image_partition("support-list", len + 9);
859 put32(entry.data, len);
860 memset(entry.data+4, 0, 4);
861 memcpy(entry.data+8, info->support_list, len);
862 entry.data[len+8] = info->support_trail;
867 /** Creates a new image partition with an arbitrary name from a file */
868 static struct image_partition_entry read_file(const char *part_name, const char *filename, bool add_jffs2_eof) {
871 if (stat(filename, &statbuf) < 0)
872 error(1, errno, "unable to stat file `%s'", filename);
874 size_t len = statbuf.st_size;
877 len = ALIGN(len, 0x10000) + sizeof(jffs2_eof_mark);
879 struct image_partition_entry entry = alloc_image_partition(part_name, len);
881 FILE *file = fopen(filename, "rb");
883 error(1, errno, "unable to open file `%s'", filename);
885 if (fread(entry.data, statbuf.st_size, 1, file) != 1)
886 error(1, errno, "unable to read file `%s'", filename);
889 uint8_t *eof = entry.data + statbuf.st_size, *end = entry.data+entry.size;
891 memset(eof, 0xff, end - eof - sizeof(jffs2_eof_mark));
892 memcpy(end - sizeof(jffs2_eof_mark), jffs2_eof_mark, sizeof(jffs2_eof_mark));
900 /** Creates a new image partition from arbitrary data */
901 static struct image_partition_entry put_data(const char *part_name, const char *datain, size_t len) {
903 struct image_partition_entry entry = alloc_image_partition(part_name, len);
905 memcpy(entry.data, datain, len);
911 Copies a list of image partitions into an image buffer and generates the image partition table while doing so
913 Example image partition table:
915 fwup-ptn partition-table base 0x00800 size 0x00800
916 fwup-ptn os-image base 0x01000 size 0x113b45
917 fwup-ptn file-system base 0x114b45 size 0x1d0004
918 fwup-ptn support-list base 0x2e4b49 size 0x000d1
920 Each line of the partition table is terminated with the bytes 09 0d 0a ("\t\r\n"),
921 the end of the partition table is marked with a zero byte.
923 The firmware image must contain at least the partition-table and support-list partitions
924 to be accepted. There aren't any alignment constraints for the image partitions.
926 The partition-table partition contains the actual flash layout; partitions
927 from the image partition table are mapped to the corresponding flash partitions during
928 the firmware upgrade. The support-list partition contains a list of devices supported by
931 The base offsets in the firmware partition table are relative to the end
932 of the vendor information block, so the partition-table partition will
933 actually start at offset 0x1814 of the image.
935 I think partition-table must be the first partition in the firmware image.
937 static void put_partitions(uint8_t *buffer, const struct flash_partition_entry *flash_parts, const struct image_partition_entry *parts) {
939 char *image_pt = (char *)buffer, *end = image_pt + 0x800;
942 for (i = 0; parts[i].name; i++) {
943 for (j = 0; flash_parts[j].name; j++) {
944 if (!strcmp(flash_parts[j].name, parts[i].name)) {
945 if (parts[i].size > flash_parts[j].size)
946 error(1, 0, "%s partition too big (more than %u bytes)", flash_parts[j].name, (unsigned)flash_parts[j].size);
951 assert(flash_parts[j].name);
953 memcpy(buffer + base, parts[i].data, parts[i].size);
955 size_t len = end-image_pt;
956 size_t w = snprintf(image_pt, len, "fwup-ptn %s base 0x%05x size 0x%05x\t\r\n", parts[i].name, (unsigned)base, (unsigned)parts[i].size);
959 error(1, 0, "image partition table overflow?");
963 base += parts[i].size;
967 /** Generates and writes the image MD5 checksum */
968 static void put_md5(uint8_t *md5, uint8_t *buffer, unsigned int len) {
972 MD5_Update(&ctx, md5_salt, (unsigned int)sizeof(md5_salt));
973 MD5_Update(&ctx, buffer, len);
974 MD5_Final(md5, &ctx);
979 Generates the firmware image in factory format
985 0000-0003 Image size (4 bytes, big endian)
986 0004-0013 MD5 hash (hash of a 16 byte salt and the image data starting with byte 0x14)
987 0014-0017 Vendor information length (without padding) (4 bytes, big endian)
988 0018-1013 Vendor information (4092 bytes, padded with 0xff; there seem to be older
989 (VxWorks-based) TP-LINK devices which use a smaller vendor information block)
990 1014-1813 Image partition table (2048 bytes, padded with 0xff)
991 1814-xxxx Firmware partitions
993 static void * generate_factory_image(const struct device_info *info, const struct image_partition_entry *parts, size_t *len) {
997 for (i = 0; parts[i].name; i++)
998 *len += parts[i].size;
1000 uint8_t *image = malloc(*len);
1002 error(1, errno, "malloc");
1004 memset(image, 0xff, *len);
1008 size_t vendor_len = strlen(info->vendor);
1009 put32(image+0x14, vendor_len);
1010 memcpy(image+0x18, info->vendor, vendor_len);
1013 put_partitions(image + 0x1014, info->partitions, parts);
1014 put_md5(image+0x04, image+0x14, *len-0x14);
1020 Generates the firmware image in sysupgrade format
1022 This makes some assumptions about the provided flash and image partition tables and
1023 should be generalized when TP-LINK starts building its safeloader into hardware with
1024 different flash layouts.
1026 static void * generate_sysupgrade_image(const struct device_info *info, const struct image_partition_entry *image_parts, size_t *len) {
1028 size_t flash_first_partition_index = 0;
1029 size_t flash_last_partition_index = 0;
1030 const struct flash_partition_entry *flash_first_partition = NULL;
1031 const struct flash_partition_entry *flash_last_partition = NULL;
1032 const struct image_partition_entry *image_last_partition = NULL;
1034 /** Find first and last partitions */
1035 for (i = 0; info->partitions[i].name; i++) {
1036 if (!strcmp(info->partitions[i].name, info->first_sysupgrade_partition)) {
1037 flash_first_partition = &info->partitions[i];
1038 flash_first_partition_index = i;
1039 } else if (!strcmp(info->partitions[i].name, info->last_sysupgrade_partition)) {
1040 flash_last_partition = &info->partitions[i];
1041 flash_last_partition_index = i;
1045 assert(flash_first_partition && flash_last_partition);
1046 assert(flash_first_partition_index < flash_last_partition_index);
1048 /** Find last partition from image to calculate needed size */
1049 for (i = 0; image_parts[i].name; i++) {
1050 if (!strcmp(image_parts[i].name, info->last_sysupgrade_partition)) {
1051 image_last_partition = &image_parts[i];
1056 assert(image_last_partition);
1058 *len = flash_last_partition->base - flash_first_partition->base + image_last_partition->size;
1060 uint8_t *image = malloc(*len);
1062 error(1, errno, "malloc");
1064 memset(image, 0xff, *len);
1066 for (i = flash_first_partition_index; i <= flash_last_partition_index; i++) {
1067 for (j = 0; image_parts[j].name; j++) {
1068 if (!strcmp(info->partitions[i].name, image_parts[j].name)) {
1069 if (image_parts[j].size > info->partitions[i].size)
1070 error(1, 0, "%s partition too big (more than %u bytes)", info->partitions[i].name, (unsigned)info->partitions[i].size);
1071 memcpy(image + info->partitions[i].base - flash_first_partition->base, image_parts[j].data, image_parts[j].size);
1075 assert(image_parts[j].name);
1082 /** Generates an image according to a given layout and writes it to a file */
1083 static void build_image(const char *output,
1084 const char *kernel_image,
1085 const char *rootfs_image,
1089 const struct device_info *info) {
1091 struct image_partition_entry parts[7] = {};
1093 parts[0] = make_partition_table(info->partitions);
1095 parts[1] = make_soft_version_from_string(info->soft_ver);
1097 parts[1] = make_soft_version(rev);
1099 parts[2] = make_support_list(info);
1100 parts[3] = read_file("os-image", kernel_image, false);
1101 parts[4] = read_file("file-system", rootfs_image, add_jffs2_eof);
1103 if (strcasecmp(info->id, "ARCHER-C25-V1") == 0) {
1104 const char mdat[11] = {0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00};
1105 parts[5] = put_data("extra-para", mdat, 11);
1111 image = generate_sysupgrade_image(info, parts, &len);
1113 image = generate_factory_image(info, parts, &len);
1115 FILE *file = fopen(output, "wb");
1117 error(1, errno, "unable to open output file");
1119 if (fwrite(image, len, 1, file) != 1)
1120 error(1, 0, "unable to write output file");
1127 for (i = 0; parts[i].name; i++)
1128 free_image_partition(parts[i]);
1132 static void usage(const char *argv0) {
1134 "Usage: %s [OPTIONS...]\n"
1137 " -B <board> create image for the board specified with <board>\n"
1138 " -k <file> read kernel image from the file <file>\n"
1139 " -r <file> read rootfs image from the file <file>\n"
1140 " -o <file> write output to the file <file>\n"
1141 " -V <rev> sets the revision number to <rev>\n"
1142 " -j add jffs2 end-of-filesystem markers\n"
1143 " -S create sysupgrade instead of factory image\n"
1144 " -h show this help\n",
1150 static const struct device_info *find_board(const char *id)
1152 struct device_info *board = NULL;
1154 for (board = boards; board->id != NULL; board++)
1155 if (strcasecmp(id, board->id) == 0)
1161 int main(int argc, char *argv[]) {
1162 const char *board = NULL, *kernel_image = NULL, *rootfs_image = NULL, *output = NULL;
1163 bool add_jffs2_eof = false, sysupgrade = false;
1165 const struct device_info *info;
1166 set_source_date_epoch();
1171 c = getopt(argc, argv, "B:k:r:o:V:jSh");
1181 kernel_image = optarg;
1185 rootfs_image = optarg;
1193 sscanf(optarg, "r%u", &rev);
1197 add_jffs2_eof = true;
1215 error(1, 0, "no board has been specified");
1217 error(1, 0, "no kernel image has been specified");
1219 error(1, 0, "no rootfs image has been specified");
1221 error(1, 0, "no output filename has been specified");
1223 info = find_board(board);
1226 error(1, 0, "unsupported board %s", board);
1228 build_image(output, kernel_image, rootfs_image, rev, add_jffs2_eof, sysupgrade, info);