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