1 .\" Copyright 2016 Netflix, Inc.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" $FreeBSD: head/lib/libefivar/efivar.3 307071 2016-10-11 22:30:41Z imp $
32 .Nd EFI Non Volatile Variable Support
38 .Fn efi_append_variable "efi_guid_t guid" "const char *name" "uint8_t *data" "size_t data_size" "uint32_t attributes"
40 .Fn efi_del_variable "efi_guid_t guid" "const char *name"
42 .Fn efi_get_variable "efi_guid_t guid" "const char *name" "uint8_t **data" "size_t *data_size" "uint32_t *attributes"
44 .Fn efi_get_variable_attributes "efi_guid_t guid" "const char *name" "uint32_t *attributes"
46 .Fn efi_get_variable_size "efi_guid_t guid" "const char *name" "size_t *size"
48 .Fn efi_get_next_variable_name "efi_guid_t **guid" "char **name"
50 .Fn efi_guid_to_name "efi_guid_t *guid" "char **name"
52 .Fn efi_guid_to_symbol "efi_guid_t *guid" "char **symbol"
54 .Fn efi_guid_to_str "const efi_guid_t *guid" "char **sp"
56 .Fn efi_name_to_guid "const char *name" "efi_guid_t *guid"
58 .Fn efi_set_variable "efi_guid_t guid" "const char *name" "uint8_t *data" "size_t data_size" "uint32_t attributes" "mode_t mode"
60 .Fn efi_str_to_guid "const char *s" "efi_guid_t *guid"
62 .Fn efi_variables_supported "void"
66 library implements access to EFI Variables via the EFI Runtime
68 All char * strings are converted to 16-bit UTF strings before passing
71 .Fn efi_variables_supported
72 returns non-zero if the current machine supports setting of EFI firmware
73 variables and the kernel support for doing so is present.
74 Otherwise zero is returned.
77 deletes the EFI variable selected by
83 .Fn efi_get_variable_attributes
84 .Fn efi_get_variable_size
85 .Fn efi_append_variable
87 .Fn efi_get_next_variable_name
92 .Fn efi_guid_to_symbol
93 This function is not actually implemented.
99 This software was originally written by
102 No facilities exist to process the strings as native UTF.
103 This is a limitation in the Linux libefivar library interface.