projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
efi: Refactor efi_memmap_init_early() into arch-neutral code
[linux-block.git] / include / linux / efi.h
CommitLineData
1da177e4
LT		 1#ifndef _LINUX_EFI_H
2#define _LINUX_EFI_H
3
4/*
5 * Extensible Firmware Interface
6 * Based on 'Extensible Firmware Interface Specification' version 0.9, April 30, 1999
7 *
8 * Copyright (C) 1999 VA Linux Systems
9 * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
10 * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
11 * David Mosberger-Tang <davidm@hpl.hp.com>
12 * Stephane Eranian <eranian@hpl.hp.com>
13 */
14#include <linux/init.h>
15#include <linux/string.h>
16#include <linux/time.h>
17#include <linux/types.h>
18#include <linux/proc_fs.h>
19#include <linux/rtc.h>
20#include <linux/ioport.h>
4a3575fd 21#include <linux/pfn.h>
5ee9c198 22#include <linux/pstore.h>
8562c99c 23#include <linux/reboot.h>
ba7e34b1 24#include <linux/uuid.h>
2c23b73c 25#include <linux/screen_info.h>
1da177e4
LT		 26
27#include <asm/page.h>
1da177e4
LT		 28
29#define EFI_SUCCESS 0
30#define EFI_LOAD_ERROR ( 1 | (1UL << (BITS_PER_LONG-1)))
31#define EFI_INVALID_PARAMETER ( 2 | (1UL << (BITS_PER_LONG-1)))
32#define EFI_UNSUPPORTED ( 3 | (1UL << (BITS_PER_LONG-1)))
33#define EFI_BAD_BUFFER_SIZE ( 4 | (1UL << (BITS_PER_LONG-1)))
34#define EFI_BUFFER_TOO_SMALL ( 5 | (1UL << (BITS_PER_LONG-1)))
5d9db883
MG		 35#define EFI_NOT_READY ( 6 | (1UL << (BITS_PER_LONG-1)))
36#define EFI_DEVICE_ERROR ( 7 | (1UL << (BITS_PER_LONG-1)))
37#define EFI_WRITE_PROTECTED ( 8 | (1UL << (BITS_PER_LONG-1)))
38#define EFI_OUT_OF_RESOURCES ( 9 | (1UL << (BITS_PER_LONG-1)))
1da177e4 39#define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
5d9db883 40#define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1)))
1da177e4
LT		 41
42typedef unsigned long efi_status_t;
43typedef u8 efi_bool_t;
44typedef u16 efi_char16_t; /* UNICODE character */
ed37ddff
RF		 45typedef u64 efi_physical_addr_t;
46typedef void *efi_handle_t;
1da177e4 47
ba7e34b1 48typedef uuid_le efi_guid_t;
1da177e4
LT		 49
50#define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
ba7e34b1 51 UUID_LE(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7)
1da177e4
LT		 52
53/*
54 * Generic EFI table header
55 */
56typedef struct {
57 u64 signature;
58 u32 revision;
59 u32 headersize;
60 u32 crc32;
61 u32 reserved;
62} efi_table_hdr_t;
63
64/*
65 * Memory map descriptor:
66 */
67
68/* Memory types: */
69#define EFI_RESERVED_TYPE 0
70#define EFI_LOADER_CODE 1
71#define EFI_LOADER_DATA 2
72#define EFI_BOOT_SERVICES_CODE 3
73#define EFI_BOOT_SERVICES_DATA 4
74#define EFI_RUNTIME_SERVICES_CODE 5
75#define EFI_RUNTIME_SERVICES_DATA 6
76#define EFI_CONVENTIONAL_MEMORY 7
77#define EFI_UNUSABLE_MEMORY 8
78#define EFI_ACPI_RECLAIM_MEMORY 9
79#define EFI_ACPI_MEMORY_NVS 10
80#define EFI_MEMORY_MAPPED_IO 11
81#define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
82#define EFI_PAL_CODE 13
ad5fb870
DW		 83#define EFI_PERSISTENT_MEMORY 14
84#define EFI_MAX_MEMORY_TYPE 15
1da177e4
LT		 85
86/* Attribute values: */
87#define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
88#define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
89#define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
90#define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
9c97e0bd 91#define EFI_MEMORY_UCE ((u64)0x0000000000000010ULL) /* uncached, exported */
1da177e4
LT		 92#define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
93#define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
94#define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
c016ca08 95#define EFI_MEMORY_NV ((u64)0x0000000000008000ULL) /* non-volatile */
b05b9f5f
TL		 96#define EFI_MEMORY_MORE_RELIABLE \
97 ((u64)0x0000000000010000ULL) /* higher reliability */
87db73ae 98#define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */
1da177e4
LT		 99#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
100#define EFI_MEMORY_DESCRIPTOR_VERSION 1
101
102#define EFI_PAGE_SHIFT 12
ed37ddff 103#define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
1da177e4 104
1da177e4
LT		 105typedef struct {
106 u32 type;
107 u32 pad;
108 u64 phys_addr;
109 u64 virt_addr;
110 u64 num_pages;
111 u64 attribute;
1da177e4
LT		 112} efi_memory_desc_t;
113
3b370237
MG		 114typedef struct {
115 efi_guid_t guid;
116 u32 headersize;
117 u32 flags;
118 u32 imagesize;
119} efi_capsule_header_t;
120
f0133f3c
MF		 121/*
122 * EFI capsule flags
123 */
124#define EFI_CAPSULE_PERSIST_ACROSS_RESET 0x00010000
125#define EFI_CAPSULE_POPULATE_SYSTEM_TABLE 0x00020000
126#define EFI_CAPSULE_INITIATE_RESET 0x00040000
127
bb05e4ba
MF		 128/*
129 * Allocation types for calls to boottime->allocate_pages.
130 */
131#define EFI_ALLOCATE_ANY_PAGES 0
132#define EFI_ALLOCATE_MAX_ADDRESS 1
133#define EFI_ALLOCATE_ADDRESS 2
134#define EFI_MAX_ALLOCATE_TYPE 3
135
e088a4ad 136typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
1da177e4
LT		 137
138/*
139 * Types and defines for Time Services
140 */
141#define EFI_TIME_ADJUST_DAYLIGHT 0x1
142#define EFI_TIME_IN_DAYLIGHT 0x2
143#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
144
145typedef struct {
146 u16 year;
147 u8 month;
148 u8 day;
149 u8 hour;
150 u8 minute;
151 u8 second;
152 u8 pad1;
153 u32 nanosecond;
154 s16 timezone;
155 u8 daylight;
156 u8 pad2;
157} efi_time_t;
158
159typedef struct {
160 u32 resolution;
161 u32 accuracy;
162 u8 sets_to_zero;
163} efi_time_cap_t;
164
677703ce
MF		 165typedef struct {
166 efi_table_hdr_t hdr;
167 u32 raise_tpl;
168 u32 restore_tpl;
169 u32 allocate_pages;
170 u32 free_pages;
171 u32 get_memory_map;
172 u32 allocate_pool;
173 u32 free_pool;
174 u32 create_event;
175 u32 set_timer;
176 u32 wait_for_event;
177 u32 signal_event;
178 u32 close_event;
179 u32 check_event;
180 u32 install_protocol_interface;
181 u32 reinstall_protocol_interface;
182 u32 uninstall_protocol_interface;
183 u32 handle_protocol;
184 u32 __reserved;
185 u32 register_protocol_notify;
186 u32 locate_handle;
187 u32 locate_device_path;
188 u32 install_configuration_table;
189 u32 load_image;
190 u32 start_image;
191 u32 exit;
192 u32 unload_image;
193 u32 exit_boot_services;
194 u32 get_next_monotonic_count;
195 u32 stall;
196 u32 set_watchdog_timer;
197 u32 connect_controller;
198 u32 disconnect_controller;
199 u32 open_protocol;
200 u32 close_protocol;
201 u32 open_protocol_information;
202 u32 protocols_per_handle;
203 u32 locate_handle_buffer;
204 u32 locate_protocol;
205 u32 install_multiple_protocol_interfaces;
206 u32 uninstall_multiple_protocol_interfaces;
207 u32 calculate_crc32;
208 u32 copy_mem;
209 u32 set_mem;
210 u32 create_event_ex;
211} __packed efi_boot_services_32_t;
212
213typedef struct {
214 efi_table_hdr_t hdr;
215 u64 raise_tpl;
216 u64 restore_tpl;
217 u64 allocate_pages;
218 u64 free_pages;
219 u64 get_memory_map;
220 u64 allocate_pool;
221 u64 free_pool;
222 u64 create_event;
223 u64 set_timer;
224 u64 wait_for_event;
225 u64 signal_event;
226 u64 close_event;
227 u64 check_event;
228 u64 install_protocol_interface;
229 u64 reinstall_protocol_interface;
230 u64 uninstall_protocol_interface;
231 u64 handle_protocol;
232 u64 __reserved;
233 u64 register_protocol_notify;
234 u64 locate_handle;
235 u64 locate_device_path;
236 u64 install_configuration_table;
237 u64 load_image;
238 u64 start_image;
239 u64 exit;
240 u64 unload_image;
241 u64 exit_boot_services;
242 u64 get_next_monotonic_count;
243 u64 stall;
244 u64 set_watchdog_timer;
245 u64 connect_controller;
246 u64 disconnect_controller;
247 u64 open_protocol;
248 u64 close_protocol;
249 u64 open_protocol_information;
250 u64 protocols_per_handle;
251 u64 locate_handle_buffer;
252 u64 locate_protocol;
253 u64 install_multiple_protocol_interfaces;
254 u64 uninstall_multiple_protocol_interfaces;
255 u64 calculate_crc32;
256 u64 copy_mem;
257 u64 set_mem;
258 u64 create_event_ex;
259} __packed efi_boot_services_64_t;
260
f30ca6ba
MF		 261/*
262 * EFI Boot Services table
263 */
264typedef struct {
265 efi_table_hdr_t hdr;
266 void *raise_tpl;
267 void *restore_tpl;
ed37ddff
RF		 268 efi_status_t (*allocate_pages)(int, int, unsigned long,
269 efi_physical_addr_t *);
270 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
271 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
272 unsigned long *, u32 *);
273 efi_status_t (*allocate_pool)(int, unsigned long, void **);
274 efi_status_t (*free_pool)(void *);
f30ca6ba
MF		 275 void *create_event;
276 void *set_timer;
277 void *wait_for_event;
278 void *signal_event;
279 void *close_event;
280 void *check_event;
281 void *install_protocol_interface;
282 void *reinstall_protocol_interface;
283 void *uninstall_protocol_interface;
ed37ddff 284 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
f30ca6ba
MF		 285 void *__reserved;
286 void *register_protocol_notify;
fc372064
AB		 287 efi_status_t (*locate_handle)(int, efi_guid_t *, void *,
288 unsigned long *, efi_handle_t *);
f30ca6ba 289 void *locate_device_path;
801820be 290 efi_status_t (*install_configuration_table)(efi_guid_t *, void *);
f30ca6ba
MF		 291 void *load_image;
292 void *start_image;
293 void *exit;
294 void *unload_image;
ed37ddff 295 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
f30ca6ba
MF		 296 void *get_next_monotonic_count;
297 void *stall;
298 void *set_watchdog_timer;
299 void *connect_controller;
300 void *disconnect_controller;
301 void *open_protocol;
302 void *close_protocol;
303 void *open_protocol_information;
304 void *protocols_per_handle;
305 void *locate_handle_buffer;
e4fbf476 306 efi_status_t (*locate_protocol)(efi_guid_t *, void *, void **);
f30ca6ba
MF		 307 void *install_multiple_protocol_interfaces;
308 void *uninstall_multiple_protocol_interfaces;
309 void *calculate_crc32;
310 void *copy_mem;
311 void *set_mem;
312 void *create_event_ex;
313} efi_boot_services_t;
314
dd5fc854
MG		 315typedef enum {
316 EfiPciIoWidthUint8,
317 EfiPciIoWidthUint16,
318 EfiPciIoWidthUint32,
319 EfiPciIoWidthUint64,
320 EfiPciIoWidthFifoUint8,
321 EfiPciIoWidthFifoUint16,
322 EfiPciIoWidthFifoUint32,
323 EfiPciIoWidthFifoUint64,
324 EfiPciIoWidthFillUint8,
325 EfiPciIoWidthFillUint16,
326 EfiPciIoWidthFillUint32,
327 EfiPciIoWidthFillUint64,
328 EfiPciIoWidthMaximum
329} EFI_PCI_IO_PROTOCOL_WIDTH;
330
331typedef enum {
332 EfiPciIoAttributeOperationGet,
333 EfiPciIoAttributeOperationSet,
334 EfiPciIoAttributeOperationEnable,
335 EfiPciIoAttributeOperationDisable,
336 EfiPciIoAttributeOperationSupported,
337 EfiPciIoAttributeOperationMaximum
338} EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
339
677703ce
MF		 340typedef struct {
341 u32 read;
342 u32 write;
343} efi_pci_io_protocol_access_32_t;
344
345typedef struct {
346 u64 read;
347 u64 write;
348} efi_pci_io_protocol_access_64_t;
dd5fc854
MG		 349
350typedef struct {
351 void *read;
352 void *write;
353} efi_pci_io_protocol_access_t;
354
677703ce
MF		 355typedef struct {
356 u32 poll_mem;
357 u32 poll_io;
358 efi_pci_io_protocol_access_32_t mem;
359 efi_pci_io_protocol_access_32_t io;
360 efi_pci_io_protocol_access_32_t pci;
361 u32 copy_mem;
362 u32 map;
363 u32 unmap;
364 u32 allocate_buffer;
365 u32 free_buffer;
366 u32 flush;
367 u32 get_location;
368 u32 attributes;
369 u32 get_bar_attributes;
370 u32 set_bar_attributes;
371 uint64_t romsize;
372 void *romimage;
373} efi_pci_io_protocol_32;
374
375typedef struct {
376 u64 poll_mem;
377 u64 poll_io;
378 efi_pci_io_protocol_access_64_t mem;
379 efi_pci_io_protocol_access_64_t io;
380 efi_pci_io_protocol_access_64_t pci;
381 u64 copy_mem;
382 u64 map;
383 u64 unmap;
384 u64 allocate_buffer;
385 u64 free_buffer;
386 u64 flush;
387 u64 get_location;
388 u64 attributes;
389 u64 get_bar_attributes;
390 u64 set_bar_attributes;
391 uint64_t romsize;
392 void *romimage;
393} efi_pci_io_protocol_64;
394
dd5fc854
MG		 395typedef struct {
396 void *poll_mem;
397 void *poll_io;
398 efi_pci_io_protocol_access_t mem;
399 efi_pci_io_protocol_access_t io;
400 efi_pci_io_protocol_access_t pci;
401 void *copy_mem;
402 void *map;
403 void *unmap;
404 void *allocate_buffer;
405 void *free_buffer;
406 void *flush;
407 void *get_location;
408 void *attributes;
409 void *get_bar_attributes;
410 void *set_bar_attributes;
411 uint64_t romsize;
412 void *romimage;
413} efi_pci_io_protocol;
414
415#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
416#define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
417#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
418#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
419#define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
420#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
421#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
422#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
423#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
424#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
425#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
426#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
427#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
428#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
429#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
430#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
431#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
432#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
433#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
434
1da177e4
LT		 435/*
436 * Types and defines for EFI ResetSystem
437 */
438#define EFI_RESET_COLD 0
439#define EFI_RESET_WARM 1
440#define EFI_RESET_SHUTDOWN 2
441
442/*
443 * EFI Runtime Services table
444 */
445#define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
446#define EFI_RUNTIME_SERVICES_REVISION 0x00010000
447
677703ce
MF		 448typedef struct {
449 efi_table_hdr_t hdr;
450 u32 get_time;
451 u32 set_time;
452 u32 get_wakeup_time;
453 u32 set_wakeup_time;
454 u32 set_virtual_address_map;
455 u32 convert_pointer;
456 u32 get_variable;
457 u32 get_next_variable;
458 u32 set_variable;
459 u32 get_next_high_mono_count;
460 u32 reset_system;
461 u32 update_capsule;
462 u32 query_capsule_caps;
463 u32 query_variable_info;
464} efi_runtime_services_32_t;
465
466typedef struct {
467 efi_table_hdr_t hdr;
468 u64 get_time;
469 u64 set_time;
470 u64 get_wakeup_time;
471 u64 set_wakeup_time;
472 u64 set_virtual_address_map;
473 u64 convert_pointer;
474 u64 get_variable;
475 u64 get_next_variable;
476 u64 set_variable;
477 u64 get_next_high_mono_count;
478 u64 reset_system;
479 u64 update_capsule;
480 u64 query_capsule_caps;
481 u64 query_variable_info;
482} efi_runtime_services_64_t;
483
1da177e4
LT		 484typedef struct {
485 efi_table_hdr_t hdr;
43ab0476
BP		 486 void *get_time;
487 void *set_time;
488 void *get_wakeup_time;
489 void *set_wakeup_time;
490 void *set_virtual_address_map;
491 void *convert_pointer;
492 void *get_variable;
493 void *get_next_variable;
494 void *set_variable;
495 void *get_next_high_mono_count;
496 void *reset_system;
497 void *update_capsule;
498 void *query_capsule_caps;
499 void *query_variable_info;
1da177e4
LT		 500} efi_runtime_services_t;
501
502typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
503typedef efi_status_t efi_set_time_t (efi_time_t *tm);
504typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
505 efi_time_t *tm);
506typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
507typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
508 unsigned long *data_size, void *data);
509typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
510 efi_guid_t *vendor);
511typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
f7a2d73f 512 u32 attr, unsigned long data_size,
1da177e4
LT		 513 void *data);
514typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
515typedef void efi_reset_system_t (int reset_type, efi_status_t status,
516 unsigned long data_size, efi_char16_t *data);
517typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
518 unsigned long descriptor_size,
519 u32 descriptor_version,
520 efi_memory_desc_t *virtual_map);
3b370237
MG		 521typedef efi_status_t efi_query_variable_info_t(u32 attr,
522 u64 *storage_space,
523 u64 *remaining_space,
524 u64 *max_variable_size);
525typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
526 unsigned long count,
527 unsigned long sg_list);
528typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
529 unsigned long count,
530 u64 *max_size,
531 int *reset_type);
ca0e30dc
AB		 532typedef efi_status_t efi_query_variable_store_t(u32 attributes,
533 unsigned long size,
534 bool nonblocking);
1da177e4 535
022ee6c5
AB		 536void efi_native_runtime_setup(void);
537
1da177e4 538/*
54fd11fe
PJ		 539 * EFI Configuration Table and GUID definitions
540 *
7fb2b43c
IM		 541 * These are all defined in a single line to make them easier to
542 * grep for and to see them at a glance - while still having a
543 * similar structure to the definitions in the spec.
544 *
545 * Here's how they are structured:
54fd11fe
PJ		 546 *
547 * GUID: 12345678-1234-1234-1234-123456789012
548 * Spec:
549 * #define EFI_SOME_PROTOCOL_GUID \
550 * {0x12345678,0x1234,0x1234,\
551 * {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}}
552 * Here:
7fb2b43c
IM		 553 * #define SOME_PROTOCOL_GUID EFI_GUID(0x12345678, 0x1234, 0x1234, 0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12)
554 * ^ tabs ^extra space
555 *
556 * Note that the 'extra space' separates the values at the same place
557 * where the UEFI SPEC breaks the line.
1da177e4 558 */
7fb2b43c
IM		 559#define NULL_GUID EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
560#define MPS_TABLE_GUID EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
561#define ACPI_TABLE_GUID EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
562#define ACPI_20_TABLE_GUID EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
563#define SMBIOS_TABLE_GUID EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
564#define SMBIOS3_TABLE_GUID EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94)
565#define SAL_SYSTEM_TABLE_GUID EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
566#define HCDP_TABLE_GUID EFI_GUID(0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98)
567#define UGA_IO_PROTOCOL_GUID EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0x0b, 0x07, 0xa2)
568#define EFI_GLOBAL_VARIABLE_GUID EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
569#define UV_SYSTEM_TABLE_GUID EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93)
570#define LINUX_EFI_CRASH_GUID EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0)
571#define LOADED_IMAGE_PROTOCOL_GUID EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
572#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
573#define EFI_UGA_PROTOCOL_GUID EFI_GUID(0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39)
574#define EFI_PCI_IO_PROTOCOL_GUID EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
575#define EFI_FILE_INFO_ID EFI_GUID(0x09576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
576#define EFI_SYSTEM_RESOURCE_TABLE_GUID EFI_GUID(0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
577#define EFI_FILE_SYSTEM_GUID EFI_GUID(0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
578#define DEVICE_TREE_GUID EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
579#define EFI_PROPERTIES_TABLE_GUID EFI_GUID(0x880aaca3, 0x4adc, 0x4a04, 0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5)
580#define EFI_RNG_PROTOCOL_GUID EFI_GUID(0x3152bca5, 0xeade, 0x433d, 0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
581#define EFI_MEMORY_ATTRIBUTES_TABLE_GUID EFI_GUID(0xdcfa911d, 0x26eb, 0x469f, 0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
582#define EFI_CONSOLE_OUT_DEVICE_GUID EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4, 0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
fc372064 583
801820be
AB		 584/*
585 * This GUID is used to pass to the kernel proper the struct screen_info
586 * structure that was populated by the stub based on the GOP protocol instance
587 * associated with ConOut
588 */
7fb2b43c
IM		 589#define LINUX_EFI_ARM_SCREEN_INFO_TABLE_GUID EFI_GUID(0xe03fc20a, 0x85dc, 0x406e, 0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95)
590#define LINUX_EFI_LOADER_ENTRY_GUID EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf, 0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)
06f7d4a1 591
1adbfa35
OJ		 592typedef struct {
593 efi_guid_t guid;
594 u64 table;
595} efi_config_table_64_t;
596
597typedef struct {
598 efi_guid_t guid;
599 u32 table;
600} efi_config_table_32_t;
601
1da177e4
LT		 602typedef struct {
603 efi_guid_t guid;
604 unsigned long table;
605} efi_config_table_t;
606
272686bf
LL		 607typedef struct {
608 efi_guid_t guid;
609 const char *name;
610 unsigned long *ptr;
611} efi_config_table_type_t;
612
1da177e4 613#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
1da177e4 614
3b370237
MG		 615#define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
616#define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
617#define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
618#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
619#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
620#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
621
1adbfa35
OJ		 622typedef struct {
623 efi_table_hdr_t hdr;
624 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
625 u32 fw_revision;
626 u32 __pad1;
627 u64 con_in_handle;
628 u64 con_in;
629 u64 con_out_handle;
630 u64 con_out;
631 u64 stderr_handle;
632 u64 stderr;
633 u64 runtime;
634 u64 boottime;
635 u32 nr_tables;
636 u32 __pad2;
637 u64 tables;
638} efi_system_table_64_t;
639
640typedef struct {
641 efi_table_hdr_t hdr;
642 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
643 u32 fw_revision;
644 u32 con_in_handle;
645 u32 con_in;
646 u32 con_out_handle;
647 u32 con_out;
648 u32 stderr_handle;
649 u32 stderr;
650 u32 runtime;
651 u32 boottime;
652 u32 nr_tables;
653 u32 tables;
654} efi_system_table_32_t;
655
1da177e4
LT		 656typedef struct {
657 efi_table_hdr_t hdr;
658 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
659 u32 fw_revision;
660 unsigned long con_in_handle;
661 unsigned long con_in;
662 unsigned long con_out_handle;
663 unsigned long con_out;
664 unsigned long stderr_handle;
665 unsigned long stderr;
666 efi_runtime_services_t *runtime;
f30ca6ba 667 efi_boot_services_t *boottime;
1da177e4
LT		 668 unsigned long nr_tables;
669 unsigned long tables;
670} efi_system_table_t;
671
9479c7ce
MF		 672/*
673 * Architecture independent structure for describing a memory map for the
674 * benefit of efi_memmap_init_early(), saving us the need to pass four
675 * parameters.
676 */
677struct efi_memory_map_data {
678 phys_addr_t phys_map;
679 unsigned long size;
680 unsigned long desc_version;
681 unsigned long desc_size;
682};
683
1da177e4 684struct efi_memory_map {
44511fb9 685 phys_addr_t phys_map;
7ae65fd3
MT		 686 void *map;
687 void *map_end;
1da177e4
LT		 688 int nr_map;
689 unsigned long desc_version;
7ae65fd3 690 unsigned long desc_size;
1da177e4
LT		 691};
692
0302f71c
MS		 693struct efi_fdt_params {
694 u64 system_table;
695 u64 mmap;
696 u32 mmap_size;
697 u32 desc_size;
698 u32 desc_ver;
699};
700
677703ce
MF		 701typedef struct {
702 u32 revision;
703 u32 parent_handle;
704 u32 system_table;
705 u32 device_handle;
706 u32 file_path;
707 u32 reserved;
708 u32 load_options_size;
709 u32 load_options;
710 u32 image_base;
711 __aligned_u64 image_size;
712 unsigned int image_code_type;
713 unsigned int image_data_type;
714 unsigned long unload;
715} efi_loaded_image_32_t;
716
717typedef struct {
718 u32 revision;
719 u64 parent_handle;
720 u64 system_table;
721 u64 device_handle;
722 u64 file_path;
723 u64 reserved;
724 u32 load_options_size;
725 u64 load_options;
726 u64 image_base;
727 __aligned_u64 image_size;
728 unsigned int image_code_type;
729 unsigned int image_data_type;
730 unsigned long unload;
731} efi_loaded_image_64_t;
732
8e84f345
MF		 733typedef struct {
734 u32 revision;
735 void *parent_handle;
736 efi_system_table_t *system_table;
737 void *device_handle;
738 void *file_path;
739 void *reserved;
740 u32 load_options_size;
741 void *load_options;
742 void *image_base;
743 __aligned_u64 image_size;
744 unsigned int image_code_type;
745 unsigned int image_data_type;
746 unsigned long unload;
747} efi_loaded_image_t;
748
55839d51
MF		 749
750typedef struct {
751 u64 size;
752 u64 file_size;
753 u64 phys_size;
754 efi_time_t create_time;
755 efi_time_t last_access_time;
756 efi_time_t modification_time;
757 __aligned_u64 attribute;
758 efi_char16_t filename[1];
759} efi_file_info_t;
760
677703ce
MF		 761typedef struct {
762 u64 revision;
763 u32 open;
764 u32 close;
765 u32 delete;
766 u32 read;
767 u32 write;
768 u32 get_position;
769 u32 set_position;
770 u32 get_info;
771 u32 set_info;
772 u32 flush;
773} efi_file_handle_32_t;
774
775typedef struct {
776 u64 revision;
777 u64 open;
778 u64 close;
779 u64 delete;
780 u64 read;
781 u64 write;
782 u64 get_position;
783 u64 set_position;
784 u64 get_info;
785 u64 set_info;
786 u64 flush;
787} efi_file_handle_64_t;
788
ed37ddff 789typedef struct _efi_file_handle {
55839d51 790 u64 revision;
ed37ddff
RF		 791 efi_status_t (*open)(struct _efi_file_handle *,
792 struct _efi_file_handle **,
793 efi_char16_t *, u64, u64);
794 efi_status_t (*close)(struct _efi_file_handle *);
55839d51 795 void *delete;
ed37ddff
RF		 796 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
797 void *);
55839d51
MF		 798 void *write;
799 void *get_position;
800 void *set_position;
ed37ddff
RF		 801 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
802 unsigned long *, void *);
55839d51
MF		 803 void *set_info;
804 void *flush;
805} efi_file_handle_t;
806
ed37ddff
RF		 807typedef struct _efi_file_io_interface {
808 u64 revision;
809 int (*open_volume)(struct _efi_file_io_interface *,
810 efi_file_handle_t **);
811} efi_file_io_interface_t;
812
55839d51
MF		 813#define EFI_FILE_MODE_READ 0x0000000000000001
814#define EFI_FILE_MODE_WRITE 0x0000000000000002
815#define EFI_FILE_MODE_CREATE 0x8000000000000000
816
bf924863
AB		 817typedef struct {
818 u32 version;
819 u32 length;
820 u64 memory_protection_attribute;
821} efi_properties_table_t;
822
823#define EFI_PROPERTIES_TABLE_VERSION 0x00010000
824#define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1
825
b2c99e3c
BH		 826#define EFI_INVALID_TABLE_ADDR (~0UL)
827
a604af07
AB		 828typedef struct {
829 u32 version;
830 u32 num_entries;
831 u32 desc_size;
832 u32 reserved;
833 efi_memory_desc_t entry[0];
834} efi_memory_attributes_table_t;
835
1da177e4
LT		 836/*
837 * All runtime access to EFI goes through this structure:
838 */
839extern struct efi {
840 efi_system_table_t *systab; /* EFI system table */
3b370237 841 unsigned int runtime_version; /* Runtime services version */
b2c99e3c
BH		 842 unsigned long mps; /* MPS table */
843 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
844 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
e1ccbbc9
AB		 845 unsigned long smbios; /* SMBIOS table (32 bit entry point) */
846 unsigned long smbios3; /* SMBIOS table (64 bit entry point) */
b2c99e3c
BH		 847 unsigned long sal_systab; /* SAL system table */
848 unsigned long boot_info; /* boot info table */
849 unsigned long hcdp; /* HCDP table */
850 unsigned long uga; /* UGA table */
a50f70b1 851 unsigned long uv_systab; /* UV system table */
a0998eb1
DY		 852 unsigned long fw_vendor; /* fw_vendor */
853 unsigned long runtime; /* runtime table */
854 unsigned long config_table; /* config tables */
0bb54905 855 unsigned long esrt; /* ESRT table */
bf924863 856 unsigned long properties_table; /* properties table */
a604af07 857 unsigned long mem_attr_table; /* memory attributes table */
1da177e4
LT		 858 efi_get_time_t *get_time;
859 efi_set_time_t *set_time;
860 efi_get_wakeup_time_t *get_wakeup_time;
861 efi_set_wakeup_time_t *set_wakeup_time;
862 efi_get_variable_t *get_variable;
863 efi_get_next_variable_t *get_next_variable;
864 efi_set_variable_t *set_variable;
70d2a3cf 865 efi_set_variable_t *set_variable_nonblocking;
3b370237 866 efi_query_variable_info_t *query_variable_info;
d3cac1f8 867 efi_query_variable_info_t *query_variable_info_nonblocking;
3b370237
MG		 868 efi_update_capsule_t *update_capsule;
869 efi_query_capsule_caps_t *query_capsule_caps;
1da177e4
LT		 870 efi_get_next_high_mono_count_t *get_next_high_mono_count;
871 efi_reset_system_t *reset_system;
872 efi_set_virtual_address_map_t *set_virtual_address_map;
884f4f66 873 struct efi_memory_map memmap;
3e909599 874 unsigned long flags;
1da177e4
LT		 875} efi;
876
877static inline int
878efi_guidcmp (efi_guid_t left, efi_guid_t right)
879{
880 return memcmp(&left, &right, sizeof (efi_guid_t));
881}
882
883static inline char *
26e02272 884efi_guid_to_str(efi_guid_t *guid, char *out)
1da177e4 885{
925ede0b 886 sprintf(out, "%pUl", guid->b);
1da177e4
LT		 887 return out;
888}
889
890extern void efi_init (void);
891extern void *efi_get_pal_addr (void);
892extern void efi_map_pal_code (void);
1da177e4 893extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
70f4f935 894extern void efi_gettimeofday (struct timespec64 *ts);
1da177e4 895extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
78510792 896#ifdef CONFIG_X86
2223af38 897extern void efi_late_init(void);
78510792 898extern void efi_free_boot_services(void);
ca0e30dc
AB		 899extern efi_status_t efi_query_variable_store(u32 attributes,
900 unsigned long size,
901 bool nonblocking);
b05b9f5f 902extern void efi_find_mirror(void);
78510792 903#else
2223af38 904static inline void efi_late_init(void) {}
78510792 905static inline void efi_free_boot_services(void) {}
a6e4d5a0 906
ca0e30dc
AB		 907static inline efi_status_t efi_query_variable_store(u32 attributes,
908 unsigned long size,
909 bool nonblocking)
a6e4d5a0
MF		 910{
911 return EFI_SUCCESS;
912}
78510792 913#endif
7bc90e01 914extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
9479c7ce
MF		 915
916extern int __init efi_memmap_init_early(struct efi_memory_map_data *data);
917extern void __init efi_memmap_unmap(void);
918
272686bf 919extern int efi_config_init(efi_config_table_type_t *arch_tables);
3846c158 920#ifdef CONFIG_EFI_ESRT
0bb54905 921extern void __init efi_esrt_init(void);
3846c158
PJ		 922#else
923static inline void efi_esrt_init(void) { }
924#endif
7bb68410
AB		 925extern int efi_config_parse_tables(void *config_tables, int count, int sz,
926 efi_config_table_type_t *arch_tables);
1da177e4
LT		 927extern u64 efi_get_iobase (void);
928extern u32 efi_mem_type (unsigned long phys_addr);
929extern u64 efi_mem_attributes (unsigned long phys_addr);
32e62c63 930extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
1da177e4 931extern int __init efi_uart_console_only (void);
0bb54905
PJ		 932extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
933extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
1da177e4 934extern void efi_initialize_iomem_resources(struct resource *code_resource,
00bf4098 935 struct resource *data_resource, struct resource *bss_resource);
916f676f 936extern void efi_reserve_boot_services(void);
7968c0e3 937extern int efi_get_fdt_params(struct efi_fdt_params *params);
0bb54905 938extern struct kobject *efi_kobj;
1da177e4 939
44be28e9 940extern int efi_reboot_quirk_mode;
0c5ed61a
MF		 941extern bool efi_poweroff_required(void);
942
0f96a99d
TI		 943#ifdef CONFIG_EFI_FAKE_MEMMAP
944extern void __init efi_fake_memmap(void);
945#else
946static inline void efi_fake_memmap(void) { }
947#endif
948
10f0d2f5
AB		 949/*
950 * efi_memattr_perm_setter - arch specific callback function passed into
951 * efi_memattr_apply_permissions() that updates the
952 * mapping permissions described by the second
953 * argument in the page tables referred to by the
954 * first argument.
955 */
956typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *);
957
958extern int efi_memattr_init(void);
959extern int efi_memattr_apply_permissions(struct mm_struct *mm,
960 efi_memattr_perm_setter fn);
961
e885cd80 962/* Iterate through an efi_memory_map */
78ce248f 963#define for_each_efi_memory_desc_in_map(m, md) \
e885cd80 964 for ((md) = (m)->map; \
55f1ea15 965 ((void *)(md) + (m)->desc_size) <= (m)->map_end; \
e885cd80
MS		 966 (md) = (void *)(md) + (m)->desc_size)
967
78ce248f
MF		 968/**
969 * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
970 * @md: the efi_memory_desc_t * iterator
971 *
972 * Once the loop finishes @md must not be accessed.
973 */
974#define for_each_efi_memory_desc(md) \
884f4f66 975 for_each_efi_memory_desc_in_map(&efi.memmap, md)
78ce248f 976
98d2a6ca
LE		 977/*
978 * Format an EFI memory descriptor's type and attributes to a user-provided
979 * character buffer, as per snprintf(), and return the buffer.
980 */
981char * __init efi_md_typeattr_format(char *buf, size_t size,
982 const efi_memory_desc_t *md);
983
1da177e4
LT		 984/**
985 * efi_range_is_wc - check the WC bit on an address range
986 * @start: starting kvirt address
987 * @len: length of range
988 *
989 * Consult the EFI memory map and make sure it's ok to set this range WC.
990 * Returns true or false.
991 */
992static inline int efi_range_is_wc(unsigned long start, unsigned long len)
993{
986a80d5 994 unsigned long i;
1da177e4
LT		 995
996 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
997 unsigned long paddr = __pa(start + i);
998 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
999 return 0;
1000 }
1001 /* The range checked out */
1002 return 1;
1003}
1004
1005#ifdef CONFIG_EFI_PCDP
1006extern int __init efi_setup_pcdp_console(char *);
1007#endif
1008
1009/*
83e68189
MF		 1010 * We play games with efi_enabled so that the compiler will, if
1011 * possible, remove EFI-related code altogether.
1da177e4 1012 */
83e68189 1013#define EFI_BOOT 0 /* Were we booted from EFI? */
83e68189
MF		 1014#define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
1015#define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
1016#define EFI_MEMMAP 4 /* Can we use EFI memory map? */
1017#define EFI_64BIT 5 /* Is the firmware 64-bit? */
9f27bc54
DK		 1018#define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
1019#define EFI_ARCH_1 7 /* First arch-specific bit */
fed6cefe 1020#define EFI_DBG 8 /* Print additional debug info at runtime */
a1041713 1021#define EFI_NX_PE_DATA 9 /* Can runtime data regions be mapped non-executable? */
83e68189 1022
1da177e4 1023#ifdef CONFIG_EFI
3e909599
MF		 1024/*
1025 * Test whether the above EFI_* bits are enabled.
1026 */
1027static inline bool efi_enabled(int feature)
1028{
1029 return test_bit(feature, &efi.flags) != 0;
1030}
8562c99c 1031extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
1da177e4 1032#else
3e909599 1033static inline bool efi_enabled(int feature)
83e68189 1034{
3e909599 1035 return false;
83e68189 1036}
8562c99c
MF		 1037static inline void
1038efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
87615a34
MF		 1039
1040static inline bool
1041efi_capsule_pending(int *reset_type)
1042{
1043 return false;
1044}
1da177e4
LT		 1045#endif
1046
806b0351
MF		 1047extern int efi_status_to_err(efi_status_t status);
1048
1da177e4
LT		 1049/*
1050 * Variable Attributes
1051 */
1052#define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
1053#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
1054#define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
41b3254c
MG		 1055#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
1056#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
1057#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
1058#define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
1059
1060#define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
1061 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
1062 EFI_VARIABLE_RUNTIME_ACCESS | \
1063 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
1064 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
1065 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
1066 EFI_VARIABLE_APPEND_WRITE)
e14ab23d
MF		 1067/*
1068 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1069 * not including trailing NUL
1070 */
ba7e34b1 1071#define EFI_VARIABLE_GUID_LEN UUID_STRING_LEN
e14ab23d 1072
e2527a7c
MF		 1073/*
1074 * The type of search to perform when calling boottime->locate_handle
1075 */
1076#define EFI_LOCATE_ALL_HANDLES 0
1077#define EFI_LOCATE_BY_REGISTER_NOTIFY 1
1078#define EFI_LOCATE_BY_PROTOCOL 2
1079
1da177e4
LT		 1080/*
1081 * EFI Device Path information
1082 */
1083#define EFI_DEV_HW 0x01
1084#define EFI_DEV_PCI 1
1085#define EFI_DEV_PCCARD 2
1086#define EFI_DEV_MEM_MAPPED 3
1087#define EFI_DEV_VENDOR 4
1088#define EFI_DEV_CONTROLLER 5
1089#define EFI_DEV_ACPI 0x02
1090#define EFI_DEV_BASIC_ACPI 1
1091#define EFI_DEV_EXPANDED_ACPI 2
1092#define EFI_DEV_MSG 0x03
1093#define EFI_DEV_MSG_ATAPI 1
1094#define EFI_DEV_MSG_SCSI 2
1095#define EFI_DEV_MSG_FC 3
1096#define EFI_DEV_MSG_1394 4
1097#define EFI_DEV_MSG_USB 5
1098#define EFI_DEV_MSG_USB_CLASS 15
1099#define EFI_DEV_MSG_I20 6
1100#define EFI_DEV_MSG_MAC 11
1101#define EFI_DEV_MSG_IPV4 12
1102#define EFI_DEV_MSG_IPV6 13
1103#define EFI_DEV_MSG_INFINIBAND 9
1104#define EFI_DEV_MSG_UART 14
1105#define EFI_DEV_MSG_VENDOR 10
1106#define EFI_DEV_MEDIA 0x04
1107#define EFI_DEV_MEDIA_HARD_DRIVE 1
1108#define EFI_DEV_MEDIA_CDROM 2
1109#define EFI_DEV_MEDIA_VENDOR 3
1110#define EFI_DEV_MEDIA_FILE 4
1111#define EFI_DEV_MEDIA_PROTOCOL 5
1112#define EFI_DEV_BIOS_BOOT 0x05
1113#define EFI_DEV_END_PATH 0x7F
1114#define EFI_DEV_END_PATH2 0xFF
1115#define EFI_DEV_END_INSTANCE 0x01
1116#define EFI_DEV_END_ENTIRE 0xFF
1117
1118struct efi_generic_dev_path {
1119 u8 type;
1120 u8 sub_type;
1121 u16 length;
1122} __attribute ((packed));
1123
4a3575fd
HY		 1124static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1125{
1126 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1127 *addr &= PAGE_MASK;
1128}
1129
4fc756bd
MW		 1130/*
1131 * EFI Variable support.
1132 *
1133 * Different firmware drivers can expose their EFI-like variables using
1134 * the following.
1135 */
1136
1137struct efivar_operations {
1138 efi_get_variable_t *get_variable;
1139 efi_get_next_variable_t *get_next_variable;
1140 efi_set_variable_t *set_variable;
70d2a3cf 1141 efi_set_variable_t *set_variable_nonblocking;
a6e4d5a0 1142 efi_query_variable_store_t *query_variable_store;
4fc756bd
MW		 1143};
1144
1145struct efivars {
1146 /*
1147 * ->lock protects two things:
82f990a8
MF		 1148 * 1) efivarfs_list and efivars_sysfs_list
1149 * 2) ->ops calls
4fc756bd
MW		 1150 */
1151 spinlock_t lock;
4fc756bd 1152 struct kset *kset;
605e70c7 1153 struct kobject *kobject;
4fc756bd
MW		 1154 const struct efivar_operations *ops;
1155};
1156
e14ab23d
MF		 1157/*
1158 * The maximum size of VariableName + Data = 1024
1159 * Therefore, it's reasonable to save that much
1160 * space in each part of the structure,
1161 * and we use a page for reading/writing.
1162 */
1163
a5d92ad3
MF		 1164#define EFI_VAR_NAME_LEN 1024
1165
e14ab23d 1166struct efi_variable {
a5d92ad3 1167 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
e14ab23d
MF		 1168 efi_guid_t VendorGuid;
1169 unsigned long DataSize;
1170 __u8 Data[1024];
1171 efi_status_t Status;
1172 __u32 Attributes;
1173} __attribute__((packed));
1174
1175struct efivar_entry {
1176 struct efi_variable var;
1177 struct list_head list;
1178 struct kobject kobj;
e0d59733
SA		 1179 bool scanning;
1180 bool deleting;
e14ab23d
MF		 1181};
1182
677703ce
MF		 1183struct efi_simple_text_output_protocol_32 {
1184 u32 reset;
1185 u32 output_string;
1186 u32 test_string;
1187};
1188
1189struct efi_simple_text_output_protocol_64 {
1190 u64 reset;
1191 u64 output_string;
1192 u64 test_string;
1193};
ed37ddff
RF		 1194
1195struct efi_simple_text_output_protocol {
1196 void *reset;
1197 efi_status_t (*output_string)(void *, void *);
1198 void *test_string;
1199};
1200
fc372064
AB		 1201#define PIXEL_RGB_RESERVED_8BIT_PER_COLOR 0
1202#define PIXEL_BGR_RESERVED_8BIT_PER_COLOR 1
1203#define PIXEL_BIT_MASK 2
1204#define PIXEL_BLT_ONLY 3
1205#define PIXEL_FORMAT_MAX 4
1206
1207struct efi_pixel_bitmask {
1208 u32 red_mask;
1209 u32 green_mask;
1210 u32 blue_mask;
1211 u32 reserved_mask;
1212};
1213
1214struct efi_graphics_output_mode_info {
1215 u32 version;
1216 u32 horizontal_resolution;
1217 u32 vertical_resolution;
1218 int pixel_format;
1219 struct efi_pixel_bitmask pixel_information;
1220 u32 pixels_per_scan_line;
1221} __packed;
1222
1223struct efi_graphics_output_protocol_mode_32 {
1224 u32 max_mode;
1225 u32 mode;
1226 u32 info;
1227 u32 size_of_info;
1228 u64 frame_buffer_base;
1229 u32 frame_buffer_size;
1230} __packed;
1231
1232struct efi_graphics_output_protocol_mode_64 {
1233 u32 max_mode;
1234 u32 mode;
1235 u64 info;
1236 u64 size_of_info;
1237 u64 frame_buffer_base;
1238 u64 frame_buffer_size;
1239} __packed;
1240
1241struct efi_graphics_output_protocol_mode {
1242 u32 max_mode;
1243 u32 mode;
1244 unsigned long info;
1245 unsigned long size_of_info;
1246 u64 frame_buffer_base;
1247 unsigned long frame_buffer_size;
1248} __packed;
1249
1250struct efi_graphics_output_protocol_32 {
1251 u32 query_mode;
1252 u32 set_mode;
1253 u32 blt;
1254 u32 mode;
1255};
1256
1257struct efi_graphics_output_protocol_64 {
1258 u64 query_mode;
1259 u64 set_mode;
1260 u64 blt;
1261 u64 mode;
1262};
1263
1264struct efi_graphics_output_protocol {
1265 unsigned long query_mode;
1266 unsigned long set_mode;
1267 unsigned long blt;
1268 struct efi_graphics_output_protocol_mode *mode;
1269};
1270
1271typedef efi_status_t (*efi_graphics_output_protocol_query_mode)(
1272 struct efi_graphics_output_protocol *, u32, unsigned long *,
1273 struct efi_graphics_output_mode_info **);
1274
04851772
MF		 1275extern struct list_head efivar_sysfs_list;
1276
1277static inline void
1278efivar_unregister(struct efivar_entry *var)
1279{
1280 kobject_put(&var->kobj);
1281}
1282
e14ab23d 1283int efivars_register(struct efivars *efivars,
4fc756bd 1284 const struct efivar_operations *ops,
e14ab23d
MF		 1285 struct kobject *kobject);
1286int efivars_unregister(struct efivars *efivars);
1287struct kobject *efivars_kobject(void);
1288
1289int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1cfd6316 1290 void *data, bool duplicates, struct list_head *head);
e14ab23d
MF		 1291
1292void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1293void efivar_entry_remove(struct efivar_entry *entry);
1294
1295int __efivar_entry_delete(struct efivar_entry *entry);
1296int efivar_entry_delete(struct efivar_entry *entry);
1297
e14ab23d 1298int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
8a415b8c
MF		 1299int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1300 unsigned long *size, void *data);
e14ab23d
MF		 1301int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1302 unsigned long *size, void *data);
1303int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1304 unsigned long size, void *data, struct list_head *head);
1305int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1306 unsigned long *size, void *data, bool *set);
1307int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1308 bool block, unsigned long size, void *data);
1309
1310void efivar_entry_iter_begin(void);
1311void efivar_entry_iter_end(void);
1312
1313int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1314 struct list_head *head, void *data,
1315 struct efivar_entry **prev);
1316int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1317 struct list_head *head, void *data);
1318
1319struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1320 struct list_head *head, bool remove);
1321
8282f5d9
PJ		 1322bool efivar_validate(efi_guid_t vendor, efi_char16_t *var_name, u8 *data,
1323 unsigned long data_size);
ed8b0de5
PJ		 1324bool efivar_variable_is_removable(efi_guid_t vendor, const char *name,
1325 size_t len);
e14ab23d 1326
a9499fa7 1327extern struct work_struct efivar_work;
04851772
MF		 1328void efivar_run_worker(void);
1329
a9499fa7 1330#if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
e14ab23d 1331int efivars_sysfs_init(void);
4fc756bd 1332
e0d59733
SA		 1333#define EFIVARS_DATA_SIZE_MAX 1024
1334
4fc756bd 1335#endif /* CONFIG_EFI_VARS */
f0133f3c
MF		 1336extern bool efi_capsule_pending(int *reset_type);
1337
1338extern int efi_capsule_supported(efi_guid_t guid, u32 flags,
1339 size_t size, int *reset);
1340
1341extern int efi_capsule_update(efi_capsule_header_t *capsule,
1342 struct page **pages);
4fc756bd 1343
926172d4
DY		 1344#ifdef CONFIG_EFI_RUNTIME_MAP
1345int efi_runtime_map_init(struct kobject *);
1346void efi_runtime_map_setup(void *, int, u32);
6a2c20e7
VG		 1347int efi_get_runtime_map_size(void);
1348int efi_get_runtime_map_desc_size(void);
1349int efi_runtime_map_copy(void *buf, size_t bufsz);
926172d4
DY		 1350#else
1351static inline int efi_runtime_map_init(struct kobject *kobj)
1352{
1353 return 0;
1354}
1355
1356static inline void
1357efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
6a2c20e7
VG		 1358
1359static inline int efi_get_runtime_map_size(void)
1360{
1361 return 0;
1362}
1363
1364static inline int efi_get_runtime_map_desc_size(void)
1365{
1366 return 0;
1367}
1368
1369static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1370{
1371 return 0;
1372}
1373
926172d4
DY		 1374#endif
1375
bd669475
AB		 1376/* prototypes shared between arch specific and generic stub code */
1377
1378#define pr_efi(sys_table, msg) efi_printk(sys_table, "EFI stub: "msg)
1379#define pr_efi_err(sys_table, msg) efi_printk(sys_table, "EFI stub: ERROR: "msg)
1380
1381void efi_printk(efi_system_table_t *sys_table_arg, char *str);
1382
1383void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
1384 unsigned long addr);
1385
1386char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
1387 efi_loaded_image_t *image, int *cmd_line_len);
1388
1389efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
1390 efi_memory_desc_t **map,
1391 unsigned long *map_size,
1392 unsigned long *desc_size,
1393 u32 *desc_ver,
1394 unsigned long *key_ptr);
1395
1396efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
1397 unsigned long size, unsigned long align,
1398 unsigned long *addr);
1399
1400efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
1401 unsigned long size, unsigned long align,
1402 unsigned long *addr, unsigned long max);
1403
1404efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
1405 unsigned long *image_addr,
1406 unsigned long image_size,
1407 unsigned long alloc_size,
1408 unsigned long preferred_addr,
1409 unsigned long alignment);
1410
1411efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
1412 efi_loaded_image_t *image,
1413 char *cmd_line, char *option_string,
1414 unsigned long max_addr,
1415 unsigned long *load_addr,
1416 unsigned long *load_size);
1417
5a17dae4
MF		 1418efi_status_t efi_parse_options(char *cmdline);
1419
2c23b73c
AB		 1420efi_status_t efi_setup_gop(efi_system_table_t *sys_table_arg,
1421 struct screen_info *si, efi_guid_t *proto,
1422 unsigned long size);
1423
b2e0a54a 1424bool efi_runtime_disabled(void);
80e75596
AT		 1425extern void efi_call_virt_check_flags(unsigned long flags, const char *call);
1426
1427/*
1428 * Arch code can implement the following three template macros, avoiding
1429 * reptition for the void/non-void return cases of {__,}efi_call_virt():
1430 *
1431 * * arch_efi_call_virt_setup()
1432 *
1433 * Sets up the environment for the call (e.g. switching page tables,
1434 * allowing kernel-mode use of floating point, if required).
1435 *
1436 * * arch_efi_call_virt()
1437 *
1438 * Performs the call. The last expression in the macro must be the call
1439 * itself, allowing the logic to be shared by the void and non-void
1440 * cases.
1441 *
1442 * * arch_efi_call_virt_teardown()
1443 *
1444 * Restores the usual kernel environment once the call has returned.
1445 */
1446
1447#define efi_call_virt_pointer(p, f, args...) \
1448({ \
1449 efi_status_t __s; \
1450 unsigned long __flags; \
1451 \
1452 arch_efi_call_virt_setup(); \
1453 \
1454 local_save_flags(__flags); \
1455 __s = arch_efi_call_virt(p, f, args); \
1456 efi_call_virt_check_flags(__flags, __stringify(f)); \
1457 \
1458 arch_efi_call_virt_teardown(); \
1459 \
1460 __s; \
1461})
1462
1463#define __efi_call_virt_pointer(p, f, args...) \
1464({ \
1465 unsigned long __flags; \
1466 \
1467 arch_efi_call_virt_setup(); \
1468 \
1469 local_save_flags(__flags); \
1470 arch_efi_call_virt(p, f, args); \
1471 efi_call_virt_check_flags(__flags, __stringify(f)); \
1472 \
1473 arch_efi_call_virt_teardown(); \
1474})
1475
1da177e4 1476#endif /* _LINUX_EFI_H */
Linux 6.x block layer and io_uring tree(s)