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_PERSISTENT_MEMORY 14
89 #define EFI_MAX_MEMORY_TYPE 15
91 /* Attribute values: */
92 #define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
93 #define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
94 #define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
95 #define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
96 #define EFI_MEMORY_UCE ((u64)0x0000000000000010ULL) /* uncached, exported */
97 #define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
98 #define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
99 #define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
100 #define EFI_MEMORY_NV ((u64)0x0000000000008000ULL) /* non-volatile */
101 #define EFI_MEMORY_MORE_RELIABLE \
102 ((u64)0x0000000000010000ULL) /* higher reliability */
103 #define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */
104 #define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
105 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
107 #define EFI_PAGE_SHIFT 12
108 #define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
124 } efi_capsule_header_t
;
127 * Allocation types for calls to boottime->allocate_pages.
129 #define EFI_ALLOCATE_ANY_PAGES 0
130 #define EFI_ALLOCATE_MAX_ADDRESS 1
131 #define EFI_ALLOCATE_ADDRESS 2
132 #define EFI_MAX_ALLOCATE_TYPE 3
134 typedef int (*efi_freemem_callback_t
) (u64 start
, u64 end
, void *arg
);
137 * Types and defines for Time Services
139 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
140 #define EFI_TIME_IN_DAYLIGHT 0x2
141 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
178 u32 install_protocol_interface
;
179 u32 reinstall_protocol_interface
;
180 u32 uninstall_protocol_interface
;
183 u32 register_protocol_notify
;
185 u32 locate_device_path
;
186 u32 install_configuration_table
;
191 u32 exit_boot_services
;
192 u32 get_next_monotonic_count
;
194 u32 set_watchdog_timer
;
195 u32 connect_controller
;
196 u32 disconnect_controller
;
199 u32 open_protocol_information
;
200 u32 protocols_per_handle
;
201 u32 locate_handle_buffer
;
203 u32 install_multiple_protocol_interfaces
;
204 u32 uninstall_multiple_protocol_interfaces
;
209 } __packed efi_boot_services_32_t
;
226 u64 install_protocol_interface
;
227 u64 reinstall_protocol_interface
;
228 u64 uninstall_protocol_interface
;
231 u64 register_protocol_notify
;
233 u64 locate_device_path
;
234 u64 install_configuration_table
;
239 u64 exit_boot_services
;
240 u64 get_next_monotonic_count
;
242 u64 set_watchdog_timer
;
243 u64 connect_controller
;
244 u64 disconnect_controller
;
247 u64 open_protocol_information
;
248 u64 protocols_per_handle
;
249 u64 locate_handle_buffer
;
251 u64 install_multiple_protocol_interfaces
;
252 u64 uninstall_multiple_protocol_interfaces
;
257 } __packed efi_boot_services_64_t
;
260 * EFI Boot Services table
266 efi_status_t (*allocate_pages
)(int, int, unsigned long,
267 efi_physical_addr_t
*);
268 efi_status_t (*free_pages
)(efi_physical_addr_t
, unsigned long);
269 efi_status_t (*get_memory_map
)(unsigned long *, void *, unsigned long *,
270 unsigned long *, u32
*);
271 efi_status_t (*allocate_pool
)(int, unsigned long, void **);
272 efi_status_t (*free_pool
)(void *);
275 void *wait_for_event
;
279 void *install_protocol_interface
;
280 void *reinstall_protocol_interface
;
281 void *uninstall_protocol_interface
;
282 efi_status_t (*handle_protocol
)(efi_handle_t
, efi_guid_t
*, void **);
284 void *register_protocol_notify
;
286 void *locate_device_path
;
287 void *install_configuration_table
;
292 efi_status_t (*exit_boot_services
)(efi_handle_t
, unsigned long);
293 void *get_next_monotonic_count
;
295 void *set_watchdog_timer
;
296 void *connect_controller
;
297 void *disconnect_controller
;
299 void *close_protocol
;
300 void *open_protocol_information
;
301 void *protocols_per_handle
;
302 void *locate_handle_buffer
;
303 void *locate_protocol
;
304 void *install_multiple_protocol_interfaces
;
305 void *uninstall_multiple_protocol_interfaces
;
306 void *calculate_crc32
;
309 void *create_event_ex
;
310 } efi_boot_services_t
;
317 EfiPciIoWidthFifoUint8
,
318 EfiPciIoWidthFifoUint16
,
319 EfiPciIoWidthFifoUint32
,
320 EfiPciIoWidthFifoUint64
,
321 EfiPciIoWidthFillUint8
,
322 EfiPciIoWidthFillUint16
,
323 EfiPciIoWidthFillUint32
,
324 EfiPciIoWidthFillUint64
,
326 } EFI_PCI_IO_PROTOCOL_WIDTH
;
329 EfiPciIoAttributeOperationGet
,
330 EfiPciIoAttributeOperationSet
,
331 EfiPciIoAttributeOperationEnable
,
332 EfiPciIoAttributeOperationDisable
,
333 EfiPciIoAttributeOperationSupported
,
334 EfiPciIoAttributeOperationMaximum
335 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION
;
340 } efi_pci_io_protocol_access_32_t
;
345 } efi_pci_io_protocol_access_64_t
;
350 } efi_pci_io_protocol_access_t
;
355 efi_pci_io_protocol_access_32_t mem
;
356 efi_pci_io_protocol_access_32_t io
;
357 efi_pci_io_protocol_access_32_t pci
;
366 u32 get_bar_attributes
;
367 u32 set_bar_attributes
;
370 } efi_pci_io_protocol_32
;
375 efi_pci_io_protocol_access_64_t mem
;
376 efi_pci_io_protocol_access_64_t io
;
377 efi_pci_io_protocol_access_64_t pci
;
386 u64 get_bar_attributes
;
387 u64 set_bar_attributes
;
390 } efi_pci_io_protocol_64
;
395 efi_pci_io_protocol_access_t mem
;
396 efi_pci_io_protocol_access_t io
;
397 efi_pci_io_protocol_access_t pci
;
401 void *allocate_buffer
;
406 void *get_bar_attributes
;
407 void *set_bar_attributes
;
410 } efi_pci_io_protocol
;
412 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
413 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
414 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
415 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
416 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
417 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
418 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
419 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
420 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
421 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
422 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
423 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
424 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
425 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
426 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
427 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
428 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
429 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
430 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
433 * Types and defines for EFI ResetSystem
435 #define EFI_RESET_COLD 0
436 #define EFI_RESET_WARM 1
437 #define EFI_RESET_SHUTDOWN 2
440 * EFI Runtime Services table
442 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
443 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
451 u32 set_virtual_address_map
;
454 u32 get_next_variable
;
456 u32 get_next_high_mono_count
;
459 u32 query_capsule_caps
;
460 u32 query_variable_info
;
461 } efi_runtime_services_32_t
;
469 u64 set_virtual_address_map
;
472 u64 get_next_variable
;
474 u64 get_next_high_mono_count
;
477 u64 query_capsule_caps
;
478 u64 query_variable_info
;
479 } efi_runtime_services_64_t
;
485 void *get_wakeup_time
;
486 void *set_wakeup_time
;
487 void *set_virtual_address_map
;
488 void *convert_pointer
;
490 void *get_next_variable
;
492 void *get_next_high_mono_count
;
494 void *update_capsule
;
495 void *query_capsule_caps
;
496 void *query_variable_info
;
497 } efi_runtime_services_t
;
499 typedef efi_status_t
efi_get_time_t (efi_time_t
*tm
, efi_time_cap_t
*tc
);
500 typedef efi_status_t
efi_set_time_t (efi_time_t
*tm
);
501 typedef efi_status_t
efi_get_wakeup_time_t (efi_bool_t
*enabled
, efi_bool_t
*pending
,
503 typedef efi_status_t
efi_set_wakeup_time_t (efi_bool_t enabled
, efi_time_t
*tm
);
504 typedef efi_status_t
efi_get_variable_t (efi_char16_t
*name
, efi_guid_t
*vendor
, u32
*attr
,
505 unsigned long *data_size
, void *data
);
506 typedef efi_status_t
efi_get_next_variable_t (unsigned long *name_size
, efi_char16_t
*name
,
508 typedef efi_status_t
efi_set_variable_t (efi_char16_t
*name
, efi_guid_t
*vendor
,
509 u32 attr
, unsigned long data_size
,
511 typedef efi_status_t
efi_get_next_high_mono_count_t (u32
*count
);
512 typedef void efi_reset_system_t (int reset_type
, efi_status_t status
,
513 unsigned long data_size
, efi_char16_t
*data
);
514 typedef efi_status_t
efi_set_virtual_address_map_t (unsigned long memory_map_size
,
515 unsigned long descriptor_size
,
516 u32 descriptor_version
,
517 efi_memory_desc_t
*virtual_map
);
518 typedef efi_status_t
efi_query_variable_info_t(u32 attr
,
520 u64
*remaining_space
,
521 u64
*max_variable_size
);
522 typedef efi_status_t
efi_update_capsule_t(efi_capsule_header_t
**capsules
,
524 unsigned long sg_list
);
525 typedef efi_status_t
efi_query_capsule_caps_t(efi_capsule_header_t
**capsules
,
529 typedef efi_status_t
efi_query_variable_store_t(u32 attributes
,
533 void efi_native_runtime_setup(void);
536 * EFI Configuration Table and GUID definitions
539 EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
541 #define MPS_TABLE_GUID \
542 EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
544 #define ACPI_TABLE_GUID \
545 EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
547 #define ACPI_20_TABLE_GUID \
548 EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
550 #define SMBIOS_TABLE_GUID \
551 EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
553 #define SMBIOS3_TABLE_GUID \
554 EFI_GUID( 0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94 )
556 #define SAL_SYSTEM_TABLE_GUID \
557 EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
559 #define HCDP_TABLE_GUID \
560 EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
562 #define UGA_IO_PROTOCOL_GUID \
563 EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
565 #define EFI_GLOBAL_VARIABLE_GUID \
566 EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
568 #define UV_SYSTEM_TABLE_GUID \
569 EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
571 #define LINUX_EFI_CRASH_GUID \
572 EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
574 #define LOADED_IMAGE_PROTOCOL_GUID \
575 EFI_GUID( 0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
577 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
578 EFI_GUID( 0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
580 #define EFI_UGA_PROTOCOL_GUID \
581 EFI_GUID( 0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
583 #define EFI_PCI_IO_PROTOCOL_GUID \
584 EFI_GUID( 0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
586 #define EFI_FILE_INFO_ID \
587 EFI_GUID( 0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
589 #define EFI_SYSTEM_RESOURCE_TABLE_GUID \
590 EFI_GUID( 0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80 )
592 #define EFI_FILE_SYSTEM_GUID \
593 EFI_GUID( 0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
595 #define DEVICE_TREE_GUID \
596 EFI_GUID( 0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0 )
598 #define EFI_PROPERTIES_TABLE_GUID \
599 EFI_GUID( 0x880aaca3, 0x4adc, 0x4a04, 0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5 )
604 } efi_config_table_64_t
;
609 } efi_config_table_32_t
;
614 } efi_config_table_t
;
620 } efi_config_table_type_t
;
622 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
624 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
625 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
626 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
627 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
628 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
629 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
633 u64 fw_vendor
; /* physical addr of CHAR16 vendor string */
647 } efi_system_table_64_t
;
651 u32 fw_vendor
; /* physical addr of CHAR16 vendor string */
663 } efi_system_table_32_t
;
667 unsigned long fw_vendor
; /* physical addr of CHAR16 vendor string */
669 unsigned long con_in_handle
;
670 unsigned long con_in
;
671 unsigned long con_out_handle
;
672 unsigned long con_out
;
673 unsigned long stderr_handle
;
674 unsigned long stderr
;
675 efi_runtime_services_t
*runtime
;
676 efi_boot_services_t
*boottime
;
677 unsigned long nr_tables
;
678 unsigned long tables
;
679 } efi_system_table_t
;
681 struct efi_memory_map
{
682 phys_addr_t phys_map
;
686 unsigned long desc_version
;
687 unsigned long desc_size
;
690 struct efi_fdt_params
{
705 u32 load_options_size
;
708 __aligned_u64 image_size
;
709 unsigned int image_code_type
;
710 unsigned int image_data_type
;
711 unsigned long unload
;
712 } efi_loaded_image_32_t
;
721 u32 load_options_size
;
724 __aligned_u64 image_size
;
725 unsigned int image_code_type
;
726 unsigned int image_data_type
;
727 unsigned long unload
;
728 } efi_loaded_image_64_t
;
733 efi_system_table_t
*system_table
;
737 u32 load_options_size
;
740 __aligned_u64 image_size
;
741 unsigned int image_code_type
;
742 unsigned int image_data_type
;
743 unsigned long unload
;
744 } efi_loaded_image_t
;
751 efi_time_t create_time
;
752 efi_time_t last_access_time
;
753 efi_time_t modification_time
;
754 __aligned_u64 attribute
;
755 efi_char16_t filename
[1];
770 } efi_file_handle_32_t
;
784 } efi_file_handle_64_t
;
786 typedef struct _efi_file_handle
{
788 efi_status_t (*open
)(struct _efi_file_handle
*,
789 struct _efi_file_handle
**,
790 efi_char16_t
*, u64
, u64
);
791 efi_status_t (*close
)(struct _efi_file_handle
*);
793 efi_status_t (*read
)(struct _efi_file_handle
*, unsigned long *,
798 efi_status_t (*get_info
)(struct _efi_file_handle
*, efi_guid_t
*,
799 unsigned long *, void *);
804 typedef struct _efi_file_io_interface
{
806 int (*open_volume
)(struct _efi_file_io_interface
*,
807 efi_file_handle_t
**);
808 } efi_file_io_interface_t
;
810 #define EFI_FILE_MODE_READ 0x0000000000000001
811 #define EFI_FILE_MODE_WRITE 0x0000000000000002
812 #define EFI_FILE_MODE_CREATE 0x8000000000000000
817 u64 memory_protection_attribute
;
818 } efi_properties_table_t
;
820 #define EFI_PROPERTIES_TABLE_VERSION 0x00010000
821 #define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1
823 #define EFI_INVALID_TABLE_ADDR (~0UL)
826 * All runtime access to EFI goes through this structure:
829 efi_system_table_t
*systab
; /* EFI system table */
830 unsigned int runtime_version
; /* Runtime services version */
831 unsigned long mps
; /* MPS table */
832 unsigned long acpi
; /* ACPI table (IA64 ext 0.71) */
833 unsigned long acpi20
; /* ACPI table (ACPI 2.0) */
834 unsigned long smbios
; /* SMBIOS table (32 bit entry point) */
835 unsigned long smbios3
; /* SMBIOS table (64 bit entry point) */
836 unsigned long sal_systab
; /* SAL system table */
837 unsigned long boot_info
; /* boot info table */
838 unsigned long hcdp
; /* HCDP table */
839 unsigned long uga
; /* UGA table */
840 unsigned long uv_systab
; /* UV system table */
841 unsigned long fw_vendor
; /* fw_vendor */
842 unsigned long runtime
; /* runtime table */
843 unsigned long config_table
; /* config tables */
844 unsigned long esrt
; /* ESRT table */
845 unsigned long properties_table
; /* properties table */
846 efi_get_time_t
*get_time
;
847 efi_set_time_t
*set_time
;
848 efi_get_wakeup_time_t
*get_wakeup_time
;
849 efi_set_wakeup_time_t
*set_wakeup_time
;
850 efi_get_variable_t
*get_variable
;
851 efi_get_next_variable_t
*get_next_variable
;
852 efi_set_variable_t
*set_variable
;
853 efi_set_variable_t
*set_variable_nonblocking
;
854 efi_query_variable_info_t
*query_variable_info
;
855 efi_query_variable_info_t
*query_variable_info_nonblocking
;
856 efi_update_capsule_t
*update_capsule
;
857 efi_query_capsule_caps_t
*query_capsule_caps
;
858 efi_get_next_high_mono_count_t
*get_next_high_mono_count
;
859 efi_reset_system_t
*reset_system
;
860 efi_set_virtual_address_map_t
*set_virtual_address_map
;
861 struct efi_memory_map
*memmap
;
866 efi_guidcmp (efi_guid_t left
, efi_guid_t right
)
868 return memcmp(&left
, &right
, sizeof (efi_guid_t
));
872 efi_guid_to_str(efi_guid_t
*guid
, char *out
)
874 sprintf(out
, "%pUl", guid
->b
);
878 extern void efi_init (void);
879 extern void *efi_get_pal_addr (void);
880 extern void efi_map_pal_code (void);
881 extern void efi_memmap_walk (efi_freemem_callback_t callback
, void *arg
);
882 extern void efi_gettimeofday (struct timespec
*ts
);
883 extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
885 extern void efi_late_init(void);
886 extern void efi_free_boot_services(void);
887 extern efi_status_t
efi_query_variable_store(u32 attributes
,
890 extern void efi_find_mirror(void);
892 static inline void efi_late_init(void) {}
893 static inline void efi_free_boot_services(void) {}
895 static inline efi_status_t
efi_query_variable_store(u32 attributes
,
902 extern void __iomem
*efi_lookup_mapped_addr(u64 phys_addr
);
903 extern int efi_config_init(efi_config_table_type_t
*arch_tables
);
904 #ifdef CONFIG_EFI_ESRT
905 extern void __init
efi_esrt_init(void);
907 static inline void efi_esrt_init(void) { }
909 extern int efi_config_parse_tables(void *config_tables
, int count
, int sz
,
910 efi_config_table_type_t
*arch_tables
);
911 extern u64
efi_get_iobase (void);
912 extern u32
efi_mem_type (unsigned long phys_addr
);
913 extern u64
efi_mem_attributes (unsigned long phys_addr
);
914 extern u64
efi_mem_attribute (unsigned long phys_addr
, unsigned long size
);
915 extern int __init
efi_uart_console_only (void);
916 extern u64
efi_mem_desc_end(efi_memory_desc_t
*md
);
917 extern int efi_mem_desc_lookup(u64 phys_addr
, efi_memory_desc_t
*out_md
);
918 extern void efi_initialize_iomem_resources(struct resource
*code_resource
,
919 struct resource
*data_resource
, struct resource
*bss_resource
);
920 extern void efi_get_time(struct timespec
*now
);
921 extern void efi_reserve_boot_services(void);
922 extern int efi_get_fdt_params(struct efi_fdt_params
*params
);
923 extern struct efi_memory_map memmap
;
924 extern struct kobject
*efi_kobj
;
926 extern int efi_reboot_quirk_mode
;
927 extern bool efi_poweroff_required(void);
929 #ifdef CONFIG_EFI_FAKE_MEMMAP
930 extern void __init
efi_fake_memmap(void);
932 static inline void efi_fake_memmap(void) { }
935 /* Iterate through an efi_memory_map */
936 #define for_each_efi_memory_desc(m, md) \
937 for ((md) = (m)->map; \
938 (md) <= (efi_memory_desc_t *)((m)->map_end - (m)->desc_size); \
939 (md) = (void *)(md) + (m)->desc_size)
942 * Format an EFI memory descriptor's type and attributes to a user-provided
943 * character buffer, as per snprintf(), and return the buffer.
945 char * __init
efi_md_typeattr_format(char *buf
, size_t size
,
946 const efi_memory_desc_t
*md
);
949 * efi_range_is_wc - check the WC bit on an address range
950 * @start: starting kvirt address
951 * @len: length of range
953 * Consult the EFI memory map and make sure it's ok to set this range WC.
954 * Returns true or false.
956 static inline int efi_range_is_wc(unsigned long start
, unsigned long len
)
960 for (i
= 0; i
< len
; i
+= (1UL << EFI_PAGE_SHIFT
)) {
961 unsigned long paddr
= __pa(start
+ i
);
962 if (!(efi_mem_attributes(paddr
) & EFI_MEMORY_WC
))
965 /* The range checked out */
969 #ifdef CONFIG_EFI_PCDP
970 extern int __init
efi_setup_pcdp_console(char *);
974 * We play games with efi_enabled so that the compiler will, if
975 * possible, remove EFI-related code altogether.
977 #define EFI_BOOT 0 /* Were we booted from EFI? */
978 #define EFI_SYSTEM_TABLES 1 /* Can we use EFI system tables? */
979 #define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
980 #define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
981 #define EFI_MEMMAP 4 /* Can we use EFI memory map? */
982 #define EFI_64BIT 5 /* Is the firmware 64-bit? */
983 #define EFI_PARAVIRT 6 /* Access is via a paravirt interface */
984 #define EFI_ARCH_1 7 /* First arch-specific bit */
985 #define EFI_DBG 8 /* Print additional debug info at runtime */
986 #define EFI_NX_PE_DATA 9 /* Can runtime data regions be mapped non-executable? */
990 * Test whether the above EFI_* bits are enabled.
992 static inline bool efi_enabled(int feature
)
994 return test_bit(feature
, &efi
.flags
) != 0;
996 extern void efi_reboot(enum reboot_mode reboot_mode
, const char *__unused
);
998 static inline bool efi_enabled(int feature
)
1003 efi_reboot(enum reboot_mode reboot_mode
, const char *__unused
) {}
1007 * Variable Attributes
1009 #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
1010 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
1011 #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
1012 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
1013 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
1014 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
1015 #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
1017 #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
1018 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
1019 EFI_VARIABLE_RUNTIME_ACCESS | \
1020 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
1021 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
1022 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
1023 EFI_VARIABLE_APPEND_WRITE)
1025 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
1026 * not including trailing NUL
1028 #define EFI_VARIABLE_GUID_LEN 36
1031 * The type of search to perform when calling boottime->locate_handle
1033 #define EFI_LOCATE_ALL_HANDLES 0
1034 #define EFI_LOCATE_BY_REGISTER_NOTIFY 1
1035 #define EFI_LOCATE_BY_PROTOCOL 2
1038 * EFI Device Path information
1040 #define EFI_DEV_HW 0x01
1041 #define EFI_DEV_PCI 1
1042 #define EFI_DEV_PCCARD 2
1043 #define EFI_DEV_MEM_MAPPED 3
1044 #define EFI_DEV_VENDOR 4
1045 #define EFI_DEV_CONTROLLER 5
1046 #define EFI_DEV_ACPI 0x02
1047 #define EFI_DEV_BASIC_ACPI 1
1048 #define EFI_DEV_EXPANDED_ACPI 2
1049 #define EFI_DEV_MSG 0x03
1050 #define EFI_DEV_MSG_ATAPI 1
1051 #define EFI_DEV_MSG_SCSI 2
1052 #define EFI_DEV_MSG_FC 3
1053 #define EFI_DEV_MSG_1394 4
1054 #define EFI_DEV_MSG_USB 5
1055 #define EFI_DEV_MSG_USB_CLASS 15
1056 #define EFI_DEV_MSG_I20 6
1057 #define EFI_DEV_MSG_MAC 11
1058 #define EFI_DEV_MSG_IPV4 12
1059 #define EFI_DEV_MSG_IPV6 13
1060 #define EFI_DEV_MSG_INFINIBAND 9
1061 #define EFI_DEV_MSG_UART 14
1062 #define EFI_DEV_MSG_VENDOR 10
1063 #define EFI_DEV_MEDIA 0x04
1064 #define EFI_DEV_MEDIA_HARD_DRIVE 1
1065 #define EFI_DEV_MEDIA_CDROM 2
1066 #define EFI_DEV_MEDIA_VENDOR 3
1067 #define EFI_DEV_MEDIA_FILE 4
1068 #define EFI_DEV_MEDIA_PROTOCOL 5
1069 #define EFI_DEV_BIOS_BOOT 0x05
1070 #define EFI_DEV_END_PATH 0x7F
1071 #define EFI_DEV_END_PATH2 0xFF
1072 #define EFI_DEV_END_INSTANCE 0x01
1073 #define EFI_DEV_END_ENTIRE 0xFF
1075 struct efi_generic_dev_path
{
1079 } __attribute ((packed
));
1081 static inline void memrange_efi_to_native(u64
*addr
, u64
*npages
)
1083 *npages
= PFN_UP(*addr
+ (*npages
<<EFI_PAGE_SHIFT
)) - PFN_DOWN(*addr
);
1088 * EFI Variable support.
1090 * Different firmware drivers can expose their EFI-like variables using
1094 struct efivar_operations
{
1095 efi_get_variable_t
*get_variable
;
1096 efi_get_next_variable_t
*get_next_variable
;
1097 efi_set_variable_t
*set_variable
;
1098 efi_set_variable_t
*set_variable_nonblocking
;
1099 efi_query_variable_store_t
*query_variable_store
;
1104 * ->lock protects two things:
1105 * 1) efivarfs_list and efivars_sysfs_list
1110 struct kobject
*kobject
;
1111 const struct efivar_operations
*ops
;
1115 * The maximum size of VariableName + Data = 1024
1116 * Therefore, it's reasonable to save that much
1117 * space in each part of the structure,
1118 * and we use a page for reading/writing.
1121 #define EFI_VAR_NAME_LEN 1024
1123 struct efi_variable
{
1124 efi_char16_t VariableName
[EFI_VAR_NAME_LEN
/sizeof(efi_char16_t
)];
1125 efi_guid_t VendorGuid
;
1126 unsigned long DataSize
;
1128 efi_status_t Status
;
1130 } __attribute__((packed
));
1132 struct efivar_entry
{
1133 struct efi_variable var
;
1134 struct list_head list
;
1135 struct kobject kobj
;
1140 struct efi_simple_text_output_protocol_32
{
1146 struct efi_simple_text_output_protocol_64
{
1152 struct efi_simple_text_output_protocol
{
1154 efi_status_t (*output_string
)(void *, void *);
1158 extern struct list_head efivar_sysfs_list
;
1161 efivar_unregister(struct efivar_entry
*var
)
1163 kobject_put(&var
->kobj
);
1166 int efivars_register(struct efivars
*efivars
,
1167 const struct efivar_operations
*ops
,
1168 struct kobject
*kobject
);
1169 int efivars_unregister(struct efivars
*efivars
);
1170 struct kobject
*efivars_kobject(void);
1172 int efivar_init(int (*func
)(efi_char16_t
*, efi_guid_t
, unsigned long, void *),
1173 void *data
, bool atomic
, bool duplicates
,
1174 struct list_head
*head
);
1176 void efivar_entry_add(struct efivar_entry
*entry
, struct list_head
*head
);
1177 void efivar_entry_remove(struct efivar_entry
*entry
);
1179 int __efivar_entry_delete(struct efivar_entry
*entry
);
1180 int efivar_entry_delete(struct efivar_entry
*entry
);
1182 int efivar_entry_size(struct efivar_entry
*entry
, unsigned long *size
);
1183 int __efivar_entry_get(struct efivar_entry
*entry
, u32
*attributes
,
1184 unsigned long *size
, void *data
);
1185 int efivar_entry_get(struct efivar_entry
*entry
, u32
*attributes
,
1186 unsigned long *size
, void *data
);
1187 int efivar_entry_set(struct efivar_entry
*entry
, u32 attributes
,
1188 unsigned long size
, void *data
, struct list_head
*head
);
1189 int efivar_entry_set_get_size(struct efivar_entry
*entry
, u32 attributes
,
1190 unsigned long *size
, void *data
, bool *set
);
1191 int efivar_entry_set_safe(efi_char16_t
*name
, efi_guid_t vendor
, u32 attributes
,
1192 bool block
, unsigned long size
, void *data
);
1194 void efivar_entry_iter_begin(void);
1195 void efivar_entry_iter_end(void);
1197 int __efivar_entry_iter(int (*func
)(struct efivar_entry
*, void *),
1198 struct list_head
*head
, void *data
,
1199 struct efivar_entry
**prev
);
1200 int efivar_entry_iter(int (*func
)(struct efivar_entry
*, void *),
1201 struct list_head
*head
, void *data
);
1203 struct efivar_entry
*efivar_entry_find(efi_char16_t
*name
, efi_guid_t guid
,
1204 struct list_head
*head
, bool remove
);
1206 bool efivar_validate(efi_char16_t
*var_name
, u8
*data
, unsigned long len
);
1208 extern struct work_struct efivar_work
;
1209 void efivar_run_worker(void);
1211 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
1212 int efivars_sysfs_init(void);
1214 #define EFIVARS_DATA_SIZE_MAX 1024
1216 #endif /* CONFIG_EFI_VARS */
1218 #ifdef CONFIG_EFI_RUNTIME_MAP
1219 int efi_runtime_map_init(struct kobject
*);
1220 void efi_runtime_map_setup(void *, int, u32
);
1221 int efi_get_runtime_map_size(void);
1222 int efi_get_runtime_map_desc_size(void);
1223 int efi_runtime_map_copy(void *buf
, size_t bufsz
);
1225 static inline int efi_runtime_map_init(struct kobject
*kobj
)
1231 efi_runtime_map_setup(void *map
, int nr_entries
, u32 desc_size
) {}
1233 static inline int efi_get_runtime_map_size(void)
1238 static inline int efi_get_runtime_map_desc_size(void)
1243 static inline int efi_runtime_map_copy(void *buf
, size_t bufsz
)
1250 /* prototypes shared between arch specific and generic stub code */
1252 #define pr_efi(sys_table, msg) efi_printk(sys_table, "EFI stub: "msg)
1253 #define pr_efi_err(sys_table, msg) efi_printk(sys_table, "EFI stub: ERROR: "msg)
1255 void efi_printk(efi_system_table_t
*sys_table_arg
, char *str
);
1257 void efi_free(efi_system_table_t
*sys_table_arg
, unsigned long size
,
1258 unsigned long addr
);
1260 char *efi_convert_cmdline(efi_system_table_t
*sys_table_arg
,
1261 efi_loaded_image_t
*image
, int *cmd_line_len
);
1263 efi_status_t
efi_get_memory_map(efi_system_table_t
*sys_table_arg
,
1264 efi_memory_desc_t
**map
,
1265 unsigned long *map_size
,
1266 unsigned long *desc_size
,
1268 unsigned long *key_ptr
);
1270 efi_status_t
efi_low_alloc(efi_system_table_t
*sys_table_arg
,
1271 unsigned long size
, unsigned long align
,
1272 unsigned long *addr
);
1274 efi_status_t
efi_high_alloc(efi_system_table_t
*sys_table_arg
,
1275 unsigned long size
, unsigned long align
,
1276 unsigned long *addr
, unsigned long max
);
1278 efi_status_t
efi_relocate_kernel(efi_system_table_t
*sys_table_arg
,
1279 unsigned long *image_addr
,
1280 unsigned long image_size
,
1281 unsigned long alloc_size
,
1282 unsigned long preferred_addr
,
1283 unsigned long alignment
);
1285 efi_status_t
handle_cmdline_files(efi_system_table_t
*sys_table_arg
,
1286 efi_loaded_image_t
*image
,
1287 char *cmd_line
, char *option_string
,
1288 unsigned long max_addr
,
1289 unsigned long *load_addr
,
1290 unsigned long *load_size
);
1292 efi_status_t
efi_parse_options(char *cmdline
);
1294 bool efi_runtime_disabled(void);
1295 #endif /* _LINUX_EFI_H */