Index: share/man/man5/device.hints.5 =================================================================== --- share/man/man5/device.hints.5 +++ share/man/man5/device.hints.5 @@ -34,43 +34,41 @@ .Sh DESCRIPTION The .Nm -file is read in by the boot -.Xr loader 8 -when the system is about to start, and its contents are -passed to the kernel. -It contains various variables to control the boot behavior of -the kernel. +file is read by the boot loader, +.Xr loader 8 , +when the system is starting. +The contents of the file +are read, parsed into variables, and passed to the kernel. +Variables that control the boot behavior of +the kernel are defined here. These variables are typically .Dq device hints , but can include any kernel tunable values. .Pp -The file contains one variable per line. +One variable is defined per line. Lines starting with the .Ql # character are comments and are ignored by the boot loader. .Pp -After the file is read by the boot loader, you may examine -the variables with the +After the boot loader has read the file, variables can be +examined with the .Ic show -command, and may add a new variable, modify an existing one, -or delete a variable with the +command, or added, modified, or deleted with the .Ic set and .Ic unset -commands of the boot loader -(see -.Xr loader 8 ) . +commands +.Pq see Xr loader 8 . .Pp -After the system has started, you can dump these variables -with the .Xr kenv 1 -command. +can be used to dump these and other kernel environment variables +after the kernel has booted. .Sh DEVICE HINTS Device hint variables are used by device drivers to set up the device. -They are most often used by ISA device drivers to specify -where the driver will probe for the relevant devices, and what -resources it will attempt to use. +They are most often used for ISA or System-on-Chip device drivers, specifying +the location to probe for the devices and which +resources are to be used. .Pp A device hint line looks like: .Pp @@ -85,36 +83,35 @@ is the unit number, and .Ar keyword is the keyword of the hint. -The keyword may be: +Typical keywords include: .Pp .Bl -tag -width ".Li disabled" -compact -offset indent .It Li at -specifies a bus to which the device is attached. +bus to which the device is attached .It Li port -specifies the start address of I/O ports to be used by the device. +start address of I/O ports to be used by the device .It Li portsize -specifies the number of ports used by the device. +number of ports used by the device .It Li irq -is the interrupt line number to be used. +interrupt line number to be used .It Li drq -is the DMA channel number. +DMA channel number .It Li maddr -specifies the physical memory address used by the device. +physical memory address used by the device .It Li msize -specifies the physical memory size used by the device. +physical memory size used by the device .It Li flags -sets various flag bits for the device. +various flag bits for the device .It Li disabled -can be set to +set to .Qq 1 -to disable the device. +to disable the device .El .Pp -A device driver may require one or more hint lines with these keywords, -and may accept other keywords not listed here, through -.Xr resource_int_value 9 . +A device driver might require one or more hint lines with these keywords, +and can accept other keywords not listed here. Consult individual device drivers' manual pages for available -keywords and their possible values. +keywords and values. .\" .Sh CONTROL VARIABLES .\" Lines not starting with .\" .Dq hint. @@ -137,7 +134,7 @@ Notes on the kernel configuration file and device resource hints. .El .Sh EXAMPLES -The following example sets up resources for the +Set up resources for the .Xr sio 4 driver on the ISA bus: .Bd -literal -offset indent @@ -147,7 +144,7 @@ hint.sio.0.irq="4" .Ed .Pp -The following example disables the ACPI driver: +Disable the ACPI driver: .Bd -literal -offset indent hint.acpi.0.disabled="1" .Ed