coreboot-kgpe-d16/util/cbfstool/util.c

277 lines
6.0 KiB
C
Raw Normal View History

/*
* cbfstool
*
* Copyright (C) 2008 Jordan Crouse <jordan@cosmicpenguin.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA
*/
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <sys/mman.h>
#include "cbfstool.h"
int uninitialized_flash_value = 0xff;
void flashinit(void *ptr, size_t len)
{
memset(ptr, uninitialized_flash_value, len);
}
int get_size(const char *size)
{
char *next;
int val = strtoul(size, &next, 0);
/* Support modifiers for the size kK and mM for kbytes and
mbytes respectfully */
if (next != NULL) {
if (*next == 'k' || *next == 'K')
val *= 1024;
else if (*next == 'm' || *next == 'M')
val *= (1024 * 1024);
}
return val;
}
int copy_from_fd(int fd, void *ptr, int size)
{
unsigned char *p = ptr;
while (size > 0) {
int ret = read(fd, p, size);
if (ret == -1) {
ERROR("Error while reading: %m\n");
return -1;
}
if (ret == 0) {
ERROR("Unexpected end of file\n");
return -1;
}
p += ret;
size -= ret;
}
return 0;
}
int size_and_open(const char *filename, unsigned int *size)
{
struct stat s;
int fd = open(filename, O_RDONLY);
if (fd == -1) {
ERROR("Unable to open %s: %m\n", filename);
return -1;
}
if (fstat(fd, &s)) {
ERROR("Unable to stat %s: %m\n", filename);
close(fd);
return -1;
}
*size = s.st_size;
return fd;
}
int map_rom(struct rom *rom, int size)
{
rom->ptr = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED,
rom->fd, 0);
if (rom->ptr == MAP_FAILED) {
ERROR("Could not map the rom: %m\n");
rom->ptr = NULL;
return -1;
}
return 0;
}
int open_rom(struct rom *rom, const char *filename)
{
struct stat s;
unsigned long offset;
if (stat(filename, &s)) {
ERROR("Could not stat %s: %m\n", filename);
return -1;
}
rom->fd = open(filename, O_RDWR);
if (rom->fd == -1) {
ERROR("Could not open %s: %m\n", filename);
rom->fd = 0;
return -1;
}
if (map_rom(rom, s.st_size))
goto err;
/* Find the master header */
offset = ROM_READL(rom, s.st_size - 4);
rom->header = (struct cbfs_header *)
ROM_PTR(rom, s.st_size - (0xFFFFFFFF - offset) - 1);
if (ntohl(rom->header->magic) != HEADER_MAGIC) {
ERROR("This does not appear to be a valid ROM\n");
goto err;
}
/* Check that the alignment is correct */
if (ntohl(rom->header->align) == 0) {
ERROR("The alignment in the ROM is 0 - probably malformed\n");
goto err;
}
/* Sanity check that the size matches the file size */
if (ntohl(rom->header->romsize) != s.st_size) {
ERROR("The ROM size in the header does not match the file\n");
ERROR("ROM size is %d bytes, file size is %d bytes\n",
ntohl(rom->header->romsize), (unsigned int)s.st_size);
goto err;
}
rom->size = ntohl(rom->header->romsize);
This is transition code for cbfs to implement cbfs files at fixed addresses. I call this transitional as the approach I am taking is to add capability to cbfstool but not change code in a way that will break existing usages. Later, once we're sure nothing has broken, we can start to smooth the edges. Right now, fixed address file are only supported via the add command. There is one additional command syntax, so, example: cbfstool add rom romstrap optionrom 0xffffd000 Will add the file to that fix location for a romstrap. The assumption is that the ROM is based at the end of a 32-bit address space. As you can see from the code, that assumption can easily be over-ridden, if we ever need to, with a command option. Here is one example output result. rminnich@xcpu2:~/src/bios/coreboot-v2/util/cbfstool$ ./cbfstool x.cbf print x.cbf: 1024 kB, bootblocksize 32768, romsize 1048576, offset 0x0 Alignment: 16 bytes Name Offset Type Size h 0x0 optionrom 251 0x130 free 917120 h3 0xdffe0 optionrom 251 0xe0110 free 97960 The way this is implemented is pretty simple. I introduce a new operator, split, that splits an unallocated area into two unallocated areas. Then, allocation merely becomes a matter of 0, 1, or 2 splits: 0 split -- the free area is the exact fit 1 splits -- need to split some off the front or back 2 splits -- need to split off BOTH the front and back I think you'll be able to see what I've done. I call this transitional because, in the end state, we only need one allocate function; for now I've left two in, to make sure I don't break compatibilty. Why I like this better than ldscript approach: I like having the ROMSTRAP located by cbfs, not linker scripts. For one thing, it makes romstrap visible as a first class object. I think I would have latched onto a problem I was having much more quickly had I remembered the ROMSTRAP. It gets lost in the linker scripts. At this point, we should be able to start removing special ROMSTRAP location code from linker scripts. Signed-off-by: Ronald G. Minnich <rminnich@gmail.com> Acked-by: Patrick Georgi <patrick.georgi@coresystems.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4351 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2009-06-08 05:33:57 +02:00
/* compute a 32-bit value of rombase.
* This does the right thing on 64-bit machines.
*/
rom->rombase = 0-rom->size;
rom->rombase &= 0xffffffff;
rom->fssize = rom->size - ntohl(rom->header->bootblocksize);
return 0;
err:
if (rom->ptr != NULL)
munmap(rom->ptr, s.st_size);
if (rom->fd > 0)
close(rom->fd);
rom->ptr = NULL;
rom->fd = 0;
return -1;
}
int create_rom(struct rom *rom, const unsigned char *filename,
int romsize, const char *bootblockname,
int bootblocksize, int align)
{
unsigned char null = '\0';
if (rom->fd != 0) {
ERROR("%s already exists - cannot create\n", filename);
return -1;
}
/* Remember the size of the entire ROM */
rom->size = romsize;
/* The size of the archive section is everything but the bootblock and
* the cbfs master header. */
rom->fssize = romsize - bootblocksize - sizeof(struct cbfs_header);
/* Open the file descriptor */
rom->fd = open((char *)filename, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
if (rom->fd == -1) {
ERROR("Could not create %s: %m\n", filename);
return -1;
}
/* Size the new file appropriately */
lseek(rom->fd, romsize - 1, SEEK_SET);
write(rom->fd, &null, 1);
if (map_rom(rom, romsize)) {
close(rom->fd);
return -1;
}
/* mmap'ed pages are by default zero-filled. Fix that. */
flashinit(rom->ptr, romsize);
/* This is a pointer to the header for easy access */
rom->header = (struct cbfs_header *)
ROM_PTR(rom, rom->size - 16 - bootblocksize - sizeof(struct cbfs_header));
rom->header->magic = htonl(HEADER_MAGIC);
rom->header->romsize = htonl(romsize);
rom->header->bootblocksize = htonl(bootblocksize);
rom->header->align = htonl(align);
rom->header->offset = htonl(0);
if (add_bootblock(rom, bootblockname) == -1)
return -1;
/* Write the cbfs master header address at the end of the ROM. */
ROM_WRITEL(rom, rom->size - 4,
0xFFFFFFF0 - bootblocksize - sizeof(struct cbfs_header));
I have made a very simple mod to cbfstool that is compatible with the src/lib/ code in coreboot. I.e. the tool changes but the coreboot code does not. Currently, as cbfstool manages the ROM, there are files and empty space. To allocate files, the code does, first, a walk of the headers and, if that fails, does a brute-force search of the rest of the space. We all agree that the brute-force search has lots of problems from a performance and correctness standpoint. I've made a slight change. Instead of an "empty space" area with no valid headers, I've made a header for the empty space. So cbfs creation looks like this: - set up the boot block - create a file, of type CBFS_COMPONENT_NULL, that contains the empty space. CBFS_COMPONENT_NULL was already defined in cbfs.h Here's an example: [rminnich@xcpu2 cbfstool]$ ./cbfstool testcbfs create 1048576 2048 (cbfstool) E: Unable to open (null): Bad address [rminnich@xcpu2 cbfstool]$ ./cbfstool testcbfs print testcbfs: 1024 kB, bootblocksize 2048, romsize 1048576, offset 0x0 Alignment: 16 bytes Name Offset Type Size 0x0 0xffffffff 1046456 So how do we create a new file? It's easy: walk the files and find a file of type CBFS_COMPONENT_NULL, which is as large or larger than the file you are trying to create. Then you use that file. - if the file is the same size as the NULL file, then it's easy: take it - if the file is smaller than the NULL file, you split the NULL file into two parts. note that this works in the base case: the base case is that the whole storage is CBFS_COMPONENT_NULL. Here's an example of adding a file. [rminnich@xcpu2 cbfstool]$ ./cbfstool testcbfs add-stage testfixed t [rminnich@xcpu2 cbfstool]$ ./cbfstool testcbfs print testcbfs: 1024 kB, bootblocksize 2048, romsize 1048576, offset 0x0 Alignment: 16 bytes Name Offset Type Size t 0x0 stage 23176 0x5ab0 0xffffffff 1023240 Note that the NULL split and got smaller. But the entire ROM is still contained by the two files. To walk this entire rom will require two FLASH accesses. Add another file: [rminnich@xcpu2 cbfstool]$ ./cbfstool testcbfs add-stage testfixed tt [rminnich@xcpu2 cbfstool]$ ./cbfstool testcbfs print testcbfs: 1024 kB, bootblocksize 2048, romsize 1048576, offset 0x0 Alignment: 16 bytes Name Offset Type Size t 0x0 stage 23176 tt 0x5ab0 stage 23176 0xb560 0xffffffff 1000024 [rminnich@xcpu2 cbfstool]$ So, taking current ROMs as an example, I can reduce FLASH accesses for cbfs from (potentially) thousands to (typically) less than 10. Index: fs.c Changes for readability and cleanliness. Move common blobs of code to functions. New function: rom_alloc,which allocates files by finding NULL files and using/splitting. Other changes as needed to support this usage. Index: util.c Creating a cbfs archive now requires creation of a NULL file covering the file system space. Index: cbfs.h Add a DELETED file type with value 0. Any file can be marked deleted by zero its type; this is a FLASH-friendly definition for all known FLASH types. Signed-off-by: Ronald G. Minnich <rminnich@gmail.com> I think it is a step in the right direction. Could you add the function prototype to cbfstool.h? Acked-by: Myles Watson <mylesgw@gmail.com> (I added the prototype) git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4261 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2009-05-08 21:23:00 +02:00
/* write the empty header */
rom_set_header(rom, (struct cbfs_file *)rom->ptr, "", -1, CBFS_COMPONENT_NULL);
return 0;
}
int add_bootblock(struct rom *rom, const char *filename)
{
unsigned int size;
int fd = size_and_open(filename, &size);
int ret;
if (fd == -1)
return -1;
if (size > ntohl(rom->header->bootblocksize)) {
ERROR("The bootblock size is not correct (%d vs %d)\n",
size, ntohl(rom->header->bootblocksize));
return -1;
}
/* Copy the bootblock into place at the end of the file */
ret = copy_from_fd(fd, ROM_PTR(rom, rom->size - ntohl(rom->header->bootblocksize)), size);
close(fd);
if (ret) {
ERROR("Unable to add %s to the bootblock\n", filename);
return -1;
}
return 0;
}
int rom_exists(struct rom *rom)
{
if (rom->fd <= 0)
return 0;
return 1;
}