sys/dev/atkbdc/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_isa.h"
  65 #include "opt_psm.h"
  66 #include "opt_evdev.h"
  67
  68 #include <sys/param.h>
  69 #include <sys/systm.h>
  70 #include <sys/kernel.h>
  71 #include <sys/module.h>
  72 #include <sys/bus.h>
  73 #include <sys/conf.h>
  74 #include <sys/filio.h>
  75 #include <sys/mutex.h>
  76 #include <sys/poll.h>
  77 #include <sys/sigio.h>
  78 #include <sys/signalvar.h>
  79 #include <sys/syslog.h>
  80 #include <machine/bus.h>
  81 #include <sys/rman.h>
  82 #include <sys/selinfo.h>
  83 #include <sys/sysctl.h>
  84 #include <sys/time.h>
  85 #include <sys/uio.h>
  86
  87 #include <sys/limits.h>
  88 #include <sys/mouse.h>
  89 #include <machine/resource.h>
  90
  91 #ifdef DEV_ISA
  92 #include <isa/isavar.h>
  93 #endif
  94
  95 #ifdef EVDEV_SUPPORT
  96 #include <dev/evdev/evdev.h>
  97 #include <dev/evdev/input.h>
  98 #endif
  99
 100 #include <dev/atkbdc/atkbdcreg.h>
 101 #include <dev/atkbdc/psm.h>
 102
 103 /*
 104  * Driver specific options: the following options may be set by
 105  * `options' statements in the kernel configuration file.
 106  */
 107
 108 /* debugging */
 109 #ifndef PSM_DEBUG
 110 #define PSM_DEBUG       0       /*
 111                                  * logging: 0: none, 1: brief, 2: verbose
 112                                  *          3: sync errors, 4: all packets
 113                                  */
 114 #endif
 115 #define VLOG(level, args)       do {    \
 116         if (verbose >= level)           \
 117                 log args;               \
 118 } while (0)
 119
 120 #ifndef PSM_INPUT_TIMEOUT
 121 #define PSM_INPUT_TIMEOUT       2000000 /* 2 sec */
 122 #endif
 123
 124 #ifndef PSM_TAP_TIMEOUT
 125 #define PSM_TAP_TIMEOUT         125000
 126 #endif
 127
 128 #ifndef PSM_TAP_THRESHOLD
 129 #define PSM_TAP_THRESHOLD       25
 130 #endif
 131
 132 /* end of driver specific options */
 133
 134 #define PSMCPNP_DRIVER_NAME     "psmcpnp"
 135
 136 struct psmcpnp_softc {
 137         enum {
 138                 PSMCPNP_GENERIC,
 139                 PSMCPNP_FORCEPAD,
 140                 PSMCPNP_TOPBUTTONPAD,
 141         } type;         /* Based on PnP ID */
 142 };
 143
 144 /* input queue */
 145 #define PSM_BUFSIZE             960
 146 #define PSM_SMALLBUFSIZE        240
 147
 148 /* operation levels */
 149 #define PSM_LEVEL_BASE          0
 150 #define PSM_LEVEL_STANDARD      1
 151 #define PSM_LEVEL_NATIVE        2
 152 #define PSM_LEVEL_MIN           PSM_LEVEL_BASE
 153 #define PSM_LEVEL_MAX           PSM_LEVEL_NATIVE
 154
 155 /* Active PS/2 multiplexing */
 156 #define PSM_NOMUX               (-1)
 157
 158 /* Logitech PS2++ protocol */
 159 #define MOUSE_PS2PLUS_CHECKBITS(b)      \
 160     ((((b[2] & 0x03) << 2) | 0x02) == (b[1] & 0x0f))
 161 #define MOUSE_PS2PLUS_PACKET_TYPE(b)    \
 162     (((b[0] & 0x30) >> 2) | ((b[1] & 0x30) >> 4))
 163
 164 /* ring buffer */
 165 typedef struct ringbuf {
 166         int             count;  /* # of valid elements in the buffer */
 167         int             head;   /* head pointer */
 168         int             tail;   /* tail poiner */
 169         u_char buf[PSM_BUFSIZE];
 170 } ringbuf_t;
 171
 172 /* data buffer */
 173 typedef struct packetbuf {
 174         u_char  ipacket[16];    /* interim input buffer */
 175         int     inputbytes;     /* # of bytes in the input buffer */
 176 } packetbuf_t;
 177
 178 #ifndef PSM_PACKETQUEUE
 179 #define PSM_PACKETQUEUE 128
 180 #endif
 181
 182 /*
 183  * Synaptics command definitions.
 184  */
 185 #define SYNAPTICS_READ_IDENTITY                 0x00
 186 #define SYNAPTICS_READ_MODES                    0x01
 187 #define SYNAPTICS_READ_CAPABILITIES             0x02
 188 #define SYNAPTICS_READ_MODEL_ID                 0x03
 189 #define SYNAPTICS_READ_SERIAL_PREFIX            0x06
 190 #define SYNAPTICS_READ_SERIAL_SUFFIX            0x07
 191 #define SYNAPTICS_READ_RESOLUTIONS              0x08
 192 #define SYNAPTICS_READ_EXTENDED                 0x09
 193 #define SYNAPTICS_READ_CAPABILITIES_CONT        0x0c
 194 #define SYNAPTICS_READ_MAX_COORDS               0x0d
 195 #define SYNAPTICS_READ_DELUXE_LED               0x0e
 196 #define SYNAPTICS_READ_MIN_COORDS               0x0f
 197
 198 typedef struct synapticsinfo {
 199         struct sysctl_ctx_list   sysctl_ctx;
 200         struct sysctl_oid       *sysctl_tree;
 201         int                      directional_scrolls;
 202         int                      two_finger_scroll;
 203         int                      min_pressure;
 204         int                      max_pressure;
 205         int                      max_width;
 206         int                      margin_top;
 207         int                      margin_right;
 208         int                      margin_bottom;
 209         int                      margin_left;
 210         int                      na_top;
 211         int                      na_right;
 212         int                      na_bottom;
 213         int                      na_left;
 214         int                      window_min;
 215         int                      window_max;
 216         int                      multiplicator;
 217         int                      weight_current;
 218         int                      weight_previous;
 219         int                      weight_previous_na;
 220         int                      weight_len_squared;
 221         int                      div_min;
 222         int                      div_max;
 223         int                      div_max_na;
 224         int                      div_len;
 225         int                      tap_max_delta;
 226         int                      tap_min_queue;
 227         int                      taphold_timeout;
 228         int                      vscroll_ver_area;
 229         int                      vscroll_hor_area;
 230         int                      vscroll_min_delta;
 231         int                      vscroll_div_min;
 232         int                      vscroll_div_max;
 233         int                      touchpad_off;
 234         int                      softbuttons_y;
 235         int                      softbutton2_x;
 236         int                      softbutton3_x;
 237         int                      max_x;
 238         int                      max_y;
 239         int                      three_finger_drag;
 240         int                      natural_scroll;
 241 } synapticsinfo_t;
 242
 243 typedef struct synapticspacket {
 244         int                     x;
 245         int                     y;
 246 } synapticspacket_t;
 247
 248 #define SYNAPTICS_PACKETQUEUE 10
 249 #define SYNAPTICS_QUEUE_CURSOR(x)                                       \
 250         (x + SYNAPTICS_PACKETQUEUE) % SYNAPTICS_PACKETQUEUE
 251
 252 #define SYNAPTICS_VERSION_GE(synhw, major, minor)                       \
 253     ((synhw).infoMajor > (major) ||                                     \
 254      ((synhw).infoMajor == (major) && (synhw).infoMinor >= (minor)))
 255
 256 typedef struct smoother {
 257         synapticspacket_t       queue[SYNAPTICS_PACKETQUEUE];
 258         int                     queue_len;
 259         int                     queue_cursor;
 260         int                     start_x;
 261         int                     start_y;
 262         int                     avg_dx;
 263         int                     avg_dy;
 264         int                     squelch_x;
 265         int                     squelch_y;
 266         int                     is_fuzzy;
 267         int                     active;
 268 } smoother_t;
 269
 270 typedef struct gesture {
 271         int                     window_min;
 272         int                     fingers_nb;
 273         int                     tap_button;
 274         int                     in_taphold;
 275         int                     in_vscroll;
 276         int                     zmax;           /* maximum pressure value */
 277         struct timeval          taptimeout;     /* tap timeout for touchpads */
 278 } gesture_t;
 279
 280 enum {
 281         TRACKPOINT_SYSCTL_SENSITIVITY,
 282         TRACKPOINT_SYSCTL_NEGATIVE_INERTIA,
 283         TRACKPOINT_SYSCTL_UPPER_PLATEAU,
 284         TRACKPOINT_SYSCTL_BACKUP_RANGE,
 285         TRACKPOINT_SYSCTL_DRAG_HYSTERESIS,
 286         TRACKPOINT_SYSCTL_MINIMUM_DRAG,
 287         TRACKPOINT_SYSCTL_UP_THRESHOLD,
 288         TRACKPOINT_SYSCTL_THRESHOLD,
 289         TRACKPOINT_SYSCTL_JENKS_CURVATURE,
 290         TRACKPOINT_SYSCTL_Z_TIME,
 291         TRACKPOINT_SYSCTL_PRESS_TO_SELECT,
 292         TRACKPOINT_SYSCTL_SKIP_BACKUPS
 293 };
 294
 295 typedef struct trackpointinfo {
 296         struct sysctl_ctx_list sysctl_ctx;
 297         struct sysctl_oid *sysctl_tree;
 298         int     sensitivity;
 299         int     inertia;
 300         int     uplateau;
 301         int     reach;
 302         int     draghys;
 303         int     mindrag;
 304         int     upthresh;
 305         int     threshold;
 306         int     jenks;
 307         int     ztime;
 308         int     pts;
 309         int     skipback;
 310 } trackpointinfo_t;
 311
 312 typedef struct finger {
 313         int                     x;
 314         int                     y;
 315         int                     p;
 316         int                     w;
 317         int                     flags;
 318 } finger_t;
 319 #define PSM_FINGERS             2       /* # of processed fingers */
 320 #define PSM_FINGER_IS_PEN       (1<<0)
 321 #define PSM_FINGER_FUZZY        (1<<1)
 322 #define PSM_FINGER_DEFAULT_P    tap_threshold
 323 #define PSM_FINGER_DEFAULT_W    1
 324 #define PSM_FINGER_IS_SET(f) ((f).x != -1 && (f).y != -1 && (f).p != 0)
 325 #define PSM_FINGER_RESET(f) do { \
 326         (f) = (finger_t) { .x = -1, .y = -1, .p = 0, .w = 0, .flags = 0 }; \
 327 } while (0)
 328
 329 typedef struct elantechhw {
 330         int                     hwversion;
 331         int                     fwversion;
 332         int                     sizex;
 333         int                     sizey;
 334         int                     dpmmx;
 335         int                     dpmmy;
 336         int                     ntracesx;
 337         int                     ntracesy;
 338         int                     dptracex;
 339         int                     dptracey;
 340         int                     issemimt;
 341         int                     isclickpad;
 342         int                     hascrc;
 343         int                     hastrackpoint;
 344         int                     haspressure;
 345 } elantechhw_t;
 346
 347 /* minimum versions supported by this driver */
 348 #define ELANTECH_HW_IS_V1(fwver) ((fwver) < 0x020030 || (fwver) == 0x020600)
 349
 350 #define ELANTECH_MAGIC(magic)                           \
 351         ((magic)[0] == 0x3c && (magic)[1] == 0x03 &&    \
 352         ((magic)[2] == 0xc8 || (magic)[2] == 0x00))
 353
 354 #define ELANTECH_FW_ID          0x00
 355 #define ELANTECH_FW_VERSION     0x01
 356 #define ELANTECH_CAPABILITIES   0x02
 357 #define ELANTECH_SAMPLE         0x03
 358 #define ELANTECH_RESOLUTION     0x04
 359 #define ELANTECH_REG_READ       0x10
 360 #define ELANTECH_REG_WRITE      0x11
 361 #define ELANTECH_REG_RDWR       0x00
 362 #define ELANTECH_CUSTOM_CMD     0xf8
 363
 364 #ifdef EVDEV_SUPPORT
 365 #define ELANTECH_MAX_FINGERS    5
 366 #else
 367 #define ELANTECH_MAX_FINGERS    PSM_FINGERS
 368 #endif
 369
 370 #define ELANTECH_FINGER_MAX_P   255
 371 #define ELANTECH_FINGER_MAX_W   15
 372 #define ELANTECH_FINGER_SET_XYP(pb) (finger_t) {                        \
 373     .x = (((pb)->ipacket[1] & 0x0f) << 8) | (pb)->ipacket[2],           \
 374     .y = (((pb)->ipacket[4] & 0x0f) << 8) | (pb)->ipacket[5],           \
 375     .p = ((pb)->ipacket[1] & 0xf0) | (((pb)->ipacket[4] >> 4) & 0x0f),  \
 376     .w = PSM_FINGER_DEFAULT_W,                                          \
 377     .flags = 0                                                          \
 378 }
 379
 380 enum {
 381         ELANTECH_PKT_NOP,
 382         ELANTECH_PKT_TRACKPOINT,
 383         ELANTECH_PKT_V2_COMMON,
 384         ELANTECH_PKT_V2_2FINGER,
 385         ELANTECH_PKT_V3,
 386         ELANTECH_PKT_V4_STATUS,
 387         ELANTECH_PKT_V4_HEAD,
 388         ELANTECH_PKT_V4_MOTION
 389 };
 390
 391 #define ELANTECH_PKT_IS_TRACKPOINT(pb) (((pb)->ipacket[3] & 0x0f) == 0x06)
 392 #define ELANTECH_PKT_IS_DEBOUNCE(pb, hwversion) ((hwversion) == 4 ? 0 : \
 393     (pb)->ipacket[0] == ((hwversion) == 2 ? 0x84 : 0xc4) &&             \
 394     (pb)->ipacket[1] == 0xff && (pb)->ipacket[2] == 0xff &&             \
 395     (pb)->ipacket[3] == 0x02 && (pb)->ipacket[4] == 0xff &&             \
 396     (pb)->ipacket[5] == 0xff)
 397 #define ELANTECH_PKT_IS_V2(pb)                                          \
 398     (((pb)->ipacket[0] & 0x0c) == 0x04 && ((pb)->ipacket[3] & 0x0f) == 0x02)
 399 #define ELANTECH_PKT_IS_V3_HEAD(pb, hascrc) ((hascrc) ?                 \
 400     ((pb)->ipacket[3] & 0x09) == 0x08 :                                 \
 401     ((pb)->ipacket[0] & 0x0c) == 0x04 && ((pb)->ipacket[3] & 0xcf) == 0x02)
 402 #define ELANTECH_PKT_IS_V3_TAIL(pb, hascrc) ((hascrc) ?                 \
 403     ((pb)->ipacket[3] & 0x09) == 0x09 :                                 \
 404     ((pb)->ipacket[0] & 0x0c) == 0x0c && ((pb)->ipacket[3] & 0xce) == 0x0c)
 405 #define ELANTECH_PKT_IS_V4(pb, hascrc) ((hascrc) ?                      \
 406     ((pb)->ipacket[3] & 0x08) == 0x00 :                                 \
 407     ((pb)->ipacket[0] & 0x0c) == 0x04 && ((pb)->ipacket[3] & 0x1c) == 0x10)
 408
 409 typedef struct elantechaction {
 410         finger_t                fingers[ELANTECH_MAX_FINGERS];
 411         int                     mask;
 412         int                     mask_v4wait;
 413 } elantechaction_t;
 414
 415 /* driver control block */
 416 struct psm_softc {              /* Driver status information */
 417         int             unit;
 418         struct selinfo  rsel;           /* Process selecting for Input */
 419         u_char          state;          /* Mouse driver state */
 420         int             config;         /* driver configuration flags */
 421         int             flags;          /* other flags */
 422         KBDC            kbdc;           /* handle to access kbd controller */
 423         struct resource *intr;          /* IRQ resource */
 424         void            *ih;            /* interrupt handle */
 425         mousehw_t       hw;             /* hardware information */
 426         synapticshw_t   synhw;          /* Synaptics hardware information */
 427         synapticsinfo_t syninfo;        /* Synaptics configuration */
 428         smoother_t      smoother[PSM_FINGERS];  /* Motion smoothing */
 429         gesture_t       gesture;        /* Gesture context */
 430         elantechhw_t    elanhw;         /* Elantech hardware information */
 431         elantechaction_t elanaction;    /* Elantech action context */
 432         int             tphw;           /* TrackPoint hardware information */
 433         trackpointinfo_t tpinfo;        /* TrackPoint configuration */
 434         mousemode_t     mode;           /* operation mode */
 435         mousemode_t     dflt_mode;      /* default operation mode */
 436         mousestatus_t   status;         /* accumulated mouse movement */
 437         ringbuf_t       queue;          /* mouse status queue */
 438         packetbuf_t     pqueue[PSM_PACKETQUEUE]; /* mouse data queue */
 439         int             pqueue_start;   /* start of data in queue */
 440         int             pqueue_end;     /* end of data in queue */
 441         int             button;         /* the latest button state */
 442         int             xold;           /* previous absolute X position */
 443         int             yold;           /* previous absolute Y position */
 444         int             xaverage;       /* average X position */
 445         int             yaverage;       /* average Y position */
 446         int             squelch; /* level to filter movement at low speed */
 447         int             syncerrors; /* # of bytes discarded to synchronize */
 448         int             pkterrors;  /* # of packets failed during quaranteen. */
 449         int             fpcount;        /* forcePad valid packet counter */
 450         struct timeval  inputtimeout;
 451         struct timeval  lastsoftintr;   /* time of last soft interrupt */
 452         struct timeval  lastinputerr;   /* time last sync error happened */
 453         struct timeval  idletimeout;
 454         packetbuf_t     idlepacket;     /* packet to send after idle timeout */
 455         int             watchdog;       /* watchdog timer flag */
 456         struct callout  callout;        /* watchdog timer call out */
 457         struct callout  softcallout; /* buffer timer call out */
 458         struct cdev     *dev;
 459         struct cdev     *bdev;
 460         int             lasterr;
 461         int             cmdcount;
 462         struct sigio    *async;         /* Processes waiting for SIGIO */
 463         int             extended_buttons;
 464         int             muxport;        /* MUX port with attached Synaptics */
 465         u_char          muxsave[3];     /* 3->6 byte proto conversion buffer */
 466         int             muxtpbuttons;   /* Touchpad button state */
 467         int             muxmsbuttons;   /* Mouse (trackpoint) button state */
 468         struct timeval  muxmidtimeout;  /* middle button supression timeout */
 469 #ifdef EVDEV_SUPPORT
 470         struct evdev_dev *evdev_a;      /* Absolute reporting device */
 471         struct evdev_dev *evdev_r;      /* Relative reporting device */
 472 #endif
 473 };
 474 static devclass_t psm_devclass;
 475
 476 /* driver state flags (state) */
 477 #define PSM_VALID               0x80
 478 #define PSM_OPEN                1       /* Device is open */
 479 #define PSM_ASLP                2       /* Waiting for mouse data */
 480 #define PSM_SOFTARMED           4       /* Software interrupt armed */
 481 #define PSM_NEED_SYNCBITS       8       /* Set syncbits using next data pkt */
 482 #define PSM_EV_OPEN_R           0x10    /* Relative evdev device is open */
 483 #define PSM_EV_OPEN_A           0x20    /* Absolute evdev device is open */
 484
 485 /* driver configuration flags (config) */
 486 #define PSM_CONFIG_RESOLUTION   0x000f  /* resolution */
 487 #define PSM_CONFIG_ACCEL        0x00f0  /* acceleration factor */
 488 #define PSM_CONFIG_NOCHECKSYNC  0x0100  /* disable sync. test */
 489 #define PSM_CONFIG_NOIDPROBE    0x0200  /* disable mouse model probe */
 490 #define PSM_CONFIG_NORESET      0x0400  /* don't reset the mouse */
 491 #define PSM_CONFIG_FORCETAP     0x0800  /* assume `tap' action exists */
 492 #define PSM_CONFIG_IGNPORTERROR 0x1000  /* ignore error in aux port test */
 493 #define PSM_CONFIG_HOOKRESUME   0x2000  /* hook the system resume event */
 494 #define PSM_CONFIG_INITAFTERSUSPEND 0x4000 /* init the device at the resume event */
 495
 496 #define PSM_CONFIG_FLAGS        \
 497     (PSM_CONFIG_RESOLUTION |    \
 498     PSM_CONFIG_ACCEL |          \
 499     PSM_CONFIG_NOCHECKSYNC |    \
 500     PSM_CONFIG_NOIDPROBE |      \
 501     PSM_CONFIG_NORESET |        \
 502     PSM_CONFIG_FORCETAP |       \
 503     PSM_CONFIG_IGNPORTERROR |   \
 504     PSM_CONFIG_HOOKRESUME |     \
 505     PSM_CONFIG_INITAFTERSUSPEND)
 506
 507 /* other flags (flags) */
 508 #define PSM_FLAGS_FINGERDOWN    0x0001  /* VersaPad finger down */
 509
 510 #define kbdcp(p)                        ((atkbdc_softc_t *)(p))
 511 #define ALWAYS_RESTORE_CONTROLLER(kbdc) !(kbdcp(kbdc)->quirks \
 512     & KBDC_QUIRK_KEEP_ACTIVATED)
 513
 514 /* Tunables */
 515 static int tap_enabled = -1;
 516 static int verbose = PSM_DEBUG;
 517 static int synaptics_support = 1;
 518 static int trackpoint_support = 1;
 519 static int elantech_support = 1;
 520
 521 /* for backward compatibility */
 522 #define OLD_MOUSE_GETHWINFO     _IOR('M', 1, old_mousehw_t)
 523 #define OLD_MOUSE_GETMODE       _IOR('M', 2, old_mousemode_t)
 524 #define OLD_MOUSE_SETMODE       _IOW('M', 3, old_mousemode_t)
 525
 526 typedef struct old_mousehw {
 527         int     buttons;
 528         int     iftype;
 529         int     type;
 530         int     hwid;
 531 } old_mousehw_t;
 532
 533 typedef struct old_mousemode {
 534         int     protocol;
 535         int     rate;
 536         int     resolution;
 537         int     accelfactor;
 538 } old_mousemode_t;
 539
 540 #define SYN_OFFSET(field) offsetof(struct psm_softc, syninfo.field)
 541 enum {
 542         SYNAPTICS_SYSCTL_MIN_PRESSURE =         SYN_OFFSET(min_pressure),
 543         SYNAPTICS_SYSCTL_MAX_PRESSURE =         SYN_OFFSET(max_pressure),
 544         SYNAPTICS_SYSCTL_MAX_WIDTH =            SYN_OFFSET(max_width),
 545         SYNAPTICS_SYSCTL_MARGIN_TOP =           SYN_OFFSET(margin_top),
 546         SYNAPTICS_SYSCTL_MARGIN_RIGHT =         SYN_OFFSET(margin_right),
 547         SYNAPTICS_SYSCTL_MARGIN_BOTTOM =        SYN_OFFSET(margin_bottom),
 548         SYNAPTICS_SYSCTL_MARGIN_LEFT =          SYN_OFFSET(margin_left),
 549         SYNAPTICS_SYSCTL_NA_TOP =               SYN_OFFSET(na_top),
 550         SYNAPTICS_SYSCTL_NA_RIGHT =             SYN_OFFSET(na_right),
 551         SYNAPTICS_SYSCTL_NA_BOTTOM =            SYN_OFFSET(na_bottom),
 552         SYNAPTICS_SYSCTL_NA_LEFT =              SYN_OFFSET(na_left),
 553         SYNAPTICS_SYSCTL_WINDOW_MIN =           SYN_OFFSET(window_min),
 554         SYNAPTICS_SYSCTL_WINDOW_MAX =           SYN_OFFSET(window_max),
 555         SYNAPTICS_SYSCTL_MULTIPLICATOR =        SYN_OFFSET(multiplicator),
 556         SYNAPTICS_SYSCTL_WEIGHT_CURRENT =       SYN_OFFSET(weight_current),
 557         SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS =      SYN_OFFSET(weight_previous),
 558         SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS_NA =   SYN_OFFSET(weight_previous_na),
 559         SYNAPTICS_SYSCTL_WEIGHT_LEN_SQUARED =   SYN_OFFSET(weight_len_squared),
 560         SYNAPTICS_SYSCTL_DIV_MIN =              SYN_OFFSET(div_min),
 561         SYNAPTICS_SYSCTL_DIV_MAX =              SYN_OFFSET(div_max),
 562         SYNAPTICS_SYSCTL_DIV_MAX_NA =           SYN_OFFSET(div_max_na),
 563         SYNAPTICS_SYSCTL_DIV_LEN =              SYN_OFFSET(div_len),
 564         SYNAPTICS_SYSCTL_TAP_MAX_DELTA =        SYN_OFFSET(tap_max_delta),
 565         SYNAPTICS_SYSCTL_TAP_MIN_QUEUE =        SYN_OFFSET(tap_min_queue),
 566         SYNAPTICS_SYSCTL_TAPHOLD_TIMEOUT =      SYN_OFFSET(taphold_timeout),
 567         SYNAPTICS_SYSCTL_VSCROLL_HOR_AREA =     SYN_OFFSET(vscroll_hor_area),
 568         SYNAPTICS_SYSCTL_VSCROLL_VER_AREA =     SYN_OFFSET(vscroll_ver_area),
 569         SYNAPTICS_SYSCTL_VSCROLL_MIN_DELTA =    SYN_OFFSET(vscroll_min_delta),
 570         SYNAPTICS_SYSCTL_VSCROLL_DIV_MIN =      SYN_OFFSET(vscroll_div_min),
 571         SYNAPTICS_SYSCTL_VSCROLL_DIV_MAX =      SYN_OFFSET(vscroll_div_max),
 572         SYNAPTICS_SYSCTL_TOUCHPAD_OFF =         SYN_OFFSET(touchpad_off),
 573         SYNAPTICS_SYSCTL_SOFTBUTTONS_Y =        SYN_OFFSET(softbuttons_y),
 574         SYNAPTICS_SYSCTL_SOFTBUTTON2_X =        SYN_OFFSET(softbutton2_x),
 575         SYNAPTICS_SYSCTL_SOFTBUTTON3_X =        SYN_OFFSET(softbutton3_x),
 576         SYNAPTICS_SYSCTL_THREE_FINGER_DRAG =    SYN_OFFSET(three_finger_drag),
 577         SYNAPTICS_SYSCTL_NATURAL_SCROLL =       SYN_OFFSET(natural_scroll),
 578 #define SYNAPTICS_SYSCTL_LAST   SYNAPTICS_SYSCTL_NATURAL_SCROLL
 579 };
 580
 581 /* packet formatting function */
 582 typedef int     packetfunc_t(struct psm_softc *, u_char *, int *, int,
 583     mousestatus_t *);
 584
 585 /* function prototypes */
 586 static void     psmidentify(driver_t *, device_t);
 587 static int      psmprobe(device_t);
 588 static int      psmattach(device_t);
 589 static int      psmdetach(device_t);
 590 static int      psmresume(device_t);
 591
 592 static d_open_t         psm_cdev_open;
 593 static d_close_t        psm_cdev_close;
 594 static d_read_t         psmread;
 595 static d_write_t        psmwrite;
 596 static d_ioctl_t        psmioctl;
 597 static d_poll_t         psmpoll;
 598
 599 static int      psmopen(struct psm_softc *);
 600 static int      psmclose(struct psm_softc *);
 601
 602 #ifdef EVDEV_SUPPORT
 603 static evdev_open_t     psm_ev_open_r;
 604 static evdev_close_t    psm_ev_close_r;
 605 static evdev_open_t     psm_ev_open_a;
 606 static evdev_close_t    psm_ev_close_a;
 607 #endif
 608
 609 static int      enable_aux_dev(KBDC);
 610 static int      disable_aux_dev(KBDC);
 611 static int      get_mouse_status(KBDC, int *, int, int);
 612 static int      get_aux_id(KBDC);
 613 static int      set_mouse_sampling_rate(KBDC, int);
 614 static int      set_mouse_scaling(KBDC, int);
 615 static int      set_mouse_resolution(KBDC, int);
 616 static int      set_mouse_mode(KBDC);
 617 static int      get_mouse_buttons(KBDC);
 618 static int      is_a_mouse(int);
 619 static void     recover_from_error(KBDC);
 620 static int      restore_controller(KBDC, int);
 621 static int      doinitialize(struct psm_softc *, mousemode_t *);
 622 static int      doopen(struct psm_softc *, int);
 623 static int      reinitialize(struct psm_softc *, int);
 624 static char     *model_name(int);
 625 static void     psmsoftintr(void *);
 626 static void     psmsoftintridle(void *);
 627 static void     psmintr(void *);
 628 static void     psmtimeout(void *);
 629 static int      timeelapsed(const struct timeval *, int, int,
 630                     const struct timeval *);
 631 static void     dropqueue(struct psm_softc *);
 632 static void     flushpackets(struct psm_softc *);
 633 static void     proc_mmanplus(struct psm_softc *, packetbuf_t *,
 634                     mousestatus_t *, int *, int *, int *);
 635 static int      proc_synaptics(struct psm_softc *, packetbuf_t *,
 636                     mousestatus_t *, int *, int *, int *);
 637 static int      proc_synaptics_mux(struct psm_softc *, packetbuf_t *);
 638 static void     proc_versapad(struct psm_softc *, packetbuf_t *,
 639                     mousestatus_t *, int *, int *, int *);
 640 static int      proc_elantech(struct psm_softc *, packetbuf_t *,
 641                     mousestatus_t *, int *, int *, int *);
 642 static int      psmpalmdetect(struct psm_softc *, finger_t *, int);
 643 static void     psmgestures(struct psm_softc *, finger_t *, int,
 644                     mousestatus_t *);
 645 static void     psmsmoother(struct psm_softc *, finger_t *, int,
 646                     mousestatus_t *, int *, int *);
 647 static int      tame_mouse(struct psm_softc *, packetbuf_t *, mousestatus_t *,
 648                     u_char *);
 649
 650 /* vendor specific features */
 651 enum probearg { PROBE, REINIT };
 652 typedef int     probefunc_t(struct psm_softc *, enum probearg);
 653
 654 static int      mouse_id_proc1(KBDC, int, int, int *);
 655 static int      mouse_ext_command(KBDC, int);
 656
 657 static probefunc_t      enable_groller;
 658 static probefunc_t      enable_gmouse;
 659 static probefunc_t      enable_aglide;
 660 static probefunc_t      enable_kmouse;
 661 static probefunc_t      enable_msexplorer;
 662 static probefunc_t      enable_msintelli;
 663 static probefunc_t      enable_4dmouse;
 664 static probefunc_t      enable_4dplus;
 665 static probefunc_t      enable_mmanplus;
 666 static probefunc_t      enable_synaptics;
 667 static probefunc_t      enable_synaptics_mux;
 668 static probefunc_t      enable_trackpoint;
 669 static probefunc_t      enable_versapad;
 670 static probefunc_t      enable_elantech;
 671
 672 static void set_trackpoint_parameters(struct psm_softc *sc);
 673 static void synaptics_passthrough_on(struct psm_softc *sc);
 674 static void synaptics_passthrough_off(struct psm_softc *sc);
 675 static int synaptics_preferred_mode(struct psm_softc *sc);
 676 static void synaptics_set_mode(struct psm_softc *sc, int mode_byte);
 677
 678 static struct {
 679         int             model;
 680         u_char          syncmask;
 681         int             packetsize;
 682         probefunc_t     *probefunc;
 683 } vendortype[] = {
 684         /*
 685          * WARNING: the order of probe is very important.  Don't mess it
 686          * unless you know what you are doing.
 687          */
 688         { MOUSE_MODEL_SYNAPTICS,        /* Synaptics Touchpad on Active Mux */
 689           0x00, MOUSE_PS2_PACKETSIZE, enable_synaptics_mux },
 690         { MOUSE_MODEL_NET,              /* Genius NetMouse */
 691           0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_gmouse },
 692         { MOUSE_MODEL_NETSCROLL,        /* Genius NetScroll */
 693           0xc8, 6, enable_groller },
 694         { MOUSE_MODEL_MOUSEMANPLUS,     /* Logitech MouseMan+ */
 695           0x08, MOUSE_PS2_PACKETSIZE, enable_mmanplus },
 696         { MOUSE_MODEL_EXPLORER,         /* Microsoft IntelliMouse Explorer */
 697           0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msexplorer },
 698         { MOUSE_MODEL_4D,               /* A4 Tech 4D Mouse */
 699           0x08, MOUSE_4D_PACKETSIZE, enable_4dmouse },
 700         { MOUSE_MODEL_4DPLUS,           /* A4 Tech 4D+ Mouse */
 701           0xc8, MOUSE_4DPLUS_PACKETSIZE, enable_4dplus },
 702         { MOUSE_MODEL_SYNAPTICS,        /* Synaptics Touchpad */
 703           0xc0, MOUSE_SYNAPTICS_PACKETSIZE, enable_synaptics },
 704         { MOUSE_MODEL_ELANTECH,         /* Elantech Touchpad */
 705           0x04, MOUSE_ELANTECH_PACKETSIZE, enable_elantech },
 706         { MOUSE_MODEL_INTELLI,          /* Microsoft IntelliMouse */
 707           0x08, MOUSE_PS2INTELLI_PACKETSIZE, enable_msintelli },
 708         { MOUSE_MODEL_GLIDEPOINT,       /* ALPS GlidePoint */
 709           0xc0, MOUSE_PS2_PACKETSIZE, enable_aglide },
 710         { MOUSE_MODEL_THINK,            /* Kensington ThinkingMouse */
 711           0x80, MOUSE_PS2_PACKETSIZE, enable_kmouse },
 712         { MOUSE_MODEL_VERSAPAD,         /* Interlink electronics VersaPad */
 713           0xe8, MOUSE_PS2VERSA_PACKETSIZE, enable_versapad },
 714         { MOUSE_MODEL_TRACKPOINT,       /* IBM/Lenovo TrackPoint */
 715           0xc0, MOUSE_PS2_PACKETSIZE, enable_trackpoint },
 716         { MOUSE_MODEL_GENERIC,
 717           0xc0, MOUSE_PS2_PACKETSIZE, NULL },
 718 };
 719 #define GENERIC_MOUSE_ENTRY (nitems(vendortype) - 1)
 720
 721 /* device driver declarateion */
 722 static device_method_t psm_methods[] = {
 723         /* Device interface */
 724         DEVMETHOD(device_identify,      psmidentify),
 725         DEVMETHOD(device_probe,         psmprobe),
 726         DEVMETHOD(device_attach,        psmattach),
 727         DEVMETHOD(device_detach,        psmdetach),
 728         DEVMETHOD(device_resume,        psmresume),
 729
 730         { 0, 0 }
 731 };
 732
 733 static driver_t psm_driver = {
 734         PSM_DRIVER_NAME,
 735         psm_methods,
 736         sizeof(struct psm_softc),
 737 };
 738
 739 static struct cdevsw psm_cdevsw = {
 740         .d_version =    D_VERSION,
 741         .d_flags =      D_NEEDGIANT,
 742         .d_open =       psm_cdev_open,
 743         .d_close =      psm_cdev_close,
 744         .d_read =       psmread,
 745         .d_write =      psmwrite,
 746         .d_ioctl =      psmioctl,
 747         .d_poll =       psmpoll,
 748         .d_name =       PSM_DRIVER_NAME,
 749 };
 750
 751 #ifdef EVDEV_SUPPORT
 752 static const struct evdev_methods psm_ev_methods_r = {
 753         .ev_open = psm_ev_open_r,
 754         .ev_close = psm_ev_close_r,
 755 };
 756 static const struct evdev_methods psm_ev_methods_a = {
 757         .ev_open = psm_ev_open_a,
 758         .ev_close = psm_ev_close_a,
 759 };
 760 #endif
 761
 762 /* device I/O routines */
 763 static int
 764 enable_aux_dev(KBDC kbdc)
 765 {
 766         int res;
 767
 768         res = send_aux_command(kbdc, PSMC_ENABLE_DEV);
 769         VLOG(2, (LOG_DEBUG, "psm: ENABLE_DEV return code:%04x\n", res));
 770
 771         return (res == PSM_ACK);
 772 }
 773
 774 static int
 775 disable_aux_dev(KBDC kbdc)
 776 {
 777         int res;
 778
 779         res = send_aux_command(kbdc, PSMC_DISABLE_DEV);
 780         VLOG(2, (LOG_DEBUG, "psm: DISABLE_DEV return code:%04x\n", res));
 781
 782         return (res == PSM_ACK);
 783 }
 784
 785 static int
 786 get_mouse_status(KBDC kbdc, int *status, int flag, int len)
 787 {
 788         int cmd;
 789         int res;
 790         int i;
 791
 792         switch (flag) {
 793         case 0:
 794         default:
 795                 cmd = PSMC_SEND_DEV_STATUS;
 796                 break;
 797         case 1:
 798                 cmd = PSMC_SEND_DEV_DATA;
 799                 break;
 800         }
 801         empty_aux_buffer(kbdc, 5);
 802         res = send_aux_command(kbdc, cmd);
 803         VLOG(2, (LOG_DEBUG, "psm: SEND_AUX_DEV_%s return code:%04x\n",
 804             (flag == 1) ? "DATA" : "STATUS", res));
 805         if (res != PSM_ACK)
 806                 return (0);
 807
 808         for (i = 0; i < len; ++i) {
 809                 status[i] = read_aux_data(kbdc);
 810                 if (status[i] < 0)
 811                         break;
 812         }
 813         if (len >= 3) {
 814                 for (; i < 3; ++i)
 815                         status[i] = 0;
 816                 VLOG(1, (LOG_DEBUG, "psm: %s %02x %02x %02x\n",
 817                     (flag == 1) ? "data" : "status", status[0], status[1], status[2]));
 818         }
 819
 820         return (i);
 821 }
 822
 823 static int
 824 get_aux_id(KBDC kbdc)
 825 {
 826         int res;
 827         int id;
 828
 829         empty_aux_buffer(kbdc, 5);
 830         res = send_aux_command(kbdc, PSMC_SEND_DEV_ID);
 831         VLOG(2, (LOG_DEBUG, "psm: SEND_DEV_ID return code:%04x\n", res));
 832         if (res != PSM_ACK)
 833                 return (-1);
 834
 835         /* 10ms delay */
 836         DELAY(10000);
 837
 838         id = read_aux_data(kbdc);
 839         VLOG(2, (LOG_DEBUG, "psm: device ID: %04x\n", id));
 840
 841         return (id);
 842 }
 843
 844 static int
 845 set_mouse_sampling_rate(KBDC kbdc, int rate)
 846 {
 847         int res;
 848
 849         res = send_aux_command_and_data(kbdc, PSMC_SET_SAMPLING_RATE, rate);
 850         VLOG(2, (LOG_DEBUG, "psm: SET_SAMPLING_RATE (%d) %04x\n", rate, res));
 851
 852         return ((res == PSM_ACK) ? rate : -1);
 853 }
 854
 855 static int
 856 set_mouse_scaling(KBDC kbdc, int scale)
 857 {
 858         int res;
 859
 860         switch (scale) {
 861         case 1:
 862         default:
 863                 scale = PSMC_SET_SCALING11;
 864                 break;
 865         case 2:
 866                 scale = PSMC_SET_SCALING21;
 867                 break;
 868         }
 869         res = send_aux_command(kbdc, scale);
 870         VLOG(2, (LOG_DEBUG, "psm: SET_SCALING%s return code:%04x\n",
 871             (scale == PSMC_SET_SCALING21) ? "21" : "11", res));
 872
 873         return (res == PSM_ACK);
 874 }
 875
 876 /* `val' must be 0 through PSMD_MAX_RESOLUTION */
 877 static int
 878 set_mouse_resolution(KBDC kbdc, int val)
 879 {
 880         int res;
 881
 882         res = send_aux_command_and_data(kbdc, PSMC_SET_RESOLUTION, val);
 883         VLOG(2, (LOG_DEBUG, "psm: SET_RESOLUTION (%d) %04x\n", val, res));
 884
 885         return ((res == PSM_ACK) ? val : -1);
 886 }
 887
 888 /*
 889  * NOTE: once `set_mouse_mode()' is called, the mouse device must be
 890  * re-enabled by calling `enable_aux_dev()'
 891  */
 892 static int
 893 set_mouse_mode(KBDC kbdc)
 894 {
 895         int res;
 896
 897         res = send_aux_command(kbdc, PSMC_SET_STREAM_MODE);
 898         VLOG(2, (LOG_DEBUG, "psm: SET_STREAM_MODE return code:%04x\n", res));
 899
 900         return (res == PSM_ACK);
 901 }
 902
 903 static int
 904 get_mouse_buttons(KBDC kbdc)
 905 {
 906         int c = 2;              /* assume two buttons by default */
 907         int status[3];
 908
 909         /*
 910          * NOTE: a special sequence to obtain Logitech Mouse specific
 911          * information: set resolution to 25 ppi, set scaling to 1:1, set
 912          * scaling to 1:1, set scaling to 1:1. Then the second byte of the
 913          * mouse status bytes is the number of available buttons.
 914          * Some manufactures also support this sequence.
 915          */
 916         if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
 917                 return (c);
 918         if (set_mouse_scaling(kbdc, 1) && set_mouse_scaling(kbdc, 1) &&
 919             set_mouse_scaling(kbdc, 1) &&
 920             get_mouse_status(kbdc, status, 0, 3) >= 3 && status[1] != 0)
 921                 return (status[1]);
 922         return (c);
 923 }
 924
 925 /* misc subroutines */
 926 /*
 927  * Someday, I will get the complete list of valid pointing devices and
 928  * their IDs... XXX
 929  */
 930 static int
 931 is_a_mouse(int id)
 932 {
 933 #if 0
 934         static int valid_ids[] = {
 935                 PSM_MOUSE_ID,           /* mouse */
 936                 PSM_BALLPOINT_ID,       /* ballpoint device */
 937                 PSM_INTELLI_ID,         /* Intellimouse */
 938                 PSM_EXPLORER_ID,        /* Intellimouse Explorer */
 939                 -1                      /* end of table */
 940         };
 941         int i;
 942
 943         for (i = 0; valid_ids[i] >= 0; ++i)
 944         if (valid_ids[i] == id)
 945                 return (TRUE);
 946         return (FALSE);
 947 #else
 948         return (TRUE);
 949 #endif
 950 }
 951
 952 static char *
 953 model_name(int model)
 954 {
 955         static struct {
 956                 int     model_code;
 957                 char    *model_name;
 958         } models[] = {
 959                 { MOUSE_MODEL_NETSCROLL,        "NetScroll" },
 960                 { MOUSE_MODEL_NET,              "NetMouse/NetScroll Optical" },
 961                 { MOUSE_MODEL_GLIDEPOINT,       "GlidePoint" },
 962                 { MOUSE_MODEL_THINK,            "ThinkingMouse" },
 963                 { MOUSE_MODEL_INTELLI,          "IntelliMouse" },
 964                 { MOUSE_MODEL_MOUSEMANPLUS,     "MouseMan+" },
 965                 { MOUSE_MODEL_VERSAPAD,         "VersaPad" },
 966                 { MOUSE_MODEL_EXPLORER,         "IntelliMouse Explorer" },
 967                 { MOUSE_MODEL_4D,               "4D Mouse" },
 968                 { MOUSE_MODEL_4DPLUS,           "4D+ Mouse" },
 969                 { MOUSE_MODEL_SYNAPTICS,        "Synaptics Touchpad" },
 970                 { MOUSE_MODEL_TRACKPOINT,       "IBM/Lenovo TrackPoint" },
 971                 { MOUSE_MODEL_ELANTECH,         "Elantech Touchpad" },
 972                 { MOUSE_MODEL_GENERIC,          "Generic PS/2 mouse" },
 973                 { MOUSE_MODEL_UNKNOWN,          "Unknown" },
 974         };
 975         int i;
 976
 977         for (i = 0; models[i].model_code != MOUSE_MODEL_UNKNOWN; ++i)
 978                 if (models[i].model_code == model)
 979                         break;
 980         return (models[i].model_name);
 981 }
 982
 983 static void
 984 recover_from_error(KBDC kbdc)
 985 {
 986         /* discard anything left in the output buffer */
 987         empty_both_buffers(kbdc, 10);
 988
 989 #if 0
 990         /*
 991          * NOTE: KBDC_RESET_KBD may not restore the communication between the
 992          * keyboard and the controller.
 993          */
 994         reset_kbd(kbdc);
 995 #else
 996         /*
 997          * NOTE: somehow diagnostic and keyboard port test commands bring the
 998          * keyboard back.
 999          */
1000         if (!test_controller(kbdc))
1001                 log(LOG_ERR, "psm: keyboard controller failed.\n");
1002         /* if there isn't a keyboard in the system, the following error is OK */
1003         if (test_kbd_port(kbdc) != 0)
1004                 VLOG(1, (LOG_ERR, "psm: keyboard port failed.\n"));
1005 #endif
1006 }
1007
1008 static int
1009 restore_controller(KBDC kbdc, int command_byte)
1010 {
1011         empty_both_buffers(kbdc, 10);
1012
1013         if (!set_controller_command_byte(kbdc, 0xff, command_byte)) {
1014                 log(LOG_ERR, "psm: failed to restore the keyboard controller "
1015                     "command byte.\n");
1016                 empty_both_buffers(kbdc, 10);
1017                 return (FALSE);
1018         } else {
1019                 empty_both_buffers(kbdc, 10);
1020                 return (TRUE);
1021         }
1022 }
1023
1024 /*
1025  * Re-initialize the aux port and device. The aux port must be enabled
1026  * and its interrupt must be disabled before calling this routine.
1027  * The aux device will be disabled before returning.
1028  * The keyboard controller must be locked via `kbdc_lock()' before
1029  * calling this routine.
1030  */
1031 static int
1032 doinitialize(struct psm_softc *sc, mousemode_t *mode)
1033 {
1034         KBDC kbdc = sc->kbdc;
1035         int stat[3];
1036         int i;
1037
1038         switch((i = test_aux_port(kbdc))) {
1039         case 1: /* ignore these errors */
1040         case 2:
1041         case 3:
1042         case PSM_ACK:
1043                 if (verbose)
1044                         log(LOG_DEBUG,
1045                             "psm%d: strange result for test aux port (%d).\n",
1046                             sc->unit, i);
1047                 /* FALLTHROUGH */
1048         case 0:         /* no error */
1049                 break;
1050         case -1:        /* time out */
1051         default:        /* error */
1052                 recover_from_error(kbdc);
1053                 if (sc->config & PSM_CONFIG_IGNPORTERROR)
1054                         break;
1055                 log(LOG_ERR, "psm%d: the aux port is not functioning (%d).\n",
1056                     sc->unit, i);
1057                 return (FALSE);
1058         }
1059
1060         if (sc->config & PSM_CONFIG_NORESET) {
1061                 /*
1062                  * Don't try to reset the pointing device.  It may possibly
1063                  * be left in the unknown state, though...
1064                  */
1065         } else {
1066                 /*
1067                  * NOTE: some controllers appears to hang the `keyboard' when
1068                  * the aux port doesn't exist and `PSMC_RESET_DEV' is issued.
1069                  */
1070                 if (!reset_aux_dev(kbdc)) {
1071                         recover_from_error(kbdc);
1072                         log(LOG_ERR, "psm%d: failed to reset the aux device.\n",
1073                             sc->unit);
1074                         return (FALSE);
1075                 }
1076         }
1077
1078         /*
1079          * both the aux port and the aux device is functioning, see
1080          * if the device can be enabled.
1081          */
1082         if (!enable_aux_dev(kbdc) || !disable_aux_dev(kbdc)) {
1083                 log(LOG_ERR, "psm%d: failed to enable the aux device.\n",
1084                     sc->unit);
1085                 return (FALSE);
1086         }
1087         empty_both_buffers(kbdc, 10);   /* remove stray data if any */
1088
1089         /* Re-enable the mouse. */
1090         for (i = 0; vendortype[i].probefunc != NULL; ++i)
1091                 if (vendortype[i].model == sc->hw.model)
1092                         (*vendortype[i].probefunc)(sc, REINIT);
1093
1094         /* set mouse parameters */
1095         if (mode != (mousemode_t *)NULL) {
1096                 if (mode->rate > 0)
1097                         mode->rate = set_mouse_sampling_rate(kbdc, mode->rate);
1098                 if (mode->resolution >= 0)
1099                         mode->resolution =
1100                             set_mouse_resolution(kbdc, mode->resolution);
1101                 set_mouse_scaling(kbdc, 1);
1102                 set_mouse_mode(kbdc);
1103         }
1104
1105         /* Record sync on the next data packet we see. */
1106         sc->flags |= PSM_NEED_SYNCBITS;
1107
1108         /* just check the status of the mouse */
1109         if (get_mouse_status(kbdc, stat, 0, 3) < 3)
1110                 log(LOG_DEBUG, "psm%d: failed to get status (doinitialize).\n",
1111                     sc->unit);
1112
1113         return (TRUE);
1114 }
1115
1116 static int
1117 doopen(struct psm_softc *sc, int command_byte)
1118 {
1119         int stat[3];
1120         int mux_enabled = FALSE;
1121
1122         /*
1123          * FIXME: Synaptics TouchPad seems to go back to Relative Mode with
1124          * no obvious reason. Thus we check the current mode and restore the
1125          * Absolute Mode if it was cleared.
1126          *
1127          * The previous hack at the end of psmprobe() wasn't efficient when
1128          * moused(8) was restarted.
1129          *
1130          * A Reset (FF) or Set Defaults (F6) command would clear the
1131          * Absolute Mode bit. But a verbose boot or debug.psm.loglevel=5
1132          * doesn't show any evidence of such a command.
1133          */
1134         if (sc->hw.model == MOUSE_MODEL_SYNAPTICS) {
1135                 if (sc->muxport != PSM_NOMUX) {
1136                         mux_enabled = enable_aux_mux(sc->kbdc) >= 0;
1137                         if (mux_enabled)
1138                                 set_active_aux_mux_port(sc->kbdc, sc->muxport);
1139                         else
1140                                 log(LOG_ERR, "psm%d: failed to enable "
1141                                     "active multiplexing mode.\n",
1142                                     sc->unit);
1143                 }
1144                 mouse_ext_command(sc->kbdc, SYNAPTICS_READ_MODES);
1145                 get_mouse_status(sc->kbdc, stat, 0, 3);
1146                 if ((SYNAPTICS_VERSION_GE(sc->synhw, 7, 5) ||
1147                      stat[1] == 0x47) &&
1148                      stat[2] == 0x40) {
1149                         synaptics_set_mode(sc, synaptics_preferred_mode(sc));
1150                         VLOG(5, (LOG_DEBUG, "psm%d: Synaptis Absolute Mode "
1151                             "hopefully restored\n",
1152                             sc->unit));
1153                 }
1154                 if (mux_enabled)
1155                         disable_aux_mux(sc->kbdc);
1156         }
1157
1158         /*
1159          * A user may want to disable tap and drag gestures on a Synaptics
1160          * TouchPad when it operates in Relative Mode.
1161          */
1162         if (sc->hw.model == MOUSE_MODEL_GENERIC) {
1163                 if (tap_enabled > 0) {
1164                         VLOG(2, (LOG_DEBUG,
1165                             "psm%d: enable tap and drag gestures\n",
1166                             sc->unit));
1167                         synaptics_set_mode(sc, synaptics_preferred_mode(sc));
1168                 } else if (tap_enabled == 0) {
1169                         VLOG(2, (LOG_DEBUG,
1170                             "psm%d: disable tap and drag gestures\n",
1171                             sc->unit));
1172                         synaptics_set_mode(sc, synaptics_preferred_mode(sc));
1173                 }
1174         }
1175
1176         /* enable the mouse device */
1177         if (!enable_aux_dev(sc->kbdc)) {
1178                 /* MOUSE ERROR: failed to enable the mouse because:
1179                  * 1) the mouse is faulty,
1180                  * 2) the mouse has been removed(!?)
1181                  * In the latter case, the keyboard may have hung, and need
1182                  * recovery procedure...
1183                  */
1184                 recover_from_error(sc->kbdc);
1185 #if 0
1186                 /* FIXME: we could reset the mouse here and try to enable
1187                  * it again. But it will take long time and it's not a good
1188                  * idea to disable the keyboard that long...
1189                  */
1190                 if (!doinitialize(sc, &sc->mode) || !enable_aux_dev(sc->kbdc)) {
1191                         recover_from_error(sc->kbdc);
1192 #else
1193                 {
1194 #endif
1195                         restore_controller(sc->kbdc, command_byte);
1196                         /* mark this device is no longer available */
1197                         sc->state &= ~PSM_VALID;
1198                         log(LOG_ERR,
1199                             "psm%d: failed to enable the device (doopen).\n",
1200                         sc->unit);
1201                         return (EIO);
1202                 }
1203         }
1204
1205         if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
1206                 log(LOG_DEBUG, "psm%d: failed to get status (doopen).\n",
1207                     sc->unit);
1208
1209         /* enable the aux port and interrupt */
1210         if (!set_controller_command_byte(sc->kbdc,
1211             kbdc_get_device_mask(sc->kbdc),
1212             (command_byte & KBD_KBD_CONTROL_BITS) |
1213             KBD_ENABLE_AUX_PORT | KBD_ENABLE_AUX_INT)) {
1214                 /* CONTROLLER ERROR */
1215                 disable_aux_dev(sc->kbdc);
1216                 restore_controller(sc->kbdc, command_byte);
1217                 log(LOG_ERR,
1218                     "psm%d: failed to enable the aux interrupt (doopen).\n",
1219                     sc->unit);
1220                 return (EIO);
1221         }
1222
1223         /* start the watchdog timer */
1224         sc->watchdog = FALSE;
1225         callout_reset(&sc->callout, hz * 2, psmtimeout, sc);
1226
1227         return (0);
1228 }
1229
1230 static int
1231 reinitialize(struct psm_softc *sc, int doinit)
1232 {
1233         int err;
1234         int c;
1235         int s;
1236
1237         /* don't let anybody mess with the aux device */
1238         if (!kbdc_lock(sc->kbdc, TRUE))
1239                 return (EIO);
1240         s = spltty();
1241
1242         /* block our watchdog timer */
1243         sc->watchdog = FALSE;
1244         callout_stop(&sc->callout);
1245
1246         /* save the current controller command byte */
1247         empty_both_buffers(sc->kbdc, 10);
1248         c = get_controller_command_byte(sc->kbdc);
1249         VLOG(2, (LOG_DEBUG,
1250             "psm%d: current command byte: %04x (reinitialize).\n",
1251             sc->unit, c));
1252
1253         /* enable the aux port but disable the aux interrupt and the keyboard */
1254         if ((c == -1) || !set_controller_command_byte(sc->kbdc,
1255             kbdc_get_device_mask(sc->kbdc),
1256             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
1257             KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1258                 /* CONTROLLER ERROR */
1259                 splx(s);
1260                 kbdc_lock(sc->kbdc, FALSE);
1261                 log(LOG_ERR,
1262                     "psm%d: unable to set the command byte (reinitialize).\n",
1263                     sc->unit);
1264                 return (EIO);
1265         }
1266
1267         /* flush any data */
1268         if (sc->state & PSM_VALID) {
1269                 /* this may fail; but never mind... */
1270                 disable_aux_dev(sc->kbdc);
1271                 empty_aux_buffer(sc->kbdc, 10);
1272         }
1273         flushpackets(sc);
1274         sc->syncerrors = 0;
1275         sc->pkterrors = 0;
1276         memset(&sc->lastinputerr, 0, sizeof(sc->lastinputerr));
1277
1278         /* try to detect the aux device; are you still there? */
1279         err = 0;
1280         if (doinit) {
1281                 if (doinitialize(sc, &sc->mode)) {
1282                         /* yes */
1283                         sc->state |= PSM_VALID;
1284                 } else {
1285                         /* the device has gone! */
1286                         restore_controller(sc->kbdc, c);
1287                         sc->state &= ~PSM_VALID;
1288                         log(LOG_ERR,
1289                             "psm%d: the aux device has gone! (reinitialize).\n",
1290                             sc->unit);
1291                         err = ENXIO;
1292                 }
1293         }
1294         splx(s);
1295
1296         /* restore the driver state */
1297         if ((sc->state & (PSM_OPEN | PSM_EV_OPEN_R | PSM_EV_OPEN_A)) &&
1298             (err == 0)) {
1299                 /* enable the aux device and the port again */
1300                 err = doopen(sc, c);
1301                 if (err != 0)
1302                         log(LOG_ERR, "psm%d: failed to enable the device "
1303                             "(reinitialize).\n", sc->unit);
1304         } else {
1305                 /* restore the keyboard port and disable the aux port */
1306                 if (!set_controller_command_byte(sc->kbdc,
1307                     kbdc_get_device_mask(sc->kbdc),
1308                     (c & KBD_KBD_CONTROL_BITS) |
1309                     KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1310                         /* CONTROLLER ERROR */
1311                         log(LOG_ERR, "psm%d: failed to disable the aux port "
1312                             "(reinitialize).\n", sc->unit);
1313                         err = EIO;
1314                 }
1315         }
1316
1317         kbdc_lock(sc->kbdc, FALSE);
1318         return (err);
1319 }
1320
1321 /* psm driver entry points */
1322
1323 static void
1324 psmidentify(driver_t *driver, device_t parent)
1325 {
1326         device_t psmc;
1327         device_t psm;
1328         u_long irq;
1329         int unit;
1330
1331         unit = device_get_unit(parent);
1332
1333         /* always add at least one child */
1334         psm = BUS_ADD_CHILD(parent, KBDC_RID_AUX, driver->name, unit);
1335         if (psm == NULL)
1336                 return;
1337
1338         irq = bus_get_resource_start(psm, SYS_RES_IRQ, KBDC_RID_AUX);
1339         if (irq > 0)
1340                 return;
1341
1342         /*
1343          * If the PS/2 mouse device has already been reported by ACPI or
1344          * PnP BIOS, obtain the IRQ resource from it.
1345          * (See psmcpnp_attach() below.)
1346          */
1347         psmc = device_find_child(device_get_parent(parent),
1348             PSMCPNP_DRIVER_NAME, unit);
1349         if (psmc == NULL)
1350                 return;
1351         irq = bus_get_resource_start(psmc, SYS_RES_IRQ, 0);
1352         if (irq <= 0)
1353                 return;
1354         bus_delete_resource(psmc, SYS_RES_IRQ, 0);
1355         bus_set_resource(psm, SYS_RES_IRQ, KBDC_RID_AUX, irq, 1);
1356 }
1357
1358 #define endprobe(v)     do {                    \
1359         if (bootverbose)                        \
1360                 --verbose;                      \
1361         kbdc_set_device_mask(sc->kbdc, mask);   \
1362         kbdc_lock(sc->kbdc, FALSE);             \
1363         return (v);                             \
1364 } while (0)
1365
1366 static int
1367 psmprobe(device_t dev)
1368 {
1369         int unit = device_get_unit(dev);
1370         struct psm_softc *sc = device_get_softc(dev);
1371         int stat[3];
1372         int command_byte;
1373         int mask;
1374         int rid;
1375         int i;
1376
1377 #if 0
1378         kbdc_debug(TRUE);
1379 #endif
1380
1381         /* see if IRQ is available */
1382         rid = KBDC_RID_AUX;
1383         sc->intr = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
1384         if (sc->intr == NULL) {
1385                 if (bootverbose)
1386                         device_printf(dev, "unable to allocate IRQ\n");
1387                 return (ENXIO);
1388         }
1389         bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1390
1391         sc->unit = unit;
1392         sc->kbdc = atkbdc_open(device_get_unit(device_get_parent(dev)));
1393         if (sc->kbdc == NULL)
1394                 return (ENXIO);
1395         sc->config = device_get_flags(dev) & PSM_CONFIG_FLAGS;
1396         /* XXX: for backward compatibility */
1397 #if defined(PSM_HOOKRESUME) || defined(PSM_HOOKAPM)
1398         sc->config |=
1399 #ifdef PSM_RESETAFTERSUSPEND
1400         PSM_CONFIG_INITAFTERSUSPEND;
1401 #else
1402         PSM_CONFIG_HOOKRESUME;
1403 #endif
1404 #endif /* PSM_HOOKRESUME | PSM_HOOKAPM */
1405         sc->flags = 0;
1406         sc->muxport = PSM_NOMUX;
1407         if (bootverbose)
1408                 ++verbose;
1409
1410         device_set_desc(dev, "PS/2 Mouse");
1411
1412         if (!kbdc_lock(sc->kbdc, TRUE)) {
1413                 printf("psm%d: unable to lock the controller.\n", unit);
1414                 if (bootverbose)
1415                         --verbose;
1416                 return (ENXIO);
1417         }
1418
1419         /*
1420          * NOTE: two bits in the command byte controls the operation of the
1421          * aux port (mouse port): the aux port disable bit (bit 5) and the aux
1422          * port interrupt (IRQ 12) enable bit (bit 2).
1423          */
1424
1425         /* discard anything left after the keyboard initialization */
1426         empty_both_buffers(sc->kbdc, 10);
1427
1428         /* save the current command byte; it will be used later */
1429         mask = kbdc_get_device_mask(sc->kbdc) & ~KBD_AUX_CONTROL_BITS;
1430         command_byte = get_controller_command_byte(sc->kbdc);
1431         if (verbose)
1432                 printf("psm%d: current command byte:%04x\n", unit,
1433                     command_byte);
1434         if (command_byte == -1) {
1435                 /* CONTROLLER ERROR */
1436                 printf("psm%d: unable to get the current command byte value.\n",
1437                         unit);
1438                 endprobe(ENXIO);
1439         }
1440
1441         /*
1442          * disable the keyboard port while probing the aux port, which must be
1443          * enabled during this routine
1444          */
1445         if (!set_controller_command_byte(sc->kbdc,
1446             KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
1447             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
1448             KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1449                 /*
1450                  * this is CONTROLLER ERROR; I don't know how to recover
1451                  * from this error...
1452                  */
1453                 if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1454                         restore_controller(sc->kbdc, command_byte);
1455                 printf("psm%d: unable to set the command byte.\n", unit);
1456                 endprobe(ENXIO);
1457         }
1458         write_controller_command(sc->kbdc, KBDC_ENABLE_AUX_PORT);
1459
1460         /*
1461          * NOTE: `test_aux_port()' is designed to return with zero if the aux
1462          * port exists and is functioning. However, some controllers appears
1463          * to respond with zero even when the aux port doesn't exist. (It may
1464          * be that this is only the case when the controller DOES have the aux
1465          * port but the port is not wired on the motherboard.) The keyboard
1466          * controllers without the port, such as the original AT, are
1467          * supposed to return with an error code or simply time out. In any
1468          * case, we have to continue probing the port even when the controller
1469          * passes this test.
1470          *
1471          * XXX: some controllers erroneously return the error code 1, 2 or 3
1472          * when it has a perfectly functional aux port. We have to ignore
1473          * this error code. Even if the controller HAS error with the aux
1474          * port, it will be detected later...
1475          * XXX: another incompatible controller returns PSM_ACK (0xfa)...
1476          */
1477         switch ((i = test_aux_port(sc->kbdc))) {
1478         case 1:         /* ignore these errors */
1479         case 2:
1480         case 3:
1481         case PSM_ACK:
1482                 if (verbose)
1483                         printf("psm%d: strange result for test aux port "
1484                             "(%d).\n", unit, i);
1485                 /* FALLTHROUGH */
1486         case 0:         /* no error */
1487                 break;
1488         case -1:        /* time out */
1489         default:        /* error */
1490                 recover_from_error(sc->kbdc);
1491                 if (sc->config & PSM_CONFIG_IGNPORTERROR)
1492                         break;
1493                 if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1494                         restore_controller(sc->kbdc, command_byte);
1495                 if (verbose)
1496                         printf("psm%d: the aux port is not functioning (%d).\n",
1497                             unit, i);
1498                 endprobe(ENXIO);
1499         }
1500
1501         if (sc->config & PSM_CONFIG_NORESET) {
1502                 /*
1503                  * Don't try to reset the pointing device.  It may possibly be
1504                  * left in an unknown state, though...
1505                  */
1506         } else {
1507                 /*
1508                  * NOTE: some controllers appears to hang the `keyboard' when
1509                  * the aux port doesn't exist and `PSMC_RESET_DEV' is issued.
1510                  *
1511                  * Attempt to reset the controller twice -- this helps
1512                  * pierce through some KVM switches. The second reset
1513                  * is non-fatal.
1514                  */
1515                 if (!reset_aux_dev(sc->kbdc)) {
1516                         recover_from_error(sc->kbdc);
1517                         if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1518                                 restore_controller(sc->kbdc, command_byte);
1519                         if (verbose)
1520                                 printf("psm%d: failed to reset the aux "
1521                                     "device.\n", unit);
1522                         endprobe(ENXIO);
1523                 } else if (!reset_aux_dev(sc->kbdc)) {
1524                         recover_from_error(sc->kbdc);
1525                         if (verbose >= 2)
1526                                 printf("psm%d: failed to reset the aux device "
1527                                     "(2).\n", unit);
1528                 }
1529         }
1530
1531         /*
1532          * both the aux port and the aux device are functioning, see if the
1533          * device can be enabled. NOTE: when enabled, the device will start
1534          * sending data; we shall immediately disable the device once we know
1535          * the device can be enabled.
1536          */
1537         if (!enable_aux_dev(sc->kbdc) || !disable_aux_dev(sc->kbdc)) {
1538                 /* MOUSE ERROR */
1539                 recover_from_error(sc->kbdc);
1540                 if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1541                         restore_controller(sc->kbdc, command_byte);
1542                 if (verbose)
1543                         printf("psm%d: failed to enable the aux device.\n",
1544                             unit);
1545                 endprobe(ENXIO);
1546         }
1547
1548         /* save the default values after reset */
1549         if (get_mouse_status(sc->kbdc, stat, 0, 3) >= 3) {
1550                 sc->dflt_mode.rate = sc->mode.rate = stat[2];
1551                 sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1552         } else {
1553                 sc->dflt_mode.rate = sc->mode.rate = -1;
1554                 sc->dflt_mode.resolution = sc->mode.resolution = -1;
1555         }
1556
1557         /* hardware information */
1558         sc->hw.iftype = MOUSE_IF_PS2;
1559
1560         /* verify the device is a mouse */
1561         sc->hw.hwid = get_aux_id(sc->kbdc);
1562         if (!is_a_mouse(sc->hw.hwid)) {
1563                 if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1564                         restore_controller(sc->kbdc, command_byte);
1565                 if (verbose)
1566                         printf("psm%d: unknown device type (%d).\n", unit,
1567                             sc->hw.hwid);
1568                 endprobe(ENXIO);
1569         }
1570         switch (sc->hw.hwid) {
1571         case PSM_BALLPOINT_ID:
1572                 sc->hw.type = MOUSE_TRACKBALL;
1573                 break;
1574         case PSM_MOUSE_ID:
1575         case PSM_INTELLI_ID:
1576         case PSM_EXPLORER_ID:
1577         case PSM_4DMOUSE_ID:
1578         case PSM_4DPLUS_ID:
1579                 sc->hw.type = MOUSE_MOUSE;
1580                 break;
1581         default:
1582                 sc->hw.type = MOUSE_UNKNOWN;
1583                 break;
1584         }
1585
1586         if (sc->config & PSM_CONFIG_NOIDPROBE) {
1587                 sc->hw.buttons = 2;
1588                 i = GENERIC_MOUSE_ENTRY;
1589         } else {
1590                 /* # of buttons */
1591                 sc->hw.buttons = get_mouse_buttons(sc->kbdc);
1592
1593                 /* other parameters */
1594                 for (i = 0; vendortype[i].probefunc != NULL; ++i)
1595                         if ((*vendortype[i].probefunc)(sc, PROBE)) {
1596                                 if (verbose >= 2)
1597                                         printf("psm%d: found %s\n", unit,
1598                                             model_name(vendortype[i].model));
1599                                 break;
1600                         }
1601         }
1602
1603         sc->hw.model = vendortype[i].model;
1604
1605         sc->dflt_mode.level = PSM_LEVEL_BASE;
1606         sc->dflt_mode.packetsize = MOUSE_PS2_PACKETSIZE;
1607         sc->dflt_mode.accelfactor = (sc->config & PSM_CONFIG_ACCEL) >> 4;
1608         if (sc->config & PSM_CONFIG_NOCHECKSYNC)
1609                 sc->dflt_mode.syncmask[0] = 0;
1610         else
1611                 sc->dflt_mode.syncmask[0] = vendortype[i].syncmask;
1612         if (sc->config & PSM_CONFIG_FORCETAP)
1613                 sc->dflt_mode.syncmask[0] &= ~MOUSE_PS2_TAP;
1614         sc->dflt_mode.syncmask[1] = 0;  /* syncbits */
1615         sc->mode = sc->dflt_mode;
1616         sc->mode.packetsize = vendortype[i].packetsize;
1617
1618         /* set mouse parameters */
1619 #if 0
1620         /*
1621          * A version of Logitech FirstMouse+ won't report wheel movement,
1622          * if SET_DEFAULTS is sent...  Don't use this command.
1623          * This fix was found by Takashi Nishida.
1624          */
1625         i = send_aux_command(sc->kbdc, PSMC_SET_DEFAULTS);
1626         if (verbose >= 2)
1627                 printf("psm%d: SET_DEFAULTS return code:%04x\n", unit, i);
1628 #endif
1629         if (sc->config & PSM_CONFIG_RESOLUTION)
1630                 sc->mode.resolution =
1631                     set_mouse_resolution(sc->kbdc,
1632                     (sc->config & PSM_CONFIG_RESOLUTION) - 1);
1633         else if (sc->mode.resolution >= 0)
1634                 sc->mode.resolution =
1635                     set_mouse_resolution(sc->kbdc, sc->dflt_mode.resolution);
1636         if (sc->mode.rate > 0)
1637                 sc->mode.rate =
1638                     set_mouse_sampling_rate(sc->kbdc, sc->dflt_mode.rate);
1639         set_mouse_scaling(sc->kbdc, 1);
1640
1641         /* Record sync on the next data packet we see. */
1642         sc->flags |= PSM_NEED_SYNCBITS;
1643
1644         /* just check the status of the mouse */
1645         /*
1646          * NOTE: XXX there are some arcane controller/mouse combinations out
1647          * there, which hung the controller unless there is data transmission
1648          * after ACK from the mouse.
1649          */
1650         if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
1651                 printf("psm%d: failed to get status.\n", unit);
1652         else {
1653                 /*
1654                  * When in its native mode, some mice operate with different
1655                  * default parameters than in the PS/2 compatible mode.
1656                  */
1657                 sc->dflt_mode.rate = sc->mode.rate = stat[2];
1658                 sc->dflt_mode.resolution = sc->mode.resolution = stat[1];
1659         }
1660
1661         /* disable the aux port for now... */
1662         if (!set_controller_command_byte(sc->kbdc,
1663             KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS,
1664             (command_byte & KBD_KBD_CONTROL_BITS) |
1665             KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1666                 /*
1667                  * this is CONTROLLER ERROR; I don't know the proper way to
1668                  * recover from this error...
1669                  */
1670                 if (ALWAYS_RESTORE_CONTROLLER(sc->kbdc))
1671                         restore_controller(sc->kbdc, command_byte);
1672                 printf("psm%d: unable to set the command byte.\n", unit);
1673                 endprobe(ENXIO);
1674         }
1675
1676         /* done */
1677         kbdc_set_device_mask(sc->kbdc, mask | KBD_AUX_CONTROL_BITS);
1678         kbdc_lock(sc->kbdc, FALSE);
1679         return (0);
1680 }
1681
1682 #ifdef EVDEV_SUPPORT
1683 /* Values are taken from Linux drivers for userland software compatibility */
1684 #define PS2_MOUSE_VENDOR                0x0002
1685 #define PS2_MOUSE_GENERIC_PRODUCT       0x0001
1686 #define PS2_MOUSE_SYNAPTICS_NAME        "SynPS/2 Synaptics TouchPad"
1687 #define PS2_MOUSE_SYNAPTICS_PRODUCT     0x0007
1688 #define PS2_MOUSE_TRACKPOINT_NAME       "TPPS/2 IBM TrackPoint"
1689 #define PS2_MOUSE_TRACKPOINT_PRODUCT    0x000A
1690 #define PS2_MOUSE_ELANTECH_NAME         "ETPS/2 Elantech Touchpad"
1691 #define PS2_MOUSE_ELANTECH_ST_NAME      "ETPS/2 Elantech TrackPoint"
1692 #define PS2_MOUSE_ELANTECH_PRODUCT      0x000E
1693
1694 #define ABSINFO_END     { ABS_CNT, 0, 0, 0 }
1695
1696 static void
1697 psm_support_abs_bulk(struct evdev_dev *evdev, const uint16_t info[][4])
1698 {
1699         size_t i;
1700
1701         for (i = 0; info[i][0] != ABS_CNT; i++)
1702                 evdev_support_abs(evdev, info[i][0], 0, info[i][1], info[i][2],
1703                     0, 0, info[i][3]);
1704 }
1705
1706 static void
1707 psm_push_mt_finger(struct psm_softc *sc, int id, const finger_t *f)
1708 {
1709         int y = sc->synhw.minimumYCoord + sc->synhw.maximumYCoord - f->y;
1710
1711         evdev_push_abs(sc->evdev_a, ABS_MT_SLOT, id);
1712         evdev_push_abs(sc->evdev_a, ABS_MT_TRACKING_ID, id);
1713         evdev_push_abs(sc->evdev_a, ABS_MT_POSITION_X, f->x);
1714         evdev_push_abs(sc->evdev_a, ABS_MT_POSITION_Y, y);
1715         evdev_push_abs(sc->evdev_a, ABS_MT_PRESSURE, f->p);
1716 }
1717
1718 static void
1719 psm_push_st_finger(struct psm_softc *sc, const finger_t *f)
1720 {
1721         int y = sc->synhw.minimumYCoord + sc->synhw.maximumYCoord - f->y;
1722
1723         evdev_push_abs(sc->evdev_a, ABS_X, f->x);
1724         evdev_push_abs(sc->evdev_a, ABS_Y, y);
1725         evdev_push_abs(sc->evdev_a, ABS_PRESSURE, f->p);
1726         if (sc->synhw.capPalmDetect)
1727                 evdev_push_abs(sc->evdev_a, ABS_TOOL_WIDTH, f->w);
1728 }
1729
1730 static void
1731 psm_release_mt_slot(struct evdev_dev *evdev, int32_t slot)
1732 {
1733
1734         evdev_push_abs(evdev, ABS_MT_SLOT, slot);
1735         evdev_push_abs(evdev, ABS_MT_TRACKING_ID, -1);
1736 }
1737
1738 static int
1739 psm_register(device_t dev, int model_code)
1740 {
1741         struct psm_softc *sc = device_get_softc(dev);
1742         struct evdev_dev *evdev_r;
1743         int error, i, nbuttons, nwheels, product;
1744         bool is_pointing_stick;
1745         const char *name;
1746
1747         name = model_name(model_code);
1748         nbuttons = sc->hw.buttons;
1749         product = PS2_MOUSE_GENERIC_PRODUCT;
1750         nwheels = 0;
1751         is_pointing_stick = false;
1752
1753         switch (model_code) {
1754         case MOUSE_MODEL_TRACKPOINT:
1755                 name = PS2_MOUSE_TRACKPOINT_NAME;
1756                 product = PS2_MOUSE_TRACKPOINT_PRODUCT;
1757                 nbuttons = 3;
1758                 is_pointing_stick = true;
1759                 break;
1760
1761         case MOUSE_MODEL_ELANTECH:
1762                 name = PS2_MOUSE_ELANTECH_ST_NAME;
1763                 product = PS2_MOUSE_ELANTECH_PRODUCT;
1764                 nbuttons = 3;
1765                 is_pointing_stick = true;
1766                 break;
1767
1768         case MOUSE_MODEL_MOUSEMANPLUS:
1769         case MOUSE_MODEL_4D:
1770                 nwheels = 2;
1771                 break;
1772
1773         case MOUSE_MODEL_EXPLORER:
1774         case MOUSE_MODEL_INTELLI:
1775         case MOUSE_MODEL_NET:
1776         case MOUSE_MODEL_NETSCROLL:
1777         case MOUSE_MODEL_4DPLUS:
1778                 nwheels = 1;
1779                 break;
1780         }
1781
1782         evdev_r = evdev_alloc();
1783         evdev_set_name(evdev_r, name);
1784         evdev_set_phys(evdev_r, device_get_nameunit(dev));
1785         evdev_set_id(evdev_r, BUS_I8042, PS2_MOUSE_VENDOR, product, 0);
1786         evdev_set_methods(evdev_r, sc, &psm_ev_methods_r);
1787
1788         evdev_support_prop(evdev_r, INPUT_PROP_POINTER);
1789         if (is_pointing_stick)
1790                 evdev_support_prop(evdev_r, INPUT_PROP_POINTING_STICK);
1791         evdev_support_event(evdev_r, EV_SYN);
1792         evdev_support_event(evdev_r, EV_KEY);
1793         evdev_support_event(evdev_r, EV_REL);
1794         evdev_support_rel(evdev_r, REL_X);
1795         evdev_support_rel(evdev_r, REL_Y);
1796         switch (nwheels) {
1797         case 2:
1798                 evdev_support_rel(evdev_r, REL_HWHEEL);
1799                 /* FALLTHROUGH */
1800         case 1:
1801                 evdev_support_rel(evdev_r, REL_WHEEL);
1802         }
1803         for (i = 0; i < nbuttons; i++)
1804                 evdev_support_key(evdev_r, BTN_MOUSE + i);
1805
1806         error = evdev_register_mtx(evdev_r, &Giant);
1807         if (error)
1808                 evdev_free(evdev_r);
1809         else
1810                 sc->evdev_r = evdev_r;
1811         return (error);
1812 }
1813
1814 static int
1815 psm_register_synaptics(device_t dev)
1816 {
1817         struct psm_softc *sc = device_get_softc(dev);
1818         const uint16_t synaptics_absinfo_st[][4] = {
1819                 { ABS_X,                sc->synhw.minimumXCoord,
1820                     sc->synhw.maximumXCoord, sc->synhw.infoXupmm },
1821                 { ABS_Y,                sc->synhw.minimumYCoord,
1822                     sc->synhw.maximumYCoord, sc->synhw.infoYupmm },
1823                 { ABS_PRESSURE,         0, ELANTECH_FINGER_MAX_P, 0 },
1824                 ABSINFO_END,
1825         };
1826         const uint16_t synaptics_absinfo_mt[][4] = {
1827                 { ABS_MT_SLOT,          0, PSM_FINGERS-1, 0},
1828                 { ABS_MT_TRACKING_ID,   -1, PSM_FINGERS-1, 0},
1829                 { ABS_MT_POSITION_X,    sc->synhw.minimumXCoord,
1830                     sc->synhw.maximumXCoord, sc->synhw.infoXupmm },
1831                 { ABS_MT_POSITION_Y,    sc->synhw.minimumYCoord,
1832                     sc->synhw.maximumYCoord, sc->synhw.infoYupmm },
1833                 { ABS_MT_PRESSURE,      0, ELANTECH_FINGER_MAX_P, 0 },
1834                 ABSINFO_END,
1835         };
1836         struct evdev_dev *evdev_a;
1837         int error, i, guest_model;
1838
1839         evdev_a = evdev_alloc();
1840         evdev_set_name(evdev_a, PS2_MOUSE_SYNAPTICS_NAME);
1841         evdev_set_phys(evdev_a, device_get_nameunit(dev));
1842         evdev_set_id(evdev_a, BUS_I8042, PS2_MOUSE_VENDOR,
1843             PS2_MOUSE_SYNAPTICS_PRODUCT, 0);
1844         evdev_set_methods(evdev_a, sc, &psm_ev_methods_a);
1845
1846         evdev_support_event(evdev_a, EV_SYN);
1847         evdev_support_event(evdev_a, EV_KEY);
1848         evdev_support_event(evdev_a, EV_ABS);
1849         evdev_support_prop(evdev_a, INPUT_PROP_POINTER);
1850         if (sc->synhw.capAdvancedGestures)
1851                 evdev_support_prop(evdev_a, INPUT_PROP_SEMI_MT);
1852         if (sc->synhw.capClickPad)
1853                 evdev_support_prop(evdev_a, INPUT_PROP_BUTTONPAD);
1854         if (sc->synhw.capClickPad && sc->synhw.topButtonPad)
1855                 evdev_support_prop(evdev_a, INPUT_PROP_TOPBUTTONPAD);
1856         evdev_support_key(evdev_a, BTN_TOUCH);
1857         evdev_support_nfingers(evdev_a, sc->synhw.capReportsV ? 5 : 3);
1858         psm_support_abs_bulk(evdev_a, synaptics_absinfo_st);
1859         if (sc->synhw.capAdvancedGestures || sc->synhw.capReportsV)
1860                 psm_support_abs_bulk(evdev_a, synaptics_absinfo_mt);
1861         if (sc->synhw.capPalmDetect)
1862                 evdev_support_abs(evdev_a, ABS_TOOL_WIDTH, 0, 0, 15, 0, 0, 0);
1863         evdev_support_key(evdev_a, BTN_LEFT);
1864         if (!sc->synhw.capClickPad) {
1865                 evdev_support_key(evdev_a, BTN_RIGHT);
1866                 if (sc->synhw.capExtended && sc->synhw.capMiddle)
1867                         evdev_support_key(evdev_a, BTN_MIDDLE);
1868         }
1869         if (sc->synhw.capExtended && sc->synhw.capFourButtons) {
1870                 evdev_support_key(evdev_a, BTN_BACK);
1871                 evdev_support_key(evdev_a, BTN_FORWARD);
1872         }
1873         if (sc->synhw.capExtended && (sc->synhw.nExtendedButtons > 0))
1874                 for (i = 0; i < sc->synhw.nExtendedButtons; i++)
1875                         evdev_support_key(evdev_a, BTN_0 + i);
1876
1877         error = evdev_register_mtx(evdev_a, &Giant);
1878         if (!error && (sc->synhw.capPassthrough || sc->muxport != PSM_NOMUX)) {
1879                 guest_model = sc->tpinfo.sysctl_tree != NULL ?
1880                     MOUSE_MODEL_TRACKPOINT : MOUSE_MODEL_GENERIC;
1881                 error = psm_register(dev, guest_model);
1882         }
1883         if (error)
1884                 evdev_free(evdev_a);
1885         else
1886                 sc->evdev_a = evdev_a;
1887         return (error);
1888 }
1889
1890 static int
1891 psm_register_elantech(device_t dev)
1892 {
1893         struct psm_softc *sc = device_get_softc(dev);
1894         const uint16_t elantech_absinfo[][4] = {
1895                 { ABS_X,                0, sc->elanhw.sizex,
1896                                            sc->elanhw.dpmmx },
1897                 { ABS_Y,                0, sc->elanhw.sizey,
1898                                            sc->elanhw.dpmmy },
1899                 { ABS_PRESSURE,         0, ELANTECH_FINGER_MAX_P, 0 },
1900                 { ABS_TOOL_WIDTH,       0, ELANTECH_FINGER_MAX_W, 0 },
1901                 { ABS_MT_SLOT,          0, ELANTECH_MAX_FINGERS - 1, 0 },
1902                 { ABS_MT_TRACKING_ID,   -1, ELANTECH_MAX_FINGERS - 1, 0 },
1903                 { ABS_MT_POSITION_X,    0, sc->elanhw.sizex,
1904                                            sc->elanhw.dpmmx },
1905                 { ABS_MT_POSITION_Y,    0, sc->elanhw.sizey,
1906                                            sc->elanhw.dpmmy },
1907                 { ABS_MT_PRESSURE,      0, ELANTECH_FINGER_MAX_P, 0 },
1908                 { ABS_MT_TOUCH_MAJOR,   0, ELANTECH_FINGER_MAX_W *
1909                                            sc->elanhw.dptracex, 0 },
1910                 ABSINFO_END,
1911         };
1912         struct evdev_dev *evdev_a;
1913         int error;
1914
1915         evdev_a = evdev_alloc();
1916         evdev_set_name(evdev_a, PS2_MOUSE_ELANTECH_NAME);
1917         evdev_set_phys(evdev_a, device_get_nameunit(dev));
1918         evdev_set_id(evdev_a, BUS_I8042, PS2_MOUSE_VENDOR,
1919             PS2_MOUSE_ELANTECH_PRODUCT, 0);
1920         evdev_set_methods(evdev_a, sc, &psm_ev_methods_a);
1921
1922         evdev_support_event(evdev_a, EV_SYN);
1923         evdev_support_event(evdev_a, EV_KEY);
1924         evdev_support_event(evdev_a, EV_ABS);
1925         evdev_support_prop(evdev_a, INPUT_PROP_POINTER);
1926         if (sc->elanhw.issemimt)
1927                 evdev_support_prop(evdev_a, INPUT_PROP_SEMI_MT);
1928         if (sc->elanhw.isclickpad)
1929                 evdev_support_prop(evdev_a, INPUT_PROP_BUTTONPAD);
1930         evdev_support_key(evdev_a, BTN_TOUCH);
1931         evdev_support_nfingers(evdev_a, ELANTECH_MAX_FINGERS);
1932         evdev_support_key(evdev_a, BTN_LEFT);
1933         if (!sc->elanhw.isclickpad)
1934                 evdev_support_key(evdev_a, BTN_RIGHT);
1935         psm_support_abs_bulk(evdev_a, elantech_absinfo);
1936
1937         error = evdev_register_mtx(evdev_a, &Giant);
1938         if (!error && sc->elanhw.hastrackpoint)
1939                 error = psm_register(dev, MOUSE_MODEL_ELANTECH);
1940         if (error)
1941                 evdev_free(evdev_a);
1942         else
1943                 sc->evdev_a = evdev_a;
1944         return (error);
1945 }
1946 #endif
1947
1948 static int
1949 psmattach(device_t dev)
1950 {
1951         int unit = device_get_unit(dev);
1952         struct psm_softc *sc = device_get_softc(dev);
1953         int error;
1954         int rid;
1955
1956         /* Setup initial state */
1957         sc->state = PSM_VALID;
1958         callout_init(&sc->callout, 0);
1959         callout_init(&sc->softcallout, 0);
1960
1961         /* Setup our interrupt handler */
1962         rid = KBDC_RID_AUX;
1963         sc->intr = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
1964         if (sc->intr == NULL)
1965                 return (ENXIO);
1966         error = bus_setup_intr(dev, sc->intr, INTR_TYPE_TTY, NULL, psmintr, sc,
1967             &sc->ih);
1968         if (error) {
1969                 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
1970                 return (error);
1971         }
1972
1973         /* Done */
1974         sc->dev = make_dev(&psm_cdevsw, 0, 0, 0, 0666, "psm%d", unit);
1975         sc->dev->si_drv1 = sc;
1976         sc->bdev = make_dev(&psm_cdevsw, 0, 0, 0, 0666, "bpsm%d", unit);
1977         sc->bdev->si_drv1 = sc;
1978
1979 #ifdef EVDEV_SUPPORT
1980         switch (sc->hw.model) {
1981         case MOUSE_MODEL_SYNAPTICS:
1982                 error = psm_register_synaptics(dev);
1983                 break;
1984
1985         case MOUSE_MODEL_ELANTECH:
1986                 error = psm_register_elantech(dev);
1987                 break;
1988
1989         default:
1990                 error = psm_register(dev, sc->hw.model);
1991         }
1992
1993         if (error)
1994                 return (error);
1995 #endif
1996
1997         /* Some touchpad devices need full reinitialization after suspend. */
1998         switch (sc->hw.model) {
1999         case MOUSE_MODEL_SYNAPTICS:
2000         case MOUSE_MODEL_GLIDEPOINT:
2001         case MOUSE_MODEL_VERSAPAD:
2002         case MOUSE_MODEL_ELANTECH:
2003                 sc->config |= PSM_CONFIG_INITAFTERSUSPEND;
2004                 break;
2005         default:
2006                 if (sc->synhw.infoMajor >= 4 || sc->tphw > 0)
2007                         sc->config |= PSM_CONFIG_INITAFTERSUSPEND;
2008                 break;
2009         }
2010
2011         /* Elantech trackpad`s sync bit differs from touchpad`s one */
2012         if (sc->hw.model == MOUSE_MODEL_ELANTECH &&
2013             (sc->elanhw.hascrc || sc->elanhw.hastrackpoint)) {
2014                 sc->config |= PSM_CONFIG_NOCHECKSYNC;
2015                 sc->flags &= ~PSM_NEED_SYNCBITS;
2016         }
2017
2018         if (!verbose)
2019                 printf("psm%d: model %s, device ID %d\n",
2020                     unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff);
2021         else {
2022                 printf("psm%d: model %s, device ID %d-%02x, %d buttons\n",
2023                     unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff,
2024                     sc->hw.hwid >> 8, sc->hw.buttons);
2025                 printf("psm%d: config:%08x, flags:%08x, packet size:%d\n",
2026                     unit, sc->config, sc->flags, sc->mode.packetsize);
2027                 printf("psm%d: syncmask:%02x, syncbits:%02x%s\n",
2028                     unit, sc->mode.syncmask[0], sc->mode.syncmask[1],
2029                     sc->config & PSM_CONFIG_NOCHECKSYNC ? " (sync not checked)" : "");
2030         }
2031
2032         if (bootverbose)
2033                 --verbose;
2034
2035         return (0);
2036 }
2037
2038 static int
2039 psmdetach(device_t dev)
2040 {
2041         struct psm_softc *sc;
2042         int rid;
2043
2044         sc = device_get_softc(dev);
2045         if (sc->state & PSM_OPEN)
2046                 return (EBUSY);
2047
2048 #ifdef EVDEV_SUPPORT
2049         evdev_free(sc->evdev_r);
2050         evdev_free(sc->evdev_a);
2051 #endif
2052
2053         rid = KBDC_RID_AUX;
2054         bus_teardown_intr(dev, sc->intr, sc->ih);
2055         bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
2056
2057         destroy_dev(sc->dev);
2058         destroy_dev(sc->bdev);
2059
2060         callout_drain(&sc->callout);
2061         callout_drain(&sc->softcallout);
2062
2063         return (0);
2064 }
2065
2066 #ifdef EVDEV_SUPPORT
2067 static int
2068 psm_ev_open_r(struct evdev_dev *evdev)
2069 {
2070         struct psm_softc *sc = evdev_get_softc(evdev);
2071         int err = 0;
2072
2073         /* Get device data */
2074         if ((sc->state & PSM_VALID) == 0) {
2075                 /* the device is no longer valid/functioning */
2076                 return (ENXIO);
2077         }
2078
2079         if (!(sc->state & (PSM_OPEN | PSM_EV_OPEN_A)))
2080                 err = psmopen(sc);
2081
2082         if (err == 0)
2083                 sc->state |= PSM_EV_OPEN_R;
2084
2085         return (err);
2086 }
2087
2088 static int
2089 psm_ev_close_r(struct evdev_dev *evdev)
2090 {
2091         struct psm_softc *sc = evdev_get_softc(evdev);
2092         int err = 0;
2093
2094         sc->state &= ~PSM_EV_OPEN_R;
2095
2096         if (sc->state & (PSM_OPEN | PSM_EV_OPEN_A))
2097                 return (0);
2098
2099         if (sc->state & PSM_VALID)
2100                 err = psmclose(sc);
2101
2102         return (err);
2103 }
2104
2105 static int
2106 psm_ev_open_a(struct evdev_dev *evdev)
2107 {
2108         struct psm_softc *sc = evdev_get_softc(evdev);
2109         int err = 0;
2110
2111         /* Get device data */
2112         if ((sc->state & PSM_VALID) == 0) {
2113                 /* the device is no longer valid/functioning */
2114                 return (ENXIO);
2115         }
2116
2117         if (!(sc->state & (PSM_OPEN | PSM_EV_OPEN_R)))
2118                 err = psmopen(sc);
2119
2120         if (err == 0)
2121                 sc->state |= PSM_EV_OPEN_A;
2122
2123         return (err);
2124 }
2125
2126 static int
2127 psm_ev_close_a(struct evdev_dev *evdev)
2128 {
2129         struct psm_softc *sc = evdev_get_softc(evdev);
2130         int err = 0;
2131
2132         sc->state &= ~PSM_EV_OPEN_A;
2133
2134         if (sc->state & (PSM_OPEN | PSM_EV_OPEN_R))
2135                 return (0);
2136
2137         if (sc->state & PSM_VALID)
2138                 err = psmclose(sc);
2139
2140         return (err);
2141 }
2142 #endif
2143
2144 static int
2145 psm_cdev_open(struct cdev *dev, int flag, int fmt, struct thread *td)
2146 {
2147         struct psm_softc *sc;
2148         int err = 0;
2149
2150         /* Get device data */
2151         sc = dev->si_drv1;
2152         if ((sc == NULL) || (sc->state & PSM_VALID) == 0) {
2153                 /* the device is no longer valid/functioning */
2154                 return (ENXIO);
2155         }
2156
2157         /* Disallow multiple opens */
2158         if (sc->state & PSM_OPEN)
2159                 return (EBUSY);
2160
2161         device_busy(devclass_get_device(psm_devclass, sc->unit));
2162
2163 #ifdef EVDEV_SUPPORT
2164         /* Already opened by evdev */
2165         if (!(sc->state & (PSM_EV_OPEN_R | PSM_EV_OPEN_A)))
2166 #endif
2167                 err = psmopen(sc);
2168
2169         if (err == 0)
2170                 sc->state |= PSM_OPEN;
2171         else
2172                 device_unbusy(devclass_get_device(psm_devclass, sc->unit));
2173
2174         return (err);
2175 }
2176
2177 static int
2178 psm_cdev_close(struct cdev *dev, int flag, int fmt, struct thread *td)
2179 {
2180         struct psm_softc *sc;
2181         int err = 0;
2182
2183         /* Get device data */
2184         sc = dev->si_drv1;
2185         if ((sc == NULL) || (sc->state & PSM_VALID) == 0) {
2186                 /* the device is no longer valid/functioning */
2187                 return (ENXIO);
2188         }
2189
2190 #ifdef EVDEV_SUPPORT
2191         /* Still opened by evdev */
2192         if (!(sc->state & (PSM_EV_OPEN_R | PSM_EV_OPEN_A)))
2193 #endif
2194                 err = psmclose(sc);
2195
2196         if (err == 0) {
2197                 sc->state &= ~PSM_OPEN;
2198                 /* clean up and sigio requests */
2199                 if (sc->async != NULL) {
2200                         funsetown(&sc->async);
2201                         sc->async = NULL;
2202                 }
2203                 device_unbusy(devclass_get_device(psm_devclass, sc->unit));
2204         }
2205
2206         return (err);
2207 }
2208
2209 static int
2210 psmopen(struct psm_softc *sc)
2211 {
2212         int command_byte;
2213         int err;
2214         int s;
2215
2216         /* Initialize state */
2217         sc->mode.level = sc->dflt_mode.level;
2218         sc->mode.protocol = sc->dflt_mode.protocol;
2219         sc->watchdog = FALSE;
2220         sc->async = NULL;
2221
2222         /* flush the event queue */
2223         sc->queue.count = 0;
2224         sc->queue.head = 0;
2225         sc->queue.tail = 0;
2226         sc->status.flags = 0;
2227         sc->status.button = 0;
2228         sc->status.obutton = 0;
2229         sc->status.dx = 0;
2230         sc->status.dy = 0;
2231         sc->status.dz = 0;
2232         sc->button = 0;
2233         sc->pqueue_start = 0;
2234         sc->pqueue_end = 0;
2235
2236         /* empty input buffer */
2237         flushpackets(sc);
2238         sc->syncerrors = 0;
2239         sc->pkterrors = 0;
2240
2241         /* don't let timeout routines in the keyboard driver to poll the kbdc */
2242         if (!kbdc_lock(sc->kbdc, TRUE))
2243                 return (EIO);
2244
2245         /* save the current controller command byte */
2246         s = spltty();
2247         command_byte = get_controller_command_byte(sc->kbdc);
2248
2249         /* enable the aux port and temporalily disable the keyboard */
2250         if (command_byte == -1 || !set_controller_command_byte(sc->kbdc,
2251             kbdc_get_device_mask(sc->kbdc),
2252             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
2253             KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2254                 /* CONTROLLER ERROR; do you know how to get out of this? */
2255                 kbdc_lock(sc->kbdc, FALSE);
2256                 splx(s);
2257                 log(LOG_ERR,
2258                     "psm%d: unable to set the command byte (psmopen).\n",
2259                     sc->unit);
2260                 return (EIO);
2261         }
2262         /*
2263          * Now that the keyboard controller is told not to generate
2264          * the keyboard and mouse interrupts, call `splx()' to allow
2265          * the other tty interrupts. The clock interrupt may also occur,
2266          * but timeout routines will be blocked by the poll flag set
2267          * via `kbdc_lock()'
2268          */
2269         splx(s);
2270
2271         /* enable the mouse device */
2272         err = doopen(sc, command_byte);
2273
2274         /* done */
2275         kbdc_lock(sc->kbdc, FALSE);
2276         return (err);
2277 }
2278
2279 static int
2280 psmclose(struct psm_softc *sc)
2281 {
2282         int stat[3];
2283         int command_byte;
2284         int s;
2285
2286         /* don't let timeout routines in the keyboard driver to poll the kbdc */
2287         if (!kbdc_lock(sc->kbdc, TRUE))
2288                 return (EIO);
2289
2290         /* save the current controller command byte */
2291         s = spltty();
2292         command_byte = get_controller_command_byte(sc->kbdc);
2293         if (command_byte == -1) {
2294                 kbdc_lock(sc->kbdc, FALSE);
2295                 splx(s);
2296                 return (EIO);
2297         }
2298
2299         /* disable the aux interrupt and temporalily disable the keyboard */
2300         if (!set_controller_command_byte(sc->kbdc,
2301             kbdc_get_device_mask(sc->kbdc),
2302             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
2303             KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2304                 log(LOG_ERR,
2305                     "psm%d: failed to disable the aux int (psmclose).\n",
2306                     sc->unit);
2307                 /* CONTROLLER ERROR;
2308                  * NOTE: we shall force our way through. Because the only
2309                  * ill effect we shall see is that we may not be able
2310                  * to read ACK from the mouse, and it doesn't matter much
2311                  * so long as the mouse will accept the DISABLE command.
2312                  */
2313         }
2314         splx(s);
2315
2316         /* stop the watchdog timer */
2317         callout_stop(&sc->callout);
2318
2319         /* remove anything left in the output buffer */
2320         empty_aux_buffer(sc->kbdc, 10);
2321
2322         /* disable the aux device, port and interrupt */
2323         if (sc->state & PSM_VALID) {
2324                 if (!disable_aux_dev(sc->kbdc)) {
2325                         /* MOUSE ERROR;
2326                          * NOTE: we don't return (error) and continue,
2327                          * pretending we have successfully disabled the device.
2328                          * It's OK because the interrupt routine will discard
2329                          * any data from the mouse hereafter.
2330                          */
2331                         log(LOG_ERR,
2332                             "psm%d: failed to disable the device (psmclose).\n",
2333                             sc->unit);
2334                 }
2335
2336                 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
2337                         log(LOG_DEBUG,
2338                             "psm%d: failed to get status (psmclose).\n",
2339                             sc->unit);
2340         }
2341
2342         if (!set_controller_command_byte(sc->kbdc,
2343             kbdc_get_device_mask(sc->kbdc),
2344             (command_byte & KBD_KBD_CONTROL_BITS) |
2345             KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2346                 /*
2347                  * CONTROLLER ERROR;
2348                  * we shall ignore this error; see the above comment.
2349                  */
2350                 log(LOG_ERR,
2351                     "psm%d: failed to disable the aux port (psmclose).\n",
2352                     sc->unit);
2353         }
2354
2355         /* remove anything left in the output buffer */
2356         empty_aux_buffer(sc->kbdc, 10);
2357
2358         /* close is almost always successful */
2359         kbdc_lock(sc->kbdc, FALSE);
2360         return (0);
2361 }
2362
2363 static int
2364 tame_mouse(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *status,
2365     u_char *buf)
2366 {
2367         static u_char butmapps2[8] = {
2368                 0,
2369                 MOUSE_PS2_BUTTON1DOWN,
2370                 MOUSE_PS2_BUTTON2DOWN,
2371                 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN,
2372                 MOUSE_PS2_BUTTON3DOWN,
2373                 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON3DOWN,
2374                 MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
2375                 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN |
2376                     MOUSE_PS2_BUTTON3DOWN,
2377         };
2378         static u_char butmapmsc[8] = {
2379                 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP |
2380                     MOUSE_MSC_BUTTON3UP,
2381                 MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
2382                 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON3UP,
2383                 MOUSE_MSC_BUTTON3UP,
2384                 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP,
2385                 MOUSE_MSC_BUTTON2UP,
2386                 MOUSE_MSC_BUTTON1UP,
2387                 0,
2388         };
2389         int mapped;
2390         int i;
2391
2392         if (sc->mode.level == PSM_LEVEL_BASE) {
2393                 mapped = status->button & ~MOUSE_BUTTON4DOWN;
2394                 if (status->button & MOUSE_BUTTON4DOWN)
2395                         mapped |= MOUSE_BUTTON1DOWN;
2396                 status->button = mapped;
2397                 buf[0] = MOUSE_PS2_SYNC | butmapps2[mapped & MOUSE_STDBUTTONS];
2398                 i = imax(imin(status->dx, 255), -256);
2399                 if (i < 0)
2400                         buf[0] |= MOUSE_PS2_XNEG;
2401                 buf[1] = i;
2402                 i = imax(imin(status->dy, 255), -256);
2403                 if (i < 0)
2404                         buf[0] |= MOUSE_PS2_YNEG;
2405                 buf[2] = i;
2406                 return (MOUSE_PS2_PACKETSIZE);
2407         } else if (sc->mode.level == PSM_LEVEL_STANDARD) {
2408                 buf[0] = MOUSE_MSC_SYNC |
2409                     butmapmsc[status->button & MOUSE_STDBUTTONS];
2410                 i = imax(imin(status->dx, 255), -256);
2411                 buf[1] = i >> 1;
2412                 buf[3] = i - buf[1];
2413                 i = imax(imin(status->dy, 255), -256);
2414                 buf[2] = i >> 1;
2415                 buf[4] = i - buf[2];
2416                 i = imax(imin(status->dz, 127), -128);
2417                 buf[5] = (i >> 1) & 0x7f;
2418                 buf[6] = (i - (i >> 1)) & 0x7f;
2419                 buf[7] = (~status->button >> 3) & 0x7f;
2420                 return (MOUSE_SYS_PACKETSIZE);
2421         }
2422         return (pb->inputbytes);
2423 }
2424
2425 static int
2426 psmread(struct cdev *dev, struct uio *uio, int flag)
2427 {
2428         struct psm_softc *sc = dev->si_drv1;
2429         u_char buf[PSM_SMALLBUFSIZE];
2430         int error = 0;
2431         int s;
2432         int l;
2433
2434         if ((sc->state & PSM_VALID) == 0)
2435                 return (EIO);
2436
2437         /* block until mouse activity occurred */
2438         s = spltty();
2439         while (sc->queue.count <= 0) {
2440                 if (dev != sc->bdev) {
2441                         splx(s);
2442                         return (EWOULDBLOCK);
2443                 }
2444                 sc->state |= PSM_ASLP;
2445                 error = tsleep(sc, PZERO | PCATCH, "psmrea", 0);
2446                 sc->state &= ~PSM_ASLP;
2447                 if (error) {
2448                         splx(s);
2449                         return (error);
2450                 } else if ((sc->state & PSM_VALID) == 0) {
2451                         /* the device disappeared! */
2452                         splx(s);
2453                         return (EIO);
2454                 }
2455         }
2456         splx(s);
2457
2458         /* copy data to the user land */
2459         while ((sc->queue.count > 0) && (uio->uio_resid > 0)) {
2460                 s = spltty();
2461                 l = imin(sc->queue.count, uio->uio_resid);
2462                 if (l > sizeof(buf))
2463                         l = sizeof(buf);
2464                 if (l > sizeof(sc->queue.buf) - sc->queue.head) {
2465                         bcopy(&sc->queue.buf[sc->queue.head], &buf[0],
2466                             sizeof(sc->queue.buf) - sc->queue.head);
2467                         bcopy(&sc->queue.buf[0],
2468                             &buf[sizeof(sc->queue.buf) - sc->queue.head],
2469                             l - (sizeof(sc->queue.buf) - sc->queue.head));
2470                 } else
2471                         bcopy(&sc->queue.buf[sc->queue.head], &buf[0], l);
2472                 sc->queue.count -= l;
2473                 sc->queue.head = (sc->queue.head + l) % sizeof(sc->queue.buf);
2474                 splx(s);
2475                 error = uiomove(buf, l, uio);
2476                 if (error)
2477                         break;
2478         }
2479
2480         return (error);
2481 }
2482
2483 static int
2484 block_mouse_data(struct psm_softc *sc, int *c)
2485 {
2486         int s;
2487
2488         if (!kbdc_lock(sc->kbdc, TRUE))
2489                 return (EIO);
2490
2491         s = spltty();
2492         *c = get_controller_command_byte(sc->kbdc);
2493         if ((*c == -1) || !set_controller_command_byte(sc->kbdc,
2494             kbdc_get_device_mask(sc->kbdc),
2495             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
2496             KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2497                 /* this is CONTROLLER ERROR */
2498                 splx(s);
2499                 kbdc_lock(sc->kbdc, FALSE);
2500                 return (EIO);
2501         }
2502
2503         /*
2504          * The device may be in the middle of status data transmission.
2505          * The transmission will be interrupted, thus, incomplete status
2506          * data must be discarded. Although the aux interrupt is disabled
2507          * at the keyboard controller level, at most one aux interrupt
2508          * may have already been pending and a data byte is in the
2509          * output buffer; throw it away. Note that the second argument
2510          * to `empty_aux_buffer()' is zero, so that the call will just
2511          * flush the internal queue.
2512          * `psmintr()' will be invoked after `splx()' if an interrupt is
2513          * pending; it will see no data and returns immediately.
2514          */
2515         empty_aux_buffer(sc->kbdc, 0);          /* flush the queue */
2516         read_aux_data_no_wait(sc->kbdc);        /* throw away data if any */
2517         flushpackets(sc);
2518         splx(s);
2519
2520         return (0);
2521 }
2522
2523 static void
2524 dropqueue(struct psm_softc *sc)
2525 {
2526
2527         sc->queue.count = 0;
2528         sc->queue.head = 0;
2529         sc->queue.tail = 0;
2530         if ((sc->state & PSM_SOFTARMED) != 0) {
2531                 sc->state &= ~PSM_SOFTARMED;
2532                 callout_stop(&sc->softcallout);
2533         }
2534         sc->pqueue_start = sc->pqueue_end;
2535 }
2536
2537 static void
2538 flushpackets(struct psm_softc *sc)
2539 {
2540
2541         dropqueue(sc);
2542         bzero(&sc->pqueue, sizeof(sc->pqueue));
2543 }
2544
2545 static int
2546 unblock_mouse_data(struct psm_softc *sc, int c)
2547 {
2548         int error = 0;
2549
2550         /*
2551          * We may have seen a part of status data during `set_mouse_XXX()'.
2552          * they have been queued; flush it.
2553          */
2554         empty_aux_buffer(sc->kbdc, 0);
2555
2556         /* restore ports and interrupt */
2557         if (!set_controller_command_byte(sc->kbdc,
2558             kbdc_get_device_mask(sc->kbdc),
2559             c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
2560                 /*
2561                  * CONTROLLER ERROR; this is serious, we may have
2562                  * been left with the inaccessible keyboard and
2563                  * the disabled mouse interrupt.
2564                  */
2565                 error = EIO;
2566         }
2567
2568         kbdc_lock(sc->kbdc, FALSE);
2569         return (error);
2570 }
2571
2572 static int
2573 psmwrite(struct cdev *dev, struct uio *uio, int flag)
2574 {
2575         struct psm_softc *sc = dev->si_drv1;
2576         u_char buf[PSM_SMALLBUFSIZE];
2577         int error = 0, i, l;
2578
2579         if ((sc->state & PSM_VALID) == 0)
2580                 return (EIO);
2581
2582         if (sc->mode.level < PSM_LEVEL_NATIVE)
2583                 return (ENODEV);
2584
2585         /* copy data from the user land */
2586         while (uio->uio_resid > 0) {
2587                 l = imin(PSM_SMALLBUFSIZE, uio->uio_resid);
2588                 error = uiomove(buf, l, uio);
2589                 if (error)
2590                         break;
2591                 for (i = 0; i < l; i++) {
2592                         VLOG(4, (LOG_DEBUG, "psm: cmd 0x%x\n", buf[i]));
2593                         if (!write_aux_command(sc->kbdc, buf[i])) {
2594                                 VLOG(2, (LOG_DEBUG,
2595                                     "psm: cmd 0x%x failed.\n", buf[i]));
2596                                 return (reinitialize(sc, FALSE));
2597                         }
2598                 }
2599         }
2600
2601         return (error);
2602 }
2603
2604 static int
2605 psmioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2606     struct thread *td)
2607 {
2608         struct psm_softc *sc = dev->si_drv1;
2609         mousemode_t mode;
2610         mousestatus_t status;
2611         mousedata_t *data;
2612         int stat[3];
2613         int command_byte;
2614         int error = 0;
2615         int s;
2616
2617         /* Perform IOCTL command */
2618         switch (cmd) {
2619
2620         case OLD_MOUSE_GETHWINFO:
2621                 s = spltty();
2622                 ((old_mousehw_t *)addr)->buttons = sc->hw.buttons;
2623                 ((old_mousehw_t *)addr)->iftype = sc->hw.iftype;
2624                 ((old_mousehw_t *)addr)->type = sc->hw.type;
2625                 ((old_mousehw_t *)addr)->hwid = sc->hw.hwid & 0x00ff;
2626                 splx(s);
2627                 break;
2628
2629         case MOUSE_GETHWINFO:
2630                 s = spltty();
2631                 *(mousehw_t *)addr = sc->hw;
2632                 if (sc->mode.level == PSM_LEVEL_BASE)
2633                         ((mousehw_t *)addr)->model = MOUSE_MODEL_GENERIC;
2634                 splx(s);
2635                 break;
2636
2637         case MOUSE_SYN_GETHWINFO:
2638                 s = spltty();
2639                 if (sc->synhw.infoMajor >= 4)
2640                         *(synapticshw_t *)addr = sc->synhw;
2641                 else
2642                         error = EINVAL;
2643                 splx(s);
2644                 break;
2645
2646         case OLD_MOUSE_GETMODE:
2647                 s = spltty();
2648                 switch (sc->mode.level) {
2649                 case PSM_LEVEL_BASE:
2650                         ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2651                         break;
2652                 case PSM_LEVEL_STANDARD:
2653                         ((old_mousemode_t *)addr)->protocol =
2654                             MOUSE_PROTO_SYSMOUSE;
2655                         break;
2656                 case PSM_LEVEL_NATIVE:
2657                         ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2658                         break;
2659                 }
2660                 ((old_mousemode_t *)addr)->rate = sc->mode.rate;
2661                 ((old_mousemode_t *)addr)->resolution = sc->mode.resolution;
2662                 ((old_mousemode_t *)addr)->accelfactor = sc->mode.accelfactor;
2663                 splx(s);
2664                 break;
2665
2666         case MOUSE_GETMODE:
2667                 s = spltty();
2668                 *(mousemode_t *)addr = sc->mode;
2669                 if ((sc->flags & PSM_NEED_SYNCBITS) != 0) {
2670                         ((mousemode_t *)addr)->syncmask[0] = 0;
2671                         ((mousemode_t *)addr)->syncmask[1] = 0;
2672                 }
2673                 ((mousemode_t *)addr)->resolution =
2674                         MOUSE_RES_LOW - sc->mode.resolution;
2675                 switch (sc->mode.level) {
2676                 case PSM_LEVEL_BASE:
2677                         ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2678                         ((mousemode_t *)addr)->packetsize =
2679                             MOUSE_PS2_PACKETSIZE;
2680                         break;
2681                 case PSM_LEVEL_STANDARD:
2682                         ((mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
2683                         ((mousemode_t *)addr)->packetsize =
2684                             MOUSE_SYS_PACKETSIZE;
2685                         ((mousemode_t *)addr)->syncmask[0] = MOUSE_SYS_SYNCMASK;
2686                         ((mousemode_t *)addr)->syncmask[1] = MOUSE_SYS_SYNC;
2687                         break;
2688                 case PSM_LEVEL_NATIVE:
2689                         /* FIXME: this isn't quite correct... XXX */
2690                         ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2691                         break;
2692                 }
2693                 splx(s);
2694                 break;
2695
2696         case OLD_MOUSE_SETMODE:
2697         case MOUSE_SETMODE:
2698                 if (cmd == OLD_MOUSE_SETMODE) {
2699                         mode.rate = ((old_mousemode_t *)addr)->rate;
2700                         /*
2701                          * resolution  old I/F   new I/F
2702                          * default        0         0
2703                          * low            1        -2
2704                          * medium low     2        -3
2705                          * medium high    3        -4
2706                          * high           4        -5
2707                          */
2708                         if (((old_mousemode_t *)addr)->resolution > 0)
2709                                 mode.resolution =
2710                                     -((old_mousemode_t *)addr)->resolution - 1;
2711                         else
2712                                 mode.resolution = 0;
2713                         mode.accelfactor =
2714                             ((old_mousemode_t *)addr)->accelfactor;
2715                         mode.level = -1;
2716                 } else
2717                         mode = *(mousemode_t *)addr;
2718
2719                 /* adjust and validate parameters. */
2720                 if (mode.rate > UCHAR_MAX)
2721                         return (EINVAL);
2722                 if (mode.rate == 0)
2723                         mode.rate = sc->dflt_mode.rate;
2724                 else if (mode.rate == -1)
2725                         /* don't change the current setting */
2726                         ;
2727                 else if (mode.rate < 0)
2728                         return (EINVAL);
2729                 if (mode.resolution >= UCHAR_MAX)
2730                         return (EINVAL);
2731                 if (mode.resolution >= 200)
2732                         mode.resolution = MOUSE_RES_HIGH;
2733                 else if (mode.resolution >= 100)
2734                         mode.resolution = MOUSE_RES_MEDIUMHIGH;
2735                 else if (mode.resolution >= 50)
2736                         mode.resolution = MOUSE_RES_MEDIUMLOW;
2737                 else if (mode.resolution > 0)
2738                         mode.resolution = MOUSE_RES_LOW;
2739                 if (mode.resolution == MOUSE_RES_DEFAULT)
2740                         mode.resolution = sc->dflt_mode.resolution;
2741                 else if (mode.resolution == -1)
2742                         /* don't change the current setting */
2743                         ;
2744                 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
2745                         mode.resolution = MOUSE_RES_LOW - mode.resolution;
2746                 if (mode.level == -1)
2747                         /* don't change the current setting */
2748                         mode.level = sc->mode.level;
2749                 else if ((mode.level < PSM_LEVEL_MIN) ||
2750                     (mode.level > PSM_LEVEL_MAX))
2751                         return (EINVAL);
2752                 if (mode.accelfactor == -1)
2753                         /* don't change the current setting */
2754                         mode.accelfactor = sc->mode.accelfactor;
2755                 else if (mode.accelfactor < 0)
2756                         return (EINVAL);
2757
2758                 /* don't allow anybody to poll the keyboard controller */
2759                 error = block_mouse_data(sc, &command_byte);
2760                 if (error)
2761                         return (error);
2762
2763                 /* set mouse parameters */
2764                 if (mode.rate > 0)
2765                         mode.rate = set_mouse_sampling_rate(sc->kbdc,
2766                             mode.rate);
2767                 if (mode.resolution >= 0)
2768                         mode.resolution =
2769                             set_mouse_resolution(sc->kbdc, mode.resolution);
2770                 set_mouse_scaling(sc->kbdc, 1);
2771                 get_mouse_status(sc->kbdc, stat, 0, 3);
2772
2773                 s = spltty();
2774                 sc->mode.rate = mode.rate;
2775                 sc->mode.resolution = mode.resolution;
2776                 sc->mode.accelfactor = mode.accelfactor;
2777                 sc->mode.level = mode.level;
2778                 splx(s);
2779
2780                 unblock_mouse_data(sc, command_byte);
2781                 break;
2782
2783         case MOUSE_GETLEVEL:
2784                 *(int *)addr = sc->mode.level;
2785                 break;
2786
2787         case MOUSE_SETLEVEL:
2788                 if ((*(int *)addr < PSM_LEVEL_MIN) ||
2789                     (*(int *)addr > PSM_LEVEL_MAX))
2790                         return (EINVAL);
2791                 sc->mode.level = *(int *)addr;
2792                 break;
2793
2794         case MOUSE_GETSTATUS:
2795                 s = spltty();
2796                 status = sc->status;
2797                 sc->status.flags = 0;
2798                 sc->status.obutton = sc->status.button;
2799                 sc->status.button = 0;
2800                 sc->status.dx = 0;
2801                 sc->status.dy = 0;
2802                 sc->status.dz = 0;
2803                 splx(s);
2804                 *(mousestatus_t *)addr = status;
2805                 break;
2806
2807         case MOUSE_READSTATE:
2808         case MOUSE_READDATA:
2809                 data = (mousedata_t *)addr;
2810                 if (data->len > sizeof(data->buf)/sizeof(data->buf[0]))
2811                         return (EINVAL);
2812
2813                 error = block_mouse_data(sc, &command_byte);
2814                 if (error)
2815                         return (error);
2816                 if ((data->len = get_mouse_status(sc->kbdc, data->buf,
2817                     (cmd == MOUSE_READDATA) ? 1 : 0, data->len)) <= 0)
2818                         error = EIO;
2819                 unblock_mouse_data(sc, command_byte);
2820                 break;
2821
2822 #if (defined(MOUSE_SETRESOLUTION))
2823         case MOUSE_SETRESOLUTION:
2824                 mode.resolution = *(int *)addr;
2825                 if (mode.resolution >= UCHAR_MAX)
2826                         return (EINVAL);
2827                 else if (mode.resolution >= 200)
2828                         mode.resolution = MOUSE_RES_HIGH;
2829                 else if (mode.resolution >= 100)
2830                         mode.resolution = MOUSE_RES_MEDIUMHIGH;
2831                 else if (mode.resolution >= 50)
2832                         mode.resolution = MOUSE_RES_MEDIUMLOW;
2833                 else if (mode.resolution > 0)
2834                         mode.resolution = MOUSE_RES_LOW;
2835                 if (mode.resolution == MOUSE_RES_DEFAULT)
2836                         mode.resolution = sc->dflt_mode.resolution;
2837                 else if (mode.resolution == -1)
2838                         mode.resolution = sc->mode.resolution;
2839                 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
2840                         mode.resolution = MOUSE_RES_LOW - mode.resolution;
2841
2842                 error = block_mouse_data(sc, &command_byte);
2843                 if (error)
2844                         return (error);
2845                 sc->mode.resolution =
2846                     set_mouse_resolution(sc->kbdc, mode.resolution);
2847                 if (sc->mode.resolution != mode.resolution)
2848                         error = EIO;
2849                 unblock_mouse_data(sc, command_byte);
2850                 break;
2851 #endif /* MOUSE_SETRESOLUTION */
2852
2853 #if (defined(MOUSE_SETRATE))
2854         case MOUSE_SETRATE:
2855                 mode.rate = *(int *)addr;
2856                 if (mode.rate > UCHAR_MAX)
2857                         return (EINVAL);
2858                 if (mode.rate == 0)
2859                         mode.rate = sc->dflt_mode.rate;
2860                 else if (mode.rate < 0)
2861                         mode.rate = sc->mode.rate;
2862
2863                 error = block_mouse_data(sc, &command_byte);
2864                 if (error)
2865                         return (error);
2866                 sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
2867                 if (sc->mode.rate != mode.rate)
2868                         error = EIO;
2869                 unblock_mouse_data(sc, command_byte);
2870                 break;
2871 #endif /* MOUSE_SETRATE */
2872
2873 #if (defined(MOUSE_SETSCALING))
2874         case MOUSE_SETSCALING:
2875                 if ((*(int *)addr <= 0) || (*(int *)addr > 2))
2876                         return (EINVAL);
2877
2878                 error = block_mouse_data(sc, &command_byte);
2879                 if (error)
2880                         return (error);
2881                 if (!set_mouse_scaling(sc->kbdc, *(int *)addr))
2882                         error = EIO;
2883                 unblock_mouse_data(sc, command_byte);
2884                 break;
2885 #endif /* MOUSE_SETSCALING */
2886
2887 #if (defined(MOUSE_GETHWID))
2888         case MOUSE_GETHWID:
2889                 error = block_mouse_data(sc, &command_byte);
2890                 if (error)
2891                         return (error);
2892                 sc->hw.hwid &= ~0x00ff;
2893                 sc->hw.hwid |= get_aux_id(sc->kbdc);
2894                 *(int *)addr = sc->hw.hwid & 0x00ff;
2895                 unblock_mouse_data(sc, command_byte);
2896                 break;
2897 #endif /* MOUSE_GETHWID */
2898
2899         case FIONBIO:
2900         case FIOASYNC:
2901                 break;
2902         case FIOSETOWN:
2903                 error = fsetown(*(int *)addr, &sc->async);
2904                 break;
2905         case FIOGETOWN:
2906                 *(int *) addr = fgetown(&sc->async);
2907                 break;
2908         default:
2909                 return (ENOTTY);
2910         }
2911
2912         return (error);
2913 }
2914
2915 static void
2916 psmtimeout(void *arg)
2917 {
2918         struct psm_softc *sc;
2919         int s;
2920
2921         sc = (struct psm_softc *)arg;
2922         s = spltty();
2923         if (sc->watchdog && kbdc_lock(sc->kbdc, TRUE)) {
2924                 VLOG(6, (LOG_DEBUG, "psm%d: lost interrupt?\n", sc->unit));
2925                 psmintr(sc);
2926                 kbdc_lock(sc->kbdc, FALSE);
2927         }
2928         sc->watchdog = TRUE;
2929         splx(s);
2930         callout_reset(&sc->callout, hz, psmtimeout, sc);
2931 }
2932
2933 /* Add all sysctls under the debug.psm and hw.psm nodes */
2934 static SYSCTL_NODE(_debug, OID_AUTO, psm, CTLFLAG_RD, 0, "ps/2 mouse");
2935 static SYSCTL_NODE(_hw, OID_AUTO, psm, CTLFLAG_RD, 0, "ps/2 mouse");
2936
2937 SYSCTL_INT(_debug_psm, OID_AUTO, loglevel, CTLFLAG_RWTUN, &verbose, 0,
2938     "Verbosity level");
2939
2940 static int psmhz = 20;
2941 SYSCTL_INT(_debug_psm, OID_AUTO, hz, CTLFLAG_RW, &psmhz, 0,
2942     "Frequency of the softcallout (in hz)");
2943 static int psmerrsecs = 2;
2944 SYSCTL_INT(_debug_psm, OID_AUTO, errsecs, CTLFLAG_RW, &psmerrsecs, 0,
2945     "Number of seconds during which packets will dropped after a sync error");
2946 static int psmerrusecs = 0;
2947 SYSCTL_INT(_debug_psm, OID_AUTO, errusecs, CTLFLAG_RW, &psmerrusecs, 0,
2948     "Microseconds to add to psmerrsecs");
2949 static int psmsecs = 0;
2950 SYSCTL_INT(_debug_psm, OID_AUTO, secs, CTLFLAG_RW, &psmsecs, 0,
2951     "Max number of seconds between soft interrupts");
2952 static int psmusecs = 500000;
2953 SYSCTL_INT(_debug_psm, OID_AUTO, usecs, CTLFLAG_RW, &psmusecs, 0,
2954     "Microseconds to add to psmsecs");
2955 static int pkterrthresh = 2;
2956 SYSCTL_INT(_debug_psm, OID_AUTO, pkterrthresh, CTLFLAG_RW, &pkterrthresh, 0,
2957     "Number of error packets allowed before reinitializing the mouse");
2958
2959 SYSCTL_INT(_hw_psm, OID_AUTO, tap_enabled, CTLFLAG_RWTUN, &tap_enabled, 0,
2960     "Enable tap and drag gestures");
2961 static int tap_threshold = PSM_TAP_THRESHOLD;
2962 SYSCTL_INT(_hw_psm, OID_AUTO, tap_threshold, CTLFLAG_RW, &tap_threshold, 0,
2963     "Button tap threshold");
2964 static int tap_timeout = PSM_TAP_TIMEOUT;
2965 SYSCTL_INT(_hw_psm, OID_AUTO, tap_timeout, CTLFLAG_RW, &tap_timeout, 0,
2966     "Tap timeout for touchpads");
2967
2968 /* Tunables */
2969 SYSCTL_INT(_hw_psm, OID_AUTO, synaptics_support, CTLFLAG_RDTUN,
2970     &synaptics_support, 0, "Enable support for Synaptics touchpads");
2971
2972 SYSCTL_INT(_hw_psm, OID_AUTO, trackpoint_support, CTLFLAG_RDTUN,
2973     &trackpoint_support, 0, "Enable support for IBM/Lenovo TrackPoint");
2974
2975 SYSCTL_INT(_hw_psm, OID_AUTO, elantech_support, CTLFLAG_RDTUN,
2976     &elantech_support, 0, "Enable support for Elantech touchpads");
2977
2978 static void
2979 psmintr(void *arg)
2980 {
2981         struct psm_softc *sc = arg;
2982         struct timeval now;
2983         int c;
2984         packetbuf_t *pb;
2985
2986         if (aux_mux_is_enabled(sc->kbdc))
2987                 VLOG(2, (LOG_DEBUG, "psmintr: active multiplexing mode is not "
2988                     "supported!\n"));
2989
2990         /* read until there is nothing to read */
2991         while((c = read_aux_data_no_wait(sc->kbdc)) != -1) {
2992                 pb = &sc->pqueue[sc->pqueue_end];
2993
2994                 /* discard the byte if the device is not open */
2995                 if (!(sc->state & (PSM_OPEN | PSM_EV_OPEN_R | PSM_EV_OPEN_A)))
2996                         continue;
2997
2998                 getmicrouptime(&now);
2999                 if ((pb->inputbytes > 0) &&
3000                     timevalcmp(&now, &sc->inputtimeout, >)) {
3001                         VLOG(3, (LOG_DEBUG, "psmintr: delay too long; "
3002                             "resetting byte count\n"));
3003                         pb->inputbytes = 0;
3004                         sc->syncerrors = 0;
3005                         sc->pkterrors = 0;
3006                 }
3007                 sc->inputtimeout.tv_sec = PSM_INPUT_TIMEOUT / 1000000;
3008                 sc->inputtimeout.tv_usec = PSM_INPUT_TIMEOUT % 1000000;
3009                 timevaladd(&sc->inputtimeout, &now);
3010
3011                 pb->ipacket[pb->inputbytes++] = c;
3012
3013                 if (sc->mode.level == PSM_LEVEL_NATIVE) {
3014                         VLOG(4, (LOG_DEBUG, "psmintr: %02x\n", pb->ipacket[0]));
3015                         sc->syncerrors = 0;
3016                         sc->pkterrors = 0;
3017                         goto next;
3018                 } else {
3019                         if (pb->inputbytes < sc->mode.packetsize)
3020                                 continue;
3021
3022                         VLOG(4, (LOG_DEBUG,
3023                             "psmintr: %02x %02x %02x %02x %02x %02x\n",
3024                             pb->ipacket[0], pb->ipacket[1], pb->ipacket[2],
3025                             pb->ipacket[3], pb->ipacket[4], pb->ipacket[5]));
3026                 }
3027
3028                 c = pb->ipacket[0];
3029
3030                 if ((sc->flags & PSM_NEED_SYNCBITS) != 0) {
3031                         sc->mode.syncmask[1] = (c & sc->mode.syncmask[0]);
3032                         sc->flags &= ~PSM_NEED_SYNCBITS;
3033                         VLOG(2, (LOG_DEBUG,
3034                             "psmintr: Sync bytes now %04x,%04x\n",
3035                             sc->mode.syncmask[0], sc->mode.syncmask[1]));
3036                 } else if ((sc->config & PSM_CONFIG_NOCHECKSYNC) == 0 &&
3037                     (c & sc->mode.syncmask[0]) != sc->mode.syncmask[1]) {
3038                         VLOG(3, (LOG_DEBUG, "psmintr: out of sync "
3039                             "(%04x != %04x) %d cmds since last error.\n",
3040                             c & sc->mode.syncmask[0], sc->mode.syncmask[1],
3041                             sc->cmdcount - sc->lasterr));
3042                         sc->lasterr = sc->cmdcount;
3043                         /*
3044                          * The sync byte test is a weak measure of packet
3045                          * validity.  Conservatively discard any input yet
3046                          * to be seen by userland when we detect a sync
3047                          * error since there is a good chance some of
3048                          * the queued packets have undetected errors.
3049                          */
3050                         dropqueue(sc);
3051                         if (sc->syncerrors == 0)
3052                                 sc->pkterrors++;
3053                         ++sc->syncerrors;
3054                         sc->lastinputerr = now;
3055                         if (sc->syncerrors >= sc->mode.packetsize * 2 ||
3056                             sc->pkterrors >= pkterrthresh) {
3057                                 /*
3058                                  * If we've failed to find a single sync byte
3059                                  * in 2 packets worth of data, or we've seen
3060                                  * persistent packet errors during the
3061                                  * validation period, reinitialize the mouse
3062                                  * in hopes of returning it to the expected
3063                                  * mode.
3064                                  */
3065                                 VLOG(3, (LOG_DEBUG,
3066                                     "psmintr: reset the mouse.\n"));
3067                                 reinitialize(sc, TRUE);
3068                         } else if (sc->syncerrors == sc->mode.packetsize) {
3069                                 /*
3070                                  * Try a soft reset after searching for a sync
3071                                  * byte through a packet length of bytes.
3072                                  */
3073                                 VLOG(3, (LOG_DEBUG,
3074                                     "psmintr: re-enable the mouse.\n"));
3075                                 pb->inputbytes = 0;
3076                                 disable_aux_dev(sc->kbdc);
3077                                 enable_aux_dev(sc->kbdc);
3078                         } else {
3079                                 VLOG(3, (LOG_DEBUG,
3080                                     "psmintr: discard a byte (%d)\n",
3081                                     sc->syncerrors));
3082                                 pb->inputbytes--;
3083                                 bcopy(&pb->ipacket[1], &pb->ipacket[0],
3084                                     pb->inputbytes);
3085                         }
3086                         continue;
3087                 }
3088
3089                 /*
3090                  * We have what appears to be a valid packet.
3091                  * Reset the error counters.
3092                  */
3093                 sc->syncerrors = 0;
3094
3095                 /*
3096                  * Drop even good packets if they occur within a timeout
3097                  * period of a sync error.  This allows the detection of
3098                  * a change in the mouse's packet mode without exposing
3099                  * erratic mouse behavior to the user.  Some KVMs forget
3100                  * enhanced mouse modes during switch events.
3101                  */
3102                 if (!timeelapsed(&sc->lastinputerr, psmerrsecs, psmerrusecs,
3103                     &now)) {
3104                         pb->inputbytes = 0;
3105                         continue;
3106                 }
3107
3108                 /*
3109                  * Now that we're out of the validation period, reset
3110                  * the packet error count.
3111                  */
3112                 sc->pkterrors = 0;
3113
3114                 sc->cmdcount++;
3115 next:
3116                 if (++sc->pqueue_end >= PSM_PACKETQUEUE)
3117                         sc->pqueue_end = 0;
3118                 /*
3119                  * If we've filled the queue then call the softintr ourselves,
3120                  * otherwise schedule the interrupt for later.
3121                  */
3122                 if (!timeelapsed(&sc->lastsoftintr, psmsecs, psmusecs, &now) ||
3123                     (sc->pqueue_end == sc->pqueue_start)) {
3124                         if ((sc->state & PSM_SOFTARMED) != 0) {
3125                                 sc->state &= ~PSM_SOFTARMED;
3126                                 callout_stop(&sc->softcallout);
3127                         }
3128                         psmsoftintr(arg);
3129                 } else if ((sc->state & PSM_SOFTARMED) == 0) {
3130                         sc->state |= PSM_SOFTARMED;
3131                         callout_reset(&sc->softcallout,
3132                             psmhz < 1 ? 1 : (hz/psmhz), psmsoftintr, arg);
3133                 }
3134         }
3135 }
3136
3137 static void
3138 proc_mmanplus(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
3139     int *x, int *y, int *z)
3140 {
3141
3142         /*
3143          * PS2++ protocol packet
3144          *
3145          *          b7 b6 b5 b4 b3 b2 b1 b0
3146          * byte 1:  *  1  p3 p2 1  *  *  *
3147          * byte 2:  c1 c2 p1 p0 d1 d0 1  0
3148          *
3149          * p3-p0: packet type
3150          * c1, c2: c1 & c2 == 1, if p2 == 0
3151          *         c1 & c2 == 0, if p2 == 1
3152          *
3153          * packet type: 0 (device type)
3154          * See comments in enable_mmanplus() below.
3155          *
3156          * packet type: 1 (wheel data)
3157          *
3158          *          b7 b6 b5 b4 b3 b2 b1 b0
3159          * byte 3:  h  *  B5 B4 s  d2 d1 d0
3160          *
3161          * h: 1, if horizontal roller data
3162          *    0, if vertical roller data
3163          * B4, B5: button 4 and 5
3164          * s: sign bit
3165          * d2-d0: roller data
3166          *
3167          * packet type: 2 (reserved)
3168          */
3169         if (((pb->ipacket[0] & MOUSE_PS2PLUS_SYNCMASK) == MOUSE_PS2PLUS_SYNC) &&
3170             (abs(*x) > 191) && MOUSE_PS2PLUS_CHECKBITS(pb->ipacket)) {
3171                 /*
3172                  * the extended data packet encodes button
3173                  * and wheel events
3174                  */
3175                 switch (MOUSE_PS2PLUS_PACKET_TYPE(pb->ipacket)) {
3176                 case 1:
3177                         /* wheel data packet */
3178                         *x = *y = 0;
3179                         if (pb->ipacket[2] & 0x80) {
3180                                 /* XXX horizontal roller count - ignore it */
3181                                 ;
3182                         } else {
3183                                 /* vertical roller count */
3184                                 *z = (pb->ipacket[2] & MOUSE_PS2PLUS_ZNEG) ?
3185                                     (pb->ipacket[2] & 0x0f) - 16 :
3186                                     (pb->ipacket[2] & 0x0f);
3187                         }
3188                         ms->button |= (pb->ipacket[2] &
3189                             MOUSE_PS2PLUS_BUTTON4DOWN) ?
3190                             MOUSE_BUTTON4DOWN : 0;
3191                         ms->button |= (pb->ipacket[2] &
3192                             MOUSE_PS2PLUS_BUTTON5DOWN) ?
3193                             MOUSE_BUTTON5DOWN : 0;
3194                         break;
3195                 case 2:
3196                         /*
3197                          * this packet type is reserved by
3198                          * Logitech...
3199                          */
3200                         /*
3201                          * IBM ScrollPoint Mouse uses this
3202                          * packet type to encode both vertical
3203                          * and horizontal scroll movement.
3204                          */
3205                         *x = *y = 0;
3206                         /* horizontal count */
3207                         if (pb->ipacket[2] & 0x0f)
3208                                 *z = (pb->ipacket[2] & MOUSE_SPOINT_WNEG) ?
3209                                     -2 : 2;
3210                         /* vertical count */
3211                         if (pb->ipacket[2] & 0xf0)
3212                                 *z = (pb->ipacket[2] & MOUSE_SPOINT_ZNEG) ?
3213                                     -1 : 1;
3214                         break;
3215                 case 0:
3216                         /* device type packet - shouldn't happen */
3217                         /* FALLTHROUGH */
3218                 default:
3219                         *x = *y = 0;
3220                         ms->button = ms->obutton;
3221                         VLOG(1, (LOG_DEBUG, "psmintr: unknown PS2++ packet "
3222                             "type %d: 0x%02x 0x%02x 0x%02x\n",
3223                             MOUSE_PS2PLUS_PACKET_TYPE(pb->ipacket),
3224                             pb->ipacket[0], pb->ipacket[1], pb->ipacket[2]));
3225                         break;
3226                 }
3227         } else {
3228                 /* preserve button states */
3229                 ms->button |= ms->obutton & MOUSE_EXTBUTTONS;
3230         }
3231 }
3232
3233 static int
3234 proc_synaptics(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
3235     int *x, int *y, int *z)
3236 {
3237         static int touchpad_buttons;
3238         static int guest_buttons;
3239         static int ew_finger_count;
3240         static finger_t f[PSM_FINGERS];
3241         int w, id, nfingers, palm, ewcode, extended_buttons, clickpad_pressed;
3242
3243         extended_buttons = 0;
3244
3245         /* TouchPad PS/2 absolute mode message format with capFourButtons:
3246          *
3247          *  Bits:        7   6   5   4   3   2   1   0 (LSB)
3248          *  ------------------------------------------------
3249          *  ipacket[0]:  1   0  W3  W2   0  W1   R   L
3250          *  ipacket[1]: Yb  Ya  Y9  Y8  Xb  Xa  X9  X8
3251          *  ipacket[2]: Z7  Z6  Z5  Z4  Z3  Z2  Z1  Z0
3252          *  ipacket[3]:  1   1  Yc  Xc   0  W0 D^R U^L
3253          *  ipacket[4]: X7  X6  X5  X4  X3  X2  X1  X0
3254          *  ipacket[5]: Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0
3255          *
3256          * Legend:
3257          *  L: left physical mouse button
3258          *  R: right physical mouse button
3259          *  D: down button
3260          *  U: up button
3261          *  W: "wrist" value
3262          *  X: x position
3263          *  Y: y position
3264          *  Z: pressure
3265          *
3266          * Without capFourButtons but with nExtendeButtons and/or capMiddle
3267          *
3268          *  Bits:        7   6   5   4      3      2      1      0 (LSB)
3269          *  ------------------------------------------------------
3270          *  ipacket[3]:  1   1  Yc  Xc      0     W0    E^R    M^L
3271          *  ipacket[4]: X7  X6  X5  X4  X3|b7  X2|b5  X1|b3  X0|b1
3272          *  ipacket[5]: Y7  Y6  Y5  Y4  Y3|b8  Y2|b6  Y1|b4  Y0|b2
3273          *
3274          * Legend:
3275          *  M: Middle physical mouse button
3276          *  E: Extended mouse buttons reported instead of low bits of X and Y
3277          *  b1-b8: Extended mouse buttons
3278          *    Only ((nExtendedButtons + 1) >> 1) bits are used in packet
3279          *    4 and 5, for reading X and Y value they should be zeroed.
3280          *
3281          * Absolute reportable limits:    0 - 6143.
3282          * Typical bezel limits:       1472 - 5472.
3283          * Typical edge marings:       1632 - 5312.
3284          *
3285          * w = 3 Passthrough Packet
3286          *
3287          * Byte 2,5,6 == Byte 1,2,3 of "Guest"
3288          */
3289
3290         if (!synaptics_support)
3291                 return (0);
3292
3293         /* Sanity check for out of sync packets. */
3294         if ((pb->ipacket[0] & 0xc8) != 0x80 ||
3295             (pb->ipacket[3] & 0xc8) != 0xc0)
3296                 return (-1);
3297
3298         *x = *y = 0;
3299         ms->button = ms->obutton;
3300
3301         /*
3302          * Pressure value.
3303          * Interpretation:
3304          *   z = 0      No finger contact
3305          *   z = 10     Finger hovering near the pad
3306          *   z = 30     Very light finger contact
3307          *   z = 80     Normal finger contact
3308          *   z = 110    Very heavy finger contact
3309          *   z = 200    Finger lying flat on pad surface
3310          *   z = 255    Maximum reportable Z
3311          */
3312         *z = pb->ipacket[2];
3313
3314         /*
3315          * Finger width value
3316          * Interpretation:
3317          *   w = 0      Two finger on the pad (capMultiFinger needed)
3318          *   w = 1      Three or more fingers (capMultiFinger needed)
3319          *   w = 2      Pen (instead of finger) (capPen needed)
3320          *   w = 3      Reserved (passthrough?)
3321          *   w = 4-7    Finger of normal width (capPalmDetect needed)
3322          *   w = 8-14   Very wide finger or palm (capPalmDetect needed)
3323          *   w = 15     Maximum reportable width (capPalmDetect needed)
3324          */
3325         /* XXX Is checking capExtended enough? */
3326         if (sc->synhw.capExtended)
3327                 w = ((pb->ipacket[0] & 0x30) >> 2) |
3328                     ((pb->ipacket[0] & 0x04) >> 1) |
3329                     ((pb->ipacket[3] & 0x04) >> 2);
3330         else {
3331                 /* Assume a finger of regular width. */
3332                 w = 4;
3333         }
3334
3335         switch (w) {
3336         case 3:
3337                 /*
3338                  * Handle packets from the guest device. See:
3339                  * Synaptics PS/2 TouchPad Interfacing Guide, Section 5.1
3340                  */
3341                 if (sc->synhw.capPassthrough || sc->muxport != PSM_NOMUX) {
3342                         *x = ((pb->ipacket[1] & 0x10) ?
3343                             pb->ipacket[4] - 256 : pb->ipacket[4]);
3344                         *y = ((pb->ipacket[1] & 0x20) ?
3345                             pb->ipacket[5] - 256 : pb->ipacket[5]);
3346                         *z = 0;
3347
3348                         guest_buttons = 0;
3349                         if (pb->ipacket[1] & 0x01)
3350                                 guest_buttons |= MOUSE_BUTTON1DOWN;
3351                         if (pb->ipacket[1] & 0x04)
3352                                 guest_buttons |= MOUSE_BUTTON2DOWN;
3353                         if (pb->ipacket[1] & 0x02)
3354                                 guest_buttons |= MOUSE_BUTTON3DOWN;
3355 #ifdef EVDEV_SUPPORT
3356                         if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
3357                                 evdev_push_rel(sc->evdev_r, REL_X, *x);
3358                                 evdev_push_rel(sc->evdev_r, REL_Y, -*y);
3359                                 evdev_push_mouse_btn(sc->evdev_r,
3360                                     guest_buttons);
3361                                 evdev_sync(sc->evdev_r);
3362                         }
3363 #endif
3364                         ms->button = touchpad_buttons | guest_buttons |
3365                             sc->extended_buttons;
3366                 }
3367                 goto SYNAPTICS_END;
3368
3369         case 2:
3370                 /* Handle Extended W mode packets */
3371                 ewcode = (pb->ipacket[5] & 0xf0) >> 4;
3372 #if PSM_FINGERS > 1
3373                 switch (ewcode) {
3374                 case 1:
3375                         /* Secondary finger */
3376                         if (sc->synhw.capAdvancedGestures)
3377                                 f[1] = (finger_t) {
3378                                         .x = (((pb->ipacket[4] & 0x0f) << 8) |
3379                                             pb->ipacket[1]) << 1,
3380                                         .y = (((pb->ipacket[4] & 0xf0) << 4) |
3381                                             pb->ipacket[2]) << 1,
3382                                         .p = ((pb->ipacket[3] & 0x30) |
3383                                             (pb->ipacket[5] & 0x0f)) << 1,
3384                                         .w = PSM_FINGER_DEFAULT_W,
3385                                         .flags = PSM_FINGER_FUZZY,
3386                                 };
3387                         else if (sc->synhw.capReportsV)
3388                                 f[1] = (finger_t) {
3389                                         .x = (((pb->ipacket[4] & 0x0f) << 8) |
3390                                             (pb->ipacket[1] & 0xfe)) << 1,
3391                                         .y = (((pb->ipacket[4] & 0xf0) << 4) |
3392                                             (pb->ipacket[2] & 0xfe)) << 1,
3393                                         .p = ((pb->ipacket[3] & 0x30) |
3394                                             (pb->ipacket[5] & 0x0e)) << 1,
3395                                         .w = (((pb->ipacket[5] & 0x01) << 2) |
3396                                             ((pb->ipacket[2] & 0x01) << 1) |
3397                                             (pb->ipacket[1] & 0x01)) + 8,
3398                                         .flags = PSM_FINGER_FUZZY,
3399                                 };
3400                         break;
3401                 case 2:
3402                         ew_finger_count = pb->ipacket[1] & 0x0f;
3403                 default:
3404                         break;
3405                 }
3406 #endif
3407                 goto SYNAPTICS_END;
3408
3409         case 1:
3410                 if (sc->synhw.capReportsV && ew_finger_count > 3) {
3411                         nfingers = ew_finger_count;
3412                         break;
3413                 }
3414                 /* FALLTHROUGH */
3415         case 0:
3416                 nfingers = w + 2;
3417                 break;
3418
3419         default:
3420                 nfingers = 1;
3421         }
3422
3423         if (sc->syninfo.touchpad_off)
3424                 goto SYNAPTICS_END;
3425
3426         /* Button presses */
3427         touchpad_buttons = 0;
3428         if (pb->ipacket[0] & 0x01)
3429                 touchpad_buttons |= MOUSE_BUTTON1DOWN;
3430         if (pb->ipacket[0] & 0x02)
3431                 touchpad_buttons |= MOUSE_BUTTON3DOWN;
3432
3433         if (sc->synhw.capExtended && sc->synhw.capFourButtons) {
3434                 if ((pb->ipacket[3] ^ pb->ipacket[0]) & 0x01)
3435                         touchpad_buttons |= MOUSE_BUTTON4DOWN;
3436                 if ((pb->ipacket[3] ^ pb->ipacket[0]) & 0x02)
3437                         touchpad_buttons |= MOUSE_BUTTON5DOWN;
3438         } else if (sc->synhw.capExtended && sc->synhw.capMiddle &&
3439             !sc->synhw.capClickPad) {
3440                 /* Middle Button */
3441                 if ((pb->ipacket[0] ^ pb->ipacket[3]) & 0x01)
3442                         touchpad_buttons |= MOUSE_BUTTON2DOWN;
3443         } else if (sc->synhw.capExtended && (sc->synhw.nExtendedButtons > 0)) {
3444                 /* Extended Buttons */
3445                 if ((pb->ipacket[0] ^ pb->ipacket[3]) & 0x02) {
3446                         if (sc->syninfo.directional_scrolls) {
3447                                 if (pb->ipacket[4] & 0x01)
3448                                         extended_buttons |= MOUSE_BUTTON4DOWN;
3449                                 if (pb->ipacket[5] & 0x01)
3450                                         extended_buttons |= MOUSE_BUTTON5DOWN;
3451                                 if (pb->ipacket[4] & 0x02)
3452                                         extended_buttons |= MOUSE_BUTTON6DOWN;
3453                                 if (pb->ipacket[5] & 0x02)
3454                                         extended_buttons |= MOUSE_BUTTON7DOWN;
3455                         } else {
3456                                 if (pb->ipacket[4] & 0x01)
3457                                         extended_buttons |= MOUSE_BUTTON1DOWN;
3458                                 if (pb->ipacket[5] & 0x01)
3459                                         extended_buttons |= MOUSE_BUTTON3DOWN;
3460                                 if (pb->ipacket[4] & 0x02)
3461                                         extended_buttons |= MOUSE_BUTTON2DOWN;
3462                                 sc->extended_buttons = extended_buttons;
3463                         }
3464
3465                         /*
3466                          * Zero out bits used by extended buttons to avoid
3467                          * misinterpretation of the data absolute position.
3468                          *
3469                          * The bits represented by
3470                          *
3471                          *     (nExtendedButtons + 1) >> 1
3472                          *
3473                          * will be masked out in both bytes.
3474                          * The mask for n bits is computed with the formula
3475                          *
3476                          *     (1 << n) - 1
3477                          */
3478                         int maskedbits = 0;
3479                         int mask = 0;
3480                         maskedbits = (sc->synhw.nExtendedButtons + 1) >> 1;
3481                         mask = (1 << maskedbits) - 1;
3482 #ifdef EVDEV_SUPPORT
3483                         int i;
3484                         if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
3485                                 if (sc->synhw.capPassthrough) {
3486                                         evdev_push_mouse_btn(sc->evdev_r,
3487                                                 extended_buttons);
3488                                         evdev_sync(sc->evdev_r);
3489                                 }
3490                                 for (i = 0; i < maskedbits; i++) {
3491                                         evdev_push_key(sc->evdev_a,
3492                                             BTN_0 + i * 2,
3493                                             pb->ipacket[4] & (1 << i));
3494                                         evdev_push_key(sc->evdev_a,
3495                                             BTN_0 + i * 2 + 1,
3496                                             pb->ipacket[5] & (1 << i));
3497                                 }
3498                         }
3499 #endif
3500                         pb->ipacket[4] &= ~(mask);
3501                         pb->ipacket[5] &= ~(mask);
3502                 } else  if (!sc->syninfo.directional_scrolls &&
3503                     !sc->gesture.in_vscroll) {
3504                         /*
3505                          * Keep reporting MOUSE DOWN until we get a new packet
3506                          * indicating otherwise.
3507                          */
3508                         extended_buttons |= sc->extended_buttons;
3509                 }
3510         }
3511
3512         if (sc->synhw.capReportsV && nfingers > 1)
3513                 f[0] = (finger_t) {
3514                         .x = ((pb->ipacket[3] & 0x10) << 8) |
3515                             ((pb->ipacket[1] & 0x0f) << 8) |
3516                             (pb->ipacket[4] & 0xfd),
3517                         .y = ((pb->ipacket[3] & 0x20) << 7) |
3518                             ((pb->ipacket[1] & 0xf0) << 4) |
3519                             (pb->ipacket[5] & 0xfd),
3520                         .p = *z & 0xfe,
3521                         .w = (((pb->ipacket[2] & 0x01) << 2) |
3522                             (pb->ipacket[5] & 0x02) |
3523                             ((pb->ipacket[4] & 0x02) >> 1)) + 8,
3524                         .flags = PSM_FINGER_FUZZY,
3525                 };
3526         else
3527                 f[0] = (finger_t) {
3528                         .x = ((pb->ipacket[3] & 0x10) << 8) |
3529                             ((pb->ipacket[1] & 0x0f) << 8) |
3530                             pb->ipacket[4],
3531                         .y = ((pb->ipacket[3] & 0x20) << 7) |
3532                             ((pb->ipacket[1] & 0xf0) << 4) |
3533                             pb->ipacket[5],
3534                         .p = *z,
3535                         .w = w,
3536                         .flags = nfingers > 1 ? PSM_FINGER_FUZZY : 0,
3537                 };
3538
3539         /* Ignore hovering and unmeasurable touches */
3540         if (f[0].p < sc->syninfo.min_pressure || f[0].x < 2)
3541                 nfingers = 0;
3542
3543         /* Handle ClickPad */
3544         if (sc->synhw.capClickPad) {
3545                 clickpad_pressed = (pb->ipacket[0] ^ pb->ipacket[3]) & 0x01;
3546                 if (sc->synhw.forcePad) {
3547                         /*
3548                          * Forcepads erroneously report button click if there
3549                          * are 2 or more fingers on the touchpad breaking
3550                          * multifinger gestures. To workaround this start
3551                          * reporting a click only after 4 consecutive single
3552                          * touch packets has been received.
3553                          * Skip these packets in case more contacts appear.
3554                          */
3555                         switch (nfingers) {
3556                         case 0:
3557                                 sc->fpcount = 0;
3558                                 break;
3559                         case 1:
3560                                 if (clickpad_pressed && sc->fpcount < INT_MAX)
3561                                         ++sc->fpcount;
3562                                 /* FALLTHROUGH */
3563                         default:
3564                                 if (!clickpad_pressed)
3565                                         sc->fpcount = 0;
3566                                 if (sc->fpcount >= sc->syninfo.window_min)
3567                                         touchpad_buttons |= MOUSE_BUTTON1DOWN;
3568                         }
3569                 } else if (clickpad_pressed)
3570                         touchpad_buttons |= MOUSE_BUTTON1DOWN;
3571         }
3572
3573         for (id = 0; id < PSM_FINGERS; id++)
3574                 if (id >= nfingers)
3575                         PSM_FINGER_RESET(f[id]);
3576
3577 #ifdef EVDEV_SUPPORT
3578         if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
3579                 for (id = 0; id < PSM_FINGERS; id++) {
3580                         if (PSM_FINGER_IS_SET(f[id]))
3581                                 psm_push_mt_finger(sc, id, &f[id]);
3582                         else
3583                                 psm_release_mt_slot(sc->evdev_a, id);
3584                 }
3585                 evdev_push_key(sc->evdev_a, BTN_TOUCH, nfingers > 0);
3586                 evdev_push_nfingers(sc->evdev_a, nfingers);
3587                 if (nfingers > 0)
3588                         psm_push_st_finger(sc, &f[0]);
3589                 else
3590                         evdev_push_abs(sc->evdev_a, ABS_PRESSURE, 0);
3591                 evdev_push_mouse_btn(sc->evdev_a, touchpad_buttons);
3592                 if (sc->synhw.capExtended && sc->synhw.capFourButtons) {
3593                         evdev_push_key(sc->evdev_a, BTN_FORWARD,
3594                             touchpad_buttons & MOUSE_BUTTON4DOWN);
3595                         evdev_push_key(sc->evdev_a, BTN_BACK,
3596                             touchpad_buttons & MOUSE_BUTTON5DOWN);
3597                 }
3598                 evdev_sync(sc->evdev_a);
3599         }
3600 #endif
3601
3602         ms->button = touchpad_buttons;
3603
3604         palm = psmpalmdetect(sc, &f[0], nfingers);
3605
3606         /* Palm detection doesn't terminate the current action. */
3607         if (!palm)
3608                 psmgestures(sc, &f[0], nfingers, ms);
3609
3610         for (id = 0; id < PSM_FINGERS; id++)
3611                 psmsmoother(sc, &f[id], id, ms, x, y);
3612
3613         if (palm) {
3614                 *x = *y = *z = 0;
3615                 ms->button = ms->obutton;
3616                 return (0);
3617         }
3618
3619         ms->button |= extended_buttons | guest_buttons;
3620
3621 SYNAPTICS_END:
3622         /*
3623          * Use the extra buttons as a scrollwheel
3624          *
3625          * XXX X.Org uses the Z axis for vertical wheel only,
3626          * whereas moused(8) understands special values to differ
3627          * vertical and horizontal wheels.
3628          *
3629          * xf86-input-mouse needs therefore a small patch to
3630          * understand these special values. Without it, the
3631          * horizontal wheel acts as a vertical wheel in X.Org.
3632          *
3633          * That's why the horizontal wheel is disabled by
3634          * default for now.
3635          */
3636         if (ms->button & MOUSE_BUTTON4DOWN)
3637                 *z = -1;
3638         else if (ms->button & MOUSE_BUTTON5DOWN)
3639                 *z = 1;
3640         else if (ms->button & MOUSE_BUTTON6DOWN)
3641                 *z = -2;
3642         else if (ms->button & MOUSE_BUTTON7DOWN)
3643                 *z = 2;
3644         else
3645                 *z = 0;
3646         ms->button &= ~(MOUSE_BUTTON4DOWN | MOUSE_BUTTON5DOWN |
3647             MOUSE_BUTTON6DOWN | MOUSE_BUTTON7DOWN);
3648
3649         return (0);
3650 }
3651
3652 static int
3653 proc_synaptics_mux(struct psm_softc *sc, packetbuf_t *pb)
3654 {
3655         int butt;
3656
3657         /*
3658          * Convert 3-byte interleaved mixture of Synaptics and generic mouse
3659          * packets into plain 6-byte Synaptics packet protocol.
3660          * While in hidden multiplexing mode KBC does some editing of the
3661          * packet stream. It remembers the button bits from the last packet
3662          * received from each device, and replaces the button bits of every
3663          * packet with the logical OR of all devices’ most recent button bits.
3664          * This button crosstalk should be filtered out as Synaptics and
3665          * generic mouse encode middle button presses in a different way.
3666          */
3667         switch (pb->ipacket[0] & 0xc0) {
3668         case 0x80:      /* First 3 bytes of Synaptics packet */
3669                 bcopy(pb->ipacket, sc->muxsave, 3);
3670                 /* Compute middle mouse button supression timeout. */
3671                 sc->muxmidtimeout.tv_sec  = 0;
3672                 sc->muxmidtimeout.tv_usec = 50000;      /* ~2-3 ints */
3673                 timevaladd(&sc->muxmidtimeout, &sc->lastsoftintr);
3674                 return (1);
3675
3676         case 0xc0:      /* Second 3 bytes of Synaptics packet */
3677                 /* Join two 3-bytes absolute packets */
3678                 bcopy(pb->ipacket, pb->ipacket + 3, 3);
3679                 bcopy(sc->muxsave, pb->ipacket, 3);
3680                 /* Prefer trackpoint buttons over touchpad's */
3681                 pb->ipacket[0] &= ~(0x08 | sc->muxmsbuttons);
3682                 pb->ipacket[3] &= ~(0x08 | sc->muxmsbuttons);
3683                 butt = (pb->ipacket[3] & 0x03) << 2 | (pb->ipacket[0] & 0x03);
3684                 /* Add hysteresis to remove spurious middle button events */
3685                 if (butt != sc->muxtpbuttons && sc->fpcount < 1) {
3686                         pb->ipacket[0] &= 0xfc;
3687                         pb->ipacket[0] |= sc->muxtpbuttons & 0x03;
3688                         pb->ipacket[3] &= 0xfc;
3689                         pb->ipacket[3] |= sc->muxtpbuttons >> 2 & 0x03;
3690                         ++sc->fpcount;
3691                 } else {
3692                         sc->fpcount = 0;
3693                         sc->muxtpbuttons = butt;
3694                 }
3695                 /* Filter out impossible w induced by middle trackpoint btn */
3696                 if (sc->synhw.capExtended && !sc->synhw.capPassthrough &&
3697                     (pb->ipacket[0] & 0x34) == 0x04 &&
3698                     (pb->ipacket[3] & 0x04) == 0x04) {
3699                         pb->ipacket[0] &= 0xfb;
3700                         pb->ipacket[3] &= 0xfb;
3701                 }
3702                 sc->muxsave[0] &= 0x30;
3703                 break;
3704
3705         default:        /* Generic mouse (Trackpoint) packet */
3706                 /* Filter out middle button events induced by some w values */
3707                 if (sc->muxmsbuttons & 0x03 || pb->ipacket[0] & 0x03 ||
3708                     (timevalcmp(&sc->lastsoftintr, &sc->muxmidtimeout, <=) &&
3709                      (sc->muxsave[0] & 0x30 || sc->muxsave[2] > 8)))
3710                         pb->ipacket[0] &= 0xfb;
3711                 sc->muxmsbuttons = pb->ipacket[0] & 0x07;
3712                 /* Convert to Synaptics pass-through protocol */
3713                 pb->ipacket[4] = pb->ipacket[1];
3714                 pb->ipacket[5] = pb->ipacket[2];
3715                 pb->ipacket[1] = pb->ipacket[0];
3716                 pb->ipacket[2] = 0;
3717                 pb->ipacket[0] = 0x84 | (sc->muxtpbuttons & 0x03);
3718                 pb->ipacket[3] = 0xc4 | (sc->muxtpbuttons >> 2 & 0x03);
3719         }
3720
3721         VLOG(4, (LOG_DEBUG, "synaptics: %02x %02x %02x %02x %02x %02x\n",
3722             pb->ipacket[0], pb->ipacket[1], pb->ipacket[2],
3723             pb->ipacket[3], pb->ipacket[4], pb->ipacket[5]));
3724
3725         pb->inputbytes = MOUSE_SYNAPTICS_PACKETSIZE;
3726         return (0);
3727 }
3728
3729 static int
3730 psmpalmdetect(struct psm_softc *sc, finger_t *f, int nfingers)
3731 {
3732         if (!(
3733             ((sc->synhw.capMultiFinger || sc->synhw.capAdvancedGestures) &&
3734               !sc->synhw.capReportsV && nfingers > 1) ||
3735             (sc->synhw.capReportsV && nfingers > 2) ||
3736             (sc->synhw.capPalmDetect && f->w <= sc->syninfo.max_width) ||
3737             (!sc->synhw.capPalmDetect && f->p <= sc->syninfo.max_pressure) ||
3738             (sc->synhw.capPen && f->flags & PSM_FINGER_IS_PEN))) {
3739                 /*
3740                  * We consider the packet irrelevant for the current
3741                  * action when:
3742                  *  - the width isn't comprised in:
3743                  *    [1; max_width]
3744                  *  - the pressure isn't comprised in:
3745                  *    [min_pressure; max_pressure]
3746                  *  - pen aren't supported but PSM_FINGER_IS_PEN is set
3747                  */
3748                 VLOG(2, (LOG_DEBUG, "synaptics: palm detected! (%d)\n", f->w));
3749                 return (1);
3750         }
3751         return (0);
3752 }
3753
3754 static void
3755 psmgestures(struct psm_softc *sc, finger_t *fingers, int nfingers,
3756     mousestatus_t *ms)
3757 {
3758         smoother_t *smoother;
3759         gesture_t *gest;
3760         finger_t *f;
3761         int y_ok, center_button, center_x, right_button, right_x, i;
3762
3763         f = &fingers[0];
3764         smoother = &sc->smoother[0];
3765         gest = &sc->gesture;
3766
3767         /* Find first active finger. */
3768         if (nfingers > 0) {
3769                 for (i = 0; i < PSM_FINGERS; i++) {
3770                         if (PSM_FINGER_IS_SET(fingers[i])) {
3771                                 f = &fingers[i];
3772                                 smoother = &sc->smoother[i];
3773                                 break;
3774                         }
3775                 }
3776         }
3777
3778         /*
3779          * Check pressure to detect a real wanted action on the
3780          * touchpad.
3781          */
3782         if (f->p >= sc->syninfo.min_pressure) {
3783                 int x0, y0;
3784                 int dxp, dyp;
3785                 int start_x, start_y;
3786                 int queue_len;
3787                 int margin_top, margin_right, margin_bottom, margin_left;
3788                 int window_min, window_max;
3789                 int vscroll_hor_area, vscroll_ver_area;
3790                 int two_finger_scroll;
3791                 int max_x, max_y;
3792                 int three_finger_drag;
3793
3794                 /* Read sysctl. */
3795                 /* XXX Verify values? */
3796                 margin_top = sc->syninfo.margin_top;
3797                 margin_right = sc->syninfo.margin_right;
3798                 margin_bottom = sc->syninfo.margin_bottom;
3799                 margin_left = sc->syninfo.margin_left;
3800                 window_min = sc->syninfo.window_min;
3801                 window_max = sc->syninfo.window_max;
3802                 vscroll_hor_area = sc->syninfo.vscroll_hor_area;
3803                 vscroll_ver_area = sc->syninfo.vscroll_ver_area;
3804                 two_finger_scroll = sc->syninfo.two_finger_scroll;
3805                 max_x = sc->syninfo.max_x;
3806                 max_y = sc->syninfo.max_y;
3807                 three_finger_drag = sc->syninfo.three_finger_drag;
3808                 /* Read current absolute position. */
3809                 x0 = f->x;
3810                 y0 = f->y;
3811
3812                 /*
3813                  * Limit the coordinates to the specified margins because
3814                  * this area isn't very reliable.
3815                  */
3816                 if (x0 <= margin_left)
3817                         x0 = margin_left;
3818                 else if (x0 >= max_x - margin_right)
3819                         x0 = max_x - margin_right;
3820                 if (y0 <= margin_bottom)
3821                         y0 = margin_bottom;
3822                 else if (y0 >= max_y - margin_top)
3823                         y0 = max_y - margin_top;
3824
3825                 VLOG(3, (LOG_DEBUG, "synaptics: ipacket: [%d, %d], %d, %d\n",
3826                     x0, y0, f->p, f->w));
3827
3828                 /*
3829                  * If the action is just beginning, init the structure and
3830                  * compute tap timeout.
3831                  */
3832                 if (!(sc->flags & PSM_FLAGS_FINGERDOWN)) {
3833                         VLOG(3, (LOG_DEBUG, "synaptics: ----\n"));
3834
3835                         /* Initialize queue. */
3836                         gest->window_min = window_min;
3837
3838                         /* Reset pressure peak. */
3839                         gest->zmax = 0;
3840
3841                         /* Reset fingers count. */
3842                         gest->fingers_nb = 0;
3843
3844                         /* Reset virtual scrolling state. */
3845                         gest->in_vscroll = 0;
3846
3847                         /* Compute tap timeout. */
3848                         if (tap_enabled != 0) {
3849                                 gest->taptimeout = (struct timeval) {
3850                                         .tv_sec  = tap_timeout / 1000000,
3851                                         .tv_usec = tap_timeout % 1000000,
3852                                 };
3853                                 timevaladd(
3854                                     &gest->taptimeout, &sc->lastsoftintr);
3855                         } else
3856                                 timevalclear(&gest->taptimeout);
3857
3858                         sc->flags |= PSM_FLAGS_FINGERDOWN;
3859
3860                         /* Smoother has not been reset yet */
3861                         queue_len = 1;
3862                         start_x = x0;
3863                         start_y = y0;
3864                 } else {
3865                         queue_len = smoother->queue_len + 1;
3866                         start_x = smoother->start_x;
3867                         start_y = smoother->start_y;
3868                 }
3869
3870                 /* Process ClickPad softbuttons */
3871                 if (sc->synhw.capClickPad && ms->button & MOUSE_BUTTON1DOWN) {
3872                         y_ok = sc->syninfo.softbuttons_y >= 0 ?
3873                             start_y < sc->syninfo.softbuttons_y :
3874                             start_y > max_y + sc->syninfo.softbuttons_y;
3875
3876                         center_button = MOUSE_BUTTON2DOWN;
3877                         center_x = sc->syninfo.softbutton2_x;
3878                         right_button = MOUSE_BUTTON3DOWN;
3879                         right_x = sc->syninfo.softbutton3_x;
3880
3881                         if (center_x > 0 && right_x > 0 && center_x > right_x) {
3882                                 center_button = MOUSE_BUTTON3DOWN;
3883                                 center_x = sc->syninfo.softbutton3_x;
3884                                 right_button = MOUSE_BUTTON2DOWN;
3885                                 right_x = sc->syninfo.softbutton2_x;
3886                         }
3887
3888                         if (right_x > 0 && start_x > right_x && y_ok)
3889                                 ms->button = (ms->button &
3890                                     ~MOUSE_BUTTON1DOWN) | right_button;
3891                         else if (center_x > 0 && start_x > center_x && y_ok)
3892                                 ms->button = (ms->button &
3893                                     ~MOUSE_BUTTON1DOWN) | center_button;
3894                 }
3895
3896                 /* If in tap-hold or three fingers, add the recorded button. */
3897                 if (gest->in_taphold || (nfingers == 3 && three_finger_drag))
3898                         ms->button |= gest->tap_button;
3899
3900                 /*
3901                  * For tap, we keep the maximum number of fingers and the
3902                  * pressure peak. Also with multiple fingers, we increase
3903                  * the minimum window.
3904                  */
3905                 if (nfingers > 1)
3906                         gest->window_min = window_max;
3907                 gest->fingers_nb = imax(nfingers, gest->fingers_nb);
3908                 gest->zmax = imax(f->p, gest->zmax);
3909
3910                 /* Do we have enough packets to consider this a gesture? */
3911                 if (queue_len < gest->window_min)
3912                         return;
3913
3914                 dyp = -1;
3915                 dxp = -1;
3916
3917                 /* Is a scrolling action occurring? */
3918                 if (!gest->in_taphold && !ms->button &&
3919                     (!gest->in_vscroll || two_finger_scroll)) {
3920                         /*
3921                          * A scrolling action must not conflict with a tap
3922                          * action. Here are the conditions to consider a
3923                          * scrolling action:
3924                          *  - the action in a configurable area
3925                          *  - one of the following:
3926                          *     . the distance between the last packet and the
3927                          *       first should be above a configurable minimum
3928                          *     . tap timed out
3929                          */
3930                         dxp = abs(x0 - start_x);
3931                         dyp = abs(y0 - start_y);
3932
3933                         if (timevalcmp(&sc->lastsoftintr, &gest->taptimeout, >) ||
3934                             dxp >= sc->syninfo.vscroll_min_delta ||
3935                             dyp >= sc->syninfo.vscroll_min_delta) {
3936                                 /*
3937                                  * Handle two finger scrolling.
3938                                  * Note that we don't rely on fingers_nb
3939                                  * as that keeps the maximum number of fingers.
3940                                  */
3941                                 if (two_finger_scroll) {
3942                                         if (nfingers == 2) {
3943                                                 gest->in_vscroll +=
3944                                                     dyp ? 2 : 0;
3945                                                 gest->in_vscroll +=
3946                                                     dxp ? 1 : 0;
3947                                         }
3948                                 } else {
3949                                         /* Check for horizontal scrolling. */
3950                                         if ((vscroll_hor_area > 0 &&
3951                                             start_y <= vscroll_hor_area) ||
3952                                             (vscroll_hor_area < 0 &&
3953                                              start_y >=
3954                                              max_y + vscroll_hor_area))
3955                                                 gest->in_vscroll += 2;
3956
3957                                         /* Check for vertical scrolling. */
3958                                         if ((vscroll_ver_area > 0 &&
3959                                             start_x <= vscroll_ver_area) ||
3960                                             (vscroll_ver_area < 0 &&
3961                                              start_x >=
3962                                              max_x + vscroll_ver_area))
3963                                                 gest->in_vscroll += 1;
3964                                 }
3965
3966                                 /* Avoid conflicts if area overlaps. */
3967                                 if (gest->in_vscroll >= 3)
3968                                         gest->in_vscroll =
3969                                             (dxp > dyp) ? 2 : 1;
3970                         }
3971                 }
3972                 /*
3973                  * Reset two finger scrolling when the number of fingers
3974                  * is different from two or any button is pressed.
3975                  */
3976                 if (two_finger_scroll && gest->in_vscroll != 0 &&
3977                     (nfingers != 2 || ms->button))
3978                         gest->in_vscroll = 0;
3979
3980                 VLOG(5, (LOG_DEBUG,
3981                         "synaptics: virtual scrolling: %s "
3982                         "(direction=%d, dxp=%d, dyp=%d, fingers=%d)\n",
3983                         gest->in_vscroll ? "YES" : "NO",
3984                         gest->in_vscroll, dxp, dyp,
3985                         gest->fingers_nb));
3986
3987         } else if (sc->flags & PSM_FLAGS_FINGERDOWN) {
3988                 /*
3989                  * An action is currently taking place but the pressure
3990                  * dropped under the minimum, putting an end to it.
3991                  */
3992                 int taphold_timeout, dx, dy, tap_max_delta;
3993
3994                 dx = abs(smoother->queue[smoother->queue_cursor].x -
3995                     smoother->start_x);
3996                 dy = abs(smoother->queue[smoother->queue_cursor].y -
3997                     smoother->start_y);
3998
3999                 /* Max delta is disabled for multi-fingers tap. */
4000                 if (gest->fingers_nb > 1)
4001                         tap_max_delta = imax(dx, dy);
4002                 else
4003                         tap_max_delta = sc->syninfo.tap_max_delta;
4004
4005                 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
4006
4007                 /* Check for tap. */
4008                 VLOG(3, (LOG_DEBUG,
4009                     "synaptics: zmax=%d, dx=%d, dy=%d, "
4010                     "delta=%d, fingers=%d, queue=%d\n",
4011                     gest->zmax, dx, dy, tap_max_delta, gest->fingers_nb,
4012                     smoother->queue_len));
4013                 if (!gest->in_vscroll && gest->zmax >= tap_threshold &&
4014                     timevalcmp(&sc->lastsoftintr, &gest->taptimeout, <=) &&
4015                     dx <= tap_max_delta && dy <= tap_max_delta &&
4016                     smoother->queue_len >= sc->syninfo.tap_min_queue) {
4017                         /*
4018                          * We have a tap if:
4019                          *   - the maximum pressure went over tap_threshold
4020                          *   - the action ended before tap_timeout
4021                          *
4022                          * To handle tap-hold, we must delay any button push to
4023                          * the next action.
4024                          */
4025                         if (gest->in_taphold) {
4026                                 /*
4027                                  * This is the second and last tap of a
4028                                  * double tap action, not a tap-hold.
4029                                  */
4030                                 gest->in_taphold = 0;
4031
4032                                 /*
4033                                  * For double-tap to work:
4034                                  *   - no button press is emitted (to
4035                                  *     simulate a button release)
4036                                  *   - PSM_FLAGS_FINGERDOWN is set to
4037                                  *     force the next packet to emit a
4038                                  *     button press)
4039                                  */
4040                                 VLOG(2, (LOG_DEBUG,
4041                                     "synaptics: button RELEASE: %d\n",
4042                                     gest->tap_button));
4043                                 sc->flags |= PSM_FLAGS_FINGERDOWN;
4044
4045                                 /* Schedule button press on next interrupt */
4046                                 sc->idletimeout.tv_sec  = psmhz > 1 ?
4047                                     0 : 1;
4048                                 sc->idletimeout.tv_usec = psmhz > 1 ?
4049                                     1000000 / psmhz : 0;
4050                         } else {
4051                                 /*
4052                                  * This is the first tap: we set the
4053                                  * tap-hold state and notify the button
4054                                  * down event.
4055                                  */
4056                                 gest->in_taphold = 1;
4057                                 taphold_timeout = sc->syninfo.taphold_timeout;
4058                                 gest->taptimeout.tv_sec  = taphold_timeout /
4059                                     1000000;
4060                                 gest->taptimeout.tv_usec = taphold_timeout %
4061                                     1000000;
4062                                 sc->idletimeout = gest->taptimeout;
4063                                 timevaladd(&gest->taptimeout,
4064                                     &sc->lastsoftintr);
4065
4066                                 switch (gest->fingers_nb) {
4067                                 case 3:
4068                                         gest->tap_button =
4069                                             MOUSE_BUTTON2DOWN;
4070                                         break;
4071                                 case 2:
4072                                         gest->tap_button =
4073                                             MOUSE_BUTTON3DOWN;
4074                                         break;
4075                                 default:
4076                                         gest->tap_button =
4077                                             MOUSE_BUTTON1DOWN;
4078                                 }
4079                                 VLOG(2, (LOG_DEBUG,
4080                                     "synaptics: button PRESS: %d\n",
4081                                     gest->tap_button));
4082                                 ms->button |= gest->tap_button;
4083                         }
4084                 } else {
4085                         /*
4086                          * Not enough pressure or timeout: reset
4087                          * tap-hold state.
4088                          */
4089                         if (gest->in_taphold) {
4090                                 VLOG(2, (LOG_DEBUG,
4091                                     "synaptics: button RELEASE: %d\n",
4092                                     gest->tap_button));
4093                                 gest->in_taphold = 0;
4094                         } else {
4095                                 VLOG(2, (LOG_DEBUG,
4096                                     "synaptics: not a tap-hold\n"));
4097                         }
4098                 }
4099         } else if (!(sc->flags & PSM_FLAGS_FINGERDOWN) && gest->in_taphold) {
4100                 /*
4101                  * For a tap-hold to work, the button must remain down at
4102                  * least until timeout (where the in_taphold flags will be
4103                  * cleared) or during the next action.
4104                  */
4105                 if (timevalcmp(&sc->lastsoftintr, &gest->taptimeout, <=)) {
4106                         ms->button |= gest->tap_button;
4107                 } else {
4108                         VLOG(2, (LOG_DEBUG, "synaptics: button RELEASE: %d\n",
4109                             gest->tap_button));
4110                         gest->in_taphold = 0;
4111                 }
4112         }
4113
4114         return;
4115 }
4116
4117 static void
4118 psmsmoother(struct psm_softc *sc, finger_t *f, int smoother_id,
4119     mousestatus_t *ms, int *x, int *y)
4120 {
4121         smoother_t *smoother = &sc->smoother[smoother_id];
4122         gesture_t *gest = &(sc->gesture);
4123
4124         /*
4125          * Check pressure to detect a real wanted action on the
4126          * touchpad.
4127          */
4128         if (f->p >= sc->syninfo.min_pressure) {
4129                 int x0, y0;
4130                 int cursor, peer, window;
4131                 int dx, dy, dxp, dyp;
4132                 int max_width, max_pressure;
4133                 int margin_top, margin_right, margin_bottom, margin_left;
4134                 int na_top, na_right, na_bottom, na_left;
4135                 int window_min, window_max;
4136                 int multiplicator;
4137                 int weight_current, weight_previous, weight_len_squared;
4138                 int div_min, div_max, div_len;
4139                 int vscroll_hor_area, vscroll_ver_area;
4140                 int two_finger_scroll;
4141                 int max_x, max_y;
4142                 int len, weight_prev_x, weight_prev_y;
4143                 int div_max_x, div_max_y, div_x, div_y;
4144                 int is_fuzzy;
4145                 int natural_scroll;
4146
4147                 /* Read sysctl. */
4148                 /* XXX Verify values? */
4149                 max_width = sc->syninfo.max_width;
4150                 max_pressure = sc->syninfo.max_pressure;
4151                 margin_top = sc->syninfo.margin_top;
4152                 margin_right = sc->syninfo.margin_right;
4153                 margin_bottom = sc->syninfo.margin_bottom;
4154                 margin_left = sc->syninfo.margin_left;
4155                 na_top = sc->syninfo.na_top;
4156                 na_right = sc->syninfo.na_right;
4157                 na_bottom = sc->syninfo.na_bottom;
4158                 na_left = sc->syninfo.na_left;
4159                 window_min = sc->syninfo.window_min;
4160                 window_max = sc->syninfo.window_max;
4161                 multiplicator = sc->syninfo.multiplicator;
4162                 weight_current = sc->syninfo.weight_current;
4163                 weight_previous = sc->syninfo.weight_previous;
4164                 weight_len_squared = sc->syninfo.weight_len_squared;
4165                 div_min = sc->syninfo.div_min;
4166                 div_max = sc->syninfo.div_max;
4167                 div_len = sc->syninfo.div_len;
4168                 vscroll_hor_area = sc->syninfo.vscroll_hor_area;
4169                 vscroll_ver_area = sc->syninfo.vscroll_ver_area;
4170                 two_finger_scroll = sc->syninfo.two_finger_scroll;
4171                 max_x = sc->syninfo.max_x;
4172                 max_y = sc->syninfo.max_y;
4173                 natural_scroll = sc->syninfo.natural_scroll;
4174
4175                 is_fuzzy = (f->flags & PSM_FINGER_FUZZY) != 0;
4176
4177                 /* Read current absolute position. */
4178                 x0 = f->x;
4179                 y0 = f->y;
4180
4181                 /*
4182                  * Limit the coordinates to the specified margins because
4183                  * this area isn't very reliable.
4184                  */
4185                 if (x0 <= margin_left)
4186                         x0 = margin_left;
4187                 else if (x0 >= max_x - margin_right)
4188                         x0 = max_x - margin_right;
4189                 if (y0 <= margin_bottom)
4190                         y0 = margin_bottom;
4191                 else if (y0 >= max_y - margin_top)
4192                         y0 = max_y - margin_top;
4193
4194                 /* If the action is just beginning, init the structure. */
4195                 if (smoother->active == 0) {
4196                         VLOG(3, (LOG_DEBUG, "smoother%d: ---\n", smoother_id));
4197
4198                         /* Store the first point of this action. */
4199                         smoother->start_x = x0;
4200                         smoother->start_y = y0;
4201                         dx = dy = 0;
4202
4203                         /* Initialize queue. */
4204                         smoother->queue_cursor = SYNAPTICS_PACKETQUEUE;
4205                         smoother->queue_len = 0;
4206
4207                         /* Reset average. */
4208                         smoother->avg_dx = 0;
4209                         smoother->avg_dy = 0;
4210
4211                         /* Reset squelch. */
4212                         smoother->squelch_x = 0;
4213                         smoother->squelch_y = 0;
4214
4215                         /* Activate queue */
4216                         smoother->active = 1;
4217                 } else {
4218                         /* Calculate the current delta. */
4219                         cursor = smoother->queue_cursor;
4220                         dx = x0 - smoother->queue[cursor].x;
4221                         dy = y0 - smoother->queue[cursor].y;
4222                 }
4223
4224                 VLOG(3, (LOG_DEBUG, "smoother%d: ipacket: [%d, %d], %d, %d\n",
4225                     smoother_id, x0, y0, f->p, f->w));
4226
4227                 /* Queue this new packet. */
4228                 cursor = SYNAPTICS_QUEUE_CURSOR(smoother->queue_cursor - 1);
4229                 smoother->queue[cursor].x = x0;
4230                 smoother->queue[cursor].y = y0;
4231                 smoother->queue_cursor = cursor;
4232                 if (smoother->queue_len < SYNAPTICS_PACKETQUEUE)
4233                         smoother->queue_len++;
4234                 VLOG(5, (LOG_DEBUG,
4235                     "smoother%d: cursor[%d]: x=%d, y=%d, dx=%d, dy=%d\n",
4236                     smoother_id, cursor, x0, y0, dx, dy));
4237
4238                 /* Do we have enough packets to consider this a movement? */
4239                 if (smoother->queue_len < gest->window_min)
4240                         return;
4241
4242                 weight_prev_x = weight_prev_y = weight_previous;
4243                 div_max_x = div_max_y = div_max;
4244
4245                 if (gest->in_vscroll) {
4246                         /* Dividers are different with virtual scrolling. */
4247                         div_min = sc->syninfo.vscroll_div_min;
4248                         div_max_x = div_max_y = sc->syninfo.vscroll_div_max;
4249                 } else {
4250                         /*
4251                          * There's a lot of noise in coordinates when
4252                          * the finger is on the touchpad's borders. When
4253                          * using this area, we apply a special weight and
4254                          * div.
4255                          */
4256                         if (x0 <= na_left || x0 >= max_x - na_right) {
4257                                 weight_prev_x = sc->syninfo.weight_previous_na;
4258                                 div_max_x = sc->syninfo.div_max_na;
4259                         }
4260
4261                         if (y0 <= na_bottom || y0 >= max_y - na_top) {
4262                                 weight_prev_y = sc->syninfo.weight_previous_na;
4263                                 div_max_y = sc->syninfo.div_max_na;
4264                         }
4265                 }
4266
4267                 /*
4268                  * Calculate weights for the average operands and
4269                  * the divisor. Both depend on the distance between
4270                  * the current packet and a previous one (based on the
4271                  * window width).
4272                  */
4273                 window = imin(smoother->queue_len, window_max);
4274                 peer = SYNAPTICS_QUEUE_CURSOR(cursor + window - 1);
4275                 dxp = abs(x0 - smoother->queue[peer].x) + 1;
4276                 dyp = abs(y0 - smoother->queue[peer].y) + 1;
4277                 len = (dxp * dxp) + (dyp * dyp);
4278                 weight_prev_x = imin(weight_prev_x,
4279                     weight_len_squared * weight_prev_x / len);
4280                 weight_prev_y = imin(weight_prev_y,
4281                     weight_len_squared * weight_prev_y / len);
4282
4283                 len = (dxp + dyp) / 2;
4284                 div_x = div_len * div_max_x / len;
4285                 div_x = imin(div_max_x, div_x);
4286                 div_x = imax(div_min, div_x);
4287                 div_y = div_len * div_max_y / len;
4288                 div_y = imin(div_max_y, div_y);
4289                 div_y = imax(div_min, div_y);
4290
4291                 VLOG(3, (LOG_DEBUG,
4292                     "smoother%d: peer=%d, len=%d, weight=%d/%d, div=%d/%d\n",
4293                     smoother_id, peer, len, weight_prev_x, weight_prev_y,
4294                     div_x, div_y));
4295
4296                 /* Compute averages. */
4297                 smoother->avg_dx =
4298                     (weight_current * dx * multiplicator +
4299                      weight_prev_x * smoother->avg_dx) /
4300                     (weight_current + weight_prev_x);
4301
4302                 smoother->avg_dy =
4303                     (weight_current * dy * multiplicator +
4304                      weight_prev_y * smoother->avg_dy) /
4305                     (weight_current + weight_prev_y);
4306
4307                 VLOG(5, (LOG_DEBUG,
4308                     "smoother%d: avg_dx~=%d, avg_dy~=%d\n", smoother_id,
4309                     smoother->avg_dx / multiplicator,
4310                     smoother->avg_dy / multiplicator));
4311
4312                 /* Use these averages to calculate x & y. */
4313                 smoother->squelch_x += smoother->avg_dx;
4314                 dxp = smoother->squelch_x / (div_x * multiplicator);
4315                 smoother->squelch_x = smoother->squelch_x %
4316                     (div_x * multiplicator);
4317
4318                 smoother->squelch_y += smoother->avg_dy;
4319                 dyp = smoother->squelch_y / (div_y * multiplicator);
4320                 smoother->squelch_y = smoother->squelch_y %
4321                     (div_y * multiplicator);
4322
4323                 switch(gest->in_vscroll) {
4324                 case 0: /* Pointer movement. */
4325                         /* On real<->fuzzy finger switch the x/y pos jumps */
4326                         if (is_fuzzy == smoother->is_fuzzy) {
4327                                 *x += dxp;
4328                                 *y += dyp;
4329                         }
4330
4331                         VLOG(3, (LOG_DEBUG, "smoother%d: [%d, %d] -> [%d, %d]\n",
4332                             smoother_id, dx, dy, dxp, dyp));
4333                         break;
4334                 case 1: /* Vertical scrolling. */
4335                         if (dyp != 0) {
4336                                 if (two_finger_scroll && natural_scroll)
4337                                         ms->button |= (dyp > 0) ?
4338                                             MOUSE_BUTTON5DOWN : MOUSE_BUTTON4DOWN;
4339                                 else
4340                                         ms->button |= (dyp > 0) ?
4341                                             MOUSE_BUTTON4DOWN : MOUSE_BUTTON5DOWN;
4342                         }
4343                         break;
4344                 case 2: /* Horizontal scrolling. */
4345                         if (dxp != 0) {
4346                                 if (two_finger_scroll && natural_scroll)
4347                                         ms->button |= (dxp > 0) ?
4348                                             MOUSE_BUTTON6DOWN : MOUSE_BUTTON7DOWN;
4349                                 else
4350                                         ms->button |= (dxp > 0) ?
4351                                             MOUSE_BUTTON7DOWN : MOUSE_BUTTON6DOWN;
4352                         }
4353                         break;
4354                 }
4355
4356                 smoother->is_fuzzy = is_fuzzy;
4357
4358         } else {
4359                 /*
4360                  * Deactivate queue. Note: We can not just reset queue here
4361                  * as these values are still used by gesture processor.
4362                  * So postpone reset till next touch.
4363                  */
4364                 smoother->active = 0;
4365         }
4366 }
4367
4368 static int
4369 proc_elantech(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
4370     int *x, int *y, int *z)
4371 {
4372         static int touchpad_button, trackpoint_button;
4373         finger_t fn, f[ELANTECH_MAX_FINGERS];
4374         int pkt, id, scale, i, nfingers, mask, palm;
4375
4376         if (!elantech_support)
4377                 return (0);
4378
4379         /* Determine packet format and do a sanity check for out of sync packets. */
4380         if (ELANTECH_PKT_IS_DEBOUNCE(pb, sc->elanhw.hwversion))
4381                 pkt = ELANTECH_PKT_NOP;
4382         else if (sc->elanhw.hastrackpoint && ELANTECH_PKT_IS_TRACKPOINT(pb))
4383                 pkt = ELANTECH_PKT_TRACKPOINT;
4384         else
4385         switch (sc->elanhw.hwversion) {
4386         case 2:
4387                 if (!ELANTECH_PKT_IS_V2(pb))
4388                         return (-1);
4389
4390                 pkt = (pb->ipacket[0] & 0xc0) == 0x80 ?
4391                     ELANTECH_PKT_V2_2FINGER : ELANTECH_PKT_V2_COMMON;
4392                 break;
4393         case 3:
4394                 if (!ELANTECH_PKT_IS_V3_HEAD(pb, sc->elanhw.hascrc) &&
4395                     !ELANTECH_PKT_IS_V3_TAIL(pb, sc->elanhw.hascrc))
4396                         return (-1);
4397
4398                 pkt = ELANTECH_PKT_V3;
4399                 break;
4400         case 4:
4401                 if (!ELANTECH_PKT_IS_V4(pb, sc->elanhw.hascrc))
4402                         return (-1);
4403
4404                 switch (pb->ipacket[3] & 0x03) {
4405                 case 0x00:
4406                         pkt = ELANTECH_PKT_V4_STATUS;
4407                         break;
4408                 case 0x01:
4409                         pkt = ELANTECH_PKT_V4_HEAD;
4410                         break;
4411                 case 0x02:
4412                         pkt = ELANTECH_PKT_V4_MOTION;
4413                         break;
4414                 default:
4415                         return (-1);
4416                 }
4417                 break;
4418         default:
4419                 return (-1);
4420         }
4421
4422         VLOG(5, (LOG_DEBUG, "elantech: ipacket format: %d\n", pkt));
4423
4424         for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
4425                 PSM_FINGER_RESET(f[id]);
4426
4427         *x = *y = *z = 0;
4428         ms->button = ms->obutton;
4429
4430         if (sc->syninfo.touchpad_off)
4431                 return (0);
4432
4433         /* Common legend
4434          * L: Left mouse button pressed
4435          * R: Right mouse button pressed
4436          * N: number of fingers on touchpad
4437          * X: absolute x value (horizontal)
4438          * Y: absolute y value (vertical)
4439          * W; width of the finger touch
4440          * P: pressure
4441          */
4442         switch (pkt) {
4443         case ELANTECH_PKT_V2_COMMON:    /* HW V2. One/Three finger touch */
4444                 /*               7   6   5   4   3   2   1   0 (LSB)
4445                  * -------------------------------------------
4446                  * ipacket[0]:  N1  N0  W3  W2   .   .   R   L
4447                  * ipacket[1]:  P7  P6  P5  P4 X11 X10  X9  X8
4448                  * ipacket[2]:  X7  X6  X5  X4  X3  X2  X1  X0
4449                  * ipacket[3]:  N4  VF  W1  W0   .   .   .  B2
4450                  * ipacket[4]:  P3  P1  P2  P0 Y11 Y10  Y9  Y8
4451                  * ipacket[5]:  Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0
4452                  * -------------------------------------------
4453                  * N4: set if more than 3 fingers (only in 3 fingers mode)
4454                  * VF: a kind of flag? (only on EF123, 0 when finger
4455                  *     is over one of the buttons, 1 otherwise)
4456                  * B2: (on EF113 only, 0 otherwise), one button pressed
4457                  * P & W is not reported on EF113 touchpads
4458                  */
4459                 nfingers = (pb->ipacket[0] & 0xc0) >> 6;
4460                 if (nfingers == 3 && (pb->ipacket[3] & 0x80))
4461                         nfingers = 4;
4462
4463                 if (nfingers == 0) {
4464                         mask = (1 << nfingers) - 1;     /* = 0x00 */
4465                         break;
4466                 }
4467
4468                 /* Map 3-rd and 4-th fingers to first finger */
4469                 mask = (1 << 1) - 1;    /* = 0x01 */
4470                 f[0] = ELANTECH_FINGER_SET_XYP(pb);
4471                 if (sc->elanhw.haspressure) {
4472                         f[0].w = ((pb->ipacket[0] & 0x30) >> 2) |
4473                             ((pb->ipacket[3] & 0x30) >> 4);
4474                 } else {
4475                         f[0].p = PSM_FINGER_DEFAULT_P;
4476                         f[0].w = PSM_FINGER_DEFAULT_W;
4477                 }
4478
4479                 /*
4480                  * HW v2 dont report exact finger positions when 3 or more
4481                  * fingers are on touchpad.
4482                  */
4483                 if (nfingers > 2)
4484                         f[0].flags = PSM_FINGER_FUZZY;
4485
4486                 break;
4487
4488         case ELANTECH_PKT_V2_2FINGER:   /*HW V2. Two finger touch */
4489                 /*               7   6   5   4   3   2   1   0 (LSB)
4490                  * -------------------------------------------
4491                  * ipacket[0]:  N1  N0 AY8 AX8   .   .   R   L
4492                  * ipacket[1]: AX7 AX6 AX5 AX4 AX3 AX2 AX1 AX0
4493                  * ipacket[2]: AY7 AY6 AY5 AY4 AY3 AY2 AY1 AY0
4494                  * ipacket[3]:   .   . BY8 BX8   .   .   .   .
4495                  * ipacket[4]: BX7 BX6 BX5 BX4 BX3 BX2 BX1 BX0
4496                  * ipacket[5]: BY7 BY6 BY5 BY4 BY3 BY2 BY1 BY0
4497                  * -------------------------------------------
4498                  * AX: lower-left finger absolute x value
4499                  * AY: lower-left finger absolute y value
4500                  * BX: upper-right finger absolute x value
4501                  * BY: upper-right finger absolute y value
4502                  */
4503                 nfingers = 2;
4504                 mask = (1 << nfingers) - 1;
4505
4506                 for (id = 0; id < imin(2, ELANTECH_MAX_FINGERS); id ++)
4507                         f[id] = (finger_t) {
4508                                 .x = (((pb->ipacket[id * 3] & 0x10) << 4) |
4509                                     pb->ipacket[id * 3 + 1]) << 2,
4510                                 .y = (((pb->ipacket[id * 3] & 0x20) << 3) |
4511                                     pb->ipacket[id * 3 + 2]) << 2,
4512                                 .p = PSM_FINGER_DEFAULT_P,
4513                                 .w = PSM_FINGER_DEFAULT_W,
4514                                 /* HW ver.2 sends bounding box */
4515                                 .flags = PSM_FINGER_FUZZY
4516                         };
4517                 break;
4518
4519         case ELANTECH_PKT_V3:   /* HW Version 3 */
4520                 /*               7   6   5   4   3   2   1   0 (LSB)
4521                  * -------------------------------------------
4522                  * ipacket[0]:  N1  N0  W3  W2   0   1   R   L
4523                  * ipacket[1]:  P7  P6  P5  P4 X11 X10  X9  X8
4524                  * ipacket[2]:  X7  X6  X5  X4  X3  X2  X1  X0
4525                  * ipacket[3]:   0   0  W1  W0   0   0   1   0
4526                  * ipacket[4]:  P3  P1  P2  P0 Y11 Y10  Y9  Y8
4527                  * ipacket[5]:  Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0
4528                  * -------------------------------------------
4529                  */
4530                 nfingers = (pb->ipacket[0] & 0xc0) >> 6;
4531                 /* Map 3-rd finger to first finger */
4532                 id = nfingers > 2 ? 0 : nfingers - 1;
4533                 mask = (1 << (id + 1)) - 1;
4534
4535                 if (nfingers == 0)
4536                         break;
4537
4538                 fn = ELANTECH_FINGER_SET_XYP(pb);
4539                 fn.w = ((pb->ipacket[0] & 0x30) >> 2) |
4540                     ((pb->ipacket[3] & 0x30) >> 4);
4541
4542                 /*
4543                  * HW v3 dont report exact finger positions when 3 or more
4544                  * fingers are on touchpad.
4545                  */
4546                 if (nfingers > 1)
4547                         fn.flags = PSM_FINGER_FUZZY;
4548
4549                 if (nfingers == 2) {
4550                         if (ELANTECH_PKT_IS_V3_HEAD(pb, sc->elanhw.hascrc)) {
4551                                 sc->elanaction.fingers[0] = fn;
4552                                 return (0);
4553                         } else
4554                                 f[0] = sc->elanaction.fingers[0];
4555                 }
4556                 f[id] = fn;
4557                 break;
4558
4559         case ELANTECH_PKT_V4_STATUS:    /* HW Version 4. Status packet */
4560                 /*               7   6   5   4   3   2   1   0 (LSB)
4561                  * -------------------------------------------
4562                  * ipacket[0]:   .   .   .   .   0   1   R   L
4563                  * ipacket[1]:   .   .   .  F4  F3  F2  F1  F0
4564                  * ipacket[2]:   .   .   .   .   .   .   .   .
4565                  * ipacket[3]:   .   .   .   1   0   0   0   0
4566                  * ipacket[4]:  PL   .   .   .   .   .   .   .
4567                  * ipacket[5]:   .   .   .   .   .   .   .   .
4568                  * -------------------------------------------
4569                  * Fn: finger n is on touchpad
4570                  * PL: palm
4571                  * HV ver4 sends a status packet to indicate that the numbers
4572                  * or identities of the fingers has been changed
4573                  */
4574
4575                 mask = pb->ipacket[1] & 0x1f;
4576                 nfingers = bitcount(mask);
4577
4578                 if (sc->elanaction.mask_v4wait != 0)
4579                         VLOG(3, (LOG_DEBUG, "elantech: HW v4 status packet"
4580                             " when not all previous head packets received\n"));
4581
4582                 /* Bitmap of fingers to receive before gesture processing */
4583                 sc->elanaction.mask_v4wait = mask & ~sc->elanaction.mask;
4584
4585                 /* Skip "new finger is on touchpad" packets */
4586                 if (sc->elanaction.mask_v4wait) {
4587                         sc->elanaction.mask = mask;
4588                         return (0);
4589                 }
4590
4591                 break;
4592
4593         case ELANTECH_PKT_V4_HEAD:      /* HW Version 4. Head packet */
4594                 /*               7   6   5   4   3   2   1   0 (LSB)
4595                  * -------------------------------------------
4596                  * ipacket[0]:  W3  W2  W1  W0   0   1   R   L
4597                  * ipacket[1]:  P7  P6  P5  P4 X11 X10  X9  X8
4598                  * ipacket[2]:  X7  X6  X5  X4  X3  X2  X1  X0
4599                  * ipacket[3]: ID2 ID1 ID0   1   0   0   0   1
4600                  * ipacket[4]:  P3  P1  P2  P0 Y11 Y10  Y9  Y8
4601                  * ipacket[5]:  Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0
4602                  * -------------------------------------------
4603                  * ID: finger id
4604                  * HW ver 4 sends head packets in two cases:
4605                  * 1. One finger touch and movement.
4606                  * 2. Next after status packet to tell new finger positions.
4607                  */
4608                 mask = sc->elanaction.mask;
4609                 nfingers = bitcount(mask);
4610                 id = ((pb->ipacket[3] & 0xe0) >> 5) - 1;
4611                 fn = ELANTECH_FINGER_SET_XYP(pb);
4612                 fn.w =(pb->ipacket[0] & 0xf0) >> 4;
4613
4614                 if (id < 0)
4615                         return (0);
4616
4617                 /* Packet is finger position update. Report it */
4618                 if (sc->elanaction.mask_v4wait == 0) {
4619                         if (id < ELANTECH_MAX_FINGERS)
4620                                 f[id] = fn;
4621                         break;
4622                 }
4623
4624                 /* Remove finger from waiting bitmap and store into context */
4625                 sc->elanaction.mask_v4wait &= ~(1 << id);
4626                 if (id < ELANTECH_MAX_FINGERS)
4627                         sc->elanaction.fingers[id] = fn;
4628
4629                 /* Wait for other fingers if needed */
4630                 if (sc->elanaction.mask_v4wait != 0)
4631                         return (0);
4632
4633                 /* All new fingers are received. Report them from context */
4634                 for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
4635                         if (sc->elanaction.mask & (1 << id))
4636                                 f[id] =  sc->elanaction.fingers[id];
4637
4638                 break;
4639
4640         case ELANTECH_PKT_V4_MOTION:    /* HW Version 4. Motion packet */
4641                 /*               7   6   5   4   3   2   1   0 (LSB)
4642                  * -------------------------------------------
4643                  * ipacket[0]: ID2 ID1 ID0  OF   0   1   R   L
4644                  * ipacket[1]: DX7 DX6 DX5 DX4 DX3 DX2 DX1 DX0
4645                  * ipacket[2]: DY7 DY6 DY5 DY4 DY3 DY2 DY1 DY0
4646                  * ipacket[3]: ID2 ID1 ID0   1   0   0   1   0
4647                  * ipacket[4]: DX7 DX6 DX5 DX4 DX3 DX2 DX1 DX0
4648                  * ipacket[5]: DY7 DY6 DY5 DY4 DY3 DY2 DY1 DY0
4649                  * -------------------------------------------
4650                  * OF: delta overflows (> 127 or < -128), in this case
4651                  *     firmware sends us (delta x / 5) and (delta y / 5)
4652                  * ID: finger id
4653                  * DX: delta x (two's complement)
4654                  * XY: delta y (two's complement)
4655                  * byte 0 ~ 2 for one finger
4656                  * byte 3 ~ 5 for another finger
4657                  */
4658                 mask = sc->elanaction.mask;
4659                 nfingers = bitcount(mask);
4660
4661                 scale = (pb->ipacket[0] & 0x10) ? 5 : 1;
4662                 for (i = 0; i <= 3; i += 3) {
4663                         id = ((pb->ipacket[i] & 0xe0) >> 5) - 1;
4664                         if (id < 0 || id >= ELANTECH_MAX_FINGERS)
4665                                 continue;
4666
4667                         if (PSM_FINGER_IS_SET(sc->elanaction.fingers[id])) {
4668                                 f[id] = sc->elanaction.fingers[id];
4669                                 f[id].x += imax(-f[id].x,
4670                                     (signed char)pb->ipacket[i+1] * scale);
4671                                 f[id].y += imax(-f[id].y,
4672                                     (signed char)pb->ipacket[i+2] * scale);
4673                         } else {
4674                                 VLOG(3, (LOG_DEBUG, "elantech: "
4675                                     "HW v4 motion packet skipped\n"));
4676                         }
4677                 }
4678
4679                 break;
4680
4681         case ELANTECH_PKT_TRACKPOINT:
4682                 /*               7   6   5   4   3   2   1   0 (LSB)
4683                  * -------------------------------------------
4684                  * ipacket[0]:   0   0  SY  SX   0   M   R   L
4685                  * ipacket[1]: ~SX   0   0   0   0   0   0   0
4686                  * ipacket[2]: ~SY   0   0   0   0   0   0   0
4687                  * ipacket[3]:   0   0 ~SY ~SX   0   1   1   0
4688                  * ipacket[4]:  X7  X6  X5  X4  X3  X2  X1  X0
4689                  * ipacket[5]:  Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0
4690                  * -------------------------------------------
4691                  * X and Y are written in two's complement spread
4692                  * over 9 bits with SX/SY the relative top bit and
4693                  * X7..X0 and Y7..Y0 the lower bits.
4694                  */
4695                 if (!(pb->ipacket[0] & 0xC8) && !(pb->ipacket[1] & 0x7F) &&
4696                     !(pb->ipacket[2] & 0x7F) && !(pb->ipacket[3] & 0xC9) &&
4697                     !(pb->ipacket[0] & 0x10) != !(pb->ipacket[1] & 0x80) &&
4698                     !(pb->ipacket[0] & 0x10) != !(pb->ipacket[3] & 0x10) &&
4699                     !(pb->ipacket[0] & 0x20) != !(pb->ipacket[2] & 0x80) &&
4700                     !(pb->ipacket[0] & 0x20) != !(pb->ipacket[3] & 0x20)) {
4701
4702                         *x = (pb->ipacket[0] & MOUSE_PS2_XNEG) ?
4703                             pb->ipacket[4] - 256 : pb->ipacket[4];
4704                         *y = (pb->ipacket[0] & MOUSE_PS2_YNEG) ?
4705                             pb->ipacket[5] - 256 : pb->ipacket[5];
4706
4707                         trackpoint_button =
4708                             ((pb->ipacket[0] & 0x01) ? MOUSE_BUTTON1DOWN : 0) |
4709                             ((pb->ipacket[0] & 0x02) ? MOUSE_BUTTON3DOWN : 0) |
4710                             ((pb->ipacket[0] & 0x04) ? MOUSE_BUTTON2DOWN : 0);
4711 #ifdef EVDEV_SUPPORT
4712                         evdev_push_rel(sc->evdev_r, REL_X, *x);
4713                         evdev_push_rel(sc->evdev_r, REL_Y, -*y);
4714                         evdev_push_mouse_btn(sc->evdev_r, trackpoint_button);
4715                         evdev_sync(sc->evdev_r);
4716 #endif
4717                         ms->button = touchpad_button | trackpoint_button;
4718                 } else
4719                         VLOG(3, (LOG_DEBUG, "elantech: "
4720                             "unexpected trackpoint packet skipped\n"));
4721                 return (0);
4722
4723         case ELANTECH_PKT_NOP:
4724                 return (0);
4725
4726         default:
4727                 return (-1);
4728         }
4729
4730         for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
4731                 if (PSM_FINGER_IS_SET(f[id]))
4732                         VLOG(2, (LOG_DEBUG, "elantech: "
4733                             "finger %d: down [%d, %d], %d, %d, %d\n", id + 1,
4734                             f[id].x, f[id].y, f[id].p, f[id].w, f[id].flags));
4735
4736         /* Touchpad button presses */
4737         if (sc->elanhw.isclickpad) {
4738                 touchpad_button =
4739                     ((pb->ipacket[0] & 0x03) ? MOUSE_BUTTON1DOWN : 0);
4740         } else {
4741                 touchpad_button =
4742                     ((pb->ipacket[0] & 0x01) ? MOUSE_BUTTON1DOWN : 0) |
4743                     ((pb->ipacket[0] & 0x02) ? MOUSE_BUTTON3DOWN : 0);
4744         }
4745
4746 #ifdef EVDEV_SUPPORT
4747         if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
4748                 for (id = 0; id < ELANTECH_MAX_FINGERS; id++) {
4749                         if (PSM_FINGER_IS_SET(f[id])) {
4750                                 psm_push_mt_finger(sc, id, &f[id]);
4751                                 /* Convert touch width to surface units */
4752                                 evdev_push_abs(sc->evdev_a, ABS_MT_TOUCH_MAJOR,
4753                                     f[id].w * sc->elanhw.dptracex);
4754                         }
4755                         if (sc->elanaction.mask & (1 << id) &&
4756                             !(mask & (1 << id)))
4757                                 psm_release_mt_slot(sc->evdev_a, id);
4758                 }
4759                 evdev_push_key(sc->evdev_a, BTN_TOUCH, nfingers > 0);
4760                 evdev_push_nfingers(sc->evdev_a, nfingers);
4761                 if (nfingers > 0) {
4762                         if (PSM_FINGER_IS_SET(f[0]))
4763                                 psm_push_st_finger(sc, &f[0]);
4764                 } else
4765                         evdev_push_abs(sc->evdev_a, ABS_PRESSURE, 0);
4766                 evdev_push_mouse_btn(sc->evdev_a, touchpad_button);
4767                 evdev_sync(sc->evdev_a);
4768         }
4769 #endif
4770
4771         ms->button = touchpad_button | trackpoint_button;
4772
4773         /* Palm detection doesn't terminate the current action. */
4774         palm = psmpalmdetect(sc, &f[0], nfingers);
4775
4776         /* Send finger 1 position to gesture processor */
4777         if ((PSM_FINGER_IS_SET(f[0]) || PSM_FINGER_IS_SET(f[1]) ||
4778             nfingers == 0) && !palm)
4779                 psmgestures(sc, &f[0], imin(nfingers, 3), ms);
4780
4781         /* Send fingers positions to movement smoothers */
4782         for (id = 0; id < PSM_FINGERS; id++)
4783                 if (PSM_FINGER_IS_SET(f[id]) || !(mask & (1 << id)))
4784                         psmsmoother(sc, &f[id], id, ms, x, y);
4785
4786         /* Store current finger positions in action context */
4787         for (id = 0; id < ELANTECH_MAX_FINGERS; id++) {
4788                 if (PSM_FINGER_IS_SET(f[id]))
4789                         sc->elanaction.fingers[id] = f[id];
4790                 if ((sc->elanaction.mask & (1 << id)) && !(mask & (1 << id)))
4791                         PSM_FINGER_RESET(sc->elanaction.fingers[id]);
4792         }
4793         sc->elanaction.mask = mask;
4794
4795         if (palm) {
4796                 *x = *y = *z = 0;
4797                 ms->button = ms->obutton;
4798                 return (0);
4799         }
4800
4801         /* Use the extra buttons as a scrollwheel */
4802         if (ms->button & MOUSE_BUTTON4DOWN)
4803                 *z = -1;
4804         else if (ms->button & MOUSE_BUTTON5DOWN)
4805                 *z = 1;
4806         else if (ms->button & MOUSE_BUTTON6DOWN)
4807                 *z = -2;
4808         else if (ms->button & MOUSE_BUTTON7DOWN)
4809                 *z = 2;
4810         else
4811                 *z = 0;
4812         ms->button &= ~(MOUSE_BUTTON4DOWN | MOUSE_BUTTON5DOWN |
4813             MOUSE_BUTTON6DOWN | MOUSE_BUTTON7DOWN);
4814
4815         return (0);
4816 }
4817
4818 static void
4819 proc_versapad(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
4820     int *x, int *y, int *z)
4821 {
4822         static int butmap_versapad[8] = {
4823                 0,
4824                 MOUSE_BUTTON3DOWN,
4825                 0,
4826                 MOUSE_BUTTON3DOWN,
4827                 MOUSE_BUTTON1DOWN,
4828                 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
4829                 MOUSE_BUTTON1DOWN,
4830                 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN
4831         };
4832         int c, x0, y0;
4833
4834         /* VersaPad PS/2 absolute mode message format
4835          *
4836          * [packet1]     7   6   5   4   3   2   1   0(LSB)
4837          *  ipacket[0]:  1   1   0   A   1   L   T   R
4838          *  ipacket[1]: H7  H6  H5  H4  H3  H2  H1  H0
4839          *  ipacket[2]: V7  V6  V5  V4  V3  V2  V1  V0
4840          *  ipacket[3]:  1   1   1   A   1   L   T   R
4841          *  ipacket[4]:V11 V10  V9  V8 H11 H10  H9  H8
4842          *  ipacket[5]:  0  P6  P5  P4  P3  P2  P1  P0
4843          *
4844          * [note]
4845          *  R: right physical mouse button (1=on)
4846          *  T: touch pad virtual button (1=tapping)
4847          *  L: left physical mouse button (1=on)
4848          *  A: position data is valid (1=valid)
4849          *  H: horizontal data (12bit signed integer. H11 is sign bit.)
4850          *  V: vertical data (12bit signed integer. V11 is sign bit.)
4851          *  P: pressure data
4852          *
4853          * Tapping is mapped to MOUSE_BUTTON4.
4854          */
4855         c = pb->ipacket[0];
4856         *x = *y = 0;
4857         ms->button = butmap_versapad[c & MOUSE_PS2VERSA_BUTTONS];
4858         ms->button |= (c & MOUSE_PS2VERSA_TAP) ? MOUSE_BUTTON4DOWN : 0;
4859         if (c & MOUSE_PS2VERSA_IN_USE) {
4860                 x0 = pb->ipacket[1] | (((pb->ipacket[4]) & 0x0f) << 8);
4861                 y0 = pb->ipacket[2] | (((pb->ipacket[4]) & 0xf0) << 4);
4862                 if (x0 & 0x800)
4863                         x0 -= 0x1000;
4864                 if (y0 & 0x800)
4865                         y0 -= 0x1000;
4866                 if (sc->flags & PSM_FLAGS_FINGERDOWN) {
4867                         *x = sc->xold - x0;
4868                         *y = y0 - sc->yold;
4869                         if (*x < 0)     /* XXX */
4870                                 ++*x;
4871                         else if (*x)
4872                                 --*x;
4873                         if (*y < 0)
4874                                 ++*y;
4875                         else if (*y)
4876                                 --*y;
4877                 } else
4878                         sc->flags |= PSM_FLAGS_FINGERDOWN;
4879                 sc->xold = x0;
4880                 sc->yold = y0;
4881         } else
4882                 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
4883 }
4884
4885 static void
4886 psmsoftintridle(void *arg)
4887 {
4888         struct psm_softc *sc = arg;
4889         packetbuf_t *pb;
4890
4891         /* Invoke soft handler only when pqueue is empty. Otherwise it will be
4892          * invoked from psmintr soon with pqueue filled with real data */
4893         if (sc->pqueue_start == sc->pqueue_end &&
4894             sc->idlepacket.inputbytes > 0) {
4895                 /* Grow circular queue backwards to avoid race with psmintr */
4896                 if (--sc->pqueue_start < 0)
4897                         sc->pqueue_start = PSM_PACKETQUEUE - 1;
4898
4899                 pb = &sc->pqueue[sc->pqueue_start];
4900                 memcpy(pb, &sc->idlepacket, sizeof(packetbuf_t));
4901                 VLOG(4, (LOG_DEBUG,
4902                     "psmsoftintridle: %02x %02x %02x %02x %02x %02x\n",
4903                     pb->ipacket[0], pb->ipacket[1], pb->ipacket[2],
4904                     pb->ipacket[3], pb->ipacket[4], pb->ipacket[5]));
4905
4906                 psmsoftintr(arg);
4907         }
4908 }
4909
4910 static void
4911 psmsoftintr(void *arg)
4912 {
4913         /*
4914          * the table to turn PS/2 mouse button bits (MOUSE_PS2_BUTTON?DOWN)
4915          * into `mousestatus' button bits (MOUSE_BUTTON?DOWN).
4916          */
4917         static int butmap[8] = {
4918                 0,
4919                 MOUSE_BUTTON1DOWN,
4920                 MOUSE_BUTTON3DOWN,
4921                 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
4922                 MOUSE_BUTTON2DOWN,
4923                 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN,
4924                 MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN,
4925                 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN
4926         };
4927         struct psm_softc *sc = arg;
4928         mousestatus_t ms;
4929         packetbuf_t *pb;
4930         int x, y, z, c, l, s;
4931
4932         getmicrouptime(&sc->lastsoftintr);
4933
4934         s = spltty();
4935
4936         do {
4937                 pb = &sc->pqueue[sc->pqueue_start];
4938
4939                 if (sc->mode.level == PSM_LEVEL_NATIVE)
4940                         goto next_native;
4941
4942                 c = pb->ipacket[0];
4943                 /*
4944                  * A kludge for Kensington device!
4945                  * The MSB of the horizontal count appears to be stored in
4946                  * a strange place.
4947                  */
4948                 if (sc->hw.model == MOUSE_MODEL_THINK)
4949                         pb->ipacket[1] |= (c & MOUSE_PS2_XOVERFLOW) ? 0x80 : 0;
4950
4951                 /* ignore the overflow bits... */
4952                 x = (c & MOUSE_PS2_XNEG) ?
4953                     pb->ipacket[1] - 256 : pb->ipacket[1];
4954                 y = (c & MOUSE_PS2_YNEG) ?
4955                     pb->ipacket[2] - 256 : pb->ipacket[2];
4956                 z = 0;
4957                 ms.obutton = sc->button;          /* previous button state */
4958                 ms.button = butmap[c & MOUSE_PS2_BUTTONS];
4959                 /* `tapping' action */
4960                 if (sc->config & PSM_CONFIG_FORCETAP)
4961                         ms.button |= ((c & MOUSE_PS2_TAP)) ?
4962                             0 : MOUSE_BUTTON4DOWN;
4963                 timevalclear(&sc->idletimeout);
4964                 sc->idlepacket.inputbytes = 0;
4965
4966                 switch (sc->hw.model) {
4967
4968                 case MOUSE_MODEL_EXPLORER:
4969                         /*
4970                          *          b7 b6 b5 b4 b3 b2 b1 b0
4971                          * byte 1:  oy ox sy sx 1  M  R  L
4972                          * byte 2:  x  x  x  x  x  x  x  x
4973                          * byte 3:  y  y  y  y  y  y  y  y
4974                          * byte 4:  *  *  S2 S1 s  d2 d1 d0
4975                          *
4976                          * L, M, R, S1, S2: left, middle, right and side buttons
4977                          * s: wheel data sign bit
4978                          * d2-d0: wheel data
4979                          */
4980                         z = (pb->ipacket[3] & MOUSE_EXPLORER_ZNEG) ?
4981                             (pb->ipacket[3] & 0x0f) - 16 :
4982                             (pb->ipacket[3] & 0x0f);
4983                         ms.button |=
4984                             (pb->ipacket[3] & MOUSE_EXPLORER_BUTTON4DOWN) ?
4985                             MOUSE_BUTTON4DOWN : 0;
4986                         ms.button |=
4987                             (pb->ipacket[3] & MOUSE_EXPLORER_BUTTON5DOWN) ?
4988                             MOUSE_BUTTON5DOWN : 0;
4989                         break;
4990
4991                 case MOUSE_MODEL_INTELLI:
4992                 case MOUSE_MODEL_NET:
4993                         /* wheel data is in the fourth byte */
4994                         z = (char)pb->ipacket[3];
4995                         /*
4996                          * XXX some mice may send 7 when there is no Z movement?                         */
4997                         if ((z >= 7) || (z <= -7))
4998                                 z = 0;
4999                         /* some compatible mice have additional buttons */
5000                         ms.button |= (c & MOUSE_PS2INTELLI_BUTTON4DOWN) ?
5001                             MOUSE_BUTTON4DOWN : 0;
5002                         ms.button |= (c & MOUSE_PS2INTELLI_BUTTON5DOWN) ?
5003                             MOUSE_BUTTON5DOWN : 0;
5004                         break;
5005
5006                 case MOUSE_MODEL_MOUSEMANPLUS:
5007                         proc_mmanplus(sc, pb, &ms, &x, &y, &z);
5008                         break;
5009
5010                 case MOUSE_MODEL_GLIDEPOINT:
5011                         /* `tapping' action */
5012                         ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 :
5013                             MOUSE_BUTTON4DOWN;
5014                         break;
5015
5016                 case MOUSE_MODEL_NETSCROLL:
5017                         /*
5018                          * three additional bytes encode buttons and
5019                          * wheel events
5020                          */
5021                         ms.button |= (pb->ipacket[3] & MOUSE_PS2_BUTTON3DOWN) ?
5022                             MOUSE_BUTTON4DOWN : 0;
5023                         ms.button |= (pb->ipacket[3] & MOUSE_PS2_BUTTON1DOWN) ?
5024                             MOUSE_BUTTON5DOWN : 0;
5025                         z = (pb->ipacket[3] & MOUSE_PS2_XNEG) ?
5026                             pb->ipacket[4] - 256 : pb->ipacket[4];
5027                         break;
5028
5029                 case MOUSE_MODEL_THINK:
5030                         /* the fourth button state in the first byte */
5031                         ms.button |= (c & MOUSE_PS2_TAP) ?
5032                             MOUSE_BUTTON4DOWN : 0;
5033                         break;
5034
5035                 case MOUSE_MODEL_VERSAPAD:
5036                         proc_versapad(sc, pb, &ms, &x, &y, &z);
5037                         c = ((x < 0) ? MOUSE_PS2_XNEG : 0) |
5038                             ((y < 0) ? MOUSE_PS2_YNEG : 0);
5039                         break;
5040
5041                 case MOUSE_MODEL_4D:
5042                         /*
5043                          *          b7 b6 b5 b4 b3 b2 b1 b0
5044                          * byte 1:  s2 d2 s1 d1 1  M  R  L
5045                          * byte 2:  sx x  x  x  x  x  x  x
5046                          * byte 3:  sy y  y  y  y  y  y  y
5047                          *
5048                          * s1: wheel 1 direction
5049                          * d1: wheel 1 data
5050                          * s2: wheel 2 direction
5051                          * d2: wheel 2 data
5052                          */
5053                         x = (pb->ipacket[1] & 0x80) ?
5054                             pb->ipacket[1] - 256 : pb->ipacket[1];
5055                         y = (pb->ipacket[2] & 0x80) ?
5056                             pb->ipacket[2] - 256 : pb->ipacket[2];
5057                         switch (c & MOUSE_4D_WHEELBITS) {
5058                         case 0x10:
5059                                 z = 1;
5060                                 break;
5061                         case 0x30:
5062                                 z = -1;
5063                                 break;
5064                         case 0x40:      /* XXX 2nd wheel turning right */
5065                                 z = 2;
5066                                 break;
5067                         case 0xc0:      /* XXX 2nd wheel turning left */
5068                                 z = -2;
5069                                 break;
5070                         }
5071                         break;
5072
5073                 case MOUSE_MODEL_4DPLUS:
5074                         if ((x < 16 - 256) && (y < 16 - 256)) {
5075                                 /*
5076                                  *          b7 b6 b5 b4 b3 b2 b1 b0
5077                                  * byte 1:  0  0  1  1  1  M  R  L
5078                                  * byte 2:  0  0  0  0  1  0  0  0
5079                                  * byte 3:  0  0  0  0  S  s  d1 d0
5080                                  *
5081                                  * L, M, R, S: left, middle, right,
5082                                  *             and side buttons
5083                                  * s: wheel data sign bit
5084                                  * d1-d0: wheel data
5085                                  */
5086                                 x = y = 0;
5087                                 if (pb->ipacket[2] & MOUSE_4DPLUS_BUTTON4DOWN)
5088                                         ms.button |= MOUSE_BUTTON4DOWN;
5089                                 z = (pb->ipacket[2] & MOUSE_4DPLUS_ZNEG) ?
5090                                     ((pb->ipacket[2] & 0x07) - 8) :
5091                                     (pb->ipacket[2] & 0x07) ;
5092                         } else {
5093                                 /* preserve previous button states */
5094                                 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
5095                         }
5096                         break;
5097
5098                 case MOUSE_MODEL_SYNAPTICS:
5099                         if (pb->inputbytes == MOUSE_PS2_PACKETSIZE)
5100                                 if (proc_synaptics_mux(sc, pb))
5101                                         goto next;
5102
5103                         if (proc_synaptics(sc, pb, &ms, &x, &y, &z) != 0) {
5104                                 VLOG(3, (LOG_DEBUG, "synaptics: "
5105                                     "packet rejected\n"));
5106                                 goto next;
5107                         }
5108                         break;
5109
5110                 case MOUSE_MODEL_ELANTECH:
5111                         if (proc_elantech(sc, pb, &ms, &x, &y, &z) != 0) {
5112                                 VLOG(3, (LOG_DEBUG, "elantech: "
5113                                     "packet rejected\n"));
5114                                 goto next;
5115                         }
5116                         break;
5117
5118                 case MOUSE_MODEL_TRACKPOINT:
5119                 case MOUSE_MODEL_GENERIC:
5120                 default:
5121                         break;
5122                 }
5123
5124 #ifdef EVDEV_SUPPORT
5125         if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE &&
5126             sc->hw.model != MOUSE_MODEL_ELANTECH &&
5127             sc->hw.model != MOUSE_MODEL_SYNAPTICS) {
5128                 evdev_push_rel(sc->evdev_r, REL_X, x);
5129                 evdev_push_rel(sc->evdev_r, REL_Y, -y);
5130
5131                 switch (sc->hw.model) {
5132                 case MOUSE_MODEL_EXPLORER:
5133                 case MOUSE_MODEL_INTELLI:
5134                 case MOUSE_MODEL_NET:
5135                 case MOUSE_MODEL_NETSCROLL:
5136                 case MOUSE_MODEL_4DPLUS:
5137                         evdev_push_rel(sc->evdev_r, REL_WHEEL, -z);
5138                         break;
5139                 case MOUSE_MODEL_MOUSEMANPLUS:
5140                 case MOUSE_MODEL_4D:
5141                         switch (z) {
5142                         case 1:
5143                         case -1:
5144                                 evdev_push_rel(sc->evdev_r, REL_WHEEL, -z);
5145                                 break;
5146                         case 2:
5147                         case -2:
5148                                 evdev_push_rel(sc->evdev_r, REL_HWHEEL, z / 2);
5149                                 break;
5150                         }
5151                         break;
5152                 }
5153
5154                 evdev_push_mouse_btn(sc->evdev_r, ms.button);
5155                 evdev_sync(sc->evdev_r);
5156         }
5157 #endif
5158
5159         /* scale values */
5160         if (sc->mode.accelfactor >= 1) {
5161                 if (x != 0) {
5162                         x = x * x / sc->mode.accelfactor;
5163                         if (x == 0)
5164                                 x = 1;
5165                         if (c & MOUSE_PS2_XNEG)
5166                                 x = -x;
5167                 }
5168                 if (y != 0) {
5169                         y = y * y / sc->mode.accelfactor;
5170                         if (y == 0)
5171                                 y = 1;
5172                         if (c & MOUSE_PS2_YNEG)
5173                                 y = -y;
5174                 }
5175         }
5176
5177         /* Store last packet for reinjection if it has not been set already */
5178         if (timevalisset(&sc->idletimeout) && sc->idlepacket.inputbytes == 0)
5179                 sc->idlepacket = *pb;
5180
5181         ms.dx = x;
5182         ms.dy = y;
5183         ms.dz = z;
5184         ms.flags = ((x || y || z) ? MOUSE_POSCHANGED : 0) |
5185             (ms.obutton ^ ms.button);
5186
5187         pb->inputbytes = tame_mouse(sc, pb, &ms, pb->ipacket);
5188
5189         sc->status.flags |= ms.flags;
5190         sc->status.dx += ms.dx;
5191         sc->status.dy += ms.dy;
5192         sc->status.dz += ms.dz;
5193         sc->status.button = ms.button;
5194         sc->button = ms.button;
5195
5196 next_native:
5197         sc->watchdog = FALSE;
5198
5199         /* queue data */
5200         if (sc->queue.count + pb->inputbytes < sizeof(sc->queue.buf)) {
5201                 l = imin(pb->inputbytes,
5202                     sizeof(sc->queue.buf) - sc->queue.tail);
5203                 bcopy(&pb->ipacket[0], &sc->queue.buf[sc->queue.tail], l);
5204                 if (pb->inputbytes > l)
5205                         bcopy(&pb->ipacket[l], &sc->queue.buf[0],
5206                             pb->inputbytes - l);
5207                 sc->queue.tail = (sc->queue.tail + pb->inputbytes) %
5208                     sizeof(sc->queue.buf);
5209                 sc->queue.count += pb->inputbytes;
5210         }
5211
5212 next:
5213         pb->inputbytes = 0;
5214         if (++sc->pqueue_start >= PSM_PACKETQUEUE)
5215                 sc->pqueue_start = 0;
5216         } while (sc->pqueue_start != sc->pqueue_end);
5217
5218         if (sc->state & PSM_ASLP) {
5219                 sc->state &= ~PSM_ASLP;
5220                 wakeup(sc);
5221         }
5222         selwakeuppri(&sc->rsel, PZERO);
5223         if (sc->async != NULL) {
5224                 pgsigio(&sc->async, SIGIO, 0);
5225         }
5226         sc->state &= ~PSM_SOFTARMED;
5227
5228         /* schedule injection of predefined packet after idletimeout
5229          * if no data packets have been received from psmintr */
5230         if (timevalisset(&sc->idletimeout)) {
5231                 sc->state |= PSM_SOFTARMED;
5232                 callout_reset(&sc->softcallout, tvtohz(&sc->idletimeout),
5233                     psmsoftintridle, sc);
5234                 VLOG(2, (LOG_DEBUG, "softintr: callout set: %d ticks\n",
5235                     tvtohz(&sc->idletimeout)));
5236         }
5237         splx(s);
5238 }
5239
5240 static int
5241 psmpoll(struct cdev *dev, int events, struct thread *td)
5242 {
5243         struct psm_softc *sc = dev->si_drv1;
5244         int s;
5245         int revents = 0;
5246
5247         /* Return true if a mouse event available */
5248         s = spltty();
5249         if (events & (POLLIN | POLLRDNORM)) {
5250                 if (sc->queue.count > 0)
5251                         revents |= events & (POLLIN | POLLRDNORM);
5252                 else
5253                         selrecord(td, &sc->rsel);
5254         }
5255         splx(s);
5256
5257         return (revents);
5258 }
5259
5260 /* vendor/model specific routines */
5261
5262 static int mouse_id_proc1(KBDC kbdc, int res, int scale, int *status)
5263 {
5264         if (set_mouse_resolution(kbdc, res) != res)
5265                 return (FALSE);
5266         if (set_mouse_scaling(kbdc, scale) &&
5267             set_mouse_scaling(kbdc, scale) &&
5268             set_mouse_scaling(kbdc, scale) &&
5269             (get_mouse_status(kbdc, status, 0, 3) >= 3))
5270                 return (TRUE);
5271         return (FALSE);
5272 }
5273
5274 static int
5275 mouse_ext_command(KBDC kbdc, int command)
5276 {
5277         int c;
5278
5279         c = (command >> 6) & 0x03;
5280         if (set_mouse_resolution(kbdc, c) != c)
5281                 return (FALSE);
5282         c = (command >> 4) & 0x03;
5283         if (set_mouse_resolution(kbdc, c) != c)
5284                 return (FALSE);
5285         c = (command >> 2) & 0x03;
5286         if (set_mouse_resolution(kbdc, c) != c)
5287                 return (FALSE);
5288         c = (command >> 0) & 0x03;
5289         if (set_mouse_resolution(kbdc, c) != c)
5290                 return (FALSE);
5291         return (TRUE);
5292 }
5293
5294 #ifdef notyet
5295 /* Logitech MouseMan Cordless II */
5296 static int
5297 enable_lcordless(struct psm_softc *sc, enum probearg arg)
5298 {
5299         KBDC kbdc = sc->kbdc;
5300         int status[3];
5301         int ch;
5302
5303         if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 2, status))
5304                 return (FALSE);
5305         if (status[1] == PSMD_RES_HIGH)
5306                 return (FALSE);
5307         ch = (status[0] & 0x07) - 1;    /* channel # */
5308         if ((ch <= 0) || (ch > 4))
5309                 return (FALSE);
5310         /*
5311          * status[1]: always one?
5312          * status[2]: battery status? (0-100)
5313          */
5314         return (TRUE);
5315 }
5316 #endif /* notyet */
5317
5318 /* Genius NetScroll Mouse, MouseSystems SmartScroll Mouse */
5319 static int
5320 enable_groller(struct psm_softc *sc, enum probearg arg)
5321 {
5322         KBDC kbdc = sc->kbdc;
5323         int status[3];
5324
5325         /*
5326          * The special sequence to enable the fourth button and the
5327          * roller. Immediately after this sequence check status bytes.
5328          * if the mouse is NetScroll, the second and the third bytes are
5329          * '3' and 'D'.
5330          */
5331
5332         /*
5333          * If the mouse is an ordinary PS/2 mouse, the status bytes should
5334          * look like the following.
5335          *
5336          * byte 1 bit 7 always 0
5337          *        bit 6 stream mode (0)
5338          *        bit 5 disabled (0)
5339          *        bit 4 1:1 scaling (0)
5340          *        bit 3 always 0
5341          *        bit 0-2 button status
5342          * byte 2 resolution (PSMD_RES_HIGH)
5343          * byte 3 report rate (?)
5344          */
5345
5346         if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 1, status))
5347                 return (FALSE);
5348         if ((status[1] != '3') || (status[2] != 'D'))
5349                 return (FALSE);
5350         /* FIXME: SmartScroll Mouse has 5 buttons! XXX */
5351         if (arg == PROBE)
5352                 sc->hw.buttons = 4;
5353         return (TRUE);
5354 }
5355
5356 /* Genius NetMouse/NetMouse Pro, ASCII Mie Mouse, NetScroll Optical */
5357 static int
5358 enable_gmouse(struct psm_softc *sc, enum probearg arg)
5359 {
5360         KBDC kbdc = sc->kbdc;
5361         int status[3];
5362
5363         /*
5364          * The special sequence to enable the middle, "rubber" button.
5365          * Immediately after this sequence check status bytes.
5366          * if the mouse is NetMouse, NetMouse Pro, or ASCII MIE Mouse,
5367          * the second and the third bytes are '3' and 'U'.
5368          * NOTE: NetMouse reports that it has three buttons although it has
5369          * two buttons and a rubber button. NetMouse Pro and MIE Mouse
5370          * say they have three buttons too and they do have a button on the
5371          * side...
5372          */
5373         if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 1, status))
5374                 return (FALSE);
5375         if ((status[1] != '3') || (status[2] != 'U'))
5376                 return (FALSE);
5377         return (TRUE);
5378 }
5379
5380 /* ALPS GlidePoint */
5381 static int
5382 enable_aglide(struct psm_softc *sc, enum probearg arg)
5383 {
5384         KBDC kbdc = sc->kbdc;
5385         int status[3];
5386
5387         /*
5388          * The special sequence to obtain ALPS GlidePoint specific
5389          * information. Immediately after this sequence, status bytes will
5390          * contain something interesting.
5391          * NOTE: ALPS produces several models of GlidePoint. Some of those
5392          * do not respond to this sequence, thus, cannot be detected this way.
5393          */
5394         if (set_mouse_sampling_rate(kbdc, 100) != 100)
5395                 return (FALSE);
5396         if (!mouse_id_proc1(kbdc, PSMD_RES_LOW, 2, status))
5397                 return (FALSE);
5398         if ((status[1] == PSMD_RES_LOW) || (status[2] == 100))
5399                 return (FALSE);
5400         return (TRUE);
5401 }
5402
5403 /* Kensington ThinkingMouse/Trackball */
5404 static int
5405 enable_kmouse(struct psm_softc *sc, enum probearg arg)
5406 {
5407         static u_char rate[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20 };
5408         KBDC kbdc = sc->kbdc;
5409         int status[3];
5410         int id1;
5411         int id2;
5412         int i;
5413
5414         id1 = get_aux_id(kbdc);
5415         if (set_mouse_sampling_rate(kbdc, 10) != 10)
5416                 return (FALSE);
5417         /*
5418          * The device is now in the native mode? It returns a different
5419          * ID value...
5420          */
5421         id2 = get_aux_id(kbdc);
5422         if ((id1 == id2) || (id2 != 2))
5423                 return (FALSE);
5424
5425         if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
5426                 return (FALSE);
5427 #if PSM_DEBUG >= 2
5428         /* at this point, resolution is LOW, sampling rate is 10/sec */
5429         if (get_mouse_status(kbdc, status, 0, 3) < 3)
5430                 return (FALSE);
5431 #endif
5432
5433         /*
5434          * The special sequence to enable the third and fourth buttons.
5435          * Otherwise they behave like the first and second buttons.
5436          */
5437         for (i = 0; i < nitems(rate); ++i)
5438                 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5439                         return (FALSE);
5440
5441         /*
5442          * At this point, the device is using default resolution and
5443          * sampling rate for the native mode.
5444          */
5445         if (get_mouse_status(kbdc, status, 0, 3) < 3)
5446                 return (FALSE);
5447         if ((status[1] == PSMD_RES_LOW) || (status[2] == rate[i - 1]))
5448                 return (FALSE);
5449
5450         /* the device appears be enabled by this sequence, diable it for now */
5451         disable_aux_dev(kbdc);
5452         empty_aux_buffer(kbdc, 5);
5453
5454         return (TRUE);
5455 }
5456
5457 /* Logitech MouseMan+/FirstMouse+, IBM ScrollPoint Mouse */
5458 static int
5459 enable_mmanplus(struct psm_softc *sc, enum probearg arg)
5460 {
5461         KBDC kbdc = sc->kbdc;
5462         int data[3];
5463
5464         /* the special sequence to enable the fourth button and the roller. */
5465         /*
5466          * NOTE: for ScrollPoint to respond correctly, the SET_RESOLUTION
5467          * must be called exactly three times since the last RESET command
5468          * before this sequence. XXX
5469          */
5470         if (!set_mouse_scaling(kbdc, 1))
5471                 return (FALSE);
5472         if (!mouse_ext_command(kbdc, 0x39) || !mouse_ext_command(kbdc, 0xdb))
5473                 return (FALSE);
5474         if (get_mouse_status(kbdc, data, 1, 3) < 3)
5475                 return (FALSE);
5476
5477         /*
5478          * PS2++ protocol, packet type 0
5479          *
5480          *          b7 b6 b5 b4 b3 b2 b1 b0
5481          * byte 1:  *  1  p3 p2 1  *  *  *
5482          * byte 2:  1  1  p1 p0 m1 m0 1  0
5483          * byte 3:  m7 m6 m5 m4 m3 m2 m1 m0
5484          *
5485          * p3-p0: packet type: 0
5486          * m7-m0: model ID: MouseMan+:0x50,
5487          *                  FirstMouse+:0x51,
5488          *                  ScrollPoint:0x58...
5489          */
5490         /* check constant bits */
5491         if ((data[0] & MOUSE_PS2PLUS_SYNCMASK) != MOUSE_PS2PLUS_SYNC)
5492                 return (FALSE);
5493         if ((data[1] & 0xc3) != 0xc2)
5494                 return (FALSE);
5495         /* check d3-d0 in byte 2 */
5496         if (!MOUSE_PS2PLUS_CHECKBITS(data))
5497                 return (FALSE);
5498         /* check p3-p0 */
5499         if (MOUSE_PS2PLUS_PACKET_TYPE(data) != 0)
5500                 return (FALSE);
5501
5502         if (arg == PROBE) {
5503                 sc->hw.hwid &= 0x00ff;
5504                 sc->hw.hwid |= data[2] << 8;    /* save model ID */
5505         }
5506
5507         /*
5508          * MouseMan+ (or FirstMouse+) is now in its native mode, in which
5509          * the wheel and the fourth button events are encoded in the
5510          * special data packet. The mouse may be put in the IntelliMouse mode
5511          * if it is initialized by the IntelliMouse's method.
5512          */
5513         return (TRUE);
5514 }
5515
5516 /* MS IntelliMouse Explorer */
5517 static int
5518 enable_msexplorer(struct psm_softc *sc, enum probearg arg)
5519 {
5520         KBDC kbdc = sc->kbdc;
5521         static u_char rate0[] = { 200, 100, 80, };
5522         static u_char rate1[] = { 200, 200, 80, };
5523         int id;
5524         int i;
5525
5526         /*
5527          * This is needed for at least A4Tech X-7xx mice - they do not go
5528          * straight to Explorer mode, but need to be set to Intelli mode
5529          * first.
5530          */
5531         enable_msintelli(sc, arg);
5532
5533         /* the special sequence to enable the extra buttons and the roller. */
5534         for (i = 0; i < nitems(rate1); ++i)
5535                 if (set_mouse_sampling_rate(kbdc, rate1[i]) != rate1[i])
5536                         return (FALSE);
5537         /* the device will give the genuine ID only after the above sequence */
5538         id = get_aux_id(kbdc);
5539         if (id != PSM_EXPLORER_ID)
5540                 return (FALSE);
5541
5542         if (arg == PROBE) {
5543                 sc->hw.buttons = 5;     /* IntelliMouse Explorer XXX */
5544                 sc->hw.hwid = id;
5545         }
5546
5547         /*
5548          * XXX: this is a kludge to fool some KVM switch products
5549          * which think they are clever enough to know the 4-byte IntelliMouse
5550          * protocol, and assume any other protocols use 3-byte packets.
5551          * They don't convey 4-byte data packets from the IntelliMouse Explorer
5552          * correctly to the host computer because of this!
5553          * The following sequence is actually IntelliMouse's "wake up"
5554          * sequence; it will make the KVM think the mouse is IntelliMouse
5555          * when it is in fact IntelliMouse Explorer.
5556          */
5557         for (i = 0; i < nitems(rate0); ++i)
5558                 if (set_mouse_sampling_rate(kbdc, rate0[i]) != rate0[i])
5559                         break;
5560         get_aux_id(kbdc);
5561
5562         return (TRUE);
5563 }
5564
5565 /*
5566  * MS IntelliMouse
5567  * Logitech MouseMan+ and FirstMouse+ will also respond to this
5568  * probe routine and act like IntelliMouse.
5569  */
5570 static int
5571 enable_msintelli(struct psm_softc *sc, enum probearg arg)
5572 {
5573         KBDC kbdc = sc->kbdc;
5574         static u_char rate[] = { 200, 100, 80, };
5575         int id;
5576         int i;
5577
5578         /* the special sequence to enable the third button and the roller. */
5579         for (i = 0; i < nitems(rate); ++i)
5580                 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5581                         return (FALSE);
5582         /* the device will give the genuine ID only after the above sequence */
5583         id = get_aux_id(kbdc);
5584         if (id != PSM_INTELLI_ID)
5585                 return (FALSE);
5586
5587         if (arg == PROBE) {
5588                 sc->hw.buttons = 3;
5589                 sc->hw.hwid = id;
5590         }
5591
5592         return (TRUE);
5593 }
5594
5595 /*
5596  * A4 Tech 4D Mouse
5597  * Newer wheel mice from A4 Tech may use the 4D+ protocol.
5598  */
5599 static int
5600 enable_4dmouse(struct psm_softc *sc, enum probearg arg)
5601 {
5602         static u_char rate[] = { 200, 100, 80, 60, 40, 20 };
5603         KBDC kbdc = sc->kbdc;
5604         int id;
5605         int i;
5606
5607         for (i = 0; i < nitems(rate); ++i)
5608                 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5609                         return (FALSE);
5610         id = get_aux_id(kbdc);
5611         /*
5612          * WinEasy 4D, 4 Way Scroll 4D: 6
5613          * Cable-Free 4D: 8 (4DPLUS)
5614          * WinBest 4D+, 4 Way Scroll 4D+: 8 (4DPLUS)
5615          */
5616         if (id != PSM_4DMOUSE_ID)
5617                 return (FALSE);
5618
5619         if (arg == PROBE) {
5620                 sc->hw.buttons = 3;     /* XXX some 4D mice have 4? */
5621                 sc->hw.hwid = id;
5622         }
5623
5624         return (TRUE);
5625 }
5626
5627 /*
5628  * A4 Tech 4D+ Mouse
5629  * Newer wheel mice from A4 Tech seem to use this protocol.
5630  * Older models are recognized as either 4D Mouse or IntelliMouse.
5631  */
5632 static int
5633 enable_4dplus(struct psm_softc *sc, enum probearg arg)
5634 {
5635         KBDC kbdc = sc->kbdc;
5636         int id;
5637
5638         /*
5639          * enable_4dmouse() already issued the following ID sequence...
5640         static u_char rate[] = { 200, 100, 80, 60, 40, 20 };
5641         int i;
5642
5643         for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i)
5644                 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5645                         return (FALSE);
5646         */
5647
5648         id = get_aux_id(kbdc);
5649         switch (id) {
5650         case PSM_4DPLUS_ID:
5651                 break;
5652         case PSM_4DPLUS_RFSW35_ID:
5653                 break;
5654         default:
5655                 return (FALSE);
5656         }
5657
5658         if (arg == PROBE) {
5659                 sc->hw.buttons = (id == PSM_4DPLUS_ID) ? 4 : 3;
5660                 sc->hw.hwid = id;
5661         }
5662
5663         return (TRUE);
5664 }
5665
5666 /* Synaptics Touchpad */
5667 static int
5668 synaptics_sysctl(SYSCTL_HANDLER_ARGS)
5669 {
5670         struct psm_softc *sc;
5671         int error, arg;
5672
5673         if (oidp->oid_arg1 == NULL || oidp->oid_arg2 < 0 ||
5674             oidp->oid_arg2 > SYNAPTICS_SYSCTL_LAST)
5675                 return (EINVAL);
5676
5677         sc = oidp->oid_arg1;
5678
5679         /* Read the current value. */
5680         arg = *(int *)((char *)sc + oidp->oid_arg2);
5681         error = sysctl_handle_int(oidp, &arg, 0, req);
5682
5683         /* Sanity check. */
5684         if (error || !req->newptr)
5685                 return (error);
5686
5687         /*
5688          * Check that the new value is in the concerned node's range
5689          * of values.
5690          */
5691         switch (oidp->oid_arg2) {
5692         case SYNAPTICS_SYSCTL_MIN_PRESSURE:
5693         case SYNAPTICS_SYSCTL_MAX_PRESSURE:
5694                 if (arg < 0 || arg > 255)
5695                         return (EINVAL);
5696                 break;
5697         case SYNAPTICS_SYSCTL_MAX_WIDTH:
5698                 if (arg < 4 || arg > 15)
5699                         return (EINVAL);
5700                 break;
5701         case SYNAPTICS_SYSCTL_MARGIN_TOP:
5702         case SYNAPTICS_SYSCTL_MARGIN_BOTTOM:
5703         case SYNAPTICS_SYSCTL_NA_TOP:
5704         case SYNAPTICS_SYSCTL_NA_BOTTOM:
5705                 if (arg < 0 || arg > sc->synhw.maximumYCoord)
5706                         return (EINVAL);
5707                 break;
5708         case SYNAPTICS_SYSCTL_SOFTBUTTON2_X:
5709         case SYNAPTICS_SYSCTL_SOFTBUTTON3_X:
5710                 /* Softbuttons is clickpad only feature */
5711                 if (!sc->synhw.capClickPad && arg != 0)
5712                         return (EINVAL);
5713                 /* FALLTHROUGH */
5714         case SYNAPTICS_SYSCTL_MARGIN_RIGHT:
5715         case SYNAPTICS_SYSCTL_MARGIN_LEFT:
5716         case SYNAPTICS_SYSCTL_NA_RIGHT:
5717         case SYNAPTICS_SYSCTL_NA_LEFT:
5718                 if (arg < 0 || arg > sc->synhw.maximumXCoord)
5719                         return (EINVAL);
5720                 break;
5721         case SYNAPTICS_SYSCTL_WINDOW_MIN:
5722         case SYNAPTICS_SYSCTL_WINDOW_MAX:
5723         case SYNAPTICS_SYSCTL_TAP_MIN_QUEUE:
5724                 if (arg < 1 || arg > SYNAPTICS_PACKETQUEUE)
5725                         return (EINVAL);
5726                 break;
5727         case SYNAPTICS_SYSCTL_MULTIPLICATOR:
5728         case SYNAPTICS_SYSCTL_WEIGHT_CURRENT:
5729         case SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS:
5730         case SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS_NA:
5731         case SYNAPTICS_SYSCTL_WEIGHT_LEN_SQUARED:
5732         case SYNAPTICS_SYSCTL_DIV_MIN:
5733         case SYNAPTICS_SYSCTL_DIV_MAX:
5734         case SYNAPTICS_SYSCTL_DIV_MAX_NA:
5735         case SYNAPTICS_SYSCTL_DIV_LEN:
5736         case SYNAPTICS_SYSCTL_VSCROLL_DIV_MIN:
5737         case SYNAPTICS_SYSCTL_VSCROLL_DIV_MAX:
5738                 if (arg < 1)
5739                         return (EINVAL);
5740                 break;
5741         case SYNAPTICS_SYSCTL_TAP_MAX_DELTA:
5742         case SYNAPTICS_SYSCTL_TAPHOLD_TIMEOUT:
5743         case SYNAPTICS_SYSCTL_VSCROLL_MIN_DELTA:
5744                 if (arg < 0)
5745                         return (EINVAL);
5746                 break;
5747         case SYNAPTICS_SYSCTL_VSCROLL_HOR_AREA:
5748                 if (arg < -sc->synhw.maximumXCoord ||
5749                     arg > sc->synhw.maximumXCoord)
5750                         return (EINVAL);
5751                 break;
5752         case SYNAPTICS_SYSCTL_SOFTBUTTONS_Y:
5753                 /* Softbuttons is clickpad only feature */
5754                 if (!sc->synhw.capClickPad && arg != 0)
5755                         return (EINVAL);
5756                 /* FALLTHROUGH */
5757         case SYNAPTICS_SYSCTL_VSCROLL_VER_AREA:
5758                 if (arg < -sc->synhw.maximumYCoord ||
5759                     arg > sc->synhw.maximumYCoord)
5760                         return (EINVAL);
5761                 break;
5762         case SYNAPTICS_SYSCTL_TOUCHPAD_OFF:
5763         case SYNAPTICS_SYSCTL_THREE_FINGER_DRAG:
5764         case SYNAPTICS_SYSCTL_NATURAL_SCROLL:
5765                 if (arg < 0 || arg > 1)
5766                         return (EINVAL);
5767                 break;
5768         default:
5769                 return (EINVAL);
5770         }
5771
5772         /* Update. */
5773         *(int *)((char *)sc + oidp->oid_arg2) = arg;
5774
5775         return (error);
5776 }
5777
5778 static void
5779 synaptics_sysctl_create_softbuttons_tree(struct psm_softc *sc)
5780 {
5781         /*
5782          * Set predefined sizes for softbuttons.
5783          * Values are taken to match HP Pavilion dv6 clickpad drawings
5784          * with thin middle softbutton placed on separator
5785          */
5786
5787         /* hw.psm.synaptics.softbuttons_y */
5788         sc->syninfo.softbuttons_y = sc->synhw.topButtonPad ? -1700 : 1700;
5789         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5790             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5791             "softbuttons_y", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5792             sc, SYNAPTICS_SYSCTL_SOFTBUTTONS_Y,
5793             synaptics_sysctl, "I",
5794             "Vertical size of softbuttons area");
5795
5796         /* hw.psm.synaptics.softbutton2_x */
5797         sc->syninfo.softbutton2_x = 3100;
5798         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5799             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5800             "softbutton2_x", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5801             sc, SYNAPTICS_SYSCTL_SOFTBUTTON2_X,
5802             synaptics_sysctl, "I",
5803             "Horisontal position of 2-nd softbutton left edge (0-disable)");
5804
5805         /* hw.psm.synaptics.softbutton3_x */
5806         sc->syninfo.softbutton3_x = 3900;
5807         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5808             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5809             "softbutton3_x", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5810             sc, SYNAPTICS_SYSCTL_SOFTBUTTON3_X,
5811             synaptics_sysctl, "I",
5812             "Horisontal position of 3-rd softbutton left edge (0-disable)");
5813 }
5814
5815 static void
5816 synaptics_sysctl_create_tree(struct psm_softc *sc, const char *name,
5817     const char *descr)
5818 {
5819
5820         if (sc->syninfo.sysctl_tree != NULL)
5821                 return;
5822
5823         /* Attach extra synaptics sysctl nodes under hw.psm.synaptics */
5824         sysctl_ctx_init(&sc->syninfo.sysctl_ctx);
5825         sc->syninfo.sysctl_tree = SYSCTL_ADD_NODE(&sc->syninfo.sysctl_ctx,
5826             SYSCTL_STATIC_CHILDREN(_hw_psm), OID_AUTO, name, CTLFLAG_RD,
5827             0, descr);
5828
5829         /* hw.psm.synaptics.directional_scrolls. */
5830         sc->syninfo.directional_scrolls = 0;
5831         SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5832             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5833             "directional_scrolls", CTLFLAG_RW|CTLFLAG_ANYBODY,
5834             &sc->syninfo.directional_scrolls, 0,
5835             "Enable hardware scrolling pad (if non-zero) or register it as "
5836             "extended buttons (if 0)");
5837
5838         /* hw.psm.synaptics.max_x. */
5839         sc->syninfo.max_x = 6143;
5840         SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5841             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5842             "max_x", CTLFLAG_RD|CTLFLAG_ANYBODY,
5843             &sc->syninfo.max_x, 0,
5844             "Horizontal reporting range");
5845
5846         /* hw.psm.synaptics.max_y. */
5847         sc->syninfo.max_y = 6143;
5848         SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5849             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5850             "max_y", CTLFLAG_RD|CTLFLAG_ANYBODY,
5851             &sc->syninfo.max_y, 0,
5852             "Vertical reporting range");
5853
5854         /*
5855          * Turn off two finger scroll if we have a
5856          * physical area reserved for scrolling or when
5857          * there's no multi finger support.
5858          */
5859         if (sc->synhw.verticalScroll || (sc->synhw.capMultiFinger == 0 &&
5860                                          sc->synhw.capAdvancedGestures == 0))
5861                 sc->syninfo.two_finger_scroll = 0;
5862         else
5863                 sc->syninfo.two_finger_scroll = 1;
5864         /* hw.psm.synaptics.two_finger_scroll. */
5865         SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5866             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5867             "two_finger_scroll", CTLFLAG_RW|CTLFLAG_ANYBODY,
5868             &sc->syninfo.two_finger_scroll, 0,
5869             "Enable two finger scrolling");
5870
5871         /* hw.psm.synaptics.min_pressure. */
5872         sc->syninfo.min_pressure = 32;
5873         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5874             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5875             "min_pressure", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5876             sc, SYNAPTICS_SYSCTL_MIN_PRESSURE,
5877             synaptics_sysctl, "I",
5878             "Minimum pressure required to start an action");
5879
5880         /* hw.psm.synaptics.max_pressure. */
5881         sc->syninfo.max_pressure = 220;
5882         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5883             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5884             "max_pressure", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5885             sc, SYNAPTICS_SYSCTL_MAX_PRESSURE,
5886             synaptics_sysctl, "I",
5887             "Maximum pressure to detect palm");
5888
5889         /* hw.psm.synaptics.max_width. */
5890         sc->syninfo.max_width = 10;
5891         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5892             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5893             "max_width", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5894             sc, SYNAPTICS_SYSCTL_MAX_WIDTH,
5895             synaptics_sysctl, "I",
5896             "Maximum finger width to detect palm");
5897
5898         /* hw.psm.synaptics.top_margin. */
5899         sc->syninfo.margin_top = 200;
5900         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5901             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5902             "margin_top", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5903             sc, SYNAPTICS_SYSCTL_MARGIN_TOP,
5904             synaptics_sysctl, "I",
5905             "Top margin");
5906
5907         /* hw.psm.synaptics.right_margin. */
5908         sc->syninfo.margin_right = 200;
5909         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5910             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5911             "margin_right", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5912             sc, SYNAPTICS_SYSCTL_MARGIN_RIGHT,
5913             synaptics_sysctl, "I",
5914             "Right margin");
5915
5916         /* hw.psm.synaptics.bottom_margin. */
5917         sc->syninfo.margin_bottom = 200;
5918         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5919             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5920             "margin_bottom", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5921             sc, SYNAPTICS_SYSCTL_MARGIN_BOTTOM,
5922             synaptics_sysctl, "I",
5923             "Bottom margin");
5924
5925         /* hw.psm.synaptics.left_margin. */
5926         sc->syninfo.margin_left = 200;
5927         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5928             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5929             "margin_left", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5930             sc, SYNAPTICS_SYSCTL_MARGIN_LEFT,
5931             synaptics_sysctl, "I",
5932             "Left margin");
5933
5934         /* hw.psm.synaptics.na_top. */
5935         sc->syninfo.na_top = 1783;
5936         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5937             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5938             "na_top", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5939             sc, SYNAPTICS_SYSCTL_NA_TOP,
5940             synaptics_sysctl, "I",
5941             "Top noisy area, where weight_previous_na is used instead "
5942             "of weight_previous");
5943
5944         /* hw.psm.synaptics.na_right. */
5945         sc->syninfo.na_right = 563;
5946         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5947             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5948             "na_right", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5949             sc, SYNAPTICS_SYSCTL_NA_RIGHT,
5950             synaptics_sysctl, "I",
5951             "Right noisy area, where weight_previous_na is used instead "
5952             "of weight_previous");
5953
5954         /* hw.psm.synaptics.na_bottom. */
5955         sc->syninfo.na_bottom = 1408;
5956         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5957             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5958             "na_bottom", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5959             sc, SYNAPTICS_SYSCTL_NA_BOTTOM,
5960             synaptics_sysctl, "I",
5961             "Bottom noisy area, where weight_previous_na is used instead "
5962             "of weight_previous");
5963
5964         /* hw.psm.synaptics.na_left. */
5965         sc->syninfo.na_left = 1600;
5966         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5967             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5968             "na_left", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5969             sc, SYNAPTICS_SYSCTL_NA_LEFT,
5970             synaptics_sysctl, "I",
5971             "Left noisy area, where weight_previous_na is used instead "
5972             "of weight_previous");
5973
5974         /* hw.psm.synaptics.window_min. */
5975         sc->syninfo.window_min = 4;
5976         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5977             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5978             "window_min", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5979             sc, SYNAPTICS_SYSCTL_WINDOW_MIN,
5980             synaptics_sysctl, "I",
5981             "Minimum window size to start an action");
5982
5983         /* hw.psm.synaptics.window_max. */
5984         sc->syninfo.window_max = 10;
5985         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5986             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5987             "window_max", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5988             sc, SYNAPTICS_SYSCTL_WINDOW_MAX,
5989             synaptics_sysctl, "I",
5990             "Maximum window size");
5991
5992         /* hw.psm.synaptics.multiplicator. */
5993         sc->syninfo.multiplicator = 10000;
5994         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5995             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5996             "multiplicator", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
5997             sc, SYNAPTICS_SYSCTL_MULTIPLICATOR,
5998             synaptics_sysctl, "I",
5999             "Multiplicator to increase precision in averages and divisions");
6000
6001         /* hw.psm.synaptics.weight_current. */
6002         sc->syninfo.weight_current = 3;
6003         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6004             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6005             "weight_current", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6006             sc, SYNAPTICS_SYSCTL_WEIGHT_CURRENT,
6007             synaptics_sysctl, "I",
6008             "Weight of the current movement in the new average");
6009
6010         /* hw.psm.synaptics.weight_previous. */
6011         sc->syninfo.weight_previous = 6;
6012         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6013             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6014             "weight_previous", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6015             sc, SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS,
6016             synaptics_sysctl, "I",
6017             "Weight of the previous average");
6018
6019         /* hw.psm.synaptics.weight_previous_na. */
6020         sc->syninfo.weight_previous_na = 20;
6021         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6022             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6023             "weight_previous_na", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6024             sc, SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS_NA,
6025             synaptics_sysctl, "I",
6026             "Weight of the previous average (inside the noisy area)");
6027
6028         /* hw.psm.synaptics.weight_len_squared. */
6029         sc->syninfo.weight_len_squared = 2000;
6030         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6031             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6032             "weight_len_squared", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6033             sc, SYNAPTICS_SYSCTL_WEIGHT_LEN_SQUARED,
6034             synaptics_sysctl, "I",
6035             "Length (squared) of segments where weight_previous "
6036             "starts to decrease");
6037
6038         /* hw.psm.synaptics.div_min. */
6039         sc->syninfo.div_min = 9;
6040         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6041             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6042             "div_min", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6043             sc, SYNAPTICS_SYSCTL_DIV_MIN,
6044             synaptics_sysctl, "I",
6045             "Divisor for fast movements");
6046
6047         /* hw.psm.synaptics.div_max. */
6048         sc->syninfo.div_max = 17;
6049         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6050             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6051             "div_max", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6052             sc, SYNAPTICS_SYSCTL_DIV_MAX,
6053             synaptics_sysctl, "I",
6054             "Divisor for slow movements");
6055
6056         /* hw.psm.synaptics.div_max_na. */
6057         sc->syninfo.div_max_na = 30;
6058         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6059             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6060             "div_max_na", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6061             sc, SYNAPTICS_SYSCTL_DIV_MAX_NA,
6062             synaptics_sysctl, "I",
6063             "Divisor with slow movements (inside the noisy area)");
6064
6065         /* hw.psm.synaptics.div_len. */
6066         sc->syninfo.div_len = 100;
6067         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6068             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6069             "div_len", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6070             sc, SYNAPTICS_SYSCTL_DIV_LEN,
6071             synaptics_sysctl, "I",
6072             "Length of segments where div_max starts to decrease");
6073
6074         /* hw.psm.synaptics.tap_max_delta. */
6075         sc->syninfo.tap_max_delta = 80;
6076         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6077             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6078             "tap_max_delta", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6079             sc, SYNAPTICS_SYSCTL_TAP_MAX_DELTA,
6080             synaptics_sysctl, "I",
6081             "Length of segments above which a tap is ignored");
6082
6083         /* hw.psm.synaptics.tap_min_queue. */
6084         sc->syninfo.tap_min_queue = 2;
6085         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6086             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6087             "tap_min_queue", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6088             sc, SYNAPTICS_SYSCTL_TAP_MIN_QUEUE,
6089             synaptics_sysctl, "I",
6090             "Number of packets required to consider a tap");
6091
6092         /* hw.psm.synaptics.taphold_timeout. */
6093         sc->gesture.in_taphold = 0;
6094         sc->syninfo.taphold_timeout = tap_timeout;
6095         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6096             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6097             "taphold_timeout", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6098             sc, SYNAPTICS_SYSCTL_TAPHOLD_TIMEOUT,
6099             synaptics_sysctl, "I",
6100             "Maximum elapsed time between two taps to consider a tap-hold "
6101             "action");
6102
6103         /* hw.psm.synaptics.vscroll_hor_area. */
6104         sc->syninfo.vscroll_hor_area = 0; /* 1300 */
6105         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6106             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6107             "vscroll_hor_area", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6108             sc, SYNAPTICS_SYSCTL_VSCROLL_HOR_AREA,
6109             synaptics_sysctl, "I",
6110             "Area reserved for horizontal virtual scrolling");
6111
6112         /* hw.psm.synaptics.vscroll_ver_area. */
6113         sc->syninfo.vscroll_ver_area = -400 - sc->syninfo.margin_right;
6114         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6115             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6116             "vscroll_ver_area", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6117             sc, SYNAPTICS_SYSCTL_VSCROLL_VER_AREA,
6118             synaptics_sysctl, "I",
6119             "Area reserved for vertical virtual scrolling");
6120
6121         /* hw.psm.synaptics.vscroll_min_delta. */
6122         sc->syninfo.vscroll_min_delta = 50;
6123         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6124             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6125             "vscroll_min_delta", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6126             sc, SYNAPTICS_SYSCTL_VSCROLL_MIN_DELTA,
6127             synaptics_sysctl, "I",
6128             "Minimum movement to consider virtual scrolling");
6129
6130         /* hw.psm.synaptics.vscroll_div_min. */
6131         sc->syninfo.vscroll_div_min = 100;
6132         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6133             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6134             "vscroll_div_min", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6135             sc, SYNAPTICS_SYSCTL_VSCROLL_DIV_MIN,
6136             synaptics_sysctl, "I",
6137             "Divisor for fast scrolling");
6138
6139         /* hw.psm.synaptics.vscroll_div_min. */
6140         sc->syninfo.vscroll_div_max = 150;
6141         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6142             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6143             "vscroll_div_max", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6144             sc, SYNAPTICS_SYSCTL_VSCROLL_DIV_MAX,
6145             synaptics_sysctl, "I",
6146             "Divisor for slow scrolling");
6147
6148         /* hw.psm.synaptics.touchpad_off. */
6149         sc->syninfo.touchpad_off = 0;
6150         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6151             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6152             "touchpad_off", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6153             sc, SYNAPTICS_SYSCTL_TOUCHPAD_OFF,
6154             synaptics_sysctl, "I",
6155             "Turn off touchpad");
6156
6157         sc->syninfo.three_finger_drag = 0;
6158         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6159             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6160             "three_finger_drag", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6161             sc, SYNAPTICS_SYSCTL_THREE_FINGER_DRAG,
6162             synaptics_sysctl, "I",
6163             "Enable dragging with three fingers");
6164
6165         /* hw.psm.synaptics.natural_scroll. */
6166         sc->syninfo.natural_scroll = 0;
6167         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6168             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6169             "natural_scroll", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6170             sc, SYNAPTICS_SYSCTL_NATURAL_SCROLL,
6171             synaptics_sysctl, "I",
6172             "Enable natural scrolling");
6173
6174         sc->syninfo.softbuttons_y = 0;
6175         sc->syninfo.softbutton2_x = 0;
6176         sc->syninfo.softbutton3_x = 0;
6177
6178         /* skip softbuttons sysctl on not clickpads */
6179         if (sc->synhw.capClickPad)
6180                 synaptics_sysctl_create_softbuttons_tree(sc);
6181 }
6182
6183 static int
6184 synaptics_preferred_mode(struct psm_softc *sc) {
6185         int mode_byte;
6186
6187         /* Check if we are in relative mode */
6188         if (sc->hw.model != MOUSE_MODEL_SYNAPTICS) {
6189                 if (tap_enabled == 0)
6190                         /*
6191                          * Disable tap & drag gestures. We use a Mode Byte
6192                          * and set the DisGest bit (see §2.5 of Synaptics
6193                          * TouchPad Interfacing Guide).
6194                          */
6195                         return (0x04);
6196                 else
6197                         /*
6198                          * Enable tap & drag gestures. We use a Mode Byte
6199                          * and clear the DisGest bit (see §2.5 of Synaptics
6200                          * TouchPad Interfacing Guide).
6201                          */
6202                         return (0x00);
6203         }
6204
6205         mode_byte = 0xc4;
6206
6207         /* request wmode where available */
6208         if (sc->synhw.capExtended)
6209                 mode_byte |= 1;
6210
6211         return mode_byte;
6212 }
6213
6214 static void
6215 synaptics_set_mode(struct psm_softc *sc, int mode_byte) {
6216         mouse_ext_command(sc->kbdc, mode_byte);
6217
6218         /* "Commit" the Set Mode Byte command sent above. */
6219         set_mouse_sampling_rate(sc->kbdc, 20);
6220
6221         /*
6222          * Enable advanced gestures mode if supported and we are not entering
6223          * passthrough or relative mode.
6224          */
6225         if ((sc->synhw.capAdvancedGestures || sc->synhw.capReportsV) &&
6226             sc->hw.model == MOUSE_MODEL_SYNAPTICS && !(mode_byte & (1 << 5))) {
6227                 mouse_ext_command(sc->kbdc, SYNAPTICS_READ_MODEL_ID);
6228                 set_mouse_sampling_rate(sc->kbdc, 0xc8);
6229         }
6230 }
6231
6232 /*
6233  * AUX MUX detection code should be placed at very beginning of probe sequence
6234  * at least before 4-byte protocol mouse probes e.g. MS IntelliMouse probe as
6235  * latter can trigger switching the MUX to incompatible state.
6236  */
6237 static int
6238 enable_synaptics_mux(struct psm_softc *sc, enum probearg arg)
6239 {
6240         KBDC kbdc = sc->kbdc;
6241         int port, version;
6242         int probe = FALSE;
6243         int active_ports_count = 0;
6244         int active_ports_mask = 0;
6245
6246         version = enable_aux_mux(kbdc);
6247         if (version == -1)
6248                 return (FALSE);
6249
6250         for (port = 0; port < KBDC_AUX_MUX_NUM_PORTS; port++) {
6251                 VLOG(3, (LOG_DEBUG, "aux_mux: ping port %d\n", port));
6252                 set_active_aux_mux_port(kbdc, port);
6253                 if (enable_aux_dev(kbdc) && disable_aux_dev(kbdc)) {
6254                         active_ports_count++;
6255                         active_ports_mask |= 1 << port;
6256                 }
6257         }
6258
6259         if (verbose >= 2)
6260                 printf("Active Multiplexing PS/2 controller v%d.%d with %d "
6261                     "active port(s)\n", version >> 4 & 0x0f, version & 0x0f,
6262                     active_ports_count);
6263
6264         /* psm has a special support for GenMouse + SynTouchpad combination */
6265         if (active_ports_count >= 2) {
6266                 for (port = 0; port < KBDC_AUX_MUX_NUM_PORTS; port++) {
6267                         if ((active_ports_mask & 1 << port) == 0)
6268                                 continue;
6269                         VLOG(3, (LOG_DEBUG, "aux_mux: probe port %d\n", port));
6270                         set_active_aux_mux_port(kbdc, port);
6271                         probe = enable_synaptics(sc, arg);
6272                         if (probe) {
6273                                 if (arg == PROBE)
6274                                         sc->muxport = port;
6275                                 break;
6276                         }
6277                 }
6278         }
6279
6280         /* IRQ handler does not support active multiplexing mode */
6281         disable_aux_mux(kbdc);
6282
6283         return (probe);
6284 }
6285
6286 static int
6287 enable_synaptics(struct psm_softc *sc, enum probearg arg)
6288 {
6289         device_t psmcpnp;
6290         struct psmcpnp_softc *psmcpnp_sc;
6291         KBDC kbdc = sc->kbdc;
6292         synapticshw_t synhw;
6293         int status[3];
6294         int buttons;
6295
6296         VLOG(3, (LOG_DEBUG, "synaptics: BEGIN init\n"));
6297
6298         /*
6299          * Just to be on the safe side: this avoids troubles with
6300          * following mouse_ext_command() when the previous command
6301          * was PSMC_SET_RESOLUTION. Set Scaling has no effect on
6302          * Synaptics Touchpad behaviour.
6303          */
6304         set_mouse_scaling(kbdc, 1);
6305
6306         /* Identify the Touchpad version. */
6307         if (mouse_ext_command(kbdc, SYNAPTICS_READ_IDENTITY) == 0)
6308                 return (FALSE);
6309         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6310                 return (FALSE);
6311         if (status[1] != 0x47)
6312                 return (FALSE);
6313
6314         bzero(&synhw, sizeof(synhw));
6315         synhw.infoMinor = status[0];
6316         synhw.infoMajor = status[2] & 0x0f;
6317
6318         if (verbose >= 2)
6319                 printf("Synaptics Touchpad v%d.%d\n", synhw.infoMajor,
6320                     synhw.infoMinor);
6321
6322         if (synhw.infoMajor < 4) {
6323                 printf("  Unsupported (pre-v4) Touchpad detected\n");
6324                 return (FALSE);
6325         }
6326
6327         /* Get the Touchpad model information. */
6328         if (mouse_ext_command(kbdc, SYNAPTICS_READ_MODEL_ID) == 0)
6329                 return (FALSE);
6330         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6331                 return (FALSE);
6332         if ((status[1] & 0x01) != 0) {
6333                 printf("  Failed to read model information\n");
6334                 return (FALSE);
6335         }
6336
6337         synhw.infoRot180   = (status[0] & 0x80) != 0;
6338         synhw.infoPortrait = (status[0] & 0x40) != 0;
6339         synhw.infoSensor   =  status[0] & 0x3f;
6340         synhw.infoHardware = (status[1] & 0xfe) >> 1;
6341         synhw.infoNewAbs   = (status[2] & 0x80) != 0;
6342         synhw.capPen       = (status[2] & 0x40) != 0;
6343         synhw.infoSimplC   = (status[2] & 0x20) != 0;
6344         synhw.infoGeometry =  status[2] & 0x0f;
6345
6346         if (verbose >= 2) {
6347                 printf("  Model information:\n");
6348                 printf("   infoRot180: %d\n", synhw.infoRot180);
6349                 printf("   infoPortrait: %d\n", synhw.infoPortrait);
6350                 printf("   infoSensor: %d\n", synhw.infoSensor);
6351                 printf("   infoHardware: %d\n", synhw.infoHardware);
6352                 printf("   infoNewAbs: %d\n", synhw.infoNewAbs);
6353                 printf("   capPen: %d\n", synhw.capPen);
6354                 printf("   infoSimplC: %d\n", synhw.infoSimplC);
6355                 printf("   infoGeometry: %d\n", synhw.infoGeometry);
6356         }
6357
6358         /* Read the extended capability bits. */
6359         if (mouse_ext_command(kbdc, SYNAPTICS_READ_CAPABILITIES) == 0)
6360                 return (FALSE);
6361         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6362                 return (FALSE);
6363         if (!SYNAPTICS_VERSION_GE(synhw, 7, 5) && status[1] != 0x47) {
6364                 printf("  Failed to read extended capability bits\n");
6365                 return (FALSE);
6366         }
6367
6368         psmcpnp = devclass_get_device(devclass_find(PSMCPNP_DRIVER_NAME),
6369             sc->unit);
6370         psmcpnp_sc = (psmcpnp != NULL) ? device_get_softc(psmcpnp) : NULL;
6371
6372         /* Set the different capabilities when they exist. */
6373         buttons = 0;
6374         synhw.capExtended = (status[0] & 0x80) != 0;
6375         if (synhw.capExtended) {
6376                 synhw.nExtendedQueries = (status[0] & 0x70) >> 4;
6377                 synhw.capMiddle        = (status[0] & 0x04) != 0;
6378                 synhw.capPassthrough   = (status[2] & 0x80) != 0;
6379                 synhw.capLowPower      = (status[2] & 0x40) != 0;
6380                 synhw.capMultiFingerReport =
6381                                          (status[2] & 0x20) != 0;
6382                 synhw.capSleep         = (status[2] & 0x10) != 0;
6383                 synhw.capFourButtons   = (status[2] & 0x08) != 0;
6384                 synhw.capBallistics    = (status[2] & 0x04) != 0;
6385                 synhw.capMultiFinger   = (status[2] & 0x02) != 0;
6386                 synhw.capPalmDetect    = (status[2] & 0x01) != 0;
6387
6388                 if (!set_mouse_scaling(kbdc, 1))
6389                         return (FALSE);
6390                 if (mouse_ext_command(kbdc, SYNAPTICS_READ_RESOLUTIONS) == 0)
6391                         return (FALSE);
6392                 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6393                         return (FALSE);
6394
6395                 if (status[0] != 0 && (status[1] & 0x80) && status[2] != 0) {
6396                         synhw.infoXupmm = status[0];
6397                         synhw.infoYupmm = status[2];
6398                 }
6399
6400                 if (verbose >= 2) {
6401                         printf("  Extended capabilities:\n");
6402                         printf("   capExtended: %d\n", synhw.capExtended);
6403                         printf("   capMiddle: %d\n", synhw.capMiddle);
6404                         printf("   nExtendedQueries: %d\n",
6405                             synhw.nExtendedQueries);
6406                         printf("   capPassthrough: %d\n", synhw.capPassthrough);
6407                         printf("   capLowPower: %d\n", synhw.capLowPower);
6408                         printf("   capMultiFingerReport: %d\n",
6409                             synhw.capMultiFingerReport);
6410                         printf("   capSleep: %d\n", synhw.capSleep);
6411                         printf("   capFourButtons: %d\n", synhw.capFourButtons);
6412                         printf("   capBallistics: %d\n", synhw.capBallistics);
6413                         printf("   capMultiFinger: %d\n", synhw.capMultiFinger);
6414                         printf("   capPalmDetect: %d\n", synhw.capPalmDetect);
6415                         printf("   infoXupmm: %d\n", synhw.infoXupmm);
6416                         printf("   infoYupmm: %d\n", synhw.infoYupmm);
6417                 }
6418
6419                 /*
6420                  * If nExtendedQueries is 1 or greater, then the TouchPad
6421                  * supports this number of extended queries. We can load
6422                  * more information about buttons using query 0x09.
6423                  */
6424                 if (synhw.nExtendedQueries >= 1) {
6425                         if (!set_mouse_scaling(kbdc, 1))
6426                                 return (FALSE);
6427                         if (mouse_ext_command(kbdc,
6428                             SYNAPTICS_READ_EXTENDED) == 0)
6429                                 return (FALSE);
6430                         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6431                                 return (FALSE);
6432                         synhw.verticalScroll   = (status[0] & 0x01) != 0;
6433                         synhw.horizontalScroll = (status[0] & 0x02) != 0;
6434                         synhw.verticalWheel    = (status[0] & 0x08) != 0;
6435                         synhw.nExtendedButtons = (status[1] & 0xf0) >> 4;
6436                         synhw.capEWmode        = (status[0] & 0x04) != 0;
6437                         if (verbose >= 2) {
6438                                 printf("  Extended model ID:\n");
6439                                 printf("   verticalScroll: %d\n",
6440                                     synhw.verticalScroll);
6441                                 printf("   horizontalScroll: %d\n",
6442                                     synhw.horizontalScroll);
6443                                 printf("   verticalWheel: %d\n",
6444                                     synhw.verticalWheel);
6445                                 printf("   nExtendedButtons: %d\n",
6446                                     synhw.nExtendedButtons);
6447                                 printf("   capEWmode: %d\n",
6448                                     synhw.capEWmode);
6449                         }
6450                         /*
6451                          * Add the number of extended buttons to the total
6452                          * button support count, including the middle button
6453                          * if capMiddle support bit is set.
6454                          */
6455                         buttons = synhw.nExtendedButtons + synhw.capMiddle;
6456                 } else
6457                         /*
6458                          * If the capFourButtons support bit is set,
6459                          * add a fourth button to the total button count.
6460                          */
6461                         buttons = synhw.capFourButtons ? 1 : 0;
6462
6463                 /* Read the continued capabilities bits. */
6464                 if (synhw.nExtendedQueries >= 4) {
6465                         if (!set_mouse_scaling(kbdc, 1))
6466                                 return (FALSE);
6467                         if (mouse_ext_command(kbdc,
6468                             SYNAPTICS_READ_CAPABILITIES_CONT) == 0)
6469                                 return (FALSE);
6470                         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6471                                 return (FALSE);
6472
6473                         synhw.capClickPad         = (status[1] & 0x01) << 1;
6474                         synhw.capClickPad        |= (status[0] & 0x10) != 0;
6475                         synhw.capDeluxeLEDs       = (status[1] & 0x02) != 0;
6476                         synhw.noAbsoluteFilter    = (status[1] & 0x04) != 0;
6477                         synhw.capReportsV         = (status[1] & 0x08) != 0;
6478                         synhw.capUniformClickPad  = (status[1] & 0x10) != 0;
6479                         synhw.capReportsMin       = (status[1] & 0x20) != 0;
6480                         synhw.capInterTouch       = (status[1] & 0x40) != 0;
6481                         synhw.capReportsMax       = (status[0] & 0x02) != 0;
6482                         synhw.capClearPad         = (status[0] & 0x04) != 0;
6483                         synhw.capAdvancedGestures = (status[0] & 0x08) != 0;
6484                         synhw.capCoveredPad       = (status[0] & 0x80) != 0;
6485
6486                         if (synhw.capReportsMax) {
6487                                 if (!set_mouse_scaling(kbdc, 1))
6488                                         return (FALSE);
6489                                 if (mouse_ext_command(kbdc,
6490                                     SYNAPTICS_READ_MAX_COORDS) == 0)
6491                                         return (FALSE);
6492                                 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6493                                         return (FALSE);
6494
6495                                 synhw.maximumXCoord = (status[0] << 5) |
6496                                                      ((status[1] & 0x0f) << 1);
6497                                 synhw.maximumYCoord = (status[2] << 5) |
6498                                                      ((status[1] & 0xf0) >> 3);
6499                         } else {
6500                                 /*
6501                                  * Typical bezel limits. Taken from 'Synaptics
6502                                  * PS/2 * TouchPad Interfacing Guide' p.3.2.3.
6503                                  */
6504                                 synhw.maximumXCoord = 5472;
6505                                 synhw.maximumYCoord = 4448;
6506                         }
6507
6508                         if (synhw.capReportsMin) {
6509                                 if (!set_mouse_scaling(kbdc, 1))
6510                                         return (FALSE);
6511                                 if (mouse_ext_command(kbdc,
6512                                     SYNAPTICS_READ_MIN_COORDS) == 0)
6513                                         return (FALSE);
6514                                 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6515                                         return (FALSE);
6516
6517                                 synhw.minimumXCoord = (status[0] << 5) |
6518                                                      ((status[1] & 0x0f) << 1);
6519                                 synhw.minimumYCoord = (status[2] << 5) |
6520                                                      ((status[1] & 0xf0) >> 3);
6521                         } else {
6522                                 /*
6523                                  * Typical bezel limits. Taken from 'Synaptics
6524                                  * PS/2 * TouchPad Interfacing Guide' p.3.2.3.
6525                                  */
6526                                 synhw.minimumXCoord = 1472;
6527                                 synhw.minimumYCoord = 1408;
6528                         }
6529
6530                         /*
6531                          * ClickPad properties are not exported through PS/2
6532                          * protocol. Detection is based on controller's PnP ID.
6533                          */
6534                         if (synhw.capClickPad && psmcpnp_sc != NULL) {
6535                                 switch (psmcpnp_sc->type) {
6536                                 case PSMCPNP_FORCEPAD:
6537                                         synhw.forcePad = 1;
6538                                         break;
6539                                 case PSMCPNP_TOPBUTTONPAD:
6540                                         synhw.topButtonPad = 1;
6541                                         break;
6542                                 default:
6543                                         break;
6544                                 }
6545                         }
6546
6547                         if (verbose >= 2) {
6548                                 printf("  Continued capabilities:\n");
6549                                 printf("   capClickPad: %d\n",
6550                                        synhw.capClickPad);
6551                                 printf("   capDeluxeLEDs: %d\n",
6552                                        synhw.capDeluxeLEDs);
6553                                 printf("   noAbsoluteFilter: %d\n",
6554                                        synhw.noAbsoluteFilter);
6555                                 printf("   capReportsV: %d\n",
6556                                        synhw.capReportsV);
6557                                 printf("   capUniformClickPad: %d\n",
6558                                        synhw.capUniformClickPad);
6559                                 printf("   capReportsMin: %d\n",
6560                                        synhw.capReportsMin);
6561                                 printf("   capInterTouch: %d\n",
6562                                        synhw.capInterTouch);
6563                                 printf("   capReportsMax: %d\n",
6564                                        synhw.capReportsMax);
6565                                 printf("   capClearPad: %d\n",
6566                                        synhw.capClearPad);
6567                                 printf("   capAdvancedGestures: %d\n",
6568                                        synhw.capAdvancedGestures);
6569                                 printf("   capCoveredPad: %d\n",
6570                                        synhw.capCoveredPad);
6571                                 if (synhw.capReportsMax) {
6572                                         printf("   maximumXCoord: %d\n",
6573                                                synhw.maximumXCoord);
6574                                         printf("   maximumYCoord: %d\n",
6575                                                synhw.maximumYCoord);
6576                                 }
6577                                 if (synhw.capReportsMin) {
6578                                         printf("   minimumXCoord: %d\n",
6579                                                synhw.minimumXCoord);
6580                                         printf("   minimumYCoord: %d\n",
6581                                                synhw.minimumYCoord);
6582                                 }
6583                                 if (synhw.capClickPad) {
6584                                         printf("  Clickpad capabilities:\n");
6585                                         printf("   forcePad: %d\n",
6586                                                synhw.forcePad);
6587                                         printf("   topButtonPad: %d\n",
6588                                                synhw.topButtonPad);
6589                                 }
6590                         }
6591                         buttons += synhw.capClickPad;
6592                 }
6593         }
6594
6595         if (verbose >= 2) {
6596                 if (synhw.capExtended)
6597                         printf("  Additional Buttons: %d\n", buttons);
6598                 else
6599                         printf("  No extended capabilities\n");
6600         }
6601
6602         /*
6603          * Add the default number of 3 buttons to the total
6604          * count of supported buttons reported above.
6605          */
6606         buttons += 3;
6607
6608         /*
6609          * Read the mode byte.
6610          *
6611          * XXX: Note the Synaptics documentation also defines the first
6612          * byte of the response to this query to be a constant 0x3b, this
6613          * does not appear to be true for Touchpads with guest devices.
6614          */
6615         if (mouse_ext_command(kbdc, SYNAPTICS_READ_MODES) == 0)
6616                 return (FALSE);
6617         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6618                 return (FALSE);
6619         if (!SYNAPTICS_VERSION_GE(synhw, 7, 5) && status[1] != 0x47) {
6620                 printf("  Failed to read mode byte\n");
6621                 return (FALSE);
6622         }
6623
6624         if (arg == PROBE)
6625                 sc->synhw = synhw;
6626         if (!synaptics_support)
6627                 return (FALSE);
6628
6629         /* Set mouse type just now for synaptics_set_mode() */
6630         sc->hw.model = MOUSE_MODEL_SYNAPTICS;
6631
6632         synaptics_set_mode(sc, synaptics_preferred_mode(sc));
6633
6634         if (trackpoint_support && synhw.capPassthrough) {
6635                 enable_trackpoint(sc, arg);
6636         }
6637
6638         VLOG(3, (LOG_DEBUG, "synaptics: END init (%d buttons)\n", buttons));
6639
6640         if (arg == PROBE) {
6641                 /* Create sysctl tree. */
6642                 synaptics_sysctl_create_tree(sc, "synaptics",
6643                     "Synaptics TouchPad");
6644                 sc->hw.buttons = buttons;
6645         }
6646
6647         return (TRUE);
6648 }
6649
6650 static void
6651 synaptics_passthrough_on(struct psm_softc *sc)
6652 {
6653         VLOG(2, (LOG_NOTICE, "psm: setting pass-through mode.\n"));
6654         synaptics_set_mode(sc, synaptics_preferred_mode(sc) | (1 << 5));
6655 }
6656
6657 static void
6658 synaptics_passthrough_off(struct psm_softc *sc)
6659 {
6660         VLOG(2, (LOG_NOTICE, "psm: turning pass-through mode off.\n"));
6661         set_mouse_scaling(sc->kbdc, 2);
6662         set_mouse_scaling(sc->kbdc, 1);
6663         synaptics_set_mode(sc, synaptics_preferred_mode(sc));
6664 }
6665
6666 /* IBM/Lenovo TrackPoint */
6667 static int
6668 trackpoint_command(struct psm_softc *sc, int cmd, int loc, int val)
6669 {
6670         const int seq[] = { 0xe2, cmd, loc, val };
6671         int i;
6672
6673         if (sc->synhw.capPassthrough)
6674                 synaptics_passthrough_on(sc);
6675
6676         for (i = 0; i < nitems(seq); i++) {
6677                 if (sc->synhw.capPassthrough &&
6678                     (seq[i] == 0xff || seq[i] == 0xe7))
6679                         if (send_aux_command(sc->kbdc, 0xe7) != PSM_ACK) {
6680                                 synaptics_passthrough_off(sc);
6681                                 return (EIO);
6682                         }
6683                 if (send_aux_command(sc->kbdc, seq[i]) != PSM_ACK) {
6684                         if (sc->synhw.capPassthrough)
6685                                 synaptics_passthrough_off(sc);
6686                         return (EIO);
6687                 }
6688         }
6689
6690         if (sc->synhw.capPassthrough)
6691                 synaptics_passthrough_off(sc);
6692
6693         return (0);
6694 }
6695
6696 #define PSM_TPINFO(x)   offsetof(struct psm_softc, tpinfo.x)
6697 #define TPMASK          0
6698 #define TPLOC           1
6699 #define TPINFO          2
6700
6701 static int
6702 trackpoint_sysctl(SYSCTL_HANDLER_ARGS)
6703 {
6704         static const int data[][3] = {
6705                 { 0x00, 0x4a, PSM_TPINFO(sensitivity) },
6706                 { 0x00, 0x4d, PSM_TPINFO(inertia) },
6707                 { 0x00, 0x60, PSM_TPINFO(uplateau) },
6708                 { 0x00, 0x57, PSM_TPINFO(reach) },
6709                 { 0x00, 0x58, PSM_TPINFO(draghys) },
6710                 { 0x00, 0x59, PSM_TPINFO(mindrag) },
6711                 { 0x00, 0x5a, PSM_TPINFO(upthresh) },
6712                 { 0x00, 0x5c, PSM_TPINFO(threshold) },
6713                 { 0x00, 0x5d, PSM_TPINFO(jenks) },
6714                 { 0x00, 0x5e, PSM_TPINFO(ztime) },
6715                 { 0x01, 0x2c, PSM_TPINFO(pts) },
6716                 { 0x08, 0x2d, PSM_TPINFO(skipback) }
6717         };
6718         struct psm_softc *sc;
6719         int error, newval, *oldvalp;
6720         const int *tp;
6721
6722         if (arg1 == NULL || arg2 < 0 || arg2 >= nitems(data))
6723                 return (EINVAL);
6724         sc = arg1;
6725         tp = data[arg2];
6726         oldvalp = (int *)((intptr_t)sc + tp[TPINFO]);
6727         newval = *oldvalp;
6728         error = sysctl_handle_int(oidp, &newval, 0, req);
6729         if (error != 0)
6730                 return (error);
6731         if (newval == *oldvalp)
6732                 return (0);
6733         if (newval < 0 || newval > (tp[TPMASK] == 0 ? 255 : 1))
6734                 return (EINVAL);
6735         error = trackpoint_command(sc, tp[TPMASK] == 0 ? 0x81 : 0x47,
6736             tp[TPLOC], tp[TPMASK] == 0 ? newval : tp[TPMASK]);
6737         if (error != 0)
6738                 return (error);
6739         *oldvalp = newval;
6740
6741         return (0);
6742 }
6743
6744 static void
6745 trackpoint_sysctl_create_tree(struct psm_softc *sc)
6746 {
6747
6748         if (sc->tpinfo.sysctl_tree != NULL)
6749                 return;
6750
6751         /* Attach extra trackpoint sysctl nodes under hw.psm.trackpoint */
6752         sysctl_ctx_init(&sc->tpinfo.sysctl_ctx);
6753         sc->tpinfo.sysctl_tree = SYSCTL_ADD_NODE(&sc->tpinfo.sysctl_ctx,
6754             SYSCTL_STATIC_CHILDREN(_hw_psm), OID_AUTO, "trackpoint", CTLFLAG_RD,
6755             0, "IBM/Lenovo TrackPoint");
6756
6757         /* hw.psm.trackpoint.sensitivity */
6758         sc->tpinfo.sensitivity = 0x80;
6759         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6760             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6761             "sensitivity", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6762             sc, TRACKPOINT_SYSCTL_SENSITIVITY,
6763             trackpoint_sysctl, "I",
6764             "Sensitivity");
6765
6766         /* hw.psm.trackpoint.negative_inertia */
6767         sc->tpinfo.inertia = 0x06;
6768         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6769             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6770             "negative_inertia", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6771             sc, TRACKPOINT_SYSCTL_NEGATIVE_INERTIA,
6772             trackpoint_sysctl, "I",
6773             "Negative inertia factor");
6774
6775         /* hw.psm.trackpoint.upper_plateau */
6776         sc->tpinfo.uplateau = 0x61;
6777         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6778             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6779             "upper_plateau", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6780             sc, TRACKPOINT_SYSCTL_UPPER_PLATEAU,
6781             trackpoint_sysctl, "I",
6782             "Transfer function upper plateau speed");
6783
6784         /* hw.psm.trackpoint.backup_range */
6785         sc->tpinfo.reach = 0x0a;
6786         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6787             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6788             "backup_range", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6789             sc, TRACKPOINT_SYSCTL_BACKUP_RANGE,
6790             trackpoint_sysctl, "I",
6791             "Backup range");
6792
6793         /* hw.psm.trackpoint.drag_hysteresis */
6794         sc->tpinfo.draghys = 0xff;
6795         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6796             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6797             "drag_hysteresis", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6798             sc, TRACKPOINT_SYSCTL_DRAG_HYSTERESIS,
6799             trackpoint_sysctl, "I",
6800             "Drag hysteresis");
6801
6802         /* hw.psm.trackpoint.minimum_drag */
6803         sc->tpinfo.mindrag = 0x14;
6804         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6805             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6806             "minimum_drag", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6807             sc, TRACKPOINT_SYSCTL_MINIMUM_DRAG,
6808             trackpoint_sysctl, "I",
6809             "Minimum drag");
6810
6811         /* hw.psm.trackpoint.up_threshold */
6812         sc->tpinfo.upthresh = 0xff;
6813         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6814             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6815             "up_threshold", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6816             sc, TRACKPOINT_SYSCTL_UP_THRESHOLD,
6817             trackpoint_sysctl, "I",
6818             "Up threshold for release");
6819
6820         /* hw.psm.trackpoint.threshold */
6821         sc->tpinfo.threshold = 0x08;
6822         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6823             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6824             "threshold", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6825             sc, TRACKPOINT_SYSCTL_THRESHOLD,
6826             trackpoint_sysctl, "I",
6827             "Threshold");
6828
6829         /* hw.psm.trackpoint.jenks_curvature */
6830         sc->tpinfo.jenks = 0x87;
6831         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6832             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6833             "jenks_curvature", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6834             sc, TRACKPOINT_SYSCTL_JENKS_CURVATURE,
6835             trackpoint_sysctl, "I",
6836             "Jenks curvature");
6837
6838         /* hw.psm.trackpoint.z_time */
6839         sc->tpinfo.ztime = 0x26;
6840         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6841             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6842             "z_time", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6843             sc, TRACKPOINT_SYSCTL_Z_TIME,
6844             trackpoint_sysctl, "I",
6845             "Z time constant");
6846
6847         /* hw.psm.trackpoint.press_to_select */
6848         sc->tpinfo.pts = 0x00;
6849         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6850             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6851             "press_to_select", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6852             sc, TRACKPOINT_SYSCTL_PRESS_TO_SELECT,
6853             trackpoint_sysctl, "I",
6854             "Press to Select");
6855
6856         /* hw.psm.trackpoint.skip_backups */
6857         sc->tpinfo.skipback = 0x00;
6858         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6859             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6860             "skip_backups", CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_ANYBODY,
6861             sc, TRACKPOINT_SYSCTL_SKIP_BACKUPS,
6862             trackpoint_sysctl, "I",
6863             "Skip backups from drags");
6864 }
6865
6866 static void
6867 set_trackpoint_parameters(struct psm_softc *sc)
6868 {
6869         trackpoint_command(sc, 0x81, 0x4a, sc->tpinfo.sensitivity);
6870         trackpoint_command(sc, 0x81, 0x60, sc->tpinfo.uplateau);
6871         trackpoint_command(sc, 0x81, 0x4d, sc->tpinfo.inertia);
6872         trackpoint_command(sc, 0x81, 0x57, sc->tpinfo.reach);
6873         trackpoint_command(sc, 0x81, 0x58, sc->tpinfo.draghys);
6874         trackpoint_command(sc, 0x81, 0x59, sc->tpinfo.mindrag);
6875         trackpoint_command(sc, 0x81, 0x5a, sc->tpinfo.upthresh);
6876         trackpoint_command(sc, 0x81, 0x5c, sc->tpinfo.threshold);
6877         trackpoint_command(sc, 0x81, 0x5d, sc->tpinfo.jenks);
6878         trackpoint_command(sc, 0x81, 0x5e, sc->tpinfo.ztime);
6879         if (sc->tpinfo.pts == 0x01)
6880                 trackpoint_command(sc, 0x47, 0x2c, 0x01);
6881         if (sc->tpinfo.skipback == 0x01)
6882                 trackpoint_command(sc, 0x47, 0x2d, 0x08);
6883 }
6884
6885 static int
6886 enable_trackpoint(struct psm_softc *sc, enum probearg arg)
6887 {
6888         KBDC kbdc = sc->kbdc;
6889         int id;
6890
6891         /*
6892          * If called from enable_synaptics(), make sure that passthrough
6893          * mode is enabled so we can reach the trackpoint.
6894          * However, passthrough mode must be disabled before setting the
6895          * trackpoint parameters, as rackpoint_command() enables and disables
6896          * passthrough mode on its own.
6897          */
6898         if (sc->synhw.capPassthrough)
6899                 synaptics_passthrough_on(sc);
6900
6901         if (send_aux_command(kbdc, 0xe1) != PSM_ACK ||
6902             read_aux_data(kbdc) != 0x01)
6903                 goto no_trackpoint;
6904         id = read_aux_data(kbdc);
6905         if (id < 0x01)
6906                 goto no_trackpoint;
6907         if (arg == PROBE)
6908                 sc->tphw = id;
6909         if (!trackpoint_support)
6910                 goto no_trackpoint;
6911
6912         if (sc->synhw.capPassthrough)
6913                 synaptics_passthrough_off(sc);
6914
6915         if (arg == PROBE) {
6916                 trackpoint_sysctl_create_tree(sc);
6917                 /*
6918                  * Don't overwrite hwid and buttons when we are
6919                  * a guest device.
6920                  */
6921                 if (!sc->synhw.capPassthrough) {
6922                         sc->hw.hwid = id;
6923                         sc->hw.buttons = 3;
6924                 }
6925         }
6926
6927         set_trackpoint_parameters(sc);
6928
6929         return (TRUE);
6930
6931 no_trackpoint:
6932         if (sc->synhw.capPassthrough)
6933                 synaptics_passthrough_off(sc);
6934
6935         return (FALSE);
6936 }
6937
6938 /* Interlink electronics VersaPad */
6939 static int
6940 enable_versapad(struct psm_softc *sc, enum probearg arg)
6941 {
6942         KBDC kbdc = sc->kbdc;
6943         int data[3];
6944
6945         set_mouse_resolution(kbdc, PSMD_RES_MEDIUM_HIGH); /* set res. 2 */
6946         set_mouse_sampling_rate(kbdc, 100);             /* set rate 100 */
6947         set_mouse_scaling(kbdc, 1);                     /* set scale 1:1 */
6948         set_mouse_scaling(kbdc, 1);                     /* set scale 1:1 */
6949         set_mouse_scaling(kbdc, 1);                     /* set scale 1:1 */
6950         set_mouse_scaling(kbdc, 1);                     /* set scale 1:1 */
6951         if (get_mouse_status(kbdc, data, 0, 3) < 3)     /* get status */
6952                 return (FALSE);
6953         if (data[2] != 0xa || data[1] != 0 )    /* rate == 0xa && res. == 0 */
6954                 return (FALSE);
6955         set_mouse_scaling(kbdc, 1);                     /* set scale 1:1 */
6956
6957         return (TRUE);                          /* PS/2 absolute mode */
6958 }
6959
6960 /* Elantech Touchpad */
6961 static int
6962 elantech_read_1(KBDC kbdc, int hwversion, int reg, int *val)
6963 {
6964         int res, readcmd, retidx;
6965         int resp[3];
6966
6967         readcmd = hwversion == 2 ? ELANTECH_REG_READ : ELANTECH_REG_RDWR;
6968         retidx = hwversion == 4 ? 1 : 0;
6969
6970         res = send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
6971         res |= send_aux_command(kbdc, readcmd) != PSM_ACK;
6972         res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
6973         res |= send_aux_command(kbdc, reg) != PSM_ACK;
6974         res |= get_mouse_status(kbdc, resp, 0, 3) != 3;
6975
6976         if (res == 0)
6977                 *val = resp[retidx];
6978
6979         return (res);
6980 }
6981
6982 static int
6983 elantech_write_1(KBDC kbdc, int hwversion, int reg, int val)
6984 {
6985         int res, writecmd;
6986
6987         writecmd = hwversion == 2 ? ELANTECH_REG_WRITE : ELANTECH_REG_RDWR;
6988
6989         res = send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
6990         res |= send_aux_command(kbdc, writecmd) != PSM_ACK;
6991         res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
6992         res |= send_aux_command(kbdc, reg) != PSM_ACK;
6993         if (hwversion == 4) {
6994                 res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
6995                 res |= send_aux_command(kbdc, writecmd) != PSM_ACK;
6996         }
6997         res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
6998         res |= send_aux_command(kbdc, val) != PSM_ACK;
6999         res |= set_mouse_scaling(kbdc, 1) == 0;
7000
7001         return (res);
7002 }
7003
7004 static int
7005 elantech_cmd(KBDC kbdc, int hwversion, int cmd, int *resp)
7006 {
7007         int res;
7008
7009         if (hwversion == 2) {
7010                 res = set_mouse_scaling(kbdc, 1) == 0;
7011                 res |= mouse_ext_command(kbdc, cmd) == 0;
7012         } else {
7013                 res = send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7014                 res |= send_aux_command(kbdc, cmd) != PSM_ACK;
7015         }
7016         res |= get_mouse_status(kbdc, resp, 0, 3) != 3;
7017
7018         return (res);
7019 }
7020
7021 static int
7022 elantech_init(KBDC kbdc, elantechhw_t *elanhw)
7023 {
7024         int i, val, res, hwversion, reg10;
7025
7026         /* set absolute mode */
7027         hwversion = elanhw->hwversion;
7028         reg10 = -1;
7029         switch (hwversion) {
7030         case 2:
7031                 reg10 = elanhw->fwversion == 0x020030 ? 0x54 : 0xc4;
7032                 res = elantech_write_1(kbdc, hwversion, 0x10, reg10);
7033                 if (res)
7034                         break;
7035                 res = elantech_write_1(kbdc, hwversion, 0x11, 0x8A);
7036                 break;
7037         case 3:
7038                 reg10 = 0x0b;
7039                 res = elantech_write_1(kbdc, hwversion, 0x10, reg10);
7040                 break;
7041         case 4:
7042                 res = elantech_write_1(kbdc, hwversion, 0x07, 0x01);
7043                 break;
7044         default:
7045                 res = 1;
7046         }
7047
7048         /* Read back reg 0x10 to ensure hardware is ready. */
7049         if (res == 0 && reg10 >= 0) {
7050                 for (i = 0; i < 5; i++) {
7051                         if (elantech_read_1(kbdc, hwversion, 0x10, &val) == 0)
7052                                 break;
7053                         DELAY(2000);
7054                 }
7055                 if (i == 5)
7056                         res = 1;
7057         }
7058
7059         if (res)
7060                 printf("couldn't set absolute mode\n");
7061
7062         return (res);
7063 }
7064
7065 static void
7066 elantech_init_synaptics(struct psm_softc *sc)
7067 {
7068
7069         /* Set capabilites required by movement smother */
7070         sc->synhw.infoMajor = sc->elanhw.hwversion;
7071         sc->synhw.infoMinor = sc->elanhw.fwversion;
7072         sc->synhw.infoXupmm = sc->elanhw.dpmmx;
7073         sc->synhw.infoYupmm = sc->elanhw.dpmmy;
7074         sc->synhw.verticalScroll = 0;
7075         sc->synhw.nExtendedQueries = 4;
7076         sc->synhw.capExtended = 1;
7077         sc->synhw.capPassthrough = sc->elanhw.hastrackpoint;
7078         sc->synhw.capClickPad = sc->elanhw.isclickpad;
7079         sc->synhw.capMultiFinger = 1;
7080         if (sc->elanhw.issemimt)
7081                 sc->synhw.capAdvancedGestures = 1;
7082         else
7083                 sc->synhw.capReportsV = 1;
7084         sc->synhw.capPalmDetect = 1;
7085         sc->synhw.capPen = 0;
7086         sc->synhw.capReportsMax = 1;
7087         sc->synhw.maximumXCoord = sc->elanhw.sizex;
7088         sc->synhw.maximumYCoord = sc->elanhw.sizey;
7089         sc->synhw.capReportsMin = 1;
7090         sc->synhw.minimumXCoord = 0;
7091         sc->synhw.minimumYCoord = 0;
7092
7093         if (sc->syninfo.sysctl_tree == NULL) {
7094                 synaptics_sysctl_create_tree(sc, "elantech",
7095                     "Elantech Touchpad");
7096
7097                 /*
7098                  * Adjust synaptic smoother tunables
7099                  * 1. Disable finger detection pressure threshold. Unlike
7100                  *    synaptics we assume the finger is acting when packet with
7101                  *    its X&Y arrives not when pressure exceedes some threshold
7102                  * 2. Disable unrelated features like margins and noisy areas
7103                  * 3. Disable virtual scroll areas as 2nd finger is preferable
7104                  * 4. For clickpads set bottom quarter as 42% - 16% - 42% sized
7105                  *    softbuttons
7106                  * 5. Scale down divisors and movement lengths by a factor of 3
7107                  *    where 3 is Synaptics to Elantech (~2200/800) dpi ratio
7108                  */
7109
7110                 /* Set reporting range to be equal touchpad size */
7111                 sc->syninfo.max_x = sc->elanhw.sizex;
7112                 sc->syninfo.max_y = sc->elanhw.sizey;
7113
7114                 /* Disable finger detection pressure threshold */
7115                 sc->syninfo.min_pressure = 1;
7116
7117                 /* Adjust palm width to nearly match synaptics w=10 */
7118                 sc->syninfo.max_width = 7;
7119
7120                 /* Elans often report double & triple taps as single event */
7121                 sc->syninfo.tap_min_queue = 1;
7122
7123                 /* Use full area of touchpad */
7124                 sc->syninfo.margin_top = 0;
7125                 sc->syninfo.margin_right = 0;
7126                 sc->syninfo.margin_bottom = 0;
7127                 sc->syninfo.margin_left = 0;
7128
7129                 /* Disable noisy area */
7130                 sc->syninfo.na_top = 0;
7131                 sc->syninfo.na_right = 0;
7132                 sc->syninfo.na_bottom = 0;
7133                 sc->syninfo.na_left = 0;
7134
7135                 /* Tune divisors and movement lengths */
7136                 sc->syninfo.weight_len_squared = 200;
7137                 sc->syninfo.div_min = 3;
7138                 sc->syninfo.div_max = 6;
7139                 sc->syninfo.div_max_na = 10;
7140                 sc->syninfo.div_len = 30;
7141                 sc->syninfo.tap_max_delta = 25;
7142
7143                 /* Disable virtual scrolling areas and tune its divisors */
7144                 sc->syninfo.vscroll_hor_area = 0;
7145                 sc->syninfo.vscroll_ver_area = 0;
7146                 sc->syninfo.vscroll_min_delta = 15;
7147                 sc->syninfo.vscroll_div_min = 30;
7148                 sc->syninfo.vscroll_div_max = 50;
7149
7150                 /* Set bottom quarter as 42% - 16% - 42% sized softbuttons */
7151                 if (sc->elanhw.isclickpad) {
7152                         sc->syninfo.softbuttons_y = sc->elanhw.sizey / 4;
7153                         sc->syninfo.softbutton2_x = sc->elanhw.sizex * 11 / 25;
7154                         sc->syninfo.softbutton3_x = sc->elanhw.sizex * 14 / 25;
7155                 }
7156         }
7157
7158         return;
7159 }
7160
7161 static int
7162 enable_elantech(struct psm_softc *sc, enum probearg arg)
7163 {
7164         static const int ic2hw[] =
7165         /*IC: 0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f */
7166             { 0, 0, 2, 0, 2, 3, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 };
7167         static const int fw_sizes[][3] = {
7168                 /* FW.vers  MaxX  MaxY */
7169                 { 0x020030, 1152,  768 },
7170                 { 0x020800, 1152,  768 },
7171                 { 0x020b00, 1152,  768 },
7172                 { 0x040215,  900,  500 },
7173                 { 0x040216,  819,  405 },
7174                 { 0x040219,  900,  500 },
7175         };
7176         elantechhw_t elanhw;
7177         int icversion, hwversion, xtr, i, id, resp[3], dpix, dpiy;
7178         KBDC kbdc = sc->kbdc;
7179
7180         VLOG(3, (LOG_DEBUG, "elantech: BEGIN init\n"));
7181
7182         set_mouse_scaling(kbdc, 1);
7183         set_mouse_scaling(kbdc, 1);
7184         set_mouse_scaling(kbdc, 1);
7185         if (get_mouse_status(kbdc, resp, 0, 3) != 3)
7186                 return (FALSE);
7187
7188         if (!ELANTECH_MAGIC(resp))
7189                 return (FALSE);
7190
7191         /* Identify the Touchpad version. */
7192         if (elantech_cmd(kbdc, 2, ELANTECH_FW_VERSION, resp))
7193                 return (FALSE);
7194
7195         bzero(&elanhw, sizeof(elanhw));
7196
7197         elanhw.fwversion = (resp[0] << 16) | (resp[1] << 8) | resp[2];
7198         icversion = resp[0] & 0x0f;
7199         hwversion = ic2hw[icversion];
7200
7201         if (verbose >= 2)
7202                 printf("Elantech touchpad hardware v.%d firmware v.0x%06x\n",
7203                     hwversion, elanhw.fwversion);
7204
7205         if (ELANTECH_HW_IS_V1(elanhw.fwversion)) {
7206                 printf ("  Unsupported touchpad hardware (v1)\n");
7207                 return (FALSE);
7208         }
7209         if (hwversion == 0) {
7210                 printf ("  Unknown touchpad hardware (firmware v.0x%06x)\n",
7211                     elanhw.fwversion);
7212                 return (FALSE);
7213         }
7214
7215         /* Get the Touchpad model information. */
7216         elanhw.hwversion = hwversion;
7217         elanhw.issemimt = hwversion == 2;
7218         elanhw.isclickpad = (resp[1] & 0x10) != 0;
7219         elanhw.hascrc = (resp[1] & 0x40) != 0;
7220         elanhw.haspressure = elanhw.fwversion >= 0x020800;
7221
7222         /* Read the capability bits. */
7223         if (elantech_cmd(kbdc, hwversion, ELANTECH_CAPABILITIES, resp) != 0) {
7224                 printf("  Failed to read capability bits\n");
7225                 return (FALSE);
7226         }
7227
7228         elanhw.ntracesx = imax(resp[1], 3);
7229         elanhw.ntracesy = imax(resp[2], 3);
7230         elanhw.hastrackpoint = (resp[0] & 0x80) != 0;
7231
7232         /* Get the touchpad resolution */
7233         switch (hwversion) {
7234         case 4:
7235                 if (elantech_cmd(kbdc, hwversion, ELANTECH_RESOLUTION, resp)
7236                     == 0) {
7237                         dpix = (resp[1] & 0x0f) * 10 + 790;
7238                         dpiy = ((resp[1] & 0xf0) >> 4) * 10 + 790;
7239                         elanhw.dpmmx = (dpix * 10 + 5) / 254;
7240                         elanhw.dpmmy = (dpiy * 10 + 5) / 254;
7241                         break;
7242                 }
7243                 /* FALLTHROUGH */
7244         case 2:
7245         case 3:
7246                 elanhw.dpmmx = elanhw.dpmmy = 32; /* 800 dpi */
7247                 break;
7248         }
7249
7250         if (!elantech_support)
7251                 return (FALSE);
7252
7253         if (elantech_init(kbdc, &elanhw)) {
7254                 printf("couldn't initialize elantech touchpad\n");
7255                 return (FALSE);
7256         }
7257
7258         /*
7259          * Get the touchpad reporting range.
7260          * On HW v.3 touchpads it should be done after switching hardware
7261          * to real resolution mode (by setting bit 3 of reg10)
7262          */
7263         elanhw.dptracex = elanhw.dptracey = 64;
7264         for (i = 0; i < nitems(fw_sizes); i++) {
7265                 if (elanhw.fwversion == fw_sizes[i][0]) {
7266                         elanhw.sizex = fw_sizes[i][1];
7267                         elanhw.sizey = fw_sizes[i][2];
7268                         goto found;
7269                 }
7270         }
7271         if (elantech_cmd(kbdc, hwversion, ELANTECH_FW_ID, resp) != 0) {
7272                 printf("  Failed to read touchpad size\n");
7273                 elanhw.sizex = 10000; /* Arbitrary high values to     */
7274                 elanhw.sizey = 10000; /* prevent clipping in smoother */
7275         } else if (hwversion == 2) {
7276                 if ((elanhw.fwversion >> 16) == 0x14 && (resp[1] & 0x10) &&
7277                     !elantech_cmd(kbdc, hwversion, ELANTECH_SAMPLE, resp)) {
7278                         elanhw.dptracex = resp[1] / 2;
7279                         elanhw.dptracey = resp[2] / 2;
7280                 }
7281                 xtr = ((elanhw.fwversion >> 8) == 0x0208) ? 1 : 2;
7282                 elanhw.sizex = (elanhw.ntracesx - xtr) * elanhw.dptracex;
7283                 elanhw.sizey = (elanhw.ntracesy - xtr) * elanhw.dptracey;
7284         } else {
7285                 elanhw.sizex = (resp[0] & 0x0f) << 8 | resp[1];
7286                 elanhw.sizey = (resp[0] & 0xf0) << 4 | resp[2];
7287                 xtr = (elanhw.sizex % (elanhw.ntracesx - 2) == 0) ? 2 : 1;
7288                 elanhw.dptracex = elanhw.sizex / (elanhw.ntracesx - xtr);
7289                 elanhw.dptracey = elanhw.sizey / (elanhw.ntracesy - xtr);
7290         }
7291 found:
7292         if (verbose >= 2) {
7293                 printf("  Model information:\n");
7294                 printf("   MaxX:       %d\n", elanhw.sizex);
7295                 printf("   MaxY:       %d\n", elanhw.sizey);
7296                 printf("   DpmmX:      %d\n", elanhw.dpmmx);
7297                 printf("   DpmmY:      %d\n", elanhw.dpmmy);
7298                 printf("   TracesX:    %d\n", elanhw.ntracesx);
7299                 printf("   TracesY:    %d\n", elanhw.ntracesy);
7300                 printf("   DptraceX:   %d\n", elanhw.dptracex);
7301                 printf("   DptraceY:   %d\n", elanhw.dptracey);
7302                 printf("   SemiMT:     %d\n", elanhw.issemimt);
7303                 printf("   Clickpad:   %d\n", elanhw.isclickpad);
7304                 printf("   Trackpoint: %d\n", elanhw.hastrackpoint);
7305                 printf("   CRC:        %d\n", elanhw.hascrc);
7306                 printf("   Pressure:   %d\n", elanhw.haspressure);
7307         }
7308
7309         VLOG(3, (LOG_DEBUG, "elantech: END init\n"));
7310
7311         if (arg == PROBE) {
7312                 sc->elanhw = elanhw;
7313                 sc->hw.buttons = 3;
7314
7315                 /* Initialize synaptics movement smoother */
7316                 elantech_init_synaptics(sc);
7317
7318                 for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
7319                         PSM_FINGER_RESET(sc->elanaction.fingers[id]);
7320         }
7321
7322         return (TRUE);
7323 }
7324
7325 /*
7326  * Return true if 'now' is earlier than (start + (secs.usecs)).
7327  * Now may be NULL and the function will fetch the current time from
7328  * getmicrouptime(), or a cached 'now' can be passed in.
7329  * All values should be numbers derived from getmicrouptime().
7330  */
7331 static int
7332 timeelapsed(start, secs, usecs, now)
7333         const struct timeval *start, *now;
7334         int secs, usecs;
7335 {
7336         struct timeval snow, tv;
7337
7338         /* if there is no 'now' passed in, the get it as a convience. */
7339         if (now == NULL) {
7340                 getmicrouptime(&snow);
7341                 now = &snow;
7342         }
7343
7344         tv.tv_sec = secs;
7345         tv.tv_usec = usecs;
7346         timevaladd(&tv, start);
7347         return (timevalcmp(&tv, now, <));
7348 }
7349
7350 static int
7351 psmresume(device_t dev)
7352 {
7353         struct psm_softc *sc = device_get_softc(dev);
7354         int unit = device_get_unit(dev);
7355         int err;
7356
7357         VLOG(2, (LOG_NOTICE, "psm%d: system resume hook called.\n", unit));
7358
7359         if ((sc->config &
7360             (PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND)) == 0)
7361                 return (0);
7362
7363         err = reinitialize(sc, sc->config & PSM_CONFIG_INITAFTERSUSPEND);
7364
7365         if ((sc->state & PSM_ASLP) && !(sc->state & PSM_VALID)) {
7366                 /*
7367                  * Release the blocked process; it must be notified that
7368                  * the device cannot be accessed anymore.
7369                  */
7370                 sc->state &= ~PSM_ASLP;
7371                 wakeup(sc);
7372         }
7373
7374         VLOG(2, (LOG_DEBUG, "psm%d: system resume hook exiting.\n", unit));
7375
7376         return (err);
7377 }
7378
7379 DRIVER_MODULE(psm, atkbdc, psm_driver, psm_devclass, 0, 0);
7380 #ifdef EVDEV_SUPPORT
7381 MODULE_DEPEND(psm, evdev, 1, 1, 1);
7382 #endif
7383
7384 #ifdef DEV_ISA
7385
7386 /*
7387  * This sucks up assignments from PNPBIOS and ACPI.
7388  */
7389
7390 /*
7391  * When the PS/2 mouse device is reported by ACPI or PnP BIOS, it may
7392  * appear BEFORE the AT keyboard controller.  As the PS/2 mouse device
7393  * can be probed and attached only after the AT keyboard controller is
7394  * attached, we shall quietly reserve the IRQ resource for later use.
7395  * If the PS/2 mouse device is reported to us AFTER the keyboard controller,
7396  * copy the IRQ resource to the PS/2 mouse device instance hanging
7397  * under the keyboard controller, then probe and attach it.
7398  */
7399
7400 static  devclass_t                      psmcpnp_devclass;
7401
7402 static  device_probe_t                  psmcpnp_probe;
7403 static  device_attach_t                 psmcpnp_attach;
7404
7405 static device_method_t psmcpnp_methods[] = {
7406         DEVMETHOD(device_probe,         psmcpnp_probe),
7407         DEVMETHOD(device_attach,        psmcpnp_attach),
7408
7409         { 0, 0 }
7410 };
7411
7412 static driver_t psmcpnp_driver = {
7413         PSMCPNP_DRIVER_NAME,
7414         psmcpnp_methods,
7415         sizeof(struct psmcpnp_softc),
7416 };
7417
7418 static struct isa_pnp_id psmcpnp_ids[] = {
7419         { 0x030fd041, "PS/2 mouse port" },              /* PNP0F03 */
7420         { 0x0e0fd041, "PS/2 mouse port" },              /* PNP0F0E */
7421         { 0x120fd041, "PS/2 mouse port" },              /* PNP0F12 */
7422         { 0x130fd041, "PS/2 mouse port" },              /* PNP0F13 */
7423         { 0x1303d041, "PS/2 port" },                    /* PNP0313, XXX */
7424         { 0x02002e4f, "Dell PS/2 mouse port" },         /* Lat. X200, Dell */
7425         { 0x0002a906, "ALPS Glide Point" },             /* ALPS Glide Point */
7426         { 0x80374d24, "IBM PS/2 mouse port" },          /* IBM3780, ThinkPad */
7427         { 0x81374d24, "IBM PS/2 mouse port" },          /* IBM3781, ThinkPad */
7428         { 0x0190d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9001, Vaio */
7429         { 0x0290d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9002, Vaio */
7430         { 0x0390d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9003, Vaio */
7431         { 0x0490d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9004, Vaio */
7432         { 0 }
7433 };
7434
7435 /* _HID list for quirk detection. Any device below has _CID from psmcpnp_ids */
7436 static struct isa_pnp_id topbtpad_ids[] = {
7437         { 0x1700ae30, "Lenovo PS/2 clickpad port" },    /* LEN0017, ThinkPad */
7438         { 0x1800ae30, "Lenovo PS/2 clickpad port" },    /* LEN0018, ThinkPad */
7439         { 0x1900ae30, "Lenovo PS/2 clickpad port" },    /* LEN0019, ThinkPad */
7440         { 0x2300ae30, "Lenovo PS/2 clickpad port" },    /* LEN0023, ThinkPad */
7441         { 0x2a00ae30, "Lenovo PS/2 clickpad port" },    /* LEN002a, ThinkPad */
7442         { 0x2b00ae30, "Lenovo PS/2 clickpad port" },    /* LEN002b, ThinkPad */
7443         { 0x2c00ae30, "Lenovo PS/2 clickpad port" },    /* LEN002c, ThinkPad */
7444         { 0x2d00ae30, "Lenovo PS/2 clickpad port" },    /* LEN002d, ThinkPad */
7445         { 0x2e00ae30, "Lenovo PS/2 clickpad port" },    /* LEN002e, ThinkPad */
7446         { 0x3300ae30, "Lenovo PS/2 clickpad port" },    /* LEN0033, ThinkPad */
7447         { 0x3400ae30, "Lenovo PS/2 clickpad port" },    /* LEN0034, ThinkPad */
7448         { 0x3500ae30, "Lenovo PS/2 clickpad port" },    /* LEN0035, ThinkPad */
7449         { 0x3600ae30, "Lenovo PS/2 clickpad port" },    /* LEN0036, ThinkPad */
7450         { 0x3700ae30, "Lenovo PS/2 clickpad port" },    /* LEN0037, ThinkPad */
7451         { 0x3800ae30, "Lenovo PS/2 clickpad port" },    /* LEN0038, ThinkPad */
7452         { 0x3900ae30, "Lenovo PS/2 clickpad port" },    /* LEN0039, ThinkPad */
7453         { 0x4100ae30, "Lenovo PS/2 clickpad port" },    /* LEN0041, ThinkPad */
7454         { 0x4200ae30, "Lenovo PS/2 clickpad port" },    /* LEN0042, ThinkPad */
7455         { 0x4500ae30, "Lenovo PS/2 clickpad port" },    /* LEN0045, ThinkPad */
7456         { 0x4700ae30, "Lenovo PS/2 clickpad port" },    /* LEN0047, ThinkPad */
7457         { 0x4900ae30, "Lenovo PS/2 clickpad port" },    /* LEN0049, ThinkPad */
7458         { 0x0020ae30, "Lenovo PS/2 clickpad port" },    /* LEN2000, ThinkPad */
7459         { 0x0120ae30, "Lenovo PS/2 clickpad port" },    /* LEN2001, ThinkPad */
7460         { 0x0220ae30, "Lenovo PS/2 clickpad port" },    /* LEN2002, ThinkPad */
7461         { 0x0320ae30, "Lenovo PS/2 clickpad port" },    /* LEN2003, ThinkPad */
7462         { 0x0420ae30, "Lenovo PS/2 clickpad port" },    /* LEN2004, ThinkPad */
7463         { 0x0520ae30, "Lenovo PS/2 clickpad port" },    /* LEN2005, ThinkPad */
7464         { 0x0620ae30, "Lenovo PS/2 clickpad port" },    /* LEN2006, ThinkPad */
7465         { 0x0720ae30, "Lenovo PS/2 clickpad port" },    /* LEN2007, ThinkPad */
7466         { 0x0820ae30, "Lenovo PS/2 clickpad port" },    /* LEN2008, ThinkPad */
7467         { 0x0920ae30, "Lenovo PS/2 clickpad port" },    /* LEN2009, ThinkPad */
7468         { 0x0a20ae30, "Lenovo PS/2 clickpad port" },    /* LEN200a, ThinkPad */
7469         { 0x0b20ae30, "Lenovo PS/2 clickpad port" },    /* LEN200b, ThinkPad */
7470         { 0 }
7471 };
7472
7473 /* _HID list for quirk detection. Any device below has _CID from psmcpnp_ids */
7474 static struct isa_pnp_id forcepad_ids[] = {
7475         { 0x0d302e4f, "HP PS/2 forcepad port" },        /* SYN300D, EB 1040 */
7476         { 0x14302e4f, "HP PS/2 forcepad port" },        /* SYN3014, EB 1040 */
7477         { 0 }
7478 };
7479
7480 static int
7481 create_a_copy(device_t atkbdc, device_t me)
7482 {
7483         device_t psm;
7484         u_long irq;
7485
7486         /* find the PS/2 mouse device instance under the keyboard controller */
7487         psm = device_find_child(atkbdc, PSM_DRIVER_NAME,
7488             device_get_unit(atkbdc));
7489         if (psm == NULL)
7490                 return (ENXIO);
7491         if (device_get_state(psm) != DS_NOTPRESENT)
7492                 return (0);
7493
7494         /* move our resource to the found device */
7495         irq = bus_get_resource_start(me, SYS_RES_IRQ, 0);
7496         bus_delete_resource(me, SYS_RES_IRQ, 0);
7497         bus_set_resource(psm, SYS_RES_IRQ, KBDC_RID_AUX, irq, 1);
7498
7499         /* ...then probe and attach it */
7500         return (device_probe_and_attach(psm));
7501 }
7502
7503 static int
7504 psmcpnp_probe(device_t dev)
7505 {
7506         struct psmcpnp_softc *sc = device_get_softc(dev);
7507         struct resource *res;
7508         u_long irq;
7509         int rid;
7510
7511         if (ISA_PNP_PROBE(device_get_parent(dev), dev, forcepad_ids) == 0)
7512                 sc->type = PSMCPNP_FORCEPAD;
7513         else if (ISA_PNP_PROBE(device_get_parent(dev), dev, topbtpad_ids) == 0)
7514                 sc->type = PSMCPNP_TOPBUTTONPAD;
7515         else if (ISA_PNP_PROBE(device_get_parent(dev), dev, psmcpnp_ids) == 0)
7516                 sc->type = PSMCPNP_GENERIC;
7517         else
7518                 return (ENXIO);
7519
7520         /*
7521          * The PnP BIOS and ACPI are supposed to assign an IRQ (12)
7522          * to the PS/2 mouse device node. But, some buggy PnP BIOS
7523          * declares the PS/2 mouse device node without an IRQ resource!
7524          * If this happens, we shall refer to device hints.
7525          * If we still don't find it there, use a hardcoded value... XXX
7526          */
7527         rid = 0;
7528         irq = bus_get_resource_start(dev, SYS_RES_IRQ, rid);
7529         if (irq <= 0) {
7530                 if (resource_long_value(PSM_DRIVER_NAME,
7531                     device_get_unit(dev),"irq", &irq) != 0)
7532                         irq = 12;       /* XXX */
7533                 device_printf(dev, "irq resource info is missing; "
7534                     "assuming irq %ld\n", irq);
7535                 bus_set_resource(dev, SYS_RES_IRQ, rid, irq, 1);
7536         }
7537         res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 0);
7538         bus_release_resource(dev, SYS_RES_IRQ, rid, res);
7539
7540         /* keep quiet */
7541         if (!bootverbose)
7542                 device_quiet(dev);
7543
7544         return ((res == NULL) ? ENXIO : 0);
7545 }
7546
7547 static int
7548 psmcpnp_attach(device_t dev)
7549 {
7550         device_t atkbdc;
7551
7552         /* find the keyboard controller, which may be on acpi* or isa* bus */
7553         atkbdc = devclass_get_device(devclass_find(ATKBDC_DRIVER_NAME),
7554             device_get_unit(dev));
7555         if ((atkbdc != NULL) && (device_get_state(atkbdc) == DS_ATTACHED))
7556                 create_a_copy(atkbdc, dev);
7557
7558         return (0);
7559 }
7560
7561 DRIVER_MODULE(psmcpnp, isa, psmcpnp_driver, psmcpnp_devclass, 0, 0);
7562 DRIVER_MODULE(psmcpnp, acpi, psmcpnp_driver, psmcpnp_devclass, 0, 0);
7563 ISA_PNP_INFO(psmcpnp_ids);
7564 #endif /* DEV_ISA */