src/include/cbfs.h

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