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.
23 * $FreeBSD: src/sys/isa/psm.c,v 1.23.2.7 2003/11/12 04:26:26 mikeh Exp $
24 * $DragonFly: src/sys/dev/misc/psm/psm.c,v 1.15 2005/06/16 16:18:06 joerg Exp $
28 * Ported to 386bsd Oct 17, 1992
29 * Sandi Donno, Computer Science, University of Cape Town, South Africa
30 * Please send bug reports to sandi@cs.uct.ac.za
32 * Thanks are also due to Rick Macklem, rick@snowhite.cis.uoguelph.ca -
33 * although I was only partially successful in getting the alpha release
34 * of his "driver for the Logitech and ATI Inport Bus mice for use with
35 * 386bsd and the X386 port" to work with my Microsoft mouse, I nevertheless
36 * found his code to be an invaluable reference when porting this driver
39 * Further modifications for latest 386BSD+patchkit and port to NetBSD,
40 * Andrew Herbert <andrew@werple.apana.org.au> - 8 June 1993
42 * Cloned from the Microsoft Bus Mouse driver, also by Erik Forsberg, by
43 * Andrew Herbert - 12 June 1993
45 * Modified for PS/2 mouse by Charles Hannum <mycroft@ai.mit.edu>
48 * Modified for PS/2 AUX mouse by Shoji Yuen <yuen@nuie.nagoya-u.ac.jp>
51 * Hardware access routines and probe logic rewritten by
52 * Kazutaka Yokota <yokota@zodiac.mech.utsunomiya-u.ac.jp>
53 * - 3, 14, 22 October 1996.
54 * - 12 November 1996. IOCTLs and rearranging `psmread', `psmioctl'...
55 * - 14, 30 November 1996. Uses `kbdio.c'.
56 * - 13 December 1996. Uses queuing version of `kbdio.c'.
57 * - January/February 1997. Tweaked probe logic for
58 * HiNote UltraII/Latitude/Armada laptops.
59 * - 30 July 1997. Added APM support.
60 * - 5 March 1997. Defined driver configuration flags (PSM_CONFIG_XXX).
61 * Improved sync check logic.
62 * Vendor specific support routines.
67 #include <sys/param.h>
68 #include <sys/systm.h>
69 #include <sys/kernel.h>
70 #include <sys/module.h>
74 #include <sys/syslog.h>
75 #include <sys/malloc.h>
76 #include <machine/bus.h>
78 #include <sys/select.h>
79 #include <sys/thread2.h>
83 #include <machine/clock.h>
84 #include <machine/limits.h>
85 #include <machine/mouse.h>
86 #include <machine/resource.h>
88 #include <bus/isa/isavar.h>
89 #include <dev/misc/kbd/atkbdcreg.h>
92 * Driver specific options: the following options may be set by
93 * `options' statements in the kernel configuration file.
98 #define PSM_DEBUG 0 /* logging: 0: none, 1: brief, 2: verbose */
101 #ifndef PSM_SYNCERR_THRESHOLD1
102 #define PSM_SYNCERR_THRESHOLD1 20
105 #ifndef PSM_INPUT_TIMEOUT
106 #define PSM_INPUT_TIMEOUT 2000000 /* 2 sec */
109 /* end of driver specific options */
111 #define PSM_DRIVER_NAME "psm"
112 #define PSMCPNP_DRIVER_NAME "psmcpnp"
115 #define PSM_BUFSIZE 960
116 #define PSM_SMALLBUFSIZE 240
118 /* operation levels */
119 #define PSM_LEVEL_BASE 0
120 #define PSM_LEVEL_STANDARD 1
121 #define PSM_LEVEL_NATIVE 2
122 #define PSM_LEVEL_MIN PSM_LEVEL_BASE
123 #define PSM_LEVEL_MAX PSM_LEVEL_NATIVE
125 /* Logitech PS2++ protocol */
126 #define MOUSE_PS2PLUS_CHECKBITS(b) \
127 ((((b[2] & 0x03) << 2) | 0x02) == (b[1] & 0x0f))
128 #define MOUSE_PS2PLUS_PACKET_TYPE(b) \
129 (((b[0] & 0x30) >> 2) | ((b[1] & 0x30) >> 4))
132 #define PSM_UNIT(dev) (minor(dev) >> 1)
133 #define PSM_NBLOCKIO(dev) (minor(dev) & 1)
134 #define PSM_MKMINOR(unit,block) ((((unit) & 0xff) << 1) | ((block) ? 0:1))
137 #define max(x,y) ((x) > (y) ? (x) : (y))
140 #define min(x,y) ((x) < (y) ? (x) : (y))
143 #define abs(x) (((x) < 0) ? -(x) : (x))
146 typedef struct ringbuf {
147 int count; /* # of valid elements in the buffer */
148 int head; /* head pointer */
149 int tail; /* tail poiner */
150 unsigned char buf[PSM_BUFSIZE];
153 /* driver control block */
154 struct psm_softc { /* Driver status information */
156 struct selinfo rsel; /* Process selecting for Input */
157 unsigned char state; /* Mouse driver state */
158 int config; /* driver configuration flags */
159 int flags; /* other flags */
160 KBDC kbdc; /* handle to access the keyboard controller */
161 struct resource *intr; /* IRQ resource */
162 void *ih; /* interrupt handle */
163 mousehw_t hw; /* hardware information */
164 mousemode_t mode; /* operation mode */
165 mousemode_t dflt_mode; /* default operation mode */
166 mousestatus_t status; /* accumulated mouse movement */
167 ringbuf_t queue; /* mouse status queue */
168 unsigned char ipacket[16]; /* interim input buffer */
169 int inputbytes; /* # of bytes in the input buffer */
170 int button; /* the latest button state */
171 int xold; /* previous absolute X position */
172 int yold; /* previous absolute Y position */
174 struct timeval inputtimeout;
175 int watchdog; /* watchdog timer flag */
176 struct callout callout; /* watchdog timer call out */
178 devclass_t psm_devclass;
179 #define PSM_SOFTC(unit) ((struct psm_softc*)devclass_get_softc(psm_devclass, unit))
181 /* driver state flags (state) */
182 #define PSM_VALID 0x80
183 #define PSM_OPEN 1 /* Device is open */
184 #define PSM_ASLP 2 /* Waiting for mouse data */
186 /* driver configuration flags (config) */
187 #define PSM_CONFIG_RESOLUTION 0x000f /* resolution */
188 #define PSM_CONFIG_ACCEL 0x00f0 /* acceleration factor */
189 #define PSM_CONFIG_NOCHECKSYNC 0x0100 /* disable sync. test */
190 #define PSM_CONFIG_NOIDPROBE 0x0200 /* disable mouse model probe */
191 #define PSM_CONFIG_NORESET 0x0400 /* don't reset the mouse */
192 #define PSM_CONFIG_FORCETAP 0x0800 /* assume `tap' action exists */
193 #define PSM_CONFIG_IGNPORTERROR 0x1000 /* ignore error in aux port test */
194 #define PSM_CONFIG_HOOKRESUME 0x2000 /* hook the system resume event */
195 #define PSM_CONFIG_INITAFTERSUSPEND 0x4000 /* init the device at the resume event */
196 #define PSM_CONFIG_SYNCHACK 0x8000 /* enable `out-of-sync' hack */
198 #define PSM_CONFIG_FLAGS (PSM_CONFIG_RESOLUTION \
200 | PSM_CONFIG_NOCHECKSYNC \
201 | PSM_CONFIG_SYNCHACK \
202 | PSM_CONFIG_NOIDPROBE \
203 | PSM_CONFIG_NORESET \
204 | PSM_CONFIG_FORCETAP \
205 | PSM_CONFIG_IGNPORTERROR \
206 | PSM_CONFIG_HOOKRESUME \
207 | PSM_CONFIG_INITAFTERSUSPEND)
209 /* other flags (flags) */
210 #define PSM_FLAGS_FINGERDOWN 0x0001 /* VersaPad finger down */
212 /* for backward compatibility */
213 #define OLD_MOUSE_GETHWINFO _IOR('M', 1, old_mousehw_t)
214 #define OLD_MOUSE_GETMODE _IOR('M', 2, old_mousemode_t)
215 #define OLD_MOUSE_SETMODE _IOW('M', 3, old_mousemode_t)
217 typedef struct old_mousehw {
224 typedef struct old_mousemode {
231 /* packet formatting function */
232 typedef int packetfunc_t (struct psm_softc *, unsigned char *,
233 int *, int, mousestatus_t *);
235 /* function prototypes */
236 static int psmprobe (device_t);
237 static int psmattach (device_t);
238 static int psmdetach (device_t);
239 static int psmresume (device_t);
241 static d_open_t psmopen;
242 static d_close_t psmclose;
243 static d_read_t psmread;
244 static d_ioctl_t psmioctl;
245 static d_poll_t psmpoll;
247 static int enable_aux_dev (KBDC);
248 static int disable_aux_dev (KBDC);
249 static int get_mouse_status (KBDC, int *, int, int);
250 static int get_aux_id (KBDC);
251 static int set_mouse_sampling_rate (KBDC, int);
252 static int set_mouse_scaling (KBDC, int);
253 static int set_mouse_resolution (KBDC, int);
254 static int set_mouse_mode (KBDC);
255 static int get_mouse_buttons (KBDC);
256 static int is_a_mouse (int);
257 static void recover_from_error (KBDC);
258 static int restore_controller (KBDC, int);
259 static int doinitialize (struct psm_softc *, mousemode_t *);
260 static int doopen (struct psm_softc *, int);
261 static int reinitialize (struct psm_softc *, int);
262 static char *model_name (int);
263 static void psmintr (void *);
264 static void psmtimeout (void *);
266 /* vendor specific features */
267 typedef int probefunc_t (struct psm_softc *);
269 static int mouse_id_proc1 (KBDC, int, int, int *);
270 static int mouse_ext_command (KBDC, int);
271 static probefunc_t enable_groller;
272 static probefunc_t enable_gmouse;
273 static probefunc_t enable_aglide;
274 static probefunc_t enable_kmouse;
275 static probefunc_t enable_msexplorer;
276 static probefunc_t enable_msintelli;
277 static probefunc_t enable_4dmouse;
278 static probefunc_t enable_4dplus;
279 static probefunc_t enable_mmanplus;
280 static probefunc_t enable_versapad;
281 static int tame_mouse (struct psm_softc *, mousestatus_t *, unsigned char *);
285 unsigned char syncmask;
287 probefunc_t *probefunc;
290 * WARNING: the order of probe is very important. Don't mess it
291 * unless you know what you are doing.
293 { MOUSE_MODEL_NET, /* Genius NetMouse */
294 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_gmouse, },
295 { MOUSE_MODEL_NETSCROLL, /* Genius NetScroll */
296 0xc8, 6, enable_groller, },
297 { MOUSE_MODEL_MOUSEMANPLUS, /* Logitech MouseMan+ */
298 0x08, MOUSE_PS2_PACKETSIZE, enable_mmanplus, },
299 { MOUSE_MODEL_EXPLORER, /* Microsoft IntelliMouse Explorer */
300 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msexplorer, },
301 { MOUSE_MODEL_4D, /* A4 Tech 4D Mouse */
302 0x08, MOUSE_4D_PACKETSIZE, enable_4dmouse, },
303 { MOUSE_MODEL_4DPLUS, /* A4 Tech 4D+ Mouse */
304 0xc8, MOUSE_4DPLUS_PACKETSIZE, enable_4dplus, },
305 { MOUSE_MODEL_INTELLI, /* Microsoft IntelliMouse */
306 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msintelli, },
307 { MOUSE_MODEL_GLIDEPOINT, /* ALPS GlidePoint */
308 0xc0, MOUSE_PS2_PACKETSIZE, enable_aglide, },
309 { MOUSE_MODEL_THINK, /* Kensignton ThinkingMouse */
310 0x80, MOUSE_PS2_PACKETSIZE, enable_kmouse, },
311 { MOUSE_MODEL_VERSAPAD, /* Interlink electronics VersaPad */
312 0xe8, MOUSE_PS2VERSA_PACKETSIZE, enable_versapad, },
313 { MOUSE_MODEL_GENERIC,
314 0xc0, MOUSE_PS2_PACKETSIZE, NULL, },
316 #define GENERIC_MOUSE_ENTRY ((sizeof(vendortype) / sizeof(*vendortype)) - 1)
318 /* device driver declarateion */
319 static device_method_t psm_methods[] = {
320 /* Device interface */
321 DEVMETHOD(device_probe, psmprobe),
322 DEVMETHOD(device_attach, psmattach),
323 DEVMETHOD(device_detach, psmdetach),
324 DEVMETHOD(device_resume, psmresume),
329 static driver_t psm_driver = {
332 sizeof(struct psm_softc),
336 static struct isa_pnp_id psm_ids[] = {
337 { 0x130fd041, "PS/2 mouse port" }, /* PNP0F13 */
338 { 0x1303d041, "PS/2 port" }, /* PNP0313, XXX */
343 #define CDEV_MAJOR 21
345 static struct cdevsw psm_cdevsw = {
346 /* name */ PSM_DRIVER_NAME,
347 /* maj */ CDEV_MAJOR,
353 /* close */ psmclose,
356 /* ioctl */ psmioctl,
359 /* strategy */ nostrategy,
364 /* debug message level */
365 static int verbose = PSM_DEBUG;
367 /* device I/O routines */
369 enable_aux_dev(KBDC kbdc)
373 res = send_aux_command(kbdc, PSMC_ENABLE_DEV);
375 log(LOG_DEBUG, "psm: ENABLE_DEV return code:%04x\n", res);
377 return (res == PSM_ACK);
381 disable_aux_dev(KBDC kbdc)
385 res = send_aux_command(kbdc, PSMC_DISABLE_DEV);
387 log(LOG_DEBUG, "psm: DISABLE_DEV return code:%04x\n", res);
389 return (res == PSM_ACK);
393 get_mouse_status(KBDC kbdc, int *status, int flag, int len)
402 cmd = PSMC_SEND_DEV_STATUS;
405 cmd = PSMC_SEND_DEV_DATA;
408 empty_aux_buffer(kbdc, 5);
409 res = send_aux_command(kbdc, cmd);
411 log(LOG_DEBUG, "psm: SEND_AUX_DEV_%s return code:%04x\n",
412 (flag == 1) ? "DATA" : "STATUS", res);
416 for (i = 0; i < len; ++i) {
417 status[i] = read_aux_data(kbdc);
423 log(LOG_DEBUG, "psm: %s %02x %02x %02x\n",
424 (flag == 1) ? "data" : "status", status[0], status[1], status[2]);
431 get_aux_id(KBDC kbdc)
436 empty_aux_buffer(kbdc, 5);
437 res = send_aux_command(kbdc, PSMC_SEND_DEV_ID);
439 log(LOG_DEBUG, "psm: SEND_DEV_ID return code:%04x\n", res);
446 id = read_aux_data(kbdc);
448 log(LOG_DEBUG, "psm: device ID: %04x\n", id);
454 set_mouse_sampling_rate(KBDC kbdc, int rate)
458 res = send_aux_command_and_data(kbdc, PSMC_SET_SAMPLING_RATE, rate);
460 log(LOG_DEBUG, "psm: SET_SAMPLING_RATE (%d) %04x\n", rate, res);
462 return ((res == PSM_ACK) ? rate : -1);
466 set_mouse_scaling(KBDC kbdc, int scale)
473 scale = PSMC_SET_SCALING11;
476 scale = PSMC_SET_SCALING21;
479 res = send_aux_command(kbdc, scale);
481 log(LOG_DEBUG, "psm: SET_SCALING%s return code:%04x\n",
482 (scale == PSMC_SET_SCALING21) ? "21" : "11", res);
484 return (res == PSM_ACK);
487 /* `val' must be 0 through PSMD_MAX_RESOLUTION */
489 set_mouse_resolution(KBDC kbdc, int val)
493 res = send_aux_command_and_data(kbdc, PSMC_SET_RESOLUTION, val);
495 log(LOG_DEBUG, "psm: SET_RESOLUTION (%d) %04x\n", val, res);
497 return ((res == PSM_ACK) ? val : -1);
501 * NOTE: once `set_mouse_mode()' is called, the mouse device must be
502 * re-enabled by calling `enable_aux_dev()'
505 set_mouse_mode(KBDC kbdc)
509 res = send_aux_command(kbdc, PSMC_SET_STREAM_MODE);
511 log(LOG_DEBUG, "psm: SET_STREAM_MODE return code:%04x\n", res);
513 return (res == PSM_ACK);
517 get_mouse_buttons(KBDC kbdc)
519 int c = 2; /* assume two buttons by default */
523 * NOTE: a special sequence to obtain Logitech Mouse specific
524 * information: set resolution to 25 ppi, set scaling to 1:1, set
525 * scaling to 1:1, set scaling to 1:1. Then the second byte of the
526 * mouse status bytes is the number of available buttons.
527 * Some manufactures also support this sequence.
529 if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
531 if (set_mouse_scaling(kbdc, 1) && set_mouse_scaling(kbdc, 1)
532 && set_mouse_scaling(kbdc, 1)
533 && (get_mouse_status(kbdc, status, 0, 3) >= 3)) {
540 /* misc subroutines */
542 * Someday, I will get the complete list of valid pointing devices and
549 static int valid_ids[] = {
550 PSM_MOUSE_ID, /* mouse */
551 PSM_BALLPOINT_ID, /* ballpoint device */
552 PSM_INTELLI_ID, /* Intellimouse */
553 PSM_EXPLORER_ID, /* Intellimouse Explorer */
554 -1 /* end of table */
558 for (i = 0; valid_ids[i] >= 0; ++i)
559 if (valid_ids[i] == id)
568 model_name(int model)
574 { MOUSE_MODEL_NETSCROLL, "NetScroll" },
575 { MOUSE_MODEL_NET, "NetMouse/NetScroll Optical" },
576 { MOUSE_MODEL_GLIDEPOINT, "GlidePoint" },
577 { MOUSE_MODEL_THINK, "ThinkingMouse" },
578 { MOUSE_MODEL_INTELLI, "IntelliMouse" },
579 { MOUSE_MODEL_MOUSEMANPLUS, "MouseMan+" },
580 { MOUSE_MODEL_VERSAPAD, "VersaPad" },
581 { MOUSE_MODEL_EXPLORER, "IntelliMouse Explorer" },
582 { MOUSE_MODEL_4D, "4D Mouse" },
583 { MOUSE_MODEL_4DPLUS, "4D+ Mouse" },
584 { MOUSE_MODEL_GENERIC, "Generic PS/2 mouse" },
585 { MOUSE_MODEL_UNKNOWN, NULL },
589 for (i = 0; models[i].model_code != MOUSE_MODEL_UNKNOWN; ++i) {
590 if (models[i].model_code == model)
591 return models[i].model_name;
597 recover_from_error(KBDC kbdc)
599 /* discard anything left in the output buffer */
600 empty_both_buffers(kbdc, 10);
604 * NOTE: KBDC_RESET_KBD may not restore the communication between the
605 * keyboard and the controller.
610 * NOTE: somehow diagnostic and keyboard port test commands bring the
613 if (!test_controller(kbdc))
614 log(LOG_ERR, "psm: keyboard controller failed.\n");
615 /* if there isn't a keyboard in the system, the following error is OK */
616 if (test_kbd_port(kbdc) != 0) {
618 log(LOG_ERR, "psm: keyboard port failed.\n");
624 restore_controller(KBDC kbdc, int command_byte)
626 empty_both_buffers(kbdc, 10);
628 if (!set_controller_command_byte(kbdc, 0xff, command_byte)) {
629 log(LOG_ERR, "psm: failed to restore the keyboard controller "
631 empty_both_buffers(kbdc, 10);
634 empty_both_buffers(kbdc, 10);
640 * Re-initialize the aux port and device. The aux port must be enabled
641 * and its interrupt must be disabled before calling this routine.
642 * The aux device will be disabled before returning.
643 * The keyboard controller must be locked via `kbdc_lock()' before
644 * calling this routine.
647 doinitialize(struct psm_softc *sc, mousemode_t *mode)
649 KBDC kbdc = sc->kbdc;
653 switch((i = test_aux_port(kbdc))) {
654 case 1: /* ignore this error */
655 case 2: /* Ignore 2 and 3 for use with some acer and compal laptops */
659 log(LOG_DEBUG, "psm%d: strange result for test aux port (%d).\n",
662 case 0: /* no error */
664 case -1: /* time out */
666 recover_from_error(kbdc);
667 if (sc->config & PSM_CONFIG_IGNPORTERROR)
669 log(LOG_ERR, "psm%d: the aux port is not functioning (%d).\n",
674 if (sc->config & PSM_CONFIG_NORESET) {
676 * Don't try to reset the pointing device. It may possibly be
677 * left in the unknown state, though...
681 * NOTE: some controllers appears to hang the `keyboard' when
682 * the aux port doesn't exist and `PSMC_RESET_DEV' is issued.
684 if (!reset_aux_dev(kbdc)) {
685 recover_from_error(kbdc);
686 log(LOG_ERR, "psm%d: failed to reset the aux device.\n", sc->unit);
692 * both the aux port and the aux device is functioning, see
693 * if the device can be enabled.
695 if (!enable_aux_dev(kbdc) || !disable_aux_dev(kbdc)) {
696 log(LOG_ERR, "psm%d: failed to enable the aux device.\n", sc->unit);
699 empty_both_buffers(kbdc, 10); /* remove stray data if any */
701 if (sc->config & PSM_CONFIG_NOIDPROBE) {
702 i = GENERIC_MOUSE_ENTRY;
704 /* FIXME: hardware ID, mouse buttons? */
706 /* other parameters */
707 for (i = 0; vendortype[i].probefunc != NULL; ++i) {
708 if ((*vendortype[i].probefunc)(sc)) {
710 log(LOG_ERR, "psm%d: found %s\n",
711 sc->unit, model_name(vendortype[i].model));
717 sc->hw.model = vendortype[i].model;
718 sc->mode.packetsize = vendortype[i].packetsize;
720 /* set mouse parameters */
721 if (mode != (mousemode_t *)NULL) {
723 mode->rate = set_mouse_sampling_rate(kbdc, mode->rate);
724 if (mode->resolution >= 0)
725 mode->resolution = set_mouse_resolution(kbdc, mode->resolution);
726 set_mouse_scaling(kbdc, 1);
727 set_mouse_mode(kbdc);
730 /* request a data packet and extract sync. bits */
731 if (get_mouse_status(kbdc, stat, 1, 3) < 3) {
732 log(LOG_DEBUG, "psm%d: failed to get data (doinitialize).\n",
734 sc->mode.syncmask[0] = 0;
736 sc->mode.syncmask[1] = stat[0] & sc->mode.syncmask[0]; /* syncbits */
737 /* the NetScroll Mouse will send three more bytes... Ignore them */
738 empty_aux_buffer(kbdc, 5);
741 /* just check the status of the mouse */
742 if (get_mouse_status(kbdc, stat, 0, 3) < 3)
743 log(LOG_DEBUG, "psm%d: failed to get status (doinitialize).\n",
750 doopen(struct psm_softc *sc, int command_byte)
754 /* enable the mouse device */
755 if (!enable_aux_dev(sc->kbdc)) {
756 /* MOUSE ERROR: failed to enable the mouse because:
757 * 1) the mouse is faulty,
758 * 2) the mouse has been removed(!?)
759 * In the latter case, the keyboard may have hung, and need
760 * recovery procedure...
762 recover_from_error(sc->kbdc);
764 /* FIXME: we could reset the mouse here and try to enable
765 * it again. But it will take long time and it's not a good
766 * idea to disable the keyboard that long...
768 if (!doinitialize(sc, &sc->mode) || !enable_aux_dev(sc->kbdc)) {
769 recover_from_error(sc->kbdc);
773 restore_controller(sc->kbdc, command_byte);
774 /* mark this device is no longer available */
775 sc->state &= ~PSM_VALID;
776 log(LOG_ERR, "psm%d: failed to enable the device (doopen).\n",
782 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
783 log(LOG_DEBUG, "psm%d: failed to get status (doopen).\n", sc->unit);
785 /* enable the aux port and interrupt */
786 if (!set_controller_command_byte(sc->kbdc,
787 kbdc_get_device_mask(sc->kbdc),
788 (command_byte & KBD_KBD_CONTROL_BITS)
789 | KBD_ENABLE_AUX_PORT | KBD_ENABLE_AUX_INT)) {
790 /* CONTROLLER ERROR */
791 disable_aux_dev(sc->kbdc);
792 restore_controller(sc->kbdc, command_byte);
793 log(LOG_ERR, "psm%d: failed to enable the aux interrupt (doopen).\n",
798 /* start the watchdog timer */
799 sc->watchdog = FALSE;
800 callout_reset(&sc->callout, hz * 2, psmtimeout, (void *)(uintptr_t)sc);
806 reinitialize(struct psm_softc *sc, int doinit)
811 /* don't let anybody mess with the aux device */
812 if (!kbdc_lock(sc->kbdc, TRUE))
816 /* block our watchdog timer */
817 sc->watchdog = FALSE;
818 callout_stop(&sc->callout);
820 /* save the current controller command byte */
821 empty_both_buffers(sc->kbdc, 10);
822 c = get_controller_command_byte(sc->kbdc);
824 log(LOG_DEBUG, "psm%d: current command byte: %04x (reinitialize).\n",
827 /* enable the aux port but disable the aux interrupt and the keyboard */
828 if ((c == -1) || !set_controller_command_byte(sc->kbdc,
829 kbdc_get_device_mask(sc->kbdc),
830 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
831 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
832 /* CONTROLLER ERROR */
834 kbdc_lock(sc->kbdc, FALSE);
835 log(LOG_ERR, "psm%d: unable to set the command byte (reinitialize).\n",
841 if (sc->state & PSM_VALID) {
842 disable_aux_dev(sc->kbdc); /* this may fail; but never mind... */
843 empty_aux_buffer(sc->kbdc, 10);
848 /* try to detect the aux device; are you still there? */
851 if (doinitialize(sc, &sc->mode)) {
853 sc->state |= PSM_VALID;
855 /* the device has gone! */
856 restore_controller(sc->kbdc, c);
857 sc->state &= ~PSM_VALID;
858 log(LOG_ERR, "psm%d: the aux device has gone! (reinitialize).\n",
865 /* restore the driver state */
866 if ((sc->state & PSM_OPEN) && (err == 0)) {
867 /* enable the aux device and the port again */
870 log(LOG_ERR, "psm%d: failed to enable the device (reinitialize).\n",
873 /* restore the keyboard port and disable the aux port */
874 if (!set_controller_command_byte(sc->kbdc,
875 kbdc_get_device_mask(sc->kbdc),
876 (c & KBD_KBD_CONTROL_BITS)
877 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
878 /* CONTROLLER ERROR */
879 log(LOG_ERR, "psm%d: failed to disable the aux port (reinitialize).\n",
885 kbdc_lock(sc->kbdc, FALSE);
889 /* psm driver entry points */
891 #define endprobe(v) { if (bootverbose) \
893 kbdc_set_device_mask(sc->kbdc, mask); \
894 kbdc_lock(sc->kbdc, FALSE); \
899 psmprobe(device_t dev)
901 int unit = device_get_unit(dev);
902 struct psm_softc *sc = device_get_softc(dev);
917 if (XXX_PNP_PROBE(device_get_parent(dev), dev, psm_ids) == ENXIO)
921 BUS_READ_IVAR(device_get_parent(dev), dev, KBDC_IVAR_IRQ, &irq);
922 BUS_READ_IVAR(device_get_parent(dev), dev, KBDC_IVAR_FLAGS, &flags);
925 sc->kbdc = atkbdc_open(device_get_unit(device_get_parent(dev)));
926 sc->config = flags & PSM_CONFIG_FLAGS;
927 /* XXX: for backward compatibility */
928 #if defined(PSM_HOOKRESUME) || defined(PSM_HOOKAPM)
930 #ifdef PSM_RESETAFTERSUSPEND
931 PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND;
933 PSM_CONFIG_HOOKRESUME;
935 #endif /* PSM_HOOKRESUME | PSM_HOOKAPM */
940 device_set_desc(dev, "PS/2 Mouse");
942 if (!kbdc_lock(sc->kbdc, TRUE)) {
943 printf("psm%d: unable to lock the controller.\n", unit);
950 * NOTE: two bits in the command byte controls the operation of the
951 * aux port (mouse port): the aux port disable bit (bit 5) and the aux
952 * port interrupt (IRQ 12) enable bit (bit 2).
955 /* discard anything left after the keyboard initialization */
956 empty_both_buffers(sc->kbdc, 10);
958 /* save the current command byte; it will be used later */
959 mask = kbdc_get_device_mask(sc->kbdc) & ~KBD_AUX_CONTROL_BITS;
960 command_byte = get_controller_command_byte(sc->kbdc);
962 printf("psm%d: current command byte:%04x\n", unit, command_byte);
963 if (command_byte == -1) {
964 /* CONTROLLER ERROR */
965 printf("psm%d: unable to get the current command byte value.\n",
971 * disable the keyboard port while probing the aux port, which must be
972 * enabled during this routine
974 if (!set_controller_command_byte(sc->kbdc,
975 KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
976 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
977 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
979 * this is CONTROLLER ERROR; I don't know how to recover
982 restore_controller(sc->kbdc, command_byte);
983 printf("psm%d: unable to set the command byte.\n", unit);
986 write_controller_command(sc->kbdc, KBDC_ENABLE_AUX_PORT);
989 * NOTE: `test_aux_port()' is designed to return with zero if the aux
990 * port exists and is functioning. However, some controllers appears
991 * to respond with zero even when the aux port doesn't exist. (It may
992 * be that this is only the case when the controller DOES have the aux
993 * port but the port is not wired on the motherboard.) The keyboard
994 * controllers without the port, such as the original AT, are
995 * supporsed to return with an error code or simply time out. In any
996 * case, we have to continue probing the port even when the controller
999 * XXX: some controllers erroneously return the error code 1 when
1000 * it has the perfectly functional aux port. We have to ignore this
1001 * error code. Even if the controller HAS error with the aux port,
1002 * it will be detected later...
1003 * XXX: another incompatible controller returns PSM_ACK (0xfa)...
1005 switch ((i = test_aux_port(sc->kbdc))) {
1006 case 1: /* ignore this error */
1007 case 2: /* Ignore 2 and 3 for use with some acer and compal laptops */
1011 printf("psm%d: strange result for test aux port (%d).\n",
1014 case 0: /* no error */
1016 case -1: /* time out */
1017 default: /* error */
1018 recover_from_error(sc->kbdc);
1019 if (sc->config & PSM_CONFIG_IGNPORTERROR)
1021 restore_controller(sc->kbdc, command_byte);
1023 printf("psm%d: the aux port is not functioning (%d).\n",
1028 if (sc->config & PSM_CONFIG_NORESET) {
1030 * Don't try to reset the pointing device. It may possibly be
1031 * left in the unknown state, though...
1035 * NOTE: some controllers appears to hang the `keyboard' when the aux
1036 * port doesn't exist and `PSMC_RESET_DEV' is issued.
1038 * Attempt to reset the controller twice -- this helps
1039 * pierce through some KVM switches. The second reset
1042 if (!reset_aux_dev(sc->kbdc)) {
1043 recover_from_error(sc->kbdc);
1044 restore_controller(sc->kbdc, command_byte);
1046 printf("psm%d: failed to reset the aux device.\n", unit);
1048 } else if (!reset_aux_dev(sc->kbdc)) {
1049 recover_from_error(sc->kbdc);
1051 printf("psm%d: failed to reset the aux device (2).\n",
1057 * both the aux port and the aux device is functioning, see if the
1058 * device can be enabled. NOTE: when enabled, the device will start
1059 * sending data; we shall immediately disable the device once we know
1060 * the device can be enabled.
1062 if (!enable_aux_dev(sc->kbdc) || !disable_aux_dev(sc->kbdc)) {
1064 recover_from_error(sc->kbdc);
1065 restore_controller(sc->kbdc, command_byte);
1067 printf("psm%d: failed to enable the aux device.\n", unit);
1071 /* save the default values after reset */
1072 if (get_mouse_status(sc->kbdc, stat, 0, 3) >= 3) {
1073 sc->dflt_mode.rate = sc->mode.rate = stat[2];
1074 sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1076 sc->dflt_mode.rate = sc->mode.rate = -1;
1077 sc->dflt_mode.resolution = sc->mode.resolution = -1;
1080 /* hardware information */
1081 sc->hw.iftype = MOUSE_IF_PS2;
1083 /* verify the device is a mouse */
1084 sc->hw.hwid = get_aux_id(sc->kbdc);
1085 if (!is_a_mouse(sc->hw.hwid)) {
1086 restore_controller(sc->kbdc, command_byte);
1088 printf("psm%d: unknown device type (%d).\n", unit, sc->hw.hwid);
1091 switch (sc->hw.hwid) {
1092 case PSM_BALLPOINT_ID:
1093 sc->hw.type = MOUSE_TRACKBALL;
1096 case PSM_INTELLI_ID:
1097 case PSM_EXPLORER_ID:
1098 case PSM_4DMOUSE_ID:
1100 sc->hw.type = MOUSE_MOUSE;
1103 sc->hw.type = MOUSE_UNKNOWN;
1107 if (sc->config & PSM_CONFIG_NOIDPROBE) {
1109 i = GENERIC_MOUSE_ENTRY;
1112 sc->hw.buttons = get_mouse_buttons(sc->kbdc);
1114 /* other parameters */
1115 for (i = 0; vendortype[i].probefunc != NULL; ++i) {
1116 if ((*vendortype[i].probefunc)(sc)) {
1118 printf("psm%d: found %s\n",
1119 unit, model_name(vendortype[i].model));
1125 sc->hw.model = vendortype[i].model;
1127 sc->dflt_mode.level = PSM_LEVEL_BASE;
1128 sc->dflt_mode.packetsize = MOUSE_PS2_PACKETSIZE;
1129 sc->dflt_mode.accelfactor = (sc->config & PSM_CONFIG_ACCEL) >> 4;
1130 if (sc->config & PSM_CONFIG_NOCHECKSYNC)
1131 sc->dflt_mode.syncmask[0] = 0;
1133 sc->dflt_mode.syncmask[0] = vendortype[i].syncmask;
1134 if (sc->config & PSM_CONFIG_FORCETAP)
1135 sc->mode.syncmask[0] &= ~MOUSE_PS2_TAP;
1136 sc->dflt_mode.syncmask[1] = 0; /* syncbits */
1137 sc->mode = sc->dflt_mode;
1138 sc->mode.packetsize = vendortype[i].packetsize;
1140 /* set mouse parameters */
1143 * A version of Logitech FirstMouse+ won't report wheel movement,
1144 * if SET_DEFAULTS is sent... Don't use this command.
1145 * This fix was found by Takashi Nishida.
1147 i = send_aux_command(sc->kbdc, PSMC_SET_DEFAULTS);
1149 printf("psm%d: SET_DEFAULTS return code:%04x\n", unit, i);
1151 if (sc->config & PSM_CONFIG_RESOLUTION) {
1153 = set_mouse_resolution(sc->kbdc,
1154 (sc->config & PSM_CONFIG_RESOLUTION) - 1);
1155 } else if (sc->mode.resolution >= 0) {
1157 = set_mouse_resolution(sc->kbdc, sc->dflt_mode.resolution);
1159 if (sc->mode.rate > 0) {
1160 sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, sc->dflt_mode.rate);
1162 set_mouse_scaling(sc->kbdc, 1);
1164 /* request a data packet and extract sync. bits */
1165 if (get_mouse_status(sc->kbdc, stat, 1, 3) < 3) {
1166 printf("psm%d: failed to get data.\n", unit);
1167 sc->mode.syncmask[0] = 0;
1169 sc->mode.syncmask[1] = stat[0] & sc->mode.syncmask[0]; /* syncbits */
1170 /* the NetScroll Mouse will send three more bytes... Ignore them */
1171 empty_aux_buffer(sc->kbdc, 5);
1174 /* just check the status of the mouse */
1176 * NOTE: XXX there are some arcane controller/mouse combinations out
1177 * there, which hung the controller unless there is data transmission
1178 * after ACK from the mouse.
1180 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3) {
1181 printf("psm%d: failed to get status.\n", unit);
1184 * When in its native mode, some mice operate with different
1185 * default parameters than in the PS/2 compatible mode.
1187 sc->dflt_mode.rate = sc->mode.rate = stat[2];
1188 sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1191 /* disable the aux port for now... */
1192 if (!set_controller_command_byte(sc->kbdc,
1193 KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
1194 (command_byte & KBD_KBD_CONTROL_BITS)
1195 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1197 * this is CONTROLLER ERROR; I don't know the proper way to
1198 * recover from this error...
1200 restore_controller(sc->kbdc, command_byte);
1201 printf("psm%d: unable to set the command byte.\n", unit);
1205 /* see if IRQ is available */
1207 sc->intr = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, irq, irq, 1,
1209 if (sc->intr == NULL) {
1210 printf("psm%d: unable to allocate the IRQ resource (%d).\n",
1214 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1218 kbdc_set_device_mask(sc->kbdc, mask | KBD_AUX_CONTROL_BITS);
1219 kbdc_lock(sc->kbdc, FALSE);
1224 psmattach(device_t dev)
1226 int unit = device_get_unit(dev);
1227 struct psm_softc *sc = device_get_softc(dev);
1232 if (sc == NULL) /* shouldn't happen */
1235 /* Setup initial state */
1236 sc->state = PSM_VALID;
1237 callout_init(&sc->callout);
1239 /* Setup our interrupt handler */
1241 BUS_READ_IVAR(device_get_parent(dev), dev, KBDC_IVAR_IRQ, &irq);
1242 sc->intr = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, irq, irq, 1,
1244 if (sc->intr == NULL)
1246 error = BUS_SETUP_INTR(device_get_parent(dev), dev, sc->intr,
1247 INTR_TYPE_TTY, psmintr, sc, &sc->ih, NULL);
1249 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1254 cdevsw_add(&psm_cdevsw, PSM_MKMINOR(-1, 0), PSM_MKMINOR(unit, 0));
1255 make_dev(&psm_cdevsw, PSM_MKMINOR(unit, FALSE), 0, 0, 0666, "psm%d", unit);
1256 make_dev(&psm_cdevsw, PSM_MKMINOR(unit, TRUE), 0, 0, 0666, "bpsm%d", unit);
1259 printf("psm%d: model %s, device ID %d\n",
1260 unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff);
1262 printf("psm%d: model %s, device ID %d-%02x, %d buttons\n",
1263 unit, model_name(sc->hw.model),
1264 sc->hw.hwid & 0x00ff, sc->hw.hwid >> 8, sc->hw.buttons);
1265 printf("psm%d: config:%08x, flags:%08x, packet size:%d\n",
1266 unit, sc->config, sc->flags, sc->mode.packetsize);
1267 printf("psm%d: syncmask:%02x, syncbits:%02x\n",
1268 unit, sc->mode.syncmask[0], sc->mode.syncmask[1]);
1278 psmdetach(device_t dev)
1280 struct psm_softc *sc;
1284 sc = device_get_softc(dev);
1285 if (sc->state & PSM_OPEN)
1288 unit = device_get_unit(dev);
1291 BUS_TEARDOWN_INTR(device_get_parent(dev), dev, sc->intr, sc->ih);
1292 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1293 cdevsw_remove(&psm_cdevsw, PSM_MKMINOR(-1, 0), PSM_MKMINOR(unit, 0));
1299 psmopen(dev_t dev, int flag, int fmt, struct thread *td)
1301 int unit = PSM_UNIT(dev);
1302 struct psm_softc *sc;
1306 /* Get device data */
1307 sc = PSM_SOFTC(unit);
1308 if ((sc == NULL) || (sc->state & PSM_VALID) == 0)
1309 /* the device is no longer valid/functioning */
1312 /* Disallow multiple opens */
1313 if (sc->state & PSM_OPEN)
1316 device_busy(devclass_get_device(psm_devclass, unit));
1318 /* Initialize state */
1319 sc->rsel.si_flags = 0;
1320 sc->rsel.si_pid = 0;
1321 sc->mode.level = sc->dflt_mode.level;
1322 sc->mode.protocol = sc->dflt_mode.protocol;
1323 sc->watchdog = FALSE;
1325 /* flush the event queue */
1326 sc->queue.count = 0;
1329 sc->status.flags = 0;
1330 sc->status.button = 0;
1331 sc->status.obutton = 0;
1337 /* empty input buffer */
1338 bzero(sc->ipacket, sizeof(sc->ipacket));
1342 /* don't let timeout routines in the keyboard driver to poll the kbdc */
1343 if (!kbdc_lock(sc->kbdc, TRUE))
1346 /* save the current controller command byte */
1348 command_byte = get_controller_command_byte(sc->kbdc);
1350 /* enable the aux port and temporalily disable the keyboard */
1351 if ((command_byte == -1)
1352 || !set_controller_command_byte(sc->kbdc,
1353 kbdc_get_device_mask(sc->kbdc),
1354 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1355 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1356 /* CONTROLLER ERROR; do you know how to get out of this? */
1357 kbdc_lock(sc->kbdc, FALSE);
1359 log(LOG_ERR, "psm%d: unable to set the command byte (psmopen).\n",
1364 * Now that the keyboard controller is told not to generate
1365 * the keyboard and mouse interrupts, call `splx()' to allow
1366 * the other tty interrupts. The clock interrupt may also occur,
1367 * but timeout routines will be blocked by the poll flag set
1372 /* enable the mouse device */
1373 err = doopen(sc, command_byte);
1377 sc->state |= PSM_OPEN;
1378 kbdc_lock(sc->kbdc, FALSE);
1383 psmclose(dev_t dev, int flag, int fmt, struct thread *td)
1385 int unit = PSM_UNIT(dev);
1386 struct psm_softc *sc = PSM_SOFTC(unit);
1390 /* don't let timeout routines in the keyboard driver to poll the kbdc */
1391 if (!kbdc_lock(sc->kbdc, TRUE))
1394 /* save the current controller command byte */
1396 command_byte = get_controller_command_byte(sc->kbdc);
1397 if (command_byte == -1) {
1398 kbdc_lock(sc->kbdc, FALSE);
1403 /* disable the aux interrupt and temporalily disable the keyboard */
1404 if (!set_controller_command_byte(sc->kbdc,
1405 kbdc_get_device_mask(sc->kbdc),
1406 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1407 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1408 log(LOG_ERR, "psm%d: failed to disable the aux int (psmclose).\n",
1410 /* CONTROLLER ERROR;
1411 * NOTE: we shall force our way through. Because the only
1412 * ill effect we shall see is that we may not be able
1413 * to read ACK from the mouse, and it doesn't matter much
1414 * so long as the mouse will accept the DISABLE command.
1419 /* stop the watchdog timer */
1420 callout_stop(&sc->callout);
1422 /* remove anything left in the output buffer */
1423 empty_aux_buffer(sc->kbdc, 10);
1425 /* disable the aux device, port and interrupt */
1426 if (sc->state & PSM_VALID) {
1427 if (!disable_aux_dev(sc->kbdc)) {
1429 * NOTE: we don't return error and continue, pretending
1430 * we have successfully disabled the device. It's OK because
1431 * the interrupt routine will discard any data from the mouse
1434 log(LOG_ERR, "psm%d: failed to disable the device (psmclose).\n",
1438 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
1439 log(LOG_DEBUG, "psm%d: failed to get status (psmclose).\n",
1443 if (!set_controller_command_byte(sc->kbdc,
1444 kbdc_get_device_mask(sc->kbdc),
1445 (command_byte & KBD_KBD_CONTROL_BITS)
1446 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1447 /* CONTROLLER ERROR;
1448 * we shall ignore this error; see the above comment.
1450 log(LOG_ERR, "psm%d: failed to disable the aux port (psmclose).\n",
1454 /* remove anything left in the output buffer */
1455 empty_aux_buffer(sc->kbdc, 10);
1457 /* close is almost always successful */
1458 sc->state &= ~PSM_OPEN;
1459 kbdc_lock(sc->kbdc, FALSE);
1460 device_unbusy(devclass_get_device(psm_devclass, unit));
1465 tame_mouse(struct psm_softc *sc, mousestatus_t *status, unsigned char *buf)
1467 static unsigned char butmapps2[8] = {
1469 MOUSE_PS2_BUTTON1DOWN,
1470 MOUSE_PS2_BUTTON2DOWN,
1471 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN,
1472 MOUSE_PS2_BUTTON3DOWN,
1473 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON3DOWN,
1474 MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
1475 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
1477 static unsigned char butmapmsc[8] = {
1478 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
1479 MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
1480 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON3UP,
1481 MOUSE_MSC_BUTTON3UP,
1482 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP,
1483 MOUSE_MSC_BUTTON2UP,
1484 MOUSE_MSC_BUTTON1UP,
1490 if (sc->mode.level == PSM_LEVEL_BASE) {
1491 mapped = status->button & ~MOUSE_BUTTON4DOWN;
1492 if (status->button & MOUSE_BUTTON4DOWN)
1493 mapped |= MOUSE_BUTTON1DOWN;
1494 status->button = mapped;
1495 buf[0] = MOUSE_PS2_SYNC | butmapps2[mapped & MOUSE_STDBUTTONS];
1496 i = max(min(status->dx, 255), -256);
1498 buf[0] |= MOUSE_PS2_XNEG;
1500 i = max(min(status->dy, 255), -256);
1502 buf[0] |= MOUSE_PS2_YNEG;
1504 return MOUSE_PS2_PACKETSIZE;
1505 } else if (sc->mode.level == PSM_LEVEL_STANDARD) {
1506 buf[0] = MOUSE_MSC_SYNC | butmapmsc[status->button & MOUSE_STDBUTTONS];
1507 i = max(min(status->dx, 255), -256);
1509 buf[3] = i - buf[1];
1510 i = max(min(status->dy, 255), -256);
1512 buf[4] = i - buf[2];
1513 i = max(min(status->dz, 127), -128);
1514 buf[5] = (i >> 1) & 0x7f;
1515 buf[6] = (i - (i >> 1)) & 0x7f;
1516 buf[7] = (~status->button >> 3) & 0x7f;
1517 return MOUSE_SYS_PACKETSIZE;
1519 return sc->inputbytes;;
1523 psmread(dev_t dev, struct uio *uio, int flag)
1525 struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
1526 unsigned char buf[PSM_SMALLBUFSIZE];
1530 if ((sc->state & PSM_VALID) == 0)
1533 /* block until mouse activity occured */
1535 while (sc->queue.count <= 0) {
1536 if (PSM_NBLOCKIO(dev)) {
1540 sc->state |= PSM_ASLP;
1541 error = tsleep((caddr_t) sc, PCATCH, "psmrea", 0);
1542 sc->state &= ~PSM_ASLP;
1546 } else if ((sc->state & PSM_VALID) == 0) {
1547 /* the device disappeared! */
1554 /* copy data to the user land */
1555 while ((sc->queue.count > 0) && (uio->uio_resid > 0)) {
1557 l = min(sc->queue.count, uio->uio_resid);
1558 if (l > sizeof(buf))
1560 if (l > sizeof(sc->queue.buf) - sc->queue.head) {
1561 bcopy(&sc->queue.buf[sc->queue.head], &buf[0],
1562 sizeof(sc->queue.buf) - sc->queue.head);
1563 bcopy(&sc->queue.buf[0],
1564 &buf[sizeof(sc->queue.buf) - sc->queue.head],
1565 l - (sizeof(sc->queue.buf) - sc->queue.head));
1567 bcopy(&sc->queue.buf[sc->queue.head], &buf[0], l);
1569 sc->queue.count -= l;
1570 sc->queue.head = (sc->queue.head + l) % sizeof(sc->queue.buf);
1572 error = uiomove(buf, l, uio);
1581 block_mouse_data(struct psm_softc *sc, int *c)
1583 if (!kbdc_lock(sc->kbdc, TRUE))
1587 *c = get_controller_command_byte(sc->kbdc);
1589 || !set_controller_command_byte(sc->kbdc,
1590 kbdc_get_device_mask(sc->kbdc),
1591 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1592 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1593 /* this is CONTROLLER ERROR */
1595 kbdc_lock(sc->kbdc, FALSE);
1600 * The device may be in the middle of status data transmission.
1601 * The transmission will be interrupted, thus, incomplete status
1602 * data must be discarded. Although the aux interrupt is disabled
1603 * at the keyboard controller level, at most one aux interrupt
1604 * may have already been pending and a data byte is in the
1605 * output buffer; throw it away. Note that the second argument
1606 * to `empty_aux_buffer()' is zero, so that the call will just
1607 * flush the internal queue.
1608 * `psmintr()' will be invoked after `splx()' if an interrupt is
1609 * pending; it will see no data and returns immediately.
1611 empty_aux_buffer(sc->kbdc, 0); /* flush the queue */
1612 read_aux_data_no_wait(sc->kbdc); /* throw away data if any */
1620 unblock_mouse_data(struct psm_softc *sc, int c)
1625 * We may have seen a part of status data during `set_mouse_XXX()'.
1626 * they have been queued; flush it.
1628 empty_aux_buffer(sc->kbdc, 0);
1630 /* restore ports and interrupt */
1631 if (!set_controller_command_byte(sc->kbdc,
1632 kbdc_get_device_mask(sc->kbdc),
1633 c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
1634 /* CONTROLLER ERROR; this is serious, we may have
1635 * been left with the inaccessible keyboard and
1636 * the disabled mouse interrupt.
1641 kbdc_lock(sc->kbdc, FALSE);
1646 psmioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
1648 struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
1650 mousestatus_t status;
1651 #if (defined(MOUSE_GETVARS))
1659 /* Perform IOCTL command */
1662 case OLD_MOUSE_GETHWINFO:
1664 ((old_mousehw_t *)addr)->buttons = sc->hw.buttons;
1665 ((old_mousehw_t *)addr)->iftype = sc->hw.iftype;
1666 ((old_mousehw_t *)addr)->type = sc->hw.type;
1667 ((old_mousehw_t *)addr)->hwid = sc->hw.hwid & 0x00ff;
1671 case MOUSE_GETHWINFO:
1673 *(mousehw_t *)addr = sc->hw;
1674 if (sc->mode.level == PSM_LEVEL_BASE)
1675 ((mousehw_t *)addr)->model = MOUSE_MODEL_GENERIC;
1679 case OLD_MOUSE_GETMODE:
1681 switch (sc->mode.level) {
1682 case PSM_LEVEL_BASE:
1683 ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1685 case PSM_LEVEL_STANDARD:
1686 ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
1688 case PSM_LEVEL_NATIVE:
1689 ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1692 ((old_mousemode_t *)addr)->rate = sc->mode.rate;
1693 ((old_mousemode_t *)addr)->resolution = sc->mode.resolution;
1694 ((old_mousemode_t *)addr)->accelfactor = sc->mode.accelfactor;
1700 *(mousemode_t *)addr = sc->mode;
1701 ((mousemode_t *)addr)->resolution =
1702 MOUSE_RES_LOW - sc->mode.resolution;
1703 switch (sc->mode.level) {
1704 case PSM_LEVEL_BASE:
1705 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1706 ((mousemode_t *)addr)->packetsize = MOUSE_PS2_PACKETSIZE;
1708 case PSM_LEVEL_STANDARD:
1709 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
1710 ((mousemode_t *)addr)->packetsize = MOUSE_SYS_PACKETSIZE;
1711 ((mousemode_t *)addr)->syncmask[0] = MOUSE_SYS_SYNCMASK;
1712 ((mousemode_t *)addr)->syncmask[1] = MOUSE_SYS_SYNC;
1714 case PSM_LEVEL_NATIVE:
1715 /* FIXME: this isn't quite correct... XXX */
1716 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1722 case OLD_MOUSE_SETMODE:
1724 if (cmd == OLD_MOUSE_SETMODE) {
1725 mode.rate = ((old_mousemode_t *)addr)->rate;
1727 * resolution old I/F new I/F
1734 if (((old_mousemode_t *)addr)->resolution > 0)
1735 mode.resolution = -((old_mousemode_t *)addr)->resolution - 1;
1736 mode.accelfactor = ((old_mousemode_t *)addr)->accelfactor;
1739 mode = *(mousemode_t *)addr;
1742 /* adjust and validate parameters. */
1743 if (mode.rate > UCHAR_MAX)
1746 mode.rate = sc->dflt_mode.rate;
1747 else if (mode.rate == -1)
1748 /* don't change the current setting */
1750 else if (mode.rate < 0)
1752 if (mode.resolution >= UCHAR_MAX)
1754 if (mode.resolution >= 200)
1755 mode.resolution = MOUSE_RES_HIGH;
1756 else if (mode.resolution >= 100)
1757 mode.resolution = MOUSE_RES_MEDIUMHIGH;
1758 else if (mode.resolution >= 50)
1759 mode.resolution = MOUSE_RES_MEDIUMLOW;
1760 else if (mode.resolution > 0)
1761 mode.resolution = MOUSE_RES_LOW;
1762 if (mode.resolution == MOUSE_RES_DEFAULT)
1763 mode.resolution = sc->dflt_mode.resolution;
1764 else if (mode.resolution == -1)
1765 /* don't change the current setting */
1767 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
1768 mode.resolution = MOUSE_RES_LOW - mode.resolution;
1769 if (mode.level == -1)
1770 /* don't change the current setting */
1771 mode.level = sc->mode.level;
1772 else if ((mode.level < PSM_LEVEL_MIN) || (mode.level > PSM_LEVEL_MAX))
1774 if (mode.accelfactor == -1)
1775 /* don't change the current setting */
1776 mode.accelfactor = sc->mode.accelfactor;
1777 else if (mode.accelfactor < 0)
1780 /* don't allow anybody to poll the keyboard controller */
1781 error = block_mouse_data(sc, &command_byte);
1785 /* set mouse parameters */
1787 mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
1788 if (mode.resolution >= 0)
1789 mode.resolution = set_mouse_resolution(sc->kbdc, mode.resolution);
1790 set_mouse_scaling(sc->kbdc, 1);
1791 get_mouse_status(sc->kbdc, stat, 0, 3);
1794 sc->mode.rate = mode.rate;
1795 sc->mode.resolution = mode.resolution;
1796 sc->mode.accelfactor = mode.accelfactor;
1797 sc->mode.level = mode.level;
1800 unblock_mouse_data(sc, command_byte);
1803 case MOUSE_GETLEVEL:
1804 *(int *)addr = sc->mode.level;
1807 case MOUSE_SETLEVEL:
1808 if ((*(int *)addr < PSM_LEVEL_MIN) || (*(int *)addr > PSM_LEVEL_MAX))
1810 sc->mode.level = *(int *)addr;
1813 case MOUSE_GETSTATUS:
1815 status = sc->status;
1816 sc->status.flags = 0;
1817 sc->status.obutton = sc->status.button;
1818 sc->status.button = 0;
1823 *(mousestatus_t *)addr = status;
1826 #if (defined(MOUSE_GETVARS))
1828 var = (mousevar_t *)addr;
1829 bzero(var, sizeof(*var));
1831 var->var[0] = MOUSE_VARS_PS2_SIG;
1832 var->var[1] = sc->config;
1833 var->var[2] = sc->flags;
1839 #endif /* MOUSE_GETVARS */
1841 case MOUSE_READSTATE:
1842 case MOUSE_READDATA:
1843 data = (mousedata_t *)addr;
1844 if (data->len > sizeof(data->buf)/sizeof(data->buf[0]))
1847 error = block_mouse_data(sc, &command_byte);
1850 if ((data->len = get_mouse_status(sc->kbdc, data->buf,
1851 (cmd == MOUSE_READDATA) ? 1 : 0, data->len)) <= 0)
1853 unblock_mouse_data(sc, command_byte);
1856 #if (defined(MOUSE_SETRESOLUTION))
1857 case MOUSE_SETRESOLUTION:
1858 mode.resolution = *(int *)addr;
1859 if (mode.resolution >= UCHAR_MAX)
1861 else if (mode.resolution >= 200)
1862 mode.resolution = MOUSE_RES_HIGH;
1863 else if (mode.resolution >= 100)
1864 mode.resolution = MOUSE_RES_MEDIUMHIGH;
1865 else if (mode.resolution >= 50)
1866 mode.resolution = MOUSE_RES_MEDIUMLOW;
1867 else if (mode.resolution > 0)
1868 mode.resolution = MOUSE_RES_LOW;
1869 if (mode.resolution == MOUSE_RES_DEFAULT)
1870 mode.resolution = sc->dflt_mode.resolution;
1871 else if (mode.resolution == -1)
1872 mode.resolution = sc->mode.resolution;
1873 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
1874 mode.resolution = MOUSE_RES_LOW - mode.resolution;
1876 error = block_mouse_data(sc, &command_byte);
1879 sc->mode.resolution = set_mouse_resolution(sc->kbdc, mode.resolution);
1880 if (sc->mode.resolution != mode.resolution)
1882 unblock_mouse_data(sc, command_byte);
1884 #endif /* MOUSE_SETRESOLUTION */
1886 #if (defined(MOUSE_SETRATE))
1888 mode.rate = *(int *)addr;
1889 if (mode.rate > UCHAR_MAX)
1892 mode.rate = sc->dflt_mode.rate;
1893 else if (mode.rate < 0)
1894 mode.rate = sc->mode.rate;
1896 error = block_mouse_data(sc, &command_byte);
1899 sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
1900 if (sc->mode.rate != mode.rate)
1902 unblock_mouse_data(sc, command_byte);
1904 #endif /* MOUSE_SETRATE */
1906 #if (defined(MOUSE_SETSCALING))
1907 case MOUSE_SETSCALING:
1908 if ((*(int *)addr <= 0) || (*(int *)addr > 2))
1911 error = block_mouse_data(sc, &command_byte);
1914 if (!set_mouse_scaling(sc->kbdc, *(int *)addr))
1916 unblock_mouse_data(sc, command_byte);
1918 #endif /* MOUSE_SETSCALING */
1920 #if (defined(MOUSE_GETHWID))
1922 error = block_mouse_data(sc, &command_byte);
1925 sc->hw.hwid &= ~0x00ff;
1926 sc->hw.hwid |= get_aux_id(sc->kbdc);
1927 *(int *)addr = sc->hw.hwid & 0x00ff;
1928 unblock_mouse_data(sc, command_byte);
1930 #endif /* MOUSE_GETHWID */
1940 psmtimeout(void *arg)
1942 struct psm_softc *sc;
1944 sc = (struct psm_softc *)arg;
1946 if (sc->watchdog && kbdc_lock(sc->kbdc, TRUE)) {
1948 log(LOG_DEBUG, "psm%d: lost interrupt?\n", sc->unit);
1950 kbdc_lock(sc->kbdc, FALSE);
1952 sc->watchdog = TRUE;
1953 callout_reset(&sc->callout, hz, psmtimeout, (void *)(uintptr_t)sc);
1961 * the table to turn PS/2 mouse button bits (MOUSE_PS2_BUTTON?DOWN)
1962 * into `mousestatus' button bits (MOUSE_BUTTON?DOWN).
1964 static int butmap[8] = {
1968 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1970 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN,
1971 MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN,
1972 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN
1974 static int butmap_versapad[8] = {
1980 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1982 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN
1984 struct psm_softc *sc = arg;
1992 /* read until there is nothing to read */
1993 while((c = read_aux_data_no_wait(sc->kbdc)) != -1) {
1995 /* discard the byte if the device is not open */
1996 if ((sc->state & PSM_OPEN) == 0)
1999 getmicrouptime(&tv);
2000 if ((sc->inputbytes > 0) && timevalcmp(&tv, &sc->inputtimeout, >)) {
2001 log(LOG_DEBUG, "psmintr: delay too long; resetting byte count\n");
2005 sc->inputtimeout.tv_sec = PSM_INPUT_TIMEOUT/1000000;
2006 sc->inputtimeout.tv_usec = PSM_INPUT_TIMEOUT%1000000;
2007 timevaladd(&sc->inputtimeout, &tv);
2009 sc->ipacket[sc->inputbytes++] = c;
2010 if (sc->inputbytes < sc->mode.packetsize)
2014 log(LOG_DEBUG, "psmintr: %02x %02x %02x %02x %02x %02x\n",
2015 sc->ipacket[0], sc->ipacket[1], sc->ipacket[2],
2016 sc->ipacket[3], sc->ipacket[4], sc->ipacket[5]);
2021 if ((c & sc->mode.syncmask[0]) != sc->mode.syncmask[1]) {
2022 log(LOG_DEBUG, "psmintr: out of sync (%04x != %04x).\n",
2023 c & sc->mode.syncmask[0], sc->mode.syncmask[1]);
2025 if (sc->syncerrors < sc->mode.packetsize) {
2026 log(LOG_DEBUG, "psmintr: discard a byte (%d).\n", sc->syncerrors);
2028 bcopy(&sc->ipacket[1], &sc->ipacket[0], sc->inputbytes);
2029 } else if (sc->syncerrors == sc->mode.packetsize) {
2030 log(LOG_DEBUG, "psmintr: re-enable the mouse.\n");
2032 disable_aux_dev(sc->kbdc);
2033 enable_aux_dev(sc->kbdc);
2034 } else if (sc->syncerrors < PSM_SYNCERR_THRESHOLD1) {
2035 log(LOG_DEBUG, "psmintr: discard a byte (%d).\n", sc->syncerrors);
2037 bcopy(&sc->ipacket[1], &sc->ipacket[0], sc->inputbytes);
2038 } else if (sc->syncerrors >= PSM_SYNCERR_THRESHOLD1) {
2039 log(LOG_DEBUG, "psmintr: reset the mouse.\n");
2040 reinitialize(sc, TRUE);
2046 * A kludge for Kensington device!
2047 * The MSB of the horizontal count appears to be stored in
2050 if (sc->hw.model == MOUSE_MODEL_THINK)
2051 sc->ipacket[1] |= (c & MOUSE_PS2_XOVERFLOW) ? 0x80 : 0;
2053 /* ignore the overflow bits... */
2054 x = (c & MOUSE_PS2_XNEG) ? sc->ipacket[1] - 256 : sc->ipacket[1];
2055 y = (c & MOUSE_PS2_YNEG) ? sc->ipacket[2] - 256 : sc->ipacket[2];
2057 ms.obutton = sc->button; /* previous button state */
2058 ms.button = butmap[c & MOUSE_PS2_BUTTONS];
2059 /* `tapping' action */
2060 if (sc->config & PSM_CONFIG_FORCETAP)
2061 ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 : MOUSE_BUTTON4DOWN;
2063 switch (sc->hw.model) {
2065 case MOUSE_MODEL_EXPLORER:
2067 * b7 b6 b5 b4 b3 b2 b1 b0
2068 * byte 1: oy ox sy sx 1 M R L
2069 * byte 2: x x x x x x x x
2070 * byte 3: y y y y y y y y
2071 * byte 4: * * S2 S1 s d2 d1 d0
2073 * L, M, R, S1, S2: left, middle, right and side buttons
2074 * s: wheel data sign bit
2077 z = (sc->ipacket[3] & MOUSE_EXPLORER_ZNEG)
2078 ? (sc->ipacket[3] & 0x0f) - 16 : (sc->ipacket[3] & 0x0f);
2079 ms.button |= (sc->ipacket[3] & MOUSE_EXPLORER_BUTTON4DOWN)
2080 ? MOUSE_BUTTON4DOWN : 0;
2081 ms.button |= (sc->ipacket[3] & MOUSE_EXPLORER_BUTTON5DOWN)
2082 ? MOUSE_BUTTON5DOWN : 0;
2085 case MOUSE_MODEL_INTELLI:
2086 case MOUSE_MODEL_NET:
2087 /* wheel data is in the fourth byte */
2088 z = (char)sc->ipacket[3];
2089 /* some mice may send 7 when there is no Z movement?! XXX */
2090 if ((z >= 7) || (z <= -7))
2092 /* some compatible mice have additional buttons */
2093 ms.button |= (c & MOUSE_PS2INTELLI_BUTTON4DOWN)
2094 ? MOUSE_BUTTON4DOWN : 0;
2095 ms.button |= (c & MOUSE_PS2INTELLI_BUTTON5DOWN)
2096 ? MOUSE_BUTTON5DOWN : 0;
2099 case MOUSE_MODEL_MOUSEMANPLUS:
2101 * PS2++ protocl packet
2103 * b7 b6 b5 b4 b3 b2 b1 b0
2104 * byte 1: * 1 p3 p2 1 * * *
2105 * byte 2: c1 c2 p1 p0 d1 d0 1 0
2107 * p3-p0: packet type
2108 * c1, c2: c1 & c2 == 1, if p2 == 0
2109 * c1 & c2 == 0, if p2 == 1
2111 * packet type: 0 (device type)
2112 * See comments in enable_mmanplus() below.
2114 * packet type: 1 (wheel data)
2116 * b7 b6 b5 b4 b3 b2 b1 b0
2117 * byte 3: h * B5 B4 s d2 d1 d0
2119 * h: 1, if horizontal roller data
2120 * 0, if vertical roller data
2121 * B4, B5: button 4 and 5
2123 * d2-d0: roller data
2125 * packet type: 2 (reserved)
2127 if (((c & MOUSE_PS2PLUS_SYNCMASK) == MOUSE_PS2PLUS_SYNC)
2129 && MOUSE_PS2PLUS_CHECKBITS(sc->ipacket)) {
2130 /* the extended data packet encodes button and wheel events */
2131 switch (MOUSE_PS2PLUS_PACKET_TYPE(sc->ipacket)) {
2133 /* wheel data packet */
2135 if (sc->ipacket[2] & 0x80) {
2136 /* horizontal roller count - ignore it XXX*/
2138 /* vertical roller count */
2139 z = (sc->ipacket[2] & MOUSE_PS2PLUS_ZNEG)
2140 ? (sc->ipacket[2] & 0x0f) - 16
2141 : (sc->ipacket[2] & 0x0f);
2143 ms.button |= (sc->ipacket[2] & MOUSE_PS2PLUS_BUTTON4DOWN)
2144 ? MOUSE_BUTTON4DOWN : 0;
2145 ms.button |= (sc->ipacket[2] & MOUSE_PS2PLUS_BUTTON5DOWN)
2146 ? MOUSE_BUTTON5DOWN : 0;
2149 /* this packet type is reserved by Logitech... */
2151 * IBM ScrollPoint Mouse uses this packet type to
2152 * encode both vertical and horizontal scroll movement.
2155 /* horizontal count */
2156 if (sc->ipacket[2] & 0x0f)
2157 z = (sc->ipacket[2] & MOUSE_SPOINT_WNEG) ? -2 : 2;
2158 /* vertical count */
2159 if (sc->ipacket[2] & 0xf0)
2160 z = (sc->ipacket[2] & MOUSE_SPOINT_ZNEG) ? -1 : 1;
2162 /* vertical count */
2163 z = (sc->ipacket[2] & MOUSE_SPOINT_ZNEG)
2164 ? ((sc->ipacket[2] >> 4) & 0x0f) - 16
2165 : ((sc->ipacket[2] >> 4) & 0x0f);
2166 /* horizontal count */
2167 w = (sc->ipacket[2] & MOUSE_SPOINT_WNEG)
2168 ? (sc->ipacket[2] & 0x0f) - 16
2169 : (sc->ipacket[2] & 0x0f);
2173 /* device type packet - shouldn't happen */
2177 ms.button = ms.obutton;
2179 log(LOG_DEBUG, "psmintr: unknown PS2++ packet type %d: "
2180 "0x%02x 0x%02x 0x%02x\n",
2181 MOUSE_PS2PLUS_PACKET_TYPE(sc->ipacket),
2182 sc->ipacket[0], sc->ipacket[1], sc->ipacket[2]);
2186 /* preserve button states */
2187 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
2191 case MOUSE_MODEL_GLIDEPOINT:
2192 /* `tapping' action */
2193 ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 : MOUSE_BUTTON4DOWN;
2196 case MOUSE_MODEL_NETSCROLL:
2197 /* three addtional bytes encode buttons and wheel events */
2198 ms.button |= (sc->ipacket[3] & MOUSE_PS2_BUTTON3DOWN)
2199 ? MOUSE_BUTTON4DOWN : 0;
2200 ms.button |= (sc->ipacket[3] & MOUSE_PS2_BUTTON1DOWN)
2201 ? MOUSE_BUTTON5DOWN : 0;
2202 z = (sc->ipacket[3] & MOUSE_PS2_XNEG)
2203 ? sc->ipacket[4] - 256 : sc->ipacket[4];
2206 case MOUSE_MODEL_THINK:
2207 /* the fourth button state in the first byte */
2208 ms.button |= (c & MOUSE_PS2_TAP) ? MOUSE_BUTTON4DOWN : 0;
2211 case MOUSE_MODEL_VERSAPAD:
2212 /* VersaPad PS/2 absolute mode message format
2214 * [packet1] 7 6 5 4 3 2 1 0(LSB)
2215 * ipacket[0]: 1 1 0 A 1 L T R
2216 * ipacket[1]: H7 H6 H5 H4 H3 H2 H1 H0
2217 * ipacket[2]: V7 V6 V5 V4 V3 V2 V1 V0
2218 * ipacket[3]: 1 1 1 A 1 L T R
2219 * ipacket[4]:V11 V10 V9 V8 H11 H10 H9 H8
2220 * ipacket[5]: 0 P6 P5 P4 P3 P2 P1 P0
2223 * R: right physical mouse button (1=on)
2224 * T: touch pad virtual button (1=tapping)
2225 * L: left physical mouse button (1=on)
2226 * A: position data is valid (1=valid)
2227 * H: horizontal data (12bit signed integer. H11 is sign bit.)
2228 * V: vertical data (12bit signed integer. V11 is sign bit.)
2231 * Tapping is mapped to MOUSE_BUTTON4.
2233 ms.button = butmap_versapad[c & MOUSE_PS2VERSA_BUTTONS];
2234 ms.button |= (c & MOUSE_PS2VERSA_TAP) ? MOUSE_BUTTON4DOWN : 0;
2236 if (c & MOUSE_PS2VERSA_IN_USE) {
2237 x0 = sc->ipacket[1] | (((sc->ipacket[4]) & 0x0f) << 8);
2238 y0 = sc->ipacket[2] | (((sc->ipacket[4]) & 0xf0) << 4);
2243 if (sc->flags & PSM_FLAGS_FINGERDOWN) {
2246 if (x < 0) /* XXX */
2255 sc->flags |= PSM_FLAGS_FINGERDOWN;
2260 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
2262 c = ((x < 0) ? MOUSE_PS2_XNEG : 0)
2263 | ((y < 0) ? MOUSE_PS2_YNEG : 0);
2266 case MOUSE_MODEL_4D:
2268 * b7 b6 b5 b4 b3 b2 b1 b0
2269 * byte 1: s2 d2 s1 d1 1 M R L
2270 * byte 2: sx x x x x x x x
2271 * byte 3: sy y y y y y y y
2273 * s1: wheel 1 direction
2275 * s2: wheel 2 direction
2278 x = (sc->ipacket[1] & 0x80) ? sc->ipacket[1] - 256 : sc->ipacket[1];
2279 y = (sc->ipacket[2] & 0x80) ? sc->ipacket[2] - 256 : sc->ipacket[2];
2280 switch (c & MOUSE_4D_WHEELBITS) {
2287 case 0x40: /* 2nd wheel turning right XXX */
2290 case 0xc0: /* 2nd wheel turning left XXX */
2296 case MOUSE_MODEL_4DPLUS:
2297 if ((x < 16 - 256) && (y < 16 - 256)) {
2299 * b7 b6 b5 b4 b3 b2 b1 b0
2300 * byte 1: 0 0 1 1 1 M R L
2301 * byte 2: 0 0 0 0 1 0 0 0
2302 * byte 3: 0 0 0 0 S s d1 d0
2304 * L, M, R, S: left, middle, right and side buttons
2305 * s: wheel data sign bit
2309 if (sc->ipacket[2] & MOUSE_4DPLUS_BUTTON4DOWN)
2310 ms.button |= MOUSE_BUTTON4DOWN;
2311 z = (sc->ipacket[2] & MOUSE_4DPLUS_ZNEG)
2312 ? ((sc->ipacket[2] & 0x07) - 8)
2313 : (sc->ipacket[2] & 0x07) ;
2315 /* preserve previous button states */
2316 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
2320 case MOUSE_MODEL_GENERIC:
2326 if (sc->mode.accelfactor >= 1) {
2328 x = x * x / sc->mode.accelfactor;
2331 if (c & MOUSE_PS2_XNEG)
2335 y = y * y / sc->mode.accelfactor;
2338 if (c & MOUSE_PS2_YNEG)
2346 ms.flags = ((x || y || z) ? MOUSE_POSCHANGED : 0)
2347 | (ms.obutton ^ ms.button);
2349 if (sc->mode.level < PSM_LEVEL_NATIVE)
2350 sc->inputbytes = tame_mouse(sc, &ms, sc->ipacket);
2352 sc->status.flags |= ms.flags;
2353 sc->status.dx += ms.dx;
2354 sc->status.dy += ms.dy;
2355 sc->status.dz += ms.dz;
2356 sc->status.button = ms.button;
2357 sc->button = ms.button;
2359 sc->watchdog = FALSE;
2362 if (sc->queue.count + sc->inputbytes < sizeof(sc->queue.buf)) {
2363 l = min(sc->inputbytes, sizeof(sc->queue.buf) - sc->queue.tail);
2364 bcopy(&sc->ipacket[0], &sc->queue.buf[sc->queue.tail], l);
2365 if (sc->inputbytes > l)
2366 bcopy(&sc->ipacket[l], &sc->queue.buf[0], sc->inputbytes - l);
2368 (sc->queue.tail + sc->inputbytes) % sizeof(sc->queue.buf);
2369 sc->queue.count += sc->inputbytes;
2373 if (sc->state & PSM_ASLP) {
2374 sc->state &= ~PSM_ASLP;
2375 wakeup((caddr_t) sc);
2377 selwakeup(&sc->rsel);
2382 psmpoll(dev_t dev, int events, struct thread *td)
2384 struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
2387 /* Return true if a mouse event available */
2389 if (events & (POLLIN | POLLRDNORM)) {
2390 if (sc->queue.count > 0)
2391 revents |= events & (POLLIN | POLLRDNORM);
2393 selrecord(td, &sc->rsel);
2400 /* vendor/model specific routines */
2402 static int mouse_id_proc1(KBDC kbdc, int res, int scale, int *status)
2404 if (set_mouse_resolution(kbdc, res) != res)
2406 if (set_mouse_scaling(kbdc, scale)
2407 && set_mouse_scaling(kbdc, scale)
2408 && set_mouse_scaling(kbdc, scale)
2409 && (get_mouse_status(kbdc, status, 0, 3) >= 3))
2415 mouse_ext_command(KBDC kbdc, int command)
2419 c = (command >> 6) & 0x03;
2420 if (set_mouse_resolution(kbdc, c) != c)
2422 c = (command >> 4) & 0x03;
2423 if (set_mouse_resolution(kbdc, c) != c)
2425 c = (command >> 2) & 0x03;
2426 if (set_mouse_resolution(kbdc, c) != c)
2428 c = (command >> 0) & 0x03;
2429 if (set_mouse_resolution(kbdc, c) != c)
2435 /* Logitech MouseMan Cordless II */
2437 enable_lcordless(struct psm_softc *sc)
2442 if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 2, status))
2444 if (status[1] == PSMD_RES_HIGH)
2446 ch = (status[0] & 0x07) - 1; /* channel # */
2447 if ((ch <= 0) || (ch > 4))
2450 * status[1]: always one?
2451 * status[2]: battery status? (0-100)
2457 /* Genius NetScroll Mouse, MouseSystems SmartScroll Mouse */
2459 enable_groller(struct psm_softc *sc)
2464 * The special sequence to enable the fourth button and the
2465 * roller. Immediately after this sequence check status bytes.
2466 * if the mouse is NetScroll, the second and the third bytes are
2471 * If the mouse is an ordinary PS/2 mouse, the status bytes should
2472 * look like the following.
2474 * byte 1 bit 7 always 0
2475 * bit 6 stream mode (0)
2476 * bit 5 disabled (0)
2477 * bit 4 1:1 scaling (0)
2479 * bit 0-2 button status
2480 * byte 2 resolution (PSMD_RES_HIGH)
2481 * byte 3 report rate (?)
2484 if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 1, status))
2486 if ((status[1] != '3') || (status[2] != 'D'))
2488 /* FIXME: SmartScroll Mouse has 5 buttons! XXX */
2493 /* Genius NetMouse/NetMouse Pro, ASCII Mie Mouse, NetScroll Optical */
2495 enable_gmouse(struct psm_softc *sc)
2500 * The special sequence to enable the middle, "rubber" button.
2501 * Immediately after this sequence check status bytes.
2502 * if the mouse is NetMouse, NetMouse Pro, or ASCII MIE Mouse,
2503 * the second and the third bytes are '3' and 'U'.
2504 * NOTE: NetMouse reports that it has three buttons although it has
2505 * two buttons and a rubber button. NetMouse Pro and MIE Mouse
2506 * say they have three buttons too and they do have a button on the
2509 if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 1, status))
2511 if ((status[1] != '3') || (status[2] != 'U'))
2516 /* ALPS GlidePoint */
2518 enable_aglide(struct psm_softc *sc)
2523 * The special sequence to obtain ALPS GlidePoint specific
2524 * information. Immediately after this sequence, status bytes will
2525 * contain something interesting.
2526 * NOTE: ALPS produces several models of GlidePoint. Some of those
2527 * do not respond to this sequence, thus, cannot be detected this way.
2529 if (set_mouse_sampling_rate(sc->kbdc, 100) != 100)
2531 if (!mouse_id_proc1(sc->kbdc, PSMD_RES_LOW, 2, status))
2533 if ((status[1] == PSMD_RES_LOW) || (status[2] == 100))
2538 /* Kensington ThinkingMouse/Trackball */
2540 enable_kmouse(struct psm_softc *sc)
2542 static unsigned char rate[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20 };
2543 KBDC kbdc = sc->kbdc;
2549 id1 = get_aux_id(kbdc);
2550 if (set_mouse_sampling_rate(kbdc, 10) != 10)
2553 * The device is now in the native mode? It returns a different
2556 id2 = get_aux_id(kbdc);
2557 if ((id1 == id2) || (id2 != 2))
2560 if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
2563 /* at this point, resolution is LOW, sampling rate is 10/sec */
2564 if (get_mouse_status(kbdc, status, 0, 3) < 3)
2569 * The special sequence to enable the third and fourth buttons.
2570 * Otherwise they behave like the first and second buttons.
2572 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2573 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2578 * At this point, the device is using default resolution and
2579 * sampling rate for the native mode.
2581 if (get_mouse_status(kbdc, status, 0, 3) < 3)
2583 if ((status[1] == PSMD_RES_LOW) || (status[2] == rate[i - 1]))
2586 /* the device appears be enabled by this sequence, diable it for now */
2587 disable_aux_dev(kbdc);
2588 empty_aux_buffer(kbdc, 5);
2593 /* Logitech MouseMan+/FirstMouse+, IBM ScrollPoint Mouse */
2595 enable_mmanplus(struct psm_softc *sc)
2597 KBDC kbdc = sc->kbdc;
2600 /* the special sequence to enable the fourth button and the roller. */
2602 * NOTE: for ScrollPoint to respond correctly, the SET_RESOLUTION
2603 * must be called exactly three times since the last RESET command
2604 * before this sequence. XXX
2606 if (!set_mouse_scaling(kbdc, 1))
2608 if (!mouse_ext_command(kbdc, 0x39) || !mouse_ext_command(kbdc, 0xdb))
2610 if (get_mouse_status(kbdc, data, 1, 3) < 3)
2614 * PS2++ protocl, packet type 0
2616 * b7 b6 b5 b4 b3 b2 b1 b0
2617 * byte 1: * 1 p3 p2 1 * * *
2618 * byte 2: 1 1 p1 p0 m1 m0 1 0
2619 * byte 3: m7 m6 m5 m4 m3 m2 m1 m0
2621 * p3-p0: packet type: 0
2622 * m7-m0: model ID: MouseMan+:0x50, FirstMouse+:0x51, ScrollPoint:0x58...
2624 /* check constant bits */
2625 if ((data[0] & MOUSE_PS2PLUS_SYNCMASK) != MOUSE_PS2PLUS_SYNC)
2627 if ((data[1] & 0xc3) != 0xc2)
2629 /* check d3-d0 in byte 2 */
2630 if (!MOUSE_PS2PLUS_CHECKBITS(data))
2633 if (MOUSE_PS2PLUS_PACKET_TYPE(data) != 0)
2636 sc->hw.hwid &= 0x00ff;
2637 sc->hw.hwid |= data[2] << 8; /* save model ID */
2640 * MouseMan+ (or FirstMouse+) is now in its native mode, in which
2641 * the wheel and the fourth button events are encoded in the
2642 * special data packet. The mouse may be put in the IntelliMouse mode
2643 * if it is initialized by the IntelliMouse's method.
2648 /* MS IntelliMouse Explorer */
2650 enable_msexplorer(struct psm_softc *sc)
2652 static unsigned char rate0[] = { 200, 100, 80, };
2653 static unsigned char rate1[] = { 200, 200, 80, };
2654 KBDC kbdc = sc->kbdc;
2658 /* the special sequence to enable the extra buttons and the roller. */
2659 for (i = 0; i < sizeof(rate1)/sizeof(rate1[0]); ++i) {
2660 if (set_mouse_sampling_rate(kbdc, rate1[i]) != rate1[i])
2663 /* the device will give the genuine ID only after the above sequence */
2664 id = get_aux_id(kbdc);
2665 if (id != PSM_EXPLORER_ID)
2669 sc->hw.buttons = 5; /* IntelliMouse Explorer XXX */
2672 * XXX: this is a kludge to fool some KVM switch products
2673 * which think they are clever enough to know the 4-byte IntelliMouse
2674 * protocol, and assume any other protocols use 3-byte packets.
2675 * They don't convey 4-byte data packets from the IntelliMouse Explorer
2676 * correctly to the host computer because of this!
2677 * The following sequence is actually IntelliMouse's "wake up"
2678 * sequence; it will make the KVM think the mouse is IntelliMouse
2679 * when it is in fact IntelliMouse Explorer.
2681 for (i = 0; i < sizeof(rate0)/sizeof(rate0[0]); ++i) {
2682 if (set_mouse_sampling_rate(kbdc, rate0[i]) != rate0[i])
2685 id = get_aux_id(kbdc);
2690 /* MS IntelliMouse */
2692 enable_msintelli(struct psm_softc *sc)
2695 * Logitech MouseMan+ and FirstMouse+ will also respond to this
2696 * probe routine and act like IntelliMouse.
2699 static unsigned char rate[] = { 200, 100, 80, };
2700 KBDC kbdc = sc->kbdc;
2704 /* the special sequence to enable the third button and the roller. */
2705 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2706 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2709 /* the device will give the genuine ID only after the above sequence */
2710 id = get_aux_id(kbdc);
2711 if (id != PSM_INTELLI_ID)
2720 /* A4 Tech 4D Mouse */
2722 enable_4dmouse(struct psm_softc *sc)
2725 * Newer wheel mice from A4 Tech may use the 4D+ protocol.
2728 static unsigned char rate[] = { 200, 100, 80, 60, 40, 20 };
2729 KBDC kbdc = sc->kbdc;
2733 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2734 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2737 id = get_aux_id(kbdc);
2739 * WinEasy 4D, 4 Way Scroll 4D: 6
2740 * Cable-Free 4D: 8 (4DPLUS)
2741 * WinBest 4D+, 4 Way Scroll 4D+: 8 (4DPLUS)
2743 if (id != PSM_4DMOUSE_ID)
2747 sc->hw.buttons = 3; /* XXX some 4D mice have 4? */
2752 /* A4 Tech 4D+ Mouse */
2754 enable_4dplus(struct psm_softc *sc)
2757 * Newer wheel mice from A4 Tech seem to use this protocol.
2758 * Older models are recognized as either 4D Mouse or IntelliMouse.
2760 KBDC kbdc = sc->kbdc;
2764 * enable_4dmouse() already issued the following ID sequence...
2765 static unsigned char rate[] = { 200, 100, 80, 60, 40, 20 };
2768 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2769 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2774 id = get_aux_id(kbdc);
2775 if (id != PSM_4DPLUS_ID)
2779 sc->hw.buttons = 4; /* XXX */
2784 /* Interlink electronics VersaPad */
2786 enable_versapad(struct psm_softc *sc)
2788 KBDC kbdc = sc->kbdc;
2791 set_mouse_resolution(kbdc, PSMD_RES_MEDIUM_HIGH); /* set res. 2 */
2792 set_mouse_sampling_rate(kbdc, 100); /* set rate 100 */
2793 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
2794 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
2795 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
2796 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
2797 if (get_mouse_status(kbdc, data, 0, 3) < 3) /* get status */
2799 if (data[2] != 0xa || data[1] != 0 ) /* rate == 0xa && res. == 0 */
2801 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
2803 sc->config |= PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND;
2805 return TRUE; /* PS/2 absolute mode */
2809 psmresume(device_t dev)
2811 struct psm_softc *sc = device_get_softc(dev);
2812 int unit = device_get_unit(dev);
2816 log(LOG_NOTICE, "psm%d: system resume hook called.\n", unit);
2818 if (!(sc->config & PSM_CONFIG_HOOKRESUME))
2821 err = reinitialize(sc, sc->config & PSM_CONFIG_INITAFTERSUSPEND);
2823 if ((sc->state & PSM_ASLP) && !(sc->state & PSM_VALID)) {
2825 * Release the blocked process; it must be notified that the device
2826 * cannot be accessed anymore.
2828 sc->state &= ~PSM_ASLP;
2829 wakeup((caddr_t)sc);
2833 log(LOG_DEBUG, "psm%d: system resume hook exiting.\n", unit);
2838 DRIVER_MODULE(psm, atkbdc, psm_driver, psm_devclass, 0, 0);