xref: /freebsd/share/man/man4/usbhid.4 (revision b62f6dfaed3d0189c1853f26b773c3afed203463)
101f2e864SVladimir Kondratyev.\" Copyright (c) 2020 Vladimir Kondratyev <wulf@FreeBSD.org>
201f2e864SVladimir Kondratyev.\"
301f2e864SVladimir Kondratyev.\" Redistribution and use in source and binary forms, with or without
401f2e864SVladimir Kondratyev.\" modification, are permitted provided that the following conditions
501f2e864SVladimir Kondratyev.\" are met:
601f2e864SVladimir Kondratyev.\" 1. Redistributions of source code must retain the above copyright
701f2e864SVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer.
801f2e864SVladimir Kondratyev.\" 2. Redistributions in binary form must reproduce the above copyright
901f2e864SVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer in the
1001f2e864SVladimir Kondratyev.\"    documentation and/or other materials provided with the distribution.
1101f2e864SVladimir Kondratyev.\"
1201f2e864SVladimir Kondratyev.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1301f2e864SVladimir Kondratyev.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1401f2e864SVladimir Kondratyev.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1501f2e864SVladimir Kondratyev.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1601f2e864SVladimir Kondratyev.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1701f2e864SVladimir Kondratyev.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
1801f2e864SVladimir Kondratyev.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1901f2e864SVladimir Kondratyev.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2001f2e864SVladimir Kondratyev.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2101f2e864SVladimir Kondratyev.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2201f2e864SVladimir Kondratyev.\" SUCH DAMAGE.
2301f2e864SVladimir Kondratyev.\"
2401f2e864SVladimir Kondratyev.\" $FreeBSD$
2501f2e864SVladimir Kondratyev.\"
26*b62f6dfaSVladimir Kondratyev.Dd January 12, 2021
2701f2e864SVladimir Kondratyev.Dt USBHID 4
2801f2e864SVladimir Kondratyev.Os
2901f2e864SVladimir Kondratyev.Sh NAME
3001f2e864SVladimir Kondratyev.Nm usbhid
3101f2e864SVladimir Kondratyev.Nd USB HID transport driver
3201f2e864SVladimir Kondratyev.Sh SYNOPSIS
3301f2e864SVladimir KondratyevTo compile this driver into the kernel,
3401f2e864SVladimir Kondratyevplace the following lines in your
3501f2e864SVladimir Kondratyevkernel configuration file:
3601f2e864SVladimir Kondratyev.Bd -ragged -offset indent
3701f2e864SVladimir Kondratyev.Cd "device usbhid"
3801f2e864SVladimir Kondratyev.Ed
3901f2e864SVladimir Kondratyev.Pp
4001f2e864SVladimir KondratyevAlternatively, to load the driver as a
4101f2e864SVladimir Kondratyevmodule at boot time, place the following line in
4201f2e864SVladimir Kondratyev.Xr loader.conf 5 :
4301f2e864SVladimir Kondratyev.Bd -literal -offset indent
4401f2e864SVladimir Kondratyevusbhid_load="YES"
4501f2e864SVladimir Kondratyev.Ed
4601f2e864SVladimir Kondratyev.Sh DESCRIPTION
4701f2e864SVladimir KondratyevThe
4801f2e864SVladimir Kondratyev.Nm
4901f2e864SVladimir Kondratyevdriver provides a interface to USB Human Interface Devices (HIDs).
5001f2e864SVladimir Kondratyev.Sh SYSCTL VARIABLES
5101f2e864SVladimir KondratyevThe following variables are available as both
5201f2e864SVladimir Kondratyev.Xr sysctl 8
5301f2e864SVladimir Kondratyevvariables and
5401f2e864SVladimir Kondratyev.Xr loader 8
5501f2e864SVladimir Kondratyevtunables:
5601f2e864SVladimir Kondratyev.Bl -tag -width indent
57*b62f6dfaSVladimir Kondratyev.It Va hw.usb.usbhid.enable
58*b62f6dfaSVladimir KondratyevEnable
59*b62f6dfaSVladimir Kondratyev.Nm
60*b62f6dfaSVladimir Kondratyevand make its priority greater than other USB HID drivers have.
61*b62f6dfaSVladimir KondratyevDefault is 0.
62*b62f6dfaSVladimir Kondratyev.El
63*b62f6dfaSVladimir Kondratyev.Bl -tag -width indent
6401f2e864SVladimir Kondratyev.It Va hw.usb.usbhid.debug
6501f2e864SVladimir KondratyevDebug output level, where 0 is debugging disabled and larger values increase
6601f2e864SVladimir Kondratyevdebug message verbosity.
6701f2e864SVladimir KondratyevDefault is 0.
6801f2e864SVladimir Kondratyev.El
6901f2e864SVladimir Kondratyev.Sh SEE ALSO
7001f2e864SVladimir Kondratyev.Xr ehci 4 ,
7101f2e864SVladimir Kondratyev.Xr ohci 4 ,
7201f2e864SVladimir Kondratyev.Xr uhci 4 ,
7301f2e864SVladimir Kondratyev.Xr usb 4 ,
7401f2e864SVladimir Kondratyev.Xr xhci 4 ,
7501f2e864SVladimir Kondratyev.Xr usbconfig 8
7601f2e864SVladimir Kondratyev.Sh HISTORY
7701f2e864SVladimir KondratyevThe
7801f2e864SVladimir Kondratyev.Nm
7901f2e864SVladimir Kondratyevdriver first appeared in
8001f2e864SVladimir Kondratyev.Fx 13.0.
8101f2e864SVladimir Kondratyev.Sh AUTHORS
8201f2e864SVladimir Kondratyev.An -nosplit
8301f2e864SVladimir KondratyevThe
8401f2e864SVladimir Kondratyev.Nm
8501f2e864SVladimir Kondratyevdriver was written by
8601f2e864SVladimir Kondratyev.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
87