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