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