2 * Synaptics TouchPad PS/2 mouse driver
4 * 2003 Dmitry Torokhov <dtor@mail.ru>
5 * Added support for pass-through port. Special thanks to Peter Berg Larsen
6 * for explaining various Synaptics quirks.
8 * 2003 Peter Osterlund <petero2@telia.com>
9 * Ported to 2.5 input device infrastructure.
11 * Copyright (C) 2001 Stefan Gmeiner <riddlebox@freesurf.ch>
12 * start merging tpconfig and gpm code to a xfree-input module
13 * adding some changes and extensions (ex. 3rd and 4th button)
15 * Copyright (c) 1997 C. Scott Ananian <cananian@alumni.priceton.edu>
16 * Copyright (c) 1998-2000 Bruce Kalk <kall@compass.com>
17 * code for the special synaptics commands (from the tpconfig-source)
19 * This program is free software; you can redistribute it and/or modify it
20 * under the terms of the GNU General Public License version 2 as published by
21 * the Free Software Foundation.
23 * Trademarks are the property of their respective owners.
26 #include <linux/module.h>
27 #include <linux/input.h>
28 #include <linux/serio.h>
29 #include <linux/libps2.h>
31 #include "synaptics.h"
34 * The x/y limits are taken from the Synaptics TouchPad interfacing Guide,
35 * section 2.3.2, which says that they should be valid regardless of the
36 * actual size of the sensor.
38 #define XMIN_NOMINAL 1472
39 #define XMAX_NOMINAL 5472
40 #define YMIN_NOMINAL 1408
41 #define YMAX_NOMINAL 4448
43 /*****************************************************************************
44 * Synaptics communications functions
45 ****************************************************************************/
48 * Send a command to the synpatics touchpad by special commands
50 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c, unsigned char *param)
52 if (psmouse_sliced_command(psmouse, c))
54 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO))
60 * Set the synaptics touchpad mode byte by special commands
62 static int synaptics_mode_cmd(struct psmouse *psmouse, unsigned char mode)
64 unsigned char param[1];
66 if (psmouse_sliced_command(psmouse, mode))
68 param[0] = SYN_PS_SET_MODE2;
69 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_SETRATE))
75 * Read the model-id bytes from the touchpad
76 * see also SYN_MODEL_* macros
78 static int synaptics_model_id(struct psmouse *psmouse)
80 struct synaptics_data *priv = psmouse->private;
83 if (synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi))
85 priv->model_id = (mi[0]<<16) | (mi[1]<<8) | mi[2];
90 * Read the capability-bits from the touchpad
91 * see also the SYN_CAP_* macros
93 static int synaptics_capability(struct psmouse *psmouse)
95 struct synaptics_data *priv = psmouse->private;
98 if (synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap))
100 priv->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2];
102 if (!SYN_CAP_VALID(priv->capabilities))
106 * Unless capExtended is set the rest of the flags should be ignored
108 if (!SYN_CAP_EXTENDED(priv->capabilities))
109 priv->capabilities = 0;
111 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 1) {
112 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) {
113 printk(KERN_ERR "Synaptics claims to have extended capabilities,"
114 " but I'm not able to read them.");
116 priv->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2];
119 * if nExtBtn is greater than 8 it should be considered
120 * invalid and treated as 0
122 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) > 8)
123 priv->ext_cap &= 0xff0fff;
131 * See also the SYN_ID_* macros
133 static int synaptics_identify(struct psmouse *psmouse)
135 struct synaptics_data *priv = psmouse->private;
138 if (synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id))
140 priv->identity = (id[0]<<16) | (id[1]<<8) | id[2];
141 if (SYN_ID_IS_SYNAPTICS(priv->identity))
146 static int synaptics_query_hardware(struct psmouse *psmouse)
150 while ((retries++ < 3) && psmouse_reset(psmouse))
151 printk(KERN_ERR "synaptics reset failed\n");
153 if (synaptics_identify(psmouse))
155 if (synaptics_model_id(psmouse))
157 if (synaptics_capability(psmouse))
163 static int synaptics_set_absolute_mode(struct psmouse *psmouse)
165 struct synaptics_data *priv = psmouse->private;
167 priv->mode = SYN_BIT_ABSOLUTE_MODE;
168 if (SYN_ID_MAJOR(priv->identity) >= 4)
169 priv->mode |= SYN_BIT_DISABLE_GESTURE;
170 if (SYN_CAP_EXTENDED(priv->capabilities))
171 priv->mode |= SYN_BIT_W_MODE;
173 if (synaptics_mode_cmd(psmouse, priv->mode))
179 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
181 struct synaptics_data *priv = psmouse->private;
184 priv->mode |= SYN_BIT_HIGH_RATE;
187 priv->mode &= ~SYN_BIT_HIGH_RATE;
191 synaptics_mode_cmd(psmouse, priv->mode);
194 /*****************************************************************************
195 * Synaptics pass-through PS/2 port support
196 ****************************************************************************/
197 static int synaptics_pt_write(struct serio *serio, unsigned char c)
199 struct psmouse *parent = serio_get_drvdata(serio->parent);
200 char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
202 if (psmouse_sliced_command(parent, c))
204 if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
209 static inline int synaptics_is_pt_packet(unsigned char *buf)
211 return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
214 static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet)
216 struct psmouse *child = serio_get_drvdata(ptport);
218 if (child && child->state == PSMOUSE_ACTIVATED) {
219 serio_interrupt(ptport, packet[1], 0);
220 serio_interrupt(ptport, packet[4], 0);
221 serio_interrupt(ptport, packet[5], 0);
222 if (child->pktsize == 4)
223 serio_interrupt(ptport, packet[2], 0);
225 serio_interrupt(ptport, packet[1], 0);
228 static void synaptics_pt_activate(struct psmouse *psmouse)
230 struct serio *ptport = psmouse->ps2dev.serio->child;
231 struct psmouse *child = serio_get_drvdata(ptport);
232 struct synaptics_data *priv = psmouse->private;
234 /* adjust the touchpad to child's choice of protocol */
236 if (child->pktsize == 4)
237 priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
239 priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
241 if (synaptics_mode_cmd(psmouse, priv->mode))
242 printk(KERN_INFO "synaptics: failed to switch guest protocol\n");
246 static void synaptics_pt_create(struct psmouse *psmouse)
250 serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
252 printk(KERN_ERR "synaptics: not enough memory to allocate pass-through port\n");
256 serio->id.type = SERIO_PS_PSTHRU;
257 strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
258 strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
259 serio->write = synaptics_pt_write;
260 serio->parent = psmouse->ps2dev.serio;
262 psmouse->pt_activate = synaptics_pt_activate;
264 printk(KERN_INFO "serio: %s port at %s\n", serio->name, psmouse->phys);
265 serio_register_port(serio);
268 /*****************************************************************************
269 * Functions to interpret the absolute mode packets
270 ****************************************************************************/
272 static void synaptics_parse_hw_state(unsigned char buf[], struct synaptics_data *priv, struct synaptics_hw_state *hw)
274 memset(hw, 0, sizeof(struct synaptics_hw_state));
276 if (SYN_MODEL_NEWABS(priv->model_id)) {
277 hw->x = (((buf[3] & 0x10) << 8) |
278 ((buf[1] & 0x0f) << 8) |
280 hw->y = (((buf[3] & 0x20) << 7) |
281 ((buf[1] & 0xf0) << 4) |
285 hw->w = (((buf[0] & 0x30) >> 2) |
286 ((buf[0] & 0x04) >> 1) |
287 ((buf[3] & 0x04) >> 2));
289 hw->left = (buf[0] & 0x01) ? 1 : 0;
290 hw->right = (buf[0] & 0x02) ? 1 : 0;
292 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
293 hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
295 hw->scroll = (signed char)(buf[1]);
298 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
299 hw->up = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
300 hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
303 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) &&
304 ((buf[0] ^ buf[3]) & 0x02)) {
305 switch (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) & ~0x01) {
308 * if nExtBtn is greater than 8 it should be
309 * considered invalid and treated as 0
313 hw->ext_buttons |= ((buf[5] & 0x08)) ? 0x80 : 0;
314 hw->ext_buttons |= ((buf[4] & 0x08)) ? 0x40 : 0;
316 hw->ext_buttons |= ((buf[5] & 0x04)) ? 0x20 : 0;
317 hw->ext_buttons |= ((buf[4] & 0x04)) ? 0x10 : 0;
319 hw->ext_buttons |= ((buf[5] & 0x02)) ? 0x08 : 0;
320 hw->ext_buttons |= ((buf[4] & 0x02)) ? 0x04 : 0;
322 hw->ext_buttons |= ((buf[5] & 0x01)) ? 0x02 : 0;
323 hw->ext_buttons |= ((buf[4] & 0x01)) ? 0x01 : 0;
327 hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
328 hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
330 hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
331 hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
333 hw->left = (buf[0] & 0x01) ? 1 : 0;
334 hw->right = (buf[0] & 0x02) ? 1 : 0;
339 * called for each full received packet from the touchpad
341 static void synaptics_process_packet(struct psmouse *psmouse)
343 struct input_dev *dev = psmouse->dev;
344 struct synaptics_data *priv = psmouse->private;
345 struct synaptics_hw_state hw;
350 synaptics_parse_hw_state(psmouse->packet, priv, &hw);
353 priv->scroll += hw.scroll;
355 while (priv->scroll >= 4) {
356 input_report_key(dev, BTN_BACK, !hw.down);
358 input_report_key(dev, BTN_BACK, hw.down);
362 while (priv->scroll <= -4) {
363 input_report_key(dev, BTN_FORWARD, !hw.up);
365 input_report_key(dev, BTN_FORWARD, hw.up);
375 if (SYN_CAP_EXTENDED(priv->capabilities)) {
378 if (SYN_CAP_MULTIFINGER(priv->capabilities))
379 num_fingers = hw.w + 2;
382 if (SYN_MODEL_PEN(priv->model_id))
383 ; /* Nothing, treat a pen as a single finger */
386 if (SYN_CAP_PALMDETECT(priv->capabilities))
397 * BTN_TOUCH has to be first as mousedev relies on it when doing
398 * absolute -> relative conversion
400 if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
401 if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
404 input_report_abs(dev, ABS_X, hw.x);
405 input_report_abs(dev, ABS_Y, YMAX_NOMINAL + YMIN_NOMINAL - hw.y);
407 input_report_abs(dev, ABS_PRESSURE, hw.z);
409 input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
410 input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
411 input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
412 input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
414 input_report_key(dev, BTN_LEFT, hw.left);
415 input_report_key(dev, BTN_RIGHT, hw.right);
417 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
418 input_report_key(dev, BTN_MIDDLE, hw.middle);
420 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
421 input_report_key(dev, BTN_FORWARD, hw.up);
422 input_report_key(dev, BTN_BACK, hw.down);
425 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
426 input_report_key(dev, BTN_0 + i, hw.ext_buttons & (1 << i));
431 static int synaptics_validate_byte(unsigned char packet[], int idx, unsigned char pkt_type)
433 static const unsigned char newabs_mask[] = { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
434 static const unsigned char newabs_rel_mask[] = { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
435 static const unsigned char newabs_rslt[] = { 0x80, 0x00, 0x00, 0xC0, 0x00 };
436 static const unsigned char oldabs_mask[] = { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
437 static const unsigned char oldabs_rslt[] = { 0xC0, 0x00, 0x00, 0x80, 0x00 };
439 if (idx < 0 || idx > 4)
444 case SYN_NEWABS_RELAXED:
445 return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
447 case SYN_NEWABS_STRICT:
448 return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
451 return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
454 printk(KERN_ERR "synaptics: unknown packet type %d\n", pkt_type);
459 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
463 for (i = 0; i < 5; i++)
464 if (!synaptics_validate_byte(psmouse->packet, i, SYN_NEWABS_STRICT)) {
465 printk(KERN_INFO "synaptics: using relaxed packet validation\n");
466 return SYN_NEWABS_RELAXED;
469 return SYN_NEWABS_STRICT;
472 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
474 struct synaptics_data *priv = psmouse->private;
476 if (psmouse->pktcnt >= 6) { /* Full packet received */
477 if (unlikely(priv->pkt_type == SYN_NEWABS))
478 priv->pkt_type = synaptics_detect_pkt_type(psmouse);
480 if (SYN_CAP_PASS_THROUGH(priv->capabilities) && synaptics_is_pt_packet(psmouse->packet)) {
481 if (psmouse->ps2dev.serio->child)
482 synaptics_pass_pt_packet(psmouse->ps2dev.serio->child, psmouse->packet);
484 synaptics_process_packet(psmouse);
486 return PSMOUSE_FULL_PACKET;
489 return synaptics_validate_byte(psmouse->packet, psmouse->pktcnt - 1, priv->pkt_type) ?
490 PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
493 /*****************************************************************************
494 * Driver initialization/cleanup functions
495 ****************************************************************************/
496 static void set_input_params(struct input_dev *dev, struct synaptics_data *priv)
500 set_bit(EV_ABS, dev->evbit);
501 input_set_abs_params(dev, ABS_X, XMIN_NOMINAL, XMAX_NOMINAL, 0, 0);
502 input_set_abs_params(dev, ABS_Y, YMIN_NOMINAL, YMAX_NOMINAL, 0, 0);
503 input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
504 set_bit(ABS_TOOL_WIDTH, dev->absbit);
506 set_bit(EV_KEY, dev->evbit);
507 set_bit(BTN_TOUCH, dev->keybit);
508 set_bit(BTN_TOOL_FINGER, dev->keybit);
509 set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
510 set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
512 set_bit(BTN_LEFT, dev->keybit);
513 set_bit(BTN_RIGHT, dev->keybit);
515 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
516 set_bit(BTN_MIDDLE, dev->keybit);
518 if (SYN_CAP_FOUR_BUTTON(priv->capabilities) ||
519 SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
520 set_bit(BTN_FORWARD, dev->keybit);
521 set_bit(BTN_BACK, dev->keybit);
524 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
525 set_bit(BTN_0 + i, dev->keybit);
527 clear_bit(EV_REL, dev->evbit);
528 clear_bit(REL_X, dev->relbit);
529 clear_bit(REL_Y, dev->relbit);
532 void synaptics_reset(struct psmouse *psmouse)
534 /* reset touchpad back to relative mode, gestures enabled */
535 synaptics_mode_cmd(psmouse, 0);
538 static void synaptics_disconnect(struct psmouse *psmouse)
540 synaptics_reset(psmouse);
541 kfree(psmouse->private);
542 psmouse->private = NULL;
545 static int synaptics_reconnect(struct psmouse *psmouse)
547 struct synaptics_data *priv = psmouse->private;
548 struct synaptics_data old_priv = *priv;
550 if (synaptics_detect(psmouse, 0))
553 if (synaptics_query_hardware(psmouse)) {
554 printk(KERN_ERR "Unable to query Synaptics hardware.\n");
558 if (old_priv.identity != priv->identity ||
559 old_priv.model_id != priv->model_id ||
560 old_priv.capabilities != priv->capabilities ||
561 old_priv.ext_cap != priv->ext_cap)
564 if (synaptics_set_absolute_mode(psmouse)) {
565 printk(KERN_ERR "Unable to initialize Synaptics hardware.\n");
572 int synaptics_detect(struct psmouse *psmouse, int set_properties)
574 struct ps2dev *ps2dev = &psmouse->ps2dev;
575 unsigned char param[4];
579 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
580 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
581 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
582 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
583 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
585 if (param[1] != 0x47)
588 if (set_properties) {
589 psmouse->vendor = "Synaptics";
590 psmouse->name = "TouchPad";
596 #if defined(__i386__)
597 #include <linux/dmi.h>
598 static struct dmi_system_id toshiba_dmi_table[] = {
600 .ident = "Toshiba Satellite",
602 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
603 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
607 .ident = "Toshiba Dynabook",
609 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
610 DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
614 .ident = "Toshiba Portege M300",
616 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
617 DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
624 int synaptics_init(struct psmouse *psmouse)
626 struct synaptics_data *priv;
628 psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
632 if (synaptics_query_hardware(psmouse)) {
633 printk(KERN_ERR "Unable to query Synaptics hardware.\n");
637 if (synaptics_set_absolute_mode(psmouse)) {
638 printk(KERN_ERR "Unable to initialize Synaptics hardware.\n");
642 priv->pkt_type = SYN_MODEL_NEWABS(priv->model_id) ? SYN_NEWABS : SYN_OLDABS;
644 printk(KERN_INFO "Synaptics Touchpad, model: %ld, fw: %ld.%ld, id: %#lx, caps: %#lx/%#lx\n",
645 SYN_ID_MODEL(priv->identity),
646 SYN_ID_MAJOR(priv->identity), SYN_ID_MINOR(priv->identity),
647 priv->model_id, priv->capabilities, priv->ext_cap);
649 set_input_params(psmouse->dev, priv);
651 psmouse->protocol_handler = synaptics_process_byte;
652 psmouse->set_rate = synaptics_set_rate;
653 psmouse->disconnect = synaptics_disconnect;
654 psmouse->reconnect = synaptics_reconnect;
655 psmouse->cleanup = synaptics_reset;
656 psmouse->pktsize = 6;
657 /* Synaptics can usually stay in sync without extra help */
658 psmouse->resync_time = 0;
660 if (SYN_CAP_PASS_THROUGH(priv->capabilities))
661 synaptics_pt_create(psmouse);
663 #if defined(__i386__)
665 * Toshiba's KBC seems to have trouble handling data from
666 * Synaptics as full rate, switch to lower rate which is roughly
667 * thye same as rate of standard PS/2 mouse.
669 if (psmouse->rate >= 80 && dmi_check_system(toshiba_dmi_table)) {
670 printk(KERN_INFO "synaptics: Toshiba %s detected, limiting rate to 40pps.\n",
671 dmi_get_system_info(DMI_PRODUCT_NAME));