projects / openwrt / openwrt.git / blob
? search:


591ce44a7883f9fc83565e13f5e98853759aa1e4
[openwrt/openwrt.git] / tools / firmware-utils / src / mkfwimage.c
1 /*
2 * Copyright (C) 2007 Ubiquiti Networks, Inc.
3 * Copyright (C) 2008 Lukas Kuna <ValXdater@seznam.cz>
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation; either version 2 of the
8 * License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 #include <sys/types.h>
21 #include <sys/stat.h>
22 #include <inttypes.h>
23 #include <fcntl.h>
24 #include <unistd.h>
25 #include <string.h>
26 #include <errno.h>
27 #include <zlib.h>
28 #include <sys/mman.h>
29 #include <netinet/in.h>
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <limits.h>
33 #include <stdbool.h>
34 #include "fw.h"
35 #include "utils.h"
36
37 typedef struct fw_layout_data {
38 u_int32_t kern_start;
39 u_int32_t kern_entry;
40 u_int32_t firmware_max_length;
41 } fw_layout_t;
42
43 struct fw_info {
44 char name[PATH_MAX];
45 struct fw_layout_data fw_layout;
46 bool sign;
47 };
48
49 struct fw_info fw_info[] = {
50 {
51 .name = "XS2",
52 .fw_layout = {
53 .kern_start = 0xbfc30000,
54 .kern_entry = 0x80041000,
55 .firmware_max_length= 0x00390000,
56 },
57 .sign = false,
58 },
59 {
60 .name = "XS5",
61 .fw_layout = {
62 .kern_start = 0xbe030000,
63 .kern_entry = 0x80041000,
64 .firmware_max_length= 0x00390000,
65 },
66 .sign = false,
67 },
68 {
69 .name = "RS",
70 .fw_layout = {
71 .kern_start = 0xbf030000,
72 .kern_entry = 0x80060000,
73 .firmware_max_length= 0x00B00000,
74 },
75 .sign = false,
76 },
77 {
78 .name = "RSPRO",
79 .fw_layout = {
80 .kern_start = 0xbf030000,
81 .kern_entry = 0x80060000,
82 .firmware_max_length= 0x00F00000,
83 },
84 .sign = false,
85 },
86 {
87 .name = "LS-SR71",
88 .fw_layout = {
89 .kern_start = 0xbf030000,
90 .kern_entry = 0x80060000,
91 .firmware_max_length= 0x00640000,
92 },
93 .sign = false,
94 },
95 {
96 .name = "XS2-8",
97 .fw_layout = {
98 .kern_start = 0xa8030000,
99 .kern_entry = 0x80041000,
100 .firmware_max_length= 0x006C0000,
101 },
102 .sign = false,
103
104 },
105 {
106 .name = "XM",
107 .fw_layout = {
108 .kern_start = 0x9f050000,
109 .kern_entry = 0x80002000,
110 .firmware_max_length= 0x00760000,
111 },
112 .sign = false,
113 },
114 {
115 .name = "SW",
116 .fw_layout = {
117 .kern_start = 0x9f050000,
118 .kern_entry = 0x80002000,
119 .firmware_max_length= 0x00760000,
120 },
121 .sign = false,
122 },
123 {
124 .name = "UBDEV01",
125 .fw_layout = {
126 .kern_start = 0x9f050000,
127 .kern_entry = 0x80002000,
128 .firmware_max_length= 0x006A0000,
129 },
130 .sign = false,
131 },
132 {
133 .name = "WA",
134 .fw_layout = {
135 .kern_start = 0x9f050000,
136 .kern_entry = 0x80002000,
137 .firmware_max_length= 0x00F60000,
138 },
139 .sign = true,
140 },
141 {
142 .name = "XC",
143 .fw_layout = {
144 .kern_start = 0x9f050000,
145 .kern_entry = 0x80002000,
146 .firmware_max_length= 0x00F60000,
147 },
148 .sign = true,
149 },
150 {
151 .name = "ACB-ISP",
152 .fw_layout = {
153 .kern_start = 0x9f050000,
154 .kern_entry = 0x80002000,
155 .firmware_max_length= 0x00F60000,
156 },
157 .sign = true,
158 },
159 {
160 .name = "",
161 },
162 };
163
164 typedef struct part_data {
165 char partition_name[64];
166 int partition_index;
167 u_int32_t partition_baseaddr;
168 u_int32_t partition_startaddr;
169 u_int32_t partition_memaddr;
170 u_int32_t partition_entryaddr;
171 u_int32_t partition_length;
172
173 char filename[PATH_MAX];
174 struct stat stats;
175 } part_data_t;
176
177 #define MAX_SECTIONS 8
178 #define DEFAULT_OUTPUT_FILE "firmware-image.bin"
179 #define DEFAULT_VERSION "UNKNOWN"
180
181 #define OPTIONS "B:hv:m:o:r:k:"
182
183 typedef struct image_info {
184 char magic[16];
185 char version[256];
186 char outputfile[PATH_MAX];
187 u_int32_t part_count;
188 part_data_t parts[MAX_SECTIONS];
189 struct fw_info* fwinfo;
190 } image_info_t;
191
192 static struct fw_info* get_fwinfo(char* board_name) {
193 struct fw_info *fwinfo = fw_info;
194 while(strlen(fwinfo->name)) {
195 if(strcmp(fwinfo->name, board_name) == 0) {
196 return fwinfo;
197 }
198 fwinfo++;
199 }
200 return NULL;
201 }
202
203 static void write_header(void* mem, const char *magic, const char* version)
204 {
205 header_t* header = mem;
206 memset(header, 0, sizeof(header_t));
207
208 FW_MEMCPY_STR(header->magic, magic);
209 FW_MEMCPY_STR(header->version, version);
210 header->crc = htonl(crc32(0L, (uint8_t*) header,
211 sizeof(header_t) - 2 * sizeof(u_int32_t)));
212 header->pad = 0L;
213 }
214
215 static void write_signature(void* mem, u_int32_t sig_offset)
216 {
217 /* write signature */
218 signature_t* sign = (signature_t*)(mem + sig_offset);
219 memset(sign, 0, sizeof(signature_t));
220
221 FW_MEMCPY_STR(sign->magic, MAGIC_END);
222 sign->crc = htonl(crc32(0L,(unsigned char *)mem, sig_offset));
223 sign->pad = 0L;
224 }
225
226 static void write_signature_rsa(void* mem, u_int32_t sig_offset)
227 {
228 /* write signature */
229 signature_rsa_t* sign = (signature_rsa_t*)(mem + sig_offset);
230 memset(sign, 0, sizeof(signature_rsa_t));
231
232 FW_MEMCPY_STR(sign->magic, MAGIC_ENDS);
233 // sign->crc = htonl(crc32(0L,(unsigned char *)mem, sig_offset));
234 sign->pad = 0L;
235 }
236
237 static int write_part(void* mem, part_data_t* d)
238 {
239 char* addr;
240 int fd;
241 part_t* p = mem;
242 part_crc_t* crc = mem + sizeof(part_t) + d->stats.st_size;
243
244 fd = open(d->filename, O_RDONLY);
245 if (fd < 0)
246 {
247 ERROR("Failed opening file '%s'\n", d->filename);
248 return -1;
249 }
250
251 if ((addr=(char*)mmap(0, d->stats.st_size, PROT_READ, MAP_SHARED, fd, 0)) == MAP_FAILED)
252 {
253 ERROR("Failed mmaping memory for file '%s'\n", d->filename);
254 close(fd);
255 return -2;
256 }
257
258 memcpy(mem + sizeof(part_t), addr, d->stats.st_size);
259 munmap(addr, d->stats.st_size);
260
261 memset(p->name, 0, PART_NAME_LENGTH);
262 FW_MEMCPY_STR(p->magic, MAGIC_PART);
263 FW_MEMCPY_STR(p->name, d->partition_name);
264
265 p->index = htonl(d->partition_index);
266 p->data_size = htonl(d->stats.st_size);
267 p->part_size = htonl(d->partition_length);
268 p->baseaddr = htonl(d->partition_baseaddr);
269 p->memaddr = htonl(d->partition_memaddr);
270 p->entryaddr = htonl(d->partition_entryaddr);
271
272 crc->crc = htonl(crc32(0L, mem, d->stats.st_size + sizeof(part_t)));
273 crc->pad = 0L;
274
275 return 0;
276 }
277
278 static void usage(const char* progname)
279 {
280 INFO("Version %s\n"
281 "Usage: %s [options]\n"
282 "\t-v <version string>\t - firmware version information, default: %s\n"
283 "\t-o <output file>\t - firmware output file, default: %s\n"
284 "\t-m <magic>\t - firmware magic, default: %s\n"
285 "\t-k <kernel file>\t\t - kernel file\n"
286 "\t-r <rootfs file>\t\t - rootfs file\n"
287 "\t-B <board name>\t\t - choose firmware layout for specified board (XS2, XS5, RS, XM)\n"
288 "\t-h\t\t\t - this help\n", VERSION,
289 progname, DEFAULT_VERSION, DEFAULT_OUTPUT_FILE, MAGIC_HEADER);
290 }
291
292 static void print_image_info(const image_info_t* im)
293 {
294 unsigned int i = 0;
295
296 INFO("Firmware version: '%s'\n"
297 "Output file: '%s'\n"
298 "Part count: %u\n",
299 im->version, im->outputfile,
300 im->part_count);
301
302 for (i = 0; i < im->part_count; ++i)
303 {
304 const part_data_t* d = &im->parts[i];
305 INFO(" %10s: %8" PRId64 " bytes (free: %8" PRId64 ")\n",
306 d->partition_name,
307 d->stats.st_size,
308 d->partition_length - d->stats.st_size);
309 }
310 }
311
312 static u_int32_t filelength(const char* file)
313 {
314 FILE *p;
315 int ret = -1;
316
317 if ( (p = fopen(file, "rb") ) == NULL) return (-1);
318
319 fseek(p, 0, SEEK_END);
320 ret = ftell(p);
321
322 fclose (p);
323
324 return (ret);
325 }
326
327 static int create_image_layout(const char* kernelfile, const char* rootfsfile, image_info_t* im)
328 {
329 uint32_t rootfs_len = 0;
330 part_data_t* kernel = &im->parts[0];
331 part_data_t* rootfs = &im->parts[1];
332
333 fw_layout_t* p = &im->fwinfo->fw_layout;
334
335 printf("board = %s\n", im->fwinfo->name);
336 strcpy(kernel->partition_name, "kernel");
337 kernel->partition_index = 1;
338 kernel->partition_baseaddr = p->kern_start;
339 if ( (kernel->partition_length = filelength(kernelfile)) == (u_int32_t)-1) return (-1);
340 kernel->partition_memaddr = p->kern_entry;
341 kernel->partition_entryaddr = p->kern_entry;
342 strncpy(kernel->filename, kernelfile, sizeof(kernel->filename));
343
344 rootfs_len = filelength(rootfsfile);
345 if (rootfs_len + kernel->partition_length > p->firmware_max_length) {
346 ERROR("File '%s' too big (0x%08X) - max size: 0x%08X (exceeds %u bytes)\n",
347 rootfsfile, rootfs_len, p->firmware_max_length,
348 (rootfs_len + kernel->partition_length) - p->firmware_max_length);
349 return (-2);
350 }
351
352 strcpy(rootfs->partition_name, "rootfs");
353 rootfs->partition_index = 2;
354 rootfs->partition_baseaddr = kernel->partition_baseaddr + kernel->partition_length;
355 rootfs->partition_length = p->firmware_max_length - kernel->partition_length;
356 rootfs->partition_memaddr = 0x00000000;
357 rootfs->partition_entryaddr = 0x00000000;
358 strncpy(rootfs->filename, rootfsfile, sizeof(rootfs->filename));
359
360 printf("kernel: %d 0x%08x\n", kernel->partition_length, kernel->partition_baseaddr);
361 printf("root: %d 0x%08x\n", rootfs->partition_length, rootfs->partition_baseaddr);
362 im->part_count = 2;
363
364 return 0;
365 }
366
367 /**
368 * Checks the availability and validity of all image components.
369 * Fills in stats member of the part_data structure.
370 */
371 static int validate_image_layout(image_info_t* im)
372 {
373 unsigned int i;
374
375 if (im->part_count == 0 || im->part_count > MAX_SECTIONS)
376 {
377 ERROR("Invalid part count '%d'\n", im->part_count);
378 return -1;
379 }
380
381 for (i = 0; i < im->part_count; ++i)
382 {
383 part_data_t* d = &im->parts[i];
384 int len = strlen(d->partition_name);
385 if (len == 0 || len > 16)
386 {
387 ERROR("Invalid partition name '%s' of the part %d\n",
388 d->partition_name, i);
389 return -1;
390 }
391 if (stat(d->filename, &d->stats) < 0)
392 {
393 ERROR("Couldn't stat file '%s' from part '%s'\n",
394 d->filename, d->partition_name);
395 return -2;
396 }
397 if (d->stats.st_size == 0)
398 {
399 ERROR("File '%s' from part '%s' is empty!\n",
400 d->filename, d->partition_name);
401 return -3;
402 }
403 if (d->stats.st_size > d->partition_length) {
404 ERROR("File '%s' too big (%d) - max size: 0x%08X (exceeds %" PRId64 " bytes)\n",
405 d->filename, i, d->partition_length,
406 d->stats.st_size - d->partition_length);
407 return -4;
408 }
409 }
410
411 return 0;
412 }
413
414 static int build_image(image_info_t* im)
415 {
416 char* mem;
417 char* ptr;
418 u_int32_t mem_size;
419 FILE* f;
420 unsigned int i;
421
422 // build in-memory buffer
423 mem_size = sizeof(header_t);
424 if(im->fwinfo->sign) {
425 mem_size += sizeof(signature_rsa_t);
426 } else {
427 mem_size += sizeof(signature_t);
428 }
429 for (i = 0; i < im->part_count; ++i)
430 {
431 part_data_t* d = &im->parts[i];
432 mem_size += sizeof(part_t) + d->stats.st_size + sizeof(part_crc_t);
433 }
434
435 mem = (char*)calloc(mem_size, 1);
436 if (mem == NULL)
437 {
438 ERROR("Cannot allocate memory chunk of size '%u'\n", mem_size);
439 return -1;
440 }
441
442 // write header
443 write_header(mem, im->magic, im->version);
444 ptr = mem + sizeof(header_t);
445 // write all parts
446 for (i = 0; i < im->part_count; ++i)
447 {
448 part_data_t* d = &im->parts[i];
449 int rc;
450 if ((rc = write_part(ptr, d)) != 0)
451 {
452 ERROR("ERROR: failed writing part %u '%s'\n", i, d->partition_name);
453 }
454 ptr += sizeof(part_t) + d->stats.st_size + sizeof(part_crc_t);
455 }
456 // write signature
457 if(im->fwinfo->sign) {
458 write_signature_rsa(mem, mem_size - sizeof(signature_rsa_t));
459 } else {
460 write_signature(mem, mem_size - sizeof(signature_t));
461 }
462
463 // write in-memory buffer into file
464 if ((f = fopen(im->outputfile, "w")) == NULL)
465 {
466 ERROR("Can not create output file: '%s'\n", im->outputfile);
467 free(mem);
468 return -10;
469 }
470
471 if (fwrite(mem, mem_size, 1, f) != 1)
472 {
473 ERROR("Could not write %d bytes into file: '%s'\n",
474 mem_size, im->outputfile);
475 free(mem);
476 fclose(f);
477 return -11;
478 }
479
480 free(mem);
481 fclose(f);
482 return 0;
483 }
484
485
486 int main(int argc, char* argv[])
487 {
488 char kernelfile[PATH_MAX];
489 char rootfsfile[PATH_MAX];
490 char board_name[PATH_MAX];
491 int o, rc;
492 image_info_t im;
493 struct fw_info *fwinfo;
494
495 memset(&im, 0, sizeof(im));
496 memset(kernelfile, 0, sizeof(kernelfile));
497 memset(rootfsfile, 0, sizeof(rootfsfile));
498 memset(board_name, 0, sizeof(board_name));
499
500 strcpy(im.outputfile, DEFAULT_OUTPUT_FILE);
501 strcpy(im.version, DEFAULT_VERSION);
502 strncpy(im.magic, MAGIC_HEADER, sizeof(im.magic));
503
504 while ((o = getopt(argc, argv, OPTIONS)) != -1)
505 {
506 switch (o) {
507 case 'v':
508 if (optarg)
509 strncpy(im.version, optarg, sizeof(im.version) - 1);
510 break;
511 case 'o':
512 if (optarg)
513 strncpy(im.outputfile, optarg, sizeof(im.outputfile) - 1);
514 break;
515 case 'm':
516 if (optarg)
517 strncpy(im.magic, optarg, sizeof(im.magic) - 1);
518 break;
519 case 'h':
520 usage(argv[0]);
521 return -1;
522 case 'k':
523 if (optarg)
524 strncpy(kernelfile, optarg, sizeof(kernelfile) - 1);
525 break;
526 case 'r':
527 if (optarg)
528 strncpy(rootfsfile, optarg, sizeof(rootfsfile) - 1);
529 break;
530 case 'B':
531 if (optarg)
532 strncpy(board_name, optarg, sizeof(board_name) - 1);
533 break;
534 }
535 }
536 if (strlen(board_name) == 0)
537 strcpy(board_name, "XS2"); /* default to XS2 */
538
539 if (strlen(kernelfile) == 0)
540 {
541 ERROR("Kernel file is not specified, cannot continue\n");
542 usage(argv[0]);
543 return -2;
544 }
545
546 if (strlen(rootfsfile) == 0)
547 {
548 ERROR("Root FS file is not specified, cannot continue\n");
549 usage(argv[0]);
550 return -2;
551 }
552
553 if ((fwinfo = get_fwinfo(board_name)) == NULL) {
554 ERROR("Invalid baord name '%s'\n", board_name);
555 usage(argv[0]);
556 return -2;
557 }
558
559 im.fwinfo = fwinfo;
560
561 if ((rc = create_image_layout(kernelfile, rootfsfile, &im)) != 0)
562 {
563 ERROR("Failed creating firmware layout description - error code: %d\n", rc);
564 return -3;
565 }
566
567 if ((rc = validate_image_layout(&im)) != 0)
568 {
569 ERROR("Failed validating firmware layout - error code: %d\n", rc);
570 return -4;
571 }
572
573 print_image_info(&im);
574
575 if ((rc = build_image(&im)) != 0)
576 {
577 ERROR("Failed building image file '%s' - error code: %d\n", im.outputfile, rc);
578 return -5;
579 }
580
581 return 0;
582 }
OpenWrt Source Repository