sys/dev/misc/psm/psm.c

   1 /*-
   2  * Copyright (c) 1992, 1993 Erik Forsberg.
   3  * Copyright (c) 1996, 1997 Kazutaka YOKOTA.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * THIS SOFTWARE IS PROVIDED BY ``AS IS'' AND ANY EXPRESS OR IMPLIED
  13  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  14  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
  15  * NO EVENT SHALL I BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  16  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  17  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  18  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  19  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  20  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  21  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  22  *
  23  * $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.25 2007/06/13 17:15:25 dillon Exp $
  25  */
  26
  27 /*
  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
  31  *
  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
  37  *  to 386bsd.
  38  *
  39  *  Further modifications for latest 386BSD+patchkit and port to NetBSD,
  40  *  Andrew Herbert <andrew@werple.apana.org.au> - 8 June 1993
  41  *
  42  *  Cloned from the Microsoft Bus Mouse driver, also by Erik Forsberg, by
  43  *  Andrew Herbert - 12 June 1993
  44  *
  45  *  Modified for PS/2 mouse by Charles Hannum <mycroft@ai.mit.edu>
  46  *  - 13 June 1993
  47  *
  48  *  Modified for PS/2 AUX mouse by Shoji Yuen <yuen@nuie.nagoya-u.ac.jp>
  49  *  - 24 October 1993
  50  *
  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.
  63  */
  64
  65 #include "opt_psm.h"
  66
  67 #include <sys/param.h>
  68 #include <sys/systm.h>
  69 #include <sys/kernel.h>
  70 #include <sys/module.h>
  71 #include <sys/bus.h>
  72 #include <sys/conf.h>
  73 #include <sys/device.h>
  74 #include <sys/event.h>
  75 #include <sys/syslog.h>
  76 #include <sys/malloc.h>
  77 #include <sys/rman.h>
  78 #include <sys/selinfo.h>
  79 #include <sys/thread2.h>
  80 #include <sys/time.h>
  81 #include <sys/uio.h>
  82
  83 #include <machine/clock.h>
  84 #include <machine/limits.h>
  85 #include <machine/mouse.h>
  86
  87 #include <bus/isa/isavar.h>
  88 #include <dev/misc/kbd/atkbdcreg.h>
  89
  90 /*
  91  * Driver specific options: the following options may be set by
  92  * `options' statements in the kernel configuration file.
  93  */
  94
  95 /* debugging */
  96 #ifndef PSM_DEBUG
  97 #define PSM_DEBUG       0       /* logging: 0: none, 1: brief, 2: verbose */
  98 #endif
  99
 100 #ifndef PSM_SYNCERR_THRESHOLD1
 101 #define PSM_SYNCERR_THRESHOLD1  20
 102 #endif
 103
 104 #ifndef PSM_INPUT_TIMEOUT
 105 #define PSM_INPUT_TIMEOUT       2000000 /* 2 sec */
 106 #endif
 107
 108 /* end of driver specific options */
 109
 110 #define PSM_DRIVER_NAME         "psm"
 111 #define PSMCPNP_DRIVER_NAME     "psmcpnp"
 112
 113 /* input queue */
 114 #define PSM_BUFSIZE             960
 115 #define PSM_SMALLBUFSIZE        240
 116
 117 /* operation levels */
 118 #define PSM_LEVEL_BASE          0
 119 #define PSM_LEVEL_STANDARD      1
 120 #define PSM_LEVEL_NATIVE        2
 121 #define PSM_LEVEL_MIN           PSM_LEVEL_BASE
 122 #define PSM_LEVEL_MAX           PSM_LEVEL_NATIVE
 123
 124 /* Logitech PS2++ protocol */
 125 #define MOUSE_PS2PLUS_CHECKBITS(b)      \
 126                                 ((((b[2] & 0x03) << 2) | 0x02) == (b[1] & 0x0f))
 127 #define MOUSE_PS2PLUS_PACKET_TYPE(b)    \
 128                                 (((b[0] & 0x30) >> 2) | ((b[1] & 0x30) >> 4))
 129
 130 /* some macros */
 131 #define PSM_UNIT(dev)           (minor(dev) >> 1)
 132 #define PSM_NBLOCKIO(dev)       (minor(dev) & 1)
 133 #define PSM_MKMINOR(unit,block) ((((unit) & 0xff) << 1) | ((block) ? 0:1))
 134
 135 #ifndef max
 136 #define max(x,y)                ((x) > (y) ? (x) : (y))
 137 #endif
 138 #ifndef min
 139 #define min(x,y)                ((x) < (y) ? (x) : (y))
 140 #endif
 141
 142 #define abs(x)                  (((x) < 0) ? -(x) : (x))
 143
 144 /* ring buffer */
 145 typedef struct ringbuf {
 146     int           count;        /* # of valid elements in the buffer */
 147     int           head;         /* head pointer */
 148     int           tail;         /* tail poiner */
 149     unsigned char buf[PSM_BUFSIZE];
 150 } ringbuf_t;
 151
 152 /* driver control block */
 153 struct psm_softc {              /* Driver status information */
 154     int           unit;
 155     struct selinfo rsel;        /* Process selecting for Input */
 156     unsigned char state;        /* Mouse driver state */
 157     int           config;       /* driver configuration flags */
 158     int           flags;        /* other flags */
 159     KBDC          kbdc;         /* handle to access the keyboard controller */
 160     struct resource *intr;      /* IRQ resource */
 161     void          *ih;          /* interrupt handle */
 162     mousehw_t     hw;           /* hardware information */
 163     mousemode_t   mode;         /* operation mode */
 164     mousemode_t   dflt_mode;    /* default operation mode */
 165     mousestatus_t status;       /* accumulated mouse movement */
 166     ringbuf_t     queue;        /* mouse status queue */
 167     unsigned char ipacket[16];  /* interim input buffer */
 168     int           inputbytes;   /* # of bytes in the input buffer */
 169     int           button;       /* the latest button state */
 170     int           xold; /* previous absolute X position */
 171     int           yold; /* previous absolute Y position */
 172     int           syncerrors;
 173     struct timeval inputtimeout;
 174     int           watchdog;     /* watchdog timer flag */
 175     struct callout callout;     /* watchdog timer call out */
 176 };
 177 devclass_t psm_devclass;
 178 #define PSM_SOFTC(unit) ((struct psm_softc*)devclass_get_softc(psm_devclass, unit))
 179
 180 /* driver state flags (state) */
 181 #define PSM_VALID               0x80
 182 #define PSM_OPEN                1       /* Device is open */
 183 #define PSM_ASLP                2       /* Waiting for mouse data */
 184
 185 /* driver configuration flags (config) */
 186 #define PSM_CONFIG_RESOLUTION   0x000f  /* resolution */
 187 #define PSM_CONFIG_ACCEL        0x00f0  /* acceleration factor */
 188 #define PSM_CONFIG_NOCHECKSYNC  0x0100  /* disable sync. test */
 189 #define PSM_CONFIG_NOIDPROBE    0x0200  /* disable mouse model probe */
 190 #define PSM_CONFIG_NORESET      0x0400  /* don't reset the mouse */
 191 #define PSM_CONFIG_FORCETAP     0x0800  /* assume `tap' action exists */
 192 #define PSM_CONFIG_IGNPORTERROR 0x1000  /* ignore error in aux port test */
 193 #define PSM_CONFIG_HOOKRESUME   0x2000  /* hook the system resume event */
 194 #define PSM_CONFIG_INITAFTERSUSPEND 0x4000 /* init the device at the resume event */
 195 #define PSM_CONFIG_SYNCHACK     0x8000 /* enable `out-of-sync' hack */
 196
 197 #define PSM_CONFIG_FLAGS        (PSM_CONFIG_RESOLUTION          \
 198                                     | PSM_CONFIG_ACCEL          \
 199                                     | PSM_CONFIG_NOCHECKSYNC    \
 200                                     | PSM_CONFIG_SYNCHACK       \
 201                                     | PSM_CONFIG_NOIDPROBE      \
 202                                     | PSM_CONFIG_NORESET        \
 203                                     | PSM_CONFIG_FORCETAP       \
 204                                     | PSM_CONFIG_IGNPORTERROR   \
 205                                     | PSM_CONFIG_HOOKRESUME     \
 206                                     | PSM_CONFIG_INITAFTERSUSPEND)
 207
 208 /* other flags (flags) */
 209 #define PSM_FLAGS_FINGERDOWN    0x0001 /* VersaPad finger down */
 210
 211 /* for backward compatibility */
 212 #define OLD_MOUSE_GETHWINFO     _IOR('M', 1, old_mousehw_t)
 213 #define OLD_MOUSE_GETMODE       _IOR('M', 2, old_mousemode_t)
 214 #define OLD_MOUSE_SETMODE       _IOW('M', 3, old_mousemode_t)
 215
 216 typedef struct old_mousehw {
 217     int buttons;
 218     int iftype;
 219     int type;
 220     int hwid;
 221 } old_mousehw_t;
 222
 223 typedef struct old_mousemode {
 224     int protocol;
 225     int rate;
 226     int resolution;
 227     int accelfactor;
 228 } old_mousemode_t;
 229
 230 /* packet formatting function */
 231 typedef int packetfunc_t (struct psm_softc *, unsigned char *,
 232                               int *, int, mousestatus_t *);
 233
 234 /* function prototypes */
 235 static int psmprobe (device_t);
 236 static int psmattach (device_t);
 237 static int psmdetach (device_t);
 238 static int psmresume (device_t);
 239
 240 static d_open_t psmopen;
 241 static d_close_t psmclose;
 242 static d_read_t psmread;
 243 static d_ioctl_t psmioctl;
 244 static d_kqfilter_t psmkqfilter;
 245
 246 static int enable_aux_dev (KBDC);
 247 static int disable_aux_dev (KBDC);
 248 static int get_mouse_status (KBDC, int *, int, int);
 249 static int get_aux_id (KBDC);
 250 static int set_mouse_sampling_rate (KBDC, int);
 251 static int set_mouse_scaling (KBDC, int);
 252 static int set_mouse_resolution (KBDC, int);
 253 static int set_mouse_mode (KBDC);
 254 static int get_mouse_buttons (KBDC);
 255 static int is_a_mouse (int);
 256 static void recover_from_error (KBDC);
 257 static int restore_controller (KBDC, int);
 258 static int doinitialize (struct psm_softc *, mousemode_t *);
 259 static int doopen (struct psm_softc *, int);
 260 static int reinitialize (struct psm_softc *, int);
 261 static char *model_name (int);
 262 static void psmintr (void *);
 263 static void psmtimeout (void *);
 264 static void psmfilter_detach(struct knote *);
 265 static int psmfilter(struct knote *, long);
 266
 267 /* vendor specific features */
 268 typedef int probefunc_t (struct psm_softc *);
 269
 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 *);
 283
 284 static struct {
 285     int                 model;
 286     unsigned char       syncmask;
 287     int                 packetsize;
 288     probefunc_t         *probefunc;
 289 } vendortype[] = {
 290     /*
 291      * WARNING: the order of probe is very important.  Don't mess it
 292      * unless you know what you are doing.
 293      */
 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, },
 316 };
 317 #define GENERIC_MOUSE_ENTRY     ((sizeof(vendortype) / sizeof(*vendortype)) - 1)
 318
 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),
 326
 327         { 0, 0 }
 328 };
 329
 330 static driver_t psm_driver = {
 331     PSM_DRIVER_NAME,
 332     psm_methods,
 333     sizeof(struct psm_softc),
 334 };
 335
 336 #if notyet
 337 static struct isa_pnp_id psm_ids[] = {
 338     { 0x130fd041, "PS/2 mouse port" },                  /* PNP0F13 */
 339     { 0x1303d041, "PS/2 port" },                        /* PNP0313, XXX */
 340     { 0 }
 341 };
 342 #endif
 343
 344 #define CDEV_MAJOR        21
 345
 346 static struct dev_ops psm_ops = {
 347         { PSM_DRIVER_NAME, CDEV_MAJOR, D_KQFILTER },
 348         .d_open =       psmopen,
 349         .d_close =      psmclose,
 350         .d_read =       psmread,
 351         .d_ioctl =      psmioctl,
 352         .d_kqfilter =   psmkqfilter
 353 };
 354
 355 /* debug message level */
 356 static int verbose = PSM_DEBUG;
 357
 358 /* device I/O routines */
 359 static int
 360 enable_aux_dev(KBDC kbdc)
 361 {
 362     int res;
 363
 364     res = send_aux_command(kbdc, PSMC_ENABLE_DEV);
 365     if (verbose >= 2)
 366         log(LOG_DEBUG, "psm: ENABLE_DEV return code:%04x\n", res);
 367
 368     return (res == PSM_ACK);
 369 }
 370
 371 static int
 372 disable_aux_dev(KBDC kbdc)
 373 {
 374     int res;
 375
 376     res = send_aux_command(kbdc, PSMC_DISABLE_DEV);
 377     if (verbose >= 2)
 378         log(LOG_DEBUG, "psm: DISABLE_DEV return code:%04x\n", res);
 379
 380     return (res == PSM_ACK);
 381 }
 382
 383 static int
 384 get_mouse_status(KBDC kbdc, int *status, int flag, int len)
 385 {
 386     int cmd;
 387     int res;
 388     int i;
 389
 390     switch (flag) {
 391     case 0:
 392     default:
 393         cmd = PSMC_SEND_DEV_STATUS;
 394         break;
 395     case 1:
 396         cmd = PSMC_SEND_DEV_DATA;
 397         break;
 398     }
 399     empty_aux_buffer(kbdc, 5);
 400     res = send_aux_command(kbdc, cmd);
 401     if (verbose >= 2)
 402         log(LOG_DEBUG, "psm: SEND_AUX_DEV_%s return code:%04x\n",
 403             (flag == 1) ? "DATA" : "STATUS", res);
 404     if (res != PSM_ACK)
 405         return 0;
 406
 407     for (i = 0; i < len; ++i) {
 408         status[i] = read_aux_data(kbdc);
 409         if (status[i] < 0)
 410             break;
 411     }
 412
 413     if (verbose) {
 414         log(LOG_DEBUG, "psm: %s %02x %02x %02x\n",
 415             (flag == 1) ? "data" : "status", status[0], status[1], status[2]);
 416     }
 417
 418     return i;
 419 }
 420
 421 static int
 422 get_aux_id(KBDC kbdc)
 423 {
 424     int res;
 425     int id;
 426
 427     empty_aux_buffer(kbdc, 5);
 428     res = send_aux_command(kbdc, PSMC_SEND_DEV_ID);
 429     if (verbose >= 2)
 430         log(LOG_DEBUG, "psm: SEND_DEV_ID return code:%04x\n", res);
 431     if (res != PSM_ACK)
 432         return (-1);
 433
 434     /* 10ms delay */
 435     DRIVERSLEEP(10000);
 436
 437     id = read_aux_data(kbdc);
 438     if (verbose >= 2)
 439         log(LOG_DEBUG, "psm: device ID: %04x\n", id);
 440
 441     return id;
 442 }
 443
 444 static int
 445 set_mouse_sampling_rate(KBDC kbdc, int rate)
 446 {
 447     int res;
 448
 449     res = send_aux_command_and_data(kbdc, PSMC_SET_SAMPLING_RATE, rate);
 450     if (verbose >= 2)
 451         log(LOG_DEBUG, "psm: SET_SAMPLING_RATE (%d) %04x\n", rate, res);
 452
 453     return ((res == PSM_ACK) ? rate : -1);
 454 }
 455
 456 static int
 457 set_mouse_scaling(KBDC kbdc, int scale)
 458 {
 459     int res;
 460
 461     switch (scale) {
 462     case 1:
 463     default:
 464         scale = PSMC_SET_SCALING11;
 465         break;
 466     case 2:
 467         scale = PSMC_SET_SCALING21;
 468         break;
 469     }
 470     res = send_aux_command(kbdc, scale);
 471     if (verbose >= 2)
 472         log(LOG_DEBUG, "psm: SET_SCALING%s return code:%04x\n",
 473             (scale == PSMC_SET_SCALING21) ? "21" : "11", res);
 474
 475     return (res == PSM_ACK);
 476 }
 477
 478 /* `val' must be 0 through PSMD_MAX_RESOLUTION */
 479 static int
 480 set_mouse_resolution(KBDC kbdc, int val)
 481 {
 482     int res;
 483
 484     res = send_aux_command_and_data(kbdc, PSMC_SET_RESOLUTION, val);
 485     if (verbose >= 2)
 486         log(LOG_DEBUG, "psm: SET_RESOLUTION (%d) %04x\n", val, res);
 487
 488     return ((res == PSM_ACK) ? val : -1);
 489 }
 490
 491 /*
 492  * NOTE: once `set_mouse_mode()' is called, the mouse device must be
 493  * re-enabled by calling `enable_aux_dev()'
 494  */
 495 static int
 496 set_mouse_mode(KBDC kbdc)
 497 {
 498     int res;
 499
 500     res = send_aux_command(kbdc, PSMC_SET_STREAM_MODE);
 501     if (verbose >= 2)
 502         log(LOG_DEBUG, "psm: SET_STREAM_MODE return code:%04x\n", res);
 503
 504     return (res == PSM_ACK);
 505 }
 506
 507 static int
 508 get_mouse_buttons(KBDC kbdc)
 509 {
 510     int c = 2;          /* assume two buttons by default */
 511     int status[3];
 512
 513     /*
 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.
 519      */
 520     if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
 521         return c;
 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)) {
 525         if (status[1] != 0)
 526             return status[1];
 527     }
 528     return c;
 529 }
 530
 531 /* misc subroutines */
 532 /*
 533  * Someday, I will get the complete list of valid pointing devices and
 534  * their IDs... XXX
 535  */
 536 static int
 537 is_a_mouse(int id)
 538 {
 539 #if 0
 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 */
 546     };
 547     int i;
 548
 549     for (i = 0; valid_ids[i] >= 0; ++i)
 550         if (valid_ids[i] == id)
 551             return TRUE;
 552     return FALSE;
 553 #else
 554     return TRUE;
 555 #endif
 556 }
 557
 558 static char *
 559 model_name(int model)
 560 {
 561     static struct {
 562         int model_code;
 563         char *model_name;
 564     } models[] = {
 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 },
 577     };
 578     int i;
 579
 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;
 583     }
 584     return "Unknown";
 585 }
 586
 587 static void
 588 recover_from_error(KBDC kbdc)
 589 {
 590     /* discard anything left in the output buffer */
 591     empty_both_buffers(kbdc, 10);
 592
 593 #if 0
 594     /*
 595      * NOTE: KBDC_RESET_KBD may not restore the communication between the
 596      * keyboard and the controller.
 597      */
 598     reset_kbd(kbdc);
 599 #else
 600     /*
 601      * NOTE: somehow diagnostic and keyboard port test commands bring the
 602      * keyboard back.
 603      */
 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) {
 608         if (verbose)
 609             log(LOG_ERR, "psm: keyboard port failed.\n");
 610     }
 611 #endif
 612 }
 613
 614 static int
 615 restore_controller(KBDC kbdc, int command_byte)
 616 {
 617     empty_both_buffers(kbdc, 10);
 618
 619     if (!set_controller_command_byte(kbdc, 0xff, command_byte)) {
 620         log(LOG_ERR, "psm: failed to restore the keyboard controller "
 621                      "command byte.\n");
 622         empty_both_buffers(kbdc, 10);
 623         return FALSE;
 624     } else {
 625         empty_both_buffers(kbdc, 10);
 626         return TRUE;
 627     }
 628 }
 629
 630 /*
 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.
 636  */
 637 static int
 638 doinitialize(struct psm_softc *sc, mousemode_t *mode)
 639 {
 640     KBDC kbdc = sc->kbdc;
 641     int stat[3];
 642     int i;
 643
 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 */
 647     case 3:
 648     case PSM_ACK:
 649         if (verbose)
 650             log(LOG_DEBUG, "psm%d: strange result for test aux port (%d).\n",
 651                 sc->unit, i);
 652         /* fall though */
 653     case 0:     /* no error */
 654         break;
 655     case -1:    /* time out */
 656     default:    /* error */
 657         recover_from_error(kbdc);
 658         if (sc->config & PSM_CONFIG_IGNPORTERROR)
 659             break;
 660         log(LOG_ERR, "psm%d: the aux port is not functioning (%d).\n",
 661             sc->unit, i);
 662         return FALSE;
 663     }
 664
 665     if (sc->config & PSM_CONFIG_NORESET) {
 666         /*
 667          * Don't try to reset the pointing device.  It may possibly be
 668          * left in the unknown state, though...
 669          */
 670     } else {
 671         /*
 672          * NOTE: some controllers appears to hang the `keyboard' when
 673          * the aux port doesn't exist and `PSMC_RESET_DEV' is issued.
 674          */
 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);
 678             return FALSE;
 679         }
 680     }
 681
 682     /*
 683      * both the aux port and the aux device is functioning, see
 684      * if the device can be enabled.
 685      */
 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);
 688         return FALSE;
 689     }
 690     empty_both_buffers(kbdc, 10);       /* remove stray data if any */
 691
 692     if (sc->config & PSM_CONFIG_NOIDPROBE) {
 693         i = GENERIC_MOUSE_ENTRY;
 694     } else {
 695         /* FIXME: hardware ID, mouse buttons? */
 696
 697         /* other parameters */
 698         for (i = 0; vendortype[i].probefunc != NULL; ++i) {
 699             if ((*vendortype[i].probefunc)(sc)) {
 700                 if (verbose >= 2)
 701                     log(LOG_ERR, "psm%d: found %s\n",
 702                         sc->unit, model_name(vendortype[i].model));
 703                 break;
 704             }
 705         }
 706     }
 707
 708     sc->hw.model = vendortype[i].model;
 709     sc->mode.packetsize = vendortype[i].packetsize;
 710
 711     /* set mouse parameters */
 712     if (mode != NULL) {
 713         if (mode->rate > 0)
 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);
 719     }
 720
 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",
 724             sc->unit);
 725         sc->mode.syncmask[0] = 0;
 726     } else {
 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);
 730     }
 731
 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",
 735             sc->unit);
 736
 737     return TRUE;
 738 }
 739
 740 static int
 741 doopen(struct psm_softc *sc, int command_byte)
 742 {
 743     int stat[3];
 744
 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...
 752          */
 753         recover_from_error(sc->kbdc);
 754 #if 0
 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...
 758          */
 759         if (!doinitialize(sc, &sc->mode) || !enable_aux_dev(sc->kbdc)) {
 760             recover_from_error(sc->kbdc);
 761 #else
 762         {
 763 #endif
 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",
 768                 sc->unit);
 769             return (EIO);
 770         }
 771     }
 772
 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);
 775
 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",
 785             sc->unit);
 786         return (EIO);
 787     }
 788
 789     /* start the watchdog timer */
 790     sc->watchdog = FALSE;
 791     callout_reset(&sc->callout, hz * 2, psmtimeout, (void *)(uintptr_t)sc);
 792
 793     return (0);
 794 }
 795
 796 static int
 797 reinitialize(struct psm_softc *sc, int doinit)
 798 {
 799     int err;
 800     int c;
 801
 802     /* don't let anybody mess with the aux device */
 803     if (!kbdc_lock(sc->kbdc, TRUE))
 804         return (EIO);
 805     crit_enter();
 806
 807     /* block our watchdog timer */
 808     sc->watchdog = FALSE;
 809     callout_stop(&sc->callout);
 810
 811     /* save the current controller command byte */
 812     empty_both_buffers(sc->kbdc, 10);
 813     c = get_controller_command_byte(sc->kbdc);
 814     if (verbose >= 2)
 815         log(LOG_DEBUG, "psm%d: current command byte: %04x (reinitialize).\n",
 816             sc->unit, c);
 817
 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 */
 824         crit_exit();
 825         kbdc_lock(sc->kbdc, FALSE);
 826         log(LOG_ERR, "psm%d: unable to set the command byte (reinitialize).\n",
 827             sc->unit);
 828         return (EIO);
 829     }
 830
 831     /* flush any data */
 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);
 835     }
 836     sc->inputbytes = 0;
 837     sc->syncerrors = 0;
 838
 839     /* try to detect the aux device; are you still there? */
 840     err = 0;
 841     if (doinit) {
 842         if (doinitialize(sc, &sc->mode)) {
 843             /* yes */
 844             sc->state |= PSM_VALID;
 845         } else {
 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",
 850                 sc->unit);
 851             err = ENXIO;
 852         }
 853     }
 854     crit_exit();
 855
 856     /* restore the driver state */
 857     if ((sc->state & PSM_OPEN) && (err == 0)) {
 858         /* enable the aux device and the port again */
 859         err = doopen(sc, c);
 860         if (err != 0)
 861             log(LOG_ERR, "psm%d: failed to enable the device (reinitialize).\n",
 862                 sc->unit);
 863     } else {
 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",
 871                 sc->unit);
 872             err = EIO;
 873         }
 874     }
 875
 876     kbdc_lock(sc->kbdc, FALSE);
 877     return (err);
 878 }
 879
 880 /* psm driver entry points */
 881
 882 #define endprobe(v)     {   if (bootverbose)                            \
 883                                 --verbose;                              \
 884                             kbdc_set_device_mask(sc->kbdc, mask);       \
 885                             kbdc_lock(sc->kbdc, FALSE);                 \
 886                             return (v);                                 \
 887                         }
 888
 889 static int
 890 psmprobe(device_t dev)
 891 {
 892     int unit = device_get_unit(dev);
 893     struct psm_softc *sc = device_get_softc(dev);
 894     uintptr_t irq;
 895     uintptr_t flags;
 896     int stat[3];
 897     int command_byte;
 898     int mask;
 899     int rid;
 900     int i;
 901
 902 #if 0
 903     kbdc_debug(TRUE);
 904 #endif
 905
 906 #if notyet
 907     /* check PnP IDs */
 908     if (XXX_PNP_PROBE(device_get_parent(dev), dev, psm_ids) == ENXIO)
 909         return ENXIO;
 910 #endif
 911
 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);
 914
 915     sc->unit = unit;
 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)
 920     sc->config |=
 921 #ifdef PSM_RESETAFTERSUSPEND
 922         PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND;
 923 #else
 924         PSM_CONFIG_HOOKRESUME;
 925 #endif
 926 #endif /* PSM_HOOKRESUME | PSM_HOOKAPM */
 927     sc->flags = 0;
 928     if (bootverbose)
 929         ++verbose;
 930
 931     device_set_desc(dev, "PS/2 Mouse");
 932
 933     if (!kbdc_lock(sc->kbdc, TRUE)) {
 934         kprintf("psm%d: unable to lock the controller.\n", unit);
 935         if (bootverbose)
 936             --verbose;
 937         return (ENXIO);
 938     }
 939
 940     /*
 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).
 944      */
 945
 946     /* discard anything left after the keyboard initialization */
 947     empty_both_buffers(sc->kbdc, 10);
 948
 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);
 952     if (verbose)
 953         kprintf("psm%d: current command byte:%04x\n", unit, command_byte);
 954     if (command_byte == -1) {
 955         /* CONTROLLER ERROR */
 956         kprintf("psm%d: unable to get the current command byte value.\n",
 957             unit);
 958         endprobe(ENXIO);
 959     }
 960
 961     /*
 962      * disable the keyboard port while probing the aux port, which must be
 963      * enabled during this routine
 964      */
 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)) {
 969         /*
 970          * this is CONTROLLER ERROR; I don't know how to recover
 971          * from this error...
 972          */
 973         restore_controller(sc->kbdc, command_byte);
 974         kprintf("psm%d: unable to set the command byte.\n", unit);
 975         endprobe(ENXIO);
 976     }
 977     write_controller_command(sc->kbdc, KBDC_ENABLE_AUX_PORT);
 978
 979     /*
 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
 988      * passes this test.
 989      *
 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)...
 995      */
 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 */
 999     case 3:
