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