bus_generic_print_child.9: Remove wrong whitespace.
[dragonfly.git] / share / man / man9 / bios.9
1 .\" $FreeBSD: src/share/man/man9/bios.9,v 1.4.2.6 2001/12/17 11:30:18 ru Exp $
2 .\"
3 .\" Copyright (c) 1997 Michael Smith
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" SUCH DAMAGE.
26 .\"
27 .Dd September 9, 2015
28 .Dt BIOS 9
29 .Os
30 .Sh NAME
31 .Nm bios_sigsearch ,
32 .Nm BIOS_PADDRTOVADDR ,
33 .Nm BIOS_VADDRTOPADDR
34 .Nd interact with PC BIOS
35 .Sh SYNOPSIS
36 .In sys/types.h
37 .In machine/pc/bios.h
38 .Ft u_int32_t
39 .Fn bios_sigsearch "u_int32_t start" "u_char *sig" "int siglen" "int paralen" "int sigofs"
40 .Fn BIOS_PADDRTOVADDR "addr"
41 .Fn BIOS_VADDRTOPADDR "addr"
42 .Sh DESCRIPTION
43 A number of macros and functions are available to deal with BIOS data
44 encountered on x86 PC-architecture systems.
45 .Bl -tag -width ".Fn BIOS_PADDRTOVADDR"
46 .It Fn bios_sigsearch
47 Searches the BIOS address space for a service signature, usually an
48 uppercase ASCII sequence surrounded by underscores.  The search begins
49 at
50 .Fa start ,
51 or at the beginning of the BIOS if
52 .Fa start
53 is zero.
54 .Fa siglen
55 bytes of the BIOS image and
56 .Fa sig
57 are compared at
58 .Fa sigofs
59 bytes offset from the current location.  If no match is found, the
60 current location is incremented by
61 .Fa paralen
62 bytes and the search repeated.  If the signature is found, its effective
63 physical address is returned.  If no signature is found, zero is returned.
64 .It Fn BIOS_VADDRTOPADDR
65 Returns the effective physical address which corresponds to the kernel
66 virtual address
67 .Fa addr .
68 .It Fn BIOS_PADDRTOVADDR
69 Returns the kernel virtual address which corresponds to the effective
70 physical address
71 .Fa addr .
72 .El