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>
34 typedef struct fw_layout_data {
41 u_int32_t firmware_max_length;
44 fw_layout_t fw_layout_data[] = {
47 .kern_start = 0xbfc30000,
48 .kern_len = 0x00140000,
49 .root_start = 0xbfc30000,
50 .root_len = 0x002C0000,
51 .kern_entry = 0x80041000,
52 .firmware_max_length= 0x00390000,
56 .kern_start = 0xbe030000,
57 .kern_len = 0x00140000,
58 .root_start = 0xbe030000,
59 .root_len = 0x002C0000,
60 .kern_entry = 0x80041000,
61 .firmware_max_length= 0x00390000,
65 .kern_start = 0x00000000,
66 .kern_len = 0x00140000,
67 .root_start = 0x00000000,
68 .root_len = 0x002C0000,
69 .kern_entry = 0x80060000,
70 .firmware_max_length= 0x00140000 + 0x002C0000,
76 typedef struct part_data {
77 char partition_name[64];
79 u_int32_t partition_baseaddr;
80 u_int32_t partition_startaddr;
81 u_int32_t partition_memaddr;
82 u_int32_t partition_entryaddr;
83 u_int32_t partition_length;
85 char filename[PATH_MAX];
89 #define MAX_SECTIONS 8
90 #define DEFAULT_OUTPUT_FILE "firmware-image.bin"
91 #define DEFAULT_VERSION "UNKNOWN"
93 #define OPTIONS "B:hv:o:r:k:"
97 typedef struct image_info {
99 char outputfile[PATH_MAX];
100 u_int32_t part_count;
101 part_data_t parts[MAX_SECTIONS];
104 static void write_header(void* mem, const char* version)
106 header_t* header = mem;
107 memset(header, 0, sizeof(header_t));
109 memcpy(header->magic, MAGIC_HEADER, MAGIC_LENGTH);
110 strncpy(header->version, version, sizeof(header->version));
111 header->crc = htonl(crc32(0L, (unsigned char *)header,
112 sizeof(header_t) - 2 * sizeof(u_int32_t)));
117 static void write_signature(void* mem, u_int32_t sig_offset)
119 /* write signature */
120 signature_t* sign = (signature_t*)(mem + sig_offset);
121 memset(sign, 0, sizeof(signature_t));
123 memcpy(sign->magic, MAGIC_END, MAGIC_LENGTH);
124 sign->crc = htonl(crc32(0L,(unsigned char *)mem, sig_offset));
128 static int write_part(void* mem, part_data_t* d)
133 part_crc_t* crc = mem + sizeof(part_t) + d->stats.st_size;
135 fd = open(d->filename, O_RDONLY);
138 ERROR("Failed opening file '%s'\n", d->filename);
142 if ((addr=(char*)mmap(0, d->stats.st_size, PROT_READ, MAP_SHARED, fd, 0)) == MAP_FAILED)
144 ERROR("Failed mmaping memory for file '%s'\n", d->filename);
149 memcpy(mem + sizeof(part_t), addr, d->stats.st_size);
150 munmap(addr, d->stats.st_size);
152 memset(p->name, 0, sizeof(p->name));
153 strncpy(p->magic, MAGIC_PART, MAGIC_LENGTH);
154 strncpy(p->name, d->partition_name, sizeof(p->name));
155 p->index = htonl(d->partition_index);
156 p->data_size = htonl(d->stats.st_size);
157 p->part_size = htonl(d->partition_length);
158 p->baseaddr = htonl(d->partition_baseaddr);
159 p->memaddr = htonl(d->partition_memaddr);
160 p->entryaddr = htonl(d->partition_entryaddr);
162 crc->crc = htonl(crc32(0L, mem, d->stats.st_size + sizeof(part_t)));
168 static void usage(const char* progname)
171 "Usage: %s [options]\n"
172 "\t-v <version string>\t - firmware version information, default: %s\n"
173 "\t-o <output file>\t - firmware output file, default: %s\n"
174 "\t-k <kernel file>\t\t - kernel file\n"
175 "\t-r <rootfs file>\t\t - rootfs file\n"
176 "\t-B <board name>\t\t - choose firmware layout for specified board (XS2, XS5, RS)\n"
177 "\t-h\t\t\t - this help\n", VERSION,
178 progname, DEFAULT_VERSION, DEFAULT_OUTPUT_FILE);
181 static void print_image_info(const image_info_t* im)
184 INFO("Firmware version: '%s'\n"
185 "Output file: '%s'\n"
187 im->version, im->outputfile,
190 for (i = 0; i < im->part_count; ++i)
192 const part_data_t* d = &im->parts[i];
193 INFO(" %10s: %8ld bytes (free: %8ld)\n",
196 d->partition_length - d->stats.st_size);
202 static u_int32_t filelength(const char* file)
207 if ( (p = fopen(file, "rb") ) == NULL) return (-1);
209 fseek(p, 0, SEEK_END);
217 static int create_image_layout(const char* kernelfile, const char* rootfsfile, char* board_name, image_info_t* im)
219 part_data_t* kernel = &im->parts[0];
220 part_data_t* rootfs = &im->parts[1];
224 p = &fw_layout_data[0];
225 while ((strlen(p->name) != 0) && (strncmp(p->name, board_name, sizeof(board_name)) != 0))
227 if (p->name == NULL) {
228 printf("BUG! Unable to find default fw layout!\n");
232 printf("board = %s\n", p->name);
233 strcpy(kernel->partition_name, "kernel");
234 kernel->partition_index = 1;
235 kernel->partition_baseaddr = p->kern_start;
236 if ( (kernel->partition_length = filelength(kernelfile)) < 0) return (-1);
237 kernel->partition_memaddr = p->kern_entry;
238 kernel->partition_entryaddr = p->kern_entry;
239 strncpy(kernel->filename, kernelfile, sizeof(kernel->filename));
241 if (filelength(rootfsfile) + kernel->partition_length > p->firmware_max_length)
244 strcpy(rootfs->partition_name, "rootfs");
245 rootfs->partition_index = 2;
246 rootfs->partition_baseaddr = kernel->partition_baseaddr + kernel->partition_length;
247 rootfs->partition_length = p->firmware_max_length - kernel->partition_length;
248 rootfs->partition_memaddr = 0x00000000;
249 rootfs->partition_entryaddr = 0x00000000;
250 strncpy(rootfs->filename, rootfsfile, sizeof(rootfs->filename));
252 printf("kernel: %d 0x%08x\n", kernel->partition_length, kernel->partition_baseaddr);
253 printf("root: %d 0x%08x\n", rootfs->partition_length, rootfs->partition_baseaddr);
260 * Checks the availability and validity of all image components.
261 * Fills in stats member of the part_data structure.
263 static int validate_image_layout(image_info_t* im)
267 if (im->part_count == 0 || im->part_count > MAX_SECTIONS)
269 ERROR("Invalid part count '%d'\n", im->part_count);
273 for (i = 0; i < im->part_count; ++i)
275 part_data_t* d = &im->parts[i];
276 int len = strlen(d->partition_name);
277 if (len == 0 || len > 16)
279 ERROR("Invalid partition name '%s' of the part %d\n",
280 d->partition_name, i);
283 if (stat(d->filename, &d->stats) < 0)
285 ERROR("Couldn't stat file '%s' from part '%s'\n",
286 d->filename, d->partition_name);
289 if (d->stats.st_size == 0)
291 ERROR("File '%s' from part '%s' is empty!\n",
292 d->filename, d->partition_name);
295 if (d->stats.st_size > d->partition_length) {
296 ERROR("File '%s' too big (%d) - max size: 0x%08X (exceeds %lu bytes)\n",
297 d->filename, i, d->partition_length,
298 d->stats.st_size - d->partition_length);
306 static int build_image(image_info_t* im)
314 // build in-memory buffer
315 mem_size = sizeof(header_t) + sizeof(signature_t);
316 for (i = 0; i < im->part_count; ++i)
318 part_data_t* d = &im->parts[i];
319 mem_size += sizeof(part_t) + d->stats.st_size + sizeof(part_crc_t);
322 mem = (char*)calloc(mem_size, 1);
325 ERROR("Cannot allocate memory chunk of size '%u'\n", mem_size);
330 write_header(mem, im->version);
331 ptr = mem + sizeof(header_t);
333 for (i = 0; i < im->part_count; ++i)
335 part_data_t* d = &im->parts[i];
337 if ((rc = write_part(ptr, d)) != 0)
339 ERROR("ERROR: failed writing part %u '%s'\n", i, d->partition_name);
341 ptr += sizeof(part_t) + d->stats.st_size + sizeof(part_crc_t);
344 write_signature(mem, mem_size - sizeof(signature_t));
346 // write in-memory buffer into file
347 if ((f = fopen(im->outputfile, "w")) == NULL)
349 ERROR("Can not create output file: '%s'\n", im->outputfile);
353 if (fwrite(mem, mem_size, 1, f) != 1)
355 ERROR("Could not write %d bytes into file: '%s'\n",
356 mem_size, im->outputfile);
366 int main(int argc, char* argv[])
368 char kernelfile[PATH_MAX];
369 char rootfsfile[PATH_MAX];
370 char board_name[PATH_MAX];
374 memset(&im, 0, sizeof(im));
375 memset(kernelfile, 0, sizeof(kernelfile));
376 memset(rootfsfile, 0, sizeof(rootfsfile));
377 memset(board_name, 0, sizeof(board_name));
379 strcpy(im.outputfile, DEFAULT_OUTPUT_FILE);
380 strcpy(im.version, DEFAULT_VERSION);
382 while ((o = getopt(argc, argv, OPTIONS)) != -1)
387 strncpy(im.version, optarg, sizeof(im.version));
391 strncpy(im.outputfile, optarg, sizeof(im.outputfile));
398 strncpy(kernelfile, optarg, sizeof(kernelfile));
402 strncpy(rootfsfile, optarg, sizeof(rootfsfile));
406 strncpy(board_name, optarg, sizeof(board_name));
410 if (strlen(board_name) == 0)
411 strcpy(board_name, "XS2"); /* default to XS2 */
413 if (strlen(kernelfile) == 0)
415 ERROR("Kernel file is not specified, cannot continue\n");
420 if (strlen(rootfsfile) == 0)
422 ERROR("Root FS file is not specified, cannot continue\n");
427 if ((rc = create_image_layout(kernelfile, rootfsfile, board_name, &im)) != 0)
429 ERROR("Failed creating firmware layout description - error code: %d\n", rc);
433 if ((rc = validate_image_layout(&im)) != 0)
435 ERROR("Failed validating firmware layout - error code: %d\n", rc);
439 print_image_info(&im);
441 if ((rc = build_image(&im)) != 0)
443 ERROR("Failed building image file '%s' - error code: %d\n", im.outputfile, rc);