blob: 41bbf8ba4ba88758cb38af8701d32bea522f4887 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24#include <asm/page.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#define EFI_SUCCESS 0
27#define EFI_LOAD_ERROR ( 1 | (1UL << (BITS_PER_LONG-1)))
28#define EFI_INVALID_PARAMETER ( 2 | (1UL << (BITS_PER_LONG-1)))
29#define EFI_UNSUPPORTED ( 3 | (1UL << (BITS_PER_LONG-1)))
30#define EFI_BAD_BUFFER_SIZE ( 4 | (1UL << (BITS_PER_LONG-1)))
31#define EFI_BUFFER_TOO_SMALL ( 5 | (1UL << (BITS_PER_LONG-1)))
Matthew Garrett5d9db882012-10-05 13:54:56 +080032#define EFI_NOT_READY ( 6 | (1UL << (BITS_PER_LONG-1)))
33#define EFI_DEVICE_ERROR ( 7 | (1UL << (BITS_PER_LONG-1)))
34#define EFI_WRITE_PROTECTED ( 8 | (1UL << (BITS_PER_LONG-1)))
35#define EFI_OUT_OF_RESOURCES ( 9 | (1UL << (BITS_PER_LONG-1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
Matthew Garrett5d9db882012-10-05 13:54:56 +080037#define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39typedef unsigned long efi_status_t;
40typedef u8 efi_bool_t;
41typedef u16 efi_char16_t; /* UNICODE character */
Roy Franzed37ddf2013-09-22 15:45:26 -070042typedef u64 efi_physical_addr_t;
43typedef void *efi_handle_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
45
46typedef struct {
47 u8 b[16];
48} efi_guid_t;
49
50#define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
51((efi_guid_t) \
52{{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
53 (b) & 0xff, ((b) >> 8) & 0xff, \
54 (c) & 0xff, ((c) >> 8) & 0xff, \
55 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
56
57/*
58 * Generic EFI table header
59 */
60typedef struct {
61 u64 signature;
62 u32 revision;
63 u32 headersize;
64 u32 crc32;
65 u32 reserved;
66} efi_table_hdr_t;
67
68/*
69 * Memory map descriptor:
70 */
71
72/* Memory types: */
73#define EFI_RESERVED_TYPE 0
74#define EFI_LOADER_CODE 1
75#define EFI_LOADER_DATA 2
76#define EFI_BOOT_SERVICES_CODE 3
77#define EFI_BOOT_SERVICES_DATA 4
78#define EFI_RUNTIME_SERVICES_CODE 5
79#define EFI_RUNTIME_SERVICES_DATA 6
80#define EFI_CONVENTIONAL_MEMORY 7
81#define EFI_UNUSABLE_MEMORY 8
82#define EFI_ACPI_RECLAIM_MEMORY 9
83#define EFI_ACPI_MEMORY_NVS 10
84#define EFI_MEMORY_MAPPED_IO 11
85#define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
86#define EFI_PAL_CODE 13
87#define EFI_MAX_MEMORY_TYPE 14
88
89/* Attribute values: */
90#define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
91#define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
92#define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
93#define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
94#define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
95#define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
96#define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
97#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
98#define EFI_MEMORY_DESCRIPTOR_VERSION 1
99
100#define EFI_PAGE_SHIFT 12
Roy Franzed37ddf2013-09-22 15:45:26 -0700101#define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103typedef struct {
104 u32 type;
105 u32 pad;
106 u64 phys_addr;
107 u64 virt_addr;
108 u64 num_pages;
109 u64 attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110} efi_memory_desc_t;
111
Matthew Garrett3b370232011-06-06 15:36:25 -0400112typedef struct {
113 efi_guid_t guid;
114 u32 headersize;
115 u32 flags;
116 u32 imagesize;
117} efi_capsule_header_t;
118
Matt Flemingbb05e4b2011-11-15 12:57:03 +0000119/*
120 * Allocation types for calls to boottime->allocate_pages.
121 */
122#define EFI_ALLOCATE_ANY_PAGES 0
123#define EFI_ALLOCATE_MAX_ADDRESS 1
124#define EFI_ALLOCATE_ADDRESS 2
125#define EFI_MAX_ALLOCATE_TYPE 3
126
Matthew Wilcoxe088a4a2009-05-22 13:49:49 -0700127typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129/*
130 * Types and defines for Time Services
131 */
132#define EFI_TIME_ADJUST_DAYLIGHT 0x1
133#define EFI_TIME_IN_DAYLIGHT 0x2
134#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
135
136typedef struct {
137 u16 year;
138 u8 month;
139 u8 day;
140 u8 hour;
141 u8 minute;
142 u8 second;
143 u8 pad1;
144 u32 nanosecond;
145 s16 timezone;
146 u8 daylight;
147 u8 pad2;
148} efi_time_t;
149
150typedef struct {
151 u32 resolution;
152 u32 accuracy;
153 u8 sets_to_zero;
154} efi_time_cap_t;
155
Matt Fleming677703c2014-01-10 13:47:37 +0000156typedef struct {
157 efi_table_hdr_t hdr;
158 u32 raise_tpl;
159 u32 restore_tpl;
160 u32 allocate_pages;
161 u32 free_pages;
162 u32 get_memory_map;
163 u32 allocate_pool;
164 u32 free_pool;
165 u32 create_event;
166 u32 set_timer;
167 u32 wait_for_event;
168 u32 signal_event;
169 u32 close_event;
170 u32 check_event;
171 u32 install_protocol_interface;
172 u32 reinstall_protocol_interface;
173 u32 uninstall_protocol_interface;
174 u32 handle_protocol;
175 u32 __reserved;
176 u32 register_protocol_notify;
177 u32 locate_handle;
178 u32 locate_device_path;
179 u32 install_configuration_table;
180 u32 load_image;
181 u32 start_image;
182 u32 exit;
183 u32 unload_image;
184 u32 exit_boot_services;
185 u32 get_next_monotonic_count;
186 u32 stall;
187 u32 set_watchdog_timer;
188 u32 connect_controller;
189 u32 disconnect_controller;
190 u32 open_protocol;
191 u32 close_protocol;
192 u32 open_protocol_information;
193 u32 protocols_per_handle;
194 u32 locate_handle_buffer;
195 u32 locate_protocol;
196 u32 install_multiple_protocol_interfaces;
197 u32 uninstall_multiple_protocol_interfaces;
198 u32 calculate_crc32;
199 u32 copy_mem;
200 u32 set_mem;
201 u32 create_event_ex;
202} __packed efi_boot_services_32_t;
203
204typedef struct {
205 efi_table_hdr_t hdr;
206 u64 raise_tpl;
207 u64 restore_tpl;
208 u64 allocate_pages;
209 u64 free_pages;
210 u64 get_memory_map;
211 u64 allocate_pool;
212 u64 free_pool;
213 u64 create_event;
214 u64 set_timer;
215 u64 wait_for_event;
216 u64 signal_event;
217 u64 close_event;
218 u64 check_event;
219 u64 install_protocol_interface;
220 u64 reinstall_protocol_interface;
221 u64 uninstall_protocol_interface;
222 u64 handle_protocol;
223 u64 __reserved;
224 u64 register_protocol_notify;
225 u64 locate_handle;
226 u64 locate_device_path;
227 u64 install_configuration_table;
228 u64 load_image;
229 u64 start_image;
230 u64 exit;
231 u64 unload_image;
232 u64 exit_boot_services;
233 u64 get_next_monotonic_count;
234 u64 stall;
235 u64 set_watchdog_timer;
236 u64 connect_controller;
237 u64 disconnect_controller;
238 u64 open_protocol;
239 u64 close_protocol;
240 u64 open_protocol_information;
241 u64 protocols_per_handle;
242 u64 locate_handle_buffer;
243 u64 locate_protocol;
244 u64 install_multiple_protocol_interfaces;
245 u64 uninstall_multiple_protocol_interfaces;
246 u64 calculate_crc32;
247 u64 copy_mem;
248 u64 set_mem;
249 u64 create_event_ex;
250} __packed efi_boot_services_64_t;
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252/*
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000253 * EFI Boot Services table
254 */
255typedef struct {
256 efi_table_hdr_t hdr;
257 void *raise_tpl;
258 void *restore_tpl;
Roy Franzed37ddf2013-09-22 15:45:26 -0700259 efi_status_t (*allocate_pages)(int, int, unsigned long,
260 efi_physical_addr_t *);
261 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
262 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
263 unsigned long *, u32 *);
264 efi_status_t (*allocate_pool)(int, unsigned long, void **);
265 efi_status_t (*free_pool)(void *);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000266 void *create_event;
267 void *set_timer;
268 void *wait_for_event;
269 void *signal_event;
270 void *close_event;
271 void *check_event;
272 void *install_protocol_interface;
273 void *reinstall_protocol_interface;
274 void *uninstall_protocol_interface;
Roy Franzed37ddf2013-09-22 15:45:26 -0700275 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000276 void *__reserved;
277 void *register_protocol_notify;
278 void *locate_handle;
279 void *locate_device_path;
280 void *install_configuration_table;
281 void *load_image;
282 void *start_image;
283 void *exit;
284 void *unload_image;
Roy Franzed37ddf2013-09-22 15:45:26 -0700285 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000286 void *get_next_monotonic_count;
287 void *stall;
288 void *set_watchdog_timer;
289 void *connect_controller;
290 void *disconnect_controller;
291 void *open_protocol;
292 void *close_protocol;
293 void *open_protocol_information;
294 void *protocols_per_handle;
295 void *locate_handle_buffer;
296 void *locate_protocol;
297 void *install_multiple_protocol_interfaces;
298 void *uninstall_multiple_protocol_interfaces;
299 void *calculate_crc32;
300 void *copy_mem;
301 void *set_mem;
302 void *create_event_ex;
303} efi_boot_services_t;
304
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700305typedef enum {
306 EfiPciIoWidthUint8,
307 EfiPciIoWidthUint16,
308 EfiPciIoWidthUint32,
309 EfiPciIoWidthUint64,
310 EfiPciIoWidthFifoUint8,
311 EfiPciIoWidthFifoUint16,
312 EfiPciIoWidthFifoUint32,
313 EfiPciIoWidthFifoUint64,
314 EfiPciIoWidthFillUint8,
315 EfiPciIoWidthFillUint16,
316 EfiPciIoWidthFillUint32,
317 EfiPciIoWidthFillUint64,
318 EfiPciIoWidthMaximum
319} EFI_PCI_IO_PROTOCOL_WIDTH;
320
321typedef enum {
322 EfiPciIoAttributeOperationGet,
323 EfiPciIoAttributeOperationSet,
324 EfiPciIoAttributeOperationEnable,
325 EfiPciIoAttributeOperationDisable,
326 EfiPciIoAttributeOperationSupported,
327 EfiPciIoAttributeOperationMaximum
328} EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
329
Matt Fleming677703c2014-01-10 13:47:37 +0000330typedef struct {
331 u32 read;
332 u32 write;
333} efi_pci_io_protocol_access_32_t;
334
335typedef struct {
336 u64 read;
337 u64 write;
338} efi_pci_io_protocol_access_64_t;
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700339
340typedef struct {
341 void *read;
342 void *write;
343} efi_pci_io_protocol_access_t;
344
345typedef struct {
Matt Fleming677703c2014-01-10 13:47:37 +0000346 u32 poll_mem;
347 u32 poll_io;
348 efi_pci_io_protocol_access_32_t mem;
349 efi_pci_io_protocol_access_32_t io;
350 efi_pci_io_protocol_access_32_t pci;
351 u32 copy_mem;
352 u32 map;
353 u32 unmap;
354 u32 allocate_buffer;
355 u32 free_buffer;
356 u32 flush;
357 u32 get_location;
358 u32 attributes;
359 u32 get_bar_attributes;
360 u32 set_bar_attributes;
361 uint64_t romsize;
362 void *romimage;
363} efi_pci_io_protocol_32;
364
365typedef struct {
366 u64 poll_mem;
367 u64 poll_io;
368 efi_pci_io_protocol_access_64_t mem;
369 efi_pci_io_protocol_access_64_t io;
370 efi_pci_io_protocol_access_64_t pci;
371 u64 copy_mem;
372 u64 map;
373 u64 unmap;
374 u64 allocate_buffer;
375 u64 free_buffer;
376 u64 flush;
377 u64 get_location;
378 u64 attributes;
379 u64 get_bar_attributes;
380 u64 set_bar_attributes;
381 uint64_t romsize;
382 void *romimage;
383} efi_pci_io_protocol_64;
384
385typedef struct {
Matthew Garrettdd5fc852012-12-05 14:33:26 -0700386 void *poll_mem;
387 void *poll_io;
388 efi_pci_io_protocol_access_t mem;
389 efi_pci_io_protocol_access_t io;
390 efi_pci_io_protocol_access_t pci;
391 void *copy_mem;
392 void *map;
393 void *unmap;
394 void *allocate_buffer;
395 void *free_buffer;
396 void *flush;
397 void *get_location;
398 void *attributes;
399 void *get_bar_attributes;
400 void *set_bar_attributes;
401 uint64_t romsize;
402 void *romimage;
403} efi_pci_io_protocol;
404
405#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
406#define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
407#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
408#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
409#define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
410#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
411#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
412#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
413#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
414#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
415#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
416#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
417#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
418#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
419#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
420#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
421#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
422#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
423#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
424
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000425/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 * Types and defines for EFI ResetSystem
427 */
428#define EFI_RESET_COLD 0
429#define EFI_RESET_WARM 1
430#define EFI_RESET_SHUTDOWN 2
431
432/*
433 * EFI Runtime Services table
434 */
435#define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
436#define EFI_RUNTIME_SERVICES_REVISION 0x00010000
437
438typedef struct {
439 efi_table_hdr_t hdr;
Matt Fleming677703c2014-01-10 13:47:37 +0000440 u32 get_time;
441 u32 set_time;
442 u32 get_wakeup_time;
443 u32 set_wakeup_time;
444 u32 set_virtual_address_map;
445 u32 convert_pointer;
446 u32 get_variable;
447 u32 get_next_variable;
448 u32 set_variable;
449 u32 get_next_high_mono_count;
450 u32 reset_system;
451 u32 update_capsule;
452 u32 query_capsule_caps;
453 u32 query_variable_info;
454} efi_runtime_services_32_t;
455
456typedef struct {
457 efi_table_hdr_t hdr;
458 u64 get_time;
459 u64 set_time;
460 u64 get_wakeup_time;
461 u64 set_wakeup_time;
462 u64 set_virtual_address_map;
463 u64 convert_pointer;
464 u64 get_variable;
465 u64 get_next_variable;
466 u64 set_variable;
467 u64 get_next_high_mono_count;
468 u64 reset_system;
469 u64 update_capsule;
470 u64 query_capsule_caps;
471 u64 query_variable_info;
472} efi_runtime_services_64_t;
473
474typedef struct {
475 efi_table_hdr_t hdr;
Borislav Petkov43ab0472013-06-02 14:56:07 +0200476 void *get_time;
477 void *set_time;
478 void *get_wakeup_time;
479 void *set_wakeup_time;
480 void *set_virtual_address_map;
481 void *convert_pointer;
482 void *get_variable;
483 void *get_next_variable;
484 void *set_variable;
485 void *get_next_high_mono_count;
486 void *reset_system;
487 void *update_capsule;
488 void *query_capsule_caps;
489 void *query_variable_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490} efi_runtime_services_t;
491
492typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
493typedef efi_status_t efi_set_time_t (efi_time_t *tm);
494typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
495 efi_time_t *tm);
496typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
497typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
498 unsigned long *data_size, void *data);
499typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
500 efi_guid_t *vendor);
501typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
Matthew Garrettf7a2d732011-06-06 15:36:24 -0400502 u32 attr, unsigned long data_size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 void *data);
504typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
505typedef void efi_reset_system_t (int reset_type, efi_status_t status,
506 unsigned long data_size, efi_char16_t *data);
507typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
508 unsigned long descriptor_size,
509 u32 descriptor_version,
510 efi_memory_desc_t *virtual_map);
Matthew Garrett3b370232011-06-06 15:36:25 -0400511typedef efi_status_t efi_query_variable_info_t(u32 attr,
512 u64 *storage_space,
513 u64 *remaining_space,
514 u64 *max_variable_size);
515typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
516 unsigned long count,
517 unsigned long sg_list);
518typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
519 unsigned long count,
520 u64 *max_size,
521 int *reset_type);
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000522typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
524/*
525 * EFI Configuration Table and GUID definitions
526 */
527#define NULL_GUID \
528 EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
529
530#define MPS_TABLE_GUID \
531 EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
532
533#define ACPI_TABLE_GUID \
534 EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
535
536#define ACPI_20_TABLE_GUID \
537 EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
538
539#define SMBIOS_TABLE_GUID \
540 EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
541
542#define SAL_SYSTEM_TABLE_GUID \
543 EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
544
545#define HCDP_TABLE_GUID \
546 EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
547
548#define UGA_IO_PROTOCOL_GUID \
549 EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
550
551#define EFI_GLOBAL_VARIABLE_GUID \
552 EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
553
Russ Andersona50f70b2008-10-03 11:58:54 -0500554#define UV_SYSTEM_TABLE_GUID \
555 EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
556
Matthew Garrett5ee9c192011-07-21 16:57:56 -0400557#define LINUX_EFI_CRASH_GUID \
558 EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
559
Matt Fleming8e84f342011-11-15 12:56:50 +0000560#define LOADED_IMAGE_PROTOCOL_GUID \
561 EFI_GUID( 0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
562
Matt Fleming0f7c5d42011-11-15 12:57:16 +0000563#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
564 EFI_GUID( 0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
565
566#define EFI_UGA_PROTOCOL_GUID \
567 EFI_GUID( 0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
568
569#define EFI_PCI_IO_PROTOCOL_GUID \
570 EFI_GUID( 0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
571
Matt Fleming55839d52011-08-11 10:28:06 +0100572#define EFI_FILE_INFO_ID \
573 EFI_GUID( 0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
574
575#define EFI_FILE_SYSTEM_GUID \
576 EFI_GUID( 0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
577
Roy Franz263b4a32014-01-08 17:54:19 -0800578#define DEVICE_TREE_GUID \
579 EFI_GUID( 0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0 )
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581typedef struct {
582 efi_guid_t guid;
Olof Johansson1adbfa32012-02-12 13:24:29 -0800583 u64 table;
584} efi_config_table_64_t;
585
586typedef struct {
587 efi_guid_t guid;
588 u32 table;
589} efi_config_table_32_t;
590
591typedef struct {
592 efi_guid_t guid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 unsigned long table;
594} efi_config_table_t;
595
Leif Lindholm272686b2013-09-05 11:34:54 +0100596typedef struct {
597 efi_guid_t guid;
598 const char *name;
599 unsigned long *ptr;
600} efi_config_table_type_t;
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
Matthew Garrett3b370232011-06-06 15:36:25 -0400604#define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
605#define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
606#define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
607#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
608#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
609#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
610
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611typedef struct {
612 efi_table_hdr_t hdr;
Olof Johansson1adbfa32012-02-12 13:24:29 -0800613 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
614 u32 fw_revision;
615 u32 __pad1;
616 u64 con_in_handle;
617 u64 con_in;
618 u64 con_out_handle;
619 u64 con_out;
620 u64 stderr_handle;
621 u64 stderr;
622 u64 runtime;
623 u64 boottime;
624 u32 nr_tables;
625 u32 __pad2;
626 u64 tables;
627} efi_system_table_64_t;
628
629typedef struct {
630 efi_table_hdr_t hdr;
631 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
632 u32 fw_revision;
633 u32 con_in_handle;
634 u32 con_in;
635 u32 con_out_handle;
636 u32 con_out;
637 u32 stderr_handle;
638 u32 stderr;
639 u32 runtime;
640 u32 boottime;
641 u32 nr_tables;
642 u32 tables;
643} efi_system_table_32_t;
644
645typedef struct {
646 efi_table_hdr_t hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
648 u32 fw_revision;
649 unsigned long con_in_handle;
650 unsigned long con_in;
651 unsigned long con_out_handle;
652 unsigned long con_out;
653 unsigned long stderr_handle;
654 unsigned long stderr;
655 efi_runtime_services_t *runtime;
Matt Flemingf30ca6b2011-11-15 12:56:32 +0000656 efi_boot_services_t *boottime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 unsigned long nr_tables;
658 unsigned long tables;
659} efi_system_table_t;
660
661struct efi_memory_map {
Matt Tolentino7ae65fd2005-09-03 15:56:27 -0700662 void *phys_map;
663 void *map;
664 void *map_end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 int nr_map;
666 unsigned long desc_version;
Matt Tolentino7ae65fd2005-09-03 15:56:27 -0700667 unsigned long desc_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668};
669
Mark Salter0302f712013-12-30 12:12:12 -0500670struct efi_fdt_params {
671 u64 system_table;
672 u64 mmap;
673 u32 mmap_size;
674 u32 desc_size;
675 u32 desc_ver;
676};
677
Matt Fleming8e84f342011-11-15 12:56:50 +0000678typedef struct {
679 u32 revision;
Matt Fleming677703c2014-01-10 13:47:37 +0000680 u32 parent_handle;
681 u32 system_table;
682 u32 device_handle;
683 u32 file_path;
684 u32 reserved;
685 u32 load_options_size;
686 u32 load_options;
687 u32 image_base;
688 __aligned_u64 image_size;
689 unsigned int image_code_type;
690 unsigned int image_data_type;
691 unsigned long unload;
692} efi_loaded_image_32_t;
693
694typedef struct {
695 u32 revision;
696 u64 parent_handle;
697 u64 system_table;
698 u64 device_handle;
699 u64 file_path;
700 u64 reserved;
701 u32 load_options_size;
702 u64 load_options;
703 u64 image_base;
704 __aligned_u64 image_size;
705 unsigned int image_code_type;
706 unsigned int image_data_type;
707 unsigned long unload;
708} efi_loaded_image_64_t;
709
710typedef struct {
711 u32 revision;
Matt Fleming8e84f342011-11-15 12:56:50 +0000712 void *parent_handle;
713 efi_system_table_t *system_table;
714 void *device_handle;
715 void *file_path;
716 void *reserved;
717 u32 load_options_size;
718 void *load_options;
719 void *image_base;
720 __aligned_u64 image_size;
721 unsigned int image_code_type;
722 unsigned int image_data_type;
723 unsigned long unload;
724} efi_loaded_image_t;
725
Matt Fleming55839d52011-08-11 10:28:06 +0100726
727typedef struct {
728 u64 size;
729 u64 file_size;
730 u64 phys_size;
731 efi_time_t create_time;
732 efi_time_t last_access_time;
733 efi_time_t modification_time;
734 __aligned_u64 attribute;
735 efi_char16_t filename[1];
736} efi_file_info_t;
737
Matt Fleming677703c2014-01-10 13:47:37 +0000738typedef struct {
739 u64 revision;
740 u32 open;
741 u32 close;
742 u32 delete;
743 u32 read;
744 u32 write;
745 u32 get_position;
746 u32 set_position;
747 u32 get_info;
748 u32 set_info;
749 u32 flush;
750} efi_file_handle_32_t;
751
752typedef struct {
753 u64 revision;
754 u64 open;
755 u64 close;
756 u64 delete;
757 u64 read;
758 u64 write;
759 u64 get_position;
760 u64 set_position;
761 u64 get_info;
762 u64 set_info;
763 u64 flush;
764} efi_file_handle_64_t;
765
Roy Franzed37ddf2013-09-22 15:45:26 -0700766typedef struct _efi_file_handle {
Matt Fleming55839d52011-08-11 10:28:06 +0100767 u64 revision;
Roy Franzed37ddf2013-09-22 15:45:26 -0700768 efi_status_t (*open)(struct _efi_file_handle *,
769 struct _efi_file_handle **,
770 efi_char16_t *, u64, u64);
771 efi_status_t (*close)(struct _efi_file_handle *);
Matt Fleming55839d52011-08-11 10:28:06 +0100772 void *delete;
Roy Franzed37ddf2013-09-22 15:45:26 -0700773 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
774 void *);
Matt Fleming55839d52011-08-11 10:28:06 +0100775 void *write;
776 void *get_position;
777 void *set_position;
Roy Franzed37ddf2013-09-22 15:45:26 -0700778 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
779 unsigned long *, void *);
Matt Fleming55839d52011-08-11 10:28:06 +0100780 void *set_info;
781 void *flush;
782} efi_file_handle_t;
783
Roy Franzed37ddf2013-09-22 15:45:26 -0700784typedef struct _efi_file_io_interface {
785 u64 revision;
786 int (*open_volume)(struct _efi_file_io_interface *,
787 efi_file_handle_t **);
788} efi_file_io_interface_t;
789
Matt Fleming55839d52011-08-11 10:28:06 +0100790#define EFI_FILE_MODE_READ 0x0000000000000001
791#define EFI_FILE_MODE_WRITE 0x0000000000000002
792#define EFI_FILE_MODE_CREATE 0x8000000000000000
793
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800794#define EFI_INVALID_TABLE_ADDR (~0UL)
795
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796/*
797 * All runtime access to EFI goes through this structure:
798 */
799extern struct efi {
800 efi_system_table_t *systab; /* EFI system table */
Matthew Garrett3b370232011-06-06 15:36:25 -0400801 unsigned int runtime_version; /* Runtime services version */
Bjorn Helgaasb2c99e32006-03-26 01:37:08 -0800802 unsigned long mps; /* MPS table */
803 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
804 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
805 unsigned long smbios; /* SM BIOS table */
806 unsigned long sal_systab; /* SAL system table */
807 unsigned long boot_info; /* boot info table */
808 unsigned long hcdp; /* HCDP table */
809 unsigned long uga; /* UGA table */
Russ Andersona50f70b2008-10-03 11:58:54 -0500810 unsigned long uv_systab; /* UV system table */
Dave Younga0998eb2013-12-20 18:02:17 +0800811 unsigned long fw_vendor; /* fw_vendor */
812 unsigned long runtime; /* runtime table */
813 unsigned long config_table; /* config tables */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 efi_get_time_t *get_time;
815 efi_set_time_t *set_time;
816 efi_get_wakeup_time_t *get_wakeup_time;
817 efi_set_wakeup_time_t *set_wakeup_time;
818 efi_get_variable_t *get_variable;
819 efi_get_next_variable_t *get_next_variable;
820 efi_set_variable_t *set_variable;
Matthew Garrett3b370232011-06-06 15:36:25 -0400821 efi_query_variable_info_t *query_variable_info;
822 efi_update_capsule_t *update_capsule;
823 efi_query_capsule_caps_t *query_capsule_caps;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 efi_get_next_high_mono_count_t *get_next_high_mono_count;
825 efi_reset_system_t *reset_system;
826 efi_set_virtual_address_map_t *set_virtual_address_map;
Leif Lindholm258f6fd2013-09-05 11:34:55 +0100827 struct efi_memory_map *memmap;
Matt Fleming3e909592014-01-15 13:21:22 +0000828 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829} efi;
830
831static inline int
832efi_guidcmp (efi_guid_t left, efi_guid_t right)
833{
834 return memcmp(&left, &right, sizeof (efi_guid_t));
835}
836
837static inline char *
838efi_guid_unparse(efi_guid_t *guid, char *out)
839{
Joe Perches925ede0bf2009-12-14 18:01:14 -0800840 sprintf(out, "%pUl", guid->b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 return out;
842}
843
844extern void efi_init (void);
845extern void *efi_get_pal_addr (void);
846extern void efi_map_pal_code (void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
848extern void efi_gettimeofday (struct timespec *ts);
849extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
Josh Triplett78510792012-09-28 17:55:44 -0700850#ifdef CONFIG_X86
Josh Triplett2223af32012-09-28 17:57:05 -0700851extern void efi_late_init(void);
Josh Triplett78510792012-09-28 17:55:44 -0700852extern void efi_free_boot_services(void);
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000853extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
Josh Triplett78510792012-09-28 17:55:44 -0700854#else
Josh Triplett2223af32012-09-28 17:57:05 -0700855static inline void efi_late_init(void) {}
Josh Triplett78510792012-09-28 17:55:44 -0700856static inline void efi_free_boot_services(void) {}
Matt Fleminga6e4d5a2013-03-25 09:14:30 +0000857
858static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
859{
860 return EFI_SUCCESS;
861}
Josh Triplett78510792012-09-28 17:55:44 -0700862#endif
Josh Triplett7bc90e02012-09-28 17:56:08 -0700863extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
Leif Lindholm272686b2013-09-05 11:34:54 +0100864extern int efi_config_init(efi_config_table_type_t *arch_tables);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865extern u64 efi_get_iobase (void);
866extern u32 efi_mem_type (unsigned long phys_addr);
867extern u64 efi_mem_attributes (unsigned long phys_addr);
Bjorn Helgaas32e62c62006-05-05 17:19:50 -0600868extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869extern int __init efi_uart_console_only (void);
870extern void efi_initialize_iomem_resources(struct resource *code_resource,
Bernhard Walle00bf4092007-10-21 16:42:01 -0700871 struct resource *data_resource, struct resource *bss_resource);
David Vrabel35651842013-05-13 18:56:06 +0100872extern void efi_get_time(struct timespec *now);
873extern int efi_set_rtc_mmss(const struct timespec *now);
Matthew Garrett916f6762011-05-25 09:53:13 -0400874extern void efi_reserve_boot_services(void);
Mark Salter0302f712013-12-30 12:12:12 -0500875extern int efi_get_fdt_params(struct efi_fdt_params *params, int verbose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876extern struct efi_memory_map memmap;
877
Mark Saltere885cd82014-01-10 14:26:06 -0500878/* Iterate through an efi_memory_map */
879#define for_each_efi_memory_desc(m, md) \
880 for ((md) = (m)->map; \
881 (md) <= (efi_memory_desc_t *)((m)->map_end - (m)->desc_size); \
882 (md) = (void *)(md) + (m)->desc_size)
883
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884/**
885 * efi_range_is_wc - check the WC bit on an address range
886 * @start: starting kvirt address
887 * @len: length of range
888 *
889 * Consult the EFI memory map and make sure it's ok to set this range WC.
890 * Returns true or false.
891 */
892static inline int efi_range_is_wc(unsigned long start, unsigned long len)
893{
Jesper Juhl986a80d2005-06-16 15:14:00 -0700894 unsigned long i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
896 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
897 unsigned long paddr = __pa(start + i);
898 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
899 return 0;
900 }
901 /* The range checked out */
902 return 1;
903}
904
905#ifdef CONFIG_EFI_PCDP
906extern int __init efi_setup_pcdp_console(char *);
907#endif
908
909/*
Matt Fleming83e68182012-11-14 09:42:35 +0000910 * We play games with efi_enabled so that the compiler will, if
911 * possible, remove EFI-related code altogether.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 */
Matt Fleming83e68182012-11-14 09:42:35 +0000913#define EFI_BOOT 0 /* Were we booted from EFI? */
914#define EFI_SYSTEM_TABLES 1 /* Can we use EFI system tables? */
915#define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
916#define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
917#define EFI_MEMMAP 4 /* Can we use EFI memory map? */
918#define EFI_64BIT 5 /* Is the firmware 64-bit? */
Borislav Petkovd2f7cbe2013-10-31 17:25:08 +0100919#define EFI_ARCH_1 6 /* First arch-specific bit */
Matt Fleming83e68182012-11-14 09:42:35 +0000920
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921#ifdef CONFIG_EFI
Matt Fleming3e909592014-01-15 13:21:22 +0000922/*
923 * Test whether the above EFI_* bits are enabled.
924 */
925static inline bool efi_enabled(int feature)
Matt Fleming83e68182012-11-14 09:42:35 +0000926{
Matt Fleming3e909592014-01-15 13:21:22 +0000927 return test_bit(feature, &efi.flags) != 0;
928}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929#else
Matt Fleming3e909592014-01-15 13:21:22 +0000930static inline bool efi_enabled(int feature)
Matt Fleming83e68182012-11-14 09:42:35 +0000931{
Matt Fleming3e909592014-01-15 13:21:22 +0000932 return false;
Matt Fleming83e68182012-11-14 09:42:35 +0000933}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934#endif
935
936/*
937 * Variable Attributes
938 */
939#define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
940#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
941#define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
Matthew Garrett41b32542012-04-30 16:11:29 -0400942#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
943#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
944#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
945#define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946
Matthew Garrett41b32542012-04-30 16:11:29 -0400947#define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
948 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
949 EFI_VARIABLE_RUNTIME_ACCESS | \
950 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
951 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
952 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
953 EFI_VARIABLE_APPEND_WRITE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954/*
Matt Fleminge14ab232013-02-03 20:16:40 +0000955 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
956 * not including trailing NUL
957 */
958#define EFI_VARIABLE_GUID_LEN 36
959
960/*
Matt Fleminge2527a72011-11-15 12:57:26 +0000961 * The type of search to perform when calling boottime->locate_handle
962 */
963#define EFI_LOCATE_ALL_HANDLES 0
964#define EFI_LOCATE_BY_REGISTER_NOTIFY 1
965#define EFI_LOCATE_BY_PROTOCOL 2
966
967/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 * EFI Device Path information
969 */
970#define EFI_DEV_HW 0x01
971#define EFI_DEV_PCI 1
972#define EFI_DEV_PCCARD 2
973#define EFI_DEV_MEM_MAPPED 3
974#define EFI_DEV_VENDOR 4
975#define EFI_DEV_CONTROLLER 5
976#define EFI_DEV_ACPI 0x02
977#define EFI_DEV_BASIC_ACPI 1
978#define EFI_DEV_EXPANDED_ACPI 2
979#define EFI_DEV_MSG 0x03
980#define EFI_DEV_MSG_ATAPI 1
981#define EFI_DEV_MSG_SCSI 2
982#define EFI_DEV_MSG_FC 3
983#define EFI_DEV_MSG_1394 4
984#define EFI_DEV_MSG_USB 5
985#define EFI_DEV_MSG_USB_CLASS 15
986#define EFI_DEV_MSG_I20 6
987#define EFI_DEV_MSG_MAC 11
988#define EFI_DEV_MSG_IPV4 12
989#define EFI_DEV_MSG_IPV6 13
990#define EFI_DEV_MSG_INFINIBAND 9
991#define EFI_DEV_MSG_UART 14
992#define EFI_DEV_MSG_VENDOR 10
993#define EFI_DEV_MEDIA 0x04
994#define EFI_DEV_MEDIA_HARD_DRIVE 1
995#define EFI_DEV_MEDIA_CDROM 2
996#define EFI_DEV_MEDIA_VENDOR 3
997#define EFI_DEV_MEDIA_FILE 4
998#define EFI_DEV_MEDIA_PROTOCOL 5
999#define EFI_DEV_BIOS_BOOT 0x05
1000#define EFI_DEV_END_PATH 0x7F
1001#define EFI_DEV_END_PATH2 0xFF
1002#define EFI_DEV_END_INSTANCE 0x01
1003#define EFI_DEV_END_ENTIRE 0xFF
1004
1005struct efi_generic_dev_path {
1006 u8 type;
1007 u8 sub_type;
1008 u16 length;
1009} __attribute ((packed));
1010
Huang, Ying4a3575f2008-02-25 15:18:37 +08001011static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1012{
1013 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1014 *addr &= PAGE_MASK;
1015}
1016
Matt Fleming04851772013-02-08 15:48:51 +00001017/*
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001018 * EFI Variable support.
1019 *
1020 * Different firmware drivers can expose their EFI-like variables using
1021 * the following.
1022 */
1023
1024struct efivar_operations {
1025 efi_get_variable_t *get_variable;
1026 efi_get_next_variable_t *get_next_variable;
1027 efi_set_variable_t *set_variable;
Matt Fleminga6e4d5a2013-03-25 09:14:30 +00001028 efi_query_variable_store_t *query_variable_store;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001029};
1030
1031struct efivars {
1032 /*
1033 * ->lock protects two things:
1034 * 1) ->list - adds, removals, reads, writes
1035 * 2) ops.[gs]et_variable() calls.
1036 * It must not be held when creating sysfs entries or calling kmalloc.
Seiji Aguchia93bc0c2013-02-12 13:04:41 -08001037 * ops.get_next_variable() is only called from register_efivars()
1038 * or efivar_update_sysfs_entries(),
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001039 * which is protected by the BKL, so that path is safe.
1040 */
1041 spinlock_t lock;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001042 struct kset *kset;
Lee, Chun-Yi605e70c2012-10-05 13:54:56 +08001043 struct kobject *kobject;
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001044 const struct efivar_operations *ops;
1045};
1046
Matt Fleminge14ab232013-02-03 20:16:40 +00001047/*
1048 * The maximum size of VariableName + Data = 1024
1049 * Therefore, it's reasonable to save that much
1050 * space in each part of the structure,
1051 * and we use a page for reading/writing.
1052 */
1053
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001054#define EFI_VAR_NAME_LEN 1024
1055
Matt Fleminge14ab232013-02-03 20:16:40 +00001056struct efi_variable {
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001057 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
Matt Fleminge14ab232013-02-03 20:16:40 +00001058 efi_guid_t VendorGuid;
1059 unsigned long DataSize;
1060 __u8 Data[1024];
1061 efi_status_t Status;
1062 __u32 Attributes;
1063} __attribute__((packed));
1064
1065struct efivar_entry {
1066 struct efi_variable var;
1067 struct list_head list;
1068 struct kobject kobj;
Seiji Aguchie0d59732013-10-30 15:27:26 -04001069 bool scanning;
1070 bool deleting;
Matt Fleminge14ab232013-02-03 20:16:40 +00001071};
1072
Matt Fleming677703c2014-01-10 13:47:37 +00001073struct efi_simple_text_output_protocol_32 {
1074 u32 reset;
1075 u32 output_string;
1076 u32 test_string;
1077};
1078
1079struct efi_simple_text_output_protocol_64 {
1080 u64 reset;
1081 u64 output_string;
1082 u64 test_string;
1083};
Roy Franzed37ddf2013-09-22 15:45:26 -07001084
1085struct efi_simple_text_output_protocol {
1086 void *reset;
1087 efi_status_t (*output_string)(void *, void *);
1088 void *test_string;
1089};
1090
Matt Fleming04851772013-02-08 15:48:51 +00001091extern struct list_head efivar_sysfs_list;
1092
1093static inline void
1094efivar_unregister(struct efivar_entry *var)
1095{
1096 kobject_put(&var->kobj);
1097}
1098
Matt Fleminge14ab232013-02-03 20:16:40 +00001099int efivars_register(struct efivars *efivars,
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001100 const struct efivar_operations *ops,
Matt Fleminge14ab232013-02-03 20:16:40 +00001101 struct kobject *kobject);
1102int efivars_unregister(struct efivars *efivars);
1103struct kobject *efivars_kobject(void);
1104
1105int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1106 void *data, bool atomic, bool duplicates,
1107 struct list_head *head);
1108
1109void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1110void efivar_entry_remove(struct efivar_entry *entry);
1111
1112int __efivar_entry_delete(struct efivar_entry *entry);
1113int efivar_entry_delete(struct efivar_entry *entry);
1114
Matt Fleminge14ab232013-02-03 20:16:40 +00001115int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
Matt Fleming8a415b82013-04-29 20:08:02 +01001116int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1117 unsigned long *size, void *data);
Matt Fleminge14ab232013-02-03 20:16:40 +00001118int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1119 unsigned long *size, void *data);
1120int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1121 unsigned long size, void *data, struct list_head *head);
1122int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1123 unsigned long *size, void *data, bool *set);
1124int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1125 bool block, unsigned long size, void *data);
1126
1127void efivar_entry_iter_begin(void);
1128void efivar_entry_iter_end(void);
1129
1130int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1131 struct list_head *head, void *data,
1132 struct efivar_entry **prev);
1133int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1134 struct list_head *head, void *data);
1135
1136struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1137 struct list_head *head, bool remove);
1138
Matt Fleminga5d92ad2014-03-17 10:57:00 +00001139bool efivar_validate(efi_char16_t *var_name, u8 *data, unsigned long len);
Matt Fleminge14ab232013-02-03 20:16:40 +00001140
Tom Gundersena9499fa2013-02-08 15:37:06 +00001141extern struct work_struct efivar_work;
Matt Fleming04851772013-02-08 15:48:51 +00001142void efivar_run_worker(void);
1143
Tom Gundersena9499fa2013-02-08 15:37:06 +00001144#if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
Matt Fleminge14ab232013-02-03 20:16:40 +00001145int efivars_sysfs_init(void);
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001146
Seiji Aguchie0d59732013-10-30 15:27:26 -04001147#define EFIVARS_DATA_SIZE_MAX 1024
1148
Mike Waychison4fc756bd2011-03-11 17:43:27 -08001149#endif /* CONFIG_EFI_VARS */
1150
Dave Young926172d2013-12-20 18:02:18 +08001151#ifdef CONFIG_EFI_RUNTIME_MAP
1152int efi_runtime_map_init(struct kobject *);
1153void efi_runtime_map_setup(void *, int, u32);
1154#else
1155static inline int efi_runtime_map_init(struct kobject *kobj)
1156{
1157 return 0;
1158}
1159
1160static inline void
1161efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
1162#endif
1163
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164#endif /* _LINUX_EFI_H */