blob: 45cb4ffdea621281aa2068676b9cad9115e48c65 [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
88#define EFI_MAX_MEMORY_TYPE 14
89
90/* Attribute values: */
91#define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
92#define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
93#define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
94#define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
95#define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
96#define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
97#define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
98#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
99#define EFI_MEMORY_DESCRIPTOR_VERSION 1
100
101#define EFI_PAGE_SHIFT 12
Roy Franzed37ddf2013-09-22 15:45:26 -0700102#define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104typedef struct {
105 u32 type;
106 u32 pad;
107 u64 phys_addr;
108 u64 virt_addr;
109 u64 num_pages;
110 u64 attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111} efi_memory_desc_t;
112
Matthew Garrett3b370232011-06-06 15:36:25 -0400113typedef struct {
114 efi_guid_t guid;
115 u32 headersize;
116 u32 flags;
117 u32 imagesize;
118} efi_capsule_header_t;
119
Matt Flemingbb05e4b2011-11-15 12:57:03 +0000120/*
121 * Allocation types for calls to boottime->allocate_pages.
122 */
123#define EFI_ALLOCATE_ANY_PAGES 0
124#define EFI_ALLOCATE_MAX_ADDRESS 1
125#define EFI_ALLOCATE_ADDRESS 2
126#define EFI_MAX_ALLOCATE_TYPE 3
127
Matthew Wilcoxe088a4a2009-05-22 13:49:49 -0700128typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130/*
131 * Types and defines for Time Services
132 */
133#define EFI_TIME_ADJUST_DAYLIGHT 0x1
134#define EFI_TIME_IN_DAYLIGHT 0x2
135#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
136
137typedef struct {
138 u16 year;
139 u8 month;
140 u8 day;
141 u8 hour;
142 u8 minute;
143 u8 second;
144 u8 pad1;
145 u32 nanosecond;
146 s16 timezone;
147 u8 daylight;
148 u8 pad2;
149} efi_time_t;
150
151typedef struct {
152 u32 resolution;
153 u32 accuracy;
154 u8 sets_to_zero;
155} efi_time_cap_t;
156
Matt Fleming677703c2014-01-10 13:47:37 +0000157typedef struct {
158 efi_table_hdr_t hdr;
159 u32 raise_tpl;
160 u32 restore_tpl;
161 u32 allocate_pages;
162 u32 free_pages;
163 u32 get_memory_map;
164 u32 allocate_pool;
165 u32 free_pool;
166 u32 create_event;
167 u32 set_timer;
168 u32 wait_for_event;
169 u32 signal_event;
170 u32 close_event;
171 u32 check_event;
172 u32 install_protocol_interface;
173 u32 reinstall_protocol_interface;
174 u32 uninstall_protocol_interface;
175 u32 handle_protocol;
176 u32 __reserved;
177 u32 register_protocol_notify;
178 u32 locate_handle;
179 u32 locate_device_path;
180 u32 install_configuration_table;
181 u32 load_image;
182 u32 start_image;
183 u32 exit;
184 u32 unload_image;
185 u32 exit_boot_services;
186 u32 get_next_monotonic_count;
187 u32 stall;
188 u32 set_watchdog_timer;
189 u32 connect_controller;
190 u32 disconnect_controller;
191 u32 open_protocol;
192 u32 close_protocol;
193 u32 open_protocol_information;
194 u32 protocols_per_handle;
195 u32 locate_handle_buffer;
196 u32 locate_protocol;
197 u32 install_multiple_protocol_interfaces;
198 u32 uninstall_multiple_protocol_interfaces;
199 u32 calculate_crc32;
200 u32 copy_mem;
201 u32 set_mem;
202 u32 create_event_ex;
203} __packed efi_boot_services_32_t;
204
205typedef struct {
206 efi_table_hdr_t hdr;
207 u64 raise_tpl;
208 u64 restore_tpl;
209 u64 allocate_pages;
210 u64 free_pages;
211 u64 get_memory_map;
212 u64 allocate_pool;
213 u64 free_pool;
214 u64 create_event;
215 u64 set_timer;
216 u64 wait_for_event;
217 u64 signal_event;
218 u64 close_event;
219 u64 check_event;
220 u64 install_protocol_interface;
221 u64 reinstall_protocol_interface;
222 u64 uninstall_protocol_interface;
223 u64 handle_protocol;
224 u64 __reserved;
225 u64 register_protocol_notify;
226 u64 locate_handle;
227 u64 locate_device_path;
228 u64 install_configuration_table;
229 u64 load_image;
230 u64 start_image;
231 u64 exit;
232 u64 unload_image;
233 u64 exit_boot_services;
234 u64 get_next_monotonic_count;
235 u64 stall;
236 u64 set_watchdog_timer;
237 u64 connect_controller;
238 u64 disconnect_controller;
239 u64 open_protocol;
240 u64 close_protocol;
241 u64 open_protocol_information;
242 u64 protocols_per_handle;
243 u64 locate_handle_buffer;
244 u64 locate_protocol;
245 u64 install_multiple_protocol_interfaces;
246 u64 uninstall_multiple_protocol_interfaces;
247 u64 calculate_crc32;
248 u64 copy_mem;
249 u64 set_mem;
250 u64 create_event_ex;
251} __packed efi_boot_services_64_t;
252
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253/*
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000254 * EFI Boot Services table
255 */
256typedef struct {
257 efi_table_hdr_t hdr;
258 void *raise_tpl;
259 void *restore_tpl;
Roy Franzed37ddf2013-09-22 15:45:26 -0700260 efi_status_t (*allocate_pages)(int, int, unsigned long,
261 efi_physical_addr_t *);
262 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
263 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
264 unsigned long *, u32 *);
265 efi_status_t (*allocate_pool)(int, unsigned long, void **);
266 efi_status_t (*free_pool)(void *);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000267 void *create_event;
268 void *set_timer;
269 void *wait_for_event;
270 void *signal_event;
271 void *close_event;
272 void *check_event;
273 void *install_protocol_interface;
274 void *reinstall_protocol_interface;
275 void *uninstall_protocol_interface;
Roy Franzed37ddf2013-09-22 15:45:26 -0700276 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000277 void *__reserved;
278 void *register_protocol_notify;
279 void *locate_handle;
280 void *locate_device_path;
281 void *install_configuration_table;
282 void *load_image;
283 void *start_image;
284 void *exit;
285 void *unload_image;
Roy Franzed37ddf2013-09-22 15:45:26 -0700286 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000287 void *get_next_monotonic_count;
288 void *stall;
289 void *set_watchdog_timer;
290 void *connect_controller;
291 void *disconnect_controller;
292 void *open_protocol;
293 void *close_protocol;
294 void *open_protocol_information;
295 void *protocols_per_handle;
296 void *locate_handle_buffer;
297 void *locate_protocol;
298 void *install_multiple_protocol_interfaces;
299 void *uninstall_multiple_protocol_interfaces;
300 void *calculate_crc32;
301 void *copy_mem;
302 void *set_mem;
303 void *create_event_ex;
304} efi_boot_services_t;
305
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700306typedef enum {
307 EfiPciIoWidthUint8,
308 EfiPciIoWidthUint16,
309 EfiPciIoWidthUint32,
310 EfiPciIoWidthUint64,
311 EfiPciIoWidthFifoUint8,
312 EfiPciIoWidthFifoUint16,
313 EfiPciIoWidthFifoUint32,
314 EfiPciIoWidthFifoUint64,
315 EfiPciIoWidthFillUint8,
316 EfiPciIoWidthFillUint16,
317 EfiPciIoWidthFillUint32,
318 EfiPciIoWidthFillUint64,
319 EfiPciIoWidthMaximum
320} EFI_PCI_IO_PROTOCOL_WIDTH;
321
322typedef enum {
323 EfiPciIoAttributeOperationGet,
324 EfiPciIoAttributeOperationSet,
325 EfiPciIoAttributeOperationEnable,
326 EfiPciIoAttributeOperationDisable,
327 EfiPciIoAttributeOperationSupported,
328 EfiPciIoAttributeOperationMaximum
329} EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
330
Matt Fleming677703c2014-01-10 13:47:37 +0000331typedef struct {
332 u32 read;
333 u32 write;
334} efi_pci_io_protocol_access_32_t;
335
336typedef struct {
337 u64 read;
338 u64 write;
339} efi_pci_io_protocol_access_64_t;
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700340
341typedef struct {
342 void *read;
343 void *write;
344} efi_pci_io_protocol_access_t;
345
346typedef struct {
Matt Fleming677703c2014-01-10 13:47:37 +0000347 u32 poll_mem;
348 u32 poll_io;
349 efi_pci_io_protocol_access_32_t mem;
350 efi_pci_io_protocol_access_32_t io;
351 efi_pci_io_protocol_access_32_t pci;
352 u32 copy_mem;
353 u32 map;
354 u32 unmap;
355 u32 allocate_buffer;
356 u32 free_buffer;
357 u32 flush;
358 u32 get_location;
359 u32 attributes;
360 u32 get_bar_attributes;
361 u32 set_bar_attributes;
362 uint64_t romsize;
363 void *romimage;
364} efi_pci_io_protocol_32;
365
366typedef struct {
367 u64 poll_mem;
368 u64 poll_io;
369 efi_pci_io_protocol_access_64_t mem;
370 efi_pci_io_protocol_access_64_t io;
371 efi_pci_io_protocol_access_64_t pci;
372 u64 copy_mem;
373 u64 map;
374 u64 unmap;
375 u64 allocate_buffer;
376 u64 free_buffer;
377 u64 flush;
378 u64 get_location;
379 u64 attributes;
380 u64 get_bar_attributes;
381 u64 set_bar_attributes;
382 uint64_t romsize;
383 void *romimage;
384} efi_pci_io_protocol_64;
385
386typedef struct {
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700387 void *poll_mem;
388 void *poll_io;
389 efi_pci_io_protocol_access_t mem;
390 efi_pci_io_protocol_access_t io;
391 efi_pci_io_protocol_access_t pci;
392 void *copy_mem;
393 void *map;
394 void *unmap;
395 void *allocate_buffer;
396 void *free_buffer;
397 void *flush;
398 void *get_location;
399 void *attributes;
400 void *get_bar_attributes;
401 void *set_bar_attributes;
402 uint64_t romsize;
403 void *romimage;
404} efi_pci_io_protocol;
405
406#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
407#define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
408#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
409#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
410#define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
411#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
412#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
413#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
414#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
415#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
416#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
417#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
418#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
419#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
420#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
421#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
422#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
423#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
424#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
425
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000426/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 * Types and defines for EFI ResetSystem
428 */
429#define EFI_RESET_COLD 0
430#define EFI_RESET_WARM 1
431#define EFI_RESET_SHUTDOWN 2
432
433/*
434 * EFI Runtime Services table
435 */
436#define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
437#define EFI_RUNTIME_SERVICES_REVISION 0x00010000
438
439typedef struct {
440 efi_table_hdr_t hdr;
Matt Fleming677703c2014-01-10 13:47:37 +0000441 u32 get_time;
442 u32 set_time;
443 u32 get_wakeup_time;
444 u32 set_wakeup_time;
445 u32 set_virtual_address_map;
446 u32 convert_pointer;
447 u32 get_variable;
448 u32 get_next_variable;
449 u32 set_variable;
450 u32 get_next_high_mono_count;
451 u32 reset_system;
452 u32 update_capsule;
453 u32 query_capsule_caps;
454 u32 query_variable_info;
455} efi_runtime_services_32_t;
456
457typedef struct {
458 efi_table_hdr_t hdr;
459 u64 get_time;
460 u64 set_time;
461 u64 get_wakeup_time;
462 u64 set_wakeup_time;
463 u64 set_virtual_address_map;
464 u64 convert_pointer;
465 u64 get_variable;
466 u64 get_next_variable;
467 u64 set_variable;
468 u64 get_next_high_mono_count;
469 u64 reset_system;
470 u64 update_capsule;
471 u64 query_capsule_caps;
472 u64 query_variable_info;
473} efi_runtime_services_64_t;
474
475typedef struct {
476 efi_table_hdr_t hdr;
Borislav Petkov43ab0472013-06-02 14:56:07 +0200477 void *get_time;
478 void *set_time;
479 void *get_wakeup_time;
480 void *set_wakeup_time;
481 void *set_virtual_address_map;
482 void *convert_pointer;
483 void *get_variable;
484 void *get_next_variable;
485 void *set_variable;
486 void *get_next_high_mono_count;
487 void *reset_system;
488 void *update_capsule;
489 void *query_capsule_caps;
490 void *query_variable_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491} efi_runtime_services_t;
492
493typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
494typedef efi_status_t efi_set_time_t (efi_time_t *tm);
495typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
496 efi_time_t *tm);
497typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
498typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
499 unsigned long *data_size, void *data);
500typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
501 efi_guid_t *vendor);
502typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
Matthew Garrettf7a2d732011-06-06 15:36:24 -0400503 u32 attr, unsigned long data_size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 void *data);
505typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
506typedef void efi_reset_system_t (int reset_type, efi_status_t status,
507 unsigned long data_size, efi_char16_t *data);
508typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
509 unsigned long descriptor_size,
510 u32 descriptor_version,
511 efi_memory_desc_t *virtual_map);
Matthew Garrett3b370232011-06-06 15:36:25 -0400512typedef efi_status_t efi_query_variable_info_t(u32 attr,
513 u64 *storage_space,
514 u64 *remaining_space,
515 u64 *max_variable_size);
516typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
517 unsigned long count,
518 unsigned long sg_list);
519typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
520 unsigned long count,
521 u64 *max_size,
522 int *reset_type);
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000523typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Ard Biesheuvel022ee6c2014-06-26 12:09:05 +0200525void efi_native_runtime_setup(void);
526
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527/*
528 * EFI Configuration Table and GUID definitions
529 */
530#define NULL_GUID \
531 EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
532
533#define MPS_TABLE_GUID \
534 EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
535
536#define ACPI_TABLE_GUID \
537 EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
538
539#define ACPI_20_TABLE_GUID \
540 EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
541
542#define SMBIOS_TABLE_GUID \
543 EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
544
545#define SAL_SYSTEM_TABLE_GUID \
546 EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
547
548#define HCDP_TABLE_GUID \
549 EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
550
551#define UGA_IO_PROTOCOL_GUID \
552 EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
553
554#define EFI_GLOBAL_VARIABLE_GUID \
555 EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
556
Russ Andersona50f70b2008-10-03 11:58:54 -0500557#define UV_SYSTEM_TABLE_GUID \
558 EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
559
Matthew Garrett5ee9c192011-07-21 16:57:56 -0400560#define LINUX_EFI_CRASH_GUID \
561 EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
562
Matt Fleming8e84f342011-11-15 12:56:50 +0000563#define LOADED_IMAGE_PROTOCOL_GUID \
564 EFI_GUID( 0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
565
Matt Fleming0f7c5d42011-11-15 12:57:16 +0000566#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
567 EFI_GUID( 0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
568
569#define EFI_UGA_PROTOCOL_GUID \
570 EFI_GUID( 0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
571
572#define EFI_PCI_IO_PROTOCOL_GUID \
573 EFI_GUID( 0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
574
Matt Fleming55839d52011-08-11 10:28:06 +0100575#define EFI_FILE_INFO_ID \
576 EFI_GUID( 0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
577
578#define EFI_FILE_SYSTEM_GUID \
579 EFI_GUID( 0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
580
Roy Franz263b4a32014-01-08 17:54:19 -0800581#define DEVICE_TREE_GUID \
582 EFI_GUID( 0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0 )
583
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584typedef struct {
585 efi_guid_t guid;
Olof Johansson1adbfa32012-02-12 13:24:29 -0800586 u64 table;
587} efi_config_table_64_t;
588
589typedef struct {
590 efi_guid_t guid;
591 u32 table;
592} efi_config_table_32_t;
593
594typedef struct {
595 efi_guid_t guid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 unsigned long table;
597} efi_config_table_t;
598
Leif Lindholm272686b2013-09-05 11:34:54 +0100599typedef struct {
600 efi_guid_t guid;
601 const char *name;
602 unsigned long *ptr;
603} efi_config_table_type_t;
604
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
Matthew Garrett3b370232011-06-06 15:36:25 -0400607#define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
608#define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
609#define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
610#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
611#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
612#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614typedef struct {
615 efi_table_hdr_t hdr;
Olof Johansson1adbfa32012-02-12 13:24:29 -0800616 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
617 u32 fw_revision;
618 u32 __pad1;
619 u64 con_in_handle;
620 u64 con_in;
621 u64 con_out_handle;
622 u64 con_out;
623 u64 stderr_handle;
624 u64 stderr;
625 u64 runtime;
626 u64 boottime;
627 u32 nr_tables;
628 u32 __pad2;
629 u64 tables;
630} efi_system_table_64_t;
631
632typedef struct {
633 efi_table_hdr_t hdr;
634 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
635 u32 fw_revision;
636 u32 con_in_handle;
637 u32 con_in;
638 u32 con_out_handle;
639 u32 con_out;
640 u32 stderr_handle;
641 u32 stderr;
642 u32 runtime;
643 u32 boottime;
644 u32 nr_tables;
645 u32 tables;
646} efi_system_table_32_t;
647
648typedef struct {
649 efi_table_hdr_t hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
651 u32 fw_revision;
652 unsigned long con_in_handle;
653 unsigned long con_in;
654 unsigned long con_out_handle;
655 unsigned long con_out;
656 unsigned long stderr_handle;
657 unsigned long stderr;
658 efi_runtime_services_t *runtime;
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000659 efi_boot_services_t *boottime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 unsigned long nr_tables;
661 unsigned long tables;
662} efi_system_table_t;
663
664struct efi_memory_map {
Matt Tolentino7ae65fd2005-09-03 15:56:27 -0700665 void *phys_map;
666 void *map;
667 void *map_end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 int nr_map;
669 unsigned long desc_version;
Matt Tolentino7ae65fd2005-09-03 15:56:27 -0700670 unsigned long desc_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671};
672
Mark Salter0302f712013-12-30 12:12:12 -0500673struct efi_fdt_params {
674 u64 system_table;
675 u64 mmap;
676 u32 mmap_size;
677 u32 desc_size;
678 u32 desc_ver;
679};
680
Matt Fleming8e84f342011-11-15 12:56:50 +0000681typedef struct {
682 u32 revision;
Matt Fleming677703c2014-01-10 13:47:37 +0000683 u32 parent_handle;
684 u32 system_table;
685 u32 device_handle;
686 u32 file_path;
687 u32 reserved;
688 u32 load_options_size;
689 u32 load_options;
690 u32 image_base;
691 __aligned_u64 image_size;
692 unsigned int image_code_type;
693 unsigned int image_data_type;
694 unsigned long unload;
695} efi_loaded_image_32_t;
696
697typedef struct {
698 u32 revision;
699 u64 parent_handle;
700 u64 system_table;
701 u64 device_handle;
702 u64 file_path;
703 u64 reserved;
704 u32 load_options_size;
705 u64 load_options;
706 u64 image_base;
707 __aligned_u64 image_size;
708 unsigned int image_code_type;
709 unsigned int image_data_type;
710 unsigned long unload;
711} efi_loaded_image_64_t;
712
713typedef struct {
714 u32 revision;
Matt Fleming8e84f342011-11-15 12:56:50 +0000715 void *parent_handle;
716 efi_system_table_t *system_table;
717 void *device_handle;
718 void *file_path;
719 void *reserved;
720 u32 load_options_size;
721 void *load_options;
722 void *image_base;
723 __aligned_u64 image_size;
724 unsigned int image_code_type;
725 unsigned int image_data_type;
726 unsigned long unload;
727} efi_loaded_image_t;
728
Matt Fleming55839d52011-08-11 10:28:06 +0100729
730typedef struct {
731 u64 size;
732 u64 file_size;
733 u64 phys_size;
734 efi_time_t create_time;
735 efi_time_t last_access_time;
736 efi_time_t modification_time;
737 __aligned_u64 attribute;
738 efi_char16_t filename[1];
739} efi_file_info_t;
740
Matt Fleming677703c2014-01-10 13:47:37 +0000741typedef struct {
742 u64 revision;
743 u32 open;
744 u32 close;
745 u32 delete;
746 u32 read;
747 u32 write;
748 u32 get_position;
749 u32 set_position;
750 u32 get_info;
751 u32 set_info;
752 u32 flush;
753} efi_file_handle_32_t;
754
755typedef struct {
756 u64 revision;
757 u64 open;
758 u64 close;
759 u64 delete;
760 u64 read;
761 u64 write;
762 u64 get_position;
763 u64 set_position;
764 u64 get_info;
765 u64 set_info;
766 u64 flush;
767} efi_file_handle_64_t;
768
Roy Franzed37ddf2013-09-22 15:45:26 -0700769typedef struct _efi_file_handle {
Matt Fleming55839d52011-08-11 10:28:06 +0100770 u64 revision;
Roy Franzed37ddf2013-09-22 15:45:26 -0700771 efi_status_t (*open)(struct _efi_file_handle *,
772 struct _efi_file_handle **,
773 efi_char16_t *, u64, u64);
774 efi_status_t (*close)(struct _efi_file_handle *);
Matt Fleming55839d52011-08-11 10:28:06 +0100775 void *delete;
Roy Franzed37ddf2013-09-22 15:45:26 -0700776 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
777 void *);
Matt Fleming55839d52011-08-11 10:28:06 +0100778 void *write;
779 void *get_position;
780 void *set_position;
Roy Franzed37ddf2013-09-22 15:45:26 -0700781 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
782 unsigned long *, void *);
Matt Fleming55839d52011-08-11 10:28:06 +0100783 void *set_info;
784 void *flush;
785} efi_file_handle_t;
786
Roy Franzed37ddf2013-09-22 15:45:26 -0700787typedef struct _efi_file_io_interface {
788 u64 revision;
789 int (*open_volume)(struct _efi_file_io_interface *,
790 efi_file_handle_t **);
791} efi_file_io_interface_t;
792
Matt Fleming55839d52011-08-11 10:28:06 +0100793#define EFI_FILE_MODE_READ 0x0000000000000001
794#define EFI_FILE_MODE_WRITE 0x0000000000000002
795#define EFI_FILE_MODE_CREATE 0x8000000000000000
796
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800797#define EFI_INVALID_TABLE_ADDR (~0UL)
798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799/*
800 * All runtime access to EFI goes through this structure:
801 */
802extern struct efi {
803 efi_system_table_t *systab; /* EFI system table */
Matthew Garrett3b370232011-06-06 15:36:25 -0400804 unsigned int runtime_version; /* Runtime services version */
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800805 unsigned long mps; /* MPS table */
806 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
807 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
808 unsigned long smbios; /* SM BIOS table */
809 unsigned long sal_systab; /* SAL system table */
810 unsigned long boot_info; /* boot info table */
811 unsigned long hcdp; /* HCDP table */
812 unsigned long uga; /* UGA table */
Russ Andersona50f70b2008-10-03 11:58:54 -0500813 unsigned long uv_systab; /* UV system table */
Dave Younga0998eb2013-12-20 18:02:17 +0800814 unsigned long fw_vendor; /* fw_vendor */
815 unsigned long runtime; /* runtime table */
816 unsigned long config_table; /* config tables */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 efi_get_time_t *get_time;
818 efi_set_time_t *set_time;
819 efi_get_wakeup_time_t *get_wakeup_time;
820 efi_set_wakeup_time_t *set_wakeup_time;
821 efi_get_variable_t *get_variable;
822 efi_get_next_variable_t *get_next_variable;
823 efi_set_variable_t *set_variable;
Matthew Garrett3b370232011-06-06 15:36:25 -0400824 efi_query_variable_info_t *query_variable_info;
825 efi_update_capsule_t *update_capsule;
826 efi_query_capsule_caps_t *query_capsule_caps;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 efi_get_next_high_mono_count_t *get_next_high_mono_count;
828 efi_reset_system_t *reset_system;
829 efi_set_virtual_address_map_t *set_virtual_address_map;
Leif Lindholm258f6fd2013-09-05 11:34:55 +0100830 struct efi_memory_map *memmap;
Matt Fleming3e909592014-01-15 13:21:22 +0000831 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832} efi;
833
834static inline int
835efi_guidcmp (efi_guid_t left, efi_guid_t right)
836{
837 return memcmp(&left, &right, sizeof (efi_guid_t));
838}
839
840static inline char *
841efi_guid_unparse(efi_guid_t *guid, char *out)
842{
Joe Perches925ede0bf2009-12-14 18:01:14 -0800843 sprintf(out, "%pUl", guid->b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 return out;
845}
846
847extern void efi_init (void);
848extern void *efi_get_pal_addr (void);
849extern void efi_map_pal_code (void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
851extern void efi_gettimeofday (struct timespec *ts);
852extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
Josh Triplett78510792012-09-28 17:55:44 -0700853#ifdef CONFIG_X86
Josh Triplett2223af32012-09-28 17:57:05 -0700854extern void efi_late_init(void);
Josh Triplett78510792012-09-28 17:55:44 -0700855extern void efi_free_boot_services(void);
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000856extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
Josh Triplett78510792012-09-28 17:55:44 -0700857#else
Josh Triplett2223af32012-09-28 17:57:05 -0700858static inline void efi_late_init(void) {}
Josh Triplett78510792012-09-28 17:55:44 -0700859static inline void efi_free_boot_services(void) {}
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000860
861static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
862{
863 return EFI_SUCCESS;
864}
Josh Triplett78510792012-09-28 17:55:44 -0700865#endif
Josh Triplett7bc90e02012-09-28 17:56:08 -0700866extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
Leif Lindholm272686b2013-09-05 11:34:54 +0100867extern int efi_config_init(efi_config_table_type_t *arch_tables);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868extern u64 efi_get_iobase (void);
869extern u32 efi_mem_type (unsigned long phys_addr);
870extern u64 efi_mem_attributes (unsigned long phys_addr);
Bjorn Helgaas32e62c62006-05-05 17:19:50 -0600871extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872extern int __init efi_uart_console_only (void);
873extern void efi_initialize_iomem_resources(struct resource *code_resource,
Bernhard Walle00bf4092007-10-21 16:42:01 -0700874 struct resource *data_resource, struct resource *bss_resource);
David Vrabel35651842013-05-13 18:56:06 +0100875extern void efi_get_time(struct timespec *now);
Matthew Garrett916f6762011-05-25 09:53:13 -0400876extern void efi_reserve_boot_services(void);
Mark Salter0302f712013-12-30 12:12:12 -0500877extern int efi_get_fdt_params(struct efi_fdt_params *params, int verbose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878extern struct efi_memory_map memmap;
879
Matt Fleming44be28e2014-06-13 12:39:55 +0100880extern int efi_reboot_quirk_mode;
Matt Fleming0c5ed612014-06-13 12:35:21 +0100881extern bool efi_poweroff_required(void);
882
Mark Saltere885cd82014-01-10 14:26:06 -0500883/* Iterate through an efi_memory_map */
884#define for_each_efi_memory_desc(m, md) \
885 for ((md) = (m)->map; \
886 (md) <= (efi_memory_desc_t *)((m)->map_end - (m)->desc_size); \
887 (md) = (void *)(md) + (m)->desc_size)
888
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889/**
890 * efi_range_is_wc - check the WC bit on an address range
891 * @start: starting kvirt address
892 * @len: length of range
893 *
894 * Consult the EFI memory map and make sure it's ok to set this range WC.
895 * Returns true or false.
896 */
897static inline int efi_range_is_wc(unsigned long start, unsigned long len)
898{
Jesper Juhl986a80d2005-06-16 15:14:00 -0700899 unsigned long i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
901 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
902 unsigned long paddr = __pa(start + i);
903 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
904 return 0;
905 }
906 /* The range checked out */
907 return 1;
908}
909
910#ifdef CONFIG_EFI_PCDP
911extern int __init efi_setup_pcdp_console(char *);
912#endif
913
914/*
Matt Fleming83e68182012-11-14 09:42:35 +0000915 * We play games with efi_enabled so that the compiler will, if
916 * possible, remove EFI-related code altogether.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 */
Matt Fleming83e68182012-11-14 09:42:35 +0000918#define EFI_BOOT 0 /* Were we booted from EFI? */
919#define EFI_SYSTEM_TABLES 1 /* Can we use EFI system tables? */
920#define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
921#define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
922#define EFI_MEMMAP 4 /* Can we use EFI memory map? */
923#define EFI_64BIT 5 /* Is the firmware 64-bit? */
Daniel Kiper9f27bc52014-06-30 19:52:58 +0200924#define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
925#define EFI_ARCH_1 7 /* First arch-specific bit */
Matt Fleming83e68182012-11-14 09:42:35 +0000926
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927#ifdef CONFIG_EFI
Matt Fleming3e909592014-01-15 13:21:22 +0000928/*
929 * Test whether the above EFI_* bits are enabled.
930 */
931static inline bool efi_enabled(int feature)
Matt Fleming83e68182012-11-14 09:42:35 +0000932{
Matt Fleming3e909592014-01-15 13:21:22 +0000933 return test_bit(feature, &efi.flags) != 0;
934}
Matt Fleming8562c99c2014-06-13 12:22:22 +0100935extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936#else
Matt Fleming3e909592014-01-15 13:21:22 +0000937static inline bool efi_enabled(int feature)
Matt Fleming83e68182012-11-14 09:42:35 +0000938{
Matt Fleming3e909592014-01-15 13:21:22 +0000939 return false;
Matt Fleming83e68182012-11-14 09:42:35 +0000940}
Matt Fleming8562c99c2014-06-13 12:22:22 +0100941static inline void
942efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943#endif
944
945/*
946 * Variable Attributes
947 */
948#define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
949#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
950#define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
Matthew Garrett41b32542012-04-30 16:11:29 -0400951#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
952#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
953#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
954#define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955
Matthew Garrett41b32542012-04-30 16:11:29 -0400956#define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
957 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
958 EFI_VARIABLE_RUNTIME_ACCESS | \
959 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
960 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
961 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
962 EFI_VARIABLE_APPEND_WRITE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963/*
Matt Fleminge14ab232013-02-03 20:16:40 +0000964 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
965 * not including trailing NUL
966 */
967#define EFI_VARIABLE_GUID_LEN 36
968
969/*
Matt Fleminge2527a72011-11-15 12:57:26 +0000970 * The type of search to perform when calling boottime->locate_handle
971 */
972#define EFI_LOCATE_ALL_HANDLES 0
973#define EFI_LOCATE_BY_REGISTER_NOTIFY 1
974#define EFI_LOCATE_BY_PROTOCOL 2
975
976/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 * EFI Device Path information
978 */
979#define EFI_DEV_HW 0x01
980#define EFI_DEV_PCI 1
981#define EFI_DEV_PCCARD 2
982#define EFI_DEV_MEM_MAPPED 3
983#define EFI_DEV_VENDOR 4
984#define EFI_DEV_CONTROLLER 5
985#define EFI_DEV_ACPI 0x02
986#define EFI_DEV_BASIC_ACPI 1
987#define EFI_DEV_EXPANDED_ACPI 2
988#define EFI_DEV_MSG 0x03
989#define EFI_DEV_MSG_ATAPI 1
990#define EFI_DEV_MSG_SCSI 2
991#define EFI_DEV_MSG_FC 3
992#define EFI_DEV_MSG_1394 4
993#define EFI_DEV_MSG_USB 5
994#define EFI_DEV_MSG_USB_CLASS 15
995#define EFI_DEV_MSG_I20 6
996#define EFI_DEV_MSG_MAC 11
997#define EFI_DEV_MSG_IPV4 12
998#define EFI_DEV_MSG_IPV6 13
999#define EFI_DEV_MSG_INFINIBAND 9
1000#define EFI_DEV_MSG_UART 14
1001#define EFI_DEV_MSG_VENDOR 10
1002#define EFI_DEV_MEDIA 0x04
1003#define EFI_DEV_MEDIA_HARD_DRIVE 1
1004#define EFI_DEV_MEDIA_CDROM 2
1005#define EFI_DEV_MEDIA_VENDOR 3
1006#define EFI_DEV_MEDIA_FILE 4
1007#define EFI_DEV_MEDIA_PROTOCOL 5
1008#define EFI_DEV_BIOS_BOOT 0x05
1009#define EFI_DEV_END_PATH 0x7F
1010#define EFI_DEV_END_PATH2 0xFF
1011#define EFI_DEV_END_INSTANCE 0x01
1012#define EFI_DEV_END_ENTIRE 0xFF
1013
1014struct efi_generic_dev_path {
1015 u8 type;
1016 u8 sub_type;
1017 u16 length;
1018} __attribute ((packed));
1019
Huang, Ying4a3575f2008-02-25 15:18:37 +08001020static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1021{
1022 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1023 *addr &= PAGE_MASK;
1024}
1025
Matt Fleming04851772013-02-08 15:48:51 +00001026/*
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001027 * EFI Variable support.
1028 *
1029 * Different firmware drivers can expose their EFI-like variables using
1030 * the following.
1031 */
1032
1033struct efivar_operations {
1034 efi_get_variable_t *get_variable;
1035 efi_get_next_variable_t *get_next_variable;
1036 efi_set_variable_t *set_variable;
Matt Fleminga6e4d5a2013-03-25 09:14:30 +00001037 efi_query_variable_store_t *query_variable_store;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001038};
1039
1040struct efivars {
1041 /*
1042 * ->lock protects two things:
Matt Fleming82f990a2014-07-08 12:28:33 +01001043 * 1) efivarfs_list and efivars_sysfs_list
1044 * 2) ->ops calls
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001045 */
1046 spinlock_t lock;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001047 struct kset *kset;
Lee, Chun-Yi605e70c2012-10-05 13:54:56 +08001048 struct kobject *kobject;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001049 const struct efivar_operations *ops;
1050};
1051
Matt Fleminge14ab232013-02-03 20:16:40 +00001052/*
1053 * The maximum size of VariableName + Data = 1024
1054 * Therefore, it's reasonable to save that much
1055 * space in each part of the structure,
1056 * and we use a page for reading/writing.
1057 */
1058
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001059#define EFI_VAR_NAME_LEN 1024
1060
Matt Fleminge14ab232013-02-03 20:16:40 +00001061struct efi_variable {
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001062 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
Matt Fleminge14ab232013-02-03 20:16:40 +00001063 efi_guid_t VendorGuid;
1064 unsigned long DataSize;
1065 __u8 Data[1024];
1066 efi_status_t Status;
1067 __u32 Attributes;
1068} __attribute__((packed));
1069
1070struct efivar_entry {
1071 struct efi_variable var;
1072 struct list_head list;
1073 struct kobject kobj;
Seiji Aguchie0d59732013-10-30 15:27:26 -04001074 bool scanning;
1075 bool deleting;
Matt Fleminge14ab232013-02-03 20:16:40 +00001076};
1077
Matt Fleming677703c2014-01-10 13:47:37 +00001078struct efi_simple_text_output_protocol_32 {
1079 u32 reset;
1080 u32 output_string;
1081 u32 test_string;
1082};
1083
1084struct efi_simple_text_output_protocol_64 {
1085 u64 reset;
1086 u64 output_string;
1087 u64 test_string;
1088};
Roy Franzed37ddf2013-09-22 15:45:26 -07001089
1090struct efi_simple_text_output_protocol {
1091 void *reset;
1092 efi_status_t (*output_string)(void *, void *);
1093 void *test_string;
1094};
1095
Matt Fleming04851772013-02-08 15:48:51 +00001096extern struct list_head efivar_sysfs_list;
1097
1098static inline void
1099efivar_unregister(struct efivar_entry *var)
1100{
1101 kobject_put(&var->kobj);
1102}
1103
Matt Fleminge14ab232013-02-03 20:16:40 +00001104int efivars_register(struct efivars *efivars,
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001105 const struct efivar_operations *ops,
Matt Fleminge14ab232013-02-03 20:16:40 +00001106 struct kobject *kobject);
1107int efivars_unregister(struct efivars *efivars);
1108struct kobject *efivars_kobject(void);
1109
1110int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1111 void *data, bool atomic, bool duplicates,
1112 struct list_head *head);
1113
1114void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1115void efivar_entry_remove(struct efivar_entry *entry);
1116
1117int __efivar_entry_delete(struct efivar_entry *entry);
1118int efivar_entry_delete(struct efivar_entry *entry);
1119
Matt Fleminge14ab232013-02-03 20:16:40 +00001120int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
Matt Fleming8a415b82013-04-29 20:08:02 +01001121int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1122 unsigned long *size, void *data);
Matt Fleminge14ab232013-02-03 20:16:40 +00001123int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1124 unsigned long *size, void *data);
1125int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1126 unsigned long size, void *data, struct list_head *head);
1127int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1128 unsigned long *size, void *data, bool *set);
1129int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1130 bool block, unsigned long size, void *data);
1131
1132void efivar_entry_iter_begin(void);
1133void efivar_entry_iter_end(void);
1134
1135int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1136 struct list_head *head, void *data,
1137 struct efivar_entry **prev);
1138int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1139 struct list_head *head, void *data);
1140
1141struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1142 struct list_head *head, bool remove);
1143
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001144bool efivar_validate(efi_char16_t *var_name, u8 *data, unsigned long len);
Matt Fleminge14ab232013-02-03 20:16:40 +00001145
Tom Gundersena9499fa2013-02-08 15:37:06 +00001146extern struct work_struct efivar_work;
Matt Fleming04851772013-02-08 15:48:51 +00001147void efivar_run_worker(void);
1148
Tom Gundersena9499fa2013-02-08 15:37:06 +00001149#if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
Matt Fleminge14ab232013-02-03 20:16:40 +00001150int efivars_sysfs_init(void);
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001151
Seiji Aguchie0d59732013-10-30 15:27:26 -04001152#define EFIVARS_DATA_SIZE_MAX 1024
1153
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001154#endif /* CONFIG_EFI_VARS */
1155
Dave Young926172d2013-12-20 18:02:18 +08001156#ifdef CONFIG_EFI_RUNTIME_MAP
1157int efi_runtime_map_init(struct kobject *);
1158void efi_runtime_map_setup(void *, int, u32);
Vivek Goyal6a2c20e2014-08-08 14:26:11 -07001159int efi_get_runtime_map_size(void);
1160int efi_get_runtime_map_desc_size(void);
1161int efi_runtime_map_copy(void *buf, size_t bufsz);
Dave Young926172d2013-12-20 18:02:18 +08001162#else
1163static inline int efi_runtime_map_init(struct kobject *kobj)
1164{
1165 return 0;
1166}
1167
1168static inline void
1169efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
Vivek Goyal6a2c20e2014-08-08 14:26:11 -07001170
1171static inline int efi_get_runtime_map_size(void)
1172{
1173 return 0;
1174}
1175
1176static inline int efi_get_runtime_map_desc_size(void)
1177{
1178 return 0;
1179}
1180
1181static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1182{
1183 return 0;
1184}
1185
Dave Young926172d2013-12-20 18:02:18 +08001186#endif
1187
Ard Biesheuvelbd669472014-07-02 14:54:42 +02001188/* prototypes shared between arch specific and generic stub code */
1189
1190#define pr_efi(sys_table, msg) efi_printk(sys_table, "EFI stub: "msg)
1191#define pr_efi_err(sys_table, msg) efi_printk(sys_table, "EFI stub: ERROR: "msg)
1192
1193void efi_printk(efi_system_table_t *sys_table_arg, char *str);
1194
1195void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
1196 unsigned long addr);
1197
1198char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
1199 efi_loaded_image_t *image, int *cmd_line_len);
1200
1201efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
1202 efi_memory_desc_t **map,
1203 unsigned long *map_size,
1204 unsigned long *desc_size,
1205 u32 *desc_ver,
1206 unsigned long *key_ptr);
1207
1208efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
1209 unsigned long size, unsigned long align,
1210 unsigned long *addr);
1211
1212efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
1213 unsigned long size, unsigned long align,
1214 unsigned long *addr, unsigned long max);
1215
1216efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
1217 unsigned long *image_addr,
1218 unsigned long image_size,
1219 unsigned long alloc_size,
1220 unsigned long preferred_addr,
1221 unsigned long alignment);
1222
1223efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
1224 efi_loaded_image_t *image,
1225 char *cmd_line, char *option_string,
1226 unsigned long max_addr,
1227 unsigned long *load_addr,
1228 unsigned long *load_size);
1229
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230#endif /* _LINUX_EFI_H */