VSOCK: Introduce virtio_vsock_common.ko
[deliverable/linux.git] / include / linux / efi.h
CommitLineData
1da177e4
LT
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>
4a3575fd 21#include <linux/pfn.h>
5ee9c198 22#include <linux/pstore.h>
8562c99c 23#include <linux/reboot.h>
ba7e34b1 24#include <linux/uuid.h>
2c23b73c 25#include <linux/screen_info.h>
1da177e4
LT
26
27#include <asm/page.h>
1da177e4
LT
28
29#define EFI_SUCCESS 0
30#define EFI_LOAD_ERROR ( 1 | (1UL << (BITS_PER_LONG-1)))
31#define EFI_INVALID_PARAMETER ( 2 | (1UL << (BITS_PER_LONG-1)))
32#define EFI_UNSUPPORTED ( 3 | (1UL << (BITS_PER_LONG-1)))
33#define EFI_BAD_BUFFER_SIZE ( 4 | (1UL << (BITS_PER_LONG-1)))
34#define EFI_BUFFER_TOO_SMALL ( 5 | (1UL << (BITS_PER_LONG-1)))
5d9db883
MG
35#define EFI_NOT_READY ( 6 | (1UL << (BITS_PER_LONG-1)))
36#define EFI_DEVICE_ERROR ( 7 | (1UL << (BITS_PER_LONG-1)))
37#define EFI_WRITE_PROTECTED ( 8 | (1UL << (BITS_PER_LONG-1)))
38#define EFI_OUT_OF_RESOURCES ( 9 | (1UL << (BITS_PER_LONG-1)))
1da177e4 39#define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
5d9db883 40#define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1)))
1da177e4
LT
41
42typedef unsigned long efi_status_t;
43typedef u8 efi_bool_t;
44typedef u16 efi_char16_t; /* UNICODE character */
ed37ddff
RF
45typedef u64 efi_physical_addr_t;
46typedef void *efi_handle_t;
1da177e4 47
ba7e34b1 48typedef uuid_le efi_guid_t;
1da177e4
LT
49
50#define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
ba7e34b1 51 UUID_LE(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7)
1da177e4
LT
52
53/*
54 * Generic EFI table header
55 */
56typedef struct {
57 u64 signature;
58 u32 revision;
59 u32 headersize;
60 u32 crc32;
61 u32 reserved;
62} efi_table_hdr_t;
63
64/*
65 * Memory map descriptor:
66 */
67
68/* Memory types: */
69#define EFI_RESERVED_TYPE 0
70#define EFI_LOADER_CODE 1
71#define EFI_LOADER_DATA 2
72#define EFI_BOOT_SERVICES_CODE 3
73#define EFI_BOOT_SERVICES_DATA 4
74#define EFI_RUNTIME_SERVICES_CODE 5
75#define EFI_RUNTIME_SERVICES_DATA 6
76#define EFI_CONVENTIONAL_MEMORY 7
77#define EFI_UNUSABLE_MEMORY 8
78#define EFI_ACPI_RECLAIM_MEMORY 9
79#define EFI_ACPI_MEMORY_NVS 10
80#define EFI_MEMORY_MAPPED_IO 11
81#define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
82#define EFI_PAL_CODE 13
ad5fb870
DW
83#define EFI_PERSISTENT_MEMORY 14
84#define EFI_MAX_MEMORY_TYPE 15
1da177e4
LT
85
86/* Attribute values: */
87#define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
88#define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
89#define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
90#define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
9c97e0bd 91#define EFI_MEMORY_UCE ((u64)0x0000000000000010ULL) /* uncached, exported */
1da177e4
LT
92#define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
93#define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
94#define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
c016ca08 95#define EFI_MEMORY_NV ((u64)0x0000000000008000ULL) /* non-volatile */
b05b9f5f
TL
96#define EFI_MEMORY_MORE_RELIABLE \
97 ((u64)0x0000000000010000ULL) /* higher reliability */
87db73ae 98#define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */
1da177e4
LT
99#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
100#define EFI_MEMORY_DESCRIPTOR_VERSION 1
101
102#define EFI_PAGE_SHIFT 12
ed37ddff 103#define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
1da177e4 104
1da177e4
LT
105typedef struct {
106 u32 type;
107 u32 pad;
108 u64 phys_addr;
109 u64 virt_addr;
110 u64 num_pages;
111 u64 attribute;
1da177e4
LT
112} efi_memory_desc_t;
113
3b370237
MG
114typedef struct {
115 efi_guid_t guid;
116 u32 headersize;
117 u32 flags;
118 u32 imagesize;
119} efi_capsule_header_t;
120
f0133f3c
MF
121/*
122 * EFI capsule flags
123 */
124#define EFI_CAPSULE_PERSIST_ACROSS_RESET 0x00010000
125#define EFI_CAPSULE_POPULATE_SYSTEM_TABLE 0x00020000
126#define EFI_CAPSULE_INITIATE_RESET 0x00040000
127
bb05e4ba
MF
128/*
129 * Allocation types for calls to boottime->allocate_pages.
130 */
131#define EFI_ALLOCATE_ANY_PAGES 0
132#define EFI_ALLOCATE_MAX_ADDRESS 1
133#define EFI_ALLOCATE_ADDRESS 2
134#define EFI_MAX_ALLOCATE_TYPE 3
135
e088a4ad 136typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
1da177e4
LT
137
138/*
139 * Types and defines for Time Services
140 */
141#define EFI_TIME_ADJUST_DAYLIGHT 0x1
142#define EFI_TIME_IN_DAYLIGHT 0x2
143#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
144
145typedef struct {
146 u16 year;
147 u8 month;
148 u8 day;
149 u8 hour;
150 u8 minute;
151 u8 second;
152 u8 pad1;
153 u32 nanosecond;
154 s16 timezone;
155 u8 daylight;
156 u8 pad2;
157} efi_time_t;
158
159typedef struct {
160 u32 resolution;
161 u32 accuracy;
162 u8 sets_to_zero;
163} efi_time_cap_t;
164
677703ce
MF
165typedef struct {
166 efi_table_hdr_t hdr;
167 u32 raise_tpl;
168 u32 restore_tpl;
169 u32 allocate_pages;
170 u32 free_pages;
171 u32 get_memory_map;
172 u32 allocate_pool;
173 u32 free_pool;
174 u32 create_event;
175 u32 set_timer;
176 u32 wait_for_event;
177 u32 signal_event;
178 u32 close_event;
179 u32 check_event;
180 u32 install_protocol_interface;
181 u32 reinstall_protocol_interface;
182 u32 uninstall_protocol_interface;
183 u32 handle_protocol;
184 u32 __reserved;
185 u32 register_protocol_notify;
186 u32 locate_handle;
187 u32 locate_device_path;
188 u32 install_configuration_table;
189 u32 load_image;
190 u32 start_image;
191 u32 exit;
192 u32 unload_image;
193 u32 exit_boot_services;
194 u32 get_next_monotonic_count;
195 u32 stall;
196 u32 set_watchdog_timer;
197 u32 connect_controller;
198 u32 disconnect_controller;
199 u32 open_protocol;
200 u32 close_protocol;
201 u32 open_protocol_information;
202 u32 protocols_per_handle;
203 u32 locate_handle_buffer;
204 u32 locate_protocol;
205 u32 install_multiple_protocol_interfaces;
206 u32 uninstall_multiple_protocol_interfaces;
207 u32 calculate_crc32;
208 u32 copy_mem;
209 u32 set_mem;
210 u32 create_event_ex;
211} __packed efi_boot_services_32_t;
212
213typedef struct {
214 efi_table_hdr_t hdr;
215 u64 raise_tpl;
216 u64 restore_tpl;
217 u64 allocate_pages;
218 u64 free_pages;
219 u64 get_memory_map;
220 u64 allocate_pool;
221 u64 free_pool;
222 u64 create_event;
223 u64 set_timer;
224 u64 wait_for_event;
225 u64 signal_event;
226 u64 close_event;
227 u64 check_event;
228 u64 install_protocol_interface;
229 u64 reinstall_protocol_interface;
230 u64 uninstall_protocol_interface;
231 u64 handle_protocol;
232 u64 __reserved;
233 u64 register_protocol_notify;
234 u64 locate_handle;
235 u64 locate_device_path;
236 u64 install_configuration_table;
237 u64 load_image;
238 u64 start_image;
239 u64 exit;
240 u64 unload_image;
241 u64 exit_boot_services;
242 u64 get_next_monotonic_count;
243 u64 stall;
244 u64 set_watchdog_timer;
245 u64 connect_controller;
246 u64 disconnect_controller;
247 u64 open_protocol;
248 u64 close_protocol;
249 u64 open_protocol_information;
250 u64 protocols_per_handle;
251 u64 locate_handle_buffer;
252 u64 locate_protocol;
253 u64 install_multiple_protocol_interfaces;
254 u64 uninstall_multiple_protocol_interfaces;
255 u64 calculate_crc32;
256 u64 copy_mem;
257 u64 set_mem;
258 u64 create_event_ex;
259} __packed efi_boot_services_64_t;
260
f30ca6ba
MF
261/*
262 * EFI Boot Services table
263 */
264typedef struct {
265 efi_table_hdr_t hdr;
266 void *raise_tpl;
267 void *restore_tpl;
ed37ddff
RF
268 efi_status_t (*allocate_pages)(int, int, unsigned long,
269 efi_physical_addr_t *);
270 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
271 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
272 unsigned long *, u32 *);
273 efi_status_t (*allocate_pool)(int, unsigned long, void **);
274 efi_status_t (*free_pool)(void *);
f30ca6ba
MF
275 void *create_event;
276 void *set_timer;
277 void *wait_for_event;
278 void *signal_event;
279 void *close_event;
280 void *check_event;
281 void *install_protocol_interface;
282 void *reinstall_protocol_interface;
283 void *uninstall_protocol_interface;
ed37ddff 284 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
f30ca6ba
MF
285 void *__reserved;
286 void *register_protocol_notify;
fc372064
AB
287 efi_status_t (*locate_handle)(int, efi_guid_t *, void *,
288 unsigned long *, efi_handle_t *);
f30ca6ba 289 void *locate_device_path;
801820be 290 efi_status_t (*install_configuration_table)(efi_guid_t *, void *);
f30ca6ba
MF
291 void *load_image;
292 void *start_image;
293 void *exit;
294 void *unload_image;
ed37ddff 295 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
f30ca6ba
MF
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;
e4fbf476 306 efi_status_t (*locate_protocol)(efi_guid_t *, void *, void **);
f30ca6ba
MF
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
dd5fc854
MG
315typedef 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
331typedef enum {
332 EfiPciIoAttributeOperationGet,
333 EfiPciIoAttributeOperationSet,
334 EfiPciIoAttributeOperationEnable,
335 EfiPciIoAttributeOperationDisable,
336 EfiPciIoAttributeOperationSupported,
337 EfiPciIoAttributeOperationMaximum
338} EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
339
677703ce
MF
340typedef struct {
341 u32 read;
342 u32 write;
343} efi_pci_io_protocol_access_32_t;
344
345typedef struct {
346 u64 read;
347 u64 write;
348} efi_pci_io_protocol_access_64_t;
dd5fc854
MG
349
350typedef struct {
351 void *read;
352 void *write;
353} efi_pci_io_protocol_access_t;
354
677703ce
MF
355typedef 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 uint64_t romsize;
372 void *romimage;
373} efi_pci_io_protocol_32;
374
375typedef 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 uint64_t romsize;
392 void *romimage;
393} efi_pci_io_protocol_64;
394
dd5fc854
MG
395typedef 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
1da177e4
LT
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
677703ce
MF
448typedef 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
466typedef 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
1da177e4
LT
484typedef struct {
485 efi_table_hdr_t hdr;
43ab0476
BP
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;
1da177e4
LT
500} efi_runtime_services_t;
501
502typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
503typedef efi_status_t efi_set_time_t (efi_time_t *tm);
504typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
505 efi_time_t *tm);
506typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
507typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
508 unsigned long *data_size, void *data);
509typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
510 efi_guid_t *vendor);
511typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
f7a2d73f 512 u32 attr, unsigned long data_size,
1da177e4
LT
513 void *data);
514typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
515typedef void efi_reset_system_t (int reset_type, efi_status_t status,
516 unsigned long data_size, efi_char16_t *data);
517typedef 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);
3b370237
MG
521typedef efi_status_t efi_query_variable_info_t(u32 attr,
522 u64 *storage_space,
523 u64 *remaining_space,
524 u64 *max_variable_size);
525typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
526 unsigned long count,
527 unsigned long sg_list);
528typedef 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);
ca0e30dc
AB
532typedef efi_status_t efi_query_variable_store_t(u32 attributes,
533 unsigned long size,
534 bool nonblocking);
1da177e4 535
022ee6c5
AB
536void efi_native_runtime_setup(void);
537
1da177e4
LT
538/*
539 * EFI Configuration Table and GUID definitions
540 */
541#define NULL_GUID \
662b1d89
PJ
542 EFI_GUID(0x00000000, 0x0000, 0x0000, \
543 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
1da177e4
LT
544
545#define MPS_TABLE_GUID \
662b1d89
PJ
546 EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3, \
547 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1da177e4
LT
548
549#define ACPI_TABLE_GUID \
662b1d89
PJ
550 EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3, \
551 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1da177e4
LT
552
553#define ACPI_20_TABLE_GUID \
662b1d89
PJ
554 EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
555 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
1da177e4
LT
556
557#define SMBIOS_TABLE_GUID \
662b1d89
PJ
558 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
559 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1da177e4 560
e1ccbbc9 561#define SMBIOS3_TABLE_GUID \
662b1d89
PJ
562 EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c, \
563 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94)
e1ccbbc9 564
1da177e4 565#define SAL_SYSTEM_TABLE_GUID \
662b1d89
PJ
566 EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3, \
567 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1da177e4
LT
568
569#define HCDP_TABLE_GUID \
662b1d89
PJ
570 EFI_GUID(0xf951938d, 0x620b, 0x42ef, \
571 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98)
1da177e4
LT
572
573#define UGA_IO_PROTOCOL_GUID \
662b1d89
PJ
574 EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b, \
575 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0x0b, 0x07, 0xa2)
1da177e4
LT
576
577#define EFI_GLOBAL_VARIABLE_GUID \
662b1d89
PJ
578 EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, \
579 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
1da177e4 580
a50f70b1 581#define UV_SYSTEM_TABLE_GUID \
662b1d89
PJ
582 EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd, \
583 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93)
a50f70b1 584
5ee9c198 585#define LINUX_EFI_CRASH_GUID \
662b1d89
PJ
586 EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc, \
587 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0)
5ee9c198 588
8e84f345 589#define LOADED_IMAGE_PROTOCOL_GUID \
662b1d89
PJ
590 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
591 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
8e84f345 592
0f7c5d47 593#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
662b1d89
PJ
594 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
595 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
0f7c5d47
MF
596
597#define EFI_UGA_PROTOCOL_GUID \
662b1d89
PJ
598 EFI_GUID(0x982c298b, 0xf4fa, 0x41cb, \
599 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39)
0f7c5d47
MF
600
601#define EFI_PCI_IO_PROTOCOL_GUID \
662b1d89
PJ
602 EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5, \
603 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
0f7c5d47 604
55839d51 605#define EFI_FILE_INFO_ID \
662b1d89
PJ
606 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
607 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
55839d51 608
0bb54905 609#define EFI_SYSTEM_RESOURCE_TABLE_GUID \
662b1d89
PJ
610 EFI_GUID(0xb122a263, 0x3661, 0x4f68, \
611 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
0bb54905 612
55839d51 613#define EFI_FILE_SYSTEM_GUID \
662b1d89
PJ
614 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
615 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
55839d51 616
263b4a30 617#define DEVICE_TREE_GUID \
662b1d89
PJ
618 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
619 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
263b4a30 620
bf924863 621#define EFI_PROPERTIES_TABLE_GUID \
662b1d89
PJ
622 EFI_GUID(0x880aaca3, 0x4adc, 0x4a04, \
623 0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5)
bf924863 624
e4fbf476
AB
625#define EFI_RNG_PROTOCOL_GUID \
626 EFI_GUID(0x3152bca5, 0xeade, 0x433d, \
627 0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
628
a604af07
AB
629#define EFI_MEMORY_ATTRIBUTES_TABLE_GUID \
630 EFI_GUID(0xdcfa911d, 0x26eb, 0x469f, \
631 0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
632
fc372064
AB
633#define EFI_CONSOLE_OUT_DEVICE_GUID \
634 EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4, \
635 0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
636
801820be
AB
637/*
638 * This GUID is used to pass to the kernel proper the struct screen_info
639 * structure that was populated by the stub based on the GOP protocol instance
640 * associated with ConOut
641 */
642#define LINUX_EFI_ARM_SCREEN_INFO_TABLE_GUID \
643 EFI_GUID(0xe03fc20a, 0x85dc, 0x406e, \
644 0xb9, 0xe, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95)
645
06f7d4a1
CJ
646#define LINUX_EFI_LOADER_ENTRY_GUID \
647 EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf, \
648 0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)
649
1adbfa35
OJ
650typedef struct {
651 efi_guid_t guid;
652 u64 table;
653} efi_config_table_64_t;
654
655typedef struct {
656 efi_guid_t guid;
657 u32 table;
658} efi_config_table_32_t;
659
1da177e4
LT
660typedef struct {
661 efi_guid_t guid;
662 unsigned long table;
663} efi_config_table_t;
664
272686bf
LL
665typedef struct {
666 efi_guid_t guid;
667 const char *name;
668 unsigned long *ptr;
669} efi_config_table_type_t;
670
1da177e4 671#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
1da177e4 672
3b370237
MG
673#define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
674#define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
675#define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
676#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
677#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
678#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
679
1adbfa35
OJ
680typedef struct {
681 efi_table_hdr_t hdr;
682 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
683 u32 fw_revision;
684 u32 __pad1;
685 u64 con_in_handle;
686 u64 con_in;
687 u64 con_out_handle;
688 u64 con_out;
689 u64 stderr_handle;
690 u64 stderr;
691 u64 runtime;
692 u64 boottime;
693 u32 nr_tables;
694 u32 __pad2;
695 u64 tables;
696} efi_system_table_64_t;
697
698typedef struct {
699 efi_table_hdr_t hdr;
700 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
701 u32 fw_revision;
702 u32 con_in_handle;
703 u32 con_in;
704 u32 con_out_handle;
705 u32 con_out;
706 u32 stderr_handle;
707 u32 stderr;
708 u32 runtime;
709 u32 boottime;
710 u32 nr_tables;
711 u32 tables;
712} efi_system_table_32_t;
713
1da177e4
LT
714typedef struct {
715 efi_table_hdr_t hdr;
716 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
717 u32 fw_revision;
718 unsigned long con_in_handle;
719 unsigned long con_in;
720 unsigned long con_out_handle;
721 unsigned long con_out;
722 unsigned long stderr_handle;
723 unsigned long stderr;
724 efi_runtime_services_t *runtime;
f30ca6ba 725 efi_boot_services_t *boottime;
1da177e4
LT
726 unsigned long nr_tables;
727 unsigned long tables;
728} efi_system_table_t;
729
730struct efi_memory_map {
44511fb9 731 phys_addr_t phys_map;
7ae65fd3
MT
732 void *map;
733 void *map_end;
1da177e4
LT
734 int nr_map;
735 unsigned long desc_version;
7ae65fd3 736 unsigned long desc_size;
1da177e4
LT
737};
738
0302f71c
MS
739struct efi_fdt_params {
740 u64 system_table;
741 u64 mmap;
742 u32 mmap_size;
743 u32 desc_size;
744 u32 desc_ver;
745};
746
677703ce
MF
747typedef struct {
748 u32 revision;
749 u32 parent_handle;
750 u32 system_table;
751 u32 device_handle;
752 u32 file_path;
753 u32 reserved;
754 u32 load_options_size;
755 u32 load_options;
756 u32 image_base;
757 __aligned_u64 image_size;
758 unsigned int image_code_type;
759 unsigned int image_data_type;
760 unsigned long unload;
761} efi_loaded_image_32_t;
762
763typedef struct {
764 u32 revision;
765 u64 parent_handle;
766 u64 system_table;
767 u64 device_handle;
768 u64 file_path;
769 u64 reserved;
770 u32 load_options_size;
771 u64 load_options;
772 u64 image_base;
773 __aligned_u64 image_size;
774 unsigned int image_code_type;
775 unsigned int image_data_type;
776 unsigned long unload;
777} efi_loaded_image_64_t;
778
8e84f345
MF
779typedef struct {
780 u32 revision;
781 void *parent_handle;
782 efi_system_table_t *system_table;
783 void *device_handle;
784 void *file_path;
785 void *reserved;
786 u32 load_options_size;
787 void *load_options;
788 void *image_base;
789 __aligned_u64 image_size;
790 unsigned int image_code_type;
791 unsigned int image_data_type;
792 unsigned long unload;
793} efi_loaded_image_t;
794
55839d51
MF
795
796typedef struct {
797 u64 size;
798 u64 file_size;
799 u64 phys_size;
800 efi_time_t create_time;
801 efi_time_t last_access_time;
802 efi_time_t modification_time;
803 __aligned_u64 attribute;
804 efi_char16_t filename[1];
805} efi_file_info_t;
806
677703ce
MF
807typedef struct {
808 u64 revision;
809 u32 open;
810 u32 close;
811 u32 delete;
812 u32 read;
813 u32 write;
814 u32 get_position;
815 u32 set_position;
816 u32 get_info;
817 u32 set_info;
818 u32 flush;
819} efi_file_handle_32_t;
820
821typedef struct {
822 u64 revision;
823 u64 open;
824 u64 close;
825 u64 delete;
826 u64 read;
827 u64 write;
828 u64 get_position;
829 u64 set_position;
830 u64 get_info;
831 u64 set_info;
832 u64 flush;
833} efi_file_handle_64_t;
834
ed37ddff 835typedef struct _efi_file_handle {
55839d51 836 u64 revision;
ed37ddff
RF
837 efi_status_t (*open)(struct _efi_file_handle *,
838 struct _efi_file_handle **,
839 efi_char16_t *, u64, u64);
840 efi_status_t (*close)(struct _efi_file_handle *);
55839d51 841 void *delete;
ed37ddff
RF
842 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
843 void *);
55839d51
MF
844 void *write;
845 void *get_position;
846 void *set_position;
ed37ddff
RF
847 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
848 unsigned long *, void *);
55839d51
MF
849 void *set_info;
850 void *flush;
851} efi_file_handle_t;
852
ed37ddff
RF
853typedef struct _efi_file_io_interface {
854 u64 revision;
855 int (*open_volume)(struct _efi_file_io_interface *,
856 efi_file_handle_t **);
857} efi_file_io_interface_t;
858
55839d51
MF
859#define EFI_FILE_MODE_READ 0x0000000000000001
860#define EFI_FILE_MODE_WRITE 0x0000000000000002
861#define EFI_FILE_MODE_CREATE 0x8000000000000000
862
bf924863
AB
863typedef struct {
864 u32 version;
865 u32 length;
866 u64 memory_protection_attribute;
867} efi_properties_table_t;
868
869#define EFI_PROPERTIES_TABLE_VERSION 0x00010000
870#define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1
871
b2c99e3c
BH
872#define EFI_INVALID_TABLE_ADDR (~0UL)
873
a604af07
AB
874typedef struct {
875 u32 version;
876 u32 num_entries;
877 u32 desc_size;
878 u32 reserved;
879 efi_memory_desc_t entry[0];
880} efi_memory_attributes_table_t;
881
1da177e4
LT
882/*
883 * All runtime access to EFI goes through this structure:
884 */
885extern struct efi {
886 efi_system_table_t *systab; /* EFI system table */
3b370237 887 unsigned int runtime_version; /* Runtime services version */
b2c99e3c
BH
888 unsigned long mps; /* MPS table */
889 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
890 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
e1ccbbc9
AB
891 unsigned long smbios; /* SMBIOS table (32 bit entry point) */
892 unsigned long smbios3; /* SMBIOS table (64 bit entry point) */
b2c99e3c
BH
893 unsigned long sal_systab; /* SAL system table */
894 unsigned long boot_info; /* boot info table */
895 unsigned long hcdp; /* HCDP table */
896 unsigned long uga; /* UGA table */
a50f70b1 897 unsigned long uv_systab; /* UV system table */
a0998eb1
DY
898 unsigned long fw_vendor; /* fw_vendor */
899 unsigned long runtime; /* runtime table */
900 unsigned long config_table; /* config tables */
0bb54905 901 unsigned long esrt; /* ESRT table */
bf924863 902 unsigned long properties_table; /* properties table */
a604af07 903 unsigned long mem_attr_table; /* memory attributes table */
1da177e4
LT
904 efi_get_time_t *get_time;
905 efi_set_time_t *set_time;
906 efi_get_wakeup_time_t *get_wakeup_time;
907 efi_set_wakeup_time_t *set_wakeup_time;
908 efi_get_variable_t *get_variable;
909 efi_get_next_variable_t *get_next_variable;
910 efi_set_variable_t *set_variable;
70d2a3cf 911 efi_set_variable_t *set_variable_nonblocking;
3b370237 912 efi_query_variable_info_t *query_variable_info;
d3cac1f8 913 efi_query_variable_info_t *query_variable_info_nonblocking;
3b370237
MG
914 efi_update_capsule_t *update_capsule;
915 efi_query_capsule_caps_t *query_capsule_caps;
1da177e4
LT
916 efi_get_next_high_mono_count_t *get_next_high_mono_count;
917 efi_reset_system_t *reset_system;
918 efi_set_virtual_address_map_t *set_virtual_address_map;
884f4f66 919 struct efi_memory_map memmap;
3e909599 920 unsigned long flags;
1da177e4
LT
921} efi;
922
923static inline int
924efi_guidcmp (efi_guid_t left, efi_guid_t right)
925{
926 return memcmp(&left, &right, sizeof (efi_guid_t));
927}
928
929static inline char *
26e02272 930efi_guid_to_str(efi_guid_t *guid, char *out)
1da177e4 931{
925ede0b 932 sprintf(out, "%pUl", guid->b);
1da177e4
LT
933 return out;
934}
935
936extern void efi_init (void);
937extern void *efi_get_pal_addr (void);
938extern void efi_map_pal_code (void);
1da177e4
LT
939extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
940extern void efi_gettimeofday (struct timespec *ts);
941extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
78510792 942#ifdef CONFIG_X86
2223af38 943extern void efi_late_init(void);
78510792 944extern void efi_free_boot_services(void);
ca0e30dc
AB
945extern efi_status_t efi_query_variable_store(u32 attributes,
946 unsigned long size,
947 bool nonblocking);
b05b9f5f 948extern void efi_find_mirror(void);
78510792 949#else
2223af38 950static inline void efi_late_init(void) {}
78510792 951static inline void efi_free_boot_services(void) {}
a6e4d5a0 952
ca0e30dc
AB
953static inline efi_status_t efi_query_variable_store(u32 attributes,
954 unsigned long size,
955 bool nonblocking)
a6e4d5a0
MF
956{
957 return EFI_SUCCESS;
958}
78510792 959#endif
7bc90e01 960extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
272686bf 961extern int efi_config_init(efi_config_table_type_t *arch_tables);
3846c158 962#ifdef CONFIG_EFI_ESRT
0bb54905 963extern void __init efi_esrt_init(void);
3846c158
PJ
964#else
965static inline void efi_esrt_init(void) { }
966#endif
7bb68410
AB
967extern int efi_config_parse_tables(void *config_tables, int count, int sz,
968 efi_config_table_type_t *arch_tables);
1da177e4
LT
969extern u64 efi_get_iobase (void);
970extern u32 efi_mem_type (unsigned long phys_addr);
971extern u64 efi_mem_attributes (unsigned long phys_addr);
32e62c63 972extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
1da177e4 973extern int __init efi_uart_console_only (void);
0bb54905
PJ
974extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
975extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
1da177e4 976extern void efi_initialize_iomem_resources(struct resource *code_resource,
00bf4098 977 struct resource *data_resource, struct resource *bss_resource);
3565184e 978extern void efi_get_time(struct timespec *now);
916f676f 979extern void efi_reserve_boot_services(void);
7968c0e3 980extern int efi_get_fdt_params(struct efi_fdt_params *params);
0bb54905 981extern struct kobject *efi_kobj;
1da177e4 982
44be28e9 983extern int efi_reboot_quirk_mode;
0c5ed61a
MF
984extern bool efi_poweroff_required(void);
985
0f96a99d
TI
986#ifdef CONFIG_EFI_FAKE_MEMMAP
987extern void __init efi_fake_memmap(void);
988#else
989static inline void efi_fake_memmap(void) { }
990#endif
991
10f0d2f5
AB
992/*
993 * efi_memattr_perm_setter - arch specific callback function passed into
994 * efi_memattr_apply_permissions() that updates the
995 * mapping permissions described by the second
996 * argument in the page tables referred to by the
997 * first argument.
998 */
999typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *);
1000
1001extern int efi_memattr_init(void);
1002extern int efi_memattr_apply_permissions(struct mm_struct *mm,
1003 efi_memattr_perm_setter fn);
1004
e885cd80 1005/* Iterate through an efi_memory_map */
78ce248f 1006#define for_each_efi_memory_desc_in_map(m, md) \
e885cd80 1007 for ((md) = (m)->map; \
55f1ea15 1008 ((void *)(md) + (m)->desc_size) <= (m)->map_end; \
e885cd80
MS
1009 (md) = (void *)(md) + (m)->desc_size)
1010
78ce248f
MF
1011/**
1012 * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
1013 * @md: the efi_memory_desc_t * iterator
1014 *
1015 * Once the loop finishes @md must not be accessed.
1016 */
1017#define for_each_efi_memory_desc(md) \
884f4f66 1018 for_each_efi_memory_desc_in_map(&efi.memmap, md)
78ce248f 1019
98d2a6ca
LE
1020/*
1021 * Format an EFI memory descriptor's type and attributes to a user-provided
1022 * character buffer, as per snprintf(), and return the buffer.
1023 */
1024char * __init efi_md_typeattr_format(char *buf, size_t size,
1025 const efi_memory_desc_t *md);
1026
1da177e4
LT
1027/**
1028 * efi_range_is_wc - check the WC bit on an address range
1029 * @start: starting kvirt address
1030 * @len: length of range
1031 *
1032 * Consult the EFI memory map and make sure it's ok to set this range WC.
1033 * Returns true or false.
1034 */
1035static inline int efi_range_is_wc(unsigned long start, unsigned long len)
1036{
986a80d5 1037 unsigned long i;
1da177e4
LT
1038
1039 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
1040 unsigned long paddr = __pa(start + i);
1041 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
1042 return 0;
1043 }
1044 /* The range checked out */
1045 return 1;
1046}
1047
1048#ifdef CONFIG_EFI_PCDP
1049extern int __init efi_setup_pcdp_console(char *);
1050#endif
1051
1052/*
83e68189
MF
1053 * We play games with efi_enabled so that the compiler will, if
1054 * possible, remove EFI-related code altogether.
1da177e4 1055 */
83e68189 1056#define EFI_BOOT 0 /* Were we booted from EFI? */
83e68189
MF
1057#define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
1058#define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
1059#define EFI_MEMMAP 4 /* Can we use EFI memory map? */
1060#define EFI_64BIT 5 /* Is the firmware 64-bit? */
9f27bc54
DK
1061#define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
1062#define EFI_ARCH_1 7 /* First arch-specific bit */
fed6cefe 1063#define EFI_DBG 8 /* Print additional debug info at runtime */
a1041713 1064#define EFI_NX_PE_DATA 9 /* Can runtime data regions be mapped non-executable? */
83e68189 1065
1da177e4 1066#ifdef CONFIG_EFI
3e909599
MF
1067/*
1068 * Test whether the above EFI_* bits are enabled.
1069 */
1070static inline bool efi_enabled(int feature)
1071{
1072 return test_bit(feature, &efi.flags) != 0;
1073}
8562c99c 1074extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
1da177e4 1075#else
3e909599 1076static inline bool efi_enabled(int feature)
83e68189 1077{
3e909599 1078 return false;
83e68189 1079}
8562c99c
MF
1080static inline void
1081efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
87615a34
MF
1082
1083static inline bool
1084efi_capsule_pending(int *reset_type)
1085{
1086 return false;
1087}
1da177e4
LT
1088#endif
1089
806b0351
MF
1090extern int efi_status_to_err(efi_status_t status);
1091
1da177e4
LT
1092/*
1093 * Variable Attributes
1094 */
1095#define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
1096#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
1097#define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
41b3254c
MG
1098#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
1099#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
1100#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
1101#define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
1102
1103#define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
1104 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
1105 EFI_VARIABLE_RUNTIME_ACCESS | \
1106 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
1107 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
1108 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
1109 EFI_VARIABLE_APPEND_WRITE)
e14ab23d
MF
1110/*
1111 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1112 * not including trailing NUL
1113 */
ba7e34b1 1114#define EFI_VARIABLE_GUID_LEN UUID_STRING_LEN
e14ab23d 1115
e2527a7c
MF
1116/*
1117 * The type of search to perform when calling boottime->locate_handle
1118 */
1119#define EFI_LOCATE_ALL_HANDLES 0
1120#define EFI_LOCATE_BY_REGISTER_NOTIFY 1
1121#define EFI_LOCATE_BY_PROTOCOL 2
1122
1da177e4
LT
1123/*
1124 * EFI Device Path information
1125 */
1126#define EFI_DEV_HW 0x01
1127#define EFI_DEV_PCI 1
1128#define EFI_DEV_PCCARD 2
1129#define EFI_DEV_MEM_MAPPED 3
1130#define EFI_DEV_VENDOR 4
1131#define EFI_DEV_CONTROLLER 5
1132#define EFI_DEV_ACPI 0x02
1133#define EFI_DEV_BASIC_ACPI 1
1134#define EFI_DEV_EXPANDED_ACPI 2
1135#define EFI_DEV_MSG 0x03
1136#define EFI_DEV_MSG_ATAPI 1
1137#define EFI_DEV_MSG_SCSI 2
1138#define EFI_DEV_MSG_FC 3
1139#define EFI_DEV_MSG_1394 4
1140#define EFI_DEV_MSG_USB 5
1141#define EFI_DEV_MSG_USB_CLASS 15
1142#define EFI_DEV_MSG_I20 6
1143#define EFI_DEV_MSG_MAC 11
1144#define EFI_DEV_MSG_IPV4 12
1145#define EFI_DEV_MSG_IPV6 13
1146#define EFI_DEV_MSG_INFINIBAND 9
1147#define EFI_DEV_MSG_UART 14
1148#define EFI_DEV_MSG_VENDOR 10
1149#define EFI_DEV_MEDIA 0x04
1150#define EFI_DEV_MEDIA_HARD_DRIVE 1
1151#define EFI_DEV_MEDIA_CDROM 2
1152#define EFI_DEV_MEDIA_VENDOR 3
1153#define EFI_DEV_MEDIA_FILE 4
1154#define EFI_DEV_MEDIA_PROTOCOL 5
1155#define EFI_DEV_BIOS_BOOT 0x05
1156#define EFI_DEV_END_PATH 0x7F
1157#define EFI_DEV_END_PATH2 0xFF
1158#define EFI_DEV_END_INSTANCE 0x01
1159#define EFI_DEV_END_ENTIRE 0xFF
1160
1161struct efi_generic_dev_path {
1162 u8 type;
1163 u8 sub_type;
1164 u16 length;
1165} __attribute ((packed));
1166
4a3575fd
HY
1167static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1168{
1169 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1170 *addr &= PAGE_MASK;
1171}
1172
4fc756bd
MW
1173/*
1174 * EFI Variable support.
1175 *
1176 * Different firmware drivers can expose their EFI-like variables using
1177 * the following.
1178 */
1179
1180struct efivar_operations {
1181 efi_get_variable_t *get_variable;
1182 efi_get_next_variable_t *get_next_variable;
1183 efi_set_variable_t *set_variable;
70d2a3cf 1184 efi_set_variable_t *set_variable_nonblocking;
a6e4d5a0 1185 efi_query_variable_store_t *query_variable_store;
4fc756bd
MW
1186};
1187
1188struct efivars {
1189 /*
1190 * ->lock protects two things:
82f990a8
MF
1191 * 1) efivarfs_list and efivars_sysfs_list
1192 * 2) ->ops calls
4fc756bd
MW
1193 */
1194 spinlock_t lock;
4fc756bd 1195 struct kset *kset;
605e70c7 1196 struct kobject *kobject;
4fc756bd
MW
1197 const struct efivar_operations *ops;
1198};
1199
e14ab23d
MF
1200/*
1201 * The maximum size of VariableName + Data = 1024
1202 * Therefore, it's reasonable to save that much
1203 * space in each part of the structure,
1204 * and we use a page for reading/writing.
1205 */
1206
a5d92ad3
MF
1207#define EFI_VAR_NAME_LEN 1024
1208
e14ab23d 1209struct efi_variable {
a5d92ad3 1210 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
e14ab23d
MF
1211 efi_guid_t VendorGuid;
1212 unsigned long DataSize;
1213 __u8 Data[1024];
1214 efi_status_t Status;
1215 __u32 Attributes;
1216} __attribute__((packed));
1217
1218struct efivar_entry {
1219 struct efi_variable var;
1220 struct list_head list;
1221 struct kobject kobj;
e0d59733
SA
1222 bool scanning;
1223 bool deleting;
e14ab23d
MF
1224};
1225
677703ce
MF
1226struct efi_simple_text_output_protocol_32 {
1227 u32 reset;
1228 u32 output_string;
1229 u32 test_string;
1230};
1231
1232struct efi_simple_text_output_protocol_64 {
1233 u64 reset;
1234 u64 output_string;
1235 u64 test_string;
1236};
ed37ddff
RF
1237
1238struct efi_simple_text_output_protocol {
1239 void *reset;
1240 efi_status_t (*output_string)(void *, void *);
1241 void *test_string;
1242};
1243
fc372064
AB
1244#define PIXEL_RGB_RESERVED_8BIT_PER_COLOR 0
1245#define PIXEL_BGR_RESERVED_8BIT_PER_COLOR 1
1246#define PIXEL_BIT_MASK 2
1247#define PIXEL_BLT_ONLY 3
1248#define PIXEL_FORMAT_MAX 4
1249
1250struct efi_pixel_bitmask {
1251 u32 red_mask;
1252 u32 green_mask;
1253 u32 blue_mask;
1254 u32 reserved_mask;
1255};
1256
1257struct efi_graphics_output_mode_info {
1258 u32 version;
1259 u32 horizontal_resolution;
1260 u32 vertical_resolution;
1261 int pixel_format;
1262 struct efi_pixel_bitmask pixel_information;
1263 u32 pixels_per_scan_line;
1264} __packed;
1265
1266struct efi_graphics_output_protocol_mode_32 {
1267 u32 max_mode;
1268 u32 mode;
1269 u32 info;
1270 u32 size_of_info;
1271 u64 frame_buffer_base;
1272 u32 frame_buffer_size;
1273} __packed;
1274
1275struct efi_graphics_output_protocol_mode_64 {
1276 u32 max_mode;
1277 u32 mode;
1278 u64 info;
1279 u64 size_of_info;
1280 u64 frame_buffer_base;
1281 u64 frame_buffer_size;
1282} __packed;
1283
1284struct efi_graphics_output_protocol_mode {
1285 u32 max_mode;
1286 u32 mode;
1287 unsigned long info;
1288 unsigned long size_of_info;
1289 u64 frame_buffer_base;
1290 unsigned long frame_buffer_size;
1291} __packed;
1292
1293struct efi_graphics_output_protocol_32 {
1294 u32 query_mode;
1295 u32 set_mode;
1296 u32 blt;
1297 u32 mode;
1298};
1299
1300struct efi_graphics_output_protocol_64 {
1301 u64 query_mode;
1302 u64 set_mode;
1303 u64 blt;
1304 u64 mode;
1305};
1306
1307struct efi_graphics_output_protocol {
1308 unsigned long query_mode;
1309 unsigned long set_mode;
1310 unsigned long blt;
1311 struct efi_graphics_output_protocol_mode *mode;
1312};
1313
1314typedef efi_status_t (*efi_graphics_output_protocol_query_mode)(
1315 struct efi_graphics_output_protocol *, u32, unsigned long *,
1316 struct efi_graphics_output_mode_info **);
1317
04851772
MF
1318extern struct list_head efivar_sysfs_list;
1319
1320static inline void
1321efivar_unregister(struct efivar_entry *var)
1322{
1323 kobject_put(&var->kobj);
1324}
1325
e14ab23d 1326int efivars_register(struct efivars *efivars,
4fc756bd 1327 const struct efivar_operations *ops,
e14ab23d
MF
1328 struct kobject *kobject);
1329int efivars_unregister(struct efivars *efivars);
1330struct kobject *efivars_kobject(void);
1331
1332int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1cfd6316 1333 void *data, bool duplicates, struct list_head *head);
e14ab23d
MF
1334
1335void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1336void efivar_entry_remove(struct efivar_entry *entry);
1337
1338int __efivar_entry_delete(struct efivar_entry *entry);
1339int efivar_entry_delete(struct efivar_entry *entry);
1340
e14ab23d 1341int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
8a415b8c
MF
1342int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1343 unsigned long *size, void *data);
e14ab23d
MF
1344int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1345 unsigned long *size, void *data);
1346int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1347 unsigned long size, void *data, struct list_head *head);
1348int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1349 unsigned long *size, void *data, bool *set);
1350int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1351 bool block, unsigned long size, void *data);
1352
1353void efivar_entry_iter_begin(void);
1354void efivar_entry_iter_end(void);
1355
1356int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1357 struct list_head *head, void *data,
1358 struct efivar_entry **prev);
1359int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1360 struct list_head *head, void *data);
1361
1362struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1363 struct list_head *head, bool remove);
1364
8282f5d9
PJ
1365bool efivar_validate(efi_guid_t vendor, efi_char16_t *var_name, u8 *data,
1366 unsigned long data_size);
ed8b0de5
PJ
1367bool efivar_variable_is_removable(efi_guid_t vendor, const char *name,
1368 size_t len);
e14ab23d 1369
a9499fa7 1370extern struct work_struct efivar_work;
04851772
MF
1371void efivar_run_worker(void);
1372
a9499fa7 1373#if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
e14ab23d 1374int efivars_sysfs_init(void);
4fc756bd 1375
e0d59733
SA
1376#define EFIVARS_DATA_SIZE_MAX 1024
1377
4fc756bd 1378#endif /* CONFIG_EFI_VARS */
f0133f3c
MF
1379extern bool efi_capsule_pending(int *reset_type);
1380
1381extern int efi_capsule_supported(efi_guid_t guid, u32 flags,
1382 size_t size, int *reset);
1383
1384extern int efi_capsule_update(efi_capsule_header_t *capsule,
1385 struct page **pages);
4fc756bd 1386
926172d4
DY
1387#ifdef CONFIG_EFI_RUNTIME_MAP
1388int efi_runtime_map_init(struct kobject *);
1389void efi_runtime_map_setup(void *, int, u32);
6a2c20e7
VG
1390int efi_get_runtime_map_size(void);
1391int efi_get_runtime_map_desc_size(void);
1392int efi_runtime_map_copy(void *buf, size_t bufsz);
926172d4
DY
1393#else
1394static inline int efi_runtime_map_init(struct kobject *kobj)
1395{
1396 return 0;
1397}
1398
1399static inline void
1400efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
6a2c20e7
VG
1401
1402static inline int efi_get_runtime_map_size(void)
1403{
1404 return 0;
1405}
1406
1407static inline int efi_get_runtime_map_desc_size(void)
1408{
1409 return 0;
1410}
1411
1412static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1413{
1414 return 0;
1415}
1416
926172d4
DY
1417#endif
1418
bd669475
AB
1419/* prototypes shared between arch specific and generic stub code */
1420
1421#define pr_efi(sys_table, msg) efi_printk(sys_table, "EFI stub: "msg)
1422#define pr_efi_err(sys_table, msg) efi_printk(sys_table, "EFI stub: ERROR: "msg)
1423
1424void efi_printk(efi_system_table_t *sys_table_arg, char *str);
1425
1426void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
1427 unsigned long addr);
1428
1429char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
1430 efi_loaded_image_t *image, int *cmd_line_len);
1431
1432efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
1433 efi_memory_desc_t **map,
1434 unsigned long *map_size,
1435 unsigned long *desc_size,
1436 u32 *desc_ver,
1437 unsigned long *key_ptr);
1438
1439efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
1440 unsigned long size, unsigned long align,
1441 unsigned long *addr);
1442
1443efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
1444 unsigned long size, unsigned long align,
1445 unsigned long *addr, unsigned long max);
1446
1447efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
1448 unsigned long *image_addr,
1449 unsigned long image_size,
1450 unsigned long alloc_size,
1451 unsigned long preferred_addr,
1452 unsigned long alignment);
1453
1454efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
1455 efi_loaded_image_t *image,
1456 char *cmd_line, char *option_string,
1457 unsigned long max_addr,
1458 unsigned long *load_addr,
1459 unsigned long *load_size);
1460
5a17dae4
MF
1461efi_status_t efi_parse_options(char *cmdline);
1462
2c23b73c
AB
1463efi_status_t efi_setup_gop(efi_system_table_t *sys_table_arg,
1464 struct screen_info *si, efi_guid_t *proto,
1465 unsigned long size);
1466
b2e0a54a 1467bool efi_runtime_disabled(void);
1da177e4 1468#endif /* _LINUX_EFI_H */
This page took 0.916888 seconds and 5 git commands to generate.