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

source code of linux/include/linux/efi.h