Merge tag 'for-linus-3.15' of git://git.kernel.org/pub/scm/linux/kernel/git/ericvh...
[deliverable/linux.git] / include / linux / efi.h
1 #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>
21 #include <linux/pfn.h>
22 #include <linux/pstore.h>
23
24 #include <asm/page.h>
25
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)))
32 #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)))
36 #define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
37 #define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1)))
38
39 typedef unsigned long efi_status_t;
40 typedef u8 efi_bool_t;
41 typedef u16 efi_char16_t; /* UNICODE character */
42 typedef u64 efi_physical_addr_t;
43 typedef void *efi_handle_t;
44
45
46 typedef 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 */
60 typedef 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
101 #define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
102
103 typedef struct {
104 u32 type;
105 u32 pad;
106 u64 phys_addr;
107 u64 virt_addr;
108 u64 num_pages;
109 u64 attribute;
110 } efi_memory_desc_t;
111
112 typedef struct {
113 efi_guid_t guid;
114 u32 headersize;
115 u32 flags;
116 u32 imagesize;
117 } efi_capsule_header_t;
118
119 /*
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
127 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
128
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
136 typedef 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
150 typedef struct {
151 u32 resolution;
152 u32 accuracy;
153 u8 sets_to_zero;
154 } efi_time_cap_t;
155
156 typedef 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
204 typedef 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
252 /*
253 * EFI Boot Services table
254 */
255 typedef struct {
256 efi_table_hdr_t hdr;
257 void *raise_tpl;
258 void *restore_tpl;
259 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 *);
266 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;
275 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
276 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;
285 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
286 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
305 typedef 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
321 typedef enum {
322 EfiPciIoAttributeOperationGet,
323 EfiPciIoAttributeOperationSet,
324 EfiPciIoAttributeOperationEnable,
325 EfiPciIoAttributeOperationDisable,
326 EfiPciIoAttributeOperationSupported,
327 EfiPciIoAttributeOperationMaximum
328 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
329
330 typedef struct {
331 u32 read;
332 u32 write;
333 } efi_pci_io_protocol_access_32_t;
334
335 typedef struct {
336 u64 read;
337 u64 write;
338 } efi_pci_io_protocol_access_64_t;
339
340 typedef struct {
341 void *read;
342 void *write;
343 } efi_pci_io_protocol_access_t;
344
345 typedef struct {
346 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
365 typedef 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
385 typedef struct {
386 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
425 /*
426 * 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
438 typedef struct {
439 efi_table_hdr_t hdr;
440 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
456 typedef 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
474 typedef struct {
475 efi_table_hdr_t hdr;
476 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;
490 } efi_runtime_services_t;
491
492 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
493 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
494 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
495 efi_time_t *tm);
496 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
497 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
498 unsigned long *data_size, void *data);
499 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
500 efi_guid_t *vendor);
501 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
502 u32 attr, unsigned long data_size,
503 void *data);
504 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
505 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
506 unsigned long data_size, efi_char16_t *data);
507 typedef 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);
511 typedef efi_status_t efi_query_variable_info_t(u32 attr,
512 u64 *storage_space,
513 u64 *remaining_space,
514 u64 *max_variable_size);
515 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
516 unsigned long count,
517 unsigned long sg_list);
518 typedef 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);
522 typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
523
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
554 #define UV_SYSTEM_TABLE_GUID \
555 EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
556
557 #define LINUX_EFI_CRASH_GUID \
558 EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
559
560 #define LOADED_IMAGE_PROTOCOL_GUID \
561 EFI_GUID( 0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
562
563 #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
572 #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
578 typedef struct {
579 efi_guid_t guid;
580 u64 table;
581 } efi_config_table_64_t;
582
583 typedef struct {
584 efi_guid_t guid;
585 u32 table;
586 } efi_config_table_32_t;
587
588 typedef struct {
589 efi_guid_t guid;
590 unsigned long table;
591 } efi_config_table_t;
592
593 typedef struct {
594 efi_guid_t guid;
595 const char *name;
596 unsigned long *ptr;
597 } efi_config_table_type_t;
598
599 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
600
601 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
602 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
603 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
604 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
605 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
606 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
607
608 typedef struct {
609 efi_table_hdr_t hdr;
610 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
611 u32 fw_revision;
612 u32 __pad1;
613 u64 con_in_handle;
614 u64 con_in;
615 u64 con_out_handle;
616 u64 con_out;
617 u64 stderr_handle;
618 u64 stderr;
619 u64 runtime;
620 u64 boottime;
621 u32 nr_tables;
622 u32 __pad2;
623 u64 tables;
624 } efi_system_table_64_t;
625
626 typedef struct {
627 efi_table_hdr_t hdr;
628 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
629 u32 fw_revision;
630 u32 con_in_handle;
631 u32 con_in;
632 u32 con_out_handle;
633 u32 con_out;
634 u32 stderr_handle;
635 u32 stderr;
636 u32 runtime;
637 u32 boottime;
638 u32 nr_tables;
639 u32 tables;
640 } efi_system_table_32_t;
641
642 typedef struct {
643 efi_table_hdr_t hdr;
644 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
645 u32 fw_revision;
646 unsigned long con_in_handle;
647 unsigned long con_in;
648 unsigned long con_out_handle;
649 unsigned long con_out;
650 unsigned long stderr_handle;
651 unsigned long stderr;
652 efi_runtime_services_t *runtime;
653 efi_boot_services_t *boottime;
654 unsigned long nr_tables;
655 unsigned long tables;
656 } efi_system_table_t;
657
658 struct efi_memory_map {
659 void *phys_map;
660 void *map;
661 void *map_end;
662 int nr_map;
663 unsigned long desc_version;
664 unsigned long desc_size;
665 };
666
667 typedef struct {
668 u32 revision;
669 u32 parent_handle;
670 u32 system_table;
671 u32 device_handle;
672 u32 file_path;
673 u32 reserved;
674 u32 load_options_size;
675 u32 load_options;
676 u32 image_base;
677 __aligned_u64 image_size;
678 unsigned int image_code_type;
679 unsigned int image_data_type;
680 unsigned long unload;
681 } efi_loaded_image_32_t;
682
683 typedef struct {
684 u32 revision;
685 u64 parent_handle;
686 u64 system_table;
687 u64 device_handle;
688 u64 file_path;
689 u64 reserved;
690 u32 load_options_size;
691 u64 load_options;
692 u64 image_base;
693 __aligned_u64 image_size;
694 unsigned int image_code_type;
695 unsigned int image_data_type;
696 unsigned long unload;
697 } efi_loaded_image_64_t;
698
699 typedef struct {
700 u32 revision;
701 void *parent_handle;
702 efi_system_table_t *system_table;
703 void *device_handle;
704 void *file_path;
705 void *reserved;
706 u32 load_options_size;
707 void *load_options;
708 void *image_base;
709 __aligned_u64 image_size;
710 unsigned int image_code_type;
711 unsigned int image_data_type;
712 unsigned long unload;
713 } efi_loaded_image_t;
714
715
716 typedef struct {
717 u64 size;
718 u64 file_size;
719 u64 phys_size;
720 efi_time_t create_time;
721 efi_time_t last_access_time;
722 efi_time_t modification_time;
723 __aligned_u64 attribute;
724 efi_char16_t filename[1];
725 } efi_file_info_t;
726
727 typedef struct {
728 u64 revision;
729 u32 open;
730 u32 close;
731 u32 delete;
732 u32 read;
733 u32 write;
734 u32 get_position;
735 u32 set_position;
736 u32 get_info;
737 u32 set_info;
738 u32 flush;
739 } efi_file_handle_32_t;
740
741 typedef struct {
742 u64 revision;
743 u64 open;
744 u64 close;
745 u64 delete;
746 u64 read;
747 u64 write;
748 u64 get_position;
749 u64 set_position;
750 u64 get_info;
751 u64 set_info;
752 u64 flush;
753 } efi_file_handle_64_t;
754
755 typedef struct _efi_file_handle {
756 u64 revision;
757 efi_status_t (*open)(struct _efi_file_handle *,
758 struct _efi_file_handle **,
759 efi_char16_t *, u64, u64);
760 efi_status_t (*close)(struct _efi_file_handle *);
761 void *delete;
762 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
763 void *);
764 void *write;
765 void *get_position;
766 void *set_position;
767 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
768 unsigned long *, void *);
769 void *set_info;
770 void *flush;
771 } efi_file_handle_t;
772
773 typedef struct _efi_file_io_interface {
774 u64 revision;
775 int (*open_volume)(struct _efi_file_io_interface *,
776 efi_file_handle_t **);
777 } efi_file_io_interface_t;
778
779 #define EFI_FILE_MODE_READ 0x0000000000000001
780 #define EFI_FILE_MODE_WRITE 0x0000000000000002
781 #define EFI_FILE_MODE_CREATE 0x8000000000000000
782
783 #define EFI_INVALID_TABLE_ADDR (~0UL)
784
785 /*
786 * All runtime access to EFI goes through this structure:
787 */
788 extern struct efi {
789 efi_system_table_t *systab; /* EFI system table */
790 unsigned int runtime_version; /* Runtime services version */
791 unsigned long mps; /* MPS table */
792 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
793 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
794 unsigned long smbios; /* SM BIOS table */
795 unsigned long sal_systab; /* SAL system table */
796 unsigned long boot_info; /* boot info table */
797 unsigned long hcdp; /* HCDP table */
798 unsigned long uga; /* UGA table */
799 unsigned long uv_systab; /* UV system table */
800 unsigned long fw_vendor; /* fw_vendor */
801 unsigned long runtime; /* runtime table */
802 unsigned long config_table; /* config tables */
803 efi_get_time_t *get_time;
804 efi_set_time_t *set_time;
805 efi_get_wakeup_time_t *get_wakeup_time;
806 efi_set_wakeup_time_t *set_wakeup_time;
807 efi_get_variable_t *get_variable;
808 efi_get_next_variable_t *get_next_variable;
809 efi_set_variable_t *set_variable;
810 efi_query_variable_info_t *query_variable_info;
811 efi_update_capsule_t *update_capsule;
812 efi_query_capsule_caps_t *query_capsule_caps;
813 efi_get_next_high_mono_count_t *get_next_high_mono_count;
814 efi_reset_system_t *reset_system;
815 efi_set_virtual_address_map_t *set_virtual_address_map;
816 struct efi_memory_map *memmap;
817 unsigned long flags;
818 } efi;
819
820 static inline int
821 efi_guidcmp (efi_guid_t left, efi_guid_t right)
822 {
823 return memcmp(&left, &right, sizeof (efi_guid_t));
824 }
825
826 static inline char *
827 efi_guid_unparse(efi_guid_t *guid, char *out)
828 {
829 sprintf(out, "%pUl", guid->b);
830 return out;
831 }
832
833 extern void efi_init (void);
834 extern void *efi_get_pal_addr (void);
835 extern void efi_map_pal_code (void);
836 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
837 extern void efi_gettimeofday (struct timespec *ts);
838 extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
839 #ifdef CONFIG_X86
840 extern void efi_late_init(void);
841 extern void efi_free_boot_services(void);
842 extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
843 #else
844 static inline void efi_late_init(void) {}
845 static inline void efi_free_boot_services(void) {}
846
847 static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
848 {
849 return EFI_SUCCESS;
850 }
851 #endif
852 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
853 extern int efi_config_init(efi_config_table_type_t *arch_tables);
854 extern u64 efi_get_iobase (void);
855 extern u32 efi_mem_type (unsigned long phys_addr);
856 extern u64 efi_mem_attributes (unsigned long phys_addr);
857 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
858 extern int __init efi_uart_console_only (void);
859 extern void efi_initialize_iomem_resources(struct resource *code_resource,
860 struct resource *data_resource, struct resource *bss_resource);
861 extern void efi_get_time(struct timespec *now);
862 extern int efi_set_rtc_mmss(const struct timespec *now);
863 extern void efi_reserve_boot_services(void);
864 extern struct efi_memory_map memmap;
865
866 /**
867 * efi_range_is_wc - check the WC bit on an address range
868 * @start: starting kvirt address
869 * @len: length of range
870 *
871 * Consult the EFI memory map and make sure it's ok to set this range WC.
872 * Returns true or false.
873 */
874 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
875 {
876 unsigned long i;
877
878 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
879 unsigned long paddr = __pa(start + i);
880 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
881 return 0;
882 }
883 /* The range checked out */
884 return 1;
885 }
886
887 #ifdef CONFIG_EFI_PCDP
888 extern int __init efi_setup_pcdp_console(char *);
889 #endif
890
891 /*
892 * We play games with efi_enabled so that the compiler will, if
893 * possible, remove EFI-related code altogether.
894 */
895 #define EFI_BOOT 0 /* Were we booted from EFI? */
896 #define EFI_SYSTEM_TABLES 1 /* Can we use EFI system tables? */
897 #define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
898 #define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
899 #define EFI_MEMMAP 4 /* Can we use EFI memory map? */
900 #define EFI_64BIT 5 /* Is the firmware 64-bit? */
901 #define EFI_ARCH_1 6 /* First arch-specific bit */
902
903 #ifdef CONFIG_EFI
904 /*
905 * Test whether the above EFI_* bits are enabled.
906 */
907 static inline bool efi_enabled(int feature)
908 {
909 return test_bit(feature, &efi.flags) != 0;
910 }
911 #else
912 static inline bool efi_enabled(int feature)
913 {
914 return false;
915 }
916 #endif
917
918 /*
919 * Variable Attributes
920 */
921 #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
922 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
923 #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
924 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
925 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
926 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
927 #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
928
929 #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
930 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
931 EFI_VARIABLE_RUNTIME_ACCESS | \
932 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
933 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
934 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
935 EFI_VARIABLE_APPEND_WRITE)
936 /*
937 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
938 * not including trailing NUL
939 */
940 #define EFI_VARIABLE_GUID_LEN 36
941
942 /*
943 * The type of search to perform when calling boottime->locate_handle
944 */
945 #define EFI_LOCATE_ALL_HANDLES 0
946 #define EFI_LOCATE_BY_REGISTER_NOTIFY 1
947 #define EFI_LOCATE_BY_PROTOCOL 2
948
949 /*
950 * EFI Device Path information
951 */
952 #define EFI_DEV_HW 0x01
953 #define EFI_DEV_PCI 1
954 #define EFI_DEV_PCCARD 2
955 #define EFI_DEV_MEM_MAPPED 3
956 #define EFI_DEV_VENDOR 4
957 #define EFI_DEV_CONTROLLER 5
958 #define EFI_DEV_ACPI 0x02
959 #define EFI_DEV_BASIC_ACPI 1
960 #define EFI_DEV_EXPANDED_ACPI 2
961 #define EFI_DEV_MSG 0x03
962 #define EFI_DEV_MSG_ATAPI 1
963 #define EFI_DEV_MSG_SCSI 2
964 #define EFI_DEV_MSG_FC 3
965 #define EFI_DEV_MSG_1394 4
966 #define EFI_DEV_MSG_USB 5
967 #define EFI_DEV_MSG_USB_CLASS 15
968 #define EFI_DEV_MSG_I20 6
969 #define EFI_DEV_MSG_MAC 11
970 #define EFI_DEV_MSG_IPV4 12
971 #define EFI_DEV_MSG_IPV6 13
972 #define EFI_DEV_MSG_INFINIBAND 9
973 #define EFI_DEV_MSG_UART 14
974 #define EFI_DEV_MSG_VENDOR 10
975 #define EFI_DEV_MEDIA 0x04
976 #define EFI_DEV_MEDIA_HARD_DRIVE 1
977 #define EFI_DEV_MEDIA_CDROM 2
978 #define EFI_DEV_MEDIA_VENDOR 3
979 #define EFI_DEV_MEDIA_FILE 4
980 #define EFI_DEV_MEDIA_PROTOCOL 5
981 #define EFI_DEV_BIOS_BOOT 0x05
982 #define EFI_DEV_END_PATH 0x7F
983 #define EFI_DEV_END_PATH2 0xFF
984 #define EFI_DEV_END_INSTANCE 0x01
985 #define EFI_DEV_END_ENTIRE 0xFF
986
987 struct efi_generic_dev_path {
988 u8 type;
989 u8 sub_type;
990 u16 length;
991 } __attribute ((packed));
992
993 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
994 {
995 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
996 *addr &= PAGE_MASK;
997 }
998
999 /*
1000 * EFI Variable support.
1001 *
1002 * Different firmware drivers can expose their EFI-like variables using
1003 * the following.
1004 */
1005
1006 struct efivar_operations {
1007 efi_get_variable_t *get_variable;
1008 efi_get_next_variable_t *get_next_variable;
1009 efi_set_variable_t *set_variable;
1010 efi_query_variable_store_t *query_variable_store;
1011 };
1012
1013 struct efivars {
1014 /*
1015 * ->lock protects two things:
1016 * 1) ->list - adds, removals, reads, writes
1017 * 2) ops.[gs]et_variable() calls.
1018 * It must not be held when creating sysfs entries or calling kmalloc.
1019 * ops.get_next_variable() is only called from register_efivars()
1020 * or efivar_update_sysfs_entries(),
1021 * which is protected by the BKL, so that path is safe.
1022 */
1023 spinlock_t lock;
1024 struct kset *kset;
1025 struct kobject *kobject;
1026 const struct efivar_operations *ops;
1027 };
1028
1029 /*
1030 * The maximum size of VariableName + Data = 1024
1031 * Therefore, it's reasonable to save that much
1032 * space in each part of the structure,
1033 * and we use a page for reading/writing.
1034 */
1035
1036 struct efi_variable {
1037 efi_char16_t VariableName[1024/sizeof(efi_char16_t)];
1038 efi_guid_t VendorGuid;
1039 unsigned long DataSize;
1040 __u8 Data[1024];
1041 efi_status_t Status;
1042 __u32 Attributes;
1043 } __attribute__((packed));
1044
1045 struct efivar_entry {
1046 struct efi_variable var;
1047 struct list_head list;
1048 struct kobject kobj;
1049 bool scanning;
1050 bool deleting;
1051 };
1052
1053 struct efi_simple_text_output_protocol_32 {
1054 u32 reset;
1055 u32 output_string;
1056 u32 test_string;
1057 };
1058
1059 struct efi_simple_text_output_protocol_64 {
1060 u64 reset;
1061 u64 output_string;
1062 u64 test_string;
1063 };
1064
1065 struct efi_simple_text_output_protocol {
1066 void *reset;
1067 efi_status_t (*output_string)(void *, void *);
1068 void *test_string;
1069 };
1070
1071 extern struct list_head efivar_sysfs_list;
1072
1073 static inline void
1074 efivar_unregister(struct efivar_entry *var)
1075 {
1076 kobject_put(&var->kobj);
1077 }
1078
1079 int efivars_register(struct efivars *efivars,
1080 const struct efivar_operations *ops,
1081 struct kobject *kobject);
1082 int efivars_unregister(struct efivars *efivars);
1083 struct kobject *efivars_kobject(void);
1084
1085 int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1086 void *data, bool atomic, bool duplicates,
1087 struct list_head *head);
1088
1089 void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1090 void efivar_entry_remove(struct efivar_entry *entry);
1091
1092 int __efivar_entry_delete(struct efivar_entry *entry);
1093 int efivar_entry_delete(struct efivar_entry *entry);
1094
1095 int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
1096 int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1097 unsigned long *size, void *data);
1098 int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1099 unsigned long *size, void *data);
1100 int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1101 unsigned long size, void *data, struct list_head *head);
1102 int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1103 unsigned long *size, void *data, bool *set);
1104 int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1105 bool block, unsigned long size, void *data);
1106
1107 void efivar_entry_iter_begin(void);
1108 void efivar_entry_iter_end(void);
1109
1110 int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1111 struct list_head *head, void *data,
1112 struct efivar_entry **prev);
1113 int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1114 struct list_head *head, void *data);
1115
1116 struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1117 struct list_head *head, bool remove);
1118
1119 bool efivar_validate(struct efi_variable *var, u8 *data, unsigned long len);
1120
1121 extern struct work_struct efivar_work;
1122 void efivar_run_worker(void);
1123
1124 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
1125 int efivars_sysfs_init(void);
1126
1127 #define EFIVARS_DATA_SIZE_MAX 1024
1128
1129 #endif /* CONFIG_EFI_VARS */
1130
1131 #ifdef CONFIG_EFI_RUNTIME_MAP
1132 int efi_runtime_map_init(struct kobject *);
1133 void efi_runtime_map_setup(void *, int, u32);
1134 #else
1135 static inline int efi_runtime_map_init(struct kobject *kobj)
1136 {
1137 return 0;
1138 }
1139
1140 static inline void
1141 efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
1142 #endif
1143
1144 #endif /* _LINUX_EFI_H */
This page took 0.05444 seconds and 5 git commands to generate.