CorebootPayloadPkg: Use extra braces to prevent gcc compile fail
[mirror_edk2.git] / CorebootModulePkg / Include / Coreboot.h
1 /** @file
2 Coreboot PEI module include file.
3
4 Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 /*
16 * This file is part of the libpayload project.
17 *
18 * Copyright (C) 2008 Advanced Micro Devices, Inc.
19 *
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions
22 * are met:
23 * 1. Redistributions of source code must retain the above copyright
24 * notice, this list of conditions and the following disclaimer.
25 * 2. Redistributions in binary form must reproduce the above copyright
26 * notice, this list of conditions and the following disclaimer in the
27 * documentation and/or other materials provided with the distribution.
28 * 3. The name of the author may not be used to endorse or promote products
29 * derived from this software without specific prior written permission.
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
32 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
33 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
35 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
39 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
40 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 * SUCH DAMAGE.
42 */
43
44
45 #ifndef _COREBOOT_PEI_H_INCLUDED_
46 #define _COREBOOT_PEI_H_INCLUDED_
47
48 #pragma warning( disable : 4200 )
49
50 #define DYN_CBMEM_ALIGN_SIZE (4096)
51
52 struct cbmem_entry {
53 UINT32 magic;
54 UINT32 start;
55 UINT32 size;
56 UINT32 id;
57 };
58
59 struct cbmem_root {
60 UINT32 max_entries;
61 UINT32 num_entries;
62 UINT32 locked;
63 UINT32 size;
64 struct cbmem_entry entries[0];
65 };
66
67 struct cbuint64 {
68 UINT32 lo;
69 UINT32 hi;
70 };
71
72 #define CB_HEADER_SIGNATURE 0x4F49424C
73
74 struct cb_header {
75 UINT32 signature;
76 UINT32 header_bytes;
77 UINT32 header_checksum;
78 UINT32 table_bytes;
79 UINT32 table_checksum;
80 UINT32 table_entries;
81 };
82
83 struct cb_record {
84 UINT32 tag;
85 UINT32 size;
86 };
87
88 #define CB_TAG_UNUSED 0x0000
89 #define CB_TAG_MEMORY 0x0001
90
91 struct cb_memory_range {
92 struct cbuint64 start;
93 struct cbuint64 size;
94 UINT32 type;
95 };
96
97 #define CB_MEM_RAM 1
98 #define CB_MEM_RESERVED 2
99 #define CB_MEM_ACPI 3
100 #define CB_MEM_NVS 4
101 #define CB_MEM_UNUSABLE 5
102 #define CB_MEM_VENDOR_RSVD 6
103 #define CB_MEM_TABLE 16
104
105 struct cb_memory {
106 UINT32 tag;
107 UINT32 size;
108 struct cb_memory_range map[0];
109 };
110
111 #define CB_TAG_MAINBOARD 0x0003
112
113 struct cb_mainboard {
114 UINT32 tag;
115 UINT32 size;
116 UINT8 vendor_idx;
117 UINT8 part_number_idx;
118 UINT8 strings[0];
119 };
120 #define CB_TAG_VERSION 0x0004
121 #define CB_TAG_EXTRA_VERSION 0x0005
122 #define CB_TAG_BUILD 0x0006
123 #define CB_TAG_COMPILE_TIME 0x0007
124 #define CB_TAG_COMPILE_BY 0x0008
125 #define CB_TAG_COMPILE_HOST 0x0009
126 #define CB_TAG_COMPILE_DOMAIN 0x000a
127 #define CB_TAG_COMPILER 0x000b
128 #define CB_TAG_LINKER 0x000c
129 #define CB_TAG_ASSEMBLER 0x000d
130
131 struct cb_string {
132 UINT32 tag;
133 UINT32 size;
134 UINT8 string[0];
135 };
136
137 #define CB_TAG_SERIAL 0x000f
138
139 struct cb_serial {
140 UINT32 tag;
141 UINT32 size;
142 #define CB_SERIAL_TYPE_IO_MAPPED 1
143 #define CB_SERIAL_TYPE_MEMORY_MAPPED 2
144 UINT32 type;
145 UINT32 baseaddr;
146 UINT32 baud;
147 };
148
149 #define CB_TAG_CONSOLE 0x00010
150
151 struct cb_console {
152 UINT32 tag;
153 UINT32 size;
154 UINT16 type;
155 };
156
157 #define CB_TAG_CONSOLE_SERIAL8250 0
158 #define CB_TAG_CONSOLE_VGA 1 // OBSOLETE
159 #define CB_TAG_CONSOLE_BTEXT 2 // OBSOLETE
160 #define CB_TAG_CONSOLE_LOGBUF 3
161 #define CB_TAG_CONSOLE_SROM 4 // OBSOLETE
162 #define CB_TAG_CONSOLE_EHCI 5
163
164 #define CB_TAG_FORWARD 0x00011
165
166 struct cb_forward {
167 UINT32 tag;
168 UINT32 size;
169 UINT64 forward;
170 };
171
172 #define CB_TAG_FRAMEBUFFER 0x0012
173 struct cb_framebuffer {
174 UINT32 tag;
175 UINT32 size;
176
177 UINT64 physical_address;
178 UINT32 x_resolution;
179 UINT32 y_resolution;
180 UINT32 bytes_per_line;
181 UINT8 bits_per_pixel;
182 UINT8 red_mask_pos;
183 UINT8 red_mask_size;
184 UINT8 green_mask_pos;
185 UINT8 green_mask_size;
186 UINT8 blue_mask_pos;
187 UINT8 blue_mask_size;
188 UINT8 reserved_mask_pos;
189 UINT8 reserved_mask_size;
190 };
191
192 #define CB_TAG_VDAT 0x0015
193 struct cb_vdat {
194 UINT32 tag;
195 UINT32 size; /* size of the entire entry */
196 UINT64 vdat_addr;
197 UINT32 vdat_size;
198 };
199
200 #define CB_TAG_TIMESTAMPS 0x0016
201 #define CB_TAG_CBMEM_CONSOLE 0x0017
202 #define CB_TAG_MRC_CACHE 0x0018
203 struct cb_cbmem_tab {
204 UINT32 tag;
205 UINT32 size;
206 UINT64 cbmem_tab;
207 };
208
209 /* Helpful macros */
210
211 #define MEM_RANGE_COUNT(_rec) \
212 (((_rec)->size - sizeof(*(_rec))) / sizeof((_rec)->map[0]))
213
214 #define MEM_RANGE_PTR(_rec, _idx) \
215 (void *)(((UINT8 *) (_rec)) + sizeof(*(_rec)) \
216 + (sizeof((_rec)->map[0]) * (_idx)))
217
218
219 #endif // _COREBOOT_PEI_H_INCLUDED_