synaptics.c revision 1.65 1 /* $NetBSD: synaptics.c,v 1.65 2020/04/27 22:31:47 jmcneill Exp $ */
2
3 /*
4 * Copyright (c) 2005, Steve C. Woodford
5 * Copyright (c) 2004, Ales Krenek
6 * Copyright (c) 2004, Kentaro A. Kurahone
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * * Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following
17 * disclaimer in the documentation and/or other materials provided
18 * with the distribution.
19 * * Neither the name of the authors nor the names of its
20 * contributors may be used to endorse or promote products derived
21 * from this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 *
36 */
37
38 /*
39 * TODO:
40 * - Make the sysctl values per-instance instead of global.
41 * - Consider setting initial scaling factors at runtime according
42 * to the values returned by the 'Read Resolutions' command.
43 * - Support the serial protocol (we only support PS/2 for now)
44 * - Support auto-repeat for up/down button Z-axis emulation.
45 * - Maybe add some more gestures (can we use Palm support somehow?)
46 */
47
48 #include "opt_pms.h"
49
50 #include <sys/cdefs.h>
51 __KERNEL_RCSID(0, "$NetBSD: synaptics.c,v 1.65 2020/04/27 22:31:47 jmcneill Exp $");
52
53 #include <sys/param.h>
54 #include <sys/systm.h>
55 #include <sys/device.h>
56 #include <sys/ioctl.h>
57 #include <sys/sysctl.h>
58 #include <sys/kernel.h>
59 #include <sys/proc.h>
60
61 #include <sys/bus.h>
62
63 #include <dev/pckbport/pckbportvar.h>
64
65 #include <dev/pckbport/synapticsreg.h>
66 #include <dev/pckbport/synapticsvar.h>
67
68 #include <dev/pckbport/pmsreg.h>
69 #include <dev/pckbport/pmsvar.h>
70
71 #include <dev/wscons/wsconsio.h>
72 #include <dev/wscons/wsmousevar.h>
73
74 /*
75 * Absolute-mode packets are decoded and passed around using
76 * the following structure.
77 */
78 struct synaptics_packet {
79 signed short sp_x; /* Unscaled absolute X/Y coordinates */
80 signed short sp_y;
81 u_char sp_z; /* Z (pressure) */
82 u_char sp_w; /* W (contact patch width) */
83 signed short sp_sx; /* Secondary finger unscaled absolute */
84 /* X/Y coordinates */
85 signed short sp_xy;
86 u_char sp_finger; /* 0 for primary, 1 for secondary */
87 char sp_left; /* Left mouse button status */
88 char sp_right; /* Right mouse button status */
89 char sp_middle; /* Middle button status (possibly emulated) */
90 char sp_up; /* Up button status */
91 char sp_down; /* Down button status */
92 };
93
94 static void pms_synaptics_input(void *, int);
95 static void pms_synaptics_process_packet(struct pms_softc *,
96 struct synaptics_packet *);
97 static void pms_sysctl_synaptics(struct sysctllog **);
98 static int pms_sysctl_synaptics_verify(SYSCTLFN_ARGS);
99
100 /* Controlled by sysctl. */
101 static int synaptics_up_down_emul = 3;
102 static int synaptics_up_down_motion_delta = 1;
103 static int synaptics_gesture_move = 200;
104 static int synaptics_gesture_length = 20;
105 static int synaptics_edge_left = SYNAPTICS_EDGE_LEFT;
106 static int synaptics_edge_right = SYNAPTICS_EDGE_RIGHT;
107 static int synaptics_edge_top = SYNAPTICS_EDGE_TOP;
108 static int synaptics_edge_bottom = SYNAPTICS_EDGE_BOTTOM;
109 static int synaptics_edge_motion_delta = 32;
110 static u_int synaptics_finger_high = SYNAPTICS_FINGER_LIGHT + 5;
111 static u_int synaptics_finger_low = SYNAPTICS_FINGER_LIGHT - 10;
112 static int synaptics_button_boundary = SYNAPTICS_EDGE_BOTTOM + 720;
113 static int synaptics_button2 = SYNAPTICS_EDGE_LEFT + (SYNAPTICS_EDGE_RIGHT - SYNAPTICS_EDGE_LEFT) / 3;
114 static int synaptics_button3 = SYNAPTICS_EDGE_LEFT + 2 * (SYNAPTICS_EDGE_RIGHT - SYNAPTICS_EDGE_LEFT) / 3;
115 static int synaptics_two_fingers_emul = 0;
116 static int synaptics_scale_x = 16;
117 static int synaptics_scale_y = 16;
118 static int synaptics_scale_z = 32;
119 static int synaptics_max_speed_x = 32;
120 static int synaptics_max_speed_y = 32;
121 static int synaptics_max_speed_z = 2;
122 static int synaptics_movement_threshold = 4;
123 static int synaptics_fscroll_min = 13;
124 static int synaptics_fscroll_max = 14;
125 static int synaptics_dz_hold = 30;
126 static int synaptics_movement_enable = 1;
127
128 /* Sysctl nodes. */
129 static int synaptics_button_boundary_nodenum;
130 static int synaptics_button2_nodenum;
131 static int synaptics_button3_nodenum;
132 static int synaptics_up_down_emul_nodenum;
133 static int synaptics_up_down_motion_delta_nodenum;
134 static int synaptics_gesture_move_nodenum;
135 static int synaptics_gesture_length_nodenum;
136 static int synaptics_edge_left_nodenum;
137 static int synaptics_edge_right_nodenum;
138 static int synaptics_edge_top_nodenum;
139 static int synaptics_edge_bottom_nodenum;
140 static int synaptics_edge_motion_delta_nodenum;
141 static int synaptics_finger_high_nodenum;
142 static int synaptics_finger_low_nodenum;
143 static int synaptics_two_fingers_emul_nodenum;
144 static int synaptics_scale_x_nodenum;
145 static int synaptics_scale_y_nodenum;
146 static int synaptics_scale_z_nodenum;
147 static int synaptics_max_speed_x_nodenum;
148 static int synaptics_max_speed_y_nodenum;
149 static int synaptics_max_speed_z_nodenum;
150 static int synaptics_movement_threshold_nodenum;
151 static int synaptics_finger_scroll_min_nodenum;
152 static int synaptics_finger_scroll_max_nodenum;
153 static int synaptics_dz_hold_nodenum;
154 static int synaptics_movement_enable_nodenum;
155
156 static int
157 synaptics_poll_cmd(struct pms_softc *psc, ...)
158 {
159 u_char cmd[4];
160 size_t i;
161 va_list ap;
162
163 va_start(ap, psc);
164
165 for (i = 0; i < __arraycount(cmd); i++)
166 if ((cmd[i] = (u_char)va_arg(ap, int)) == 0)
167 break;
168 va_end(ap);
169
170 int res = pckbport_poll_cmd(psc->sc_kbctag, psc->sc_kbcslot, cmd, i, 0,
171 NULL, 0);
172 if (res)
173 aprint_error_dev(psc->sc_dev, "command error %#x\n", cmd[0]);
174 return res;
175 }
176
177 static int
178 synaptics_poll_reset(struct pms_softc *psc)
179 {
180 u_char resp[2];
181 int res;
182
183 u_char cmd[1] = { PMS_RESET };
184 res = pckbport_poll_cmd(psc->sc_kbctag, psc->sc_kbcslot, cmd, 1, 2,
185 resp, 1);
186 aprint_debug_dev(psc->sc_dev, "reset %d 0x%02x 0x%02x\n",
187 res, resp[0], resp[1]);
188 return res;
189 }
190
191 static int
192 synaptics_special_read(struct pms_softc *psc, u_char slice, u_char resp[3])
193 {
194 u_char cmd[1] = { PMS_SEND_DEV_STATUS };
195 int res = pms_sliced_command(psc->sc_kbctag, psc->sc_kbcslot, slice);
196
197 return res | pckbport_poll_cmd(psc->sc_kbctag, psc->sc_kbcslot,
198 cmd, 1, 3, resp, 0);
199 }
200
201 static int
202 synaptics_special_write(struct pms_softc *psc, u_char command, u_char arg)
203 {
204 int res = pms_sliced_command(psc->sc_kbctag, psc->sc_kbcslot, arg);
205 if (res)
206 return res;
207
208 u_char cmd[2];
209 cmd[0] = PMS_SET_SAMPLE;
210 cmd[1] = command;
211 res = pckbport_poll_cmd(psc->sc_kbctag, psc->sc_kbcslot,
212 cmd, 2, 0, NULL, 0);
213 return res;
214 }
215
216 static void
217 pms_synaptics_probe_extended(struct pms_softc *psc)
218 {
219 struct synaptics_softc *sc = &psc->u.synaptics;
220 u_char resp[3];
221 int res;
222
223 aprint_debug_dev(psc->sc_dev,
224 "synaptics_probe: Capabilities 0x%04x.\n", sc->caps);
225 if (sc->caps & SYNAPTICS_CAP_PASSTHROUGH)
226 sc->flags |= SYN_FLAG_HAS_PASSTHROUGH;
227
228 if (sc->caps & SYNAPTICS_CAP_PALMDETECT)
229 sc->flags |= SYN_FLAG_HAS_PALM_DETECT;
230
231 if (sc->caps & SYNAPTICS_CAP_MULTIDETECT)
232 sc->flags |= SYN_FLAG_HAS_MULTI_FINGER;
233
234 if (sc->caps & SYNAPTICS_CAP_MULTIFINGERREPORT)
235 sc->flags |= SYN_FLAG_HAS_MULTI_FINGER_REPORT;
236
237 /* Ask about extra buttons to detect up/down. */
238 if (((sc->caps & SYNAPTICS_CAP_EXTNUM) + 0x08)
239 >= SYNAPTICS_EXTENDED_QUERY)
240 {
241 res = synaptics_special_read(psc, SYNAPTICS_EXTENDED_QUERY, resp);
242 if (res == 0) {
243 int buttons = (resp[1] >> 4);
244 aprint_debug_dev(psc->sc_dev,
245 "%s: Extended Buttons: %d.\n", __func__, buttons);
246
247 aprint_debug_dev(psc->sc_dev, "%s: Extended "
248 "Capabilities: 0x%02x 0x%02x 0x%02x.\n", __func__,
249 resp[0], resp[1], resp[2]);
250 if (buttons >= 2) {
251 /* Yes. */
252 sc->flags |= SYN_FLAG_HAS_UP_DOWN_BUTTONS;
253 }
254 if (resp[0] & 0x1) {
255 /* Vertical scroll area */
256 sc->flags |= SYN_FLAG_HAS_VERTICAL_SCROLL;
257 }
258 if (resp[0] & 0x2) {
259 /* Horizontal scroll area */
260 sc->flags |= SYN_FLAG_HAS_HORIZONTAL_SCROLL;
261 }
262 if (resp[0] & 0x4) {
263 /* Extended W-Mode */
264 sc->flags |= SYN_FLAG_HAS_EXTENDED_WMODE;
265 }
266 }
267 }
268
269 /* Ask about click pad */
270 if (((sc->caps & SYNAPTICS_CAP_EXTNUM) + 0x08) >=
271 SYNAPTICS_CONTINUED_CAPABILITIES)
272 {
273 res = synaptics_special_read(psc,
274 SYNAPTICS_CONTINUED_CAPABILITIES, resp);
275
276 /*
277 * The following describes response for the
278 * SYNAPTICS_CONTINUED_CAPABILITIES query.
279 *
280 * byte mask name meaning
281 * ---- ---- ------- ------------
282 * 0 0x01 adjustable threshold capacitive button sensitivity
283 * can be adjusted
284 * 0 0x02 report max query 0x0d gives max coord reported
285 * 0 0x04 clearpad sensor is ClearPad product
286 * 0 0x08 advanced gesture not particularly meaningful
287 * 0 0x10 clickpad bit 0 1-button ClickPad
288 * 0 0x60 multifinger mode identifies firmware finger counting
289 * (not reporting!) algorithm.
290 * Not particularly meaningful
291 * 0 0x80 covered pad W clipped to 14, 15 == pad mostly covered
292 * 1 0x01 clickpad bit 1 2-button ClickPad
293 * 1 0x02 deluxe LED controls touchpad support LED commands
294 * ala multimedia control bar
295 * 1 0x04 reduced filtering firmware does less filtering on
296 * position data, driver should watch
297 * for noise.
298 * 1 0x08 image sensor image sensor tracks 5 fingers, but only
299 * reports 2.
300 * 1 0x10 uniform clickpad whole clickpad moves instead of being
301 * hinged at the top.
302 * 1 0x20 report min query 0x0f gives min coord reported
303 */
304 if (res == 0) {
305 uint val = SYN_CCAP_VALUE(resp);
306
307 aprint_debug_dev(psc->sc_dev, "%s: Continued "
308 "Capabilities 0x%02x 0x%02x 0x%02x.\n", __func__,
309 resp[0], resp[1], resp[2]);
310 switch (SYN_CCAP_CLICKPAD_TYPE(val)) {
311 case 0: /* not a clickpad */
312 break;
313 case 1:
314 sc->flags |= SYN_FLAG_HAS_ONE_BUTTON_CLICKPAD;
315 break;
316 case 2:
317 sc->flags |= SYN_FLAG_HAS_TWO_BUTTON_CLICKPAD;
318 break;
319 case 3: /* reserved */
320 default:
321 /* unreached */
322 break;
323 }
324
325 if ((val & SYN_CCAP_HAS_ADV_GESTURE_MODE))
326 sc->flags |= SYN_FLAG_HAS_ADV_GESTURE_MODE;
327 }
328 }
329 }
330
331 static const struct {
332 int bit;
333 const char *desc;
334 } syn_flags[] = {
335 { SYN_FLAG_HAS_EXTENDED_WMODE, "Extended W mode", },
336 { SYN_FLAG_HAS_PASSTHROUGH, "Passthrough", },
337 { SYN_FLAG_HAS_MIDDLE_BUTTON, "Middle button", },
338 { SYN_FLAG_HAS_BUTTONS_4_5, "Buttons 4/5", },
339 { SYN_FLAG_HAS_UP_DOWN_BUTTONS, "Up/down buttons", },
340 { SYN_FLAG_HAS_PALM_DETECT, "Palm detect", },
341 { SYN_FLAG_HAS_ONE_BUTTON_CLICKPAD, "One button click pad", },
342 { SYN_FLAG_HAS_TWO_BUTTON_CLICKPAD, "Two button click pad", },
343 { SYN_FLAG_HAS_VERTICAL_SCROLL, "Vertical scroll", },
344 { SYN_FLAG_HAS_HORIZONTAL_SCROLL, "Horizontal scroll", },
345 { SYN_FLAG_HAS_MULTI_FINGER_REPORT, "Multi-finger Report", },
346 { SYN_FLAG_HAS_MULTI_FINGER, "Multi-finger", },
347 };
348
349 int
350 pms_synaptics_probe_init(void *vsc)
351 {
352 struct pms_softc *psc = vsc;
353 struct synaptics_softc *sc = &psc->u.synaptics;
354 u_char cmd[1], resp[3];
355 int res, ver_minor, ver_major;
356 struct sysctllog *clog = NULL;
357
358 res = pms_sliced_command(psc->sc_kbctag, psc->sc_kbcslot,
359 SYNAPTICS_IDENTIFY_TOUCHPAD);
360 cmd[0] = PMS_SEND_DEV_STATUS;
361 res |= pckbport_poll_cmd(psc->sc_kbctag, psc->sc_kbcslot, cmd, 1, 3,
362 resp, 0);
363 if (res) {
364 aprint_debug_dev(psc->sc_dev,
365 "synaptics_probe: Identify Touchpad error.\n");
366 /*
367 * Reset device in case the probe confused it.
368 */
369 doreset:
370 (void)synaptics_poll_reset(psc);
371 return res;
372 }
373
374 if (resp[1] != SYNAPTICS_MAGIC_BYTE) {
375 aprint_debug_dev(psc->sc_dev,
376 "synaptics_probe: Not synaptics.\n");
377 res = 1;
378 goto doreset;
379 }
380
381 sc->flags = 0;
382
383 /* Check for minimum version and print a nice message. */
384 ver_major = resp[2] & 0x0f;
385 ver_minor = resp[0];
386 aprint_normal_dev(psc->sc_dev, "Synaptics touchpad version %d.%d\n",
387 ver_major, ver_minor);
388 if (ver_major * 10 + ver_minor < SYNAPTICS_MIN_VERSION) {
389 /* No capability query support. */
390 sc->caps = 0;
391 goto done;
392 }
393
394
395 /* Query the hardware capabilities. */
396 res = synaptics_special_read(psc, SYNAPTICS_READ_CAPABILITIES, resp);
397 if (res) {
398 /* Hmm, failed to get capabilites. */
399 aprint_error_dev(psc->sc_dev,
400 "synaptics_probe: Failed to query capabilities.\n");
401 goto doreset;
402 }
403
404 sc->caps = SYNAPTICS_CAP_VALUE(resp);
405
406 if (sc->caps & SYNAPTICS_CAP_MBUTTON)
407 sc->flags |= SYN_FLAG_HAS_MIDDLE_BUTTON;
408
409 if (sc->caps & SYNAPTICS_CAP_4BUTTON)
410 sc->flags |= SYN_FLAG_HAS_BUTTONS_4_5;
411
412 if (sc->caps & SYNAPTICS_CAP_EXTENDED) {
413 pms_synaptics_probe_extended(psc);
414 }
415
416 if (sc->flags) {
417 const char comma[] = ", ";
418 const char *sep = "";
419 aprint_normal_dev(psc->sc_dev, "");
420 for (size_t f = 0; f < __arraycount(syn_flags); f++) {
421 if (sc->flags & syn_flags[f].bit) {
422 aprint_normal("%s%s", sep, syn_flags[f].desc);
423 sep = comma;
424 }
425 }
426 aprint_normal("\n");
427 }
428
429 done:
430 pms_sysctl_synaptics(&clog);
431 pckbport_set_inputhandler(psc->sc_kbctag, psc->sc_kbcslot,
432 pms_synaptics_input, psc, device_xname(psc->sc_dev));
433
434 return (0);
435 }
436
437 void
438 pms_synaptics_enable(void *vsc)
439 {
440 struct pms_softc *psc = vsc;
441 struct synaptics_softc *sc = &psc->u.synaptics;
442 u_char enable_modes;
443 int res, i;
444
445 if (sc->flags & SYN_FLAG_HAS_PASSTHROUGH) {
446 /*
447 * Extended capability probes can confuse the passthrough
448 * device; reset the touchpad now to cure that.
449 */
450 res = synaptics_poll_reset(psc);
451 }
452
453 /*
454 * Enable Absolute mode with W (width) reporting, and set
455 * the packet rate to maximum (80 packets per second). Enable
456 * extended W mode if supported so we can report second finger
457 * position.
458 */
459 enable_modes =
460 SYNAPTICS_MODE_ABSOLUTE | SYNAPTICS_MODE_W | SYNAPTICS_MODE_RATE;
461
462 if (sc->flags & SYN_FLAG_HAS_EXTENDED_WMODE)
463 enable_modes |= SYNAPTICS_MODE_EXTENDED_W;
464
465 /*
466 * Synaptics documentation says to disable device before
467 * setting mode.
468 */
469 synaptics_poll_cmd(psc, PMS_DEV_DISABLE, 0);
470 /* a couple of set scales to clear out pending commands */
471 for (i = 0; i < 2; i++)
472 synaptics_poll_cmd(psc, PMS_SET_SCALE11, 0);
473
474 res = synaptics_special_write(psc, SYNAPTICS_CMD_SET_MODE2, enable_modes);
475 if (res)
476 aprint_error("synaptics: set mode error\n");
477
478 /* a couple of set scales to clear out pending commands */
479 for (i = 0; i < 2; i++)
480 synaptics_poll_cmd(psc, PMS_SET_SCALE11, 0);
481
482 /* Set advanced gesture mode */
483 if ((sc->flags & SYN_FLAG_HAS_EXTENDED_WMODE) ||
484 (sc->flags & SYN_FLAG_HAS_ADV_GESTURE_MODE))
485 synaptics_special_write(psc, SYNAPTICS_WRITE_DELUXE_3, 0x3);
486
487 synaptics_poll_cmd(psc, PMS_DEV_ENABLE, 0);
488
489 sc->up_down = 0;
490 sc->prev_fingers = 0;
491 sc->gesture_start_x = sc->gesture_start_y = 0;
492 sc->gesture_start_packet = 0;
493 sc->gesture_tap_packet = 0;
494 sc->gesture_type = 0;
495 sc->gesture_buttons = 0;
496 sc->dz_hold = 0;
497 for (i = 0; i < SYN_MAX_FINGERS; i++) {
498 sc->rem_x[i] = sc->rem_y[i] = sc->rem_z[i] = 0;
499 sc->movement_history[i] = 0;
500 }
501 sc->button_history = 0;
502 }
503
504 void
505 pms_synaptics_resume(void *vsc)
506 {
507 (void)synaptics_poll_reset(vsc);
508 }
509
510 static void
511 pms_sysctl_synaptics(struct sysctllog **clog)
512 {
513 int rc, root_num;
514 const struct sysctlnode *node;
515
516 if ((rc = sysctl_createv(clog, 0, NULL, &node,
517 CTLFLAG_PERMANENT, CTLTYPE_NODE, "synaptics",
518 SYSCTL_DESCR("Synaptics touchpad controls"),
519 NULL, 0, NULL, 0, CTL_HW, CTL_CREATE, CTL_EOL)) != 0)
520 goto err;
521
522 root_num = node->sysctl_num;
523
524 if ((rc = sysctl_createv(clog, 0, NULL, &node,
525 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
526 CTLTYPE_INT, "up_down_emulation",
527 SYSCTL_DESCR("Middle button/Z-axis emulation with up/down buttons"),
528 pms_sysctl_synaptics_verify, 0,
529 &synaptics_up_down_emul,
530 0, CTL_HW, root_num, CTL_CREATE,
531 CTL_EOL)) != 0)
532 goto err;
533
534 synaptics_up_down_emul_nodenum = node->sysctl_num;
535
536 if ((rc = sysctl_createv(clog, 0, NULL, &node,
537 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
538 CTLTYPE_INT, "up_down_motion_delta",
539 SYSCTL_DESCR("Up/down button Z-axis emulation rate"),
540 pms_sysctl_synaptics_verify, 0,
541 &synaptics_up_down_motion_delta,
542 0, CTL_HW, root_num, CTL_CREATE,
543 CTL_EOL)) != 0)
544 goto err;
545
546 synaptics_up_down_motion_delta_nodenum = node->sysctl_num;
547
548 if ((rc = sysctl_createv(clog, 0, NULL, &node,
549 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
550 CTLTYPE_INT, "gesture_move",
551 SYSCTL_DESCR("Movement greater than this between taps cancels gesture"),
552 pms_sysctl_synaptics_verify, 0,
553 &synaptics_gesture_move,
554 0, CTL_HW, root_num, CTL_CREATE,
555 CTL_EOL)) != 0)
556 goto err;
557
558 synaptics_gesture_move_nodenum = node->sysctl_num;
559
560 if ((rc = sysctl_createv(clog, 0, NULL, &node,
561 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
562 CTLTYPE_INT, "gesture_length",
563 SYSCTL_DESCR("Time period in which tap is recognised as a gesture"),
564 pms_sysctl_synaptics_verify, 0,
565 &synaptics_gesture_length,
566 0, CTL_HW, root_num, CTL_CREATE,
567 CTL_EOL)) != 0)
568 goto err;
569
570 synaptics_gesture_length_nodenum = node->sysctl_num;
571
572 if ((rc = sysctl_createv(clog, 0, NULL, &node,
573 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
574 CTLTYPE_INT, "edge_left",
575 SYSCTL_DESCR("Define left edge of touchpad"),
576 pms_sysctl_synaptics_verify, 0,
577 &synaptics_edge_left,
578 0, CTL_HW, root_num, CTL_CREATE,
579 CTL_EOL)) != 0)
580 goto err;
581
582 synaptics_edge_left_nodenum = node->sysctl_num;
583
584 if ((rc = sysctl_createv(clog, 0, NULL, &node,
585 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
586 CTLTYPE_INT, "edge_right",
587 SYSCTL_DESCR("Define right edge of touchpad"),
588 pms_sysctl_synaptics_verify, 0,
589 &synaptics_edge_right,
590 0, CTL_HW, root_num, CTL_CREATE,
591 CTL_EOL)) != 0)
592 goto err;
593
594 synaptics_edge_right_nodenum = node->sysctl_num;
595
596 if ((rc = sysctl_createv(clog, 0, NULL, &node,
597 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
598 CTLTYPE_INT, "edge_top",
599 SYSCTL_DESCR("Define top edge of touchpad"),
600 pms_sysctl_synaptics_verify, 0,
601 &synaptics_edge_top,
602 0, CTL_HW, root_num, CTL_CREATE,
603 CTL_EOL)) != 0)
604 goto err;
605
606 synaptics_edge_top_nodenum = node->sysctl_num;
607
608 if ((rc = sysctl_createv(clog, 0, NULL, &node,
609 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
610 CTLTYPE_INT, "edge_bottom",
611 SYSCTL_DESCR("Define bottom edge of touchpad"),
612 pms_sysctl_synaptics_verify, 0,
613 &synaptics_edge_bottom,
614 0, CTL_HW, root_num, CTL_CREATE,
615 CTL_EOL)) != 0)
616 goto err;
617
618 synaptics_edge_bottom_nodenum = node->sysctl_num;
619
620 if ((rc = sysctl_createv(clog, 0, NULL, &node,
621 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
622 CTLTYPE_INT, "edge_motion_delta",
623 SYSCTL_DESCR("Define edge motion rate"),
624 pms_sysctl_synaptics_verify, 0,
625 &synaptics_edge_motion_delta,
626 0, CTL_HW, root_num, CTL_CREATE,
627 CTL_EOL)) != 0)
628 goto err;
629
630 synaptics_edge_motion_delta_nodenum = node->sysctl_num;
631
632 if ((rc = sysctl_createv(clog, 0, NULL, &node,
633 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
634 CTLTYPE_INT, "finger_high",
635 SYSCTL_DESCR("Define finger applied pressure threshold"),
636 pms_sysctl_synaptics_verify, 0,
637 &synaptics_finger_high,
638 0, CTL_HW, root_num, CTL_CREATE,
639 CTL_EOL)) != 0)
640 goto err;
641
642 synaptics_finger_high_nodenum = node->sysctl_num;
643
644 if ((rc = sysctl_createv(clog, 0, NULL, &node,
645 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
646 CTLTYPE_INT, "finger_low",
647 SYSCTL_DESCR("Define finger removed pressure threshold"),
648 pms_sysctl_synaptics_verify, 0,
649 &synaptics_finger_low,
650 0, CTL_HW, root_num, CTL_CREATE,
651 CTL_EOL)) != 0)
652 goto err;
653
654 synaptics_finger_low_nodenum = node->sysctl_num;
655
656 if ((rc = sysctl_createv(clog, 0, NULL, &node,
657 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
658 CTLTYPE_INT, "two_fingers_emulation",
659 SYSCTL_DESCR("Map two fingers to middle button"),
660 pms_sysctl_synaptics_verify, 0,
661 &synaptics_two_fingers_emul,
662 0, CTL_HW, root_num, CTL_CREATE,
663 CTL_EOL)) != 0)
664 goto err;
665
666 synaptics_two_fingers_emul_nodenum = node->sysctl_num;
667
668 if ((rc = sysctl_createv(clog, 0, NULL, &node,
669 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
670 CTLTYPE_INT, "scale_x",
671 SYSCTL_DESCR("Horizontal movement scale factor"),
672 pms_sysctl_synaptics_verify, 0,
673 &synaptics_scale_x,
674 0, CTL_HW, root_num, CTL_CREATE,
675 CTL_EOL)) != 0)
676 goto err;
677
678 synaptics_scale_x_nodenum = node->sysctl_num;
679
680 if ((rc = sysctl_createv(clog, 0, NULL, &node,
681 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
682 CTLTYPE_INT, "scale_y",
683 SYSCTL_DESCR("Vertical movement scale factor"),
684 pms_sysctl_synaptics_verify, 0,
685 &synaptics_scale_y,
686 0, CTL_HW, root_num, CTL_CREATE,
687 CTL_EOL)) != 0)
688 goto err;
689
690 synaptics_scale_y_nodenum = node->sysctl_num;
691
692 if ((rc = sysctl_createv(clog, 0, NULL, &node,
693 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
694 CTLTYPE_INT, "scale_z",
695 SYSCTL_DESCR("Sroll wheel emulation scale factor"),
696 pms_sysctl_synaptics_verify, 0,
697 &synaptics_scale_z,
698 0, CTL_HW, root_num, CTL_CREATE,
699 CTL_EOL)) != 0)
700 goto err;
701
702 synaptics_scale_z_nodenum = node->sysctl_num;
703
704 if ((rc = sysctl_createv(clog, 0, NULL, &node,
705 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
706 CTLTYPE_INT, "max_speed_x",
707 SYSCTL_DESCR("Horizontal movement maximum speed"),
708 pms_sysctl_synaptics_verify, 0,
709 &synaptics_max_speed_x,
710 0, CTL_HW, root_num, CTL_CREATE,
711 CTL_EOL)) != 0)
712 goto err;
713
714 synaptics_max_speed_x_nodenum = node->sysctl_num;
715
716 if ((rc = sysctl_createv(clog, 0, NULL, &node,
717 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
718 CTLTYPE_INT, "max_speed_y",
719 SYSCTL_DESCR("Vertical movement maximum speed"),
720 pms_sysctl_synaptics_verify, 0,
721 &synaptics_max_speed_y,
722 0, CTL_HW, root_num, CTL_CREATE,
723 CTL_EOL)) != 0)
724 goto err;
725
726 synaptics_max_speed_y_nodenum = node->sysctl_num;
727
728 if ((rc = sysctl_createv(clog, 0, NULL, &node,
729 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
730 CTLTYPE_INT, "max_speed_z",
731 SYSCTL_DESCR("Scroll wheel emulation maximum speed"),
732 pms_sysctl_synaptics_verify, 0,
733 &synaptics_max_speed_z,
734 0, CTL_HW, root_num, CTL_CREATE,
735 CTL_EOL)) != 0)
736 goto err;
737
738 synaptics_max_speed_z_nodenum = node->sysctl_num;
739
740 if ((rc = sysctl_createv(clog, 0, NULL, &node,
741 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
742 CTLTYPE_INT, "movement_threshold",
743 SYSCTL_DESCR("Minimum reported movement threshold"),
744 pms_sysctl_synaptics_verify, 0,
745 &synaptics_movement_threshold,
746 0, CTL_HW, root_num, CTL_CREATE,
747 CTL_EOL)) != 0)
748 goto err;
749
750 synaptics_movement_threshold_nodenum = node->sysctl_num;
751
752 if ((rc = sysctl_createv(clog, 0, NULL, &node,
753 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
754 CTLTYPE_INT, "movement_enable",
755 SYSCTL_DESCR("Enable movement reporting"),
756 pms_sysctl_synaptics_verify, 0,
757 &synaptics_movement_enable,
758 0, CTL_HW, root_num, CTL_CREATE,
759 CTL_EOL)) != 0)
760 goto err;
761
762 synaptics_movement_enable_nodenum = node->sysctl_num;
763
764 if ((rc = sysctl_createv(clog, 0, NULL, &node,
765 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
766 CTLTYPE_INT, "button_boundary",
767 SYSCTL_DESCR("Top edge of button area"),
768 pms_sysctl_synaptics_verify, 0,
769 &synaptics_button_boundary,
770 0, CTL_HW, root_num, CTL_CREATE,
771 CTL_EOL)) != 0)
772 goto err;
773
774 synaptics_button_boundary_nodenum = node->sysctl_num;
775
776 if ((rc = sysctl_createv(clog, 0, NULL, &node,
777 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
778 CTLTYPE_INT, "button2_edge",
779 SYSCTL_DESCR("Left edge of button 2 region"),
780 pms_sysctl_synaptics_verify, 0,
781 &synaptics_button2,
782 0, CTL_HW, root_num, CTL_CREATE,
783 CTL_EOL)) != 0)
784 goto err;
785
786 synaptics_button2_nodenum = node->sysctl_num;
787
788 if ((rc = sysctl_createv(clog, 0, NULL, &node,
789 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
790 CTLTYPE_INT, "button3_edge",
791 SYSCTL_DESCR("Left edge of button 3 region"),
792 pms_sysctl_synaptics_verify, 0,
793 &synaptics_button3,
794 0, CTL_HW, root_num, CTL_CREATE,
795 CTL_EOL)) != 0)
796 goto err;
797
798 synaptics_button3_nodenum = node->sysctl_num;
799
800 if ((rc = sysctl_createv(clog, 0, NULL, &node,
801 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
802 CTLTYPE_INT, "finger_scroll-min",
803 SYSCTL_DESCR("Minimum width at which y cursor movements will be converted to scroll wheel events"),
804 pms_sysctl_synaptics_verify, 0,
805 &synaptics_fscroll_min,
806 0, CTL_HW, root_num, CTL_CREATE,
807 CTL_EOL)) != 0)
808 goto err;
809
810 synaptics_finger_scroll_min_nodenum = node->sysctl_num;
811
812 if ((rc = sysctl_createv(clog, 0, NULL, &node,
813 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
814 CTLTYPE_INT, "finger_scroll-max",
815 SYSCTL_DESCR("Maximum width at which y cursor movements will be converted to scroll wheel events"),
816 pms_sysctl_synaptics_verify, 0,
817 &synaptics_fscroll_max,
818 0, CTL_HW, root_num, CTL_CREATE,
819 CTL_EOL)) != 0)
820 goto err;
821
822 synaptics_finger_scroll_max_nodenum = node->sysctl_num;
823
824 if ((rc = sysctl_createv(clog, 0, NULL, &node,
825 CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
826 CTLTYPE_INT, "finger_scroll-hysteresis",
827 SYSCTL_DESCR("Number of packets to keep reporting y cursor movements as scroll wheel events"),
828 pms_sysctl_synaptics_verify, 0,
829 &synaptics_dz_hold,
830 0, CTL_HW, root_num, CTL_CREATE,
831 CTL_EOL)) != 0)
832 goto err;
833
834 synaptics_dz_hold_nodenum = node->sysctl_num;
835 return;
836
837 err:
838 aprint_error("%s: sysctl_createv failed (rc = %d)\n", __func__, rc);
839 }
840
841 static int
842 pms_sysctl_synaptics_verify(SYSCTLFN_ARGS)
843 {
844 int error, t;
845 struct sysctlnode node;
846
847 node = *rnode;
848 t = *(int *)rnode->sysctl_data;
849 node.sysctl_data = &t;
850 error = sysctl_lookup(SYSCTLFN_CALL(&node));
851 if (error || newp == NULL)
852 return error;
853
854 /* Sanity check the params. */
855 if (node.sysctl_num == synaptics_up_down_emul_nodenum) {
856 if (t < 0 || t > 3)
857 return (EINVAL);
858 } else
859 if (node.sysctl_num == synaptics_two_fingers_emul_nodenum) {
860 if (t < 0 || t > 2)
861 return (EINVAL);
862 } else
863 if (node.sysctl_num == synaptics_gesture_length_nodenum ||
864 node.sysctl_num == synaptics_edge_motion_delta_nodenum ||
865 node.sysctl_num == synaptics_up_down_motion_delta_nodenum ||
866 node.sysctl_num == synaptics_max_speed_x_nodenum ||
867 node.sysctl_num == synaptics_max_speed_y_nodenum ||
868 node.sysctl_num == synaptics_max_speed_z_nodenum) {
869 if (t < 0)
870 return (EINVAL);
871 } else
872 if (node.sysctl_num == synaptics_edge_left_nodenum ||
873 node.sysctl_num == synaptics_edge_bottom_nodenum) {
874 if (t < 0 || t > (SYNAPTICS_EDGE_MAX / 2))
875 return (EINVAL);
876 } else
877 if (node.sysctl_num == synaptics_edge_right_nodenum ||
878 node.sysctl_num == synaptics_edge_top_nodenum) {
879 if (t < (SYNAPTICS_EDGE_MAX / 2))
880 return (EINVAL);
881 } else
882 if (node.sysctl_num == synaptics_scale_x_nodenum ||
883 node.sysctl_num == synaptics_scale_y_nodenum ||
884 node.sysctl_num == synaptics_scale_z_nodenum) {
885 if (t < 1 || t > (SYNAPTICS_EDGE_MAX / 4))
886 return (EINVAL);
887 } else
888 if (node.sysctl_num == synaptics_finger_high_nodenum) {
889 if (t < 0 || t > SYNAPTICS_FINGER_PALM ||
890 t < synaptics_finger_low)
891 return (EINVAL);
892 } else
893 if (node.sysctl_num == synaptics_finger_low_nodenum) {
894 if (t < 0 || t > SYNAPTICS_FINGER_PALM ||
895 t > synaptics_finger_high)
896 return (EINVAL);
897 } else
898 if (node.sysctl_num == synaptics_gesture_move_nodenum ||
899 node.sysctl_num == synaptics_movement_threshold_nodenum) {
900 if (t < 0 || t > (SYNAPTICS_EDGE_MAX / 4))
901 return (EINVAL);
902 } else
903 if (node.sysctl_num == synaptics_button_boundary_nodenum) {
904 if (t < 0 || t < SYNAPTICS_EDGE_BOTTOM ||
905 t > SYNAPTICS_EDGE_TOP)
906 return (EINVAL);
907 } else
908 if (node.sysctl_num == synaptics_button2_nodenum ||
909 node.sysctl_num == synaptics_button3_nodenum) {
910 if (t < SYNAPTICS_EDGE_LEFT || t > SYNAPTICS_EDGE_RIGHT)
911 return (EINVAL);
912 } else
913 if (node.sysctl_num == synaptics_finger_scroll_min_nodenum ||
914 node.sysctl_num == synaptics_finger_scroll_max_nodenum) {
915 /* make sure we avoid the "magic" widths, 4 and below
916 are for fingers, 15 is palm detect. */
917 if ((t < 5) || (t > 14))
918 return (EINVAL);
919 } else
920 if (node.sysctl_num == synaptics_dz_hold_nodenum) {
921 if (t < 0)
922 return (EINVAL);
923 } else
924 if (node.sysctl_num == synaptics_movement_enable_nodenum) {
925 if (t < 0 || t > 1)
926 return (EINVAL);
927 } else
928 return (EINVAL);
929
930 *(int *)rnode->sysctl_data = t;
931
932 return (0);
933 }
934
935 /* Masks for the first byte of a packet */
936 #define PMS_LBUTMASK 0x01
937 #define PMS_RBUTMASK 0x02
938 #define PMS_MBUTMASK 0x04
939
940 static void
941 pms_synaptics_parse(struct pms_softc *psc)
942 {
943 struct synaptics_softc *sc = &psc->u.synaptics;
944 struct synaptics_packet sp;
945 char new_buttons, ew_mode;
946
947 memset(&sp, 0, sizeof(sp));
948
949 /* Width of finger */
950 sp.sp_w = ((psc->packet[0] & 0x30) >> 2) +
951 ((psc->packet[0] & 0x04) >> 1) +
952 ((psc->packet[3] & 0x04) >> 2);
953 sp.sp_finger = 0;
954 if ((sc->flags & SYN_FLAG_HAS_EXTENDED_WMODE) &&
955 (sp.sp_w == SYNAPTICS_WIDTH_EXTENDED_W)) {
956 ew_mode = psc->packet[5] >> 4;
957 switch (ew_mode)
958 {
959 case SYNAPTICS_EW_WHEEL:
960 /* scroll wheel report, ignore for now */
961 aprint_debug_dev(psc->sc_dev, "mouse wheel packet\n");
962 return;
963
964 case SYNAPTICS_EW_SECONDARY_FINGER:
965 /* parse the second finger report */
966
967 sp.sp_finger = 1; /* just one other finger for now */
968 sp.sp_x = psc->packet[1]
969 + ((psc->packet[4] & 0x0f) << 8);
970 sp.sp_y = psc->packet[2]
971 + ((psc->packet[4] & 0xf0) << 4);
972 sp.sp_z = (psc->packet[3] & 0x30)
973 + (psc->packet[5] & 0x0f);
974
975 /* keep same buttons down as primary */
976 sp.sp_left = sc->button_history & PMS_LBUTMASK;
977 sp.sp_middle = sc->button_history & PMS_MBUTMASK;
978 sp.sp_right = sc->button_history & PMS_RBUTMASK;
979 break;
980
981 case SYNAPTICS_EW_FINGER_STATUS:
982 /* reports which finger is primary/secondary
983 * ignore for now.
984 */
985 return;
986
987 default:
988 aprint_error_dev(psc->sc_dev,
989 "invalid extended w mode %d\n",
990 ew_mode);
991 return;
992 }
993 } else {
994
995 /* Absolute X/Y coordinates of finger */
996 sp.sp_x = psc->packet[4] + ((psc->packet[1] & 0x0f) << 8) +
997 ((psc->packet[3] & 0x10) << 8);
998 sp.sp_y = psc->packet[5] + ((psc->packet[1] & 0xf0) << 4) +
999 ((psc->packet[3] & 0x20) << 7);
1000
1001 /* Pressure */
1002 sp.sp_z = psc->packet[2];
1003
1004 if ((psc->packet[0] ^ psc->packet[3]) & 0x02) {
1005 /* extended buttons */
1006
1007 aprint_debug_dev(psc->sc_dev,
1008 "synaptics_parse: %02x %02x %02x %02x %02x %02x\n",
1009 psc->packet[0], psc->packet[1], psc->packet[2],
1010 psc->packet[3], psc->packet[4], psc->packet[5]);
1011
1012 if ((psc->packet[4] & SYN_1BUTMASK) != 0)
1013 sc->ext_left = PMS_LBUTMASK;
1014 else
1015 sc->ext_left = 0;
1016
1017 if ((psc->packet[4] & SYN_3BUTMASK) != 0)
1018 sc->ext_middle = PMS_MBUTMASK;
1019 else
1020 sc->ext_middle = 0;
1021
1022 if ((psc->packet[5] & SYN_2BUTMASK) != 0)
1023 sc->ext_right = PMS_RBUTMASK;
1024 else
1025 sc->ext_right = 0;
1026
1027 if ((psc->packet[5] & SYN_4BUTMASK) != 0)
1028 sc->ext_up = 1;
1029 else
1030 sc->ext_up = 0;
1031
1032 if ((psc->packet[4] & SYN_5BUTMASK) != 0)
1033 sc->ext_down = 1;
1034 else
1035 sc->ext_down = 0;
1036 } else {
1037 /* Left/Right button handling. */
1038 sp.sp_left = psc->packet[0] & PMS_LBUTMASK;
1039 sp.sp_right = psc->packet[0] & PMS_RBUTMASK;
1040 }
1041
1042 /* Up/Down buttons. */
1043 if (sc->flags & SYN_FLAG_HAS_BUTTONS_4_5) {
1044 /* Old up/down buttons. */
1045 sp.sp_up = sp.sp_left ^
1046 (psc->packet[3] & PMS_LBUTMASK);
1047 sp.sp_down = sp.sp_right ^
1048 (psc->packet[3] & PMS_RBUTMASK);
1049 } else if (sc->flags & SYN_FLAG_HAS_UP_DOWN_BUTTONS &&
1050 ((psc->packet[0] & PMS_RBUTMASK) ^
1051 (psc->packet[3] & PMS_RBUTMASK))) {
1052 /* New up/down button. */
1053 sp.sp_up = psc->packet[4] & SYN_1BUTMASK;
1054 sp.sp_down = psc->packet[5] & SYN_2BUTMASK;
1055 } else {
1056 sp.sp_up = 0;
1057 sp.sp_down = 0;
1058 }
1059
1060 new_buttons = 0;
1061 if(sc->flags & SYN_FLAG_HAS_ONE_BUTTON_CLICKPAD) {
1062 /* This is not correctly specified. Read this button press
1063 * from L/U bit. Emulate 3 buttons by checking the
1064 * coordinates of the click and returning the appropriate
1065 * button code. Outside the button region default to a
1066 * left click.
1067 */
1068 u_char bstate = (psc->packet[0] ^ psc->packet[3])
1069 & 0x01;
1070 if (sp.sp_y < synaptics_button_boundary) {
1071 if (sp.sp_x > synaptics_button3) {
1072 sp.sp_right =
1073 bstate ? PMS_RBUTMASK : 0;
1074 } else if (sp.sp_x > synaptics_button2) {
1075 sp.sp_middle =
1076 bstate ? PMS_MBUTMASK : 0;
1077 } else {
1078 sp.sp_left = bstate ? PMS_LBUTMASK : 0;
1079 }
1080 } else
1081 sp.sp_left = bstate ? 1 : 0;
1082 new_buttons = sp.sp_left | sp.sp_middle | sp.sp_right;
1083 if (new_buttons != sc->button_history) {
1084 if (sc->button_history == 0)
1085 sc->button_history = new_buttons;
1086 else if (new_buttons == 0) {
1087 sc->button_history = 0;
1088 /* ensure all buttons are cleared just in
1089 * case finger comes off in a different
1090 * region.
1091 */
1092 sp.sp_left = 0;
1093 sp.sp_middle = 0;
1094 sp.sp_right = 0;
1095 } else {
1096 /* make sure we keep the same button even
1097 * if the finger moves to a different
1098 * region. This precludes chording
1099 * but, oh well.
1100 */
1101 sp.sp_left = sc->button_history & PMS_LBUTMASK;
1102 sp.sp_middle = sc->button_history
1103 & PMS_MBUTMASK;
1104 sp.sp_right = sc->button_history & PMS_RBUTMASK;
1105 }
1106 }
1107 } else if (sc->flags & SYN_FLAG_HAS_MIDDLE_BUTTON) {
1108 /* Old style Middle Button. */
1109 sp.sp_middle = (psc->packet[0] & PMS_LBUTMASK) ^
1110 (psc->packet[3] & PMS_LBUTMASK);
1111 } else if (synaptics_up_down_emul != 1) {
1112 sp.sp_middle = 0;
1113 }
1114
1115 /* Overlay extended button state */
1116 sp.sp_left |= sc->ext_left;
1117 sp.sp_right |= sc->ext_right;
1118 sp.sp_middle |= sc->ext_middle;
1119 sp.sp_up |= sc->ext_up;
1120 sp.sp_down |= sc->ext_down;
1121
1122 switch (synaptics_up_down_emul) {
1123 case 1:
1124 /* Do middle button emulation using up/down buttons */
1125 sp.sp_middle = sp.sp_up | sp.sp_down;
1126 sp.sp_up = sp.sp_down = 0;
1127 break;
1128 case 3:
1129 /* Do left/right button emulation using up/down buttons */
1130 sp.sp_left = sp.sp_left | sp.sp_up;
1131 sp.sp_right = sp.sp_right | sp.sp_down;
1132 sp.sp_up = sp.sp_down = 0;
1133 break;
1134 default:
1135 /*
1136 * Don't do any remapping...
1137 * Z-axis emulation is handled in pms_synaptics_process_packet
1138 */
1139 break;
1140 }
1141 }
1142
1143 pms_synaptics_process_packet(psc, &sp);
1144 }
1145
1146 static void
1147 pms_synaptics_passthrough(struct pms_softc *psc)
1148 {
1149 int dx, dy, dz;
1150 int buttons, changed;
1151 int s;
1152
1153 buttons = ((psc->packet[1] & PMS_LBUTMASK) ? 0x20 : 0) |
1154 ((psc->packet[1] & PMS_MBUTMASK) ? 0x40 : 0) |
1155 ((psc->packet[1] & PMS_RBUTMASK) ? 0x80 : 0);
1156
1157 dx = psc->packet[4];
1158 if (dx >= 128)
1159 dx -= 256;
1160 if (dx == -128)
1161 dx = -127;
1162
1163 dy = psc->packet[5];
1164 if (dy >= 128)
1165 dy -= 256;
1166 if (dy == -128)
1167 dy = -127;
1168
1169 dz = 0;
1170
1171 changed = buttons ^ (psc->buttons & 0xe0);
1172 psc->buttons ^= changed;
1173
1174 if (dx || dy || dz || changed) {
1175 buttons = (psc->buttons & 0x1f) | ((psc->buttons >> 5) & 0x7);
1176 s = spltty();
1177 wsmouse_input(psc->sc_wsmousedev,
1178 buttons, dx, dy, dz, 0,
1179 WSMOUSE_INPUT_DELTA);
1180 splx(s);
1181 }
1182 }
1183
1184 static void
1185 pms_synaptics_input(void *vsc, int data)
1186 {
1187 struct pms_softc *psc = vsc;
1188 struct timeval diff;
1189
1190 if (!psc->sc_enabled) {
1191 /* Interrupts are not expected. Discard the byte. */
1192 return;
1193 }
1194
1195 getmicrouptime(&psc->current);
1196
1197 if (psc->inputstate != 0) {
1198 timersub(&psc->current, &psc->last, &diff);
1199 if (diff.tv_sec > 0 || diff.tv_usec >= 40000) {
1200 aprint_debug_dev(psc->sc_dev,
1201 "pms_synaptics_input: unusual delay (%ld.%06ld s), "
1202 "scheduling reset\n",
1203 (long)diff.tv_sec, (long)diff.tv_usec);
1204 printf("pms_synaptics_input: unusual delay (%ld.%06ld s), "
1205 "scheduling reset\n",
1206 (long)diff.tv_sec, (long)diff.tv_usec);
1207 psc->inputstate = 0;
1208 psc->sc_enabled = 0;
1209 wakeup(&psc->sc_enabled);
1210 return;
1211 }
1212 }
1213 psc->last = psc->current;
1214
1215 switch (psc->inputstate) {
1216 case -5:
1217 case -4:
1218 case -3:
1219 case -2:
1220 case -1:
1221 case 0:
1222 if ((data & 0xc8) != 0x80) {
1223 aprint_debug_dev(psc->sc_dev,
1224 "pms_synaptics_input: 0x%02x out of sync\n", data);
1225 /* use negative counts to limit resync phase */
1226 psc->inputstate--;
1227 return; /* not in sync yet, discard input */
1228 }
1229 psc->inputstate = 0;
1230 /*FALLTHROUGH*/
1231
1232 case -6:
1233 case 3:
1234 if ((data & 8) == 8) {
1235 aprint_debug_dev(psc->sc_dev,
1236 "pms_synaptics_input: dropped in relative mode, reset\n");
1237 psc->inputstate = 0;
1238 psc->sc_enabled = 0;
1239 wakeup(&psc->sc_enabled);
1240 return;
1241 }
1242 }
1243
1244 psc->packet[psc->inputstate++] = data & 0xff;
1245 if (psc->inputstate == 6) {
1246 /*
1247 * We have a complete packet.
1248 * Extract the pertinent details.
1249 */
1250 psc->inputstate = 0;
1251 if ((psc->packet[0] & 0xfc) == 0x84 &&
1252 (psc->packet[3] & 0xcc) == 0xc4) {
1253 /* W = SYNAPTICS_WIDTH_PASSTHROUGH, PS/2 passthrough */
1254 pms_synaptics_passthrough(psc);
1255 } else {
1256 pms_synaptics_parse(psc);
1257 }
1258 }
1259 }
1260
1261 static inline int
1262 synaptics_finger_detect(struct synaptics_softc *sc, struct synaptics_packet *sp,
1263 int *palmp)
1264 {
1265 int fingers;
1266
1267 /* Assume no palm */
1268 *palmp = 0;
1269
1270 /*
1271 * Apply some hysteresis when checking for a finger.
1272 * When the finger is first applied, we ignore it until the
1273 * pressure exceeds the 'high' threshold. The finger is considered
1274 * removed only when pressure falls beneath the 'low' threshold.
1275 */
1276 if ((sc->prev_fingers == 0 && sp->sp_z > synaptics_finger_high) ||
1277 (sc->prev_fingers != 0 && sp->sp_z > synaptics_finger_low))
1278 fingers = 1;
1279 else
1280 fingers = 0;
1281
1282 /*
1283 * If the pad can't do palm detection, skip the rest.
1284 */
1285 if (fingers == 0 || (sc->flags & SYN_FLAG_HAS_PALM_DETECT) == 0)
1286 return (fingers);
1287
1288 /*
1289 * Palm detection
1290 */
1291 if (sp->sp_z > SYNAPTICS_FINGER_FLAT &&
1292 sp->sp_w >= SYNAPTICS_WIDTH_PALM_MIN)
1293 *palmp = 1;
1294
1295 if (sc->prev_fingers == 0 &&
1296 (sp->sp_z > SYNAPTICS_FINGER_FLAT ||
1297 sp->sp_w >= SYNAPTICS_WIDTH_PALM_MIN)) {
1298 /*
1299 * Contact area or pressure is too great to be a finger.
1300 * Just ignore it for now.
1301 */
1302 return (0);
1303 }
1304
1305 /*
1306 * Detect 2 and 3 fingers if supported, but only if multiple
1307 * fingers appear within the tap gesture time period.
1308 */
1309 if (sc->flags & SYN_FLAG_HAS_MULTI_FINGER &&
1310 SYN_TIME(sc, sc->gesture_start_packet,
1311 sp->sp_finger) < synaptics_gesture_length) {
1312 switch (sp->sp_w) {
1313 case SYNAPTICS_WIDTH_TWO_FINGERS:
1314 fingers = 2;
1315 break;
1316
1317 case SYNAPTICS_WIDTH_THREE_OR_MORE:
1318 fingers = 3;
1319 break;
1320
1321 default:
1322 /*
1323 * The width value can report spurious single-finger
1324 * events after a multi-finger event.
1325 */
1326 fingers = sc->prev_fingers <= 1 ? 1 : sc->prev_fingers;
1327 break;
1328 }
1329 }
1330
1331 return (fingers);
1332 }
1333
1334 static inline void
1335 synaptics_gesture_detect(struct synaptics_softc *sc,
1336 struct synaptics_packet *sp, int fingers)
1337 {
1338 int gesture_len, gesture_buttons;
1339 int set_buttons;
1340
1341 gesture_len = SYN_TIME(sc, sc->gesture_start_packet, sp->sp_finger);
1342 gesture_buttons = sc->gesture_buttons;
1343
1344 if (fingers > 0 && (fingers == sc->prev_fingers)) {
1345 /* Finger is still present */
1346 sc->gesture_move_x = abs(sc->gesture_start_x - sp->sp_x);
1347 sc->gesture_move_y = abs(sc->gesture_start_y - sp->sp_y);
1348 } else
1349 if (fingers && sc->prev_fingers == 0) {
1350 /*
1351 * Finger was just applied.
1352 * If the previous gesture was a single-click, set things
1353 * up to deal with a possible drag or double-click gesture.
1354 * Basically, if the finger is removed again within
1355 * 'synaptics_gesture_length' packets, this is treated
1356 * as a double-click. Otherwise we will emulate holding
1357 * the left button down whilst dragging the mouse.
1358 */
1359 if (SYN_IS_SINGLE_TAP(sc->gesture_type))
1360 sc->gesture_type |= SYN_GESTURE_DRAG;
1361
1362 sc->gesture_start_x = abs(sp->sp_x);
1363 sc->gesture_start_y = abs(sp->sp_y);
1364 sc->gesture_move_x = 0;
1365 sc->gesture_move_y = 0;
1366 sc->gesture_start_packet = sc->total_packets[0];
1367
1368 #ifdef DIAGNOSTIC
1369 aprint_debug("Finger applied: gesture_start_x: %d gesture_start_y: %d\n",
1370 sc->gesture_start_x, sc->gesture_start_y);
1371 #endif
1372 } else
1373 if (fingers == 0 && sc->prev_fingers != 0) {
1374 /*
1375 * Finger was just removed.
1376 * Check if the contact time and finger movement were
1377 * small enough to qualify as a gesture.
1378 * Ignore finger movement if multiple fingers were
1379 * detected (the pad may report coordinates for any
1380 * of the fingers).
1381 */
1382
1383 #ifdef DIAGNOSTIC
1384 aprint_debug("Finger removed: gesture_len: %d (%d)\n",
1385 gesture_len, synaptics_gesture_length);
1386 aprint_debug("gesture_move_x: %d (%d) sp_x: %d\n",
1387 sc->gesture_move_x, synaptics_gesture_move, abs(sp->sp_x));
1388 aprint_debug("gesture_move_y: %d (%d) sp_y: %d\n",
1389 sc->gesture_move_y, synaptics_gesture_move, abs(sp->sp_y));
1390 #endif
1391
1392 if (gesture_len < synaptics_gesture_length &&
1393 ((sc->gesture_move_x < synaptics_gesture_move &&
1394 sc->gesture_move_y < synaptics_gesture_move))) {
1395 /*
1396 * Looking good so far.
1397 */
1398 if (SYN_IS_DRAG(sc->gesture_type)) {
1399 /*
1400 * Promote this gesture to double-click.
1401 */
1402 sc->gesture_type |= SYN_GESTURE_DOUBLE;
1403 sc->gesture_type &= ~SYN_GESTURE_SINGLE;
1404 } else {
1405 /*
1406 * Single tap gesture. Set the tap length timer
1407 * and flag a single-click.
1408 */
1409 sc->gesture_tap_packet = sc->total_packets[0];
1410 sc->gesture_type |= SYN_GESTURE_SINGLE;
1411
1412 /*
1413 * The gesture can be modified depending on
1414 * the number of fingers detected.
1415 *
1416 * 1: Normal left button emulation.
1417 * 2: Either middle button or right button
1418 * depending on the value of the two_fingers
1419 * sysctl variable.
1420 * 3: Right button.
1421 */
1422 switch (sc->prev_fingers) {
1423 case 2:
1424 if (synaptics_two_fingers_emul == 1)
1425 gesture_buttons |= PMS_RBUTMASK;
1426 else
1427 if (synaptics_two_fingers_emul == 2)
1428 gesture_buttons |= PMS_MBUTMASK;
1429 break;
1430 case 3:
1431 gesture_buttons |= PMS_RBUTMASK;
1432 break;
1433 default:
1434 gesture_buttons |= PMS_LBUTMASK;
1435 break;
1436 }
1437 }
1438 }
1439
1440 /*
1441 * Always clear drag state when the finger is removed.
1442 */
1443 sc->gesture_type &= ~SYN_GESTURE_DRAG;
1444 }
1445
1446 if (sc->gesture_type == 0) {
1447 /*
1448 * There is no gesture in progress.
1449 * Clear emulated button state.
1450 */
1451 sc->gesture_buttons = 0;
1452 return;
1453 }
1454
1455 /*
1456 * A gesture is in progress.
1457 */
1458 set_buttons = 0;
1459
1460 if (SYN_IS_SINGLE_TAP(sc->gesture_type)) {
1461 /*
1462 * Single-click.
1463 * Activate the relevant button(s) until the
1464 * gesture tap timer has expired.
1465 */
1466 if (SYN_TIME(sc, sc->gesture_tap_packet, sp->sp_finger) <
1467 synaptics_gesture_length)
1468 set_buttons = 1;
1469 else
1470 sc->gesture_type &= ~SYN_GESTURE_SINGLE;
1471 } else
1472 if (SYN_IS_DOUBLE_TAP(sc->gesture_type) && sc->prev_fingers == 0) {
1473 /*
1474 * Double-click.
1475 * Activate the relevant button(s) once.
1476 */
1477 set_buttons = 1;
1478 sc->gesture_type &= ~SYN_GESTURE_DOUBLE;
1479 }
1480
1481 if (set_buttons || SYN_IS_DRAG(sc->gesture_type)) {
1482 /*
1483 * Single-click and drag.
1484 * Maintain button state until the finger is removed.
1485 */
1486 sp->sp_left |= gesture_buttons & PMS_LBUTMASK;
1487 sp->sp_right |= gesture_buttons & PMS_RBUTMASK;
1488 sp->sp_middle |= gesture_buttons & PMS_MBUTMASK;
1489 }
1490
1491 sc->gesture_buttons = gesture_buttons;
1492 }
1493
1494 static inline int
1495 synaptics_filter_policy(struct synaptics_softc *sc, int finger, int *history,
1496 int value)
1497 {
1498 int a, b, rv, count;
1499
1500 count = sc->total_packets[finger];
1501
1502 /*
1503 * Once we've accumulated at least SYN_HIST_SIZE values, combine
1504 * each new value with the previous two and return the average.
1505 *
1506 * This is necessary when the touchpad is operating in 80 packets
1507 * per second mode, as it performs little internal filtering on
1508 * reported values.
1509 *
1510 * Using a rolling average helps to filter out jitter caused by
1511 * tiny finger movements.
1512 */
1513 if (sc->movement_history[finger] >= SYN_HIST_SIZE) {
1514 a = (history[(count + 0) % SYN_HIST_SIZE] +
1515 history[(count + 1) % SYN_HIST_SIZE]) / 2;
1516
1517 b = (value + history[(count + 0) % SYN_HIST_SIZE]) / 2;
1518
1519 rv = b - a;
1520
1521 /*
1522 * Don't report the movement if it's below a certain
1523 * threshold.
1524 */
1525 if (abs(rv) < synaptics_movement_threshold)
1526 rv = 0;
1527 } else
1528 rv = 0;
1529
1530 /*
1531 * Add the new value to the history buffer.
1532 */
1533 history[(count + 1) % SYN_HIST_SIZE] = value;
1534
1535 return (rv);
1536 }
1537
1538 /* Edge detection */
1539 #define SYN_EDGE_TOP 1
1540 #define SYN_EDGE_BOTTOM 2
1541 #define SYN_EDGE_LEFT 4
1542 #define SYN_EDGE_RIGHT 8
1543
1544 static inline int
1545 synaptics_check_edge(int x, int y)
1546 {
1547 int rv = 0;
1548
1549 if (x < synaptics_edge_left)
1550 rv |= SYN_EDGE_LEFT;
1551 else
1552 if (x > synaptics_edge_right)
1553 rv |= SYN_EDGE_RIGHT;
1554
1555 if (y < synaptics_edge_bottom)
1556 rv |= SYN_EDGE_BOTTOM;
1557 else
1558 if (y > synaptics_edge_top)
1559 rv |= SYN_EDGE_TOP;
1560
1561 return (rv);
1562 }
1563
1564 static inline int
1565 synaptics_edge_motion(struct synaptics_softc *sc, int delta, int dir)
1566 {
1567
1568 /*
1569 * When edge motion is enabled, synaptics_edge_motion_delta is
1570 * combined with the current delta, together with the direction
1571 * in which to simulate the motion. The result is added to
1572 * the delta derived from finger movement. This provides a smooth
1573 * transition from finger movement to edge motion.
1574 */
1575 delta = synaptics_edge_motion_delta + (dir * delta);
1576 if (delta < 0)
1577 return (0);
1578 if (delta > synaptics_edge_motion_delta)
1579 return (synaptics_edge_motion_delta);
1580 return (delta);
1581 }
1582
1583 static inline int
1584 synaptics_scale(int delta, int scale, int *remp)
1585 {
1586 int rv;
1587
1588 /*
1589 * Scale the raw delta in Synaptics coordinates (0-6143) into
1590 * something more reasonable by dividing the raw delta by a
1591 * scale factor. Any remainder from the previous scale result
1592 * is added to the current delta before scaling.
1593 * This prevents loss of resolution for very small/slow
1594 * movements of the finger.
1595 */
1596 delta += *remp;
1597 rv = delta / scale;
1598 *remp = delta % scale;
1599
1600 return (rv);
1601 }
1602
1603 static inline void
1604 synaptics_movement(struct synaptics_softc *sc, struct synaptics_packet *sp,
1605 int finger, int scroll_emul, int *dxp, int *dyp, int *dzp)
1606 {
1607 int dx, dy, dz, edge;
1608
1609 dx = dy = dz = 0;
1610
1611 /*
1612 * Compute the next values of dx and dy and dz. If scroll_emul
1613 * is non-zero, take the dy and used it as use it as dz so we
1614 * can emulate a scroll wheel.
1615 */
1616 if (scroll_emul == 0) {
1617 dx = synaptics_filter_policy(sc, finger, sc->history_x[finger],
1618 sp->sp_x);
1619 dy = synaptics_filter_policy(sc, finger, sc->history_y[finger],
1620 sp->sp_y);
1621 } else {
1622 dz = synaptics_filter_policy(sc, finger, sc->history_z[finger],
1623 sp->sp_y);
1624 dx = dy = 0;
1625 }
1626
1627 /*
1628 * If we're dealing with a drag gesture, and the finger moves to
1629 * the edge of the touchpad, apply edge motion emulation if it
1630 * is enabled.
1631 */
1632 if (synaptics_edge_motion_delta && SYN_IS_DRAG(sc->gesture_type)) {
1633 edge = synaptics_check_edge(sp->sp_x, sp->sp_y);
1634
1635 if (edge & SYN_EDGE_LEFT)
1636 dx -= synaptics_edge_motion(sc, dx, 1);
1637 if (edge & SYN_EDGE_RIGHT)
1638 dx += synaptics_edge_motion(sc, dx, -1);
1639 if (edge & SYN_EDGE_BOTTOM)
1640 dy -= synaptics_edge_motion(sc, dy, 1);
1641 if (edge & SYN_EDGE_TOP)
1642 dy += synaptics_edge_motion(sc, dy, -1);
1643 }
1644
1645 /*
1646 * Apply scaling to the deltas
1647 */
1648 dx = synaptics_scale(dx, synaptics_scale_x, &sc->rem_x[finger]);
1649 dy = synaptics_scale(dy, synaptics_scale_y, &sc->rem_y[finger]);
1650 dz = synaptics_scale(dz, synaptics_scale_z, &sc->rem_z[finger]);
1651
1652 /*
1653 * Clamp deltas to specified maximums.
1654 */
1655 if (abs(dx) > synaptics_max_speed_x)
1656 dx = ((dx >= 0)? 1 : -1) * synaptics_max_speed_x;
1657 if (abs(dy) > synaptics_max_speed_y)
1658 dy = ((dy >= 0)? 1 : -1) * synaptics_max_speed_y;
1659 if (abs(dz) > synaptics_max_speed_z)
1660 dz = ((dz >= 0)? 1 : -1) * synaptics_max_speed_z;
1661
1662 *dxp = dx;
1663 *dyp = dy;
1664 *dzp = dz;
1665
1666 sc->movement_history[finger]++;
1667 }
1668
1669 static void
1670 pms_synaptics_process_packet(struct pms_softc *psc, struct synaptics_packet *sp)
1671 {
1672 struct synaptics_softc *sc = &psc->u.synaptics;
1673 int dx, dy, dz;
1674 int fingers, palm, buttons, changed;
1675 int s, z_emul;
1676
1677 /*
1678 * Do Z-axis emulation using up/down buttons if required.
1679 * Note that the pad will send a one second burst of packets
1680 * when an up/down button is pressed and held. At the moment
1681 * we don't deal with auto-repeat, so convert the burst into
1682 * a one-shot.
1683 */
1684 dz = 0;
1685 if (synaptics_up_down_emul == 2) {
1686 if (sc->up_down == 0) {
1687 if (sp->sp_up && sp->sp_down) {
1688 /*
1689 * Most up/down buttons will be actuated using
1690 * a rocker switch, so we should never see
1691 * them both simultaneously. But just in case,
1692 * treat this situation as a middle button
1693 * event.
1694 */
1695 sp->sp_middle = 1;
1696 } else
1697 if (sp->sp_up)
1698 dz = -synaptics_up_down_motion_delta;
1699 else
1700 if (sp->sp_down)
1701 dz = synaptics_up_down_motion_delta;
1702 }
1703
1704 sc->up_down = sp->sp_up | sp->sp_down;
1705 sp->sp_up = sp->sp_down = 0;
1706 }
1707
1708 /*
1709 * Determine whether or not a finger is on the pad.
1710 * On some pads, this will return the number of fingers
1711 * detected.
1712 */
1713 fingers = synaptics_finger_detect(sc, sp, &palm);
1714
1715 /*
1716 * Do gesture processing only if we didn't detect a palm and
1717 * it is not the seondary finger.
1718 */
1719 if ((sp->sp_finger == 0) && (palm == 0))
1720 synaptics_gesture_detect(sc, sp, fingers);
1721 else
1722 sc->gesture_type = sc->gesture_buttons = 0;
1723
1724 /*
1725 * Determine what buttons to report
1726 */
1727 buttons = (sp->sp_left ? 0x1 : 0) |
1728 (sp->sp_middle ? 0x2 : 0) |
1729 (sp->sp_right ? 0x4 : 0) |
1730 (sp->sp_up ? 0x8 : 0) |
1731 (sp->sp_down ? 0x10 : 0);
1732 changed = buttons ^ (psc->buttons & 0x1f);
1733 psc->buttons ^= changed;
1734
1735 sc->prev_fingers = fingers;
1736 sc->total_packets[sp->sp_finger]++;
1737
1738 /*
1739 * Do movement processing IFF we have a single finger and no palm or
1740 * a secondary finger and no palm.
1741 */
1742 if (palm == 0 && synaptics_movement_enable) {
1743 if (fingers == 1) {
1744 z_emul = 0;
1745
1746 if ((sp->sp_w >= synaptics_fscroll_min) &&
1747 (sp->sp_w <= synaptics_fscroll_max)) {
1748 z_emul = 1;
1749 sc->dz_hold = synaptics_dz_hold;
1750 }
1751
1752 if (sc->dz_hold > 0) {
1753 z_emul = 1;
1754 }
1755
1756 synaptics_movement(sc, sp, sp->sp_finger,
1757 z_emul, &dx, &dy, &dz);
1758 } else {
1759 /*
1760 * No valid finger. Therefore no movement.
1761 */
1762 sc->movement_history[sp->sp_finger] = 0;
1763 sc->rem_x[sp->sp_finger] = sc->rem_y[sp->sp_finger] = 0;
1764 dx = dy = 0;
1765 }
1766 } else {
1767 /*
1768 * No valid finger. Therefore no movement.
1769 */
1770 sc->movement_history[0] = 0;
1771 sc->rem_x[0] = sc->rem_y[0] = sc->rem_z[0] = 0;
1772 dx = dy = dz = 0;
1773 }
1774
1775 if (sc->dz_hold > 0)
1776 sc->dz_hold--;
1777
1778 /*
1779 * Pass the final results up to wsmouse_input() if necessary.
1780 */
1781 if (dx || dy || dz || changed) {
1782 buttons = (psc->buttons & 0x1f) | ((psc->buttons >> 5) & 0x7);
1783 s = spltty();
1784 wsmouse_input(psc->sc_wsmousedev,
1785 buttons,
1786 dx, dy, dz, 0,
1787 WSMOUSE_INPUT_DELTA);
1788 splx(s);
1789 }
1790 }
1791