blob: 5bb12c355c2f390276bb28bb355914dcf2199e1e [file] [log] [blame]
Gabe Black84cd9322012-10-12 14:26:11 +00001/*
2 * Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
3 *
Gabe Black84cd9322012-10-12 14:26:11 +00004 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License as
6 * published by the Free Software Foundation; either version 2 of
7 * the License, or (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
17 * MA 02111-1307 USA
18 */
19
20#ifndef __CBFS_H
21#define __CBFS_H
22
23#include <compiler.h>
24#include <linux/compiler.h>
25
26enum cbfs_result {
27 CBFS_SUCCESS = 0,
28 CBFS_NOT_INITIALIZED,
29 CBFS_BAD_HEADER,
30 CBFS_BAD_FILE,
31 CBFS_FILE_NOT_FOUND
32};
33
34enum cbfs_filetype {
35 CBFS_TYPE_STAGE = 0x10,
36 CBFS_TYPE_PAYLOAD = 0x20,
37 CBFS_TYPE_OPTIONROM = 0x30,
38 CBFS_TYPE_BOOTSPLASH = 0x40,
39 CBFS_TYPE_RAW = 0x50,
40 CBFS_TYPE_VSA = 0x51,
41 CBFS_TYPE_MBI = 0x52,
42 CBFS_TYPE_MICROCODE = 0x53,
43 CBFS_COMPONENT_CMOS_DEFAULT = 0xaa,
44 CBFS_COMPONENT_CMOS_LAYOUT = 0x01aa
45};
46
47struct cbfs_header {
48 u32 magic;
49 u32 version;
50 u32 rom_size;
51 u32 boot_block_size;
52 u32 align;
53 u32 offset;
54 u32 pad[2];
55} __packed;
56
57struct cbfs_fileheader {
58 u8 magic[8];
59 u32 len;
60 u32 type;
61 u32 checksum;
62 u32 offset;
63} __packed;
64
65struct cbfs_cachenode {
66 struct cbfs_cachenode *next;
67 u32 type;
68 void *data;
69 u32 data_length;
70 char *name;
71 u32 name_length;
72 u32 checksum;
73} __packed;
74
75extern enum cbfs_result file_cbfs_result;
76
Simon Glasse3ff7972012-11-05 12:16:25 +000077/**
78 * file_cbfs_error() - Return a string describing the most recent error
79 * condition.
Gabe Black84cd9322012-10-12 14:26:11 +000080 *
81 * @return A pointer to the constant string.
82 */
83const char *file_cbfs_error(void);
84
Simon Glasse3ff7972012-11-05 12:16:25 +000085/**
86 * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM.
Gabe Black84cd9322012-10-12 14:26:11 +000087 *
Simon Glasse3ff7972012-11-05 12:16:25 +000088 * @end_of_rom: Points to the end of the ROM the CBFS should be read
Gabe Black84cd9322012-10-12 14:26:11 +000089 * from.
90 */
91void file_cbfs_init(uintptr_t end_of_rom);
92
Simon Glasse3ff7972012-11-05 12:16:25 +000093/**
94 * file_cbfs_get_header() - Get the header structure for the current CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +000095 *
96 * @return A pointer to the constant structure, or NULL if there is none.
97 */
98const struct cbfs_header *file_cbfs_get_header(void);
99
Simon Glasse3ff7972012-11-05 12:16:25 +0000100/**
101 * file_cbfs_get_first() - Get a handle for the first file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000102 *
103 * @return A handle for the first file in CBFS, NULL on error.
104 */
105const struct cbfs_cachenode *file_cbfs_get_first(void);
106
Simon Glasse3ff7972012-11-05 12:16:25 +0000107/**
108 * file_cbfs_get_next() - Get a handle to the file after this one in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000109 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000110 * @file: A pointer to the handle to advance.
Gabe Black84cd9322012-10-12 14:26:11 +0000111 */
112void file_cbfs_get_next(const struct cbfs_cachenode **file);
113
Simon Glasse3ff7972012-11-05 12:16:25 +0000114/**
115 * file_cbfs_find() - Find a file with a particular name in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000116 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000117 * @name: The name to search for.
Gabe Black84cd9322012-10-12 14:26:11 +0000118 *
119 * @return A handle to the file, or NULL on error.
120 */
121const struct cbfs_cachenode *file_cbfs_find(const char *name);
122
123
124/***************************************************************************/
125/* All of the functions below can be used without first initializing CBFS. */
126/***************************************************************************/
127
Simon Glasse3ff7972012-11-05 12:16:25 +0000128/**
129 * file_cbfs_find_uncached() - Find a file with a particular name in CBFS
130 * without using the heap.
Gabe Black84cd9322012-10-12 14:26:11 +0000131 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000132 * @end_of_rom: Points to the end of the ROM the CBFS should be read
Gabe Black84cd9322012-10-12 14:26:11 +0000133 * from.
Simon Glasse3ff7972012-11-05 12:16:25 +0000134 * @name: The name to search for.
Gabe Black84cd9322012-10-12 14:26:11 +0000135 *
136 * @return A handle to the file, or NULL on error.
137 */
138const struct cbfs_cachenode *file_cbfs_find_uncached(uintptr_t end_of_rom,
139 const char *name);
140
Simon Glasse3ff7972012-11-05 12:16:25 +0000141/**
142 * file_cbfs_name() - Get the name of a file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000143 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000144 * @file: The handle to the file.
Gabe Black84cd9322012-10-12 14:26:11 +0000145 *
146 * @return The name of the file, NULL on error.
147 */
148const char *file_cbfs_name(const struct cbfs_cachenode *file);
149
Simon Glasse3ff7972012-11-05 12:16:25 +0000150/**
151 * file_cbfs_size() - Get the size of a file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000152 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000153 * @file: The handle to the file.
Gabe Black84cd9322012-10-12 14:26:11 +0000154 *
155 * @return The size of the file, zero on error.
156 */
157u32 file_cbfs_size(const struct cbfs_cachenode *file);
158
Simon Glasse3ff7972012-11-05 12:16:25 +0000159/**
160 * file_cbfs_type() - Get the type of a file in CBFS.
Gabe Black84cd9322012-10-12 14:26:11 +0000161 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000162 * @file: The handle to the file.
Gabe Black84cd9322012-10-12 14:26:11 +0000163 *
164 * @return The type of the file, zero on error.
165 */
166u32 file_cbfs_type(const struct cbfs_cachenode *file);
167
Simon Glasse3ff7972012-11-05 12:16:25 +0000168/**
169 * file_cbfs_read() - Read a file from CBFS into RAM
Gabe Black84cd9322012-10-12 14:26:11 +0000170 *
Simon Glasse3ff7972012-11-05 12:16:25 +0000171 * @file: A handle to the file to read.
172 * @buffer: Where to read it into memory.
173 * @maxsize: Maximum number of bytes to read
Gabe Black84cd9322012-10-12 14:26:11 +0000174 *
175 * @return If positive or zero, the number of characters read. If negative, an
Simon Glasse3ff7972012-11-05 12:16:25 +0000176 * error occurred.
Gabe Black84cd9322012-10-12 14:26:11 +0000177 */
178long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
179 unsigned long maxsize);
180
181#endif /* __CBFS_H */