2  * ALPS touchpad PS/2 mouse driver
 
   4  * Copyright (c) 2003 Neil Brown <neilb@cse.unsw.edu.au>
 
   5  * Copyright (c) 2003-2005 Peter Osterlund <petero2@telia.com>
 
   6  * Copyright (c) 2004 Dmitry Torokhov <dtor@mail.ru>
 
   7  * Copyright (c) 2005 Vojtech Pavlik <vojtech@suse.cz>
 
   9  * ALPS detection, tap switching and status querying info is taken from
 
  10  * tpconfig utility (by C. Scott Ananian and Bruce Kall).
 
  12  * This program is free software; you can redistribute it and/or modify it
 
  13  * under the terms of the GNU General Public License version 2 as published by
 
  14  * the Free Software Foundation.
 
  17 #include <linux/input.h>
 
  18 #include <linux/serio.h>
 
  19 #include <linux/libps2.h>
 
  26 #define dbg(format, arg...) printk(KERN_INFO "alps.c: " format "\n", ## arg)
 
  28 #define dbg(format, arg...) do {} while (0)
 
  31 #define ALPS_DUALPOINT  0x01
 
  32 #define ALPS_WHEEL      0x02
 
  33 #define ALPS_FW_BK_1    0x04
 
  34 #define ALPS_4BTN       0x08
 
  35 #define ALPS_OLDPROTO   0x10
 
  36 #define ALPS_PASS       0x20
 
  37 #define ALPS_FW_BK_2    0x40
 
  39 static const struct alps_model_info alps_model_data[] = {
 
  40         { { 0x33, 0x02, 0x0a }, 0x88, 0xf8, ALPS_OLDPROTO },            /* UMAX-530T */
 
  41         { { 0x53, 0x02, 0x0a }, 0xf8, 0xf8, 0 },
 
  42         { { 0x53, 0x02, 0x14 }, 0xf8, 0xf8, 0 },
 
  43         { { 0x60, 0x03, 0xc8 }, 0xf8, 0xf8, 0 },                        /* HP ze1115 */
 
  44         { { 0x63, 0x02, 0x0a }, 0xf8, 0xf8, 0 },
 
  45         { { 0x63, 0x02, 0x14 }, 0xf8, 0xf8, 0 },
 
  46         { { 0x63, 0x02, 0x28 }, 0xf8, 0xf8, ALPS_FW_BK_2 },             /* Fujitsu Siemens S6010 */
 
  47         { { 0x63, 0x02, 0x3c }, 0x8f, 0x8f, ALPS_WHEEL },               /* Toshiba Satellite S2400-103 */
 
  48         { { 0x63, 0x02, 0x50 }, 0xef, 0xef, ALPS_FW_BK_1 },             /* NEC Versa L320 */
 
  49         { { 0x63, 0x02, 0x64 }, 0xf8, 0xf8, 0 },
 
  50         { { 0x63, 0x03, 0xc8 }, 0xf8, 0xf8, ALPS_PASS },                /* Dell Latitude D800 */
 
  51         { { 0x73, 0x00, 0x0a }, 0xf8, 0xf8, ALPS_DUALPOINT },           /* ThinkPad R61 8918-5QG */
 
  52         { { 0x73, 0x02, 0x0a }, 0xf8, 0xf8, 0 },
 
  53         { { 0x73, 0x02, 0x14 }, 0xf8, 0xf8, ALPS_FW_BK_2 },             /* Ahtec Laptop */
 
  54         { { 0x20, 0x02, 0x0e }, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT }, /* XXX */
 
  55         { { 0x22, 0x02, 0x0a }, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT },
 
  56         { { 0x22, 0x02, 0x14 }, 0xff, 0xff, ALPS_PASS | ALPS_DUALPOINT }, /* Dell Latitude D600 */
 
  57         { { 0x62, 0x02, 0x14 }, 0xcf, 0xcf, ALPS_PASS | ALPS_DUALPOINT }, /* Dell Latitude E6500 */
 
  58         { { 0x73, 0x02, 0x50 }, 0xcf, 0xcf, ALPS_FW_BK_1 } /* Dell Vostro 1400 */
 
  62  * XXX - this entry is suspicious. First byte has zero lower nibble,
 
  63  * which is what a normal mouse would report. Also, the value 0x0e
 
  64  * isn't valid per PS/2 spec.
 
  68  * ALPS abolute Mode - new format
 
  70  * byte 0:  1    ?    ?    ?    1    ?    ?    ?
 
  71  * byte 1:  0   x6   x5   x4   x3   x2   x1   x0
 
  72  * byte 2:  0   x10  x9   x8   x7    ?  fin  ges
 
  73  * byte 3:  0   y9   y8   y7    1    M    R    L
 
  74  * byte 4:  0   y6   y5   y4   y3   y2   y1   y0
 
  75  * byte 5:  0   z6   z5   z4   z3   z2   z1   z0
 
  77  * ?'s can have different meanings on different models,
 
  78  * such as wheel rotation, extra buttons, stick buttons
 
  79  * on a dualpoint, etc.
 
  82 static void alps_process_packet(struct psmouse *psmouse)
 
  84         struct alps_data *priv = psmouse->private;
 
  85         unsigned char *packet = psmouse->packet;
 
  86         struct input_dev *dev = psmouse->dev;
 
  87         struct input_dev *dev2 = priv->dev2;
 
  88         int x, y, z, ges, fin, left, right, middle;
 
  89         int back = 0, forward = 0;
 
  91         if ((packet[0] & 0xc8) == 0x08) {   /* 3-byte PS/2 packet */
 
  92                 input_report_key(dev2, BTN_LEFT,   packet[0] & 1);
 
  93                 input_report_key(dev2, BTN_RIGHT,  packet[0] & 2);
 
  94                 input_report_key(dev2, BTN_MIDDLE, packet[0] & 4);
 
  95                 input_report_rel(dev2, REL_X,
 
  96                         packet[1] ? packet[1] - ((packet[0] << 4) & 0x100) : 0);
 
  97                 input_report_rel(dev2, REL_Y,
 
  98                         packet[2] ? ((packet[0] << 3) & 0x100) - packet[2] : 0);
 
 103         if (priv->i->flags & ALPS_OLDPROTO) {
 
 104                 left = packet[2] & 0x10;
 
 105                 right = packet[2] & 0x08;
 
 107                 x = packet[1] | ((packet[0] & 0x07) << 7);
 
 108                 y = packet[4] | ((packet[3] & 0x07) << 7);
 
 111                 left = packet[3] & 1;
 
 112                 right = packet[3] & 2;
 
 113                 middle = packet[3] & 4;
 
 114                 x = packet[1] | ((packet[2] & 0x78) << (7 - 3));
 
 115                 y = packet[4] | ((packet[3] & 0x70) << (7 - 4));
 
 119         if (priv->i->flags & ALPS_FW_BK_1) {
 
 120                 back = packet[0] & 0x10;
 
 121                 forward = packet[2] & 4;
 
 124         if (priv->i->flags & ALPS_FW_BK_2) {
 
 125                 back = packet[3] & 4;
 
 126                 forward = packet[2] & 4;
 
 127                 if ((middle = forward && back))
 
 134         input_report_key(dev, BTN_LEFT, left);
 
 135         input_report_key(dev, BTN_RIGHT, right);
 
 136         input_report_key(dev, BTN_MIDDLE, middle);
 
 138         if ((priv->i->flags & ALPS_DUALPOINT) && z == 127) {
 
 139                 input_report_rel(dev2, REL_X,  (x > 383 ? (x - 768) : x));
 
 140                 input_report_rel(dev2, REL_Y, -(y > 255 ? (y - 512) : y));
 
 146         /* Convert hardware tap to a reasonable Z value */
 
 147         if (ges && !fin) z = 40;
 
 150          * A "tap and drag" operation is reported by the hardware as a transition
 
 151          * from (!fin && ges) to (fin && ges). This should be translated to the
 
 152          * sequence Z>0, Z==0, Z>0, so the Z==0 event has to be generated manually.
 
 154         if (ges && fin && !priv->prev_fin) {
 
 155                 input_report_abs(dev, ABS_X, x);
 
 156                 input_report_abs(dev, ABS_Y, y);
 
 157                 input_report_abs(dev, ABS_PRESSURE, 0);
 
 158                 input_report_key(dev, BTN_TOOL_FINGER, 0);
 
 161         priv->prev_fin = fin;
 
 163         if (z > 30) input_report_key(dev, BTN_TOUCH, 1);
 
 164         if (z < 25) input_report_key(dev, BTN_TOUCH, 0);
 
 167                 input_report_abs(dev, ABS_X, x);
 
 168                 input_report_abs(dev, ABS_Y, y);
 
 171         input_report_abs(dev, ABS_PRESSURE, z);
 
 172         input_report_key(dev, BTN_TOOL_FINGER, z > 0);
 
 174         if (priv->i->flags & ALPS_WHEEL)
 
 175                 input_report_rel(dev, REL_WHEEL, ((packet[2] << 1) & 0x08) - ((packet[0] >> 4) & 0x07));
 
 177         if (priv->i->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
 
 178                 input_report_key(dev, BTN_FORWARD, forward);
 
 179                 input_report_key(dev, BTN_BACK, back);
 
 185 static psmouse_ret_t alps_process_byte(struct psmouse *psmouse)
 
 187         struct alps_data *priv = psmouse->private;
 
 189         if ((psmouse->packet[0] & 0xc8) == 0x08) { /* PS/2 packet */
 
 190                 if (psmouse->pktcnt == 3) {
 
 191                         alps_process_packet(psmouse);
 
 192                         return PSMOUSE_FULL_PACKET;
 
 194                 return PSMOUSE_GOOD_DATA;
 
 197         if ((psmouse->packet[0] & priv->i->mask0) != priv->i->byte0)
 
 198                 return PSMOUSE_BAD_DATA;
 
 200         /* Bytes 2 - 6 should have 0 in the highest bit */
 
 201         if (psmouse->pktcnt >= 2 && psmouse->pktcnt <= 6 &&
 
 202             (psmouse->packet[psmouse->pktcnt - 1] & 0x80))
 
 203                 return PSMOUSE_BAD_DATA;
 
 205         if (psmouse->pktcnt == 6) {
 
 206                 alps_process_packet(psmouse);
 
 207                 return PSMOUSE_FULL_PACKET;
 
 210         return PSMOUSE_GOOD_DATA;
 
 213 static const struct alps_model_info *alps_get_model(struct psmouse *psmouse, int *version)
 
 215         struct ps2dev *ps2dev = &psmouse->ps2dev;
 
 216         static const unsigned char rates[] = { 0, 10, 20, 40, 60, 80, 100, 200 };
 
 217         unsigned char param[4];
 
 221          * First try "E6 report".
 
 222          * ALPS should return 0,0,10 or 0,0,100
 
 225         if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
 
 226             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
 
 227             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11) ||
 
 228             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11))
 
 231         param[0] = param[1] = param[2] = 0xff;
 
 232         if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
 
 235         dbg("E6 report: %2.2x %2.2x %2.2x", param[0], param[1], param[2]);
 
 237         if (param[0] != 0 || param[1] != 0 || (param[2] != 10 && param[2] != 100))
 
 241          * Now try "E7 report". Allowed responses are in
 
 242          * alps_model_data[].signature
 
 245         if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
 
 246             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE21) ||
 
 247             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE21) ||
 
 248             ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE21))
 
 251         param[0] = param[1] = param[2] = 0xff;
 
 252         if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
 
 255         dbg("E7 report: %2.2x %2.2x %2.2x", param[0], param[1], param[2]);
 
 258                 for (i = 0; i < ARRAY_SIZE(rates) && param[2] != rates[i]; i++)
 
 260                 *version = (param[0] << 8) | (param[1] << 4) | i;
 
 263         for (i = 0; i < ARRAY_SIZE(alps_model_data); i++)
 
 264                 if (!memcmp(param, alps_model_data[i].signature,
 
 265                             sizeof(alps_model_data[i].signature)))
 
 266                         return alps_model_data + i;
 
 272  * For DualPoint devices select the device that should respond to
 
 273  * subsequent commands. It looks like glidepad is behind stickpointer,
 
 274  * I'd thought it would be other way around...
 
 276 static int alps_passthrough_mode(struct psmouse *psmouse, int enable)
 
 278         struct ps2dev *ps2dev = &psmouse->ps2dev;
 
 279         int cmd = enable ? PSMOUSE_CMD_SETSCALE21 : PSMOUSE_CMD_SETSCALE11;
 
 281         if (ps2_command(ps2dev, NULL, cmd) ||
 
 282             ps2_command(ps2dev, NULL, cmd) ||
 
 283             ps2_command(ps2dev, NULL, cmd) ||
 
 284             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE))
 
 287         /* we may get 3 more bytes, just ignore them */
 
 288         ps2_drain(ps2dev, 3, 100);
 
 293 static int alps_absolute_mode(struct psmouse *psmouse)
 
 295         struct ps2dev *ps2dev = &psmouse->ps2dev;
 
 297         /* Try ALPS magic knock - 4 disable before enable */
 
 298         if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
 
 299             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
 
 300             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
 
 301             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
 
 302             ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE))
 
 306          * Switch mouse to poll (remote) mode so motion data will not
 
 309         return ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETPOLL);
 
 312 static int alps_get_status(struct psmouse *psmouse, char *param)
 
 314         struct ps2dev *ps2dev = &psmouse->ps2dev;
 
 316         /* Get status: 0xF5 0xF5 0xF5 0xE9 */
 
 317         if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
 
 318             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
 
 319             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
 
 320             ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
 
 323         dbg("Status: %2.2x %2.2x %2.2x", param[0], param[1], param[2]);
 
 329  * Turn touchpad tapping on or off. The sequences are:
 
 330  * 0xE9 0xF5 0xF5 0xF3 0x0A to enable,
 
 331  * 0xE9 0xF5 0xF5 0xE8 0x00 to disable.
 
 332  * My guess that 0xE9 (GetInfo) is here as a sync point.
 
 333  * For models that also have stickpointer (DualPoints) its tapping
 
 334  * is controlled separately (0xE6 0xE6 0xE6 0xF3 0x14|0x0A) but
 
 335  * we don't fiddle with it.
 
 337 static int alps_tap_mode(struct psmouse *psmouse, int enable)
 
 339         struct ps2dev *ps2dev = &psmouse->ps2dev;
 
 340         int cmd = enable ? PSMOUSE_CMD_SETRATE : PSMOUSE_CMD_SETRES;
 
 341         unsigned char tap_arg = enable ? 0x0A : 0x00;
 
 342         unsigned char param[4];
 
 344         if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO) ||
 
 345             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
 
 346             ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) ||
 
 347             ps2_command(ps2dev, &tap_arg, cmd))
 
 350         if (alps_get_status(psmouse, param))
 
 357  * alps_poll() - poll the touchpad for current motion packet.
 
 360 static int alps_poll(struct psmouse *psmouse)
 
 362         struct alps_data *priv = psmouse->private;
 
 363         unsigned char buf[6];
 
 366         if (priv->i->flags & ALPS_PASS)
 
 367                 alps_passthrough_mode(psmouse, 1);
 
 369         poll_failed = ps2_command(&psmouse->ps2dev, buf,
 
 370                                   PSMOUSE_CMD_POLL | (psmouse->pktsize << 8)) < 0;
 
 372         if (priv->i->flags & ALPS_PASS)
 
 373                 alps_passthrough_mode(psmouse, 0);
 
 375         if (poll_failed || (buf[0] & priv->i->mask0) != priv->i->byte0)
 
 378         if ((psmouse->badbyte & 0xc8) == 0x08) {
 
 380  * Poll the track stick ...
 
 382                 if (ps2_command(&psmouse->ps2dev, buf, PSMOUSE_CMD_POLL | (3 << 8)))
 
 386         memcpy(psmouse->packet, buf, sizeof(buf));
 
 390 static int alps_hw_init(struct psmouse *psmouse, int *version)
 
 392         struct alps_data *priv = psmouse->private;
 
 394         priv->i = alps_get_model(psmouse, version);
 
 398         if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 1))
 
 401         if (alps_tap_mode(psmouse, 1)) {
 
 402                 printk(KERN_WARNING "alps.c: Failed to enable hardware tapping\n");
 
 406         if (alps_absolute_mode(psmouse)) {
 
 407                 printk(KERN_ERR "alps.c: Failed to enable absolute mode\n");
 
 411         if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 0))
 
 414         /* ALPS needs stream mode, otherwise it won't report any data */
 
 415         if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSTREAM)) {
 
 416                 printk(KERN_ERR "alps.c: Failed to enable stream mode\n");
 
 423 static int alps_reconnect(struct psmouse *psmouse)
 
 425         psmouse_reset(psmouse);
 
 427         if (alps_hw_init(psmouse, NULL))
 
 433 static void alps_disconnect(struct psmouse *psmouse)
 
 435         struct alps_data *priv = psmouse->private;
 
 437         psmouse_reset(psmouse);
 
 438         input_unregister_device(priv->dev2);
 
 442 int alps_init(struct psmouse *psmouse)
 
 444         struct alps_data *priv;
 
 445         struct input_dev *dev1 = psmouse->dev, *dev2;
 
 448         priv = kzalloc(sizeof(struct alps_data), GFP_KERNEL);
 
 449         dev2 = input_allocate_device();
 
 454         psmouse->private = priv;
 
 456         if (alps_hw_init(psmouse, &version))
 
 459         dev1->evbit[BIT_WORD(EV_KEY)] |= BIT_MASK(EV_KEY);
 
 460         dev1->keybit[BIT_WORD(BTN_TOUCH)] |= BIT_MASK(BTN_TOUCH);
 
 461         dev1->keybit[BIT_WORD(BTN_TOOL_FINGER)] |= BIT_MASK(BTN_TOOL_FINGER);
 
 462         dev1->keybit[BIT_WORD(BTN_LEFT)] |= BIT_MASK(BTN_LEFT) |
 
 463                 BIT_MASK(BTN_MIDDLE) | BIT_MASK(BTN_RIGHT);
 
 465         dev1->evbit[BIT_WORD(EV_ABS)] |= BIT_MASK(EV_ABS);
 
 466         input_set_abs_params(dev1, ABS_X, 0, 1023, 0, 0);
 
 467         input_set_abs_params(dev1, ABS_Y, 0, 767, 0, 0);
 
 468         input_set_abs_params(dev1, ABS_PRESSURE, 0, 127, 0, 0);
 
 470         if (priv->i->flags & ALPS_WHEEL) {
 
 471                 dev1->evbit[BIT_WORD(EV_REL)] |= BIT_MASK(EV_REL);
 
 472                 dev1->relbit[BIT_WORD(REL_WHEEL)] |= BIT_MASK(REL_WHEEL);
 
 475         if (priv->i->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) {
 
 476                 dev1->keybit[BIT_WORD(BTN_FORWARD)] |= BIT_MASK(BTN_FORWARD);
 
 477                 dev1->keybit[BIT_WORD(BTN_BACK)] |= BIT_MASK(BTN_BACK);
 
 480         snprintf(priv->phys, sizeof(priv->phys), "%s/input1", psmouse->ps2dev.serio->phys);
 
 481         dev2->phys = priv->phys;
 
 482         dev2->name = (priv->i->flags & ALPS_DUALPOINT) ? "DualPoint Stick" : "PS/2 Mouse";
 
 483         dev2->id.bustype = BUS_I8042;
 
 484         dev2->id.vendor  = 0x0002;
 
 485         dev2->id.product = PSMOUSE_ALPS;
 
 486         dev2->id.version = 0x0000;
 
 487         dev2->dev.parent = &psmouse->ps2dev.serio->dev;
 
 489         dev2->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
 
 490         dev2->relbit[BIT_WORD(REL_X)] |= BIT_MASK(REL_X) | BIT_MASK(REL_Y);
 
 491         dev2->keybit[BIT_WORD(BTN_LEFT)] |= BIT_MASK(BTN_LEFT) |
 
 492                 BIT_MASK(BTN_MIDDLE) | BIT_MASK(BTN_RIGHT);
 
 494         if (input_register_device(priv->dev2))
 
 497         psmouse->protocol_handler = alps_process_byte;
 
 498         psmouse->poll = alps_poll;
 
 499         psmouse->disconnect = alps_disconnect;
 
 500         psmouse->reconnect = alps_reconnect;
 
 501         psmouse->pktsize = 6;
 
 503         /* We are having trouble resyncing ALPS touchpads so disable it for now */
 
 504         psmouse->resync_time = 0;
 
 509         psmouse_reset(psmouse);
 
 510         input_free_device(dev2);
 
 512         psmouse->private = NULL;
 
 516 int alps_detect(struct psmouse *psmouse, int set_properties)
 
 519         const struct alps_model_info *model;
 
 521         model = alps_get_model(psmouse, &version);
 
 525         if (set_properties) {
 
 526                 psmouse->vendor = "ALPS";
 
 527                 psmouse->name = model->flags & ALPS_DUALPOINT ?
 
 528                                 "DualPoint TouchPad" : "GlidePoint";
 
 529                 psmouse->model = version;