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);
162 static bool efivar_wq_enabled = true;
164 /* Return the number of unicode characters in data */
166 utf16_strnlen(efi_char16_t *s, size_t maxlength)
168 unsigned long length = 0;
170 while (*s++ != 0 && length < maxlength)
175 static inline unsigned long
176 utf16_strlen(efi_char16_t *s)
178 return utf16_strnlen(s, ~0UL);
182 * Return the number of bytes is the length of this string
183 * Note: this is NOT the same as the number of unicode characters
185 static inline unsigned long
186 utf16_strsize(efi_char16_t *data, unsigned long maxlength)
188 return utf16_strnlen(data, maxlength/sizeof(efi_char16_t)) * sizeof(efi_char16_t);
192 utf16_strncmp(const efi_char16_t *a, const efi_char16_t *b, size_t len)
201 if (*a == 0) /* implies *b == 0 */
210 validate_device_path(struct efi_variable *var, int match, u8 *buffer,
213 struct efi_generic_dev_path *node;
216 node = (struct efi_generic_dev_path *)buffer;
218 if (len < sizeof(*node))
221 while (offset <= len - sizeof(*node) &&
222 node->length >= sizeof(*node) &&
223 node->length <= len - offset) {
224 offset += node->length;
226 if ((node->type == EFI_DEV_END_PATH ||
227 node->type == EFI_DEV_END_PATH2) &&
228 node->sub_type == EFI_DEV_END_ENTIRE)
231 node = (struct efi_generic_dev_path *)(buffer + offset);
235 * If we're here then either node->length pointed past the end
236 * of the buffer or we reached the end of the buffer without
237 * finding a device path end node.
243 validate_boot_order(struct efi_variable *var, int match, u8 *buffer,
246 /* An array of 16-bit integers */
254 validate_load_option(struct efi_variable *var, int match, u8 *buffer,
258 int i, desclength = 0, namelen;
260 namelen = utf16_strnlen(var->VariableName, sizeof(var->VariableName));
262 /* Either "Boot" or "Driver" followed by four digits of hex */
263 for (i = match; i < match+4; i++) {
264 if (var->VariableName[i] > 127 ||
265 hex_to_bin(var->VariableName[i] & 0xff) < 0)
269 /* Reject it if there's 4 digits of hex and then further content */
270 if (namelen > match + 4)
273 /* A valid entry must be at least 8 bytes */
277 filepathlength = buffer[4] | buffer[5] << 8;
280 * There's no stored length for the description, so it has to be
283 desclength = utf16_strsize((efi_char16_t *)(buffer + 6), len - 6) + 2;
285 /* Each boot entry must have a descriptor */
290 * If the sum of the length of the description, the claimed filepath
291 * length and the original header are greater than the length of the
292 * variable, it's malformed
294 if ((desclength + filepathlength + 6) > len)
298 * And, finally, check the filepath
300 return validate_device_path(var, match, buffer + desclength + 6,
305 validate_uint16(struct efi_variable *var, int match, u8 *buffer,
308 /* A single 16-bit integer */
316 validate_ascii_string(struct efi_variable *var, int match, u8 *buffer,
321 for (i = 0; i < len; i++) {
332 struct variable_validate {
334 bool (*validate)(struct efi_variable *var, int match, u8 *data,
338 static const struct variable_validate variable_validate[] = {
339 { "BootNext", validate_uint16 },
340 { "BootOrder", validate_boot_order },
341 { "DriverOrder", validate_boot_order },
342 { "Boot*", validate_load_option },
343 { "Driver*", validate_load_option },
344 { "ConIn", validate_device_path },
345 { "ConInDev", validate_device_path },
346 { "ConOut", validate_device_path },
347 { "ConOutDev", validate_device_path },
348 { "ErrOut", validate_device_path },
349 { "ErrOutDev", validate_device_path },
350 { "Timeout", validate_uint16 },
351 { "Lang", validate_ascii_string },
352 { "PlatformLang", validate_ascii_string },
357 validate_var(struct efi_variable *var, u8 *data, unsigned long len)
360 u16 *unicode_name = var->VariableName;
362 for (i = 0; variable_validate[i].validate != NULL; i++) {
363 const char *name = variable_validate[i].name;
366 for (match = 0; ; match++) {
367 char c = name[match];
368 u16 u = unicode_name[match];
370 /* All special variables are plain ascii */
374 /* Wildcard in the matching name means we've matched */
376 return variable_validate[i].validate(var,
379 /* Case sensitive match */
383 /* Reached the end of the string while matching */
385 return variable_validate[i].validate(var,
394 get_var_data_locked(struct efivars *efivars, struct efi_variable *var)
398 var->DataSize = 1024;
399 status = efivars->ops->get_variable(var->VariableName,
408 get_var_data(struct efivars *efivars, struct efi_variable *var)
413 spin_lock_irqsave(&efivars->lock, flags);
414 status = get_var_data_locked(efivars, var);
415 spin_unlock_irqrestore(&efivars->lock, flags);
417 if (status != EFI_SUCCESS) {
418 printk(KERN_WARNING "efivars: get_variable() failed 0x%lx!\n",
425 check_var_size_locked(struct efivars *efivars, u32 attributes,
428 u64 storage_size, remaining_size, max_size;
430 const struct efivar_operations *fops = efivars->ops;
432 if (!efivars->ops->query_variable_info)
433 return EFI_UNSUPPORTED;
435 status = fops->query_variable_info(attributes, &storage_size,
436 &remaining_size, &max_size);
438 if (status != EFI_SUCCESS)
441 if (!storage_size || size > remaining_size || size > max_size ||
442 (remaining_size - size) < (storage_size / 2))
443 return EFI_OUT_OF_RESOURCES;
449 efivar_guid_read(struct efivar_entry *entry, char *buf)
451 struct efi_variable *var = &entry->var;
457 efi_guid_unparse(&var->VendorGuid, str);
459 str += sprintf(str, "\n");
465 efivar_attr_read(struct efivar_entry *entry, char *buf)
467 struct efi_variable *var = &entry->var;
474 status = get_var_data(entry->efivars, var);
475 if (status != EFI_SUCCESS)
478 if (var->Attributes & EFI_VARIABLE_NON_VOLATILE)
479 str += sprintf(str, "EFI_VARIABLE_NON_VOLATILE\n");
480 if (var->Attributes & EFI_VARIABLE_BOOTSERVICE_ACCESS)
481 str += sprintf(str, "EFI_VARIABLE_BOOTSERVICE_ACCESS\n");
482 if (var->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)
483 str += sprintf(str, "EFI_VARIABLE_RUNTIME_ACCESS\n");
484 if (var->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD)
485 str += sprintf(str, "EFI_VARIABLE_HARDWARE_ERROR_RECORD\n");
486 if (var->Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)
488 "EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\n");
489 if (var->Attributes &
490 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)
492 "EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS\n");
493 if (var->Attributes & EFI_VARIABLE_APPEND_WRITE)
494 str += sprintf(str, "EFI_VARIABLE_APPEND_WRITE\n");
499 efivar_size_read(struct efivar_entry *entry, char *buf)
501 struct efi_variable *var = &entry->var;
508 status = get_var_data(entry->efivars, var);
509 if (status != EFI_SUCCESS)
512 str += sprintf(str, "0x%lx\n", var->DataSize);
517 efivar_data_read(struct efivar_entry *entry, char *buf)
519 struct efi_variable *var = &entry->var;
525 status = get_var_data(entry->efivars, var);
526 if (status != EFI_SUCCESS)
529 memcpy(buf, var->Data, var->DataSize);
530 return var->DataSize;
533 * We allow each variable to be edited via rewriting the
534 * entire efi variable structure.
537 efivar_store_raw(struct efivar_entry *entry, const char *buf, size_t count)
539 struct efi_variable *new_var, *var = &entry->var;
540 struct efivars *efivars = entry->efivars;
541 efi_status_t status = EFI_NOT_FOUND;
543 if (count != sizeof(struct efi_variable))
546 new_var = (struct efi_variable *)buf;
548 * If only updating the variable data, then the name
549 * and guid should remain the same
551 if (memcmp(new_var->VariableName, var->VariableName, sizeof(var->VariableName)) ||
552 efi_guidcmp(new_var->VendorGuid, var->VendorGuid)) {
553 printk(KERN_ERR "efivars: Cannot edit the wrong variable!\n");
557 if ((new_var->DataSize <= 0) || (new_var->Attributes == 0)){
558 printk(KERN_ERR "efivars: DataSize & Attributes must be valid!\n");
562 if ((new_var->Attributes & ~EFI_VARIABLE_MASK) != 0 ||
563 validate_var(new_var, new_var->Data, new_var->DataSize) == false) {
564 printk(KERN_ERR "efivars: Malformed variable content\n");
568 spin_lock_irq(&efivars->lock);
570 status = check_var_size_locked(efivars, new_var->Attributes,
571 new_var->DataSize + utf16_strsize(new_var->VariableName, 1024));
573 if (status == EFI_SUCCESS || status == EFI_UNSUPPORTED)
574 status = efivars->ops->set_variable(new_var->VariableName,
575 &new_var->VendorGuid,
580 spin_unlock_irq(&efivars->lock);
582 if (status != EFI_SUCCESS) {
583 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
588 memcpy(&entry->var, new_var, count);
593 efivar_show_raw(struct efivar_entry *entry, char *buf)
595 struct efi_variable *var = &entry->var;
601 status = get_var_data(entry->efivars, var);
602 if (status != EFI_SUCCESS)
605 memcpy(buf, var, sizeof(*var));
610 * Generic read/write functions that call the specific functions of
613 static ssize_t efivar_attr_show(struct kobject *kobj, struct attribute *attr,
616 struct efivar_entry *var = to_efivar_entry(kobj);
617 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
620 if (!capable(CAP_SYS_ADMIN))
623 if (efivar_attr->show) {
624 ret = efivar_attr->show(var, buf);
629 static ssize_t efivar_attr_store(struct kobject *kobj, struct attribute *attr,
630 const char *buf, size_t count)
632 struct efivar_entry *var = to_efivar_entry(kobj);
633 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
636 if (!capable(CAP_SYS_ADMIN))
639 if (efivar_attr->store)
640 ret = efivar_attr->store(var, buf, count);
645 static const struct sysfs_ops efivar_attr_ops = {
646 .show = efivar_attr_show,
647 .store = efivar_attr_store,
650 static void efivar_release(struct kobject *kobj)
652 struct efivar_entry *var = container_of(kobj, struct efivar_entry, kobj);
656 static EFIVAR_ATTR(guid, 0400, efivar_guid_read, NULL);
657 static EFIVAR_ATTR(attributes, 0400, efivar_attr_read, NULL);
658 static EFIVAR_ATTR(size, 0400, efivar_size_read, NULL);
659 static EFIVAR_ATTR(data, 0400, efivar_data_read, NULL);
660 static EFIVAR_ATTR(raw_var, 0600, efivar_show_raw, efivar_store_raw);
662 static struct attribute *def_attrs[] = {
663 &efivar_attr_guid.attr,
664 &efivar_attr_size.attr,
665 &efivar_attr_attributes.attr,
666 &efivar_attr_data.attr,
667 &efivar_attr_raw_var.attr,
671 static struct kobj_type efivar_ktype = {
672 .release = efivar_release,
673 .sysfs_ops = &efivar_attr_ops,
674 .default_attrs = def_attrs,
678 efivar_unregister(struct efivar_entry *var)
680 kobject_put(&var->kobj);
683 static int efi_status_to_err(efi_status_t status)
688 case EFI_INVALID_PARAMETER:
691 case EFI_OUT_OF_RESOURCES:
694 case EFI_DEVICE_ERROR:
697 case EFI_WRITE_PROTECTED:
700 case EFI_SECURITY_VIOLATION:
713 #ifdef CONFIG_EFI_VARS_PSTORE
715 static int efi_pstore_open(struct pstore_info *psi)
717 struct efivars *efivars = psi->data;
719 spin_lock_irq(&efivars->lock);
720 efivars->walk_entry = list_first_entry(&efivars->list,
721 struct efivar_entry, list);
725 static int efi_pstore_close(struct pstore_info *psi)
727 struct efivars *efivars = psi->data;
729 spin_unlock_irq(&efivars->lock);
733 static ssize_t efi_pstore_read(u64 *id, enum pstore_type_id *type,
734 struct timespec *timespec,
735 char **buf, struct pstore_info *psi)
737 efi_guid_t vendor = LINUX_EFI_CRASH_GUID;
738 struct efivars *efivars = psi->data;
739 char name[DUMP_NAME_LEN];
741 unsigned int part, size;
744 while (&efivars->walk_entry->list != &efivars->list) {
745 if (!efi_guidcmp(efivars->walk_entry->var.VendorGuid,
747 for (i = 0; i < DUMP_NAME_LEN; i++) {
748 name[i] = efivars->walk_entry->var.VariableName[i];
750 if (sscanf(name, "dump-type%u-%u-%lu", type, &part, &time) == 3) {
752 timespec->tv_sec = time;
753 timespec->tv_nsec = 0;
754 get_var_data_locked(efivars, &efivars->walk_entry->var);
755 size = efivars->walk_entry->var.DataSize;
756 *buf = kmalloc(size, GFP_KERNEL);
759 memcpy(*buf, efivars->walk_entry->var.Data,
761 efivars->walk_entry = list_entry(efivars->walk_entry->list.next,
762 struct efivar_entry, list);
766 efivars->walk_entry = list_entry(efivars->walk_entry->list.next,
767 struct efivar_entry, list);
772 static int efi_pstore_write(enum pstore_type_id type, u64 *id,
773 unsigned int part, size_t size, struct pstore_info *psi)
775 char name[DUMP_NAME_LEN];
776 char stub_name[DUMP_NAME_LEN];
777 efi_char16_t efi_name[DUMP_NAME_LEN];
778 efi_guid_t vendor = LINUX_EFI_CRASH_GUID;
779 struct efivars *efivars = psi->data;
780 struct efivar_entry *entry, *found = NULL;
782 efi_status_t status = EFI_NOT_FOUND;
785 sprintf(stub_name, "dump-type%u-%u-", type, part);
786 sprintf(name, "%s%lu", stub_name, get_seconds());
788 spin_lock_irqsave(&efivars->lock, flags);
791 * Check if there is a space enough to log.
792 * size: a size of logging data
793 * DUMP_NAME_LEN * 2: a maximum size of variable name
796 status = check_var_size_locked(efivars, PSTORE_EFI_ATTRIBUTES,
797 size + DUMP_NAME_LEN * 2);
800 spin_unlock_irqrestore(&efivars->lock, flags);
805 for (i = 0; i < DUMP_NAME_LEN; i++)
806 efi_name[i] = stub_name[i];
809 * Clean up any entries with the same name
812 list_for_each_entry(entry, &efivars->list, list) {
813 get_var_data_locked(efivars, &entry->var);
815 if (efi_guidcmp(entry->var.VendorGuid, vendor))
817 if (utf16_strncmp(entry->var.VariableName, efi_name,
818 utf16_strlen(efi_name)))
820 /* Needs to be a prefix */
821 if (entry->var.VariableName[utf16_strlen(efi_name)] == 0)
826 efivars->ops->set_variable(entry->var.VariableName,
827 &entry->var.VendorGuid,
828 PSTORE_EFI_ATTRIBUTES,
833 list_del(&found->list);
835 for (i = 0; i < DUMP_NAME_LEN; i++)
836 efi_name[i] = name[i];
838 efivars->ops->set_variable(efi_name, &vendor, PSTORE_EFI_ATTRIBUTES,
841 spin_unlock_irqrestore(&efivars->lock, flags);
844 efivar_unregister(found);
846 if (efivar_wq_enabled)
847 schedule_work(&efivar_work);
853 static int efi_pstore_erase(enum pstore_type_id type, u64 id,
854 struct pstore_info *psi)
856 efi_pstore_write(type, &id, (unsigned int)id, 0, psi);
861 static struct pstore_info efi_pstore_info = {
862 .owner = THIS_MODULE,
864 .open = efi_pstore_open,
865 .close = efi_pstore_close,
866 .read = efi_pstore_read,
867 .write = efi_pstore_write,
868 .erase = efi_pstore_erase,
871 static void efivar_pstore_register(struct efivars *efivars)
873 efivars->efi_pstore_info = efi_pstore_info;
874 efivars->efi_pstore_info.buf = kmalloc(4096, GFP_KERNEL);
875 if (efivars->efi_pstore_info.buf) {
876 efivars->efi_pstore_info.bufsize = 1024;
877 efivars->efi_pstore_info.data = efivars;
878 spin_lock_init(&efivars->efi_pstore_info.buf_lock);
879 pstore_register(&efivars->efi_pstore_info);
883 static void efivar_pstore_register(struct efivars *efivars)
889 static ssize_t efivar_create(struct file *filp, struct kobject *kobj,
890 struct bin_attribute *bin_attr,
891 char *buf, loff_t pos, size_t count)
893 struct efi_variable *new_var = (struct efi_variable *)buf;
894 struct efivars *efivars = bin_attr->private;
895 struct efivar_entry *search_efivar, *n;
896 unsigned long strsize1, strsize2;
897 efi_status_t status = EFI_NOT_FOUND;
900 if (!capable(CAP_SYS_ADMIN))
903 if ((new_var->Attributes & ~EFI_VARIABLE_MASK) != 0 ||
904 validate_var(new_var, new_var->Data, new_var->DataSize) == false) {
905 printk(KERN_ERR "efivars: Malformed variable content\n");
909 spin_lock_irq(&efivars->lock);
912 * Does this variable already exist?
914 list_for_each_entry_safe(search_efivar, n, &efivars->list, list) {
915 strsize1 = utf16_strsize(search_efivar->var.VariableName, 1024);
916 strsize2 = utf16_strsize(new_var->VariableName, 1024);
917 if (strsize1 == strsize2 &&
918 !memcmp(&(search_efivar->var.VariableName),
919 new_var->VariableName, strsize1) &&
920 !efi_guidcmp(search_efivar->var.VendorGuid,
921 new_var->VendorGuid)) {
927 spin_unlock_irq(&efivars->lock);
931 status = check_var_size_locked(efivars, new_var->Attributes,
932 new_var->DataSize + utf16_strsize(new_var->VariableName, 1024));
934 if (status && status != EFI_UNSUPPORTED) {
935 spin_unlock_irq(&efivars->lock);
936 return efi_status_to_err(status);
939 /* now *really* create the variable via EFI */
940 status = efivars->ops->set_variable(new_var->VariableName,
941 &new_var->VendorGuid,
946 if (status != EFI_SUCCESS) {
947 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
949 spin_unlock_irq(&efivars->lock);
952 spin_unlock_irq(&efivars->lock);
954 /* Create the entry in sysfs. Locking is not required here */
955 status = efivar_create_sysfs_entry(efivars,
956 utf16_strsize(new_var->VariableName,
958 new_var->VariableName,
959 &new_var->VendorGuid);
961 printk(KERN_WARNING "efivars: variable created, but sysfs entry wasn't.\n");
966 static ssize_t efivar_delete(struct file *filp, struct kobject *kobj,
967 struct bin_attribute *bin_attr,
968 char *buf, loff_t pos, size_t count)
970 struct efi_variable *del_var = (struct efi_variable *)buf;
971 struct efivars *efivars = bin_attr->private;
972 struct efivar_entry *search_efivar, *n;
973 unsigned long strsize1, strsize2;
974 efi_status_t status = EFI_NOT_FOUND;
977 if (!capable(CAP_SYS_ADMIN))
980 spin_lock_irq(&efivars->lock);
983 * Does this variable already exist?
985 list_for_each_entry_safe(search_efivar, n, &efivars->list, list) {
986 strsize1 = utf16_strsize(search_efivar->var.VariableName, 1024);
987 strsize2 = utf16_strsize(del_var->VariableName, 1024);
988 if (strsize1 == strsize2 &&
989 !memcmp(&(search_efivar->var.VariableName),
990 del_var->VariableName, strsize1) &&
991 !efi_guidcmp(search_efivar->var.VendorGuid,
992 del_var->VendorGuid)) {
998 spin_unlock_irq(&efivars->lock);
1001 /* force the Attributes/DataSize to 0 to ensure deletion */
1002 del_var->Attributes = 0;
1003 del_var->DataSize = 0;
1005 status = efivars->ops->set_variable(del_var->VariableName,
1006 &del_var->VendorGuid,
1007 del_var->Attributes,
1011 if (status != EFI_SUCCESS) {
1012 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
1014 spin_unlock_irq(&efivars->lock);
1017 list_del(&search_efivar->list);
1018 /* We need to release this lock before unregistering. */
1019 spin_unlock_irq(&efivars->lock);
1020 efivar_unregister(search_efivar);
1022 /* It's dead Jim.... */
1026 static bool variable_is_present(efi_char16_t *variable_name, efi_guid_t *vendor)
1028 struct efivar_entry *entry, *n;
1029 struct efivars *efivars = &__efivars;
1030 unsigned long strsize1, strsize2;
1033 strsize1 = utf16_strsize(variable_name, 1024);
1034 list_for_each_entry_safe(entry, n, &efivars->list, list) {
1035 strsize2 = utf16_strsize(entry->var.VariableName, 1024);
1036 if (strsize1 == strsize2 &&
1037 !memcmp(variable_name, &(entry->var.VariableName),
1039 !efi_guidcmp(entry->var.VendorGuid,
1049 * Returns the size of variable_name, in bytes, including the
1050 * terminating NULL character, or variable_name_size if no NULL
1051 * character is found among the first variable_name_size bytes.
1053 static unsigned long var_name_strnsize(efi_char16_t *variable_name,
1054 unsigned long variable_name_size)
1060 * The variable name is, by definition, a NULL-terminated
1061 * string, so make absolutely sure that variable_name_size is
1062 * the value we expect it to be. If not, return the real size.
1064 for (len = 2; len <= variable_name_size; len += sizeof(c)) {
1065 c = variable_name[(len / sizeof(c)) - 1];
1070 return min(len, variable_name_size);
1073 static void efivar_update_sysfs_entries(struct work_struct *work)
1075 struct efivars *efivars = &__efivars;
1077 efi_char16_t *variable_name;
1078 unsigned long variable_name_size = 1024;
1079 efi_status_t status = EFI_NOT_FOUND;
1082 /* Add new sysfs entries */
1084 variable_name = kzalloc(variable_name_size, GFP_KERNEL);
1085 if (!variable_name) {
1086 pr_err("efivars: Memory allocation failed.\n");
1090 spin_lock_irq(&efivars->lock);
1093 variable_name_size = 1024;
1094 status = efivars->ops->get_next_variable(
1095 &variable_name_size,
1098 if (status != EFI_SUCCESS) {
1101 if (!variable_is_present(variable_name,
1108 spin_unlock_irq(&efivars->lock);
1111 kfree(variable_name);
1114 variable_name_size = var_name_strnsize(variable_name,
1115 variable_name_size);
1116 efivar_create_sysfs_entry(efivars,
1118 variable_name, &vendor);
1124 * Let's not leave out systab information that snuck into
1125 * the efivars driver
1127 static ssize_t systab_show(struct kobject *kobj,
1128 struct kobj_attribute *attr, char *buf)
1135 if (efi.mps != EFI_INVALID_TABLE_ADDR)
1136 str += sprintf(str, "MPS=0x%lx\n", efi.mps);
1137 if (efi.acpi20 != EFI_INVALID_TABLE_ADDR)
1138 str += sprintf(str, "ACPI20=0x%lx\n", efi.acpi20);
1139 if (efi.acpi != EFI_INVALID_TABLE_ADDR)
1140 str += sprintf(str, "ACPI=0x%lx\n", efi.acpi);
1141 if (efi.smbios != EFI_INVALID_TABLE_ADDR)
1142 str += sprintf(str, "SMBIOS=0x%lx\n", efi.smbios);
1143 if (efi.hcdp != EFI_INVALID_TABLE_ADDR)
1144 str += sprintf(str, "HCDP=0x%lx\n", efi.hcdp);
1145 if (efi.boot_info != EFI_INVALID_TABLE_ADDR)
1146 str += sprintf(str, "BOOTINFO=0x%lx\n", efi.boot_info);
1147 if (efi.uga != EFI_INVALID_TABLE_ADDR)
1148 str += sprintf(str, "UGA=0x%lx\n", efi.uga);
1153 static struct kobj_attribute efi_attr_systab =
1154 __ATTR(systab, 0400, systab_show, NULL);
1156 static struct attribute *efi_subsys_attrs[] = {
1157 &efi_attr_systab.attr,
1158 NULL, /* maybe more in the future? */
1161 static struct attribute_group efi_subsys_attr_group = {
1162 .attrs = efi_subsys_attrs,
1165 static struct kobject *efi_kobj;
1168 * efivar_create_sysfs_entry()
1170 * variable_name_size = number of bytes required to hold
1171 * variable_name (not counting the NULL
1172 * character at the end.
1173 * efivars->lock is not held on entry or exit.
1174 * Returns 1 on failure, 0 on success
1177 efivar_create_sysfs_entry(struct efivars *efivars,
1178 unsigned long variable_name_size,
1179 efi_char16_t *variable_name,
1180 efi_guid_t *vendor_guid)
1182 int i, short_name_size = variable_name_size / sizeof(efi_char16_t) + 38;
1184 struct efivar_entry *new_efivar;
1186 short_name = kzalloc(short_name_size + 1, GFP_KERNEL);
1187 new_efivar = kzalloc(sizeof(struct efivar_entry), GFP_KERNEL);
1189 if (!short_name || !new_efivar) {
1195 new_efivar->efivars = efivars;
1196 memcpy(new_efivar->var.VariableName, variable_name,
1197 variable_name_size);
1198 memcpy(&(new_efivar->var.VendorGuid), vendor_guid, sizeof(efi_guid_t));
1200 /* Convert Unicode to normal chars (assume top bits are 0),
1202 for (i=0; i < (int)(variable_name_size / sizeof(efi_char16_t)); i++) {
1203 short_name[i] = variable_name[i] & 0xFF;
1205 /* This is ugly, but necessary to separate one vendor's
1206 private variables from another's. */
1208 *(short_name + strlen(short_name)) = '-';
1209 efi_guid_unparse(vendor_guid, short_name + strlen(short_name));
1211 new_efivar->kobj.kset = efivars->kset;
1212 i = kobject_init_and_add(&new_efivar->kobj, &efivar_ktype, NULL,
1220 kobject_uevent(&new_efivar->kobj, KOBJ_ADD);
1224 spin_lock_irq(&efivars->lock);
1225 list_add(&new_efivar->list, &efivars->list);
1226 spin_unlock_irq(&efivars->lock);
1232 create_efivars_bin_attributes(struct efivars *efivars)
1234 struct bin_attribute *attr;
1238 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
1242 attr->attr.name = "new_var";
1243 attr->attr.mode = 0200;
1244 attr->write = efivar_create;
1245 attr->private = efivars;
1246 efivars->new_var = attr;
1249 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
1254 attr->attr.name = "del_var";
1255 attr->attr.mode = 0200;
1256 attr->write = efivar_delete;
1257 attr->private = efivars;
1258 efivars->del_var = attr;
1260 sysfs_bin_attr_init(efivars->new_var);
1261 sysfs_bin_attr_init(efivars->del_var);
1264 error = sysfs_create_bin_file(&efivars->kset->kobj,
1267 printk(KERN_ERR "efivars: unable to create new_var sysfs file"
1268 " due to error %d\n", error);
1271 error = sysfs_create_bin_file(&efivars->kset->kobj,
1274 printk(KERN_ERR "efivars: unable to create del_var sysfs file"
1275 " due to error %d\n", error);
1276 sysfs_remove_bin_file(&efivars->kset->kobj,
1283 kfree(efivars->del_var);
1284 efivars->del_var = NULL;
1285 kfree(efivars->new_var);
1286 efivars->new_var = NULL;
1290 void unregister_efivars(struct efivars *efivars)
1292 struct efivar_entry *entry, *n;
1294 list_for_each_entry_safe(entry, n, &efivars->list, list) {
1295 spin_lock_irq(&efivars->lock);
1296 list_del(&entry->list);
1297 spin_unlock_irq(&efivars->lock);
1298 efivar_unregister(entry);
1300 if (efivars->new_var)
1301 sysfs_remove_bin_file(&efivars->kset->kobj, efivars->new_var);
1302 if (efivars->del_var)
1303 sysfs_remove_bin_file(&efivars->kset->kobj, efivars->del_var);
1304 kfree(efivars->new_var);
1305 kfree(efivars->del_var);
1306 kset_unregister(efivars->kset);
1308 EXPORT_SYMBOL_GPL(unregister_efivars);
1311 * Print a warning when duplicate EFI variables are encountered and
1312 * disable the sysfs workqueue since the firmware is buggy.
1314 static void dup_variable_bug(efi_char16_t *s16, efi_guid_t *vendor_guid,
1315 unsigned long len16)
1317 size_t i, len8 = len16 / sizeof(efi_char16_t);
1321 * Disable the workqueue since the algorithm it uses for
1322 * detecting new variables won't work with this buggy
1323 * implementation of GetNextVariableName().
1325 efivar_wq_enabled = false;
1327 s8 = kzalloc(len8, GFP_KERNEL);
1331 for (i = 0; i < len8; i++)
1334 printk(KERN_WARNING "efivars: duplicate variable: %s-%pUl\n",
1339 int register_efivars(struct efivars *efivars,
1340 const struct efivar_operations *ops,
1341 struct kobject *parent_kobj)
1343 efi_status_t status = EFI_NOT_FOUND;
1344 efi_guid_t vendor_guid;
1345 efi_char16_t *variable_name;
1346 unsigned long variable_name_size = 1024;
1349 variable_name = kzalloc(variable_name_size, GFP_KERNEL);
1350 if (!variable_name) {
1351 printk(KERN_ERR "efivars: Memory allocation failed.\n");
1355 spin_lock_init(&efivars->lock);
1356 INIT_LIST_HEAD(&efivars->list);
1359 efivars->kset = kset_create_and_add("vars", NULL, parent_kobj);
1360 if (!efivars->kset) {
1361 printk(KERN_ERR "efivars: Subsystem registration failed.\n");
1367 * Per EFI spec, the maximum storage allocated for both
1368 * the variable name and variable data is 1024 bytes.
1372 variable_name_size = 1024;
1374 status = ops->get_next_variable(&variable_name_size,
1379 variable_name_size = var_name_strnsize(variable_name,
1380 variable_name_size);
1383 * Some firmware implementations return the
1384 * same variable name on multiple calls to
1385 * get_next_variable(). Terminate the loop
1386 * immediately as there is no guarantee that
1387 * we'll ever see a different variable name,
1388 * and may end up looping here forever.
1390 if (variable_is_present(variable_name, &vendor_guid)) {
1391 dup_variable_bug(variable_name, &vendor_guid,
1392 variable_name_size);
1393 status = EFI_NOT_FOUND;
1397 efivar_create_sysfs_entry(efivars,
1405 printk(KERN_WARNING "efivars: get_next_variable: status=%lx\n",
1407 status = EFI_NOT_FOUND;
1410 } while (status != EFI_NOT_FOUND);
1412 error = create_efivars_bin_attributes(efivars);
1414 unregister_efivars(efivars);
1416 if (!efivars_pstore_disable)
1417 efivar_pstore_register(efivars);
1420 kfree(variable_name);
1424 EXPORT_SYMBOL_GPL(register_efivars);
1426 static struct efivar_operations ops;
1429 * For now we register the efi subsystem with the firmware subsystem
1430 * and the vars subsystem with the efi subsystem. In the future, it
1431 * might make sense to split off the efi subsystem into its own
1432 * driver, but for now only efivars will register with it, so just
1441 printk(KERN_INFO "EFI Variables Facility v%s %s\n", EFIVARS_VERSION,
1444 if (!efi_enabled(EFI_RUNTIME_SERVICES))
1447 /* For now we'll register the efi directory at /sys/firmware/efi */
1448 efi_kobj = kobject_create_and_add("efi", firmware_kobj);
1450 printk(KERN_ERR "efivars: Firmware registration failed.\n");
1454 ops.get_variable = efi.get_variable;
1455 ops.set_variable = efi.set_variable;
1456 ops.get_next_variable = efi.get_next_variable;
1457 ops.query_variable_info = efi.query_variable_info;
1458 error = register_efivars(&__efivars, &ops, efi_kobj);
1462 /* Don't forget the systab entry */
1463 error = sysfs_create_group(efi_kobj, &efi_subsys_attr_group);
1466 "efivars: Sysfs attribute export failed with error %d.\n",
1468 goto err_unregister;
1474 unregister_efivars(&__efivars);
1476 kobject_put(efi_kobj);
1483 cancel_work_sync(&efivar_work);
1485 if (efi_enabled(EFI_RUNTIME_SERVICES)) {
1486 unregister_efivars(&__efivars);
1487 kobject_put(efi_kobj);
1491 module_init(efivars_init);
1492 module_exit(efivars_exit);