2 * Copyright (c) 1992, 1993 Erik Forsberg.
3 * Copyright (c) 1996, 1997 Kazutaka YOKOTA.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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.
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
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
35 * Further modifications for latest 386BSD+patchkit and port to NetBSD,
36 * Andrew Herbert <andrew@werple.apana.org.au> - 8 June 1993
38 * Cloned from the Microsoft Bus Mouse driver, also by Erik Forsberg, by
39 * Andrew Herbert - 12 June 1993
41 * Modified for PS/2 mouse by Charles Hannum <mycroft@ai.mit.edu>
44 * Modified for PS/2 AUX mouse by Shoji Yuen <yuen@nuie.nagoya-u.ac.jp>
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.
61 #include <sys/cdefs.h>
62 __FBSDID("$FreeBSD$");
67 #include <sys/param.h>
68 #include <sys/systm.h>
69 #include <sys/kernel.h>
70 #include <sys/module.h>
73 #include <sys/filio.h>
75 #include <sys/sigio.h>
76 #include <sys/signalvar.h>
77 #include <sys/syslog.h>
78 #include <machine/bus.h>
80 #include <sys/selinfo.h>
81 #include <sys/sysctl.h>
85 #include <sys/limits.h>
86 #include <sys/mouse.h>
87 #include <machine/resource.h>
90 #include <isa/isavar.h>
93 #include <dev/atkbdc/atkbdcreg.h>
94 #include <dev/atkbdc/psm.h>
97 * Driver specific options: the following options may be set by
98 * `options' statements in the kernel configuration file.
103 #define PSM_DEBUG 0 /*
104 * logging: 0: none, 1: brief, 2: verbose
105 * 3: sync errors, 4: all packets
108 #define VLOG(level, args) do { \
109 if (verbose >= level) \
113 #ifndef PSM_INPUT_TIMEOUT
114 #define PSM_INPUT_TIMEOUT 2000000 /* 2 sec */
117 #ifndef PSM_TAP_TIMEOUT
118 #define PSM_TAP_TIMEOUT 125000
121 #ifndef PSM_TAP_THRESHOLD
122 #define PSM_TAP_THRESHOLD 25
125 /* end of driver specific options */
127 #define PSMCPNP_DRIVER_NAME "psmcpnp"
130 #define PSM_BUFSIZE 960
131 #define PSM_SMALLBUFSIZE 240
133 /* operation levels */
134 #define PSM_LEVEL_BASE 0
135 #define PSM_LEVEL_STANDARD 1
136 #define PSM_LEVEL_NATIVE 2
137 #define PSM_LEVEL_MIN PSM_LEVEL_BASE
138 #define PSM_LEVEL_MAX PSM_LEVEL_NATIVE
140 /* Logitech PS2++ protocol */
141 #define MOUSE_PS2PLUS_CHECKBITS(b) \
142 ((((b[2] & 0x03) << 2) | 0x02) == (b[1] & 0x0f))
143 #define MOUSE_PS2PLUS_PACKET_TYPE(b) \
144 (((b[0] & 0x30) >> 2) | ((b[1] & 0x30) >> 4))
147 typedef struct ringbuf {
148 int count; /* # of valid elements in the buffer */
149 int head; /* head pointer */
150 int tail; /* tail poiner */
151 u_char buf[PSM_BUFSIZE];
155 typedef struct packetbuf {
156 u_char ipacket[16]; /* interim input buffer */
157 int inputbytes; /* # of bytes in the input buffer */
160 #ifndef PSM_PACKETQUEUE
161 #define PSM_PACKETQUEUE 128
165 SYNAPTICS_SYSCTL_MIN_PRESSURE,
166 SYNAPTICS_SYSCTL_MAX_PRESSURE,
167 SYNAPTICS_SYSCTL_MAX_WIDTH,
168 SYNAPTICS_SYSCTL_MARGIN_TOP,
169 SYNAPTICS_SYSCTL_MARGIN_RIGHT,
170 SYNAPTICS_SYSCTL_MARGIN_BOTTOM,
171 SYNAPTICS_SYSCTL_MARGIN_LEFT,
172 SYNAPTICS_SYSCTL_NA_TOP,
173 SYNAPTICS_SYSCTL_NA_RIGHT,
174 SYNAPTICS_SYSCTL_NA_BOTTOM,
175 SYNAPTICS_SYSCTL_NA_LEFT,
176 SYNAPTICS_SYSCTL_WINDOW_MIN,
177 SYNAPTICS_SYSCTL_WINDOW_MAX,
178 SYNAPTICS_SYSCTL_MULTIPLICATOR,
179 SYNAPTICS_SYSCTL_WEIGHT_CURRENT,
180 SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS,
181 SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS_NA,
182 SYNAPTICS_SYSCTL_WEIGHT_LEN_SQUARED,
183 SYNAPTICS_SYSCTL_DIV_MIN,
184 SYNAPTICS_SYSCTL_DIV_MAX,
185 SYNAPTICS_SYSCTL_DIV_MAX_NA,
186 SYNAPTICS_SYSCTL_DIV_LEN,
187 SYNAPTICS_SYSCTL_TAP_MAX_DELTA,
188 SYNAPTICS_SYSCTL_TAP_MIN_QUEUE,
189 SYNAPTICS_SYSCTL_TAPHOLD_TIMEOUT,
190 SYNAPTICS_SYSCTL_VSCROLL_HOR_AREA,
191 SYNAPTICS_SYSCTL_VSCROLL_VER_AREA,
192 SYNAPTICS_SYSCTL_VSCROLL_MIN_DELTA,
193 SYNAPTICS_SYSCTL_VSCROLL_DIV_MIN,
194 SYNAPTICS_SYSCTL_VSCROLL_DIV_MAX,
195 SYNAPTICS_SYSCTL_TOUCHPAD_OFF
198 typedef struct synapticsinfo {
199 struct sysctl_ctx_list sysctl_ctx;
200 struct sysctl_oid *sysctl_tree;
201 int directional_scrolls;
202 int two_finger_scroll;
219 int weight_previous_na;
220 int weight_len_squared;
228 int vscroll_ver_area;
229 int vscroll_hor_area;
230 int vscroll_min_delta;
236 typedef struct synapticspacket {
241 #define SYNAPTICS_PACKETQUEUE 10
242 #define SYNAPTICS_QUEUE_CURSOR(x) \
243 (x + SYNAPTICS_PACKETQUEUE) % SYNAPTICS_PACKETQUEUE
245 #define SYNAPTICS_VERSION_GE(synhw, major, minor) \
246 ((synhw).infoMajor > (major) || \
247 ((synhw).infoMajor == (major) && (synhw).infoMinor >= (minor)))
249 typedef struct synapticsaction {
250 synapticspacket_t queue[SYNAPTICS_PACKETQUEUE];
267 TRACKPOINT_SYSCTL_SENSITIVITY,
268 TRACKPOINT_SYSCTL_NEGATIVE_INERTIA,
269 TRACKPOINT_SYSCTL_UPPER_PLATEAU,
270 TRACKPOINT_SYSCTL_BACKUP_RANGE,
271 TRACKPOINT_SYSCTL_DRAG_HYSTERESIS,
272 TRACKPOINT_SYSCTL_MINIMUM_DRAG,
273 TRACKPOINT_SYSCTL_UP_THRESHOLD,
274 TRACKPOINT_SYSCTL_THRESHOLD,
275 TRACKPOINT_SYSCTL_JENKS_CURVATURE,
276 TRACKPOINT_SYSCTL_Z_TIME,
277 TRACKPOINT_SYSCTL_PRESS_TO_SELECT,
278 TRACKPOINT_SYSCTL_SKIP_BACKUPS
281 typedef struct trackpointinfo {
282 struct sysctl_ctx_list sysctl_ctx;
283 struct sysctl_oid *sysctl_tree;
298 /* driver control block */
299 struct psm_softc { /* Driver status information */
301 struct selinfo rsel; /* Process selecting for Input */
302 u_char state; /* Mouse driver state */
303 int config; /* driver configuration flags */
304 int flags; /* other flags */
305 KBDC kbdc; /* handle to access kbd controller */
306 struct resource *intr; /* IRQ resource */
307 void *ih; /* interrupt handle */
308 mousehw_t hw; /* hardware information */
309 synapticshw_t synhw; /* Synaptics hardware information */
310 synapticsinfo_t syninfo; /* Synaptics configuration */
311 synapticsaction_t synaction; /* Synaptics action context */
312 int tphw; /* TrackPoint hardware information */
313 trackpointinfo_t tpinfo; /* TrackPoint configuration */
314 mousemode_t mode; /* operation mode */
315 mousemode_t dflt_mode; /* default operation mode */
316 mousestatus_t status; /* accumulated mouse movement */
317 ringbuf_t queue; /* mouse status queue */
318 packetbuf_t pqueue[PSM_PACKETQUEUE]; /* mouse data queue */
319 int pqueue_start; /* start of data in queue */
320 int pqueue_end; /* end of data in queue */
321 int button; /* the latest button state */
322 int xold; /* previous absolute X position */
323 int yold; /* previous absolute Y position */
324 int xaverage; /* average X position */
325 int yaverage; /* average Y position */
326 int squelch; /* level to filter movement at low speed */
327 int zmax; /* maximum pressure value for touchpads */
328 int syncerrors; /* # of bytes discarded to synchronize */
329 int pkterrors; /* # of packets failed during quaranteen. */
330 struct timeval inputtimeout;
331 struct timeval lastsoftintr; /* time of last soft interrupt */
332 struct timeval lastinputerr; /* time last sync error happened */
333 struct timeval taptimeout; /* tap timeout for touchpads */
334 int watchdog; /* watchdog timer flag */
335 struct callout callout; /* watchdog timer call out */
336 struct callout softcallout; /* buffer timer call out */
341 struct sigio *async; /* Processes waiting for SIGIO */
342 int extended_buttons;
344 static devclass_t psm_devclass;
346 /* driver state flags (state) */
347 #define PSM_VALID 0x80
348 #define PSM_OPEN 1 /* Device is open */
349 #define PSM_ASLP 2 /* Waiting for mouse data */
350 #define PSM_SOFTARMED 4 /* Software interrupt armed */
351 #define PSM_NEED_SYNCBITS 8 /* Set syncbits using next data pkt */
353 /* driver configuration flags (config) */
354 #define PSM_CONFIG_RESOLUTION 0x000f /* resolution */
355 #define PSM_CONFIG_ACCEL 0x00f0 /* acceleration factor */
356 #define PSM_CONFIG_NOCHECKSYNC 0x0100 /* disable sync. test */
357 #define PSM_CONFIG_NOIDPROBE 0x0200 /* disable mouse model probe */
358 #define PSM_CONFIG_NORESET 0x0400 /* don't reset the mouse */
359 #define PSM_CONFIG_FORCETAP 0x0800 /* assume `tap' action exists */
360 #define PSM_CONFIG_IGNPORTERROR 0x1000 /* ignore error in aux port test */
361 #define PSM_CONFIG_HOOKRESUME 0x2000 /* hook the system resume event */
362 #define PSM_CONFIG_INITAFTERSUSPEND 0x4000 /* init the device at the resume event */
364 #define PSM_CONFIG_FLAGS \
365 (PSM_CONFIG_RESOLUTION | \
367 PSM_CONFIG_NOCHECKSYNC | \
368 PSM_CONFIG_NOIDPROBE | \
369 PSM_CONFIG_NORESET | \
370 PSM_CONFIG_FORCETAP | \
371 PSM_CONFIG_IGNPORTERROR | \
372 PSM_CONFIG_HOOKRESUME | \
373 PSM_CONFIG_INITAFTERSUSPEND)
375 /* other flags (flags) */
376 #define PSM_FLAGS_FINGERDOWN 0x0001 /* VersaPad finger down */
379 static int tap_enabled = -1;
380 TUNABLE_INT("hw.psm.tap_enabled", &tap_enabled);
382 static int synaptics_support = 0;
383 TUNABLE_INT("hw.psm.synaptics_support", &synaptics_support);
385 static int trackpoint_support = 0;
386 TUNABLE_INT("hw.psm.trackpoint_support", &trackpoint_support);
388 static int verbose = PSM_DEBUG;
389 TUNABLE_INT("debug.psm.loglevel", &verbose);
391 /* for backward compatibility */
392 #define OLD_MOUSE_GETHWINFO _IOR('M', 1, old_mousehw_t)
393 #define OLD_MOUSE_GETMODE _IOR('M', 2, old_mousemode_t)
394 #define OLD_MOUSE_SETMODE _IOW('M', 3, old_mousemode_t)
396 typedef struct old_mousehw {
403 typedef struct old_mousemode {
410 /* packet formatting function */
411 typedef int packetfunc_t(struct psm_softc *, u_char *, int *, int,
414 /* function prototypes */
415 static void psmidentify(driver_t *, device_t);
416 static int psmprobe(device_t);
417 static int psmattach(device_t);
418 static int psmdetach(device_t);
419 static int psmresume(device_t);
421 static d_open_t psmopen;
422 static d_close_t psmclose;
423 static d_read_t psmread;
424 static d_write_t psmwrite;
425 static d_ioctl_t psmioctl;
426 static d_poll_t psmpoll;
428 static int enable_aux_dev(KBDC);
429 static int disable_aux_dev(KBDC);
430 static int get_mouse_status(KBDC, int *, int, int);
431 static int get_aux_id(KBDC);
432 static int set_mouse_sampling_rate(KBDC, int);
433 static int set_mouse_scaling(KBDC, int);
434 static int set_mouse_resolution(KBDC, int);
435 static int set_mouse_mode(KBDC);
436 static int get_mouse_buttons(KBDC);
437 static int is_a_mouse(int);
438 static void recover_from_error(KBDC);
439 static int restore_controller(KBDC, int);
440 static int doinitialize(struct psm_softc *, mousemode_t *);
441 static int doopen(struct psm_softc *, int);
442 static int reinitialize(struct psm_softc *, int);
443 static char *model_name(int);
444 static void psmsoftintr(void *);
445 static void psmintr(void *);
446 static void psmtimeout(void *);
447 static int timeelapsed(const struct timeval *, int, int,
448 const struct timeval *);
449 static void dropqueue(struct psm_softc *);
450 static void flushpackets(struct psm_softc *);
451 static void proc_mmanplus(struct psm_softc *, packetbuf_t *,
452 mousestatus_t *, int *, int *, int *);
453 static int proc_synaptics(struct psm_softc *, packetbuf_t *,
454 mousestatus_t *, int *, int *, int *);
455 static void proc_versapad(struct psm_softc *, packetbuf_t *,
456 mousestatus_t *, int *, int *, int *);
457 static int tame_mouse(struct psm_softc *, packetbuf_t *, mousestatus_t *,
460 /* vendor specific features */
461 typedef int probefunc_t(KBDC, struct psm_softc *);
463 static int mouse_id_proc1(KBDC, int, int, int *);
464 static int mouse_ext_command(KBDC, int);
466 static probefunc_t enable_groller;
467 static probefunc_t enable_gmouse;
468 static probefunc_t enable_aglide;
469 static probefunc_t enable_kmouse;
470 static probefunc_t enable_msexplorer;
471 static probefunc_t enable_msintelli;
472 static probefunc_t enable_4dmouse;
473 static probefunc_t enable_4dplus;
474 static probefunc_t enable_mmanplus;
475 static probefunc_t enable_synaptics;
476 static probefunc_t enable_trackpoint;
477 static probefunc_t enable_versapad;
479 static void set_trackpoint_parameters(struct psm_softc *sc);
480 static void synaptics_passthrough_on(struct psm_softc *sc);
481 static void synaptics_passthrough_off(struct psm_softc *sc);
487 probefunc_t *probefunc;
490 * WARNING: the order of probe is very important. Don't mess it
491 * unless you know what you are doing.
493 { MOUSE_MODEL_NET, /* Genius NetMouse */
494 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_gmouse },
495 { MOUSE_MODEL_NETSCROLL, /* Genius NetScroll */
496 0xc8, 6, enable_groller },
497 { MOUSE_MODEL_MOUSEMANPLUS, /* Logitech MouseMan+ */
498 0x08, MOUSE_PS2_PACKETSIZE, enable_mmanplus },
499 { MOUSE_MODEL_EXPLORER, /* Microsoft IntelliMouse Explorer */
500 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msexplorer },
501 { MOUSE_MODEL_4D, /* A4 Tech 4D Mouse */
502 0x08, MOUSE_4D_PACKETSIZE, enable_4dmouse },
503 { MOUSE_MODEL_4DPLUS, /* A4 Tech 4D+ Mouse */
504 0xc8, MOUSE_4DPLUS_PACKETSIZE, enable_4dplus },
505 { MOUSE_MODEL_SYNAPTICS, /* Synaptics Touchpad */
506 0xc0, MOUSE_SYNAPTICS_PACKETSIZE, enable_synaptics },
507 { MOUSE_MODEL_INTELLI, /* Microsoft IntelliMouse */
508 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msintelli },
509 { MOUSE_MODEL_GLIDEPOINT, /* ALPS GlidePoint */
510 0xc0, MOUSE_PS2_PACKETSIZE, enable_aglide },
511 { MOUSE_MODEL_THINK, /* Kensington ThinkingMouse */
512 0x80, MOUSE_PS2_PACKETSIZE, enable_kmouse },
513 { MOUSE_MODEL_VERSAPAD, /* Interlink electronics VersaPad */
514 0xe8, MOUSE_PS2VERSA_PACKETSIZE, enable_versapad },
515 { MOUSE_MODEL_TRACKPOINT, /* IBM/Lenovo TrackPoint */
516 0xc0, MOUSE_PS2_PACKETSIZE, enable_trackpoint },
517 { MOUSE_MODEL_GENERIC,
518 0xc0, MOUSE_PS2_PACKETSIZE, NULL },
520 #define GENERIC_MOUSE_ENTRY \
521 ((sizeof(vendortype) / sizeof(*vendortype)) - 1)
523 /* device driver declarateion */
524 static device_method_t psm_methods[] = {
525 /* Device interface */
526 DEVMETHOD(device_identify, psmidentify),
527 DEVMETHOD(device_probe, psmprobe),
528 DEVMETHOD(device_attach, psmattach),
529 DEVMETHOD(device_detach, psmdetach),
530 DEVMETHOD(device_resume, psmresume),
535 static driver_t psm_driver = {
538 sizeof(struct psm_softc),
541 static struct cdevsw psm_cdevsw = {
542 .d_version = D_VERSION,
543 .d_flags = D_NEEDGIANT,
550 .d_name = PSM_DRIVER_NAME,
553 /* device I/O routines */
555 enable_aux_dev(KBDC kbdc)
559 res = send_aux_command(kbdc, PSMC_ENABLE_DEV);
560 VLOG(2, (LOG_DEBUG, "psm: ENABLE_DEV return code:%04x\n", res));
562 return (res == PSM_ACK);
566 disable_aux_dev(KBDC kbdc)
570 res = send_aux_command(kbdc, PSMC_DISABLE_DEV);
571 VLOG(2, (LOG_DEBUG, "psm: DISABLE_DEV return code:%04x\n", res));
573 return (res == PSM_ACK);
577 get_mouse_status(KBDC kbdc, int *status, int flag, int len)
586 cmd = PSMC_SEND_DEV_STATUS;
589 cmd = PSMC_SEND_DEV_DATA;
592 empty_aux_buffer(kbdc, 5);
593 res = send_aux_command(kbdc, cmd);
594 VLOG(2, (LOG_DEBUG, "psm: SEND_AUX_DEV_%s return code:%04x\n",
595 (flag == 1) ? "DATA" : "STATUS", res));
599 for (i = 0; i < len; ++i) {
600 status[i] = read_aux_data(kbdc);
605 VLOG(1, (LOG_DEBUG, "psm: %s %02x %02x %02x\n",
606 (flag == 1) ? "data" : "status", status[0], status[1], status[2]));
612 get_aux_id(KBDC kbdc)
617 empty_aux_buffer(kbdc, 5);
618 res = send_aux_command(kbdc, PSMC_SEND_DEV_ID);
619 VLOG(2, (LOG_DEBUG, "psm: SEND_DEV_ID return code:%04x\n", res));
626 id = read_aux_data(kbdc);
627 VLOG(2, (LOG_DEBUG, "psm: device ID: %04x\n", id));
633 set_mouse_sampling_rate(KBDC kbdc, int rate)
637 res = send_aux_command_and_data(kbdc, PSMC_SET_SAMPLING_RATE, rate);
638 VLOG(2, (LOG_DEBUG, "psm: SET_SAMPLING_RATE (%d) %04x\n", rate, res));
640 return ((res == PSM_ACK) ? rate : -1);
644 set_mouse_scaling(KBDC kbdc, int scale)
651 scale = PSMC_SET_SCALING11;
654 scale = PSMC_SET_SCALING21;
657 res = send_aux_command(kbdc, scale);
658 VLOG(2, (LOG_DEBUG, "psm: SET_SCALING%s return code:%04x\n",
659 (scale == PSMC_SET_SCALING21) ? "21" : "11", res));
661 return (res == PSM_ACK);
664 /* `val' must be 0 through PSMD_MAX_RESOLUTION */
666 set_mouse_resolution(KBDC kbdc, int val)
670 res = send_aux_command_and_data(kbdc, PSMC_SET_RESOLUTION, val);
671 VLOG(2, (LOG_DEBUG, "psm: SET_RESOLUTION (%d) %04x\n", val, res));
673 return ((res == PSM_ACK) ? val : -1);
677 * NOTE: once `set_mouse_mode()' is called, the mouse device must be
678 * re-enabled by calling `enable_aux_dev()'
681 set_mouse_mode(KBDC kbdc)
685 res = send_aux_command(kbdc, PSMC_SET_STREAM_MODE);
686 VLOG(2, (LOG_DEBUG, "psm: SET_STREAM_MODE return code:%04x\n", res));
688 return (res == PSM_ACK);
692 get_mouse_buttons(KBDC kbdc)
694 int c = 2; /* assume two buttons by default */
698 * NOTE: a special sequence to obtain Logitech Mouse specific
699 * information: set resolution to 25 ppi, set scaling to 1:1, set
700 * scaling to 1:1, set scaling to 1:1. Then the second byte of the
701 * mouse status bytes is the number of available buttons.
702 * Some manufactures also support this sequence.
704 if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
706 if (set_mouse_scaling(kbdc, 1) && set_mouse_scaling(kbdc, 1) &&
707 set_mouse_scaling(kbdc, 1) &&
708 get_mouse_status(kbdc, status, 0, 3) >= 3 && status[1] != 0)
713 /* misc subroutines */
715 * Someday, I will get the complete list of valid pointing devices and
722 static int valid_ids[] = {
723 PSM_MOUSE_ID, /* mouse */
724 PSM_BALLPOINT_ID, /* ballpoint device */
725 PSM_INTELLI_ID, /* Intellimouse */
726 PSM_EXPLORER_ID, /* Intellimouse Explorer */
727 -1 /* end of table */
731 for (i = 0; valid_ids[i] >= 0; ++i)
732 if (valid_ids[i] == id)
741 model_name(int model)
747 { MOUSE_MODEL_NETSCROLL, "NetScroll" },
748 { MOUSE_MODEL_NET, "NetMouse/NetScroll Optical" },
749 { MOUSE_MODEL_GLIDEPOINT, "GlidePoint" },
750 { MOUSE_MODEL_THINK, "ThinkingMouse" },
751 { MOUSE_MODEL_INTELLI, "IntelliMouse" },
752 { MOUSE_MODEL_MOUSEMANPLUS, "MouseMan+" },
753 { MOUSE_MODEL_VERSAPAD, "VersaPad" },
754 { MOUSE_MODEL_EXPLORER, "IntelliMouse Explorer" },
755 { MOUSE_MODEL_4D, "4D Mouse" },
756 { MOUSE_MODEL_4DPLUS, "4D+ Mouse" },
757 { MOUSE_MODEL_SYNAPTICS, "Synaptics Touchpad" },
758 { MOUSE_MODEL_TRACKPOINT, "IBM/Lenovo TrackPoint" },
759 { MOUSE_MODEL_GENERIC, "Generic PS/2 mouse" },
760 { MOUSE_MODEL_UNKNOWN, "Unknown" },
764 for (i = 0; models[i].model_code != MOUSE_MODEL_UNKNOWN; ++i)
765 if (models[i].model_code == model)
767 return (models[i].model_name);
771 recover_from_error(KBDC kbdc)
773 /* discard anything left in the output buffer */
774 empty_both_buffers(kbdc, 10);
778 * NOTE: KBDC_RESET_KBD may not restore the communication between the
779 * keyboard and the controller.
784 * NOTE: somehow diagnostic and keyboard port test commands bring the
787 if (!test_controller(kbdc))
788 log(LOG_ERR, "psm: keyboard controller failed.\n");
789 /* if there isn't a keyboard in the system, the following error is OK */
790 if (test_kbd_port(kbdc) != 0)
791 VLOG(1, (LOG_ERR, "psm: keyboard port failed.\n"));
796 restore_controller(KBDC kbdc, int command_byte)
798 empty_both_buffers(kbdc, 10);
800 if (!set_controller_command_byte(kbdc, 0xff, command_byte)) {
801 log(LOG_ERR, "psm: failed to restore the keyboard controller "
803 empty_both_buffers(kbdc, 10);
806 empty_both_buffers(kbdc, 10);
812 * Re-initialize the aux port and device. The aux port must be enabled
813 * and its interrupt must be disabled before calling this routine.
814 * The aux device will be disabled before returning.
815 * The keyboard controller must be locked via `kbdc_lock()' before
816 * calling this routine.
819 doinitialize(struct psm_softc *sc, mousemode_t *mode)
821 KBDC kbdc = sc->kbdc;
825 switch((i = test_aux_port(kbdc))) {
826 case 1: /* ignore these errors */
832 "psm%d: strange result for test aux port (%d).\n",
835 case 0: /* no error */
837 case -1: /* time out */
839 recover_from_error(kbdc);
840 if (sc->config & PSM_CONFIG_IGNPORTERROR)
842 log(LOG_ERR, "psm%d: the aux port is not functioning (%d).\n",
847 if (sc->config & PSM_CONFIG_NORESET) {
849 * Don't try to reset the pointing device. It may possibly
850 * be left in the unknown state, though...
854 * NOTE: some controllers appears to hang the `keyboard' when
855 * the aux port doesn't exist and `PSMC_RESET_DEV' is issued.
857 if (!reset_aux_dev(kbdc)) {
858 recover_from_error(kbdc);
859 log(LOG_ERR, "psm%d: failed to reset the aux device.\n",
866 * both the aux port and the aux device is functioning, see
867 * if the device can be enabled.
869 if (!enable_aux_dev(kbdc) || !disable_aux_dev(kbdc)) {
870 log(LOG_ERR, "psm%d: failed to enable the aux device.\n",
874 empty_both_buffers(kbdc, 10); /* remove stray data if any */
876 /* Re-enable the mouse. */
877 for (i = 0; vendortype[i].probefunc != NULL; ++i)
878 if (vendortype[i].model == sc->hw.model)
879 (*vendortype[i].probefunc)(sc->kbdc, NULL);
881 /* set mouse parameters */
882 if (mode != (mousemode_t *)NULL) {
884 mode->rate = set_mouse_sampling_rate(kbdc, mode->rate);
885 if (mode->resolution >= 0)
887 set_mouse_resolution(kbdc, mode->resolution);
888 set_mouse_scaling(kbdc, 1);
889 set_mouse_mode(kbdc);
892 * Trackpoint settings are lost on resume.
896 set_trackpoint_parameters(sc);
899 /* Record sync on the next data packet we see. */
900 sc->flags |= PSM_NEED_SYNCBITS;
902 /* just check the status of the mouse */
903 if (get_mouse_status(kbdc, stat, 0, 3) < 3)
904 log(LOG_DEBUG, "psm%d: failed to get status (doinitialize).\n",
911 doopen(struct psm_softc *sc, int command_byte)
916 * FIXME: Synaptics TouchPad seems to go back to Relative Mode with
917 * no obvious reason. Thus we check the current mode and restore the
918 * Absolute Mode if it was cleared.
920 * The previous hack at the end of psmprobe() wasn't efficient when
921 * moused(8) was restarted.
923 * A Reset (FF) or Set Defaults (F6) command would clear the
924 * Absolute Mode bit. But a verbose boot or debug.psm.loglevel=5
925 * doesn't show any evidence of such a command.
927 if (sc->hw.model == MOUSE_MODEL_SYNAPTICS) {
928 mouse_ext_command(sc->kbdc, 1);
929 get_mouse_status(sc->kbdc, stat, 0, 3);
930 if ((SYNAPTICS_VERSION_GE(sc->synhw, 7, 5) ||
933 /* Set the mode byte -- request wmode where
935 if (sc->synhw.capExtended)
936 mouse_ext_command(sc->kbdc, 0xc1);
938 mouse_ext_command(sc->kbdc, 0xc0);
939 set_mouse_sampling_rate(sc->kbdc, 20);
940 VLOG(5, (LOG_DEBUG, "psm%d: Synaptis Absolute Mode "
941 "hopefully restored\n",
947 * A user may want to disable tap and drag gestures on a Synaptics
948 * TouchPad when it operates in Relative Mode.
950 if (sc->hw.model == MOUSE_MODEL_GENERIC) {
951 if (tap_enabled > 0) {
953 * Enable tap & drag gestures. We use a Mode Byte
954 * and clear the DisGest bit (see §2.5 of Synaptics
955 * TouchPad Interfacing Guide).
958 "psm%d: enable tap and drag gestures\n",
960 mouse_ext_command(sc->kbdc, 0x00);
961 set_mouse_sampling_rate(sc->kbdc, 20);
962 } else if (tap_enabled == 0) {
964 * Disable tap & drag gestures. We use a Mode Byte
965 * and set the DisGest bit (see §2.5 of Synaptics
966 * TouchPad Interfacing Guide).
969 "psm%d: disable tap and drag gestures\n",
971 mouse_ext_command(sc->kbdc, 0x04);
972 set_mouse_sampling_rate(sc->kbdc, 20);
976 /* enable the mouse device */
977 if (!enable_aux_dev(sc->kbdc)) {
978 /* MOUSE ERROR: failed to enable the mouse because:
979 * 1) the mouse is faulty,
980 * 2) the mouse has been removed(!?)
981 * In the latter case, the keyboard may have hung, and need
982 * recovery procedure...
984 recover_from_error(sc->kbdc);
986 /* FIXME: we could reset the mouse here and try to enable
987 * it again. But it will take long time and it's not a good
988 * idea to disable the keyboard that long...
990 if (!doinitialize(sc, &sc->mode) || !enable_aux_dev(sc->kbdc)) {
991 recover_from_error(sc->kbdc);
995 restore_controller(sc->kbdc, command_byte);
996 /* mark this device is no longer available */
997 sc->state &= ~PSM_VALID;
999 "psm%d: failed to enable the device (doopen).\n",
1005 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
1006 log(LOG_DEBUG, "psm%d: failed to get status (doopen).\n",
1009 /* enable the aux port and interrupt */
1010 if (!set_controller_command_byte(sc->kbdc,
1011 kbdc_get_device_mask(sc->kbdc),
1012 (command_byte & KBD_KBD_CONTROL_BITS) |
1013 KBD_ENABLE_AUX_PORT | KBD_ENABLE_AUX_INT)) {
1014 /* CONTROLLER ERROR */
1015 disable_aux_dev(sc->kbdc);
1016 restore_controller(sc->kbdc, command_byte);
1018 "psm%d: failed to enable the aux interrupt (doopen).\n",
1023 /* start the watchdog timer */
1024 sc->watchdog = FALSE;
1025 callout_reset(&sc->callout, hz * 2, psmtimeout, sc);
1031 reinitialize(struct psm_softc *sc, int doinit)
1037 /* don't let anybody mess with the aux device */
1038 if (!kbdc_lock(sc->kbdc, TRUE))
1042 /* block our watchdog timer */
1043 sc->watchdog = FALSE;
1044 callout_stop(&sc->callout);
1046 /* save the current controller command byte */
1047 empty_both_buffers(sc->kbdc, 10);
1048 c = get_controller_command_byte(sc->kbdc);
1050 "psm%d: current command byte: %04x (reinitialize).\n",
1053 /* enable the aux port but disable the aux interrupt and the keyboard */
1054 if ((c == -1) || !set_controller_command_byte(sc->kbdc,
1055 kbdc_get_device_mask(sc->kbdc),
1056 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
1057 KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1058 /* CONTROLLER ERROR */
1060 kbdc_lock(sc->kbdc, FALSE);
1062 "psm%d: unable to set the command byte (reinitialize).\n",
1067 /* flush any data */
1068 if (sc->state & PSM_VALID) {
1069 /* this may fail; but never mind... */
1070 disable_aux_dev(sc->kbdc);
1071 empty_aux_buffer(sc->kbdc, 10);
1076 memset(&sc->lastinputerr, 0, sizeof(sc->lastinputerr));
1078 /* try to detect the aux device; are you still there? */
1081 if (doinitialize(sc, &sc->mode)) {
1083 sc->state |= PSM_VALID;
1085 /* the device has gone! */
1086 restore_controller(sc->kbdc, c);
1087 sc->state &= ~PSM_VALID;
1089 "psm%d: the aux device has gone! (reinitialize).\n",
1096 /* restore the driver state */
1097 if ((sc->state & PSM_OPEN) && (err == 0)) {
1098 /* enable the aux device and the port again */
1099 err = doopen(sc, c);
1101 log(LOG_ERR, "psm%d: failed to enable the device "
1102 "(reinitialize).\n", sc->unit);
1104 /* restore the keyboard port and disable the aux port */
1105 if (!set_controller_command_byte(sc->kbdc,
1106 kbdc_get_device_mask(sc->kbdc),
1107 (c & KBD_KBD_CONTROL_BITS) |
1108 KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1109 /* CONTROLLER ERROR */
1110 log(LOG_ERR, "psm%d: failed to disable the aux port "
1111 "(reinitialize).\n", sc->unit);
1116 kbdc_lock(sc->kbdc, FALSE);
1120 /* psm driver entry points */
1123 psmidentify(driver_t *driver, device_t parent)
1130 unit = device_get_unit(parent);
1132 /* always add at least one child */
1133 psm = BUS_ADD_CHILD(parent, KBDC_RID_AUX, driver->name, unit);
1137 irq = bus_get_resource_start(psm, SYS_RES_IRQ, KBDC_RID_AUX);
1142 * If the PS/2 mouse device has already been reported by ACPI or
1143 * PnP BIOS, obtain the IRQ resource from it.
1144 * (See psmcpnp_attach() below.)
1146 psmc = device_find_child(device_get_parent(parent),
1147 PSMCPNP_DRIVER_NAME, unit);
1150 irq = bus_get_resource_start(psmc, SYS_RES_IRQ, 0);
1153 bus_delete_resource(psmc, SYS_RES_IRQ, 0);
1154 bus_set_resource(psm, SYS_RES_IRQ, KBDC_RID_AUX, irq, 1);
1157 #define endprobe(v) do { \
1160 kbdc_set_device_mask(sc->kbdc, mask); \
1161 kbdc_lock(sc->kbdc, FALSE); \
1166 psmprobe(device_t dev)
1168 int unit = device_get_unit(dev);
1169 struct psm_softc *sc = device_get_softc(dev);
1180 /* see if IRQ is available */
1182 sc->intr = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
1183 if (sc->intr == NULL) {
1185 device_printf(dev, "unable to allocate IRQ\n");
1188 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1191 sc->kbdc = atkbdc_open(device_get_unit(device_get_parent(dev)));
1192 sc->config = device_get_flags(dev) & PSM_CONFIG_FLAGS;
1193 /* XXX: for backward compatibility */
1194 #if defined(PSM_HOOKRESUME) || defined(PSM_HOOKAPM)
1196 #ifdef PSM_RESETAFTERSUSPEND
1197 PSM_CONFIG_INITAFTERSUSPEND;
1199 PSM_CONFIG_HOOKRESUME;
1201 #endif /* PSM_HOOKRESUME | PSM_HOOKAPM */
1206 device_set_desc(dev, "PS/2 Mouse");
1208 if (!kbdc_lock(sc->kbdc, TRUE)) {
1209 printf("psm%d: unable to lock the controller.\n", unit);
1216 * NOTE: two bits in the command byte controls the operation of the
1217 * aux port (mouse port): the aux port disable bit (bit 5) and the aux
1218 * port interrupt (IRQ 12) enable bit (bit 2).
1221 /* discard anything left after the keyboard initialization */
1222 empty_both_buffers(sc->kbdc, 10);
1224 /* save the current command byte; it will be used later */
1225 mask = kbdc_get_device_mask(sc->kbdc) & ~KBD_AUX_CONTROL_BITS;
1226 command_byte = get_controller_command_byte(sc->kbdc);
1228 printf("psm%d: current command byte:%04x\n", unit,
1230 if (command_byte == -1) {
1231 /* CONTROLLER ERROR */
1232 printf("psm%d: unable to get the current command byte value.\n",
1238 * disable the keyboard port while probing the aux port, which must be
1239 * enabled during this routine
1241 if (!set_controller_command_byte(sc->kbdc,
1242 KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
1243 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
1244 KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1246 * this is CONTROLLER ERROR; I don't know how to recover
1247 * from this error...
1249 restore_controller(sc->kbdc, command_byte);
1250 printf("psm%d: unable to set the command byte.\n", unit);
1253 write_controller_command(sc->kbdc, KBDC_ENABLE_AUX_PORT);
1256 * NOTE: `test_aux_port()' is designed to return with zero if the aux
1257 * port exists and is functioning. However, some controllers appears
1258 * to respond with zero even when the aux port doesn't exist. (It may
1259 * be that this is only the case when the controller DOES have the aux
1260 * port but the port is not wired on the motherboard.) The keyboard
1261 * controllers without the port, such as the original AT, are
1262 * supposed to return with an error code or simply time out. In any
1263 * case, we have to continue probing the port even when the controller
1266 * XXX: some controllers erroneously return the error code 1, 2 or 3
1267 * when it has a perfectly functional aux port. We have to ignore
1268 * this error code. Even if the controller HAS error with the aux
1269 * port, it will be detected later...
1270 * XXX: another incompatible controller returns PSM_ACK (0xfa)...
1272 switch ((i = test_aux_port(sc->kbdc))) {
1273 case 1: /* ignore these errors */
1278 printf("psm%d: strange result for test aux port "
1279 "(%d).\n", unit, i);
1281 case 0: /* no error */
1283 case -1: /* time out */
1284 default: /* error */
1285 recover_from_error(sc->kbdc);
1286 if (sc->config & PSM_CONFIG_IGNPORTERROR)
1288 restore_controller(sc->kbdc, command_byte);
1290 printf("psm%d: the aux port is not functioning (%d).\n",
1295 if (sc->config & PSM_CONFIG_NORESET) {
1297 * Don't try to reset the pointing device. It may possibly be
1298 * left in an unknown state, though...
1302 * NOTE: some controllers appears to hang the `keyboard' when
1303 * the aux port doesn't exist and `PSMC_RESET_DEV' is issued.
1305 * Attempt to reset the controller twice -- this helps
1306 * pierce through some KVM switches. The second reset
1309 if (!reset_aux_dev(sc->kbdc)) {
1310 recover_from_error(sc->kbdc);
1311 restore_controller(sc->kbdc, command_byte);
1313 printf("psm%d: failed to reset the aux "
1316 } else if (!reset_aux_dev(sc->kbdc)) {
1317 recover_from_error(sc->kbdc);
1319 printf("psm%d: failed to reset the aux device "
1325 * both the aux port and the aux device are functioning, see if the
1326 * device can be enabled. NOTE: when enabled, the device will start
1327 * sending data; we shall immediately disable the device once we know
1328 * the device can be enabled.
1330 if (!enable_aux_dev(sc->kbdc) || !disable_aux_dev(sc->kbdc)) {
1332 recover_from_error(sc->kbdc);
1333 restore_controller(sc->kbdc, command_byte);
1335 printf("psm%d: failed to enable the aux device.\n",
1340 /* save the default values after reset */
1341 if (get_mouse_status(sc->kbdc, stat, 0, 3) >= 3) {
1342 sc->dflt_mode.rate = sc->mode.rate = stat[2];
1343 sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1345 sc->dflt_mode.rate = sc->mode.rate = -1;
1346 sc->dflt_mode.resolution = sc->mode.resolution = -1;
1349 /* hardware information */
1350 sc->hw.iftype = MOUSE_IF_PS2;
1352 /* verify the device is a mouse */
1353 sc->hw.hwid = get_aux_id(sc->kbdc);
1354 if (!is_a_mouse(sc->hw.hwid)) {
1355 restore_controller(sc->kbdc, command_byte);
1357 printf("psm%d: unknown device type (%d).\n", unit,
1361 switch (sc->hw.hwid) {
1362 case PSM_BALLPOINT_ID:
1363 sc->hw.type = MOUSE_TRACKBALL;
1366 case PSM_INTELLI_ID:
1367 case PSM_EXPLORER_ID:
1368 case PSM_4DMOUSE_ID:
1370 sc->hw.type = MOUSE_MOUSE;
1373 sc->hw.type = MOUSE_UNKNOWN;
1377 if (sc->config & PSM_CONFIG_NOIDPROBE) {
1379 i = GENERIC_MOUSE_ENTRY;
1382 sc->hw.buttons = get_mouse_buttons(sc->kbdc);
1384 /* other parameters */
1385 for (i = 0; vendortype[i].probefunc != NULL; ++i)
1386 if ((*vendortype[i].probefunc)(sc->kbdc, sc)) {
1388 printf("psm%d: found %s\n", unit,
1389 model_name(vendortype[i].model));
1394 sc->hw.model = vendortype[i].model;
1396 sc->dflt_mode.level = PSM_LEVEL_BASE;
1397 sc->dflt_mode.packetsize = MOUSE_PS2_PACKETSIZE;
1398 sc->dflt_mode.accelfactor = (sc->config & PSM_CONFIG_ACCEL) >> 4;
1399 if (sc->config & PSM_CONFIG_NOCHECKSYNC)
1400 sc->dflt_mode.syncmask[0] = 0;
1402 sc->dflt_mode.syncmask[0] = vendortype[i].syncmask;
1403 if (sc->config & PSM_CONFIG_FORCETAP)
1404 sc->dflt_mode.syncmask[0] &= ~MOUSE_PS2_TAP;
1405 sc->dflt_mode.syncmask[1] = 0; /* syncbits */
1406 sc->mode = sc->dflt_mode;
1407 sc->mode.packetsize = vendortype[i].packetsize;
1409 /* set mouse parameters */
1412 * A version of Logitech FirstMouse+ won't report wheel movement,
1413 * if SET_DEFAULTS is sent... Don't use this command.
1414 * This fix was found by Takashi Nishida.
1416 i = send_aux_command(sc->kbdc, PSMC_SET_DEFAULTS);
1418 printf("psm%d: SET_DEFAULTS return code:%04x\n", unit, i);
1420 if (sc->config & PSM_CONFIG_RESOLUTION)
1421 sc->mode.resolution =
1422 set_mouse_resolution(sc->kbdc,
1423 (sc->config & PSM_CONFIG_RESOLUTION) - 1);
1424 else if (sc->mode.resolution >= 0)
1425 sc->mode.resolution =
1426 set_mouse_resolution(sc->kbdc, sc->dflt_mode.resolution);
1427 if (sc->mode.rate > 0)
1429 set_mouse_sampling_rate(sc->kbdc, sc->dflt_mode.rate);
1430 set_mouse_scaling(sc->kbdc, 1);
1432 /* Record sync on the next data packet we see. */
1433 sc->flags |= PSM_NEED_SYNCBITS;
1435 /* just check the status of the mouse */
1437 * NOTE: XXX there are some arcane controller/mouse combinations out
1438 * there, which hung the controller unless there is data transmission
1439 * after ACK from the mouse.
1441 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
1442 printf("psm%d: failed to get status.\n", unit);
1445 * When in its native mode, some mice operate with different
1446 * default parameters than in the PS/2 compatible mode.
1448 sc->dflt_mode.rate = sc->mode.rate = stat[2];
1449 sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1452 /* disable the aux port for now... */
1453 if (!set_controller_command_byte(sc->kbdc,
1454 KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
1455 (command_byte & KBD_KBD_CONTROL_BITS) |
1456 KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1458 * this is CONTROLLER ERROR; I don't know the proper way to
1459 * recover from this error...
1461 restore_controller(sc->kbdc, command_byte);
1462 printf("psm%d: unable to set the command byte.\n", unit);
1467 kbdc_set_device_mask(sc->kbdc, mask | KBD_AUX_CONTROL_BITS);
1468 kbdc_lock(sc->kbdc, FALSE);
1473 psmattach(device_t dev)
1475 int unit = device_get_unit(dev);
1476 struct psm_softc *sc = device_get_softc(dev);
1480 /* Setup initial state */
1481 sc->state = PSM_VALID;
1482 callout_init(&sc->callout, 0);
1483 callout_init(&sc->softcallout, 0);
1485 /* Setup our interrupt handler */
1487 sc->intr = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
1488 if (sc->intr == NULL)
1490 error = bus_setup_intr(dev, sc->intr, INTR_TYPE_TTY, NULL, psmintr, sc,
1493 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1498 sc->dev = make_dev(&psm_cdevsw, 0, 0, 0, 0666, "psm%d", unit);
1499 sc->dev->si_drv1 = sc;
1500 sc->bdev = make_dev(&psm_cdevsw, 0, 0, 0, 0666, "bpsm%d", unit);
1501 sc->bdev->si_drv1 = sc;
1503 /* Some touchpad devices need full reinitialization after suspend. */
1504 switch (sc->hw.model) {
1505 case MOUSE_MODEL_SYNAPTICS:
1506 case MOUSE_MODEL_GLIDEPOINT:
1507 case MOUSE_MODEL_VERSAPAD:
1508 sc->config |= PSM_CONFIG_INITAFTERSUSPEND;
1511 if (sc->synhw.infoMajor >= 4 || sc->tphw > 0)
1512 sc->config |= PSM_CONFIG_INITAFTERSUSPEND;
1517 printf("psm%d: model %s, device ID %d\n",
1518 unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff);
1520 printf("psm%d: model %s, device ID %d-%02x, %d buttons\n",
1521 unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff,
1522 sc->hw.hwid >> 8, sc->hw.buttons);
1523 printf("psm%d: config:%08x, flags:%08x, packet size:%d\n",
1524 unit, sc->config, sc->flags, sc->mode.packetsize);
1525 printf("psm%d: syncmask:%02x, syncbits:%02x\n",
1526 unit, sc->mode.syncmask[0], sc->mode.syncmask[1]);
1536 psmdetach(device_t dev)
1538 struct psm_softc *sc;
1541 sc = device_get_softc(dev);
1542 if (sc->state & PSM_OPEN)
1546 bus_teardown_intr(dev, sc->intr, sc->ih);
1547 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1549 destroy_dev(sc->dev);
1550 destroy_dev(sc->bdev);
1552 callout_drain(&sc->callout);
1553 callout_drain(&sc->softcallout);
1559 psmopen(struct cdev *dev, int flag, int fmt, struct thread *td)
1561 struct psm_softc *sc;
1566 /* Get device data */
1568 if ((sc == NULL) || (sc->state & PSM_VALID) == 0) {
1569 /* the device is no longer valid/functioning */
1573 /* Disallow multiple opens */
1574 if (sc->state & PSM_OPEN)
1577 device_busy(devclass_get_device(psm_devclass, sc->unit));
1579 /* Initialize state */
1580 sc->mode.level = sc->dflt_mode.level;
1581 sc->mode.protocol = sc->dflt_mode.protocol;
1582 sc->watchdog = FALSE;
1585 /* flush the event queue */
1586 sc->queue.count = 0;
1589 sc->status.flags = 0;
1590 sc->status.button = 0;
1591 sc->status.obutton = 0;
1596 sc->pqueue_start = 0;
1599 /* empty input buffer */
1604 /* don't let timeout routines in the keyboard driver to poll the kbdc */
1605 if (!kbdc_lock(sc->kbdc, TRUE))
1608 /* save the current controller command byte */
1610 command_byte = get_controller_command_byte(sc->kbdc);
1612 /* enable the aux port and temporalily disable the keyboard */
1613 if (command_byte == -1 || !set_controller_command_byte(sc->kbdc,
1614 kbdc_get_device_mask(sc->kbdc),
1615 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
1616 KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1617 /* CONTROLLER ERROR; do you know how to get out of this? */
1618 kbdc_lock(sc->kbdc, FALSE);
1621 "psm%d: unable to set the command byte (psmopen).\n",
1626 * Now that the keyboard controller is told not to generate
1627 * the keyboard and mouse interrupts, call `splx()' to allow
1628 * the other tty interrupts. The clock interrupt may also occur,
1629 * but timeout routines will be blocked by the poll flag set
1634 /* enable the mouse device */
1635 err = doopen(sc, command_byte);
1639 sc->state |= PSM_OPEN;
1640 kbdc_lock(sc->kbdc, FALSE);
1645 psmclose(struct cdev *dev, int flag, int fmt, struct thread *td)
1647 struct psm_softc *sc = dev->si_drv1;
1652 /* don't let timeout routines in the keyboard driver to poll the kbdc */
1653 if (!kbdc_lock(sc->kbdc, TRUE))
1656 /* save the current controller command byte */
1658 command_byte = get_controller_command_byte(sc->kbdc);
1659 if (command_byte == -1) {
1660 kbdc_lock(sc->kbdc, FALSE);
1665 /* disable the aux interrupt and temporalily disable the keyboard */
1666 if (!set_controller_command_byte(sc->kbdc,
1667 kbdc_get_device_mask(sc->kbdc),
1668 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
1669 KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1671 "psm%d: failed to disable the aux int (psmclose).\n",
1673 /* CONTROLLER ERROR;
1674 * NOTE: we shall force our way through. Because the only
1675 * ill effect we shall see is that we may not be able
1676 * to read ACK from the mouse, and it doesn't matter much
1677 * so long as the mouse will accept the DISABLE command.
1682 /* stop the watchdog timer */
1683 callout_stop(&sc->callout);
1685 /* remove anything left in the output buffer */
1686 empty_aux_buffer(sc->kbdc, 10);
1688 /* disable the aux device, port and interrupt */
1689 if (sc->state & PSM_VALID) {
1690 if (!disable_aux_dev(sc->kbdc)) {
1692 * NOTE: we don't return (error) and continue,
1693 * pretending we have successfully disabled the device.
1694 * It's OK because the interrupt routine will discard
1695 * any data from the mouse hereafter.
1698 "psm%d: failed to disable the device (psmclose).\n",
1702 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
1704 "psm%d: failed to get status (psmclose).\n",
1708 if (!set_controller_command_byte(sc->kbdc,
1709 kbdc_get_device_mask(sc->kbdc),
1710 (command_byte & KBD_KBD_CONTROL_BITS) |
1711 KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1714 * we shall ignore this error; see the above comment.
1717 "psm%d: failed to disable the aux port (psmclose).\n",
1721 /* remove anything left in the output buffer */
1722 empty_aux_buffer(sc->kbdc, 10);
1724 /* clean up and sigio requests */
1725 if (sc->async != NULL) {
1726 funsetown(&sc->async);
1730 /* close is almost always successful */
1731 sc->state &= ~PSM_OPEN;
1732 kbdc_lock(sc->kbdc, FALSE);
1733 device_unbusy(devclass_get_device(psm_devclass, sc->unit));
1738 tame_mouse(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *status,
1741 static u_char butmapps2[8] = {
1743 MOUSE_PS2_BUTTON1DOWN,
1744 MOUSE_PS2_BUTTON2DOWN,
1745 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN,
1746 MOUSE_PS2_BUTTON3DOWN,
1747 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON3DOWN,
1748 MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
1749 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN |
1750 MOUSE_PS2_BUTTON3DOWN,
1752 static u_char butmapmsc[8] = {
1753 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP |
1754 MOUSE_MSC_BUTTON3UP,
1755 MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
1756 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON3UP,
1757 MOUSE_MSC_BUTTON3UP,
1758 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP,
1759 MOUSE_MSC_BUTTON2UP,
1760 MOUSE_MSC_BUTTON1UP,
1766 if (sc->mode.level == PSM_LEVEL_BASE) {
1767 mapped = status->button & ~MOUSE_BUTTON4DOWN;
1768 if (status->button & MOUSE_BUTTON4DOWN)
1769 mapped |= MOUSE_BUTTON1DOWN;
1770 status->button = mapped;
1771 buf[0] = MOUSE_PS2_SYNC | butmapps2[mapped & MOUSE_STDBUTTONS];
1772 i = imax(imin(status->dx, 255), -256);
1774 buf[0] |= MOUSE_PS2_XNEG;
1776 i = imax(imin(status->dy, 255), -256);
1778 buf[0] |= MOUSE_PS2_YNEG;
1780 return (MOUSE_PS2_PACKETSIZE);
1781 } else if (sc->mode.level == PSM_LEVEL_STANDARD) {
1782 buf[0] = MOUSE_MSC_SYNC |
1783 butmapmsc[status->button & MOUSE_STDBUTTONS];
1784 i = imax(imin(status->dx, 255), -256);
1786 buf[3] = i - buf[1];
1787 i = imax(imin(status->dy, 255), -256);
1789 buf[4] = i - buf[2];
1790 i = imax(imin(status->dz, 127), -128);
1791 buf[5] = (i >> 1) & 0x7f;
1792 buf[6] = (i - (i >> 1)) & 0x7f;
1793 buf[7] = (~status->button >> 3) & 0x7f;
1794 return (MOUSE_SYS_PACKETSIZE);
1796 return (pb->inputbytes);
1800 psmread(struct cdev *dev, struct uio *uio, int flag)
1802 struct psm_softc *sc = dev->si_drv1;
1803 u_char buf[PSM_SMALLBUFSIZE];
1808 if ((sc->state & PSM_VALID) == 0)
1811 /* block until mouse activity occured */
1813 while (sc->queue.count <= 0) {
1814 if (dev != sc->bdev) {
1816 return (EWOULDBLOCK);
1818 sc->state |= PSM_ASLP;
1819 error = tsleep(sc, PZERO | PCATCH, "psmrea", 0);
1820 sc->state &= ~PSM_ASLP;
1824 } else if ((sc->state & PSM_VALID) == 0) {
1825 /* the device disappeared! */
1832 /* copy data to the user land */
1833 while ((sc->queue.count > 0) && (uio->uio_resid > 0)) {
1835 l = imin(sc->queue.count, uio->uio_resid);
1836 if (l > sizeof(buf))
1838 if (l > sizeof(sc->queue.buf) - sc->queue.head) {
1839 bcopy(&sc->queue.buf[sc->queue.head], &buf[0],
1840 sizeof(sc->queue.buf) - sc->queue.head);
1841 bcopy(&sc->queue.buf[0],
1842 &buf[sizeof(sc->queue.buf) - sc->queue.head],
1843 l - (sizeof(sc->queue.buf) - sc->queue.head));
1845 bcopy(&sc->queue.buf[sc->queue.head], &buf[0], l);
1846 sc->queue.count -= l;
1847 sc->queue.head = (sc->queue.head + l) % sizeof(sc->queue.buf);
1849 error = uiomove(buf, l, uio);
1858 block_mouse_data(struct psm_softc *sc, int *c)
1862 if (!kbdc_lock(sc->kbdc, TRUE))
1866 *c = get_controller_command_byte(sc->kbdc);
1867 if ((*c == -1) || !set_controller_command_byte(sc->kbdc,
1868 kbdc_get_device_mask(sc->kbdc),
1869 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
1870 KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1871 /* this is CONTROLLER ERROR */
1873 kbdc_lock(sc->kbdc, FALSE);
1878 * The device may be in the middle of status data transmission.
1879 * The transmission will be interrupted, thus, incomplete status
1880 * data must be discarded. Although the aux interrupt is disabled
1881 * at the keyboard controller level, at most one aux interrupt
1882 * may have already been pending and a data byte is in the
1883 * output buffer; throw it away. Note that the second argument
1884 * to `empty_aux_buffer()' is zero, so that the call will just
1885 * flush the internal queue.
1886 * `psmintr()' will be invoked after `splx()' if an interrupt is
1887 * pending; it will see no data and returns immediately.
1889 empty_aux_buffer(sc->kbdc, 0); /* flush the queue */
1890 read_aux_data_no_wait(sc->kbdc); /* throw away data if any */
1898 dropqueue(struct psm_softc *sc)
1901 sc->queue.count = 0;
1904 if ((sc->state & PSM_SOFTARMED) != 0) {
1905 sc->state &= ~PSM_SOFTARMED;
1906 callout_stop(&sc->softcallout);
1908 sc->pqueue_start = sc->pqueue_end;
1912 flushpackets(struct psm_softc *sc)
1916 bzero(&sc->pqueue, sizeof(sc->pqueue));
1920 unblock_mouse_data(struct psm_softc *sc, int c)
1925 * We may have seen a part of status data during `set_mouse_XXX()'.
1926 * they have been queued; flush it.
1928 empty_aux_buffer(sc->kbdc, 0);
1930 /* restore ports and interrupt */
1931 if (!set_controller_command_byte(sc->kbdc,
1932 kbdc_get_device_mask(sc->kbdc),
1933 c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
1935 * CONTROLLER ERROR; this is serious, we may have
1936 * been left with the inaccessible keyboard and
1937 * the disabled mouse interrupt.
1942 kbdc_lock(sc->kbdc, FALSE);
1947 psmwrite(struct cdev *dev, struct uio *uio, int flag)
1949 struct psm_softc *sc = dev->si_drv1;
1950 u_char buf[PSM_SMALLBUFSIZE];
1951 int error = 0, i, l;
1953 if ((sc->state & PSM_VALID) == 0)
1956 if (sc->mode.level < PSM_LEVEL_NATIVE)
1959 /* copy data from the user land */
1960 while (uio->uio_resid > 0) {
1961 l = imin(PSM_SMALLBUFSIZE, uio->uio_resid);
1962 error = uiomove(buf, l, uio);
1965 for (i = 0; i < l; i++) {
1966 VLOG(4, (LOG_DEBUG, "psm: cmd 0x%x\n", buf[i]));
1967 if (!write_aux_command(sc->kbdc, buf[i])) {
1969 "psm: cmd 0x%x failed.\n", buf[i]));
1970 return (reinitialize(sc, FALSE));
1979 psmioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
1982 struct psm_softc *sc = dev->si_drv1;
1984 mousestatus_t status;
1985 #if (defined(MOUSE_GETVARS))
1994 /* Perform IOCTL command */
1997 case OLD_MOUSE_GETHWINFO:
1999 ((old_mousehw_t *)addr)->buttons = sc->hw.buttons;
2000 ((old_mousehw_t *)addr)->iftype = sc->hw.iftype;
2001 ((old_mousehw_t *)addr)->type = sc->hw.type;
2002 ((old_mousehw_t *)addr)->hwid = sc->hw.hwid & 0x00ff;
2006 case MOUSE_GETHWINFO:
2008 *(mousehw_t *)addr = sc->hw;
2009 if (sc->mode.level == PSM_LEVEL_BASE)
2010 ((mousehw_t *)addr)->model = MOUSE_MODEL_GENERIC;
2014 case MOUSE_SYN_GETHWINFO:
2016 if (sc->synhw.infoMajor >= 4)
2017 *(synapticshw_t *)addr = sc->synhw;
2023 case OLD_MOUSE_GETMODE:
2025 switch (sc->mode.level) {
2026 case PSM_LEVEL_BASE:
2027 ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2029 case PSM_LEVEL_STANDARD:
2030 ((old_mousemode_t *)addr)->protocol =
2031 MOUSE_PROTO_SYSMOUSE;
2033 case PSM_LEVEL_NATIVE:
2034 ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2037 ((old_mousemode_t *)addr)->rate = sc->mode.rate;
2038 ((old_mousemode_t *)addr)->resolution = sc->mode.resolution;
2039 ((old_mousemode_t *)addr)->accelfactor = sc->mode.accelfactor;
2045 *(mousemode_t *)addr = sc->mode;
2046 if ((sc->flags & PSM_NEED_SYNCBITS) != 0) {
2047 ((mousemode_t *)addr)->syncmask[0] = 0;
2048 ((mousemode_t *)addr)->syncmask[1] = 0;
2050 ((mousemode_t *)addr)->resolution =
2051 MOUSE_RES_LOW - sc->mode.resolution;
2052 switch (sc->mode.level) {
2053 case PSM_LEVEL_BASE:
2054 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2055 ((mousemode_t *)addr)->packetsize =
2056 MOUSE_PS2_PACKETSIZE;
2058 case PSM_LEVEL_STANDARD:
2059 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
2060 ((mousemode_t *)addr)->packetsize =
2061 MOUSE_SYS_PACKETSIZE;
2062 ((mousemode_t *)addr)->syncmask[0] = MOUSE_SYS_SYNCMASK;
2063 ((mousemode_t *)addr)->syncmask[1] = MOUSE_SYS_SYNC;
2065 case PSM_LEVEL_NATIVE:
2066 /* FIXME: this isn't quite correct... XXX */
2067 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2073 case OLD_MOUSE_SETMODE:
2075 if (cmd == OLD_MOUSE_SETMODE) {
2076 mode.rate = ((old_mousemode_t *)addr)->rate;
2078 * resolution old I/F new I/F
2085 if (((old_mousemode_t *)addr)->resolution > 0)
2087 -((old_mousemode_t *)addr)->resolution - 1;
2089 mode.resolution = 0;
2091 ((old_mousemode_t *)addr)->accelfactor;
2094 mode = *(mousemode_t *)addr;
2096 /* adjust and validate parameters. */
2097 if (mode.rate > UCHAR_MAX)
2100 mode.rate = sc->dflt_mode.rate;
2101 else if (mode.rate == -1)
2102 /* don't change the current setting */
2104 else if (mode.rate < 0)
2106 if (mode.resolution >= UCHAR_MAX)
2108 if (mode.resolution >= 200)
2109 mode.resolution = MOUSE_RES_HIGH;
2110 else if (mode.resolution >= 100)
2111 mode.resolution = MOUSE_RES_MEDIUMHIGH;
2112 else if (mode.resolution >= 50)
2113 mode.resolution = MOUSE_RES_MEDIUMLOW;
2114 else if (mode.resolution > 0)
2115 mode.resolution = MOUSE_RES_LOW;
2116 if (mode.resolution == MOUSE_RES_DEFAULT)
2117 mode.resolution = sc->dflt_mode.resolution;
2118 else if (mode.resolution == -1)
2119 /* don't change the current setting */
2121 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
2122 mode.resolution = MOUSE_RES_LOW - mode.resolution;
2123 if (mode.level == -1)
2124 /* don't change the current setting */
2125 mode.level = sc->mode.level;
2126 else if ((mode.level < PSM_LEVEL_MIN) ||
2127 (mode.level > PSM_LEVEL_MAX))
2129 if (mode.accelfactor == -1)
2130 /* don't change the current setting */
2131 mode.accelfactor = sc->mode.accelfactor;
2132 else if (mode.accelfactor < 0)
2135 /* don't allow anybody to poll the keyboard controller */
2136 error = block_mouse_data(sc, &command_byte);
2140 /* set mouse parameters */
2142 mode.rate = set_mouse_sampling_rate(sc->kbdc,
2144 if (mode.resolution >= 0)
2146 set_mouse_resolution(sc->kbdc, mode.resolution);
2147 set_mouse_scaling(sc->kbdc, 1);
2148 get_mouse_status(sc->kbdc, stat, 0, 3);
2151 sc->mode.rate = mode.rate;
2152 sc->mode.resolution = mode.resolution;
2153 sc->mode.accelfactor = mode.accelfactor;
2154 sc->mode.level = mode.level;
2157 unblock_mouse_data(sc, command_byte);
2160 case MOUSE_GETLEVEL:
2161 *(int *)addr = sc->mode.level;
2164 case MOUSE_SETLEVEL:
2165 if ((*(int *)addr < PSM_LEVEL_MIN) ||
2166 (*(int *)addr > PSM_LEVEL_MAX))
2168 sc->mode.level = *(int *)addr;
2171 case MOUSE_GETSTATUS:
2173 status = sc->status;
2174 sc->status.flags = 0;
2175 sc->status.obutton = sc->status.button;
2176 sc->status.button = 0;
2181 *(mousestatus_t *)addr = status;
2184 #if (defined(MOUSE_GETVARS))
2186 var = (mousevar_t *)addr;
2187 bzero(var, sizeof(*var));
2189 var->var[0] = MOUSE_VARS_PS2_SIG;
2190 var->var[1] = sc->config;
2191 var->var[2] = sc->flags;
2197 #endif /* MOUSE_GETVARS */
2199 case MOUSE_READSTATE:
2200 case MOUSE_READDATA:
2201 data = (mousedata_t *)addr;
2202 if (data->len > sizeof(data->buf)/sizeof(data->buf[0]))
2205 error = block_mouse_data(sc, &command_byte);
2208 if ((data->len = get_mouse_status(sc->kbdc, data->buf,
2209 (cmd == MOUSE_READDATA) ? 1 : 0, data->len)) <= 0)
2211 unblock_mouse_data(sc, command_byte);
2214 #if (defined(MOUSE_SETRESOLUTION))
2215 case MOUSE_SETRESOLUTION:
2216 mode.resolution = *(int *)addr;
2217 if (mode.resolution >= UCHAR_MAX)
2219 else if (mode.resolution >= 200)
2220 mode.resolution = MOUSE_RES_HIGH;
2221 else if (mode.resolution >= 100)
2222 mode.resolution = MOUSE_RES_MEDIUMHIGH;
2223 else if (mode.resolution >= 50)
2224 mode.resolution = MOUSE_RES_MEDIUMLOW;
2225 else if (mode.resolution > 0)
2226 mode.resolution = MOUSE_RES_LOW;
2227 if (mode.resolution == MOUSE_RES_DEFAULT)
2228 mode.resolution = sc->dflt_mode.resolution;
2229 else if (mode.resolution == -1)
2230 mode.resolution = sc->mode.resolution;
2231 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
2232 mode.resolution = MOUSE_RES_LOW - mode.resolution;
2234 error = block_mouse_data(sc, &command_byte);
2237 sc->mode.resolution =
2238 set_mouse_resolution(sc->kbdc, mode.resolution);
2239 if (sc->mode.resolution != mode.resolution)
2241 unblock_mouse_data(sc, command_byte);
2243 #endif /* MOUSE_SETRESOLUTION */
2245 #if (defined(MOUSE_SETRATE))
2247 mode.rate = *(int *)addr;
2248 if (mode.rate > UCHAR_MAX)
2251 mode.rate = sc->dflt_mode.rate;
2252 else if (mode.rate < 0)
2253 mode.rate = sc->mode.rate;
2255 error = block_mouse_data(sc, &command_byte);
2258 sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
2259 if (sc->mode.rate != mode.rate)
2261 unblock_mouse_data(sc, command_byte);
2263 #endif /* MOUSE_SETRATE */
2265 #if (defined(MOUSE_SETSCALING))
2266 case MOUSE_SETSCALING:
2267 if ((*(int *)addr <= 0) || (*(int *)addr > 2))
2270 error = block_mouse_data(sc, &command_byte);
2273 if (!set_mouse_scaling(sc->kbdc, *(int *)addr))
2275 unblock_mouse_data(sc, command_byte);
2277 #endif /* MOUSE_SETSCALING */
2279 #if (defined(MOUSE_GETHWID))
2281 error = block_mouse_data(sc, &command_byte);
2284 sc->hw.hwid &= ~0x00ff;
2285 sc->hw.hwid |= get_aux_id(sc->kbdc);
2286 *(int *)addr = sc->hw.hwid & 0x00ff;
2287 unblock_mouse_data(sc, command_byte);
2289 #endif /* MOUSE_GETHWID */
2295 error = fsetown(*(int *)addr, &sc->async);
2298 *(int *) addr = fgetown(&sc->async);
2308 psmtimeout(void *arg)
2310 struct psm_softc *sc;
2313 sc = (struct psm_softc *)arg;
2315 if (sc->watchdog && kbdc_lock(sc->kbdc, TRUE)) {
2316 VLOG(4, (LOG_DEBUG, "psm%d: lost interrupt?\n", sc->unit));
2318 kbdc_lock(sc->kbdc, FALSE);
2320 sc->watchdog = TRUE;
2322 callout_reset(&sc->callout, hz, psmtimeout, sc);
2325 /* Add all sysctls under the debug.psm and hw.psm nodes */
2326 static SYSCTL_NODE(_debug, OID_AUTO, psm, CTLFLAG_RD, 0, "ps/2 mouse");
2327 static SYSCTL_NODE(_hw, OID_AUTO, psm, CTLFLAG_RD, 0, "ps/2 mouse");
2329 SYSCTL_INT(_debug_psm, OID_AUTO, loglevel, CTLFLAG_RW, &verbose, 0,
2332 static int psmhz = 20;
2333 SYSCTL_INT(_debug_psm, OID_AUTO, hz, CTLFLAG_RW, &psmhz, 0,
2334 "Frequency of the softcallout (in hz)");
2335 static int psmerrsecs = 2;
2336 SYSCTL_INT(_debug_psm, OID_AUTO, errsecs, CTLFLAG_RW, &psmerrsecs, 0,
2337 "Number of seconds during which packets will dropped after a sync error");
2338 static int psmerrusecs = 0;
2339 SYSCTL_INT(_debug_psm, OID_AUTO, errusecs, CTLFLAG_RW, &psmerrusecs, 0,
2340 "Microseconds to add to psmerrsecs");
2341 static int psmsecs = 0;
2342 SYSCTL_INT(_debug_psm, OID_AUTO, secs, CTLFLAG_RW, &psmsecs, 0,
2343 "Max number of seconds between soft interrupts");
2344 static int psmusecs = 500000;
2345 SYSCTL_INT(_debug_psm, OID_AUTO, usecs, CTLFLAG_RW, &psmusecs, 0,
2346 "Microseconds to add to psmsecs");
2347 static int pkterrthresh = 2;
2348 SYSCTL_INT(_debug_psm, OID_AUTO, pkterrthresh, CTLFLAG_RW, &pkterrthresh, 0,
2349 "Number of error packets allowed before reinitializing the mouse");
2351 SYSCTL_INT(_hw_psm, OID_AUTO, tap_enabled, CTLFLAG_RW, &tap_enabled, 0,
2352 "Enable tap and drag gestures");
2353 static int tap_threshold = PSM_TAP_THRESHOLD;
2354 SYSCTL_INT(_hw_psm, OID_AUTO, tap_threshold, CTLFLAG_RW, &tap_threshold, 0,
2355 "Button tap threshold");
2356 static int tap_timeout = PSM_TAP_TIMEOUT;
2357 SYSCTL_INT(_hw_psm, OID_AUTO, tap_timeout, CTLFLAG_RW, &tap_timeout, 0,
2358 "Tap timeout for touchpads");
2363 struct psm_softc *sc = arg;
2369 /* read until there is nothing to read */
2370 while((c = read_aux_data_no_wait(sc->kbdc)) != -1) {
2371 pb = &sc->pqueue[sc->pqueue_end];
2373 /* discard the byte if the device is not open */
2374 if ((sc->state & PSM_OPEN) == 0)
2377 getmicrouptime(&now);
2378 if ((pb->inputbytes > 0) &&
2379 timevalcmp(&now, &sc->inputtimeout, >)) {
2380 VLOG(3, (LOG_DEBUG, "psmintr: delay too long; "
2381 "resetting byte count\n"));
2386 sc->inputtimeout.tv_sec = PSM_INPUT_TIMEOUT / 1000000;
2387 sc->inputtimeout.tv_usec = PSM_INPUT_TIMEOUT % 1000000;
2388 timevaladd(&sc->inputtimeout, &now);
2390 pb->ipacket[pb->inputbytes++] = c;
2392 if (sc->mode.level == PSM_LEVEL_NATIVE) {
2393 VLOG(4, (LOG_DEBUG, "psmintr: %02x\n", pb->ipacket[0]));
2398 if (pb->inputbytes < sc->mode.packetsize)
2402 "psmintr: %02x %02x %02x %02x %02x %02x\n",
2403 pb->ipacket[0], pb->ipacket[1], pb->ipacket[2],
2404 pb->ipacket[3], pb->ipacket[4], pb->ipacket[5]));
2409 if ((sc->flags & PSM_NEED_SYNCBITS) != 0) {
2410 sc->mode.syncmask[1] = (c & sc->mode.syncmask[0]);
2411 sc->flags &= ~PSM_NEED_SYNCBITS;
2413 "psmintr: Sync bytes now %04x,%04x\n",
2414 sc->mode.syncmask[0], sc->mode.syncmask[0]));
2415 } else if ((c & sc->mode.syncmask[0]) != sc->mode.syncmask[1]) {
2416 VLOG(3, (LOG_DEBUG, "psmintr: out of sync "
2417 "(%04x != %04x) %d cmds since last error.\n",
2418 c & sc->mode.syncmask[0], sc->mode.syncmask[1],
2419 sc->cmdcount - sc->lasterr));
2420 sc->lasterr = sc->cmdcount;
2422 * The sync byte test is a weak measure of packet
2423 * validity. Conservatively discard any input yet
2424 * to be seen by userland when we detect a sync
2425 * error since there is a good chance some of
2426 * the queued packets have undetected errors.
2429 if (sc->syncerrors == 0)
2432 sc->lastinputerr = now;
2433 if (sc->syncerrors >= sc->mode.packetsize * 2 ||
2434 sc->pkterrors >= pkterrthresh) {
2436 * If we've failed to find a single sync byte
2437 * in 2 packets worth of data, or we've seen
2438 * persistent packet errors during the
2439 * validation period, reinitialize the mouse
2440 * in hopes of returning it to the expected
2444 "psmintr: reset the mouse.\n"));
2445 reinitialize(sc, TRUE);
2446 } else if (sc->syncerrors == sc->mode.packetsize) {
2448 * Try a soft reset after searching for a sync
2449 * byte through a packet length of bytes.
2452 "psmintr: re-enable the mouse.\n"));
2454 disable_aux_dev(sc->kbdc);
2455 enable_aux_dev(sc->kbdc);
2458 "psmintr: discard a byte (%d)\n",
2461 bcopy(&pb->ipacket[1], &pb->ipacket[0],
2468 * We have what appears to be a valid packet.
2469 * Reset the error counters.
2474 * Drop even good packets if they occur within a timeout
2475 * period of a sync error. This allows the detection of
2476 * a change in the mouse's packet mode without exposing
2477 * erratic mouse behavior to the user. Some KVMs forget
2478 * enhanced mouse modes during switch events.
2480 if (!timeelapsed(&sc->lastinputerr, psmerrsecs, psmerrusecs,
2487 * Now that we're out of the validation period, reset
2488 * the packet error count.
2494 if (++sc->pqueue_end >= PSM_PACKETQUEUE)
2497 * If we've filled the queue then call the softintr ourselves,
2498 * otherwise schedule the interrupt for later.
2500 if (!timeelapsed(&sc->lastsoftintr, psmsecs, psmusecs, &now) ||
2501 (sc->pqueue_end == sc->pqueue_start)) {
2502 if ((sc->state & PSM_SOFTARMED) != 0) {
2503 sc->state &= ~PSM_SOFTARMED;
2504 callout_stop(&sc->softcallout);
2507 } else if ((sc->state & PSM_SOFTARMED) == 0) {
2508 sc->state |= PSM_SOFTARMED;
2509 callout_reset(&sc->softcallout,
2510 psmhz < 1 ? 1 : (hz/psmhz), psmsoftintr, arg);
2516 proc_mmanplus(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
2517 int *x, int *y, int *z)
2521 * PS2++ protocol packet
2523 * b7 b6 b5 b4 b3 b2 b1 b0
2524 * byte 1: * 1 p3 p2 1 * * *
2525 * byte 2: c1 c2 p1 p0 d1 d0 1 0
2527 * p3-p0: packet type
2528 * c1, c2: c1 & c2 == 1, if p2 == 0
2529 * c1 & c2 == 0, if p2 == 1
2531 * packet type: 0 (device type)
2532 * See comments in enable_mmanplus() below.
2534 * packet type: 1 (wheel data)
2536 * b7 b6 b5 b4 b3 b2 b1 b0
2537 * byte 3: h * B5 B4 s d2 d1 d0
2539 * h: 1, if horizontal roller data
2540 * 0, if vertical roller data
2541 * B4, B5: button 4 and 5
2543 * d2-d0: roller data
2545 * packet type: 2 (reserved)
2547 if (((pb->ipacket[0] & MOUSE_PS2PLUS_SYNCMASK) == MOUSE_PS2PLUS_SYNC) &&
2548 (abs(*x) > 191) && MOUSE_PS2PLUS_CHECKBITS(pb->ipacket)) {
2550 * the extended data packet encodes button
2553 switch (MOUSE_PS2PLUS_PACKET_TYPE(pb->ipacket)) {
2555 /* wheel data packet */
2557 if (pb->ipacket[2] & 0x80) {
2558 /* XXX horizontal roller count - ignore it */
2561 /* vertical roller count */
2562 *z = (pb->ipacket[2] & MOUSE_PS2PLUS_ZNEG) ?
2563 (pb->ipacket[2] & 0x0f) - 16 :
2564 (pb->ipacket[2] & 0x0f);
2566 ms->button |= (pb->ipacket[2] &
2567 MOUSE_PS2PLUS_BUTTON4DOWN) ?
2568 MOUSE_BUTTON4DOWN : 0;
2569 ms->button |= (pb->ipacket[2] &
2570 MOUSE_PS2PLUS_BUTTON5DOWN) ?
2571 MOUSE_BUTTON5DOWN : 0;
2575 * this packet type is reserved by
2579 * IBM ScrollPoint Mouse uses this
2580 * packet type to encode both vertical
2581 * and horizontal scroll movement.
2584 /* horizontal count */
2585 if (pb->ipacket[2] & 0x0f)
2586 *z = (pb->ipacket[2] & MOUSE_SPOINT_WNEG) ?
2588 /* vertical count */
2589 if (pb->ipacket[2] & 0xf0)
2590 *z = (pb->ipacket[2] & MOUSE_SPOINT_ZNEG) ?
2594 /* device type packet - shouldn't happen */
2598 ms->button = ms->obutton;
2599 VLOG(1, (LOG_DEBUG, "psmintr: unknown PS2++ packet "
2600 "type %d: 0x%02x 0x%02x 0x%02x\n",
2601 MOUSE_PS2PLUS_PACKET_TYPE(pb->ipacket),
2602 pb->ipacket[0], pb->ipacket[1], pb->ipacket[2]));
2606 /* preserve button states */
2607 ms->button |= ms->obutton & MOUSE_EXTBUTTONS;
2612 proc_synaptics(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
2613 int *x, int *y, int *z)
2615 static int touchpad_buttons;
2616 static int guest_buttons;
2619 /* TouchPad PS/2 absolute mode message format with capFourButtons:
2621 * Bits: 7 6 5 4 3 2 1 0 (LSB)
2622 * ------------------------------------------------
2623 * ipacket[0]: 1 0 W3 W2 0 W1 R L
2624 * ipacket[1]: Yb Ya Y9 Y8 Xb Xa X9 X8
2625 * ipacket[2]: Z7 Z6 Z5 Z4 Z3 Z2 Z1 Z0
2626 * ipacket[3]: 1 1 Yc Xc 0 W0 D^R U^L
2627 * ipacket[4]: X7 X6 X5 X4 X3 X2 X1 X0
2628 * ipacket[5]: Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
2631 * L: left physical mouse button
2632 * R: right physical mouse button
2640 * Without capFourButtons but with nExtendeButtons and/or capMiddle
2642 * Bits: 7 6 5 4 3 2 1 0 (LSB)
2643 * ------------------------------------------------------
2644 * ipacket[3]: 1 1 Yc Xc 0 W0 E^R M^L
2645 * ipacket[4]: X7 X6 X5 X4 X3|b7 X2|b5 X1|b3 X0|b1
2646 * ipacket[5]: Y7 Y6 Y5 Y4 Y3|b8 Y2|b6 Y1|b4 Y0|b2
2649 * M: Middle physical mouse button
2650 * E: Extended mouse buttons reported instead of low bits of X and Y
2651 * b1-b8: Extended mouse buttons
2652 * Only ((nExtendedButtons + 1) >> 1) bits are used in packet
2653 * 4 and 5, for reading X and Y value they should be zeroed.
2655 * Absolute reportable limits: 0 - 6143.
2656 * Typical bezel limits: 1472 - 5472.
2657 * Typical edge marings: 1632 - 5312.
2659 * w = 3 Passthrough Packet
2661 * Byte 2,5,6 == Byte 1,2,3 of "Guest"
2664 if (!synaptics_support)
2667 /* Sanity check for out of sync packets. */
2668 if ((pb->ipacket[0] & 0xc8) != 0x80 ||
2669 (pb->ipacket[3] & 0xc8) != 0xc0)
2677 * z = 0 No finger contact
2678 * z = 10 Finger hovering near the pad
2679 * z = 30 Very light finger contact
2680 * z = 80 Normal finger contact
2681 * z = 110 Very heavy finger contact
2682 * z = 200 Finger lying flat on pad surface
2683 * z = 255 Maximum reportable Z
2685 *z = pb->ipacket[2];
2688 * Finger width value
2690 * w = 0 Two finger on the pad (capMultiFinger needed)
2691 * w = 1 Three or more fingers (capMultiFinger needed)
2692 * w = 2 Pen (instead of finger) (capPen needed)
2693 * w = 3 Reserved (passthrough?)
2694 * w = 4-7 Finger of normal width (capPalmDetect needed)
2695 * w = 8-14 Very wide finger or palm (capPalmDetect needed)
2696 * w = 15 Maximum reportable width (capPalmDetect needed)
2698 /* XXX Is checking capExtended enough? */
2699 if (sc->synhw.capExtended)
2700 w = ((pb->ipacket[0] & 0x30) >> 2) |
2701 ((pb->ipacket[0] & 0x04) >> 1) |
2702 ((pb->ipacket[3] & 0x04) >> 2);
2704 /* Assume a finger of regular width. */
2709 * Handle packets from the guest device. See:
2710 * Synaptics PS/2 TouchPad Interfacing Guide, Section 5.1
2712 if (w == 3 && sc->synhw.capPassthrough) {
2713 *x = ((pb->ipacket[1] & 0x10) ?
2714 pb->ipacket[4] - 256 : pb->ipacket[4]);
2715 *y = ((pb->ipacket[1] & 0x20) ?
2716 pb->ipacket[5] - 256 : pb->ipacket[5]);
2720 if (pb->ipacket[1] & 0x01)
2721 guest_buttons |= MOUSE_BUTTON1DOWN;
2722 if (pb->ipacket[1] & 0x04)
2723 guest_buttons |= MOUSE_BUTTON2DOWN;
2724 if (pb->ipacket[1] & 0x02)
2725 guest_buttons |= MOUSE_BUTTON3DOWN;
2727 ms->button = touchpad_buttons | guest_buttons;
2731 if (sc->syninfo.touchpad_off) {
2733 ms->button = ms->obutton;
2737 /* Button presses */
2738 touchpad_buttons = 0;
2739 if (pb->ipacket[0] & 0x01)
2740 touchpad_buttons |= MOUSE_BUTTON1DOWN;
2741 if (pb->ipacket[0] & 0x02)
2742 touchpad_buttons |= MOUSE_BUTTON3DOWN;
2744 if (sc->synhw.capExtended && sc->synhw.capFourButtons) {
2745 if ((pb->ipacket[3] ^ pb->ipacket[0]) & 0x01)
2746 touchpad_buttons |= MOUSE_BUTTON4DOWN;
2747 if ((pb->ipacket[3] ^ pb->ipacket[0]) & 0x02)
2748 touchpad_buttons |= MOUSE_BUTTON5DOWN;
2749 } else if (sc->synhw.capExtended && sc->synhw.capMiddle &&
2750 !sc->synhw.capClickPad) {
2752 if ((pb->ipacket[0] ^ pb->ipacket[3]) & 0x01)
2753 touchpad_buttons |= MOUSE_BUTTON2DOWN;
2754 } else if (sc->synhw.capExtended && (sc->synhw.nExtendedButtons > 0)) {
2755 /* Extended Buttons */
2756 if ((pb->ipacket[0] ^ pb->ipacket[3]) & 0x02) {
2757 if (sc->syninfo.directional_scrolls) {
2758 if (pb->ipacket[4] & 0x01)
2759 touchpad_buttons |= MOUSE_BUTTON4DOWN;
2760 if (pb->ipacket[5] & 0x01)
2761 touchpad_buttons |= MOUSE_BUTTON5DOWN;
2762 if (pb->ipacket[4] & 0x02)
2763 touchpad_buttons |= MOUSE_BUTTON6DOWN;
2764 if (pb->ipacket[5] & 0x02)
2765 touchpad_buttons |= MOUSE_BUTTON7DOWN;
2767 if (pb->ipacket[4] & 0x01)
2768 touchpad_buttons |= MOUSE_BUTTON1DOWN;
2769 if (pb->ipacket[5] & 0x01)
2770 touchpad_buttons |= MOUSE_BUTTON3DOWN;
2771 if (pb->ipacket[4] & 0x02)
2772 touchpad_buttons |= MOUSE_BUTTON2DOWN;
2773 sc->extended_buttons = touchpad_buttons;
2777 * Zero out bits used by extended buttons to avoid
2778 * misinterpretation of the data absolute position.
2780 * The bits represented by
2782 * (nExtendedButtons + 1) >> 1
2784 * will be masked out in both bytes.
2785 * The mask for n bits is computed with the formula
2791 maskedbits = (sc->synhw.nExtendedButtons + 1) >> 1;
2792 mask = (1 << maskedbits) - 1;
2793 pb->ipacket[4] &= ~(mask);
2794 pb->ipacket[5] &= ~(mask);
2795 } else if (!sc->syninfo.directional_scrolls &&
2796 !sc->synaction.in_vscroll) {
2798 * Keep reporting MOUSE DOWN until we get a new packet
2799 * indicating otherwise.
2801 touchpad_buttons |= sc->extended_buttons;
2804 /* Handle ClickPad. */
2805 if (sc->synhw.capClickPad &&
2806 ((pb->ipacket[0] ^ pb->ipacket[3]) & 0x01))
2807 touchpad_buttons |= MOUSE_BUTTON1DOWN;
2809 ms->button = touchpad_buttons | guest_buttons;
2812 * Check pressure to detect a real wanted action on the
2815 if (*z >= sc->syninfo.min_pressure) {
2816 synapticsaction_t *synaction;
2817 int cursor, peer, window;
2818 int dx, dy, dxp, dyp;
2819 int max_width, max_pressure;
2820 int margin_top, margin_right, margin_bottom, margin_left;
2821 int na_top, na_right, na_bottom, na_left;
2822 int window_min, window_max;
2824 int weight_current, weight_previous, weight_len_squared;
2825 int div_min, div_max, div_len;
2826 int vscroll_hor_area, vscroll_ver_area;
2827 int two_finger_scroll;
2828 int len, weight_prev_x, weight_prev_y;
2829 int div_max_x, div_max_y, div_x, div_y;
2832 /* XXX Verify values? */
2833 max_width = sc->syninfo.max_width;
2834 max_pressure = sc->syninfo.max_pressure;
2835 margin_top = sc->syninfo.margin_top;
2836 margin_right = sc->syninfo.margin_right;
2837 margin_bottom = sc->syninfo.margin_bottom;
2838 margin_left = sc->syninfo.margin_left;
2839 na_top = sc->syninfo.na_top;
2840 na_right = sc->syninfo.na_right;
2841 na_bottom = sc->syninfo.na_bottom;
2842 na_left = sc->syninfo.na_left;
2843 window_min = sc->syninfo.window_min;
2844 window_max = sc->syninfo.window_max;
2845 multiplicator = sc->syninfo.multiplicator;
2846 weight_current = sc->syninfo.weight_current;
2847 weight_previous = sc->syninfo.weight_previous;
2848 weight_len_squared = sc->syninfo.weight_len_squared;
2849 div_min = sc->syninfo.div_min;
2850 div_max = sc->syninfo.div_max;
2851 div_len = sc->syninfo.div_len;
2852 vscroll_hor_area = sc->syninfo.vscroll_hor_area;
2853 vscroll_ver_area = sc->syninfo.vscroll_ver_area;
2854 two_finger_scroll = sc->syninfo.two_finger_scroll;
2856 /* Palm detection. */
2858 (sc->synhw.capMultiFinger && (w == 0 || w == 1)) ||
2859 (sc->synhw.capPalmDetect && w >= 4 && w <= max_width) ||
2860 (!sc->synhw.capPalmDetect && *z <= max_pressure) ||
2861 (sc->synhw.capPen && w == 2))) {
2863 * We consider the packet irrelevant for the current
2865 * - the width isn't comprised in:
2867 * - the pressure isn't comprised in:
2868 * [min_pressure; max_pressure]
2869 * - pen aren't supported but w is 2
2871 * Note that this doesn't terminate the current action.
2874 "synaptics: palm detected! (%d)\n", w));
2878 /* Read current absolute position. */
2879 x0 = ((pb->ipacket[3] & 0x10) << 8) |
2880 ((pb->ipacket[1] & 0x0f) << 8) |
2882 y0 = ((pb->ipacket[3] & 0x20) << 7) |
2883 ((pb->ipacket[1] & 0xf0) << 4) |
2886 synaction = &(sc->synaction);
2889 * If the action is just beginning, init the structure and
2890 * compute tap timeout.
2892 if (!(sc->flags & PSM_FLAGS_FINGERDOWN)) {
2893 VLOG(3, (LOG_DEBUG, "synaptics: ----\n"));
2895 /* Store the first point of this action. */
2896 synaction->start_x = x0;
2897 synaction->start_y = y0;
2900 /* Initialize queue. */
2901 synaction->queue_cursor = SYNAPTICS_PACKETQUEUE;
2902 synaction->queue_len = 0;
2903 synaction->window_min = window_min;
2905 /* Reset average. */
2906 synaction->avg_dx = 0;
2907 synaction->avg_dy = 0;
2909 /* Reset squelch. */
2910 synaction->squelch_x = 0;
2911 synaction->squelch_y = 0;
2913 /* Reset pressure peak. */
2916 /* Reset fingers count. */
2917 synaction->fingers_nb = 0;
2919 /* Reset virtual scrolling state. */
2920 synaction->in_vscroll = 0;
2922 /* Compute tap timeout. */
2923 sc->taptimeout.tv_sec = tap_timeout / 1000000;
2924 sc->taptimeout.tv_usec = tap_timeout % 1000000;
2925 timevaladd(&sc->taptimeout, &sc->lastsoftintr);
2927 sc->flags |= PSM_FLAGS_FINGERDOWN;
2929 /* Calculate the current delta. */
2930 cursor = synaction->queue_cursor;
2931 dx = x0 - synaction->queue[cursor].x;
2932 dy = y0 - synaction->queue[cursor].y;
2935 /* If in tap-hold, add the recorded button. */
2936 if (synaction->in_taphold)
2937 ms->button |= synaction->tap_button;
2940 * From now on, we can use the SYNAPTICS_END label to skip
2941 * the current packet.
2945 * Limit the coordinates to the specified margins because
2946 * this area isn't very reliable.
2948 if (x0 <= margin_left)
2950 else if (x0 >= 6143 - margin_right)
2951 x0 = 6143 - margin_right;
2952 if (y0 <= margin_bottom)
2954 else if (y0 >= 6143 - margin_top)
2955 y0 = 6143 - margin_top;
2957 VLOG(3, (LOG_DEBUG, "synaptics: ipacket: [%d, %d], %d, %d\n",
2960 /* Queue this new packet. */
2961 cursor = SYNAPTICS_QUEUE_CURSOR(synaction->queue_cursor - 1);
2962 synaction->queue[cursor].x = x0;
2963 synaction->queue[cursor].y = y0;
2964 synaction->queue_cursor = cursor;
2965 if (synaction->queue_len < SYNAPTICS_PACKETQUEUE)
2966 synaction->queue_len++;
2968 "synaptics: cursor[%d]: x=%d, y=%d, dx=%d, dy=%d\n",
2969 cursor, x0, y0, dx, dy));
2972 * For tap, we keep the maximum number of fingers and the
2973 * pressure peak. Also with multiple fingers, we increase
2974 * the minimum window.
2977 case 1: /* Three or more fingers. */
2978 synaction->fingers_nb = imax(3, synaction->fingers_nb);
2979 synaction->window_min = window_max;
2981 case 0: /* Two fingers. */
2982 synaction->fingers_nb = imax(2, synaction->fingers_nb);
2983 synaction->window_min = window_max;
2985 default: /* One finger or undetectable. */
2986 synaction->fingers_nb = imax(1, synaction->fingers_nb);
2988 sc->zmax = imax(*z, sc->zmax);
2990 /* Do we have enough packets to consider this a movement? */
2991 if (synaction->queue_len < synaction->window_min)
2994 /* Is a scrolling action occuring? */
2995 if (!synaction->in_taphold && !synaction->in_vscroll) {
2997 * A scrolling action must not conflict with a tap
2998 * action. Here are the conditions to consider a
3000 * - the action in a configurable area
3001 * - one of the following:
3002 * . the distance between the last packet and the
3003 * first should be above a configurable minimum
3006 dxp = abs(synaction->queue[synaction->queue_cursor].x -
3007 synaction->start_x);
3008 dyp = abs(synaction->queue[synaction->queue_cursor].y -
3009 synaction->start_y);
3011 if (timevalcmp(&sc->lastsoftintr, &sc->taptimeout, >) ||
3012 dxp >= sc->syninfo.vscroll_min_delta ||
3013 dyp >= sc->syninfo.vscroll_min_delta) {
3015 * Handle two finger scrolling.
3016 * Note that we don't rely on fingers_nb
3017 * as that keeps the maximum number of fingers.
3019 if (two_finger_scroll) {
3021 synaction->in_vscroll +=
3023 synaction->in_vscroll +=
3027 /* Check for horizontal scrolling. */
3028 if ((vscroll_hor_area > 0 &&
3029 synaction->start_y <=
3030 vscroll_hor_area) ||
3031 (vscroll_hor_area < 0 &&
3032 synaction->start_y >=
3033 6143 + vscroll_hor_area))
3034 synaction->in_vscroll += 2;
3036 /* Check for vertical scrolling. */
3037 if ((vscroll_ver_area > 0 &&
3038 synaction->start_x <=
3039 vscroll_ver_area) ||
3040 (vscroll_ver_area < 0 &&
3041 synaction->start_x >=
3042 6143 + vscroll_ver_area))
3043 synaction->in_vscroll += 1;
3046 /* Avoid conflicts if area overlaps. */
3047 if (synaction->in_vscroll >= 3)
3048 synaction->in_vscroll =
3049 (dxp > dyp) ? 2 : 1;
3053 * Reset two finger scrolling when the number of fingers
3054 * is different from two.
3056 if (two_finger_scroll && w != 0)
3057 synaction->in_vscroll = 0;
3060 "synaptics: virtual scrolling: %s "
3061 "(direction=%d, dxp=%d, dyp=%d, fingers=%d)\n",
3062 synaction->in_vscroll ? "YES" : "NO",
3063 synaction->in_vscroll, dxp, dyp,
3064 synaction->fingers_nb));
3066 weight_prev_x = weight_prev_y = weight_previous;
3067 div_max_x = div_max_y = div_max;
3069 if (synaction->in_vscroll) {
3070 /* Dividers are different with virtual scrolling. */
3071 div_min = sc->syninfo.vscroll_div_min;
3072 div_max_x = div_max_y = sc->syninfo.vscroll_div_max;
3075 * There's a lot of noise in coordinates when
3076 * the finger is on the touchpad's borders. When
3077 * using this area, we apply a special weight and
3080 if (x0 <= na_left || x0 >= 6143 - na_right) {
3081 weight_prev_x = sc->syninfo.weight_previous_na;
3082 div_max_x = sc->syninfo.div_max_na;
3085 if (y0 <= na_bottom || y0 >= 6143 - na_top) {
3086 weight_prev_y = sc->syninfo.weight_previous_na;
3087 div_max_y = sc->syninfo.div_max_na;
3092 * Calculate weights for the average operands and
3093 * the divisor. Both depend on the distance between
3094 * the current packet and a previous one (based on the
3097 window = imin(synaction->queue_len, window_max);
3098 peer = SYNAPTICS_QUEUE_CURSOR(cursor + window - 1);
3099 dxp = abs(x0 - synaction->queue[peer].x) + 1;
3100 dyp = abs(y0 - synaction->queue[peer].y) + 1;
3101 len = (dxp * dxp) + (dyp * dyp);
3102 weight_prev_x = imin(weight_prev_x,
3103 weight_len_squared * weight_prev_x / len);
3104 weight_prev_y = imin(weight_prev_y,
3105 weight_len_squared * weight_prev_y / len);
3107 len = (dxp + dyp) / 2;
3108 div_x = div_len * div_max_x / len;
3109 div_x = imin(div_max_x, div_x);
3110 div_x = imax(div_min, div_x);
3111 div_y = div_len * div_max_y / len;
3112 div_y = imin(div_max_y, div_y);
3113 div_y = imax(div_min, div_y);
3116 "synaptics: peer=%d, len=%d, weight=%d/%d, div=%d/%d\n",
3117 peer, len, weight_prev_x, weight_prev_y, div_x, div_y));
3119 /* Compute averages. */
3121 (weight_current * dx * multiplicator +
3122 weight_prev_x * synaction->avg_dx) /
3123 (weight_current + weight_prev_x);
3126 (weight_current * dy * multiplicator +
3127 weight_prev_y * synaction->avg_dy) /
3128 (weight_current + weight_prev_y);
3131 "synaptics: avg_dx~=%d, avg_dy~=%d\n",
3132 synaction->avg_dx / multiplicator,
3133 synaction->avg_dy / multiplicator));
3135 /* Use these averages to calculate x & y. */
3136 synaction->squelch_x += synaction->avg_dx;
3137 *x = synaction->squelch_x / (div_x * multiplicator);
3138 synaction->squelch_x = synaction->squelch_x %
3139 (div_x * multiplicator);
3141 synaction->squelch_y += synaction->avg_dy;
3142 *y = synaction->squelch_y / (div_y * multiplicator);
3143 synaction->squelch_y = synaction->squelch_y %
3144 (div_y * multiplicator);
3146 if (synaction->in_vscroll) {
3147 switch(synaction->in_vscroll) {
3148 case 1: /* Vertical scrolling. */
3150 ms->button |= (*y > 0) ?
3154 case 2: /* Horizontal scrolling. */
3156 ms->button |= (*x > 0) ?
3162 /* The pointer is not moved. */
3165 VLOG(3, (LOG_DEBUG, "synaptics: [%d, %d] -> [%d, %d]\n",
3168 } else if (sc->flags & PSM_FLAGS_FINGERDOWN) {
3170 * An action is currently taking place but the pressure
3171 * dropped under the minimum, putting an end to it.
3173 synapticsaction_t *synaction;
3174 int taphold_timeout, dx, dy, tap_max_delta;
3176 synaction = &(sc->synaction);
3177 dx = abs(synaction->queue[synaction->queue_cursor].x -
3178 synaction->start_x);
3179 dy = abs(synaction->queue[synaction->queue_cursor].y -
3180 synaction->start_y);
3182 /* Max delta is disabled for multi-fingers tap. */
3183 if (synaction->fingers_nb > 1)
3184 tap_max_delta = imax(dx, dy);
3186 tap_max_delta = sc->syninfo.tap_max_delta;
3188 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
3190 /* Check for tap. */
3192 "synaptics: zmax=%d, dx=%d, dy=%d, "
3193 "delta=%d, fingers=%d, queue=%d\n",
3194 sc->zmax, dx, dy, tap_max_delta, synaction->fingers_nb,
3195 synaction->queue_len));
3196 if (!synaction->in_vscroll && sc->zmax >= tap_threshold &&
3197 timevalcmp(&sc->lastsoftintr, &sc->taptimeout, <=) &&
3198 dx <= tap_max_delta && dy <= tap_max_delta &&
3199 synaction->queue_len >= sc->syninfo.tap_min_queue) {
3202 * - the maximum pressure went over tap_threshold
3203 * - the action ended before tap_timeout
3205 * To handle tap-hold, we must delay any button push to
3208 if (synaction->in_taphold) {
3210 * This is the second and last tap of a
3211 * double tap action, not a tap-hold.
3213 synaction->in_taphold = 0;
3216 * For double-tap to work:
3217 * - no button press is emitted (to
3218 * simulate a button release)
3219 * - PSM_FLAGS_FINGERDOWN is set to
3220 * force the next packet to emit a
3224 "synaptics: button RELEASE: %d\n",
3225 synaction->tap_button));
3226 sc->flags |= PSM_FLAGS_FINGERDOWN;
3229 * This is the first tap: we set the
3230 * tap-hold state and notify the button
3233 synaction->in_taphold = 1;
3234 taphold_timeout = sc->syninfo.taphold_timeout;
3235 sc->taptimeout.tv_sec = taphold_timeout /
3237 sc->taptimeout.tv_usec = taphold_timeout %
3239 timevaladd(&sc->taptimeout, &sc->lastsoftintr);
3241 switch (synaction->fingers_nb) {
3243 synaction->tap_button =
3247 synaction->tap_button =
3251 synaction->tap_button =
3255 "synaptics: button PRESS: %d\n",
3256 synaction->tap_button));
3257 ms->button |= synaction->tap_button;
3261 * Not enough pressure or timeout: reset
3264 if (synaction->in_taphold) {
3266 "synaptics: button RELEASE: %d\n",
3267 synaction->tap_button));
3268 synaction->in_taphold = 0;
3271 "synaptics: not a tap-hold\n"));
3274 } else if (!(sc->flags & PSM_FLAGS_FINGERDOWN) &&
3275 sc->synaction.in_taphold) {
3277 * For a tap-hold to work, the button must remain down at
3278 * least until timeout (where the in_taphold flags will be
3279 * cleared) or during the next action.
3281 if (timevalcmp(&sc->lastsoftintr, &sc->taptimeout, <=)) {
3282 ms->button |= sc->synaction.tap_button;
3285 "synaptics: button RELEASE: %d\n",
3286 sc->synaction.tap_button));
3287 sc->synaction.in_taphold = 0;
3293 * Use the extra buttons as a scrollwheel
3295 * XXX X.Org uses the Z axis for vertical wheel only,
3296 * whereas moused(8) understands special values to differ
3297 * vertical and horizontal wheels.
3299 * xf86-input-mouse needs therefore a small patch to
3300 * understand these special values. Without it, the
3301 * horizontal wheel acts as a vertical wheel in X.Org.
3303 * That's why the horizontal wheel is disabled by
3307 if (ms->button & MOUSE_BUTTON4DOWN) {
3309 ms->button &= ~MOUSE_BUTTON4DOWN;
3310 } else if (ms->button & MOUSE_BUTTON5DOWN) {
3312 ms->button &= ~MOUSE_BUTTON5DOWN;
3313 } else if (ms->button & MOUSE_BUTTON6DOWN) {
3315 ms->button &= ~MOUSE_BUTTON6DOWN;
3316 } else if (ms->button & MOUSE_BUTTON7DOWN) {
3318 ms->button &= ~MOUSE_BUTTON7DOWN;
3326 proc_versapad(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
3327 int *x, int *y, int *z)
3329 static int butmap_versapad[8] = {
3335 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
3337 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN
3341 /* VersaPad PS/2 absolute mode message format
3343 * [packet1] 7 6 5 4 3 2 1 0(LSB)
3344 * ipacket[0]: 1 1 0 A 1 L T R
3345 * ipacket[1]: H7 H6 H5 H4 H3 H2 H1 H0
3346 * ipacket[2]: V7 V6 V5 V4 V3 V2 V1 V0
3347 * ipacket[3]: 1 1 1 A 1 L T R
3348 * ipacket[4]:V11 V10 V9 V8 H11 H10 H9 H8
3349 * ipacket[5]: 0 P6 P5 P4 P3 P2 P1 P0
3352 * R: right physical mouse button (1=on)
3353 * T: touch pad virtual button (1=tapping)
3354 * L: left physical mouse button (1=on)
3355 * A: position data is valid (1=valid)
3356 * H: horizontal data (12bit signed integer. H11 is sign bit.)
3357 * V: vertical data (12bit signed integer. V11 is sign bit.)
3360 * Tapping is mapped to MOUSE_BUTTON4.
3364 ms->button = butmap_versapad[c & MOUSE_PS2VERSA_BUTTONS];
3365 ms->button |= (c & MOUSE_PS2VERSA_TAP) ? MOUSE_BUTTON4DOWN : 0;
3366 if (c & MOUSE_PS2VERSA_IN_USE) {
3367 x0 = pb->ipacket[1] | (((pb->ipacket[4]) & 0x0f) << 8);
3368 y0 = pb->ipacket[2] | (((pb->ipacket[4]) & 0xf0) << 4);
3373 if (sc->flags & PSM_FLAGS_FINGERDOWN) {
3376 if (*x < 0) /* XXX */
3385 sc->flags |= PSM_FLAGS_FINGERDOWN;
3389 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
3393 psmsoftintr(void *arg)
3396 * the table to turn PS/2 mouse button bits (MOUSE_PS2_BUTTON?DOWN)
3397 * into `mousestatus' button bits (MOUSE_BUTTON?DOWN).
3399 static int butmap[8] = {
3403 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
3405 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN,
3406 MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN,
3407 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN
3409 struct psm_softc *sc = arg;
3412 int x, y, z, c, l, s;
3414 getmicrouptime(&sc->lastsoftintr);
3419 pb = &sc->pqueue[sc->pqueue_start];
3421 if (sc->mode.level == PSM_LEVEL_NATIVE)
3426 * A kludge for Kensington device!
3427 * The MSB of the horizontal count appears to be stored in
3430 if (sc->hw.model == MOUSE_MODEL_THINK)
3431 pb->ipacket[1] |= (c & MOUSE_PS2_XOVERFLOW) ? 0x80 : 0;
3433 /* ignore the overflow bits... */
3434 x = (c & MOUSE_PS2_XNEG) ?
3435 pb->ipacket[1] - 256 : pb->ipacket[1];
3436 y = (c & MOUSE_PS2_YNEG) ?
3437 pb->ipacket[2] - 256 : pb->ipacket[2];
3439 ms.obutton = sc->button; /* previous button state */
3440 ms.button = butmap[c & MOUSE_PS2_BUTTONS];
3441 /* `tapping' action */
3442 if (sc->config & PSM_CONFIG_FORCETAP)
3443 ms.button |= ((c & MOUSE_PS2_TAP)) ?
3444 0 : MOUSE_BUTTON4DOWN;
3446 switch (sc->hw.model) {
3448 case MOUSE_MODEL_EXPLORER:
3450 * b7 b6 b5 b4 b3 b2 b1 b0
3451 * byte 1: oy ox sy sx 1 M R L
3452 * byte 2: x x x x x x x x
3453 * byte 3: y y y y y y y y
3454 * byte 4: * * S2 S1 s d2 d1 d0
3456 * L, M, R, S1, S2: left, middle, right and side buttons
3457 * s: wheel data sign bit
3460 z = (pb->ipacket[3] & MOUSE_EXPLORER_ZNEG) ?
3461 (pb->ipacket[3] & 0x0f) - 16 :
3462 (pb->ipacket[3] & 0x0f);
3464 (pb->ipacket[3] & MOUSE_EXPLORER_BUTTON4DOWN) ?
3465 MOUSE_BUTTON4DOWN : 0;
3467 (pb->ipacket[3] & MOUSE_EXPLORER_BUTTON5DOWN) ?
3468 MOUSE_BUTTON5DOWN : 0;
3471 case MOUSE_MODEL_INTELLI:
3472 case MOUSE_MODEL_NET:
3473 /* wheel data is in the fourth byte */
3474 z = (char)pb->ipacket[3];
3476 * XXX some mice may send 7 when there is no Z movement? */
3477 if ((z >= 7) || (z <= -7))
3479 /* some compatible mice have additional buttons */
3480 ms.button |= (c & MOUSE_PS2INTELLI_BUTTON4DOWN) ?
3481 MOUSE_BUTTON4DOWN : 0;
3482 ms.button |= (c & MOUSE_PS2INTELLI_BUTTON5DOWN) ?
3483 MOUSE_BUTTON5DOWN : 0;
3486 case MOUSE_MODEL_MOUSEMANPLUS:
3487 proc_mmanplus(sc, pb, &ms, &x, &y, &z);
3490 case MOUSE_MODEL_GLIDEPOINT:
3491 /* `tapping' action */
3492 ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 :
3496 case MOUSE_MODEL_NETSCROLL:
3498 * three addtional bytes encode buttons and
3501 ms.button |= (pb->ipacket[3] & MOUSE_PS2_BUTTON3DOWN) ?
3502 MOUSE_BUTTON4DOWN : 0;
3503 ms.button |= (pb->ipacket[3] & MOUSE_PS2_BUTTON1DOWN) ?
3504 MOUSE_BUTTON5DOWN : 0;
3505 z = (pb->ipacket[3] & MOUSE_PS2_XNEG) ?
3506 pb->ipacket[4] - 256 : pb->ipacket[4];
3509 case MOUSE_MODEL_THINK:
3510 /* the fourth button state in the first byte */
3511 ms.button |= (c & MOUSE_PS2_TAP) ?
3512 MOUSE_BUTTON4DOWN : 0;
3515 case MOUSE_MODEL_VERSAPAD:
3516 proc_versapad(sc, pb, &ms, &x, &y, &z);
3517 c = ((x < 0) ? MOUSE_PS2_XNEG : 0) |
3518 ((y < 0) ? MOUSE_PS2_YNEG : 0);
3521 case MOUSE_MODEL_4D:
3523 * b7 b6 b5 b4 b3 b2 b1 b0
3524 * byte 1: s2 d2 s1 d1 1 M R L
3525 * byte 2: sx x x x x x x x
3526 * byte 3: sy y y y y y y y
3528 * s1: wheel 1 direction
3530 * s2: wheel 2 direction
3533 x = (pb->ipacket[1] & 0x80) ?
3534 pb->ipacket[1] - 256 : pb->ipacket[1];
3535 y = (pb->ipacket[2] & 0x80) ?
3536 pb->ipacket[2] - 256 : pb->ipacket[2];
3537 switch (c & MOUSE_4D_WHEELBITS) {
3544 case 0x40: /* XXX 2nd wheel turning right */
3547 case 0xc0: /* XXX 2nd wheel turning left */
3553 case MOUSE_MODEL_4DPLUS:
3554 if ((x < 16 - 256) && (y < 16 - 256)) {
3556 * b7 b6 b5 b4 b3 b2 b1 b0
3557 * byte 1: 0 0 1 1 1 M R L
3558 * byte 2: 0 0 0 0 1 0 0 0
3559 * byte 3: 0 0 0 0 S s d1 d0
3561 * L, M, R, S: left, middle, right,
3563 * s: wheel data sign bit
3567 if (pb->ipacket[2] & MOUSE_4DPLUS_BUTTON4DOWN)
3568 ms.button |= MOUSE_BUTTON4DOWN;
3569 z = (pb->ipacket[2] & MOUSE_4DPLUS_ZNEG) ?
3570 ((pb->ipacket[2] & 0x07) - 8) :
3571 (pb->ipacket[2] & 0x07) ;
3573 /* preserve previous button states */
3574 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
3578 case MOUSE_MODEL_SYNAPTICS:
3579 if (proc_synaptics(sc, pb, &ms, &x, &y, &z) != 0)
3583 case MOUSE_MODEL_TRACKPOINT:
3584 case MOUSE_MODEL_GENERIC:
3590 if (sc->mode.accelfactor >= 1) {
3592 x = x * x / sc->mode.accelfactor;
3595 if (c & MOUSE_PS2_XNEG)
3599 y = y * y / sc->mode.accelfactor;
3602 if (c & MOUSE_PS2_YNEG)
3610 ms.flags = ((x || y || z) ? MOUSE_POSCHANGED : 0) |
3611 (ms.obutton ^ ms.button);
3613 pb->inputbytes = tame_mouse(sc, pb, &ms, pb->ipacket);
3615 sc->status.flags |= ms.flags;
3616 sc->status.dx += ms.dx;
3617 sc->status.dy += ms.dy;
3618 sc->status.dz += ms.dz;
3619 sc->status.button = ms.button;
3620 sc->button = ms.button;
3623 sc->watchdog = FALSE;
3626 if (sc->queue.count + pb->inputbytes < sizeof(sc->queue.buf)) {
3627 l = imin(pb->inputbytes,
3628 sizeof(sc->queue.buf) - sc->queue.tail);
3629 bcopy(&pb->ipacket[0], &sc->queue.buf[sc->queue.tail], l);
3630 if (pb->inputbytes > l)
3631 bcopy(&pb->ipacket[l], &sc->queue.buf[0],
3632 pb->inputbytes - l);
3633 sc->queue.tail = (sc->queue.tail + pb->inputbytes) %
3634 sizeof(sc->queue.buf);
3635 sc->queue.count += pb->inputbytes;
3640 if (++sc->pqueue_start >= PSM_PACKETQUEUE)
3641 sc->pqueue_start = 0;
3642 } while (sc->pqueue_start != sc->pqueue_end);
3644 if (sc->state & PSM_ASLP) {
3645 sc->state &= ~PSM_ASLP;
3648 selwakeuppri(&sc->rsel, PZERO);
3649 if (sc->async != NULL) {
3650 pgsigio(&sc->async, SIGIO, 0);
3652 sc->state &= ~PSM_SOFTARMED;
3657 psmpoll(struct cdev *dev, int events, struct thread *td)
3659 struct psm_softc *sc = dev->si_drv1;
3663 /* Return true if a mouse event available */
3665 if (events & (POLLIN | POLLRDNORM)) {
3666 if (sc->queue.count > 0)
3667 revents |= events & (POLLIN | POLLRDNORM);
3669 selrecord(td, &sc->rsel);
3676 /* vendor/model specific routines */
3678 static int mouse_id_proc1(KBDC kbdc, int res, int scale, int *status)
3680 if (set_mouse_resolution(kbdc, res) != res)
3682 if (set_mouse_scaling(kbdc, scale) &&
3683 set_mouse_scaling(kbdc, scale) &&
3684 set_mouse_scaling(kbdc, scale) &&
3685 (get_mouse_status(kbdc, status, 0, 3) >= 3))
3691 mouse_ext_command(KBDC kbdc, int command)
3695 c = (command >> 6) & 0x03;
3696 if (set_mouse_resolution(kbdc, c) != c)
3698 c = (command >> 4) & 0x03;
3699 if (set_mouse_resolution(kbdc, c) != c)
3701 c = (command >> 2) & 0x03;
3702 if (set_mouse_resolution(kbdc, c) != c)
3704 c = (command >> 0) & 0x03;
3705 if (set_mouse_resolution(kbdc, c) != c)
3711 /* Logitech MouseMan Cordless II */
3713 enable_lcordless(KDBC kbdc, struct psm_softc *sc)
3718 if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 2, status))
3720 if (status[1] == PSMD_RES_HIGH)
3722 ch = (status[0] & 0x07) - 1; /* channel # */
3723 if ((ch <= 0) || (ch > 4))
3726 * status[1]: always one?
3727 * status[2]: battery status? (0-100)
3733 /* Genius NetScroll Mouse, MouseSystems SmartScroll Mouse */
3735 enable_groller(KBDC kbdc, struct psm_softc *sc)
3740 * The special sequence to enable the fourth button and the
3741 * roller. Immediately after this sequence check status bytes.
3742 * if the mouse is NetScroll, the second and the third bytes are
3747 * If the mouse is an ordinary PS/2 mouse, the status bytes should
3748 * look like the following.
3750 * byte 1 bit 7 always 0
3751 * bit 6 stream mode (0)
3752 * bit 5 disabled (0)
3753 * bit 4 1:1 scaling (0)
3755 * bit 0-2 button status
3756 * byte 2 resolution (PSMD_RES_HIGH)
3757 * byte 3 report rate (?)
3760 if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 1, status))
3762 if ((status[1] != '3') || (status[2] != 'D'))
3764 /* FIXME: SmartScroll Mouse has 5 buttons! XXX */
3770 /* Genius NetMouse/NetMouse Pro, ASCII Mie Mouse, NetScroll Optical */
3772 enable_gmouse(KBDC kbdc, struct psm_softc *sc)
3777 * The special sequence to enable the middle, "rubber" button.
3778 * Immediately after this sequence check status bytes.
3779 * if the mouse is NetMouse, NetMouse Pro, or ASCII MIE Mouse,
3780 * the second and the third bytes are '3' and 'U'.
3781 * NOTE: NetMouse reports that it has three buttons although it has
3782 * two buttons and a rubber button. NetMouse Pro and MIE Mouse
3783 * say they have three buttons too and they do have a button on the
3786 if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 1, status))
3788 if ((status[1] != '3') || (status[2] != 'U'))
3793 /* ALPS GlidePoint */
3795 enable_aglide(KBDC kbdc, struct psm_softc *sc)
3800 * The special sequence to obtain ALPS GlidePoint specific
3801 * information. Immediately after this sequence, status bytes will
3802 * contain something interesting.
3803 * NOTE: ALPS produces several models of GlidePoint. Some of those
3804 * do not respond to this sequence, thus, cannot be detected this way.
3806 if (set_mouse_sampling_rate(kbdc, 100) != 100)
3808 if (!mouse_id_proc1(kbdc, PSMD_RES_LOW, 2, status))
3810 if ((status[1] == PSMD_RES_LOW) || (status[2] == 100))
3815 /* Kensington ThinkingMouse/Trackball */
3817 enable_kmouse(KBDC kbdc, struct psm_softc *sc)
3819 static u_char rate[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20 };
3825 id1 = get_aux_id(kbdc);
3826 if (set_mouse_sampling_rate(kbdc, 10) != 10)
3829 * The device is now in the native mode? It returns a different
3832 id2 = get_aux_id(kbdc);
3833 if ((id1 == id2) || (id2 != 2))
3836 if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
3839 /* at this point, resolution is LOW, sampling rate is 10/sec */
3840 if (get_mouse_status(kbdc, status, 0, 3) < 3)
3845 * The special sequence to enable the third and fourth buttons.
3846 * Otherwise they behave like the first and second buttons.
3848 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i)
3849 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
3853 * At this point, the device is using default resolution and
3854 * sampling rate for the native mode.
3856 if (get_mouse_status(kbdc, status, 0, 3) < 3)
3858 if ((status[1] == PSMD_RES_LOW) || (status[2] == rate[i - 1]))
3861 /* the device appears be enabled by this sequence, diable it for now */
3862 disable_aux_dev(kbdc);
3863 empty_aux_buffer(kbdc, 5);
3868 /* Logitech MouseMan+/FirstMouse+, IBM ScrollPoint Mouse */
3870 enable_mmanplus(KBDC kbdc, struct psm_softc *sc)
3874 /* the special sequence to enable the fourth button and the roller. */
3876 * NOTE: for ScrollPoint to respond correctly, the SET_RESOLUTION
3877 * must be called exactly three times since the last RESET command
3878 * before this sequence. XXX
3880 if (!set_mouse_scaling(kbdc, 1))
3882 if (!mouse_ext_command(kbdc, 0x39) || !mouse_ext_command(kbdc, 0xdb))
3884 if (get_mouse_status(kbdc, data, 1, 3) < 3)
3888 * PS2++ protocol, packet type 0
3890 * b7 b6 b5 b4 b3 b2 b1 b0
3891 * byte 1: * 1 p3 p2 1 * * *
3892 * byte 2: 1 1 p1 p0 m1 m0 1 0
3893 * byte 3: m7 m6 m5 m4 m3 m2 m1 m0
3895 * p3-p0: packet type: 0
3896 * m7-m0: model ID: MouseMan+:0x50,
3898 * ScrollPoint:0x58...
3900 /* check constant bits */
3901 if ((data[0] & MOUSE_PS2PLUS_SYNCMASK) != MOUSE_PS2PLUS_SYNC)
3903 if ((data[1] & 0xc3) != 0xc2)
3905 /* check d3-d0 in byte 2 */
3906 if (!MOUSE_PS2PLUS_CHECKBITS(data))
3909 if (MOUSE_PS2PLUS_PACKET_TYPE(data) != 0)
3913 sc->hw.hwid &= 0x00ff;
3914 sc->hw.hwid |= data[2] << 8; /* save model ID */
3918 * MouseMan+ (or FirstMouse+) is now in its native mode, in which
3919 * the wheel and the fourth button events are encoded in the
3920 * special data packet. The mouse may be put in the IntelliMouse mode
3921 * if it is initialized by the IntelliMouse's method.
3926 /* MS IntelliMouse Explorer */
3928 enable_msexplorer(KBDC kbdc, struct psm_softc *sc)
3930 static u_char rate0[] = { 200, 100, 80, };
3931 static u_char rate1[] = { 200, 200, 80, };
3936 * This is needed for at least A4Tech X-7xx mice - they do not go
3937 * straight to Explorer mode, but need to be set to Intelli mode
3940 enable_msintelli(kbdc, sc);
3942 /* the special sequence to enable the extra buttons and the roller. */
3943 for (i = 0; i < sizeof(rate1)/sizeof(rate1[0]); ++i)
3944 if (set_mouse_sampling_rate(kbdc, rate1[i]) != rate1[i])
3946 /* the device will give the genuine ID only after the above sequence */
3947 id = get_aux_id(kbdc);
3948 if (id != PSM_EXPLORER_ID)
3952 sc->hw.buttons = 5; /* IntelliMouse Explorer XXX */
3957 * XXX: this is a kludge to fool some KVM switch products
3958 * which think they are clever enough to know the 4-byte IntelliMouse
3959 * protocol, and assume any other protocols use 3-byte packets.
3960 * They don't convey 4-byte data packets from the IntelliMouse Explorer
3961 * correctly to the host computer because of this!
3962 * The following sequence is actually IntelliMouse's "wake up"
3963 * sequence; it will make the KVM think the mouse is IntelliMouse
3964 * when it is in fact IntelliMouse Explorer.
3966 for (i = 0; i < sizeof(rate0)/sizeof(rate0[0]); ++i)
3967 if (set_mouse_sampling_rate(kbdc, rate0[i]) != rate0[i])
3974 /* MS IntelliMouse */
3976 enable_msintelli(KBDC kbdc, struct psm_softc *sc)
3979 * Logitech MouseMan+ and FirstMouse+ will also respond to this
3980 * probe routine and act like IntelliMouse.
3983 static u_char rate[] = { 200, 100, 80, };
3987 /* the special sequence to enable the third button and the roller. */
3988 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i)
3989 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
3991 /* the device will give the genuine ID only after the above sequence */
3992 id = get_aux_id(kbdc);
3993 if (id != PSM_INTELLI_ID)
4004 /* A4 Tech 4D Mouse */
4006 enable_4dmouse(KBDC kbdc, struct psm_softc *sc)
4009 * Newer wheel mice from A4 Tech may use the 4D+ protocol.
4012 static u_char rate[] = { 200, 100, 80, 60, 40, 20 };
4016 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i)
4017 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
4019 id = get_aux_id(kbdc);
4021 * WinEasy 4D, 4 Way Scroll 4D: 6
4022 * Cable-Free 4D: 8 (4DPLUS)
4023 * WinBest 4D+, 4 Way Scroll 4D+: 8 (4DPLUS)
4025 if (id != PSM_4DMOUSE_ID)
4029 sc->hw.buttons = 3; /* XXX some 4D mice have 4? */
4036 /* A4 Tech 4D+ Mouse */
4038 enable_4dplus(KBDC kbdc, struct psm_softc *sc)
4041 * Newer wheel mice from A4 Tech seem to use this protocol.
4042 * Older models are recognized as either 4D Mouse or IntelliMouse.
4047 * enable_4dmouse() already issued the following ID sequence...
4048 static u_char rate[] = { 200, 100, 80, 60, 40, 20 };
4051 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i)
4052 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
4056 id = get_aux_id(kbdc);
4060 case PSM_4DPLUS_RFSW35_ID:
4067 sc->hw.buttons = (id == PSM_4DPLUS_ID) ? 4 : 3;
4074 /* Synaptics Touchpad */
4076 synaptics_sysctl(SYSCTL_HANDLER_ARGS)
4080 /* Read the current value. */
4081 arg = *(int *)oidp->oid_arg1;
4082 error = sysctl_handle_int(oidp, &arg, 0, req);
4085 if (error || !req->newptr)
4089 * Check that the new value is in the concerned node's range
4092 switch (oidp->oid_arg2) {
4093 case SYNAPTICS_SYSCTL_MIN_PRESSURE:
4094 case SYNAPTICS_SYSCTL_MAX_PRESSURE:
4095 if (arg < 0 || arg > 255)
4098 case SYNAPTICS_SYSCTL_MAX_WIDTH:
4099 if (arg < 4 || arg > 15)
4102 case SYNAPTICS_SYSCTL_MARGIN_TOP:
4103 case SYNAPTICS_SYSCTL_MARGIN_RIGHT:
4104 case SYNAPTICS_SYSCTL_MARGIN_BOTTOM:
4105 case SYNAPTICS_SYSCTL_MARGIN_LEFT:
4106 case SYNAPTICS_SYSCTL_NA_TOP:
4107 case SYNAPTICS_SYSCTL_NA_RIGHT:
4108 case SYNAPTICS_SYSCTL_NA_BOTTOM:
4109 case SYNAPTICS_SYSCTL_NA_LEFT:
4110 if (arg < 0 || arg > 6143)
4113 case SYNAPTICS_SYSCTL_WINDOW_MIN:
4114 case SYNAPTICS_SYSCTL_WINDOW_MAX:
4115 case SYNAPTICS_SYSCTL_TAP_MIN_QUEUE:
4116 if (arg < 1 || arg > SYNAPTICS_PACKETQUEUE)
4119 case SYNAPTICS_SYSCTL_MULTIPLICATOR:
4120 case SYNAPTICS_SYSCTL_WEIGHT_CURRENT:
4121 case SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS:
4122 case SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS_NA:
4123 case SYNAPTICS_SYSCTL_WEIGHT_LEN_SQUARED:
4124 case SYNAPTICS_SYSCTL_DIV_MIN:
4125 case SYNAPTICS_SYSCTL_DIV_MAX:
4126 case SYNAPTICS_SYSCTL_DIV_MAX_NA:
4127 case SYNAPTICS_SYSCTL_DIV_LEN:
4128 case SYNAPTICS_SYSCTL_VSCROLL_DIV_MIN:
4129 case SYNAPTICS_SYSCTL_VSCROLL_DIV_MAX:
4133 case SYNAPTICS_SYSCTL_TAP_MAX_DELTA:
4134 case SYNAPTICS_SYSCTL_TAPHOLD_TIMEOUT:
4135 case SYNAPTICS_SYSCTL_VSCROLL_MIN_DELTA:
4139 case SYNAPTICS_SYSCTL_VSCROLL_HOR_AREA:
4140 case SYNAPTICS_SYSCTL_VSCROLL_VER_AREA:
4141 if (arg < -6143 || arg > 6143)
4144 case SYNAPTICS_SYSCTL_TOUCHPAD_OFF:
4145 if (arg < 0 || arg > 1)
4153 *(int *)oidp->oid_arg1 = arg;
4159 synaptics_sysctl_create_tree(struct psm_softc *sc)
4162 if (sc->syninfo.sysctl_tree != NULL)
4165 /* Attach extra synaptics sysctl nodes under hw.psm.synaptics */
4166 sysctl_ctx_init(&sc->syninfo.sysctl_ctx);
4167 sc->syninfo.sysctl_tree = SYSCTL_ADD_NODE(&sc->syninfo.sysctl_ctx,
4168 SYSCTL_STATIC_CHILDREN(_hw_psm), OID_AUTO, "synaptics", CTLFLAG_RD,
4169 0, "Synaptics TouchPad");
4171 /* hw.psm.synaptics.directional_scrolls. */
4172 sc->syninfo.directional_scrolls = 0;
4173 SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
4174 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4175 "directional_scrolls", CTLFLAG_RW|CTLFLAG_ANYBODY,
4176 &sc->syninfo.directional_scrolls, 0,
4177 "Enable hardware scrolling pad (if non-zero) or register it as "
4178 "extended buttons (if 0)");
4181 * Turn off two finger scroll if we have a
4182 * physical area reserved for scrolling or when
4183 * there's no multi finger support.
4185 if (sc->synhw.verticalScroll || sc->synhw.capMultiFinger == 0)
4186 sc->syninfo.two_finger_scroll = 0;
4188 sc->syninfo.two_finger_scroll = 1;
4189 /* hw.psm.synaptics.two_finger_scroll. */
4190 SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
4191 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4192 "two_finger_scroll", CTLFLAG_RW|CTLFLAG_ANYBODY,
4193 &sc->syninfo.two_finger_scroll, 0,
4194 "Enable two finger scrolling");
4196 /* hw.psm.synaptics.min_pressure. */
4197 sc->syninfo.min_pressure = 16;
4198 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4199 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4200 "min_pressure", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4201 &sc->syninfo.min_pressure, SYNAPTICS_SYSCTL_MIN_PRESSURE,
4202 synaptics_sysctl, "I",
4203 "Minimum pressure required to start an action");
4205 /* hw.psm.synaptics.max_pressure. */
4206 sc->syninfo.max_pressure = 220;
4207 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4208 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4209 "max_pressure", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4210 &sc->syninfo.max_pressure, SYNAPTICS_SYSCTL_MAX_PRESSURE,
4211 synaptics_sysctl, "I",
4212 "Maximum pressure to detect palm");
4214 /* hw.psm.synaptics.max_width. */
4215 sc->syninfo.max_width = 10;
4216 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4217 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4218 "max_width", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4219 &sc->syninfo.max_width, SYNAPTICS_SYSCTL_MAX_WIDTH,
4220 synaptics_sysctl, "I",
4221 "Maximum finger width to detect palm");
4223 /* hw.psm.synaptics.top_margin. */
4224 sc->syninfo.margin_top = 200;
4225 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4226 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4227 "margin_top", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4228 &sc->syninfo.margin_top, SYNAPTICS_SYSCTL_MARGIN_TOP,
4229 synaptics_sysctl, "I",
4232 /* hw.psm.synaptics.right_margin. */
4233 sc->syninfo.margin_right = 200;
4234 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4235 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4236 "margin_right", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4237 &sc->syninfo.margin_right, SYNAPTICS_SYSCTL_MARGIN_RIGHT,
4238 synaptics_sysctl, "I",
4241 /* hw.psm.synaptics.bottom_margin. */
4242 sc->syninfo.margin_bottom = 200;
4243 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4244 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4245 "margin_bottom", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4246 &sc->syninfo.margin_bottom, SYNAPTICS_SYSCTL_MARGIN_BOTTOM,
4247 synaptics_sysctl, "I",
4250 /* hw.psm.synaptics.left_margin. */
4251 sc->syninfo.margin_left = 200;
4252 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4253 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4254 "margin_left", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4255 &sc->syninfo.margin_left, SYNAPTICS_SYSCTL_MARGIN_LEFT,
4256 synaptics_sysctl, "I",
4259 /* hw.psm.synaptics.na_top. */
4260 sc->syninfo.na_top = 1783;
4261 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4262 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4263 "na_top", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4264 &sc->syninfo.na_top, SYNAPTICS_SYSCTL_NA_TOP,
4265 synaptics_sysctl, "I",
4266 "Top noisy area, where weight_previous_na is used instead "
4267 "of weight_previous");
4269 /* hw.psm.synaptics.na_right. */
4270 sc->syninfo.na_right = 563;
4271 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4272 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4273 "na_right", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4274 &sc->syninfo.na_right, SYNAPTICS_SYSCTL_NA_RIGHT,
4275 synaptics_sysctl, "I",
4276 "Right noisy area, where weight_previous_na is used instead "
4277 "of weight_previous");
4279 /* hw.psm.synaptics.na_bottom. */
4280 sc->syninfo.na_bottom = 1408;
4281 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4282 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4283 "na_bottom", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4284 &sc->syninfo.na_bottom, SYNAPTICS_SYSCTL_NA_BOTTOM,
4285 synaptics_sysctl, "I",
4286 "Bottom noisy area, where weight_previous_na is used instead "
4287 "of weight_previous");
4289 /* hw.psm.synaptics.na_left. */
4290 sc->syninfo.na_left = 1600;
4291 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4292 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4293 "na_left", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4294 &sc->syninfo.na_left, SYNAPTICS_SYSCTL_NA_LEFT,
4295 synaptics_sysctl, "I",
4296 "Left noisy area, where weight_previous_na is used instead "
4297 "of weight_previous");
4299 /* hw.psm.synaptics.window_min. */
4300 sc->syninfo.window_min = 4;
4301 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4302 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4303 "window_min", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4304 &sc->syninfo.window_min, SYNAPTICS_SYSCTL_WINDOW_MIN,
4305 synaptics_sysctl, "I",
4306 "Minimum window size to start an action");
4308 /* hw.psm.synaptics.window_max. */
4309 sc->syninfo.window_max = 10;
4310 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4311 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4312 "window_max", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4313 &sc->syninfo.window_max, SYNAPTICS_SYSCTL_WINDOW_MAX,
4314 synaptics_sysctl, "I",
4315 "Maximum window size");
4317 /* hw.psm.synaptics.multiplicator. */
4318 sc->syninfo.multiplicator = 10000;
4319 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4320 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4321 "multiplicator", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4322 &sc->syninfo.multiplicator, SYNAPTICS_SYSCTL_MULTIPLICATOR,
4323 synaptics_sysctl, "I",
4324 "Multiplicator to increase precision in averages and divisions");
4326 /* hw.psm.synaptics.weight_current. */
4327 sc->syninfo.weight_current = 3;
4328 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4329 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4330 "weight_current", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4331 &sc->syninfo.weight_current, SYNAPTICS_SYSCTL_WEIGHT_CURRENT,
4332 synaptics_sysctl, "I",
4333 "Weight of the current movement in the new average");
4335 /* hw.psm.synaptics.weight_previous. */
4336 sc->syninfo.weight_previous = 6;
4337 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4338 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4339 "weight_previous", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4340 &sc->syninfo.weight_previous, SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS,
4341 synaptics_sysctl, "I",
4342 "Weight of the previous average");
4344 /* hw.psm.synaptics.weight_previous_na. */
4345 sc->syninfo.weight_previous_na = 20;
4346 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4347 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4348 "weight_previous_na", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4349 &sc->syninfo.weight_previous_na,
4350 SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS_NA,
4351 synaptics_sysctl, "I",
4352 "Weight of the previous average (inside the noisy area)");
4354 /* hw.psm.synaptics.weight_len_squared. */
4355 sc->syninfo.weight_len_squared = 2000;
4356 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4357 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4358 "weight_len_squared", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4359 &sc->syninfo.weight_len_squared,
4360 SYNAPTICS_SYSCTL_WEIGHT_LEN_SQUARED,
4361 synaptics_sysctl, "I",
4362 "Length (squared) of segments where weight_previous "
4363 "starts to decrease");
4365 /* hw.psm.synaptics.div_min. */
4366 sc->syninfo.div_min = 9;
4367 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4368 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4369 "div_min", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4370 &sc->syninfo.div_min, SYNAPTICS_SYSCTL_DIV_MIN,
4371 synaptics_sysctl, "I",
4372 "Divisor for fast movements");
4374 /* hw.psm.synaptics.div_max. */
4375 sc->syninfo.div_max = 17;
4376 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4377 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4378 "div_max", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4379 &sc->syninfo.div_max, SYNAPTICS_SYSCTL_DIV_MAX,
4380 synaptics_sysctl, "I",
4381 "Divisor for slow movements");
4383 /* hw.psm.synaptics.div_max_na. */
4384 sc->syninfo.div_max_na = 30;
4385 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4386 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4387 "div_max_na", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4388 &sc->syninfo.div_max_na, SYNAPTICS_SYSCTL_DIV_MAX_NA,
4389 synaptics_sysctl, "I",
4390 "Divisor with slow movements (inside the noisy area)");
4392 /* hw.psm.synaptics.div_len. */
4393 sc->syninfo.div_len = 100;
4394 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4395 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4396 "div_len", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4397 &sc->syninfo.div_len, SYNAPTICS_SYSCTL_DIV_LEN,
4398 synaptics_sysctl, "I",
4399 "Length of segments where div_max starts to decrease");
4401 /* hw.psm.synaptics.tap_max_delta. */
4402 sc->syninfo.tap_max_delta = 80;
4403 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4404 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4405 "tap_max_delta", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4406 &sc->syninfo.tap_max_delta, SYNAPTICS_SYSCTL_TAP_MAX_DELTA,
4407 synaptics_sysctl, "I",
4408 "Length of segments above which a tap is ignored");
4410 /* hw.psm.synaptics.tap_min_queue. */
4411 sc->syninfo.tap_min_queue = 2;
4412 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4413 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4414 "tap_min_queue", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4415 &sc->syninfo.tap_min_queue, SYNAPTICS_SYSCTL_TAP_MIN_QUEUE,
4416 synaptics_sysctl, "I",
4417 "Number of packets required to consider a tap");
4419 /* hw.psm.synaptics.taphold_timeout. */
4420 sc->synaction.in_taphold = 0;
4421 sc->syninfo.taphold_timeout = tap_timeout;
4422 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4423 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4424 "taphold_timeout", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4425 &sc->syninfo.taphold_timeout, SYNAPTICS_SYSCTL_TAPHOLD_TIMEOUT,
4426 synaptics_sysctl, "I",
4427 "Maximum elapsed time between two taps to consider a tap-hold "
4430 /* hw.psm.synaptics.vscroll_hor_area. */
4431 sc->syninfo.vscroll_hor_area = 0; /* 1300 */
4432 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4433 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4434 "vscroll_hor_area", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4435 &sc->syninfo.vscroll_hor_area, SYNAPTICS_SYSCTL_VSCROLL_HOR_AREA,
4436 synaptics_sysctl, "I",
4437 "Area reserved for horizontal virtual scrolling");
4439 /* hw.psm.synaptics.vscroll_ver_area. */
4440 sc->syninfo.vscroll_ver_area = -600;
4441 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4442 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4443 "vscroll_ver_area", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4444 &sc->syninfo.vscroll_ver_area, SYNAPTICS_SYSCTL_VSCROLL_VER_AREA,
4445 synaptics_sysctl, "I",
4446 "Area reserved for vertical virtual scrolling");
4448 /* hw.psm.synaptics.vscroll_min_delta. */
4449 sc->syninfo.vscroll_min_delta = 50;
4450 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4451 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4452 "vscroll_min_delta", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4453 &sc->syninfo.vscroll_min_delta,
4454 SYNAPTICS_SYSCTL_VSCROLL_MIN_DELTA,
4455 synaptics_sysctl, "I",
4456 "Minimum movement to consider virtual scrolling");
4458 /* hw.psm.synaptics.vscroll_div_min. */
4459 sc->syninfo.vscroll_div_min = 100;
4460 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4461 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4462 "vscroll_div_min", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4463 &sc->syninfo.vscroll_div_min, SYNAPTICS_SYSCTL_VSCROLL_DIV_MIN,
4464 synaptics_sysctl, "I",
4465 "Divisor for fast scrolling");
4467 /* hw.psm.synaptics.vscroll_div_min. */
4468 sc->syninfo.vscroll_div_max = 150;
4469 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4470 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4471 "vscroll_div_max", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4472 &sc->syninfo.vscroll_div_max, SYNAPTICS_SYSCTL_VSCROLL_DIV_MAX,
4473 synaptics_sysctl, "I",
4474 "Divisor for slow scrolling");
4476 /* hw.psm.synaptics.touchpad_off. */
4477 sc->syninfo.touchpad_off = 0;
4478 SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
4479 SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
4480 "touchpad_off", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4481 &sc->syninfo.touchpad_off, SYNAPTICS_SYSCTL_TOUCHPAD_OFF,
4482 synaptics_sysctl, "I",
4483 "Turn off touchpad");
4487 enable_synaptics(KBDC kbdc, struct psm_softc *sc)
4489 synapticshw_t synhw;
4493 VLOG(3, (LOG_DEBUG, "synaptics: BEGIN init\n"));
4496 * Just to be on the safe side: this avoids troubles with
4497 * following mouse_ext_command() when the previous command
4498 * was PSMC_SET_RESOLUTION. Set Scaling has no effect on
4499 * Synaptics Touchpad behaviour.
4501 set_mouse_scaling(kbdc, 1);
4503 /* Identify the Touchpad version. */
4504 if (mouse_ext_command(kbdc, 0) == 0)
4506 if (get_mouse_status(kbdc, status, 0, 3) != 3)
4508 if (status[1] != 0x47)
4511 bzero(&synhw, sizeof(synhw));
4512 synhw.infoMinor = status[0];
4513 synhw.infoMajor = status[2] & 0x0f;
4516 printf("Synaptics Touchpad v%d.%d\n", synhw.infoMajor,
4519 if (synhw.infoMajor < 4) {
4520 printf(" Unsupported (pre-v4) Touchpad detected\n");
4524 /* Get the Touchpad model information. */
4525 if (mouse_ext_command(kbdc, 3) == 0)
4527 if (get_mouse_status(kbdc, status, 0, 3) != 3)
4529 if ((status[1] & 0x01) != 0) {
4530 printf(" Failed to read model information\n");
4534 synhw.infoRot180 = (status[0] & 0x80) != 0;
4535 synhw.infoPortrait = (status[0] & 0x40) != 0;
4536 synhw.infoSensor = status[0] & 0x3f;
4537 synhw.infoHardware = (status[1] & 0xfe) >> 1;
4538 synhw.infoNewAbs = (status[2] & 0x80) != 0;
4539 synhw.capPen = (status[2] & 0x40) != 0;
4540 synhw.infoSimplC = (status[2] & 0x20) != 0;
4541 synhw.infoGeometry = status[2] & 0x0f;
4544 printf(" Model information:\n");
4545 printf(" infoRot180: %d\n", synhw.infoRot180);
4546 printf(" infoPortrait: %d\n", synhw.infoPortrait);
4547 printf(" infoSensor: %d\n", synhw.infoSensor);
4548 printf(" infoHardware: %d\n", synhw.infoHardware);
4549 printf(" infoNewAbs: %d\n", synhw.infoNewAbs);
4550 printf(" capPen: %d\n", synhw.capPen);
4551 printf(" infoSimplC: %d\n", synhw.infoSimplC);
4552 printf(" infoGeometry: %d\n", synhw.infoGeometry);
4555 /* Read the extended capability bits. */
4556 if (mouse_ext_command(kbdc, 2) == 0)
4558 if (get_mouse_status(kbdc, status, 0, 3) != 3)
4560 if (!SYNAPTICS_VERSION_GE(synhw, 7, 5) && status[1] != 0x47) {
4561 printf(" Failed to read extended capability bits\n");
4565 /* Set the different capabilities when they exist. */
4567 synhw.capExtended = (status[0] & 0x80) != 0;
4568 if (synhw.capExtended) {
4569 synhw.nExtendedQueries = (status[0] & 0x70) != 0;
4570 synhw.capMiddle = (status[0] & 0x04) != 0;
4571 synhw.capPassthrough = (status[2] & 0x80) != 0;
4572 synhw.capSleep = (status[2] & 0x10) != 0;
4573 synhw.capFourButtons = (status[2] & 0x08) != 0;
4574 synhw.capMultiFinger = (status[2] & 0x02) != 0;
4575 synhw.capPalmDetect = (status[2] & 0x01) != 0;
4578 printf(" Extended capabilities:\n");
4579 printf(" capExtended: %d\n", synhw.capExtended);
4580 printf(" capMiddle: %d\n", synhw.capMiddle);
4581 printf(" nExtendedQueries: %d\n",
4582 synhw.nExtendedQueries);
4583 printf(" capPassthrough: %d\n", synhw.capPassthrough);
4584 printf(" capSleep: %d\n", synhw.capSleep);
4585 printf(" capFourButtons: %d\n", synhw.capFourButtons);
4586 printf(" capMultiFinger: %d\n", synhw.capMultiFinger);
4587 printf(" capPalmDetect: %d\n", synhw.capPalmDetect);
4591 * If nExtendedQueries is 1 or greater, then the TouchPad
4592 * supports this number of extended queries. We can load
4593 * more information about buttons using query 0x09.
4595 if (synhw.capExtended && synhw.nExtendedQueries) {
4596 if (mouse_ext_command(kbdc, 0x09) == 0)
4598 if (get_mouse_status(kbdc, status, 0, 3) != 3)
4600 synhw.verticalScroll = (status[0] & 0x01) != 0;
4601 synhw.horizontalScroll = (status[0] & 0x02) != 0;
4602 synhw.verticalWheel = (status[0] & 0x08) != 0;
4603 synhw.nExtendedButtons = (status[1] & 0xf0) >> 4;
4605 printf(" Extended model ID:\n");
4606 printf(" verticalScroll: %d\n",
4607 synhw.verticalScroll);
4608 printf(" horizontalScroll: %d\n",
4609 synhw.horizontalScroll);
4610 printf(" verticalWheel: %d\n",
4611 synhw.verticalWheel);
4612 printf(" nExtendedButtons: %d\n",
4613 synhw.nExtendedButtons);
4616 * Add the number of extended buttons to the total
4617 * button support count, including the middle button
4618 * if capMiddle support bit is set.
4620 buttons = synhw.nExtendedButtons + synhw.capMiddle;
4623 * If the capFourButtons support bit is set,
4624 * add a fourth button to the total button count.
4626 buttons = synhw.capFourButtons ? 1 : 0;
4629 if (synhw.capExtended)
4630 printf(" Additional Buttons: %d\n", buttons);
4632 printf(" No extended capabilities\n");
4635 /* Read the continued capabilities bits. */
4636 if (mouse_ext_command(kbdc, 0xc) != 0 &&
4637 get_mouse_status(kbdc, status, 0, 3) == 3) {
4638 synhw.capClickPad = (status[1] & 0x01) << 1;
4639 synhw.capClickPad |= (status[0] & 0x10) != 0;
4640 synhw.capDeluxeLEDs = (status[1] & 0x02) != 0;
4641 synhw.noAbsoluteFilter = (status[1] & 0x04) != 0;
4642 synhw.capReportsV = (status[1] & 0x08) != 0;
4643 synhw.capUniformClickPad = (status[1] & 0x10) != 0;
4644 synhw.capReportsMin = (status[1] & 0x20) != 0;
4645 synhw.capInterTouch = (status[1] & 0x40) != 0;
4646 synhw.capReportsMax = (status[2] & 0x02) != 0;
4647 synhw.capClearPad = (status[2] & 0x04) != 0;
4648 synhw.capAdvancedGestures = (status[2] & 0x08) != 0;
4649 synhw.capCoveredPad = (status[2] & 0x80) != 0;
4652 printf(" Continued capabilities:\n");
4653 printf(" capClickPad: %d\n", synhw.capClickPad);
4654 printf(" capDeluxeLEDs: %d\n", synhw.capDeluxeLEDs);
4655 printf(" noAbsoluteFilter: %d\n",
4656 synhw.noAbsoluteFilter);
4657 printf(" capReportsV: %d\n", synhw.capReportsV);
4658 printf(" capUniformClickPad: %d\n",
4659 synhw.capUniformClickPad);
4660 printf(" capReportsMin: %d\n", synhw.capReportsMin);
4661 printf(" capInterTouch: %d\n", synhw.capInterTouch);
4662 printf(" capReportsMax: %d\n", synhw.capReportsMax);
4663 printf(" capClearPad: %d\n", synhw.capClearPad);
4664 printf(" capAdvancedGestures: %d\n",
4665 synhw.capAdvancedGestures);
4666 printf(" capCoveredPad: %d\n", synhw.capCoveredPad);
4668 buttons += synhw.capClickPad;
4672 * Add the default number of 3 buttons to the total
4673 * count of supported buttons reported above.
4678 * Read the mode byte.
4680 * XXX: Note the Synaptics documentation also defines the first
4681 * byte of the response to this query to be a constant 0x3b, this
4682 * does not appear to be true for Touchpads with guest devices.
4684 if (mouse_ext_command(kbdc, 1) == 0)
4686 if (get_mouse_status(kbdc, status, 0, 3) != 3)
4688 if (!SYNAPTICS_VERSION_GE(synhw, 7, 5) && status[1] != 0x47) {
4689 printf(" Failed to read mode byte\n");
4695 if (!synaptics_support)
4698 /* Set the mode byte; request wmode where available. */
4699 mouse_ext_command(kbdc, synhw.capExtended ? 0xc1 : 0xc0);
4701 /* "Commit" the Set Mode Byte command sent above. */
4702 set_mouse_sampling_rate(kbdc, 20);
4704 VLOG(3, (LOG_DEBUG, "synaptics: END init (%d buttons)\n", buttons));
4707 if (trackpoint_support && synhw.capPassthrough) {
4708 synaptics_passthrough_on(sc);
4709 enable_trackpoint(kbdc, sc);
4710 synaptics_passthrough_off(sc);
4712 /* Create sysctl tree. */
4713 synaptics_sysctl_create_tree(sc);
4714 sc->hw.buttons = buttons;
4721 synaptics_passthrough_on(struct psm_softc *sc)
4725 mode_byte = 0xc1 | (1 << 5);
4726 VLOG(2, (LOG_NOTICE, "psm: setting pass-through mode. %d\n",
4728 mouse_ext_command(sc->kbdc, mode_byte);
4730 /* "Commit" the Set Mode Byte command sent above. */
4731 set_mouse_sampling_rate(sc->kbdc, 20);
4735 synaptics_passthrough_off(struct psm_softc *sc)
4740 VLOG(2, (LOG_NOTICE, "psm: turning pass-through mode off.\n"));
4741 set_mouse_scaling(sc->kbdc, 2);
4742 set_mouse_scaling(sc->kbdc, 1);
4743 mouse_ext_command(sc->kbdc, mode_byte);
4745 /* "Commit" the Set Mode Byte command sent above. */
4746 set_mouse_sampling_rate(sc->kbdc, 20);
4749 /* IBM/Lenovo TrackPoint */
4751 trackpoint_command(struct psm_softc *sc, int cmd, int loc, int val)
4753 const int seq[] = { 0xe2, cmd, loc, val };
4756 if (sc->synhw.capPassthrough)
4757 synaptics_passthrough_on(sc);
4759 for (i = 0; i < nitems(seq); i++) {
4760 if (sc->synhw.capPassthrough &&
4761 (seq[i] == 0xff || seq[i] == 0xe7))
4762 if (send_aux_command(sc->kbdc, 0xe7) != PSM_ACK) {
4763 synaptics_passthrough_off(sc);
4766 if (send_aux_command(sc->kbdc, seq[i]) != PSM_ACK) {
4767 if (sc->synhw.capPassthrough)
4768 synaptics_passthrough_off(sc);
4773 if (sc->synhw.capPassthrough)
4774 synaptics_passthrough_off(sc);
4779 #define PSM_TPINFO(x) offsetof(struct psm_softc, tpinfo.x)
4785 trackpoint_sysctl(SYSCTL_HANDLER_ARGS)
4787 static const int data[][3] = {
4788 { 0x00, 0x4a, PSM_TPINFO(sensitivity) },
4789 { 0x00, 0x4d, PSM_TPINFO(inertia) },
4790 { 0x00, 0x60, PSM_TPINFO(uplateau) },
4791 { 0x00, 0x57, PSM_TPINFO(reach) },
4792 { 0x00, 0x58, PSM_TPINFO(draghys) },
4793 { 0x00, 0x59, PSM_TPINFO(mindrag) },
4794 { 0x00, 0x5a, PSM_TPINFO(upthresh) },
4795 { 0x00, 0x5c, PSM_TPINFO(threshold) },
4796 { 0x00, 0x5d, PSM_TPINFO(jenks) },
4797 { 0x00, 0x5e, PSM_TPINFO(ztime) },
4798 { 0x01, 0x2c, PSM_TPINFO(pts) },
4799 { 0x08, 0x2d, PSM_TPINFO(skipback) }
4801 struct psm_softc *sc;
4802 int error, newval, *oldvalp;
4805 if (arg1 == NULL || arg2 < 0 || arg2 >= nitems(data))
4809 oldvalp = (int *)((intptr_t)sc + tp[TPINFO]);
4811 error = sysctl_handle_int(oidp, &newval, 0, req);
4814 if (newval == *oldvalp)
4816 if (newval < 0 || newval > (tp[TPMASK] == 0 ? 255 : 1))
4818 error = trackpoint_command(sc, tp[TPMASK] == 0 ? 0x81 : 0x47,
4819 tp[TPLOC], tp[TPMASK] == 0 ? newval : tp[TPMASK]);
4828 trackpoint_sysctl_create_tree(struct psm_softc *sc)
4831 if (sc->tpinfo.sysctl_tree != NULL)
4834 /* Attach extra trackpoint sysctl nodes under hw.psm.trackpoint */
4835 sysctl_ctx_init(&sc->tpinfo.sysctl_ctx);
4836 sc->tpinfo.sysctl_tree = SYSCTL_ADD_NODE(&sc->tpinfo.sysctl_ctx,
4837 SYSCTL_STATIC_CHILDREN(_hw_psm), OID_AUTO, "trackpoint", CTLFLAG_RD,
4838 0, "IBM/Lenovo TrackPoint");
4840 /* hw.psm.trackpoint.sensitivity */
4841 sc->tpinfo.sensitivity = 0x80;
4842 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4843 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4844 "sensitivity", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4845 sc, TRACKPOINT_SYSCTL_SENSITIVITY,
4846 trackpoint_sysctl, "I",
4849 /* hw.psm.trackpoint.negative_inertia */
4850 sc->tpinfo.inertia = 0x06;
4851 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4852 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4853 "negative_inertia", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4854 sc, TRACKPOINT_SYSCTL_NEGATIVE_INERTIA,
4855 trackpoint_sysctl, "I",
4856 "Negative inertia factor");
4858 /* hw.psm.trackpoint.upper_plateau */
4859 sc->tpinfo.uplateau = 0x61;
4860 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4861 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4862 "upper_plateau", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4863 sc, TRACKPOINT_SYSCTL_UPPER_PLATEAU,
4864 trackpoint_sysctl, "I",
4865 "Transfer function upper plateau speed");
4867 /* hw.psm.trackpoint.backup_range */
4868 sc->tpinfo.reach = 0x0a;
4869 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4870 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4871 "backup_range", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4872 sc, TRACKPOINT_SYSCTL_BACKUP_RANGE,
4873 trackpoint_sysctl, "I",
4876 /* hw.psm.trackpoint.drag_hysteresis */
4877 sc->tpinfo.draghys = 0xff;
4878 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4879 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4880 "drag_hysteresis", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4881 sc, TRACKPOINT_SYSCTL_DRAG_HYSTERESIS,
4882 trackpoint_sysctl, "I",
4885 /* hw.psm.trackpoint.minimum_drag */
4886 sc->tpinfo.mindrag = 0x14;
4887 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4888 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4889 "minimum_drag", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4890 sc, TRACKPOINT_SYSCTL_MINIMUM_DRAG,
4891 trackpoint_sysctl, "I",
4894 /* hw.psm.trackpoint.up_threshold */
4895 sc->tpinfo.upthresh = 0xff;
4896 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4897 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4898 "up_threshold", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4899 sc, TRACKPOINT_SYSCTL_UP_THRESHOLD,
4900 trackpoint_sysctl, "I",
4901 "Up threshold for release");
4903 /* hw.psm.trackpoint.threshold */
4904 sc->tpinfo.threshold = 0x08;
4905 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4906 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4907 "threshold", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4908 sc, TRACKPOINT_SYSCTL_THRESHOLD,
4909 trackpoint_sysctl, "I",
4912 /* hw.psm.trackpoint.jenks_curvature */
4913 sc->tpinfo.jenks = 0x87;
4914 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4915 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4916 "jenks_curvature", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4917 sc, TRACKPOINT_SYSCTL_JENKS_CURVATURE,
4918 trackpoint_sysctl, "I",
4921 /* hw.psm.trackpoint.z_time */
4922 sc->tpinfo.ztime = 0x26;
4923 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4924 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4925 "z_time", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4926 sc, TRACKPOINT_SYSCTL_Z_TIME,
4927 trackpoint_sysctl, "I",
4930 /* hw.psm.trackpoint.press_to_select */
4931 sc->tpinfo.pts = 0x00;
4932 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4933 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4934 "press_to_select", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4935 sc, TRACKPOINT_SYSCTL_PRESS_TO_SELECT,
4936 trackpoint_sysctl, "I",
4939 /* hw.psm.trackpoint.skip_backups */
4940 sc->tpinfo.skipback = 0x00;
4941 SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
4942 SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
4943 "skip_backups", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
4944 sc, TRACKPOINT_SYSCTL_SKIP_BACKUPS,
4945 trackpoint_sysctl, "I",
4946 "Skip backups from drags");
4950 set_trackpoint_parameters(struct psm_softc *sc)
4952 trackpoint_command(sc, 0x81, 0x4a, sc->tpinfo.sensitivity);
4953 trackpoint_command(sc, 0x81, 0x60, sc->tpinfo.uplateau);
4954 trackpoint_command(sc, 0x81, 0x4d, sc->tpinfo.inertia);
4955 trackpoint_command(sc, 0x81, 0x57, sc->tpinfo.reach);
4956 trackpoint_command(sc, 0x81, 0x58, sc->tpinfo.draghys);
4957 trackpoint_command(sc, 0x81, 0x59, sc->tpinfo.mindrag);
4958 trackpoint_command(sc, 0x81, 0x5a, sc->tpinfo.upthresh);
4959 trackpoint_command(sc, 0x81, 0x5c, sc->tpinfo.threshold);
4960 trackpoint_command(sc, 0x81, 0x5d, sc->tpinfo.jenks);
4961 trackpoint_command(sc, 0x81, 0x5e, sc->tpinfo.ztime);
4962 if (sc->tpinfo.pts == 0x01)
4963 trackpoint_command(sc, 0x47, 0x2c, 0x01);
4964 if (sc->tpinfo.skipback == 0x01)
4965 trackpoint_command(sc, 0x47, 0x2d, 0x08);
4969 enable_trackpoint(KBDC kbdc, struct psm_softc *sc)
4973 if (send_aux_command(kbdc, 0xe1) != PSM_ACK ||
4974 read_aux_data(kbdc) != 0x01)
4976 id = read_aux_data(kbdc);
4981 if (!trackpoint_support)
4985 /* Create sysctl tree. */
4986 trackpoint_sysctl_create_tree(sc);
4989 * Don't overwrite hwid and buttons when we are
4992 if (!sc->synhw.capPassthrough) {
5001 /* Interlink electronics VersaPad */
5003 enable_versapad(KBDC kbdc, struct psm_softc *sc)
5007 set_mouse_resolution(kbdc, PSMD_RES_MEDIUM_HIGH); /* set res. 2 */
5008 set_mouse_sampling_rate(kbdc, 100); /* set rate 100 */
5009 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
5010 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
5011 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
5012 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
5013 if (get_mouse_status(kbdc, data, 0, 3) < 3) /* get status */
5015 if (data[2] != 0xa || data[1] != 0 ) /* rate == 0xa && res. == 0 */
5017 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
5019 return (TRUE); /* PS/2 absolute mode */
5023 * Return true if 'now' is earlier than (start + (secs.usecs)).
5024 * Now may be NULL and the function will fetch the current time from
5025 * getmicrouptime(), or a cached 'now' can be passed in.
5026 * All values should be numbers derived from getmicrouptime().
5029 timeelapsed(start, secs, usecs, now)
5030 const struct timeval *start, *now;
5033 struct timeval snow, tv;
5035 /* if there is no 'now' passed in, the get it as a convience. */
5037 getmicrouptime(&snow);
5043 timevaladd(&tv, start);
5044 return (timevalcmp(&tv, now, <));
5048 psmresume(device_t dev)
5050 struct psm_softc *sc = device_get_softc(dev);
5051 int unit = device_get_unit(dev);
5054 VLOG(2, (LOG_NOTICE, "psm%d: system resume hook called.\n", unit));
5057 (PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND)) == 0)
5060 err = reinitialize(sc, sc->config & PSM_CONFIG_INITAFTERSUSPEND);
5062 if ((sc->state & PSM_ASLP) && !(sc->state & PSM_VALID)) {
5064 * Release the blocked process; it must be notified that
5065 * the device cannot be accessed anymore.
5067 sc->state &= ~PSM_ASLP;
5071 VLOG(2, (LOG_DEBUG, "psm%d: system resume hook exiting.\n", unit));
5076 DRIVER_MODULE(psm, atkbdc, psm_driver, psm_devclass, 0, 0);
5081 * This sucks up assignments from PNPBIOS and ACPI.
5085 * When the PS/2 mouse device is reported by ACPI or PnP BIOS, it may
5086 * appear BEFORE the AT keyboard controller. As the PS/2 mouse device
5087 * can be probed and attached only after the AT keyboard controller is
5088 * attached, we shall quietly reserve the IRQ resource for later use.
5089 * If the PS/2 mouse device is reported to us AFTER the keyboard controller,
5090 * copy the IRQ resource to the PS/2 mouse device instance hanging
5091 * under the keyboard controller, then probe and attach it.
5094 static devclass_t psmcpnp_devclass;
5096 static device_probe_t psmcpnp_probe;
5097 static device_attach_t psmcpnp_attach;
5099 static device_method_t psmcpnp_methods[] = {
5100 DEVMETHOD(device_probe, psmcpnp_probe),
5101 DEVMETHOD(device_attach, psmcpnp_attach),
5106 static driver_t psmcpnp_driver = {
5107 PSMCPNP_DRIVER_NAME,
5112 static struct isa_pnp_id psmcpnp_ids[] = {
5113 { 0x030fd041, "PS/2 mouse port" }, /* PNP0F03 */
5114 { 0x0e0fd041, "PS/2 mouse port" }, /* PNP0F0E */
5115 { 0x120fd041, "PS/2 mouse port" }, /* PNP0F12 */
5116 { 0x130fd041, "PS/2 mouse port" }, /* PNP0F13 */
5117 { 0x1303d041, "PS/2 port" }, /* PNP0313, XXX */
5118 { 0x02002e4f, "Dell PS/2 mouse port" }, /* Lat. X200, Dell */
5119 { 0x0002a906, "ALPS Glide Point" }, /* ALPS Glide Point */
5120 { 0x80374d24, "IBM PS/2 mouse port" }, /* IBM3780, ThinkPad */
5121 { 0x81374d24, "IBM PS/2 mouse port" }, /* IBM3781, ThinkPad */
5122 { 0x0190d94d, "SONY VAIO PS/2 mouse port"}, /* SNY9001, Vaio */
5123 { 0x0290d94d, "SONY VAIO PS/2 mouse port"}, /* SNY9002, Vaio */
5124 { 0x0390d94d, "SONY VAIO PS/2 mouse port"}, /* SNY9003, Vaio */
5125 { 0x0490d94d, "SONY VAIO PS/2 mouse port"}, /* SNY9004, Vaio */
5130 create_a_copy(device_t atkbdc, device_t me)
5135 /* find the PS/2 mouse device instance under the keyboard controller */
5136 psm = device_find_child(atkbdc, PSM_DRIVER_NAME,
5137 device_get_unit(atkbdc));
5140 if (device_get_state(psm) != DS_NOTPRESENT)
5143 /* move our resource to the found device */
5144 irq = bus_get_resource_start(me, SYS_RES_IRQ, 0);
5145 bus_delete_resource(me, SYS_RES_IRQ, 0);
5146 bus_set_resource(psm, SYS_RES_IRQ, KBDC_RID_AUX, irq, 1);
5148 /* ...then probe and attach it */
5149 return (device_probe_and_attach(psm));
5153 psmcpnp_probe(device_t dev)
5155 struct resource *res;
5159 if (ISA_PNP_PROBE(device_get_parent(dev), dev, psmcpnp_ids))
5163 * The PnP BIOS and ACPI are supposed to assign an IRQ (12)
5164 * to the PS/2 mouse device node. But, some buggy PnP BIOS
5165 * declares the PS/2 mouse device node without an IRQ resource!
5166 * If this happens, we shall refer to device hints.
5167 * If we still don't find it there, use a hardcoded value... XXX
5170 irq = bus_get_resource_start(dev, SYS_RES_IRQ, rid);
5172 if (resource_long_value(PSM_DRIVER_NAME,
5173 device_get_unit(dev),"irq", &irq) != 0)
5175 device_printf(dev, "irq resource info is missing; "
5176 "assuming irq %ld\n", irq);
5177 bus_set_resource(dev, SYS_RES_IRQ, rid, irq, 1);
5179 res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 0);
5180 bus_release_resource(dev, SYS_RES_IRQ, rid, res);
5186 return ((res == NULL) ? ENXIO : 0);
5190 psmcpnp_attach(device_t dev)
5194 /* find the keyboard controller, which may be on acpi* or isa* bus */
5195 atkbdc = devclass_get_device(devclass_find(ATKBDC_DRIVER_NAME),
5196 device_get_unit(dev));
5197 if ((atkbdc != NULL) && (device_get_state(atkbdc) == DS_ATTACHED))
5198 create_a_copy(atkbdc, dev);
5203 DRIVER_MODULE(psmcpnp, isa, psmcpnp_driver, psmcpnp_devclass, 0, 0);
5204 DRIVER_MODULE(psmcpnp, acpi, psmcpnp_driver, psmcpnp_devclass, 0, 0);
5206 #endif /* DEV_ISA */