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