synaptics.c revision 1.55
1 /* $NetBSD: synaptics.c,v 1.55 2020/03/14 13:08:18 nia 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.55 2020/03/14 13:08:18 nia 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 = 2; 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 if (t < 0) 867 return (EINVAL); 868 } else 869 if (node.sysctl_num == synaptics_edge_left_nodenum || 870 node.sysctl_num == synaptics_edge_bottom_nodenum) { 871 if (t < 0 || t > (SYNAPTICS_EDGE_MAX / 2)) 872 return (EINVAL); 873 } else 874 if (node.sysctl_num == synaptics_edge_right_nodenum || 875 node.sysctl_num == synaptics_edge_top_nodenum) { 876 if (t < (SYNAPTICS_EDGE_MAX / 2)) 877 return (EINVAL); 878 } else 879 if (node.sysctl_num == synaptics_scale_x_nodenum || 880 node.sysctl_num == synaptics_scale_y_nodenum || 881 node.sysctl_num == synaptics_scale_z_nodenum) { 882 if (t < 1 || t > (SYNAPTICS_EDGE_MAX / 4)) 883 return (EINVAL); 884 } else 885 if (node.sysctl_num == synaptics_finger_high_nodenum) { 886 if (t < 0 || t > SYNAPTICS_FINGER_PALM || 887 t < synaptics_finger_low) 888 return (EINVAL); 889 } else 890 if (node.sysctl_num == synaptics_finger_low_nodenum) { 891 if (t < 0 || t > SYNAPTICS_FINGER_PALM || 892 t > synaptics_finger_high) 893 return (EINVAL); 894 } else 895 if (node.sysctl_num == synaptics_gesture_move_nodenum || 896 node.sysctl_num == synaptics_movement_threshold_nodenum) { 897 if (t < 0 || t > (SYNAPTICS_EDGE_MAX / 4)) 898 return (EINVAL); 899 } else 900 if (node.sysctl_num == synaptics_button_boundary_nodenum) { 901 if (t < 0 || t < SYNAPTICS_EDGE_BOTTOM || 902 t > SYNAPTICS_EDGE_TOP) 903 return (EINVAL); 904 } else 905 if (node.sysctl_num == synaptics_button2_nodenum || 906 node.sysctl_num == synaptics_button3_nodenum) { 907 if (t < SYNAPTICS_EDGE_LEFT || t > SYNAPTICS_EDGE_RIGHT) 908 return (EINVAL); 909 } else 910 if (node.sysctl_num == synaptics_finger_scroll_min_nodenum || 911 node.sysctl_num == synaptics_finger_scroll_max_nodenum) { 912 /* make sure we avoid the "magic" widths, 4 and below 913 are for fingers, 15 is palm detect. */ 914 if ((t < 5) || (t > 14)) 915 return (EINVAL); 916 } else 917 if (node.sysctl_num == synaptics_dz_hold_nodenum) { 918 if (t < 0) 919 return (EINVAL); 920 } else 921 if (node.sysctl_num == synaptics_movement_enable_nodenum) { 922 if (t < 0 || t > 1) 923 return (EINVAL); 924 } else 925 return (EINVAL); 926 927 *(int *)rnode->sysctl_data = t; 928 929 return (0); 930 } 931 932 /* Masks for the first byte of a packet */ 933 #define PMS_LBUTMASK 0x01 934 #define PMS_RBUTMASK 0x02 935 #define PMS_MBUTMASK 0x04 936 937 static void 938 pms_synaptics_parse(struct pms_softc *psc) 939 { 940 struct synaptics_softc *sc = &psc->u.synaptics; 941 struct synaptics_packet sp; 942 char new_buttons, ew_mode; 943 944 memset(&sp, 0, sizeof(sp)); 945 946 /* Width of finger */ 947 sp.sp_w = ((psc->packet[0] & 0x30) >> 2) + 948 ((psc->packet[0] & 0x04) >> 1) + 949 ((psc->packet[3] & 0x04) >> 2); 950 sp.sp_finger = 0; 951 if ((sc->flags & SYN_FLAG_HAS_EXTENDED_WMODE) && 952 (sp.sp_w == SYNAPTICS_WIDTH_EXTENDED_W)) { 953 ew_mode = psc->packet[5] >> 4; 954 switch (ew_mode) 955 { 956 case SYNAPTICS_EW_WHEEL: 957 /* scroll wheel report, ignore for now */ 958 aprint_debug_dev(psc->sc_dev, "mouse wheel packet\n"); 959 return; 960 961 case SYNAPTICS_EW_SECONDARY_FINGER: 962 /* parse the second finger report */ 963 964 sp.sp_finger = 1; /* just one other finger for now */ 965 sp.sp_x = psc->packet[1] 966 + ((psc->packet[4] & 0x0f) << 8); 967 sp.sp_y = psc->packet[2] 968 + ((psc->packet[4] & 0xf0) << 4); 969 sp.sp_z = (psc->packet[3] & 0x30) 970 + (psc->packet[5] & 0x0f); 971 972 /* keep same buttons down as primary */ 973 sp.sp_left = sc->button_history & PMS_LBUTMASK; 974 sp.sp_middle = sc->button_history & PMS_MBUTMASK; 975 sp.sp_right = sc->button_history & PMS_RBUTMASK; 976 break; 977 978 case SYNAPTICS_EW_FINGER_STATUS: 979 /* reports which finger is primary/secondary 980 * ignore for now. 981 */ 982 return; 983 984 default: 985 aprint_error_dev(psc->sc_dev, 986 "invalid extended w mode %d\n", 987 ew_mode); 988 return; 989 } 990 } else { 991 992 /* Absolute X/Y coordinates of finger */ 993 sp.sp_x = psc->packet[4] + ((psc->packet[1] & 0x0f) << 8) + 994 ((psc->packet[3] & 0x10) << 8); 995 sp.sp_y = psc->packet[5] + ((psc->packet[1] & 0xf0) << 4) + 996 ((psc->packet[3] & 0x20) << 7); 997 998 /* Pressure */ 999 sp.sp_z = psc->packet[2]; 1000 1001 if ((psc->packet[0] ^ psc->packet[3]) & 0x02) { 1002 /* extended buttons */ 1003 1004 aprint_debug_dev(psc->sc_dev, 1005 "synaptics_parse: %02x %02x %02x %02x %02x %02x\n", 1006 psc->packet[0], psc->packet[1], psc->packet[2], 1007 psc->packet[3], psc->packet[4], psc->packet[5]); 1008 1009 if ((psc->packet[4] & SYN_1BUTMASK) != 0) 1010 sp.sp_left = PMS_LBUTMASK; 1011 1012 if ((psc->packet[4] & SYN_3BUTMASK) != 0) 1013 sp.sp_middle = PMS_MBUTMASK; 1014 1015 if ((psc->packet[5] & SYN_2BUTMASK) != 0) 1016 sp.sp_right = PMS_RBUTMASK; 1017 1018 if ((psc->packet[5] & SYN_4BUTMASK) != 0) 1019 sp.sp_up = 1; 1020 1021 if ((psc->packet[4] & SYN_5BUTMASK) != 0) 1022 sp.sp_down = 1; 1023 } else { 1024 /* Left/Right button handling. */ 1025 sp.sp_left = psc->packet[0] & PMS_LBUTMASK; 1026 sp.sp_right = psc->packet[0] & PMS_RBUTMASK; 1027 } 1028 1029 /* Up/Down buttons. */ 1030 if (sc->flags & SYN_FLAG_HAS_BUTTONS_4_5) { 1031 /* Old up/down buttons. */ 1032 sp.sp_up = sp.sp_left ^ 1033 (psc->packet[3] & PMS_LBUTMASK); 1034 sp.sp_down = sp.sp_right ^ 1035 (psc->packet[3] & PMS_RBUTMASK); 1036 } else if (sc->flags & SYN_FLAG_HAS_UP_DOWN_BUTTONS && 1037 ((psc->packet[0] & PMS_RBUTMASK) ^ 1038 (psc->packet[3] & PMS_RBUTMASK))) { 1039 /* New up/down button. */ 1040 sp.sp_up = psc->packet[4] & SYN_1BUTMASK; 1041 sp.sp_down = psc->packet[5] & SYN_2BUTMASK; 1042 } else { 1043 sp.sp_up = 0; 1044 sp.sp_down = 0; 1045 } 1046 1047 new_buttons = 0; 1048 if(sc->flags & SYN_FLAG_HAS_ONE_BUTTON_CLICKPAD) { 1049 /* This is not correctly specified. Read this button press 1050 * from L/U bit. Emulate 3 buttons by checking the 1051 * coordinates of the click and returning the appropriate 1052 * button code. Outside the button region default to a 1053 * left click. 1054 */ 1055 u_char bstate = (psc->packet[0] ^ psc->packet[3]) 1056 & 0x01; 1057 if (sp.sp_y < synaptics_button_boundary) { 1058 if (sp.sp_x > synaptics_button3) { 1059 sp.sp_right = 1060 bstate ? PMS_RBUTMASK : 0; 1061 } else if (sp.sp_x > synaptics_button2) { 1062 sp.sp_middle = 1063 bstate ? PMS_MBUTMASK : 0; 1064 } else { 1065 sp.sp_left = bstate ? PMS_LBUTMASK : 0; 1066 } 1067 } else 1068 sp.sp_left = bstate ? 1 : 0; 1069 new_buttons = sp.sp_left | sp.sp_middle | sp.sp_right; 1070 if (new_buttons != sc->button_history) { 1071 if (sc->button_history == 0) 1072 sc->button_history = new_buttons; 1073 else if (new_buttons == 0) { 1074 sc->button_history = 0; 1075 /* ensure all buttons are cleared just in 1076 * case finger comes off in a different 1077 * region. 1078 */ 1079 sp.sp_left = 0; 1080 sp.sp_middle = 0; 1081 sp.sp_right = 0; 1082 } else { 1083 /* make sure we keep the same button even 1084 * if the finger moves to a different 1085 * region. This precludes chording 1086 * but, oh well. 1087 */ 1088 sp.sp_left = sc->button_history & PMS_LBUTMASK; 1089 sp.sp_middle = sc->button_history 1090 & PMS_MBUTMASK; 1091 sp.sp_right = sc->button_history & PMS_RBUTMASK; 1092 } 1093 } 1094 } else if (sc->flags & SYN_FLAG_HAS_MIDDLE_BUTTON) { 1095 /* Old style Middle Button. */ 1096 sp.sp_middle = (psc->packet[0] & PMS_LBUTMASK) ^ 1097 (psc->packet[3] & PMS_LBUTMASK); 1098 } else if (synaptics_up_down_emul != 1) { 1099 sp.sp_middle = 0; 1100 } 1101 1102 switch (synaptics_up_down_emul) { 1103 case 1: 1104 /* Do middle button emulation using up/down buttons */ 1105 sp.sp_middle = sp.sp_up | sp.sp_down; 1106 sp.sp_up = sp.sp_down = 0; 1107 break; 1108 case 3: 1109 /* Do left/right button emulation using up/down buttons */ 1110 sp.sp_left = sp.sp_up; 1111 sp.sp_right = sp.sp_down; 1112 sp.sp_up = sp.sp_down = 0; 1113 break; 1114 default: 1115 /* 1116 * Don't do any remapping... 1117 * Z-axis emulation is handled in pms_synaptics_process_packet 1118 */ 1119 break; 1120 } 1121 } 1122 1123 pms_synaptics_process_packet(psc, &sp); 1124 } 1125 1126 static void 1127 pms_synaptics_passthrough(struct pms_softc *psc) 1128 { 1129 int dx, dy, dz; 1130 int buttons, changed; 1131 int s; 1132 1133 buttons = ((psc->packet[1] & PMS_LBUTMASK) ? 0x20 : 0) | 1134 ((psc->packet[1] & PMS_MBUTMASK) ? 0x40 : 0) | 1135 ((psc->packet[1] & PMS_RBUTMASK) ? 0x80 : 0); 1136 1137 dx = psc->packet[4]; 1138 if (dx >= 128) 1139 dx -= 256; 1140 if (dx == -128) 1141 dx = -127; 1142 1143 dy = psc->packet[5]; 1144 if (dy >= 128) 1145 dy -= 256; 1146 if (dy == -128) 1147 dy = -127; 1148 1149 dz = 0; 1150 1151 changed = buttons ^ (psc->buttons & 0xe0); 1152 psc->buttons ^= changed; 1153 1154 if (dx || dy || dz || changed) { 1155 buttons = (psc->buttons & 0x1f) | ((psc->buttons >> 5) & 0x7); 1156 s = spltty(); 1157 wsmouse_input(psc->sc_wsmousedev, 1158 buttons, dx, dy, dz, 0, 1159 WSMOUSE_INPUT_DELTA); 1160 splx(s); 1161 } 1162 } 1163 1164 static void 1165 pms_synaptics_input(void *vsc, int data) 1166 { 1167 struct pms_softc *psc = vsc; 1168 struct timeval diff; 1169 1170 if (!psc->sc_enabled) { 1171 /* Interrupts are not expected. Discard the byte. */ 1172 return; 1173 } 1174 1175 getmicrouptime(&psc->current); 1176 1177 if (psc->inputstate != 0) { 1178 timersub(&psc->current, &psc->last, &diff); 1179 if (diff.tv_sec > 0 || diff.tv_usec >= 40000) { 1180 aprint_debug_dev(psc->sc_dev, 1181 "pms_synaptics_input: unusual delay (%ld.%06ld s), " 1182 "scheduling reset\n", 1183 (long)diff.tv_sec, (long)diff.tv_usec); 1184 printf("pms_synaptics_input: unusual delay (%ld.%06ld s), " 1185 "scheduling reset\n", 1186 (long)diff.tv_sec, (long)diff.tv_usec); 1187 psc->inputstate = 0; 1188 psc->sc_enabled = 0; 1189 wakeup(&psc->sc_enabled); 1190 return; 1191 } 1192 } 1193 psc->last = psc->current; 1194 1195 switch (psc->inputstate) { 1196 case -5: 1197 case -4: 1198 case -3: 1199 case -2: 1200 case -1: 1201 case 0: 1202 if ((data & 0xc8) != 0x80) { 1203 aprint_debug_dev(psc->sc_dev, 1204 "pms_synaptics_input: 0x%02x out of sync\n", data); 1205 /* use negative counts to limit resync phase */ 1206 psc->inputstate--; 1207 return; /* not in sync yet, discard input */ 1208 } 1209 psc->inputstate = 0; 1210 /*FALLTHROUGH*/ 1211 1212 case -6: 1213 case 3: 1214 if ((data & 8) == 8) { 1215 aprint_debug_dev(psc->sc_dev, 1216 "pms_synaptics_input: dropped in relative mode, reset\n"); 1217 psc->inputstate = 0; 1218 psc->sc_enabled = 0; 1219 wakeup(&psc->sc_enabled); 1220 return; 1221 } 1222 } 1223 1224 psc->packet[psc->inputstate++] = data & 0xff; 1225 if (psc->inputstate == 6) { 1226 /* 1227 * We have a complete packet. 1228 * Extract the pertinent details. 1229 */ 1230 psc->inputstate = 0; 1231 if ((psc->packet[0] & 0xfc) == 0x84 && 1232 (psc->packet[3] & 0xcc) == 0xc4) { 1233 /* W = SYNAPTICS_WIDTH_PASSTHROUGH, PS/2 passthrough */ 1234 pms_synaptics_passthrough(psc); 1235 } else { 1236 pms_synaptics_parse(psc); 1237 } 1238 } 1239 } 1240 1241 static inline int 1242 synaptics_finger_detect(struct synaptics_softc *sc, struct synaptics_packet *sp, 1243 int *palmp) 1244 { 1245 int fingers; 1246 1247 /* Assume no palm */ 1248 *palmp = 0; 1249 1250 /* 1251 * Apply some hysteresis when checking for a finger. 1252 * When the finger is first applied, we ignore it until the 1253 * pressure exceeds the 'high' threshold. The finger is considered 1254 * removed only when pressure falls beneath the 'low' threshold. 1255 */ 1256 if ((sc->prev_fingers == 0 && sp->sp_z > synaptics_finger_high) || 1257 (sc->prev_fingers != 0 && sp->sp_z > synaptics_finger_low)) 1258 fingers = 1; 1259 else 1260 fingers = 0; 1261 1262 /* 1263 * If the pad can't do palm detection, skip the rest. 1264 */ 1265 if (fingers == 0 || (sc->flags & SYN_FLAG_HAS_PALM_DETECT) == 0) 1266 return (fingers); 1267 1268 /* 1269 * Palm detection 1270 */ 1271 if (sp->sp_z > SYNAPTICS_FINGER_FLAT && 1272 sp->sp_w >= SYNAPTICS_WIDTH_PALM_MIN) 1273 *palmp = 1; 1274 1275 if (sc->prev_fingers == 0 && 1276 (sp->sp_z > SYNAPTICS_FINGER_FLAT || 1277 sp->sp_w >= SYNAPTICS_WIDTH_PALM_MIN)) { 1278 /* 1279 * Contact area or pressure is too great to be a finger. 1280 * Just ignore it for now. 1281 */ 1282 return (0); 1283 } 1284 1285 /* 1286 * Detect 2 and 3 fingers if supported, but only if multiple 1287 * fingers appear within the tap gesture time period. 1288 */ 1289 if (sc->flags & SYN_FLAG_HAS_MULTI_FINGER && 1290 SYN_TIME(sc, sc->gesture_start_packet, 1291 sp->sp_finger) < synaptics_gesture_length) { 1292 switch (sp->sp_w) { 1293 case SYNAPTICS_WIDTH_TWO_FINGERS: 1294 fingers = 2; 1295 break; 1296 1297 case SYNAPTICS_WIDTH_THREE_OR_MORE: 1298 fingers = 3; 1299 break; 1300 1301 case SYNAPTICS_WIDTH_PEN: 1302 fingers = 1; 1303 break; 1304 1305 default: 1306 /* 1307 * The width value can report spurious single-finger 1308 * events after a multi-finger event. 1309 */ 1310 if (sc->prev_fingers > 1) 1311 fingers = sc->prev_fingers; 1312 else 1313 fingers = 1; 1314 break; 1315 } 1316 } 1317 1318 return (fingers); 1319 } 1320 1321 static inline void 1322 synaptics_gesture_detect(struct synaptics_softc *sc, 1323 struct synaptics_packet *sp, int fingers) 1324 { 1325 int gesture_len, gesture_buttons; 1326 int set_buttons; 1327 1328 gesture_len = SYN_TIME(sc, sc->gesture_start_packet, sp->sp_finger); 1329 gesture_buttons = sc->gesture_buttons; 1330 1331 if (fingers > 0 && (fingers == sc->prev_fingers)) { 1332 /* Finger is still present */ 1333 sc->gesture_move_x = abs(sc->gesture_start_x - sp->sp_x); 1334 sc->gesture_move_y = abs(sc->gesture_start_y - sp->sp_y); 1335 } else 1336 if (fingers && sc->prev_fingers == 0) { 1337 /* 1338 * Finger was just applied. 1339 * If the previous gesture was a single-click, set things 1340 * up to deal with a possible drag or double-click gesture. 1341 * Basically, if the finger is removed again within 1342 * 'synaptics_gesture_length' packets, this is treated 1343 * as a double-click. Otherwise we will emulate holding 1344 * the left button down whilst dragging the mouse. 1345 */ 1346 if (SYN_IS_SINGLE_TAP(sc->gesture_type)) 1347 sc->gesture_type |= SYN_GESTURE_DRAG; 1348 1349 sc->gesture_start_x = abs(sp->sp_x); 1350 sc->gesture_start_y = abs(sp->sp_y); 1351 sc->gesture_move_x = 0; 1352 sc->gesture_move_y = 0; 1353 sc->gesture_start_packet = sc->total_packets[0]; 1354 1355 #ifdef DIAGNOSTIC 1356 aprint_debug("Finger applied: gesture_start_x: %d gesture_start_y: %d\n", 1357 sc->gesture_start_x, sc->gesture_start_y); 1358 #endif 1359 } else 1360 if (fingers == 0 && sc->prev_fingers != 0) { 1361 /* 1362 * Finger was just removed. 1363 * Check if the contact time and finger movement were 1364 * small enough to qualify as a gesture. 1365 * Ignore finger movement if multiple fingers were 1366 * detected (the pad may report coordinates for any 1367 * of the fingers). 1368 */ 1369 1370 #ifdef DIAGNOSTIC 1371 aprint_debug("Finger removed: gesture_len: %d (%d)\n", 1372 gesture_len, synaptics_gesture_length); 1373 aprint_debug("gesture_move_x: %d (%d) sp_x: %d\n", 1374 sc->gesture_move_x, synaptics_gesture_move, abs(sp->sp_x)); 1375 aprint_debug("gesture_move_y: %d (%d) sp_y: %d\n", 1376 sc->gesture_move_y, synaptics_gesture_move, abs(sp->sp_y)); 1377 #endif 1378 1379 if (gesture_len < synaptics_gesture_length && 1380 ((sc->gesture_move_x < synaptics_gesture_move && 1381 sc->gesture_move_y < synaptics_gesture_move))) { 1382 /* 1383 * Looking good so far. 1384 */ 1385 if (SYN_IS_DRAG(sc->gesture_type)) { 1386 /* 1387 * Promote this gesture to double-click. 1388 */ 1389 sc->gesture_type |= SYN_GESTURE_DOUBLE; 1390 sc->gesture_type &= ~SYN_GESTURE_SINGLE; 1391 } else { 1392 /* 1393 * Single tap gesture. Set the tap length timer 1394 * and flag a single-click. 1395 */ 1396 sc->gesture_tap_packet = sc->total_packets[0]; 1397 sc->gesture_type |= SYN_GESTURE_SINGLE; 1398 1399 /* 1400 * The gesture can be modified depending on 1401 * the number of fingers detected. 1402 * 1403 * 1: Normal left button emulation. 1404 * 2: Either middle button or right button 1405 * depending on the value of the two_fingers 1406 * sysctl variable. 1407 * 3: Right button. 1408 */ 1409 switch (sc->prev_fingers) { 1410 case 2: 1411 if (synaptics_two_fingers_emul == 1) 1412 gesture_buttons |= PMS_RBUTMASK; 1413 else 1414 if (synaptics_two_fingers_emul == 2) 1415 gesture_buttons |= PMS_MBUTMASK; 1416 break; 1417 case 3: 1418 gesture_buttons |= PMS_RBUTMASK; 1419 break; 1420 default: 1421 gesture_buttons |= PMS_LBUTMASK; 1422 break; 1423 } 1424 } 1425 } 1426 1427 /* 1428 * Always clear drag state when the finger is removed. 1429 */ 1430 sc->gesture_type &= ~SYN_GESTURE_DRAG; 1431 } 1432 1433 if (sc->gesture_type == 0) { 1434 /* 1435 * There is no gesture in progress. 1436 * Clear emulated button state. 1437 */ 1438 sc->gesture_buttons = 0; 1439 return; 1440 } 1441 1442 /* 1443 * A gesture is in progress. 1444 */ 1445 set_buttons = 0; 1446 1447 if (SYN_IS_SINGLE_TAP(sc->gesture_type)) { 1448 /* 1449 * Single-click. 1450 * Activate the relevant button(s) until the 1451 * gesture tap timer has expired. 1452 */ 1453 if (SYN_TIME(sc, sc->gesture_tap_packet, sp->sp_finger) < 1454 synaptics_gesture_length) 1455 set_buttons = 1; 1456 else 1457 sc->gesture_type &= ~SYN_GESTURE_SINGLE; 1458 } else 1459 if (SYN_IS_DOUBLE_TAP(sc->gesture_type) && sc->prev_fingers == 0) { 1460 /* 1461 * Double-click. 1462 * Activate the relevant button(s) once. 1463 */ 1464 set_buttons = 1; 1465 sc->gesture_type &= ~SYN_GESTURE_DOUBLE; 1466 } 1467 1468 if (set_buttons || SYN_IS_DRAG(sc->gesture_type)) { 1469 /* 1470 * Single-click and drag. 1471 * Maintain button state until the finger is removed. 1472 */ 1473 sp->sp_left |= gesture_buttons & PMS_LBUTMASK; 1474 sp->sp_right |= gesture_buttons & PMS_RBUTMASK; 1475 sp->sp_middle |= gesture_buttons & PMS_MBUTMASK; 1476 } 1477 1478 sc->gesture_buttons = gesture_buttons; 1479 } 1480 1481 static inline int 1482 synaptics_filter_policy(struct synaptics_softc *sc, int finger, int *history, 1483 int value) 1484 { 1485 int a, b, rv, count; 1486 1487 count = sc->total_packets[finger]; 1488 1489 /* 1490 * Once we've accumulated at least SYN_HIST_SIZE values, combine 1491 * each new value with the previous two and return the average. 1492 * 1493 * This is necessary when the touchpad is operating in 80 packets 1494 * per second mode, as it performs little internal filtering on 1495 * reported values. 1496 * 1497 * Using a rolling average helps to filter out jitter caused by 1498 * tiny finger movements. 1499 */ 1500 if (sc->movement_history[finger] >= SYN_HIST_SIZE) { 1501 a = (history[(count + 0) % SYN_HIST_SIZE] + 1502 history[(count + 1) % SYN_HIST_SIZE]) / 2; 1503 1504 b = (value + history[(count + 0) % SYN_HIST_SIZE]) / 2; 1505 1506 rv = b - a; 1507 1508 /* 1509 * Don't report the movement if it's below a certain 1510 * threshold. 1511 */ 1512 if (abs(rv) < synaptics_movement_threshold) 1513 rv = 0; 1514 } else 1515 rv = 0; 1516 1517 /* 1518 * Add the new value to the history buffer. 1519 */ 1520 history[(count + 1) % SYN_HIST_SIZE] = value; 1521 1522 return (rv); 1523 } 1524 1525 /* Edge detection */ 1526 #define SYN_EDGE_TOP 1 1527 #define SYN_EDGE_BOTTOM 2 1528 #define SYN_EDGE_LEFT 4 1529 #define SYN_EDGE_RIGHT 8 1530 1531 static inline int 1532 synaptics_check_edge(int x, int y) 1533 { 1534 int rv = 0; 1535 1536 if (x < synaptics_edge_left) 1537 rv |= SYN_EDGE_LEFT; 1538 else 1539 if (x > synaptics_edge_right) 1540 rv |= SYN_EDGE_RIGHT; 1541 1542 if (y < synaptics_edge_bottom) 1543 rv |= SYN_EDGE_BOTTOM; 1544 else 1545 if (y > synaptics_edge_top) 1546 rv |= SYN_EDGE_TOP; 1547 1548 return (rv); 1549 } 1550 1551 static inline int 1552 synaptics_edge_motion(struct synaptics_softc *sc, int delta, int dir) 1553 { 1554 1555 /* 1556 * When edge motion is enabled, synaptics_edge_motion_delta is 1557 * combined with the current delta, together with the direction 1558 * in which to simulate the motion. The result is added to 1559 * the delta derived from finger movement. This provides a smooth 1560 * transition from finger movement to edge motion. 1561 */ 1562 delta = synaptics_edge_motion_delta + (dir * delta); 1563 if (delta < 0) 1564 return (0); 1565 if (delta > synaptics_edge_motion_delta) 1566 return (synaptics_edge_motion_delta); 1567 return (delta); 1568 } 1569 1570 static inline int 1571 synaptics_scale(int delta, int scale, int *remp) 1572 { 1573 int rv; 1574 1575 /* 1576 * Scale the raw delta in Synaptics coordinates (0-6143) into 1577 * something more reasonable by dividing the raw delta by a 1578 * scale factor. Any remainder from the previous scale result 1579 * is added to the current delta before scaling. 1580 * This prevents loss of resolution for very small/slow 1581 * movements of the finger. 1582 */ 1583 delta += *remp; 1584 rv = delta / scale; 1585 *remp = delta % scale; 1586 1587 return (rv); 1588 } 1589 1590 static inline void 1591 synaptics_movement(struct synaptics_softc *sc, struct synaptics_packet *sp, 1592 int finger, int scroll_emul, int *dxp, int *dyp, int *dzp) 1593 { 1594 int dx, dy, dz, edge; 1595 1596 dx = dy = dz = 0; 1597 1598 /* 1599 * Compute the next values of dx and dy and dz. If scroll_emul 1600 * is non-zero, take the dy and used it as use it as dz so we 1601 * can emulate a scroll wheel. 1602 */ 1603 if (scroll_emul == 0) { 1604 dx = synaptics_filter_policy(sc, finger, sc->history_x[finger], 1605 sp->sp_x); 1606 dy = synaptics_filter_policy(sc, finger, sc->history_y[finger], 1607 sp->sp_y); 1608 } else { 1609 dz = synaptics_filter_policy(sc, finger, sc->history_z[finger], 1610 sp->sp_y); 1611 dx = dy = 0; 1612 } 1613 1614 /* 1615 * If we're dealing with a drag gesture, and the finger moves to 1616 * the edge of the touchpad, apply edge motion emulation if it 1617 * is enabled. 1618 */ 1619 if (synaptics_edge_motion_delta && SYN_IS_DRAG(sc->gesture_type)) { 1620 edge = synaptics_check_edge(sp->sp_x, sp->sp_y); 1621 1622 if (edge & SYN_EDGE_LEFT) 1623 dx -= synaptics_edge_motion(sc, dx, 1); 1624 if (edge & SYN_EDGE_RIGHT) 1625 dx += synaptics_edge_motion(sc, dx, -1); 1626 if (edge & SYN_EDGE_BOTTOM) 1627 dy -= synaptics_edge_motion(sc, dy, 1); 1628 if (edge & SYN_EDGE_TOP) 1629 dy += synaptics_edge_motion(sc, dy, -1); 1630 } 1631 1632 /* 1633 * Apply scaling to the deltas 1634 */ 1635 dx = synaptics_scale(dx, synaptics_scale_x, &sc->rem_x[finger]); 1636 dy = synaptics_scale(dy, synaptics_scale_y, &sc->rem_y[finger]); 1637 dz = synaptics_scale(dz, synaptics_scale_z, &sc->rem_z[finger]); 1638 1639 /* 1640 * Clamp deltas to specified maximums. 1641 */ 1642 if (abs(dx) > synaptics_max_speed_x) 1643 dx = ((dx >= 0)? 1 : -1) * synaptics_max_speed_x; 1644 if (abs(dy) > synaptics_max_speed_y) 1645 dy = ((dy >= 0)? 1 : -1) * synaptics_max_speed_y; 1646 if (abs(dz) > synaptics_max_speed_z) 1647 dz = ((dz >= 0)? 1 : -1) * synaptics_max_speed_z; 1648 1649 *dxp = dx; 1650 *dyp = dy; 1651 *dzp = dz; 1652 1653 sc->movement_history[finger]++; 1654 } 1655 1656 static void 1657 pms_synaptics_process_packet(struct pms_softc *psc, struct synaptics_packet *sp) 1658 { 1659 struct synaptics_softc *sc = &psc->u.synaptics; 1660 int dx, dy, dz; 1661 int fingers, palm, buttons, changed; 1662 int s, z_emul; 1663 1664 /* 1665 * Do Z-axis emulation using up/down buttons if required. 1666 * Note that the pad will send a one second burst of packets 1667 * when an up/down button is pressed and held. At the moment 1668 * we don't deal with auto-repeat, so convert the burst into 1669 * a one-shot. 1670 */ 1671 dz = 0; 1672 if (synaptics_up_down_emul == 2) { 1673 if (sc->up_down == 0) { 1674 if (sp->sp_up && sp->sp_down) { 1675 /* 1676 * Most up/down buttons will be actuated using 1677 * a rocker switch, so we should never see 1678 * them both simultaneously. But just in case, 1679 * treat this situation as a middle button 1680 * event. 1681 */ 1682 sp->sp_middle = 1; 1683 } else 1684 if (sp->sp_up) 1685 dz = -synaptics_up_down_motion_delta; 1686 else 1687 if (sp->sp_down) 1688 dz = synaptics_up_down_motion_delta; 1689 } 1690 1691 sc->up_down = sp->sp_up | sp->sp_down; 1692 sp->sp_up = sp->sp_down = 0; 1693 } 1694 1695 /* 1696 * Determine whether or not a finger is on the pad. 1697 * On some pads, this will return the number of fingers 1698 * detected. 1699 */ 1700 fingers = synaptics_finger_detect(sc, sp, &palm); 1701 1702 /* 1703 * Do gesture processing only if we didn't detect a palm and 1704 * it is not the seondary finger. 1705 */ 1706 if ((sp->sp_finger == 0) && (palm == 0)) 1707 synaptics_gesture_detect(sc, sp, fingers); 1708 else 1709 sc->gesture_type = sc->gesture_buttons = 0; 1710 1711 /* 1712 * Determine what buttons to report 1713 */ 1714 buttons = (sp->sp_left ? 0x1 : 0) | 1715 (sp->sp_middle ? 0x2 : 0) | 1716 (sp->sp_right ? 0x4 : 0) | 1717 (sp->sp_up ? 0x8 : 0) | 1718 (sp->sp_down ? 0x10 : 0); 1719 changed = buttons ^ (psc->buttons & 0x1f); 1720 psc->buttons ^= changed; 1721 1722 sc->prev_fingers = fingers; 1723 sc->total_packets[sp->sp_finger]++; 1724 1725 /* 1726 * Do movement processing IFF we have a single finger and no palm or 1727 * a secondary finger and no palm. 1728 */ 1729 if (palm == 0 && synaptics_movement_enable) { 1730 if (fingers == 1) { 1731 z_emul = 0; 1732 1733 if ((sp->sp_w >= synaptics_fscroll_min) && 1734 (sp->sp_w <= synaptics_fscroll_max)) { 1735 z_emul = 1; 1736 sc->dz_hold = synaptics_dz_hold; 1737 } 1738 1739 if (sc->dz_hold > 0) { 1740 z_emul = 1; 1741 } 1742 1743 synaptics_movement(sc, sp, sp->sp_finger, 1744 z_emul, &dx, &dy, &dz); 1745 } else { 1746 /* 1747 * No valid finger. Therefore no movement. 1748 */ 1749 sc->movement_history[sp->sp_finger] = 0; 1750 sc->rem_x[sp->sp_finger] = sc->rem_y[sp->sp_finger] = 0; 1751 dx = dy = 0; 1752 } 1753 } else { 1754 /* 1755 * No valid finger. Therefore no movement. 1756 */ 1757 sc->movement_history[0] = 0; 1758 sc->rem_x[0] = sc->rem_y[0] = sc->rem_z[0] = 0; 1759 dx = dy = dz = 0; 1760 } 1761 1762 if (sc->dz_hold > 0) 1763 sc->dz_hold--; 1764 1765 /* 1766 * Pass the final results up to wsmouse_input() if necessary. 1767 */ 1768 if (dx || dy || dz || changed) { 1769 buttons = (psc->buttons & 0x1f) | ((psc->buttons >> 5) & 0x7); 1770 s = spltty(); 1771 wsmouse_input(psc->sc_wsmousedev, 1772 buttons, 1773 dx, dy, dz, 0, 1774 WSMOUSE_INPUT_DELTA); 1775 splx(s); 1776 } 1777 } 1778
Indexes created Sat Sep 27 22:09:54 GMT 2025