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 .\" 3. 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 April 30, 2019
  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 Some newer PCs boot using UEFI firmware, not BIOS.
  60 That process is described
  61 in
  62 .Xr uefi 8 .
  63 .Pp
  64 By default, a three-stage bootstrap is employed, and control is
  65 automatically passed from the boot blocks (bootstrap stages one and
  66 two) to a separate third-stage bootstrap program,
  67 .Xr loader 8 .
  68 This third stage provides more sophisticated control over the booting
  69 process than it is possible to achieve in the boot blocks, which are
  70 constrained by occupying limited fixed space on a given disk or slice.
  71 .Pp
  72 However, it is possible to dispense with the third stage altogether,
  73 either by specifying a kernel name in the boot block parameter
  74 file,
  75 .Pa /boot.config ,
  76 or, unless option
  77 .Fl n
  78 is set, by hitting a key during a brief pause (while one of the characters
  79 .Sy - ,
  80 .Sy \e ,
  81 .Sy \&| ,
  82 or
  83 .Sy /
  84 is displayed) before
  85 .Xr loader 8
  86 is invoked.
  87 Booting will also be attempted at stage two, if the
  88 third stage cannot be loaded.
  89 .Pp
  90 The remainder of this subsection deals only with the boot blocks.
  91 The
  92 .Xr loader 8
  93 program is documented separately.
  94 .Pp
  95 After the boot blocks have been loaded,
  96 you should see a prompt similar to the following:
  97 .Bd -literal
  98 >> FreeBSD/x86 BOOT
  99 Default: 0:ad(0,a)/boot/loader
 100 boot:
 101 .Ed
 102 .Pp
 103 The automatic boot will attempt to load
 104 .Pa /boot/loader
 105 from partition
 106 .Ql a
 107 of either the floppy or the hard disk.
 108 This boot may be aborted by typing any character on the keyboard
 109 at the
 110 .Ql boot:
 111 prompt.
 112 At this time, the following input will be accepted:
 113 .Bl -tag -width indent
 114 .It Ic \&?
 115 Give a short listing of the files in the root directory of the default
 116 boot device, as a hint about available boot files.
 117 (A
 118 .Ic ?\&
 119 may also be specified as the last segment of a path, in which case
 120 the listing will be of the relevant subdirectory.)
 121 .It Xo
 122 .Sm off
 123 .Ar bios_drive : interface ( unit , Oo Ar slice , Oc Ar part )
 124 .Ar filename
 125 .Sm on
 126 .Op Fl aCcDdghmnPprsv
 127 .Op Fl S Ns Ar speed
 128 .Xc
 129 Specify boot file and flags.
 130 .Bl -tag -width indent
 131 .It Ar bios_drive
 132 The drive number as recognized by the BIOS.
 133 0 for the first drive, 1 for the second drive, etc.
 134 .It Ar interface
 135 The type of controller to boot from.
 136 Note that the controller is required
 137 to have BIOS support since the BIOS services are used to load the
 138 boot file image.
 139 .Pp
 140 The supported interfaces are:
 141 .Pp
 142 .Bl -tag -width "adXX" -compact
 143 .It ad
 144 ST506, IDE, ESDI, RLL disks on a WD100[2367] or lookalike
 145 controller
 146 .It fd
 147 5 1/4" or 3 1/2" High density floppies
 148 .It da
 149 SCSI disk on any supported SCSI controller
 150 .\".It cd
 151 .\"boot from CDROM
 152 .El
 153 .It Ar unit
 154 The unit number of the drive on the interface being used.
 155 0 for the first drive, 1 for the second drive, etc.
 156 .It Oo Ar slice , Oc Ns Ar part
 157 The partition letter inside the
 158 .Bx
 159 portion of the disk.
 160 See
 161 .Xr bsdlabel 8 .
 162 By convention, only partition
 163 .Ql a
 164 contains a bootable image.
 165 If sliced disks are used
 166 .Pq Dq fdisk partitions ,
 167 any
 168 .Ar slice
 169 (1 for the first slice, 2 for the second slice, etc.\&)
 170 can be booted from, with the default (if not specified) being the active slice
 171 or, otherwise, the first
 172 .Fx
 173 slice.
 174 If
 175 .Ar slice
 176 is specified as 0, the first
 177 .Fx
 178 slice (also known as
 179 .Dq compatibility
 180 slice) is booted from.
 181 .It Ar filename
 182 The pathname of the file to boot (relative to the root directory
 183 on the specified partition).
 184 Defaults to
 185 .Pa /boot/kernel/kernel .
 186 Symbolic links are not supported (hard links are).
 187 .It Xo Op Fl aCcDdghmnPpqrsv
 188 .Op Fl S Ns Ar speed
 189 .Xc
 190 Boot flags:
 191 .Pp
 192 .Bl -tag -width "-CXX" -compact
 193 .It Fl a
 194 during kernel initialization,
 195 ask for the device to mount as the root file system.
 196 .It Fl C
 197 try to mount root file system from a CD-ROM.
 198 .It Fl c
 199 this flag is currently a no-op.
 200 .It Fl D
 201 boot with the dual console configuration.
 202 In the single
 203 configuration, the console will be either the internal display
 204 or the serial port, depending on the state of the
 205 .Fl h
 206 option below.
 207 In the dual console configuration,
 208 both the internal display and the serial port will become the console
 209 at the same time, regardless of the state of the
 210 .Fl h
 211 option.
 212 .It Fl d
 213 enter the DDB kernel debugger
 214 (see
 215 .Xr ddb 4 )
 216 as early as possible in kernel initialization.
 217 .It Fl g
 218 use the GDB remote debugging protocol.
 219 .It Fl h
 220 force the serial console.
 221 For instance, if you boot from the internal console,
 222 you can use the
 223 .Fl h
 224 option to force the kernel to use the serial port as its
 225 console device.
 226 The serial port driver
 227 .Xr sio 4
 228 (but not
 229 .Xr uart 4 )
 230 has a flag (0x20) to override this option.
 231 If that flag is set, the serial port will always be used as the console,
 232 regardless of the
 233 .Fl h
 234 option described here.
 235 .It Fl m
 236 mute the console to suppress all kernel console input and output during the
 237 boot.
 238 .It Fl n
 239 ignore key press to interrupt boot before
 240 .Xr loader 8
 241 is invoked.
 242 .It Fl P
 243 probe the keyboard.
 244 If no keyboard is found, the
 245 .Fl D
 246 and
 247 .Fl h
 248 options are automatically set.
 249 .It Fl p
 250 pause after each attached device during the device probing phase.
 251 .It Fl q
 252 be quiet,
 253 do not write anything to the console unless automatic boot fails or
 254 is disabled.
 255 This option only affects second-stage bootstrap,
 256 to prevent next stages from writing to the console use in
 257 combination with the
 258 .Fl m
 259 option.
 260 .It Fl r
 261 use the statically configured default for the device containing the
 262 root file system
 263 (see
 264 .Xr config 8 ) .
 265 Normally, the root file system is on the device
 266 that the kernel was loaded from.
 267 .It Fl s
 268 boot into single-user mode; if the console is marked as
 269 .Dq insecure
 270 (see
 271 .Xr ttys 5 ) ,
 272 the root password must be entered.
 273 .It Fl S Ns Ar speed
 274 set the speed of the serial console to
 275 .Ar speed .
 276 The default is 9600 unless it has been overridden by setting
 277 .Va BOOT_COMCONSOLE_SPEED
 278 in
 279 .Xr make.conf 5
 280 and recompiling and reinstalling the boot blocks.
 281 .It Fl v
 282 be verbose during device probing (and later).
 283 .El
 284 .El
 285 .El
 286 .Pp
 287 Use the
 288 .Pa /boot.config
 289 file to set the default configuration options for the boot block code.
 290 See
 291 .Xr boot.config 5
 292 for more information about the
 293 .Pa /boot.config
 294 file.
 295 .Sh FILES
 296 .Bl -tag -width /boot/loader -compact
 297 .It Pa /boot.config
 298 parameters for the boot blocks (optional)
 299 .It Pa /boot/boot1
 300 first stage bootstrap file
 301 .It Pa /boot/boot2
 302 second stage bootstrap file
 303 .It Pa /boot/loader
 304 third stage bootstrap
 305 .It Pa /boot/kernel/kernel
 306 default kernel
 307 .It Pa /boot/kernel.old/kernel
 308 typical non-default kernel (optional)
 309 .El
 310 .Sh DIAGNOSTICS
 311 When disk-related errors occur, these are reported by the second-stage
 312 bootstrap using the same error codes returned by the BIOS, for example
 313 .Dq Disk error 0x1 (lba=0x12345678) .
 314 Here is a partial list of these error codes:
 315 .Pp
 316 .Bl -tag -width "0x80" -compact
 317 .It 0x1
 318 Invalid argument
 319 .It 0x2
 320 Address mark not found
 321 .It 0x4
 322 Sector not found
 323 .It 0x8
 324 DMA overrun
 325 .It 0x9
 326 DMA attempt across 64K boundary
 327 .It 0xc
 328 Invalid media
 329 .It 0x10
 330 Uncorrectable CRC/ECC error
 331 .It 0x20
 332 Controller failure
 333 .It 0x40
 334 Seek failed
 335 .It 0x80
 336 Timeout
 337 .El
 338 .Pp
 339 .Sy "NOTE" :
 340 On older machines, or otherwise where EDD support (disk packet
 341 interface support) is not available, all boot-related files and
 342 structures (including the kernel) that need to be accessed during the
 343 boot phase must reside on the disk at or below cylinder 1023 (as the
 344 BIOS understands the geometry).
 345 When a
 346 .Dq Disk error 0x1
 347 is reported by the second-stage bootstrap, it generally means that this
 348 requirement has not been adhered to.
 349 .Sh SEE ALSO
 350 .Xr ddb 4 ,
 351 .Xr boot.config 5 ,
 352 .Xr make.conf 5 ,
 353 .Xr mount.conf 5 ,
 354 .Xr ttys 5 ,
 355 .Xr boot0cfg 8 ,
 356 .Xr btxld 8 ,
 357 .Xr config 8 ,
 358 .Xr gpart 8 ,
 359 .Xr gptboot 8 ,
 360 .Xr halt 8 ,
 361 .Xr loader 8 ,
 362 .Xr nextboot 8 ,
 363 .Xr reboot 8 ,
 364 .Xr shutdown 8 ,
 365 .Xr uefi 8
 366 .Sh BUGS
 367 The bsdlabel format used by this version of
 368 .Bx
 369 is quite
 370 different from that of other architectures.
 371 .Pp
 372 Due to space constraints, the keyboard probe initiated by the
 373 .Fl P
 374 option is simply a test that the BIOS has detected an
 375 .Dq extended
 376 keyboard.
 377 If an
 378 .Dq XT/AT
 379 keyboard (with no F11 and F12 keys, etc.) is attached, the probe will
 380 fail.