xref: /freebsd/share/man/man4/hcons.4 (revision afd590d9e56686e179cbbf626ec567aeaaa49199)
1*afd590d9SVladimir Kondratyev.\" Copyright (c) 2020 Vladimir Kondratyev <wulf@FreeBSD.org>
2*afd590d9SVladimir Kondratyev.\"
3*afd590d9SVladimir Kondratyev.\" Redistribution and use in source and binary forms, with or without
4*afd590d9SVladimir Kondratyev.\" modification, are permitted provided that the following conditions
5*afd590d9SVladimir Kondratyev.\" are met:
6*afd590d9SVladimir Kondratyev.\" 1. Redistributions of source code must retain the above copyright
7*afd590d9SVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer.
8*afd590d9SVladimir Kondratyev.\" 2. Redistributions in binary form must reproduce the above copyright
9*afd590d9SVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer in the
10*afd590d9SVladimir Kondratyev.\"    documentation and/or other materials provided with the distribution.
11*afd590d9SVladimir Kondratyev.\"
12*afd590d9SVladimir Kondratyev.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13*afd590d9SVladimir Kondratyev.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14*afd590d9SVladimir Kondratyev.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15*afd590d9SVladimir Kondratyev.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16*afd590d9SVladimir Kondratyev.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17*afd590d9SVladimir Kondratyev.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18*afd590d9SVladimir Kondratyev.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19*afd590d9SVladimir Kondratyev.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20*afd590d9SVladimir Kondratyev.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21*afd590d9SVladimir Kondratyev.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22*afd590d9SVladimir Kondratyev.\" SUCH DAMAGE.
23*afd590d9SVladimir Kondratyev.\"
24*afd590d9SVladimir Kondratyev.\" $FreeBSD$
25*afd590d9SVladimir Kondratyev.\"
26*afd590d9SVladimir Kondratyev.Dd September 14, 2020
27*afd590d9SVladimir Kondratyev.Dt HCONS 4
28*afd590d9SVladimir Kondratyev.Os
29*afd590d9SVladimir Kondratyev.Sh NAME
30*afd590d9SVladimir Kondratyev.Nm hcons
31*afd590d9SVladimir Kondratyev.Nd HID consumer page controls driver
32*afd590d9SVladimir Kondratyev.Sh SYNOPSIS
33*afd590d9SVladimir KondratyevTo compile this driver into the kernel,
34*afd590d9SVladimir Kondratyevplace the following lines in your
35*afd590d9SVladimir Kondratyevkernel configuration file:
36*afd590d9SVladimir Kondratyev.Bd -ragged -offset indent
37*afd590d9SVladimir Kondratyev.Cd "device hcons"
38*afd590d9SVladimir Kondratyev.Cd "device hid"
39*afd590d9SVladimir Kondratyev.Cd "device hidbus"
40*afd590d9SVladimir Kondratyev.Cd "device hidmap"
41*afd590d9SVladimir Kondratyev.Cd "device evdev"
42*afd590d9SVladimir Kondratyev.Ed
43*afd590d9SVladimir Kondratyev.Pp
44*afd590d9SVladimir KondratyevAlternatively, to load the driver as a
45*afd590d9SVladimir Kondratyevmodule at boot time, place the following line in
46*afd590d9SVladimir Kondratyev.Xr loader.conf 5 :
47*afd590d9SVladimir Kondratyev.Bd -literal -offset indent
48*afd590d9SVladimir Kondratyevhgame_load="YES"
49*afd590d9SVladimir Kondratyev.Ed
50*afd590d9SVladimir Kondratyev.Sh DESCRIPTION
51*afd590d9SVladimir KondratyevThe
52*afd590d9SVladimir Kondratyev.Nm
53*afd590d9SVladimir Kondratyevdriver provides support for HID consumer page controls most often used as
54*afd590d9SVladimir Kondratyev"Multimedia keys" found on many keyboards.
55*afd590d9SVladimir Kondratyev.Pp
56*afd590d9SVladimir KondratyevThe
57*afd590d9SVladimir Kondratyev.Pa /dev/input/event*
58*afd590d9SVladimir Kondratyevdevice presents the consumer page controls as a
59*afd590d9SVladimir Kondratyev.Ar evdev
60*afd590d9SVladimir Kondratyevtype device.
61*afd590d9SVladimir Kondratyev.Sh SYSCTL VARIABLES
62*afd590d9SVladimir KondratyevThe following variable is available as both
63*afd590d9SVladimir Kondratyev.Xr sysctl 8
64*afd590d9SVladimir Kondratyevvariable and
65*afd590d9SVladimir Kondratyev.Xr loader 8
66*afd590d9SVladimir Kondratyevtunable:
67*afd590d9SVladimir Kondratyev.Bl -tag -width indent
68*afd590d9SVladimir Kondratyev.It Va dev.hcons.X.debug
69*afd590d9SVladimir KondratyevDebug output level, where 0 is debugging disabled and larger values increase
70*afd590d9SVladimir Kondratyevdebug message verbosity.
71*afd590d9SVladimir KondratyevDefault is 0.
72*afd590d9SVladimir Kondratyev.El
73*afd590d9SVladimir Kondratyev.Pp
74*afd590d9SVladimir KondratyevIt default value is set with
75*afd590d9SVladimir Kondratyev.Xr loader 8
76*afd590d9SVladimir Kondratyevtunable:
77*afd590d9SVladimir Kondratyev.Bl -tag -width indent
78*afd590d9SVladimir Kondratyev.It Va hw.hid.hcons.debug
79*afd590d9SVladimir Kondratyev.El
80*afd590d9SVladimir Kondratyev.Sh FILES
81*afd590d9SVladimir Kondratyev.Bl -tag -width /dev/input/event* -compact
82*afd590d9SVladimir Kondratyev.It Pa /dev/input/event*
83*afd590d9SVladimir Kondratyevinput event device node.
84*afd590d9SVladimir Kondratyev.El
85*afd590d9SVladimir Kondratyev.Sh SEE ALSO
86*afd590d9SVladimir Kondratyev.Xr iichid 4 ,
87*afd590d9SVladimir Kondratyev.Xr usbhid 4
88*afd590d9SVladimir Kondratyev.Sh HISTORY
89*afd590d9SVladimir KondratyevThe
90*afd590d9SVladimir Kondratyev.Nm
91*afd590d9SVladimir Kondratyevdriver first appeared in
92*afd590d9SVladimir Kondratyev.Fx 13.0.
93*afd590d9SVladimir Kondratyev.Sh AUTHORS
94*afd590d9SVladimir Kondratyev.An -nosplit
95*afd590d9SVladimir KondratyevThe
96*afd590d9SVladimir Kondratyev.Nm
97*afd590d9SVladimir Kondratyevdriver was written by
98*afd590d9SVladimir Kondratyev.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
99