1 .\" Copyright (c) 1997, 1998
2 .\" Nick Hibma <n_hibma@FreeBSD.org>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
27 .Dd September 12, 2020
32 .Nd HID keyboard driver
34 To compile this driver into the kernel,
35 place the following line in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
42 .Cd "options EVDEV_SUPPORT"
45 Alternatively, to load the driver as a
46 module at boot time, place the following line in
48 .Bd -literal -offset indent
54 driver provides support for keyboards that attach to the HID transport
62 must be configured in the kernel as well.
64 By default, the keyboard subsystem does not create the appropriate devices yet.
65 Make sure you reconfigure your kernel with the following option in the kernel
68 .Dl "options KBD_INSTALL_CDEV"
70 If both an AT keyboard HID keyboards are used at the same time, the
71 AT keyboard will appear as
75 The HID keyboards will be
78 You can see some information about the keyboard with the following command:
80 .Dl "kbdcontrol -i < /dev/kbd1"
84 .Dl "kbdcontrol -l keymaps/pt.iso < /dev/kbd1"
88 for more possible options.
90 You can swap console keyboards by using the command
92 .Dl "kbdcontrol -k /dev/kbd1"
94 From this point on, the first HID keyboard will be the keyboard
95 to be used by the console.
97 If you want to use a HID keyboard as your default and not use an AT keyboard at
98 all, you will have to remove the
100 line from the kernel configuration file.
101 Because of the device initialization order,
102 the HID keyboard will be detected
105 initializes itself and you have to explicitly tell the console
106 driver to use the existence of the HID keyboard.
108 one of the following two ways.
110 Run the following command as a part of system initialization:
112 .Dl "kbdcontrol -k /dev/kbd0 < /dev/ttyv0 > /dev/null"
114 (Note that as the HID keyboard is the only keyboard, it is accessed as
116 or otherwise tell the console driver to periodically look for a
117 keyboard by setting a flag in the kernel configuration file:
119 .Dl "device sc0 at isa? flags 0x100"
121 With the above flag, the console driver will try to detect any
122 keyboard in the system if it did not detect one while it was
123 initialized at boot time.
124 .Sh DRIVER CONFIGURATION
125 .D1 Cd "options KBD_INSTALL_CDEV"
127 Make the keyboards available through a character device in
130 .D1 Cd options HKBD_DFLT_KEYMAP
131 .D1 Cd makeoptions HKBD_DFLT_KEYMAP=fr.iso
133 The above lines will put the French ISO keymap in the ukbd driver.
134 You can specify any keymap in
135 .Pa /usr/share/syscons/keymaps
137 .Pa /usr/share/vt/keymaps
138 (depending on the console driver being used) with this option.
140 .D1 Cd "options KBD_DISABLE_KEYMAP_LOADING"
142 Do not allow the user to change the keymap.
143 Note that these options also affect the AT keyboard driver,
146 The following variables are available as both
151 .Bl -tag -width indent
152 .It Va hw.hid.hkbd.debug
153 Debug output level, where 0 is debugging disabled and larger values increase
154 debug message verbosity.
158 .Bl -tag -width ".Pa /dev/input/event*" -compact
160 blocking device nodes
161 .It Pa /dev/input/event*
162 input event device nodes.
169 driver to the kernel.
183 driver was written by
184 .An Lennart Augustsson Aq Mt augustss@cs.chalmers.se
187 and was substantially rewritten for
190 .An Kazutaka YOKOTA Aq Mt yokota@zodiac.mech.utsunomiya-u.ac.jp .
192 This manual page was written by
193 .An Nick Hibma Aq Mt n_hibma@FreeBSD.org
194 with a large amount of input from
195 .An Kazutaka YOKOTA Aq Mt yokota@zodiac.mech.utsunomiya-u.ac.jp .