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