2 * Logitech PS/2++ mouse driver
4 * Copyright (c) 1999-2003 Vojtech Pavlik <vojtech@suse.cz>
5 * Copyright (c) 2003 Eric Wong <eric@yhbt.net>
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.
12 #include <linux/input.h>
13 #include <linux/serio.h>
14 #include <linux/libps2.h>
16 #include "logips2pp.h"
18 /* Logitech mouse types */
19 #define PS2PP_KIND_WHEEL 1
20 #define PS2PP_KIND_MX 2
21 #define PS2PP_KIND_TP3 3
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
33 unsigned const int kind;
34 unsigned const int features;
38 * Process a PS2++ or PS2T++ packet.
41 static psmouse_ret_t ps2pp_process_byte(struct psmouse *psmouse, struct pt_regs *regs)
43 struct input_dev *dev = &psmouse->dev;
44 unsigned char *packet = psmouse->packet;
46 if (psmouse->pktcnt < 3)
47 return PSMOUSE_GOOD_DATA;
50 * Full packet accumulated, process it
53 input_regs(dev, regs);
55 if ((packet[0] & 0x48) == 0x48 && (packet[1] & 0x02) == 0x02) {
57 /* Logitech extended packet */
58 switch ((packet[1] >> 4) | (packet[0] & 0x30)) {
60 case 0x0d: /* Mouse extra info */
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);
69 case 0x0e: /* buttons 4, 5, 6, 7, 8, 9, 10 info */
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);
79 case 0x0f: /* TouchPad extra info */
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;
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));
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);
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);
104 return PSMOUSE_FULL_PACKET;
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
115 static int ps2pp_cmd(struct psmouse *psmouse, unsigned char *param, unsigned char command)
117 if (psmouse_sliced_command(psmouse, command))
120 if (ps2_command(&psmouse->ps2dev, param, PSMOUSE_CMD_POLL))
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
130 * 1 - enabled (if previously disabled, also default)
134 static void ps2pp_set_smartscroll(struct psmouse *psmouse, unsigned int smartscroll)
136 struct ps2dev *ps2dev = &psmouse->ps2dev;
137 unsigned char param[4];
142 ps2pp_cmd(psmouse, param, 0x32);
145 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
146 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
147 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
149 param[0] = smartscroll;
150 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
153 static ssize_t psmouse_attr_show_smartscroll(struct psmouse *psmouse, char *buf)
155 return sprintf(buf, "%d\n", psmouse->smartscroll ? 1 : 0);
158 static ssize_t psmouse_attr_set_smartscroll(struct psmouse *psmouse, const char *buf, size_t count)
163 value = simple_strtoul(buf, &rest, 10);
164 if (*rest || value > 1)
167 ps2pp_set_smartscroll(psmouse, value);
168 psmouse->smartscroll = value;
172 PSMOUSE_DEFINE_ATTR(smartscroll);
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).
180 static void ps2pp_set_resolution(struct psmouse *psmouse, unsigned int resolution)
182 if (resolution > 400) {
183 struct ps2dev *ps2dev = &psmouse->ps2dev;
184 unsigned char param = 3;
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, ¶m, PSMOUSE_CMD_SETRES);
190 psmouse->resolution = 800;
192 psmouse_set_resolution(psmouse, resolution);
195 static void ps2pp_disconnect(struct psmouse *psmouse)
197 device_remove_file(&psmouse->ps2dev.serio->dev, &psmouse_attr_smartscroll);
200 static struct ps2pp_info *get_model_info(unsigned char model)
202 static struct ps2pp_info ps2pp_list[] = {
203 { 12, 0, PS2PP_SIDE_BTN},
205 { 40, 0, PS2PP_SIDE_BTN },
206 { 41, 0, PS2PP_SIDE_BTN },
207 { 42, 0, PS2PP_SIDE_BTN },
208 { 43, 0, PS2PP_SIDE_BTN },
211 { 52, PS2PP_KIND_WHEEL, PS2PP_SIDE_BTN | PS2PP_WHEEL },
212 { 53, PS2PP_KIND_WHEEL, PS2PP_WHEEL },
214 PS2PP_WHEEL | PS2PP_SIDE_BTN | PS2PP_TASK_BTN |
215 PS2PP_EXTRA_BTN | PS2PP_NAV_BTN }, /* MX700 */
216 { 73, 0, PS2PP_SIDE_BTN },
217 { 75, PS2PP_KIND_WHEEL, PS2PP_WHEEL },
218 { 76, PS2PP_KIND_WHEEL, PS2PP_WHEEL },
219 { 80, PS2PP_KIND_WHEEL, PS2PP_SIDE_BTN | PS2PP_WHEEL },
220 { 81, PS2PP_KIND_WHEEL, PS2PP_WHEEL },
221 { 83, PS2PP_KIND_WHEEL, PS2PP_WHEEL },
222 { 88, PS2PP_KIND_WHEEL, PS2PP_WHEEL },
224 { 97, PS2PP_KIND_TP3, PS2PP_WHEEL | PS2PP_HWHEEL },
225 { 100, PS2PP_KIND_MX,
226 PS2PP_WHEEL | PS2PP_SIDE_BTN | PS2PP_TASK_BTN |
227 PS2PP_EXTRA_BTN | PS2PP_NAV_BTN }, /* MX510 */
228 { 112, PS2PP_KIND_MX,
229 PS2PP_WHEEL | PS2PP_SIDE_BTN | PS2PP_TASK_BTN |
230 PS2PP_EXTRA_BTN | PS2PP_NAV_BTN }, /* MX500 */
231 { 114, PS2PP_KIND_MX,
232 PS2PP_WHEEL | PS2PP_SIDE_BTN |
233 PS2PP_TASK_BTN | PS2PP_EXTRA_BTN }, /* M310 */
238 for (i = 0; ps2pp_list[i].model; i++)
239 if (model == ps2pp_list[i].model)
240 return &ps2pp_list[i];
245 * Set up input device's properties based on the detected mouse model.
248 static void ps2pp_set_model_properties(struct psmouse *psmouse, struct ps2pp_info *model_info,
251 if (model_info->features & PS2PP_SIDE_BTN)
252 set_bit(BTN_SIDE, psmouse->dev.keybit);
254 if (model_info->features & PS2PP_EXTRA_BTN)
255 set_bit(BTN_EXTRA, psmouse->dev.keybit);
257 if (model_info->features & PS2PP_TASK_BTN)
258 set_bit(BTN_TASK, psmouse->dev.keybit);
260 if (model_info->features & PS2PP_NAV_BTN) {
261 set_bit(BTN_FORWARD, psmouse->dev.keybit);
262 set_bit(BTN_BACK, psmouse->dev.keybit);
265 if (model_info->features & PS2PP_WHEEL)
266 set_bit(REL_WHEEL, psmouse->dev.relbit);
268 if (model_info->features & PS2PP_HWHEEL)
269 set_bit(REL_HWHEEL, psmouse->dev.relbit);
271 switch (model_info->kind) {
272 case PS2PP_KIND_WHEEL:
273 psmouse->name = "Wheel Mouse";
277 psmouse->name = "MX Mouse";
281 psmouse->name = "TouchPad 3";
286 * Set name to "Mouse" only when using PS2++,
287 * otherwise let other protocols define suitable
291 psmouse->name = "Mouse";
298 * Logitech magic init. Detect whether the mouse is a Logitech one
299 * and its exact model and try turning on extended protocol for ones
303 int ps2pp_init(struct psmouse *psmouse, int set_properties)
305 struct ps2dev *ps2dev = &psmouse->ps2dev;
306 unsigned char param[4];
307 unsigned char model, buttons;
308 struct ps2pp_info *model_info;
312 ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES);
313 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
314 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
315 ps2_command(ps2dev, NULL, PSMOUSE_CMD_SETSCALE11);
317 ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO);
322 model = ((param[0] >> 4) & 0x07) | ((param[0] << 3) & 0x78);
325 if ((model_info = get_model_info(model)) != NULL) {
328 * Do Logitech PS2++ / PS2T++ magic init.
330 if (model == 97) { /* Touch Pad 3 */
333 param[0] = 0x11; param[1] = 0x04; param[2] = 0x68;
334 ps2_command(ps2dev, param, 0x30d1);
335 /* Enable features */
336 param[0] = 0x11; param[1] = 0x05; param[2] = 0x0b;
337 ps2_command(ps2dev, param, 0x30d1);
339 param[0] = 0x11; param[1] = 0x09; param[2] = 0xc3;
340 ps2_command(ps2dev, param, 0x30d1);
343 if (!ps2_command(ps2dev, param, 0x13d1) &&
344 param[0] == 0x06 && param[1] == 0x00 && param[2] == 0x14) {
350 param[0] = param[1] = param[2] = 0;
351 ps2pp_cmd(psmouse, param, 0x39); /* Magic knock */
352 ps2pp_cmd(psmouse, param, 0xDB);
354 if ((param[0] & 0x78) == 0x48 &&
355 (param[1] & 0xf3) == 0xc2 &&
356 (param[2] & 0x03) == ((param[1] >> 2) & 3)) {
357 ps2pp_set_smartscroll(psmouse, psmouse->smartscroll);
363 if (set_properties) {
364 psmouse->vendor = "Logitech";
365 psmouse->model = model;
368 psmouse->protocol_handler = ps2pp_process_byte;
369 psmouse->pktsize = 3;
371 if (model_info->kind != PS2PP_KIND_TP3) {
372 psmouse->set_resolution = ps2pp_set_resolution;
373 psmouse->disconnect = ps2pp_disconnect;
375 device_create_file(&psmouse->ps2dev.serio->dev, &psmouse_attr_smartscroll);
380 clear_bit(BTN_MIDDLE, psmouse->dev.keybit);
382 clear_bit(BTN_RIGHT, psmouse->dev.keybit);
385 ps2pp_set_model_properties(psmouse, model_info, use_ps2pp);
388 return use_ps2pp ? 0 : -1;