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