[ar71xx] create firmware image for the Ubiquiti LS-SR71 board
[openwrt/svn-archive/archive.git] / tools / firmware-utils / src / mkfwimage.c
index 372a0b59324ada4644038a9f4ffc06fd40d970d9..fc1c6ce6a6622c0a4820f7af898f5bb938535ffd 100644 (file)
@@ -1,5 +1,6 @@
 /*
  * Copyright (C) 2007 Ubiquiti Networks, Inc.
+ * Copyright (C) 2008 Lukas Kuna <ValXdater@seznam.cz>
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License as
 #include <stdio.h>
 #include <stdlib.h>
 #include <limits.h>
-
 #include "fw.h"
 
+typedef struct fw_layout_data {
+       char            name[PATH_MAX];
+       u_int32_t       kern_start;
+       u_int32_t       kern_entry;
+       u_int32_t       firmware_max_length;
+} fw_layout_t;
+
+fw_layout_t fw_layout_data[] = {
+       {
+               .name           =       "XS2",
+               .kern_start     =       0xbfc30000,
+               .kern_entry     =       0x80041000,
+               .firmware_max_length=   0x00390000,
+       },
+       {
+               .name           =       "XS5",
+               .kern_start     =       0xbe030000,
+               .kern_entry     =       0x80041000,
+               .firmware_max_length=   0x00390000,
+       },
+       {
+               .name           =       "RS",
+               .kern_start     =       0xbf030000,
+               .kern_entry     =       0x80060000,
+               .firmware_max_length=   0x00640000,
+       },
+       {
+               .name           =       "LS-SR71",
+               .kern_start     =       0xbf030000,
+               .kern_entry     =       0x80060000,
+               .firmware_max_length=   0x00640000,
+       },
+       {       .name           =       "",
+       },
+};
+
 typedef struct part_data {
        char    partition_name[64];
        int     partition_index;
        u_int32_t       partition_baseaddr;
+       u_int32_t       partition_startaddr;
        u_int32_t       partition_memaddr;
        u_int32_t       partition_entryaddr;
        u_int32_t  partition_length;
@@ -47,7 +84,7 @@ typedef struct part_data {
 #define DEFAULT_OUTPUT_FILE    "firmware-image.bin"
 #define DEFAULT_VERSION                "UNKNOWN"
 
-#define OPTIONS "hv:o:i:"
+#define OPTIONS "B:hv:o:r:k:"
 
 static int debug = 0;
 
@@ -55,7 +92,7 @@ typedef struct image_info {
        char version[256];
        char outputfile[PATH_MAX];
        u_int32_t       part_count;
-       part_data_t parts[MAX_SECTIONS]; 
+       part_data_t parts[MAX_SECTIONS];
 } image_info_t;
 
 static void write_header(void* mem, const char* version)
@@ -128,7 +165,9 @@ static void usage(const char* progname)
              "Usage: %s [options]\n"
             "\t-v <version string>\t - firmware version information, default: %s\n"
             "\t-o <output file>\t - firmware output file, default: %s\n"
-            "\t-i <input file>\t\t - firmware layout file, default: none\n"
+            "\t-k <kernel file>\t\t - kernel file\n"
+            "\t-r <rootfs file>\t\t - rootfs file\n"
+            "\t-B <board name>\t\t - choose firmware layout for specified board (XS2, XS5, RS)\n"
             "\t-h\t\t\t - this help\n", VERSION,
             progname, DEFAULT_VERSION, DEFAULT_OUTPUT_FILE);
 }
@@ -154,76 +193,65 @@ static void print_image_info(const image_info_t* im)
 
 
 
-/**
- * Image layout file format:
- *
- * <partition name>\t<partition index>\t<partition size>\t<data file name>
- *
- */
-static int parse_image_layout(const char* layoutfile, image_info_t* im)
+static u_int32_t filelength(const char* file)
 {
-       int fd = 0;
-       char line[1028];
-       FILE* f;
-
-       im->part_count = 0;
+       FILE *p;
+       int ret = -1;
 
-       fd = open(layoutfile, O_RDONLY);
-       if (fd < 0) {
-               ERROR("Could not open file '%s'\n", layoutfile);
-               return -1;
-       }
-
-       f = fdopen(fd, "r");
-       if (f == NULL) {
-               close(fd);
-               return -2;
-       }
+       if ( (p = fopen(file, "rb") ) == NULL) return (-1);
 
-       while (!feof(f))
-       {
-               char name[32];
-               u_int32_t index;
-               u_int32_t baseaddr;
-               u_int32_t size;
-               u_int32_t memaddr;
-               u_int32_t entryaddr;
-               char file[PATH_MAX];
-               u_int32_t c;
-               part_data_t* d;
-
-               if (fgets(line, sizeof(line), f) == NULL)
-                       break;
+       fseek(p, 0, SEEK_END);
+       ret = ftell(p);
 
-               // TODO: very inconvenient format, use smarter parsing someday
-               if ((c = sscanf(line, "%32[^\t]\t%X\t%X\t%X\t%X\t%X\t%128[^\t\n]", name, &index, &baseaddr, &size, &memaddr, &entryaddr, file)) != 7)
-                       continue;
+       fclose (p);
 
-               DEBUG("%s\t\t0x%02X\t0x%08X\t0x%08X\t0x%08X\t0x%08X\t%s\n", name, index, baseaddr, size, memaddr, entryaddr, file);
+       return (ret);
+}
 
-               c = im->part_count;
-               if (c == MAX_SECTIONS)
-                       break;
+static int create_image_layout(const char* kernelfile, const char* rootfsfile, char* board_name, image_info_t* im)
+{
+       part_data_t* kernel = &im->parts[0];
+       part_data_t* rootfs = &im->parts[1];
 
-               d = &im->parts[c];
-               strncpy(d->partition_name, name, sizeof(d->partition_name));
-               d->partition_index = index;
-               d->partition_baseaddr = baseaddr;
-               d->partition_length = size;
-               d->partition_memaddr = memaddr;
-               d->partition_entryaddr = entryaddr;
-               strncpy(d->filename, file, sizeof(d->filename));
+       fw_layout_t* p;
 
-               im->part_count++;
+       p = &fw_layout_data[0];
+       while ((strlen(p->name) != 0) && (strncmp(p->name, board_name, sizeof(board_name)) != 0))
+               p++;
+       if (p->name == NULL) {
+               printf("BUG! Unable to find default fw layout!\n");
+               exit(-1);
        }
 
-       fclose(f);
+       printf("board = %s\n", p->name);
+       strcpy(kernel->partition_name, "kernel");
+       kernel->partition_index = 1;
+       kernel->partition_baseaddr = p->kern_start;
+       if ( (kernel->partition_length = filelength(kernelfile)) < 0) return (-1);
+       kernel->partition_memaddr = p->kern_entry;
+       kernel->partition_entryaddr = p->kern_entry;
+       strncpy(kernel->filename, kernelfile, sizeof(kernel->filename));
+
+       if (filelength(rootfsfile) + kernel->partition_length > p->firmware_max_length)
+               return (-2);
+
+       strcpy(rootfs->partition_name, "rootfs");
+       rootfs->partition_index = 2;
+       rootfs->partition_baseaddr = kernel->partition_baseaddr + kernel->partition_length;
+       rootfs->partition_length = p->firmware_max_length - kernel->partition_length;
+       rootfs->partition_memaddr = 0x00000000;
+       rootfs->partition_entryaddr = 0x00000000;
+       strncpy(rootfs->filename, rootfsfile, sizeof(rootfs->filename));
+
+printf("kernel: %d 0x%08x\n", kernel->partition_length, kernel->partition_baseaddr);
+printf("root: %d 0x%08x\n", rootfs->partition_length, rootfs->partition_baseaddr);
+       im->part_count = 2;
 
        return 0;
 }
 
 /**
- * Checks the availability and validity of all image components. 
+ * Checks the availability and validity of all image components.
  * Fills in stats member of the part_data structure.
  */
 static int validate_image_layout(image_info_t* im)
@@ -260,7 +288,7 @@ static int validate_image_layout(image_info_t* im)
                }
                if (d->stats.st_size > d->partition_length) {
                        ERROR("File '%s' too big (%d) - max size: 0x%08X (exceeds %lu bytes)\n",
-                                       d->filename, i, d->partition_length, 
+                                       d->filename, i, d->partition_length,
                                        d->stats.st_size - d->partition_length);
                        return -4;
                }
