xref: /freebsd/share/man/man4/hidbus.4 (revision e0c4386e)
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 September 14, 2020
25.Dt HIDBUS 4
26.Os
27.Sh NAME
28.Nm hidbus
29.Nd generic HID bus 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 hidbus"
36.Cd "device hid"
37.Ed
38.Pp
39Alternatively, to load the driver as a
40module at boot time, place the following line in
41.Xr loader.conf 5 :
42.Bd -literal -offset indent
43hidbus_load="YES"
44.Ed
45.Sh DESCRIPTION
46The
47.Nm
48driver provides support for multiple HID driver attachments to single HID
49transport backend.
50See
51.Xr iichid 4
52or
53.Xr usbhid 4 .
54.Pp
55Each HID device can have several components, e.g., a keyboard and
56a mouse.
57These components use different report identifiers (a byte) combined into
58groups called collections to distinguish which one data is coming from.
59The
60.Nm
61driver has other drivers attached that handle particular
62kinds of devices and
63.Nm
64broadcasts data to all of them.
65.Sh SYSCTL VARIABLES
66The following variables are available as both
67.Xr sysctl 8
68variables and
69.Xr loader 8
70tunables:
71.Bl -tag -width indent
72.It Va hw.hid.hidbus.debug
73Debug output level, where 0 is debugging disabled and larger values increase
74debug message verbosity.
75Default is 0.
76.El
77.Sh SEE ALSO
78.Xr hconf 4 ,
79.Xr hcons 4 ,
80.Xr hgame 4 ,
81.Xr hidraw 4 ,
82.Xr hkbd 4 ,
83.Xr hms 4 ,
84.Xr hmt 4 ,
85.Xr hpen 4 ,
86.Xr hsctrl 4 ,
87.Xr hskbd 4 ,
88.Xr iichid 4 ,
89.Xr usbhid 4
90.Sh HISTORY
91The
92.Nm
93driver first appeared in
94.Fx 13.0 .
95.Sh AUTHORS
96.An -nosplit
97The
98.Nm
99driver was written by
100.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
101