aboutsummaryrefslogtreecommitdiff
path: root/src/commonlib/include/commonlib/cbfs.h
blob: b0a468cdc92261df7a69d6c6fcd0d7a83b3fd86b (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
/*
 * This file is part of the coreboot project.
 *
 * Copyright 2015 Google Inc.
 *
 * 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.
 */

#ifndef _COMMONLIB_CBFS_H_
#define _COMMONLIB_CBFS_H_

#include <commonlib/cbfs_serialized.h>
#include <commonlib/region.h>

/* Object representing cbfs files. */
struct cbfsf {
	struct region_device metadata;
	struct region_device data;
};

/* Locate file by name and optional type. Returns 0 on succcess else < 0 on
 * error.*/
int cbfs_locate(struct cbfsf *fh, const struct region_device *cbfs,
		const char *name, uint32_t *type);

static inline void cbfs_file_data(struct region_device *data,
					const struct cbfsf *file)
{
	rdev_chain(data, &file->data, 0, region_device_sz(&file->data));
}

static inline void cbfs_file_metadata(struct region_device *metadata,
					const struct cbfsf *file)
{
	rdev_chain(metadata, &file->metadata, 0,
			region_device_sz(&file->metadata));
}

/*
 * Provide a handle to each cbfs file within a cbfs. The prev pointer represents
 * the previous file (NULL on first invocation). The next object gets filled
 * out with the next file. This returns < 0 on error, 0 on finding the next
 * file, and > 0 at end of cbfs.
 */
int cbfs_for_each_file(const struct region_device *cbfs,
			const struct cbfsf *prev, struct cbfsf *fh);

#endif