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         struct make_dev_args mda;
1952         int unit = device_get_unit(dev);
1953         struct psm_softc *sc = device_get_softc(dev);
1954         int error;
1955         int rid;
1956
1957         /* Setup initial state */
1958         sc->state = PSM_VALID;
1959         callout_init(&sc->callout, 0);
1960         callout_init(&sc->softcallout, 0);
1961
1962         /* Setup our interrupt handler */
1963         rid = KBDC_RID_AUX;
1964         sc->intr = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
1965         if (sc->intr == NULL)
1966                 return (ENXIO);
1967         error = bus_setup_intr(dev, sc->intr, INTR_TYPE_TTY, NULL, psmintr, sc,
1968             &sc->ih);
1969         if (error)
1970                 goto out;
1971
1972         /* Done */
1973         make_dev_args_init(&mda);
1974         mda.mda_devsw = &psm_cdevsw;
1975         mda.mda_mode = 0666;
1976         mda.mda_si_drv1 = sc;
1977
1978         if ((error = make_dev_s(&mda, &sc->dev, "psm%d", unit)) != 0)
1979                 goto out;
1980         if ((error = make_dev_s(&mda, &sc->bdev, "bpsm%d", unit)) != 0)
1981                 goto out;
1982
1983 #ifdef EVDEV_SUPPORT
1984         switch (sc->hw.model) {
1985         case MOUSE_MODEL_SYNAPTICS:
1986                 error = psm_register_synaptics(dev);
1987                 break;
1988
1989         case MOUSE_MODEL_ELANTECH:
1990                 error = psm_register_elantech(dev);
1991                 break;
1992
1993         default:
1994                 error = psm_register(dev, sc->hw.model);
1995         }
1996
1997         if (error)
1998                 goto out;
1999 #endif
2000
2001         /* Some touchpad devices need full reinitialization after suspend. */
2002         switch (sc->hw.model) {
2003         case MOUSE_MODEL_SYNAPTICS:
2004         case MOUSE_MODEL_GLIDEPOINT:
2005         case MOUSE_MODEL_VERSAPAD:
2006         case MOUSE_MODEL_ELANTECH:
2007                 sc->config |= PSM_CONFIG_INITAFTERSUSPEND;
2008                 break;
2009         default:
2010                 if (sc->synhw.infoMajor >= 4 || sc->tphw > 0)
2011                         sc->config |= PSM_CONFIG_INITAFTERSUSPEND;
2012                 break;
2013         }
2014
2015         /* Elantech trackpad`s sync bit differs from touchpad`s one */
2016         if (sc->hw.model == MOUSE_MODEL_ELANTECH &&
2017             (sc->elanhw.hascrc || sc->elanhw.hastrackpoint)) {
2018                 sc->config |= PSM_CONFIG_NOCHECKSYNC;
2019                 sc->flags &= ~PSM_NEED_SYNCBITS;
2020         }
2021
2022         if (!verbose)
2023                 printf("psm%d: model %s, device ID %d\n",
2024                     unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff);
2025         else {
2026                 printf("psm%d: model %s, device ID %d-%02x, %d buttons\n",
2027                     unit, model_name(sc->hw.model), sc->hw.hwid & 0x00ff,
2028                     sc->hw.hwid >> 8, sc->hw.buttons);
2029                 printf("psm%d: config:%08x, flags:%08x, packet size:%d\n",
2030                     unit, sc->config, sc->flags, sc->mode.packetsize);
2031                 printf("psm%d: syncmask:%02x, syncbits:%02x%s\n",
2032                     unit, sc->mode.syncmask[0], sc->mode.syncmask[1],
2033                     sc->config & PSM_CONFIG_NOCHECKSYNC ? " (sync not checked)" : "");
2034         }
2035
2036         if (bootverbose)
2037                 --verbose;
2038
2039 out:
2040         if (error != 0) {
2041                 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
2042                 if (sc->dev != NULL)
2043                         destroy_dev(sc->dev);
2044                 if (sc->bdev != NULL)
2045                         destroy_dev(sc->bdev);
2046         }
2047         return (error);
2048 }
2049
2050 static int
2051 psmdetach(device_t dev)
2052 {
2053         struct psm_softc *sc;
2054         int rid;
2055
2056         sc = device_get_softc(dev);
2057         if (sc->state & PSM_OPEN)
2058                 return (EBUSY);
2059
2060 #ifdef EVDEV_SUPPORT
2061         evdev_free(sc->evdev_r);
2062         evdev_free(sc->evdev_a);
2063 #endif
2064
2065         rid = KBDC_RID_AUX;
2066         bus_teardown_intr(dev, sc->intr, sc->ih);
2067         bus_release_resource(dev, SYS_RES_IRQ, rid, sc->intr);
2068
2069         destroy_dev(sc->dev);
2070         destroy_dev(sc->bdev);
2071
2072         callout_drain(&sc->callout);
2073         callout_drain(&sc->softcallout);
2074
2075         return (0);
2076 }
2077
2078 #ifdef EVDEV_SUPPORT
2079 static int
2080 psm_ev_open_r(struct evdev_dev *evdev)
2081 {
2082         struct psm_softc *sc = evdev_get_softc(evdev);
2083         int err = 0;
2084
2085         /* Get device data */
2086         if ((sc->state & PSM_VALID) == 0) {
2087                 /* the device is no longer valid/functioning */
2088                 return (ENXIO);
2089         }
2090
2091         if (!(sc->state & (PSM_OPEN | PSM_EV_OPEN_A)))
2092                 err = psmopen(sc);
2093
2094         if (err == 0)
2095                 sc->state |= PSM_EV_OPEN_R;
2096
2097         return (err);
2098 }
2099
2100 static int
2101 psm_ev_close_r(struct evdev_dev *evdev)
2102 {
2103         struct psm_softc *sc = evdev_get_softc(evdev);
2104         int err = 0;
2105
2106         sc->state &= ~PSM_EV_OPEN_R;
2107
2108         if (sc->state & (PSM_OPEN | PSM_EV_OPEN_A))
2109                 return (0);
2110
2111         if (sc->state & PSM_VALID)
2112                 err = psmclose(sc);
2113
2114         return (err);
2115 }
2116
2117 static int
2118 psm_ev_open_a(struct evdev_dev *evdev)
2119 {
2120         struct psm_softc *sc = evdev_get_softc(evdev);
2121         int err = 0;
2122
2123         /* Get device data */
2124         if ((sc->state & PSM_VALID) == 0) {
2125                 /* the device is no longer valid/functioning */
2126                 return (ENXIO);
2127         }
2128
2129         if (!(sc->state & (PSM_OPEN | PSM_EV_OPEN_R)))
2130                 err = psmopen(sc);
2131
2132         if (err == 0)
2133                 sc->state |= PSM_EV_OPEN_A;
2134
2135         return (err);
2136 }
2137
2138 static int
2139 psm_ev_close_a(struct evdev_dev *evdev)
2140 {
2141         struct psm_softc *sc = evdev_get_softc(evdev);
2142         int err = 0;
2143
2144         sc->state &= ~PSM_EV_OPEN_A;
2145
2146         if (sc->state & (PSM_OPEN | PSM_EV_OPEN_R))
2147                 return (0);
2148
2149         if (sc->state & PSM_VALID)
2150                 err = psmclose(sc);
2151
2152         return (err);
2153 }
2154 #endif
2155
2156 static int
2157 psm_cdev_open(struct cdev *dev, int flag, int fmt, struct thread *td)
2158 {
2159         struct psm_softc *sc;
2160         int err = 0;
2161
2162         /* Get device data */
2163         sc = dev->si_drv1;
2164         if ((sc == NULL) || (sc->state & PSM_VALID) == 0) {
2165                 /* the device is no longer valid/functioning */
2166                 return (ENXIO);
2167         }
2168
2169         /* Disallow multiple opens */
2170         if (sc->state & PSM_OPEN)
2171                 return (EBUSY);
2172
2173         device_busy(devclass_get_device(psm_devclass, sc->unit));
2174
2175 #ifdef EVDEV_SUPPORT
2176         /* Already opened by evdev */
2177         if (!(sc->state & (PSM_EV_OPEN_R | PSM_EV_OPEN_A)))
2178 #endif
2179                 err = psmopen(sc);
2180
2181         if (err == 0)
2182                 sc->state |= PSM_OPEN;
2183         else
2184                 device_unbusy(devclass_get_device(psm_devclass, sc->unit));
2185
2186         return (err);
2187 }
2188
2189 static int
2190 psm_cdev_close(struct cdev *dev, int flag, int fmt, struct thread *td)
2191 {
2192         struct psm_softc *sc;
2193         int err = 0;
2194
2195         /* Get device data */
2196         sc = dev->si_drv1;
2197         if ((sc == NULL) || (sc->state & PSM_VALID) == 0) {
2198                 /* the device is no longer valid/functioning */
2199                 return (ENXIO);
2200         }
2201
2202 #ifdef EVDEV_SUPPORT
2203         /* Still opened by evdev */
2204         if (!(sc->state & (PSM_EV_OPEN_R | PSM_EV_OPEN_A)))
2205 #endif
2206                 err = psmclose(sc);
2207
2208         if (err == 0) {
2209                 sc->state &= ~PSM_OPEN;
2210                 /* clean up and sigio requests */
2211                 if (sc->async != NULL) {
2212                         funsetown(&sc->async);
2213                         sc->async = NULL;
2214                 }
2215                 device_unbusy(devclass_get_device(psm_devclass, sc->unit));
2216         }
2217
2218         return (err);
2219 }
2220
2221 static int
2222 psmopen(struct psm_softc *sc)
2223 {
2224         int command_byte;
2225         int err;
2226         int s;
2227
2228         /* Initialize state */
2229         sc->mode.level = sc->dflt_mode.level;
2230         sc->mode.protocol = sc->dflt_mode.protocol;
2231         sc->watchdog = FALSE;
2232         sc->async = NULL;
2233
2234         /* flush the event queue */
2235         sc->queue.count = 0;
2236         sc->queue.head = 0;
2237         sc->queue.tail = 0;
2238         sc->status.flags = 0;
2239         sc->status.button = 0;
2240         sc->status.obutton = 0;
2241         sc->status.dx = 0;
2242         sc->status.dy = 0;
2243         sc->status.dz = 0;
2244         sc->button = 0;
2245         sc->pqueue_start = 0;
2246         sc->pqueue_end = 0;
2247
2248         /* empty input buffer */
2249         flushpackets(sc);
2250         sc->syncerrors = 0;
2251         sc->pkterrors = 0;
2252
2253         /* don't let timeout routines in the keyboard driver to poll the kbdc */
2254         if (!kbdc_lock(sc->kbdc, TRUE))
2255                 return (EIO);
2256
2257         /* save the current controller command byte */
2258         s = spltty();
2259         command_byte = get_controller_command_byte(sc->kbdc);
2260
2261         /* enable the aux port and temporalily disable the keyboard */
2262         if (command_byte == -1 || !set_controller_command_byte(sc->kbdc,
2263             kbdc_get_device_mask(sc->kbdc),
2264             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
2265             KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2266                 /* CONTROLLER ERROR; do you know how to get out of this? */
2267                 kbdc_lock(sc->kbdc, FALSE);
2268                 splx(s);
2269                 log(LOG_ERR,
2270                     "psm%d: unable to set the command byte (psmopen).\n",
2271                     sc->unit);
2272                 return (EIO);
2273         }
2274         /*
2275          * Now that the keyboard controller is told not to generate
2276          * the keyboard and mouse interrupts, call `splx()' to allow
2277          * the other tty interrupts. The clock interrupt may also occur,
2278          * but timeout routines will be blocked by the poll flag set
2279          * via `kbdc_lock()'
2280          */
2281         splx(s);
2282
2283         /* enable the mouse device */
2284         err = doopen(sc, command_byte);
2285
2286         /* done */
2287         kbdc_lock(sc->kbdc, FALSE);
2288         return (err);
2289 }
2290
2291 static int
2292 psmclose(struct psm_softc *sc)
2293 {
2294         int stat[3];
2295         int command_byte;
2296         int s;
2297
2298         /* don't let timeout routines in the keyboard driver to poll the kbdc */
2299         if (!kbdc_lock(sc->kbdc, TRUE))
2300                 return (EIO);
2301
2302         /* save the current controller command byte */
2303         s = spltty();
2304         command_byte = get_controller_command_byte(sc->kbdc);
2305         if (command_byte == -1) {
2306                 kbdc_lock(sc->kbdc, FALSE);
2307                 splx(s);
2308                 return (EIO);
2309         }
2310
2311         /* disable the aux interrupt and temporalily disable the keyboard */
2312         if (!set_controller_command_byte(sc->kbdc,
2313             kbdc_get_device_mask(sc->kbdc),
2314             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
2315             KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2316                 log(LOG_ERR,
2317                     "psm%d: failed to disable the aux int (psmclose).\n",
2318                     sc->unit);
2319                 /* CONTROLLER ERROR;
2320                  * NOTE: we shall force our way through. Because the only
2321                  * ill effect we shall see is that we may not be able
2322                  * to read ACK from the mouse, and it doesn't matter much
2323                  * so long as the mouse will accept the DISABLE command.
2324                  */
2325         }
2326         splx(s);
2327
2328         /* stop the watchdog timer */
2329         callout_stop(&sc->callout);
2330
2331         /* remove anything left in the output buffer */
2332         empty_aux_buffer(sc->kbdc, 10);
2333
2334         /* disable the aux device, port and interrupt */
2335         if (sc->state & PSM_VALID) {
2336                 if (!disable_aux_dev(sc->kbdc)) {
2337                         /* MOUSE ERROR;
2338                          * NOTE: we don't return (error) and continue,
2339                          * pretending we have successfully disabled the device.
2340                          * It's OK because the interrupt routine will discard
2341                          * any data from the mouse hereafter.
2342                          */
2343                         log(LOG_ERR,
2344                             "psm%d: failed to disable the device (psmclose).\n",
2345                             sc->unit);
2346                 }
2347
2348                 if (get_mouse_status(sc->kbdc, stat, 0, 3) < 3)
2349                         log(LOG_DEBUG,
2350                             "psm%d: failed to get status (psmclose).\n",
2351                             sc->unit);
2352         }
2353
2354         if (!set_controller_command_byte(sc->kbdc,
2355             kbdc_get_device_mask(sc->kbdc),
2356             (command_byte & KBD_KBD_CONTROL_BITS) |
2357             KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2358                 /*
2359                  * CONTROLLER ERROR;
2360                  * we shall ignore this error; see the above comment.
2361                  */
2362                 log(LOG_ERR,
2363                     "psm%d: failed to disable the aux port (psmclose).\n",
2364                     sc->unit);
2365         }
2366
2367         /* remove anything left in the output buffer */
2368         empty_aux_buffer(sc->kbdc, 10);
2369
2370         /* close is almost always successful */
2371         kbdc_lock(sc->kbdc, FALSE);
2372         return (0);
2373 }
2374
2375 static int
2376 tame_mouse(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *status,
2377     u_char *buf)
2378 {
2379         static u_char butmapps2[8] = {
2380                 0,
2381                 MOUSE_PS2_BUTTON1DOWN,
2382                 MOUSE_PS2_BUTTON2DOWN,
2383                 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN,
2384                 MOUSE_PS2_BUTTON3DOWN,
2385                 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON3DOWN,
2386                 MOUSE_PS2_BUTTON2DOWN | MOUSE_PS2_BUTTON3DOWN,
2387                 MOUSE_PS2_BUTTON1DOWN | MOUSE_PS2_BUTTON2DOWN |
2388                     MOUSE_PS2_BUTTON3DOWN,
2389         };
2390         static u_char butmapmsc[8] = {
2391                 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP |
2392                     MOUSE_MSC_BUTTON3UP,
2393                 MOUSE_MSC_BUTTON2UP | MOUSE_MSC_BUTTON3UP,
2394                 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON3UP,
2395                 MOUSE_MSC_BUTTON3UP,
2396                 MOUSE_MSC_BUTTON1UP | MOUSE_MSC_BUTTON2UP,
2397                 MOUSE_MSC_BUTTON2UP,
2398                 MOUSE_MSC_BUTTON1UP,
2399                 0,
2400         };
2401         int mapped;
2402         int i;
2403
2404         if (sc->mode.level == PSM_LEVEL_BASE) {
2405                 mapped = status->button & ~MOUSE_BUTTON4DOWN;
2406                 if (status->button & MOUSE_BUTTON4DOWN)
2407                         mapped |= MOUSE_BUTTON1DOWN;
2408                 status->button = mapped;
2409                 buf[0] = MOUSE_PS2_SYNC | butmapps2[mapped & MOUSE_STDBUTTONS];
2410                 i = imax(imin(status->dx, 255), -256);
2411                 if (i < 0)
2412                         buf[0] |= MOUSE_PS2_XNEG;
2413                 buf[1] = i;
2414                 i = imax(imin(status->dy, 255), -256);
2415                 if (i < 0)
2416                         buf[0] |= MOUSE_PS2_YNEG;
2417                 buf[2] = i;
2418                 return (MOUSE_PS2_PACKETSIZE);
2419         } else if (sc->mode.level == PSM_LEVEL_STANDARD) {
2420                 buf[0] = MOUSE_MSC_SYNC |
2421                     butmapmsc[status->button & MOUSE_STDBUTTONS];
2422                 i = imax(imin(status->dx, 255), -256);
2423                 buf[1] = i >> 1;
2424                 buf[3] = i - buf[1];
2425                 i = imax(imin(status->dy, 255), -256);
2426                 buf[2] = i >> 1;
2427                 buf[4] = i - buf[2];
2428                 i = imax(imin(status->dz, 127), -128);
2429                 buf[5] = (i >> 1) & 0x7f;
2430                 buf[6] = (i - (i >> 1)) & 0x7f;
2431                 buf[7] = (~status->button >> 3) & 0x7f;
2432                 return (MOUSE_SYS_PACKETSIZE);
2433         }
2434         return (pb->inputbytes);
2435 }
2436
2437 static int
2438 psmread(struct cdev *dev, struct uio *uio, int flag)
2439 {
2440         struct psm_softc *sc = dev->si_drv1;
2441         u_char buf[PSM_SMALLBUFSIZE];
2442         int error = 0;
2443         int s;
2444         int l;
2445
2446         if ((sc->state & PSM_VALID) == 0)
2447                 return (EIO);
2448
2449         /* block until mouse activity occurred */
2450         s = spltty();
2451         while (sc->queue.count <= 0) {
2452                 if (dev != sc->bdev) {
2453                         splx(s);
2454                         return (EWOULDBLOCK);
2455                 }
2456                 sc->state |= PSM_ASLP;
2457                 error = tsleep(sc, PZERO | PCATCH, "psmrea", 0);
2458                 sc->state &= ~PSM_ASLP;
2459                 if (error) {
2460                         splx(s);
2461                         return (error);
2462                 } else if ((sc->state & PSM_VALID) == 0) {
2463                         /* the device disappeared! */
2464                         splx(s);
2465                         return (EIO);
2466                 }
2467         }
2468         splx(s);
2469
2470         /* copy data to the user land */
2471         while ((sc->queue.count > 0) && (uio->uio_resid > 0)) {
2472                 s = spltty();
2473                 l = imin(sc->queue.count, uio->uio_resid);
2474                 if (l > sizeof(buf))
2475                         l = sizeof(buf);
2476                 if (l > sizeof(sc->queue.buf) - sc->queue.head) {
2477                         bcopy(&sc->queue.buf[sc->queue.head], &buf[0],
2478                             sizeof(sc->queue.buf) - sc->queue.head);
2479                         bcopy(&sc->queue.buf[0],
2480                             &buf[sizeof(sc->queue.buf) - sc->queue.head],
2481                             l - (sizeof(sc->queue.buf) - sc->queue.head));
2482                 } else
2483                         bcopy(&sc->queue.buf[sc->queue.head], &buf[0], l);
2484                 sc->queue.count -= l;
2485                 sc->queue.head = (sc->queue.head + l) % sizeof(sc->queue.buf);
2486                 splx(s);
2487                 error = uiomove(buf, l, uio);
2488                 if (error)
2489                         break;
2490         }
2491
2492         return (error);
2493 }
2494
2495 static int
2496 block_mouse_data(struct psm_softc *sc, int *c)
2497 {
2498         int s;
2499
2500         if (!kbdc_lock(sc->kbdc, TRUE))
2501                 return (EIO);
2502
2503         s = spltty();
2504         *c = get_controller_command_byte(sc->kbdc);
2505         if ((*c == -1) || !set_controller_command_byte(sc->kbdc,
2506             kbdc_get_device_mask(sc->kbdc),
2507             KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT |
2508             KBD_ENABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
2509                 /* this is CONTROLLER ERROR */
2510                 splx(s);
2511                 kbdc_lock(sc->kbdc, FALSE);
2512                 return (EIO);
2513         }
2514
2515         /*
2516          * The device may be in the middle of status data transmission.
2517          * The transmission will be interrupted, thus, incomplete status
2518          * data must be discarded. Although the aux interrupt is disabled
2519          * at the keyboard controller level, at most one aux interrupt
2520          * may have already been pending and a data byte is in the
2521          * output buffer; throw it away. Note that the second argument
2522          * to `empty_aux_buffer()' is zero, so that the call will just
2523          * flush the internal queue.
2524          * `psmintr()' will be invoked after `splx()' if an interrupt is
2525          * pending; it will see no data and returns immediately.
2526          */
2527         empty_aux_buffer(sc->kbdc, 0);          /* flush the queue */
2528         read_aux_data_no_wait(sc->kbdc);        /* throw away data if any */
2529         flushpackets(sc);
2530         splx(s);
2531
2532         return (0);
2533 }
2534
2535 static void
2536 dropqueue(struct psm_softc *sc)
2537 {
2538
2539         sc->queue.count = 0;
2540         sc->queue.head = 0;
2541         sc->queue.tail = 0;
2542         if ((sc->state & PSM_SOFTARMED) != 0) {
2543                 sc->state &= ~PSM_SOFTARMED;
2544                 callout_stop(&sc->softcallout);
2545         }
2546         sc->pqueue_start = sc->pqueue_end;
2547 }
2548
2549 static void
2550 flushpackets(struct psm_softc *sc)
2551 {
2552
2553         dropqueue(sc);
2554         bzero(&sc->pqueue, sizeof(sc->pqueue));
2555 }
2556
2557 static int
2558 unblock_mouse_data(struct psm_softc *sc, int c)
2559 {
2560         int error = 0;
2561
2562         /*
2563          * We may have seen a part of status data during `set_mouse_XXX()'.
2564          * they have been queued; flush it.
2565          */
2566         empty_aux_buffer(sc->kbdc, 0);
2567
2568         /* restore ports and interrupt */
2569         if (!set_controller_command_byte(sc->kbdc,
2570             kbdc_get_device_mask(sc->kbdc),
2571             c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
2572                 /*
2573                  * CONTROLLER ERROR; this is serious, we may have
2574                  * been left with the inaccessible keyboard and
2575                  * the disabled mouse interrupt.
2576                  */
2577                 error = EIO;
2578         }
2579
2580         kbdc_lock(sc->kbdc, FALSE);
2581         return (error);
2582 }
2583
2584 static int
2585 psmwrite(struct cdev *dev, struct uio *uio, int flag)
2586 {
2587         struct psm_softc *sc = dev->si_drv1;
2588         u_char buf[PSM_SMALLBUFSIZE];
2589         int error = 0, i, l;
2590
2591         if ((sc->state & PSM_VALID) == 0)
2592                 return (EIO);
2593
2594         if (sc->mode.level < PSM_LEVEL_NATIVE)
2595                 return (ENODEV);
2596
2597         /* copy data from the user land */
2598         while (uio->uio_resid > 0) {
2599                 l = imin(PSM_SMALLBUFSIZE, uio->uio_resid);
2600                 error = uiomove(buf, l, uio);
2601                 if (error)
2602                         break;
2603                 for (i = 0; i < l; i++) {
2604                         VLOG(4, (LOG_DEBUG, "psm: cmd 0x%x\n", buf[i]));
2605                         if (!write_aux_command(sc->kbdc, buf[i])) {
2606                                 VLOG(2, (LOG_DEBUG,
2607                                     "psm: cmd 0x%x failed.\n", buf[i]));
2608                                 return (reinitialize(sc, FALSE));
2609                         }
2610                 }
2611         }
2612
2613         return (error);
2614 }
2615
2616 static int
2617 psmioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2618     struct thread *td)
2619 {
2620         struct psm_softc *sc = dev->si_drv1;
2621         mousemode_t mode;
2622         mousestatus_t status;
2623         mousedata_t *data;
2624         int stat[3];
2625         int command_byte;
2626         int error = 0;
2627         int s;
2628
2629         /* Perform IOCTL command */
2630         switch (cmd) {
2631
2632         case OLD_MOUSE_GETHWINFO:
2633                 s = spltty();
2634                 ((old_mousehw_t *)addr)->buttons = sc->hw.buttons;
2635                 ((old_mousehw_t *)addr)->iftype = sc->hw.iftype;
2636                 ((old_mousehw_t *)addr)->type = sc->hw.type;
2637                 ((old_mousehw_t *)addr)->hwid = sc->hw.hwid & 0x00ff;
2638                 splx(s);
2639                 break;
2640
2641         case MOUSE_GETHWINFO:
2642                 s = spltty();
2643                 *(mousehw_t *)addr = sc->hw;
2644                 if (sc->mode.level == PSM_LEVEL_BASE)
2645                         ((mousehw_t *)addr)->model = MOUSE_MODEL_GENERIC;
2646                 splx(s);
2647                 break;
2648
2649         case MOUSE_SYN_GETHWINFO:
2650                 s = spltty();
2651                 if (sc->synhw.infoMajor >= 4)
2652                         *(synapticshw_t *)addr = sc->synhw;
2653                 else
2654                         error = EINVAL;
2655                 splx(s);
2656                 break;
2657
2658         case OLD_MOUSE_GETMODE:
2659                 s = spltty();
2660                 switch (sc->mode.level) {
2661                 case PSM_LEVEL_BASE:
2662                         ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2663                         break;
2664                 case PSM_LEVEL_STANDARD:
2665                         ((old_mousemode_t *)addr)->protocol =
2666                             MOUSE_PROTO_SYSMOUSE;
2667                         break;
2668                 case PSM_LEVEL_NATIVE:
2669                         ((old_mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2670                         break;
2671                 }
2672                 ((old_mousemode_t *)addr)->rate = sc->mode.rate;
2673                 ((old_mousemode_t *)addr)->resolution = sc->mode.resolution;
2674                 ((old_mousemode_t *)addr)->accelfactor = sc->mode.accelfactor;
2675                 splx(s);
2676                 break;
2677
2678         case MOUSE_GETMODE:
2679                 s = spltty();
2680                 *(mousemode_t *)addr = sc->mode;
2681                 if ((sc->flags & PSM_NEED_SYNCBITS) != 0) {
2682                         ((mousemode_t *)addr)->syncmask[0] = 0;
2683                         ((mousemode_t *)addr)->syncmask[1] = 0;
2684                 }
2685                 ((mousemode_t *)addr)->resolution =
2686                         MOUSE_RES_LOW - sc->mode.resolution;
2687                 switch (sc->mode.level) {
2688                 case PSM_LEVEL_BASE:
2689                         ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2690                         ((mousemode_t *)addr)->packetsize =
2691                             MOUSE_PS2_PACKETSIZE;
2692                         break;
2693                 case PSM_LEVEL_STANDARD:
2694                         ((mousemode_t *)addr)->protocol = MOUSE_PROTO_SYSMOUSE;
2695                         ((mousemode_t *)addr)->packetsize =
2696                             MOUSE_SYS_PACKETSIZE;
2697                         ((mousemode_t *)addr)->syncmask[0] = MOUSE_SYS_SYNCMASK;
2698                         ((mousemode_t *)addr)->syncmask[1] = MOUSE_SYS_SYNC;
2699                         break;
2700                 case PSM_LEVEL_NATIVE:
2701                         /* FIXME: this isn't quite correct... XXX */
2702                         ((mousemode_t *)addr)->protocol = MOUSE_PROTO_PS2;
2703                         break;
2704                 }
2705                 splx(s);
2706                 break;
2707
2708         case OLD_MOUSE_SETMODE:
2709         case MOUSE_SETMODE:
2710                 if (cmd == OLD_MOUSE_SETMODE) {
2711                         mode.rate = ((old_mousemode_t *)addr)->rate;
2712                         /*
2713                          * resolution  old I/F   new I/F
2714                          * default        0         0
2715                          * low            1        -2
2716                          * medium low     2        -3
2717                          * medium high    3        -4
2718                          * high           4        -5
2719                          */
2720                         if (((old_mousemode_t *)addr)->resolution > 0)
2721                                 mode.resolution =
2722                                     -((old_mousemode_t *)addr)->resolution - 1;
2723                         else
2724                                 mode.resolution = 0;
2725                         mode.accelfactor =
2726                             ((old_mousemode_t *)addr)->accelfactor;
2727                         mode.level = -1;
2728                 } else
2729                         mode = *(mousemode_t *)addr;
2730
2731                 /* adjust and validate parameters. */
2732                 if (mode.rate > UCHAR_MAX)
2733                         return (EINVAL);
2734                 if (mode.rate == 0)
2735                         mode.rate = sc->dflt_mode.rate;
2736                 else if (mode.rate == -1)
2737                         /* don't change the current setting */
2738                         ;
2739                 else if (mode.rate < 0)
2740                         return (EINVAL);
2741                 if (mode.resolution >= UCHAR_MAX)
2742                         return (EINVAL);
2743                 if (mode.resolution >= 200)
2744                         mode.resolution = MOUSE_RES_HIGH;
2745                 else if (mode.resolution >= 100)
2746                         mode.resolution = MOUSE_RES_MEDIUMHIGH;
2747                 else if (mode.resolution >= 50)
2748                         mode.resolution = MOUSE_RES_MEDIUMLOW;
2749                 else if (mode.resolution > 0)
2750                         mode.resolution = MOUSE_RES_LOW;
2751                 if (mode.resolution == MOUSE_RES_DEFAULT)
2752                         mode.resolution = sc->dflt_mode.resolution;
2753                 else if (mode.resolution == -1)
2754                         /* don't change the current setting */
2755                         ;
2756                 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
2757                         mode.resolution = MOUSE_RES_LOW - mode.resolution;
2758                 if (mode.level == -1)
2759                         /* don't change the current setting */
2760                         mode.level = sc->mode.level;
2761                 else if ((mode.level < PSM_LEVEL_MIN) ||
2762                     (mode.level > PSM_LEVEL_MAX))
2763                         return (EINVAL);
2764                 if (mode.accelfactor == -1)
2765                         /* don't change the current setting */
2766                         mode.accelfactor = sc->mode.accelfactor;
2767                 else if (mode.accelfactor < 0)
2768                         return (EINVAL);
2769
2770                 /* don't allow anybody to poll the keyboard controller */
2771                 error = block_mouse_data(sc, &command_byte);
2772                 if (error)
2773                         return (error);
2774
2775                 /* set mouse parameters */
2776                 if (mode.rate > 0)
2777                         mode.rate = set_mouse_sampling_rate(sc->kbdc,
2778                             mode.rate);
2779                 if (mode.resolution >= 0)
2780                         mode.resolution =
2781                             set_mouse_resolution(sc->kbdc, mode.resolution);
2782                 set_mouse_scaling(sc->kbdc, 1);
2783                 get_mouse_status(sc->kbdc, stat, 0, 3);
2784
2785                 s = spltty();
2786                 sc->mode.rate = mode.rate;
2787                 sc->mode.resolution = mode.resolution;
2788                 sc->mode.accelfactor = mode.accelfactor;
2789                 sc->mode.level = mode.level;
2790                 splx(s);
2791
2792                 unblock_mouse_data(sc, command_byte);
2793                 break;
2794
2795         case MOUSE_GETLEVEL:
2796                 *(int *)addr = sc->mode.level;
2797                 break;
2798
2799         case MOUSE_SETLEVEL:
2800                 if ((*(int *)addr < PSM_LEVEL_MIN) ||
2801                     (*(int *)addr > PSM_LEVEL_MAX))
2802                         return (EINVAL);
2803                 sc->mode.level = *(int *)addr;
2804                 break;
2805
2806         case MOUSE_GETSTATUS:
2807                 s = spltty();
2808                 status = sc->status;
2809                 sc->status.flags = 0;
2810                 sc->status.obutton = sc->status.button;
2811                 sc->status.button = 0;
2812                 sc->status.dx = 0;
2813                 sc->status.dy = 0;
2814                 sc->status.dz = 0;
2815                 splx(s);
2816                 *(mousestatus_t *)addr = status;
2817                 break;
2818
2819         case MOUSE_READSTATE:
2820         case MOUSE_READDATA:
2821                 data = (mousedata_t *)addr;
2822                 if (data->len > sizeof(data->buf)/sizeof(data->buf[0]))
2823                         return (EINVAL);
2824
2825                 error = block_mouse_data(sc, &command_byte);
2826                 if (error)
2827                         return (error);
2828                 if ((data->len = get_mouse_status(sc->kbdc, data->buf,
2829                     (cmd == MOUSE_READDATA) ? 1 : 0, data->len)) <= 0)
2830                         error = EIO;
2831                 unblock_mouse_data(sc, command_byte);
2832                 break;
2833
2834 #if (defined(MOUSE_SETRESOLUTION))
2835         case MOUSE_SETRESOLUTION:
2836                 mode.resolution = *(int *)addr;
2837                 if (mode.resolution >= UCHAR_MAX)
2838                         return (EINVAL);
2839                 else if (mode.resolution >= 200)
2840                         mode.resolution = MOUSE_RES_HIGH;
2841                 else if (mode.resolution >= 100)
2842                         mode.resolution = MOUSE_RES_MEDIUMHIGH;
2843                 else if (mode.resolution >= 50)
2844                         mode.resolution = MOUSE_RES_MEDIUMLOW;
2845                 else if (mode.resolution > 0)
2846                         mode.resolution = MOUSE_RES_LOW;
2847                 if (mode.resolution == MOUSE_RES_DEFAULT)
2848                         mode.resolution = sc->dflt_mode.resolution;
2849                 else if (mode.resolution == -1)
2850                         mode.resolution = sc->mode.resolution;
2851                 else if (mode.resolution < 0) /* MOUSE_RES_LOW/MEDIUM/HIGH */
2852                         mode.resolution = MOUSE_RES_LOW - mode.resolution;
2853
2854                 error = block_mouse_data(sc, &command_byte);
2855                 if (error)
2856                         return (error);
2857                 sc->mode.resolution =
2858                     set_mouse_resolution(sc->kbdc, mode.resolution);
2859                 if (sc->mode.resolution != mode.resolution)
2860                         error = EIO;
2861                 unblock_mouse_data(sc, command_byte);
2862                 break;
2863 #endif /* MOUSE_SETRESOLUTION */
2864
2865 #if (defined(MOUSE_SETRATE))
2866         case MOUSE_SETRATE:
2867                 mode.rate = *(int *)addr;
2868                 if (mode.rate > UCHAR_MAX)
2869                         return (EINVAL);
2870                 if (mode.rate == 0)
2871                         mode.rate = sc->dflt_mode.rate;
2872                 else if (mode.rate < 0)
2873                         mode.rate = sc->mode.rate;
2874
2875                 error = block_mouse_data(sc, &command_byte);
2876                 if (error)
2877                         return (error);
2878                 sc->mode.rate = set_mouse_sampling_rate(sc->kbdc, mode.rate);
2879                 if (sc->mode.rate != mode.rate)
2880                         error = EIO;
2881                 unblock_mouse_data(sc, command_byte);
2882                 break;
2883 #endif /* MOUSE_SETRATE */
2884
2885 #if (defined(MOUSE_SETSCALING))
2886         case MOUSE_SETSCALING:
2887                 if ((*(int *)addr <= 0) || (*(int *)addr > 2))
2888                         return (EINVAL);
2889
2890                 error = block_mouse_data(sc, &command_byte);
2891                 if (error)
2892                         return (error);
2893                 if (!set_mouse_scaling(sc->kbdc, *(int *)addr))
2894                         error = EIO;
2895                 unblock_mouse_data(sc, command_byte);
2896                 break;
2897 #endif /* MOUSE_SETSCALING */
2898
2899 #if (defined(MOUSE_GETHWID))
2900         case MOUSE_GETHWID:
2901                 error = block_mouse_data(sc, &command_byte);
2902                 if (error)
2903                         return (error);
2904                 sc->hw.hwid &= ~0x00ff;
2905                 sc->hw.hwid |= get_aux_id(sc->kbdc);
2906                 *(int *)addr = sc->hw.hwid & 0x00ff;
2907                 unblock_mouse_data(sc, command_byte);
2908                 break;
2909 #endif /* MOUSE_GETHWID */
2910
2911         case FIONBIO:
2912         case FIOASYNC:
2913                 break;
2914         case FIOSETOWN:
2915                 error = fsetown(*(int *)addr, &sc->async);
2916                 break;
2917         case FIOGETOWN:
2918                 *(int *) addr = fgetown(&sc->async);
2919                 break;
2920         default:
2921                 return (ENOTTY);
2922         }
2923
2924         return (error);
2925 }
2926
2927 static void
2928 psmtimeout(void *arg)
2929 {
2930         struct psm_softc *sc;
2931         int s;
2932
2933         sc = (struct psm_softc *)arg;
2934         s = spltty();
2935         if (sc->watchdog && kbdc_lock(sc->kbdc, TRUE)) {
2936                 VLOG(6, (LOG_DEBUG, "psm%d: lost interrupt?\n", sc->unit));
2937                 psmintr(sc);
2938                 kbdc_lock(sc->kbdc, FALSE);
2939         }
2940         sc->watchdog = TRUE;
2941         splx(s);
2942         callout_reset(&sc->callout, hz, psmtimeout, sc);
2943 }
2944
2945 /* Add all sysctls under the debug.psm and hw.psm nodes */
2946 static SYSCTL_NODE(_debug, OID_AUTO, psm, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
2947     "ps/2 mouse");
2948 static SYSCTL_NODE(_hw, OID_AUTO, psm, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
2949     "ps/2 mouse");
2950
2951 SYSCTL_INT(_debug_psm, OID_AUTO, loglevel, CTLFLAG_RWTUN, &verbose, 0,
2952     "Verbosity level");
2953
2954 static int psmhz = 20;
2955 SYSCTL_INT(_debug_psm, OID_AUTO, hz, CTLFLAG_RW, &psmhz, 0,
2956     "Frequency of the softcallout (in hz)");
2957 static int psmerrsecs = 2;
2958 SYSCTL_INT(_debug_psm, OID_AUTO, errsecs, CTLFLAG_RW, &psmerrsecs, 0,
2959     "Number of seconds during which packets will dropped after a sync error");
2960 static int psmerrusecs = 0;
2961 SYSCTL_INT(_debug_psm, OID_AUTO, errusecs, CTLFLAG_RW, &psmerrusecs, 0,
2962     "Microseconds to add to psmerrsecs");
2963 static int psmsecs = 0;
2964 SYSCTL_INT(_debug_psm, OID_AUTO, secs, CTLFLAG_RW, &psmsecs, 0,
2965     "Max number of seconds between soft interrupts");
2966 static int psmusecs = 500000;
2967 SYSCTL_INT(_debug_psm, OID_AUTO, usecs, CTLFLAG_RW, &psmusecs, 0,
2968     "Microseconds to add to psmsecs");
2969 static int pkterrthresh = 2;
2970 SYSCTL_INT(_debug_psm, OID_AUTO, pkterrthresh, CTLFLAG_RW, &pkterrthresh, 0,
2971     "Number of error packets allowed before reinitializing the mouse");
2972
2973 SYSCTL_INT(_hw_psm, OID_AUTO, tap_enabled, CTLFLAG_RWTUN, &tap_enabled, 0,
2974     "Enable tap and drag gestures");
2975 static int tap_threshold = PSM_TAP_THRESHOLD;
2976 SYSCTL_INT(_hw_psm, OID_AUTO, tap_threshold, CTLFLAG_RW, &tap_threshold, 0,
2977     "Button tap threshold");
2978 static int tap_timeout = PSM_TAP_TIMEOUT;
2979 SYSCTL_INT(_hw_psm, OID_AUTO, tap_timeout, CTLFLAG_RW, &tap_timeout, 0,
2980     "Tap timeout for touchpads");
2981
2982 /* Tunables */
2983 SYSCTL_INT(_hw_psm, OID_AUTO, synaptics_support, CTLFLAG_RDTUN,
2984     &synaptics_support, 0, "Enable support for Synaptics touchpads");
2985
2986 SYSCTL_INT(_hw_psm, OID_AUTO, trackpoint_support, CTLFLAG_RDTUN,
2987     &trackpoint_support, 0, "Enable support for IBM/Lenovo TrackPoint");
2988
2989 SYSCTL_INT(_hw_psm, OID_AUTO, elantech_support, CTLFLAG_RDTUN,
2990     &elantech_support, 0, "Enable support for Elantech touchpads");
2991
2992 static void
2993 psmintr(void *arg)
2994 {
2995         struct psm_softc *sc = arg;
2996         struct timeval now;
2997         int c;
2998         packetbuf_t *pb;
2999
3000         if (aux_mux_is_enabled(sc->kbdc))
3001                 VLOG(2, (LOG_DEBUG, "psmintr: active multiplexing mode is not "
3002                     "supported!\n"));
3003
3004         /* read until there is nothing to read */
3005         while((c = read_aux_data_no_wait(sc->kbdc)) != -1) {
3006                 pb = &sc->pqueue[sc->pqueue_end];
3007
3008                 /* discard the byte if the device is not open */
3009                 if (!(sc->state & (PSM_OPEN | PSM_EV_OPEN_R | PSM_EV_OPEN_A)))
3010                         continue;
3011
3012                 getmicrouptime(&now);
3013                 if ((pb->inputbytes > 0) &&
3014                     timevalcmp(&now, &sc->inputtimeout, >)) {
3015                         VLOG(3, (LOG_DEBUG, "psmintr: delay too long; "
3016                             "resetting byte count\n"));
3017                         pb->inputbytes = 0;
3018                         sc->syncerrors = 0;
3019                         sc->pkterrors = 0;
3020                 }
3021                 sc->inputtimeout.tv_sec = PSM_INPUT_TIMEOUT / 1000000;
3022                 sc->inputtimeout.tv_usec = PSM_INPUT_TIMEOUT % 1000000;
3023                 timevaladd(&sc->inputtimeout, &now);
3024
3025                 pb->ipacket[pb->inputbytes++] = c;
3026
3027                 if (sc->mode.level == PSM_LEVEL_NATIVE) {
3028                         VLOG(4, (LOG_DEBUG, "psmintr: %02x\n", pb->ipacket[0]));
3029                         sc->syncerrors = 0;
3030                         sc->pkterrors = 0;
3031                         goto next;
3032                 } else {
3033                         if (pb->inputbytes < sc->mode.packetsize)
3034                                 continue;
3035
3036                         VLOG(4, (LOG_DEBUG,
3037                             "psmintr: %02x %02x %02x %02x %02x %02x\n",
3038                             pb->ipacket[0], pb->ipacket[1], pb->ipacket[2],
3039                             pb->ipacket[3], pb->ipacket[4], pb->ipacket[5]));
3040                 }
3041
3042                 c = pb->ipacket[0];
3043
3044                 if ((sc->flags & PSM_NEED_SYNCBITS) != 0) {
3045                         sc->mode.syncmask[1] = (c & sc->mode.syncmask[0]);
3046                         sc->flags &= ~PSM_NEED_SYNCBITS;
3047                         VLOG(2, (LOG_DEBUG,
3048                             "psmintr: Sync bytes now %04x,%04x\n",
3049                             sc->mode.syncmask[0], sc->mode.syncmask[1]));
3050                 } else if ((sc->config & PSM_CONFIG_NOCHECKSYNC) == 0 &&
3051                     (c & sc->mode.syncmask[0]) != sc->mode.syncmask[1]) {
3052                         VLOG(3, (LOG_DEBUG, "psmintr: out of sync "
3053                             "(%04x != %04x) %d cmds since last error.\n",
3054                             c & sc->mode.syncmask[0], sc->mode.syncmask[1],
3055                             sc->cmdcount - sc->lasterr));
3056                         sc->lasterr = sc->cmdcount;
3057                         /*
3058                          * The sync byte test is a weak measure of packet
3059                          * validity.  Conservatively discard any input yet
3060                          * to be seen by userland when we detect a sync
3061                          * error since there is a good chance some of
3062                          * the queued packets have undetected errors.
3063                          */
3064                         dropqueue(sc);
3065                         if (sc->syncerrors == 0)
3066                                 sc->pkterrors++;
3067                         ++sc->syncerrors;
3068                         sc->lastinputerr = now;
3069                         if (sc->syncerrors >= sc->mode.packetsize * 2 ||
3070                             sc->pkterrors >= pkterrthresh) {
3071                                 /*
3072                                  * If we've failed to find a single sync byte
3073                                  * in 2 packets worth of data, or we've seen
3074                                  * persistent packet errors during the
3075                                  * validation period, reinitialize the mouse
3076                                  * in hopes of returning it to the expected
3077                                  * mode.
3078                                  */
3079                                 VLOG(3, (LOG_DEBUG,
3080                                     "psmintr: reset the mouse.\n"));
3081                                 reinitialize(sc, TRUE);
3082                         } else if (sc->syncerrors == sc->mode.packetsize) {
3083                                 /*
3084                                  * Try a soft reset after searching for a sync
3085                                  * byte through a packet length of bytes.
3086                                  */
3087                                 VLOG(3, (LOG_DEBUG,
3088                                     "psmintr: re-enable the mouse.\n"));
3089                                 pb->inputbytes = 0;
3090                                 disable_aux_dev(sc->kbdc);
3091                                 enable_aux_dev(sc->kbdc);
3092                         } else {
3093                                 VLOG(3, (LOG_DEBUG,
3094                                     "psmintr: discard a byte (%d)\n",
3095                                     sc->syncerrors));
3096                                 pb->inputbytes--;
3097                                 bcopy(&pb->ipacket[1], &pb->ipacket[0],
3098                                     pb->inputbytes);
3099                         }
3100                         continue;
3101                 }
3102
3103                 /*
3104                  * We have what appears to be a valid packet.
3105                  * Reset the error counters.
3106                  */
3107                 sc->syncerrors = 0;
3108
3109                 /*
3110                  * Drop even good packets if they occur within a timeout
3111                  * period of a sync error.  This allows the detection of
3112                  * a change in the mouse's packet mode without exposing
3113                  * erratic mouse behavior to the user.  Some KVMs forget
3114                  * enhanced mouse modes during switch events.
3115                  */
3116                 if (!timeelapsed(&sc->lastinputerr, psmerrsecs, psmerrusecs,
3117                     &now)) {
3118                         pb->inputbytes = 0;
3119                         continue;
3120                 }
3121
3122                 /*
3123                  * Now that we're out of the validation period, reset
3124                  * the packet error count.
3125                  */
3126                 sc->pkterrors = 0;
3127
3128                 sc->cmdcount++;
3129 next:
3130                 if (++sc->pqueue_end >= PSM_PACKETQUEUE)
3131                         sc->pqueue_end = 0;
3132                 /*
3133                  * If we've filled the queue then call the softintr ourselves,
3134                  * otherwise schedule the interrupt for later.
3135                  */
3136                 if (!timeelapsed(&sc->lastsoftintr, psmsecs, psmusecs, &now) ||
3137                     (sc->pqueue_end == sc->pqueue_start)) {
3138                         if ((sc->state & PSM_SOFTARMED) != 0) {
3139                                 sc->state &= ~PSM_SOFTARMED;
3140                                 callout_stop(&sc->softcallout);
3141                         }
3142                         psmsoftintr(arg);
3143                 } else if ((sc->state & PSM_SOFTARMED) == 0) {
3144                         sc->state |= PSM_SOFTARMED;
3145                         callout_reset(&sc->softcallout,
3146                             psmhz < 1 ? 1 : (hz/psmhz), psmsoftintr, arg);
3147                 }
3148         }
3149 }
3150
3151 static void
3152 proc_mmanplus(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
3153     int *x, int *y, int *z)
3154 {
3155
3156         /*
3157          * PS2++ protocol packet
3158          *
3159          *          b7 b6 b5 b4 b3 b2 b1 b0
3160          * byte 1:  *  1  p3 p2 1  *  *  *
3161          * byte 2:  c1 c2 p1 p0 d1 d0 1  0
3162          *
3163          * p3-p0: packet type
3164          * c1, c2: c1 & c2 == 1, if p2 == 0
3165          *         c1 & c2 == 0, if p2 == 1
3166          *
3167          * packet type: 0 (device type)
3168          * See comments in enable_mmanplus() below.
3169          *
3170          * packet type: 1 (wheel data)
3171          *
3172          *          b7 b6 b5 b4 b3 b2 b1 b0
3173          * byte 3:  h  *  B5 B4 s  d2 d1 d0
3174          *
3175          * h: 1, if horizontal roller data
3176          *    0, if vertical roller data
3177          * B4, B5: button 4 and 5
3178          * s: sign bit
3179          * d2-d0: roller data
3180          *
3181          * packet type: 2 (reserved)
3182          */
3183         if (((pb->ipacket[0] & MOUSE_PS2PLUS_SYNCMASK) == MOUSE_PS2PLUS_SYNC) &&
3184             (abs(*x) > 191) && MOUSE_PS2PLUS_CHECKBITS(pb->ipacket)) {
3185                 /*
3186                  * the extended data packet encodes button
3187                  * and wheel events
3188                  */
3189                 switch (MOUSE_PS2PLUS_PACKET_TYPE(pb->ipacket)) {
3190                 case 1:
3191                         /* wheel data packet */
3192                         *x = *y = 0;
3193                         if (pb->ipacket[2] & 0x80) {
3194                                 /* XXX horizontal roller count - ignore it */
3195                                 ;
3196                         } else {
3197                                 /* vertical roller count */
3198                                 *z = (pb->ipacket[2] & MOUSE_PS2PLUS_ZNEG) ?
3199                                     (pb->ipacket[2] & 0x0f) - 16 :
3200                                     (pb->ipacket[2] & 0x0f);
3201                         }
3202                         ms->button |= (pb->ipacket[2] &
3203                             MOUSE_PS2PLUS_BUTTON4DOWN) ?
3204                             MOUSE_BUTTON4DOWN : 0;
3205                         ms->button |= (pb->ipacket[2] &
3206                             MOUSE_PS2PLUS_BUTTON5DOWN) ?
3207                             MOUSE_BUTTON5DOWN : 0;
3208                         break;
3209                 case 2:
3210                         /*
3211                          * this packet type is reserved by
3212                          * Logitech...
3213                          */
3214                         /*
3215                          * IBM ScrollPoint Mouse uses this
3216                          * packet type to encode both vertical
3217                          * and horizontal scroll movement.
3218                          */
3219                         *x = *y = 0;
3220                         /* horizontal count */
3221                         if (pb->ipacket[2] & 0x0f)
3222                                 *z = (pb->ipacket[2] & MOUSE_SPOINT_WNEG) ?
3223                                     -2 : 2;
3224                         /* vertical count */
3225                         if (pb->ipacket[2] & 0xf0)
3226                                 *z = (pb->ipacket[2] & MOUSE_SPOINT_ZNEG) ?
3227                                     -1 : 1;
3228                         break;
3229                 case 0:
3230                         /* device type packet - shouldn't happen */
3231                         /* FALLTHROUGH */
3232                 default:
3233                         *x = *y = 0;
3234                         ms->button = ms->obutton;
3235                         VLOG(1, (LOG_DEBUG, "psmintr: unknown PS2++ packet "
3236                             "type %d: 0x%02x 0x%02x 0x%02x\n",
3237                             MOUSE_PS2PLUS_PACKET_TYPE(pb->ipacket),
3238                             pb->ipacket[0], pb->ipacket[1], pb->ipacket[2]));
3239                         break;
3240                 }
3241         } else {
3242                 /* preserve button states */
3243                 ms->button |= ms->obutton & MOUSE_EXTBUTTONS;
3244         }
3245 }
3246
3247 static int
3248 proc_synaptics(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
3249     int *x, int *y, int *z)
3250 {
3251         static int touchpad_buttons;
3252         static int guest_buttons;
3253         static int ew_finger_count;
3254         static finger_t f[PSM_FINGERS];
3255         int w, id, nfingers, palm, ewcode, extended_buttons, clickpad_pressed;
3256
3257         extended_buttons = 0;
3258
3259         /* TouchPad PS/2 absolute mode message format with capFourButtons:
3260          *
3261          *  Bits:        7   6   5   4   3   2   1   0 (LSB)
3262          *  ------------------------------------------------
3263          *  ipacket[0]:  1   0  W3  W2   0  W1   R   L
3264          *  ipacket[1]: Yb  Ya  Y9  Y8  Xb  Xa  X9  X8
3265          *  ipacket[2]: Z7  Z6  Z5  Z4  Z3  Z2  Z1  Z0
3266          *  ipacket[3]:  1   1  Yc  Xc   0  W0 D^R U^L
3267          *  ipacket[4]: X7  X6  X5  X4  X3  X2  X1  X0
3268          *  ipacket[5]: Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0
3269          *
3270          * Legend:
3271          *  L: left physical mouse button
3272          *  R: right physical mouse button
3273          *  D: down button
3274          *  U: up button
3275          *  W: "wrist" value
3276          *  X: x position
3277          *  Y: y position
3278          *  Z: pressure
3279          *
3280          * Without capFourButtons but with nExtendeButtons and/or capMiddle
3281          *
3282          *  Bits:        7   6   5   4      3      2      1      0 (LSB)
3283          *  ------------------------------------------------------
3284          *  ipacket[3]:  1   1  Yc  Xc      0     W0    E^R    M^L
3285          *  ipacket[4]: X7  X6  X5  X4  X3|b7  X2|b5  X1|b3  X0|b1
3286          *  ipacket[5]: Y7  Y6  Y5  Y4  Y3|b8  Y2|b6  Y1|b4  Y0|b2
3287          *
3288          * Legend:
3289          *  M: Middle physical mouse button
3290          *  E: Extended mouse buttons reported instead of low bits of X and Y
3291          *  b1-b8: Extended mouse buttons
3292          *    Only ((nExtendedButtons + 1) >> 1) bits are used in packet
3293          *    4 and 5, for reading X and Y value they should be zeroed.
3294          *
3295          * Absolute reportable limits:    0 - 6143.
3296          * Typical bezel limits:       1472 - 5472.
3297          * Typical edge marings:       1632 - 5312.
3298          *
3299          * w = 3 Passthrough Packet
3300          *
3301          * Byte 2,5,6 == Byte 1,2,3 of "Guest"
3302          */
3303
3304         if (!synaptics_support)
3305                 return (0);
3306
3307         /* Sanity check for out of sync packets. */
3308         if ((pb->ipacket[0] & 0xc8) != 0x80 ||
3309             (pb->ipacket[3] & 0xc8) != 0xc0)
3310                 return (-1);
3311
3312         *x = *y = 0;
3313         ms->button = ms->obutton;
3314
3315         /*
3316          * Pressure value.
3317          * Interpretation:
3318          *   z = 0      No finger contact
3319          *   z = 10     Finger hovering near the pad
3320          *   z = 30     Very light finger contact
3321          *   z = 80     Normal finger contact
3322          *   z = 110    Very heavy finger contact
3323          *   z = 200    Finger lying flat on pad surface
3324          *   z = 255    Maximum reportable Z
3325          */
3326         *z = pb->ipacket[2];
3327
3328         /*
3329          * Finger width value
3330          * Interpretation:
3331          *   w = 0      Two finger on the pad (capMultiFinger needed)
3332          *   w = 1      Three or more fingers (capMultiFinger needed)
3333          *   w = 2      Pen (instead of finger) (capPen needed)
3334          *   w = 3      Reserved (passthrough?)
3335          *   w = 4-7    Finger of normal width (capPalmDetect needed)
3336          *   w = 8-14   Very wide finger or palm (capPalmDetect needed)
3337          *   w = 15     Maximum reportable width (capPalmDetect needed)
3338          */
3339         /* XXX Is checking capExtended enough? */
3340         if (sc->synhw.capExtended)
3341                 w = ((pb->ipacket[0] & 0x30) >> 2) |
3342                     ((pb->ipacket[0] & 0x04) >> 1) |
3343                     ((pb->ipacket[3] & 0x04) >> 2);
3344         else {
3345                 /* Assume a finger of regular width. */
3346                 w = 4;
3347         }
3348
3349         switch (w) {
3350         case 3:
3351                 /*
3352                  * Handle packets from the guest device. See:
3353                  * Synaptics PS/2 TouchPad Interfacing Guide, Section 5.1
3354                  */
3355                 if (sc->synhw.capPassthrough || sc->muxport != PSM_NOMUX) {
3356                         *x = ((pb->ipacket[1] & 0x10) ?
3357                             pb->ipacket[4] - 256 : pb->ipacket[4]);
3358                         *y = ((pb->ipacket[1] & 0x20) ?
3359                             pb->ipacket[5] - 256 : pb->ipacket[5]);
3360                         *z = 0;
3361
3362                         guest_buttons = 0;
3363                         if (pb->ipacket[1] & 0x01)
3364                                 guest_buttons |= MOUSE_BUTTON1DOWN;
3365                         if (pb->ipacket[1] & 0x04)
3366                                 guest_buttons |= MOUSE_BUTTON2DOWN;
3367                         if (pb->ipacket[1] & 0x02)
3368                                 guest_buttons |= MOUSE_BUTTON3DOWN;
3369 #ifdef EVDEV_SUPPORT
3370                         if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
3371                                 evdev_push_rel(sc->evdev_r, REL_X, *x);
3372                                 evdev_push_rel(sc->evdev_r, REL_Y, -*y);
3373                                 evdev_push_mouse_btn(sc->evdev_r,
3374                                     guest_buttons);
3375                                 evdev_sync(sc->evdev_r);
3376                         }
3377 #endif
3378                         ms->button = touchpad_buttons | guest_buttons |
3379                             sc->extended_buttons;
3380                 }
3381                 goto SYNAPTICS_END;
3382
3383         case 2:
3384                 /* Handle Extended W mode packets */
3385                 ewcode = (pb->ipacket[5] & 0xf0) >> 4;
3386 #if PSM_FINGERS > 1
3387                 switch (ewcode) {
3388                 case 1:
3389                         /* Secondary finger */
3390                         if (sc->synhw.capAdvancedGestures)
3391                                 f[1] = (finger_t) {
3392                                         .x = (((pb->ipacket[4] & 0x0f) << 8) |
3393                                             pb->ipacket[1]) << 1,
3394                                         .y = (((pb->ipacket[4] & 0xf0) << 4) |
3395                                             pb->ipacket[2]) << 1,
3396                                         .p = ((pb->ipacket[3] & 0x30) |
3397                                             (pb->ipacket[5] & 0x0f)) << 1,
3398                                         .w = PSM_FINGER_DEFAULT_W,
3399                                         .flags = PSM_FINGER_FUZZY,
3400                                 };
3401                         else if (sc->synhw.capReportsV)
3402                                 f[1] = (finger_t) {
3403                                         .x = (((pb->ipacket[4] & 0x0f) << 8) |
3404                                             (pb->ipacket[1] & 0xfe)) << 1,
3405                                         .y = (((pb->ipacket[4] & 0xf0) << 4) |
3406                                             (pb->ipacket[2] & 0xfe)) << 1,
3407                                         .p = ((pb->ipacket[3] & 0x30) |
3408                                             (pb->ipacket[5] & 0x0e)) << 1,
3409                                         .w = (((pb->ipacket[5] & 0x01) << 2) |
3410                                             ((pb->ipacket[2] & 0x01) << 1) |
3411                                             (pb->ipacket[1] & 0x01)) + 8,
3412                                         .flags = PSM_FINGER_FUZZY,
3413                                 };
3414                         break;
3415                 case 2:
3416                         ew_finger_count = pb->ipacket[1] & 0x0f;
3417                 default:
3418                         break;
3419                 }
3420 #endif
3421                 goto SYNAPTICS_END;
3422
3423         case 1:
3424                 if (sc->synhw.capReportsV && ew_finger_count > 3) {
3425                         nfingers = ew_finger_count;
3426                         break;
3427                 }
3428                 /* FALLTHROUGH */
3429         case 0:
3430                 nfingers = w + 2;
3431                 break;
3432
3433         default:
3434                 nfingers = 1;
3435         }
3436
3437         if (sc->syninfo.touchpad_off)
3438                 goto SYNAPTICS_END;
3439
3440         /* Button presses */
3441         touchpad_buttons = 0;
3442         if (pb->ipacket[0] & 0x01)
3443                 touchpad_buttons |= MOUSE_BUTTON1DOWN;
3444         if (pb->ipacket[0] & 0x02)
3445                 touchpad_buttons |= MOUSE_BUTTON3DOWN;
3446
3447         if (sc->synhw.capExtended && sc->synhw.capFourButtons) {
3448                 if ((pb->ipacket[3] ^ pb->ipacket[0]) & 0x01)
3449                         touchpad_buttons |= MOUSE_BUTTON4DOWN;
3450                 if ((pb->ipacket[3] ^ pb->ipacket[0]) & 0x02)
3451                         touchpad_buttons |= MOUSE_BUTTON5DOWN;
3452         } else if (sc->synhw.capExtended && sc->synhw.capMiddle &&
3453             !sc->synhw.capClickPad) {
3454                 /* Middle Button */
3455                 if ((pb->ipacket[0] ^ pb->ipacket[3]) & 0x01)
3456                         touchpad_buttons |= MOUSE_BUTTON2DOWN;
3457         } else if (sc->synhw.capExtended && (sc->synhw.nExtendedButtons > 0)) {
3458                 /* Extended Buttons */
3459                 if ((pb->ipacket[0] ^ pb->ipacket[3]) & 0x02) {
3460                         if (sc->syninfo.directional_scrolls) {
3461                                 if (pb->ipacket[4] & 0x01)
3462                                         extended_buttons |= MOUSE_BUTTON4DOWN;
3463                                 if (pb->ipacket[5] & 0x01)
3464                                         extended_buttons |= MOUSE_BUTTON5DOWN;
3465                                 if (pb->ipacket[4] & 0x02)
3466                                         extended_buttons |= MOUSE_BUTTON6DOWN;
3467                                 if (pb->ipacket[5] & 0x02)
3468                                         extended_buttons |= MOUSE_BUTTON7DOWN;
3469                         } else {
3470                                 if (pb->ipacket[4] & 0x01)
3471                                         extended_buttons |= MOUSE_BUTTON1DOWN;
3472                                 if (pb->ipacket[5] & 0x01)
3473                                         extended_buttons |= MOUSE_BUTTON3DOWN;
3474                                 if (pb->ipacket[4] & 0x02)
3475                                         extended_buttons |= MOUSE_BUTTON2DOWN;
3476                                 sc->extended_buttons = extended_buttons;
3477                         }
3478
3479                         /*
3480                          * Zero out bits used by extended buttons to avoid
3481                          * misinterpretation of the data absolute position.
3482                          *
3483                          * The bits represented by
3484                          *
3485                          *     (nExtendedButtons + 1) >> 1
3486                          *
3487                          * will be masked out in both bytes.
3488                          * The mask for n bits is computed with the formula
3489                          *
3490                          *     (1 << n) - 1
3491                          */
3492                         int maskedbits = 0;
3493                         int mask = 0;
3494                         maskedbits = (sc->synhw.nExtendedButtons + 1) >> 1;
3495                         mask = (1 << maskedbits) - 1;
3496 #ifdef EVDEV_SUPPORT
3497                         int i;
3498                         if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
3499                                 if (sc->synhw.capPassthrough) {
3500                                         evdev_push_mouse_btn(sc->evdev_r,
3501                                                 extended_buttons);
3502                                         evdev_sync(sc->evdev_r);
3503                                 }
3504                                 for (i = 0; i < maskedbits; i++) {
3505                                         evdev_push_key(sc->evdev_a,
3506                                             BTN_0 + i * 2,
3507                                             pb->ipacket[4] & (1 << i));
3508                                         evdev_push_key(sc->evdev_a,
3509                                             BTN_0 + i * 2 + 1,
3510                                             pb->ipacket[5] & (1 << i));
3511                                 }
3512                         }
3513 #endif
3514                         pb->ipacket[4] &= ~(mask);
3515                         pb->ipacket[5] &= ~(mask);
3516                 } else  if (!sc->syninfo.directional_scrolls &&
3517                     !sc->gesture.in_vscroll) {
3518                         /*
3519                          * Keep reporting MOUSE DOWN until we get a new packet
3520                          * indicating otherwise.
3521                          */
3522                         extended_buttons |= sc->extended_buttons;
3523                 }
3524         }
3525
3526         if (sc->synhw.capReportsV && nfingers > 1)
3527                 f[0] = (finger_t) {
3528                         .x = ((pb->ipacket[3] & 0x10) << 8) |
3529                             ((pb->ipacket[1] & 0x0f) << 8) |
3530                             (pb->ipacket[4] & 0xfd),
3531                         .y = ((pb->ipacket[3] & 0x20) << 7) |
3532                             ((pb->ipacket[1] & 0xf0) << 4) |
3533                             (pb->ipacket[5] & 0xfd),
3534                         .p = *z & 0xfe,
3535                         .w = (((pb->ipacket[2] & 0x01) << 2) |
3536                             (pb->ipacket[5] & 0x02) |
3537                             ((pb->ipacket[4] & 0x02) >> 1)) + 8,
3538                         .flags = PSM_FINGER_FUZZY,
3539                 };
3540         else
3541                 f[0] = (finger_t) {
3542                         .x = ((pb->ipacket[3] & 0x10) << 8) |
3543                             ((pb->ipacket[1] & 0x0f) << 8) |
3544                             pb->ipacket[4],
3545                         .y = ((pb->ipacket[3] & 0x20) << 7) |
3546                             ((pb->ipacket[1] & 0xf0) << 4) |
3547                             pb->ipacket[5],
3548                         .p = *z,
3549                         .w = w,
3550                         .flags = nfingers > 1 ? PSM_FINGER_FUZZY : 0,
3551                 };
3552
3553         /* Ignore hovering and unmeasurable touches */
3554         if (f[0].p < sc->syninfo.min_pressure || f[0].x < 2)
3555                 nfingers = 0;
3556
3557         /* Handle ClickPad */
3558         if (sc->synhw.capClickPad) {
3559                 clickpad_pressed = (pb->ipacket[0] ^ pb->ipacket[3]) & 0x01;
3560                 if (sc->synhw.forcePad) {
3561                         /*
3562                          * Forcepads erroneously report button click if there
3563                          * are 2 or more fingers on the touchpad breaking
3564                          * multifinger gestures. To workaround this start
3565                          * reporting a click only after 4 consecutive single
3566                          * touch packets has been received.
3567                          * Skip these packets in case more contacts appear.
3568                          */
3569                         switch (nfingers) {
3570                         case 0:
3571                                 sc->fpcount = 0;
3572                                 break;
3573                         case 1:
3574                                 if (clickpad_pressed && sc->fpcount < INT_MAX)
3575                                         ++sc->fpcount;
3576                                 /* FALLTHROUGH */
3577                         default:
3578                                 if (!clickpad_pressed)
3579                                         sc->fpcount = 0;
3580                                 if (sc->fpcount >= sc->syninfo.window_min)
3581                                         touchpad_buttons |= MOUSE_BUTTON1DOWN;
3582                         }
3583                 } else if (clickpad_pressed)
3584                         touchpad_buttons |= MOUSE_BUTTON1DOWN;
3585         }
3586
3587         for (id = 0; id < PSM_FINGERS; id++)
3588                 if (id >= nfingers)
3589                         PSM_FINGER_RESET(f[id]);
3590
3591 #ifdef EVDEV_SUPPORT
3592         if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
3593                 for (id = 0; id < PSM_FINGERS; id++) {
3594                         if (PSM_FINGER_IS_SET(f[id]))
3595                                 psm_push_mt_finger(sc, id, &f[id]);
3596                         else
3597                                 psm_release_mt_slot(sc->evdev_a, id);
3598                 }
3599                 evdev_push_key(sc->evdev_a, BTN_TOUCH, nfingers > 0);
3600                 evdev_push_nfingers(sc->evdev_a, nfingers);
3601                 if (nfingers > 0)
3602                         psm_push_st_finger(sc, &f[0]);
3603                 else
3604                         evdev_push_abs(sc->evdev_a, ABS_PRESSURE, 0);
3605                 evdev_push_mouse_btn(sc->evdev_a, touchpad_buttons);
3606                 if (sc->synhw.capExtended && sc->synhw.capFourButtons) {
3607                         evdev_push_key(sc->evdev_a, BTN_FORWARD,
3608                             touchpad_buttons & MOUSE_BUTTON4DOWN);
3609                         evdev_push_key(sc->evdev_a, BTN_BACK,
3610                             touchpad_buttons & MOUSE_BUTTON5DOWN);
3611                 }
3612                 evdev_sync(sc->evdev_a);
3613         }
3614 #endif
3615
3616         ms->button = touchpad_buttons;
3617
3618         palm = psmpalmdetect(sc, &f[0], nfingers);
3619
3620         /* Palm detection doesn't terminate the current action. */
3621         if (!palm)
3622                 psmgestures(sc, &f[0], nfingers, ms);
3623
3624         for (id = 0; id < PSM_FINGERS; id++)
3625                 psmsmoother(sc, &f[id], id, ms, x, y);
3626
3627         if (palm) {
3628                 *x = *y = *z = 0;
3629                 ms->button = ms->obutton;
3630                 return (0);
3631         }
3632
3633         ms->button |= extended_buttons | guest_buttons;
3634
3635 SYNAPTICS_END:
3636         /*
3637          * Use the extra buttons as a scrollwheel
3638          *
3639          * XXX X.Org uses the Z axis for vertical wheel only,
3640          * whereas moused(8) understands special values to differ
3641          * vertical and horizontal wheels.
3642          *
3643          * xf86-input-mouse needs therefore a small patch to
3644          * understand these special values. Without it, the
3645          * horizontal wheel acts as a vertical wheel in X.Org.
3646          *
3647          * That's why the horizontal wheel is disabled by
3648          * default for now.
3649          */
3650         if (ms->button & MOUSE_BUTTON4DOWN)
3651                 *z = -1;
3652         else if (ms->button & MOUSE_BUTTON5DOWN)
3653                 *z = 1;
3654         else if (ms->button & MOUSE_BUTTON6DOWN)
3655                 *z = -2;
3656         else if (ms->button & MOUSE_BUTTON7DOWN)
3657                 *z = 2;
3658         else
3659                 *z = 0;
3660         ms->button &= ~(MOUSE_BUTTON4DOWN | MOUSE_BUTTON5DOWN |
3661             MOUSE_BUTTON6DOWN | MOUSE_BUTTON7DOWN);
3662
3663         return (0);
3664 }
3665
3666 static int
3667 proc_synaptics_mux(struct psm_softc *sc, packetbuf_t *pb)
3668 {
3669         int butt;
3670
3671         /*
3672          * Convert 3-byte interleaved mixture of Synaptics and generic mouse
3673          * packets into plain 6-byte Synaptics packet protocol.
3674          * While in hidden multiplexing mode KBC does some editing of the
3675          * packet stream. It remembers the button bits from the last packet
3676          * received from each device, and replaces the button bits of every
3677          * packet with the logical OR of all devices’ most recent button bits.
3678          * This button crosstalk should be filtered out as Synaptics and
3679          * generic mouse encode middle button presses in a different way.
3680          */
3681         switch (pb->ipacket[0] & 0xc0) {
3682         case 0x80:      /* First 3 bytes of Synaptics packet */
3683                 bcopy(pb->ipacket, sc->muxsave, 3);
3684                 /* Compute middle mouse button supression timeout. */
3685                 sc->muxmidtimeout.tv_sec  = 0;
3686                 sc->muxmidtimeout.tv_usec = 50000;      /* ~2-3 ints */
3687                 timevaladd(&sc->muxmidtimeout, &sc->lastsoftintr);
3688                 return (1);
3689
3690         case 0xc0:      /* Second 3 bytes of Synaptics packet */
3691                 /* Join two 3-bytes absolute packets */
3692                 bcopy(pb->ipacket, pb->ipacket + 3, 3);
3693                 bcopy(sc->muxsave, pb->ipacket, 3);
3694                 /* Prefer trackpoint buttons over touchpad's */
3695                 pb->ipacket[0] &= ~(0x08 | sc->muxmsbuttons);
3696                 pb->ipacket[3] &= ~(0x08 | sc->muxmsbuttons);
3697                 butt = (pb->ipacket[3] & 0x03) << 2 | (pb->ipacket[0] & 0x03);
3698                 /* Add hysteresis to remove spurious middle button events */
3699                 if (butt != sc->muxtpbuttons && sc->fpcount < 1) {
3700                         pb->ipacket[0] &= 0xfc;
3701                         pb->ipacket[0] |= sc->muxtpbuttons & 0x03;
3702                         pb->ipacket[3] &= 0xfc;
3703                         pb->ipacket[3] |= sc->muxtpbuttons >> 2 & 0x03;
3704                         ++sc->fpcount;
3705                 } else {
3706                         sc->fpcount = 0;
3707                         sc->muxtpbuttons = butt;
3708                 }
3709                 /* Filter out impossible w induced by middle trackpoint btn */
3710                 if (sc->synhw.capExtended && !sc->synhw.capPassthrough &&
3711                     (pb->ipacket[0] & 0x34) == 0x04 &&
3712                     (pb->ipacket[3] & 0x04) == 0x04) {
3713                         pb->ipacket[0] &= 0xfb;
3714                         pb->ipacket[3] &= 0xfb;
3715                 }
3716                 sc->muxsave[0] &= 0x30;
3717                 break;
3718
3719         default:        /* Generic mouse (Trackpoint) packet */
3720                 /* Filter out middle button events induced by some w values */
3721                 if (sc->muxmsbuttons & 0x03 || pb->ipacket[0] & 0x03 ||
3722                     (timevalcmp(&sc->lastsoftintr, &sc->muxmidtimeout, <=) &&
3723                      (sc->muxsave[0] & 0x30 || sc->muxsave[2] > 8)))
3724                         pb->ipacket[0] &= 0xfb;
3725                 sc->muxmsbuttons = pb->ipacket[0] & 0x07;
3726                 /* Convert to Synaptics pass-through protocol */
3727                 pb->ipacket[4] = pb->ipacket[1];
3728                 pb->ipacket[5] = pb->ipacket[2];
3729                 pb->ipacket[1] = pb->ipacket[0];
3730                 pb->ipacket[2] = 0;
3731                 pb->ipacket[0] = 0x84 | (sc->muxtpbuttons & 0x03);
3732                 pb->ipacket[3] = 0xc4 | (sc->muxtpbuttons >> 2 & 0x03);
3733         }
3734
3735         VLOG(4, (LOG_DEBUG, "synaptics: %02x %02x %02x %02x %02x %02x\n",
3736             pb->ipacket[0], pb->ipacket[1], pb->ipacket[2],
3737             pb->ipacket[3], pb->ipacket[4], pb->ipacket[5]));
3738
3739         pb->inputbytes = MOUSE_SYNAPTICS_PACKETSIZE;
3740         return (0);
3741 }
3742
3743 static int
3744 psmpalmdetect(struct psm_softc *sc, finger_t *f, int nfingers)
3745 {
3746         if (!(
3747             ((sc->synhw.capMultiFinger || sc->synhw.capAdvancedGestures) &&
3748               !sc->synhw.capReportsV && nfingers > 1) ||
3749             (sc->synhw.capReportsV && nfingers > 2) ||
3750             (sc->synhw.capPalmDetect && f->w <= sc->syninfo.max_width) ||
3751             (!sc->synhw.capPalmDetect && f->p <= sc->syninfo.max_pressure) ||
3752             (sc->synhw.capPen && f->flags & PSM_FINGER_IS_PEN))) {
3753                 /*
3754                  * We consider the packet irrelevant for the current
3755                  * action when:
3756                  *  - the width isn't comprised in:
3757                  *    [1; max_width]
3758                  *  - the pressure isn't comprised in:
3759                  *    [min_pressure; max_pressure]
3760                  *  - pen aren't supported but PSM_FINGER_IS_PEN is set
3761                  */
3762                 VLOG(2, (LOG_DEBUG, "synaptics: palm detected! (%d)\n", f->w));
3763                 return (1);
3764         }
3765         return (0);
3766 }
3767
3768 static void
3769 psmgestures(struct psm_softc *sc, finger_t *fingers, int nfingers,
3770     mousestatus_t *ms)
3771 {
3772         smoother_t *smoother;
3773         gesture_t *gest;
3774         finger_t *f;
3775         int y_ok, center_button, center_x, right_button, right_x, i;
3776
3777         f = &fingers[0];
3778         smoother = &sc->smoother[0];
3779         gest = &sc->gesture;
3780
3781         /* Find first active finger. */
3782         if (nfingers > 0) {
3783                 for (i = 0; i < PSM_FINGERS; i++) {
3784                         if (PSM_FINGER_IS_SET(fingers[i])) {
3785                                 f = &fingers[i];
3786                                 smoother = &sc->smoother[i];
3787                                 break;
3788                         }
3789                 }
3790         }
3791
3792         /*
3793          * Check pressure to detect a real wanted action on the
3794          * touchpad.
3795          */
3796         if (f->p >= sc->syninfo.min_pressure) {
3797                 int x0, y0;
3798                 int dxp, dyp;
3799                 int start_x, start_y;
3800                 int queue_len;
3801                 int margin_top, margin_right, margin_bottom, margin_left;
3802                 int window_min, window_max;
3803                 int vscroll_hor_area, vscroll_ver_area;
3804                 int two_finger_scroll;
3805                 int max_x, max_y;
3806                 int three_finger_drag;
3807
3808                 /* Read sysctl. */
3809                 /* XXX Verify values? */
3810                 margin_top = sc->syninfo.margin_top;
3811                 margin_right = sc->syninfo.margin_right;
3812                 margin_bottom = sc->syninfo.margin_bottom;
3813                 margin_left = sc->syninfo.margin_left;
3814                 window_min = sc->syninfo.window_min;
3815                 window_max = sc->syninfo.window_max;
3816                 vscroll_hor_area = sc->syninfo.vscroll_hor_area;
3817                 vscroll_ver_area = sc->syninfo.vscroll_ver_area;
3818                 two_finger_scroll = sc->syninfo.two_finger_scroll;
3819                 max_x = sc->syninfo.max_x;
3820                 max_y = sc->syninfo.max_y;
3821                 three_finger_drag = sc->syninfo.three_finger_drag;
3822                 /* Read current absolute position. */
3823                 x0 = f->x;
3824                 y0 = f->y;
3825
3826                 /*
3827                  * Limit the coordinates to the specified margins because
3828                  * this area isn't very reliable.
3829                  */
3830                 if (x0 <= margin_left)
3831                         x0 = margin_left;
3832                 else if (x0 >= max_x - margin_right)
3833                         x0 = max_x - margin_right;
3834                 if (y0 <= margin_bottom)
3835                         y0 = margin_bottom;
3836                 else if (y0 >= max_y - margin_top)
3837                         y0 = max_y - margin_top;
3838
3839                 VLOG(3, (LOG_DEBUG, "synaptics: ipacket: [%d, %d], %d, %d\n",
3840                     x0, y0, f->p, f->w));
3841
3842                 /*
3843                  * If the action is just beginning, init the structure and
3844                  * compute tap timeout.
3845                  */
3846                 if (!(sc->flags & PSM_FLAGS_FINGERDOWN)) {
3847                         VLOG(3, (LOG_DEBUG, "synaptics: ----\n"));
3848
3849                         /* Initialize queue. */
3850                         gest->window_min = window_min;
3851
3852                         /* Reset pressure peak. */
3853                         gest->zmax = 0;
3854
3855                         /* Reset fingers count. */
3856                         gest->fingers_nb = 0;
3857
3858                         /* Reset virtual scrolling state. */
3859                         gest->in_vscroll = 0;
3860
3861                         /* Compute tap timeout. */
3862                         if (tap_enabled != 0) {
3863                                 gest->taptimeout = (struct timeval) {
3864                                         .tv_sec  = tap_timeout / 1000000,
3865                                         .tv_usec = tap_timeout % 1000000,
3866                                 };
3867                                 timevaladd(
3868                                     &gest->taptimeout, &sc->lastsoftintr);
3869                         } else
3870                                 timevalclear(&gest->taptimeout);
3871
3872                         sc->flags |= PSM_FLAGS_FINGERDOWN;
3873
3874                         /* Smoother has not been reset yet */
3875                         queue_len = 1;
3876                         start_x = x0;
3877                         start_y = y0;
3878                 } else {
3879                         queue_len = smoother->queue_len + 1;
3880                         start_x = smoother->start_x;
3881                         start_y = smoother->start_y;
3882                 }
3883
3884                 /* Process ClickPad softbuttons */
3885                 if (sc->synhw.capClickPad && ms->button & MOUSE_BUTTON1DOWN) {
3886                         y_ok = sc->syninfo.softbuttons_y >= 0 ?
3887                             start_y < sc->syninfo.softbuttons_y :
3888                             start_y > max_y + sc->syninfo.softbuttons_y;
3889
3890                         center_button = MOUSE_BUTTON2DOWN;
3891                         center_x = sc->syninfo.softbutton2_x;
3892                         right_button = MOUSE_BUTTON3DOWN;
3893                         right_x = sc->syninfo.softbutton3_x;
3894
3895                         if (center_x > 0 && right_x > 0 && center_x > right_x) {
3896                                 center_button = MOUSE_BUTTON3DOWN;
3897                                 center_x = sc->syninfo.softbutton3_x;
3898                                 right_button = MOUSE_BUTTON2DOWN;
3899                                 right_x = sc->syninfo.softbutton2_x;
3900                         }
3901
3902                         if (right_x > 0 && start_x > right_x && y_ok)
3903                                 ms->button = (ms->button &
3904                                     ~MOUSE_BUTTON1DOWN) | right_button;
3905                         else if (center_x > 0 && start_x > center_x && y_ok)
3906                                 ms->button = (ms->button &
3907                                     ~MOUSE_BUTTON1DOWN) | center_button;
3908                 }
3909
3910                 /* If in tap-hold or three fingers, add the recorded button. */
3911                 if (gest->in_taphold || (nfingers == 3 && three_finger_drag))
3912                         ms->button |= gest->tap_button;
3913
3914                 /*
3915                  * For tap, we keep the maximum number of fingers and the
3916                  * pressure peak. Also with multiple fingers, we increase
3917                  * the minimum window.
3918                  */
3919                 if (nfingers > 1)
3920                         gest->window_min = window_max;
3921                 gest->fingers_nb = imax(nfingers, gest->fingers_nb);
3922                 gest->zmax = imax(f->p, gest->zmax);
3923
3924                 /* Do we have enough packets to consider this a gesture? */
3925                 if (queue_len < gest->window_min)
3926                         return;
3927
3928                 dyp = -1;
3929                 dxp = -1;
3930
3931                 /* Is a scrolling action occurring? */
3932                 if (!gest->in_taphold && !ms->button &&
3933                     (!gest->in_vscroll || two_finger_scroll)) {
3934                         /*
3935                          * A scrolling action must not conflict with a tap
3936                          * action. Here are the conditions to consider a
3937                          * scrolling action:
3938                          *  - the action in a configurable area
3939                          *  - one of the following:
3940                          *     . the distance between the last packet and the
3941                          *       first should be above a configurable minimum
3942                          *     . tap timed out
3943                          */
3944                         dxp = abs(x0 - start_x);
3945                         dyp = abs(y0 - start_y);
3946
3947                         if (timevalcmp(&sc->lastsoftintr, &gest->taptimeout, >) ||
3948                             dxp >= sc->syninfo.vscroll_min_delta ||
3949                             dyp >= sc->syninfo.vscroll_min_delta) {
3950                                 /*
3951                                  * Handle two finger scrolling.
3952                                  * Note that we don't rely on fingers_nb
3953                                  * as that keeps the maximum number of fingers.
3954                                  */
3955                                 if (two_finger_scroll) {
3956                                         if (nfingers == 2) {
3957                                                 gest->in_vscroll +=
3958                                                     dyp ? 2 : 0;
3959                                                 gest->in_vscroll +=
3960                                                     dxp ? 1 : 0;
3961                                         }
3962                                 } else {
3963                                         /* Check for horizontal scrolling. */
3964                                         if ((vscroll_hor_area > 0 &&
3965                                             start_y <= vscroll_hor_area) ||
3966                                             (vscroll_hor_area < 0 &&
3967                                              start_y >=
3968                                              max_y + vscroll_hor_area))
3969                                                 gest->in_vscroll += 2;
3970
3971                                         /* Check for vertical scrolling. */
3972                                         if ((vscroll_ver_area > 0 &&
3973                                             start_x <= vscroll_ver_area) ||
3974                                             (vscroll_ver_area < 0 &&
3975                                              start_x >=
3976                                              max_x + vscroll_ver_area))
3977                                                 gest->in_vscroll += 1;
3978                                 }
3979
3980                                 /* Avoid conflicts if area overlaps. */
3981                                 if (gest->in_vscroll >= 3)
3982                                         gest->in_vscroll =
3983                                             (dxp > dyp) ? 2 : 1;
3984                         }
3985                 }
3986                 /*
3987                  * Reset two finger scrolling when the number of fingers
3988                  * is different from two or any button is pressed.
3989                  */
3990                 if (two_finger_scroll && gest->in_vscroll != 0 &&
3991                     (nfingers != 2 || ms->button))
3992                         gest->in_vscroll = 0;
3993
3994                 VLOG(5, (LOG_DEBUG,
3995                         "synaptics: virtual scrolling: %s "
3996                         "(direction=%d, dxp=%d, dyp=%d, fingers=%d)\n",
3997                         gest->in_vscroll ? "YES" : "NO",
3998                         gest->in_vscroll, dxp, dyp,
3999                         gest->fingers_nb));
4000
4001         } else if (sc->flags & PSM_FLAGS_FINGERDOWN) {
4002                 /*
4003                  * An action is currently taking place but the pressure
4004                  * dropped under the minimum, putting an end to it.
4005                  */
4006                 int taphold_timeout, dx, dy, tap_max_delta;
4007
4008                 dx = abs(smoother->queue[smoother->queue_cursor].x -
4009                     smoother->start_x);
4010                 dy = abs(smoother->queue[smoother->queue_cursor].y -
4011                     smoother->start_y);
4012
4013                 /* Max delta is disabled for multi-fingers tap. */
4014                 if (gest->fingers_nb > 1)
4015                         tap_max_delta = imax(dx, dy);
4016                 else
4017                         tap_max_delta = sc->syninfo.tap_max_delta;
4018
4019                 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
4020
4021                 /* Check for tap. */
4022                 VLOG(3, (LOG_DEBUG,
4023                     "synaptics: zmax=%d, dx=%d, dy=%d, "
4024                     "delta=%d, fingers=%d, queue=%d\n",
4025                     gest->zmax, dx, dy, tap_max_delta, gest->fingers_nb,
4026                     smoother->queue_len));
4027                 if (!gest->in_vscroll && gest->zmax >= tap_threshold &&
4028                     timevalcmp(&sc->lastsoftintr, &gest->taptimeout, <=) &&
4029                     dx <= tap_max_delta && dy <= tap_max_delta &&
4030                     smoother->queue_len >= sc->syninfo.tap_min_queue) {
4031                         /*
4032                          * We have a tap if:
4033                          *   - the maximum pressure went over tap_threshold
4034                          *   - the action ended before tap_timeout
4035                          *
4036                          * To handle tap-hold, we must delay any button push to
4037                          * the next action.
4038                          */
4039                         if (gest->in_taphold) {
4040                                 /*
4041                                  * This is the second and last tap of a
4042                                  * double tap action, not a tap-hold.
4043                                  */
4044                                 gest->in_taphold = 0;
4045
4046                                 /*
4047                                  * For double-tap to work:
4048                                  *   - no button press is emitted (to
4049                                  *     simulate a button release)
4050                                  *   - PSM_FLAGS_FINGERDOWN is set to
4051                                  *     force the next packet to emit a
4052                                  *     button press)
4053                                  */
4054                                 VLOG(2, (LOG_DEBUG,
4055                                     "synaptics: button RELEASE: %d\n",
4056                                     gest->tap_button));
4057                                 sc->flags |= PSM_FLAGS_FINGERDOWN;
4058
4059                                 /* Schedule button press on next interrupt */
4060                                 sc->idletimeout.tv_sec  = psmhz > 1 ?
4061                                     0 : 1;
4062                                 sc->idletimeout.tv_usec = psmhz > 1 ?
4063                                     1000000 / psmhz : 0;
4064                         } else {
4065                                 /*
4066                                  * This is the first tap: we set the
4067                                  * tap-hold state and notify the button
4068                                  * down event.
4069                                  */
4070                                 gest->in_taphold = 1;
4071                                 taphold_timeout = sc->syninfo.taphold_timeout;
4072                                 gest->taptimeout.tv_sec  = taphold_timeout /
4073                                     1000000;
4074                                 gest->taptimeout.tv_usec = taphold_timeout %
4075                                     1000000;
4076                                 sc->idletimeout = gest->taptimeout;
4077                                 timevaladd(&gest->taptimeout,
4078                                     &sc->lastsoftintr);
4079
4080                                 switch (gest->fingers_nb) {
4081                                 case 3:
4082                                         gest->tap_button =
4083                                             MOUSE_BUTTON2DOWN;
4084                                         break;
4085                                 case 2:
4086                                         gest->tap_button =
4087                                             MOUSE_BUTTON3DOWN;
4088                                         break;
4089                                 default:
4090                                         gest->tap_button =
4091                                             MOUSE_BUTTON1DOWN;
4092                                 }
4093                                 VLOG(2, (LOG_DEBUG,
4094                                     "synaptics: button PRESS: %d\n",
4095                                     gest->tap_button));
4096                                 ms->button |= gest->tap_button;
4097                         }
4098                 } else {
4099                         /*
4100                          * Not enough pressure or timeout: reset
4101                          * tap-hold state.
4102                          */
4103                         if (gest->in_taphold) {
4104                                 VLOG(2, (LOG_DEBUG,
4105                                     "synaptics: button RELEASE: %d\n",
4106                                     gest->tap_button));
4107                                 gest->in_taphold = 0;
4108                         } else {
4109                                 VLOG(2, (LOG_DEBUG,
4110                                     "synaptics: not a tap-hold\n"));
4111                         }
4112                 }
4113         } else if (!(sc->flags & PSM_FLAGS_FINGERDOWN) && gest->in_taphold) {
4114                 /*
4115                  * For a tap-hold to work, the button must remain down at
4116                  * least until timeout (where the in_taphold flags will be
4117                  * cleared) or during the next action.
4118                  */
4119                 if (timevalcmp(&sc->lastsoftintr, &gest->taptimeout, <=)) {
4120                         ms->button |= gest->tap_button;
4121                 } else {
4122                         VLOG(2, (LOG_DEBUG, "synaptics: button RELEASE: %d\n",
4123                             gest->tap_button));
4124                         gest->in_taphold = 0;
4125                 }
4126         }
4127
4128         return;
4129 }
4130
4131 static void
4132 psmsmoother(struct psm_softc *sc, finger_t *f, int smoother_id,
4133     mousestatus_t *ms, int *x, int *y)
4134 {
4135         smoother_t *smoother = &sc->smoother[smoother_id];
4136         gesture_t *gest = &(sc->gesture);
4137
4138         /*
4139          * Check pressure to detect a real wanted action on the
4140          * touchpad.
4141          */
4142         if (f->p >= sc->syninfo.min_pressure) {
4143                 int x0, y0;
4144                 int cursor, peer, window;
4145                 int dx, dy, dxp, dyp;
4146                 int max_width, max_pressure;
4147                 int margin_top, margin_right, margin_bottom, margin_left;
4148                 int na_top, na_right, na_bottom, na_left;
4149                 int window_min, window_max;
4150                 int multiplicator;
4151                 int weight_current, weight_previous, weight_len_squared;
4152                 int div_min, div_max, div_len;
4153                 int vscroll_hor_area, vscroll_ver_area;
4154                 int two_finger_scroll;
4155                 int max_x, max_y;
4156                 int len, weight_prev_x, weight_prev_y;
4157                 int div_max_x, div_max_y, div_x, div_y;
4158                 int is_fuzzy;
4159                 int natural_scroll;
4160
4161                 /* Read sysctl. */
4162                 /* XXX Verify values? */
4163                 max_width = sc->syninfo.max_width;
4164                 max_pressure = sc->syninfo.max_pressure;
4165                 margin_top = sc->syninfo.margin_top;
4166                 margin_right = sc->syninfo.margin_right;
4167                 margin_bottom = sc->syninfo.margin_bottom;
4168                 margin_left = sc->syninfo.margin_left;
4169                 na_top = sc->syninfo.na_top;
4170                 na_right = sc->syninfo.na_right;
4171                 na_bottom = sc->syninfo.na_bottom;
4172                 na_left = sc->syninfo.na_left;
4173                 window_min = sc->syninfo.window_min;
4174                 window_max = sc->syninfo.window_max;
4175                 multiplicator = sc->syninfo.multiplicator;
4176                 weight_current = sc->syninfo.weight_current;
4177                 weight_previous = sc->syninfo.weight_previous;
4178                 weight_len_squared = sc->syninfo.weight_len_squared;
4179                 div_min = sc->syninfo.div_min;
4180                 div_max = sc->syninfo.div_max;
4181                 div_len = sc->syninfo.div_len;
4182                 vscroll_hor_area = sc->syninfo.vscroll_hor_area;
4183                 vscroll_ver_area = sc->syninfo.vscroll_ver_area;
4184                 two_finger_scroll = sc->syninfo.two_finger_scroll;
4185                 max_x = sc->syninfo.max_x;
4186                 max_y = sc->syninfo.max_y;
4187                 natural_scroll = sc->syninfo.natural_scroll;
4188
4189                 is_fuzzy = (f->flags & PSM_FINGER_FUZZY) != 0;
4190
4191                 /* Read current absolute position. */
4192                 x0 = f->x;
4193                 y0 = f->y;
4194
4195                 /*
4196                  * Limit the coordinates to the specified margins because
4197                  * this area isn't very reliable.
4198                  */
4199                 if (x0 <= margin_left)
4200                         x0 = margin_left;
4201                 else if (x0 >= max_x - margin_right)
4202                         x0 = max_x - margin_right;
4203                 if (y0 <= margin_bottom)
4204                         y0 = margin_bottom;
4205                 else if (y0 >= max_y - margin_top)
4206                         y0 = max_y - margin_top;
4207
4208                 /* If the action is just beginning, init the structure. */
4209                 if (smoother->active == 0) {
4210                         VLOG(3, (LOG_DEBUG, "smoother%d: ---\n", smoother_id));
4211
4212                         /* Store the first point of this action. */
4213                         smoother->start_x = x0;
4214                         smoother->start_y = y0;
4215                         dx = dy = 0;
4216
4217                         /* Initialize queue. */
4218                         smoother->queue_cursor = SYNAPTICS_PACKETQUEUE;
4219                         smoother->queue_len = 0;
4220
4221                         /* Reset average. */
4222                         smoother->avg_dx = 0;
4223                         smoother->avg_dy = 0;
4224
4225                         /* Reset squelch. */
4226                         smoother->squelch_x = 0;
4227                         smoother->squelch_y = 0;
4228
4229                         /* Activate queue */
4230                         smoother->active = 1;
4231                 } else {
4232                         /* Calculate the current delta. */
4233                         cursor = smoother->queue_cursor;
4234                         dx = x0 - smoother->queue[cursor].x;
4235                         dy = y0 - smoother->queue[cursor].y;
4236                 }
4237
4238                 VLOG(3, (LOG_DEBUG, "smoother%d: ipacket: [%d, %d], %d, %d\n",
4239                     smoother_id, x0, y0, f->p, f->w));
4240
4241                 /* Queue this new packet. */
4242                 cursor = SYNAPTICS_QUEUE_CURSOR(smoother->queue_cursor - 1);
4243                 smoother->queue[cursor].x = x0;
4244                 smoother->queue[cursor].y = y0;
4245                 smoother->queue_cursor = cursor;
4246                 if (smoother->queue_len < SYNAPTICS_PACKETQUEUE)
4247                         smoother->queue_len++;
4248                 VLOG(5, (LOG_DEBUG,
4249                     "smoother%d: cursor[%d]: x=%d, y=%d, dx=%d, dy=%d\n",
4250                     smoother_id, cursor, x0, y0, dx, dy));
4251
4252                 /* Do we have enough packets to consider this a movement? */
4253                 if (smoother->queue_len < gest->window_min)
4254                         return;
4255
4256                 weight_prev_x = weight_prev_y = weight_previous;
4257                 div_max_x = div_max_y = div_max;
4258
4259                 if (gest->in_vscroll) {
4260                         /* Dividers are different with virtual scrolling. */
4261                         div_min = sc->syninfo.vscroll_div_min;
4262                         div_max_x = div_max_y = sc->syninfo.vscroll_div_max;
4263                 } else {
4264                         /*
4265                          * There's a lot of noise in coordinates when
4266                          * the finger is on the touchpad's borders. When
4267                          * using this area, we apply a special weight and
4268                          * div.
4269                          */
4270                         if (x0 <= na_left || x0 >= max_x - na_right) {
4271                                 weight_prev_x = sc->syninfo.weight_previous_na;
4272                                 div_max_x = sc->syninfo.div_max_na;
4273                         }
4274
4275                         if (y0 <= na_bottom || y0 >= max_y - na_top) {
4276                                 weight_prev_y = sc->syninfo.weight_previous_na;
4277                                 div_max_y = sc->syninfo.div_max_na;
4278                         }
4279                 }
4280
4281                 /*
4282                  * Calculate weights for the average operands and
4283                  * the divisor. Both depend on the distance between
4284                  * the current packet and a previous one (based on the
4285                  * window width).
4286                  */
4287                 window = imin(smoother->queue_len, window_max);
4288                 peer = SYNAPTICS_QUEUE_CURSOR(cursor + window - 1);
4289                 dxp = abs(x0 - smoother->queue[peer].x) + 1;
4290                 dyp = abs(y0 - smoother->queue[peer].y) + 1;
4291                 len = (dxp * dxp) + (dyp * dyp);
4292                 weight_prev_x = imin(weight_prev_x,
4293                     weight_len_squared * weight_prev_x / len);
4294                 weight_prev_y = imin(weight_prev_y,
4295                     weight_len_squared * weight_prev_y / len);
4296
4297                 len = (dxp + dyp) / 2;
4298                 div_x = div_len * div_max_x / len;
4299                 div_x = imin(div_max_x, div_x);
4300                 div_x = imax(div_min, div_x);
4301                 div_y = div_len * div_max_y / len;
4302                 div_y = imin(div_max_y, div_y);
4303                 div_y = imax(div_min, div_y);
4304
4305                 VLOG(3, (LOG_DEBUG,
4306                     "smoother%d: peer=%d, len=%d, weight=%d/%d, div=%d/%d\n",
4307                     smoother_id, peer, len, weight_prev_x, weight_prev_y,
4308                     div_x, div_y));
4309
4310                 /* Compute averages. */
4311                 smoother->avg_dx =
4312                     (weight_current * dx * multiplicator +
4313                      weight_prev_x * smoother->avg_dx) /
4314                     (weight_current + weight_prev_x);
4315
4316                 smoother->avg_dy =
4317                     (weight_current * dy * multiplicator +
4318                      weight_prev_y * smoother->avg_dy) /
4319                     (weight_current + weight_prev_y);
4320
4321                 VLOG(5, (LOG_DEBUG,
4322                     "smoother%d: avg_dx~=%d, avg_dy~=%d\n", smoother_id,
4323                     smoother->avg_dx / multiplicator,
4324                     smoother->avg_dy / multiplicator));
4325
4326                 /* Use these averages to calculate x & y. */
4327                 smoother->squelch_x += smoother->avg_dx;
4328                 dxp = smoother->squelch_x / (div_x * multiplicator);
4329                 smoother->squelch_x = smoother->squelch_x %
4330                     (div_x * multiplicator);
4331
4332                 smoother->squelch_y += smoother->avg_dy;
4333                 dyp = smoother->squelch_y / (div_y * multiplicator);
4334                 smoother->squelch_y = smoother->squelch_y %
4335                     (div_y * multiplicator);
4336
4337                 switch(gest->in_vscroll) {
4338                 case 0: /* Pointer movement. */
4339                         /* On real<->fuzzy finger switch the x/y pos jumps */
4340                         if (is_fuzzy == smoother->is_fuzzy) {
4341                                 *x += dxp;
4342                                 *y += dyp;
4343                         }
4344
4345                         VLOG(3, (LOG_DEBUG, "smoother%d: [%d, %d] -> [%d, %d]\n",
4346                             smoother_id, dx, dy, dxp, dyp));
4347                         break;
4348                 case 1: /* Vertical scrolling. */
4349                         if (dyp != 0) {
4350                                 if (two_finger_scroll && natural_scroll)
4351                                         ms->button |= (dyp > 0) ?
4352                                             MOUSE_BUTTON5DOWN : MOUSE_BUTTON4DOWN;
4353                                 else
4354                                         ms->button |= (dyp > 0) ?
4355                                             MOUSE_BUTTON4DOWN : MOUSE_BUTTON5DOWN;
4356                         }
4357                         break;
4358                 case 2: /* Horizontal scrolling. */
4359                         if (dxp != 0) {
4360                                 if (two_finger_scroll && natural_scroll)
4361                                         ms->button |= (dxp > 0) ?
4362                                             MOUSE_BUTTON6DOWN : MOUSE_BUTTON7DOWN;
4363                                 else
4364                                         ms->button |= (dxp > 0) ?
4365                                             MOUSE_BUTTON7DOWN : MOUSE_BUTTON6DOWN;
4366                         }
4367                         break;
4368                 }
4369
4370                 smoother->is_fuzzy = is_fuzzy;
4371
4372         } else {
4373                 /*
4374                  * Deactivate queue. Note: We can not just reset queue here
4375                  * as these values are still used by gesture processor.
4376                  * So postpone reset till next touch.
4377                  */
4378                 smoother->active = 0;
4379         }
4380 }
4381
4382 static int
4383 proc_elantech(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
4384     int *x, int *y, int *z)
4385 {
4386         static int touchpad_button, trackpoint_button;
4387         finger_t fn, f[ELANTECH_MAX_FINGERS];
4388         int pkt, id, scale, i, nfingers, mask, palm;
4389
4390         if (!elantech_support)
4391                 return (0);
4392
4393         /* Determine packet format and do a sanity check for out of sync packets. */
4394         if (ELANTECH_PKT_IS_DEBOUNCE(pb, sc->elanhw.hwversion))
4395                 pkt = ELANTECH_PKT_NOP;
4396         else if (sc->elanhw.hastrackpoint && ELANTECH_PKT_IS_TRACKPOINT(pb))
4397                 pkt = ELANTECH_PKT_TRACKPOINT;
4398         else
4399         switch (sc->elanhw.hwversion) {
4400         case 2:
4401                 if (!ELANTECH_PKT_IS_V2(pb))
4402                         return (-1);
4403
4404                 pkt = (pb->ipacket[0] & 0xc0) == 0x80 ?
4405                     ELANTECH_PKT_V2_2FINGER : ELANTECH_PKT_V2_COMMON;
4406                 break;
4407         case 3:
4408                 if (!ELANTECH_PKT_IS_V3_HEAD(pb, sc->elanhw.hascrc) &&
4409                     !ELANTECH_PKT_IS_V3_TAIL(pb, sc->elanhw.hascrc))
4410                         return (-1);
4411
4412                 pkt = ELANTECH_PKT_V3;
4413                 break;
4414         case 4:
4415                 if (!ELANTECH_PKT_IS_V4(pb, sc->elanhw.hascrc))
4416                         return (-1);
4417
4418                 switch (pb->ipacket[3] & 0x03) {
4419                 case 0x00:
4420                         pkt = ELANTECH_PKT_V4_STATUS;
4421                         break;
4422                 case 0x01:
4423                         pkt = ELANTECH_PKT_V4_HEAD;
4424                         break;
4425                 case 0x02:
4426                         pkt = ELANTECH_PKT_V4_MOTION;
4427                         break;
4428                 default:
4429                         return (-1);
4430                 }
4431                 break;
4432         default:
4433                 return (-1);
4434         }
4435
4436         VLOG(5, (LOG_DEBUG, "elantech: ipacket format: %d\n", pkt));
4437
4438         for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
4439                 PSM_FINGER_RESET(f[id]);
4440
4441         *x = *y = *z = 0;
4442         ms->button = ms->obutton;
4443
4444         if (sc->syninfo.touchpad_off)
4445                 return (0);
4446
4447         /* Common legend
4448          * L: Left mouse button pressed
4449          * R: Right mouse button pressed
4450          * N: number of fingers on touchpad
4451          * X: absolute x value (horizontal)
4452          * Y: absolute y value (vertical)
4453          * W; width of the finger touch
4454          * P: pressure
4455          */
4456         switch (pkt) {
4457         case ELANTECH_PKT_V2_COMMON:    /* HW V2. One/Three finger touch */
4458                 /*               7   6   5   4   3   2   1   0 (LSB)
4459                  * -------------------------------------------
4460                  * ipacket[0]:  N1  N0  W3  W2   .   .   R   L
4461                  * ipacket[1]:  P7  P6  P5  P4 X11 X10  X9  X8
4462                  * ipacket[2]:  X7  X6  X5  X4  X3  X2  X1  X0
4463                  * ipacket[3]:  N4  VF  W1  W0   .   .   .  B2
4464                  * ipacket[4]:  P3  P1  P2  P0 Y11 Y10  Y9  Y8
4465                  * ipacket[5]:  Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0
4466                  * -------------------------------------------
4467                  * N4: set if more than 3 fingers (only in 3 fingers mode)
4468                  * VF: a kind of flag? (only on EF123, 0 when finger
4469                  *     is over one of the buttons, 1 otherwise)
4470                  * B2: (on EF113 only, 0 otherwise), one button pressed
4471                  * P & W is not reported on EF113 touchpads
4472                  */
4473                 nfingers = (pb->ipacket[0] & 0xc0) >> 6;
4474                 if (nfingers == 3 && (pb->ipacket[3] & 0x80))
4475                         nfingers = 4;
4476
4477                 if (nfingers == 0) {
4478                         mask = (1 << nfingers) - 1;     /* = 0x00 */
4479                         break;
4480                 }
4481
4482                 /* Map 3-rd and 4-th fingers to first finger */
4483                 mask = (1 << 1) - 1;    /* = 0x01 */
4484                 f[0] = ELANTECH_FINGER_SET_XYP(pb);
4485                 if (sc->elanhw.haspressure) {
4486                         f[0].w = ((pb->ipacket[0] & 0x30) >> 2) |
4487                             ((pb->ipacket[3] & 0x30) >> 4);
4488                 } else {
4489                         f[0].p = PSM_FINGER_DEFAULT_P;
4490                         f[0].w = PSM_FINGER_DEFAULT_W;
4491                 }
4492
4493                 /*
4494                  * HW v2 dont report exact finger positions when 3 or more
4495                  * fingers are on touchpad.
4496                  */
4497                 if (nfingers > 2)
4498                         f[0].flags = PSM_FINGER_FUZZY;
4499
4500                 break;
4501
4502         case ELANTECH_PKT_V2_2FINGER:   /*HW V2. Two finger touch */
4503                 /*               7   6   5   4   3   2   1   0 (LSB)
4504                  * -------------------------------------------
4505                  * ipacket[0]:  N1  N0 AY8 AX8   .   .   R   L
4506                  * ipacket[1]: AX7 AX6 AX5 AX4 AX3 AX2 AX1 AX0
4507                  * ipacket[2]: AY7 AY6 AY5 AY4 AY3 AY2 AY1 AY0
4508                  * ipacket[3]:   .   . BY8 BX8   .   .   .   .
4509                  * ipacket[4]: BX7 BX6 BX5 BX4 BX3 BX2 BX1 BX0
4510                  * ipacket[5]: BY7 BY6 BY5 BY4 BY3 BY2 BY1 BY0
4511                  * -------------------------------------------
4512                  * AX: lower-left finger absolute x value
4513                  * AY: lower-left finger absolute y value
4514                  * BX: upper-right finger absolute x value
4515                  * BY: upper-right finger absolute y value
4516                  */
4517                 nfingers = 2;
4518                 mask = (1 << nfingers) - 1;
4519
4520                 for (id = 0; id < imin(2, ELANTECH_MAX_FINGERS); id ++)
4521                         f[id] = (finger_t) {
4522                                 .x = (((pb->ipacket[id * 3] & 0x10) << 4) |
4523                                     pb->ipacket[id * 3 + 1]) << 2,
4524                                 .y = (((pb->ipacket[id * 3] & 0x20) << 3) |
4525                                     pb->ipacket[id * 3 + 2]) << 2,
4526                                 .p = PSM_FINGER_DEFAULT_P,
4527                                 .w = PSM_FINGER_DEFAULT_W,
4528                                 /* HW ver.2 sends bounding box */
4529                                 .flags = PSM_FINGER_FUZZY
4530                         };
4531                 break;
4532
4533         case ELANTECH_PKT_V3:   /* HW Version 3 */
4534                 /*               7   6   5   4   3   2   1   0 (LSB)
4535                  * -------------------------------------------
4536                  * ipacket[0]:  N1  N0  W3  W2   0   1   R   L
4537                  * ipacket[1]:  P7  P6  P5  P4 X11 X10  X9  X8
4538                  * ipacket[2]:  X7  X6  X5  X4  X3  X2  X1  X0
4539                  * ipacket[3]:   0   0  W1  W0   0   0   1   0
4540                  * ipacket[4]:  P3  P1  P2  P0 Y11 Y10  Y9  Y8
4541                  * ipacket[5]:  Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0
4542                  * -------------------------------------------
4543                  */
4544                 nfingers = (pb->ipacket[0] & 0xc0) >> 6;
4545                 /* Map 3-rd finger to first finger */
4546                 id = nfingers > 2 ? 0 : nfingers - 1;
4547                 mask = (1 << (id + 1)) - 1;
4548
4549                 if (nfingers == 0)
4550                         break;
4551
4552                 fn = ELANTECH_FINGER_SET_XYP(pb);
4553                 fn.w = ((pb->ipacket[0] & 0x30) >> 2) |
4554                     ((pb->ipacket[3] & 0x30) >> 4);
4555
4556                 /*
4557                  * HW v3 dont report exact finger positions when 3 or more
4558                  * fingers are on touchpad.
4559                  */
4560                 if (nfingers > 1)
4561                         fn.flags = PSM_FINGER_FUZZY;
4562
4563                 if (nfingers == 2) {
4564                         if (ELANTECH_PKT_IS_V3_HEAD(pb, sc->elanhw.hascrc)) {
4565                                 sc->elanaction.fingers[0] = fn;
4566                                 return (0);
4567                         } else
4568                                 f[0] = sc->elanaction.fingers[0];
4569                 }
4570                 f[id] = fn;
4571                 break;
4572
4573         case ELANTECH_PKT_V4_STATUS:    /* HW Version 4. Status packet */
4574                 /*               7   6   5   4   3   2   1   0 (LSB)
4575                  * -------------------------------------------
4576                  * ipacket[0]:   .   .   .   .   0   1   R   L
4577                  * ipacket[1]:   .   .   .  F4  F3  F2  F1  F0
4578                  * ipacket[2]:   .   .   .   .   .   .   .   .
4579                  * ipacket[3]:   .   .   .   1   0   0   0   0
4580                  * ipacket[4]:  PL   .   .   .   .   .   .   .
4581                  * ipacket[5]:   .   .   .   .   .   .   .   .
4582                  * -------------------------------------------
4583                  * Fn: finger n is on touchpad
4584                  * PL: palm
4585                  * HV ver4 sends a status packet to indicate that the numbers
4586                  * or identities of the fingers has been changed
4587                  */
4588
4589                 mask = pb->ipacket[1] & 0x1f;
4590                 nfingers = bitcount(mask);
4591
4592                 if (sc->elanaction.mask_v4wait != 0)
4593                         VLOG(3, (LOG_DEBUG, "elantech: HW v4 status packet"
4594                             " when not all previous head packets received\n"));
4595
4596                 /* Bitmap of fingers to receive before gesture processing */
4597                 sc->elanaction.mask_v4wait = mask & ~sc->elanaction.mask;
4598
4599                 /* Skip "new finger is on touchpad" packets */
4600                 if (sc->elanaction.mask_v4wait) {
4601                         sc->elanaction.mask = mask;
4602                         return (0);
4603                 }
4604
4605                 break;
4606
4607         case ELANTECH_PKT_V4_HEAD:      /* HW Version 4. Head packet */
4608                 /*               7   6   5   4   3   2   1   0 (LSB)
4609                  * -------------------------------------------
4610                  * ipacket[0]:  W3  W2  W1  W0   0   1   R   L
4611                  * ipacket[1]:  P7  P6  P5  P4 X11 X10  X9  X8
4612                  * ipacket[2]:  X7  X6  X5  X4  X3  X2  X1  X0
4613                  * ipacket[3]: ID2 ID1 ID0   1   0   0   0   1
4614                  * ipacket[4]:  P3  P1  P2  P0 Y11 Y10  Y9  Y8
4615                  * ipacket[5]:  Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0
4616                  * -------------------------------------------
4617                  * ID: finger id
4618                  * HW ver 4 sends head packets in two cases:
4619                  * 1. One finger touch and movement.
4620                  * 2. Next after status packet to tell new finger positions.
4621                  */
4622                 mask = sc->elanaction.mask;
4623                 nfingers = bitcount(mask);
4624                 id = ((pb->ipacket[3] & 0xe0) >> 5) - 1;
4625                 fn = ELANTECH_FINGER_SET_XYP(pb);
4626                 fn.w =(pb->ipacket[0] & 0xf0) >> 4;
4627
4628                 if (id < 0)
4629                         return (0);
4630
4631                 /* Packet is finger position update. Report it */
4632                 if (sc->elanaction.mask_v4wait == 0) {
4633                         if (id < ELANTECH_MAX_FINGERS)
4634                                 f[id] = fn;
4635                         break;
4636                 }
4637
4638                 /* Remove finger from waiting bitmap and store into context */
4639                 sc->elanaction.mask_v4wait &= ~(1 << id);
4640                 if (id < ELANTECH_MAX_FINGERS)
4641                         sc->elanaction.fingers[id] = fn;
4642
4643                 /* Wait for other fingers if needed */
4644                 if (sc->elanaction.mask_v4wait != 0)
4645                         return (0);
4646
4647                 /* All new fingers are received. Report them from context */
4648                 for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
4649                         if (sc->elanaction.mask & (1 << id))
4650                                 f[id] =  sc->elanaction.fingers[id];
4651
4652                 break;
4653
4654         case ELANTECH_PKT_V4_MOTION:    /* HW Version 4. Motion packet */
4655                 /*               7   6   5   4   3   2   1   0 (LSB)
4656                  * -------------------------------------------
4657                  * ipacket[0]: ID2 ID1 ID0  OF   0   1   R   L
4658                  * ipacket[1]: DX7 DX6 DX5 DX4 DX3 DX2 DX1 DX0
4659                  * ipacket[2]: DY7 DY6 DY5 DY4 DY3 DY2 DY1 DY0
4660                  * ipacket[3]: ID2 ID1 ID0   1   0   0   1   0
4661                  * ipacket[4]: DX7 DX6 DX5 DX4 DX3 DX2 DX1 DX0
4662                  * ipacket[5]: DY7 DY6 DY5 DY4 DY3 DY2 DY1 DY0
4663                  * -------------------------------------------
4664                  * OF: delta overflows (> 127 or < -128), in this case
4665                  *     firmware sends us (delta x / 5) and (delta y / 5)
4666                  * ID: finger id
4667                  * DX: delta x (two's complement)
4668                  * XY: delta y (two's complement)
4669                  * byte 0 ~ 2 for one finger
4670                  * byte 3 ~ 5 for another finger
4671                  */
4672                 mask = sc->elanaction.mask;
4673                 nfingers = bitcount(mask);
4674
4675                 scale = (pb->ipacket[0] & 0x10) ? 5 : 1;
4676                 for (i = 0; i <= 3; i += 3) {
4677                         id = ((pb->ipacket[i] & 0xe0) >> 5) - 1;
4678                         if (id < 0 || id >= ELANTECH_MAX_FINGERS)
4679                                 continue;
4680
4681                         if (PSM_FINGER_IS_SET(sc->elanaction.fingers[id])) {
4682                                 f[id] = sc->elanaction.fingers[id];
4683                                 f[id].x += imax(-f[id].x,
4684                                     (signed char)pb->ipacket[i+1] * scale);
4685                                 f[id].y += imax(-f[id].y,
4686                                     (signed char)pb->ipacket[i+2] * scale);
4687                         } else {
4688                                 VLOG(3, (LOG_DEBUG, "elantech: "
4689                                     "HW v4 motion packet skipped\n"));
4690                         }
4691                 }
4692
4693                 break;
4694
4695         case ELANTECH_PKT_TRACKPOINT:
4696                 /*               7   6   5   4   3   2   1   0 (LSB)
4697                  * -------------------------------------------
4698                  * ipacket[0]:   0   0  SY  SX   0   M   R   L
4699                  * ipacket[1]: ~SX   0   0   0   0   0   0   0
4700                  * ipacket[2]: ~SY   0   0   0   0   0   0   0
4701                  * ipacket[3]:   0   0 ~SY ~SX   0   1   1   0
4702                  * ipacket[4]:  X7  X6  X5  X4  X3  X2  X1  X0
4703                  * ipacket[5]:  Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0
4704                  * -------------------------------------------
4705                  * X and Y are written in two's complement spread
4706                  * over 9 bits with SX/SY the relative top bit and
4707                  * X7..X0 and Y7..Y0 the lower bits.
4708                  */
4709                 if (!(pb->ipacket[0] & 0xC8) && !(pb->ipacket[1] & 0x7F) &&
4710                     !(pb->ipacket[2] & 0x7F) && !(pb->ipacket[3] & 0xC9) &&
4711                     !(pb->ipacket[0] & 0x10) != !(pb->ipacket[1] & 0x80) &&
4712                     !(pb->ipacket[0] & 0x10) != !(pb->ipacket[3] & 0x10) &&
4713                     !(pb->ipacket[0] & 0x20) != !(pb->ipacket[2] & 0x80) &&
4714                     !(pb->ipacket[0] & 0x20) != !(pb->ipacket[3] & 0x20)) {
4715
4716                         *x = (pb->ipacket[0] & MOUSE_PS2_XNEG) ?
4717                             pb->ipacket[4] - 256 : pb->ipacket[4];
4718                         *y = (pb->ipacket[0] & MOUSE_PS2_YNEG) ?
4719                             pb->ipacket[5] - 256 : pb->ipacket[5];
4720
4721                         trackpoint_button =
4722                             ((pb->ipacket[0] & 0x01) ? MOUSE_BUTTON1DOWN : 0) |
4723                             ((pb->ipacket[0] & 0x02) ? MOUSE_BUTTON3DOWN : 0) |
4724                             ((pb->ipacket[0] & 0x04) ? MOUSE_BUTTON2DOWN : 0);
4725 #ifdef EVDEV_SUPPORT
4726                         evdev_push_rel(sc->evdev_r, REL_X, *x);
4727                         evdev_push_rel(sc->evdev_r, REL_Y, -*y);
4728                         evdev_push_mouse_btn(sc->evdev_r, trackpoint_button);
4729                         evdev_sync(sc->evdev_r);
4730 #endif
4731                         ms->button = touchpad_button | trackpoint_button;
4732                 } else
4733                         VLOG(3, (LOG_DEBUG, "elantech: "
4734                             "unexpected trackpoint packet skipped\n"));
4735                 return (0);
4736
4737         case ELANTECH_PKT_NOP:
4738                 return (0);
4739
4740         default:
4741                 return (-1);
4742         }
4743
4744         for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
4745                 if (PSM_FINGER_IS_SET(f[id]))
4746                         VLOG(2, (LOG_DEBUG, "elantech: "
4747                             "finger %d: down [%d, %d], %d, %d, %d\n", id + 1,
4748                             f[id].x, f[id].y, f[id].p, f[id].w, f[id].flags));
4749
4750         /* Touchpad button presses */
4751         if (sc->elanhw.isclickpad) {
4752                 touchpad_button =
4753                     ((pb->ipacket[0] & 0x03) ? MOUSE_BUTTON1DOWN : 0);
4754         } else {
4755                 touchpad_button =
4756                     ((pb->ipacket[0] & 0x01) ? MOUSE_BUTTON1DOWN : 0) |
4757                     ((pb->ipacket[0] & 0x02) ? MOUSE_BUTTON3DOWN : 0);
4758         }
4759
4760 #ifdef EVDEV_SUPPORT
4761         if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE) {
4762                 for (id = 0; id < ELANTECH_MAX_FINGERS; id++) {
4763                         if (PSM_FINGER_IS_SET(f[id])) {
4764                                 psm_push_mt_finger(sc, id, &f[id]);
4765                                 /* Convert touch width to surface units */
4766                                 evdev_push_abs(sc->evdev_a, ABS_MT_TOUCH_MAJOR,
4767                                     f[id].w * sc->elanhw.dptracex);
4768                         }
4769                         if (sc->elanaction.mask & (1 << id) &&
4770                             !(mask & (1 << id)))
4771                                 psm_release_mt_slot(sc->evdev_a, id);
4772                 }
4773                 evdev_push_key(sc->evdev_a, BTN_TOUCH, nfingers > 0);
4774                 evdev_push_nfingers(sc->evdev_a, nfingers);
4775                 if (nfingers > 0) {
4776                         if (PSM_FINGER_IS_SET(f[0]))
4777                                 psm_push_st_finger(sc, &f[0]);
4778                 } else
4779                         evdev_push_abs(sc->evdev_a, ABS_PRESSURE, 0);
4780                 evdev_push_mouse_btn(sc->evdev_a, touchpad_button);
4781                 evdev_sync(sc->evdev_a);
4782         }
4783 #endif
4784
4785         ms->button = touchpad_button | trackpoint_button;
4786
4787         /* Palm detection doesn't terminate the current action. */
4788         palm = psmpalmdetect(sc, &f[0], nfingers);
4789
4790         /* Send finger 1 position to gesture processor */
4791         if ((PSM_FINGER_IS_SET(f[0]) || PSM_FINGER_IS_SET(f[1]) ||
4792             nfingers == 0) && !palm)
4793                 psmgestures(sc, &f[0], imin(nfingers, 3), ms);
4794
4795         /* Send fingers positions to movement smoothers */
4796         for (id = 0; id < PSM_FINGERS; id++)
4797                 if (PSM_FINGER_IS_SET(f[id]) || !(mask & (1 << id)))
4798                         psmsmoother(sc, &f[id], id, ms, x, y);
4799
4800         /* Store current finger positions in action context */
4801         for (id = 0; id < ELANTECH_MAX_FINGERS; id++) {
4802                 if (PSM_FINGER_IS_SET(f[id]))
4803                         sc->elanaction.fingers[id] = f[id];
4804                 if ((sc->elanaction.mask & (1 << id)) && !(mask & (1 << id)))
4805                         PSM_FINGER_RESET(sc->elanaction.fingers[id]);
4806         }
4807         sc->elanaction.mask = mask;
4808
4809         if (palm) {
4810                 *x = *y = *z = 0;
4811                 ms->button = ms->obutton;
4812                 return (0);
4813         }
4814
4815         /* Use the extra buttons as a scrollwheel */
4816         if (ms->button & MOUSE_BUTTON4DOWN)
4817                 *z = -1;
4818         else if (ms->button & MOUSE_BUTTON5DOWN)
4819                 *z = 1;
4820         else if (ms->button & MOUSE_BUTTON6DOWN)
4821                 *z = -2;
4822         else if (ms->button & MOUSE_BUTTON7DOWN)
4823                 *z = 2;
4824         else
4825                 *z = 0;
4826         ms->button &= ~(MOUSE_BUTTON4DOWN | MOUSE_BUTTON5DOWN |
4827             MOUSE_BUTTON6DOWN | MOUSE_BUTTON7DOWN);
4828
4829         return (0);
4830 }
4831
4832 static void
4833 proc_versapad(struct psm_softc *sc, packetbuf_t *pb, mousestatus_t *ms,
4834     int *x, int *y, int *z)
4835 {
4836         static int butmap_versapad[8] = {
4837                 0,
4838                 MOUSE_BUTTON3DOWN,
4839                 0,
4840                 MOUSE_BUTTON3DOWN,
4841                 MOUSE_BUTTON1DOWN,
4842                 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
4843                 MOUSE_BUTTON1DOWN,
4844                 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN
4845         };
4846         int c, x0, y0;
4847
4848         /* VersaPad PS/2 absolute mode message format
4849          *
4850          * [packet1]     7   6   5   4   3   2   1   0(LSB)
4851          *  ipacket[0]:  1   1   0   A   1   L   T   R
4852          *  ipacket[1]: H7  H6  H5  H4  H3  H2  H1  H0
4853          *  ipacket[2]: V7  V6  V5  V4  V3  V2  V1  V0
4854          *  ipacket[3]:  1   1   1   A   1   L   T   R
4855          *  ipacket[4]:V11 V10  V9  V8 H11 H10  H9  H8
4856          *  ipacket[5]:  0  P6  P5  P4  P3  P2  P1  P0
4857          *
4858          * [note]
4859          *  R: right physical mouse button (1=on)
4860          *  T: touch pad virtual button (1=tapping)
4861          *  L: left physical mouse button (1=on)
4862          *  A: position data is valid (1=valid)
4863          *  H: horizontal data (12bit signed integer. H11 is sign bit.)
4864          *  V: vertical data (12bit signed integer. V11 is sign bit.)
4865          *  P: pressure data
4866          *
4867          * Tapping is mapped to MOUSE_BUTTON4.
4868          */
4869         c = pb->ipacket[0];
4870         *x = *y = 0;
4871         ms->button = butmap_versapad[c & MOUSE_PS2VERSA_BUTTONS];
4872         ms->button |= (c & MOUSE_PS2VERSA_TAP) ? MOUSE_BUTTON4DOWN : 0;
4873         if (c & MOUSE_PS2VERSA_IN_USE) {
4874                 x0 = pb->ipacket[1] | (((pb->ipacket[4]) & 0x0f) << 8);
4875                 y0 = pb->ipacket[2] | (((pb->ipacket[4]) & 0xf0) << 4);
4876                 if (x0 & 0x800)
4877                         x0 -= 0x1000;
4878                 if (y0 & 0x800)
4879                         y0 -= 0x1000;
4880                 if (sc->flags & PSM_FLAGS_FINGERDOWN) {
4881                         *x = sc->xold - x0;
4882                         *y = y0 - sc->yold;
4883                         if (*x < 0)     /* XXX */
4884                                 ++*x;
4885                         else if (*x)
4886                                 --*x;
4887                         if (*y < 0)
4888                                 ++*y;
4889                         else if (*y)
4890                                 --*y;
4891                 } else
4892                         sc->flags |= PSM_FLAGS_FINGERDOWN;
4893                 sc->xold = x0;
4894                 sc->yold = y0;
4895         } else
4896                 sc->flags &= ~PSM_FLAGS_FINGERDOWN;
4897 }
4898
4899 static void
4900 psmsoftintridle(void *arg)
4901 {
4902         struct psm_softc *sc = arg;
4903         packetbuf_t *pb;
4904
4905         /* Invoke soft handler only when pqueue is empty. Otherwise it will be
4906          * invoked from psmintr soon with pqueue filled with real data */
4907         if (sc->pqueue_start == sc->pqueue_end &&
4908             sc->idlepacket.inputbytes > 0) {
4909                 /* Grow circular queue backwards to avoid race with psmintr */
4910                 if (--sc->pqueue_start < 0)
4911                         sc->pqueue_start = PSM_PACKETQUEUE - 1;
4912
4913                 pb = &sc->pqueue[sc->pqueue_start];
4914                 memcpy(pb, &sc->idlepacket, sizeof(packetbuf_t));
4915                 VLOG(4, (LOG_DEBUG,
4916                     "psmsoftintridle: %02x %02x %02x %02x %02x %02x\n",
4917                     pb->ipacket[0], pb->ipacket[1], pb->ipacket[2],
4918                     pb->ipacket[3], pb->ipacket[4], pb->ipacket[5]));
4919
4920                 psmsoftintr(arg);
4921         }
4922 }
4923
4924 static void
4925 psmsoftintr(void *arg)
4926 {
4927         /*
4928          * the table to turn PS/2 mouse button bits (MOUSE_PS2_BUTTON?DOWN)
4929          * into `mousestatus' button bits (MOUSE_BUTTON?DOWN).
4930          */
4931         static int butmap[8] = {
4932                 0,
4933                 MOUSE_BUTTON1DOWN,
4934                 MOUSE_BUTTON3DOWN,
4935                 MOUSE_BUTTON1DOWN | MOUSE_BUTTON3DOWN,
4936                 MOUSE_BUTTON2DOWN,
4937                 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN,
4938                 MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN,
4939                 MOUSE_BUTTON1DOWN | MOUSE_BUTTON2DOWN | MOUSE_BUTTON3DOWN
4940         };
4941         struct psm_softc *sc = arg;
4942         mousestatus_t ms;
4943         packetbuf_t *pb;
4944         int x, y, z, c, l, s;
4945
4946         getmicrouptime(&sc->lastsoftintr);
4947
4948         s = spltty();
4949
4950         do {
4951                 pb = &sc->pqueue[sc->pqueue_start];
4952
4953                 if (sc->mode.level == PSM_LEVEL_NATIVE)
4954                         goto next_native;
4955
4956                 c = pb->ipacket[0];
4957                 /*
4958                  * A kludge for Kensington device!
4959                  * The MSB of the horizontal count appears to be stored in
4960                  * a strange place.
4961                  */
4962                 if (sc->hw.model == MOUSE_MODEL_THINK)
4963                         pb->ipacket[1] |= (c & MOUSE_PS2_XOVERFLOW) ? 0x80 : 0;
4964
4965                 /* ignore the overflow bits... */
4966                 x = (c & MOUSE_PS2_XNEG) ?
4967                     pb->ipacket[1] - 256 : pb->ipacket[1];
4968                 y = (c & MOUSE_PS2_YNEG) ?
4969                     pb->ipacket[2] - 256 : pb->ipacket[2];
4970                 z = 0;
4971                 ms.obutton = sc->button;          /* previous button state */
4972                 ms.button = butmap[c & MOUSE_PS2_BUTTONS];
4973                 /* `tapping' action */
4974                 if (sc->config & PSM_CONFIG_FORCETAP)
4975                         ms.button |= ((c & MOUSE_PS2_TAP)) ?
4976                             0 : MOUSE_BUTTON4DOWN;
4977                 timevalclear(&sc->idletimeout);
4978                 sc->idlepacket.inputbytes = 0;
4979
4980                 switch (sc->hw.model) {
4981
4982                 case MOUSE_MODEL_EXPLORER:
4983                         /*
4984                          *          b7 b6 b5 b4 b3 b2 b1 b0
4985                          * byte 1:  oy ox sy sx 1  M  R  L
4986                          * byte 2:  x  x  x  x  x  x  x  x
4987                          * byte 3:  y  y  y  y  y  y  y  y
4988                          * byte 4:  *  *  S2 S1 s  d2 d1 d0
4989                          *
4990                          * L, M, R, S1, S2: left, middle, right and side buttons
4991                          * s: wheel data sign bit
4992                          * d2-d0: wheel data
4993                          */
4994                         z = (pb->ipacket[3] & MOUSE_EXPLORER_ZNEG) ?
4995                             (pb->ipacket[3] & 0x0f) - 16 :
4996                             (pb->ipacket[3] & 0x0f);
4997                         ms.button |=
4998                             (pb->ipacket[3] & MOUSE_EXPLORER_BUTTON4DOWN) ?
4999                             MOUSE_BUTTON4DOWN : 0;
5000                         ms.button |=
5001                             (pb->ipacket[3] & MOUSE_EXPLORER_BUTTON5DOWN) ?
5002                             MOUSE_BUTTON5DOWN : 0;
5003                         break;
5004
5005                 case MOUSE_MODEL_INTELLI:
5006                 case MOUSE_MODEL_NET:
5007                         /* wheel data is in the fourth byte */
5008                         z = (char)pb->ipacket[3];
5009                         /*
5010                          * XXX some mice may send 7 when there is no Z movement?                         */
5011                         if ((z >= 7) || (z <= -7))
5012                                 z = 0;
5013                         /* some compatible mice have additional buttons */
5014                         ms.button |= (c & MOUSE_PS2INTELLI_BUTTON4DOWN) ?
5015                             MOUSE_BUTTON4DOWN : 0;
5016                         ms.button |= (c & MOUSE_PS2INTELLI_BUTTON5DOWN) ?
5017                             MOUSE_BUTTON5DOWN : 0;
5018                         break;
5019
5020                 case MOUSE_MODEL_MOUSEMANPLUS:
5021                         proc_mmanplus(sc, pb, &ms, &x, &y, &z);
5022                         break;
5023
5024                 case MOUSE_MODEL_GLIDEPOINT:
5025                         /* `tapping' action */
5026                         ms.button |= ((c & MOUSE_PS2_TAP)) ? 0 :
5027                             MOUSE_BUTTON4DOWN;
5028                         break;
5029
5030                 case MOUSE_MODEL_NETSCROLL:
5031                         /*
5032                          * three additional bytes encode buttons and
5033                          * wheel events
5034                          */
5035                         ms.button |= (pb->ipacket[3] & MOUSE_PS2_BUTTON3DOWN) ?
5036                             MOUSE_BUTTON4DOWN : 0;
5037                         ms.button |= (pb->ipacket[3] & MOUSE_PS2_BUTTON1DOWN) ?
5038                             MOUSE_BUTTON5DOWN : 0;
5039                         z = (pb->ipacket[3] & MOUSE_PS2_XNEG) ?
5040                             pb->ipacket[4] - 256 : pb->ipacket[4];
5041                         break;
5042
5043                 case MOUSE_MODEL_THINK:
5044                         /* the fourth button state in the first byte */
5045                         ms.button |= (c & MOUSE_PS2_TAP) ?
5046                             MOUSE_BUTTON4DOWN : 0;
5047                         break;
5048
5049                 case MOUSE_MODEL_VERSAPAD:
5050                         proc_versapad(sc, pb, &ms, &x, &y, &z);
5051                         c = ((x < 0) ? MOUSE_PS2_XNEG : 0) |
5052                             ((y < 0) ? MOUSE_PS2_YNEG : 0);
5053                         break;
5054
5055                 case MOUSE_MODEL_4D:
5056                         /*
5057                          *          b7 b6 b5 b4 b3 b2 b1 b0
5058                          * byte 1:  s2 d2 s1 d1 1  M  R  L
5059                          * byte 2:  sx x  x  x  x  x  x  x
5060                          * byte 3:  sy y  y  y  y  y  y  y
5061                          *
5062                          * s1: wheel 1 direction
5063                          * d1: wheel 1 data
5064                          * s2: wheel 2 direction
5065                          * d2: wheel 2 data
5066                          */
5067                         x = (pb->ipacket[1] & 0x80) ?
5068                             pb->ipacket[1] - 256 : pb->ipacket[1];
5069                         y = (pb->ipacket[2] & 0x80) ?
5070                             pb->ipacket[2] - 256 : pb->ipacket[2];
5071                         switch (c & MOUSE_4D_WHEELBITS) {
5072                         case 0x10:
5073                                 z = 1;
5074                                 break;
5075                         case 0x30:
5076                                 z = -1;
5077                                 break;
5078                         case 0x40:      /* XXX 2nd wheel turning right */
5079                                 z = 2;
5080                                 break;
5081                         case 0xc0:      /* XXX 2nd wheel turning left */
5082                                 z = -2;
5083                                 break;
5084                         }
5085                         break;
5086
5087                 case MOUSE_MODEL_4DPLUS:
5088                         if ((x < 16 - 256) && (y < 16 - 256)) {
5089                                 /*
5090                                  *          b7 b6 b5 b4 b3 b2 b1 b0
5091                                  * byte 1:  0  0  1  1  1  M  R  L
5092                                  * byte 2:  0  0  0  0  1  0  0  0
5093                                  * byte 3:  0  0  0  0  S  s  d1 d0
5094                                  *
5095                                  * L, M, R, S: left, middle, right,
5096                                  *             and side buttons
5097                                  * s: wheel data sign bit
5098                                  * d1-d0: wheel data
5099                                  */
5100                                 x = y = 0;
5101                                 if (pb->ipacket[2] & MOUSE_4DPLUS_BUTTON4DOWN)
5102                                         ms.button |= MOUSE_BUTTON4DOWN;
5103                                 z = (pb->ipacket[2] & MOUSE_4DPLUS_ZNEG) ?
5104                                     ((pb->ipacket[2] & 0x07) - 8) :
5105                                     (pb->ipacket[2] & 0x07) ;
5106                         } else {
5107                                 /* preserve previous button states */
5108                                 ms.button |= ms.obutton & MOUSE_EXTBUTTONS;
5109                         }
5110                         break;
5111
5112                 case MOUSE_MODEL_SYNAPTICS:
5113                         if (pb->inputbytes == MOUSE_PS2_PACKETSIZE)
5114                                 if (proc_synaptics_mux(sc, pb))
5115                                         goto next;
5116
5117                         if (proc_synaptics(sc, pb, &ms, &x, &y, &z) != 0) {
5118                                 VLOG(3, (LOG_DEBUG, "synaptics: "
5119                                     "packet rejected\n"));
5120                                 goto next;
5121                         }
5122                         break;
5123
5124                 case MOUSE_MODEL_ELANTECH:
5125                         if (proc_elantech(sc, pb, &ms, &x, &y, &z) != 0) {
5126                                 VLOG(3, (LOG_DEBUG, "elantech: "
5127                                     "packet rejected\n"));
5128                                 goto next;
5129                         }
5130                         break;
5131
5132                 case MOUSE_MODEL_TRACKPOINT:
5133                 case MOUSE_MODEL_GENERIC:
5134                 default:
5135                         break;
5136                 }
5137
5138 #ifdef EVDEV_SUPPORT
5139         if (evdev_rcpt_mask & EVDEV_RCPT_HW_MOUSE &&
5140             sc->hw.model != MOUSE_MODEL_ELANTECH &&
5141             sc->hw.model != MOUSE_MODEL_SYNAPTICS) {
5142                 evdev_push_rel(sc->evdev_r, REL_X, x);
5143                 evdev_push_rel(sc->evdev_r, REL_Y, -y);
5144
5145                 switch (sc->hw.model) {
5146                 case MOUSE_MODEL_EXPLORER:
5147                 case MOUSE_MODEL_INTELLI:
5148                 case MOUSE_MODEL_NET:
5149                 case MOUSE_MODEL_NETSCROLL:
5150                 case MOUSE_MODEL_4DPLUS:
5151                         evdev_push_rel(sc->evdev_r, REL_WHEEL, -z);
5152                         break;
5153                 case MOUSE_MODEL_MOUSEMANPLUS:
5154                 case MOUSE_MODEL_4D:
5155                         switch (z) {
5156                         case 1:
5157                         case -1:
5158                                 evdev_push_rel(sc->evdev_r, REL_WHEEL, -z);
5159                                 break;
5160                         case 2:
5161                         case -2:
5162                                 evdev_push_rel(sc->evdev_r, REL_HWHEEL, z / 2);
5163                                 break;
5164                         }
5165                         break;
5166                 }
5167
5168                 evdev_push_mouse_btn(sc->evdev_r, ms.button);
5169                 evdev_sync(sc->evdev_r);
5170         }
5171 #endif
5172
5173         /* scale values */
5174         if (sc->mode.accelfactor >= 1) {
5175                 if (x != 0) {
5176                         x = x * x / sc->mode.accelfactor;
5177                         if (x == 0)
5178                                 x = 1;
5179                         if (c & MOUSE_PS2_XNEG)
5180                                 x = -x;
5181                 }
5182                 if (y != 0) {
5183                         y = y * y / sc->mode.accelfactor;
5184                         if (y == 0)
5185                                 y = 1;
5186                         if (c & MOUSE_PS2_YNEG)
5187                                 y = -y;
5188                 }
5189         }
5190
5191         /* Store last packet for reinjection if it has not been set already */
5192         if (timevalisset(&sc->idletimeout) && sc->idlepacket.inputbytes == 0)
5193                 sc->idlepacket = *pb;
5194
5195         ms.dx = x;
5196         ms.dy = y;
5197         ms.dz = z;
5198         ms.flags = ((x || y || z) ? MOUSE_POSCHANGED : 0) |
5199             (ms.obutton ^ ms.button);
5200
5201         pb->inputbytes = tame_mouse(sc, pb, &ms, pb->ipacket);
5202
5203         sc->status.flags |= ms.flags;
5204         sc->status.dx += ms.dx;
5205         sc->status.dy += ms.dy;
5206         sc->status.dz += ms.dz;
5207         sc->status.button = ms.button;
5208         sc->button = ms.button;
5209
5210 next_native:
5211         sc->watchdog = FALSE;
5212
5213         /* queue data */
5214         if (sc->queue.count + pb->inputbytes < sizeof(sc->queue.buf)) {
5215                 l = imin(pb->inputbytes,
5216                     sizeof(sc->queue.buf) - sc->queue.tail);
5217                 bcopy(&pb->ipacket[0], &sc->queue.buf[sc->queue.tail], l);
5218                 if (pb->inputbytes > l)
5219                         bcopy(&pb->ipacket[l], &sc->queue.buf[0],
5220                             pb->inputbytes - l);
5221                 sc->queue.tail = (sc->queue.tail + pb->inputbytes) %
5222                     sizeof(sc->queue.buf);
5223                 sc->queue.count += pb->inputbytes;
5224         }
5225
5226 next:
5227         pb->inputbytes = 0;
5228         if (++sc->pqueue_start >= PSM_PACKETQUEUE)
5229                 sc->pqueue_start = 0;
5230         } while (sc->pqueue_start != sc->pqueue_end);
5231
5232         if (sc->state & PSM_ASLP) {
5233                 sc->state &= ~PSM_ASLP;
5234                 wakeup(sc);
5235         }
5236         selwakeuppri(&sc->rsel, PZERO);
5237         if (sc->async != NULL) {
5238                 pgsigio(&sc->async, SIGIO, 0);
5239         }
5240         sc->state &= ~PSM_SOFTARMED;
5241
5242         /* schedule injection of predefined packet after idletimeout
5243          * if no data packets have been received from psmintr */
5244         if (timevalisset(&sc->idletimeout)) {
5245                 sc->state |= PSM_SOFTARMED;
5246                 callout_reset(&sc->softcallout, tvtohz(&sc->idletimeout),
5247                     psmsoftintridle, sc);
5248                 VLOG(2, (LOG_DEBUG, "softintr: callout set: %d ticks\n",
5249                     tvtohz(&sc->idletimeout)));
5250         }
5251         splx(s);
5252 }
5253
5254 static int
5255 psmpoll(struct cdev *dev, int events, struct thread *td)
5256 {
5257         struct psm_softc *sc = dev->si_drv1;
5258         int s;
5259         int revents = 0;
5260
5261         /* Return true if a mouse event available */
5262         s = spltty();
5263         if (events & (POLLIN | POLLRDNORM)) {
5264                 if (sc->queue.count > 0)
5265                         revents |= events & (POLLIN | POLLRDNORM);
5266                 else
5267                         selrecord(td, &sc->rsel);
5268         }
5269         splx(s);
5270
5271         return (revents);
5272 }
5273
5274 /* vendor/model specific routines */
5275
5276 static int mouse_id_proc1(KBDC kbdc, int res, int scale, int *status)
5277 {
5278         if (set_mouse_resolution(kbdc, res) != res)
5279                 return (FALSE);
5280         if (set_mouse_scaling(kbdc, scale) &&
5281             set_mouse_scaling(kbdc, scale) &&
5282             set_mouse_scaling(kbdc, scale) &&
5283             (get_mouse_status(kbdc, status, 0, 3) >= 3))
5284                 return (TRUE);
5285         return (FALSE);
5286 }
5287
5288 static int
5289 mouse_ext_command(KBDC kbdc, int command)
5290 {
5291         int c;
5292
5293         c = (command >> 6) & 0x03;
5294         if (set_mouse_resolution(kbdc, c) != c)
5295                 return (FALSE);
5296         c = (command >> 4) & 0x03;
5297         if (set_mouse_resolution(kbdc, c) != c)
5298                 return (FALSE);
5299         c = (command >> 2) & 0x03;
5300         if (set_mouse_resolution(kbdc, c) != c)
5301                 return (FALSE);
5302         c = (command >> 0) & 0x03;
5303         if (set_mouse_resolution(kbdc, c) != c)
5304                 return (FALSE);
5305         return (TRUE);
5306 }
5307
5308 #ifdef notyet
5309 /* Logitech MouseMan Cordless II */
5310 static int
5311 enable_lcordless(struct psm_softc *sc, enum probearg arg)
5312 {
5313         KBDC kbdc = sc->kbdc;
5314         int status[3];
5315         int ch;
5316
5317         if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 2, status))
5318                 return (FALSE);
5319         if (status[1] == PSMD_RES_HIGH)
5320                 return (FALSE);
5321         ch = (status[0] & 0x07) - 1;    /* channel # */
5322         if ((ch <= 0) || (ch > 4))
5323                 return (FALSE);
5324         /*
5325          * status[1]: always one?
5326          * status[2]: battery status? (0-100)
5327          */
5328         return (TRUE);
5329 }
5330 #endif /* notyet */
5331
5332 /* Genius NetScroll Mouse, MouseSystems SmartScroll Mouse */
5333 static int
5334 enable_groller(struct psm_softc *sc, enum probearg arg)
5335 {
5336         KBDC kbdc = sc->kbdc;
5337         int status[3];
5338
5339         /*
5340          * The special sequence to enable the fourth button and the
5341          * roller. Immediately after this sequence check status bytes.
5342          * if the mouse is NetScroll, the second and the third bytes are
5343          * '3' and 'D'.
5344          */
5345
5346         /*
5347          * If the mouse is an ordinary PS/2 mouse, the status bytes should
5348          * look like the following.
5349          *
5350          * byte 1 bit 7 always 0
5351          *        bit 6 stream mode (0)
5352          *        bit 5 disabled (0)
5353          *        bit 4 1:1 scaling (0)
5354          *        bit 3 always 0
5355          *        bit 0-2 button status
5356          * byte 2 resolution (PSMD_RES_HIGH)
5357          * byte 3 report rate (?)
5358          */
5359
5360         if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 1, status))
5361                 return (FALSE);
5362         if ((status[1] != '3') || (status[2] != 'D'))
5363                 return (FALSE);
5364         /* FIXME: SmartScroll Mouse has 5 buttons! XXX */
5365         if (arg == PROBE)
5366                 sc->hw.buttons = 4;
5367         return (TRUE);
5368 }
5369
5370 /* Genius NetMouse/NetMouse Pro, ASCII Mie Mouse, NetScroll Optical */
5371 static int
5372 enable_gmouse(struct psm_softc *sc, enum probearg arg)
5373 {
5374         KBDC kbdc = sc->kbdc;
5375         int status[3];
5376
5377         /*
5378          * The special sequence to enable the middle, "rubber" button.
5379          * Immediately after this sequence check status bytes.
5380          * if the mouse is NetMouse, NetMouse Pro, or ASCII MIE Mouse,
5381          * the second and the third bytes are '3' and 'U'.
5382          * NOTE: NetMouse reports that it has three buttons although it has
5383          * two buttons and a rubber button. NetMouse Pro and MIE Mouse
5384          * say they have three buttons too and they do have a button on the
5385          * side...
5386          */
5387         if (!mouse_id_proc1(kbdc, PSMD_RES_HIGH, 1, status))
5388                 return (FALSE);
5389         if ((status[1] != '3') || (status[2] != 'U'))
5390                 return (FALSE);
5391         return (TRUE);
5392 }
5393
5394 /* ALPS GlidePoint */
5395 static int
5396 enable_aglide(struct psm_softc *sc, enum probearg arg)
5397 {
5398         KBDC kbdc = sc->kbdc;
5399         int status[3];
5400
5401         /*
5402          * The special sequence to obtain ALPS GlidePoint specific
5403          * information. Immediately after this sequence, status bytes will
5404          * contain something interesting.
5405          * NOTE: ALPS produces several models of GlidePoint. Some of those
5406          * do not respond to this sequence, thus, cannot be detected this way.
5407          */
5408         if (set_mouse_sampling_rate(kbdc, 100) != 100)
5409                 return (FALSE);
5410         if (!mouse_id_proc1(kbdc, PSMD_RES_LOW, 2, status))
5411                 return (FALSE);
5412         if ((status[1] == PSMD_RES_LOW) || (status[2] == 100))
5413                 return (FALSE);
5414         return (TRUE);
5415 }
5416
5417 /* Kensington ThinkingMouse/Trackball */
5418 static int
5419 enable_kmouse(struct psm_softc *sc, enum probearg arg)
5420 {
5421         static u_char rate[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20 };
5422         KBDC kbdc = sc->kbdc;
5423         int status[3];
5424         int id1;
5425         int id2;
5426         int i;
5427
5428         id1 = get_aux_id(kbdc);
5429         if (set_mouse_sampling_rate(kbdc, 10) != 10)
5430                 return (FALSE);
5431         /*
5432          * The device is now in the native mode? It returns a different
5433          * ID value...
5434          */
5435         id2 = get_aux_id(kbdc);
5436         if ((id1 == id2) || (id2 != 2))
5437                 return (FALSE);
5438
5439         if (set_mouse_resolution(kbdc, PSMD_RES_LOW) != PSMD_RES_LOW)
5440                 return (FALSE);
5441 #if PSM_DEBUG >= 2
5442         /* at this point, resolution is LOW, sampling rate is 10/sec */
5443         if (get_mouse_status(kbdc, status, 0, 3) < 3)
5444                 return (FALSE);
5445 #endif
5446
5447         /*
5448          * The special sequence to enable the third and fourth buttons.
5449          * Otherwise they behave like the first and second buttons.
5450          */
5451         for (i = 0; i < nitems(rate); ++i)
5452                 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5453                         return (FALSE);
5454
5455         /*
5456          * At this point, the device is using default resolution and
5457          * sampling rate for the native mode.
5458          */
5459         if (get_mouse_status(kbdc, status, 0, 3) < 3)
5460                 return (FALSE);
5461         if ((status[1] == PSMD_RES_LOW) || (status[2] == rate[i - 1]))
5462                 return (FALSE);
5463
5464         /* the device appears be enabled by this sequence, diable it for now */
5465         disable_aux_dev(kbdc);
5466         empty_aux_buffer(kbdc, 5);
5467
5468         return (TRUE);
5469 }
5470
5471 /* Logitech MouseMan+/FirstMouse+, IBM ScrollPoint Mouse */
5472 static int
5473 enable_mmanplus(struct psm_softc *sc, enum probearg arg)
5474 {
5475         KBDC kbdc = sc->kbdc;
5476         int data[3];
5477
5478         /* the special sequence to enable the fourth button and the roller. */
5479         /*
5480          * NOTE: for ScrollPoint to respond correctly, the SET_RESOLUTION
5481          * must be called exactly three times since the last RESET command
5482          * before this sequence. XXX
5483          */
5484         if (!set_mouse_scaling(kbdc, 1))
5485                 return (FALSE);
5486         if (!mouse_ext_command(kbdc, 0x39) || !mouse_ext_command(kbdc, 0xdb))
5487                 return (FALSE);
5488         if (get_mouse_status(kbdc, data, 1, 3) < 3)
5489                 return (FALSE);
5490
5491         /*
5492          * PS2++ protocol, packet type 0
5493          *
5494          *          b7 b6 b5 b4 b3 b2 b1 b0
5495          * byte 1:  *  1  p3 p2 1  *  *  *
5496          * byte 2:  1  1  p1 p0 m1 m0 1  0
5497          * byte 3:  m7 m6 m5 m4 m3 m2 m1 m0
5498          *
5499          * p3-p0: packet type: 0
5500          * m7-m0: model ID: MouseMan+:0x50,
5501          *                  FirstMouse+:0x51,
5502          *                  ScrollPoint:0x58...
5503          */
5504         /* check constant bits */
5505         if ((data[0] & MOUSE_PS2PLUS_SYNCMASK) != MOUSE_PS2PLUS_SYNC)
5506                 return (FALSE);
5507         if ((data[1] & 0xc3) != 0xc2)
5508                 return (FALSE);
5509         /* check d3-d0 in byte 2 */
5510         if (!MOUSE_PS2PLUS_CHECKBITS(data))
5511                 return (FALSE);
5512         /* check p3-p0 */
5513         if (MOUSE_PS2PLUS_PACKET_TYPE(data) != 0)
5514                 return (FALSE);
5515
5516         if (arg == PROBE) {
5517                 sc->hw.hwid &= 0x00ff;
5518                 sc->hw.hwid |= data[2] << 8;    /* save model ID */
5519         }
5520
5521         /*
5522          * MouseMan+ (or FirstMouse+) is now in its native mode, in which
5523          * the wheel and the fourth button events are encoded in the
5524          * special data packet. The mouse may be put in the IntelliMouse mode
5525          * if it is initialized by the IntelliMouse's method.
5526          */
5527         return (TRUE);
5528 }
5529
5530 /* MS IntelliMouse Explorer */
5531 static int
5532 enable_msexplorer(struct psm_softc *sc, enum probearg arg)
5533 {
5534         KBDC kbdc = sc->kbdc;
5535         static u_char rate0[] = { 200, 100, 80, };
5536         static u_char rate1[] = { 200, 200, 80, };
5537         int id;
5538         int i;
5539
5540         /*
5541          * This is needed for at least A4Tech X-7xx mice - they do not go
5542          * straight to Explorer mode, but need to be set to Intelli mode
5543          * first.
5544          */
5545         enable_msintelli(sc, arg);
5546
5547         /* the special sequence to enable the extra buttons and the roller. */
5548         for (i = 0; i < nitems(rate1); ++i)
5549                 if (set_mouse_sampling_rate(kbdc, rate1[i]) != rate1[i])
5550                         return (FALSE);
5551         /* the device will give the genuine ID only after the above sequence */
5552         id = get_aux_id(kbdc);
5553         if (id != PSM_EXPLORER_ID)
5554                 return (FALSE);
5555
5556         if (arg == PROBE) {
5557                 sc->hw.buttons = 5;     /* IntelliMouse Explorer XXX */
5558                 sc->hw.hwid = id;
5559         }
5560
5561         /*
5562          * XXX: this is a kludge to fool some KVM switch products
5563          * which think they are clever enough to know the 4-byte IntelliMouse
5564          * protocol, and assume any other protocols use 3-byte packets.
5565          * They don't convey 4-byte data packets from the IntelliMouse Explorer
5566          * correctly to the host computer because of this!
5567          * The following sequence is actually IntelliMouse's "wake up"
5568          * sequence; it will make the KVM think the mouse is IntelliMouse
5569          * when it is in fact IntelliMouse Explorer.
5570          */
5571         for (i = 0; i < nitems(rate0); ++i)
5572                 if (set_mouse_sampling_rate(kbdc, rate0[i]) != rate0[i])
5573                         break;
5574         get_aux_id(kbdc);
5575
5576         return (TRUE);
5577 }
5578
5579 /*
5580  * MS IntelliMouse
5581  * Logitech MouseMan+ and FirstMouse+ will also respond to this
5582  * probe routine and act like IntelliMouse.
5583  */
5584 static int
5585 enable_msintelli(struct psm_softc *sc, enum probearg arg)
5586 {
5587         KBDC kbdc = sc->kbdc;
5588         static u_char rate[] = { 200, 100, 80, };
5589         int id;
5590         int i;
5591
5592         /* the special sequence to enable the third button and the roller. */
5593         for (i = 0; i < nitems(rate); ++i)
5594                 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5595                         return (FALSE);
5596         /* the device will give the genuine ID only after the above sequence */
5597         id = get_aux_id(kbdc);
5598         if (id != PSM_INTELLI_ID)
5599                 return (FALSE);
5600
5601         if (arg == PROBE) {
5602                 sc->hw.buttons = 3;
5603                 sc->hw.hwid = id;
5604         }
5605
5606         return (TRUE);
5607 }
5608
5609 /*
5610  * A4 Tech 4D Mouse
5611  * Newer wheel mice from A4 Tech may use the 4D+ protocol.
5612  */
5613 static int
5614 enable_4dmouse(struct psm_softc *sc, enum probearg arg)
5615 {
5616         static u_char rate[] = { 200, 100, 80, 60, 40, 20 };
5617         KBDC kbdc = sc->kbdc;
5618         int id;
5619         int i;
5620
5621         for (i = 0; i < nitems(rate); ++i)
5622                 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5623                         return (FALSE);
5624         id = get_aux_id(kbdc);
5625         /*
5626          * WinEasy 4D, 4 Way Scroll 4D: 6
5627          * Cable-Free 4D: 8 (4DPLUS)
5628          * WinBest 4D+, 4 Way Scroll 4D+: 8 (4DPLUS)
5629          */
5630         if (id != PSM_4DMOUSE_ID)
5631                 return (FALSE);
5632
5633         if (arg == PROBE) {
5634                 sc->hw.buttons = 3;     /* XXX some 4D mice have 4? */
5635                 sc->hw.hwid = id;
5636         }
5637
5638         return (TRUE);
5639 }
5640
5641 /*
5642  * A4 Tech 4D+ Mouse
5643  * Newer wheel mice from A4 Tech seem to use this protocol.
5644  * Older models are recognized as either 4D Mouse or IntelliMouse.
5645  */
5646 static int
5647 enable_4dplus(struct psm_softc *sc, enum probearg arg)
5648 {
5649         KBDC kbdc = sc->kbdc;
5650         int id;
5651
5652         /*
5653          * enable_4dmouse() already issued the following ID sequence...
5654         static u_char rate[] = { 200, 100, 80, 60, 40, 20 };
5655         int i;
5656
5657         for (i = 0; i < sizeof(rate)/sizeof(rate[0]); ++i)
5658                 if (set_mouse_sampling_rate(kbdc, rate[i]) != rate[i])
5659                         return (FALSE);
5660         */
5661
5662         id = get_aux_id(kbdc);
5663         switch (id) {
5664         case PSM_4DPLUS_ID:
5665                 break;
5666         case PSM_4DPLUS_RFSW35_ID:
5667                 break;
5668         default:
5669                 return (FALSE);
5670         }
5671
5672         if (arg == PROBE) {
5673                 sc->hw.buttons = (id == PSM_4DPLUS_ID) ? 4 : 3;
5674                 sc->hw.hwid = id;
5675         }
5676
5677         return (TRUE);
5678 }
5679
5680 /* Synaptics Touchpad */
5681 static int
5682 synaptics_sysctl(SYSCTL_HANDLER_ARGS)
5683 {
5684         struct psm_softc *sc;
5685         int error, arg;
5686
5687         if (oidp->oid_arg1 == NULL || oidp->oid_arg2 < 0 ||
5688             oidp->oid_arg2 > SYNAPTICS_SYSCTL_LAST)
5689                 return (EINVAL);
5690
5691         sc = oidp->oid_arg1;
5692
5693         /* Read the current value. */
5694         arg = *(int *)((char *)sc + oidp->oid_arg2);
5695         error = sysctl_handle_int(oidp, &arg, 0, req);
5696
5697         /* Sanity check. */
5698         if (error || !req->newptr)
5699                 return (error);
5700
5701         /*
5702          * Check that the new value is in the concerned node's range
5703          * of values.
5704          */
5705         switch (oidp->oid_arg2) {
5706         case SYNAPTICS_SYSCTL_MIN_PRESSURE:
5707         case SYNAPTICS_SYSCTL_MAX_PRESSURE:
5708                 if (arg < 0 || arg > 255)
5709                         return (EINVAL);
5710                 break;
5711         case SYNAPTICS_SYSCTL_MAX_WIDTH:
5712                 if (arg < 4 || arg > 15)
5713                         return (EINVAL);
5714                 break;
5715         case SYNAPTICS_SYSCTL_MARGIN_TOP:
5716         case SYNAPTICS_SYSCTL_MARGIN_BOTTOM:
5717         case SYNAPTICS_SYSCTL_NA_TOP:
5718         case SYNAPTICS_SYSCTL_NA_BOTTOM:
5719                 if (arg < 0 || arg > sc->synhw.maximumYCoord)
5720                         return (EINVAL);
5721                 break;
5722         case SYNAPTICS_SYSCTL_SOFTBUTTON2_X:
5723         case SYNAPTICS_SYSCTL_SOFTBUTTON3_X:
5724                 /* Softbuttons is clickpad only feature */
5725                 if (!sc->synhw.capClickPad && arg != 0)
5726                         return (EINVAL);
5727                 /* FALLTHROUGH */
5728         case SYNAPTICS_SYSCTL_MARGIN_RIGHT:
5729         case SYNAPTICS_SYSCTL_MARGIN_LEFT:
5730         case SYNAPTICS_SYSCTL_NA_RIGHT:
5731         case SYNAPTICS_SYSCTL_NA_LEFT:
5732                 if (arg < 0 || arg > sc->synhw.maximumXCoord)
5733                         return (EINVAL);
5734                 break;
5735         case SYNAPTICS_SYSCTL_WINDOW_MIN:
5736         case SYNAPTICS_SYSCTL_WINDOW_MAX:
5737         case SYNAPTICS_SYSCTL_TAP_MIN_QUEUE:
5738                 if (arg < 1 || arg > SYNAPTICS_PACKETQUEUE)
5739                         return (EINVAL);
5740                 break;
5741         case SYNAPTICS_SYSCTL_MULTIPLICATOR:
5742         case SYNAPTICS_SYSCTL_WEIGHT_CURRENT:
5743         case SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS:
5744         case SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS_NA:
5745         case SYNAPTICS_SYSCTL_WEIGHT_LEN_SQUARED:
5746         case SYNAPTICS_SYSCTL_DIV_MIN:
5747         case SYNAPTICS_SYSCTL_DIV_MAX:
5748         case SYNAPTICS_SYSCTL_DIV_MAX_NA:
5749         case SYNAPTICS_SYSCTL_DIV_LEN:
5750         case SYNAPTICS_SYSCTL_VSCROLL_DIV_MIN:
5751         case SYNAPTICS_SYSCTL_VSCROLL_DIV_MAX:
5752                 if (arg < 1)
5753                         return (EINVAL);
5754                 break;
5755         case SYNAPTICS_SYSCTL_TAP_MAX_DELTA:
5756         case SYNAPTICS_SYSCTL_TAPHOLD_TIMEOUT:
5757         case SYNAPTICS_SYSCTL_VSCROLL_MIN_DELTA:
5758                 if (arg < 0)
5759                         return (EINVAL);
5760                 break;
5761         case SYNAPTICS_SYSCTL_VSCROLL_HOR_AREA:
5762                 if (arg < -sc->synhw.maximumXCoord ||
5763                     arg > sc->synhw.maximumXCoord)
5764                         return (EINVAL);
5765                 break;
5766         case SYNAPTICS_SYSCTL_SOFTBUTTONS_Y:
5767                 /* Softbuttons is clickpad only feature */
5768                 if (!sc->synhw.capClickPad && arg != 0)
5769                         return (EINVAL);
5770                 /* FALLTHROUGH */
5771         case SYNAPTICS_SYSCTL_VSCROLL_VER_AREA:
5772                 if (arg < -sc->synhw.maximumYCoord ||
5773                     arg > sc->synhw.maximumYCoord)
5774                         return (EINVAL);
5775                 break;
5776         case SYNAPTICS_SYSCTL_TOUCHPAD_OFF:
5777         case SYNAPTICS_SYSCTL_THREE_FINGER_DRAG:
5778         case SYNAPTICS_SYSCTL_NATURAL_SCROLL:
5779                 if (arg < 0 || arg > 1)
5780                         return (EINVAL);
5781                 break;
5782         default:
5783                 return (EINVAL);
5784         }
5785
5786         /* Update. */
5787         *(int *)((char *)sc + oidp->oid_arg2) = arg;
5788
5789         return (error);
5790 }
5791
5792 static void
5793 synaptics_sysctl_create_softbuttons_tree(struct psm_softc *sc)
5794 {
5795         /*
5796          * Set predefined sizes for softbuttons.
5797          * Values are taken to match HP Pavilion dv6 clickpad drawings
5798          * with thin middle softbutton placed on separator
5799          */
5800
5801         /* hw.psm.synaptics.softbuttons_y */
5802         sc->syninfo.softbuttons_y = sc->synhw.topButtonPad ? -1700 : 1700;
5803         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5804             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5805             "softbuttons_y",
5806             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5807             sc, SYNAPTICS_SYSCTL_SOFTBUTTONS_Y,
5808             synaptics_sysctl, "I",
5809             "Vertical size of softbuttons area");
5810
5811         /* hw.psm.synaptics.softbutton2_x */
5812         sc->syninfo.softbutton2_x = 3100;
5813         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5814             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5815             "softbutton2_x",
5816             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5817             sc, SYNAPTICS_SYSCTL_SOFTBUTTON2_X,
5818             synaptics_sysctl, "I",
5819             "Horisontal position of 2-nd softbutton left edge (0-disable)");
5820
5821         /* hw.psm.synaptics.softbutton3_x */
5822         sc->syninfo.softbutton3_x = 3900;
5823         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5824             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5825             "softbutton3_x",
5826             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5827             sc, SYNAPTICS_SYSCTL_SOFTBUTTON3_X,
5828             synaptics_sysctl, "I",
5829             "Horisontal position of 3-rd softbutton left edge (0-disable)");
5830 }
5831
5832 static void
5833 synaptics_sysctl_create_tree(struct psm_softc *sc, const char *name,
5834     const char *descr)
5835 {
5836
5837         if (sc->syninfo.sysctl_tree != NULL)
5838                 return;
5839
5840         /* Attach extra synaptics sysctl nodes under hw.psm.synaptics */
5841         sysctl_ctx_init(&sc->syninfo.sysctl_ctx);
5842         sc->syninfo.sysctl_tree = SYSCTL_ADD_NODE(&sc->syninfo.sysctl_ctx,
5843             SYSCTL_STATIC_CHILDREN(_hw_psm), OID_AUTO, name,
5844             CTLFLAG_RD | CTLFLAG_MPSAFE, 0, descr);
5845
5846         /* hw.psm.synaptics.directional_scrolls. */
5847         sc->syninfo.directional_scrolls = 0;
5848         SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5849             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5850             "directional_scrolls", CTLFLAG_RW|CTLFLAG_ANYBODY,
5851             &sc->syninfo.directional_scrolls, 0,
5852             "Enable hardware scrolling pad (if non-zero) or register it as "
5853             "extended buttons (if 0)");
5854
5855         /* hw.psm.synaptics.max_x. */
5856         sc->syninfo.max_x = 6143;
5857         SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5858             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5859             "max_x", CTLFLAG_RD|CTLFLAG_ANYBODY,
5860             &sc->syninfo.max_x, 0,
5861             "Horizontal reporting range");
5862
5863         /* hw.psm.synaptics.max_y. */
5864         sc->syninfo.max_y = 6143;
5865         SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5866             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5867             "max_y", CTLFLAG_RD|CTLFLAG_ANYBODY,
5868             &sc->syninfo.max_y, 0,
5869             "Vertical reporting range");
5870
5871         /*
5872          * Turn off two finger scroll if we have a
5873          * physical area reserved for scrolling or when
5874          * there's no multi finger support.
5875          */
5876         if (sc->synhw.verticalScroll || (sc->synhw.capMultiFinger == 0 &&
5877                                          sc->synhw.capAdvancedGestures == 0))
5878                 sc->syninfo.two_finger_scroll = 0;
5879         else
5880                 sc->syninfo.two_finger_scroll = 1;
5881         /* hw.psm.synaptics.two_finger_scroll. */
5882         SYSCTL_ADD_INT(&sc->syninfo.sysctl_ctx,
5883             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5884             "two_finger_scroll", CTLFLAG_RW|CTLFLAG_ANYBODY,
5885             &sc->syninfo.two_finger_scroll, 0,
5886             "Enable two finger scrolling");
5887
5888         /* hw.psm.synaptics.min_pressure. */
5889         sc->syninfo.min_pressure = 32;
5890         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5891             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5892             "min_pressure",
5893             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5894             sc, SYNAPTICS_SYSCTL_MIN_PRESSURE,
5895             synaptics_sysctl, "I",
5896             "Minimum pressure required to start an action");
5897
5898         /* hw.psm.synaptics.max_pressure. */
5899         sc->syninfo.max_pressure = 220;
5900         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5901             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5902             "max_pressure",
5903             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5904             sc, SYNAPTICS_SYSCTL_MAX_PRESSURE,
5905             synaptics_sysctl, "I",
5906             "Maximum pressure to detect palm");
5907
5908         /* hw.psm.synaptics.max_width. */
5909         sc->syninfo.max_width = 10;
5910         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5911             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5912             "max_width",
5913             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5914             sc, SYNAPTICS_SYSCTL_MAX_WIDTH,
5915             synaptics_sysctl, "I",
5916             "Maximum finger width to detect palm");
5917
5918         /* hw.psm.synaptics.top_margin. */
5919         sc->syninfo.margin_top = 200;
5920         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5921             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5922             "margin_top",
5923             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5924             sc, SYNAPTICS_SYSCTL_MARGIN_TOP,
5925             synaptics_sysctl, "I",
5926             "Top margin");
5927
5928         /* hw.psm.synaptics.right_margin. */
5929         sc->syninfo.margin_right = 200;
5930         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5931             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5932             "margin_right",
5933             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5934             sc, SYNAPTICS_SYSCTL_MARGIN_RIGHT,
5935             synaptics_sysctl, "I",
5936             "Right margin");
5937
5938         /* hw.psm.synaptics.bottom_margin. */
5939         sc->syninfo.margin_bottom = 200;
5940         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5941             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5942             "margin_bottom",
5943             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5944             sc, SYNAPTICS_SYSCTL_MARGIN_BOTTOM,
5945             synaptics_sysctl, "I",
5946             "Bottom margin");
5947
5948         /* hw.psm.synaptics.left_margin. */
5949         sc->syninfo.margin_left = 200;
5950         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5951             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5952             "margin_left",
5953             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5954             sc, SYNAPTICS_SYSCTL_MARGIN_LEFT,
5955             synaptics_sysctl, "I",
5956             "Left margin");
5957
5958         /* hw.psm.synaptics.na_top. */
5959         sc->syninfo.na_top = 1783;
5960         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5961             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5962             "na_top",
5963             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5964             sc, SYNAPTICS_SYSCTL_NA_TOP,
5965             synaptics_sysctl, "I",
5966             "Top noisy area, where weight_previous_na is used instead "
5967             "of weight_previous");
5968
5969         /* hw.psm.synaptics.na_right. */
5970         sc->syninfo.na_right = 563;
5971         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5972             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5973             "na_right",
5974             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5975             sc, SYNAPTICS_SYSCTL_NA_RIGHT,
5976             synaptics_sysctl, "I",
5977             "Right noisy area, where weight_previous_na is used instead "
5978             "of weight_previous");
5979
5980         /* hw.psm.synaptics.na_bottom. */
5981         sc->syninfo.na_bottom = 1408;
5982         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5983             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5984             "na_bottom",
5985             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5986             sc, SYNAPTICS_SYSCTL_NA_BOTTOM,
5987             synaptics_sysctl, "I",
5988             "Bottom noisy area, where weight_previous_na is used instead "
5989             "of weight_previous");
5990
5991         /* hw.psm.synaptics.na_left. */
5992         sc->syninfo.na_left = 1600;
5993         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
5994             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
5995             "na_left",
5996             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
5997             sc, SYNAPTICS_SYSCTL_NA_LEFT,
5998             synaptics_sysctl, "I",
5999             "Left noisy area, where weight_previous_na is used instead "
6000             "of weight_previous");
6001
6002         /* hw.psm.synaptics.window_min. */
6003         sc->syninfo.window_min = 4;
6004         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6005             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6006             "window_min",
6007             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6008             sc, SYNAPTICS_SYSCTL_WINDOW_MIN,
6009             synaptics_sysctl, "I",
6010             "Minimum window size to start an action");
6011
6012         /* hw.psm.synaptics.window_max. */
6013         sc->syninfo.window_max = 10;
6014         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6015             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6016             "window_max",
6017             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6018             sc, SYNAPTICS_SYSCTL_WINDOW_MAX,
6019             synaptics_sysctl, "I",
6020             "Maximum window size");
6021
6022         /* hw.psm.synaptics.multiplicator. */
6023         sc->syninfo.multiplicator = 10000;
6024         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6025             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6026             "multiplicator",
6027             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6028             sc, SYNAPTICS_SYSCTL_MULTIPLICATOR,
6029             synaptics_sysctl, "I",
6030             "Multiplicator to increase precision in averages and divisions");
6031
6032         /* hw.psm.synaptics.weight_current. */
6033         sc->syninfo.weight_current = 3;
6034         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6035             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6036             "weight_current",
6037             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6038             sc, SYNAPTICS_SYSCTL_WEIGHT_CURRENT,
6039             synaptics_sysctl, "I",
6040             "Weight of the current movement in the new average");
6041
6042         /* hw.psm.synaptics.weight_previous. */
6043         sc->syninfo.weight_previous = 6;
6044         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6045             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6046             "weight_previous",
6047             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6048             sc, SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS,
6049             synaptics_sysctl, "I",
6050             "Weight of the previous average");
6051
6052         /* hw.psm.synaptics.weight_previous_na. */
6053         sc->syninfo.weight_previous_na = 20;
6054         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6055             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6056             "weight_previous_na",
6057             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6058             sc, SYNAPTICS_SYSCTL_WEIGHT_PREVIOUS_NA,
6059             synaptics_sysctl, "I",
6060             "Weight of the previous average (inside the noisy area)");
6061
6062         /* hw.psm.synaptics.weight_len_squared. */
6063         sc->syninfo.weight_len_squared = 2000;
6064         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6065             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6066             "weight_len_squared",
6067             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6068             sc, SYNAPTICS_SYSCTL_WEIGHT_LEN_SQUARED,
6069             synaptics_sysctl, "I",
6070             "Length (squared) of segments where weight_previous "
6071             "starts to decrease");
6072
6073         /* hw.psm.synaptics.div_min. */
6074         sc->syninfo.div_min = 9;
6075         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6076             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6077             "div_min",
6078             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6079             sc, SYNAPTICS_SYSCTL_DIV_MIN,
6080             synaptics_sysctl, "I",
6081             "Divisor for fast movements");
6082
6083         /* hw.psm.synaptics.div_max. */
6084         sc->syninfo.div_max = 17;
6085         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6086             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6087             "div_max",
6088             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6089             sc, SYNAPTICS_SYSCTL_DIV_MAX,
6090             synaptics_sysctl, "I",
6091             "Divisor for slow movements");
6092
6093         /* hw.psm.synaptics.div_max_na. */
6094         sc->syninfo.div_max_na = 30;
6095         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6096             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6097             "div_max_na",
6098             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6099             sc, SYNAPTICS_SYSCTL_DIV_MAX_NA,
6100             synaptics_sysctl, "I",
6101             "Divisor with slow movements (inside the noisy area)");
6102
6103         /* hw.psm.synaptics.div_len. */
6104         sc->syninfo.div_len = 100;
6105         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6106             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6107             "div_len",
6108             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6109             sc, SYNAPTICS_SYSCTL_DIV_LEN,
6110             synaptics_sysctl, "I",
6111             "Length of segments where div_max starts to decrease");
6112
6113         /* hw.psm.synaptics.tap_max_delta. */
6114         sc->syninfo.tap_max_delta = 80;
6115         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6116             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6117             "tap_max_delta",
6118             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6119             sc, SYNAPTICS_SYSCTL_TAP_MAX_DELTA,
6120             synaptics_sysctl, "I",
6121             "Length of segments above which a tap is ignored");
6122
6123         /* hw.psm.synaptics.tap_min_queue. */
6124         sc->syninfo.tap_min_queue = 2;
6125         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6126             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6127             "tap_min_queue",
6128             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6129             sc, SYNAPTICS_SYSCTL_TAP_MIN_QUEUE,
6130             synaptics_sysctl, "I",
6131             "Number of packets required to consider a tap");
6132
6133         /* hw.psm.synaptics.taphold_timeout. */
6134         sc->gesture.in_taphold = 0;
6135         sc->syninfo.taphold_timeout = tap_timeout;
6136         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6137             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6138             "taphold_timeout",
6139             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6140             sc, SYNAPTICS_SYSCTL_TAPHOLD_TIMEOUT,
6141             synaptics_sysctl, "I",
6142             "Maximum elapsed time between two taps to consider a tap-hold "
6143             "action");
6144
6145         /* hw.psm.synaptics.vscroll_hor_area. */
6146         sc->syninfo.vscroll_hor_area = 0; /* 1300 */
6147         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6148             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6149             "vscroll_hor_area",
6150             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6151             sc, SYNAPTICS_SYSCTL_VSCROLL_HOR_AREA,
6152             synaptics_sysctl, "I",
6153             "Area reserved for horizontal virtual scrolling");
6154
6155         /* hw.psm.synaptics.vscroll_ver_area. */
6156         sc->syninfo.vscroll_ver_area = -400 - sc->syninfo.margin_right;
6157         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6158             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6159             "vscroll_ver_area",
6160             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6161             sc, SYNAPTICS_SYSCTL_VSCROLL_VER_AREA,
6162             synaptics_sysctl, "I",
6163             "Area reserved for vertical virtual scrolling");
6164
6165         /* hw.psm.synaptics.vscroll_min_delta. */
6166         sc->syninfo.vscroll_min_delta = 50;
6167         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6168             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6169             "vscroll_min_delta",
6170             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6171             sc, SYNAPTICS_SYSCTL_VSCROLL_MIN_DELTA,
6172             synaptics_sysctl, "I",
6173             "Minimum movement to consider virtual scrolling");
6174
6175         /* hw.psm.synaptics.vscroll_div_min. */
6176         sc->syninfo.vscroll_div_min = 100;
6177         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6178             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6179             "vscroll_div_min",
6180             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6181             sc, SYNAPTICS_SYSCTL_VSCROLL_DIV_MIN,
6182             synaptics_sysctl, "I",
6183             "Divisor for fast scrolling");
6184
6185         /* hw.psm.synaptics.vscroll_div_min. */
6186         sc->syninfo.vscroll_div_max = 150;
6187         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6188             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6189             "vscroll_div_max",
6190             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6191             sc, SYNAPTICS_SYSCTL_VSCROLL_DIV_MAX,
6192             synaptics_sysctl, "I",
6193             "Divisor for slow scrolling");
6194
6195         /* hw.psm.synaptics.touchpad_off. */
6196         sc->syninfo.touchpad_off = 0;
6197         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6198             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6199             "touchpad_off",
6200             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6201             sc, SYNAPTICS_SYSCTL_TOUCHPAD_OFF,
6202             synaptics_sysctl, "I",
6203             "Turn off touchpad");
6204
6205         sc->syninfo.three_finger_drag = 0;
6206         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6207             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6208             "three_finger_drag",
6209             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6210             sc, SYNAPTICS_SYSCTL_THREE_FINGER_DRAG,
6211             synaptics_sysctl, "I",
6212             "Enable dragging with three fingers");
6213
6214         /* hw.psm.synaptics.natural_scroll. */
6215         sc->syninfo.natural_scroll = 0;
6216         SYSCTL_ADD_PROC(&sc->syninfo.sysctl_ctx,
6217             SYSCTL_CHILDREN(sc->syninfo.sysctl_tree), OID_AUTO,
6218             "natural_scroll",
6219             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6220             sc, SYNAPTICS_SYSCTL_NATURAL_SCROLL,
6221             synaptics_sysctl, "I",
6222             "Enable natural scrolling");
6223
6224         sc->syninfo.softbuttons_y = 0;
6225         sc->syninfo.softbutton2_x = 0;
6226         sc->syninfo.softbutton3_x = 0;
6227
6228         /* skip softbuttons sysctl on not clickpads */
6229         if (sc->synhw.capClickPad)
6230                 synaptics_sysctl_create_softbuttons_tree(sc);
6231 }
6232
6233 static int
6234 synaptics_preferred_mode(struct psm_softc *sc) {
6235         int mode_byte;
6236
6237         /* Check if we are in relative mode */
6238         if (sc->hw.model != MOUSE_MODEL_SYNAPTICS) {
6239                 if (tap_enabled == 0)
6240                         /*
6241                          * Disable tap & drag gestures. We use a Mode Byte
6242                          * and set the DisGest bit (see §2.5 of Synaptics
6243                          * TouchPad Interfacing Guide).
6244                          */
6245                         return (0x04);
6246                 else
6247                         /*
6248                          * Enable tap & drag gestures. We use a Mode Byte
6249                          * and clear the DisGest bit (see §2.5 of Synaptics
6250                          * TouchPad Interfacing Guide).
6251                          */
6252                         return (0x00);
6253         }
6254
6255         mode_byte = 0xc4;
6256
6257         /* request wmode where available */
6258         if (sc->synhw.capExtended)
6259                 mode_byte |= 1;
6260
6261         return mode_byte;
6262 }
6263
6264 static void
6265 synaptics_set_mode(struct psm_softc *sc, int mode_byte) {
6266         mouse_ext_command(sc->kbdc, mode_byte);
6267
6268         /* "Commit" the Set Mode Byte command sent above. */
6269         set_mouse_sampling_rate(sc->kbdc, 20);
6270
6271         /*
6272          * Enable advanced gestures mode if supported and we are not entering
6273          * passthrough or relative mode.
6274          */
6275         if ((sc->synhw.capAdvancedGestures || sc->synhw.capReportsV) &&
6276             sc->hw.model == MOUSE_MODEL_SYNAPTICS && !(mode_byte & (1 << 5))) {
6277                 mouse_ext_command(sc->kbdc, SYNAPTICS_READ_MODEL_ID);
6278                 set_mouse_sampling_rate(sc->kbdc, 0xc8);
6279         }
6280 }
6281
6282 /*
6283  * AUX MUX detection code should be placed at very beginning of probe sequence
6284  * at least before 4-byte protocol mouse probes e.g. MS IntelliMouse probe as
6285  * latter can trigger switching the MUX to incompatible state.
6286  */
6287 static int
6288 enable_synaptics_mux(struct psm_softc *sc, enum probearg arg)
6289 {
6290         KBDC kbdc = sc->kbdc;
6291         int port, version;
6292         int probe = FALSE;
6293         int active_ports_count = 0;
6294         int active_ports_mask = 0;
6295
6296         version = enable_aux_mux(kbdc);
6297         if (version == -1)
6298                 return (FALSE);
6299
6300         for (port = 0; port < KBDC_AUX_MUX_NUM_PORTS; port++) {
6301                 VLOG(3, (LOG_DEBUG, "aux_mux: ping port %d\n", port));
6302                 set_active_aux_mux_port(kbdc, port);
6303                 if (enable_aux_dev(kbdc) && disable_aux_dev(kbdc)) {
6304                         active_ports_count++;
6305                         active_ports_mask |= 1 << port;
6306                 }
6307         }
6308
6309         if (verbose >= 2)
6310                 printf("Active Multiplexing PS/2 controller v%d.%d with %d "
6311                     "active port(s)\n", version >> 4 & 0x0f, version & 0x0f,
6312                     active_ports_count);
6313
6314         /* psm has a special support for GenMouse + SynTouchpad combination */
6315         if (active_ports_count >= 2) {
6316                 for (port = 0; port < KBDC_AUX_MUX_NUM_PORTS; port++) {
6317                         if ((active_ports_mask & 1 << port) == 0)
6318                                 continue;
6319                         VLOG(3, (LOG_DEBUG, "aux_mux: probe port %d\n", port));
6320                         set_active_aux_mux_port(kbdc, port);
6321                         probe = enable_synaptics(sc, arg);
6322                         if (probe) {
6323                                 if (arg == PROBE)
6324                                         sc->muxport = port;
6325                                 break;
6326                         }
6327                 }
6328         }
6329
6330         /* IRQ handler does not support active multiplexing mode */
6331         disable_aux_mux(kbdc);
6332
6333         return (probe);
6334 }
6335
6336 static int
6337 enable_synaptics(struct psm_softc *sc, enum probearg arg)
6338 {
6339         device_t psmcpnp;
6340         struct psmcpnp_softc *psmcpnp_sc;
6341         KBDC kbdc = sc->kbdc;
6342         synapticshw_t synhw;
6343         int status[3];
6344         int buttons;
6345
6346         VLOG(3, (LOG_DEBUG, "synaptics: BEGIN init\n"));
6347
6348         /*
6349          * Just to be on the safe side: this avoids troubles with
6350          * following mouse_ext_command() when the previous command
6351          * was PSMC_SET_RESOLUTION. Set Scaling has no effect on
6352          * Synaptics Touchpad behaviour.
6353          */
6354         set_mouse_scaling(kbdc, 1);
6355
6356         /* Identify the Touchpad version. */
6357         if (mouse_ext_command(kbdc, SYNAPTICS_READ_IDENTITY) == 0)
6358                 return (FALSE);
6359         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6360                 return (FALSE);
6361         if (status[1] != 0x47)
6362                 return (FALSE);
6363
6364         bzero(&synhw, sizeof(synhw));
6365         synhw.infoMinor = status[0];
6366         synhw.infoMajor = status[2] & 0x0f;
6367
6368         if (verbose >= 2)
6369                 printf("Synaptics Touchpad v%d.%d\n", synhw.infoMajor,
6370                     synhw.infoMinor);
6371
6372         if (synhw.infoMajor < 4) {
6373                 printf("  Unsupported (pre-v4) Touchpad detected\n");
6374                 return (FALSE);
6375         }
6376
6377         /* Get the Touchpad model information. */
6378         if (mouse_ext_command(kbdc, SYNAPTICS_READ_MODEL_ID) == 0)
6379                 return (FALSE);
6380         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6381                 return (FALSE);
6382         if ((status[1] & 0x01) != 0) {
6383                 printf("  Failed to read model information\n");
6384                 return (FALSE);
6385         }
6386
6387         synhw.infoRot180   = (status[0] & 0x80) != 0;
6388         synhw.infoPortrait = (status[0] & 0x40) != 0;
6389         synhw.infoSensor   =  status[0] & 0x3f;
6390         synhw.infoHardware = (status[1] & 0xfe) >> 1;
6391         synhw.infoNewAbs   = (status[2] & 0x80) != 0;
6392         synhw.capPen       = (status[2] & 0x40) != 0;
6393         synhw.infoSimplC   = (status[2] & 0x20) != 0;
6394         synhw.infoGeometry =  status[2] & 0x0f;
6395
6396         if (verbose >= 2) {
6397                 printf("  Model information:\n");
6398                 printf("   infoRot180: %d\n", synhw.infoRot180);
6399                 printf("   infoPortrait: %d\n", synhw.infoPortrait);
6400                 printf("   infoSensor: %d\n", synhw.infoSensor);
6401                 printf("   infoHardware: %d\n", synhw.infoHardware);
6402                 printf("   infoNewAbs: %d\n", synhw.infoNewAbs);
6403                 printf("   capPen: %d\n", synhw.capPen);
6404                 printf("   infoSimplC: %d\n", synhw.infoSimplC);
6405                 printf("   infoGeometry: %d\n", synhw.infoGeometry);
6406         }
6407
6408         /* Read the extended capability bits. */
6409         if (mouse_ext_command(kbdc, SYNAPTICS_READ_CAPABILITIES) == 0)
6410                 return (FALSE);
6411         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6412                 return (FALSE);
6413         if (!SYNAPTICS_VERSION_GE(synhw, 7, 5) && status[1] != 0x47) {
6414                 printf("  Failed to read extended capability bits\n");
6415                 return (FALSE);
6416         }
6417
6418         psmcpnp = devclass_get_device(devclass_find(PSMCPNP_DRIVER_NAME),
6419             sc->unit);
6420         psmcpnp_sc = (psmcpnp != NULL) ? device_get_softc(psmcpnp) : NULL;
6421
6422         /* Set the different capabilities when they exist. */
6423         buttons = 0;
6424         synhw.capExtended = (status[0] & 0x80) != 0;
6425         if (synhw.capExtended) {
6426                 synhw.nExtendedQueries = (status[0] & 0x70) >> 4;
6427                 synhw.capMiddle        = (status[0] & 0x04) != 0;
6428                 synhw.capPassthrough   = (status[2] & 0x80) != 0;
6429                 synhw.capLowPower      = (status[2] & 0x40) != 0;
6430                 synhw.capMultiFingerReport =
6431                                          (status[2] & 0x20) != 0;
6432                 synhw.capSleep         = (status[2] & 0x10) != 0;
6433                 synhw.capFourButtons   = (status[2] & 0x08) != 0;
6434                 synhw.capBallistics    = (status[2] & 0x04) != 0;
6435                 synhw.capMultiFinger   = (status[2] & 0x02) != 0;
6436                 synhw.capPalmDetect    = (status[2] & 0x01) != 0;
6437
6438                 if (!set_mouse_scaling(kbdc, 1))
6439                         return (FALSE);
6440                 if (mouse_ext_command(kbdc, SYNAPTICS_READ_RESOLUTIONS) == 0)
6441                         return (FALSE);
6442                 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6443                         return (FALSE);
6444
6445                 if (status[0] != 0 && (status[1] & 0x80) && status[2] != 0) {
6446                         synhw.infoXupmm = status[0];
6447                         synhw.infoYupmm = status[2];
6448                 }
6449
6450                 if (verbose >= 2) {
6451                         printf("  Extended capabilities:\n");
6452                         printf("   capExtended: %d\n", synhw.capExtended);
6453                         printf("   capMiddle: %d\n", synhw.capMiddle);
6454                         printf("   nExtendedQueries: %d\n",
6455                             synhw.nExtendedQueries);
6456                         printf("   capPassthrough: %d\n", synhw.capPassthrough);
6457                         printf("   capLowPower: %d\n", synhw.capLowPower);
6458                         printf("   capMultiFingerReport: %d\n",
6459                             synhw.capMultiFingerReport);
6460                         printf("   capSleep: %d\n", synhw.capSleep);
6461                         printf("   capFourButtons: %d\n", synhw.capFourButtons);
6462                         printf("   capBallistics: %d\n", synhw.capBallistics);
6463                         printf("   capMultiFinger: %d\n", synhw.capMultiFinger);
6464                         printf("   capPalmDetect: %d\n", synhw.capPalmDetect);
6465                         printf("   infoXupmm: %d\n", synhw.infoXupmm);
6466                         printf("   infoYupmm: %d\n", synhw.infoYupmm);
6467                 }
6468
6469                 /*
6470                  * If nExtendedQueries is 1 or greater, then the TouchPad
6471                  * supports this number of extended queries. We can load
6472                  * more information about buttons using query 0x09.
6473                  */
6474                 if (synhw.nExtendedQueries >= 1) {
6475                         if (!set_mouse_scaling(kbdc, 1))
6476                                 return (FALSE);
6477                         if (mouse_ext_command(kbdc,
6478                             SYNAPTICS_READ_EXTENDED) == 0)
6479                                 return (FALSE);
6480                         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6481                                 return (FALSE);
6482                         synhw.verticalScroll   = (status[0] & 0x01) != 0;
6483                         synhw.horizontalScroll = (status[0] & 0x02) != 0;
6484                         synhw.verticalWheel    = (status[0] & 0x08) != 0;
6485                         synhw.nExtendedButtons = (status[1] & 0xf0) >> 4;
6486                         synhw.capEWmode        = (status[0] & 0x04) != 0;
6487                         if (verbose >= 2) {
6488                                 printf("  Extended model ID:\n");
6489                                 printf("   verticalScroll: %d\n",
6490                                     synhw.verticalScroll);
6491                                 printf("   horizontalScroll: %d\n",
6492                                     synhw.horizontalScroll);
6493                                 printf("   verticalWheel: %d\n",
6494                                     synhw.verticalWheel);
6495                                 printf("   nExtendedButtons: %d\n",
6496                                     synhw.nExtendedButtons);
6497                                 printf("   capEWmode: %d\n",
6498                                     synhw.capEWmode);
6499                         }
6500                         /*
6501                          * Add the number of extended buttons to the total
6502                          * button support count, including the middle button
6503                          * if capMiddle support bit is set.
6504                          */
6505                         buttons = synhw.nExtendedButtons + synhw.capMiddle;
6506                 } else
6507                         /*
6508                          * If the capFourButtons support bit is set,
6509                          * add a fourth button to the total button count.
6510                          */
6511                         buttons = synhw.capFourButtons ? 1 : 0;
6512
6513                 /* Read the continued capabilities bits. */
6514                 if (synhw.nExtendedQueries >= 4) {
6515                         if (!set_mouse_scaling(kbdc, 1))
6516                                 return (FALSE);
6517                         if (mouse_ext_command(kbdc,
6518                             SYNAPTICS_READ_CAPABILITIES_CONT) == 0)
6519                                 return (FALSE);
6520                         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6521                                 return (FALSE);
6522
6523                         synhw.capClickPad         = (status[1] & 0x01) << 1;
6524                         synhw.capClickPad        |= (status[0] & 0x10) != 0;
6525                         synhw.capDeluxeLEDs       = (status[1] & 0x02) != 0;
6526                         synhw.noAbsoluteFilter    = (status[1] & 0x04) != 0;
6527                         synhw.capReportsV         = (status[1] & 0x08) != 0;
6528                         synhw.capUniformClickPad  = (status[1] & 0x10) != 0;
6529                         synhw.capReportsMin       = (status[1] & 0x20) != 0;
6530                         synhw.capInterTouch       = (status[1] & 0x40) != 0;
6531                         synhw.capReportsMax       = (status[0] & 0x02) != 0;
6532                         synhw.capClearPad         = (status[0] & 0x04) != 0;
6533                         synhw.capAdvancedGestures = (status[0] & 0x08) != 0;
6534                         synhw.capCoveredPad       = (status[0] & 0x80) != 0;
6535
6536                         if (synhw.capReportsMax) {
6537                                 if (!set_mouse_scaling(kbdc, 1))
6538                                         return (FALSE);
6539                                 if (mouse_ext_command(kbdc,
6540                                     SYNAPTICS_READ_MAX_COORDS) == 0)
6541                                         return (FALSE);
6542                                 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6543                                         return (FALSE);
6544
6545                                 synhw.maximumXCoord = (status[0] << 5) |
6546                                                      ((status[1] & 0x0f) << 1);
6547                                 synhw.maximumYCoord = (status[2] << 5) |
6548                                                      ((status[1] & 0xf0) >> 3);
6549                         } else {
6550                                 /*
6551                                  * Typical bezel limits. Taken from 'Synaptics
6552                                  * PS/2 * TouchPad Interfacing Guide' p.3.2.3.
6553                                  */
6554                                 synhw.maximumXCoord = 5472;
6555                                 synhw.maximumYCoord = 4448;
6556                         }
6557
6558                         if (synhw.capReportsMin) {
6559                                 if (!set_mouse_scaling(kbdc, 1))
6560                                         return (FALSE);
6561                                 if (mouse_ext_command(kbdc,
6562                                     SYNAPTICS_READ_MIN_COORDS) == 0)
6563                                         return (FALSE);
6564                                 if (get_mouse_status(kbdc, status, 0, 3) != 3)
6565                                         return (FALSE);
6566
6567                                 synhw.minimumXCoord = (status[0] << 5) |
6568                                                      ((status[1] & 0x0f) << 1);
6569                                 synhw.minimumYCoord = (status[2] << 5) |
6570                                                      ((status[1] & 0xf0) >> 3);
6571                         } else {
6572                                 /*
6573                                  * Typical bezel limits. Taken from 'Synaptics
6574                                  * PS/2 * TouchPad Interfacing Guide' p.3.2.3.
6575                                  */
6576                                 synhw.minimumXCoord = 1472;
6577                                 synhw.minimumYCoord = 1408;
6578                         }
6579
6580                         /*
6581                          * ClickPad properties are not exported through PS/2
6582                          * protocol. Detection is based on controller's PnP ID.
6583                          */
6584                         if (synhw.capClickPad && psmcpnp_sc != NULL) {
6585                                 switch (psmcpnp_sc->type) {
6586                                 case PSMCPNP_FORCEPAD:
6587                                         synhw.forcePad = 1;
6588                                         break;
6589                                 case PSMCPNP_TOPBUTTONPAD:
6590                                         synhw.topButtonPad = 1;
6591                                         break;
6592                                 default:
6593                                         break;
6594                                 }
6595                         }
6596
6597                         if (verbose >= 2) {
6598                                 printf("  Continued capabilities:\n");
6599                                 printf("   capClickPad: %d\n",
6600                                        synhw.capClickPad);
6601                                 printf("   capDeluxeLEDs: %d\n",
6602                                        synhw.capDeluxeLEDs);
6603                                 printf("   noAbsoluteFilter: %d\n",
6604                                        synhw.noAbsoluteFilter);
6605                                 printf("   capReportsV: %d\n",
6606                                        synhw.capReportsV);
6607                                 printf("   capUniformClickPad: %d\n",
6608                                        synhw.capUniformClickPad);
6609                                 printf("   capReportsMin: %d\n",
6610                                        synhw.capReportsMin);
6611                                 printf("   capInterTouch: %d\n",
6612                                        synhw.capInterTouch);
6613                                 printf("   capReportsMax: %d\n",
6614                                        synhw.capReportsMax);
6615                                 printf("   capClearPad: %d\n",
6616                                        synhw.capClearPad);
6617                                 printf("   capAdvancedGestures: %d\n",
6618                                        synhw.capAdvancedGestures);
6619                                 printf("   capCoveredPad: %d\n",
6620                                        synhw.capCoveredPad);
6621                                 if (synhw.capReportsMax) {
6622                                         printf("   maximumXCoord: %d\n",
6623                                                synhw.maximumXCoord);
6624                                         printf("   maximumYCoord: %d\n",
6625                                                synhw.maximumYCoord);
6626                                 }
6627                                 if (synhw.capReportsMin) {
6628                                         printf("   minimumXCoord: %d\n",
6629                                                synhw.minimumXCoord);
6630                                         printf("   minimumYCoord: %d\n",
6631                                                synhw.minimumYCoord);
6632                                 }
6633                                 if (synhw.capClickPad) {
6634                                         printf("  Clickpad capabilities:\n");
6635                                         printf("   forcePad: %d\n",
6636                                                synhw.forcePad);
6637                                         printf("   topButtonPad: %d\n",
6638                                                synhw.topButtonPad);
6639                                 }
6640                         }
6641                         buttons += synhw.capClickPad;
6642                 }
6643         }
6644
6645         if (verbose >= 2) {
6646                 if (synhw.capExtended)
6647                         printf("  Additional Buttons: %d\n", buttons);
6648                 else
6649                         printf("  No extended capabilities\n");
6650         }
6651
6652         /*
6653          * Add the default number of 3 buttons to the total
6654          * count of supported buttons reported above.
6655          */
6656         buttons += 3;
6657
6658         /*
6659          * Read the mode byte.
6660          *
6661          * XXX: Note the Synaptics documentation also defines the first
6662          * byte of the response to this query to be a constant 0x3b, this
6663          * does not appear to be true for Touchpads with guest devices.
6664          */
6665         if (mouse_ext_command(kbdc, SYNAPTICS_READ_MODES) == 0)
6666                 return (FALSE);
6667         if (get_mouse_status(kbdc, status, 0, 3) != 3)
6668                 return (FALSE);
6669         if (!SYNAPTICS_VERSION_GE(synhw, 7, 5) && status[1] != 0x47) {
6670                 printf("  Failed to read mode byte\n");
6671                 return (FALSE);
6672         }
6673
6674         if (arg == PROBE)
6675                 sc->synhw = synhw;
6676         if (!synaptics_support)
6677                 return (FALSE);
6678
6679         /* Set mouse type just now for synaptics_set_mode() */
6680         sc->hw.model = MOUSE_MODEL_SYNAPTICS;
6681
6682         synaptics_set_mode(sc, synaptics_preferred_mode(sc));
6683
6684         if (trackpoint_support && synhw.capPassthrough) {
6685                 enable_trackpoint(sc, arg);
6686         }
6687
6688         VLOG(3, (LOG_DEBUG, "synaptics: END init (%d buttons)\n", buttons));
6689
6690         if (arg == PROBE) {
6691                 /* Create sysctl tree. */
6692                 synaptics_sysctl_create_tree(sc, "synaptics",
6693                     "Synaptics TouchPad");
6694                 sc->hw.buttons = buttons;
6695         }
6696
6697         return (TRUE);
6698 }
6699
6700 static void
6701 synaptics_passthrough_on(struct psm_softc *sc)
6702 {
6703         VLOG(2, (LOG_NOTICE, "psm: setting pass-through mode.\n"));
6704         synaptics_set_mode(sc, synaptics_preferred_mode(sc) | (1 << 5));
6705 }
6706
6707 static void
6708 synaptics_passthrough_off(struct psm_softc *sc)
6709 {
6710         VLOG(2, (LOG_NOTICE, "psm: turning pass-through mode off.\n"));
6711         set_mouse_scaling(sc->kbdc, 2);
6712         set_mouse_scaling(sc->kbdc, 1);
6713         synaptics_set_mode(sc, synaptics_preferred_mode(sc));
6714 }
6715
6716 /* IBM/Lenovo TrackPoint */
6717 static int
6718 trackpoint_command(struct psm_softc *sc, int cmd, int loc, int val)
6719 {
6720         const int seq[] = { 0xe2, cmd, loc, val };
6721         int i;
6722
6723         if (sc->synhw.capPassthrough)
6724                 synaptics_passthrough_on(sc);
6725
6726         for (i = 0; i < nitems(seq); i++) {
6727                 if (sc->synhw.capPassthrough &&
6728                     (seq[i] == 0xff || seq[i] == 0xe7))
6729                         if (send_aux_command(sc->kbdc, 0xe7) != PSM_ACK) {
6730                                 synaptics_passthrough_off(sc);
6731                                 return (EIO);
6732                         }
6733                 if (send_aux_command(sc->kbdc, seq[i]) != PSM_ACK) {
6734                         if (sc->synhw.capPassthrough)
6735                                 synaptics_passthrough_off(sc);
6736                         return (EIO);
6737                 }
6738         }
6739
6740         if (sc->synhw.capPassthrough)
6741                 synaptics_passthrough_off(sc);
6742
6743         return (0);
6744 }
6745
6746 #define PSM_TPINFO(x)   offsetof(struct psm_softc, tpinfo.x)
6747 #define TPMASK          0
6748 #define TPLOC           1
6749 #define TPINFO          2
6750
6751 static int
6752 trackpoint_sysctl(SYSCTL_HANDLER_ARGS)
6753 {
6754         static const int data[][3] = {
6755                 { 0x00, 0x4a, PSM_TPINFO(sensitivity) },
6756                 { 0x00, 0x4d, PSM_TPINFO(inertia) },
6757                 { 0x00, 0x60, PSM_TPINFO(uplateau) },
6758                 { 0x00, 0x57, PSM_TPINFO(reach) },
6759                 { 0x00, 0x58, PSM_TPINFO(draghys) },
6760                 { 0x00, 0x59, PSM_TPINFO(mindrag) },
6761                 { 0x00, 0x5a, PSM_TPINFO(upthresh) },
6762                 { 0x00, 0x5c, PSM_TPINFO(threshold) },
6763                 { 0x00, 0x5d, PSM_TPINFO(jenks) },
6764                 { 0x00, 0x5e, PSM_TPINFO(ztime) },
6765                 { 0x01, 0x2c, PSM_TPINFO(pts) },
6766                 { 0x08, 0x2d, PSM_TPINFO(skipback) }
6767         };
6768         struct psm_softc *sc;
6769         int error, newval, *oldvalp;
6770         const int *tp;
6771
6772         if (arg1 == NULL || arg2 < 0 || arg2 >= nitems(data))
6773                 return (EINVAL);
6774         sc = arg1;
6775         tp = data[arg2];
6776         oldvalp = (int *)((intptr_t)sc + tp[TPINFO]);
6777         newval = *oldvalp;
6778         error = sysctl_handle_int(oidp, &newval, 0, req);
6779         if (error != 0)
6780                 return (error);
6781         if (newval == *oldvalp)
6782                 return (0);
6783         if (newval < 0 || newval > (tp[TPMASK] == 0 ? 255 : 1))
6784                 return (EINVAL);
6785         error = trackpoint_command(sc, tp[TPMASK] == 0 ? 0x81 : 0x47,
6786             tp[TPLOC], tp[TPMASK] == 0 ? newval : tp[TPMASK]);
6787         if (error != 0)
6788                 return (error);
6789         *oldvalp = newval;
6790
6791         return (0);
6792 }
6793
6794 static void
6795 trackpoint_sysctl_create_tree(struct psm_softc *sc)
6796 {
6797
6798         if (sc->tpinfo.sysctl_tree != NULL)
6799                 return;
6800
6801         /* Attach extra trackpoint sysctl nodes under hw.psm.trackpoint */
6802         sysctl_ctx_init(&sc->tpinfo.sysctl_ctx);
6803         sc->tpinfo.sysctl_tree = SYSCTL_ADD_NODE(&sc->tpinfo.sysctl_ctx,
6804             SYSCTL_STATIC_CHILDREN(_hw_psm), OID_AUTO, "trackpoint",
6805             CTLFLAG_RD | CTLFLAG_MPSAFE, 0, "IBM/Lenovo TrackPoint");
6806
6807         /* hw.psm.trackpoint.sensitivity */
6808         sc->tpinfo.sensitivity = 0x80;
6809         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6810             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6811             "sensitivity",
6812             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6813             sc, TRACKPOINT_SYSCTL_SENSITIVITY,
6814             trackpoint_sysctl, "I",
6815             "Sensitivity");
6816
6817         /* hw.psm.trackpoint.negative_inertia */
6818         sc->tpinfo.inertia = 0x06;
6819         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6820             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6821             "negative_inertia",
6822             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6823             sc, TRACKPOINT_SYSCTL_NEGATIVE_INERTIA,
6824             trackpoint_sysctl, "I",
6825             "Negative inertia factor");
6826
6827         /* hw.psm.trackpoint.upper_plateau */
6828         sc->tpinfo.uplateau = 0x61;
6829         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6830             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6831             "upper_plateau",
6832             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6833             sc, TRACKPOINT_SYSCTL_UPPER_PLATEAU,
6834             trackpoint_sysctl, "I",
6835             "Transfer function upper plateau speed");
6836
6837         /* hw.psm.trackpoint.backup_range */
6838         sc->tpinfo.reach = 0x0a;
6839         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6840             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6841             "backup_range",
6842             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6843             sc, TRACKPOINT_SYSCTL_BACKUP_RANGE,
6844             trackpoint_sysctl, "I",
6845             "Backup range");
6846
6847         /* hw.psm.trackpoint.drag_hysteresis */
6848         sc->tpinfo.draghys = 0xff;
6849         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6850             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6851             "drag_hysteresis",
6852             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6853             sc, TRACKPOINT_SYSCTL_DRAG_HYSTERESIS,
6854             trackpoint_sysctl, "I",
6855             "Drag hysteresis");
6856
6857         /* hw.psm.trackpoint.minimum_drag */
6858         sc->tpinfo.mindrag = 0x14;
6859         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6860             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6861             "minimum_drag",
6862             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6863             sc, TRACKPOINT_SYSCTL_MINIMUM_DRAG,
6864             trackpoint_sysctl, "I",
6865             "Minimum drag");
6866
6867         /* hw.psm.trackpoint.up_threshold */
6868         sc->tpinfo.upthresh = 0xff;
6869         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6870             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6871             "up_threshold",
6872             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6873             sc, TRACKPOINT_SYSCTL_UP_THRESHOLD,
6874             trackpoint_sysctl, "I",
6875             "Up threshold for release");
6876
6877         /* hw.psm.trackpoint.threshold */
6878         sc->tpinfo.threshold = 0x08;
6879         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6880             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6881             "threshold",
6882             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6883             sc, TRACKPOINT_SYSCTL_THRESHOLD,
6884             trackpoint_sysctl, "I",
6885             "Threshold");
6886
6887         /* hw.psm.trackpoint.jenks_curvature */
6888         sc->tpinfo.jenks = 0x87;
6889         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6890             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6891             "jenks_curvature",
6892             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6893             sc, TRACKPOINT_SYSCTL_JENKS_CURVATURE,
6894             trackpoint_sysctl, "I",
6895             "Jenks curvature");
6896
6897         /* hw.psm.trackpoint.z_time */
6898         sc->tpinfo.ztime = 0x26;
6899         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6900             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6901             "z_time",
6902             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6903             sc, TRACKPOINT_SYSCTL_Z_TIME,
6904             trackpoint_sysctl, "I",
6905             "Z time constant");
6906
6907         /* hw.psm.trackpoint.press_to_select */
6908         sc->tpinfo.pts = 0x00;
6909         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6910             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6911             "press_to_select",
6912             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6913             sc, TRACKPOINT_SYSCTL_PRESS_TO_SELECT,
6914             trackpoint_sysctl, "I",
6915             "Press to Select");
6916
6917         /* hw.psm.trackpoint.skip_backups */
6918         sc->tpinfo.skipback = 0x00;
6919         SYSCTL_ADD_PROC(&sc->tpinfo.sysctl_ctx,
6920             SYSCTL_CHILDREN(sc->tpinfo.sysctl_tree), OID_AUTO,
6921             "skip_backups",
6922             CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY | CTLFLAG_NEEDGIANT,
6923             sc, TRACKPOINT_SYSCTL_SKIP_BACKUPS,
6924             trackpoint_sysctl, "I",
6925             "Skip backups from drags");
6926 }
6927
6928 static void
6929 set_trackpoint_parameters(struct psm_softc *sc)
6930 {
6931         trackpoint_command(sc, 0x81, 0x4a, sc->tpinfo.sensitivity);
6932         trackpoint_command(sc, 0x81, 0x60, sc->tpinfo.uplateau);
6933         trackpoint_command(sc, 0x81, 0x4d, sc->tpinfo.inertia);
6934         trackpoint_command(sc, 0x81, 0x57, sc->tpinfo.reach);
6935         trackpoint_command(sc, 0x81, 0x58, sc->tpinfo.draghys);
6936         trackpoint_command(sc, 0x81, 0x59, sc->tpinfo.mindrag);
6937         trackpoint_command(sc, 0x81, 0x5a, sc->tpinfo.upthresh);
6938         trackpoint_command(sc, 0x81, 0x5c, sc->tpinfo.threshold);
6939         trackpoint_command(sc, 0x81, 0x5d, sc->tpinfo.jenks);
6940         trackpoint_command(sc, 0x81, 0x5e, sc->tpinfo.ztime);
6941         if (sc->tpinfo.pts == 0x01)
6942                 trackpoint_command(sc, 0x47, 0x2c, 0x01);
6943         if (sc->tpinfo.skipback == 0x01)
6944                 trackpoint_command(sc, 0x47, 0x2d, 0x08);
6945 }
6946
6947 static int
6948 enable_trackpoint(struct psm_softc *sc, enum probearg arg)
6949 {
6950         KBDC kbdc = sc->kbdc;
6951         int id;
6952
6953         /*
6954          * If called from enable_synaptics(), make sure that passthrough
6955          * mode is enabled so we can reach the trackpoint.
6956          * However, passthrough mode must be disabled before setting the
6957          * trackpoint parameters, as rackpoint_command() enables and disables
6958          * passthrough mode on its own.
6959          */
6960         if (sc->synhw.capPassthrough)
6961                 synaptics_passthrough_on(sc);
6962
6963         if (send_aux_command(kbdc, 0xe1) != PSM_ACK ||
6964             read_aux_data(kbdc) != 0x01)
6965                 goto no_trackpoint;
6966         id = read_aux_data(kbdc);
6967         if (id < 0x01)
6968                 goto no_trackpoint;
6969         if (arg == PROBE)
6970                 sc->tphw = id;
6971         if (!trackpoint_support)
6972                 goto no_trackpoint;
6973
6974         if (sc->synhw.capPassthrough)
6975                 synaptics_passthrough_off(sc);
6976
6977         if (arg == PROBE) {
6978                 trackpoint_sysctl_create_tree(sc);
6979                 /*
6980                  * Don't overwrite hwid and buttons when we are
6981                  * a guest device.
6982                  */
6983                 if (!sc->synhw.capPassthrough) {
6984                         sc->hw.hwid = id;
6985                         sc->hw.buttons = 3;
6986                 }
6987         }
6988
6989         set_trackpoint_parameters(sc);
6990
6991         return (TRUE);
6992
6993 no_trackpoint:
6994         if (sc->synhw.capPassthrough)
6995                 synaptics_passthrough_off(sc);
6996
6997         return (FALSE);
6998 }
6999
7000 /* Interlink electronics VersaPad */
7001 static int
7002 enable_versapad(struct psm_softc *sc, enum probearg arg)
7003 {
7004         KBDC kbdc = sc->kbdc;
7005         int data[3];
7006
7007         set_mouse_resolution(kbdc, PSMD_RES_MEDIUM_HIGH); /* set res. 2 */
7008         set_mouse_sampling_rate(kbdc, 100);             /* set rate 100 */
7009         set_mouse_scaling(kbdc, 1);                     /* set scale 1:1 */
7010         set_mouse_scaling(kbdc, 1);                     /* set scale 1:1 */
7011         set_mouse_scaling(kbdc, 1);                     /* set scale 1:1 */
7012         set_mouse_scaling(kbdc, 1);                     /* set scale 1:1 */
7013         if (get_mouse_status(kbdc, data, 0, 3) < 3)     /* get status */
7014                 return (FALSE);
7015         if (data[2] != 0xa || data[1] != 0 )    /* rate == 0xa && res. == 0 */
7016                 return (FALSE);
7017         set_mouse_scaling(kbdc, 1);                     /* set scale 1:1 */
7018
7019         return (TRUE);                          /* PS/2 absolute mode */
7020 }
7021
7022 /* Elantech Touchpad */
7023 static int
7024 elantech_read_1(KBDC kbdc, int hwversion, int reg, int *val)
7025 {
7026         int res, readcmd, retidx;
7027         int resp[3];
7028
7029         readcmd = hwversion == 2 ? ELANTECH_REG_READ : ELANTECH_REG_RDWR;
7030         retidx = hwversion == 4 ? 1 : 0;
7031
7032         res = send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7033         res |= send_aux_command(kbdc, readcmd) != PSM_ACK;
7034         res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7035         res |= send_aux_command(kbdc, reg) != PSM_ACK;
7036         res |= get_mouse_status(kbdc, resp, 0, 3) != 3;
7037
7038         if (res == 0)
7039                 *val = resp[retidx];
7040
7041         return (res);
7042 }
7043
7044 static int
7045 elantech_write_1(KBDC kbdc, int hwversion, int reg, int val)
7046 {
7047         int res, writecmd;
7048
7049         writecmd = hwversion == 2 ? ELANTECH_REG_WRITE : ELANTECH_REG_RDWR;
7050
7051         res = send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7052         res |= send_aux_command(kbdc, writecmd) != PSM_ACK;
7053         res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7054         res |= send_aux_command(kbdc, reg) != PSM_ACK;
7055         if (hwversion == 4) {
7056                 res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7057                 res |= send_aux_command(kbdc, writecmd) != PSM_ACK;
7058         }
7059         res |= send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7060         res |= send_aux_command(kbdc, val) != PSM_ACK;
7061         res |= set_mouse_scaling(kbdc, 1) == 0;
7062
7063         return (res);
7064 }
7065
7066 static int
7067 elantech_cmd(KBDC kbdc, int hwversion, int cmd, int *resp)
7068 {
7069         int res;
7070
7071         if (hwversion == 2) {
7072                 res = set_mouse_scaling(kbdc, 1) == 0;
7073                 res |= mouse_ext_command(kbdc, cmd) == 0;
7074         } else {
7075                 res = send_aux_command(kbdc, ELANTECH_CUSTOM_CMD) != PSM_ACK;
7076                 res |= send_aux_command(kbdc, cmd) != PSM_ACK;
7077         }
7078         res |= get_mouse_status(kbdc, resp, 0, 3) != 3;
7079
7080         return (res);
7081 }
7082
7083 static int
7084 elantech_init(KBDC kbdc, elantechhw_t *elanhw)
7085 {
7086         int i, val, res, hwversion, reg10;
7087
7088         /* set absolute mode */
7089         hwversion = elanhw->hwversion;
7090         reg10 = -1;
7091         switch (hwversion) {
7092         case 2:
7093                 reg10 = elanhw->fwversion == 0x020030 ? 0x54 : 0xc4;
7094                 res = elantech_write_1(kbdc, hwversion, 0x10, reg10);
7095                 if (res)
7096                         break;
7097                 res = elantech_write_1(kbdc, hwversion, 0x11, 0x8A);
7098                 break;
7099         case 3:
7100                 reg10 = 0x0b;
7101                 res = elantech_write_1(kbdc, hwversion, 0x10, reg10);
7102                 break;
7103         case 4:
7104                 res = elantech_write_1(kbdc, hwversion, 0x07, 0x01);
7105                 break;
7106         default:
7107                 res = 1;
7108         }
7109
7110         /* Read back reg 0x10 to ensure hardware is ready. */
7111         if (res == 0 && reg10 >= 0) {
7112                 for (i = 0; i < 5; i++) {
7113                         if (elantech_read_1(kbdc, hwversion, 0x10, &val) == 0)
7114                                 break;
7115                         DELAY(2000);
7116                 }
7117                 if (i == 5)
7118                         res = 1;
7119         }
7120
7121         if (res)
7122                 printf("couldn't set absolute mode\n");
7123
7124         return (res);
7125 }
7126
7127 static void
7128 elantech_init_synaptics(struct psm_softc *sc)
7129 {
7130
7131         /* Set capabilites required by movement smother */
7132         sc->synhw.infoMajor = sc->elanhw.hwversion;
7133         sc->synhw.infoMinor = sc->elanhw.fwversion;
7134         sc->synhw.infoXupmm = sc->elanhw.dpmmx;
7135         sc->synhw.infoYupmm = sc->elanhw.dpmmy;
7136         sc->synhw.verticalScroll = 0;
7137         sc->synhw.nExtendedQueries = 4;
7138         sc->synhw.capExtended = 1;
7139         sc->synhw.capPassthrough = sc->elanhw.hastrackpoint;
7140         sc->synhw.capClickPad = sc->elanhw.isclickpad;
7141         sc->synhw.capMultiFinger = 1;
7142         if (sc->elanhw.issemimt)
7143                 sc->synhw.capAdvancedGestures = 1;
7144         else
7145                 sc->synhw.capReportsV = 1;
7146         sc->synhw.capPalmDetect = 1;
7147         sc->synhw.capPen = 0;
7148         sc->synhw.capReportsMax = 1;
7149         sc->synhw.maximumXCoord = sc->elanhw.sizex;
7150         sc->synhw.maximumYCoord = sc->elanhw.sizey;
7151         sc->synhw.capReportsMin = 1;
7152         sc->synhw.minimumXCoord = 0;
7153         sc->synhw.minimumYCoord = 0;
7154
7155         if (sc->syninfo.sysctl_tree == NULL) {
7156                 synaptics_sysctl_create_tree(sc, "elantech",
7157                     "Elantech Touchpad");
7158
7159                 /*
7160                  * Adjust synaptic smoother tunables
7161                  * 1. Disable finger detection pressure threshold. Unlike
7162                  *    synaptics we assume the finger is acting when packet with
7163                  *    its X&Y arrives not when pressure exceedes some threshold
7164                  * 2. Disable unrelated features like margins and noisy areas
7165                  * 3. Disable virtual scroll areas as 2nd finger is preferable
7166                  * 4. For clickpads set bottom quarter as 42% - 16% - 42% sized
7167                  *    softbuttons
7168                  * 5. Scale down divisors and movement lengths by a factor of 3
7169                  *    where 3 is Synaptics to Elantech (~2200/800) dpi ratio
7170                  */
7171
7172                 /* Set reporting range to be equal touchpad size */
7173                 sc->syninfo.max_x = sc->elanhw.sizex;
7174                 sc->syninfo.max_y = sc->elanhw.sizey;
7175
7176                 /* Disable finger detection pressure threshold */
7177                 sc->syninfo.min_pressure = 1;
7178
7179                 /* Adjust palm width to nearly match synaptics w=10 */
7180                 sc->syninfo.max_width = 7;
7181
7182                 /* Elans often report double & triple taps as single event */
7183                 sc->syninfo.tap_min_queue = 1;
7184
7185                 /* Use full area of touchpad */
7186                 sc->syninfo.margin_top = 0;
7187                 sc->syninfo.margin_right = 0;
7188                 sc->syninfo.margin_bottom = 0;
7189                 sc->syninfo.margin_left = 0;
7190
7191                 /* Disable noisy area */
7192                 sc->syninfo.na_top = 0;
7193                 sc->syninfo.na_right = 0;
7194                 sc->syninfo.na_bottom = 0;
7195                 sc->syninfo.na_left = 0;
7196
7197                 /* Tune divisors and movement lengths */
7198                 sc->syninfo.weight_len_squared = 200;
7199                 sc->syninfo.div_min = 3;
7200                 sc->syninfo.div_max = 6;
7201                 sc->syninfo.div_max_na = 10;
7202                 sc->syninfo.div_len = 30;
7203                 sc->syninfo.tap_max_delta = 25;
7204
7205                 /* Disable virtual scrolling areas and tune its divisors */
7206                 sc->syninfo.vscroll_hor_area = 0;
7207                 sc->syninfo.vscroll_ver_area = 0;
7208                 sc->syninfo.vscroll_min_delta = 15;
7209                 sc->syninfo.vscroll_div_min = 30;
7210                 sc->syninfo.vscroll_div_max = 50;
7211
7212                 /* Set bottom quarter as 42% - 16% - 42% sized softbuttons */
7213                 if (sc->elanhw.isclickpad) {
7214                         sc->syninfo.softbuttons_y = sc->elanhw.sizey / 4;
7215                         sc->syninfo.softbutton2_x = sc->elanhw.sizex * 11 / 25;
7216                         sc->syninfo.softbutton3_x = sc->elanhw.sizex * 14 / 25;
7217                 }
7218         }
7219
7220         return;
7221 }
7222
7223 static int
7224 enable_elantech(struct psm_softc *sc, enum probearg arg)
7225 {
7226         static const int ic2hw[] =
7227         /*IC: 0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f */
7228             { 0, 0, 2, 0, 2, 3, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 };
7229         static const int fw_sizes[][3] = {
7230                 /* FW.vers  MaxX  MaxY */
7231                 { 0x020030, 1152,  768 },
7232                 { 0x020800, 1152,  768 },
7233                 { 0x020b00, 1152,  768 },
7234                 { 0x040215,  900,  500 },
7235                 { 0x040216,  819,  405 },
7236                 { 0x040219,  900,  500 },
7237         };
7238         elantechhw_t elanhw;
7239         int icversion, hwversion, xtr, i, id, resp[3], dpix, dpiy;
7240         KBDC kbdc = sc->kbdc;
7241
7242         VLOG(3, (LOG_DEBUG, "elantech: BEGIN init\n"));
7243
7244         set_mouse_scaling(kbdc, 1);
7245         set_mouse_scaling(kbdc, 1);
7246         set_mouse_scaling(kbdc, 1);
7247         if (get_mouse_status(kbdc, resp, 0, 3) != 3)
7248                 return (FALSE);
7249
7250         if (!ELANTECH_MAGIC(resp))
7251                 return (FALSE);
7252
7253         /* Identify the Touchpad version. */
7254         if (elantech_cmd(kbdc, 2, ELANTECH_FW_VERSION, resp))
7255                 return (FALSE);
7256
7257         bzero(&elanhw, sizeof(elanhw));
7258
7259         elanhw.fwversion = (resp[0] << 16) | (resp[1] << 8) | resp[2];
7260         icversion = resp[0] & 0x0f;
7261         hwversion = ic2hw[icversion];
7262
7263         if (verbose >= 2)
7264                 printf("Elantech touchpad hardware v.%d firmware v.0x%06x\n",
7265                     hwversion, elanhw.fwversion);
7266
7267         if (ELANTECH_HW_IS_V1(elanhw.fwversion)) {
7268                 printf ("  Unsupported touchpad hardware (v1)\n");
7269                 return (FALSE);
7270         }
7271         if (hwversion == 0) {
7272                 printf ("  Unknown touchpad hardware (firmware v.0x%06x)\n",
7273                     elanhw.fwversion);
7274                 return (FALSE);
7275         }
7276
7277         /* Get the Touchpad model information. */
7278         elanhw.hwversion = hwversion;
7279         elanhw.issemimt = hwversion == 2;
7280         elanhw.isclickpad = (resp[1] & 0x10) != 0;
7281         elanhw.hascrc = (resp[1] & 0x40) != 0;
7282         elanhw.haspressure = elanhw.fwversion >= 0x020800;
7283
7284         /* Read the capability bits. */
7285         if (elantech_cmd(kbdc, hwversion, ELANTECH_CAPABILITIES, resp) != 0) {
7286                 printf("  Failed to read capability bits\n");
7287                 return (FALSE);
7288         }
7289
7290         elanhw.ntracesx = imax(resp[1], 3);
7291         elanhw.ntracesy = imax(resp[2], 3);
7292         elanhw.hastrackpoint = (resp[0] & 0x80) != 0;
7293
7294         /* Get the touchpad resolution */
7295         switch (hwversion) {
7296         case 4:
7297                 if (elantech_cmd(kbdc, hwversion, ELANTECH_RESOLUTION, resp)
7298                     == 0) {
7299                         dpix = (resp[1] & 0x0f) * 10 + 790;
7300                         dpiy = ((resp[1] & 0xf0) >> 4) * 10 + 790;
7301                         elanhw.dpmmx = (dpix * 10 + 5) / 254;
7302                         elanhw.dpmmy = (dpiy * 10 + 5) / 254;
7303                         break;
7304                 }
7305                 /* FALLTHROUGH */
7306         case 2:
7307         case 3:
7308                 elanhw.dpmmx = elanhw.dpmmy = 32; /* 800 dpi */
7309                 break;
7310         }
7311
7312         if (!elantech_support)
7313                 return (FALSE);
7314
7315         if (elantech_init(kbdc, &elanhw)) {
7316                 printf("couldn't initialize elantech touchpad\n");
7317                 return (FALSE);
7318         }
7319
7320         /*
7321          * Get the touchpad reporting range.
7322          * On HW v.3 touchpads it should be done after switching hardware
7323          * to real resolution mode (by setting bit 3 of reg10)
7324          */
7325         elanhw.dptracex = elanhw.dptracey = 64;
7326         for (i = 0; i < nitems(fw_sizes); i++) {
7327                 if (elanhw.fwversion == fw_sizes[i][0]) {
7328                         elanhw.sizex = fw_sizes[i][1];
7329                         elanhw.sizey = fw_sizes[i][2];
7330                         goto found;
7331                 }
7332         }
7333         if (elantech_cmd(kbdc, hwversion, ELANTECH_FW_ID, resp) != 0) {
7334                 printf("  Failed to read touchpad size\n");
7335                 elanhw.sizex = 10000; /* Arbitrary high values to     */
7336                 elanhw.sizey = 10000; /* prevent clipping in smoother */
7337         } else if (hwversion == 2) {
7338                 if ((elanhw.fwversion >> 16) == 0x14 && (resp[1] & 0x10) &&
7339                     !elantech_cmd(kbdc, hwversion, ELANTECH_SAMPLE, resp)) {
7340                         elanhw.dptracex = resp[1] / 2;
7341                         elanhw.dptracey = resp[2] / 2;
7342                 }
7343                 xtr = ((elanhw.fwversion >> 8) == 0x0208) ? 1 : 2;
7344                 elanhw.sizex = (elanhw.ntracesx - xtr) * elanhw.dptracex;
7345                 elanhw.sizey = (elanhw.ntracesy - xtr) * elanhw.dptracey;
7346         } else {
7347                 elanhw.sizex = (resp[0] & 0x0f) << 8 | resp[1];
7348                 elanhw.sizey = (resp[0] & 0xf0) << 4 | resp[2];
7349                 xtr = (elanhw.sizex % (elanhw.ntracesx - 2) == 0) ? 2 : 1;
7350                 elanhw.dptracex = elanhw.sizex / (elanhw.ntracesx - xtr);
7351                 elanhw.dptracey = elanhw.sizey / (elanhw.ntracesy - xtr);
7352         }
7353 found:
7354         if (verbose >= 2) {
7355                 printf("  Model information:\n");
7356                 printf("   MaxX:       %d\n", elanhw.sizex);
7357                 printf("   MaxY:       %d\n", elanhw.sizey);
7358                 printf("   DpmmX:      %d\n", elanhw.dpmmx);
7359                 printf("   DpmmY:      %d\n", elanhw.dpmmy);
7360                 printf("   TracesX:    %d\n", elanhw.ntracesx);
7361                 printf("   TracesY:    %d\n", elanhw.ntracesy);
7362                 printf("   DptraceX:   %d\n", elanhw.dptracex);
7363                 printf("   DptraceY:   %d\n", elanhw.dptracey);
7364                 printf("   SemiMT:     %d\n", elanhw.issemimt);
7365                 printf("   Clickpad:   %d\n", elanhw.isclickpad);
7366                 printf("   Trackpoint: %d\n", elanhw.hastrackpoint);
7367                 printf("   CRC:        %d\n", elanhw.hascrc);
7368                 printf("   Pressure:   %d\n", elanhw.haspressure);
7369         }
7370
7371         VLOG(3, (LOG_DEBUG, "elantech: END init\n"));
7372
7373         if (arg == PROBE) {
7374                 sc->elanhw = elanhw;
7375                 sc->hw.buttons = 3;
7376
7377                 /* Initialize synaptics movement smoother */
7378                 elantech_init_synaptics(sc);
7379
7380                 for (id = 0; id < ELANTECH_MAX_FINGERS; id++)
7381                         PSM_FINGER_RESET(sc->elanaction.fingers[id]);
7382         }
7383
7384         return (TRUE);
7385 }
7386
7387 /*
7388  * Return true if 'now' is earlier than (start + (secs.usecs)).
7389  * Now may be NULL and the function will fetch the current time from
7390  * getmicrouptime(), or a cached 'now' can be passed in.
7391  * All values should be numbers derived from getmicrouptime().
7392  */
7393 static int
7394 timeelapsed(start, secs, usecs, now)
7395         const struct timeval *start, *now;
7396         int secs, usecs;
7397 {
7398         struct timeval snow, tv;
7399
7400         /* if there is no 'now' passed in, the get it as a convience. */
7401         if (now == NULL) {
7402                 getmicrouptime(&snow);
7403                 now = &snow;
7404         }
7405
7406         tv.tv_sec = secs;
7407         tv.tv_usec = usecs;
7408         timevaladd(&tv, start);
7409         return (timevalcmp(&tv, now, <));
7410 }
7411
7412 static int
7413 psmresume(device_t dev)
7414 {
7415         struct psm_softc *sc = device_get_softc(dev);
7416         int unit = device_get_unit(dev);
7417         int err;
7418
7419         VLOG(2, (LOG_NOTICE, "psm%d: system resume hook called.\n", unit));
7420
7421         if ((sc->config &
7422             (PSM_CONFIG_HOOKRESUME | PSM_CONFIG_INITAFTERSUSPEND)) == 0)
7423                 return (0);
7424
7425         err = reinitialize(sc, sc->config & PSM_CONFIG_INITAFTERSUSPEND);
7426
7427         if ((sc->state & PSM_ASLP) && !(sc->state & PSM_VALID)) {
7428                 /*
7429                  * Release the blocked process; it must be notified that
7430                  * the device cannot be accessed anymore.
7431                  */
7432                 sc->state &= ~PSM_ASLP;
7433                 wakeup(sc);
7434         }
7435
7436         VLOG(2, (LOG_DEBUG, "psm%d: system resume hook exiting.\n", unit));
7437
7438         return (err);
7439 }
7440
7441 DRIVER_MODULE(psm, atkbdc, psm_driver, psm_devclass, 0, 0);
7442 #ifdef EVDEV_SUPPORT
7443 MODULE_DEPEND(psm, evdev, 1, 1, 1);
7444 #endif
7445
7446 #ifdef DEV_ISA
7447
7448 /*
7449  * This sucks up assignments from PNPBIOS and ACPI.
7450  */
7451
7452 /*
7453  * When the PS/2 mouse device is reported by ACPI or PnP BIOS, it may
7454  * appear BEFORE the AT keyboard controller.  As the PS/2 mouse device
7455  * can be probed and attached only after the AT keyboard controller is
7456  * attached, we shall quietly reserve the IRQ resource for later use.
7457  * If the PS/2 mouse device is reported to us AFTER the keyboard controller,
7458  * copy the IRQ resource to the PS/2 mouse device instance hanging
7459  * under the keyboard controller, then probe and attach it.
7460  */
7461
7462 static  devclass_t                      psmcpnp_devclass;
7463
7464 static  device_probe_t                  psmcpnp_probe;
7465 static  device_attach_t                 psmcpnp_attach;
7466
7467 static device_method_t psmcpnp_methods[] = {
7468         DEVMETHOD(device_probe,         psmcpnp_probe),
7469         DEVMETHOD(device_attach,        psmcpnp_attach),
7470
7471         { 0, 0 }
7472 };
7473
7474 static driver_t psmcpnp_driver = {
7475         PSMCPNP_DRIVER_NAME,
7476         psmcpnp_methods,
7477         sizeof(struct psmcpnp_softc),
7478 };
7479
7480 static struct isa_pnp_id psmcpnp_ids[] = {
7481         { 0x030fd041, "PS/2 mouse port" },              /* PNP0F03 */
7482         { 0x0e0fd041, "PS/2 mouse port" },              /* PNP0F0E */
7483         { 0x120fd041, "PS/2 mouse port" },              /* PNP0F12 */
7484         { 0x130fd041, "PS/2 mouse port" },              /* PNP0F13 */
7485         { 0x1303d041, "PS/2 port" },                    /* PNP0313, XXX */
7486         { 0x02002e4f, "Dell PS/2 mouse port" },         /* Lat. X200, Dell */
7487         { 0x0002a906, "ALPS Glide Point" },             /* ALPS Glide Point */
7488         { 0x80374d24, "IBM PS/2 mouse port" },          /* IBM3780, ThinkPad */
7489         { 0x81374d24, "IBM PS/2 mouse port" },          /* IBM3781, ThinkPad */
7490         { 0x0190d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9001, Vaio */
7491         { 0x0290d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9002, Vaio */
7492         { 0x0390d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9003, Vaio */
7493         { 0x0490d94d, "SONY VAIO PS/2 mouse port"},     /* SNY9004, Vaio */
7494         { 0 }
7495 };
7496
7497 /* _HID list for quirk detection. Any device below has _CID from psmcpnp_ids */
7498 static struct isa_pnp_id topbtpad_ids[] = {
7499         { 0x1700ae30, "Lenovo PS/2 clickpad port" },    /* LEN0017, ThinkPad */
7500         { 0x1800ae30, "Lenovo PS/2 clickpad port" },    /* LEN0018, ThinkPad */
7501         { 0x1900ae30, "Lenovo PS/2 clickpad port" },    /* LEN0019, ThinkPad */
7502         { 0x2300ae30, "Lenovo PS/2 clickpad port" },    /* LEN0023, ThinkPad */
7503         { 0x2a00ae30, "Lenovo PS/2 clickpad port" },    /* LEN002a, ThinkPad */
7504         { 0x2b00ae30, "Lenovo PS/2 clickpad port" },    /* LEN002b, ThinkPad */
7505         { 0x2c00ae30, "Lenovo PS/2 clickpad port" },    /* LEN002c, ThinkPad */
7506         { 0x2d00ae30, "Lenovo PS/2 clickpad port" },    /* LEN002d, ThinkPad */
7507         { 0x2e00ae30, "Lenovo PS/2 clickpad port" },    /* LEN002e, ThinkPad */
7508         { 0x3300ae30, "Lenovo PS/2 clickpad port" },    /* LEN0033, ThinkPad */
7509         { 0x3400ae30, "Lenovo PS/2 clickpad port" },    /* LEN0034, ThinkPad */
7510         { 0x3500ae30, "Lenovo PS/2 clickpad port" },    /* LEN0035, ThinkPad */
7511         { 0x3600ae30, "Lenovo PS/2 clickpad port" },    /* LEN0036, ThinkPad */
7512         { 0x3700ae30, "Lenovo PS/2 clickpad port" },    /* LEN0037, ThinkPad */
7513         { 0x3800ae30, "Lenovo PS/2 clickpad port" },    /* LEN0038, ThinkPad */
7514         { 0x3900ae30, "Lenovo PS/2 clickpad port" },    /* LEN0039, ThinkPad */
7515         { 0x4100ae30, "Lenovo PS/2 clickpad port" },    /* LEN0041, ThinkPad */
7516         { 0x4200ae30, "Lenovo PS/2 clickpad port" },    /* LEN0042, ThinkPad */
7517         { 0x4500ae30, "Lenovo PS/2 clickpad port" },    /* LEN0045, ThinkPad */
7518         { 0x4700ae30, "Lenovo PS/2 clickpad port" },    /* LEN0047, ThinkPad */
7519         { 0x4900ae30, "Lenovo PS/2 clickpad port" },    /* LEN0049, ThinkPad */
7520         { 0x0020ae30, "Lenovo PS/2 clickpad port" },    /* LEN2000, ThinkPad */
7521         { 0x0120ae30, "Lenovo PS/2 clickpad port" },    /* LEN2001, ThinkPad */
7522         { 0x0220ae30, "Lenovo PS/2 clickpad port" },    /* LEN2002, ThinkPad */
7523         { 0x0320ae30, "Lenovo PS/2 clickpad port" },    /* LEN2003, ThinkPad */
7524         { 0x0420ae30, "Lenovo PS/2 clickpad port" },    /* LEN2004, ThinkPad */
7525         { 0x0520ae30, "Lenovo PS/2 clickpad port" },    /* LEN2005, ThinkPad */
7526         { 0x0620ae30, "Lenovo PS/2 clickpad port" },    /* LEN2006, ThinkPad */
7527         { 0x0720ae30, "Lenovo PS/2 clickpad port" },    /* LEN2007, ThinkPad */
7528         { 0x0820ae30, "Lenovo PS/2 clickpad port" },    /* LEN2008, ThinkPad */
7529         { 0x0920ae30, "Lenovo PS/2 clickpad port" },    /* LEN2009, ThinkPad */
7530         { 0x0a20ae30, "Lenovo PS/2 clickpad port" },    /* LEN200a, ThinkPad */
7531         { 0x0b20ae30, "Lenovo PS/2 clickpad port" },    /* LEN200b, ThinkPad */
7532         { 0 }
7533 };
7534
7535 /* _HID list for quirk detection. Any device below has _CID from psmcpnp_ids */
7536 static struct isa_pnp_id forcepad_ids[] = {
7537         { 0x0d302e4f, "HP PS/2 forcepad port" },        /* SYN300D, EB 1040 */
7538         { 0x14302e4f, "HP PS/2 forcepad port" },        /* SYN3014, EB 1040 */
7539         { 0 }
7540 };
7541
7542 static int
7543 create_a_copy(device_t atkbdc, device_t me)
7544 {
7545         device_t psm;
7546         u_long irq;
7547
7548         /* find the PS/2 mouse device instance under the keyboard controller */
7549         psm = device_find_child(atkbdc, PSM_DRIVER_NAME,
7550             device_get_unit(atkbdc));
7551         if (psm == NULL)
7552                 return (ENXIO);
7553         if (device_get_state(psm) != DS_NOTPRESENT)
7554                 return (0);
7555
7556         /* move our resource to the found device */
7557         irq = bus_get_resource_start(me, SYS_RES_IRQ, 0);
7558         bus_delete_resource(me, SYS_RES_IRQ, 0);
7559         bus_set_resource(psm, SYS_RES_IRQ, KBDC_RID_AUX, irq, 1);
7560
7561         /* ...then probe and attach it */
7562         return (device_probe_and_attach(psm));
7563 }
7564
7565 static int
7566 psmcpnp_probe(device_t dev)
7567 {
7568         struct psmcpnp_softc *sc = device_get_softc(dev);
7569         struct resource *res;
7570         u_long irq;
7571         int rid;
7572
7573         if (ISA_PNP_PROBE(device_get_parent(dev), dev, forcepad_ids) == 0)
7574                 sc->type = PSMCPNP_FORCEPAD;
7575         else if (ISA_PNP_PROBE(device_get_parent(dev), dev, topbtpad_ids) == 0)
7576                 sc->type = PSMCPNP_TOPBUTTONPAD;
7577         else if (ISA_PNP_PROBE(device_get_parent(dev), dev, psmcpnp_ids) == 0)
7578                 sc->type = PSMCPNP_GENERIC;
7579         else
7580                 return (ENXIO);
7581
7582         /*
7583          * The PnP BIOS and ACPI are supposed to assign an IRQ (12)
7584          * to the PS/2 mouse device node. But, some buggy PnP BIOS
7585          * declares the PS/2 mouse device node without an IRQ resource!
7586          * If this happens, we shall refer to device hints.
7587          * If we still don't find it there, use a hardcoded value... XXX
7588          */
7589         rid = 0;
7590         irq = bus_get_resource_start(dev, SYS_RES_IRQ, rid);
7591         if (irq <= 0) {
7592                 if (resource_long_value(PSM_DRIVER_NAME,
7593                     device_get_unit(dev),"irq", &irq) != 0)
7594                         irq = 12;       /* XXX */
7595                 device_printf(dev, "irq resource info is missing; "
7596                     "assuming irq %ld\n", irq);
7597                 bus_set_resource(dev, SYS_RES_IRQ, rid, irq, 1);
7598         }
7599         res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 0);
7600         bus_release_resource(dev, SYS_RES_IRQ, rid, res);
7601
7602         /* keep quiet */
7603         if (!bootverbose)
7604                 device_quiet(dev);
7605
7606         return ((res == NULL) ? ENXIO : 0);
7607 }
7608
7609 static int
7610 psmcpnp_attach(device_t dev)
7611 {
7612         device_t atkbdc;
7613
7614         /* find the keyboard controller, which may be on acpi* or isa* bus */
7615         atkbdc = devclass_get_device(devclass_find(ATKBDC_DRIVER_NAME),
7616             device_get_unit(dev));
7617         if ((atkbdc != NULL) && (device_get_state(atkbdc) == DS_ATTACHED))
7618                 create_a_copy(atkbdc, dev);
7619
7620         return (0);
7621 }
7622
7623 DRIVER_MODULE(psmcpnp, isa, psmcpnp_driver, psmcpnp_devclass, 0, 0);
7624 DRIVER_MODULE(psmcpnp, acpi, psmcpnp_driver, psmcpnp_devclass, 0, 0);
7625 ISA_PNP_INFO(psmcpnp_ids);
7626 #endif /* DEV_ISA */