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