]>
Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | #ifndef _LINUX_EFI_H |
3 | #define _LINUX_EFI_H | |
4 | ||
5 | /* | |
6 | * Extensible Firmware Interface | |
7 | * Based on 'Extensible Firmware Interface Specification' version 0.9, April 30, 1999 | |
8 | * | |
9 | * Copyright (C) 1999 VA Linux Systems | |
10 | * Copyright (C) 1999 Walt Drummond <drummond@valinux.com> | |
11 | * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co. | |
12 | * David Mosberger-Tang <davidm@hpl.hp.com> | |
13 | * Stephane Eranian <eranian@hpl.hp.com> | |
14 | */ | |
15 | #include <linux/init.h> | |
16 | #include <linux/string.h> | |
17 | #include <linux/time.h> | |
18 | #include <linux/types.h> | |
19 | #include <linux/proc_fs.h> | |
20 | #include <linux/rtc.h> | |
21 | #include <linux/ioport.h> | |
4a3575fd | 22 | #include <linux/pfn.h> |
5ee9c198 | 23 | #include <linux/pstore.h> |
60863c0d | 24 | #include <linux/range.h> |
8562c99c | 25 | #include <linux/reboot.h> |
ba7e34b1 | 26 | #include <linux/uuid.h> |
2c23b73c | 27 | #include <linux/screen_info.h> |
1da177e4 LT |
28 | |
29 | #include <asm/page.h> | |
1da177e4 LT |
30 | |
31 | #define EFI_SUCCESS 0 | |
32 | #define EFI_LOAD_ERROR ( 1 | (1UL << (BITS_PER_LONG-1))) | |
33 | #define EFI_INVALID_PARAMETER ( 2 | (1UL << (BITS_PER_LONG-1))) | |
34 | #define EFI_UNSUPPORTED ( 3 | (1UL << (BITS_PER_LONG-1))) | |
35 | #define EFI_BAD_BUFFER_SIZE ( 4 | (1UL << (BITS_PER_LONG-1))) | |
36 | #define EFI_BUFFER_TOO_SMALL ( 5 | (1UL << (BITS_PER_LONG-1))) | |
5d9db883 MG |
37 | #define EFI_NOT_READY ( 6 | (1UL << (BITS_PER_LONG-1))) |
38 | #define EFI_DEVICE_ERROR ( 7 | (1UL << (BITS_PER_LONG-1))) | |
39 | #define EFI_WRITE_PROTECTED ( 8 | (1UL << (BITS_PER_LONG-1))) | |
40 | #define EFI_OUT_OF_RESOURCES ( 9 | (1UL << (BITS_PER_LONG-1))) | |
1da177e4 | 41 | #define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1))) |
dce48e35 | 42 | #define EFI_ABORTED (21 | (1UL << (BITS_PER_LONG-1))) |
5d9db883 | 43 | #define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1))) |
1da177e4 LT |
44 | |
45 | typedef unsigned long efi_status_t; | |
46 | typedef u8 efi_bool_t; | |
47 | typedef u16 efi_char16_t; /* UNICODE character */ | |
ed37ddff RF |
48 | typedef u64 efi_physical_addr_t; |
49 | typedef void *efi_handle_t; | |
1da177e4 | 50 | |
89ed4865 | 51 | #if defined(CONFIG_X86_64) |
8f24f8c2 | 52 | #define __efiapi __attribute__((ms_abi)) |
89ed4865 AB |
53 | #elif defined(CONFIG_X86_32) |
54 | #define __efiapi __attribute__((regparm(0))) | |
8f24f8c2 AB |
55 | #else |
56 | #define __efiapi | |
57 | #endif | |
58 | ||
494c704f AB |
59 | /* |
60 | * The UEFI spec and EDK2 reference implementation both define EFI_GUID as | |
61 | * struct { u32 a; u16; b; u16 c; u8 d[8]; }; and so the implied alignment | |
62 | * is 32 bits not 8 bits like our guid_t. In some cases (i.e., on 32-bit ARM), | |
63 | * this means that firmware services invoked by the kernel may assume that | |
64 | * efi_guid_t* arguments are 32-bit aligned, and use memory accessors that | |
65 | * do not tolerate misalignment. So let's set the minimum alignment to 32 bits. | |
66 | * | |
67 | * Note that the UEFI spec as well as some comments in the EDK2 code base | |
68 | * suggest that EFI_GUID should be 64-bit aligned, but this appears to be | |
69 | * a mistake, given that no code seems to exist that actually enforces that | |
70 | * or relies on it. | |
71 | */ | |
72 | typedef guid_t efi_guid_t __aligned(__alignof__(u32)); | |
1da177e4 LT |
73 | |
74 | #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \ | |
c0020756 | 75 | GUID_INIT(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) |
1da177e4 LT |
76 | |
77 | /* | |
78 | * Generic EFI table header | |
79 | */ | |
80 | typedef struct { | |
81 | u64 signature; | |
82 | u32 revision; | |
83 | u32 headersize; | |
84 | u32 crc32; | |
85 | u32 reserved; | |
86 | } efi_table_hdr_t; | |
87 | ||
88 | /* | |
89 | * Memory map descriptor: | |
90 | */ | |
91 | ||
92 | /* Memory types: */ | |
93 | #define EFI_RESERVED_TYPE 0 | |
94 | #define EFI_LOADER_CODE 1 | |
95 | #define EFI_LOADER_DATA 2 | |
96 | #define EFI_BOOT_SERVICES_CODE 3 | |
97 | #define EFI_BOOT_SERVICES_DATA 4 | |
98 | #define EFI_RUNTIME_SERVICES_CODE 5 | |
99 | #define EFI_RUNTIME_SERVICES_DATA 6 | |
100 | #define EFI_CONVENTIONAL_MEMORY 7 | |
101 | #define EFI_UNUSABLE_MEMORY 8 | |
102 | #define EFI_ACPI_RECLAIM_MEMORY 9 | |
103 | #define EFI_ACPI_MEMORY_NVS 10 | |
104 | #define EFI_MEMORY_MAPPED_IO 11 | |
105 | #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12 | |
106 | #define EFI_PAL_CODE 13 | |
ad5fb870 DW |
107 | #define EFI_PERSISTENT_MEMORY 14 |
108 | #define EFI_MAX_MEMORY_TYPE 15 | |
1da177e4 LT |
109 | |
110 | /* Attribute values: */ | |
111 | #define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */ | |
112 | #define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */ | |
113 | #define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */ | |
114 | #define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */ | |
9c97e0bd | 115 | #define EFI_MEMORY_UCE ((u64)0x0000000000000010ULL) /* uncached, exported */ |
1da177e4 LT |
116 | #define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */ |
117 | #define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */ | |
118 | #define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */ | |
c016ca08 | 119 | #define EFI_MEMORY_NV ((u64)0x0000000000008000ULL) /* non-volatile */ |
b05b9f5f TL |
120 | #define EFI_MEMORY_MORE_RELIABLE \ |
121 | ((u64)0x0000000000010000ULL) /* higher reliability */ | |
87db73ae | 122 | #define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */ |
fe3e5e65 | 123 | #define EFI_MEMORY_SP ((u64)0x0000000000040000ULL) /* soft reserved */ |
1da177e4 LT |
124 | #define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */ |
125 | #define EFI_MEMORY_DESCRIPTOR_VERSION 1 | |
126 | ||
127 | #define EFI_PAGE_SHIFT 12 | |
ed37ddff | 128 | #define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT) |
0100a3e6 | 129 | #define EFI_PAGES_MAX (U64_MAX >> EFI_PAGE_SHIFT) |
1da177e4 | 130 | |
1da177e4 LT |
131 | typedef struct { |
132 | u32 type; | |
133 | u32 pad; | |
134 | u64 phys_addr; | |
135 | u64 virt_addr; | |
136 | u64 num_pages; | |
137 | u64 attribute; | |
1da177e4 LT |
138 | } efi_memory_desc_t; |
139 | ||
3b370237 MG |
140 | typedef struct { |
141 | efi_guid_t guid; | |
142 | u32 headersize; | |
143 | u32 flags; | |
144 | u32 imagesize; | |
145 | } efi_capsule_header_t; | |
146 | ||
f0133f3c MF |
147 | /* |
148 | * EFI capsule flags | |
149 | */ | |
150 | #define EFI_CAPSULE_PERSIST_ACROSS_RESET 0x00010000 | |
151 | #define EFI_CAPSULE_POPULATE_SYSTEM_TABLE 0x00020000 | |
152 | #define EFI_CAPSULE_INITIATE_RESET 0x00040000 | |
153 | ||
3fabd628 AB |
154 | struct capsule_info { |
155 | efi_capsule_header_t header; | |
f24c4d47 | 156 | efi_capsule_header_t *capsule; |
3fabd628 AB |
157 | int reset_type; |
158 | long index; | |
159 | size_t count; | |
160 | size_t total_size; | |
f24c4d47 AB |
161 | struct page **pages; |
162 | phys_addr_t *phys; | |
3fabd628 AB |
163 | size_t page_bytes_remain; |
164 | }; | |
165 | ||
166 | int __efi_capsule_setup_info(struct capsule_info *cap_info); | |
167 | ||
e088a4ad | 168 | typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg); |
1da177e4 LT |
169 | |
170 | /* | |
171 | * Types and defines for Time Services | |
172 | */ | |
173 | #define EFI_TIME_ADJUST_DAYLIGHT 0x1 | |
174 | #define EFI_TIME_IN_DAYLIGHT 0x2 | |
175 | #define EFI_UNSPECIFIED_TIMEZONE 0x07ff | |
176 | ||
177 | typedef struct { | |
178 | u16 year; | |
179 | u8 month; | |
180 | u8 day; | |
181 | u8 hour; | |
182 | u8 minute; | |
183 | u8 second; | |
184 | u8 pad1; | |
185 | u32 nanosecond; | |
186 | s16 timezone; | |
187 | u8 daylight; | |
188 | u8 pad2; | |
189 | } efi_time_t; | |
190 | ||
191 | typedef struct { | |
192 | u32 resolution; | |
193 | u32 accuracy; | |
194 | u8 sets_to_zero; | |
195 | } efi_time_cap_t; | |
196 | ||
8166ec09 | 197 | typedef union efi_boot_services efi_boot_services_t; |
33b6d034 | 198 | |
1da177e4 LT |
199 | /* |
200 | * Types and defines for EFI ResetSystem | |
201 | */ | |
202 | #define EFI_RESET_COLD 0 | |
203 | #define EFI_RESET_WARM 1 | |
204 | #define EFI_RESET_SHUTDOWN 2 | |
205 | ||
206 | /* | |
207 | * EFI Runtime Services table | |
208 | */ | |
209 | #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL) | |
210 | #define EFI_RUNTIME_SERVICES_REVISION 0x00010000 | |
211 | ||
677703ce MF |
212 | typedef struct { |
213 | efi_table_hdr_t hdr; | |
214 | u32 get_time; | |
215 | u32 set_time; | |
216 | u32 get_wakeup_time; | |
217 | u32 set_wakeup_time; | |
218 | u32 set_virtual_address_map; | |
219 | u32 convert_pointer; | |
220 | u32 get_variable; | |
221 | u32 get_next_variable; | |
222 | u32 set_variable; | |
223 | u32 get_next_high_mono_count; | |
224 | u32 reset_system; | |
225 | u32 update_capsule; | |
226 | u32 query_capsule_caps; | |
227 | u32 query_variable_info; | |
228 | } efi_runtime_services_32_t; | |
229 | ||
1da177e4 LT |
230 | typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc); |
231 | typedef efi_status_t efi_set_time_t (efi_time_t *tm); | |
232 | typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending, | |
233 | efi_time_t *tm); | |
234 | typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm); | |
235 | typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr, | |
236 | unsigned long *data_size, void *data); | |
237 | typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name, | |
238 | efi_guid_t *vendor); | |
239 | typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor, | |
f7a2d73f | 240 | u32 attr, unsigned long data_size, |
1da177e4 LT |
241 | void *data); |
242 | typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count); | |
243 | typedef void efi_reset_system_t (int reset_type, efi_status_t status, | |
244 | unsigned long data_size, efi_char16_t *data); | |
245 | typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size, | |
246 | unsigned long descriptor_size, | |
247 | u32 descriptor_version, | |
248 | efi_memory_desc_t *virtual_map); | |
3b370237 MG |
249 | typedef efi_status_t efi_query_variable_info_t(u32 attr, |
250 | u64 *storage_space, | |
251 | u64 *remaining_space, | |
252 | u64 *max_variable_size); | |
253 | typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules, | |
254 | unsigned long count, | |
255 | unsigned long sg_list); | |
256 | typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules, | |
257 | unsigned long count, | |
258 | u64 *max_size, | |
259 | int *reset_type); | |
ca0e30dc AB |
260 | typedef efi_status_t efi_query_variable_store_t(u32 attributes, |
261 | unsigned long size, | |
262 | bool nonblocking); | |
1da177e4 | 263 | |
1786e830 AB |
264 | typedef union { |
265 | struct { | |
8f24f8c2 AB |
266 | efi_table_hdr_t hdr; |
267 | efi_get_time_t __efiapi *get_time; | |
268 | efi_set_time_t __efiapi *set_time; | |
269 | efi_get_wakeup_time_t __efiapi *get_wakeup_time; | |
270 | efi_set_wakeup_time_t __efiapi *set_wakeup_time; | |
271 | efi_set_virtual_address_map_t __efiapi *set_virtual_address_map; | |
272 | void *convert_pointer; | |
273 | efi_get_variable_t __efiapi *get_variable; | |
274 | efi_get_next_variable_t __efiapi *get_next_variable; | |
275 | efi_set_variable_t __efiapi *set_variable; | |
276 | efi_get_next_high_mono_count_t __efiapi *get_next_high_mono_count; | |
277 | efi_reset_system_t __efiapi *reset_system; | |
278 | efi_update_capsule_t __efiapi *update_capsule; | |
279 | efi_query_capsule_caps_t __efiapi *query_capsule_caps; | |
280 | efi_query_variable_info_t __efiapi *query_variable_info; | |
1786e830 AB |
281 | }; |
282 | efi_runtime_services_32_t mixed_mode; | |
c4c39c70 AB |
283 | } efi_runtime_services_t; |
284 | ||
022ee6c5 AB |
285 | void efi_native_runtime_setup(void); |
286 | ||
1da177e4 | 287 | /* |
54fd11fe PJ |
288 | * EFI Configuration Table and GUID definitions |
289 | * | |
7fb2b43c IM |
290 | * These are all defined in a single line to make them easier to |
291 | * grep for and to see them at a glance - while still having a | |
292 | * similar structure to the definitions in the spec. | |
293 | * | |
294 | * Here's how they are structured: | |
54fd11fe PJ |
295 | * |
296 | * GUID: 12345678-1234-1234-1234-123456789012 | |
297 | * Spec: | |
298 | * #define EFI_SOME_PROTOCOL_GUID \ | |
299 | * {0x12345678,0x1234,0x1234,\ | |
300 | * {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}} | |
301 | * Here: | |
7fb2b43c IM |
302 | * #define SOME_PROTOCOL_GUID EFI_GUID(0x12345678, 0x1234, 0x1234, 0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12) |
303 | * ^ tabs ^extra space | |
304 | * | |
305 | * Note that the 'extra space' separates the values at the same place | |
306 | * where the UEFI SPEC breaks the line. | |
1da177e4 | 307 | */ |
7fb2b43c IM |
308 | #define NULL_GUID EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00) |
309 | #define MPS_TABLE_GUID EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) | |
310 | #define ACPI_TABLE_GUID EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) | |
311 | #define ACPI_20_TABLE_GUID EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81) | |
312 | #define SMBIOS_TABLE_GUID EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) | |
313 | #define SMBIOS3_TABLE_GUID EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94) | |
314 | #define SAL_SYSTEM_TABLE_GUID EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) | |
315 | #define HCDP_TABLE_GUID EFI_GUID(0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98) | |
316 | #define UGA_IO_PROTOCOL_GUID EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0x0b, 0x07, 0xa2) | |
317 | #define EFI_GLOBAL_VARIABLE_GUID EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c) | |
318 | #define UV_SYSTEM_TABLE_GUID EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93) | |
319 | #define LINUX_EFI_CRASH_GUID EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0) | |
320 | #define LOADED_IMAGE_PROTOCOL_GUID EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) | |
321 | #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a) | |
322 | #define EFI_UGA_PROTOCOL_GUID EFI_GUID(0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39) | |
323 | #define EFI_PCI_IO_PROTOCOL_GUID EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a) | |
324 | #define EFI_FILE_INFO_ID EFI_GUID(0x09576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) | |
325 | #define EFI_SYSTEM_RESOURCE_TABLE_GUID EFI_GUID(0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80) | |
326 | #define EFI_FILE_SYSTEM_GUID EFI_GUID(0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) | |
327 | #define DEVICE_TREE_GUID EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0) | |
328 | #define EFI_PROPERTIES_TABLE_GUID EFI_GUID(0x880aaca3, 0x4adc, 0x4a04, 0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5) | |
329 | #define EFI_RNG_PROTOCOL_GUID EFI_GUID(0x3152bca5, 0xeade, 0x433d, 0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44) | |
568bc4e8 | 330 | #define EFI_RNG_ALGORITHM_RAW EFI_GUID(0xe43176d7, 0xb6e8, 0x4827, 0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61) |
7fb2b43c IM |
331 | #define EFI_MEMORY_ATTRIBUTES_TABLE_GUID EFI_GUID(0xdcfa911d, 0x26eb, 0x469f, 0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20) |
332 | #define EFI_CONSOLE_OUT_DEVICE_GUID EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4, 0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) | |
58c5475a | 333 | #define APPLE_PROPERTIES_PROTOCOL_GUID EFI_GUID(0x91bd12fe, 0xf6c3, 0x44fb, 0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0) |
33b6d034 | 334 | #define EFI_TCG2_PROTOCOL_GUID EFI_GUID(0x607f766c, 0x7455, 0x42be, 0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f) |
2931d526 AB |
335 | #define EFI_LOAD_FILE_PROTOCOL_GUID EFI_GUID(0x56ec3091, 0x954c, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) |
336 | #define EFI_LOAD_FILE2_PROTOCOL_GUID EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e, 0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d) | |
fc372064 | 337 | |
e58910cd JB |
338 | #define EFI_IMAGE_SECURITY_DATABASE_GUID EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f) |
339 | #define EFI_SHIM_LOCK_GUID EFI_GUID(0x605dab50, 0xe046, 0x4300, 0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23) | |
340 | ||
5c126ba2 DH |
341 | #define EFI_CERT_SHA256_GUID EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28) |
342 | #define EFI_CERT_X509_GUID EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72) | |
343 | #define EFI_CERT_X509_SHA256_GUID EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed) | |
344 | ||
801820be AB |
345 | /* |
346 | * This GUID is used to pass to the kernel proper the struct screen_info | |
347 | * structure that was populated by the stub based on the GOP protocol instance | |
348 | * associated with ConOut | |
349 | */ | |
7fb2b43c IM |
350 | #define LINUX_EFI_ARM_SCREEN_INFO_TABLE_GUID EFI_GUID(0xe03fc20a, 0x85dc, 0x406e, 0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95) |
351 | #define LINUX_EFI_LOADER_ENTRY_GUID EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf, 0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f) | |
63625988 | 352 | #define LINUX_EFI_RANDOM_SEED_TABLE_GUID EFI_GUID(0x1ce1e5bc, 0x7ceb, 0x42f2, 0x81, 0xe5, 0x8a, 0xad, 0xf1, 0x80, 0xf5, 0x7b) |
33b6d034 | 353 | #define LINUX_EFI_TPM_EVENT_LOG_GUID EFI_GUID(0xb7799cb0, 0xeca2, 0x4943, 0x96, 0x67, 0x1f, 0xae, 0x07, 0xb7, 0x47, 0xfa) |
c46f3405 | 354 | #define LINUX_EFI_TPM_FINAL_LOG_GUID EFI_GUID(0x1e2ed096, 0x30e2, 0x4254, 0xbd, 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25) |
71e0940d | 355 | #define LINUX_EFI_MEMRESERVE_TABLE_GUID EFI_GUID(0x888eb0c6, 0x8ede, 0x4ff5, 0xa8, 0xf0, 0x9a, 0xee, 0x5c, 0xb9, 0x77, 0xc2) |
06f7d4a1 | 356 | |
1c5fecb6 N |
357 | /* OEM GUIDs */ |
358 | #define DELLEMC_EFI_RCI2_TABLE_GUID EFI_GUID(0x2d9f28a2, 0xa886, 0x456a, 0x97, 0xa8, 0xf1, 0x1e, 0xf2, 0x4f, 0xf4, 0x55) | |
359 | ||
1adbfa35 OJ |
360 | typedef struct { |
361 | efi_guid_t guid; | |
362 | u64 table; | |
363 | } efi_config_table_64_t; | |
364 | ||
365 | typedef struct { | |
366 | efi_guid_t guid; | |
367 | u32 table; | |
368 | } efi_config_table_32_t; | |
369 | ||
1786e830 AB |
370 | typedef union { |
371 | struct { | |
372 | efi_guid_t guid; | |
f958efe9 | 373 | void *table; |
1786e830 AB |
374 | }; |
375 | efi_config_table_32_t mixed_mode; | |
1da177e4 LT |
376 | } efi_config_table_t; |
377 | ||
272686bf LL |
378 | typedef struct { |
379 | efi_guid_t guid; | |
380 | const char *name; | |
381 | unsigned long *ptr; | |
382 | } efi_config_table_type_t; | |
383 | ||
1da177e4 | 384 | #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL) |
1da177e4 | 385 | |
3b370237 MG |
386 | #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30)) |
387 | #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20)) | |
388 | #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10)) | |
389 | #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00)) | |
390 | #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10)) | |
391 | #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02)) | |
392 | ||
1adbfa35 OJ |
393 | typedef struct { |
394 | efi_table_hdr_t hdr; | |
395 | u64 fw_vendor; /* physical addr of CHAR16 vendor string */ | |
396 | u32 fw_revision; | |
397 | u32 __pad1; | |
398 | u64 con_in_handle; | |
399 | u64 con_in; | |
400 | u64 con_out_handle; | |
401 | u64 con_out; | |
402 | u64 stderr_handle; | |
403 | u64 stderr; | |
404 | u64 runtime; | |
405 | u64 boottime; | |
406 | u32 nr_tables; | |
407 | u32 __pad2; | |
408 | u64 tables; | |
409 | } efi_system_table_64_t; | |
410 | ||
411 | typedef struct { | |
412 | efi_table_hdr_t hdr; | |
413 | u32 fw_vendor; /* physical addr of CHAR16 vendor string */ | |
414 | u32 fw_revision; | |
415 | u32 con_in_handle; | |
416 | u32 con_in; | |
417 | u32 con_out_handle; | |
418 | u32 con_out; | |
419 | u32 stderr_handle; | |
420 | u32 stderr; | |
421 | u32 runtime; | |
422 | u32 boottime; | |
423 | u32 nr_tables; | |
424 | u32 tables; | |
425 | } efi_system_table_32_t; | |
426 | ||
960a8d01 AB |
427 | typedef union efi_simple_text_output_protocol efi_simple_text_output_protocol_t; |
428 | ||
1786e830 AB |
429 | typedef union { |
430 | struct { | |
431 | efi_table_hdr_t hdr; | |
432 | unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */ | |
433 | u32 fw_revision; | |
434 | unsigned long con_in_handle; | |
435 | unsigned long con_in; | |
436 | unsigned long con_out_handle; | |
960a8d01 | 437 | efi_simple_text_output_protocol_t *con_out; |
1786e830 AB |
438 | unsigned long stderr_handle; |
439 | unsigned long stderr; | |
440 | efi_runtime_services_t *runtime; | |
441 | efi_boot_services_t *boottime; | |
442 | unsigned long nr_tables; | |
443 | unsigned long tables; | |
444 | }; | |
445 | efi_system_table_32_t mixed_mode; | |
1da177e4 LT |
446 | } efi_system_table_t; |
447 | ||
9479c7ce MF |
448 | /* |
449 | * Architecture independent structure for describing a memory map for the | |
1db91035 DW |
450 | * benefit of efi_memmap_init_early(), and for passing context between |
451 | * efi_memmap_alloc() and efi_memmap_install(). | |
9479c7ce MF |
452 | */ |
453 | struct efi_memory_map_data { | |
454 | phys_addr_t phys_map; | |
455 | unsigned long size; | |
456 | unsigned long desc_version; | |
457 | unsigned long desc_size; | |
26c0e44a | 458 | unsigned long flags; |
9479c7ce MF |
459 | }; |
460 | ||
1da177e4 | 461 | struct efi_memory_map { |
44511fb9 | 462 | phys_addr_t phys_map; |
7ae65fd3 MT |
463 | void *map; |
464 | void *map_end; | |
1da177e4 LT |
465 | int nr_map; |
466 | unsigned long desc_version; | |
7ae65fd3 | 467 | unsigned long desc_size; |
26c0e44a | 468 | #define EFI_MEMMAP_LATE (1UL << 0) |
1db91035 DW |
469 | #define EFI_MEMMAP_MEMBLOCK (1UL << 1) |
470 | #define EFI_MEMMAP_SLAB (1UL << 2) | |
26c0e44a | 471 | unsigned long flags; |
1da177e4 LT |
472 | }; |
473 | ||
60863c0d MF |
474 | struct efi_mem_range { |
475 | struct range range; | |
476 | u64 attribute; | |
1da177e4 LT |
477 | }; |
478 | ||
0302f71c MS |
479 | struct efi_fdt_params { |
480 | u64 system_table; | |
481 | u64 mmap; | |
482 | u32 mmap_size; | |
483 | u32 desc_size; | |
484 | u32 desc_ver; | |
485 | }; | |
486 | ||
bf924863 AB |
487 | typedef struct { |
488 | u32 version; | |
489 | u32 length; | |
490 | u64 memory_protection_attribute; | |
491 | } efi_properties_table_t; | |
492 | ||
493 | #define EFI_PROPERTIES_TABLE_VERSION 0x00010000 | |
494 | #define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1 | |
495 | ||
b2c99e3c BH |
496 | #define EFI_INVALID_TABLE_ADDR (~0UL) |
497 | ||
a604af07 AB |
498 | typedef struct { |
499 | u32 version; | |
500 | u32 num_entries; | |
501 | u32 desc_size; | |
502 | u32 reserved; | |
503 | efi_memory_desc_t entry[0]; | |
504 | } efi_memory_attributes_table_t; | |
505 | ||
5c126ba2 DH |
506 | typedef struct { |
507 | efi_guid_t signature_owner; | |
508 | u8 signature_data[]; | |
509 | } efi_signature_data_t; | |
510 | ||
511 | typedef struct { | |
512 | efi_guid_t signature_type; | |
513 | u32 signature_list_size; | |
514 | u32 signature_header_size; | |
515 | u32 signature_size; | |
516 | u8 signature_header[]; | |
517 | /* efi_signature_data_t signatures[][] */ | |
518 | } efi_signature_list_t; | |
519 | ||
520 | typedef u8 efi_sha256_hash_t[32]; | |
521 | ||
522 | typedef struct { | |
523 | efi_sha256_hash_t to_be_signed_hash; | |
524 | efi_time_t time_of_revocation; | |
525 | } efi_cert_x509_sha256_t; | |
526 | ||
1da177e4 LT |
527 | /* |
528 | * All runtime access to EFI goes through this structure: | |
529 | */ | |
530 | extern struct efi { | |
531 | efi_system_table_t *systab; /* EFI system table */ | |
3b370237 | 532 | unsigned int runtime_version; /* Runtime services version */ |
b2c99e3c BH |
533 | unsigned long mps; /* MPS table */ |
534 | unsigned long acpi; /* ACPI table (IA64 ext 0.71) */ | |
535 | unsigned long acpi20; /* ACPI table (ACPI 2.0) */ | |
e1ccbbc9 AB |
536 | unsigned long smbios; /* SMBIOS table (32 bit entry point) */ |
537 | unsigned long smbios3; /* SMBIOS table (64 bit entry point) */ | |
b2c99e3c BH |
538 | unsigned long boot_info; /* boot info table */ |
539 | unsigned long hcdp; /* HCDP table */ | |
540 | unsigned long uga; /* UGA table */ | |
a0998eb1 DY |
541 | unsigned long fw_vendor; /* fw_vendor */ |
542 | unsigned long runtime; /* runtime table */ | |
543 | unsigned long config_table; /* config tables */ | |
0bb54905 | 544 | unsigned long esrt; /* ESRT table */ |
bf924863 | 545 | unsigned long properties_table; /* properties table */ |
a604af07 | 546 | unsigned long mem_attr_table; /* memory attributes table */ |
63625988 | 547 | unsigned long rng_seed; /* UEFI firmware random seed */ |
33b6d034 | 548 | unsigned long tpm_log; /* TPM2 Event Log table */ |
c46f3405 | 549 | unsigned long tpm_final_log; /* TPM2 Final Events Log table */ |
71e0940d | 550 | unsigned long mem_reserve; /* Linux EFI memreserve table */ |
1da177e4 LT |
551 | efi_get_time_t *get_time; |
552 | efi_set_time_t *set_time; | |
553 | efi_get_wakeup_time_t *get_wakeup_time; | |
554 | efi_set_wakeup_time_t *set_wakeup_time; | |
555 | efi_get_variable_t *get_variable; | |
556 | efi_get_next_variable_t *get_next_variable; | |
557 | efi_set_variable_t *set_variable; | |
70d2a3cf | 558 | efi_set_variable_t *set_variable_nonblocking; |
3b370237 | 559 | efi_query_variable_info_t *query_variable_info; |
d3cac1f8 | 560 | efi_query_variable_info_t *query_variable_info_nonblocking; |
3b370237 MG |
561 | efi_update_capsule_t *update_capsule; |
562 | efi_query_capsule_caps_t *query_capsule_caps; | |
1da177e4 LT |
563 | efi_get_next_high_mono_count_t *get_next_high_mono_count; |
564 | efi_reset_system_t *reset_system; | |
884f4f66 | 565 | struct efi_memory_map memmap; |
3e909599 | 566 | unsigned long flags; |
1da177e4 LT |
567 | } efi; |
568 | ||
7e904a91 SP |
569 | extern struct mm_struct efi_mm; |
570 | ||
1da177e4 LT |
571 | static inline int |
572 | efi_guidcmp (efi_guid_t left, efi_guid_t right) | |
573 | { | |
574 | return memcmp(&left, &right, sizeof (efi_guid_t)); | |
575 | } | |
576 | ||
577 | static inline char * | |
26e02272 | 578 | efi_guid_to_str(efi_guid_t *guid, char *out) |
1da177e4 | 579 | { |
925ede0b | 580 | sprintf(out, "%pUl", guid->b); |
1da177e4 LT |
581 | return out; |
582 | } | |
583 | ||
584 | extern void efi_init (void); | |
585 | extern void *efi_get_pal_addr (void); | |
586 | extern void efi_map_pal_code (void); | |
1da177e4 | 587 | extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg); |
70f4f935 | 588 | extern void efi_gettimeofday (struct timespec64 *ts); |
1da177e4 | 589 | extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */ |
78510792 | 590 | #ifdef CONFIG_X86 |
ca0e30dc AB |
591 | extern efi_status_t efi_query_variable_store(u32 attributes, |
592 | unsigned long size, | |
593 | bool nonblocking); | |
78510792 | 594 | #else |
a6e4d5a0 | 595 | |
ca0e30dc AB |
596 | static inline efi_status_t efi_query_variable_store(u32 attributes, |
597 | unsigned long size, | |
598 | bool nonblocking) | |
a6e4d5a0 MF |
599 | { |
600 | return EFI_SUCCESS; | |
601 | } | |
78510792 | 602 | #endif |
7bc90e01 | 603 | extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr); |
9479c7ce | 604 | |
1db91035 DW |
605 | extern int __init efi_memmap_alloc(unsigned int num_entries, |
606 | struct efi_memory_map_data *data); | |
484a418d DW |
607 | extern void __efi_memmap_free(u64 phys, unsigned long size, |
608 | unsigned long flags); | |
9479c7ce | 609 | extern int __init efi_memmap_init_early(struct efi_memory_map_data *data); |
dca0f971 | 610 | extern int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size); |
9479c7ce | 611 | extern void __init efi_memmap_unmap(void); |
1db91035 | 612 | extern int __init efi_memmap_install(struct efi_memory_map_data *data); |
60863c0d MF |
613 | extern int __init efi_memmap_split_count(efi_memory_desc_t *md, |
614 | struct range *range); | |
615 | extern void __init efi_memmap_insert(struct efi_memory_map *old_memmap, | |
616 | void *buf, struct efi_mem_range *mem); | |
9479c7ce | 617 | |
272686bf | 618 | extern int efi_config_init(efi_config_table_type_t *arch_tables); |
3846c158 | 619 | #ifdef CONFIG_EFI_ESRT |
0bb54905 | 620 | extern void __init efi_esrt_init(void); |
3846c158 PJ |
621 | #else |
622 | static inline void efi_esrt_init(void) { } | |
623 | #endif | |
7bb68410 AB |
624 | extern int efi_config_parse_tables(void *config_tables, int count, int sz, |
625 | efi_config_table_type_t *arch_tables); | |
1da177e4 | 626 | extern u64 efi_get_iobase (void); |
f99afd08 | 627 | extern int efi_mem_type(unsigned long phys_addr); |
1da177e4 | 628 | extern u64 efi_mem_attributes (unsigned long phys_addr); |
32e62c63 | 629 | extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size); |
1da177e4 | 630 | extern int __init efi_uart_console_only (void); |
0bb54905 PJ |
631 | extern u64 efi_mem_desc_end(efi_memory_desc_t *md); |
632 | extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md); | |
816e7612 | 633 | extern void efi_mem_reserve(phys_addr_t addr, u64 size); |
a23d3bb0 | 634 | extern int efi_mem_reserve_persistent(phys_addr_t addr, u64 size); |
1da177e4 | 635 | extern void efi_initialize_iomem_resources(struct resource *code_resource, |
00bf4098 | 636 | struct resource *data_resource, struct resource *bss_resource); |
7968c0e3 | 637 | extern int efi_get_fdt_params(struct efi_fdt_params *params); |
0bb54905 | 638 | extern struct kobject *efi_kobj; |
1da177e4 | 639 | |
44be28e9 | 640 | extern int efi_reboot_quirk_mode; |
0c5ed61a MF |
641 | extern bool efi_poweroff_required(void); |
642 | ||
0f96a99d TI |
643 | #ifdef CONFIG_EFI_FAKE_MEMMAP |
644 | extern void __init efi_fake_memmap(void); | |
645 | #else | |
646 | static inline void efi_fake_memmap(void) { } | |
647 | #endif | |
648 | ||
10f0d2f5 AB |
649 | /* |
650 | * efi_memattr_perm_setter - arch specific callback function passed into | |
651 | * efi_memattr_apply_permissions() that updates the | |
652 | * mapping permissions described by the second | |
653 | * argument in the page tables referred to by the | |
654 | * first argument. | |
655 | */ | |
656 | typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *); | |
657 | ||
658 | extern int efi_memattr_init(void); | |
659 | extern int efi_memattr_apply_permissions(struct mm_struct *mm, | |
660 | efi_memattr_perm_setter fn); | |
661 | ||
02e43c2d BH |
662 | /* |
663 | * efi_early_memdesc_ptr - get the n-th EFI memmap descriptor | |
664 | * @map: the start of efi memmap | |
665 | * @desc_size: the size of space for each EFI memmap descriptor | |
666 | * @n: the index of efi memmap descriptor | |
667 | * | |
668 | * EFI boot service provides the GetMemoryMap() function to get a copy of the | |
669 | * current memory map which is an array of memory descriptors, each of | |
670 | * which describes a contiguous block of memory. It also gets the size of the | |
671 | * map, and the size of each descriptor, etc. | |
672 | * | |
673 | * Note that per section 6.2 of UEFI Spec 2.6 Errata A, the returned size of | |
674 | * each descriptor might not be equal to sizeof(efi_memory_memdesc_t), | |
675 | * since efi_memory_memdesc_t may be extended in the future. Thus the OS | |
676 | * MUST use the returned size of the descriptor to find the start of each | |
677 | * efi_memory_memdesc_t in the memory map array. This should only be used | |
678 | * during bootup since for_each_efi_memory_desc_xxx() is available after the | |
679 | * kernel initializes the EFI subsystem to set up struct efi_memory_map. | |
680 | */ | |
681 | #define efi_early_memdesc_ptr(map, desc_size, n) \ | |
682 | (efi_memory_desc_t *)((void *)(map) + ((n) * (desc_size))) | |
683 | ||
e885cd80 | 684 | /* Iterate through an efi_memory_map */ |
78ce248f | 685 | #define for_each_efi_memory_desc_in_map(m, md) \ |
e885cd80 | 686 | for ((md) = (m)->map; \ |
d4c4fed0 | 687 | (md) && ((void *)(md) + (m)->desc_size) <= (m)->map_end; \ |
e885cd80 MS |
688 | (md) = (void *)(md) + (m)->desc_size) |
689 | ||
78ce248f MF |
690 | /** |
691 | * for_each_efi_memory_desc - iterate over descriptors in efi.memmap | |
692 | * @md: the efi_memory_desc_t * iterator | |
693 | * | |
694 | * Once the loop finishes @md must not be accessed. | |
695 | */ | |
696 | #define for_each_efi_memory_desc(md) \ | |
884f4f66 | 697 | for_each_efi_memory_desc_in_map(&efi.memmap, md) |
78ce248f | 698 | |
98d2a6ca LE |
699 | /* |
700 | * Format an EFI memory descriptor's type and attributes to a user-provided | |
701 | * character buffer, as per snprintf(), and return the buffer. | |
702 | */ | |
703 | char * __init efi_md_typeattr_format(char *buf, size_t size, | |
704 | const efi_memory_desc_t *md); | |
705 | ||
0bc9ae39 DH |
706 | |
707 | typedef void (*efi_element_handler_t)(const char *source, | |
708 | const void *element_data, | |
709 | size_t element_size); | |
710 | extern int __init parse_efi_signature_list( | |
711 | const char *source, | |
712 | const void *data, size_t size, | |
713 | efi_element_handler_t (*get_handler_for_guid)(const efi_guid_t *)); | |
714 | ||
1da177e4 LT |
715 | /** |
716 | * efi_range_is_wc - check the WC bit on an address range | |
717 | * @start: starting kvirt address | |
718 | * @len: length of range | |
719 | * | |
720 | * Consult the EFI memory map and make sure it's ok to set this range WC. | |
721 | * Returns true or false. | |
722 | */ | |
723 | static inline int efi_range_is_wc(unsigned long start, unsigned long len) | |
724 | { | |
986a80d5 | 725 | unsigned long i; |
1da177e4 LT |
726 | |
727 | for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) { | |
728 | unsigned long paddr = __pa(start + i); | |
729 | if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC)) | |
730 | return 0; | |
731 | } | |
732 | /* The range checked out */ | |
733 | return 1; | |
734 | } | |
735 | ||
736 | #ifdef CONFIG_EFI_PCDP | |
737 | extern int __init efi_setup_pcdp_console(char *); | |
738 | #endif | |
739 | ||
740 | /* | |
83e68189 MF |
741 | * We play games with efi_enabled so that the compiler will, if |
742 | * possible, remove EFI-related code altogether. | |
1da177e4 | 743 | */ |
83e68189 | 744 | #define EFI_BOOT 0 /* Were we booted from EFI? */ |
83e68189 MF |
745 | #define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */ |
746 | #define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */ | |
747 | #define EFI_MEMMAP 4 /* Can we use EFI memory map? */ | |
748 | #define EFI_64BIT 5 /* Is the firmware 64-bit? */ | |
9f27bc54 DK |
749 | #define EFI_PARAVIRT 6 /* Access is via a paravirt interface */ |
750 | #define EFI_ARCH_1 7 /* First arch-specific bit */ | |
fed6cefe | 751 | #define EFI_DBG 8 /* Print additional debug info at runtime */ |
a1041713 | 752 | #define EFI_NX_PE_DATA 9 /* Can runtime data regions be mapped non-executable? */ |
a19ebf59 | 753 | #define EFI_MEM_ATTR 10 /* Did firmware publish an EFI_MEMORY_ATTRIBUTES table? */ |
b617c526 | 754 | #define EFI_MEM_NO_SOFT_RESERVE 11 /* Is the kernel configured to ignore soft reservations? */ |
83e68189 | 755 | |
1da177e4 | 756 | #ifdef CONFIG_EFI |
3e909599 MF |
757 | /* |
758 | * Test whether the above EFI_* bits are enabled. | |
759 | */ | |
760 | static inline bool efi_enabled(int feature) | |
761 | { | |
762 | return test_bit(feature, &efi.flags) != 0; | |
763 | } | |
8562c99c | 764 | extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused); |
b617c526 DW |
765 | |
766 | bool __pure __efi_soft_reserve_enabled(void); | |
767 | ||
768 | static inline bool __pure efi_soft_reserve_enabled(void) | |
769 | { | |
770 | return IS_ENABLED(CONFIG_EFI_SOFT_RESERVE) | |
771 | && __efi_soft_reserve_enabled(); | |
772 | } | |
1da177e4 | 773 | #else |
3e909599 | 774 | static inline bool efi_enabled(int feature) |
83e68189 | 775 | { |
3e909599 | 776 | return false; |
83e68189 | 777 | } |
8562c99c MF |
778 | static inline void |
779 | efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {} | |
87615a34 MF |
780 | |
781 | static inline bool | |
782 | efi_capsule_pending(int *reset_type) | |
783 | { | |
784 | return false; | |
785 | } | |
b617c526 DW |
786 | |
787 | static inline bool efi_soft_reserve_enabled(void) | |
788 | { | |
789 | return false; | |
790 | } | |
1da177e4 LT |
791 | #endif |
792 | ||
806b0351 MF |
793 | extern int efi_status_to_err(efi_status_t status); |
794 | ||
1da177e4 LT |
795 | /* |
796 | * Variable Attributes | |
797 | */ | |
798 | #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001 | |
799 | #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002 | |
800 | #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004 | |
41b3254c MG |
801 | #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008 |
802 | #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010 | |
803 | #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020 | |
804 | #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040 | |
805 | ||
806 | #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \ | |
807 | EFI_VARIABLE_BOOTSERVICE_ACCESS | \ | |
808 | EFI_VARIABLE_RUNTIME_ACCESS | \ | |
809 | EFI_VARIABLE_HARDWARE_ERROR_RECORD | \ | |
810 | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \ | |
811 | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \ | |
812 | EFI_VARIABLE_APPEND_WRITE) | |
e14ab23d MF |
813 | /* |
814 | * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")) | |
815 | * not including trailing NUL | |
816 | */ | |
ba7e34b1 | 817 | #define EFI_VARIABLE_GUID_LEN UUID_STRING_LEN |
e14ab23d | 818 | |
1da177e4 LT |
819 | /* |
820 | * EFI Device Path information | |
821 | */ | |
822 | #define EFI_DEV_HW 0x01 | |
823 | #define EFI_DEV_PCI 1 | |
824 | #define EFI_DEV_PCCARD 2 | |
825 | #define EFI_DEV_MEM_MAPPED 3 | |
826 | #define EFI_DEV_VENDOR 4 | |
827 | #define EFI_DEV_CONTROLLER 5 | |
828 | #define EFI_DEV_ACPI 0x02 | |
829 | #define EFI_DEV_BASIC_ACPI 1 | |
830 | #define EFI_DEV_EXPANDED_ACPI 2 | |
831 | #define EFI_DEV_MSG 0x03 | |
832 | #define EFI_DEV_MSG_ATAPI 1 | |
833 | #define EFI_DEV_MSG_SCSI 2 | |
834 | #define EFI_DEV_MSG_FC 3 | |
835 | #define EFI_DEV_MSG_1394 4 | |
836 | #define EFI_DEV_MSG_USB 5 | |
837 | #define EFI_DEV_MSG_USB_CLASS 15 | |
838 | #define EFI_DEV_MSG_I20 6 | |
839 | #define EFI_DEV_MSG_MAC 11 | |
840 | #define EFI_DEV_MSG_IPV4 12 | |
841 | #define EFI_DEV_MSG_IPV6 13 | |
842 | #define EFI_DEV_MSG_INFINIBAND 9 | |
843 | #define EFI_DEV_MSG_UART 14 | |
844 | #define EFI_DEV_MSG_VENDOR 10 | |
845 | #define EFI_DEV_MEDIA 0x04 | |
846 | #define EFI_DEV_MEDIA_HARD_DRIVE 1 | |
847 | #define EFI_DEV_MEDIA_CDROM 2 | |
848 | #define EFI_DEV_MEDIA_VENDOR 3 | |
849 | #define EFI_DEV_MEDIA_FILE 4 | |
850 | #define EFI_DEV_MEDIA_PROTOCOL 5 | |
851 | #define EFI_DEV_BIOS_BOOT 0x05 | |
852 | #define EFI_DEV_END_PATH 0x7F | |
853 | #define EFI_DEV_END_PATH2 0xFF | |
854 | #define EFI_DEV_END_INSTANCE 0x01 | |
855 | #define EFI_DEV_END_ENTIRE 0xFF | |
856 | ||
857 | struct efi_generic_dev_path { | |
db8952e7 AB |
858 | u8 type; |
859 | u8 sub_type; | |
860 | u16 length; | |
861 | } __packed; | |
862 | ||
863 | struct efi_acpi_dev_path { | |
864 | struct efi_generic_dev_path header; | |
865 | u32 hid; | |
866 | u32 uid; | |
867 | } __packed; | |
868 | ||
869 | struct efi_pci_dev_path { | |
870 | struct efi_generic_dev_path header; | |
871 | u8 fn; | |
872 | u8 dev; | |
873 | } __packed; | |
874 | ||
875 | struct efi_vendor_dev_path { | |
876 | struct efi_generic_dev_path header; | |
877 | efi_guid_t vendorguid; | |
878 | u8 vendordata[]; | |
879 | } __packed; | |
1da177e4 | 880 | |
46cd4b75 | 881 | struct efi_dev_path { |
46cd4b75 | 882 | union { |
db8952e7 AB |
883 | struct efi_generic_dev_path header; |
884 | struct efi_acpi_dev_path acpi; | |
885 | struct efi_pci_dev_path pci; | |
886 | struct efi_vendor_dev_path vendor; | |
46cd4b75 | 887 | }; |
db8952e7 | 888 | } __packed; |
46cd4b75 | 889 | |
db8952e7 AB |
890 | struct device *efi_get_device_by_path(const struct efi_dev_path **node, |
891 | size_t *len); | |
46cd4b75 | 892 | |
4a3575fd HY |
893 | static inline void memrange_efi_to_native(u64 *addr, u64 *npages) |
894 | { | |
895 | *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr); | |
896 | *addr &= PAGE_MASK; | |
897 | } | |
898 | ||
4fc756bd MW |
899 | /* |
900 | * EFI Variable support. | |
901 | * | |
902 | * Different firmware drivers can expose their EFI-like variables using | |
903 | * the following. | |
904 | */ | |
905 | ||
906 | struct efivar_operations { | |
907 | efi_get_variable_t *get_variable; | |
908 | efi_get_next_variable_t *get_next_variable; | |
909 | efi_set_variable_t *set_variable; | |
70d2a3cf | 910 | efi_set_variable_t *set_variable_nonblocking; |
a6e4d5a0 | 911 | efi_query_variable_store_t *query_variable_store; |
4fc756bd MW |
912 | }; |
913 | ||
914 | struct efivars { | |
4fc756bd | 915 | struct kset *kset; |
605e70c7 | 916 | struct kobject *kobject; |
4fc756bd MW |
917 | const struct efivar_operations *ops; |
918 | }; | |
919 | ||
e14ab23d MF |
920 | /* |
921 | * The maximum size of VariableName + Data = 1024 | |
922 | * Therefore, it's reasonable to save that much | |
923 | * space in each part of the structure, | |
924 | * and we use a page for reading/writing. | |
925 | */ | |
926 | ||
a5d92ad3 MF |
927 | #define EFI_VAR_NAME_LEN 1024 |
928 | ||
e14ab23d | 929 | struct efi_variable { |
a5d92ad3 | 930 | efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)]; |
e14ab23d MF |
931 | efi_guid_t VendorGuid; |
932 | unsigned long DataSize; | |
933 | __u8 Data[1024]; | |
934 | efi_status_t Status; | |
935 | __u32 Attributes; | |
936 | } __attribute__((packed)); | |
937 | ||
938 | struct efivar_entry { | |
939 | struct efi_variable var; | |
940 | struct list_head list; | |
941 | struct kobject kobj; | |
e0d59733 SA |
942 | bool scanning; |
943 | bool deleting; | |
e14ab23d MF |
944 | }; |
945 | ||
04851772 MF |
946 | extern struct list_head efivar_sysfs_list; |
947 | ||
948 | static inline void | |
949 | efivar_unregister(struct efivar_entry *var) | |
950 | { | |
951 | kobject_put(&var->kobj); | |
952 | } | |
953 | ||
e14ab23d | 954 | int efivars_register(struct efivars *efivars, |
4fc756bd | 955 | const struct efivar_operations *ops, |
e14ab23d MF |
956 | struct kobject *kobject); |
957 | int efivars_unregister(struct efivars *efivars); | |
958 | struct kobject *efivars_kobject(void); | |
959 | ||
960 | int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *), | |
1cfd6316 | 961 | void *data, bool duplicates, struct list_head *head); |
e14ab23d | 962 | |
21b3ddd3 SC |
963 | int efivar_entry_add(struct efivar_entry *entry, struct list_head *head); |
964 | int efivar_entry_remove(struct efivar_entry *entry); | |
e14ab23d MF |
965 | |
966 | int __efivar_entry_delete(struct efivar_entry *entry); | |
967 | int efivar_entry_delete(struct efivar_entry *entry); | |
968 | ||
e14ab23d | 969 | int efivar_entry_size(struct efivar_entry *entry, unsigned long *size); |
8a415b8c MF |
970 | int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes, |
971 | unsigned long *size, void *data); | |
e14ab23d MF |
972 | int efivar_entry_get(struct efivar_entry *entry, u32 *attributes, |
973 | unsigned long *size, void *data); | |
974 | int efivar_entry_set(struct efivar_entry *entry, u32 attributes, | |
975 | unsigned long size, void *data, struct list_head *head); | |
976 | int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes, | |
977 | unsigned long *size, void *data, bool *set); | |
978 | int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes, | |
979 | bool block, unsigned long size, void *data); | |
980 | ||
21b3ddd3 | 981 | int efivar_entry_iter_begin(void); |
e14ab23d MF |
982 | void efivar_entry_iter_end(void); |
983 | ||
984 | int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *), | |
985 | struct list_head *head, void *data, | |
986 | struct efivar_entry **prev); | |
987 | int efivar_entry_iter(int (*func)(struct efivar_entry *, void *), | |
988 | struct list_head *head, void *data); | |
989 | ||
990 | struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid, | |
991 | struct list_head *head, bool remove); | |
992 | ||
8282f5d9 PJ |
993 | bool efivar_validate(efi_guid_t vendor, efi_char16_t *var_name, u8 *data, |
994 | unsigned long data_size); | |
ed8b0de5 PJ |
995 | bool efivar_variable_is_removable(efi_guid_t vendor, const char *name, |
996 | size_t len); | |
e14ab23d | 997 | |
a9499fa7 | 998 | extern struct work_struct efivar_work; |
04851772 MF |
999 | void efivar_run_worker(void); |
1000 | ||
a9499fa7 | 1001 | #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE) |
e14ab23d | 1002 | int efivars_sysfs_init(void); |
4fc756bd | 1003 | |
e0d59733 SA |
1004 | #define EFIVARS_DATA_SIZE_MAX 1024 |
1005 | ||
4fc756bd | 1006 | #endif /* CONFIG_EFI_VARS */ |
f0133f3c MF |
1007 | extern bool efi_capsule_pending(int *reset_type); |
1008 | ||
1009 | extern int efi_capsule_supported(efi_guid_t guid, u32 flags, | |
1010 | size_t size, int *reset); | |
1011 | ||
1012 | extern int efi_capsule_update(efi_capsule_header_t *capsule, | |
2a457fb3 | 1013 | phys_addr_t *pages); |
4fc756bd | 1014 | |
926172d4 DY |
1015 | #ifdef CONFIG_EFI_RUNTIME_MAP |
1016 | int efi_runtime_map_init(struct kobject *); | |
6a2c20e7 VG |
1017 | int efi_get_runtime_map_size(void); |
1018 | int efi_get_runtime_map_desc_size(void); | |
1019 | int efi_runtime_map_copy(void *buf, size_t bufsz); | |
926172d4 DY |
1020 | #else |
1021 | static inline int efi_runtime_map_init(struct kobject *kobj) | |
1022 | { | |
1023 | return 0; | |
1024 | } | |
1025 | ||
6a2c20e7 VG |
1026 | static inline int efi_get_runtime_map_size(void) |
1027 | { | |
1028 | return 0; | |
1029 | } | |
1030 | ||
1031 | static inline int efi_get_runtime_map_desc_size(void) | |
1032 | { | |
1033 | return 0; | |
1034 | } | |
1035 | ||
1036 | static inline int efi_runtime_map_copy(void *buf, size_t bufsz) | |
1037 | { | |
1038 | return 0; | |
1039 | } | |
1040 | ||
926172d4 DY |
1041 | #endif |
1042 | ||
0082517f JHP |
1043 | #ifdef CONFIG_EFI |
1044 | extern bool efi_runtime_disabled(void); | |
1045 | #else | |
1046 | static inline bool efi_runtime_disabled(void) { return true; } | |
1047 | #endif | |
1048 | ||
80e75596 | 1049 | extern void efi_call_virt_check_flags(unsigned long flags, const char *call); |
13b210dd | 1050 | extern unsigned long efi_call_virt_save_flags(void); |
80e75596 | 1051 | |
de8cb458 DH |
1052 | enum efi_secureboot_mode { |
1053 | efi_secureboot_mode_unset, | |
1054 | efi_secureboot_mode_unknown, | |
1055 | efi_secureboot_mode_disabled, | |
1056 | efi_secureboot_mode_enabled, | |
1057 | }; | |
cd33a5c1 | 1058 | enum efi_secureboot_mode efi_get_secureboot(void); |
de8cb458 | 1059 | |
ccc829ba | 1060 | #ifdef CONFIG_RESET_ATTACK_MITIGATION |
cd33a5c1 | 1061 | void efi_enable_reset_attack_mitigation(void); |
ccc829ba MG |
1062 | #else |
1063 | static inline void | |
cd33a5c1 | 1064 | efi_enable_reset_attack_mitigation(void) { } |
ccc829ba MG |
1065 | #endif |
1066 | ||
cd33a5c1 | 1067 | efi_status_t efi_random_get_seed(void); |
0d959814 | 1068 | |
cd33a5c1 | 1069 | void efi_retrieve_tpm2_eventlog(void); |
33b6d034 | 1070 | |
80e75596 AT |
1071 | /* |
1072 | * Arch code can implement the following three template macros, avoiding | |
1073 | * reptition for the void/non-void return cases of {__,}efi_call_virt(): | |
1074 | * | |
1075 | * * arch_efi_call_virt_setup() | |
1076 | * | |
1077 | * Sets up the environment for the call (e.g. switching page tables, | |
1078 | * allowing kernel-mode use of floating point, if required). | |
1079 | * | |
1080 | * * arch_efi_call_virt() | |
1081 | * | |
1082 | * Performs the call. The last expression in the macro must be the call | |
1083 | * itself, allowing the logic to be shared by the void and non-void | |
1084 | * cases. | |
1085 | * | |
1086 | * * arch_efi_call_virt_teardown() | |
1087 | * | |
1088 | * Restores the usual kernel environment once the call has returned. | |
1089 | */ | |
1090 | ||
1091 | #define efi_call_virt_pointer(p, f, args...) \ | |
1092 | ({ \ | |
1093 | efi_status_t __s; \ | |
1094 | unsigned long __flags; \ | |
1095 | \ | |
1096 | arch_efi_call_virt_setup(); \ | |
1097 | \ | |
13b210dd | 1098 | __flags = efi_call_virt_save_flags(); \ |
80e75596 AT |
1099 | __s = arch_efi_call_virt(p, f, args); \ |
1100 | efi_call_virt_check_flags(__flags, __stringify(f)); \ | |
1101 | \ | |
1102 | arch_efi_call_virt_teardown(); \ | |
1103 | \ | |
1104 | __s; \ | |
1105 | }) | |
1106 | ||
1107 | #define __efi_call_virt_pointer(p, f, args...) \ | |
1108 | ({ \ | |
1109 | unsigned long __flags; \ | |
1110 | \ | |
1111 | arch_efi_call_virt_setup(); \ | |
1112 | \ | |
13b210dd | 1113 | __flags = efi_call_virt_save_flags(); \ |
80e75596 AT |
1114 | arch_efi_call_virt(p, f, args); \ |
1115 | efi_call_virt_check_flags(__flags, __stringify(f)); \ | |
1116 | \ | |
1117 | arch_efi_call_virt_teardown(); \ | |
1118 | }) | |
1119 | ||
c2ceb5fd AB |
1120 | #define EFI_RANDOM_SEED_SIZE 64U |
1121 | ||
63625988 AB |
1122 | struct linux_efi_random_seed { |
1123 | u32 size; | |
1124 | u8 bits[]; | |
1125 | }; | |
1126 | ||
33b6d034 TW |
1127 | struct linux_efi_tpm_eventlog { |
1128 | u32 size; | |
166a2809 | 1129 | u32 final_events_preboot_size; |
33b6d034 TW |
1130 | u8 version; |
1131 | u8 log[]; | |
1132 | }; | |
1133 | ||
1134 | extern int efi_tpm_eventlog_init(void); | |
1135 | ||
c46f3405 MG |
1136 | struct efi_tcg2_final_events_table { |
1137 | u64 version; | |
1138 | u64 nr_events; | |
1139 | u8 events[]; | |
1140 | }; | |
1141 | extern int efi_tpm_final_log_size; | |
1142 | ||
1c5fecb6 N |
1143 | extern unsigned long rci2_table_phys; |
1144 | ||
3425d934 SP |
1145 | /* |
1146 | * efi_runtime_service() function identifiers. | |
1147 | * "NONE" is used by efi_recover_from_page_fault() to check if the page | |
1148 | * fault happened while executing an efi runtime service. | |
1149 | */ | |
9dbbedaa | 1150 | enum efi_rts_ids { |
5c418dc7 AR |
1151 | EFI_NONE, |
1152 | EFI_GET_TIME, | |
1153 | EFI_SET_TIME, | |
1154 | EFI_GET_WAKEUP_TIME, | |
1155 | EFI_SET_WAKEUP_TIME, | |
1156 | EFI_GET_VARIABLE, | |
1157 | EFI_GET_NEXT_VARIABLE, | |
1158 | EFI_SET_VARIABLE, | |
1159 | EFI_QUERY_VARIABLE_INFO, | |
1160 | EFI_GET_NEXT_HIGH_MONO_COUNT, | |
1161 | EFI_RESET_SYSTEM, | |
1162 | EFI_UPDATE_CAPSULE, | |
1163 | EFI_QUERY_CAPSULE_CAPS, | |
9dbbedaa SP |
1164 | }; |
1165 | ||
1166 | /* | |
1167 | * efi_runtime_work: Details of EFI Runtime Service work | |
1168 | * @arg<1-5>: EFI Runtime Service function arguments | |
1169 | * @status: Status of executing EFI Runtime Service | |
1170 | * @efi_rts_id: EFI Runtime Service function identifier | |
1171 | * @efi_rts_comp: Struct used for handling completions | |
1172 | */ | |
1173 | struct efi_runtime_work { | |
1174 | void *arg1; | |
1175 | void *arg2; | |
1176 | void *arg3; | |
1177 | void *arg4; | |
1178 | void *arg5; | |
1179 | efi_status_t status; | |
1180 | struct work_struct work; | |
1181 | enum efi_rts_ids efi_rts_id; | |
1182 | struct completion efi_rts_comp; | |
1183 | }; | |
1184 | ||
1185 | extern struct efi_runtime_work efi_rts_work; | |
1186 | ||
3eb420e7 SP |
1187 | /* Workqueue to queue EFI Runtime Services */ |
1188 | extern struct workqueue_struct *efi_rts_wq; | |
1189 | ||
71e0940d | 1190 | struct linux_efi_memreserve { |
5f0b0ecf AB |
1191 | int size; // allocated size of the array |
1192 | atomic_t count; // number of entries used | |
1193 | phys_addr_t next; // pa of next struct instance | |
1194 | struct { | |
1195 | phys_addr_t base; | |
1196 | phys_addr_t size; | |
1197 | } entry[0]; | |
71e0940d AB |
1198 | }; |
1199 | ||
5f0b0ecf AB |
1200 | #define EFI_MEMRESERVE_SIZE(count) (sizeof(struct linux_efi_memreserve) + \ |
1201 | (count) * sizeof(((struct linux_efi_memreserve *)0)->entry[0])) | |
1202 | ||
80424b02 AB |
1203 | #define EFI_MEMRESERVE_COUNT(size) (((size) - sizeof(struct linux_efi_memreserve)) \ |
1204 | / sizeof(((struct linux_efi_memreserve *)0)->entry[0])) | |
1205 | ||
1da177e4 | 1206 | #endif /* _LINUX_EFI_H */ |