Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 1 | /* |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 2 | * Copyright (C) 2009 coresystems GmbH |
| 3 | * written by Patrick Georgi <patrick.georgi@coresystems.de> |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License as published by |
| 7 | * the Free Software Foundation; version 2 of the License. |
| 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., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA |
| 17 | */ |
| 18 | |
Stefan Reinauer | 6321758 | 2012-10-29 16:52:36 -0700 | [diff] [blame] | 19 | #ifndef __CBFS_H |
| 20 | #define __CBFS_H |
| 21 | |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 22 | #include <stdint.h> |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 23 | |
David Hendricks | 90ca3b6 | 2012-11-16 14:48:22 -0800 | [diff] [blame] | 24 | #define CBFS_HEADER_MAGIC 0x4F524243 |
| 25 | #define CBFS_HEADPTR_ADDR_X86 0xFFFFFFFC |
Hung-Te Lin | 086842a | 2013-01-04 12:33:03 +0800 | [diff] [blame] | 26 | #define CBFS_HEADER_VERSION1 0x31313131 |
| 27 | #define CBFS_HEADER_VERSION2 0x31313132 |
| 28 | #define CBFS_HEADER_VERSION CBFS_HEADER_VERSION2 |
David Hendricks | 90ca3b6 | 2012-11-16 14:48:22 -0800 | [diff] [blame] | 29 | |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 30 | struct cbfs_header { |
| 31 | uint32_t magic; |
| 32 | uint32_t version; |
| 33 | uint32_t romsize; |
| 34 | uint32_t bootblocksize; |
| 35 | uint32_t align; |
| 36 | uint32_t offset; |
David Hendricks | 90ca3b6 | 2012-11-16 14:48:22 -0800 | [diff] [blame] | 37 | uint32_t architecture; /* Version 2 */ |
| 38 | uint32_t pad[1]; |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 39 | } __attribute__ ((packed)); |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 40 | |
David Hendricks | 90ca3b6 | 2012-11-16 14:48:22 -0800 | [diff] [blame] | 41 | #define CBFS_ARCHITECTURE_UNKNOWN 0xFFFFFFFF |
| 42 | #define CBFS_ARCHITECTURE_X86 0x00000001 |
| 43 | #define CBFS_ARCHITECTURE_ARMV7 0x00000010 |
| 44 | |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 45 | struct cbfs_file { |
Stefan Reinauer | a1e4824 | 2011-10-21 14:24:57 -0700 | [diff] [blame] | 46 | uint8_t magic[8]; |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 47 | uint32_t len; |
| 48 | uint32_t type; |
| 49 | uint32_t checksum; |
| 50 | uint32_t offset; |
| 51 | } __attribute__ ((packed)); |
| 52 | |
| 53 | struct cbfs_stage { |
Stefan Reinauer | a1e4824 | 2011-10-21 14:24:57 -0700 | [diff] [blame] | 54 | uint32_t compression; |
| 55 | uint64_t entry; |
| 56 | uint64_t load; |
| 57 | uint32_t len; |
| 58 | uint32_t memlen; |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 59 | } __attribute__ ((packed)); |
| 60 | |
| 61 | #define PAYLOAD_SEGMENT_CODE 0x45444F43 |
| 62 | #define PAYLOAD_SEGMENT_DATA 0x41544144 |
| 63 | #define PAYLOAD_SEGMENT_BSS 0x20535342 |
| 64 | #define PAYLOAD_SEGMENT_PARAMS 0x41524150 |
| 65 | #define PAYLOAD_SEGMENT_ENTRY 0x52544E45 |
| 66 | |
| 67 | struct cbfs_payload_segment { |
Stefan Reinauer | a1e4824 | 2011-10-21 14:24:57 -0700 | [diff] [blame] | 68 | uint32_t type; |
| 69 | uint32_t compression; |
| 70 | uint32_t offset; |
| 71 | uint64_t load_addr; |
| 72 | uint32_t len; |
| 73 | uint32_t mem_len; |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 74 | } __attribute__ ((packed)); |
| 75 | |
| 76 | struct cbfs_payload { |
| 77 | struct cbfs_payload_segment segments; |
| 78 | } __attribute__ ((packed)); |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 79 | |
| 80 | /** These are standard component types for well known |
| 81 | components (i.e - those that coreboot needs to consume. |
| 82 | Users are welcome to use any other value for their |
| 83 | components */ |
| 84 | |
Stefan Reinauer | 800379f | 2010-03-01 08:34:19 +0000 | [diff] [blame] | 85 | #define CBFS_COMPONENT_STAGE 0x10 |
| 86 | #define CBFS_COMPONENT_PAYLOAD 0x20 |
| 87 | #define CBFS_COMPONENT_OPTIONROM 0x30 |
| 88 | #define CBFS_COMPONENT_BOOTSPLASH 0x40 |
| 89 | #define CBFS_COMPONENT_RAW 0x50 |
| 90 | #define CBFS_COMPONENT_VSA 0x51 |
| 91 | #define CBFS_COMPONENT_MBI 0x52 |
| 92 | #define CBFS_COMPONENT_MICROCODE 0x53 |
Patrick Georgi | a865b17 | 2011-01-14 07:40:24 +0000 | [diff] [blame] | 93 | #define CBFS_COMPONENT_CMOS_DEFAULT 0xaa |
Patrick Georgi | 2447937 | 2011-01-18 13:56:36 +0000 | [diff] [blame] | 94 | #define CBFS_COMPONENT_CMOS_LAYOUT 0x01aa |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 95 | |
Ronald G. Minnich | 83b8f0c | 2009-05-08 19:23:00 +0000 | [diff] [blame] | 96 | /* The deleted type is chosen to be a value |
| 97 | * that can be written in a FLASH from all other |
Stefan Reinauer | 14e2277 | 2010-04-27 06:56:47 +0000 | [diff] [blame] | 98 | * values. |
Ronald G. Minnich | 83b8f0c | 2009-05-08 19:23:00 +0000 | [diff] [blame] | 99 | */ |
| 100 | #define CBFS_COMPONENT_DELETED 0 |
| 101 | |
Stefan Reinauer | 14e2277 | 2010-04-27 06:56:47 +0000 | [diff] [blame] | 102 | /* for all known FLASH, this value can be changed |
| 103 | * to all other values. This allows NULL files to be |
Ronald G. Minnich | 83b8f0c | 2009-05-08 19:23:00 +0000 | [diff] [blame] | 104 | * changed without a block erase |
| 105 | */ |
Peter Stuge | 1d862de | 2009-04-14 00:08:34 +0000 | [diff] [blame] | 106 | #define CBFS_COMPONENT_NULL 0xFFFFFFFF |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 107 | |
David Hendricks | 90ca3b6 | 2012-11-16 14:48:22 -0800 | [diff] [blame] | 108 | int cbfs_file_header(unsigned long physaddr); |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 109 | struct cbfs_file *cbfs_create_empty_file(uint32_t physaddr, uint32_t size); |
Stefan Reinauer | 6321758 | 2012-10-29 16:52:36 -0700 | [diff] [blame] | 110 | |
| 111 | #endif |