blob: 8706e0aabedc91543c089522964ea7d975594270 [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 Fleming8562c992014-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 */
Tony Luckb05b9f52015-06-24 16:58:15 -0700100#define EFI_MEMORY_MORE_RELIABLE \
101 ((u64)0x0000000000010000ULL) /* higher reliability */
Ard Biesheuvel87db73ae2015-08-07 09:36:54 +0100102#define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
104#define EFI_MEMORY_DESCRIPTOR_VERSION 1
105
106#define EFI_PAGE_SHIFT 12
Roy Franzed37ddf2013-09-22 15:45:26 -0700107#define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109typedef struct {
110 u32 type;
111 u32 pad;
112 u64 phys_addr;
113 u64 virt_addr;
114 u64 num_pages;
115 u64 attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116} efi_memory_desc_t;
117
Matthew Garrett3b370232011-06-06 15:36:25 -0400118typedef struct {
119 efi_guid_t guid;
120 u32 headersize;
121 u32 flags;
122 u32 imagesize;
123} efi_capsule_header_t;
124
Matt Flemingbb05e4b2011-11-15 12:57:03 +0000125/*
126 * Allocation types for calls to boottime->allocate_pages.
127 */
128#define EFI_ALLOCATE_ANY_PAGES 0
129#define EFI_ALLOCATE_MAX_ADDRESS 1
130#define EFI_ALLOCATE_ADDRESS 2
131#define EFI_MAX_ALLOCATE_TYPE 3
132
Matthew Wilcoxe088a4a2009-05-22 13:49:49 -0700133typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135/*
136 * Types and defines for Time Services
137 */
138#define EFI_TIME_ADJUST_DAYLIGHT 0x1
139#define EFI_TIME_IN_DAYLIGHT 0x2
140#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
141
142typedef struct {
143 u16 year;
144 u8 month;
145 u8 day;
146 u8 hour;
147 u8 minute;
148 u8 second;
149 u8 pad1;
150 u32 nanosecond;
151 s16 timezone;
152 u8 daylight;
153 u8 pad2;
154} efi_time_t;
155
156typedef struct {
157 u32 resolution;
158 u32 accuracy;
159 u8 sets_to_zero;
160} efi_time_cap_t;
161
Matt Fleming677703c2014-01-10 13:47:37 +0000162typedef struct {
163 efi_table_hdr_t hdr;
164 u32 raise_tpl;
165 u32 restore_tpl;
166 u32 allocate_pages;
167 u32 free_pages;
168 u32 get_memory_map;
169 u32 allocate_pool;
170 u32 free_pool;
171 u32 create_event;
172 u32 set_timer;
173 u32 wait_for_event;
174 u32 signal_event;
175 u32 close_event;
176 u32 check_event;
177 u32 install_protocol_interface;
178 u32 reinstall_protocol_interface;
179 u32 uninstall_protocol_interface;
180 u32 handle_protocol;
181 u32 __reserved;
182 u32 register_protocol_notify;
183 u32 locate_handle;
184 u32 locate_device_path;
185 u32 install_configuration_table;
186 u32 load_image;
187 u32 start_image;
188 u32 exit;
189 u32 unload_image;
190 u32 exit_boot_services;
191 u32 get_next_monotonic_count;
192 u32 stall;
193 u32 set_watchdog_timer;
194 u32 connect_controller;
195 u32 disconnect_controller;
196 u32 open_protocol;
197 u32 close_protocol;
198 u32 open_protocol_information;
199 u32 protocols_per_handle;
200 u32 locate_handle_buffer;
201 u32 locate_protocol;
202 u32 install_multiple_protocol_interfaces;
203 u32 uninstall_multiple_protocol_interfaces;
204 u32 calculate_crc32;
205 u32 copy_mem;
206 u32 set_mem;
207 u32 create_event_ex;
208} __packed efi_boot_services_32_t;
209
210typedef struct {
211 efi_table_hdr_t hdr;
212 u64 raise_tpl;
213 u64 restore_tpl;
214 u64 allocate_pages;
215 u64 free_pages;
216 u64 get_memory_map;
217 u64 allocate_pool;
218 u64 free_pool;
219 u64 create_event;
220 u64 set_timer;
221 u64 wait_for_event;
222 u64 signal_event;
223 u64 close_event;
224 u64 check_event;
225 u64 install_protocol_interface;
226 u64 reinstall_protocol_interface;
227 u64 uninstall_protocol_interface;
228 u64 handle_protocol;
229 u64 __reserved;
230 u64 register_protocol_notify;
231 u64 locate_handle;
232 u64 locate_device_path;
233 u64 install_configuration_table;
234 u64 load_image;
235 u64 start_image;
236 u64 exit;
237 u64 unload_image;
238 u64 exit_boot_services;
239 u64 get_next_monotonic_count;
240 u64 stall;
241 u64 set_watchdog_timer;
242 u64 connect_controller;
243 u64 disconnect_controller;
244 u64 open_protocol;
245 u64 close_protocol;
246 u64 open_protocol_information;
247 u64 protocols_per_handle;
248 u64 locate_handle_buffer;
249 u64 locate_protocol;
250 u64 install_multiple_protocol_interfaces;
251 u64 uninstall_multiple_protocol_interfaces;
252 u64 calculate_crc32;
253 u64 copy_mem;
254 u64 set_mem;
255 u64 create_event_ex;
256} __packed efi_boot_services_64_t;
257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258/*
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000259 * EFI Boot Services table
260 */
261typedef struct {
262 efi_table_hdr_t hdr;
263 void *raise_tpl;
264 void *restore_tpl;
Roy Franzed37ddf2013-09-22 15:45:26 -0700265 efi_status_t (*allocate_pages)(int, int, unsigned long,
266 efi_physical_addr_t *);
267 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
268 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
269 unsigned long *, u32 *);
270 efi_status_t (*allocate_pool)(int, unsigned long, void **);
271 efi_status_t (*free_pool)(void *);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000272 void *create_event;
273 void *set_timer;
274 void *wait_for_event;
275 void *signal_event;
276 void *close_event;
277 void *check_event;
278 void *install_protocol_interface;
279 void *reinstall_protocol_interface;
280 void *uninstall_protocol_interface;
Roy Franzed37ddf2013-09-22 15:45:26 -0700281 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000282 void *__reserved;
283 void *register_protocol_notify;
284 void *locate_handle;
285 void *locate_device_path;
286 void *install_configuration_table;
287 void *load_image;
288 void *start_image;
289 void *exit;
290 void *unload_image;
Roy Franzed37ddf2013-09-22 15:45:26 -0700291 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000292 void *get_next_monotonic_count;
293 void *stall;
294 void *set_watchdog_timer;
295 void *connect_controller;
296 void *disconnect_controller;
297 void *open_protocol;
298 void *close_protocol;
299 void *open_protocol_information;
300 void *protocols_per_handle;
301 void *locate_handle_buffer;
302 void *locate_protocol;
303 void *install_multiple_protocol_interfaces;
304 void *uninstall_multiple_protocol_interfaces;
305 void *calculate_crc32;
306 void *copy_mem;
307 void *set_mem;
308 void *create_event_ex;
309} efi_boot_services_t;
310
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700311typedef enum {
312 EfiPciIoWidthUint8,
313 EfiPciIoWidthUint16,
314 EfiPciIoWidthUint32,
315 EfiPciIoWidthUint64,
316 EfiPciIoWidthFifoUint8,
317 EfiPciIoWidthFifoUint16,
318 EfiPciIoWidthFifoUint32,
319 EfiPciIoWidthFifoUint64,
320 EfiPciIoWidthFillUint8,
321 EfiPciIoWidthFillUint16,
322 EfiPciIoWidthFillUint32,
323 EfiPciIoWidthFillUint64,
324 EfiPciIoWidthMaximum
325} EFI_PCI_IO_PROTOCOL_WIDTH;
326
327typedef enum {
328 EfiPciIoAttributeOperationGet,
329 EfiPciIoAttributeOperationSet,
330 EfiPciIoAttributeOperationEnable,
331 EfiPciIoAttributeOperationDisable,
332 EfiPciIoAttributeOperationSupported,
333 EfiPciIoAttributeOperationMaximum
334} EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
335
Matt Fleming677703c2014-01-10 13:47:37 +0000336typedef struct {
337 u32 read;
338 u32 write;
339} efi_pci_io_protocol_access_32_t;
340
341typedef struct {
342 u64 read;
343 u64 write;
344} efi_pci_io_protocol_access_64_t;
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700345
346typedef struct {
347 void *read;
348 void *write;
349} efi_pci_io_protocol_access_t;
350
351typedef struct {
Matt Fleming677703c2014-01-10 13:47:37 +0000352 u32 poll_mem;
353 u32 poll_io;
354 efi_pci_io_protocol_access_32_t mem;
355 efi_pci_io_protocol_access_32_t io;
356 efi_pci_io_protocol_access_32_t pci;
357 u32 copy_mem;
358 u32 map;
359 u32 unmap;
360 u32 allocate_buffer;
361 u32 free_buffer;
362 u32 flush;
363 u32 get_location;
364 u32 attributes;
365 u32 get_bar_attributes;
366 u32 set_bar_attributes;
367 uint64_t romsize;
368 void *romimage;
369} efi_pci_io_protocol_32;
370
371typedef struct {
372 u64 poll_mem;
373 u64 poll_io;
374 efi_pci_io_protocol_access_64_t mem;
375 efi_pci_io_protocol_access_64_t io;
376 efi_pci_io_protocol_access_64_t pci;
377 u64 copy_mem;
378 u64 map;
379 u64 unmap;
380 u64 allocate_buffer;
381 u64 free_buffer;
382 u64 flush;
383 u64 get_location;
384 u64 attributes;
385 u64 get_bar_attributes;
386 u64 set_bar_attributes;
387 uint64_t romsize;
388 void *romimage;
389} efi_pci_io_protocol_64;
390
391typedef struct {
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700392 void *poll_mem;
393 void *poll_io;
394 efi_pci_io_protocol_access_t mem;
395 efi_pci_io_protocol_access_t io;
396 efi_pci_io_protocol_access_t pci;
397 void *copy_mem;
398 void *map;
399 void *unmap;
400 void *allocate_buffer;
401 void *free_buffer;
402 void *flush;
403 void *get_location;
404 void *attributes;
405 void *get_bar_attributes;
406 void *set_bar_attributes;
407 uint64_t romsize;
408 void *romimage;
409} efi_pci_io_protocol;
410
411#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
412#define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
413#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
414#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
415#define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
416#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
417#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
418#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
419#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
420#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
421#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
422#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
423#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
424#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
425#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
426#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
427#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
428#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
429#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
430
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000431/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 * Types and defines for EFI ResetSystem
433 */
434#define EFI_RESET_COLD 0
435#define EFI_RESET_WARM 1
436#define EFI_RESET_SHUTDOWN 2
437
438/*
439 * EFI Runtime Services table
440 */
441#define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
442#define EFI_RUNTIME_SERVICES_REVISION 0x00010000
443
444typedef struct {
445 efi_table_hdr_t hdr;
Matt Fleming677703c2014-01-10 13:47:37 +0000446 u32 get_time;
447 u32 set_time;
448 u32 get_wakeup_time;
449 u32 set_wakeup_time;
450 u32 set_virtual_address_map;
451 u32 convert_pointer;
452 u32 get_variable;
453 u32 get_next_variable;
454 u32 set_variable;
455 u32 get_next_high_mono_count;
456 u32 reset_system;
457 u32 update_capsule;
458 u32 query_capsule_caps;
459 u32 query_variable_info;
460} efi_runtime_services_32_t;
461
462typedef struct {
463 efi_table_hdr_t hdr;
464 u64 get_time;
465 u64 set_time;
466 u64 get_wakeup_time;
467 u64 set_wakeup_time;
468 u64 set_virtual_address_map;
469 u64 convert_pointer;
470 u64 get_variable;
471 u64 get_next_variable;
472 u64 set_variable;
473 u64 get_next_high_mono_count;
474 u64 reset_system;
475 u64 update_capsule;
476 u64 query_capsule_caps;
477 u64 query_variable_info;
478} efi_runtime_services_64_t;
479
480typedef struct {
481 efi_table_hdr_t hdr;
Borislav Petkov43ab0472013-06-02 14:56:07 +0200482 void *get_time;
483 void *set_time;
484 void *get_wakeup_time;
485 void *set_wakeup_time;
486 void *set_virtual_address_map;
487 void *convert_pointer;
488 void *get_variable;
489 void *get_next_variable;
490 void *set_variable;
491 void *get_next_high_mono_count;
492 void *reset_system;
493 void *update_capsule;
494 void *query_capsule_caps;
495 void *query_variable_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496} efi_runtime_services_t;
497
498typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
499typedef efi_status_t efi_set_time_t (efi_time_t *tm);
500typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
501 efi_time_t *tm);
502typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
503typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
504 unsigned long *data_size, void *data);
505typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
506 efi_guid_t *vendor);
507typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
Matthew Garrettf7a2d732011-06-06 15:36:24 -0400508 u32 attr, unsigned long data_size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 void *data);
510typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
511typedef void efi_reset_system_t (int reset_type, efi_status_t status,
512 unsigned long data_size, efi_char16_t *data);
513typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
514 unsigned long descriptor_size,
515 u32 descriptor_version,
516 efi_memory_desc_t *virtual_map);
Matthew Garrett3b370232011-06-06 15:36:25 -0400517typedef efi_status_t efi_query_variable_info_t(u32 attr,
518 u64 *storage_space,
519 u64 *remaining_space,
520 u64 *max_variable_size);
521typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
522 unsigned long count,
523 unsigned long sg_list);
524typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
525 unsigned long count,
526 u64 *max_size,
527 int *reset_type);
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000528typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Ard Biesheuvel022ee6c2014-06-26 12:09:05 +0200530void efi_native_runtime_setup(void);
531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532/*
533 * EFI Configuration Table and GUID definitions
534 */
535#define NULL_GUID \
536 EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
537
538#define MPS_TABLE_GUID \
539 EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
540
541#define ACPI_TABLE_GUID \
542 EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
543
544#define ACPI_20_TABLE_GUID \
545 EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
546
547#define SMBIOS_TABLE_GUID \
548 EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
549
Ard Biesheuvele1ccbbc2014-10-14 16:34:47 +0200550#define SMBIOS3_TABLE_GUID \
551 EFI_GUID( 0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94 )
552
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553#define SAL_SYSTEM_TABLE_GUID \
554 EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
555
556#define HCDP_TABLE_GUID \
557 EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
558
559#define UGA_IO_PROTOCOL_GUID \
560 EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
561
562#define EFI_GLOBAL_VARIABLE_GUID \
563 EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
564
Russ Andersona50f70b2008-10-03 11:58:54 -0500565#define UV_SYSTEM_TABLE_GUID \
566 EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
567
Matthew Garrett5ee9c192011-07-21 16:57:56 -0400568#define LINUX_EFI_CRASH_GUID \
569 EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
570
Matt Fleming8e84f342011-11-15 12:56:50 +0000571#define LOADED_IMAGE_PROTOCOL_GUID \
572 EFI_GUID( 0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
573
Matt Fleming0f7c5d42011-11-15 12:57:16 +0000574#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
575 EFI_GUID( 0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
576
577#define EFI_UGA_PROTOCOL_GUID \
578 EFI_GUID( 0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
579
580#define EFI_PCI_IO_PROTOCOL_GUID \
581 EFI_GUID( 0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
582
Matt Fleming55839d52011-08-11 10:28:06 +0100583#define EFI_FILE_INFO_ID \
584 EFI_GUID( 0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
585
Peter Jones0bb54902015-04-28 18:44:31 -0400586#define EFI_SYSTEM_RESOURCE_TABLE_GUID \
587 EFI_GUID( 0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80 )
588
Matt Fleming55839d52011-08-11 10:28:06 +0100589#define EFI_FILE_SYSTEM_GUID \
590 EFI_GUID( 0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
591
Roy Franz263b4a32014-01-08 17:54:19 -0800592#define DEVICE_TREE_GUID \
593 EFI_GUID( 0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0 )
594
Ard Biesheuvelbf924862015-09-09 10:08:15 +0200595#define EFI_PROPERTIES_TABLE_GUID \
596 EFI_GUID( 0x880aaca3, 0x4adc, 0x4a04, 0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5 )
597
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598typedef struct {
599 efi_guid_t guid;
Olof Johansson1adbfa32012-02-12 13:24:29 -0800600 u64 table;
601} efi_config_table_64_t;
602
603typedef struct {
604 efi_guid_t guid;
605 u32 table;
606} efi_config_table_32_t;
607
608typedef struct {
609 efi_guid_t guid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 unsigned long table;
611} efi_config_table_t;
612
Leif Lindholm272686b2013-09-05 11:34:54 +0100613typedef struct {
614 efi_guid_t guid;
615 const char *name;
616 unsigned long *ptr;
617} efi_config_table_type_t;
618
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
Matthew Garrett3b370232011-06-06 15:36:25 -0400621#define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
622#define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
623#define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
624#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
625#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
626#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628typedef struct {
629 efi_table_hdr_t hdr;
Olof Johansson1adbfa32012-02-12 13:24:29 -0800630 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
631 u32 fw_revision;
632 u32 __pad1;
633 u64 con_in_handle;
634 u64 con_in;
635 u64 con_out_handle;
636 u64 con_out;
637 u64 stderr_handle;
638 u64 stderr;
639 u64 runtime;
640 u64 boottime;
641 u32 nr_tables;
642 u32 __pad2;
643 u64 tables;
644} efi_system_table_64_t;
645
646typedef struct {
647 efi_table_hdr_t hdr;
648 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
649 u32 fw_revision;
650 u32 con_in_handle;
651 u32 con_in;
652 u32 con_out_handle;
653 u32 con_out;
654 u32 stderr_handle;
655 u32 stderr;
656 u32 runtime;
657 u32 boottime;
658 u32 nr_tables;
659 u32 tables;
660} efi_system_table_32_t;
661
662typedef struct {
663 efi_table_hdr_t hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
665 u32 fw_revision;
666 unsigned long con_in_handle;
667 unsigned long con_in;
668 unsigned long con_out_handle;
669 unsigned long con_out;
670 unsigned long stderr_handle;
671 unsigned long stderr;
672 efi_runtime_services_t *runtime;
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000673 efi_boot_services_t *boottime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 unsigned long nr_tables;
675 unsigned long tables;
676} efi_system_table_t;
677
678struct efi_memory_map {
Ard Biesheuvel44511fb2015-10-23 11:48:16 +0200679 phys_addr_t phys_map;
Matt Tolentino7ae65fd2005-09-03 15:56:27 -0700680 void *map;
681 void *map_end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 int nr_map;
683 unsigned long desc_version;
Matt Tolentino7ae65fd2005-09-03 15:56:27 -0700684 unsigned long desc_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685};
686
Mark Salter0302f712013-12-30 12:12:12 -0500687struct efi_fdt_params {
688 u64 system_table;
689 u64 mmap;
690 u32 mmap_size;
691 u32 desc_size;
692 u32 desc_ver;
693};
694
Matt Fleming8e84f342011-11-15 12:56:50 +0000695typedef struct {
696 u32 revision;
Matt Fleming677703c2014-01-10 13:47:37 +0000697 u32 parent_handle;
698 u32 system_table;
699 u32 device_handle;
700 u32 file_path;
701 u32 reserved;
702 u32 load_options_size;
703 u32 load_options;
704 u32 image_base;
705 __aligned_u64 image_size;
706 unsigned int image_code_type;
707 unsigned int image_data_type;
708 unsigned long unload;
709} efi_loaded_image_32_t;
710
711typedef struct {
712 u32 revision;
713 u64 parent_handle;
714 u64 system_table;
715 u64 device_handle;
716 u64 file_path;
717 u64 reserved;
718 u32 load_options_size;
719 u64 load_options;
720 u64 image_base;
721 __aligned_u64 image_size;
722 unsigned int image_code_type;
723 unsigned int image_data_type;
724 unsigned long unload;
725} efi_loaded_image_64_t;
726
727typedef struct {
728 u32 revision;
Matt Fleming8e84f342011-11-15 12:56:50 +0000729 void *parent_handle;
730 efi_system_table_t *system_table;
731 void *device_handle;
732 void *file_path;
733 void *reserved;
734 u32 load_options_size;
735 void *load_options;
736 void *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_t;
742
Matt Fleming55839d52011-08-11 10:28:06 +0100743
744typedef struct {
745 u64 size;
746 u64 file_size;
747 u64 phys_size;
748 efi_time_t create_time;
749 efi_time_t last_access_time;
750 efi_time_t modification_time;
751 __aligned_u64 attribute;
752 efi_char16_t filename[1];
753} efi_file_info_t;
754
Matt Fleming677703c2014-01-10 13:47:37 +0000755typedef struct {
756 u64 revision;
757 u32 open;
758 u32 close;
759 u32 delete;
760 u32 read;
761 u32 write;
762 u32 get_position;
763 u32 set_position;
764 u32 get_info;
765 u32 set_info;
766 u32 flush;
767} efi_file_handle_32_t;
768
769typedef struct {
770 u64 revision;
771 u64 open;
772 u64 close;
773 u64 delete;
774 u64 read;
775 u64 write;
776 u64 get_position;
777 u64 set_position;
778 u64 get_info;
779 u64 set_info;
780 u64 flush;
781} efi_file_handle_64_t;
782
Roy Franzed37ddf2013-09-22 15:45:26 -0700783typedef struct _efi_file_handle {
Matt Fleming55839d52011-08-11 10:28:06 +0100784 u64 revision;
Roy Franzed37ddf2013-09-22 15:45:26 -0700785 efi_status_t (*open)(struct _efi_file_handle *,
786 struct _efi_file_handle **,
787 efi_char16_t *, u64, u64);
788 efi_status_t (*close)(struct _efi_file_handle *);
Matt Fleming55839d52011-08-11 10:28:06 +0100789 void *delete;
Roy Franzed37ddf2013-09-22 15:45:26 -0700790 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
791 void *);
Matt Fleming55839d52011-08-11 10:28:06 +0100792 void *write;
793 void *get_position;
794 void *set_position;
Roy Franzed37ddf2013-09-22 15:45:26 -0700795 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
796 unsigned long *, void *);
Matt Fleming55839d52011-08-11 10:28:06 +0100797 void *set_info;
798 void *flush;
799} efi_file_handle_t;
800
Roy Franzed37ddf2013-09-22 15:45:26 -0700801typedef struct _efi_file_io_interface {
802 u64 revision;
803 int (*open_volume)(struct _efi_file_io_interface *,
804 efi_file_handle_t **);
805} efi_file_io_interface_t;
806
Matt Fleming55839d52011-08-11 10:28:06 +0100807#define EFI_FILE_MODE_READ 0x0000000000000001
808#define EFI_FILE_MODE_WRITE 0x0000000000000002
809#define EFI_FILE_MODE_CREATE 0x8000000000000000
810
Ard Biesheuvelbf924862015-09-09 10:08:15 +0200811typedef struct {
812 u32 version;
813 u32 length;
814 u64 memory_protection_attribute;
815} efi_properties_table_t;
816
817#define EFI_PROPERTIES_TABLE_VERSION 0x00010000
818#define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1
819
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800820#define EFI_INVALID_TABLE_ADDR (~0UL)
821
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822/*
823 * All runtime access to EFI goes through this structure:
824 */
825extern struct efi {
826 efi_system_table_t *systab; /* EFI system table */
Matthew Garrett3b370232011-06-06 15:36:25 -0400827 unsigned int runtime_version; /* Runtime services version */
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800828 unsigned long mps; /* MPS table */
829 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
830 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
Ard Biesheuvele1ccbbc2014-10-14 16:34:47 +0200831 unsigned long smbios; /* SMBIOS table (32 bit entry point) */
832 unsigned long smbios3; /* SMBIOS table (64 bit entry point) */
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800833 unsigned long sal_systab; /* SAL system table */
834 unsigned long boot_info; /* boot info table */
835 unsigned long hcdp; /* HCDP table */
836 unsigned long uga; /* UGA table */
Russ Andersona50f70b2008-10-03 11:58:54 -0500837 unsigned long uv_systab; /* UV system table */
Dave Younga0998eb2013-12-20 18:02:17 +0800838 unsigned long fw_vendor; /* fw_vendor */
839 unsigned long runtime; /* runtime table */
840 unsigned long config_table; /* config tables */
Peter Jones0bb54902015-04-28 18:44:31 -0400841 unsigned long esrt; /* ESRT table */
Ard Biesheuvelbf924862015-09-09 10:08:15 +0200842 unsigned long properties_table; /* properties table */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 efi_get_time_t *get_time;
844 efi_set_time_t *set_time;
845 efi_get_wakeup_time_t *get_wakeup_time;
846 efi_set_wakeup_time_t *set_wakeup_time;
847 efi_get_variable_t *get_variable;
848 efi_get_next_variable_t *get_next_variable;
849 efi_set_variable_t *set_variable;
Ard Biesheuvel70d2a3c2016-02-01 22:06:56 +0000850 efi_set_variable_t *set_variable_nonblocking;
Matthew Garrett3b370232011-06-06 15:36:25 -0400851 efi_query_variable_info_t *query_variable_info;
852 efi_update_capsule_t *update_capsule;
853 efi_query_capsule_caps_t *query_capsule_caps;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 efi_get_next_high_mono_count_t *get_next_high_mono_count;
855 efi_reset_system_t *reset_system;
856 efi_set_virtual_address_map_t *set_virtual_address_map;
Leif Lindholm258f6fd2013-09-05 11:34:55 +0100857 struct efi_memory_map *memmap;
Matt Fleming3e909592014-01-15 13:21:22 +0000858 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859} efi;
860
861static inline int
862efi_guidcmp (efi_guid_t left, efi_guid_t right)
863{
864 return memcmp(&left, &right, sizeof (efi_guid_t));
865}
866
867static inline char *
Borislav Petkov26e02272014-12-18 16:02:17 +0100868efi_guid_to_str(efi_guid_t *guid, char *out)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869{
Joe Perches925ede0bf2009-12-14 18:01:14 -0800870 sprintf(out, "%pUl", guid->b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 return out;
872}
873
874extern void efi_init (void);
875extern void *efi_get_pal_addr (void);
876extern void efi_map_pal_code (void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
878extern void efi_gettimeofday (struct timespec *ts);
879extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
Josh Triplett78510792012-09-28 17:55:44 -0700880#ifdef CONFIG_X86
Josh Triplett2223af32012-09-28 17:57:05 -0700881extern void efi_late_init(void);
Josh Triplett78510792012-09-28 17:55:44 -0700882extern void efi_free_boot_services(void);
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000883extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
Tony Luckb05b9f52015-06-24 16:58:15 -0700884extern void efi_find_mirror(void);
Josh Triplett78510792012-09-28 17:55:44 -0700885#else
Josh Triplett2223af32012-09-28 17:57:05 -0700886static inline void efi_late_init(void) {}
Josh Triplett78510792012-09-28 17:55:44 -0700887static inline void efi_free_boot_services(void) {}
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000888
889static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
890{
891 return EFI_SUCCESS;
892}
Josh Triplett78510792012-09-28 17:55:44 -0700893#endif
Josh Triplett7bc90e012012-09-28 17:56:08 -0700894extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
Leif Lindholm272686b2013-09-05 11:34:54 +0100895extern int efi_config_init(efi_config_table_type_t *arch_tables);
Peter Jones3846c152015-06-05 15:14:54 -0400896#ifdef CONFIG_EFI_ESRT
Peter Jones0bb54902015-04-28 18:44:31 -0400897extern void __init efi_esrt_init(void);
Peter Jones3846c152015-06-05 15:14:54 -0400898#else
899static inline void efi_esrt_init(void) { }
900#endif
Ard Biesheuvel7bb68412014-10-18 15:04:15 +0200901extern int efi_config_parse_tables(void *config_tables, int count, int sz,
902 efi_config_table_type_t *arch_tables);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903extern u64 efi_get_iobase (void);
904extern u32 efi_mem_type (unsigned long phys_addr);
905extern u64 efi_mem_attributes (unsigned long phys_addr);
Bjorn Helgaas32e62c62006-05-05 17:19:50 -0600906extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907extern int __init efi_uart_console_only (void);
Peter Jones0bb54902015-04-28 18:44:31 -0400908extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
909extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910extern void efi_initialize_iomem_resources(struct resource *code_resource,
Bernhard Walle00bf4092007-10-21 16:42:01 -0700911 struct resource *data_resource, struct resource *bss_resource);
David Vrabel35651842013-05-13 18:56:06 +0100912extern void efi_get_time(struct timespec *now);
Matthew Garrett916f6762011-05-25 09:53:13 -0400913extern void efi_reserve_boot_services(void);
Leif Lindholm7968c0e2015-08-26 14:24:58 +0100914extern int efi_get_fdt_params(struct efi_fdt_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915extern struct efi_memory_map memmap;
Peter Jones0bb54902015-04-28 18:44:31 -0400916extern struct kobject *efi_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
Matt Fleming44be28e2014-06-13 12:39:55 +0100918extern int efi_reboot_quirk_mode;
Matt Fleming0c5ed612014-06-13 12:35:21 +0100919extern bool efi_poweroff_required(void);
920
Taku Izumi0f96a992015-09-30 23:01:56 +0900921#ifdef CONFIG_EFI_FAKE_MEMMAP
922extern void __init efi_fake_memmap(void);
923#else
924static inline void efi_fake_memmap(void) { }
925#endif
926
Mark Saltere885cd82014-01-10 14:26:06 -0500927/* Iterate through an efi_memory_map */
928#define for_each_efi_memory_desc(m, md) \
929 for ((md) = (m)->map; \
930 (md) <= (efi_memory_desc_t *)((m)->map_end - (m)->desc_size); \
931 (md) = (void *)(md) + (m)->desc_size)
932
Laszlo Ersek98d2a6c2014-09-03 13:32:20 +0200933/*
934 * Format an EFI memory descriptor's type and attributes to a user-provided
935 * character buffer, as per snprintf(), and return the buffer.
936 */
937char * __init efi_md_typeattr_format(char *buf, size_t size,
938 const efi_memory_desc_t *md);
939
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940/**
941 * efi_range_is_wc - check the WC bit on an address range
942 * @start: starting kvirt address
943 * @len: length of range
944 *
945 * Consult the EFI memory map and make sure it's ok to set this range WC.
946 * Returns true or false.
947 */
948static inline int efi_range_is_wc(unsigned long start, unsigned long len)
949{
Jesper Juhl986a80d2005-06-16 15:14:00 -0700950 unsigned long i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
952 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
953 unsigned long paddr = __pa(start + i);
954 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
955 return 0;
956 }
957 /* The range checked out */
958 return 1;
959}
960
961#ifdef CONFIG_EFI_PCDP
962extern int __init efi_setup_pcdp_console(char *);
963#endif
964
965/*
Matt Fleming83e68182012-11-14 09:42:35 +0000966 * We play games with efi_enabled so that the compiler will, if
967 * possible, remove EFI-related code altogether.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 */
Matt Fleming83e68182012-11-14 09:42:35 +0000969#define EFI_BOOT 0 /* Were we booted from EFI? */
970#define EFI_SYSTEM_TABLES 1 /* Can we use EFI system tables? */
971#define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
972#define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
973#define EFI_MEMMAP 4 /* Can we use EFI memory map? */
974#define EFI_64BIT 5 /* Is the firmware 64-bit? */
Daniel Kiper9f27bc52014-06-30 19:52:58 +0200975#define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
976#define EFI_ARCH_1 7 /* First arch-specific bit */
Borislav Petkovfed6cef2015-02-05 11:44:41 +0100977#define EFI_DBG 8 /* Print additional debug info at runtime */
Ard Biesheuvela1041712015-09-23 07:29:34 -0700978#define EFI_NX_PE_DATA 9 /* Can runtime data regions be mapped non-executable? */
Matt Fleming83e68182012-11-14 09:42:35 +0000979
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980#ifdef CONFIG_EFI
Matt Fleming3e909592014-01-15 13:21:22 +0000981/*
982 * Test whether the above EFI_* bits are enabled.
983 */
984static inline bool efi_enabled(int feature)
Matt Fleming83e68182012-11-14 09:42:35 +0000985{
Matt Fleming3e909592014-01-15 13:21:22 +0000986 return test_bit(feature, &efi.flags) != 0;
987}
Matt Fleming8562c992014-06-13 12:22:22 +0100988extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989#else
Matt Fleming3e909592014-01-15 13:21:22 +0000990static inline bool efi_enabled(int feature)
Matt Fleming83e68182012-11-14 09:42:35 +0000991{
Matt Fleming3e909592014-01-15 13:21:22 +0000992 return false;
Matt Fleming83e68182012-11-14 09:42:35 +0000993}
Matt Fleming8562c992014-06-13 12:22:22 +0100994static inline void
995efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996#endif
997
998/*
999 * Variable Attributes
1000 */
1001#define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
1002#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
1003#define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
Matthew Garrett41b32542012-04-30 16:11:29 -04001004#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
1005#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
1006#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
1007#define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Matthew Garrett41b32542012-04-30 16:11:29 -04001009#define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
1010 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
1011 EFI_VARIABLE_RUNTIME_ACCESS | \
1012 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
1013 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
1014 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
1015 EFI_VARIABLE_APPEND_WRITE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016/*
Matt Fleminge14ab232013-02-03 20:16:40 +00001017 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1018 * not including trailing NUL
1019 */
1020#define EFI_VARIABLE_GUID_LEN 36
1021
1022/*
Matt Fleminge2527a72011-11-15 12:57:26 +00001023 * The type of search to perform when calling boottime->locate_handle
1024 */
1025#define EFI_LOCATE_ALL_HANDLES 0
1026#define EFI_LOCATE_BY_REGISTER_NOTIFY 1
1027#define EFI_LOCATE_BY_PROTOCOL 2
1028
1029/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 * EFI Device Path information
1031 */
1032#define EFI_DEV_HW 0x01
1033#define EFI_DEV_PCI 1
1034#define EFI_DEV_PCCARD 2
1035#define EFI_DEV_MEM_MAPPED 3
1036#define EFI_DEV_VENDOR 4
1037#define EFI_DEV_CONTROLLER 5
1038#define EFI_DEV_ACPI 0x02
1039#define EFI_DEV_BASIC_ACPI 1
1040#define EFI_DEV_EXPANDED_ACPI 2
1041#define EFI_DEV_MSG 0x03
1042#define EFI_DEV_MSG_ATAPI 1
1043#define EFI_DEV_MSG_SCSI 2
1044#define EFI_DEV_MSG_FC 3
1045#define EFI_DEV_MSG_1394 4
1046#define EFI_DEV_MSG_USB 5
1047#define EFI_DEV_MSG_USB_CLASS 15
1048#define EFI_DEV_MSG_I20 6
1049#define EFI_DEV_MSG_MAC 11
1050#define EFI_DEV_MSG_IPV4 12
1051#define EFI_DEV_MSG_IPV6 13
1052#define EFI_DEV_MSG_INFINIBAND 9
1053#define EFI_DEV_MSG_UART 14
1054#define EFI_DEV_MSG_VENDOR 10
1055#define EFI_DEV_MEDIA 0x04
1056#define EFI_DEV_MEDIA_HARD_DRIVE 1
1057#define EFI_DEV_MEDIA_CDROM 2
1058#define EFI_DEV_MEDIA_VENDOR 3
1059#define EFI_DEV_MEDIA_FILE 4
1060#define EFI_DEV_MEDIA_PROTOCOL 5
1061#define EFI_DEV_BIOS_BOOT 0x05
1062#define EFI_DEV_END_PATH 0x7F
1063#define EFI_DEV_END_PATH2 0xFF
1064#define EFI_DEV_END_INSTANCE 0x01
1065#define EFI_DEV_END_ENTIRE 0xFF
1066
1067struct efi_generic_dev_path {
1068 u8 type;
1069 u8 sub_type;
1070 u16 length;
1071} __attribute ((packed));
1072
Huang, Ying4a3575f2008-02-25 15:18:37 +08001073static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1074{
1075 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1076 *addr &= PAGE_MASK;
1077}
1078
Matt Fleming04851772013-02-08 15:48:51 +00001079/*
Mike Waychison4fc756b2011-03-11 17:43:27 -08001080 * EFI Variable support.
1081 *
1082 * Different firmware drivers can expose their EFI-like variables using
1083 * the following.
1084 */
1085
1086struct efivar_operations {
1087 efi_get_variable_t *get_variable;
1088 efi_get_next_variable_t *get_next_variable;
1089 efi_set_variable_t *set_variable;
Ard Biesheuvel70d2a3c2016-02-01 22:06:56 +00001090 efi_set_variable_t *set_variable_nonblocking;
Matt Fleminga6e4d5a2013-03-25 09:14:30 +00001091 efi_query_variable_store_t *query_variable_store;
Mike Waychison4fc756b2011-03-11 17:43:27 -08001092};
1093
1094struct efivars {
1095 /*
1096 * ->lock protects two things:
Matt Fleming82f990a2014-07-08 12:28:33 +01001097 * 1) efivarfs_list and efivars_sysfs_list
1098 * 2) ->ops calls
Mike Waychison4fc756b2011-03-11 17:43:27 -08001099 */
1100 spinlock_t lock;
Mike Waychison4fc756b2011-03-11 17:43:27 -08001101 struct kset *kset;
Lee, Chun-Yi605e70c2012-10-05 13:54:56 +08001102 struct kobject *kobject;
Mike Waychison4fc756b2011-03-11 17:43:27 -08001103 const struct efivar_operations *ops;
1104};
1105
Matt Fleminge14ab232013-02-03 20:16:40 +00001106/*
1107 * The maximum size of VariableName + Data = 1024
1108 * Therefore, it's reasonable to save that much
1109 * space in each part of the structure,
1110 * and we use a page for reading/writing.
1111 */
1112
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001113#define EFI_VAR_NAME_LEN 1024
1114
Matt Fleminge14ab232013-02-03 20:16:40 +00001115struct efi_variable {
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001116 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
Matt Fleminge14ab232013-02-03 20:16:40 +00001117 efi_guid_t VendorGuid;
1118 unsigned long DataSize;
1119 __u8 Data[1024];
1120 efi_status_t Status;
1121 __u32 Attributes;
1122} __attribute__((packed));
1123
1124struct efivar_entry {
1125 struct efi_variable var;
1126 struct list_head list;
1127 struct kobject kobj;
Seiji Aguchie0d59732013-10-30 15:27:26 -04001128 bool scanning;
1129 bool deleting;
Matt Fleminge14ab232013-02-03 20:16:40 +00001130};
1131
Matt Fleming677703c2014-01-10 13:47:37 +00001132struct efi_simple_text_output_protocol_32 {
1133 u32 reset;
1134 u32 output_string;
1135 u32 test_string;
1136};
1137
1138struct efi_simple_text_output_protocol_64 {
1139 u64 reset;
1140 u64 output_string;
1141 u64 test_string;
1142};
Roy Franzed37ddf2013-09-22 15:45:26 -07001143
1144struct efi_simple_text_output_protocol {
1145 void *reset;
1146 efi_status_t (*output_string)(void *, void *);
1147 void *test_string;
1148};
1149
Matt Fleming04851772013-02-08 15:48:51 +00001150extern struct list_head efivar_sysfs_list;
1151
1152static inline void
1153efivar_unregister(struct efivar_entry *var)
1154{
1155 kobject_put(&var->kobj);
1156}
1157
Matt Fleminge14ab232013-02-03 20:16:40 +00001158int efivars_register(struct efivars *efivars,
Mike Waychison4fc756b2011-03-11 17:43:27 -08001159 const struct efivar_operations *ops,
Matt Fleminge14ab232013-02-03 20:16:40 +00001160 struct kobject *kobject);
1161int efivars_unregister(struct efivars *efivars);
1162struct kobject *efivars_kobject(void);
1163
1164int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1165 void *data, bool atomic, bool duplicates,
1166 struct list_head *head);
1167
1168void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1169void efivar_entry_remove(struct efivar_entry *entry);
1170
1171int __efivar_entry_delete(struct efivar_entry *entry);
1172int efivar_entry_delete(struct efivar_entry *entry);
1173
Matt Fleminge14ab232013-02-03 20:16:40 +00001174int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
Matt Fleming8a415b82013-04-29 20:08:02 +01001175int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1176 unsigned long *size, void *data);
Matt Fleminge14ab232013-02-03 20:16:40 +00001177int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1178 unsigned long *size, void *data);
1179int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1180 unsigned long size, void *data, struct list_head *head);
1181int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1182 unsigned long *size, void *data, bool *set);
1183int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1184 bool block, unsigned long size, void *data);
1185
1186void efivar_entry_iter_begin(void);
1187void efivar_entry_iter_end(void);
1188
1189int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1190 struct list_head *head, void *data,
1191 struct efivar_entry **prev);
1192int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1193 struct list_head *head, void *data);
1194
1195struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1196 struct list_head *head, bool remove);
1197
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001198bool efivar_validate(efi_char16_t *var_name, u8 *data, unsigned long len);
Matt Fleminge14ab232013-02-03 20:16:40 +00001199
Tom Gundersena9499fa2013-02-08 15:37:06 +00001200extern struct work_struct efivar_work;
Matt Fleming04851772013-02-08 15:48:51 +00001201void efivar_run_worker(void);
1202
Tom Gundersena9499fa2013-02-08 15:37:06 +00001203#if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
Matt Fleminge14ab232013-02-03 20:16:40 +00001204int efivars_sysfs_init(void);
Mike Waychison4fc756b2011-03-11 17:43:27 -08001205
Seiji Aguchie0d59732013-10-30 15:27:26 -04001206#define EFIVARS_DATA_SIZE_MAX 1024
1207
Mike Waychison4fc756b2011-03-11 17:43:27 -08001208#endif /* CONFIG_EFI_VARS */
1209
Dave Young926172d2013-12-20 18:02:18 +08001210#ifdef CONFIG_EFI_RUNTIME_MAP
1211int efi_runtime_map_init(struct kobject *);
1212void efi_runtime_map_setup(void *, int, u32);
Vivek Goyal6a2c20e2014-08-08 14:26:11 -07001213int efi_get_runtime_map_size(void);
1214int efi_get_runtime_map_desc_size(void);
1215int efi_runtime_map_copy(void *buf, size_t bufsz);
Dave Young926172d2013-12-20 18:02:18 +08001216#else
1217static inline int efi_runtime_map_init(struct kobject *kobj)
1218{
1219 return 0;
1220}
1221
1222static inline void
1223efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
Vivek Goyal6a2c20e2014-08-08 14:26:11 -07001224
1225static inline int efi_get_runtime_map_size(void)
1226{
1227 return 0;
1228}
1229
1230static inline int efi_get_runtime_map_desc_size(void)
1231{
1232 return 0;
1233}
1234
1235static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1236{
1237 return 0;
1238}
1239
Dave Young926172d2013-12-20 18:02:18 +08001240#endif
1241
Ard Biesheuvelbd669472014-07-02 14:54:42 +02001242/* prototypes shared between arch specific and generic stub code */
1243
1244#define pr_efi(sys_table, msg) efi_printk(sys_table, "EFI stub: "msg)
1245#define pr_efi_err(sys_table, msg) efi_printk(sys_table, "EFI stub: ERROR: "msg)
1246
1247void efi_printk(efi_system_table_t *sys_table_arg, char *str);
1248
1249void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
1250 unsigned long addr);
1251
1252char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
1253 efi_loaded_image_t *image, int *cmd_line_len);
1254
1255efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
1256 efi_memory_desc_t **map,
1257 unsigned long *map_size,
1258 unsigned long *desc_size,
1259 u32 *desc_ver,
1260 unsigned long *key_ptr);
1261
1262efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
1263 unsigned long size, unsigned long align,
1264 unsigned long *addr);
1265
1266efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
1267 unsigned long size, unsigned long align,
1268 unsigned long *addr, unsigned long max);
1269
1270efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
1271 unsigned long *image_addr,
1272 unsigned long image_size,
1273 unsigned long alloc_size,
1274 unsigned long preferred_addr,
1275 unsigned long alignment);
1276
1277efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
1278 efi_loaded_image_t *image,
1279 char *cmd_line, char *option_string,
1280 unsigned long max_addr,
1281 unsigned long *load_addr,
1282 unsigned long *load_size);
1283
Matt Fleming5a17dae2014-08-05 11:52:11 +01001284efi_status_t efi_parse_options(char *cmdline);
1285
Dave Youngb2e0a542014-08-14 17:15:26 +08001286bool efi_runtime_disabled(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287#endif /* _LINUX_EFI_H */