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
50 .Pa /boot/device.hints :
51 .Cd hint.cyapa.0.at="iicbus0"
52 .Cd hint.cyapa.0.addr="0xCE"
53 .Cd hint.cyapa.1.at="iicbus1"
54 .Cd hint.cyapa.1.addr="0xCE"
58 driver provides support for the Cypress APA trackpad.
59 It emulates the IntelliMouse PS/2 protocol.
60 It supports basic mouse ioctls, so that
62 is supported properly.
66 +--------------------+------------+
70 | Button +------------+
73 +--------------------+............|
74 | Thumb/Button Area | 15%
75 +---------------------------------+
79 .It Va Two finger scrolling
80 Use two fingers for Z axis scrolling.
81 .It Va Button down/second finger
82 While one finger clicks and holds down the touchpad, the second finger can be
83 used to move the mouse cursor.
84 This can be useful for drawing or selecting text.
85 .It Va Thumb/Button area
86 The lower 15% of the trackpad will not affect the mouse cursor position.
87 This allows for high precision clicking, by controlling the cursor with the
88 index finger and pushing/holding the pad down with the thumb.
89 .It Va Trackpad button
91 The left two thirds of the pad issues a LEFT button event.
92 The upper right corner issues a MIDDLE button event.
93 The lower right corner issues a RIGHT button.
94 Optionally, tap to click can be enabled (see below).
99 these values are configurable for
101 .Bl -tag -width "hint.cyapa.%d.addr"
102 .It Va hint.cyapa.%d.at
105 .It Va hint.cyapa.%d.addr
113 variables are available:
115 .It Va debug.cyapa_idle_freq
116 Scan frequency in idle mode, the default is 1.
117 .It Va debug.cyapa_slow_freq
118 Scan frequency in slow mode, the default is 20.
119 .It Va debug.cyapa_norm_freq
120 Scan frequency in normal mode, the default is 100.
121 .It Va debug.cyapa_minpressure
122 Minimum pressure to detect a finger, the default is 12.
123 .It Va debug.cyapa_enable_tapclick
124 Controls tap to click.
128 Tap to click is disabled.
129 This is the default value.
131 Tap to click always generates a left mouse button event.
133 Tap to click generates left mouse button event if the left 2/3rds of the pad
134 are tapped and a right mouse button event otherwise.
136 Tap to click generates mouse button events as if the physical button was
141 .It Va debug.cyapa_tapclick_min_ticks
142 Minimum tap duration in ticks to create a click, the default is 1.
143 .It Va debug.cyapa_tapclick_max_ticks
144 Maximum tap duration in ticks to create a click, the default is 8.
145 .It Va debug.cyapa_move_min_ticks
146 Minimum ticks before cursor movement occurs, the default is 4.
147 .It Va debug.cyapa_scroll_wait_ticks
148 Ticks to wait before starting to scroll, the default is 0.
149 .It Va debug.cyapa_scroll_stick_ticks
150 Ticks while preventing cursor movement on single finger after scroll,
152 .It Va debug.cyapa_thumbarea_percent
153 Size of bottom thumb area in percent, the default is 15.
154 .It Va debug.cyapa_debug
155 Setting this to a non-zero value enables debug output to console and syslog,
157 .It Va debug.cyapa_reset
158 Setting this to a non-zero value reinitializes the device.
159 The sysctl resets to zero immediately.
165 which presents the mouse as an
166 .Ar IntelliMouse PS/2
170 levels 0 through 2, level 1 is used by default.
176 add the following lines to the
180 .Dl moused_enable="YES"
181 .Dl moused_port="/dev/cyapa0"
183 If vertical scrolling is not desired, add
185 .Dl moused_flags="-l0"
190 Enable tap to click for the left and the right mouse button and
191 disable the thumb area by adding these lines to the
195 .Dl debug.cyapa_thumbarea_percent=0
196 .Dl debug.cyapa_enable_tapclick=2
206 driver was written for DragonFly BSD by
209 It has been ported, modified, and enhanced for
212 .An Michael Gmelin Aq Mt freebsd@grem.de .
214 This manual page was written by
215 .An Michael Gmelin Aq Mt freebsd@grem.de .
219 driver detects the device from the I2C address.
220 This might have unforeseen consequences if the initialization sequence
221 is sent to an unknown device at that address.