share/man/man4/usbhid.4

   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 .\" $FreeBSD$
  25 .\"
  26 .Dd January 12, 2021
  27 .Dt USBHID 4
  28 .Os
  29 .Sh NAME
  30 .Nm usbhid
  31 .Nd USB HID transport driver
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following lines in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device usbhid"
  38 .Ed
  39 .Pp
  40 Alternatively, to load the driver as a
  41 module at boot time, place the following line in
  42 .Xr loader.conf 5 :
  43 .Bd -literal -offset indent
  44 usbhid_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 driver provides a interface to USB Human Interface Devices (HIDs).
  50 .Sh SYSCTL VARIABLES
  51 The following variables are available as both
  52 .Xr sysctl 8
  53 variables and
  54 .Xr loader 8
  55 tunables:
  56 .Bl -tag -width indent
  57 .It Va hw.usb.usbhid.enable
  58 Enable
  59 .Nm
  60 and make its priority greater than other USB HID drivers have.
  61 Default is 0.
  62 .El
  63 .Bl -tag -width indent
  64 .It Va hw.usb.usbhid.debug
  65 Debug output level, where 0 is debugging disabled and larger values increase
  66 debug message verbosity.
  67 Default is 0.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr ehci 4 ,
  71 .Xr ohci 4 ,
  72 .Xr uhci 4 ,
  73 .Xr usb 4 ,
  74 .Xr xhci 4 ,
  75 .Xr usbconfig 8
  76 .Sh HISTORY
  77 The
  78 .Nm
  79 driver first appeared in
  80 .Fx 13.0.
  81 .Sh AUTHORS
  82 .An -nosplit
  83 The
  84 .Nm
  85 driver was written by
  86 .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .