xref: /freebsd/share/man/man4/hsctrl.4 (revision 315ee00f)
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 26, 2021
25.Dt HSCTRL 4
26.Os
27.Sh NAME
28.Nm hsctrl
29.Nd HID system controls 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 hsctrl"
36.Cd "device hid"
37.Cd "device hidbus"
38.Cd "device hidmap"
39.Cd "device evdev"
40.Ed
41.Pp
42Alternatively, to load the driver as a
43module at boot time, place the following line in
44.Xr loader.conf 5 :
45.Bd -literal -offset indent
46hsctrl_load="YES"
47.Ed
48.Sh DESCRIPTION
49The
50.Nm
51driver provides support for HID system controls most often used as
52"Power off/Sleep keys" found on many keyboards.
53.Pp
54The
55.Pa /dev/input/event*
56device presents the consumer page controls as a
57.Ar evdev
58type device.
59.Sh SYSCTL VARIABLES
60The following variable is available as both
61.Xr sysctl 8
62variable and
63.Xr loader 8
64tunable:
65.Bl -tag -width indent
66.It Va dev.hsctrl.X.debug
67Debug output level, where 0 is debugging disabled and larger values increase
68debug message verbosity.
69Default is 0.
70.El
71.Pp
72It default value is set with
73.Xr loader 8
74tunable:
75.Bl -tag -width indent
76.It Va hw.hid.hsctrl.debug
77.El
78.Sh FILES
79.Bl -tag -width /dev/input/event* -compact
80.It Pa /dev/input/event*
81input event device node.
82.El
83.Sh SEE ALSO
84.Xr iichid 4 ,
85.Xr usbhid 4
86.Sh HISTORY
87The
88.Nm
89driver first appeared in
90.Fx 13.0.
91.Sh AUTHORS
92.An -nosplit
93The
94.Nm
95driver was written by
96.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
97