1 .\" Copyright (c) 2015 Michael Gmelin <freebsd@grem.de>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd Cypress APA trackpad with I2C interface driver
34 To compile this driver into the kernel, place the following lines into
35 the kernel configuration file:
36 .Bd -ragged -offset indent
42 Alternatively, to load the driver as a module at boot time, place the following line in
44 .Bd -literal -offset indent
49 On many Chromebook models this driver can be automatically configured with the
51 .Xr chromebook_platform 4
55 driver can be manually configured in
56 .Pa /boot/device.hints :
57 .Cd hint.cyapa.0.at="iicbus0"
58 .Cd hint.cyapa.0.addr="0xCE"
59 .Cd hint.cyapa.1.at="iicbus1"
60 .Cd hint.cyapa.1.addr="0xCE"
64 driver provides support for the Cypress APA trackpad.
65 It emulates the IntelliMouse PS/2 protocol.
66 It supports basic mouse ioctls, so that
68 is supported properly.
72 +--------------------+------------+
76 | Button +------------+
79 +--------------------+............|
80 | Thumb/Button Area | 15%
81 +---------------------------------+
85 .It Va Two finger scrolling
86 Use two fingers for Z axis scrolling.
87 .It Va Button down/second finger
88 While one finger clicks and holds down the touchpad, the second finger can be
89 used to move the mouse cursor.
90 This can be useful for drawing or selecting text.
91 .It Va Thumb/Button area
92 The lower 15% of the trackpad will not affect the mouse cursor position.
93 This allows for high precision clicking, by controlling the cursor with the
94 index finger and pushing/holding the pad down with the thumb.
95 .It Va Trackpad button
97 The left two thirds of the pad issues a LEFT button event.
98 The upper right corner issues a MIDDLE button event.
99 The lower right corner issues a RIGHT button.
100 Optionally, tap to click can be enabled (see below).
105 these values are configurable for
107 .Bl -tag -width "hint.cyapa.%d.addr"
108 .It Va hint.cyapa.%d.at
111 .It Va hint.cyapa.%d.addr
119 variables are available:
121 .It Va debug.cyapa_idle_freq
122 Scan frequency in idle mode, the default is 1.
123 .It Va debug.cyapa_slow_freq
124 Scan frequency in slow mode, the default is 20.
125 .It Va debug.cyapa_norm_freq
126 Scan frequency in normal mode, the default is 100.
127 .It Va debug.cyapa_minpressure
128 Minimum pressure to detect a finger, the default is 12.
129 .It Va debug.cyapa_enable_tapclick
130 Controls tap to click.
134 Tap to click is disabled.
135 This is the default value.
137 Tap to click always generates a left mouse button event.
139 Tap to click generates left mouse button event if the left 2/3rds of the pad
140 are tapped and a right mouse button event otherwise.
142 Tap to click generates mouse button events as if the physical button was
147 .It Va debug.cyapa_tapclick_min_ticks
148 Minimum tap duration in ticks to create a click, the default is 1.
149 .It Va debug.cyapa_tapclick_max_ticks
150 Maximum tap duration in ticks to create a click, the default is 8.
151 .It Va debug.cyapa_move_min_ticks
152 Minimum ticks before cursor movement occurs, the default is 4.
153 .It Va debug.cyapa_scroll_wait_ticks
154 Ticks to wait before starting to scroll, the default is 0.
155 .It Va debug.cyapa_scroll_stick_ticks
156 Ticks while preventing cursor movement on single finger after scroll,
158 .It Va debug.cyapa_thumbarea_percent
159 Size of bottom thumb area in percent, the default is 15.
160 .It Va debug.cyapa_debug
161 Setting this to a non-zero value enables debug output to console and syslog,
163 .It Va debug.cyapa_reset
164 Setting this to a non-zero value reinitializes the device.
165 The sysctl resets to zero immediately.
171 which presents the mouse as an
172 .Ar IntelliMouse PS/2
176 levels 0 through 2, level 1 is used by default.
182 add the following lines to the
186 .Dl moused_enable="YES"
187 .Dl moused_port="/dev/cyapa0"
189 If vertical scrolling is not desired, add
191 .Dl moused_flags="-l0"
196 Enable tap to click for the left and the right mouse button and
197 disable the thumb area by adding these lines to the
201 .Dl debug.cyapa_thumbarea_percent=0
202 .Dl debug.cyapa_enable_tapclick=2
204 .Xr chromebook_platform 4 ,
213 driver was written for DragonFly BSD by
216 It has been ported, modified, and enhanced for
219 .An Michael Gmelin Aq Mt freebsd@grem.de .
221 This manual page was written by
222 .An Michael Gmelin Aq Mt freebsd@grem.de .
226 driver detects the device from the I2C address.
227 This might have unforeseen consequences if the initialization sequence
228 is sent to an unknown device at that address.