coreboot/util/cbfstool/common.c
<<
>>
Prefs
   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
  31uint32_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
  41void *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
  68struct cbfs_header *master_header;
  69uint32_t phys_start, phys_end, align, romsize;
  70void *offset;
  71
  72void 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
  84void *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
  93int 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
 112int cbfs_file_header(uint32_t physaddr)
 113{
 114        /* maybe improve this test */
 115        return (strncmp(phys_to_virt(physaddr), "LARCHIVE", 8) == 0);
 116}
 117
 118struct 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
 130int iself(unsigned char *input)
 131{
 132        Elf32_Ehdr *ehdr = (Elf32_Ehdr *) input;
 133        return !memcmp(ehdr->e_ident, ELFMAG, 4);
 134}
 135
 136struct 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_CMOS_DEFAULT, "cmos default"},
 149        {CBFS_COMPONENT_DELETED, "deleted"},
 150        {CBFS_COMPONENT_NULL, "null"}
 151};
 152
 153void print_supported_filetypes(void)
 154{
 155        int i, number = ARRAY_SIZE(filetypes);
 156
 157        for (i=0; i<number; i++) {
 158                printf(" %s%c", filetypes[i].name, (i==(number-1))?'\n':',');
 159                if ((i%8) == 7)
 160                        printf("\n");
 161        }
 162}
 163
 164const char *strfiletype(uint32_t number)
 165{
 166        int i;
 167        for (i = 0; i < (sizeof(filetypes) / sizeof(struct filetypes_t)); i++)
 168                if (filetypes[i].type == number)
 169                        return filetypes[i].name;
 170        return "unknown";
 171}
 172
 173uint64_t intfiletype(const char *name)
 174{
 175        int i;
 176        for (i = 0; i < (sizeof(filetypes) / sizeof(struct filetypes_t)); i++)
 177                if (strcmp(filetypes[i].name, name) == 0)
 178                        return filetypes[i].type;
 179        return -1;
 180}
 181
 182void print_cbfs_directory(const char *filename)
 183{
 184        printf
 185            ("%s: %d kB, bootblocksize %d, romsize %d, offset 0x%x\nAlignment: %d bytes\n\n",
 186             basename((char *)filename), romsize / 1024, ntohl(master_header->bootblocksize),
 187             romsize, ntohl(master_header->offset), align);
 188        printf("%-30s %-10s %-12s Size\n", "Name", "Offset", "Type");
 189        uint32_t current = phys_start;
 190        while (current < phys_end) {
 191                if (!cbfs_file_header(current)) {
 192                        current += align;
 193                        continue;
 194                }
 195                struct cbfs_file *thisfile =
 196                    (struct cbfs_file *)phys_to_virt(current);
 197                uint32_t length = ntohl(thisfile->len);
 198                char *fname = (char *)(phys_to_virt(current) + sizeof(struct cbfs_file));
 199                if (strlen(fname) == 0)
 200                        fname = "(empty)";
 201
 202                printf("%-30s 0x%-8x %-12s %d\n", fname,
 203                       current - phys_start, strfiletype(ntohl(thisfile->type)),
 204                       length);
 205                current =
 206                    ALIGN(current + ntohl(thisfile->len) +
 207                          ntohl(thisfile->offset), align);
 208        }
 209}
 210
 211int extract_file_from_cbfs(const char *filename, const char *payloadname, const char *outpath)
 212{
 213        // Identify the coreboot image.
 214        printf(
 215             "%s: %d kB, bootblocksize %d, romsize %d, offset 0x%x\nAlignment: %d bytes\n\n",
 216             basename((char *)filename), romsize / 1024, ntohl(master_header->bootblocksize),
 217             romsize, ntohl(master_header->offset), align);
 218
 219        FILE *outfile = NULL;
 220        uint32_t current = phys_start;
 221        while (current < phys_end) {
 222                if (!cbfs_file_header(current)) {
 223                        current += align;
 224                        continue;
 225                }
 226
 227                // Locate the file start struct
 228                struct cbfs_file *thisfile =
 229                    (struct cbfs_file *)phys_to_virt(current);
 230                // And its length
 231                uint32_t length = ntohl(thisfile->len);
 232                // Locate the file name
 233                char *fname = (char *)(phys_to_virt(current) + sizeof(struct cbfs_file));
 234                // It's not the file we are looking for..
 235                if (strcmp(fname, payloadname) != 0)
 236                {
 237                        current =
 238                           ALIGN(current + ntohl(thisfile->len) +
 239                                  ntohl(thisfile->offset), align);
 240                        continue;
 241                }
 242
 243                // Else, it's our file.
 244                printf("Found file %.30s at 0x%x, type %.12s, size %d\n", fname,
 245                       current - phys_start, strfiletype(ntohl(thisfile->type)),
 246                       length);
 247
 248                // If we are not dumping to stdout, open the out file.
 249                outfile = fopen(outpath, "wb");
 250                if (!outfile)
 251                {
 252                        printf("Could not open the file %s for writing. Aborting.\n", outpath);
 253                        return 1;
 254                }
 255
 256                if (ntohl(thisfile->type) != CBFS_COMPONENT_RAW)
 257                {
 258                        printf("Warning: only 'raw' files are safe to extract.\n");
 259                }
 260
 261                fwrite(((char *)thisfile)
 262                                + ntohl(thisfile->offset), length, 1, outfile);
 263
 264                fclose(outfile);
 265                printf("Successfully dumped the file.\n");
 266
 267                // We'll only dump one file.
 268                return 0;
 269        }
 270
 271}
 272
 273
 274int add_file_to_cbfs(void *content, uint32_t contentsize, uint32_t location)
 275{
 276        uint32_t current = phys_start;
 277        while (current < phys_end) {
 278                if (!cbfs_file_header(current)) {
 279                        current += align;
 280                        continue;
 281                }
 282                struct cbfs_file *thisfile =
 283                    (struct cbfs_file *)phys_to_virt(current);
 284                uint32_t length = ntohl(thisfile->len);
 285
 286                dprintf("at %x, %x bytes\n", current, length);
 287                /* Is this a free chunk? */
 288                if ((thisfile->type == CBFS_COMPONENT_DELETED)
 289                    || (thisfile->type == CBFS_COMPONENT_NULL)) {
 290                        dprintf("null||deleted at %x, %x bytes\n", current,
 291                                length);
 292                        /* if this is the right size, and if specified, the right location, use it */
 293                        if ((contentsize <= length)
 294                            && ((location == 0) || (current == location))) {
 295                                if (contentsize < length) {
 296                                        dprintf
 297                                            ("this chunk is %x bytes, we need %x. create a new chunk at %x with %x bytes\n",
 298                                             length, contentsize,
 299                                             ALIGN(current + contentsize,
 300                                                   align),
 301                                             length - contentsize);
 302                                        uint32_t start =
 303                                            ALIGN(current + contentsize, align);
 304                                        uint32_t size =
 305                                            current + ntohl(thisfile->offset)
 306                                            + length - start - 16 -
 307                                            sizeof(struct cbfs_file);
 308                                        cbfs_create_empty_file(start, size);
 309                                }
 310                                dprintf("copying data\n");
 311                                memcpy(phys_to_virt(current), content,
 312                                       contentsize);
 313                                return 0;
 314                        }
 315                        if (location != 0) {
 316                                /* CBFS has the constraint that the chain always moves up in memory. so once
 317                                   we're past the place we seek, we don't need to look any further */
 318                                if (current > location) {
 319                                        printf
 320                                            ("the requested space is not available\n");
 321                                        return 1;
 322                                }
 323
 324                                /* Is the requested location inside the current chunk? */
 325                                if ((current < location)
 326                                    && ((location + contentsize) <=
 327                                        (current + length))) {
 328                                        /* Split it up. In the next iteration the code will be at the right place. */
 329                                        dprintf("split up. new length: %x\n",
 330                                                location - current -
 331                                                ntohl(thisfile->offset));
 332                                        thisfile->len =
 333                                            htonl(location - current -
 334                                                  ntohl(thisfile->offset));
 335                                        struct cbfs_file *nextfile =
 336                                            cbfs_create_empty_file(location,
 337                                                                   length -
 338                                                                   (location -
 339                                                                    current));
 340                                }
 341                        }
 342                }
 343                current =
 344                    ALIGN(current + ntohl(thisfile->len) +
 345                          ntohl(thisfile->offset), align);
 346        }
 347        printf("Could not add the file to CBFS, it's probably too big.\n");
 348        printf("File size: %d bytes (%d KB).\n", contentsize, contentsize/1024);
 349        return 1;
 350}
 351
 352/* returns new data block with cbfs_file header, suitable to dump into the ROM. location returns
 353   the new location that points to the cbfs_file header */
 354void *create_cbfs_file(const char *filename, void *data, uint32_t * datasize,
 355                       uint32_t type, uint32_t * location)
 356{
 357        uint32_t filename_len = ALIGN(strlen(filename) + 1, 16);
 358        uint32_t headersize = sizeof(struct cbfs_file) + filename_len;
 359        if ((location != 0) && (*location != 0)) {
 360                uint32_t offset = *location % align;
 361                /* If offset >= (headersize % align), we can stuff the header into the offset.
 362                   Otherwise the header has to be aligned itself, and put before the offset data */
 363                if (offset >= (headersize % align)) {
 364                        offset -= (headersize % align);
 365                } else {
 366                        offset += align - (headersize % align);
 367                }
 368                headersize += offset;
 369                *location -= headersize;
 370        }
 371        void *newdata = malloc(*datasize + headersize);
 372        if (!newdata) {
 373                printf("Could not get %d bytes for CBFS file.\n", *datasize +
 374                       headersize);
 375                exit(1);
 376        }
 377        memset(newdata, 0xff, *datasize + headersize);
 378        struct cbfs_file *nextfile = (struct cbfs_file *)newdata;
 379        strncpy(nextfile->magic, "LARCHIVE", 8);
 380        nextfile->len = htonl(*datasize);
 381        nextfile->type = htonl(type);
 382        nextfile->checksum = 0; // FIXME?
 383        nextfile->offset = htonl(headersize);
 384        strcpy(newdata + sizeof(struct cbfs_file), filename);
 385        memcpy(newdata + headersize, data, *datasize);
 386        *datasize += headersize;
 387        return newdata;
 388}
 389
 390int create_cbfs_image(const char *romfile, uint32_t _romsize,
 391                      const char *bootblock, uint32_t align)
 392{
 393        romsize = _romsize;
 394        unsigned char *romarea = malloc(romsize);
 395        if (!romarea) {
 396                printf("Could not get %d bytes of memory for CBFS image.\n",
 397                       romsize);
 398                exit(1);
 399        }
 400        memset(romarea, 0xff, romsize);
 401
 402        // Set up physical/virtual mapping
 403        offset = romarea + romsize - 0x100000000ULL;
 404
 405        if (align == 0)
 406                align = 64;
 407
 408        uint32_t bootblocksize = 0;
 409        loadfile(bootblock, &bootblocksize, romarea + romsize, SEEK_END);
 410        struct cbfs_header *master_header =
 411            (struct cbfs_header *)(romarea + romsize - bootblocksize -
 412                                   sizeof(struct cbfs_header));
 413        master_header->magic = ntohl(0x4f524243);
 414        master_header->version = ntohl(0x31313131);
 415        master_header->romsize = htonl(romsize);
 416        master_header->bootblocksize = htonl(bootblocksize);
 417        master_header->align = htonl(align);
 418        master_header->offset = htonl(0);
 419        ((uint32_t *) phys_to_virt(0xfffffffc))[0] =
 420            virt_to_phys(master_header);
 421
 422        recalculate_rom_geometry(romarea);
 423
 424        struct cbfs_file *one_empty_file =
 425            cbfs_create_empty_file((0 - romsize) & 0xffffffff,
 426                                   romsize - bootblocksize -
 427                                   sizeof(struct cbfs_header) -
 428                                   sizeof(struct cbfs_file) - 16);
 429
 430        writerom(romfile, romarea, romsize);
 431        return 0;
 432}
 433
 434static int in_segment(int addr, int size, int gran)
 435{
 436        return ((addr & ~(gran - 1)) == ((addr + size) & ~(gran - 1)));
 437}
 438
 439uint32_t cbfs_find_location(const char *romfile, uint32_t filesize,
 440                            const char *filename, uint32_t alignment)
 441{
 442        void *rom = loadrom(romfile);
 443        int filename_size = strlen(filename);
 444
 445        int headersize =
 446            sizeof(struct cbfs_file) + ALIGN(filename_size + 1,
 447                                             16) + sizeof(struct cbfs_stage);
 448        int totalsize = headersize + filesize;
 449
 450        uint32_t current = phys_start;
 451        while (current < phys_end) {
 452                if (!cbfs_file_header(current)) {
 453                        current += align;
 454                        continue;
 455                }
 456                struct cbfs_file *thisfile =
 457                    (struct cbfs_file *)phys_to_virt(current);
 458
 459                uint32_t top =
 460                    current + ntohl(thisfile->len) + ntohl(thisfile->offset);
 461                if (((ntohl(thisfile->type) == 0x0)
 462                     || (ntohl(thisfile->type) == 0xffffffff))
 463                    && (ntohl(thisfile->len) + ntohl(thisfile->offset) >=
 464                        totalsize)) {
 465                        if (in_segment
 466                            (current + headersize, filesize, alignment))
 467                                return current + headersize;
 468                        if ((ALIGN(current, alignment) + filesize < top)
 469                            && (ALIGN(current, alignment) - headersize >
 470                                current)
 471                            && in_segment(ALIGN(current, alignment), filesize,
 472                                          alignment))
 473                                return ALIGN(current, alignment);
 474                        if ((ALIGN(current, alignment) + alignment + filesize <
 475                             top)
 476                            && (ALIGN(current, alignment) + alignment -
 477                                headersize > current)
 478                            && in_segment(ALIGN(current, alignment) + alignment,
 479                                          filesize, alignment))
 480                                return ALIGN(current, alignment) + alignment;
 481                }
 482                current =
 483                    ALIGN(current + ntohl(thisfile->len) +
 484                          ntohl(thisfile->offset), align);
 485        }
 486        return 0;
 487}
 488
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.