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