share/man/man4/ukbd.4

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