share/man/man8/man8.i386/boot_console.8

   1 .\"     $NetBSD: boot_console.8,v 1.13 2004/07/03 20:04:03 mycroft Exp $
   2 .\"
   3 .\" Copyright (c) 1997
   4 .\"     Matthias Drochner.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  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 AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .Dd July 3, 2004
  28 .Dt BOOT_CONSOLE 8 i386
  29 .Os
  30 .Sh NAME
  31 .Nm boot_console
  32 .Nd selection of a console device in the i386 bootloader
  33 .\"
  34 .Sh DESCRIPTION
  35 The
  36 .Nx
  37 i386 bootloader selects a console device for its user interaction and
  38 passes information about it to the
  39 .Nx
  40 kernel.
  41 When booting from the system BIOS, the console device and properties
  42 are saved in the primary bootstrap by
  43 .Xr installboot 8 .
  44 For other boot procedures (such as
  45 .Xr dosboot 8 )
  46 the selection process is controlled by bootloader compile-time
  47 options and system setup at the bootloader startup time.
  48 The selection may be changed on-the-fly from within the bootloader.
  49 .\"
  50 .Ss Serial Console Options
  51 The compile-time options (to be set in the booter's
  52 .Dq Makefile )
  53 are:
  54 .Bl -ohang
  55 .It Sy SUPPORT_SERIAL= Ns Fa policy
  56 enables support for serial input/output.
  57 By default this option is
  58 not set and the standard PC keyboard and display are always used as the
  59 console device.
  60 See
  61 .Sx Console Selection Policy
  62 below for valid values of
  63 .Fa policy .
  64 .It Sy DIRECT_SERIAL
  65 causes direct hardware access to be used for serial input / output.
  66 With this option, software handshake (XON/XOFF) is used for flow
  67 control.
  68 Without this option, BIOS functions are employed for serial
  69 port handling, which require hardware handshake lines to be completely
  70 wired.
  71 .It Sy CONSPEED= Ns Fa integer
  72 sets the baud-rate for the serial console.
  73 This option has only an effect when used in combination with the
  74 .Dq Dv DIRECT_SERIAL
  75 option above, otherwise, the default setting of 9600 baud is used.
  76 The value of
  77 .Fa integer
  78 must be something that makes sense as a serial port baud rate.
  79 .It Sy COMCONS_KEYPRESS
  80 Require a character input within seven (7) seconds from serial console
  81 device to be selected.
  82 .El
  83 .\"
  84 .Ss Console Selection Policy
  85 The actual policy for the console selection is determined by the value
  86 of
  87 .Dq Dv SUPPORT_SERIAL
  88 The following options are available:
  89 .Bl -ohang
  90 .It Em CONSDEV_PC
  91 Force use of the standard PC keyboard and display as the console.
  92 .It Em CONSDEV_COM0 Li ... Em CONSDEV_COM3
  93 Use the serial port with the corresponding BIOS number as the console.
  94 No attempt is made to verify connectivity on the selected port.
  95 If the port is not known to the BIOS, it falls back to
  96 .Dq Dv CONSDEV_PC .
  97 (Note: This feature can be deliberately used for console selection if
  98 the serial ports have been disabled in the BIOS.)
  99 .It Em CONSDEV_COM0KBD Li ... Em CONSDEV_COM3KBD
 100 If the port is known to the BIOS, and output of a character to the port
 101 succeeds (and if
 102 .Dq Dv DIRECT_SERIAL
 103 is defined the RS-232
 104 .Dq "modem ready"
 105 status is on after the character is output), the port is used as
 106 console.
 107 If the port is not known to the BIOS, or the test output fails, it falls back
 108 to
 109 .Dq Dv CONSDEV_PC .
 110 .It Em CONSDEV_AUTO
 111 Auto-select the console.
 112 All serial ports known to the BIOS are probed in sequence.
 113 If output of a character to the port succeeds (and if
 114 .Dq Dv DIRECT_SERIAL
 115 is defined the RS-232
 116 .Dq "modem ready"
 117 status is on after the character is output), the port is used as console.
 118 If no serial port passes the check,
 119 .Dq Dv CONSDEV_PC
 120 is used.
 121 The progress of the selection process is shown at the PC display as
 122 digits corresponding to the serial port number currently probed.
 123 .El
 124 .\"
 125 .Sh FILES
 126 .Bl -tag -width /sys/arch/i386/stand/{bios,dos,net}boot/Makefile
 127 .It Pa /sys/arch/i386/stand/{bios,dos,net}boot/Makefile
 128 compile time options for the boot programs.
 129 .El
 130 .\"
 131 .Sh SEE ALSO
 132 .Xr console 4 ,
 133 .Xr boot 8 ,
 134 .Xr installboot 8
 135 .\"
 136 .Sh BUGS
 137 The value of
 138 .Dv SERIAL_POLICY
 139 should be settable through a boot configuration option.
 140 However traditionally there was no non-volatile storage available on the
 141 PC platform.
 142 This requires console auto-selection methods which can be
 143 inconvenient and/or unstable in some situations.
 144 The selection policy should be adapted to the local hardware configuration,
 145 which might require code changes.
 146 (Some BIOS versions, particularly those used on
 147 large servers and in embedded and single-board industrial computers,
 148 have integrated support for serial consoles.
 149 The boot loader should query for these settings if possible.)
 150 .Pp
 151 The serial communication parameters (byte-size, parity, stop-bits) are
 152 not settable (either at compile time or run time).
 153 The default parameters are
 154 .Dq "8 N 1" .
 155 .Pp
 156 The baud rate is not settable when using BIOS I/O.
 157 It should be settable at compile time with
 158 .Dq Dv CONSPEED
 159 just as it is when using
 160 .Dq Dv DIRECT_SERIAL .
 161 The default speed is 9600 baud (the maximum for BIOS I/O).