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