1 /*-
2 * Copyright (c) 1992, 1993 Erik Forsberg.
3 * Copyright (c) 1996, 1997 Kazutaka YOKOTA.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * THIS SOFTWARE IS PROVIDED BY ``AS IS'' AND ANY EXPRESS OR IMPLIED
13 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
14 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
15 * NO EVENT SHALL I BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
16 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
17 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
18 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
19 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
20 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
21 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22 */
23 /*
24 * Ported to 386bsd Oct 17, 1992
25 * Sandi Donno, Computer Science, University of Cape Town, South Africa
26 * Please send bug reports to sandi@cs.uct.ac.za
27 *
28 * Thanks are also due to Rick Macklem, rick@snowhite.cis.uoguelph.ca -
29 * although I was only partially successful in getting the alpha release
30 * of his "driver for the Logitech and ATI Inport Bus mice for use with
31 * 386bsd and the X386 port" to work with my Microsoft mouse, I nevertheless
32 * found his code to be an invaluable reference when porting this driver
33 * to 386bsd.
34 *
35 * Further modifications for latest 386BSD+patchkit and port to NetBSD,
36 * Andrew Herbert <andrew@werple.apana.org.au> - 8 June 1993
37 *
38 * Cloned from the Microsoft Bus Mouse driver, also by Erik Forsberg, by
39 * Andrew Herbert - 12 June 1993
40 *
41 * Modified for PS/2 mouse by Charles Hannum <mycroft@ai.mit.edu>
42 * - 13 June 1993
43 *
44 * Modified for PS/2 AUX mouse by Shoji Yuen <yuen@nuie.nagoya-u.ac.jp>
45 * - 24 October 1993
46 *
47 * Hardware access routines and probe logic rewritten by
48 * Kazutaka Yokota <yokota@zodiac.mech.utsunomiya-u.ac.jp>
49 * - 3, 14, 22 October 1996.
50 * - 12 November 1996. IOCTLs and rearranging `psmread', `psmioctl'...
51 * - 14, 30 November 1996. Uses `kbdio.c'.
52 * - 13 December 1996. Uses queuing version of `kbdio.c'.
53 * - January/February 1997. Tweaked probe logic for
54 * HiNote UltraII/Latitude/Armada laptops.
55 * - 30 July 1997. Added APM support.
56 * - 5 March 1997. Defined driver configuration flags (PSM_CONFIG_XXX).
57 * Improved sync check logic.
58 * Vendor specific support routines.
59 */
60
61 #include <sys/cdefs.h>
62 __FBSDID("$FreeBSD: stable/12/sys/dev/atkbdc/psm.c 370312 2021-08-16 01:01:04Z wulf $");
63
64 #include "opt_isa.h"
65 #include "opt_psm.h"
66 #include "opt_evdev.h"
67
68 #include <sys/param.h>
69 #include <sys/systm.h>
70 #include <sys/kernel.h>
71 #include <sys/module.h>
72 #include <sys/bus.h>
73 #include <sys/conf.h>
74 #include <sys/filio.h>
75 #include <sys/poll.h>
76 #include <sys/sigio.h>
77 #include <sys/signalvar.h>
78 #include <sys/syslog.h>
79 #include <machine/bus.h>
80 #include <sys/rman.h>
81 #include <sys/selinfo.h>
82 #include <sys/sysctl.h>
83 #include <sys/time.h>
84 #include <sys/uio.h>
85
86 #include <sys/limits.h>
87 #include <sys/mouse.h>
88 #include <machine/resource.h>
89
90 #ifdef DEV_ISA
91 #include <isa/isavar.h>
92 #endif
93
94 #ifdef EVDEV_SUPPORT
95 #include <dev/evdev/evdev.h>
96 #include <dev/evdev/input.h>
97 #endif
98
99 #include <dev/atkbdc/atkbdcreg.h>
100 #include <dev/atkbdc/psm.h>
101
102 /*
103 * Driver specific options: the following options may be set by
104 * `options' statements in the kernel configuration file.
105 */
106
107 /* debugging */
108 #ifndef PSM_DEBUG
109 #define PSM_DEBUG 0 /*
110 * logging: 0: none, 1: brief, 2: verbose
111 * 3: sync errors, 4: all packets
112 */
113 #endif
114 #define VLOG(level, args) do { \
115 if (verbose >= level) \
116 log args; \
117 } while (0)
118
119 #ifndef PSM_INPUT_TIMEOUT
120 #define PSM_INPUT_TIMEOUT 2000000 /* 2 sec */
121 #endif
122
123 #ifndef PSM_TAP_TIMEOUT
124 #define PSM_TAP_TIMEOUT 125000
125 #endif
126
127 #ifndef PSM_TAP_THRESHOLD
128 #define PSM_TAP_THRESHOLD 25
129 #endif
130
131 /* end of driver specific options */
132
133 #define PSMCPNP_DRIVER_NAME "psmcpnp"
134
135 struct psmcpnp_softc {
136 enum {
137 PSMCPNP_GENERIC,
138 PSMCPNP_FORCEPAD,
139 PSMCPNP_TOPBUTTONPAD,
140 } type; /* Based on PnP ID */
141 };
142
143 /* input queue */
144 #define PSM_BUFSIZE 960
145 #define PSM_SMALLBUFSIZE 240
146
147 /* operation levels */
148 #define PSM_LEVEL_BASE 0
149 #define PSM_LEVEL_STANDARD 1
150 #define PSM_LEVEL_NATIVE 2
151 #define PSM_LEVEL_MIN PSM_LEVEL_BASE
152 #define PSM_LEVEL_MAX PSM_LEVEL_NATIVE
153
154 /* Active PS/2 multiplexing */
155 #define PSM_NOMUX (-1)
156
157 /* Logitech PS2++ protocol */
158 #define MOUSE_PS2PLUS_CHECKBITS(b) \
159 ((((b[2] & 0x03) << 2) | 0x02) == (b[1] & 0x0f))
160 #define MOUSE_PS2PLUS_PACKET_TYPE(b) \
161 (((b[0] & 0x30) >> 2) | ((b[1] & 0x30) >> 4))
162
163 /* ring buffer */
164 typedef struct ringbuf {
165 int count; /* # of valid elements in the buffer */
166 int head; /* head pointer */
167 int tail; /* tail poiner */
168 u_char buf[PSM_BUFSIZE];
169 } ringbuf_t;
170
171 /* data buffer */
172 typedef struct packetbuf {
173 u_char ipacket[16]; /* interim input buffer */
174 int inputbytes; /* # of bytes in the input buffer */
175 } packetbuf_t;
176
177 #ifndef PSM_PACKETQUEUE
178 #define PSM_PACKETQUEUE 128
179 #endif
180
181 /*
182 * Synaptics command definitions.
183 */
184 #define SYNAPTICS_READ_IDENTITY 0x00
185 #define SYNAPTICS_READ_MODES 0x01
186 #define SYNAPTICS_READ_CAPABILITIES 0x02
187 #define SYNAPTICS_READ_MODEL_ID 0x03
188 #define SYNAPTICS_READ_SERIAL_PREFIX 0x06
189 #define SYNAPTICS_READ_SERIAL_SUFFIX 0x07
190 #define SYNAPTICS_READ_RESOLUTIONS 0x08
191 #define SYNAPTICS_READ_EXTENDED 0x09
192 #define SYNAPTICS_READ_CAPABILITIES_CONT 0x0c
193 #define SYNAPTICS_READ_MAX_COORDS 0x0d
194 #define SYNAPTICS_READ_DELUXE_LED 0x0e
195 #define SYNAPTICS_READ_MIN_COORDS 0x0f
196
197 typedef struct synapticsinfo {
198 struct sysctl_ctx_list sysctl_ctx;
199 struct sysctl_oid *sysctl_tree;
200 int directional_scrolls;
201 int two_finger_scroll;
202 int min_pressure;
203 int max_pressure;
204 int max_width;
205 int margin_top;
206 int margin_right;
207 int margin_bottom;
208 int margin_left;
209 int na_top;
210 int na_right;
211 int na_bottom;
212 int na_left;
213 int window_min;
214 int window_max;
215 int multiplicator;
216 int weight_current;
217 int weight_previous;
218 int weight_previous_na;
219 int weight_len_squared;
220 int div_min;
221 int div_max;
222 int div_max_na;
223 int div_len;
224 int tap_max_delta;
225 int tap_min_queue;
226 int taphold_timeout;
227 int vscroll_ver_area;
228 int vscroll_hor_area;
229 int vscroll_min_delta;
230 int vscroll_div_min;
231 int vscroll_div_max;
232 int touchpad_off;
233 int softbuttons_y;
234 int softbutton2_x;
235 int softbutton3_x;
236 int max_x;
237 int max_y;
238 int three_finger_drag;
239 int natural_scroll;
240 } synapticsinfo_t;
241
242 typedef struct synapticspacket {
243 int x;
244 int y;
245 } synapticspacket_t;
246
247 #define SYNAPTICS_PACKETQUEUE 10
248 #define SYNAPTICS_QUEUE_CURSOR(x) \
249 (x + SYNAPTICS_PACKETQUEUE) % SYNAPTICS_PACKETQUEUE
250
251 #define SYNAPTICS_VERSION_GE(synhw, major, minor) \
252 ((synhw).infoMajor > (major) || \
253 ((synhw).infoMajor == (major) && (synhw).infoMinor >= (minor)))
254
255 typedef struct smoother {
256 synapticspacket_t queue[SYNAPTICS_PACKETQUEUE];
257 int queue_len;
258 int queue_cursor;
259 int start_x;
260 int start_y;
261 int avg_dx;
262 int avg_dy;
263 int squelch_x;
264 int squelch_y;
265 int is_fuzzy;
266 int active;
267 } smoother_t;
268
269 typedef struct gesture {
270 int window_min;
271 int fingers_nb;
272 int tap_button;
273 int in_taphold;
274 int in_vscroll;
275 int zmax; /* maximum pressure value */
276 struct timeval taptimeout; /* tap timeout for touchpads */
277 } gesture_t;
278
279 enum {
280 TRACKPOINT_SYSCTL_SENSITIVITY,
281 TRACKPOINT_SYSCTL_NEGATIVE_INERTIA,
282 TRACKPOINT_SYSCTL_UPPER_PLATEAU,
283 TRACKPOINT_SYSCTL_BACKUP_RANGE,
284 TRACKPOINT_SYSCTL_DRAG_HYSTERESIS,
285 TRACKPOINT_SYSCTL_MINIMUM_DRAG,
286 TRACKPOINT_SYSCTL_UP_THRESHOLD,
287 TRACKPOINT_SYSCTL_THRESHOLD,
288 TRACKPOINT_SYSCTL_JENKS_CURVATURE,
289 TRACKPOINT_SYSCTL_Z_TIME,
290 TRACKPOINT_SYSCTL_PRESS_TO_SELECT,
291 TRACKPOINT_SYSCTL_SKIP_BACKUPS
292 };
293
294 typedef struct trackpointinfo {
295 struct sysctl_ctx_list sysctl_ctx;
296 struct sysctl_oid *sysctl_tree;
297 int sensitivity;
298 int inertia;
299 int uplateau;
300 int reach;
301 int draghys;
302 int mindrag;
303 int upthresh;
304 int threshold;
305 int jenks;
306 int ztime;
307 int pts;
308 int skipback;
309 } trackpointinfo_t;
310
311 typedef struct finger {
312 int x;
313 int y;
314 int p;
315 int w;
316 int flags;
317 } finger_t;
318 #define PSM_FINGERS 2 /* # of processed fingers */
319 #define PSM_FINGER_IS_PEN (1<<0)
320 #define PSM_FINGER_FUZZY (1<<1)
321 #define PSM_FINGER_DEFAULT_P tap_threshold
322 #define PSM_FINGER_DEFAULT_W 1
323 #define PSM_FINGER_IS_SET(f) ((f).x != -1 && (f).y != -1 && (f).p != 0)
324 #define PSM_FINGER_RESET(f) do { \
325 (f) = (finger_t) { .x = -1, .y = -1, .p = 0, .w = 0, .flags = 0 }; \
326 } while (0)
327
328 typedef struct elantechhw {
329 int hwversion;
330 int fwversion;
331 int sizex;
332 int sizey;
333 int dpmmx;
334 int dpmmy;
335 int ntracesx;
336 int ntracesy;
337 int dptracex;
338 int dptracey;
339 int issemimt;
340 int isclickpad;
341 int hascrc;
342 int hastrackpoint;
343 int haspressure;
344 } elantechhw_t;
345
346 /* minimum versions supported by this driver */
347 #define ELANTECH_HW_IS_V1(fwver) ((fwver) < 0x020030 || (fwver) == 0x020600)
348
349 #define ELANTECH_MAGIC(magic) \
350 ((magic)[0] == 0x3c && (magic)[1] == 0x03 && \
351 ((magic)[2] == 0xc8 || (magic)[2] == 0x00))
352
353 #define ELANTECH_FW_ID 0x00
354 #define ELANTECH_FW_VERSION 0x01
355 #define ELANTECH_CAPABILITIES 0x02
356 #define ELANTECH_SAMPLE 0x03
357 #define ELANTECH_RESOLUTION 0x04
358 #define ELANTECH_REG_READ 0x10
359 #define ELANTECH_REG_WRITE 0x11
360 #define ELANTECH_REG_RDWR 0x00
361 #define ELANTECH_CUSTOM_CMD 0xf8
362
363 #ifdef EVDEV_SUPPORT
364 #define ELANTECH_MAX_FINGERS 5
365 #else
366 #define ELANTECH_MAX_FINGERS PSM_FINGERS
367 #endif
368
369 #define ELANTECH_FINGER_MAX_P 255
370 #define ELANTECH_FINGER_MAX_W 15
371 #define ELANTECH_FINGER_SET_XYP(pb) (finger_t) { \
372 .x = (((pb)->ipacket[1] & 0x0f) << 8) | (pb)->ipacket[2], \
373 .y = (((pb)->ipacket[4] & 0x0f) << 8) | (pb)->ipacket[5], \
374 .p = ((pb)->ipacket[1] & 0xf0) | (((pb)->ipacket[4] >> 4) & 0x0f), \
375 .w = PSM_FINGER_DEFAULT_W, \
376 .flags = 0 \
377 }
378
379 enum {
380 ELANTECH_PKT_NOP,
381 ELANTECH_PKT_TRACKPOINT,
382 ELANTECH_PKT_V2_COMMON,
383 ELANTECH_PKT_V2_2FINGER,
384 ELANTECH_PKT_V3,
385 ELANTECH_PKT_V4_STATUS,
386 ELANTECH_PKT_V4_HEAD,
387 ELANTECH_PKT_V4_MOTION
388 };
389
390 #define ELANTECH_PKT_IS_TRACKPOINT(pb) (((pb)->ipacket[3] & 0x0f) == 0x06)
391 #define ELANTECH_PKT_IS_DEBOUNCE(pb, hwversion) ((hwversion) == 4 ? 0 : \
392 (pb)->ipacket[0] == ((hwversion) == 2 ? 0x84 : 0xc4) && \
393 (pb)->ipacket[1] == 0xff && (pb)->ipacket[2] == 0xff && \
394 (pb)->ipacket[3] == 0x02 && (pb)->ipacket[4] == 0xff && \
395 (pb)->ipacket[5] == 0xff)
396 #define ELANTECH_PKT_IS_V2(pb) \
397 (((pb)->ipacket[0] & 0x0c) == 0x04 && ((pb)->ipacket[3] & 0x0f) == 0x02)
398 #define ELANTECH_PKT_IS_V3_HEAD(pb, hascrc) ((hascrc) ? \
399 ((pb)->ipacket[3] & 0x09) == 0x08 : \
400 ((pb)->ipacket[0] & 0x0c) == 0x04 && ((pb)->ipacket[3] & 0xcf) == 0x02)
401 #define ELANTECH_PKT_IS_V3_TAIL(pb, hascrc) ((hascrc) ? \
402 ((pb)->ipacket[3] & 0x09) == 0x09 : \
403 ((pb)->ipacket[0] & 0x0c) == 0x0c && ((pb)->ipacket[3] & 0xce) == 0x0c)
404 #define ELANTECH_PKT_IS_V4(pb, hascrc) ((hascrc) ? \
405 ((pb)->ipacket[3] & 0x08) == 0x00 : \
406 ((pb)->ipacket[0] & 0x0c) == 0x04 && ((pb)->ipacket[3] & 0x1c) == 0x10)
407
408 typedef struct elantechaction {
409 finger_t fingers[ELANTECH_MAX_FINGERS];
410 int mask;
411 int mask_v4wait;
412 } elantechaction_t;
413
414 /* driver control block */
415 struct psm_softc { /* Driver status information */
416 int unit;
417 struct selinfo rsel; /* Process selecting for Input */
418 u_char state; /* Mouse driver state */
419 int config; /* driver configuration flags */
420 int flags; /* other flags */
421 KBDC kbdc; /* handle to access kbd controller */
422 struct resource *intr; /* IRQ resource */
423 void *ih; /* interrupt handle */
424 mousehw_t hw; /* hardware information */
425 synapticshw_t synhw; /* Synaptics hardware information */
426 synapticsinfo_t syninfo; /* Synaptics configuration */
427 smoother_t smoother[PSM_FINGERS]; /* Motion smoothing */
428 gesture_t gesture; /* Gesture context */
429 elantechhw_t elanhw; /* Elantech hardware information */
430 elantechaction_t elanaction; /* Elantech action context */
431 int tphw; /* TrackPoint hardware information */
432 trackpointinfo_t tpinfo; /* TrackPoint configuration */
433 mousemode_t mode; /* operation mode */
434 mousemode_t dflt_mode; /* default operation mode */
435 mousestatus_t status; /* accumulated mouse movement */
436 ringbuf_t queue; /* mouse status queue */
437 packetbuf_t pqueue[PSM_PACKETQUEUE]; /* mouse data queue */
438 int pqueue_start; /* start of data in queue */
439 int pqueue_end; /* end of data in queue */
440 int button; /* the latest button state */
441 int xold; /* previous absolute X position */
442 int yold; /* previous absolute Y position */
443 int xaverage; /* average X position */
444 int yaverage; /* average Y position */
445 int squelch; /* level to filter movement at low speed */
446 int syncerrors; /* # of bytes discarded to synchronize */
447 int pkterrors; /* # of packets failed during quaranteen. */
448 int fpcount; /* forcePad valid packet counter */
449 struct timeval inputtimeout;
450 struct timeval lastsoftintr; /* time of last soft interrupt */
451 struct timeval lastinputerr; /* time last sync error happened */
452 struct timeval idletimeout;
453 packetbuf_t idlepacket; /* packet to send after idle timeout */
454 int watchdog; /* watchdog timer flag */
455 struct callout callout; /* watchdog timer call out */
456 struct callout softcallout; /* buffer timer call out */
457 struct cdev *dev;
458 struct cdev *bdev;
459 int lasterr;
460 int cmdcount;
461 struct sigio *async; /* Processes waiting for SIGIO */
462 int extended_buttons;
463 int muxport; /* MUX port with attached Synaptics */
464 u_char muxsave[3]; /* 3->6 byte proto conversion buffer */
465 int muxtpbuttons; /* Touchpad button state */
466 int muxmsbuttons; /* Mouse (trackpoint) button state */
467 struct timeval muxmidtimeout; /* middle button supression timeout */
468 int muxsinglesyna; /* Probe result of single Synaptics */
469 #ifdef EVDEV_SUPPORT
470 struct evdev_dev *evdev_a; /* Absolute reporting device */
471 struct evdev_dev *evdev_r; /* Relative reporting device */
472 #endif
473 };
474 static devclass_t psm_devclass;
475
476 /* driver state flags (state) */
477 #define PSM_VALID 0x80
478 #define PSM_OPEN 1 /* Device is open */
479 #define PSM_ASLP 2 /* Waiting for mouse data */
480 #define PSM_SOFTARMED 4 /* Software interrupt armed */
481 #define PSM_NEED_SYNCBITS 8 /* Set syncbits using next data pkt */
482 #define PSM_EV_OPEN_R 0x10 /* Relative evdev device is open */
483 #define PSM_EV_OPEN_A 0x20 /* Absolute evdev device is open */
484
485 /* driver configuration flags (config) */
486 #define PSM_CONFIG_RESOLUTION 0x000f /* resolution */
487 #define PSM_CONFIG_ACCEL 0x00f0 /* acceleration factor */
488 #define PSM_CONFIG_NOCHECKSYNC 0x0100 /* disable sync. test */
489 #define PSM_CONFIG_NOIDPROBE 0x0200 /* disable mouse model probe */
490 #define PSM_CONFIG_NORESET 0x0400 /* don't reset the mouse */
491 #define PSM_CONFIG_FORCETAP 0x0800 /* assume `tap' action exists */
492 #define PSM_CONFIG_IGNPORTERROR 0x1000 /* ignore error in aux port test */
493 #define PSM_CONFIG_HOOKRESUME 0x2000 /* hook the system resume event */
494 #define PSM_CONFIG_INITAFTERSUSPEND 0x4000 /* init the device at the resume event */
495
496 #define PSM_CONFIG_FLAGS \
497 (PSM_CONFIG_RESOLUTION | \
498 PSM_CONFIG_ACCEL | \
499 PSM_CONFIG_NOCHECKSYNC | \
500 PSM_CONFIG_NOIDPROBE | \
501 PSM_CONFIG_NORESET | \
502 PSM_CONFIG_FORCETAP | \
503 PSM_CONFIG_IGNPORTERROR | \
504 PSM_CONFIG_HOOKRESUME | \
505 PSM_CONFIG_INITAFTERSUSPEND)
506
507 /* other flags (flags) */
508 #define PSM_FLAGS_FINGERDOWN 0x0001 /* VersaPad finger down */
509
510 #define kbdcp(p) ((atkbdc_softc_t *)(p))
511 #define ALWAYS_RESTORE_CONTROLLER(kbdc) !(kbdcp(kbdc)->quirks \
512 & KBDC_QUIRK_KEEP_ACTIVATED)
513
514 /* Tunables */
515 static int tap_enabled = -1;
516 static int verbose = PSM_DEBUG;
517 static int synaptics_support = 1;
518 static int trackpoint_support = 1;
519 static int elantech_support = 1;
520 static int mux_disabled = -1;
521
522 /* for backward compatibility */
523 #define OLD_MOUSE_GETHWINFO _IOR('M', 1, old_mousehw_t)
524 #define OLD_MOUSE_GETMODE _IOR('M', 2, old_mousemode_t)
525 #define OLD_MOUSE_SETMODE _IOW('M', 3, old_mousemode_t)
526
527 typedef struct old_mousehw {
528 int buttons;
529 int iftype;
530 int type;
531 int hwid;
532 } old_mousehw_t;
533
534 typedef struct old_mousemode {
535 int protocol;
536 int rate;
537 int resolution;
538 int accelfactor;
539 } old_mousemode_t;
540
541 #define SYN_OFFSET(field) offsetof(struct psm_softc, syninfo.field)
542 enum {
543 SYNAPTICS_SYSCTL_MIN_PRESSURE = SYN_OFFSET(min_pressure),
544 SYNAPTICS_SYSCTL_MAX_PRESSURE = SYN_OFFSET(max_pressure),
545 SYNAPTICS_SYSCTL_MAX_WIDTH = SYN_OFFSET(max_width),
546 SYNAPTICS_SYSCTL_MARGIN_TOP = SYN_OFFSET(margin_top),
547 SYNAPTICS_SYSCTL_MARGIN_RIGHT = SYN_OFFSET(margin_right),
548 SYNAPTICS_SYSCTL_MARGIN_BOTTOM = SYN_OFFSET(margin_bottom),
549 SYNAPTICS_SYSCTL_MARGIN_LEFT = SYN_OFFSET(margin_left),
550 SYNAPTICS_SYSCTL_NA_TOP = SYN_OFFSET(na_top),
551 SYNAPTICS_SYSCTL_NA_RIGHT = SYN_OFFSET(na_right),
552 SYNAPTICS_SYSCTL_NA_BOTTOM = SYN_OFFSET(na_bottom),
553 SYNAPTICS_SYSCTL_NA_LEFT = SYN_OFFSET(na_left),
554 SYNAPTICS_SYSCTL_WINDOW_MIN = SYN_OFFSET(window_min),
555 SYNAPTICS_SYSCTL_WINDOW_MAX = SYN_OFFSET(window_max),
556 SYNAPTICS_SYSCTL_MULTIPLICATOR = SYN_OFFSET(multiplicator),
557 SYNAPTICS_SYSCTL_WEIGHT_CURRENT = SYN_OFFSET(weight_current),
558 SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS = SYN_OFFSET(weight_previous),
559 SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS_NA = SYN_OFFSET(weight_previous_na),
560 SYNAPTICS_SYSCTL_WEIGHT_LEN_SQUARED = SYN_OFFSET(weight_len_squared),
561 SYNAPTICS_SYSCTL_DIV_MIN = SYN_OFFSET(div_min),
562 SYNAPTICS_SYSCTL_DIV_MAX = SYN_OFFSET(div_max),
563 SYNAPTICS_SYSCTL_DIV_MAX_NA = SYN_OFFSET(div_max_na),
564 SYNAPTICS_SYSCTL_DIV_LEN = SYN_OFFSET(div_len),
565 SYNAPTICS_SYSCTL_TAP_MAX_DELTA = SYN_OFFSET(tap_max_delta),
566 SYNAPTICS_SYSCTL_TAP_MIN_QUEUE = SYN_OFFSET(tap_min_queue),
567 SYNAPTICS_SYSCTL_TAPHOLD_TIMEOUT = SYN_OFFSET(taphold_timeout),
568 SYNAPTICS_SYSCTL_VSCROLL_HOR_AREA = SYN_OFFSET(vscroll_hor_area),
569 SYNAPTICS_SYSCTL_VSCROLL_VER_AREA = SYN_OFFSET(vscroll_ver_area),
570 SYNAPTICS_SYSCTL_VSCROLL_MIN_DELTA = SYN_OFFSET(vscroll_min_delta),
571 SYNAPTICS_SYSCTL_VSCROLL_DIV_MIN = SYN_OFFSET(vscroll_div_min),
572 SYNAPTICS_SYSCTL_VSCROLL_DIV_MAX = SYN_OFFSET(vscroll_div_max),
573 SYNAPTICS_SYSCTL_TOUCHPAD_OFF = SYN_OFFSET(touchpad_off),
574 SYNAPTICS_SYSCTL_SOFTBUTTONS_Y = SYN_OFFSET(softbuttons_y),
575 SYNAPTICS_SYSCTL_SOFTBUTTON2_X = SYN_OFFSET(softbutton2_x),
576 SYNAPTICS_SYSCTL_SOFTBUTTON3_X = SYN_OFFSET(softbutton3_x),
577 SYNAPTICS_SYSCTL_THREE_FINGER_DRAG = SYN_OFFSET(three_finger_drag),
578 SYNAPTICS_SYSCTL_NATURAL_SCROLL = SYN_OFFSET(natural_scroll),
579 #define SYNAPTICS_SYSCTL_LAST SYNAPTICS_SYSCTL_NATURAL_SCROLL
580 };
581
582 /* packet formatting function */
583 typedef int packetfunc_t(struct psm_softc *, u_char *, int *, int,
584 mousestatus_t *);
585
586 /* function prototypes */
587 static void psmidentify(driver_t *, device_t);
588 static int psmprobe(device_t);
589 static int psmattach(device_t);
590 static int psmdetach(device_t);
591 static int psmresume(device_t);
592
593 static d_open_t psm_cdev_open;
594 static d_close_t psm_cdev_close;
595 static d_read_t psmread;
596 static d_write_t psmwrite;
597 static d_ioctl_t psmioctl;
598 static d_poll_t psmpoll;
599
600 static int psmopen(struct psm_softc *);
601 static int psmclose(struct psm_softc *);
602
603 #ifdef EVDEV_SUPPORT
604 static evdev_open_t psm_ev_open_r;
605 static evdev_close_t psm_ev_close_r;
606 static evdev_open_t psm_ev_open_a;
607 static evdev_close_t psm_ev_close_a;
608 #endif
609
610 static int enable_aux_dev(KBDC);
611 static int disable_aux_dev(KBDC);
612 static int get_mouse_status(KBDC, int *, int, int);
613 static int get_aux_id(KBDC);
614 static int set_mouse_sampling_rate(KBDC, int);
615 static int set_mouse_scaling(KBDC, int);
616 static int set_mouse_resolution(KBDC, int);
617 static int set_mouse_mode(KBDC);
618 static int get_mouse_buttons(KBDC);
619 static int is_a_mouse(int);
620 static void recover_from_error(KBDC);
621 static int restore_controller(KBDC, int);
622 static int doinitialize(struct psm_softc *, mousemode_t *);
623 static int doopen(struct psm_softc *, int);
624 static int reinitialize(struct psm_softc *, int);
625 static char *model_name(int);
626 static void psmsoftintr(void *);
627 static void psmsoftintridle(void *);
628 static void psmintr(void *);
629 static void psmtimeout(void *);
630 static int timeelapsed(const struct timeval *, int, int,
631 const struct timeval *);
632 static void dropqueue(struct psm_softc *);
633 static void flushpackets(struct psm_softc *);
634 static void proc_mmanplus(struct psm_softc *, packetbuf_t *,
635 mousestatus_t *, int *, int *, int *);
636 static int proc_synaptics(struct psm_softc *, packetbuf_t *,
637 mousestatus_t *, int *, int *, int *);
638 static int proc_synaptics_mux(struct psm_softc *, packetbuf_t *);
639 static void proc_versapad(struct psm_softc *, packetbuf_t *,
640 mousestatus_t *, int *, int *, int *);
641 static int proc_elantech(struct psm_softc *, packetbuf_t *,
642 mousestatus_t *, int *, int *, int *);
643 static int psmpalmdetect(struct psm_softc *, finger_t *, int);
644 static void psmgestures(struct psm_softc *, finger_t *, int,
645 mousestatus_t *);
646 static void psmsmoother(struct psm_softc *, finger_t *, int,
647 mousestatus_t *, int *, int *);
648 static int tame_mouse(struct psm_softc *, packetbuf_t *, mousestatus_t *,
649 u_char *);
650
651 /* vendor specific features */
652 enum probearg { PROBE, REINIT };
653 typedef int probefunc_t(struct psm_softc *, enum probearg);
654
655 static int mouse_id_proc1(KBDC, int, int, int *);
656 static int mouse_ext_command(KBDC, int);
657
658 static probefunc_t enable_groller;
659 static probefunc_t enable_gmouse;
660 static probefunc_t enable_aglide;
661 static probefunc_t enable_kmouse;
662 static probefunc_t enable_msexplorer;
663 static probefunc_t enable_msintelli;
664 static probefunc_t enable_4dmouse;
665 static probefunc_t enable_4dplus;
666 static probefunc_t enable_mmanplus;
667 static probefunc_t enable_synaptics;
668 static probefunc_t enable_synaptics_mux;
669 static probefunc_t enable_single_synaptics_mux;
670 static probefunc_t enable_trackpoint;
671 static probefunc_t enable_versapad;
672 static probefunc_t enable_elantech;
673
674 static void set_trackpoint_parameters(struct psm_softc *sc);
675 static void synaptics_passthrough_on(struct psm_softc *sc);
676 static void synaptics_passthrough_off(struct psm_softc *sc);
677 static int synaptics_preferred_mode(struct psm_softc *sc);
678 static void synaptics_set_mode(struct psm_softc *sc, int mode_byte);
679
680 static struct {
681 int model;
682 u_char syncmask;
683 int packetsize;
684 probefunc_t *probefunc;
685 } vendortype[] = {
686 /*
687 * WARNING: the order of probe is very important. Don't mess it
688 * unless you know what you are doing.
689 */
690 { MOUSE_MODEL_SYNAPTICS, /* Synaptics + mouse on Active Mux */
691 0x00, MOUSE_PS2_PACKETSIZE, enable_synaptics_mux },
692 { MOUSE_MODEL_SYNAPTICS, /* Single Synaptics on Active Mux */
693 0xc0, MOUSE_SYNAPTICS_PACKETSIZE, enable_single_synaptics_mux },
694 { MOUSE_MODEL_NET, /* Genius NetMouse */
695 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_gmouse },
696 { MOUSE_MODEL_NETSCROLL, /* Genius NetScroll */
697 0xc8, 6, enable_groller },
698 { MOUSE_MODEL_MOUSEMANPLUS, /* Logitech MouseMan+ */
699 0x08, MOUSE_PS2_PACKETSIZE, enable_mmanplus },
700 { MOUSE_MODEL_EXPLORER, /* Microsoft IntelliMouse Explorer */
701 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msexplorer },
702 { MOUSE_MODEL_4D, /* A4 Tech 4D Mouse */
703 0x08, MOUSE_4D_PACKETSIZE, enable_4dmouse },
704 { MOUSE_MODEL_4DPLUS, /* A4 Tech 4D+ Mouse */
705 0xc8, MOUSE_4DPLUS_PACKETSIZE, enable_4dplus },
706 { MOUSE_MODEL_SYNAPTICS, /* Synaptics Touchpad */
707 0xc0, MOUSE_SYNAPTICS_PACKETSIZE, enable_synaptics },
708 { MOUSE_MODEL_ELANTECH, /* Elantech Touchpad */
709 0x04, MOUSE_ELANTECH_PACKETSIZE, enable_elantech },
710 { MOUSE_MODEL_INTELLI, /* Microsoft IntelliMouse */
711 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msintelli },
712 { MOUSE_MODEL_GLIDEPOINT, /* ALPS GlidePoint */
713 0xc0, MOUSE_PS2_PACKETSIZE, enable_aglide },
714 { MOUSE_MODEL_THINK, /* Kensington ThinkingMouse */
715 0x80, MOUSE_PS2_PACKETSIZE, enable_kmouse },
716 { MOUSE_MODEL_VERSAPAD, /* Interlink electronics VersaPad */
717 0xe8, MOUSE_PS2VERSA_PACKETSIZE, enable_versapad },
718 { MOUSE_MODEL_TRACKPOINT, /* IBM/Lenovo TrackPoint */
719 0xc0, MOUSE_PS2_PACKETSIZE, enable_trackpoint },
720 { MOUSE_MODEL_GENERIC,
721 0xc0, MOUSE_PS2_PACKETSIZE, NULL },
722 };
723 #define GENERIC_MOUSE_ENTRY (nitems(vendortype) - 1)
724
725 /* device driver declarateion */
726 static device_method_t psm_methods[] = {
727 /* Device interface */
728 DEVMETHOD(device_identify, psmidentify),
729 DEVMETHOD(device_probe, psmprobe),
730 DEVMETHOD(device_attach, psmattach),
731 DEVMETHOD(device_detach, psmdetach),
732 DEVMETHOD(device_resume, psmresume),
733
734 { 0, 0 }
735 };
736
737 static driver_t psm_driver = {
738 PSM_DRIVER_NAME,
739 psm_methods,
740 sizeof(struct psm_softc),
741 };
742
743 static struct cdevsw psm_cdevsw = {
744 .d_version = D_VERSION,
745 .d_flags = D_NEEDGIANT,
746 .d_open = psm_cdev_open,
747 .d_close = psm_cdev_close,
748 .d_read = psmread,
749 .d_write = psmwrite,
750 .d_ioctl = psmioctl,
751 .d_poll = psmpoll,
752 .d_name = PSM_DRIVER_NAME,
753 };
754
755 #ifdef EVDEV_SUPPORT
756 static const struct evdev_methods psm_ev_methods_r = {
757 .ev_open = psm_ev_open_r,
758 .ev_close = psm_ev_close_r,
759 };
760 static const struct evdev_methods psm_ev_methods_a = {
761 .ev_open = psm_ev_open_a,
762 .ev_close = psm_ev_close_a,
763 };
764 #endif
765
766 /* device I/O routines */
767 static int
enable_aux_dev(KBDC kbdc)768 enable_aux_dev(KBDC kbdc)
769 {
770 int res;
771
772 res = send_aux_command(kbdc, PSMC_ENABLE_DEV);
773 VLOG(2, (LOG_DEBUG, "psm: ENABLE_DEV return code:%04x\n", res));
774
775 return (res == PSM_ACK);
776 }
777
778 static int
disable_aux_dev(KBDC kbdc)779 disable_aux_dev(KBDC kbdc)
780 {
781 int res;
782
783 res = send_aux_command(kbdc, PSMC_DISABLE_DEV);
784 VLOG(2, (LOG_DEBUG, "psm: DISABLE_DEV return code:%04x\n", res));
785
786 return (res == PSM_ACK);
787 }
788
789 static int
get_mouse_status(KBDC kbdc,int * status,int flag,int len)790 get_mouse_status(KBDC kbdc, int *status, int flag, int len)
791 {
792 int cmd;
793 int res;
794 int i;
795
796 switch (flag) {
797 case 0:
798 default:
799 cmd = PSMC_SEND_DEV_STATUS;
800 break;
801 case 1:
802 cmd = PSMC_SEND_DEV_DATA;
803 break;
804 }
805 empty_aux_buffer(kbdc, 5);
806 res = send_aux_command(kbdc, cmd);
807 VLOG(2, (LOG_DEBUG, "psm: SEND_AUX_DEV_%s return code:%04x\n",
808 (flag == 1) ? "DATA" : "STATUS", res));
809 if (res != PSM_ACK)
810 return (0);
811
812 for (i = 0; i < len; ++i) {
813 status[i] = read_aux_data(kbdc);
814 if (status[i] < 0)
815 break;
816 }
817 if (len >= 3) {
818 for (; i < 3; ++i)
819 status[i] = 0;
820 VLOG(1, (LOG_DEBUG, "psm: %s %02x %02x %02x\n",
821 (flag == 1) ? "data" : "status", status[0], status[1], status[2]));
822 }
823
824 return (i);
825 }
826
827 static int
get_aux_id(KBDC kbdc)828 get_aux_id(KBDC kbdc)
829 {
830 int res;
831 int id;
832
833 empty_aux_buffer(kbdc, 5);
834 res = send_aux_command(kbdc, PSMC_SEND_DEV_ID);
835 VLOG(2, (LOG_DEBUG, "psm: SEND_DEV_ID return code:%04x\n", res));
836 if (res != PSM_ACK)
837 return (-1);
838
839 /* 10ms delay */
840 DELAY(10000);
841
842 id = read_aux_data(kbdc);
843 VLOG(2, (LOG_DEBUG, "psm: device ID: %04x\n", id));
844
845 return (id);
846 }
847
848 static int
set_mouse_sampling_rate(KBDC kbdc,int rate)849 set_mouse_sampling_rate(KBDC kbdc, int rate)
850 {
851 int res;
852
853 res = send_aux_command_and_data(kbdc, PSMC_SET_SAMPLING_RATE, rate);
854 VLOG(2, (LOG_DEBUG, "psm: SET_SAMPLING_RATE (%d) %04x\n", rate, res));
855
856 return ((res == PSM_ACK) ? rate : -1);
857 }
858
859 static int
set_mouse_scaling(KBDC kbdc,int scale)860 set_mouse_scaling(KBDC kbdc, int scale)
861 {
862 int res;
863
864 switch (scale) {
865 case 1:
866 default:
867 scale = PSMC_SET_SCALING11;
868 break;
869 case 2:
870 scale = PSMC_SET_SCALING21;
871 break;
872 }
873 res = send_aux_command(kbdc, scale);
874 VLOG(2, (LOG_DEBUG, "psm: SET_SCALING%s return code:%04x\n",
875 (scale == PSMC_SET_SCALING21) ? "21" : "11", res));
876
877 return (res == PSM_ACK);
878 }
879
880 /* `val' must be 0 through PSMD_MAX_RESOLUTION */
881 static int
set_mouse_resolution(KBDC kbdc,int val)882 set_mouse_resolution(KBDC kbdc, int val)
883 {
884 int res;
885
886 res = send_aux_command_and_data(kbdc, PSMC_SET_RESOLUTION, val);
887 VLOG(2, (LOG_DEBUG, "psm: SET_RESOLUTION (%d) %04x\n", val, res));
888
889 return ((res == PSM_ACK) ? val : -1);
890 }
891
892 /*
893 * NOTE: once `set_mouse_mode()' is called, the mouse device must be
894 * re-enabled by calling `enable_aux_dev()'
895 */
896 static int
set_mouse_mode(KBDC kbdc)897 set_mouse_mode(KBDC kbdc)
898 {
899 int res;
900
901 res = send_aux_command(kbdc, PSMC_SET_STREAM_MODE);
902 VLOG(2, (LOG_DEBUG, "psm: SET_STREAM_MODE return code:%04x\n", res));
903
904 return (res == PSM_ACK);
905 }
906
907 static int
get_mouse_buttons(KBDC kbdc)908 get_mouse_buttons(KBDC kbdc)
909 {
910 int c = 2; /* assume two buttons by default */
911 int status[3];
912
913 /*
914 * NOTE: a special sequence to obtain Logitech Mouse specific
915 * information: set resolution to 25 ppi, set scaling to 1:1, set
916 * scaling to 1:1, set scaling to 1:1. Then the second byte of the
917 * mouse status bytes is the number of available buttons.
918 * Some manufactures also support this sequence.
919 */
920 if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
921 return (c);
922 if (set_mouse_scaling(kbdc, 1) && set_mouse_scaling(kbdc, 1) &&
923 set_mouse_scaling(kbdc, 1) &&
924 get_mouse_status(kbdc, status, 0, 3) >= 3 && status[1] != 0)
925 return (status[1]);
926 return (c);
927 }
928
929 /* misc subroutines */
930 /*
931 * Someday, I will get the complete list of valid pointing devices and
932 * their IDs... XXX
933 */
934 static int
is_a_mouse(int id)935 is_a_mouse(int id)
936 {
937 #if 0
938 static int valid_ids[] = {
939 PSM_MOUSE_ID, /* mouse */
940 PSM_BALLPOINT_ID, /* ballpoint device */
941 PSM_INTELLI_ID, /* Intellimouse */
942 PSM_EXPLORER_ID, /* Intellimouse Explorer */
943 -1 /* end of table */
944 };
945 int i;
946
947 for (i = 0; valid_ids[i] >= 0; ++i)
948 if (valid_ids[i] == id)
949 return (TRUE);
950 return (FALSE);
951 #else
952 return (TRUE);
953 #endif
954 }
955
956 static char *
model_name(int model)957 model_name(int model)
958 {
959 static struct {
960 int model_code;
961 char *model_name;
962 } models[] = {
963 { MOUSE_MODEL_NETSCROLL, "NetScroll" },
964 { MOUSE_MODEL_NET, "NetMouse/NetScroll Optical" },
965 { MOUSE_MODEL_GLIDEPOINT, "GlidePoint" },
966 { MOUSE_MODEL_THINK, "ThinkingMouse" },
967 { MOUSE_MODEL_INTELLI, "IntelliMouse" },
968 { MOUSE_MODEL_MOUSEMANPLUS, "MouseMan+" },
969 { MOUSE_MODEL_VERSAPAD, "VersaPad" },
970 { MOUSE_MODEL_EXPLORER, "IntelliMouse Explorer" },
971 { MOUSE_MODEL_4D, "4D Mouse" },
972 { MOUSE_MODEL_4DPLUS, "4D+ Mouse" },
973 { MOUSE_MODEL_SYNAPTICS, "Synaptics Touchpad" },
974 { MOUSE_MODEL_TRACKPOINT, "IBM/Lenovo TrackPoint" },
975 { MOUSE_MODEL_ELANTECH, "Elantech Touchpad" },
976 { MOUSE_MODEL_GENERIC, "Generic PS/2 mouse" },
977 { MOUSE_MODEL_UNKNOWN, "Unknown" },
978 };
979 int i;
980
981 for (i = 0; models[i].model_code != MOUSE_MODEL_UNKNOWN; ++i)
982 if (models[i].model_code == model)
983 break;
984 return (models[i].model_name);
985 }
986
987 static void
recover_from_error(KBDC kbdc)988 recover_from_error(KBDC kbdc)
989 {
990 /* discard anything left in the output buffer */
991 empty_both_buffers(kbdc, 10);
992
993 #if 0
994 /*
995 * NOTE: KBDC_RESET_KBD may not restore the communication between the
996 * keyboard and the controller.
997 */
998 reset_kbd(kbdc);
999 #else
1000 /*
1001 * NOTE: somehow diagnostic and keyboard port test commands bring the
1002 * keyboard back.
1003 */
1004 if (!test_controller(kbdc))
1005 log(LOG_ERR, "psm: keyboard controller failed.\n");
1006 /* if there isn't a keyboard in the system, the following error is OK */
1007 if (test_kbd_port(kbdc) != 0)
1008 VLOG(1, (LOG_ERR, "psm: keyboard port failed.\n"));
1009 #endif
1010 }
1011
1012 static int
restore_controller(KBDC kbdc,int command_byte)1013 restore_controller(KBDC kbdc, int command_byte)
1014 {
1015 empty_both_buffers(kbdc, 10);
1016
1017 if (!set_controller_command_byte(kbdc, 0xff, command_byte)) {
1018 log(LOG_ERR, "psm: failed to restore the keyboard controller "
1019 "command byte.\n");
1020 empty_both_buffers(kbdc, 10);
1021 return (FALSE);
1022 } else {
1023 empty_both_buffers(kbdc, 10);
1024 return (TRUE);
1025 }
1026 }
1027
1028 /*
1029 * Re-initialize the aux port and device. The aux port must be enabled
1030 * and its interrupt must be disabled before calling this routine.
1031 * The aux device will be disabled before returning.
1032 * The keyboard controller must be locked via `kbdc_lock()' before
1033 * calling this routine.
1034 */
1035 static int
doinitialize(struct psm_softc * sc,mousemode_t * mode)1036 doinitialize(struct psm_softc *sc, mousemode_t *mode)
1037 {
1038 KBDC kbdc = sc->kbdc;
1039 int stat[3];
1040 int i;
1041
1042 switch((i = test_aux_port(kbdc))) {
1043 case 1: /* ignore these errors */
1044 case 2:
1045 case 3:
1046 case PSM_ACK:
1047 if (verbose)
1048 log(LOG_DEBUG,
1049 "psm%d: strange result for test aux port (%d).\n",
1050 sc->unit, i);
1051 /* FALLTHROUGH */
1052 case 0: /* no error */
1053 break;
1054 case -1: /* time out */
1055 default: /* error */
1056 recover_from_error(kbdc);
1057 if (sc->config & PSM_CONFIG_IGNPORTERROR)
1058 break;
1059 log(LOG_ERR, "psm%d: the aux port is not functioning (%d).\n",
1060 sc->unit, i);
1061 return (FALSE);
1062 }
1063
1064 if (sc->config & PSM_CONFIG_NORESET) {
1065 /*
1066 * Don't try to reset the pointing device. It may possibly
1067 * be left in the unknown state, though...
1068 */
1069 } else {
1070 /*
1071 * NOTE: some controllers appears to hang the `keyboard' when
1072 * the aux port doesn't exist and `PSMC_RESET_DEV' is issued.
1073 */
1074 if (!reset_aux_dev(kbdc)) {
1075 recover_from_error(kbdc);
1076 log(LOG_ERR, "psm%d: failed to reset the aux device.\n",
1077 sc->unit);
1078 return (FALSE);
1079 }
1080 }
1081
1082 /*
1083 * both the aux port and the aux device is functioning, see
1084 * if the device can be enabled.
1085 */
1086 if (!enable_aux_dev(kbdc) || !disable_aux_dev(kbdc)) {
1087 log(LOG_ERR, "psm%d: failed to enable the aux device.\n",
1088 sc->unit);
1089 return (FALSE);
1090 }
1091 empty_both_buffers(kbdc, 10); /* remove stray data if any */
1092
1093 /* Re-enable the mouse. */
1094 for (i = 0; vendortype[i].probefunc != NULL; ++i)
1095 if (vendortype[i].model == sc->hw.model)
1096 (*vendortype[i].probefunc)(sc, REINIT);
1097
1098 /* set mouse parameters */
1099 if (mode != (mousemode_t *)NULL) {
1100 if (mode->rate > 0)
1101 mode->rate = set_mouse_sampling_rate(kbdc, mode->rate);
1102 if (mode->resolution >= 0)
1103 mode->resolution =
1104 set_mouse_resolution(kbdc, mode->resolution);
1105 set_mouse_scaling(kbdc, 1);
1106 set_mouse_mode(kbdc);
1107 }
1108
1109 /* Record sync on the next data packet we see. */
1110 sc->flags |= PSM_NEED_SYNCBITS;
1111
1112 /* just check the status of the mouse */
1113 if (get_mouse_status(kbdc, stat, 0, 3) < 3)
1114 log(LOG_DEBUG, "psm%d: failed to get status (doinitialize).\n",
1115 sc->unit);
1116
1117 return (TRUE);
1118 }
1119
1120 static int
doopen(struct psm_softc * sc,int command_byte)1121 doopen(struct psm_softc *sc, int command_byte)
1122 {
1123 int stat[3];
1124 int mux_enabled = FALSE;
1125
1126 /*
1127 * FIXME: Synaptics TouchPad seems to go back to Relative Mode with
1128 * no obvious reason. Thus we check the current mode and restore the
1129 * Absolute Mode if it was cleared.
1130 *
1131 * The previous hack at the end of psmprobe() wasn't efficient when
1132 * moused(8) was restarted.
1133 *
1134 * A Reset (FF) or Set Defaults (F6) command would clear the
1135 * Absolute Mode bit. But a verbose boot or debug.psm.loglevel=5
1136 * doesn't show any evidence of such a command.
1137 */
1138 if (sc->hw.model == MOUSE_MODEL_SYNAPTICS) {
1139 if (sc->muxport != PSM_NOMUX) {
1140 mux_enabled = enable_aux_mux(sc->kbdc) >= 0;
1141 if (mux_enabled)
1142 set_active_aux_mux_port(sc->kbdc, sc->muxport);
1143 else
1144 log(LOG_ERR, "psm%d: failed to enable "
1145 "active multiplexing mode.\n",
1146 sc->unit);
1147 }
1148 mouse_ext_command(sc->kbdc, SYNAPTICS_READ_MODES);
1149 get_mouse_status(sc->kbdc, stat, 0, 3);
1150 if ((SYNAPTICS_VERSION_GE(sc->synhw, 7, 5) ||
1151 stat[1] == 0x47) &&
1152 stat[2] == 0x40) {
1153 synaptics_set_mode(sc, synaptics_preferred_mode(sc));
1154 VLOG(5, (LOG_DEBUG, "psm%d: Synaptis Absolute Mode "
1155 "hopefully restored\n",
1156 sc->unit));
1157 }
1158 if (mux_enabled)
1159 disable_aux_mux(sc->kbdc);
1160 }
1161
1162 /*
1163 * A user may want to disable tap and drag gestures on a Synaptics
1164 * TouchPad when it operates in Relative Mode.
1165 */
1166 if (sc->hw.model == MOUSE_MODEL_GENERIC) {
1167 if (tap_enabled > 0) {
1168 VLOG(2, (LOG_DEBUG,
1169 "psm%d: enable tap and drag gestures\n",
1170 sc->unit));
1171 synaptics_set_mode(sc, synaptics_preferred_mode(sc));
1172 } else if (tap_enabled == 0) {
1173 VLOG(2, (LOG_DEBUG,
1174 "psm%d: disable tap and drag gestures\n",
1175 sc->unit));
1176 synaptics_set_mode(sc, synaptics_preferred_mode(sc));
1177 }
1178 }
1179
1180 /* enable the mouse device */
1181 if (!enable_aux_dev(sc->kbdc)) {
1182 /* MOUSE ERROR: failed to enable the mouse because:
1183 * 1) the mouse is faulty,
1184 * 2) the mouse has been removed(!?)
1185 * In the latter case, the keyboard may have hung, and need
1186 * recovery procedure...
1187 */
1188 recover_from_error(sc->kbdc);
1189 #if 0
1190 /* FIXME: we could reset the mouse here and try to enable
1191 * it again. But it will take long time and it's not a good
1192 * idea to disable the keyboard that long...
1193 */
1194 if (!doinitialize(sc, &sc->mode) || !enable_aux_dev(sc->kbdc)) {
1195 recover_from_error(sc->kbdc);
1196 #else
1197 {
1198 #endif
1199 restore_controller(sc->kbdc, command_byte);
1200 /* mark this device is no longer available */
1201 sc->state &= ~PSM_VALID;
1202 log(LOG_ERR,
1203 "psm%d: failed to enable the device (doopen).\n",
1204 sc->unit);
1205 return (EIO);
1206 }
1207 }
1208
1209 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
1210 log(LOG_DEBUG, "psm%d: failed to get status (doopen).\n",
1211 sc->unit);
1212
1213 /* enable the aux port and interrupt */
1214 if (!set_controller_command_byte(sc->kbdc,
1215 kbdc_get_device_mask(sc->kbdc),
1216 (command_byte & KBD_KBD_CONTROL_BITS) |
1217 KBD_ENABLE_AUX_PORT | KBD_ENABLE_AUX_INT)) {
1218 /* CONTROLLER ERROR */
1219 disable_aux_dev(sc->kbdc);
1220 restore_controller(sc->kbdc, command_byte);
1221 log(LOG_ERR,
1222 "psm%d: failed to enable the aux interrupt (doopen).\n",
1223 sc->unit);
1224 return (EIO);
1225 }
1226
1227 /* start the watchdog timer */
1228 sc->watchdog = FALSE;
1229 callout_reset(&sc->callout, hz * 2, psmtimeout, sc);
1230
1231 return (0);
1232 }
1233
1234 static int
1235 reinitialize(struct psm_softc *sc, int doinit)
1236 {
1237 int err;
1238 int c;
1239 int s;
1240
1241 /* don't let anybody mess with the aux device */
1242 if (!kbdc_lock(sc->kbdc, TRUE))
1243 return (EIO);
1244 s = spltty();
1245
1246 /* block our watchdog timer */
1247 sc->watchdog = FALSE;
1248 callout_stop(&sc->callout);
1249
1250 /* save the current controller command byte */
1251 empty_both_buffers(sc->kbdc, 10);
1252 c = get_controller_command_byte(sc->kbdc);
1253 VLOG(2, (LOG_DEBUG,
1254 "psm%d: current command byte: %04x (reinitialize).\n",
1255 sc->unit, c));
1256
1257 /* enable the aux port but disable the aux interrupt and the keyboard */
1258 if ((c == -1) || !set_controller_command_byte(sc->kbdc,
1259 kbdc_get_device_mask(sc->kbdc),
1260 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
1261 KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1262 /* CONTROLLER ERROR */
1263 splx(s);
1264 kbdc_lock(sc->kbdc, FALSE);
1265 log(LOG_ERR,
1266 "psm%d: unable to set the command byte (reinitialize).\n",
1267 sc->unit);
1268 return (EIO);
1269 }
1270
1271 /* flush any data */
1272 if (sc->state & PSM_VALID) {
1273 /* this may fail; but never mind... */
1274 disable_aux_dev(sc->kbdc);
1275 empty_aux_buffer(sc->kbdc, 10);
1276 }
1277 flushpackets(sc);
1278 sc->syncerrors = 0;
1279 sc->pkterrors = 0;
1280 memset(&sc->lastinputerr, 0, sizeof(sc->lastinputerr));
1281
1282 /* try to detect the aux device; are you still there? */
1283 err = 0;
1284 if (doinit) {
1285 if (doinitialize(sc, &sc->mode)) {
1286 /* yes */
1287 sc->state |= PSM_VALID;
1288 } else {
1289 /* the device has gone! */
1290 restore_controller(sc->kbdc, c);
1291 sc->state &= ~PSM_VALID;
1292 log(LOG_ERR,
1293 "psm%d: the aux device has gone! (reinitialize).\n",
1294 sc->unit);
1295 err = ENXIO;
1296 }
1297 }
1298 splx(s);
1299
1300 /* restore the driver state */
1301 if ((sc->state & (PSM_OPEN | PSM_EV_OPEN_R | PSM_EV_OPEN_A)) &&
1302 (err == 0)) {
1303 /* enable the aux device and the port again */
1304 err = doopen(sc, c);
1305 if (err != 0)
1306 log(LOG_ERR, "psm%d: failed to enable the device "
1307 "(reinitialize).\n", sc->unit);
1308 } else {
1309 /* restore the keyboard port and disable the aux port */
1310 if (!set_controller_command_byte(sc->kbdc,
1311 kbdc_get_device_mask(sc->kbdc),
1312 (c & KBD_KBD_CONTROL_BITS) |
1313 KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1314 /* CONTROLLER ERROR */
1315 log(LOG_ERR, "psm%d: failed to disable the aux port "
1316 "(reinitialize).\n", sc->unit);
1317 err = EIO;
1318 }
1319 }
1320
1321 kbdc_lock(sc->kbdc, FALSE);
1322 return (err);
1323 }
1324
1325 /* psm driver entry points */
1326
1327 static void
1328 psmidentify(driver_t *driver, device_t parent)
1329 {
1330 device_t psmc;
1331 device_t psm;
1332 u_long irq;
1333 int unit;
1334
1335 unit = device_get_unit(parent);
1336
1337 /* always add at least one child */
1338 psm = BUS_ADD_CHILD(parent, KBDC_RID_AUX, driver->name, unit);
1339 if (psm == NULL)
1340 return;
1341
1342 irq = bus_get_resource_start(psm, SYS_RES_IRQ, KBDC_RID_AUX);
1343 if (irq > 0)
1344 return;
1345
1346 /*
1347 * If the PS/2 mouse device has already been reported by ACPI or
1348 * PnP BIOS, obtain the IRQ resource from it.
1349 * (See psmcpnp_attach() below.)
1350 */
1351 psmc = device_find_child(device_get_parent(parent),
1352 PSMCPNP_DRIVER_NAME, unit);
1353 if (psmc == NULL)
1354 return;
1355 irq = bus_get_resource_start(psmc, SYS_RES_IRQ, 0);
1356 if (irq <= 0)
1357 return;
1358 bus_delete_resource(psmc, SYS_RES_IRQ, 0);
1359 bus_set_resource(psm, SYS_RES_IRQ, KBDC_RID_AUX, irq, 1);
1360 }
1361
1362 #define endprobe(v) do { \
1363 if (bootverbose) \
1364 --verbose; \
1365 kbdc_set_device_mask(sc->kbdc, mask); \
1366 kbdc_lock(sc->kbdc, FALSE); \
1367 return (v); \
1368 } while (0)
1369
1370 static int
1371 psmprobe(device_t dev)
1372 {
1373 int unit = device_get_unit(dev);
1374 struct psm_softc *sc = device_get_softc(dev);
1375 int stat[3];
1376 int command_byte;
1377 int mask;
1378 int rid;
1379 int i;
1380
1381 #if 0
1382 kbdc_debug(TRUE);
1383 #endif
1384
1385 /* see if IRQ is available */
1386 rid = KBDC_RID_AUX;
1387 sc->intr = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
1388 if (sc->intr == NULL) {
1389 if (bootverbose)
1390 device_printf(dev, "unable to allocate IRQ\n");
1391 return (ENXIO);
1392 }
1393 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1394
1395 sc->unit = unit;
1396 sc->kbdc = atkbdc_open(device_get_unit(device_get_parent(dev)));
1397 sc->config = device_get_flags(dev) & PSM_CONFIG_FLAGS;
1398 /* XXX: for backward compatibility */
1399 #if defined(PSM_HOOKRESUME) || defined(PSM_HOOKAPM)
1400 sc->config |=
1401 #ifdef PSM_RESETAFTERSUSPEND
1402 PSM_CONFIG_INITAFTERSUSPEND;
1403 #else
1404 PSM_CONFIG_HOOKRESUME;
1405 #endif
1406 #endif /* PSM_HOOKRESUME | PSM_HOOKAPM */
1407 sc->flags = 0;
1408 sc->muxport = PSM_NOMUX;
1409 if (bootverbose)
1410 ++verbose;
1411
1412 device_set_desc(dev, "PS/2 Mouse");
1413
1414 if (!kbdc_lock(sc->kbdc, TRUE)) {
1415 printf("psm%d: unable to lock the controller.\n", unit);
1416 if (bootverbose)
1417 --verbose;
1418 return (ENXIO);
1419 }
1420
1421 /*
1422 * NOTE: two bits in the command byte controls the operation of the
1423 * aux port (mouse port): the aux port disable bit (bit 5) and the aux
1424 * port interrupt (IRQ 12) enable bit (bit 2).
1425 */
1426
1427 /* discard anything left after the keyboard initialization */
1428 empty_both_buffers(sc->kbdc, 10);
1429
1430 /* save the current command byte; it will be used later */
1431 mask = kbdc_get_device_mask(sc->kbdc) & ~KBD_AUX_CONTROL_BITS;
1432 command_byte = get_controller_command_byte(sc->kbdc);
1433 if (verbose)
1434 printf("psm%d: current command byte:%04x\n", unit,
1435 command_byte);
1436 if (command_byte == -1) {
1437 /* CONTROLLER ERROR */
1438 printf("psm%d: unable to get the current command byte value.\n",
1439 unit);
1440 endprobe(ENXIO);
1441 }
1442
1443 /*
1444 * disable the keyboard port while probing the aux port, which must be
1445 * enabled during this routine
1446 */
1447 if (!set_controller_command_byte(sc->kbdc,
1448 KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
1449 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
1450 KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1451 /*
1452 * this is CONTROLLER ERROR; I don't know how to recover
1453 * from this error...
1454 */
1455 if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1456 restore_controller(sc->kbdc, command_byte);
1457 printf("psm%d: unable to set the command byte.\n", unit);
1458 endprobe(ENXIO);
1459 }
1460 write_controller_command(sc->kbdc, KBDC_ENABLE_AUX_PORT);
1461
1462 /*
1463 * NOTE: `test_aux_port()' is designed to return with zero if the aux
1464 * port exists and is functioning. However, some controllers appears
1465 * to respond with zero even when the aux port doesn't exist. (It may
1466 * be that this is only the case when the controller DOES have the aux
1467 * port but the port is not wired on the motherboard.) The keyboard
1468 * controllers without the port, such as the original AT, are
1469 * supposed to return with an error code or simply time out. In any
1470 * case, we have to continue probing the port even when the controller
1471 * passes this test.
1472 *
1473 * XXX: some controllers erroneously return the error code 1, 2 or 3
1474 * when it has a perfectly functional aux port. We have to ignore
1475 * this error code. Even if the controller HAS error with the aux
1476 * port, it will be detected later...
1477 * XXX: another incompatible controller returns PSM_ACK (0xfa)...
1478 */
1479 switch ((i = test_aux_port(sc->kbdc))) {
1480 case 1: /* ignore these errors */
1481 case 2:
1482 case 3:
1483 case PSM_ACK:
1484 if (verbose)
1485 printf("psm%d: strange result for test aux port "
1486 "(%d).\n", unit, i);
1487 /* FALLTHROUGH */
1488 case 0: /* no error */
1489 break;
1490 case -1: /* time out */
1491 default: /* error */
1492 recover_from_error(sc->kbdc);
1493 if (sc->config & PSM_CONFIG_IGNPORTERROR)
1494 break;
1495 if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1496 restore_controller(sc->kbdc, command_byte);
1497 if (verbose)
1498 printf("psm%d: the aux port is not functioning (%d).\n",
1499 unit, i);
1500 endprobe(ENXIO);
1501 }
1502
1503 if (sc->config & PSM_CONFIG_NORESET) {
1504 /*
1505 * Don't try to reset the pointing device. It may possibly be
1506 * left in an unknown state, though...
1507 */
1508 } else {
1509 /*
1510 * NOTE: some controllers appears to hang the `keyboard' when
1511 * the aux port doesn't exist and `PSMC_RESET_DEV' is issued.
1512 *
1513 * Attempt to reset the controller twice -- this helps
1514 * pierce through some KVM switches. The second reset
1515 * is non-fatal.
1516 */
1517 if (!reset_aux_dev(sc->kbdc)) {
1518 recover_from_error(sc->kbdc);
1519 if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1520 restore_controller(sc->kbdc, command_byte);
1521 if (verbose)
1522 printf("psm%d: failed to reset the aux "
1523 "device.\n", unit);
1524 endprobe(ENXIO);
1525 } else if (!reset_aux_dev(sc->kbdc)) {
1526 recover_from_error(sc->kbdc);
1527 if (verbose >= 2)
1528 printf("psm%d: failed to reset the aux device "
1529 "(2).\n", unit);
1530 }
1531 }
1532
1533 /*
1534 * both the aux port and the aux device are functioning, see if the
1535 * device can be enabled. NOTE: when enabled, the device will start
1536 * sending data; we shall immediately disable the device once we know
1537 * the device can be enabled.
1538 */
1539 if (!enable_aux_dev(sc->kbdc) || !disable_aux_dev(sc->kbdc)) {
1540 /* MOUSE ERROR */
1541 recover_from_error(sc->kbdc);
1542 if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1543 restore_controller(sc->kbdc, command_byte);
1544 if (verbose)
1545 printf("psm%d: failed to enable the aux device.\n",
1546 unit);
1547 endprobe(ENXIO);
1548 }
1549
1550 /* save the default values after reset */
1551 if (get_mouse_status(sc->kbdc, stat, 0, 3) >= 3) {
1552 sc->dflt_mode.rate = sc->mode.rate = stat[2];
1553 sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1554 } else {
1555 sc->dflt_mode.rate = sc->mode.rate = -1;
1556 sc->dflt_mode.resolution = sc->mode.resolution = -1;
1557 }
1558
1559 /* hardware information */
1560 sc->hw.iftype = MOUSE_IF_PS2;
1561
1562 /* verify the device is a mouse */
1563 sc->hw.hwid = get_aux_id(sc->kbdc);
1564 if (!is_a_mouse(sc->hw.hwid)) {
1565 if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1566 restore_controller(sc->kbdc, command_byte);
1567 if (verbose)
1568 printf("psm%d: unknown device type (%d).\n", unit,
1569 sc->hw.hwid);
1570 endprobe(ENXIO);
1571 }
1572 switch (sc->hw.hwid) {
1573 case PSM_BALLPOINT_ID:
1574 sc->hw.type = MOUSE_TRACKBALL;
1575 break;
1576 case PSM_MOUSE_ID:
1577 case PSM_INTELLI_ID:
1578 case PSM_EXPLORER_ID:
1579 case PSM_4DMOUSE_ID:
1580 case PSM_4DPLUS_ID:
1581 sc->hw.type = MOUSE_MOUSE;
1582 break;
1583 default:
1584 sc->hw.type = MOUSE_UNKNOWN;
1585 break;
1586 }
1587
1588 if (sc->config & PSM_CONFIG_NOIDPROBE) {
1589 sc->hw.buttons = 2;
1590 i = GENERIC_MOUSE_ENTRY;
1591 } else {
1592 /* # of buttons */
1593 sc->hw.buttons = get_mouse_buttons(sc->kbdc);
1594
1595 /* other parameters */
1596 for (i = 0; vendortype[i].probefunc != NULL; ++i)
1597 if ((*vendortype[i].probefunc)(sc, PROBE)) {
1598 if (verbose >= 2)
1599 printf("psm%d: found %s\n", unit,
1600 model_name(vendortype[i].model));
1601 break;
1602 }
1603 }
1604
1605 sc->hw.model = vendortype[i].model;
1606
1607 sc->dflt_mode.level = PSM_LEVEL_BASE;
1608 sc->dflt_mode.packetsize = MOUSE_PS2_PACKETSIZE;
1609 sc->dflt_mode.accelfactor = (sc->config & PSM_CONFIG_ACCEL) >> 4;
1610 if (sc->config & PSM_CONFIG_NOCHECKSYNC)
1611 sc->dflt_mode.syncmask[0] = 0;
1612 else
1613 sc->dflt_mode.syncmask[0] = vendortype[i].syncmask;
1614 if (sc->config & PSM_CONFIG_FORCETAP)
1615 sc->dflt_mode.syncmask[0] &= ~MOUSE_PS2_TAP;
1616 sc->dflt_mode.syncmask[1] = 0; /* syncbits */
1617 sc->mode = sc->dflt_mode;
1618 sc->mode.packetsize = vendortype[i].packetsize;
1619
1620 /* set mouse parameters */
1621 #if 0
1622 /*
1623 * A version of Logitech FirstMouse+ won't report wheel movement,
1624 * if SET_DEFAULTS is sent... Don't use this command.
1625 * This fix was found by Takashi Nishida.
1626 */
1627 i = send_aux_command(sc->kbdc, PSMC_SET_DEFAULTS);
1628 if (verbose >= 2)
1629 printf("psm%d: SET_DEFAULTS return code:%04x\n", unit, i);
1630 #endif
1631 if (sc->config & PSM_CONFIG_RESOLUTION)
1632 sc->mode.resolution =
1633 set_mouse_resolution(sc->kbdc,
1634 (sc->config & PSM_CONFIG_RESOLUTION) - 1);
1635 else if (sc->mode.resolution >= 0)
1636 sc->mode.resolution =
1637 set_mouse_resolution(sc->kbdc, sc->dflt_mode.resolution);
1638 if (sc->mode.rate > 0)
1639 sc->mode.rate =
1640 set_mouse_sampling_rate(sc->kbdc, sc->dflt_mode.rate);
1641 set_mouse_scaling(sc->kbdc, 1);
1642
1643 /* Record sync on the next data packet we see. */
1644 sc->flags |= PSM_NEED_SYNCBITS;
1645
1646 /* just check the status of the mouse */
1647 /*
1648 * NOTE: XXX there are some arcane controller/mouse combinations out
1649 * there, which hung the controller unless there is data transmission
1650 * after ACK from the mouse.
1651 */
1652 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
1653 printf("psm%d: failed to get status.\n", unit);
1654 else {
1655 /*
1656 * When in its native mode, some mice operate with different
1657 * default parameters than in the PS/2 compatible mode.
1658 */
1659 sc->dflt_mode.rate = sc->mode.rate = stat[2];
1660 sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1661 }
1662
1663 /* disable the aux port for now... */
1664 if (!set_controller_command_byte(sc->kbdc,
1665 KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
1666 (command_byte & KBD_KBD_CONTROL_BITS) |
1667 KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1668 /*
1669 * this is CONTROLLER ERROR; I don't know the proper way to
1670 * recover from this error...
1671 */
1672 if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1673 restore_controller(sc->kbdc, command_byte);
1674 printf("psm%d: unable to set the command byte.\n", unit);
1675 endprobe(ENXIO);
1676 }
1677
1678 /* done */
1679 kbdc_set_device_mask(sc->kbdc, mask | KBD_AUX_CONTROL_BITS);
1680 kbdc_lock(sc->kbdc, FALSE);
1681 return (0);
1682 }
1683
1684 #ifdef EVDEV_SUPPORT
1685 /* Values are taken from Linux drivers for userland software compatibility */
1686 #define PS2_MOUSE_VENDOR 0x0002
1687 #define PS2_MOUSE_GENERIC_PRODUCT 0x0001
1688 #define PS2_MOUSE_SYNAPTICS_NAME "SynPS/2 Synaptics TouchPad"
1689 #define PS2_MOUSE_SYNAPTICS_PRODUCT 0x0007
1690 #define PS2_MOUSE_TRACKPOINT_NAME "TPPS/2 IBM TrackPoint"
1691 #define PS2_MOUSE_TRACKPOINT_PRODUCT 0x000A
1692 #define PS2_MOUSE_ELANTECH_NAME "ETPS/2 Elantech Touchpad"
1693 #define PS2_MOUSE_ELANTECH_ST_NAME "ETPS/2 Elantech TrackPoint"
1694 #define PS2_MOUSE_ELANTECH_PRODUCT 0x000E
1695
1696 #define ABSINFO_END { ABS_CNT, 0, 0, 0 }
1697
1698 static void
1699 psm_support_abs_bulk(struct evdev_dev *evdev, const uint16_t info[][4])
1700 {
1701 size_t i;
1702
1703 for (i = 0; info[i][0] != ABS_CNT; i++)
1704 evdev_support_abs(evdev, info[i][0], 0, info[i][1], info[i][2],
1705 0, 0, info[i][3]);
1706 }
1707
1708 static void
1709 psm_push_mt_finger(struct psm_softc *sc, int id, const finger_t *f)
1710 {
1711 int y = sc->synhw.minimumYCoord + sc->synhw.maximumYCoord - f->y;
1712
1713 evdev_push_abs(sc->evdev_a, ABS_MT_SLOT, id);
1714 evdev_push_abs(sc->evdev_a, ABS_MT_TRACKING_ID, id);
1715 evdev_push_abs(sc->evdev_a, ABS_MT_POSITION_X, f->x);
1716 evdev_push_abs(sc->evdev_a, ABS_MT_POSITION_Y, y);
1717 evdev_push_abs(sc->evdev_a, ABS_MT_PRESSURE, f->p);
1718 }
1719
1720 static void
1721 psm_push_st_finger(struct psm_softc *sc, const finger_t *f)
1722 {
1723 int y = sc->synhw.minimumYCoord + sc->synhw.maximumYCoord - f->y;
1724
1725 evdev_push_abs(sc->evdev_a, ABS_X, f->x);
1726 evdev_push_abs(sc->evdev_a, ABS_Y, y);
1727 evdev_push_abs(sc->evdev_a, ABS_PRESSURE, f->p);
1728 if (sc->synhw.capPalmDetect)
1729 evdev_push_abs(sc->evdev_a, ABS_TOOL_WIDTH, f->w);
1730 }
1731
1732 static void
1733 psm_release_mt_slot(struct evdev_dev *evdev, int32_t slot)
1734 {
1735
1736 evdev_push_abs(evdev, ABS_MT_SLOT, slot);
1737 evdev_push_abs(evdev, ABS_MT_TRACKING_ID, -1);
1738 }
1739
1740 static int
1741 psm_register(device_t dev, int model_code)
1742 {
1743 struct psm_softc *sc = device_get_softc(dev);
1744 struct evdev_dev *evdev_r;
1745 int error, i, nbuttons, nwheels, product;
1746 bool is_pointing_stick;
1747 const char *name;
1748
1749 name = model_name(model_code);
1750 nbuttons = sc->hw.buttons;
1751 product = PS2_MOUSE_GENERIC_PRODUCT;
1752 nwheels = 0;
1753 is_pointing_stick = false;
1754
1755 switch (model_code) {
1756 case MOUSE_MODEL_TRACKPOINT:
1757 name = PS2_MOUSE_TRACKPOINT_NAME;
1758 product = PS2_MOUSE_TRACKPOINT_PRODUCT;
1759 nbuttons = 3;
1760 is_pointing_stick = true;
1761 break;
1762
1763 case MOUSE_MODEL_ELANTECH:
1764 name = PS2_MOUSE_ELANTECH_ST_NAME;
1765 product = PS2_MOUSE_ELANTECH_PRODUCT;
1766 nbuttons = 3;
1767 is_pointing_stick = true;
1768 break;
1769
1770 case MOUSE_MODEL_MOUSEMANPLUS:
1771 case MOUSE_MODEL_4D:
1772 nwheels = 2;
1773 break;
1774
1775 case MOUSE_MODEL_EXPLORER:
1776 case MOUSE_MODEL_INTELLI:
1777 case MOUSE_MODEL_NET:
1778 case MOUSE_MODEL_NETSCROLL:
1779 case MOUSE_MODEL_4DPLUS:
1780 nwheels = 1;
1781 break;
1782 }
1783
1784 evdev_r = evdev_alloc();
1785 evdev_set_name(evdev_r, name);
1786 evdev_set_phys(evdev_r, device_get_nameunit(dev));
1787 evdev_set_id(evdev_r, BUS_I8042, PS2_MOUSE_VENDOR, product, 0);
1788 evdev_set_methods(evdev_r, sc, &psm_ev_methods_r);
1789
1790 evdev_support_prop(evdev_r, INPUT_PROP_POINTER);
1791 if (is_pointing_stick)
1792 evdev_support_prop(evdev_r, INPUT_PROP_POINTING_STICK);
1793 evdev_support_event(evdev_r, EV_SYN);
1794 evdev_support_event(evdev_r, EV_KEY);
1795 evdev_support_event(evdev_r, EV_REL);
1796 evdev_support_rel(evdev_r, REL_X);
1797 evdev_support_rel(evdev_r, REL_Y);
1798 switch (nwheels) {
1799 case 2:
1800 evdev_support_rel(evdev_r, REL_HWHEEL);
1801 /* FALLTHROUGH */
1802 case 1:
1803 evdev_support_rel(evdev_r, REL_WHEEL);
1804 }
1805 for (i = 0; i < nbuttons; i++)
1806 evdev_support_key(evdev_r, BTN_MOUSE + i);
1807
1808 error = evdev_register_mtx(evdev_r, &Giant);
1809 if (error)
1810 evdev_free(evdev_r);
1811 else
1812 sc->evdev_r = evdev_r;
1813 return (error);
1814 }
1815
1816 static int
1817 psm_register_synaptics(device_t dev)
1818 {
1819 struct psm_softc *sc = device_get_softc(dev);
1820 const uint16_t synaptics_absinfo_st[][4] = {
1821 { ABS_X, sc->synhw.minimumXCoord,
1822 sc->synhw.maximumXCoord, sc->synhw.infoXupmm },
1823 { ABS_Y, sc->synhw.minimumYCoord,
1824 sc->synhw.maximumYCoord, sc->synhw.infoYupmm },
1825 { ABS_PRESSURE, 0, ELANTECH_FINGER_MAX_P, 0 },
1826 ABSINFO_END,
1827 };
1828 const uint16_t synaptics_absinfo_mt[][4] = {
1829 { ABS_MT_SLOT, 0, PSM_FINGERS-1, 0},
1830 { ABS_MT_TRACKING_ID, -1, PSM_FINGERS-1, 0},
1831 { ABS_MT_POSITION_X, sc->synhw.minimumXCoord,
1832 sc->synhw.maximumXCoord, sc->synhw.infoXupmm },
1833 { ABS_MT_POSITION_Y, sc->synhw.minimumYCoord,
1834 sc->synhw.maximumYCoord, sc->synhw.infoYupmm },
1835 { ABS_MT_PRESSURE, 0, ELANTECH_FINGER_MAX_P, 0 },
1836 ABSINFO_END,
1837 };
1838 struct evdev_dev *evdev_a;
1839 int error, i, guest_model;
1840
1841 evdev_a = evdev_alloc();
1842 evdev_set_name(evdev_a, PS2_MOUSE_SYNAPTICS_NAME);
1843 evdev_set_phys(evdev_a, device_get_nameunit(dev));
1844 evdev_set_id(evdev_a, BUS_I8042, PS2_MOUSE_VENDOR,
1845 PS2_MOUSE_SYNAPTICS_PRODUCT, 0);
1846 evdev_set_methods(evdev_a, sc, &psm_ev_methods_a);
1847
1848 evdev_support_event(evdev_a, EV_SYN);
1849 evdev_support_event(evdev_a, EV_KEY);
1850 evdev_support_event(evdev_a, EV_ABS);
1851 evdev_support_prop(evdev_a, INPUT_PROP_POINTER);
1852 if (sc->synhw.capAdvancedGestures)
1853 evdev_support_prop(evdev_a, INPUT_PROP_SEMI_MT);
1854 if (sc->synhw.capClickPad)
1855 evdev_support_prop(evdev_a, INPUT_PROP_BUTTONPAD);
1856 if (sc->synhw.capClickPad && sc->synhw.topButtonPad)
1857 evdev_support_prop(evdev_a, INPUT_PROP_TOPBUTTONPAD);
1858 evdev_support_key(evdev_a, BTN_TOUCH);
1859 evdev_support_nfingers(evdev_a, sc->synhw.capReportsV ? 5 : 3);
1860 psm_support_abs_bulk(evdev_a, synaptics_absinfo_st);
1861 if (sc->synhw.capAdvancedGestures || sc->synhw.capReportsV)
1862 psm_support_abs_bulk(evdev_a, synaptics_absinfo_mt);
1863 if (sc->synhw.capPalmDetect)
1864 evdev_support_abs(evdev_a, ABS_TOOL_WIDTH, 0, 0, 15, 0, 0, 0);
1865 evdev_support_key(evdev_a, BTN_LEFT);
1866 if (!sc->synhw.capClickPad) {
1867 evdev_support_key(evdev_a, BTN_RIGHT);
1868 if (sc->synhw.capExtended && sc->synhw.capMiddle)
1869 evdev_support_key(evdev_a, BTN_MIDDLE);
1870 }
1871 if (sc->synhw.capExtended && sc->synhw.capFourButtons) {
1872 evdev_support_key(evdev_a, BTN_BACK);
1873 evdev_support_key(evdev_a, BTN_FORWARD);
1874 }
1875 if (sc->synhw.capExtended && (sc->synhw.nExtendedButtons > 0))
1876 for (i = 0; i < sc->synhw.nExtendedButtons; i++)
1877 evdev_support_key(evdev_a, BTN_0 + i);
1878
1879 error = evdev_register_mtx(evdev_a, &Giant);
1880 if (!error && (sc->synhw.capPassthrough || sc->muxport != PSM_NOMUX)) {
1881 guest_model = sc->tpinfo.sysctl_tree != NULL ?
1882 MOUSE_MODEL_TRACKPOINT : MOUSE_MODEL_GENERIC;
1883 error = psm_register(dev, guest_model);
1884 }
1885 if (error)
1886 evdev_free(evdev_a);
1887 else
1888 sc->evdev_a = evdev_a;
1889 return (error);
1890 }
1891
1892 static int
1893 psm_register_elantech(device_t dev)
1894 {
1895 struct psm_softc *sc = device_get_softc(dev);
1896 const uint16_t elantech_absinfo[][4] = {
1897 { ABS_X, 0, sc->elanhw.sizex,
1898 sc->elanhw.dpmmx },
1899 { ABS_Y, 0, sc->elanhw.sizey,
1900 sc->elanhw.dpmmy },
1901 { ABS_PRESSURE, 0, ELANTECH_FINGER_MAX_P, 0 },
1902 { ABS_TOOL_WIDTH, 0, ELANTECH_FINGER_MAX_W, 0 },
1903 { ABS_MT_SLOT, 0, ELANTECH_MAX_FINGERS - 1, 0 },
1904 { ABS_MT_TRACKING_ID, -1, ELANTECH_MAX_FINGERS - 1, 0 },
1905 { ABS_MT_POSITION_X, 0, sc->elanhw.sizex,
1906 sc->elanhw.dpmmx },
1907 { ABS_MT_POSITION_Y, 0, sc->elanhw.sizey,
1908 sc->elanhw.dpmmy },
1909 { ABS_MT_PRESSURE, 0, ELANTECH_FINGER_MAX_P, 0 },
1910 { ABS_MT_TOUCH_MAJOR, 0, ELANTECH_FINGER_MAX_W *
1911 sc->elanhw.dptracex, 0 },
1912 ABSINFO_END,
1913 };
1914 struct evdev_dev *evdev_a;
1915 int error;
1916
1917 evdev_a = evdev_alloc();
1918 evdev_set_name(evdev_a, PS2_MOUSE_ELANTECH_NAME);
1919 evdev_set_phys(evdev_a, device_get_nameunit(dev));
1920 evdev_set_id(evdev_a, BUS_I8042, PS2_MOUSE_VENDOR,
1921 PS2_MOUSE_ELANTECH_PRODUCT, 0);
1922 evdev_set_methods(evdev_a, sc, &psm_ev_methods_a);
1923
1924 evdev_support_event(evdev_a, EV_SYN);
1925 evdev_support_event(evdev_a, EV_KEY);
1926 evdev_support_event(evdev_a, EV_ABS);
1927 evdev_support_prop(evdev_a, INPUT_PROP_POINTER);
1928 if (sc->elanhw.issemimt)
1929 evdev_support_prop(evdev_a, INPUT_PROP_SEMI_MT);
1930 if (sc->elanhw.isclickpad)
1931 evdev_support_prop(evdev_a, INPUT_PROP_BUTTONPAD);
1932 evdev_support_key(evdev_a, BTN_TOUCH);
1933 evdev_support_nfingers(evdev_a, ELANTECH_MAX_FINGERS);
1934 evdev_support_key(evdev_a, BTN_LEFT);
1935 if (!sc->elanhw.isclickpad)
1936 evdev_support_key(evdev_a, BTN_RIGHT);
1937 psm_support_abs_bulk(evdev_a, elantech_absinfo);
1938
1939 error = evdev_register_mtx(evdev_a, &Giant);
1940 if (!error && sc->elanhw.hastrackpoint)
1941 error = psm_register(dev, MOUSE_MODEL_ELANTECH);
1942 if (error)
1943 evdev_free(evdev_a);
1944 else
1945 sc->evdev_a = evdev_a;
1946 return (error);
1947 }
1948 #endif
1949
1950 static int
1951 psmattach(device_t dev)
1952 {
1953 struct make_dev_args mda;
1954 int unit = device_get_unit(dev);
1955 struct psm_softc *sc = device_get_softc(dev);
1956 int error;
1957 int rid;
1958
1959 /* Setup initial state */
1960 sc->state = PSM_VALID;
1961 callout_init(&sc->callout, 0);
1962 callout_init(&sc->softcallout, 0);
1963
1964 /* Setup our interrupt handler */
1965 rid = KBDC_RID_AUX;
1966 sc->intr = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
1967 if (sc->intr == NULL)
1968 return (ENXIO);
1969 error = bus_setup_intr(dev, sc->intr, INTR_TYPE_TTY, NULL, psmintr, sc,
1970 &sc->ih);
1971 if (error)
1972 goto out;
1973
1974 /* Done */
1975 make_dev_args_init(&mda);
1976 mda.mda_devsw = &psm_cdevsw;
1977 mda.mda_mode = 0666;
1978 mda.mda_si_drv1 = sc;
1979
1980 if ((error = make_dev_s(&mda, &sc->dev, "psm%d", unit)) != 0)
1981 goto out;
1982 if ((error = make_dev_s(&mda, &sc->bdev, "bpsm%d", unit)) != 0)
1983 goto out;
1984
1985 #ifdef EVDEV_SUPPORT
1986 switch (sc->hw.model) {
1987 case MOUSE_MODEL_SYNAPTICS:
1988 error = psm_register_synaptics(dev);
1989 break;
1990
1991 case MOUSE_MODEL_ELANTECH:
1992 error = psm_register_elantech(dev);
1993 break;
1994
1995 default:
1996 error = psm_register(dev, sc->hw.model);
1997 }
1998
1999 if (error)
2000 goto out;
2001 #endif
2002
2003 /* Some touchpad devices need full reinitialization after suspend. */
2004 switch (sc->hw.model) {
2005 case MOUSE_MODEL_SYNAPTICS:
2006 case MOUSE_MODEL_GLIDEPOINT:
2007 case MOUSE_MODEL_VERSAPAD:
2008 case MOUSE_MODEL_ELANTECH:
2009 sc->config |= PSM_CONFIG_INITAFTERSUSPEND;
2010 break;
2011 default:
2012 if (sc->synhw.infoMajor >= 4 || sc->tphw > 0)
2013 sc->config |= PSM_CONFIG_INITAFTERSUSPEND;
2014 break;
2015 }
2016
2017 /* Elantech trackpad`s sync bit differs from touchpad`s one */
2018 if (sc->hw.model == MOUSE_MODEL_ELANTECH &&
2019 (sc->elanhw.hascrc || sc->elanhw.hastrackpoint)) {
2020 sc->config |= PSM_CONFIG_NOCHECKSYNC;
2021 sc->flags &= ~PSM_NEED_SYNCBITS;
2022 }
2023
2024 if (!verbose)
2025 printf("psm%d: model %s, device ID %d\n",
2026 unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff);
2027 else {
2028 printf("psm%d: model %s, device ID %d-%02x, %d buttons\n",
2029 unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff,
2030 sc->hw.hwid >> 8, sc->hw.buttons);
2031 printf("psm%d: config:%08x, flags:%08x, packet size:%d\n",
2032 unit, sc->config, sc->flags, sc->mode.packetsize);
2033 printf("psm%d: syncmask:%02x, syncbits:%02x%s\n",
2034 unit, sc->mode.syncmask[0], sc->mode.syncmask[1],
2035 sc->config & PSM_CONFIG_NOCHECKSYNC ? " (sync not checked)" : "");
2036 }
2037
2038 if (bootverbose)
2039 --verbose;
2040
2041 out:
2042 if (error != 0) {
2043 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
2044 if (sc->dev != NULL)
2045 destroy_dev(sc->dev);
2046 if (sc->bdev != NULL)
2047 destroy_dev(sc->bdev);
2048 }
2049 return (error);
2050 }
2051
2052 static int
2053 psmdetach(device_t dev)
2054 {
2055 struct psm_softc *sc;
2056 int rid;
2057
2058 sc = device_get_softc(dev);
2059 if (sc->state & PSM_OPEN)
2060 return (EBUSY);
2061
2062 #ifdef EVDEV_SUPPORT
2063 evdev_free(sc->evdev_r);
2064 evdev_free(sc->evdev_a);
2065 #endif
2066
2067 rid = KBDC_RID_AUX;
2068 bus_teardown_intr(dev, sc->intr, sc->ih);
2069 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
2070
2071 destroy_dev(sc->dev);
2072 destroy_dev(sc->bdev);
2073
2074 callout_drain(&sc->callout);
2075 callout_drain(&sc->softcallout);
2076
2077 return (0);
2078 }
2079
2080 #ifdef EVDEV_SUPPORT
2081 static int
2082 psm_ev_open_r(struct evdev_dev *evdev)
2083 {
2084 struct psm_softc *sc = evdev_get_softc(evdev);
2085 int err = 0;
2086
2087 /* Get device data */
2088 if ((sc->state & PSM_VALID) == 0) {
2089 /* the device is no longer valid/functioning */
2090 return (ENXIO);
2091 }
2092
2093 if (!(sc->state & (PSM_OPEN | PSM_EV_OPEN_A)))
2094 err = psmopen(sc);
2095
2096 if (err == 0)
2097 sc->state |= PSM_EV_OPEN_R;
2098
2099 return (err);
2100 }
2101
2102 static int
2103 psm_ev_close_r(struct evdev_dev *evdev)
2104 {
2105 struct psm_softc *sc = evdev_get_softc(evdev);
2106 int err = 0;
2107
2108 sc->state &= ~PSM_EV_OPEN_R;
2109
2110 if (sc->state & (PSM_OPEN | PSM_EV_OPEN_A))
2111 return (0);
2112
2113 if (sc->state & PSM_VALID)
2114 err = psmclose(sc);
2115
2116 return (err);
2117 }
2118
2119 static int
2120 psm_ev_open_a(struct evdev_dev *evdev)
2121 {
2122 struct psm_softc *sc = evdev_get_softc(evdev);
2123 int err = 0;
2124
2125 /* Get device data */
2126 if ((sc->state & PSM_VALID) == 0) {
2127 /* the device is no longer valid/functioning */
2128 return (ENXIO);
2129 }
2130
2131 if (!(sc->state & (PSM_OPEN | PSM_EV_OPEN_R)))
2132 err = psmopen(sc);
2133
2134 if (err == 0)
2135 sc->state |= PSM_EV_OPEN_A;
2136
2137 return (err);
2138 }
2139
2140 static int
2141 psm_ev_close_a(struct evdev_dev *evdev)
2142 {
2143 struct psm_softc *sc = evdev_get_softc(evdev);
2144 int err = 0;
2145
2146 sc->state &= ~PSM_EV_OPEN_A;
2147
2148 if (sc->state & (PSM_OPEN | PSM_EV_OPEN_R))
2149 return (0);
2150
2151 if (sc->state & PSM_VALID)
2152 err = psmclose(sc);
2153
2154 return (err);
2155 }
2156 #endif
2157
2158 static int
2159 psm_cdev_open(struct cdev *dev, int flag, int fmt, struct thread *td)
2160 {
2161 struct psm_softc *sc;
2162 int err = 0;
2163
2164 /* Get device data */
2165 sc = dev->si_drv1;
2166 if ((sc == NULL) || (sc->state & PSM_VALID) == 0) {
2167 /* the device is no longer valid/functioning */
2168 return (ENXIO);
2169 }
2170
2171 /* Disallow multiple opens */
2172 if (sc->state & PSM_OPEN)
2173 return (EBUSY);
2174
2175 device_busy(devclass_get_device(psm_devclass, sc->unit));
2176
2177 #ifdef EVDEV_SUPPORT
2178 /* Already opened by evdev */
2179 if (!(sc->state & (PSM_EV_OPEN_R | PSM_EV_OPEN_A)))
2180 #endif
2181 err = psmopen(sc);
2182
2183 if (err == 0)
2184 sc->state |= PSM_OPEN;
2185 else
2186 device_unbusy(devclass_get_device(psm_devclass, sc->unit));
2187
2188 return (err);
2189 }
2190
2191 static int
2192 psm_cdev_close(struct cdev *dev, int flag, int fmt, struct thread *td)
2193 {
2194 struct psm_softc *sc;
2195 int err = 0;
2196
2197 /* Get device data */
2198 sc = dev->si_drv1;
2199 if ((sc == NULL) || (sc->state & PSM_VALID) == 0) {
2200 /* the device is no longer valid/functioning */
2201 return (ENXIO);
2202 }
2203
2204 #ifdef EVDEV_SUPPORT
2205 /* Still opened by evdev */
2206 if (!(sc->state & (PSM_EV_OPEN_R | PSM_EV_OPEN_A)))
2207 #endif
2208 err = psmclose(sc);
2209
2210 if (err == 0) {
2211 sc->state &= ~PSM_OPEN;
2212 /* clean up and sigio requests */
2213 if (sc->async != NULL) {
2214 funsetown(&sc->async);
2215 sc->async = NULL;
2216 }
2217 device_unbusy(devclass_get_device(psm_devclass, sc->unit));
2218 }
2219
2220 return (err);
2221 }
2222
2223 static int
2224 psmopen(struct psm_softc *sc)
2225 {
2226 int command_byte;
2227 int err;
2228 int s;
2229
2230 /* Initialize state */
2231 sc->mode.level = sc->dflt_mode.level;
2232 sc->mode.protocol = sc->dflt_mode.protocol;
2233 sc->watchdog = FALSE;
2234 sc->async = NULL;
2235
2236 /* flush the event queue */
2237 sc->queue.count = 0;
2238 sc->queue.head = 0;
2239 sc->queue.tail = 0;
2240 sc->status.flags = 0;
2241 sc->status.button = 0;
2242 sc->status.obutton = 0;
2243 sc->status.dx = 0;
2244 sc->status.dy = 0;
2245 sc->status.dz = 0;
2246 sc->button = 0;
2247 sc->pqueue_start = 0;
2248 sc->pqueue_end = 0;
2249
2250 /* empty input buffer */
2251 flushpackets(sc);
2252 sc->syncerrors = 0;
2253 sc->pkterrors = 0;
2254
2255 /* don't let timeout routines in the keyboard driver to poll the kbdc */
2256 if (!kbdc_lock(sc->kbdc, TRUE))
2257 return (EIO);
2258
2259 /* save the current controller command byte */
2260 s = spltty();
2261 command_byte = get_controller_command_byte(sc->kbdc);
2262
2263 /* enable the aux port and temporalily disable the keyboard */
2264 if (command_byte == -1 || !set_controller_command_byte(sc->kbdc,
2265 kbdc_get_device_mask(sc->kbdc),
2266 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
2267 KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2268 /* CONTROLLER ERROR; do you know how to get out of this? */
2269 kbdc_lock(sc->kbdc, FALSE);
2270 splx(s);
2271 log(LOG_ERR,
2272 "psm%d: unable to set the command byte (psmopen).\n",
2273 sc->unit);
2274 return (EIO);
2275 }
2276 /*
2277 * Now that the keyboard controller is told not to generate
2278 * the keyboard and mouse interrupts, call `splx()' to allow
2279 * the other tty interrupts. The clock interrupt may also occur,
2280 * but timeout routines will be blocked by the poll flag set
2281 * via `kbdc_lock()'
2282 */
2283 splx(s);
2284
2285 /* enable the mouse device */
2286 err = doopen(sc, command_byte);
2287
2288 /* done */
2289 kbdc_lock(sc->kbdc, FALSE);
2290 return (err);
2291 }
2292
2293 static int
2294 psmclose(struct psm_softc *sc)
2295 {
2296 int stat[3];
2297 int command_byte;
2298 int s;
2299
2300 /* don't let timeout routines in the keyboard driver to poll the kbdc */
2301 if (!kbdc_lock(sc->kbdc, TRUE))
2302 return (EIO);
2303
2304 /* save the current controller command byte */
2305 s = spltty();
2306 command_byte = get_controller_command_byte(sc->kbdc);
2307 if (command_byte == -1) {
2308 kbdc_lock(sc->kbdc, FALSE);
2309 splx(s);
2310 return (EIO);
2311 }
2312
2313 /* disable the aux interrupt and temporalily disable the keyboard */
2314 if (!set_controller_command_byte(sc->kbdc,
2315 kbdc_get_device_mask(sc->kbdc),
2316 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
2317 KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2318 log(LOG_ERR,
2319 "psm%d: failed to disable the aux int (psmclose).\n",
2320 sc->unit);
2321 /* CONTROLLER ERROR;
2322 * NOTE: we shall force our way through. Because the only
2323 * ill effect we shall see is that we may not be able
2324 * to read ACK from the mouse, and it doesn't matter much
2325 * so long as the mouse will accept the DISABLE command.
2326 */
2327 }
2328 splx(s);
2329
2330 /* stop the watchdog timer */
2331 callout_stop(&sc->callout);
2332
2333 /* remove anything left in the output buffer */
2334 empty_aux_buffer(sc->kbdc, 10);
2335
2336 /* disable the aux device, port and interrupt */
2337 if (sc->state & PSM_VALID) {
2338 if (!disable_aux_dev(sc->kbdc)) {
2339 /* MOUSE ERROR;
2340 * NOTE: we don't return (error) and continue,
2341 * pretending we have successfully disabled the device.
2342 * It's OK because the interrupt routine will discard
2343 * any data from the mouse hereafter.
2344 */
2345 log(LOG_ERR,
2346 "psm%d: failed to disable the device (psmclose).\n",
2347 sc->unit);
2348 }
2349
2350 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
2351 log(LOG_DEBUG,
2352 "psm%d: failed to get status (psmclose).\n",
2353 sc->unit);
2354 }
2355
2356 if (!set_controller_command_byte(sc->kbdc,
2357 kbdc_get_device_mask(sc->kbdc),
2358 (command_byte & KBD_KBD_CONTROL_BITS) |
2359 KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2360 /*
2361 * CONTROLLER ERROR;
2362 * we shall ignore this error; see the above comment.
2363 */
2364 log(LOG_ERR,
2365 "psm%d: failed to disable the aux port (psmclose).\n",
2366 sc->unit);
2367 }
2368
2369 /* remove anything left in the output buffer */
2370 empty_aux_buffer(sc->kbdc, 10);
2371
2372 /* close is almost always successful */
2373 kbdc_lock(sc->kbdc, FALSE);
2374 return (0);
2375 }
2376
2377 static int
2378 tame_mouse(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *status,
2379 u_char *buf)
2380 {
2381 static u_char butmapps2[8] = {
2382 0,
2383 MOUSE_PS2_BUTTON1DOWN,
2384 MOUSE_PS2_BUTTON2DOWN,
2385 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN,
2386 MOUSE_PS2_BUTTON3DOWN,
2387 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON3DOWN,
2388 MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
2389 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN |
2390 MOUSE_PS2_BUTTON3DOWN,
2391 };
2392 static u_char butmapmsc[8] = {
2393 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP |
2394 MOUSE_MSC_BUTTON3UP,
2395 MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
2396 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON3UP,
2397 MOUSE_MSC_BUTTON3UP,
2398 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP,
2399 MOUSE_MSC_BUTTON2UP,
2400 MOUSE_MSC_BUTTON1UP,
2401 0,
2402 };
2403 int mapped;
2404 int i;
2405
2406 if (sc->mode.level == PSM_LEVEL_BASE) {
2407 mapped = status->button & ~MOUSE_BUTTON4DOWN;
2408 if (status->button & MOUSE_BUTTON4DOWN)
2409 mapped |= MOUSE_BUTTON1DOWN;
2410 status->button = mapped;
2411 buf[0] = MOUSE_PS2_SYNC | butmapps2[mapped & MOUSE_STDBUTTONS];
2412 i = imax(imin(status->dx, 255), -256);
2413 if (i < 0)
2414 buf[0] |= MOUSE_PS2_XNEG;
2415 buf[1] = i;
2416 i = imax(imin(status->dy, 255), -256);
2417 if (i < 0)
2418 buf[0] |= MOUSE_PS2_YNEG;
2419 buf[2] = i;
2420 return (MOUSE_PS2_PACKETSIZE);
2421 } else if (sc->mode.level == PSM_LEVEL_STANDARD) {
2422 buf[0] = MOUSE_MSC_SYNC |
2423 butmapmsc[status->button & MOUSE_STDBUTTONS];
2424 i = imax(imin(status->dx, 255), -256);
2425 buf[1] = i >> 1;
2426 buf[3] = i - buf[1];
2427 i = imax(imin(status->dy, 255), -256);
2428 buf[2] = i >> 1;
2429 buf[4] = i - buf[2];
2430 i = imax(imin(status->dz, 127), -128);
2431 buf[5] = (i >> 1) & 0x7f;
2432 buf[6] = (i - (i >> 1)) & 0x7f;
2433 buf[7] = (~status->button >> 3) & 0x7f;
2434 return (MOUSE_SYS_PACKETSIZE);
2435 }
2436 return (pb->inputbytes);
2437 }
2438
2439 static int
2440 psmread(struct cdev *dev, struct uio *uio, int flag)
2441 {
2442 struct psm_softc *sc = dev->si_drv1;
2443 u_char buf[PSM_SMALLBUFSIZE];
2444 int error = 0;
2445 int s;
2446 int l;
2447
2448 if ((sc->state & PSM_VALID) == 0)
2449 return (EIO);
2450
2451 /* block until mouse activity occurred */
2452 s = spltty();
2453 while (sc->queue.count <= 0) {
2454 if (dev != sc->bdev) {
2455 splx(s);
2456 return (EWOULDBLOCK);
2457 }
2458 sc->state |= PSM_ASLP;
2459 error = tsleep(sc, PZERO | PCATCH, "psmrea", 0);
2460 sc->state &= ~PSM_ASLP;
2461 if (error) {
2462 splx(s);
2463 return (error);
2464 } else if ((sc->state & PSM_VALID) == 0) {
2465 /* the device disappeared! */
2466 splx(s);
2467 return (EIO);
2468 }
2469 }
2470 splx(s);
2471
2472 /* copy data to the user land */
2473 while ((sc->queue.count > 0) && (uio->uio_resid > 0)) {
2474 s = spltty();
2475 l = imin(sc->queue.count, uio->uio_resid);
2476 if (l > sizeof(buf))
2477 l = sizeof(buf);
2478 if (l > sizeof(sc->queue.buf) - sc->queue.head) {
2479 bcopy(&sc->queue.buf[sc->queue.head], &buf[0],
2480 sizeof(sc->queue.buf) - sc->queue.head);
2481 bcopy(&sc->queue.buf[0],
2482 &buf[sizeof(sc->queue.buf) - sc->queue.head],
2483 l - (sizeof(sc->queue.buf) - sc->queue.head));
2484 } else
2485 bcopy(&sc->queue.buf[sc->queue.head], &buf[0], l);
2486 sc->queue.count -= l;
2487 sc->queue.head = (sc->queue.head + l) % sizeof(sc->queue.buf);
2488 splx(s);
2489 error = uiomove(buf, l, uio);
2490 if (error)
2491 break;
2492 }
2493
2494 return (error);
2495 }
2496
2497 static int
2498 block_mouse_data(struct psm_softc *sc, int *c)
2499 {
2500 int s;
2501
2502 if (!kbdc_lock(sc->kbdc, TRUE))
2503 return (EIO);
2504
2505 s = spltty();
2506 *c = get_controller_command_byte(sc->kbdc);
2507 if ((*c == -1) || !set_controller_command_byte(sc->kbdc,
2508 kbdc_get_device_mask(sc->kbdc),
2509 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
2510 KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2511 /* this is CONTROLLER ERROR */
2512 splx(s);
2513 kbdc_lock(sc->kbdc, FALSE);
2514 return (EIO);
2515 }
2516
2517 /*
2518 * The device may be in the middle of status data transmission.
2519 * The transmission will be interrupted, thus, incomplete status
2520 * data must be discarded. Although the aux interrupt is disabled
2521 * at the keyboard controller level, at most one aux interrupt
2522 * may have already been pending and a data byte is in the
2523 * output buffer; throw it away. Note that the second argument
2524 * to `empty_aux_buffer()' is zero, so that the call will just
2525 * flush the internal queue.
2526 * `psmintr()' will be invoked after `splx()' if an interrupt is
2527 * pending; it will see no data and returns immediately.
2528 */
2529 empty_aux_buffer(sc->kbdc, 0); /* flush the queue */
2530 read_aux_data_no_wait(sc->kbdc); /* throw away data if any */
2531 flushpackets(sc);
2532 splx(s);
2533
2534 return (0);
2535 }
2536
2537 static void
2538 dropqueue(struct psm_softc *sc)
2539 {
2540
2541 sc->queue.count = 0;
2542 sc->queue.head = 0;
2543 sc->queue.tail = 0;
2544 if ((sc->state & PSM_SOFTARMED) != 0) {
2545 sc->state &= ~PSM_SOFTARMED;
2546 callout_stop(&sc->softcallout);
2547 }
2548 sc->pqueue_start = sc->pqueue_end;
2549 }
2550
2551 static void
2552 flushpackets(struct psm_softc *sc)
2553 {
2554
2555 dropqueue(sc);
2556 bzero(&sc->pqueue, sizeof(sc->pqueue));
2557 }
2558
2559 static int
2560 unblock_mouse_data(struct psm_softc *sc, int c)
2561 {
2562 int error = 0;
2563
2564 /*
2565 * We may have seen a part of status data during `set_mouse_XXX()'.
2566 * they have been queued; flush it.
2567 */
2568 empty_aux_buffer(sc->kbdc, 0);
2569
2570 /* restore ports and interrupt */
2571 if (!set_controller_command_byte(sc->kbdc,
2572 kbdc_get_device_mask(sc->kbdc),
2573 c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
2574 /*
2575 * CONTROLLER ERROR; this is serious, we may have
2576 * been left with the inaccessible keyboard and
2577 * the disabled mouse interrupt.
2578 */
2579 error = EIO;
2580 }
2581
2582 kbdc_lock(sc->kbdc, FALSE);
2583 return (error);
2584 }
2585
2586 static int
2587 psmwrite(struct cdev *dev, struct uio *uio, int flag)
2588 {
2589 struct psm_softc *sc = dev->si_drv1;
2590 u_char buf[PSM_SMALLBUFSIZE];
2591 int error = 0, i, l;
2592
2593 if ((sc->state & PSM_VALID) == 0)
2594 return (EIO);
2595
2596 if (sc->mode.level < PSM_LEVEL_NATIVE)
2597 return (ENODEV);
2598
2599 /* copy data from the user land */
2600 while (uio->uio_resid > 0) {
2601 l = imin(PSM_SMALLBUFSIZE, uio->uio_resid);
2602 error = uiomove(buf, l, uio);
2603 if (error)
2604 break;
2605 for (i = 0; i < l; i++) {
2606 VLOG(4, (LOG_DEBUG, "psm: cmd 0x%x\n", buf[i]));
2607 if (!write_aux_command(sc->kbdc, buf[i])) {
2608 VLOG(2, (LOG_DEBUG,
2609 "psm: cmd 0x%x failed.\n", buf[i]));
2610 return (reinitialize(sc, FALSE));
2611 }
2612 }
2613 }
2614
2615 return (error);
2616 }
2617
2618 static int
2619 psmioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2620 struct thread *td)
2621 {
2622 struct psm_softc *sc = dev->si_drv1;
2623 mousemode_t mode;
2624 mousestatus_t status;
2625 mousedata_t *data;
2626 int stat[3];
2627 int command_byte;
2628 int error = 0;
2629 int s;
2630
2631 /* Perform IOCTL command */
2632 switch (cmd) {
2633
2634 case OLD_MOUSE_GETHWINFO:
2635 s = spltty();
2636 ((old_mousehw_t *)addr)->buttons = sc->hw.buttons;
2637 ((old_mousehw_t *)addr)->iftype = sc->hw.iftype;
2638 ((old_mousehw_t *)addr)->type = sc->hw.type;
2639 ((old_mousehw_t *)addr)->hwid = sc->hw.hwid & 0x00ff;
2640 splx(s);
2641 break;
2642
2643 case MOUSE_GETHWINFO:
2644 s = spltty();
2645 *(mousehw_t *)addr = sc->hw;
2646 if (sc->mode.level == PSM_LEVEL_BASE)
2647 ((mousehw_t *)addr)->model = MOUSE_MODEL_GENERIC;
2648 splx(s);
2649 break;
2650
2651 case MOUSE_SYN_GETHWINFO:
2652 s = spltty();
2653 if (sc->synhw.infoMajor >= 4)
2654 *(synapticshw_t *)addr = sc->synhw;
2655 else
2656 error = EINVAL;
2657 splx(s);
2658 break;
2659
2660 case OLD_MOUSE_GETMODE:
2661 s = spltty();
2662 switch (sc->mode.level) {
2663 case PSM_LEVEL_BASE:
2664 ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2665 break;
2666 case PSM_LEVEL_STANDARD:
2667 ((old_mousemode_t *)addr)->protocol =
2668 MOUSE_PROTO_SYSMOUSE;
2669 break;
2670 case PSM_LEVEL_NATIVE:
2671 ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2672 break;
2673 }
2674 ((old_mousemode_t *)addr)->rate = sc->mode.rate;
2675 ((old_mousemode_t *)addr)->resolution = sc->mode.resolution;
2676 ((old_mousemode_t *)addr)->accelfactor = sc->mode.accelfactor;
2677 splx(s);
2678 break;
2679
2680 case MOUSE_GETMODE:
2681 s = spltty();
2682 *(mousemode_t *)addr = sc->mode;
2683 if ((sc->flags & PSM_NEED_SYNCBITS) != 0) {
2684 ((mousemode_t *)addr)->syncmask[0] = 0;
2685 ((mousemode_t *)addr)->syncmask[1] = 0;
2686 }
2687 ((mousemode_t *)addr)->resolution =
2688 MOUSE_RES_LOW - sc->mode.resolution;
2689 switch (sc->mode.level) {
2690 case PSM_LEVEL_BASE:
2691 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2692 ((mousemode_t *)addr)->packetsize =
2693 MOUSE_PS2_PACKETSIZE;
2694 break;
2695 case PSM_LEVEL_STANDARD:
2696 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
2697 ((mousemode_t *)addr)->packetsize =
2698 MOUSE_SYS_PACKETSIZE;
2699 ((mousemode_t *)addr)->syncmask[0] = MOUSE_SYS_SYNCMASK;
2700 ((mousemode_t *)addr)->syncmask[1] = MOUSE_SYS_SYNC;
2701 break;
2702 case PSM_LEVEL_NATIVE:
2703 /* FIXME: this isn't quite correct... XXX */
2704 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2705 break;
2706 }
2707 splx(s);
2708 break;
2709
2710 case OLD_MOUSE_SETMODE:
2711 case MOUSE_SETMODE:
2712 if (cmd == OLD_MOUSE_SETMODE) {
2713 mode.rate = ((old_mousemode_t *)addr)->rate;
2714 /*
2715 * resolution old I/F new I/F
2716 * default 0 0
2717 * low 1 -2
2718 * medium low 2 -3
2719 * medium high 3 -4
2720 * high 4 -5
2721 */
2722 if (((old_mousemode_t *)addr)->resolution > 0)
2723 mode.resolution =
2724 -((old_mousemode_t *)addr)->resolution - 1;
2725 else
2726 mode.resolution = 0;
2727 mode.accelfactor =
2728 ((old_mousemode_t *)addr)->accelfactor;
2729 mode.level = -1;
2730 } else
2731 mode = *(mousemode_t *)addr;
2732
2733 /* adjust and validate parameters. */
2734 if (mode.rate > UCHAR_MAX)
2735 return (EINVAL);
2736 if (mode.rate == 0)
2737 mode.rate = sc->dflt_mode.rate;
2738 else if (mode.rate == -1)
2739 /* don't change the current setting */
2740 ;
2741 else if (mode.rate < 0)
2742 return (EINVAL);
2743 if (mode.resolution >= UCHAR_MAX)
2744 return (EINVAL);
2745 if (mode.resolution >= 200)
2746 mode.resolution = MOUSE_RES_HIGH;
2747 else if (mode.resolution >= 100)
2748 mode.resolution = MOUSE_RES_MEDIUMHIGH;
2749 else if (mode.resolution >= 50)
2750 mode.resolution = MOUSE_RES_MEDIUMLOW;
2751 else if (mode.resolution > 0)
2752 mode.resolution = MOUSE_RES_LOW;
2753 if (mode.resolution == MOUSE_RES_DEFAULT)
2754 mode.resolution = sc->dflt_mode.resolution;
2755 else if (mode.resolution == -1)
2756 /* don't change the current setting */
2757 ;
2758 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
2759 mode.resolution = MOUSE_RES_LOW - mode.resolution;
2760 if (mode.level == -1)
2761 /* don't change the current setting */
2762 mode.level = sc->mode.level;
2763 else if ((mode.level < PSM_LEVEL_MIN) ||
2764 (mode.level > PSM_LEVEL_MAX))
2765 return (EINVAL);
2766 if (mode.accelfactor == -1)
2767 /* don't change the current setting */
2768 mode.accelfactor = sc->mode.accelfactor;
2769 else if (mode.accelfactor < 0)
2770 return (EINVAL);
2771
2772 /* don't allow anybody to poll the keyboard controller */
2773 error = block_mouse_data(sc, &command_byte);
2774 if (error)
2775 return (error);
2776
2777 /* set mouse parameters */
2778 if (mode.rate > 0)
2779 mode.rate = set_mouse_sampling_rate(sc->kbdc,
2780 mode.rate);
2781 if (mode.resolution >= 0)
2782 mode.resolution =
2783 set_mouse_resolution(sc->kbdc, mode.resolution);
2784 set_mouse_scaling(sc->kbdc, 1);
2785 get_mouse_status(sc->kbdc, stat, 0, 3);
2786
2787 s = spltty();
2788 sc->mode.rate = mode.rate;
2789 sc->mode.resolution = mode.resolution;
2790 sc->mode.accelfactor = mode.accelfactor;
2791 sc->mode.level = mode.level;
2792 splx(s);
2793
2794 unblock_mouse_data(sc, command_byte);
2795 break;
2796
2797 case MOUSE_GETLEVEL:
2798 *(int *)addr = sc->mode.level;
2799 break;
2800
2801 case MOUSE_SETLEVEL:
2802 if ((*(int *)addr < PSM_LEVEL_MIN) ||
2803 (*(int *)addr > PSM_LEVEL_MAX))
2804 return (EINVAL);
2805 sc->mode.level = *(int *)addr;
2806 break;
2807
2808 case MOUSE_GETSTATUS:
2809 s = spltty();
2810 status = sc->status;
2811 sc->status.flags = 0;
2812 sc->status.obutton = sc->status.button;
2813 sc->status.button = 0;
2814 sc->status.dx = 0;
2815 sc->status.dy = 0;
2816 sc->status.dz = 0;
2817 splx(s);
2818 *(mousestatus_t *)addr = status;
2819 break;
2820
2821 case MOUSE_READSTATE:
2822 case MOUSE_READDATA:
2823 data = (mousedata_t *)addr;
2824 if (data->len > sizeof(data->buf)/sizeof(data->buf[0]))
2825 return (EINVAL);
2826
2827 error = block_mouse_data(sc, &command_byte);
2828 if (error)
2829 return (error);
2830 if ((data->len = get_mouse_status(sc->kbdc, data->buf,
2831 (cmd == MOUSE_READDATA) ? 1 : 0, data->len)) <= 0)
2832 error = EIO;
2833 unblock_mouse_data(sc, command_byte);
2834 break;
2835
2836 #if (defined(MOUSE_SETRESOLUTION))
2837 case MOUSE_SETRESOLUTION:
2838 mode.resolution = *(int *)addr;
2839 if (mode.resolution >= UCHAR_MAX)
2840 return (EINVAL);
2841 else if (mode.resolution >= 200)
2842 mode.resolution = MOUSE_RES_HIGH;
2843 else if (mode.resolution >= 100)
2844 mode.resolution = MOUSE_RES_MEDIUMHIGH;
2845 else if (mode.resolution >= 50)
2846 mode.resolution = MOUSE_RES_MEDIUMLOW;
2847 else if (mode.resolution > 0)
2848 mode.resolution = MOUSE_RES_LOW;
2849 if (mode.resolution == MOUSE_RES_DEFAULT)
2850 mode.resolution = sc->dflt_mode.resolution;
2851 else if (mode.resolution == -1)
2852 mode.resolution = sc->mode.resolution;
2853 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
2854 mode.resolution = MOUSE_RES_LOW - mode.resolution;
2855
2856 error = block_mouse_data(sc, &command_byte);
2857 if (error)
2858 return (error);
2859 sc->mode.resolution =
2860 set_mouse_resolution(sc->kbdc, mode.resolution);
2861 if (sc->mode.resolution != mode.resolution)
2862 error = EIO;
2863 unblock_mouse_data(sc, command_byte);
2864 break;
2865 #endif /* MOUSE_SETRESOLUTION */
2866
2867 #if (defined(MOUSE_SETRATE))
2868 case MOUSE_SETRATE:
2869 mode.rate = *(int *)addr;
2870 if (mode.rate > UCHAR_MAX)
2871 return (EINVAL);
2872 if (mode.rate == 0)
2873 mode.rate = sc->dflt_mode.rate;
2874 else if (mode.rate < 0)
2875 mode.rate = sc->mode.rate;
2876
2877 error = block_mouse_data(sc, &command_byte);
2878 if (error)
2879 return (error);
2880 sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
2881 if (sc->mode.rate != mode.rate)
2882 error = EIO;
2883 unblock_mouse_data(sc, command_byte);
2884 break;
2885 #endif /* MOUSE_SETRATE */
2886
2887 #if (defined(MOUSE_SETSCALING))
2888 case MOUSE_SETSCALING:
2889 if ((*(int *)addr <= 0) || (*(int *)addr > 2))
2890 return (EINVAL);
2891
2892 error = block_mouse_data(sc, &command_byte);
2893 if (error)
2894 return (error);
2895 if (!set_mouse_scaling(sc->kbdc, *(int *)addr))
2896 error = EIO;
2897 unblock_mouse_data(sc, command_byte);
2898 break;
2899 #endif /* MOUSE_SETSCALING */
2900
2901 #if (defined(MOUSE_GETHWID))
2902 case MOUSE_GETHWID:
2903 error = block_mouse_data(sc, &command_byte);
2904 if (error)
2905 return (error);
2906 sc->hw.hwid &= ~0x00ff;
2907 sc->hw.hwid |= get_aux_id(sc->kbdc);
2908 *(int *)addr = sc->hw.hwid & 0x00ff;
2909 unblock_mouse_data(sc, command_byte);
2910 break;
2911 #endif /* MOUSE_GETHWID */
2912
2913 case FIONBIO:
2914 case FIOASYNC:
2915 break;
2916 case FIOSETOWN:
2917 error = fsetown(*(int *)addr, &sc->async);
2918 break;
2919 case FIOGETOWN:
2920 *(int *) addr = fgetown(&sc->async);
2921 break;
2922 default:
2923 return (ENOTTY);
2924 }
2925
2926 return (error);
2927 }
2928
2929 static void
2930 psmtimeout(void *arg)
2931 {
2932 struct psm_softc *sc;
2933 int s;
2934
2935 sc = (struct psm_softc *)arg;
2936 s = spltty();
2937 if (sc->watchdog && kbdc_lock(sc->kbdc, TRUE)) {
2938 VLOG(6, (LOG_DEBUG, "psm%d: lost interrupt?\n", sc->unit));
2939 psmintr(sc);
2940 kbdc_lock(sc->kbdc, FALSE);
2941 }
2942 sc->watchdog = TRUE;
2943 splx(s);
2944 callout_reset(&sc->callout, hz, psmtimeout, sc);
2945 }
2946
2947 /* Add all sysctls under the debug.psm and hw.psm nodes */
2948 static SYSCTL_NODE(_debug, OID_AUTO, psm, CTLFLAG_RD, 0, "ps/2 mouse");
2949 static SYSCTL_NODE(_hw, OID_AUTO, psm, CTLFLAG_RD, 0, "ps/2 mouse");
2950
2951 SYSCTL_INT(_debug_psm, OID_AUTO, loglevel, CTLFLAG_RWTUN, &verbose, 0,
2952 "Verbosity level");
2953
2954 static int psmhz = 20;
2955 SYSCTL_INT(_debug_psm, OID_AUTO, hz, CTLFLAG_RW, &psmhz, 0,
2956 "Frequency of the softcallout (in hz)");
2957 static int psmerrsecs = 2;
2958 SYSCTL_INT(_debug_psm, OID_AUTO, errsecs, CTLFLAG_RW, &psmerrsecs, 0,
2959 "Number of seconds during which packets will dropped after a sync error");
2960 static int psmerrusecs = 0;
2961 SYSCTL_INT(_debug_psm, OID_AUTO, errusecs, CTLFLAG_RW, &psmerrusecs, 0,
2962 "Microseconds to add to psmerrsecs");
2963 static int psmsecs = 0;
2964 SYSCTL_INT(_debug_psm, OID_AUTO, secs, CTLFLAG_RW, &psmsecs, 0,
2965 "Max number of seconds between soft interrupts");
2966 static int psmusecs = 500000;
2967 SYSCTL_INT(_debug_psm, OID_AUTO, usecs, CTLFLAG_RW, &psmusecs, 0,
2968 "Microseconds to add to psmsecs");
2969 static int pkterrthresh = 2;
2970 SYSCTL_INT(_debug_psm, OID_AUTO, pkterrthresh, CTLFLAG_RW, &pkterrthresh, 0,
2971 "Number of error packets allowed before reinitializing the mouse");
2972
2973 SYSCTL_INT(_hw_psm, OID_AUTO, tap_enabled, CTLFLAG_RWTUN, &tap_enabled, 0,
2974 "Enable tap and drag gestures");
2975 static int tap_threshold = PSM_TAP_THRESHOLD;
2976 SYSCTL_INT(_hw_psm, OID_AUTO, tap_threshold, CTLFLAG_RW, &tap_threshold, 0,
2977 "Button tap threshold");
2978 static int tap_timeout = PSM_TAP_TIMEOUT;
2979 SYSCTL_INT(_hw_psm, OID_AUTO, tap_timeout, CTLFLAG_RW, &tap_timeout, 0,
2980 "Tap timeout for touchpads");
2981
2982 /* Tunables */
2983 SYSCTL_INT(_hw_psm, OID_AUTO, synaptics_support, CTLFLAG_RDTUN,
2984 &synaptics_support, 0, "Enable support for Synaptics touchpads");
2985
2986 SYSCTL_INT(_hw_psm, OID_AUTO, trackpoint_support, CTLFLAG_RDTUN,
2987 &trackpoint_support, 0, "Enable support for IBM/Lenovo TrackPoint");
2988
2989 SYSCTL_INT(_hw_psm, OID_AUTO, elantech_support, CTLFLAG_RDTUN,
2990 &elantech_support, 0, "Enable support for Elantech touchpads");
2991
2992 SYSCTL_INT(_hw_psm, OID_AUTO, mux_disabled, CTLFLAG_RDTUN,
2993 &mux_disabled, 0, "Disable active multiplexing");
2994
2995 static void
2996 psmintr(void *arg)
2997 {
2998 struct psm_softc *sc = arg;
2999 struct timeval now;
3000 int c;
3001 packetbuf_t *pb;
3002
3003 if (aux_mux_is_enabled(sc->kbdc))
3004 VLOG(2, (LOG_DEBUG, "psmintr: active multiplexing mode is not "
3005 "supported!\n"));
3006
3007 /* read until there is nothing to read */
3008 while((c = read_aux_data_no_wait(sc->kbdc)) != -1) {
3009 pb = &sc->pqueue[sc->pqueue_end];
3010
3011 /* discard the byte if the device is not open */
3012 if (!(sc->state & (PSM_OPEN | PSM_EV_OPEN_R | PSM_EV_OPEN_A)))
3013 continue;
3014
3015 getmicrouptime(&now);
3016 if ((pb->inputbytes > 0) &&
3017 timevalcmp(&now, &sc->inputtimeout, >)) {
3018 VLOG(3, (LOG_DEBUG, "psmintr: delay too long; "
3019 "resetting byte count\n"));
3020 pb->inputbytes = 0;
3021 sc->syncerrors = 0;
3022 sc->pkterrors = 0;
3023 }
3024 sc->inputtimeout.tv_sec = PSM_INPUT_TIMEOUT / 1000000;
3025 sc->inputtimeout.tv_usec = PSM_INPUT_TIMEOUT % 1000000;
3026 timevaladd(&sc->inputtimeout, &now);
3027
3028 pb->ipacket[pb->inputbytes++] = c;
3029
3030 if (sc->mode.level == PSM_LEVEL_NATIVE) {
3031 VLOG(4, (LOG_DEBUG, "psmintr: %02x\n", pb->ipacket[0]));
3032 sc->syncerrors = 0;
3033 sc->pkterrors = 0;
3034 goto next;
3035 } else {
3036 if (pb->inputbytes < sc->mode.packetsize)
3037 continue;
3038
3039 VLOG(4, (LOG_DEBUG,
3040 "psmintr: %02x %02x %02x %02x %02x %02x\n",
3041 pb->ipacket[0], pb->ipacket[1], pb->ipacket[2],
3042 pb->ipacket[3], pb->ipacket[4], pb->ipacket[5]));
3043 }
3044
3045 c = pb->ipacket[0];
3046
3047 if ((sc->flags & PSM_NEED_SYNCBITS) != 0) {
3048 sc->mode.syncmask[1] = (c & sc->mode.syncmask[0]);
3049 sc->flags &= ~PSM_NEED_SYNCBITS;
3050 VLOG(2, (LOG_DEBUG,
3051 "psmintr: Sync bytes now %04x,%04x\n",
3052 sc->mode.syncmask[0], sc->mode.syncmask[1]));
3053 } else if ((sc->config & PSM_CONFIG_NOCHECKSYNC) == 0 &&
3054 (c & sc->mode.syncmask[0]) != sc->mode.syncmask[1]) {
3055 VLOG(3, (LOG_DEBUG, "psmintr: out of sync "
3056 "(%04x != %04x) %d cmds since last error.\n",
3057 c & sc->mode.syncmask[0], sc->mode.syncmask[1],
3058 sc->cmdcount - sc->lasterr));
3059 sc->lasterr = sc->cmdcount;
3060 /*
3061 * The sync byte test is a weak measure of packet
3062 * validity. Conservatively discard any input yet
3063 * to be seen by userland when we detect a sync
3064 * error since there is a good chance some of
3065 * the queued packets have undetected errors.
3066 */
3067 dropqueue(sc);
3068 if (sc->syncerrors == 0)
3069 sc->pkterrors++;
3070 ++sc->syncerrors;
3071 sc->lastinputerr = now;
3072 if (sc->syncerrors >= sc->mode.packetsize * 2 ||
3073 sc->pkterrors >= pkterrthresh) {
3074 /*
3075 * If we've failed to find a single sync byte
3076 * in 2 packets worth of data, or we've seen
3077 * persistent packet errors during the
3078 * validation period, reinitialize the mouse
3079 * in hopes of returning it to the expected
3080 * mode.
3081 */
3082 VLOG(3, (LOG_DEBUG,
3083 "psmintr: reset the mouse.\n"));
3084 reinitialize(sc, TRUE);
3085 } else if (sc->syncerrors == sc->mode.packetsize) {
3086 /*
3087 * Try a soft reset after searching for a sync
3088 * byte through a packet length of bytes.
3089 */
3090 VLOG(3, (LOG_DEBUG,
3091 "psmintr: re-enable the mouse.\n"));
3092 pb->inputbytes = 0;
3093 disable_aux_dev(sc->kbdc);
3094 enable_aux_dev(sc->kbdc);
3095 } else {
3096 VLOG(3, (LOG_DEBUG,
3097 "psmintr: discard a byte (%d)\n",
3098 sc->syncerrors));
3099 pb->inputbytes--;
3100 bcopy(&pb->ipacket[1], &pb->ipacket[0],
3101 pb->inputbytes);
3102 }
3103 continue;
3104 }
3105
3106 /*
3107 * We have what appears to be a valid packet.
3108 * Reset the error counters.
3109 */
3110 sc->syncerrors = 0;
3111
3112 /*
3113 * Drop even good packets if they occur within a timeout
3114 * period of a sync error. This allows the detection of
3115 * a change in the mouse's packet mode without exposing
3116 * erratic mouse behavior to the user. Some KVMs forget
3117 * enhanced mouse modes during switch events.
3118 */
3119 if (!timeelapsed(&sc->lastinputerr, psmerrsecs, psmerrusecs,
3120 &now)) {
3121 pb->inputbytes = 0;
3122 continue;
3123 }
3124
3125 /*
3126 * Now that we're out of the validation period, reset
3127 * the packet error count.
3128 */
3129 sc->pkterrors = 0;
3130
3131 sc->cmdcount++;
3132 next:
3133 if (++sc->pqueue_end >= PSM_PACKETQUEUE)
3134 sc->pqueue_end = 0;
3135 /*
3136 * If we've filled the queue then call the softintr ourselves,
3137 * otherwise schedule the interrupt for later.
3138 */
3139 if (!timeelapsed(&sc->lastsoftintr, psmsecs, psmusecs, &now) ||
3140 (sc->pqueue_end == sc->pqueue_start)) {
3141 if ((sc->state & PSM_SOFTARMED) != 0) {
3142 sc->state &= ~PSM_SOFTARMED;
3143 callout_stop(&sc->softcallout);
3144 }
3145 psmsoftintr(arg);
3146 } else if ((sc->state & PSM_SOFTARMED) == 0) {
3147 sc->state |= PSM_SOFTARMED;
3148 callout_reset(&sc->softcallout,
3149 psmhz < 1 ? 1 : (hz/psmhz), psmsoftintr, arg);
3150 }
3151 }
3152 }
3153
3154 static void
3155 proc_mmanplus(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
3156 int *x, int *y, int *z)
3157 {
3158
3159 /*
3160 * PS2++ protocol packet
3161 *
3162 * b7 b6 b5 b4 b3 b2 b1 b0
3163 * byte 1: * 1 p3 p2 1 * * *
3164 * byte 2: c1 c2 p1 p0 d1 d0 1 0
3165 *
3166 * p3-p0: packet type
3167 * c1, c2: c1 & c2 == 1, if p2 == 0
3168 * c1 & c2 == 0, if p2 == 1
3169 *
3170 * packet type: 0 (device type)
3171 * See comments in enable_mmanplus() below.
3172 *
3173 * packet type: 1 (wheel data)
3174 *
3175 * b7 b6 b5 b4 b3 b2 b1 b0
3176 * byte 3: h * B5 B4 s d2 d1 d0
3177 *
3178 * h: 1, if horizontal roller data
3179 * 0, if vertical roller data
3180 * B4, B5: button 4 and 5
3181 * s: sign bit
3182 * d2-d0: roller data
3183 *
3184 * packet type: 2 (reserved)
3185 */
3186 if (((pb->ipacket[0] & MOUSE_PS2PLUS_SYNCMASK) == MOUSE_PS2PLUS_SYNC) &&
3187 (abs(*x) > 191) && MOUSE_PS2PLUS_CHECKBITS(pb->ipacket)) {
3188 /*
3189 * the extended data packet encodes button
3190 * and wheel events
3191 */
3192 switch (MOUSE_PS2PLUS_PACKET_TYPE(pb->ipacket)) {
3193 case 1:
3194 /* wheel data packet */
3195 *x = *y = 0;
3196 if (pb->ipacket[2] & 0x80) {
3197 /* XXX horizontal roller count - ignore it */
3198 ;
3199 } else {
3200 /* vertical roller count */
3201 *z = (pb->ipacket[2] & MOUSE_PS2PLUS_ZNEG) ?
3202 (pb->ipacket[2] & 0x0f) - 16 :
3203 (pb->ipacket[2] & 0x0f);
3204 }
3205 ms->button |= (pb->ipacket[2] &
3206 MOUSE_PS2PLUS_BUTTON4DOWN) ?
3207 MOUSE_BUTTON4DOWN : 0;
3208 ms->button |= (pb->ipacket[2] &
3209 MOUSE_PS2PLUS_BUTTON5DOWN) ?
3210 MOUSE_BUTTON5DOWN : 0;
3211 break;
3212 case 2:
3213 /*
3214 * this packet type is reserved by
3215 * Logitech...
3216 */
3217 /*
3218 * IBM ScrollPoint Mouse uses this
3219 * packet type to encode both vertical
3220 * and horizontal scroll movement.
3221 */
3222 *x = *y = 0;
3223 /* horizontal count */
3224 if (pb->ipacket[2] & 0x0f)
3225 *z = (pb->ipacket[2] & MOUSE_SPOINT_WNEG) ?
3226 -2 : 2;
3227 /* vertical count */
3228 if (pb->ipacket[2] & 0xf0)
3229 *z = (pb->ipacket[2] & MOUSE_SPOINT_ZNEG) ?
3230 -1 : 1;
3231 break;
3232 case 0:
3233 /* device type packet - shouldn't happen */
3234 /* FALLTHROUGH */
3235 default:
3236 *x = *y = 0;
3237 ms->button = ms->obutton;
3238 VLOG(1, (LOG_DEBUG, "psmintr: unknown PS2++ packet "
3239 "type %d: 0x%02x 0x%02x 0x%02x\n",
3240 MOUSE_PS2PLUS_PACKET_TYPE(pb->ipacket),
3241 pb->ipacket[0], pb->ipacket[1], pb->ipacket[2]));
3242 break;
3243 }
3244 } else {
3245 /* preserve button states */
3246 ms->button |= ms->obutton & MOUSE_EXTBUTTONS;
3247 }
3248 }
3249
3250 static int
3251 proc_synaptics(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
3252 int *x, int *y, int *z)
3253 {
3254 static int touchpad_buttons;
3255 static int guest_buttons;
3256 static int ew_finger_count;
3257 static finger_t f[PSM_FINGERS];
3258 int w, id, nfingers, palm, ewcode, extended_buttons, clickpad_pressed;
3259
3260 extended_buttons = 0;
3261
3262 /* TouchPad PS/2 absolute mode message format with capFourButtons:
3263 *
3264 * Bits: 7 6 5 4 3 2 1 0 (LSB)
3265 * ------------------------------------------------
3266 * ipacket[0]: 1 0 W3 W2 0 W1 R L
3267 * ipacket[1]: Yb Ya Y9 Y8 Xb Xa X9 X8
3268 * ipacket[2]: Z7 Z6 Z5 Z4 Z3 Z2 Z1 Z0
3269 * ipacket[3]: 1 1 Yc Xc 0 W0 D^R U^L
3270 * ipacket[4]: X7 X6 X5 X4 X3 X2 X1 X0
3271 * ipacket[5]: Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
3272 *
3273 * Legend:
3274 * L: left physical mouse button
3275 * R: right physical mouse button
3276 * D: down button
3277 * U: up button
3278 * W: "wrist" value
3279 * X: x position
3280 * Y: y position
3281 * Z: pressure
3282 *
3283 * Without capFourButtons but with nExtendeButtons and/or capMiddle
3284 *
3285 * Bits: 7 6 5 4 3 2 1 0 (LSB)
3286 * ------------------------------------------------------
3287 * ipacket[3]: 1 1 Yc Xc 0 W0 E^R M^L
3288 * ipacket[4]: X7 X6 X5 X4 X3|b7 X2|b5 X1|b3 X0|b1
3289 * ipacket[5]: Y7 Y6 Y5 Y4 Y3|b8 Y2|b6 Y1|b4 Y0|b2
3290 *
3291 * Legend:
3292 * M: Middle physical mouse button
3293 * E: Extended mouse buttons reported instead of low bits of X and Y
3294 * b1-b8: Extended mouse buttons
3295 * Only ((nExtendedButtons + 1) >> 1) bits are used in packet
3296 * 4 and 5, for reading X and Y value they should be zeroed.
3297 *
3298 * Absolute reportable limits: 0 - 6143.
3299 * Typical bezel limits: 1472 - 5472.
3300 * Typical edge marings: 1632 - 5312.
3301 *
3302 * w = 3 Passthrough Packet
3303 *
3304 * Byte 2,5,6 == Byte 1,2,3 of "Guest"
3305 */
3306
3307 if (!synaptics_support)
3308 return (0);
3309
3310 /* Sanity check for out of sync packets. */
3311 if ((pb->ipacket[0] & 0xc8) != 0x80 ||
3312 (pb->ipacket[3] & 0xc8) != 0xc0)
3313 return (-1);
3314
3315 *x = *y = 0;
3316 ms->button = ms->obutton;
3317
3318 /*
3319 * Pressure value.
3320 * Interpretation:
3321 * z = 0 No finger contact
3322 * z = 10 Finger hovering near the pad
3323 * z = 30 Very light finger contact
3324 * z = 80 Normal finger contact
3325 * z = 110 Very heavy finger contact
3326 * z = 200 Finger lying flat on pad surface
3327 * z = 255 Maximum reportable Z
3328 */
3329 *z = pb->ipacket[2];
3330
3331 /*
3332 * Finger width value
3333 * Interpretation:
3334 * w = 0 Two finger on the pad (capMultiFinger needed)
3335 * w = 1 Three or more fingers (capMultiFinger needed)
3336 * w = 2 Pen (instead of finger) (capPen needed)
3337 * w = 3 Reserved (passthrough?)
3338 * w = 4-7 Finger of normal width (capPalmDetect needed)
3339 * w = 8-14 Very wide finger or palm (capPalmDetect needed)
3340 * w = 15 Maximum reportable width (capPalmDetect needed)
3341 */
3342 /* XXX Is checking capExtended enough? */
3343 if (sc->synhw.capExtended)
3344 w = ((pb->ipacket[0] & 0x30) >> 2) |
3345 ((pb->ipacket[0] & 0x04) >> 1) |
3346 ((pb->ipacket[3] & 0x04) >> 2);
3347 else {
3348 /* Assume a finger of regular width. */
3349 w = 4;
3350 }
3351
3352 switch (w) {
3353 case 3:
3354 /*
3355 * Handle packets from the guest device. See:
3356 * Synaptics PS/2 TouchPad Interfacing Guide, Section 5.1
3357 */
3358 if (sc->synhw.capPassthrough || sc->muxport != PSM_NOMUX) {
3359 *x = ((pb->ipacket[1] & 0x10) ?
3360 pb->ipacket[4] - 256 : pb->ipacket[4]);
3361 *y = ((pb->ipacket[1] & 0x20) ?
3362 pb->ipacket[5] - 256 : pb->ipacket[5]);
3363 *z = 0;
3364
3365 guest_buttons = 0;
3366 if (pb->ipacket[1] & 0x01)
3367 guest_buttons |= MOUSE_BUTTON1DOWN;
3368 if (pb->ipacket[1] & 0x04)
3369 guest_buttons |= MOUSE_BUTTON2DOWN;
3370 if (pb->ipacket[1] & 0x02)
3371 guest_buttons |= MOUSE_BUTTON3DOWN;
3372 #ifdef EVDEV_SUPPORT
3373 if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
3374 evdev_push_rel(sc->evdev_r, REL_X, *x);
3375 evdev_push_rel(sc->evdev_r, REL_Y, -*y);
3376 evdev_push_mouse_btn(sc->evdev_r,
3377 guest_buttons | sc->extended_buttons);
3378 evdev_sync(sc->evdev_r);
3379 }
3380 #endif
3381 ms->button = touchpad_buttons | guest_buttons |
3382 sc->extended_buttons;
3383 }
3384 goto SYNAPTICS_END;
3385
3386 case 2:
3387 /* Handle Extended W mode packets */
3388 ewcode = (pb->ipacket[5] & 0xf0) >> 4;
3389 #if PSM_FINGERS > 1
3390 switch (ewcode) {
3391 case 1:
3392 /* Secondary finger */
3393 if (sc->synhw.capAdvancedGestures)
3394 f[1] = (finger_t) {
3395 .x = (((pb->ipacket[4] & 0x0f) << 8) |
3396 pb->ipacket[1]) << 1,
3397 .y = (((pb->ipacket[4] & 0xf0) << 4) |
3398 pb->ipacket[2]) << 1,
3399 .p = ((pb->ipacket[3] & 0x30) |
3400 (pb->ipacket[5] & 0x0f)) << 1,
3401 .w = PSM_FINGER_DEFAULT_W,
3402 .flags = PSM_FINGER_FUZZY,
3403 };
3404 else if (sc->synhw.capReportsV)
3405 f[1] = (finger_t) {
3406 .x = (((pb->ipacket[4] & 0x0f) << 8) |
3407 (pb->ipacket[1] & 0xfe)) << 1,
3408 .y = (((pb->ipacket[4] & 0xf0) << 4) |
3409 (pb->ipacket[2] & 0xfe)) << 1,
3410 .p = ((pb->ipacket[3] & 0x30) |
3411 (pb->ipacket[5] & 0x0e)) << 1,
3412 .w = (((pb->ipacket[5] & 0x01) << 2) |
3413 ((pb->ipacket[2] & 0x01) << 1) |
3414 (pb->ipacket[1] & 0x01)) + 8,
3415 .flags = PSM_FINGER_FUZZY,
3416 };
3417 break;
3418 case 2:
3419 ew_finger_count = pb->ipacket[1] & 0x0f;
3420 default:
3421 break;
3422 }
3423 #endif
3424 goto SYNAPTICS_END;
3425
3426 case 1:
3427 if (sc->synhw.capReportsV && ew_finger_count > 3) {
3428 nfingers = ew_finger_count;
3429 break;
3430 }
3431 /* FALLTHROUGH */
3432 case 0:
3433 nfingers = w + 2;
3434 break;
3435
3436 default:
3437 nfingers = 1;
3438 }
3439
3440 if (sc->syninfo.touchpad_off)
3441 goto SYNAPTICS_END;
3442
3443 /* Button presses */
3444 touchpad_buttons = 0;
3445 if (pb->ipacket[0] & 0x01)
3446 touchpad_buttons |= MOUSE_BUTTON1DOWN;
3447 if (pb->ipacket[0] & 0x02)
3448 touchpad_buttons |= MOUSE_BUTTON3DOWN;
3449
3450 if (sc->synhw.capExtended && sc->synhw.capFourButtons) {
3451 if ((pb->ipacket[3] ^ pb->ipacket[0]) & 0x01)
3452 touchpad_buttons |= MOUSE_BUTTON4DOWN;
3453 if ((pb->ipacket[3] ^ pb->ipacket[0]) & 0x02)
3454 touchpad_buttons |= MOUSE_BUTTON5DOWN;
3455 } else if (sc->synhw.capExtended && sc->synhw.capMiddle &&
3456 !sc->synhw.capClickPad) {
3457 /* Middle Button */
3458 if ((pb->ipacket[0] ^ pb->ipacket[3]) & 0x01)
3459 touchpad_buttons |= MOUSE_BUTTON2DOWN;
3460 } else if (sc->synhw.capExtended && (sc->synhw.nExtendedButtons > 0)) {
3461 /* Extended Buttons */
3462 if ((pb->ipacket[0] ^ pb->ipacket[3]) & 0x02) {
3463 if (sc->syninfo.directional_scrolls) {
3464 if (pb->ipacket[4] & 0x01)
3465 extended_buttons |= MOUSE_BUTTON4DOWN;
3466 if (pb->ipacket[5] & 0x01)
3467 extended_buttons |= MOUSE_BUTTON5DOWN;
3468 if (pb->ipacket[4] & 0x02)
3469 extended_buttons |= MOUSE_BUTTON6DOWN;
3470 if (pb->ipacket[5] & 0x02)
3471 extended_buttons |= MOUSE_BUTTON7DOWN;
3472 } else {
3473 if (pb->ipacket[4] & 0x01)
3474 extended_buttons |= MOUSE_BUTTON1DOWN;
3475 if (pb->ipacket[5] & 0x01)
3476 extended_buttons |= MOUSE_BUTTON3DOWN;
3477 if (pb->ipacket[4] & 0x02)
3478 extended_buttons |= MOUSE_BUTTON2DOWN;
3479 sc->extended_buttons = extended_buttons;
3480 }
3481
3482 /*
3483 * Zero out bits used by extended buttons to avoid
3484 * misinterpretation of the data absolute position.
3485 *
3486 * The bits represented by
3487 *
3488 * (nExtendedButtons + 1) >> 1
3489 *
3490 * will be masked out in both bytes.
3491 * The mask for n bits is computed with the formula
3492 *
3493 * (1 << n) - 1
3494 */
3495 int maskedbits = 0;
3496 int mask = 0;
3497 maskedbits = (sc->synhw.nExtendedButtons + 1) >> 1;
3498 mask = (1 << maskedbits) - 1;
3499 #ifdef EVDEV_SUPPORT
3500 int i;
3501 if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
3502 if (sc->synhw.capPassthrough) {
3503 evdev_push_mouse_btn(sc->evdev_r,
3504 extended_buttons);
3505 evdev_sync(sc->evdev_r);
3506 }
3507 for (i = 0; i < maskedbits; i++) {
3508 evdev_push_key(sc->evdev_a,
3509 BTN_0 + i * 2,
3510 pb->ipacket[4] & (1 << i));
3511 evdev_push_key(sc->evdev_a,
3512 BTN_0 + i * 2 + 1,
3513 pb->ipacket[5] & (1 << i));
3514 }
3515 }
3516 #endif
3517 pb->ipacket[4] &= ~(mask);
3518 pb->ipacket[5] &= ~(mask);
3519 } else if (!sc->syninfo.directional_scrolls &&
3520 !sc->gesture.in_vscroll) {
3521 /*
3522 * Keep reporting MOUSE DOWN until we get a new packet
3523 * indicating otherwise.
3524 */
3525 extended_buttons |= sc->extended_buttons;
3526 }
3527 }
3528
3529 if (sc->synhw.capReportsV && nfingers > 1)
3530 f[0] = (finger_t) {
3531 .x = ((pb->ipacket[3] & 0x10) << 8) |
3532 ((pb->ipacket[1] & 0x0f) << 8) |
3533 (pb->ipacket[4] & 0xfd),
3534 .y = ((pb->ipacket[3] & 0x20) << 7) |
3535 ((pb->ipacket[1] & 0xf0) << 4) |
3536 (pb->ipacket[5] & 0xfd),
3537 .p = *z & 0xfe,
3538 .w = (((pb->ipacket[2] & 0x01) << 2) |
3539 (pb->ipacket[5] & 0x02) |
3540 ((pb->ipacket[4] & 0x02) >> 1)) + 8,
3541 .flags = PSM_FINGER_FUZZY,
3542 };
3543 else
3544 f[0] = (finger_t) {
3545 .x = ((pb->ipacket[3] & 0x10) << 8) |
3546 ((pb->ipacket[1] & 0x0f) << 8) |
3547 pb->ipacket[4],
3548 .y = ((pb->ipacket[3] & 0x20) << 7) |
3549 ((pb->ipacket[1] & 0xf0) << 4) |
3550 pb->ipacket[5],
3551 .p = *z,
3552 .w = w,
3553 .flags = nfingers > 1 ? PSM_FINGER_FUZZY : 0,
3554 };
3555
3556 /* Ignore hovering and unmeasurable touches */
3557 if (f[0].p < sc->syninfo.min_pressure || f[0].x < 2)
3558 nfingers = 0;
3559
3560 /* Handle ClickPad */
3561 if (sc->synhw.capClickPad) {
3562 clickpad_pressed = (pb->ipacket[0] ^ pb->ipacket[3]) & 0x01;
3563 if (sc->synhw.forcePad) {
3564 /*
3565 * Forcepads erroneously report button click if there
3566 * are 2 or more fingers on the touchpad breaking
3567 * multifinger gestures. To workaround this start
3568 * reporting a click only after 4 consecutive single
3569 * touch packets has been received.
3570 * Skip these packets in case more contacts appear.
3571 */
3572 switch (nfingers) {
3573 case 0:
3574 sc->fpcount = 0;
3575 break;
3576 case 1:
3577 if (clickpad_pressed && sc->fpcount < INT_MAX)
3578 ++sc->fpcount;
3579 /* FALLTHROUGH */
3580 default:
3581 if (!clickpad_pressed)
3582 sc->fpcount = 0;
3583 if (sc->fpcount >= sc->syninfo.window_min)
3584 touchpad_buttons |= MOUSE_BUTTON1DOWN;
3585 }
3586 } else if (clickpad_pressed)
3587 touchpad_buttons |= MOUSE_BUTTON1DOWN;
3588 }
3589
3590 for (id = 0; id < PSM_FINGERS; id++)
3591 if (id >= nfingers)
3592 PSM_FINGER_RESET(f[id]);
3593
3594 #ifdef EVDEV_SUPPORT
3595 if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
3596 for (id = 0; id < PSM_FINGERS; id++) {
3597 if (PSM_FINGER_IS_SET(f[id]))
3598 psm_push_mt_finger(sc, id, &f[id]);
3599 else
3600 psm_release_mt_slot(sc->evdev_a, id);
3601 }
3602 evdev_push_key(sc->evdev_a, BTN_TOUCH, nfingers > 0);
3603 evdev_push_nfingers(sc->evdev_a, nfingers);
3604 if (nfingers > 0)
3605 psm_push_st_finger(sc, &f[0]);
3606 else
3607 evdev_push_abs(sc->evdev_a, ABS_PRESSURE, 0);
3608 evdev_push_mouse_btn(sc->evdev_a, touchpad_buttons);
3609 if (sc->synhw.capExtended && sc->synhw.capFourButtons) {
3610 evdev_push_key(sc->evdev_a, BTN_FORWARD,
3611 touchpad_buttons & MOUSE_BUTTON4DOWN);
3612 evdev_push_key(sc->evdev_a, BTN_BACK,
3613 touchpad_buttons & MOUSE_BUTTON5DOWN);
3614 }
3615 evdev_sync(sc->evdev_a);
3616 }
3617 #endif
3618
3619 ms->button = touchpad_buttons;
3620
3621 palm = psmpalmdetect(sc, &f[0], nfingers);
3622
3623 /* Palm detection doesn't terminate the current action. */
3624 if (!palm)
3625 psmgestures(sc, &f[0], nfingers, ms);
3626
3627 for (id = 0; id < PSM_FINGERS; id++)
3628 psmsmoother(sc, &f[id], id, ms, x, y);
3629
3630 if (palm) {
3631 *x = *y = *z = 0;
3632 ms->button = ms->obutton;
3633 return (0);
3634 }
3635
3636 ms->button |= extended_buttons | guest_buttons;
3637
3638 SYNAPTICS_END:
3639 /*
3640 * Use the extra buttons as a scrollwheel
3641 *
3642 * XXX X.Org uses the Z axis for vertical wheel only,
3643 * whereas moused(8) understands special values to differ
3644 * vertical and horizontal wheels.
3645 *
3646 * xf86-input-mouse needs therefore a small patch to
3647 * understand these special values. Without it, the
3648 * horizontal wheel acts as a vertical wheel in X.Org.
3649 *
3650 * That's why the horizontal wheel is disabled by
3651 * default for now.
3652 */
3653 if (ms->button & MOUSE_BUTTON4DOWN)
3654 *z = -1;
3655 else if (ms->button & MOUSE_BUTTON5DOWN)
3656 *z = 1;
3657 else if (ms->button & MOUSE_BUTTON6DOWN)
3658 *z = -2;
3659 else if (ms->button & MOUSE_BUTTON7DOWN)
3660 *z = 2;
3661 else
3662 *z = 0;
3663 ms->button &= ~(MOUSE_BUTTON4DOWN | MOUSE_BUTTON5DOWN |
3664 MOUSE_BUTTON6DOWN | MOUSE_BUTTON7DOWN);
3665
3666 return (0);
3667 }
3668
3669 static int
3670 proc_synaptics_mux(struct psm_softc *sc, packetbuf_t *pb)
3671 {
3672 int butt;
3673
3674 /*
3675 * Convert 3-byte interleaved mixture of Synaptics and generic mouse
3676 * packets into plain 6-byte Synaptics packet protocol.
3677 * While in hidden multiplexing mode KBC does some editing of the
3678 * packet stream. It remembers the button bits from the last packet
3679 * received from each device, and replaces the button bits of every
3680 * packet with the logical OR of all devices’ most recent button bits.
3681 * This button crosstalk should be filtered out as Synaptics and
3682 * generic mouse encode middle button presses in a different way.
3683 */
3684 switch (pb->ipacket[0] & 0xc0) {
3685 case 0x80: /* First 3 bytes of Synaptics packet */
3686 bcopy(pb->ipacket, sc->muxsave, 3);
3687 /* Compute middle mouse button supression timeout. */
3688 sc->muxmidtimeout.tv_sec = 0;
3689 sc->muxmidtimeout.tv_usec = 50000; /* ~2-3 ints */
3690 timevaladd(&sc->muxmidtimeout, &sc->lastsoftintr);
3691 return (1);
3692
3693 case 0xc0: /* Second 3 bytes of Synaptics packet */
3694 /* Join two 3-bytes absolute packets */
3695 bcopy(pb->ipacket, pb->ipacket + 3, 3);
3696 bcopy(sc->muxsave, pb->ipacket, 3);
3697 /* Prefer trackpoint buttons over touchpad's */
3698 pb->ipacket[0] &= ~(0x08 | sc->muxmsbuttons);
3699 pb->ipacket[3] &= ~(0x08 | sc->muxmsbuttons);
3700 butt = (pb->ipacket[3] & 0x03) << 2 | (pb->ipacket[0] & 0x03);
3701 /* Add hysteresis to remove spurious middle button events */
3702 if (butt != sc->muxtpbuttons && sc->fpcount < 1) {
3703 pb->ipacket[0] &= 0xfc;
3704 pb->ipacket[0] |= sc->muxtpbuttons & 0x03;
3705 pb->ipacket[3] &= 0xfc;
3706 pb->ipacket[3] |= sc->muxtpbuttons >> 2 & 0x03;
3707 ++sc->fpcount;
3708 } else {
3709 sc->fpcount = 0;
3710 sc->muxtpbuttons = butt;
3711 }
3712 /* Filter out impossible w induced by middle trackpoint btn */
3713 if (sc->synhw.capExtended && !sc->synhw.capPassthrough &&
3714 (pb->ipacket[0] & 0x34) == 0x04 &&
3715 (pb->ipacket[3] & 0x04) == 0x04) {
3716 pb->ipacket[0] &= 0xfb;
3717 pb->ipacket[3] &= 0xfb;
3718 }
3719 sc->muxsave[0] &= 0x30;
3720 break;
3721
3722 default: /* Generic mouse (Trackpoint) packet */
3723 /* Filter out middle button events induced by some w values */
3724 if (sc->muxmsbuttons & 0x03 || pb->ipacket[0] & 0x03 ||
3725 (timevalcmp(&sc->lastsoftintr, &sc->muxmidtimeout, <=) &&
3726 (sc->muxsave[0] & 0x30 || sc->muxsave[2] > 8)))
3727 pb->ipacket[0] &= 0xfb;
3728 sc->muxmsbuttons = pb->ipacket[0] & 0x07;
3729 /* Convert to Synaptics pass-through protocol */
3730 pb->ipacket[4] = pb->ipacket[1];
3731 pb->ipacket[5] = pb->ipacket[2];
3732 pb->ipacket[1] = pb->ipacket[0];
3733 pb->ipacket[2] = 0;
3734 pb->ipacket[0] = 0x84 | (sc->muxtpbuttons & 0x03);
3735 pb->ipacket[3] = 0xc4 | (sc->muxtpbuttons >> 2 & 0x03);
3736 }
3737
3738 VLOG(4, (LOG_DEBUG, "synaptics: %02x %02x %02x %02x %02x %02x\n",
3739 pb->ipacket[0], pb->ipacket[1], pb->ipacket[2],
3740 pb->ipacket[3], pb->ipacket[4], pb->ipacket[5]));
3741
3742 pb->inputbytes = MOUSE_SYNAPTICS_PACKETSIZE;
3743 return (0);
3744 }
3745
3746 static int
3747 psmpalmdetect(struct psm_softc *sc, finger_t *f, int nfingers)
3748 {
3749 if (!(
3750 ((sc->synhw.capMultiFinger || sc->synhw.capAdvancedGestures) &&
3751 !sc->synhw.capReportsV && nfingers > 1) ||
3752 (sc->synhw.capReportsV && nfingers > 2) ||
3753 (sc->synhw.capPalmDetect && f->w <= sc->syninfo.max_width) ||
3754 (!sc->synhw.capPalmDetect && f->p <= sc->syninfo.max_pressure) ||
3755 (sc->synhw.capPen && f->flags & PSM_FINGER_IS_PEN))) {
3756 /*
3757 * We consider the packet irrelevant for the current
3758 * action when:
3759 * - the width isn't comprised in:
3760 * [1; max_width]
3761 * - the pressure isn't comprised in:
3762 * [min_pressure; max_pressure]
3763 * - pen aren't supported but PSM_FINGER_IS_PEN is set
3764 */
3765 VLOG(2, (LOG_DEBUG, "synaptics: palm detected! (%d)\n", f->w));
3766 return (1);
3767 }
3768 return (0);
3769 }
3770
3771 static void
3772 psmgestures(struct psm_softc *sc, finger_t *fingers, int nfingers,
3773 mousestatus_t *ms)
3774 {
3775 smoother_t *smoother;
3776 gesture_t *gest;
3777 finger_t *f;
3778 int y_ok, center_button, center_x, right_button, right_x, i;
3779
3780 f = &fingers[0];
3781 smoother = &sc->smoother[0];
3782 gest = &sc->gesture;
3783
3784 /* Find first active finger. */
3785 if (nfingers > 0) {
3786 for (i = 0; i < PSM_FINGERS; i++) {
3787 if (PSM_FINGER_IS_SET(fingers[i])) {
3788 f = &fingers[i];
3789 smoother = &sc->smoother[i];
3790 break;
3791 }
3792 }
3793 }
3794
3795 /*
3796 * Check pressure to detect a real wanted action on the
3797 * touchpad.
3798 */
3799 if (f->p >= sc->syninfo.min_pressure) {
3800 int x0, y0;
3801 int dxp, dyp;
3802 int start_x, start_y;
3803 int queue_len;
3804 int margin_top, margin_right, margin_bottom, margin_left;
3805 int window_min, window_max;
3806 int vscroll_hor_area, vscroll_ver_area;
3807 int two_finger_scroll;
3808 int max_x, max_y;
3809 int three_finger_drag;
3810
3811 /* Read sysctl. */
3812 /* XXX Verify values? */
3813 margin_top = sc->syninfo.margin_top;
3814 margin_right = sc->syninfo.margin_right;
3815 margin_bottom = sc->syninfo.margin_bottom;
3816 margin_left = sc->syninfo.margin_left;
3817 window_min = sc->syninfo.window_min;
3818 window_max = sc->syninfo.window_max;
3819 vscroll_hor_area = sc->syninfo.vscroll_hor_area;
3820 vscroll_ver_area = sc->syninfo.vscroll_ver_area;
3821 two_finger_scroll = sc->syninfo.two_finger_scroll;
3822 max_x = sc->syninfo.max_x;
3823 max_y = sc->syninfo.max_y;
3824 three_finger_drag = sc->syninfo.three_finger_drag;
3825 /* Read current absolute position. */
3826 x0 = f->x;
3827 y0 = f->y;
3828
3829 /*
3830 * Limit the coordinates to the specified margins because
3831 * this area isn't very reliable.
3832 */
3833 if (x0 <= margin_left)
3834 x0 = margin_left;
3835 else if (x0 >= max_x - margin_right)
3836 x0 = max_x - margin_right;
3837 if (y0 <= margin_bottom)
3838 y0 = margin_bottom;
3839 else if (y0 >= max_y - margin_top)
3840 y0 = max_y - margin_top;
3841
3842 VLOG(3, (LOG_DEBUG, "synaptics: ipacket: [%d, %d], %d, %d\n",
3843 x0, y0, f->p, f->w));
3844
3845 /*
3846 * If the action is just beginning, init the structure and
3847 * compute tap timeout.
3848 */
3849 if (!(sc->flags & PSM_FLAGS_FINGERDOWN)) {
3850 VLOG(3, (LOG_DEBUG, "synaptics: ----\n"));
3851
3852 /* Initialize queue. */
3853 gest->window_min = window_min;
3854
3855 /* Reset pressure peak. */
3856 gest->zmax = 0;
3857
3858 /* Reset fingers count. */
3859 gest->fingers_nb = 0;
3860
3861 /* Reset virtual scrolling state. */
3862 gest->in_vscroll = 0;
3863
3864 /* Compute tap timeout. */
3865 if (tap_enabled != 0) {
3866 gest->taptimeout = (struct timeval) {
3867 .tv_sec = tap_timeout / 1000000,
3868 .tv_usec = tap_timeout % 1000000,
3869 };
3870 timevaladd(
3871 &gest->taptimeout, &sc->lastsoftintr);
3872 } else
3873 timevalclear(&gest->taptimeout);
3874
3875 sc->flags |= PSM_FLAGS_FINGERDOWN;
3876
3877 /* Smoother has not been reset yet */
3878 queue_len = 1;
3879 start_x = x0;
3880 start_y = y0;
3881 } else {
3882 queue_len = smoother->queue_len + 1;
3883 start_x = smoother->start_x;
3884 start_y = smoother->start_y;
3885 }
3886
3887 /* Process ClickPad softbuttons */
3888 if (sc->synhw.capClickPad && ms->button & MOUSE_BUTTON1DOWN) {
3889 y_ok = sc->syninfo.softbuttons_y >= 0 ?
3890 start_y < sc->syninfo.softbuttons_y :
3891 start_y > max_y + sc->syninfo.softbuttons_y;
3892
3893 center_button = MOUSE_BUTTON2DOWN;
3894 center_x = sc->syninfo.softbutton2_x;
3895 right_button = MOUSE_BUTTON3DOWN;
3896 right_x = sc->syninfo.softbutton3_x;
3897
3898 if (center_x > 0 && right_x > 0 && center_x > right_x) {
3899 center_button = MOUSE_BUTTON3DOWN;
3900 center_x = sc->syninfo.softbutton3_x;
3901 right_button = MOUSE_BUTTON2DOWN;
3902 right_x = sc->syninfo.softbutton2_x;
3903 }
3904
3905 if (right_x > 0 && start_x > right_x && y_ok)
3906 ms->button = (ms->button &
3907 ~MOUSE_BUTTON1DOWN) | right_button;
3908 else if (center_x > 0 && start_x > center_x && y_ok)
3909 ms->button = (ms->button &
3910 ~MOUSE_BUTTON1DOWN) | center_button;
3911 }
3912
3913 /* If in tap-hold or three fingers, add the recorded button. */
3914 if (gest->in_taphold || (nfingers == 3 && three_finger_drag))
3915 ms->button |= gest->tap_button;
3916
3917 /*
3918 * For tap, we keep the maximum number of fingers and the
3919 * pressure peak. Also with multiple fingers, we increase
3920 * the minimum window.
3921 */
3922 if (nfingers > 1)
3923 gest->window_min = window_max;
3924 gest->fingers_nb = imax(nfingers, gest->fingers_nb);
3925 gest->zmax = imax(f->p, gest->zmax);
3926
3927 /* Do we have enough packets to consider this a gesture? */
3928 if (queue_len < gest->window_min)
3929 return;
3930
3931 dyp = -1;
3932 dxp = -1;
3933
3934 /* Is a scrolling action occurring? */
3935 if (!gest->in_taphold && !ms->button &&
3936 (!gest->in_vscroll || two_finger_scroll)) {
3937 /*
3938 * A scrolling action must not conflict with a tap
3939 * action. Here are the conditions to consider a
3940 * scrolling action:
3941 * - the action in a configurable area
3942 * - one of the following:
3943 * . the distance between the last packet and the
3944 * first should be above a configurable minimum
3945 * . tap timed out
3946 */
3947 dxp = abs(x0 - start_x);
3948 dyp = abs(y0 - start_y);
3949
3950 if (timevalcmp(&sc->lastsoftintr, &gest->taptimeout, >) ||
3951 dxp >= sc->syninfo.vscroll_min_delta ||
3952 dyp >= sc->syninfo.vscroll_min_delta) {
3953 /*
3954 * Handle two finger scrolling.
3955 * Note that we don't rely on fingers_nb
3956 * as that keeps the maximum number of fingers.
3957 */
3958 if (two_finger_scroll) {
3959 if (nfingers == 2) {
3960 gest->in_vscroll +=
3961 dyp ? 2 : 0;
3962 gest->in_vscroll +=
3963 dxp ? 1 : 0;
3964 }
3965 } else {
3966 /* Check for horizontal scrolling. */
3967 if ((vscroll_hor_area > 0 &&
3968 start_y <= vscroll_hor_area) ||
3969 (vscroll_hor_area < 0 &&
3970 start_y >=
3971 max_y + vscroll_hor_area))
3972 gest->in_vscroll += 2;
3973
3974 /* Check for vertical scrolling. */
3975 if ((vscroll_ver_area > 0 &&
3976 start_x <= vscroll_ver_area) ||
3977 (vscroll_ver_area < 0 &&
3978 start_x >=
3979 max_x + vscroll_ver_area))
3980 gest->in_vscroll += 1;
3981 }
3982
3983 /* Avoid conflicts if area overlaps. */
3984 if (gest->in_vscroll >= 3)
3985 gest->in_vscroll =
3986 (dxp > dyp) ? 2 : 1;
3987 }
3988 }
3989 /*
3990 * Reset two finger scrolling when the number of fingers
3991 * is different from two or any button is pressed.
3992 */
3993 if (two_finger_scroll && gest->in_vscroll != 0 &&
3994 (nfingers != 2 || ms->button))
3995 gest->in_vscroll = 0;
3996
3997 VLOG(5, (LOG_DEBUG,
3998 "synaptics: virtual scrolling: %s "
3999 "(direction=%d, dxp=%d, dyp=%d, fingers=%d)\n",
4000 gest->in_vscroll ? "YES" : "NO",
4001 gest->in_vscroll, dxp, dyp,
4002 gest->fingers_nb));
4003
4004 } else if (sc->flags & PSM_FLAGS_FINGERDOWN) {
4005 /*
4006 * An action is currently taking place but the pressure
4007 * dropped under the minimum, putting an end to it.
4008 */
4009 int taphold_timeout, dx, dy, tap_max_delta;
4010
4011 dx = abs(smoother->queue[smoother->queue_cursor].x -
4012 smoother->start_x);
4013 dy = abs(smoother->queue[smoother->queue_cursor].y -
4014 smoother->start_y);
4015
4016 /* Max delta is disabled for multi-fingers tap. */
4017 if (gest->fingers_nb > 1)
4018 tap_max_delta = imax(dx, dy);
4019 else
4020 tap_max_delta = sc->syninfo.tap_max_delta;
4021
4022 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
4023
4024 /* Check for tap. */
4025 VLOG(3, (LOG_DEBUG,
4026 "synaptics: zmax=%d, dx=%d, dy=%d, "
4027 "delta=%d, fingers=%d, queue=%d\n",
4028 gest->zmax, dx, dy, tap_max_delta, gest->fingers_nb,
4029 smoother->queue_len));
4030 if (!gest->in_vscroll && gest->zmax >= tap_threshold &&
4031 timevalcmp(&sc->lastsoftintr, &gest->taptimeout, <=) &&
4032 dx <= tap_max_delta && dy <= tap_max_delta &&
4033 smoother->queue_len >= sc->syninfo.tap_min_queue) {
4034 /*
4035 * We have a tap if:
4036 * - the maximum pressure went over tap_threshold
4037 * - the action ended before tap_timeout
4038 *
4039 * To handle tap-hold, we must delay any button push to
4040 * the next action.
4041 */
4042 if (gest->in_taphold) {
4043 /*
4044 * This is the second and last tap of a
4045 * double tap action, not a tap-hold.
4046 */
4047 gest->in_taphold = 0;
4048
4049 /*
4050 * For double-tap to work:
4051 * - no button press is emitted (to
4052 * simulate a button release)
4053 * - PSM_FLAGS_FINGERDOWN is set to
4054 * force the next packet to emit a
4055 * button press)
4056 */
4057 VLOG(2, (LOG_DEBUG,
4058 "synaptics: button RELEASE: %d\n",
4059 gest->tap_button));
4060 sc->flags |= PSM_FLAGS_FINGERDOWN;
4061
4062 /* Schedule button press on next interrupt */
4063 sc->idletimeout.tv_sec = psmhz > 1 ?
4064 0 : 1;
4065 sc->idletimeout.tv_usec = psmhz > 1 ?
4066 1000000 / psmhz : 0;
4067 } else {
4068 /*
4069 * This is the first tap: we set the
4070 * tap-hold state and notify the button
4071 * down event.
4072 */
4073 gest->in_taphold = 1;
4074 taphold_timeout = sc->syninfo.taphold_timeout;
4075 gest->taptimeout.tv_sec = taphold_timeout /
4076 1000000;
4077 gest->taptimeout.tv_usec = taphold_timeout %
4078 1000000;
4079 sc->idletimeout = gest->taptimeout;
4080 timevaladd(&gest->taptimeout,
4081 &sc->lastsoftintr);
4082
4083 switch (gest->fingers_nb) {
4084 case 3:
4085 gest->tap_button =
4086 MOUSE_BUTTON2DOWN;
4087 break;
4088 case 2:
4089 gest->tap_button =
4090 MOUSE_BUTTON3DOWN;
4091 break;
4092 default:
4093 gest->tap_button =
4094 MOUSE_BUTTON1DOWN;
4095 }
4096 VLOG(2, (LOG_DEBUG,
4097 "synaptics: button PRESS: %d\n",
4098 gest->tap_button));
4099 ms->button |= gest->tap_button;
4100 }
4101 } else {
4102 /*
4103 * Not enough pressure or timeout: reset
4104 * tap-hold state.
4105 */
4106 if (gest->in_taphold) {
4107 VLOG(2, (LOG_DEBUG,
4108 "synaptics: button RELEASE: %d\n",
4109 gest->tap_button));
4110 gest->in_taphold = 0;
4111 } else {
4112 VLOG(2, (LOG_DEBUG,
4113 "synaptics: not a tap-hold\n"));
4114 }
4115 }
4116 } else if (!(sc->flags & PSM_FLAGS_FINGERDOWN) && gest->in_taphold) {
4117 /*
4118 * For a tap-hold to work, the button must remain down at
4119 * least until timeout (where the in_taphold flags will be
4120 * cleared) or during the next action.
4121 */
4122 if (timevalcmp(&sc->lastsoftintr, &gest->taptimeout, <=)) {
4123 ms->button |= gest->tap_button;
4124 } else {
4125 VLOG(2, (LOG_DEBUG, "synaptics: button RELEASE: %d\n",
4126 gest->tap_button));
4127 gest->in_taphold = 0;
4128 }
4129 }
4130
4131 return;
4132 }
4133
4134 static void
4135 psmsmoother(struct psm_softc *sc, finger_t *f, int smoother_id,
4136 mousestatus_t *ms, int *x, int *y)
4137 {
4138 smoother_t *smoother = &sc->smoother[smoother_id];
4139 gesture_t *gest = &(sc->gesture);
4140
4141 /*
4142 * Check pressure to detect a real wanted action on the
4143 * touchpad.
4144 */
4145 if (f->p >= sc->syninfo.min_pressure) {
4146 int x0, y0;
4147 int cursor, peer, window;
4148 int dx, dy, dxp, dyp;
4149 int max_width, max_pressure;
4150 int margin_top, margin_right, margin_bottom, margin_left;
4151 int na_top, na_right, na_bottom, na_left;
4152 int window_min, window_max;
4153 int multiplicator;
4154 int weight_current, weight_previous, weight_len_squared;
4155 int div_min, div_max, div_len;
4156 int vscroll_hor_area, vscroll_ver_area;
4157 int two_finger_scroll;
4158 int max_x, max_y;
4159 int len, weight_prev_x, weight_prev_y;
4160 int div_max_x, div_max_y, div_x, div_y;
4161 int is_fuzzy;
4162 int natural_scroll;
4163
4164 /* Read sysctl. */
4165 /* XXX Verify values? */
4166 max_width = sc->syninfo.max_width;
4167 max_pressure = sc->syninfo.max_pressure;
4168 margin_top = sc->syninfo.margin_top;
4169 margin_right = sc->syninfo.margin_right;
4170 margin_bottom = sc->syninfo.margin_bottom;
4171 margin_left = sc->syninfo.margin_left;
4172 na_top = sc->syninfo.na_top;
4173 na_right = sc->syninfo.na_right;
4174 na_bottom = sc->syninfo.na_bottom;
4175 na_left = sc->syninfo.na_left;
4176 window_min = sc->syninfo.window_min;
4177 window_max = sc->syninfo.window_max;
4178 multiplicator = sc->syninfo.multiplicator;
4179 weight_current = sc->syninfo.weight_current;
4180 weight_previous = sc->syninfo.weight_previous;
4181 weight_len_squared = sc->syninfo.weight_len_squared;
4182 div_min = sc->syninfo.div_min;
4183 div_max = sc->syninfo.div_max;
4184 div_len = sc->syninfo.div_len;
4185 vscroll_hor_area = sc->syninfo.vscroll_hor_area;
4186 vscroll_ver_area = sc->syninfo.vscroll_ver_area;
4187 two_finger_scroll = sc->syninfo.two_finger_scroll;
4188 max_x = sc->syninfo.max_x;
4189 max_y = sc->syninfo.max_y;
4190 natural_scroll = sc->syninfo.natural_scroll;
4191
4192 is_fuzzy = (f->flags & PSM_FINGER_FUZZY) != 0;
4193
4194 /* Read current absolute position. */
4195 x0 = f->x;
4196 y0 = f->y;
4197
4198 /*
4199 * Limit the coordinates to the specified margins because
4200 * this area isn't very reliable.
4201 */
4202 if (x0 <= margin_left)
4203 x0 = margin_left;
4204 else if (x0 >= max_x - margin_right)
4205 x0 = max_x - margin_right;
4206 if (y0 <= margin_bottom)
4207 y0 = margin_bottom;
4208 else if (y0 >= max_y - margin_top)
4209 y0 = max_y - margin_top;
4210
4211 /* If the action is just beginning, init the structure. */
4212 if (smoother->active == 0) {
4213 VLOG(3, (LOG_DEBUG, "smoother%d: ---\n", smoother_id));
4214
4215 /* Store the first point of this action. */
4216 smoother->start_x = x0;
4217 smoother->start_y = y0;
4218 dx = dy = 0;
4219
4220 /* Initialize queue. */
4221 smoother->queue_cursor = SYNAPTICS_PACKETQUEUE;
4222 smoother->queue_len = 0;
4223
4224 /* Reset average. */
4225 smoother->avg_dx = 0;
4226 smoother->avg_dy = 0;
4227
4228 /* Reset squelch. */
4229 smoother->squelch_x = 0;
4230 smoother->squelch_y = 0;
4231
4232 /* Activate queue */
4233 smoother->active = 1;
4234 } else {
4235 /* Calculate the current delta. */
4236 cursor = smoother->queue_cursor;
4237 dx = x0 - smoother->queue[cursor].x;
4238 dy = y0 - smoother->queue[cursor].y;
4239 }
4240
4241 VLOG(3, (LOG_DEBUG, "smoother%d: ipacket: [%d, %d], %d, %d\n",
4242 smoother_id, x0, y0, f->p, f->w));
4243
4244 /* Queue this new packet. */
4245 cursor = SYNAPTICS_QUEUE_CURSOR(smoother->queue_cursor - 1);
4246 smoother->queue[cursor].x = x0;
4247 smoother->queue[cursor].y = y0;
4248 smoother->queue_cursor = cursor;
4249 if (smoother->queue_len < SYNAPTICS_PACKETQUEUE)
4250 smoother->queue_len++;
4251 VLOG(5, (LOG_DEBUG,
4252 "smoother%d: cursor[%d]: x=%d, y=%d, dx=%d, dy=%d\n",
4253 smoother_id, cursor, x0, y0, dx, dy));
4254
4255 /* Do we have enough packets to consider this a movement? */
4256 if (smoother->queue_len < gest->window_min)
4257 return;
4258
4259 weight_prev_x = weight_prev_y = weight_previous;
4260 div_max_x = div_max_y = div_max;
4261
4262 if (gest->in_vscroll) {
4263 /* Dividers are different with virtual scrolling. */
4264 div_min = sc->syninfo.vscroll_div_min;
4265 div_max_x = div_max_y = sc->syninfo.vscroll_div_max;
4266 } else {
4267 /*
4268 * There's a lot of noise in coordinates when
4269 * the finger is on the touchpad's borders. When
4270 * using this area, we apply a special weight and
4271 * div.
4272 */
4273 if (x0 <= na_left || x0 >= max_x - na_right) {
4274 weight_prev_x = sc->syninfo.weight_previous_na;
4275 div_max_x = sc->syninfo.div_max_na;
4276 }
4277
4278 if (y0 <= na_bottom || y0 >= max_y - na_top) {
4279 weight_prev_y = sc->syninfo.weight_previous_na;
4280 div_max_y = sc->syninfo.div_max_na;
4281 }
4282 }
4283
4284 /*
4285 * Calculate weights for the average operands and
4286 * the divisor. Both depend on the distance between
4287 * the current packet and a previous one (based on the
4288 * window width).
4289 */
4290 window = imin(smoother->queue_len, window_max);
4291 peer = SYNAPTICS_QUEUE_CURSOR(cursor + window - 1);
4292 dxp = abs(x0 - smoother->queue[peer].x) + 1;
4293 dyp = abs(y0 - smoother->queue[peer].y) + 1;
4294 len = (dxp * dxp) + (dyp * dyp);
4295 weight_prev_x = imin(weight_prev_x,
4296 weight_len_squared * weight_prev_x / len);
4297 weight_prev_y = imin(weight_prev_y,
4298 weight_len_squared * weight_prev_y / len);
4299
4300 len = (dxp + dyp) / 2;
4301 div_x = div_len * div_max_x / len;
4302 div_x = imin(div_max_x, div_x);
4303 div_x = imax(div_min, div_x);
4304 div_y = div_len * div_max_y / len;
4305 div_y = imin(div_max_y, div_y);
4306 div_y = imax(div_min, div_y);
4307
4308 VLOG(3, (LOG_DEBUG,
4309 "smoother%d: peer=%d, len=%d, weight=%d/%d, div=%d/%d\n",
4310 smoother_id, peer, len, weight_prev_x, weight_prev_y,
4311 div_x, div_y));
4312
4313 /* Compute averages. */
4314 smoother->avg_dx =
4315 (weight_current * dx * multiplicator +
4316 weight_prev_x * smoother->avg_dx) /
4317 (weight_current + weight_prev_x);
4318
4319 smoother->avg_dy =
4320 (weight_current * dy * multiplicator +
4321 weight_prev_y * smoother->avg_dy) /
4322 (weight_current + weight_prev_y);
4323
4324 VLOG(5, (LOG_DEBUG,
4325 "smoother%d: avg_dx~=%d, avg_dy~=%d\n", smoother_id,
4326 smoother->avg_dx / multiplicator,
4327 smoother->avg_dy / multiplicator));
4328
4329 /* Use these averages to calculate x & y. */
4330 smoother->squelch_x += smoother->avg_dx;
4331 dxp = smoother->squelch_x / (div_x * multiplicator);
4332 smoother->squelch_x = smoother->squelch_x %
4333 (div_x * multiplicator);
4334
4335 smoother->squelch_y += smoother->avg_dy;
4336 dyp = smoother->squelch_y / (div_y * multiplicator);
4337 smoother->squelch_y = smoother->squelch_y %
4338 (div_y * multiplicator);
4339
4340 switch(gest->in_vscroll) {
4341 case 0: /* Pointer movement. */
4342 /* On real<->fuzzy finger switch the x/y pos jumps */
4343 if (is_fuzzy == smoother->is_fuzzy) {
4344 *x += dxp;
4345 *y += dyp;
4346 }
4347
4348 VLOG(3, (LOG_DEBUG, "smoother%d: [%d, %d] -> [%d, %d]\n",
4349 smoother_id, dx, dy, dxp, dyp));
4350 break;
4351 case 1: /* Vertical scrolling. */
4352 if (dyp != 0) {
4353 if (two_finger_scroll && natural_scroll)
4354 ms->button |= (dyp > 0) ?
4355 MOUSE_BUTTON5DOWN : MOUSE_BUTTON4DOWN;
4356 else
4357 ms->button |= (dyp > 0) ?
4358 MOUSE_BUTTON4DOWN : MOUSE_BUTTON5DOWN;
4359 }
4360 break;
4361 case 2: /* Horizontal scrolling. */
4362 if (dxp != 0) {
4363 if (two_finger_scroll && natural_scroll)
4364 ms->button |= (dxp > 0) ?
4365 MOUSE_BUTTON6DOWN : MOUSE_BUTTON7DOWN;
4366 else
4367 ms->button |= (dxp > 0) ?
4368 MOUSE_BUTTON7DOWN : MOUSE_BUTTON6DOWN;
4369 }
4370 break;
4371 }
4372
4373 smoother->is_fuzzy = is_fuzzy;
4374
4375 } else {
4376 /*
4377 * Deactivate queue. Note: We can not just reset queue here
4378 * as these values are still used by gesture processor.
4379 * So postpone reset till next touch.
4380 */
4381 smoother->active = 0;
4382 }
4383 }
4384
4385 static int
4386 proc_elantech(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
4387 int *x, int *y, int *z)
4388 {
4389 static int touchpad_button, trackpoint_button;
4390 finger_t fn, f[ELANTECH_MAX_FINGERS];
4391 int pkt, id, scale, i, nfingers, mask, palm;
4392
4393 if (!elantech_support)
4394 return (0);
4395
4396 /* Determine packet format and do a sanity check for out of sync packets. */
4397 if (ELANTECH_PKT_IS_DEBOUNCE(pb, sc->elanhw.hwversion))
4398 pkt = ELANTECH_PKT_NOP;
4399 else if (sc->elanhw.hastrackpoint && ELANTECH_PKT_IS_TRACKPOINT(pb))
4400 pkt = ELANTECH_PKT_TRACKPOINT;
4401 else
4402 switch (sc->elanhw.hwversion) {
4403 case 2:
4404 if (!ELANTECH_PKT_IS_V2(pb))
4405 return (-1);
4406
4407 pkt = (pb->ipacket[0] & 0xc0) == 0x80 ?
4408 ELANTECH_PKT_V2_2FINGER : ELANTECH_PKT_V2_COMMON;
4409 break;
4410 case 3:
4411 if (!ELANTECH_PKT_IS_V3_HEAD(pb, sc->elanhw.hascrc) &&
4412 !ELANTECH_PKT_IS_V3_TAIL(pb, sc->elanhw.hascrc))
4413 return (-1);
4414
4415 pkt = ELANTECH_PKT_V3;
4416 break;
4417 case 4:
4418 if (!ELANTECH_PKT_IS_V4(pb, sc->elanhw.hascrc))
4419 return (-1);
4420
4421 switch (pb->ipacket[3] & 0x03) {
4422 case 0x00:
4423 pkt = ELANTECH_PKT_V4_STATUS;
4424 break;
4425 case 0x01:
4426 pkt = ELANTECH_PKT_V4_HEAD;
4427 break;
4428 case 0x02:
4429 pkt = ELANTECH_PKT_V4_MOTION;
4430 break;
4431 default:
4432 return (-1);
4433 }
4434 break;
4435 default:
4436 return (-1);
4437 }
4438
4439 VLOG(5, (LOG_DEBUG, "elantech: ipacket format: %d\n", pkt));
4440
4441 for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
4442 PSM_FINGER_RESET(f[id]);
4443
4444 *x = *y = *z = 0;
4445 ms->button = ms->obutton;
4446
4447 if (sc->syninfo.touchpad_off && pkt != ELANTECH_PKT_TRACKPOINT)
4448 return (0);
4449
4450 /* Common legend
4451 * L: Left mouse button pressed
4452 * R: Right mouse button pressed
4453 * N: number of fingers on touchpad
4454 * X: absolute x value (horizontal)
4455 * Y: absolute y value (vertical)
4456 * W; width of the finger touch
4457 * P: pressure
4458 */
4459 switch (pkt) {
4460 case ELANTECH_PKT_V2_COMMON: /* HW V2. One/Three finger touch */
4461 /* 7 6 5 4 3 2 1 0 (LSB)
4462 * -------------------------------------------
4463 * ipacket[0]: N1 N0 W3 W2 . . R L
4464 * ipacket[1]: P7 P6 P5 P4 X11 X10 X9 X8
4465 * ipacket[2]: X7 X6 X5 X4 X3 X2 X1 X0
4466 * ipacket[3]: N4 VF W1 W0 . . . B2
4467 * ipacket[4]: P3 P1 P2 P0 Y11 Y10 Y9 Y8
4468 * ipacket[5]: Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
4469 * -------------------------------------------
4470 * N4: set if more than 3 fingers (only in 3 fingers mode)
4471 * VF: a kind of flag? (only on EF123, 0 when finger
4472 * is over one of the buttons, 1 otherwise)
4473 * B2: (on EF113 only, 0 otherwise), one button pressed
4474 * P & W is not reported on EF113 touchpads
4475 */
4476 nfingers = (pb->ipacket[0] & 0xc0) >> 6;
4477 if (nfingers == 3 && (pb->ipacket[3] & 0x80))
4478 nfingers = 4;
4479
4480 if (nfingers == 0) {
4481 mask = (1 << nfingers) - 1; /* = 0x00 */
4482 break;
4483 }
4484
4485 /* Map 3-rd and 4-th fingers to first finger */
4486 mask = (1 << 1) - 1; /* = 0x01 */
4487 f[0] = ELANTECH_FINGER_SET_XYP(pb);
4488 if (sc->elanhw.haspressure) {
4489 f[0].w = ((pb->ipacket[0] & 0x30) >> 2) |
4490 ((pb->ipacket[3] & 0x30) >> 4);
4491 } else {
4492 f[0].p = PSM_FINGER_DEFAULT_P;
4493 f[0].w = PSM_FINGER_DEFAULT_W;
4494 }
4495
4496 /*
4497 * HW v2 dont report exact finger positions when 3 or more
4498 * fingers are on touchpad.
4499 */
4500 if (nfingers > 2)
4501 f[0].flags = PSM_FINGER_FUZZY;
4502
4503 break;
4504
4505 case ELANTECH_PKT_V2_2FINGER: /*HW V2. Two finger touch */
4506 /* 7 6 5 4 3 2 1 0 (LSB)
4507 * -------------------------------------------
4508 * ipacket[0]: N1 N0 AY8 AX8 . . R L
4509 * ipacket[1]: AX7 AX6 AX5 AX4 AX3 AX2 AX1 AX0
4510 * ipacket[2]: AY7 AY6 AY5 AY4 AY3 AY2 AY1 AY0
4511 * ipacket[3]: . . BY8 BX8 . . . .
4512 * ipacket[4]: BX7 BX6 BX5 BX4 BX3 BX2 BX1 BX0
4513 * ipacket[5]: BY7 BY6 BY5 BY4 BY3 BY2 BY1 BY0
4514 * -------------------------------------------
4515 * AX: lower-left finger absolute x value
4516 * AY: lower-left finger absolute y value
4517 * BX: upper-right finger absolute x value
4518 * BY: upper-right finger absolute y value
4519 */
4520 nfingers = 2;
4521 mask = (1 << nfingers) - 1;
4522
4523 for (id = 0; id < imin(2, ELANTECH_MAX_FINGERS); id ++)
4524 f[id] = (finger_t) {
4525 .x = (((pb->ipacket[id * 3] & 0x10) << 4) |
4526 pb->ipacket[id * 3 + 1]) << 2,
4527 .y = (((pb->ipacket[id * 3] & 0x20) << 3) |
4528 pb->ipacket[id * 3 + 2]) << 2,
4529 .p = PSM_FINGER_DEFAULT_P,
4530 .w = PSM_FINGER_DEFAULT_W,
4531 /* HW ver.2 sends bounding box */
4532 .flags = PSM_FINGER_FUZZY
4533 };
4534 break;
4535
4536 case ELANTECH_PKT_V3: /* HW Version 3 */
4537 /* 7 6 5 4 3 2 1 0 (LSB)
4538 * -------------------------------------------
4539 * ipacket[0]: N1 N0 W3 W2 0 1 R L
4540 * ipacket[1]: P7 P6 P5 P4 X11 X10 X9 X8
4541 * ipacket[2]: X7 X6 X5 X4 X3 X2 X1 X0
4542 * ipacket[3]: 0 0 W1 W0 0 0 1 0
4543 * ipacket[4]: P3 P1 P2 P0 Y11 Y10 Y9 Y8
4544 * ipacket[5]: Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
4545 * -------------------------------------------
4546 */
4547 nfingers = (pb->ipacket[0] & 0xc0) >> 6;
4548 /* Map 3-rd finger to first finger */
4549 id = nfingers > 2 ? 0 : nfingers - 1;
4550 mask = (1 << (id + 1)) - 1;
4551
4552 if (nfingers == 0)
4553 break;
4554
4555 fn = ELANTECH_FINGER_SET_XYP(pb);
4556 fn.w = ((pb->ipacket[0] & 0x30) >> 2) |
4557 ((pb->ipacket[3] & 0x30) >> 4);
4558
4559 /*
4560 * HW v3 dont report exact finger positions when 3 or more
4561 * fingers are on touchpad.
4562 */
4563 if (nfingers > 1)
4564 fn.flags = PSM_FINGER_FUZZY;
4565
4566 if (nfingers == 2) {
4567 if (ELANTECH_PKT_IS_V3_HEAD(pb, sc->elanhw.hascrc)) {
4568 sc->elanaction.fingers[0] = fn;
4569 return (0);
4570 } else
4571 f[0] = sc->elanaction.fingers[0];
4572 }
4573 f[id] = fn;
4574 break;
4575
4576 case ELANTECH_PKT_V4_STATUS: /* HW Version 4. Status packet */
4577 /* 7 6 5 4 3 2 1 0 (LSB)
4578 * -------------------------------------------
4579 * ipacket[0]: . . . . 0 1 R L
4580 * ipacket[1]: . . . F4 F3 F2 F1 F0
4581 * ipacket[2]: . . . . . . . .
4582 * ipacket[3]: . . . 1 0 0 0 0
4583 * ipacket[4]: PL . . . . . . .
4584 * ipacket[5]: . . . . . . . .
4585 * -------------------------------------------
4586 * Fn: finger n is on touchpad
4587 * PL: palm
4588 * HV ver4 sends a status packet to indicate that the numbers
4589 * or identities of the fingers has been changed
4590 */
4591
4592 mask = pb->ipacket[1] & 0x1f;
4593 nfingers = bitcount(mask);
4594
4595 if (sc->elanaction.mask_v4wait != 0)
4596 VLOG(3, (LOG_DEBUG, "elantech: HW v4 status packet"
4597 " when not all previous head packets received\n"));
4598
4599 /* Bitmap of fingers to receive before gesture processing */
4600 sc->elanaction.mask_v4wait = mask & ~sc->elanaction.mask;
4601
4602 /* Skip "new finger is on touchpad" packets */
4603 if (sc->elanaction.mask_v4wait) {
4604 sc->elanaction.mask = mask;
4605 return (0);
4606 }
4607
4608 break;
4609
4610 case ELANTECH_PKT_V4_HEAD: /* HW Version 4. Head packet */
4611 /* 7 6 5 4 3 2 1 0 (LSB)
4612 * -------------------------------------------
4613 * ipacket[0]: W3 W2 W1 W0 0 1 R L
4614 * ipacket[1]: P7 P6 P5 P4 X11 X10 X9 X8
4615 * ipacket[2]: X7 X6 X5 X4 X3 X2 X1 X0
4616 * ipacket[3]: ID2 ID1 ID0 1 0 0 0 1
4617 * ipacket[4]: P3 P1 P2 P0 Y11 Y10 Y9 Y8
4618 * ipacket[5]: Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
4619 * -------------------------------------------
4620 * ID: finger id
4621 * HW ver 4 sends head packets in two cases:
4622 * 1. One finger touch and movement.
4623 * 2. Next after status packet to tell new finger positions.
4624 */
4625 mask = sc->elanaction.mask;
4626 nfingers = bitcount(mask);
4627 id = ((pb->ipacket[3] & 0xe0) >> 5) - 1;
4628 fn = ELANTECH_FINGER_SET_XYP(pb);
4629 fn.w =(pb->ipacket[0] & 0xf0) >> 4;
4630
4631 if (id < 0)
4632 return (0);
4633
4634 /* Packet is finger position update. Report it */
4635 if (sc->elanaction.mask_v4wait == 0) {
4636 if (id < ELANTECH_MAX_FINGERS)
4637 f[id] = fn;
4638 break;
4639 }
4640
4641 /* Remove finger from waiting bitmap and store into context */
4642 sc->elanaction.mask_v4wait &= ~(1 << id);
4643 if (id < ELANTECH_MAX_FINGERS)
4644 sc->elanaction.fingers[id] = fn;
4645
4646 /* Wait for other fingers if needed */
4647 if (sc->elanaction.mask_v4wait != 0)
4648 return (0);
4649
4650 /* All new fingers are received. Report them from context */
4651 for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
4652 if (sc->elanaction.mask & (1 << id))
4653 f[id] = sc->elanaction.fingers[id];
4654
4655 break;
4656
4657 case ELANTECH_PKT_V4_MOTION: /* HW Version 4. Motion packet */
4658 /* 7 6 5 4 3 2 1 0 (LSB)
4659 * -------------------------------------------
4660 * ipacket[0]: ID2 ID1 ID0 OF 0 1 R L
4661 * ipacket[1]: DX7 DX6 DX5 DX4 DX3 DX2 DX1 DX0
4662 * ipacket[2]: DY7 DY6 DY5 DY4 DY3 DY2 DY1 DY0
4663 * ipacket[3]: ID2 ID1 ID0 1 0 0 1 0
4664 * ipacket[4]: DX7 DX6 DX5 DX4 DX3 DX2 DX1 DX0
4665 * ipacket[5]: DY7 DY6 DY5 DY4 DY3 DY2 DY1 DY0
4666 * -------------------------------------------
4667 * OF: delta overflows (> 127 or < -128), in this case
4668 * firmware sends us (delta x / 5) and (delta y / 5)
4669 * ID: finger id
4670 * DX: delta x (two's complement)
4671 * XY: delta y (two's complement)
4672 * byte 0 ~ 2 for one finger
4673 * byte 3 ~ 5 for another finger
4674 */
4675 mask = sc->elanaction.mask;
4676 nfingers = bitcount(mask);
4677
4678 scale = (pb->ipacket[0] & 0x10) ? 5 : 1;
4679 for (i = 0; i <= 3; i += 3) {
4680 id = ((pb->ipacket[i] & 0xe0) >> 5) - 1;
4681 if (id < 0 || id >= ELANTECH_MAX_FINGERS)
4682 continue;
4683
4684 if (PSM_FINGER_IS_SET(sc->elanaction.fingers[id])) {
4685 f[id] = sc->elanaction.fingers[id];
4686 f[id].x += imax(-f[id].x,
4687 (signed char)pb->ipacket[i+1] * scale);
4688 f[id].y += imax(-f[id].y,
4689 (signed char)pb->ipacket[i+2] * scale);
4690 } else {
4691 VLOG(3, (LOG_DEBUG, "elantech: "
4692 "HW v4 motion packet skipped\n"));
4693 }
4694 }
4695
4696 break;
4697
4698 case ELANTECH_PKT_TRACKPOINT:
4699 /* 7 6 5 4 3 2 1 0 (LSB)
4700 * -------------------------------------------
4701 * ipacket[0]: 0 0 SY SX 0 M R L
4702 * ipacket[1]: ~SX 0 0 0 0 0 0 0
4703 * ipacket[2]: ~SY 0 0 0 0 0 0 0
4704 * ipacket[3]: 0 0 ~SY ~SX 0 1 1 0
4705 * ipacket[4]: X7 X6 X5 X4 X3 X2 X1 X0
4706 * ipacket[5]: Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
4707 * -------------------------------------------
4708 * X and Y are written in two's complement spread
4709 * over 9 bits with SX/SY the relative top bit and
4710 * X7..X0 and Y7..Y0 the lower bits.
4711 */
4712 if (!(pb->ipacket[0] & 0xC8) && !(pb->ipacket[1] & 0x7F) &&
4713 !(pb->ipacket[2] & 0x7F) && !(pb->ipacket[3] & 0xC9) &&
4714 !(pb->ipacket[0] & 0x10) != !(pb->ipacket[1] & 0x80) &&
4715 !(pb->ipacket[0] & 0x10) != !(pb->ipacket[3] & 0x10) &&
4716 !(pb->ipacket[0] & 0x20) != !(pb->ipacket[2] & 0x80) &&
4717 !(pb->ipacket[0] & 0x20) != !(pb->ipacket[3] & 0x20)) {
4718
4719 *x = (pb->ipacket[0] & MOUSE_PS2_XNEG) ?
4720 pb->ipacket[4] - 256 : pb->ipacket[4];
4721 *y = (pb->ipacket[0] & MOUSE_PS2_YNEG) ?
4722 pb->ipacket[5] - 256 : pb->ipacket[5];
4723
4724 trackpoint_button =
4725 ((pb->ipacket[0] & 0x01) ? MOUSE_BUTTON1DOWN : 0) |
4726 ((pb->ipacket[0] & 0x02) ? MOUSE_BUTTON3DOWN : 0) |
4727 ((pb->ipacket[0] & 0x04) ? MOUSE_BUTTON2DOWN : 0);
4728 #ifdef EVDEV_SUPPORT
4729 evdev_push_rel(sc->evdev_r, REL_X, *x);
4730 evdev_push_rel(sc->evdev_r, REL_Y, -*y);
4731 evdev_push_mouse_btn(sc->evdev_r, trackpoint_button);
4732 evdev_sync(sc->evdev_r);
4733 #endif
4734 ms->button = touchpad_button | trackpoint_button;
4735 } else
4736 VLOG(3, (LOG_DEBUG, "elantech: "
4737 "unexpected trackpoint packet skipped\n"));
4738 return (0);
4739
4740 case ELANTECH_PKT_NOP:
4741 return (0);
4742
4743 default:
4744 return (-1);
4745 }
4746
4747 for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
4748 if (PSM_FINGER_IS_SET(f[id]))
4749 VLOG(2, (LOG_DEBUG, "elantech: "
4750 "finger %d: down [%d, %d], %d, %d, %d\n", id + 1,
4751 f[id].x, f[id].y, f[id].p, f[id].w, f[id].flags));
4752
4753 /* Touchpad button presses */
4754 if (sc->elanhw.isclickpad) {
4755 touchpad_button =
4756 ((pb->ipacket[0] & 0x03) ? MOUSE_BUTTON1DOWN : 0);
4757 } else {
4758 touchpad_button =
4759 ((pb->ipacket[0] & 0x01) ? MOUSE_BUTTON1DOWN : 0) |
4760 ((pb->ipacket[0] & 0x02) ? MOUSE_BUTTON3DOWN : 0);
4761 }
4762
4763 #ifdef EVDEV_SUPPORT
4764 if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
4765 for (id = 0; id < ELANTECH_MAX_FINGERS; id++) {
4766 if (PSM_FINGER_IS_SET(f[id])) {
4767 psm_push_mt_finger(sc, id, &f[id]);
4768 /* Convert touch width to surface units */
4769 evdev_push_abs(sc->evdev_a, ABS_MT_TOUCH_MAJOR,
4770 f[id].w * sc->elanhw.dptracex);
4771 }
4772 if (sc->elanaction.mask & (1 << id) &&
4773 !(mask & (1 << id)))
4774 psm_release_mt_slot(sc->evdev_a, id);
4775 }
4776 evdev_push_key(sc->evdev_a, BTN_TOUCH, nfingers > 0);
4777 evdev_push_nfingers(sc->evdev_a, nfingers);
4778 if (nfingers > 0) {
4779 if (PSM_FINGER_IS_SET(f[0]))
4780 psm_push_st_finger(sc, &f[0]);
4781 } else
4782 evdev_push_abs(sc->evdev_a, ABS_PRESSURE, 0);
4783 evdev_push_mouse_btn(sc->evdev_a, touchpad_button);
4784 evdev_sync(sc->evdev_a);
4785 }
4786 #endif
4787
4788 ms->button = touchpad_button | trackpoint_button;
4789
4790 /* Palm detection doesn't terminate the current action. */
4791 palm = psmpalmdetect(sc, &f[0], nfingers);
4792
4793 /* Send finger 1 position to gesture processor */
4794 if ((PSM_FINGER_IS_SET(f[0]) || PSM_FINGER_IS_SET(f[1]) ||
4795 nfingers == 0) && !palm)
4796 psmgestures(sc, &f[0], imin(nfingers, 3), ms);
4797
4798 /* Send fingers positions to movement smoothers */
4799 for (id = 0; id < PSM_FINGERS; id++)
4800 if (PSM_FINGER_IS_SET(f[id]) || !(mask & (1 << id)))
4801 psmsmoother(sc, &f[id], id, ms, x, y);
4802
4803 /* Store current finger positions in action context */
4804 for (id = 0; id < ELANTECH_MAX_FINGERS; id++) {
4805 if (PSM_FINGER_IS_SET(f[id]))
4806 sc->elanaction.fingers[id] = f[id];
4807 if ((sc->elanaction.mask & (1 << id)) && !(mask & (1 << id)))
4808 PSM_FINGER_RESET(sc->elanaction.fingers[id]);
4809 }
4810 sc->elanaction.mask = mask;
4811
4812 if (palm) {
4813 *x = *y = *z = 0;
4814 ms->button = ms->obutton;
4815 return (0);
4816 }
4817
4818 /* Use the extra buttons as a scrollwheel */
4819 if (ms->button & MOUSE_BUTTON4DOWN)
4820 *z = -1;
4821 else if (ms->button & MOUSE_BUTTON5DOWN)
4822 *z = 1;
4823 else if (ms->button & MOUSE_BUTTON6DOWN)
4824 *z = -2;
4825 else if (ms->button & MOUSE_BUTTON7DOWN)
4826 *z = 2;
4827 else
4828 *z = 0;
4829 ms->button &= ~(MOUSE_BUTTON4DOWN | MOUSE_BUTTON5DOWN |
4830 MOUSE_BUTTON6DOWN | MOUSE_BUTTON7DOWN);
4831
4832 return (0);
4833 }
4834
4835 static void
4836 proc_versapad(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
4837 int *x, int *y, int *z)
4838 {
4839 static int butmap_versapad[8] = {
4840 0,
4841 MOUSE_BUTTON3DOWN,
4842 0,
4843 MOUSE_BUTTON3DOWN,
4844 MOUSE_BUTTON1DOWN,
4845 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
4846 MOUSE_BUTTON1DOWN,
4847 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN
4848 };
4849 int c, x0, y0;
4850
4851 /* VersaPad PS/2 absolute mode message format
4852 *
4853 * [packet1] 7 6 5 4 3 2 1 0(LSB)
4854 * ipacket[0]: 1 1 0 A 1 L T R
4855 * ipacket[1]: H7 H6 H5 H4 H3 H2 H1 H0
4856 * ipacket[2]: V7 V6 V5 V4 V3 V2 V1 V0
4857 * ipacket[3]: 1 1 1 A 1 L T R
4858 * ipacket[4]:V11 V10 V9 V8 H11 H10 H9 H8
4859 * ipacket[5]: 0 P6 P5 P4 P3 P2 P1 P0
4860 *
4861 * [note]
4862 * R: right physical mouse button (1=on)
4863 * T: touch pad virtual button (1=tapping)
4864 * L: left physical mouse button (1=on)
4865 * A: position data is valid (1=valid)
4866 * H: horizontal data (12bit signed integer. H11 is sign bit.)
4867 * V: vertical data (12bit signed integer. V11 is sign bit.)
4868 * P: pressure data
4869 *
4870 * Tapping is mapped to MOUSE_BUTTON4.
4871 */
4872 c = pb->ipacket[0];
4873 *x = *y = 0;
4874 ms->button = butmap_versapad[c & MOUSE_PS2VERSA_BUTTONS];
4875 ms->button |= (c & MOUSE_PS2VERSA_TAP) ? MOUSE_BUTTON4DOWN : 0;
4876 if (c & MOUSE_PS2VERSA_IN_USE) {
4877 x0 = pb->ipacket[1] | (((pb->ipacket[4]) & 0x0f) << 8);
4878 y0 = pb->ipacket[2] | (((pb->ipacket[4]) & 0xf0) << 4);
4879 if (x0 & 0x800)
4880 x0 -= 0x1000;
4881 if (y0 & 0x800)
4882 y0 -= 0x1000;
4883 if (sc->flags & PSM_FLAGS_FINGERDOWN) {
4884 *x = sc->xold - x0;
4885 *y = y0 - sc->yold;
4886 if (*x < 0) /* XXX */
4887 ++*x;
4888 else if (*x)
4889 --*x;
4890 if (*y < 0)
4891 ++*y;
4892 else if (*y)
4893 --*y;
4894 } else
4895 sc->flags |= PSM_FLAGS_FINGERDOWN;
4896 sc->xold = x0;
4897 sc->yold = y0;
4898 } else
4899 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
4900 }
4901
4902 static void
4903 psmsoftintridle(void *arg)
4904 {
4905 struct psm_softc *sc = arg;
4906 packetbuf_t *pb;
4907
4908 /* Invoke soft handler only when pqueue is empty. Otherwise it will be
4909 * invoked from psmintr soon with pqueue filled with real data */
4910 if (sc->pqueue_start == sc->pqueue_end &&
4911 sc->idlepacket.inputbytes > 0) {
4912 /* Grow circular queue backwards to avoid race with psmintr */
4913 if (--sc->pqueue_start < 0)
4914 sc->pqueue_start = PSM_PACKETQUEUE - 1;
4915
4916 pb = &sc->pqueue[sc->pqueue_start];
4917 memcpy(pb, &sc->idlepacket, sizeof(packetbuf_t));
4918 VLOG(4, (LOG_DEBUG,
4919 "psmsoftintridle: %02x %02x %02x %02x %02x %02x\n",
4920 pb->ipacket[0], pb->ipacket[1], pb->ipacket[2],
4921 pb->ipacket[3], pb->ipacket[4], pb->ipacket[5]));
4922
4923 psmsoftintr(arg);
4924 }
4925 }
4926
4927 static void
4928 psmsoftintr(void *arg)
4929 {
4930 /*
4931 * the table to turn PS/2 mouse button bits (MOUSE_PS2_BUTTON?DOWN)
4932 * into `mousestatus' button bits (MOUSE_BUTTON?DOWN).
4933 */
4934 static int butmap[8] = {
4935 0,
4936 MOUSE_BUTTON1DOWN,
4937 MOUSE_BUTTON3DOWN,
4938 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
4939 MOUSE_BUTTON2DOWN,
4940 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN,
4941 MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN,
4942 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN
4943 };
4944 struct psm_softc *sc = arg;
4945 mousestatus_t ms;
4946 packetbuf_t *pb;
4947 int x, y, z, c, l, s;
4948
4949 getmicrouptime(&sc->lastsoftintr);
4950
4951 s = spltty();
4952
4953 do {
4954 pb = &sc->pqueue[sc->pqueue_start];
4955
4956 if (sc->mode.level == PSM_LEVEL_NATIVE)
4957 goto next_native;
4958
4959 c = pb->ipacket[0];
4960 /*
4961 * A kludge for Kensington device!
4962 * The MSB of the horizontal count appears to be stored in
4963 * a strange place.
4964 */
4965 if (sc->hw.model == MOUSE_MODEL_THINK)
4966 pb->ipacket[1] |= (c & MOUSE_PS2_XOVERFLOW) ? 0x80 : 0;
4967
4968 /* ignore the overflow bits... */
4969 x = (c & MOUSE_PS2_XNEG) ?
4970 pb->ipacket[1] - 256 : pb->ipacket[1];
4971 y = (c & MOUSE_PS2_YNEG) ?
4972 pb->ipacket[2] - 256 : pb->ipacket[2];
4973 z = 0;
4974 ms.obutton = sc->button; /* previous button state */
4975 ms.button = butmap[c & MOUSE_PS2_BUTTONS];
4976 /* `tapping' action */
4977 if (sc->config & PSM_CONFIG_FORCETAP)
4978 ms.button |= ((c & MOUSE_PS2_TAP)) ?
4979 0 : MOUSE_BUTTON4DOWN;
4980 timevalclear(&sc->idletimeout);
4981 sc->idlepacket.inputbytes = 0;
4982
4983 switch (sc->hw.model) {
4984
4985 case MOUSE_MODEL_EXPLORER:
4986 /*
4987 * b7 b6 b5 b4 b3 b2 b1 b0
4988 * byte 1: oy ox sy sx 1 M R L
4989 * byte 2: x x x x x x x x
4990 * byte 3: y y y y y y y y
4991 * byte 4: * * S2 S1 s d2 d1 d0
4992 *
4993 * L, M, R, S1, S2: left, middle, right and side buttons
4994 * s: wheel data sign bit
4995 * d2-d0: wheel data
4996 */
4997 z = (pb->ipacket[3] & MOUSE_EXPLORER_ZNEG) ?
4998 (pb->ipacket[3] & 0x0f) - 16 :
4999 (pb->ipacket[3] & 0x0f);
5000 ms.button |=
5001 (pb->ipacket[3] & MOUSE_EXPLORER_BUTTON4DOWN) ?
5002 MOUSE_BUTTON4DOWN : 0;
5003 ms.button |=
5004 (pb->ipacket[3] & MOUSE_EXPLORER_BUTTON5DOWN) ?
5005 MOUSE_BUTTON5DOWN : 0;
5006 break;
5007
5008 case MOUSE_MODEL_INTELLI:
5009 case MOUSE_MODEL_NET:
5010 /* wheel data is in the fourth byte */
5011 z = (char)pb->ipacket[3];
5012 /*
5013 * XXX some mice may send 7 when there is no Z movement? */
5014 if ((z >= 7) || (z <= -7))
5015 z = 0;
5016 /* some compatible mice have additional buttons */
5017 ms.button |= (c & MOUSE_PS2INTELLI_BUTTON4DOWN) ?
5018 MOUSE_BUTTON4DOWN : 0;
5019 ms.button |= (c & MOUSE_PS2INTELLI_BUTTON5DOWN) ?
5020 MOUSE_BUTTON5DOWN : 0;
5021 break;
5022
5023 case MOUSE_MODEL_MOUSEMANPLUS:
5024 proc_mmanplus(sc, pb, &ms, &x, &y, &z);
5025 break;
5026
5027 case MOUSE_MODEL_GLIDEPOINT:
5028 /* `tapping' action */
5029 ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 :
5030 MOUSE_BUTTON4DOWN;
5031 break;
5032
5033 case MOUSE_MODEL_NETSCROLL:
5034 /*
5035 * three additional bytes encode buttons and
5036 * wheel events
5037 */
5038 ms.button |= (pb->ipacket[3] & MOUSE_PS2_BUTTON3DOWN) ?
5039 MOUSE_BUTTON4DOWN : 0;
5040 ms.button |= (pb->ipacket[3] & MOUSE_PS2_BUTTON1DOWN) ?
5041 MOUSE_BUTTON5DOWN : 0;
5042 z = (pb->ipacket[3] & MOUSE_PS2_XNEG) ?
5043 pb->ipacket[4] - 256 : pb->ipacket[4];
5044 break;
5045
5046 case MOUSE_MODEL_THINK:
5047 /* the fourth button state in the first byte */
5048 ms.button |= (c & MOUSE_PS2_TAP) ?
5049 MOUSE_BUTTON4DOWN : 0;
5050 break;
5051
5052 case MOUSE_MODEL_VERSAPAD:
5053 proc_versapad(sc, pb, &ms, &x, &y, &z);
5054 c = ((x < 0) ? MOUSE_PS2_XNEG : 0) |
5055 ((y < 0) ? MOUSE_PS2_YNEG : 0);
5056 break;
5057
5058 case MOUSE_MODEL_4D:
5059 /*
5060 * b7 b6 b5 b4 b3 b2 b1 b0
5061 * byte 1: s2 d2 s1 d1 1 M R L
5062 * byte 2: sx x x x x x x x
5063 * byte 3: sy y y y y y y y
5064 *
5065 * s1: wheel 1 direction
5066 * d1: wheel 1 data
5067 * s2: wheel 2 direction
5068 * d2: wheel 2 data
5069 */
5070 x = (pb->ipacket[1] & 0x80) ?
5071 pb->ipacket[1] - 256 : pb->ipacket[1];
5072 y = (pb->ipacket[2] & 0x80) ?
5073 pb->ipacket[2] - 256 : pb->ipacket[2];
5074 switch (c & MOUSE_4D_WHEELBITS) {
5075 case 0x10:
5076 z = 1;
5077 break;
5078 case 0x30:
5079 z = -1;
5080 break;
5081 case 0x40: /* XXX 2nd wheel turning right */
5082 z = 2;
5083 break;
5084 case 0xc0: /* XXX 2nd wheel turning left */
5085 z = -2;
5086 break;
5087 }
5088 break;
5089
5090 case MOUSE_MODEL_4DPLUS:
5091 if ((x < 16 - 256) && (y < 16 - 256)) {
5092 /*
5093 * b7 b6 b5 b4 b3 b2 b1 b0
5094 * byte 1: 0 0 1 1 1 M R L
5095 * byte 2: 0 0 0 0 1 0 0 0
5096 * byte 3: 0 0 0 0 S s d1 d0
5097 *
5098 * L, M, R, S: left, middle, right,
5099 * and side buttons
5100 * s: wheel data sign bit
5101 * d1-d0: wheel data
5102 */
5103 x = y = 0;
5104 if (pb->ipacket[2] & MOUSE_4DPLUS_BUTTON4DOWN)
5105 ms.button |= MOUSE_BUTTON4DOWN;
5106 z = (pb->ipacket[2] & MOUSE_4DPLUS_ZNEG) ?
5107 ((pb->ipacket[2] & 0x07) - 8) :
5108 (pb->ipacket[2] & 0x07) ;
5109 } else {
5110 /* preserve previous button states */
5111 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
5112 }
5113 break;
5114
5115 case MOUSE_MODEL_SYNAPTICS:
5116 if (pb->inputbytes == MOUSE_PS2_PACKETSIZE)
5117 if (proc_synaptics_mux(sc, pb))
5118 goto next;
5119
5120 if (proc_synaptics(sc, pb, &ms, &x, &y, &z) != 0) {
5121 VLOG(3, (LOG_DEBUG, "synaptics: "
5122 "packet rejected\n"));
5123 goto next;
5124 }
5125 break;
5126
5127 case MOUSE_MODEL_ELANTECH:
5128 if (proc_elantech(sc, pb, &ms, &x, &y, &z) != 0) {
5129 VLOG(3, (LOG_DEBUG, "elantech: "
5130 "packet rejected\n"));
5131 goto next;
5132 }
5133 break;
5134
5135 case MOUSE_MODEL_TRACKPOINT:
5136 case MOUSE_MODEL_GENERIC:
5137 default:
5138 break;
5139 }
5140
5141 #ifdef EVDEV_SUPPORT
5142 if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE &&
5143 sc->hw.model != MOUSE_MODEL_ELANTECH &&
5144 sc->hw.model != MOUSE_MODEL_SYNAPTICS) {
5145 evdev_push_rel(sc->evdev_r, REL_X, x);
5146 evdev_push_rel(sc->evdev_r, REL_Y, -y);
5147
5148 switch (sc->hw.model) {
5149 case MOUSE_MODEL_EXPLORER:
5150 case MOUSE_MODEL_INTELLI:
5151 case MOUSE_MODEL_NET:
5152 case MOUSE_MODEL_NETSCROLL:
5153 case MOUSE_MODEL_4DPLUS:
5154 evdev_push_rel(sc->evdev_r, REL_WHEEL, -z);
5155 break;
5156 case MOUSE_MODEL_MOUSEMANPLUS:
5157 case MOUSE_MODEL_4D:
5158 switch (z) {
5159 case 1:
5160 case -1:
5161 evdev_push_rel(sc->evdev_r, REL_WHEEL, -z);
5162 break;
5163 case 2:
5164 case -2:
5165 evdev_push_rel(sc->evdev_r, REL_HWHEEL, z / 2);
5166 break;
5167 }
5168 break;
5169 }
5170
5171 evdev_push_mouse_btn(sc->evdev_r, ms.button);
5172 evdev_sync(sc->evdev_r);
5173 }
5174 #endif
5175
5176 /* scale values */
5177 if (sc->mode.accelfactor >= 1) {
5178 if (x != 0) {
5179 x = x * x / sc->mode.accelfactor;
5180 if (x == 0)
5181 x = 1;
5182 if (c & MOUSE_PS2_XNEG)
5183 x = -x;
5184 }
5185 if (y != 0) {
5186 y = y * y / sc->mode.accelfactor;
5187 if (y == 0)
5188 y = 1;
5189 if (c & MOUSE_PS2_YNEG)
5190 y = -y;
5191 }
5192 }
5193
5194 /* Store last packet for reinjection if it has not been set already */
5195 if (timevalisset(&sc->idletimeout) && sc->idlepacket.inputbytes == 0)
5196 sc->idlepacket = *pb;
5197
5198 ms.dx = x;
5199 ms.dy = y;
5200 ms.dz = z;
5201 ms.flags = ((x || y || z) ? MOUSE_POSCHANGED : 0) |
5202 (ms.obutton ^ ms.button);
5203
5204 pb->inputbytes = tame_mouse(sc, pb, &ms, pb->ipacket);
5205
5206 sc->status.flags |= ms.flags;
5207 sc->status.dx += ms.dx;
5208 sc->status.dy += ms.dy;
5209 sc->status.dz += ms.dz;
5210 sc->status.button = ms.button;
5211 sc->button = ms.button;
5212
5213 next_native:
5214 sc->watchdog = FALSE;
5215
5216 /* queue data */
5217 if (sc->queue.count + pb->inputbytes < sizeof(sc->queue.buf)) {
5218 l = imin(pb->inputbytes,
5219 sizeof(sc->queue.buf) - sc->queue.tail);
5220 bcopy(&pb->ipacket[0], &sc->queue.buf[sc->queue.tail], l);
5221 if (pb->inputbytes > l)
5222 bcopy(&pb->ipacket[l], &sc->queue.buf[0],
5223 pb->inputbytes - l);
5224 sc->queue.tail = (sc->queue.tail + pb->inputbytes) %
5225 sizeof(sc->queue.buf);
5226 sc->queue.count += pb->inputbytes;
5227 }
5228
5229 next:
5230 pb->inputbytes = 0;
5231 if (++sc->pqueue_start >= PSM_PACKETQUEUE)
5232 sc->pqueue_start = 0;
5233 } while (sc->pqueue_start != sc->pqueue_end);
5234
5235 if (sc->state & PSM_ASLP) {
5236 sc->state &= ~PSM_ASLP;
5237 wakeup(sc);
5238 }
5239 selwakeuppri(&sc->rsel, PZERO);
5240 if (sc->async != NULL) {
5241 pgsigio(&sc->async, SIGIO, 0);
5242 }
5243 sc->state &= ~PSM_SOFTARMED;
5244
5245 /* schedule injection of predefined packet after idletimeout
5246 * if no data packets have been received from psmintr */
5247 if (timevalisset(&sc->idletimeout)) {
5248 sc->state |= PSM_SOFTARMED;
5249 callout_reset(&sc->softcallout, tvtohz(&sc->idletimeout),
5250 psmsoftintridle, sc);
5251 VLOG(2, (LOG_DEBUG, "softintr: callout set: %d ticks\n",
5252 tvtohz(&sc->idletimeout)));
5253 }
5254 splx(s);
5255 }
5256
5257 static int
5258 psmpoll(struct cdev *dev, int events, struct thread *td)
5259 {
5260 struct psm_softc *sc = dev->si_drv1;
5261 int s;
5262 int revents = 0;
5263
5264 /* Return true if a mouse event available */
5265 s = spltty();
5266 if (events & (POLLIN | POLLRDNORM)) {
5267 if (sc->queue.count > 0)
5268 revents |= events & (POLLIN | POLLRDNORM);
5269 else
5270 selrecord(td, &sc->rsel);
5271 }
5272 splx(s);
5273
5274 return (revents);
5275 }
5276
5277 /* vendor/model specific routines */
5278
5279 static int mouse_id_proc1(KBDC kbdc, int res, int scale, int *status)
5280 {
5281 if (set_mouse_resolution(kbdc, res) != res)
5282 return (FALSE);
5283 if (set_mouse_scaling(kbdc, scale) &&
5284 set_mouse_scaling(kbdc, scale) &&
5285 set_mouse_scaling(kbdc, scale) &&
5286 (get_mouse_status(kbdc, status, 0, 3) >= 3))
5287 return (TRUE);
5288 return (FALSE);
5289 }
5290
5291 static int
5292 mouse_ext_command(KBDC kbdc, int command)
5293 {
5294 int c;
5295
5296 c = (command >> 6) & 0x03;
5297 if (set_mouse_resolution(kbdc, c) != c)
5298 return (FALSE);
5299 c = (command >> 4) & 0x03;
5300 if (set_mouse_resolution(kbdc, c) != c)
5301 return (FALSE);
5302 c = (command >> 2) & 0x03;
5303 if (set_mouse_resolution(kbdc, c) != c)
5304 return (FALSE);
5305 c = (command >> 0) & 0x03;
5306 if (set_mouse_resolution(kbdc, c) != c)
5307 return (FALSE);
5308 return (TRUE);
5309 }
5310
5311 #ifdef notyet
5312 /* Logitech MouseMan Cordless II */
5313 static int
5314 enable_lcordless(struct psm_softc *sc, enum probearg arg)
5315 {
5316 KBDC kbdc = sc->kbdc;
5317 int status[3];
5318 int ch;
5319
5320 if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 2, status))
5321 return (FALSE);
5322 if (status[1] == PSMD_RES_HIGH)
5323 return (FALSE);
5324 ch = (status[0] & 0x07) - 1; /* channel # */
5325 if ((ch <= 0) || (ch > 4))
5326 return (FALSE);
5327 /*
5328 * status[1]: always one?
5329 * status[2]: battery status? (0-100)
5330 */
5331 return (TRUE);
5332 }
5333 #endif /* notyet */
5334
5335 /* Genius NetScroll Mouse, MouseSystems SmartScroll Mouse */
5336 static int
5337 enable_groller(struct psm_softc *sc, enum probearg arg)
5338 {
5339 KBDC kbdc = sc->kbdc;
5340 int status[3];
5341
5342 /*
5343 * The special sequence to enable the fourth button and the
5344 * roller. Immediately after this sequence check status bytes.
5345 * if the mouse is NetScroll, the second and the third bytes are
5346 * '3' and 'D'.
5347 */
5348
5349 /*
5350 * If the mouse is an ordinary PS/2 mouse, the status bytes should
5351 * look like the following.
5352 *
5353 * byte 1 bit 7 always 0
5354 * bit 6 stream mode (0)
5355 * bit 5 disabled (0)
5356 * bit 4 1:1 scaling (0)
5357 * bit 3 always 0
5358 * bit 0-2 button status
5359 * byte 2 resolution (PSMD_RES_HIGH)
5360 * byte 3 report rate (?)
5361 */
5362
5363 if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 1, status))
5364 return (FALSE);
5365 if ((status[1] != '3') || (status[2] != 'D'))
5366 return (FALSE);
5367 /* FIXME: SmartScroll Mouse has 5 buttons! XXX */
5368 if (arg == PROBE)
5369 sc->hw.buttons = 4;
5370 return (TRUE);
5371 }
5372
5373 /* Genius NetMouse/NetMouse Pro, ASCII Mie Mouse, NetScroll Optical */
5374 static int
5375 enable_gmouse(struct psm_softc *sc, enum probearg arg)
5376 {
5377 KBDC kbdc = sc->kbdc;
5378 int status[3];
5379
5380 /*
5381 * The special sequence to enable the middle, "rubber" button.
5382 * Immediately after this sequence check status bytes.
5383 * if the mouse is NetMouse, NetMouse Pro, or ASCII MIE Mouse,
5384 * the second and the third bytes are '3' and 'U'.
5385 * NOTE: NetMouse reports that it has three buttons although it has
5386 * two buttons and a rubber button. NetMouse Pro and MIE Mouse
5387 * say they have three buttons too and they do have a button on the
5388 * side...
5389 */
5390 if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 1, status))
5391 return (FALSE);
5392 if ((status[1] != '3') || (status[2] != 'U'))
5393 return (FALSE);
5394 return (TRUE);
5395 }
5396
5397 /* ALPS GlidePoint */
5398 static int
5399 enable_aglide(struct psm_softc *sc, enum probearg arg)
5400 {
5401 KBDC kbdc = sc->kbdc;
5402 int status[3];
5403
5404 /*
5405 * The special sequence to obtain ALPS GlidePoint specific
5406 * information. Immediately after this sequence, status bytes will
5407 * contain something interesting.
5408 * NOTE: ALPS produces several models of GlidePoint. Some of those
5409 * do not respond to this sequence, thus, cannot be detected this way.
5410 */
5411 if (set_mouse_sampling_rate(kbdc, 100) != 100)
5412 return (FALSE);
5413 if (!mouse_id_proc1(kbdc, PSMD_RES_LOW, 2, status))
5414 return (FALSE);
5415 if ((status[1] == PSMD_RES_LOW) || (status[2] == 100))
5416 return (FALSE);
5417 return (TRUE);
5418 }
5419
5420 /* Kensington ThinkingMouse/Trackball */
5421 static int
5422 enable_kmouse(struct psm_softc *sc, enum probearg arg)
5423 {
5424 static u_char rate[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20 };
5425 KBDC kbdc = sc->kbdc;
5426 int status[3];
5427 int id1;
5428 int id2;
5429 int i;
5430
5431 id1 = get_aux_id(kbdc);
5432 if (set_mouse_sampling_rate(kbdc, 10) != 10)
5433 return (FALSE);
5434 /*
5435 * The device is now in the native mode? It returns a different
5436 * ID value...
5437 */
5438 id2 = get_aux_id(kbdc);
5439 if ((id1 == id2) || (id2 != 2))
5440 return (FALSE);
5441
5442 if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
5443 return (FALSE);
5444 #if PSM_DEBUG >= 2
5445 /* at this point, resolution is LOW, sampling rate is 10/sec */
5446 if (get_mouse_status(kbdc, status, 0, 3) < 3)
5447 return (FALSE);
5448 #endif
5449
5450 /*
5451 * The special sequence to enable the third and fourth buttons.
5452 * Otherwise they behave like the first and second buttons.
5453 */
5454 for (i = 0; i < nitems(rate); ++i)
5455 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5456 return (FALSE);
5457
5458 /*
5459 * At this point, the device is using default resolution and
5460 * sampling rate for the native mode.
5461 */
5462 if (get_mouse_status(kbdc, status, 0, 3) < 3)
5463 return (FALSE);
5464 if ((status[1] == PSMD_RES_LOW) || (status[2] == rate[i - 1]))
5465 return (FALSE);
5466
5467 /* the device appears be enabled by this sequence, diable it for now */
5468 disable_aux_dev(kbdc);
5469 empty_aux_buffer(kbdc, 5);
5470
5471 return (TRUE);
5472 }
5473
5474 /* Logitech MouseMan+/FirstMouse+, IBM ScrollPoint Mouse */
5475 static int
5476 enable_mmanplus(struct psm_softc *sc, enum probearg arg)
5477 {
5478 KBDC kbdc = sc->kbdc;
5479 int data[3];
5480
5481 /* the special sequence to enable the fourth button and the roller. */
5482 /*
5483 * NOTE: for ScrollPoint to respond correctly, the SET_RESOLUTION
5484 * must be called exactly three times since the last RESET command
5485 * before this sequence. XXX
5486 */
5487 if (!set_mouse_scaling(kbdc, 1))
5488 return (FALSE);
5489 if (!mouse_ext_command(kbdc, 0x39) || !mouse_ext_command(kbdc, 0xdb))
5490 return (FALSE);
5491 if (get_mouse_status(kbdc, data, 1, 3) < 3)
5492 return (FALSE);
5493
5494 /*
5495 * PS2++ protocol, packet type 0
5496 *
5497 * b7 b6 b5 b4 b3 b2 b1 b0
5498 * byte 1: * 1 p3 p2 1 * * *
5499 * byte 2: 1 1 p1 p0 m1 m0 1 0
5500 * byte 3: m7 m6 m5 m4 m3 m2 m1 m0
5501 *
5502 * p3-p0: packet type: 0
5503 * m7-m0: model ID: MouseMan+:0x50,
5504 * FirstMouse+:0x51,
5505 * ScrollPoint:0x58...
5506 */
5507 /* check constant bits */
5508 if ((data[0] & MOUSE_PS2PLUS_SYNCMASK) != MOUSE_PS2PLUS_SYNC)
5509 return (FALSE);
5510 if ((data[1] & 0xc3) != 0xc2)
5511 return (FALSE);
5512 /* check d3-d0 in byte 2 */
5513 if (!MOUSE_PS2PLUS_CHECKBITS(data))
5514 return (FALSE);
5515 /* check p3-p0 */
5516 if (MOUSE_PS2PLUS_PACKET_TYPE(data) != 0)
5517 return (FALSE);
5518
5519 if (arg == PROBE) {
5520 sc->hw.hwid &= 0x00ff;
5521 sc->hw.hwid |= data[2] << 8; /* save model ID */
5522 }
5523
5524 /*
5525 * MouseMan+ (or FirstMouse+) is now in its native mode, in which
5526 * the wheel and the fourth button events are encoded in the
5527 * special data packet. The mouse may be put in the IntelliMouse mode
5528 * if it is initialized by the IntelliMouse's method.
5529 */
5530 return (TRUE);
5531 }
5532
5533 /* MS IntelliMouse Explorer */
5534 static int
5535 enable_msexplorer(struct psm_softc *sc, enum probearg arg)
5536 {
5537 KBDC kbdc = sc->kbdc;
5538 static u_char rate0[] = { 200, 100, 80, };
5539 static u_char rate1[] = { 200, 200, 80, };
5540 int id;
5541 int i;
5542
5543 /*
5544 * This is needed for at least A4Tech X-7xx mice - they do not go
5545 * straight to Explorer mode, but need to be set to Intelli mode
5546 * first.
5547 */
5548 enable_msintelli(sc, arg);
5549
5550 /* the special sequence to enable the extra buttons and the roller. */
5551 for (i = 0; i < nitems(rate1); ++i)
5552 if (set_mouse_sampling_rate(kbdc, rate1[i]) != rate1[i])
5553 return (FALSE);
5554 /* the device will give the genuine ID only after the above sequence */
5555 id = get_aux_id(kbdc);
5556 if (id != PSM_EXPLORER_ID)
5557 return (FALSE);
5558
5559 if (arg == PROBE) {
5560 sc->hw.buttons = 5; /* IntelliMouse Explorer XXX */
5561 sc->hw.hwid = id;
5562 }
5563
5564 /*
5565 * XXX: this is a kludge to fool some KVM switch products
5566 * which think they are clever enough to know the 4-byte IntelliMouse
5567 * protocol, and assume any other protocols use 3-byte packets.
5568 * They don't convey 4-byte data packets from the IntelliMouse Explorer
5569 * correctly to the host computer because of this!
5570 * The following sequence is actually IntelliMouse's "wake up"
5571 * sequence; it will make the KVM think the mouse is IntelliMouse
5572 * when it is in fact IntelliMouse Explorer.
5573 */
5574 for (i = 0; i < nitems(rate0); ++i)
5575 if (set_mouse_sampling_rate(kbdc, rate0[i]) != rate0[i])
5576 break;
5577 get_aux_id(kbdc);
5578
5579 return (TRUE);
5580 }
5581
5582 /*
5583 * MS IntelliMouse
5584 * Logitech MouseMan+ and FirstMouse+ will also respond to this
5585 * probe routine and act like IntelliMouse.
5586 */
5587 static int
5588 enable_msintelli(struct psm_softc *sc, enum probearg arg)
5589 {
5590 KBDC kbdc = sc->kbdc;
5591 static u_char rate[] = { 200, 100, 80, };
5592 int id;
5593 int i;
5594
5595 /* the special sequence to enable the third button and the roller. */
5596 for (i = 0; i < nitems(rate); ++i)
5597 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5598 return (FALSE);
5599 /* the device will give the genuine ID only after the above sequence */
5600 id = get_aux_id(kbdc);
5601 if (id != PSM_INTELLI_ID)
5602 return (FALSE);
5603
5604 if (arg == PROBE) {
5605 sc->hw.buttons = 3;
5606 sc->hw.hwid = id;
5607 }
5608
5609 return (TRUE);
5610 }
5611
5612 /*
5613 * A4 Tech 4D Mouse
5614 * Newer wheel mice from A4 Tech may use the 4D+ protocol.
5615 */
5616 static int
5617 enable_4dmouse(struct psm_softc *sc, enum probearg arg)
5618 {
5619 static u_char rate[] = { 200, 100, 80, 60, 40, 20 };
5620 KBDC kbdc = sc->kbdc;
5621 int id;
5622 int i;
5623
5624 for (i = 0; i < nitems(rate); ++i)
5625 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5626 return (FALSE);
5627 id = get_aux_id(kbdc);
5628 /*
5629 * WinEasy 4D, 4 Way Scroll 4D: 6
5630 * Cable-Free 4D: 8 (4DPLUS)
5631 * WinBest 4D+, 4 Way Scroll 4D+: 8 (4DPLUS)
5632 */
5633 if (id != PSM_4DMOUSE_ID)
5634 return (FALSE);
5635
5636 if (arg == PROBE) {
5637 sc->hw.buttons = 3; /* XXX some 4D mice have 4? */
5638 sc->hw.hwid = id;
5639 }
5640
5641 return (TRUE);
5642 }
5643
5644 /*
5645 * A4 Tech 4D+ Mouse
5646 * Newer wheel mice from A4 Tech seem to use this protocol.
5647 * Older models are recognized as either 4D Mouse or IntelliMouse.
5648 */
5649 static int
5650 enable_4dplus(struct psm_softc *sc, enum probearg arg)
5651 {
5652 KBDC kbdc = sc->kbdc;
5653 int id;
5654
5655 /*
5656 * enable_4dmouse() already issued the following ID sequence...
5657 static u_char rate[] = { 200, 100, 80, 60, 40, 20 };
5658 int i;
5659
5660 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i)
5661 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5662 return (FALSE);
5663 */
5664
5665 id = get_aux_id(kbdc);
5666 switch (id) {
5667 case PSM_4DPLUS_ID:
5668 break;
5669 case PSM_4DPLUS_RFSW35_ID:
5670 break;
5671 default:
5672 return (FALSE);
5673 }
5674
5675 if (arg == PROBE) {
5676 sc->hw.buttons = (id == PSM_4DPLUS_ID) ? 4 : 3;
5677 sc->hw.hwid = id;
5678 }
5679
5680 return (TRUE);
5681 }
5682
5683 /* Synaptics Touchpad */
5684 static int
5685 synaptics_sysctl(SYSCTL_HANDLER_ARGS)
5686 {
5687 struct psm_softc *sc;
5688 int error, arg;
5689
5690 if (oidp->oid_arg1 == NULL || oidp->oid_arg2 < 0 ||
5691 oidp->oid_arg2 > SYNAPTICS_SYSCTL_LAST)
5692 return (EINVAL);
5693
5694 sc = oidp->oid_arg1;
5695
5696 /* Read the current value. */
5697 arg = *(int *)((char *)sc + oidp->oid_arg2);
5698 error = sysctl_handle_int(oidp, &arg, 0, req);
5699
5700 /* Sanity check. */
5701 if (error || !req->newptr)
5702 return (error);
5703
5704 /*
5705 * Check that the new value is in the concerned node's range
5706 * of values.
5707 */
5708 switch (oidp->oid_arg2) {
5709 case SYNAPTICS_SYSCTL_MIN_PRESSURE:
5710 case SYNAPTICS_SYSCTL_MAX_PRESSURE:
5711 if (arg < 0 || arg > 255)
5712 return (EINVAL);
5713 break;
5714 case SYNAPTICS_SYSCTL_MAX_WIDTH:
5715 if (arg < 4 || arg > 15)
5716 return (EINVAL);
5717 break;
5718 case SYNAPTICS_SYSCTL_MARGIN_TOP:
5719 case SYNAPTICS_SYSCTL_MARGIN_BOTTOM:
5720 case SYNAPTICS_SYSCTL_NA_TOP:
5721 case SYNAPTICS_SYSCTL_NA_BOTTOM:
5722 if (arg < 0 || arg > sc->synhw.maximumYCoord)
5723 return (EINVAL);
5724 break;
5725 case SYNAPTICS_SYSCTL_SOFTBUTTON2_X:
5726 case SYNAPTICS_SYSCTL_SOFTBUTTON3_X:
5727 /* Softbuttons is clickpad only feature */
5728 if (!sc->synhw.capClickPad && arg != 0)
5729 return (EINVAL);
5730 /* FALLTHROUGH */
5731 case SYNAPTICS_SYSCTL_MARGIN_RIGHT:
5732 case SYNAPTICS_SYSCTL_MARGIN_LEFT:
5733 case SYNAPTICS_SYSCTL_NA_RIGHT:
5734 case SYNAPTICS_SYSCTL_NA_LEFT:
5735 if (arg < 0 || arg > sc->synhw.maximumXCoord)
5736 return (EINVAL);
5737 break;
5738 case SYNAPTICS_SYSCTL_WINDOW_MIN:
5739 case SYNAPTICS_SYSCTL_WINDOW_MAX:
5740 case SYNAPTICS_SYSCTL_TAP_MIN_QUEUE:
5741 if (arg < 1 || arg > SYNAPTICS_PACKETQUEUE)
5742 return (EINVAL);
5743 break;
5744 case SYNAPTICS_SYSCTL_MULTIPLICATOR:
5745 case SYNAPTICS_SYSCTL_WEIGHT_CURRENT:
5746 case SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS:
5747 case SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS_NA:
5748 case SYNAPTICS_SYSCTL_WEIGHT_LEN_SQUARED:
5749 case SYNAPTICS_SYSCTL_DIV_MIN:
5750 case SYNAPTICS_SYSCTL_DIV_MAX:
5751 case SYNAPTICS_SYSCTL_DIV_MAX_NA:
5752 case SYNAPTICS_SYSCTL_DIV_LEN:
5753 case SYNAPTICS_SYSCTL_VSCROLL_DIV_MIN:
5754 case SYNAPTICS_SYSCTL_VSCROLL_DIV_MAX:
5755 if (arg < 1)
5756 return (EINVAL);
5757 break;
5758 case SYNAPTICS_SYSCTL_TAP_MAX_DELTA:
5759 case SYNAPTICS_SYSCTL_TAPHOLD_TIMEOUT:
5760 case SYNAPTICS_SYSCTL_VSCROLL_MIN_DELTA:
5761 if (arg < 0)
5762 return (EINVAL);
5763 break;
5764 case SYNAPTICS_SYSCTL_VSCROLL_HOR_AREA:
5765 if (arg < -sc->synhw.maximumXCoord ||
5766 arg > sc->synhw.maximumXCoord)
5767 return (EINVAL);
5768 break;
5769 case SYNAPTICS_SYSCTL_SOFTBUTTONS_Y:
5770 /* Softbuttons is clickpad only feature */
5771 if (!sc->synhw.capClickPad && arg != 0)
5772 return (EINVAL);
5773 /* FALLTHROUGH */
5774 case SYNAPTICS_SYSCTL_VSCROLL_VER_AREA:
5775 if (arg < -sc->synhw.maximumYCoord ||
5776 arg > sc->synhw.maximumYCoord)
5777 return (EINVAL);
5778 break;
5779 case SYNAPTICS_SYSCTL_TOUCHPAD_OFF:
5780 case SYNAPTICS_SYSCTL_THREE_FINGER_DRAG:
5781 case SYNAPTICS_SYSCTL_NATURAL_SCROLL:
5782 if (arg < 0 || arg > 1)
5783 return (EINVAL);
5784 break;
5785 default:
5786 return (EINVAL);
5787 }
5788
5789 /* Update. */
5790 *(int *)((char *)sc + oidp->oid_arg2) = arg;
5791
5792 return (error);
5793 }
5794
5795 static void
5796 synaptics_sysctl_create_softbuttons_tree(struct psm_softc *sc)
5797 {
5798 /*
5799 * Set predefined sizes for softbuttons.
5800 * Values are taken to match HP Pavilion dv6 clickpad drawings
5801 * with thin middle softbutton placed on separator
5802 */
5803
5804 /* hw.psm.synaptics.softbuttons_y */
5805 sc->syninfo.softbuttons_y = sc->synhw.topButtonPad ? -1700 : 1700;
5806 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5807 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5808 "softbuttons_y", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5809 sc, SYNAPTICS_SYSCTL_SOFTBUTTONS_Y,
5810 synaptics_sysctl, "I",
5811 "Vertical size of softbuttons area");
5812
5813 /* hw.psm.synaptics.softbutton2_x */
5814 sc->syninfo.softbutton2_x = 3100;
5815 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5816 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5817 "softbutton2_x", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5818 sc, SYNAPTICS_SYSCTL_SOFTBUTTON2_X,
5819 synaptics_sysctl, "I",
5820 "Horisontal position of 2-nd softbutton left edge (0-disable)");
5821
5822 /* hw.psm.synaptics.softbutton3_x */
5823 sc->syninfo.softbutton3_x = 3900;
5824 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5825 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5826 "softbutton3_x", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5827 sc, SYNAPTICS_SYSCTL_SOFTBUTTON3_X,
5828 synaptics_sysctl, "I",
5829 "Horisontal position of 3-rd softbutton left edge (0-disable)");
5830 }
5831
5832 static void
5833 synaptics_sysctl_create_tree(struct psm_softc *sc, const char *name,
5834 const char *descr)
5835 {
5836
5837 if (sc->syninfo.sysctl_tree != NULL)
5838 return;
5839
5840 /* Attach extra synaptics sysctl nodes under hw.psm.synaptics */
5841 sysctl_ctx_init(&sc->syninfo.sysctl_ctx);
5842 sc->syninfo.sysctl_tree = SYSCTL_ADD_NODE(&sc->syninfo.sysctl_ctx,
5843 SYSCTL_STATIC_CHILDREN(_hw_psm), OID_AUTO, name, CTLFLAG_RD,
5844 0, descr);
5845
5846 /* hw.psm.synaptics.directional_scrolls. */
5847 sc->syninfo.directional_scrolls = 0;
5848 SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5849 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5850 "directional_scrolls", CTLFLAG_RW|CTLFLAG_ANYBODY,
5851 &sc->syninfo.directional_scrolls, 0,
5852 "Enable hardware scrolling pad (if non-zero) or register it as "
5853 "extended buttons (if 0)");
5854
5855 /* hw.psm.synaptics.max_x. */
5856 sc->syninfo.max_x = 6143;
5857 SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5858 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5859 "max_x", CTLFLAG_RD|CTLFLAG_ANYBODY,
5860 &sc->syninfo.max_x, 0,
5861 "Horizontal reporting range");
5862
5863 /* hw.psm.synaptics.max_y. */
5864 sc->syninfo.max_y = 6143;
5865 SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5866 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5867 "max_y", CTLFLAG_RD|CTLFLAG_ANYBODY,
5868 &sc->syninfo.max_y, 0,
5869 "Vertical reporting range");
5870
5871 /*
5872 * Turn off two finger scroll if we have a
5873 * physical area reserved for scrolling or when
5874 * there's no multi finger support.
5875 */
5876 if (sc->synhw.verticalScroll || (sc->synhw.capMultiFinger == 0 &&
5877 sc->synhw.capAdvancedGestures == 0))
5878 sc->syninfo.two_finger_scroll = 0;
5879 else
5880 sc->syninfo.two_finger_scroll = 1;
5881 /* hw.psm.synaptics.two_finger_scroll. */
5882 SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5883 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5884 "two_finger_scroll", CTLFLAG_RW|CTLFLAG_ANYBODY,
5885 &sc->syninfo.two_finger_scroll, 0,
5886 "Enable two finger scrolling");
5887
5888 /* hw.psm.synaptics.min_pressure. */
5889 sc->syninfo.min_pressure = 32;
5890 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5891 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5892 "min_pressure", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5893 sc, SYNAPTICS_SYSCTL_MIN_PRESSURE,
5894 synaptics_sysctl, "I",
5895 "Minimum pressure required to start an action");
5896
5897 /* hw.psm.synaptics.max_pressure. */
5898 sc->syninfo.max_pressure = 220;
5899 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5900 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5901 "max_pressure", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5902 sc, SYNAPTICS_SYSCTL_MAX_PRESSURE,
5903 synaptics_sysctl, "I",
5904 "Maximum pressure to detect palm");
5905
5906 /* hw.psm.synaptics.max_width. */
5907 sc->syninfo.max_width = 10;
5908 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5909 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5910 "max_width", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5911 sc, SYNAPTICS_SYSCTL_MAX_WIDTH,
5912 synaptics_sysctl, "I",
5913 "Maximum finger width to detect palm");
5914
5915 /* hw.psm.synaptics.top_margin. */
5916 sc->syninfo.margin_top = 200;
5917 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5918 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5919 "margin_top", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5920 sc, SYNAPTICS_SYSCTL_MARGIN_TOP,
5921 synaptics_sysctl, "I",
5922 "Top margin");
5923
5924 /* hw.psm.synaptics.right_margin. */
5925 sc->syninfo.margin_right = 200;
5926 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5927 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5928 "margin_right", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5929 sc, SYNAPTICS_SYSCTL_MARGIN_RIGHT,
5930 synaptics_sysctl, "I",
5931 "Right margin");
5932
5933 /* hw.psm.synaptics.bottom_margin. */
5934 sc->syninfo.margin_bottom = 200;
5935 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5936 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5937 "margin_bottom", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5938 sc, SYNAPTICS_SYSCTL_MARGIN_BOTTOM,
5939 synaptics_sysctl, "I",
5940 "Bottom margin");
5941
5942 /* hw.psm.synaptics.left_margin. */
5943 sc->syninfo.margin_left = 200;
5944 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5945 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5946 "margin_left", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5947 sc, SYNAPTICS_SYSCTL_MARGIN_LEFT,
5948 synaptics_sysctl, "I",
5949 "Left margin");
5950
5951 /* hw.psm.synaptics.na_top. */
5952 sc->syninfo.na_top = 1783;
5953 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5954 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5955 "na_top", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5956 sc, SYNAPTICS_SYSCTL_NA_TOP,
5957 synaptics_sysctl, "I",
5958 "Top noisy area, where weight_previous_na is used instead "
5959 "of weight_previous");
5960
5961 /* hw.psm.synaptics.na_right. */
5962 sc->syninfo.na_right = 563;
5963 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5964 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5965 "na_right", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5966 sc, SYNAPTICS_SYSCTL_NA_RIGHT,
5967 synaptics_sysctl, "I",
5968 "Right noisy area, where weight_previous_na is used instead "
5969 "of weight_previous");
5970
5971 /* hw.psm.synaptics.na_bottom. */
5972 sc->syninfo.na_bottom = 1408;
5973 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5974 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5975 "na_bottom", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5976 sc, SYNAPTICS_SYSCTL_NA_BOTTOM,
5977 synaptics_sysctl, "I",
5978 "Bottom noisy area, where weight_previous_na is used instead "
5979 "of weight_previous");
5980
5981 /* hw.psm.synaptics.na_left. */
5982 sc->syninfo.na_left = 1600;
5983 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5984 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5985 "na_left", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5986 sc, SYNAPTICS_SYSCTL_NA_LEFT,
5987 synaptics_sysctl, "I",
5988 "Left noisy area, where weight_previous_na is used instead "
5989 "of weight_previous");
5990
5991 /* hw.psm.synaptics.window_min. */
5992 sc->syninfo.window_min = 4;
5993 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5994 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5995 "window_min", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5996 sc, SYNAPTICS_SYSCTL_WINDOW_MIN,
5997 synaptics_sysctl, "I",
5998 "Minimum window size to start an action");
5999
6000 /* hw.psm.synaptics.window_max. */
6001 sc->syninfo.window_max = 10;
6002 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6003 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6004 "window_max", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6005 sc, SYNAPTICS_SYSCTL_WINDOW_MAX,
6006 synaptics_sysctl, "I",
6007 "Maximum window size");
6008
6009 /* hw.psm.synaptics.multiplicator. */
6010 sc->syninfo.multiplicator = 10000;
6011 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6012 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6013 "multiplicator", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6014 sc, SYNAPTICS_SYSCTL_MULTIPLICATOR,
6015 synaptics_sysctl, "I",
6016 "Multiplicator to increase precision in averages and divisions");
6017
6018 /* hw.psm.synaptics.weight_current. */
6019 sc->syninfo.weight_current = 3;
6020 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6021 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6022 "weight_current", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6023 sc, SYNAPTICS_SYSCTL_WEIGHT_CURRENT,
6024 synaptics_sysctl, "I",
6025 "Weight of the current movement in the new average");
6026
6027 /* hw.psm.synaptics.weight_previous. */
6028 sc->syninfo.weight_previous = 6;
6029 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6030 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6031 "weight_previous", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6032 sc, SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS,
6033 synaptics_sysctl, "I",
6034 "Weight of the previous average");
6035
6036 /* hw.psm.synaptics.weight_previous_na. */
6037 sc->syninfo.weight_previous_na = 20;
6038 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6039 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6040 "weight_previous_na", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6041 sc, SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS_NA,
6042 synaptics_sysctl, "I",
6043 "Weight of the previous average (inside the noisy area)");
6044
6045 /* hw.psm.synaptics.weight_len_squared. */
6046 sc->syninfo.weight_len_squared = 2000;
6047 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6048 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6049 "weight_len_squared", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6050 sc, SYNAPTICS_SYSCTL_WEIGHT_LEN_SQUARED,
6051 synaptics_sysctl, "I",
6052 "Length (squared) of segments where weight_previous "
6053 "starts to decrease");
6054
6055 /* hw.psm.synaptics.div_min. */
6056 sc->syninfo.div_min = 9;
6057 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6058 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6059 "div_min", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6060 sc, SYNAPTICS_SYSCTL_DIV_MIN,
6061 synaptics_sysctl, "I",
6062 "Divisor for fast movements");
6063
6064 /* hw.psm.synaptics.div_max. */
6065 sc->syninfo.div_max = 17;
6066 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6067 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6068 "div_max", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6069 sc, SYNAPTICS_SYSCTL_DIV_MAX,
6070 synaptics_sysctl, "I",
6071 "Divisor for slow movements");
6072
6073 /* hw.psm.synaptics.div_max_na. */
6074 sc->syninfo.div_max_na = 30;
6075 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6076 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6077 "div_max_na", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6078 sc, SYNAPTICS_SYSCTL_DIV_MAX_NA,
6079 synaptics_sysctl, "I",
6080 "Divisor with slow movements (inside the noisy area)");
6081
6082 /* hw.psm.synaptics.div_len. */
6083 sc->syninfo.div_len = 100;
6084 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6085 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6086 "div_len", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6087 sc, SYNAPTICS_SYSCTL_DIV_LEN,
6088 synaptics_sysctl, "I",
6089 "Length of segments where div_max starts to decrease");
6090
6091 /* hw.psm.synaptics.tap_max_delta. */
6092 sc->syninfo.tap_max_delta = 80;
6093 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6094 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6095 "tap_max_delta", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6096 sc, SYNAPTICS_SYSCTL_TAP_MAX_DELTA,
6097 synaptics_sysctl, "I",
6098 "Length of segments above which a tap is ignored");
6099
6100 /* hw.psm.synaptics.tap_min_queue. */
6101 sc->syninfo.tap_min_queue = 2;
6102 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6103 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6104 "tap_min_queue", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6105 sc, SYNAPTICS_SYSCTL_TAP_MIN_QUEUE,
6106 synaptics_sysctl, "I",
6107 "Number of packets required to consider a tap");
6108
6109 /* hw.psm.synaptics.taphold_timeout. */
6110 sc->gesture.in_taphold = 0;
6111 sc->syninfo.taphold_timeout = tap_timeout;
6112 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6113 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6114 "taphold_timeout", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6115 sc, SYNAPTICS_SYSCTL_TAPHOLD_TIMEOUT,
6116 synaptics_sysctl, "I",
6117 "Maximum elapsed time between two taps to consider a tap-hold "
6118 "action");
6119
6120 /* hw.psm.synaptics.vscroll_hor_area. */
6121 sc->syninfo.vscroll_hor_area = 0; /* 1300 */
6122 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6123 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6124 "vscroll_hor_area", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6125 sc, SYNAPTICS_SYSCTL_VSCROLL_HOR_AREA,
6126 synaptics_sysctl, "I",
6127 "Area reserved for horizontal virtual scrolling");
6128
6129 /* hw.psm.synaptics.vscroll_ver_area. */
6130 sc->syninfo.vscroll_ver_area = -400 - sc->syninfo.margin_right;
6131 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6132 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6133 "vscroll_ver_area", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6134 sc, SYNAPTICS_SYSCTL_VSCROLL_VER_AREA,
6135 synaptics_sysctl, "I",
6136 "Area reserved for vertical virtual scrolling");
6137
6138 /* hw.psm.synaptics.vscroll_min_delta. */
6139 sc->syninfo.vscroll_min_delta = 50;
6140 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6141 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6142 "vscroll_min_delta", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6143 sc, SYNAPTICS_SYSCTL_VSCROLL_MIN_DELTA,
6144 synaptics_sysctl, "I",
6145 "Minimum movement to consider virtual scrolling");
6146
6147 /* hw.psm.synaptics.vscroll_div_min. */
6148 sc->syninfo.vscroll_div_min = 100;
6149 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6150 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6151 "vscroll_div_min", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6152 sc, SYNAPTICS_SYSCTL_VSCROLL_DIV_MIN,
6153 synaptics_sysctl, "I",
6154 "Divisor for fast scrolling");
6155
6156 /* hw.psm.synaptics.vscroll_div_min. */
6157 sc->syninfo.vscroll_div_max = 150;
6158 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6159 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6160 "vscroll_div_max", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6161 sc, SYNAPTICS_SYSCTL_VSCROLL_DIV_MAX,
6162 synaptics_sysctl, "I",
6163 "Divisor for slow scrolling");
6164
6165 /* hw.psm.synaptics.touchpad_off. */
6166 sc->syninfo.touchpad_off = 0;
6167 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6168 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6169 "touchpad_off", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6170 sc, SYNAPTICS_SYSCTL_TOUCHPAD_OFF,
6171 synaptics_sysctl, "I",
6172 "Turn off touchpad");
6173
6174 sc->syninfo.three_finger_drag = 0;
6175 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6176 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6177 "three_finger_drag", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6178 sc, SYNAPTICS_SYSCTL_THREE_FINGER_DRAG,
6179 synaptics_sysctl, "I",
6180 "Enable dragging with three fingers");
6181
6182 /* hw.psm.synaptics.natural_scroll. */
6183 sc->syninfo.natural_scroll = 0;
6184 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6185 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6186 "natural_scroll", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6187 sc, SYNAPTICS_SYSCTL_NATURAL_SCROLL,
6188 synaptics_sysctl, "I",
6189 "Enable natural scrolling");
6190
6191 sc->syninfo.softbuttons_y = 0;
6192 sc->syninfo.softbutton2_x = 0;
6193 sc->syninfo.softbutton3_x = 0;
6194
6195 /* skip softbuttons sysctl on not clickpads */
6196 if (sc->synhw.capClickPad)
6197 synaptics_sysctl_create_softbuttons_tree(sc);
6198 }
6199
6200 static int
6201 synaptics_preferred_mode(struct psm_softc *sc) {
6202 int mode_byte;
6203
6204 /* Check if we are in relative mode */
6205 if (sc->hw.model != MOUSE_MODEL_SYNAPTICS) {
6206 if (tap_enabled == 0)
6207 /*
6208 * Disable tap & drag gestures. We use a Mode Byte
6209 * and set the DisGest bit (see §2.5 of Synaptics
6210 * TouchPad Interfacing Guide).
6211 */
6212 return (0x04);
6213 else
6214 /*
6215 * Enable tap & drag gestures. We use a Mode Byte
6216 * and clear the DisGest bit (see §2.5 of Synaptics
6217 * TouchPad Interfacing Guide).
6218 */
6219 return (0x00);
6220 }
6221
6222 mode_byte = 0xc4;
6223
6224 /* request wmode where available */
6225 if (sc->synhw.capExtended)
6226 mode_byte |= 1;
6227
6228 return mode_byte;
6229 }
6230
6231 static void
6232 synaptics_set_mode(struct psm_softc *sc, int mode_byte) {
6233 mouse_ext_command(sc->kbdc, mode_byte);
6234
6235 /* "Commit" the Set Mode Byte command sent above. */
6236 set_mouse_sampling_rate(sc->kbdc, 20);
6237
6238 /*
6239 * Enable advanced gestures mode if supported and we are not entering
6240 * passthrough or relative mode.
6241 */
6242 if ((sc->synhw.capAdvancedGestures || sc->synhw.capReportsV) &&
6243 sc->hw.model == MOUSE_MODEL_SYNAPTICS && !(mode_byte & (1 << 5))) {
6244 mouse_ext_command(sc->kbdc, SYNAPTICS_READ_MODEL_ID);
6245 set_mouse_sampling_rate(sc->kbdc, 0xc8);
6246 }
6247 }
6248
6249 /*
6250 * AUX MUX detection code should be placed at very beginning of probe sequence
6251 * at least before 4-byte protocol mouse probes e.g. MS IntelliMouse probe as
6252 * latter can trigger switching the MUX to incompatible state.
6253 */
6254 static int
6255 enable_synaptics_mux(struct psm_softc *sc, enum probearg arg)
6256 {
6257 KBDC kbdc = sc->kbdc;
6258 int port, version;
6259 int probe = FALSE;
6260 int active_ports_count = 0;
6261 int active_ports_mask = 0;
6262
6263 sc->muxsinglesyna = FALSE;
6264
6265 if (mux_disabled == 1 || (mux_disabled == -1 &&
6266 (kbdcp(kbdc)->quirks & KBDC_QUIRK_DISABLE_MUX_PROBE) != 0))
6267 return (FALSE);
6268
6269 version = enable_aux_mux(kbdc);
6270 if (version == -1)
6271 return (FALSE);
6272
6273 for (port = 0; port < KBDC_AUX_MUX_NUM_PORTS; port++) {
6274 VLOG(3, (LOG_DEBUG, "aux_mux: ping port %d\n", port));
6275 set_active_aux_mux_port(kbdc, port);
6276 if (enable_aux_dev(kbdc) && disable_aux_dev(kbdc)) {
6277 active_ports_count++;
6278 active_ports_mask |= 1 << port;
6279 }
6280 }
6281
6282 if (verbose >= 2)
6283 printf("Active Multiplexing PS/2 controller v%d.%d with %d "
6284 "active port(s)\n", version >> 4 & 0x0f, version & 0x0f,
6285 active_ports_count);
6286
6287 /* psm has a special support for GenMouse + SynTouchpad combination */
6288 for (port = 0; port < KBDC_AUX_MUX_NUM_PORTS; port++) {
6289 if ((active_ports_mask & 1 << port) == 0)
6290 continue;
6291 VLOG(3, (LOG_DEBUG, "aux_mux: probe port %d\n", port));
6292 set_active_aux_mux_port(kbdc, port);
6293 probe = enable_synaptics(sc, arg);
6294 if (probe) {
6295 if (arg == PROBE)
6296 sc->muxport = port;
6297 break;
6298 }
6299 }
6300
6301 /* IRQ handler does not support active multiplexing mode */
6302 disable_aux_mux(kbdc);
6303
6304 /* Is MUX still alive after switching back to legacy mode? */
6305 if (!enable_aux_dev(kbdc) || !disable_aux_dev(kbdc)) {
6306 /*
6307 * On some laptops e.g. Lenovo X121e dead AUX MUX can be
6308 * brought back to life with resetting of keyboard.
6309 */
6310 reset_kbd(kbdc);
6311 if (!enable_aux_dev(kbdc) || !disable_aux_dev(kbdc)) {
6312 printf("psm%d: AUX MUX hang detected!\n", sc->unit);
6313 printf("Consider adding hw.psm.mux_disabled=1 to "
6314 "loader tunables\n");
6315 }
6316 }
6317 empty_both_buffers(kbdc, 10); /* remove stray data if any */
6318
6319 /* Don't disable syncbit checks if Synaptics is only device on MUX */
6320 if (active_ports_count == 1)
6321 sc->muxsinglesyna = probe;
6322 return (active_ports_count != 1 ? probe : FALSE);
6323 }
6324
6325 static int
6326 enable_single_synaptics_mux(struct psm_softc *sc, enum probearg arg)
6327 {
6328 /* Synaptics device is already initialized in enable_synaptics_mux */
6329 return (sc->muxsinglesyna);
6330 }
6331
6332 static int
6333 enable_synaptics(struct psm_softc *sc, enum probearg arg)
6334 {
6335 device_t psmcpnp;
6336 struct psmcpnp_softc *psmcpnp_sc;
6337 KBDC kbdc = sc->kbdc;
6338 synapticshw_t synhw;
6339 int status[3];
6340 int buttons;
6341
6342 VLOG(3, (LOG_DEBUG, "synaptics: BEGIN init\n"));
6343
6344 /*
6345 * Just to be on the safe side: this avoids troubles with
6346 * following mouse_ext_command() when the previous command
6347 * was PSMC_SET_RESOLUTION. Set Scaling has no effect on
6348 * Synaptics Touchpad behaviour.
6349 */
6350 set_mouse_scaling(kbdc, 1);
6351
6352 /* Identify the Touchpad version. */
6353 if (mouse_ext_command(kbdc, SYNAPTICS_READ_IDENTITY) == 0)
6354 return (FALSE);
6355 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6356 return (FALSE);
6357 if (status[1] != 0x47)
6358 return (FALSE);
6359
6360 bzero(&synhw, sizeof(synhw));
6361 synhw.infoMinor = status[0];
6362 synhw.infoMajor = status[2] & 0x0f;
6363
6364 if (verbose >= 2)
6365 printf("Synaptics Touchpad v%d.%d\n", synhw.infoMajor,
6366 synhw.infoMinor);
6367
6368 if (synhw.infoMajor < 4) {
6369 printf(" Unsupported (pre-v4) Touchpad detected\n");
6370 return (FALSE);
6371 }
6372
6373 /* Get the Touchpad model information. */
6374 if (mouse_ext_command(kbdc, SYNAPTICS_READ_MODEL_ID) == 0)
6375 return (FALSE);
6376 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6377 return (FALSE);
6378 if ((status[1] & 0x01) != 0) {
6379 printf(" Failed to read model information\n");
6380 return (FALSE);
6381 }
6382
6383 synhw.infoRot180 = (status[0] & 0x80) != 0;
6384 synhw.infoPortrait = (status[0] & 0x40) != 0;
6385 synhw.infoSensor = status[0] & 0x3f;
6386 synhw.infoHardware = (status[1] & 0xfe) >> 1;
6387 synhw.infoNewAbs = (status[2] & 0x80) != 0;
6388 synhw.capPen = (status[2] & 0x40) != 0;
6389 synhw.infoSimplC = (status[2] & 0x20) != 0;
6390 synhw.infoGeometry = status[2] & 0x0f;
6391
6392 if (verbose >= 2) {
6393 printf(" Model information:\n");
6394 printf(" infoRot180: %d\n", synhw.infoRot180);
6395 printf(" infoPortrait: %d\n", synhw.infoPortrait);
6396 printf(" infoSensor: %d\n", synhw.infoSensor);
6397 printf(" infoHardware: %d\n", synhw.infoHardware);
6398 printf(" infoNewAbs: %d\n", synhw.infoNewAbs);
6399 printf(" capPen: %d\n", synhw.capPen);
6400 printf(" infoSimplC: %d\n", synhw.infoSimplC);
6401 printf(" infoGeometry: %d\n", synhw.infoGeometry);
6402 }
6403
6404 /*
6405 * Typical bezel limits. Taken from 'Synaptics
6406 * PS/2 * TouchPad Interfacing Guide' p.3.2.3.
6407 */
6408 synhw.maximumXCoord = 5472;
6409 synhw.maximumYCoord = 4448;
6410 synhw.minimumXCoord = 1472;
6411 synhw.minimumYCoord = 1408;
6412
6413 /* Read the extended capability bits. */
6414 if (mouse_ext_command(kbdc, SYNAPTICS_READ_CAPABILITIES) == 0)
6415 return (FALSE);
6416 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6417 return (FALSE);
6418 if (!SYNAPTICS_VERSION_GE(synhw, 7, 5) && status[1] != 0x47) {
6419 printf(" Failed to read extended capability bits\n");
6420 return (FALSE);
6421 }
6422
6423 psmcpnp = devclass_get_device(devclass_find(PSMCPNP_DRIVER_NAME),
6424 sc->unit);
6425 psmcpnp_sc = (psmcpnp != NULL) ? device_get_softc(psmcpnp) : NULL;
6426
6427 /* Set the different capabilities when they exist. */
6428 buttons = 0;
6429 synhw.capExtended = (status[0] & 0x80) != 0;
6430 if (synhw.capExtended) {
6431 synhw.nExtendedQueries = (status[0] & 0x70) >> 4;
6432 synhw.capMiddle = (status[0] & 0x04) != 0;
6433 synhw.capPassthrough = (status[2] & 0x80) != 0;
6434 synhw.capLowPower = (status[2] & 0x40) != 0;
6435 synhw.capMultiFingerReport =
6436 (status[2] & 0x20) != 0;
6437 synhw.capSleep = (status[2] & 0x10) != 0;
6438 synhw.capFourButtons = (status[2] & 0x08) != 0;
6439 synhw.capBallistics = (status[2] & 0x04) != 0;
6440 synhw.capMultiFinger = (status[2] & 0x02) != 0;
6441 synhw.capPalmDetect = (status[2] & 0x01) != 0;
6442
6443 if (!set_mouse_scaling(kbdc, 1))
6444 return (FALSE);
6445 if (mouse_ext_command(kbdc, SYNAPTICS_READ_RESOLUTIONS) == 0)
6446 return (FALSE);
6447 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6448 return (FALSE);
6449
6450 if (status[0] != 0 && (status[1] & 0x80) && status[2] != 0) {
6451 synhw.infoXupmm = status[0];
6452 synhw.infoYupmm = status[2];
6453 }
6454
6455 if (verbose >= 2) {
6456 printf(" Extended capabilities:\n");
6457 printf(" capExtended: %d\n", synhw.capExtended);
6458 printf(" capMiddle: %d\n", synhw.capMiddle);
6459 printf(" nExtendedQueries: %d\n",
6460 synhw.nExtendedQueries);
6461 printf(" capPassthrough: %d\n", synhw.capPassthrough);
6462 printf(" capLowPower: %d\n", synhw.capLowPower);
6463 printf(" capMultiFingerReport: %d\n",
6464 synhw.capMultiFingerReport);
6465 printf(" capSleep: %d\n", synhw.capSleep);
6466 printf(" capFourButtons: %d\n", synhw.capFourButtons);
6467 printf(" capBallistics: %d\n", synhw.capBallistics);
6468 printf(" capMultiFinger: %d\n", synhw.capMultiFinger);
6469 printf(" capPalmDetect: %d\n", synhw.capPalmDetect);
6470 printf(" infoXupmm: %d\n", synhw.infoXupmm);
6471 printf(" infoYupmm: %d\n", synhw.infoYupmm);
6472 }
6473
6474 /*
6475 * If nExtendedQueries is 1 or greater, then the TouchPad
6476 * supports this number of extended queries. We can load
6477 * more information about buttons using query 0x09.
6478 */
6479 if (synhw.nExtendedQueries >= 1) {
6480 if (!set_mouse_scaling(kbdc, 1))
6481 return (FALSE);
6482 if (mouse_ext_command(kbdc,
6483 SYNAPTICS_READ_EXTENDED) == 0)
6484 return (FALSE);
6485 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6486 return (FALSE);
6487 synhw.verticalScroll = (status[0] & 0x01) != 0;
6488 synhw.horizontalScroll = (status[0] & 0x02) != 0;
6489 synhw.verticalWheel = (status[0] & 0x08) != 0;
6490 synhw.nExtendedButtons = (status[1] & 0xf0) >> 4;
6491 synhw.capEWmode = (status[0] & 0x04) != 0;
6492 if (verbose >= 2) {
6493 printf(" Extended model ID:\n");
6494 printf(" verticalScroll: %d\n",
6495 synhw.verticalScroll);
6496 printf(" horizontalScroll: %d\n",
6497 synhw.horizontalScroll);
6498 printf(" verticalWheel: %d\n",
6499 synhw.verticalWheel);
6500 printf(" nExtendedButtons: %d\n",
6501 synhw.nExtendedButtons);
6502 printf(" capEWmode: %d\n",
6503 synhw.capEWmode);
6504 }
6505 /*
6506 * Add the number of extended buttons to the total
6507 * button support count, including the middle button
6508 * if capMiddle support bit is set.
6509 */
6510 buttons = synhw.nExtendedButtons + synhw.capMiddle;
6511 } else
6512 /*
6513 * If the capFourButtons support bit is set,
6514 * add a fourth button to the total button count.
6515 */
6516 buttons = synhw.capFourButtons ? 1 : 0;
6517
6518 /* Read the continued capabilities bits. */
6519 if (synhw.nExtendedQueries >= 4) {
6520 if (!set_mouse_scaling(kbdc, 1))
6521 return (FALSE);
6522 if (mouse_ext_command(kbdc,
6523 SYNAPTICS_READ_CAPABILITIES_CONT) == 0)
6524 return (FALSE);
6525 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6526 return (FALSE);
6527
6528 synhw.capClickPad = (status[1] & 0x01) << 1;
6529 synhw.capClickPad |= (status[0] & 0x10) != 0;
6530 synhw.capDeluxeLEDs = (status[1] & 0x02) != 0;
6531 synhw.noAbsoluteFilter = (status[1] & 0x04) != 0;
6532 synhw.capReportsV = (status[1] & 0x08) != 0;
6533 synhw.capUniformClickPad = (status[1] & 0x10) != 0;
6534 synhw.capReportsMin = (status[1] & 0x20) != 0;
6535 synhw.capInterTouch = (status[1] & 0x40) != 0;
6536 synhw.capReportsMax = (status[0] & 0x02) != 0;
6537 synhw.capClearPad = (status[0] & 0x04) != 0;
6538 synhw.capAdvancedGestures = (status[0] & 0x08) != 0;
6539 synhw.capCoveredPad = (status[0] & 0x80) != 0;
6540
6541 if (synhw.capReportsMax) {
6542 if (!set_mouse_scaling(kbdc, 1))
6543 return (FALSE);
6544 if (mouse_ext_command(kbdc,
6545 SYNAPTICS_READ_MAX_COORDS) == 0)
6546 return (FALSE);
6547 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6548 return (FALSE);
6549
6550 synhw.maximumXCoord = (status[0] << 5) |
6551 ((status[1] & 0x0f) << 1);
6552 synhw.maximumYCoord = (status[2] << 5) |
6553 ((status[1] & 0xf0) >> 3);
6554 }
6555
6556 if (synhw.capReportsMin) {
6557 if (!set_mouse_scaling(kbdc, 1))
6558 return (FALSE);
6559 if (mouse_ext_command(kbdc,
6560 SYNAPTICS_READ_MIN_COORDS) == 0)
6561 return (FALSE);
6562 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6563 return (FALSE);
6564
6565 synhw.minimumXCoord = (status[0] << 5) |
6566 ((status[1] & 0x0f) << 1);
6567 synhw.minimumYCoord = (status[2] << 5) |
6568 ((status[1] & 0xf0) >> 3);
6569 }
6570
6571 /*
6572 * ClickPad properties are not exported through PS/2
6573 * protocol. Detection is based on controller's PnP ID.
6574 */
6575 if (synhw.capClickPad && psmcpnp_sc != NULL) {
6576 switch (psmcpnp_sc->type) {
6577 case PSMCPNP_FORCEPAD:
6578 synhw.forcePad = 1;
6579 break;
6580 case PSMCPNP_TOPBUTTONPAD:
6581 synhw.topButtonPad = 1;
6582 break;
6583 default:
6584 break;
6585 }
6586 }
6587
6588 if (verbose >= 2) {
6589 printf(" Continued capabilities:\n");
6590 printf(" capClickPad: %d\n",
6591 synhw.capClickPad);
6592 printf(" capDeluxeLEDs: %d\n",
6593 synhw.capDeluxeLEDs);
6594 printf(" noAbsoluteFilter: %d\n",
6595 synhw.noAbsoluteFilter);
6596 printf(" capReportsV: %d\n",
6597 synhw.capReportsV);
6598 printf(" capUniformClickPad: %d\n",
6599 synhw.capUniformClickPad);
6600 printf(" capReportsMin: %d\n",
6601 synhw.capReportsMin);
6602 printf(" capInterTouch: %d\n",
6603 synhw.capInterTouch);
6604 printf(" capReportsMax: %d\n",
6605 synhw.capReportsMax);
6606 printf(" capClearPad: %d\n",
6607 synhw.capClearPad);
6608 printf(" capAdvancedGestures: %d\n",
6609 synhw.capAdvancedGestures);
6610 printf(" capCoveredPad: %d\n",
6611 synhw.capCoveredPad);
6612 if (synhw.capReportsMax) {
6613 printf(" maximumXCoord: %d\n",
6614 synhw.maximumXCoord);
6615 printf(" maximumYCoord: %d\n",
6616 synhw.maximumYCoord);
6617 }
6618 if (synhw.capReportsMin) {
6619 printf(" minimumXCoord: %d\n",
6620 synhw.minimumXCoord);
6621 printf(" minimumYCoord: %d\n",
6622 synhw.minimumYCoord);
6623 }
6624 if (synhw.capClickPad) {
6625 printf(" Clickpad capabilities:\n");
6626 printf(" forcePad: %d\n",
6627 synhw.forcePad);
6628 printf(" topButtonPad: %d\n",
6629 synhw.topButtonPad);
6630 }
6631 }
6632 buttons += synhw.capClickPad;
6633 }
6634 }
6635
6636 if (verbose >= 2) {
6637 if (synhw.capExtended)
6638 printf(" Additional Buttons: %d\n", buttons);
6639 else
6640 printf(" No extended capabilities\n");
6641 }
6642
6643 /*
6644 * Add the default number of 3 buttons to the total
6645 * count of supported buttons reported above.
6646 */
6647 buttons += 3;
6648
6649 /*
6650 * Read the mode byte.
6651 *
6652 * XXX: Note the Synaptics documentation also defines the first
6653 * byte of the response to this query to be a constant 0x3b, this
6654 * does not appear to be true for Touchpads with guest devices.
6655 */
6656 if (mouse_ext_command(kbdc, SYNAPTICS_READ_MODES) == 0)
6657 return (FALSE);
6658 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6659 return (FALSE);
6660 if (!SYNAPTICS_VERSION_GE(synhw, 7, 5) && status[1] != 0x47) {
6661 printf(" Failed to read mode byte\n");
6662 return (FALSE);
6663 }
6664
6665 if (arg == PROBE)
6666 sc->synhw = synhw;
6667 if (!synaptics_support)
6668 return (FALSE);
6669
6670 /* Set mouse type just now for synaptics_set_mode() */
6671 sc->hw.model = MOUSE_MODEL_SYNAPTICS;
6672
6673 synaptics_set_mode(sc, synaptics_preferred_mode(sc));
6674
6675 if (trackpoint_support && synhw.capPassthrough) {
6676 enable_trackpoint(sc, arg);
6677 }
6678
6679 VLOG(3, (LOG_DEBUG, "synaptics: END init (%d buttons)\n", buttons));
6680
6681 if (arg == PROBE) {
6682 /* Create sysctl tree. */
6683 synaptics_sysctl_create_tree(sc, "synaptics",
6684 "Synaptics TouchPad");
6685 sc->hw.buttons = buttons;
6686 }
6687
6688 return (TRUE);
6689 }
6690
6691 static void
6692 synaptics_passthrough_on(struct psm_softc *sc)
6693 {
6694 VLOG(2, (LOG_NOTICE, "psm: setting pass-through mode.\n"));
6695 synaptics_set_mode(sc, synaptics_preferred_mode(sc) | (1 << 5));
6696 }
6697
6698 static void
6699 synaptics_passthrough_off(struct psm_softc *sc)
6700 {
6701 VLOG(2, (LOG_NOTICE, "psm: turning pass-through mode off.\n"));
6702 set_mouse_scaling(sc->kbdc, 2);
6703 set_mouse_scaling(sc->kbdc, 1);
6704 synaptics_set_mode(sc, synaptics_preferred_mode(sc));
6705 }
6706
6707 /* IBM/Lenovo TrackPoint */
6708 static int
6709 trackpoint_command(struct psm_softc *sc, int cmd, int loc, int val)
6710 {
6711 const int seq[] = { 0xe2, cmd, loc, val };
6712 int i;
6713
6714 if (sc->synhw.capPassthrough)
6715 synaptics_passthrough_on(sc);
6716
6717 for (i = 0; i < nitems(seq); i++) {
6718 if (sc->synhw.capPassthrough &&
6719 (seq[i] == 0xff || seq[i] == 0xe7))
6720 if (send_aux_command(sc->kbdc, 0xe7) != PSM_ACK) {
6721 synaptics_passthrough_off(sc);
6722 return (EIO);
6723 }
6724 if (send_aux_command(sc->kbdc, seq[i]) != PSM_ACK) {
6725 if (sc->synhw.capPassthrough)
6726 synaptics_passthrough_off(sc);
6727 return (EIO);
6728 }
6729 }
6730
6731 if (sc->synhw.capPassthrough)
6732 synaptics_passthrough_off(sc);
6733
6734 return (0);
6735 }
6736
6737 #define PSM_TPINFO(x) offsetof(struct psm_softc, tpinfo.x)
6738 #define TPMASK 0
6739 #define TPLOC 1
6740 #define TPINFO 2
6741
6742 static int
6743 trackpoint_sysctl(SYSCTL_HANDLER_ARGS)
6744 {
6745 static const int data[][3] = {
6746 { 0x00, 0x4a, PSM_TPINFO(sensitivity) },
6747 { 0x00, 0x4d, PSM_TPINFO(inertia) },
6748 { 0x00, 0x60, PSM_TPINFO(uplateau) },
6749 { 0x00, 0x57, PSM_TPINFO(reach) },
6750 { 0x00, 0x58, PSM_TPINFO(draghys) },
6751 { 0x00, 0x59, PSM_TPINFO(mindrag) },
6752 { 0x00, 0x5a, PSM_TPINFO(upthresh) },
6753 { 0x00, 0x5c, PSM_TPINFO(threshold) },
6754 { 0x00, 0x5d, PSM_TPINFO(jenks) },
6755 { 0x00, 0x5e, PSM_TPINFO(ztime) },
6756 { 0x01, 0x2c, PSM_TPINFO(pts) },
6757 { 0x08, 0x2d, PSM_TPINFO(skipback) }
6758 };
6759 struct psm_softc *sc;
6760 int error, newval, *oldvalp;
6761 const int *tp;
6762
6763 if (arg1 == NULL || arg2 < 0 || arg2 >= nitems(data))
6764 return (EINVAL);
6765 sc = arg1;
6766 tp = data[arg2];
6767 oldvalp = (int *)((intptr_t)sc + tp[TPINFO]);
6768 newval = *oldvalp;
6769 error = sysctl_handle_int(oidp, &newval, 0, req);
6770 if (error != 0)
6771 return (error);
6772 if (newval == *oldvalp)
6773 return (0);
6774 if (newval < 0 || newval > (tp[TPMASK] == 0 ? 255 : 1))
6775 return (EINVAL);
6776 error = trackpoint_command(sc, tp[TPMASK] == 0 ? 0x81 : 0x47,
6777 tp[TPLOC], tp[TPMASK] == 0 ? newval : tp[TPMASK]);
6778 if (error != 0)
6779 return (error);
6780 *oldvalp = newval;
6781
6782 return (0);
6783 }
6784
6785 static void
6786 trackpoint_sysctl_create_tree(struct psm_softc *sc)
6787 {
6788
6789 if (sc->tpinfo.sysctl_tree != NULL)
6790 return;
6791
6792 /* Attach extra trackpoint sysctl nodes under hw.psm.trackpoint */
6793 sysctl_ctx_init(&sc->tpinfo.sysctl_ctx);
6794 sc->tpinfo.sysctl_tree = SYSCTL_ADD_NODE(&sc->tpinfo.sysctl_ctx,
6795 SYSCTL_STATIC_CHILDREN(_hw_psm), OID_AUTO, "trackpoint", CTLFLAG_RD,
6796 0, "IBM/Lenovo TrackPoint");
6797
6798 /* hw.psm.trackpoint.sensitivity */
6799 sc->tpinfo.sensitivity = 0x80;
6800 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6801 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6802 "sensitivity", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6803 sc, TRACKPOINT_SYSCTL_SENSITIVITY,
6804 trackpoint_sysctl, "I",
6805 "Sensitivity");
6806
6807 /* hw.psm.trackpoint.negative_inertia */
6808 sc->tpinfo.inertia = 0x06;
6809 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6810 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6811 "negative_inertia", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6812 sc, TRACKPOINT_SYSCTL_NEGATIVE_INERTIA,
6813 trackpoint_sysctl, "I",
6814 "Negative inertia factor");
6815
6816 /* hw.psm.trackpoint.upper_plateau */
6817 sc->tpinfo.uplateau = 0x61;
6818 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6819 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6820 "upper_plateau", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6821 sc, TRACKPOINT_SYSCTL_UPPER_PLATEAU,
6822 trackpoint_sysctl, "I",
6823 "Transfer function upper plateau speed");
6824
6825 /* hw.psm.trackpoint.backup_range */
6826 sc->tpinfo.reach = 0x0a;
6827 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6828 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6829 "backup_range", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6830 sc, TRACKPOINT_SYSCTL_BACKUP_RANGE,
6831 trackpoint_sysctl, "I",
6832 "Backup range");
6833
6834 /* hw.psm.trackpoint.drag_hysteresis */
6835 sc->tpinfo.draghys = 0xff;
6836 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6837 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6838 "drag_hysteresis", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6839 sc, TRACKPOINT_SYSCTL_DRAG_HYSTERESIS,
6840 trackpoint_sysctl, "I",
6841 "Drag hysteresis");
6842
6843 /* hw.psm.trackpoint.minimum_drag */
6844 sc->tpinfo.mindrag = 0x14;
6845 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6846 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6847 "minimum_drag", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6848 sc, TRACKPOINT_SYSCTL_MINIMUM_DRAG,
6849 trackpoint_sysctl, "I",
6850 "Minimum drag");
6851
6852 /* hw.psm.trackpoint.up_threshold */
6853 sc->tpinfo.upthresh = 0xff;
6854 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6855 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6856 "up_threshold", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6857 sc, TRACKPOINT_SYSCTL_UP_THRESHOLD,
6858 trackpoint_sysctl, "I",
6859 "Up threshold for release");
6860
6861 /* hw.psm.trackpoint.threshold */
6862 sc->tpinfo.threshold = 0x08;
6863 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6864 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6865 "threshold", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6866 sc, TRACKPOINT_SYSCTL_THRESHOLD,
6867 trackpoint_sysctl, "I",
6868 "Threshold");
6869
6870 /* hw.psm.trackpoint.jenks_curvature */
6871 sc->tpinfo.jenks = 0x87;
6872 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6873 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6874 "jenks_curvature", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6875 sc, TRACKPOINT_SYSCTL_JENKS_CURVATURE,
6876 trackpoint_sysctl, "I",
6877 "Jenks curvature");
6878
6879 /* hw.psm.trackpoint.z_time */
6880 sc->tpinfo.ztime = 0x26;
6881 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6882 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6883 "z_time", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6884 sc, TRACKPOINT_SYSCTL_Z_TIME,
6885 trackpoint_sysctl, "I",
6886 "Z time constant");
6887
6888 /* hw.psm.trackpoint.press_to_select */
6889 sc->tpinfo.pts = 0x00;
6890 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6891 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6892 "press_to_select", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6893 sc, TRACKPOINT_SYSCTL_PRESS_TO_SELECT,
6894 trackpoint_sysctl, "I",
6895 "Press to Select");
6896
6897 /* hw.psm.trackpoint.skip_backups */
6898 sc->tpinfo.skipback = 0x00;
6899 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6900 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6901 "skip_backups", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6902 sc, TRACKPOINT_SYSCTL_SKIP_BACKUPS,
6903 trackpoint_sysctl, "I",
6904 "Skip backups from drags");
6905 }
6906
6907 static void
6908 set_trackpoint_parameters(struct psm_softc *sc)
6909 {
6910 trackpoint_command(sc, 0x81, 0x4a, sc->tpinfo.sensitivity);
6911 trackpoint_command(sc, 0x81, 0x60, sc->tpinfo.uplateau);
6912 trackpoint_command(sc, 0x81, 0x4d, sc->tpinfo.inertia);
6913 trackpoint_command(sc, 0x81, 0x57, sc->tpinfo.reach);
6914 trackpoint_command(sc, 0x81, 0x58, sc->tpinfo.draghys);
6915 trackpoint_command(sc, 0x81, 0x59, sc->tpinfo.mindrag);
6916 trackpoint_command(sc, 0x81, 0x5a, sc->tpinfo.upthresh);
6917 trackpoint_command(sc, 0x81, 0x5c, sc->tpinfo.threshold);
6918 trackpoint_command(sc, 0x81, 0x5d, sc->tpinfo.jenks);
6919 trackpoint_command(sc, 0x81, 0x5e, sc->tpinfo.ztime);
6920 if (sc->tpinfo.pts == 0x01)
6921 trackpoint_command(sc, 0x47, 0x2c, 0x01);
6922 if (sc->tpinfo.skipback == 0x01)
6923 trackpoint_command(sc, 0x47, 0x2d, 0x08);
6924 }
6925
6926 static int
6927 enable_trackpoint(struct psm_softc *sc, enum probearg arg)
6928 {
6929 KBDC kbdc = sc->kbdc;
6930 int id;
6931
6932 /*
6933 * If called from enable_synaptics(), make sure that passthrough
6934 * mode is enabled so we can reach the trackpoint.
6935 * However, passthrough mode must be disabled before setting the
6936 * trackpoint parameters, as rackpoint_command() enables and disables
6937 * passthrough mode on its own.
6938 */
6939 if (sc->synhw.capPassthrough)
6940 synaptics_passthrough_on(sc);
6941
6942 if (send_aux_command(kbdc, 0xe1) != PSM_ACK ||
6943 read_aux_data(kbdc) != 0x01)
6944 goto no_trackpoint;
6945 id = read_aux_data(kbdc);
6946 if (id < 0x01)
6947 goto no_trackpoint;
6948 if (arg == PROBE)
6949 sc->tphw = id;
6950 if (!trackpoint_support)
6951 goto no_trackpoint;
6952
6953 if (sc->synhw.capPassthrough)
6954 synaptics_passthrough_off(sc);
6955
6956 if (arg == PROBE) {
6957 trackpoint_sysctl_create_tree(sc);
6958 /*
6959 * Don't overwrite hwid and buttons when we are
6960 * a guest device.
6961 */
6962 if (!sc->synhw.capPassthrough) {
6963 sc->hw.hwid = id;
6964 sc->hw.buttons = 3;
6965 }
6966 }
6967
6968 set_trackpoint_parameters(sc);
6969
6970 return (TRUE);
6971
6972 no_trackpoint:
6973 if (sc->synhw.capPassthrough)
6974 synaptics_passthrough_off(sc);
6975
6976 return (FALSE);
6977 }
6978
6979 /* Interlink electronics VersaPad */
6980 static int
6981 enable_versapad(struct psm_softc *sc, enum probearg arg)
6982 {
6983 KBDC kbdc = sc->kbdc;
6984 int data[3];
6985
6986 set_mouse_resolution(kbdc, PSMD_RES_MEDIUM_HIGH); /* set res. 2 */
6987 set_mouse_sampling_rate(kbdc, 100); /* set rate 100 */
6988 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
6989 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
6990 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
6991 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
6992 if (get_mouse_status(kbdc, data, 0, 3) < 3) /* get status */
6993 return (FALSE);
6994 if (data[2] != 0xa || data[1] != 0 ) /* rate == 0xa && res. == 0 */
6995 return (FALSE);
6996 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
6997
6998 return (TRUE); /* PS/2 absolute mode */
6999 }
7000
7001 /* Elantech Touchpad */
7002 static int
7003 elantech_read_1(KBDC kbdc, int hwversion, int reg, int *val)
7004 {
7005 int res, readcmd, retidx;
7006 int resp[3];
7007
7008 readcmd = hwversion == 2 ? ELANTECH_REG_READ : ELANTECH_REG_RDWR;
7009 retidx = hwversion == 4 ? 1 : 0;
7010
7011 res = send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7012 res |= send_aux_command(kbdc, readcmd) != PSM_ACK;
7013 res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7014 res |= send_aux_command(kbdc, reg) != PSM_ACK;
7015 res |= get_mouse_status(kbdc, resp, 0, 3) != 3;
7016
7017 if (res == 0)
7018 *val = resp[retidx];
7019
7020 return (res);
7021 }
7022
7023 static int
7024 elantech_write_1(KBDC kbdc, int hwversion, int reg, int val)
7025 {
7026 int res, writecmd;
7027
7028 writecmd = hwversion == 2 ? ELANTECH_REG_WRITE : ELANTECH_REG_RDWR;
7029
7030 res = send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7031 res |= send_aux_command(kbdc, writecmd) != PSM_ACK;
7032 res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7033 res |= send_aux_command(kbdc, reg) != PSM_ACK;
7034 if (hwversion == 4) {
7035 res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7036 res |= send_aux_command(kbdc, writecmd) != PSM_ACK;
7037 }
7038 res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7039 res |= send_aux_command(kbdc, val) != PSM_ACK;
7040 res |= set_mouse_scaling(kbdc, 1) == 0;
7041
7042 return (res);
7043 }
7044
7045 static int
7046 elantech_cmd(KBDC kbdc, int hwversion, int cmd, int *resp)
7047 {
7048 int res;
7049
7050 if (hwversion == 2) {
7051 res = set_mouse_scaling(kbdc, 1) == 0;
7052 res |= mouse_ext_command(kbdc, cmd) == 0;
7053 } else {
7054 res = send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7055 res |= send_aux_command(kbdc, cmd) != PSM_ACK;
7056 }
7057 res |= get_mouse_status(kbdc, resp, 0, 3) != 3;
7058
7059 return (res);
7060 }
7061
7062 static int
7063 elantech_init(KBDC kbdc, elantechhw_t *elanhw)
7064 {
7065 int i, val, res, hwversion, reg10;
7066
7067 /* set absolute mode */
7068 hwversion = elanhw->hwversion;
7069 reg10 = -1;
7070 switch (hwversion) {
7071 case 2:
7072 reg10 = elanhw->fwversion == 0x020030 ? 0x54 : 0xc4;
7073 res = elantech_write_1(kbdc, hwversion, 0x10, reg10);
7074 if (res)
7075 break;
7076 res = elantech_write_1(kbdc, hwversion, 0x11, 0x8A);
7077 break;
7078 case 3:
7079 reg10 = 0x0b;
7080 res = elantech_write_1(kbdc, hwversion, 0x10, reg10);
7081 break;
7082 case 4:
7083 res = elantech_write_1(kbdc, hwversion, 0x07, 0x01);
7084 break;
7085 default:
7086 res = 1;
7087 }
7088
7089 /* Read back reg 0x10 to ensure hardware is ready. */
7090 if (res == 0 && reg10 >= 0) {
7091 for (i = 0; i < 5; i++) {
7092 if (elantech_read_1(kbdc, hwversion, 0x10, &val) == 0)
7093 break;
7094 DELAY(2000);
7095 }
7096 if (i == 5)
7097 res = 1;
7098 }
7099
7100 if (res)
7101 printf("couldn't set absolute mode\n");
7102
7103 return (res);
7104 }
7105
7106 static void
7107 elantech_init_synaptics(struct psm_softc *sc)
7108 {
7109
7110 /* Set capabilites required by movement smother */
7111 sc->synhw.infoMajor = sc->elanhw.hwversion;
7112 sc->synhw.infoMinor = sc->elanhw.fwversion;
7113 sc->synhw.infoXupmm = sc->elanhw.dpmmx;
7114 sc->synhw.infoYupmm = sc->elanhw.dpmmy;
7115 sc->synhw.verticalScroll = 0;
7116 sc->synhw.nExtendedQueries = 4;
7117 sc->synhw.capExtended = 1;
7118 sc->synhw.capPassthrough = sc->elanhw.hastrackpoint;
7119 sc->synhw.capClickPad = sc->elanhw.isclickpad;
7120 sc->synhw.capMultiFinger = 1;
7121 if (sc->elanhw.issemimt)
7122 sc->synhw.capAdvancedGestures = 1;
7123 else
7124 sc->synhw.capReportsV = 1;
7125 sc->synhw.capPalmDetect = 1;
7126 sc->synhw.capPen = 0;
7127 sc->synhw.capReportsMax = 1;
7128 sc->synhw.maximumXCoord = sc->elanhw.sizex;
7129 sc->synhw.maximumYCoord = sc->elanhw.sizey;
7130 sc->synhw.capReportsMin = 1;
7131 sc->synhw.minimumXCoord = 0;
7132 sc->synhw.minimumYCoord = 0;
7133
7134 if (sc->syninfo.sysctl_tree == NULL) {
7135 synaptics_sysctl_create_tree(sc, "elantech",
7136 "Elantech Touchpad");
7137
7138 /*
7139 * Adjust synaptic smoother tunables
7140 * 1. Disable finger detection pressure threshold. Unlike
7141 * synaptics we assume the finger is acting when packet with
7142 * its X&Y arrives not when pressure exceedes some threshold
7143 * 2. Disable unrelated features like margins and noisy areas
7144 * 3. Disable virtual scroll areas as 2nd finger is preferable
7145 * 4. For clickpads set bottom quarter as 42% - 16% - 42% sized
7146 * softbuttons
7147 * 5. Scale down divisors and movement lengths by a factor of 3
7148 * where 3 is Synaptics to Elantech (~2200/800) dpi ratio
7149 */
7150
7151 /* Set reporting range to be equal touchpad size */
7152 sc->syninfo.max_x = sc->elanhw.sizex;
7153 sc->syninfo.max_y = sc->elanhw.sizey;
7154
7155 /* Disable finger detection pressure threshold */
7156 sc->syninfo.min_pressure = 1;
7157
7158 /* Adjust palm width to nearly match synaptics w=10 */
7159 sc->syninfo.max_width = 7;
7160
7161 /* Elans often report double & triple taps as single event */
7162 sc->syninfo.tap_min_queue = 1;
7163
7164 /* Use full area of touchpad */
7165 sc->syninfo.margin_top = 0;
7166 sc->syninfo.margin_right = 0;
7167 sc->syninfo.margin_bottom = 0;
7168 sc->syninfo.margin_left = 0;
7169
7170 /* Disable noisy area */
7171 sc->syninfo.na_top = 0;
7172 sc->syninfo.na_right = 0;
7173 sc->syninfo.na_bottom = 0;
7174 sc->syninfo.na_left = 0;
7175
7176 /* Tune divisors and movement lengths */
7177 sc->syninfo.weight_len_squared = 200;
7178 sc->syninfo.div_min = 3;
7179 sc->syninfo.div_max = 6;
7180 sc->syninfo.div_max_na = 10;
7181 sc->syninfo.div_len = 30;
7182 sc->syninfo.tap_max_delta = 25;
7183
7184 /* Disable virtual scrolling areas and tune its divisors */
7185 sc->syninfo.vscroll_hor_area = 0;
7186 sc->syninfo.vscroll_ver_area = 0;
7187 sc->syninfo.vscroll_min_delta = 15;
7188 sc->syninfo.vscroll_div_min = 30;
7189 sc->syninfo.vscroll_div_max = 50;
7190
7191 /* Set bottom quarter as 42% - 16% - 42% sized softbuttons */
7192 if (sc->elanhw.isclickpad) {
7193 sc->syninfo.softbuttons_y = sc->elanhw.sizey / 4;
7194 sc->syninfo.softbutton2_x = sc->elanhw.sizex * 11 / 25;
7195 sc->syninfo.softbutton3_x = sc->elanhw.sizex * 14 / 25;
7196 }
7197 }
7198
7199 return;
7200 }
7201
7202 static int
7203 enable_elantech(struct psm_softc *sc, enum probearg arg)
7204 {
7205 static const int ic2hw[] =
7206 /*IC: 0 1 2 3 4 5 6 7 8 9 a b c d e f */
7207 { 0, 0, 2, 0, 2, 3, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 };
7208 static const int fw_sizes[][3] = {
7209 /* FW.vers MaxX MaxY */
7210 { 0x020030, 1152, 768 },
7211 { 0x020800, 1152, 768 },
7212 { 0x020b00, 1152, 768 },
7213 { 0x040215, 900, 500 },
7214 { 0x040216, 819, 405 },
7215 { 0x040219, 900, 500 },
7216 };
7217 elantechhw_t elanhw;
7218 int icversion, hwversion, xtr, i, id, resp[3], dpix, dpiy;
7219 KBDC kbdc = sc->kbdc;
7220
7221 VLOG(3, (LOG_DEBUG, "elantech: BEGIN init\n"));
7222
7223 set_mouse_scaling(kbdc, 1);
7224 set_mouse_scaling(kbdc, 1);
7225 set_mouse_scaling(kbdc, 1);
7226 if (get_mouse_status(kbdc, resp, 0, 3) != 3)
7227 return (FALSE);
7228
7229 if (!ELANTECH_MAGIC(resp))
7230 return (FALSE);
7231
7232 /* Identify the Touchpad version. */
7233 if (elantech_cmd(kbdc, 2, ELANTECH_FW_VERSION, resp))
7234 return (FALSE);
7235
7236 bzero(&elanhw, sizeof(elanhw));
7237
7238 elanhw.fwversion = (resp[0] << 16) | (resp[1] << 8) | resp[2];
7239 icversion = resp[0] & 0x0f;
7240 hwversion = ic2hw[icversion];
7241
7242 if (verbose >= 2)
7243 printf("Elantech touchpad hardware v.%d firmware v.0x%06x\n",
7244 hwversion, elanhw.fwversion);
7245
7246 if (ELANTECH_HW_IS_V1(elanhw.fwversion)) {
7247 printf (" Unsupported touchpad hardware (v1)\n");
7248 return (FALSE);
7249 }
7250 if (hwversion == 0) {
7251 printf (" Unknown touchpad hardware (firmware v.0x%06x)\n",
7252 elanhw.fwversion);
7253 return (FALSE);
7254 }
7255
7256 /* Get the Touchpad model information. */
7257 elanhw.hwversion = hwversion;
7258 elanhw.issemimt = hwversion == 2;
7259 elanhw.isclickpad = (resp[1] & 0x10) != 0;
7260 elanhw.hascrc = (resp[1] & 0x40) != 0;
7261 elanhw.haspressure = elanhw.fwversion >= 0x020800;
7262
7263 /* Read the capability bits. */
7264 if (elantech_cmd(kbdc, hwversion, ELANTECH_CAPABILITIES, resp) != 0) {
7265 printf(" Failed to read capability bits\n");
7266 return (FALSE);
7267 }
7268
7269 elanhw.ntracesx = imax(resp[1], 3);
7270 elanhw.ntracesy = imax(resp[2], 3);
7271 elanhw.hastrackpoint = (resp[0] & 0x80) != 0;
7272
7273 /* Get the touchpad resolution */
7274 switch (hwversion) {
7275 case 4:
7276 if (elantech_cmd(kbdc, hwversion, ELANTECH_RESOLUTION, resp)
7277 == 0) {
7278 dpix = (resp[1] & 0x0f) * 10 + 790;
7279 dpiy = ((resp[1] & 0xf0) >> 4) * 10 + 790;
7280 elanhw.dpmmx = (dpix * 10 + 5) / 254;
7281 elanhw.dpmmy = (dpiy * 10 + 5) / 254;
7282 break;
7283 }
7284 /* FALLTHROUGH */
7285 case 2:
7286 case 3:
7287 elanhw.dpmmx = elanhw.dpmmy = 32; /* 800 dpi */
7288 break;
7289 }
7290
7291 if (!elantech_support)
7292 return (FALSE);
7293
7294 if (elantech_init(kbdc, &elanhw)) {
7295 printf("couldn't initialize elantech touchpad\n");
7296 return (FALSE);
7297 }
7298
7299 /*
7300 * Get the touchpad reporting range.
7301 * On HW v.3 touchpads it should be done after switching hardware
7302 * to real resolution mode (by setting bit 3 of reg10)
7303 */
7304 elanhw.dptracex = elanhw.dptracey = 64;
7305 for (i = 0; i < nitems(fw_sizes); i++) {
7306 if (elanhw.fwversion == fw_sizes[i][0]) {
7307 elanhw.sizex = fw_sizes[i][1];
7308 elanhw.sizey = fw_sizes[i][2];
7309 goto found;
7310 }
7311 }
7312 if (elantech_cmd(kbdc, hwversion, ELANTECH_FW_ID, resp) != 0) {
7313 printf(" Failed to read touchpad size\n");
7314 elanhw.sizex = 10000; /* Arbitrary high values to */
7315 elanhw.sizey = 10000; /* prevent clipping in smoother */
7316 } else if (hwversion == 2) {
7317 if ((elanhw.fwversion >> 16) == 0x14 && (resp[1] & 0x10) &&
7318 !elantech_cmd(kbdc, hwversion, ELANTECH_SAMPLE, resp)) {
7319 elanhw.dptracex = resp[1] / 2;
7320 elanhw.dptracey = resp[2] / 2;
7321 }
7322 xtr = ((elanhw.fwversion >> 8) == 0x0208) ? 1 : 2;
7323 elanhw.sizex = (elanhw.ntracesx - xtr) * elanhw.dptracex;
7324 elanhw.sizey = (elanhw.ntracesy - xtr) * elanhw.dptracey;
7325 } else {
7326 elanhw.sizex = (resp[0] & 0x0f) << 8 | resp[1];
7327 elanhw.sizey = (resp[0] & 0xf0) << 4 | resp[2];
7328 xtr = (elanhw.sizex % (elanhw.ntracesx - 2) == 0) ? 2 : 1;
7329 elanhw.dptracex = elanhw.sizex / (elanhw.ntracesx - xtr);
7330 elanhw.dptracey = elanhw.sizey / (elanhw.ntracesy - xtr);
7331 }
7332 found:
7333 if (verbose >= 2) {
7334 printf(" Model information:\n");
7335 printf(" MaxX: %d\n", elanhw.sizex);
7336 printf(" MaxY: %d\n", elanhw.sizey);
7337 printf(" DpmmX: %d\n", elanhw.dpmmx);
7338 printf(" DpmmY: %d\n", elanhw.dpmmy);
7339 printf(" TracesX: %d\n", elanhw.ntracesx);
7340 printf(" TracesY: %d\n", elanhw.ntracesy);
7341 printf(" DptraceX: %d\n", elanhw.dptracex);
7342 printf(" DptraceY: %d\n", elanhw.dptracey);
7343 printf(" SemiMT: %d\n", elanhw.issemimt);
7344 printf(" Clickpad: %d\n", elanhw.isclickpad);
7345 printf(" Trackpoint: %d\n", elanhw.hastrackpoint);
7346 printf(" CRC: %d\n", elanhw.hascrc);
7347 printf(" Pressure: %d\n", elanhw.haspressure);
7348 }
7349
7350 VLOG(3, (LOG_DEBUG, "elantech: END init\n"));
7351
7352 if (arg == PROBE) {
7353 sc->elanhw = elanhw;
7354 sc->hw.buttons = 3;
7355
7356 /* Initialize synaptics movement smoother */
7357 elantech_init_synaptics(sc);
7358
7359 for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
7360 PSM_FINGER_RESET(sc->elanaction.fingers[id]);
7361 }
7362
7363 return (TRUE);
7364 }
7365
7366 /*
7367 * Return true if 'now' is earlier than (start + (secs.usecs)).
7368 * Now may be NULL and the function will fetch the current time from
7369 * getmicrouptime(), or a cached 'now' can be passed in.
7370 * All values should be numbers derived from getmicrouptime().
7371 */
7372 static int
7373 timeelapsed(start, secs, usecs, now)
7374 const struct timeval *start, *now;
7375 int secs, usecs;
7376 {
7377 struct timeval snow, tv;
7378
7379 /* if there is no 'now' passed in, the get it as a convience. */
7380 if (now == NULL) {
7381 getmicrouptime(&snow);
7382 now = &snow;
7383 }
7384
7385 tv.tv_sec = secs;
7386 tv.tv_usec = usecs;
7387 timevaladd(&tv, start);
7388 return (timevalcmp(&tv, now, <));
7389 }
7390
7391 static int
7392 psmresume(device_t dev)
7393 {
7394 struct psm_softc *sc = device_get_softc(dev);
7395 int unit = device_get_unit(dev);
7396 int err;
7397
7398 VLOG(2, (LOG_NOTICE, "psm%d: system resume hook called.\n", unit));
7399
7400 if ((sc->config &
7401 (PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND)) == 0)
7402 return (0);
7403
7404 err = reinitialize(sc, sc->config & PSM_CONFIG_INITAFTERSUSPEND);
7405
7406 if ((sc->state & PSM_ASLP) && !(sc->state & PSM_VALID)) {
7407 /*
7408 * Release the blocked process; it must be notified that
7409 * the device cannot be accessed anymore.
7410 */
7411 sc->state &= ~PSM_ASLP;
7412 wakeup(sc);
7413 }
7414
7415 VLOG(2, (LOG_DEBUG, "psm%d: system resume hook exiting.\n", unit));
7416
7417 return (err);
7418 }
7419
7420 DRIVER_MODULE(psm, atkbdc, psm_driver, psm_devclass, 0, 0);
7421 #ifdef EVDEV_SUPPORT
7422 MODULE_DEPEND(psm, evdev, 1, 1, 1);
7423 #endif
7424
7425 #ifdef DEV_ISA
7426
7427 /*
7428 * This sucks up assignments from PNPBIOS and ACPI.
7429 */
7430
7431 /*
7432 * When the PS/2 mouse device is reported by ACPI or PnP BIOS, it may
7433 * appear BEFORE the AT keyboard controller. As the PS/2 mouse device
7434 * can be probed and attached only after the AT keyboard controller is
7435 * attached, we shall quietly reserve the IRQ resource for later use.
7436 * If the PS/2 mouse device is reported to us AFTER the keyboard controller,
7437 * copy the IRQ resource to the PS/2 mouse device instance hanging
7438 * under the keyboard controller, then probe and attach it.
7439 */
7440
7441 static devclass_t psmcpnp_devclass;
7442
7443 static device_probe_t psmcpnp_probe;
7444 static device_attach_t psmcpnp_attach;
7445
7446 static device_method_t psmcpnp_methods[] = {
7447 DEVMETHOD(device_probe, psmcpnp_probe),
7448 DEVMETHOD(device_attach, psmcpnp_attach),
7449
7450 { 0, 0 }
7451 };
7452
7453 static driver_t psmcpnp_driver = {
7454 PSMCPNP_DRIVER_NAME,
7455 psmcpnp_methods,
7456 sizeof(struct psmcpnp_softc),
7457 };
7458
7459 static struct isa_pnp_id psmcpnp_ids[] = {
7460 { 0x030fd041, "PS/2 mouse port" }, /* PNP0F03 */
7461 { 0x0e0fd041, "PS/2 mouse port" }, /* PNP0F0E */
7462 { 0x120fd041, "PS/2 mouse port" }, /* PNP0F12 */
7463 { 0x130fd041, "PS/2 mouse port" }, /* PNP0F13 */
7464 { 0x1303d041, "PS/2 port" }, /* PNP0313, XXX */
7465 { 0x02002e4f, "Dell PS/2 mouse port" }, /* Lat. X200, Dell */
7466 { 0x0002a906, "ALPS Glide Point" }, /* ALPS Glide Point */
7467 { 0x80374d24, "IBM PS/2 mouse port" }, /* IBM3780, ThinkPad */
7468 { 0x81374d24, "IBM PS/2 mouse port" }, /* IBM3781, ThinkPad */
7469 { 0x0190d94d, "SONY VAIO PS/2 mouse port"}, /* SNY9001, Vaio */
7470 { 0x0290d94d, "SONY VAIO PS/2 mouse port"}, /* SNY9002, Vaio */
7471 { 0x0390d94d, "SONY VAIO PS/2 mouse port"}, /* SNY9003, Vaio */
7472 { 0x0490d94d, "SONY VAIO PS/2 mouse port"}, /* SNY9004, Vaio */
7473 { 0 }
7474 };
7475
7476 /* _HID list for quirk detection. Any device below has _CID from psmcpnp_ids */
7477 static struct isa_pnp_id topbtpad_ids[] = {
7478 { 0x1700ae30, "Lenovo PS/2 clickpad port" }, /* LEN0017, ThinkPad */
7479 { 0x1800ae30, "Lenovo PS/2 clickpad port" }, /* LEN0018, ThinkPad */
7480 { 0x1900ae30, "Lenovo PS/2 clickpad port" }, /* LEN0019, ThinkPad */
7481 { 0x2300ae30, "Lenovo PS/2 clickpad port" }, /* LEN0023, ThinkPad */
7482 { 0x2a00ae30, "Lenovo PS/2 clickpad port" }, /* LEN002a, ThinkPad */
7483 { 0x2b00ae30, "Lenovo PS/2 clickpad port" }, /* LEN002b, ThinkPad */
7484 { 0x2c00ae30, "Lenovo PS/2 clickpad port" }, /* LEN002c, ThinkPad */
7485 { 0x2d00ae30, "Lenovo PS/2 clickpad port" }, /* LEN002d, ThinkPad */
7486 { 0x2e00ae30, "Lenovo PS/2 clickpad port" }, /* LEN002e, ThinkPad */
7487 { 0x3300ae30, "Lenovo PS/2 clickpad port" }, /* LEN0033, ThinkPad */
7488 { 0x3400ae30, "Lenovo PS/2 clickpad port" }, /* LEN0034, ThinkPad */
7489 { 0x3500ae30, "Lenovo PS/2 clickpad port" }, /* LEN0035, ThinkPad */
7490 { 0x3600ae30, "Lenovo PS/2 clickpad port" }, /* LEN0036, ThinkPad */
7491 { 0x3700ae30, "Lenovo PS/2 clickpad port" }, /* LEN0037, ThinkPad */
7492 { 0x3800ae30, "Lenovo PS/2 clickpad port" }, /* LEN0038, ThinkPad */
7493 { 0x3900ae30, "Lenovo PS/2 clickpad port" }, /* LEN0039, ThinkPad */
7494 { 0x4100ae30, "Lenovo PS/2 clickpad port" }, /* LEN0041, ThinkPad */
7495 { 0x4200ae30, "Lenovo PS/2 clickpad port" }, /* LEN0042, ThinkPad */
7496 { 0x4500ae30, "Lenovo PS/2 clickpad port" }, /* LEN0045, ThinkPad */
7497 { 0x4700ae30, "Lenovo PS/2 clickpad port" }, /* LEN0047, ThinkPad */
7498 { 0x4900ae30, "Lenovo PS/2 clickpad port" }, /* LEN0049, ThinkPad */
7499 { 0x0020ae30, "Lenovo PS/2 clickpad port" }, /* LEN2000, ThinkPad */
7500 { 0x0120ae30, "Lenovo PS/2 clickpad port" }, /* LEN2001, ThinkPad */
7501 { 0x0220ae30, "Lenovo PS/2 clickpad port" }, /* LEN2002, ThinkPad */
7502 { 0x0320ae30, "Lenovo PS/2 clickpad port" }, /* LEN2003, ThinkPad */
7503 { 0x0420ae30, "Lenovo PS/2 clickpad port" }, /* LEN2004, ThinkPad */
7504 { 0x0520ae30, "Lenovo PS/2 clickpad port" }, /* LEN2005, ThinkPad */
7505 { 0x0620ae30, "Lenovo PS/2 clickpad port" }, /* LEN2006, ThinkPad */
7506 { 0x0720ae30, "Lenovo PS/2 clickpad port" }, /* LEN2007, ThinkPad */
7507 { 0x0820ae30, "Lenovo PS/2 clickpad port" }, /* LEN2008, ThinkPad */
7508 { 0x0920ae30, "Lenovo PS/2 clickpad port" }, /* LEN2009, ThinkPad */
7509 { 0x0a20ae30, "Lenovo PS/2 clickpad port" }, /* LEN200a, ThinkPad */
7510 { 0x0b20ae30, "Lenovo PS/2 clickpad port" }, /* LEN200b, ThinkPad */
7511 { 0 }
7512 };
7513
7514 /* _HID list for quirk detection. Any device below has _CID from psmcpnp_ids */
7515 static struct isa_pnp_id forcepad_ids[] = {
7516 { 0x0d302e4f, "HP PS/2 forcepad port" }, /* SYN300D, EB 1040 */
7517 { 0x14302e4f, "HP PS/2 forcepad port" }, /* SYN3014, EB 1040 */
7518 { 0 }
7519 };
7520
7521 static int
7522 create_a_copy(device_t atkbdc, device_t me)
7523 {
7524 device_t psm;
7525 u_long irq;
7526
7527 /* find the PS/2 mouse device instance under the keyboard controller */
7528 psm = device_find_child(atkbdc, PSM_DRIVER_NAME,
7529 device_get_unit(atkbdc));
7530 if (psm == NULL)
7531 return (ENXIO);
7532 if (device_get_state(psm) != DS_NOTPRESENT)
7533 return (0);
7534
7535 /* move our resource to the found device */
7536 irq = bus_get_resource_start(me, SYS_RES_IRQ, 0);
7537 bus_delete_resource(me, SYS_RES_IRQ, 0);
7538 bus_set_resource(psm, SYS_RES_IRQ, KBDC_RID_AUX, irq, 1);
7539
7540 /* ...then probe and attach it */
7541 return (device_probe_and_attach(psm));
7542 }
7543
7544 static int
7545 psmcpnp_probe(device_t dev)
7546 {
7547 struct psmcpnp_softc *sc = device_get_softc(dev);
7548 struct resource *res;
7549 u_long irq;
7550 int rid;
7551
7552 if (ISA_PNP_PROBE(device_get_parent(dev), dev, forcepad_ids) == 0)
7553 sc->type = PSMCPNP_FORCEPAD;
7554 else if (ISA_PNP_PROBE(device_get_parent(dev), dev, topbtpad_ids) == 0)
7555 sc->type = PSMCPNP_TOPBUTTONPAD;
7556 else if (ISA_PNP_PROBE(device_get_parent(dev), dev, psmcpnp_ids) == 0)
7557 sc->type = PSMCPNP_GENERIC;
7558 else
7559 return (ENXIO);
7560
7561 /*
7562 * The PnP BIOS and ACPI are supposed to assign an IRQ (12)
7563 * to the PS/2 mouse device node. But, some buggy PnP BIOS
7564 * declares the PS/2 mouse device node without an IRQ resource!
7565 * If this happens, we shall refer to device hints.
7566 * If we still don't find it there, use a hardcoded value... XXX
7567 */
7568 rid = 0;
7569 irq = bus_get_resource_start(dev, SYS_RES_IRQ, rid);
7570 if (irq <= 0) {
7571 if (resource_long_value(PSM_DRIVER_NAME,
7572 device_get_unit(dev),"irq", &irq) != 0)
7573 irq = 12; /* XXX */
7574 device_printf(dev, "irq resource info is missing; "
7575 "assuming irq %ld\n", irq);
7576 bus_set_resource(dev, SYS_RES_IRQ, rid, irq, 1);
7577 }
7578 res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 0);
7579 bus_release_resource(dev, SYS_RES_IRQ, rid, res);
7580
7581 /* keep quiet */
7582 if (!bootverbose)
7583 device_quiet(dev);
7584
7585 return ((res == NULL) ? ENXIO : 0);
7586 }
7587
7588 static int
7589 psmcpnp_attach(device_t dev)
7590 {
7591 device_t atkbdc;
7592
7593 /* find the keyboard controller, which may be on acpi* or isa* bus */
7594 atkbdc = devclass_get_device(devclass_find(ATKBDC_DRIVER_NAME),
7595 device_get_unit(dev));
7596 if ((atkbdc != NULL) && (device_get_state(atkbdc) == DS_ATTACHED))
7597 create_a_copy(atkbdc, dev);
7598
7599 return (0);
7600 }
7601
7602 DRIVER_MODULE(psmcpnp, isa, psmcpnp_driver, psmcpnp_devclass, 0, 0);
7603 DRIVER_MODULE(psmcpnp, acpi, psmcpnp_driver, psmcpnp_devclass, 0, 0);
7604 ISA_PNP_INFO(psmcpnp_ids);
7605 #endif /* DEV_ISA */
7606