sys/isa/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 /*
  24  *  Ported to 386bsd Oct 17, 1992
  25  *  Sandi Donno, Computer Science, University of Cape Town, South Africa
  26  *  Please send bug reports to sandi@cs.uct.ac.za
  27  *
  28  *  Thanks are also due to Rick Macklem, rick@snowhite.cis.uoguelph.ca -
  29  *  although I was only partially successful in getting the alpha release
  30  *  of his "driver for the Logitech and ATI Inport Bus mice for use with
  31  *  386bsd and the X386 port" to work with my Microsoft mouse, I nevertheless
  32  *  found his code to be an invaluable reference when porting this driver
  33  *  to 386bsd.
  34  *
  35  *  Further modifications for latest 386BSD+patchkit and port to NetBSD,
  36  *  Andrew Herbert <andrew@werple.apana.org.au> - 8 June 1993
  37  *
  38  *  Cloned from the Microsoft Bus Mouse driver, also by Erik Forsberg, by
  39  *  Andrew Herbert - 12 June 1993
  40  *
  41  *  Modified for PS/2 mouse by Charles Hannum <mycroft@ai.mit.edu>
  42  *  - 13 June 1993
  43  *
  44  *  Modified for PS/2 AUX mouse by Shoji Yuen <yuen@nuie.nagoya-u.ac.jp>
  45  *  - 24 October 1993
  46  *
  47  *  Hardware access routines and probe logic rewritten by
  48  *  Kazutaka Yokota <yokota@zodiac.mech.utsunomiya-u.ac.jp>
  49  *  - 3, 14, 22 October 1996.
  50  *  - 12 November 1996. IOCTLs and rearranging `psmread', `psmioctl'...
  51  *  - 14, 30 November 1996. Uses `kbdio.c'.
  52  *  - 13 December 1996. Uses queuing version of `kbdio.c'.
  53  *  - January/February 1997. Tweaked probe logic for
  54  *    HiNote UltraII/Latitude/Armada laptops.
  55  *  - 30 July 1997. Added APM support.
  56  *  - 5 March 1997. Defined driver configuration flags (PSM_CONFIG_XXX).
  57  *    Improved sync check logic.
  58  *    Vendor specific support routines.
  59  */
  60
  61 #include <sys/cdefs.h>
  62 __FBSDID("$FreeBSD$");
  63
  64 #include "opt_psm.h"
  65
  66 #include <sys/param.h>
  67 #include <sys/systm.h>
  68 #include <sys/kernel.h>
  69 #include <sys/module.h>
  70 #include <sys/bus.h>
  71 #include <sys/conf.h>
  72 #include <sys/poll.h>
  73 #include <sys/syslog.h>
  74 #include <machine/bus.h>
  75 #include <sys/rman.h>
  76 #include <sys/selinfo.h>
  77 #include <sys/sysctl.h>
  78 #include <sys/time.h>
  79 #include <sys/uio.h>
  80
  81 #include <sys/limits.h>
  82 #include <sys/mouse.h>
  83 #include <machine/resource.h>
  84
  85 #include <isa/isavar.h>
  86 #include <dev/kbd/atkbdcreg.h>
  87
  88 /*
  89  * Driver specific options: the following options may be set by
  90  * `options' statements in the kernel configuration file.
  91  */
  92
  93 /* debugging */
  94 #ifndef PSM_DEBUG
  95 #define PSM_DEBUG       0       /* logging: 0: none, 1: brief, 2: verbose */
  96 #endif
  97
  98 #ifndef PSM_SYNCERR_THRESHOLD1
  99 #define PSM_SYNCERR_THRESHOLD1  20
 100 #endif
 101
 102 #ifndef PSM_INPUT_TIMEOUT
 103 #define PSM_INPUT_TIMEOUT       2000000 /* 2 sec */
 104 #endif
 105
 106 /* end of driver specific options */
 107
 108 #define PSM_DRIVER_NAME         "psm"
 109 #define PSMCPNP_DRIVER_NAME     "psmcpnp"
 110
 111 /* input queue */
 112 #define PSM_BUFSIZE             960
 113 #define PSM_SMALLBUFSIZE        240
 114
 115 /* operation levels */
 116 #define PSM_LEVEL_BASE          0
 117 #define PSM_LEVEL_STANDARD      1
 118 #define PSM_LEVEL_NATIVE        2
 119 #define PSM_LEVEL_MIN           PSM_LEVEL_BASE
 120 #define PSM_LEVEL_MAX           PSM_LEVEL_NATIVE
 121
 122 /* Logitech PS2++ protocol */
 123 #define MOUSE_PS2PLUS_CHECKBITS(b)      \
 124                                 ((((b[2] & 0x03) << 2) | 0x02) == (b[1] & 0x0f))
 125 #define MOUSE_PS2PLUS_PACKET_TYPE(b)    \
 126                                 (((b[0] & 0x30) >> 2) | ((b[1] & 0x30) >> 4))
 127
 128 /* some macros */
 129 #define PSM_UNIT(dev)           (minor(dev) >> 1)
 130 #define PSM_NBLOCKIO(dev)       (minor(dev) & 1)
 131 #define PSM_MKMINOR(unit,block) (((unit) << 1) | ((block) ? 0:1))
 132
 133 /* ring buffer */
 134 typedef struct ringbuf {
 135     int           count;        /* # of valid elements in the buffer */
 136     int           head;         /* head pointer */
 137     int           tail;         /* tail poiner */
 138     unsigned char buf[PSM_BUFSIZE];
 139 } ringbuf_t;
 140
 141 /* data buffer */
 142 typedef struct packetbuf {
 143     unsigned char ipacket[16];  /* interim input buffer */
 144     int           inputbytes;   /* # of bytes in the input buffer */
 145 } packetbuf_t;
 146
 147 #ifndef PSM_PACKETQUEUE
 148 #define PSM_PACKETQUEUE 128
 149 #endif
 150
 151 /* driver control block */
 152 struct psm_softc {              /* Driver status information */
 153     int           unit;
 154     struct selinfo rsel;        /* Process selecting for Input */
 155     unsigned char state;        /* Mouse driver state */
 156     int           config;       /* driver configuration flags */
 157     int           flags;        /* other flags */
 158     KBDC          kbdc;         /* handle to access the keyboard controller */
 159     struct resource *intr;      /* IRQ resource */
 160     void          *ih;          /* interrupt handle */
 161     mousehw_t     hw;           /* hardware information */
 162     mousemode_t   mode;         /* operation mode */
 163     mousemode_t   dflt_mode;    /* default operation mode */
 164     mousestatus_t status;       /* accumulated mouse movement */
 165     ringbuf_t     queue;        /* mouse status queue */
 166     packetbuf_t   pqueue[PSM_PACKETQUEUE];      /* mouse data queue */
 167     int           pqueue_start; /* start of data in queue */
 168     int           pqueue_end;   /* end of data in queue */
 169     int           button;       /* the latest button state */
 170     int           xold; /* previous absolute X position */
 171     int           yold; /* previous absolute Y position */
 172     int           syncerrors; /* XXX: KILL ME! */
 173     struct timeval inputtimeout;
 174     struct timeval lastsoftintr;        /* time of last soft interrupt */
 175     struct timeval lastinputerr;        /* time last sync error happened */
 176     int           watchdog;     /* watchdog timer flag */
 177     struct callout_handle callout;      /* watchdog timer call out */
 178     struct callout_handle softcallout;  /* buffer timer call out */
 179     dev_t         dev;
 180     dev_t         bdev;
 181     int           lasterr;
 182     int           cmdcount;
 183 };
 184 static devclass_t psm_devclass;
 185 #define PSM_SOFTC(unit) ((struct psm_softc*)devclass_get_softc(psm_devclass, unit))
 186
 187 /* driver state flags (state) */
 188 #define PSM_VALID               0x80
 189 #define PSM_OPEN                1       /* Device is open */
 190 #define PSM_ASLP                2       /* Waiting for mouse data */
 191 #define PSM_SOFTARMED           4       /* Software interrupt armed */
 192
 193 /* driver configuration flags (config) */
 194 #define PSM_CONFIG_RESOLUTION   0x000f  /* resolution */
 195 #define PSM_CONFIG_ACCEL        0x00f0  /* acceleration factor */
 196 #define PSM_CONFIG_NOCHECKSYNC  0x0100  /* disable sync. test */
 197 #define PSM_CONFIG_NOIDPROBE    0x0200  /* disable mouse model probe */
 198 #define PSM_CONFIG_NORESET      0x0400  /* don't reset the mouse */
 199 #define PSM_CONFIG_FORCETAP     0x0800  /* assume `tap' action exists */
 200 #define PSM_CONFIG_IGNPORTERROR 0x1000  /* ignore error in aux port test */
 201 #define PSM_CONFIG_HOOKRESUME   0x2000  /* hook the system resume event */
 202 #define PSM_CONFIG_INITAFTERSUSPEND 0x4000 /* init the device at the resume event */
 203 #define PSM_CONFIG_SYNCHACK     0x8000 /* enable `out-of-sync' hack */
 204
 205 #define PSM_CONFIG_FLAGS        (PSM_CONFIG_RESOLUTION          \
 206                                     | PSM_CONFIG_ACCEL          \
 207                                     | PSM_CONFIG_NOCHECKSYNC    \
 208                                     | PSM_CONFIG_SYNCHACK       \
 209                                     | PSM_CONFIG_NOIDPROBE      \
 210                                     | PSM_CONFIG_NORESET        \
 211                                     | PSM_CONFIG_FORCETAP       \
 212                                     | PSM_CONFIG_IGNPORTERROR   \
 213                                     | PSM_CONFIG_HOOKRESUME     \
 214                                     | PSM_CONFIG_INITAFTERSUSPEND)
 215
 216 /* other flags (flags) */
 217 #define PSM_FLAGS_FINGERDOWN    0x0001 /* VersaPad finger down */
 218
 219 /* for backward compatibility */
 220 #define OLD_MOUSE_GETHWINFO     _IOR('M', 1, old_mousehw_t)
 221 #define OLD_MOUSE_GETMODE       _IOR('M', 2, old_mousemode_t)
 222 #define OLD_MOUSE_SETMODE       _IOW('M', 3, old_mousemode_t)
 223
 224 typedef struct old_mousehw {
 225     int buttons;
 226     int iftype;
 227     int type;
 228     int hwid;
 229 } old_mousehw_t;
 230
 231 typedef struct old_mousemode {
 232     int protocol;
 233     int rate;
 234     int resolution;
 235     int accelfactor;
 236 } old_mousemode_t;
 237
 238 /* packet formatting function */
 239 typedef int packetfunc_t(struct psm_softc *, unsigned char *,
 240                               int *, int, mousestatus_t *);
 241
 242 /* function prototypes */
 243 static void psmidentify(driver_t *, device_t);
 244 static int psmprobe(device_t);
 245 static int psmattach(device_t);
 246 static int psmdetach(device_t);
 247 static int psmresume(device_t);
 248
 249 static d_open_t psmopen;
 250 static d_close_t psmclose;
 251 static d_read_t psmread;
 252 static d_ioctl_t psmioctl;
 253 static d_poll_t psmpoll;
 254
 255 static int enable_aux_dev(KBDC);
 256 static int disable_aux_dev(KBDC);
 257 static int get_mouse_status(KBDC, int *, int, int);
 258 static int get_aux_id(KBDC);
 259 static int set_mouse_sampling_rate(KBDC, int);
 260 static int set_mouse_scaling(KBDC, int);
 261 static int set_mouse_resolution(KBDC, int);
 262 static int set_mouse_mode(KBDC);
 263 static int get_mouse_buttons(KBDC);
 264 static int is_a_mouse(int);
 265 static void recover_from_error(KBDC);
 266 static int restore_controller(KBDC, int);
 267 static int doinitialize(struct psm_softc *, mousemode_t *);
 268 static int doopen(struct psm_softc *, int);
 269 static int reinitialize(struct psm_softc *, int);
 270 static char *model_name(int);
 271 static void psmsoftintr(void *);
 272 static void psmintr(void *);
 273 static void psmtimeout(void *);
 274 static int timeelapsed(const struct timeval *,
 275     int, int, const struct timeval *);
 276 static void dropqueue(struct psm_softc *);
 277 static void flushpackets(struct psm_softc *);
 278
 279 /* vendor specific features */
 280 typedef int probefunc_t(struct psm_softc *);
 281
 282 static int mouse_id_proc1(KBDC, int, int, int *);
 283 static int mouse_ext_command(KBDC, int);
 284 static probefunc_t enable_groller;
 285 static probefunc_t enable_gmouse;
 286 static probefunc_t enable_aglide;
 287 static probefunc_t enable_kmouse;
 288 static probefunc_t enable_msexplorer;
 289 static probefunc_t enable_msintelli;
 290 static probefunc_t enable_4dmouse;
 291 static probefunc_t enable_4dplus;
 292 static probefunc_t enable_mmanplus;
 293 static probefunc_t enable_versapad;
 294 static int tame_mouse(struct psm_softc *, packetbuf_t *, mousestatus_t *, unsigned char *);
 295
 296 static struct {
 297     int                 model;
 298     unsigned char       syncmask;
 299     int                 packetsize;
 300     probefunc_t         *probefunc;
 301 } vendortype[] = {
 302     /*
 303      * WARNING: the order of probe is very important.  Don't mess it
 304      * unless you know what you are doing.
 305      */
 306     { MOUSE_MODEL_NET,                  /* Genius NetMouse */
 307       0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_gmouse, },
 308     { MOUSE_MODEL_NETSCROLL,            /* Genius NetScroll */
 309       0xc8, 6, enable_groller, },
 310     { MOUSE_MODEL_MOUSEMANPLUS,         /* Logitech MouseMan+ */
 311       0x08, MOUSE_PS2_PACKETSIZE, enable_mmanplus, },
 312     { MOUSE_MODEL_EXPLORER,             /* Microsoft IntelliMouse Explorer */
 313       0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msexplorer, },
 314     { MOUSE_MODEL_4D,                   /* A4 Tech 4D Mouse */
 315       0x08, MOUSE_4D_PACKETSIZE, enable_4dmouse, },
 316     { MOUSE_MODEL_4DPLUS,               /* A4 Tech 4D+ Mouse */
 317       0xc8, MOUSE_4DPLUS_PACKETSIZE, enable_4dplus, },
 318     { MOUSE_MODEL_INTELLI,              /* Microsoft IntelliMouse */
 319       0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msintelli, },
 320     { MOUSE_MODEL_GLIDEPOINT,           /* ALPS GlidePoint */
 321       0xc0, MOUSE_PS2_PACKETSIZE, enable_aglide, },
 322     { MOUSE_MODEL_THINK,                /* Kensignton ThinkingMouse */
 323       0x80, MOUSE_PS2_PACKETSIZE, enable_kmouse, },
 324     { MOUSE_MODEL_VERSAPAD,             /* Interlink electronics VersaPad */
 325       0xe8, MOUSE_PS2VERSA_PACKETSIZE, enable_versapad, },
 326     { MOUSE_MODEL_GENERIC,
 327       0xc0, MOUSE_PS2_PACKETSIZE, NULL, },
 328 };
 329 #define GENERIC_MOUSE_ENTRY     ((sizeof(vendortype) / sizeof(*vendortype)) - 1)
 330
 331 /* device driver declarateion */
 332 static device_method_t psm_methods[] = {
 333         /* Device interface */
 334         DEVMETHOD(device_identify,      psmidentify),
 335         DEVMETHOD(device_probe,         psmprobe),
 336         DEVMETHOD(device_attach,        psmattach),
 337         DEVMETHOD(device_detach,        psmdetach),
 338         DEVMETHOD(device_resume,        psmresume),
 339
 340         { 0, 0 }
 341 };
 342
 343 static driver_t psm_driver = {
 344     PSM_DRIVER_NAME,
 345     psm_methods,
 346     sizeof(struct psm_softc),
 347 };
 348
 349 #define CDEV_MAJOR        21
 350
 351 static struct cdevsw psm_cdevsw = {
 352         .d_open =       psmopen,
 353         .d_close =      psmclose,
 354         .d_read =       psmread,
 355         .d_ioctl =      psmioctl,
 356         .d_poll =       psmpoll,
 357         .d_name =       PSM_DRIVER_NAME,
 358         .d_maj =        CDEV_MAJOR,
 359 };
 360
 361 /* debug message level */
 362 static int verbose = PSM_DEBUG;
 363
 364 /* device I/O routines */
 365 static int
 366 enable_aux_dev(KBDC kbdc)
 367 {
 368     int res;
 369
 370     res = send_aux_command(kbdc, PSMC_ENABLE_DEV);
 371     if (verbose >= 2)
 372         log(LOG_DEBUG, "psm: ENABLE_DEV return code:%04x\n", res);
 373
 374     return (res == PSM_ACK);
 375 }
 376
 377 static int
 378 disable_aux_dev(KBDC kbdc)
 379 {
 380     int res;
 381
 382     res = send_aux_command(kbdc, PSMC_DISABLE_DEV);
 383     if (verbose >= 2)
 384         log(LOG_DEBUG, "psm: DISABLE_DEV return code:%04x\n", res);
 385
 386     return (res == PSM_ACK);
 387 }
 388
 389 static int
 390 get_mouse_status(KBDC kbdc, int *status, int flag, int len)
 391 {
 392     int cmd;
 393     int res;
 394     int i;
 395
 396     switch (flag) {
 397     case 0:
 398     default:
 399         cmd = PSMC_SEND_DEV_STATUS;
 400         break;
 401     case 1:
 402         cmd = PSMC_SEND_DEV_DATA;
 403         break;
 404     }
 405     empty_aux_buffer(kbdc, 5);
 406     res = send_aux_command(kbdc, cmd);
 407     if (verbose >= 2)
 408         log(LOG_DEBUG, "psm: SEND_AUX_DEV_%s return code:%04x\n",
 409             (flag == 1) ? "DATA" : "STATUS", res);
 410     if (res != PSM_ACK)
 411         return 0;
 412
 413     for (i = 0; i < len; ++i) {
 414         status[i] = read_aux_data(kbdc);
 415         if (status[i] < 0)
 416             break;
 417     }
 418
 419     if (verbose) {
 420         log(LOG_DEBUG, "psm: %s %02x %02x %02x\n",
 421             (flag == 1) ? "data" : "status", status[0], status[1], status[2]);
 422     }
 423
 424     return i;
 425 }
 426
 427 static int
 428 get_aux_id(KBDC kbdc)
 429 {
 430     int res;
 431     int id;
 432
 433     empty_aux_buffer(kbdc, 5);
 434     res = send_aux_command(kbdc, PSMC_SEND_DEV_ID);
 435     if (verbose >= 2)
 436         log(LOG_DEBUG, "psm: SEND_DEV_ID return code:%04x\n", res);
 437     if (res != PSM_ACK)
 438         return (-1);
 439
 440     /* 10ms delay */
 441     DELAY(10000);
 442
 443     id = read_aux_data(kbdc);
 444     if (verbose >= 2)
 445         log(LOG_DEBUG, "psm: device ID: %04x\n", id);
 446
 447     return id;
 448 }
 449
 450 static int
 451 set_mouse_sampling_rate(KBDC kbdc, int rate)
 452 {
 453     int res;
 454
 455     res = send_aux_command_and_data(kbdc, PSMC_SET_SAMPLING_RATE, rate);
 456     if (verbose >= 2)
 457         log(LOG_DEBUG, "psm: SET_SAMPLING_RATE (%d) %04x\n", rate, res);
 458
 459     return ((res == PSM_ACK) ? rate : -1);
 460 }
 461
 462 static int
 463 set_mouse_scaling(KBDC kbdc, int scale)
 464 {
 465     int res;
 466
 467     switch (scale) {
 468     case 1:
 469     default:
 470         scale = PSMC_SET_SCALING11;
 471         break;
 472     case 2:
 473         scale = PSMC_SET_SCALING21;
 474         break;
 475     }
 476     res = send_aux_command(kbdc, scale);
 477     if (verbose >= 2)
 478         log(LOG_DEBUG, "psm: SET_SCALING%s return code:%04x\n",
 479             (scale == PSMC_SET_SCALING21) ? "21" : "11", res);
 480
 481     return (res == PSM_ACK);
 482 }
 483
 484 /* `val' must be 0 through PSMD_MAX_RESOLUTION */
 485 static int
 486 set_mouse_resolution(KBDC kbdc, int val)
 487 {
 488     int res;
 489
 490     res = send_aux_command_and_data(kbdc, PSMC_SET_RESOLUTION, val);
 491     if (verbose >= 2)
 492         log(LOG_DEBUG, "psm: SET_RESOLUTION (%d) %04x\n", val, res);
 493
 494     return ((res == PSM_ACK) ? val : -1);
 495 }
 496
 497 /*
 498  * NOTE: once `set_mouse_mode()' is called, the mouse device must be
 499  * re-enabled by calling `enable_aux_dev()'
 500  */
 501 static int
 502 set_mouse_mode(KBDC kbdc)
 503 {
 504     int res;
 505
 506     res = send_aux_command(kbdc, PSMC_SET_STREAM_MODE);
 507     if (verbose >= 2)
 508         log(LOG_DEBUG, "psm: SET_STREAM_MODE return code:%04x\n", res);
 509
 510     return (res == PSM_ACK);
 511 }
 512
 513 static int
 514 get_mouse_buttons(KBDC kbdc)
 515 {
 516     int c = 2;          /* assume two buttons by default */
 517     int status[3];
 518
 519     /*
 520      * NOTE: a special sequence to obtain Logitech Mouse specific
 521      * information: set resolution to 25 ppi, set scaling to 1:1, set
 522      * scaling to 1:1, set scaling to 1:1. Then the second byte of the
 523      * mouse status bytes is the number of available buttons.
 524      * Some manufactures also support this sequence.
 525      */
 526     if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
 527         return c;
 528     if (set_mouse_scaling(kbdc, 1) && set_mouse_scaling(kbdc, 1)
 529         && set_mouse_scaling(kbdc, 1)
 530         && (get_mouse_status(kbdc, status, 0, 3) >= 3)) {
 531         if (status[1] != 0)
 532             return status[1];
 533     }
 534     return c;
 535 }
 536
 537 /* misc subroutines */
 538 /*
 539  * Someday, I will get the complete list of valid pointing devices and
 540  * their IDs... XXX
 541  */
 542 static int
 543 is_a_mouse(int id)
 544 {
 545 #if 0
 546     static int valid_ids[] = {
 547         PSM_MOUSE_ID,           /* mouse */
 548         PSM_BALLPOINT_ID,       /* ballpoint device */
 549         PSM_INTELLI_ID,         /* Intellimouse */
 550         PSM_EXPLORER_ID,        /* Intellimouse Explorer */
 551         -1                      /* end of table */
 552     };
 553     int i;
 554
 555     for (i = 0; valid_ids[i] >= 0; ++i)
 556         if (valid_ids[i] == id)
 557             return TRUE;
 558     return FALSE;
 559 #else
 560     return TRUE;
 561 #endif
 562 }
 563
 564 static char *
 565 model_name(int model)
 566 {
 567     static struct {
 568         int model_code;
 569         char *model_name;
 570     } models[] = {
 571         { MOUSE_MODEL_NETSCROLL,        "NetScroll" },
 572         { MOUSE_MODEL_NET,              "NetMouse/NetScroll Optical" },
 573         { MOUSE_MODEL_GLIDEPOINT,       "GlidePoint" },
 574         { MOUSE_MODEL_THINK,            "ThinkingMouse" },
 575         { MOUSE_MODEL_INTELLI,          "IntelliMouse" },
 576         { MOUSE_MODEL_MOUSEMANPLUS,     "MouseMan+" },
 577         { MOUSE_MODEL_VERSAPAD,         "VersaPad" },
 578         { MOUSE_MODEL_EXPLORER,         "IntelliMouse Explorer" },
 579         { MOUSE_MODEL_4D,               "4D Mouse" },
 580         { MOUSE_MODEL_4DPLUS,           "4D+ Mouse" },
 581         { MOUSE_MODEL_GENERIC,          "Generic PS/2 mouse" },
 582         { MOUSE_MODEL_UNKNOWN,          NULL },
 583     };
 584     int i;
 585
 586     for (i = 0; models[i].model_code != MOUSE_MODEL_UNKNOWN; ++i) {
 587         if (models[i].model_code == model)
 588             return models[i].model_name;
 589     }
 590     return "Unknown";
 591 }
 592
 593 static void
 594 recover_from_error(KBDC kbdc)
 595 {
 596     /* discard anything left in the output buffer */
 597     empty_both_buffers(kbdc, 10);
 598
 599 #if 0
 600     /*
 601      * NOTE: KBDC_RESET_KBD may not restore the communication between the
 602      * keyboard and the controller.
 603      */
 604     reset_kbd(kbdc);
 605 #else
 606     /*
 607      * NOTE: somehow diagnostic and keyboard port test commands bring the
 608      * keyboard back.
 609      */
 610     if (!test_controller(kbdc))
 611         log(LOG_ERR, "psm: keyboard controller failed.\n");
 612     /* if there isn't a keyboard in the system, the following error is OK */
 613     if (test_kbd_port(kbdc) != 0) {
 614         if (verbose)
 615             log(LOG_ERR, "psm: keyboard port failed.\n");
 616     }
 617 #endif
 618 }
 619
 620 static int
 621 restore_controller(KBDC kbdc, int command_byte)
 622 {
 623     empty_both_buffers(kbdc, 10);
 624
 625     if (!set_controller_command_byte(kbdc, 0xff, command_byte)) {
 626         log(LOG_ERR, "psm: failed to restore the keyboard controller "
 627                      "command byte.\n");
 628         empty_both_buffers(kbdc, 10);
 629         return FALSE;
 630     } else {
 631         empty_both_buffers(kbdc, 10);
 632         return TRUE;
 633     }
 634 }
 635
 636 /*
 637  * Re-initialize the aux port and device. The aux port must be enabled
 638  * and its interrupt must be disabled before calling this routine.
 639  * The aux device will be disabled before returning.
 640  * The keyboard controller must be locked via `kbdc_lock()' before
 641  * calling this routine.
 642  */
 643 static int
 644 doinitialize(struct psm_softc *sc, mousemode_t *mode)
 645 {
 646     KBDC kbdc = sc->kbdc;
 647     int stat[3];
 648     int i;
 649
 650     switch((i = test_aux_port(kbdc))) {
 651     case 1:     /* ignore this error */
 652     case PSM_ACK:
 653         if (verbose)
 654             log(LOG_DEBUG, "psm%d: strange result for test aux port (%d).\n",
 655                 sc->unit, i);
 656         /* FALLTHROUGH */
 657     case 0:     /* no error */
 658         break;
 659     case -1:    /* time out */
 660     default:    /* error */
 661         recover_from_error(kbdc);
 662         if (sc->config & PSM_CONFIG_IGNPORTERROR)
 663             break;
 664         log(LOG_ERR, "psm%d: the aux port is not functioning (%d).\n",
 665             sc->unit, i);
 666         return FALSE;
 667     }
 668
 669     if (sc->config & PSM_CONFIG_NORESET) {
 670         /*
 671          * Don't try to reset the pointing device.  It may possibly be
 672          * left in the unknown state, though...
 673          */
 674     } else {
 675         /*
 676          * NOTE: some controllers appears to hang the `keyboard' when
 677          * the aux port doesn't exist and `PSMC_RESET_DEV' is issued.
 678          */
 679         if (!reset_aux_dev(kbdc)) {
 680             recover_from_error(kbdc);
 681             log(LOG_ERR, "psm%d: failed to reset the aux device.\n", sc->unit);
 682             return FALSE;
 683         }
 684     }
 685
 686     /*
 687      * both the aux port and the aux device is functioning, see
 688      * if the device can be enabled.
 689      */
 690     if (!enable_aux_dev(kbdc) || !disable_aux_dev(kbdc)) {
 691         log(LOG_ERR, "psm%d: failed to enable the aux device.\n", sc->unit);
 692         return FALSE;
 693     }
 694     empty_both_buffers(kbdc, 10);       /* remove stray data if any */
 695
 696     if (sc->config & PSM_CONFIG_NOIDPROBE) {
 697         i = GENERIC_MOUSE_ENTRY;
 698     } else {
 699         /* FIXME: hardware ID, mouse buttons? */
 700
 701         /* other parameters */
 702         for (i = 0; vendortype[i].probefunc != NULL; ++i) {
 703             if ((*vendortype[i].probefunc)(sc)) {
 704                 if (verbose >= 2)
 705                     log(LOG_ERR, "psm%d: found %s\n",
 706                         sc->unit, model_name(vendortype[i].model));
 707                 break;
 708             }
 709         }
 710     }
 711
 712     sc->hw.model = vendortype[i].model;
 713     sc->mode.packetsize = vendortype[i].packetsize;
 714
 715     /* set mouse parameters */
 716     if (mode != (mousemode_t *)NULL) {
 717         if (mode->rate > 0)
 718             mode->rate = set_mouse_sampling_rate(kbdc, mode->rate);
 719         if (mode->resolution >= 0)
 720             mode->resolution = set_mouse_resolution(kbdc, mode->resolution);
 721         set_mouse_scaling(kbdc, 1);
 722         set_mouse_mode(kbdc);
 723     }
 724
 725     /* request a data packet and extract sync. bits */
 726     if (get_mouse_status(kbdc, stat, 1, 3) < 3) {
 727         log(LOG_DEBUG, "psm%d: failed to get data (doinitialize).\n",
 728             sc->unit);
 729         sc->mode.syncmask[0] = 0;
 730     } else {
 731         sc->mode.syncmask[1] = stat[0] & sc->mode.syncmask[0];  /* syncbits */
 732         /* the NetScroll Mouse will send three more bytes... Ignore them */
 733         empty_aux_buffer(kbdc, 5);
 734     }
 735
 736     /* just check the status of the mouse */
 737     if (get_mouse_status(kbdc, stat, 0, 3) < 3)
 738         log(LOG_DEBUG, "psm%d: failed to get status (doinitialize).\n",
 739             sc->unit);
 740
 741     return TRUE;
 742 }
 743
 744 static int
 745 doopen(struct psm_softc *sc, int command_byte)
 746 {
 747     int stat[3];
 748
 749     /* enable the mouse device */
 750     if (!enable_aux_dev(sc->kbdc)) {
 751         /* MOUSE ERROR: failed to enable the mouse because:
 752          * 1) the mouse is faulty,
 753          * 2) the mouse has been removed(!?)
 754          * In the latter case, the keyboard may have hung, and need
 755          * recovery procedure...
 756          */
 757         recover_from_error(sc->kbdc);
 758 #if 0
 759         /* FIXME: we could reset the mouse here and try to enable
 760          * it again. But it will take long time and it's not a good
 761          * idea to disable the keyboard that long...
 762          */
 763         if (!doinitialize(sc, &sc->mode) || !enable_aux_dev(sc->kbdc)) {
 764             recover_from_error(sc->kbdc);
 765 #else
 766         {
 767 #endif
 768             restore_controller(sc->kbdc, command_byte);
 769             /* mark this device is no longer available */
 770             sc->state &= ~PSM_VALID;
 771             log(LOG_ERR, "psm%d: failed to enable the device (doopen).\n",
 772                 sc->unit);
 773             return (EIO);
 774         }
 775     }
 776
 777     if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
 778         log(LOG_DEBUG, "psm%d: failed to get status (doopen).\n", sc->unit);
 779
 780     /* enable the aux port and interrupt */
 781     if (!set_controller_command_byte(sc->kbdc,
 782             kbdc_get_device_mask(sc->kbdc),
 783             (command_byte & KBD_KBD_CONTROL_BITS)
 784                 | KBD_ENABLE_AUX_PORT | KBD_ENABLE_AUX_INT)) {
 785         /* CONTROLLER ERROR */
 786         disable_aux_dev(sc->kbdc);
 787         restore_controller(sc->kbdc, command_byte);
 788         log(LOG_ERR, "psm%d: failed to enable the aux interrupt (doopen).\n",
 789             sc->unit);
 790         return (EIO);
 791     }
 792
 793     /* start the watchdog timer */
 794     sc->watchdog = FALSE;
 795     sc->callout = timeout(psmtimeout, (void *)(uintptr_t)sc, hz*2);
 796
 797     return (0);
 798 }
 799
 800 static int
 801 reinitialize(struct psm_softc *sc, int doinit)
 802 {
 803     int err;
 804     int c;
 805     int s;
 806
 807     /* don't let anybody mess with the aux device */
 808     if (!kbdc_lock(sc->kbdc, TRUE))
 809         return (EIO);
 810     s = spltty();
 811
 812     /* block our watchdog timer */
 813     sc->watchdog = FALSE;
 814     untimeout(psmtimeout, (void *)(uintptr_t)sc, sc->callout);
 815     callout_handle_init(&sc->callout);
 816
 817     /* save the current controller command byte */
 818     empty_both_buffers(sc->kbdc, 10);
 819     c = get_controller_command_byte(sc->kbdc);
 820     if (verbose >= 2)
 821         log(LOG_DEBUG, "psm%d: current command byte: %04x (reinitialize).\n",
 822             sc->unit, c);
 823
 824     /* enable the aux port but disable the aux interrupt and the keyboard */
 825     if ((c == -1) || !set_controller_command_byte(sc->kbdc,
 826             kbdc_get_device_mask(sc->kbdc),
 827             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
 828                 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
 829         /* CONTROLLER ERROR */
 830         splx(s);
 831         kbdc_lock(sc->kbdc, FALSE);
 832         log(LOG_ERR, "psm%d: unable to set the command byte (reinitialize).\n",
 833             sc->unit);
 834         return (EIO);
 835     }
 836
 837     /* flush any data */
 838     if (sc->state & PSM_VALID) {
 839         disable_aux_dev(sc->kbdc);      /* this may fail; but never mind... */
 840         empty_aux_buffer(sc->kbdc, 10);
 841     }
 842     flushpackets(sc);
 843     sc->syncerrors = 0;
 844
 845     /* try to detect the aux device; are you still there? */
 846     err = 0;
 847     if (doinit) {
 848         if (doinitialize(sc, &sc->mode)) {
 849             /* yes */
 850             sc->state |= PSM_VALID;
 851         } else {
 852             /* the device has gone! */
 853             restore_controller(sc->kbdc, c);
 854             sc->state &= ~PSM_VALID;
 855             log(LOG_ERR, "psm%d: the aux device has gone! (reinitialize).\n",
 856                 sc->unit);
 857             err = ENXIO;
 858         }
 859     }
 860     splx(s);
 861
 862     /* restore the driver state */
 863     if ((sc->state & PSM_OPEN) && (err == 0)) {
 864         /* enable the aux device and the port again */
 865         err = doopen(sc, c);
 866         if (err != 0)
 867             log(LOG_ERR, "psm%d: failed to enable the device (reinitialize).\n",
 868                 sc->unit);
 869     } else {
 870         /* restore the keyboard port and disable the aux port */
 871         if (!set_controller_command_byte(sc->kbdc,
 872                 kbdc_get_device_mask(sc->kbdc),
 873                 (c & KBD_KBD_CONTROL_BITS)
 874                     | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
 875             /* CONTROLLER ERROR */
 876             log(LOG_ERR, "psm%d: failed to disable the aux port (reinitialize).\n",
 877                 sc->unit);
 878             err = EIO;
 879         }
 880     }
 881
 882     kbdc_lock(sc->kbdc, FALSE);
 883     return (err);
 884 }
 885
 886 /* psm driver entry points */
 887
 888 static void
 889 psmidentify(driver_t *driver, device_t parent)
 890 {
 891     device_t psmc;
 892     device_t psm;
 893     u_long irq;
 894     int unit;
 895
 896     unit = device_get_unit(parent);
 897
 898     /* always add at least one child */
 899     psm = BUS_ADD_CHILD(parent, KBDC_RID_AUX, driver->name, unit);
 900     if (psm == NULL)
 901         return;
 902
 903     irq = bus_get_resource_start(psm, SYS_RES_IRQ, KBDC_RID_AUX);
 904     if (irq > 0)
 905         return;
 906
 907     /*
 908      * If the PS/2 mouse device has already been reported by ACPI or
 909      * PnP BIOS, obtain the IRQ resource from it.
 910      * (See psmcpnp_attach() below.)
 911      */
 912     psmc = device_find_child(device_get_parent(parent),
 913                              PSMCPNP_DRIVER_NAME, unit);
 914     if (psmc == NULL)
 915         return;
 916     irq = bus_get_resource_start(psmc, SYS_RES_IRQ, 0);
 917     if (irq <= 0)
 918         return;
 919     bus_set_resource(psm, SYS_RES_IRQ, KBDC_RID_AUX, irq, 1);
 920 }
 921
 922 #define endprobe(v)     do {   if (bootverbose)                         \
 923                                 --verbose;                              \
 924                             kbdc_set_device_mask(sc->kbdc, mask);       \
 925                             kbdc_lock(sc->kbdc, FALSE);                 \
 926                             return (v);                                 \
 927                         } while (0)
 928
 929 static int
 930 psmprobe(device_t dev)
 931 {
 932     int unit = device_get_unit(dev);
 933     struct psm_softc *sc = device_get_softc(dev);
 934     int stat[3];
 935     int command_byte;
 936     int mask;
 937     int rid;
 938     int i;
 939
 940 #if 0
 941     kbdc_debug(TRUE);
 942 #endif
 943
 944     /* see if IRQ is available */
 945     rid = KBDC_RID_AUX;
 946     sc->intr = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 0, ~0, 1,
 947                                   RF_SHAREABLE | RF_ACTIVE);
 948     if (sc->intr == NULL) {
 949         if (bootverbose)
 950             device_printf(dev, "unable to allocate IRQ\n");
 951         return (ENXIO);
 952     }
 953     bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
 954
 955     sc->unit = unit;
 956     sc->kbdc = atkbdc_open(device_get_unit(device_get_parent(dev)));
 957     sc->config = device_get_flags(dev) & PSM_CONFIG_FLAGS;
 958     /* XXX: for backward compatibility */
 959 #if defined(PSM_HOOKRESUME) || defined(PSM_HOOKAPM)
 960     sc->config |=
 961 #ifdef PSM_RESETAFTERSUSPEND
 962         PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND;
 963 #else
 964         PSM_CONFIG_HOOKRESUME;
 965 #endif
 966 #endif /* PSM_HOOKRESUME | PSM_HOOKAPM */
 967     sc->flags = 0;
 968     if (bootverbose)
 969         ++verbose;
 970
 971     device_set_desc(dev, "PS/2 Mouse");
 972
 973     if (!kbdc_lock(sc->kbdc, TRUE)) {
 974         printf("psm%d: unable to lock the controller.\n", unit);
 975         if (bootverbose)
 976             --verbose;
 977         return (ENXIO);
 978     }
 979
 980     /*
 981      * NOTE: two bits in the command byte controls the operation of the
 982      * aux port (mouse port): the aux port disable bit (bit 5) and the aux
 983      * port interrupt (IRQ 12) enable bit (bit 2).
 984      */
 985
 986     /* discard anything left after the keyboard initialization */
 987     empty_both_buffers(sc->kbdc, 10);
 988
 989     /* save the current command byte; it will be used later */
 990     mask = kbdc_get_device_mask(sc->kbdc) & ~KBD_AUX_CONTROL_BITS;
 991     command_byte = get_controller_command_byte(sc->kbdc);
 992     if (verbose)
 993         printf("psm%d: current command byte:%04x\n", unit, command_byte);
 994     if (command_byte == -1) {
 995         /* CONTROLLER ERROR */
 996         printf("psm%d: unable to get the current command byte value.\n",
 997             unit);
 998         endprobe(ENXIO);
 999     }
1000
1001     /*
1002      * disable the keyboard port while probing the aux port, which must be
1003      * enabled during this routine
1004      */
1005     if (!set_controller_command_byte(sc->kbdc,
1006             KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
1007             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1008                 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1009         /*
1010          * this is CONTROLLER ERROR; I don't know how to recover
1011          * from this error...
1012          */
1013         restore_controller(sc->kbdc, command_byte);
1014         printf("psm%d: unable to set the command byte.\n", unit);
1015         endprobe(ENXIO);
1016     }
1017     write_controller_command(sc->kbdc, KBDC_ENABLE_AUX_PORT);
1018
1019     /*
1020      * NOTE: `test_aux_port()' is designed to return with zero if the aux
1021      * port exists and is functioning. However, some controllers appears
1022      * to respond with zero even when the aux port doesn't exist. (It may
1023      * be that this is only the case when the controller DOES have the aux
1024      * port but the port is not wired on the motherboard.) The keyboard
1025      * controllers without the port, such as the original AT, are
1026      * supporsed to return with an error code or simply time out. In any
1027      * case, we have to continue probing the port even when the controller
1028      * passes this test.
1029      *
1030      * XXX: some controllers erroneously return the error code 1 when
1031      * it has the perfectly functional aux port. We have to ignore this
1032      * error code. Even if the controller HAS error with the aux port,
1033      * it will be detected later...
1034      * XXX: another incompatible controller returns PSM_ACK (0xfa)...
1035      */
1036     switch ((i = test_aux_port(sc->kbdc))) {
1037     case 1:        /* ignore this error */
1038     case PSM_ACK:
1039         if (verbose)
1040             printf("psm%d: strange result for test aux port (%d).\n",
1041                 unit, i);
1042         /* FALLTHROUGH */
1043     case 0:        /* no error */
1044         break;
1045     case -1:        /* time out */
1046     default:        /* error */
1047         recover_from_error(sc->kbdc);
1048         if (sc->config & PSM_CONFIG_IGNPORTERROR)
1049             break;
1050         restore_controller(sc->kbdc, command_byte);
1051         if (verbose)
1052             printf("psm%d: the aux port is not functioning (%d).\n",
1053                 unit, i);
1054         endprobe(ENXIO);
1055     }
1056
1057     if (sc->config & PSM_CONFIG_NORESET) {
1058         /*
1059          * Don't try to reset the pointing device.  It may possibly be
1060          * left in the unknown state, though...
1061          */
1062     } else {
1063         /*
1064          * NOTE: some controllers appears to hang the `keyboard' when the aux
1065          * port doesn't exist and `PSMC_RESET_DEV' is issued.
1066          *
1067          * Attempt to reset the controller twice -- this helps
1068          * pierce through some KVM switches. The second reset
1069          * is non-fatal.
1070          */
1071         if (!reset_aux_dev(sc->kbdc)) {
1072             recover_from_error(sc->kbdc);
1073             restore_controller(sc->kbdc, command_byte);
1074             if (verbose)
1075                 printf("psm%d: failed to reset the aux device.\n", unit);
1076             endprobe(ENXIO);
1077         } else if (!reset_aux_dev(sc->kbdc)) {
1078             recover_from_error(sc->kbdc);
1079             if (verbose >= 2)
1080                 printf("psm%d: failed to reset the aux device (2).\n",
1081                     unit);
1082         }
1083     }
1084
1085     /*
1086      * both the aux port and the aux device is functioning, see if the
1087      * device can be enabled. NOTE: when enabled, the device will start
1088      * sending data; we shall immediately disable the device once we know
1089      * the device can be enabled.
1090      */
1091     if (!enable_aux_dev(sc->kbdc) || !disable_aux_dev(sc->kbdc)) {
1092         /* MOUSE ERROR */
1093         recover_from_error(sc->kbdc);
1094         restore_controller(sc->kbdc, command_byte);
1095         if (verbose)
1096             printf("psm%d: failed to enable the aux device.\n", unit);
1097         endprobe(ENXIO);
1098     }
1099
1100     /* save the default values after reset */
1101     if (get_mouse_status(sc->kbdc, stat, 0, 3) >= 3) {
1102         sc->dflt_mode.rate = sc->mode.rate = stat[2];
1103         sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1104     } else {
1105         sc->dflt_mode.rate = sc->mode.rate = -1;
1106         sc->dflt_mode.resolution = sc->mode.resolution = -1;
1107     }
1108
1109     /* hardware information */
1110     sc->hw.iftype = MOUSE_IF_PS2;
1111
1112     /* verify the device is a mouse */
1113     sc->hw.hwid = get_aux_id(sc->kbdc);
1114     if (!is_a_mouse(sc->hw.hwid)) {
1115         restore_controller(sc->kbdc, command_byte);
1116         if (verbose)
1117             printf("psm%d: unknown device type (%d).\n", unit, sc->hw.hwid);
1118         endprobe(ENXIO);
1119     }
1120     switch (sc->hw.hwid) {
1121     case PSM_BALLPOINT_ID:
1122         sc->hw.type = MOUSE_TRACKBALL;
1123         break;
1124     case PSM_MOUSE_ID:
1125     case PSM_INTELLI_ID:
1126     case PSM_EXPLORER_ID:
1127     case PSM_4DMOUSE_ID:
1128     case PSM_4DPLUS_ID:
1129         sc->hw.type = MOUSE_MOUSE;
1130         break;
1131     default:
1132         sc->hw.type = MOUSE_UNKNOWN;
1133         break;
1134     }
1135
1136     if (sc->config & PSM_CONFIG_NOIDPROBE) {
1137         sc->hw.buttons = 2;
1138         i = GENERIC_MOUSE_ENTRY;
1139     } else {
1140         /* # of buttons */
1141         sc->hw.buttons = get_mouse_buttons(sc->kbdc);
1142
1143         /* other parameters */
1144         for (i = 0; vendortype[i].probefunc != NULL; ++i) {
1145             if ((*vendortype[i].probefunc)(sc)) {
1146                 if (verbose >= 2)
1147                     printf("psm%d: found %s\n",
1148                            unit, model_name(vendortype[i].model));
1149                 break;
1150             }
1151         }
1152     }
1153
1154     sc->hw.model = vendortype[i].model;
1155
1156     sc->dflt_mode.level = PSM_LEVEL_BASE;
1157     sc->dflt_mode.packetsize = MOUSE_PS2_PACKETSIZE;
1158     sc->dflt_mode.accelfactor = (sc->config & PSM_CONFIG_ACCEL) >> 4;
1159     if (sc->config & PSM_CONFIG_NOCHECKSYNC)
1160         sc->dflt_mode.syncmask[0] = 0;
1161     else
1162         sc->dflt_mode.syncmask[0] = vendortype[i].syncmask;
1163     if (sc->config & PSM_CONFIG_FORCETAP)
1164         sc->mode.syncmask[0] &= ~MOUSE_PS2_TAP;
1165     sc->dflt_mode.syncmask[1] = 0;      /* syncbits */
1166     sc->mode = sc->dflt_mode;
1167     sc->mode.packetsize = vendortype[i].packetsize;
1168
1169     /* set mouse parameters */
1170 #if 0
1171     /*
1172      * A version of Logitech FirstMouse+ won't report wheel movement,
1173      * if SET_DEFAULTS is sent...  Don't use this command.
1174      * This fix was found by Takashi Nishida.
1175      */
1176     i = send_aux_command(sc->kbdc, PSMC_SET_DEFAULTS);
1177     if (verbose >= 2)
1178         printf("psm%d: SET_DEFAULTS return code:%04x\n", unit, i);
1179 #endif
1180     if (sc->config & PSM_CONFIG_RESOLUTION) {
1181         sc->mode.resolution
1182             = set_mouse_resolution(sc->kbdc,
1183                                    (sc->config & PSM_CONFIG_RESOLUTION) - 1);
1184     } else if (sc->mode.resolution >= 0) {
1185         sc->mode.resolution
1186             = set_mouse_resolution(sc->kbdc, sc->dflt_mode.resolution);
1187     }
1188     if (sc->mode.rate > 0) {
1189         sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, sc->dflt_mode.rate);
1190     }
1191     set_mouse_scaling(sc->kbdc, 1);
1192
1193     /* request a data packet and extract sync. bits */
1194     if (get_mouse_status(sc->kbdc, stat, 1, 3) < 3) {
1195         printf("psm%d: failed to get data.\n", unit);
1196         sc->mode.syncmask[0] = 0;
1197     } else {
1198         sc->mode.syncmask[1] = stat[0] & sc->mode.syncmask[0];  /* syncbits */
1199         /* the NetScroll Mouse will send three more bytes... Ignore them */
1200         empty_aux_buffer(sc->kbdc, 5);
1201     }
1202
1203     /* just check the status of the mouse */
1204     /*
1205      * NOTE: XXX there are some arcane controller/mouse combinations out
1206      * there, which hung the controller unless there is data transmission
1207      * after ACK from the mouse.
1208      */
1209     if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3) {
1210         printf("psm%d: failed to get status.\n", unit);
1211     } else {
1212         /*
1213          * When in its native mode, some mice operate with different
1214          * default parameters than in the PS/2 compatible mode.
1215          */
1216         sc->dflt_mode.rate = sc->mode.rate = stat[2];
1217         sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1218      }
1219
1220     /* disable the aux port for now... */
1221     if (!set_controller_command_byte(sc->kbdc,
1222             KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
1223             (command_byte & KBD_KBD_CONTROL_BITS)
1224                 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1225         /*
1226          * this is CONTROLLER ERROR; I don't know the proper way to
1227          * recover from this error...
1228          */
1229         restore_controller(sc->kbdc, command_byte);
1230         printf("psm%d: unable to set the command byte.\n", unit);
1231         endprobe(ENXIO);
1232     }
1233
1234     /* done */
1235     kbdc_set_device_mask(sc->kbdc, mask | KBD_AUX_CONTROL_BITS);
1236     kbdc_lock(sc->kbdc, FALSE);
1237     return (0);
1238 }
1239
1240 static int
1241 psmattach(device_t dev)
1242 {
1243     int unit = device_get_unit(dev);
1244     struct psm_softc *sc = device_get_softc(dev);
1245     int error;
1246     int rid;
1247
1248     if (sc == NULL)    /* shouldn't happen */
1249         return (ENXIO);
1250
1251     /* Setup initial state */
1252     sc->state = PSM_VALID;
1253     callout_handle_init(&sc->callout);
1254
1255     /* Setup our interrupt handler */
1256     rid = KBDC_RID_AUX;
1257     sc->intr = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 0, ~0, 1,
1258                                   RF_SHAREABLE | RF_ACTIVE);
1259     if (sc->intr == NULL)
1260         return (ENXIO);
1261     error = bus_setup_intr(dev, sc->intr, INTR_TYPE_TTY, psmintr, sc, &sc->ih);
1262     if (error) {
1263         bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1264         return (error);
1265     }
1266
1267     /* Done */
1268     sc->dev = make_dev(&psm_cdevsw, PSM_MKMINOR(unit, FALSE), 0, 0, 0666,
1269                        "psm%d", unit);
1270     sc->bdev = make_dev(&psm_cdevsw, PSM_MKMINOR(unit, TRUE), 0, 0, 0666,
1271                         "bpsm%d", unit);
1272
1273     if (!verbose) {
1274         printf("psm%d: model %s, device ID %d\n",
1275             unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff);
1276     } else {
1277         printf("psm%d: model %s, device ID %d-%02x, %d buttons\n",
1278             unit, model_name(sc->hw.model),
1279             sc->hw.hwid & 0x00ff, sc->hw.hwid >> 8, sc->hw.buttons);
1280         printf("psm%d: config:%08x, flags:%08x, packet size:%d\n",
1281             unit, sc->config, sc->flags, sc->mode.packetsize);
1282         printf("psm%d: syncmask:%02x, syncbits:%02x\n",
1283             unit, sc->mode.syncmask[0], sc->mode.syncmask[1]);
1284     }
1285
1286     if (bootverbose)
1287         --verbose;
1288
1289     return (0);
1290 }
1291
1292 static int
1293 psmdetach(device_t dev)
1294 {
1295     struct psm_softc *sc;
1296     int rid;
1297
1298     sc = device_get_softc(dev);
1299     if (sc->state & PSM_OPEN)
1300         return EBUSY;
1301
1302     rid = KBDC_RID_AUX;
1303     bus_teardown_intr(dev, sc->intr, sc->ih);
1304     bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1305
1306     destroy_dev(sc->dev);
1307     destroy_dev(sc->bdev);
1308
1309     return 0;
1310 }
1311
1312 static int
1313 psmopen(dev_t dev, int flag, int fmt, struct thread *td)
1314 {
1315     int unit = PSM_UNIT(dev);
1316     struct psm_softc *sc;
1317     int command_byte;
1318     int err;
1319     int s;
1320
1321     /* Get device data */
1322     sc = PSM_SOFTC(unit);
1323     if ((sc == NULL) || (sc->state & PSM_VALID) == 0)
1324         /* the device is no longer valid/functioning */
1325         return (ENXIO);
1326
1327     /* Disallow multiple opens */
1328     if (sc->state & PSM_OPEN)
1329         return (EBUSY);
1330
1331     device_busy(devclass_get_device(psm_devclass, unit));
1332
1333     /* Initialize state */
1334     sc->mode.level = sc->dflt_mode.level;
1335     sc->mode.protocol = sc->dflt_mode.protocol;
1336     sc->watchdog = FALSE;
1337
1338     /* flush the event queue */
1339     sc->queue.count = 0;
1340     sc->queue.head = 0;
1341     sc->queue.tail = 0;
1342     sc->status.flags = 0;
1343     sc->status.button = 0;
1344     sc->status.obutton = 0;
1345     sc->status.dx = 0;
1346     sc->status.dy = 0;
1347     sc->status.dz = 0;
1348     sc->button = 0;
1349     sc->pqueue_start = 0;
1350     sc->pqueue_end = 0;
1351
1352     /* empty input buffer */
1353     flushpackets(sc);
1354     sc->syncerrors = 0;
1355
1356     /* don't let timeout routines in the keyboard driver to poll the kbdc */
1357     if (!kbdc_lock(sc->kbdc, TRUE))
1358         return (EIO);
1359
1360     /* save the current controller command byte */
1361     s = spltty();
1362     command_byte = get_controller_command_byte(sc->kbdc);
1363
1364     /* enable the aux port and temporalily disable the keyboard */
1365     if ((command_byte == -1)
1366         || !set_controller_command_byte(sc->kbdc,
1367             kbdc_get_device_mask(sc->kbdc),
1368             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1369                 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1370         /* CONTROLLER ERROR; do you know how to get out of this? */
1371         kbdc_lock(sc->kbdc, FALSE);
1372         splx(s);
1373         log(LOG_ERR, "psm%d: unable to set the command byte (psmopen).\n",
1374             unit);
1375         return (EIO);
1376     }
1377     /*
1378      * Now that the keyboard controller is told not to generate
1379      * the keyboard and mouse interrupts, call `splx()' to allow
1380      * the other tty interrupts. The clock interrupt may also occur,
1381      * but timeout routines will be blocked by the poll flag set
1382      * via `kbdc_lock()'
1383      */
1384     splx(s);
1385
1386     /* enable the mouse device */
1387     err = doopen(sc, command_byte);
1388
1389     /* done */
1390     if (err == 0)
1391         sc->state |= PSM_OPEN;
1392     kbdc_lock(sc->kbdc, FALSE);
1393     return (err);
1394 }
1395
1396 static int
1397 psmclose(dev_t dev, int flag, int fmt, struct thread *td)
1398 {
1399     int unit = PSM_UNIT(dev);
1400     struct psm_softc *sc = PSM_SOFTC(unit);
1401     int stat[3];
1402     int command_byte;
1403     int s;
1404
1405     /* don't let timeout routines in the keyboard driver to poll the kbdc */
1406     if (!kbdc_lock(sc->kbdc, TRUE))
1407         return (EIO);
1408
1409     /* save the current controller command byte */
1410     s = spltty();
1411     command_byte = get_controller_command_byte(sc->kbdc);
1412     if (command_byte == -1) {
1413         kbdc_lock(sc->kbdc, FALSE);
1414         splx(s);
1415         return (EIO);
1416     }
1417
1418     /* disable the aux interrupt and temporalily disable the keyboard */
1419     if (!set_controller_command_byte(sc->kbdc,
1420             kbdc_get_device_mask(sc->kbdc),
1421             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1422                 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1423         log(LOG_ERR, "psm%d: failed to disable the aux int (psmclose).\n",
1424             unit);
1425         /* CONTROLLER ERROR;
1426          * NOTE: we shall force our way through. Because the only
1427          * ill effect we shall see is that we may not be able
1428          * to read ACK from the mouse, and it doesn't matter much
1429          * so long as the mouse will accept the DISABLE command.
1430          */
1431     }
1432     splx(s);
1433
1434     /* stop the watchdog timer */
1435     untimeout(psmtimeout, (void *)(uintptr_t)sc, sc->callout);
1436     callout_handle_init(&sc->callout);
1437
1438     /* remove anything left in the output buffer */
1439     empty_aux_buffer(sc->kbdc, 10);
1440
1441     /* disable the aux device, port and interrupt */
1442     if (sc->state & PSM_VALID) {
1443         if (!disable_aux_dev(sc->kbdc)) {
1444             /* MOUSE ERROR;
1445              * NOTE: we don't return error and continue, pretending
1446              * we have successfully disabled the device. It's OK because
1447              * the interrupt routine will discard any data from the mouse
1448              * hereafter.
1449              */
1450             log(LOG_ERR, "psm%d: failed to disable the device (psmclose).\n",
1451                 unit);
1452         }
1453
1454         if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
1455             log(LOG_DEBUG, "psm%d: failed to get status (psmclose).\n",
1456                 unit);
1457     }
1458
1459     if (!set_controller_command_byte(sc->kbdc,
1460             kbdc_get_device_mask(sc->kbdc),
1461             (command_byte & KBD_KBD_CONTROL_BITS)
1462                 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1463         /* CONTROLLER ERROR;
1464          * we shall ignore this error; see the above comment.
1465          */
1466         log(LOG_ERR, "psm%d: failed to disable the aux port (psmclose).\n",
1467             unit);
1468     }
1469
1470     /* remove anything left in the output buffer */
1471     empty_aux_buffer(sc->kbdc, 10);
1472
1473     /* close is almost always successful */
1474     sc->state &= ~PSM_OPEN;
1475     kbdc_lock(sc->kbdc, FALSE);
1476     device_unbusy(devclass_get_device(psm_devclass, unit));
1477     return (0);
1478 }
1479
1480 static int
1481 tame_mouse(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *status, unsigned char *buf)
1482 {
1483     static unsigned char butmapps2[8] = {
1484         0,
1485         MOUSE_PS2_BUTTON1DOWN,
1486         MOUSE_PS2_BUTTON2DOWN,
1487         MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN,
1488         MOUSE_PS2_BUTTON3DOWN,
1489         MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON3DOWN,
1490         MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
1491         MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
1492     };
1493     static unsigned char butmapmsc[8] = {
1494         MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
1495         MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
1496         MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON3UP,
1497         MOUSE_MSC_BUTTON3UP,
1498         MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP,
1499         MOUSE_MSC_BUTTON2UP,
1500         MOUSE_MSC_BUTTON1UP,
1501         0,
1502     };
1503     int mapped;
1504     int i;
1505
1506     if (sc->mode.level == PSM_LEVEL_BASE) {
1507         mapped = status->button & ~MOUSE_BUTTON4DOWN;
1508         if (status->button & MOUSE_BUTTON4DOWN)
1509             mapped |= MOUSE_BUTTON1DOWN;
1510         status->button = mapped;
1511         buf[0] = MOUSE_PS2_SYNC | butmapps2[mapped & MOUSE_STDBUTTONS];
1512         i = imax(imin(status->dx, 255), -256);
1513         if (i < 0)
1514             buf[0] |= MOUSE_PS2_XNEG;
1515         buf[1] = i;
1516         i = imax(imin(status->dy, 255), -256);
1517         if (i < 0)
1518             buf[0] |= MOUSE_PS2_YNEG;
1519         buf[2] = i;
1520         return MOUSE_PS2_PACKETSIZE;
1521     } else if (sc->mode.level == PSM_LEVEL_STANDARD) {
1522         buf[0] = MOUSE_MSC_SYNC | butmapmsc[status->button & MOUSE_STDBUTTONS];
1523         i = imax(imin(status->dx, 255), -256);
1524         buf[1] = i >> 1;
1525         buf[3] = i - buf[1];
1526         i = imax(imin(status->dy, 255), -256);
1527         buf[2] = i >> 1;
1528         buf[4] = i - buf[2];
1529         i = imax(imin(status->dz, 127), -128);
1530         buf[5] = (i >> 1) & 0x7f;
1531         buf[6] = (i - (i >> 1)) & 0x7f;
1532         buf[7] = (~status->button >> 3) & 0x7f;
1533         return MOUSE_SYS_PACKETSIZE;
1534     }
1535     return pb->inputbytes;
1536 }
1537
1538 static int
1539 psmread(dev_t dev, struct uio *uio, int flag)
1540 {
1541     register struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
1542     unsigned char buf[PSM_SMALLBUFSIZE];
1543     int error = 0;
1544     int s;
1545     int l;
1546
1547     if ((sc->state & PSM_VALID) == 0)
1548         return EIO;
1549
1550     /* block until mouse activity occured */
1551     s = spltty();
1552     while (sc->queue.count <= 0) {
1553         if (PSM_NBLOCKIO(dev)) {
1554             splx(s);
1555             return EWOULDBLOCK;
1556         }
1557         sc->state |= PSM_ASLP;
1558         error = tsleep( sc, PZERO | PCATCH, "psmrea", 0);
1559         sc->state &= ~PSM_ASLP;
1560         if (error) {
1561             splx(s);
1562             return error;
1563         } else if ((sc->state & PSM_VALID) == 0) {
1564             /* the device disappeared! */
1565             splx(s);
1566             return EIO;
1567         }
1568     }
1569     splx(s);
1570
1571     /* copy data to the user land */
1572     while ((sc->queue.count > 0) && (uio->uio_resid > 0)) {
1573         s = spltty();
1574         l = imin(sc->queue.count, uio->uio_resid);
1575         if (l > sizeof(buf))
1576             l = sizeof(buf);
1577         if (l > sizeof(sc->queue.buf) - sc->queue.head) {
1578             bcopy(&sc->queue.buf[sc->queue.head], &buf[0],
1579                 sizeof(sc->queue.buf) - sc->queue.head);
1580             bcopy(&sc->queue.buf[0],
1581                 &buf[sizeof(sc->queue.buf) - sc->queue.head],
1582                 l - (sizeof(sc->queue.buf) - sc->queue.head));
1583         } else {
1584             bcopy(&sc->queue.buf[sc->queue.head], &buf[0], l);
1585         }
1586         sc->queue.count -= l;
1587         sc->queue.head = (sc->queue.head + l) % sizeof(sc->queue.buf);
1588         splx(s);
1589         error = uiomove(buf, l, uio);
1590         if (error)
1591             break;
1592     }
1593
1594     return error;
1595 }
1596
1597 static int
1598 block_mouse_data(struct psm_softc *sc, int *c)
1599 {
1600     int s;
1601
1602     if (!kbdc_lock(sc->kbdc, TRUE))
1603         return EIO;
1604
1605     s = spltty();
1606     *c = get_controller_command_byte(sc->kbdc);
1607     if ((*c == -1)
1608         || !set_controller_command_byte(sc->kbdc,
1609             kbdc_get_device_mask(sc->kbdc),
1610             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1611                 | KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1612         /* this is CONTROLLER ERROR */
1613         splx(s);
1614         kbdc_lock(sc->kbdc, FALSE);
1615         return EIO;
1616     }
1617
1618     /*
1619      * The device may be in the middle of status data transmission.
1620      * The transmission will be interrupted, thus, incomplete status
1621      * data must be discarded. Although the aux interrupt is disabled
1622      * at the keyboard controller level, at most one aux interrupt
1623      * may have already been pending and a data byte is in the
1624      * output buffer; throw it away. Note that the second argument
1625      * to `empty_aux_buffer()' is zero, so that the call will just
1626      * flush the internal queue.
1627      * `psmintr()' will be invoked after `splx()' if an interrupt is
1628      * pending; it will see no data and returns immediately.
1629      */
1630     empty_aux_buffer(sc->kbdc, 0);      /* flush the queue */
1631     read_aux_data_no_wait(sc->kbdc);    /* throw away data if any */
1632     flushpackets(sc);
1633     splx(s);
1634
1635     return 0;
1636 }
1637
1638 static void
1639 dropqueue(struct psm_softc *sc)
1640 {
1641
1642         sc->queue.count = 0;
1643         sc->queue.head = 0;
1644         sc->queue.tail = 0;
1645         if ((sc->state & PSM_SOFTARMED) != 0) {
1646                 sc->state &= ~PSM_SOFTARMED;
1647                 untimeout(psmsoftintr, (void *)(uintptr_t)sc, sc->softcallout);
1648         }
1649         sc->pqueue_start = sc->pqueue_end;
1650 }
1651
1652 static void
1653 flushpackets(struct psm_softc *sc)
1654 {
1655
1656         dropqueue(sc);
1657         bzero(&sc->pqueue, sizeof(sc->pqueue));
1658 }
1659
1660 static int
1661 unblock_mouse_data(struct psm_softc *sc, int c)
1662 {
1663     int error = 0;
1664
1665     /*
1666      * We may have seen a part of status data during `set_mouse_XXX()'.
1667      * they have been queued; flush it.
1668      */
1669     empty_aux_buffer(sc->kbdc, 0);
1670
1671     /* restore ports and interrupt */
1672     if (!set_controller_command_byte(sc->kbdc,
1673             kbdc_get_device_mask(sc->kbdc),
1674             c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
1675         /* CONTROLLER ERROR; this is serious, we may have
1676          * been left with the inaccessible keyboard and
1677          * the disabled mouse interrupt.
1678          */
1679         error = EIO;
1680     }
1681
1682     kbdc_lock(sc->kbdc, FALSE);
1683     return error;
1684 }
1685
1686 static int
1687 psmioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
1688 {
1689     struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
1690     mousemode_t mode;
1691     mousestatus_t status;
1692 #if (defined(MOUSE_GETVARS))
1693     mousevar_t *var;
1694 #endif
1695     mousedata_t *data;
1696     int stat[3];
1697     int command_byte;
1698     int error = 0;
1699     int s;
1700
1701     /* Perform IOCTL command */
1702     switch (cmd) {
1703
1704     case OLD_MOUSE_GETHWINFO:
1705         s = spltty();
1706         ((old_mousehw_t *)addr)->buttons = sc->hw.buttons;
1707         ((old_mousehw_t *)addr)->iftype = sc->hw.iftype;
1708         ((old_mousehw_t *)addr)->type = sc->hw.type;
1709         ((old_mousehw_t *)addr)->hwid = sc->hw.hwid & 0x00ff;
1710         splx(s);
1711         break;
1712
1713     case MOUSE_GETHWINFO:
1714         s = spltty();
1715         *(mousehw_t *)addr = sc->hw;
1716         if (sc->mode.level == PSM_LEVEL_BASE)
1717             ((mousehw_t *)addr)->model = MOUSE_MODEL_GENERIC;
1718         splx(s);
1719         break;
1720
1721     case OLD_MOUSE_GETMODE:
1722         s = spltty();
1723         switch (sc->mode.level) {
1724         case PSM_LEVEL_BASE:
1725             ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1726             break;
1727         case PSM_LEVEL_STANDARD:
1728             ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
1729             break;
1730         case PSM_LEVEL_NATIVE:
1731             ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1732             break;
1733         }
1734         ((old_mousemode_t *)addr)->rate = sc->mode.rate;
1735         ((old_mousemode_t *)addr)->resolution = sc->mode.resolution;
1736         ((old_mousemode_t *)addr)->accelfactor = sc->mode.accelfactor;
1737         splx(s);
1738         break;
1739
1740     case MOUSE_GETMODE:
1741         s = spltty();
1742         *(mousemode_t *)addr = sc->mode;
1743         ((mousemode_t *)addr)->resolution =
1744             MOUSE_RES_LOW - sc->mode.resolution;
1745         switch (sc->mode.level) {
1746         case PSM_LEVEL_BASE:
1747             ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1748             ((mousemode_t *)addr)->packetsize = MOUSE_PS2_PACKETSIZE;
1749             break;
1750         case PSM_LEVEL_STANDARD:
1751             ((mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
1752             ((mousemode_t *)addr)->packetsize = MOUSE_SYS_PACKETSIZE;
1753             ((mousemode_t *)addr)->syncmask[0] = MOUSE_SYS_SYNCMASK;
1754             ((mousemode_t *)addr)->syncmask[1] = MOUSE_SYS_SYNC;
1755             break;
1756         case PSM_LEVEL_NATIVE:
1757             /* FIXME: this isn't quite correct... XXX */
1758             ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
1759             break;
1760         }
1761         splx(s);
1762         break;
1763
1764     case OLD_MOUSE_SETMODE:
1765     case MOUSE_SETMODE:
1766         if (cmd == OLD_MOUSE_SETMODE) {
1767             mode.rate = ((old_mousemode_t *)addr)->rate;
1768             /*
1769              * resolution  old I/F   new I/F
1770              * default        0         0
1771              * low            1        -2
1772              * medium low     2        -3
1773              * medium high    3        -4
1774              * high           4        -5
1775              */
1776             if (((old_mousemode_t *)addr)->resolution > 0)
1777                 mode.resolution = -((old_mousemode_t *)addr)->resolution - 1;
1778             mode.accelfactor = ((old_mousemode_t *)addr)->accelfactor;
1779             mode.level = -1;
1780         } else {
1781             mode = *(mousemode_t *)addr;
1782         }
1783
1784         /* adjust and validate parameters. */
1785         if (mode.rate > UCHAR_MAX)
1786             return EINVAL;
1787         if (mode.rate == 0)
1788             mode.rate = sc->dflt_mode.rate;
1789         else if (mode.rate == -1)
1790             /* don't change the current setting */
1791             ;
1792         else if (mode.rate < 0)
1793             return EINVAL;
1794         if (mode.resolution >= UCHAR_MAX)
1795             return EINVAL;
1796         if (mode.resolution >= 200)
1797             mode.resolution = MOUSE_RES_HIGH;
1798         else if (mode.resolution >= 100)
1799             mode.resolution = MOUSE_RES_MEDIUMHIGH;
1800         else if (mode.resolution >= 50)
1801             mode.resolution = MOUSE_RES_MEDIUMLOW;
1802         else if (mode.resolution > 0)
1803             mode.resolution = MOUSE_RES_LOW;
1804         if (mode.resolution == MOUSE_RES_DEFAULT)
1805             mode.resolution = sc->dflt_mode.resolution;
1806         else if (mode.resolution == -1)
1807             /* don't change the current setting */
1808             ;
1809         else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
1810             mode.resolution = MOUSE_RES_LOW - mode.resolution;
1811         if (mode.level == -1)
1812             /* don't change the current setting */
1813             mode.level = sc->mode.level;
1814         else if ((mode.level < PSM_LEVEL_MIN) || (mode.level > PSM_LEVEL_MAX))
1815             return EINVAL;
1816         if (mode.accelfactor == -1)
1817             /* don't change the current setting */
1818             mode.accelfactor = sc->mode.accelfactor;
1819         else if (mode.accelfactor < 0)
1820             return EINVAL;
1821
1822         /* don't allow anybody to poll the keyboard controller */
1823         error = block_mouse_data(sc, &command_byte);
1824         if (error)
1825             return error;
1826
1827         /* set mouse parameters */
1828         if (mode.rate > 0)
1829             mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
1830         if (mode.resolution >= 0)
1831             mode.resolution = set_mouse_resolution(sc->kbdc, mode.resolution);
1832         set_mouse_scaling(sc->kbdc, 1);
1833         get_mouse_status(sc->kbdc, stat, 0, 3);
1834
1835         s = spltty();
1836         sc->mode.rate = mode.rate;
1837         sc->mode.resolution = mode.resolution;
1838         sc->mode.accelfactor = mode.accelfactor;
1839         sc->mode.level = mode.level;
1840         splx(s);
1841
1842         unblock_mouse_data(sc, command_byte);
1843         break;
1844
1845     case MOUSE_GETLEVEL:
1846         *(int *)addr = sc->mode.level;
1847         break;
1848
1849     case MOUSE_SETLEVEL:
1850         if ((*(int *)addr < PSM_LEVEL_MIN) || (*(int *)addr > PSM_LEVEL_MAX))
1851             return EINVAL;
1852         sc->mode.level = *(int *)addr;
1853         break;
1854
1855     case MOUSE_GETSTATUS:
1856         s = spltty();
1857         status = sc->status;
1858         sc->status.flags = 0;
1859         sc->status.obutton = sc->status.button;
1860         sc->status.button = 0;
1861         sc->status.dx = 0;
1862         sc->status.dy = 0;
1863         sc->status.dz = 0;
1864         splx(s);
1865         *(mousestatus_t *)addr = status;
1866         break;
1867
1868 #if (defined(MOUSE_GETVARS))
1869     case MOUSE_GETVARS:
1870         var = (mousevar_t *)addr;
1871         bzero(var, sizeof(*var));
1872         s = spltty();
1873         var->var[0] = MOUSE_VARS_PS2_SIG;
1874         var->var[1] = sc->config;
1875         var->var[2] = sc->flags;
1876         splx(s);
1877         break;
1878
1879     case MOUSE_SETVARS:
1880         return ENODEV;
1881 #endif /* MOUSE_GETVARS */
1882
1883     case MOUSE_READSTATE:
1884     case MOUSE_READDATA:
1885         data = (mousedata_t *)addr;
1886         if (data->len > sizeof(data->buf)/sizeof(data->buf[0]))
1887             return EINVAL;
1888
1889         error = block_mouse_data(sc, &command_byte);
1890         if (error)
1891             return error;
1892         if ((data->len = get_mouse_status(sc->kbdc, data->buf,
1893                 (cmd == MOUSE_READDATA) ? 1 : 0, data->len)) <= 0)
1894             error = EIO;
1895         unblock_mouse_data(sc, command_byte);
1896         break;
1897
1898 #if (defined(MOUSE_SETRESOLUTION))
1899     case MOUSE_SETRESOLUTION:
1900         mode.resolution = *(int *)addr;
1901         if (mode.resolution >= UCHAR_MAX)
1902             return EINVAL;
1903         else if (mode.resolution >= 200)
1904             mode.resolution = MOUSE_RES_HIGH;
1905         else if (mode.resolution >= 100)
1906             mode.resolution = MOUSE_RES_MEDIUMHIGH;
1907         else if (mode.resolution >= 50)
1908             mode.resolution = MOUSE_RES_MEDIUMLOW;
1909         else if (mode.resolution > 0)
1910             mode.resolution = MOUSE_RES_LOW;
1911         if (mode.resolution == MOUSE_RES_DEFAULT)
1912             mode.resolution = sc->dflt_mode.resolution;
1913         else if (mode.resolution == -1)
1914             mode.resolution = sc->mode.resolution;
1915         else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
1916             mode.resolution = MOUSE_RES_LOW - mode.resolution;
1917
1918         error = block_mouse_data(sc, &command_byte);
1919         if (error)
1920             return error;
1921         sc->mode.resolution = set_mouse_resolution(sc->kbdc, mode.resolution);
1922         if (sc->mode.resolution != mode.resolution)
1923             error = EIO;
1924         unblock_mouse_data(sc, command_byte);
1925         break;
1926 #endif /* MOUSE_SETRESOLUTION */
1927
1928 #if (defined(MOUSE_SETRATE))
1929     case MOUSE_SETRATE:
1930         mode.rate = *(int *)addr;
1931         if (mode.rate > UCHAR_MAX)
1932             return EINVAL;
1933         if (mode.rate == 0)
1934             mode.rate = sc->dflt_mode.rate;
1935         else if (mode.rate < 0)
1936             mode.rate = sc->mode.rate;
1937
1938         error = block_mouse_data(sc, &command_byte);
1939         if (error)
1940             return error;
1941         sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
1942         if (sc->mode.rate != mode.rate)
1943             error = EIO;
1944         unblock_mouse_data(sc, command_byte);
1945         break;
1946 #endif /* MOUSE_SETRATE */
1947
1948 #if (defined(MOUSE_SETSCALING))
1949     case MOUSE_SETSCALING:
1950         if ((*(int *)addr <= 0) || (*(int *)addr > 2))
1951             return EINVAL;
1952
1953         error = block_mouse_data(sc, &command_byte);
1954         if (error)
1955             return error;
1956         if (!set_mouse_scaling(sc->kbdc, *(int *)addr))
1957             error = EIO;
1958         unblock_mouse_data(sc, command_byte);
1959         break;
1960 #endif /* MOUSE_SETSCALING */
1961
1962 #if (defined(MOUSE_GETHWID))
1963     case MOUSE_GETHWID:
1964         error = block_mouse_data(sc, &command_byte);
1965         if (error)
1966             return error;
1967         sc->hw.hwid &= ~0x00ff;
1968         sc->hw.hwid |= get_aux_id(sc->kbdc);
1969         *(int *)addr = sc->hw.hwid & 0x00ff;
1970         unblock_mouse_data(sc, command_byte);
1971         break;
1972 #endif /* MOUSE_GETHWID */
1973
1974     default:
1975         return ENOTTY;
1976     }
1977
1978     return error;
1979 }
1980
1981 static void
1982 psmtimeout(void *arg)
1983 {
1984     struct psm_softc *sc;
1985     int s;
1986
1987     sc = (struct psm_softc *)arg;
1988     s = spltty();
1989     if (sc->watchdog && kbdc_lock(sc->kbdc, TRUE)) {
1990         if (verbose >= 4)
1991             log(LOG_DEBUG, "psm%d: lost interrupt?\n", sc->unit);
1992         psmintr(sc);
1993         kbdc_lock(sc->kbdc, FALSE);
1994     }
1995     sc->watchdog = TRUE;
1996     splx(s);
1997     sc->callout = timeout(psmtimeout, (void *)(uintptr_t)sc, hz);
1998 }
1999
2000 static int psmhz = 20;
2001 SYSCTL_INT(_debug, OID_AUTO, psmhz, CTLFLAG_RW, &psmhz, 0, "");
2002
2003 static int psm_soft_timeout = 500000; /* 0.5 sec */
2004 SYSCTL_INT(_debug, OID_AUTO, psm_soft_timeout, CTLFLAG_RW,
2005     &psm_soft_timeout, 0, "");
2006
2007 static int psmerrsecs = 2;
2008 SYSCTL_INT(_debug, OID_AUTO, psmerrsecs, CTLFLAG_RW, &psmerrsecs, 0, "");
2009 static int psmerrusecs = 0;
2010 SYSCTL_INT(_debug, OID_AUTO, psmerrusecs, CTLFLAG_RW, &psmerrusecs, 0, "");
2011 static int psmsecs = 0;
2012 SYSCTL_INT(_debug, OID_AUTO, psmsecs, CTLFLAG_RW, &psmsecs, 0, "");
2013 static int psmusecs = 500000;
2014 SYSCTL_INT(_debug, OID_AUTO, psmusecs, CTLFLAG_RW, &psmusecs, 0, "");
2015
2016 static void
2017 psmintr(void *arg)
2018 {
2019     struct psm_softc *sc = arg;
2020     struct timeval now;
2021     int c;
2022     packetbuf_t *pb;
2023     int haderror = 0;
2024
2025
2026     /* read until there is nothing to read */
2027     while((c = read_aux_data_no_wait(sc->kbdc)) != -1) {
2028
2029         pb = &sc->pqueue[sc->pqueue_end];
2030         /* discard the byte if the device is not open */
2031         if ((sc->state & PSM_OPEN) == 0)
2032             continue;
2033
2034         getmicrouptime(&now);
2035         if ((pb->inputbytes > 0) && timevalcmp(&now, &sc->inputtimeout, >)) {
2036             log(LOG_DEBUG, "psmintr: delay too long; resetting byte count\n");
2037             pb->inputbytes = 0;
2038             sc->syncerrors = 0;
2039         }
2040         sc->inputtimeout.tv_sec = PSM_INPUT_TIMEOUT/1000000;
2041         sc->inputtimeout.tv_usec = PSM_INPUT_TIMEOUT%1000000;
2042         timevaladd(&sc->inputtimeout, &now);
2043
2044         pb->ipacket[pb->inputbytes++] = c;
2045         if (pb->inputbytes < sc->mode.packetsize)
2046             continue;
2047
2048 #if 0
2049         log(LOG_DEBUG, "psmintr: %02x %02x %02x %02x %02x %02x\n",
2050             pb->ipacket[0], pb->ipacket[1], pb->ipacket[2],
2051             pb->ipacket[3], pb->ipacket[4], pb->ipacket[5]);
2052 #endif
2053
2054         c = pb->ipacket[0];
2055
2056         if ((c & sc->mode.syncmask[0]) != sc->mode.syncmask[1]) {
2057             log(LOG_DEBUG, "psmintr: out of sync (%04x != %04x) %d"
2058                 " cmds since last error.\n",
2059                 c & sc->mode.syncmask[0], sc->mode.syncmask[1],
2060                 sc->cmdcount - sc->lasterr);
2061             haderror = 1;
2062             sc->lasterr = sc->cmdcount;
2063             dropqueue(sc);
2064             ++sc->syncerrors;
2065             sc->lastinputerr = now;
2066             if (sc->syncerrors < sc->mode.packetsize) {
2067                 log(LOG_DEBUG, "psmintr: discard a byte (%d).\n", sc->syncerrors);
2068                 --pb->inputbytes;
2069                 bcopy(&pb->ipacket[1], &pb->ipacket[0], pb->inputbytes);
2070             } else if (sc->syncerrors == sc->mode.packetsize) {
2071                 log(LOG_DEBUG, "psmintr: re-enable the mouse.\n");
2072                 pb->inputbytes = 0;
2073                 disable_aux_dev(sc->kbdc);
2074                 enable_aux_dev(sc->kbdc);
2075             } else if (sc->syncerrors < PSM_SYNCERR_THRESHOLD1) {
2076                 log(LOG_DEBUG, "psmintr: discard a byte (%d).\n", sc->syncerrors);
2077                 --pb->inputbytes;
2078                 bcopy(&pb->ipacket[1], &pb->ipacket[0], pb->inputbytes);
2079             } else if (sc->syncerrors >= PSM_SYNCERR_THRESHOLD1) {
2080                 log(LOG_DEBUG, "psmintr: reset the mouse.\n");
2081                 reinitialize(sc, TRUE);
2082             }
2083             continue;
2084         }
2085         /* if this packet is at all bogus then drop the packet. */
2086         if (haderror ||
2087             !timeelapsed(&sc->lastinputerr, psmerrsecs, psmerrusecs, &now)) {
2088                 pb->inputbytes = 0;
2089                 haderror = 0;
2090                 continue;
2091         }
2092
2093         sc->cmdcount++;
2094         if (++sc->pqueue_end >= PSM_PACKETQUEUE)
2095                 sc->pqueue_end = 0;
2096         /*
2097          * If we've filled the queue then call the softintr ourselves,
2098          * otherwise schedule the interrupt for later.
2099          */
2100         if (!timeelapsed(&sc->lastsoftintr, psmsecs, psmusecs, &now) ||
2101             (sc->pqueue_end == sc->pqueue_start)) {
2102                 if ((sc->state & PSM_SOFTARMED) != 0) {
2103                         sc->state &= ~PSM_SOFTARMED;
2104                         untimeout(psmsoftintr, arg, sc->softcallout);
2105                 }
2106                 psmsoftintr(arg);
2107         } else if ((sc->state & PSM_SOFTARMED) == 0) {
2108                 sc->state |= PSM_SOFTARMED;
2109                 sc->softcallout = timeout(psmsoftintr, arg,
2110                     psmhz < 1 ? 1 : (hz/psmhz));
2111         }
2112     }
2113 }
2114
2115 static void
2116 psmsoftintr(void *arg)
2117 {
2118     /*
2119      * the table to turn PS/2 mouse button bits (MOUSE_PS2_BUTTON?DOWN)
2120      * into `mousestatus' button bits (MOUSE_BUTTON?DOWN).
2121      */
2122     static int butmap[8] = {
2123         0,
2124         MOUSE_BUTTON1DOWN,
2125         MOUSE_BUTTON3DOWN,
2126         MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
2127         MOUSE_BUTTON2DOWN,
2128         MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN,
2129         MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN,
2130         MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN
2131     };
2132     static int butmap_versapad[8] = {
2133         0,
2134         MOUSE_BUTTON3DOWN,
2135         0,
2136         MOUSE_BUTTON3DOWN,
2137         MOUSE_BUTTON1DOWN,
2138         MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
2139         MOUSE_BUTTON1DOWN,
2140         MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN
2141     };
2142     register struct psm_softc *sc = arg;
2143     mousestatus_t ms;
2144     int x, y, z;
2145     int c;
2146     int l;
2147     int x0, y0;
2148     int s;
2149     packetbuf_t *pb;
2150
2151     getmicrouptime(&sc->lastsoftintr);
2152
2153     s = spltty();
2154
2155     do {
2156
2157         pb = &sc->pqueue[sc->pqueue_start];
2158         c = pb->ipacket[0];
2159         /*
2160          * A kludge for Kensington device!
2161          * The MSB of the horizontal count appears to be stored in
2162          * a strange place.
2163          */
2164         if (sc->hw.model == MOUSE_MODEL_THINK)
2165             pb->ipacket[1] |= (c & MOUSE_PS2_XOVERFLOW) ? 0x80 : 0;
2166
2167         /* ignore the overflow bits... */
2168         x = (c & MOUSE_PS2_XNEG) ?  pb->ipacket[1] - 256 : pb->ipacket[1];
2169         y = (c & MOUSE_PS2_YNEG) ?  pb->ipacket[2] - 256 : pb->ipacket[2];
2170         z = 0;
2171         ms.obutton = sc->button;                  /* previous button state */
2172         ms.button = butmap[c & MOUSE_PS2_BUTTONS];
2173         /* `tapping' action */
2174         if (sc->config & PSM_CONFIG_FORCETAP)
2175             ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 : MOUSE_BUTTON4DOWN;
2176
2177         switch (sc->hw.model) {
2178
2179         case MOUSE_MODEL_EXPLORER:
2180             /*
2181              *          b7 b6 b5 b4 b3 b2 b1 b0
2182              * byte 1:  oy ox sy sx 1  M  R  L
2183              * byte 2:  x  x  x  x  x  x  x  x
2184              * byte 3:  y  y  y  y  y  y  y  y
2185              * byte 4:  *  *  S2 S1 s  d2 d1 d0
2186              *
2187              * L, M, R, S1, S2: left, middle, right and side buttons
2188              * s: wheel data sign bit
2189              * d2-d0: wheel data
2190              */
2191             z = (pb->ipacket[3] & MOUSE_EXPLORER_ZNEG)
2192                 ? (pb->ipacket[3] & 0x0f) - 16 : (pb->ipacket[3] & 0x0f);
2193             ms.button |= (pb->ipacket[3] & MOUSE_EXPLORER_BUTTON4DOWN)
2194                 ? MOUSE_BUTTON4DOWN : 0;
2195             ms.button |= (pb->ipacket[3] & MOUSE_EXPLORER_BUTTON5DOWN)
2196                 ? MOUSE_BUTTON5DOWN : 0;
2197             break;
2198
2199         case MOUSE_MODEL_INTELLI:
2200         case MOUSE_MODEL_NET:
2201             /* wheel data is in the fourth byte */
2202             z = (char)pb->ipacket[3];
2203             /* some mice may send 7 when there is no Z movement?! XXX */
2204             if ((z >= 7) || (z <= -7))
2205                 z = 0;
2206             /* some compatible mice have additional buttons */
2207             ms.button |= (c & MOUSE_PS2INTELLI_BUTTON4DOWN)
2208                 ? MOUSE_BUTTON4DOWN : 0;
2209             ms.button |= (c & MOUSE_PS2INTELLI_BUTTON5DOWN)
2210                 ? MOUSE_BUTTON5DOWN : 0;
2211             break;
2212
2213         case MOUSE_MODEL_MOUSEMANPLUS:
2214             /*
2215              * PS2++ protocl packet
2216              *
2217              *          b7 b6 b5 b4 b3 b2 b1 b0
2218              * byte 1:  *  1  p3 p2 1  *  *  *
2219              * byte 2:  c1 c2 p1 p0 d1 d0 1  0
2220              *
2221              * p3-p0: packet type
2222              * c1, c2: c1 & c2 == 1, if p2 == 0
2223              *         c1 & c2 == 0, if p2 == 1
2224              *
2225              * packet type: 0 (device type)
2226              * See comments in enable_mmanplus() below.
2227              *
2228              * packet type: 1 (wheel data)
2229              *
2230              *          b7 b6 b5 b4 b3 b2 b1 b0
2231              * byte 3:  h  *  B5 B4 s  d2 d1 d0
2232              *
2233              * h: 1, if horizontal roller data
2234              *    0, if vertical roller data
2235              * B4, B5: button 4 and 5
2236              * s: sign bit
2237              * d2-d0: roller data
2238              *
2239              * packet type: 2 (reserved)
2240              */
2241             if (((c & MOUSE_PS2PLUS_SYNCMASK) == MOUSE_PS2PLUS_SYNC)
2242                     && (abs(x) > 191)
2243                     && MOUSE_PS2PLUS_CHECKBITS(pb->ipacket)) {
2244                 /* the extended data packet encodes button and wheel events */
2245                 switch (MOUSE_PS2PLUS_PACKET_TYPE(pb->ipacket)) {
2246                 case 1:
2247                     /* wheel data packet */
2248                     x = y = 0;
2249                     if (pb->ipacket[2] & 0x80) {
2250                         /* horizontal roller count - ignore it XXX*/
2251                     } else {
2252                         /* vertical roller count */
2253                         z = (pb->ipacket[2] & MOUSE_PS2PLUS_ZNEG)
2254                             ? (pb->ipacket[2] & 0x0f) - 16
2255                             : (pb->ipacket[2] & 0x0f);
2256                     }
2257                     ms.button |= (pb->ipacket[2] & MOUSE_PS2PLUS_BUTTON4DOWN)
2258                         ? MOUSE_BUTTON4DOWN : 0;
2259                     ms.button |= (pb->ipacket[2] & MOUSE_PS2PLUS_BUTTON5DOWN)
2260                         ? MOUSE_BUTTON5DOWN : 0;
2261                     break;
2262                 case 2:
2263                     /* this packet type is reserved by Logitech... */
2264                     /*
2265                      * IBM ScrollPoint Mouse uses this packet type to
2266                      * encode both vertical and horizontal scroll movement.
2267                      */
2268                     x = y = 0;
2269                     /* horizontal count */
2270                     if (pb->ipacket[2] & 0x0f)
2271                         z = (pb->ipacket[2] & MOUSE_SPOINT_WNEG) ? -2 : 2;
2272                     /* vertical count */
2273                     if (pb->ipacket[2] & 0xf0)
2274                         z = (pb->ipacket[2] & MOUSE_SPOINT_ZNEG) ? -1 : 1;
2275 #if 0
2276                     /* vertical count */
2277                     z = (pb->ipacket[2] & MOUSE_SPOINT_ZNEG)
2278                         ? ((pb->ipacket[2] >> 4) & 0x0f) - 16
2279                         : ((pb->ipacket[2] >> 4) & 0x0f);
2280                     /* horizontal count */
2281                     w = (pb->ipacket[2] & MOUSE_SPOINT_WNEG)
2282                         ? (pb->ipacket[2] & 0x0f) - 16
2283                         : (pb->ipacket[2] & 0x0f);
2284 #endif
2285                     break;
2286                 case 0:
2287                     /* device type packet - shouldn't happen */
2288                     /* FALLTHROUGH */
2289                 default:
2290                     x = y = 0;
2291                     ms.button = ms.obutton;
2292                     if (bootverbose)
2293                         log(LOG_DEBUG, "psmintr: unknown PS2++ packet type %d: "
2294                                        "0x%02x 0x%02x 0x%02x\n",
2295                             MOUSE_PS2PLUS_PACKET_TYPE(pb->ipacket),
2296                             pb->ipacket[0], pb->ipacket[1], pb->ipacket[2]);
2297                     break;
2298                 }
2299             } else {
2300                 /* preserve button states */
2301                 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
2302             }
2303             break;
2304
2305         case MOUSE_MODEL_GLIDEPOINT:
2306             /* `tapping' action */
2307             ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 : MOUSE_BUTTON4DOWN;
2308             break;
2309
2310         case MOUSE_MODEL_NETSCROLL:
2311             /* three addtional bytes encode buttons and wheel events */
2312             ms.button |= (pb->ipacket[3] & MOUSE_PS2_BUTTON3DOWN)
2313                 ? MOUSE_BUTTON4DOWN : 0;
2314             ms.button |= (pb->ipacket[3] & MOUSE_PS2_BUTTON1DOWN)
2315                 ? MOUSE_BUTTON5DOWN : 0;
2316             z = (pb->ipacket[3] & MOUSE_PS2_XNEG)
2317                 ? pb->ipacket[4] - 256 : pb->ipacket[4];
2318             break;
2319
2320         case MOUSE_MODEL_THINK:
2321             /* the fourth button state in the first byte */
2322             ms.button |= (c & MOUSE_PS2_TAP) ? MOUSE_BUTTON4DOWN : 0;
2323             break;
2324
2325         case MOUSE_MODEL_VERSAPAD:
2326             /* VersaPad PS/2 absolute mode message format
2327              *
2328              * [packet1]     7   6   5   4   3   2   1   0(LSB)
2329              *  ipacket[0]:  1   1   0   A   1   L   T   R
2330              *  ipacket[1]: H7  H6  H5  H4  H3  H2  H1  H0
2331              *  ipacket[2]: V7  V6  V5  V4  V3  V2  V1  V0
2332              *  ipacket[3]:  1   1   1   A   1   L   T   R
2333              *  ipacket[4]:V11 V10  V9  V8 H11 H10  H9  H8
2334              *  ipacket[5]:  0  P6  P5  P4  P3  P2  P1  P0
2335              *
2336              * [note]
2337              *  R: right physical mouse button (1=on)
2338              *  T: touch pad virtual button (1=tapping)
2339              *  L: left physical mouse button (1=on)
2340              *  A: position data is valid (1=valid)
2341              *  H: horizontal data (12bit signed integer. H11 is sign bit.)
2342              *  V: vertical data (12bit signed integer. V11 is sign bit.)
2343              *  P: pressure data
2344              *
2345              * Tapping is mapped to MOUSE_BUTTON4.
2346              */
2347             ms.button = butmap_versapad[c & MOUSE_PS2VERSA_BUTTONS];
2348             ms.button |= (c & MOUSE_PS2VERSA_TAP) ? MOUSE_BUTTON4DOWN : 0;
2349             x = y = 0;
2350             if (c & MOUSE_PS2VERSA_IN_USE) {
2351                 x0 = pb->ipacket[1] | (((pb->ipacket[4]) & 0x0f) << 8);
2352                 y0 = pb->ipacket[2] | (((pb->ipacket[4]) & 0xf0) << 4);
2353                 if (x0 & 0x800)
2354                     x0 -= 0x1000;
2355                 if (y0 & 0x800)
2356                     y0 -= 0x1000;
2357                 if (sc->flags & PSM_FLAGS_FINGERDOWN) {
2358                     x = sc->xold - x0;
2359                     y = y0 - sc->yold;
2360                     if (x < 0)  /* XXX */
2361                         x++;
2362                     else if (x)
2363                         x--;
2364                     if (y < 0)
2365                         y++;
2366                     else if (y)
2367                         y--;
2368                 } else {
2369                     sc->flags |= PSM_FLAGS_FINGERDOWN;
2370                 }
2371                 sc->xold = x0;
2372                 sc->yold = y0;
2373             } else {
2374                 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
2375             }
2376             c = ((x < 0) ? MOUSE_PS2_XNEG : 0)
2377                 | ((y < 0) ? MOUSE_PS2_YNEG : 0);
2378             break;
2379
2380         case MOUSE_MODEL_4D:
2381             /*
2382              *          b7 b6 b5 b4 b3 b2 b1 b0
2383              * byte 1:  s2 d2 s1 d1 1  M  R  L
2384              * byte 2:  sx x  x  x  x  x  x  x
2385              * byte 3:  sy y  y  y  y  y  y  y
2386              *
2387              * s1: wheel 1 direction
2388              * d1: wheel 1 data
2389              * s2: wheel 2 direction
2390              * d2: wheel 2 data
2391              */
2392             x = (pb->ipacket[1] & 0x80) ? pb->ipacket[1] - 256 : pb->ipacket[1];
2393             y = (pb->ipacket[2] & 0x80) ? pb->ipacket[2] - 256 : pb->ipacket[2];
2394             switch (c & MOUSE_4D_WHEELBITS) {
2395             case 0x10:
2396                 z = 1;
2397                 break;
2398             case 0x30:
2399                 z = -1;
2400                 break;
2401             case 0x40:  /* 2nd wheel turning right XXX */
2402                 z = 2;
2403                 break;
2404             case 0xc0:  /* 2nd wheel turning left XXX */
2405                 z = -2;
2406                 break;
2407             }
2408             break;
2409
2410         case MOUSE_MODEL_4DPLUS:
2411             if ((x < 16 - 256) && (y < 16 - 256)) {
2412                 /*
2413                  *          b7 b6 b5 b4 b3 b2 b1 b0
2414                  * byte 1:  0  0  1  1  1  M  R  L
2415                  * byte 2:  0  0  0  0  1  0  0  0
2416                  * byte 3:  0  0  0  0  S  s  d1 d0
2417                  *
2418                  * L, M, R, S: left, middle, right and side buttons
2419                  * s: wheel data sign bit
2420                  * d1-d0: wheel data
2421                  */
2422                 x = y = 0;
2423                 if (pb->ipacket[2] & MOUSE_4DPLUS_BUTTON4DOWN)
2424                     ms.button |= MOUSE_BUTTON4DOWN;
2425                 z = (pb->ipacket[2] & MOUSE_4DPLUS_ZNEG)
2426                         ? ((pb->ipacket[2] & 0x07) - 8)
2427                         : (pb->ipacket[2] & 0x07) ;
2428             } else {
2429                 /* preserve previous button states */
2430                 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
2431             }
2432             break;
2433
2434         case MOUSE_MODEL_GENERIC:
2435         default:
2436             break;
2437         }
2438
2439         /* scale values */
2440         if (sc->mode.accelfactor >= 1) {
2441             if (x != 0) {
2442                 x = x * x / sc->mode.accelfactor;
2443                 if (x == 0)
2444                     x = 1;
2445                 if (c & MOUSE_PS2_XNEG)
2446                     x = -x;
2447             }
2448             if (y != 0) {
2449                 y = y * y / sc->mode.accelfactor;
2450                 if (y == 0)
2451                     y = 1;
2452                 if (c & MOUSE_PS2_YNEG)
2453                     y = -y;
2454             }
2455         }
2456
2457         ms.dx = x;
2458         ms.dy = y;
2459         ms.dz = z;
2460         ms.flags = ((x || y || z) ? MOUSE_POSCHANGED : 0)
2461             | (ms.obutton ^ ms.button);
2462
2463         if (sc->mode.level < PSM_LEVEL_NATIVE)
2464             pb->inputbytes = tame_mouse(sc, pb, &ms, pb->ipacket);
2465
2466         sc->status.flags |= ms.flags;
2467         sc->status.dx += ms.dx;
2468         sc->status.dy += ms.dy;
2469         sc->status.dz += ms.dz;
2470         sc->status.button = ms.button;
2471         sc->button = ms.button;
2472
2473         sc->watchdog = FALSE;
2474
2475         /* queue data */
2476         if (sc->queue.count + pb->inputbytes < sizeof(sc->queue.buf)) {
2477             l = imin(pb->inputbytes, sizeof(sc->queue.buf) - sc->queue.tail);
2478             bcopy(&pb->ipacket[0], &sc->queue.buf[sc->queue.tail], l);
2479             if (pb->inputbytes > l)
2480                 bcopy(&pb->ipacket[l], &sc->queue.buf[0], pb->inputbytes - l);
2481             sc->queue.tail =
2482                 (sc->queue.tail + pb->inputbytes) % sizeof(sc->queue.buf);
2483             sc->queue.count += pb->inputbytes;
2484         }
2485         pb->inputbytes = 0;
2486
2487         if (++sc->pqueue_start >= PSM_PACKETQUEUE)
2488                 sc->pqueue_start = 0;
2489     } while (sc->pqueue_start != sc->pqueue_end);
2490     if (sc->state & PSM_ASLP) {
2491         sc->state &= ~PSM_ASLP;
2492         wakeup( sc);
2493     }
2494     selwakeuppri(&sc->rsel, PZERO);
2495     sc->state &= ~PSM_SOFTARMED;
2496     splx(s);
2497 }
2498
2499 static int
2500 psmpoll(dev_t dev, int events, struct thread *td)
2501 {
2502     struct psm_softc *sc = PSM_SOFTC(PSM_UNIT(dev));
2503     int s;
2504     int revents = 0;
2505
2506     /* Return true if a mouse event available */
2507     s = spltty();
2508     if (events & (POLLIN | POLLRDNORM)) {
2509         if (sc->queue.count > 0)
2510             revents |= events & (POLLIN | POLLRDNORM);
2511         else
2512             selrecord(td, &sc->rsel);
2513     }
2514     splx(s);
2515
2516     return (revents);
2517 }
2518
2519 /* vendor/model specific routines */
2520
2521 static int mouse_id_proc1(KBDC kbdc, int res, int scale, int *status)
2522 {
2523     if (set_mouse_resolution(kbdc, res) != res)
2524         return FALSE;
2525     if (set_mouse_scaling(kbdc, scale)
2526         && set_mouse_scaling(kbdc, scale)
2527         && set_mouse_scaling(kbdc, scale)
2528         && (get_mouse_status(kbdc, status, 0, 3) >= 3))
2529         return TRUE;
2530     return FALSE;
2531 }
2532
2533 static int
2534 mouse_ext_command(KBDC kbdc, int command)
2535 {
2536     int c;
2537
2538     c = (command >> 6) & 0x03;
2539     if (set_mouse_resolution(kbdc, c) != c)
2540         return FALSE;
2541     c = (command >> 4) & 0x03;
2542     if (set_mouse_resolution(kbdc, c) != c)
2543         return FALSE;
2544     c = (command >> 2) & 0x03;
2545     if (set_mouse_resolution(kbdc, c) != c)
2546         return FALSE;
2547     c = (command >> 0) & 0x03;
2548     if (set_mouse_resolution(kbdc, c) != c)
2549         return FALSE;
2550     return TRUE;
2551 }
2552
2553 #if notyet
2554 /* Logitech MouseMan Cordless II */
2555 static int
2556 enable_lcordless(struct psm_softc *sc)
2557 {
2558     int status[3];
2559     int ch;
2560
2561     if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 2, status))
2562         return FALSE;
2563     if (status[1] == PSMD_RES_HIGH)
2564         return FALSE;
2565     ch = (status[0] & 0x07) - 1;        /* channel # */
2566     if ((ch <= 0) || (ch > 4))
2567         return FALSE;
2568     /*
2569      * status[1]: always one?
2570      * status[2]: battery status? (0-100)
2571      */
2572     return TRUE;
2573 }
2574 #endif /* notyet */
2575
2576 /* Genius NetScroll Mouse, MouseSystems SmartScroll Mouse */
2577 static int
2578 enable_groller(struct psm_softc *sc)
2579 {
2580     int status[3];
2581
2582     /*
2583      * The special sequence to enable the fourth button and the
2584      * roller. Immediately after this sequence check status bytes.
2585      * if the mouse is NetScroll, the second and the third bytes are
2586      * '3' and 'D'.
2587      */
2588
2589     /*
2590      * If the mouse is an ordinary PS/2 mouse, the status bytes should
2591      * look like the following.
2592      *
2593      * byte 1 bit 7 always 0
2594      *        bit 6 stream mode (0)
2595      *        bit 5 disabled (0)
2596      *        bit 4 1:1 scaling (0)
2597      *        bit 3 always 0
2598      *        bit 0-2 button status
2599      * byte 2 resolution (PSMD_RES_HIGH)
2600      * byte 3 report rate (?)
2601      */
2602
2603     if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 1, status))
2604         return FALSE;
2605     if ((status[1] != '3') || (status[2] != 'D'))
2606         return FALSE;
2607     /* FIXME: SmartScroll Mouse has 5 buttons! XXX */
2608     sc->hw.buttons = 4;
2609     return TRUE;
2610 }
2611
2612 /* Genius NetMouse/NetMouse Pro, ASCII Mie Mouse, NetScroll Optical */
2613 static int
2614 enable_gmouse(struct psm_softc *sc)
2615 {
2616     int status[3];
2617
2618     /*
2619      * The special sequence to enable the middle, "rubber" button.
2620      * Immediately after this sequence check status bytes.
2621      * if the mouse is NetMouse, NetMouse Pro, or ASCII MIE Mouse,
2622      * the second and the third bytes are '3' and 'U'.
2623      * NOTE: NetMouse reports that it has three buttons although it has
2624      * two buttons and a rubber button. NetMouse Pro and MIE Mouse
2625      * say they have three buttons too and they do have a button on the
2626      * side...
2627      */
2628     if (!mouse_id_proc1(sc->kbdc, PSMD_RES_HIGH, 1, status))
2629         return FALSE;
2630     if ((status[1] != '3') || (status[2] != 'U'))
2631         return FALSE;
2632     return TRUE;
2633 }
2634
2635 /* ALPS GlidePoint */
2636 static int
2637 enable_aglide(struct psm_softc *sc)
2638 {
2639     int status[3];
2640
2641     /*
2642      * The special sequence to obtain ALPS GlidePoint specific
2643      * information. Immediately after this sequence, status bytes will
2644      * contain something interesting.
2645      * NOTE: ALPS produces several models of GlidePoint. Some of those
2646      * do not respond to this sequence, thus, cannot be detected this way.
2647      */
2648     if (set_mouse_sampling_rate(sc->kbdc, 100) != 100)
2649         return FALSE;
2650     if (!mouse_id_proc1(sc->kbdc, PSMD_RES_LOW, 2, status))
2651         return FALSE;
2652     if ((status[1] == PSMD_RES_LOW) || (status[2] == 100))
2653         return FALSE;
2654     return TRUE;
2655 }
2656
2657 /* Kensington ThinkingMouse/Trackball */
2658 static int
2659 enable_kmouse(struct psm_softc *sc)
2660 {
2661     static unsigned char rate[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20 };
2662     KBDC kbdc = sc->kbdc;
2663     int status[3];
2664     int id1;
2665     int id2;
2666     int i;
2667
2668     id1 = get_aux_id(kbdc);
2669     if (set_mouse_sampling_rate(kbdc, 10) != 10)
2670         return FALSE;
2671     /*
2672      * The device is now in the native mode? It returns a different
2673      * ID value...
2674      */
2675     id2 = get_aux_id(kbdc);
2676     if ((id1 == id2) || (id2 != 2))
2677         return FALSE;
2678
2679     if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
2680         return FALSE;
2681 #if PSM_DEBUG >= 2
2682     /* at this point, resolution is LOW, sampling rate is 10/sec */
2683     if (get_mouse_status(kbdc, status, 0, 3) < 3)
2684         return FALSE;
2685 #endif
2686
2687     /*
2688      * The special sequence to enable the third and fourth buttons.
2689      * Otherwise they behave like the first and second buttons.
2690      */
2691     for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2692         if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2693             return FALSE;
2694     }
2695
2696     /*
2697      * At this point, the device is using default resolution and
2698      * sampling rate for the native mode.
2699      */
2700     if (get_mouse_status(kbdc, status, 0, 3) < 3)
2701         return FALSE;
2702     if ((status[1] == PSMD_RES_LOW) || (status[2] == rate[i - 1]))
2703         return FALSE;
2704
2705     /* the device appears be enabled by this sequence, diable it for now */
2706     disable_aux_dev(kbdc);
2707     empty_aux_buffer(kbdc, 5);
2708
2709     return TRUE;
2710 }
2711
2712 /* Logitech MouseMan+/FirstMouse+, IBM ScrollPoint Mouse */
2713 static int
2714 enable_mmanplus(struct psm_softc *sc)
2715 {
2716     KBDC kbdc = sc->kbdc;
2717     int data[3];
2718
2719     /* the special sequence to enable the fourth button and the roller. */
2720     /*
2721      * NOTE: for ScrollPoint to respond correctly, the SET_RESOLUTION
2722      * must be called exactly three times since the last RESET command
2723      * before this sequence. XXX
2724      */
2725     if (!set_mouse_scaling(kbdc, 1))
2726         return FALSE;
2727     if (!mouse_ext_command(kbdc, 0x39) || !mouse_ext_command(kbdc, 0xdb))
2728         return FALSE;
2729     if (get_mouse_status(kbdc, data, 1, 3) < 3)
2730         return FALSE;
2731
2732     /*
2733      * PS2++ protocl, packet type 0
2734      *
2735      *          b7 b6 b5 b4 b3 b2 b1 b0
2736      * byte 1:  *  1  p3 p2 1  *  *  *
2737      * byte 2:  1  1  p1 p0 m1 m0 1  0
2738      * byte 3:  m7 m6 m5 m4 m3 m2 m1 m0
2739      *
2740      * p3-p0: packet type: 0
2741      * m7-m0: model ID: MouseMan+:0x50, FirstMouse+:0x51, ScrollPoint:0x58...
2742      */
2743     /* check constant bits */
2744     if ((data[0] & MOUSE_PS2PLUS_SYNCMASK) != MOUSE_PS2PLUS_SYNC)
2745         return FALSE;
2746     if ((data[1] & 0xc3) != 0xc2)
2747         return FALSE;
2748     /* check d3-d0 in byte 2 */
2749     if (!MOUSE_PS2PLUS_CHECKBITS(data))
2750         return FALSE;
2751     /* check p3-p0 */
2752     if (MOUSE_PS2PLUS_PACKET_TYPE(data) != 0)
2753         return FALSE;
2754
2755     sc->hw.hwid &= 0x00ff;
2756     sc->hw.hwid |= data[2] << 8;        /* save model ID */
2757
2758     /*
2759      * MouseMan+ (or FirstMouse+) is now in its native mode, in which
2760      * the wheel and the fourth button events are encoded in the
2761      * special data packet. The mouse may be put in the IntelliMouse mode
2762      * if it is initialized by the IntelliMouse's method.
2763      */
2764     return TRUE;
2765 }
2766
2767 /* MS IntelliMouse Explorer */
2768 static int
2769 enable_msexplorer(struct psm_softc *sc)
2770 {
2771     static unsigned char rate0[] = { 200, 100, 80, };
2772     static unsigned char rate1[] = { 200, 200, 80, };
2773     KBDC kbdc = sc->kbdc;
2774     int id;
2775     int i;
2776
2777     /* the special sequence to enable the extra buttons and the roller. */
2778     for (i = 0; i < sizeof(rate1)/sizeof(rate1[0]); ++i) {
2779         if (set_mouse_sampling_rate(kbdc, rate1[i]) != rate1[i])
2780             return FALSE;
2781     }
2782     /* the device will give the genuine ID only after the above sequence */
2783     id = get_aux_id(kbdc);
2784     if (id != PSM_EXPLORER_ID)
2785         return FALSE;
2786
2787     sc->hw.hwid = id;
2788     sc->hw.buttons = 5;         /* IntelliMouse Explorer XXX */
2789
2790     /*
2791      * XXX: this is a kludge to fool some KVM switch products
2792      * which think they are clever enough to know the 4-byte IntelliMouse
2793      * protocol, and assume any other protocols use 3-byte packets.
2794      * They don't convey 4-byte data packets from the IntelliMouse Explorer
2795      * correctly to the host computer because of this!
2796      * The following sequence is actually IntelliMouse's "wake up"
2797      * sequence; it will make the KVM think the mouse is IntelliMouse
2798      * when it is in fact IntelliMouse Explorer.
2799      */
2800     for (i = 0; i < sizeof(rate0)/sizeof(rate0[0]); ++i) {
2801         if (set_mouse_sampling_rate(kbdc, rate0[i]) != rate0[i])
2802             break;
2803     }
2804     id = get_aux_id(kbdc);
2805
2806     return TRUE;
2807 }
2808
2809 /* MS IntelliMouse */
2810 static int
2811 enable_msintelli(struct psm_softc *sc)
2812 {
2813     /*
2814      * Logitech MouseMan+ and FirstMouse+ will also respond to this
2815      * probe routine and act like IntelliMouse.
2816      */
2817
2818     static unsigned char rate[] = { 200, 100, 80, };
2819     KBDC kbdc = sc->kbdc;
2820     int id;
2821     int i;
2822
2823     /* the special sequence to enable the third button and the roller. */
2824     for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2825         if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2826             return FALSE;
2827     }
2828     /* the device will give the genuine ID only after the above sequence */
2829     id = get_aux_id(kbdc);
2830     if (id != PSM_INTELLI_ID)
2831         return FALSE;
2832
2833     sc->hw.hwid = id;
2834     sc->hw.buttons = 3;
2835
2836     return TRUE;
2837 }
2838
2839 /* A4 Tech 4D Mouse */
2840 static int
2841 enable_4dmouse(struct psm_softc *sc)
2842 {
2843     /*
2844      * Newer wheel mice from A4 Tech may use the 4D+ protocol.
2845      */
2846
2847     static unsigned char rate[] = { 200, 100, 80, 60, 40, 20 };
2848     KBDC kbdc = sc->kbdc;
2849     int id;
2850     int i;
2851
2852     for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2853         if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2854             return FALSE;
2855     }
2856     id = get_aux_id(kbdc);
2857     /*
2858      * WinEasy 4D, 4 Way Scroll 4D: 6
2859      * Cable-Free 4D: 8 (4DPLUS)
2860      * WinBest 4D+, 4 Way Scroll 4D+: 8 (4DPLUS)
2861      */
2862     if (id != PSM_4DMOUSE_ID)
2863         return FALSE;
2864
2865     sc->hw.hwid = id;
2866     sc->hw.buttons = 3;         /* XXX some 4D mice have 4? */
2867
2868     return TRUE;
2869 }
2870
2871 /* A4 Tech 4D+ Mouse */
2872 static int
2873 enable_4dplus(struct psm_softc *sc)
2874 {
2875     /*
2876      * Newer wheel mice from A4 Tech seem to use this protocol.
2877      * Older models are recognized as either 4D Mouse or IntelliMouse.
2878      */
2879     KBDC kbdc = sc->kbdc;
2880     int id;
2881
2882     /*
2883      * enable_4dmouse() already issued the following ID sequence...
2884     static unsigned char rate[] = { 200, 100, 80, 60, 40, 20 };
2885     int i;
2886
2887     for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i) {
2888         if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
2889             return FALSE;
2890     }
2891     */
2892
2893     id = get_aux_id(kbdc);
2894     switch (id) {
2895     case PSM_4DPLUS_ID:
2896             sc->hw.buttons = 4;
2897             break;
2898     case PSM_4DPLUS_RFSW35_ID:
2899             sc->hw.buttons = 3;
2900             break;
2901     default:
2902             return FALSE;
2903     }
2904
2905     sc->hw.hwid = id;
2906
2907     return TRUE;
2908 }
2909
2910 /* Interlink electronics VersaPad */
2911 static int
2912 enable_versapad(struct psm_softc *sc)
2913 {
2914     KBDC kbdc = sc->kbdc;
2915     int data[3];
2916
2917     set_mouse_resolution(kbdc, PSMD_RES_MEDIUM_HIGH); /* set res. 2 */
2918     set_mouse_sampling_rate(kbdc, 100);         /* set rate 100 */
2919     set_mouse_scaling(kbdc, 1);                 /* set scale 1:1 */
2920     set_mouse_scaling(kbdc, 1);                 /* set scale 1:1 */
2921     set_mouse_scaling(kbdc, 1);                 /* set scale 1:1 */
2922     set_mouse_scaling(kbdc, 1);                 /* set scale 1:1 */
2923     if (get_mouse_status(kbdc, data, 0, 3) < 3) /* get status */
2924         return FALSE;
2925     if (data[2] != 0xa || data[1] != 0 )        /* rate == 0xa && res. == 0 */
2926         return FALSE;
2927     set_mouse_scaling(kbdc, 1);                 /* set scale 1:1 */
2928
2929     sc->config |= PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND;
2930
2931     return TRUE;                                /* PS/2 absolute mode */
2932 }
2933
2934 static int
2935 psmresume(device_t dev)
2936 {
2937     struct psm_softc *sc = device_get_softc(dev);
2938     int unit = device_get_unit(dev);
2939     int err;
2940
2941     if (verbose >= 2)
2942         log(LOG_NOTICE, "psm%d: system resume hook called.\n", unit);
2943
2944     if (!(sc->config & PSM_CONFIG_HOOKRESUME))
2945         return (0);
2946
2947     err = reinitialize(sc, sc->config & PSM_CONFIG_INITAFTERSUSPEND);
2948
2949     if ((sc->state & PSM_ASLP) && !(sc->state & PSM_VALID)) {
2950         /*
2951          * Release the blocked process; it must be notified that the device
2952          * cannot be accessed anymore.
2953          */
2954         sc->state &= ~PSM_ASLP;
2955         wakeup(sc);
2956     }
2957
2958     if (verbose >= 2)
2959         log(LOG_DEBUG, "psm%d: system resume hook exiting.\n", unit);
2960
2961     return (err);
2962 }
2963
2964 DRIVER_MODULE(psm, atkbdc, psm_driver, psm_devclass, 0, 0);
2965
2966 /*
2967  * This sucks up assignments from PNPBIOS and ACPI.
2968  */
2969
2970 /*
2971  * When the PS/2 mouse device is reported by ACPI or PnP BIOS, it may
2972  * appear BEFORE the AT keyboard controller.  As the PS/2 mouse device
2973  * can be probed and attached only after the AT keyboard controller is
2974  * attached, we shall quietly reserve the IRQ resource for later use.
2975  * If the PS/2 mouse device is reported to us AFTER the keyboard controller,
2976  * copy the IRQ resource to the PS/2 mouse device instance hanging
2977  * under the keyboard controller, then probe and attach it.
2978  */
2979
2980 static  devclass_t                      psmcpnp_devclass;
2981
2982 static  device_probe_t                  psmcpnp_probe;
2983 static  device_attach_t                 psmcpnp_attach;
2984
2985 static device_method_t psmcpnp_methods[] = {
2986         DEVMETHOD(device_probe,         psmcpnp_probe),
2987         DEVMETHOD(device_attach,        psmcpnp_attach),
2988
2989         { 0, 0 }
2990 };
2991
2992 static driver_t psmcpnp_driver = {
2993         PSMCPNP_DRIVER_NAME,
2994         psmcpnp_methods,
2995         1,                      /* no softc */
2996 };
2997
2998 static struct isa_pnp_id psmcpnp_ids[] = {
2999         { 0x030fd041, "PS/2 mouse port" },              /* PNP0F03 */
3000         { 0x130fd041, "PS/2 mouse port" },              /* PNP0F13 */
3001         { 0x1303d041, "PS/2 port" },                    /* PNP0313, XXX */
3002         { 0x02002e4f, "Dell PS/2 mouse port" },         /* Lat. X200, Dell */
3003         { 0x80374d24, "IBM PS/2 mouse port" },          /* IBM3780, ThinkPad */
3004         { 0x81374d24, "IBM PS/2 mouse port" },          /* IBM3781, ThinkPad */
3005         { 0x0190d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9001, Vaio */
3006         { 0x0290d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9002, Vaio */
3007         { 0x0390d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9003, Vaio */
3008         { 0x0490d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9004, Vaio */
3009         { 0 }
3010 };
3011
3012 static int
3013 create_a_copy(device_t atkbdc, device_t me)
3014 {
3015         device_t psm;
3016         u_long irq;
3017
3018         /* find the PS/2 mouse device instance under the keyboard controller */
3019         psm = device_find_child(atkbdc, PSM_DRIVER_NAME,
3020                                 device_get_unit(atkbdc));
3021         if (psm == NULL)
3022                 return ENXIO;
3023         if (device_get_state(psm) != DS_NOTPRESENT)
3024                 return 0;
3025
3026         /* move our resource to the found device */
3027         irq = bus_get_resource_start(me, SYS_RES_IRQ, 0);
3028         bus_set_resource(psm, SYS_RES_IRQ, KBDC_RID_AUX, irq, 1);
3029
3030         /* ...then probe and attach it */
3031         return device_probe_and_attach(psm);
3032 }
3033
3034 static int
3035 psmcpnp_probe(device_t dev)
3036 {
3037         struct resource *res;
3038         u_long irq;
3039         int rid;
3040
3041         if (ISA_PNP_PROBE(device_get_parent(dev), dev, psmcpnp_ids))
3042                 return ENXIO;
3043
3044         /*
3045          * The PnP BIOS and ACPI are supposed to assign an IRQ (12)
3046          * to the PS/2 mouse device node. But, some buggy PnP BIOS
3047          * declares the PS/2 mouse device node without an IRQ resource!
3048          * If this happens, we shall refer to device hints.
3049          * If we still don't find it there, use a hardcoded value... XXX
3050          */
3051         rid = 0;
3052         irq = bus_get_resource_start(dev, SYS_RES_IRQ, rid);
3053         if (irq <= 0) {
3054                 if (resource_long_value(PSM_DRIVER_NAME,
3055                                         device_get_unit(dev), "irq", &irq) != 0)
3056                         irq = 12;       /* XXX */
3057                 device_printf(dev, "irq resource info is missing; "
3058                               "assuming irq %ld\n", irq);
3059                 bus_set_resource(dev, SYS_RES_IRQ, rid, irq, 1);
3060         }
3061         res = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 0, ~0, 1,
3062                                  RF_SHAREABLE);
3063         bus_release_resource(dev, SYS_RES_IRQ, rid, res);
3064
3065         /* keep quiet */
3066         if (!bootverbose)
3067                 device_quiet(dev);
3068
3069         return ((res == NULL) ? ENXIO : 0);
3070 }
3071
3072 static int
3073 psmcpnp_attach(device_t dev)
3074 {
3075         device_t atkbdc;
3076         int rid;
3077
3078         /* find the keyboard controller, which may be on acpi* or isa* bus */
3079         atkbdc = devclass_get_device(devclass_find(ATKBDC_DRIVER_NAME),
3080                                      device_get_unit(dev));
3081         if ((atkbdc != NULL) && (device_get_state(atkbdc) == DS_ATTACHED)) {
3082                 create_a_copy(atkbdc, dev);
3083         } else {
3084                 /*
3085                  * If we don't have the AT keyboard controller yet,
3086                  * just reserve the IRQ for later use...
3087                  * (See psmidentify() above.)
3088                  */
3089                 rid = 0;
3090                 bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 0, ~0, 1,
3091                                    RF_SHAREABLE);
3092         }
3093
3094         return 0;
3095 }
3096
3097 /*
3098  * Return true if 'now' is earlier than (start + (secs.usecs)).
3099  * Now may be NULL and the function will fetch the current time from
3100  * getmicrouptime(), or a cached 'now' can be passed in.
3101  * All values should be numbers derived from getmicrouptime().
3102  */
3103 static int
3104 timeelapsed(start, secs, usecs, now)
3105         const struct timeval *start, *now;
3106         int secs, usecs;
3107 {
3108         struct timeval snow, tv;
3109
3110         /* if there is no 'now' passed in, the get it as a convience. */
3111         if (now == NULL) {
3112                 getmicrouptime(&snow);
3113                 now = &snow;
3114         }
3115
3116         tv.tv_sec = secs;
3117         tv.tv_usec = usecs;
3118         timevaladd(&tv, start);
3119         return (timevalcmp(&tv, now, <));
3120 }
3121
3122 DRIVER_MODULE(psmcpnp, isa, psmcpnp_driver, psmcpnp_devclass, 0, 0);
3123 DRIVER_MODULE(psmcpnp, acpi, psmcpnp_driver, psmcpnp_devclass, 0, 0);