xref: /freebsd/share/man/man4/hidbus.4 (revision e47a47b2150f86216e6eca666d902ce20bd5031a)
1*2b4464b0SVladimir Kondratyev.\" Copyright (c) 2020 Vladimir Kondratyev <wulf@FreeBSD.org>
2*2b4464b0SVladimir Kondratyev.\"
3*2b4464b0SVladimir Kondratyev.\" Redistribution and use in source and binary forms, with or without
4*2b4464b0SVladimir Kondratyev.\" modification, are permitted provided that the following conditions
5*2b4464b0SVladimir Kondratyev.\" are met:
6*2b4464b0SVladimir Kondratyev.\" 1. Redistributions of source code must retain the above copyright
7*2b4464b0SVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer.
8*2b4464b0SVladimir Kondratyev.\" 2. Redistributions in binary form must reproduce the above copyright
9*2b4464b0SVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer in the
10*2b4464b0SVladimir Kondratyev.\"    documentation and/or other materials provided with the distribution.
11*2b4464b0SVladimir Kondratyev.\"
12*2b4464b0SVladimir Kondratyev.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13*2b4464b0SVladimir Kondratyev.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14*2b4464b0SVladimir Kondratyev.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15*2b4464b0SVladimir Kondratyev.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16*2b4464b0SVladimir Kondratyev.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17*2b4464b0SVladimir Kondratyev.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18*2b4464b0SVladimir Kondratyev.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19*2b4464b0SVladimir Kondratyev.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20*2b4464b0SVladimir Kondratyev.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21*2b4464b0SVladimir Kondratyev.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22*2b4464b0SVladimir Kondratyev.\" SUCH DAMAGE.
23*2b4464b0SVladimir Kondratyev.\"
24*2b4464b0SVladimir Kondratyev.Dd September 14, 2020
25*2b4464b0SVladimir Kondratyev.Dt HIDBUS 4
26*2b4464b0SVladimir Kondratyev.Os
27*2b4464b0SVladimir Kondratyev.Sh NAME
28*2b4464b0SVladimir Kondratyev.Nm hidbus
29*2b4464b0SVladimir Kondratyev.Nd generic HID bus driver
30*2b4464b0SVladimir Kondratyev.Sh SYNOPSIS
31*2b4464b0SVladimir KondratyevTo compile this driver into the kernel,
32*2b4464b0SVladimir Kondratyevplace the following lines in your
33*2b4464b0SVladimir Kondratyevkernel configuration file:
34*2b4464b0SVladimir Kondratyev.Bd -ragged -offset indent
35*2b4464b0SVladimir Kondratyev.Cd "device hidbus"
36*2b4464b0SVladimir Kondratyev.Cd "device hid"
37*2b4464b0SVladimir Kondratyev.Ed
38*2b4464b0SVladimir Kondratyev.Pp
39*2b4464b0SVladimir KondratyevAlternatively, to load the driver as a
40*2b4464b0SVladimir Kondratyevmodule at boot time, place the following line in
41*2b4464b0SVladimir Kondratyev.Xr loader.conf 5 :
42*2b4464b0SVladimir Kondratyev.Bd -literal -offset indent
43*2b4464b0SVladimir Kondratyevhidbus_load="YES"
44*2b4464b0SVladimir Kondratyev.Ed
45*2b4464b0SVladimir Kondratyev.Sh DESCRIPTION
46*2b4464b0SVladimir KondratyevThe
47*2b4464b0SVladimir Kondratyev.Nm
48*2b4464b0SVladimir Kondratyevdriver provides support for multiple HID driver attachments to single HID
49*2b4464b0SVladimir Kondratyevtransport backend.
50*2b4464b0SVladimir KondratyevSee
51*2b4464b0SVladimir Kondratyev.Xr iichid 4
52*2b4464b0SVladimir Kondratyevor
53*2b4464b0SVladimir Kondratyev.Xr usbhid 4 .
54*2b4464b0SVladimir Kondratyev.Pp
55*2b4464b0SVladimir KondratyevEach HID device can have several components, e.g., a keyboard and
56*2b4464b0SVladimir Kondratyeva mouse.
57*2b4464b0SVladimir KondratyevThese components use different report identifiers (a byte) combined into
58*2b4464b0SVladimir Kondratyevgroups called collections to distinguish which one data is coming from.
59*2b4464b0SVladimir KondratyevThe
60*2b4464b0SVladimir Kondratyev.Nm
61*2b4464b0SVladimir Kondratyevdriver has other drivers attached that handle particular
62*2b4464b0SVladimir Kondratyevkinds of devices and
63*2b4464b0SVladimir Kondratyev.Nm
64*2b4464b0SVladimir Kondratyevbroadcasts data to all of them.
65*2b4464b0SVladimir Kondratyev.Sh SYSCTL VARIABLES
66*2b4464b0SVladimir KondratyevThe following variables are available as both
67*2b4464b0SVladimir Kondratyev.Xr sysctl 8
68*2b4464b0SVladimir Kondratyevvariables and
69*2b4464b0SVladimir Kondratyev.Xr loader 8
70*2b4464b0SVladimir Kondratyevtunables:
71*2b4464b0SVladimir Kondratyev.Bl -tag -width indent
72*2b4464b0SVladimir Kondratyev.It Va hw.hid.hidbus.debug
73*2b4464b0SVladimir KondratyevDebug output level, where 0 is debugging disabled and larger values increase
74*2b4464b0SVladimir Kondratyevdebug message verbosity.
75*2b4464b0SVladimir KondratyevDefault is 0.
76*2b4464b0SVladimir Kondratyev.El
77*2b4464b0SVladimir Kondratyev.Sh SEE ALSO
78*2b4464b0SVladimir Kondratyev.Xr hconf 4 ,
79*2b4464b0SVladimir Kondratyev.Xr hcons 4 ,
80*2b4464b0SVladimir Kondratyev.Xr hgame 4 ,
81*2b4464b0SVladimir Kondratyev.Xr hidraw 4 ,
82*2b4464b0SVladimir Kondratyev.Xr hkbd 4 ,
83*2b4464b0SVladimir Kondratyev.Xr hms 4 ,
84*2b4464b0SVladimir Kondratyev.Xr hmt 4 ,
85*2b4464b0SVladimir Kondratyev.Xr hpen 4 ,
86*2b4464b0SVladimir Kondratyev.Xr hsctrl 4 ,
87*2b4464b0SVladimir Kondratyev.Xr hskbd 4 ,
88*2b4464b0SVladimir Kondratyev.Xr iichid 4 ,
89*2b4464b0SVladimir Kondratyev.Xr usbhid 4
90*2b4464b0SVladimir Kondratyev.Sh HISTORY
91*2b4464b0SVladimir KondratyevThe
92*2b4464b0SVladimir Kondratyev.Nm
93*2b4464b0SVladimir Kondratyevdriver first appeared in
94*2b4464b0SVladimir Kondratyev.Fx 13.0 .
95*2b4464b0SVladimir Kondratyev.Sh AUTHORS
96*2b4464b0SVladimir Kondratyev.An -nosplit
97*2b4464b0SVladimir KondratyevThe
98*2b4464b0SVladimir Kondratyev.Nm
99*2b4464b0SVladimir Kondratyevdriver was written by
100*2b4464b0SVladimir Kondratyev.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
101