Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/efidev.4
Show All 20 Lines | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd August 12, 2018 | .Dd June 18, 2021 | ||||
kib: The date of the man page should be updated | |||||
.Dt EFIDEV 4 | .Dt EFIDEV 4 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm efidev , | .Nm efidev , | ||||
.Nm efirtc | .Nm efirtc | ||||
.Nd user-mode access to UEFI runtime services | .Nd user-mode access to UEFI runtime services | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
To compile this driver into the kernel, place the following lines in your | To compile this driver into the kernel, place the following lines in your | ||||
Show All 28 Lines | |||||
.Pp | .Pp | ||||
.Nm | .Nm | ||||
provides the following ioctls defined in | provides the following ioctls defined in | ||||
.In sys/efiio.h | .In sys/efiio.h | ||||
with supplemental structures and constants defined in | with supplemental structures and constants defined in | ||||
.In sys/efi.h : | .In sys/efi.h : | ||||
.Bl -tag -width indent | .Bl -tag -width indent | ||||
.It Dv EFIIOC_GET_TABLE Pq Vt "struct efi_get_table_ioc" | .It Dv EFIIOC_GET_TABLE Pq Vt "struct efi_get_table_ioc" | ||||
Get a table by uuid from the UEFI system table. | Copy the table from the UEFI system described by | ||||
emasteUnsubmitted Not Done Inline ActionsI would probably write this as "Copy the UEFI table specified by the uuid field of struct ...." emaste: I would probably write this as "Copy the UEFI table specified by the uuid field of struct ...."
| |||||
.Va uuid | |||||
field of the | |||||
Not Done Inline ActionsEach sentence should start at the new line. .Va buf kib: Each sentence should start at the new line.
`.Va buf`
`.Dv NULL`
`.Va table_len`
`.Va buf_len` | |||||
.Vt struct efi_get_table_ioc | |||||
into the | |||||
.Va buf | |||||
field. | |||||
The memory size for the buf field can be found by passing | |||||
emasteUnsubmitted Not Done Inline Actionsmaybe s/found/queried/ emaste: maybe s/found/queried/ | |||||
.Dv NULL | |||||
pointer as a buf value. | |||||
The required size will be stored in the | |||||
.Va table_len | |||||
field. | |||||
The size of the allocated memory must be specified in the | |||||
.Va buf_len | |||||
field. | |||||
.Bd -literal -offset indent | .Bd -literal -offset indent | ||||
struct efi_get_table_ioc { | struct efi_get_table_ioc { | ||||
void *buf; | |||||
struct uuid uuid; | struct uuid uuid; | ||||
void *ptr; | size_t table_len; | ||||
size_t buf_len; | |||||
}; | }; | ||||
.Ed | .Ed | ||||
Not Done Inline ActionsThis is too terse. Please explain what table_len and buf_len are for, which are in and which are out, and how to use them. kib: This is too terse. Please explain what table_len and buf_len are for, which are in and which… | |||||
.It Dv EFIIOC_GET_TIME Pq Vt "struct efi_tm" | .It Dv EFIIOC_GET_TIME Pq Vt "struct efi_tm" | ||||
Get the time from the RTC, if the RTC is available. | Get the time from the RTC, if the RTC is available. | ||||
The | The | ||||
.Vt struct efi_tm | .Vt struct efi_tm | ||||
passed is populated with the current time, unless an error occurs. | passed is populated with the current time, unless an error occurs. | ||||
.Bd -literal -offset indent | .Bd -literal -offset indent | ||||
struct efi_tm { | struct efi_tm { | ||||
uint16_t tm_year; | uint16_t tm_year; | ||||
▲ Show 20 Lines • Show All 59 Lines • Show Last 20 Lines |
The date of the man page should be updated