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 LAR 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 #define CBFS_COMPRESS_NRV2B 2
  61
  62 /** These are standard component types for well known
  63     components (i.e - those that coreboot needs to consume.
  64     Users are welcome to use any other value for their
  65     components */
  66
  67 #define CBFS_TYPE_STAGE     0x10
  68 #define CBFS_TYPE_PAYLOAD   0x20
  69 #define CBFS_TYPE_OPTIONROM 0x30
  70
  71 /** this is the master cbfs header - it need to be
  72     located somewhere in the bootblock.  Where it
  73     actually lives is up to coreboot. A pointer to
  74     this header will live at 0xFFFFFFFc, so we can
  75     easily find it. */
  76
  77 #define CBFS_HEADER_MAGIC  0x4F524243
  78 #define CBFS_HEADPTR_ADDR 0xFFFFFFFc
  79 #define VERSION1 0x31313131
  80
  81 struct cbfs_header {
  82         u32 magic;
  83         u32 version;
  84         u32 romsize;
  85         u32 bootblocksize;
  86         u32 align;
  87         u32 offset;
  88         u32 pad[2];
  89 } __attribute__((packed));
  90
  91 /** This is a component header - every entry in the CBFS
  92     will have this header.
  93
  94     This is how the component is arranged in the ROM:
  95
  96     --------------   <- 0
  97     component header
  98     --------------   <- sizeof(struct component)
  99     component name
 100     --------------   <- offset
 101     data
 102     ...
 103     --------------   <- offset + len
 104 */
 105
 106 #define CBFS_FILE_MAGIC "LARCHIVE"
 107
 108 struct cbfs_file {
 109         char magic[8];
 110         u32 len;
 111         u32 type;
 112         u32 checksum;
 113         u32 offset;
 114 } __attribute__((packed));
 115
 116 /*** Component sub-headers ***/
 117
 118 /* Following are component sub-headers for the "standard"
 119    component types */
 120
 121 /** This is the sub-header for stage components.  Stages are
 122     loaded by coreboot during the normal boot process */
 123
 124 struct cbfs_stage {
 125         u32 compression;  /** Compression type */
 126         u64 entry;  /** entry point */
 127         u64 load;   /** Where to load in memory */
 128         u32 len;          /** length of data to load */
 129         u32 memlen;        /** total length of object in memory */
 130 } __attribute__((packed));
 131
 132 /** this is the sub-header for payload components.  Payloads
 133     are loaded by coreboot at the end of the boot process */
 134
 135 struct cbfs_payload_segment {
 136         u32 type;
 137         u32 compression;
 138         u32 offset;
 139         u64 load_addr;
 140         u32 len;
 141         u32 mem_len;
 142 } __attribute__((packed));
 143
 144 struct cbfs_payload {
 145         struct cbfs_payload_segment segments;
 146 };
 147
 148 #define PAYLOAD_SEGMENT_CODE   0x45444F43
 149 #define PAYLOAD_SEGMENT_DATA   0x41544144
 150 #define PAYLOAD_SEGMENT_BSS    0x20535342
 151 #define PAYLOAD_SEGMENT_PARAMS 0x41524150
 152 #define PAYLOAD_SEGMENT_ENTRY  0x52544E45
 153
 154 struct cbfs_optionrom {
 155         u32 compression;
 156         u32 len;
 157 } __attribute__((packed));
 158
 159 #define CBFS_NAME(_c) (((char *) (_c)) + sizeof(struct cbfs_file))
 160 #define CBFS_SUBHEADER(_p) ( (void *) ((((u8 *) (_p)) + ntohl((_p)->offset))) )
 161
 162 void * cbfs_load_payload(struct lb_memory *lb_mem, const char *name);
 163 void * cbfs_load_stage(const char *name);
 164 int cbfs_execute_stage(const char *name);
 165 void * cbfs_get_file(const char *name);
 166 void *cbfs_load_optionrom(u16 vendor, u16 device, void * dest);
 167 int run_address(void *f);
 168
 169 struct cbfs_stage *cbfs_find_file(const char *name, int type);
 170
 171 #endif
 172