xref: /freebsd/share/man/man4/usbhid.4 (revision a03411e84728e9b267056fd31c7d1d9d1dc1b01e)
1.\" Copyright (c) 2020 Vladimir Kondratyev <wulf@FreeBSD.org>
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22.\" SUCH DAMAGE.
23.\"
24.Dd January 12, 2021
25.Dt USBHID 4
26.Os
27.Sh NAME
28.Nm usbhid
29.Nd USB HID transport driver
30.Sh SYNOPSIS
31To compile this driver into the kernel,
32place the following lines in your
33kernel configuration file:
34.Bd -ragged -offset indent
35.Cd "device usbhid"
36.Ed
37.Pp
38Alternatively, to load the driver as a
39module at boot time, place the following line in
40.Xr loader.conf 5 :
41.Bd -literal -offset indent
42usbhid_load="YES"
43.Ed
44.Sh DESCRIPTION
45The
46.Nm
47driver provides a interface to USB Human Interface Devices (HIDs).
48.Sh SYSCTL VARIABLES
49The following variables are available as both
50.Xr sysctl 8
51variables and
52.Xr loader 8
53tunables:
54.Bl -tag -width indent
55.It Va hw.usb.usbhid.enable
56Enable
57.Nm
58and make its priority greater than other USB HID drivers have.
59Default is 0.
60.El
61.Bl -tag -width indent
62.It Va hw.usb.usbhid.debug
63Debug output level, where 0 is debugging disabled and larger values increase
64debug message verbosity.
65Default is 0.
66.El
67.Sh SEE ALSO
68.Xr ehci 4 ,
69.Xr ohci 4 ,
70.Xr uhci 4 ,
71.Xr usb 4 ,
72.Xr xhci 4 ,
73.Xr usbconfig 8
74.Sh HISTORY
75The
76.Nm
77driver first appeared in
78.Fx 13.0 .
79.Sh AUTHORS
80.An -nosplit
81The
82.Nm
83driver was written by
84.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
85