summaryrefslogtreecommitdiff
path: root/util/cbfstool/common.c
blob: 23f3ecfa87ea52ace5a8913e9f4bb5952eb115ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
/*
 * common utility functions for cbfstool
 *
 * Copyright (C) 2009 coresystems GmbH
 *                 written by Patrick Georgi <patrick.georgi@coresystems.de>
 *
 * 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 <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <libgen.h>
#include "common.h"
#include "cbfs.h"
#include "elf.h"

#define dprintf(x...)

uint32_t getfilesize(const char *filename)
{
	uint32_t size;
	FILE *file = fopen(filename, "rb");
	fseek(file, 0, SEEK_END);
	size = ftell(file);
	fclose(file);
	return size;
}

void *loadfile(const char *filename, uint32_t * romsize_p, void *content,
	       int place)
{
	FILE *file = fopen(filename, "rb");
	if (file == NULL)
		return NULL;
	fseek(file, 0, SEEK_END);
	*romsize_p = ftell(file);
	fseek(file, 0, SEEK_SET);
	if (!content) {
		content = malloc(*romsize_p);
		if (!content) {
			printf("Could not get %d bytes for file %s\n",
			       *romsize_p, filename);
			exit(1);
		}
	} else if (place == SEEK_END)
		content -= *romsize_p;

	if (!fread(content, *romsize_p, 1, file)) {
		printf("failed to read %s\n", filename);
		return NULL;
	}
	fclose(file);
	return content;
}

struct cbfs_header *master_header;
uint32_t phys_start, phys_end, align, romsize;
void *offset;

void recalculate_rom_geometry(void *romarea)
{
	offset = romarea + romsize - 0x100000000ULL;
	master_header = (struct cbfs_header *)
	    phys_to_virt(*((uint32_t *) phys_to_virt(0xfffffffc)));
	phys_start = (0 - romsize + ntohl(master_header->offset)) & 0xffffffff;
	phys_end =
	    (0 - ntohl(master_header->bootblocksize) -
	     sizeof(struct cbfs_header)) & 0xffffffff;
	align = ntohl(master_header->align);
}

void *loadrom(const char *filename)
{
	void *romarea = loadfile(filename, &romsize, 0, SEEK_SET);
	if (romarea == NULL)
		return NULL;
	recalculate_rom_geometry(romarea);
	return romarea;
}

int writerom(const char *filename, void *start, uint32_t size)
{
	FILE *file = fopen(filename, "wb");
	if (!file) {
		fprintf(stderr, "Could not open '%s' for writing: ", filename);
		perror("");
		return 1;
	}

	if (fwrite(start, size, 1, file) != 1) {
		fprintf(stderr, "Could not write to '%s': ", filename);
		perror("");
		return 1;
	}

	fclose(file);
	return 0;
}

int cbfs_file_header(uint32_t physaddr)
{
	/* maybe improve this test */
	return (strncmp(phys_to_virt(physaddr), "LARCHIVE", 8) == 0);
}

struct cbfs_file *cbfs_create_empty_file(uint32_t physaddr, uint32_t size)
{
	struct cbfs_file *nextfile = (struct cbfs_file *)phys_to_virt(physaddr);
	strncpy((char *)(nextfile->magic), "LARCHIVE", 8);
	nextfile->len = htonl(size);
	nextfile->type = htonl(0xffffffff);
	nextfile->checksum = 0;	// FIXME?
	nextfile->offset = htonl(sizeof(struct cbfs_file) + 16);
	memset(((void *)nextfile) + sizeof(struct cbfs_file), 0, 16);
	return nextfile;
}

int iself(unsigned char *input)
{
	Elf32_Ehdr *ehdr = (Elf32_Ehdr *) input;
	return !memcmp(ehdr->e_ident, ELFMAG, 4);
}

static struct filetypes_t {
	uint32_t type;
	const char *name;
} filetypes[] = {
	{CBFS_COMPONENT_STAGE, "stage"},
	{CBFS_COMPONENT_PAYLOAD, "payload"},
	{CBFS_COMPONENT_OPTIONROM, "optionrom"},
	{CBFS_COMPONENT_BOOTSPLASH, "bootsplash"},
	{CBFS_COMPONENT_RAW, "raw"},
	{CBFS_COMPONENT_VSA, "vsa"},
	{CBFS_COMPONENT_MBI, "mbi"},
	{CBFS_COMPONENT_MICROCODE, "microcode"},
	{CBFS_COMPONENT_CMOS_DEFAULT, "cmos default"},
	{CBFS_COMPONENT_CMOS_LAYOUT, "cmos layout"},
	{CBFS_COMPONENT_DELETED, "deleted"},
	{CBFS_COMPONENT_NULL, "null"}
};

