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 void print_ident(struct synaptics_data *priv)
148 printk(KERN_INFO "Synaptics Touchpad, model: %ld\n", SYN_ID_MODEL(priv->identity));
149 printk(KERN_INFO " Firmware: %ld.%ld\n", SYN_ID_MAJOR(priv->identity),
150 SYN_ID_MINOR(priv->identity));
151 if (SYN_MODEL_ROT180(priv->model_id))
152 printk(KERN_INFO " 180 degree mounted touchpad\n");
153 if (SYN_MODEL_PORTRAIT(priv->model_id))
154 printk(KERN_INFO " portrait touchpad\n");
155 printk(KERN_INFO " Sensor: %ld\n", SYN_MODEL_SENSOR(priv->model_id));
156 if (SYN_MODEL_NEWABS(priv->model_id))
157 printk(KERN_INFO " new absolute packet format\n");
158 if (SYN_MODEL_PEN(priv->model_id))
159 printk(KERN_INFO " pen detection\n");
161 if (SYN_CAP_EXTENDED(priv->capabilities)) {
162 printk(KERN_INFO " Touchpad has extended capability bits\n");
163 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap))
164 printk(KERN_INFO " -> %d multi-buttons, i.e. besides standard buttons\n",
165 (int)(SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap)));
166 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
167 printk(KERN_INFO " -> middle button\n");
168 if (SYN_CAP_FOUR_BUTTON(priv->capabilities))
169 printk(KERN_INFO " -> four buttons\n");
170 if (SYN_CAP_MULTIFINGER(priv->capabilities))
171 printk(KERN_INFO " -> multifinger detection\n");
172 if (SYN_CAP_PALMDETECT(priv->capabilities))
173 printk(KERN_INFO " -> palm detection\n");
174 if (SYN_CAP_PASS_THROUGH(priv->capabilities))
175 printk(KERN_INFO " -> pass-through port\n");
179 static int synaptics_query_hardware(struct psmouse *psmouse)
183 while ((retries++ < 3) && psmouse_reset(psmouse))
184 printk(KERN_ERR "synaptics reset failed\n");
186 if (synaptics_identify(psmouse))
188 if (synaptics_model_id(psmouse))
190 if (synaptics_capability(psmouse))
196 static int synaptics_set_absolute_mode(struct psmouse *psmouse)
198 struct synaptics_data *priv = psmouse->private;
200 priv->mode = SYN_BIT_ABSOLUTE_MODE;
201 if (SYN_ID_MAJOR(priv->identity) >= 4)
202 priv->mode |= SYN_BIT_DISABLE_GESTURE;
203 if (SYN_CAP_EXTENDED(priv->capabilities))
204 priv->mode |= SYN_BIT_W_MODE;
206 if (synaptics_mode_cmd(psmouse, priv->mode))
212 static void synaptics_set_rate(struct psmouse *psmouse, unsigned int rate)
214 struct synaptics_data *priv = psmouse->private;
217 priv->mode |= SYN_BIT_HIGH_RATE;
220 priv->mode &= ~SYN_BIT_HIGH_RATE;
224 synaptics_mode_cmd(psmouse, priv->mode);
227 /*****************************************************************************
228 * Synaptics pass-through PS/2 port support
229 ****************************************************************************/
230 static int synaptics_pt_write(struct serio *serio, unsigned char c)
232 struct psmouse *parent = serio->parent->private;
233 char rate_param = SYN_PS_CLIENT_CMD; /* indicates that we want pass-through port */
235 if (psmouse_sliced_command(parent, c))
237 if (ps2_command(&parent->ps2dev, &rate_param, PSMOUSE_CMD_SETRATE))
242 static inline int synaptics_is_pt_packet(unsigned char *buf)
244 return (buf[0] & 0xFC) == 0x84 && (buf[3] & 0xCC) == 0xC4;
247 static void synaptics_pass_pt_packet(struct serio *ptport, unsigned char *packet)
249 struct psmouse *child = ptport->private;
251 if (child && child->state == PSMOUSE_ACTIVATED) {
252 serio_interrupt(ptport, packet[1], 0, NULL);
253 serio_interrupt(ptport, packet[4], 0, NULL);
254 serio_interrupt(ptport, packet[5], 0, NULL);
255 if (child->type >= PSMOUSE_GENPS)
256 serio_interrupt(ptport, packet[2], 0, NULL);
258 serio_interrupt(ptport, packet[1], 0, NULL);
261 static void synaptics_pt_activate(struct psmouse *psmouse)
263 struct psmouse *child = psmouse->ps2dev.serio->child->private;
264 struct synaptics_data *priv = psmouse->private;
266 /* adjust the touchpad to child's choice of protocol */
268 if (child->type >= PSMOUSE_GENPS)
269 priv->mode |= SYN_BIT_FOUR_BYTE_CLIENT;
271 priv->mode &= ~SYN_BIT_FOUR_BYTE_CLIENT;
273 if (synaptics_mode_cmd(psmouse, priv->mode))
274 printk(KERN_INFO "synaptics: failed to switch guest protocol\n");
278 static void synaptics_pt_create(struct psmouse *psmouse)
282 serio = kmalloc(sizeof(struct serio), GFP_KERNEL);
284 printk(KERN_ERR "synaptics: not enough memory to allocate pass-through port\n");
288 memset(serio, 0, sizeof(struct serio));
290 serio->type = SERIO_PS_PSTHRU;
291 strlcpy(serio->name, "Synaptics pass-through", sizeof(serio->name));
292 strlcpy(serio->phys, "synaptics-pt/serio0", sizeof(serio->name));
293 serio->write = synaptics_pt_write;
294 serio->parent = psmouse->ps2dev.serio;
296 psmouse->pt_activate = synaptics_pt_activate;
298 psmouse->ps2dev.serio->child = serio;
301 /*****************************************************************************
302 * Functions to interpret the absolute mode packets
303 ****************************************************************************/
305 static void synaptics_parse_hw_state(unsigned char buf[], struct synaptics_data *priv, struct synaptics_hw_state *hw)
307 memset(hw, 0, sizeof(struct synaptics_hw_state));
309 if (SYN_MODEL_NEWABS(priv->model_id)) {
310 hw->x = (((buf[3] & 0x10) << 8) |
311 ((buf[1] & 0x0f) << 8) |
313 hw->y = (((buf[3] & 0x20) << 7) |
314 ((buf[1] & 0xf0) << 4) |
318 hw->w = (((buf[0] & 0x30) >> 2) |
319 ((buf[0] & 0x04) >> 1) |
320 ((buf[3] & 0x04) >> 2));
322 hw->left = (buf[0] & 0x01) ? 1 : 0;
323 hw->right = (buf[0] & 0x02) ? 1 : 0;
325 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
326 hw->middle = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
328 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
329 hw->up = ((buf[0] ^ buf[3]) & 0x01) ? 1 : 0;
330 hw->down = ((buf[0] ^ buf[3]) & 0x02) ? 1 : 0;
333 if (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) &&
334 ((buf[0] ^ buf[3]) & 0x02)) {
335 switch (SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap) & ~0x01) {
338 * if nExtBtn is greater than 8 it should be
339 * considered invalid and treated as 0
343 hw->ext_buttons |= ((buf[5] & 0x08)) ? 0x80 : 0;
344 hw->ext_buttons |= ((buf[4] & 0x08)) ? 0x40 : 0;
346 hw->ext_buttons |= ((buf[5] & 0x04)) ? 0x20 : 0;
347 hw->ext_buttons |= ((buf[4] & 0x04)) ? 0x10 : 0;
349 hw->ext_buttons |= ((buf[5] & 0x02)) ? 0x08 : 0;
350 hw->ext_buttons |= ((buf[4] & 0x02)) ? 0x04 : 0;
352 hw->ext_buttons |= ((buf[5] & 0x01)) ? 0x02 : 0;
353 hw->ext_buttons |= ((buf[4] & 0x01)) ? 0x01 : 0;
357 hw->x = (((buf[1] & 0x1f) << 8) | buf[2]);
358 hw->y = (((buf[4] & 0x1f) << 8) | buf[5]);
360 hw->z = (((buf[0] & 0x30) << 2) | (buf[3] & 0x3F));
361 hw->w = (((buf[1] & 0x80) >> 4) | ((buf[0] & 0x04) >> 1));
363 hw->left = (buf[0] & 0x01) ? 1 : 0;
364 hw->right = (buf[0] & 0x02) ? 1 : 0;
369 * called for each full received packet from the touchpad
371 static void synaptics_process_packet(struct psmouse *psmouse)
373 struct input_dev *dev = &psmouse->dev;
374 struct synaptics_data *priv = psmouse->private;
375 struct synaptics_hw_state hw;
380 synaptics_parse_hw_state(psmouse->packet, priv, &hw);
385 if (SYN_CAP_EXTENDED(priv->capabilities)) {
388 if (SYN_CAP_MULTIFINGER(priv->capabilities))
389 num_fingers = hw.w + 2;
392 if (SYN_MODEL_PEN(priv->model_id))
393 ; /* Nothing, treat a pen as a single finger */
396 if (SYN_CAP_PALMDETECT(priv->capabilities))
407 * BTN_TOUCH has to be first as mousedev relies on it when doing
408 * absolute -> relative conversion
410 if (hw.z > 30) input_report_key(dev, BTN_TOUCH, 1);
411 if (hw.z < 25) input_report_key(dev, BTN_TOUCH, 0);
414 input_report_abs(dev, ABS_X, hw.x);
415 input_report_abs(dev, ABS_Y, YMAX_NOMINAL + YMIN_NOMINAL - hw.y);
417 input_report_abs(dev, ABS_PRESSURE, hw.z);
419 input_report_abs(dev, ABS_TOOL_WIDTH, finger_width);
420 input_report_key(dev, BTN_TOOL_FINGER, num_fingers == 1);
421 input_report_key(dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
422 input_report_key(dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
424 input_report_key(dev, BTN_LEFT, hw.left);
425 input_report_key(dev, BTN_RIGHT, hw.right);
427 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
428 input_report_key(dev, BTN_MIDDLE, hw.middle);
430 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
431 input_report_key(dev, BTN_FORWARD, hw.up);
432 input_report_key(dev, BTN_BACK, hw.down);
435 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
436 input_report_key(dev, BTN_0 + i, hw.ext_buttons & (1 << i));
441 static int synaptics_validate_byte(unsigned char packet[], int idx, unsigned char pkt_type)
443 static unsigned char newabs_mask[] = { 0xC8, 0x00, 0x00, 0xC8, 0x00 };
444 static unsigned char newabs_rel_mask[] = { 0xC0, 0x00, 0x00, 0xC0, 0x00 };
445 static unsigned char newabs_rslt[] = { 0x80, 0x00, 0x00, 0xC0, 0x00 };
446 static unsigned char oldabs_mask[] = { 0xC0, 0x60, 0x00, 0xC0, 0x60 };
447 static unsigned char oldabs_rslt[] = { 0xC0, 0x00, 0x00, 0x80, 0x00 };
449 if (idx < 0 || idx > 4)
454 case SYN_NEWABS_RELAXED:
455 return (packet[idx] & newabs_rel_mask[idx]) == newabs_rslt[idx];
457 case SYN_NEWABS_STRICT:
458 return (packet[idx] & newabs_mask[idx]) == newabs_rslt[idx];
461 return (packet[idx] & oldabs_mask[idx]) == oldabs_rslt[idx];
464 printk(KERN_ERR "synaptics: unknown packet type %d\n", pkt_type);
469 static unsigned char synaptics_detect_pkt_type(struct psmouse *psmouse)
473 for (i = 0; i < 5; i++)
474 if (!synaptics_validate_byte(psmouse->packet, i, SYN_NEWABS_STRICT)) {
475 printk(KERN_INFO "synaptics: using relaxed packet validation\n");
476 return SYN_NEWABS_RELAXED;
479 return SYN_NEWABS_STRICT;
482 static psmouse_ret_t synaptics_process_byte(struct psmouse *psmouse, struct pt_regs *regs)
484 struct input_dev *dev = &psmouse->dev;
485 struct synaptics_data *priv = psmouse->private;
487 input_regs(dev, regs);
489 if (psmouse->pktcnt >= 6) { /* Full packet received */
490 if (unlikely(priv->pkt_type == SYN_NEWABS))
491 priv->pkt_type = synaptics_detect_pkt_type(psmouse);
493 if (SYN_CAP_PASS_THROUGH(priv->capabilities) && synaptics_is_pt_packet(psmouse->packet)) {
494 if (psmouse->ps2dev.serio->child)
495 synaptics_pass_pt_packet(psmouse->ps2dev.serio->child, psmouse->packet);
497 synaptics_process_packet(psmouse);
499 return PSMOUSE_FULL_PACKET;
502 return synaptics_validate_byte(psmouse->packet, psmouse->pktcnt - 1, priv->pkt_type) ?
503 PSMOUSE_GOOD_DATA : PSMOUSE_BAD_DATA;
506 /*****************************************************************************
507 * Driver initialization/cleanup functions
508 ****************************************************************************/
509 static void set_input_params(struct input_dev *dev, struct synaptics_data *priv)
513 set_bit(EV_ABS, dev->evbit);
514 input_set_abs_params(dev, ABS_X, XMIN_NOMINAL, XMAX_NOMINAL, 0, 0);
515 input_set_abs_params(dev, ABS_Y, YMIN_NOMINAL, YMAX_NOMINAL, 0, 0);
516 input_set_abs_params(dev, ABS_PRESSURE, 0, 255, 0, 0);
517 set_bit(ABS_TOOL_WIDTH, dev->absbit);
519 set_bit(EV_KEY, dev->evbit);
520 set_bit(BTN_TOUCH, dev->keybit);
521 set_bit(BTN_TOOL_FINGER, dev->keybit);
522 set_bit(BTN_TOOL_DOUBLETAP, dev->keybit);
523 set_bit(BTN_TOOL_TRIPLETAP, dev->keybit);
525 set_bit(BTN_LEFT, dev->keybit);
526 set_bit(BTN_RIGHT, dev->keybit);
528 if (SYN_CAP_MIDDLE_BUTTON(priv->capabilities))
529 set_bit(BTN_MIDDLE, dev->keybit);
531 if (SYN_CAP_FOUR_BUTTON(priv->capabilities)) {
532 set_bit(BTN_FORWARD, dev->keybit);
533 set_bit(BTN_BACK, dev->keybit);
536 for (i = 0; i < SYN_CAP_MULTI_BUTTON_NO(priv->ext_cap); i++)
537 set_bit(BTN_0 + i, dev->keybit);
539 clear_bit(EV_REL, dev->evbit);
540 clear_bit(REL_X, dev->relbit);
541 clear_bit(REL_Y, dev->relbit);
544 void synaptics_reset(struct psmouse *psmouse)
546 /* reset touchpad back to relative mode, gestures enabled */
547 synaptics_mode_cmd(psmouse, 0);
550 static void synaptics_disconnect(struct psmouse *psmouse)
552 synaptics_reset(psmouse);
553 kfree(psmouse->private);
556 static int synaptics_reconnect(struct psmouse *psmouse)
558 struct synaptics_data *priv = psmouse->private;
559 struct synaptics_data old_priv = *priv;
561 if (synaptics_detect(psmouse, 0))
564 if (synaptics_query_hardware(psmouse)) {
565 printk(KERN_ERR "Unable to query Synaptics hardware.\n");
569 if (old_priv.identity != priv->identity ||
570 old_priv.model_id != priv->model_id ||
571 old_priv.capabilities != priv->capabilities ||
572 old_priv.ext_cap != priv->ext_cap)
575 if (synaptics_set_absolute_mode(psmouse)) {
576 printk(KERN_ERR "Unable to initialize Synaptics hardware.\n");
583 int synaptics_detect(struct psmouse *psmouse, int set_properties)
585 struct ps2dev *ps2dev = &psmouse->ps2dev;
586 unsigned char param[4];
590 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
591 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
592 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
593 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
594 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
596 if (param[1] != 0x47)
599 if (set_properties) {
600 psmouse->vendor = "Synaptics";
601 psmouse->name = "TouchPad";
607 int synaptics_init(struct psmouse *psmouse)
609 struct synaptics_data *priv;
611 psmouse->private = priv = kmalloc(sizeof(struct synaptics_data), GFP_KERNEL);
614 memset(priv, 0, sizeof(struct synaptics_data));
616 if (synaptics_query_hardware(psmouse)) {
617 printk(KERN_ERR "Unable to query Synaptics hardware.\n");
621 if (synaptics_set_absolute_mode(psmouse)) {
622 printk(KERN_ERR "Unable to initialize Synaptics hardware.\n");
626 priv->pkt_type = SYN_MODEL_NEWABS(priv->model_id) ? SYN_NEWABS : SYN_OLDABS;
628 if (SYN_CAP_PASS_THROUGH(priv->capabilities))
629 synaptics_pt_create(psmouse);
632 set_input_params(&psmouse->dev, priv);
634 psmouse->protocol_handler = synaptics_process_byte;
635 psmouse->set_rate = synaptics_set_rate;
636 psmouse->disconnect = synaptics_disconnect;
637 psmouse->reconnect = synaptics_reconnect;
638 psmouse->pktsize = 6;