util/nvramtool/cbfs.h

   1 /* This file is part of the coreboot project. */
   2 /*
   3  * This file is dual-licensed. You can choose between:
   4  *   - The GNU GPL, version 2, as published by the Free Software Foundation
   5  *   - The revised BSD license (without advertising clause)
   6  *
   7  * ---------------------------------------------------------------------------
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; version 2 of the License.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  * ---------------------------------------------------------------------------
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions
  19  * are met:
  20  * 1. Redistributions of source code must retain the above copyright
  21  *    notice, this list of conditions and the following disclaimer.
  22  * 2. Redistributions in binary form must reproduce the above copyright
  23  *    notice, this list of conditions and the following disclaimer in the
  24  *    documentation and/or other materials provided with the distribution.
  25  * 3. The name of the author may not be used to endorse or promote products
  26  *    derived from this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38  * SUCH DAMAGE.
  39  * ---------------------------------------------------------------------------
  40  */
  41
  42 #ifndef _CBFS_H_
  43 #define _CBFS_H_
  44
  45 #include "coreboot_tables.h"
  46
  47 typedef uint64_t u64;
  48 typedef uint32_t u32;
  49 typedef uint16_t u16;
  50 typedef uint8_t u8;
  51
  52 /** These are standard values for the known compression
  53     algorithms that coreboot knows about for stages and
  54     payloads.  Of course, other CBFS users can use whatever
  55     values they want, as long as they understand them. */
  56
  57 #define CBFS_COMPRESS_NONE  0
  58 #define CBFS_COMPRESS_LZMA  1
  59 #define CBFS_COMPRESS_LZ4   2
  60
  61 /** These are standard component types for well known
  62     components (i.e - those that coreboot needs to consume.
  63     Users are welcome to use any other value for their
  64     components */
  65
  66 #define CBFS_TYPE_STAGE      0x10
  67 #define CBFS_TYPE_SELF       0x20
  68 #define CBFS_TYPE_FIT        0x21
  69 #define CBFS_TYPE_OPTIONROM  0x30
  70 #define CBFS_TYPE_BOOTSPLASH 0x40
  71 #define CBFS_TYPE_RAW        0x50
  72 #define CBFS_TYPE_VSA        0x51
  73 #define CBFS_TYPE_MBI        0x52
  74 #define CBFS_TYPE_MICROCODE  0x53
  75 #define CBFS_COMPONENT_CMOS_DEFAULT 0xaa
  76 #define CBFS_COMPONENT_CMOS_LAYOUT 0x01aa
  77
  78
  79 /** this is the master cbfs header - it need to be
  80     located somewhere in the bootblock.  Where it
  81     actually lives is up to coreboot. A pointer to
  82     this header will live at 0xFFFFFFFc, so we can
  83     easily find it. */
  84
  85 #define CBFS_HEADER_MAGIC  0x4F524243
  86 #define CBFS_HEADPTR_ADDR 0xFFFFFFFc
  87 #define CBFS_HEADER_VERSION1 0x31313131
  88
  89 struct cbfs_header {
  90         u32 magic;
  91         u32 version;
  92         u32 romsize;
  93         u32 bootblocksize;
  94         u32 align;
  95         u32 offset;
  96         u32 pad[2];
  97 } __attribute__((packed));
  98
  99 /** This is a component header - every entry in the CBFS
 100     will have this header.
 101
 102     This is how the component is arranged in the ROM:
 103
 104     --------------   <- 0
 105     component header
 106     --------------   <- sizeof(struct component)
 107     component name
 108     --------------   <- offset
 109     data
 110     ...
 111     --------------   <- offset + len
 112 */
 113
 114 #define CBFS_FILE_MAGIC "LARCHIVE"
 115
 116 struct cbfs_file {
 117         char magic[8];
 118         u32 len;
 119         u32 type;
 120         u32 checksum;
 121         u32 offset;
 122 } __attribute__((packed));
 123
 124 /*** Component sub-headers ***/
 125
 126 /* Following are component sub-headers for the "standard"
 127    component types */
 128
 129 /** This is the sub-header for stage components.  Stages are
 130     loaded by coreboot during the normal boot process */
 131
 132 struct cbfs_stage {
 133         u32 compression;  /** Compression type */
 134         u64 entry;  /** entry point */
 135         u64 load;   /** Where to load in memory */
 136         u32 len;          /** length of data to load */
 137         u32 memlen;        /** total length of object in memory */
 138 } __attribute__((packed));
 139
 140 /** this is the sub-header for payload components.  Payloads
 141     are loaded by coreboot at the end of the boot process */
 142
 143 struct cbfs_payload_segment {
 144         u32 type;
 145         u32 compression;
 146         u32 offset;
 147         u64 load_addr;
 148         u32 len;
 149         u32 mem_len;
 150 } __attribute__((packed));
 151
 152 struct cbfs_payload {
 153         struct cbfs_payload_segment segments;
 154 };
 155
 156 #define PAYLOAD_SEGMENT_CODE   0x45444F43
 157 #define PAYLOAD_SEGMENT_DATA   0x41544144
 158 #define PAYLOAD_SEGMENT_BSS    0x20535342
 159 #define PAYLOAD_SEGMENT_PARAMS 0x41524150
 160 #define PAYLOAD_SEGMENT_ENTRY  0x52544E45
 161
 162 struct cbfs_optionrom {
 163         u32 compression;
 164         u32 len;
 165 } __attribute__((packed));
 166
 167 #define CBFS_NAME(_c) (((char *) (_c)) + sizeof(struct cbfs_file))
 168 #define CBFS_SUBHEADER(_p) ( (void *) ((((u8 *) (_p)) + ntohl((_p)->offset))) )
 169
 170 void * cbfs_get_file(const char *name);
 171 struct cbfs_file *cbfs_find(const char *name);
 172 void *cbfs_find_file(const char *name, unsigned int type, unsigned int *len);
 173
 174 void open_cbfs(const char *filename);
 175 #endif