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