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