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