2 .\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer as
10 .\" the first lines of this file unmodified.
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.
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, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 .Dd September 11, 2009
33 .Nd device resource hints
37 file is read in by the boot
39 when the system is about to start, and its contents are
41 It contains various variables to control the boot behavior of
43 These variables are typically
45 .\" .Dq device hints ,
46 .\" and other control variables.
48 The file contains one variable per line.
49 Lines starting with the
51 character are comments and are ignored by the boot loader.
53 After the file is read by the boot loader, you may examine
54 the variables with the
56 command, and may add a new variable, modify an existing one,
57 or delete a variable with the
61 commands of the boot loader
65 After the system has started, you can dump these variables
70 Device hint variables are used by device drivers to set up
72 They are most often used by ISA device drivers to specify
73 where the driver will probe for the relevant devices, and what
74 resources it will attempt to use.
76 A device hint line looks like:
79 .D1 Li hint. Ar driver . Ar unit . Ar keyword Li = Qq Ar value
84 is the name of a device driver,
86 is the unit number, and
88 is the keyword of the hint.
91 .Bl -tag -width ".Li disabled" -compact -offset indent
93 specifies a bus to which the device is attached.
95 specifies the start address of I/O ports to be used by the device.
97 specifies the number of ports used by the device.
99 is the interrupt line number to be used.
101 is the DMA channel number.
103 specifies the physical memory address used by the device.
105 specifies the physical memory size used by the device.
107 sets various flag bits for the device.
111 to disable the device.
114 A device driver may require one or more hint lines with these keywords,
115 and may accept other keywords not listed here, through
116 .Xr resource_int_value 9 .
117 Consult individual device drivers' manual pages for available
118 keywords and their possible values.
119 .\" .Sh CONTROL VARIABLES
120 .\" Lines not starting with
122 .\" specify other control variables for the kernel.
125 .\" .Dl <name>="<value>"
127 .\" WE SHOULD LIST AVAILABLE VARIABLE NAMES AND THEIR POSSIBLE VALUES HERE!
130 .Bl -tag -width ".Pa /sys/ Ns Ar ARCH Ns Pa /conf/GENERIC.hints" -compact
131 .It Pa /boot/device.hints
132 Device resource hints file.
133 .It Pa /sys/ Ns Ar ARCH Ns Pa /conf/GENERIC.hints
134 Sample resource hints for the
137 .It Pa /sys/ Ns Ar ARCH Ns Pa /conf/NOTES
138 Notes on the kernel configuration file and device resource hints.
141 The following example sets up resources for the
143 driver on the ISA bus:
144 .Bd -literal -offset indent
146 hint.sio.0.port="0x3F8"
147 hint.sio.0.flags="0x10"
151 The following example disables the ACPI driver:
152 .Bd -literal -offset indent
153 hint.acpi.0.disabled="1"
156 .\" A control variable may look like:
158 .\" .Bd -literal -offset indent
159 .\" debug.acpi.layer="ACPI_RESOURCES"
165 .Xr resource_int_value 9
169 file first appeared in