Linux-libre 3.16.85-gnu
[librecmc/linux-libre.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 #include <linux/reboot.h>
24
25 #include <asm/page.h>
26
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)))
33 #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)))
37 #define EFI_NOT_FOUND           (14 | (1UL << (BITS_PER_LONG-1)))
38 #define EFI_SECURITY_VIOLATION  (26 | (1UL << (BITS_PER_LONG-1)))
39
40 typedef unsigned long efi_status_t;
41 typedef u8 efi_bool_t;
42 typedef u16 efi_char16_t;               /* UNICODE character */
43 typedef u64 efi_physical_addr_t;
44 typedef void *efi_handle_t;
45
46
47 typedef 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  */
61 typedef 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
102 #define EFI_PAGE_SIZE           (1UL << EFI_PAGE_SHIFT)
103
104 typedef struct {
105         u32 type;
106         u32 pad;
107         u64 phys_addr;
108         u64 virt_addr;
109         u64 num_pages;
110         u64 attribute;
111 } efi_memory_desc_t;
112
113 typedef struct {
114         efi_guid_t guid;
115         u32 headersize;
116         u32 flags;
117         u32 imagesize;
118 } efi_capsule_header_t;
119
120 struct efi_boot_memmap {
121         efi_memory_desc_t       **map;
122         unsigned long           *map_size;
123         unsigned long           *desc_size;
124         u32                     *desc_ver;
125         unsigned long           *key_ptr;
126         unsigned long           *buff_size;
127 };
128
129 /*
130  * Allocation types for calls to boottime->allocate_pages.
131  */
132 #define EFI_ALLOCATE_ANY_PAGES          0
133 #define EFI_ALLOCATE_MAX_ADDRESS        1
134 #define EFI_ALLOCATE_ADDRESS            2
135 #define EFI_MAX_ALLOCATE_TYPE           3
136
137 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
138
139 /*
140  * Types and defines for Time Services
141  */
142 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
143 #define EFI_TIME_IN_DAYLIGHT     0x2
144 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
145
146 typedef struct {
147         u16 year;
148         u8 month;
149         u8 day;
150         u8 hour;
151         u8 minute;
152         u8 second;
153         u8 pad1;
154         u32 nanosecond;
155         s16 timezone;
156         u8 daylight;
157         u8 pad2;
158 } efi_time_t;
159
160 typedef struct {
161         u32 resolution;
162         u32 accuracy;
163         u8 sets_to_zero;
164 } efi_time_cap_t;
165
166 typedef struct {
167         efi_table_hdr_t hdr;
168         u32 raise_tpl;
169         u32 restore_tpl;
170         u32 allocate_pages;
171         u32 free_pages;
172         u32 get_memory_map;
173         u32 allocate_pool;
174         u32 free_pool;
175         u32 create_event;
176         u32 set_timer;
177         u32 wait_for_event;
178         u32 signal_event;
179         u32 close_event;
180         u32 check_event;
181         u32 install_protocol_interface;
182         u32 reinstall_protocol_interface;
183         u32 uninstall_protocol_interface;
184         u32 handle_protocol;
185         u32 __reserved;
186         u32 register_protocol_notify;
187         u32 locate_handle;
188         u32 locate_device_path;
189         u32 install_configuration_table;
190         u32 load_image;
191         u32 start_image;
192         u32 exit;
193         u32 unload_image;
194         u32 exit_boot_services;
195         u32 get_next_monotonic_count;
196         u32 stall;
197         u32 set_watchdog_timer;
198         u32 connect_controller;
199         u32 disconnect_controller;
200         u32 open_protocol;
201         u32 close_protocol;
202         u32 open_protocol_information;
203         u32 protocols_per_handle;
204         u32 locate_handle_buffer;
205         u32 locate_protocol;
206         u32 install_multiple_protocol_interfaces;
207         u32 uninstall_multiple_protocol_interfaces;
208         u32 calculate_crc32;
209         u32 copy_mem;
210         u32 set_mem;
211         u32 create_event_ex;
212 } __packed efi_boot_services_32_t;
213
214 typedef struct {
215         efi_table_hdr_t hdr;
216         u64 raise_tpl;
217         u64 restore_tpl;
218         u64 allocate_pages;
219         u64 free_pages;
220         u64 get_memory_map;
221         u64 allocate_pool;
222         u64 free_pool;
223         u64 create_event;
224         u64 set_timer;
225         u64 wait_for_event;
226         u64 signal_event;
227         u64 close_event;
228         u64 check_event;
229         u64 install_protocol_interface;
230         u64 reinstall_protocol_interface;
231         u64 uninstall_protocol_interface;
232         u64 handle_protocol;
233         u64 __reserved;
234         u64 register_protocol_notify;
235         u64 locate_handle;
236         u64 locate_device_path;
237         u64 install_configuration_table;
238         u64 load_image;
239         u64 start_image;
240         u64 exit;
241         u64 unload_image;
242         u64 exit_boot_services;
243         u64 get_next_monotonic_count;
244         u64 stall;
245         u64 set_watchdog_timer;
246         u64 connect_controller;
247         u64 disconnect_controller;
248         u64 open_protocol;
249         u64 close_protocol;
250         u64 open_protocol_information;
251         u64 protocols_per_handle;
252         u64 locate_handle_buffer;
253         u64 locate_protocol;
254         u64 install_multiple_protocol_interfaces;
255         u64 uninstall_multiple_protocol_interfaces;
256         u64 calculate_crc32;
257         u64 copy_mem;
258         u64 set_mem;
259         u64 create_event_ex;
260 } __packed efi_boot_services_64_t;
261
262 /*
263  * EFI Boot Services table
264  */
265 typedef struct {
266         efi_table_hdr_t hdr;
267         void *raise_tpl;
268         void *restore_tpl;
269         efi_status_t (*allocate_pages)(int, int, unsigned long,
270                                        efi_physical_addr_t *);
271         efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
272         efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
273                                        unsigned long *, u32 *);
274         efi_status_t (*allocate_pool)(int, unsigned long, void **);
275         efi_status_t (*free_pool)(void *);
276         void *create_event;
277         void *set_timer;
278         void *wait_for_event;
279         void *signal_event;
280         void *close_event;
281         void *check_event;
282         void *install_protocol_interface;
283         void *reinstall_protocol_interface;
284         void *uninstall_protocol_interface;
285         efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
286         void *__reserved;
287         void *register_protocol_notify;
288         void *locate_handle;
289         void *locate_device_path;
290         void *install_configuration_table;
291         void *load_image;
292         void *start_image;
293         void *exit;
294         void *unload_image;
295         efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
296         void *get_next_monotonic_count;
297         void *stall;
298         void *set_watchdog_timer;
299         void *connect_controller;
300         void *disconnect_controller;
301         void *open_protocol;
302         void *close_protocol;
303         void *open_protocol_information;
304         void *protocols_per_handle;
305         void *locate_handle_buffer;
306         void *locate_protocol;
307         void *install_multiple_protocol_interfaces;
308         void *uninstall_multiple_protocol_interfaces;
309         void *calculate_crc32;
310         void *copy_mem;
311         void *set_mem;
312         void *create_event_ex;
313 } efi_boot_services_t;
314
315 typedef enum {
316         EfiPciIoWidthUint8,
317         EfiPciIoWidthUint16,
318         EfiPciIoWidthUint32,
319         EfiPciIoWidthUint64,
320         EfiPciIoWidthFifoUint8,
321         EfiPciIoWidthFifoUint16,
322         EfiPciIoWidthFifoUint32,
323         EfiPciIoWidthFifoUint64,
324         EfiPciIoWidthFillUint8,
325         EfiPciIoWidthFillUint16,
326         EfiPciIoWidthFillUint32,
327         EfiPciIoWidthFillUint64,
328         EfiPciIoWidthMaximum
329 } EFI_PCI_IO_PROTOCOL_WIDTH;
330
331 typedef enum {
332         EfiPciIoAttributeOperationGet,
333         EfiPciIoAttributeOperationSet,
334         EfiPciIoAttributeOperationEnable,
335         EfiPciIoAttributeOperationDisable,
336         EfiPciIoAttributeOperationSupported,
337     EfiPciIoAttributeOperationMaximum
338 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
339
340 typedef struct {
341         u32 read;
342         u32 write;
343 } efi_pci_io_protocol_access_32_t;
344
345 typedef struct {
346         u64 read;
347         u64 write;
348 } efi_pci_io_protocol_access_64_t;
349
350 typedef struct {
351         void *read;
352         void *write;
353 } efi_pci_io_protocol_access_t;
354
355 typedef struct {
356         u32 poll_mem;
357         u32 poll_io;
358         efi_pci_io_protocol_access_32_t mem;
359         efi_pci_io_protocol_access_32_t io;
360         efi_pci_io_protocol_access_32_t pci;
361         u32 copy_mem;
362         u32 map;
363         u32 unmap;
364         u32 allocate_buffer;
365         u32 free_buffer;
366         u32 flush;
367         u32 get_location;
368         u32 attributes;
369         u32 get_bar_attributes;
370         u32 set_bar_attributes;
371         u64 romsize;
372         u32 romimage;
373 } efi_pci_io_protocol_32;
374
375 typedef struct {
376         u64 poll_mem;
377         u64 poll_io;
378         efi_pci_io_protocol_access_64_t mem;
379         efi_pci_io_protocol_access_64_t io;
380         efi_pci_io_protocol_access_64_t pci;
381         u64 copy_mem;
382         u64 map;
383         u64 unmap;
384         u64 allocate_buffer;
385         u64 free_buffer;
386         u64 flush;
387         u64 get_location;
388         u64 attributes;
389         u64 get_bar_attributes;
390         u64 set_bar_attributes;
391         u64 romsize;
392         u64 romimage;
393 } efi_pci_io_protocol_64;
394
395 typedef struct {
396         void *poll_mem;
397         void *poll_io;
398         efi_pci_io_protocol_access_t mem;
399         efi_pci_io_protocol_access_t io;
400         efi_pci_io_protocol_access_t pci;
401         void *copy_mem;
402         void *map;
403         void *unmap;
404         void *allocate_buffer;
405         void *free_buffer;
406         void *flush;
407         void *get_location;
408         void *attributes;
409         void *get_bar_attributes;
410         void *set_bar_attributes;
411         uint64_t romsize;
412         void *romimage;
413 } efi_pci_io_protocol;
414
415 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
416 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
417 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
418 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
419 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
420 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
421 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
422 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
423 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
424 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
425 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
426 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
427 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
428 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
429 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
430 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
431 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
432 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
433 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
434
435 /*
436  * Types and defines for EFI ResetSystem
437  */
438 #define EFI_RESET_COLD 0
439 #define EFI_RESET_WARM 1
440 #define EFI_RESET_SHUTDOWN 2
441
442 /*
443  * EFI Runtime Services table
444  */
445 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
446 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
447
448 typedef struct {
449         efi_table_hdr_t hdr;
450         u32 get_time;
451         u32 set_time;
452         u32 get_wakeup_time;
453         u32 set_wakeup_time;
454         u32 set_virtual_address_map;
455         u32 convert_pointer;
456         u32 get_variable;
457         u32 get_next_variable;
458         u32 set_variable;
459         u32 get_next_high_mono_count;
460         u32 reset_system;
461         u32 update_capsule;
462         u32 query_capsule_caps;
463         u32 query_variable_info;
464 } efi_runtime_services_32_t;
465
466 typedef struct {
467         efi_table_hdr_t hdr;
468         u64 get_time;
469         u64 set_time;
470         u64 get_wakeup_time;
471         u64 set_wakeup_time;
472         u64 set_virtual_address_map;
473         u64 convert_pointer;
474         u64 get_variable;
475         u64 get_next_variable;
476         u64 set_variable;
477         u64 get_next_high_mono_count;
478         u64 reset_system;
479         u64 update_capsule;
480         u64 query_capsule_caps;
481         u64 query_variable_info;
482 } efi_runtime_services_64_t;
483
484 typedef struct {
485         efi_table_hdr_t hdr;
486         void *get_time;
487         void *set_time;
488         void *get_wakeup_time;
489         void *set_wakeup_time;
490         void *set_virtual_address_map;
491         void *convert_pointer;
492         void *get_variable;
493         void *get_next_variable;
494         void *set_variable;
495         void *get_next_high_mono_count;
496         void *reset_system;
497         void *update_capsule;
498         void *query_capsule_caps;
499         void *query_variable_info;
500 } efi_runtime_services_t;
501
502 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
503 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
504 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
505                                             efi_time_t *tm);
506 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
507 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
508                                          unsigned long *data_size, void *data);
509 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
510                                               efi_guid_t *vendor);
511 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor, 
512                                          u32 attr, unsigned long data_size,
513                                          void *data);
514 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
515 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
516                                  unsigned long data_size, efi_char16_t *data);
517 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
518                                                 unsigned long descriptor_size,
519                                                 u32 descriptor_version,
520                                                 efi_memory_desc_t *virtual_map);
521 typedef efi_status_t efi_query_variable_info_t(u32 attr,
522                                                u64 *storage_space,
523                                                u64 *remaining_space,
524                                                u64 *max_variable_size);
525 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
526                                           unsigned long count,
527                                           unsigned long sg_list);
528 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
529                                               unsigned long count,
530                                               u64 *max_size,
531                                               int *reset_type);
532 typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
533
534 /*
535  *  EFI Configuration Table and GUID definitions
536  */
537 #define NULL_GUID \
538     EFI_GUID(  0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
539
540 #define MPS_TABLE_GUID    \
541     EFI_GUID(  0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
542
543 #define ACPI_TABLE_GUID    \
544     EFI_GUID(  0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
545
546 #define ACPI_20_TABLE_GUID    \
547     EFI_GUID(  0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
548
549 #define SMBIOS_TABLE_GUID    \
550     EFI_GUID(  0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
551
552 #define SAL_SYSTEM_TABLE_GUID    \
553     EFI_GUID(  0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
554
555 #define HCDP_TABLE_GUID \
556     EFI_GUID(  0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
557
558 #define UGA_IO_PROTOCOL_GUID \
559     EFI_GUID(  0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
560
561 #define EFI_GLOBAL_VARIABLE_GUID \
562     EFI_GUID(  0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
563
564 #define UV_SYSTEM_TABLE_GUID \
565     EFI_GUID(  0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
566
567 #define LINUX_EFI_CRASH_GUID \
568     EFI_GUID(  0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
569
570 #define LOADED_IMAGE_PROTOCOL_GUID \
571     EFI_GUID(  0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
572
573 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
574     EFI_GUID(  0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
575
576 #define EFI_UGA_PROTOCOL_GUID \
577     EFI_GUID(  0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
578
579 #define EFI_PCI_IO_PROTOCOL_GUID \
580     EFI_GUID(  0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
581
582 #define EFI_FILE_INFO_ID \
583     EFI_GUID(  0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
584
585 #define EFI_FILE_SYSTEM_GUID \
586     EFI_GUID(  0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
587
588 #define DEVICE_TREE_GUID \
589     EFI_GUID(  0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0 )
590
591 typedef struct {
592         efi_guid_t guid;
593         u64 table;
594 } efi_config_table_64_t;
595
596 typedef struct {
597         efi_guid_t guid;
598         u32 table;
599 } efi_config_table_32_t;
600
601 typedef struct {
602         efi_guid_t guid;
603         unsigned long table;
604 } efi_config_table_t;
605
606 typedef struct {
607         efi_guid_t guid;
608         const char *name;
609         unsigned long *ptr;
610 } efi_config_table_type_t;
611
612 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
613
614 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
615 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
616 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
617 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
618 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
619 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
620
621 typedef struct {
622         efi_table_hdr_t hdr;
623         u64 fw_vendor;  /* physical addr of CHAR16 vendor string */
624         u32 fw_revision;
625         u32 __pad1;
626         u64 con_in_handle;
627         u64 con_in;
628         u64 con_out_handle;
629         u64 con_out;
630         u64 stderr_handle;
631         u64 stderr;
632         u64 runtime;
633         u64 boottime;
634         u32 nr_tables;
635         u32 __pad2;
636         u64 tables;
637 } efi_system_table_64_t;
638
639 typedef struct {
640         efi_table_hdr_t hdr;
641         u32 fw_vendor;  /* physical addr of CHAR16 vendor string */
642         u32 fw_revision;
643         u32 con_in_handle;
644         u32 con_in;
645         u32 con_out_handle;
646         u32 con_out;
647         u32 stderr_handle;
648         u32 stderr;
649         u32 runtime;
650         u32 boottime;
651         u32 nr_tables;
652         u32 tables;
653 } efi_system_table_32_t;
654
655 typedef struct {
656         efi_table_hdr_t hdr;
657         unsigned long fw_vendor;        /* physical addr of CHAR16 vendor string */
658         u32 fw_revision;
659         unsigned long con_in_handle;
660         unsigned long con_in;
661         unsigned long con_out_handle;
662         unsigned long con_out;
663         unsigned long stderr_handle;
664         unsigned long stderr;
665         efi_runtime_services_t *runtime;
666         efi_boot_services_t *boottime;
667         unsigned long nr_tables;
668         unsigned long tables;
669 } efi_system_table_t;
670
671 struct efi_memory_map {
672         void *phys_map;
673         void *map;
674         void *map_end;
675         int nr_map;
676         unsigned long desc_version;
677         unsigned long desc_size;
678 };
679
680 struct efi_fdt_params {
681         u64 system_table;
682         u64 mmap;
683         u32 mmap_size;
684         u32 desc_size;
685         u32 desc_ver;
686 };
687
688 typedef struct {
689         u32 revision;
690         u32 parent_handle;
691         u32 system_table;
692         u32 device_handle;
693         u32 file_path;
694         u32 reserved;
695         u32 load_options_size;
696         u32 load_options;
697         u32 image_base;
698         __aligned_u64 image_size;
699         unsigned int image_code_type;
700         unsigned int image_data_type;
701         unsigned long unload;
702 } efi_loaded_image_32_t;
703
704 typedef struct {
705         u32 revision;
706         u64 parent_handle;
707         u64 system_table;
708         u64 device_handle;
709         u64 file_path;
710         u64 reserved;
711         u32 load_options_size;
712         u64 load_options;
713         u64 image_base;
714         __aligned_u64 image_size;
715         unsigned int image_code_type;
716         unsigned int image_data_type;
717         unsigned long unload;
718 } efi_loaded_image_64_t;
719
720 typedef struct {
721         u32 revision;
722         void *parent_handle;
723         efi_system_table_t *system_table;
724         void *device_handle;
725         void *file_path;
726         void *reserved;
727         u32 load_options_size;
728         void *load_options;
729         void *image_base;
730         __aligned_u64 image_size;
731         unsigned int image_code_type;
732         unsigned int image_data_type;
733         unsigned long unload;
734 } efi_loaded_image_t;
735
736
737 typedef struct {
738         u64 size;
739         u64 file_size;
740         u64 phys_size;
741         efi_time_t create_time;
742         efi_time_t last_access_time;
743         efi_time_t modification_time;
744         __aligned_u64 attribute;
745         efi_char16_t filename[1];
746 } efi_file_info_t;
747
748 typedef struct {
749         u64 revision;
750         u32 open;
751         u32 close;
752         u32 delete;
753         u32 read;
754         u32 write;
755         u32 get_position;
756         u32 set_position;
757         u32 get_info;
758         u32 set_info;
759         u32 flush;
760 } efi_file_handle_32_t;
761
762 typedef struct {
763         u64 revision;
764         u64 open;
765         u64 close;
766         u64 delete;
767         u64 read;
768         u64 write;
769         u64 get_position;
770         u64 set_position;
771         u64 get_info;
772         u64 set_info;
773         u64 flush;
774 } efi_file_handle_64_t;
775
776 typedef struct _efi_file_handle {
777         u64 revision;
778         efi_status_t (*open)(struct _efi_file_handle *,
779                              struct _efi_file_handle **,
780                              efi_char16_t *, u64, u64);
781         efi_status_t (*close)(struct _efi_file_handle *);
782         void *delete;
783         efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
784                              void *);
785         void *write;
786         void *get_position;
787         void *set_position;
788         efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
789                         unsigned long *, void *);
790         void *set_info;
791         void *flush;
792 } efi_file_handle_t;
793
794 typedef struct _efi_file_io_interface {
795         u64 revision;
796         int (*open_volume)(struct _efi_file_io_interface *,
797                            efi_file_handle_t **);
798 } efi_file_io_interface_t;
799
800 #define EFI_FILE_MODE_READ      0x0000000000000001
801 #define EFI_FILE_MODE_WRITE     0x0000000000000002
802 #define EFI_FILE_MODE_CREATE    0x8000000000000000
803
804 #define EFI_INVALID_TABLE_ADDR          (~0UL)
805
806 /*
807  * All runtime access to EFI goes through this structure:
808  */
809 extern struct efi {
810         efi_system_table_t *systab;     /* EFI system table */
811         unsigned int runtime_version;   /* Runtime services version */
812         unsigned long mps;              /* MPS table */
813         unsigned long acpi;             /* ACPI table  (IA64 ext 0.71) */
814         unsigned long acpi20;           /* ACPI table  (ACPI 2.0) */
815         unsigned long smbios;           /* SM BIOS table */
816         unsigned long sal_systab;       /* SAL system table */
817         unsigned long boot_info;        /* boot info table */
818         unsigned long hcdp;             /* HCDP table */
819         unsigned long uga;              /* UGA table */
820         unsigned long uv_systab;        /* UV system table */
821         unsigned long fw_vendor;        /* fw_vendor */
822         unsigned long runtime;          /* runtime table */
823         unsigned long config_table;     /* config tables */
824         efi_get_time_t *get_time;
825         efi_set_time_t *set_time;
826         efi_get_wakeup_time_t *get_wakeup_time;
827         efi_set_wakeup_time_t *set_wakeup_time;
828         efi_get_variable_t *get_variable;
829         efi_get_next_variable_t *get_next_variable;
830         efi_set_variable_t *set_variable;
831         efi_query_variable_info_t *query_variable_info;
832         efi_update_capsule_t *update_capsule;
833         efi_query_capsule_caps_t *query_capsule_caps;
834         efi_get_next_high_mono_count_t *get_next_high_mono_count;
835         efi_reset_system_t *reset_system;
836         efi_set_virtual_address_map_t *set_virtual_address_map;
837         struct efi_memory_map *memmap;
838         unsigned long flags;
839 } efi;
840
841 static inline int
842 efi_guidcmp (efi_guid_t left, efi_guid_t right)
843 {
844         return memcmp(&left, &right, sizeof (efi_guid_t));
845 }
846
847 static inline char *
848 efi_guid_unparse(efi_guid_t *guid, char *out)
849 {
850         sprintf(out, "%pUl", guid->b);
851         return out;
852 }
853
854 extern void efi_init (void);
855 extern void *efi_get_pal_addr (void);
856 extern void efi_map_pal_code (void);
857 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
858 extern void efi_gettimeofday (struct timespec *ts);
859 extern void efi_enter_virtual_mode (void);      /* switch EFI to virtual mode, if possible */
860 #ifdef CONFIG_X86
861 extern void efi_late_init(void);
862 extern void efi_free_boot_services(void);
863 extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
864 #else
865 static inline void efi_late_init(void) {}
866 static inline void efi_free_boot_services(void) {}
867
868 static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
869 {
870         return EFI_SUCCESS;
871 }
872 #endif
873 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
874 extern int efi_config_init(efi_config_table_type_t *arch_tables);
875 extern u64 efi_get_iobase (void);
876 extern u32 efi_mem_type (unsigned long phys_addr);
877 extern u64 efi_mem_attributes (unsigned long phys_addr);
878 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
879 extern int __init efi_uart_console_only (void);
880 extern void efi_initialize_iomem_resources(struct resource *code_resource,
881                 struct resource *data_resource, struct resource *bss_resource);
882 extern void efi_get_time(struct timespec *now);
883 extern int efi_set_rtc_mmss(const struct timespec *now);
884 extern void efi_reserve_boot_services(void);
885 extern int efi_get_fdt_params(struct efi_fdt_params *params, int verbose);
886 extern struct efi_memory_map memmap;
887
888 extern int efi_reboot_quirk_mode;
889 extern bool efi_poweroff_required(void);
890
891 /* Iterate through an efi_memory_map */
892 #define for_each_efi_memory_desc(m, md)                                    \
893         for ((md) = (m)->map;                                              \
894              (md) <= (efi_memory_desc_t *)((m)->map_end - (m)->desc_size); \
895              (md) = (void *)(md) + (m)->desc_size)
896
897 /**
898  * efi_range_is_wc - check the WC bit on an address range
899  * @start: starting kvirt address
900  * @len: length of range
901  *
902  * Consult the EFI memory map and make sure it's ok to set this range WC.
903  * Returns true or false.
904  */
905 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
906 {
907         unsigned long i;
908
909         for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
910                 unsigned long paddr = __pa(start + i);
911                 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
912                         return 0;
913         }
914         /* The range checked out */
915         return 1;
916 }
917
918 #ifdef CONFIG_EFI_PCDP
919 extern int __init efi_setup_pcdp_console(char *);
920 #endif
921
922 /*
923  * We play games with efi_enabled so that the compiler will, if
924  * possible, remove EFI-related code altogether.
925  */
926 #define EFI_BOOT                0       /* Were we booted from EFI? */
927 #define EFI_SYSTEM_TABLES       1       /* Can we use EFI system tables? */
928 #define EFI_CONFIG_TABLES       2       /* Can we use EFI config tables? */
929 #define EFI_RUNTIME_SERVICES    3       /* Can we use runtime services? */
930 #define EFI_MEMMAP              4       /* Can we use EFI memory map? */
931 #define EFI_64BIT               5       /* Is the firmware 64-bit? */
932 #define EFI_ARCH_1              6       /* First arch-specific bit */
933
934 #ifdef CONFIG_EFI
935 /*
936  * Test whether the above EFI_* bits are enabled.
937  */
938 static inline bool efi_enabled(int feature)
939 {
940         return test_bit(feature, &efi.flags) != 0;
941 }
942 extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
943 #else
944 static inline bool efi_enabled(int feature)
945 {
946         return false;
947 }
948 static inline void
949 efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
950 #endif
951
952 /*
953  * Variable Attributes
954  */
955 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
956 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
957 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
958 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
959 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
960 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
961 #define EFI_VARIABLE_APPEND_WRITE       0x0000000000000040
962
963 #define EFI_VARIABLE_MASK       (EFI_VARIABLE_NON_VOLATILE | \
964                                 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
965                                 EFI_VARIABLE_RUNTIME_ACCESS | \
966                                 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
967                                 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
968                                 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
969                                 EFI_VARIABLE_APPEND_WRITE)
970 /*
971  * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
972  * not including trailing NUL
973  */
974 #define EFI_VARIABLE_GUID_LEN 36
975
976 /*
977  * The type of search to perform when calling boottime->locate_handle
978  */
979 #define EFI_LOCATE_ALL_HANDLES                  0
980 #define EFI_LOCATE_BY_REGISTER_NOTIFY           1
981 #define EFI_LOCATE_BY_PROTOCOL                  2
982
983 /*
984  * EFI Device Path information
985  */
986 #define EFI_DEV_HW                      0x01
987 #define  EFI_DEV_PCI                             1
988 #define  EFI_DEV_PCCARD                          2
989 #define  EFI_DEV_MEM_MAPPED                      3
990 #define  EFI_DEV_VENDOR                          4
991 #define  EFI_DEV_CONTROLLER                      5
992 #define EFI_DEV_ACPI                    0x02
993 #define   EFI_DEV_BASIC_ACPI                     1
994 #define   EFI_DEV_EXPANDED_ACPI                  2
995 #define EFI_DEV_MSG                     0x03
996 #define   EFI_DEV_MSG_ATAPI                      1
997 #define   EFI_DEV_MSG_SCSI                       2
998 #define   EFI_DEV_MSG_FC                         3
999 #define   EFI_DEV_MSG_1394                       4
1000 #define   EFI_DEV_MSG_USB                        5
1001 #define   EFI_DEV_MSG_USB_CLASS                 15
1002 #define   EFI_DEV_MSG_I20                        6
1003 #define   EFI_DEV_MSG_MAC                       11
1004 #define   EFI_DEV_MSG_IPV4                      12
1005 #define   EFI_DEV_MSG_IPV6                      13
1006 #define   EFI_DEV_MSG_INFINIBAND                 9
1007 #define   EFI_DEV_MSG_UART                      14
1008 #define   EFI_DEV_MSG_VENDOR                    10
1009 #define EFI_DEV_MEDIA                   0x04
1010 #define   EFI_DEV_MEDIA_HARD_DRIVE               1
1011 #define   EFI_DEV_MEDIA_CDROM                    2
1012 #define   EFI_DEV_MEDIA_VENDOR                   3
1013 #define   EFI_DEV_MEDIA_FILE                     4
1014 #define   EFI_DEV_MEDIA_PROTOCOL                 5
1015 #define EFI_DEV_BIOS_BOOT               0x05
1016 #define EFI_DEV_END_PATH                0x7F
1017 #define EFI_DEV_END_PATH2               0xFF
1018 #define   EFI_DEV_END_INSTANCE                  0x01
1019 #define   EFI_DEV_END_ENTIRE                    0xFF
1020
1021 struct efi_generic_dev_path {
1022         u8 type;
1023         u8 sub_type;
1024         u16 length;
1025 } __attribute ((packed));
1026
1027 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1028 {
1029         *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1030         *addr &= PAGE_MASK;
1031 }
1032
1033 /*
1034  * EFI Variable support.
1035  *
1036  * Different firmware drivers can expose their EFI-like variables using
1037  * the following.
1038  */
1039
1040 struct efivar_operations {
1041         efi_get_variable_t *get_variable;
1042         efi_get_next_variable_t *get_next_variable;
1043         efi_set_variable_t *set_variable;
1044         efi_query_variable_store_t *query_variable_store;
1045 };
1046
1047 struct efivars {
1048         /*
1049          * ->lock protects two things:
1050          * 1) ->list - adds, removals, reads, writes
1051          * 2) ops.[gs]et_variable() calls.
1052          * It must not be held when creating sysfs entries or calling kmalloc.
1053          * ops.get_next_variable() is only called from register_efivars()
1054          * or efivar_update_sysfs_entries(),
1055          * which is protected by the BKL, so that path is safe.
1056          */
1057         spinlock_t lock;
1058         struct kset *kset;
1059         struct kobject *kobject;
1060         const struct efivar_operations *ops;
1061 };
1062
1063 /*
1064  * The maximum size of VariableName + Data = 1024
1065  * Therefore, it's reasonable to save that much
1066  * space in each part of the structure,
1067  * and we use a page for reading/writing.
1068  */
1069
1070 #define EFI_VAR_NAME_LEN        1024
1071
1072 struct efi_variable {
1073         efi_char16_t  VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
1074         efi_guid_t    VendorGuid;
1075         unsigned long DataSize;
1076         __u8          Data[1024];
1077         efi_status_t  Status;
1078         __u32         Attributes;
1079 } __attribute__((packed));
1080
1081 struct efivar_entry {
1082         struct efi_variable var;
1083         struct list_head list;
1084         struct kobject kobj;
1085         bool scanning;
1086         bool deleting;
1087 };
1088
1089 struct efi_simple_text_output_protocol_32 {
1090         u32 reset;
1091         u32 output_string;
1092         u32 test_string;
1093 };
1094
1095 struct efi_simple_text_output_protocol_64 {
1096         u64 reset;
1097         u64 output_string;
1098         u64 test_string;
1099 };
1100
1101 struct efi_simple_text_output_protocol {
1102         void *reset;
1103         efi_status_t (*output_string)(void *, void *);
1104         void *test_string;
1105 };
1106
1107 extern struct list_head efivar_sysfs_list;
1108
1109 static inline void
1110 efivar_unregister(struct efivar_entry *var)
1111 {
1112         kobject_put(&var->kobj);
1113 }
1114
1115 int efivars_register(struct efivars *efivars,
1116                      const struct efivar_operations *ops,
1117                      struct kobject *kobject);
1118 int efivars_unregister(struct efivars *efivars);
1119 struct kobject *efivars_kobject(void);
1120
1121 int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1122                 void *data, bool atomic, bool duplicates,
1123                 struct list_head *head);
1124
1125 void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1126 void efivar_entry_remove(struct efivar_entry *entry);
1127
1128 int __efivar_entry_delete(struct efivar_entry *entry);
1129 int efivar_entry_delete(struct efivar_entry *entry);
1130
1131 int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
1132 int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1133                        unsigned long *size, void *data);
1134 int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1135                      unsigned long *size, void *data);
1136 int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1137                      unsigned long size, void *data, struct list_head *head);
1138 int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1139                               unsigned long *size, void *data, bool *set);
1140 int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1141                           bool block, unsigned long size, void *data);
1142
1143 void efivar_entry_iter_begin(void);
1144 void efivar_entry_iter_end(void);
1145
1146 int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1147                         struct list_head *head, void *data,
1148                         struct efivar_entry **prev);
1149 int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1150                       struct list_head *head, void *data);
1151
1152 struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1153                                        struct list_head *head, bool remove);
1154
1155 bool efivar_validate(efi_guid_t vendor, efi_char16_t *var_name, u8 *data,
1156                      unsigned long data_size);
1157 bool efivar_variable_is_removable(efi_guid_t vendor, const char *name,
1158                                   size_t len);
1159
1160 extern struct work_struct efivar_work;
1161 void efivar_run_worker(void);
1162
1163 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
1164 int efivars_sysfs_init(void);
1165
1166 #define EFIVARS_DATA_SIZE_MAX 1024
1167
1168 #endif /* CONFIG_EFI_VARS */
1169
1170 #ifdef CONFIG_EFI_RUNTIME_MAP
1171 int efi_runtime_map_init(struct kobject *);
1172 void efi_runtime_map_setup(void *, int, u32);
1173 #else
1174 static inline int efi_runtime_map_init(struct kobject *kobj)
1175 {
1176         return 0;
1177 }
1178
1179 static inline void
1180 efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
1181 #endif
1182
1183 #endif /* _LINUX_EFI_H */