void print_supported_filetypes(void)
{
	int i, number = ARRAY_SIZE(filetypes);

	for (i=0; i<number; i++) {
		printf(" %s%c", filetypes[i].name, (i==(number-1))?'\n':',');
		if ((i%8) == 7)
			printf("\n");
	}
}

const char *strfiletype(uint32_t number)
{
	size_t i;
	for (i = 0; i < (sizeof(filetypes) / sizeof(struct filetypes_t)); i++)
		if (filetypes[i].type == number)
			return filetypes[i].name;
	return "unknown";
}

uint64_t intfiletype(const char *name)
{
	size_t i;
	for (i = 0; i < (sizeof(filetypes) / sizeof(struct filetypes_t)); i++)
		if (strcmp(filetypes[i].name, name) == 0)
			return filetypes[i].type;
	return -1;
}

void print_cbfs_directory(const char *filename)
{
	printf
	    ("%s: %d kB, bootblocksize %d, romsize %d, offset 0x%x\nAlignment: %d bytes\n\n",
	     basename((char *)filename), romsize / 1024, ntohl(master_header->bootblocksize),
	     romsize, ntohl(master_header->offset), align);
	printf("%-30s %-10s %-12s Size\n", "Name", "Offset", "Type");
	uint32_t current = phys_start;
	while (current < phys_end) {
		if (!cbfs_file_header(current)) {
			current += align;
			continue;
		}
		struct cbfs_file *thisfile =
		    (struct cbfs_file *)phys_to_virt(current);
		uint32_t length = ntohl(thisfile->len);
		char *fname = (char *)(phys_to_virt(current) + sizeof(struct cbfs_file));
		if (strlen(fname) == 0)
			fname = "(empty)";

		printf("%-30s 0x%-8x %-12s %d\n", fname,
		       current - phys_start, strfiletype(ntohl(thisfile->type)),
		       length);
		current =
		    ALIGN(current + ntohl(thisfile->len) +
			  ntohl(thisfile->offset), align);
	}
}

int extract_file_from_cbfs(const char *filename, const char *payloadname, const char *outpath)
{
	// Identify the coreboot image.
	printf(
	     "%s: %d kB, bootblocksize %d, romsize %d, offset 0x%x\nAlignment: %d bytes\n\n",
	     basename((char *)filename), romsize / 1024, ntohl(master_header->bootblocksize),
	     romsize, ntohl(master_header->offset), align);

	FILE *outfile = NULL;
	uint32_t current = phys_start;
	while (current < phys_end) {
		if (!cbfs_file_header(current)) {
			current += align;
			continue;
		}

		// Locate the file start struct
		struct cbfs_file *thisfile =
		    (struct cbfs_file *)phys_to_virt(current);
		// And its length
		uint32_t length = ntohl(thisfile->len);
		// Locate the file name
		char *fname = (char *)(phys_to_virt(current) + sizeof(struct cbfs_file));

		// It's not the file we are looking for..
		if (strcmp(fname, payloadname) != 0)
		{
			current =
			   ALIGN(current + ntohl(thisfile->len) +
				  ntohl(thisfile->offset), align);
			continue;
		}

		// Else, it's our file.
		printf("Found file %.30s at 0x%x, type %.12s, size %d\n", fname,
		       current - phys_start, strfiletype(ntohl(thisfile->type)),
		       length);

		// If we are not dumping to stdout, open the out file.
		outfile = fopen(outpath, "wb");
		if (!outfile)
		{
			printf("Could not open the file %s for writing. Aborting.\n", outpath);
			return 1;
		}

		if (ntohl(thisfile->type) != CBFS_COMPONENT_RAW)
		{
			printf("Warning: only 'raw' files are safe to extract.\n");
		}

		fwrite(((char *)thisfile)
				+ ntohl(thisfile->offset), length, 1, outfile);

		fclose(outfile);
		printf("Successfully dumped the file.\n");

		// We'll only dump one file.
		return 0;
	}
	printf("File %s not found.\n", payloadname);
	return 1;
}


