util/cbfstool/common.c

   1 /*
   2  * common utility functions for cbfstool
   3  *
   4  * Copyright (C) 2009 coresystems GmbH
   5  *                 written by Patrick Georgi <patrick.georgi@coresystems.de>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; version 2 of the License.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA
  19  */
  20
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <libgen.h>
  25 #include "common.h"
  26 #include "cbfs.h"
  27 #include "elf.h"
  28
  29 #define dprintf
  30
  31 uint32_t getfilesize(const char *filename)
  32 {
  33         uint32_t size;
  34         FILE *file = fopen(filename, "rb");
  35         fseek(file, 0, SEEK_END);
  36         size = ftell(file);
  37         fclose(file);
  38         return size;
  39 }
  40
  41 void *loadfile(const char *filename, uint32_t * romsize_p, void *content,
  42                int place)
  43 {
  44         FILE *file = fopen(filename, "rb");
  45         if (file == NULL)
  46                 return NULL;
  47         fseek(file, 0, SEEK_END);
  48         *romsize_p = ftell(file);
  49         fseek(file, 0, SEEK_SET);
  50         if (!content) {
  51                 content = malloc(*romsize_p);
  52                 if (!content) {
  53                         printf("Could not get %d bytes for file %s\n",
  54                                *romsize_p, filename);
  55                         exit(1);
  56                 }
  57         } else if (place == SEEK_END)
  58                 content -= *romsize_p;
  59
  60         if (!fread(content, *romsize_p, 1, file)) {
  61                 printf("failed to read %s\n", filename);
  62                 return NULL;
  63         }
  64         fclose(file);
  65         return content;
  66 }
  67
  68 struct cbfs_header *master_header;
  69 uint32_t phys_start, phys_end, align, romsize;
  70 void *offset;
  71
  72 void recalculate_rom_geometry(void *romarea)
  73 {
  74         offset = romarea + romsize - 0x100000000ULL;
  75         master_header = (struct cbfs_header *)
  76             phys_to_virt(*((uint32_t *) phys_to_virt(0xfffffffc)));
  77         phys_start = (0 - romsize + ntohl(master_header->offset)) & 0xffffffff;
  78         phys_end =
  79             (0 - ntohl(master_header->bootblocksize) -
  80              sizeof(struct cbfs_header)) & 0xffffffff;
  81         align = ntohl(master_header->align);
  82 }
  83
  84 void *loadrom(const char *filename)
  85 {
  86         void *romarea = loadfile(filename, &romsize, 0, SEEK_SET);
  87         if (romarea == NULL)
  88                 return NULL;
  89         recalculate_rom_geometry(romarea);
  90         return romarea;
  91 }
  92
  93 int writerom(const char *filename, void *start, uint32_t size)
  94 {
  95         FILE *file = fopen(filename, "wb");
  96         if (!file) {
  97                 fprintf(stderr, "Could not open '%s' for writing: ", filename);
  98                 perror("");
  99                 return 1;
 100         }
 101
 102         if (fwrite(start, size, 1, file) != 1) {
 103                 fprintf(stderr, "Could not write to '%s': ", filename);
 104                 perror("");
 105                 return 1;
 106         }
 107
 108         fclose(file);
 109         return 0;
 110 }
 111
 112 int cbfs_file_header(uint32_t physaddr)
 113 {
 114         /* maybe improve this test */
 115         return (strncmp(phys_to_virt(physaddr), "LARCHIVE", 8) == 0);
 116 }
 117
 118 struct cbfs_file *cbfs_create_empty_file(uint32_t physaddr, uint32_t size)
 119 {
 120         struct cbfs_file *nextfile = (struct cbfs_file *)phys_to_virt(physaddr);
 121         strncpy(nextfile->magic, "LARCHIVE", 8);
 122         nextfile->len = htonl(size);
 123         nextfile->type = htonl(0xffffffff);
 124         nextfile->checksum = 0; // FIXME?
 125         nextfile->offset = htonl(sizeof(struct cbfs_file) + 16);
 126         memset(((void *)nextfile) + sizeof(struct cbfs_file), 0, 16);
 127         return nextfile;
 128 }
 129
 130 int iself(unsigned char *input)
 131 {
 132         Elf32_Ehdr *ehdr = (Elf32_Ehdr *) input;
 133         return !memcmp(ehdr->e_ident, ELFMAG, 4);
 134 }
 135
 136 struct filetypes_t {
 137         uint32_t type;
 138         const char *name;
 139 } filetypes[] = {
 140         {CBFS_COMPONENT_STAGE, "stage"},
 141         {CBFS_COMPONENT_PAYLOAD, "payload"},
 142         {CBFS_COMPONENT_OPTIONROM, "optionrom"},
 143         {CBFS_COMPONENT_BOOTSPLASH, "bootsplash"},
 144         {CBFS_COMPONENT_RAW, "raw"},
 145         {CBFS_COMPONENT_VSA, "vsa"},
 146         {CBFS_COMPONENT_MBI, "mbi"},
 147         {CBFS_COMPONENT_MICROCODE, "microcode"},
 148         {CBFS_COMPONENT_DELETED, "deleted"},
 149         {CBFS_COMPONENT_NULL, "null"}
 150 };
 151
 152 void print_supported_filetypes(void)
 153 {
 154         int i, number = ARRAY_SIZE(filetypes);
 155
 156         for (i=0; i<number; i++) {
 157                 printf(" %s%c", filetypes[i].name, (i==(number-1))?'\n':',');
 158                 if ((i%8) == 7)
 159                         printf("\n");
 160         }
 161 }
 162
 163 const char *strfiletype(uint32_t number)
 164 {
 165         int i;
 166         for (i = 0; i < (sizeof(filetypes) / sizeof(struct filetypes_t)); i++)
 167                 if (filetypes[i].type == number)
 168                         return filetypes[i].name;
 169         return "unknown";
 170 }
 171
 172 uint64_t intfiletype(const char *name)
 173 {
 174         int i;
 175         for (i = 0; i < (sizeof(filetypes) / sizeof(struct filetypes_t)); i++)
 176                 if (strcmp(filetypes[i].name, name) == 0)
 177                         return filetypes[i].type;
 178         return -1;
 179 }
 180
 181 void print_cbfs_directory(const char *filename)
 182 {
 183         printf
 184             ("%s: %d kB, bootblocksize %d, romsize %d, offset 0x%x\nAlignment: %d bytes\n\n",
 185              basename((char *)filename), romsize / 1024, ntohl(master_header->bootblocksize),
 186              romsize, ntohl(master_header->offset), align);
 187         printf("%-30s %-10s %-12s Size\n", "Name", "Offset", "Type");
 188         uint32_t current = phys_start;
 189         while (current < phys_end) {
 190                 if (!cbfs_file_header(current)) {
 191                         current += align;
 192                         continue;
 193                 }
 194                 struct cbfs_file *thisfile =
 195                     (struct cbfs_file *)phys_to_virt(current);
 196                 uint32_t length = ntohl(thisfile->len);
 197                 char *fname = (char *)(phys_to_virt(current) + sizeof(struct cbfs_file));
 198                 if (strlen(fname) == 0)
 199                         fname = "(empty)";
 200
 201                 printf("%-30s 0x%-8x %-12s %d\n", fname,
 202                        current - phys_start, strfiletype(ntohl(thisfile->type)),
 203                        length);
 204                 current =
 205                     ALIGN(current + ntohl(thisfile->len) +
 206                           ntohl(thisfile->offset), align);
 207         }
 208 }
 209
 210 int extract_file_from_cbfs(const char *filename, const char *payloadname, const char *outpath)
 211 {
 212         // Identify the coreboot image.
 213         printf(
 214              "%s: %d kB, bootblocksize %d, romsize %d, offset 0x%x\nAlignment: %d bytes\n\n",
 215              basename((char *)filename), romsize / 1024, ntohl(master_header->bootblocksize),
 216              romsize, ntohl(master_header->offset), align);
 217
 218         FILE *outfile = NULL;
 219         uint32_t current = phys_start;
 220         while (current < phys_end) {
 221                 if (!cbfs_file_header(current)) {
 222                         current += align;
 223                         continue;
 224                 }
 225
 226                 // Locate the file start struct
 227                 struct cbfs_file *thisfile =
 228                     (struct cbfs_file *)phys_to_virt(current);
 229                 // And its length
 230                 uint32_t length = ntohl(thisfile->len);
 231                 // Locate the file name
 232                 char *fname = (char *)(phys_to_virt(current) + sizeof(struct cbfs_file));
 233                 // It's not the file we are looking for..
 234                 if (strcmp(fname, payloadname) != 0)
 235                 {
 236                         current =
 237                            ALIGN(current + ntohl(thisfile->len) +
 238                                   ntohl(thisfile->offset), align);
 239                         continue;
 240                 }
 241
 242                 // Else, it's our file.
 243                 printf("Found %.30s payload at 0x%x, type %.12s, size %d\n", fname,
 244                        current - phys_start, strfiletype(ntohl(thisfile->type)),
 245                        length);
 246
 247                 // If we are not dumping to stdout, open the out file.
 248                 outfile = fopen(outpath, "wb");
 249                 if (!outfile)
 250                 {
 251                         printf("Could not open the file %s for writing. Aborting.\n", outpath);
 252                         return 1;
 253                 }
 254
 255                 if (ntohl(thisfile->type) != CBFS_COMPONENT_RAW)
 256                 {
 257                         printf("Warning: only 'raw' files are safe to extract.\n");
 258                 }
 259
 260                 fwrite(((char *)thisfile)
 261                                 + ntohl(thisfile->offset), length, 1, outfile);
 262
 263                 fclose(outfile);
 264                 printf("Successfully dumped the payload.\n");
 265
 266                 // We'll only dump one file.
 267                 return 0;
 268         }
 269
 270 }
 271
 272
 273 int add_file_to_cbfs(void *content, uint32_t contentsize, uint32_t location)
 274 {
 275         uint32_t current = phys_start;
 276         while (current < phys_end) {
 277                 if (!cbfs_file_header(current)) {
 278                         current += align;
 279                         continue;
 280                 }
 281                 struct cbfs_file *thisfile =
 282                     (struct cbfs_file *)phys_to_virt(current);
 283                 uint32_t length = ntohl(thisfile->len);
 284
 285                 dprintf("at %x, %x bytes\n", current, length);
 286                 /* Is this a free chunk? */
 287                 if ((thisfile->type == CBFS_COMPONENT_DELETED)
 288                     || (thisfile->type == CBFS_COMPONENT_NULL)) {
 289                         dprintf("null||deleted at %x, %x bytes\n", current,
 290                                 length);
 291                         /* if this is the right size, and if specified, the right location, use it */
 292                         if ((contentsize <= length)
 293                             && ((location == 0) || (current == location))) {
 294                                 if (contentsize < length) {
 295                                         dprintf
 296                                             ("this chunk is %x bytes, we need %x. create a new chunk at %x with %x bytes\n",
 297                                              length, contentsize,
 298                                              ALIGN(current + contentsize,
 299                                                    align),
 300                                              length - contentsize);
 301                                         uint32_t start =
 302                                             ALIGN(current + contentsize, align);
 303                                         uint32_t size =
 304                                             current + ntohl(thisfile->offset)
 305                                             + length - start - 16 -
 306                                             sizeof(struct cbfs_file);
 307                                         cbfs_create_empty_file(start, size);
 308                                 }
 309                                 dprintf("copying data\n");
 310                                 memcpy(phys_to_virt(current), content,
 311                                        contentsize);
 312                                 return 0;
 313                         }
 314                         if (location != 0) {
 315                                 /* CBFS has the constraint that the chain always moves up in memory. so once
 316                                    we're past the place we seek, we don't need to look any further */
 317                                 if (current > location) {
 318                                         printf
 319                                             ("the requested space is not available\n");
 320                                         return 1;
 321                                 }
 322
 323                                 /* Is the requested location inside the current chunk? */
 324                                 if ((current < location)
 325                                     && ((location + contentsize) <=
 326                                         (current + length))) {
 327                                         /* Split it up. In the next iteration the code will be at the right place. */
 328                                         dprintf("split up. new length: %x\n",
 329                                                 location - current -
 330                                                 ntohl(thisfile->offset));
 331                                         thisfile->len =
 332                                             htonl(location - current -
 333                                                   ntohl(thisfile->offset));
 334                                         struct cbfs_file *nextfile =
 335                                             cbfs_create_empty_file(location,
 336                                                                    length -
 337                                                                    (location -
 338                                                                     current));
 339                                 }
 340                         }
 341                 }
 342                 current =
 343                     ALIGN(current + ntohl(thisfile->len) +
 344                           ntohl(thisfile->offset), align);
 345         }
 346         printf("Could not add the file to CBFS, it's probably too big.\n");
 347         printf("File size: %d bytes (%d KB).\n", contentsize, contentsize/1024);
 348         return 1;
 349 }
 350
 351 /* returns new data block with cbfs_file header, suitable to dump into the ROM. location returns
 352    the new location that points to the cbfs_file header */
 353 void *create_cbfs_file(const char *filename, void *data, uint32_t * datasize,
 354                        uint32_t type, uint32_t * location)
 355 {
 356         uint32_t filename_len = ALIGN(strlen(filename) + 1, 16);
 357         uint32_t headersize = sizeof(struct cbfs_file) + filename_len;
 358         if ((location != 0) && (*location != 0)) {
 359                 uint32_t offset = *location % align;
 360                 /* If offset >= (headersize % align), we can stuff the header into the offset.
 361                    Otherwise the header has to be aligned itself, and put before the offset data */
 362                 if (offset >= (headersize % align)) {
 363                         offset -= (headersize % align);
 364                 } else {
 365                         offset += align - (headersize % align);
 366                 }
 367                 headersize += offset;
 368                 *location -= headersize;
 369         }
 370         void *newdata = malloc(*datasize + headersize);
 371         if (!newdata) {
 372                 printf("Could not get %d bytes for CBFS file.\n", *datasize +
 373                        headersize);
 374                 exit(1);
 375         }
 376         memset(newdata, 0xff, *datasize + headersize);
 377         struct cbfs_file *nextfile = (struct cbfs_file *)newdata;
 378         strncpy(nextfile->magic, "LARCHIVE", 8);
 379         nextfile->len = htonl(*datasize);
 380         nextfile->type = htonl(type);
 381         nextfile->checksum = 0; // FIXME?
 382         nextfile->offset = htonl(headersize);
 383         strcpy(newdata + sizeof(struct cbfs_file), filename);
 384         memcpy(newdata + headersize, data, *datasize);
 385         *datasize += headersize;
 386         return newdata;
 387 }
 388
 389 int create_cbfs_image(const char *romfile, uint32_t _romsize,
 390                       const char *bootblock, uint32_t align)
 391 {
 392         romsize = _romsize;
 393         unsigned char *romarea = malloc(romsize);
 394         if (!romarea) {
 395                 printf("Could not get %d bytes of memory for CBFS image.\n",
 396                        romsize);
 397                 exit(1);
 398         }
 399         memset(romarea, 0xff, romsize);
 400
 401         // Set up physical/virtual mapping
 402         offset = romarea + romsize - 0x100000000ULL;
 403
 404         if (align == 0)
 405                 align = 64;
 406
 407         uint32_t bootblocksize = 0;
 408         loadfile(bootblock, &bootblocksize, romarea + romsize, SEEK_END);
 409         struct cbfs_header *master_header =
 410             (struct cbfs_header *)(romarea + romsize - bootblocksize -
 411                                    sizeof(struct cbfs_header));
 412         master_header->magic = ntohl(0x4f524243);
 413         master_header->version = ntohl(0x31313131);
 414         master_header->romsize = htonl(romsize);
 415         master_header->bootblocksize = htonl(bootblocksize);
 416         master_header->align = htonl(align);
 417         master_header->offset = htonl(0);
 418         ((uint32_t *) phys_to_virt(0xfffffffc))[0] =
 419             virt_to_phys(master_header);
 420
 421         recalculate_rom_geometry(romarea);
 422
 423         struct cbfs_file *one_empty_file =
 424             cbfs_create_empty_file((0 - romsize) & 0xffffffff,
 425                                    romsize - bootblocksize -
 426                                    sizeof(struct cbfs_header) -
 427                                    sizeof(struct cbfs_file) - 16);
 428
 429         writerom(romfile, romarea, romsize);
 430         return 0;
 431 }
 432
 433 static int in_segment(int addr, int size, int gran)
 434 {
 435         return ((addr & ~(gran - 1)) == ((addr + size) & ~(gran - 1)));
 436 }
 437
 438 uint32_t cbfs_find_location(const char *romfile, uint32_t filesize,
 439                             const char *filename, uint32_t alignment)
 440 {
 441         void *rom = loadrom(romfile);
 442         int filename_size = strlen(filename);
 443
 444         int headersize =
 445             sizeof(struct cbfs_file) + ALIGN(filename_size + 1,
 446                                              16) + sizeof(struct cbfs_stage);
 447         int totalsize = headersize + filesize;
 448
 449         uint32_t current = phys_start;
 450         while (current < phys_end) {
 451                 if (!cbfs_file_header(current)) {
 452                         current += align;
 453                         continue;
 454                 }
 455                 struct cbfs_file *thisfile =
 456                     (struct cbfs_file *)phys_to_virt(current);
 457
 458                 uint32_t top =
 459                     current + ntohl(thisfile->len) + ntohl(thisfile->offset);
 460                 if (((ntohl(thisfile->type) == 0x0)
 461                      || (ntohl(thisfile->type) == 0xffffffff))
 462                     && (ntohl(thisfile->len) + ntohl(thisfile->offset) >=
 463                         totalsize)) {
 464                         if (in_segment
 465                             (current + headersize, filesize, alignment))
 466                                 return current + headersize;
 467                         if ((ALIGN(current, alignment) + filesize < top)
 468                             && (ALIGN(current, alignment) - headersize >
 469                                 current)
 470                             && in_segment(ALIGN(current, alignment), filesize,
 471                                           alignment))
 472                                 return ALIGN(current, alignment);
 473                         if ((ALIGN(current, alignment) + alignment + filesize <
 474                              top)
 475                             && (ALIGN(current, alignment) + alignment -
 476                                 headersize > current)
 477                             && in_segment(ALIGN(current, alignment) + alignment,
 478                                           filesize, alignment))
 479                                 return ALIGN(current, alignment) + alignment;
 480                 }
 481                 current =
 482                     ALIGN(current + ntohl(thisfile->len) +
 483                           ntohl(thisfile->offset), align);
 484         }
 485         return 0;
 486 }