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