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