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.\" $DragonFly: src/share/man/man4/ukbd.4,v 1.4 2007/12/25 13:38:47 swildner Exp $ 33.\" 34.Dd August 6, 2009 35.Dt UKBD 4 36.Os 37.Sh NAME 38.Nm ukbd 39.Nd USB keyboard driver 40.Sh SYNOPSIS 41.Cd "device ukbd" 42.Sh DESCRIPTION 43The 44.Nm 45driver provides support for keyboards that attach to the USB port. 46.Xr usb 4 47and one of 48.Xr uhci 4 49or 50.Xr ohci 4 51must be configured in the kernel as well. 52.Sh CONFIGURATION 53By default, the keyboard subsystem does not create the appropriate devices yet. 54Make sure you reconfigure your kernel with the following option in the kernel 55config file: 56.Pp 57.D1 Cd "options KBD_INSTALL_CDEV" 58.Pp 59If both an AT keyboard USB keyboards are used at the same time, the 60AT keyboard will appear as 61.Pa kbd0 62in 63.Pa /dev . 64The USB keyboards will be 65.Pa kbd1 , kbd2 , 66etc. 67You can see some information about the keyboard with the following command: 68.Pp 69.Dl "kbdcontrol -i < /dev/kbd1" 70.Pp 71or load a keymap with 72.Pp 73.Dl "kbdcontrol -l keymaps/pt.iso < /dev/kbd1" 74.Pp 75See 76.Xr kbdcontrol 1 77for more possible options. 78.Pp 79You can swap console keyboards by using the command 80.Pp 81.Dl "kbdcontrol -k /dev/kbd1" 82.Pp 83From this point on, the first USB keyboard will be the keyboard 84to be used by the console. 85.Pp 86If you want to use a USB keyboard as your default and not use an AT keyboard at 87all, you will have to remove the 88.Cd "device atkbd" 89line from the kernel configuration file. 90Because of the device initialization order, 91the USB keyboard will be detected 92.Em after 93the console driver 94initializes itself and you have to explicitly tell the console 95driver to use the existence of the USB keyboard. This can be done in 96one of the following two ways. 97.Pp 98Run the following command as a part of system initialization: 99.Pp 100.Dl "kbdcontrol -k /dev/kbd0 < /dev/ttyv0 > /dev/null" 101.Pp 102(Note that as the USB keyboard is the only keyboard, it is accessed as 103.Pa /dev/kbd0 ) 104or otherwise tell the console driver to periodically look for a 105keyboard by setting a flag in the kernel configuration file: 106.Pp 107.Dl "device sc0 at isa? flags 0x100" 108.Pp 109With the above flag, the console driver will try to detect any 110keyboard in the system if it did not detect one while it was 111initialized at boot time. 112.Sh DRIVER CONFIGURATION 113.D1 Cd "options KBD_INSTALL_CDEV" 114.Pp 115Make the keyboards available through a character device in 116.Pa /dev . 117.Pp 118.D1 Cd options UKBD_DFLT_KEYMAP 119.D1 Cd makeoptions UKBD_DFLT_KEYMAP=fr.iso 120.Pp 121The above lines will put the French ISO keymap in the ukbd driver. 122You can specify any keymap in 123.Pa /usr/share/syscons/keymaps 124with this option. 125.Pp 126.D1 Cd "options KBD_DISABLE_KEYMAP_LOAD" 127.Pp 128Do not allow the user to change the keymap. 129Note that these options also affect the AT keyboard driver, 130.Xr atkbd 4 . 131.Sh FILES 132.Bl -tag -width ".Pa /dev/kbd*" -compact 133.It Pa /dev/kbd* 134blocking device nodes 135.El 136.Sh EXAMPLES 137.D1 Cd "device ukbd" 138.Pp 139Add the 140.Nm 141driver to the kernel. 142.Sh SEE ALSO 143.Xr kbdcontrol 1 , 144.Xr ohci 4 , 145.Xr syscons 4 , 146.Xr uhci 4 , 147.Xr usb 4 , 148.Xr config 8 149.Sh AUTHORS 150.An -nosplit 151The 152.Nm 153driver was written by 154.An Lennart Augustsson Aq augustss@cs.chalmers.se 155for 156.Nx 157and was substantially rewritten for 158.Fx 159by 160.An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp . 161.Pp 162This manual page was written by 163.An Nick Hibma Aq n_hibma@FreeBSD.org 164with a large amount of input from 165.An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp . 166