* Add .Nm and MLINKS for BIOS_* macros.
[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 .\" $DragonFly: src/share/man/man9/bios.9,v 1.4 2007/02/18 14:17:29 swildner Exp $
3 .\"
4 .\" Copyright (c) 1997 Michael Smith
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .Dd August 1, 1997
29 .Dt BIOS 9
30 .Os
31 .Sh NAME
32 .Nm bios_sigsearch ,
33 .Nm bios32_SDlookup ,
34 .Nm bios32 ,
35 .Nm BIOS_PADDRTOVADDR ,
36 .Nm BIOS_VADDRTOPADDR
37 .Nd interact with PC BIOS
38 .Sh SYNOPSIS
39 .In sys/types.h
40 .In machine/pc/bios.h
41 .Ft u_int32_t
42 .Fn bios_sigsearch "u_int32_t start" "u_char *sig" "int siglen" "int paralen" "int sigofs"
43 .Ft int
44 .Fn bios32_SDlookup "struct bios32_SDentry *ent"
45 .Ft void
46 .Fn bios32 "caddr_t entry" "struct bios32_args *args"
47 .Fn BIOS_PADDRTOVADDR "addr"
48 .Fn BIOS_VADDRTOPADDR "addr"
49 .Vt extern struct bios32_SDentry PCIbios ;
50 .Vt extern struct SMBIOS_table SMBIOStable ;
51 .Vt extern struct DMI_table DMItable ;
52 .Sh DESCRIPTION
53 These functions provide a general-purpose interface for dealing with
54 the BIOS functions and data encountered on x86 PC-architecture systems.
55 .Bl -tag -width ".Fn BIOS_PADDRTOVADDR"
56 .It Fn bios_sigsearch
57 Searches the BIOS address space for a service signature, usually an
58 uppercase ASCII sequence surrounded by underscores.  The search begins
59 at
60 .Fa start ,
61 or at the beginning of the BIOS if
62 .Fa start
63 is zero.
64 .Fa siglen
65 bytes of the BIOS image and
66 .Fa sig
67 are compared at
68 .Fa sigofs
69 bytes offset from the current location.  If no match is found, the
70 current location is incremented by
71 .Fa paralen
72 bytes and the search repeated.  If the signature is found, its effective
73 physical address is returned.  If no signature is found, zero is returned.
74 .It Fn BIOS_VADDRTOPADDR
75 Returns the effective physical address which corresponds to the kernel
76 virtual address
77 .Fa addr .
78 .It Fn BIOS_PADDRTOVADDR
79 Returns the kernel virtual address which corresponds to the effective
80 physical address
81 .Fa addr .
82 .It Va SMBIOStable
83 If not NULL, points to a
84 .Ft struct SMBIOS_table
85 structure containing information read from the System Management BIOS table
86 during system startup.
87 .It Va DMItable
88 If not NULL, points to a
89 .Ft struct DMI_table
90 structure containing information read from the Desktop Management Interface
91 parameter table during system startup.
92 .El
93 .Sh BIOS32
94 At system startup, the BIOS is scanned for the BIOS32 Service Directory
95 (part of the PCI specification), and the existence of the directory is
96 recorded.  This can then be used to locate other services.
97 .Bl -tag -width ".Fn BIOS_PADDRTOVADDR"
98 .It Fn bios32_SDlookup
99 Attempts to locate the BIOS32 service matching the 4-byte identifier
100 passed in the
101 .Fa ident
102 field of the
103 .Fa ent
104 argument.
105 .It Fn bios32
106 Calls a bios32 function.  This presumes that the function is capable of
107 working within the kernel segment (normally the case).  The virtual address
108 of the entrypoint is supplied in
109 .Fa entry
110 and the register arguments to the function are supplied in
111 .Fa args .
112 .It Va PCIbios
113 If not NULL, points to a
114 .Ft struct bios32_SDentry
115 structure describing the PCI BIOS entrypoint which was found during system
116 startup.
117 .El