5 * Extensible Firmware Interface
6 * Based on 'Extensible Firmware Interface Specification' version 0.9, April 30, 1999
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>
14 #include <linux/init.h>
15 #include <linux/string.h>
16 #include <linux/time.h>
17 #include <linux/types.h>
18 #include <linux/proc_fs.h>
19 #include <linux/rtc.h>
20 #include <linux/ioport.h>
21 #include <linux/pfn.h>
22 #include <linux/pstore.h>
23 #include <linux/reboot.h>
28 #define EFI_LOAD_ERROR ( 1 | (1UL << (BITS_PER_LONG-1)))
29 #define EFI_INVALID_PARAMETER ( 2 | (1UL << (BITS_PER_LONG-1)))
30 #define EFI_UNSUPPORTED ( 3 | (1UL << (BITS_PER_LONG-1)))
31 #define EFI_BAD_BUFFER_SIZE ( 4 | (1UL << (BITS_PER_LONG-1)))
32 #define EFI_BUFFER_TOO_SMALL ( 5 | (1UL << (BITS_PER_LONG-1)))
33 #define EFI_NOT_READY ( 6 | (1UL << (BITS_PER_LONG-1)))
34 #define EFI_DEVICE_ERROR ( 7 | (1UL << (BITS_PER_LONG-1)))
35 #define EFI_WRITE_PROTECTED ( 8 | (1UL << (BITS_PER_LONG-1)))
36 #define EFI_OUT_OF_RESOURCES ( 9 | (1UL << (BITS_PER_LONG-1)))
37 #define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
38 #define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1)))
40 typedef unsigned long efi_status_t;
41 typedef u8 efi_bool_t;
42 typedef u16 efi_char16_t; /* UNICODE character */
43 typedef u64 efi_physical_addr_t;
44 typedef void *efi_handle_t;
51 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
53 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
54 (b) & 0xff, ((b) >> 8) & 0xff, \
55 (c) & 0xff, ((c) >> 8) & 0xff, \
56 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
59 * Generic EFI table header
70 * Memory map descriptor:
74 #define EFI_RESERVED_TYPE 0
75 #define EFI_LOADER_CODE 1
76 #define EFI_LOADER_DATA 2
77 #define EFI_BOOT_SERVICES_CODE 3
78 #define EFI_BOOT_SERVICES_DATA 4
79 #define EFI_RUNTIME_SERVICES_CODE 5
80 #define EFI_RUNTIME_SERVICES_DATA 6
81 #define EFI_CONVENTIONAL_MEMORY 7
82 #define EFI_UNUSABLE_MEMORY 8
83 #define EFI_ACPI_RECLAIM_MEMORY 9
84 #define EFI_ACPI_MEMORY_NVS 10
85 #define EFI_MEMORY_MAPPED_IO 11
86 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
87 #define EFI_PAL_CODE 13
88 #define EFI_MAX_MEMORY_TYPE 14
90 /* Attribute values: */
91 #define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
92 #define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
93 #define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
94 #define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
95 #define EFI_MEMORY_UCE ((u64)0x0000000000000010ULL) /* uncached, exported */
96 #define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
97 #define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
98 #define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
99 #define EFI_MEMORY_MORE_RELIABLE \
100 ((u64)0x0000000000010000ULL) /* higher reliability */
101 #define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
102 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
104 #define EFI_PAGE_SHIFT 12
105 #define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
121 } efi_capsule_header_t;
124 * Allocation types for calls to boottime->allocate_pages.
126 #define EFI_ALLOCATE_ANY_PAGES 0
127 #define EFI_ALLOCATE_MAX_ADDRESS 1
128 #define EFI_ALLOCATE_ADDRESS 2
129 #define EFI_MAX_ALLOCATE_TYPE 3
131 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
134 * Types and defines for Time Services
136 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
137 #define EFI_TIME_IN_DAYLIGHT 0x2
138 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
175 u32 install_protocol_interface;
176 u32 reinstall_protocol_interface;
177 u32 uninstall_protocol_interface;
180 u32 register_protocol_notify;
182 u32 locate_device_path;
183 u32 install_configuration_table;
188 u32 exit_boot_services;
189 u32 get_next_monotonic_count;
191 u32 set_watchdog_timer;
192 u32 connect_controller;
193 u32 disconnect_controller;
196 u32 open_protocol_information;
197 u32 protocols_per_handle;
198 u32 locate_handle_buffer;
200 u32 install_multiple_protocol_interfaces;
201 u32 uninstall_multiple_protocol_interfaces;
206 } __packed efi_boot_services_32_t;
223 u64 install_protocol_interface;
224 u64 reinstall_protocol_interface;
225 u64 uninstall_protocol_interface;
228 u64 register_protocol_notify;
230 u64 locate_device_path;
231 u64 install_configuration_table;
236 u64 exit_boot_services;
237 u64 get_next_monotonic_count;
239 u64 set_watchdog_timer;
240 u64 connect_controller;
241 u64 disconnect_controller;
244 u64 open_protocol_information;
245 u64 protocols_per_handle;
246 u64 locate_handle_buffer;
248 u64 install_multiple_protocol_interfaces;
249 u64 uninstall_multiple_protocol_interfaces;
254 } __packed efi_boot_services_64_t;
257 * EFI Boot Services table
263 efi_status_t (*allocate_pages)(int, int, unsigned long,
264 efi_physical_addr_t *);
265 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
266 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
267 unsigned long *, u32 *);
268 efi_status_t (*allocate_pool)(int, unsigned long, void **);
269 efi_status_t (*free_pool)(void *);
272 void *wait_for_event;
276 void *install_protocol_interface;
277 void *reinstall_protocol_interface;
278 void *uninstall_protocol_interface;
279 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
281 void *register_protocol_notify;
283 void *locate_device_path;
284 void *install_configuration_table;
289 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
290 void *get_next_monotonic_count;
292 void *set_watchdog_timer;
293 void *connect_controller;
294 void *disconnect_controller;
296 void *close_protocol;
297 void *open_protocol_information;
298 void *protocols_per_handle;
299 void *locate_handle_buffer;
300 void *locate_protocol;
301 void *install_multiple_protocol_interfaces;
302 void *uninstall_multiple_protocol_interfaces;
303 void *calculate_crc32;
306 void *create_event_ex;
307 } efi_boot_services_t;
314 EfiPciIoWidthFifoUint8,
315 EfiPciIoWidthFifoUint16,
316 EfiPciIoWidthFifoUint32,
317 EfiPciIoWidthFifoUint64,
318 EfiPciIoWidthFillUint8,
319 EfiPciIoWidthFillUint16,
320 EfiPciIoWidthFillUint32,
321 EfiPciIoWidthFillUint64,
323 } EFI_PCI_IO_PROTOCOL_WIDTH;
326 EfiPciIoAttributeOperationGet,
327 EfiPciIoAttributeOperationSet,
328 EfiPciIoAttributeOperationEnable,
329 EfiPciIoAttributeOperationDisable,
330 EfiPciIoAttributeOperationSupported,
331 EfiPciIoAttributeOperationMaximum
332 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
337 } efi_pci_io_protocol_access_32_t;
342 } efi_pci_io_protocol_access_64_t;
347 } efi_pci_io_protocol_access_t;
352 efi_pci_io_protocol_access_32_t mem;
353 efi_pci_io_protocol_access_32_t io;
354 efi_pci_io_protocol_access_32_t pci;
363 u32 get_bar_attributes;
364 u32 set_bar_attributes;
367 } efi_pci_io_protocol_32;
372 efi_pci_io_protocol_access_64_t mem;
373 efi_pci_io_protocol_access_64_t io;
374 efi_pci_io_protocol_access_64_t pci;
383 u64 get_bar_attributes;
384 u64 set_bar_attributes;
387 } efi_pci_io_protocol_64;
392 efi_pci_io_protocol_access_t mem;
393 efi_pci_io_protocol_access_t io;
394 efi_pci_io_protocol_access_t pci;
398 void *allocate_buffer;
403 void *get_bar_attributes;
404 void *set_bar_attributes;
407 } efi_pci_io_protocol;
409 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
410 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
411 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
412 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
413 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
414 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
415 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
416 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
417 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
418 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
419 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
420 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
421 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
422 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
423 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
424 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
425 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
426 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
427 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
430 * Types and defines for EFI ResetSystem
432 #define EFI_RESET_COLD 0
433 #define EFI_RESET_WARM 1
434 #define EFI_RESET_SHUTDOWN 2
437 * EFI Runtime Services table
439 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
440 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
448 u32 set_virtual_address_map;
451 u32 get_next_variable;
453 u32 get_next_high_mono_count;
456 u32 query_capsule_caps;
457 u32 query_variable_info;
458 } efi_runtime_services_32_t;
466 u64 set_virtual_address_map;
469 u64 get_next_variable;
471 u64 get_next_high_mono_count;
474 u64 query_capsule_caps;
475 u64 query_variable_info;
476 } efi_runtime_services_64_t;
482 void *get_wakeup_time;
483 void *set_wakeup_time;
484 void *set_virtual_address_map;
485 void *convert_pointer;
487 void *get_next_variable;
489 void *get_next_high_mono_count;
491 void *update_capsule;
492 void *query_capsule_caps;
493 void *query_variable_info;
494 } efi_runtime_services_t;
496 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
497 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
498 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
500 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
501 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
502 unsigned long *data_size, void *data);
503 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
505 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
506 u32 attr, unsigned long data_size,
509 efi_set_variable_nonblocking_t(efi_char16_t *name, efi_guid_t *vendor,
510 u32 attr, unsigned long data_size, void *data);
512 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
513 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
514 unsigned long data_size, efi_char16_t *data);
515 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
516 unsigned long descriptor_size,
517 u32 descriptor_version,
518 efi_memory_desc_t *virtual_map);
519 typedef efi_status_t efi_query_variable_info_t(u32 attr,
521 u64 *remaining_space,
522 u64 *max_variable_size);
523 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
525 unsigned long sg_list);
526 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
530 typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
532 void efi_native_runtime_setup(void);
535 * EFI Configuration Table and GUID definitions
538 EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
540 #define MPS_TABLE_GUID \
541 EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
543 #define ACPI_TABLE_GUID \
544 EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
546 #define ACPI_20_TABLE_GUID \
547 EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
549 #define SMBIOS_TABLE_GUID \
550 EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
552 #define SMBIOS3_TABLE_GUID \
553 EFI_GUID( 0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94 )
555 #define SAL_SYSTEM_TABLE_GUID \
556 EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
558 #define HCDP_TABLE_GUID \
559 EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
561 #define UGA_IO_PROTOCOL_GUID \
562 EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
564 #define EFI_GLOBAL_VARIABLE_GUID \
565 EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
567 #define UV_SYSTEM_TABLE_GUID \
568 EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
570 #define LINUX_EFI_CRASH_GUID \
571 EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
573 #define LOADED_IMAGE_PROTOCOL_GUID \
574 EFI_GUID( 0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
576 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
577 EFI_GUID( 0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
579 #define EFI_UGA_PROTOCOL_GUID \
580 EFI_GUID( 0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
582 #define EFI_PCI_IO_PROTOCOL_GUID \
583 EFI_GUID( 0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
585 #define EFI_FILE_INFO_ID \
586 EFI_GUID( 0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
588 #define EFI_SYSTEM_RESOURCE_TABLE_GUID \
589 EFI_GUID( 0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80 )
591 #define EFI_FILE_SYSTEM_GUID \
592 EFI_GUID( 0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
594 #define DEVICE_TREE_GUID \
595 EFI_GUID( 0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0 )
600 } efi_config_table_64_t;
605 } efi_config_table_32_t;
610 } efi_config_table_t;
616 } efi_config_table_type_t;
618 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
620 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
621 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
622 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
623 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
624 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
625 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
629 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
643 } efi_system_table_64_t;
647 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
659 } efi_system_table_32_t;
663 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
665 unsigned long con_in_handle;
666 unsigned long con_in;
667 unsigned long con_out_handle;
668 unsigned long con_out;
669 unsigned long stderr_handle;
670 unsigned long stderr;
671 efi_runtime_services_t *runtime;
672 efi_boot_services_t *boottime;
673 unsigned long nr_tables;
674 unsigned long tables;
675 } efi_system_table_t;
677 struct efi_memory_map {
682 unsigned long desc_version;
683 unsigned long desc_size;
686 struct efi_fdt_params {
701 u32 load_options_size;
704 __aligned_u64 image_size;
705 unsigned int image_code_type;
706 unsigned int image_data_type;
707 unsigned long unload;
708 } efi_loaded_image_32_t;
717 u32 load_options_size;
720 __aligned_u64 image_size;
721 unsigned int image_code_type;
722 unsigned int image_data_type;
723 unsigned long unload;
724 } efi_loaded_image_64_t;
729 efi_system_table_t *system_table;
733 u32 load_options_size;
736 __aligned_u64 image_size;
737 unsigned int image_code_type;
738 unsigned int image_data_type;
739 unsigned long unload;
740 } efi_loaded_image_t;
747 efi_time_t create_time;
748 efi_time_t last_access_time;
749 efi_time_t modification_time;
750 __aligned_u64 attribute;
751 efi_char16_t filename[1];
766 } efi_file_handle_32_t;
780 } efi_file_handle_64_t;
782 typedef struct _efi_file_handle {
784 efi_status_t (*open)(struct _efi_file_handle *,
785 struct _efi_file_handle **,
786 efi_char16_t *, u64, u64);
787 efi_status_t (*close)(struct _efi_file_handle *);
789 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
794 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
795 unsigned long *, void *);
800 typedef struct _efi_file_io_interface {
802 int (*open_volume)(struct _efi_file_io_interface *,
803 efi_file_handle_t **);
804 } efi_file_io_interface_t;
806 #define EFI_FILE_MODE_READ 0x0000000000000001
807 #define EFI_FILE_MODE_WRITE 0x0000000000000002
808 #define EFI_FILE_MODE_CREATE 0x8000000000000000
810 #define EFI_INVALID_TABLE_ADDR (~0UL)
813 * All runtime access to EFI goes through this structure:
816 efi_system_table_t *systab; /* EFI system table */
817 unsigned int runtime_version; /* Runtime services version */
818 unsigned long mps; /* MPS table */
819 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
820 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
821 unsigned long smbios; /* SMBIOS table (32 bit entry point) */
822 unsigned long smbios3; /* SMBIOS table (64 bit entry point) */
823 unsigned long sal_systab; /* SAL system table */
824 unsigned long boot_info; /* boot info table */
825 unsigned long hcdp; /* HCDP table */
826 unsigned long uga; /* UGA table */
827 unsigned long uv_systab; /* UV system table */
828 unsigned long fw_vendor; /* fw_vendor */
829 unsigned long runtime; /* runtime table */
830 unsigned long config_table; /* config tables */
831 unsigned long esrt; /* ESRT table */
832 efi_get_time_t *get_time;
833 efi_set_time_t *set_time;
834 efi_get_wakeup_time_t *get_wakeup_time;
835 efi_set_wakeup_time_t *set_wakeup_time;
836 efi_get_variable_t *get_variable;
837 efi_get_next_variable_t *get_next_variable;
838 efi_set_variable_t *set_variable;
839 efi_set_variable_nonblocking_t *set_variable_nonblocking;
840 efi_query_variable_info_t *query_variable_info;
841 efi_update_capsule_t *update_capsule;
842 efi_query_capsule_caps_t *query_capsule_caps;
843 efi_get_next_high_mono_count_t *get_next_high_mono_count;
844 efi_reset_system_t *reset_system;
845 efi_set_virtual_address_map_t *set_virtual_address_map;
846 struct efi_memory_map *memmap;
851 efi_guidcmp (efi_guid_t left, efi_guid_t right)
853 return memcmp(&left, &right, sizeof (efi_guid_t));
857 efi_guid_to_str(efi_guid_t *guid, char *out)
859 sprintf(out, "%pUl", guid->b);
863 extern void efi_init (void);
864 extern void *efi_get_pal_addr (void);
865 extern void efi_map_pal_code (void);
866 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
867 extern void efi_gettimeofday (struct timespec *ts);
868 extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
870 extern void efi_late_init(void);
871 extern void efi_free_boot_services(void);
872 extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
873 extern void efi_find_mirror(void);
875 static inline void efi_late_init(void) {}
876 static inline void efi_free_boot_services(void) {}
878 static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
883 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
884 extern int efi_config_init(efi_config_table_type_t *arch_tables);
885 #ifdef CONFIG_EFI_ESRT
886 extern void __init efi_esrt_init(void);
888 static inline void efi_esrt_init(void) { }
890 extern int efi_config_parse_tables(void *config_tables, int count, int sz,
891 efi_config_table_type_t *arch_tables);
892 extern u64 efi_get_iobase (void);
893 extern u32 efi_mem_type (unsigned long phys_addr);
894 extern u64 efi_mem_attributes (unsigned long phys_addr);
895 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
896 extern int __init efi_uart_console_only (void);
897 extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
898 extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
899 extern void efi_initialize_iomem_resources(struct resource *code_resource,
900 struct resource *data_resource, struct resource *bss_resource);
901 extern void efi_get_time(struct timespec *now);
902 extern void efi_reserve_boot_services(void);
903 extern int efi_get_fdt_params(struct efi_fdt_params *params, int verbose);
904 extern struct efi_memory_map memmap;
905 extern struct kobject *efi_kobj;
907 extern int efi_reboot_quirk_mode;
908 extern bool efi_poweroff_required(void);
910 /* Iterate through an efi_memory_map */
911 #define for_each_efi_memory_desc(m, md) \
912 for ((md) = (m)->map; \
913 (md) <= (efi_memory_desc_t *)((m)->map_end - (m)->desc_size); \
914 (md) = (void *)(md) + (m)->desc_size)
917 * Format an EFI memory descriptor's type and attributes to a user-provided
918 * character buffer, as per snprintf(), and return the buffer.
920 char * __init efi_md_typeattr_format(char *buf, size_t size,
921 const efi_memory_desc_t *md);
924 * efi_range_is_wc - check the WC bit on an address range
925 * @start: starting kvirt address
926 * @len: length of range
928 * Consult the EFI memory map and make sure it's ok to set this range WC.
929 * Returns true or false.
931 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
935 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
936 unsigned long paddr = __pa(start + i);
937 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
940 /* The range checked out */
944 #ifdef CONFIG_EFI_PCDP
945 extern int __init efi_setup_pcdp_console(char *);
949 * We play games with efi_enabled so that the compiler will, if
950 * possible, remove EFI-related code altogether.
952 #define EFI_BOOT 0 /* Were we booted from EFI? */
953 #define EFI_SYSTEM_TABLES 1 /* Can we use EFI system tables? */
954 #define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
955 #define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
956 #define EFI_MEMMAP 4 /* Can we use EFI memory map? */
957 #define EFI_64BIT 5 /* Is the firmware 64-bit? */
958 #define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
959 #define EFI_ARCH_1 7 /* First arch-specific bit */
960 #define EFI_DBG 8 /* Print additional debug info at runtime */
964 * Test whether the above EFI_* bits are enabled.
966 static inline bool efi_enabled(int feature)
968 return test_bit(feature, &efi.flags) != 0;
970 extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
972 static inline bool efi_enabled(int feature)
977 efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
981 * Variable Attributes
983 #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
984 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
985 #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
986 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
987 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
988 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
989 #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
991 #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
992 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
993 EFI_VARIABLE_RUNTIME_ACCESS | \
994 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
995 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
996 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
997 EFI_VARIABLE_APPEND_WRITE)
999 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1000 * not including trailing NUL
1002 #define EFI_VARIABLE_GUID_LEN 36
1005 * The type of search to perform when calling boottime->locate_handle
1007 #define EFI_LOCATE_ALL_HANDLES 0
1008 #define EFI_LOCATE_BY_REGISTER_NOTIFY 1
1009 #define EFI_LOCATE_BY_PROTOCOL 2
1012 * EFI Device Path information
1014 #define EFI_DEV_HW 0x01
1015 #define EFI_DEV_PCI 1
1016 #define EFI_DEV_PCCARD 2
1017 #define EFI_DEV_MEM_MAPPED 3
1018 #define EFI_DEV_VENDOR 4
1019 #define EFI_DEV_CONTROLLER 5
1020 #define EFI_DEV_ACPI 0x02
1021 #define EFI_DEV_BASIC_ACPI 1
1022 #define EFI_DEV_EXPANDED_ACPI 2
1023 #define EFI_DEV_MSG 0x03
1024 #define EFI_DEV_MSG_ATAPI 1
1025 #define EFI_DEV_MSG_SCSI 2
1026 #define EFI_DEV_MSG_FC 3
1027 #define EFI_DEV_MSG_1394 4
1028 #define EFI_DEV_MSG_USB 5
1029 #define EFI_DEV_MSG_USB_CLASS 15
1030 #define EFI_DEV_MSG_I20 6
1031 #define EFI_DEV_MSG_MAC 11
1032 #define EFI_DEV_MSG_IPV4 12
1033 #define EFI_DEV_MSG_IPV6 13
1034 #define EFI_DEV_MSG_INFINIBAND 9
1035 #define EFI_DEV_MSG_UART 14
1036 #define EFI_DEV_MSG_VENDOR 10
1037 #define EFI_DEV_MEDIA 0x04
1038 #define EFI_DEV_MEDIA_HARD_DRIVE 1
1039 #define EFI_DEV_MEDIA_CDROM 2
1040 #define EFI_DEV_MEDIA_VENDOR 3
1041 #define EFI_DEV_MEDIA_FILE 4
1042 #define EFI_DEV_MEDIA_PROTOCOL 5
1043 #define EFI_DEV_BIOS_BOOT 0x05
1044 #define EFI_DEV_END_PATH 0x7F
1045 #define EFI_DEV_END_PATH2 0xFF
1046 #define EFI_DEV_END_INSTANCE 0x01
1047 #define EFI_DEV_END_ENTIRE 0xFF
1049 struct efi_generic_dev_path {
1053 } __attribute ((packed));
1055 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1057 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1062 * EFI Variable support.
1064 * Different firmware drivers can expose their EFI-like variables using
1068 struct efivar_operations {
1069 efi_get_variable_t *get_variable;
1070 efi_get_next_variable_t *get_next_variable;
1071 efi_set_variable_t *set_variable;
1072 efi_set_variable_nonblocking_t *set_variable_nonblocking;
1073 efi_query_variable_store_t *query_variable_store;
1078 * ->lock protects two things:
1079 * 1) efivarfs_list and efivars_sysfs_list
1084 struct kobject *kobject;
1085 const struct efivar_operations *ops;
1089 * The maximum size of VariableName + Data = 1024
1090 * Therefore, it's reasonable to save that much
1091 * space in each part of the structure,
1092 * and we use a page for reading/writing.
1095 #define EFI_VAR_NAME_LEN 1024
1097 struct efi_variable {
1098 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
1099 efi_guid_t VendorGuid;
1100 unsigned long DataSize;
1102 efi_status_t Status;
1104 } __attribute__((packed));
1106 struct efivar_entry {
1107 struct efi_variable var;
1108 struct list_head list;
1109 struct kobject kobj;
1114 struct efi_simple_text_output_protocol_32 {
1120 struct efi_simple_text_output_protocol_64 {
1126 struct efi_simple_text_output_protocol {
1128 efi_status_t (*output_string)(void *, void *);
1132 extern struct list_head efivar_sysfs_list;
1135 efivar_unregister(struct efivar_entry *var)
1137 kobject_put(&var->kobj);
1140 int efivars_register(struct efivars *efivars,
1141 const struct efivar_operations *ops,
1142 struct kobject *kobject);
1143 int efivars_unregister(struct efivars *efivars);
1144 struct kobject *efivars_kobject(void);
1146 int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1147 void *data, bool atomic, bool duplicates,
1148 struct list_head *head);
1150 void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1151 void efivar_entry_remove(struct efivar_entry *entry);
1153 int __efivar_entry_delete(struct efivar_entry *entry);
1154 int efivar_entry_delete(struct efivar_entry *entry);
1156 int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
1157 int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1158 unsigned long *size, void *data);
1159 int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1160 unsigned long *size, void *data);
1161 int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1162 unsigned long size, void *data, struct list_head *head);
1163 int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1164 unsigned long *size, void *data, bool *set);
1165 int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1166 bool block, unsigned long size, void *data);
1168 void efivar_entry_iter_begin(void);
1169 void efivar_entry_iter_end(void);
1171 int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1172 struct list_head *head, void *data,
1173 struct efivar_entry **prev);
1174 int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1175 struct list_head *head, void *data);
1177 struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1178 struct list_head *head, bool remove);
1180 bool efivar_validate(efi_char16_t *var_name, u8 *data, unsigned long len);
1182 extern struct work_struct efivar_work;
1183 void efivar_run_worker(void);
1185 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
1186 int efivars_sysfs_init(void);
1188 #define EFIVARS_DATA_SIZE_MAX 1024
1190 #endif /* CONFIG_EFI_VARS */
1192 #ifdef CONFIG_EFI_RUNTIME_MAP
1193 int efi_runtime_map_init(struct kobject *);
1194 void efi_runtime_map_setup(void *, int, u32);
1195 int efi_get_runtime_map_size(void);
1196 int efi_get_runtime_map_desc_size(void);
1197 int efi_runtime_map_copy(void *buf, size_t bufsz);
1199 static inline int efi_runtime_map_init(struct kobject *kobj)
1205 efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
1207 static inline int efi_get_runtime_map_size(void)
1212 static inline int efi_get_runtime_map_desc_size(void)
1217 static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1224 /* prototypes shared between arch specific and generic stub code */
1226 #define pr_efi(sys_table, msg) efi_printk(sys_table, "EFI stub: "msg)
1227 #define pr_efi_err(sys_table, msg) efi_printk(sys_table, "EFI stub: ERROR: "msg)
1229 void efi_printk(efi_system_table_t *sys_table_arg, char *str);
1231 void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
1232 unsigned long addr);
1234 char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
1235 efi_loaded_image_t *image, int *cmd_line_len);
1237 efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
1238 efi_memory_desc_t **map,
1239 unsigned long *map_size,
1240 unsigned long *desc_size,
1242 unsigned long *key_ptr);
1244 efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
1245 unsigned long size, unsigned long align,
1246 unsigned long *addr);
1248 efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
1249 unsigned long size, unsigned long align,
1250 unsigned long *addr, unsigned long max);
1252 efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
1253 unsigned long *image_addr,
1254 unsigned long image_size,
1255 unsigned long alloc_size,
1256 unsigned long preferred_addr,
1257 unsigned long alignment);
1259 efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
1260 efi_loaded_image_t *image,
1261 char *cmd_line, char *option_string,
1262 unsigned long max_addr,
1263 unsigned long *load_addr,
1264 unsigned long *load_size);
1266 efi_status_t efi_parse_options(char *cmdline);
1268 bool efi_runtime_disabled(void);
1269 #endif /* _LINUX_EFI_H */