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 program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/capability.h>
23 #include <linux/types.h>
24 #include <linux/errno.h>
25 #include <linux/init.h>
27 #include <linux/module.h>
28 #include <linux/string.h>
29 #include <linux/smp.h>
30 #include <linux/efi.h>
31 #include <linux/sysfs.h>
32 #include <linux/device.h>
33 #include <linux/slab.h>
34 #include <linux/ctype.h>
35 #include <linux/ucs2_string.h>
37 /* Private pointer to registered efivars */
38 static struct efivars
*__efivars
;
40 static bool efivar_wq_enabled
= true;
41 DECLARE_WORK(efivar_work
, NULL
);
42 EXPORT_SYMBOL_GPL(efivar_work
);
45 validate_device_path(efi_char16_t
*var_name
, int match
, u8
*buffer
,
48 struct efi_generic_dev_path
*node
;
51 node
= (struct efi_generic_dev_path
*)buffer
;
53 if (len
< sizeof(*node
))
56 while (offset
<= len
- sizeof(*node
) &&
57 node
->length
>= sizeof(*node
) &&
58 node
->length
<= len
- offset
) {
59 offset
+= node
->length
;
61 if ((node
->type
== EFI_DEV_END_PATH
||
62 node
->type
== EFI_DEV_END_PATH2
) &&
63 node
->sub_type
== EFI_DEV_END_ENTIRE
)
66 node
= (struct efi_generic_dev_path
*)(buffer
+ offset
);
70 * If we're here then either node->length pointed past the end
71 * of the buffer or we reached the end of the buffer without
72 * finding a device path end node.
78 validate_boot_order(efi_char16_t
*var_name
, int match
, u8
*buffer
,
81 /* An array of 16-bit integers */
89 validate_load_option(efi_char16_t
*var_name
, int match
, u8
*buffer
,
93 int i
, desclength
= 0, namelen
;
95 namelen
= ucs2_strnlen(var_name
, EFI_VAR_NAME_LEN
);
97 /* Either "Boot" or "Driver" followed by four digits of hex */
98 for (i
= match
; i
< match
+4; i
++) {
99 if (var_name
[i
] > 127 ||
100 hex_to_bin(var_name
[i
] & 0xff) < 0)
104 /* Reject it if there's 4 digits of hex and then further content */
105 if (namelen
> match
+ 4)
108 /* A valid entry must be at least 8 bytes */
112 filepathlength
= buffer
[4] | buffer
[5] << 8;
115 * There's no stored length for the description, so it has to be
118 desclength
= ucs2_strsize((efi_char16_t
*)(buffer
+ 6), len
- 6) + 2;
120 /* Each boot entry must have a descriptor */
125 * If the sum of the length of the description, the claimed filepath
126 * length and the original header are greater than the length of the
127 * variable, it's malformed
129 if ((desclength
+ filepathlength
+ 6) > len
)
133 * And, finally, check the filepath
135 return validate_device_path(var_name
, match
, buffer
+ desclength
+ 6,
140 validate_uint16(efi_char16_t
*var_name
, int match
, u8
*buffer
,
143 /* A single 16-bit integer */
151 validate_ascii_string(efi_char16_t
*var_name
, int match
, u8
*buffer
,
156 for (i
= 0; i
< len
; i
++) {
167 struct variable_validate
{
169 bool (*validate
)(efi_char16_t
*var_name
, int match
, u8
*data
,
173 static const struct variable_validate variable_validate
[] = {
174 { "BootNext", validate_uint16
},
175 { "BootOrder", validate_boot_order
},
176 { "DriverOrder", validate_boot_order
},
177 { "Boot*", validate_load_option
},
178 { "Driver*", validate_load_option
},
179 { "ConIn", validate_device_path
},
180 { "ConInDev", validate_device_path
},
181 { "ConOut", validate_device_path
},
182 { "ConOutDev", validate_device_path
},
183 { "ErrOut", validate_device_path
},
184 { "ErrOutDev", validate_device_path
},
185 { "Timeout", validate_uint16
},
186 { "Lang", validate_ascii_string
},
187 { "PlatformLang", validate_ascii_string
},
192 efivar_validate(efi_char16_t
*var_name
, u8
*data
, unsigned long len
)
195 u16
*unicode_name
= var_name
;
197 for (i
= 0; variable_validate
[i
].validate
!= NULL
; i
++) {
198 const char *name
= variable_validate
[i
].name
;
201 for (match
= 0; ; match
++) {
202 char c
= name
[match
];
203 u16 u
= unicode_name
[match
];
205 /* All special variables are plain ascii */
209 /* Wildcard in the matching name means we've matched */
211 return variable_validate
[i
].validate(var_name
,
214 /* Case sensitive match */
218 /* Reached the end of the string while matching */
220 return variable_validate
[i
].validate(var_name
,
227 EXPORT_SYMBOL_GPL(efivar_validate
);
230 check_var_size(u32 attributes
, unsigned long size
)
232 const struct efivar_operations
*fops
= __efivars
->ops
;
234 if (!fops
->query_variable_store
)
235 return EFI_UNSUPPORTED
;
237 return fops
->query_variable_store(attributes
, size
, false);
241 check_var_size_nonblocking(u32 attributes
, unsigned long size
)
243 const struct efivar_operations
*fops
= __efivars
->ops
;
245 if (!fops
->query_variable_store
)
246 return EFI_UNSUPPORTED
;
248 return fops
->query_variable_store(attributes
, size
, true);
251 static int efi_status_to_err(efi_status_t status
)
259 case EFI_INVALID_PARAMETER
:
262 case EFI_OUT_OF_RESOURCES
:
265 case EFI_DEVICE_ERROR
:
268 case EFI_WRITE_PROTECTED
:
271 case EFI_SECURITY_VIOLATION
:
284 static bool variable_is_present(efi_char16_t
*variable_name
, efi_guid_t
*vendor
,
285 struct list_head
*head
)
287 struct efivar_entry
*entry
, *n
;
288 unsigned long strsize1
, strsize2
;
291 strsize1
= ucs2_strsize(variable_name
, 1024);
292 list_for_each_entry_safe(entry
, n
, head
, list
) {
293 strsize2
= ucs2_strsize(entry
->var
.VariableName
, 1024);
294 if (strsize1
== strsize2
&&
295 !memcmp(variable_name
, &(entry
->var
.VariableName
),
297 !efi_guidcmp(entry
->var
.VendorGuid
,
307 * Returns the size of variable_name, in bytes, including the
308 * terminating NULL character, or variable_name_size if no NULL
309 * character is found among the first variable_name_size bytes.
311 static unsigned long var_name_strnsize(efi_char16_t
*variable_name
,
312 unsigned long variable_name_size
)
318 * The variable name is, by definition, a NULL-terminated
319 * string, so make absolutely sure that variable_name_size is
320 * the value we expect it to be. If not, return the real size.
322 for (len
= 2; len
<= variable_name_size
; len
+= sizeof(c
)) {
323 c
= variable_name
[(len
/ sizeof(c
)) - 1];
328 return min(len
, variable_name_size
);
332 * Print a warning when duplicate EFI variables are encountered and
333 * disable the sysfs workqueue since the firmware is buggy.
335 static void dup_variable_bug(efi_char16_t
*str16
, efi_guid_t
*vendor_guid
,
338 size_t i
, len8
= len16
/ sizeof(efi_char16_t
);
342 * Disable the workqueue since the algorithm it uses for
343 * detecting new variables won't work with this buggy
344 * implementation of GetNextVariableName().
346 efivar_wq_enabled
= false;
348 str8
= kzalloc(len8
, GFP_KERNEL
);
352 for (i
= 0; i
< len8
; i
++)
355 printk(KERN_WARNING
"efivars: duplicate variable: %s-%pUl\n",
361 * efivar_init - build the initial list of EFI variables
362 * @func: callback function to invoke for every variable
363 * @data: function-specific data to pass to @func
364 * @atomic: do we need to execute the @func-loop atomically?
365 * @duplicates: error if we encounter duplicates on @head?
366 * @head: initialised head of variable list
368 * Get every EFI variable from the firmware and invoke @func. @func
369 * should call efivar_entry_add() to build the list of variables.
371 * Returns 0 on success, or a kernel error code on failure.
373 int efivar_init(int (*func
)(efi_char16_t
*, efi_guid_t
, unsigned long, void *),
374 void *data
, bool atomic
, bool duplicates
,
375 struct list_head
*head
)
377 const struct efivar_operations
*ops
= __efivars
->ops
;
378 unsigned long variable_name_size
= 1024;
379 efi_char16_t
*variable_name
;
381 efi_guid_t vendor_guid
;
384 variable_name
= kzalloc(variable_name_size
, GFP_KERNEL
);
385 if (!variable_name
) {
386 printk(KERN_ERR
"efivars: Memory allocation failed.\n");
390 spin_lock_irq(&__efivars
->lock
);
393 * Per EFI spec, the maximum storage allocated for both
394 * the variable name and variable data is 1024 bytes.
398 variable_name_size
= 1024;
400 status
= ops
->get_next_variable(&variable_name_size
,
406 spin_unlock_irq(&__efivars
->lock
);
408 variable_name_size
= var_name_strnsize(variable_name
,
412 * Some firmware implementations return the
413 * same variable name on multiple calls to
414 * get_next_variable(). Terminate the loop
415 * immediately as there is no guarantee that
416 * we'll ever see a different variable name,
417 * and may end up looping here forever.
420 variable_is_present(variable_name
, &vendor_guid
, head
)) {
421 dup_variable_bug(variable_name
, &vendor_guid
,
424 spin_lock_irq(&__efivars
->lock
);
426 status
= EFI_NOT_FOUND
;
430 err
= func(variable_name
, vendor_guid
, variable_name_size
, data
);
432 status
= EFI_NOT_FOUND
;
435 spin_lock_irq(&__efivars
->lock
);
441 printk(KERN_WARNING
"efivars: get_next_variable: status=%lx\n",
443 status
= EFI_NOT_FOUND
;
447 } while (status
!= EFI_NOT_FOUND
);
449 spin_unlock_irq(&__efivars
->lock
);
451 kfree(variable_name
);
455 EXPORT_SYMBOL_GPL(efivar_init
);
458 * efivar_entry_add - add entry to variable list
459 * @entry: entry to add to list
462 void efivar_entry_add(struct efivar_entry
*entry
, struct list_head
*head
)
464 spin_lock_irq(&__efivars
->lock
);
465 list_add(&entry
->list
, head
);
466 spin_unlock_irq(&__efivars
->lock
);
468 EXPORT_SYMBOL_GPL(efivar_entry_add
);
471 * efivar_entry_remove - remove entry from variable list
472 * @entry: entry to remove from list
474 void efivar_entry_remove(struct efivar_entry
*entry
)
476 spin_lock_irq(&__efivars
->lock
);
477 list_del(&entry
->list
);
478 spin_unlock_irq(&__efivars
->lock
);
480 EXPORT_SYMBOL_GPL(efivar_entry_remove
);
483 * efivar_entry_list_del_unlock - remove entry from variable list
484 * @entry: entry to remove
486 * Remove @entry from the variable list and release the list lock.
488 * NOTE: slightly weird locking semantics here - we expect to be
489 * called with the efivars lock already held, and we release it before
490 * returning. This is because this function is usually called after
491 * set_variable() while the lock is still held.
493 static void efivar_entry_list_del_unlock(struct efivar_entry
*entry
)
495 lockdep_assert_held(&__efivars
->lock
);
497 list_del(&entry
->list
);
498 spin_unlock_irq(&__efivars
->lock
);
502 * __efivar_entry_delete - delete an EFI variable
503 * @entry: entry containing EFI variable to delete
505 * Delete the variable from the firmware but leave @entry on the
508 * This function differs from efivar_entry_delete() because it does
509 * not remove @entry from the variable list. Also, it is safe to be
510 * called from within a efivar_entry_iter_begin() and
511 * efivar_entry_iter_end() region, unlike efivar_entry_delete().
513 * Returns 0 on success, or a converted EFI status code if
514 * set_variable() fails.
516 int __efivar_entry_delete(struct efivar_entry
*entry
)
518 const struct efivar_operations
*ops
= __efivars
->ops
;
521 lockdep_assert_held(&__efivars
->lock
);
523 status
= ops
->set_variable(entry
->var
.VariableName
,
524 &entry
->var
.VendorGuid
,
527 return efi_status_to_err(status
);
529 EXPORT_SYMBOL_GPL(__efivar_entry_delete
);
532 * efivar_entry_delete - delete variable and remove entry from list
533 * @entry: entry containing variable to delete
535 * Delete the variable from the firmware and remove @entry from the
536 * variable list. It is the caller's responsibility to free @entry
539 * Returns 0 on success, or a converted EFI status code if
540 * set_variable() fails.
542 int efivar_entry_delete(struct efivar_entry
*entry
)
544 const struct efivar_operations
*ops
= __efivars
->ops
;
547 spin_lock_irq(&__efivars
->lock
);
548 status
= ops
->set_variable(entry
->var
.VariableName
,
549 &entry
->var
.VendorGuid
,
551 if (!(status
== EFI_SUCCESS
|| status
== EFI_NOT_FOUND
)) {
552 spin_unlock_irq(&__efivars
->lock
);
553 return efi_status_to_err(status
);
556 efivar_entry_list_del_unlock(entry
);
559 EXPORT_SYMBOL_GPL(efivar_entry_delete
);
562 * efivar_entry_set - call set_variable()
563 * @entry: entry containing the EFI variable to write
564 * @attributes: variable attributes
565 * @size: size of @data buffer
566 * @data: buffer containing variable data
567 * @head: head of variable list
569 * Calls set_variable() for an EFI variable. If creating a new EFI
570 * variable, this function is usually followed by efivar_entry_add().
572 * Before writing the variable, the remaining EFI variable storage
573 * space is checked to ensure there is enough room available.
575 * If @head is not NULL a lookup is performed to determine whether
576 * the entry is already on the list.
578 * Returns 0 on success, -EEXIST if a lookup is performed and the entry
579 * already exists on the list, or a converted EFI status code if
580 * set_variable() fails.
582 int efivar_entry_set(struct efivar_entry
*entry
, u32 attributes
,
583 unsigned long size
, void *data
, struct list_head
*head
)
585 const struct efivar_operations
*ops
= __efivars
->ops
;
587 efi_char16_t
*name
= entry
->var
.VariableName
;
588 efi_guid_t vendor
= entry
->var
.VendorGuid
;
590 spin_lock_irq(&__efivars
->lock
);
592 if (head
&& efivar_entry_find(name
, vendor
, head
, false)) {
593 spin_unlock_irq(&__efivars
->lock
);
597 status
= check_var_size(attributes
, size
+ ucs2_strsize(name
, 1024));
598 if (status
== EFI_SUCCESS
|| status
== EFI_UNSUPPORTED
)
599 status
= ops
->set_variable(name
, &vendor
,
600 attributes
, size
, data
);
602 spin_unlock_irq(&__efivars
->lock
);
604 return efi_status_to_err(status
);
607 EXPORT_SYMBOL_GPL(efivar_entry_set
);
610 * efivar_entry_set_nonblocking - call set_variable_nonblocking()
612 * This function is guaranteed to not block and is suitable for calling
613 * from crash/panic handlers.
615 * Crucially, this function will not block if it cannot acquire
616 * __efivars->lock. Instead, it returns -EBUSY.
619 efivar_entry_set_nonblocking(efi_char16_t
*name
, efi_guid_t vendor
,
620 u32 attributes
, unsigned long size
, void *data
)
622 const struct efivar_operations
*ops
= __efivars
->ops
;
626 if (!spin_trylock_irqsave(&__efivars
->lock
, flags
))
629 status
= check_var_size_nonblocking(attributes
,
630 size
+ ucs2_strsize(name
, 1024));
631 if (status
!= EFI_SUCCESS
) {
632 spin_unlock_irqrestore(&__efivars
->lock
, flags
);
636 status
= ops
->set_variable_nonblocking(name
, &vendor
, attributes
,
639 spin_unlock_irqrestore(&__efivars
->lock
, flags
);
640 return efi_status_to_err(status
);
644 * efivar_entry_set_safe - call set_variable() if enough space in firmware
645 * @name: buffer containing the variable name
646 * @vendor: variable vendor guid
647 * @attributes: variable attributes
648 * @block: can we block in this context?
649 * @size: size of @data buffer
650 * @data: buffer containing variable data
652 * Ensures there is enough free storage in the firmware for this variable, and
653 * if so, calls set_variable(). If creating a new EFI variable, this function
654 * is usually followed by efivar_entry_add().
656 * Returns 0 on success, -ENOSPC if the firmware does not have enough
657 * space for set_variable() to succeed, or a converted EFI status code
658 * if set_variable() fails.
660 int efivar_entry_set_safe(efi_char16_t
*name
, efi_guid_t vendor
, u32 attributes
,
661 bool block
, unsigned long size
, void *data
)
663 const struct efivar_operations
*ops
= __efivars
->ops
;
667 if (!ops
->query_variable_store
)
671 * If the EFI variable backend provides a non-blocking
672 * ->set_variable() operation and we're in a context where we
673 * cannot block, then we need to use it to avoid live-locks,
674 * since the implication is that the regular ->set_variable()
677 * If no ->set_variable_nonblocking() is provided then
678 * ->set_variable() is assumed to be non-blocking.
680 if (!block
&& ops
->set_variable_nonblocking
)
681 return efivar_entry_set_nonblocking(name
, vendor
, attributes
,
685 if (!spin_trylock_irqsave(&__efivars
->lock
, flags
))
688 spin_lock_irqsave(&__efivars
->lock
, flags
);
691 status
= check_var_size(attributes
, size
+ ucs2_strsize(name
, 1024));
692 if (status
!= EFI_SUCCESS
) {
693 spin_unlock_irqrestore(&__efivars
->lock
, flags
);
697 status
= ops
->set_variable(name
, &vendor
, attributes
, size
, data
);
699 spin_unlock_irqrestore(&__efivars
->lock
, flags
);
701 return efi_status_to_err(status
);
703 EXPORT_SYMBOL_GPL(efivar_entry_set_safe
);
706 * efivar_entry_find - search for an entry
707 * @name: the EFI variable name
708 * @guid: the EFI variable vendor's guid
709 * @head: head of the variable list
710 * @remove: should we remove the entry from the list?
712 * Search for an entry on the variable list that has the EFI variable
713 * name @name and vendor guid @guid. If an entry is found on the list
714 * and @remove is true, the entry is removed from the list.
716 * The caller MUST call efivar_entry_iter_begin() and
717 * efivar_entry_iter_end() before and after the invocation of this
718 * function, respectively.
720 * Returns the entry if found on the list, %NULL otherwise.
722 struct efivar_entry
*efivar_entry_find(efi_char16_t
*name
, efi_guid_t guid
,
723 struct list_head
*head
, bool remove
)
725 struct efivar_entry
*entry
, *n
;
726 int strsize1
, strsize2
;
729 lockdep_assert_held(&__efivars
->lock
);
731 list_for_each_entry_safe(entry
, n
, head
, list
) {
732 strsize1
= ucs2_strsize(name
, 1024);
733 strsize2
= ucs2_strsize(entry
->var
.VariableName
, 1024);
734 if (strsize1
== strsize2
&&
735 !memcmp(name
, &(entry
->var
.VariableName
), strsize1
) &&
736 !efi_guidcmp(guid
, entry
->var
.VendorGuid
)) {
746 if (entry
->scanning
) {
748 * The entry will be deleted
749 * after scanning is completed.
751 entry
->deleting
= true;
753 list_del(&entry
->list
);
758 EXPORT_SYMBOL_GPL(efivar_entry_find
);
761 * efivar_entry_size - obtain the size of a variable
762 * @entry: entry for this variable
763 * @size: location to store the variable's size
765 int efivar_entry_size(struct efivar_entry
*entry
, unsigned long *size
)
767 const struct efivar_operations
*ops
= __efivars
->ops
;
772 spin_lock_irq(&__efivars
->lock
);
773 status
= ops
->get_variable(entry
->var
.VariableName
,
774 &entry
->var
.VendorGuid
, NULL
, size
, NULL
);
775 spin_unlock_irq(&__efivars
->lock
);
777 if (status
!= EFI_BUFFER_TOO_SMALL
)
778 return efi_status_to_err(status
);
782 EXPORT_SYMBOL_GPL(efivar_entry_size
);
785 * __efivar_entry_get - call get_variable()
786 * @entry: read data for this variable
787 * @attributes: variable attributes
788 * @size: size of @data buffer
789 * @data: buffer to store variable data
791 * The caller MUST call efivar_entry_iter_begin() and
792 * efivar_entry_iter_end() before and after the invocation of this
793 * function, respectively.
795 int __efivar_entry_get(struct efivar_entry
*entry
, u32
*attributes
,
796 unsigned long *size
, void *data
)
798 const struct efivar_operations
*ops
= __efivars
->ops
;
801 lockdep_assert_held(&__efivars
->lock
);
803 status
= ops
->get_variable(entry
->var
.VariableName
,
804 &entry
->var
.VendorGuid
,
805 attributes
, size
, data
);
807 return efi_status_to_err(status
);
809 EXPORT_SYMBOL_GPL(__efivar_entry_get
);
812 * efivar_entry_get - call get_variable()
813 * @entry: read data for this variable
814 * @attributes: variable attributes
815 * @size: size of @data buffer
816 * @data: buffer to store variable data
818 int efivar_entry_get(struct efivar_entry
*entry
, u32
*attributes
,
819 unsigned long *size
, void *data
)
821 const struct efivar_operations
*ops
= __efivars
->ops
;
824 spin_lock_irq(&__efivars
->lock
);
825 status
= ops
->get_variable(entry
->var
.VariableName
,
826 &entry
->var
.VendorGuid
,
827 attributes
, size
, data
);
828 spin_unlock_irq(&__efivars
->lock
);
830 return efi_status_to_err(status
);
832 EXPORT_SYMBOL_GPL(efivar_entry_get
);
835 * efivar_entry_set_get_size - call set_variable() and get new size (atomic)
836 * @entry: entry containing variable to set and get
837 * @attributes: attributes of variable to be written
838 * @size: size of data buffer
839 * @data: buffer containing data to write
840 * @set: did the set_variable() call succeed?
842 * This is a pretty special (complex) function. See efivarfs_file_write().
844 * Atomically call set_variable() for @entry and if the call is
845 * successful, return the new size of the variable from get_variable()
846 * in @size. The success of set_variable() is indicated by @set.
848 * Returns 0 on success, -EINVAL if the variable data is invalid,
849 * -ENOSPC if the firmware does not have enough available space, or a
850 * converted EFI status code if either of set_variable() or
851 * get_variable() fail.
853 * If the EFI variable does not exist when calling set_variable()
854 * (EFI_NOT_FOUND), @entry is removed from the variable list.
856 int efivar_entry_set_get_size(struct efivar_entry
*entry
, u32 attributes
,
857 unsigned long *size
, void *data
, bool *set
)
859 const struct efivar_operations
*ops
= __efivars
->ops
;
860 efi_char16_t
*name
= entry
->var
.VariableName
;
861 efi_guid_t
*vendor
= &entry
->var
.VendorGuid
;
867 if (efivar_validate(name
, data
, *size
) == false)
871 * The lock here protects the get_variable call, the conditional
872 * set_variable call, and removal of the variable from the efivars
873 * list (in the case of an authenticated delete).
875 spin_lock_irq(&__efivars
->lock
);
878 * Ensure that the available space hasn't shrunk below the safe level
880 status
= check_var_size(attributes
, *size
+ ucs2_strsize(name
, 1024));
881 if (status
!= EFI_SUCCESS
) {
882 if (status
!= EFI_UNSUPPORTED
) {
883 err
= efi_status_to_err(status
);
893 status
= ops
->set_variable(name
, vendor
, attributes
, *size
, data
);
894 if (status
!= EFI_SUCCESS
) {
895 err
= efi_status_to_err(status
);
902 * Writing to the variable may have caused a change in size (which
903 * could either be an append or an overwrite), or the variable to be
904 * deleted. Perform a GetVariable() so we can tell what actually
908 status
= ops
->get_variable(entry
->var
.VariableName
,
909 &entry
->var
.VendorGuid
,
912 if (status
== EFI_NOT_FOUND
)
913 efivar_entry_list_del_unlock(entry
);
915 spin_unlock_irq(&__efivars
->lock
);
917 if (status
&& status
!= EFI_BUFFER_TOO_SMALL
)
918 return efi_status_to_err(status
);
923 spin_unlock_irq(&__efivars
->lock
);
927 EXPORT_SYMBOL_GPL(efivar_entry_set_get_size
);
930 * efivar_entry_iter_begin - begin iterating the variable list
932 * Lock the variable list to prevent entry insertion and removal until
933 * efivar_entry_iter_end() is called. This function is usually used in
934 * conjunction with __efivar_entry_iter() or efivar_entry_iter().
936 void efivar_entry_iter_begin(void)
938 spin_lock_irq(&__efivars
->lock
);
940 EXPORT_SYMBOL_GPL(efivar_entry_iter_begin
);
943 * efivar_entry_iter_end - finish iterating the variable list
945 * Unlock the variable list and allow modifications to the list again.
947 void efivar_entry_iter_end(void)
949 spin_unlock_irq(&__efivars
->lock
);
951 EXPORT_SYMBOL_GPL(efivar_entry_iter_end
);
954 * __efivar_entry_iter - iterate over variable list
955 * @func: callback function
956 * @head: head of the variable list
957 * @data: function-specific data to pass to callback
958 * @prev: entry to begin iterating from
960 * Iterate over the list of EFI variables and call @func with every
961 * entry on the list. It is safe for @func to remove entries in the
962 * list via efivar_entry_delete().
964 * You MUST call efivar_enter_iter_begin() before this function, and
965 * efivar_entry_iter_end() afterwards.
967 * It is possible to begin iteration from an arbitrary entry within
968 * the list by passing @prev. @prev is updated on return to point to
969 * the last entry passed to @func. To begin iterating from the
970 * beginning of the list @prev must be %NULL.
972 * The restrictions for @func are the same as documented for
973 * efivar_entry_iter().
975 int __efivar_entry_iter(int (*func
)(struct efivar_entry
*, void *),
976 struct list_head
*head
, void *data
,
977 struct efivar_entry
**prev
)
979 struct efivar_entry
*entry
, *n
;
982 if (!prev
|| !*prev
) {
983 list_for_each_entry_safe(entry
, n
, head
, list
) {
984 err
= func(entry
, data
);
996 list_for_each_entry_safe_continue((*prev
), n
, head
, list
) {
997 err
= func(*prev
, data
);
1004 EXPORT_SYMBOL_GPL(__efivar_entry_iter
);
1007 * efivar_entry_iter - iterate over variable list
1008 * @func: callback function
1009 * @head: head of variable list
1010 * @data: function-specific data to pass to callback
1012 * Iterate over the list of EFI variables and call @func with every
1013 * entry on the list. It is safe for @func to remove entries in the
1014 * list via efivar_entry_delete() while iterating.
1016 * Some notes for the callback function:
1017 * - a non-zero return value indicates an error and terminates the loop
1018 * - @func is called from atomic context
1020 int efivar_entry_iter(int (*func
)(struct efivar_entry
*, void *),
1021 struct list_head
*head
, void *data
)
1025 efivar_entry_iter_begin();
1026 err
= __efivar_entry_iter(func
, head
, data
, NULL
);
1027 efivar_entry_iter_end();
1031 EXPORT_SYMBOL_GPL(efivar_entry_iter
);
1034 * efivars_kobject - get the kobject for the registered efivars
1036 * If efivars_register() has not been called we return NULL,
1037 * otherwise return the kobject used at registration time.
1039 struct kobject
*efivars_kobject(void)
1044 return __efivars
->kobject
;
1046 EXPORT_SYMBOL_GPL(efivars_kobject
);
1049 * efivar_run_worker - schedule the efivar worker thread
1051 void efivar_run_worker(void)
1053 if (efivar_wq_enabled
)
1054 schedule_work(&efivar_work
);
1056 EXPORT_SYMBOL_GPL(efivar_run_worker
);
1059 * efivars_register - register an efivars
1060 * @efivars: efivars to register
1061 * @ops: efivars operations
1062 * @kobject: @efivars-specific kobject
1064 * Only a single efivars can be registered at any time.
1066 int efivars_register(struct efivars
*efivars
,
1067 const struct efivar_operations
*ops
,
1068 struct kobject
*kobject
)
1070 spin_lock_init(&efivars
->lock
);
1072 efivars
->kobject
= kobject
;
1074 __efivars
= efivars
;
1078 EXPORT_SYMBOL_GPL(efivars_register
);
1081 * efivars_unregister - unregister an efivars
1082 * @efivars: efivars to unregister
1084 * The caller must have already removed every entry from the list,
1085 * failure to do so is an error.
1087 int efivars_unregister(struct efivars
*efivars
)
1092 printk(KERN_ERR
"efivars not registered\n");
1097 if (__efivars
!= efivars
) {
1108 EXPORT_SYMBOL_GPL(efivars_unregister
);