2 * EFI Variables - efivars.c
4 * Copyright (C) 2001,2003,2004 Dell <Matt_Domsch@dell.com>
5 * Copyright (C) 2004 Intel Corporation <matthew.e.tolentino@intel.com>
7 * This code takes all variables accessible from EFI runtime and
8 * exports them via sysfs
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 * 17 May 2004 - Matt Domsch <Matt_Domsch@dell.com>
27 * remove check for efi_enabled in exit
30 * 26 Apr 2004 - Matt Domsch <Matt_Domsch@dell.com>
33 * 21 Apr 2004 - Matt Tolentino <matthew.e.tolentino@intel.com)
34 * converted driver to export variable information via sysfs
35 * and moved to drivers/firmware directory
36 * bumped revision number to v0.07 to reflect conversion & move
38 * 10 Dec 2002 - Matt Domsch <Matt_Domsch@dell.com>
39 * fix locking per Peter Chubb's findings
41 * 25 Mar 2002 - Matt Domsch <Matt_Domsch@dell.com>
42 * move uuid_unparse() to include/asm-ia64/efi.h:efi_guid_unparse()
44 * 12 Feb 2002 - Matt Domsch <Matt_Domsch@dell.com>
45 * use list_for_each_safe when deleting vars.
46 * remove ifdef CONFIG_SMP around include <linux/smp.h>
47 * v0.04 release to linux-ia64@linuxia64.org
49 * 20 April 2001 - Matt Domsch <Matt_Domsch@dell.com>
50 * Moved vars from /proc/efi to /proc/efi/vars, and made
51 * efi.c own the /proc/efi directory.
52 * v0.03 release to linux-ia64@linuxia64.org
54 * 26 March 2001 - Matt Domsch <Matt_Domsch@dell.com>
55 * At the request of Stephane, moved ownership of /proc/efi
56 * to efi.c, and now efivars lives under /proc/efi/vars.
58 * 12 March 2001 - Matt Domsch <Matt_Domsch@dell.com>
59 * Feedback received from Stephane Eranian incorporated.
60 * efivar_write() checks copy_from_user() return value.
61 * efivar_read/write() returns proper errno.
62 * v0.02 release to linux-ia64@linuxia64.org
64 * 26 February 2001 - Matt Domsch <Matt_Domsch@dell.com>
65 * v0.01 release to linux-ia64@linuxia64.org
68 #include <linux/config.h>
69 #include <linux/types.h>
70 #include <linux/errno.h>
71 #include <linux/init.h>
72 #include <linux/sched.h> /* for capable() */
74 #include <linux/module.h>
75 #include <linux/string.h>
76 #include <linux/smp.h>
77 #include <linux/efi.h>
78 #include <linux/sysfs.h>
79 #include <linux/kobject.h>
80 #include <linux/device.h>
82 #include <asm/uaccess.h>
84 #define EFIVARS_VERSION "0.08"
85 #define EFIVARS_DATE "2004-May-17"
87 MODULE_AUTHOR("Matt Domsch <Matt_Domsch@Dell.com>");
88 MODULE_DESCRIPTION("sysfs interface to EFI Variables");
89 MODULE_LICENSE("GPL");
90 MODULE_VERSION(EFIVARS_VERSION);
93 * efivars_lock protects two things:
94 * 1) efivar_list - adds, removals, reads, writes
95 * 2) efi.[gs]et_variable() calls.
96 * It must not be held when creating sysfs entries or calling kmalloc.
97 * efi.get_next_variable() is only called from efivars_init(),
98 * which is protected by the BKL, so that path is safe.
100 static DEFINE_SPINLOCK(efivars_lock);
101 static LIST_HEAD(efivar_list);
104 * The maximum size of VariableName + Data = 1024
105 * Therefore, it's reasonable to save that much
106 * space in each part of the structure,
107 * and we use a page for reading/writing.
110 struct efi_variable {
111 efi_char16_t VariableName[1024/sizeof(efi_char16_t)];
112 efi_guid_t VendorGuid;
113 unsigned long DataSize;
117 } __attribute__((packed));
120 struct efivar_entry {
121 struct efi_variable var;
122 struct list_head list;
126 #define get_efivar_entry(n) list_entry(n, struct efivar_entry, list)
128 struct efivar_attribute {
129 struct attribute attr;
130 ssize_t (*show) (struct efivar_entry *entry, char *buf);
131 ssize_t (*store)(struct efivar_entry *entry, const char *buf, size_t count);
135 #define EFI_ATTR(_name, _mode, _show, _store) \
136 struct subsys_attribute efi_attr_##_name = { \
137 .attr = {.name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE}, \
142 #define EFIVAR_ATTR(_name, _mode, _show, _store) \
143 struct efivar_attribute efivar_attr_##_name = { \
144 .attr = {.name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE}, \
149 #define VAR_SUBSYS_ATTR(_name, _mode, _show, _store) \
150 struct subsys_attribute var_subsys_attr_##_name = { \
151 .attr = {.name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE}, \
156 #define to_efivar_attr(_attr) container_of(_attr, struct efivar_attribute, attr)
157 #define to_efivar_entry(obj) container_of(obj, struct efivar_entry, kobj)
160 * Prototype for sysfs creation function
163 efivar_create_sysfs_entry(unsigned long variable_name_size,
164 efi_char16_t *variable_name,
165 efi_guid_t *vendor_guid);
167 /* Return the number of unicode characters in data */
169 utf8_strlen(efi_char16_t *data, unsigned long maxlength)
171 unsigned long length = 0;
173 while (*data++ != 0 && length < maxlength)
179 * Return the number of bytes is the length of this string
180 * Note: this is NOT the same as the number of unicode characters
182 static inline unsigned long
183 utf8_strsize(efi_char16_t *data, unsigned long maxlength)
185 return utf8_strlen(data, maxlength/sizeof(efi_char16_t)) * sizeof(efi_char16_t);
189 get_var_data(struct efi_variable *var)
193 spin_lock(&efivars_lock);
194 var->DataSize = 1024;
195 status = efi.get_variable(var->VariableName,
200 spin_unlock(&efivars_lock);
201 if (status != EFI_SUCCESS) {
202 printk(KERN_WARNING "efivars: get_variable() failed 0x%lx!\n",
209 efivar_guid_read(struct efivar_entry *entry, char *buf)
211 struct efi_variable *var = &entry->var;
217 efi_guid_unparse(&var->VendorGuid, str);
219 str += sprintf(str, "\n");
225 efivar_attr_read(struct efivar_entry *entry, char *buf)
227 struct efi_variable *var = &entry->var;
234 status = get_var_data(var);
235 if (status != EFI_SUCCESS)
238 if (var->Attributes & 0x1)
239 str += sprintf(str, "EFI_VARIABLE_NON_VOLATILE\n");
240 if (var->Attributes & 0x2)
241 str += sprintf(str, "EFI_VARIABLE_BOOTSERVICE_ACCESS\n");
242 if (var->Attributes & 0x4)
243 str += sprintf(str, "EFI_VARIABLE_RUNTIME_ACCESS\n");
248 efivar_size_read(struct efivar_entry *entry, char *buf)
250 struct efi_variable *var = &entry->var;
257 status = get_var_data(var);
258 if (status != EFI_SUCCESS)
261 str += sprintf(str, "0x%lx\n", var->DataSize);
266 efivar_data_read(struct efivar_entry *entry, char *buf)
268 struct efi_variable *var = &entry->var;
274 status = get_var_data(var);
275 if (status != EFI_SUCCESS)
278 memcpy(buf, var->Data, var->DataSize);
279 return var->DataSize;
282 * We allow each variable to be edited via rewriting the
283 * entire efi variable structure.
286 efivar_store_raw(struct efivar_entry *entry, const char *buf, size_t count)
288 struct efi_variable *new_var, *var = &entry->var;
289 efi_status_t status = EFI_NOT_FOUND;
291 if (count != sizeof(struct efi_variable))
294 new_var = (struct efi_variable *)buf;
296 * If only updating the variable data, then the name
297 * and guid should remain the same
299 if (memcmp(new_var->VariableName, var->VariableName, sizeof(var->VariableName)) ||
300 efi_guidcmp(new_var->VendorGuid, var->VendorGuid)) {
301 printk(KERN_ERR "efivars: Cannot edit the wrong variable!\n");
305 if ((new_var->DataSize <= 0) || (new_var->Attributes == 0)){
306 printk(KERN_ERR "efivars: DataSize & Attributes must be valid!\n");
310 spin_lock(&efivars_lock);
311 status = efi.set_variable(new_var->VariableName,
312 &new_var->VendorGuid,
317 spin_unlock(&efivars_lock);
319 if (status != EFI_SUCCESS) {
320 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
325 memcpy(&entry->var, new_var, count);
330 efivar_show_raw(struct efivar_entry *entry, char *buf)
332 struct efi_variable *var = &entry->var;
338 status = get_var_data(var);
339 if (status != EFI_SUCCESS)
342 memcpy(buf, var, sizeof(*var));
347 * Generic read/write functions that call the specific functions of
350 static ssize_t efivar_attr_show(struct kobject *kobj, struct attribute *attr,
353 struct efivar_entry *var = to_efivar_entry(kobj);
354 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
357 if (!capable(CAP_SYS_ADMIN))
360 if (efivar_attr->show) {
361 ret = efivar_attr->show(var, buf);
366 static ssize_t efivar_attr_store(struct kobject *kobj, struct attribute *attr,
367 const char *buf, size_t count)
369 struct efivar_entry *var = to_efivar_entry(kobj);
370 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
373 if (!capable(CAP_SYS_ADMIN))
376 if (efivar_attr->store)
377 ret = efivar_attr->store(var, buf, count);
382 static struct sysfs_ops efivar_attr_ops = {
383 .show = efivar_attr_show,
384 .store = efivar_attr_store,
387 static void efivar_release(struct kobject *kobj)
389 struct efivar_entry *var = container_of(kobj, struct efivar_entry, kobj);
390 spin_lock(&efivars_lock);
391 list_del(&var->list);
392 spin_unlock(&efivars_lock);
396 static EFIVAR_ATTR(guid, 0400, efivar_guid_read, NULL);
397 static EFIVAR_ATTR(attributes, 0400, efivar_attr_read, NULL);
398 static EFIVAR_ATTR(size, 0400, efivar_size_read, NULL);
399 static EFIVAR_ATTR(data, 0400, efivar_data_read, NULL);
400 static EFIVAR_ATTR(raw_var, 0600, efivar_show_raw, efivar_store_raw);
402 static struct attribute *def_attrs[] = {
403 &efivar_attr_guid.attr,
404 &efivar_attr_size.attr,
405 &efivar_attr_attributes.attr,
406 &efivar_attr_data.attr,
407 &efivar_attr_raw_var.attr,
411 static struct kobj_type ktype_efivar = {
412 .release = efivar_release,
413 .sysfs_ops = &efivar_attr_ops,
414 .default_attrs = def_attrs,
418 dummy(struct subsystem *sub, char *buf)
424 efivar_unregister(struct efivar_entry *var)
426 kobject_unregister(&var->kobj);
431 efivar_create(struct subsystem *sub, const char *buf, size_t count)
433 struct efi_variable *new_var = (struct efi_variable *)buf;
434 struct efivar_entry *search_efivar = NULL;
435 unsigned long strsize1, strsize2;
436 struct list_head *pos, *n;
437 efi_status_t status = EFI_NOT_FOUND;
440 if (!capable(CAP_SYS_ADMIN))
443 spin_lock(&efivars_lock);
446 * Does this variable already exist?
448 list_for_each_safe(pos, n, &efivar_list) {
449 search_efivar = get_efivar_entry(pos);
450 strsize1 = utf8_strsize(search_efivar->var.VariableName, 1024);
451 strsize2 = utf8_strsize(new_var->VariableName, 1024);
452 if (strsize1 == strsize2 &&
453 !memcmp(&(search_efivar->var.VariableName),
454 new_var->VariableName, strsize1) &&
455 !efi_guidcmp(search_efivar->var.VendorGuid,
456 new_var->VendorGuid)) {
462 spin_unlock(&efivars_lock);
466 /* now *really* create the variable via EFI */
467 status = efi.set_variable(new_var->VariableName,
468 &new_var->VendorGuid,
473 if (status != EFI_SUCCESS) {
474 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
476 spin_unlock(&efivars_lock);
479 spin_unlock(&efivars_lock);
481 /* Create the entry in sysfs. Locking is not required here */
482 status = efivar_create_sysfs_entry(utf8_strsize(new_var->VariableName,
483 1024), new_var->VariableName, &new_var->VendorGuid);
485 printk(KERN_WARNING "efivars: variable created, but sysfs entry wasn't.\n");
491 efivar_delete(struct subsystem *sub, const char *buf, size_t count)
493 struct efi_variable *del_var = (struct efi_variable *)buf;
494 struct efivar_entry *search_efivar = NULL;
495 unsigned long strsize1, strsize2;
496 struct list_head *pos, *n;
497 efi_status_t status = EFI_NOT_FOUND;
500 if (!capable(CAP_SYS_ADMIN))
503 spin_lock(&efivars_lock);
506 * Does this variable already exist?
508 list_for_each_safe(pos, n, &efivar_list) {
509 search_efivar = get_efivar_entry(pos);
510 strsize1 = utf8_strsize(search_efivar->var.VariableName, 1024);
511 strsize2 = utf8_strsize(del_var->VariableName, 1024);
512 if (strsize1 == strsize2 &&
513 !memcmp(&(search_efivar->var.VariableName),
514 del_var->VariableName, strsize1) &&
515 !efi_guidcmp(search_efivar->var.VendorGuid,
516 del_var->VendorGuid)) {
522 spin_unlock(&efivars_lock);
525 /* force the Attributes/DataSize to 0 to ensure deletion */
526 del_var->Attributes = 0;
527 del_var->DataSize = 0;
529 status = efi.set_variable(del_var->VariableName,
530 &del_var->VendorGuid,
535 if (status != EFI_SUCCESS) {
536 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
538 spin_unlock(&efivars_lock);
541 /* We need to release this lock before unregistering. */
542 spin_unlock(&efivars_lock);
544 efivar_unregister(search_efivar);
546 /* It's dead Jim.... */
550 static VAR_SUBSYS_ATTR(new_var, 0200, dummy, efivar_create);
551 static VAR_SUBSYS_ATTR(del_var, 0200, dummy, efivar_delete);
553 static struct subsys_attribute *var_subsys_attrs[] = {
554 &var_subsys_attr_new_var,
555 &var_subsys_attr_del_var,
560 * Let's not leave out systab information that snuck into
564 systab_read(struct subsystem *entry, char *buf)
572 str += sprintf(str, "MPS=0x%lx\n", __pa(efi.mps));
574 str += sprintf(str, "ACPI20=0x%lx\n", __pa(efi.acpi20));
576 str += sprintf(str, "ACPI=0x%lx\n", __pa(efi.acpi));
578 str += sprintf(str, "SMBIOS=0x%lx\n", __pa(efi.smbios));
580 str += sprintf(str, "HCDP=0x%lx\n", __pa(efi.hcdp));
582 str += sprintf(str, "BOOTINFO=0x%lx\n", __pa(efi.boot_info));
584 str += sprintf(str, "UGA=0x%lx\n", __pa(efi.uga));
589 static EFI_ATTR(systab, 0400, systab_read, NULL);
591 static struct subsys_attribute *efi_subsys_attrs[] = {
593 NULL, /* maybe more in the future? */
596 static decl_subsys(vars, &ktype_efivar, NULL);
597 static decl_subsys(efi, NULL, NULL);
600 * efivar_create_sysfs_entry()
602 * variable_name_size = number of bytes required to hold
603 * variable_name (not counting the NULL
604 * character at the end.
605 * efivars_lock is not held on entry or exit.
606 * Returns 1 on failure, 0 on success
609 efivar_create_sysfs_entry(unsigned long variable_name_size,
610 efi_char16_t *variable_name,
611 efi_guid_t *vendor_guid)
613 int i, short_name_size = variable_name_size / sizeof(efi_char16_t) + 38;
615 struct efivar_entry *new_efivar;
617 short_name = kmalloc(short_name_size + 1, GFP_KERNEL);
618 new_efivar = kmalloc(sizeof(struct efivar_entry), GFP_KERNEL);
620 if (!short_name || !new_efivar) {
621 if (short_name) kfree(short_name);
622 if (new_efivar) kfree(new_efivar);
625 memset(short_name, 0, short_name_size+1);
626 memset(new_efivar, 0, sizeof(struct efivar_entry));
628 memcpy(new_efivar->var.VariableName, variable_name,
630 memcpy(&(new_efivar->var.VendorGuid), vendor_guid, sizeof(efi_guid_t));
632 /* Convert Unicode to normal chars (assume top bits are 0),
634 for (i=0; i < (int)(variable_name_size / sizeof(efi_char16_t)); i++) {
635 short_name[i] = variable_name[i] & 0xFF;
637 /* This is ugly, but necessary to separate one vendor's
638 private variables from another's. */
640 *(short_name + strlen(short_name)) = '-';
641 efi_guid_unparse(vendor_guid, short_name + strlen(short_name));
643 kobject_set_name(&new_efivar->kobj, "%s", short_name);
644 kobj_set_kset_s(new_efivar, vars_subsys);
645 kobject_register(&new_efivar->kobj);
647 kfree(short_name); short_name = NULL;
649 spin_lock(&efivars_lock);
650 list_add(&new_efivar->list, &efivar_list);
651 spin_unlock(&efivars_lock);
656 * For now we register the efi subsystem with the firmware subsystem
657 * and the vars subsystem with the efi subsystem. In the future, it
658 * might make sense to split off the efi subsystem into its own
659 * driver, but for now only efivars will register with it, so just
666 efi_status_t status = EFI_NOT_FOUND;
667 efi_guid_t vendor_guid;
668 efi_char16_t *variable_name;
669 struct subsys_attribute *attr;
670 unsigned long variable_name_size = 1024;
676 variable_name = kmalloc(variable_name_size, GFP_KERNEL);
677 if (!variable_name) {
678 printk(KERN_ERR "efivars: Memory allocation failed.\n");
682 memset(variable_name, 0, variable_name_size);
684 printk(KERN_INFO "EFI Variables Facility v%s %s\n", EFIVARS_VERSION,
688 * For now we'll register the efi subsys within this driver
691 error = firmware_register(&efi_subsys);
694 printk(KERN_ERR "efivars: Firmware registration failed with error %d.\n", error);
698 kset_set_kset_s(&vars_subsys, efi_subsys);
700 error = subsystem_register(&vars_subsys);
703 printk(KERN_ERR "efivars: Subsystem registration failed with error %d.\n", error);
704 goto out_firmware_unregister;
708 * Per EFI spec, the maximum storage allocated for both
709 * the variable name and variable data is 1024 bytes.
713 variable_name_size = 1024;
715 status = efi.get_next_variable(&variable_name_size,
720 efivar_create_sysfs_entry(variable_name_size,
727 printk(KERN_WARNING "efivars: get_next_variable: status=%lx\n",
729 status = EFI_NOT_FOUND;
732 } while (status != EFI_NOT_FOUND);
735 * Now add attributes to allow creation of new vars
736 * and deletion of existing ones...
739 for (i = 0; (attr = var_subsys_attrs[i]) && !error; i++) {
740 if (attr->show && attr->store)
741 error = subsys_create_file(&vars_subsys, attr);
744 /* Don't forget the systab entry */
746 for (i = 0; (attr = efi_subsys_attrs[i]) && !error; i++) {
748 error = subsys_create_file(&efi_subsys, attr);
752 printk(KERN_ERR "efivars: Sysfs attribute export failed with error %d.\n", error);
756 subsystem_unregister(&vars_subsys);
758 out_firmware_unregister:
759 firmware_unregister(&efi_subsys);
762 kfree(variable_name);
770 struct list_head *pos, *n;
772 list_for_each_safe(pos, n, &efivar_list)
773 efivar_unregister(get_efivar_entry(pos));
775 subsystem_unregister(&vars_subsys);
776 firmware_unregister(&efi_subsys);
779 module_init(efivars_init);
780 module_exit(efivars_exit);