2 .\" Copyright 2016 Netflix, Inc.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .Nd EFI Non Volatile Variable Support
35 .Fn efi_append_variable "efi_guid_t guid" "const char *name" "void *data" "size_t data_size" "uint32_t attributes"
37 .Fn efi_del_variable "efi_guid_t guid" "const char *name"
39 .Fn efi_get_variable "efi_guid_t guid" "const char *name" "void **data" "ssize_t *data_size" "uint32_t *attributes"
41 .Fn efi_get_variable_attributes "efi_guid_t guid" "const char *name" "uint32_t *attributes"
43 .Fn efi_get_variable_size "efi_guid_t guid" "const char *name" "size_t *size"
45 .Fn efi_get_next_variable_name "efi_guid_t **guid" "char **name"
47 .Fn efi_guid_to_name "efi_guid_t *guid" "char **name"
49 .Fn efi_guid_to_symbol "efi_guid_t *guid" "char **symbol"
51 .Fn efi_guid_to_str "const efi_guid_t *guid" "char **sp"
53 .Fn efi_name_to_guid "const char *name" "efi_guid_t *guid"
55 .Fn efi_set_variable "efi_guid_t guid" "const char *name" "void *data" "size_t data_size" "uint32_t attributes"
57 .Fn efi_str_to_guid "const char *s" "efi_guid_t *guid"
59 .Fn efi_variables_supported "void"
63 library implements access to EFI Variables via the EFI Runtime
67 strings are converted to 16-bit UTF strings before passing
70 .Fn efi_variables_supported
71 returns non-zero if the current machine supports setting of EFI firmware
72 variables and the kernel support for doing so is present.
73 Otherwise zero is returned.
76 deletes the EFI variable selected by
81 The following functions have not been implemented yet:
82 .Bl -dash -offset indent -compact
84 .Fn efi_append_variable
86 .Fn efi_get_next_variable_name
90 .Fn efi_get_variable_attributes
92 .Fn efi_get_variable_size
98 .Fn efi_guid_to_symbol
111 library first appeared in
115 This software was originally written by
118 No facilities exist to process the strings as native UTF.
119 This is a limitation in the Linux