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