int add_file_to_cbfs(void *content, uint32_t contentsize, uint32_t location)
{
	uint32_t current = phys_start;
	while (current < phys_end) {
		if (!cbfs_file_header(current)) {
			current += align;
			continue;
		}
		struct cbfs_file *thisfile =
		    (struct cbfs_file *)phys_to_virt(current);
		uint32_t length = ntohl(thisfile->len);

		dprintf("at %x, %x bytes\n", current, length);
		/* Is this a free chunk? */
		if ((thisfile->type == CBFS_COMPONENT_DELETED)
		    || (thisfile->type == CBFS_COMPONENT_NULL)) {
			dprintf("null||deleted at %x, %x bytes\n", current,
				length);
			/* if this is the right size, and if specified, the right location, use it */
			if ((contentsize <= length)
			    && ((location == 0) || (current == location))) {
				if (contentsize < length) {
					dprintf
					    ("this chunk is %x bytes, we need %x. create a new chunk at %x with %x bytes\n",
					     length, contentsize,
					     ALIGN(current + contentsize,
						   align),
					     length - contentsize);
					uint32_t start =
					    ALIGN(current + contentsize, align);
					uint32_t size =
					    current + ntohl(thisfile->offset)
					    + length - start - 16 -
					    sizeof(struct cbfs_file);
					cbfs_create_empty_file(start, size);
				}
				dprintf("copying data\n");
				memcpy(phys_to_virt(current), content,
				       contentsize);
				return 0;
			}
			if (location != 0) {
				/* CBFS has the constraint that the chain always moves up in memory. so once
				   we're past the place we seek, we don't need to look any further */
				if (current > location) {
					printf
					    ("the requested space is not available\n");
					return 1;
				}

				/* Is the requested location inside the current chunk? */
				if ((current < location)
				    && ((location + contentsize) <=
					(current + length))) {
					/* Split it up. In the next iteration the code will be at the right place. */
					dprintf("split up. new length: %x\n",
						location - current -
						ntohl(thisfile->offset));
					thisfile->len =
					    htonl(location - current -
						  ntohl(thisfile->offset));
					cbfs_create_empty_file(location,
								   length -
								   (location -
								    current));
				}
			}
		}
		current =
		    ALIGN(current + ntohl(thisfile->len) +
			  ntohl(thisfile->offset), align);
	}
	printf("Could not add the file to CBFS, it's probably too big.\n");
	printf("File size: %d bytes (%d KB).\n", contentsize, contentsize/1024);
	return 1;
}


static struct cbfs_file *merge_adjacent_files(struct cbfs_file *first,
					      struct cbfs_file *second)
{
	uint32_t new_length =
	    ntohl(first->len) + ntohl(second->len) + ntohl(second->offset);
	first->len = htonl(new_length);
	first->checksum = 0; // FIXME?
	return first;
}

static struct cbfs_file *next_file(struct cbfs_file *prev)
{
	uint32_t pos = (prev == NULL) ? phys_start :
	    ALIGN(virt_to_phys(prev) + ntohl(prev->len) + ntohl(prev->offset),
		  align);

	for (; pos < phys_end; pos += align) {
		if (cbfs_file_header(pos))
			return (struct cbfs_file *)phys_to_virt(pos);
	}
	return NULL;
}


int remove_file_from_cbfs(const char *filename)
{
	struct cbfs_file *prev = NULL;
	struct cbfs_file *cur = next_file(prev);
	struct cbfs_file *next = next_file(cur);
	for (; cur; prev = cur, cur = next, next = next_file(next)) {

		/* Check if this is the file to remove. */
		char *name = (char *)cur + sizeof(*cur);
		if (strcmp(name, filename))
			continue;

		/* Mark the file as free space and erase its name. */
		cur->type = CBFS_COMPONENT_NULL;
		name[0] = '\0';

		/* Merge it with the previous file if possible. */
		if (prev && prev->type == CBFS_COMPONENT_NULL)
			cur = merge_adjacent_files(prev, cur);

		/* Merge it with the next file if possible. */
		if (next && next->type == CBFS_COMPONENT_NULL)
			merge_adjacent_files(cur, next);

		return 0;
	}
	printf("CBFS file %s not found.\n", filename);
	return 1;
}


/* returns new data block with cbfs_file header, suitable to dump into the ROM. location returns
   the new location that points to the cbfs_file header */
