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.20 2006/09/10 01:26:34 dillon 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>
73 #include <sys/device.h>
75 #include <sys/syslog.h>
76 #include <sys/malloc.h>
77 #include <machine/bus.h>
79 #include <sys/selinfo.h>
80 #include <sys/thread2.h>
84 #include <machine/clock.h>
85 #include <machine/limits.h>
86 #include <machine/mouse.h>
87 #include <machine/resource.h>
89 #include <bus/isa/isavar.h>
90 #include <dev/misc/kbd/atkbdcreg.h>
93 * Driver specific options: the following options may be set by
94 * `options' statements in the kernel configuration file.
99 #define PSM_DEBUG 0 /* logging: 0: none, 1: brief, 2: verbose */
102 #ifndef PSM_SYNCERR_THRESHOLD1
103 #define PSM_SYNCERR_THRESHOLD1 20
106 #ifndef PSM_INPUT_TIMEOUT
107 #define PSM_INPUT_TIMEOUT 2000000 /* 2 sec */
110 /* end of driver specific options */
112 #define PSM_DRIVER_NAME "psm"
113 #define PSMCPNP_DRIVER_NAME "psmcpnp"
116 #define PSM_BUFSIZE 960
117 #define PSM_SMALLBUFSIZE 240
119 /* operation levels */
120 #define PSM_LEVEL_BASE 0
121 #define PSM_LEVEL_STANDARD 1
122 #define PSM_LEVEL_NATIVE 2
123 #define PSM_LEVEL_MIN PSM_LEVEL_BASE
124 #define PSM_LEVEL_MAX PSM_LEVEL_NATIVE
126 /* Logitech PS2++ protocol */
127 #define MOUSE_PS2PLUS_CHECKBITS(b) \
128 ((((b[2] & 0x03) << 2) | 0x02) == (b[1] & 0x0f))
129 #define MOUSE_PS2PLUS_PACKET_TYPE(b) \
130 (((b[0] & 0x30) >> 2) | ((b[1] & 0x30) >> 4))
133 #define PSM_UNIT(dev) (minor(dev) >> 1)
134 #define PSM_NBLOCKIO(dev) (minor(dev) & 1)
135 #define PSM_MKMINOR(unit,block) ((((unit) & 0xff) << 1) | ((block) ? 0:1))
138 #define max(x,y) ((x) > (y) ? (x) : (y))
141 #define min(x,y) ((x) < (y) ? (x) : (y))
144 #define abs(x) (((x) < 0) ? -(x) : (x))
147 typedef struct ringbuf {
148 int count; /* # of valid elements in the buffer */
149 int head; /* head pointer */
150 int tail; /* tail poiner */
151 unsigned char buf[PSM_BUFSIZE];
154 /* driver control block */
155 struct psm_softc { /* Driver status information */
157 struct selinfo rsel; /* Process selecting for Input */
158 unsigned char state; /* Mouse driver state */
159 int config; /* driver configuration flags */
160 int flags; /* other flags */
161 KBDC kbdc; /* handle to access the keyboard controller */
162 struct resource *intr; /* IRQ resource */
163 void *ih; /* interrupt handle */
164 mousehw_t hw; /* hardware information */
165 mousemode_t mode; /* operation mode */
166 mousemode_t dflt_mode; /* default operation mode */
167 mousestatus_t status; /* accumulated mouse movement */
168 ringbuf_t queue; /* mouse status queue */
169 unsigned char ipacket[16]; /* interim input buffer */
170 int inputbytes; /* # of bytes in the input buffer */
171 int button; /* the latest button state */
172 int xold; /* previous absolute X position */
173 int yold; /* previous absolute Y position */
175 struct timeval inputtimeout;
176 int watchdog; /* watchdog timer flag */
177 struct callout callout; /* watchdog timer call out */
179 devclass_t psm_devclass;
180 #define PSM_SOFTC(unit) ((struct psm_softc*)devclass_get_softc(psm_devclass, unit))
182 /* driver state flags (state) */
183 #define PSM_VALID 0x80
184 #define PSM_OPEN 1 /* Device is open */
185 #define PSM_ASLP 2 /* Waiting for mouse data */
187 /* driver configuration flags (config) */
188 #define PSM_CONFIG_RESOLUTION 0x000f /* resolution */
189 #define PSM_CONFIG_ACCEL 0x00f0 /* acceleration factor */
190 #define PSM_CONFIG_NOCHECKSYNC 0x0100 /* disable sync. test */
191 #define PSM_CONFIG_NOIDPROBE 0x0200 /* disable mouse model probe */
192 #define PSM_CONFIG_NORESET 0x0400 /* don't reset the mouse */
193 #define PSM_CONFIG_FORCETAP 0x0800 /* assume `tap' action exists */
194 #define PSM_CONFIG_IGNPORTERROR 0x1000 /* ignore error in aux port test */
195 #define PSM_CONFIG_HOOKRESUME 0x2000 /* hook the system resume event */
196 #define PSM_CONFIG_INITAFTERSUSPEND 0x4000 /* init the device at the resume event */
197 #define PSM_CONFIG_SYNCHACK 0x8000 /* enable `out-of-sync' hack */
199 #define PSM_CONFIG_FLAGS (PSM_CONFIG_RESOLUTION \
201 | PSM_CONFIG_NOCHECKSYNC \
202 | PSM_CONFIG_SYNCHACK \
203 | PSM_CONFIG_NOIDPROBE \
204 | PSM_CONFIG_NORESET \
205 | PSM_CONFIG_FORCETAP \
206 | PSM_CONFIG_IGNPORTERROR \
207 | PSM_CONFIG_HOOKRESUME \
208 | PSM_CONFIG_INITAFTERSUSPEND)
210 /* other flags (flags) */
211 #define PSM_FLAGS_FINGERDOWN 0x0001 /* VersaPad finger down */
213 /* for backward compatibility */
214 #define OLD_MOUSE_GETHWINFO _IOR('M', 1, old_mousehw_t)
215 #define OLD_MOUSE_GETMODE _IOR('M', 2, old_mousemode_t)
216 #define OLD_MOUSE_SETMODE _IOW('M', 3, old_mousemode_t)
218 typedef struct old_mousehw {
225 typedef struct old_mousemode {
232 /* packet formatting function */
233 typedef int packetfunc_t (struct psm_softc *, unsigned char *,
234 int *, int, mousestatus_t *);
236 /* function prototypes */
237 static int psmprobe (device_t);
238 static int psmattach (device_t);
239 static int psmdetach (device_t);
240 static int psmresume (device_t);
242 static d_open_t psmopen;
243 static d_close_t psmclose;
244 static d_read_t psmread;
245 static d_ioctl_t psmioctl;
246 static d_poll_t psmpoll;
248 static int enable_aux_dev (KBDC);
249 static int disable_aux_dev (KBDC);
250 static int get_mouse_status (KBDC, int *, int, int);
251 static int get_aux_id (KBDC);
252 static int set_mouse_sampling_rate (KBDC, int);
253 static int set_mouse_scaling (KBDC, int);
254 static int set_mouse_resolution (KBDC, int);
255 static int set_mouse_mode (KBDC);
256 static int get_mouse_buttons (KBDC);
257 static int is_a_mouse (int);
258 static void recover_from_error (KBDC);
259 static int restore_controller (KBDC, int);
260 static int doinitialize (struct psm_softc *, mousemode_t *);
261 static int doopen (struct psm_softc *, int);
262 static int reinitialize (struct psm_softc *, int);
263 static char *model_name (int);
264 static void psmintr (void *);
265 static void psmtimeout (void *);
267 /* vendor specific features */
268 typedef int probefunc_t (struct psm_softc *);
270 static int mouse_id_proc1 (KBDC, int, int, int *);
271 static int mouse_ext_command (KBDC, int);
272 static probefunc_t enable_groller;
273 static probefunc_t enable_gmouse;
274 static probefunc_t enable_aglide;
275 static probefunc_t enable_kmouse;
276 static probefunc_t enable_msexplorer;
277 static probefunc_t enable_msintelli;
278 static probefunc_t enable_4dmouse;
279 static probefunc_t enable_4dplus;
280 static probefunc_t enable_mmanplus;
281 static probefunc_t enable_versapad;
282 static int tame_mouse (struct psm_softc *, mousestatus_t *, unsigned char *);
286 unsigned char syncmask;
288 probefunc_t *probefunc;
291 * WARNING: the order of probe is very important. Don't mess it
292 * unless you know what you are doing.
294 { MOUSE_MODEL_NET, /* Genius NetMouse */
295 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_gmouse, },
296 { MOUSE_MODEL_NETSCROLL, /* Genius NetScroll */
297 0xc8, 6, enable_groller, },
298 { MOUSE_MODEL_MOUSEMANPLUS, /* Logitech MouseMan+ */
299 0x08, MOUSE_PS2_PACKETSIZE, enable_mmanplus, },
300 { MOUSE_MODEL_EXPLORER, /* Microsoft IntelliMouse Explorer */
301 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msexplorer, },
302 { MOUSE_MODEL_4D, /* A4 Tech 4D Mouse */
303 0x08, MOUSE_4D_PACKETSIZE, enable_4dmouse, },
304 { MOUSE_MODEL_4DPLUS, /* A4 Tech 4D+ Mouse */
305 0xc8, MOUSE_4DPLUS_PACKETSIZE, enable_4dplus, },
306 { MOUSE_MODEL_INTELLI, /* Microsoft IntelliMouse */
307 0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msintelli, },
308 { MOUSE_MODEL_GLIDEPOINT, /* ALPS GlidePoint */
309 0xc0, MOUSE_PS2_PACKETSIZE, enable_aglide, },
310 { MOUSE_MODEL_THINK, /* Kensignton ThinkingMouse */
311 0x80, MOUSE_PS2_PACKETSIZE, enable_kmouse, },
312 { MOUSE_MODEL_VERSAPAD, /* Interlink electronics VersaPad */
313 0xe8, MOUSE_PS2VERSA_PACKETSIZE, enable_versapad, },
314 { MOUSE_MODEL_GENERIC,
315 0xc0, MOUSE_PS2_PACKETSIZE, NULL, },
317 #define GENERIC_MOUSE_ENTRY ((sizeof(vendortype) / sizeof(*vendortype)) - 1)
319 /* device driver declarateion */
320 static device_method_t psm_methods[] = {
321 /* Device interface */
322 DEVMETHOD(device_probe, psmprobe),
323 DEVMETHOD(device_attach, psmattach),
324 DEVMETHOD(device_detach, psmdetach),
325 DEVMETHOD(device_resume, psmresume),
330 static driver_t psm_driver = {
333 sizeof(struct psm_softc),
337 static struct isa_pnp_id psm_ids[] = {
338 { 0x130fd041, "PS/2 mouse port" }, /* PNP0F13 */
339 { 0x1303d041, "PS/2 port" }, /* PNP0313, XXX */
344 #define CDEV_MAJOR 21
346 static struct dev_ops psm_ops = {
347 { PSM_DRIVER_NAME, CDEV_MAJOR, 0 },
355 /* debug message level */
356 static int verbose = PSM_DEBUG;
358 /* device I/O routines */
360 enable_aux_dev(KBDC kbdc)
364 res = send_aux_command(kbdc, PSMC_ENABLE_DEV);
366 log(LOG_DEBUG, "psm: ENABLE_DEV return code:%04x\n", res);
368 return (res == PSM_ACK);
372 disable_aux_dev(KBDC kbdc)
376 res = send_aux_command(kbdc, PSMC_DISABLE_DEV);
378 log(LOG_DEBUG, "psm: DISABLE_DEV return code:%04x\n", res);
380 return (res == PSM_ACK);
384 get_mouse_status(KBDC kbdc, int *status, int flag, int len)
393 cmd = PSMC_SEND_DEV_STATUS;
396 cmd = PSMC_SEND_DEV_DATA;
399 empty_aux_buffer(kbdc, 5);
400 res = send_aux_command(kbdc, cmd);
402 log(LOG_DEBUG, "psm: SEND_AUX_DEV_%s return code:%04x\n",
403 (flag == 1) ? "DATA" : "STATUS", res);
407 for (i = 0; i < len; ++i) {
408 status[i] = read_aux_data(kbdc);
414 log(LOG_DEBUG, "psm: %s %02x %02x %02x\n",
415 (flag == 1) ? "data" : "status", status[0], status[1], status[2]);
422 get_aux_id(KBDC kbdc)
427 empty_aux_buffer(kbdc, 5);
428 res = send_aux_command(kbdc, PSMC_SEND_DEV_ID);
430 log(LOG_DEBUG, "psm: SEND_DEV_ID return code:%04x\n", res);
437 id = read_aux_data(kbdc);
439 log(LOG_DEBUG, "psm: device ID: %04x\n", id);
445 set_mouse_sampling_rate(KBDC kbdc, int rate)
449 res = send_aux_command_and_data(kbdc, PSMC_SET_SAMPLING_RATE, rate);
451 log(LOG_DEBUG, "psm: SET_SAMPLING_RATE (%d) %04x\n", rate, res);
453 return ((res == PSM_ACK) ? rate : -1);
457 set_mouse_scaling(KBDC kbdc, int scale)
464 scale = PSMC_SET_SCALING11;
467 scale = PSMC_SET_SCALING21;
470 res = send_aux_command(kbdc, scale);
472 log(LOG_DEBUG, "psm: SET_SCALING%s return code:%04x\n",
473 (scale == PSMC_SET_SCALING21) ? "21" : "11", res);
475 return (res == PSM_ACK);
478 /* `val' must be 0 through PSMD_MAX_RESOLUTION */
480 set_mouse_resolution(KBDC kbdc, int val)
484 res = send_aux_command_and_data(kbdc, PSMC_SET_RESOLUTION, val);
486 log(LOG_DEBUG, "psm: SET_RESOLUTION (%d) %04x\n", val, res);
488 return ((res == PSM_ACK) ? val : -1);
492 * NOTE: once `set_mouse_mode()' is called, the mouse device must be
493 * re-enabled by calling `enable_aux_dev()'
496 set_mouse_mode(KBDC kbdc)
500 res = send_aux_command(kbdc, PSMC_SET_STREAM_MODE);
502 log(LOG_DEBUG, "psm: SET_STREAM_MODE return code:%04x\n", res);
504 return (res == PSM_ACK);
508 get_mouse_buttons(KBDC kbdc)
510 int c = 2; /* assume two buttons by default */
514 * NOTE: a special sequence to obtain Logitech Mouse specific
515 * information: set resolution to 25 ppi, set scaling to 1:1, set
516 * scaling to 1:1, set scaling to 1:1. Then the second byte of the
517 * mouse status bytes is the number of available buttons.
518 * Some manufactures also support this sequence.
520 if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
522 if (set_mouse_scaling(kbdc, 1) && set_mouse_scaling(kbdc, 1)
523 && set_mouse_scaling(kbdc, 1)
524 && (get_mouse_status(kbdc, status, 0, 3) >= 3)) {
531 /* misc subroutines */
533 * Someday, I will get the complete list of valid pointing devices and
540 static int valid_ids[] = {
541 PSM_MOUSE_ID, /* mouse */
542 PSM_BALLPOINT_ID, /* ballpoint device */
543 PSM_INTELLI_ID, /* Intellimouse */
544 PSM_EXPLORER_ID, /* Intellimouse Explorer */
545 -1 /* end of table */
549 for (i = 0; valid_ids[i] >= 0; ++i)
550 if (valid_ids[i] == id)
559 model_name(int model)
565 { MOUSE_MODEL_NETSCROLL, "NetScroll" },
566 { MOUSE_MODEL_NET, "NetMouse/NetScroll Optical" },
567 { MOUSE_MODEL_GLIDEPOINT, "GlidePoint" },
568 { MOUSE_MODEL_THINK, "ThinkingMouse" },
569 { MOUSE_MODEL_INTELLI, "IntelliMouse" },
570 { MOUSE_MODEL_MOUSEMANPLUS, "MouseMan+" },
571 { MOUSE_MODEL_VERSAPAD, "VersaPad" },
572 { MOUSE_MODEL_EXPLORER, "IntelliMouse Explorer" },
573 { MOUSE_MODEL_4D, "4D Mouse" },
574 { MOUSE_MODEL_4DPLUS, "4D+ Mouse" },
575 { MOUSE_MODEL_GENERIC, "Generic PS/2 mouse" },
576 { MOUSE_MODEL_UNKNOWN, NULL },
580 for (i = 0; models[i].model_code != MOUSE_MODEL_UNKNOWN; ++i) {
581 if (models[i].model_code == model)
582 return models[i].model_name;
588 recover_from_error(KBDC kbdc)
590 /* discard anything left in the output buffer */
591 empty_both_buffers(kbdc, 10);
595 * NOTE: KBDC_RESET_KBD may not restore the communication between the
596 * keyboard and the controller.
601 * NOTE: somehow diagnostic and keyboard port test commands bring the
604 if (!test_controller(kbdc))
605 log(LOG_ERR, "psm: keyboard controller failed.\n");
606 /* if there isn't a keyboard in the system, the following error is OK */
607 if (test_kbd_port(kbdc) != 0) {
609 log(LOG_ERR, "psm: keyboard port failed.\n");
615 restore_controller(KBDC kbdc, int command_byte)
617 empty_both_buffers(kbdc, 10);
619 if (!set_controller_command_byte(kbdc, 0xff, command_byte)) {
620 log(LOG_ERR, "psm: failed to restore the keyboard controller "
622 empty_both_buffers(kbdc, 10);
625 empty_both_buffers(kbdc, 10);
631 * Re-initialize the aux port and device. The aux port must be enabled
632 * and its interrupt must be disabled before calling this routine.
633 * The aux device will be disabled before returning.
634 * The keyboard controller must be locked via `kbdc_lock()' before
635 * calling this routine.
638 doinitialize(struct psm_softc *sc, mousemode_t *mode)
640 KBDC kbdc = sc->kbdc;
644 switch((i = test_aux_port(kbdc))) {
645 case 1: /* ignore this error */
646 case 2: /* Ignore 2 and 3 for use with some acer and compal laptops */
650 log(LOG_DEBUG, "psm%d: strange result for test aux port (%d).\n",
653 case 0: /* no error */
655 case -1: /* time out */
657 recover_from_error(kbdc);
658 if (sc->config & PSM_CONFIG_IGNPORTERROR)
660 log(LOG_ERR, "psm%d: the aux port is not functioning (%d).\n",
665 if (sc->config & PSM_CONFIG_NORESET) {
667 * Don't try to reset the pointing device. It may possibly be
668 * left in the unknown state, though...
672 * NOTE: some controllers appears to hang the `keyboard' when
673 * the aux port doesn't exist and `PSMC_RESET_DEV' is issued.
675 if (!reset_aux_dev(kbdc)) {
676 recover_from_error(kbdc);
677 log(LOG_ERR, "psm%d: failed to reset the aux device.\n", sc->unit);
683 * both the aux port and the aux device is functioning, see
684 * if the device can be enabled.
686 if (!enable_aux_dev(kbdc) || !disable_aux_dev(kbdc)) {
687 log(LOG_ERR, "psm%d: failed to enable the aux device.\n", sc->unit);
690 empty_both_buffers(kbdc, 10); /* remove stray data if any */
692 if (sc->config & PSM_CONFIG_NOIDPROBE) {
693 i = GENERIC_MOUSE_ENTRY;
695 /* FIXME: hardware ID, mouse buttons? */
697 /* other parameters */
698 for (i = 0; vendortype[i].probefunc != NULL; ++i) {
699 if ((*vendortype[i].probefunc)(sc)) {
701 log(LOG_ERR, "psm%d: found %s\n",
702 sc->unit, model_name(vendortype[i].model));
708 sc->hw.model = vendortype[i].model;
709 sc->mode.packetsize = vendortype[i].packetsize;
711 /* set mouse parameters */
712 if (mode != (mousemode_t *)NULL) {
714 mode->rate = set_mouse_sampling_rate(kbdc, mode->rate);
715 if (mode->resolution >= 0)
716 mode->resolution = set_mouse_resolution(kbdc, mode->resolution);
717 set_mouse_scaling(kbdc, 1);
718 set_mouse_mode(kbdc);
721 /* request a data packet and extract sync. bits */
722 if (get_mouse_status(kbdc, stat, 1, 3) < 3) {
723 log(LOG_DEBUG, "psm%d: failed to get data (doinitialize).\n",
725 sc->mode.syncmask[0] = 0;
727 sc->mode.syncmask[1] = stat[0] & sc->mode.syncmask[0]; /* syncbits */
728 /* the NetScroll Mouse will send three more bytes... Ignore them */
729 empty_aux_buffer(kbdc, 5);
732 /* just check the status of the mouse */
733 if (get_mouse_status(kbdc, stat, 0, 3) < 3)
734 log(LOG_DEBUG, "psm%d: failed to get status (doinitialize).\n",
741 doopen(struct psm_softc *sc, int command_byte)
745 /* enable the mouse device */
746 if (!enable_aux_dev(sc->kbdc)) {
747 /* MOUSE ERROR: failed to enable the mouse because:
748 * 1) the mouse is faulty,
749 * 2) the mouse has been removed(!?)
750 * In the latter case, the keyboard may have hung, and need
751 * recovery procedure...
753 recover_from_error(sc->kbdc);
755 /* FIXME: we could reset the mouse here and try to enable
756 * it again. But it will take long time and it's not a good
757 * idea to disable the keyboard that long...
759 if (!doinitialize(sc, &sc->mode) || !enable_aux_dev(sc->kbdc)) {
760 recover_from_error(sc->kbdc);
764 restore_controller(sc->kbdc, command_byte);
765 /* mark this device is no longer available */
766 sc->state &= ~PSM_VALID;
767 log(LOG_ERR, "psm%d: failed to enable the device (doopen).\n",
773 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
774 log(LOG_DEBUG, "psm%d: failed to get status (doopen).\n", sc->unit);
776 /* enable the aux port and interrupt */
777 if (!set_controller_command_byte(sc->kbdc,
778 kbdc_get_device_mask(sc->kbdc),
779 (command_byte & KBD_KBD_CONTROL_BITS)
780 | KBD_ENABLE_AUX_PORT | KBD_ENABLE_AUX_INT)) {
781 /* CONTROLLER ERROR */
782 disable_aux_dev(sc->kbdc);
783 restore_controller(sc->kbdc, command_byte);
784 log(LOG_ERR, "psm%d: failed to enable the aux interrupt (doopen).\n",
789 /* start the watchdog timer */
790 sc->watchdog = FALSE;
791 callout_reset(&sc->callout, hz * 2, psmtimeout, (void *)(uintptr_t)sc);
797 reinitialize(struct psm_softc *sc, int doinit)
802 /* don't let anybody mess with the aux device */
803 if (!kbdc_lock(sc->kbdc, TRUE))
807 /* block our watchdog timer */
808 sc->watchdog = FALSE;
809 callout_stop(&sc->callout);
811 /* save the current controller command byte */
812 empty_both_buffers(sc->kbdc, 10);
813 c = get_controller_command_byte(sc->kbdc);
815 log(LOG_DEBUG, "psm%d: current command byte: %04x (reinitialize).\n",
818 /* enable the aux port but disable the aux interrupt and the keyboard */
819 if ((c == -1) || !set_controller_command_byte(sc->kbdc,
820 kbdc_get_device_mask(sc->kbdc),
821 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
822 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
823 /* CONTROLLER ERROR */
825 kbdc_lock(sc->kbdc, FALSE);
826 log(LOG_ERR, "psm%d: unable to set the command byte (reinitialize).\n",
832 if (sc->state & PSM_VALID) {
833 disable_aux_dev(sc->kbdc); /* this may fail; but never mind... */
834 empty_aux_buffer(sc->kbdc, 10);
839 /* try to detect the aux device; are you still there? */
842 if (doinitialize(sc, &sc->mode)) {
844 sc->state |= PSM_VALID;
846 /* the device has gone! */
847 restore_controller(sc->kbdc, c);
848 sc->state &= ~PSM_VALID;
849 log(LOG_ERR, "psm%d: the aux device has gone! (reinitialize).\n",
856 /* restore the driver state */
857 if ((sc->state & PSM_OPEN) && (err == 0)) {
858 /* enable the aux device and the port again */
861 log(LOG_ERR, "psm%d: failed to enable the device (reinitialize).\n",
864 /* restore the keyboard port and disable the aux port */
865 if (!set_controller_command_byte(sc->kbdc,
866 kbdc_get_device_mask(sc->kbdc),
867 (c & KBD_KBD_CONTROL_BITS)
868 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
869 /* CONTROLLER ERROR */
870 log(LOG_ERR, "psm%d: failed to disable the aux port (reinitialize).\n",
876 kbdc_lock(sc->kbdc, FALSE);
880 /* psm driver entry points */
882 #define endprobe(v) { if (bootverbose) \
884 kbdc_set_device_mask(sc->kbdc, mask); \
885 kbdc_lock(sc->kbdc, FALSE); \
890 psmprobe(device_t dev)
892 int unit = device_get_unit(dev);
893 struct psm_softc *sc = device_get_softc(dev);
908 if (XXX_PNP_PROBE(device_get_parent(dev), dev, psm_ids) == ENXIO)
912 BUS_READ_IVAR(device_get_parent(dev), dev, KBDC_IVAR_IRQ, &irq);
913 BUS_READ_IVAR(device_get_parent(dev), dev, KBDC_IVAR_FLAGS, &flags);
916 sc->kbdc = atkbdc_open(device_get_unit(device_get_parent(dev)));
917 sc->config = flags & PSM_CONFIG_FLAGS;
918 /* XXX: for backward compatibility */
919 #if defined(PSM_HOOKRESUME) || defined(PSM_HOOKAPM)
921 #ifdef PSM_RESETAFTERSUSPEND
922 PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND;
924 PSM_CONFIG_HOOKRESUME;
926 #endif /* PSM_HOOKRESUME | PSM_HOOKAPM */
931 device_set_desc(dev, "PS/2 Mouse");
933 if (!kbdc_lock(sc->kbdc, TRUE)) {
934 printf("psm%d: unable to lock the controller.\n", unit);
941 * NOTE: two bits in the command byte controls the operation of the
942 * aux port (mouse port): the aux port disable bit (bit 5) and the aux
943 * port interrupt (IRQ 12) enable bit (bit 2).
946 /* discard anything left after the keyboard initialization */
947 empty_both_buffers(sc->kbdc, 10);
949 /* save the current command byte; it will be used later */
950 mask = kbdc_get_device_mask(sc->kbdc) & ~KBD_AUX_CONTROL_BITS;
951 command_byte = get_controller_command_byte(sc->kbdc);
953 printf("psm%d: current command byte:%04x\n", unit, command_byte);
954 if (command_byte == -1) {
955 /* CONTROLLER ERROR */
956 printf("psm%d: unable to get the current command byte value.\n",
962 * disable the keyboard port while probing the aux port, which must be
963 * enabled during this routine
965 if (!set_controller_command_byte(sc->kbdc,
966 KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
967 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
968 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
970 * this is CONTROLLER ERROR; I don't know how to recover
973 restore_controller(sc->kbdc, command_byte);
974 printf("psm%d: unable to set the command byte.\n", unit);
977 write_controller_command(sc->kbdc, KBDC_ENABLE_AUX_PORT);
980 * NOTE: `test_aux_port()' is designed to return with zero if the aux
981 * port exists and is functioning. However, some controllers appears
982 * to respond with zero even when the aux port doesn't exist. (It may
983 * be that this is only the case when the controller DOES have the aux
984 * port but the port is not wired on the motherboard.) The keyboard
985 * controllers without the port, such as the original AT, are
986 * supporsed to return with an error code or simply time out. In any
987 * case, we have to continue probing the port even when the controller
990 * XXX: some controllers erroneously return the error code 1 when
991 * it has the perfectly functional aux port. We have to ignore this
992 * error code. Even if the controller HAS error with the aux port,
993 * it will be detected later...
994 * XXX: another incompatible controller returns PSM_ACK (0xfa)...
996 switch ((i = test_aux_port(sc->kbdc))) {
997 case 1: /* ignore this error */
998 case 2: /* Ignore 2 and 3 for use with some acer and compal laptops */
1002 printf("psm%d: strange result for test aux port (%d).\n",
1005 case 0: /* no error */
1007 case -1: /* time out */
1008 default: /* error */
1009 recover_from_error(sc->kbdc);
1010 if (sc->config & PSM_CONFIG_IGNPORTERROR)
1012 restore_controller(sc->kbdc, command_byte);
1014 printf("psm%d: the aux port is not functioning (%d).\n",
1019 if (sc->config & PSM_CONFIG_NORESET) {
1021 * Don't try to reset the pointing device. It may possibly be
1022 * left in the unknown state, though...
1026 * NOTE: some controllers appears to hang the `keyboard' when the aux
1027 * port doesn't exist and `PSMC_RESET_DEV' is issued.
1029 * Attempt to reset the controller twice -- this helps
1030 * pierce through some KVM switches. The second reset
1033 if (!reset_aux_dev(sc->kbdc)) {
1034 recover_from_error(sc->kbdc);
1035 restore_controller(sc->kbdc, command_byte);
1037 printf("psm%d: failed to reset the aux device.\n", unit);
1039 } else if (!reset_aux_dev(sc->kbdc)) {
1040 recover_from_error(sc->kbdc);
1042 printf("psm%d: failed to reset the aux device (2).\n",
1048 * both the aux port and the aux device is functioning, see if the
1049 * device can be enabled. NOTE: when enabled, the device will start
1050 * sending data; we shall immediately disable the device once we know
1051 * the device can be enabled.
1053 if (!enable_aux_dev(sc->kbdc) || !disable_aux_dev(sc->kbdc)) {
1055 recover_from_error(sc->kbdc);
1056 restore_controller(sc->kbdc, command_byte);
1058 printf("psm%d: failed to enable the aux device.\n", unit);
1062 /* save the default values after reset */
1063 if (get_mouse_status(sc->kbdc, stat, 0, 3) >= 3) {
1064 sc->dflt_mode.rate = sc->mode.rate = stat[2];
1065 sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1067 sc->dflt_mode.rate = sc->mode.rate = -1;
1068 sc->dflt_mode.resolution = sc->mode.resolution = -1;
1071 /* hardware information */
1072 sc->hw.iftype = MOUSE_IF_PS2;
1074 /* verify the device is a mouse */
1075 sc->hw.hwid = get_aux_id(sc->kbdc);
1076 if (!is_a_mouse(sc->hw.hwid)) {
1077 restore_controller(sc->kbdc, command_byte);
1079 printf("psm%d: unknown device type (%d).\n", unit, sc->hw.hwid);
1082 switch (sc->hw.hwid) {
1083 case PSM_BALLPOINT_ID:
1084 sc->hw.type = MOUSE_TRACKBALL;
1087 case PSM_INTELLI_ID:
1088 case PSM_EXPLORER_ID:
1089 case PSM_4DMOUSE_ID:
1091 sc->hw.type = MOUSE_MOUSE;
1094 sc->hw.type = MOUSE_UNKNOWN;
1098 if (sc->config & PSM_CONFIG_NOIDPROBE) {
1100 i = GENERIC_MOUSE_ENTRY;
1103 sc->hw.buttons = get_mouse_buttons(sc->kbdc);
1105 /* other parameters */
1106 for (i = 0; vendortype[i].probefunc != NULL; ++i) {
1107 if ((*vendortype[i].probefunc)(sc)) {
1109 printf("psm%d: found %s\n",
1110 unit, model_name(vendortype[i].model));
1116 sc->hw.model = vendortype[i].model;
1118 sc->dflt_mode.level = PSM_LEVEL_BASE;
1119 sc->dflt_mode.packetsize = MOUSE_PS2_PACKETSIZE;
1120 sc->dflt_mode.accelfactor = (sc->config & PSM_CONFIG_ACCEL) >> 4;
1121 if (sc->config & PSM_CONFIG_NOCHECKSYNC)
1122 sc->dflt_mode.syncmask[0] = 0;
1124 sc->dflt_mode.syncmask[0] = vendortype[i].syncmask;
1125 if (sc->config & PSM_CONFIG_FORCETAP)
1126 sc->mode.syncmask[0] &= ~MOUSE_PS2_TAP;
1127 sc->dflt_mode.syncmask[1] = 0; /* syncbits */
1128 sc->mode = sc->dflt_mode;
1129 sc->mode.packetsize = vendortype[i].packetsize;
1131 /* set mouse parameters */
1134 * A version of Logitech FirstMouse+ won't report wheel movement,
1135 * if SET_DEFAULTS is sent... Don't use this command.
1136 * This fix was found by Takashi Nishida.
1138 i = send_aux_command(sc->kbdc, PSMC_SET_DEFAULTS);
1140 printf("psm%d: SET_DEFAULTS return code:%04x\n", unit, i);
1142 if (sc->config & PSM_CONFIG_RESOLUTION) {
1144 = set_mouse_resolution(sc->kbdc,
1145 (sc->config & PSM_CONFIG_RESOLUTION) - 1);
1146 } else if (sc->mode.resolution >= 0) {
1148 = set_mouse_resolution(sc->kbdc, sc->dflt_mode.resolution);
1150 if (sc->mode.rate > 0) {
1151 sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, sc->dflt_mode.rate);
1153 set_mouse_scaling(sc->kbdc, 1);
1155 /* request a data packet and extract sync. bits */
1156 if (get_mouse_status(sc->kbdc, stat, 1, 3) < 3) {
1157 printf("psm%d: failed to get data.\n", unit);
1158 sc->mode.syncmask[0] = 0;
1160 sc->mode.syncmask[1] = stat[0] & sc->mode.syncmask[0]; /* syncbits */
1161 /* the NetScroll Mouse will send three more bytes... Ignore them */
1162 empty_aux_buffer(sc->kbdc, 5);
1165 /* just check the status of the mouse */
1167 * NOTE: XXX there are some arcane controller/mouse combinations out
1168 * there, which hung the controller unless there is data transmission
1169 * after ACK from the mouse.
1171 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3) {
1172 printf("psm%d: failed to get status.\n", unit);
1175 * When in its native mode, some mice operate with different
1176 * default parameters than in the PS/2 compatible mode.
1178 sc->dflt_mode.rate = sc->mode.rate = stat[2];
1179 sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1182 /* disable the aux port for now... */
1183 if (!set_controller_command_byte(sc->kbdc,
1184 KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
1185 (command_byte & KBD_KBD_CONTROL_BITS)
1186 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1188 * this is CONTROLLER ERROR; I don't know the proper way to
1189 * recover from this error...
1191 restore_controller(sc->kbdc, command_byte);
1192 printf("psm%d: unable to set the command byte.\n", unit);
1196 /* see if IRQ is available */
1198 sc->intr = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, irq, irq, 1,
1200 if (sc->intr == NULL) {
1201 printf("psm%d: unable to allocate the IRQ resource (%d).\n",
1205 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1209 kbdc_set_device_mask(sc->kbdc, mask | KBD_AUX_CONTROL_BITS);
1210 kbdc_lock(sc->kbdc, FALSE);
1215 psmattach(device_t dev)
1217 int unit = device_get_unit(dev);
1218 struct psm_softc *sc = device_get_softc(dev);
1223 if (sc == NULL) /* shouldn't happen */
1226 /* Setup initial state */
1227 sc->state = PSM_VALID;
1228 callout_init(&sc->callout);
1230 /* Setup our interrupt handler */
1232 BUS_READ_IVAR(device_get_parent(dev), dev, KBDC_IVAR_IRQ, &irq);
1233 sc->intr = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, irq, irq, 1,
1235 if (sc->intr == NULL)
1237 error = BUS_SETUP_INTR(device_get_parent(dev), dev, sc->intr,
1238 0, psmintr, sc, &sc->ih, NULL);
1240 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1245 dev_ops_add(&psm_ops, PSM_MKMINOR(-1, 0), PSM_MKMINOR(unit, 0));
1246 make_dev(&psm_ops, PSM_MKMINOR(unit, FALSE), 0, 0, 0666, "psm%d", unit);
1247 make_dev(&psm_ops, PSM_MKMINOR(unit, TRUE), 0, 0, 0666, "bpsm%d", unit);
1250 printf("psm%d: model %s, device ID %d\n",
1251 unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff);
1253 printf("psm%d: model %s, device ID %d-%02x, %d buttons\n",
1254 unit, model_name(sc->hw.model),
1255 sc->hw.hwid & 0x00ff, sc->hw.hwid >> 8, sc->hw.buttons);
1256 printf("psm%d: config:%08x, flags:%08x, packet size:%d\n",
1257 unit, sc->config, sc->flags, sc->mode.packetsize);
1258 printf("psm%d: syncmask:%02x, syncbits:%02x\n",
1259 unit, sc->mode.syncmask[0], sc->mode.syncmask[1]);
1269 psmdetach(device_t dev)
1271 struct psm_softc *sc;
1275 sc = device_get_softc(dev);
1276 if (sc->state & PSM_OPEN)
1279 unit = device_get_unit(dev);
1282 BUS_TEARDOWN_INTR(device_get_parent(dev), dev, sc->intr, sc->ih);
1283 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1284 dev_ops_remove(&psm_ops, PSM_MKMINOR(-1, 0), PSM_MKMINOR(unit, 0));
1290 psmopen(struct dev_open_args *ap)
1292 cdev_t dev = ap->a_head.a_dev;
1293 int unit = PSM_UNIT(dev);
1294 struct psm_softc *sc;
1298 /* Get device data */
1299 sc = PSM_SOFTC(unit);
1300 if ((sc == NULL) || (sc->state & PSM_VALID) == 0)
1301 /* the device is no longer valid/functioning */
1304 /* Disallow multiple opens */
1305 if (sc->state & PSM_OPEN)
1308 device_busy(devclass_get_device(psm_devclass, unit));
1310 /* Initialize state */
1311 sc->rsel.si_flags = 0;
1312 sc->rsel.si_pid = 0;
1313 sc->mode.level = sc->dflt_mode.level;
1314 sc->mode.protocol = sc->dflt_mode.protocol;
1315 sc->watchdog = FALSE;
1317 /* flush the event queue */
1318 sc->queue.count = 0;
1321 sc->status.flags = 0;
1322 sc->status.button = 0;
1323 sc->status.obutton = 0;
1329 /* empty input buffer */
1330 bzero(sc->ipacket, sizeof(sc->ipacket));
1334 /* don't let timeout routines in the keyboard driver to poll the kbdc */
1335 if (!kbdc_lock(sc->kbdc, TRUE))
1338 /* save the current controller command byte */
1340 command_byte = get_controller_command_byte(sc->kbdc);
1342 /* enable the aux port and temporalily disable the keyboard */
1343 if ((command_byte == -1)
1344 || !set_controller_command_byte(sc->kbdc,
1345 kbdc_get_device_mask(sc->kbdc),
1346 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1347 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1348 /* CONTROLLER ERROR; do you know how to get out of this? */
1349 kbdc_lock(sc->kbdc, FALSE);
1351 log(LOG_ERR, "psm%d: unable to set the command byte (psmopen).\n",
1356 * Now that the keyboard controller is told not to generate
1357 * the keyboard and mouse interrupts, call `splx()' to allow
1358 * the other tty interrupts. The clock interrupt may also occur,
1359 * but timeout routines will be blocked by the poll flag set
1364 /* enable the mouse device */
1365 err = doopen(sc, command_byte);
1369 sc->state |= PSM_OPEN;
1370 kbdc_lock(sc->kbdc, FALSE);
1375 psmclose(struct dev_close_args *ap)
1377 cdev_t dev = ap->a_head.a_dev;
1378 int unit = PSM_UNIT(dev);
1379 struct psm_softc *sc = PSM_SOFTC(unit);
1383 /* don't let timeout routines in the keyboard driver to poll the kbdc */
1384 if (!kbdc_lock(sc->kbdc, TRUE))
1387 /* save the current controller command byte */
1389 command_byte = get_controller_command_byte(sc->kbdc);
1390 if (command_byte == -1) {
1391 kbdc_lock(sc->kbdc, FALSE);
1396 /* disable the aux interrupt and temporalily disable the keyboard */
1397 if (!set_controller_command_byte(sc->kbdc,
1398 kbdc_get_device_mask(sc->kbdc),
1399 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1400 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1401 log(LOG_ERR, "psm%d: failed to disable the aux int (psmclose).\n",
1403 /* CONTROLLER ERROR;
1404 * NOTE: we shall force our way through. Because the only
1405 * ill effect we shall see is that we may not be able
1406 * to read ACK from the mouse, and it doesn't matter much
1407 * so long as the mouse will accept the DISABLE command.
1412 /* stop the watchdog timer */
1413 callout_stop(&sc->callout);
1415 /* remove anything left in the output buffer */
1416 empty_aux_buffer(sc->kbdc, 10);
1418 /* disable the aux device, port and interrupt */
1419 if (sc->state & PSM_VALID) {
1420 if (!disable_aux_dev(sc->kbdc)) {
1422 * NOTE: we don't return error and continue, pretending
1423 * we have successfully disabled the device. It's OK because
1424 * the interrupt routine will discard any data from the mouse
1427 log(LOG_ERR, "psm%d: failed to disable the device (psmclose).\n",
1431 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
1432 log(LOG_DEBUG, "psm%d: failed to get status (psmclose).\n",
1436 if (!set_controller_command_byte(sc->kbdc,
1437 kbdc_get_device_mask(sc->kbdc),
1438 (command_byte & KBD_KBD_CONTROL_BITS)
1439 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1440 /* CONTROLLER ERROR;
1441 * we shall ignore this error; see the above comment.
1443 log(LOG_ERR, "psm%d: failed to disable the aux port (psmclose).\n",
1447 /* remove anything left in the output buffer */
1448 empty_aux_buffer(sc->kbdc, 10);
1450 /* close is almost always successful */
1451 sc->state &= ~PSM_OPEN;
1452 kbdc_lock(sc->kbdc, FALSE);
1453 device_unbusy(devclass_get_device(psm_devclass, unit));
1458 tame_mouse(struct psm_softc *sc, mousestatus_t *status, unsigned char *buf)
1460 static unsigned char butmapps2[8] = {
1462 MOUSE_PS2_BUTTON1DOWN,
1463 MOUSE_PS2_BUTTON2DOWN,
1464 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN,
1465 MOUSE_PS2_BUTTON3DOWN,
1466 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON3DOWN,
1467 MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
1468 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
1470 static unsigned char butmapmsc[8] = {
1471 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
1472 MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
1473 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON3UP,
1474 MOUSE_MSC_BUTTON3UP,
1475 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP,
1476 MOUSE_MSC_BUTTON2UP,
1477 MOUSE_MSC_BUTTON1UP,
1483 if (sc->mode.level == PSM_LEVEL_BASE) {
1484 mapped = status->button & ~MOUSE_BUTTON4DOWN;
1485 if (status->button & MOUSE_BUTTON4DOWN)
1486 mapped |= MOUSE_BUTTON1DOWN;
1487 status->button = mapped;
1488 buf[0] = MOUSE_PS2_SYNC | butmapps2[mapped & MOUSE_STDBUTTONS];
1489 i = max(min(status->dx, 255), -256);
1491 buf[0] |= MOUSE_PS2_XNEG;
1493 i = max(min(status->dy, 255), -256);
1495 buf[0] |= MOUSE_PS2_YNEG;
1497 return MOUSE_PS2_PACKETSIZE;
1498 } else if (sc->mode.level == PSM_LEVEL_STANDARD) {
1499 buf[0] = MOUSE_MSC_SYNC | butmapmsc[status->button & MOUSE_STDBUTTONS];
1500 i = max(min(status->dx, 255), -256);
1502 buf[3] = i - buf[1];
1503 i = max(min(status->dy, 255), -256);
1505 buf[4] = i - buf[2];
1506 i = max(min(status->dz, 127), -128);
1507 buf[5] = (i >> 1) & 0x7f;
1508 buf[6] = (i - (i >> 1)) & 0x7f;
1509 buf[7] = (~status->button >> 3) & 0x7f;
1510 return MOUSE_SYS_PACKETSIZE;
1512 return sc->inputbytes;
1516 psmread(struct dev_read_args *ap)
1518 cdev_t dev = ap->a_head.a_dev;
1519 struct uio *uio = ap->a_uio;
1520 struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
1521 unsigned char buf[PSM_SMALLBUFSIZE];
1525 if ((sc->state & PSM_VALID) == 0)
1528 /* block until mouse activity occured */
1530 while (sc->queue.count <= 0) {
1531 if (PSM_NBLOCKIO(dev)) {
1535 sc->state |= PSM_ASLP;
1536 error = tsleep((caddr_t) sc, PCATCH, "psmrea", 0);
1537 sc->state &= ~PSM_ASLP;
1541 } else if ((sc->state & PSM_VALID) == 0) {
1542 /* the device disappeared! */
1549 /* copy data to the user land */
1550 while ((sc->queue.count > 0) && (uio->uio_resid > 0)) {
1552 l = min(sc->queue.count, uio->uio_resid);
1553 if (l > sizeof(buf))
1555 if (l > sizeof(sc->queue.buf) - sc->queue.head) {
1556 bcopy(&sc->queue.buf[sc->queue.head], &buf[0],
1557 sizeof(sc->queue.buf) - sc->queue.head);
1558 bcopy(&sc->queue.buf[0],
1559 &buf[sizeof(sc->queue.buf) - sc->queue.head],
1560 l - (sizeof(sc->queue.buf) - sc->queue.head));
1562 bcopy(&sc->queue.buf[sc->queue.head], &buf[0], l);
1564 sc->queue.count -= l;
1565 sc->queue.head = (sc->queue.head + l) % sizeof(sc->queue.buf);
1567 error = uiomove(buf, l, uio);
1576 block_mouse_data(struct psm_softc *sc, int *c)
1578 if (!kbdc_lock(sc->kbdc, TRUE))
1582 *c = get_controller_command_byte(sc->kbdc);
1584 || !set_controller_command_byte(sc->kbdc,
1585 kbdc_get_device_mask(sc->kbdc),
1586 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1587 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1588 /* this is CONTROLLER ERROR */
1590 kbdc_lock(sc->kbdc, FALSE);
1595 * The device may be in the middle of status data transmission.
1596 * The transmission will be interrupted, thus, incomplete status
1597 * data must be discarded. Although the aux interrupt is disabled
1598 * at the keyboard controller level, at most one aux interrupt
1599 * may have already been pending and a data byte is in the
1600 * output buffer; throw it away. Note that the second argument
1601 * to `empty_aux_buffer()' is zero, so that the call will just
1602 * flush the internal queue.
1603 * `psmintr()' will be invoked after `splx()' if an interrupt is
1604 * pending; it will see no data and returns immediately.
1606 empty_aux_buffer(sc->kbdc, 0); /* flush the queue */
1607 read_aux_data_no_wait(sc->kbdc); /* throw away data if any */
1615 unblock_mouse_data(struct psm_softc *sc, int c)
1620 * We may have seen a part of status data during `set_mouse_XXX()'.
1621 * they have been queued; flush it.
1623 empty_aux_buffer(sc->kbdc, 0);
1625 /* restore ports and interrupt */
1626 if (!set_controller_command_byte(sc->kbdc,
1627 kbdc_get_device_mask(sc->kbdc),
1628 c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
1629 /* CONTROLLER ERROR; this is serious, we may have
1630 * been left with the inaccessible keyboard and
1631 * the disabled mouse interrupt.
1636 kbdc_lock(sc->kbdc, FALSE);
1641 psmioctl(struct dev_ioctl_args *ap)
1643 cdev_t dev = ap->a_head.a_dev;
1644 caddr_t addr= ap->a_data;
1645 struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
1647 mousestatus_t status;
1648 #if (defined(MOUSE_GETVARS))
1656 /* Perform IOCTL command */
1658 switch (ap->a_cmd) {
1659 case OLD_MOUSE_GETHWINFO:
1661 ((old_mousehw_t *)addr)->buttons = sc->hw.buttons;
1662 ((old_mousehw_t *)addr)->iftype = sc->hw.iftype;
1663 ((old_mousehw_t *)addr)->type = sc->hw.type;
1664 ((old_mousehw_t *)addr)->hwid = sc->hw.hwid & 0x00ff;
1668 case MOUSE_GETHWINFO:
1670 *(mousehw_t *)addr = sc->hw;
1671 if (sc->mode.level == PSM_LEVEL_BASE)
1672 ((mousehw_t *)addr)->model = MOUSE_MODEL_GENERIC;
1676 case OLD_MOUSE_GETMODE:
1678 switch (sc->mode.level) {
1679 case PSM_LEVEL_BASE:
1680 ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1682 case PSM_LEVEL_STANDARD:
1683 ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
1685 case PSM_LEVEL_NATIVE:
1686 ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1689 ((old_mousemode_t *)addr)->rate = sc->mode.rate;
1690 ((old_mousemode_t *)addr)->resolution = sc->mode.resolution;
1691 ((old_mousemode_t *)addr)->accelfactor = sc->mode.accelfactor;
1697 *(mousemode_t *)addr = sc->mode;
1698 ((mousemode_t *)addr)->resolution =
1699 MOUSE_RES_LOW - sc->mode.resolution;
1700 switch (sc->mode.level) {
1701 case PSM_LEVEL_BASE:
1702 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1703 ((mousemode_t *)addr)->packetsize = MOUSE_PS2_PACKETSIZE;
1705 case PSM_LEVEL_STANDARD:
1706 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
1707 ((mousemode_t *)addr)->packetsize = MOUSE_SYS_PACKETSIZE;
1708 ((mousemode_t *)addr)->syncmask[0] = MOUSE_SYS_SYNCMASK;
1709 ((mousemode_t *)addr)->syncmask[1] = MOUSE_SYS_SYNC;
1711 case PSM_LEVEL_NATIVE:
1712 /* FIXME: this isn't quite correct... XXX */
1713 ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1719 case OLD_MOUSE_SETMODE:
1721 if (ap->a_cmd == OLD_MOUSE_SETMODE) {
1722 mode.rate = ((old_mousemode_t *)addr)->rate;
1724 * resolution old I/F new I/F
1731 if (((old_mousemode_t *)addr)->resolution > 0)
1732 mode.resolution = -((old_mousemode_t *)addr)->resolution - 1;
1733 mode.accelfactor = ((old_mousemode_t *)addr)->accelfactor;
1736 mode = *(mousemode_t *)addr;
1739 /* adjust and validate parameters. */
1740 if (mode.rate > UCHAR_MAX)
1743 mode.rate = sc->dflt_mode.rate;
1744 else if (mode.rate == -1)
1745 /* don't change the current setting */
1747 else if (mode.rate < 0)
1749 if (mode.resolution >= UCHAR_MAX)
1751 if (mode.resolution >= 200)
1752 mode.resolution = MOUSE_RES_HIGH;
1753 else if (mode.resolution >= 100)
1754 mode.resolution = MOUSE_RES_MEDIUMHIGH;
1755 else if (mode.resolution >= 50)
1756 mode.resolution = MOUSE_RES_MEDIUMLOW;
1757 else if (mode.resolution > 0)
1758 mode.resolution = MOUSE_RES_LOW;
1759 if (mode.resolution == MOUSE_RES_DEFAULT)
1760 mode.resolution = sc->dflt_mode.resolution;
1761 else if (mode.resolution == -1)
1762 /* don't change the current setting */
1764 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
1765 mode.resolution = MOUSE_RES_LOW - mode.resolution;
1766 if (mode.level == -1)
1767 /* don't change the current setting */
1768 mode.level = sc->mode.level;
1769 else if ((mode.level < PSM_LEVEL_MIN) || (mode.level > PSM_LEVEL_MAX))
1771 if (mode.accelfactor == -1)
1772 /* don't change the current setting */
1773 mode.accelfactor = sc->mode.accelfactor;
1774 else if (mode.accelfactor < 0)
1777 /* don't allow anybody to poll the keyboard controller */
1778 error = block_mouse_data(sc, &command_byte);
1782 /* set mouse parameters */
1784 mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
1785 if (mode.resolution >= 0)
1786 mode.resolution = set_mouse_resolution(sc->kbdc, mode.resolution);
1787 set_mouse_scaling(sc->kbdc, 1);
1788 get_mouse_status(sc->kbdc, stat, 0, 3);
1791 sc->mode.rate = mode.rate;
1792 sc->mode.resolution = mode.resolution;
1793 sc->mode.accelfactor = mode.accelfactor;
1794 sc->mode.level = mode.level;
1797 unblock_mouse_data(sc, command_byte);
1800 case MOUSE_GETLEVEL:
1801 *(int *)addr = sc->mode.level;
1804 case MOUSE_SETLEVEL:
1805 if ((*(int *)addr < PSM_LEVEL_MIN) || (*(int *)addr > PSM_LEVEL_MAX))
1807 sc->mode.level = *(int *)addr;
1810 case MOUSE_GETSTATUS:
1812 status = sc->status;
1813 sc->status.flags = 0;
1814 sc->status.obutton = sc->status.button;
1815 sc->status.button = 0;
1820 *(mousestatus_t *)addr = status;
1823 #if (defined(MOUSE_GETVARS))
1825 var = (mousevar_t *)addr;
1826 bzero(var, sizeof(*var));
1828 var->var[0] = MOUSE_VARS_PS2_SIG;
1829 var->var[1] = sc->config;
1830 var->var[2] = sc->flags;
1836 #endif /* MOUSE_GETVARS */
1838 case MOUSE_READSTATE:
1839 case MOUSE_READDATA:
1840 data = (mousedata_t *)addr;
1841 if (data->len > sizeof(data->buf)/sizeof(data->buf[0]))
1844 error = block_mouse_data(sc, &command_byte);
1847 if ((data->len = get_mouse_status(sc->kbdc, data->buf,
1848 (ap->a_cmd == MOUSE_READDATA) ? 1 : 0, data->len)) <= 0)
1850 unblock_mouse_data(sc, command_byte);
1853 #if (defined(MOUSE_SETRESOLUTION))
1854 case MOUSE_SETRESOLUTION:
1855 mode.resolution = *(int *)addr;
1856 if (mode.resolution >= UCHAR_MAX)
1858 else if (mode.resolution >= 200)
1859 mode.resolution = MOUSE_RES_HIGH;
1860 else if (mode.resolution >= 100)
1861 mode.resolution = MOUSE_RES_MEDIUMHIGH;
1862 else if (mode.resolution >= 50)
1863 mode.resolution = MOUSE_RES_MEDIUMLOW;
1864 else if (mode.resolution > 0)
1865 mode.resolution = MOUSE_RES_LOW;
1866 if (mode.resolution == MOUSE_RES_DEFAULT)
1867 mode.resolution = sc->dflt_mode.resolution;
1868 else if (mode.resolution == -1)
1869 mode.resolution = sc->mode.resolution;
1870 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
1871 mode.resolution = MOUSE_RES_LOW - mode.resolution;
1873 error = block_mouse_data(sc, &command_byte);
1876 sc->mode.resolution = set_mouse_resolution(sc->kbdc, mode.resolution);
1877 if (sc->mode.resolution != mode.resolution)
1879 unblock_mouse_data(sc, command_byte);
1881 #endif /* MOUSE_SETRESOLUTION */
1883 #if (defined(MOUSE_SETRATE))
1885 mode.rate = *(int *)addr;
1886 if (mode.rate > UCHAR_MAX)
1889 mode.rate = sc->dflt_mode.rate;
1890 else if (mode.rate < 0)
1891 mode.rate = sc->mode.rate;
1893 error = block_mouse_data(sc, &command_byte);
1896 sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
1897 if (sc->mode.rate != mode.rate)
1899 unblock_mouse_data(sc, command_byte);
1901 #endif /* MOUSE_SETRATE */
1903 #if (defined(MOUSE_SETSCALING))
1904 case MOUSE_SETSCALING:
1905 if ((*(int *)addr <= 0) || (*(int *)addr > 2))
1908 error = block_mouse_data(sc, &command_byte);
1911 if (!set_mouse_scaling(sc->kbdc, *(int *)addr))
1913 unblock_mouse_data(sc, command_byte);
1915 #endif /* MOUSE_SETSCALING */
1917 #if (defined(MOUSE_GETHWID))
1919 error = block_mouse_data(sc, &command_byte);
1922 sc->hw.hwid &= ~0x00ff;
1923 sc->hw.hwid |= get_aux_id(sc->kbdc);
1924 *(int *)addr = sc->hw.hwid & 0x00ff;
1925 unblock_mouse_data(sc, command_byte);
1927 #endif /* MOUSE_GETHWID */
1937 psmtimeout(void *arg)
1939 struct psm_softc *sc;
1941 sc = (struct psm_softc *)arg;
1943 if (sc->watchdog && kbdc_lock(sc->kbdc, TRUE)) {
1945 log(LOG_DEBUG, "psm%d: lost interrupt?\n", sc->unit);
1947 kbdc_lock(sc->kbdc, FALSE);
1949 sc->watchdog = TRUE;
1950 callout_reset(&sc->callout, hz, psmtimeout, (void *)(uintptr_t)sc);
1958 * the table to turn PS/2 mouse button bits (MOUSE_PS2_BUTTON?DOWN)
1959 * into `mousestatus' button bits (MOUSE_BUTTON?DOWN).
1961 static int butmap[8] = {
1965 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1967 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN,
1968 MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN,
1969 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN
1971 static int butmap_versapad[8] = {
1977 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1979 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN
1981 struct psm_softc *sc = arg;
1989 /* read until there is nothing to read */
1990 while((c = read_aux_data_no_wait(sc->kbdc)) != -1) {
1992 /* discard the byte if the device is not open */
1993 if ((sc->state & PSM_OPEN) == 0)
1996 getmicrouptime(&tv);
1997 if ((sc->inputbytes > 0) && timevalcmp(&tv, &sc->inputtimeout, >)) {
1998 log(LOG_DEBUG, "psmintr: delay too long; resetting byte count\n");
2002 sc->inputtimeout.tv_sec = PSM_INPUT_TIMEOUT/1000000;
2003 sc->inputtimeout.tv_usec = PSM_INPUT_TIMEOUT%1000000;
2004 timevaladd(&sc->inputtimeout, &tv);
2006 sc->ipacket[sc->inputbytes++] = c;
2007 if (sc->inputbytes < sc->mode.packetsize)
2011 log(LOG_DEBUG, "psmintr: %02x %02x %02x %02x %02x %02x\n",
2012 sc->ipacket[0], sc->ipacket[1], sc->ipacket[2],
2013 sc->ipacket[3], sc->ipacket[4], sc->ipacket[5]);
2018 if ((c & sc->mode.syncmask[0]) != sc->mode.syncmask[1]) {
2019 log(LOG_DEBUG, "psmintr: out of sync (%04x != %04x).\n",
2020 c & sc->mode.syncmask[0], sc->mode.syncmask[1]);
2022 if (sc->syncerrors < sc->mode.packetsize) {
2023 log(LOG_DEBUG, "psmintr: discard a byte (%d).\n", sc->syncerrors);
2025 bcopy(&sc->ipacket[1], &sc->ipacket[0], sc->inputbytes);
2026 } else if (sc->syncerrors == sc->mode.packetsize) {
2027 log(LOG_DEBUG, "psmintr: re-enable the mouse.\n");
2029 disable_aux_dev(sc->kbdc);
2030 enable_aux_dev(sc->kbdc);
2031 } else if (sc->syncerrors < PSM_SYNCERR_THRESHOLD1) {
2032 log(LOG_DEBUG, "psmintr: discard a byte (%d).\n", sc->syncerrors);
2034 bcopy(&sc->ipacket[1], &sc->ipacket[0], sc->inputbytes);
2035 } else if (sc->syncerrors >= PSM_SYNCERR_THRESHOLD1) {
2036 log(LOG_DEBUG, "psmintr: reset the mouse.\n");
2037 reinitialize(sc, TRUE);
2043 * A kludge for Kensington device!
2044 * The MSB of the horizontal count appears to be stored in
2047 if (sc->hw.model == MOUSE_MODEL_THINK)
2048 sc->ipacket[1] |= (c & MOUSE_PS2_XOVERFLOW) ? 0x80 : 0;
2050 /* ignore the overflow bits... */
2051 x = (c & MOUSE_PS2_XNEG) ? sc->ipacket[1] - 256 : sc->ipacket[1];
2052 y = (c & MOUSE_PS2_YNEG) ? sc->ipacket[2] - 256 : sc->ipacket[2];
2054 ms.obutton = sc->button; /* previous button state */
2055 ms.button = butmap[c & MOUSE_PS2_BUTTONS];
2056 /* `tapping' action */
2057 if (sc->config & PSM_CONFIG_FORCETAP)
2058 ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 : MOUSE_BUTTON4DOWN;
2060 switch (sc->hw.model) {
2062 case MOUSE_MODEL_EXPLORER:
2064 * b7 b6 b5 b4 b3 b2 b1 b0
2065 * byte 1: oy ox sy sx 1 M R L
2066 * byte 2: x x x x x x x x
2067 * byte 3: y y y y y y y y
2068 * byte 4: * * S2 S1 s d2 d1 d0
2070 * L, M, R, S1, S2: left, middle, right and side buttons
2071 * s: wheel data sign bit
2074 z = (sc->ipacket[3] & MOUSE_EXPLORER_ZNEG)
2075 ? (sc->ipacket[3] & 0x0f) - 16 : (sc->ipacket[3] & 0x0f);
2076 ms.button |= (sc->ipacket[3] & MOUSE_EXPLORER_BUTTON4DOWN)
2077 ? MOUSE_BUTTON4DOWN : 0;
2078 ms.button |= (sc->ipacket[3] & MOUSE_EXPLORER_BUTTON5DOWN)
2079 ? MOUSE_BUTTON5DOWN : 0;
2082 case MOUSE_MODEL_INTELLI:
2083 case MOUSE_MODEL_NET:
2084 /* wheel data is in the fourth byte */
2085 z = (char)sc->ipacket[3];
2086 /* some mice may send 7 when there is no Z movement?! XXX */
2087 if ((z >= 7) || (z <= -7))
2089 /* some compatible mice have additional buttons */
2090 ms.button |= (c & MOUSE_PS2INTELLI_BUTTON4DOWN)
2091 ? MOUSE_BUTTON4DOWN : 0;
2092 ms.button |= (c & MOUSE_PS2INTELLI_BUTTON5DOWN)
2093 ? MOUSE_BUTTON5DOWN : 0;
2096 case MOUSE_MODEL_MOUSEMANPLUS:
2098 * PS2++ protocl packet
2100 * b7 b6 b5 b4 b3 b2 b1 b0
2101 * byte 1: * 1 p3 p2 1 * * *
2102 * byte 2: c1 c2 p1 p0 d1 d0 1 0
2104 * p3-p0: packet type
2105 * c1, c2: c1 & c2 == 1, if p2 == 0
2106 * c1 & c2 == 0, if p2 == 1
2108 * packet type: 0 (device type)
2109 * See comments in enable_mmanplus() below.
2111 * packet type: 1 (wheel data)
2113 * b7 b6 b5 b4 b3 b2 b1 b0
2114 * byte 3: h * B5 B4 s d2 d1 d0
2116 * h: 1, if horizontal roller data
2117 * 0, if vertical roller data
2118 * B4, B5: button 4 and 5
2120 * d2-d0: roller data
2122 * packet type: 2 (reserved)
2124 if (((c & MOUSE_PS2PLUS_SYNCMASK) == MOUSE_PS2PLUS_SYNC)
2126 && MOUSE_PS2PLUS_CHECKBITS(sc->ipacket)) {
2127 /* the extended data packet encodes button and wheel events */
2128 switch (MOUSE_PS2PLUS_PACKET_TYPE(sc->ipacket)) {
2130 /* wheel data packet */
2132 if (sc->ipacket[2] & 0x80) {
2133 /* horizontal roller count - ignore it XXX*/
2135 /* vertical roller count */
2136 z = (sc->ipacket[2] & MOUSE_PS2PLUS_ZNEG)
2137 ? (sc->ipacket[2] & 0x0f) - 16
2138 : (sc->ipacket[2] & 0x0f);
2140 ms.button |= (sc->ipacket[2] & MOUSE_PS2PLUS_BUTTON4DOWN)
2141 ? MOUSE_BUTTON4DOWN : 0;
2142 ms.button |= (sc->ipacket[2] & MOUSE_PS2PLUS_BUTTON5DOWN)
2143 ? MOUSE_BUTTON5DOWN : 0;
2146 /* this packet type is reserved by Logitech... */
2148 * IBM ScrollPoint Mouse uses this packet type to
2149 * encode both vertical and horizontal scroll movement.
2152 /* horizontal count */
2153 if (sc->ipacket[2] & 0x0f)
2154 z = (sc->ipacket[2] & MOUSE_SPOINT_WNEG) ? -2 : 2;
2155 /* vertical count */
2156 if (sc->ipacket[2] & 0xf0)
2157 z = (sc->ipacket[2] & MOUSE_SPOINT_ZNEG) ? -1 : 1;
2159 /* vertical count */
2160 z = (sc->ipacket[2] & MOUSE_SPOINT_ZNEG)
2161 ? ((sc->ipacket[2] >> 4) & 0x0f) - 16
2162 : ((sc->ipacket[2] >> 4) & 0x0f);
2163 /* horizontal count */
2164 w = (sc->ipacket[2] & MOUSE_SPOINT_WNEG)
2165 ? (sc->ipacket[2] & 0x0f) - 16
2166 : (sc->ipacket[2] & 0x0f);
2170 /* device type packet - shouldn't happen */
2174 ms.button = ms.obutton;
2176 log(LOG_DEBUG, "psmintr: unknown PS2++ packet type %d: "
2177 "0x%02x 0x%02x 0x%02x\n",
2178 MOUSE_PS2PLUS_PACKET_TYPE(sc->ipacket),
2179 sc->ipacket[0], sc->ipacket[1], sc->ipacket[2]);
2183 /* preserve button states */
2184 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
2188 case MOUSE_MODEL_GLIDEPOINT:
2189 /* `tapping' action */
2190 ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 : MOUSE_BUTTON4DOWN;
2193 case MOUSE_MODEL_NETSCROLL:
2194 /* three addtional bytes encode buttons and wheel events */
2195 ms.button |= (sc->ipacket[3] & MOUSE_PS2_BUTTON3DOWN)
2196 ? MOUSE_BUTTON4DOWN : 0;
2197 ms.button |= (sc->ipacket[3] & MOUSE_PS2_BUTTON1DOWN)
2198 ? MOUSE_BUTTON5DOWN : 0;
2199 z = (sc->ipacket[3] & MOUSE_PS2_XNEG)
2200 ? sc->ipacket[4] - 256 : sc->ipacket[4];
2203 case MOUSE_MODEL_THINK:
2204 /* the fourth button state in the first byte */
2205 ms.button |= (c & MOUSE_PS2_TAP) ? MOUSE_BUTTON4DOWN : 0;
2208 case MOUSE_MODEL_VERSAPAD:
2209 /* VersaPad PS/2 absolute mode message format
2211 * [packet1] 7 6 5 4 3 2 1 0(LSB)
2212 * ipacket[0]: 1 1 0 A 1 L T R
2213 * ipacket[1]: H7 H6 H5 H4 H3 H2 H1 H0
2214 * ipacket[2]: V7 V6 V5 V4 V3 V2 V1 V0
2215 * ipacket[3]: 1 1 1 A 1 L T R
2216 * ipacket[4]:V11 V10 V9 V8 H11 H10 H9 H8
2217 * ipacket[5]: 0 P6 P5 P4 P3 P2 P1 P0
2220 * R: right physical mouse button (1=on)
2221 * T: touch pad virtual button (1=tapping)
2222 * L: left physical mouse button (1=on)
2223 * A: position data is valid (1=valid)
2224 * H: horizontal data (12bit signed integer. H11 is sign bit.)
2225 * V: vertical data (12bit signed integer. V11 is sign bit.)
2228 * Tapping is mapped to MOUSE_BUTTON4.
2230 ms.button = butmap_versapad[c & MOUSE_PS2VERSA_BUTTONS];
2231 ms.button |= (c & MOUSE_PS2VERSA_TAP) ? MOUSE_BUTTON4DOWN : 0;
2233 if (c & MOUSE_PS2VERSA_IN_USE) {
2234 x0 = sc->ipacket[1] | (((sc->ipacket[4]) & 0x0f) << 8);
2235 y0 = sc->ipacket[2] | (((sc->ipacket[4]) & 0xf0) << 4);
2240 if (sc->flags & PSM_FLAGS_FINGERDOWN) {
2243 if (x < 0) /* XXX */
2252 sc->flags |= PSM_FLAGS_FINGERDOWN;
2257 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
2259 c = ((x < 0) ? MOUSE_PS2_XNEG : 0)
2260 | ((y < 0) ? MOUSE_PS2_YNEG : 0);
2263 case MOUSE_MODEL_4D:
2265 * b7 b6 b5 b4 b3 b2 b1 b0
2266 * byte 1: s2 d2 s1 d1 1 M R L
2267 * byte 2: sx x x x x x x x
2268 * byte 3: sy y y y y y y y
2270 * s1: wheel 1 direction
2272 * s2: wheel 2 direction
2275 x = (sc->ipacket[1] & 0x80) ? sc->ipacket[1] - 256 : sc->ipacket[1];
2276 y = (sc->ipacket[2] & 0x80) ? sc->ipacket[2] - 256 : sc->ipacket[2];
2277 switch (c & MOUSE_4D_WHEELBITS) {
2284 case 0x40: /* 2nd wheel turning right XXX */
2287 case 0xc0: /* 2nd wheel turning left XXX */
2293 case MOUSE_MODEL_4DPLUS:
2294 if ((x < 16 - 256) && (y < 16 - 256)) {
2296 * b7 b6 b5 b4 b3 b2 b1 b0
2297 * byte 1: 0 0 1 1 1 M R L
2298 * byte 2: 0 0 0 0 1 0 0 0
2299 * byte 3: 0 0 0 0 S s d1 d0
2301 * L, M, R, S: left, middle, right and side buttons
2302 * s: wheel data sign bit
2306 if (sc->ipacket[2] & MOUSE_4DPLUS_BUTTON4DOWN)
2307 ms.button |= MOUSE_BUTTON4DOWN;
2308 z = (sc->ipacket[2] & MOUSE_4DPLUS_ZNEG)
2309 ? ((sc->ipacket[2] & 0x07) - 8)
2310 : (sc->ipacket[2] & 0x07) ;
2312 /* preserve previous button states */
2313 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
2317 case MOUSE_MODEL_GENERIC:
2323 if (sc->mode.accelfactor >= 1) {
2325 x = x * x / sc->mode.accelfactor;
2328 if (c & MOUSE_PS2_XNEG)
2332 y = y * y / sc->mode.accelfactor;
2335 if (c & MOUSE_PS2_YNEG)
2343 ms.flags = ((x || y || z) ? MOUSE_POSCHANGED : 0)
2344 | (ms.obutton ^ ms.button);
2346 if (sc->mode.level < PSM_LEVEL_NATIVE)
2347 sc->inputbytes = tame_mouse(sc, &ms, sc->ipacket);
2349 sc->status.flags |= ms.flags;
2350 sc->status.dx += ms.dx;
2351 sc->status.dy += ms.dy;
2352 sc->status.dz += ms.dz;
2353 sc->status.button = ms.button;
2354 sc->button = ms.button;
2356 sc->watchdog = FALSE;
2359 if (sc->queue.count + sc->inputbytes < sizeof(sc->queue.buf)) {
2360 l = min(sc->inputbytes, sizeof(sc->queue.buf) - sc->queue.tail);
2361 bcopy(&sc->ipacket[0], &sc->queue.buf[sc->queue.tail], l);
2362 if (sc->inputbytes > l)
2363 bcopy(&sc->ipacket[l], &sc->queue.buf[0], sc->inputbytes - l);
2365 (sc->queue.tail + sc->inputbytes) % sizeof(sc->queue.buf);
2366 sc->queue.count += sc->inputbytes;
2370 if (sc->state & PSM_ASLP) {
2371 sc->state &= ~PSM_ASLP;
2372 wakeup((caddr_t) sc);
2374 selwakeup(&sc->rsel);
2379 psmpoll(struct dev_poll_args *ap)
2381 cdev_t dev = ap->a_head.a_dev;
2382 struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
2385 /* Return true if a mouse event available */
2387 if (ap->a_events & (POLLIN | POLLRDNORM)) {
2388 if (sc->queue.count > 0)
2389 revents |= ap->a_events & (POLLIN | POLLRDNORM);
2391 selrecord(curthread, &sc->rsel);
2394 ap->a_events = revents;
2398 /* vendor/model specific routines */
2400 static int mouse_id_proc1(KBDC kbdc, int res, int scale, int *status)
2402 if (set_mouse_resolution(kbdc, res) != res)
2404 if (set_mouse_scaling(kbdc, scale)
2405 && set_mouse_scaling(kbdc, scale)
2406 && set_mouse_scaling(kbdc, scale)
2407 && (get_mouse_status(kbdc, status, 0, 3) >= 3))
2413 mouse_ext_command(KBDC kbdc, int command)
2417 c = (command >> 6) & 0x03;
2418 if (set_mouse_resolution(kbdc, c) != c)
2420 c = (command >> 4) & 0x03;
2421 if (set_mouse_resolution(kbdc, c) != c)
2423 c = (command >> 2) & 0x03;
2424 if (set_mouse_resolution(kbdc, c) != c)
2426 c = (command >> 0) & 0x03;
2427 if (set_mouse_resolution(kbdc, c) != c)
2433 /* Logitech MouseMan Cordless II */
2435 enable_lcordless(struct psm_softc *sc)
2440 if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 2, status))
2442 if (status[1] == PSMD_RES_HIGH)
2444 ch = (status[0] & 0x07) - 1; /* channel # */
2445 if ((ch <= 0) || (ch > 4))
2448 * status[1]: always one?
2449 * status[2]: battery status? (0-100)
2455 /* Genius NetScroll Mouse, MouseSystems SmartScroll Mouse */
2457 enable_groller(struct psm_softc *sc)
2462 * The special sequence to enable the fourth button and the
2463 * roller. Immediately after this sequence check status bytes.
2464 * if the mouse is NetScroll, the second and the third bytes are
2469 * If the mouse is an ordinary PS/2 mouse, the status bytes should
2470 * look like the following.
2472 * byte 1 bit 7 always 0
2473 * bit 6 stream mode (0)
2474 * bit 5 disabled (0)
2475 * bit 4 1:1 scaling (0)
2477 * bit 0-2 button status
2478 * byte 2 resolution (PSMD_RES_HIGH)
2479 * byte 3 report rate (?)
2482 if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 1, status))
2484 if ((status[1] != '3') || (status[2] != 'D'))
2486 /* FIXME: SmartScroll Mouse has 5 buttons! XXX */
2491 /* Genius NetMouse/NetMouse Pro, ASCII Mie Mouse, NetScroll Optical */
2493 enable_gmouse(struct psm_softc *sc)
2498 * The special sequence to enable the middle, "rubber" button.
2499 * Immediately after this sequence check status bytes.
2500 * if the mouse is NetMouse, NetMouse Pro, or ASCII MIE Mouse,
2501 * the second and the third bytes are '3' and 'U'.
2502 * NOTE: NetMouse reports that it has three buttons although it has
2503 * two buttons and a rubber button. NetMouse Pro and MIE Mouse
2504 * say they have three buttons too and they do have a button on the
2507 if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 1, status))
2509 if ((status[1] != '3') || (status[2] != 'U'))
2514 /* ALPS GlidePoint */
2516 enable_aglide(struct psm_softc *sc)
2521 * The special sequence to obtain ALPS GlidePoint specific
2522 * information. Immediately after this sequence, status bytes will
2523 * contain something interesting.
2524 * NOTE: ALPS produces several models of GlidePoint. Some of those
2525 * do not respond to this sequence, thus, cannot be detected this way.
2527 if (set_mouse_sampling_rate(sc->kbdc, 100) != 100)
2529 if (!mouse_id_proc1(sc->kbdc, PSMD_RES_LOW, 2, status))
2531 if ((status[1] == PSMD_RES_LOW) || (status[2] == 100))
2536 /* Kensington ThinkingMouse/Trackball */
2538 enable_kmouse(struct psm_softc *sc)
2540 static unsigned char rate[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20 };
2541 KBDC kbdc = sc->kbdc;
2547 id1 = get_aux_id(kbdc);
2548 if (set_mouse_sampling_rate(kbdc, 10) != 10)
2551 * The device is now in the native mode? It returns a different
2554 id2 = get_aux_id(kbdc);
2555 if ((id1 == id2) || (id2 != 2))
2558 if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
2561 /* at this point, resolution is LOW, sampling rate is 10/sec */
2562 if (get_mouse_status(kbdc, status, 0, 3) < 3)
2567 * The special sequence to enable the third and fourth buttons.
2568 * Otherwise they behave like the first and second buttons.
2570 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2571 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2576 * At this point, the device is using default resolution and
2577 * sampling rate for the native mode.
2579 if (get_mouse_status(kbdc, status, 0, 3) < 3)
2581 if ((status[1] == PSMD_RES_LOW) || (status[2] == rate[i - 1]))
2584 /* the device appears be enabled by this sequence, diable it for now */
2585 disable_aux_dev(kbdc);
2586 empty_aux_buffer(kbdc, 5);
2591 /* Logitech MouseMan+/FirstMouse+, IBM ScrollPoint Mouse */
2593 enable_mmanplus(struct psm_softc *sc)
2595 KBDC kbdc = sc->kbdc;
2598 /* the special sequence to enable the fourth button and the roller. */
2600 * NOTE: for ScrollPoint to respond correctly, the SET_RESOLUTION
2601 * must be called exactly three times since the last RESET command
2602 * before this sequence. XXX
2604 if (!set_mouse_scaling(kbdc, 1))
2606 if (!mouse_ext_command(kbdc, 0x39) || !mouse_ext_command(kbdc, 0xdb))
2608 if (get_mouse_status(kbdc, data, 1, 3) < 3)
2612 * PS2++ protocl, packet type 0
2614 * b7 b6 b5 b4 b3 b2 b1 b0
2615 * byte 1: * 1 p3 p2 1 * * *
2616 * byte 2: 1 1 p1 p0 m1 m0 1 0
2617 * byte 3: m7 m6 m5 m4 m3 m2 m1 m0
2619 * p3-p0: packet type: 0
2620 * m7-m0: model ID: MouseMan+:0x50, FirstMouse+:0x51, ScrollPoint:0x58...
2622 /* check constant bits */
2623 if ((data[0] & MOUSE_PS2PLUS_SYNCMASK) != MOUSE_PS2PLUS_SYNC)
2625 if ((data[1] & 0xc3) != 0xc2)
2627 /* check d3-d0 in byte 2 */
2628 if (!MOUSE_PS2PLUS_CHECKBITS(data))
2631 if (MOUSE_PS2PLUS_PACKET_TYPE(data) != 0)
2634 sc->hw.hwid &= 0x00ff;
2635 sc->hw.hwid |= data[2] << 8; /* save model ID */
2638 * MouseMan+ (or FirstMouse+) is now in its native mode, in which
2639 * the wheel and the fourth button events are encoded in the
2640 * special data packet. The mouse may be put in the IntelliMouse mode
2641 * if it is initialized by the IntelliMouse's method.
2646 /* MS IntelliMouse Explorer */
2648 enable_msexplorer(struct psm_softc *sc)
2650 static unsigned char rate0[] = { 200, 100, 80, };
2651 static unsigned char rate1[] = { 200, 200, 80, };
2652 KBDC kbdc = sc->kbdc;
2656 /* the special sequence to enable the extra buttons and the roller. */
2657 for (i = 0; i < sizeof(rate1)/sizeof(rate1[0]); ++i) {
2658 if (set_mouse_sampling_rate(kbdc, rate1[i]) != rate1[i])
2661 /* the device will give the genuine ID only after the above sequence */
2662 id = get_aux_id(kbdc);
2663 if (id != PSM_EXPLORER_ID)
2667 sc->hw.buttons = 5; /* IntelliMouse Explorer XXX */
2670 * XXX: this is a kludge to fool some KVM switch products
2671 * which think they are clever enough to know the 4-byte IntelliMouse
2672 * protocol, and assume any other protocols use 3-byte packets.
2673 * They don't convey 4-byte data packets from the IntelliMouse Explorer
2674 * correctly to the host computer because of this!
2675 * The following sequence is actually IntelliMouse's "wake up"
2676 * sequence; it will make the KVM think the mouse is IntelliMouse
2677 * when it is in fact IntelliMouse Explorer.
2679 for (i = 0; i < sizeof(rate0)/sizeof(rate0[0]); ++i) {
2680 if (set_mouse_sampling_rate(kbdc, rate0[i]) != rate0[i])
2683 id = get_aux_id(kbdc);
2688 /* MS IntelliMouse */
2690 enable_msintelli(struct psm_softc *sc)
2693 * Logitech MouseMan+ and FirstMouse+ will also respond to this
2694 * probe routine and act like IntelliMouse.
2697 static unsigned char rate[] = { 200, 100, 80, };
2698 KBDC kbdc = sc->kbdc;
2702 /* the special sequence to enable the third button and the roller. */
2703 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2704 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2707 /* the device will give the genuine ID only after the above sequence */
2708 id = get_aux_id(kbdc);
2709 if (id != PSM_INTELLI_ID)
2718 /* A4 Tech 4D Mouse */
2720 enable_4dmouse(struct psm_softc *sc)
2723 * Newer wheel mice from A4 Tech may use the 4D+ protocol.
2726 static unsigned char rate[] = { 200, 100, 80, 60, 40, 20 };
2727 KBDC kbdc = sc->kbdc;
2731 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2732 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2735 id = get_aux_id(kbdc);
2737 * WinEasy 4D, 4 Way Scroll 4D: 6
2738 * Cable-Free 4D: 8 (4DPLUS)
2739 * WinBest 4D+, 4 Way Scroll 4D+: 8 (4DPLUS)
2741 if (id != PSM_4DMOUSE_ID)
2745 sc->hw.buttons = 3; /* XXX some 4D mice have 4? */
2750 /* A4 Tech 4D+ Mouse */
2752 enable_4dplus(struct psm_softc *sc)
2755 * Newer wheel mice from A4 Tech seem to use this protocol.
2756 * Older models are recognized as either 4D Mouse or IntelliMouse.
2758 KBDC kbdc = sc->kbdc;
2762 * enable_4dmouse() already issued the following ID sequence...
2763 static unsigned char rate[] = { 200, 100, 80, 60, 40, 20 };
2766 for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2767 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2772 id = get_aux_id(kbdc);
2773 if (id != PSM_4DPLUS_ID)
2777 sc->hw.buttons = 4; /* XXX */
2782 /* Interlink electronics VersaPad */
2784 enable_versapad(struct psm_softc *sc)
2786 KBDC kbdc = sc->kbdc;
2789 set_mouse_resolution(kbdc, PSMD_RES_MEDIUM_HIGH); /* set res. 2 */
2790 set_mouse_sampling_rate(kbdc, 100); /* set rate 100 */
2791 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
2792 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
2793 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
2794 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
2795 if (get_mouse_status(kbdc, data, 0, 3) < 3) /* get status */
2797 if (data[2] != 0xa || data[1] != 0 ) /* rate == 0xa && res. == 0 */
2799 set_mouse_scaling(kbdc, 1); /* set scale 1:1 */
2801 sc->config |= PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND;
2803 return TRUE; /* PS/2 absolute mode */
2807 psmresume(device_t dev)
2809 struct psm_softc *sc = device_get_softc(dev);
2810 int unit = device_get_unit(dev);
2814 log(LOG_NOTICE, "psm%d: system resume hook called.\n", unit);
2816 if (!(sc->config & PSM_CONFIG_HOOKRESUME))
2819 err = reinitialize(sc, sc->config & PSM_CONFIG_INITAFTERSUSPEND);
2821 if ((sc->state & PSM_ASLP) && !(sc->state & PSM_VALID)) {
2823 * Release the blocked process; it must be notified that the device
2824 * cannot be accessed anymore.
2826 sc->state &= ~PSM_ASLP;
2827 wakeup((caddr_t)sc);
2831 log(LOG_DEBUG, "psm%d: system resume hook exiting.\n", unit);
2836 DRIVER_MODULE(psm, atkbdc, psm_driver, psm_devclass, 0, 0);