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