void *create_cbfs_file(const char *filename, void *data, uint32_t * datasize,
		       uint32_t type, uint32_t * location)
{
	uint32_t filename_len = ALIGN(strlen(filename) + 1, 16);
	uint32_t headersize = sizeof(struct cbfs_file) + filename_len;
	if ((location != 0) && (*location != 0)) {
		uint32_t offset = *location % align;
		/* If offset >= (headersize % align), we can stuff the header into the offset.
		   Otherwise the header has to be aligned itself, and put before the offset data */
		if (offset >= (headersize % align)) {
			offset -= (headersize % align);
		} else {
			offset += align - (headersize % align);
		}
		headersize += offset;
		*location -= headersize;
	}
	void *newdata = malloc(*datasize + headersize);
	if (!newdata) {
		printf("Could not get %d bytes for CBFS file.\n", *datasize +
		       headersize);
		exit(1);
	}
	memset(newdata, 0xff, *datasize + headersize);
	struct cbfs_file *nextfile = (struct cbfs_file *)newdata;
	strncpy((char *)(nextfile->magic), "LARCHIVE", 8);
	nextfile->len = htonl(*datasize);
	nextfile->type = htonl(type);
	nextfile->checksum = 0;	// FIXME?
	nextfile->offset = htonl(headersize);
	strcpy(newdata + sizeof(struct cbfs_file), filename);
	memcpy(newdata + headersize, data, *datasize);
	*datasize += headersize;
	return newdata;
}

int create_cbfs_image(const char *romfile, uint32_t _romsize,
		      const char *bootblock, uint32_t align, uint32_t offs)
{
	romsize = _romsize;
	unsigned char *romarea = malloc(romsize);
	if (!romarea) {
		printf("Could not get %d bytes of memory for CBFS image.\n",
		       romsize);
		exit(1);
	}
	memset(romarea, 0xff, romsize);

	// Set up physical/virtual mapping
	offset = romarea + romsize - 0x100000000ULL;

	if (align == 0)
		align = 64;

	uint32_t bootblocksize = 0;
	loadfile(bootblock, &bootblocksize, romarea + romsize, SEEK_END);
	struct cbfs_header *master_header =
	    (struct cbfs_header *)(romarea + romsize - bootblocksize -
				   sizeof(struct cbfs_header));
	master_header->magic = ntohl(0x4f524243);
	master_header->version = ntohl(0x31313131);
	master_header->romsize = htonl(romsize);
	master_header->bootblocksize = htonl(bootblocksize);
	master_header->align = htonl(align);
	master_header->offset = htonl(offs);
	((uint32_t *) phys_to_virt(0xfffffffc))[0] =
	    virt_to_phys(master_header);

	recalculate_rom_geometry(romarea);

	cbfs_create_empty_file((0 - romsize + offs) & 0xffffffff,
				   romsize - offs - bootblocksize -
				   sizeof(struct cbfs_header) -
				   sizeof(struct cbfs_file) - 16);

	writerom(romfile, romarea, romsize);
	return 0;
}

static int in_segment(int addr, int size, int gran)
{
	return ((addr & ~(gran - 1)) == ((addr + size) & ~(gran - 1)));
}

uint32_t cbfs_find_location(const char *romfile, uint32_t filesize,
			    const char *filename, uint32_t alignment)
{
	loadrom(romfile);
	size_t filename_size = strlen(filename);

	size_t headersize =
	    sizeof(struct cbfs_file) + ALIGN(filename_size + 1,
					     16) + sizeof(struct cbfs_stage);
	size_t totalsize = headersize + filesize;

	uint32_t current = phys_start;
	while (current < phys_end) {
		if (!cbfs_file_header(current)) {
			current += align;
			continue;
		}
		struct cbfs_file *thisfile =
		    (struct cbfs_file *)phys_to_virt(current);

		uint32_t top =
		    current + ntohl(thisfile->len) + ntohl(thisfile->offset);
		if (((ntohl(thisfile->type) == 0x0)
		     || (ntohl(thisfile->type) == 0xffffffff))
		    && (ntohl(thisfile->len) + ntohl(thisfile->offset) >=
			totalsize)) {
			if (in_segment
			    (current + headersize, filesize, alignment))
				return current + headersize;
			if ((ALIGN(current, alignment) + filesize < top)
			    && (ALIGN(current, alignment) - headersize >
				current)
			    && in_segment(ALIGN(current, alignment), filesize,
					  alignment))
				return ALIGN(current, alignment);
			if ((ALIGN(current, alignment) + alignment + filesize <
			     top)
			    && (ALIGN(current, alignment) + alignment -
				headersize > current)
			    && in_segment(ALIGN(current, alignment) + alignment,
					  filesize, alignment))
				return ALIGN(current, alignment) + alignment;
		}
		current =
		    ALIGN(current + ntohl(thisfile->len) +
			  ntohl(thisfile->offset), align);
	}
	return 0;
}