share/man/man5/device.hints.5

   1 .\" Copyright (c) 2001
   2 .\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   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.
  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, 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.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd July 23, 2015
  29 .Dt DEVICE.HINTS 5
  30 .Os
  31 .Sh NAME
  32 .Nm device.hints
  33 .Nd device resource hints
  34 .Sh DESCRIPTION
  35 The
  36 .Nm
  37 file is read in by the boot
  38 .Xr loader 8
  39 when the system is about to start, and its contents are
  40 passed to the kernel.
  41 It contains various variables to control the boot behavior of
  42 the kernel.
  43 These variables are typically
  44 .Dq device hints ,
  45 but can include any kernel tunable values.
  46 .Pp
  47 The file contains one variable per line.
  48 Lines starting with the
  49 .Ql #
  50 character are comments and are ignored by the boot loader.
  51 .Pp
  52 After the file is read by the boot loader, you may examine
  53 the variables with the
  54 .Ic show
  55 command, and may add a new variable, modify an existing one,
  56 or delete a variable with the
  57 .Ic set
  58 and
  59 .Ic unset
  60 commands of the boot loader
  61 (see
  62 .Xr loader 8 ) .
  63 .Pp
  64 After the system has started, you can dump these variables
  65 with the
  66 .Xr kenv 1
  67 command.
  68 .Sh DEVICE HINTS
  69 Device hint variables are used by device drivers to set up
  70 the device.
  71 They are most often used by ISA device drivers to specify
  72 where the driver will probe for the relevant devices, and what
  73 resources it will attempt to use.
  74 .Pp
  75 A device hint line looks like:
  76 .Pp
  77 .Sm off
  78 .D1 Li hint. Ar driver . Ar unit . Ar keyword Li = Qq Ar value
  79 .Sm on
  80 .Pp
  81 where
  82 .Ar driver
  83 is the name of a device driver,
  84 .Ar unit
  85 is the unit number, and
  86 .Ar keyword
  87 is the keyword of the hint.
  88 The keyword may be:
  89 .Pp
  90 .Bl -tag -width ".Li disabled" -compact -offset indent
  91 .It Li at
  92 specifies a bus to which the device is attached.
  93 .It Li port
  94 specifies the start address of I/O ports to be used by the device.
  95 .It Li portsize
  96 specifies the number of ports used by the device.
  97 .It Li irq
  98 is the interrupt line number to be used.
  99 .It Li drq
 100 is the DMA channel number.
 101 .It Li maddr
 102 specifies the physical memory address used by the device.
 103 .It Li msize
 104 specifies the physical memory size used by the device.
 105 .It Li flags
 106 sets various flag bits for the device.
 107 .It Li disabled
 108 can be set to
 109 .Qq 1
 110 to disable the device.
 111 .El
 112 .Pp
 113 A device driver may require one or more hint lines with these keywords,
 114 and may accept other keywords not listed here, through
 115 .Xr resource_int_value 9 .
 116 Consult individual device drivers' manual pages for available
 117 keywords and their possible values.
 118 .\" .Sh CONTROL VARIABLES
 119 .\" Lines not starting with
 120 .\" .Dq hint.
 121 .\" specify other control variables for the kernel.
 122 .\" They look:
 123 .\" .Pp
 124 .\" .Dl <name>="<value>"
 125 .\" XXX
 126 .\" WE SHOULD LIST AVAILABLE VARIABLE NAMES AND THEIR POSSIBLE VALUES HERE!
 127 .\" .Pp
 128 .Sh FILES
 129 .Bl -tag -width ".Pa /sys/ Ns Ar ARCH Ns Pa /conf/GENERIC.hints" -compact
 130 .It Pa /boot/device.hints
 131 Device resource hints file.
 132 .It Pa /sys/ Ns Ar ARCH Ns Pa /conf/GENERIC.hints
 133 Sample resource hints for the
 134 .Pa GENERIC
 135 kernel.
 136 .It Pa /sys/ Ns Ar ARCH Ns Pa /conf/NOTES
 137 Notes on the kernel configuration file and device resource hints.
 138 .El
 139 .Sh EXAMPLES
 140 The following example sets up resources for the
 141 .Xr sio 4
 142 driver on the ISA bus:
 143 .Bd -literal -offset indent
 144 hint.sio.0.at="isa"
 145 hint.sio.0.port="0x3F8"
 146 hint.sio.0.flags="0x10"
 147 hint.sio.0.irq="4"
 148 .Ed
 149 .Pp
 150 The following example disables the ACPI driver:
 151 .Bd -literal -offset indent
 152 hint.acpi.0.disabled="1"
 153 .Ed
 154 .Pp
 155 Setting a tunable variable:
 156 .Bd -literal -offset indent
 157 vm.pmap.pg_ps_enabled=1
 158 .Ed
 159 .Sh SEE ALSO
 160 .Xr kenv 1 ,
 161 .Xr loader.conf 5 ,
 162 .Xr loader 8 ,
 163 .Xr resource_int_value 9
 164 .Sh HISTORY
 165 The
 166 .Nm
 167 file first appeared in
 168 .Fx 5.0 .