sbin/reboot/boot_i386.8

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software written and contributed
   5 .\" to Berkeley by William Jolitz.
   6 .\"
   7 .\" Almost completely rewritten for FreeBSD 2.1 by Joerg Wunsch.
   8 .\"
   9 .\" Substantially revised for FreeBSD 3.1 by Robert Nordier.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)boot_i386.8 8.2 (Berkeley) 4/19/94
  36 .\"
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd July 1, 2013
  40 .Dt BOOT 8 i386
  41 .Os
  42 .Sh NAME
  43 .Nm boot
  44 .Nd system bootstrapping procedures
  45 .Sh DESCRIPTION
  46 .Sy Power fail and crash recovery .
  47 Normally, the system will reboot itself at power-up or after crashes.
  48 An automatic consistency check of the file systems will be performed,
  49 and unless this fails, the system will resume multi-user operations.
  50 .Pp
  51 .Sy Cold starts .
  52 Most i386 PCs attempt to boot first from floppy disk drive 0 (sometimes
  53 known as drive A:) and, failing that, from hard disk drive 0 (sometimes
  54 known as drive C:, or as drive 0x80 to the BIOS).
  55 Some BIOSes allow
  56 you to change this default sequence, and may also include a CD-ROM
  57 drive as a boot device.
  58 .Pp
  59 By default, a three-stage bootstrap is employed, and control is
  60 automatically passed from the boot blocks (bootstrap stages one and
  61 two) to a separate third-stage bootstrap program,
  62 .Xr loader 8 .
  63 This third stage provides more sophisticated control over the booting
  64 process than it is possible to achieve in the boot blocks, which are
  65 constrained by occupying limited fixed space on a given disk or slice.
  66 .Pp
  67 However, it is possible to dispense with the third stage altogether,
  68 either by specifying a kernel name in the boot block parameter
  69 file,
  70 .Pa /boot.config ,
  71 or, unless option
  72 .Fl n
  73 is set, by hitting a key during a brief pause (while one of the characters
  74 .Sy - ,
  75 .Sy \e ,
  76 .Sy \&| ,
  77 or
  78 .Sy /
  79 is displayed) before
  80 .Xr loader 8
  81 is invoked.
  82 Booting will also be attempted at stage two, if the
  83 third stage cannot be loaded.
  84 .Pp
  85 The remainder of this subsection deals only with the boot blocks.
  86 The
  87 .Xr loader 8
  88 program is documented separately.
  89 .Pp
  90 After the boot blocks have been loaded,
  91 you should see a prompt similar to the following:
  92 .Bd -literal
  93 >> FreeBSD/i386 BOOT
  94 Default: 0:ad(0,a)/boot/loader
  95 boot:
  96 .Ed
  97 .Pp
  98 The automatic boot will attempt to load
  99 .Pa /boot/loader
 100 from partition
 101 .Ql a
 102 of either the floppy or the hard disk.
 103 This boot may be aborted by typing any character on the keyboard
 104 at the
 105 .Ql boot:
 106 prompt.
 107 At this time, the following input will be accepted:
 108 .Bl -tag -width indent
 109 .It Ic \&?
 110 Give a short listing of the files in the root directory of the default
 111 boot device, as a hint about available boot files.
 112 (A
 113 .Ic ?\&
 114 may also be specified as the last segment of a path, in which case
 115 the listing will be of the relevant subdirectory.)
 116 .Pp
 117 .It Xo
 118 .Sm off
 119 .Ar bios_drive : interface ( unit , Oo Ar slice , Oc Ar part )
 120 .Ar filename
 121 .Sm on
 122 .Op Fl aCcDdghmnPprsv
 123 .Op Fl S Ns Ar speed
 124 .Xc
 125 Specify boot file and flags.
 126 .Bl -tag -width indent
 127 .It Ar bios_drive
 128 The drive number as recognized by the BIOS.
 129 0 for the first drive, 1 for the second drive, etc.
 130 .It Ar interface
 131 The type of controller to boot from.
 132 Note that the controller is required
 133 to have BIOS support since the BIOS services are used to load the
 134 boot file image.
 135 .Pp
 136 The supported interfaces are:
 137 .Pp
 138 .Bl -tag -width "adXX" -compact
 139 .It ad
 140 ST506, IDE, ESDI, RLL disks on a WD100[2367] or lookalike
 141 controller
 142 .It fd
 143 5 1/4" or 3 1/2" High density floppies
 144 .It da
 145 SCSI disk on any supported SCSI controller
 146 .\".It cd
 147 .\"boot from CDROM
 148 .El
 149 .It Ar unit
 150 The unit number of the drive on the interface being used.
 151 0 for the first drive, 1 for the second drive, etc.
 152 .It Oo Ar slice , Oc Ns Ar part
 153 The partition letter inside the
 154 .Bx
 155 portion of the disk.
 156 See
 157 .Xr bsdlabel 8 .
 158 By convention, only partition
 159 .Ql a
 160 contains a bootable image.
 161 If sliced disks are used
 162 .Pq Dq fdisk partitions ,
 163 any
 164 .Ar slice
 165 (1 for the first slice, 2 for the second slice, etc.\&)
 166 can be booted from, with the default (if not specified) being the active slice
 167 or, otherwise, the first
 168 .Fx
 169 slice.
 170 If
 171 .Ar slice
 172 is specified as 0, the first
 173 .Fx
 174 slice (also known as
 175 .Dq compatibility
 176 slice) is booted from.
 177 .It Ar filename
 178 The pathname of the file to boot (relative to the root directory
 179 on the specified partition).
 180 Defaults to
 181 .Pa /boot/kernel/kernel .
 182 Symbolic links are not supported (hard links are).
 183 .It Xo Op Fl aCcDdghmnPpqrsv
 184 .Op Fl S Ns Ar speed
 185 .Xc
 186 Boot flags:
 187 .Pp
 188 .Bl -tag -width "-CXX" -compact
 189 .It Fl a
 190 during kernel initialization,
 191 ask for the device to mount as the root file system.
 192 .It Fl C
 193 try to mount root file system from a CD-ROM.
 194 .It Fl c
 195 this flag is currently a no-op.
 196 .It Fl D
 197 boot with the dual console configuration.
 198 In the single
 199 configuration, the console will be either the internal display
 200 or the serial port, depending on the state of the
 201 .Fl h
 202 option below.
 203 In the dual console configuration,
 204 both the internal display and the serial port will become the console
 205 at the same time, regardless of the state of the
 206 .Fl h
 207 option.
 208 .It Fl d
 209 enter the DDB kernel debugger
 210 (see
 211 .Xr ddb 4 )
 212 as early as possible in kernel initialization.
 213 .It Fl g
 214 use the GDB remote debugging protocol.
 215 .It Fl h
 216 force the serial console.
 217 For instance, if you boot from the internal console,
 218 you can use the
 219 .Fl h
 220 option to force the kernel to use the serial port as its
 221 console device.
 222 The serial port driver
 223 .Xr uart 4
 224 has a flag (0x20) to override this option.
 225 If that flag is set, the serial port will always be used as the console,
 226 regardless of the
 227 .Fl h
 228 option described here.
 229 See the man page for
 230 .Xr uart 4
 231 for more details.
 232 .It Fl m
 233 mute the console to suppress all console input and output during the
 234 boot.
 235 .It Fl n
 236 ignore key press to interrupt boot before
 237 .Xr loader 8
 238 is invoked.
 239 .It Fl P
 240 probe the keyboard.
 241 If no keyboard is found, the
 242 .Fl D
 243 and
 244 .Fl h
 245 options are automatically set.
 246 .It Fl p
 247 pause after each attached device during the device probing phase.
 248 .It Fl q
 249 be quiet,
 250 do not write anything to the console unless automatic boot fails or
 251 is disabled.
 252 This option only affects second-stage bootstrap,
 253 to prevent next stages from writing to the console use in
 254 combination with the
 255 .Fl m
 256 option.
 257 .It Fl r
 258 use the statically configured default for the device containing the
 259 root file system
 260 (see
 261 .Xr config 8 ) .
 262 Normally, the root file system is on the device
 263 that the kernel was loaded from.
 264 .It Fl s
 265 boot into single-user mode; if the console is marked as
 266 .Dq insecure
 267 (see
 268 .Xr ttys 5 ) ,
 269 the root password must be entered.
 270 .It Fl S Ns Ar speed
 271 set the speed of the serial console to
 272 .Ar speed .
 273 The default is 9600 unless it has been overridden by setting
 274 .Va BOOT_COMCONSOLE_SPEED
 275 in
 276 .Xr make.conf 5
 277 and recompiling and reinstalling the boot blocks.
 278 .It Fl v
 279 be verbose during device probing (and later).
 280 .El
 281 .El
 282 .El
 283 .Pp
 284 Use the
 285 .Pa /boot.config
 286 file to set the default configuration options for the boot block code.
 287 See
 288 .Xr boot.config 5
 289 for more information about the
 290 .Pa /boot.config
 291 file.
 292 .Sh FILES
 293 .Bl -tag -width /boot/loader -compact
 294 .It Pa /boot.config
 295 parameters for the boot blocks (optional)
 296 .It Pa /boot/boot1
 297 first stage bootstrap file
 298 .It Pa /boot/boot2
 299 second stage bootstrap file
 300 .It Pa /boot/loader
 301 third stage bootstrap
 302 .It Pa /boot/kernel/kernel
 303 default kernel
 304 .It Pa /boot/kernel.old/kernel
 305 typical non-default kernel (optional)
 306 .El
 307 .Sh DIAGNOSTICS
 308 When disk-related errors occur, these are reported by the second-stage
 309 bootstrap using the same error codes returned by the BIOS, for example
 310 .Dq Disk error 0x1 (lba=0x12345678) .
 311 Here is a partial list of these error codes:
 312 .Pp
 313 .Bl -tag -width "0x80" -compact
 314 .It 0x1
 315 Invalid argument
 316 .It 0x2
 317 Address mark not found
 318 .It 0x4
 319 Sector not found
 320 .It 0x8
 321 DMA overrun
 322 .It 0x9
 323 DMA attempt across 64K boundary
 324 .It 0xc
 325 Invalid media
 326 .It 0x10
 327 Uncorrectable CRC/ECC error
 328 .It 0x20
 329 Controller failure
 330 .It 0x40
 331 Seek failed
 332 .It 0x80
 333 Timeout
 334 .El
 335 .Pp
 336 .Sy "NOTE" :
 337 On older machines, or otherwise where EDD support (disk packet
 338 interface support) is not available, all boot-related files and
 339 structures (including the kernel) that need to be accessed during the
 340 boot phase must reside on the disk at or below cylinder 1023 (as the
 341 BIOS understands the geometry).
 342 When a
 343 .Dq Disk error 0x1
 344 is reported by the second-stage bootstrap, it generally means that this
 345 requirement has not been adhered to.
 346 .Sh SEE ALSO
 347 .Xr ddb 4 ,
 348 .Xr boot.config 5 ,
 349 .Xr make.conf 5 ,
 350 .Xr ttys 5 ,
 351 .Xr boot0cfg 8 ,
 352 .Xr bsdlabel 8 ,
 353 .Xr btxld 8 ,
 354 .Xr config 8 ,
 355 .Xr gptboot 8 ,
 356 .Xr halt 8 ,
 357 .Xr loader 8 ,
 358 .Xr nextboot 8 ,
 359 .Xr reboot 8 ,
 360 .Xr shutdown 8
 361 .Sh BUGS
 362 The bsdlabel format used by this version of
 363 .Bx
 364 is quite
 365 different from that of other architectures.
 366 .Pp
 367 Due to space constraints, the keyboard probe initiated by the
 368 .Fl P
 369 option is simply a test that the BIOS has detected an
 370 .Dq extended
 371 keyboard.
 372 If an
 373 .Dq XT/AT
 374 keyboard (with no F11 and F12 keys, etc.) is attached, the probe will
 375 fail.