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>
27 #define EFI_LOAD_ERROR ( 1 | (1UL << (BITS_PER_LONG-1)))
28 #define EFI_INVALID_PARAMETER ( 2 | (1UL << (BITS_PER_LONG-1)))
29 #define EFI_UNSUPPORTED ( 3 | (1UL << (BITS_PER_LONG-1)))
30 #define EFI_BAD_BUFFER_SIZE ( 4 | (1UL << (BITS_PER_LONG-1)))
31 #define EFI_BUFFER_TOO_SMALL ( 5 | (1UL << (BITS_PER_LONG-1)))
32 #define EFI_NOT_READY ( 6 | (1UL << (BITS_PER_LONG-1)))
33 #define EFI_DEVICE_ERROR ( 7 | (1UL << (BITS_PER_LONG-1)))
34 #define EFI_WRITE_PROTECTED ( 8 | (1UL << (BITS_PER_LONG-1)))
35 #define EFI_OUT_OF_RESOURCES ( 9 | (1UL << (BITS_PER_LONG-1)))
36 #define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
37 #define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1)))
39 typedef unsigned long efi_status_t;
40 typedef u8 efi_bool_t;
41 typedef u16 efi_char16_t; /* UNICODE character */
42 typedef u64 efi_physical_addr_t;
43 typedef void *efi_handle_t;
50 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
52 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
53 (b) & 0xff, ((b) >> 8) & 0xff, \
54 (c) & 0xff, ((c) >> 8) & 0xff, \
55 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
58 * Generic EFI table header
69 * Memory map descriptor:
73 #define EFI_RESERVED_TYPE 0
74 #define EFI_LOADER_CODE 1
75 #define EFI_LOADER_DATA 2
76 #define EFI_BOOT_SERVICES_CODE 3
77 #define EFI_BOOT_SERVICES_DATA 4
78 #define EFI_RUNTIME_SERVICES_CODE 5
79 #define EFI_RUNTIME_SERVICES_DATA 6
80 #define EFI_CONVENTIONAL_MEMORY 7
81 #define EFI_UNUSABLE_MEMORY 8
82 #define EFI_ACPI_RECLAIM_MEMORY 9
83 #define EFI_ACPI_MEMORY_NVS 10
84 #define EFI_MEMORY_MAPPED_IO 11
85 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
86 #define EFI_PAL_CODE 13
87 #define EFI_MAX_MEMORY_TYPE 14
89 /* Attribute values: */
90 #define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
91 #define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
92 #define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
93 #define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
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_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
98 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
100 #define EFI_PAGE_SHIFT 12
101 #define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
117 } efi_capsule_header_t;
120 * Allocation types for calls to boottime->allocate_pages.
122 #define EFI_ALLOCATE_ANY_PAGES 0
123 #define EFI_ALLOCATE_MAX_ADDRESS 1
124 #define EFI_ALLOCATE_ADDRESS 2
125 #define EFI_MAX_ALLOCATE_TYPE 3
127 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
130 * Types and defines for Time Services
132 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
133 #define EFI_TIME_IN_DAYLIGHT 0x2
134 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
171 u32 install_protocol_interface;
172 u32 reinstall_protocol_interface;
173 u32 uninstall_protocol_interface;
176 u32 register_protocol_notify;
178 u32 locate_device_path;
179 u32 install_configuration_table;
184 u32 exit_boot_services;
185 u32 get_next_monotonic_count;
187 u32 set_watchdog_timer;
188 u32 connect_controller;
189 u32 disconnect_controller;
192 u32 open_protocol_information;
193 u32 protocols_per_handle;
194 u32 locate_handle_buffer;
196 u32 install_multiple_protocol_interfaces;
197 u32 uninstall_multiple_protocol_interfaces;
202 } __packed efi_boot_services_32_t;
219 u64 install_protocol_interface;
220 u64 reinstall_protocol_interface;
221 u64 uninstall_protocol_interface;
224 u64 register_protocol_notify;
226 u64 locate_device_path;
227 u64 install_configuration_table;
232 u64 exit_boot_services;
233 u64 get_next_monotonic_count;
235 u64 set_watchdog_timer;
236 u64 connect_controller;
237 u64 disconnect_controller;
240 u64 open_protocol_information;
241 u64 protocols_per_handle;
242 u64 locate_handle_buffer;
244 u64 install_multiple_protocol_interfaces;
245 u64 uninstall_multiple_protocol_interfaces;
250 } __packed efi_boot_services_64_t;
253 * EFI Boot Services table
259 efi_status_t (*allocate_pages)(int, int, unsigned long,
260 efi_physical_addr_t *);
261 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
262 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
263 unsigned long *, u32 *);
264 efi_status_t (*allocate_pool)(int, unsigned long, void **);
265 efi_status_t (*free_pool)(void *);
268 void *wait_for_event;
272 void *install_protocol_interface;
273 void *reinstall_protocol_interface;
274 void *uninstall_protocol_interface;
275 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
277 void *register_protocol_notify;
279 void *locate_device_path;
280 void *install_configuration_table;
285 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
286 void *get_next_monotonic_count;
288 void *set_watchdog_timer;
289 void *connect_controller;
290 void *disconnect_controller;
292 void *close_protocol;
293 void *open_protocol_information;
294 void *protocols_per_handle;
295 void *locate_handle_buffer;
296 void *locate_protocol;
297 void *install_multiple_protocol_interfaces;
298 void *uninstall_multiple_protocol_interfaces;
299 void *calculate_crc32;
302 void *create_event_ex;
303 } efi_boot_services_t;
310 EfiPciIoWidthFifoUint8,
311 EfiPciIoWidthFifoUint16,
312 EfiPciIoWidthFifoUint32,
313 EfiPciIoWidthFifoUint64,
314 EfiPciIoWidthFillUint8,
315 EfiPciIoWidthFillUint16,
316 EfiPciIoWidthFillUint32,
317 EfiPciIoWidthFillUint64,
319 } EFI_PCI_IO_PROTOCOL_WIDTH;
322 EfiPciIoAttributeOperationGet,
323 EfiPciIoAttributeOperationSet,
324 EfiPciIoAttributeOperationEnable,
325 EfiPciIoAttributeOperationDisable,
326 EfiPciIoAttributeOperationSupported,
327 EfiPciIoAttributeOperationMaximum
328 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
333 } efi_pci_io_protocol_access_32_t;
338 } efi_pci_io_protocol_access_64_t;
343 } efi_pci_io_protocol_access_t;
348 efi_pci_io_protocol_access_32_t mem;
349 efi_pci_io_protocol_access_32_t io;
350 efi_pci_io_protocol_access_32_t pci;
359 u32 get_bar_attributes;
360 u32 set_bar_attributes;
363 } efi_pci_io_protocol_32;
368 efi_pci_io_protocol_access_64_t mem;
369 efi_pci_io_protocol_access_64_t io;
370 efi_pci_io_protocol_access_64_t pci;
379 u64 get_bar_attributes;
380 u64 set_bar_attributes;
383 } efi_pci_io_protocol_64;
388 efi_pci_io_protocol_access_t mem;
389 efi_pci_io_protocol_access_t io;
390 efi_pci_io_protocol_access_t pci;
394 void *allocate_buffer;
399 void *get_bar_attributes;
400 void *set_bar_attributes;
403 } efi_pci_io_protocol;
405 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
406 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
407 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
408 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
409 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
410 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
411 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
412 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
413 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
414 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
415 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
416 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
417 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
418 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
419 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
420 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
421 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
422 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
423 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
426 * Types and defines for EFI ResetSystem
428 #define EFI_RESET_COLD 0
429 #define EFI_RESET_WARM 1
430 #define EFI_RESET_SHUTDOWN 2
433 * EFI Runtime Services table
435 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
436 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
444 u32 set_virtual_address_map;
447 u32 get_next_variable;
449 u32 get_next_high_mono_count;
452 u32 query_capsule_caps;
453 u32 query_variable_info;
454 } efi_runtime_services_32_t;
462 u64 set_virtual_address_map;
465 u64 get_next_variable;
467 u64 get_next_high_mono_count;
470 u64 query_capsule_caps;
471 u64 query_variable_info;
472 } efi_runtime_services_64_t;
478 void *get_wakeup_time;
479 void *set_wakeup_time;
480 void *set_virtual_address_map;
481 void *convert_pointer;
483 void *get_next_variable;
485 void *get_next_high_mono_count;
487 void *update_capsule;
488 void *query_capsule_caps;
489 void *query_variable_info;
490 } efi_runtime_services_t;
492 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
493 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
494 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
496 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
497 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
498 unsigned long *data_size, void *data);
499 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
501 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
502 u32 attr, unsigned long data_size,
504 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
505 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
506 unsigned long data_size, efi_char16_t *data);
507 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
508 unsigned long descriptor_size,
509 u32 descriptor_version,
510 efi_memory_desc_t *virtual_map);
511 typedef efi_status_t efi_query_variable_info_t(u32 attr,
513 u64 *remaining_space,
514 u64 *max_variable_size);
515 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
517 unsigned long sg_list);
518 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
522 typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
525 * EFI Configuration Table and GUID definitions
528 EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
530 #define MPS_TABLE_GUID \
531 EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
533 #define ACPI_TABLE_GUID \
534 EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
536 #define ACPI_20_TABLE_GUID \
537 EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
539 #define SMBIOS_TABLE_GUID \
540 EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
542 #define SAL_SYSTEM_TABLE_GUID \
543 EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
545 #define HCDP_TABLE_GUID \
546 EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
548 #define UGA_IO_PROTOCOL_GUID \
549 EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
551 #define EFI_GLOBAL_VARIABLE_GUID \
552 EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
554 #define UV_SYSTEM_TABLE_GUID \
555 EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
557 #define LINUX_EFI_CRASH_GUID \
558 EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
560 #define LOADED_IMAGE_PROTOCOL_GUID \
561 EFI_GUID( 0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
563 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
564 EFI_GUID( 0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
566 #define EFI_UGA_PROTOCOL_GUID \
567 EFI_GUID( 0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
569 #define EFI_PCI_IO_PROTOCOL_GUID \
570 EFI_GUID( 0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
572 #define EFI_FILE_INFO_ID \
573 EFI_GUID( 0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
575 #define EFI_FILE_SYSTEM_GUID \
576 EFI_GUID( 0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
578 #define DEVICE_TREE_GUID \
579 EFI_GUID( 0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0 )
584 } efi_config_table_64_t;
589 } efi_config_table_32_t;
594 } efi_config_table_t;
600 } efi_config_table_type_t;
602 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
604 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
605 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
606 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
607 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
608 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
609 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
613 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
627 } efi_system_table_64_t;
631 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
643 } efi_system_table_32_t;
647 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
649 unsigned long con_in_handle;
650 unsigned long con_in;
651 unsigned long con_out_handle;
652 unsigned long con_out;
653 unsigned long stderr_handle;
654 unsigned long stderr;
655 efi_runtime_services_t *runtime;
656 efi_boot_services_t *boottime;
657 unsigned long nr_tables;
658 unsigned long tables;
659 } efi_system_table_t;
661 struct efi_memory_map {
666 unsigned long desc_version;
667 unsigned long desc_size;
670 struct efi_fdt_params {
685 u32 load_options_size;
688 __aligned_u64 image_size;
689 unsigned int image_code_type;
690 unsigned int image_data_type;
691 unsigned long unload;
692 } efi_loaded_image_32_t;
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_64_t;
713 efi_system_table_t *system_table;
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_t;
731 efi_time_t create_time;
732 efi_time_t last_access_time;
733 efi_time_t modification_time;
734 __aligned_u64 attribute;
735 efi_char16_t filename[1];
750 } efi_file_handle_32_t;
764 } efi_file_handle_64_t;
766 typedef struct _efi_file_handle {
768 efi_status_t (*open)(struct _efi_file_handle *,
769 struct _efi_file_handle **,
770 efi_char16_t *, u64, u64);
771 efi_status_t (*close)(struct _efi_file_handle *);
773 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
778 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
779 unsigned long *, void *);
784 typedef struct _efi_file_io_interface {
786 int (*open_volume)(struct _efi_file_io_interface *,
787 efi_file_handle_t **);
788 } efi_file_io_interface_t;
790 #define EFI_FILE_MODE_READ 0x0000000000000001
791 #define EFI_FILE_MODE_WRITE 0x0000000000000002
792 #define EFI_FILE_MODE_CREATE 0x8000000000000000
794 #define EFI_INVALID_TABLE_ADDR (~0UL)
797 * All runtime access to EFI goes through this structure:
800 efi_system_table_t *systab; /* EFI system table */
801 unsigned int runtime_version; /* Runtime services version */
802 unsigned long mps; /* MPS table */
803 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
804 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
805 unsigned long smbios; /* SM BIOS table */
806 unsigned long sal_systab; /* SAL system table */
807 unsigned long boot_info; /* boot info table */
808 unsigned long hcdp; /* HCDP table */
809 unsigned long uga; /* UGA table */
810 unsigned long uv_systab; /* UV system table */
811 unsigned long fw_vendor; /* fw_vendor */
812 unsigned long runtime; /* runtime table */
813 unsigned long config_table; /* config tables */
814 efi_get_time_t *get_time;
815 efi_set_time_t *set_time;
816 efi_get_wakeup_time_t *get_wakeup_time;
817 efi_set_wakeup_time_t *set_wakeup_time;
818 efi_get_variable_t *get_variable;
819 efi_get_next_variable_t *get_next_variable;
820 efi_set_variable_t *set_variable;
821 efi_query_variable_info_t *query_variable_info;
822 efi_update_capsule_t *update_capsule;
823 efi_query_capsule_caps_t *query_capsule_caps;
824 efi_get_next_high_mono_count_t *get_next_high_mono_count;
825 efi_reset_system_t *reset_system;
826 efi_set_virtual_address_map_t *set_virtual_address_map;
827 struct efi_memory_map *memmap;
832 efi_guidcmp (efi_guid_t left, efi_guid_t right)
834 return memcmp(&left, &right, sizeof (efi_guid_t));
838 efi_guid_unparse(efi_guid_t *guid, char *out)
840 sprintf(out, "%pUl", guid->b);
844 extern void efi_init (void);
845 extern void *efi_get_pal_addr (void);
846 extern void efi_map_pal_code (void);
847 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
848 extern void efi_gettimeofday (struct timespec *ts);
849 extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
851 extern void efi_late_init(void);
852 extern void efi_free_boot_services(void);
853 extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
855 static inline void efi_late_init(void) {}
856 static inline void efi_free_boot_services(void) {}
858 static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
863 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
864 extern int efi_config_init(efi_config_table_type_t *arch_tables);
865 extern u64 efi_get_iobase (void);
866 extern u32 efi_mem_type (unsigned long phys_addr);
867 extern u64 efi_mem_attributes (unsigned long phys_addr);
868 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
869 extern int __init efi_uart_console_only (void);
870 extern void efi_initialize_iomem_resources(struct resource *code_resource,
871 struct resource *data_resource, struct resource *bss_resource);
872 extern void efi_get_time(struct timespec *now);
873 extern int efi_set_rtc_mmss(const struct timespec *now);
874 extern void efi_reserve_boot_services(void);
875 extern int efi_get_fdt_params(struct efi_fdt_params *params, int verbose);
876 extern struct efi_memory_map memmap;
878 /* Iterate through an efi_memory_map */
879 #define for_each_efi_memory_desc(m, md) \
880 for ((md) = (m)->map; \
881 (md) <= (efi_memory_desc_t *)((m)->map_end - (m)->desc_size); \
882 (md) = (void *)(md) + (m)->desc_size)
885 * efi_range_is_wc - check the WC bit on an address range
886 * @start: starting kvirt address
887 * @len: length of range
889 * Consult the EFI memory map and make sure it's ok to set this range WC.
890 * Returns true or false.
892 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
896 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
897 unsigned long paddr = __pa(start + i);
898 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
901 /* The range checked out */
905 #ifdef CONFIG_EFI_PCDP
906 extern int __init efi_setup_pcdp_console(char *);
910 * We play games with efi_enabled so that the compiler will, if
911 * possible, remove EFI-related code altogether.
913 #define EFI_BOOT 0 /* Were we booted from EFI? */
914 #define EFI_SYSTEM_TABLES 1 /* Can we use EFI system tables? */
915 #define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
916 #define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
917 #define EFI_MEMMAP 4 /* Can we use EFI memory map? */
918 #define EFI_64BIT 5 /* Is the firmware 64-bit? */
919 #define EFI_ARCH_1 6 /* First arch-specific bit */
923 * Test whether the above EFI_* bits are enabled.
925 static inline bool efi_enabled(int feature)
927 return test_bit(feature, &efi.flags) != 0;
930 static inline bool efi_enabled(int feature)
937 * Variable Attributes
939 #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
940 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
941 #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
942 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
943 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
944 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
945 #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
947 #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
948 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
949 EFI_VARIABLE_RUNTIME_ACCESS | \
950 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
951 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
952 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
953 EFI_VARIABLE_APPEND_WRITE)
955 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
956 * not including trailing NUL
958 #define EFI_VARIABLE_GUID_LEN 36
961 * The type of search to perform when calling boottime->locate_handle
963 #define EFI_LOCATE_ALL_HANDLES 0
964 #define EFI_LOCATE_BY_REGISTER_NOTIFY 1
965 #define EFI_LOCATE_BY_PROTOCOL 2
968 * EFI Device Path information
970 #define EFI_DEV_HW 0x01
971 #define EFI_DEV_PCI 1
972 #define EFI_DEV_PCCARD 2
973 #define EFI_DEV_MEM_MAPPED 3
974 #define EFI_DEV_VENDOR 4
975 #define EFI_DEV_CONTROLLER 5
976 #define EFI_DEV_ACPI 0x02
977 #define EFI_DEV_BASIC_ACPI 1
978 #define EFI_DEV_EXPANDED_ACPI 2
979 #define EFI_DEV_MSG 0x03
980 #define EFI_DEV_MSG_ATAPI 1
981 #define EFI_DEV_MSG_SCSI 2
982 #define EFI_DEV_MSG_FC 3
983 #define EFI_DEV_MSG_1394 4
984 #define EFI_DEV_MSG_USB 5
985 #define EFI_DEV_MSG_USB_CLASS 15
986 #define EFI_DEV_MSG_I20 6
987 #define EFI_DEV_MSG_MAC 11
988 #define EFI_DEV_MSG_IPV4 12
989 #define EFI_DEV_MSG_IPV6 13
990 #define EFI_DEV_MSG_INFINIBAND 9
991 #define EFI_DEV_MSG_UART 14
992 #define EFI_DEV_MSG_VENDOR 10
993 #define EFI_DEV_MEDIA 0x04
994 #define EFI_DEV_MEDIA_HARD_DRIVE 1
995 #define EFI_DEV_MEDIA_CDROM 2
996 #define EFI_DEV_MEDIA_VENDOR 3
997 #define EFI_DEV_MEDIA_FILE 4
998 #define EFI_DEV_MEDIA_PROTOCOL 5
999 #define EFI_DEV_BIOS_BOOT 0x05
1000 #define EFI_DEV_END_PATH 0x7F
1001 #define EFI_DEV_END_PATH2 0xFF
1002 #define EFI_DEV_END_INSTANCE 0x01
1003 #define EFI_DEV_END_ENTIRE 0xFF
1005 struct efi_generic_dev_path {
1009 } __attribute ((packed));
1011 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1013 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1018 * EFI Variable support.
1020 * Different firmware drivers can expose their EFI-like variables using
1024 struct efivar_operations {
1025 efi_get_variable_t *get_variable;
1026 efi_get_next_variable_t *get_next_variable;
1027 efi_set_variable_t *set_variable;
1028 efi_query_variable_store_t *query_variable_store;
1033 * ->lock protects two things:
1034 * 1) ->list - adds, removals, reads, writes
1035 * 2) ops.[gs]et_variable() calls.
1036 * It must not be held when creating sysfs entries or calling kmalloc.
1037 * ops.get_next_variable() is only called from register_efivars()
1038 * or efivar_update_sysfs_entries(),
1039 * which is protected by the BKL, so that path is safe.
1043 struct kobject *kobject;
1044 const struct efivar_operations *ops;
1048 * The maximum size of VariableName + Data = 1024
1049 * Therefore, it's reasonable to save that much
1050 * space in each part of the structure,
1051 * and we use a page for reading/writing.
1054 #define EFI_VAR_NAME_LEN 1024
1056 struct efi_variable {
1057 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
1058 efi_guid_t VendorGuid;
1059 unsigned long DataSize;
1061 efi_status_t Status;
1063 } __attribute__((packed));
1065 struct efivar_entry {
1066 struct efi_variable var;
1067 struct list_head list;
1068 struct kobject kobj;
1073 struct efi_simple_text_output_protocol_32 {
1079 struct efi_simple_text_output_protocol_64 {
1085 struct efi_simple_text_output_protocol {
1087 efi_status_t (*output_string)(void *, void *);
1091 extern struct list_head efivar_sysfs_list;
1094 efivar_unregister(struct efivar_entry *var)
1096 kobject_put(&var->kobj);
1099 int efivars_register(struct efivars *efivars,
1100 const struct efivar_operations *ops,
1101 struct kobject *kobject);
1102 int efivars_unregister(struct efivars *efivars);
1103 struct kobject *efivars_kobject(void);
1105 int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1106 void *data, bool atomic, bool duplicates,
1107 struct list_head *head);
1109 void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1110 void efivar_entry_remove(struct efivar_entry *entry);
1112 int __efivar_entry_delete(struct efivar_entry *entry);
1113 int efivar_entry_delete(struct efivar_entry *entry);
1115 int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
1116 int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1117 unsigned long *size, void *data);
1118 int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1119 unsigned long *size, void *data);
1120 int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1121 unsigned long size, void *data, struct list_head *head);
1122 int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1123 unsigned long *size, void *data, bool *set);
1124 int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1125 bool block, unsigned long size, void *data);
1127 void efivar_entry_iter_begin(void);
1128 void efivar_entry_iter_end(void);
1130 int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1131 struct list_head *head, void *data,
1132 struct efivar_entry **prev);
1133 int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1134 struct list_head *head, void *data);
1136 struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1137 struct list_head *head, bool remove);
1139 bool efivar_validate(efi_char16_t *var_name, u8 *data, unsigned long len);
1141 extern struct work_struct efivar_work;
1142 void efivar_run_worker(void);
1144 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
1145 int efivars_sysfs_init(void);
1147 #define EFIVARS_DATA_SIZE_MAX 1024
1149 #endif /* CONFIG_EFI_VARS */
1151 #ifdef CONFIG_EFI_RUNTIME_MAP
1152 int efi_runtime_map_init(struct kobject *);
1153 void efi_runtime_map_setup(void *, int, u32);
1155 static inline int efi_runtime_map_init(struct kobject *kobj)
1161 efi_runtime_map_setup(void *map, int nr_entries, u32 desc_size) {}
1164 #endif /* _LINUX_EFI_H */