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