cbfs.h 3.91 KB
Newer Older
1 2 3
/*
 * Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
 *
4
 * SPDX-License-Identifier:	GPL-2.0+
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
 */

#ifndef __CBFS_H
#define __CBFS_H

#include <compiler.h>
#include <linux/compiler.h>

enum cbfs_result {
	CBFS_SUCCESS = 0,
	CBFS_NOT_INITIALIZED,
	CBFS_BAD_HEADER,
	CBFS_BAD_FILE,
	CBFS_FILE_NOT_FOUND
};

enum cbfs_filetype {
	CBFS_TYPE_STAGE = 0x10,
	CBFS_TYPE_PAYLOAD = 0x20,
	CBFS_TYPE_OPTIONROM = 0x30,
	CBFS_TYPE_BOOTSPLASH = 0x40,
	CBFS_TYPE_RAW = 0x50,
	CBFS_TYPE_VSA = 0x51,
	CBFS_TYPE_MBI = 0x52,
	CBFS_TYPE_MICROCODE = 0x53,
	CBFS_COMPONENT_CMOS_DEFAULT = 0xaa,
	CBFS_COMPONENT_CMOS_LAYOUT = 0x01aa
};

struct cbfs_header {
	u32 magic;
	u32 version;
	u32 rom_size;
	u32 boot_block_size;
	u32 align;
	u32 offset;
	u32 pad[2];
} __packed;

struct cbfs_fileheader {
	u8 magic[8];
	u32 len;
	u32 type;
	u32 checksum;
	u32 offset;
} __packed;

struct cbfs_cachenode {
	struct cbfs_cachenode *next;
	u32 type;
	void *data;
	u32 data_length;
	char *name;
	u32 name_length;
	u32 checksum;
} __packed;

extern enum cbfs_result file_cbfs_result;

Simon Glass's avatar
Simon Glass committed
64 65 66
/**
 * file_cbfs_error() - Return a string describing the most recent error
 * condition.
67 68 69 70 71
 *
 * @return A pointer to the constant string.
 */
const char *file_cbfs_error(void);

Simon Glass's avatar
Simon Glass committed
72 73
/**
 * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM.
74
 *
Simon Glass's avatar
Simon Glass committed
75
 * @end_of_rom: Points to the end of the ROM the CBFS should be read
76 77 78 79
 *                      from.
 */
void file_cbfs_init(uintptr_t end_of_rom);

Simon Glass's avatar
Simon Glass committed
80 81
/**
 * file_cbfs_get_header() - Get the header structure for the current CBFS.
82 83 84 85 86
 *
 * @return A pointer to the constant structure, or NULL if there is none.
 */
const struct cbfs_header *file_cbfs_get_header(void);

Simon Glass's avatar
Simon Glass committed
87 88
/**
 * file_cbfs_get_first() - Get a handle for the first file in CBFS.
89 90 91 92 93
 *
 * @return A handle for the first file in CBFS, NULL on error.
 */
const struct cbfs_cachenode *file_cbfs_get_first(void);

Simon Glass's avatar
Simon Glass committed
94 95
/**
 * file_cbfs_get_next() - Get a handle to the file after this one in CBFS.
96
 *
Simon Glass's avatar
Simon Glass committed
97
 * @file:		A pointer to the handle to advance.
98 99 100
 */
void file_cbfs_get_next(const struct cbfs_cachenode **file);

Simon Glass's avatar
Simon Glass committed
101 102
/**
 * file_cbfs_find() - Find a file with a particular name in CBFS.
103
 *
Simon Glass's avatar
Simon Glass committed
104
 * @name:		The name to search for.
105 106 107 108 109 110 111 112 113 114
 *
 * @return A handle to the file, or NULL on error.
 */
const struct cbfs_cachenode *file_cbfs_find(const char *name);


/***************************************************************************/
/* All of the functions below can be used without first initializing CBFS. */
/***************************************************************************/

Simon Glass's avatar
Simon Glass committed
115 116 117
/**
 * file_cbfs_find_uncached() - Find a file with a particular name in CBFS
 * without using the heap.
118
 *
Simon Glass's avatar
Simon Glass committed
119
 * @end_of_rom:		Points to the end of the ROM the CBFS should be read
120
 *                      from.
Simon Glass's avatar
Simon Glass committed
121
 * @name:		The name to search for.
122 123 124 125 126 127
 *
 * @return A handle to the file, or NULL on error.
 */
const struct cbfs_cachenode *file_cbfs_find_uncached(uintptr_t end_of_rom,
						     const char *name);

Simon Glass's avatar
Simon Glass committed
128 129
/**
 * file_cbfs_name() - Get the name of a file in CBFS.
130
 *
Simon Glass's avatar
Simon Glass committed
131
 * @file:		The handle to the file.
132 133 134 135 136
 *
 * @return The name of the file, NULL on error.
 */
const char *file_cbfs_name(const struct cbfs_cachenode *file);

Simon Glass's avatar
Simon Glass committed
137 138
/**
 * file_cbfs_size() - Get the size of a file in CBFS.
139
 *
Simon Glass's avatar
Simon Glass committed
140
 * @file:		The handle to the file.
141 142 143 144 145
 *
 * @return The size of the file, zero on error.
 */
u32 file_cbfs_size(const struct cbfs_cachenode *file);

Simon Glass's avatar
Simon Glass committed
146 147
/**
 * file_cbfs_type() - Get the type of a file in CBFS.
148
 *
Simon Glass's avatar
Simon Glass committed
149
 * @file:		The handle to the file.
150 151 152 153 154
 *
 * @return The type of the file, zero on error.
 */
u32 file_cbfs_type(const struct cbfs_cachenode *file);

Simon Glass's avatar
Simon Glass committed
155 156
/**
 * file_cbfs_read() - Read a file from CBFS into RAM
157
 *
Simon Glass's avatar
Simon Glass committed
158 159 160
 * @file:		A handle to the file to read.
 * @buffer:		Where to read it into memory.
 * @maxsize:		Maximum number of bytes to read
161 162
 *
 * @return If positive or zero, the number of characters read. If negative, an
Simon Glass's avatar
Simon Glass committed
163
 *	   error occurred.
164 165 166 167 168
 */
long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
		    unsigned long maxsize);

#endif /* __CBFS_H */