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>
54 #define ALIGN(x,a) ({ typeof(a) __a = (a); (((x) + __a - 1) & ~(__a - 1)); })
57 #define MAX_PARTITIONS 32
59 /** An image partition table entry */
60 struct image_partition_entry
{
66 /** A flash partition table entry */
67 struct flash_partition_entry
{
73 /** Firmware layout description */
77 const char *support_list
;
80 struct flash_partition_entry partitions
[MAX_PARTITIONS
+1];
81 const char *first_sysupgrade_partition
;
82 const char *last_sysupgrade_partition
;
85 /** The content of the soft-version structure */
86 struct __attribute__((__packed__
)) soft_version
{
90 uint8_t version_major
;
91 uint8_t version_minor
;
92 uint8_t version_patch
;
102 static const uint8_t jffs2_eof_mark
[4] = {0xde, 0xad, 0xc0, 0xde};
106 Salt for the MD5 hash
108 Fortunately, TP-LINK seems to use the same salt for most devices which use
109 the new image format.
111 static const uint8_t md5_salt
[16] = {
112 0x7a, 0x2b, 0x15, 0xed,
113 0x9b, 0x98, 0x59, 0x6d,
114 0xe5, 0x04, 0xab, 0x44,
115 0xac, 0x2a, 0x9f, 0x4e,
119 /** Firmware layout table */
120 static struct device_info boards
[] = {
121 /** Firmware layout for the CPE210/220 */
124 .vendor
= "CPE510(TP-LINK|UN|N300-5):1.0\r\n",
127 "CPE210(TP-LINK|UN|N300-2):1.0\r\n"
128 "CPE210(TP-LINK|UN|N300-2):1.1\r\n"
129 "CPE210(TP-LINK|US|N300-2):1.1\r\n"
130 "CPE210(TP-LINK|EU|N300-2):1.1\r\n"
131 "CPE220(TP-LINK|UN|N300-2):1.1\r\n"
132 "CPE220(TP-LINK|US|N300-2):1.1\r\n"
133 "CPE220(TP-LINK|EU|N300-2):1.1\r\n",
134 .support_trail
= '\xff',
138 {"fs-uboot", 0x00000, 0x20000},
139 {"partition-table", 0x20000, 0x02000},
140 {"default-mac", 0x30000, 0x00020},
141 {"product-info", 0x31100, 0x00100},
142 {"signature", 0x32000, 0x00400},
143 {"os-image", 0x40000, 0x1c0000},
144 {"file-system", 0x200000, 0x5b0000},
145 {"soft-version", 0x7b0000, 0x00100},
146 {"support-list", 0x7b1000, 0x00400},
147 {"user-config", 0x7c0000, 0x10000},
148 {"default-config", 0x7d0000, 0x10000},
149 {"log", 0x7e0000, 0x10000},
150 {"radio", 0x7f0000, 0x10000},
154 .first_sysupgrade_partition
= "os-image",
155 .last_sysupgrade_partition
= "support-list",
158 /** Firmware layout for the CPE210 V2 */
161 .vendor
= "CPE210(TP-LINK|UN|N300-2|00000000):2.0\r\n",
164 "CPE210(TP-LINK|EU|N300-2|00000000):2.0\r\n"
165 "CPE210(TP-LINK|EU|N300-2|45550000):2.0\r\n"
166 "CPE210(TP-LINK|EU|N300-2|55530000):2.0\r\n"
167 "CPE210(TP-LINK|UN|N300-2|00000000):2.0\r\n"
168 "CPE210(TP-LINK|UN|N300-2|45550000):2.0\r\n"
169 "CPE210(TP-LINK|UN|N300-2|55530000):2.0\r\n"
170 "CPE210(TP-LINK|US|N300-2|55530000):2.0\r\n"
171 "CPE210(TP-LINK|UN|N300-2):2.0\r\n"
172 "CPE210(TP-LINK|EU|N300-2):2.0\r\n"
173 "CPE210(TP-LINK|US|N300-2):2.0\r\n",
174 .support_trail
= '\xff',
178 {"fs-uboot", 0x00000, 0x20000},
179 {"partition-table", 0x20000, 0x02000},
180 {"default-mac", 0x30000, 0x00020},
181 {"product-info", 0x31100, 0x00100},
182 {"device-info", 0x31400, 0x00400},
183 {"signature", 0x32000, 0x00400},
184 {"device-id", 0x33000, 0x00100},
185 {"os-image", 0x40000, 0x1c0000},
186 {"file-system", 0x200000, 0x5b0000},
187 {"soft-version", 0x7b0000, 0x00100},
188 {"support-list", 0x7b1000, 0x01000},
189 {"user-config", 0x7c0000, 0x10000},
190 {"default-config", 0x7d0000, 0x10000},
191 {"log", 0x7e0000, 0x10000},
192 {"radio", 0x7f0000, 0x10000},
196 .first_sysupgrade_partition
= "os-image",
197 .last_sysupgrade_partition
= "support-list",
200 /** Firmware layout for the CPE510/520 */
203 .vendor
= "CPE510(TP-LINK|UN|N300-5):1.0\r\n",
206 "CPE510(TP-LINK|UN|N300-5):1.0\r\n"
207 "CPE510(TP-LINK|UN|N300-5):1.1\r\n"
208 "CPE510(TP-LINK|UN|N300-5):1.1\r\n"
209 "CPE510(TP-LINK|US|N300-5):1.1\r\n"
210 "CPE510(TP-LINK|EU|N300-5):1.1\r\n"
211 "CPE520(TP-LINK|UN|N300-5):1.1\r\n"
212 "CPE520(TP-LINK|US|N300-5):1.1\r\n"
213 "CPE520(TP-LINK|EU|N300-5):1.1\r\n",
214 .support_trail
= '\xff',
218 {"fs-uboot", 0x00000, 0x20000},
219 {"partition-table", 0x20000, 0x02000},
220 {"default-mac", 0x30000, 0x00020},
221 {"product-info", 0x31100, 0x00100},
222 {"signature", 0x32000, 0x00400},
223 {"os-image", 0x40000, 0x1c0000},
224 {"file-system", 0x200000, 0x5b0000},
225 {"soft-version", 0x7b0000, 0x00100},
226 {"support-list", 0x7b1000, 0x00400},
227 {"user-config", 0x7c0000, 0x10000},
228 {"default-config", 0x7d0000, 0x10000},
229 {"log", 0x7e0000, 0x10000},
230 {"radio", 0x7f0000, 0x10000},
234 .first_sysupgrade_partition
= "os-image",
235 .last_sysupgrade_partition
= "support-list",
240 .vendor
= "CPE510(TP-LINK|UN|N300-5):1.0\r\n",
243 "WBS210(TP-LINK|UN|N300-2):1.20\r\n"
244 "WBS210(TP-LINK|US|N300-2):1.20\r\n"
245 "WBS210(TP-LINK|EU|N300-2):1.20\r\n",
246 .support_trail
= '\xff',
250 {"fs-uboot", 0x00000, 0x20000},
251 {"partition-table", 0x20000, 0x02000},
252 {"default-mac", 0x30000, 0x00020},
253 {"product-info", 0x31100, 0x00100},
254 {"signature", 0x32000, 0x00400},
255 {"os-image", 0x40000, 0x1c0000},
256 {"file-system", 0x200000, 0x5b0000},
257 {"soft-version", 0x7b0000, 0x00100},
258 {"support-list", 0x7b1000, 0x00400},
259 {"user-config", 0x7c0000, 0x10000},
260 {"default-config", 0x7d0000, 0x10000},
261 {"log", 0x7e0000, 0x10000},
262 {"radio", 0x7f0000, 0x10000},
266 .first_sysupgrade_partition
= "os-image",
267 .last_sysupgrade_partition
= "support-list",
272 .vendor
= "CPE510(TP-LINK|UN|N300-5):1.0\r\n",
275 "WBS510(TP-LINK|UN|N300-5):1.20\r\n"
276 "WBS510(TP-LINK|US|N300-5):1.20\r\n"
277 "WBS510(TP-LINK|EU|N300-5):1.20\r\n",
278 .support_trail
= '\xff',
282 {"fs-uboot", 0x00000, 0x20000},
283 {"partition-table", 0x20000, 0x02000},
284 {"default-mac", 0x30000, 0x00020},
285 {"product-info", 0x31100, 0x00100},
286 {"signature", 0x32000, 0x00400},
287 {"os-image", 0x40000, 0x1c0000},
288 {"file-system", 0x200000, 0x5b0000},
289 {"soft-version", 0x7b0000, 0x00100},
290 {"support-list", 0x7b1000, 0x00400},
291 {"user-config", 0x7c0000, 0x10000},
292 {"default-config", 0x7d0000, 0x10000},
293 {"log", 0x7e0000, 0x10000},
294 {"radio", 0x7f0000, 0x10000},
298 .first_sysupgrade_partition
= "os-image",
299 .last_sysupgrade_partition
= "support-list",
302 /** Firmware layout for the C2600 */
308 "{product_name:Archer C2600,product_ver:1.0.0,special_id:00000000}\r\n",
309 .support_trail
= '\x00',
313 We use a bigger os-image partition than the stock images (and thus
314 smaller file-system), as our kernel doesn't fit in the stock firmware's
315 2 MB os-image since kernel 4.14.
318 {"SBL1", 0x00000, 0x20000},
319 {"MIBIB", 0x20000, 0x20000},
320 {"SBL2", 0x40000, 0x20000},
321 {"SBL3", 0x60000, 0x30000},
322 {"DDRCONFIG", 0x90000, 0x10000},
323 {"SSD", 0xa0000, 0x10000},
324 {"TZ", 0xb0000, 0x30000},
325 {"RPM", 0xe0000, 0x20000},
326 {"fs-uboot", 0x100000, 0x70000},
327 {"uboot-env", 0x170000, 0x40000},
328 {"radio", 0x1b0000, 0x40000},
329 {"os-image", 0x1f0000, 0x400000}, /* Stock: base 0x1f0000 size 0x200000 */
330 {"file-system", 0x5f0000, 0x1900000}, /* Stock: base 0x3f0000 size 0x1b00000 */
331 {"default-mac", 0x1ef0000, 0x00200},
332 {"pin", 0x1ef0200, 0x00200},
333 {"product-info", 0x1ef0400, 0x0fc00},
334 {"partition-table", 0x1f00000, 0x10000},
335 {"soft-version", 0x1f10000, 0x10000},
336 {"support-list", 0x1f20000, 0x10000},
337 {"profile", 0x1f30000, 0x10000},
338 {"default-config", 0x1f40000, 0x10000},
339 {"user-config", 0x1f50000, 0x40000},
340 {"qos-db", 0x1f90000, 0x40000},
341 {"usb-config", 0x1fd0000, 0x10000},
342 {"log", 0x1fe0000, 0x20000},
346 .first_sysupgrade_partition
= "os-image",
347 .last_sysupgrade_partition
= "file-system"
350 /** Firmware layout for the C25v1 */
352 .id
= "ARCHER-C25-V1",
355 "{product_name:ArcherC25,product_ver:1.0.0,special_id:00000000}\n"
356 "{product_name:ArcherC25,product_ver:1.0.0,special_id:55530000}\n"
357 "{product_name:ArcherC25,product_ver:1.0.0,special_id:45550000}\n",
358 .support_trail
= '\x00',
359 .soft_ver
= "soft_ver:1.0.0\n",
362 We use a bigger os-image partition than the stock images (and thus
363 smaller file-system), as our kernel doesn't fit in the stock firmware's
367 {"factory-boot", 0x00000, 0x20000},
368 {"fs-uboot", 0x20000, 0x10000},
369 {"os-image", 0x30000, 0x180000}, /* Stock: base 0x30000 size 0x100000 */
370 {"file-system", 0x1b0000, 0x620000}, /* Stock: base 0x130000 size 0x6a0000 */
371 {"user-config", 0x7d0000, 0x04000},
372 {"default-mac", 0x7e0000, 0x00100},
373 {"device-id", 0x7e0100, 0x00100},
374 {"extra-para", 0x7e0200, 0x00100},
375 {"pin", 0x7e0300, 0x00100},
376 {"support-list", 0x7e0400, 0x00400},
377 {"soft-version", 0x7e0800, 0x00400},
378 {"product-info", 0x7e0c00, 0x01400},
379 {"partition-table", 0x7e2000, 0x01000},
380 {"profile", 0x7e3000, 0x01000},
381 {"default-config", 0x7e4000, 0x04000},
382 {"merge-config", 0x7ec000, 0x02000},
383 {"qos-db", 0x7ee000, 0x02000},
384 {"radio", 0x7f0000, 0x10000},
388 .first_sysupgrade_partition
= "os-image",
389 .last_sysupgrade_partition
= "file-system",
392 /** Firmware layout for the C58v1 */
394 .id
= "ARCHER-C58-V1",
398 "{product_name:Archer C58,product_ver:1.0.0,special_id:00000000}\r\n"
399 "{product_name:Archer C58,product_ver:1.0.0,special_id:45550000}\r\n"
400 "{product_name:Archer C58,product_ver:1.0.0,special_id:55530000}\r\n",
401 .support_trail
= '\x00',
402 .soft_ver
= "soft_ver:1.0.0\n",
405 {"fs-uboot", 0x00000, 0x10000},
406 {"default-mac", 0x10000, 0x00200},
407 {"pin", 0x10200, 0x00200},
408 {"product-info", 0x10400, 0x00100},
409 {"partition-table", 0x10500, 0x00800},
410 {"soft-version", 0x11300, 0x00200},
411 {"support-list", 0x11500, 0x00100},
412 {"device-id", 0x11600, 0x00100},
413 {"profile", 0x11700, 0x03900},
414 {"default-config", 0x15000, 0x04000},
415 {"user-config", 0x19000, 0x04000},
416 {"os-image", 0x20000, 0x180000},
417 {"file-system", 0x1a0000, 0x648000},
418 {"certyficate", 0x7e8000, 0x08000},
419 {"radio", 0x7f0000, 0x10000},
423 .first_sysupgrade_partition
= "os-image",
424 .last_sysupgrade_partition
= "file-system",
427 /** Firmware layout for the C59v1 */
429 .id
= "ARCHER-C59-V1",
433 "{product_name:Archer C59,product_ver:1.0.0,special_id:00000000}\r\n"
434 "{product_name:Archer C59,product_ver:1.0.0,special_id:45550000}\r\n"
435 "{product_name:Archer C59,product_ver:1.0.0,special_id:52550000}\r\n"
436 "{product_name:Archer C59,product_ver:1.0.0,special_id:55530000}\r\n",
437 .support_trail
= '\x00',
438 .soft_ver
= "soft_ver:1.0.0\n",
441 {"fs-uboot", 0x00000, 0x10000},
442 {"default-mac", 0x10000, 0x00200},
443 {"pin", 0x10200, 0x00200},
444 {"device-id", 0x10400, 0x00100},
445 {"product-info", 0x10500, 0x0fb00},
446 {"os-image", 0x20000, 0x180000},
447 {"file-system", 0x1a0000, 0xcb0000},
448 {"partition-table", 0xe50000, 0x10000},
449 {"soft-version", 0xe60000, 0x10000},
450 {"support-list", 0xe70000, 0x10000},
451 {"profile", 0xe80000, 0x10000},
452 {"default-config", 0xe90000, 0x10000},
453 {"user-config", 0xea0000, 0x40000},
454 {"usb-config", 0xee0000, 0x10000},
455 {"certificate", 0xef0000, 0x10000},
456 {"qos-db", 0xf00000, 0x40000},
457 {"log", 0xfe0000, 0x10000},
458 {"radio", 0xff0000, 0x10000},
462 .first_sysupgrade_partition
= "os-image",
463 .last_sysupgrade_partition
= "file-system",
466 /** Firmware layout for the C60v1 */
468 .id
= "ARCHER-C60-V1",
472 "{product_name:Archer C60,product_ver:1.0.0,special_id:00000000}\r\n"
473 "{product_name:Archer C60,product_ver:1.0.0,special_id:45550000}\r\n"
474 "{product_name:Archer C60,product_ver:1.0.0,special_id:55530000}\r\n",
475 .support_trail
= '\x00',
476 .soft_ver
= "soft_ver:1.0.0\n",
479 {"fs-uboot", 0x00000, 0x10000},
480 {"default-mac", 0x10000, 0x00200},
481 {"pin", 0x10200, 0x00200},
482 {"product-info", 0x10400, 0x00100},
483 {"partition-table", 0x10500, 0x00800},
484 {"soft-version", 0x11300, 0x00200},
485 {"support-list", 0x11500, 0x00100},
486 {"device-id", 0x11600, 0x00100},
487 {"profile", 0x11700, 0x03900},
488 {"default-config", 0x15000, 0x04000},
489 {"user-config", 0x19000, 0x04000},
490 {"os-image", 0x20000, 0x180000},
491 {"file-system", 0x1a0000, 0x648000},
492 {"certyficate", 0x7e8000, 0x08000},
493 {"radio", 0x7f0000, 0x10000},
497 .first_sysupgrade_partition
= "os-image",
498 .last_sysupgrade_partition
= "file-system",
501 /** Firmware layout for the C60v2 */
503 .id
= "ARCHER-C60-V2",
507 "{product_name:Archer C60,product_ver:2.0.0,special_id:42520000}\r\n"
508 "{product_name:Archer C60,product_ver:2.0.0,special_id:45550000}\r\n"
509 "{product_name:Archer C60,product_ver:2.0.0,special_id:55530000}\r\n",
510 .support_trail
= '\x00',
511 .soft_ver
= "soft_ver:2.0.0\n",
514 {"factory-boot", 0x00000, 0x1fb00},
515 {"default-mac", 0x1fb00, 0x00200},
516 {"pin", 0x1fd00, 0x00100},
517 {"product-info", 0x1fe00, 0x00100},
518 {"device-id", 0x1ff00, 0x00100},
519 {"fs-uboot", 0x20000, 0x10000},
520 {"os-image", 0x30000, 0x180000},
521 {"file-system", 0x1b0000, 0x620000},
522 {"soft-version", 0x7d9500, 0x00100},
523 {"support-list", 0x7d9600, 0x00100},
524 {"extra-para", 0x7d9700, 0x00100},
525 {"profile", 0x7d9800, 0x03000},
526 {"default-config", 0x7dc800, 0x03000},
527 {"partition-table", 0x7df800, 0x00800},
528 {"user-config", 0x7e0000, 0x0c000},
529 {"certificate", 0x7ec000, 0x04000},
530 {"radio", 0x7f0000, 0x10000},
534 .first_sysupgrade_partition
= "os-image",
535 .last_sysupgrade_partition
= "file-system",
538 /** Firmware layout for the C5 */
540 .id
= "ARCHER-C5-V2",
544 "{product_name:ArcherC5,product_ver:2.0.0,special_id:00000000}\r\n"
545 "{product_name:ArcherC5,product_ver:2.0.0,special_id:55530000}\r\n"
546 "{product_name:ArcherC5,product_ver:2.0.0,special_id:4A500000}\r\n", /* JP version */
547 .support_trail
= '\x00',
551 {"fs-uboot", 0x00000, 0x40000},
552 {"os-image", 0x40000, 0x200000},
553 {"file-system", 0x240000, 0xc00000},
554 {"default-mac", 0xe40000, 0x00200},
555 {"pin", 0xe40200, 0x00200},
556 {"product-info", 0xe40400, 0x00200},
557 {"partition-table", 0xe50000, 0x10000},
558 {"soft-version", 0xe60000, 0x00200},
559 {"support-list", 0xe61000, 0x0f000},
560 {"profile", 0xe70000, 0x10000},
561 {"default-config", 0xe80000, 0x10000},
562 {"user-config", 0xe90000, 0x50000},
563 {"log", 0xee0000, 0x100000},
564 {"radio_bk", 0xfe0000, 0x10000},
565 {"radio", 0xff0000, 0x10000},
569 .first_sysupgrade_partition
= "os-image",
570 .last_sysupgrade_partition
= "file-system"
573 /** Firmware layout for the C7 */
575 .id
= "ARCHER-C7-V4",
578 "{product_name:Archer C7,product_ver:4.0.0,special_id:00000000}\n"
579 "{product_name:Archer C7,product_ver:4.0.0,special_id:41550000}\n"
580 "{product_name:Archer C7,product_ver:4.0.0,special_id:45550000}\n"
581 "{product_name:Archer C7,product_ver:4.0.0,special_id:4B520000}\n"
582 "{product_name:Archer C7,product_ver:4.0.0,special_id:42520000}\n"
583 "{product_name:Archer C7,product_ver:4.0.0,special_id:4A500000}\n"
584 "{product_name:Archer C7,product_ver:4.0.0,special_id:52550000}\n"
585 "{product_name:Archer C7,product_ver:4.0.0,special_id:54570000}\n"
586 "{product_name:Archer C7,product_ver:4.0.0,special_id:55530000}\n"
587 "{product_name:Archer C7,product_ver:4.0.0,special_id:43410000}\n",
588 .support_trail
= '\x00',
589 .soft_ver
= "soft_ver:1.0.0\n",
592 We use a bigger os-image partition than the stock images (and thus
593 smaller file-system), as our kernel doesn't fit in the stock firmware's
597 {"factory-boot", 0x00000, 0x20000},
598 {"fs-uboot", 0x20000, 0x20000},
599 {"os-image", 0x40000, 0x180000}, /* Stock: base 0x40000 size 0x120000 */
600 {"file-system", 0x1c0000, 0xd40000}, /* Stock: base 0x160000 size 0xda0000 */
601 {"default-mac", 0xf00000, 0x00200},
602 {"pin", 0xf00200, 0x00200},
603 {"device-id", 0xf00400, 0x00100},
604 {"product-info", 0xf00500, 0x0fb00},
605 {"soft-version", 0xf10000, 0x00100},
606 {"extra-para", 0xf11000, 0x01000},
607 {"support-list", 0xf12000, 0x0a000},
608 {"profile", 0xf1c000, 0x04000},
609 {"default-config", 0xf20000, 0x10000},
610 {"user-config", 0xf30000, 0x40000},
611 {"qos-db", 0xf70000, 0x40000},
612 {"certificate", 0xfb0000, 0x10000},
613 {"partition-table", 0xfc0000, 0x10000},
614 {"log", 0xfd0000, 0x20000},
615 {"radio", 0xff0000, 0x10000},
619 .first_sysupgrade_partition
= "os-image",
620 .last_sysupgrade_partition
= "file-system",
623 /** Firmware layout for the C7 v5*/
625 .id
= "ARCHER-C7-V5",
628 "{product_name:Archer C7,product_ver:5.0.0,special_id:00000000}\n"
629 "{product_name:Archer C7,product_ver:5.0.0,special_id:55530000}\n",
631 .support_trail
= '\x00',
632 .soft_ver
= "soft_ver:1.0.0\n",
635 We use a bigger os-image partition than the stock images (and thus
636 smaller file-system), as our kernel doesn't fit in the stock firmware's
640 {"factory-boot", 0x00000, 0x20000},
641 {"fs-uboot", 0x20000, 0x20000},
642 {"partition-table", 0x40000, 0x10000},
643 {"radio", 0x50000, 0x10000},
644 {"default-mac", 0x60000, 0x00200},
645 {"pin", 0x60200, 0x00200},
646 {"device-id", 0x60400, 0x00100},
647 {"product-info", 0x60500, 0x0fb00},
648 {"soft-version", 0x70000, 0x01000},
649 {"extra-para", 0x71000, 0x01000},
650 {"support-list", 0x72000, 0x0a000},
651 {"profile", 0x7c000, 0x04000},
652 {"user-config", 0x80000, 0x40000},
655 {"os-image", 0xc0000, 0x180000}, /* Stock: base 0xc0000 size 0x120000 */
656 {"file-system", 0x240000, 0xd80000}, /* Stock: base 0x1e0000 size 0xde0000 */
658 {"log", 0xfc0000, 0x20000},
659 {"certificate", 0xfe0000, 0x10000},
660 {"default-config", 0xff0000, 0x10000},
665 .first_sysupgrade_partition
= "os-image",
666 .last_sysupgrade_partition
= "file-system",
669 /** Firmware layout for the C9 */
675 "{product_name:ArcherC9,"
677 "special_id:00000000}\n",
678 .support_trail
= '\x00',
682 {"fs-uboot", 0x00000, 0x40000},
683 {"os-image", 0x40000, 0x200000},
684 {"file-system", 0x240000, 0xc00000},
685 {"default-mac", 0xe40000, 0x00200},
686 {"pin", 0xe40200, 0x00200},
687 {"product-info", 0xe40400, 0x00200},
688 {"partition-table", 0xe50000, 0x10000},
689 {"soft-version", 0xe60000, 0x00200},
690 {"support-list", 0xe61000, 0x0f000},
691 {"profile", 0xe70000, 0x10000},
692 {"default-config", 0xe80000, 0x10000},
693 {"user-config", 0xe90000, 0x50000},
694 {"log", 0xee0000, 0x100000},
695 {"radio_bk", 0xfe0000, 0x10000},
696 {"radio", 0xff0000, 0x10000},
700 .first_sysupgrade_partition
= "os-image",
701 .last_sysupgrade_partition
= "file-system"
704 /** Firmware layout for the EAP120 */
707 .vendor
= "EAP120(TP-LINK|UN|N300-2):1.0\r\n",
710 "EAP120(TP-LINK|UN|N300-2):1.0\r\n",
711 .support_trail
= '\xff',
715 {"fs-uboot", 0x00000, 0x20000},
716 {"partition-table", 0x20000, 0x02000},
717 {"default-mac", 0x30000, 0x00020},
718 {"support-list", 0x31000, 0x00100},
719 {"product-info", 0x31100, 0x00100},
720 {"soft-version", 0x32000, 0x00100},
721 {"os-image", 0x40000, 0x180000},
722 {"file-system", 0x1c0000, 0x600000},
723 {"user-config", 0x7c0000, 0x10000},
724 {"backup-config", 0x7d0000, 0x10000},
725 {"log", 0x7e0000, 0x10000},
726 {"radio", 0x7f0000, 0x10000},
730 .first_sysupgrade_partition
= "os-image",
731 .last_sysupgrade_partition
= "file-system"
734 /** Firmware layout for the TL-WA850RE v2 */
740 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:55530000}\n"
741 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:00000000}\n"
742 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:55534100}\n"
743 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:45550000}\n"
744 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:4B520000}\n"
745 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:42520000}\n"
746 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:4A500000}\n"
747 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:43410000}\n"
748 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:41550000}\n"
749 "{product_name:TL-WA850RE,product_ver:2.0.0,special_id:52550000}\n",
750 .support_trail
= '\x00',
754 576KB were moved from file-system to os-image
755 in comparison to the stock image
758 {"fs-uboot", 0x00000, 0x20000},
759 {"os-image", 0x20000, 0x150000},
760 {"file-system", 0x170000, 0x240000},
761 {"partition-table", 0x3b0000, 0x02000},
762 {"default-mac", 0x3c0000, 0x00020},
763 {"pin", 0x3c0100, 0x00020},
764 {"product-info", 0x3c1000, 0x01000},
765 {"soft-version", 0x3c2000, 0x00100},
766 {"support-list", 0x3c3000, 0x01000},
767 {"profile", 0x3c4000, 0x08000},
768 {"user-config", 0x3d0000, 0x10000},
769 {"default-config", 0x3e0000, 0x10000},
770 {"radio", 0x3f0000, 0x10000},
774 .first_sysupgrade_partition
= "os-image",
775 .last_sysupgrade_partition
= "file-system"
778 /** Firmware layout for the TL-WA855RE v1 */
784 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:00000000}\n"
785 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:55530000}\n"
786 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:45550000}\n"
787 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:4B520000}\n"
788 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:42520000}\n"
789 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:4A500000}\n"
790 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:43410000}\n"
791 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:41550000}\n"
792 "{product_name:TL-WA855RE,product_ver:1.0.0,special_id:52550000}\n",
793 .support_trail
= '\x00',
797 {"fs-uboot", 0x00000, 0x20000},
798 {"os-image", 0x20000, 0x150000},
799 {"file-system", 0x170000, 0x240000},
800 {"partition-table", 0x3b0000, 0x02000},
801 {"default-mac", 0x3c0000, 0x00020},
802 {"pin", 0x3c0100, 0x00020},
803 {"product-info", 0x3c1000, 0x01000},
804 {"soft-version", 0x3c2000, 0x00100},
805 {"support-list", 0x3c3000, 0x01000},
806 {"profile", 0x3c4000, 0x08000},
807 {"user-config", 0x3d0000, 0x10000},
808 {"default-config", 0x3e0000, 0x10000},
809 {"radio", 0x3f0000, 0x10000},
813 .first_sysupgrade_partition
= "os-image",
814 .last_sysupgrade_partition
= "file-system"
817 /** Firmware layout for the TL-WR1043 v5 */
823 "{product_name:TL-WR1043N,product_ver:5.0.0,special_id:45550000}\n"
824 "{product_name:TL-WR1043N,product_ver:5.0.0,special_id:55530000}\n",
825 .support_trail
= '\x00',
826 .soft_ver
= "soft_ver:1.0.0\n",
828 {"factory-boot", 0x00000, 0x20000},
829 {"fs-uboot", 0x20000, 0x20000},
830 {"os-image", 0x40000, 0x180000},
831 {"file-system", 0x1c0000, 0xd40000},
832 {"default-mac", 0xf00000, 0x00200},
833 {"pin", 0xf00200, 0x00200},
834 {"device-id", 0xf00400, 0x00100},
835 {"product-info", 0xf00500, 0x0fb00},
836 {"soft-version", 0xf10000, 0x01000},
837 {"extra-para", 0xf11000, 0x01000},
838 {"support-list", 0xf12000, 0x0a000},
839 {"profile", 0xf1c000, 0x04000},
840 {"default-config", 0xf20000, 0x10000},
841 {"user-config", 0xf30000, 0x40000},
842 {"qos-db", 0xf70000, 0x40000},
843 {"certificate", 0xfb0000, 0x10000},
844 {"partition-table", 0xfc0000, 0x10000},
845 {"log", 0xfd0000, 0x20000},
846 {"radio", 0xff0000, 0x10000},
849 .first_sysupgrade_partition
= "os-image",
850 .last_sysupgrade_partition
= "file-system"
853 /** Firmware layout for the TL-WR1043 v4 */
855 .id
= "TLWR1043NDV4",
859 "{product_name:TL-WR1043ND,product_ver:4.0.0,special_id:45550000}\n",
860 .support_trail
= '\x00',
863 /* We're using a dynamic kernel/rootfs split here */
865 {"fs-uboot", 0x00000, 0x20000},
866 {"firmware", 0x20000, 0xf30000},
867 {"default-mac", 0xf50000, 0x00200},
868 {"pin", 0xf50200, 0x00200},
869 {"product-info", 0xf50400, 0x0fc00},
870 {"soft-version", 0xf60000, 0x0b000},
871 {"support-list", 0xf6b000, 0x04000},
872 {"profile", 0xf70000, 0x04000},
873 {"default-config", 0xf74000, 0x0b000},
874 {"user-config", 0xf80000, 0x40000},
875 {"partition-table", 0xfc0000, 0x10000},
876 {"log", 0xfd0000, 0x20000},
877 {"radio", 0xff0000, 0x10000},
881 .first_sysupgrade_partition
= "os-image",
882 .last_sysupgrade_partition
= "file-system"
885 /** Firmware layout for the TL-WR902AC v1 */
887 .id
= "TL-WR902AC-V1",
891 "{product_name:TL-WR902AC,product_ver:1.0.0,special_id:45550000}\n"
892 "{product_name:TL-WR902AC,product_ver:1.0.0,special_id:55530000}\n",
893 .support_trail
= '\x00',
897 384KB were moved from file-system to os-image
898 in comparison to the stock image
901 {"fs-uboot", 0x00000, 0x20000},
902 {"os-image", 0x20000, 0x180000},
903 {"file-system", 0x1a0000, 0x5b0000},
904 {"default-mac", 0x750000, 0x00200},
905 {"pin", 0x750200, 0x00200},
906 {"product-info", 0x750400, 0x0fc00},
907 {"soft-version", 0x760000, 0x0b000},
908 {"support-list", 0x76b000, 0x04000},
909 {"profile", 0x770000, 0x04000},
910 {"default-config", 0x774000, 0x0b000},
911 {"user-config", 0x780000, 0x40000},
912 {"partition-table", 0x7c0000, 0x10000},
913 {"log", 0x7d0000, 0x20000},
914 {"radio", 0x7f0000, 0x10000},
918 .first_sysupgrade_partition
= "os-image",
919 .last_sysupgrade_partition
= "file-system",
922 /** Firmware layout for the TL-WR942N V1 */
928 "{product_name:TL-WR942N,product_ver:1.0.0,special_id:00000000}\r\n"
929 "{product_name:TL-WR942N,product_ver:1.0.0,special_id:52550000}\r\n",
930 .support_trail
= '\x00',
934 {"fs-uboot", 0x00000, 0x20000},
935 {"os-image", 0x20000, 0x180000},
936 {"file-system", 0x1a0000, 0xca0000},
937 {"default-mac", 0xe40000, 0x00200},
938 {"pin", 0xe40200, 0x00200},
939 {"product-info", 0xe40400, 0x0fc00},
940 {"partition-table", 0xe50000, 0x10000},
941 {"soft-version", 0xe60000, 0x10000},
942 {"support-list", 0xe70000, 0x10000},
943 {"profile", 0xe80000, 0x10000},
944 {"default-config", 0xe90000, 0x10000},
945 {"user-config", 0xea0000, 0x40000},
946 {"qos-db", 0xee0000, 0x40000},
947 {"certificate", 0xf20000, 0x10000},
948 {"usb-config", 0xfb0000, 0x10000},
949 {"log", 0xfc0000, 0x20000},
950 {"radio-bk", 0xfe0000, 0x10000},
951 {"radio", 0xff0000, 0x10000},
955 .first_sysupgrade_partition
= "os-image",
956 .last_sysupgrade_partition
= "file-system",
959 /** Firmware layout for the RE350 v1 */
965 "{product_name:RE350,product_ver:1.0.0,special_id:45550000}\n"
966 "{product_name:RE350,product_ver:1.0.0,special_id:00000000}\n"
967 "{product_name:RE350,product_ver:1.0.0,special_id:41550000}\n"
968 "{product_name:RE350,product_ver:1.0.0,special_id:55530000}\n"
969 "{product_name:RE350,product_ver:1.0.0,special_id:43410000}\n"
970 "{product_name:RE350,product_ver:1.0.0,special_id:4b520000}\n"
971 "{product_name:RE350,product_ver:1.0.0,special_id:4a500000}\n",
972 .support_trail
= '\x00',
975 /** We're using a dynamic kernel/rootfs split here */
977 {"fs-uboot", 0x00000, 0x20000},
978 {"firmware", 0x20000, 0x5e0000},
979 {"partition-table", 0x600000, 0x02000},
980 {"default-mac", 0x610000, 0x00020},
981 {"pin", 0x610100, 0x00020},
982 {"product-info", 0x611100, 0x01000},
983 {"soft-version", 0x620000, 0x01000},
984 {"support-list", 0x621000, 0x01000},
985 {"profile", 0x622000, 0x08000},
986 {"user-config", 0x630000, 0x10000},
987 {"default-config", 0x640000, 0x10000},
988 {"radio", 0x7f0000, 0x10000},
992 .first_sysupgrade_partition
= "os-image",
993 .last_sysupgrade_partition
= "file-system"
996 /** Firmware layout for the RE355 */
1002 "{product_name:RE355,product_ver:1.0.0,special_id:00000000}\r\n"
1003 "{product_name:RE355,product_ver:1.0.0,special_id:55530000}\r\n"
1004 "{product_name:RE355,product_ver:1.0.0,special_id:45550000}\r\n"
1005 "{product_name:RE355,product_ver:1.0.0,special_id:4A500000}\r\n"
1006 "{product_name:RE355,product_ver:1.0.0,special_id:43410000}\r\n"
1007 "{product_name:RE355,product_ver:1.0.0,special_id:41550000}\r\n"
1008 "{product_name:RE355,product_ver:1.0.0,special_id:4B520000}\r\n"
1009 "{product_name:RE355,product_ver:1.0.0,special_id:55534100}\r\n",
1010 .support_trail
= '\x00',
1014 The flash partition table for RE355;
1015 it is almost the same as the one used by the stock images,
1016 576KB were moved from file-system to os-image.
1019 {"fs-uboot", 0x00000, 0x20000},
1020 {"os-image", 0x20000, 0x180000},
1021 {"file-system", 0x1a0000, 0x460000},
1022 {"partition-table", 0x600000, 0x02000},
1023 {"default-mac", 0x610000, 0x00020},
1024 {"pin", 0x610100, 0x00020},
1025 {"product-info", 0x611100, 0x01000},
1026 {"soft-version", 0x620000, 0x01000},
1027 {"support-list", 0x621000, 0x01000},
1028 {"profile", 0x622000, 0x08000},
1029 {"user-config", 0x630000, 0x10000},
1030 {"default-config", 0x640000, 0x10000},
1031 {"radio", 0x7f0000, 0x10000},
1035 .first_sysupgrade_partition
= "os-image",
1036 .last_sysupgrade_partition
= "file-system"
1039 /** Firmware layout for the RE450 */
1045 "{product_name:RE450,product_ver:1.0.0,special_id:00000000}\r\n"
1046 "{product_name:RE450,product_ver:1.0.0,special_id:55530000}\r\n"
1047 "{product_name:RE450,product_ver:1.0.0,special_id:45550000}\r\n"
1048 "{product_name:RE450,product_ver:1.0.0,special_id:4A500000}\r\n"
1049 "{product_name:RE450,product_ver:1.0.0,special_id:43410000}\r\n"
1050 "{product_name:RE450,product_ver:1.0.0,special_id:41550000}\r\n"
1051 "{product_name:RE450,product_ver:1.0.0,special_id:4B520000}\r\n"
1052 "{product_name:RE450,product_ver:1.0.0,special_id:55534100}\r\n",
1053 .support_trail
= '\x00',
1057 The flash partition table for RE450;
1058 it is almost the same as the one used by the stock images,
1059 576KB were moved from file-system to os-image.
1062 {"fs-uboot", 0x00000, 0x20000},
1063 {"os-image", 0x20000, 0x180000},
1064 {"file-system", 0x1a0000, 0x460000},
1065 {"partition-table", 0x600000, 0x02000},
1066 {"default-mac", 0x610000, 0x00020},
1067 {"pin", 0x610100, 0x00020},
1068 {"product-info", 0x611100, 0x01000},
1069 {"soft-version", 0x620000, 0x01000},
1070 {"support-list", 0x621000, 0x01000},
1071 {"profile", 0x622000, 0x08000},
1072 {"user-config", 0x630000, 0x10000},
1073 {"default-config", 0x640000, 0x10000},
1074 {"radio", 0x7f0000, 0x10000},
1078 .first_sysupgrade_partition
= "os-image",
1079 .last_sysupgrade_partition
= "file-system"
1085 #define error(_ret, _errno, _str, ...) \
1087 fprintf(stderr, _str ": %s\n", ## __VA_ARGS__, \
1088 strerror(_errno)); \
1094 /** Stores a uint32 as big endian */
1095 static inline void put32(uint8_t *buf
, uint32_t val
) {
1102 /** Allocates a new image partition */
1103 static struct image_partition_entry
alloc_image_partition(const char *name
, size_t len
) {
1104 struct image_partition_entry entry
= {name
, len
, malloc(len
)};
1106 error(1, errno
, "malloc");
1111 /** Frees an image partition */
1112 static void free_image_partition(struct image_partition_entry entry
) {
1116 static time_t source_date_epoch
= -1;
1117 static void set_source_date_epoch() {
1118 char *env
= getenv("SOURCE_DATE_EPOCH");
1122 source_date_epoch
= strtoull(env
, &endptr
, 10);
1123 if (errno
|| (endptr
&& *endptr
!= '\0')) {
1124 fprintf(stderr
, "Invalid SOURCE_DATE_EPOCH");
1130 /** Generates the partition-table partition */
1131 static struct image_partition_entry
make_partition_table(const struct flash_partition_entry
*p
) {
1132 struct image_partition_entry entry
= alloc_image_partition("partition-table", 0x800);
1134 char *s
= (char *)entry
.data
, *end
= (char *)(s
+entry
.size
);
1142 for (i
= 0; p
[i
].name
; i
++) {
1144 size_t w
= snprintf(s
, len
, "partition %s base 0x%05x size 0x%05x\n", p
[i
].name
, p
[i
].base
, p
[i
].size
);
1147 error(1, 0, "flash partition table overflow?");
1154 memset(s
, 0xff, end
-s
);
1160 /** Generates a binary-coded decimal representation of an integer in the range [0, 99] */
1161 static inline uint8_t bcd(uint8_t v
) {
1162 return 0x10 * (v
/10) + v
%10;
1166 /** Generates the soft-version partition */
1167 static struct image_partition_entry
make_soft_version(uint32_t rev
) {
1168 struct image_partition_entry entry
= alloc_image_partition("soft-version", sizeof(struct soft_version
));
1169 struct soft_version
*s
= (struct soft_version
*)entry
.data
;
1173 if (source_date_epoch
!= -1)
1174 t
= source_date_epoch
;
1175 else if (time(&t
) == (time_t)(-1))
1176 error(1, errno
, "time");
1178 struct tm
*tm
= localtime(&t
);
1180 s
->magic
= htonl(0x0000000c);
1184 s
->version_major
= 0;
1185 s
->version_minor
= 0;
1186 s
->version_patch
= 0;
1188 s
->year_hi
= bcd((1900+tm
->tm_year
)/100);
1189 s
->year_lo
= bcd(tm
->tm_year
%100);
1190 s
->month
= bcd(tm
->tm_mon
+1);
1191 s
->day
= bcd(tm
->tm_mday
);
1192 s
->rev
= htonl(rev
);
1199 static struct image_partition_entry
make_soft_version_from_string(const char *soft_ver
) {
1200 /** String length _including_ the terminating zero byte */
1201 uint32_t ver_len
= strlen(soft_ver
) + 1;
1202 /** Partition contains 64 bit header, the version string, and one additional null byte */
1203 size_t partition_len
= 2*sizeof(uint32_t) + ver_len
+ 1;
1204 struct image_partition_entry entry
= alloc_image_partition("soft-version", partition_len
);
1206 uint32_t *len
= (uint32_t *)entry
.data
;
1207 len
[0] = htonl(ver_len
);
1209 memcpy(&len
[2], soft_ver
, ver_len
);
1211 entry
.data
[partition_len
- 1] = 0;
1216 /** Generates the support-list partition */
1217 static struct image_partition_entry
make_support_list(struct device_info
*info
) {
1218 size_t len
= strlen(info
->support_list
);
1219 struct image_partition_entry entry
= alloc_image_partition("support-list", len
+ 9);
1221 put32(entry
.data
, len
);
1222 memset(entry
.data
+4, 0, 4);
1223 memcpy(entry
.data
+8, info
->support_list
, len
);
1224 entry
.data
[len
+8] = info
->support_trail
;
1229 /** Creates a new image partition with an arbitrary name from a file */
1230 static struct image_partition_entry
read_file(const char *part_name
, const char *filename
, bool add_jffs2_eof
, struct flash_partition_entry
*file_system_partition
) {
1231 struct stat statbuf
;
1233 if (stat(filename
, &statbuf
) < 0)
1234 error(1, errno
, "unable to stat file `%s'", filename
);
1236 size_t len
= statbuf
.st_size
;
1239 if (file_system_partition
)
1240 len
= ALIGN(len
+ file_system_partition
->base
, 0x10000) + sizeof(jffs2_eof_mark
) - file_system_partition
->base
;
1242 len
= ALIGN(len
, 0x10000) + sizeof(jffs2_eof_mark
);
1244 struct image_partition_entry entry
= alloc_image_partition(part_name
, len
);
1246 FILE *file
= fopen(filename
, "rb");
1248 error(1, errno
, "unable to open file `%s'", filename
);
1250 if (fread(entry
.data
, statbuf
.st_size
, 1, file
) != 1)
1251 error(1, errno
, "unable to read file `%s'", filename
);
1253 if (add_jffs2_eof
) {
1254 uint8_t *eof
= entry
.data
+ statbuf
.st_size
, *end
= entry
.data
+entry
.size
;
1256 memset(eof
, 0xff, end
- eof
- sizeof(jffs2_eof_mark
));
1257 memcpy(end
- sizeof(jffs2_eof_mark
), jffs2_eof_mark
, sizeof(jffs2_eof_mark
));
1265 /** Creates a new image partition from arbitrary data */
1266 static struct image_partition_entry
put_data(const char *part_name
, const char *datain
, size_t len
) {
1268 struct image_partition_entry entry
= alloc_image_partition(part_name
, len
);
1270 memcpy(entry
.data
, datain
, len
);
1276 Copies a list of image partitions into an image buffer and generates the image partition table while doing so
1278 Example image partition table:
1280 fwup-ptn partition-table base 0x00800 size 0x00800
1281 fwup-ptn os-image base 0x01000 size 0x113b45
1282 fwup-ptn file-system base 0x114b45 size 0x1d0004
1283 fwup-ptn support-list base 0x2e4b49 size 0x000d1
1285 Each line of the partition table is terminated with the bytes 09 0d 0a ("\t\r\n"),
1286 the end of the partition table is marked with a zero byte.
1288 The firmware image must contain at least the partition-table and support-list partitions
1289 to be accepted. There aren't any alignment constraints for the image partitions.
1291 The partition-table partition contains the actual flash layout; partitions
1292 from the image partition table are mapped to the corresponding flash partitions during
1293 the firmware upgrade. The support-list partition contains a list of devices supported by
1296 The base offsets in the firmware partition table are relative to the end
1297 of the vendor information block, so the partition-table partition will
1298 actually start at offset 0x1814 of the image.
1300 I think partition-table must be the first partition in the firmware image.
1302 static void put_partitions(uint8_t *buffer
, const struct flash_partition_entry
*flash_parts
, const struct image_partition_entry
*parts
) {
1304 char *image_pt
= (char *)buffer
, *end
= image_pt
+ 0x800;
1306 size_t base
= 0x800;
1307 for (i
= 0; parts
[i
].name
; i
++) {
1308 for (j
= 0; flash_parts
[j
].name
; j
++) {
1309 if (!strcmp(flash_parts
[j
].name
, parts
[i
].name
)) {
1310 if (parts
[i
].size
> flash_parts
[j
].size
)
1311 error(1, 0, "%s partition too big (more than %u bytes)", flash_parts
[j
].name
, (unsigned)flash_parts
[j
].size
);
1316 assert(flash_parts
[j
].name
);
1318 memcpy(buffer
+ base
, parts
[i
].data
, parts
[i
].size
);
1320 size_t len
= end
-image_pt
;
1321 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
);
1324 error(1, 0, "image partition table overflow?");
1328 base
+= parts
[i
].size
;
1332 /** Generates and writes the image MD5 checksum */
1333 static void put_md5(uint8_t *md5
, uint8_t *buffer
, unsigned int len
) {
1337 MD5_Update(&ctx
, md5_salt
, (unsigned int)sizeof(md5_salt
));
1338 MD5_Update(&ctx
, buffer
, len
);
1339 MD5_Final(md5
, &ctx
);
1344 Generates the firmware image in factory format
1350 0000-0003 Image size (4 bytes, big endian)
1351 0004-0013 MD5 hash (hash of a 16 byte salt and the image data starting with byte 0x14)
1352 0014-0017 Vendor information length (without padding) (4 bytes, big endian)
1353 0018-1013 Vendor information (4092 bytes, padded with 0xff; there seem to be older
1354 (VxWorks-based) TP-LINK devices which use a smaller vendor information block)
1355 1014-1813 Image partition table (2048 bytes, padded with 0xff)
1356 1814-xxxx Firmware partitions
1358 static void * generate_factory_image(struct device_info
*info
, const struct image_partition_entry
*parts
, size_t *len
) {
1362 for (i
= 0; parts
[i
].name
; i
++)
1363 *len
+= parts
[i
].size
;
1365 uint8_t *image
= malloc(*len
);
1367 error(1, errno
, "malloc");
1369 memset(image
, 0xff, *len
);
1373 size_t vendor_len
= strlen(info
->vendor
);
1374 put32(image
+0x14, vendor_len
);
1375 memcpy(image
+0x18, info
->vendor
, vendor_len
);
1378 put_partitions(image
+ 0x1014, info
->partitions
, parts
);
1379 put_md5(image
+0x04, image
+0x14, *len
-0x14);
1385 Generates the firmware image in sysupgrade format
1387 This makes some assumptions about the provided flash and image partition tables and
1388 should be generalized when TP-LINK starts building its safeloader into hardware with
1389 different flash layouts.
1391 static void * generate_sysupgrade_image(struct device_info
*info
, const struct image_partition_entry
*image_parts
, size_t *len
) {
1393 size_t flash_first_partition_index
= 0;
1394 size_t flash_last_partition_index
= 0;
1395 const struct flash_partition_entry
*flash_first_partition
= NULL
;
1396 const struct flash_partition_entry
*flash_last_partition
= NULL
;
1397 const struct image_partition_entry
*image_last_partition
= NULL
;
1399 /** Find first and last partitions */
1400 for (i
= 0; info
->partitions
[i
].name
; i
++) {
1401 if (!strcmp(info
->partitions
[i
].name
, info
->first_sysupgrade_partition
)) {
1402 flash_first_partition
= &info
->partitions
[i
];
1403 flash_first_partition_index
= i
;
1404 } else if (!strcmp(info
->partitions
[i
].name
, info
->last_sysupgrade_partition
)) {
1405 flash_last_partition
= &info
->partitions
[i
];
1406 flash_last_partition_index
= i
;
1410 assert(flash_first_partition
&& flash_last_partition
);
1411 assert(flash_first_partition_index
< flash_last_partition_index
);
1413 /** Find last partition from image to calculate needed size */
1414 for (i
= 0; image_parts
[i
].name
; i
++) {
1415 if (!strcmp(image_parts
[i
].name
, info
->last_sysupgrade_partition
)) {
1416 image_last_partition
= &image_parts
[i
];
1421 assert(image_last_partition
);
1423 *len
= flash_last_partition
->base
- flash_first_partition
->base
+ image_last_partition
->size
;
1425 uint8_t *image
= malloc(*len
);
1427 error(1, errno
, "malloc");
1429 memset(image
, 0xff, *len
);
1431 for (i
= flash_first_partition_index
; i
<= flash_last_partition_index
; i
++) {
1432 for (j
= 0; image_parts
[j
].name
; j
++) {
1433 if (!strcmp(info
->partitions
[i
].name
, image_parts
[j
].name
)) {
1434 if (image_parts
[j
].size
> info
->partitions
[i
].size
)
1435 error(1, 0, "%s partition too big (more than %u bytes)", info
->partitions
[i
].name
, (unsigned)info
->partitions
[i
].size
);
1436 memcpy(image
+ info
->partitions
[i
].base
- flash_first_partition
->base
, image_parts
[j
].data
, image_parts
[j
].size
);
1440 assert(image_parts
[j
].name
);
1447 /** Generates an image according to a given layout and writes it to a file */
1448 static void build_image(const char *output
,
1449 const char *kernel_image
,
1450 const char *rootfs_image
,
1454 struct device_info
*info
) {
1458 struct image_partition_entry parts
[7] = {};
1460 struct flash_partition_entry
*firmware_partition
= NULL
;
1461 struct flash_partition_entry
*os_image_partition
= NULL
;
1462 struct flash_partition_entry
*file_system_partition
= NULL
;
1463 size_t firmware_partition_index
= 0;
1465 for (i
= 0; info
->partitions
[i
].name
; i
++) {
1466 if (!strcmp(info
->partitions
[i
].name
, "firmware"))
1468 firmware_partition
= &info
->partitions
[i
];
1469 firmware_partition_index
= i
;
1473 if (firmware_partition
)
1475 os_image_partition
= &info
->partitions
[firmware_partition_index
];
1476 file_system_partition
= &info
->partitions
[firmware_partition_index
+ 1];
1479 if (stat(kernel_image
, &kernel
) < 0)
1480 error(1, errno
, "unable to stat file `%s'", kernel_image
);
1482 if (kernel
.st_size
> firmware_partition
->size
)
1483 error(1, 0, "kernel overflowed firmware partition\n");
1485 for (i
= MAX_PARTITIONS
-1; i
>= firmware_partition_index
+ 1; i
--)
1486 info
->partitions
[i
+1] = info
->partitions
[i
];
1488 file_system_partition
->name
= "file-system";
1489 file_system_partition
->base
= firmware_partition
->base
+ kernel
.st_size
;
1491 /* Align partition start to erase blocks for factory images only */
1493 file_system_partition
->base
= ALIGN(firmware_partition
->base
+ kernel
.st_size
, 0x10000);
1495 file_system_partition
->size
= firmware_partition
->size
- file_system_partition
->base
;
1497 os_image_partition
->name
= "os-image";
1498 os_image_partition
->size
= kernel
.st_size
;
1501 parts
[0] = make_partition_table(info
->partitions
);
1503 parts
[1] = make_soft_version_from_string(info
->soft_ver
);
1505 parts
[1] = make_soft_version(rev
);
1507 parts
[2] = make_support_list(info
);
1508 parts
[3] = read_file("os-image", kernel_image
, false, NULL
);
1509 parts
[4] = read_file("file-system", rootfs_image
, add_jffs2_eof
, file_system_partition
);
1511 /* Some devices need the extra-para partition to accept the firmware */
1512 if (strcasecmp(info
->id
, "ARCHER-C25-V1") == 0 ||
1513 strcasecmp(info
->id
, "ARCHER-C60-V2") == 0 ||
1514 strcasecmp(info
->id
, "TLWR1043NV5") == 0) {
1515 const char mdat
[11] = {0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00};
1516 parts
[5] = put_data("extra-para", mdat
, 11);
1517 } else if (strcasecmp(info
->id
, "ARCHER-C7-V4") == 0 || strcasecmp(info
->id
, "ARCHER-C7-V5") == 0) {
1518 const char mdat
[11] = {0x01, 0x00, 0x00, 0x02, 0x00, 0x00, 0xca, 0x00, 0x01, 0x00, 0x00};
1519 parts
[5] = put_data("extra-para", mdat
, 11);
1525 image
= generate_sysupgrade_image(info
, parts
, &len
);
1527 image
= generate_factory_image(info
, parts
, &len
);
1529 FILE *file
= fopen(output
, "wb");
1531 error(1, errno
, "unable to open output file");
1533 if (fwrite(image
, len
, 1, file
) != 1)
1534 error(1, 0, "unable to write output file");
1540 for (i
= 0; parts
[i
].name
; i
++)
1541 free_image_partition(parts
[i
]);
1545 static void usage(const char *argv0
) {
1547 "Usage: %s [OPTIONS...]\n"
1550 " -h show this help\n"
1552 "Create a new image:\n"
1553 " -B <board> create image for the board specified with <board>\n"
1554 " -k <file> read kernel image from the file <file>\n"
1555 " -r <file> read rootfs image from the file <file>\n"
1556 " -o <file> write output to the file <file>\n"
1557 " -V <rev> sets the revision number to <rev>\n"
1558 " -j add jffs2 end-of-filesystem markers\n"
1559 " -S create sysupgrade instead of factory image\n"
1560 "Extract an old image:\n"
1561 " -x <file> extract all oem firmware partition\n"
1562 " -d <dir> destination to extract the firmware partition\n"
1563 " -z <file> convert an oem firmware into a sysupgade file. Use -o for output file\n",
1569 static struct device_info
*find_board(const char *id
)
1571 struct device_info
*board
= NULL
;
1573 for (board
= boards
; board
->id
!= NULL
; board
++)
1574 if (strcasecmp(id
, board
->id
) == 0)
1580 static int add_flash_partition(
1581 struct flash_partition_entry
*part_list
,
1588 /* check if the list has a free entry */
1589 for (ptr
= 0; ptr
< max_entries
; ptr
++, part_list
++) {
1590 if (part_list
->name
== NULL
&&
1591 part_list
->base
== 0 &&
1592 part_list
->size
== 0)
1596 if (ptr
== max_entries
) {
1597 error(1, 0, "No free flash part entry available.");
1600 part_list
->name
= calloc(1, strlen(name
) + 1);
1601 memcpy((char *)part_list
->name
, name
, strlen(name
));
1602 part_list
->base
= base
;
1603 part_list
->size
= size
;
1608 /** read the partition table into struct flash_partition_entry */
1609 static int read_partition_table(
1610 FILE *file
, long offset
,
1611 struct flash_partition_entry
*entries
, size_t max_entries
,
1616 const char *parthdr
= NULL
;
1617 const char *fwuphdr
= "fwup-ptn";
1618 const char *flashhdr
= "partition";
1620 /* TODO: search for the partition table */
1630 error(1, 0, "Invalid partition table");
1633 if (fseek(file
, offset
, SEEK_SET
) < 0)
1634 error(1, errno
, "Can not seek in the firmware");
1636 if (fread(buf
, 1, 2048, file
) < 0)
1637 error(1, errno
, "Can not read fwup-ptn from the firmware");
1641 /* look for the partition header */
1642 if (memcmp(buf
, parthdr
, strlen(parthdr
)) != 0) {
1643 fprintf(stderr
, "DEBUG: can not find fwuphdr\n");
1648 end
= buf
+ sizeof(buf
);
1649 while ((ptr
+ strlen(parthdr
)) < end
&&
1650 memcmp(ptr
, parthdr
, strlen(parthdr
)) == 0) {
1654 char name
[32] = { 0 };
1656 unsigned long base
= 0;
1657 unsigned long size
= 0;
1659 end_part
= memchr(ptr
, '\n', (end
- ptr
));
1660 if (end_part
== NULL
) {
1661 /* in theory this should never happen, because a partition always ends with 0x09, 0x0D, 0x0A */
1665 for (int i
= 0; i
<= 4; i
++) {
1666 if (end_part
<= ptr
)
1669 end_element
= memchr(ptr
, 0x20, (end_part
- ptr
));
1670 if (end_element
== NULL
) {
1671 error(1, errno
, "Ignoring the rest of the partition entries.");
1676 /* partition header */
1678 ptr
= end_element
+ 1;
1682 name_len
= (end_element
- ptr
) > 31 ? 31 : (end_element
- ptr
);
1683 strncpy(name
, ptr
, name_len
);
1684 name
[name_len
] = '\0';
1685 ptr
= end_element
+ 1;
1690 ptr
= end_element
+ 1;
1695 base
= strtoul(ptr
, NULL
, 16);
1696 ptr
= end_element
+ 1;
1701 ptr
= end_element
+ 1;
1702 /* actual size. The last element doesn't have a sepeartor */
1703 size
= strtoul(ptr
, NULL
, 16);
1704 /* the part ends with 0x09, 0x0d, 0x0a */
1706 add_flash_partition(entries
, max_entries
, name
, base
, size
);
1715 static void write_partition(
1717 size_t firmware_offset
,
1718 struct flash_partition_entry
*entry
,
1724 fseek(input_file
, entry
->base
+ firmware_offset
, SEEK_SET
);
1726 for (offset
= 0; sizeof(buf
) + offset
<= entry
->size
; offset
+= sizeof(buf
)) {
1727 if (fread(buf
, sizeof(buf
), 1, input_file
) < 0)
1728 error(1, errno
, "Can not read partition from input_file");
1730 if (fwrite(buf
, sizeof(buf
), 1, output_file
) < 0)
1731 error(1, errno
, "Can not write partition to output_file");
1733 /* write last chunk smaller than buffer */
1734 if (offset
< entry
->size
) {
1735 offset
= entry
->size
- offset
;
1736 if (fread(buf
, offset
, 1, input_file
) < 0)
1737 error(1, errno
, "Can not read partition from input_file");
1738 if (fwrite(buf
, offset
, 1, output_file
) < 0)
1739 error(1, errno
, "Can not write partition to output_file");
1743 static int extract_firmware_partition(FILE *input_file
, size_t firmware_offset
, struct flash_partition_entry
*entry
, const char *output_directory
)
1746 char output
[PATH_MAX
];
1748 snprintf(output
, PATH_MAX
, "%s/%s", output_directory
, entry
->name
);
1749 output_file
= fopen(output
, "wb+");
1750 if (output_file
== NULL
) {
1751 error(1, errno
, "Can not open output file %s", output
);
1754 write_partition(input_file
, firmware_offset
, entry
, output_file
);
1756 fclose(output_file
);
1761 /** extract all partitions from the firmware file */
1762 static int extract_firmware(const char *input
, const char *output_directory
)
1764 struct flash_partition_entry entries
[16] = { 0 };
1765 size_t max_entries
= 16;
1766 size_t firmware_offset
= 0x1014;
1769 struct stat statbuf
;
1771 /* check input file */
1772 if (stat(input
, &statbuf
)) {
1773 error(1, errno
, "Can not read input firmware %s", input
);
1776 /* check if output directory exists */
1777 if (stat(output_directory
, &statbuf
)) {
1778 error(1, errno
, "Failed to stat output directory %s", output_directory
);
1781 if ((statbuf
.st_mode
& S_IFMT
) != S_IFDIR
) {
1782 error(1, errno
, "Given output directory is not a directory %s", output_directory
);
1785 input_file
= fopen(input
, "rb");
1787 if (read_partition_table(input_file
, firmware_offset
, entries
, 16, 0) != 0) {
1788 error(1, 0, "Error can not read the partition table (fwup-ptn)");
1791 for (int i
= 0; i
< max_entries
; i
++) {
1792 if (entries
[i
].name
== NULL
&&
1793 entries
[i
].base
== 0 &&
1794 entries
[i
].size
== 0)
1797 extract_firmware_partition(input_file
, firmware_offset
, &entries
[i
], output_directory
);
1803 static struct flash_partition_entry
*find_partition(
1804 struct flash_partition_entry
*entries
, size_t max_entries
,
1805 const char *name
, const char *error_msg
)
1807 for (int i
= 0; i
< max_entries
; i
++, entries
++) {
1808 if (strcmp(entries
->name
, name
) == 0)
1812 error(1, 0, "%s", error_msg
);
1816 static void write_ff(FILE *output_file
, size_t size
)
1821 memset(buf
, 0xff, sizeof(buf
));
1823 for (offset
= 0; offset
+ sizeof(buf
) < size
; offset
+= sizeof(buf
)) {
1824 if (fwrite(buf
, sizeof(buf
), 1, output_file
) < 0)
1825 error(1, errno
, "Can not write 0xff to output_file");
1828 /* write last chunk smaller than buffer */
1829 if (offset
< size
) {
1830 offset
= size
- offset
;
1831 if (fwrite(buf
, offset
, 1, output_file
) < 0)
1832 error(1, errno
, "Can not write partition to output_file");
1836 static void convert_firmware(const char *input
, const char *output
)
1838 struct flash_partition_entry fwup
[MAX_PARTITIONS
] = { 0 };
1839 struct flash_partition_entry flash
[MAX_PARTITIONS
] = { 0 };
1840 struct flash_partition_entry
*fwup_os_image
= NULL
, *fwup_file_system
= NULL
;
1841 struct flash_partition_entry
*flash_os_image
= NULL
, *flash_file_system
= NULL
;
1842 struct flash_partition_entry
*fwup_partition_table
= NULL
;
1843 size_t firmware_offset
= 0x1014;
1844 FILE *input_file
, *output_file
;
1846 struct stat statbuf
;
1848 /* check input file */
1849 if (stat(input
, &statbuf
)) {
1850 error(1, errno
, "Can not read input firmware %s", input
);
1853 input_file
= fopen(input
, "rb");
1855 error(1, 0, "Can not open input firmware %s", input
);
1857 output_file
= fopen(output
, "wb");
1859 error(1, 0, "Can not open output firmware %s", output
);
1861 if (read_partition_table(input_file
, firmware_offset
, fwup
, MAX_PARTITIONS
, 0) != 0) {
1862 error(1, 0, "Error can not read the partition table (fwup-ptn)");
1865 fwup_os_image
= find_partition(fwup
, MAX_PARTITIONS
,
1866 "os-image", "Error can not find os-image partition (fwup)");
1867 fwup_file_system
= find_partition(fwup
, MAX_PARTITIONS
,
1868 "file-system", "Error can not find file-system partition (fwup)");
1869 fwup_partition_table
= find_partition(fwup
, MAX_PARTITIONS
,
1870 "partition-table", "Error can not find partition-table partition");
1872 /* the flash partition table has a 0x00000004 magic haeder */
1873 if (read_partition_table(input_file
, firmware_offset
+ fwup_partition_table
->base
+ 4, flash
, MAX_PARTITIONS
, 1) != 0)
1874 error(1, 0, "Error can not read the partition table (flash)");
1876 flash_os_image
= find_partition(flash
, MAX_PARTITIONS
,
1877 "os-image", "Error can not find os-image partition (flash)");
1878 flash_file_system
= find_partition(flash
, MAX_PARTITIONS
,
1879 "file-system", "Error can not find file-system partition (flash)");
1881 /* write os_image to 0x0 */
1882 write_partition(input_file
, firmware_offset
, fwup_os_image
, output_file
);
1883 write_ff(output_file
, flash_os_image
->size
- fwup_os_image
->size
);
1885 /* write file-system behind os_image */
1886 fseek(output_file
, flash_file_system
->base
- flash_os_image
->base
, SEEK_SET
);
1887 write_partition(input_file
, firmware_offset
, fwup_file_system
, output_file
);
1888 write_ff(output_file
, flash_file_system
->size
- fwup_file_system
->size
);
1890 fclose(output_file
);
1894 int main(int argc
, char *argv
[]) {
1895 const char *board
= NULL
, *kernel_image
= NULL
, *rootfs_image
= NULL
, *output
= NULL
;
1896 const char *extract_image
= NULL
, *output_directory
= NULL
, *convert_image
= NULL
;
1897 bool add_jffs2_eof
= false, sysupgrade
= false;
1899 struct device_info
*info
;
1900 set_source_date_epoch();
1905 c
= getopt(argc
, argv
, "B:k:r:o:V:jSh:x:d:z:");
1915 kernel_image
= optarg
;
1919 rootfs_image
= optarg
;
1927 sscanf(optarg
, "r%u", &rev
);
1931 add_jffs2_eof
= true;
1943 output_directory
= optarg
;
1947 extract_image
= optarg
;
1951 convert_image
= optarg
;
1960 if (extract_image
|| output_directory
) {
1962 error(1, 0, "No factory/oem image given via -x <file>. Output directory is only valid with -x");
1963 if (!output_directory
)
1964 error(1, 0, "Can not extract an image without output directory. Use -d <dir>");
1965 extract_firmware(extract_image
, output_directory
);
1966 } else if (convert_image
) {
1968 error(1, 0, "Can not convert a factory/oem image into sysupgrade image without output file. Use -o <file>");
1969 convert_firmware(convert_image
, output
);
1972 error(1, 0, "no board has been specified");
1974 error(1, 0, "no kernel image has been specified");
1976 error(1, 0, "no rootfs image has been specified");
1978 error(1, 0, "no output filename has been specified");
1980 info
= find_board(board
);
1983 error(1, 0, "unsupported board %s", board
);
1985 build_image(output
, kernel_image
, rootfs_image
, rev
, add_jffs2_eof
, sysupgrade
, info
);