1 // SPDX-License-Identifier: GPL-2.0+
3 * Originally from efivars.c,
5 * Copyright (C) 2001,2003,2004 Dell <Matt_Domsch@dell.com>
6 * Copyright (C) 2004 Intel Corporation <matthew.e.tolentino@intel.com>
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"
21 MODULE_AUTHOR("Matt Domsch <Matt_Domsch@Dell.com>");
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
;
92 if (efivar_entry_get(entry
, &var
->Attributes
, &var
->DataSize
, var
->Data
))
95 if (var
->Attributes
& EFI_VARIABLE_NON_VOLATILE
)
96 str
+= sprintf(str
, "EFI_VARIABLE_NON_VOLATILE\n");
97 if (var
->Attributes
& EFI_VARIABLE_BOOTSERVICE_ACCESS
)
98 str
+= sprintf(str
, "EFI_VARIABLE_BOOTSERVICE_ACCESS\n");
99 if (var
->Attributes
& EFI_VARIABLE_RUNTIME_ACCESS
)
100 str
+= sprintf(str
, "EFI_VARIABLE_RUNTIME_ACCESS\n");
101 if (var
->Attributes
& EFI_VARIABLE_HARDWARE_ERROR_RECORD
)
102 str
+= sprintf(str
, "EFI_VARIABLE_HARDWARE_ERROR_RECORD\n");
103 if (var
->Attributes
& EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
)
105 "EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\n");
106 if (var
->Attributes
&
107 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
)
109 "EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS\n");
110 if (var
->Attributes
& EFI_VARIABLE_APPEND_WRITE
)
111 str
+= sprintf(str
, "EFI_VARIABLE_APPEND_WRITE\n");
116 efivar_size_read(struct efivar_entry
*entry
, char *buf
)
118 struct efi_variable
*var
= &entry
->var
;
124 var
->DataSize
= 1024;
125 if (efivar_entry_get(entry
, &var
->Attributes
, &var
->DataSize
, var
->Data
))
128 str
+= sprintf(str
, "0x%lx\n", var
->DataSize
);
133 efivar_data_read(struct efivar_entry
*entry
, char *buf
)
135 struct efi_variable
*var
= &entry
->var
;
140 var
->DataSize
= 1024;
141 if (efivar_entry_get(entry
, &var
->Attributes
, &var
->DataSize
, var
->Data
))
144 memcpy(buf
, var
->Data
, var
->DataSize
);
145 return var
->DataSize
;
149 sanity_check(struct efi_variable
*var
, efi_char16_t
*name
, efi_guid_t vendor
,
150 unsigned long size
, u32 attributes
, u8
*data
)
153 * If only updating the variable data, then the name
154 * and guid should remain the same
156 if (memcmp(name
, var
->VariableName
, sizeof(var
->VariableName
)) ||
157 efi_guidcmp(vendor
, var
->VendorGuid
)) {
158 printk(KERN_ERR
"efivars: Cannot edit the wrong variable!\n");
162 if ((size
<= 0) || (attributes
== 0)){
163 printk(KERN_ERR
"efivars: DataSize & Attributes must be valid!\n");
167 if ((attributes
& ~EFI_VARIABLE_MASK
) != 0 ||
168 efivar_validate(vendor
, name
, data
, size
) == false) {
169 printk(KERN_ERR
"efivars: Malformed variable content\n");
177 copy_out_compat(struct efi_variable
*dst
, struct compat_efi_variable
*src
)
179 memcpy(dst
->VariableName
, src
->VariableName
, EFI_VAR_NAME_LEN
);
180 memcpy(dst
->Data
, src
->Data
, sizeof(src
->Data
));
182 dst
->VendorGuid
= src
->VendorGuid
;
183 dst
->DataSize
= src
->DataSize
;
184 dst
->Attributes
= src
->Attributes
;
188 * We allow each variable to be edited via rewriting the
189 * entire efi variable structure.
192 efivar_store_raw(struct efivar_entry
*entry
, const char *buf
, size_t count
)
194 struct efi_variable
*new_var
, *var
= &entry
->var
;
202 if (in_compat_syscall()) {
203 struct compat_efi_variable
*compat
;
205 if (count
!= sizeof(*compat
))
208 compat
= (struct compat_efi_variable
*)buf
;
209 attributes
= compat
->Attributes
;
210 vendor
= compat
->VendorGuid
;
211 name
= compat
->VariableName
;
212 size
= compat
->DataSize
;
215 err
= sanity_check(var
, name
, vendor
, size
, attributes
, data
);
219 copy_out_compat(&entry
->var
, compat
);
221 if (count
!= sizeof(struct efi_variable
))
224 new_var
= (struct efi_variable
*)buf
;
226 attributes
= new_var
->Attributes
;
227 vendor
= new_var
->VendorGuid
;
228 name
= new_var
->VariableName
;
229 size
= new_var
->DataSize
;
230 data
= new_var
->Data
;
232 err
= sanity_check(var
, name
, vendor
, size
, attributes
, data
);
236 memcpy(&entry
->var
, new_var
, count
);
239 err
= efivar_entry_set(entry
, attributes
, size
, data
, NULL
);
241 printk(KERN_WARNING
"efivars: set_variable() failed: status=%d\n", err
);
249 efivar_show_raw(struct efivar_entry
*entry
, char *buf
)
251 struct efi_variable
*var
= &entry
->var
;
252 struct compat_efi_variable
*compat
;
258 var
->DataSize
= 1024;
259 if (efivar_entry_get(entry
, &entry
->var
.Attributes
,
260 &entry
->var
.DataSize
, entry
->var
.Data
))
263 if (in_compat_syscall()) {
264 compat
= (struct compat_efi_variable
*)buf
;
266 size
= sizeof(*compat
);
267 memcpy(compat
->VariableName
, var
->VariableName
,
269 memcpy(compat
->Data
, var
->Data
, sizeof(compat
->Data
));
271 compat
->VendorGuid
= var
->VendorGuid
;
272 compat
->DataSize
= var
->DataSize
;
273 compat
->Attributes
= var
->Attributes
;
276 memcpy(buf
, var
, size
);
283 * Generic read/write functions that call the specific functions of
286 static ssize_t
efivar_attr_show(struct kobject
*kobj
, struct attribute
*attr
,
289 struct efivar_entry
*var
= to_efivar_entry(kobj
);
290 struct efivar_attribute
*efivar_attr
= to_efivar_attr(attr
);
293 if (!capable(CAP_SYS_ADMIN
))
296 if (efivar_attr
->show
) {
297 ret
= efivar_attr
->show(var
, buf
);
302 static ssize_t
efivar_attr_store(struct kobject
*kobj
, struct attribute
*attr
,
303 const char *buf
, size_t count
)
305 struct efivar_entry
*var
= to_efivar_entry(kobj
);
306 struct efivar_attribute
*efivar_attr
= to_efivar_attr(attr
);
309 if (!capable(CAP_SYS_ADMIN
))
312 if (efivar_attr
->store
)
313 ret
= efivar_attr
->store(var
, buf
, count
);
318 static const struct sysfs_ops efivar_attr_ops
= {
319 .show
= efivar_attr_show
,
320 .store
= efivar_attr_store
,
323 static void efivar_release(struct kobject
*kobj
)
325 struct efivar_entry
*var
= to_efivar_entry(kobj
);
329 static EFIVAR_ATTR(guid
, 0400, efivar_guid_read
, NULL
);
330 static EFIVAR_ATTR(attributes
, 0400, efivar_attr_read
, NULL
);
331 static EFIVAR_ATTR(size
, 0400, efivar_size_read
, NULL
);
332 static EFIVAR_ATTR(data
, 0400, efivar_data_read
, NULL
);
333 static EFIVAR_ATTR(raw_var
, 0600, efivar_show_raw
, efivar_store_raw
);
335 static struct attribute
*def_attrs
[] = {
336 &efivar_attr_guid
.attr
,
337 &efivar_attr_size
.attr
,
338 &efivar_attr_attributes
.attr
,
339 &efivar_attr_data
.attr
,
340 &efivar_attr_raw_var
.attr
,
344 static struct kobj_type efivar_ktype
= {
345 .release
= efivar_release
,
346 .sysfs_ops
= &efivar_attr_ops
,
347 .default_attrs
= def_attrs
,
350 static ssize_t
efivar_create(struct file
*filp
, struct kobject
*kobj
,
351 struct bin_attribute
*bin_attr
,
352 char *buf
, loff_t pos
, size_t count
)
354 struct compat_efi_variable
*compat
= (struct compat_efi_variable
*)buf
;
355 struct efi_variable
*new_var
= (struct efi_variable
*)buf
;
356 struct efivar_entry
*new_entry
;
357 bool need_compat
= in_compat_syscall();
364 if (!capable(CAP_SYS_ADMIN
))
368 if (count
!= sizeof(*compat
))
371 attributes
= compat
->Attributes
;
372 name
= compat
->VariableName
;
373 size
= compat
->DataSize
;
376 if (count
!= sizeof(*new_var
))
379 attributes
= new_var
->Attributes
;
380 name
= new_var
->VariableName
;
381 size
= new_var
->DataSize
;
382 data
= new_var
->Data
;
385 if ((attributes
& ~EFI_VARIABLE_MASK
) != 0 ||
386 efivar_validate(new_var
->VendorGuid
, name
, data
,
388 printk(KERN_ERR
"efivars: Malformed variable content\n");
392 new_entry
= kzalloc(sizeof(*new_entry
), GFP_KERNEL
);
397 copy_out_compat(&new_entry
->var
, compat
);
399 memcpy(&new_entry
->var
, new_var
, sizeof(*new_var
));
401 err
= efivar_entry_set(new_entry
, attributes
, size
,
402 data
, &efivar_sysfs_list
);
409 if (efivar_create_sysfs_entry(new_entry
)) {
410 printk(KERN_WARNING
"efivars: failed to create sysfs entry.\n");
420 static ssize_t
efivar_delete(struct file
*filp
, struct kobject
*kobj
,
421 struct bin_attribute
*bin_attr
,
422 char *buf
, loff_t pos
, size_t count
)
424 struct efi_variable
*del_var
= (struct efi_variable
*)buf
;
425 struct compat_efi_variable
*compat
;
426 struct efivar_entry
*entry
;
431 if (!capable(CAP_SYS_ADMIN
))
434 if (in_compat_syscall()) {
435 if (count
!= sizeof(*compat
))
438 compat
= (struct compat_efi_variable
*)buf
;
439 name
= compat
->VariableName
;
440 vendor
= compat
->VendorGuid
;
442 if (count
!= sizeof(*del_var
))
445 name
= del_var
->VariableName
;
446 vendor
= del_var
->VendorGuid
;
449 if (efivar_entry_iter_begin())
451 entry
= efivar_entry_find(name
, vendor
, &efivar_sysfs_list
, true);
454 else if (__efivar_entry_delete(entry
))
458 efivar_entry_iter_end();
462 if (!entry
->scanning
) {
463 efivar_entry_iter_end();
464 efivar_unregister(entry
);
466 efivar_entry_iter_end();
468 /* It's dead Jim.... */
473 * efivar_create_sysfs_entry - create a new entry in sysfs
474 * @new_var: efivar entry to create
476 * Returns 0 on success, negative error code on failure
479 efivar_create_sysfs_entry(struct efivar_entry
*new_var
)
483 unsigned long utf8_name_size
;
484 efi_char16_t
*variable_name
= new_var
->var
.VariableName
;
488 * Length of the variable bytes in UTF8, plus the '-' separator,
489 * plus the GUID, plus trailing NUL
491 utf8_name_size
= ucs2_utf8size(variable_name
);
492 short_name_size
= utf8_name_size
+ 1 + EFI_VARIABLE_GUID_LEN
+ 1;
494 short_name
= kmalloc(short_name_size
, GFP_KERNEL
);
498 ucs2_as_utf8(short_name
, variable_name
, short_name_size
);
500 /* This is ugly, but necessary to separate one vendor's
501 private variables from another's. */
502 short_name
[utf8_name_size
] = '-';
503 efi_guid_to_str(&new_var
->var
.VendorGuid
,
504 short_name
+ utf8_name_size
+ 1);
506 new_var
->kobj
.kset
= efivars_kset
;
508 ret
= kobject_init_and_add(&new_var
->kobj
, &efivar_ktype
,
509 NULL
, "%s", short_name
);
514 kobject_uevent(&new_var
->kobj
, KOBJ_ADD
);
515 if (efivar_entry_add(new_var
, &efivar_sysfs_list
)) {
516 efivar_unregister(new_var
);
524 create_efivars_bin_attributes(void)
526 struct bin_attribute
*attr
;
530 attr
= kzalloc(sizeof(*attr
), GFP_KERNEL
);
534 attr
->attr
.name
= "new_var";
535 attr
->attr
.mode
= 0200;
536 attr
->write
= efivar_create
;
537 efivars_new_var
= attr
;
540 attr
= kzalloc(sizeof(*attr
), GFP_KERNEL
);
545 attr
->attr
.name
= "del_var";
546 attr
->attr
.mode
= 0200;
547 attr
->write
= efivar_delete
;
548 efivars_del_var
= attr
;
550 sysfs_bin_attr_init(efivars_new_var
);
551 sysfs_bin_attr_init(efivars_del_var
);
554 error
= sysfs_create_bin_file(&efivars_kset
->kobj
, efivars_new_var
);
556 printk(KERN_ERR
"efivars: unable to create new_var sysfs file"
557 " due to error %d\n", error
);
561 error
= sysfs_create_bin_file(&efivars_kset
->kobj
, efivars_del_var
);
563 printk(KERN_ERR
"efivars: unable to create del_var sysfs file"
564 " due to error %d\n", error
);
565 sysfs_remove_bin_file(&efivars_kset
->kobj
, efivars_new_var
);
571 kfree(efivars_del_var
);
572 efivars_del_var
= NULL
;
573 kfree(efivars_new_var
);
574 efivars_new_var
= NULL
;
578 static int efivar_update_sysfs_entry(efi_char16_t
*name
, efi_guid_t vendor
,
579 unsigned long name_size
, void *data
)
581 struct efivar_entry
*entry
= data
;
583 if (efivar_entry_find(name
, vendor
, &efivar_sysfs_list
, false))
586 memcpy(entry
->var
.VariableName
, name
, name_size
);
587 memcpy(&(entry
->var
.VendorGuid
), &vendor
, sizeof(efi_guid_t
));
592 static void efivar_update_sysfs_entries(struct work_struct
*work
)
594 struct efivar_entry
*entry
;
597 /* Add new sysfs entries */
599 entry
= kzalloc(sizeof(*entry
), GFP_KERNEL
);
603 err
= efivar_init(efivar_update_sysfs_entry
, entry
,
604 false, &efivar_sysfs_list
);
608 efivar_create_sysfs_entry(entry
);
614 static int efivars_sysfs_callback(efi_char16_t
*name
, efi_guid_t vendor
,
615 unsigned long name_size
, void *data
)
617 struct efivar_entry
*entry
;
619 entry
= kzalloc(sizeof(*entry
), GFP_KERNEL
);
623 memcpy(entry
->var
.VariableName
, name
, name_size
);
624 memcpy(&(entry
->var
.VendorGuid
), &vendor
, sizeof(efi_guid_t
));
626 efivar_create_sysfs_entry(entry
);
631 static int efivar_sysfs_destroy(struct efivar_entry
*entry
, void *data
)
633 int err
= efivar_entry_remove(entry
);
637 efivar_unregister(entry
);
641 static void efivars_sysfs_exit(void)
643 /* Remove all entries and destroy */
646 err
= __efivar_entry_iter(efivar_sysfs_destroy
, &efivar_sysfs_list
,
649 pr_err("efivars: Failed to destroy sysfs entries\n");
654 sysfs_remove_bin_file(&efivars_kset
->kobj
, efivars_new_var
);
656 sysfs_remove_bin_file(&efivars_kset
->kobj
, efivars_del_var
);
657 kfree(efivars_new_var
);
658 kfree(efivars_del_var
);
659 kset_unregister(efivars_kset
);
662 int efivars_sysfs_init(void)
664 struct kobject
*parent_kobj
= efivars_kobject();
667 if (!efi_enabled(EFI_RUNTIME_SERVICES
))
670 /* No efivars has been registered yet */
674 printk(KERN_INFO
"EFI Variables Facility v%s %s\n", EFIVARS_VERSION
,
677 efivars_kset
= kset_create_and_add("vars", NULL
, parent_kobj
);
679 printk(KERN_ERR
"efivars: Subsystem registration failed.\n");
683 efivar_init(efivars_sysfs_callback
, NULL
, true, &efivar_sysfs_list
);
685 error
= create_efivars_bin_attributes();
687 efivars_sysfs_exit();
691 INIT_WORK(&efivar_work
, efivar_update_sysfs_entries
);
695 EXPORT_SYMBOL_GPL(efivars_sysfs_init
);
697 module_init(efivars_sysfs_init
);
698 module_exit(efivars_sysfs_exit
);