blob: 85ef051ac6fb43a64c38779c6bf754d2e492abcf [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 */
Tony Luckb05b9f52015-06-24 16:58:15 -0700100#define EFI_MEMORY_MORE_RELIABLE \
101 ((u64)0x0000000000010000ULL) /* higher reliability */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
103#define EFI_MEMORY_DESCRIPTOR_VERSION 1
104
105#define EFI_PAGE_SHIFT 12
Roy Franzed37ddf2013-09-22 15:45:26 -0700106#define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108typedef struct {
109 u32 type;
110 u32 pad;
111 u64 phys_addr;
112 u64 virt_addr;
113 u64 num_pages;
114 u64 attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115} efi_memory_desc_t;
116
Matthew Garrett3b370232011-06-06 15:36:25 -0400117typedef struct {
118 efi_guid_t guid;
119 u32 headersize;
120 u32 flags;
121 u32 imagesize;
122} efi_capsule_header_t;
123
Matt Flemingbb05e4b2011-11-15 12:57:03 +0000124/*
125 * Allocation types for calls to boottime->allocate_pages.
126 */
127#define EFI_ALLOCATE_ANY_PAGES 0
128#define EFI_ALLOCATE_MAX_ADDRESS 1
129#define EFI_ALLOCATE_ADDRESS 2
130#define EFI_MAX_ALLOCATE_TYPE 3
131
Matthew Wilcoxe088a4a2009-05-22 13:49:49 -0700132typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134/*
135 * Types and defines for Time Services
136 */
137#define EFI_TIME_ADJUST_DAYLIGHT 0x1
138#define EFI_TIME_IN_DAYLIGHT 0x2
139#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
140
141typedef struct {
142 u16 year;
143 u8 month;
144 u8 day;
145 u8 hour;
146 u8 minute;
147 u8 second;
148 u8 pad1;
149 u32 nanosecond;
150 s16 timezone;
151 u8 daylight;
152 u8 pad2;
153} efi_time_t;
154
155typedef struct {
156 u32 resolution;
157 u32 accuracy;
158 u8 sets_to_zero;
159} efi_time_cap_t;
160
Matt Fleming677703c2014-01-10 13:47:37 +0000161typedef struct {
162 efi_table_hdr_t hdr;
163 u32 raise_tpl;
164 u32 restore_tpl;
165 u32 allocate_pages;
166 u32 free_pages;
167 u32 get_memory_map;
168 u32 allocate_pool;
169 u32 free_pool;
170 u32 create_event;
171 u32 set_timer;
172 u32 wait_for_event;
173 u32 signal_event;
174 u32 close_event;
175 u32 check_event;
176 u32 install_protocol_interface;
177 u32 reinstall_protocol_interface;
178 u32 uninstall_protocol_interface;
179 u32 handle_protocol;
180 u32 __reserved;
181 u32 register_protocol_notify;
182 u32 locate_handle;
183 u32 locate_device_path;
184 u32 install_configuration_table;
185 u32 load_image;
186 u32 start_image;
187 u32 exit;
188 u32 unload_image;
189 u32 exit_boot_services;
190 u32 get_next_monotonic_count;
191 u32 stall;
192 u32 set_watchdog_timer;
193 u32 connect_controller;
194 u32 disconnect_controller;
195 u32 open_protocol;
196 u32 close_protocol;
197 u32 open_protocol_information;
198 u32 protocols_per_handle;
199 u32 locate_handle_buffer;
200 u32 locate_protocol;
201 u32 install_multiple_protocol_interfaces;
202 u32 uninstall_multiple_protocol_interfaces;
203 u32 calculate_crc32;
204 u32 copy_mem;
205 u32 set_mem;
206 u32 create_event_ex;
207} __packed efi_boot_services_32_t;
208
209typedef struct {
210 efi_table_hdr_t hdr;
211 u64 raise_tpl;
212 u64 restore_tpl;
213 u64 allocate_pages;
214 u64 free_pages;
215 u64 get_memory_map;
216 u64 allocate_pool;
217 u64 free_pool;
218 u64 create_event;
219 u64 set_timer;
220 u64 wait_for_event;
221 u64 signal_event;
222 u64 close_event;
223 u64 check_event;
224 u64 install_protocol_interface;
225 u64 reinstall_protocol_interface;
226 u64 uninstall_protocol_interface;
227 u64 handle_protocol;
228 u64 __reserved;
229 u64 register_protocol_notify;
230 u64 locate_handle;
231 u64 locate_device_path;
232 u64 install_configuration_table;
233 u64 load_image;
234 u64 start_image;
235 u64 exit;
236 u64 unload_image;
237 u64 exit_boot_services;
238 u64 get_next_monotonic_count;
239 u64 stall;
240 u64 set_watchdog_timer;
241 u64 connect_controller;
242 u64 disconnect_controller;
243 u64 open_protocol;
244 u64 close_protocol;
245 u64 open_protocol_information;
246 u64 protocols_per_handle;
247 u64 locate_handle_buffer;
248 u64 locate_protocol;
249 u64 install_multiple_protocol_interfaces;
250 u64 uninstall_multiple_protocol_interfaces;
251 u64 calculate_crc32;
252 u64 copy_mem;
253 u64 set_mem;
254 u64 create_event_ex;
255} __packed efi_boot_services_64_t;
256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257/*
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000258 * EFI Boot Services table
259 */
260typedef struct {
261 efi_table_hdr_t hdr;
262 void *raise_tpl;
263 void *restore_tpl;
Roy Franzed37ddf2013-09-22 15:45:26 -0700264 efi_status_t (*allocate_pages)(int, int, unsigned long,
265 efi_physical_addr_t *);
266 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
267 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
268 unsigned long *, u32 *);
269 efi_status_t (*allocate_pool)(int, unsigned long, void **);
270 efi_status_t (*free_pool)(void *);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000271 void *create_event;
272 void *set_timer;
273 void *wait_for_event;
274 void *signal_event;
275 void *close_event;
276 void *check_event;
277 void *install_protocol_interface;
278 void *reinstall_protocol_interface;
279 void *uninstall_protocol_interface;
Roy Franzed37ddf2013-09-22 15:45:26 -0700280 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000281 void *__reserved;
282 void *register_protocol_notify;
283 void *locate_handle;
284 void *locate_device_path;
285 void *install_configuration_table;
286 void *load_image;
287 void *start_image;
288 void *exit;
289 void *unload_image;
Roy Franzed37ddf2013-09-22 15:45:26 -0700290 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000291 void *get_next_monotonic_count;
292 void *stall;
293 void *set_watchdog_timer;
294 void *connect_controller;
295 void *disconnect_controller;
296 void *open_protocol;
297 void *close_protocol;
298 void *open_protocol_information;
299 void *protocols_per_handle;
300 void *locate_handle_buffer;
301 void *locate_protocol;
302 void *install_multiple_protocol_interfaces;
303 void *uninstall_multiple_protocol_interfaces;
304 void *calculate_crc32;
305 void *copy_mem;
306 void *set_mem;
307 void *create_event_ex;
308} efi_boot_services_t;
309
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700310typedef enum {
311 EfiPciIoWidthUint8,
312 EfiPciIoWidthUint16,
313 EfiPciIoWidthUint32,
314 EfiPciIoWidthUint64,
315 EfiPciIoWidthFifoUint8,
316 EfiPciIoWidthFifoUint16,
317 EfiPciIoWidthFifoUint32,
318 EfiPciIoWidthFifoUint64,
319 EfiPciIoWidthFillUint8,
320 EfiPciIoWidthFillUint16,
321 EfiPciIoWidthFillUint32,
322 EfiPciIoWidthFillUint64,
323 EfiPciIoWidthMaximum
324} EFI_PCI_IO_PROTOCOL_WIDTH;
325
326typedef enum {
327 EfiPciIoAttributeOperationGet,
328 EfiPciIoAttributeOperationSet,
329 EfiPciIoAttributeOperationEnable,
330 EfiPciIoAttributeOperationDisable,
331 EfiPciIoAttributeOperationSupported,
332 EfiPciIoAttributeOperationMaximum
333} EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
334
Matt Fleming677703c2014-01-10 13:47:37 +0000335typedef struct {
336 u32 read;
337 u32 write;
338} efi_pci_io_protocol_access_32_t;
339
340typedef struct {
341 u64 read;
342 u64 write;
343} efi_pci_io_protocol_access_64_t;
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700344
345typedef struct {
346 void *read;
347 void *write;
348} efi_pci_io_protocol_access_t;
349
350typedef struct {
Matt Fleming677703c2014-01-10 13:47:37 +0000351 u32 poll_mem;
352 u32 poll_io;
353 efi_pci_io_protocol_access_32_t mem;
354 efi_pci_io_protocol_access_32_t io;
355 efi_pci_io_protocol_access_32_t pci;
356 u32 copy_mem;
357 u32 map;
358 u32 unmap;
359 u32 allocate_buffer;
360 u32 free_buffer;
361 u32 flush;
362 u32 get_location;
363 u32 attributes;
364 u32 get_bar_attributes;
365 u32 set_bar_attributes;
366 uint64_t romsize;
367 void *romimage;
368} efi_pci_io_protocol_32;
369
370typedef struct {
371 u64 poll_mem;
372 u64 poll_io;
373 efi_pci_io_protocol_access_64_t mem;
374 efi_pci_io_protocol_access_64_t io;
375 efi_pci_io_protocol_access_64_t pci;
376 u64 copy_mem;
377 u64 map;
378 u64 unmap;
379 u64 allocate_buffer;
380 u64 free_buffer;
381 u64 flush;
382 u64 get_location;
383 u64 attributes;
384 u64 get_bar_attributes;
385 u64 set_bar_attributes;
386 uint64_t romsize;
387 void *romimage;
388} efi_pci_io_protocol_64;
389
390typedef struct {
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700391 void *poll_mem;
392 void *poll_io;
393 efi_pci_io_protocol_access_t mem;
394 efi_pci_io_protocol_access_t io;
395 efi_pci_io_protocol_access_t pci;
396 void *copy_mem;
397 void *map;
398 void *unmap;
399 void *allocate_buffer;
400 void *free_buffer;
401 void *flush;
402 void *get_location;
403 void *attributes;
404 void *get_bar_attributes;
405 void *set_bar_attributes;
406 uint64_t romsize;
407 void *romimage;
408} efi_pci_io_protocol;
409
410#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
411#define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
412#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
413#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
414#define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
415#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
416#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
417#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
418#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
419#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
420#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
421#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
422#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
423#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
424#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
425#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
426#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
427#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
428#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
429
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000430/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 * Types and defines for EFI ResetSystem
432 */
433#define EFI_RESET_COLD 0
434#define EFI_RESET_WARM 1
435#define EFI_RESET_SHUTDOWN 2
436
437/*
438 * EFI Runtime Services table
439 */
440#define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
441#define EFI_RUNTIME_SERVICES_REVISION 0x00010000
442
443typedef struct {
444 efi_table_hdr_t hdr;
Matt Fleming677703c2014-01-10 13:47:37 +0000445 u32 get_time;
446 u32 set_time;
447 u32 get_wakeup_time;
448 u32 set_wakeup_time;
449 u32 set_virtual_address_map;
450 u32 convert_pointer;
451 u32 get_variable;
452 u32 get_next_variable;
453 u32 set_variable;
454 u32 get_next_high_mono_count;
455 u32 reset_system;
456 u32 update_capsule;
457 u32 query_capsule_caps;
458 u32 query_variable_info;
459} efi_runtime_services_32_t;
460
461typedef struct {
462 efi_table_hdr_t hdr;
463 u64 get_time;
464 u64 set_time;
465 u64 get_wakeup_time;
466 u64 set_wakeup_time;
467 u64 set_virtual_address_map;
468 u64 convert_pointer;
469 u64 get_variable;
470 u64 get_next_variable;
471 u64 set_variable;
472 u64 get_next_high_mono_count;
473 u64 reset_system;
474 u64 update_capsule;
475 u64 query_capsule_caps;
476 u64 query_variable_info;
477} efi_runtime_services_64_t;
478
479typedef struct {
480 efi_table_hdr_t hdr;
Borislav Petkov43ab0472013-06-02 14:56:07 +0200481 void *get_time;
482 void *set_time;
483 void *get_wakeup_time;
484 void *set_wakeup_time;
485 void *set_virtual_address_map;
486 void *convert_pointer;
487 void *get_variable;
488 void *get_next_variable;
489 void *set_variable;
490 void *get_next_high_mono_count;
491 void *reset_system;
492 void *update_capsule;
493 void *query_capsule_caps;
494 void *query_variable_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495} efi_runtime_services_t;
496
497typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
498typedef efi_status_t efi_set_time_t (efi_time_t *tm);
499typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
500 efi_time_t *tm);
501typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
502typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
503 unsigned long *data_size, void *data);
504typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
505 efi_guid_t *vendor);
506typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
Matthew Garrettf7a2d732011-06-06 15:36:24 -0400507 u32 attr, unsigned long data_size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 void *data);
Matt Fleming6d80dba2014-09-30 21:58:52 +0100509typedef efi_status_t
510efi_set_variable_nonblocking_t(efi_char16_t *name, efi_guid_t *vendor,
511 u32 attr, unsigned long data_size, void *data);
512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
514typedef void efi_reset_system_t (int reset_type, efi_status_t status,
515 unsigned long data_size, efi_char16_t *data);
516typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
517 unsigned long descriptor_size,
518 u32 descriptor_version,
519 efi_memory_desc_t *virtual_map);
Matthew Garrett3b370232011-06-06 15:36:25 -0400520typedef efi_status_t efi_query_variable_info_t(u32 attr,
521 u64 *storage_space,
522 u64 *remaining_space,
523 u64 *max_variable_size);
524typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
525 unsigned long count,
526 unsigned long sg_list);
527typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
528 unsigned long count,
529 u64 *max_size,
530 int *reset_type);
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000531typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
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 \
539 EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
540
541#define MPS_TABLE_GUID \
542 EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
543
544#define ACPI_TABLE_GUID \
545 EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
546
547#define ACPI_20_TABLE_GUID \
548 EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
549
550#define SMBIOS_TABLE_GUID \
551 EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
552
Ard Biesheuvele1ccbbc2014-10-14 16:34:47 +0200553#define SMBIOS3_TABLE_GUID \
554 EFI_GUID( 0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94 )
555
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556#define SAL_SYSTEM_TABLE_GUID \
557 EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
558
559#define HCDP_TABLE_GUID \
560 EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
561
562#define UGA_IO_PROTOCOL_GUID \
563 EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
564
565#define EFI_GLOBAL_VARIABLE_GUID \
566 EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
567
Russ Andersona50f70b2008-10-03 11:58:54 -0500568#define UV_SYSTEM_TABLE_GUID \
569 EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
570
Matthew Garrett5ee9c192011-07-21 16:57:56 -0400571#define LINUX_EFI_CRASH_GUID \
572 EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
573
Matt Fleming8e84f342011-11-15 12:56:50 +0000574#define LOADED_IMAGE_PROTOCOL_GUID \
575 EFI_GUID( 0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
576
Matt Fleming0f7c5d42011-11-15 12:57:16 +0000577#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
578 EFI_GUID( 0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
579
580#define EFI_UGA_PROTOCOL_GUID \
581 EFI_GUID( 0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
582
583#define EFI_PCI_IO_PROTOCOL_GUID \
584 EFI_GUID( 0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
585
Matt Fleming55839d52011-08-11 10:28:06 +0100586#define EFI_FILE_INFO_ID \
587 EFI_GUID( 0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
588
Peter Jones0bb54902015-04-28 18:44:31 -0400589#define EFI_SYSTEM_RESOURCE_TABLE_GUID \
590 EFI_GUID( 0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80 )
591
Matt Fleming55839d52011-08-11 10:28:06 +0100592#define EFI_FILE_SYSTEM_GUID \
593 EFI_GUID( 0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
594
Roy Franz263b4a32014-01-08 17:54:19 -0800595#define DEVICE_TREE_GUID \
596 EFI_GUID( 0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0 )
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 {
Matt Tolentino7ae65fd2005-09-03 15:56:27 -0700679 void *phys_map;
680 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
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800811#define EFI_INVALID_TABLE_ADDR (~0UL)
812
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813/*
814 * All runtime access to EFI goes through this structure:
815 */
816extern struct efi {
817 efi_system_table_t *systab; /* EFI system table */
Matthew Garrett3b370232011-06-06 15:36:25 -0400818 unsigned int runtime_version; /* Runtime services version */
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800819 unsigned long mps; /* MPS table */
820 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
821 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
Ard Biesheuvele1ccbbc2014-10-14 16:34:47 +0200822 unsigned long smbios; /* SMBIOS table (32 bit entry point) */
823 unsigned long smbios3; /* SMBIOS table (64 bit entry point) */
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800824 unsigned long sal_systab; /* SAL system table */
825 unsigned long boot_info; /* boot info table */
826 unsigned long hcdp; /* HCDP table */
827 unsigned long uga; /* UGA table */
Russ Andersona50f70b2008-10-03 11:58:54 -0500828 unsigned long uv_systab; /* UV system table */
Dave Younga0998eb2013-12-20 18:02:17 +0800829 unsigned long fw_vendor; /* fw_vendor */
830 unsigned long runtime; /* runtime table */
831 unsigned long config_table; /* config tables */
Peter Jones0bb54902015-04-28 18:44:31 -0400832 unsigned long esrt; /* ESRT table */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 efi_get_time_t *get_time;
834 efi_set_time_t *set_time;
835 efi_get_wakeup_time_t *get_wakeup_time;
836 efi_set_wakeup_time_t *set_wakeup_time;
837 efi_get_variable_t *get_variable;
838 efi_get_next_variable_t *get_next_variable;
839 efi_set_variable_t *set_variable;
Matt Fleming6d80dba2014-09-30 21:58:52 +0100840 efi_set_variable_nonblocking_t *set_variable_nonblocking;
Matthew Garrett3b370232011-06-06 15:36:25 -0400841 efi_query_variable_info_t *query_variable_info;
842 efi_update_capsule_t *update_capsule;
843 efi_query_capsule_caps_t *query_capsule_caps;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 efi_get_next_high_mono_count_t *get_next_high_mono_count;
845 efi_reset_system_t *reset_system;
846 efi_set_virtual_address_map_t *set_virtual_address_map;
Leif Lindholm258f6fd2013-09-05 11:34:55 +0100847 struct efi_memory_map *memmap;
Matt Fleming3e909592014-01-15 13:21:22 +0000848 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849} efi;
850
851static inline int
852efi_guidcmp (efi_guid_t left, efi_guid_t right)
853{
854 return memcmp(&left, &right, sizeof (efi_guid_t));
855}
856
857static inline char *
Borislav Petkov26e02272014-12-18 16:02:17 +0100858efi_guid_to_str(efi_guid_t *guid, char *out)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859{
Joe Perches925ede0bf2009-12-14 18:01:14 -0800860 sprintf(out, "%pUl", guid->b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 return out;
862}
863
864extern void efi_init (void);
865extern void *efi_get_pal_addr (void);
866extern void efi_map_pal_code (void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
868extern void efi_gettimeofday (struct timespec *ts);
869extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
Josh Triplett78510792012-09-28 17:55:44 -0700870#ifdef CONFIG_X86
Josh Triplett2223af32012-09-28 17:57:05 -0700871extern void efi_late_init(void);
Josh Triplett78510792012-09-28 17:55:44 -0700872extern void efi_free_boot_services(void);
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000873extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
Tony Luckb05b9f52015-06-24 16:58:15 -0700874extern void efi_find_mirror(void);
Josh Triplett78510792012-09-28 17:55:44 -0700875#else
Josh Triplett2223af32012-09-28 17:57:05 -0700876static inline void efi_late_init(void) {}
Josh Triplett78510792012-09-28 17:55:44 -0700877static inline void efi_free_boot_services(void) {}
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000878
879static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
880{
881 return EFI_SUCCESS;
882}
Josh Triplett78510792012-09-28 17:55:44 -0700883#endif
Josh Triplett7bc90e02012-09-28 17:56:08 -0700884extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
Leif Lindholm272686b2013-09-05 11:34:54 +0100885extern int efi_config_init(efi_config_table_type_t *arch_tables);
Peter Jones3846c152015-06-05 15:14:54 -0400886#ifdef CONFIG_EFI_ESRT
Peter Jones0bb54902015-04-28 18:44:31 -0400887extern void __init efi_esrt_init(void);
Peter Jones3846c152015-06-05 15:14:54 -0400888#else
889static inline void efi_esrt_init(void) { }
890#endif
Ard Biesheuvel7bb68412014-10-18 15:04:15 +0200891extern int efi_config_parse_tables(void *config_tables, int count, int sz,
892 efi_config_table_type_t *arch_tables);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893extern u64 efi_get_iobase (void);
894extern u32 efi_mem_type (unsigned long phys_addr);
895extern u64 efi_mem_attributes (unsigned long phys_addr);
Bjorn Helgaas32e62c62006-05-05 17:19:50 -0600896extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897extern int __init efi_uart_console_only (void);
Peter Jones0bb54902015-04-28 18:44:31 -0400898extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
899extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900extern void efi_initialize_iomem_resources(struct resource *code_resource,
Bernhard Walle00bf4092007-10-21 16:42:01 -0700901 struct resource *data_resource, struct resource *bss_resource);
David Vrabel35651842013-05-13 18:56:06 +0100902extern void efi_get_time(struct timespec *now);
Matthew Garrett916f6762011-05-25 09:53:13 -0400903extern void efi_reserve_boot_services(void);
Mark Salter0302f712013-12-30 12:12:12 -0500904extern int efi_get_fdt_params(struct efi_fdt_params *params, int verbose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905extern struct efi_memory_map memmap;
Peter Jones0bb54902015-04-28 18:44:31 -0400906extern struct kobject *efi_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Matt Fleming44be28e2014-06-13 12:39:55 +0100908extern int efi_reboot_quirk_mode;
Matt Fleming0c5ed612014-06-13 12:35:21 +0100909extern bool efi_poweroff_required(void);
910
Mark Saltere885cd82014-01-10 14:26:06 -0500911/* Iterate through an efi_memory_map */
912#define for_each_efi_memory_desc(m, md) \
913 for ((md) = (m)->map; \
914 (md) <= (efi_memory_desc_t *)((m)->map_end - (m)->desc_size); \
915 (md) = (void *)(md) + (m)->desc_size)
916
Laszlo Ersek98d2a6c2014-09-03 13:32:20 +0200917/*
918 * Format an EFI memory descriptor's type and attributes to a user-provided
919 * character buffer, as per snprintf(), and return the buffer.
920 */
921char * __init efi_md_typeattr_format(char *buf, size_t size,
922 const efi_memory_desc_t *md);
923
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924/**
925 * efi_range_is_wc - check the WC bit on an address range
926 * @start: starting kvirt address
927 * @len: length of range
928 *
929 * Consult the EFI memory map and make sure it's ok to set this range WC.
930 * Returns true or false.
931 */
932static inline int efi_range_is_wc(unsigned long start, unsigned long len)
933{
Jesper Juhl986a80d2005-06-16 15:14:00 -0700934 unsigned long i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
936 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
937 unsigned long paddr = __pa(start + i);
938 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
939 return 0;
940 }
941 /* The range checked out */
942 return 1;
943}
944
945#ifdef CONFIG_EFI_PCDP
946extern int __init efi_setup_pcdp_console(char *);
947#endif
948
949/*
Matt Fleming83e68182012-11-14 09:42:35 +0000950 * We play games with efi_enabled so that the compiler will, if
951 * possible, remove EFI-related code altogether.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 */
Matt Fleming83e68182012-11-14 09:42:35 +0000953#define EFI_BOOT 0 /* Were we booted from EFI? */
954#define EFI_SYSTEM_TABLES 1 /* Can we use EFI system tables? */
955#define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
956#define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
957#define EFI_MEMMAP 4 /* Can we use EFI memory map? */
958#define EFI_64BIT 5 /* Is the firmware 64-bit? */
Daniel Kiper9f27bc52014-06-30 19:52:58 +0200959#define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
960#define EFI_ARCH_1 7 /* First arch-specific bit */
Borislav Petkovfed6cef2015-02-05 11:44:41 +0100961#define EFI_DBG 8 /* Print additional debug info at runtime */
Matt Fleming83e68182012-11-14 09:42:35 +0000962
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963#ifdef CONFIG_EFI
Matt Fleming3e909592014-01-15 13:21:22 +0000964/*
965 * Test whether the above EFI_* bits are enabled.
966 */
967static inline bool efi_enabled(int feature)
Matt Fleming83e68182012-11-14 09:42:35 +0000968{
Matt Fleming3e909592014-01-15 13:21:22 +0000969 return test_bit(feature, &efi.flags) != 0;
970}
Matt Fleming8562c99c2014-06-13 12:22:22 +0100971extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972#else
Matt Fleming3e909592014-01-15 13:21:22 +0000973static inline bool efi_enabled(int feature)
Matt Fleming83e68182012-11-14 09:42:35 +0000974{
Matt Fleming3e909592014-01-15 13:21:22 +0000975 return false;
Matt Fleming83e68182012-11-14 09:42:35 +0000976}
Matt Fleming8562c99c2014-06-13 12:22:22 +0100977static inline void
978efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979#endif
980
981/*
982 * Variable Attributes
983 */
984#define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
985#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
986#define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
Matthew Garrett41b32542012-04-30 16:11:29 -0400987#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
988#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
989#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
990#define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Matthew Garrett41b32542012-04-30 16:11:29 -0400992#define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
993 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
994 EFI_VARIABLE_RUNTIME_ACCESS | \
995 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
996 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
997 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
998 EFI_VARIABLE_APPEND_WRITE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999/*
Matt Fleminge14ab232013-02-03 20:16:40 +00001000 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1001 * not including trailing NUL
1002 */
1003#define EFI_VARIABLE_GUID_LEN 36
1004
1005/*
Matt Fleminge2527a72011-11-15 12:57:26 +00001006 * The type of search to perform when calling boottime->locate_handle
1007 */
1008#define EFI_LOCATE_ALL_HANDLES 0
1009#define EFI_LOCATE_BY_REGISTER_NOTIFY 1
1010#define EFI_LOCATE_BY_PROTOCOL 2
1011
1012/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 * EFI Device Path information
1014 */
1015#define EFI_DEV_HW 0x01
1016#define EFI_DEV_PCI 1
1017#define EFI_DEV_PCCARD 2
1018#define EFI_DEV_MEM_MAPPED 3
1019#define EFI_DEV_VENDOR 4
1020#define EFI_DEV_CONTROLLER 5
1021#define EFI_DEV_ACPI 0x02
1022#define EFI_DEV_BASIC_ACPI 1
1023#define EFI_DEV_EXPANDED_ACPI 2
1024#define EFI_DEV_MSG 0x03
1025#define EFI_DEV_MSG_ATAPI 1
1026#define EFI_DEV_MSG_SCSI 2
1027#define EFI_DEV_MSG_FC 3
1028#define EFI_DEV_MSG_1394 4
1029#define EFI_DEV_MSG_USB 5
1030#define EFI_DEV_MSG_USB_CLASS 15
1031#define EFI_DEV_MSG_I20 6
1032#define EFI_DEV_MSG_MAC 11
1033#define EFI_DEV_MSG_IPV4 12
1034#define EFI_DEV_MSG_IPV6 13
1035#define EFI_DEV_MSG_INFINIBAND 9
1036#define EFI_DEV_MSG_UART 14
1037#define EFI_DEV_MSG_VENDOR 10
1038#define EFI_DEV_MEDIA 0x04
1039#define EFI_DEV_MEDIA_HARD_DRIVE 1
1040#define EFI_DEV_MEDIA_CDROM 2
1041#define EFI_DEV_MEDIA_VENDOR 3
1042#define EFI_DEV_MEDIA_FILE 4
1043#define EFI_DEV_MEDIA_PROTOCOL 5
1044#define EFI_DEV_BIOS_BOOT 0x05
1045#define EFI_DEV_END_PATH 0x7F
1046#define EFI_DEV_END_PATH2 0xFF
1047#define EFI_DEV_END_INSTANCE 0x01
1048#define EFI_DEV_END_ENTIRE 0xFF
1049
1050struct efi_generic_dev_path {
1051 u8 type;
1052 u8 sub_type;
1053 u16 length;
1054} __attribute ((packed));
1055
Huang, Ying4a3575f2008-02-25 15:18:37 +08001056static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1057{
1058 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1059 *addr &= PAGE_MASK;
1060}
1061
Matt Fleming04851772013-02-08 15:48:51 +00001062/*
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001063 * EFI Variable support.
1064 *
1065 * Different firmware drivers can expose their EFI-like variables using
1066 * the following.
1067 */
1068
1069struct efivar_operations {
1070 efi_get_variable_t *get_variable;
1071 efi_get_next_variable_t *get_next_variable;
1072 efi_set_variable_t *set_variable;
Matt Fleming6d80dba2014-09-30 21:58:52 +01001073 efi_set_variable_nonblocking_t *set_variable_nonblocking;
Matt Fleminga6e4d5a2013-03-25 09:14:30 +00001074 efi_query_variable_store_t *query_variable_store;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001075};
1076
1077struct efivars {
1078 /*
1079 * ->lock protects two things:
Matt Fleming82f990a2014-07-08 12:28:33 +01001080 * 1) efivarfs_list and efivars_sysfs_list
1081 * 2) ->ops calls
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001082 */
1083 spinlock_t lock;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001084 struct kset *kset;
Lee, Chun-Yi605e70c2012-10-05 13:54:56 +08001085 struct kobject *kobject;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001086 const struct efivar_operations *ops;
1087};
1088
Matt Fleminge14ab232013-02-03 20:16:40 +00001089/*
1090 * The maximum size of VariableName + Data = 1024
1091 * Therefore, it's reasonable to save that much
1092 * space in each part of the structure,
1093 * and we use a page for reading/writing.
1094 */
1095
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001096#define EFI_VAR_NAME_LEN 1024
1097
Matt Fleminge14ab232013-02-03 20:16:40 +00001098struct efi_variable {
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001099 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
Matt Fleminge14ab232013-02-03 20:16:40 +00001100 efi_guid_t VendorGuid;
1101 unsigned long DataSize;
1102 __u8 Data[1024];
1103 efi_status_t Status;
1104 __u32 Attributes;
1105} __attribute__((packed));
1106
1107struct efivar_entry {
1108 struct efi_variable var;
1109 struct list_head list;
1110 struct kobject kobj;
Seiji Aguchie0d59732013-10-30 15:27:26 -04001111 bool scanning;
1112 bool deleting;
Matt Fleminge14ab232013-02-03 20:16:40 +00001113};
1114
Matt Fleming677703c2014-01-10 13:47:37 +00001115struct efi_simple_text_output_protocol_32 {
1116 u32 reset;
1117 u32 output_string;
1118 u32 test_string;
1119};
1120
1121struct efi_simple_text_output_protocol_64 {
1122 u64 reset;
1123 u64 output_string;
1124 u64 test_string;
1125};
Roy Franzed37ddf2013-09-22 15:45:26 -07001126
1127struct efi_simple_text_output_protocol {
1128 void *reset;
1129 efi_status_t (*output_string)(void *, void *);
1130 void *test_string;
1131};
1132
Matt Fleming04851772013-02-08 15:48:51 +00001133extern struct list_head efivar_sysfs_list;
1134
1135static inline void
1136efivar_unregister(struct efivar_entry *var)
1137{
1138 kobject_put(&var->kobj);
1139}
1140
Matt Fleminge14ab232013-02-03 20:16:40 +00001141int efivars_register(struct efivars *efivars,
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001142 const struct efivar_operations *ops,
Matt Fleminge14ab232013-02-03 20:16:40 +00001143 struct kobject *kobject);
1144int efivars_unregister(struct efivars *efivars);
1145struct kobject *efivars_kobject(void);
1146
1147int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1148 void *data, bool atomic, bool duplicates,
1149 struct list_head *head);
1150
1151void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1152void efivar_entry_remove(struct efivar_entry *entry);
1153
1154int __efivar_entry_delete(struct efivar_entry *entry);
1155int efivar_entry_delete(struct efivar_entry *entry);
1156
Matt Fleminge14ab232013-02-03 20:16:40 +00001157int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
Matt Fleming8a415b82013-04-29 20:08:02 +01001158int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1159 unsigned long *size, void *data);
Matt Fleminge14ab232013-02-03 20:16:40 +00001160int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1161 unsigned long *size, void *data);
1162int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1163 unsigned long size, void *data, struct list_head *head);
1164int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1165 unsigned long *size, void *data, bool *set);
1166int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1167 bool block, unsigned long size, void *data);
1168
1169void efivar_entry_iter_begin(void);
1170void efivar_entry_iter_end(void);
1171
1172int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1173 struct list_head *head, void *data,
1174 struct efivar_entry **prev);
1175int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1176 struct list_head *head, void *data);
1177
1178struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1179 struct list_head *head, bool remove);
1180
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001181bool efivar_validate(efi_char16_t *var_name, u8 *data, unsigned long len);
Matt Fleminge14ab232013-02-03 20:16:40 +00001182
Tom Gundersena9499fa2013-02-08 15:37:06 +00001183extern struct work_struct efivar_work;
Matt Fleming04851772013-02-08 15:48:51 +00001184void efivar_run_worker(void);
1185
Tom Gundersena9499fa2013-02-08 15:37:06 +00001186#if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
Matt Fleminge14ab232013-02-03 20:16:40 +00001187int efivars_sysfs_init(void);
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001188
Seiji Aguchie0d59732013-10-30 15:27:26 -04001189#define EFIVARS_DATA_SIZE_MAX 1024
1190
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001191#endif /* CONFIG_EFI_VARS */
1192
Dave Young926172d2013-12-20 18:02:18 +08001193#ifdef CONFIG_EFI_RUNTIME_MAP
1194int efi_runtime_map_init(struct kobject *);
1195void efi_runtime_map_setup(void *, int, u32);
Vivek Goyal6a2c20e2014-08-08 14:26:11 -07001196int efi_get_runtime_map_size(void);
1197int efi_get_runtime_map_desc_size(void);
1198int efi_runtime_map_copy(void *buf, size_t bufsz);
Dave Young926172d2013-12-20 18:02:18 +08001199#else
1200static inline int efi_runtime_map_init(struct kobject *kobj)
1201{
1202 return 0;
1203}
1204
1205static inline void
1206efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
Vivek Goyal6a2c20e2014-08-08 14:26:11 -07001207
1208static inline int efi_get_runtime_map_size(void)
1209{
1210 return 0;
1211}
1212
1213static inline int efi_get_runtime_map_desc_size(void)
1214{
1215 return 0;
1216}
1217
1218static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1219{
1220 return 0;
1221}
1222
Dave Young926172d2013-12-20 18:02:18 +08001223#endif
1224
Ard Biesheuvelbd669472014-07-02 14:54:42 +02001225/* prototypes shared between arch specific and generic stub code */
1226
1227#define pr_efi(sys_table, msg) efi_printk(sys_table, "EFI stub: "msg)
1228#define pr_efi_err(sys_table, msg) efi_printk(sys_table, "EFI stub: ERROR: "msg)
1229
1230void efi_printk(efi_system_table_t *sys_table_arg, char *str);
1231
1232void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
1233 unsigned long addr);
1234
1235char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
1236 efi_loaded_image_t *image, int *cmd_line_len);
1237
1238efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
1239 efi_memory_desc_t **map,
1240 unsigned long *map_size,
1241 unsigned long *desc_size,
1242 u32 *desc_ver,
1243 unsigned long *key_ptr);
1244
1245efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
1246 unsigned long size, unsigned long align,
1247 unsigned long *addr);
1248
1249efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
1250 unsigned long size, unsigned long align,
1251 unsigned long *addr, unsigned long max);
1252
1253efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
1254 unsigned long *image_addr,
1255 unsigned long image_size,
1256 unsigned long alloc_size,
1257 unsigned long preferred_addr,
1258 unsigned long alignment);
1259
1260efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
1261 efi_loaded_image_t *image,
1262 char *cmd_line, char *option_string,
1263 unsigned long max_addr,
1264 unsigned long *load_addr,
1265 unsigned long *load_size);
1266
Matt Fleming5a17dae2014-08-05 11:52:11 +01001267efi_status_t efi_parse_options(char *cmdline);
1268
Dave Youngb2e0a542014-08-14 17:15:26 +08001269bool efi_runtime_disabled(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270#endif /* _LINUX_EFI_H */