share/man/man4/hconf.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 18, 2021
  27 .Dt HCONF 4
  28 .Os
  29 .Sh NAME
  30 .Nm hconf
  31 .Nd MS Windows Precision Touchpad configuration 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 hconf"
  38 .Cd "device hid"
  39 .Cd "device hidbus"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 hconf_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 driver provides support for generic MS Windows Precision Touchpad
  52 configuration collection.
  53 It enables the host to configure two different aspects of the device.
  54 One allows the host to select input mode, and the other allows the host to be
  55 selective in what is reported.
  56 .Sh SYSCTL VARIABLES
  57 Next parameters are available as
  58 .Xr sysctl 8
  59 variables.
  60 Debug parameter is available as
  61 .Xr loader 8
  62 tunable as well.
  63 .Bl -tag -width indent
  64 .It Va dev.hconf.*.input_mode
  65 HID device input mode: 0 = mouse, 3 = touchpad.
  66 .It Va dev.hconf.*.surface_switch
  67 Enable / disable switch for surface: 1 = on, 0 = off.
  68 .It Va dev.hconf.*.buttons_switch
  69 Enable / disable switch for buttons: 1 = on, 0 = off.
  70 .It Va hw.hid.hconf.debug
  71 Debug output level, where 0 is debugging disabled and larger values increase
  72 debug message verbosity.
  73 Default is 0.
  74 .El
  75 .Sh SEE ALSO
  76 .Xr hms 4 ,
  77 .Xr hmt 4
  78 .Sh HISTORY
  79 The
  80 .Nm
  81 driver first appeared in
  82 .Fx 13.0.
  83 .Sh AUTHORS
  84 .An -nosplit
  85 The
  86 .Nm
  87 driver was written by
  88 .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
  89 Switch parameter support was added by
  90 .An Andriy Gapon Aq Mt avg@FreeBSD.org .