Various fixes like spelling, style and syntax.
Submitted by: ru (thanks!)
This commit is contained in:
parent
2ebd5d2871
commit
14a3afd9ab
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=203714
@ -25,24 +25,28 @@
|
|||||||
.\"
|
.\"
|
||||||
.\" $FreeBSD$
|
.\" $FreeBSD$
|
||||||
.\"
|
.\"
|
||||||
.Dd Januari 29, 2010
|
.Dd January 29, 2010
|
||||||
.Dt LIBEFI 3
|
.Dt LIBEFI 3
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
.Nm efi_getvar , efi_nextvarname , efi_setvar
|
.Nm efi_getvar , efi_nextvarname , efi_setvar
|
||||||
.Nd Interface for accessing the EFI variable services
|
.Nd "interface for accessing the EFI variable services"
|
||||||
.Sh LIBRARY
|
.Sh LIBRARY
|
||||||
.Lb libefi
|
.Lb libefi
|
||||||
.Sh SYNOPSIS
|
.Sh SYNOPSIS
|
||||||
.In libefi.h
|
.In libefi.h
|
||||||
.Ft int
|
.Ft int
|
||||||
.Fn efi_getvar "char *name" "uuid_t *vendor" "uint32_t *attrib" \
|
.Fo efi_getvar
|
||||||
"size_t *datasize" "void *data"
|
.Fa "char *name" "uuid_t *vendor" "uint32_t *attrib"
|
||||||
|
.Fa "size_t *datasize" "void *data"
|
||||||
|
.Fc
|
||||||
.Ft int
|
.Ft int
|
||||||
.Fn efi_nextvarname "size_t *namesize" "char *name" "uuid_t *vendor"
|
.Fn efi_nextvarname "size_t *namesize" "char *name" "uuid_t *vendor"
|
||||||
.Ft int
|
.Ft int
|
||||||
.Fn efi_setvar "char *name" "uuid_t *vendor" "uint32_t attrib" \
|
.Fo efi_setvar
|
||||||
"size_t datasize" "void *data"
|
.Fa "char *name" "uuid_t *vendor" "uint32_t attrib"
|
||||||
|
.Fa "size_t datasize" "void *data"
|
||||||
|
.Fc
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
The
|
The
|
||||||
.Nm libefi
|
.Nm libefi
|
||||||
@ -53,18 +57,19 @@ The
|
|||||||
.Fn efi_nextvarname
|
.Fn efi_nextvarname
|
||||||
function is used to enumerate the variables.
|
function is used to enumerate the variables.
|
||||||
The
|
The
|
||||||
.Nm namesize
|
.Fa namesize
|
||||||
parameter needs to be set to the size of the buffer pointed to by
|
parameter needs to be set to the size of the buffer pointed to by
|
||||||
.Nm name .
|
.Fa name .
|
||||||
On return,
|
On return,
|
||||||
.Nm namesize
|
.Fa namesize
|
||||||
is set to the length of the variable name (including the terminating '\\0')
|
is set to the length of the variable name (including the terminating
|
||||||
|
.Ql \e0 )
|
||||||
irrespective of whether the buffer was big enough.
|
irrespective of whether the buffer was big enough.
|
||||||
The buffer pointed to by
|
The buffer pointed to by
|
||||||
.Nm name
|
.Fa name
|
||||||
contains the full or partial variable name on return.
|
contains the full or partial variable name on return.
|
||||||
Only on successful completion of the request is the
|
Only on successful completion of the request is the
|
||||||
.Nm vendor
|
.Fa vendor
|
||||||
updated.
|
updated.
|
||||||
The values returned should be passed to successive calls to
|
The values returned should be passed to successive calls to
|
||||||
.Fn efi_nextvarname
|
.Fn efi_nextvarname
|
||||||
@ -76,11 +81,11 @@ can be passed to
|
|||||||
.Fn efi_getvar
|
.Fn efi_getvar
|
||||||
to obtain the value and attribute of the variable.
|
to obtain the value and attribute of the variable.
|
||||||
The buffer that is to contain the value is specified by
|
The buffer that is to contain the value is specified by
|
||||||
.Nm data
|
.Fa data
|
||||||
and the size of the buffer is given by
|
and the size of the buffer is given by
|
||||||
.Nm datasize .
|
.Fa datasize .
|
||||||
The attribute pointed to by
|
The attribute pointed to by
|
||||||
.Nm attrib
|
.Fa attrib
|
||||||
consists of the bit values defined by the EFI specification.
|
consists of the bit values defined by the EFI specification.
|
||||||
.Pp
|
.Pp
|
||||||
Variables can be created, modified and deleted using the
|
Variables can be created, modified and deleted using the
|
||||||
@ -91,15 +96,17 @@ order for the request to succeed.
|
|||||||
Note that for runtime accessable variables the boottime accessable bit must
|
Note that for runtime accessable variables the boottime accessable bit must
|
||||||
be set as well.
|
be set as well.
|
||||||
To delete a variable, set
|
To delete a variable, set
|
||||||
.Nm datasize
|
.Fa datasize
|
||||||
to 0.
|
to 0.
|
||||||
.Pp
|
.Pp
|
||||||
The vendor UUID is used to avoid collisions between variable names of
|
The vendor UUID is used to avoid collisions between variable names of
|
||||||
different vendors.
|
different vendors.
|
||||||
Variables created for use by FreeBSD should use the
|
Variables created for use by
|
||||||
.Nm EFI_FREEBSD_VARIABLE
|
.Fx
|
||||||
|
should use the
|
||||||
|
.Dv EFI_FREEBSD_VARIABLE
|
||||||
UUID as defined in the
|
UUID as defined in the
|
||||||
.Nm libefi
|
.In libefi.h
|
||||||
header file.
|
header file.
|
||||||
.Sh RETURN VALUES
|
.Sh RETURN VALUES
|
||||||
Upon successful completion, these functions return 0.
|
Upon successful completion, these functions return 0.
|
||||||
@ -127,10 +134,10 @@ the buffer provided.
|
|||||||
The
|
The
|
||||||
.Nm libefi
|
.Nm libefi
|
||||||
library first appeared in
|
library first appeared in
|
||||||
.Fx 9
|
.Fx 9.0
|
||||||
for the ia64 architecture.
|
for the ia64 architecture.
|
||||||
.Sh AUTHORS
|
.Sh AUTHORS
|
||||||
The
|
The
|
||||||
.Nm libefi
|
.Nm libefi
|
||||||
library and corresponding manual page were written by
|
library and this manual page were written by
|
||||||
.An Marcel Moolenaar Aq marcel@FreeBSD.org .
|
.An Marcel Moolenaar Aq marcel@FreeBSD.org .
|
||||||
|
Loading…
Reference in New Issue
Block a user