a017981164e23dd2527aae6b2870f498a5eba39a
[dragonfly.git] / lib / libefivar / efivar.3
1 .\" Copyright 2016 Netflix, Inc.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
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.
12 .\"
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
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: head/lib/libefivar/efivar.3 307071 2016-10-11 22:30:41Z imp $
26 .\"
27 .Dd September 14, 2016
28 .Dt LIBEFIVAR 3
29 .Os
30 .Sh NAME
31 .Nm libefivar
32 .Nd EFI Non Volatile Variable Support
33 .Sh LIBRARY
34 .Lb libefivar
35 .Sh SYNOPSIS
36 .In efivar.h
37 .Ft int
38 .Fn efi_append_variable "efi_guid_t guid" "const char *name" "uint8_t *data" "size_t data_size" "uint32_t attributes"
39 .Ft int
40 .Fn efi_del_variable "efi_guid_t guid" "const char *name"
41 .Ft int
42 .Fn efi_get_variable "efi_guid_t guid" "const char *name" "uint8_t **data" "size_t *data_size" "uint32_t *attributes"
43 .Ft int
44 .Fn efi_get_variable_attributes "efi_guid_t guid" "const char *name" "uint32_t *attributes"
45 .Ft int
46 .Fn efi_get_variable_size "efi_guid_t guid" "const char *name" "size_t *size"
47 .Ft int
48 .Fn efi_get_next_variable_name "efi_guid_t **guid" "char **name"
49 .Ft int
50 .Fn efi_guid_to_name "efi_guid_t *guid" "char **name"
51 .Ft int
52 .Fn efi_guid_to_symbol "efi_guid_t *guid" "char **symbol"
53 .Ft int
54 .Fn efi_guid_to_str "const efi_guid_t *guid" "char **sp"
55 .Ft int
56 .Fn efi_name_to_guid "const char *name" "efi_guid_t *guid"
57 .Ft int
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"
59 .Ft int
60 .Fn efi_str_to_guid "const char *s" "efi_guid_t *guid"
61 .Ft int
62 .Fn efi_variables_supported "void"
63 .Sh DESCRIPTION
64 The
65 .Nm
66 library implements access to EFI Variables via the EFI Runtime
67 Serivces.
68 All char * strings are converted to 16-bit UTF strings before passing
69 them to EFI.
70 .Pp
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.
75 .Pp
76 .Fn efi_del_variable
77 deletes the EFI variable selected by
78 .Dv guid
79 and
80 .Dv name .
81 .Pp
82 .Fn efi_get_variable
83 .Fn efi_get_variable_attributes
84 .Fn efi_get_variable_size
85 .Fn efi_append_variable
86 .Fn efi_set_variable
87 .Fn efi_get_next_variable_name
88 .Fn efi_str_to_guid
89 .Fn efi_guid_to_str
90 .Fn efi_name_to_guid
91 .Fn efi_guid_to_name
92 .Fn efi_guid_to_symbol
93 This function is not actually implemented.
94 .Sh SEE ALSO
95 .Xr efivar 8
96 .Sh AUTHORS
97 .An -nosplit
98 This software was originally written by
99 .An Warner Losh .
100 .Sh BUGS
101 No facilities exist to process the strings as native UTF.
102 This is a limitation in the Linux libefivar library interface.