@@ -318,7 +346,7 @@ static int build_image(image_info_t* im)
 
        if (fwrite(mem, mem_size, 1, f) != 1)
        {
-               ERROR("Could not write %d bytes into file: '%s'\n", 
+               ERROR("Could not write %d bytes into file: '%s'\n",
                                mem_size, im->outputfile);
                return -11;
        }
@@ -331,12 +359,16 @@ static int build_image(image_info_t* im)
 
 int main(int argc, char* argv[])
 {
-       char inputfile[PATH_MAX];
+       char kernelfile[PATH_MAX];
+       char rootfsfile[PATH_MAX];
+       char board_name[PATH_MAX];
        int o, rc;
        image_info_t im;
 
        memset(&im, 0, sizeof(im));
-       memset(inputfile, 0, sizeof(inputfile));
+       memset(kernelfile, 0, sizeof(kernelfile));
+       memset(rootfsfile, 0, sizeof(rootfsfile));
+       memset(board_name, 0, sizeof(board_name));
 
        strcpy(im.outputfile, DEFAULT_OUTPUT_FILE);
        strcpy(im.version, DEFAULT_VERSION);
@@ -352,27 +384,43 @@ int main(int argc, char* argv[])
                        if (optarg)
                                strncpy(im.outputfile, optarg, sizeof(im.outputfile));
                        break;
-               case 'i':
-                       if (optarg)
-                               strncpy(inputfile, optarg, sizeof(inputfile));
-                       break;
                case 'h':
                        usage(argv[0]);
                        return -1;
+               case 'k':
+                       if (optarg)
+                               strncpy(kernelfile, optarg, sizeof(kernelfile));
+                       break;
+               case 'r':
+                       if (optarg)
+                               strncpy(rootfsfile, optarg, sizeof(rootfsfile));
+                       break;
+               case 'B':
+                       if (optarg)
+                               strncpy(board_name, optarg, sizeof(board_name));
+                       break;
                }
        }
+       if (strlen(board_name) == 0)
+               strcpy(board_name, "XS2"); /* default to XS2 */
+
+       if (strlen(kernelfile) == 0)
+       {
+               ERROR("Kernel file is not specified, cannot continue\n");
+               usage(argv[0]);
+               return -2;
+       }
 
-       if (strlen(inputfile) == 0)
+       if (strlen(rootfsfile) == 0)
        {
-               ERROR("Input file is not specified, cannot continue\n");
+               ERROR("Root FS file is not specified, cannot continue\n");
                usage(argv[0]);
                return -2;
        }
 
-       if ((rc = parse_image_layout(inputfile, &im)) != 0)
+       if ((rc = create_image_layout(kernelfile, rootfsfile, board_name, &im)) != 0)
        {
-               ERROR("Failed parsing firmware layout file '%s' - error code: %d\n", 
-                       inputfile, rc);
+               ERROR("Failed creating firmware layout description - error code: %d\n", rc);
                return -3;
        }