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