Merge branch '2020-05-15-misc-bugfixes'

[u-boot.git] / include / cbfs.h

diff --git a/include/cbfs.h b/include/cbfs.h
index f50280107b001d0699e1f4d33bdf5a777338a16a..d915f9426d8201ea1ca9989dc267b676352bf378 100644 (file)
--- a/include/cbfs.h
+++ b/include/cbfs.h
@@ -1,7 +1,6 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #ifndef __CBFS_H
@@ -19,18 +18,39 @@ enum cbfs_result {
 };
 
 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_COMPONENT_CMOS_DEFAULT = 0xaa,
-       CBFS_COMPONENT_CMOS_LAYOUT = 0x01aa
+       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;
@@ -45,19 +65,20 @@ struct cbfs_fileheader {
        u8 magic[8];
        u32 len;
        u32 type;
-       u32 checksum;
+       /* offset to struct cbfs_file_attribute or 0 */
+       u32 attributes_offset;
        u32 offset;
 } __packed;
 
 struct cbfs_cachenode {
        struct cbfs_cachenode *next;
-       u32 type;
        void *data;
-       u32 data_length;
        char *name;
+       u32 type;
+       u32 data_length;
        u32 name_length;
-       u32 checksum;
-} __packed;
+       u32 attributes_offset;
+};
 
 extern enum cbfs_result file_cbfs_result;
 
@@ -69,6 +90,13 @@ extern enum cbfs_result file_cbfs_result;
  */
 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.
  *
@@ -107,6 +135,28 @@ void file_cbfs_get_next(const struct cbfs_cachenode **file);
  */
 const struct cbfs_cachenode *file_cbfs_find(const char *name);
 
+struct cbfs_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. */