2 * efi.c - EFI subsystem
4 * Copyright (C) 2001,2003,2004 Dell <Matt_Domsch@dell.com>
5 * Copyright (C) 2004 Intel Corporation <matthew.e.tolentino@intel.com>
6 * Copyright (C) 2013 Tom Gundersen <teg@jklm.no>
8 * This code registers /sys/firmware/efi{,/efivars} when EFI is supported,
9 * allowing the efivarfs to be mounted or the efivars module to be loaded.
10 * The existance of /sys/firmware/efi may also be used by userspace to
11 * determine that the system supports EFI.
13 * This file is released under the GPLv2.
16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18 #include <linux/kobject.h>
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/device.h>
22 #include <linux/efi.h>
24 #include <linux/of_fdt.h>
26 #include <linux/platform_device.h>
28 struct efi __read_mostly efi = {
29 .mps = EFI_INVALID_TABLE_ADDR,
30 .acpi = EFI_INVALID_TABLE_ADDR,
31 .acpi20 = EFI_INVALID_TABLE_ADDR,
32 .smbios = EFI_INVALID_TABLE_ADDR,
33 .smbios3 = EFI_INVALID_TABLE_ADDR,
34 .sal_systab = EFI_INVALID_TABLE_ADDR,
35 .boot_info = EFI_INVALID_TABLE_ADDR,
36 .hcdp = EFI_INVALID_TABLE_ADDR,
37 .uga = EFI_INVALID_TABLE_ADDR,
38 .uv_systab = EFI_INVALID_TABLE_ADDR,
39 .fw_vendor = EFI_INVALID_TABLE_ADDR,
40 .runtime = EFI_INVALID_TABLE_ADDR,
41 .config_table = EFI_INVALID_TABLE_ADDR,
42 .esrt = EFI_INVALID_TABLE_ADDR,
46 static bool disable_runtime;
47 static int __init setup_noefi(char *arg)
49 disable_runtime = true;
52 early_param("noefi", setup_noefi);
54 bool efi_runtime_disabled(void)
56 return disable_runtime;
59 static int __init parse_efi_cmdline(char *str)
61 if (parse_option_str(str, "noruntime"))
62 disable_runtime = true;
66 early_param("efi", parse_efi_cmdline);
68 struct kobject *efi_kobj;
69 static struct kobject *efivars_kobj;
72 * Let's not leave out systab information that snuck into
75 static ssize_t systab_show(struct kobject *kobj,
76 struct kobj_attribute *attr, char *buf)
83 if (efi.mps != EFI_INVALID_TABLE_ADDR)
84 str += sprintf(str, "MPS=0x%lx\n", efi.mps);
85 if (efi.acpi20 != EFI_INVALID_TABLE_ADDR)
86 str += sprintf(str, "ACPI20=0x%lx\n", efi.acpi20);
87 if (efi.acpi != EFI_INVALID_TABLE_ADDR)
88 str += sprintf(str, "ACPI=0x%lx\n", efi.acpi);
90 * If both SMBIOS and SMBIOS3 entry points are implemented, the
91 * SMBIOS3 entry point shall be preferred, so we list it first to
92 * let applications stop parsing after the first match.
94 if (efi.smbios3 != EFI_INVALID_TABLE_ADDR)
95 str += sprintf(str, "SMBIOS3=0x%lx\n", efi.smbios3);
96 if (efi.smbios != EFI_INVALID_TABLE_ADDR)
97 str += sprintf(str, "SMBIOS=0x%lx\n", efi.smbios);
98 if (efi.hcdp != EFI_INVALID_TABLE_ADDR)
99 str += sprintf(str, "HCDP=0x%lx\n", efi.hcdp);
100 if (efi.boot_info != EFI_INVALID_TABLE_ADDR)
101 str += sprintf(str, "BOOTINFO=0x%lx\n", efi.boot_info);
102 if (efi.uga != EFI_INVALID_TABLE_ADDR)
103 str += sprintf(str, "UGA=0x%lx\n", efi.uga);
108 static struct kobj_attribute efi_attr_systab =
109 __ATTR(systab, 0400, systab_show, NULL);
111 #define EFI_FIELD(var) efi.var
113 #define EFI_ATTR_SHOW(name) \
114 static ssize_t name##_show(struct kobject *kobj, \
115 struct kobj_attribute *attr, char *buf) \
117 return sprintf(buf, "0x%lx\n", EFI_FIELD(name)); \
120 EFI_ATTR_SHOW(fw_vendor);
121 EFI_ATTR_SHOW(runtime);
122 EFI_ATTR_SHOW(config_table);
124 static ssize_t fw_platform_size_show(struct kobject *kobj,
125 struct kobj_attribute *attr, char *buf)
127 return sprintf(buf, "%d\n", efi_enabled(EFI_64BIT) ? 64 : 32);
130 static struct kobj_attribute efi_attr_fw_vendor = __ATTR_RO(fw_vendor);
131 static struct kobj_attribute efi_attr_runtime = __ATTR_RO(runtime);
132 static struct kobj_attribute efi_attr_config_table = __ATTR_RO(config_table);
133 static struct kobj_attribute efi_attr_fw_platform_size =
134 __ATTR_RO(fw_platform_size);
136 static struct attribute *efi_subsys_attrs[] = {
137 &efi_attr_systab.attr,
138 &efi_attr_fw_vendor.attr,
139 &efi_attr_runtime.attr,
140 &efi_attr_config_table.attr,
141 &efi_attr_fw_platform_size.attr,
145 static umode_t efi_attr_is_visible(struct kobject *kobj,
146 struct attribute *attr, int n)
148 if (attr == &efi_attr_fw_vendor.attr) {
149 if (efi_enabled(EFI_PARAVIRT) ||
150 efi.fw_vendor == EFI_INVALID_TABLE_ADDR)
152 } else if (attr == &efi_attr_runtime.attr) {
153 if (efi.runtime == EFI_INVALID_TABLE_ADDR)
155 } else if (attr == &efi_attr_config_table.attr) {
156 if (efi.config_table == EFI_INVALID_TABLE_ADDR)
163 static struct attribute_group efi_subsys_attr_group = {
164 .attrs = efi_subsys_attrs,
165 .is_visible = efi_attr_is_visible,
168 static struct efivars generic_efivars;
169 static struct efivar_operations generic_ops;
171 static int generic_ops_register(void)
173 generic_ops.get_variable = efi.get_variable;
174 generic_ops.set_variable = efi.set_variable;
175 generic_ops.get_next_variable = efi.get_next_variable;
176 generic_ops.query_variable_store = efi_query_variable_store;
178 return efivars_register(&generic_efivars, &generic_ops, efi_kobj);
181 static void generic_ops_unregister(void)
183 efivars_unregister(&generic_efivars);
187 * We register the efi subsystem with the firmware subsystem and the
188 * efivars subsystem with the efi subsystem, if the system was booted with
191 static int __init efisubsys_init(void)
195 if (!efi_enabled(EFI_BOOT))
198 /* We register the efi directory at /sys/firmware/efi */
199 efi_kobj = kobject_create_and_add("efi", firmware_kobj);
201 pr_err("efi: Firmware registration failed.\n");
205 error = generic_ops_register();
209 error = sysfs_create_group(efi_kobj, &efi_subsys_attr_group);
211 pr_err("efi: Sysfs attribute export failed with error %d.\n",
216 error = efi_runtime_map_init(efi_kobj);
218 goto err_remove_group;
220 /* and the standard mountpoint for efivarfs */
221 efivars_kobj = kobject_create_and_add("efivars", efi_kobj);
223 pr_err("efivars: Subsystem registration failed.\n");
225 goto err_remove_group;
231 sysfs_remove_group(efi_kobj, &efi_subsys_attr_group);
233 generic_ops_unregister();
235 kobject_put(efi_kobj);
239 subsys_initcall(efisubsys_init);
242 * Find the efi memory descriptor for a given physical address. Given a
243 * physicall address, determine if it exists within an EFI Memory Map entry,
244 * and if so, populate the supplied memory descriptor with the appropriate
247 int __init efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md)
249 struct efi_memory_map *map = efi.memmap;
252 if (!efi_enabled(EFI_MEMMAP)) {
253 pr_err_once("EFI_MEMMAP is not enabled.\n");
258 pr_err_once("efi.memmap is not set.\n");
262 pr_err_once("out_md is null.\n");
265 if (WARN_ON_ONCE(!map->phys_map))
267 if (WARN_ON_ONCE(map->nr_map == 0) || WARN_ON_ONCE(map->desc_size == 0))
270 e = map->phys_map + map->nr_map * map->desc_size;
271 for (p = map->phys_map; p < e; p += map->desc_size) {
272 efi_memory_desc_t *md;
277 * If a driver calls this after efi_free_boot_services,
278 * ->map will be NULL, and the target may also not be mapped.
279 * So just always get our own virtual map on the CPU.
282 md = early_memremap((phys_addr_t)p, sizeof (*md));
284 pr_err_once("early_memremap(%p, %zu) failed.\n",
289 if (!(md->attribute & EFI_MEMORY_RUNTIME) &&
290 md->type != EFI_BOOT_SERVICES_DATA &&
291 md->type != EFI_RUNTIME_SERVICES_DATA) {
292 early_memunmap(md, sizeof (*md));
296 size = md->num_pages << EFI_PAGE_SHIFT;
297 end = md->phys_addr + size;
298 if (phys_addr >= md->phys_addr && phys_addr < end) {
299 memcpy(out_md, md, sizeof(*out_md));
300 early_memunmap(md, sizeof (*md));
304 early_memunmap(md, sizeof (*md));
306 pr_err_once("requested map not found.\n");
311 * Calculate the highest address of an efi memory descriptor.
313 u64 __init efi_mem_desc_end(efi_memory_desc_t *md)
315 u64 size = md->num_pages << EFI_PAGE_SHIFT;
316 u64 end = md->phys_addr + size;
321 * We can't ioremap data in EFI boot services RAM, because we've already mapped
322 * it as RAM. So, look it up in the existing EFI memory map instead. Only
323 * callable after efi_enter_virtual_mode and before efi_free_boot_services.
325 void __iomem *efi_lookup_mapped_addr(u64 phys_addr)
327 struct efi_memory_map *map;
332 if (WARN_ON(!map->map))
334 for (p = map->map; p < map->map_end; p += map->desc_size) {
335 efi_memory_desc_t *md = p;
336 u64 size = md->num_pages << EFI_PAGE_SHIFT;
337 u64 end = md->phys_addr + size;
338 if (!(md->attribute & EFI_MEMORY_RUNTIME) &&
339 md->type != EFI_BOOT_SERVICES_CODE &&
340 md->type != EFI_BOOT_SERVICES_DATA)
344 if (phys_addr >= md->phys_addr && phys_addr < end) {
345 phys_addr += md->virt_addr - md->phys_addr;
346 return (__force void __iomem *)(unsigned long)phys_addr;
352 static __initdata efi_config_table_type_t common_tables[] = {
353 {ACPI_20_TABLE_GUID, "ACPI 2.0", &efi.acpi20},
354 {ACPI_TABLE_GUID, "ACPI", &efi.acpi},
355 {HCDP_TABLE_GUID, "HCDP", &efi.hcdp},
356 {MPS_TABLE_GUID, "MPS", &efi.mps},
357 {SAL_SYSTEM_TABLE_GUID, "SALsystab", &efi.sal_systab},
358 {SMBIOS_TABLE_GUID, "SMBIOS", &efi.smbios},
359 {SMBIOS3_TABLE_GUID, "SMBIOS 3.0", &efi.smbios3},
360 {UGA_IO_PROTOCOL_GUID, "UGA", &efi.uga},
361 {EFI_SYSTEM_RESOURCE_TABLE_GUID, "ESRT", &efi.esrt},
362 {NULL_GUID, NULL, NULL},
365 static __init int match_config_table(efi_guid_t *guid,
367 efi_config_table_type_t *table_types)
372 for (i = 0; efi_guidcmp(table_types[i].guid, NULL_GUID); i++) {
373 if (!efi_guidcmp(*guid, table_types[i].guid)) {
374 *(table_types[i].ptr) = table;
375 pr_cont(" %s=0x%lx ",
376 table_types[i].name, table);
385 int __init efi_config_parse_tables(void *config_tables, int count, int sz,
386 efi_config_table_type_t *arch_tables)
391 tablep = config_tables;
393 for (i = 0; i < count; i++) {
397 if (efi_enabled(EFI_64BIT)) {
399 guid = ((efi_config_table_64_t *)tablep)->guid;
400 table64 = ((efi_config_table_64_t *)tablep)->table;
405 pr_err("Table located above 4GB, disabling EFI.\n");
410 guid = ((efi_config_table_32_t *)tablep)->guid;
411 table = ((efi_config_table_32_t *)tablep)->table;
414 if (!match_config_table(&guid, table, common_tables))
415 match_config_table(&guid, table, arch_tables);
420 set_bit(EFI_CONFIG_TABLES, &efi.flags);
424 int __init efi_config_init(efi_config_table_type_t *arch_tables)
429 if (efi_enabled(EFI_64BIT))
430 sz = sizeof(efi_config_table_64_t);
432 sz = sizeof(efi_config_table_32_t);
435 * Let's see what config tables the firmware passed to us.
437 config_tables = early_memremap(efi.systab->tables,
438 efi.systab->nr_tables * sz);
439 if (config_tables == NULL) {
440 pr_err("Could not map Configuration table!\n");
444 ret = efi_config_parse_tables(config_tables, efi.systab->nr_tables, sz,
447 early_memunmap(config_tables, efi.systab->nr_tables * sz);
451 #ifdef CONFIG_EFI_VARS_MODULE
452 static int __init efi_load_efivars(void)
454 struct platform_device *pdev;
456 if (!efi_enabled(EFI_RUNTIME_SERVICES))
459 pdev = platform_device_register_simple("efivars", 0, NULL, 0);
460 return IS_ERR(pdev) ? PTR_ERR(pdev) : 0;
462 device_initcall(efi_load_efivars);
465 #ifdef CONFIG_EFI_PARAMS_FROM_FDT
467 #define UEFI_PARAM(name, prop, field) \
471 offsetof(struct efi_fdt_params, field), \
472 FIELD_SIZEOF(struct efi_fdt_params, field) \
475 static __initdata struct {
477 const char propname[32];
481 UEFI_PARAM("System Table", "linux,uefi-system-table", system_table),
482 UEFI_PARAM("MemMap Address", "linux,uefi-mmap-start", mmap),
483 UEFI_PARAM("MemMap Size", "linux,uefi-mmap-size", mmap_size),
484 UEFI_PARAM("MemMap Desc. Size", "linux,uefi-mmap-desc-size", desc_size),
485 UEFI_PARAM("MemMap Desc. Version", "linux,uefi-mmap-desc-ver", desc_ver)
494 static int __init fdt_find_uefi_params(unsigned long node, const char *uname,
495 int depth, void *data)
497 struct param_info *info = data;
503 if (depth != 1 || strcmp(uname, "chosen") != 0)
506 for (i = 0; i < ARRAY_SIZE(dt_params); i++) {
507 prop = of_get_flat_dt_prop(node, dt_params[i].propname, &len);
510 dest = info->params + dt_params[i].offset;
513 val = of_read_number(prop, len / sizeof(u32));
515 if (dt_params[i].size == sizeof(u32))
521 pr_info(" %s: 0x%0*llx\n", dt_params[i].name,
522 dt_params[i].size * 2, val);
527 int __init efi_get_fdt_params(struct efi_fdt_params *params, int verbose)
529 struct param_info info;
532 pr_info("Getting EFI parameters from FDT:\n");
534 info.verbose = verbose;
536 info.params = params;
538 ret = of_scan_flat_dt(fdt_find_uefi_params, &info);
540 pr_info("UEFI not found.\n");
542 pr_err("Can't find '%s' in device tree!\n",
543 dt_params[info.found].name);
547 #endif /* CONFIG_EFI_PARAMS_FROM_FDT */
549 static __initdata char memory_type_name[][20] = {
557 "Conventional Memory",
559 "ACPI Reclaim Memory",
566 char * __init efi_md_typeattr_format(char *buf, size_t size,
567 const efi_memory_desc_t *md)
574 if (md->type >= ARRAY_SIZE(memory_type_name))
575 type_len = snprintf(pos, size, "[type=%u", md->type);
577 type_len = snprintf(pos, size, "[%-*s",
578 (int)(sizeof(memory_type_name[0]) - 1),
579 memory_type_name[md->type]);
580 if (type_len >= size)
586 attr = md->attribute;
587 if (attr & ~(EFI_MEMORY_UC | EFI_MEMORY_WC | EFI_MEMORY_WT |
588 EFI_MEMORY_WB | EFI_MEMORY_UCE | EFI_MEMORY_WP |
589 EFI_MEMORY_RP | EFI_MEMORY_XP | EFI_MEMORY_RUNTIME))
590 snprintf(pos, size, "|attr=0x%016llx]",
591 (unsigned long long)attr);
593 snprintf(pos, size, "|%3s|%2s|%2s|%2s|%3s|%2s|%2s|%2s|%2s]",
594 attr & EFI_MEMORY_RUNTIME ? "RUN" : "",
595 attr & EFI_MEMORY_XP ? "XP" : "",
596 attr & EFI_MEMORY_RP ? "RP" : "",
597 attr & EFI_MEMORY_WP ? "WP" : "",
598 attr & EFI_MEMORY_UCE ? "UCE" : "",
599 attr & EFI_MEMORY_WB ? "WB" : "",
600 attr & EFI_MEMORY_WT ? "WT" : "",
601 attr & EFI_MEMORY_WC ? "WC" : "",
602 attr & EFI_MEMORY_UC ? "UC" : "");