| /* |
| * This file is part of the coreboot project. |
| * |
| * Copyright (C) 2008 Jordan Crouse <jordan@cosmicpenguin.net> |
| * Copyright (C) 2012 Google, Inc. |
| * Copyright (C) 2013 The Chromium OS Authors. All rights reserved. |
| * |
| * This file is dual-licensed. You can choose between: |
| * - The GNU GPL, version 2, as published by the Free Software Foundation |
| * - The revised BSD license (without advertising clause) |
| * |
| * --------------------------------------------------------------------------- |
| * This program is free software; you can redistribute it and/or modify |
| * it under the terms of the GNU General Public License as published by |
| * the Free Software Foundation; version 2 of the License. |
| * |
| * This program is distributed in the hope that it will be useful, |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| * GNU General Public License for more details. |
| * |
| * You should have received a copy of the GNU General Public License |
| * along with this program; if not, write to the Free Software |
| * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA |
| * --------------------------------------------------------------------------- |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * 3. The name of the author may not be used to endorse or promote products |
| * derived from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
| * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
| * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * --------------------------------------------------------------------------- |
| */ |
| |
| #ifndef _CBFS_CORE_H_ |
| #define _CBFS_CORE_H_ |
| |
| #include <grub/types.h> |
| |
| /** These are standard values for the known compression |
| alogrithms that coreboot knows about for stages and |
| payloads. Of course, other CBFS users can use whatever |
| values they want, as long as they understand them. */ |
| |
| #define CBFS_COMPRESS_NONE 0 |
| #define CBFS_COMPRESS_LZMA 1 |
| |
| /** These are standard component types for well known |
| components (i.e - those that coreboot needs to consume. |
| Users are welcome to use any other value for their |
| components */ |
| |
| #define CBFS_TYPE_STAGE 0x10 |
| #define CBFS_TYPE_PAYLOAD 0x20 |
| #define CBFS_TYPE_OPTIONROM 0x30 |
| #define CBFS_TYPE_BOOTSPLASH 0x40 |
| #define CBFS_TYPE_RAW 0x50 |
| #define CBFS_TYPE_VSA 0x51 |
| #define CBFS_TYPE_MBI 0x52 |
| #define CBFS_TYPE_MICROCODE 0x53 |
| #define CBFS_COMPONENT_CMOS_DEFAULT 0xaa |
| #define CBFS_COMPONENT_CMOS_LAYOUT 0x01aa |
| |
| #define CBFS_HEADER_MAGIC 0x4F524243 |
| #define CBFS_HEADER_VERSION1 0x31313131 |
| #define CBFS_HEADER_VERSION2 0x31313132 |
| #define CBFS_HEADER_VERSION CBFS_HEADER_VERSION2 |
| |
| #define CBFS_HEADER_INVALID_ADDRESS ((void*)(0xffffffff)) |
| |
| /** this is the master cbfs header - it need to be located somewhere available |
| to bootblock (to load romstage). Where it actually lives is up to coreboot. |
| On x86, a pointer to this header will live at 0xFFFFFFFC. |
| For other platforms, you need to define CONFIG_CBFS_HEADER_ROM_OFFSET */ |
| |
| struct cbfs_header { |
| grub_uint32_t magic; |
| grub_uint32_t version; |
| grub_uint32_t romsize; |
| grub_uint32_t bootblocksize; |
| grub_uint32_t align; |
| grub_uint32_t offset; |
| grub_uint32_t architecture; |
| grub_uint32_t pad[1]; |
| } GRUB_PACKED; |
| |
| /* "Unknown" refers to CBFS headers version 1, |
| * before the architecture was defined (i.e., x86 only). |
| */ |
| #define CBFS_ARCHITECTURE_UNKNOWN 0xFFFFFFFF |
| #define CBFS_ARCHITECTURE_X86 0x00000001 |
| #define CBFS_ARCHITECTURE_ARMV7 0x00000010 |
| |
| /** This is a component header - every entry in the CBFS |
| will have this header. |
| |
| This is how the component is arranged in the ROM: |
| |
| -------------- <- 0 |
| component header |
| -------------- <- sizeof(struct component) |
| component name |
| -------------- <- offset |
| data |
| ... |
| -------------- <- offset + len |
| */ |
| |
| #define CBFS_FILE_MAGIC "LARCHIVE" |
| |
| struct cbfs_file { |
| char magic[8]; |
| grub_uint32_t len; |
| grub_uint32_t type; |
| grub_uint32_t checksum; |
| grub_uint32_t offset; |
| } GRUB_PACKED; |
| |
| /*** Component sub-headers ***/ |
| |
| /* Following are component sub-headers for the "standard" |
| component types */ |
| |
| /** This is the sub-header for stage components. Stages are |
| loaded by coreboot during the normal boot process */ |
| |
| struct cbfs_stage { |
| grub_uint32_t compression; /** Compression type */ |
| grub_uint64_t entry; /** entry point */ |
| grub_uint64_t load; /** Where to load in memory */ |
| grub_uint32_t len; /** length of data to load */ |
| grub_uint32_t memlen; /** total length of object in memory */ |
| } GRUB_PACKED; |
| |
| /** this is the sub-header for payload components. Payloads |
| are loaded by coreboot at the end of the boot process */ |
| |
| struct cbfs_payload_segment { |
| grub_uint32_t type; |
| grub_uint32_t compression; |
| grub_uint32_t offset; |
| grub_uint64_t load_addr; |
| grub_uint32_t len; |
| grub_uint32_t mem_len; |
| } GRUB_PACKED; |
| |
| struct cbfs_payload { |
| struct cbfs_payload_segment segments; |
| }; |
| |
| #define PAYLOAD_SEGMENT_CODE 0x45444F43 |
| #define PAYLOAD_SEGMENT_DATA 0x41544144 |
| #define PAYLOAD_SEGMENT_BSS 0x20535342 |
| #define PAYLOAD_SEGMENT_PARAMS 0x41524150 |
| #define PAYLOAD_SEGMENT_ENTRY 0x52544E45 |
| |
| struct cbfs_optionrom { |
| grub_uint32_t compression; |
| grub_uint32_t len; |
| } GRUB_PACKED; |
| |
| #endif |
