]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - include/linux/efi.h
Merge tag 'hwlock-v4.21' of git://github.com/andersson/remoteproc
[mirror_ubuntu-eoan-kernel.git] / include / linux / efi.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
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>
4a3575fd 22#include <linux/pfn.h>
5ee9c198 23#include <linux/pstore.h>
60863c0d 24#include <linux/range.h>
8562c99c 25#include <linux/reboot.h>
ba7e34b1 26#include <linux/uuid.h>
2c23b73c 27#include <linux/screen_info.h>
1da177e4
LT
28
29#include <asm/page.h>
1da177e4
LT
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)))
5d9db883
MG
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)))
1da177e4 41#define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
dce48e35 42#define EFI_ABORTED (21 | (1UL << (BITS_PER_LONG-1)))
5d9db883 43#define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1)))
1da177e4
LT
44
45typedef unsigned long efi_status_t;
46typedef u8 efi_bool_t;
47typedef u16 efi_char16_t; /* UNICODE character */
ed37ddff
RF
48typedef u64 efi_physical_addr_t;
49typedef void *efi_handle_t;
1da177e4 50
c0020756 51typedef guid_t efi_guid_t;
1da177e4
LT
52
53#define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
c0020756 54 GUID_INIT(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7)
1da177e4
LT
55
56/*
57 * Generic EFI table header
58 */
59typedef struct {
60 u64 signature;
61 u32 revision;
62 u32 headersize;
63 u32 crc32;
64 u32 reserved;
65} efi_table_hdr_t;
66
67/*
68 * Memory map descriptor:
69 */
70
71/* Memory types: */
72#define EFI_RESERVED_TYPE 0
73#define EFI_LOADER_CODE 1
74#define EFI_LOADER_DATA 2
75#define EFI_BOOT_SERVICES_CODE 3
76#define EFI_BOOT_SERVICES_DATA 4
77#define EFI_RUNTIME_SERVICES_CODE 5
78#define EFI_RUNTIME_SERVICES_DATA 6
79#define EFI_CONVENTIONAL_MEMORY 7
80#define EFI_UNUSABLE_MEMORY 8
81#define EFI_ACPI_RECLAIM_MEMORY 9
82#define EFI_ACPI_MEMORY_NVS 10
83#define EFI_MEMORY_MAPPED_IO 11
84#define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
85#define EFI_PAL_CODE 13
ad5fb870
DW
86#define EFI_PERSISTENT_MEMORY 14
87#define EFI_MAX_MEMORY_TYPE 15
1da177e4
LT
88
89/* Attribute values: */
90#define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
91#define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
92#define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
93#define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
9c97e0bd 94#define EFI_MEMORY_UCE ((u64)0x0000000000000010ULL) /* uncached, exported */
1da177e4
LT
95#define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
96#define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
97#define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
c016ca08 98#define EFI_MEMORY_NV ((u64)0x0000000000008000ULL) /* non-volatile */
b05b9f5f
TL
99#define EFI_MEMORY_MORE_RELIABLE \
100 ((u64)0x0000000000010000ULL) /* higher reliability */
87db73ae 101#define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */
1da177e4
LT
102#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
103#define EFI_MEMORY_DESCRIPTOR_VERSION 1
104
105#define EFI_PAGE_SHIFT 12
ed37ddff 106#define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
0100a3e6 107#define EFI_PAGES_MAX (U64_MAX >> EFI_PAGE_SHIFT)
1da177e4 108
1da177e4
LT
109typedef struct {
110 u32 type;
111 u32 pad;
112 u64 phys_addr;
113 u64 virt_addr;
114 u64 num_pages;
115 u64 attribute;
1da177e4
LT
116} efi_memory_desc_t;
117
3b370237
MG
118typedef struct {
119 efi_guid_t guid;
120 u32 headersize;
121 u32 flags;
122 u32 imagesize;
123} efi_capsule_header_t;
124
dadb57ab
JH
125struct efi_boot_memmap {
126 efi_memory_desc_t **map;
127 unsigned long *map_size;
128 unsigned long *desc_size;
129 u32 *desc_ver;
130 unsigned long *key_ptr;
131 unsigned long *buff_size;
132};
133
f0133f3c
MF
134/*
135 * EFI capsule flags
136 */
137#define EFI_CAPSULE_PERSIST_ACROSS_RESET 0x00010000
138#define EFI_CAPSULE_POPULATE_SYSTEM_TABLE 0x00020000
139#define EFI_CAPSULE_INITIATE_RESET 0x00040000
140
3fabd628
AB
141struct capsule_info {
142 efi_capsule_header_t header;
f24c4d47 143 efi_capsule_header_t *capsule;
3fabd628
AB
144 int reset_type;
145 long index;
146 size_t count;
147 size_t total_size;
f24c4d47
AB
148 struct page **pages;
149 phys_addr_t *phys;
3fabd628
AB
150 size_t page_bytes_remain;
151};
152
153int __efi_capsule_setup_info(struct capsule_info *cap_info);
154
bb05e4ba
MF
155/*
156 * Allocation types for calls to boottime->allocate_pages.
157 */
158#define EFI_ALLOCATE_ANY_PAGES 0
159#define EFI_ALLOCATE_MAX_ADDRESS 1
160#define EFI_ALLOCATE_ADDRESS 2
161#define EFI_MAX_ALLOCATE_TYPE 3
162
e088a4ad 163typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
1da177e4
LT
164
165/*
166 * Types and defines for Time Services
167 */
168#define EFI_TIME_ADJUST_DAYLIGHT 0x1
169#define EFI_TIME_IN_DAYLIGHT 0x2
170#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
171
172typedef struct {
173 u16 year;
174 u8 month;
175 u8 day;
176 u8 hour;
177 u8 minute;
178 u8 second;
179 u8 pad1;
180 u32 nanosecond;
181 s16 timezone;
182 u8 daylight;
183 u8 pad2;
184} efi_time_t;
185
186typedef struct {
187 u32 resolution;
188 u32 accuracy;
189 u8 sets_to_zero;
190} efi_time_cap_t;
191
677703ce
MF
192typedef struct {
193 efi_table_hdr_t hdr;
194 u32 raise_tpl;
195 u32 restore_tpl;
196 u32 allocate_pages;
197 u32 free_pages;
198 u32 get_memory_map;
199 u32 allocate_pool;
200 u32 free_pool;
201 u32 create_event;
202 u32 set_timer;
203 u32 wait_for_event;
204 u32 signal_event;
205 u32 close_event;
206 u32 check_event;
207 u32 install_protocol_interface;
208 u32 reinstall_protocol_interface;
209 u32 uninstall_protocol_interface;
210 u32 handle_protocol;
211 u32 __reserved;
212 u32 register_protocol_notify;
213 u32 locate_handle;
214 u32 locate_device_path;
215 u32 install_configuration_table;
216 u32 load_image;
217 u32 start_image;
218 u32 exit;
219 u32 unload_image;
220 u32 exit_boot_services;
221 u32 get_next_monotonic_count;
222 u32 stall;
223 u32 set_watchdog_timer;
224 u32 connect_controller;
225 u32 disconnect_controller;
226 u32 open_protocol;
227 u32 close_protocol;
228 u32 open_protocol_information;
229 u32 protocols_per_handle;
230 u32 locate_handle_buffer;
231 u32 locate_protocol;
232 u32 install_multiple_protocol_interfaces;
233 u32 uninstall_multiple_protocol_interfaces;
234 u32 calculate_crc32;
235 u32 copy_mem;
236 u32 set_mem;
237 u32 create_event_ex;
238} __packed efi_boot_services_32_t;
239
240typedef struct {
241 efi_table_hdr_t hdr;
242 u64 raise_tpl;
243 u64 restore_tpl;
244 u64 allocate_pages;
245 u64 free_pages;
246 u64 get_memory_map;
247 u64 allocate_pool;
248 u64 free_pool;
249 u64 create_event;
250 u64 set_timer;
251 u64 wait_for_event;
252 u64 signal_event;
253 u64 close_event;
254 u64 check_event;
255 u64 install_protocol_interface;
256 u64 reinstall_protocol_interface;
257 u64 uninstall_protocol_interface;
258 u64 handle_protocol;
259 u64 __reserved;
260 u64 register_protocol_notify;
261 u64 locate_handle;
262 u64 locate_device_path;
263 u64 install_configuration_table;
264 u64 load_image;
265 u64 start_image;
266 u64 exit;
267 u64 unload_image;
268 u64 exit_boot_services;
269 u64 get_next_monotonic_count;
270 u64 stall;
271 u64 set_watchdog_timer;
272 u64 connect_controller;
273 u64 disconnect_controller;
274 u64 open_protocol;
275 u64 close_protocol;
276 u64 open_protocol_information;
277 u64 protocols_per_handle;
278 u64 locate_handle_buffer;
279 u64 locate_protocol;
280 u64 install_multiple_protocol_interfaces;
281 u64 uninstall_multiple_protocol_interfaces;
282 u64 calculate_crc32;
283 u64 copy_mem;
284 u64 set_mem;
285 u64 create_event_ex;
286} __packed efi_boot_services_64_t;
287
f30ca6ba
MF
288/*
289 * EFI Boot Services table
290 */
291typedef struct {
292 efi_table_hdr_t hdr;
293 void *raise_tpl;
294 void *restore_tpl;
ed37ddff
RF
295 efi_status_t (*allocate_pages)(int, int, unsigned long,
296 efi_physical_addr_t *);
297 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
298 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
299 unsigned long *, u32 *);
300 efi_status_t (*allocate_pool)(int, unsigned long, void **);
301 efi_status_t (*free_pool)(void *);
f30ca6ba
MF
302 void *create_event;
303 void *set_timer;
304 void *wait_for_event;
305 void *signal_event;
306 void *close_event;
307 void *check_event;
308 void *install_protocol_interface;
309 void *reinstall_protocol_interface;
310 void *uninstall_protocol_interface;
ed37ddff 311 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
f30ca6ba
MF
312 void *__reserved;
313 void *register_protocol_notify;
fc372064
AB
314 efi_status_t (*locate_handle)(int, efi_guid_t *, void *,
315 unsigned long *, efi_handle_t *);
f30ca6ba 316 void *locate_device_path;
801820be 317 efi_status_t (*install_configuration_table)(efi_guid_t *, void *);
f30ca6ba
MF
318 void *load_image;
319 void *start_image;
320 void *exit;
321 void *unload_image;
ed37ddff 322 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
f30ca6ba
MF
323 void *get_next_monotonic_count;
324 void *stall;
325 void *set_watchdog_timer;
326 void *connect_controller;
327 void *disconnect_controller;
328 void *open_protocol;
329 void *close_protocol;
330 void *open_protocol_information;
331 void *protocols_per_handle;
332 void *locate_handle_buffer;
e4fbf476 333 efi_status_t (*locate_protocol)(efi_guid_t *, void *, void **);
f30ca6ba
MF
334 void *install_multiple_protocol_interfaces;
335 void *uninstall_multiple_protocol_interfaces;
336 void *calculate_crc32;
337 void *copy_mem;
338 void *set_mem;
339 void *create_event_ex;
340} efi_boot_services_t;
341
dd5fc854
MG
342typedef enum {
343 EfiPciIoWidthUint8,
344 EfiPciIoWidthUint16,
345 EfiPciIoWidthUint32,
346 EfiPciIoWidthUint64,
347 EfiPciIoWidthFifoUint8,
348 EfiPciIoWidthFifoUint16,
349 EfiPciIoWidthFifoUint32,
350 EfiPciIoWidthFifoUint64,
351 EfiPciIoWidthFillUint8,
352 EfiPciIoWidthFillUint16,
353 EfiPciIoWidthFillUint32,
354 EfiPciIoWidthFillUint64,
355 EfiPciIoWidthMaximum
356} EFI_PCI_IO_PROTOCOL_WIDTH;
357
358typedef enum {
359 EfiPciIoAttributeOperationGet,
360 EfiPciIoAttributeOperationSet,
361 EfiPciIoAttributeOperationEnable,
362 EfiPciIoAttributeOperationDisable,
363 EfiPciIoAttributeOperationSupported,
364 EfiPciIoAttributeOperationMaximum
365} EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
366
677703ce
MF
367typedef struct {
368 u32 read;
369 u32 write;
370} efi_pci_io_protocol_access_32_t;
371
372typedef struct {
373 u64 read;
374 u64 write;
375} efi_pci_io_protocol_access_64_t;
dd5fc854
MG
376
377typedef struct {
378 void *read;
379 void *write;
380} efi_pci_io_protocol_access_t;
381
677703ce
MF
382typedef struct {
383 u32 poll_mem;
384 u32 poll_io;
385 efi_pci_io_protocol_access_32_t mem;
386 efi_pci_io_protocol_access_32_t io;
387 efi_pci_io_protocol_access_32_t pci;
388 u32 copy_mem;
389 u32 map;
390 u32 unmap;
391 u32 allocate_buffer;
392 u32 free_buffer;
393 u32 flush;
394 u32 get_location;
395 u32 attributes;
396 u32 get_bar_attributes;
397 u32 set_bar_attributes;
0b3225ab
AB
398 u64 romsize;
399 u32 romimage;
cb0ba793 400} efi_pci_io_protocol_32_t;
677703ce
MF
401
402typedef struct {
403 u64 poll_mem;
404 u64 poll_io;
405 efi_pci_io_protocol_access_64_t mem;
406 efi_pci_io_protocol_access_64_t io;
407 efi_pci_io_protocol_access_64_t pci;
408 u64 copy_mem;
409 u64 map;
410 u64 unmap;
411 u64 allocate_buffer;
412 u64 free_buffer;
413 u64 flush;
414 u64 get_location;
415 u64 attributes;
416 u64 get_bar_attributes;
417 u64 set_bar_attributes;
0b3225ab
AB
418 u64 romsize;
419 u64 romimage;
cb0ba793 420} efi_pci_io_protocol_64_t;
677703ce 421
dd5fc854
MG
422typedef struct {
423 void *poll_mem;
424 void *poll_io;
425 efi_pci_io_protocol_access_t mem;
426 efi_pci_io_protocol_access_t io;
427 efi_pci_io_protocol_access_t pci;
428 void *copy_mem;
429 void *map;
430 void *unmap;
431 void *allocate_buffer;
432 void *free_buffer;
433 void *flush;
434 void *get_location;
435 void *attributes;
436 void *get_bar_attributes;
437 void *set_bar_attributes;
438 uint64_t romsize;
439 void *romimage;
cb0ba793 440} efi_pci_io_protocol_t;
dd5fc854
MG
441
442#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
443#define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
444#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
445#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
446#define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
447#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
448#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
449#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
450#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
451#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
452#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
453#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
454#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
455#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
456#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
457#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
458#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
459#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
460#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
461
58c5475a
LW
462typedef struct {
463 u32 version;
464 u32 get;
465 u32 set;
466 u32 del;
467 u32 get_all;
468} apple_properties_protocol_32_t;
469
470typedef struct {
471 u64 version;
472 u64 get;
473 u64 set;
474 u64 del;
475 u64 get_all;
476} apple_properties_protocol_64_t;
477
33b6d034
TW
478typedef struct {
479 u32 get_capability;
480 u32 get_event_log;
481 u32 hash_log_extend_event;
482 u32 submit_command;
483 u32 get_active_pcr_banks;
484 u32 set_active_pcr_banks;
485 u32 get_result_of_set_active_pcr_banks;
486} efi_tcg2_protocol_32_t;
487
488typedef struct {
489 u64 get_capability;
490 u64 get_event_log;
491 u64 hash_log_extend_event;
492 u64 submit_command;
493 u64 get_active_pcr_banks;
494 u64 set_active_pcr_banks;
495 u64 get_result_of_set_active_pcr_banks;
496} efi_tcg2_protocol_64_t;
497
498typedef u32 efi_tcg2_event_log_format;
499
500typedef struct {
501 void *get_capability;
502 efi_status_t (*get_event_log)(efi_handle_t, efi_tcg2_event_log_format,
503 efi_physical_addr_t *, efi_physical_addr_t *, efi_bool_t *);
504 void *hash_log_extend_event;
505 void *submit_command;
506 void *get_active_pcr_banks;
507 void *set_active_pcr_banks;
508 void *get_result_of_set_active_pcr_banks;
509} efi_tcg2_protocol_t;
510
1da177e4
LT
511/*
512 * Types and defines for EFI ResetSystem
513 */
514#define EFI_RESET_COLD 0
515#define EFI_RESET_WARM 1
516#define EFI_RESET_SHUTDOWN 2
517
518/*
519 * EFI Runtime Services table
520 */
521#define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
522#define EFI_RUNTIME_SERVICES_REVISION 0x00010000
523
677703ce
MF
524typedef struct {
525 efi_table_hdr_t hdr;
526 u32 get_time;
527 u32 set_time;
528 u32 get_wakeup_time;
529 u32 set_wakeup_time;
530 u32 set_virtual_address_map;
531 u32 convert_pointer;
532 u32 get_variable;
533 u32 get_next_variable;
534 u32 set_variable;
535 u32 get_next_high_mono_count;
536 u32 reset_system;
537 u32 update_capsule;
538 u32 query_capsule_caps;
539 u32 query_variable_info;
540} efi_runtime_services_32_t;
541
542typedef struct {
543 efi_table_hdr_t hdr;
544 u64 get_time;
545 u64 set_time;
546 u64 get_wakeup_time;
547 u64 set_wakeup_time;
548 u64 set_virtual_address_map;
549 u64 convert_pointer;
550 u64 get_variable;
551 u64 get_next_variable;
552 u64 set_variable;
553 u64 get_next_high_mono_count;
554 u64 reset_system;
555 u64 update_capsule;
556 u64 query_capsule_caps;
557 u64 query_variable_info;
558} efi_runtime_services_64_t;
559
1da177e4
LT
560typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
561typedef efi_status_t efi_set_time_t (efi_time_t *tm);
562typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
563 efi_time_t *tm);
564typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
565typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
566 unsigned long *data_size, void *data);
567typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
568 efi_guid_t *vendor);
569typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
f7a2d73f 570 u32 attr, unsigned long data_size,
1da177e4
LT
571 void *data);
572typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
573typedef void efi_reset_system_t (int reset_type, efi_status_t status,
574 unsigned long data_size, efi_char16_t *data);
575typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
576 unsigned long descriptor_size,
577 u32 descriptor_version,
578 efi_memory_desc_t *virtual_map);
3b370237
MG
579typedef efi_status_t efi_query_variable_info_t(u32 attr,
580 u64 *storage_space,
581 u64 *remaining_space,
582 u64 *max_variable_size);
583typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
584 unsigned long count,
585 unsigned long sg_list);
586typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
587 unsigned long count,
588 u64 *max_size,
589 int *reset_type);
ca0e30dc
AB
590typedef efi_status_t efi_query_variable_store_t(u32 attributes,
591 unsigned long size,
592 bool nonblocking);
1da177e4 593
c4c39c70
AB
594typedef struct {
595 efi_table_hdr_t hdr;
596 efi_get_time_t *get_time;
597 efi_set_time_t *set_time;
598 efi_get_wakeup_time_t *get_wakeup_time;
599 efi_set_wakeup_time_t *set_wakeup_time;
600 efi_set_virtual_address_map_t *set_virtual_address_map;
601 void *convert_pointer;
602 efi_get_variable_t *get_variable;
603 efi_get_next_variable_t *get_next_variable;
604 efi_set_variable_t *set_variable;
605 efi_get_next_high_mono_count_t *get_next_high_mono_count;
606 efi_reset_system_t *reset_system;
607 efi_update_capsule_t *update_capsule;
608 efi_query_capsule_caps_t *query_capsule_caps;
609 efi_query_variable_info_t *query_variable_info;
610} efi_runtime_services_t;
611
022ee6c5
AB
612void efi_native_runtime_setup(void);
613
1da177e4 614/*
54fd11fe
PJ
615 * EFI Configuration Table and GUID definitions
616 *
7fb2b43c
IM
617 * These are all defined in a single line to make them easier to
618 * grep for and to see them at a glance - while still having a
619 * similar structure to the definitions in the spec.
620 *
621 * Here's how they are structured:
54fd11fe
PJ
622 *
623 * GUID: 12345678-1234-1234-1234-123456789012
624 * Spec:
625 * #define EFI_SOME_PROTOCOL_GUID \
626 * {0x12345678,0x1234,0x1234,\
627 * {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}}
628 * Here:
7fb2b43c
IM
629 * #define SOME_PROTOCOL_GUID EFI_GUID(0x12345678, 0x1234, 0x1234, 0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12)
630 * ^ tabs ^extra space
631 *
632 * Note that the 'extra space' separates the values at the same place
633 * where the UEFI SPEC breaks the line.
1da177e4 634 */
7fb2b43c
IM
635#define NULL_GUID EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
636#define MPS_TABLE_GUID EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
637#define ACPI_TABLE_GUID EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
638#define ACPI_20_TABLE_GUID EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
639#define SMBIOS_TABLE_GUID EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
640#define SMBIOS3_TABLE_GUID EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94)
641#define SAL_SYSTEM_TABLE_GUID EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
642#define HCDP_TABLE_GUID EFI_GUID(0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98)
643#define UGA_IO_PROTOCOL_GUID EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0x0b, 0x07, 0xa2)
644#define EFI_GLOBAL_VARIABLE_GUID EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
645#define UV_SYSTEM_TABLE_GUID EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93)
646#define LINUX_EFI_CRASH_GUID EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0)
647#define LOADED_IMAGE_PROTOCOL_GUID EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
648#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
649#define EFI_UGA_PROTOCOL_GUID EFI_GUID(0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39)
650#define EFI_PCI_IO_PROTOCOL_GUID EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
651#define EFI_FILE_INFO_ID EFI_GUID(0x09576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
652#define EFI_SYSTEM_RESOURCE_TABLE_GUID EFI_GUID(0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
653#define EFI_FILE_SYSTEM_GUID EFI_GUID(0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
654#define DEVICE_TREE_GUID EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
655#define EFI_PROPERTIES_TABLE_GUID EFI_GUID(0x880aaca3, 0x4adc, 0x4a04, 0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5)
656#define EFI_RNG_PROTOCOL_GUID EFI_GUID(0x3152bca5, 0xeade, 0x433d, 0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
568bc4e8 657#define EFI_RNG_ALGORITHM_RAW EFI_GUID(0xe43176d7, 0xb6e8, 0x4827, 0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61)
7fb2b43c
IM
658#define EFI_MEMORY_ATTRIBUTES_TABLE_GUID EFI_GUID(0xdcfa911d, 0x26eb, 0x469f, 0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
659#define EFI_CONSOLE_OUT_DEVICE_GUID EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4, 0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
58c5475a 660#define APPLE_PROPERTIES_PROTOCOL_GUID EFI_GUID(0x91bd12fe, 0xf6c3, 0x44fb, 0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0)
33b6d034 661#define EFI_TCG2_PROTOCOL_GUID EFI_GUID(0x607f766c, 0x7455, 0x42be, 0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)
fc372064 662
e58910cd
JB
663#define EFI_IMAGE_SECURITY_DATABASE_GUID EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
664#define EFI_SHIM_LOCK_GUID EFI_GUID(0x605dab50, 0xe046, 0x4300, 0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23)
665
5c126ba2
DH
666#define EFI_CERT_SHA256_GUID EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
667#define EFI_CERT_X509_GUID EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
668#define EFI_CERT_X509_SHA256_GUID EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
669
801820be
AB
670/*
671 * This GUID is used to pass to the kernel proper the struct screen_info
672 * structure that was populated by the stub based on the GOP protocol instance
673 * associated with ConOut
674 */
7fb2b43c
IM
675#define LINUX_EFI_ARM_SCREEN_INFO_TABLE_GUID EFI_GUID(0xe03fc20a, 0x85dc, 0x406e, 0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95)
676#define LINUX_EFI_LOADER_ENTRY_GUID EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf, 0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)
63625988 677#define LINUX_EFI_RANDOM_SEED_TABLE_GUID EFI_GUID(0x1ce1e5bc, 0x7ceb, 0x42f2, 0x81, 0xe5, 0x8a, 0xad, 0xf1, 0x80, 0xf5, 0x7b)
33b6d034 678#define LINUX_EFI_TPM_EVENT_LOG_GUID EFI_GUID(0xb7799cb0, 0xeca2, 0x4943, 0x96, 0x67, 0x1f, 0xae, 0x07, 0xb7, 0x47, 0xfa)
71e0940d 679#define LINUX_EFI_MEMRESERVE_TABLE_GUID EFI_GUID(0x888eb0c6, 0x8ede, 0x4ff5, 0xa8, 0xf0, 0x9a, 0xee, 0x5c, 0xb9, 0x77, 0xc2)
06f7d4a1 680
1adbfa35
OJ
681typedef struct {
682 efi_guid_t guid;
683 u64 table;
684} efi_config_table_64_t;
685
686typedef struct {
687 efi_guid_t guid;
688 u32 table;
689} efi_config_table_32_t;
690
1da177e4
LT
691typedef struct {
692 efi_guid_t guid;
693 unsigned long table;
694} efi_config_table_t;
695
272686bf
LL
696typedef struct {
697 efi_guid_t guid;
698 const char *name;
699 unsigned long *ptr;
700} efi_config_table_type_t;
701
1da177e4 702#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
1da177e4 703
3b370237
MG
704#define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
705#define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
706#define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
707#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
708#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
709#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
710
1adbfa35
OJ
711typedef struct {
712 efi_table_hdr_t hdr;
713 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
714 u32 fw_revision;
715 u32 __pad1;
716 u64 con_in_handle;
717 u64 con_in;
718 u64 con_out_handle;
719 u64 con_out;
720 u64 stderr_handle;
721 u64 stderr;
722 u64 runtime;
723 u64 boottime;
724 u32 nr_tables;
725 u32 __pad2;
726 u64 tables;
727} efi_system_table_64_t;
728
729typedef struct {
730 efi_table_hdr_t hdr;
731 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
732 u32 fw_revision;
733 u32 con_in_handle;
734 u32 con_in;
735 u32 con_out_handle;
736 u32 con_out;
737 u32 stderr_handle;
738 u32 stderr;
739 u32 runtime;
740 u32 boottime;
741 u32 nr_tables;
742 u32 tables;
743} efi_system_table_32_t;
744
1da177e4
LT
745typedef struct {
746 efi_table_hdr_t hdr;
747 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
748 u32 fw_revision;
749 unsigned long con_in_handle;
750 unsigned long con_in;
751 unsigned long con_out_handle;
752 unsigned long con_out;
753 unsigned long stderr_handle;
754 unsigned long stderr;
755 efi_runtime_services_t *runtime;
f30ca6ba 756 efi_boot_services_t *boottime;
1da177e4
LT
757 unsigned long nr_tables;
758 unsigned long tables;
759} efi_system_table_t;
760
9479c7ce
MF
761/*
762 * Architecture independent structure for describing a memory map for the
763 * benefit of efi_memmap_init_early(), saving us the need to pass four
764 * parameters.
765 */
766struct efi_memory_map_data {
767 phys_addr_t phys_map;
768 unsigned long size;
769 unsigned long desc_version;
770 unsigned long desc_size;
771};
772
1da177e4 773struct efi_memory_map {
44511fb9 774 phys_addr_t phys_map;
7ae65fd3
MT
775 void *map;
776 void *map_end;
1da177e4
LT
777 int nr_map;
778 unsigned long desc_version;
7ae65fd3 779 unsigned long desc_size;
dca0f971 780 bool late;
1da177e4
LT
781};
782
60863c0d
MF
783struct efi_mem_range {
784 struct range range;
785 u64 attribute;
1da177e4
LT
786};
787
0302f71c
MS
788struct efi_fdt_params {
789 u64 system_table;
790 u64 mmap;
791 u32 mmap_size;
792 u32 desc_size;
793 u32 desc_ver;
794};
795
677703ce
MF
796typedef struct {
797 u32 revision;
798 u32 parent_handle;
799 u32 system_table;
800 u32 device_handle;
801 u32 file_path;
802 u32 reserved;
803 u32 load_options_size;
804 u32 load_options;
805 u32 image_base;
806 __aligned_u64 image_size;
807 unsigned int image_code_type;
808 unsigned int image_data_type;
809 unsigned long unload;
810} efi_loaded_image_32_t;
811
812typedef struct {
813 u32 revision;
814 u64 parent_handle;
815 u64 system_table;
816 u64 device_handle;
817 u64 file_path;
818 u64 reserved;
819 u32 load_options_size;
820 u64 load_options;
821 u64 image_base;
822 __aligned_u64 image_size;
823 unsigned int image_code_type;
824 unsigned int image_data_type;
825 unsigned long unload;
826} efi_loaded_image_64_t;
827
8e84f345
MF
828typedef struct {
829 u32 revision;
830 void *parent_handle;
831 efi_system_table_t *system_table;
832 void *device_handle;
833 void *file_path;
834 void *reserved;
835 u32 load_options_size;
836 void *load_options;
837 void *image_base;
838 __aligned_u64 image_size;
839 unsigned int image_code_type;
840 unsigned int image_data_type;
841 unsigned long unload;
842} efi_loaded_image_t;
843
55839d51
MF
844
845typedef struct {
846 u64 size;
847 u64 file_size;
848 u64 phys_size;
849 efi_time_t create_time;
850 efi_time_t last_access_time;
851 efi_time_t modification_time;
852 __aligned_u64 attribute;
853 efi_char16_t filename[1];
854} efi_file_info_t;
855
677703ce
MF
856typedef struct {
857 u64 revision;
858 u32 open;
859 u32 close;
860 u32 delete;
861 u32 read;
862 u32 write;
863 u32 get_position;
864 u32 set_position;
865 u32 get_info;
866 u32 set_info;
867 u32 flush;
868} efi_file_handle_32_t;
869
870typedef struct {
871 u64 revision;
872 u64 open;
873 u64 close;
874 u64 delete;
875 u64 read;
876 u64 write;
877 u64 get_position;
878 u64 set_position;
879 u64 get_info;
880 u64 set_info;
881 u64 flush;
882} efi_file_handle_64_t;
883
ed37ddff 884typedef struct _efi_file_handle {
55839d51 885 u64 revision;
ed37ddff
RF
886 efi_status_t (*open)(struct _efi_file_handle *,
887 struct _efi_file_handle **,
888 efi_char16_t *, u64, u64);
889 efi_status_t (*close)(struct _efi_file_handle *);
55839d51 890 void *delete;
ed37ddff
RF
891 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
892 void *);
55839d51
MF
893 void *write;
894 void *get_position;
895 void *set_position;
ed37ddff
RF
896 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
897 unsigned long *, void *);
55839d51
MF
898 void *set_info;
899 void *flush;
900} efi_file_handle_t;
901
c4db9c1e
LW
902typedef struct {
903 u64 revision;
904 u32 open_volume;
905} efi_file_io_interface_32_t;
906
907typedef struct {
908 u64 revision;
909 u64 open_volume;
910} efi_file_io_interface_64_t;
911
ed37ddff
RF
912typedef struct _efi_file_io_interface {
913 u64 revision;
914 int (*open_volume)(struct _efi_file_io_interface *,
915 efi_file_handle_t **);
916} efi_file_io_interface_t;
917
55839d51
MF
918#define EFI_FILE_MODE_READ 0x0000000000000001
919#define EFI_FILE_MODE_WRITE 0x0000000000000002
920#define EFI_FILE_MODE_CREATE 0x8000000000000000
921
bf924863
AB
922typedef struct {
923 u32 version;
924 u32 length;
925 u64 memory_protection_attribute;
926} efi_properties_table_t;
927
928#define EFI_PROPERTIES_TABLE_VERSION 0x00010000
929#define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1
930
b2c99e3c
BH
931#define EFI_INVALID_TABLE_ADDR (~0UL)
932
a604af07
AB
933typedef struct {
934 u32 version;
935 u32 num_entries;
936 u32 desc_size;
937 u32 reserved;
938 efi_memory_desc_t entry[0];
939} efi_memory_attributes_table_t;
940
5c126ba2
DH
941typedef struct {
942 efi_guid_t signature_owner;
943 u8 signature_data[];
944} efi_signature_data_t;
945
946typedef struct {
947 efi_guid_t signature_type;
948 u32 signature_list_size;
949 u32 signature_header_size;
950 u32 signature_size;
951 u8 signature_header[];
952 /* efi_signature_data_t signatures[][] */
953} efi_signature_list_t;
954
955typedef u8 efi_sha256_hash_t[32];
956
957typedef struct {
958 efi_sha256_hash_t to_be_signed_hash;
959 efi_time_t time_of_revocation;
960} efi_cert_x509_sha256_t;
961
1da177e4
LT
962/*
963 * All runtime access to EFI goes through this structure:
964 */
965extern struct efi {
966 efi_system_table_t *systab; /* EFI system table */
3b370237 967 unsigned int runtime_version; /* Runtime services version */
b2c99e3c
BH
968 unsigned long mps; /* MPS table */
969 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
970 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
e1ccbbc9
AB
971 unsigned long smbios; /* SMBIOS table (32 bit entry point) */
972 unsigned long smbios3; /* SMBIOS table (64 bit entry point) */
b2c99e3c
BH
973 unsigned long sal_systab; /* SAL system table */
974 unsigned long boot_info; /* boot info table */
975 unsigned long hcdp; /* HCDP table */
976 unsigned long uga; /* UGA table */
a50f70b1 977 unsigned long uv_systab; /* UV system table */
a0998eb1
DY
978 unsigned long fw_vendor; /* fw_vendor */
979 unsigned long runtime; /* runtime table */
980 unsigned long config_table; /* config tables */
0bb54905 981 unsigned long esrt; /* ESRT table */
bf924863 982 unsigned long properties_table; /* properties table */
a604af07 983 unsigned long mem_attr_table; /* memory attributes table */
63625988 984 unsigned long rng_seed; /* UEFI firmware random seed */
33b6d034 985 unsigned long tpm_log; /* TPM2 Event Log table */
71e0940d 986 unsigned long mem_reserve; /* Linux EFI memreserve table */
1da177e4
LT
987 efi_get_time_t *get_time;
988 efi_set_time_t *set_time;
989 efi_get_wakeup_time_t *get_wakeup_time;
990 efi_set_wakeup_time_t *set_wakeup_time;
991 efi_get_variable_t *get_variable;
992 efi_get_next_variable_t *get_next_variable;
993 efi_set_variable_t *set_variable;
70d2a3cf 994 efi_set_variable_t *set_variable_nonblocking;
3b370237 995 efi_query_variable_info_t *query_variable_info;
d3cac1f8 996 efi_query_variable_info_t *query_variable_info_nonblocking;
3b370237
MG
997 efi_update_capsule_t *update_capsule;
998 efi_query_capsule_caps_t *query_capsule_caps;
1da177e4
LT
999 efi_get_next_high_mono_count_t *get_next_high_mono_count;
1000 efi_reset_system_t *reset_system;
1001 efi_set_virtual_address_map_t *set_virtual_address_map;
884f4f66 1002 struct efi_memory_map memmap;
3e909599 1003 unsigned long flags;
1da177e4
LT
1004} efi;
1005
7e904a91
SP
1006extern struct mm_struct efi_mm;
1007
1da177e4
LT
1008static inline int
1009efi_guidcmp (efi_guid_t left, efi_guid_t right)
1010{
1011 return memcmp(&left, &right, sizeof (efi_guid_t));
1012}
1013
1014static inline char *
26e02272 1015efi_guid_to_str(efi_guid_t *guid, char *out)
1da177e4 1016{
925ede0b 1017 sprintf(out, "%pUl", guid->b);
1da177e4
LT
1018 return out;
1019}
1020
1021extern void efi_init (void);
1022extern void *efi_get_pal_addr (void);
1023extern void efi_map_pal_code (void);
1da177e4 1024extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
70f4f935 1025extern void efi_gettimeofday (struct timespec64 *ts);
1da177e4 1026extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
78510792 1027#ifdef CONFIG_X86
ca0e30dc
AB
1028extern efi_status_t efi_query_variable_store(u32 attributes,
1029 unsigned long size,
1030 bool nonblocking);
b05b9f5f 1031extern void efi_find_mirror(void);
78510792 1032#else
a6e4d5a0 1033
ca0e30dc
AB
1034static inline efi_status_t efi_query_variable_store(u32 attributes,
1035 unsigned long size,
1036 bool nonblocking)
a6e4d5a0
MF
1037{
1038 return EFI_SUCCESS;
1039}
78510792 1040#endif
7bc90e01 1041extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
9479c7ce 1042
20b1e22d 1043extern phys_addr_t __init efi_memmap_alloc(unsigned int num_entries);
9479c7ce 1044extern int __init efi_memmap_init_early(struct efi_memory_map_data *data);
dca0f971 1045extern int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size);
9479c7ce 1046extern void __init efi_memmap_unmap(void);
c45f4da3 1047extern int __init efi_memmap_install(phys_addr_t addr, unsigned int nr_map);
60863c0d
MF
1048extern int __init efi_memmap_split_count(efi_memory_desc_t *md,
1049 struct range *range);
1050extern void __init efi_memmap_insert(struct efi_memory_map *old_memmap,
1051 void *buf, struct efi_mem_range *mem);
9479c7ce 1052
272686bf 1053extern int efi_config_init(efi_config_table_type_t *arch_tables);
3846c158 1054#ifdef CONFIG_EFI_ESRT
0bb54905 1055extern void __init efi_esrt_init(void);
3846c158
PJ
1056#else
1057static inline void efi_esrt_init(void) { }
1058#endif
7bb68410
AB
1059extern int efi_config_parse_tables(void *config_tables, int count, int sz,
1060 efi_config_table_type_t *arch_tables);
1da177e4 1061extern u64 efi_get_iobase (void);
f99afd08 1062extern int efi_mem_type(unsigned long phys_addr);
1da177e4 1063extern u64 efi_mem_attributes (unsigned long phys_addr);
32e62c63 1064extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
1da177e4 1065extern int __init efi_uart_console_only (void);
0bb54905
PJ
1066extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
1067extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
816e7612 1068extern void efi_mem_reserve(phys_addr_t addr, u64 size);
a23d3bb0 1069extern int efi_mem_reserve_persistent(phys_addr_t addr, u64 size);
1da177e4 1070extern void efi_initialize_iomem_resources(struct resource *code_resource,
00bf4098 1071 struct resource *data_resource, struct resource *bss_resource);
7968c0e3 1072extern int efi_get_fdt_params(struct efi_fdt_params *params);
0bb54905 1073extern struct kobject *efi_kobj;
1da177e4 1074
44be28e9 1075extern int efi_reboot_quirk_mode;
0c5ed61a
MF
1076extern bool efi_poweroff_required(void);
1077
0f96a99d
TI
1078#ifdef CONFIG_EFI_FAKE_MEMMAP
1079extern void __init efi_fake_memmap(void);
1080#else
1081static inline void efi_fake_memmap(void) { }
1082#endif
1083
10f0d2f5
AB
1084/*
1085 * efi_memattr_perm_setter - arch specific callback function passed into
1086 * efi_memattr_apply_permissions() that updates the
1087 * mapping permissions described by the second
1088 * argument in the page tables referred to by the
1089 * first argument.
1090 */
1091typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *);
1092
1093extern int efi_memattr_init(void);
1094extern int efi_memattr_apply_permissions(struct mm_struct *mm,
1095 efi_memattr_perm_setter fn);
1096
02e43c2d
BH
1097/*
1098 * efi_early_memdesc_ptr - get the n-th EFI memmap descriptor
1099 * @map: the start of efi memmap
1100 * @desc_size: the size of space for each EFI memmap descriptor
1101 * @n: the index of efi memmap descriptor
1102 *
1103 * EFI boot service provides the GetMemoryMap() function to get a copy of the
1104 * current memory map which is an array of memory descriptors, each of
1105 * which describes a contiguous block of memory. It also gets the size of the
1106 * map, and the size of each descriptor, etc.
1107 *
1108 * Note that per section 6.2 of UEFI Spec 2.6 Errata A, the returned size of
1109 * each descriptor might not be equal to sizeof(efi_memory_memdesc_t),
1110 * since efi_memory_memdesc_t may be extended in the future. Thus the OS
1111 * MUST use the returned size of the descriptor to find the start of each
1112 * efi_memory_memdesc_t in the memory map array. This should only be used
1113 * during bootup since for_each_efi_memory_desc_xxx() is available after the
1114 * kernel initializes the EFI subsystem to set up struct efi_memory_map.
1115 */
1116#define efi_early_memdesc_ptr(map, desc_size, n) \
1117 (efi_memory_desc_t *)((void *)(map) + ((n) * (desc_size)))
1118
e885cd80 1119/* Iterate through an efi_memory_map */
78ce248f 1120#define for_each_efi_memory_desc_in_map(m, md) \
e885cd80 1121 for ((md) = (m)->map; \
d4c4fed0 1122 (md) && ((void *)(md) + (m)->desc_size) <= (m)->map_end; \
e885cd80
MS
1123 (md) = (void *)(md) + (m)->desc_size)
1124
78ce248f
MF
1125/**
1126 * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
1127 * @md: the efi_memory_desc_t * iterator
1128 *
1129 * Once the loop finishes @md must not be accessed.
1130 */
1131#define for_each_efi_memory_desc(md) \
884f4f66 1132 for_each_efi_memory_desc_in_map(&efi.memmap, md)
78ce248f 1133
98d2a6ca
LE
1134/*
1135 * Format an EFI memory descriptor's type and attributes to a user-provided
1136 * character buffer, as per snprintf(), and return the buffer.
1137 */
1138char * __init efi_md_typeattr_format(char *buf, size_t size,
1139 const efi_memory_desc_t *md);
1140
0bc9ae39
DH
1141
1142typedef void (*efi_element_handler_t)(const char *source,
1143 const void *element_data,
1144 size_t element_size);
1145extern int __init parse_efi_signature_list(
1146 const char *source,
1147 const void *data, size_t size,
1148 efi_element_handler_t (*get_handler_for_guid)(const efi_guid_t *));
1149
1da177e4
LT
1150/**
1151 * efi_range_is_wc - check the WC bit on an address range
1152 * @start: starting kvirt address
1153 * @len: length of range
1154 *
1155 * Consult the EFI memory map and make sure it's ok to set this range WC.
1156 * Returns true or false.
1157 */
1158static inline int efi_range_is_wc(unsigned long start, unsigned long len)
1159{
986a80d5 1160 unsigned long i;
1da177e4
LT
1161
1162 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
1163 unsigned long paddr = __pa(start + i);
1164 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
1165 return 0;
1166 }
1167 /* The range checked out */
1168 return 1;
1169}
1170
1171#ifdef CONFIG_EFI_PCDP
1172extern int __init efi_setup_pcdp_console(char *);
1173#endif
1174
1175/*
83e68189
MF
1176 * We play games with efi_enabled so that the compiler will, if
1177 * possible, remove EFI-related code altogether.
1da177e4 1178 */
83e68189 1179#define EFI_BOOT 0 /* Were we booted from EFI? */
83e68189
MF
1180#define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
1181#define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
1182#define EFI_MEMMAP 4 /* Can we use EFI memory map? */
1183#define EFI_64BIT 5 /* Is the firmware 64-bit? */
9f27bc54
DK
1184#define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
1185#define EFI_ARCH_1 7 /* First arch-specific bit */
fed6cefe 1186#define EFI_DBG 8 /* Print additional debug info at runtime */
a1041713 1187#define EFI_NX_PE_DATA 9 /* Can runtime data regions be mapped non-executable? */
a19ebf59 1188#define EFI_MEM_ATTR 10 /* Did firmware publish an EFI_MEMORY_ATTRIBUTES table? */
83e68189 1189
1da177e4 1190#ifdef CONFIG_EFI
3e909599
MF
1191/*
1192 * Test whether the above EFI_* bits are enabled.
1193 */
1194static inline bool efi_enabled(int feature)
1195{
1196 return test_bit(feature, &efi.flags) != 0;
1197}
8562c99c 1198extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
a19d66c5
TL
1199
1200extern bool efi_is_table_address(unsigned long phys_addr);
eff89628
AB
1201
1202extern int efi_apply_persistent_mem_reservations(void);
1da177e4 1203#else
3e909599 1204static inline bool efi_enabled(int feature)
83e68189 1205{
3e909599 1206 return false;
83e68189 1207}
8562c99c
MF
1208static inline void
1209efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
87615a34
MF
1210
1211static inline bool
1212efi_capsule_pending(int *reset_type)
1213{
1214 return false;
1215}
a19d66c5
TL
1216
1217static inline bool efi_is_table_address(unsigned long phys_addr)
1218{
1219 return false;
1220}
eff89628
AB
1221
1222static inline int efi_apply_persistent_mem_reservations(void)
1223{
1224 return 0;
1225}
1da177e4
LT
1226#endif
1227
806b0351
MF
1228extern int efi_status_to_err(efi_status_t status);
1229
1da177e4
LT
1230/*
1231 * Variable Attributes
1232 */
1233#define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
1234#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
1235#define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
41b3254c
MG
1236#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
1237#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
1238#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
1239#define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
1240
1241#define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
1242 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
1243 EFI_VARIABLE_RUNTIME_ACCESS | \
1244 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
1245 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
1246 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
1247 EFI_VARIABLE_APPEND_WRITE)
e14ab23d
MF
1248/*
1249 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1250 * not including trailing NUL
1251 */
ba7e34b1 1252#define EFI_VARIABLE_GUID_LEN UUID_STRING_LEN
e14ab23d 1253
e2527a7c
MF
1254/*
1255 * The type of search to perform when calling boottime->locate_handle
1256 */
1257#define EFI_LOCATE_ALL_HANDLES 0
1258#define EFI_LOCATE_BY_REGISTER_NOTIFY 1
1259#define EFI_LOCATE_BY_PROTOCOL 2
1260
1da177e4
LT
1261/*
1262 * EFI Device Path information
1263 */
1264#define EFI_DEV_HW 0x01
1265#define EFI_DEV_PCI 1
1266#define EFI_DEV_PCCARD 2
1267#define EFI_DEV_MEM_MAPPED 3
1268#define EFI_DEV_VENDOR 4
1269#define EFI_DEV_CONTROLLER 5
1270#define EFI_DEV_ACPI 0x02
1271#define EFI_DEV_BASIC_ACPI 1
1272#define EFI_DEV_EXPANDED_ACPI 2
1273#define EFI_DEV_MSG 0x03
1274#define EFI_DEV_MSG_ATAPI 1
1275#define EFI_DEV_MSG_SCSI 2
1276#define EFI_DEV_MSG_FC 3
1277#define EFI_DEV_MSG_1394 4
1278#define EFI_DEV_MSG_USB 5
1279#define EFI_DEV_MSG_USB_CLASS 15
1280#define EFI_DEV_MSG_I20 6
1281#define EFI_DEV_MSG_MAC 11
1282#define EFI_DEV_MSG_IPV4 12
1283#define EFI_DEV_MSG_IPV6 13
1284#define EFI_DEV_MSG_INFINIBAND 9
1285#define EFI_DEV_MSG_UART 14
1286#define EFI_DEV_MSG_VENDOR 10
1287#define EFI_DEV_MEDIA 0x04
1288#define EFI_DEV_MEDIA_HARD_DRIVE 1
1289#define EFI_DEV_MEDIA_CDROM 2
1290#define EFI_DEV_MEDIA_VENDOR 3
1291#define EFI_DEV_MEDIA_FILE 4
1292#define EFI_DEV_MEDIA_PROTOCOL 5
1293#define EFI_DEV_BIOS_BOOT 0x05
1294#define EFI_DEV_END_PATH 0x7F
1295#define EFI_DEV_END_PATH2 0xFF
1296#define EFI_DEV_END_INSTANCE 0x01
1297#define EFI_DEV_END_ENTIRE 0xFF
1298
1299struct efi_generic_dev_path {
1300 u8 type;
1301 u8 sub_type;
1302 u16 length;
1303} __attribute ((packed));
1304
46cd4b75
LW
1305struct efi_dev_path {
1306 u8 type; /* can be replaced with unnamed */
1307 u8 sub_type; /* struct efi_generic_dev_path; */
1308 u16 length; /* once we've moved to -std=c11 */
1309 union {
1310 struct {
1311 u32 hid;
1312 u32 uid;
1313 } acpi;
1314 struct {
1315 u8 fn;
1316 u8 dev;
1317 } pci;
1318 };
1319} __attribute ((packed));
1320
1321#if IS_ENABLED(CONFIG_EFI_DEV_PATH_PARSER)
1322struct device *efi_get_device_by_path(struct efi_dev_path **node, size_t *len);
1323#endif
1324
4a3575fd
HY
1325static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1326{
1327 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1328 *addr &= PAGE_MASK;
1329}
1330
4fc756bd
MW
1331/*
1332 * EFI Variable support.
1333 *
1334 * Different firmware drivers can expose their EFI-like variables using
1335 * the following.
1336 */
1337
1338struct efivar_operations {
1339 efi_get_variable_t *get_variable;
1340 efi_get_next_variable_t *get_next_variable;
1341 efi_set_variable_t *set_variable;
70d2a3cf 1342 efi_set_variable_t *set_variable_nonblocking;
a6e4d5a0 1343 efi_query_variable_store_t *query_variable_store;
4fc756bd
MW
1344};
1345
1346struct efivars {
4fc756bd 1347 struct kset *kset;
605e70c7 1348 struct kobject *kobject;
4fc756bd
MW
1349 const struct efivar_operations *ops;
1350};
1351
e14ab23d
MF
1352/*
1353 * The maximum size of VariableName + Data = 1024
1354 * Therefore, it's reasonable to save that much
1355 * space in each part of the structure,
1356 * and we use a page for reading/writing.
1357 */
1358
a5d92ad3
MF
1359#define EFI_VAR_NAME_LEN 1024
1360
e14ab23d 1361struct efi_variable {
a5d92ad3 1362 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
e14ab23d
MF
1363 efi_guid_t VendorGuid;
1364 unsigned long DataSize;
1365 __u8 Data[1024];
1366 efi_status_t Status;
1367 __u32 Attributes;
1368} __attribute__((packed));
1369
1370struct efivar_entry {
1371 struct efi_variable var;
1372 struct list_head list;
1373 struct kobject kobj;
e0d59733
SA
1374 bool scanning;
1375 bool deleting;
e14ab23d
MF
1376};
1377
db4545d9 1378typedef struct {
677703ce
MF
1379 u32 reset;
1380 u32 output_string;
1381 u32 test_string;
db4545d9 1382} efi_simple_text_output_protocol_32_t;
677703ce 1383
db4545d9 1384typedef struct {
677703ce
MF
1385 u64 reset;
1386 u64 output_string;
1387 u64 test_string;
db4545d9 1388} efi_simple_text_output_protocol_64_t;
ed37ddff
RF
1389
1390struct efi_simple_text_output_protocol {
1391 void *reset;
1392 efi_status_t (*output_string)(void *, void *);
1393 void *test_string;
1394};
1395
fc372064
AB
1396#define PIXEL_RGB_RESERVED_8BIT_PER_COLOR 0
1397#define PIXEL_BGR_RESERVED_8BIT_PER_COLOR 1
1398#define PIXEL_BIT_MASK 2
1399#define PIXEL_BLT_ONLY 3
1400#define PIXEL_FORMAT_MAX 4
1401
1402struct efi_pixel_bitmask {
1403 u32 red_mask;
1404 u32 green_mask;
1405 u32 blue_mask;
1406 u32 reserved_mask;
1407};
1408
1409struct efi_graphics_output_mode_info {
1410 u32 version;
1411 u32 horizontal_resolution;
1412 u32 vertical_resolution;
1413 int pixel_format;
1414 struct efi_pixel_bitmask pixel_information;
1415 u32 pixels_per_scan_line;
1416} __packed;
1417
1418struct efi_graphics_output_protocol_mode_32 {
1419 u32 max_mode;
1420 u32 mode;
1421 u32 info;
1422 u32 size_of_info;
1423 u64 frame_buffer_base;
1424 u32 frame_buffer_size;
1425} __packed;
1426
1427struct efi_graphics_output_protocol_mode_64 {
1428 u32 max_mode;
1429 u32 mode;
1430 u64 info;
1431 u64 size_of_info;
1432 u64 frame_buffer_base;
1433 u64 frame_buffer_size;
1434} __packed;
1435
1436struct efi_graphics_output_protocol_mode {
1437 u32 max_mode;
1438 u32 mode;
1439 unsigned long info;
1440 unsigned long size_of_info;
1441 u64 frame_buffer_base;
1442 unsigned long frame_buffer_size;
1443} __packed;
1444
1445struct efi_graphics_output_protocol_32 {
1446 u32 query_mode;
1447 u32 set_mode;
1448 u32 blt;
1449 u32 mode;
1450};
1451
1452struct efi_graphics_output_protocol_64 {
1453 u64 query_mode;
1454 u64 set_mode;
1455 u64 blt;
1456 u64 mode;
1457};
1458
1459struct efi_graphics_output_protocol {
1460 unsigned long query_mode;
1461 unsigned long set_mode;
1462 unsigned long blt;
1463 struct efi_graphics_output_protocol_mode *mode;
1464};
1465
1466typedef efi_status_t (*efi_graphics_output_protocol_query_mode)(
1467 struct efi_graphics_output_protocol *, u32, unsigned long *,
1468 struct efi_graphics_output_mode_info **);
1469
04851772
MF
1470extern struct list_head efivar_sysfs_list;
1471
1472static inline void
1473efivar_unregister(struct efivar_entry *var)
1474{
1475 kobject_put(&var->kobj);
1476}
1477
e14ab23d 1478int efivars_register(struct efivars *efivars,
4fc756bd 1479 const struct efivar_operations *ops,
e14ab23d
MF
1480 struct kobject *kobject);
1481int efivars_unregister(struct efivars *efivars);
1482struct kobject *efivars_kobject(void);
1483
1484int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1cfd6316 1485 void *data, bool duplicates, struct list_head *head);
e14ab23d 1486
21b3ddd3
SC
1487int efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1488int efivar_entry_remove(struct efivar_entry *entry);
e14ab23d
MF
1489
1490int __efivar_entry_delete(struct efivar_entry *entry);
1491int efivar_entry_delete(struct efivar_entry *entry);
1492
e14ab23d 1493int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
8a415b8c
MF
1494int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1495 unsigned long *size, void *data);
e14ab23d
MF
1496int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1497 unsigned long *size, void *data);
1498int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1499 unsigned long size, void *data, struct list_head *head);
1500int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1501 unsigned long *size, void *data, bool *set);
1502int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1503 bool block, unsigned long size, void *data);
1504
21b3ddd3 1505int efivar_entry_iter_begin(void);
e14ab23d
MF
1506void efivar_entry_iter_end(void);
1507
1508int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1509 struct list_head *head, void *data,
1510 struct efivar_entry **prev);
1511int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1512 struct list_head *head, void *data);
1513
1514struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1515 struct list_head *head, bool remove);
1516
8282f5d9
PJ
1517bool efivar_validate(efi_guid_t vendor, efi_char16_t *var_name, u8 *data,
1518 unsigned long data_size);
ed8b0de5
PJ
1519bool efivar_variable_is_removable(efi_guid_t vendor, const char *name,
1520 size_t len);
e14ab23d 1521
a9499fa7 1522extern struct work_struct efivar_work;
04851772
MF
1523void efivar_run_worker(void);
1524
a9499fa7 1525#if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
e14ab23d 1526int efivars_sysfs_init(void);
4fc756bd 1527
e0d59733
SA
1528#define EFIVARS_DATA_SIZE_MAX 1024
1529
4fc756bd 1530#endif /* CONFIG_EFI_VARS */
f0133f3c
MF
1531extern bool efi_capsule_pending(int *reset_type);
1532
1533extern int efi_capsule_supported(efi_guid_t guid, u32 flags,
1534 size_t size, int *reset);
1535
1536extern int efi_capsule_update(efi_capsule_header_t *capsule,
2a457fb3 1537 phys_addr_t *pages);
4fc756bd 1538
926172d4
DY
1539#ifdef CONFIG_EFI_RUNTIME_MAP
1540int efi_runtime_map_init(struct kobject *);
6a2c20e7
VG
1541int efi_get_runtime_map_size(void);
1542int efi_get_runtime_map_desc_size(void);
1543int efi_runtime_map_copy(void *buf, size_t bufsz);
926172d4
DY
1544#else
1545static inline int efi_runtime_map_init(struct kobject *kobj)
1546{
1547 return 0;
1548}
1549
6a2c20e7
VG
1550static inline int efi_get_runtime_map_size(void)
1551{
1552 return 0;
1553}
1554
1555static inline int efi_get_runtime_map_desc_size(void)
1556{
1557 return 0;
1558}
1559
1560static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1561{
1562 return 0;
1563}
1564
926172d4
DY
1565#endif
1566
bd669475
AB
1567/* prototypes shared between arch specific and generic stub code */
1568
bd669475
AB
1569void efi_printk(efi_system_table_t *sys_table_arg, char *str);
1570
1571void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
1572 unsigned long addr);
1573
1574char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
1575 efi_loaded_image_t *image, int *cmd_line_len);
1576
1577efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
dadb57ab 1578 struct efi_boot_memmap *map);
bd669475
AB
1579
1580efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
1581 unsigned long size, unsigned long align,
1582 unsigned long *addr);
1583
1584efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
1585 unsigned long size, unsigned long align,
1586 unsigned long *addr, unsigned long max);
1587
1588efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
1589 unsigned long *image_addr,
1590 unsigned long image_size,
1591 unsigned long alloc_size,
1592 unsigned long preferred_addr,
1593 unsigned long alignment);
1594
1595efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
1596 efi_loaded_image_t *image,
1597 char *cmd_line, char *option_string,
1598 unsigned long max_addr,
1599 unsigned long *load_addr,
1600 unsigned long *load_size);
1601
60f38de7 1602efi_status_t efi_parse_options(char const *cmdline);
5a17dae4 1603
2c23b73c
AB
1604efi_status_t efi_setup_gop(efi_system_table_t *sys_table_arg,
1605 struct screen_info *si, efi_guid_t *proto,
1606 unsigned long size);
1607
b2e0a54a 1608bool efi_runtime_disabled(void);
80e75596
AT
1609extern void efi_call_virt_check_flags(unsigned long flags, const char *call);
1610
de8cb458
DH
1611enum efi_secureboot_mode {
1612 efi_secureboot_mode_unset,
1613 efi_secureboot_mode_unknown,
1614 efi_secureboot_mode_disabled,
1615 efi_secureboot_mode_enabled,
1616};
1617enum efi_secureboot_mode efi_get_secureboot(efi_system_table_t *sys_table);
1618
ccc829ba
MG
1619#ifdef CONFIG_RESET_ATTACK_MITIGATION
1620void efi_enable_reset_attack_mitigation(efi_system_table_t *sys_table_arg);
1621#else
1622static inline void
1623efi_enable_reset_attack_mitigation(efi_system_table_t *sys_table_arg) { }
1624#endif
1625
33b6d034
TW
1626void efi_retrieve_tpm2_eventlog(efi_system_table_t *sys_table);
1627
80e75596
AT
1628/*
1629 * Arch code can implement the following three template macros, avoiding
1630 * reptition for the void/non-void return cases of {__,}efi_call_virt():
1631 *
1632 * * arch_efi_call_virt_setup()
1633 *
1634 * Sets up the environment for the call (e.g. switching page tables,
1635 * allowing kernel-mode use of floating point, if required).
1636 *
1637 * * arch_efi_call_virt()
1638 *
1639 * Performs the call. The last expression in the macro must be the call
1640 * itself, allowing the logic to be shared by the void and non-void
1641 * cases.
1642 *
1643 * * arch_efi_call_virt_teardown()
1644 *
1645 * Restores the usual kernel environment once the call has returned.
1646 */
1647
1648#define efi_call_virt_pointer(p, f, args...) \
1649({ \
1650 efi_status_t __s; \
1651 unsigned long __flags; \
1652 \
1653 arch_efi_call_virt_setup(); \
1654 \
1655 local_save_flags(__flags); \
1656 __s = arch_efi_call_virt(p, f, args); \
1657 efi_call_virt_check_flags(__flags, __stringify(f)); \
1658 \
1659 arch_efi_call_virt_teardown(); \
1660 \
1661 __s; \
1662})
1663
1664#define __efi_call_virt_pointer(p, f, args...) \
1665({ \
1666 unsigned long __flags; \
1667 \
1668 arch_efi_call_virt_setup(); \
1669 \
1670 local_save_flags(__flags); \
1671 arch_efi_call_virt(p, f, args); \
1672 efi_call_virt_check_flags(__flags, __stringify(f)); \
1673 \
1674 arch_efi_call_virt_teardown(); \
1675})
1676
fc07716b
JH
1677typedef efi_status_t (*efi_exit_boot_map_processing)(
1678 efi_system_table_t *sys_table_arg,
1679 struct efi_boot_memmap *map,
1680 void *priv);
1681
1682efi_status_t efi_exit_boot_services(efi_system_table_t *sys_table,
1683 void *handle,
1684 struct efi_boot_memmap *map,
1685 void *priv,
1686 efi_exit_boot_map_processing priv_func);
63625988 1687
c2ceb5fd
AB
1688#define EFI_RANDOM_SEED_SIZE 64U
1689
63625988
AB
1690struct linux_efi_random_seed {
1691 u32 size;
1692 u8 bits[];
1693};
1694
33b6d034
TW
1695struct linux_efi_tpm_eventlog {
1696 u32 size;
1697 u8 version;
1698 u8 log[];
1699};
1700
1701extern int efi_tpm_eventlog_init(void);
1702
3425d934
SP
1703/*
1704 * efi_runtime_service() function identifiers.
1705 * "NONE" is used by efi_recover_from_page_fault() to check if the page
1706 * fault happened while executing an efi runtime service.
1707 */
9dbbedaa 1708enum efi_rts_ids {
3425d934 1709 NONE,
9dbbedaa
SP
1710 GET_TIME,
1711 SET_TIME,
1712 GET_WAKEUP_TIME,
1713 SET_WAKEUP_TIME,
1714 GET_VARIABLE,
1715 GET_NEXT_VARIABLE,
1716 SET_VARIABLE,
1717 QUERY_VARIABLE_INFO,
1718 GET_NEXT_HIGH_MONO_COUNT,
3425d934 1719 RESET_SYSTEM,
9dbbedaa
SP
1720 UPDATE_CAPSULE,
1721 QUERY_CAPSULE_CAPS,
1722};
1723
1724/*
1725 * efi_runtime_work: Details of EFI Runtime Service work
1726 * @arg<1-5>: EFI Runtime Service function arguments
1727 * @status: Status of executing EFI Runtime Service
1728 * @efi_rts_id: EFI Runtime Service function identifier
1729 * @efi_rts_comp: Struct used for handling completions
1730 */
1731struct efi_runtime_work {
1732 void *arg1;
1733 void *arg2;
1734 void *arg3;
1735 void *arg4;
1736 void *arg5;
1737 efi_status_t status;
1738 struct work_struct work;
1739 enum efi_rts_ids efi_rts_id;
1740 struct completion efi_rts_comp;
1741};
1742
1743extern struct efi_runtime_work efi_rts_work;
1744
3eb420e7
SP
1745/* Workqueue to queue EFI Runtime Services */
1746extern struct workqueue_struct *efi_rts_wq;
1747
71e0940d 1748struct linux_efi_memreserve {
5f0b0ecf
AB
1749 int size; // allocated size of the array
1750 atomic_t count; // number of entries used
1751 phys_addr_t next; // pa of next struct instance
1752 struct {
1753 phys_addr_t base;
1754 phys_addr_t size;
1755 } entry[0];
71e0940d
AB
1756};
1757
5f0b0ecf
AB
1758#define EFI_MEMRESERVE_SIZE(count) (sizeof(struct linux_efi_memreserve) + \
1759 (count) * sizeof(((struct linux_efi_memreserve *)0)->entry[0]))
1760
80424b02
AB
1761#define EFI_MEMRESERVE_COUNT(size) (((size) - sizeof(struct linux_efi_memreserve)) \
1762 / sizeof(((struct linux_efi_memreserve *)0)->entry[0]))
1763
1da177e4 1764#endif /* _LINUX_EFI_H */