1.\" Copyright (c) 1997, 1998 2.\" Nick Hibma <n_hibma@FreeBSD.org>. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. Neither the name of the author nor the names of any co-contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY NICK HIBMA AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL NICK HIBMA OR THE VOICES IN HIS HEAD 20.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 26.\" THE POSSIBILITY OF SUCH DAMAGE. 27.\" 28.\" $FreeBSD$ 29.\" 30.Dd April 11, 1999 31.Dt UKBD 4 32.Os 33.Sh NAME 34.Nm ukbd 35.Nd USB keyboard driver 36.Sh SYNOPSIS 37.Cd "device ukbd" 38.Sh DESCRIPTION 39The 40.Nm 41driver provides support for keyboards that attach to the USB port. 42.Xr usb 4 43and one of 44.Xr uhci 4 45or 46.Xr ohci 4 47must be configured in the kernel as well. 48.Sh CONFIGURATION 49By default, the keyboard subsystem does not create the appropriate devices yet. 50Make sure you reconfigure your kernel with the following option in the kernel 51config file: 52.Pp 53.Dl "options KBD_INSTALL_CDEV" 54.Pp 55Go to 56.Pa /dev 57and make device nodes 58.Pa kbd* : 59.Pp 60.Dl "sh MAKEDEV kbd0 kbd1" 61.Pp 62If both an AT keyboard USB keyboards are used at the same time, the 63AT keyboard will appear as 64.Pa kbd0 65in 66.Pa /dev . 67The USB keyboards will be 68.Pa kbd1 , kbd2 , 69etc. 70You can see some information about the keyboard with the following command: 71.Pp 72.Dl "kbdcontrol -i < /dev/kbd1" 73.Pp 74or load a keymap with 75.Pp 76.Dl "kbdcontrol -l keymaps/pt.iso < /dev/kbd1" 77.Pp 78See 79.Xr kbdcontrol 1 80for more possible options. 81.Pp 82You can swap console keyboards by using the command 83.Pp 84.Dl "kbdcontrol -k /dev/kbd1" 85.Pp 86From this point on, the first USB keyboard will be the keyboard 87to be used by the console. 88.Pp 89If you want to use a USB keyboard as your default and not use an AT keyboard at 90all, you will have to remove the 91.Cd "device atkbd" 92line from the kernel configuration file. 93Because of the device initialization order, 94the USB keyboard will be detected 95.Em after 96the console driver 97initializes itself and you have to explicitly tell the console 98driver to use the existence of the USB keyboard. This can be done in 99one of the following two ways. 100.Pp 101Run the following command as a part of system initialization: 102.Pp 103.Dl "kbdcontrol -k /dev/kbd0 < /dev/ttyv0 > /dev/null" 104.Pp 105(Note that as the USB keyboard is the only keyboard, it is accessed as 106.Pa /dev/kbd0 ) 107or otherwise tell the console driver to periodically look for a 108keyboard by setting a flag in the kernel configuration file: 109.Pp 110.Dl "device sc0 at isa? flags 0x100" 111.Pp 112With the above flag, the console driver will try to detect any 113keyboard in the system if it did not detect one while it was 114initialized at boot time. 115.Sh DRIVER CONFIGURATION 116.D1 Cd "options KBD_INSTALL_CDEV" 117.Pp 118Make the keyboards available through a character device in 119.Pa /dev . 120.Pp 121.D1 Cd options UKBD_DFLT_KEYMAP 122.D1 Cd makeoptions UKBD_DFLT_KEYMAP=fr.iso 123.Pp 124The above lines will put the French ISO keymap in the ukbd driver. 125You can specify any keymap in 126.Pa /usr/share/syscons/keymaps 127with this option. 128.Pp 129.D1 Cd "options KBD_DISABLE_KEYMAP_LOADING" 130.Pp 131Do not allow the user to change the keymap. 132Note that these options also affect the AT keyboard driver, 133.Xr atkbd 4 . 134.Sh FILES 135.Bl -tag -width ".Pa /dev/kbd*" -compact 136.It Pa /dev/kbd* 137blocking device nodes 138.El 139.Sh EXAMPLES 140.D1 Cd "device ukbd" 141.Pp 142Add the 143.Nm 144driver to the kernel. 145.Sh SEE ALSO 146.Xr kbdcontrol 1 , 147.Xr ohci 4 , 148.Xr syscons 4 , 149.Xr uhci 4 , 150.Xr usb 4 , 151.Xr config 8 152.Sh AUTHORS 153.An -nosplit 154The 155.Nm 156driver was written by 157.An Lennart Augustsson Aq augustss@cs.chalmers.se 158for 159.Nx 160and was substantially rewritten for 161.Fx 162by 163.An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp . 164.Pp 165This manual page was written by 166.An Nick Hibma Aq n_hibma@FreeBSD.org 167with a large amount of input from 168.An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp . 169