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