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