CYAPA(4)

💖 CYAPA(4) — the Cypress APA trackpad glow-up 💖

okay bestie, gather round, because this is the manual page for cyapa, aka the Cypress APA trackpad with I2C interface driver — and she is literally the reason your Chromebook trackpad doesn't just sit there being useless. this lives in the Kernel Interfaces Manual section, and yes, she's iconic. 🎀

---

✨ NAME ✨

cyapa — Cypress APA trackpad with I2C interface driver. that's it, that's the girl. 🦋

---

✨ SYNOPSIS ✨

so if you wanna bake this driver into the kernel (main character move, no cap), you drop these lines into your kernel configuration file:

device cyapa
device ig4
device iicbus

or, if you'd rather load it as a module at boot time instead (lowkey easier, tbh), put this line in loader.conf(5):

cyapa_load="YES"
ig4_load="YES"

and here's the tea: on many Chromebook models this driver can be automatically configured with the help of the chromebook_platform(4) driver. obsessed. ✨ alternatively, you can configure the cyapa driver manually in /boot/device.hints:

hint.cyapa.0.at="iicbus0"
hint.cyapa.0.addr="0xCE"
hint.cyapa.1.at="iicbus1"
hint.cyapa.1.addr="0xCE"

---

✨ DESCRIPTION ✨

the cyapa driver provides support for the Cypress APA trackpad. it emulates the IntelliMouse PS/2 protocol. 💅 and it supports basic mouse ioctls, so that moused(8) is supported properly. we love a compatible queen.

🎀 Trackpad layout 🎀

here's the map, bestie — memorize it, there will be a quiz:

                       2/3               1/3
              +--------------------+------------+
              |                    |   Middle   |
              |                    |   Button   |
              |       Left         |            |
              |      Button        +------------+
              |                    |   Right    |
              |                    |   Button   |
              +--------------------+............|
              |     Thumb/Button Area           | 15%
              +---------------------------------+

🌸 Trackpad features 🌸

• Two finger scrolling — use two fingers for Z axis scrolling. that's it. two fingers, vibes only.
• Button down/second finger — while one finger clicks and holds down the touchpad, the second finger can be used to move the mouse cursor. this can be useful for drawing or selecting text. multitasking icon behavior, fr fr.
• Thumb/Button area — the lower 15% of the trackpad will not affect the mouse cursor position. this allows for high precision clicking, by controlling the cursor with the index finger and pushing/holding the pad down with the thumb. chef's kiss precision. 👑
• Trackpad button — push physical button. the left two thirds of the pad issues a LEFT button event. the upper right corner issues a MIDDLE button event. the lower right corner issues a RIGHT button. optionally, tap to click can be enabled (see below). ✨

on a system using device.hints(5), these values are configurable for cyapa:

• hint.cyapa.%d.at — target iicbus(4).
• hint.cyapa.%d.addr — cyapa i2c address on the iicbus(4).

---

✨ SYSCTL VARIABLES ✨

these sysctl(8) variables are available, and honestly they're the tuning knobs of your dreams:

• debug.cyapa_idle_freq — scan frequency in idle mode, the default is 1.
• debug.cyapa_slow_freq — scan frequency in slow mode, the default is 20.
• debug.cyapa_norm_freq — scan frequency in normal mode, the default is 100.
• debug.cyapa_minpressure — minimum pressure to detect a finger, the default is 12.
• debug.cyapa_enable_tapclick — controls tap to click. possible values:
  1. 0 — tap to click is disabled. this is the default value.
  2. 1 — tap to click always generates a left mouse button event.
  3. 2 — tap to click generates left mouse button event if the left 2/3rds of the pad are tapped and a right mouse button event otherwise.
  4. 3 — tap to click generates mouse button events as if the physical button was pressed (see “DESCRIPTION” above).
• debug.cyapa_tapclick_min_ticks — minimum tap duration in ticks to create a click, the default is 1.
• debug.cyapa_tapclick_max_ticks — maximum tap duration in ticks to create a click, the default is 8.
• debug.cyapa_move_min_ticks — minimum ticks before cursor movement occurs, the default is 4.
• debug.cyapa_scroll_wait_ticks — ticks to wait before starting to scroll, the default is 0.
• debug.cyapa_scroll_stick_ticks — ticks while preventing cursor movement on single finger after scroll, the default is 15.
• debug.cyapa_thumbarea_percent — size of bottom thumb area in percent, the default is 15.
• debug.cyapa_debug — setting this to a non-zero value enables debug output to console and syslog, the default is 0.
• debug.cyapa_reset — setting this to a non-zero value reinitializes the device. the sysctl resets to zero immediately. 🫶

---

✨ FILES ✨

cyapa creates /dev/cyapa0, which presents the mouse as an IntelliMouse PS/2 device. it supports moused(8) levels 0 through 2, and level 1 is used by default. periodt. 💅

---

✨ EXAMPLES ✨

to use cyapa with moused(8), add the following lines to the rc.conf(5) file:

moused_enable="YES"
moused_port="/dev/cyapa0"

if vertical scrolling is not desired, add

moused_flags="-l0"

to rc.conf(5).

enable tap to click for the left and the right mouse button and disable the thumb area by adding these lines to the sysctl.conf(5) file:

debug.cyapa_thumbarea_percent=0
debug.cyapa_enable_tapclick=2

ate. no crumbs. 🍓

---

✨ SEE ALSO ✨

chromebook_platform(4), ig4(4), iicbus(4), sysmouse(4), moused(8)

---

✨ AUTHORS ✨

the original cyapa driver was written for DragonFly BSD by Matthew Dillon. 🫡

it has been ported, modified, and enhanced for FreeBSD by Michael Gmelin <freebsd@grem.de>.

this manual page was written by Michael Gmelin <freebsd@grem.de>.

---

✨ BUGS ✨

bestie, listen up, because this one's important: the cyapa driver detects the device from the I2C address. this might have unforeseen consequences if the initialization sequence is sent to an unknown device at that address. 💀 so like… be careful, okay? that's the whole warning.

---

and that's the whole page, my love 💜 this was the CYAPA(4) page from the Debian edition, dated December 18, 2018 — go forth and scroll with two fingers like the icon you are. 🌈✨🎀