1000     case PSM_ACK:
1001         if (verbose)
1002             kprintf("psm%d: strange result for test aux port (%d).\n",
1003                 unit, i);
1004         /* fall though */
1005     case 0:        /* no error */
1006         break;
1007     case -1:        /* time out */
1008     default:        /* error */
1009         recover_from_error(sc->kbdc);
1010         if (sc->config & PSM_CONFIG_IGNPORTERROR)
1011             break;
1012         restore_controller(sc->kbdc, command_byte);
1013         if (verbose)
1014             kprintf("psm%d: the aux port is not functioning (%d).\n",
1015                 unit, i);
1016         endprobe(ENXIO);
1017     }
1018
1019     if (sc->config & PSM_CONFIG_NORESET) {
1020         /*
1021          * Don't try to reset the pointing device.  It may possibly be
1022          * left in the unknown state, though...
1023          */
1024     } else {
1025         /*
1026          * NOTE: some controllers appears to hang the `keyboard' when the aux
1027          * port doesn't exist and `PSMC_RESET_DEV' is issued.
1028          *
1029          * Attempt to reset the controller twice -- this helps
1030          * pierce through some KVM switches. The second reset
1031          * is non-fatal.
1032          */
1033         if (!reset_aux_dev(sc->kbdc)) {
1034             recover_from_error(sc->kbdc);
1035             restore_controller(sc->kbdc, command_byte);
1036             if (verbose)
1037                 kprintf("psm%d: failed to reset the aux device.\n", unit);
1038             endprobe(ENXIO);
1039         } else if (!reset_aux_dev(sc->kbdc)) {
1040             recover_from_error(sc->kbdc);
1041             if (verbose >= 2)
1042                 kprintf("psm%d: failed to reset the aux device (2).\n",
1043                     unit);
1044         }
1045     }
1046
1047     /*
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.
1052      */
1053     if (!enable_aux_dev(sc->kbdc) || !disable_aux_dev(sc->kbdc)) {
1054         /* MOUSE ERROR */
1055         recover_from_error(sc->kbdc);
1056         restore_controller(sc->kbdc, command_byte);
1057         if (verbose)
1058             kprintf("psm%d: failed to enable the aux device.\n", unit);
1059         endprobe(ENXIO);
1060     }
1061
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];
1066     } else {
1067         sc->dflt_mode.rate = sc->mode.rate = -1;
1068         sc->dflt_mode.resolution = sc->mode.resolution = -1;
1069     }
1070
1071     /* hardware information */
1072     sc->hw.iftype = MOUSE_IF_PS2;
1073
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);
1078         if (verbose)
1079             kprintf("psm%d: unknown device type (%d).\n", unit, sc->hw.hwid);
1080         endprobe(ENXIO);
1081     }
1082     switch (sc->hw.hwid) {
1083     case PSM_BALLPOINT_ID:
1084         sc->hw.type = MOUSE_TRACKBALL;
1085         break;
1086     case PSM_MOUSE_ID:
1087     case PSM_INTELLI_ID:
1088     case PSM_EXPLORER_ID:
1089     case PSM_4DMOUSE_ID:
1090     case PSM_4DPLUS_ID:
1091         sc->hw.type = MOUSE_MOUSE;
1092         break;
1093     default:
1094         sc->hw.type = MOUSE_UNKNOWN;
1095         break;
1096     }
1097
1098     if (sc->config & PSM_CONFIG_NOIDPROBE) {
1099         sc->hw.buttons = 2;
1100         i = GENERIC_MOUSE_ENTRY;
1101     } else {
1102         /* # of buttons */
1103         sc->hw.buttons = get_mouse_buttons(sc->kbdc);
1104
1105         /* other parameters */
1106         for (i = 0; vendortype[i].probefunc != NULL; ++i) {
1107             if ((*vendortype[i].probefunc)(sc)) {
1108                 if (verbose >= 2)
1109                     kprintf("psm%d: found %s\n",
1110                            unit, model_name(vendortype[i].model));
1111                 break;
1112             }
1113         }
1114     }
1115
1116     sc->hw.model = vendortype[i].model;
1117
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;
1123     else
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;
1130
1131     /* set mouse parameters */
1132 #if 0
1133     /*
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.
1137      */
1138     i = send_aux_command(sc->kbdc, PSMC_SET_DEFAULTS);
1139     if (verbose >= 2)
1140         kprintf("psm%d: SET_DEFAULTS return code:%04x\n", unit, i);
1141 #endif
1142     if (sc->config & PSM_CONFIG_RESOLUTION) {
1143         sc->mode.resolution
1144             = set_mouse_resolution(sc->kbdc,
1145                                    (sc->config & PSM_CONFIG_RESOLUTION) - 1);
1146     } else if (sc->mode.resolution >= 0) {
1147         sc->mode.resolution
1148             = set_mouse_resolution(sc->kbdc, sc->dflt_mode.resolution);
1149     }
1150     if (sc->mode.rate > 0) {
1151         sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, sc->dflt_mode.rate);
1152     }
1153     set_mouse_scaling(sc->kbdc, 1);
1154
1155     /* request a data packet and extract sync. bits */
1156     if (get_mouse_status(sc->kbdc, stat, 1, 3) < 3) {
1157         kprintf("psm%d: failed to get data.\n", unit);
1158         sc->mode.syncmask[0] = 0;
1159     } else {
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);
1163     }
1164
1165     /* just check the status of the mouse */
1166     /*
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.
1170      */
1171     if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3) {
1172         kprintf("psm%d: failed to get status.\n", unit);
1173     } else {
1174         /*
1175          * When in its native mode, some mice operate with different
1176          * default parameters than in the PS/2 compatible mode.
1177          */
1178         sc->dflt_mode.rate = sc->mode.rate = stat[2];
1179         sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1180      }
1181
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)) {
1187         /*
1188          * this is CONTROLLER ERROR; I don't know the proper way to
1189          * recover from this error...
1190          */
1191         restore_controller(sc->kbdc, command_byte);
1192         kprintf("psm%d: unable to set the command byte.\n", unit);
1193         endprobe(ENXIO);
1194     }
1195
1196     /* see if IRQ is available */
1197     rid = 0;
1198     sc->intr = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, irq, irq, 1,
1199                                   RF_ACTIVE);
1200     if (sc->intr == NULL) {
1201         kprintf("psm%d: unable to allocate the IRQ resource (%d).\n",
1202                unit, (int)irq);
1203         endprobe(ENXIO);
1204     } else {
1205         bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1206     }
1207
1208     /* done */
1209     kbdc_set_device_mask(sc->kbdc, mask | KBD_AUX_CONTROL_BITS);
1210     kbdc_lock(sc->kbdc, FALSE);
1211     return (0);
1212 }
1213
1214 static int
1215 psmattach(device_t dev)
1216 {
1217     int unit = device_get_unit(dev);
1218     struct psm_softc *sc = device_get_softc(dev);
1219     uintptr_t irq;
1220     int error;
1221     int rid;
1222
1223     if (sc == NULL)    /* shouldn't happen */
1224         return (ENXIO);
1225
1226     /* Setup initial state */
1227     sc->state = PSM_VALID;
1228     callout_init(&sc->callout);
1229
1230     /* Setup our interrupt handler */
1231     rid = 0;
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,
1234                                   RF_ACTIVE);
1235     if (sc->intr == NULL)
1236         return (ENXIO);
1237     error = BUS_SETUP_INTR(device_get_parent(dev), dev, sc->intr,
1238                            INTR_NOPOLL, psmintr, sc, &sc->ih, NULL);
1239     if (error) {
1240         bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1241         return (error);
1242     }
1243
1244     /* Done */
1245     make_dev(&psm_ops, PSM_MKMINOR(unit, FALSE), 0, 0, 0666, "psm%d", unit);
1246     make_dev(&psm_ops, PSM_MKMINOR(unit, TRUE), 0, 0, 0666, "bpsm%d", unit);
1247
1248     if (!verbose) {
1249         kprintf("psm%d: model %s, device ID %d\n",
1250             unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff);
1251     } else {
1252         kprintf("psm%d: model %s, device ID %d-%02x, %d buttons\n",
1253             unit, model_name(sc->hw.model),
1254             sc->hw.hwid & 0x00ff, sc->hw.hwid >> 8, sc->hw.buttons);
1255         kprintf("psm%d: config:%08x, flags:%08x, packet size:%d\n",
1256             unit, sc->config, sc->flags, sc->mode.packetsize);
1257         kprintf("psm%d: syncmask:%02x, syncbits:%02x\n",
1258             unit, sc->mode.syncmask[0], sc->mode.syncmask[1]);
1259     }
1260
1261     if (bootverbose)
1262         --verbose;
1263
1264     return (0);
1265 }
1266
1267 static int
1268 psmdetach(device_t dev)
1269 {
1270     struct psm_softc *sc;
1271     int rid;
1272     int unit;
1273
1274     sc = device_get_softc(dev);
1275     if (sc->state & PSM_OPEN)
1276         return EBUSY;
1277
1278     unit = device_get_unit(dev);
1279
1280     rid = 0;
1281     BUS_TEARDOWN_INTR(device_get_parent(dev), dev, sc->intr, sc->ih);
1282     bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1283     kprintf("devfs: Please make sure that only the right psm device was removed!!!!\n");
1284     dev_ops_remove_minor(&psm_ops, /*PSM_MKMINOR(-1, 0), */PSM_MKMINOR(unit, 0));
1285
1286     return 0;
1287 }
1288
1289 static int
1290 psmopen(struct dev_open_args *ap)
1291 {
1292     cdev_t dev = ap->a_head.a_dev;
1293     int unit = PSM_UNIT(dev);
1294     struct psm_softc *sc;
1295     int command_byte;
1296     int err;
1297
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 */
1302         return (ENXIO);
1303
1304     /* Disallow multiple opens */
1305     if (sc->state & PSM_OPEN)
1306         return (EBUSY);
1307
1308 #if 0
1309     device_busy(devclass_get_device(psm_devclass, unit));
1310 #endif
1311
1312     /* Initialize state */
1313     sc->rsel.si_flags = 0;
1314     sc->rsel.si_pid = 0;
1315     sc->mode.level = sc->dflt_mode.level;
1316     sc->mode.protocol = sc->dflt_mode.protocol;
1317     sc->watchdog = FALSE;
1318
1319     /* flush the event queue */
1320     sc->queue.count = 0;
1321     sc->queue.head = 0;
1322     sc->queue.tail = 0;
1323     sc->status.flags = 0;
1324     sc->status.button = 0;
1325     sc->status.obutton = 0;
1326     sc->status.dx = 0;
1327     sc->status.dy = 0;
1328     sc->status.dz = 0;
1329     sc->button = 0;
1330
1331     /* empty input buffer */
1332     bzero(sc->ipacket, sizeof(sc->ipacket));
1333     sc->inputbytes = 0;
1334     sc->syncerrors = 0;
1335
1336     /* don't let timeout routines in the keyboard driver to poll the kbdc */
1337     if (!kbdc_lock(sc->kbdc, TRUE))
1338         return (EIO);
1339
1340     /* save the current controller command byte */
1341     crit_enter();
1342     command_byte = get_controller_command_byte(sc->kbdc);
1343
1344     /* enable the aux port and temporalily disable the keyboard */
1345     if ((command_byte == -1)
1346         || !set_controller_command_byte(sc->kbdc,
1347             kbdc_get_device_mask(sc->kbdc),
1348             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1349                 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1350         /* CONTROLLER ERROR; do you know how to get out of this? */
1351         kbdc_lock(sc->kbdc, FALSE);
1352         crit_exit();
1353         log(LOG_ERR, "psm%d: unable to set the command byte (psmopen).\n",
1354             unit);
1355         return (EIO);
1356     }
1357     /*
1358      * Now that the keyboard controller is told not to generate
1359      * the keyboard and mouse interrupts, call `splx()' to allow
1360      * the other tty interrupts. The clock interrupt may also occur,
1361      * but timeout routines will be blocked by the poll flag set
1362      * via `kbdc_lock()'
1363      */
1364     crit_exit();
1365
1366     /* enable the mouse device */
1367     err = doopen(sc, command_byte);
1368
1369     /* done */
1370     if (err == 0)
1371         sc->state |= PSM_OPEN;
1372     kbdc_lock(sc->kbdc, FALSE);
1373     return (err);
1374 }
1375
1376 static int
1377 psmclose(struct dev_close_args *ap)
1378 {
1379     cdev_t dev = ap->a_head.a_dev;
1380     int unit = PSM_UNIT(dev);
1381     struct psm_softc *sc = PSM_SOFTC(unit);
1382     int stat[3];
1383     int command_byte;
1384
1385     /* don't let timeout routines in the keyboard driver to poll the kbdc */
1386     if (!kbdc_lock(sc->kbdc, TRUE))
1387         return (EIO);
1388
1389     /* save the current controller command byte */
1390     crit_enter();
1391     command_byte = get_controller_command_byte(sc->kbdc);
1392     if (command_byte == -1) {
1393         kbdc_lock(sc->kbdc, FALSE);
1394         crit_exit();
1395         return (EIO);
1396     }
1397
1398     /* disable the aux interrupt and temporalily disable the keyboard */
1399     if (!set_controller_command_byte(sc->kbdc,
1400             kbdc_get_device_mask(sc->kbdc),
1401             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1402                 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1403         log(LOG_ERR, "psm%d: failed to disable the aux int (psmclose).\n",
1404             unit);
1405         /* CONTROLLER ERROR;
1406          * NOTE: we shall force our way through. Because the only
1407          * ill effect we shall see is that we may not be able
1408          * to read ACK from the mouse, and it doesn't matter much
1409          * so long as the mouse will accept the DISABLE command.
1410          */
1411     }
1412     crit_exit();
1413
1414     /* stop the watchdog timer */
1415     callout_stop(&sc->callout);
1416
1417     /* remove anything left in the output buffer */
1418     empty_aux_buffer(sc->kbdc, 10);
1419
1420     /* disable the aux device, port and interrupt */
1421     if (sc->state & PSM_VALID) {
1422         if (!disable_aux_dev(sc->kbdc)) {
1423             /* MOUSE ERROR;
1424              * NOTE: we don't return error and continue, pretending
1425              * we have successfully disabled the device. It's OK because
1426              * the interrupt routine will discard any data from the mouse
1427              * hereafter.
1428              */
1429             log(LOG_ERR, "psm%d: failed to disable the device (psmclose).\n",
1430                 unit);
1431         }
1432
1433         if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
1434             log(LOG_DEBUG, "psm%d: failed to get status (psmclose).\n",
1435                 unit);
1436     }
1437
1438     if (!set_controller_command_byte(sc->kbdc,
1439             kbdc_get_device_mask(sc->kbdc),
1440             (command_byte & KBD_KBD_CONTROL_BITS)
1441                 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1442         /* CONTROLLER ERROR;
1443          * we shall ignore this error; see the above comment.
1444          */
1445         log(LOG_ERR, "psm%d: failed to disable the aux port (psmclose).\n",
1446             unit);
1447     }
1448
1449     /* remove anything left in the output buffer */
1450     empty_aux_buffer(sc->kbdc, 10);
1451
1452     /* close is almost always successful */
1453     sc->state &= ~PSM_OPEN;
1454     kbdc_lock(sc->kbdc, FALSE);
1455 #if 0
1456     device_unbusy(devclass_get_device(psm_devclass, unit));
1457 #endif
1458     return (0);
1459 }
1460
1461 static int
1462 tame_mouse(struct psm_softc *sc, mousestatus_t *status, unsigned char *buf)
1463 {
1464     static unsigned char butmapps2[8] = {
1465         0,
1466         MOUSE_PS2_BUTTON1DOWN,
1467         MOUSE_PS2_BUTTON2DOWN,
1468         MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN,
1469         MOUSE_PS2_BUTTON3DOWN,
1470         MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON3DOWN,
1471         MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
1472         MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
1473     };
1474     static unsigned char butmapmsc[8] = {
1475         MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
1476         MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
1477         MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON3UP,
1478         MOUSE_MSC_BUTTON3UP,
1479         MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP,
1480         MOUSE_MSC_BUTTON2UP,
1481         MOUSE_MSC_BUTTON1UP,
1482         0,
1483     };
1484     int mapped;
1485     int i;
1486
1487     if (sc->mode.level == PSM_LEVEL_BASE) {
1488         mapped = status->button & ~MOUSE_BUTTON4DOWN;
1489         if (status->button & MOUSE_BUTTON4DOWN)
1490             mapped |= MOUSE_BUTTON1DOWN;
1491         status->button = mapped;
1492         buf[0] = MOUSE_PS2_SYNC | butmapps2[mapped & MOUSE_STDBUTTONS];
1493         i = max(min(status->dx, 255), -256);
1494         if (i < 0)
1495             buf[0] |= MOUSE_PS2_XNEG;
1496         buf[1] = i;
1497         i = max(min(status->dy, 255), -256);
1498         if (i < 0)
1499             buf[0] |= MOUSE_PS2_YNEG;
1500         buf[2] = i;
1501         return MOUSE_PS2_PACKETSIZE;
1502     } else if (sc->mode.level == PSM_LEVEL_STANDARD) {
1503         buf[0] = MOUSE_MSC_SYNC | butmapmsc[status->button & MOUSE_STDBUTTONS];
1504         i = max(min(status->dx, 255), -256);
1505         buf[1] = i >> 1;
1506         buf[3] = i - buf[1];
1507         i = max(min(status->dy, 255), -256);
1508         buf[2] = i >> 1;
1509         buf[4] = i - buf[2];
1510         i = max(min(status->dz, 127), -128);
1511         buf[5] = (i >> 1) & 0x7f;
1512         buf[6] = (i - (i >> 1)) & 0x7f;
1513         buf[7] = (~status->button >> 3) & 0x7f;
1514         return MOUSE_SYS_PACKETSIZE;
1515     }
1516     return sc->inputbytes;
1517 }
1518
1519 static int
1520 psmread(struct dev_read_args *ap)
1521 {
1522     cdev_t dev = ap->a_head.a_dev;
1523     struct uio *uio = ap->a_uio;
1524     struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
1525     unsigned char buf[PSM_SMALLBUFSIZE];
1526     int error = 0;
1527     int l;
1528
1529     if ((sc->state & PSM_VALID) == 0)
1530         return EIO;
1531
1532     /* block until mouse activity occured */
1533     crit_enter();
1534     while (sc->queue.count <= 0) {
1535         if (PSM_NBLOCKIO(dev)) {
1536             crit_exit();
1537             return EWOULDBLOCK;
1538         }
1539         sc->state |= PSM_ASLP;
1540         error = tsleep((caddr_t) sc, PCATCH, "psmrea", 0);
1541         sc->state &= ~PSM_ASLP;
1542         if (error) {
1543             crit_exit();
1544             return error;
1545         } else if ((sc->state & PSM_VALID) == 0) {
1546             /* the device disappeared! */
1547             crit_exit();
1548             return EIO;
1549         }
1550     }
1551     crit_exit();
1552
1553     /* copy data to the user land */
1554     while ((sc->queue.count > 0) && (uio->uio_resid > 0)) {
1555         crit_enter();
1556         l = (int)szmin(sc->queue.count, uio->uio_resid);
1557         if (l > sizeof(buf))
1558             l = sizeof(buf);
1559         if (l > sizeof(sc->queue.buf) - sc->queue.head) {
1560             bcopy(&sc->queue.buf[sc->queue.head], &buf[0],
1561                 sizeof(sc->queue.buf) - sc->queue.head);
1562             bcopy(&sc->queue.buf[0],
1563                 &buf[sizeof(sc->queue.buf) - sc->queue.head],
1564                 l - (sizeof(sc->queue.buf) - sc->queue.head));
1565         } else {
1566             bcopy(&sc->queue.buf[sc->queue.head], &buf[0], l);
1567         }
1568         sc->queue.count -= l;
1569         sc->queue.head = (sc->queue.head + l) % sizeof(sc->queue.buf);
1570         crit_exit();
1571         error = uiomove(buf, (size_t)l, uio);
1572         if (error)
1573             break;
1574     }
1575
1576     return error;
1577 }
1578
1579 static int
1580 block_mouse_data(struct psm_softc *sc, int *c)
1581 {
1582     if (!kbdc_lock(sc->kbdc, TRUE))
1583         return EIO;
1584
1585     crit_enter();
1586     *c = get_controller_command_byte(sc->kbdc);
1587     if ((*c == -1)
1588         || !set_controller_command_byte(sc->kbdc,
1589             kbdc_get_device_mask(sc->kbdc),
1590             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1591                 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1592         /* this is CONTROLLER ERROR */
1593         crit_exit();
1594         kbdc_lock(sc->kbdc, FALSE);
1595         return EIO;
1596     }
1597
1598     /*
1599      * The device may be in the middle of status data transmission.
1600      * The transmission will be interrupted, thus, incomplete status
1601      * data must be discarded. Although the aux interrupt is disabled
1602      * at the keyboard controller level, at most one aux interrupt
1603      * may have already been pending and a data byte is in the
1604      * output buffer; throw it away. Note that the second argument
1605      * to `empty_aux_buffer()' is zero, so that the call will just
1606      * flush the internal queue.
1607      * `psmintr()' will be invoked after `splx()' if an interrupt is
1608      * pending; it will see no data and returns immediately.
1609      */
1610     empty_aux_buffer(sc->kbdc, 0);      /* flush the queue */
1611     read_aux_data_no_wait(sc->kbdc);    /* throw away data if any */
1612     sc->inputbytes = 0;
1613     crit_exit();
1614
1615     return 0;
1616 }
1617
1618 static int
1619 unblock_mouse_data(struct psm_softc *sc, int c)
1620 {
1621     int error = 0;
1622
1623     /*
1624      * We may have seen a part of status data during `set_mouse_XXX()'.
1625      * they have been queued; flush it.
1626      */
1627     empty_aux_buffer(sc->kbdc, 0);
1628
1629     /* restore ports and interrupt */
1630     if (!set_controller_command_byte(sc->kbdc,
1631             kbdc_get_device_mask(sc->kbdc),
1632             c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
1633         /* CONTROLLER ERROR; this is serious, we may have
1634          * been left with the inaccessible keyboard and
1635          * the disabled mouse interrupt.
1636          */
1637         error = EIO;
1638     }
1639
1640     kbdc_lock(sc->kbdc, FALSE);
1641     return error;
1642 }
1643
1644 static int
1645 psmioctl(struct dev_ioctl_args *ap)
1646 {
1647     cdev_t dev = ap->a_head.a_dev;
1648     caddr_t addr=  ap->a_data;
1649     struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
1650     mousemode_t mode;
1651     mousestatus_t status;
1652 #if (defined(MOUSE_GETVARS))
1653     mousevar_t *var;
1654 #endif
1655     mousedata_t *data;
1656     int stat[3];
1657     int command_byte;
1658     int error = 0;
1659
1660     mode.resolution = -1;
1661
1662     /* Perform IOCTL command */
1663
1664     switch (ap->a_cmd) {
1665     case OLD_MOUSE_GETHWINFO:
1666         crit_enter();
1667         ((old_mousehw_t *)addr)->buttons = sc->hw.buttons;
1668         ((old_mousehw_t *)addr)->iftype = sc->hw.iftype;
1669         ((old_mousehw_t *)addr)->type = sc->hw.type;
1670         ((old_mousehw_t *)addr)->hwid = sc->hw.hwid & 0x00ff;
1671         crit_exit();
1672         break;
1673
1674     case MOUSE_GETHWINFO:
1675         crit_enter();
1676         *(mousehw_t *)addr = sc->hw;
1677         if (sc->mode.level == PSM_LEVEL_BASE)
1678             ((mousehw_t *)addr)->model = MOUSE_MODEL_GENERIC;
1679         crit_exit();
1680         break;
1681
1682     case OLD_MOUSE_GETMODE:
1683         crit_enter();
1684         switch (sc->mode.level) {
1685         case PSM_LEVEL_BASE:
1686             ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1687             break;
1688         case PSM_LEVEL_STANDARD:
1689             ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
1690             break;
1691         case PSM_LEVEL_NATIVE:
1692             ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1693             break;
1694         }
1695         ((old_mousemode_t *)addr)->rate = sc->mode.rate;
1696         ((old_mousemode_t *)addr)->resolution = sc->mode.resolution;
1697         ((old_mousemode_t *)addr)->accelfactor = sc->mode.accelfactor;
1698         crit_exit();
1699         break;
1700
1701     case MOUSE_GETMODE:
1702         crit_enter();
1703         *(mousemode_t *)addr = sc->mode;
1704         ((mousemode_t *)addr)->resolution =
1705             MOUSE_RES_LOW - sc->mode.resolution;
1706         switch (sc->mode.level) {
1707         case PSM_LEVEL_BASE:
1708             ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1709             ((mousemode_t *)addr)->packetsize = MOUSE_PS2_PACKETSIZE;
1710             break;
1711         case PSM_LEVEL_STANDARD:
1712             ((mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
1713             ((mousemode_t *)addr)->packetsize = MOUSE_SYS_PACKETSIZE;
1714             ((mousemode_t *)addr)->syncmask[0] = MOUSE_SYS_SYNCMASK;
1715             ((mousemode_t *)addr)->syncmask[1] = MOUSE_SYS_SYNC;
1716             break;
1717         case PSM_LEVEL_NATIVE:
1718             /* FIXME: this isn't quite correct... XXX */
1719             ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1720             break;
1721         }
1722         crit_exit();
1723         break;
1724
1725     case OLD_MOUSE_SETMODE:
1726     case MOUSE_SETMODE:
1727         if (ap->a_cmd == OLD_MOUSE_SETMODE) {
1728             mode.rate = ((old_mousemode_t *)addr)->rate;
1729             /*
1730              * resolution  old I/F   new I/F
1731              * default        0         0
1732              * low            1        -2
1733              * medium low     2        -3
1734              * medium high    3        -4
1735              * high           4        -5
1736              */
1737             if (((old_mousemode_t *)addr)->resolution > 0)
1738                 mode.resolution = -((old_mousemode_t *)addr)->resolution - 1;
1739             mode.accelfactor = ((old_mousemode_t *)addr)->accelfactor;
1740             mode.level = -1;
1741         } else {
1742             mode = *(mousemode_t *)addr;
1743         }
1744
1745         /* adjust and validate parameters. */
1746         if (mode.rate > UCHAR_MAX)
1747             return EINVAL;
1748         if (mode.rate == 0)
1749             mode.rate = sc->dflt_mode.rate;
1750         else if (mode.rate == -1)
1751             /* don't change the current setting */
1752             ;
1753         else if (mode.rate < 0)
1754             return EINVAL;
1755         if (mode.resolution >= UCHAR_MAX)
1756             return EINVAL;
1757         if (mode.resolution >= 200)
1758             mode.resolution = MOUSE_RES_HIGH;
1759         else if (mode.resolution >= 100)
1760             mode.resolution = MOUSE_RES_MEDIUMHIGH;
1761         else if (mode.resolution >= 50)
1762             mode.resolution = MOUSE_RES_MEDIUMLOW;
1763         else if (mode.resolution > 0)
1764             mode.resolution = MOUSE_RES_LOW;
1765         if (mode.resolution == MOUSE_RES_DEFAULT)
1766             mode.resolution = sc->dflt_mode.resolution;
1767         else if (mode.resolution == -1)
1768             /* don't change the current setting */
1769             ;
1770         else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
1771             mode.resolution = MOUSE_RES_LOW - mode.resolution;
1772         if (mode.level == -1)
1773             /* don't change the current setting */
1774             mode.level = sc->mode.level;
1775         else if ((mode.level < PSM_LEVEL_MIN) || (mode.level > PSM_LEVEL_MAX))
1776             return EINVAL;
1777         if (mode.accelfactor == -1)
1778             /* don't change the current setting */
1779             mode.accelfactor = sc->mode.accelfactor;
1780         else if (mode.accelfactor < 0)
1781             return EINVAL;
1782
1783         /* don't allow anybody to poll the keyboard controller */
1784         error = block_mouse_data(sc, &command_byte);
1785         if (error)
1786             return error;
1787
1788         /* set mouse parameters */
1789         if (mode.rate > 0)
1790             mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
1791         if (mode.resolution >= 0)
1792             mode.resolution = set_mouse_resolution(sc->kbdc, mode.resolution);
1793         set_mouse_scaling(sc->kbdc, 1);
1794         get_mouse_status(sc->kbdc, stat, 0, 3);
1795
1796         crit_enter();
1797         sc->mode.rate = mode.rate;
1798         sc->mode.resolution = mode.resolution;
1799         sc->mode.accelfactor = mode.accelfactor;
1800         sc->mode.level = mode.level;
1801         crit_exit();
1802
1803         unblock_mouse_data(sc, command_byte);
1804         break;
1805
1806     case MOUSE_GETLEVEL:
1807         *(int *)addr = sc->mode.level;
1808         break;
1809
1810     case MOUSE_SETLEVEL:
1811         if ((*(int *)addr < PSM_LEVEL_MIN) || (*(int *)addr > PSM_LEVEL_MAX))
1812             return EINVAL;
1813         sc->mode.level = *(int *)addr;
1814         break;
1815
1816     case MOUSE_GETSTATUS:
1817         crit_enter();
1818         status = sc->status;
1819         sc->status.flags = 0;
1820         sc->status.obutton = sc->status.button;
1821         sc->status.button = 0;
1822         sc->status.dx = 0;
1823         sc->status.dy = 0;
1824         sc->status.dz = 0;
1825         crit_exit();
1826         *(mousestatus_t *)addr = status;
1827         break;
1828
1829 #if (defined(MOUSE_GETVARS))
1830     case MOUSE_GETVARS:
1831         var = (mousevar_t *)addr;
1832         bzero(var, sizeof(*var));
1833         crit_enter();
1834         var->var[0] = MOUSE_VARS_PS2_SIG;
1835         var->var[1] = sc->config;
1836         var->var[2] = sc->flags;
1837         crit_exit();
1838         break;
1839
1840     case MOUSE_SETVARS:
1841         return ENODEV;
1842 #endif /* MOUSE_GETVARS */
1843
1844     case MOUSE_READSTATE:
1845     case MOUSE_READDATA:
1846         data = (mousedata_t *)addr;
1847         if (data->len > sizeof(data->buf)/sizeof(data->buf[0]))
1848             return EINVAL;
1849
1850         error = block_mouse_data(sc, &command_byte);
1851         if (error)
1852             return error;
1853         if ((data->len = get_mouse_status(sc->kbdc, data->buf,
1854                 (ap->a_cmd == MOUSE_READDATA) ? 1 : 0, data->len)) <= 0)
1855             error = EIO;
1856         unblock_mouse_data(sc, command_byte);
1857         break;
1858
1859 #if (defined(MOUSE_SETRESOLUTION))
1860     case MOUSE_SETRESOLUTION:
1861         mode.resolution = *(int *)addr;
1862         if (mode.resolution >= UCHAR_MAX)
1863             return EINVAL;
1864         else if (mode.resolution >= 200)
1865             mode.resolution = MOUSE_RES_HIGH;
1866         else if (mode.resolution >= 100)
1867             mode.resolution = MOUSE_RES_MEDIUMHIGH;
1868         else if (mode.resolution >= 50)
1869             mode.resolution = MOUSE_RES_MEDIUMLOW;
1870         else if (mode.resolution > 0)
1871             mode.resolution = MOUSE_RES_LOW;
1872         if (mode.resolution == MOUSE_RES_DEFAULT)
1873             mode.resolution = sc->dflt_mode.resolution;
1874         else if (mode.resolution == -1)
1875             mode.resolution = sc->mode.resolution;
1876         else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
1877             mode.resolution = MOUSE_RES_LOW - mode.resolution;
1878
1879         error = block_mouse_data(sc, &command_byte);
1880         if (error)
1881             return error;
1882         sc->mode.resolution = set_mouse_resolution(sc->kbdc, mode.resolution);
1883         if (sc->mode.resolution != mode.resolution)
1884             error = EIO;
1885         unblock_mouse_data(sc, command_byte);
1886         break;
1887 #endif /* MOUSE_SETRESOLUTION */
1888
1889 #if (defined(MOUSE_SETRATE))
1890     case MOUSE_SETRATE:
1891         mode.rate = *(int *)addr;
1892         if (mode.rate > UCHAR_MAX)
1893             return EINVAL;
1894         if (mode.rate == 0)
1895             mode.rate = sc->dflt_mode.rate;
1896         else if (mode.rate < 0)
1897             mode.rate = sc->mode.rate;
1898
1899         error = block_mouse_data(sc, &command_byte);
1900         if (error)
1901             return error;
1902         sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
1903         if (sc->mode.rate != mode.rate)
1904             error = EIO;
1905         unblock_mouse_data(sc, command_byte);
1906         break;
1907 #endif /* MOUSE_SETRATE */
1908
1909 #if (defined(MOUSE_SETSCALING))
1910     case MOUSE_SETSCALING:
1911         if ((*(int *)addr <= 0) || (*(int *)addr > 2))
1912             return EINVAL;
1913
1914         error = block_mouse_data(sc, &command_byte);
1915         if (error)
1916             return error;
1917         if (!set_mouse_scaling(sc->kbdc, *(int *)addr))
1918             error = EIO;
1919         unblock_mouse_data(sc, command_byte);
1920         break;
1921 #endif /* MOUSE_SETSCALING */
1922
1923 #if (defined(MOUSE_GETHWID))
1924     case MOUSE_GETHWID:
1925         error = block_mouse_data(sc, &command_byte);
1926         if (error)
1927             return error;
1928         sc->hw.hwid &= ~0x00ff;
1929         sc->hw.hwid |= get_aux_id(sc->kbdc);
1930         *(int *)addr = sc->hw.hwid & 0x00ff;
1931         unblock_mouse_data(sc, command_byte);
1932         break;
1933 #endif /* MOUSE_GETHWID */
1934
1935     default:
1936         return ENOTTY;
1937     }
1938
1939     return error;
1940 }
1941
1942 static void
1943 psmtimeout(void *arg)
1944 {
1945     struct psm_softc *sc;
1946
1947     sc = (struct psm_softc *)arg;
1948     crit_enter();
1949     if (sc->watchdog && kbdc_lock(sc->kbdc, TRUE)) {
1950         if (verbose >= 4)
1951             log(LOG_DEBUG, "psm%d: lost interrupt?\n", sc->unit);
1952         psmintr(sc);
1953         kbdc_lock(sc->kbdc, FALSE);
1954     }
1955     sc->watchdog = TRUE;
1956     callout_reset(&sc->callout, hz, psmtimeout, (void *)(uintptr_t)sc);
1957     crit_exit();
1958 }
1959
1960 static void
1961 psmintr(void *arg)
1962 {
1963     /*
1964      * the table to turn PS/2 mouse button bits (MOUSE_PS2_BUTTON?DOWN)
1965      * into `mousestatus' button bits (MOUSE_BUTTON?DOWN).
1966      */
1967     static int butmap[8] = {
1968         0,
1969         MOUSE_BUTTON1DOWN,
1970         MOUSE_BUTTON3DOWN,
1971         MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1972         MOUSE_BUTTON2DOWN,
1973         MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN,
1974         MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN,
1975         MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN
1976     };
1977     static int butmap_versapad[8] = {
1978         0,
1979         MOUSE_BUTTON3DOWN,
1980         0,
1981         MOUSE_BUTTON3DOWN,
1982         MOUSE_BUTTON1DOWN,
1983         MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
1984         MOUSE_BUTTON1DOWN,
1985         MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN
1986     };
1987     struct psm_softc *sc = arg;
1988     mousestatus_t ms;
1989     struct timeval tv;
1990     int x, y, z;
1991     int c;
1992     int l;
1993     int x0, y0;
1994
1995     /* read until there is nothing to read */
1996     while((c = read_aux_data_no_wait(sc->kbdc)) != -1) {
1997
1998         /* discard the byte if the device is not open */
1999         if ((sc->state & PSM_OPEN) == 0)
2000             continue;
2001
2002         getmicrouptime(&tv);
2003         if ((sc->inputbytes > 0) && timevalcmp(&tv, &sc->inputtimeout, >)) {
2004             log(LOG_DEBUG, "psmintr: delay too long; resetting byte count\n");
2005             sc->inputbytes = 0;
2006             sc->syncerrors = 0;
2007         }
2008         sc->inputtimeout.tv_sec = PSM_INPUT_TIMEOUT/1000000;
2009         sc->inputtimeout.tv_usec = PSM_INPUT_TIMEOUT%1000000;
2010         timevaladd(&sc->inputtimeout, &tv);
2011
2012         sc->ipacket[sc->inputbytes++] = c;
2013         if (sc->inputbytes < sc->mode.packetsize)
2014             continue;
2015
2016 #if 0
2017         log(LOG_DEBUG, "psmintr: %02x %02x %02x %02x %02x %02x\n",
2018             sc->ipacket[0], sc->ipacket[1], sc->ipacket[2],
2019             sc->ipacket[3], sc->ipacket[4], sc->ipacket[5]);
2020 #endif
2021
2022         c = sc->ipacket[0];
2023
2024         if ((c & sc->mode.syncmask[0]) != sc->mode.syncmask[1]) {
2025             log(LOG_DEBUG, "psmintr: out of sync (%04x != %04x).\n",
2026                 c & sc->mode.syncmask[0], sc->mode.syncmask[1]);
2027             ++sc->syncerrors;
2028             if (sc->syncerrors < sc->mode.packetsize) {
2029                 log(LOG_DEBUG, "psmintr: discard a byte (%d).\n", sc->syncerrors);
2030                 --sc->inputbytes;
2031                 bcopy(&sc->ipacket[1], &sc->ipacket[0], sc->inputbytes);
2032             } else if (sc->syncerrors == sc->mode.packetsize) {
2033                 log(LOG_DEBUG, "psmintr: re-enable the mouse.\n");
2034                 sc->inputbytes = 0;
2035                 disable_aux_dev(sc->kbdc);
2036                 enable_aux_dev(sc->kbdc);
2037             } else if (sc->syncerrors < PSM_SYNCERR_THRESHOLD1) {
2038                 log(LOG_DEBUG, "psmintr: discard a byte (%d).\n", sc->syncerrors);
2039                 --sc->inputbytes;
2040                 bcopy(&sc->ipacket[1], &sc->ipacket[0], sc->inputbytes);
2041             } else if (sc->syncerrors >= PSM_SYNCERR_THRESHOLD1) {
2042                 log(LOG_DEBUG, "psmintr: reset the mouse.\n");
2043                 reinitialize(sc, TRUE);
2044             }
2045             continue;
2046         }
2047
2048         /*
2049          * A kludge for Kensington device!
2050          * The MSB of the horizontal count appears to be stored in
2051          * a strange place.
2052          */
2053         if (sc->hw.model == MOUSE_MODEL_THINK)
2054             sc->ipacket[1] |= (c & MOUSE_PS2_XOVERFLOW) ? 0x80 : 0;
2055
2056         /* ignore the overflow bits... */
2057         x = (c & MOUSE_PS2_XNEG) ?  sc->ipacket[1] - 256 : sc->ipacket[1];
2058         y = (c & MOUSE_PS2_YNEG) ?  sc->ipacket[2] - 256 : sc->ipacket[2];
2059         z = 0;
2060         ms.obutton = sc->button;                  /* previous button state */
2061         ms.button = butmap[c & MOUSE_PS2_BUTTONS];
2062         /* `tapping' action */
2063         if (sc->config & PSM_CONFIG_FORCETAP)
2064             ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 : MOUSE_BUTTON4DOWN;
2065
2066         switch (sc->hw.model) {
2067
2068         case MOUSE_MODEL_EXPLORER:
2069             /*
2070              *          b7 b6 b5 b4 b3 b2 b1 b0
2071              * byte 1:  oy ox sy sx 1  M  R  L
2072              * byte 2:  x  x  x  x  x  x  x  x
2073              * byte 3:  y  y  y  y  y  y  y  y
2074              * byte 4:  *  *  S2 S1 s  d2 d1 d0
2075              *
2076              * L, M, R, S1, S2: left, middle, right and side buttons
2077              * s: wheel data sign bit
2078              * d2-d0: wheel data
2079              */
2080             z = (sc->ipacket[3] & MOUSE_EXPLORER_ZNEG)
2081                 ? (sc->ipacket[3] & 0x0f) - 16 : (sc->ipacket[3] & 0x0f);
2082             ms.button |= (sc->ipacket[3] & MOUSE_EXPLORER_BUTTON4DOWN)
2083                 ? MOUSE_BUTTON4DOWN : 0;
2084             ms.button |= (sc->ipacket[3] & MOUSE_EXPLORER_BUTTON5DOWN)
2085                 ? MOUSE_BUTTON5DOWN : 0;
2086             break;
2087
2088         case MOUSE_MODEL_INTELLI:
2089         case MOUSE_MODEL_NET:
2090             /* wheel data is in the fourth byte */
2091             z = (char)sc->ipacket[3];
2092             /* some mice may send 7 when there is no Z movement?! XXX */
2093             if ((z >= 7) || (z <= -7))
2094                 z = 0;
2095             /* some compatible mice have additional buttons */
2096             ms.button |= (c & MOUSE_PS2INTELLI_BUTTON4DOWN)
2097                 ? MOUSE_BUTTON4DOWN : 0;
2098             ms.button |= (c & MOUSE_PS2INTELLI_BUTTON5DOWN)
2099                 ? MOUSE_BUTTON5DOWN : 0;
2100             break;
2101
2102         case MOUSE_MODEL_MOUSEMANPLUS:
2103             /*
2104              * PS2++ protocl packet
2105              *
2106              *          b7 b6 b5 b4 b3 b2 b1 b0
2107              * byte 1:  *  1  p3 p2 1  *  *  *
2108              * byte 2:  c1 c2 p1 p0 d1 d0 1  0
2109              *
2110              * p3-p0: packet type
2111              * c1, c2: c1 & c2 == 1, if p2 == 0
2112              *         c1 & c2 == 0, if p2 == 1
2113              *
2114              * packet type: 0 (device type)
2115              * See comments in enable_mmanplus() below.
2116              *
2117              * packet type: 1 (wheel data)
2118              *
2119              *          b7 b6 b5 b4 b3 b2 b1 b0
2120              * byte 3:  h  *  B5 B4 s  d2 d1 d0
2121              *
2122              * h: 1, if horizontal roller data
2123              *    0, if vertical roller data
2124              * B4, B5: button 4 and 5
2125              * s: sign bit
2126              * d2-d0: roller data
2127              *
2128              * packet type: 2 (reserved)
2129              */
2130             if (((c & MOUSE_PS2PLUS_SYNCMASK) == MOUSE_PS2PLUS_SYNC)
2131                     && (abs(x) > 191)
2132                     && MOUSE_PS2PLUS_CHECKBITS(sc->ipacket)) {
2133                 /* the extended data packet encodes button and wheel events */
2134                 switch (MOUSE_PS2PLUS_PACKET_TYPE(sc->ipacket)) {
2135                 case 1:
2136                     /* wheel data packet */
2137                     x = y = 0;
2138                     if (sc->ipacket[2] & 0x80) {
2139                         /* horizontal roller count - ignore it XXX*/
2140                     } else {
2141                         /* vertical roller count */
2142                         z = (sc->ipacket[2] & MOUSE_PS2PLUS_ZNEG)
2143                             ? (sc->ipacket[2] & 0x0f) - 16
2144                             : (sc->ipacket[2] & 0x0f);
2145                     }
2146                     ms.button |= (sc->ipacket[2] & MOUSE_PS2PLUS_BUTTON4DOWN)
2147                         ? MOUSE_BUTTON4DOWN : 0;
2148                     ms.button |= (sc->ipacket[2] & MOUSE_PS2PLUS_BUTTON5DOWN)
2149                         ? MOUSE_BUTTON5DOWN : 0;
2150                     break;
2151                 case 2:
2152                     /* this packet type is reserved by Logitech... */
2153                     /*
2154                      * IBM ScrollPoint Mouse uses this packet type to
2155                      * encode both vertical and horizontal scroll movement.
2156                      */
2157                     x = y = 0;
2158                     /* horizontal count */
2159                     if (sc->ipacket[2] & 0x0f)
2160                         z = (sc->ipacket[2] & MOUSE_SPOINT_WNEG) ? -2 : 2;
2161                     /* vertical count */
2162                     if (sc->ipacket[2] & 0xf0)
2163                         z = (sc->ipacket[2] & MOUSE_SPOINT_ZNEG) ? -1 : 1;
2164 #if 0
2165                     /* vertical count */
2166                     z = (sc->ipacket[2] & MOUSE_SPOINT_ZNEG)
2167                         ? ((sc->ipacket[2] >> 4) & 0x0f) - 16
2168                         : ((sc->ipacket[2] >> 4) & 0x0f);
2169                     /* horizontal count */
2170                     w = (sc->ipacket[2] & MOUSE_SPOINT_WNEG)
2171                         ? (sc->ipacket[2] & 0x0f) - 16
2172                         : (sc->ipacket[2] & 0x0f);
2173 #endif
2174                     break;
2175                 case 0:
2176                     /* device type packet - shouldn't happen */
2177                     /* FALL THROUGH */
2178                 default:
2179                     x = y = 0;
2180                     ms.button = ms.obutton;
2181                     if (bootverbose)
2182                         log(LOG_DEBUG, "psmintr: unknown PS2++ packet type %d: "
2183                                        "0x%02x 0x%02x 0x%02x\n",
2184                             MOUSE_PS2PLUS_PACKET_TYPE(sc->ipacket),
2185                             sc->ipacket[0], sc->ipacket[1], sc->ipacket[2]);
2186                     break;
2187                 }
2188             } else {
2189                 /* preserve button states */
2190                 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
2191             }
2192             break;
2193
2194         case MOUSE_MODEL_GLIDEPOINT:
2195             /* `tapping' action */
2196             ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 : MOUSE_BUTTON4DOWN;
2197             break;
2198
2199         case MOUSE_MODEL_NETSCROLL:
2200             /* three addtional bytes encode buttons and wheel events */
2201             ms.button |= (sc->ipacket[3] & MOUSE_PS2_BUTTON3DOWN)
2202                 ? MOUSE_BUTTON4DOWN : 0;
2203             ms.button |= (sc->ipacket[3] & MOUSE_PS2_BUTTON1DOWN)
2204                 ? MOUSE_BUTTON5DOWN : 0;
2205             z = (sc->ipacket[3] & MOUSE_PS2_XNEG)
2206                 ? sc->ipacket[4] - 256 : sc->ipacket[4];
2207             break;
2208
2209         case MOUSE_MODEL_THINK:
2210             /* the fourth button state in the first byte */
2211             ms.button |= (c & MOUSE_PS2_TAP) ? MOUSE_BUTTON4DOWN : 0;
2212             break;
2213
2214         case MOUSE_MODEL_VERSAPAD:
2215             /* VersaPad PS/2 absolute mode message format
2216              *
2217              * [packet1]     7   6   5   4   3   2   1   0(LSB)
2218              *  ipacket[0]:  1   1   0   A   1   L   T   R
2219              *  ipacket[1]: H7  H6  H5  H4  H3  H2  H1  H0
2220              *  ipacket[2]: V7  V6  V5  V4  V3  V2  V1  V0
2221              *  ipacket[3]:  1   1   1   A   1   L   T   R
2222              *  ipacket[4]:V11 V10  V9  V8 H11 H10  H9  H8
2223              *  ipacket[5]:  0  P6  P5  P4  P3  P2  P1  P0
2224              *
2225              * [note]
2226              *  R: right physical mouse button (1=on)
2227              *  T: touch pad virtual button (1=tapping)
2228              *  L: left physical mouse button (1=on)
2229              *  A: position data is valid (1=valid)
2230              *  H: horizontal data (12bit signed integer. H11 is sign bit.)
2231              *  V: vertical data (12bit signed integer. V11 is sign bit.)
2232              *  P: pressure data
2233              *
2234              * Tapping is mapped to MOUSE_BUTTON4.
2235              */
2236             ms.button = butmap_versapad[c & MOUSE_PS2VERSA_BUTTONS];
2237             ms.button |= (c & MOUSE_PS2VERSA_TAP) ? MOUSE_BUTTON4DOWN : 0;
2238             x = y = 0;
2239             if (c & MOUSE_PS2VERSA_IN_USE) {
2240                 x0 = sc->ipacket[1] | (((sc->ipacket[4]) & 0x0f) << 8);
2241                 y0 = sc->ipacket[2] | (((sc->ipacket[4]) & 0xf0) << 4);
2242                 if (x0 & 0x800)
2243                     x0 -= 0x1000;
2244                 if (y0 & 0x800)
2245                     y0 -= 0x1000;
2246                 if (sc->flags & PSM_FLAGS_FINGERDOWN) {
2247                     x = sc->xold - x0;
2248                     y = y0 - sc->yold;
2249                     if (x < 0)  /* XXX */
2250                         x++;
2251                     else if (x)
2252                         x--;
2253                     if (y < 0)
2254                         y++;
2255                     else if (y)
2256                         y--;
2257                 } else {
2258                     sc->flags |= PSM_FLAGS_FINGERDOWN;
2259                 }
2260                 sc->xold = x0;
2261                 sc->yold = y0;
2262             } else {
2263                 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
2264             }
2265             c = ((x < 0) ? MOUSE_PS2_XNEG : 0)
2266                 | ((y < 0) ? MOUSE_PS2_YNEG : 0);
2267             break;
2268
2269         case MOUSE_MODEL_4D:
2270             /*
2271              *          b7 b6 b5 b4 b3 b2 b1 b0
2272              * byte 1:  s2 d2 s1 d1 1  M  R  L
2273              * byte 2:  sx x  x  x  x  x  x  x
2274              * byte 3:  sy y  y  y  y  y  y  y
2275              *
2276              * s1: wheel 1 direction
2277              * d1: wheel 1 data
2278              * s2: wheel 2 direction
2279              * d2: wheel 2 data
2280              */
2281             x = (sc->ipacket[1] & 0x80) ? sc->ipacket[1] - 256 : sc->ipacket[1];
2282             y = (sc->ipacket[2] & 0x80) ? sc->ipacket[2] - 256 : sc->ipacket[2];
2283             switch (c & MOUSE_4D_WHEELBITS) {
2284             case 0x10:
2285                 z = 1;
2286                 break;
2287             case 0x30:
2288                 z = -1;
2289                 break;
2290             case 0x40:  /* 2nd wheel turning right XXX */
2291                 z = 2;
2292                 break;
2293             case 0xc0:  /* 2nd wheel turning left XXX */
2294                 z = -2;
2295                 break;
2296             }
2297             break;
2298
2299         case MOUSE_MODEL_4DPLUS:
2300             if ((x < 16 - 256) && (y < 16 - 256)) {
2301                 /*
2302                  *          b7 b6 b5 b4 b3 b2 b1 b0
2303                  * byte 1:  0  0  1  1  1  M  R  L
2304                  * byte 2:  0  0  0  0  1  0  0  0
2305                  * byte 3:  0  0  0  0  S  s  d1 d0
2306                  *
2307                  * L, M, R, S: left, middle, right and side buttons
2308                  * s: wheel data sign bit
2309                  * d1-d0: wheel data
2310                  */
2311                 x = y = 0;
2312                 if (sc->ipacket[2] & MOUSE_4DPLUS_BUTTON4DOWN)
2313                     ms.button |= MOUSE_BUTTON4DOWN;
2314                 z = (sc->ipacket[2] & MOUSE_4DPLUS_ZNEG)
2315                         ? ((sc->ipacket[2] & 0x07) - 8)
2316                         : (sc->ipacket[2] & 0x07) ;
2317             } else {
2318                 /* preserve previous button states */
2319                 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
2320             }
2321             break;
2322
2323         case MOUSE_MODEL_GENERIC:
2324         default:
2325             break;
2326         }
2327
2328         /* scale values */
2329         if (sc->mode.accelfactor >= 1) {
2330             if (x != 0) {
2331                 x = x * x / sc->mode.accelfactor;
2332                 if (x == 0)
2333                     x = 1;
2334                 if (c & MOUSE_PS2_XNEG)
2335                     x = -x;
2336             }
2337             if (y != 0) {
2338                 y = y * y / sc->mode.accelfactor;
2339                 if (y == 0)
2340                     y = 1;
2341                 if (c & MOUSE_PS2_YNEG)
2342                     y = -y;
2343             }
2344         }
2345
2346         ms.dx = x;
2347         ms.dy = y;
2348         ms.dz = z;
2349         ms.flags = ((x || y || z) ? MOUSE_POSCHANGED : 0)
2350             | (ms.obutton ^ ms.button);
2351
2352         if (sc->mode.level < PSM_LEVEL_NATIVE)
2353             sc->inputbytes = tame_mouse(sc, &ms, sc->ipacket);
2354
2355         sc->status.flags |= ms.flags;
2356         sc->status.dx += ms.dx;
2357         sc->status.dy += ms.dy;
2358         sc->status.dz += ms.dz;
2359         sc->status.button = ms.button;
2360         sc->button = ms.button;
2361
2362         sc->watchdog = FALSE;
2363
2364         /* queue data */
2365         if (sc->queue.count + sc->inputbytes < sizeof(sc->queue.buf)) {
2366             l = min(sc->inputbytes, sizeof(sc->queue.buf) - sc->queue.tail);
2367             bcopy(&sc->ipacket[0], &sc->queue.buf[sc->queue.tail], l);
2368             if (sc->inputbytes > l)
2369                 bcopy(&sc->ipacket[l], &sc->queue.buf[0], sc->inputbytes - l);
2370             sc->queue.tail =
2371                 (sc->queue.tail + sc->inputbytes) % sizeof(sc->queue.buf);
2372             sc->queue.count += sc->inputbytes;
2373         }
2374         sc->inputbytes = 0;
2375
2376         if (sc->state & PSM_ASLP) {
2377             sc->state &= ~PSM_ASLP;
2378             wakeup((caddr_t) sc);
2379         }
2380         selwakeup(&sc->rsel);
2381         KNOTE(&sc->rsel.si_note, 0);
2382     }
2383 }
2384
2385 static struct filterops psmfiltops =
2386         { 1, NULL, psmfilter_detach, psmfilter };
2387
2388 static int
2389 psmkqfilter(struct dev_kqfilter_args *ap)
2390 {
2391         cdev_t dev = ap->a_head.a_dev;
2392         struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
2393         struct knote *kn = ap->a_kn;
2394         struct klist *klist;
2395
2396         ap->a_result = 0;
2397
2398         switch (kn->kn_filter) {
2399         case EVFILT_READ:
2400                 kn->kn_fop = &psmfiltops;
2401                 kn->kn_hook = (caddr_t)sc;
2402                 break;
2403         default:
2404                 ap->a_result = EOPNOTSUPP;
2405                 return (0);
2406         }
2407
2408         crit_enter();
2409         klist = &sc->rsel.si_note;
2410         SLIST_INSERT_HEAD(klist, kn, kn_selnext);
2411         crit_exit();
2412
2413         return (0);
2414 }
2415
2416 static void
2417 psmfilter_detach(struct knote *kn)
2418 {
2419         struct psm_softc *sc = (struct psm_softc *)kn->kn_hook;
2420         struct klist *klist;
2421
2422         crit_enter();
2423         klist = &sc->rsel.si_note;
2424         SLIST_REMOVE(klist, kn, knote, kn_selnext);
2425         crit_exit();
2426 }
2427
2428 static int
2429 psmfilter(struct knote *kn, long hint)
2430 {
2431         struct psm_softc *sc = (struct psm_softc *)kn->kn_hook;
2432         int ready = 0;
2433
2434         crit_enter();
2435         if (sc->queue.count > 0)
2436                 ready = 1;
2437         crit_exit();
2438
2439         return (ready);
2440 }
2441
2442 /* vendor/model specific routines */
2443
2444 static int mouse_id_proc1(KBDC kbdc, int res, int scale, int *status)
2445 {
2446     if (set_mouse_resolution(kbdc, res) != res)
2447         return FALSE;
2448     if (set_mouse_scaling(kbdc, scale)
2449         && set_mouse_scaling(kbdc, scale)
2450         && set_mouse_scaling(kbdc, scale)
2451         && (get_mouse_status(kbdc, status, 0, 3) >= 3))
2452         return TRUE;
2453     return FALSE;
2454 }
2455
2456 static int
2457 mouse_ext_command(KBDC kbdc, int command)
2458 {
2459     int c;
2460
2461     c = (command >> 6) & 0x03;
2462     if (set_mouse_resolution(kbdc, c) != c)
2463         return FALSE;
2464     c = (command >> 4) & 0x03;
2465     if (set_mouse_resolution(kbdc, c) != c)
2466         return FALSE;
2467     c = (command >> 2) & 0x03;
2468     if (set_mouse_resolution(kbdc, c) != c)
2469         return FALSE;
2470     c = (command >> 0) & 0x03;
2471     if (set_mouse_resolution(kbdc, c) != c)
2472         return FALSE;
2473     return TRUE;
2474 }
2475
2476 #if notyet
2477 /* Logitech MouseMan Cordless II */
2478 static int
2479 enable_lcordless(struct psm_softc *sc)
2480 {
2481     int status[3];
2482     int ch;
2483
2484     if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 2, status))
2485         return FALSE;
2486     if (status[1] == PSMD_RES_HIGH)
2487         return FALSE;
2488     ch = (status[0] & 0x07) - 1;        /* channel # */
2489     if ((ch <= 0) || (ch > 4))
2490         return FALSE;
2491     /*
2492      * status[1]: always one?
2493      * status[2]: battery status? (0-100)
2494      */
2495     return TRUE;
2496 }
2497 #endif /* notyet */
2498
2499 /* Genius NetScroll Mouse, MouseSystems SmartScroll Mouse */
2500 static int
2501 enable_groller(struct psm_softc *sc)
2502 {
2503     int status[3];
2504
2505     /*
2506      * The special sequence to enable the fourth button and the
2507      * roller. Immediately after this sequence check status bytes.
2508      * if the mouse is NetScroll, the second and the third bytes are
2509      * '3' and 'D'.
2510      */
2511
2512     /*
2513      * If the mouse is an ordinary PS/2 mouse, the status bytes should
2514      * look like the following.
2515      *
2516      * byte 1 bit 7 always 0
2517      *        bit 6 stream mode (0)
2518      *        bit 5 disabled (0)
2519      *        bit 4 1:1 scaling (0)
2520      *        bit 3 always 0
2521      *        bit 0-2 button status
2522      * byte 2 resolution (PSMD_RES_HIGH)
2523      * byte 3 report rate (?)
2524      */
2525
2526     if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 1, status))
2527         return FALSE;
2528     if ((status[1] != '3') || (status[2] != 'D'))
2529         return FALSE;
2530     /* FIXME: SmartScroll Mouse has 5 buttons! XXX */
2531     sc->hw.buttons = 4;
2532     return TRUE;
2533 }
2534
2535 /* Genius NetMouse/NetMouse Pro, ASCII Mie Mouse, NetScroll Optical */
2536 static int
2537 enable_gmouse(struct psm_softc *sc)
2538 {
2539     int status[3];
2540
2541     /*
2542      * The special sequence to enable the middle, "rubber" button.
2543      * Immediately after this sequence check status bytes.
2544      * if the mouse is NetMouse, NetMouse Pro, or ASCII MIE Mouse,
2545      * the second and the third bytes are '3' and 'U'.
2546      * NOTE: NetMouse reports that it has three buttons although it has
2547      * two buttons and a rubber button. NetMouse Pro and MIE Mouse
2548      * say they have three buttons too and they do have a button on the
2549      * side...
2550      */
2551     if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 1, status))
2552         return FALSE;
2553     if ((status[1] != '3') || (status[2] != 'U'))
2554         return FALSE;
2555     return TRUE;
2556 }
2557
2558 /* ALPS GlidePoint */
2559 static int
2560 enable_aglide(struct psm_softc *sc)
2561 {
2562     int status[3];
2563
2564     /*
2565      * The special sequence to obtain ALPS GlidePoint specific
2566      * information. Immediately after this sequence, status bytes will
2567      * contain something interesting.
2568      * NOTE: ALPS produces several models of GlidePoint. Some of those
2569      * do not respond to this sequence, thus, cannot be detected this way.
2570      */
2571     if (set_mouse_sampling_rate(sc->kbdc, 100) != 100)
2572         return FALSE;
2573     if (!mouse_id_proc1(sc->kbdc, PSMD_RES_LOW, 2, status))
2574         return FALSE;
2575     if ((status[1] == PSMD_RES_LOW) || (status[2] == 100))
2576         return FALSE;
2577     return TRUE;
2578 }
2579
2580 /* Kensington ThinkingMouse/Trackball */
2581 static int
2582 enable_kmouse(struct psm_softc *sc)
2583 {
2584     static unsigned char rate[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20 };
2585     KBDC kbdc = sc->kbdc;
2586     int status[3];
2587     int id1;
2588     int id2;
2589     int i;
2590
2591     id1 = get_aux_id(kbdc);
2592     if (set_mouse_sampling_rate(kbdc, 10) != 10)
2593         return FALSE;
2594     /*
2595      * The device is now in the native mode? It returns a different
2596      * ID value...
2597      */
2598     id2 = get_aux_id(kbdc);
2599     if ((id1 == id2) || (id2 != 2))
2600         return FALSE;
2601
2602     if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
2603         return FALSE;
2604 #if PSM_DEBUG >= 2
2605     /* at this point, resolution is LOW, sampling rate is 10/sec */
2606     if (get_mouse_status(kbdc, status, 0, 3) < 3)
2607         return FALSE;
2608 #endif
2609
2610     /*
2611      * The special sequence to enable the third and fourth buttons.
2612      * Otherwise they behave like the first and second buttons.
2613      */
2614     for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2615         if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2616             return FALSE;
2617     }
2618
2619     /*
2620      * At this point, the device is using default resolution and
2621      * sampling rate for the native mode.
2622      */
2623     if (get_mouse_status(kbdc, status, 0, 3) < 3)
2624         return FALSE;
2625     if ((status[1] == PSMD_RES_LOW) || (status[2] == rate[i - 1]))
2626         return FALSE;
2627
2628     /* the device appears be enabled by this sequence, diable it for now */
2629     disable_aux_dev(kbdc);
2630     empty_aux_buffer(kbdc, 5);
2631
2632     return TRUE;
2633 }
2634
2635 /* Logitech MouseMan+/FirstMouse+, IBM ScrollPoint Mouse */
2636 static int
2637 enable_mmanplus(struct psm_softc *sc)
2638 {
2639     KBDC kbdc = sc->kbdc;
2640     int data[3];
2641
2642     /* the special sequence to enable the fourth button and the roller. */
2643     /*
2644      * NOTE: for ScrollPoint to respond correctly, the SET_RESOLUTION
2645      * must be called exactly three times since the last RESET command
2646      * before this sequence. XXX
2647      */
2648     if (!set_mouse_scaling(kbdc, 1))
2649         return FALSE;
2650     if (!mouse_ext_command(kbdc, 0x39) || !mouse_ext_command(kbdc, 0xdb))
2651         return FALSE;
2652     if (get_mouse_status(kbdc, data, 1, 3) < 3)
2653         return FALSE;
2654
2655     /*
2656      * PS2++ protocl, packet type 0
2657      *
2658      *          b7 b6 b5 b4 b3 b2 b1 b0
2659      * byte 1:  *  1  p3 p2 1  *  *  *
2660      * byte 2:  1  1  p1 p0 m1 m0 1  0
2661      * byte 3:  m7 m6 m5 m4 m3 m2 m1 m0
2662      *
2663      * p3-p0: packet type: 0
2664      * m7-m0: model ID: MouseMan+:0x50, FirstMouse+:0x51, ScrollPoint:0x58...
2665      */
2666     /* check constant bits */
2667     if ((data[0] & MOUSE_PS2PLUS_SYNCMASK) != MOUSE_PS2PLUS_SYNC)
2668         return FALSE;
2669     if ((data[1] & 0xc3) != 0xc2)
2670         return FALSE;
2671     /* check d3-d0 in byte 2 */
2672     if (!MOUSE_PS2PLUS_CHECKBITS(data))
2673         return FALSE;
2674     /* check p3-p0 */
2675     if (MOUSE_PS2PLUS_PACKET_TYPE(data) != 0)
2676         return FALSE;
2677
2678     sc->hw.hwid &= 0x00ff;
2679     sc->hw.hwid |= data[2] << 8;        /* save model ID */
2680
2681     /*
2682      * MouseMan+ (or FirstMouse+) is now in its native mode, in which
2683      * the wheel and the fourth button events are encoded in the
2684      * special data packet. The mouse may be put in the IntelliMouse mode
2685      * if it is initialized by the IntelliMouse's method.
2686      */
2687     return TRUE;
2688 }
2689
2690 /* MS IntelliMouse Explorer */
2691 static int
2692 enable_msexplorer(struct psm_softc *sc)
2693 {
2694     static unsigned char rate0[] = { 200, 100, 80, };
2695     static unsigned char rate1[] = { 200, 200, 80, };
2696     KBDC kbdc = sc->kbdc;
2697     int id;
2698     int i;
2699
2700     /* the special sequence to enable the extra buttons and the roller. */
2701     for (i = 0; i < sizeof(rate1)/sizeof(rate1[0]); ++i) {
2702         if (set_mouse_sampling_rate(kbdc, rate1[i]) != rate1[i])
2703             return FALSE;
2704     }
2705     /* the device will give the genuine ID only after the above sequence */
2706     id = get_aux_id(kbdc);
2707     if (id != PSM_EXPLORER_ID)
2708         return FALSE;
2709
2710     sc->hw.hwid = id;
2711     sc->hw.buttons = 5;         /* IntelliMouse Explorer XXX */
2712
2713     /*
2714      * XXX: this is a kludge to fool some KVM switch products
2715      * which think they are clever enough to know the 4-byte IntelliMouse
2716      * protocol, and assume any other protocols use 3-byte packets.
2717      * They don't convey 4-byte data packets from the IntelliMouse Explorer
2718      * correctly to the host computer because of this!
2719      * The following sequence is actually IntelliMouse's "wake up"
2720      * sequence; it will make the KVM think the mouse is IntelliMouse
2721      * when it is in fact IntelliMouse Explorer.
2722      */
2723     for (i = 0; i < sizeof(rate0)/sizeof(rate0[0]); ++i) {
2724         if (set_mouse_sampling_rate(kbdc, rate0[i]) != rate0[i])
2725             break;
2726     }
2727     id = get_aux_id(kbdc);
2728
2729     return TRUE;
2730 }
2731
2732 /* MS IntelliMouse */
2733 static int
2734 enable_msintelli(struct psm_softc *sc)
2735 {
2736     /*
2737      * Logitech MouseMan+ and FirstMouse+ will also respond to this
2738      * probe routine and act like IntelliMouse.
2739      */
2740
2741     static unsigned char rate[] = { 200, 100, 80, };
2742     KBDC kbdc = sc->kbdc;
2743     int id;
2744     int i;
2745
2746     /* the special sequence to enable the third button and the roller. */
2747     for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2748         if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2749             return FALSE;
2750     }
2751     /* the device will give the genuine ID only after the above sequence */
2752     id = get_aux_id(kbdc);
2753     if (id != PSM_INTELLI_ID)
2754         return FALSE;
2755
2756     sc->hw.hwid = id;
2757     sc->hw.buttons = 3;
2758
2759     return TRUE;
2760 }
2761
2762 /* A4 Tech 4D Mouse */
2763 static int
2764 enable_4dmouse(struct psm_softc *sc)
2765 {
2766     /*
2767      * Newer wheel mice from A4 Tech may use the 4D+ protocol.
2768      */
2769
2770     static unsigned char rate[] = { 200, 100, 80, 60, 40, 20 };
2771     KBDC kbdc = sc->kbdc;
2772     int id;
2773     int i;
2774
2775     for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2776         if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2777             return FALSE;
2778     }
2779     id = get_aux_id(kbdc);
2780     /*
2781      * WinEasy 4D, 4 Way Scroll 4D: 6
2782      * Cable-Free 4D: 8 (4DPLUS)
2783      * WinBest 4D+, 4 Way Scroll 4D+: 8 (4DPLUS)
2784      */
2785     if (id != PSM_4DMOUSE_ID)
2786         return FALSE;
2787
2788     sc->hw.hwid = id;
2789     sc->hw.buttons = 3;         /* XXX some 4D mice have 4? */
2790
2791     return TRUE;
2792 }
2793
2794 /* A4 Tech 4D+ Mouse */
2795 static int
2796 enable_4dplus(struct psm_softc *sc)
2797 {
2798     /*
2799      * Newer wheel mice from A4 Tech seem to use this protocol.
2800      * Older models are recognized as either 4D Mouse or IntelliMouse.
2801      */
2802     KBDC kbdc = sc->kbdc;
2803     int id;
2804
2805     /*
2806      * enable_4dmouse() already issued the following ID sequence...
2807     static unsigned char rate[] = { 200, 100, 80, 60, 40, 20 };
2808     int i;
2809
2810     for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2811         if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2812             return FALSE;
2813     }
2814     */
2815
2816     id = get_aux_id(kbdc);
2817     if (id != PSM_4DPLUS_ID)
2818         return FALSE;
2819
2820     sc->hw.hwid = id;
2821     sc->hw.buttons = 4;         /* XXX */
2822
2823     return TRUE;
2824 }
2825
2826 /* Interlink electronics VersaPad */
2827 static int
2828 enable_versapad(struct psm_softc *sc)
2829 {
2830     KBDC kbdc = sc->kbdc;
2831     int data[3];
2832
2833     set_mouse_resolution(kbdc, PSMD_RES_MEDIUM_HIGH); /* set res. 2 */
2834     set_mouse_sampling_rate(kbdc, 100);         /* set rate 100 */
2835     set_mouse_scaling(kbdc, 1);                 /* set scale 1:1 */
2836     set_mouse_scaling(kbdc, 1);                 /* set scale 1:1 */
2837     set_mouse_scaling(kbdc, 1);                 /* set scale 1:1 */
2838     set_mouse_scaling(kbdc, 1);                 /* set scale 1:1 */
2839     if (get_mouse_status(kbdc, data, 0, 3) < 3) /* get status */
2840         return FALSE;
2841     if (data[2] != 0xa || data[1] != 0 )        /* rate == 0xa && res. == 0 */
2842         return FALSE;
2843     set_mouse_scaling(kbdc, 1);                 /* set scale 1:1 */
2844
2845     sc->config |= PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND;
2846
2847     return TRUE;                                /* PS/2 absolute mode */
2848 }
2849
2850 static int
2851 psmresume(device_t dev)
2852 {
2853     struct psm_softc *sc = device_get_softc(dev);
2854     int unit = device_get_unit(dev);
2855     int err;
2856
2857     if (verbose >= 2)
2858         log(LOG_NOTICE, "psm%d: system resume hook called.\n", unit);
2859
2860     if (!(sc->config & PSM_CONFIG_HOOKRESUME))
2861         return (0);
2862
2863     err = reinitialize(sc, sc->config & PSM_CONFIG_INITAFTERSUSPEND);
2864
2865     if ((sc->state & PSM_ASLP) && !(sc->state & PSM_VALID)) {
2866         /*
2867          * Release the blocked process; it must be notified that the device
2868          * cannot be accessed anymore.
2869          */
2870         sc->state &= ~PSM_ASLP;
2871         wakeup((caddr_t)sc);
2872     }
2873
2874     if (verbose >= 2)
2875         log(LOG_DEBUG, "psm%d: system resume hook exiting.\n", unit);
2876
2877     return (err);
2878 }
2879
2880 DRIVER_MODULE(psm, atkbdc, psm_driver, psm_devclass, 0, 0);