blob: e29a31d0fc35307584f1124d27b43e7ac5327df8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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>
Huang, Ying4a3575f2008-02-25 15:18:37 +080021#include <linux/pfn.h>
Matthew Garrett5ee9c192011-07-21 16:57:56 -040022#include <linux/pstore.h>
Matt Fleming8562c99c2014-06-13 12:22:22 +010023#include <linux/reboot.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25#include <asm/page.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27#define EFI_SUCCESS 0
28#define EFI_LOAD_ERROR ( 1 | (1UL << (BITS_PER_LONG-1)))
29#define EFI_INVALID_PARAMETER ( 2 | (1UL << (BITS_PER_LONG-1)))
30#define EFI_UNSUPPORTED ( 3 | (1UL << (BITS_PER_LONG-1)))
31#define EFI_BAD_BUFFER_SIZE ( 4 | (1UL << (BITS_PER_LONG-1)))
32#define EFI_BUFFER_TOO_SMALL ( 5 | (1UL << (BITS_PER_LONG-1)))
Matthew Garrett5d9db882012-10-05 13:54:56 +080033#define EFI_NOT_READY ( 6 | (1UL << (BITS_PER_LONG-1)))
34#define EFI_DEVICE_ERROR ( 7 | (1UL << (BITS_PER_LONG-1)))
35#define EFI_WRITE_PROTECTED ( 8 | (1UL << (BITS_PER_LONG-1)))
36#define EFI_OUT_OF_RESOURCES ( 9 | (1UL << (BITS_PER_LONG-1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
Matthew Garrett5d9db882012-10-05 13:54:56 +080038#define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40typedef unsigned long efi_status_t;
41typedef u8 efi_bool_t;
42typedef u16 efi_char16_t; /* UNICODE character */
Roy Franzed37ddf2013-09-22 15:45:26 -070043typedef u64 efi_physical_addr_t;
44typedef void *efi_handle_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46
47typedef struct {
48 u8 b[16];
49} efi_guid_t;
50
51#define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
52((efi_guid_t) \
53{{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
54 (b) & 0xff, ((b) >> 8) & 0xff, \
55 (c) & 0xff, ((c) >> 8) & 0xff, \
56 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
57
58/*
59 * Generic EFI table header
60 */
61typedef struct {
62 u64 signature;
63 u32 revision;
64 u32 headersize;
65 u32 crc32;
66 u32 reserved;
67} efi_table_hdr_t;
68
69/*
70 * Memory map descriptor:
71 */
72
73/* Memory types: */
74#define EFI_RESERVED_TYPE 0
75#define EFI_LOADER_CODE 1
76#define EFI_LOADER_DATA 2
77#define EFI_BOOT_SERVICES_CODE 3
78#define EFI_BOOT_SERVICES_DATA 4
79#define EFI_RUNTIME_SERVICES_CODE 5
80#define EFI_RUNTIME_SERVICES_DATA 6
81#define EFI_CONVENTIONAL_MEMORY 7
82#define EFI_UNUSABLE_MEMORY 8
83#define EFI_ACPI_RECLAIM_MEMORY 9
84#define EFI_ACPI_MEMORY_NVS 10
85#define EFI_MEMORY_MAPPED_IO 11
86#define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
87#define EFI_PAL_CODE 13
Dan Williamsad5fb872015-04-03 12:05:28 -040088#define EFI_PERSISTENT_MEMORY 14
89#define EFI_MAX_MEMORY_TYPE 15
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
91/* Attribute values: */
92#define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
93#define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
94#define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
95#define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
Laszlo Ersek9c97e0b2014-09-03 13:32:19 +020096#define EFI_MEMORY_UCE ((u64)0x0000000000000010ULL) /* uncached, exported */
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
98#define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
99#define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
Robert Elliottc016ca02016-02-01 22:07:06 +0000100#define EFI_MEMORY_NV ((u64)0x0000000000008000ULL) /* non-volatile */
Tony Luckb05b9f52015-06-24 16:58:15 -0700101#define EFI_MEMORY_MORE_RELIABLE \
102 ((u64)0x0000000000010000ULL) /* higher reliability */
Ard Biesheuvel87db73ae2015-08-07 09:36:54 +0100103#define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
105#define EFI_MEMORY_DESCRIPTOR_VERSION 1
106
107#define EFI_PAGE_SHIFT 12
Roy Franzed37ddf2013-09-22 15:45:26 -0700108#define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110typedef struct {
111 u32 type;
112 u32 pad;
113 u64 phys_addr;
114 u64 virt_addr;
115 u64 num_pages;
116 u64 attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117} efi_memory_desc_t;
118
Matthew Garrett3b370232011-06-06 15:36:25 -0400119typedef struct {
120 efi_guid_t guid;
121 u32 headersize;
122 u32 flags;
123 u32 imagesize;
124} efi_capsule_header_t;
125
Matt Flemingbb05e4b2011-11-15 12:57:03 +0000126/*
127 * Allocation types for calls to boottime->allocate_pages.
128 */
129#define EFI_ALLOCATE_ANY_PAGES 0
130#define EFI_ALLOCATE_MAX_ADDRESS 1
131#define EFI_ALLOCATE_ADDRESS 2
132#define EFI_MAX_ALLOCATE_TYPE 3
133
Matthew Wilcoxe088a4a2009-05-22 13:49:49 -0700134typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136/*
137 * Types and defines for Time Services
138 */
139#define EFI_TIME_ADJUST_DAYLIGHT 0x1
140#define EFI_TIME_IN_DAYLIGHT 0x2
141#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
142
143typedef struct {
144 u16 year;
145 u8 month;
146 u8 day;
147 u8 hour;
148 u8 minute;
149 u8 second;
150 u8 pad1;
151 u32 nanosecond;
152 s16 timezone;
153 u8 daylight;
154 u8 pad2;
155} efi_time_t;
156
157typedef struct {
158 u32 resolution;
159 u32 accuracy;
160 u8 sets_to_zero;
161} efi_time_cap_t;
162
Matt Fleming677703c2014-01-10 13:47:37 +0000163typedef struct {
164 efi_table_hdr_t hdr;
165 u32 raise_tpl;
166 u32 restore_tpl;
167 u32 allocate_pages;
168 u32 free_pages;
169 u32 get_memory_map;
170 u32 allocate_pool;
171 u32 free_pool;
172 u32 create_event;
173 u32 set_timer;
174 u32 wait_for_event;
175 u32 signal_event;
176 u32 close_event;
177 u32 check_event;
178 u32 install_protocol_interface;
179 u32 reinstall_protocol_interface;
180 u32 uninstall_protocol_interface;
181 u32 handle_protocol;
182 u32 __reserved;
183 u32 register_protocol_notify;
184 u32 locate_handle;
185 u32 locate_device_path;
186 u32 install_configuration_table;
187 u32 load_image;
188 u32 start_image;
189 u32 exit;
190 u32 unload_image;
191 u32 exit_boot_services;
192 u32 get_next_monotonic_count;
193 u32 stall;
194 u32 set_watchdog_timer;
195 u32 connect_controller;
196 u32 disconnect_controller;
197 u32 open_protocol;
198 u32 close_protocol;
199 u32 open_protocol_information;
200 u32 protocols_per_handle;
201 u32 locate_handle_buffer;
202 u32 locate_protocol;
203 u32 install_multiple_protocol_interfaces;
204 u32 uninstall_multiple_protocol_interfaces;
205 u32 calculate_crc32;
206 u32 copy_mem;
207 u32 set_mem;
208 u32 create_event_ex;
209} __packed efi_boot_services_32_t;
210
211typedef struct {
212 efi_table_hdr_t hdr;
213 u64 raise_tpl;
214 u64 restore_tpl;
215 u64 allocate_pages;
216 u64 free_pages;
217 u64 get_memory_map;
218 u64 allocate_pool;
219 u64 free_pool;
220 u64 create_event;
221 u64 set_timer;
222 u64 wait_for_event;
223 u64 signal_event;
224 u64 close_event;
225 u64 check_event;
226 u64 install_protocol_interface;
227 u64 reinstall_protocol_interface;
228 u64 uninstall_protocol_interface;
229 u64 handle_protocol;
230 u64 __reserved;
231 u64 register_protocol_notify;
232 u64 locate_handle;
233 u64 locate_device_path;
234 u64 install_configuration_table;
235 u64 load_image;
236 u64 start_image;
237 u64 exit;
238 u64 unload_image;
239 u64 exit_boot_services;
240 u64 get_next_monotonic_count;
241 u64 stall;
242 u64 set_watchdog_timer;
243 u64 connect_controller;
244 u64 disconnect_controller;
245 u64 open_protocol;
246 u64 close_protocol;
247 u64 open_protocol_information;
248 u64 protocols_per_handle;
249 u64 locate_handle_buffer;
250 u64 locate_protocol;
251 u64 install_multiple_protocol_interfaces;
252 u64 uninstall_multiple_protocol_interfaces;
253 u64 calculate_crc32;
254 u64 copy_mem;
255 u64 set_mem;
256 u64 create_event_ex;
257} __packed efi_boot_services_64_t;
258
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259/*
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000260 * EFI Boot Services table
261 */
262typedef struct {
263 efi_table_hdr_t hdr;
264 void *raise_tpl;
265 void *restore_tpl;
Roy Franzed37ddf2013-09-22 15:45:26 -0700266 efi_status_t (*allocate_pages)(int, int, unsigned long,
267 efi_physical_addr_t *);
268 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
269 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
270 unsigned long *, u32 *);
271 efi_status_t (*allocate_pool)(int, unsigned long, void **);
272 efi_status_t (*free_pool)(void *);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000273 void *create_event;
274 void *set_timer;
275 void *wait_for_event;
276 void *signal_event;
277 void *close_event;
278 void *check_event;
279 void *install_protocol_interface;
280 void *reinstall_protocol_interface;
281 void *uninstall_protocol_interface;
Roy Franzed37ddf2013-09-22 15:45:26 -0700282 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000283 void *__reserved;
284 void *register_protocol_notify;
285 void *locate_handle;
286 void *locate_device_path;
287 void *install_configuration_table;
288 void *load_image;
289 void *start_image;
290 void *exit;
291 void *unload_image;
Roy Franzed37ddf2013-09-22 15:45:26 -0700292 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000293 void *get_next_monotonic_count;
294 void *stall;
295 void *set_watchdog_timer;
296 void *connect_controller;
297 void *disconnect_controller;
298 void *open_protocol;
299 void *close_protocol;
300 void *open_protocol_information;
301 void *protocols_per_handle;
302 void *locate_handle_buffer;
Ard Biesheuvele4fbf472016-01-10 11:29:07 +0100303 efi_status_t (*locate_protocol)(efi_guid_t *, void *, void **);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000304 void *install_multiple_protocol_interfaces;
305 void *uninstall_multiple_protocol_interfaces;
306 void *calculate_crc32;
307 void *copy_mem;
308 void *set_mem;
309 void *create_event_ex;
310} efi_boot_services_t;
311
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700312typedef enum {
313 EfiPciIoWidthUint8,
314 EfiPciIoWidthUint16,
315 EfiPciIoWidthUint32,
316 EfiPciIoWidthUint64,
317 EfiPciIoWidthFifoUint8,
318 EfiPciIoWidthFifoUint16,
319 EfiPciIoWidthFifoUint32,
320 EfiPciIoWidthFifoUint64,
321 EfiPciIoWidthFillUint8,
322 EfiPciIoWidthFillUint16,
323 EfiPciIoWidthFillUint32,
324 EfiPciIoWidthFillUint64,
325 EfiPciIoWidthMaximum
326} EFI_PCI_IO_PROTOCOL_WIDTH;
327
328typedef enum {
329 EfiPciIoAttributeOperationGet,
330 EfiPciIoAttributeOperationSet,
331 EfiPciIoAttributeOperationEnable,
332 EfiPciIoAttributeOperationDisable,
333 EfiPciIoAttributeOperationSupported,
334 EfiPciIoAttributeOperationMaximum
335} EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
336
Matt Fleming677703c2014-01-10 13:47:37 +0000337typedef struct {
338 u32 read;
339 u32 write;
340} efi_pci_io_protocol_access_32_t;
341
342typedef struct {
343 u64 read;
344 u64 write;
345} efi_pci_io_protocol_access_64_t;
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700346
347typedef struct {
348 void *read;
349 void *write;
350} efi_pci_io_protocol_access_t;
351
352typedef struct {
Matt Fleming677703c2014-01-10 13:47:37 +0000353 u32 poll_mem;
354 u32 poll_io;
355 efi_pci_io_protocol_access_32_t mem;
356 efi_pci_io_protocol_access_32_t io;
357 efi_pci_io_protocol_access_32_t pci;
358 u32 copy_mem;
359 u32 map;
360 u32 unmap;
361 u32 allocate_buffer;
362 u32 free_buffer;
363 u32 flush;
364 u32 get_location;
365 u32 attributes;
366 u32 get_bar_attributes;
367 u32 set_bar_attributes;
368 uint64_t romsize;
369 void *romimage;
370} efi_pci_io_protocol_32;
371
372typedef struct {
373 u64 poll_mem;
374 u64 poll_io;
375 efi_pci_io_protocol_access_64_t mem;
376 efi_pci_io_protocol_access_64_t io;
377 efi_pci_io_protocol_access_64_t pci;
378 u64 copy_mem;
379 u64 map;
380 u64 unmap;
381 u64 allocate_buffer;
382 u64 free_buffer;
383 u64 flush;
384 u64 get_location;
385 u64 attributes;
386 u64 get_bar_attributes;
387 u64 set_bar_attributes;
388 uint64_t romsize;
389 void *romimage;
390} efi_pci_io_protocol_64;
391
392typedef struct {
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700393 void *poll_mem;
394 void *poll_io;
395 efi_pci_io_protocol_access_t mem;
396 efi_pci_io_protocol_access_t io;
397 efi_pci_io_protocol_access_t pci;
398 void *copy_mem;
399 void *map;
400 void *unmap;
401 void *allocate_buffer;
402 void *free_buffer;
403 void *flush;
404 void *get_location;
405 void *attributes;
406 void *get_bar_attributes;
407 void *set_bar_attributes;
408 uint64_t romsize;
409 void *romimage;
410} efi_pci_io_protocol;
411
412#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
413#define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
414#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
415#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
416#define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
417#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
418#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
419#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
420#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
421#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
422#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
423#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
424#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
425#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
426#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
427#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
428#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
429#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
430#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
431
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000432/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 * Types and defines for EFI ResetSystem
434 */
435#define EFI_RESET_COLD 0
436#define EFI_RESET_WARM 1
437#define EFI_RESET_SHUTDOWN 2
438
439/*
440 * EFI Runtime Services table
441 */
442#define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
443#define EFI_RUNTIME_SERVICES_REVISION 0x00010000
444
445typedef struct {
446 efi_table_hdr_t hdr;
Matt Fleming677703c2014-01-10 13:47:37 +0000447 u32 get_time;
448 u32 set_time;
449 u32 get_wakeup_time;
450 u32 set_wakeup_time;
451 u32 set_virtual_address_map;
452 u32 convert_pointer;
453 u32 get_variable;
454 u32 get_next_variable;
455 u32 set_variable;
456 u32 get_next_high_mono_count;
457 u32 reset_system;
458 u32 update_capsule;
459 u32 query_capsule_caps;
460 u32 query_variable_info;
461} efi_runtime_services_32_t;
462
463typedef struct {
464 efi_table_hdr_t hdr;
465 u64 get_time;
466 u64 set_time;
467 u64 get_wakeup_time;
468 u64 set_wakeup_time;
469 u64 set_virtual_address_map;
470 u64 convert_pointer;
471 u64 get_variable;
472 u64 get_next_variable;
473 u64 set_variable;
474 u64 get_next_high_mono_count;
475 u64 reset_system;
476 u64 update_capsule;
477 u64 query_capsule_caps;
478 u64 query_variable_info;
479} efi_runtime_services_64_t;
480
481typedef struct {
482 efi_table_hdr_t hdr;
Borislav Petkov43ab0472013-06-02 14:56:07 +0200483 void *get_time;
484 void *set_time;
485 void *get_wakeup_time;
486 void *set_wakeup_time;
487 void *set_virtual_address_map;
488 void *convert_pointer;
489 void *get_variable;
490 void *get_next_variable;
491 void *set_variable;
492 void *get_next_high_mono_count;
493 void *reset_system;
494 void *update_capsule;
495 void *query_capsule_caps;
496 void *query_variable_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497} efi_runtime_services_t;
498
499typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
500typedef efi_status_t efi_set_time_t (efi_time_t *tm);
501typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
502 efi_time_t *tm);
503typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
504typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
505 unsigned long *data_size, void *data);
506typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
507 efi_guid_t *vendor);
508typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
Matthew Garrettf7a2d732011-06-06 15:36:24 -0400509 u32 attr, unsigned long data_size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 void *data);
511typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
512typedef void efi_reset_system_t (int reset_type, efi_status_t status,
513 unsigned long data_size, efi_char16_t *data);
514typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
515 unsigned long descriptor_size,
516 u32 descriptor_version,
517 efi_memory_desc_t *virtual_map);
Matthew Garrett3b370232011-06-06 15:36:25 -0400518typedef efi_status_t efi_query_variable_info_t(u32 attr,
519 u64 *storage_space,
520 u64 *remaining_space,
521 u64 *max_variable_size);
522typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
523 unsigned long count,
524 unsigned long sg_list);
525typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
526 unsigned long count,
527 u64 *max_size,
528 int *reset_type);
Ard Biesheuvelca0e30d2016-02-01 22:06:58 +0000529typedef efi_status_t efi_query_variable_store_t(u32 attributes,
530 unsigned long size,
531 bool nonblocking);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
Ard Biesheuvel022ee6c2014-06-26 12:09:05 +0200533void efi_native_runtime_setup(void);
534
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535/*
536 * EFI Configuration Table and GUID definitions
537 */
538#define NULL_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000539 EFI_GUID(0x00000000, 0x0000, 0x0000, \
540 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
542#define MPS_TABLE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000543 EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3, \
544 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
546#define ACPI_TABLE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000547 EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3, \
548 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
550#define ACPI_20_TABLE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000551 EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
552 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
554#define SMBIOS_TABLE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000555 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
556 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Ard Biesheuvele1ccbbc2014-10-14 16:34:47 +0200558#define SMBIOS3_TABLE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000559 EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c, \
560 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94)
Ard Biesheuvele1ccbbc2014-10-14 16:34:47 +0200561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562#define SAL_SYSTEM_TABLE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000563 EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3, \
564 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
566#define HCDP_TABLE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000567 EFI_GUID(0xf951938d, 0x620b, 0x42ef, \
568 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569
570#define UGA_IO_PROTOCOL_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000571 EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b, \
572 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0x0b, 0x07, 0xa2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
574#define EFI_GLOBAL_VARIABLE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000575 EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, \
576 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
Russ Andersona50f70b2008-10-03 11:58:54 -0500578#define UV_SYSTEM_TABLE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000579 EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd, \
580 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93)
Russ Andersona50f70b2008-10-03 11:58:54 -0500581
Matthew Garrett5ee9c192011-07-21 16:57:56 -0400582#define LINUX_EFI_CRASH_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000583 EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc, \
584 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0)
Matthew Garrett5ee9c192011-07-21 16:57:56 -0400585
Matt Fleming8e84f342011-11-15 12:56:50 +0000586#define LOADED_IMAGE_PROTOCOL_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000587 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
588 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
Matt Fleming8e84f342011-11-15 12:56:50 +0000589
Matt Fleming0f7c5d42011-11-15 12:57:16 +0000590#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000591 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
592 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
Matt Fleming0f7c5d42011-11-15 12:57:16 +0000593
594#define EFI_UGA_PROTOCOL_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000595 EFI_GUID(0x982c298b, 0xf4fa, 0x41cb, \
596 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39)
Matt Fleming0f7c5d42011-11-15 12:57:16 +0000597
598#define EFI_PCI_IO_PROTOCOL_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000599 EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5, \
600 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
Matt Fleming0f7c5d42011-11-15 12:57:16 +0000601
Matt Fleming55839d52011-08-11 10:28:06 +0100602#define EFI_FILE_INFO_ID \
Peter Jones662b1d82016-02-17 12:35:54 +0000603 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
604 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
Matt Fleming55839d52011-08-11 10:28:06 +0100605
Peter Jones0bb54902015-04-28 18:44:31 -0400606#define EFI_SYSTEM_RESOURCE_TABLE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000607 EFI_GUID(0xb122a263, 0x3661, 0x4f68, \
608 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
Peter Jones0bb54902015-04-28 18:44:31 -0400609
Matt Fleming55839d52011-08-11 10:28:06 +0100610#define EFI_FILE_SYSTEM_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000611 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
612 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
Matt Fleming55839d52011-08-11 10:28:06 +0100613
Roy Franz263b4a32014-01-08 17:54:19 -0800614#define DEVICE_TREE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000615 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
616 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
Roy Franz263b4a32014-01-08 17:54:19 -0800617
Ard Biesheuvelbf924862015-09-09 10:08:15 +0200618#define EFI_PROPERTIES_TABLE_GUID \
Peter Jones662b1d82016-02-17 12:35:54 +0000619 EFI_GUID(0x880aaca3, 0x4adc, 0x4a04, \
620 0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5)
Ard Biesheuvelbf924862015-09-09 10:08:15 +0200621
Ard Biesheuvele4fbf472016-01-10 11:29:07 +0100622#define EFI_RNG_PROTOCOL_GUID \
623 EFI_GUID(0x3152bca5, 0xeade, 0x433d, \
624 0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
625
Ard Biesheuvela604af02016-04-25 21:06:44 +0100626#define EFI_MEMORY_ATTRIBUTES_TABLE_GUID \
627 EFI_GUID(0xdcfa911d, 0x26eb, 0x469f, \
628 0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630typedef struct {
631 efi_guid_t guid;
Olof Johansson1adbfa32012-02-12 13:24:29 -0800632 u64 table;
633} efi_config_table_64_t;
634
635typedef struct {
636 efi_guid_t guid;
637 u32 table;
638} efi_config_table_32_t;
639
640typedef struct {
641 efi_guid_t guid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 unsigned long table;
643} efi_config_table_t;
644
Leif Lindholm272686b2013-09-05 11:34:54 +0100645typedef struct {
646 efi_guid_t guid;
647 const char *name;
648 unsigned long *ptr;
649} efi_config_table_type_t;
650
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Matthew Garrett3b370232011-06-06 15:36:25 -0400653#define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
654#define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
655#define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
656#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
657#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
658#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
659
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660typedef struct {
661 efi_table_hdr_t hdr;
Olof Johansson1adbfa32012-02-12 13:24:29 -0800662 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
663 u32 fw_revision;
664 u32 __pad1;
665 u64 con_in_handle;
666 u64 con_in;
667 u64 con_out_handle;
668 u64 con_out;
669 u64 stderr_handle;
670 u64 stderr;
671 u64 runtime;
672 u64 boottime;
673 u32 nr_tables;
674 u32 __pad2;
675 u64 tables;
676} efi_system_table_64_t;
677
678typedef struct {
679 efi_table_hdr_t hdr;
680 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
681 u32 fw_revision;
682 u32 con_in_handle;
683 u32 con_in;
684 u32 con_out_handle;
685 u32 con_out;
686 u32 stderr_handle;
687 u32 stderr;
688 u32 runtime;
689 u32 boottime;
690 u32 nr_tables;
691 u32 tables;
692} efi_system_table_32_t;
693
694typedef struct {
695 efi_table_hdr_t hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
697 u32 fw_revision;
698 unsigned long con_in_handle;
699 unsigned long con_in;
700 unsigned long con_out_handle;
701 unsigned long con_out;
702 unsigned long stderr_handle;
703 unsigned long stderr;
704 efi_runtime_services_t *runtime;
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000705 efi_boot_services_t *boottime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 unsigned long nr_tables;
707 unsigned long tables;
708} efi_system_table_t;
709
710struct efi_memory_map {
Ard Biesheuvel44511fb2015-10-23 11:48:16 +0200711 phys_addr_t phys_map;
Matt Tolentino7ae65fd2005-09-03 15:56:27 -0700712 void *map;
713 void *map_end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 int nr_map;
715 unsigned long desc_version;
Matt Tolentino7ae65fd2005-09-03 15:56:27 -0700716 unsigned long desc_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717};
718
Mark Salter0302f712013-12-30 12:12:12 -0500719struct efi_fdt_params {
720 u64 system_table;
721 u64 mmap;
722 u32 mmap_size;
723 u32 desc_size;
724 u32 desc_ver;
725};
726
Matt Fleming8e84f342011-11-15 12:56:50 +0000727typedef struct {
728 u32 revision;
Matt Fleming677703c2014-01-10 13:47:37 +0000729 u32 parent_handle;
730 u32 system_table;
731 u32 device_handle;
732 u32 file_path;
733 u32 reserved;
734 u32 load_options_size;
735 u32 load_options;
736 u32 image_base;
737 __aligned_u64 image_size;
738 unsigned int image_code_type;
739 unsigned int image_data_type;
740 unsigned long unload;
741} efi_loaded_image_32_t;
742
743typedef struct {
744 u32 revision;
745 u64 parent_handle;
746 u64 system_table;
747 u64 device_handle;
748 u64 file_path;
749 u64 reserved;
750 u32 load_options_size;
751 u64 load_options;
752 u64 image_base;
753 __aligned_u64 image_size;
754 unsigned int image_code_type;
755 unsigned int image_data_type;
756 unsigned long unload;
757} efi_loaded_image_64_t;
758
759typedef struct {
760 u32 revision;
Matt Fleming8e84f342011-11-15 12:56:50 +0000761 void *parent_handle;
762 efi_system_table_t *system_table;
763 void *device_handle;
764 void *file_path;
765 void *reserved;
766 u32 load_options_size;
767 void *load_options;
768 void *image_base;
769 __aligned_u64 image_size;
770 unsigned int image_code_type;
771 unsigned int image_data_type;
772 unsigned long unload;
773} efi_loaded_image_t;
774
Matt Fleming55839d52011-08-11 10:28:06 +0100775
776typedef struct {
777 u64 size;
778 u64 file_size;
779 u64 phys_size;
780 efi_time_t create_time;
781 efi_time_t last_access_time;
782 efi_time_t modification_time;
783 __aligned_u64 attribute;
784 efi_char16_t filename[1];
785} efi_file_info_t;
786
Matt Fleming677703c2014-01-10 13:47:37 +0000787typedef struct {
788 u64 revision;
789 u32 open;
790 u32 close;
791 u32 delete;
792 u32 read;
793 u32 write;
794 u32 get_position;
795 u32 set_position;
796 u32 get_info;
797 u32 set_info;
798 u32 flush;
799} efi_file_handle_32_t;
800
801typedef struct {
802 u64 revision;
803 u64 open;
804 u64 close;
805 u64 delete;
806 u64 read;
807 u64 write;
808 u64 get_position;
809 u64 set_position;
810 u64 get_info;
811 u64 set_info;
812 u64 flush;
813} efi_file_handle_64_t;
814
Roy Franzed37ddf2013-09-22 15:45:26 -0700815typedef struct _efi_file_handle {
Matt Fleming55839d52011-08-11 10:28:06 +0100816 u64 revision;
Roy Franzed37ddf2013-09-22 15:45:26 -0700817 efi_status_t (*open)(struct _efi_file_handle *,
818 struct _efi_file_handle **,
819 efi_char16_t *, u64, u64);
820 efi_status_t (*close)(struct _efi_file_handle *);
Matt Fleming55839d52011-08-11 10:28:06 +0100821 void *delete;
Roy Franzed37ddf2013-09-22 15:45:26 -0700822 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
823 void *);
Matt Fleming55839d52011-08-11 10:28:06 +0100824 void *write;
825 void *get_position;
826 void *set_position;
Roy Franzed37ddf2013-09-22 15:45:26 -0700827 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
828 unsigned long *, void *);
Matt Fleming55839d52011-08-11 10:28:06 +0100829 void *set_info;
830 void *flush;
831} efi_file_handle_t;
832
Roy Franzed37ddf2013-09-22 15:45:26 -0700833typedef struct _efi_file_io_interface {
834 u64 revision;
835 int (*open_volume)(struct _efi_file_io_interface *,
836 efi_file_handle_t **);
837} efi_file_io_interface_t;
838
Matt Fleming55839d52011-08-11 10:28:06 +0100839#define EFI_FILE_MODE_READ 0x0000000000000001
840#define EFI_FILE_MODE_WRITE 0x0000000000000002
841#define EFI_FILE_MODE_CREATE 0x8000000000000000
842
Ard Biesheuvelbf924862015-09-09 10:08:15 +0200843typedef struct {
844 u32 version;
845 u32 length;
846 u64 memory_protection_attribute;
847} efi_properties_table_t;
848
849#define EFI_PROPERTIES_TABLE_VERSION 0x00010000
850#define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1
851
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800852#define EFI_INVALID_TABLE_ADDR (~0UL)
853
Ard Biesheuvela604af02016-04-25 21:06:44 +0100854typedef struct {
855 u32 version;
856 u32 num_entries;
857 u32 desc_size;
858 u32 reserved;
859 efi_memory_desc_t entry[0];
860} efi_memory_attributes_table_t;
861
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862/*
863 * All runtime access to EFI goes through this structure:
864 */
865extern struct efi {
866 efi_system_table_t *systab; /* EFI system table */
Matthew Garrett3b370232011-06-06 15:36:25 -0400867 unsigned int runtime_version; /* Runtime services version */
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800868 unsigned long mps; /* MPS table */
869 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
870 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
Ard Biesheuvele1ccbbc2014-10-14 16:34:47 +0200871 unsigned long smbios; /* SMBIOS table (32 bit entry point) */
872 unsigned long smbios3; /* SMBIOS table (64 bit entry point) */
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800873 unsigned long sal_systab; /* SAL system table */
874 unsigned long boot_info; /* boot info table */
875 unsigned long hcdp; /* HCDP table */
876 unsigned long uga; /* UGA table */
Russ Andersona50f70b2008-10-03 11:58:54 -0500877 unsigned long uv_systab; /* UV system table */
Dave Younga0998eb2013-12-20 18:02:17 +0800878 unsigned long fw_vendor; /* fw_vendor */
879 unsigned long runtime; /* runtime table */
880 unsigned long config_table; /* config tables */
Peter Jones0bb54902015-04-28 18:44:31 -0400881 unsigned long esrt; /* ESRT table */
Ard Biesheuvelbf924862015-09-09 10:08:15 +0200882 unsigned long properties_table; /* properties table */
Ard Biesheuvela604af02016-04-25 21:06:44 +0100883 unsigned long mem_attr_table; /* memory attributes table */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 efi_get_time_t *get_time;
885 efi_set_time_t *set_time;
886 efi_get_wakeup_time_t *get_wakeup_time;
887 efi_set_wakeup_time_t *set_wakeup_time;
888 efi_get_variable_t *get_variable;
889 efi_get_next_variable_t *get_next_variable;
890 efi_set_variable_t *set_variable;
Ard Biesheuvel70d2a3c2016-02-01 22:06:56 +0000891 efi_set_variable_t *set_variable_nonblocking;
Matthew Garrett3b370232011-06-06 15:36:25 -0400892 efi_query_variable_info_t *query_variable_info;
Ard Biesheuveld3cac1f2016-02-01 22:06:57 +0000893 efi_query_variable_info_t *query_variable_info_nonblocking;
Matthew Garrett3b370232011-06-06 15:36:25 -0400894 efi_update_capsule_t *update_capsule;
895 efi_query_capsule_caps_t *query_capsule_caps;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 efi_get_next_high_mono_count_t *get_next_high_mono_count;
897 efi_reset_system_t *reset_system;
898 efi_set_virtual_address_map_t *set_virtual_address_map;
Matt Fleming884f4f62016-04-25 21:06:39 +0100899 struct efi_memory_map memmap;
Matt Fleming3e909592014-01-15 13:21:22 +0000900 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901} efi;
902
903static inline int
904efi_guidcmp (efi_guid_t left, efi_guid_t right)
905{
906 return memcmp(&left, &right, sizeof (efi_guid_t));
907}
908
909static inline char *
Borislav Petkov26e02272014-12-18 16:02:17 +0100910efi_guid_to_str(efi_guid_t *guid, char *out)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911{
Joe Perches925ede0bf2009-12-14 18:01:14 -0800912 sprintf(out, "%pUl", guid->b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 return out;
914}
915
916extern void efi_init (void);
917extern void *efi_get_pal_addr (void);
918extern void efi_map_pal_code (void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
920extern void efi_gettimeofday (struct timespec *ts);
921extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
Josh Triplett78510792012-09-28 17:55:44 -0700922#ifdef CONFIG_X86
Josh Triplett2223af32012-09-28 17:57:05 -0700923extern void efi_late_init(void);
Josh Triplett78510792012-09-28 17:55:44 -0700924extern void efi_free_boot_services(void);
Ard Biesheuvelca0e30d2016-02-01 22:06:58 +0000925extern efi_status_t efi_query_variable_store(u32 attributes,
926 unsigned long size,
927 bool nonblocking);
Tony Luckb05b9f52015-06-24 16:58:15 -0700928extern void efi_find_mirror(void);
Josh Triplett78510792012-09-28 17:55:44 -0700929#else
Josh Triplett2223af32012-09-28 17:57:05 -0700930static inline void efi_late_init(void) {}
Josh Triplett78510792012-09-28 17:55:44 -0700931static inline void efi_free_boot_services(void) {}
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000932
Ard Biesheuvelca0e30d2016-02-01 22:06:58 +0000933static inline efi_status_t efi_query_variable_store(u32 attributes,
934 unsigned long size,
935 bool nonblocking)
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000936{
937 return EFI_SUCCESS;
938}
Josh Triplett78510792012-09-28 17:55:44 -0700939#endif
Josh Triplett7bc90e02012-09-28 17:56:08 -0700940extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
Leif Lindholm272686b2013-09-05 11:34:54 +0100941extern int efi_config_init(efi_config_table_type_t *arch_tables);
Peter Jones3846c152015-06-05 15:14:54 -0400942#ifdef CONFIG_EFI_ESRT
Peter Jones0bb54902015-04-28 18:44:31 -0400943extern void __init efi_esrt_init(void);
Peter Jones3846c152015-06-05 15:14:54 -0400944#else
945static inline void efi_esrt_init(void) { }
946#endif
Ard Biesheuvel7bb68412014-10-18 15:04:15 +0200947extern int efi_config_parse_tables(void *config_tables, int count, int sz,
948 efi_config_table_type_t *arch_tables);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949extern u64 efi_get_iobase (void);
950extern u32 efi_mem_type (unsigned long phys_addr);
951extern u64 efi_mem_attributes (unsigned long phys_addr);
Bjorn Helgaas32e62c62006-05-05 17:19:50 -0600952extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953extern int __init efi_uart_console_only (void);
Peter Jones0bb54902015-04-28 18:44:31 -0400954extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
955extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956extern void efi_initialize_iomem_resources(struct resource *code_resource,
Bernhard Walle00bf4092007-10-21 16:42:01 -0700957 struct resource *data_resource, struct resource *bss_resource);
David Vrabel35651842013-05-13 18:56:06 +0100958extern void efi_get_time(struct timespec *now);
Matthew Garrett916f6762011-05-25 09:53:13 -0400959extern void efi_reserve_boot_services(void);
Leif Lindholm7968c0e2015-08-26 14:24:58 +0100960extern int efi_get_fdt_params(struct efi_fdt_params *params);
Peter Jones0bb54902015-04-28 18:44:31 -0400961extern struct kobject *efi_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962
Matt Fleming44be28e2014-06-13 12:39:55 +0100963extern int efi_reboot_quirk_mode;
Matt Fleming0c5ed612014-06-13 12:35:21 +0100964extern bool efi_poweroff_required(void);
965
Taku Izumi0f96a992015-09-30 23:01:56 +0900966#ifdef CONFIG_EFI_FAKE_MEMMAP
967extern void __init efi_fake_memmap(void);
968#else
969static inline void efi_fake_memmap(void) { }
970#endif
971
Ard Biesheuvel10f0d2f52016-04-25 21:06:45 +0100972/*
973 * efi_memattr_perm_setter - arch specific callback function passed into
974 * efi_memattr_apply_permissions() that updates the
975 * mapping permissions described by the second
976 * argument in the page tables referred to by the
977 * first argument.
978 */
979typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *);
980
981extern int efi_memattr_init(void);
982extern int efi_memattr_apply_permissions(struct mm_struct *mm,
983 efi_memattr_perm_setter fn);
984
Mark Saltere885cd82014-01-10 14:26:06 -0500985/* Iterate through an efi_memory_map */
Matt Fleming78ce2482016-04-25 21:06:38 +0100986#define for_each_efi_memory_desc_in_map(m, md) \
Mark Saltere885cd82014-01-10 14:26:06 -0500987 for ((md) = (m)->map; \
988 (md) <= (efi_memory_desc_t *)((m)->map_end - (m)->desc_size); \
989 (md) = (void *)(md) + (m)->desc_size)
990
Matt Fleming78ce2482016-04-25 21:06:38 +0100991/**
992 * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
993 * @md: the efi_memory_desc_t * iterator
994 *
995 * Once the loop finishes @md must not be accessed.
996 */
997#define for_each_efi_memory_desc(md) \
Matt Fleming884f4f62016-04-25 21:06:39 +0100998 for_each_efi_memory_desc_in_map(&efi.memmap, md)
Matt Fleming78ce2482016-04-25 21:06:38 +0100999
Laszlo Ersek98d2a6c2014-09-03 13:32:20 +02001000/*
1001 * Format an EFI memory descriptor's type and attributes to a user-provided
1002 * character buffer, as per snprintf(), and return the buffer.
1003 */
1004char * __init efi_md_typeattr_format(char *buf, size_t size,
1005 const efi_memory_desc_t *md);
1006
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007/**
1008 * efi_range_is_wc - check the WC bit on an address range
1009 * @start: starting kvirt address
1010 * @len: length of range
1011 *
1012 * Consult the EFI memory map and make sure it's ok to set this range WC.
1013 * Returns true or false.
1014 */
1015static inline int efi_range_is_wc(unsigned long start, unsigned long len)
1016{
Jesper Juhl986a80d2005-06-16 15:14:00 -07001017 unsigned long i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
1019 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
1020 unsigned long paddr = __pa(start + i);
1021 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
1022 return 0;
1023 }
1024 /* The range checked out */
1025 return 1;
1026}
1027
1028#ifdef CONFIG_EFI_PCDP
1029extern int __init efi_setup_pcdp_console(char *);
1030#endif
1031
1032/*
Matt Fleming83e68182012-11-14 09:42:35 +00001033 * We play games with efi_enabled so that the compiler will, if
1034 * possible, remove EFI-related code altogether.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 */
Matt Fleming83e68182012-11-14 09:42:35 +00001036#define EFI_BOOT 0 /* Were we booted from EFI? */
Matt Fleming83e68182012-11-14 09:42:35 +00001037#define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
1038#define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
1039#define EFI_MEMMAP 4 /* Can we use EFI memory map? */
1040#define EFI_64BIT 5 /* Is the firmware 64-bit? */
Daniel Kiper9f27bc52014-06-30 19:52:58 +02001041#define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
1042#define EFI_ARCH_1 7 /* First arch-specific bit */
Borislav Petkovfed6cef2015-02-05 11:44:41 +01001043#define EFI_DBG 8 /* Print additional debug info at runtime */
Ard Biesheuvela1041712015-09-23 07:29:34 -07001044#define EFI_NX_PE_DATA 9 /* Can runtime data regions be mapped non-executable? */
Matt Fleming83e68182012-11-14 09:42:35 +00001045
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046#ifdef CONFIG_EFI
Matt Fleming3e909592014-01-15 13:21:22 +00001047/*
1048 * Test whether the above EFI_* bits are enabled.
1049 */
1050static inline bool efi_enabled(int feature)
Matt Fleming83e68182012-11-14 09:42:35 +00001051{
Matt Fleming3e909592014-01-15 13:21:22 +00001052 return test_bit(feature, &efi.flags) != 0;
1053}
Matt Fleming8562c99c2014-06-13 12:22:22 +01001054extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055#else
Matt Fleming3e909592014-01-15 13:21:22 +00001056static inline bool efi_enabled(int feature)
Matt Fleming83e68182012-11-14 09:42:35 +00001057{
Matt Fleming3e909592014-01-15 13:21:22 +00001058 return false;
Matt Fleming83e68182012-11-14 09:42:35 +00001059}
Matt Fleming8562c99c2014-06-13 12:22:22 +01001060static inline void
1061efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062#endif
1063
1064/*
1065 * Variable Attributes
1066 */
1067#define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
1068#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
1069#define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
Matthew Garrett41b32542012-04-30 16:11:29 -04001070#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
1071#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
1072#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
1073#define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
Matthew Garrett41b32542012-04-30 16:11:29 -04001075#define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
1076 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
1077 EFI_VARIABLE_RUNTIME_ACCESS | \
1078 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
1079 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
1080 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
1081 EFI_VARIABLE_APPEND_WRITE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082/*
Matt Fleminge14ab232013-02-03 20:16:40 +00001083 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1084 * not including trailing NUL
1085 */
1086#define EFI_VARIABLE_GUID_LEN 36
1087
1088/*
Matt Fleminge2527a72011-11-15 12:57:26 +00001089 * The type of search to perform when calling boottime->locate_handle
1090 */
1091#define EFI_LOCATE_ALL_HANDLES 0
1092#define EFI_LOCATE_BY_REGISTER_NOTIFY 1
1093#define EFI_LOCATE_BY_PROTOCOL 2
1094
1095/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 * EFI Device Path information
1097 */
1098#define EFI_DEV_HW 0x01
1099#define EFI_DEV_PCI 1
1100#define EFI_DEV_PCCARD 2
1101#define EFI_DEV_MEM_MAPPED 3
1102#define EFI_DEV_VENDOR 4
1103#define EFI_DEV_CONTROLLER 5
1104#define EFI_DEV_ACPI 0x02
1105#define EFI_DEV_BASIC_ACPI 1
1106#define EFI_DEV_EXPANDED_ACPI 2
1107#define EFI_DEV_MSG 0x03
1108#define EFI_DEV_MSG_ATAPI 1
1109#define EFI_DEV_MSG_SCSI 2
1110#define EFI_DEV_MSG_FC 3
1111#define EFI_DEV_MSG_1394 4
1112#define EFI_DEV_MSG_USB 5
1113#define EFI_DEV_MSG_USB_CLASS 15
1114#define EFI_DEV_MSG_I20 6
1115#define EFI_DEV_MSG_MAC 11
1116#define EFI_DEV_MSG_IPV4 12
1117#define EFI_DEV_MSG_IPV6 13
1118#define EFI_DEV_MSG_INFINIBAND 9
1119#define EFI_DEV_MSG_UART 14
1120#define EFI_DEV_MSG_VENDOR 10
1121#define EFI_DEV_MEDIA 0x04
1122#define EFI_DEV_MEDIA_HARD_DRIVE 1
1123#define EFI_DEV_MEDIA_CDROM 2
1124#define EFI_DEV_MEDIA_VENDOR 3
1125#define EFI_DEV_MEDIA_FILE 4
1126#define EFI_DEV_MEDIA_PROTOCOL 5
1127#define EFI_DEV_BIOS_BOOT 0x05
1128#define EFI_DEV_END_PATH 0x7F
1129#define EFI_DEV_END_PATH2 0xFF
1130#define EFI_DEV_END_INSTANCE 0x01
1131#define EFI_DEV_END_ENTIRE 0xFF
1132
1133struct efi_generic_dev_path {
1134 u8 type;
1135 u8 sub_type;
1136 u16 length;
1137} __attribute ((packed));
1138
Huang, Ying4a3575f2008-02-25 15:18:37 +08001139static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1140{
1141 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1142 *addr &= PAGE_MASK;
1143}
1144
Matt Fleming04851772013-02-08 15:48:51 +00001145/*
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001146 * EFI Variable support.
1147 *
1148 * Different firmware drivers can expose their EFI-like variables using
1149 * the following.
1150 */
1151
1152struct efivar_operations {
1153 efi_get_variable_t *get_variable;
1154 efi_get_next_variable_t *get_next_variable;
1155 efi_set_variable_t *set_variable;
Ard Biesheuvel70d2a3c2016-02-01 22:06:56 +00001156 efi_set_variable_t *set_variable_nonblocking;
Matt Fleminga6e4d5a2013-03-25 09:14:30 +00001157 efi_query_variable_store_t *query_variable_store;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001158};
1159
1160struct efivars {
1161 /*
1162 * ->lock protects two things:
Matt Fleming82f990a2014-07-08 12:28:33 +01001163 * 1) efivarfs_list and efivars_sysfs_list
1164 * 2) ->ops calls
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001165 */
1166 spinlock_t lock;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001167 struct kset *kset;
Lee, Chun-Yi605e70c2012-10-05 13:54:56 +08001168 struct kobject *kobject;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001169 const struct efivar_operations *ops;
1170};
1171
Matt Fleminge14ab232013-02-03 20:16:40 +00001172/*
1173 * The maximum size of VariableName + Data = 1024
1174 * Therefore, it's reasonable to save that much
1175 * space in each part of the structure,
1176 * and we use a page for reading/writing.
1177 */
1178
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001179#define EFI_VAR_NAME_LEN 1024
1180
Matt Fleminge14ab232013-02-03 20:16:40 +00001181struct efi_variable {
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001182 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
Matt Fleminge14ab232013-02-03 20:16:40 +00001183 efi_guid_t VendorGuid;
1184 unsigned long DataSize;
1185 __u8 Data[1024];
1186 efi_status_t Status;
1187 __u32 Attributes;
1188} __attribute__((packed));
1189
1190struct efivar_entry {
1191 struct efi_variable var;
1192 struct list_head list;
1193 struct kobject kobj;
Seiji Aguchie0d59732013-10-30 15:27:26 -04001194 bool scanning;
1195 bool deleting;
Matt Fleminge14ab232013-02-03 20:16:40 +00001196};
1197
Matt Fleming677703c2014-01-10 13:47:37 +00001198struct efi_simple_text_output_protocol_32 {
1199 u32 reset;
1200 u32 output_string;
1201 u32 test_string;
1202};
1203
1204struct efi_simple_text_output_protocol_64 {
1205 u64 reset;
1206 u64 output_string;
1207 u64 test_string;
1208};
Roy Franzed37ddf2013-09-22 15:45:26 -07001209
1210struct efi_simple_text_output_protocol {
1211 void *reset;
1212 efi_status_t (*output_string)(void *, void *);
1213 void *test_string;
1214};
1215
Matt Fleming04851772013-02-08 15:48:51 +00001216extern struct list_head efivar_sysfs_list;
1217
1218static inline void
1219efivar_unregister(struct efivar_entry *var)
1220{
1221 kobject_put(&var->kobj);
1222}
1223
Matt Fleminge14ab232013-02-03 20:16:40 +00001224int efivars_register(struct efivars *efivars,
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001225 const struct efivar_operations *ops,
Matt Fleminge14ab232013-02-03 20:16:40 +00001226 struct kobject *kobject);
1227int efivars_unregister(struct efivars *efivars);
1228struct kobject *efivars_kobject(void);
1229
1230int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1231 void *data, bool atomic, bool duplicates,
1232 struct list_head *head);
1233
1234void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1235void efivar_entry_remove(struct efivar_entry *entry);
1236
1237int __efivar_entry_delete(struct efivar_entry *entry);
1238int efivar_entry_delete(struct efivar_entry *entry);
1239
Matt Fleminge14ab232013-02-03 20:16:40 +00001240int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
Matt Fleming8a415b82013-04-29 20:08:02 +01001241int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1242 unsigned long *size, void *data);
Matt Fleminge14ab232013-02-03 20:16:40 +00001243int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1244 unsigned long *size, void *data);
1245int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1246 unsigned long size, void *data, struct list_head *head);
1247int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1248 unsigned long *size, void *data, bool *set);
1249int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1250 bool block, unsigned long size, void *data);
1251
1252void efivar_entry_iter_begin(void);
1253void efivar_entry_iter_end(void);
1254
1255int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1256 struct list_head *head, void *data,
1257 struct efivar_entry **prev);
1258int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1259 struct list_head *head, void *data);
1260
1261struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1262 struct list_head *head, bool remove);
1263
Peter Jones8282f5d2016-02-08 14:48:14 -05001264bool efivar_validate(efi_guid_t vendor, efi_char16_t *var_name, u8 *data,
1265 unsigned long data_size);
Peter Jonesed8b0de2016-02-08 14:48:15 -05001266bool efivar_variable_is_removable(efi_guid_t vendor, const char *name,
1267 size_t len);
Matt Fleminge14ab232013-02-03 20:16:40 +00001268
Tom Gundersena9499fa2013-02-08 15:37:06 +00001269extern struct work_struct efivar_work;
Matt Fleming04851772013-02-08 15:48:51 +00001270void efivar_run_worker(void);
1271
Tom Gundersena9499fa2013-02-08 15:37:06 +00001272#if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
Matt Fleminge14ab232013-02-03 20:16:40 +00001273int efivars_sysfs_init(void);
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001274
Seiji Aguchie0d59732013-10-30 15:27:26 -04001275#define EFIVARS_DATA_SIZE_MAX 1024
1276
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001277#endif /* CONFIG_EFI_VARS */
1278
Dave Young926172d2013-12-20 18:02:18 +08001279#ifdef CONFIG_EFI_RUNTIME_MAP
1280int efi_runtime_map_init(struct kobject *);
1281void efi_runtime_map_setup(void *, int, u32);
Vivek Goyal6a2c20e2014-08-08 14:26:11 -07001282int efi_get_runtime_map_size(void);
1283int efi_get_runtime_map_desc_size(void);
1284int efi_runtime_map_copy(void *buf, size_t bufsz);
Dave Young926172d2013-12-20 18:02:18 +08001285#else
1286static inline int efi_runtime_map_init(struct kobject *kobj)
1287{
1288 return 0;
1289}
1290
1291static inline void
1292efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
Vivek Goyal6a2c20e2014-08-08 14:26:11 -07001293
1294static inline int efi_get_runtime_map_size(void)
1295{
1296 return 0;
1297}
1298
1299static inline int efi_get_runtime_map_desc_size(void)
1300{
1301 return 0;
1302}
1303
1304static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1305{
1306 return 0;
1307}
1308
Dave Young926172d2013-12-20 18:02:18 +08001309#endif
1310
Ard Biesheuvelbd669472014-07-02 14:54:42 +02001311/* prototypes shared between arch specific and generic stub code */
1312
1313#define pr_efi(sys_table, msg) efi_printk(sys_table, "EFI stub: "msg)
1314#define pr_efi_err(sys_table, msg) efi_printk(sys_table, "EFI stub: ERROR: "msg)
1315
1316void efi_printk(efi_system_table_t *sys_table_arg, char *str);
1317
1318void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
1319 unsigned long addr);
1320
1321char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
1322 efi_loaded_image_t *image, int *cmd_line_len);
1323
1324efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
1325 efi_memory_desc_t **map,
1326 unsigned long *map_size,
1327 unsigned long *desc_size,
1328 u32 *desc_ver,
1329 unsigned long *key_ptr);
1330
1331efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
1332 unsigned long size, unsigned long align,
1333 unsigned long *addr);
1334
1335efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
1336 unsigned long size, unsigned long align,
1337 unsigned long *addr, unsigned long max);
1338
1339efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
1340 unsigned long *image_addr,
1341 unsigned long image_size,
1342 unsigned long alloc_size,
1343 unsigned long preferred_addr,
1344 unsigned long alignment);
1345
1346efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
1347 efi_loaded_image_t *image,
1348 char *cmd_line, char *option_string,
1349 unsigned long max_addr,
1350 unsigned long *load_addr,
1351 unsigned long *load_size);
1352
Matt Fleming5a17dae2014-08-05 11:52:11 +01001353efi_status_t efi_parse_options(char *cmdline);
1354
Dave Youngb2e0a542014-08-14 17:15:26 +08001355bool efi_runtime_disabled(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356#endif /* _LINUX_EFI_H */