Put in remaining pages and wiki contents.
[ikiwiki.git] / docs / handbook / handbook-serialconsole-setup.mdwn
1 \r
2 \r
3 ## 17.6 Setting Up the Serial Console \r
4 \r
5 ***Contributed by Kazutaka YOKOTA. ******Based on a document by Bill Paul. ***\r
6 \r
7 ### 17.6.1 Introduction \r
8 \r
9 DragonFly has the ability to boot on a system with only a dumb terminal on a serial port as a console. Such a configuration should be useful for two classes of people: system administrators who wish to install DragonFly on machines that have no keyboard or monitor attached, and developers who want to debug the kernel or device drivers.\r
10 \r
11 As described in [boot.html Chapter 7], DragonFly employs a three stage bootstrap. The first two stages are in the boot block code which is stored at the beginning of the DragonFly slice on the boot disk. The boot block will then load and run the boot loader (`/boot/loader`) as the third stage code.\r
12 \r
13 In order to set up the serial console you must configure the boot block code, the boot loader code and the kernel.\r
14 \r
15 ### 17.6.2 Serial Console Configuration, Terse Version \r
16 \r
17 This section assumes that you are using the default setup, know how to connect serial ports and just want a fast overview of a serial console. If you encounter difficulty with these steps, please see the more extensive explaination of all the options and advanced settings in [serialconsole-setup.html#SERIALCONSOLE-HOWTO Section 17.6.3].\r
18 \r
19   1. Connect the serial port. The serial console will be on COM1.\r
20   1. `echo -h > /boot.config` to enable the serial console for the boot loader and kernel.\r
21   1. Edit `/etc/ttys` and change `off` to `on` for the `ttyd0` entry. This enables a login prompt on the serial console, which mirrors how video consoles are typically setup.\r
22   1. `shutdown -r now` will reboot the system with the serial console.\r
23 \r
24 ### 17.6.3 Serial Console Configuration \r
25 \r
26   1. Prepare a serial cable.\r
27   You will need either a null-modem cable or a standard serial cable and a null-modem adapter. See [ Section 17.2.2](serial.html#SERIAL-CABLES-PORTS) for a discussion on serial cables.\r
28   1. Unplug your keyboard.\r
29   Most PC systems probe for the keyboard during the Power-On Self-Test (POST) and will generate an error if the keyboard is not detected. Some machines complain loudly about the lack of a keyboard and will not continue to boot until it is plugged in.\r
30   If your computer complains about the error, but boots anyway, then you do not have to do anything special. (Some machines with Phoenix BIOS installed merely say ***`Keyboard failed`*** and continue to boot normally.)\r
31   If your computer refuses to boot without a keyboard attached then you will have to configure the BIOS so that it ignores this error (if it can). Consult your motherboard's manual for details on how to do this.\r
32    **Tip:** Setting the keyboard to ***Not installed*** in the BIOS setup does ***not*** mean that you will not be able to use your keyboard. All this does is tell the BIOS not to probe for a keyboard at power-on, so it will not complain if the keyboard is not plugged in. You can leave the keyboard plugged in even with this flag set to ***Not installed*** and the keyboard will still work.\r
33    **Note:** If your system has a PS/2® mouse, chances are very good that you may have to unplug your mouse as well as your keyboard. This is because PS/2 mice share some hardware with the keyboard and leaving the mouse plugged in can fool the keyboard probe into thinking the keyboard is still there. In general, this is not a problem since the mouse is not much good without the keyboard anyway.\r
34   1. Plug a dumb terminal into `COM1` (`sio0`).\r
35   If you do not have a dumb terminal, you can use an old PC/XT with a modem program, or the serial port on another UNIX® box. If you do not have a `COM1` (`sio0`), get one. At this time, there is no way to select a port other than `COM1` for the boot blocks without recompiling the boot blocks. If you are already using `COM1` for another device, you will have to temporarily remove that device and install a new boot block and kernel once you get DragonFly up and running. (It is assumed that `COM1` will be available on a file/compute/terminal server anyway; if you really need `COM1` for something else (and you cannot switch that something else to `COM2` (`sio1`)), then you probably should not even be bothering with all this in the first place.)\r
36   1. Make sure the configuration file of your kernel has appropriate flags set for `COM1` (`sio0`).\r
37   Relevant flags are:\r
38   `0x10`:: Enables console support for this unit. The other console flags are ignored unless this is set. Currently, at most one unit can have console support; the first one (in config file order) with this flag set is preferred. This option alone will not make the serial port the console. Set the following flag or use the `-h` option described below, together with this flag.`0x20`:: Forces this unit to be the console (unless there is another higher priority console), regardless of the `-h` option discussed below. This flag replaces the `COMCONSOLE` option in DragonFly versions 2.`***X***`. The flag `0x20` must be used together with the `0x10` flag.`0x40`:: Reserves this unit (in conjunction with `0x10`) and makes the unit unavailable for normal access. You should not set this flag to the serial port unit which you want to use as the serial console. This reserves this port for "low-level IO", i.e. kernel debugging.`0x80`:: This port will be used for remote kernel debugging.\r
39   Example:\r
40       \r
41       device sio0 at isa? port IO_COM1 flags 0x10 irq 4\r
42   \r
43   See the [sio(4)](http://leaf.dragonflybsd.org/cgi/web-man?command#sio&section4) manual page for more details.\r
44   If the flags were not set, you need to run UserConfig (on a different console) or recompile the kernel.\r
45   1. Create `boot.config` in the root directory of the `a` partition on the boot drive.\r
46   This file will instruct the boot block code how you would like to boot the system. In order to activate the serial console, you need one or more of the following options--if you want multiple options, include them all on the same line:\r
47   `-h`:: Toggles internal and serial consoles. You can use this to switch console devices. For instance, if you boot from the internal (video) console, you can use `-h` to direct the boot loader and the kernel to use the serial port as its console device. Alternatively, if you boot from the serial port, you can use the `-h` to tell the boot loader and the kernel to use the video display as the console instead.`-D`:: Toggles single and dual console configurations. In the single configuration the console will be either the internal console (video display) or the serial port, depending on the state of the `-h` option above. In the dual console configuration, both the video display and the serial port will become the console at the same time, regardless of the state of the `-h` option. However, note that the dual console configuration takes effect only during the boot block is running. Once the boot loader gets control, the console specified by the `-h` option becomes the only console.`-P`:: Makes the boot block probe the keyboard. If no keyboard is found, the `-D` and `-h` options are automatically set.\r
48    **Note:** Due to space constraints in the current version of the boot blocks, the `-P` option is capable of detecting extended keyboards only. Keyboards with less than 101 keys (and without F11 and F12 keys) may not be detected. Keyboards on some laptop computers may not be properly found because of this limitation. If this is the case with your system, you have to abandon using the `-P` option. Unfortunately there is no workaround for this problem.\r
49   Use either the `-P` option to select the console automatically, or the `-h` option to activate the serial console.\r
50   You may include other options described in [boot(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#boot&section8) as well.\r
51   The options, except for `-P`, will be passed to the boot loader (`/boot/loader`). The boot loader will determine which of the internal video or the serial port should become the console by examining the state of the `-h` option alone. This means that if you specify the `-D` option but not the `-h` option in `/boot.config`, you can use the serial port as the console only during the boot block; the boot loader will use the internal video display as the console.\r
52   1. Boot the machine.\r
53   When you start your DragonFly box, the boot blocks will echo the contents of `/boot.config` to the console. For example:\r
54       \r
55       /boot.config: -P\r
56       Keyboard: no\r
57   \r
58   The second line appears only if you put `-P` in `/boot.config` and indicates presence/absence of the keyboard. These messages go to either serial or internal console, or both, depending on the option in `/boot.config`.\r
59   || Options || Message goes to ||\r
60   || none || internal console ||\r
61   || `-h` || serial console ||\r
62   || `-D` || serial and internal consoles ||\r
63   || `-Dh` || serial and internal consoles ||\r
64   || `-P`, keyboard present || internal console ||\r
65   || `-P`, keyboard absent || serial console ||\r
66   After the above messages, there will be a small pause before the boot blocks continue loading the boot loader and before any further messages printed to the console. Under normal circumstances, you do not need to interrupt the boot blocks, but you may want to do so in order to make sure things are set up correctly.\r
67   Hit any key, other than Enter, at the console to interrupt the boot process. The boot blocks will then prompt you for further action. You should now see something like:\r
68       \r
69       >> DragonFly/i386 BOOT\r
70       Default: 0:ad(0,a)/boot/loader\r
71       boot:\r
72   \r
73   Verify the above message appears on either the serial or internal console or both, according to the options you put in `/boot.config`. If the message appears in the correct console, hit Enter to continue the boot process.\r
74   If you want the serial console but you do not see the prompt on the serial terminal, something is wrong with your settings. In the meantime, you enter `-h` and hit Enter/Return (if possible) to tell the boot block (and then the boot loader and the kernel) to choose the serial port for the console. Once the system is up, go back and check what went wrong.\r
75 \r
76 After the boot loader is loaded and you are in the third stage of the boot process you can still switch between the internal console and the serial console by setting appropriate environment variables in the boot loader. See [serialconsole-setup.html#SERIALCONSOLE-LOADER Section 17.6.6].\r
77 \r
78 ### 17.6.4 Summary \r
79 \r
80 Here is the summary of various settings discussed in this section and the console eventually selected.\r
81 \r
82 #### 17.6.4.1 Case 1: You Set the Flags to 0x10 for `sio0` \r
83 \r
84     \r
85     device sio0 at isa? port IO_COM1 flags 0x10 irq 4\r
86 \r
87 \r
88 [[!table  data="""
89 | Options in /boot.config | Console during boot blocks | Console during boot loader | Console in kernel 
90  nothing | internal | internal | internal 
91  `-h` | serial | serial | serial 
92  `-D` | serial and internal | internal | internal 
93  `-Dh` | serial and internal | serial | serial 
94  `-P`, keyboard present | internal | internal | internal 
95  `-P`, keyboard absent | serial and internal | serial | serial |\r
96 """]]\r
97 #### 17.6.4.2 Case 2: You Set the Flags to 0x30 for sio0 \r
98 \r
99     \r
100     device sio0 at isa? port IO_COM1 flags 0x30 irq 4\r
101 \r
102 \r
103 [[!table  data="""
104 | Options in /boot.config | Console during boot blocks | Console during boot loader | Console in kernel 
105  nothing | internal | internal | serial 
106  `-h` | serial | serial | serial 
107  `-D` | serial and internal | internal | serial 
108  `-Dh` | serial and internal | serial | serial 
109  `-P`, keyboard present | internal | internal | serial 
110  `-P`, keyboard absent | serial and internal | serial | serial |\r
111 """]]\r
112 ### 17.6.5 Tips for the Serial Console \r
113 \r
114 #### 17.6.5.1 Setting a Faster Serial Port Speed \r
115 \r
116 By default, the serial port settings are: 9600 baud, 8 bits, no parity, and 1 stop bit. If you wish to change the speed, you need to recompile at least the boot blocks. Add the following line to `/etc/make.conf` and compile new boot blocks:\r
117 \r
118     \r
119     BOOT_COMCONSOLE_SPEED=19200\r
120 \r
121 \r
122 If the serial console is configured in some other way than by booting with `-h`, or if the serial console used by the kernel is different from the one used by the boot blocks, then you must also add the following option to the kernel configuration file and compile a new kernel:\r
123 \r
124     \r
125     options CONSPEED=19200\r
126 \r
127 \r
128 #### 17.6.5.2 Using Serial Port Other Than `sio0` for the Console \r
129 \r
130 Using a port other than `sio0` as the console requires some recompiling. If you want to use another serial port for whatever reasons, recompile the boot blocks, the boot loader and the kernel as follows.\r
131 \r
132   1. Get the kernel source. (See [ Section 21.1](updating.html#UPDATING-SETUP))\r
133   1. Edit `/etc/make.conf` and set `BOOT_COMCONSOLE_PORT` to the address of the port you want to use (0x3F8, 0x2F8, 0x3E8 or 0x2E8). Only `sio0` through `sio3` (`COM1` through `COM4`) can be used; multiport serial cards will not work. No interrupt setting is needed.\r
134   1. Create a custom kernel configuration file and add appropriate flags for the serial port you want to use. For example, if you want to make `sio1` (`COM2`) the console:\r
135       \r
136       device sio1 at isa? port IO_COM2 flags 0x10 irq 3\r
137   \r
138   or\r
139       \r
140       device sio1 at isa? port IO_COM2 flags 0x30 irq 3\r
141   \r
142   The console flags for the other serial ports should not be set.\r
143   1. Recompile and install the boot blocks and the boot loader:\r
144       \r
145       # cd /sys/boot\r
146       # make\r
147       # make install\r
148   \r
149   1. Rebuild and install the kernel.\r
150   1. Write the boot blocks to the boot disk with [disklabel(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#disklabel&section8) and boot from the new kernel.\r
151 \r
152 #### 17.6.5.3 Entering the DDB Debugger from the Serial Line \r
153 \r
154 If you wish to drop into the kernel debugger from the serial console (useful for remote diagnostics, but also dangerous if you generate a spurious BREAK on the serial port!) then you should compile your kernel with the following options:\r
155 \r
156     \r
157     options BREAK_TO_DEBUGGER\r
158     options DDB\r
159 \r
160 \r
161 #### 17.6.5.4 Getting a Login Prompt on the Serial Console \r
162 \r
163 While this is not required, you may wish to get a ***login*** prompt over the serial line, now that you can see boot messages and can enter the kernel debugging session through the serial console. Here is how to do it.\r
164 \r
165 Open the file `/etc/ttys` with an editor and locate the lines:\r
166 \r
167     \r
168     ttyd0 "/usr/libexec/getty std.9600" unknown off secure\r
169     ttyd1 "/usr/libexec/getty std.9600" unknown off secure\r
170     ttyd2 "/usr/libexec/getty std.9600" unknown off secure\r
171     ttyd3 "/usr/libexec/getty std.9600" unknown off secure\r
172 \r
173 \r
174 `ttyd0` through `ttyd3` corresponds to `COM1` through `COM4`. Change `off` to `on` for the desired port. If you have changed the speed of the serial port, you need to change `std.9600` to match the current setting, e.g. `std.19200`.\r
175 \r
176 You may also want to change the terminal type from `unknown` to the actual type of your serial terminal.\r
177 \r
178 After editing the file, you must `kill -HUP 1` to make this change take effect.\r
179 \r
180 ### 17.6.6 Changing Console from the Boot Loader \r
181 \r
182 Previous sections described how to set up the serial console by tweaking the boot block. This section shows that you can specify the console by entering some commands and environment variables in the boot loader. As the boot loader is invoked at the third stage of the boot process, after the boot block, the settings in the boot loader will override the settings in the boot block.\r
183 \r
184 #### 17.6.6.1 Setting Up the Serial Console \r
185 \r
186 You can easily specify the boot loader and the kernel to use the serial console by writing just one line in `/boot/loader.rc`:\r
187 \r
188     \r
189     set console=comconsole\r
190 \r
191 \r
192 This will take effect regardless of the settings in the boot block discussed in the previous section.\r
193 \r
194 You had better put the above line as the first line of `/boot/loader.rc` so as to see boot messages on the serial console as early as possible.\r
195 \r
196 Likewise, you can specify the internal console as:\r
197 \r
198     \r
199     set console=vidconsole\r
200 \r
201 \r
202 If you do not set the boot loader environment variable `console`, the boot loader, and subsequently the kernel, will use whichever console indicated by the `-h` option in the boot block.\r
203 \r
204 In versions 3.2 or later, you may specify the console in `/boot/loader.conf.local` or `/boot/loader.conf`, rather than in `/boot/loader.rc`. In this method your `/boot/loader.rc` should look like:\r
205 \r
206     \r
207     include /boot/loader.4th\r
208     start\r
209 \r
210 \r
211 Then, create `/boot/loader.conf.local` and put the following line there.\r
212 \r
213     \r
214     console=comconsole\r
215 \r
216 \r
217 or\r
218 \r
219     \r
220     console=vidconsole\r
221 \r
222 \r
223 See [loader.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command#loader.conf&section5) for more information.\r
224 \r
225  **Note:** At the moment, the boot loader has no option equivalent to the `-P` option in the boot block, and there is no provision to automatically select the internal console and the serial console based on the presence of the keyboard.\r
226 \r
227 #### 17.6.6.2 Using a Serial Port Other Than `sio0` for the Console \r
228 \r
229 You need to recompile the boot loader to use a serial port other than `sio0` for the serial console. Follow the procedure described in [serialconsole-setup.html#SERIALCONSOLE-COM2 Section 17.6.5.2].\r
230 \r
231 ### 17.6.7 Caveats \r
232 \r
233 The idea here is to allow people to set up dedicated servers that require no graphics hardware or attached keyboards. Unfortunately, while most systems will let you boot without a keyboard, there are quite a few that will not let you boot without a graphics adapter. Machines with AMI BIOSes can be configured to boot with no graphics adapter installed simply by changing the ***graphics adapter*** setting in the CMOS configuration to ***Not installed.***\r
234 \r
235 However, many machines do not support this option and will refuse to boot if you have no display hardware in the system. With these machines, you will have to leave some kind of graphics card plugged in, (even if it is just a junky mono board) although you will not have to attach a monitor. You might also try installing an AMI BIOS.\r
236 \r
237 \r
238 \r
239 CategoryHandbook\r
240 CategoryHandbook-serial\r