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 39static 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, 0x02, 0x0a }, 0xf8, 0xf8, 0 }, 52 { { 0x73, 0x02, 0x14 }, 0xf8, 0xf8, ALPS_FW_BK_2 }, /* Ahtec Laptop */ 53 { { 0x20, 0x02, 0x0e }, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT }, 54 { { 0x22, 0x02, 0x0a }, 0xf8, 0xf8, ALPS_PASS | ALPS_DUALPOINT }, 55 { { 0x22, 0x02, 0x14 }, 0xff, 0xff, ALPS_PASS | ALPS_DUALPOINT }, /* Dell Latitude D600 */ 56}; 57 58 59/* 60 * ALPS abolute Mode - new format 61 * 62 * byte 0: 1 ? ? ? 1 ? ? ? 63 * byte 1: 0 x6 x5 x4 x3 x2 x1 x0 64 * byte 2: 0 x10 x9 x8 x7 ? fin ges 65 * byte 3: 0 y9 y8 y7 1 M R L 66 * byte 4: 0 y6 y5 y4 y3 y2 y1 y0 67 * byte 5: 0 z6 z5 z4 z3 z2 z1 z0 68 * 69 * ?'s can have different meanings on different models, 70 * such as wheel rotation, extra buttons, stick buttons 71 * on a dualpoint, etc. 72 */ 73 74static void alps_process_packet(struct psmouse *psmouse) 75{ 76 struct alps_data *priv = psmouse->private; 77 unsigned char *packet = psmouse->packet; 78 struct input_dev *dev = psmouse->dev; 79 struct input_dev *dev2 = priv->dev2; 80 int x, y, z, ges, fin, left, right, middle; 81 int back = 0, forward = 0; 82 83 if ((packet[0] & 0xc8) == 0x08) { /* 3-byte PS/2 packet */ 84 input_report_key(dev2, BTN_LEFT, packet[0] & 1); 85 input_report_key(dev2, BTN_RIGHT, packet[0] & 2); 86 input_report_key(dev2, BTN_MIDDLE, packet[0] & 4); 87 input_report_rel(dev2, REL_X, 88 packet[1] ? packet[1] - ((packet[0] << 4) & 0x100) : 0); 89 input_report_rel(dev2, REL_Y, 90 packet[2] ? ((packet[0] << 3) & 0x100) - packet[2] : 0); 91 input_sync(dev2); 92 return; 93 } 94 95 if (priv->i->flags & ALPS_OLDPROTO) { 96 left = packet[2] & 0x10; 97 right = packet[2] & 0x08; 98 middle = 0; 99 x = packet[1] | ((packet[0] & 0x07) << 7); 100 y = packet[4] | ((packet[3] & 0x07) << 7); 101 z = packet[5]; 102 } else { 103 left = packet[3] & 1; 104 right = packet[3] & 2; 105 middle = packet[3] & 4; 106 x = packet[1] | ((packet[2] & 0x78) << (7 - 3)); 107 y = packet[4] | ((packet[3] & 0x70) << (7 - 4)); 108 z = packet[5]; 109 } 110 111 if (priv->i->flags & ALPS_FW_BK_1) { 112 back = packet[2] & 4; 113 forward = packet[0] & 0x10; 114 } 115 116 if (priv->i->flags & ALPS_FW_BK_2) { 117 back = packet[3] & 4; 118 forward = packet[2] & 4; 119 if ((middle = forward && back)) 120 forward = back = 0; 121 } 122 123 ges = packet[2] & 1; 124 fin = packet[2] & 2; 125 126 input_report_key(dev, BTN_LEFT, left); 127 input_report_key(dev, BTN_RIGHT, right); 128 input_report_key(dev, BTN_MIDDLE, middle); 129 130 if ((priv->i->flags & ALPS_DUALPOINT) && z == 127) { 131 input_report_rel(dev2, REL_X, (x > 383 ? (x - 768) : x)); 132 input_report_rel(dev2, REL_Y, -(y > 255 ? (y - 512) : y)); 133 input_sync(dev); 134 input_sync(dev2); 135 return; 136 } 137 138 /* Convert hardware tap to a reasonable Z value */ 139 if (ges && !fin) z = 40; 140 141 /* 142 * A "tap and drag" operation is reported by the hardware as a transition 143 * from (!fin && ges) to (fin && ges). This should be translated to the 144 * sequence Z>0, Z==0, Z>0, so the Z==0 event has to be generated manually. 145 */ 146 if (ges && fin && !priv->prev_fin) { 147 input_report_abs(dev, ABS_X, x); 148 input_report_abs(dev, ABS_Y, y); 149 input_report_abs(dev, ABS_PRESSURE, 0); 150 input_report_key(dev, BTN_TOOL_FINGER, 0); 151 input_sync(dev); 152 } 153 priv->prev_fin = fin; 154 155 if (z > 30) input_report_key(dev, BTN_TOUCH, 1); 156 if (z < 25) input_report_key(dev, BTN_TOUCH, 0); 157 158 if (z > 0) { 159 input_report_abs(dev, ABS_X, x); 160 input_report_abs(dev, ABS_Y, y); 161 } 162 163 input_report_abs(dev, ABS_PRESSURE, z); 164 input_report_key(dev, BTN_TOOL_FINGER, z > 0); 165 166 if (priv->i->flags & ALPS_WHEEL) 167 input_report_rel(dev, REL_WHEEL, ((packet[2] << 1) & 0x08) - ((packet[0] >> 4) & 0x07)); 168 169 if (priv->i->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) { 170 input_report_key(dev, BTN_FORWARD, forward); 171 input_report_key(dev, BTN_BACK, back); 172 } 173 174 input_sync(dev); 175} 176 177static psmouse_ret_t alps_process_byte(struct psmouse *psmouse) 178{ 179 struct alps_data *priv = psmouse->private; 180 181 if ((psmouse->packet[0] & 0xc8) == 0x08) { /* PS/2 packet */ 182 if (psmouse->pktcnt == 3) { 183 alps_process_packet(psmouse); 184 return PSMOUSE_FULL_PACKET; 185 } 186 return PSMOUSE_GOOD_DATA; 187 } 188 189 if ((psmouse->packet[0] & priv->i->mask0) != priv->i->byte0) 190 return PSMOUSE_BAD_DATA; 191 192 /* Bytes 2 - 6 should have 0 in the highest bit */ 193 if (psmouse->pktcnt >= 2 && psmouse->pktcnt <= 6 && 194 (psmouse->packet[psmouse->pktcnt - 1] & 0x80)) 195 return PSMOUSE_BAD_DATA; 196 197 if (psmouse->pktcnt == 6) { 198 alps_process_packet(psmouse); 199 return PSMOUSE_FULL_PACKET; 200 } 201 202 return PSMOUSE_GOOD_DATA; 203} 204 205static const struct alps_model_info *alps_get_model(struct psmouse *psmouse, int *version) 206{ 207 struct ps2dev *ps2dev = &psmouse->ps2dev; 208 static const unsigned char rates[] = { 0, 10, 20, 40, 60, 80, 100, 200 }; 209 unsigned char param[4]; 210 int i; 211 212 /* 213 * First try "E6 report". 214 * ALPS should return 0,0,10 or 0,0,100 215 */ 216 param[0] = 0; 217 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) || 218 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) || 219 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11) || 220 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11)) 221 return NULL; 222 223 param[0] = param[1] = param[2] = 0xff; 224 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) 225 return NULL; 226 227 dbg("E6 report: %2.2x %2.2x %2.2x", param[0], param[1], param[2]); 228 229 if (param[0] != 0 || param[1] != 0 || (param[2] != 10 && param[2] != 100)) 230 return NULL; 231 232 /* 233 * Now try "E7 report". Allowed responses are in 234 * alps_model_data[].signature 235 */ 236 param[0] = 0; 237 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) || 238 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21) || 239 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21) || 240 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE21)) 241 return NULL; 242 243 param[0] = param[1] = param[2] = 0xff; 244 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) 245 return NULL; 246 247 dbg("E7 report: %2.2x %2.2x %2.2x", param[0], param[1], param[2]); 248 249 if (version) { 250 for (i = 0; i < ARRAY_SIZE(rates) && param[2] != rates[i]; i++) 251 /* empty */; 252 *version = (param[0] << 8) | (param[1] << 4) | i; 253 } 254 255 for (i = 0; i < ARRAY_SIZE(alps_model_data); i++) 256 if (!memcmp(param, alps_model_data[i].signature, 257 sizeof(alps_model_data[i].signature))) 258 return alps_model_data + i; 259 260 return NULL; 261} 262 263/* 264 * For DualPoint devices select the device that should respond to 265 * subsequent commands. It looks like glidepad is behind stickpointer, 266 * I'd thought it would be other way around... 267 */ 268static int alps_passthrough_mode(struct psmouse *psmouse, int enable) 269{ 270 struct ps2dev *ps2dev = &psmouse->ps2dev; 271 int cmd = enable ? PSMOUSE_CMD_SETSCALE21 : PSMOUSE_CMD_SETSCALE11; 272 273 if (ps2_command(ps2dev, NULL, cmd) || 274 ps2_command(ps2dev, NULL, cmd) || 275 ps2_command(ps2dev, NULL, cmd) || 276 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE)) 277 return -1; 278 279 /* we may get 3 more bytes, just ignore them */ 280 ps2_drain(ps2dev, 3, 100); 281 282 return 0; 283} 284 285static int alps_absolute_mode(struct psmouse *psmouse) 286{ 287 struct ps2dev *ps2dev = &psmouse->ps2dev; 288 289 /* Try ALPS magic knock - 4 disable before enable */ 290 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) || 291 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) || 292 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) || 293 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) || 294 ps2_command(ps2dev, NULL, PSMOUSE_CMD_ENABLE)) 295 return -1; 296 297 /* 298 * Switch mouse to poll (remote) mode so motion data will not 299 * get in our way 300 */ 301 return ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETPOLL); 302} 303 304static int alps_get_status(struct psmouse *psmouse, char *param) 305{ 306 struct ps2dev *ps2dev = &psmouse->ps2dev; 307 308 /* Get status: 0xF5 0xF5 0xF5 0xE9 */ 309 if (ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) || 310 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) || 311 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) || 312 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO)) 313 return -1; 314 315 dbg("Status: %2.2x %2.2x %2.2x", param[0], param[1], param[2]); 316 317 return 0; 318} 319 320/* 321 * Turn touchpad tapping on or off. The sequences are: 322 * 0xE9 0xF5 0xF5 0xF3 0x0A to enable, 323 * 0xE9 0xF5 0xF5 0xE8 0x00 to disable. 324 * My guess that 0xE9 (GetInfo) is here as a sync point. 325 * For models that also have stickpointer (DualPoints) its tapping 326 * is controlled separately (0xE6 0xE6 0xE6 0xF3 0x14|0x0A) but 327 * we don't fiddle with it. 328 */ 329static int alps_tap_mode(struct psmouse *psmouse, int enable) 330{ 331 struct ps2dev *ps2dev = &psmouse->ps2dev; 332 int cmd = enable ? PSMOUSE_CMD_SETRATE : PSMOUSE_CMD_SETRES; 333 unsigned char tap_arg = enable ? 0x0A : 0x00; 334 unsigned char param[4]; 335 336 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO) || 337 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) || 338 ps2_command(ps2dev, NULL, PSMOUSE_CMD_DISABLE) || 339 ps2_command(ps2dev, &tap_arg, cmd)) 340 return -1; 341 342 if (alps_get_status(psmouse, param)) 343 return -1; 344 345 return 0; 346} 347 348/* 349 * alps_poll() - poll the touchpad for current motion packet. 350 * Used in resync. 351 */ 352static int alps_poll(struct psmouse *psmouse) 353{ 354 struct alps_data *priv = psmouse->private; 355 unsigned char buf[6]; 356 int poll_failed; 357 358 if (priv->i->flags & ALPS_PASS) 359 alps_passthrough_mode(psmouse, 1); 360 361 poll_failed = ps2_command(&psmouse->ps2dev, buf, 362 PSMOUSE_CMD_POLL | (psmouse->pktsize << 8)) < 0; 363 364 if (priv->i->flags & ALPS_PASS) 365 alps_passthrough_mode(psmouse, 0); 366 367 if (poll_failed || (buf[0] & priv->i->mask0) != priv->i->byte0) 368 return -1; 369 370 if ((psmouse->badbyte & 0xc8) == 0x08) { 371/* 372 * Poll the track stick ... 373 */ 374 if (ps2_command(&psmouse->ps2dev, buf, PSMOUSE_CMD_POLL | (3 << 8))) 375 return -1; 376 } 377 378 memcpy(psmouse->packet, buf, sizeof(buf)); 379 return 0; 380} 381 382static int alps_hw_init(struct psmouse *psmouse, int *version) 383{ 384 struct alps_data *priv = psmouse->private; 385 386 priv->i = alps_get_model(psmouse, version); 387 if (!priv->i) 388 return -1; 389 390 if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 1)) 391 return -1; 392 393 if (alps_tap_mode(psmouse, 1)) { 394 printk(KERN_WARNING "alps.c: Failed to enable hardware tapping\n"); 395 return -1; 396 } 397 398 if (alps_absolute_mode(psmouse)) { 399 printk(KERN_ERR "alps.c: Failed to enable absolute mode\n"); 400 return -1; 401 } 402 403 if ((priv->i->flags & ALPS_PASS) && alps_passthrough_mode(psmouse, 0)) 404 return -1; 405 406 /* ALPS needs stream mode, otherwise it won't report any data */ 407 if (ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_SETSTREAM)) { 408 printk(KERN_ERR "alps.c: Failed to enable stream mode\n"); 409 return -1; 410 } 411 412 return 0; 413} 414 415static int alps_reconnect(struct psmouse *psmouse) 416{ 417 psmouse_reset(psmouse); 418 419 if (alps_hw_init(psmouse, NULL)) 420 return -1; 421 422 return 0; 423} 424 425static void alps_disconnect(struct psmouse *psmouse) 426{ 427 struct alps_data *priv = psmouse->private; 428 429 psmouse_reset(psmouse); 430 input_unregister_device(priv->dev2); 431 kfree(priv); 432} 433 434int alps_init(struct psmouse *psmouse) 435{ 436 struct alps_data *priv; 437 struct input_dev *dev1 = psmouse->dev, *dev2; 438 int version; 439 440 priv = kzalloc(sizeof(struct alps_data), GFP_KERNEL); 441 dev2 = input_allocate_device(); 442 if (!priv || !dev2) 443 goto init_fail; 444 445 priv->dev2 = dev2; 446 psmouse->private = priv; 447 448 if (alps_hw_init(psmouse, &version)) 449 goto init_fail; 450 451 dev1->evbit[LONG(EV_KEY)] |= BIT(EV_KEY); 452 dev1->keybit[LONG(BTN_TOUCH)] |= BIT(BTN_TOUCH); 453 dev1->keybit[LONG(BTN_TOOL_FINGER)] |= BIT(BTN_TOOL_FINGER); 454 dev1->keybit[LONG(BTN_LEFT)] |= BIT(BTN_LEFT) | BIT(BTN_MIDDLE) | BIT(BTN_RIGHT); 455 456 dev1->evbit[LONG(EV_ABS)] |= BIT(EV_ABS); 457 input_set_abs_params(dev1, ABS_X, 0, 1023, 0, 0); 458 input_set_abs_params(dev1, ABS_Y, 0, 767, 0, 0); 459 input_set_abs_params(dev1, ABS_PRESSURE, 0, 127, 0, 0); 460 461 if (priv->i->flags & ALPS_WHEEL) { 462 dev1->evbit[LONG(EV_REL)] |= BIT(EV_REL); 463 dev1->relbit[LONG(REL_WHEEL)] |= BIT(REL_WHEEL); 464 } 465 466 if (priv->i->flags & (ALPS_FW_BK_1 | ALPS_FW_BK_2)) { 467 dev1->keybit[LONG(BTN_FORWARD)] |= BIT(BTN_FORWARD); 468 dev1->keybit[LONG(BTN_BACK)] |= BIT(BTN_BACK); 469 } 470 471 snprintf(priv->phys, sizeof(priv->phys), "%s/input1", psmouse->ps2dev.serio->phys); 472 dev2->phys = priv->phys; 473 dev2->name = (priv->i->flags & ALPS_DUALPOINT) ? "DualPoint Stick" : "PS/2 Mouse"; 474 dev2->id.bustype = BUS_I8042; 475 dev2->id.vendor = 0x0002; 476 dev2->id.product = PSMOUSE_ALPS; 477 dev2->id.version = 0x0000; 478 479 dev2->evbit[0] = BIT(EV_KEY) | BIT(EV_REL); 480 dev2->relbit[LONG(REL_X)] |= BIT(REL_X) | BIT(REL_Y); 481 dev2->keybit[LONG(BTN_LEFT)] |= BIT(BTN_LEFT) | BIT(BTN_MIDDLE) | BIT(BTN_RIGHT); 482 483 if (input_register_device(priv->dev2)) 484 goto init_fail; 485 486 psmouse->protocol_handler = alps_process_byte; 487 psmouse->poll = alps_poll; 488 psmouse->disconnect = alps_disconnect; 489 psmouse->reconnect = alps_reconnect; 490 psmouse->pktsize = 6; 491 492 /* We are having trouble resyncing ALPS touchpads so disable it for now */ 493 psmouse->resync_time = 0; 494 495 return 0; 496 497init_fail: 498 psmouse_reset(psmouse); 499 input_free_device(dev2); 500 kfree(priv); 501 psmouse->private = NULL; 502 return -1; 503} 504 505int alps_detect(struct psmouse *psmouse, int set_properties) 506{ 507 int version; 508 const struct alps_model_info *model; 509 510 model = alps_get_model(psmouse, &version); 511 if (!model) 512 return -1; 513 514 if (set_properties) { 515 psmouse->vendor = "ALPS"; 516 psmouse->name = model->flags & ALPS_DUALPOINT ? 517 "DualPoint TouchPad" : "GlidePoint"; 518 psmouse->model = version; 519 } 520 return 0; 521} 522