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 )
304 } efi_config_table_t;
306 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
308 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
309 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
310 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
311 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
312 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
313 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
317 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
319 unsigned long con_in_handle;
320 unsigned long con_in;
321 unsigned long con_out_handle;
322 unsigned long con_out;
323 unsigned long stderr_handle;
324 unsigned long stderr;
325 efi_runtime_services_t *runtime;
326 efi_boot_services_t *boottime;
327 unsigned long nr_tables;
328 unsigned long tables;
329 } efi_system_table_t;
331 struct efi_memory_map {
336 unsigned long desc_version;
337 unsigned long desc_size;
343 efi_system_table_t *system_table;
347 u32 load_options_size;
350 __aligned_u64 image_size;
351 unsigned int image_code_type;
352 unsigned int image_data_type;
353 unsigned long unload;
354 } efi_loaded_image_t;
356 #define EFI_INVALID_TABLE_ADDR (~0UL)
359 * All runtime access to EFI goes through this structure:
362 efi_system_table_t *systab; /* EFI system table */
363 unsigned int runtime_version; /* Runtime services version */
364 unsigned long mps; /* MPS table */
365 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
366 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
367 unsigned long smbios; /* SM BIOS table */
368 unsigned long sal_systab; /* SAL system table */
369 unsigned long boot_info; /* boot info table */
370 unsigned long hcdp; /* HCDP table */
371 unsigned long uga; /* UGA table */
372 unsigned long uv_systab; /* UV system table */
373 efi_get_time_t *get_time;
374 efi_set_time_t *set_time;
375 efi_get_wakeup_time_t *get_wakeup_time;
376 efi_set_wakeup_time_t *set_wakeup_time;
377 efi_get_variable_t *get_variable;
378 efi_get_next_variable_t *get_next_variable;
379 efi_set_variable_t *set_variable;
380 efi_query_variable_info_t *query_variable_info;
381 efi_update_capsule_t *update_capsule;
382 efi_query_capsule_caps_t *query_capsule_caps;
383 efi_get_next_high_mono_count_t *get_next_high_mono_count;
384 efi_reset_system_t *reset_system;
385 efi_set_virtual_address_map_t *set_virtual_address_map;
389 efi_guidcmp (efi_guid_t left, efi_guid_t right)
391 return memcmp(&left, &right, sizeof (efi_guid_t));
395 efi_guid_unparse(efi_guid_t *guid, char *out)
397 sprintf(out, "%pUl", guid->b);
401 extern void efi_init (void);
402 extern void *efi_get_pal_addr (void);
403 extern void efi_map_pal_code (void);
404 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
405 extern void efi_gettimeofday (struct timespec *ts);
406 extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
407 extern u64 efi_get_iobase (void);
408 extern u32 efi_mem_type (unsigned long phys_addr);
409 extern u64 efi_mem_attributes (unsigned long phys_addr);
410 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
411 extern int __init efi_uart_console_only (void);
412 extern void efi_initialize_iomem_resources(struct resource *code_resource,
413 struct resource *data_resource, struct resource *bss_resource);
414 extern unsigned long efi_get_time(void);
415 extern int efi_set_rtc_mmss(unsigned long nowtime);
416 extern void efi_reserve_boot_services(void);
417 extern struct efi_memory_map memmap;
420 * efi_range_is_wc - check the WC bit on an address range
421 * @start: starting kvirt address
422 * @len: length of range
424 * Consult the EFI memory map and make sure it's ok to set this range WC.
425 * Returns true or false.
427 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
431 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
432 unsigned long paddr = __pa(start + i);
433 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
436 /* The range checked out */
440 #ifdef CONFIG_EFI_PCDP
441 extern int __init efi_setup_pcdp_console(char *);
445 * We play games with efi_enabled so that the compiler will, if possible, remove
446 * EFI-related code altogether.
450 extern int efi_enabled;
452 # define efi_enabled 1
455 # define efi_enabled 0
459 * Variable Attributes
461 #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
462 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
463 #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
466 * EFI Device Path information
468 #define EFI_DEV_HW 0x01
469 #define EFI_DEV_PCI 1
470 #define EFI_DEV_PCCARD 2
471 #define EFI_DEV_MEM_MAPPED 3
472 #define EFI_DEV_VENDOR 4
473 #define EFI_DEV_CONTROLLER 5
474 #define EFI_DEV_ACPI 0x02
475 #define EFI_DEV_BASIC_ACPI 1
476 #define EFI_DEV_EXPANDED_ACPI 2
477 #define EFI_DEV_MSG 0x03
478 #define EFI_DEV_MSG_ATAPI 1
479 #define EFI_DEV_MSG_SCSI 2
480 #define EFI_DEV_MSG_FC 3
481 #define EFI_DEV_MSG_1394 4
482 #define EFI_DEV_MSG_USB 5
483 #define EFI_DEV_MSG_USB_CLASS 15
484 #define EFI_DEV_MSG_I20 6
485 #define EFI_DEV_MSG_MAC 11
486 #define EFI_DEV_MSG_IPV4 12
487 #define EFI_DEV_MSG_IPV6 13
488 #define EFI_DEV_MSG_INFINIBAND 9
489 #define EFI_DEV_MSG_UART 14
490 #define EFI_DEV_MSG_VENDOR 10
491 #define EFI_DEV_MEDIA 0x04
492 #define EFI_DEV_MEDIA_HARD_DRIVE 1
493 #define EFI_DEV_MEDIA_CDROM 2
494 #define EFI_DEV_MEDIA_VENDOR 3
495 #define EFI_DEV_MEDIA_FILE 4
496 #define EFI_DEV_MEDIA_PROTOCOL 5
497 #define EFI_DEV_BIOS_BOOT 0x05
498 #define EFI_DEV_END_PATH 0x7F
499 #define EFI_DEV_END_PATH2 0xFF
500 #define EFI_DEV_END_INSTANCE 0x01
501 #define EFI_DEV_END_ENTIRE 0xFF
503 struct efi_generic_dev_path {
507 } __attribute ((packed));
509 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
511 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
515 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
517 * EFI Variable support.
519 * Different firmware drivers can expose their EFI-like variables using
523 struct efivar_operations {
524 efi_get_variable_t *get_variable;
525 efi_get_next_variable_t *get_next_variable;
526 efi_set_variable_t *set_variable;
531 * ->lock protects two things:
532 * 1) ->list - adds, removals, reads, writes
533 * 2) ops.[gs]et_variable() calls.
534 * It must not be held when creating sysfs entries or calling kmalloc.
535 * ops.get_next_variable() is only called from register_efivars(),
536 * which is protected by the BKL, so that path is safe.
539 struct list_head list;
541 struct bin_attribute *new_var, *del_var;
542 const struct efivar_operations *ops;
543 struct efivar_entry *walk_entry;
544 struct pstore_info efi_pstore_info;
547 int register_efivars(struct efivars *efivars,
548 const struct efivar_operations *ops,
549 struct kobject *parent_kobj);
550 void unregister_efivars(struct efivars *efivars);
552 #endif /* CONFIG_EFI_VARS */
554 #endif /* _LINUX_EFI_H */