123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218 |
- /* SPDX-License-Identifier: GPL-2.0+ */
- /*
- * Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
- */
- #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_BOOTBLOCK = 0x01,
- CBFS_TYPE_CBFSHEADER = 0x02,
- CBFS_TYPE_STAGE = 0x10,
- CBFS_TYPE_PAYLOAD = 0x20,
- CBFS_TYPE_FIT = 0x21,
- 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_TYPE_FSP = 0x60,
- CBFS_TYPE_MRC = 0x61,
- CBFS_TYPE_MMA = 0x62,
- CBFS_TYPE_EFI = 0x63,
- CBFS_TYPE_STRUCT = 0x70,
- CBFS_TYPE_CMOS_DEFAULT = 0xaa,
- CBFS_TYPE_SPD = 0xab,
- CBFS_TYPE_MRC_CACHE = 0xac,
- CBFS_TYPE_CMOS_LAYOUT = 0x01aa
- };
- enum {
- CBFS_HEADER_MAGIC = 0x4f524243,
- };
- /**
- * struct cbfs_header - header at the start of a CBFS region
- *
- * All fields use big-endian format.
- *
- * @magic: Magic number (CBFS_HEADER_MAGIC)
- */
- 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;
- /* offset to struct cbfs_file_attribute or 0 */
- u32 attributes_offset;
- u32 offset;
- } __packed;
- struct cbfs_cachenode {
- struct cbfs_cachenode *next;
- void *data;
- char *name;
- u32 type;
- u32 data_length;
- u32 name_length;
- u32 attributes_offset;
- };
- extern enum cbfs_result file_cbfs_result;
- /**
- * file_cbfs_error() - Return a string describing the most recent error
- * condition.
- *
- * @return A pointer to the constant string.
- */
- const char *file_cbfs_error(void);
- /**
- * cbfs_get_result() - Get the result of the last CBFS operation
- *
- *@return last result
- */
- enum cbfs_result cbfs_get_result(void);
- /**
- * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM.
- *
- * @end_of_rom: Points to the end of the ROM the CBFS should be read
- * from.
- */
- void file_cbfs_init(uintptr_t end_of_rom);
- /**
- * file_cbfs_get_header() - Get the header structure for the current CBFS.
- *
- * @return A pointer to the constant structure, or NULL if there is none.
- */
- const struct cbfs_header *file_cbfs_get_header(void);
- /**
- * file_cbfs_get_first() - Get a handle for the first file in CBFS.
- *
- * @return A handle for the first file in CBFS, NULL on error.
- */
- const struct cbfs_cachenode *file_cbfs_get_first(void);
- /**
- * file_cbfs_get_next() - Get a handle to the file after this one in CBFS.
- *
- * @file: A pointer to the handle to advance.
- */
- void file_cbfs_get_next(const struct cbfs_cachenode **file);
- /**
- * file_cbfs_find() - Find a file with a particular name in CBFS.
- *
- * @name: The name to search for.
- *
- * @return A handle to the file, or NULL on error.
- */
- const struct cbfs_cachenode *file_cbfs_find(const char *name);
- struct cbfs_priv *priv;
- /**
- * cbfs_find_file() - Find a file in a given CBFS
- *
- * @cbfs: CBFS to look in (use cbfs_init_mem() to set it up)
- * @name: Filename to look for
- * @return pointer to CBFS node if found, else NULL
- */
- const struct cbfs_cachenode *cbfs_find_file(struct cbfs_priv *cbfs,
- const char *name);
- /**
- * cbfs_init_mem() - Set up a new CBFS
- *
- * @base: Base address of CBFS
- * @size: Size of CBFS in bytes
- * @cbfsp: Returns a pointer to CBFS on success
- * @return 0 if OK, -ve on error
- */
- int cbfs_init_mem(ulong base, ulong size, struct cbfs_priv **privp);
- /***************************************************************************/
- /* All of the functions below can be used without first initializing CBFS. */
- /***************************************************************************/
- /**
- * file_cbfs_find_uncached() - Find a file with a particular name in CBFS
- * without using the heap.
- *
- * @end_of_rom: Points to the end of the ROM the CBFS should be read
- * from.
- * @name: The name to search for.
- *
- * @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);
- /**
- * file_cbfs_name() - Get the name of a file in CBFS.
- *
- * @file: The handle to the file.
- *
- * @return The name of the file, NULL on error.
- */
- const char *file_cbfs_name(const struct cbfs_cachenode *file);
- /**
- * file_cbfs_size() - Get the size of a file in CBFS.
- *
- * @file: The handle to the file.
- *
- * @return The size of the file, zero on error.
- */
- u32 file_cbfs_size(const struct cbfs_cachenode *file);
- /**
- * file_cbfs_type() - Get the type of a file in CBFS.
- *
- * @file: The handle to the file.
- *
- * @return The type of the file, zero on error.
- */
- u32 file_cbfs_type(const struct cbfs_cachenode *file);
- /**
- * file_cbfs_read() - Read a file from CBFS into RAM
- *
- * @file: A handle to the file to read.
- * @buffer: Where to read it into memory.
- * @maxsize: Maximum number of bytes to read
- *
- * @return If positive or zero, the number of characters read. If negative, an
- * error occurred.
- */
- long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
- unsigned long maxsize);
- #endif /* __CBFS_H */
|