2 * Copyright (C) 2007 Ubiquiti Networks, Inc.
3 * Copyright (C) 2008 Lukas Kuna <ValXdater@seznam.cz>
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.
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.
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.
20 #include <sys/types.h>
28 #include <netinet/in.h>
35 typedef struct fw_layout_data
{
38 u_int32_t firmware_max_length
;
43 struct fw_layout_data fw_layout
;
47 struct fw_info fw_info
[] = {
51 .kern_start
= 0xbfc30000,
52 .kern_entry
= 0x80041000,
53 .firmware_max_length
= 0x00390000,
60 .kern_start
= 0xbe030000,
61 .kern_entry
= 0x80041000,
62 .firmware_max_length
= 0x00390000,
69 .kern_start
= 0xbf030000,
70 .kern_entry
= 0x80060000,
71 .firmware_max_length
= 0x00B00000,
78 .kern_start
= 0xbf030000,
79 .kern_entry
= 0x80060000,
80 .firmware_max_length
= 0x00F00000,
87 .kern_start
= 0xbf030000,
88 .kern_entry
= 0x80060000,
89 .firmware_max_length
= 0x00640000,
96 .kern_start
= 0xa8030000,
97 .kern_entry
= 0x80041000,
98 .firmware_max_length
= 0x006C0000,
106 .kern_start
= 0x9f050000,
107 .kern_entry
= 0x80002000,
108 .firmware_max_length
= 0x00760000,
115 .kern_start
= 0x9f050000,
116 .kern_entry
= 0x80002000,
117 .firmware_max_length
= 0x006A0000,
124 .kern_start
= 0x9f050000,
125 .kern_entry
= 0x80002000,
126 .firmware_max_length
= 0x00F60000,
135 typedef struct part_data
{
136 char partition_name
[64];
138 u_int32_t partition_baseaddr
;
139 u_int32_t partition_startaddr
;
140 u_int32_t partition_memaddr
;
141 u_int32_t partition_entryaddr
;
142 u_int32_t partition_length
;
144 char filename
[PATH_MAX
];
148 #define MAX_SECTIONS 8
149 #define DEFAULT_OUTPUT_FILE "firmware-image.bin"
150 #define DEFAULT_VERSION "UNKNOWN"
152 #define OPTIONS "B:hv:m:o:r:k:"
154 typedef struct image_info
{
157 char outputfile
[PATH_MAX
];
158 u_int32_t part_count
;
159 part_data_t parts
[MAX_SECTIONS
];
160 struct fw_info
* fwinfo
;
163 static struct fw_info
* get_fwinfo(char* board_name
) {
164 struct fw_info
*fwinfo
= fw_info
;
165 while(strlen(fwinfo
->name
)) {
166 if(strcmp(fwinfo
->name
, board_name
) == 0) {
174 static void write_header(void* mem
, const char *magic
, const char* version
)
176 header_t
* header
= mem
;
177 memset(header
, 0, sizeof(header_t
));
179 memcpy(header
->magic
, magic
, MAGIC_LENGTH
);
180 strncpy(header
->version
, version
, sizeof(header
->version
));
181 header
->crc
= htonl(crc32(0L, (unsigned char *)header
,
182 sizeof(header_t
) - 2 * sizeof(u_int32_t
)));
187 static void write_signature(void* mem
, u_int32_t sig_offset
)
189 /* write signature */
190 signature_t
* sign
= (signature_t
*)(mem
+ sig_offset
);
191 memset(sign
, 0, sizeof(signature_t
));
193 memcpy(sign
->magic
, MAGIC_END
, MAGIC_LENGTH
);
194 sign
->crc
= htonl(crc32(0L,(unsigned char *)mem
, sig_offset
));
198 static void write_signature_rsa(void* mem
, u_int32_t sig_offset
)
200 /* write signature */
201 signature_rsa_t
* sign
= (signature_rsa_t
*)(mem
+ sig_offset
);
202 memset(sign
, 0, sizeof(signature_rsa_t
));
204 memcpy(sign
->magic
, MAGIC_ENDS
, MAGIC_LENGTH
);
205 // sign->crc = htonl(crc32(0L,(unsigned char *)mem, sig_offset));
209 static int write_part(void* mem
, part_data_t
* d
)
214 part_crc_t
* crc
= mem
+ sizeof(part_t
) + d
->stats
.st_size
;
216 fd
= open(d
->filename
, O_RDONLY
);
219 ERROR("Failed opening file '%s'\n", d
->filename
);
223 if ((addr
=(char*)mmap(0, d
->stats
.st_size
, PROT_READ
, MAP_SHARED
, fd
, 0)) == MAP_FAILED
)
225 ERROR("Failed mmaping memory for file '%s'\n", d
->filename
);
230 memcpy(mem
+ sizeof(part_t
), addr
, d
->stats
.st_size
);
231 munmap(addr
, d
->stats
.st_size
);
233 memset(p
->name
, 0, sizeof(p
->name
));
234 strncpy(p
->magic
, MAGIC_PART
, MAGIC_LENGTH
);
235 strncpy(p
->name
, d
->partition_name
, sizeof(p
->name
));
236 p
->index
= htonl(d
->partition_index
);
237 p
->data_size
= htonl(d
->stats
.st_size
);
238 p
->part_size
= htonl(d
->partition_length
);
239 p
->baseaddr
= htonl(d
->partition_baseaddr
);
240 p
->memaddr
= htonl(d
->partition_memaddr
);
241 p
->entryaddr
= htonl(d
->partition_entryaddr
);
243 crc
->crc
= htonl(crc32(0L, mem
, d
->stats
.st_size
+ sizeof(part_t
)));
249 static void usage(const char* progname
)
252 "Usage: %s [options]\n"
253 "\t-v <version string>\t - firmware version information, default: %s\n"
254 "\t-o <output file>\t - firmware output file, default: %s\n"
255 "\t-m <magic>\t - firmware magic, default: %s\n"
256 "\t-k <kernel file>\t\t - kernel file\n"
257 "\t-r <rootfs file>\t\t - rootfs file\n"
258 "\t-B <board name>\t\t - choose firmware layout for specified board (XS2, XS5, RS, XM)\n"
259 "\t-h\t\t\t - this help\n", VERSION
,
260 progname
, DEFAULT_VERSION
, DEFAULT_OUTPUT_FILE
, MAGIC_HEADER
);
263 static void print_image_info(const image_info_t
* im
)
267 INFO("Firmware version: '%s'\n"
268 "Output file: '%s'\n"
270 im
->version
, im
->outputfile
,
273 for (i
= 0; i
< im
->part_count
; ++i
)
275 const part_data_t
* d
= &im
->parts
[i
];
276 INFO(" %10s: %8ld bytes (free: %8ld)\n",
279 d
->partition_length
- d
->stats
.st_size
);
283 static u_int32_t
filelength(const char* file
)
288 if ( (p
= fopen(file
, "rb") ) == NULL
) return (-1);
290 fseek(p
, 0, SEEK_END
);
298 static int create_image_layout(const char* kernelfile
, const char* rootfsfile
, char* board_name
, image_info_t
* im
)
300 uint32_t rootfs_len
= 0;
301 part_data_t
* kernel
= &im
->parts
[0];
302 part_data_t
* rootfs
= &im
->parts
[1];
304 fw_layout_t
* p
= &im
->fwinfo
->fw_layout
;
306 printf("board = %s\n", im
->fwinfo
->name
);
307 strcpy(kernel
->partition_name
, "kernel");
308 kernel
->partition_index
= 1;
309 kernel
->partition_baseaddr
= p
->kern_start
;
310 if ( (kernel
->partition_length
= filelength(kernelfile
)) == (u_int32_t
)-1) return (-1);
311 kernel
->partition_memaddr
= p
->kern_entry
;
312 kernel
->partition_entryaddr
= p
->kern_entry
;
313 strncpy(kernel
->filename
, kernelfile
, sizeof(kernel
->filename
));
315 rootfs_len
= filelength(rootfsfile
);
316 if (rootfs_len
+ kernel
->partition_length
> p
->firmware_max_length
) {
317 ERROR("File '%s' too big (0x%08X) - max size: 0x%08X (exceeds %u bytes)\n",
318 rootfsfile
, rootfs_len
, p
->firmware_max_length
,
319 (rootfs_len
+ kernel
->partition_length
) - p
->firmware_max_length
);
323 strcpy(rootfs
->partition_name
, "rootfs");
324 rootfs
->partition_index
= 2;
325 rootfs
->partition_baseaddr
= kernel
->partition_baseaddr
+ kernel
->partition_length
;
326 rootfs
->partition_length
= p
->firmware_max_length
- kernel
->partition_length
;
327 rootfs
->partition_memaddr
= 0x00000000;
328 rootfs
->partition_entryaddr
= 0x00000000;
329 strncpy(rootfs
->filename
, rootfsfile
, sizeof(rootfs
->filename
));
331 printf("kernel: %d 0x%08x\n", kernel
->partition_length
, kernel
->partition_baseaddr
);
332 printf("root: %d 0x%08x\n", rootfs
->partition_length
, rootfs
->partition_baseaddr
);
339 * Checks the availability and validity of all image components.
340 * Fills in stats member of the part_data structure.
342 static int validate_image_layout(image_info_t
* im
)
346 if (im
->part_count
== 0 || im
->part_count
> MAX_SECTIONS
)
348 ERROR("Invalid part count '%d'\n", im
->part_count
);
352 for (i
= 0; i
< im
->part_count
; ++i
)
354 part_data_t
* d
= &im
->parts
[i
];
355 int len
= strlen(d
->partition_name
);
356 if (len
== 0 || len
> 16)
358 ERROR("Invalid partition name '%s' of the part %d\n",
359 d
->partition_name
, i
);
362 if (stat(d
->filename
, &d
->stats
) < 0)
364 ERROR("Couldn't stat file '%s' from part '%s'\n",
365 d
->filename
, d
->partition_name
);
368 if (d
->stats
.st_size
== 0)
370 ERROR("File '%s' from part '%s' is empty!\n",
371 d
->filename
, d
->partition_name
);
374 if (d
->stats
.st_size
> d
->partition_length
) {
375 ERROR("File '%s' too big (%d) - max size: 0x%08X (exceeds %lu bytes)\n",
376 d
->filename
, i
, d
->partition_length
,
377 d
->stats
.st_size
- d
->partition_length
);
385 static int build_image(image_info_t
* im
)
393 // build in-memory buffer
394 mem_size
= sizeof(header_t
);
395 if(im
->fwinfo
->sign
) {
396 mem_size
+= sizeof(signature_rsa_t
);
398 mem_size
+= sizeof(signature_t
);
400 for (i
= 0; i
< im
->part_count
; ++i
)
402 part_data_t
* d
= &im
->parts
[i
];
403 mem_size
+= sizeof(part_t
) + d
->stats
.st_size
+ sizeof(part_crc_t
);
406 mem
= (char*)calloc(mem_size
, 1);
409 ERROR("Cannot allocate memory chunk of size '%u'\n", mem_size
);
414 write_header(mem
, im
->magic
, im
->version
);
415 ptr
= mem
+ sizeof(header_t
);
417 for (i
= 0; i
< im
->part_count
; ++i
)
419 part_data_t
* d
= &im
->parts
[i
];
421 if ((rc
= write_part(ptr
, d
)) != 0)
423 ERROR("ERROR: failed writing part %u '%s'\n", i
, d
->partition_name
);
425 ptr
+= sizeof(part_t
) + d
->stats
.st_size
+ sizeof(part_crc_t
);
428 if(im
->fwinfo
->sign
) {
429 write_signature_rsa(mem
, mem_size
- sizeof(signature_rsa_t
));
431 write_signature(mem
, mem_size
- sizeof(signature_t
));
434 // write in-memory buffer into file
435 if ((f
= fopen(im
->outputfile
, "w")) == NULL
)
437 ERROR("Can not create output file: '%s'\n", im
->outputfile
);
441 if (fwrite(mem
, mem_size
, 1, f
) != 1)
443 ERROR("Could not write %d bytes into file: '%s'\n",
444 mem_size
, im
->outputfile
);
454 int main(int argc
, char* argv
[])
456 char kernelfile
[PATH_MAX
];
457 char rootfsfile
[PATH_MAX
];
458 char board_name
[PATH_MAX
];
461 struct fw_info
*fwinfo
;
463 memset(&im
, 0, sizeof(im
));
464 memset(kernelfile
, 0, sizeof(kernelfile
));
465 memset(rootfsfile
, 0, sizeof(rootfsfile
));
466 memset(board_name
, 0, sizeof(board_name
));
468 strcpy(im
.outputfile
, DEFAULT_OUTPUT_FILE
);
469 strcpy(im
.version
, DEFAULT_VERSION
);
470 strncpy(im
.magic
, MAGIC_HEADER
, sizeof(im
.magic
));
472 while ((o
= getopt(argc
, argv
, OPTIONS
)) != -1)
477 strncpy(im
.version
, optarg
, sizeof(im
.version
));
481 strncpy(im
.outputfile
, optarg
, sizeof(im
.outputfile
));
485 strncpy(im
.magic
, optarg
, sizeof(im
.magic
));
492 strncpy(kernelfile
, optarg
, sizeof(kernelfile
));
496 strncpy(rootfsfile
, optarg
, sizeof(rootfsfile
));
500 strncpy(board_name
, optarg
, sizeof(board_name
));
504 if (strlen(board_name
) == 0)
505 strcpy(board_name
, "XS2"); /* default to XS2 */
507 if (strlen(kernelfile
) == 0)
509 ERROR("Kernel file is not specified, cannot continue\n");
514 if (strlen(rootfsfile
) == 0)
516 ERROR("Root FS file is not specified, cannot continue\n");
521 if ((fwinfo
= get_fwinfo(board_name
)) == NULL
) {
522 ERROR("Invalid baord name '%s'\n", board_name
);
529 if ((rc
= create_image_layout(kernelfile
, rootfsfile
, board_name
, &im
)) != 0)
531 ERROR("Failed creating firmware layout description - error code: %d\n", rc
);
535 if ((rc
= validate_image_layout(&im
)) != 0)
537 ERROR("Failed validating firmware layout - error code: %d\n", rc
);
541 print_image_info(&im
);
543 if ((rc
= build_image(&im
)) != 0)
545 ERROR("Failed building image file '%s' - error code: %d\n", im
.outputfile
, rc
);