2 * Originally from 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_to_str()
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/efi.h>
69 #include <linux/module.h>
70 #include <linux/slab.h>
71 #include <linux/ucs2_string.h>
72 #include <linux/compat.h>
74 #define EFIVARS_VERSION "0.08"
75 #define EFIVARS_DATE "2004-May-17"
77 MODULE_AUTHOR("Matt Domsch <Matt_Domsch@Dell.com>");
78 MODULE_DESCRIPTION("sysfs interface to EFI Variables");
79 MODULE_LICENSE("GPL");
80 MODULE_VERSION(EFIVARS_VERSION);
81 MODULE_ALIAS("platform:efivars");
83 LIST_HEAD(efivar_sysfs_list);
84 EXPORT_SYMBOL_GPL(efivar_sysfs_list);
86 static struct kset *efivars_kset;
88 static struct bin_attribute *efivars_new_var;
89 static struct bin_attribute *efivars_del_var;
91 struct compat_efi_variable {
92 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
93 efi_guid_t VendorGuid;
100 struct efivar_attribute {
101 struct attribute attr;
102 ssize_t (*show) (struct efivar_entry *entry, char *buf);
103 ssize_t (*store)(struct efivar_entry *entry, const char *buf, size_t count);
106 #define EFIVAR_ATTR(_name, _mode, _show, _store) \
107 struct efivar_attribute efivar_attr_##_name = { \
108 .attr = {.name = __stringify(_name), .mode = _mode}, \
113 #define to_efivar_attr(_attr) container_of(_attr, struct efivar_attribute, attr)
114 #define to_efivar_entry(obj) container_of(obj, struct efivar_entry, kobj)
117 * Prototype for sysfs creation function
120 efivar_create_sysfs_entry(struct efivar_entry *new_var);
123 efivar_guid_read(struct efivar_entry *entry, char *buf)
125 struct efi_variable *var = &entry->var;
131 efi_guid_to_str(&var->VendorGuid, str);
133 str += sprintf(str, "\n");
139 efivar_attr_read(struct efivar_entry *entry, char *buf)
141 struct efi_variable *var = &entry->var;
142 unsigned long size = sizeof(var->Data);
149 ret = efivar_entry_get(entry, &var->Attributes, &size, var->Data);
150 var->DataSize = size;
154 if (var->Attributes & EFI_VARIABLE_NON_VOLATILE)
155 str += sprintf(str, "EFI_VARIABLE_NON_VOLATILE\n");
156 if (var->Attributes & EFI_VARIABLE_BOOTSERVICE_ACCESS)
157 str += sprintf(str, "EFI_VARIABLE_BOOTSERVICE_ACCESS\n");
158 if (var->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)
159 str += sprintf(str, "EFI_VARIABLE_RUNTIME_ACCESS\n");
160 if (var->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD)
161 str += sprintf(str, "EFI_VARIABLE_HARDWARE_ERROR_RECORD\n");
162 if (var->Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)
164 "EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\n");
165 if (var->Attributes &
166 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)
168 "EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS\n");
169 if (var->Attributes & EFI_VARIABLE_APPEND_WRITE)
170 str += sprintf(str, "EFI_VARIABLE_APPEND_WRITE\n");
175 efivar_size_read(struct efivar_entry *entry, char *buf)
177 struct efi_variable *var = &entry->var;
178 unsigned long size = sizeof(var->Data);
185 ret = efivar_entry_get(entry, &var->Attributes, &size, var->Data);
186 var->DataSize = size;
190 str += sprintf(str, "0x%lx\n", var->DataSize);
195 efivar_data_read(struct efivar_entry *entry, char *buf)
197 struct efi_variable *var = &entry->var;
198 unsigned long size = sizeof(var->Data);
204 ret = efivar_entry_get(entry, &var->Attributes, &size, var->Data);
205 var->DataSize = size;
209 memcpy(buf, var->Data, var->DataSize);
210 return var->DataSize;
214 sanity_check(struct efi_variable *var, efi_char16_t *name, efi_guid_t vendor,
215 unsigned long size, u32 attributes, u8 *data)
218 * If only updating the variable data, then the name
219 * and guid should remain the same
221 if (memcmp(name, var->VariableName, sizeof(var->VariableName)) ||
222 efi_guidcmp(vendor, var->VendorGuid)) {
223 printk(KERN_ERR "efivars: Cannot edit the wrong variable!\n");
227 if ((size <= 0) || (attributes == 0)){
228 printk(KERN_ERR "efivars: DataSize & Attributes must be valid!\n");
232 if ((attributes & ~EFI_VARIABLE_MASK) != 0 ||
233 efivar_validate(vendor, name, data, size) == false) {
234 printk(KERN_ERR "efivars: Malformed variable content\n");
241 static inline bool is_compat(void)
243 if (IS_ENABLED(CONFIG_COMPAT) && in_compat_syscall())
250 copy_out_compat(struct efi_variable *dst, struct compat_efi_variable *src)
252 memcpy(dst->VariableName, src->VariableName, EFI_VAR_NAME_LEN);
253 memcpy(dst->Data, src->Data, sizeof(src->Data));
255 dst->VendorGuid = src->VendorGuid;
256 dst->DataSize = src->DataSize;
257 dst->Attributes = src->Attributes;
261 * We allow each variable to be edited via rewriting the
262 * entire efi variable structure.
265 efivar_store_raw(struct efivar_entry *entry, const char *buf, size_t count)
267 struct efi_variable *new_var, *var = &entry->var;
279 struct compat_efi_variable *compat;
281 if (count != sizeof(*compat))
284 compat = (struct compat_efi_variable *)buf;
285 attributes = compat->Attributes;
286 vendor = compat->VendorGuid;
287 name = compat->VariableName;
288 size = compat->DataSize;
291 err = sanity_check(var, name, vendor, size, attributes, data);
295 copy_out_compat(&entry->var, compat);
297 if (count != sizeof(struct efi_variable))
300 new_var = (struct efi_variable *)buf;
302 attributes = new_var->Attributes;
303 vendor = new_var->VendorGuid;
304 name = new_var->VariableName;
305 size = new_var->DataSize;
306 data = new_var->Data;
308 err = sanity_check(var, name, vendor, size, attributes, data);
312 memcpy(&entry->var, new_var, count);
315 err = efivar_entry_set(entry, attributes, size, data, NULL);
317 printk(KERN_WARNING "efivars: set_variable() failed: status=%d\n", err);
325 efivar_show_raw(struct efivar_entry *entry, char *buf)
327 struct efi_variable *var = &entry->var;
328 struct compat_efi_variable *compat;
329 unsigned long datasize = sizeof(var->Data);
336 ret = efivar_entry_get(entry, &var->Attributes, &datasize, var->Data);
337 var->DataSize = datasize;
342 compat = (struct compat_efi_variable *)buf;
344 size = sizeof(*compat);
345 memcpy(compat->VariableName, var->VariableName,
347 memcpy(compat->Data, var->Data, sizeof(compat->Data));
349 compat->VendorGuid = var->VendorGuid;
350 compat->DataSize = var->DataSize;
351 compat->Attributes = var->Attributes;
354 memcpy(buf, var, size);
361 * Generic read/write functions that call the specific functions of
364 static ssize_t efivar_attr_show(struct kobject *kobj, struct attribute *attr,
367 struct efivar_entry *var = to_efivar_entry(kobj);
368 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
371 if (!capable(CAP_SYS_ADMIN))
374 if (efivar_attr->show) {
375 ret = efivar_attr->show(var, buf);
380 static ssize_t efivar_attr_store(struct kobject *kobj, struct attribute *attr,
381 const char *buf, size_t count)
383 struct efivar_entry *var = to_efivar_entry(kobj);
384 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
387 if (!capable(CAP_SYS_ADMIN))
390 if (efivar_attr->store)
391 ret = efivar_attr->store(var, buf, count);
396 static const struct sysfs_ops efivar_attr_ops = {
397 .show = efivar_attr_show,
398 .store = efivar_attr_store,
401 static void efivar_release(struct kobject *kobj)
403 struct efivar_entry *var = to_efivar_entry(kobj);
407 static EFIVAR_ATTR(guid, 0400, efivar_guid_read, NULL);
408 static EFIVAR_ATTR(attributes, 0400, efivar_attr_read, NULL);
409 static EFIVAR_ATTR(size, 0400, efivar_size_read, NULL);
410 static EFIVAR_ATTR(data, 0400, efivar_data_read, NULL);
411 static EFIVAR_ATTR(raw_var, 0600, efivar_show_raw, efivar_store_raw);
413 static struct attribute *def_attrs[] = {
414 &efivar_attr_guid.attr,
415 &efivar_attr_size.attr,
416 &efivar_attr_attributes.attr,
417 &efivar_attr_data.attr,
418 &efivar_attr_raw_var.attr,
422 static struct kobj_type efivar_ktype = {
423 .release = efivar_release,
424 .sysfs_ops = &efivar_attr_ops,
425 .default_attrs = def_attrs,
428 static ssize_t efivar_create(struct file *filp, struct kobject *kobj,
429 struct bin_attribute *bin_attr,
430 char *buf, loff_t pos, size_t count)
432 struct compat_efi_variable *compat = (struct compat_efi_variable *)buf;
433 struct efi_variable *new_var = (struct efi_variable *)buf;
434 struct efivar_entry *new_entry;
435 bool need_compat = is_compat();
442 if (!capable(CAP_SYS_ADMIN))
446 if (count != sizeof(*compat))
449 attributes = compat->Attributes;
450 name = compat->VariableName;
451 size = compat->DataSize;
454 if (count != sizeof(*new_var))
457 attributes = new_var->Attributes;
458 name = new_var->VariableName;
459 size = new_var->DataSize;
460 data = new_var->Data;
463 if ((attributes & ~EFI_VARIABLE_MASK) != 0 ||
464 efivar_validate(new_var->VendorGuid, name, data,
466 printk(KERN_ERR "efivars: Malformed variable content\n");
470 new_entry = kzalloc(sizeof(*new_entry), GFP_KERNEL);
475 copy_out_compat(&new_entry->var, compat);
477 memcpy(&new_entry->var, new_var, sizeof(*new_var));
479 err = efivar_entry_set(new_entry, attributes, size,
480 data, &efivar_sysfs_list);
487 if (efivar_create_sysfs_entry(new_entry)) {
488 printk(KERN_WARNING "efivars: failed to create sysfs entry.\n");
498 static ssize_t efivar_delete(struct file *filp, struct kobject *kobj,
499 struct bin_attribute *bin_attr,
500 char *buf, loff_t pos, size_t count)
502 struct efi_variable *del_var = (struct efi_variable *)buf;
503 struct compat_efi_variable *compat;
504 struct efivar_entry *entry;
509 if (!capable(CAP_SYS_ADMIN))
513 if (count != sizeof(*compat))
516 compat = (struct compat_efi_variable *)buf;
517 name = compat->VariableName;
518 vendor = compat->VendorGuid;
520 if (count != sizeof(*del_var))
523 name = del_var->VariableName;
524 vendor = del_var->VendorGuid;
527 if (efivar_entry_iter_begin())
529 entry = efivar_entry_find(name, vendor, &efivar_sysfs_list, true);
532 else if (__efivar_entry_delete(entry))
536 efivar_entry_iter_end();
540 if (!entry->scanning) {
541 efivar_entry_iter_end();
542 efivar_unregister(entry);
544 efivar_entry_iter_end();
546 /* It's dead Jim.... */
551 * efivar_create_sysfs_entry - create a new entry in sysfs
552 * @new_var: efivar entry to create
554 * Returns 0 on success, negative error code on failure
557 efivar_create_sysfs_entry(struct efivar_entry *new_var)
561 unsigned long utf8_name_size;
562 efi_char16_t *variable_name = new_var->var.VariableName;
566 * Length of the variable bytes in UTF8, plus the '-' separator,
567 * plus the GUID, plus trailing NUL
569 utf8_name_size = ucs2_utf8size(variable_name);
570 short_name_size = utf8_name_size + 1 + EFI_VARIABLE_GUID_LEN + 1;
572 short_name = kmalloc(short_name_size, GFP_KERNEL);
576 ucs2_as_utf8(short_name, variable_name, short_name_size);
578 /* This is ugly, but necessary to separate one vendor's
579 private variables from another's. */
580 short_name[utf8_name_size] = '-';
581 efi_guid_to_str(&new_var->var.VendorGuid,
582 short_name + utf8_name_size + 1);
584 new_var->kobj.kset = efivars_kset;
586 ret = kobject_init_and_add(&new_var->kobj, &efivar_ktype,
587 NULL, "%s", short_name);
590 kobject_put(&new_var->kobj);
594 kobject_uevent(&new_var->kobj, KOBJ_ADD);
595 if (efivar_entry_add(new_var, &efivar_sysfs_list)) {
596 efivar_unregister(new_var);
604 create_efivars_bin_attributes(void)
606 struct bin_attribute *attr;
610 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
614 attr->attr.name = "new_var";
615 attr->attr.mode = 0200;
616 attr->write = efivar_create;
617 efivars_new_var = attr;
620 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
625 attr->attr.name = "del_var";
626 attr->attr.mode = 0200;
627 attr->write = efivar_delete;
628 efivars_del_var = attr;
630 sysfs_bin_attr_init(efivars_new_var);
631 sysfs_bin_attr_init(efivars_del_var);
634 error = sysfs_create_bin_file(&efivars_kset->kobj, efivars_new_var);
636 printk(KERN_ERR "efivars: unable to create new_var sysfs file"
637 " due to error %d\n", error);
641 error = sysfs_create_bin_file(&efivars_kset->kobj, efivars_del_var);
643 printk(KERN_ERR "efivars: unable to create del_var sysfs file"
644 " due to error %d\n", error);
645 sysfs_remove_bin_file(&efivars_kset->kobj, efivars_new_var);
651 kfree(efivars_del_var);
652 efivars_del_var = NULL;
653 kfree(efivars_new_var);
654 efivars_new_var = NULL;
658 static int efivar_update_sysfs_entry(efi_char16_t *name, efi_guid_t vendor,
659 unsigned long name_size, void *data)
661 struct efivar_entry *entry = data;
663 if (efivar_entry_find(name, vendor, &efivar_sysfs_list, false))
666 memcpy(entry->var.VariableName, name, name_size);
667 memcpy(&(entry->var.VendorGuid), &vendor, sizeof(efi_guid_t));
672 static void efivar_update_sysfs_entries(struct work_struct *work)
674 struct efivar_entry *entry;
677 /* Add new sysfs entries */
679 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
683 err = efivar_init(efivar_update_sysfs_entry, entry,
684 false, &efivar_sysfs_list);
688 efivar_create_sysfs_entry(entry);
694 static int efivars_sysfs_callback(efi_char16_t *name, efi_guid_t vendor,
695 unsigned long name_size, void *data)
697 struct efivar_entry *entry;
699 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
703 memcpy(entry->var.VariableName, name, name_size);
704 memcpy(&(entry->var.VendorGuid), &vendor, sizeof(efi_guid_t));
706 efivar_create_sysfs_entry(entry);
711 static int efivar_sysfs_destroy(struct efivar_entry *entry, void *data)
713 int err = efivar_entry_remove(entry);
717 efivar_unregister(entry);
721 static void efivars_sysfs_exit(void)
723 /* Remove all entries and destroy */
726 err = __efivar_entry_iter(efivar_sysfs_destroy, &efivar_sysfs_list,
729 pr_err("efivars: Failed to destroy sysfs entries\n");
734 sysfs_remove_bin_file(&efivars_kset->kobj, efivars_new_var);
736 sysfs_remove_bin_file(&efivars_kset->kobj, efivars_del_var);
737 kfree(efivars_new_var);
738 kfree(efivars_del_var);
739 kset_unregister(efivars_kset);
742 int efivars_sysfs_init(void)
744 struct kobject *parent_kobj = efivars_kobject();
747 if (!efi_enabled(EFI_RUNTIME_SERVICES))
750 /* No efivars has been registered yet */
754 printk(KERN_INFO "EFI Variables Facility v%s %s\n", EFIVARS_VERSION,
757 efivars_kset = kset_create_and_add("vars", NULL, parent_kobj);
759 printk(KERN_ERR "efivars: Subsystem registration failed.\n");
763 efivar_init(efivars_sysfs_callback, NULL, true, &efivar_sysfs_list);
765 error = create_efivars_bin_attributes();
767 efivars_sysfs_exit();
771 INIT_WORK(&efivar_work, efivar_update_sysfs_entries);
775 EXPORT_SYMBOL_GPL(efivars_sysfs_init);
777 module_init(efivars_sysfs_init);
778 module_exit(efivars_sysfs_exit);