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