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>
84 #include <linux/ramfs.h>
85 #include <linux/pagemap.h>
87 #include <asm/uaccess.h>
89 #define EFIVARS_VERSION "0.08"
90 #define EFIVARS_DATE "2004-May-17"
92 MODULE_AUTHOR("Matt Domsch <Matt_Domsch@Dell.com>");
93 MODULE_DESCRIPTION("sysfs interface to EFI Variables");
94 MODULE_LICENSE("GPL");
95 MODULE_VERSION(EFIVARS_VERSION);
97 #define DUMP_NAME_LEN 52
100 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
101 * not including trailing NUL
106 * The maximum size of VariableName + Data = 1024
107 * Therefore, it's reasonable to save that much
108 * space in each part of the structure,
109 * and we use a page for reading/writing.
112 struct efi_variable {
113 efi_char16_t VariableName[1024/sizeof(efi_char16_t)];
114 efi_guid_t VendorGuid;
115 unsigned long DataSize;
119 } __attribute__((packed));
121 struct efivar_entry {
122 struct efivars *efivars;
123 struct efi_variable var;
124 struct list_head 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);
134 static struct efivars __efivars;
135 static struct efivar_operations ops;
137 #define PSTORE_EFI_ATTRIBUTES \
138 (EFI_VARIABLE_NON_VOLATILE | \
139 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
140 EFI_VARIABLE_RUNTIME_ACCESS)
142 #define EFIVAR_ATTR(_name, _mode, _show, _store) \
143 struct efivar_attribute efivar_attr_##_name = { \
144 .attr = {.name = __stringify(_name), .mode = _mode}, \
149 #define to_efivar_attr(_attr) container_of(_attr, struct efivar_attribute, attr)
150 #define to_efivar_entry(obj) container_of(obj, struct efivar_entry, kobj)
153 * Prototype for sysfs creation function
156 efivar_create_sysfs_entry(struct efivars *efivars,
157 unsigned long variable_name_size,
158 efi_char16_t *variable_name,
159 efi_guid_t *vendor_guid);
161 /* Return the number of unicode characters in data */
163 utf16_strnlen(efi_char16_t *s, size_t maxlength)
165 unsigned long length = 0;
167 while (*s++ != 0 && length < maxlength)
172 static inline unsigned long
173 utf16_strlen(efi_char16_t *s)
175 return utf16_strnlen(s, ~0UL);
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 utf16_strsize(efi_char16_t *data, unsigned long maxlength)
185 return utf16_strnlen(data, maxlength/sizeof(efi_char16_t)) * sizeof(efi_char16_t);
189 utf16_strncmp(const efi_char16_t *a, const efi_char16_t *b, size_t len)
198 if (*a == 0) /* implies *b == 0 */
207 validate_device_path(struct efi_variable *var, int match, u8 *buffer,
210 struct efi_generic_dev_path *node;
213 node = (struct efi_generic_dev_path *)buffer;
215 if (len < sizeof(*node))
218 while (offset <= len - sizeof(*node) &&
219 node->length >= sizeof(*node) &&
220 node->length <= len - offset) {
221 offset += node->length;
223 if ((node->type == EFI_DEV_END_PATH ||
224 node->type == EFI_DEV_END_PATH2) &&
225 node->sub_type == EFI_DEV_END_ENTIRE)
228 node = (struct efi_generic_dev_path *)(buffer + offset);
232 * If we're here then either node->length pointed past the end
233 * of the buffer or we reached the end of the buffer without
234 * finding a device path end node.
240 validate_boot_order(struct efi_variable *var, int match, u8 *buffer,
243 /* An array of 16-bit integers */
251 validate_load_option(struct efi_variable *var, int match, u8 *buffer,
255 int i, desclength = 0, namelen;
257 namelen = utf16_strnlen(var->VariableName, sizeof(var->VariableName));
259 /* Either "Boot" or "Driver" followed by four digits of hex */
260 for (i = match; i < match+4; i++) {
261 if (var->VariableName[i] > 127 ||
262 hex_to_bin(var->VariableName[i] & 0xff) < 0)
266 /* Reject it if there's 4 digits of hex and then further content */
267 if (namelen > match + 4)
270 /* A valid entry must be at least 8 bytes */
274 filepathlength = buffer[4] | buffer[5] << 8;
277 * There's no stored length for the description, so it has to be
280 desclength = utf16_strsize((efi_char16_t *)(buffer + 6), len - 6) + 2;
282 /* Each boot entry must have a descriptor */
287 * If the sum of the length of the description, the claimed filepath
288 * length and the original header are greater than the length of the
289 * variable, it's malformed
291 if ((desclength + filepathlength + 6) > len)
295 * And, finally, check the filepath
297 return validate_device_path(var, match, buffer + desclength + 6,
302 validate_uint16(struct efi_variable *var, int match, u8 *buffer,
305 /* A single 16-bit integer */
313 validate_ascii_string(struct efi_variable *var, int match, u8 *buffer,
318 for (i = 0; i < len; i++) {
329 struct variable_validate {
331 bool (*validate)(struct efi_variable *var, int match, u8 *data,
335 static const struct variable_validate variable_validate[] = {
336 { "BootNext", validate_uint16 },
337 { "BootOrder", validate_boot_order },
338 { "DriverOrder", validate_boot_order },
339 { "Boot*", validate_load_option },
340 { "Driver*", validate_load_option },
341 { "ConIn", validate_device_path },
342 { "ConInDev", validate_device_path },
343 { "ConOut", validate_device_path },
344 { "ConOutDev", validate_device_path },
345 { "ErrOut", validate_device_path },
346 { "ErrOutDev", validate_device_path },
347 { "Timeout", validate_uint16 },
348 { "Lang", validate_ascii_string },
349 { "PlatformLang", validate_ascii_string },
354 validate_var(struct efi_variable *var, u8 *data, unsigned long len)
357 u16 *unicode_name = var->VariableName;
359 for (i = 0; variable_validate[i].validate != NULL; i++) {
360 const char *name = variable_validate[i].name;
363 for (match = 0; ; match++) {
364 char c = name[match];
365 u16 u = unicode_name[match];
367 /* All special variables are plain ascii */
371 /* Wildcard in the matching name means we've matched */
373 return variable_validate[i].validate(var,
376 /* Case sensitive match */
380 /* Reached the end of the string while matching */
382 return variable_validate[i].validate(var,
391 get_var_data_locked(struct efivars *efivars, struct efi_variable *var)
395 var->DataSize = 1024;
396 status = efivars->ops->get_variable(var->VariableName,
405 get_var_data(struct efivars *efivars, struct efi_variable *var)
409 spin_lock(&efivars->lock);
410 status = get_var_data_locked(efivars, var);
411 spin_unlock(&efivars->lock);
413 if (status != EFI_SUCCESS) {
414 printk(KERN_WARNING "efivars: get_variable() failed 0x%lx!\n",
421 efivar_guid_read(struct efivar_entry *entry, char *buf)
423 struct efi_variable *var = &entry->var;
429 efi_guid_unparse(&var->VendorGuid, str);
431 str += sprintf(str, "\n");
437 efivar_attr_read(struct efivar_entry *entry, char *buf)
439 struct efi_variable *var = &entry->var;
446 status = get_var_data(entry->efivars, var);
447 if (status != EFI_SUCCESS)
450 if (var->Attributes & EFI_VARIABLE_NON_VOLATILE)
451 str += sprintf(str, "EFI_VARIABLE_NON_VOLATILE\n");
452 if (var->Attributes & EFI_VARIABLE_BOOTSERVICE_ACCESS)
453 str += sprintf(str, "EFI_VARIABLE_BOOTSERVICE_ACCESS\n");
454 if (var->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)
455 str += sprintf(str, "EFI_VARIABLE_RUNTIME_ACCESS\n");
456 if (var->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD)
457 str += sprintf(str, "EFI_VARIABLE_HARDWARE_ERROR_RECORD\n");
458 if (var->Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)
460 "EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\n");
461 if (var->Attributes &
462 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)
464 "EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS\n");
465 if (var->Attributes & EFI_VARIABLE_APPEND_WRITE)
466 str += sprintf(str, "EFI_VARIABLE_APPEND_WRITE\n");
471 efivar_size_read(struct efivar_entry *entry, char *buf)
473 struct efi_variable *var = &entry->var;
480 status = get_var_data(entry->efivars, var);
481 if (status != EFI_SUCCESS)
484 str += sprintf(str, "0x%lx\n", var->DataSize);
489 efivar_data_read(struct efivar_entry *entry, char *buf)
491 struct efi_variable *var = &entry->var;
497 status = get_var_data(entry->efivars, var);
498 if (status != EFI_SUCCESS)
501 memcpy(buf, var->Data, var->DataSize);
502 return var->DataSize;
505 * We allow each variable to be edited via rewriting the
506 * entire efi variable structure.
509 efivar_store_raw(struct efivar_entry *entry, const char *buf, size_t count)
511 struct efi_variable *new_var, *var = &entry->var;
512 struct efivars *efivars = entry->efivars;
513 efi_status_t status = EFI_NOT_FOUND;
515 if (count != sizeof(struct efi_variable))
518 new_var = (struct efi_variable *)buf;
520 * If only updating the variable data, then the name
521 * and guid should remain the same
523 if (memcmp(new_var->VariableName, var->VariableName, sizeof(var->VariableName)) ||
524 efi_guidcmp(new_var->VendorGuid, var->VendorGuid)) {
525 printk(KERN_ERR "efivars: Cannot edit the wrong variable!\n");
529 if ((new_var->DataSize <= 0) || (new_var->Attributes == 0)){
530 printk(KERN_ERR "efivars: DataSize & Attributes must be valid!\n");
534 if ((new_var->Attributes & ~EFI_VARIABLE_MASK) != 0 ||
535 validate_var(new_var, new_var->Data, new_var->DataSize) == false) {
536 printk(KERN_ERR "efivars: Malformed variable content\n");
540 spin_lock(&efivars->lock);
541 status = efivars->ops->set_variable(new_var->VariableName,
542 &new_var->VendorGuid,
547 spin_unlock(&efivars->lock);
549 if (status != EFI_SUCCESS) {
550 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
555 memcpy(&entry->var, new_var, count);
560 efivar_show_raw(struct efivar_entry *entry, char *buf)
562 struct efi_variable *var = &entry->var;
568 status = get_var_data(entry->efivars, var);
569 if (status != EFI_SUCCESS)
572 memcpy(buf, var, sizeof(*var));
577 * Generic read/write functions that call the specific functions of
580 static ssize_t efivar_attr_show(struct kobject *kobj, struct attribute *attr,
583 struct efivar_entry *var = to_efivar_entry(kobj);
584 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
587 if (!capable(CAP_SYS_ADMIN))
590 if (efivar_attr->show) {
591 ret = efivar_attr->show(var, buf);
596 static ssize_t efivar_attr_store(struct kobject *kobj, struct attribute *attr,
597 const char *buf, size_t count)
599 struct efivar_entry *var = to_efivar_entry(kobj);
600 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
603 if (!capable(CAP_SYS_ADMIN))
606 if (efivar_attr->store)
607 ret = efivar_attr->store(var, buf, count);
612 static const struct sysfs_ops efivar_attr_ops = {
613 .show = efivar_attr_show,
614 .store = efivar_attr_store,
617 static void efivar_release(struct kobject *kobj)
619 struct efivar_entry *var = container_of(kobj, struct efivar_entry, kobj);
623 static EFIVAR_ATTR(guid, 0400, efivar_guid_read, NULL);
624 static EFIVAR_ATTR(attributes, 0400, efivar_attr_read, NULL);
625 static EFIVAR_ATTR(size, 0400, efivar_size_read, NULL);
626 static EFIVAR_ATTR(data, 0400, efivar_data_read, NULL);
627 static EFIVAR_ATTR(raw_var, 0600, efivar_show_raw, efivar_store_raw);
629 static struct attribute *def_attrs[] = {
630 &efivar_attr_guid.attr,
631 &efivar_attr_size.attr,
632 &efivar_attr_attributes.attr,
633 &efivar_attr_data.attr,
634 &efivar_attr_raw_var.attr,
638 static struct kobj_type efivar_ktype = {
639 .release = efivar_release,
640 .sysfs_ops = &efivar_attr_ops,
641 .default_attrs = def_attrs,
645 efivar_unregister(struct efivar_entry *var)
647 kobject_put(&var->kobj);
650 static int efivarfs_file_open(struct inode *inode, struct file *file)
652 file->private_data = inode->i_private;
656 static int efi_status_to_err(efi_status_t status)
661 case EFI_INVALID_PARAMETER:
664 case EFI_OUT_OF_RESOURCES:
667 case EFI_DEVICE_ERROR:
670 case EFI_WRITE_PROTECTED:
673 case EFI_SECURITY_VIOLATION:
686 static ssize_t efivarfs_file_write(struct file *file,
687 const char __user *userbuf, size_t count, loff_t *ppos)
689 struct efivar_entry *var = file->private_data;
690 struct efivars *efivars;
694 struct inode *inode = file->f_mapping->host;
695 unsigned long datasize = count - sizeof(attributes);
696 unsigned long newdatasize;
697 u64 storage_size, remaining_size, max_size;
700 if (count < sizeof(attributes))
703 if (copy_from_user(&attributes, userbuf, sizeof(attributes)))
706 if (attributes & ~(EFI_VARIABLE_MASK))
709 efivars = var->efivars;
712 * Ensure that the user can't allocate arbitrarily large
713 * amounts of memory. Pick a default size of 64K if
714 * QueryVariableInfo() isn't supported by the firmware.
716 spin_lock(&efivars->lock);
718 if (!efivars->ops->query_variable_info)
719 status = EFI_UNSUPPORTED;
721 const struct efivar_operations *fops = efivars->ops;
722 status = fops->query_variable_info(attributes, &storage_size,
723 &remaining_size, &max_size);
726 spin_unlock(&efivars->lock);
728 if (status != EFI_SUCCESS) {
729 if (status != EFI_UNSUPPORTED)
730 return efi_status_to_err(status);
732 remaining_size = 65536;
735 if (datasize > remaining_size)
738 data = kmalloc(datasize, GFP_KERNEL);
742 if (copy_from_user(data, userbuf + sizeof(attributes), datasize)) {
747 if (validate_var(&var->var, data, datasize) == false) {
753 * The lock here protects the get_variable call, the conditional
754 * set_variable call, and removal of the variable from the efivars
755 * list (in the case of an authenticated delete).
757 spin_lock(&efivars->lock);
759 status = efivars->ops->set_variable(var->var.VariableName,
760 &var->var.VendorGuid,
761 attributes, datasize,
764 if (status != EFI_SUCCESS) {
765 spin_unlock(&efivars->lock);
768 return efi_status_to_err(status);
774 * Writing to the variable may have caused a change in size (which
775 * could either be an append or an overwrite), or the variable to be
776 * deleted. Perform a GetVariable() so we can tell what actually
780 status = efivars->ops->get_variable(var->var.VariableName,
781 &var->var.VendorGuid,
785 if (status == EFI_BUFFER_TOO_SMALL) {
786 spin_unlock(&efivars->lock);
787 mutex_lock(&inode->i_mutex);
788 i_size_write(inode, newdatasize + sizeof(attributes));
789 mutex_unlock(&inode->i_mutex);
791 } else if (status == EFI_NOT_FOUND) {
792 list_del(&var->list);
793 spin_unlock(&efivars->lock);
794 efivar_unregister(var);
796 d_delete(file->f_dentry);
797 dput(file->f_dentry);
800 spin_unlock(&efivars->lock);
801 pr_warn("efivarfs: inconsistent EFI variable implementation? "
802 "status = %lx\n", status);
811 static ssize_t efivarfs_file_read(struct file *file, char __user *userbuf,
812 size_t count, loff_t *ppos)
814 struct efivar_entry *var = file->private_data;
815 struct efivars *efivars = var->efivars;
817 unsigned long datasize = 0;
822 spin_lock(&efivars->lock);
823 status = efivars->ops->get_variable(var->var.VariableName,
824 &var->var.VendorGuid,
825 &attributes, &datasize, NULL);
826 spin_unlock(&efivars->lock);
828 if (status != EFI_BUFFER_TOO_SMALL)
829 return efi_status_to_err(status);
831 data = kmalloc(datasize + sizeof(attributes), GFP_KERNEL);
836 spin_lock(&efivars->lock);
837 status = efivars->ops->get_variable(var->var.VariableName,
838 &var->var.VendorGuid,
839 &attributes, &datasize,
840 (data + sizeof(attributes)));
841 spin_unlock(&efivars->lock);
843 if (status != EFI_SUCCESS) {
844 size = efi_status_to_err(status);
848 memcpy(data, &attributes, sizeof(attributes));
849 size = simple_read_from_buffer(userbuf, count, ppos,
850 data, datasize + sizeof(attributes));
857 static void efivarfs_evict_inode(struct inode *inode)
862 static const struct super_operations efivarfs_ops = {
863 .statfs = simple_statfs,
864 .drop_inode = generic_delete_inode,
865 .evict_inode = efivarfs_evict_inode,
866 .show_options = generic_show_options,
869 static struct super_block *efivarfs_sb;
871 static const struct inode_operations efivarfs_dir_inode_operations;
873 static const struct file_operations efivarfs_file_operations = {
874 .open = efivarfs_file_open,
875 .read = efivarfs_file_read,
876 .write = efivarfs_file_write,
880 static struct inode *efivarfs_get_inode(struct super_block *sb,
881 const struct inode *dir, int mode, dev_t dev)
883 struct inode *inode = new_inode(sb);
886 inode->i_ino = get_next_ino();
887 inode->i_mode = mode;
888 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
889 switch (mode & S_IFMT) {
891 inode->i_fop = &efivarfs_file_operations;
894 inode->i_op = &efivarfs_dir_inode_operations;
895 inode->i_fop = &simple_dir_operations;
903 static void efivarfs_hex_to_guid(const char *str, efi_guid_t *guid)
905 guid->b[0] = hex_to_bin(str[6]) << 4 | hex_to_bin(str[7]);
906 guid->b[1] = hex_to_bin(str[4]) << 4 | hex_to_bin(str[5]);
907 guid->b[2] = hex_to_bin(str[2]) << 4 | hex_to_bin(str[3]);
908 guid->b[3] = hex_to_bin(str[0]) << 4 | hex_to_bin(str[1]);
909 guid->b[4] = hex_to_bin(str[11]) << 4 | hex_to_bin(str[12]);
910 guid->b[5] = hex_to_bin(str[9]) << 4 | hex_to_bin(str[10]);
911 guid->b[6] = hex_to_bin(str[16]) << 4 | hex_to_bin(str[17]);
912 guid->b[7] = hex_to_bin(str[14]) << 4 | hex_to_bin(str[15]);
913 guid->b[8] = hex_to_bin(str[19]) << 4 | hex_to_bin(str[20]);
914 guid->b[9] = hex_to_bin(str[21]) << 4 | hex_to_bin(str[22]);
915 guid->b[10] = hex_to_bin(str[24]) << 4 | hex_to_bin(str[25]);
916 guid->b[11] = hex_to_bin(str[26]) << 4 | hex_to_bin(str[27]);
917 guid->b[12] = hex_to_bin(str[28]) << 4 | hex_to_bin(str[29]);
918 guid->b[13] = hex_to_bin(str[30]) << 4 | hex_to_bin(str[31]);
919 guid->b[14] = hex_to_bin(str[32]) << 4 | hex_to_bin(str[33]);
920 guid->b[15] = hex_to_bin(str[34]) << 4 | hex_to_bin(str[35]);
923 static int efivarfs_create(struct inode *dir, struct dentry *dentry,
924 umode_t mode, bool excl)
927 struct efivars *efivars = &__efivars;
928 struct efivar_entry *var;
929 int namelen, i = 0, err = 0;
932 * We need a GUID, plus at least one letter for the variable name,
933 * plus the '-' separator
935 if (dentry->d_name.len < GUID_LEN + 2)
938 inode = efivarfs_get_inode(dir->i_sb, dir, mode, 0);
942 var = kzalloc(sizeof(struct efivar_entry), GFP_KERNEL);
948 /* length of the variable name itself: remove GUID and separator */
949 namelen = dentry->d_name.len - GUID_LEN - 1;
951 efivarfs_hex_to_guid(dentry->d_name.name + namelen + 1,
952 &var->var.VendorGuid);
954 for (i = 0; i < namelen; i++)
955 var->var.VariableName[i] = dentry->d_name.name[i];
957 var->var.VariableName[i] = '\0';
959 inode->i_private = var;
960 var->efivars = efivars;
961 var->kobj.kset = efivars->kset;
963 err = kobject_init_and_add(&var->kobj, &efivar_ktype, NULL, "%s",
964 dentry->d_name.name);
968 kobject_uevent(&var->kobj, KOBJ_ADD);
969 spin_lock(&efivars->lock);
970 list_add(&var->list, &efivars->list);
971 spin_unlock(&efivars->lock);
972 d_instantiate(dentry, inode);
982 static int efivarfs_unlink(struct inode *dir, struct dentry *dentry)
984 struct efivar_entry *var = dentry->d_inode->i_private;
985 struct efivars *efivars = var->efivars;
988 spin_lock(&efivars->lock);
990 status = efivars->ops->set_variable(var->var.VariableName,
991 &var->var.VendorGuid,
994 if (status == EFI_SUCCESS || status == EFI_NOT_FOUND) {
995 list_del(&var->list);
996 spin_unlock(&efivars->lock);
997 efivar_unregister(var);
998 drop_nlink(dentry->d_inode);
1003 spin_unlock(&efivars->lock);
1007 static int efivarfs_fill_super(struct super_block *sb, void *data, int silent)
1009 struct inode *inode = NULL;
1010 struct dentry *root;
1011 struct efivar_entry *entry, *n;
1012 struct efivars *efivars = &__efivars;
1017 sb->s_maxbytes = MAX_LFS_FILESIZE;
1018 sb->s_blocksize = PAGE_CACHE_SIZE;
1019 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
1020 sb->s_magic = EFIVARFS_MAGIC;
1021 sb->s_op = &efivarfs_ops;
1022 sb->s_time_gran = 1;
1024 inode = efivarfs_get_inode(sb, NULL, S_IFDIR | 0755, 0);
1027 inode->i_op = &efivarfs_dir_inode_operations;
1029 root = d_make_root(inode);
1034 list_for_each_entry_safe(entry, n, &efivars->list, list) {
1035 struct dentry *dentry, *root = efivarfs_sb->s_root;
1036 unsigned long size = 0;
1041 len = utf16_strlen(entry->var.VariableName);
1043 /* name, plus '-', plus GUID, plus NUL*/
1044 name = kmalloc(len + 1 + GUID_LEN + 1, GFP_ATOMIC);
1048 for (i = 0; i < len; i++)
1049 name[i] = entry->var.VariableName[i] & 0xFF;
1053 efi_guid_unparse(&entry->var.VendorGuid, name + len + 1);
1055 name[len+GUID_LEN+1] = '\0';
1057 inode = efivarfs_get_inode(efivarfs_sb, root->d_inode,
1062 dentry = d_alloc_name(root, name);
1066 /* copied by the above to local storage in the dentry. */
1069 spin_lock(&efivars->lock);
1070 efivars->ops->get_variable(entry->var.VariableName,
1071 &entry->var.VendorGuid,
1072 &entry->var.Attributes,
1075 spin_unlock(&efivars->lock);
1077 mutex_lock(&inode->i_mutex);
1078 inode->i_private = entry;
1079 i_size_write(inode, size+4);
1080 mutex_unlock(&inode->i_mutex);
1081 d_add(dentry, inode);
1094 static struct dentry *efivarfs_mount(struct file_system_type *fs_type,
1095 int flags, const char *dev_name, void *data)
1097 return mount_single(fs_type, flags, data, efivarfs_fill_super);
1100 static void efivarfs_kill_sb(struct super_block *sb)
1102 kill_litter_super(sb);
1106 static struct file_system_type efivarfs_type = {
1108 .mount = efivarfs_mount,
1109 .kill_sb = efivarfs_kill_sb,
1112 static const struct inode_operations efivarfs_dir_inode_operations = {
1113 .lookup = simple_lookup,
1114 .unlink = efivarfs_unlink,
1115 .create = efivarfs_create,
1118 static struct pstore_info efi_pstore_info;
1120 #ifdef CONFIG_PSTORE
1122 static int efi_pstore_open(struct pstore_info *psi)
1124 struct efivars *efivars = psi->data;
1126 spin_lock(&efivars->lock);
1127 efivars->walk_entry = list_first_entry(&efivars->list,
1128 struct efivar_entry, list);
1132 static int efi_pstore_close(struct pstore_info *psi)
1134 struct efivars *efivars = psi->data;
1136 spin_unlock(&efivars->lock);
1140 static ssize_t efi_pstore_read(u64 *id, enum pstore_type_id *type,
1141 int *count, struct timespec *timespec,
1142 char **buf, struct pstore_info *psi)
1144 efi_guid_t vendor = LINUX_EFI_CRASH_GUID;
1145 struct efivars *efivars = psi->data;
1146 char name[DUMP_NAME_LEN];
1149 unsigned int part, size;
1152 while (&efivars->walk_entry->list != &efivars->list) {
1153 if (!efi_guidcmp(efivars->walk_entry->var.VendorGuid,
1155 for (i = 0; i < DUMP_NAME_LEN; i++) {
1156 name[i] = efivars->walk_entry->var.VariableName[i];
1158 if (sscanf(name, "dump-type%u-%u-%d-%lu",
1159 type, &part, &cnt, &time) == 4) {
1162 timespec->tv_sec = time;
1163 timespec->tv_nsec = 0;
1164 } else if (sscanf(name, "dump-type%u-%u-%lu",
1165 type, &part, &time) == 3) {
1167 * Check if an old format,
1168 * which doesn't support holding
1169 * multiple logs, remains.
1173 timespec->tv_sec = time;
1174 timespec->tv_nsec = 0;
1176 efivars->walk_entry = list_entry(
1177 efivars->walk_entry->list.next,
1178 struct efivar_entry, list);
1182 get_var_data_locked(efivars, &efivars->walk_entry->var);
1183 size = efivars->walk_entry->var.DataSize;
1184 *buf = kmalloc(size, GFP_KERNEL);
1187 memcpy(*buf, efivars->walk_entry->var.Data,
1189 efivars->walk_entry = list_entry(
1190 efivars->walk_entry->list.next,
1191 struct efivar_entry, list);
1194 efivars->walk_entry = list_entry(efivars->walk_entry->list.next,
1195 struct efivar_entry, list);
1200 static int efi_pstore_write(enum pstore_type_id type,
1201 enum kmsg_dump_reason reason, u64 *id,
1202 unsigned int part, int count, size_t size,
1203 struct pstore_info *psi)
1205 char name[DUMP_NAME_LEN];
1206 efi_char16_t efi_name[DUMP_NAME_LEN];
1207 efi_guid_t vendor = LINUX_EFI_CRASH_GUID;
1208 struct efivars *efivars = psi->data;
1210 u64 storage_space, remaining_space, max_variable_size;
1211 efi_status_t status = EFI_NOT_FOUND;
1213 spin_lock(&efivars->lock);
1216 * Check if there is a space enough to log.
1217 * size: a size of logging data
1218 * DUMP_NAME_LEN * 2: a maximum size of variable name
1220 status = efivars->ops->query_variable_info(PSTORE_EFI_ATTRIBUTES,
1223 &max_variable_size);
1224 if (status || remaining_space < size + DUMP_NAME_LEN * 2) {
1225 spin_unlock(&efivars->lock);
1230 sprintf(name, "dump-type%u-%u-%d-%lu", type, part, count,
1233 for (i = 0; i < DUMP_NAME_LEN; i++)
1234 efi_name[i] = name[i];
1236 efivars->ops->set_variable(efi_name, &vendor, PSTORE_EFI_ATTRIBUTES,
1239 spin_unlock(&efivars->lock);
1242 ret = efivar_create_sysfs_entry(efivars,
1243 utf16_strsize(efi_name,
1251 static int efi_pstore_erase(enum pstore_type_id type, u64 id, int count,
1252 struct timespec time, struct pstore_info *psi)
1254 char name[DUMP_NAME_LEN];
1255 efi_char16_t efi_name[DUMP_NAME_LEN];
1256 char name_old[DUMP_NAME_LEN];
1257 efi_char16_t efi_name_old[DUMP_NAME_LEN];
1258 efi_guid_t vendor = LINUX_EFI_CRASH_GUID;
1259 struct efivars *efivars = psi->data;
1260 struct efivar_entry *entry, *found = NULL;
1263 sprintf(name, "dump-type%u-%u-%d-%lu", type, (unsigned int)id, count,
1266 spin_lock(&efivars->lock);
1268 for (i = 0; i < DUMP_NAME_LEN; i++)
1269 efi_name[i] = name[i];
1272 * Clean up an entry with the same name
1275 list_for_each_entry(entry, &efivars->list, list) {
1276 get_var_data_locked(efivars, &entry->var);
1278 if (efi_guidcmp(entry->var.VendorGuid, vendor))
1280 if (utf16_strncmp(entry->var.VariableName, efi_name,
1281 utf16_strlen(efi_name))) {
1283 * Check if an old format,
1284 * which doesn't support holding
1285 * multiple logs, remains.
1287 sprintf(name_old, "dump-type%u-%u-%lu", type,
1288 (unsigned int)id, time.tv_sec);
1290 for (i = 0; i < DUMP_NAME_LEN; i++)
1291 efi_name_old[i] = name_old[i];
1293 if (utf16_strncmp(entry->var.VariableName, efi_name_old,
1294 utf16_strlen(efi_name_old)))
1300 efivars->ops->set_variable(entry->var.VariableName,
1301 &entry->var.VendorGuid,
1302 PSTORE_EFI_ATTRIBUTES,
1308 list_del(&found->list);
1310 spin_unlock(&efivars->lock);
1313 efivar_unregister(found);
1318 static int efi_pstore_open(struct pstore_info *psi)
1323 static int efi_pstore_close(struct pstore_info *psi)
1328 static ssize_t efi_pstore_read(u64 *id, enum pstore_type_id *type, int *count,
1329 struct timespec *timespec,
1330 char **buf, struct pstore_info *psi)
1335 static int efi_pstore_write(enum pstore_type_id type,
1336 enum kmsg_dump_reason reason, u64 *id,
1337 unsigned int part, int count, size_t size,
1338 struct pstore_info *psi)
1343 static int efi_pstore_erase(enum pstore_type_id type, u64 id, int count,
1344 struct timespec time, struct pstore_info *psi)
1350 static struct pstore_info efi_pstore_info = {
1351 .owner = THIS_MODULE,
1353 .open = efi_pstore_open,
1354 .close = efi_pstore_close,
1355 .read = efi_pstore_read,
1356 .write = efi_pstore_write,
1357 .erase = efi_pstore_erase,
1360 static ssize_t efivar_create(struct file *filp, struct kobject *kobj,
1361 struct bin_attribute *bin_attr,
1362 char *buf, loff_t pos, size_t count)
1364 struct efi_variable *new_var = (struct efi_variable *)buf;
1365 struct efivars *efivars = bin_attr->private;
1366 struct efivar_entry *search_efivar, *n;
1367 unsigned long strsize1, strsize2;
1368 efi_status_t status = EFI_NOT_FOUND;
1371 if (!capable(CAP_SYS_ADMIN))
1374 if ((new_var->Attributes & ~EFI_VARIABLE_MASK) != 0 ||
1375 validate_var(new_var, new_var->Data, new_var->DataSize) == false) {
1376 printk(KERN_ERR "efivars: Malformed variable content\n");
1380 spin_lock(&efivars->lock);
1383 * Does this variable already exist?
1385 list_for_each_entry_safe(search_efivar, n, &efivars->list, list) {
1386 strsize1 = utf16_strsize(search_efivar->var.VariableName, 1024);
1387 strsize2 = utf16_strsize(new_var->VariableName, 1024);
1388 if (strsize1 == strsize2 &&
1389 !memcmp(&(search_efivar->var.VariableName),
1390 new_var->VariableName, strsize1) &&
1391 !efi_guidcmp(search_efivar->var.VendorGuid,
1392 new_var->VendorGuid)) {
1398 spin_unlock(&efivars->lock);
1402 /* now *really* create the variable via EFI */
1403 status = efivars->ops->set_variable(new_var->VariableName,
1404 &new_var->VendorGuid,
1405 new_var->Attributes,
1409 if (status != EFI_SUCCESS) {
1410 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
1412 spin_unlock(&efivars->lock);
1415 spin_unlock(&efivars->lock);
1417 /* Create the entry in sysfs. Locking is not required here */
1418 status = efivar_create_sysfs_entry(efivars,
1419 utf16_strsize(new_var->VariableName,
1421 new_var->VariableName,
1422 &new_var->VendorGuid);
1424 printk(KERN_WARNING "efivars: variable created, but sysfs entry wasn't.\n");
1429 static ssize_t efivar_delete(struct file *filp, struct kobject *kobj,
1430 struct bin_attribute *bin_attr,
1431 char *buf, loff_t pos, size_t count)
1433 struct efi_variable *del_var = (struct efi_variable *)buf;
1434 struct efivars *efivars = bin_attr->private;
1435 struct efivar_entry *search_efivar, *n;
1436 unsigned long strsize1, strsize2;
1437 efi_status_t status = EFI_NOT_FOUND;
1440 if (!capable(CAP_SYS_ADMIN))
1443 spin_lock(&efivars->lock);
1446 * Does this variable already exist?
1448 list_for_each_entry_safe(search_efivar, n, &efivars->list, list) {
1449 strsize1 = utf16_strsize(search_efivar->var.VariableName, 1024);
1450 strsize2 = utf16_strsize(del_var->VariableName, 1024);
1451 if (strsize1 == strsize2 &&
1452 !memcmp(&(search_efivar->var.VariableName),
1453 del_var->VariableName, strsize1) &&
1454 !efi_guidcmp(search_efivar->var.VendorGuid,
1455 del_var->VendorGuid)) {
1461 spin_unlock(&efivars->lock);
1464 /* force the Attributes/DataSize to 0 to ensure deletion */
1465 del_var->Attributes = 0;
1466 del_var->DataSize = 0;
1468 status = efivars->ops->set_variable(del_var->VariableName,
1469 &del_var->VendorGuid,
1470 del_var->Attributes,
1474 if (status != EFI_SUCCESS) {
1475 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
1477 spin_unlock(&efivars->lock);
1480 list_del(&search_efivar->list);
1481 /* We need to release this lock before unregistering. */
1482 spin_unlock(&efivars->lock);
1483 efivar_unregister(search_efivar);
1485 /* It's dead Jim.... */
1490 * Let's not leave out systab information that snuck into
1491 * the efivars driver
1493 static ssize_t systab_show(struct kobject *kobj,
1494 struct kobj_attribute *attr, char *buf)
1501 if (efi.mps != EFI_INVALID_TABLE_ADDR)
1502 str += sprintf(str, "MPS=0x%lx\n", efi.mps);
1503 if (efi.acpi20 != EFI_INVALID_TABLE_ADDR)
1504 str += sprintf(str, "ACPI20=0x%lx\n", efi.acpi20);
1505 if (efi.acpi != EFI_INVALID_TABLE_ADDR)
1506 str += sprintf(str, "ACPI=0x%lx\n", efi.acpi);
1507 if (efi.smbios != EFI_INVALID_TABLE_ADDR)
1508 str += sprintf(str, "SMBIOS=0x%lx\n", efi.smbios);
1509 if (efi.hcdp != EFI_INVALID_TABLE_ADDR)
1510 str += sprintf(str, "HCDP=0x%lx\n", efi.hcdp);
1511 if (efi.boot_info != EFI_INVALID_TABLE_ADDR)
1512 str += sprintf(str, "BOOTINFO=0x%lx\n", efi.boot_info);
1513 if (efi.uga != EFI_INVALID_TABLE_ADDR)
1514 str += sprintf(str, "UGA=0x%lx\n", efi.uga);
1519 static struct kobj_attribute efi_attr_systab =
1520 __ATTR(systab, 0400, systab_show, NULL);
1522 static struct attribute *efi_subsys_attrs[] = {
1523 &efi_attr_systab.attr,
1524 NULL, /* maybe more in the future? */
1527 static struct attribute_group efi_subsys_attr_group = {
1528 .attrs = efi_subsys_attrs,
1531 static struct kobject *efi_kobj;
1534 * efivar_create_sysfs_entry()
1536 * variable_name_size = number of bytes required to hold
1537 * variable_name (not counting the NULL
1538 * character at the end.
1539 * efivars->lock is not held on entry or exit.
1540 * Returns 1 on failure, 0 on success
1543 efivar_create_sysfs_entry(struct efivars *efivars,
1544 unsigned long variable_name_size,
1545 efi_char16_t *variable_name,
1546 efi_guid_t *vendor_guid)
1548 int i, short_name_size;
1550 struct efivar_entry *new_efivar;
1553 * Length of the variable bytes in ASCII, plus the '-' separator,
1554 * plus the GUID, plus trailing NUL
1556 short_name_size = variable_name_size / sizeof(efi_char16_t)
1559 short_name = kzalloc(short_name_size, GFP_KERNEL);
1560 new_efivar = kzalloc(sizeof(struct efivar_entry), GFP_KERNEL);
1562 if (!short_name || !new_efivar) {
1568 new_efivar->efivars = efivars;
1569 memcpy(new_efivar->var.VariableName, variable_name,
1570 variable_name_size);
1571 memcpy(&(new_efivar->var.VendorGuid), vendor_guid, sizeof(efi_guid_t));
1573 /* Convert Unicode to normal chars (assume top bits are 0),
1575 for (i=0; i < (int)(variable_name_size / sizeof(efi_char16_t)); i++) {
1576 short_name[i] = variable_name[i] & 0xFF;
1578 /* This is ugly, but necessary to separate one vendor's
1579 private variables from another's. */
1581 *(short_name + strlen(short_name)) = '-';
1582 efi_guid_unparse(vendor_guid, short_name + strlen(short_name));
1584 new_efivar->kobj.kset = efivars->kset;
1585 i = kobject_init_and_add(&new_efivar->kobj, &efivar_ktype, NULL,
1593 kobject_uevent(&new_efivar->kobj, KOBJ_ADD);
1597 spin_lock(&efivars->lock);
1598 list_add(&new_efivar->list, &efivars->list);
1599 spin_unlock(&efivars->lock);
1605 create_efivars_bin_attributes(struct efivars *efivars)
1607 struct bin_attribute *attr;
1611 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
1615 attr->attr.name = "new_var";
1616 attr->attr.mode = 0200;
1617 attr->write = efivar_create;
1618 attr->private = efivars;
1619 efivars->new_var = attr;
1622 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
1627 attr->attr.name = "del_var";
1628 attr->attr.mode = 0200;
1629 attr->write = efivar_delete;
1630 attr->private = efivars;
1631 efivars->del_var = attr;
1633 sysfs_bin_attr_init(efivars->new_var);
1634 sysfs_bin_attr_init(efivars->del_var);
1637 error = sysfs_create_bin_file(&efivars->kset->kobj,
1640 printk(KERN_ERR "efivars: unable to create new_var sysfs file"
1641 " due to error %d\n", error);
1644 error = sysfs_create_bin_file(&efivars->kset->kobj,
1647 printk(KERN_ERR "efivars: unable to create del_var sysfs file"
1648 " due to error %d\n", error);
1649 sysfs_remove_bin_file(&efivars->kset->kobj,
1656 kfree(efivars->del_var);
1657 efivars->del_var = NULL;
1658 kfree(efivars->new_var);
1659 efivars->new_var = NULL;
1663 void unregister_efivars(struct efivars *efivars)
1665 struct efivar_entry *entry, *n;
1667 list_for_each_entry_safe(entry, n, &efivars->list, list) {
1668 spin_lock(&efivars->lock);
1669 list_del(&entry->list);
1670 spin_unlock(&efivars->lock);
1671 efivar_unregister(entry);
1673 if (efivars->new_var)
1674 sysfs_remove_bin_file(&efivars->kset->kobj, efivars->new_var);
1675 if (efivars->del_var)
1676 sysfs_remove_bin_file(&efivars->kset->kobj, efivars->del_var);
1677 kfree(efivars->new_var);
1678 kfree(efivars->del_var);
1679 kobject_put(efivars->kobject);
1680 kset_unregister(efivars->kset);
1682 EXPORT_SYMBOL_GPL(unregister_efivars);
1684 int register_efivars(struct efivars *efivars,
1685 const struct efivar_operations *ops,
1686 struct kobject *parent_kobj)
1688 efi_status_t status = EFI_NOT_FOUND;
1689 efi_guid_t vendor_guid;
1690 efi_char16_t *variable_name;
1691 unsigned long variable_name_size = 1024;
1694 variable_name = kzalloc(variable_name_size, GFP_KERNEL);
1695 if (!variable_name) {
1696 printk(KERN_ERR "efivars: Memory allocation failed.\n");
1700 spin_lock_init(&efivars->lock);
1701 INIT_LIST_HEAD(&efivars->list);
1704 efivars->kset = kset_create_and_add("vars", NULL, parent_kobj);
1705 if (!efivars->kset) {
1706 printk(KERN_ERR "efivars: Subsystem registration failed.\n");
1711 efivars->kobject = kobject_create_and_add("efivars", parent_kobj);
1712 if (!efivars->kobject) {
1713 pr_err("efivars: Subsystem registration failed.\n");
1715 kset_unregister(efivars->kset);
1720 * Per EFI spec, the maximum storage allocated for both
1721 * the variable name and variable data is 1024 bytes.
1725 variable_name_size = 1024;
1727 status = ops->get_next_variable(&variable_name_size,
1732 efivar_create_sysfs_entry(efivars,
1740 printk(KERN_WARNING "efivars: get_next_variable: status=%lx\n",
1742 status = EFI_NOT_FOUND;
1745 } while (status != EFI_NOT_FOUND);
1747 error = create_efivars_bin_attributes(efivars);
1749 unregister_efivars(efivars);
1751 efivars->efi_pstore_info = efi_pstore_info;
1753 efivars->efi_pstore_info.buf = kmalloc(4096, GFP_KERNEL);
1754 if (efivars->efi_pstore_info.buf) {
1755 efivars->efi_pstore_info.bufsize = 1024;
1756 efivars->efi_pstore_info.data = efivars;
1757 spin_lock_init(&efivars->efi_pstore_info.buf_lock);
1758 pstore_register(&efivars->efi_pstore_info);
1761 register_filesystem(&efivarfs_type);
1764 kfree(variable_name);
1768 EXPORT_SYMBOL_GPL(register_efivars);
1771 * For now we register the efi subsystem with the firmware subsystem
1772 * and the vars subsystem with the efi subsystem. In the future, it
1773 * might make sense to split off the efi subsystem into its own
1774 * driver, but for now only efivars will register with it, so just
1783 printk(KERN_INFO "EFI Variables Facility v%s %s\n", EFIVARS_VERSION,
1786 if (!efi_enabled(EFI_RUNTIME_SERVICES))
1789 /* For now we'll register the efi directory at /sys/firmware/efi */
1790 efi_kobj = kobject_create_and_add("efi", firmware_kobj);
1792 printk(KERN_ERR "efivars: Firmware registration failed.\n");
1796 ops.get_variable = efi.get_variable;
1797 ops.set_variable = efi.set_variable;
1798 ops.get_next_variable = efi.get_next_variable;
1799 ops.query_variable_info = efi.query_variable_info;
1801 error = register_efivars(&__efivars, &ops, efi_kobj);
1805 /* Don't forget the systab entry */
1806 error = sysfs_create_group(efi_kobj, &efi_subsys_attr_group);
1809 "efivars: Sysfs attribute export failed with error %d.\n",
1811 goto err_unregister;
1817 unregister_efivars(&__efivars);
1819 kobject_put(efi_kobj);
1826 if (efi_enabled(EFI_RUNTIME_SERVICES)) {
1827 unregister_efivars(&__efivars);
1828 kobject_put(efi_kobj);
1832 module_init(efivars_init);
1833 module_exit(efivars_exit);