include/cbfs.h

   1 /*
   2  * Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
   3  *
   4  * 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
  26 enum 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
  34 enum 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
  47 struct 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
  57 struct cbfs_fileheader {
  58         u8 magic[8];
  59         u32 len;
  60         u32 type;
  61         u32 checksum;
  62         u32 offset;
  63 } __packed;
  64
  65 struct 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
  75 extern enum cbfs_result file_cbfs_result;
  76
  77 /*
  78  * Return a string describing the most recent error condition.
  79  *
  80  * @return A pointer to the constant string.
  81  */
  82 const char *file_cbfs_error(void);
  83
  84 /*
  85  * Initialize the CBFS driver and load metadata into RAM.
  86  *
  87  * @param end_of_rom    Points to the end of the ROM the CBFS should be read
  88  *                      from.
  89  */
  90 void file_cbfs_init(uintptr_t end_of_rom);
  91
  92 /*
  93  * Get the header structure for the current CBFS.
  94  *
  95  * @return A pointer to the constant structure, or NULL if there is none.
  96  */
  97 const struct cbfs_header *file_cbfs_get_header(void);
  98
  99 /*
 100  * Get a handle for the first file in CBFS.
 101  *
 102  * @return A handle for the first file in CBFS, NULL on error.
 103  */
 104 const struct cbfs_cachenode *file_cbfs_get_first(void);
 105
 106 /*
 107  * Get a handle to the file after this one in CBFS.
 108  *
 109  * @param file          A pointer to the handle to advance.
 110  */
 111 void file_cbfs_get_next(const struct cbfs_cachenode **file);
 112
 113 /*
 114  * Find a file with a particular name in CBFS.
 115  *
 116  * @param name          The name to search for.
 117  *
 118  * @return A handle to the file, or NULL on error.
 119  */
 120 const struct cbfs_cachenode *file_cbfs_find(const char *name);
 121
 122
 123 /***************************************************************************/
 124 /* All of the functions below can be used without first initializing CBFS. */
 125 /***************************************************************************/
 126
 127 /*
 128  * Find a file with a particular name in CBFS without using the heap.
 129  *
 130  * @param end_of_rom    Points to the end of the ROM the CBFS should be read
 131  *                      from.
 132  * @param name          The name to search for.
 133  *
 134  * @return A handle to the file, or NULL on error.
 135  */
 136 const struct cbfs_cachenode *file_cbfs_find_uncached(uintptr_t end_of_rom,
 137                                                      const char *name);
 138
 139 /*
 140  * Get the name of a file in CBFS.
 141  *
 142  * @param file          The handle to the file.
 143  *
 144  * @return The name of the file, NULL on error.
 145  */
 146 const char *file_cbfs_name(const struct cbfs_cachenode *file);
 147
 148 /*
 149  * Get the size of a file in CBFS.
 150  *
 151  * @param file          The handle to the file.
 152  *
 153  * @return The size of the file, zero on error.
 154  */
 155 u32 file_cbfs_size(const struct cbfs_cachenode *file);
 156
 157 /*
 158  * Get the type of a file in CBFS.
 159  *
 160  * @param file          The handle to the file.
 161  *
 162  * @return The type of the file, zero on error.
 163  */
 164 u32 file_cbfs_type(const struct cbfs_cachenode *file);
 165
 166 /*
 167  * Read a file from CBFS into RAM
 168  *
 169  * @param file          A handle to the file to read.
 170  * @param buffer        Where to read it into memory.
 171  *
 172  * @return If positive or zero, the number of characters read. If negative, an
 173  *         error occurred.
 174  */
 175 long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
 176                     unsigned long maxsize);
 177
 178 #endif /* __CBFS_H */