summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/iichid.4 3.html
diff options
context:
space:
mode:
Diffstat (limited to 'static/freebsd/man4/iichid.4 3.html')
-rw-r--r--static/freebsd/man4/iichid.4 3.html84
1 files changed, 84 insertions, 0 deletions
diff --git a/static/freebsd/man4/iichid.4 3.html b/static/freebsd/man4/iichid.4 3.html
new file mode 100644
index 00000000..c5dc8855
--- /dev/null
+++ b/static/freebsd/man4/iichid.4 3.html
@@ -0,0 +1,84 @@
+<table class="head">
+ <tr>
+ <td class="head-ltitle">IICHID(4)</td>
+ <td class="head-vol">Device Drivers Manual</td>
+ <td class="head-rtitle">IICHID(4)</td>
+ </tr>
+</table>
+<div class="manual-text">
+<section class="Sh">
+<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
+<p class="Pp"><code class="Nm">iichid</code> &#x2014; <span class="Nd">I2C HID
+ transport driver</span></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
+<p class="Pp">To compile this driver into the kernel, place the following lines
+ in your kernel configuration file:</p>
+<div class="Bd Pp Bd-indent"><code class="Cd">device iichid</code></div>
+<p class="Pp">Alternatively, to load the driver as a module at boot time, place
+ the following line in <a class="Xr">loader.conf(5)</a>:</p>
+<div class="Bd Pp Bd-indent Li">
+<pre>iichid_load=&quot;YES&quot;</pre>
+</div>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
+<p class="Pp">The <code class="Nm">iichid</code> driver provides a interface to
+ I2C Human Interface Devices (HIDs).</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL
+ VARIABLES</a></h1>
+<p class="Pp">Next parameters are available as <a class="Xr">sysctl(8)</a>
+ variables. Debug parameter is available as <a class="Xr">loader(8)</a>
+ tunable as well.</p>
+<dl class="Bl-tag">
+ <dt id="dev.iichid.*.sampling_rate_fast"><var class="Va">dev.iichid.*.sampling_rate_fast</var></dt>
+ <dd>Active sampling rate in num/second (for sampling mode).</dd>
+ <dt id="dev.iichid.*.sampling_rate_slow"><var class="Va">dev.iichid.*.sampling_rate_slow</var></dt>
+ <dd>Idle sampling rate in num/second (for sampling mode).</dd>
+ <dt id="dev.iichid.*.sampling_hysteresis"><var class="Va">dev.iichid.*.sampling_hysteresis</var></dt>
+ <dd>Number of missing samples before enabling of slow mode (for sampling
+ mode).</dd>
+ <dt id="hw.iichid.debug"><var class="Va">hw.iichid.debug</var></dt>
+ <dd>Debug output level, where 0 is debugging disabled and larger values
+ increase debug message verbosity. Default is 0.</dd>
+</dl>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
+ ALSO</a></h1>
+<p class="Pp"><a class="Xr">ig4(4)</a></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
+<p class="Pp">The <code class="Nm">iichid</code> does not support GPIO
+ interrupts yet. In that case <code class="Nm">iichid</code> enables sampling
+ mode with periodic polling of hardware by driver means. See
+ dev.iichid.*.sampling_* <a class="Xr">sysctl(8)</a> variables for tuning of
+ sampling parameters.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
+<p class="Pp">The <code class="Nm">iichid</code> driver first appeared in
+ <span class="Ux">FreeBSD 13.0</span>.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
+<p class="Pp">The <code class="Nm">iichid</code> driver was written by
+ <span class="An">Marc Priggemeyer</span>
+ &lt;<a class="Mt" href="mailto:marc.priggemeyer@gmail.com">marc.priggemeyer@gmail.com</a>&gt;
+ and <span class="An">Vladimir Kondratyev</span>
+ &lt;<a class="Mt" href="mailto:wulf@FreeBSD.org">wulf@FreeBSD.org</a>&gt;.</p>
+<p class="Pp">This manual page was written by <span class="An">Vladimir
+ Kondratyev</span>
+ &lt;<a class="Mt" href="mailto:wulf@FreeBSD.org">wulf@FreeBSD.org</a>&gt;.</p>
+</section>
+</div>
+<table class="foot">
+ <tr>
+ <td class="foot-date">September 21, 2020</td>
+ <td class="foot-os">FreeBSD 15.0</td>
+ </tr>
+</table>