drivers/input/mouse/psmouse-base.c

   1 /*
   2  * PS/2 mouse driver
   3  *
   4  * Copyright (c) 1999-2002 Vojtech Pavlik
   5  * Copyright (c) 2003-2004 Dmitry Torokhov
   6  */
   7
   8 /*
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License version 2 as published by
  11  * the Free Software Foundation.
  12  */
  13
  14 #define pr_fmt(fmt)             KBUILD_MODNAME ": " fmt
  15 #define psmouse_fmt(fmt)        fmt
  16
  17 #include <linux/delay.h>
  18 #include <linux/module.h>
  19 #include <linux/slab.h>
  20 #include <linux/interrupt.h>
  21 #include <linux/input.h>
  22 #include <linux/serio.h>
  23 #include <linux/init.h>
  24 #include <linux/libps2.h>
  25 #include <linux/mutex.h>
  26
  27 #include "psmouse.h"
  28 #include "synaptics.h"
  29 #include "logips2pp.h"
  30 #include "alps.h"
  31 #include "hgpk.h"
  32 #include "lifebook.h"
  33 #include "trackpoint.h"
  34 #include "touchkit_ps2.h"
  35 #include "elantech.h"
  36 #include "sentelic.h"
  37
  38 #define DRIVER_DESC     "PS/2 mouse driver"
  39
  40 MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");
  41 MODULE_DESCRIPTION(DRIVER_DESC);
  42 MODULE_LICENSE("GPL");
  43
  44 static unsigned int psmouse_max_proto = PSMOUSE_AUTO;
  45 static int psmouse_set_maxproto(const char *val, const struct kernel_param *);
  46 static int psmouse_get_maxproto(char *buffer, const struct kernel_param *kp);
  47 static struct kernel_param_ops param_ops_proto_abbrev = {
  48         .set = psmouse_set_maxproto,
  49         .get = psmouse_get_maxproto,
  50 };
  51 #define param_check_proto_abbrev(name, p)       __param_check(name, p, unsigned int)
  52 module_param_named(proto, psmouse_max_proto, proto_abbrev, 0644);
  53 MODULE_PARM_DESC(proto, "Highest protocol extension to probe (bare, imps, exps, any). Useful for KVM switches.");
  54
  55 static unsigned int psmouse_resolution = 200;
  56 module_param_named(resolution, psmouse_resolution, uint, 0644);
  57 MODULE_PARM_DESC(resolution, "Resolution, in dpi.");
  58
  59 static unsigned int psmouse_rate = 100;
  60 module_param_named(rate, psmouse_rate, uint, 0644);
  61 MODULE_PARM_DESC(rate, "Report rate, in reports per second.");
  62
  63 static unsigned int psmouse_smartscroll = 1;
  64 module_param_named(smartscroll, psmouse_smartscroll, bool, 0644);
  65 MODULE_PARM_DESC(smartscroll, "Logitech Smartscroll autorepeat, 1 = enabled (default), 0 = disabled.");
  66
  67 static unsigned int psmouse_resetafter = 5;
  68 module_param_named(resetafter, psmouse_resetafter, uint, 0644);
  69 MODULE_PARM_DESC(resetafter, "Reset device after so many bad packets (0 = never).");
  70
  71 static unsigned int psmouse_resync_time;
  72 module_param_named(resync_time, psmouse_resync_time, uint, 0644);
  73 MODULE_PARM_DESC(resync_time, "How long can mouse stay idle before forcing resync (in seconds, 0 = never).");
  74
  75 PSMOUSE_DEFINE_ATTR(protocol, S_IWUSR | S_IRUGO,
  76                         NULL,
  77                         psmouse_attr_show_protocol, psmouse_attr_set_protocol);
  78 PSMOUSE_DEFINE_ATTR(rate, S_IWUSR | S_IRUGO,
  79                         (void *) offsetof(struct psmouse, rate),
  80                         psmouse_show_int_attr, psmouse_attr_set_rate);
  81 PSMOUSE_DEFINE_ATTR(resolution, S_IWUSR | S_IRUGO,
  82                         (void *) offsetof(struct psmouse, resolution),
  83                         psmouse_show_int_attr, psmouse_attr_set_resolution);
  84 PSMOUSE_DEFINE_ATTR(resetafter, S_IWUSR | S_IRUGO,
  85                         (void *) offsetof(struct psmouse, resetafter),
  86                         psmouse_show_int_attr, psmouse_set_int_attr);
  87 PSMOUSE_DEFINE_ATTR(resync_time, S_IWUSR | S_IRUGO,
  88                         (void *) offsetof(struct psmouse, resync_time),
  89                         psmouse_show_int_attr, psmouse_set_int_attr);
  90
  91 static struct attribute *psmouse_attributes[] = {
  92         &psmouse_attr_protocol.dattr.attr,
  93         &psmouse_attr_rate.dattr.attr,
  94         &psmouse_attr_resolution.dattr.attr,
  95         &psmouse_attr_resetafter.dattr.attr,
  96         &psmouse_attr_resync_time.dattr.attr,
  97         NULL
  98 };
  99
 100 static struct attribute_group psmouse_attribute_group = {
 101         .attrs  = psmouse_attributes,
 102 };
 103
 104 /*
 105  * psmouse_mutex protects all operations changing state of mouse
 106  * (connecting, disconnecting, changing rate or resolution via
 107  * sysfs). We could use a per-device semaphore but since there
 108  * rarely more than one PS/2 mouse connected and since semaphore
 109  * is taken in "slow" paths it is not worth it.
 110  */
 111 static DEFINE_MUTEX(psmouse_mutex);
 112
 113 static struct workqueue_struct *kpsmoused_wq;
 114
 115 struct psmouse_protocol {
 116         enum psmouse_type type;
 117         bool maxproto;
 118         bool ignore_parity; /* Protocol should ignore parity errors from KBC */
 119         const char *name;
 120         const char *alias;
 121         int (*detect)(struct psmouse *, bool);
 122         int (*init)(struct psmouse *);
 123 };
 124
 125 /*
 126  * psmouse_process_byte() analyzes the PS/2 data stream and reports
 127  * relevant events to the input module once full packet has arrived.
 128  */
 129
 130 static psmouse_ret_t psmouse_process_byte(struct psmouse *psmouse)
 131 {
 132         struct input_dev *dev = psmouse->dev;
 133         unsigned char *packet = psmouse->packet;
 134
 135         if (psmouse->pktcnt < psmouse->pktsize)
 136                 return PSMOUSE_GOOD_DATA;
 137
 138 /*
 139  * Full packet accumulated, process it
 140  */
 141
 142 /*
 143  * Scroll wheel on IntelliMice, scroll buttons on NetMice
 144  */
 145
 146         if (psmouse->type == PSMOUSE_IMPS || psmouse->type == PSMOUSE_GENPS)
 147                 input_report_rel(dev, REL_WHEEL, -(signed char) packet[3]);
 148
 149 /*
 150  * Scroll wheel and buttons on IntelliMouse Explorer
 151  */
 152
 153         if (psmouse->type == PSMOUSE_IMEX) {
 154                 switch (packet[3] & 0xC0) {
 155                 case 0x80: /* vertical scroll on IntelliMouse Explorer 4.0 */
 156                         input_report_rel(dev, REL_WHEEL, (int) (packet[3] & 32) - (int) (packet[3] & 31));
 157                         break;
 158                 case 0x40: /* horizontal scroll on IntelliMouse Explorer 4.0 */
 159                         input_report_rel(dev, REL_HWHEEL, (int) (packet[3] & 32) - (int) (packet[3] & 31));
 160                         break;
 161                 case 0x00:
 162                 case 0xC0:
 163                         input_report_rel(dev, REL_WHEEL, (int) (packet[3] & 8) - (int) (packet[3] & 7));
 164                         input_report_key(dev, BTN_SIDE, (packet[3] >> 4) & 1);
 165                         input_report_key(dev, BTN_EXTRA, (packet[3] >> 5) & 1);
 166                         break;
 167                 }
 168         }
 169
 170 /*
 171  * Extra buttons on Genius NewNet 3D
 172  */
 173
 174         if (psmouse->type == PSMOUSE_GENPS) {
 175                 input_report_key(dev, BTN_SIDE, (packet[0] >> 6) & 1);
 176                 input_report_key(dev, BTN_EXTRA, (packet[0] >> 7) & 1);
 177         }
 178
 179 /*
 180  * Extra button on ThinkingMouse
 181  */
 182         if (psmouse->type == PSMOUSE_THINKPS) {
 183                 input_report_key(dev, BTN_EXTRA, (packet[0] >> 3) & 1);
 184                 /* Without this bit of weirdness moving up gives wildly high Y changes. */
 185                 packet[1] |= (packet[0] & 0x40) << 1;
 186         }
 187
 188 /*
 189  * Cortron PS2 Trackball reports SIDE button on the 4th bit of the first
 190  * byte.
 191  */
 192         if (psmouse->type == PSMOUSE_CORTRON) {
 193                 input_report_key(dev, BTN_SIDE, (packet[0] >> 3) & 1);
 194                 packet[0] |= 0x08;
 195         }
 196
 197 /*
 198  * Generic PS/2 Mouse
 199  */
 200
 201         input_report_key(dev, BTN_LEFT,    packet[0]       & 1);
 202         input_report_key(dev, BTN_MIDDLE, (packet[0] >> 2) & 1);
 203         input_report_key(dev, BTN_RIGHT,  (packet[0] >> 1) & 1);
 204
 205         input_report_rel(dev, REL_X, packet[1] ? (int) packet[1] - (int) ((packet[0] << 4) & 0x100) : 0);
 206         input_report_rel(dev, REL_Y, packet[2] ? (int) ((packet[0] << 3) & 0x100) - (int) packet[2] : 0);
 207
 208         input_sync(dev);
 209
 210         return PSMOUSE_FULL_PACKET;
 211 }
 212
 213 void psmouse_queue_work(struct psmouse *psmouse, struct delayed_work *work,
 214                 unsigned long delay)
 215 {
 216         queue_delayed_work(kpsmoused_wq, work, delay);
 217 }
 218
 219 /*
 220  * __psmouse_set_state() sets new psmouse state and resets all flags.
 221  */
 222
 223 static inline void __psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state)
 224 {
 225         psmouse->state = new_state;
 226         psmouse->pktcnt = psmouse->out_of_sync_cnt = 0;
 227         psmouse->ps2dev.flags = 0;
 228         psmouse->last = jiffies;
 229 }
 230
 231
 232 /*
 233  * psmouse_set_state() sets new psmouse state and resets all flags and
 234  * counters while holding serio lock so fighting with interrupt handler
 235  * is not a concern.
 236  */
 237
 238 void psmouse_set_state(struct psmouse *psmouse, enum psmouse_state new_state)
 239 {
 240         serio_pause_rx(psmouse->ps2dev.serio);
 241         __psmouse_set_state(psmouse, new_state);
 242         serio_continue_rx(psmouse->ps2dev.serio);
 243 }
 244
 245 /*
 246  * psmouse_handle_byte() processes one byte of the input data stream
 247  * by calling corresponding protocol handler.
 248  */
 249
 250 static int psmouse_handle_byte(struct psmouse *psmouse)
 251 {
 252         psmouse_ret_t rc = psmouse->protocol_handler(psmouse);
 253
 254         switch (rc) {
 255         case PSMOUSE_BAD_DATA:
 256                 if (psmouse->state == PSMOUSE_ACTIVATED) {
 257                         psmouse_warn(psmouse,
 258                                      "%s at %s lost sync at byte %d\n",
 259                                      psmouse->name, psmouse->phys,
 260                                      psmouse->pktcnt);
 261                         if (++psmouse->out_of_sync_cnt == psmouse->resetafter) {
 262                                 __psmouse_set_state(psmouse, PSMOUSE_IGNORE);
 263                                 psmouse_notice(psmouse,
 264                                                 "issuing reconnect request\n");
 265                                 serio_reconnect(psmouse->ps2dev.serio);
 266                                 return -1;
 267                         }
 268                 }
 269                 psmouse->pktcnt = 0;
 270                 break;
 271
 272         case PSMOUSE_FULL_PACKET:
 273                 psmouse->pktcnt = 0;
 274                 if (psmouse->out_of_sync_cnt) {
 275                         psmouse->out_of_sync_cnt = 0;
 276                         psmouse_notice(psmouse,
 277                                         "%s at %s - driver resynced.\n",
 278                                         psmouse->name, psmouse->phys);
 279                 }
 280                 break;
 281
 282         case PSMOUSE_GOOD_DATA:
 283                 break;
 284         }
 285         return 0;
 286 }
 287
 288 /*
 289  * psmouse_interrupt() handles incoming characters, either passing them
 290  * for normal processing or gathering them as command response.
 291  */
 292
 293 static irqreturn_t psmouse_interrupt(struct serio *serio,
 294                 unsigned char data, unsigned int flags)
 295 {
 296         struct psmouse *psmouse = serio_get_drvdata(serio);
 297
 298         if (psmouse->state == PSMOUSE_IGNORE)
 299                 goto out;
 300
 301         if (unlikely((flags & SERIO_TIMEOUT) ||
 302                      ((flags & SERIO_PARITY) && !psmouse->ignore_parity))) {
 303
 304                 if (psmouse->state == PSMOUSE_ACTIVATED)
 305                         psmouse_warn(psmouse,
 306                                      "bad data from KBC -%s%s\n",
 307                                      flags & SERIO_TIMEOUT ? " timeout" : "",
 308                                      flags & SERIO_PARITY ? " bad parity" : "");
 309                 ps2_cmd_aborted(&psmouse->ps2dev);
 310                 goto out;
 311         }
 312
 313         if (unlikely(psmouse->ps2dev.flags & PS2_FLAG_ACK))
 314                 if  (ps2_handle_ack(&psmouse->ps2dev, data))
 315                         goto out;
 316
 317         if (unlikely(psmouse->ps2dev.flags & PS2_FLAG_CMD))
 318                 if  (ps2_handle_response(&psmouse->ps2dev, data))
 319                         goto out;
 320
 321         if (psmouse->state <= PSMOUSE_RESYNCING)
 322                 goto out;
 323
 324         if (psmouse->state == PSMOUSE_ACTIVATED &&
 325             psmouse->pktcnt && time_after(jiffies, psmouse->last + HZ/2)) {
 326                 psmouse_info(psmouse, "%s at %s lost synchronization, throwing %d bytes away.\n",
 327                              psmouse->name, psmouse->phys, psmouse->pktcnt);
 328                 psmouse->badbyte = psmouse->packet[0];
 329                 __psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
 330                 psmouse_queue_work(psmouse, &psmouse->resync_work, 0);
 331                 goto out;
 332         }
 333
 334         psmouse->packet[psmouse->pktcnt++] = data;
 335 /*
 336  * Check if this is a new device announcement (0xAA 0x00)
 337  */
 338         if (unlikely(psmouse->packet[0] == PSMOUSE_RET_BAT && psmouse->pktcnt <= 2)) {
 339                 if (psmouse->pktcnt == 1) {
 340                         psmouse->last = jiffies;
 341                         goto out;
 342                 }
 343
 344                 if (psmouse->packet[1] == PSMOUSE_RET_ID ||
 345                     (psmouse->type == PSMOUSE_HGPK &&
 346                      psmouse->packet[1] == PSMOUSE_RET_BAT)) {
 347                         __psmouse_set_state(psmouse, PSMOUSE_IGNORE);
 348                         serio_reconnect(serio);
 349                         goto out;
 350                 }
 351 /*
 352  * Not a new device, try processing first byte normally
 353  */
 354                 psmouse->pktcnt = 1;
 355                 if (psmouse_handle_byte(psmouse))
 356                         goto out;
 357
 358                 psmouse->packet[psmouse->pktcnt++] = data;
 359         }
 360
 361 /*
 362  * See if we need to force resync because mouse was idle for too long
 363  */
 364         if (psmouse->state == PSMOUSE_ACTIVATED &&
 365             psmouse->pktcnt == 1 && psmouse->resync_time &&
 366             time_after(jiffies, psmouse->last + psmouse->resync_time * HZ)) {
 367                 psmouse->badbyte = psmouse->packet[0];
 368                 __psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
 369                 psmouse_queue_work(psmouse, &psmouse->resync_work, 0);
 370                 goto out;
 371         }
 372
 373         psmouse->last = jiffies;
 374         psmouse_handle_byte(psmouse);
 375
 376  out:
 377         return IRQ_HANDLED;
 378 }
 379
 380
 381 /*
 382  * psmouse_sliced_command() sends an extended PS/2 command to the mouse
 383  * using sliced syntax, understood by advanced devices, such as Logitech
 384  * or Synaptics touchpads. The command is encoded as:
 385  * 0xE6 0xE8 rr 0xE8 ss 0xE8 tt 0xE8 uu where (rr*64)+(ss*16)+(tt*4)+uu
 386  * is the command.
 387  */
 388 int psmouse_sliced_command(struct psmouse *psmouse, unsigned char command)
 389 {
 390         int i;
 391
 392         if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11))
 393                 return -1;
 394
 395         for (i = 6; i >= 0; i -= 2) {
 396                 unsigned char d = (command >> i) & 3;
 397                 if (ps2_command(&psmouse->ps2dev, &d, PSMOUSE_CMD_SETRES))
 398                         return -1;
 399         }
 400
 401         return 0;
 402 }
 403
 404
 405 /*
 406  * psmouse_reset() resets the mouse into power-on state.
 407  */
 408 int psmouse_reset(struct psmouse *psmouse)
 409 {
 410         unsigned char param[2];
 411
 412         if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_RESET_BAT))
 413                 return -1;
 414
 415         if (param[0] != PSMOUSE_RET_BAT && param[1] != PSMOUSE_RET_ID)
 416                 return -1;
 417
 418         return 0;
 419 }
 420
 421
 422 /*
 423  * Genius NetMouse magic init.
 424  */
 425 static int genius_detect(struct psmouse *psmouse, bool set_properties)
 426 {
 427         struct ps2dev *ps2dev = &psmouse->ps2dev;
 428         unsigned char param[4];
 429
 430         param[0] = 3;
 431         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
 432         ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
 433         ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
 434         ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
 435         ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
 436
 437         if (param[0] != 0x00 || param[1] != 0x33 || param[2] != 0x55)
 438                 return -1;
 439
 440         if (set_properties) {
 441                 __set_bit(BTN_MIDDLE, psmouse->dev->keybit);
 442                 __set_bit(BTN_EXTRA, psmouse->dev->keybit);
 443                 __set_bit(BTN_SIDE, psmouse->dev->keybit);
 444                 __set_bit(REL_WHEEL, psmouse->dev->relbit);
 445
 446                 psmouse->vendor = "Genius";
 447                 psmouse->name = "Mouse";
 448                 psmouse->pktsize = 4;
 449         }
 450
 451         return 0;
 452 }
 453
 454 /*
 455  * IntelliMouse magic init.
 456  */
 457 static int intellimouse_detect(struct psmouse *psmouse, bool set_properties)
 458 {
 459         struct ps2dev *ps2dev = &psmouse->ps2dev;
 460         unsigned char param[2];
 461
 462         param[0] = 200;
 463         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
 464         param[0] = 100;
 465         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
 466         param[0] =  80;
 467         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
 468         ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
 469
 470         if (param[0] != 3)
 471                 return -1;
 472
 473         if (set_properties) {
 474                 __set_bit(BTN_MIDDLE, psmouse->dev->keybit);
 475                 __set_bit(REL_WHEEL, psmouse->dev->relbit);
 476
 477                 if (!psmouse->vendor)
 478                         psmouse->vendor = "Generic";
 479                 if (!psmouse->name)
 480                         psmouse->name = "Wheel Mouse";
 481                 psmouse->pktsize = 4;
 482         }
 483
 484         return 0;
 485 }
 486
 487 /*
 488  * Try IntelliMouse/Explorer magic init.
 489  */
 490 static int im_explorer_detect(struct psmouse *psmouse, bool set_properties)
 491 {
 492         struct ps2dev *ps2dev = &psmouse->ps2dev;
 493         unsigned char param[2];
 494
 495         intellimouse_detect(psmouse, 0);
 496
 497         param[0] = 200;
 498         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
 499         param[0] = 200;
 500         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
 501         param[0] =  80;
 502         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
 503         ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
 504
 505         if (param[0] != 4)
 506                 return -1;
 507
 508 /* Magic to enable horizontal scrolling on IntelliMouse 4.0 */
 509         param[0] = 200;
 510         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
 511         param[0] =  80;
 512         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
 513         param[0] =  40;
 514         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
 515
 516         if (set_properties) {
 517                 __set_bit(BTN_MIDDLE, psmouse->dev->keybit);
 518                 __set_bit(REL_WHEEL, psmouse->dev->relbit);
 519                 __set_bit(REL_HWHEEL, psmouse->dev->relbit);
 520                 __set_bit(BTN_SIDE, psmouse->dev->keybit);
 521                 __set_bit(BTN_EXTRA, psmouse->dev->keybit);
 522
 523                 if (!psmouse->vendor)
 524                         psmouse->vendor = "Generic";
 525                 if (!psmouse->name)
 526                         psmouse->name = "Explorer Mouse";
 527                 psmouse->pktsize = 4;
 528         }
 529
 530         return 0;
 531 }
 532
 533 /*
 534  * Kensington ThinkingMouse / ExpertMouse magic init.
 535  */
 536 static int thinking_detect(struct psmouse *psmouse, bool set_properties)
 537 {
 538         struct ps2dev *ps2dev = &psmouse->ps2dev;
 539         unsigned char param[2];
 540         static const unsigned char seq[] = { 20, 60, 40, 20, 20, 60, 40, 20, 20 };
 541         int i;
 542
 543         param[0] = 10;
 544         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
 545         param[0] = 0;
 546         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
 547         for (i = 0; i < ARRAY_SIZE(seq); i++) {
 548                 param[0] = seq[i];
 549                 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
 550         }
 551         ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
 552
 553         if (param[0] != 2)
 554                 return -1;
 555
 556         if (set_properties) {
 557                 __set_bit(BTN_MIDDLE, psmouse->dev->keybit);
 558                 __set_bit(BTN_EXTRA, psmouse->dev->keybit);
 559
 560                 psmouse->vendor = "Kensington";
 561                 psmouse->name = "ThinkingMouse";
 562         }
 563
 564         return 0;
 565 }
 566
 567 /*
 568  * Bare PS/2 protocol "detection". Always succeeds.
 569  */
 570 static int ps2bare_detect(struct psmouse *psmouse, bool set_properties)
 571 {
 572         if (set_properties) {
 573                 if (!psmouse->vendor)
 574                         psmouse->vendor = "Generic";
 575                 if (!psmouse->name)
 576                         psmouse->name = "Mouse";
 577
 578 /*
 579  * We have no way of figuring true number of buttons so let's
 580  * assume that the device has 3.
 581  */
 582                 __set_bit(BTN_MIDDLE, psmouse->dev->keybit);
 583         }
 584
 585         return 0;
 586 }
 587
 588 /*
 589  * Cortron PS/2 protocol detection. There's no special way to detect it, so it
 590  * must be forced by sysfs protocol writing.
 591  */
 592 static int cortron_detect(struct psmouse *psmouse, bool set_properties)
 593 {
 594         if (set_properties) {
 595                 psmouse->vendor = "Cortron";
 596                 psmouse->name = "PS/2 Trackball";
 597
 598                 __set_bit(BTN_MIDDLE, psmouse->dev->keybit);
 599                 __set_bit(BTN_SIDE, psmouse->dev->keybit);
 600         }
 601
 602         return 0;
 603 }
 604
 605 /*
 606  * psmouse_extensions() probes for any extensions to the basic PS/2 protocol
 607  * the mouse may have.
 608  */
 609
 610 static int psmouse_extensions(struct psmouse *psmouse,
 611                               unsigned int max_proto, bool set_properties)
 612 {
 613         bool synaptics_hardware = false;
 614
 615 /*
 616  * We always check for lifebook because it does not disturb mouse
 617  * (it only checks DMI information).
 618  */
 619         if (lifebook_detect(psmouse, set_properties) == 0) {
 620                 if (max_proto > PSMOUSE_IMEX) {
 621                         if (!set_properties || lifebook_init(psmouse) == 0)
 622                                 return PSMOUSE_LIFEBOOK;
 623                 }
 624         }
 625
 626 /*
 627  * Try Kensington ThinkingMouse (we try first, because synaptics probe
 628  * upsets the thinkingmouse).
 629  */
 630
 631         if (max_proto > PSMOUSE_IMEX && thinking_detect(psmouse, set_properties) == 0)
 632                 return PSMOUSE_THINKPS;
 633
 634 /*
 635  * Try Synaptics TouchPad. Note that probing is done even if Synaptics protocol
 636  * support is disabled in config - we need to know if it is synaptics so we
 637  * can reset it properly after probing for intellimouse.
 638  */
 639         if (max_proto > PSMOUSE_PS2 && synaptics_detect(psmouse, set_properties) == 0) {
 640                 synaptics_hardware = true;
 641
 642                 if (max_proto > PSMOUSE_IMEX) {
 643 /*
 644  * Try activating protocol, but check if support is enabled first, since
 645  * we try detecting Synaptics even when protocol is disabled.
 646  */
 647                         if (synaptics_supported() &&
 648                             (!set_properties || synaptics_init(psmouse) == 0)) {
 649                                 return PSMOUSE_SYNAPTICS;
 650                         }
 651
 652 /*
 653  * Some Synaptics touchpads can emulate extended protocols (like IMPS/2).
 654  * Unfortunately Logitech/Genius probes confuse some firmware versions so
 655  * we'll have to skip them.
 656  */
 657                         max_proto = PSMOUSE_IMEX;
 658                 }
 659 /*
 660  * Make sure that touchpad is in relative mode, gestures (taps) are enabled
 661  */
 662                 synaptics_reset(psmouse);
 663         }
 664
 665 /*
 666  * Try ALPS TouchPad
 667  */
 668         if (max_proto > PSMOUSE_IMEX) {
 669                 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
 670                 if (alps_detect(psmouse, set_properties) == 0) {
 671                         if (!set_properties || alps_init(psmouse) == 0)
 672                                 return PSMOUSE_ALPS;
 673 /*
 674  * Init failed, try basic relative protocols
 675  */
 676                         max_proto = PSMOUSE_IMEX;
 677                 }
 678         }
 679
 680 /*
 681  * Try OLPC HGPK touchpad.
 682  */
 683         if (max_proto > PSMOUSE_IMEX &&
 684                         hgpk_detect(psmouse, set_properties) == 0) {
 685                 if (!set_properties || hgpk_init(psmouse) == 0)
 686                         return PSMOUSE_HGPK;
 687 /*
 688  * Init failed, try basic relative protocols
 689  */
 690                 max_proto = PSMOUSE_IMEX;
 691         }
 692
 693 /*
 694  * Try Elantech touchpad.
 695  */
 696         if (max_proto > PSMOUSE_IMEX &&
 697                         elantech_detect(psmouse, set_properties) == 0) {
 698                 if (!set_properties || elantech_init(psmouse) == 0)
 699                         return PSMOUSE_ELANTECH;
 700 /*
 701  * Init failed, try basic relative protocols
 702  */
 703                 max_proto = PSMOUSE_IMEX;
 704         }
 705
 706
 707         if (max_proto > PSMOUSE_IMEX) {
 708                 if (genius_detect(psmouse, set_properties) == 0)
 709                         return PSMOUSE_GENPS;
 710
 711                 if (ps2pp_init(psmouse, set_properties) == 0)
 712                         return PSMOUSE_PS2PP;
 713
 714                 if (trackpoint_detect(psmouse, set_properties) == 0)
 715                         return PSMOUSE_TRACKPOINT;
 716
 717                 if (touchkit_ps2_detect(psmouse, set_properties) == 0)
 718                         return PSMOUSE_TOUCHKIT_PS2;
 719         }
 720
 721 /*
 722  * Try Finger Sensing Pad. We do it here because its probe upsets
 723  * Trackpoint devices (causing TP_READ_ID command to time out).
 724  */
 725         if (max_proto > PSMOUSE_IMEX) {
 726                 if (fsp_detect(psmouse, set_properties) == 0) {
 727                         if (!set_properties || fsp_init(psmouse) == 0)
 728                                 return PSMOUSE_FSP;
 729 /*
 730  * Init failed, try basic relative protocols
 731  */
 732                         max_proto = PSMOUSE_IMEX;
 733                 }
 734         }
 735
 736 /*
 737  * Reset to defaults in case the device got confused by extended
 738  * protocol probes. Note that we follow up with full reset because
 739  * some mice put themselves to sleep when they see PSMOUSE_RESET_DIS.
 740  */
 741         ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
 742         psmouse_reset(psmouse);
 743
 744         if (max_proto >= PSMOUSE_IMEX && im_explorer_detect(psmouse, set_properties) == 0)
 745                 return PSMOUSE_IMEX;
 746
 747         if (max_proto >= PSMOUSE_IMPS && intellimouse_detect(psmouse, set_properties) == 0)
 748                 return PSMOUSE_IMPS;
 749
 750 /*
 751  * Okay, all failed, we have a standard mouse here. The number of the buttons
 752  * is still a question, though. We assume 3.
 753  */
 754         ps2bare_detect(psmouse, set_properties);
 755
 756         if (synaptics_hardware) {
 757 /*
 758  * We detected Synaptics hardware but it did not respond to IMPS/2 probes.
 759  * We need to reset the touchpad because if there is a track point on the
 760  * pass through port it could get disabled while probing for protocol
 761  * extensions.
 762  */
 763                 psmouse_reset(psmouse);
 764         }
 765
 766         return PSMOUSE_PS2;
 767 }
 768
 769 static const struct psmouse_protocol psmouse_protocols[] = {
 770         {
 771                 .type           = PSMOUSE_PS2,
 772                 .name           = "PS/2",
 773                 .alias          = "bare",
 774                 .maxproto       = true,
 775                 .ignore_parity  = true,
 776                 .detect         = ps2bare_detect,
 777         },
 778 #ifdef CONFIG_MOUSE_PS2_LOGIPS2PP
 779         {
 780                 .type           = PSMOUSE_PS2PP,
 781                 .name           = "PS2++",
 782                 .alias          = "logitech",
 783                 .detect         = ps2pp_init,
 784         },
 785 #endif
 786         {
 787                 .type           = PSMOUSE_THINKPS,
 788                 .name           = "ThinkPS/2",
 789                 .alias          = "thinkps",
 790                 .detect         = thinking_detect,
 791         },
 792         {
 793                 .type           = PSMOUSE_GENPS,
 794                 .name           = "GenPS/2",
 795                 .alias          = "genius",
 796                 .detect         = genius_detect,
 797         },
 798         {
 799                 .type           = PSMOUSE_IMPS,
 800                 .name           = "ImPS/2",
 801                 .alias          = "imps",
 802                 .maxproto       = true,
 803                 .ignore_parity  = true,
 804                 .detect         = intellimouse_detect,
 805         },
 806         {
 807                 .type           = PSMOUSE_IMEX,
 808                 .name           = "ImExPS/2",
 809                 .alias          = "exps",
 810                 .maxproto       = true,
 811                 .ignore_parity  = true,
 812                 .detect         = im_explorer_detect,
 813         },
 814 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS
 815         {
 816                 .type           = PSMOUSE_SYNAPTICS,
 817                 .name           = "SynPS/2",
 818                 .alias          = "synaptics",
 819                 .detect         = synaptics_detect,
 820                 .init           = synaptics_init,
 821         },
 822 #endif
 823 #ifdef CONFIG_MOUSE_PS2_ALPS
 824         {
 825                 .type           = PSMOUSE_ALPS,
 826                 .name           = "AlpsPS/2",
 827                 .alias          = "alps",
 828                 .detect         = alps_detect,
 829                 .init           = alps_init,
 830         },
 831 #endif
 832 #ifdef CONFIG_MOUSE_PS2_LIFEBOOK
 833         {
 834                 .type           = PSMOUSE_LIFEBOOK,
 835                 .name           = "LBPS/2",
 836                 .alias          = "lifebook",
 837                 .init           = lifebook_init,
 838         },
 839 #endif
 840 #ifdef CONFIG_MOUSE_PS2_TRACKPOINT
 841         {
 842                 .type           = PSMOUSE_TRACKPOINT,
 843                 .name           = "TPPS/2",
 844                 .alias          = "trackpoint",
 845                 .detect         = trackpoint_detect,
 846         },
 847 #endif
 848 #ifdef CONFIG_MOUSE_PS2_TOUCHKIT
 849         {
 850                 .type           = PSMOUSE_TOUCHKIT_PS2,
 851                 .name           = "touchkitPS/2",
 852                 .alias          = "touchkit",
 853                 .detect         = touchkit_ps2_detect,
 854         },
 855 #endif
 856 #ifdef CONFIG_MOUSE_PS2_OLPC
 857         {
 858                 .type           = PSMOUSE_HGPK,
 859                 .name           = "OLPC HGPK",
 860                 .alias          = "hgpk",
 861                 .detect         = hgpk_detect,
 862         },
 863 #endif
 864 #ifdef CONFIG_MOUSE_PS2_ELANTECH
 865         {
 866                 .type           = PSMOUSE_ELANTECH,
 867                 .name           = "ETPS/2",
 868                 .alias          = "elantech",
 869                 .detect         = elantech_detect,
 870                 .init           = elantech_init,
 871         },
 872 #endif
 873 #ifdef CONFIG_MOUSE_PS2_SENTELIC
 874         {
 875                 .type           = PSMOUSE_FSP,
 876                 .name           = "FSPPS/2",
 877                 .alias          = "fsp",
 878                 .detect         = fsp_detect,
 879                 .init           = fsp_init,
 880         },
 881 #endif
 882         {
 883                 .type           = PSMOUSE_CORTRON,
 884                 .name           = "CortronPS/2",
 885                 .alias          = "cortps",
 886                 .detect         = cortron_detect,
 887         },
 888         {
 889                 .type           = PSMOUSE_AUTO,
 890                 .name           = "auto",
 891                 .alias          = "any",
 892                 .maxproto       = true,
 893         },
 894 };
 895
 896 static const struct psmouse_protocol *psmouse_protocol_by_type(enum psmouse_type type)
 897 {
 898         int i;
 899
 900         for (i = 0; i < ARRAY_SIZE(psmouse_protocols); i++)
 901                 if (psmouse_protocols[i].type == type)
 902                         return &psmouse_protocols[i];
 903
 904         WARN_ON(1);
 905         return &psmouse_protocols[0];
 906 }
 907
 908 static const struct psmouse_protocol *psmouse_protocol_by_name(const char *name, size_t len)
 909 {
 910         const struct psmouse_protocol *p;
 911         int i;
 912
 913         for (i = 0; i < ARRAY_SIZE(psmouse_protocols); i++) {
 914                 p = &psmouse_protocols[i];
 915
 916                 if ((strlen(p->name) == len && !strncmp(p->name, name, len)) ||
 917                     (strlen(p->alias) == len && !strncmp(p->alias, name, len)))
 918                         return &psmouse_protocols[i];
 919         }
 920
 921         return NULL;
 922 }
 923
 924
 925 /*
 926  * psmouse_probe() probes for a PS/2 mouse.
 927  */
 928
 929 static int psmouse_probe(struct psmouse *psmouse)
 930 {
 931         struct ps2dev *ps2dev = &psmouse->ps2dev;
 932         unsigned char param[2];
 933
 934 /*
 935  * First, we check if it's a mouse. It should send 0x00 or 0x03
 936  * in case of an IntelliMouse in 4-byte mode or 0x04 for IM Explorer.
 937  * Sunrex K8561 IR Keyboard/Mouse reports 0xff on second and subsequent
 938  * ID queries, probably due to a firmware bug.
 939  */
 940
 941         param[0] = 0xa5;
 942         if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETID))
 943                 return -1;
 944
 945         if (param[0] != 0x00 && param[0] != 0x03 &&
 946             param[0] != 0x04 && param[0] != 0xff)
 947                 return -1;
 948
 949 /*
 950  * Then we reset and disable the mouse so that it doesn't generate events.
 951  */
 952
 953         if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_RESET_DIS))
 954                 psmouse_warn(psmouse, "Failed to reset mouse on %s\n",
 955                              ps2dev->serio->phys);
 956
 957         return 0;
 958 }
 959
 960 /*
 961  * Here we set the mouse resolution.
 962  */
 963
 964 void psmouse_set_resolution(struct psmouse *psmouse, unsigned int resolution)
 965 {
 966         static const unsigned char params[] = { 0, 1, 2, 2, 3 };
 967         unsigned char p;
 968
 969         if (resolution == 0 || resolution > 200)
 970                 resolution = 200;
 971
 972         p = params[resolution / 50];
 973         ps2_command(&psmouse->ps2dev, &p, PSMOUSE_CMD_SETRES);
 974         psmouse->resolution = 25 << p;
 975 }
 976
 977 /*
 978  * Here we set the mouse report rate.
 979  */
 980
 981 static void psmouse_set_rate(struct psmouse *psmouse, unsigned int rate)
 982 {
 983         static const unsigned char rates[] = { 200, 100, 80, 60, 40, 20, 10, 0 };
 984         unsigned char r;
 985         int i = 0;
 986
 987         while (rates[i] > rate) i++;
 988         r = rates[i];
 989         ps2_command(&psmouse->ps2dev, &r, PSMOUSE_CMD_SETRATE);
 990         psmouse->rate = r;
 991 }
 992
 993 /*
 994  * psmouse_initialize() initializes the mouse to a sane state.
 995  */
 996
 997 static void psmouse_initialize(struct psmouse *psmouse)
 998 {
 999 /*
1000  * We set the mouse report rate, resolution and scaling.
1001  */
1002
1003         if (psmouse_max_proto != PSMOUSE_PS2) {
1004                 psmouse->set_rate(psmouse, psmouse->rate);
1005                 psmouse->set_resolution(psmouse, psmouse->resolution);
1006                 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
1007         }
1008 }
1009
1010 /*
1011  * psmouse_activate() enables the mouse so that we get motion reports from it.
1012  */
1013
1014 static void psmouse_activate(struct psmouse *psmouse)
1015 {
1016         if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_ENABLE))
1017                 psmouse_warn(psmouse, "Failed to enable mouse on %s\n",
1018                              psmouse->ps2dev.serio->phys);
1019
1020         psmouse_set_state(psmouse, PSMOUSE_ACTIVATED);
1021 }
1022
1023
1024 /*
1025  * psmouse_deactivate() puts the mouse into poll mode so that we don't get motion
1026  * reports from it unless we explicitly request it.
1027  */
1028
1029 static void psmouse_deactivate(struct psmouse *psmouse)
1030 {
1031         if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_DISABLE))
1032                 psmouse_warn(psmouse, "Failed to deactivate mouse on %s\n",
1033                              psmouse->ps2dev.serio->phys);
1034
1035         psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1036 }
1037
1038 /*
1039  * psmouse_poll() - default poll handler. Everyone except for ALPS uses it.
1040  */
1041
1042 static int psmouse_poll(struct psmouse *psmouse)
1043 {
1044         return ps2_command(&psmouse->ps2dev, psmouse->packet,
1045                            PSMOUSE_CMD_POLL | (psmouse->pktsize << 8));
1046 }
1047
1048
1049 /*
1050  * psmouse_resync() attempts to re-validate current protocol.
1051  */
1052
1053 static void psmouse_resync(struct work_struct *work)
1054 {
1055         struct psmouse *parent = NULL, *psmouse =
1056                 container_of(work, struct psmouse, resync_work.work);
1057         struct serio *serio = psmouse->ps2dev.serio;
1058         psmouse_ret_t rc = PSMOUSE_GOOD_DATA;
1059         bool failed = false, enabled = false;
1060         int i;
1061
1062         mutex_lock(&psmouse_mutex);
1063
1064         if (psmouse->state != PSMOUSE_RESYNCING)
1065                 goto out;
1066
1067         if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1068                 parent = serio_get_drvdata(serio->parent);
1069                 psmouse_deactivate(parent);
1070         }
1071
1072 /*
1073  * Some mice don't ACK commands sent while they are in the middle of
1074  * transmitting motion packet. To avoid delay we use ps2_sendbyte()
1075  * instead of ps2_command() which would wait for 200ms for an ACK
1076  * that may never come.
1077  * As an additional quirk ALPS touchpads may not only forget to ACK
1078  * disable command but will stop reporting taps, so if we see that
1079  * mouse at least once ACKs disable we will do full reconnect if ACK
1080  * is missing.
1081  */
1082         psmouse->num_resyncs++;
1083
1084         if (ps2_sendbyte(&psmouse->ps2dev, PSMOUSE_CMD_DISABLE, 20)) {
1085                 if (psmouse->num_resyncs < 3 || psmouse->acks_disable_command)
1086                         failed = true;
1087         } else
1088                 psmouse->acks_disable_command = true;
1089
1090 /*
1091  * Poll the mouse. If it was reset the packet will be shorter than
1092  * psmouse->pktsize and ps2_command will fail. We do not expect and
1093  * do not handle scenario when mouse "upgrades" its protocol while
1094  * disconnected since it would require additional delay. If we ever
1095  * see a mouse that does it we'll adjust the code.
1096  */
1097         if (!failed) {
1098                 if (psmouse->poll(psmouse))
1099                         failed = true;
1100                 else {
1101                         psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1102                         for (i = 0; i < psmouse->pktsize; i++) {
1103                                 psmouse->pktcnt++;
1104                                 rc = psmouse->protocol_handler(psmouse);
1105                                 if (rc != PSMOUSE_GOOD_DATA)
1106                                         break;
1107                         }
1108                         if (rc != PSMOUSE_FULL_PACKET)
1109                                 failed = true;
1110                         psmouse_set_state(psmouse, PSMOUSE_RESYNCING);
1111                 }
1112         }
1113 /*
1114  * Now try to enable mouse. We try to do that even if poll failed and also
1115  * repeat our attempts 5 times, otherwise we may be left out with disabled
1116  * mouse.
1117  */
1118         for (i = 0; i < 5; i++) {
1119                 if (!ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_ENABLE)) {
1120                         enabled = true;
1121                         break;
1122                 }
1123                 msleep(200);
1124         }
1125
1126         if (!enabled) {
1127                 psmouse_warn(psmouse, "failed to re-enable mouse on %s\n",
1128                              psmouse->ps2dev.serio->phys);
1129                 failed = true;
1130         }
1131
1132         if (failed) {
1133                 psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1134                 psmouse_info(psmouse,
1135                              "resync failed, issuing reconnect request\n");
1136                 serio_reconnect(serio);
1137         } else
1138                 psmouse_set_state(psmouse, PSMOUSE_ACTIVATED);
1139
1140         if (parent)
1141                 psmouse_activate(parent);
1142  out:
1143         mutex_unlock(&psmouse_mutex);
1144 }
1145
1146 /*
1147  * psmouse_cleanup() resets the mouse into power-on state.
1148  */
1149
1150 static void psmouse_cleanup(struct serio *serio)
1151 {
1152         struct psmouse *psmouse = serio_get_drvdata(serio);
1153         struct psmouse *parent = NULL;
1154
1155         mutex_lock(&psmouse_mutex);
1156
1157         if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1158                 parent = serio_get_drvdata(serio->parent);
1159                 psmouse_deactivate(parent);
1160         }
1161
1162         psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1163
1164         /*
1165          * Disable stream mode so cleanup routine can proceed undisturbed.
1166          */
1167         if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_DISABLE))
1168                 psmouse_warn(psmouse, "Failed to disable mouse on %s\n",
1169                              psmouse->ps2dev.serio->phys);
1170
1171         if (psmouse->cleanup)
1172                 psmouse->cleanup(psmouse);
1173
1174 /*
1175  * Reset the mouse to defaults (bare PS/2 protocol).
1176  */
1177         ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
1178
1179 /*
1180  * Some boxes, such as HP nx7400, get terribly confused if mouse
1181  * is not fully enabled before suspending/shutting down.
1182  */
1183         ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_ENABLE);
1184
1185         if (parent) {
1186                 if (parent->pt_deactivate)
1187                         parent->pt_deactivate(parent);
1188
1189                 psmouse_activate(parent);
1190         }
1191
1192         mutex_unlock(&psmouse_mutex);
1193 }
1194
1195 /*
1196  * psmouse_disconnect() closes and frees.
1197  */
1198
1199 static void psmouse_disconnect(struct serio *serio)
1200 {
1201         struct psmouse *psmouse, *parent = NULL;
1202
1203         psmouse = serio_get_drvdata(serio);
1204
1205         sysfs_remove_group(&serio->dev.kobj, &psmouse_attribute_group);
1206
1207         mutex_lock(&psmouse_mutex);
1208
1209         psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1210
1211         /* make sure we don't have a resync in progress */
1212         mutex_unlock(&psmouse_mutex);
1213         flush_workqueue(kpsmoused_wq);
1214         mutex_lock(&psmouse_mutex);
1215
1216         if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1217                 parent = serio_get_drvdata(serio->parent);
1218                 psmouse_deactivate(parent);
1219         }
1220
1221         if (psmouse->disconnect)
1222                 psmouse->disconnect(psmouse);
1223
1224         if (parent && parent->pt_deactivate)
1225                 parent->pt_deactivate(parent);
1226
1227         psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1228
1229         serio_close(serio);
1230         serio_set_drvdata(serio, NULL);
1231         input_unregister_device(psmouse->dev);
1232         kfree(psmouse);
1233
1234         if (parent)
1235                 psmouse_activate(parent);
1236
1237         mutex_unlock(&psmouse_mutex);
1238 }
1239
1240 static int psmouse_switch_protocol(struct psmouse *psmouse,
1241                                    const struct psmouse_protocol *proto)
1242 {
1243         const struct psmouse_protocol *selected_proto;
1244         struct input_dev *input_dev = psmouse->dev;
1245
1246         input_dev->dev.parent = &psmouse->ps2dev.serio->dev;
1247
1248         input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
1249         input_dev->keybit[BIT_WORD(BTN_MOUSE)] =
1250                                 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_RIGHT);
1251         input_dev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
1252
1253         psmouse->set_rate = psmouse_set_rate;
1254         psmouse->set_resolution = psmouse_set_resolution;
1255         psmouse->poll = psmouse_poll;
1256         psmouse->protocol_handler = psmouse_process_byte;
1257         psmouse->pktsize = 3;
1258
1259         if (proto && (proto->detect || proto->init)) {
1260                 if (proto->detect && proto->detect(psmouse, true) < 0)
1261                         return -1;
1262
1263                 if (proto->init && proto->init(psmouse) < 0)
1264                         return -1;
1265
1266                 psmouse->type = proto->type;
1267                 selected_proto = proto;
1268         } else {
1269                 psmouse->type = psmouse_extensions(psmouse,
1270                                                    psmouse_max_proto, true);
1271                 selected_proto = psmouse_protocol_by_type(psmouse->type);
1272         }
1273
1274         psmouse->ignore_parity = selected_proto->ignore_parity;
1275
1276         /*
1277          * If mouse's packet size is 3 there is no point in polling the
1278          * device in hopes to detect protocol reset - we won't get less
1279          * than 3 bytes response anyhow.
1280          */
1281         if (psmouse->pktsize == 3)
1282                 psmouse->resync_time = 0;
1283
1284         /*
1285          * Some smart KVMs fake response to POLL command returning just
1286          * 3 bytes and messing up our resync logic, so if initial poll
1287          * fails we won't try polling the device anymore. Hopefully
1288          * such KVM will maintain initially selected protocol.
1289          */
1290         if (psmouse->resync_time && psmouse->poll(psmouse))
1291                 psmouse->resync_time = 0;
1292
1293         snprintf(psmouse->devname, sizeof(psmouse->devname), "%s %s %s",
1294                  selected_proto->name, psmouse->vendor, psmouse->name);
1295
1296         input_dev->name = psmouse->devname;
1297         input_dev->phys = psmouse->phys;
1298         input_dev->id.bustype = BUS_I8042;
1299         input_dev->id.vendor = 0x0002;
1300         input_dev->id.product = psmouse->type;
1301         input_dev->id.version = psmouse->model;
1302
1303         return 0;
1304 }
1305
1306 /*
1307  * psmouse_connect() is a callback from the serio module when
1308  * an unhandled serio port is found.
1309  */
1310 static int psmouse_connect(struct serio *serio, struct serio_driver *drv)
1311 {
1312         struct psmouse *psmouse, *parent = NULL;
1313         struct input_dev *input_dev;
1314         int retval = 0, error = -ENOMEM;
1315
1316         mutex_lock(&psmouse_mutex);
1317
1318         /*
1319          * If this is a pass-through port deactivate parent so the device
1320          * connected to this port can be successfully identified
1321          */
1322         if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1323                 parent = serio_get_drvdata(serio->parent);
1324                 psmouse_deactivate(parent);
1325         }
1326
1327         psmouse = kzalloc(sizeof(struct psmouse), GFP_KERNEL);
1328         input_dev = input_allocate_device();
1329         if (!psmouse || !input_dev)
1330                 goto err_free;
1331
1332         ps2_init(&psmouse->ps2dev, serio);
1333         INIT_DELAYED_WORK(&psmouse->resync_work, psmouse_resync);
1334         psmouse->dev = input_dev;
1335         snprintf(psmouse->phys, sizeof(psmouse->phys), "%s/input0", serio->phys);
1336
1337         psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1338
1339         serio_set_drvdata(serio, psmouse);
1340
1341         error = serio_open(serio, drv);
1342         if (error)
1343                 goto err_clear_drvdata;
1344
1345         if (psmouse_probe(psmouse) < 0) {
1346                 error = -ENODEV;
1347                 goto err_close_serio;
1348         }
1349
1350         psmouse->rate = psmouse_rate;
1351         psmouse->resolution = psmouse_resolution;
1352         psmouse->resetafter = psmouse_resetafter;
1353         psmouse->resync_time = parent ? 0 : psmouse_resync_time;
1354         psmouse->smartscroll = psmouse_smartscroll;
1355
1356         psmouse_switch_protocol(psmouse, NULL);
1357
1358         psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1359         psmouse_initialize(psmouse);
1360
1361         error = input_register_device(psmouse->dev);
1362         if (error)
1363                 goto err_protocol_disconnect;
1364
1365         if (parent && parent->pt_activate)
1366                 parent->pt_activate(parent);
1367
1368         error = sysfs_create_group(&serio->dev.kobj, &psmouse_attribute_group);
1369         if (error)
1370                 goto err_pt_deactivate;
1371
1372         psmouse_activate(psmouse);
1373
1374  out:
1375         /* If this is a pass-through port the parent needs to be re-activated */
1376         if (parent)
1377                 psmouse_activate(parent);
1378
1379         mutex_unlock(&psmouse_mutex);
1380         return retval;
1381
1382  err_pt_deactivate:
1383         if (parent && parent->pt_deactivate)
1384                 parent->pt_deactivate(parent);
1385         input_unregister_device(psmouse->dev);
1386         input_dev = NULL; /* so we don't try to free it below */
1387  err_protocol_disconnect:
1388         if (psmouse->disconnect)
1389                 psmouse->disconnect(psmouse);
1390         psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1391  err_close_serio:
1392         serio_close(serio);
1393  err_clear_drvdata:
1394         serio_set_drvdata(serio, NULL);
1395  err_free:
1396         input_free_device(input_dev);
1397         kfree(psmouse);
1398
1399         retval = error;
1400         goto out;
1401 }
1402
1403
1404 static int psmouse_reconnect(struct serio *serio)
1405 {
1406         struct psmouse *psmouse = serio_get_drvdata(serio);
1407         struct psmouse *parent = NULL;
1408         struct serio_driver *drv = serio->drv;
1409         unsigned char type;
1410         int rc = -1;
1411
1412         if (!drv || !psmouse) {
1413                 psmouse_dbg(psmouse,
1414                             "reconnect request, but serio is disconnected, ignoring...\n");
1415                 return -1;
1416         }
1417
1418         mutex_lock(&psmouse_mutex);
1419
1420         if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1421                 parent = serio_get_drvdata(serio->parent);
1422                 psmouse_deactivate(parent);
1423         }
1424
1425         psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1426
1427         if (psmouse->reconnect) {
1428                 if (psmouse->reconnect(psmouse))
1429                         goto out;
1430         } else {
1431                 psmouse_reset(psmouse);
1432
1433                 if (psmouse_probe(psmouse) < 0)
1434                         goto out;
1435
1436                 type = psmouse_extensions(psmouse, psmouse_max_proto, false);
1437                 if (psmouse->type != type)
1438                         goto out;
1439         }
1440
1441         /*
1442          * OK, the device type (and capabilities) match the old one,
1443          * we can continue using it, complete initialization
1444          */
1445         psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1446
1447         psmouse_initialize(psmouse);
1448
1449         if (parent && parent->pt_activate)
1450                 parent->pt_activate(parent);
1451
1452         psmouse_activate(psmouse);
1453         rc = 0;
1454
1455 out:
1456         /* If this is a pass-through port the parent waits to be activated */
1457         if (parent)
1458                 psmouse_activate(parent);
1459
1460         mutex_unlock(&psmouse_mutex);
1461         return rc;
1462 }
1463
1464 static struct serio_device_id psmouse_serio_ids[] = {
1465         {
1466                 .type   = SERIO_8042,
1467                 .proto  = SERIO_ANY,
1468                 .id     = SERIO_ANY,
1469                 .extra  = SERIO_ANY,
1470         },
1471         {
1472                 .type   = SERIO_PS_PSTHRU,
1473                 .proto  = SERIO_ANY,
1474                 .id     = SERIO_ANY,
1475                 .extra  = SERIO_ANY,
1476         },
1477         { 0 }
1478 };
1479
1480 MODULE_DEVICE_TABLE(serio, psmouse_serio_ids);
1481
1482 static struct serio_driver psmouse_drv = {
1483         .driver         = {
1484                 .name   = "psmouse",
1485         },
1486         .description    = DRIVER_DESC,
1487         .id_table       = psmouse_serio_ids,
1488         .interrupt      = psmouse_interrupt,
1489         .connect        = psmouse_connect,
1490         .reconnect      = psmouse_reconnect,
1491         .disconnect     = psmouse_disconnect,
1492         .cleanup        = psmouse_cleanup,
1493 };
1494
1495 ssize_t psmouse_attr_show_helper(struct device *dev, struct device_attribute *devattr,
1496                                  char *buf)
1497 {
1498         struct serio *serio = to_serio_port(dev);
1499         struct psmouse_attribute *attr = to_psmouse_attr(devattr);
1500         struct psmouse *psmouse;
1501
1502         psmouse = serio_get_drvdata(serio);
1503
1504         return attr->show(psmouse, attr->data, buf);
1505 }
1506
1507 ssize_t psmouse_attr_set_helper(struct device *dev, struct device_attribute *devattr,
1508                                 const char *buf, size_t count)
1509 {
1510         struct serio *serio = to_serio_port(dev);
1511         struct psmouse_attribute *attr = to_psmouse_attr(devattr);
1512         struct psmouse *psmouse, *parent = NULL;
1513         int retval;
1514
1515         retval = mutex_lock_interruptible(&psmouse_mutex);
1516         if (retval)
1517                 goto out;
1518
1519         psmouse = serio_get_drvdata(serio);
1520
1521         if (attr->protect) {
1522                 if (psmouse->state == PSMOUSE_IGNORE) {
1523                         retval = -ENODEV;
1524                         goto out_unlock;
1525                 }
1526
1527                 if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1528                         parent = serio_get_drvdata(serio->parent);
1529                         psmouse_deactivate(parent);
1530                 }
1531
1532                 psmouse_deactivate(psmouse);
1533         }
1534
1535         retval = attr->set(psmouse, attr->data, buf, count);
1536
1537         if (attr->protect) {
1538                 if (retval != -ENODEV)
1539                         psmouse_activate(psmouse);
1540
1541                 if (parent)
1542                         psmouse_activate(parent);
1543         }
1544
1545  out_unlock:
1546         mutex_unlock(&psmouse_mutex);
1547  out:
1548         return retval;
1549 }
1550
1551 static ssize_t psmouse_show_int_attr(struct psmouse *psmouse, void *offset, char *buf)
1552 {
1553         unsigned int *field = (unsigned int *)((char *)psmouse + (size_t)offset);
1554
1555         return sprintf(buf, "%u\n", *field);
1556 }
1557
1558 static ssize_t psmouse_set_int_attr(struct psmouse *psmouse, void *offset, const char *buf, size_t count)
1559 {
1560         unsigned int *field = (unsigned int *)((char *)psmouse + (size_t)offset);
1561         unsigned long value;
1562
1563         if (strict_strtoul(buf, 10, &value))
1564                 return -EINVAL;
1565
1566         if ((unsigned int)value != value)
1567                 return -EINVAL;
1568
1569         *field = value;
1570
1571         return count;
1572 }
1573
1574 static ssize_t psmouse_attr_show_protocol(struct psmouse *psmouse, void *data, char *buf)
1575 {
1576         return sprintf(buf, "%s\n", psmouse_protocol_by_type(psmouse->type)->name);
1577 }
1578
1579 static ssize_t psmouse_attr_set_protocol(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1580 {
1581         struct serio *serio = psmouse->ps2dev.serio;
1582         struct psmouse *parent = NULL;
1583         struct input_dev *old_dev, *new_dev;
1584         const struct psmouse_protocol *proto, *old_proto;
1585         int error;
1586         int retry = 0;
1587
1588         proto = psmouse_protocol_by_name(buf, count);
1589         if (!proto)
1590                 return -EINVAL;
1591
1592         if (psmouse->type == proto->type)
1593                 return count;
1594
1595         new_dev = input_allocate_device();
1596         if (!new_dev)
1597                 return -ENOMEM;
1598
1599         while (!list_empty(&serio->children)) {
1600                 if (++retry > 3) {
1601                         psmouse_warn(psmouse,
1602                                      "failed to destroy children ports, protocol change aborted.\n");
1603                         input_free_device(new_dev);
1604                         return -EIO;
1605                 }
1606
1607                 mutex_unlock(&psmouse_mutex);
1608                 serio_unregister_child_port(serio);
1609                 mutex_lock(&psmouse_mutex);
1610
1611                 if (serio->drv != &psmouse_drv) {
1612                         input_free_device(new_dev);
1613                         return -ENODEV;
1614                 }
1615
1616                 if (psmouse->type == proto->type) {
1617                         input_free_device(new_dev);
1618                         return count; /* switched by other thread */
1619                 }
1620         }
1621
1622         if (serio->parent && serio->id.type == SERIO_PS_PSTHRU) {
1623                 parent = serio_get_drvdata(serio->parent);
1624                 if (parent->pt_deactivate)
1625                         parent->pt_deactivate(parent);
1626         }
1627
1628         old_dev = psmouse->dev;
1629         old_proto = psmouse_protocol_by_type(psmouse->type);
1630
1631         if (psmouse->disconnect)
1632                 psmouse->disconnect(psmouse);
1633
1634         psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1635
1636         psmouse->dev = new_dev;
1637         psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1638
1639         if (psmouse_switch_protocol(psmouse, proto) < 0) {
1640                 psmouse_reset(psmouse);
1641                 /* default to PSMOUSE_PS2 */
1642                 psmouse_switch_protocol(psmouse, &psmouse_protocols[0]);
1643         }
1644
1645         psmouse_initialize(psmouse);
1646         psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1647
1648         error = input_register_device(psmouse->dev);
1649         if (error) {
1650                 if (psmouse->disconnect)
1651                         psmouse->disconnect(psmouse);
1652
1653                 psmouse_set_state(psmouse, PSMOUSE_IGNORE);
1654                 input_free_device(new_dev);
1655                 psmouse->dev = old_dev;
1656                 psmouse_set_state(psmouse, PSMOUSE_INITIALIZING);
1657                 psmouse_switch_protocol(psmouse, old_proto);
1658                 psmouse_initialize(psmouse);
1659                 psmouse_set_state(psmouse, PSMOUSE_CMD_MODE);
1660
1661                 return error;
1662         }
1663
1664         input_unregister_device(old_dev);
1665
1666         if (parent && parent->pt_activate)
1667                 parent->pt_activate(parent);
1668
1669         return count;
1670 }
1671
1672 static ssize_t psmouse_attr_set_rate(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1673 {
1674         unsigned long value;
1675
1676         if (strict_strtoul(buf, 10, &value))
1677                 return -EINVAL;
1678
1679         psmouse->set_rate(psmouse, value);
1680         return count;
1681 }
1682
1683 static ssize_t psmouse_attr_set_resolution(struct psmouse *psmouse, void *data, const char *buf, size_t count)
1684 {
1685         unsigned long value;
1686
1687         if (strict_strtoul(buf, 10, &value))
1688                 return -EINVAL;
1689
1690         psmouse->set_resolution(psmouse, value);
1691         return count;
1692 }
1693
1694
1695 static int psmouse_set_maxproto(const char *val, const struct kernel_param *kp)
1696 {
1697         const struct psmouse_protocol *proto;
1698
1699         if (!val)
1700                 return -EINVAL;
1701
1702         proto = psmouse_protocol_by_name(val, strlen(val));
1703
1704         if (!proto || !proto->maxproto)
1705                 return -EINVAL;
1706
1707         *((unsigned int *)kp->arg) = proto->type;
1708
1709         return 0;
1710 }
1711
1712 static int psmouse_get_maxproto(char *buffer, const struct kernel_param *kp)
1713 {
1714         int type = *((unsigned int *)kp->arg);
1715
1716         return sprintf(buffer, "%s", psmouse_protocol_by_type(type)->name);
1717 }
1718
1719 static int __init psmouse_init(void)
1720 {
1721         int err;
1722
1723         lifebook_module_init();
1724         synaptics_module_init();
1725         hgpk_module_init();
1726
1727         kpsmoused_wq = create_singlethread_workqueue("kpsmoused");
1728         if (!kpsmoused_wq) {
1729                 pr_err("failed to create kpsmoused workqueue\n");
1730                 return -ENOMEM;
1731         }
1732
1733         err = serio_register_driver(&psmouse_drv);
1734         if (err)
1735                 destroy_workqueue(kpsmoused_wq);
1736
1737         return err;
1738 }
1739
1740 static void __exit psmouse_exit(void)
1741 {
1742         serio_unregister_driver(&psmouse_drv);
1743         destroy_workqueue(kpsmoused_wq);
1744 }
1745
1746 module_init(psmouse_init);
1747 module_exit(psmouse_exit);