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 : #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_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID EFI_GUID(0x05c99a21, 0xc70f, 0x4ad2, 0x8a, 0x5f, 0x35, 0xdf, 0x33, 0x43, 0xf5, 0x1e)
375 : #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
376 : #define EFI_UGA_PROTOCOL_GUID EFI_GUID(0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39)
377 : #define EFI_PCI_IO_PROTOCOL_GUID EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
378 : #define EFI_FILE_INFO_ID EFI_GUID(0x09576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
379 : #define EFI_SYSTEM_RESOURCE_TABLE_GUID EFI_GUID(0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
380 : #define EFI_FILE_SYSTEM_GUID EFI_GUID(0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
381 : #define DEVICE_TREE_GUID EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
382 : #define EFI_PROPERTIES_TABLE_GUID EFI_GUID(0x880aaca3, 0x4adc, 0x4a04, 0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5)
383 : #define EFI_RNG_PROTOCOL_GUID EFI_GUID(0x3152bca5, 0xeade, 0x433d, 0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
384 : #define EFI_RNG_ALGORITHM_RAW EFI_GUID(0xe43176d7, 0xb6e8, 0x4827, 0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61)
385 : #define EFI_MEMORY_ATTRIBUTES_TABLE_GUID EFI_GUID(0xdcfa911d, 0x26eb, 0x469f, 0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
386 : #define EFI_CONSOLE_OUT_DEVICE_GUID EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4, 0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
387 : #define APPLE_PROPERTIES_PROTOCOL_GUID EFI_GUID(0x91bd12fe, 0xf6c3, 0x44fb, 0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0)
388 : #define EFI_TCG2_PROTOCOL_GUID EFI_GUID(0x607f766c, 0x7455, 0x42be, 0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)
389 : #define EFI_LOAD_FILE_PROTOCOL_GUID EFI_GUID(0x56ec3091, 0x954c, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
390 : #define EFI_LOAD_FILE2_PROTOCOL_GUID EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e, 0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d)
391 : #define EFI_RT_PROPERTIES_TABLE_GUID EFI_GUID(0xeb66918a, 0x7eef, 0x402a, 0x84, 0x2e, 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9)
392 : #define EFI_DXE_SERVICES_TABLE_GUID EFI_GUID(0x05ad34ba, 0x6f02, 0x4214, 0x95, 0x2e, 0x4d, 0xa0, 0x39, 0x8e, 0x2b, 0xb9)
393 : #define EFI_SMBIOS_PROTOCOL_GUID EFI_GUID(0x03583ff6, 0xcb36, 0x4940, 0x94, 0x7e, 0xb9, 0xb3, 0x9f, 0x4a, 0xfa, 0xf7)
394 : #define EFI_MEMORY_ATTRIBUTE_PROTOCOL_GUID EFI_GUID(0xf4560cf6, 0x40ec, 0x4b4a, 0xa1, 0x92, 0xbf, 0x1d, 0x57, 0xd0, 0xb1, 0x89)
395 :
396 : #define EFI_IMAGE_SECURITY_DATABASE_GUID EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
397 : #define EFI_SHIM_LOCK_GUID EFI_GUID(0x605dab50, 0xe046, 0x4300, 0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23)
398 :
399 : #define EFI_CERT_SHA256_GUID EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
400 : #define EFI_CERT_X509_GUID EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
401 : #define EFI_CERT_X509_SHA256_GUID EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
402 : #define EFI_CC_BLOB_GUID EFI_GUID(0x067b1f5f, 0xcf26, 0x44c5, 0x85, 0x54, 0x93, 0xd7, 0x77, 0x91, 0x2d, 0x42)
403 :
404 : /*
405 : * This GUID is used to pass to the kernel proper the struct screen_info
406 : * structure that was populated by the stub based on the GOP protocol instance
407 : * associated with ConOut
408 : */
409 : #define LINUX_EFI_SCREEN_INFO_TABLE_GUID EFI_GUID(0xe03fc20a, 0x85dc, 0x406e, 0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95)
410 : #define LINUX_EFI_ARM_CPU_STATE_TABLE_GUID EFI_GUID(0xef79e4aa, 0x3c3d, 0x4989, 0xb9, 0x02, 0x07, 0xa9, 0x43, 0xe5, 0x50, 0xd2)
411 : #define LINUX_EFI_LOADER_ENTRY_GUID EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf, 0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)
412 : #define LINUX_EFI_RANDOM_SEED_TABLE_GUID EFI_GUID(0x1ce1e5bc, 0x7ceb, 0x42f2, 0x81, 0xe5, 0x8a, 0xad, 0xf1, 0x80, 0xf5, 0x7b)
413 : #define LINUX_EFI_TPM_EVENT_LOG_GUID EFI_GUID(0xb7799cb0, 0xeca2, 0x4943, 0x96, 0x67, 0x1f, 0xae, 0x07, 0xb7, 0x47, 0xfa)
414 : #define LINUX_EFI_TPM_FINAL_LOG_GUID EFI_GUID(0x1e2ed096, 0x30e2, 0x4254, 0xbd, 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
415 : #define LINUX_EFI_MEMRESERVE_TABLE_GUID EFI_GUID(0x888eb0c6, 0x8ede, 0x4ff5, 0xa8, 0xf0, 0x9a, 0xee, 0x5c, 0xb9, 0x77, 0xc2)
416 : #define LINUX_EFI_INITRD_MEDIA_GUID EFI_GUID(0x5568e427, 0x68fc, 0x4f3d, 0xac, 0x74, 0xca, 0x55, 0x52, 0x31, 0xcc, 0x68)
417 : #define LINUX_EFI_MOK_VARIABLE_TABLE_GUID EFI_GUID(0xc451ed2b, 0x9694, 0x45d3, 0xba, 0xba, 0xed, 0x9f, 0x89, 0x88, 0xa3, 0x89)
418 : #define LINUX_EFI_COCO_SECRET_AREA_GUID EFI_GUID(0xadf956ad, 0xe98c, 0x484c, 0xae, 0x11, 0xb5, 0x1c, 0x7d, 0x33, 0x64, 0x47)
419 : #define LINUX_EFI_BOOT_MEMMAP_GUID EFI_GUID(0x800f683f, 0xd08b, 0x423a, 0xa2, 0x93, 0x96, 0x5c, 0x3c, 0x6f, 0xe2, 0xb4)
420 :
421 : #define RISCV_EFI_BOOT_PROTOCOL_GUID EFI_GUID(0xccd15fec, 0x6f73, 0x4eec, 0x83, 0x95, 0x3e, 0x69, 0xe4, 0xb9, 0x40, 0xbf)
422 :
423 : /*
424 : * This GUID may be installed onto the kernel image's handle as a NULL protocol
425 : * to signal to the stub that the placement of the image should be respected,
426 : * and moving the image in physical memory is undesirable. To ensure
427 : * compatibility with 64k pages kernels with virtually mapped stacks, and to
428 : * avoid defeating physical randomization, this protocol should only be
429 : * installed if the image was placed at a randomized 128k aligned address in
430 : * memory.
431 : */
432 : #define LINUX_EFI_LOADED_IMAGE_FIXED_GUID EFI_GUID(0xf5a37b6d, 0x3344, 0x42a5, 0xb6, 0xbb, 0x97, 0x86, 0x48, 0xc1, 0x89, 0x0a)
433 :
434 : /* OEM GUIDs */
435 : #define DELLEMC_EFI_RCI2_TABLE_GUID EFI_GUID(0x2d9f28a2, 0xa886, 0x456a, 0x97, 0xa8, 0xf1, 0x1e, 0xf2, 0x4f, 0xf4, 0x55)
436 : #define AMD_SEV_MEM_ENCRYPT_GUID EFI_GUID(0x0cf29b71, 0x9e51, 0x433a, 0xa3, 0xb7, 0x81, 0xf3, 0xab, 0x16, 0xb8, 0x75)
437 :
438 : typedef struct {
439 : efi_guid_t guid;
440 : u64 table;
441 : } efi_config_table_64_t;
442 :
443 : typedef struct {
444 : efi_guid_t guid;
445 : u32 table;
446 : } efi_config_table_32_t;
447 :
448 : typedef union {
449 : struct {
450 : efi_guid_t guid;
451 : void *table;
452 : };
453 : efi_config_table_32_t mixed_mode;
454 : } efi_config_table_t;
455 :
456 : typedef struct {
457 : efi_guid_t guid;
458 : unsigned long *ptr;
459 : const char name[16];
460 : } efi_config_table_type_t;
461 :
462 : #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
463 : #define EFI_DXE_SERVICES_TABLE_SIGNATURE ((u64)0x565245535f455844ULL)
464 :
465 : #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
466 : #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
467 : #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
468 : #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
469 : #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
470 : #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
471 :
472 : typedef struct {
473 : efi_table_hdr_t hdr;
474 : u64 fw_vendor; /* physical addr of CHAR16 vendor string */
475 : u32 fw_revision;
476 : u32 __pad1;
477 : u64 con_in_handle;
478 : u64 con_in;
479 : u64 con_out_handle;
480 : u64 con_out;
481 : u64 stderr_handle;
482 : u64 stderr;
483 : u64 runtime;
484 : u64 boottime;
485 : u32 nr_tables;
486 : u32 __pad2;
487 : u64 tables;
488 : } efi_system_table_64_t;
489 :
490 : typedef struct {
491 : efi_table_hdr_t hdr;
492 : u32 fw_vendor; /* physical addr of CHAR16 vendor string */
493 : u32 fw_revision;
494 : u32 con_in_handle;
495 : u32 con_in;
496 : u32 con_out_handle;
497 : u32 con_out;
498 : u32 stderr_handle;
499 : u32 stderr;
500 : u32 runtime;
501 : u32 boottime;
502 : u32 nr_tables;
503 : u32 tables;
504 : } efi_system_table_32_t;
505 :
506 : typedef union efi_simple_text_input_protocol efi_simple_text_input_protocol_t;
507 : typedef union efi_simple_text_output_protocol efi_simple_text_output_protocol_t;
508 :
509 : typedef union {
510 : struct {
511 : efi_table_hdr_t hdr;
512 : unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
513 : u32 fw_revision;
514 : unsigned long con_in_handle;
515 : efi_simple_text_input_protocol_t *con_in;
516 : unsigned long con_out_handle;
517 : efi_simple_text_output_protocol_t *con_out;
518 : unsigned long stderr_handle;
519 : unsigned long stderr;
520 : efi_runtime_services_t *runtime;
521 : efi_boot_services_t *boottime;
522 : unsigned long nr_tables;
523 : unsigned long tables;
524 : };
525 : efi_system_table_32_t mixed_mode;
526 : } efi_system_table_t;
527 :
528 : struct efi_boot_memmap {
529 : unsigned long map_size;
530 : unsigned long desc_size;
531 : u32 desc_ver;
532 : unsigned long map_key;
533 : unsigned long buff_size;
534 : efi_memory_desc_t map[];
535 : };
536 :
537 : /*
538 : * Architecture independent structure for describing a memory map for the
539 : * benefit of efi_memmap_init_early(), and for passing context between
540 : * efi_memmap_alloc() and efi_memmap_install().
541 : */
542 : struct efi_memory_map_data {
543 : phys_addr_t phys_map;
544 : unsigned long size;
545 : unsigned long desc_version;
546 : unsigned long desc_size;
547 : unsigned long flags;
548 : };
549 :
550 : struct efi_memory_map {
551 : phys_addr_t phys_map;
552 : void *map;
553 : void *map_end;
554 : int nr_map;
555 : unsigned long desc_version;
556 : unsigned long desc_size;
557 : #define EFI_MEMMAP_LATE (1UL << 0)
558 : #define EFI_MEMMAP_MEMBLOCK (1UL << 1)
559 : #define EFI_MEMMAP_SLAB (1UL << 2)
560 : unsigned long flags;
561 : };
562 :
563 : struct efi_mem_range {
564 : struct range range;
565 : u64 attribute;
566 : };
567 :
568 : typedef struct {
569 : u32 version;
570 : u32 length;
571 : u64 memory_protection_attribute;
572 : } efi_properties_table_t;
573 :
574 : #define EFI_PROPERTIES_TABLE_VERSION 0x00010000
575 : #define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1
576 :
577 : typedef struct {
578 : u16 version;
579 : u16 length;
580 : u32 runtime_services_supported;
581 : } efi_rt_properties_table_t;
582 :
583 : #define EFI_RT_PROPERTIES_TABLE_VERSION 0x1
584 :
585 : #define EFI_INVALID_TABLE_ADDR (~0UL)
586 :
587 : // BIT0 implies that Runtime code includes the forward control flow guard
588 : // instruction, such as X86 CET-IBT or ARM BTI.
589 : #define EFI_MEMORY_ATTRIBUTES_FLAGS_RT_FORWARD_CONTROL_FLOW_GUARD 0x1
590 :
591 : typedef struct {
592 : u32 version;
593 : u32 num_entries;
594 : u32 desc_size;
595 : u32 flags;
596 : efi_memory_desc_t entry[0];
597 : } efi_memory_attributes_table_t;
598 :
599 : typedef struct {
600 : efi_guid_t signature_owner;
601 : u8 signature_data[];
602 : } efi_signature_data_t;
603 :
604 : typedef struct {
605 : efi_guid_t signature_type;
606 : u32 signature_list_size;
607 : u32 signature_header_size;
608 : u32 signature_size;
609 : u8 signature_header[];
610 : /* efi_signature_data_t signatures[][] */
611 : } efi_signature_list_t;
612 :
613 : typedef u8 efi_sha256_hash_t[32];
614 :
615 : typedef struct {
616 : efi_sha256_hash_t to_be_signed_hash;
617 : efi_time_t time_of_revocation;
618 : } efi_cert_x509_sha256_t;
619 :
620 : extern unsigned long __ro_after_init efi_rng_seed; /* RNG Seed table */
621 :
622 : /*
623 : * All runtime access to EFI goes through this structure:
624 : */
625 : extern struct efi {
626 : const efi_runtime_services_t *runtime; /* EFI runtime services table */
627 : unsigned int runtime_version; /* Runtime services version */
628 : unsigned int runtime_supported_mask;
629 :
630 : unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
631 : unsigned long acpi20; /* ACPI table (ACPI 2.0) */
632 : unsigned long smbios; /* SMBIOS table (32 bit entry point) */
633 : unsigned long smbios3; /* SMBIOS table (64 bit entry point) */
634 : unsigned long esrt; /* ESRT table */
635 : unsigned long tpm_log; /* TPM2 Event Log table */
636 : unsigned long tpm_final_log; /* TPM2 Final Events Log table */
637 : unsigned long mokvar_table; /* MOK variable config table */
638 : unsigned long coco_secret; /* Confidential computing secret table */
639 :
640 : efi_get_time_t *get_time;
641 : efi_set_time_t *set_time;
642 : efi_get_wakeup_time_t *get_wakeup_time;
643 : efi_set_wakeup_time_t *set_wakeup_time;
644 : efi_get_variable_t *get_variable;
645 : efi_get_next_variable_t *get_next_variable;
646 : efi_set_variable_t *set_variable;
647 : efi_set_variable_t *set_variable_nonblocking;
648 : efi_query_variable_info_t *query_variable_info;
649 : efi_query_variable_info_t *query_variable_info_nonblocking;
650 : efi_update_capsule_t *update_capsule;
651 : efi_query_capsule_caps_t *query_capsule_caps;
652 : efi_get_next_high_mono_count_t *get_next_high_mono_count;
653 : efi_reset_system_t *reset_system;
654 :
655 : struct efi_memory_map memmap;
656 : unsigned long flags;
657 : } efi;
658 :
659 : #define EFI_RT_SUPPORTED_GET_TIME 0x0001
660 : #define EFI_RT_SUPPORTED_SET_TIME 0x0002
661 : #define EFI_RT_SUPPORTED_GET_WAKEUP_TIME 0x0004
662 : #define EFI_RT_SUPPORTED_SET_WAKEUP_TIME 0x0008
663 : #define EFI_RT_SUPPORTED_GET_VARIABLE 0x0010
664 : #define EFI_RT_SUPPORTED_GET_NEXT_VARIABLE_NAME 0x0020
665 : #define EFI_RT_SUPPORTED_SET_VARIABLE 0x0040
666 : #define EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP 0x0080
667 : #define EFI_RT_SUPPORTED_CONVERT_POINTER 0x0100
668 : #define EFI_RT_SUPPORTED_GET_NEXT_HIGH_MONOTONIC_COUNT 0x0200
669 : #define EFI_RT_SUPPORTED_RESET_SYSTEM 0x0400
670 : #define EFI_RT_SUPPORTED_UPDATE_CAPSULE 0x0800
671 : #define EFI_RT_SUPPORTED_QUERY_CAPSULE_CAPABILITIES 0x1000
672 : #define EFI_RT_SUPPORTED_QUERY_VARIABLE_INFO 0x2000
673 :
674 : #define EFI_RT_SUPPORTED_ALL 0x3fff
675 :
676 : #define EFI_RT_SUPPORTED_TIME_SERVICES 0x0003
677 : #define EFI_RT_SUPPORTED_WAKEUP_SERVICES 0x000c
678 : #define EFI_RT_SUPPORTED_VARIABLE_SERVICES 0x0070
679 :
680 : extern struct mm_struct efi_mm;
681 :
682 : static inline int
683 : efi_guidcmp (efi_guid_t left, efi_guid_t right)
684 : {
685 0 : return memcmp(&left, &right, sizeof (efi_guid_t));
686 : }
687 :
688 : static inline char *
689 : efi_guid_to_str(efi_guid_t *guid, char *out)
690 : {
691 0 : sprintf(out, "%pUl", guid->b);
692 : return out;
693 : }
694 :
695 : extern void efi_init (void);
696 : #ifdef CONFIG_EFI
697 : extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
698 : #else
699 : static inline void efi_enter_virtual_mode (void) {}
700 : #endif
701 : #ifdef CONFIG_X86
702 : extern efi_status_t efi_query_variable_store(u32 attributes,
703 : unsigned long size,
704 : bool nonblocking);
705 : #else
706 :
707 : static inline efi_status_t efi_query_variable_store(u32 attributes,
708 : unsigned long size,
709 : bool nonblocking)
710 : {
711 : return EFI_SUCCESS;
712 : }
713 : #endif
714 : extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
715 :
716 : extern int __init __efi_memmap_init(struct efi_memory_map_data *data);
717 : extern int __init efi_memmap_init_early(struct efi_memory_map_data *data);
718 : extern int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size);
719 : extern void __init efi_memmap_unmap(void);
720 :
721 : #ifdef CONFIG_EFI_ESRT
722 : extern void __init efi_esrt_init(void);
723 : #else
724 : static inline void efi_esrt_init(void) { }
725 : #endif
726 : extern int efi_config_parse_tables(const efi_config_table_t *config_tables,
727 : int count,
728 : const efi_config_table_type_t *arch_tables);
729 : extern int efi_systab_check_header(const efi_table_hdr_t *systab_hdr);
730 : extern void efi_systab_report_header(const efi_table_hdr_t *systab_hdr,
731 : unsigned long fw_vendor);
732 : extern u64 efi_get_iobase (void);
733 : extern int efi_mem_type(unsigned long phys_addr);
734 : extern u64 efi_mem_attributes (unsigned long phys_addr);
735 : extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
736 : extern int __init efi_uart_console_only (void);
737 : extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
738 : extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
739 : extern int __efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
740 : extern void efi_mem_reserve(phys_addr_t addr, u64 size);
741 : extern int efi_mem_reserve_persistent(phys_addr_t addr, u64 size);
742 : extern void efi_initialize_iomem_resources(struct resource *code_resource,
743 : struct resource *data_resource, struct resource *bss_resource);
744 : extern u64 efi_get_fdt_params(struct efi_memory_map_data *data);
745 : extern struct kobject *efi_kobj;
746 :
747 : extern int efi_reboot_quirk_mode;
748 : extern bool efi_poweroff_required(void);
749 :
750 : extern unsigned long efi_mem_attr_table;
751 :
752 : /*
753 : * efi_memattr_perm_setter - arch specific callback function passed into
754 : * efi_memattr_apply_permissions() that updates the
755 : * mapping permissions described by the second
756 : * argument in the page tables referred to by the
757 : * first argument.
758 : */
759 : typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *, bool);
760 :
761 : extern int efi_memattr_init(void);
762 : extern int efi_memattr_apply_permissions(struct mm_struct *mm,
763 : efi_memattr_perm_setter fn);
764 :
765 : /*
766 : * efi_early_memdesc_ptr - get the n-th EFI memmap descriptor
767 : * @map: the start of efi memmap
768 : * @desc_size: the size of space for each EFI memmap descriptor
769 : * @n: the index of efi memmap descriptor
770 : *
771 : * EFI boot service provides the GetMemoryMap() function to get a copy of the
772 : * current memory map which is an array of memory descriptors, each of
773 : * which describes a contiguous block of memory. It also gets the size of the
774 : * map, and the size of each descriptor, etc.
775 : *
776 : * Note that per section 6.2 of UEFI Spec 2.6 Errata A, the returned size of
777 : * each descriptor might not be equal to sizeof(efi_memory_memdesc_t),
778 : * since efi_memory_memdesc_t may be extended in the future. Thus the OS
779 : * MUST use the returned size of the descriptor to find the start of each
780 : * efi_memory_memdesc_t in the memory map array. This should only be used
781 : * during bootup since for_each_efi_memory_desc_xxx() is available after the
782 : * kernel initializes the EFI subsystem to set up struct efi_memory_map.
783 : */
784 : #define efi_early_memdesc_ptr(map, desc_size, n) \
785 : (efi_memory_desc_t *)((void *)(map) + ((n) * (desc_size)))
786 :
787 : /* Iterate through an efi_memory_map */
788 : #define for_each_efi_memory_desc_in_map(m, md) \
789 : for ((md) = (m)->map; \
790 : (md) && ((void *)(md) + (m)->desc_size) <= (m)->map_end; \
791 : (md) = (void *)(md) + (m)->desc_size)
792 :
793 : /**
794 : * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
795 : * @md: the efi_memory_desc_t * iterator
796 : *
797 : * Once the loop finishes @md must not be accessed.
798 : */
799 : #define for_each_efi_memory_desc(md) \
800 : for_each_efi_memory_desc_in_map(&efi.memmap, md)
801 :
802 : /*
803 : * Format an EFI memory descriptor's type and attributes to a user-provided
804 : * character buffer, as per snprintf(), and return the buffer.
805 : */
806 : char * __init efi_md_typeattr_format(char *buf, size_t size,
807 : const efi_memory_desc_t *md);
808 :
809 :
810 : typedef void (*efi_element_handler_t)(const char *source,
811 : const void *element_data,
812 : size_t element_size);
813 : extern int __init parse_efi_signature_list(
814 : const char *source,
815 : const void *data, size_t size,
816 : efi_element_handler_t (*get_handler_for_guid)(const efi_guid_t *));
817 :
818 : /**
819 : * efi_range_is_wc - check the WC bit on an address range
820 : * @start: starting kvirt address
821 : * @len: length of range
822 : *
823 : * Consult the EFI memory map and make sure it's ok to set this range WC.
824 : * Returns true or false.
825 : */
826 : static inline int efi_range_is_wc(unsigned long start, unsigned long len)
827 : {
828 : unsigned long i;
829 :
830 : for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
831 : unsigned long paddr = __pa(start + i);
832 : if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
833 : return 0;
834 : }
835 : /* The range checked out */
836 : return 1;
837 : }
838 :
839 : #ifdef CONFIG_EFI_PCDP
840 : extern int __init efi_setup_pcdp_console(char *);
841 : #endif
842 :
843 : /*
844 : * We play games with efi_enabled so that the compiler will, if
845 : * possible, remove EFI-related code altogether.
846 : */
847 : #define EFI_BOOT 0 /* Were we booted from EFI? */
848 : #define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
849 : #define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
850 : #define EFI_MEMMAP 4 /* Can we use EFI memory map? */
851 : #define EFI_64BIT 5 /* Is the firmware 64-bit? */
852 : #define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
853 : #define EFI_ARCH_1 7 /* First arch-specific bit */
854 : #define EFI_DBG 8 /* Print additional debug info at runtime */
855 : #define EFI_NX_PE_DATA 9 /* Can runtime data regions be mapped non-executable? */
856 : #define EFI_MEM_ATTR 10 /* Did firmware publish an EFI_MEMORY_ATTRIBUTES table? */
857 : #define EFI_MEM_NO_SOFT_RESERVE 11 /* Is the kernel configured to ignore soft reservations? */
858 : #define EFI_PRESERVE_BS_REGIONS 12 /* Are EFI boot-services memory segments available? */
859 :
860 : #ifdef CONFIG_EFI
861 : /*
862 : * Test whether the above EFI_* bits are enabled.
863 : */
864 : static inline bool efi_enabled(int feature)
865 : {
866 : return test_bit(feature, &efi.flags) != 0;
867 : }
868 : extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
869 :
870 : bool __pure __efi_soft_reserve_enabled(void);
871 :
872 : static inline bool __pure efi_soft_reserve_enabled(void)
873 : {
874 : return IS_ENABLED(CONFIG_EFI_SOFT_RESERVE)
875 : && __efi_soft_reserve_enabled();
876 : }
877 :
878 : static inline bool efi_rt_services_supported(unsigned int mask)
879 : {
880 : return (efi.runtime_supported_mask & mask) == mask;
881 : }
882 : extern void efi_find_mirror(void);
883 : #else
884 : static inline bool efi_enabled(int feature)
885 : {
886 : return false;
887 : }
888 : static inline void
889 : efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
890 :
891 : static inline bool efi_soft_reserve_enabled(void)
892 : {
893 : return false;
894 : }
895 :
896 : static inline bool efi_rt_services_supported(unsigned int mask)
897 : {
898 : return false;
899 : }
900 :
901 : static inline void efi_find_mirror(void) {}
902 : #endif
903 :
904 : extern int efi_status_to_err(efi_status_t status);
905 :
906 : /*
907 : * Variable Attributes
908 : */
909 : #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
910 : #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
911 : #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
912 : #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
913 : #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
914 : #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
915 : #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
916 :
917 : #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
918 : EFI_VARIABLE_BOOTSERVICE_ACCESS | \
919 : EFI_VARIABLE_RUNTIME_ACCESS | \
920 : EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
921 : EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
922 : EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
923 : EFI_VARIABLE_APPEND_WRITE)
924 : /*
925 : * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
926 : * not including trailing NUL
927 : */
928 : #define EFI_VARIABLE_GUID_LEN UUID_STRING_LEN
929 :
930 : /*
931 : * EFI Device Path information
932 : */
933 : #define EFI_DEV_HW 0x01
934 : #define EFI_DEV_PCI 1
935 : #define EFI_DEV_PCCARD 2
936 : #define EFI_DEV_MEM_MAPPED 3
937 : #define EFI_DEV_VENDOR 4
938 : #define EFI_DEV_CONTROLLER 5
939 : #define EFI_DEV_ACPI 0x02
940 : #define EFI_DEV_BASIC_ACPI 1
941 : #define EFI_DEV_EXPANDED_ACPI 2
942 : #define EFI_DEV_MSG 0x03
943 : #define EFI_DEV_MSG_ATAPI 1
944 : #define EFI_DEV_MSG_SCSI 2
945 : #define EFI_DEV_MSG_FC 3
946 : #define EFI_DEV_MSG_1394 4
947 : #define EFI_DEV_MSG_USB 5
948 : #define EFI_DEV_MSG_USB_CLASS 15
949 : #define EFI_DEV_MSG_I20 6
950 : #define EFI_DEV_MSG_MAC 11
951 : #define EFI_DEV_MSG_IPV4 12
952 : #define EFI_DEV_MSG_IPV6 13
953 : #define EFI_DEV_MSG_INFINIBAND 9
954 : #define EFI_DEV_MSG_UART 14
955 : #define EFI_DEV_MSG_VENDOR 10
956 : #define EFI_DEV_MEDIA 0x04
957 : #define EFI_DEV_MEDIA_HARD_DRIVE 1
958 : #define EFI_DEV_MEDIA_CDROM 2
959 : #define EFI_DEV_MEDIA_VENDOR 3
960 : #define EFI_DEV_MEDIA_FILE 4
961 : #define EFI_DEV_MEDIA_PROTOCOL 5
962 : #define EFI_DEV_MEDIA_REL_OFFSET 8
963 : #define EFI_DEV_BIOS_BOOT 0x05
964 : #define EFI_DEV_END_PATH 0x7F
965 : #define EFI_DEV_END_PATH2 0xFF
966 : #define EFI_DEV_END_INSTANCE 0x01
967 : #define EFI_DEV_END_ENTIRE 0xFF
968 :
969 : struct efi_generic_dev_path {
970 : u8 type;
971 : u8 sub_type;
972 : u16 length;
973 : } __packed;
974 :
975 : struct efi_acpi_dev_path {
976 : struct efi_generic_dev_path header;
977 : u32 hid;
978 : u32 uid;
979 : } __packed;
980 :
981 : struct efi_pci_dev_path {
982 : struct efi_generic_dev_path header;
983 : u8 fn;
984 : u8 dev;
985 : } __packed;
986 :
987 : struct efi_vendor_dev_path {
988 : struct efi_generic_dev_path header;
989 : efi_guid_t vendorguid;
990 : u8 vendordata[];
991 : } __packed;
992 :
993 : struct efi_rel_offset_dev_path {
994 : struct efi_generic_dev_path header;
995 : u32 reserved;
996 : u64 starting_offset;
997 : u64 ending_offset;
998 : } __packed;
999 :
1000 : struct efi_mem_mapped_dev_path {
1001 : struct efi_generic_dev_path header;
1002 : u32 memory_type;
1003 : u64 starting_addr;
1004 : u64 ending_addr;
1005 : } __packed;
1006 :
1007 : struct efi_file_path_dev_path {
1008 : struct efi_generic_dev_path header;
1009 : efi_char16_t filename[];
1010 : } __packed;
1011 :
1012 : struct efi_dev_path {
1013 : union {
1014 : struct efi_generic_dev_path header;
1015 : struct efi_acpi_dev_path acpi;
1016 : struct efi_pci_dev_path pci;
1017 : struct efi_vendor_dev_path vendor;
1018 : struct efi_rel_offset_dev_path rel_offset;
1019 : };
1020 : } __packed;
1021 :
1022 : struct device *efi_get_device_by_path(const struct efi_dev_path **node,
1023 : size_t *len);
1024 :
1025 : static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1026 : {
1027 : *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1028 : *addr &= PAGE_MASK;
1029 : }
1030 :
1031 : /*
1032 : * EFI Variable support.
1033 : *
1034 : * Different firmware drivers can expose their EFI-like variables using
1035 : * the following.
1036 : */
1037 :
1038 : struct efivar_operations {
1039 : efi_get_variable_t *get_variable;
1040 : efi_get_next_variable_t *get_next_variable;
1041 : efi_set_variable_t *set_variable;
1042 : efi_set_variable_t *set_variable_nonblocking;
1043 : efi_query_variable_store_t *query_variable_store;
1044 : };
1045 :
1046 : struct efivars {
1047 : struct kset *kset;
1048 : const struct efivar_operations *ops;
1049 : };
1050 :
1051 : /*
1052 : * The maximum size of VariableName + Data = 1024
1053 : * Therefore, it's reasonable to save that much
1054 : * space in each part of the structure,
1055 : * and we use a page for reading/writing.
1056 : */
1057 :
1058 : #define EFI_VAR_NAME_LEN 1024
1059 :
1060 : int efivars_register(struct efivars *efivars,
1061 : const struct efivar_operations *ops);
1062 : int efivars_unregister(struct efivars *efivars);
1063 :
1064 : #ifdef CONFIG_EFI
1065 : bool efivar_is_available(void);
1066 : #else
1067 : static inline bool efivar_is_available(void) { return false; }
1068 : #endif
1069 :
1070 : bool 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
1098 : static inline bool efi_capsule_pending(int *reset_type) { return false; }
1099 : #endif
1100 :
1101 : #ifdef CONFIG_EFI
1102 : extern bool efi_runtime_disabled(void);
1103 : #else
1104 : static inline bool efi_runtime_disabled(void) { return true; }
1105 : #endif
1106 :
1107 : extern void efi_call_virt_check_flags(unsigned long flags, const char *call);
1108 : extern unsigned long efi_call_virt_save_flags(void);
1109 :
1110 : enum efi_secureboot_mode {
1111 : efi_secureboot_mode_unset,
1112 : efi_secureboot_mode_unknown,
1113 : efi_secureboot_mode_disabled,
1114 : efi_secureboot_mode_enabled,
1115 : };
1116 :
1117 : static inline
1118 : enum efi_secureboot_mode efi_get_secureboot_mode(efi_get_variable_t *get_var)
1119 : {
1120 : u8 secboot, setupmode = 0;
1121 : efi_status_t status;
1122 : unsigned long size;
1123 :
1124 : size = sizeof(secboot);
1125 : status = get_var(L"SecureBoot", &EFI_GLOBAL_VARIABLE_GUID, NULL, &size,
1126 : &secboot);
1127 : if (status == EFI_NOT_FOUND)
1128 : return efi_secureboot_mode_disabled;
1129 : if (status != EFI_SUCCESS)
1130 : return efi_secureboot_mode_unknown;
1131 :
1132 : size = sizeof(setupmode);
1133 : get_var(L"SetupMode", &EFI_GLOBAL_VARIABLE_GUID, NULL, &size, &setupmode);
1134 : if (secboot == 0 || setupmode == 1)
1135 : return efi_secureboot_mode_disabled;
1136 : return efi_secureboot_mode_enabled;
1137 : }
1138 :
1139 : #ifdef CONFIG_EFI_EMBEDDED_FIRMWARE
1140 : void efi_check_for_embedded_firmwares(void);
1141 : #else
1142 : static inline void efi_check_for_embedded_firmwares(void) { }
1143 : #endif
1144 :
1145 : #define arch_efi_call_virt(p, f, args...) ((p)->f(args))
1146 :
1147 : /*
1148 : * Arch code can implement the following three template macros, avoiding
1149 : * reptition for the void/non-void return cases of {__,}efi_call_virt():
1150 : *
1151 : * * arch_efi_call_virt_setup()
1152 : *
1153 : * Sets up the environment for the call (e.g. switching page tables,
1154 : * allowing kernel-mode use of floating point, if required).
1155 : *
1156 : * * arch_efi_call_virt()
1157 : *
1158 : * Performs the call. The last expression in the macro must be the call
1159 : * itself, allowing the logic to be shared by the void and non-void
1160 : * cases.
1161 : *
1162 : * * arch_efi_call_virt_teardown()
1163 : *
1164 : * Restores the usual kernel environment once the call has returned.
1165 : */
1166 :
1167 : #define efi_call_virt_pointer(p, f, args...) \
1168 : ({ \
1169 : efi_status_t __s; \
1170 : unsigned long __flags; \
1171 : \
1172 : arch_efi_call_virt_setup(); \
1173 : \
1174 : __flags = efi_call_virt_save_flags(); \
1175 : __s = arch_efi_call_virt(p, f, args); \
1176 : efi_call_virt_check_flags(__flags, __stringify(f)); \
1177 : \
1178 : arch_efi_call_virt_teardown(); \
1179 : \
1180 : __s; \
1181 : })
1182 :
1183 : #define __efi_call_virt_pointer(p, f, args...) \
1184 : ({ \
1185 : unsigned long __flags; \
1186 : \
1187 : arch_efi_call_virt_setup(); \
1188 : \
1189 : __flags = efi_call_virt_save_flags(); \
1190 : arch_efi_call_virt(p, f, args); \
1191 : efi_call_virt_check_flags(__flags, __stringify(f)); \
1192 : \
1193 : arch_efi_call_virt_teardown(); \
1194 : })
1195 :
1196 : #define EFI_RANDOM_SEED_SIZE 32U // BLAKE2S_HASH_SIZE
1197 :
1198 : struct linux_efi_random_seed {
1199 : u32 size;
1200 : u8 bits[];
1201 : };
1202 :
1203 : struct linux_efi_tpm_eventlog {
1204 : u32 size;
1205 : u32 final_events_preboot_size;
1206 : u8 version;
1207 : u8 log[];
1208 : };
1209 :
1210 : extern int efi_tpm_eventlog_init(void);
1211 :
1212 : struct efi_tcg2_final_events_table {
1213 : u64 version;
1214 : u64 nr_events;
1215 : u8 events[];
1216 : };
1217 : extern int efi_tpm_final_log_size;
1218 :
1219 : extern unsigned long rci2_table_phys;
1220 :
1221 : /*
1222 : * efi_runtime_service() function identifiers.
1223 : * "NONE" is used by efi_recover_from_page_fault() to check if the page
1224 : * fault happened while executing an efi runtime service.
1225 : */
1226 : enum efi_rts_ids {
1227 : EFI_NONE,
1228 : EFI_GET_TIME,
1229 : EFI_SET_TIME,
1230 : EFI_GET_WAKEUP_TIME,
1231 : EFI_SET_WAKEUP_TIME,
1232 : EFI_GET_VARIABLE,
1233 : EFI_GET_NEXT_VARIABLE,
1234 : EFI_SET_VARIABLE,
1235 : EFI_QUERY_VARIABLE_INFO,
1236 : EFI_GET_NEXT_HIGH_MONO_COUNT,
1237 : EFI_RESET_SYSTEM,
1238 : EFI_UPDATE_CAPSULE,
1239 : EFI_QUERY_CAPSULE_CAPS,
1240 : };
1241 :
1242 : /*
1243 : * efi_runtime_work: Details of EFI Runtime Service work
1244 : * @arg<1-5>: EFI Runtime Service function arguments
1245 : * @status: Status of executing EFI Runtime Service
1246 : * @efi_rts_id: EFI Runtime Service function identifier
1247 : * @efi_rts_comp: Struct used for handling completions
1248 : */
1249 : struct efi_runtime_work {
1250 : void *arg1;
1251 : void *arg2;
1252 : void *arg3;
1253 : void *arg4;
1254 : void *arg5;
1255 : efi_status_t status;
1256 : struct work_struct work;
1257 : enum efi_rts_ids efi_rts_id;
1258 : struct completion efi_rts_comp;
1259 : };
1260 :
1261 : extern struct efi_runtime_work efi_rts_work;
1262 :
1263 : /* Workqueue to queue EFI Runtime Services */
1264 : extern struct workqueue_struct *efi_rts_wq;
1265 :
1266 : struct linux_efi_memreserve {
1267 : int size; // allocated size of the array
1268 : atomic_t count; // number of entries used
1269 : phys_addr_t next; // pa of next struct instance
1270 : struct {
1271 : phys_addr_t base;
1272 : phys_addr_t size;
1273 : } entry[];
1274 : };
1275 :
1276 : #define EFI_MEMRESERVE_COUNT(size) (((size) - sizeof(struct linux_efi_memreserve)) \
1277 : / sizeof_field(struct linux_efi_memreserve, entry[0]))
1278 :
1279 : void __init efi_arch_mem_reserve(phys_addr_t addr, u64 size);
1280 :
1281 : char *efi_systab_show_arch(char *str);
1282 :
1283 : /*
1284 : * The LINUX_EFI_MOK_VARIABLE_TABLE_GUID config table can be provided
1285 : * to the kernel by an EFI boot loader. The table contains a packed
1286 : * sequence of these entries, one for each named MOK variable.
1287 : * The sequence is terminated by an entry with a completely NULL
1288 : * name and 0 data size.
1289 : */
1290 : struct efi_mokvar_table_entry {
1291 : char name[256];
1292 : u64 data_size;
1293 : u8 data[];
1294 : } __attribute((packed));
1295 :
1296 : #ifdef CONFIG_LOAD_UEFI_KEYS
1297 : extern void __init efi_mokvar_table_init(void);
1298 : extern struct efi_mokvar_table_entry *efi_mokvar_entry_next(
1299 : struct efi_mokvar_table_entry **mokvar_entry);
1300 : extern struct efi_mokvar_table_entry *efi_mokvar_entry_find(const char *name);
1301 : #else
1302 : static inline void efi_mokvar_table_init(void) { }
1303 : static inline struct efi_mokvar_table_entry *efi_mokvar_entry_next(
1304 : struct efi_mokvar_table_entry **mokvar_entry)
1305 : {
1306 : return NULL;
1307 : }
1308 : static inline struct efi_mokvar_table_entry *efi_mokvar_entry_find(
1309 : const char *name)
1310 : {
1311 : return NULL;
1312 : }
1313 : #endif
1314 :
1315 : extern void efifb_setup_from_dmi(struct screen_info *si, const char *opt);
1316 :
1317 : struct linux_efi_coco_secret_area {
1318 : u64 base_pa;
1319 : u64 size;
1320 : };
1321 :
1322 : struct linux_efi_initrd {
1323 : unsigned long base;
1324 : unsigned long size;
1325 : };
1326 :
1327 : /* Header of a populated EFI secret area */
1328 : #define EFI_SECRET_TABLE_HEADER_GUID EFI_GUID(0x1e74f542, 0x71dd, 0x4d66, 0x96, 0x3e, 0xef, 0x42, 0x87, 0xff, 0x17, 0x3b)
1329 :
1330 : bool xen_efi_config_table_is_usable(const efi_guid_t *guid, unsigned long table);
1331 :
1332 : static inline
1333 : bool efi_config_table_is_usable(const efi_guid_t *guid, unsigned long table)
1334 : {
1335 : if (!IS_ENABLED(CONFIG_XEN_EFI))
1336 : return true;
1337 : return xen_efi_config_table_is_usable(guid, table);
1338 : }
1339 :
1340 : #endif /* _LINUX_EFI_H */
|
