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