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
44 /*****************************************************************************
45 * Stuff we need even when we do not want native Synaptics support
46 ****************************************************************************/
49 * Set the synaptics touchpad mode byte by special commands
51 static int synaptics_mode_cmd(struct psmouse *psmouse, unsigned char mode)
53 unsigned char param[1];
55 if (psmouse_sliced_command(psmouse, mode))
57 param[0] = SYN_PS_SET_MODE2;
58 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_SETRATE))
63 int synaptics_detect(struct psmouse *psmouse, int set_properties)
65 struct ps2dev *ps2dev = &psmouse->ps2dev;
66 unsigned char param[4];
70 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
71 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
72 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
73 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
74 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
80 psmouse->vendor = "Synaptics";
81 psmouse->name = "TouchPad";
87 void synaptics_reset(struct psmouse *psmouse)
89 /* reset touchpad back to relative mode, gestures enabled */
90 synaptics_mode_cmd(psmouse, 0);
93 #ifdef CONFIG_MOUSE_PS2_SYNAPTICS
95 /*****************************************************************************
96 * Synaptics communications functions
97 ****************************************************************************/
100 * Send a command to the synpatics touchpad by special commands
102 static int synaptics_send_cmd(struct psmouse *psmouse, unsigned char c, unsigned char *param)
104 if (psmouse_sliced_command(psmouse, c))
106 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_GETINFO))
112 * Read the model-id bytes from the touchpad
113 * see also SYN_MODEL_* macros
115 static int synaptics_model_id(struct psmouse *psmouse)
117 struct synaptics_data *priv = psmouse->private;
120 if (synaptics_send_cmd(psmouse, SYN_QUE_MODEL, mi))
122 priv->model_id = (mi[0]<<16) | (mi[1]<<8) | mi[2];
127 * Read the capability-bits from the touchpad
128 * see also the SYN_CAP_* macros
130 static int synaptics_capability(struct psmouse *psmouse)
132 struct synaptics_data *priv = psmouse->private;
133 unsigned char cap[3];
135 if (synaptics_send_cmd(psmouse, SYN_QUE_CAPABILITIES, cap))
137 priv->capabilities = (cap[0] << 16) | (cap[1] << 8) | cap[2];
139 if (!SYN_CAP_VALID(priv->capabilities))
143 * Unless capExtended is set the rest of the flags should be ignored
145 if (!SYN_CAP_EXTENDED(priv->capabilities))
146 priv->capabilities = 0;
148 if (SYN_EXT_CAP_REQUESTS(priv->capabilities) >= 1) {
149 if (synaptics_send_cmd(psmouse, SYN_QUE_EXT_CAPAB, cap)) {
150 printk(KERN_ERR "Synaptics claims to have extended capabilities,"
151 " but I'm not able to read them.");
153 priv->ext_cap = (cap[0] << 16) | (cap[1] << 8) | cap[2];
156 * if nExtBtn is greater than 8 it should be considered
157 * invalid and treated as 0
159 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) > 8)
160 priv->ext_cap &= 0xff0fff;
168 * See also the SYN_ID_* macros
170 static int synaptics_identify(struct psmouse *psmouse)
172 struct synaptics_data *priv = psmouse->private;
175 if (synaptics_send_cmd(psmouse, SYN_QUE_IDENTIFY, id))
177 priv->identity = (id[0]<<16) | (id[1]<<8) | id[2];
178 if (SYN_ID_IS_SYNAPTICS(priv->identity))
183 static int synaptics_query_hardware(struct psmouse *psmouse)
187 while ((retries++ < 3) && psmouse_reset(psmouse))
190 if (synaptics_identify(psmouse))
192 if (synaptics_model_id(psmouse))
194 if (synaptics_capability(psmouse))
200 static int synaptics_set_absolute_mode(struct psmouse *psmouse)
202 struct synaptics_data *priv = psmouse->private;
204 priv->mode = SYN_BIT_ABSOLUTE_MODE;
205 if (SYN_ID_MAJOR(priv->identity) >= 4)
206 priv->mode |= SYN_BIT_DISABLE_GESTURE;
207 if (SYN_CAP_EXTENDED(priv->capabilities))
208 priv->mode |= SYN_BIT_W_MODE;
210 if (synaptics_mode_cmd(psmouse, priv->mode))
216 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
218 struct synaptics_data *priv = psmouse->private;
221 priv->mode |= SYN_BIT_HIGH_RATE;
224 priv->mode &= ~SYN_BIT_HIGH_RATE;
228 synaptics_mode_cmd(psmouse, priv->mode);
231 /*****************************************************************************
232 * Synaptics pass-through PS/2 port support
233 ****************************************************************************/
234 static int synaptics_pt_write(struct serio *serio, unsigned char c)
236 struct psmouse *parent = serio_get_drvdata(serio->parent);
237 char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
239 if (psmouse_sliced_command(parent, c))
241 if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
246 static inline int synaptics_is_pt_packet(unsigned char *buf)
248 return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
251 static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet)
253 struct psmouse *child = serio_get_drvdata(ptport);
255 if (child && child->state == PSMOUSE_ACTIVATED) {
256 serio_interrupt(ptport, packet[1], 0);
257 serio_interrupt(ptport, packet[4], 0);
258 serio_interrupt(ptport, packet[5], 0);
259 if (child->pktsize == 4)
260 serio_interrupt(ptport, packet[2], 0);
262 serio_interrupt(ptport, packet[1], 0);
265 static void synaptics_pt_activate(struct psmouse *psmouse)
267 struct serio *ptport = psmouse->ps2dev.serio->child;
268 struct psmouse *child = serio_get_drvdata(ptport);
269 struct synaptics_data *priv = psmouse->private;
271 /* adjust the touchpad to child's choice of protocol */
273 if (child->pktsize == 4)
274 priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
276 priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
278 if (synaptics_mode_cmd(psmouse, priv->mode))
279 printk(KERN_INFO "synaptics: failed to switch guest protocol\n");
283 static void synaptics_pt_create(struct psmouse *psmouse)
287 serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
289 printk(KERN_ERR "synaptics: not enough memory to allocate pass-through port\n");
293 serio->id.type = SERIO_PS_PSTHRU;
294 strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
295 strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
296 serio->write = synaptics_pt_write;
297 serio->parent = psmouse->ps2dev.serio;
299 psmouse->pt_activate = synaptics_pt_activate;
301 printk(KERN_INFO "serio: %s port at %s\n", serio->name, psmouse->phys);
302 serio_register_port(serio);
305 /*****************************************************************************
306 * Functions to interpret the absolute mode packets
307 ****************************************************************************/
309 static void synaptics_parse_hw_state(unsigned char buf[], struct synaptics_data *priv, struct synaptics_hw_state *hw)
311 memset(hw, 0, sizeof(struct synaptics_hw_state));
313 if (SYN_MODEL_NEWABS(priv->model_id)) {
314 hw->x = (((buf[3] & 0x10) << 8) |
315 ((buf[1] & 0x0f) << 8) |
317 hw->y = (((buf[3] & 0x20) << 7) |
318 ((buf[1] & 0xf0) << 4) |
322 hw->w = (((buf[0] & 0x30) >> 2) |
323 ((buf[0] & 0x04) >> 1) |
324 ((buf[3] & 0x04) >> 2));
326 hw->left = (buf[0] & 0x01) ? 1 : 0;
327 hw->right = (buf[0] & 0x02) ? 1 : 0;
329 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
330 hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
332 hw->scroll = (signed char)(buf[1]);
335 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
336 hw->up = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
337 hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
340 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) &&
341 ((buf[0] ^ buf[3]) & 0x02)) {
342 switch (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) & ~0x01) {
345 * if nExtBtn is greater than 8 it should be
346 * considered invalid and treated as 0
350 hw->ext_buttons |= ((buf[5] & 0x08)) ? 0x80 : 0;
351 hw->ext_buttons |= ((buf[4] & 0x08)) ? 0x40 : 0;
353 hw->ext_buttons |= ((buf[5] & 0x04)) ? 0x20 : 0;
354 hw->ext_buttons |= ((buf[4] & 0x04)) ? 0x10 : 0;
356 hw->ext_buttons |= ((buf[5] & 0x02)) ? 0x08 : 0;
357 hw->ext_buttons |= ((buf[4] & 0x02)) ? 0x04 : 0;
359 hw->ext_buttons |= ((buf[5] & 0x01)) ? 0x02 : 0;
360 hw->ext_buttons |= ((buf[4] & 0x01)) ? 0x01 : 0;
364 hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
365 hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
367 hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
368 hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
370 hw->left = (buf[0] & 0x01) ? 1 : 0;
371 hw->right = (buf[0] & 0x02) ? 1 : 0;
376 * called for each full received packet from the touchpad
378 static void synaptics_process_packet(struct psmouse *psmouse)
380 struct input_dev *dev = psmouse->dev;
381 struct synaptics_data *priv = psmouse->private;
382 struct synaptics_hw_state hw;
387 synaptics_parse_hw_state(psmouse->packet, priv, &hw);
390 priv->scroll += hw.scroll;
392 while (priv->scroll >= 4) {
393 input_report_key(dev, BTN_BACK, !hw.down);
395 input_report_key(dev, BTN_BACK, hw.down);
399 while (priv->scroll <= -4) {
400 input_report_key(dev, BTN_FORWARD, !hw.up);
402 input_report_key(dev, BTN_FORWARD, hw.up);
412 if (SYN_CAP_EXTENDED(priv->capabilities)) {
415 if (SYN_CAP_MULTIFINGER(priv->capabilities))
416 num_fingers = hw.w + 2;
419 if (SYN_MODEL_PEN(priv->model_id))
420 ; /* Nothing, treat a pen as a single finger */
423 if (SYN_CAP_PALMDETECT(priv->capabilities))
434 * BTN_TOUCH has to be first as mousedev relies on it when doing
435 * absolute -> relative conversion
437 if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
438 if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
441 input_report_abs(dev, ABS_X, hw.x);
442 input_report_abs(dev, ABS_Y, YMAX_NOMINAL + YMIN_NOMINAL - hw.y);
444 input_report_abs(dev, ABS_PRESSURE, hw.z);
446 input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
447 input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
448 input_report_key(dev, BTN_LEFT, hw.left);
449 input_report_key(dev, BTN_RIGHT, hw.right);
451 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
452 input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
453 input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
456 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
457 input_report_key(dev, BTN_MIDDLE, hw.middle);
459 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
460 input_report_key(dev, BTN_FORWARD, hw.up);
461 input_report_key(dev, BTN_BACK, hw.down);
464 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
465 input_report_key(dev, BTN_0 + i, hw.ext_buttons & (1 << i));
470 static int synaptics_validate_byte(unsigned char packet[], int idx, unsigned char pkt_type)
472 static const unsigned char newabs_mask[] = { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
473 static const unsigned char newabs_rel_mask[] = { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
474 static const unsigned char newabs_rslt[] = { 0x80, 0x00, 0x00, 0xC0, 0x00 };
475 static const unsigned char oldabs_mask[] = { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
476 static const unsigned char oldabs_rslt[] = { 0xC0, 0x00, 0x00, 0x80, 0x00 };
478 if (idx < 0 || idx > 4)
483 case SYN_NEWABS_RELAXED:
484 return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
486 case SYN_NEWABS_STRICT:
487 return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
490 return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
493 printk(KERN_ERR "synaptics: unknown packet type %d\n", pkt_type);
498 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
502 for (i = 0; i < 5; i++)
503 if (!synaptics_validate_byte(psmouse->packet, i, SYN_NEWABS_STRICT)) {
504 printk(KERN_INFO "synaptics: using relaxed packet validation\n");
505 return SYN_NEWABS_RELAXED;
508 return SYN_NEWABS_STRICT;
511 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse)
513 struct synaptics_data *priv = psmouse->private;
515 if (psmouse->pktcnt >= 6) { /* Full packet received */
516 if (unlikely(priv->pkt_type == SYN_NEWABS))
517 priv->pkt_type = synaptics_detect_pkt_type(psmouse);
519 if (SYN_CAP_PASS_THROUGH(priv->capabilities) && synaptics_is_pt_packet(psmouse->packet)) {
520 if (psmouse->ps2dev.serio->child)
521 synaptics_pass_pt_packet(psmouse->ps2dev.serio->child, psmouse->packet);
523 synaptics_process_packet(psmouse);
525 return PSMOUSE_FULL_PACKET;
528 return synaptics_validate_byte(psmouse->packet, psmouse->pktcnt - 1, priv->pkt_type) ?
529 PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
532 /*****************************************************************************
533 * Driver initialization/cleanup functions
534 ****************************************************************************/
535 static void set_input_params(struct input_dev *dev, struct synaptics_data *priv)
539 set_bit(EV_ABS, dev->evbit);
540 input_set_abs_params(dev, ABS_X, XMIN_NOMINAL, XMAX_NOMINAL, 0, 0);
541 input_set_abs_params(dev, ABS_Y, YMIN_NOMINAL, YMAX_NOMINAL, 0, 0);
542 input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
543 set_bit(ABS_TOOL_WIDTH, dev->absbit);
545 set_bit(EV_KEY, dev->evbit);
546 set_bit(BTN_TOUCH, dev->keybit);
547 set_bit(BTN_TOOL_FINGER, dev->keybit);
548 set_bit(BTN_LEFT, dev->keybit);
549 set_bit(BTN_RIGHT, dev->keybit);
551 if (SYN_CAP_MULTIFINGER(priv->capabilities)) {
552 set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
553 set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
556 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
557 set_bit(BTN_MIDDLE, dev->keybit);
559 if (SYN_CAP_FOUR_BUTTON(priv->capabilities) ||
560 SYN_CAP_MIDDLE_BUTTON(priv->capabilities)) {
561 set_bit(BTN_FORWARD, dev->keybit);
562 set_bit(BTN_BACK, dev->keybit);
565 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
566 set_bit(BTN_0 + i, dev->keybit);
568 clear_bit(EV_REL, dev->evbit);
569 clear_bit(REL_X, dev->relbit);
570 clear_bit(REL_Y, dev->relbit);
573 static void synaptics_disconnect(struct psmouse *psmouse)
575 synaptics_reset(psmouse);
576 kfree(psmouse->private);
577 psmouse->private = NULL;
580 static int synaptics_reconnect(struct psmouse *psmouse)
582 struct synaptics_data *priv = psmouse->private;
583 struct synaptics_data old_priv = *priv;
585 if (synaptics_detect(psmouse, 0))
588 if (synaptics_query_hardware(psmouse)) {
589 printk(KERN_ERR "Unable to query Synaptics hardware.\n");
593 if (old_priv.identity != priv->identity ||
594 old_priv.model_id != priv->model_id ||
595 old_priv.capabilities != priv->capabilities ||
596 old_priv.ext_cap != priv->ext_cap)
599 if (synaptics_set_absolute_mode(psmouse)) {
600 printk(KERN_ERR "Unable to initialize Synaptics hardware.\n");
607 #if defined(__i386__)
608 #include <linux/dmi.h>
609 static const struct dmi_system_id toshiba_dmi_table[] = {
611 .ident = "Toshiba Satellite",
613 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
614 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
618 .ident = "Toshiba Dynabook",
620 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
621 DMI_MATCH(DMI_PRODUCT_NAME, "dynabook"),
625 .ident = "Toshiba Portege M300",
627 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
628 DMI_MATCH(DMI_PRODUCT_NAME, "PORTEGE M300"),
635 int synaptics_init(struct psmouse *psmouse)
637 struct synaptics_data *priv;
639 psmouse->private = priv = kzalloc(sizeof(struct synaptics_data), GFP_KERNEL);
643 if (synaptics_query_hardware(psmouse)) {
644 printk(KERN_ERR "Unable to query Synaptics hardware.\n");
648 if (synaptics_set_absolute_mode(psmouse)) {
649 printk(KERN_ERR "Unable to initialize Synaptics hardware.\n");
653 priv->pkt_type = SYN_MODEL_NEWABS(priv->model_id) ? SYN_NEWABS : SYN_OLDABS;
655 printk(KERN_INFO "Synaptics Touchpad, model: %ld, fw: %ld.%ld, id: %#lx, caps: %#lx/%#lx\n",
656 SYN_ID_MODEL(priv->identity),
657 SYN_ID_MAJOR(priv->identity), SYN_ID_MINOR(priv->identity),
658 priv->model_id, priv->capabilities, priv->ext_cap);
660 set_input_params(psmouse->dev, priv);
663 * Encode touchpad model so that it can be used to set
664 * input device->id.version and be visible to userspace.
665 * Because version is __u16 we have to drop something.
666 * Hardware info bits seem to be good candidates as they
667 * are documented to be for Synaptics corp. internal use.
669 psmouse->model = ((priv->model_id & 0x00ff0000) >> 8) |
670 (priv->model_id & 0x000000ff);
672 psmouse->protocol_handler = synaptics_process_byte;
673 psmouse->set_rate = synaptics_set_rate;
674 psmouse->disconnect = synaptics_disconnect;
675 psmouse->reconnect = synaptics_reconnect;
676 psmouse->cleanup = synaptics_reset;
677 psmouse->pktsize = 6;
678 /* Synaptics can usually stay in sync without extra help */
679 psmouse->resync_time = 0;
681 if (SYN_CAP_PASS_THROUGH(priv->capabilities))
682 synaptics_pt_create(psmouse);
684 #if defined(__i386__)
686 * Toshiba's KBC seems to have trouble handling data from
687 * Synaptics as full rate, switch to lower rate which is roughly
688 * thye same as rate of standard PS/2 mouse.
690 if (psmouse->rate >= 80 && dmi_check_system(toshiba_dmi_table)) {
691 printk(KERN_INFO "synaptics: Toshiba %s detected, limiting rate to 40pps.\n",
692 dmi_get_system_info(DMI_PRODUCT_NAME));
704 #else /* CONFIG_MOUSE_PS2_SYNAPTICS */
706 int synaptics_init(struct psmouse *psmouse)
711 #endif /* CONFIG_MOUSE_PS2_SYNAPTICS */