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>
25 #include <asm/system.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_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
35 typedef unsigned long efi_status_t
;
36 typedef u8 efi_bool_t
;
37 typedef u16 efi_char16_t
; /* UNICODE character */
44 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
46 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
47 (b) & 0xff, ((b) >> 8) & 0xff, \
48 (c) & 0xff, ((c) >> 8) & 0xff, \
49 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
52 * Generic EFI table header
63 * Memory map descriptor:
67 #define EFI_RESERVED_TYPE 0
68 #define EFI_LOADER_CODE 1
69 #define EFI_LOADER_DATA 2
70 #define EFI_BOOT_SERVICES_CODE 3
71 #define EFI_BOOT_SERVICES_DATA 4
72 #define EFI_RUNTIME_SERVICES_CODE 5
73 #define EFI_RUNTIME_SERVICES_DATA 6
74 #define EFI_CONVENTIONAL_MEMORY 7
75 #define EFI_UNUSABLE_MEMORY 8
76 #define EFI_ACPI_RECLAIM_MEMORY 9
77 #define EFI_ACPI_MEMORY_NVS 10
78 #define EFI_MEMORY_MAPPED_IO 11
79 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
80 #define EFI_PAL_CODE 13
81 #define EFI_MAX_MEMORY_TYPE 14
83 /* Attribute values: */
84 #define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
85 #define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
86 #define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
87 #define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
88 #define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
89 #define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
90 #define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
91 #define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
92 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
94 #define EFI_PAGE_SHIFT 12
110 } efi_capsule_header_t
;
113 * Allocation types for calls to boottime->allocate_pages.
115 #define EFI_ALLOCATE_ANY_PAGES 0
116 #define EFI_ALLOCATE_MAX_ADDRESS 1
117 #define EFI_ALLOCATE_ADDRESS 2
118 #define EFI_MAX_ALLOCATE_TYPE 3
120 typedef int (*efi_freemem_callback_t
) (u64 start
, u64 end
, void *arg
);
123 * Types and defines for Time Services
125 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
126 #define EFI_TIME_IN_DAYLIGHT 0x2
127 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
150 * EFI Boot Services table
156 void *allocate_pages
;
158 void *get_memory_map
;
163 void *wait_for_event
;
167 void *install_protocol_interface
;
168 void *reinstall_protocol_interface
;
169 void *uninstall_protocol_interface
;
170 void *handle_protocol
;
172 void *register_protocol_notify
;
174 void *locate_device_path
;
175 void *install_configuration_table
;
180 void *exit_boot_services
;
181 void *get_next_monotonic_count
;
183 void *set_watchdog_timer
;
184 void *connect_controller
;
185 void *disconnect_controller
;
187 void *close_protocol
;
188 void *open_protocol_information
;
189 void *protocols_per_handle
;
190 void *locate_handle_buffer
;
191 void *locate_protocol
;
192 void *install_multiple_protocol_interfaces
;
193 void *uninstall_multiple_protocol_interfaces
;
194 void *calculate_crc32
;
197 void *create_event_ex
;
198 } efi_boot_services_t
;
201 * Types and defines for EFI ResetSystem
203 #define EFI_RESET_COLD 0
204 #define EFI_RESET_WARM 1
205 #define EFI_RESET_SHUTDOWN 2
208 * EFI Runtime Services table
210 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
211 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
215 unsigned long get_time
;
216 unsigned long set_time
;
217 unsigned long get_wakeup_time
;
218 unsigned long set_wakeup_time
;
219 unsigned long set_virtual_address_map
;
220 unsigned long convert_pointer
;
221 unsigned long get_variable
;
222 unsigned long get_next_variable
;
223 unsigned long set_variable
;
224 unsigned long get_next_high_mono_count
;
225 unsigned long reset_system
;
226 unsigned long update_capsule
;
227 unsigned long query_capsule_caps
;
228 unsigned long query_variable_info
;
229 } efi_runtime_services_t
;
231 typedef efi_status_t
efi_get_time_t (efi_time_t
*tm
, efi_time_cap_t
*tc
);
232 typedef efi_status_t
efi_set_time_t (efi_time_t
*tm
);
233 typedef efi_status_t
efi_get_wakeup_time_t (efi_bool_t
*enabled
, efi_bool_t
*pending
,
235 typedef efi_status_t
efi_set_wakeup_time_t (efi_bool_t enabled
, efi_time_t
*tm
);
236 typedef efi_status_t
efi_get_variable_t (efi_char16_t
*name
, efi_guid_t
*vendor
, u32
*attr
,
237 unsigned long *data_size
, void *data
);
238 typedef efi_status_t
efi_get_next_variable_t (unsigned long *name_size
, efi_char16_t
*name
,
240 typedef efi_status_t
efi_set_variable_t (efi_char16_t
*name
, efi_guid_t
*vendor
,
241 u32 attr
, unsigned long data_size
,
243 typedef efi_status_t
efi_get_next_high_mono_count_t (u32
*count
);
244 typedef void efi_reset_system_t (int reset_type
, efi_status_t status
,
245 unsigned long data_size
, efi_char16_t
*data
);
246 typedef efi_status_t
efi_set_virtual_address_map_t (unsigned long memory_map_size
,
247 unsigned long descriptor_size
,
248 u32 descriptor_version
,
249 efi_memory_desc_t
*virtual_map
);
250 typedef efi_status_t
efi_query_variable_info_t(u32 attr
,
252 u64
*remaining_space
,
253 u64
*max_variable_size
);
254 typedef efi_status_t
efi_update_capsule_t(efi_capsule_header_t
**capsules
,
256 unsigned long sg_list
);
257 typedef efi_status_t
efi_query_capsule_caps_t(efi_capsule_header_t
**capsules
,
263 * EFI Configuration Table and GUID definitions
266 EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
268 #define MPS_TABLE_GUID \
269 EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
271 #define ACPI_TABLE_GUID \
272 EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
274 #define ACPI_20_TABLE_GUID \
275 EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
277 #define SMBIOS_TABLE_GUID \
278 EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
280 #define SAL_SYSTEM_TABLE_GUID \
281 EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
283 #define HCDP_TABLE_GUID \
284 EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
286 #define UGA_IO_PROTOCOL_GUID \
287 EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
289 #define EFI_GLOBAL_VARIABLE_GUID \
290 EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
292 #define UV_SYSTEM_TABLE_GUID \
293 EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
295 #define LINUX_EFI_CRASH_GUID \
296 EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
298 #define LOADED_IMAGE_PROTOCOL_GUID \
299 EFI_GUID( 0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
301 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
302 EFI_GUID( 0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
304 #define EFI_UGA_PROTOCOL_GUID \
305 EFI_GUID( 0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
307 #define EFI_PCI_IO_PROTOCOL_GUID \
308 EFI_GUID( 0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
310 #define EFI_FILE_INFO_ID \
311 EFI_GUID( 0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
313 #define EFI_FILE_SYSTEM_GUID \
314 EFI_GUID( 0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
319 } efi_config_table_t
;
321 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
323 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
324 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
325 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
326 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
327 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
328 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
332 unsigned long fw_vendor
; /* physical addr of CHAR16 vendor string */
334 unsigned long con_in_handle
;
335 unsigned long con_in
;
336 unsigned long con_out_handle
;
337 unsigned long con_out
;
338 unsigned long stderr_handle
;
339 unsigned long stderr
;
340 efi_runtime_services_t
*runtime
;
341 efi_boot_services_t
*boottime
;
342 unsigned long nr_tables
;
343 unsigned long tables
;
344 } efi_system_table_t
;
346 struct efi_memory_map
{
351 unsigned long desc_version
;
352 unsigned long desc_size
;
358 efi_system_table_t
*system_table
;
362 u32 load_options_size
;
365 __aligned_u64 image_size
;
366 unsigned int image_code_type
;
367 unsigned int image_data_type
;
368 unsigned long unload
;
369 } efi_loaded_image_t
;
374 } efi_file_io_interface_t
;
380 efi_time_t create_time
;
381 efi_time_t last_access_time
;
382 efi_time_t modification_time
;
383 __aligned_u64 attribute
;
384 efi_char16_t filename
[1];
401 #define EFI_FILE_MODE_READ 0x0000000000000001
402 #define EFI_FILE_MODE_WRITE 0x0000000000000002
403 #define EFI_FILE_MODE_CREATE 0x8000000000000000
405 #define EFI_INVALID_TABLE_ADDR (~0UL)
408 * All runtime access to EFI goes through this structure:
411 efi_system_table_t
*systab
; /* EFI system table */
412 unsigned int runtime_version
; /* Runtime services version */
413 unsigned long mps
; /* MPS table */
414 unsigned long acpi
; /* ACPI table (IA64 ext 0.71) */
415 unsigned long acpi20
; /* ACPI table (ACPI 2.0) */
416 unsigned long smbios
; /* SM BIOS table */
417 unsigned long sal_systab
; /* SAL system table */
418 unsigned long boot_info
; /* boot info table */
419 unsigned long hcdp
; /* HCDP table */
420 unsigned long uga
; /* UGA table */
421 unsigned long uv_systab
; /* UV system table */
422 efi_get_time_t
*get_time
;
423 efi_set_time_t
*set_time
;
424 efi_get_wakeup_time_t
*get_wakeup_time
;
425 efi_set_wakeup_time_t
*set_wakeup_time
;
426 efi_get_variable_t
*get_variable
;
427 efi_get_next_variable_t
*get_next_variable
;
428 efi_set_variable_t
*set_variable
;
429 efi_query_variable_info_t
*query_variable_info
;
430 efi_update_capsule_t
*update_capsule
;
431 efi_query_capsule_caps_t
*query_capsule_caps
;
432 efi_get_next_high_mono_count_t
*get_next_high_mono_count
;
433 efi_reset_system_t
*reset_system
;
434 efi_set_virtual_address_map_t
*set_virtual_address_map
;
438 efi_guidcmp (efi_guid_t left
, efi_guid_t right
)
440 return memcmp(&left
, &right
, sizeof (efi_guid_t
));
444 efi_guid_unparse(efi_guid_t
*guid
, char *out
)
446 sprintf(out
, "%pUl", guid
->b
);
450 extern void efi_init (void);
451 extern void *efi_get_pal_addr (void);
452 extern void efi_map_pal_code (void);
453 extern void efi_memmap_walk (efi_freemem_callback_t callback
, void *arg
);
454 extern void efi_gettimeofday (struct timespec
*ts
);
455 extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
456 extern u64
efi_get_iobase (void);
457 extern u32
efi_mem_type (unsigned long phys_addr
);
458 extern u64
efi_mem_attributes (unsigned long phys_addr
);
459 extern u64
efi_mem_attribute (unsigned long phys_addr
, unsigned long size
);
460 extern int __init
efi_uart_console_only (void);
461 extern void efi_initialize_iomem_resources(struct resource
*code_resource
,
462 struct resource
*data_resource
, struct resource
*bss_resource
);
463 extern unsigned long efi_get_time(void);
464 extern int efi_set_rtc_mmss(unsigned long nowtime
);
465 extern void efi_reserve_boot_services(void);
466 extern struct efi_memory_map memmap
;
469 * efi_range_is_wc - check the WC bit on an address range
470 * @start: starting kvirt address
471 * @len: length of range
473 * Consult the EFI memory map and make sure it's ok to set this range WC.
474 * Returns true or false.
476 static inline int efi_range_is_wc(unsigned long start
, unsigned long len
)
480 for (i
= 0; i
< len
; i
+= (1UL << EFI_PAGE_SHIFT
)) {
481 unsigned long paddr
= __pa(start
+ i
);
482 if (!(efi_mem_attributes(paddr
) & EFI_MEMORY_WC
))
485 /* The range checked out */
489 #ifdef CONFIG_EFI_PCDP
490 extern int __init
efi_setup_pcdp_console(char *);
494 * We play games with efi_enabled so that the compiler will, if possible, remove
495 * EFI-related code altogether.
499 extern int efi_enabled
;
501 # define efi_enabled 1
504 # define efi_enabled 0
508 * Variable Attributes
510 #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
511 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
512 #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
513 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
514 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
515 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
516 #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
518 #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
519 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
520 EFI_VARIABLE_RUNTIME_ACCESS | \
521 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
522 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
523 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
524 EFI_VARIABLE_APPEND_WRITE)
526 * The type of search to perform when calling boottime->locate_handle
528 #define EFI_LOCATE_ALL_HANDLES 0
529 #define EFI_LOCATE_BY_REGISTER_NOTIFY 1
530 #define EFI_LOCATE_BY_PROTOCOL 2
533 * EFI Device Path information
535 #define EFI_DEV_HW 0x01
536 #define EFI_DEV_PCI 1
537 #define EFI_DEV_PCCARD 2
538 #define EFI_DEV_MEM_MAPPED 3
539 #define EFI_DEV_VENDOR 4
540 #define EFI_DEV_CONTROLLER 5
541 #define EFI_DEV_ACPI 0x02
542 #define EFI_DEV_BASIC_ACPI 1
543 #define EFI_DEV_EXPANDED_ACPI 2
544 #define EFI_DEV_MSG 0x03
545 #define EFI_DEV_MSG_ATAPI 1
546 #define EFI_DEV_MSG_SCSI 2
547 #define EFI_DEV_MSG_FC 3
548 #define EFI_DEV_MSG_1394 4
549 #define EFI_DEV_MSG_USB 5
550 #define EFI_DEV_MSG_USB_CLASS 15
551 #define EFI_DEV_MSG_I20 6
552 #define EFI_DEV_MSG_MAC 11
553 #define EFI_DEV_MSG_IPV4 12
554 #define EFI_DEV_MSG_IPV6 13
555 #define EFI_DEV_MSG_INFINIBAND 9
556 #define EFI_DEV_MSG_UART 14
557 #define EFI_DEV_MSG_VENDOR 10
558 #define EFI_DEV_MEDIA 0x04
559 #define EFI_DEV_MEDIA_HARD_DRIVE 1
560 #define EFI_DEV_MEDIA_CDROM 2
561 #define EFI_DEV_MEDIA_VENDOR 3
562 #define EFI_DEV_MEDIA_FILE 4
563 #define EFI_DEV_MEDIA_PROTOCOL 5
564 #define EFI_DEV_BIOS_BOOT 0x05
565 #define EFI_DEV_END_PATH 0x7F
566 #define EFI_DEV_END_PATH2 0xFF
567 #define EFI_DEV_END_INSTANCE 0x01
568 #define EFI_DEV_END_ENTIRE 0xFF
570 struct efi_generic_dev_path
{
574 } __attribute ((packed
));
576 static inline void memrange_efi_to_native(u64
*addr
, u64
*npages
)
578 *npages
= PFN_UP(*addr
+ (*npages
<<EFI_PAGE_SHIFT
)) - PFN_DOWN(*addr
);
582 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
584 * EFI Variable support.
586 * Different firmware drivers can expose their EFI-like variables using
590 struct efivar_operations
{
591 efi_get_variable_t
*get_variable
;
592 efi_get_next_variable_t
*get_next_variable
;
593 efi_set_variable_t
*set_variable
;
598 * ->lock protects two things:
599 * 1) ->list - adds, removals, reads, writes
600 * 2) ops.[gs]et_variable() calls.
601 * It must not be held when creating sysfs entries or calling kmalloc.
602 * ops.get_next_variable() is only called from register_efivars(),
603 * which is protected by the BKL, so that path is safe.
606 struct list_head list
;
608 struct bin_attribute
*new_var
, *del_var
;
609 const struct efivar_operations
*ops
;
610 struct efivar_entry
*walk_entry
;
611 struct pstore_info efi_pstore_info
;
614 int register_efivars(struct efivars
*efivars
,
615 const struct efivar_operations
*ops
,
616 struct kobject
*parent_kobj
);
617 void unregister_efivars(struct efivars
*efivars
);
619 #endif /* CONFIG_EFI_VARS */
621 #endif /* _LINUX_EFI_H */