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_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 */
49 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
51 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
52 (b) & 0xff, ((b) >> 8) & 0xff, \
53 (c) & 0xff, ((c) >> 8) & 0xff, \
54 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
57 * Generic EFI table header
68 * Memory map descriptor:
72 #define EFI_RESERVED_TYPE 0
73 #define EFI_LOADER_CODE 1
74 #define EFI_LOADER_DATA 2
75 #define EFI_BOOT_SERVICES_CODE 3
76 #define EFI_BOOT_SERVICES_DATA 4
77 #define EFI_RUNTIME_SERVICES_CODE 5
78 #define EFI_RUNTIME_SERVICES_DATA 6
79 #define EFI_CONVENTIONAL_MEMORY 7
80 #define EFI_UNUSABLE_MEMORY 8
81 #define EFI_ACPI_RECLAIM_MEMORY 9
82 #define EFI_ACPI_MEMORY_NVS 10
83 #define EFI_MEMORY_MAPPED_IO 11
84 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
85 #define EFI_PAL_CODE 13
86 #define EFI_MAX_MEMORY_TYPE 14
88 /* Attribute values: */
89 #define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
90 #define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
91 #define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
92 #define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
93 #define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
94 #define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
95 #define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
96 #define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
97 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
99 #define EFI_PAGE_SHIFT 12
115 } efi_capsule_header_t;
117 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
120 * Types and defines for Time Services
122 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
123 #define EFI_TIME_IN_DAYLIGHT 0x2
124 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
147 * Types and defines for EFI ResetSystem
149 #define EFI_RESET_COLD 0
150 #define EFI_RESET_WARM 1
151 #define EFI_RESET_SHUTDOWN 2
154 * EFI Runtime Services table
156 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
157 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
161 unsigned long get_time;
162 unsigned long set_time;
163 unsigned long get_wakeup_time;
164 unsigned long set_wakeup_time;
165 unsigned long set_virtual_address_map;
166 unsigned long convert_pointer;
167 unsigned long get_variable;
168 unsigned long get_next_variable;
169 unsigned long set_variable;
170 unsigned long get_next_high_mono_count;
171 unsigned long reset_system;
172 unsigned long update_capsule;
173 unsigned long query_capsule_caps;
174 unsigned long query_variable_info;
175 } efi_runtime_services_t;
177 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
178 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
179 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
181 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
182 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
183 unsigned long *data_size, void *data);
184 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
186 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
187 u32 attr, unsigned long data_size,
189 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
190 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
191 unsigned long data_size, efi_char16_t *data);
192 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
193 unsigned long descriptor_size,
194 u32 descriptor_version,
195 efi_memory_desc_t *virtual_map);
196 typedef efi_status_t efi_query_variable_info_t(u32 attr,
198 u64 *remaining_space,
199 u64 *max_variable_size);
200 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
202 unsigned long sg_list);
203 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
207 typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
210 * EFI Configuration Table and GUID definitions
213 EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
215 #define MPS_TABLE_GUID \
216 EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
218 #define ACPI_TABLE_GUID \
219 EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
221 #define ACPI_20_TABLE_GUID \
222 EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
224 #define SMBIOS_TABLE_GUID \
225 EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
227 #define SAL_SYSTEM_TABLE_GUID \
228 EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
230 #define HCDP_TABLE_GUID \
231 EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
233 #define UGA_IO_PROTOCOL_GUID \
234 EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
236 #define EFI_GLOBAL_VARIABLE_GUID \
237 EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
239 #define UV_SYSTEM_TABLE_GUID \
240 EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
242 #define LINUX_EFI_CRASH_GUID \
243 EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
248 } efi_config_table_t;
250 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
252 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
253 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
254 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
255 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
256 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
257 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
261 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
263 unsigned long con_in_handle;
264 unsigned long con_in;
265 unsigned long con_out_handle;
266 unsigned long con_out;
267 unsigned long stderr_handle;
268 unsigned long stderr;
269 efi_runtime_services_t *runtime;
270 unsigned long boottime;
271 unsigned long nr_tables;
272 unsigned long tables;
273 } efi_system_table_t;
275 struct efi_memory_map {
280 unsigned long desc_version;
281 unsigned long desc_size;
284 #define EFI_INVALID_TABLE_ADDR (~0UL)
287 * All runtime access to EFI goes through this structure:
290 efi_system_table_t *systab; /* EFI system table */
291 unsigned int runtime_version; /* Runtime services version */
292 unsigned long mps; /* MPS table */
293 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
294 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
295 unsigned long smbios; /* SM BIOS table */
296 unsigned long sal_systab; /* SAL system table */
297 unsigned long boot_info; /* boot info table */
298 unsigned long hcdp; /* HCDP table */
299 unsigned long uga; /* UGA table */
300 unsigned long uv_systab; /* UV system table */
301 efi_get_time_t *get_time;
302 efi_set_time_t *set_time;
303 efi_get_wakeup_time_t *get_wakeup_time;
304 efi_set_wakeup_time_t *set_wakeup_time;
305 efi_get_variable_t *get_variable;
306 efi_get_next_variable_t *get_next_variable;
307 efi_set_variable_t *set_variable;
308 efi_query_variable_info_t *query_variable_info;
309 efi_update_capsule_t *update_capsule;
310 efi_query_capsule_caps_t *query_capsule_caps;
311 efi_get_next_high_mono_count_t *get_next_high_mono_count;
312 efi_reset_system_t *reset_system;
313 efi_set_virtual_address_map_t *set_virtual_address_map;
317 efi_guidcmp (efi_guid_t left, efi_guid_t right)
319 return memcmp(&left, &right, sizeof (efi_guid_t));
323 efi_guid_unparse(efi_guid_t *guid, char *out)
325 sprintf(out, "%pUl", guid->b);
329 extern void efi_init (void);
330 extern void *efi_get_pal_addr (void);
331 extern void efi_map_pal_code (void);
332 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
333 extern void efi_gettimeofday (struct timespec *ts);
334 extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
336 extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
338 static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
343 extern u64 efi_get_iobase (void);
344 extern u32 efi_mem_type (unsigned long phys_addr);
345 extern u64 efi_mem_attributes (unsigned long phys_addr);
346 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
347 extern int __init efi_uart_console_only (void);
348 extern void efi_initialize_iomem_resources(struct resource *code_resource,
349 struct resource *data_resource, struct resource *bss_resource);
350 extern unsigned long efi_get_time(void);
351 extern int efi_set_rtc_mmss(unsigned long nowtime);
352 extern void efi_reserve_boot_services(void);
353 extern struct efi_memory_map memmap;
356 * efi_range_is_wc - check the WC bit on an address range
357 * @start: starting kvirt address
358 * @len: length of range
360 * Consult the EFI memory map and make sure it's ok to set this range WC.
361 * Returns true or false.
363 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
367 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
368 unsigned long paddr = __pa(start + i);
369 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
372 /* The range checked out */
376 #ifdef CONFIG_EFI_PCDP
377 extern int __init efi_setup_pcdp_console(char *);
381 * We play games with efi_enabled so that the compiler will, if
382 * possible, remove EFI-related code altogether.
384 #define EFI_BOOT 0 /* Were we booted from EFI? */
385 #define EFI_SYSTEM_TABLES 1 /* Can we use EFI system tables? */
386 #define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
387 #define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
388 #define EFI_MEMMAP 4 /* Can we use EFI memory map? */
389 #define EFI_64BIT 5 /* Is the firmware 64-bit? */
393 extern int efi_enabled(int facility);
395 static inline int efi_enabled(int facility)
401 static inline int efi_enabled(int facility)
408 * Variable Attributes
410 #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
411 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
412 #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
413 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
414 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
415 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
416 #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
418 #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
419 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
420 EFI_VARIABLE_RUNTIME_ACCESS | \
421 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
422 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
423 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
424 EFI_VARIABLE_APPEND_WRITE)
426 * EFI Device Path information
428 #define EFI_DEV_HW 0x01
429 #define EFI_DEV_PCI 1
430 #define EFI_DEV_PCCARD 2
431 #define EFI_DEV_MEM_MAPPED 3
432 #define EFI_DEV_VENDOR 4
433 #define EFI_DEV_CONTROLLER 5
434 #define EFI_DEV_ACPI 0x02
435 #define EFI_DEV_BASIC_ACPI 1
436 #define EFI_DEV_EXPANDED_ACPI 2
437 #define EFI_DEV_MSG 0x03
438 #define EFI_DEV_MSG_ATAPI 1
439 #define EFI_DEV_MSG_SCSI 2
440 #define EFI_DEV_MSG_FC 3
441 #define EFI_DEV_MSG_1394 4
442 #define EFI_DEV_MSG_USB 5
443 #define EFI_DEV_MSG_USB_CLASS 15
444 #define EFI_DEV_MSG_I20 6
445 #define EFI_DEV_MSG_MAC 11
446 #define EFI_DEV_MSG_IPV4 12
447 #define EFI_DEV_MSG_IPV6 13
448 #define EFI_DEV_MSG_INFINIBAND 9
449 #define EFI_DEV_MSG_UART 14
450 #define EFI_DEV_MSG_VENDOR 10
451 #define EFI_DEV_MEDIA 0x04
452 #define EFI_DEV_MEDIA_HARD_DRIVE 1
453 #define EFI_DEV_MEDIA_CDROM 2
454 #define EFI_DEV_MEDIA_VENDOR 3
455 #define EFI_DEV_MEDIA_FILE 4
456 #define EFI_DEV_MEDIA_PROTOCOL 5
457 #define EFI_DEV_BIOS_BOOT 0x05
458 #define EFI_DEV_END_PATH 0x7F
459 #define EFI_DEV_END_PATH2 0xFF
460 #define EFI_DEV_END_INSTANCE 0x01
461 #define EFI_DEV_END_ENTIRE 0xFF
463 struct efi_generic_dev_path {
467 } __attribute ((packed));
469 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
471 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
475 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
477 * EFI Variable support.
479 * Different firmware drivers can expose their EFI-like variables using
483 struct efivar_operations {
484 efi_get_variable_t *get_variable;
485 efi_get_next_variable_t *get_next_variable;
486 efi_set_variable_t *set_variable;
487 efi_query_variable_store_t *query_variable_store;
492 * ->lock protects two things:
493 * 1) ->list - adds, removals, reads, writes
494 * 2) ops.[gs]et_variable() calls.
495 * It must not be held when creating sysfs entries or calling kmalloc.
496 * ops.get_next_variable() is only called from register_efivars()
497 * or efivar_update_sysfs_entries(),
498 * which is protected by the BKL, so that path is safe.
501 struct list_head list;
503 struct bin_attribute *new_var, *del_var;
504 const struct efivar_operations *ops;
505 struct efivar_entry *walk_entry;
506 struct pstore_info efi_pstore_info;
509 int register_efivars(struct efivars *efivars,
510 const struct efivar_operations *ops,
511 struct kobject *parent_kobj);
512 void unregister_efivars(struct efivars *efivars);
514 #endif /* CONFIG_EFI_VARS */
516 #endif /* _LINUX_EFI_H */