1 // SPDX-License-Identifier: GPL-2.0+
3 * Originally from efivars.c,
8 * This code takes all variables accessible from EFI runtime and
9 * exports them via sysfs
12 #include <linux/efi.h>
13 #include <linux/module.h>
14 #include <linux/slab.h>
15 #include <linux/ucs2_string.h>
16 #include <linux/compat.h>
18 #define EFIVARS_VERSION "0.08"
19 #define EFIVARS_DATE "2004-May-17"
22 MODULE_DESCRIPTION("sysfs interface to EFI Variables");
23 MODULE_LICENSE("GPL");
24 MODULE_VERSION(EFIVARS_VERSION);
25 MODULE_ALIAS("platform:efivars");
27 LIST_HEAD(efivar_sysfs_list);
28 EXPORT_SYMBOL_GPL(efivar_sysfs_list);
30 static struct kset *efivars_kset;
32 static struct bin_attribute *efivars_new_var;
33 static struct bin_attribute *efivars_del_var;
35 struct compat_efi_variable {
36 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
37 efi_guid_t VendorGuid;
44 struct efivar_attribute {
45 struct attribute attr;
46 ssize_t (*show) (struct efivar_entry *entry, char *buf);
47 ssize_t (*store)(struct efivar_entry *entry, const char *buf, size_t count);
50 #define EFIVAR_ATTR(_name, _mode, _show, _store) \
51 struct efivar_attribute efivar_attr_##_name = { \
52 .attr = {.name = __stringify(_name), .mode = _mode}, \
57 #define to_efivar_attr(_attr) container_of(_attr, struct efivar_attribute, attr)
58 #define to_efivar_entry(obj) container_of(obj, struct efivar_entry, kobj)
61 * Prototype for sysfs creation function
64 efivar_create_sysfs_entry(struct efivar_entry *new_var);
67 efivar_guid_read(struct efivar_entry *entry, char *buf)
69 struct efi_variable *var = &entry->var;
75 efi_guid_to_str(&var->VendorGuid, str);
77 str += sprintf(str, "\n");
83 efivar_attr_read(struct efivar_entry *entry, char *buf)
85 struct efi_variable *var = &entry->var;
86 unsigned long size = sizeof(var->Data);
93 ret = efivar_entry_get(entry, &var->Attributes, &size, var->Data);
98 if (var->Attributes & EFI_VARIABLE_NON_VOLATILE)
99 str += sprintf(str, "EFI_VARIABLE_NON_VOLATILE\n");
100 if (var->Attributes & EFI_VARIABLE_BOOTSERVICE_ACCESS)
101 str += sprintf(str, "EFI_VARIABLE_BOOTSERVICE_ACCESS\n");
102 if (var->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)
103 str += sprintf(str, "EFI_VARIABLE_RUNTIME_ACCESS\n");
104 if (var->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD)
105 str += sprintf(str, "EFI_VARIABLE_HARDWARE_ERROR_RECORD\n");
106 if (var->Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)
108 "EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\n");
109 if (var->Attributes &
110 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)
112 "EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS\n");
113 if (var->Attributes & EFI_VARIABLE_APPEND_WRITE)
114 str += sprintf(str, "EFI_VARIABLE_APPEND_WRITE\n");
119 efivar_size_read(struct efivar_entry *entry, char *buf)
121 struct efi_variable *var = &entry->var;
122 unsigned long size = sizeof(var->Data);
129 ret = efivar_entry_get(entry, &var->Attributes, &size, var->Data);
130 var->DataSize = size;
134 str += sprintf(str, "0x%lx\n", var->DataSize);
139 efivar_data_read(struct efivar_entry *entry, char *buf)
141 struct efi_variable *var = &entry->var;
142 unsigned long size = sizeof(var->Data);
148 ret = efivar_entry_get(entry, &var->Attributes, &size, var->Data);
149 var->DataSize = size;
153 memcpy(buf, var->Data, var->DataSize);
154 return var->DataSize;
158 sanity_check(struct efi_variable *var, efi_char16_t *name, efi_guid_t vendor,
159 unsigned long size, u32 attributes, u8 *data)
162 * If only updating the variable data, then the name
163 * and guid should remain the same
165 if (memcmp(name, var->VariableName, sizeof(var->VariableName)) ||
166 efi_guidcmp(vendor, var->VendorGuid)) {
167 printk(KERN_ERR "efivars: Cannot edit the wrong variable!\n");
171 if ((size <= 0) || (attributes == 0)){
172 printk(KERN_ERR "efivars: DataSize & Attributes must be valid!\n");
176 if ((attributes & ~EFI_VARIABLE_MASK) != 0 ||
177 efivar_validate(vendor, name, data, size) == false) {
178 printk(KERN_ERR "efivars: Malformed variable content\n");
186 copy_out_compat(struct efi_variable *dst, struct compat_efi_variable *src)
188 memcpy(dst->VariableName, src->VariableName, EFI_VAR_NAME_LEN);
189 memcpy(dst->Data, src->Data, sizeof(src->Data));
191 dst->VendorGuid = src->VendorGuid;
192 dst->DataSize = src->DataSize;
193 dst->Attributes = src->Attributes;
197 * We allow each variable to be edited via rewriting the
198 * entire efi variable structure.
201 efivar_store_raw(struct efivar_entry *entry, const char *buf, size_t count)
203 struct efi_variable *new_var, *var = &entry->var;
214 if (in_compat_syscall()) {
215 struct compat_efi_variable *compat;
217 if (count != sizeof(*compat))
220 compat = (struct compat_efi_variable *)buf;
221 attributes = compat->Attributes;
222 vendor = compat->VendorGuid;
223 name = compat->VariableName;
224 size = compat->DataSize;
227 err = sanity_check(var, name, vendor, size, attributes, data);
231 copy_out_compat(&entry->var, compat);
233 if (count != sizeof(struct efi_variable))
236 new_var = (struct efi_variable *)buf;
238 attributes = new_var->Attributes;
239 vendor = new_var->VendorGuid;
240 name = new_var->VariableName;
241 size = new_var->DataSize;
242 data = new_var->Data;
244 err = sanity_check(var, name, vendor, size, attributes, data);
248 memcpy(&entry->var, new_var, count);
251 err = efivar_entry_set(entry, attributes, size, data, NULL);
253 printk(KERN_WARNING "efivars: set_variable() failed: status=%d\n", err);
261 efivar_show_raw(struct efivar_entry *entry, char *buf)
263 struct efi_variable *var = &entry->var;
264 struct compat_efi_variable *compat;
265 unsigned long datasize = sizeof(var->Data);
272 ret = efivar_entry_get(entry, &var->Attributes, &datasize, var->Data);
273 var->DataSize = datasize;
277 if (in_compat_syscall()) {
278 compat = (struct compat_efi_variable *)buf;
280 size = sizeof(*compat);
281 memcpy(compat->VariableName, var->VariableName,
283 memcpy(compat->Data, var->Data, sizeof(compat->Data));
285 compat->VendorGuid = var->VendorGuid;
286 compat->DataSize = var->DataSize;
287 compat->Attributes = var->Attributes;
290 memcpy(buf, var, size);
297 * Generic read/write functions that call the specific functions of
300 static ssize_t efivar_attr_show(struct kobject *kobj, struct attribute *attr,
303 struct efivar_entry *var = to_efivar_entry(kobj);
304 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
307 if (!capable(CAP_SYS_ADMIN))
310 if (efivar_attr->show) {
311 ret = efivar_attr->show(var, buf);
316 static ssize_t efivar_attr_store(struct kobject *kobj, struct attribute *attr,
317 const char *buf, size_t count)
319 struct efivar_entry *var = to_efivar_entry(kobj);
320 struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
323 if (!capable(CAP_SYS_ADMIN))
326 if (efivar_attr->store)
327 ret = efivar_attr->store(var, buf, count);
332 static const struct sysfs_ops efivar_attr_ops = {
333 .show = efivar_attr_show,
334 .store = efivar_attr_store,
337 static void efivar_release(struct kobject *kobj)
339 struct efivar_entry *var = to_efivar_entry(kobj);
343 static EFIVAR_ATTR(guid, 0400, efivar_guid_read, NULL);
344 static EFIVAR_ATTR(attributes, 0400, efivar_attr_read, NULL);
345 static EFIVAR_ATTR(size, 0400, efivar_size_read, NULL);
346 static EFIVAR_ATTR(data, 0400, efivar_data_read, NULL);
347 static EFIVAR_ATTR(raw_var, 0600, efivar_show_raw, efivar_store_raw);
349 static struct attribute *def_attrs[] = {
350 &efivar_attr_guid.attr,
351 &efivar_attr_size.attr,
352 &efivar_attr_attributes.attr,
353 &efivar_attr_data.attr,
354 &efivar_attr_raw_var.attr,
358 static struct kobj_type efivar_ktype = {
359 .release = efivar_release,
360 .sysfs_ops = &efivar_attr_ops,
361 .default_attrs = def_attrs,
364 static ssize_t efivar_create(struct file *filp, struct kobject *kobj,
365 struct bin_attribute *bin_attr,
366 char *buf, loff_t pos, size_t count)
368 struct compat_efi_variable *compat = (struct compat_efi_variable *)buf;
369 struct efi_variable *new_var = (struct efi_variable *)buf;
370 struct efivar_entry *new_entry;
371 bool need_compat = in_compat_syscall();
378 if (!capable(CAP_SYS_ADMIN))
382 if (count != sizeof(*compat))
385 attributes = compat->Attributes;
386 name = compat->VariableName;
387 size = compat->DataSize;
390 if (count != sizeof(*new_var))
393 attributes = new_var->Attributes;
394 name = new_var->VariableName;
395 size = new_var->DataSize;
396 data = new_var->Data;
399 if ((attributes & ~EFI_VARIABLE_MASK) != 0 ||
400 efivar_validate(new_var->VendorGuid, name, data,
402 printk(KERN_ERR "efivars: Malformed variable content\n");
406 new_entry = kzalloc(sizeof(*new_entry), GFP_KERNEL);
411 copy_out_compat(&new_entry->var, compat);
413 memcpy(&new_entry->var, new_var, sizeof(*new_var));
415 err = efivar_entry_set(new_entry, attributes, size,
416 data, &efivar_sysfs_list);
423 if (efivar_create_sysfs_entry(new_entry)) {
424 printk(KERN_WARNING "efivars: failed to create sysfs entry.\n");
434 static ssize_t efivar_delete(struct file *filp, struct kobject *kobj,
435 struct bin_attribute *bin_attr,
436 char *buf, loff_t pos, size_t count)
438 struct efi_variable *del_var = (struct efi_variable *)buf;
439 struct compat_efi_variable *compat;
440 struct efivar_entry *entry;
445 if (!capable(CAP_SYS_ADMIN))
448 if (in_compat_syscall()) {
449 if (count != sizeof(*compat))
452 compat = (struct compat_efi_variable *)buf;
453 name = compat->VariableName;
454 vendor = compat->VendorGuid;
456 if (count != sizeof(*del_var))
459 name = del_var->VariableName;
460 vendor = del_var->VendorGuid;
463 if (efivar_entry_iter_begin())
465 entry = efivar_entry_find(name, vendor, &efivar_sysfs_list, true);
468 else if (__efivar_entry_delete(entry))
472 efivar_entry_iter_end();
476 if (!entry->scanning) {
477 efivar_entry_iter_end();
478 efivar_unregister(entry);
480 efivar_entry_iter_end();
482 /* It's dead Jim.... */
487 * efivar_create_sysfs_entry - create a new entry in sysfs
488 * @new_var: efivar entry to create
490 * Returns 0 on success, negative error code on failure
493 efivar_create_sysfs_entry(struct efivar_entry *new_var)
497 unsigned long utf8_name_size;
498 efi_char16_t *variable_name = new_var->var.VariableName;
502 * Length of the variable bytes in UTF8, plus the '-' separator,
503 * plus the GUID, plus trailing NUL
505 utf8_name_size = ucs2_utf8size(variable_name);
506 short_name_size = utf8_name_size + 1 + EFI_VARIABLE_GUID_LEN + 1;
508 short_name = kmalloc(short_name_size, GFP_KERNEL);
512 ucs2_as_utf8(short_name, variable_name, short_name_size);
514 /* This is ugly, but necessary to separate one vendor's
515 private variables from another's. */
516 short_name[utf8_name_size] = '-';
517 efi_guid_to_str(&new_var->var.VendorGuid,
518 short_name + utf8_name_size + 1);
520 new_var->kobj.kset = efivars_kset;
522 ret = kobject_init_and_add(&new_var->kobj, &efivar_ktype,
523 NULL, "%s", short_name);
526 kobject_put(&new_var->kobj);
530 kobject_uevent(&new_var->kobj, KOBJ_ADD);
531 if (efivar_entry_add(new_var, &efivar_sysfs_list)) {
532 efivar_unregister(new_var);
540 create_efivars_bin_attributes(void)
542 struct bin_attribute *attr;
546 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
550 attr->attr.name = "new_var";
551 attr->attr.mode = 0200;
552 attr->write = efivar_create;
553 efivars_new_var = attr;
556 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
561 attr->attr.name = "del_var";
562 attr->attr.mode = 0200;
563 attr->write = efivar_delete;
564 efivars_del_var = attr;
566 sysfs_bin_attr_init(efivars_new_var);
567 sysfs_bin_attr_init(efivars_del_var);
570 error = sysfs_create_bin_file(&efivars_kset->kobj, efivars_new_var);
572 printk(KERN_ERR "efivars: unable to create new_var sysfs file"
573 " due to error %d\n", error);
577 error = sysfs_create_bin_file(&efivars_kset->kobj, efivars_del_var);
579 printk(KERN_ERR "efivars: unable to create del_var sysfs file"
580 " due to error %d\n", error);
581 sysfs_remove_bin_file(&efivars_kset->kobj, efivars_new_var);
587 kfree(efivars_del_var);
588 efivars_del_var = NULL;
589 kfree(efivars_new_var);
590 efivars_new_var = NULL;
594 static int efivar_update_sysfs_entry(efi_char16_t *name, efi_guid_t vendor,
595 unsigned long name_size, void *data)
597 struct efivar_entry *entry = data;
599 if (efivar_entry_find(name, vendor, &efivar_sysfs_list, false))
602 memcpy(entry->var.VariableName, name, name_size);
603 memcpy(&(entry->var.VendorGuid), &vendor, sizeof(efi_guid_t));
608 static void efivar_update_sysfs_entries(struct work_struct *work)
610 struct efivar_entry *entry;
613 /* Add new sysfs entries */
615 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
619 err = efivar_init(efivar_update_sysfs_entry, entry,
620 false, &efivar_sysfs_list);
624 efivar_create_sysfs_entry(entry);
630 static int efivars_sysfs_callback(efi_char16_t *name, efi_guid_t vendor,
631 unsigned long name_size, void *data)
633 struct efivar_entry *entry;
635 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
639 memcpy(entry->var.VariableName, name, name_size);
640 memcpy(&(entry->var.VendorGuid), &vendor, sizeof(efi_guid_t));
642 efivar_create_sysfs_entry(entry);
647 static int efivar_sysfs_destroy(struct efivar_entry *entry, void *data)
649 int err = efivar_entry_remove(entry);
653 efivar_unregister(entry);
657 static void efivars_sysfs_exit(void)
659 /* Remove all entries and destroy */
662 err = __efivar_entry_iter(efivar_sysfs_destroy, &efivar_sysfs_list,
665 pr_err("efivars: Failed to destroy sysfs entries\n");
670 sysfs_remove_bin_file(&efivars_kset->kobj, efivars_new_var);
672 sysfs_remove_bin_file(&efivars_kset->kobj, efivars_del_var);
673 kfree(efivars_new_var);
674 kfree(efivars_del_var);
675 kset_unregister(efivars_kset);
678 int efivars_sysfs_init(void)
680 struct kobject *parent_kobj = efivars_kobject();
683 /* No efivars has been registered yet */
684 if (!parent_kobj || !efivar_supports_writes())
687 printk(KERN_INFO "EFI Variables Facility v%s %s\n", EFIVARS_VERSION,
690 efivars_kset = kset_create_and_add("vars", NULL, parent_kobj);
692 printk(KERN_ERR "efivars: Subsystem registration failed.\n");
696 efivar_init(efivars_sysfs_callback, NULL, true, &efivar_sysfs_list);
698 error = create_efivars_bin_attributes();
700 efivars_sysfs_exit();
704 INIT_WORK(&efivar_work, efivar_update_sysfs_entries);
708 EXPORT_SYMBOL_GPL(efivars_sysfs_init);
710 module_init(efivars_sysfs_init);
711 module_exit(efivars_sysfs_exit);