1 /* SPDX-License-Identifier: GPL-2.0 */
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>
22 #include <linux/pfn.h>
23 #include <linux/pstore.h>
24 #include <linux/range.h>
25 #include <linux/reboot.h>
26 #include <linux/uuid.h>
27
28 #include <asm/page.h>
29
30 struct screen_info;
31
32 #define EFI_SUCCESS 0
33 #define EFI_LOAD_ERROR ( 1 | (1UL << (BITS_PER_LONG-1)))
34 #define EFI_INVALID_PARAMETER ( 2 | (1UL << (BITS_PER_LONG-1)))
35 #define EFI_UNSUPPORTED ( 3 | (1UL << (BITS_PER_LONG-1)))
36 #define EFI_BAD_BUFFER_SIZE ( 4 | (1UL << (BITS_PER_LONG-1)))
37 #define EFI_BUFFER_TOO_SMALL ( 5 | (1UL << (BITS_PER_LONG-1)))
38 #define EFI_NOT_READY ( 6 | (1UL << (BITS_PER_LONG-1)))
39 #define EFI_DEVICE_ERROR ( 7 | (1UL << (BITS_PER_LONG-1)))
40 #define EFI_WRITE_PROTECTED ( 8 | (1UL << (BITS_PER_LONG-1)))
41 #define EFI_OUT_OF_RESOURCES ( 9 | (1UL << (BITS_PER_LONG-1)))
42 #define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
43 #define EFI_ACCESS_DENIED (15 | (1UL << (BITS_PER_LONG-1)))
44 #define EFI_TIMEOUT (18 | (1UL << (BITS_PER_LONG-1)))
45 #define EFI_ABORTED (21 | (1UL << (BITS_PER_LONG-1)))
46 #define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1)))
47
48 typedef unsigned long efi_status_t;
49 typedef u8 efi_bool_t;
50 typedef u16 efi_char16_t; /* UNICODE character */
51 typedef u64 efi_physical_addr_t;
52 typedef void *efi_handle_t;
53
54 #if defined(CONFIG_X86_64)
55 #define __efiapi __attribute__((ms_abi))
56 #elif defined(CONFIG_X86_32)
57 #define __efiapi __attribute__((regparm(0)))
58 #else
59 #define __efiapi
60 #endif
61
62 /*
63 * The UEFI spec and EDK2 reference implementation both define EFI_GUID as
64 * struct { u32 a; u16; b; u16 c; u8 d[8]; }; and so the implied alignment
65 * is 32 bits not 8 bits like our guid_t. In some cases (i.e., on 32-bit ARM),
66 * this means that firmware services invoked by the kernel may assume that
67 * efi_guid_t* arguments are 32-bit aligned, and use memory accessors that
68 * do not tolerate misalignment. So let's set the minimum alignment to 32 bits.
69 *
70 * Note that the UEFI spec as well as some comments in the EDK2 code base
71 * suggest that EFI_GUID should be 64-bit aligned, but this appears to be
72 * a mistake, given that no code seems to exist that actually enforces that
73 * or relies on it.
74 */
75 typedef guid_t efi_guid_t __aligned(__alignof__(u32));
76
77 #define EFI_GUID(a, b, c, d...) ((efi_guid_t){ { \
78 (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
79 (b) & 0xff, ((b) >> 8) & 0xff, \
80 (c) & 0xff, ((c) >> 8) & 0xff, d } })
81
82 /*
83 * Generic EFI table header
84 */
85 typedef struct {
86 u64 signature;
87 u32 revision;
88 u32 headersize;
89 u32 crc32;
90 u32 reserved;
91 } efi_table_hdr_t;
92
93 /*
94 * Memory map descriptor:
95 */
96
97 /* Memory types: */
98 #define EFI_RESERVED_TYPE 0
99 #define EFI_LOADER_CODE 1
100 #define EFI_LOADER_DATA 2
101 #define EFI_BOOT_SERVICES_CODE 3
102 #define EFI_BOOT_SERVICES_DATA 4
103 #define EFI_RUNTIME_SERVICES_CODE 5
104 #define EFI_RUNTIME_SERVICES_DATA 6
105 #define EFI_CONVENTIONAL_MEMORY 7
106 #define EFI_UNUSABLE_MEMORY 8
107 #define EFI_ACPI_RECLAIM_MEMORY 9
108 #define EFI_ACPI_MEMORY_NVS 10
109 #define EFI_MEMORY_MAPPED_IO 11
110 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
111 #define EFI_PAL_CODE 13
112 #define EFI_PERSISTENT_MEMORY 14
113 #define EFI_UNACCEPTED_MEMORY 15
114 #define EFI_MAX_MEMORY_TYPE 16
115
116 /* Attribute values: */
117 #define EFI_MEMORY_UC BIT_ULL(0) /* uncached */
118 #define EFI_MEMORY_WC BIT_ULL(1) /* write-coalescing */
119 #define EFI_MEMORY_WT BIT_ULL(2) /* write-through */
120 #define EFI_MEMORY_WB BIT_ULL(3) /* write-back */
121 #define EFI_MEMORY_UCE BIT_ULL(4) /* uncached, exported */
122 #define EFI_MEMORY_WP BIT_ULL(12) /* write-protect */
123 #define EFI_MEMORY_RP BIT_ULL(13) /* read-protect */
124 #define EFI_MEMORY_XP BIT_ULL(14) /* execute-protect */
125 #define EFI_MEMORY_NV BIT_ULL(15) /* non-volatile */
126 #define EFI_MEMORY_MORE_RELIABLE BIT_ULL(16) /* higher reliability */
127 #define EFI_MEMORY_RO BIT_ULL(17) /* read-only */
128 #define EFI_MEMORY_SP BIT_ULL(18) /* soft reserved */
129 #define EFI_MEMORY_CPU_CRYPTO BIT_ULL(19) /* supports encryption */
130 #define EFI_MEMORY_HOT_PLUGGABLE BIT_ULL(20) /* supports unplugging at runtime */
131 #define EFI_MEMORY_RUNTIME BIT_ULL(63) /* range requires runtime mapping */
132
133 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
134
135 #define EFI_PAGE_SHIFT 12
136 #define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
137 #define EFI_PAGES_MAX (U64_MAX >> EFI_PAGE_SHIFT)
138
139 typedef struct {
140 u32 type;
141 u32 pad;
142 u64 phys_addr;
143 u64 virt_addr;
144 u64 num_pages;
145 u64 attribute;
146 } efi_memory_desc_t;
147
148 typedef struct {
149 efi_guid_t guid;
150 u32 headersize;
151 u32 flags;
152 u32 imagesize;
153 } efi_capsule_header_t;
154
155 /* EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER */
156 struct efi_manage_capsule_header {
157 u32 ver;
158 u16 emb_drv_cnt;
159 u16 payload_cnt;
160 /*
161 * Variable-size array of the size given by the sum of
162 * emb_drv_cnt and payload_cnt.
163 */
164 u64 offset_list[];
165 } __packed;
166
167 /* EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER */
168 struct efi_manage_capsule_image_header {
169 u32 ver;
170 efi_guid_t image_type_id;
171 u8 image_index;
172 u8 reserved_bytes[3];
173 u32 image_size;
174 u32 vendor_code_size;
175 /* hw_ins was introduced in version 2 */
176 u64 hw_ins;
177 /* capsule_support was introduced in version 3 */
178 u64 capsule_support;
179 } __packed;
180
181 /* WIN_CERTIFICATE */
182 struct win_cert {
183 u32 len;
184 u16 rev;
185 u16 cert_type;
186 };
187
188 /* WIN_CERTIFICATE_UEFI_GUID */
189 struct win_cert_uefi_guid {
190 struct win_cert hdr;
191 efi_guid_t cert_type;
192 u8 cert_data[];
193 };
194
195 /* EFI_FIRMWARE_IMAGE_AUTHENTICATION */
196 struct efi_image_auth {
197 u64 mon_count;
198 struct win_cert_uefi_guid auth_info;
199 };
200
201 /*
202 * EFI capsule flags
203 */
204 #define EFI_CAPSULE_PERSIST_ACROSS_RESET 0x00010000
205 #define EFI_CAPSULE_POPULATE_SYSTEM_TABLE 0x00020000
206 #define EFI_CAPSULE_INITIATE_RESET 0x00040000
207
208 struct capsule_info {
209 efi_capsule_header_t header;
210 efi_capsule_header_t *capsule;
211 int reset_type;
212 long index;
213 size_t count;
214 size_t total_size;
215 struct page **pages;
216 phys_addr_t *phys;
217 size_t page_bytes_remain;
218 };
219
220 int efi_capsule_setup_info(struct capsule_info *cap_info, void *kbuff,
221 size_t hdr_bytes);
222 int __efi_capsule_setup_info(struct capsule_info *cap_info);
223
224 /*
225 * Types and defines for Time Services
226 */
227 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
228 #define EFI_TIME_IN_DAYLIGHT 0x2
229 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
230
231 typedef struct {
232 u16 year;
233 u8 month;
234 u8 day;
235 u8 hour;
236 u8 minute;
237 u8 second;
238 u8 pad1;
239 u32 nanosecond;
240 s16 timezone;
241 u8 daylight;
242 u8 pad2;
243 } efi_time_t;
244
245 typedef struct {
246 u32 resolution;
247 u32 accuracy;
248 u8 sets_to_zero;
249 } efi_time_cap_t;
250
251 typedef union efi_boot_services efi_boot_services_t;
252
253 /*
254 * Types and defines for EFI ResetSystem
255 */
256 #define EFI_RESET_COLD 0
257 #define EFI_RESET_WARM 1
258 #define EFI_RESET_SHUTDOWN 2
259
260 /*
261 * EFI Runtime Services table
262 */
263 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
264 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
265
266 typedef struct {
267 efi_table_hdr_t hdr;
268 u32 get_time;
269 u32 set_time;
270 u32 get_wakeup_time;
271 u32 set_wakeup_time;
272 u32 set_virtual_address_map;
273 u32 convert_pointer;
274 u32 get_variable;
275 u32 get_next_variable;
276 u32 set_variable;
277 u32 get_next_high_mono_count;
278 u32 reset_system;
279 u32 update_capsule;
280 u32 query_capsule_caps;
281 u32 query_variable_info;
282 } efi_runtime_services_32_t;
283
284 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
285 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
286 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
287 efi_time_t *tm);
288 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
289 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
290 unsigned long *data_size, void *data);
291 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
292 efi_guid_t *vendor);
293 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
294 u32 attr, unsigned long data_size,
295 void *data);
296 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
297 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
298 unsigned long data_size, efi_char16_t *data);
299 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
300 unsigned long descriptor_size,
301 u32 descriptor_version,
302 efi_memory_desc_t *virtual_map);
303 typedef efi_status_t efi_query_variable_info_t(u32 attr,
304 u64 *storage_space,
305 u64 *remaining_space,
306 u64 *max_variable_size);
307 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
308 unsigned long count,
309 unsigned long sg_list);
310 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
311 unsigned long count,
312 u64 *max_size,
313 int *reset_type);
314 typedef efi_status_t efi_query_variable_store_t(u32 attributes,
315 unsigned long size,
316 bool nonblocking);
317
318 typedef union {
319 struct {
320 efi_table_hdr_t hdr;
321 efi_get_time_t __efiapi *get_time;
322 efi_set_time_t __efiapi *set_time;
323 efi_get_wakeup_time_t __efiapi *get_wakeup_time;
324 efi_set_wakeup_time_t __efiapi *set_wakeup_time;
325 efi_set_virtual_address_map_t __efiapi *set_virtual_address_map;
326 void *convert_pointer;
327 efi_get_variable_t __efiapi *get_variable;
328 efi_get_next_variable_t __efiapi *get_next_variable;
329 efi_set_variable_t __efiapi *set_variable;
330 efi_get_next_high_mono_count_t __efiapi *get_next_high_mono_count;
331 efi_reset_system_t __efiapi *reset_system;
332 efi_update_capsule_t __efiapi *update_capsule;
333 efi_query_capsule_caps_t __efiapi *query_capsule_caps;
334 efi_query_variable_info_t __efiapi *query_variable_info;
335 };
336 efi_runtime_services_32_t mixed_mode;
337 } efi_runtime_services_t;
338
339 void efi_native_runtime_setup(void);
340
341 /*
342 * EFI Configuration Table and GUID definitions
343 *
344 * These are all defined in a single line to make them easier to
345 * grep for and to see them at a glance - while still having a
346 * similar structure to the definitions in the spec.
347 *
348 * Here's how they are structured:
349 *
350 * GUID: 12345678-1234-1234-1234-123456789012
351 * Spec:
352 * #define EFI_SOME_PROTOCOL_GUID \
353 * {0x12345678,0x1234,0x1234,\
354 * {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}}
355 * Here:
356 * #define SOME_PROTOCOL_GUID EFI_GUID(0x12345678, 0x1234, 0x1234, 0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12)
357 * ^ tabs ^extra space
358 *
359 * Note that the 'extra space' separates the values at the same place
360 * where the UEFI SPEC breaks the line.
361 */
362 #define NULL_GUID EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
363 #define ACPI_TABLE_GUID EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
364 #define ACPI_20_TABLE_GUID EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
365 #define SMBIOS_TABLE_GUID EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
366 #define SMBIOS3_TABLE_GUID EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94)
367 #define EFI_GLOBAL_VARIABLE_GUID EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
368 #define UV_SYSTEM_TABLE_GUID EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93)
369 #define LINUX_EFI_CRASH_GUID EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0)
370 #define LOADED_IMAGE_PROTOCOL_GUID EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
371 #define LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID EFI_GUID(0xbc62157e, 0x3e33, 0x4fec, 0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf)
372 #define EFI_DEVICE_PATH_PROTOCOL_GUID EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
373 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID EFI_GUID(0x8b843e20, 0x8132, 0x4852, 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
374 #define EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID EFI_GUID(0x05c99a21, 0xc70f, 0x4ad2, 0x8a, 0x5f, 0x35, 0xdf, 0x33, 0x43, 0xf5, 0x1e)
375 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
376 #define EFI_EDID_DISCOVERED_PROTOCOL_GUID EFI_GUID(0x1c0c34f6, 0xd380, 0x41fa, 0xa0, 0x49, 0x8a, 0xd0, 0x6c, 0x1a, 0x66, 0xaa)
377 #define EFI_EDID_ACTIVE_PROTOCOL_GUID EFI_GUID(0xbd8c1056, 0x9f36, 0x44ec, 0x92, 0xa8, 0xa6, 0x33, 0x7f, 0x81, 0x79, 0x86)
378 #define EFI_PCI_IO_PROTOCOL_GUID EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
379 #define EFI_FILE_INFO_ID EFI_GUID(0x09576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
380 #define EFI_SYSTEM_RESOURCE_TABLE_GUID EFI_GUID(0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
381 #define EFI_FILE_SYSTEM_GUID EFI_GUID(0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
382 #define DEVICE_TREE_GUID EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
383 #define EFI_RNG_PROTOCOL_GUID EFI_GUID(0x3152bca5, 0xeade, 0x433d, 0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
384 #define EFI_RNG_ALGORITHM_RAW EFI_GUID(0xe43176d7, 0xb6e8, 0x4827, 0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61)
385 #define EFI_MEMORY_ATTRIBUTES_TABLE_GUID EFI_GUID(0xdcfa911d, 0x26eb, 0x469f, 0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
386 #define EFI_CONSOLE_OUT_DEVICE_GUID EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4, 0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
387 #define APPLE_PROPERTIES_PROTOCOL_GUID EFI_GUID(0x91bd12fe, 0xf6c3, 0x44fb, 0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0)
388 #define APPLE_SET_OS_PROTOCOL_GUID EFI_GUID(0xc5c5da95, 0x7d5c, 0x45e6, 0xb2, 0xf1, 0x3f, 0xd5, 0x2b, 0xb1, 0x00, 0x77)
389 #define EFI_TCG2_PROTOCOL_GUID EFI_GUID(0x607f766c, 0x7455, 0x42be, 0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)
390 #define EFI_TCG2_FINAL_EVENTS_TABLE_GUID EFI_GUID(0x1e2ed096, 0x30e2, 0x4254, 0xbd, 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
391 #define EFI_LOAD_FILE_PROTOCOL_GUID EFI_GUID(0x56ec3091, 0x954c, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
392 #define EFI_LOAD_FILE2_PROTOCOL_GUID EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e, 0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d)
393 #define EFI_RT_PROPERTIES_TABLE_GUID EFI_GUID(0xeb66918a, 0x7eef, 0x402a, 0x84, 0x2e, 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9)
394 #define EFI_DXE_SERVICES_TABLE_GUID EFI_GUID(0x05ad34ba, 0x6f02, 0x4214, 0x95, 0x2e, 0x4d, 0xa0, 0x39, 0x8e, 0x2b, 0xb9)
395 #define EFI_SMBIOS_PROTOCOL_GUID EFI_GUID(0x03583ff6, 0xcb36, 0x4940, 0x94, 0x7e, 0xb9, 0xb3, 0x9f, 0x4a, 0xfa, 0xf7)
396 #define EFI_MEMORY_ATTRIBUTE_PROTOCOL_GUID EFI_GUID(0xf4560cf6, 0x40ec, 0x4b4a, 0xa1, 0x92, 0xbf, 0x1d, 0x57, 0xd0, 0xb1, 0x89)
397
398 #define EFI_IMAGE_SECURITY_DATABASE_GUID EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
399 #define EFI_SHIM_LOCK_GUID EFI_GUID(0x605dab50, 0xe046, 0x4300, 0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23)
400
401 #define EFI_CERT_SHA256_GUID EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
402 #define EFI_CERT_X509_GUID EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
403 #define EFI_CERT_X509_SHA256_GUID EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
404 #define EFI_CC_BLOB_GUID EFI_GUID(0x067b1f5f, 0xcf26, 0x44c5, 0x85, 0x54, 0x93, 0xd7, 0x77, 0x91, 0x2d, 0x42)
405 #define EFI_CC_MEASUREMENT_PROTOCOL_GUID EFI_GUID(0x96751a3d, 0x72f4, 0x41a6, 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, 0x6b)
406 #define EFI_CC_FINAL_EVENTS_TABLE_GUID EFI_GUID(0xdd4a4648, 0x2de7, 0x4665, 0x96, 0x4d, 0x21, 0xd9, 0xef, 0x5f, 0xb4, 0x46)
407
408 /*
409 * This GUIDs are used to pass to the kernel proper the primary
410 * display that has been populated by the stub based on the GOP
411 * instance associated with ConOut.
412 */
413 #define LINUX_EFI_PRIMARY_DISPLAY_TABLE_GUID EFI_GUID(0xe03fc20a, 0x85dc, 0x406e, 0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95)
414
415 #define LINUX_EFI_ARM_CPU_STATE_TABLE_GUID EFI_GUID(0xef79e4aa, 0x3c3d, 0x4989, 0xb9, 0x02, 0x07, 0xa9, 0x43, 0xe5, 0x50, 0xd2)
416 #define LINUX_EFI_LOADER_ENTRY_GUID EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf, 0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)
417 #define LINUX_EFI_RANDOM_SEED_TABLE_GUID EFI_GUID(0x1ce1e5bc, 0x7ceb, 0x42f2, 0x81, 0xe5, 0x8a, 0xad, 0xf1, 0x80, 0xf5, 0x7b)
418 #define LINUX_EFI_TPM_EVENT_LOG_GUID EFI_GUID(0xb7799cb0, 0xeca2, 0x4943, 0x96, 0x67, 0x1f, 0xae, 0x07, 0xb7, 0x47, 0xfa)
419 #define LINUX_EFI_MEMRESERVE_TABLE_GUID EFI_GUID(0x888eb0c6, 0x8ede, 0x4ff5, 0xa8, 0xf0, 0x9a, 0xee, 0x5c, 0xb9, 0x77, 0xc2)
420 #define LINUX_EFI_INITRD_MEDIA_GUID EFI_GUID(0x5568e427, 0x68fc, 0x4f3d, 0xac, 0x74, 0xca, 0x55, 0x52, 0x31, 0xcc, 0x68)
421 #define LINUX_EFI_MOK_VARIABLE_TABLE_GUID EFI_GUID(0xc451ed2b, 0x9694, 0x45d3, 0xba, 0xba, 0xed, 0x9f, 0x89, 0x88, 0xa3, 0x89)
422 #define LINUX_EFI_COCO_SECRET_AREA_GUID EFI_GUID(0xadf956ad, 0xe98c, 0x484c, 0xae, 0x11, 0xb5, 0x1c, 0x7d, 0x33, 0x64, 0x47)
423 #define LINUX_EFI_BOOT_MEMMAP_GUID EFI_GUID(0x800f683f, 0xd08b, 0x423a, 0xa2, 0x93, 0x96, 0x5c, 0x3c, 0x6f, 0xe2, 0xb4)
424 #define LINUX_EFI_UNACCEPTED_MEM_TABLE_GUID EFI_GUID(0xd5d1de3c, 0x105c, 0x44f9, 0x9e, 0xa9, 0xbc, 0xef, 0x98, 0x12, 0x00, 0x31)
425
426 #define RISCV_EFI_BOOT_PROTOCOL_GUID EFI_GUID(0xccd15fec, 0x6f73, 0x4eec, 0x83, 0x95, 0x3e, 0x69, 0xe4, 0xb9, 0x40, 0xbf)
427
428 /*
429 * This GUID may be installed onto the kernel image's handle as a NULL protocol
430 * to signal to the stub that the placement of the image should be respected,
431 * and moving the image in physical memory is undesirable. To ensure
432 * compatibility with 64k pages kernels with virtually mapped stacks, and to
433 * avoid defeating physical randomization, this protocol should only be
434 * installed if the image was placed at a randomized 128k aligned address in
435 * memory.
436 */
437 #define LINUX_EFI_LOADED_IMAGE_FIXED_GUID EFI_GUID(0xf5a37b6d, 0x3344, 0x42a5, 0xb6, 0xbb, 0x97, 0x86, 0x48, 0xc1, 0x89, 0x0a)
438
439 /* OEM GUIDs */
440 #define DELLEMC_EFI_RCI2_TABLE_GUID EFI_GUID(0x2d9f28a2, 0xa886, 0x456a, 0x97, 0xa8, 0xf1, 0x1e, 0xf2, 0x4f, 0xf4, 0x55)
441 #define AMD_SEV_MEM_ENCRYPT_GUID EFI_GUID(0x0cf29b71, 0x9e51, 0x433a, 0xa3, 0xb7, 0x81, 0xf3, 0xab, 0x16, 0xb8, 0x75)
442
443 /* OVMF protocol GUIDs */
444 #define OVMF_SEV_MEMORY_ACCEPTANCE_PROTOCOL_GUID EFI_GUID(0xc5a010fe, 0x38a7, 0x4531, 0x8a, 0x4a, 0x05, 0x00, 0xd2, 0xfd, 0x16, 0x49)
445 #define OVMF_MEMORY_LOG_TABLE_GUID EFI_GUID(0x95305139, 0xb20f, 0x4723, 0x84, 0x25, 0x62, 0x7c, 0x88, 0x8f, 0xf1, 0x21)
446
447 typedef struct {
448 efi_guid_t guid;
449 u64 table;
450 } efi_config_table_64_t;
451
452 typedef struct {
453 efi_guid_t guid;
454 u32 table;
455 } efi_config_table_32_t;
456
457 typedef union {
458 struct {
459 efi_guid_t guid;
460 void *table;
461 };
462 efi_config_table_32_t mixed_mode;
463 } efi_config_table_t;
464
465 typedef struct {
466 efi_guid_t guid;
467 unsigned long *ptr;
468 const char name[16];
469 } efi_config_table_type_t;
470
471 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
472 #define EFI_DXE_SERVICES_TABLE_SIGNATURE ((u64)0x565245535f455844ULL)
473
474 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
475 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
476 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
477 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
478 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
479 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
480
481 typedef struct {
482 efi_table_hdr_t hdr;
483 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
484 u32 fw_revision;
485 u32 __pad1;
486 u64 con_in_handle;
487 u64 con_in;
488 u64 con_out_handle;
489 u64 con_out;
490 u64 stderr_handle;
491 u64 stderr;
492 u64 runtime;
493 u64 boottime;
494 u32 nr_tables;
495 u32 __pad2;
496 u64 tables;
497 } efi_system_table_64_t;
498
499 typedef struct {
500 efi_table_hdr_t hdr;
501 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
502 u32 fw_revision;
503 u32 con_in_handle;
504 u32 con_in;
505 u32 con_out_handle;
506 u32 con_out;
507 u32 stderr_handle;
508 u32 stderr;
509 u32 runtime;
510 u32 boottime;
511 u32 nr_tables;
512 u32 tables;
513 } efi_system_table_32_t;
514
515 typedef union efi_simple_text_input_protocol efi_simple_text_input_protocol_t;
516 typedef union efi_simple_text_output_protocol efi_simple_text_output_protocol_t;
517
518 typedef union {
519 struct {
520 efi_table_hdr_t hdr;
521 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
522 u32 fw_revision;
523 unsigned long con_in_handle;
524 efi_simple_text_input_protocol_t *con_in;
525 unsigned long con_out_handle;
526 efi_simple_text_output_protocol_t *con_out;
527 unsigned long stderr_handle;
528 unsigned long stderr;
529 efi_runtime_services_t *runtime;
530 efi_boot_services_t *boottime;
531 unsigned long nr_tables;
532 unsigned long tables;
533 };
534 efi_system_table_32_t mixed_mode;
535 } efi_system_table_t;
536
537 struct efi_boot_memmap {
538 unsigned long map_size;
539 unsigned long desc_size;
540 u32 desc_ver;
541 unsigned long map_key;
542 unsigned long buff_size;
543 efi_memory_desc_t map[];
544 };
545
546 struct efi_unaccepted_memory {
547 u32 version;
548 u32 unit_size;
549 u64 phys_base;
550 u64 size;
551 unsigned long bitmap[];
552 };
553
554 /*
555 * Architecture independent structure for describing a memory map for the
556 * benefit of efi_memmap_init_early(), and for passing context between
557 * efi_memmap_alloc() and efi_memmap_install().
558 */
559 struct efi_memory_map_data {
560 phys_addr_t phys_map;
561 unsigned long size;
562 unsigned long desc_version;
563 unsigned long desc_size;
564 unsigned long flags;
565 };
566
567 struct efi_memory_map {
568 phys_addr_t phys_map;
569 void *map;
570 void *map_end;
571 int nr_map;
572 unsigned long desc_version;
573 unsigned long desc_size;
574 #define EFI_MEMMAP_LATE (1UL << 0)
575 #define EFI_MEMMAP_MEMBLOCK (1UL << 1)
576 #define EFI_MEMMAP_SLAB (1UL << 2)
577 unsigned long flags;
578 };
579
580 struct efi_mem_range {
581 struct range range;
582 u64 attribute;
583 };
584
585 typedef struct {
586 u16 version;
587 u16 length;
588 u32 runtime_services_supported;
589 } efi_rt_properties_table_t;
590
591 #define EFI_RT_PROPERTIES_TABLE_VERSION 0x1
592
593 #define EFI_INVALID_TABLE_ADDR (~0UL)
594
595 // BIT0 implies that Runtime code includes the forward control flow guard
596 // instruction, such as X86 CET-IBT or ARM BTI.
597 #define EFI_MEMORY_ATTRIBUTES_FLAGS_RT_FORWARD_CONTROL_FLOW_GUARD 0x1
598
599 typedef struct {
600 u32 version;
601 u32 num_entries;
602 u32 desc_size;
603 u32 flags;
604 /*
605 * There are @num_entries following, each of size @desc_size bytes,
606 * including an efi_memory_desc_t header. See efi_memdesc_ptr().
607 */
608 efi_memory_desc_t entry[];
609 } efi_memory_attributes_table_t;
610
611 typedef struct {
612 efi_guid_t signature_owner;
613 u8 signature_data[];
614 } efi_signature_data_t;
615
616 typedef struct {
617 efi_guid_t signature_type;
618 u32 signature_list_size;
619 u32 signature_header_size;
620 u32 signature_size;
621 u8 signature_header[];
622 /* efi_signature_data_t signatures[][] */
623 } efi_signature_list_t;
624
625 typedef u8 efi_sha256_hash_t[32];
626
627 typedef struct {
628 efi_sha256_hash_t to_be_signed_hash;
629 efi_time_t time_of_revocation;
630 } efi_cert_x509_sha256_t;
631
632 extern unsigned long __ro_after_init efi_rng_seed; /* RNG Seed table */
633
634 /*
635 * All runtime access to EFI goes through this structure:
636 */
637 extern struct efi {
638 const efi_runtime_services_t *runtime; /* EFI runtime services table */
639 unsigned int runtime_version; /* Runtime services version */
640 unsigned int runtime_supported_mask;
641
642 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
643 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
644 unsigned long smbios; /* SMBIOS table (32 bit entry point) */
645 unsigned long smbios3; /* SMBIOS table (64 bit entry point) */
646 unsigned long esrt; /* ESRT table */
647 unsigned long tpm_log; /* TPM2 Event Log table */
648 unsigned long tpm_final_log; /* TPM2 Final Events Log table */
649 unsigned long ovmf_debug_log;
650 unsigned long mokvar_table; /* MOK variable config table */
651 unsigned long coco_secret; /* Confidential computing secret table */
652 unsigned long unaccepted; /* Unaccepted memory table */
653
654 efi_get_time_t *get_time;
655 efi_set_time_t *set_time;
656 efi_get_wakeup_time_t *get_wakeup_time;
657 efi_set_wakeup_time_t *set_wakeup_time;
658 efi_get_variable_t *get_variable;
659 efi_get_next_variable_t *get_next_variable;
660 efi_set_variable_t *set_variable;
661 efi_set_variable_t *set_variable_nonblocking;
662 efi_query_variable_info_t *query_variable_info;
663 efi_query_variable_info_t *query_variable_info_nonblocking;
664 efi_update_capsule_t *update_capsule;
665 efi_query_capsule_caps_t *query_capsule_caps;
666 efi_get_next_high_mono_count_t *get_next_high_mono_count;
667 efi_reset_system_t *reset_system;
668
669 struct efi_memory_map memmap;
670 unsigned long flags;
671 } efi;
672
673 #define EFI_RT_SUPPORTED_GET_TIME 0x0001
674 #define EFI_RT_SUPPORTED_SET_TIME 0x0002
675 #define EFI_RT_SUPPORTED_GET_WAKEUP_TIME 0x0004
676 #define EFI_RT_SUPPORTED_SET_WAKEUP_TIME 0x0008
677 #define EFI_RT_SUPPORTED_GET_VARIABLE 0x0010
678 #define EFI_RT_SUPPORTED_GET_NEXT_VARIABLE_NAME 0x0020
679 #define EFI_RT_SUPPORTED_SET_VARIABLE 0x0040
680 #define EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP 0x0080
681 #define EFI_RT_SUPPORTED_CONVERT_POINTER 0x0100
682 #define EFI_RT_SUPPORTED_GET_NEXT_HIGH_MONOTONIC_COUNT 0x0200
683 #define EFI_RT_SUPPORTED_RESET_SYSTEM 0x0400
684 #define EFI_RT_SUPPORTED_UPDATE_CAPSULE 0x0800
685 #define EFI_RT_SUPPORTED_QUERY_CAPSULE_CAPABILITIES 0x1000
686 #define EFI_RT_SUPPORTED_QUERY_VARIABLE_INFO 0x2000
687
688 #define EFI_RT_SUPPORTED_ALL 0x3fff
689
690 #define EFI_RT_SUPPORTED_TIME_SERVICES 0x0003
691 #define EFI_RT_SUPPORTED_WAKEUP_SERVICES 0x000c
692 #define EFI_RT_SUPPORTED_VARIABLE_SERVICES 0x0070
693
694 extern struct mm_struct efi_mm;
695
mm_is_efi(struct mm_struct * mm)696 static inline bool mm_is_efi(struct mm_struct *mm)
697 {
698 return IS_ENABLED(CONFIG_EFI) && mm == &efi_mm;
699 }
700
701 static inline int
efi_guidcmp(efi_guid_t left,efi_guid_t right)702 efi_guidcmp (efi_guid_t left, efi_guid_t right)
703 {
704 return memcmp(&left, &right, sizeof (efi_guid_t));
705 }
706
707 static inline char *
efi_guid_to_str(efi_guid_t * guid,char * out)708 efi_guid_to_str(efi_guid_t *guid, char *out)
709 {
710 sprintf(out, "%pUl", guid->b);
711 return out;
712 }
713
714 extern void efi_init (void);
715 extern void efi_earlycon_reprobe(void);
716 #ifdef CONFIG_EFI
717 extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
718 #else
efi_enter_virtual_mode(void)719 static inline void efi_enter_virtual_mode (void) {}
720 #endif
721 #ifdef CONFIG_X86
722 extern efi_status_t efi_query_variable_store(u32 attributes,
723 unsigned long size,
724 bool nonblocking);
725 #else
726
efi_query_variable_store(u32 attributes,unsigned long size,bool nonblocking)727 static inline efi_status_t efi_query_variable_store(u32 attributes,
728 unsigned long size,
729 bool nonblocking)
730 {
731 return EFI_SUCCESS;
732 }
733 #endif
734
735 extern int __init __efi_memmap_init(struct efi_memory_map_data *data);
736 extern int __init efi_memmap_init_early(struct efi_memory_map_data *data);
737 extern int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size);
738 extern void __init efi_memmap_unmap(void);
739
740 #ifdef CONFIG_EFI_ESRT
741 extern void __init efi_esrt_init(void);
742 #else
efi_esrt_init(void)743 static inline void efi_esrt_init(void) { }
744 #endif
745 extern int efi_config_parse_tables(const efi_config_table_t *config_tables,
746 int count,
747 const efi_config_table_type_t *arch_tables);
748 extern int efi_systab_check_header(const efi_table_hdr_t *systab_hdr);
749 extern void efi_systab_report_header(const efi_table_hdr_t *systab_hdr,
750 unsigned long fw_vendor);
751 extern u64 efi_get_iobase (void);
752 extern int efi_mem_type(unsigned long phys_addr);
753 extern u64 efi_mem_attributes (unsigned long phys_addr);
754 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
755 extern int __init efi_uart_console_only (void);
756 extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
757 extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
758 extern int __efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
759 extern void efi_mem_reserve(phys_addr_t addr, u64 size);
760 extern int efi_mem_reserve_persistent(phys_addr_t addr, u64 size);
761 extern u64 efi_get_fdt_params(struct efi_memory_map_data *data);
762 extern struct kobject *efi_kobj;
763
764 extern int efi_reboot_quirk_mode;
765 extern bool efi_poweroff_required(void);
766
767 extern unsigned long efi_mem_attr_table;
768
769 /*
770 * efi_memattr_perm_setter - arch specific callback function passed into
771 * efi_memattr_apply_permissions() that updates the
772 * mapping permissions described by the second
773 * argument in the page tables referred to by the
774 * first argument.
775 */
776 typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *, bool);
777
778 extern void efi_memattr_init(void);
779 extern int efi_memattr_apply_permissions(struct mm_struct *mm,
780 efi_memattr_perm_setter fn);
781
782 /*
783 * efi_memdesc_ptr - get the n-th EFI memmap descriptor
784 * @map: the start of efi memmap
785 * @desc_size: the size of space for each EFI memmap descriptor
786 * @n: the index of efi memmap descriptor
787 *
788 * EFI boot service provides the GetMemoryMap() function to get a copy of the
789 * current memory map which is an array of memory descriptors, each of
790 * which describes a contiguous block of memory. It also gets the size of the
791 * map, and the size of each descriptor, etc.
792 *
793 * Note that per section 6.2 of UEFI Spec 2.6 Errata A, the returned size of
794 * each descriptor might not be equal to sizeof(efi_memory_memdesc_t),
795 * since efi_memory_memdesc_t may be extended in the future. Thus the OS
796 * MUST use the returned size of the descriptor to find the start of each
797 * efi_memory_memdesc_t in the memory map array. This should only be used
798 * during bootup since for_each_efi_memory_desc_xxx() is available after the
799 * kernel initializes the EFI subsystem to set up struct efi_memory_map.
800 */
801 #define efi_memdesc_ptr(map, desc_size, n) \
802 (efi_memory_desc_t *)((void *)(map) + ((n) * (desc_size)))
803
804 /* Iterate through an efi_memory_map */
805 #define for_each_efi_memory_desc_in_map(m, md) \
806 for ((md) = (m)->map; \
807 (md) && ((void *)(md) + (m)->desc_size) <= (m)->map_end; \
808 (md) = (void *)(md) + (m)->desc_size)
809
810 /**
811 * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
812 * @md: the efi_memory_desc_t * iterator
813 *
814 * Once the loop finishes @md must not be accessed.
815 */
816 #define for_each_efi_memory_desc(md) \
817 for_each_efi_memory_desc_in_map(&efi.memmap, md)
818
819 /*
820 * Format an EFI memory descriptor's type and attributes to a user-provided
821 * character buffer, as per snprintf(), and return the buffer.
822 */
823 char * __init efi_md_typeattr_format(char *buf, size_t size,
824 const efi_memory_desc_t *md);
825
826
827 typedef void (*efi_element_handler_t)(const char *source,
828 const void *element_data,
829 size_t element_size);
830 extern int __init parse_efi_signature_list(
831 const char *source,
832 const void *data, size_t size,
833 efi_element_handler_t (*get_handler_for_guid)(const efi_guid_t *));
834
835 /*
836 * We play games with efi_enabled so that the compiler will, if
837 * possible, remove EFI-related code altogether.
838 */
839 #define EFI_BOOT 0 /* Were we booted from EFI? */
840 #define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
841 #define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
842 #define EFI_MEMMAP 4 /* Can we use EFI memory map? */
843 #define EFI_64BIT 5 /* Is the firmware 64-bit? */
844 #define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
845 #define EFI_ARCH_1 7 /* First arch-specific bit */
846 #define EFI_DBG 8 /* Print additional debug info at runtime */
847 #define EFI_MEM_ATTR 9 /* Did firmware publish an EFI_MEMORY_ATTRIBUTES table? */
848 #define EFI_MEM_NO_SOFT_RESERVE 10 /* Is the kernel configured to ignore soft reservations? */
849 #define EFI_PRESERVE_BS_REGIONS 11 /* Are EFI boot-services memory segments available? */
850
851 #ifdef CONFIG_EFI
852 /*
853 * Test whether the above EFI_* bits are enabled.
854 */
efi_enabled(int feature)855 static inline bool efi_enabled(int feature)
856 {
857 return test_bit(feature, &efi.flags) != 0;
858 }
859 extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
860
861 bool __pure __efi_soft_reserve_enabled(void);
862
efi_soft_reserve_enabled(void)863 static inline bool __pure efi_soft_reserve_enabled(void)
864 {
865 return IS_ENABLED(CONFIG_EFI_SOFT_RESERVE)
866 && __efi_soft_reserve_enabled();
867 }
868
efi_rt_services_supported(unsigned int mask)869 static inline bool efi_rt_services_supported(unsigned int mask)
870 {
871 return (efi.runtime_supported_mask & mask) == mask;
872 }
873 extern void efi_find_mirror(void);
874 #else
efi_enabled(int feature)875 static inline bool efi_enabled(int feature)
876 {
877 return false;
878 }
879 static inline void
efi_reboot(enum reboot_mode reboot_mode,const char * __unused)880 efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
881
efi_soft_reserve_enabled(void)882 static inline bool efi_soft_reserve_enabled(void)
883 {
884 return false;
885 }
886
efi_rt_services_supported(unsigned int mask)887 static inline bool efi_rt_services_supported(unsigned int mask)
888 {
889 return false;
890 }
891
efi_find_mirror(void)892 static inline void efi_find_mirror(void) {}
893 #endif
894
895 extern int efi_status_to_err(efi_status_t status);
896
897 /*
898 * Variable Attributes
899 */
900 #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
901 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
902 #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
903 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
904 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
905 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
906 #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
907
908 #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
909 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
910 EFI_VARIABLE_RUNTIME_ACCESS | \
911 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
912 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
913 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
914 EFI_VARIABLE_APPEND_WRITE)
915 /*
916 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
917 * not including trailing NUL
918 */
919 #define EFI_VARIABLE_GUID_LEN UUID_STRING_LEN
920
921 /*
922 * EFI Device Path information
923 */
924 #define EFI_DEV_HW 0x01
925 #define EFI_DEV_PCI 1
926 #define EFI_DEV_PCCARD 2
927 #define EFI_DEV_MEM_MAPPED 3
928 #define EFI_DEV_VENDOR 4
929 #define EFI_DEV_CONTROLLER 5
930 #define EFI_DEV_ACPI 0x02
931 #define EFI_DEV_BASIC_ACPI 1
932 #define EFI_DEV_EXPANDED_ACPI 2
933 #define EFI_DEV_MSG 0x03
934 #define EFI_DEV_MSG_ATAPI 1
935 #define EFI_DEV_MSG_SCSI 2
936 #define EFI_DEV_MSG_FC 3
937 #define EFI_DEV_MSG_1394 4
938 #define EFI_DEV_MSG_USB 5
939 #define EFI_DEV_MSG_USB_CLASS 15
940 #define EFI_DEV_MSG_I20 6
941 #define EFI_DEV_MSG_MAC 11
942 #define EFI_DEV_MSG_IPV4 12
943 #define EFI_DEV_MSG_IPV6 13
944 #define EFI_DEV_MSG_INFINIBAND 9
945 #define EFI_DEV_MSG_UART 14
946 #define EFI_DEV_MSG_VENDOR 10
947 #define EFI_DEV_MEDIA 0x04
948 #define EFI_DEV_MEDIA_HARD_DRIVE 1
949 #define EFI_DEV_MEDIA_CDROM 2
950 #define EFI_DEV_MEDIA_VENDOR 3
951 #define EFI_DEV_MEDIA_FILE 4
952 #define EFI_DEV_MEDIA_PROTOCOL 5
953 #define EFI_DEV_MEDIA_REL_OFFSET 8
954 #define EFI_DEV_BIOS_BOOT 0x05
955 #define EFI_DEV_END_PATH 0x7F
956 #define EFI_DEV_END_PATH2 0xFF
957 #define EFI_DEV_END_INSTANCE 0x01
958 #define EFI_DEV_END_ENTIRE 0xFF
959
960 struct efi_generic_dev_path {
961 u8 type;
962 u8 sub_type;
963 u16 length;
964 } __packed;
965
966 struct efi_acpi_dev_path {
967 struct efi_generic_dev_path header;
968 u32 hid;
969 u32 uid;
970 } __packed;
971
972 struct efi_pci_dev_path {
973 struct efi_generic_dev_path header;
974 u8 fn;
975 u8 dev;
976 } __packed;
977
978 struct efi_vendor_dev_path {
979 struct efi_generic_dev_path header;
980 efi_guid_t vendorguid;
981 u8 vendordata[];
982 } __packed;
983
984 struct efi_rel_offset_dev_path {
985 struct efi_generic_dev_path header;
986 u32 reserved;
987 u64 starting_offset;
988 u64 ending_offset;
989 } __packed;
990
991 struct efi_mem_mapped_dev_path {
992 struct efi_generic_dev_path header;
993 u32 memory_type;
994 u64 starting_addr;
995 u64 ending_addr;
996 } __packed;
997
998 struct efi_file_path_dev_path {
999 struct efi_generic_dev_path header;
1000 efi_char16_t filename[];
1001 } __packed;
1002
1003 struct efi_dev_path {
1004 union {
1005 struct efi_generic_dev_path header;
1006 struct efi_acpi_dev_path acpi;
1007 struct efi_pci_dev_path pci;
1008 struct efi_vendor_dev_path vendor;
1009 struct efi_rel_offset_dev_path rel_offset;
1010 };
1011 } __packed;
1012
1013 struct device *efi_get_device_by_path(const struct efi_dev_path **node,
1014 size_t *len);
1015
memrange_efi_to_native(u64 * addr,u64 * npages)1016 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1017 {
1018 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1019 *addr &= PAGE_MASK;
1020 }
1021
1022 /*
1023 * EFI Variable support.
1024 *
1025 * Different firmware drivers can expose their EFI-like variables using
1026 * the following.
1027 */
1028
1029 struct efivar_operations {
1030 efi_get_variable_t *get_variable;
1031 efi_get_next_variable_t *get_next_variable;
1032 efi_set_variable_t *set_variable;
1033 efi_set_variable_t *set_variable_nonblocking;
1034 efi_query_variable_store_t *query_variable_store;
1035 efi_query_variable_info_t *query_variable_info;
1036 };
1037
1038 struct efivars {
1039 struct kset *kset;
1040 const struct efivar_operations *ops;
1041 };
1042
1043 #ifdef CONFIG_X86
1044 u64 __attribute_const__ efivar_reserved_space(void);
1045 #else
efivar_reserved_space(void)1046 static inline u64 efivar_reserved_space(void) { return 0; }
1047 #endif
1048
1049 /*
1050 * There is no actual upper limit specified for the variable name size.
1051 *
1052 * This limit exists only for practical purposes, since name conversions
1053 * are bounds-checked and name data is occasionally stored in-line.
1054 */
1055 #define EFI_VAR_NAME_LEN 1024
1056
1057 int efivars_register(struct efivars *efivars,
1058 const struct efivar_operations *ops);
1059 int efivars_unregister(struct efivars *efivars);
1060
1061 #ifdef CONFIG_EFI
1062 bool efivar_is_available(void);
1063 #else
efivar_is_available(void)1064 static inline bool efivar_is_available(void) { return false; }
1065 #endif
1066
1067 bool efivar_supports_writes(void);
1068
1069 int efivar_lock(void);
1070 int efivar_trylock(void);
1071 void efivar_unlock(void);
1072
1073 efi_status_t efivar_get_variable(efi_char16_t *name, efi_guid_t *vendor,
1074 u32 *attr, unsigned long *size, void *data);
1075
1076 efi_status_t efivar_get_next_variable(unsigned long *name_size,
1077 efi_char16_t *name, efi_guid_t *vendor);
1078
1079 efi_status_t efivar_set_variable_locked(efi_char16_t *name, efi_guid_t *vendor,
1080 u32 attr, unsigned long data_size,
1081 void *data, bool nonblocking);
1082
1083 efi_status_t efivar_set_variable(efi_char16_t *name, efi_guid_t *vendor,
1084 u32 attr, unsigned long data_size, void *data);
1085
1086 efi_status_t efivar_query_variable_info(u32 attr, u64 *storage_space,
1087 u64 *remaining_space,
1088 u64 *max_variable_size);
1089
1090 #if IS_ENABLED(CONFIG_EFI_CAPSULE_LOADER)
1091 extern bool efi_capsule_pending(int *reset_type);
1092
1093 extern int efi_capsule_supported(efi_guid_t guid, u32 flags,
1094 size_t size, int *reset);
1095
1096 extern int efi_capsule_update(efi_capsule_header_t *capsule,
1097 phys_addr_t *pages);
1098 #else
efi_capsule_pending(int * reset_type)1099 static inline bool efi_capsule_pending(int *reset_type) { return false; }
1100 #endif
1101
1102 #ifdef CONFIG_EFI
1103 extern bool efi_runtime_disabled(void);
1104 #else
efi_runtime_disabled(void)1105 static inline bool efi_runtime_disabled(void) { return true; }
1106 #endif
1107
1108 extern void efi_call_virt_check_flags(unsigned long flags, const void *caller);
1109 extern unsigned long efi_call_virt_save_flags(void);
1110
1111 void efi_runtime_assert_lock_held(void);
1112
1113 enum efi_secureboot_mode {
1114 efi_secureboot_mode_unset,
1115 efi_secureboot_mode_unknown,
1116 efi_secureboot_mode_disabled,
1117 efi_secureboot_mode_enabled,
1118 };
1119
1120 static inline
efi_get_secureboot_mode(efi_get_variable_t * get_var)1121 enum efi_secureboot_mode efi_get_secureboot_mode(efi_get_variable_t *get_var)
1122 {
1123 u8 secboot, setupmode = 0;
1124 efi_status_t status;
1125 unsigned long size;
1126
1127 size = sizeof(secboot);
1128 status = get_var(L"SecureBoot", &EFI_GLOBAL_VARIABLE_GUID, NULL, &size,
1129 &secboot);
1130 if (status == EFI_NOT_FOUND)
1131 return efi_secureboot_mode_disabled;
1132 if (status != EFI_SUCCESS)
1133 return efi_secureboot_mode_unknown;
1134
1135 size = sizeof(setupmode);
1136 get_var(L"SetupMode", &EFI_GLOBAL_VARIABLE_GUID, NULL, &size, &setupmode);
1137 if (secboot == 0 || setupmode == 1)
1138 return efi_secureboot_mode_disabled;
1139 return efi_secureboot_mode_enabled;
1140 }
1141
1142 #ifdef CONFIG_EFI_EMBEDDED_FIRMWARE
1143 void efi_check_for_embedded_firmwares(void);
1144 #else
efi_check_for_embedded_firmwares(void)1145 static inline void efi_check_for_embedded_firmwares(void) { }
1146 #endif
1147
1148 #define arch_efi_call_virt(p, f, args...) ((p)->f(args))
1149
1150 /*
1151 * Arch code must implement the following three routines:
1152 *
1153 * * arch_efi_call_virt_setup()
1154 *
1155 * Sets up the environment for the call (e.g. switching page tables,
1156 * allowing kernel-mode use of floating point, if required).
1157 *
1158 * * arch_efi_call_virt()
1159 *
1160 * Performs the call. This routine takes a variable number of arguments so
1161 * it must be implemented as a variadic preprocessor macro.
1162 *
1163 * * arch_efi_call_virt_teardown()
1164 *
1165 * Restores the usual kernel environment once the call has returned.
1166 */
1167
1168 #define efi_call_virt_pointer(p, f, args...) \
1169 ({ \
1170 typeof((p)->f(args)) __s; \
1171 unsigned long __flags; \
1172 \
1173 arch_efi_call_virt_setup(); \
1174 \
1175 __flags = efi_call_virt_save_flags(); \
1176 __s = arch_efi_call_virt(p, f, args); \
1177 efi_call_virt_check_flags(__flags, NULL); \
1178 \
1179 arch_efi_call_virt_teardown(); \
1180 \
1181 __s; \
1182 })
1183
1184 #define EFI_RANDOM_SEED_SIZE 32U // BLAKE2S_HASH_SIZE
1185
1186 struct linux_efi_random_seed {
1187 u32 size;
1188 u8 bits[];
1189 };
1190
1191 struct linux_efi_tpm_eventlog {
1192 u32 size;
1193 u32 final_events_preboot_size;
1194 u8 version;
1195 u8 log[];
1196 };
1197
1198 extern int efi_tpm_eventlog_init(void);
1199
1200 struct efi_tcg2_final_events_table {
1201 u64 version;
1202 u64 nr_events;
1203 u8 events[];
1204 };
1205 extern int efi_tpm_final_log_size;
1206
1207 extern unsigned long rci2_table_phys;
1208
1209 efi_status_t
1210 efi_call_acpi_prm_handler(efi_status_t (__efiapi *handler_addr)(u64, void *),
1211 u64 param_buffer_addr, void *context);
1212
1213 /*
1214 * efi_runtime_service() function identifiers.
1215 * "NONE" is used by efi_recover_from_page_fault() to check if the page
1216 * fault happened while executing an efi runtime service.
1217 */
1218 enum efi_rts_ids {
1219 EFI_NONE,
1220 EFI_GET_TIME,
1221 EFI_SET_TIME,
1222 EFI_GET_WAKEUP_TIME,
1223 EFI_SET_WAKEUP_TIME,
1224 EFI_GET_VARIABLE,
1225 EFI_GET_NEXT_VARIABLE,
1226 EFI_SET_VARIABLE,
1227 EFI_QUERY_VARIABLE_INFO,
1228 EFI_GET_NEXT_HIGH_MONO_COUNT,
1229 EFI_RESET_SYSTEM,
1230 EFI_UPDATE_CAPSULE,
1231 EFI_QUERY_CAPSULE_CAPS,
1232 EFI_ACPI_PRM_HANDLER,
1233 };
1234
1235 union efi_rts_args;
1236
1237 /*
1238 * efi_runtime_work: Details of EFI Runtime Service work
1239 * @args: Pointer to union describing the arguments
1240 * @status: Status of executing EFI Runtime Service
1241 * @efi_rts_id: EFI Runtime Service function identifier
1242 * @efi_rts_comp: Struct used for handling completions
1243 * @caller: The caller of the runtime service
1244 */
1245 struct efi_runtime_work {
1246 union efi_rts_args *args;
1247 efi_status_t status;
1248 struct work_struct work;
1249 enum efi_rts_ids efi_rts_id;
1250 struct completion efi_rts_comp;
1251 const void *caller;
1252 };
1253
1254 extern struct efi_runtime_work efi_rts_work;
1255
1256 /* Workqueue to queue EFI Runtime Services */
1257 extern struct workqueue_struct *efi_rts_wq;
1258
1259 struct linux_efi_memreserve {
1260 int size; // allocated size of the array
1261 atomic_t count; // number of entries used
1262 phys_addr_t next; // pa of next struct instance
1263 struct {
1264 phys_addr_t base;
1265 phys_addr_t size;
1266 } entry[];
1267 };
1268
1269 #define EFI_MEMRESERVE_COUNT(size) (((size) - sizeof(struct linux_efi_memreserve)) \
1270 / sizeof_field(struct linux_efi_memreserve, entry[0]))
1271
1272 void __init efi_arch_mem_reserve(phys_addr_t addr, u64 size);
1273
1274 /*
1275 * The LINUX_EFI_MOK_VARIABLE_TABLE_GUID config table can be provided
1276 * to the kernel by an EFI boot loader. The table contains a packed
1277 * sequence of these entries, one for each named MOK variable.
1278 * The sequence is terminated by an entry with a completely NULL
1279 * name and 0 data size.
1280 */
1281 struct efi_mokvar_table_entry {
1282 char name[256];
1283 u64 data_size;
1284 u8 data[];
1285 } __attribute((packed));
1286
1287 #ifdef CONFIG_LOAD_UEFI_KEYS
1288 extern void __init efi_mokvar_table_init(void);
1289 extern struct efi_mokvar_table_entry *efi_mokvar_entry_next(
1290 struct efi_mokvar_table_entry **mokvar_entry);
1291 extern struct efi_mokvar_table_entry *efi_mokvar_entry_find(const char *name);
1292 #else
efi_mokvar_table_init(void)1293 static inline void efi_mokvar_table_init(void) { }
efi_mokvar_entry_next(struct efi_mokvar_table_entry ** mokvar_entry)1294 static inline struct efi_mokvar_table_entry *efi_mokvar_entry_next(
1295 struct efi_mokvar_table_entry **mokvar_entry)
1296 {
1297 return NULL;
1298 }
efi_mokvar_entry_find(const char * name)1299 static inline struct efi_mokvar_table_entry *efi_mokvar_entry_find(
1300 const char *name)
1301 {
1302 return NULL;
1303 }
1304 #endif
1305
1306 extern void efifb_setup_from_dmi(struct screen_info *si, const char *opt);
1307
1308 struct linux_efi_coco_secret_area {
1309 u64 base_pa;
1310 u64 size;
1311 };
1312
1313 struct linux_efi_initrd {
1314 unsigned long base;
1315 unsigned long size;
1316 };
1317
1318 /* Header of a populated EFI secret area */
1319 #define EFI_SECRET_TABLE_HEADER_GUID EFI_GUID(0x1e74f542, 0x71dd, 0x4d66, 0x96, 0x3e, 0xef, 0x42, 0x87, 0xff, 0x17, 0x3b)
1320
1321 bool xen_efi_config_table_is_usable(const efi_guid_t *guid, unsigned long table);
1322
1323 static __always_inline
efi_config_table_is_usable(const efi_guid_t * guid,unsigned long table)1324 bool efi_config_table_is_usable(const efi_guid_t *guid, unsigned long table)
1325 {
1326 if (!IS_ENABLED(CONFIG_XEN_EFI))
1327 return true;
1328 return xen_efi_config_table_is_usable(guid, table);
1329 }
1330
1331 umode_t efi_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n);
1332
1333 int ovmf_log_probe(unsigned long ovmf_debug_log_table);
1334
1335 /*
1336 * efivar ops event type
1337 */
1338 #define EFIVAR_OPS_RDONLY 0
1339 #define EFIVAR_OPS_RDWR 1
1340
1341 extern struct blocking_notifier_head efivar_ops_nh;
1342
1343 void efivars_generic_ops_register(void);
1344 void efivars_generic_ops_unregister(void);
1345
1346 #endif /* _LINUX_EFI_H */
1347