Input: psmouse - wheel mice (imps, exps) always have 3rd button
[linux-2.6.git] / drivers / input / mouse / logips2pp.c
1 /*
2  * Logitech PS/2++ mouse driver
3  *
4  * Copyright (c) 1999-2003 Vojtech Pavlik <vojtech@suse.cz>
5  * Copyright (c) 2003 Eric Wong <eric@yhbt.net>
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License version 2 as published by
9  * the Free Software Foundation.
10  */
11
12 #include <linux/input.h>
13 #include <linux/serio.h>
14 #include <linux/libps2.h>
15 #include "psmouse.h"
16 #include "logips2pp.h"
17
18 /* Logitech mouse types */
19 #define PS2PP_KIND_WHEEL        1
20 #define PS2PP_KIND_MX           2
21 #define PS2PP_KIND_TP3          3
22
23 /* Logitech mouse features */
24 #define PS2PP_WHEEL             0x01
25 #define PS2PP_HWHEEL            0x02
26 #define PS2PP_SIDE_BTN          0x04
27 #define PS2PP_EXTRA_BTN         0x08
28 #define PS2PP_TASK_BTN          0x10
29 #define PS2PP_NAV_BTN           0x20
30
31 struct ps2pp_info {
32         const int model;
33         unsigned const int kind;
34         unsigned const int features;
35 };
36
37 /*
38  * Process a PS2++ or PS2T++ packet.
39  */
40
41 static psmouse_ret_t ps2pp_process_byte(struct psmouse *psmouse, struct pt_regs *regs)
42 {
43         struct input_dev *dev = &psmouse->dev;
44         unsigned char *packet = psmouse->packet;
45
46         if (psmouse->pktcnt < 3)
47                 return PSMOUSE_GOOD_DATA;
48
49 /*
50  * Full packet accumulated, process it
51  */
52
53         input_regs(dev, regs);
54
55         if ((packet[0] & 0x48) == 0x48 && (packet[1] & 0x02) == 0x02) {
56
57                 /* Logitech extended packet */
58                 switch ((packet[1] >> 4) | (packet[0] & 0x30)) {
59
60                         case 0x0d: /* Mouse extra info */
61
62                                 input_report_rel(dev, packet[2] & 0x80 ? REL_HWHEEL : REL_WHEEL,
63                                         (int) (packet[2] & 8) - (int) (packet[2] & 7));
64                                 input_report_key(dev, BTN_SIDE, (packet[2] >> 4) & 1);
65                                 input_report_key(dev, BTN_EXTRA, (packet[2] >> 5) & 1);
66
67                                 break;
68
69                         case 0x0e: /* buttons 4, 5, 6, 7, 8, 9, 10 info */
70
71                                 input_report_key(dev, BTN_SIDE, (packet[2]) & 1);
72                                 input_report_key(dev, BTN_EXTRA, (packet[2] >> 1) & 1);
73                                 input_report_key(dev, BTN_BACK, (packet[2] >> 3) & 1);
74                                 input_report_key(dev, BTN_FORWARD, (packet[2] >> 4) & 1);
75                                 input_report_key(dev, BTN_TASK, (packet[2] >> 2) & 1);
76
77                                 break;
78
79                         case 0x0f: /* TouchPad extra info */
80
81                                 input_report_rel(dev, packet[2] & 0x08 ? REL_HWHEEL : REL_WHEEL,
82                                         (int) ((packet[2] >> 4) & 8) - (int) ((packet[2] >> 4) & 7));
83                                 packet[0] = packet[2] | 0x08;
84                                 break;
85
86 #ifdef DEBUG
87                         default:
88                                 printk(KERN_WARNING "psmouse.c: Received PS2++ packet #%x, but don't know how to handle.\n",
89                                         (packet[1] >> 4) | (packet[0] & 0x30));
90 #endif
91                 }
92         } else {
93                 /* Standard PS/2 motion data */
94                 input_report_rel(dev, REL_X, packet[1] ? (int) packet[1] - (int) ((packet[0] << 4) & 0x100) : 0);
95                 input_report_rel(dev, REL_Y, packet[2] ? (int) ((packet[0] << 3) & 0x100) - (int) packet[2] : 0);
96         }
97
98         input_report_key(dev, BTN_LEFT,    packet[0]       & 1);
99         input_report_key(dev, BTN_MIDDLE, (packet[0] >> 2) & 1);
100         input_report_key(dev, BTN_RIGHT,  (packet[0] >> 1) & 1);
101
102         input_sync(dev);
103
104         return PSMOUSE_FULL_PACKET;
105
106 }
107
108 /*
109  * ps2pp_cmd() sends a PS2++ command, sliced into two bit
110  * pieces through the SETRES command. This is needed to send extended
111  * commands to mice on notebooks that try to understand the PS/2 protocol
112  * Ugly.
113  */
114
115 static int ps2pp_cmd(struct psmouse *psmouse, unsigned char *param, unsigned char command)
116 {
117         if (psmouse_sliced_command(psmouse, command))
118                 return -1;
119
120         if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_POLL))
121                 return -1;
122
123         return 0;
124 }
125
126 /*
127  * SmartScroll / CruiseControl for some newer Logitech mice Defaults to
128  * enabled if we do nothing to it. Of course I put this in because I want it
129  * disabled :P
130  * 1 - enabled (if previously disabled, also default)
131  * 0 - disabled
132  */
133
134 static void ps2pp_set_smartscroll(struct psmouse *psmouse, unsigned int smartscroll)
135 {
136         struct ps2dev *ps2dev = &psmouse->ps2dev;
137         unsigned char param[4];
138
139         if (smartscroll > 1)
140                 smartscroll = 1;
141
142         ps2pp_cmd(psmouse, param, 0x32);
143
144         param[0] = 0;
145         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
146         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
147         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
148
149         param[0] = smartscroll;
150         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
151 }
152
153 static ssize_t psmouse_attr_show_smartscroll(struct psmouse *psmouse, char *buf)
154 {
155         return sprintf(buf, "%d\n", psmouse->smartscroll ? 1 : 0);
156 }
157
158 static ssize_t psmouse_attr_set_smartscroll(struct psmouse *psmouse, const char *buf, size_t count)
159 {
160         unsigned long value;
161         char *rest;
162
163         value = simple_strtoul(buf, &rest, 10);
164         if (*rest || value > 1)
165                 return -EINVAL;
166
167         ps2pp_set_smartscroll(psmouse, value);
168         psmouse->smartscroll = value;
169         return count;
170 }
171
172 PSMOUSE_DEFINE_ATTR(smartscroll);
173
174 /*
175  * Support 800 dpi resolution _only_ if the user wants it (there are good
176  * reasons to not use it even if the mouse supports it, and of course there are
177  * also good reasons to use it, let the user decide).
178  */
179
180 static void ps2pp_set_resolution(struct psmouse *psmouse, unsigned int resolution)
181 {
182         if (resolution > 400) {
183                 struct ps2dev *ps2dev = &psmouse->ps2dev;
184                 unsigned char param = 3;
185
186                 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
187                 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
188                 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
189                 ps2_command(ps2dev, &param, PSMOUSE_CMD_SETRES);
190                 psmouse->resolution = 800;
191         } else
192                 psmouse_set_resolution(psmouse, resolution);
193 }
194
195 static void ps2pp_disconnect(struct psmouse *psmouse)
196 {
197         device_remove_file(&psmouse->ps2dev.serio->dev, &psmouse_attr_smartscroll);
198 }
199
200 static struct ps2pp_info *get_model_info(unsigned char model)
201 {
202         static struct ps2pp_info ps2pp_list[] = {
203                 { 12,   0,                      PS2PP_SIDE_BTN},
204                 { 13,   0,                      0 },
205                 { 15,   PS2PP_KIND_MX,                                  /* MX1000 */
206                                 PS2PP_WHEEL | PS2PP_SIDE_BTN | PS2PP_TASK_BTN |
207                                 PS2PP_EXTRA_BTN | PS2PP_NAV_BTN | PS2PP_HWHEEL },
208                 { 40,   0,                      PS2PP_SIDE_BTN },
209                 { 41,   0,                      PS2PP_SIDE_BTN },
210                 { 42,   0,                      PS2PP_SIDE_BTN },
211                 { 43,   0,                      PS2PP_SIDE_BTN },
212                 { 50,   0,                      0 },
213                 { 51,   0,                      0 },
214                 { 52,   PS2PP_KIND_WHEEL,       PS2PP_SIDE_BTN | PS2PP_WHEEL },
215                 { 53,   PS2PP_KIND_WHEEL,       PS2PP_WHEEL },
216                 { 61,   PS2PP_KIND_MX,                                  /* MX700 */
217                                 PS2PP_WHEEL | PS2PP_SIDE_BTN | PS2PP_TASK_BTN |
218                                 PS2PP_EXTRA_BTN | PS2PP_NAV_BTN },
219                 { 73,   0,                      PS2PP_SIDE_BTN },
220                 { 75,   PS2PP_KIND_WHEEL,       PS2PP_WHEEL },
221                 { 76,   PS2PP_KIND_WHEEL,       PS2PP_WHEEL },
222                 { 80,   PS2PP_KIND_WHEEL,       PS2PP_SIDE_BTN | PS2PP_WHEEL },
223                 { 81,   PS2PP_KIND_WHEEL,       PS2PP_WHEEL },
224                 { 83,   PS2PP_KIND_WHEEL,       PS2PP_WHEEL },
225                 { 88,   PS2PP_KIND_WHEEL,       PS2PP_WHEEL },
226                 { 96,   0,                      0 },
227                 { 97,   PS2PP_KIND_TP3,         PS2PP_WHEEL | PS2PP_HWHEEL },
228                 { 100,  PS2PP_KIND_MX,                                  /* MX510 */
229                                 PS2PP_WHEEL | PS2PP_SIDE_BTN | PS2PP_TASK_BTN |
230                                 PS2PP_EXTRA_BTN | PS2PP_NAV_BTN },
231                 { 111,  PS2PP_KIND_MX,                                  /* MX300 */
232                                 PS2PP_WHEEL | PS2PP_EXTRA_BTN | PS2PP_TASK_BTN },
233                 { 112,  PS2PP_KIND_MX,                                  /* MX500 */
234                                 PS2PP_WHEEL | PS2PP_SIDE_BTN | PS2PP_TASK_BTN |
235                                 PS2PP_EXTRA_BTN | PS2PP_NAV_BTN },
236                 { 114,  PS2PP_KIND_MX,                                  /* MX310 */
237                                 PS2PP_WHEEL | PS2PP_SIDE_BTN |
238                                 PS2PP_TASK_BTN | PS2PP_EXTRA_BTN },
239                 { }
240         };
241         int i;
242
243         for (i = 0; ps2pp_list[i].model; i++)
244                 if (model == ps2pp_list[i].model)
245                         return &ps2pp_list[i];
246
247         printk(KERN_WARNING "logips2pp: Detected unknown logitech mouse model %d\n", model);
248         return NULL;
249 }
250
251 /*
252  * Set up input device's properties based on the detected mouse model.
253  */
254
255 static void ps2pp_set_model_properties(struct psmouse *psmouse, struct ps2pp_info *model_info,
256                                        int using_ps2pp)
257 {
258         if (model_info->features & PS2PP_SIDE_BTN)
259                 set_bit(BTN_SIDE, psmouse->dev.keybit);
260
261         if (model_info->features & PS2PP_EXTRA_BTN)
262                 set_bit(BTN_EXTRA, psmouse->dev.keybit);
263
264         if (model_info->features & PS2PP_TASK_BTN)
265                 set_bit(BTN_TASK, psmouse->dev.keybit);
266
267         if (model_info->features & PS2PP_NAV_BTN) {
268                 set_bit(BTN_FORWARD, psmouse->dev.keybit);
269                 set_bit(BTN_BACK, psmouse->dev.keybit);
270         }
271
272         if (model_info->features & PS2PP_WHEEL)
273                 set_bit(REL_WHEEL, psmouse->dev.relbit);
274
275         if (model_info->features & PS2PP_HWHEEL)
276                 set_bit(REL_HWHEEL, psmouse->dev.relbit);
277
278         switch (model_info->kind) {
279                 case PS2PP_KIND_WHEEL:
280                         psmouse->name = "Wheel Mouse";
281                         break;
282
283                 case PS2PP_KIND_MX:
284                         psmouse->name = "MX Mouse";
285                         break;
286
287                 case PS2PP_KIND_TP3:
288                         psmouse->name = "TouchPad 3";
289                         break;
290
291                 default:
292                         /*
293                          * Set name to "Mouse" only when using PS2++,
294                          * otherwise let other protocols define suitable
295                          * name
296                          */
297                         if (using_ps2pp)
298                                 psmouse->name = "Mouse";
299                         break;
300         }
301 }
302
303
304 /*
305  * Logitech magic init. Detect whether the mouse is a Logitech one
306  * and its exact model and try turning on extended protocol for ones
307  * that support it.
308  */
309
310 int ps2pp_init(struct psmouse *psmouse, int set_properties)
311 {
312         struct ps2dev *ps2dev = &psmouse->ps2dev;
313         unsigned char param[4];
314         unsigned char model, buttons;
315         struct ps2pp_info *model_info;
316         int use_ps2pp = 0;
317
318         param[0] = 0;
319         ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
320         ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
321         ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
322         ps2_command(ps2dev,  NULL, PSMOUSE_CMD_SETSCALE11);
323         param[1] = 0;
324         ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
325
326         if (!param[1])
327                 return -1;
328
329         model = ((param[0] >> 4) & 0x07) | ((param[0] << 3) & 0x78);
330         buttons = param[1];
331
332         if ((model_info = get_model_info(model)) != NULL) {
333
334 /*
335  * Do Logitech PS2++ / PS2T++ magic init.
336  */
337                 if (model == 97) { /* Touch Pad 3 */
338
339                         /* Unprotect RAM */
340                         param[0] = 0x11; param[1] = 0x04; param[2] = 0x68;
341                         ps2_command(ps2dev, param, 0x30d1);
342                         /* Enable features */
343                         param[0] = 0x11; param[1] = 0x05; param[2] = 0x0b;
344                         ps2_command(ps2dev, param, 0x30d1);
345                         /* Enable PS2++ */
346                         param[0] = 0x11; param[1] = 0x09; param[2] = 0xc3;
347                         ps2_command(ps2dev, param, 0x30d1);
348
349                         param[0] = 0;
350                         if (!ps2_command(ps2dev, param, 0x13d1) &&
351                             param[0] == 0x06 && param[1] == 0x00 && param[2] == 0x14) {
352                                 use_ps2pp = 1;
353                         }
354
355                 } else {
356
357                         param[0] = param[1] = param[2] = 0;
358                         ps2pp_cmd(psmouse, param, 0x39); /* Magic knock */
359                         ps2pp_cmd(psmouse, param, 0xDB);
360
361                         if ((param[0] & 0x78) == 0x48 &&
362                             (param[1] & 0xf3) == 0xc2 &&
363                             (param[2] & 0x03) == ((param[1] >> 2) & 3)) {
364                                 ps2pp_set_smartscroll(psmouse, psmouse->smartscroll);
365                                 use_ps2pp = 1;
366                         }
367                 }
368         }
369
370         if (set_properties) {
371                 psmouse->vendor = "Logitech";
372                 psmouse->model = model;
373
374                 if (use_ps2pp) {
375                         psmouse->protocol_handler = ps2pp_process_byte;
376                         psmouse->pktsize = 3;
377
378                         if (model_info->kind != PS2PP_KIND_TP3) {
379                                 psmouse->set_resolution = ps2pp_set_resolution;
380                                 psmouse->disconnect = ps2pp_disconnect;
381
382                                 device_create_file(&psmouse->ps2dev.serio->dev, &psmouse_attr_smartscroll);
383                         }
384                 }
385
386                 if (buttons < 3)
387                         clear_bit(BTN_MIDDLE, psmouse->dev.keybit);
388
389                 if (model_info)
390                         ps2pp_set_model_properties(psmouse, model_info, use_ps2pp);
391         }
392
393         return use_ps2pp ? 0 : -1;
394 }
395