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/capability.h>
69 #include <linux/types.h>
70 #include <linux/errno.h>
71 #include <linux/init.h>
73 #include <linux/module.h>
74 #include <linux/string.h>
75 #include <linux/smp.h>
76 #include <linux/efi.h>
77 #include <linux/sysfs.h>
78 #include <linux/kobject.h>
79 #include <linux/device.h>
80 #include <linux/slab.h>
81 #include <linux/pstore.h>
83 #include <asm/uaccess.h>
85 #define EFIVARS_VERSION "0.08"
86 #define EFIVARS_DATE "2004-May-17"
88 MODULE_AUTHOR("Matt Domsch <Matt_Domsch@Dell.com>");
89 MODULE_DESCRIPTION("sysfs interface to EFI Variables");
90 MODULE_LICENSE("GPL");
91 MODULE_VERSION(EFIVARS_VERSION);
93 #define DUMP_NAME_LEN 52
95 static bool efivars_pstore_disable =
96 IS_ENABLED(CONFIG_EFI_VARS_PSTORE_DEFAULT_DISABLE);
98 module_param_named(pstore_disable, efivars_pstore_disable, bool, 0644);
101 * The maximum size of VariableName + Data = 1024
102 * Therefore, it's reasonable to save that much
103 * space in each part of the structure,
104 * and we use a page for reading/writing.
107 struct efi_variable {
108 efi_char16_t VariableName[1024/sizeof(efi_char16_t)];
109 efi_guid_t VendorGuid;
110 unsigned long DataSize;
114 } __attribute__((packed));
117 struct efivar_entry {
118 struct efivars *efivars;
119 struct efi_variable var;
120 struct list_head list;
124 struct efivar_attribute {
125 struct attribute attr;
126 ssize_t (*show) (struct efivar_entry *entry, char *buf);
127 ssize_t (*store)(struct efivar_entry *entry, const char *buf, size_t count);
130 static struct efivars __efivars;
132 #define PSTORE_EFI_ATTRIBUTES \
133 (EFI_VARIABLE_NON_VOLATILE | \
134 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
135 EFI_VARIABLE_RUNTIME_ACCESS)
137 #define EFIVAR_ATTR(_name, _mode, _show, _store) \
138 struct efivar_attribute efivar_attr_##_name = { \
139 .attr = {.name = __stringify(_name), .mode = _mode}, \
144 #define to_efivar_attr(_attr) container_of(_attr, struct efivar_attribute, attr)
145 #define to_efivar_entry(obj) container_of(obj, struct efivar_entry, kobj)
148 * Prototype for sysfs creation function
151 efivar_create_sysfs_entry(struct efivars *efivars,
152 unsigned long variable_name_size,
153 efi_char16_t *variable_name,
154 efi_guid_t *vendor_guid);
157 * Prototype for workqueue functions updating sysfs entry
160 static void efivar_update_sysfs_entries(struct work_struct *);
161 static DECLARE_WORK(efivar_work, efivar_update_sysfs_entries);
163 /* Return the number of unicode characters in data */
165 utf16_strnlen(efi_char16_t *s, size_t maxlength)
167 unsigned long length = 0;
169 while (*s++ != 0 && length < maxlength)
174 static inline unsigned long
175 utf16_strlen(efi_char16_t *s)
177 return utf16_strnlen(s, ~0UL);
181 * Return the number of bytes is the length of this string
182 * Note: this is NOT the same as the number of unicode characters
184 static inline unsigned long
185 utf16_strsize(efi_char16_t *data, unsigned long maxlength)
187 return utf16_strnlen(data, maxlength/sizeof(efi_char16_t)) * sizeof(efi_char16_t);
191 utf16_strncmp(const efi_char16_t *a, const efi_char16_t *b, size_t len)
200 if (*a == 0) /* implies *b == 0 */
209 validate_device_path(struct efi_variable *var, int match, u8 *buffer,
212 struct efi_generic_dev_path *node;
215 node = (struct efi_generic_dev_path *)buffer;
217 if (len < sizeof(*node))
220 while (offset <= len - sizeof(*node) &&
221 node->length >= sizeof(*node) &&
222 node->length <= len - offset) {
223 offset += node->length;
225 if ((node->type == EFI_DEV_END_PATH ||
226 node->type == EFI_DEV_END_PATH2) &&
227 node->sub_type == EFI_DEV_END_ENTIRE)
230 node = (struct efi_generic_dev_path *)(buffer + offset);
234 * If we're here then either node->length pointed past the end
235 * of the buffer or we reached the end of the buffer without
236 * finding a device path end node.
242 validate_boot_order(struct efi_variable *var, int match, u8 *buffer,
245 /* An array of 16-bit integers */
253 validate_load_option(struct efi_variable *var, int match, u8 *buffer,
257 int i, desclength = 0, namelen;
259 namelen = utf16_strnlen(var->VariableName, sizeof(var->VariableName));
261 /* Either "Boot" or "Driver" followed by four digits of hex */
262 for (i = match; i < match+4; i++) {
263 if (var->VariableName[i] > 127 ||
264 hex_to_bin(var->VariableName[i] & 0xff) < 0)
268 /* Reject it if there's 4 digits of hex and then further content */
269 if (namelen > match + 4)
272 /* A valid entry must be at least 8 bytes */
276 filepathlength = buffer[4] | buffer[5] << 8;
279 * There's no stored length for the description, so it has to be
282 desclength = utf16_strsize((efi_char16_t *)(buffer + 6), len - 6) + 2;
284 /* Each boot entry must have a descriptor */
289 * If the sum of the length of the description, the claimed filepath
290 * length and the original header are greater than the length of the
291 * variable, it's malformed
293 if ((desclength + filepathlength + 6) > len)
297 * And, finally, check the filepath
299 return validate_device_path(var, match, buffer + desclength + 6,
304 validate_uint16(struct efi_variable *var, int match, u8 *buffer,
307 /* A single 16-bit integer */
315 validate_ascii_string(struct efi_variable *var, int match, u8 *buffer,
320 for (i = 0; i < len; i++) {
331 struct variable_validate {
333 bool (*validate)(struct efi_variable *var, int match, u8 *data,
337 static const struct variable_validate variable_validate[] = {
338 { "BootNext", validate_uint16 },
339 { "BootOrder", validate_boot_order },
340 { "DriverOrder", validate_boot_order },
341 { "Boot*", validate_load_option },
342 { "Driver*", validate_load_option },
343 { "ConIn", validate_device_path },
344 { "ConInDev", validate_device_path },
345 { "ConOut", validate_device_path },
346 { "ConOutDev", validate_device_path },
347 { "ErrOut", validate_device_path },
348 { "ErrOutDev", validate_device_path },
349 { "Timeout", validate_uint16 },
350 { "Lang", validate_ascii_string },
351 { "PlatformLang", validate_ascii_string },
356 validate_var(struct efi_variable *var, u8 *data, unsigned long len)
359 u16 *unicode_name = var->VariableName;
361 for (i = 0; variable_validate[i].validate != NULL; i++) {
362 const char *name = variable_validate[i].name;
365 for (match = 0; ; match++) {
366 char c = name[match];
367 u16 u = unicode_name[match];
369 /* All special variables are plain ascii */
373 /* Wildcard in the matching name means we've matched */
375 return variable_validate[i].validate(var,
378 /* Case sensitive match */
382 /* Reached the end of the string while matching */
384 return variable_validate[i].validate(var,
393 get_var_data_locked(struct efivars *efivars, struct efi_variable *var)
397 var->DataSize = 1024;
398 status = efivars->ops->get_variable(var->VariableName,
407 get_var_data(struct efivars *efivars, struct efi_variable *var)
412 spin_lock_irqsave(&efivars->lock, flags);
413 status = get_var_data_locked(efivars, var);
414 spin_unlock_irqrestore(&efivars->lock, flags);
416 if (status != EFI_SUCCESS) {
417 printk(KERN_WARNING "efivars: get_variable() failed 0x%lx!\n",
424 check_var_size_locked(struct efivars *efivars, u32 attributes,
427 u64 storage_size, remaining_size, max_size;
429 const struct efivar_operations *fops = efivars->ops;
431 if (!efivars->ops->query_variable_info)
432 return EFI_UNSUPPORTED;
434 status = fops->query_variable_info(attributes, &storage_size,
435 &remaining_size, &max_size);
437 if (status != EFI_SUCCESS)
440 if (!storage_size || size > remaining_size || size > max_size ||
441 (remaining_size - size) < (storage_size / 2))
442 return EFI_OUT_OF_RESOURCES;
448 efivar_guid_read(struct efivar_entry *entry, char *buf)
450 struct efi_variable *var = &entry->var;
456 efi_guid_unparse(&var->VendorGuid, str);
458 str += sprintf(str, "\n");
464 efivar_attr_read(struct efivar_entry *entry, char *buf)
466 struct efi_variable *var = &entry->var;
473 status = get_var_data(entry->efivars, var);
474 if (status != EFI_SUCCESS)
477 if (var->Attributes & EFI_VARIABLE_NON_VOLATILE)
478 str += sprintf(str, "EFI_VARIABLE_NON_VOLATILE\n");
479 if (var->Attributes & EFI_VARIABLE_BOOTSERVICE_ACCESS)
480 str += sprintf(str, "EFI_VARIABLE_BOOTSERVICE_ACCESS\n");
481 if (var->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)
482 str += sprintf(str, "EFI_VARIABLE_RUNTIME_ACCESS\n");
483 if (var->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD)
484 str += sprintf(str, "EFI_VARIABLE_HARDWARE_ERROR_RECORD\n");
485 if (var->Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)
487 "EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\n");
488 if (var->Attributes &
489 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)
491 "EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS\n");
492 if (var->Attributes & EFI_VARIABLE_APPEND_WRITE)
493 str += sprintf(str, "EFI_VARIABLE_APPEND_WRITE\n");
498 efivar_size_read(struct efivar_entry *entry, char *buf)
500 struct efi_variable *var = &entry->var;
507 status = get_var_data(entry->efivars, var);
508 if (status != EFI_SUCCESS)
511 str += sprintf(str, "0x%lx\n", var->DataSize);
516 efivar_data_read(struct efivar_entry *entry, char *buf)
518 struct efi_variable *var = &entry->var;
524 status = get_var_data(entry->efivars, var);
525 if (status != EFI_SUCCESS)
528 memcpy(buf, var->Data, var->DataSize);
529 return var->DataSize;
532 * We allow each variable to be edited via rewriting the
533 * entire efi variable structure.
536 efivar_store_raw(struct efivar_entry *entry, const char *buf, size_t count)
538 struct efi_variable *new_var, *var = &entry->var;
539 struct efivars *efivars = entry->efivars;
540 efi_status_t status = EFI_NOT_FOUND;
542 if (count != sizeof(struct efi_variable))
545 new_var = (struct efi_variable *)buf;
547 * If only updating the variable data, then the name
548 * and guid should remain the same
550 if (memcmp(new_var->VariableName, var->VariableName, sizeof(var->VariableName)) ||
551 efi_guidcmp(new_var->VendorGuid, var->VendorGuid)) {
552 printk(KERN_ERR "efivars: Cannot edit the wrong variable!\n");
556 if ((new_var->DataSize <= 0) || (new_var->Attributes == 0)){
557 printk(KERN_ERR "efivars: DataSize & Attributes must be valid!\n");
561 if ((new_var->Attributes & ~EFI_VARIABLE_MASK) != 0 ||
562 validate_var(new_var, new_var->Data, new_var->DataSize) == false) {
563 printk(KERN_ERR "efivars: Malformed variable content\n");
567 spin_lock_irq(&efivars->lock);
569 status = check_var_size_locked(efivars, new_var->Attributes,
570 new_var->DataSize + utf16_strsize(new_var->VariableName, 1024));
572 if (status == EFI_SUCCESS || status == EFI_UNSUPPORTED)
573 status = efivars->ops->set_variable(new_var->VariableName,
574 &new_var->VendorGuid,
579 spin_unlock_irq(&efivars->lock);
581 if (status != EFI_SUCCESS) {
582 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
587 memcpy(&entry->var, new_var, count);
592 efivar_show_raw(struct efivar_entry *entry, char *buf)
594 struct efi_variable *var = &entry->var;
600 status = get_var_data(entry->efivars, var);
601 if (status != EFI_SUCCESS)
604 memcpy(buf, var, sizeof(*var));
609 * Generic read/write functions that call the specific functions of
612 static ssize_t efivar_attr_show(struct kobject *kobj, struct attribute *attr,
615 struct efivar_entry *var = to_efivar_entry(kobj);
616 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
619 if (!capable(CAP_SYS_ADMIN))
622 if (efivar_attr->show) {
623 ret = efivar_attr->show(var, buf);
628 static ssize_t efivar_attr_store(struct kobject *kobj, struct attribute *attr,
629 const char *buf, size_t count)
631 struct efivar_entry *var = to_efivar_entry(kobj);
632 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
635 if (!capable(CAP_SYS_ADMIN))
638 if (efivar_attr->store)
639 ret = efivar_attr->store(var, buf, count);
644 static const struct sysfs_ops efivar_attr_ops = {
645 .show = efivar_attr_show,
646 .store = efivar_attr_store,
649 static void efivar_release(struct kobject *kobj)
651 struct efivar_entry *var = container_of(kobj, struct efivar_entry, kobj);
655 static EFIVAR_ATTR(guid, 0400, efivar_guid_read, NULL);
656 static EFIVAR_ATTR(attributes, 0400, efivar_attr_read, NULL);
657 static EFIVAR_ATTR(size, 0400, efivar_size_read, NULL);
658 static EFIVAR_ATTR(data, 0400, efivar_data_read, NULL);
659 static EFIVAR_ATTR(raw_var, 0600, efivar_show_raw, efivar_store_raw);
661 static struct attribute *def_attrs[] = {
662 &efivar_attr_guid.attr,
663 &efivar_attr_size.attr,
664 &efivar_attr_attributes.attr,
665 &efivar_attr_data.attr,
666 &efivar_attr_raw_var.attr,
670 static struct kobj_type efivar_ktype = {
671 .release = efivar_release,
672 .sysfs_ops = &efivar_attr_ops,
673 .default_attrs = def_attrs,
677 efivar_unregister(struct efivar_entry *var)
679 kobject_put(&var->kobj);
682 static int efi_status_to_err(efi_status_t status)
687 case EFI_INVALID_PARAMETER:
690 case EFI_OUT_OF_RESOURCES:
693 case EFI_DEVICE_ERROR:
696 case EFI_WRITE_PROTECTED:
699 case EFI_SECURITY_VIOLATION:
712 #ifdef CONFIG_EFI_VARS_PSTORE
714 static int efi_pstore_open(struct pstore_info *psi)
716 struct efivars *efivars = psi->data;
718 spin_lock_irq(&efivars->lock);
719 efivars->walk_entry = list_first_entry(&efivars->list,
720 struct efivar_entry, list);
724 static int efi_pstore_close(struct pstore_info *psi)
726 struct efivars *efivars = psi->data;
728 spin_unlock_irq(&efivars->lock);
732 static ssize_t efi_pstore_read(u64 *id, enum pstore_type_id *type,
733 struct timespec *timespec,
734 char **buf, struct pstore_info *psi)
736 efi_guid_t vendor = LINUX_EFI_CRASH_GUID;
737 struct efivars *efivars = psi->data;
738 char name[DUMP_NAME_LEN];
740 unsigned int part, size;
743 while (&efivars->walk_entry->list != &efivars->list) {
744 if (!efi_guidcmp(efivars->walk_entry->var.VendorGuid,
746 for (i = 0; i < DUMP_NAME_LEN; i++) {
747 name[i] = efivars->walk_entry->var.VariableName[i];
749 if (sscanf(name, "dump-type%u-%u-%lu", type, &part, &time) == 3) {
751 timespec->tv_sec = time;
752 timespec->tv_nsec = 0;
753 get_var_data_locked(efivars, &efivars->walk_entry->var);
754 size = efivars->walk_entry->var.DataSize;
755 *buf = kmalloc(size, GFP_KERNEL);
758 memcpy(*buf, efivars->walk_entry->var.Data,
760 efivars->walk_entry = list_entry(efivars->walk_entry->list.next,
761 struct efivar_entry, list);
765 efivars->walk_entry = list_entry(efivars->walk_entry->list.next,
766 struct efivar_entry, list);
771 static int efi_pstore_write(enum pstore_type_id type, u64 *id,
772 unsigned int part, size_t size, struct pstore_info *psi)
774 char name[DUMP_NAME_LEN];
775 char stub_name[DUMP_NAME_LEN];
776 efi_char16_t efi_name[DUMP_NAME_LEN];
777 efi_guid_t vendor = LINUX_EFI_CRASH_GUID;
778 struct efivars *efivars = psi->data;
779 struct efivar_entry *entry, *found = NULL;
781 efi_status_t status = EFI_NOT_FOUND;
784 sprintf(stub_name, "dump-type%u-%u-", type, part);
785 sprintf(name, "%s%lu", stub_name, get_seconds());
787 spin_lock_irqsave(&efivars->lock, flags);
790 * Check if there is a space enough to log.
791 * size: a size of logging data
792 * DUMP_NAME_LEN * 2: a maximum size of variable name
795 status = check_var_size_locked(efivars, PSTORE_EFI_ATTRIBUTES,
796 size + DUMP_NAME_LEN * 2);
799 spin_unlock_irqrestore(&efivars->lock, flags);
804 for (i = 0; i < DUMP_NAME_LEN; i++)
805 efi_name[i] = stub_name[i];
808 * Clean up any entries with the same name
811 list_for_each_entry(entry, &efivars->list, list) {
812 get_var_data_locked(efivars, &entry->var);
814 if (efi_guidcmp(entry->var.VendorGuid, vendor))
816 if (utf16_strncmp(entry->var.VariableName, efi_name,
817 utf16_strlen(efi_name)))
819 /* Needs to be a prefix */
820 if (entry->var.VariableName[utf16_strlen(efi_name)] == 0)
825 efivars->ops->set_variable(entry->var.VariableName,
826 &entry->var.VendorGuid,
827 PSTORE_EFI_ATTRIBUTES,
832 list_del(&found->list);
834 for (i = 0; i < DUMP_NAME_LEN; i++)
835 efi_name[i] = name[i];
837 efivars->ops->set_variable(efi_name, &vendor, PSTORE_EFI_ATTRIBUTES,
840 spin_unlock_irqrestore(&efivars->lock, flags);
843 efivar_unregister(found);
845 schedule_work(&efivar_work);
851 static int efi_pstore_erase(enum pstore_type_id type, u64 id,
852 struct pstore_info *psi)
854 efi_pstore_write(type, &id, (unsigned int)id, 0, psi);
859 static struct pstore_info efi_pstore_info = {
860 .owner = THIS_MODULE,
862 .open = efi_pstore_open,
863 .close = efi_pstore_close,
864 .read = efi_pstore_read,
865 .write = efi_pstore_write,
866 .erase = efi_pstore_erase,
869 static void efivar_pstore_register(struct efivars *efivars)
871 efivars->efi_pstore_info = efi_pstore_info;
872 efivars->efi_pstore_info.buf = kmalloc(4096, GFP_KERNEL);
873 if (efivars->efi_pstore_info.buf) {
874 efivars->efi_pstore_info.bufsize = 1024;
875 efivars->efi_pstore_info.data = efivars;
876 spin_lock_init(&efivars->efi_pstore_info.buf_lock);
877 pstore_register(&efivars->efi_pstore_info);
881 static void efivar_pstore_register(struct efivars *efivars)
887 static ssize_t efivar_create(struct file *filp, struct kobject *kobj,
888 struct bin_attribute *bin_attr,
889 char *buf, loff_t pos, size_t count)
891 struct efi_variable *new_var = (struct efi_variable *)buf;
892 struct efivars *efivars = bin_attr->private;
893 struct efivar_entry *search_efivar, *n;
894 unsigned long strsize1, strsize2;
895 efi_status_t status = EFI_NOT_FOUND;
898 if (!capable(CAP_SYS_ADMIN))
901 if ((new_var->Attributes & ~EFI_VARIABLE_MASK) != 0 ||
902 validate_var(new_var, new_var->Data, new_var->DataSize) == false) {
903 printk(KERN_ERR "efivars: Malformed variable content\n");
907 spin_lock_irq(&efivars->lock);
910 * Does this variable already exist?
912 list_for_each_entry_safe(search_efivar, n, &efivars->list, list) {
913 strsize1 = utf16_strsize(search_efivar->var.VariableName, 1024);
914 strsize2 = utf16_strsize(new_var->VariableName, 1024);
915 if (strsize1 == strsize2 &&
916 !memcmp(&(search_efivar->var.VariableName),
917 new_var->VariableName, strsize1) &&
918 !efi_guidcmp(search_efivar->var.VendorGuid,
919 new_var->VendorGuid)) {
925 spin_unlock_irq(&efivars->lock);
929 status = check_var_size_locked(efivars, new_var->Attributes,
930 new_var->DataSize + utf16_strsize(new_var->VariableName, 1024));
932 if (status && status != EFI_UNSUPPORTED) {
933 spin_unlock_irq(&efivars->lock);
934 return efi_status_to_err(status);
937 /* now *really* create the variable via EFI */
938 status = efivars->ops->set_variable(new_var->VariableName,
939 &new_var->VendorGuid,
944 if (status != EFI_SUCCESS) {
945 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
947 spin_unlock_irq(&efivars->lock);
950 spin_unlock_irq(&efivars->lock);
952 /* Create the entry in sysfs. Locking is not required here */
953 status = efivar_create_sysfs_entry(efivars,
954 utf16_strsize(new_var->VariableName,
956 new_var->VariableName,
957 &new_var->VendorGuid);
959 printk(KERN_WARNING "efivars: variable created, but sysfs entry wasn't.\n");
964 static ssize_t efivar_delete(struct file *filp, struct kobject *kobj,
965 struct bin_attribute *bin_attr,
966 char *buf, loff_t pos, size_t count)
968 struct efi_variable *del_var = (struct efi_variable *)buf;
969 struct efivars *efivars = bin_attr->private;
970 struct efivar_entry *search_efivar, *n;
971 unsigned long strsize1, strsize2;
972 efi_status_t status = EFI_NOT_FOUND;
975 if (!capable(CAP_SYS_ADMIN))
978 spin_lock_irq(&efivars->lock);
981 * Does this variable already exist?
983 list_for_each_entry_safe(search_efivar, n, &efivars->list, list) {
984 strsize1 = utf16_strsize(search_efivar->var.VariableName, 1024);
985 strsize2 = utf16_strsize(del_var->VariableName, 1024);
986 if (strsize1 == strsize2 &&
987 !memcmp(&(search_efivar->var.VariableName),
988 del_var->VariableName, strsize1) &&
989 !efi_guidcmp(search_efivar->var.VendorGuid,
990 del_var->VendorGuid)) {
996 spin_unlock_irq(&efivars->lock);
999 /* force the Attributes/DataSize to 0 to ensure deletion */
1000 del_var->Attributes = 0;
1001 del_var->DataSize = 0;
1003 status = efivars->ops->set_variable(del_var->VariableName,
1004 &del_var->VendorGuid,
1005 del_var->Attributes,
1009 if (status != EFI_SUCCESS) {
1010 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
1012 spin_unlock_irq(&efivars->lock);
1015 list_del(&search_efivar->list);
1016 /* We need to release this lock before unregistering. */
1017 spin_unlock_irq(&efivars->lock);
1018 efivar_unregister(search_efivar);
1020 /* It's dead Jim.... */
1024 static bool variable_is_present(efi_char16_t *variable_name, efi_guid_t *vendor)
1026 struct efivar_entry *entry, *n;
1027 struct efivars *efivars = &__efivars;
1028 unsigned long strsize1, strsize2;
1031 strsize1 = utf16_strsize(variable_name, 1024);
1032 list_for_each_entry_safe(entry, n, &efivars->list, list) {
1033 strsize2 = utf16_strsize(entry->var.VariableName, 1024);
1034 if (strsize1 == strsize2 &&
1035 !memcmp(variable_name, &(entry->var.VariableName),
1037 !efi_guidcmp(entry->var.VendorGuid,
1046 static void efivar_update_sysfs_entries(struct work_struct *work)
1048 struct efivars *efivars = &__efivars;
1050 efi_char16_t *variable_name;
1051 unsigned long variable_name_size = 1024;
1052 efi_status_t status = EFI_NOT_FOUND;
1055 /* Add new sysfs entries */
1057 variable_name = kzalloc(variable_name_size, GFP_KERNEL);
1058 if (!variable_name) {
1059 pr_err("efivars: Memory allocation failed.\n");
1063 spin_lock_irq(&efivars->lock);
1066 variable_name_size = 1024;
1067 status = efivars->ops->get_next_variable(
1068 &variable_name_size,
1071 if (status != EFI_SUCCESS) {
1074 if (!variable_is_present(variable_name,
1081 spin_unlock_irq(&efivars->lock);
1084 kfree(variable_name);
1087 efivar_create_sysfs_entry(efivars,
1089 variable_name, &vendor);
1094 * Let's not leave out systab information that snuck into
1095 * the efivars driver
1097 static ssize_t systab_show(struct kobject *kobj,
1098 struct kobj_attribute *attr, char *buf)
1105 if (efi.mps != EFI_INVALID_TABLE_ADDR)
1106 str += sprintf(str, "MPS=0x%lx\n", efi.mps);
1107 if (efi.acpi20 != EFI_INVALID_TABLE_ADDR)
1108 str += sprintf(str, "ACPI20=0x%lx\n", efi.acpi20);
1109 if (efi.acpi != EFI_INVALID_TABLE_ADDR)
1110 str += sprintf(str, "ACPI=0x%lx\n", efi.acpi);
1111 if (efi.smbios != EFI_INVALID_TABLE_ADDR)
1112 str += sprintf(str, "SMBIOS=0x%lx\n", efi.smbios);
1113 if (efi.hcdp != EFI_INVALID_TABLE_ADDR)
1114 str += sprintf(str, "HCDP=0x%lx\n", efi.hcdp);
1115 if (efi.boot_info != EFI_INVALID_TABLE_ADDR)
1116 str += sprintf(str, "BOOTINFO=0x%lx\n", efi.boot_info);
1117 if (efi.uga != EFI_INVALID_TABLE_ADDR)
1118 str += sprintf(str, "UGA=0x%lx\n", efi.uga);
1123 static struct kobj_attribute efi_attr_systab =
1124 __ATTR(systab, 0400, systab_show, NULL);
1126 static struct attribute *efi_subsys_attrs[] = {
1127 &efi_attr_systab.attr,
1128 NULL, /* maybe more in the future? */
1131 static struct attribute_group efi_subsys_attr_group = {
1132 .attrs = efi_subsys_attrs,
1135 static struct kobject *efi_kobj;
1138 * efivar_create_sysfs_entry()
1140 * variable_name_size = number of bytes required to hold
1141 * variable_name (not counting the NULL
1142 * character at the end.
1143 * efivars->lock is not held on entry or exit.
1144 * Returns 1 on failure, 0 on success
1147 efivar_create_sysfs_entry(struct efivars *efivars,
1148 unsigned long variable_name_size,
1149 efi_char16_t *variable_name,
1150 efi_guid_t *vendor_guid)
1152 int i, short_name_size = variable_name_size / sizeof(efi_char16_t) + 38;
1154 struct efivar_entry *new_efivar;
1156 short_name = kzalloc(short_name_size + 1, GFP_KERNEL);
1157 new_efivar = kzalloc(sizeof(struct efivar_entry), GFP_KERNEL);
1159 if (!short_name || !new_efivar) {
1165 new_efivar->efivars = efivars;
1166 memcpy(new_efivar->var.VariableName, variable_name,
1167 variable_name_size);
1168 memcpy(&(new_efivar->var.VendorGuid), vendor_guid, sizeof(efi_guid_t));
1170 /* Convert Unicode to normal chars (assume top bits are 0),
1172 for (i=0; i < (int)(variable_name_size / sizeof(efi_char16_t)); i++) {
1173 short_name[i] = variable_name[i] & 0xFF;
1175 /* This is ugly, but necessary to separate one vendor's
1176 private variables from another's. */
1178 *(short_name + strlen(short_name)) = '-';
1179 efi_guid_unparse(vendor_guid, short_name + strlen(short_name));
1181 new_efivar->kobj.kset = efivars->kset;
1182 i = kobject_init_and_add(&new_efivar->kobj, &efivar_ktype, NULL,
1190 kobject_uevent(&new_efivar->kobj, KOBJ_ADD);
1194 spin_lock_irq(&efivars->lock);
1195 list_add(&new_efivar->list, &efivars->list);
1196 spin_unlock_irq(&efivars->lock);
1202 create_efivars_bin_attributes(struct efivars *efivars)
1204 struct bin_attribute *attr;
1208 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
1212 attr->attr.name = "new_var";
1213 attr->attr.mode = 0200;
1214 attr->write = efivar_create;
1215 attr->private = efivars;
1216 efivars->new_var = attr;
1219 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
1224 attr->attr.name = "del_var";
1225 attr->attr.mode = 0200;
1226 attr->write = efivar_delete;
1227 attr->private = efivars;
1228 efivars->del_var = attr;
1230 sysfs_bin_attr_init(efivars->new_var);
1231 sysfs_bin_attr_init(efivars->del_var);
1234 error = sysfs_create_bin_file(&efivars->kset->kobj,
1237 printk(KERN_ERR "efivars: unable to create new_var sysfs file"
1238 " due to error %d\n", error);
1241 error = sysfs_create_bin_file(&efivars->kset->kobj,
1244 printk(KERN_ERR "efivars: unable to create del_var sysfs file"
1245 " due to error %d\n", error);
1246 sysfs_remove_bin_file(&efivars->kset->kobj,
1253 kfree(efivars->del_var);
1254 efivars->del_var = NULL;
1255 kfree(efivars->new_var);
1256 efivars->new_var = NULL;
1260 void unregister_efivars(struct efivars *efivars)
1262 struct efivar_entry *entry, *n;
1264 list_for_each_entry_safe(entry, n, &efivars->list, list) {
1265 spin_lock_irq(&efivars->lock);
1266 list_del(&entry->list);
1267 spin_unlock_irq(&efivars->lock);
1268 efivar_unregister(entry);
1270 if (efivars->new_var)
1271 sysfs_remove_bin_file(&efivars->kset->kobj, efivars->new_var);
1272 if (efivars->del_var)
1273 sysfs_remove_bin_file(&efivars->kset->kobj, efivars->del_var);
1274 kfree(efivars->new_var);
1275 kfree(efivars->del_var);
1276 kset_unregister(efivars->kset);
1278 EXPORT_SYMBOL_GPL(unregister_efivars);
1280 int register_efivars(struct efivars *efivars,
1281 const struct efivar_operations *ops,
1282 struct kobject *parent_kobj)
1284 efi_status_t status = EFI_NOT_FOUND;
1285 efi_guid_t vendor_guid;
1286 efi_char16_t *variable_name;
1287 unsigned long variable_name_size = 1024;
1290 variable_name = kzalloc(variable_name_size, GFP_KERNEL);
1291 if (!variable_name) {
1292 printk(KERN_ERR "efivars: Memory allocation failed.\n");
1296 spin_lock_init(&efivars->lock);
1297 INIT_LIST_HEAD(&efivars->list);
1300 efivars->kset = kset_create_and_add("vars", NULL, parent_kobj);
1301 if (!efivars->kset) {
1302 printk(KERN_ERR "efivars: Subsystem registration failed.\n");
1308 * Per EFI spec, the maximum storage allocated for both
1309 * the variable name and variable data is 1024 bytes.
1313 variable_name_size = 1024;
1315 status = ops->get_next_variable(&variable_name_size,
1320 efivar_create_sysfs_entry(efivars,
1328 printk(KERN_WARNING "efivars: get_next_variable: status=%lx\n",
1330 status = EFI_NOT_FOUND;
1333 } while (status != EFI_NOT_FOUND);
1335 error = create_efivars_bin_attributes(efivars);
1337 unregister_efivars(efivars);
1339 if (!efivars_pstore_disable)
1340 efivar_pstore_register(efivars);
1343 kfree(variable_name);
1347 EXPORT_SYMBOL_GPL(register_efivars);
1349 static struct efivar_operations ops;
1352 * For now we register the efi subsystem with the firmware subsystem
1353 * and the vars subsystem with the efi subsystem. In the future, it
1354 * might make sense to split off the efi subsystem into its own
1355 * driver, but for now only efivars will register with it, so just
1364 printk(KERN_INFO "EFI Variables Facility v%s %s\n", EFIVARS_VERSION,
1367 if (!efi_enabled(EFI_RUNTIME_SERVICES))
1370 /* For now we'll register the efi directory at /sys/firmware/efi */
1371 efi_kobj = kobject_create_and_add("efi", firmware_kobj);
1373 printk(KERN_ERR "efivars: Firmware registration failed.\n");
1377 ops.get_variable = efi.get_variable;
1378 ops.set_variable = efi.set_variable;
1379 ops.get_next_variable = efi.get_next_variable;
1380 ops.query_variable_info = efi.query_variable_info;
1381 error = register_efivars(&__efivars, &ops, efi_kobj);
1385 /* Don't forget the systab entry */
1386 error = sysfs_create_group(efi_kobj, &efi_subsys_attr_group);
1389 "efivars: Sysfs attribute export failed with error %d.\n",
1391 goto err_unregister;
1397 unregister_efivars(&__efivars);
1399 kobject_put(efi_kobj);
1406 cancel_work_sync(&efivar_work);
1408 if (efi_enabled(EFI_RUNTIME_SERVICES)) {
1409 unregister_efivars(&__efivars);
1410 kobject_put(efi_kobj);
1414 module_init(efivars_init);
1415 module_exit(efivars_exit);