xref: /freebsd/share/man/man4/iichid.4 (revision e47a47b2150f86216e6eca666d902ce20bd5031a)
1b1f1b07fSVladimir Kondratyev.\" Copyright (c) 2020 Vladimir Kondratyev <wulf@FreeBSD.org>
2b1f1b07fSVladimir Kondratyev.\"
3b1f1b07fSVladimir Kondratyev.\" Redistribution and use in source and binary forms, with or without
4b1f1b07fSVladimir Kondratyev.\" modification, are permitted provided that the following conditions
5b1f1b07fSVladimir Kondratyev.\" are met:
6b1f1b07fSVladimir Kondratyev.\" 1. Redistributions of source code must retain the above copyright
7b1f1b07fSVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer.
8b1f1b07fSVladimir Kondratyev.\" 2. Redistributions in binary form must reproduce the above copyright
9b1f1b07fSVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer in the
10b1f1b07fSVladimir Kondratyev.\"    documentation and/or other materials provided with the distribution.
11b1f1b07fSVladimir Kondratyev.\"
12b1f1b07fSVladimir Kondratyev.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13b1f1b07fSVladimir Kondratyev.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14b1f1b07fSVladimir Kondratyev.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15b1f1b07fSVladimir Kondratyev.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16b1f1b07fSVladimir Kondratyev.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17b1f1b07fSVladimir Kondratyev.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18b1f1b07fSVladimir Kondratyev.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19b1f1b07fSVladimir Kondratyev.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20b1f1b07fSVladimir Kondratyev.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21b1f1b07fSVladimir Kondratyev.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22b1f1b07fSVladimir Kondratyev.\" SUCH DAMAGE.
23b1f1b07fSVladimir Kondratyev.\"
24b1f1b07fSVladimir Kondratyev.Dd September 21, 2020
25b1f1b07fSVladimir Kondratyev.Dt IICHID 4
26b1f1b07fSVladimir Kondratyev.Os
27b1f1b07fSVladimir Kondratyev.Sh NAME
28b1f1b07fSVladimir Kondratyev.Nm iichid
29b1f1b07fSVladimir Kondratyev.Nd I2C HID transport driver
30b1f1b07fSVladimir Kondratyev.Sh SYNOPSIS
31b1f1b07fSVladimir KondratyevTo compile this driver into the kernel,
32b1f1b07fSVladimir Kondratyevplace the following lines in your
33b1f1b07fSVladimir Kondratyevkernel configuration file:
34b1f1b07fSVladimir Kondratyev.Bd -ragged -offset indent
35b1f1b07fSVladimir Kondratyev.Cd "device iichid"
36b1f1b07fSVladimir Kondratyev.Ed
37b1f1b07fSVladimir Kondratyev.Pp
38b1f1b07fSVladimir KondratyevAlternatively, to load the driver as a
39b1f1b07fSVladimir Kondratyevmodule at boot time, place the following line in
40b1f1b07fSVladimir Kondratyev.Xr loader.conf 5 :
41b1f1b07fSVladimir Kondratyev.Bd -literal -offset indent
42b1f1b07fSVladimir Kondratyeviichid_load="YES"
43b1f1b07fSVladimir Kondratyev.Ed
44b1f1b07fSVladimir Kondratyev.Sh DESCRIPTION
45b1f1b07fSVladimir KondratyevThe
46b1f1b07fSVladimir Kondratyev.Nm
47b1f1b07fSVladimir Kondratyevdriver provides a interface to I2C Human Interface Devices (HIDs).
48b1f1b07fSVladimir Kondratyev.Sh SYSCTL VARIABLES
49b1f1b07fSVladimir KondratyevNext parameters are available as
50b1f1b07fSVladimir Kondratyev.Xr sysctl 8
51b1f1b07fSVladimir Kondratyevvariables.
52b1f1b07fSVladimir KondratyevDebug parameter is available as
53b1f1b07fSVladimir Kondratyev.Xr loader 8
54b1f1b07fSVladimir Kondratyevtunable as well.
55b1f1b07fSVladimir Kondratyev.Bl -tag -width indent
56b1f1b07fSVladimir Kondratyev.It Va dev.iichid.*.sampling_rate_fast
57b1f1b07fSVladimir KondratyevActive sampling rate in num/second (for sampling mode).
58b1f1b07fSVladimir Kondratyev.It Va dev.iichid.*.sampling_rate_slow
59b1f1b07fSVladimir KondratyevIdle sampling rate in num/second (for sampling mode).
60b1f1b07fSVladimir Kondratyev.It Va dev.iichid.*.sampling_hysteresis
61b1f1b07fSVladimir KondratyevNumber of missing samples before enabling of slow mode (for sampling mode).
62b1f1b07fSVladimir Kondratyev.It Va hw.iichid.debug
63b1f1b07fSVladimir KondratyevDebug output level, where 0 is debugging disabled and larger values increase
64b1f1b07fSVladimir Kondratyevdebug message verbosity.
65b1f1b07fSVladimir KondratyevDefault is 0.
66b1f1b07fSVladimir Kondratyev.El
67b1f1b07fSVladimir Kondratyev.Sh SEE ALSO
68b1f1b07fSVladimir Kondratyev.Xr ig4 4
69b1f1b07fSVladimir Kondratyev.Sh BUGS
70b1f1b07fSVladimir KondratyevThe
71b1f1b07fSVladimir Kondratyev.Nm
72b1f1b07fSVladimir Kondratyevdoes not support GPIO interrupts yet.
73b1f1b07fSVladimir KondratyevIn that case
74b1f1b07fSVladimir Kondratyev.Nm
75b1f1b07fSVladimir Kondratyevenables sampling mode with periodic polling of hardware by driver means.
76b1f1b07fSVladimir KondratyevSee dev.iichid.*.sampling_*
77*e9e615c8SJens Schweikhardt.Xr sysctl 8
78b1f1b07fSVladimir Kondratyevvariables for tuning of sampling parameters.
79b1f1b07fSVladimir Kondratyev.Sh HISTORY
80b1f1b07fSVladimir KondratyevThe
81b1f1b07fSVladimir Kondratyev.Nm
82b1f1b07fSVladimir Kondratyevdriver first appeared in
83b1f1b07fSVladimir Kondratyev.Fx 13.0 .
84b1f1b07fSVladimir Kondratyev.Sh AUTHORS
85b1f1b07fSVladimir Kondratyev.An -nosplit
86b1f1b07fSVladimir KondratyevThe
87b1f1b07fSVladimir Kondratyev.Nm
88b1f1b07fSVladimir Kondratyevdriver was written by
89b1f1b07fSVladimir Kondratyev.An Marc Priggemeyer Aq Mt marc.priggemeyer@gmail.com
90b1f1b07fSVladimir Kondratyevand
91b1f1b07fSVladimir Kondratyev.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
92b1f1b07fSVladimir Kondratyev.Pp
93b1f1b07fSVladimir KondratyevThis manual page was written by
94b1f1b07fSVladimir Kondratyev.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
95