IICHID(4)

📦
version 15.1 · 2 versions
, in freebsd 15.1, nixpkgs unstable

💅 IICHID(4) — the I2C HID transport driver, explained 🎀

okay so bestie, this is the manual page for iichid(4) from the Kernel Interfaces Manual — yes it's giving kernel-interface realness, and we're gonna get through it together, no cap. ✨

🦋 NAME

iichid — the I2C HID transport driver, aka the little connector that lets your kernel talk to I2C Human Interface Devices. literally it's the middleman. 🫶

🌸 SYNOPSIS

So there's two ways to get this baby into your life, and both are valid.

Way 1 — bake it into the kernel. drop these lines in your kernel configuration file:

device iichid

Way 2 — load it as a module at boot time. then go put this line into loader.conf(5):

iichid_load="YES"

both slay, pick your fighter. 💖

✨ DESCRIPTION

The iichid driver provides a interface to I2C Human Interface Devices (HIDs).

that's the whole thing. short king energy. 👑

🎀 SYSCTL VARIABLES

Next parameters are available as sysctl(8) variables. Also important: the debug parameter is available as a loader(8) tunable as well — so you can set that one early, before the kernel even gets its coffee. ☕

  • dev.iichid.*.sampling_rate_fast — the active sampling rate, in num/second. this is the one that kicks in for sampling mode. 🏃‍♀️
  • dev.iichid.*.sampling_rate_slow — the idle sampling rate, in num/second (for sampling mode). chill mode. 😴
  • dev.iichid.*.sampling_hysteresis — how many missing samples it tolerates before it switches on slow mode (for sampling mode). like, how many texts go unanswered before it assumes you're busy. 📵
  • hw.iichid.debug — debug output level, where 0 means debugging disabled, and larger values increase debug message verbosity. default is 0. turn it up when you're nosy, iykyk. 🔍

🔥 SEE ALSO

that's it, that's the whole list. quality over quantity bestie. 💜

💀 BUGS

Okay so, real talk — iichid does not support GPIO interrupts yet. 😭 and in that case, iichid enables sampling mode with periodic polling of hardware by driver means. like, it just keeps asking "you good? you good?" on repeat.

if you need to tune that polling life, see the dev.iichid.*.sampling_* sysctl(8) variables. that's where your knobs are, bestie. 🎛️

🌈 HISTORY

The iichid driver first appeared in FreeBSD 13.0. a whole era. ⭐

👑 AUTHORS

The iichid driver was written by Marc Priggemeyer <marc.priggemeyer@gmail.com> and Vladimir Kondratyev <wulf@FreeBSD.org>.

This manual page was written by Vladimir Kondratyev <wulf@FreeBSD.org>.

give them their flowers, fr fr. 🌸💐

and that's the page, bestie! 🧚 this version dropped on Debian, dated September 21, 2020, and it's the IICHID(4) page — go forth and interface with your HIDs. 💅✨

📦 where this page comes from