1 /* 2 * ALPS touchpad PS/2 mouse driver 3 * 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> 8 * 9 * ALPS detection, tap switching and status querying info is taken from 10 * tpconfig utility (by C. Scott Ananian and Bruce Kall). 11 * 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. 15 */ 16 17 #include <linux/input.h> 18 #include <linux/serio.h> 19 #include <linux/libps2.h> 20 21 #include "psmouse.h" 22 #include "alps.h" 23 24 #undef DEBUG 25 #ifdef DEBUG 26 #define dbg(format, arg...) printk(KERN_INFO "alps.c: " format "\n", ## arg) 27 #else 28 #define dbg(format, arg...) do {} while (0) 29 #endif 30 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 38 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 */ 59 }; 60 61 /* 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. 65 */ 66 67 /* 68 * ALPS abolute Mode - new format 69 * 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 76 * 77 * ?'s can have different meanings on different models, 78 * such as wheel rotation, extra buttons, stick buttons 79 * on a dualpoint, etc. 80 */ 81 82 static void alps_process_packet(struct psmouse *psmouse) 83 { 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; 90 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); 99 input_sync(dev2); 100 return; 101 } 102 103 if (priv->i->flags & ALPS_OLDPROTO) { 104 left = packet[2] & 0x10; 105 right = packet[2] & 0x08; 106 middle = 0; 107 x = packet[1] | ((packet[0] & 0x07) << 7); 108 y = packet[4] | ((packet[3] & 0x07) << 7); 109 z = packet[5]; 110 } else { 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)); 116 z = packet[5]; 117 } 118 119 if (priv->i->flags & ALPS_FW_BK_1) { 120 back = packet[0] & 0x10; 121 forward = packet[2] & 4; 122 } 123 124 if (priv->i->flags & ALPS_FW_BK_2) { 125 back = packet[3] & 4; 126 forward = packet[2] & 4; 127 if ((middle = forward && back)) 128 forward = back = 0; 129 } 130 131 ges = packet[2] & 1; 132 fin = packet[2] & 2; 133 134 input_report_key(dev, BTN_LEFT, left); 135 input_report_key(dev, BTN_RIGHT, right); 136 input_report_key(dev, BTN_MIDDLE, middle); 137 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)); 141 input_sync(dev); 142 input_sync(dev2); 143 return; 144 } 145 146 /* Convert hardware tap to a reasonable Z value */ 147 if (ges && !fin) z = 40; 148 149 /* 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. 153 */ 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); 159 input_sync(dev); 160 } 161 priv->prev_fin = fin; 162 163 if (z > 30) input_report_key(dev, BTN_TOUCH, 1); 164 if (z < 25) input_report_key(dev, BTN_TOUCH, 0); 165 166 if (z > 0) { 167 input_report_abs(dev, ABS_X, x); 168 input_report_abs(dev, ABS_Y, y); 169 } 170 171 input_report_abs(dev, ABS_PRESSURE, z); 172 input_report_key(dev, BTN_TOOL_FINGER, z > 0); 173 174 if (priv->i->flags & ALPS_WHEEL) 175 input_report_rel(dev, REL_WHEEL, ((packet[2] << 1) & 0x08) - ((packet[0] >> 4) & 0x07)); 176 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); 180 } 181 182 input_sync(dev); 183 } 184 185 static psmouse_ret_t alps_process_byte(struct psmouse *psmouse) 186 { 187 struct alps_data *priv = psmouse->private; 188 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; 193 } 194 return PSMOUSE_GOOD_DATA; 195 } 196 197 if ((psmouse->packet[0] & priv->i->mask0) != priv->i->byte0) 198 return PSMOUSE_BAD_DATA; 199 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; 204 205 if (psmouse->pktcnt == 6) { 206 alps_process_packet(psmouse); 207 return PSMOUSE_FULL_PACKET; 208 } 209 210 return PSMOUSE_GOOD_DATA; 211 } 212 213 static const struct alps_model_info *alps_get_model(struct psmouse *psmouse, int *version) 214 { 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]; 218 int i; 219 220 /* 221 * First try "E6 report". 222 * ALPS should return 0,0,10 or 0,0,100 223 */ 224 param[0] = 0; 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)) 229 return NULL; 230 231 param[0] = param[1] = param[2] = 0xff; 232 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) 233 return NULL; 234 235 dbg("E6 report: %2.2x %2.2x %2.2x", param[0], param[1], param[2]); 236 237 if (param[0] != 0 || param[1] != 0 || (param[2] != 10 && param[2] != 100)) 238 return NULL; 239 240 /* 241 * Now try "E7 report". Allowed responses are in 242 * alps_model_data[].signature 243 */ 244 param[0] = 0; 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)) 249 return NULL; 250 251 param[0] = param[1] = param[2] = 0xff; 252 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) 253 return NULL; 254 255 dbg("E7 report: %2.2x %2.2x %2.2x", param[0], param[1], param[2]); 256 257 if (version) { 258 for (i = 0; i < ARRAY_SIZE(rates) && param[2] != rates[i]; i++) 259 /* empty */; 260 *version = (param[0] << 8) | (param[1] << 4) | i; 261 } 262 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; 267 268 return NULL; 269 } 270 271 /* 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... 275 */ 276 static int alps_passthrough_mode(struct psmouse *psmouse, int enable) 277 { 278 struct ps2dev *ps2dev = &psmouse->ps2dev; 279 int cmd = enable ? PSMOUSE_CMD_SETSCALE21 : PSMOUSE_CMD_SETSCALE11; 280 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)) 285 return -1; 286 287 /* we may get 3 more bytes, just ignore them */ 288 ps2_drain(ps2dev, 3, 100); 289 290 return 0; 291 } 292 293 static int alps_absolute_mode(struct psmouse *psmouse) 294 { 295 struct ps2dev *ps2dev = &psmouse->ps2dev; 296 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)) 303 return -1; 304 305 /* 306 * Switch mouse to poll (remote) mode so motion data will not 307 * get in our way 308 */ 309 return ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETPOLL); 310 } 311 312 static int alps_get_status(struct psmouse *psmouse, char *param) 313 { 314 struct ps2dev *ps2dev = &psmouse->ps2dev; 315 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)) 321 return -1; 322 323 dbg("Status: %2.2x %2.2x %2.2x", param[0], param[1], param[2]); 324 325 return 0; 326 } 327 328 /* 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. 336 */ 337 static int alps_tap_mode(struct psmouse *psmouse, int enable) 338 { 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]; 343 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)) 348 return -1; 349 350 if (alps_get_status(psmouse, param)) 351 return -1; 352 353 return 0; 354 } 355 356 /* 357 * alps_poll() - poll the touchpad for current motion packet. 358 * Used in resync. 359 */ 360 static int alps_poll(struct psmouse *psmouse) 361 { 362 struct alps_data *priv = psmouse->private; 363 unsigned char buf[6]; 364 int poll_failed; 365 366 if (priv->i->flags & ALPS_PASS) 367 alps_passthrough_mode(psmouse, 1); 368 369 poll_failed = ps2_command(&psmouse->ps2dev, buf, 370 PSMOUSE_CMD_POLL | (psmouse->pktsize << 8)) < 0; 371 372 if (priv->i->flags & ALPS_PASS) 373 alps_passthrough_mode(psmouse, 0); 374 375 if (poll_failed || (buf[0] & priv->i->mask0) != priv->i->byte0) 376 return -1; 377 378 if ((psmouse->badbyte & 0xc8) == 0x08) { 379 /* 380 * Poll the track stick ... 381 */ 382 if (ps2_command(&psmouse->ps2dev, buf, PSMOUSE_CMD_POLL | (3 << 8))) 383 return -1; 384 } 385 386 memcpy(psmouse->packet, buf, sizeof(buf)); 387 return 0; 388 } 389 390 static int alps_hw_init(struct psmouse *psmouse, int *version) 391 { 392 struct alps_data *priv = psmouse->private; 393 394 priv->i = alps_get_model(psmouse, version); 395 if (!priv->i) 396 return -1; 397 398 if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 1)) 399 return -1; 400 401 if (alps_tap_mode(psmouse, 1)) { 402 printk(KERN_WARNING "alps.c: Failed to enable hardware tapping\n"); 403 return -1; 404 } 405 406 if (alps_absolute_mode(psmouse)) { 407 printk(KERN_ERR "alps.c: Failed to enable absolute mode\n"); 408 return -1; 409 } 410 411 if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 0)) 412 return -1; 413 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"); 417 return -1; 418 } 419 420 return 0; 421 } 422 423 static int alps_reconnect(struct psmouse *psmouse) 424 { 425 psmouse_reset(psmouse); 426 427 if (alps_hw_init(psmouse, NULL)) 428 return -1; 429 430 return 0; 431 } 432 433 static void alps_disconnect(struct psmouse *psmouse) 434 { 435 struct alps_data *priv = psmouse->private; 436 437 psmouse_reset(psmouse); 438 input_unregister_device(priv->dev2); 439 kfree(priv); 440 } 441 442 int alps_init(struct psmouse *psmouse) 443 { 444 struct alps_data *priv; 445 struct input_dev *dev1 = psmouse->dev, *dev2; 446 int version; 447 448 priv = kzalloc(sizeof(struct alps_data), GFP_KERNEL); 449 dev2 = input_allocate_device(); 450 if (!priv || !dev2) 451 goto init_fail; 452 453 priv->dev2 = dev2; 454 psmouse->private = priv; 455 456 if (alps_hw_init(psmouse, &version)) 457 goto init_fail; 458 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); 464 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); 469 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); 473 } 474 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); 478 } 479 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; 488 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); 493 494 if (input_register_device(priv->dev2)) 495 goto init_fail; 496 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; 502 503 /* We are having trouble resyncing ALPS touchpads so disable it for now */ 504 psmouse->resync_time = 0; 505 506 return 0; 507 508 init_fail: 509 psmouse_reset(psmouse); 510 input_free_device(dev2); 511 kfree(priv); 512 psmouse->private = NULL; 513 return -1; 514 } 515 516 int alps_detect(struct psmouse *psmouse, int set_properties) 517 { 518 int version; 519 const struct alps_model_info *model; 520 521 model = alps_get_model(psmouse, &version); 522 if (!model) 523 return -1; 524 525 if (set_properties) { 526 psmouse->vendor = "ALPS"; 527 psmouse->name = model->flags & ALPS_DUALPOINT ? 528 "DualPoint TouchPad" : "GlidePoint"; 529 psmouse->model = version; 530 } 531 return 0; 532 } 533 534