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