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