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 September 21, 2020 25.Dt IICHID 4 26.Os 27.Sh NAME 28.Nm iichid 29.Nd I2C HID transport 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 iichid" 36.Ed 37.Pp 38Alternatively, to load the driver as a 39module at boot time, place the following line in 40.Xr loader.conf 5 : 41.Bd -literal -offset indent 42iichid_load="YES" 43.Ed 44.Sh DESCRIPTION 45The 46.Nm 47driver provides a interface to I2C Human Interface Devices (HIDs). 48.Sh SYSCTL VARIABLES 49Next parameters are available as 50.Xr sysctl 8 51variables. 52Debug parameter is available as 53.Xr loader 8 54tunable as well. 55.Bl -tag -width indent 56.It Va dev.iichid.*.sampling_rate_fast 57Active sampling rate in num/second (for sampling mode). 58.It Va dev.iichid.*.sampling_rate_slow 59Idle sampling rate in num/second (for sampling mode). 60.It Va dev.iichid.*.sampling_hysteresis 61Number of missing samples before enabling of slow mode (for sampling mode). 62.It Va hw.iichid.debug 63Debug output level, where 0 is debugging disabled and larger values increase 64debug message verbosity. 65Default is 0. 66.El 67.Sh SEE ALSO 68.Xr ig4 4 69.Sh BUGS 70The 71.Nm 72does not support GPIO interrupts yet. 73In that case 74.Nm 75enables sampling mode with periodic polling of hardware by driver means. 76See dev.iichid.*.sampling_* 77.Xr sysctl 8 78variables for tuning of sampling parameters. 79.Sh HISTORY 80The 81.Nm 82driver first appeared in 83.Fx 13.0 . 84.Sh AUTHORS 85.An -nosplit 86The 87.Nm 88driver was written by 89.An Marc Priggemeyer Aq Mt marc.priggemeyer@gmail.com 90and 91.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . 92.Pp 93This manual page was written by 94.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . 95