libertas: configurable beacon interval
[linux-2.6/sactl.git] / drivers / macintosh / adbhid.c
blobef4c117ea35fde801a43eeea0d1dbf8aebc14190
1 /*
2 * drivers/macintosh/adbhid.c
4 * ADB HID driver for Power Macintosh computers.
6 * Adapted from drivers/macintosh/mac_keyb.c by Franz Sirl.
7 * drivers/macintosh/mac_keyb.c was Copyright (C) 1996 Paul Mackerras
8 * with considerable contributions from Ben Herrenschmidt and others.
10 * Copyright (C) 2000 Franz Sirl.
12 * Adapted to ADB changes and support for more devices by
13 * Benjamin Herrenschmidt. Adapted from code in MkLinux
14 * and reworked.
16 * Supported devices:
18 * - Standard 1 button mouse
19 * - All standard Apple Extended protocol (handler ID 4)
20 * - mouseman and trackman mice & trackballs
21 * - PowerBook Trackpad (default setup: enable tapping)
22 * - MicroSpeed mouse & trackball (needs testing)
23 * - CH Products Trackball Pro (needs testing)
24 * - Contour Design (Contour Mouse)
25 * - Hunter digital (NoHandsMouse)
26 * - Kensignton TurboMouse 5 (needs testing)
27 * - Mouse Systems A3 mice and trackballs <aidan@kublai.com>
28 * - MacAlly 2-buttons mouse (needs testing) <pochini@denise.shiny.it>
30 * To do:
32 * Improve Kensington support.
33 * Split mouse/kbd
34 * Move to syfs
37 #include <linux/module.h>
38 #include <linux/slab.h>
39 #include <linux/init.h>
40 #include <linux/notifier.h>
41 #include <linux/input.h>
43 #include <linux/adb.h>
44 #include <linux/cuda.h>
45 #include <linux/pmu.h>
47 #include <asm/machdep.h>
48 #ifdef CONFIG_PPC_PMAC
49 #include <asm/backlight.h>
50 #include <asm/pmac_feature.h>
51 #endif
53 MODULE_AUTHOR("Franz Sirl <Franz.Sirl-kernel@lauterbach.com>");
55 static int restore_capslock_events;
56 module_param(restore_capslock_events, int, 0644);
57 MODULE_PARM_DESC(restore_capslock_events,
58 "Produce keypress events for capslock on both keyup and keydown.");
60 #define KEYB_KEYREG 0 /* register # for key up/down data */
61 #define KEYB_LEDREG 2 /* register # for leds on ADB keyboard */
62 #define MOUSE_DATAREG 0 /* reg# for movement/button codes from mouse */
64 static int adb_message_handler(struct notifier_block *, unsigned long, void *);
65 static struct notifier_block adbhid_adb_notifier = {
66 .notifier_call = adb_message_handler,
69 /* Some special keys */
70 #define ADB_KEY_DEL 0x33
71 #define ADB_KEY_CMD 0x37
72 #define ADB_KEY_CAPSLOCK 0x39
73 #define ADB_KEY_FN 0x3f
74 #define ADB_KEY_FWDEL 0x75
75 #define ADB_KEY_POWER_OLD 0x7e
76 #define ADB_KEY_POWER 0x7f
78 u16 adb_to_linux_keycodes[128] = {
79 /* 0x00 */ KEY_A, /* 30 */
80 /* 0x01 */ KEY_S, /* 31 */
81 /* 0x02 */ KEY_D, /* 32 */
82 /* 0x03 */ KEY_F, /* 33 */
83 /* 0x04 */ KEY_H, /* 35 */
84 /* 0x05 */ KEY_G, /* 34 */
85 /* 0x06 */ KEY_Z, /* 44 */
86 /* 0x07 */ KEY_X, /* 45 */
87 /* 0x08 */ KEY_C, /* 46 */
88 /* 0x09 */ KEY_V, /* 47 */
89 /* 0x0a */ KEY_102ND, /* 86 */
90 /* 0x0b */ KEY_B, /* 48 */
91 /* 0x0c */ KEY_Q, /* 16 */
92 /* 0x0d */ KEY_W, /* 17 */
93 /* 0x0e */ KEY_E, /* 18 */
94 /* 0x0f */ KEY_R, /* 19 */
95 /* 0x10 */ KEY_Y, /* 21 */
96 /* 0x11 */ KEY_T, /* 20 */
97 /* 0x12 */ KEY_1, /* 2 */
98 /* 0x13 */ KEY_2, /* 3 */
99 /* 0x14 */ KEY_3, /* 4 */
100 /* 0x15 */ KEY_4, /* 5 */
101 /* 0x16 */ KEY_6, /* 7 */
102 /* 0x17 */ KEY_5, /* 6 */
103 /* 0x18 */ KEY_EQUAL, /* 13 */
104 /* 0x19 */ KEY_9, /* 10 */
105 /* 0x1a */ KEY_7, /* 8 */
106 /* 0x1b */ KEY_MINUS, /* 12 */
107 /* 0x1c */ KEY_8, /* 9 */
108 /* 0x1d */ KEY_0, /* 11 */
109 /* 0x1e */ KEY_RIGHTBRACE, /* 27 */
110 /* 0x1f */ KEY_O, /* 24 */
111 /* 0x20 */ KEY_U, /* 22 */
112 /* 0x21 */ KEY_LEFTBRACE, /* 26 */
113 /* 0x22 */ KEY_I, /* 23 */
114 /* 0x23 */ KEY_P, /* 25 */
115 /* 0x24 */ KEY_ENTER, /* 28 */
116 /* 0x25 */ KEY_L, /* 38 */
117 /* 0x26 */ KEY_J, /* 36 */
118 /* 0x27 */ KEY_APOSTROPHE, /* 40 */
119 /* 0x28 */ KEY_K, /* 37 */
120 /* 0x29 */ KEY_SEMICOLON, /* 39 */
121 /* 0x2a */ KEY_BACKSLASH, /* 43 */
122 /* 0x2b */ KEY_COMMA, /* 51 */
123 /* 0x2c */ KEY_SLASH, /* 53 */
124 /* 0x2d */ KEY_N, /* 49 */
125 /* 0x2e */ KEY_M, /* 50 */
126 /* 0x2f */ KEY_DOT, /* 52 */
127 /* 0x30 */ KEY_TAB, /* 15 */
128 /* 0x31 */ KEY_SPACE, /* 57 */
129 /* 0x32 */ KEY_GRAVE, /* 41 */
130 /* 0x33 */ KEY_BACKSPACE, /* 14 */
131 /* 0x34 */ KEY_KPENTER, /* 96 */
132 /* 0x35 */ KEY_ESC, /* 1 */
133 /* 0x36 */ KEY_LEFTCTRL, /* 29 */
134 /* 0x37 */ KEY_LEFTMETA, /* 125 */
135 /* 0x38 */ KEY_LEFTSHIFT, /* 42 */
136 /* 0x39 */ KEY_CAPSLOCK, /* 58 */
137 /* 0x3a */ KEY_LEFTALT, /* 56 */
138 /* 0x3b */ KEY_LEFT, /* 105 */
139 /* 0x3c */ KEY_RIGHT, /* 106 */
140 /* 0x3d */ KEY_DOWN, /* 108 */
141 /* 0x3e */ KEY_UP, /* 103 */
142 /* 0x3f */ KEY_FN, /* 0x1d0 */
143 /* 0x40 */ 0,
144 /* 0x41 */ KEY_KPDOT, /* 83 */
145 /* 0x42 */ 0,
146 /* 0x43 */ KEY_KPASTERISK, /* 55 */
147 /* 0x44 */ 0,
148 /* 0x45 */ KEY_KPPLUS, /* 78 */
149 /* 0x46 */ 0,
150 /* 0x47 */ KEY_NUMLOCK, /* 69 */
151 /* 0x48 */ 0,
152 /* 0x49 */ 0,
153 /* 0x4a */ 0,
154 /* 0x4b */ KEY_KPSLASH, /* 98 */
155 /* 0x4c */ KEY_KPENTER, /* 96 */
156 /* 0x4d */ 0,
157 /* 0x4e */ KEY_KPMINUS, /* 74 */
158 /* 0x4f */ 0,
159 /* 0x50 */ 0,
160 /* 0x51 */ KEY_KPEQUAL, /* 117 */
161 /* 0x52 */ KEY_KP0, /* 82 */
162 /* 0x53 */ KEY_KP1, /* 79 */
163 /* 0x54 */ KEY_KP2, /* 80 */
164 /* 0x55 */ KEY_KP3, /* 81 */
165 /* 0x56 */ KEY_KP4, /* 75 */
166 /* 0x57 */ KEY_KP5, /* 76 */
167 /* 0x58 */ KEY_KP6, /* 77 */
168 /* 0x59 */ KEY_KP7, /* 71 */
169 /* 0x5a */ 0,
170 /* 0x5b */ KEY_KP8, /* 72 */
171 /* 0x5c */ KEY_KP9, /* 73 */
172 /* 0x5d */ KEY_YEN, /* 124 */
173 /* 0x5e */ KEY_RO, /* 89 */
174 /* 0x5f */ KEY_KPCOMMA, /* 121 */
175 /* 0x60 */ KEY_F5, /* 63 */
176 /* 0x61 */ KEY_F6, /* 64 */
177 /* 0x62 */ KEY_F7, /* 65 */
178 /* 0x63 */ KEY_F3, /* 61 */
179 /* 0x64 */ KEY_F8, /* 66 */
180 /* 0x65 */ KEY_F9, /* 67 */
181 /* 0x66 */ KEY_HANJA, /* 123 */
182 /* 0x67 */ KEY_F11, /* 87 */
183 /* 0x68 */ KEY_HANGEUL, /* 122 */
184 /* 0x69 */ KEY_SYSRQ, /* 99 */
185 /* 0x6a */ 0,
186 /* 0x6b */ KEY_SCROLLLOCK, /* 70 */
187 /* 0x6c */ 0,
188 /* 0x6d */ KEY_F10, /* 68 */
189 /* 0x6e */ KEY_COMPOSE, /* 127 */
190 /* 0x6f */ KEY_F12, /* 88 */
191 /* 0x70 */ 0,
192 /* 0x71 */ KEY_PAUSE, /* 119 */
193 /* 0x72 */ KEY_INSERT, /* 110 */
194 /* 0x73 */ KEY_HOME, /* 102 */
195 /* 0x74 */ KEY_PAGEUP, /* 104 */
196 /* 0x75 */ KEY_DELETE, /* 111 */
197 /* 0x76 */ KEY_F4, /* 62 */
198 /* 0x77 */ KEY_END, /* 107 */
199 /* 0x78 */ KEY_F2, /* 60 */
200 /* 0x79 */ KEY_PAGEDOWN, /* 109 */
201 /* 0x7a */ KEY_F1, /* 59 */
202 /* 0x7b */ KEY_RIGHTSHIFT, /* 54 */
203 /* 0x7c */ KEY_RIGHTALT, /* 100 */
204 /* 0x7d */ KEY_RIGHTCTRL, /* 97 */
205 /* 0x7e */ KEY_RIGHTMETA, /* 126 */
206 /* 0x7f */ KEY_POWER, /* 116 */
209 struct adbhid {
210 struct input_dev *input;
211 int id;
212 int default_id;
213 int original_handler_id;
214 int current_handler_id;
215 int mouse_kind;
216 u16 *keycode;
217 char name[64];
218 char phys[32];
219 int flags;
222 #define FLAG_FN_KEY_PRESSED 0x00000001
223 #define FLAG_POWER_FROM_FN 0x00000002
224 #define FLAG_EMU_FWDEL_DOWN 0x00000004
225 #define FLAG_CAPSLOCK_TRANSLATE 0x00000008
226 #define FLAG_CAPSLOCK_DOWN 0x00000010
228 static struct adbhid *adbhid[16];
230 static void adbhid_probe(void);
232 static void adbhid_input_keycode(int, int, int);
234 static void init_trackpad(int id);
235 static void init_trackball(int id);
236 static void init_turbomouse(int id);
237 static void init_microspeed(int id);
238 static void init_ms_a3(int id);
240 static struct adb_ids keyboard_ids;
241 static struct adb_ids mouse_ids;
242 static struct adb_ids buttons_ids;
244 /* Kind of keyboard, see Apple technote 1152 */
245 #define ADB_KEYBOARD_UNKNOWN 0
246 #define ADB_KEYBOARD_ANSI 0x0100
247 #define ADB_KEYBOARD_ISO 0x0200
248 #define ADB_KEYBOARD_JIS 0x0300
250 /* Kind of mouse */
251 #define ADBMOUSE_STANDARD_100 0 /* Standard 100cpi mouse (handler 1) */
252 #define ADBMOUSE_STANDARD_200 1 /* Standard 200cpi mouse (handler 2) */
253 #define ADBMOUSE_EXTENDED 2 /* Apple Extended mouse (handler 4) */
254 #define ADBMOUSE_TRACKBALL 3 /* TrackBall (handler 4) */
255 #define ADBMOUSE_TRACKPAD 4 /* Apple's PowerBook trackpad (handler 4) */
256 #define ADBMOUSE_TURBOMOUSE5 5 /* Turbomouse 5 (previously req. mousehack) */
257 #define ADBMOUSE_MICROSPEED 6 /* Microspeed mouse (&trackball ?), MacPoint */
258 #define ADBMOUSE_TRACKBALLPRO 7 /* Trackball Pro (special buttons) */
259 #define ADBMOUSE_MS_A3 8 /* Mouse systems A3 trackball (handler 3) */
260 #define ADBMOUSE_MACALLY2 9 /* MacAlly 2-button mouse */
262 static void
263 adbhid_keyboard_input(unsigned char *data, int nb, int apoll)
265 int id = (data[0] >> 4) & 0x0f;
267 if (!adbhid[id]) {
268 printk(KERN_ERR "ADB HID on ID %d not yet registered, packet %#02x, %#02x, %#02x, %#02x\n",
269 id, data[0], data[1], data[2], data[3]);
270 return;
273 /* first check this is from register 0 */
274 if (nb != 3 || (data[0] & 3) != KEYB_KEYREG)
275 return; /* ignore it */
276 adbhid_input_keycode(id, data[1], 0);
277 if (!(data[2] == 0xff || (data[2] == 0x7f && data[1] == 0x7f)))
278 adbhid_input_keycode(id, data[2], 0);
281 static void
282 adbhid_input_keycode(int id, int scancode, int repeat)
284 struct adbhid *ahid = adbhid[id];
285 int keycode, up_flag, key;
287 keycode = scancode & 0x7f;
288 up_flag = scancode & 0x80;
290 if (restore_capslock_events) {
291 if (keycode == ADB_KEY_CAPSLOCK && !up_flag) {
292 /* Key pressed, turning on the CapsLock LED.
293 * The next 0xff will be interpreted as a release. */
294 ahid->flags |= FLAG_CAPSLOCK_TRANSLATE
295 | FLAG_CAPSLOCK_DOWN;
296 } else if (scancode == 0xff) {
297 /* Scancode 0xff usually signifies that the capslock
298 * key was either pressed or released. */
299 if (ahid->flags & FLAG_CAPSLOCK_TRANSLATE) {
300 keycode = ADB_KEY_CAPSLOCK;
301 if (ahid->flags & FLAG_CAPSLOCK_DOWN) {
302 /* Key released */
303 up_flag = 1;
304 ahid->flags &= ~FLAG_CAPSLOCK_DOWN;
305 } else {
306 /* Key pressed */
307 up_flag = 0;
308 ahid->flags &= ~FLAG_CAPSLOCK_TRANSLATE;
310 } else {
311 printk(KERN_INFO "Spurious caps lock event "
312 "(scancode 0xff).");
317 switch (keycode) {
318 case ADB_KEY_CAPSLOCK:
319 if (!restore_capslock_events) {
320 /* Generate down/up events for CapsLock everytime. */
321 input_report_key(ahid->input, KEY_CAPSLOCK, 1);
322 input_sync(ahid->input);
323 input_report_key(ahid->input, KEY_CAPSLOCK, 0);
324 input_sync(ahid->input);
325 return;
327 break;
328 #ifdef CONFIG_PPC_PMAC
329 case ADB_KEY_POWER_OLD: /* Power key on PBook 3400 needs remapping */
330 switch(pmac_call_feature(PMAC_FTR_GET_MB_INFO,
331 NULL, PMAC_MB_INFO_MODEL, 0)) {
332 case PMAC_TYPE_COMET:
333 case PMAC_TYPE_HOOPER:
334 case PMAC_TYPE_KANGA:
335 keycode = ADB_KEY_POWER;
337 break;
338 case ADB_KEY_POWER:
339 /* Fn + Command will produce a bogus "power" keycode */
340 if (ahid->flags & FLAG_FN_KEY_PRESSED) {
341 keycode = ADB_KEY_CMD;
342 if (up_flag)
343 ahid->flags &= ~FLAG_POWER_FROM_FN;
344 else
345 ahid->flags |= FLAG_POWER_FROM_FN;
346 } else if (ahid->flags & FLAG_POWER_FROM_FN) {
347 keycode = ADB_KEY_CMD;
348 ahid->flags &= ~FLAG_POWER_FROM_FN;
350 break;
351 case ADB_KEY_FN:
352 /* Keep track of the Fn key state */
353 if (up_flag) {
354 ahid->flags &= ~FLAG_FN_KEY_PRESSED;
355 /* Emulate Fn+delete = forward delete */
356 if (ahid->flags & FLAG_EMU_FWDEL_DOWN) {
357 ahid->flags &= ~FLAG_EMU_FWDEL_DOWN;
358 keycode = ADB_KEY_FWDEL;
359 break;
361 } else
362 ahid->flags |= FLAG_FN_KEY_PRESSED;
363 break;
364 case ADB_KEY_DEL:
365 /* Emulate Fn+delete = forward delete */
366 if (ahid->flags & FLAG_FN_KEY_PRESSED) {
367 keycode = ADB_KEY_FWDEL;
368 if (up_flag)
369 ahid->flags &= ~FLAG_EMU_FWDEL_DOWN;
370 else
371 ahid->flags |= FLAG_EMU_FWDEL_DOWN;
373 break;
374 #endif /* CONFIG_PPC_PMAC */
377 key = adbhid[id]->keycode[keycode];
378 if (key) {
379 input_report_key(adbhid[id]->input, key, !up_flag);
380 input_sync(adbhid[id]->input);
381 } else
382 printk(KERN_INFO "Unhandled ADB key (scancode %#02x) %s.\n", keycode,
383 up_flag ? "released" : "pressed");
387 static void
388 adbhid_mouse_input(unsigned char *data, int nb, int autopoll)
390 int id = (data[0] >> 4) & 0x0f;
392 if (!adbhid[id]) {
393 printk(KERN_ERR "ADB HID on ID %d not yet registered\n", id);
394 return;
398 Handler 1 -- 100cpi original Apple mouse protocol.
399 Handler 2 -- 200cpi original Apple mouse protocol.
401 For Apple's standard one-button mouse protocol the data array will
402 contain the following values:
404 BITS COMMENTS
405 data[0] = dddd 1100 ADB command: Talk, register 0, for device dddd.
406 data[1] = bxxx xxxx First button and x-axis motion.
407 data[2] = byyy yyyy Second button and y-axis motion.
409 Handler 4 -- Apple Extended mouse protocol.
411 For Apple's 3-button mouse protocol the data array will contain the
412 following values:
414 BITS COMMENTS
415 data[0] = dddd 1100 ADB command: Talk, register 0, for device dddd.
416 data[1] = bxxx xxxx Left button and x-axis motion.
417 data[2] = byyy yyyy Second button and y-axis motion.
418 data[3] = byyy bxxx Third button and fourth button. Y is additional
419 high bits of y-axis motion. XY is additional
420 high bits of x-axis motion.
422 MacAlly 2-button mouse protocol.
424 For MacAlly 2-button mouse protocol the data array will contain the
425 following values:
427 BITS COMMENTS
428 data[0] = dddd 1100 ADB command: Talk, register 0, for device dddd.
429 data[1] = bxxx xxxx Left button and x-axis motion.
430 data[2] = byyy yyyy Right button and y-axis motion.
431 data[3] = ???? ???? unknown
432 data[4] = ???? ???? unknown
436 /* If it's a trackpad, we alias the second button to the first.
437 NOTE: Apple sends an ADB flush command to the trackpad when
438 the first (the real) button is released. We could do
439 this here using async flush requests.
441 switch (adbhid[id]->mouse_kind)
443 case ADBMOUSE_TRACKPAD:
444 data[1] = (data[1] & 0x7f) | ((data[1] & data[2]) & 0x80);
445 data[2] = data[2] | 0x80;
446 break;
447 case ADBMOUSE_MICROSPEED:
448 data[1] = (data[1] & 0x7f) | ((data[3] & 0x01) << 7);
449 data[2] = (data[2] & 0x7f) | ((data[3] & 0x02) << 6);
450 data[3] = (data[3] & 0x77) | ((data[3] & 0x04) << 5)
451 | (data[3] & 0x08);
452 break;
453 case ADBMOUSE_TRACKBALLPRO:
454 data[1] = (data[1] & 0x7f) | (((data[3] & 0x04) << 5)
455 & ((data[3] & 0x08) << 4));
456 data[2] = (data[2] & 0x7f) | ((data[3] & 0x01) << 7);
457 data[3] = (data[3] & 0x77) | ((data[3] & 0x02) << 6);
458 break;
459 case ADBMOUSE_MS_A3:
460 data[1] = (data[1] & 0x7f) | ((data[3] & 0x01) << 7);
461 data[2] = (data[2] & 0x7f) | ((data[3] & 0x02) << 6);
462 data[3] = ((data[3] & 0x04) << 5);
463 break;
464 case ADBMOUSE_MACALLY2:
465 data[3] = (data[2] & 0x80) ? 0x80 : 0x00;
466 data[2] |= 0x80; /* Right button is mapped as button 3 */
467 nb=4;
468 break;
471 input_report_key(adbhid[id]->input, BTN_LEFT, !((data[1] >> 7) & 1));
472 input_report_key(adbhid[id]->input, BTN_MIDDLE, !((data[2] >> 7) & 1));
474 if (nb >= 4 && adbhid[id]->mouse_kind != ADBMOUSE_TRACKPAD)
475 input_report_key(adbhid[id]->input, BTN_RIGHT, !((data[3] >> 7) & 1));
477 input_report_rel(adbhid[id]->input, REL_X,
478 ((data[2]&0x7f) < 64 ? (data[2]&0x7f) : (data[2]&0x7f)-128 ));
479 input_report_rel(adbhid[id]->input, REL_Y,
480 ((data[1]&0x7f) < 64 ? (data[1]&0x7f) : (data[1]&0x7f)-128 ));
482 input_sync(adbhid[id]->input);
485 static void
486 adbhid_buttons_input(unsigned char *data, int nb, int autopoll)
488 int id = (data[0] >> 4) & 0x0f;
490 if (!adbhid[id]) {
491 printk(KERN_ERR "ADB HID on ID %d not yet registered\n", id);
492 return;
495 switch (adbhid[id]->original_handler_id) {
496 default:
497 case 0x02: /* Adjustable keyboard button device */
499 int down = (data[1] == (data[1] & 0xf));
501 switch (data[1] & 0x0f) {
502 case 0x0: /* microphone */
503 input_report_key(adbhid[id]->input, KEY_SOUND, down);
504 break;
506 case 0x1: /* mute */
507 input_report_key(adbhid[id]->input, KEY_MUTE, down);
508 break;
510 case 0x2: /* volume decrease */
511 input_report_key(adbhid[id]->input, KEY_VOLUMEDOWN, down);
512 break;
514 case 0x3: /* volume increase */
515 input_report_key(adbhid[id]->input, KEY_VOLUMEUP, down);
516 break;
518 default:
519 printk(KERN_INFO "Unhandled ADB_MISC event %02x, %02x, %02x, %02x\n",
520 data[0], data[1], data[2], data[3]);
521 break;
524 break;
526 case 0x1f: /* Powerbook button device */
528 int down = (data[1] == (data[1] & 0xf));
531 * XXX: Where is the contrast control for the passive?
532 * -- Cort
535 switch (data[1] & 0x0f) {
536 case 0x8: /* mute */
537 input_report_key(adbhid[id]->input, KEY_MUTE, down);
538 break;
540 case 0x7: /* volume decrease */
541 input_report_key(adbhid[id]->input, KEY_VOLUMEDOWN, down);
542 break;
544 case 0x6: /* volume increase */
545 input_report_key(adbhid[id]->input, KEY_VOLUMEUP, down);
546 break;
548 case 0xb: /* eject */
549 input_report_key(adbhid[id]->input, KEY_EJECTCD, down);
550 break;
552 case 0xa: /* brightness decrease */
553 #ifdef CONFIG_PMAC_BACKLIGHT
554 if (down)
555 pmac_backlight_key_down();
556 #endif
557 input_report_key(adbhid[id]->input, KEY_BRIGHTNESSDOWN, down);
558 break;
560 case 0x9: /* brightness increase */
561 #ifdef CONFIG_PMAC_BACKLIGHT
562 if (down)
563 pmac_backlight_key_up();
564 #endif
565 input_report_key(adbhid[id]->input, KEY_BRIGHTNESSUP, down);
566 break;
568 case 0xc: /* videomode switch */
569 input_report_key(adbhid[id]->input, KEY_SWITCHVIDEOMODE, down);
570 break;
572 case 0xd: /* keyboard illumination toggle */
573 input_report_key(adbhid[id]->input, KEY_KBDILLUMTOGGLE, down);
574 break;
576 case 0xe: /* keyboard illumination decrease */
577 input_report_key(adbhid[id]->input, KEY_KBDILLUMDOWN, down);
578 break;
580 case 0xf:
581 switch (data[1]) {
582 case 0x8f:
583 case 0x0f:
584 /* keyboard illumination increase */
585 input_report_key(adbhid[id]->input, KEY_KBDILLUMUP, down);
586 break;
588 case 0x7f:
589 case 0xff:
590 /* keypad overlay toogle */
591 break;
593 default:
594 printk(KERN_INFO "Unhandled ADB_MISC event %02x, %02x, %02x, %02x\n",
595 data[0], data[1], data[2], data[3]);
596 break;
598 break;
599 default:
600 printk(KERN_INFO "Unhandled ADB_MISC event %02x, %02x, %02x, %02x\n",
601 data[0], data[1], data[2], data[3]);
602 break;
605 break;
608 input_sync(adbhid[id]->input);
611 static struct adb_request led_request;
612 static int leds_pending[16];
613 static int leds_req_pending;
614 static int pending_devs[16];
615 static int pending_led_start;
616 static int pending_led_end;
617 static DEFINE_SPINLOCK(leds_lock);
619 static void leds_done(struct adb_request *req)
621 int leds = 0, device = 0, pending = 0;
622 unsigned long flags;
624 spin_lock_irqsave(&leds_lock, flags);
626 if (pending_led_start != pending_led_end) {
627 device = pending_devs[pending_led_start];
628 leds = leds_pending[device] & 0xff;
629 leds_pending[device] = 0;
630 pending_led_start++;
631 pending_led_start = (pending_led_start < 16) ? pending_led_start : 0;
632 pending = leds_req_pending;
633 } else
634 leds_req_pending = 0;
635 spin_unlock_irqrestore(&leds_lock, flags);
636 if (pending)
637 adb_request(&led_request, leds_done, 0, 3,
638 ADB_WRITEREG(device, KEYB_LEDREG), 0xff, ~leds);
641 static void real_leds(unsigned char leds, int device)
643 unsigned long flags;
645 spin_lock_irqsave(&leds_lock, flags);
646 if (!leds_req_pending) {
647 leds_req_pending = 1;
648 spin_unlock_irqrestore(&leds_lock, flags);
649 adb_request(&led_request, leds_done, 0, 3,
650 ADB_WRITEREG(device, KEYB_LEDREG), 0xff, ~leds);
651 return;
652 } else {
653 if (!(leds_pending[device] & 0x100)) {
654 pending_devs[pending_led_end] = device;
655 pending_led_end++;
656 pending_led_end = (pending_led_end < 16) ? pending_led_end : 0;
658 leds_pending[device] = leds | 0x100;
660 spin_unlock_irqrestore(&leds_lock, flags);
664 * Event callback from the input module. Events that change the state of
665 * the hardware are processed here.
667 static int adbhid_kbd_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
669 struct adbhid *adbhid = input_get_drvdata(dev);
670 unsigned char leds;
672 switch (type) {
673 case EV_LED:
674 leds = (test_bit(LED_SCROLLL, dev->led) ? 4 : 0) |
675 (test_bit(LED_NUML, dev->led) ? 1 : 0) |
676 (test_bit(LED_CAPSL, dev->led) ? 2 : 0);
677 real_leds(leds, adbhid->id);
678 return 0;
681 return -1;
684 static int
685 adb_message_handler(struct notifier_block *this, unsigned long code, void *x)
687 switch (code) {
688 case ADB_MSG_PRE_RESET:
689 case ADB_MSG_POWERDOWN:
690 /* Stop the repeat timer. Autopoll is already off at this point */
692 int i;
693 for (i = 1; i < 16; i++) {
694 if (adbhid[i])
695 del_timer_sync(&adbhid[i]->input->timer);
699 /* Stop pending led requests */
700 while(leds_req_pending)
701 adb_poll();
702 break;
704 case ADB_MSG_POST_RESET:
705 adbhid_probe();
706 break;
708 return NOTIFY_DONE;
711 static int
712 adbhid_input_register(int id, int default_id, int original_handler_id,
713 int current_handler_id, int mouse_kind)
715 struct adbhid *hid;
716 struct input_dev *input_dev;
717 int err;
718 int i;
720 if (adbhid[id]) {
721 printk(KERN_ERR "Trying to reregister ADB HID on ID %d\n", id);
722 return -EEXIST;
725 adbhid[id] = hid = kzalloc(sizeof(struct adbhid), GFP_KERNEL);
726 input_dev = input_allocate_device();
727 if (!hid || !input_dev) {
728 err = -ENOMEM;
729 goto fail;
732 sprintf(hid->phys, "adb%d:%d.%02x/input", id, default_id, original_handler_id);
734 hid->input = input_dev;
735 hid->id = default_id;
736 hid->original_handler_id = original_handler_id;
737 hid->current_handler_id = current_handler_id;
738 hid->mouse_kind = mouse_kind;
739 hid->flags = 0;
740 input_set_drvdata(input_dev, hid);
741 input_dev->name = hid->name;
742 input_dev->phys = hid->phys;
743 input_dev->id.bustype = BUS_ADB;
744 input_dev->id.vendor = 0x0001;
745 input_dev->id.product = (id << 12) | (default_id << 8) | original_handler_id;
746 input_dev->id.version = 0x0100;
748 switch (default_id) {
749 case ADB_KEYBOARD:
750 hid->keycode = kmalloc(sizeof(adb_to_linux_keycodes), GFP_KERNEL);
751 if (!hid->keycode) {
752 err = -ENOMEM;
753 goto fail;
756 sprintf(hid->name, "ADB keyboard");
758 memcpy(hid->keycode, adb_to_linux_keycodes, sizeof(adb_to_linux_keycodes));
760 printk(KERN_INFO "Detected ADB keyboard, type ");
761 switch (original_handler_id) {
762 default:
763 printk("<unknown>.\n");
764 input_dev->id.version = ADB_KEYBOARD_UNKNOWN;
765 break;
767 case 0x01: case 0x02: case 0x03: case 0x06: case 0x08:
768 case 0x0C: case 0x10: case 0x18: case 0x1B: case 0x1C:
769 case 0xC0: case 0xC3: case 0xC6:
770 printk("ANSI.\n");
771 input_dev->id.version = ADB_KEYBOARD_ANSI;
772 break;
774 case 0x04: case 0x05: case 0x07: case 0x09: case 0x0D:
775 case 0x11: case 0x14: case 0x19: case 0x1D: case 0xC1:
776 case 0xC4: case 0xC7:
777 printk("ISO, swapping keys.\n");
778 input_dev->id.version = ADB_KEYBOARD_ISO;
779 i = hid->keycode[10];
780 hid->keycode[10] = hid->keycode[50];
781 hid->keycode[50] = i;
782 break;
784 case 0x12: case 0x15: case 0x16: case 0x17: case 0x1A:
785 case 0x1E: case 0xC2: case 0xC5: case 0xC8: case 0xC9:
786 printk("JIS.\n");
787 input_dev->id.version = ADB_KEYBOARD_JIS;
788 break;
791 for (i = 0; i < 128; i++)
792 if (hid->keycode[i])
793 set_bit(hid->keycode[i], input_dev->keybit);
795 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_LED) |
796 BIT_MASK(EV_REP);
797 input_dev->ledbit[0] = BIT_MASK(LED_SCROLLL) |
798 BIT_MASK(LED_CAPSL) | BIT_MASK(LED_NUML);
799 input_dev->event = adbhid_kbd_event;
800 input_dev->keycodemax = KEY_FN;
801 input_dev->keycodesize = sizeof(hid->keycode[0]);
802 break;
804 case ADB_MOUSE:
805 sprintf(hid->name, "ADB mouse");
807 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
808 input_dev->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |
809 BIT_MASK(BTN_MIDDLE) | BIT_MASK(BTN_RIGHT);
810 input_dev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
811 break;
813 case ADB_MISC:
814 switch (original_handler_id) {
815 case 0x02: /* Adjustable keyboard button device */
816 sprintf(hid->name, "ADB adjustable keyboard buttons");
817 input_dev->evbit[0] = BIT_MASK(EV_KEY) |
818 BIT_MASK(EV_REP);
819 set_bit(KEY_SOUND, input_dev->keybit);
820 set_bit(KEY_MUTE, input_dev->keybit);
821 set_bit(KEY_VOLUMEUP, input_dev->keybit);
822 set_bit(KEY_VOLUMEDOWN, input_dev->keybit);
823 break;
824 case 0x1f: /* Powerbook button device */
825 sprintf(hid->name, "ADB Powerbook buttons");
826 input_dev->evbit[0] = BIT_MASK(EV_KEY) |
827 BIT_MASK(EV_REP);
828 set_bit(KEY_MUTE, input_dev->keybit);
829 set_bit(KEY_VOLUMEUP, input_dev->keybit);
830 set_bit(KEY_VOLUMEDOWN, input_dev->keybit);
831 set_bit(KEY_BRIGHTNESSUP, input_dev->keybit);
832 set_bit(KEY_BRIGHTNESSDOWN, input_dev->keybit);
833 set_bit(KEY_EJECTCD, input_dev->keybit);
834 set_bit(KEY_SWITCHVIDEOMODE, input_dev->keybit);
835 set_bit(KEY_KBDILLUMTOGGLE, input_dev->keybit);
836 set_bit(KEY_KBDILLUMDOWN, input_dev->keybit);
837 set_bit(KEY_KBDILLUMUP, input_dev->keybit);
838 break;
840 if (hid->name[0])
841 break;
842 /* else fall through */
844 default:
845 printk(KERN_INFO "Trying to register unknown ADB device to input layer.\n");
846 err = -ENODEV;
847 goto fail;
850 input_dev->keycode = hid->keycode;
852 err = input_register_device(input_dev);
853 if (err)
854 goto fail;
856 if (default_id == ADB_KEYBOARD) {
857 /* HACK WARNING!! This should go away as soon there is an utility
858 * to control that for event devices.
860 input_dev->rep[REP_DELAY] = 500; /* input layer default: 250 */
861 input_dev->rep[REP_PERIOD] = 66; /* input layer default: 33 */
864 return 0;
866 fail: input_free_device(input_dev);
867 if (hid) {
868 kfree(hid->keycode);
869 kfree(hid);
871 adbhid[id] = NULL;
872 return err;
875 static void adbhid_input_unregister(int id)
877 input_unregister_device(adbhid[id]->input);
878 kfree(adbhid[id]->keycode);
879 kfree(adbhid[id]);
880 adbhid[id] = NULL;
884 static u16
885 adbhid_input_reregister(int id, int default_id, int org_handler_id,
886 int cur_handler_id, int mk)
888 if (adbhid[id]) {
889 if (adbhid[id]->input->id.product !=
890 ((id << 12)|(default_id << 8)|org_handler_id)) {
891 adbhid_input_unregister(id);
892 adbhid_input_register(id, default_id, org_handler_id,
893 cur_handler_id, mk);
895 } else
896 adbhid_input_register(id, default_id, org_handler_id,
897 cur_handler_id, mk);
898 return 1<<id;
901 static void
902 adbhid_input_devcleanup(u16 exist)
904 int i;
905 for(i=1; i<16; i++)
906 if (adbhid[i] && !(exist&(1<<i)))
907 adbhid_input_unregister(i);
910 static void
911 adbhid_probe(void)
913 struct adb_request req;
914 int i, default_id, org_handler_id, cur_handler_id;
915 u16 reg = 0;
917 adb_register(ADB_MOUSE, 0, &mouse_ids, adbhid_mouse_input);
918 adb_register(ADB_KEYBOARD, 0, &keyboard_ids, adbhid_keyboard_input);
919 adb_register(ADB_MISC, 0, &buttons_ids, adbhid_buttons_input);
921 for (i = 0; i < keyboard_ids.nids; i++) {
922 int id = keyboard_ids.id[i];
924 adb_get_infos(id, &default_id, &org_handler_id);
926 /* turn off all leds */
927 adb_request(&req, NULL, ADBREQ_SYNC, 3,
928 ADB_WRITEREG(id, KEYB_LEDREG), 0xff, 0xff);
930 /* Enable full feature set of the keyboard
931 ->get it to send separate codes for left and right shift,
932 control, option keys */
933 #if 0 /* handler 5 doesn't send separate codes for R modifiers */
934 if (adb_try_handler_change(id, 5))
935 printk("ADB keyboard at %d, handler set to 5\n", id);
936 else
937 #endif
938 if (adb_try_handler_change(id, 3))
939 printk("ADB keyboard at %d, handler set to 3\n", id);
940 else
941 printk("ADB keyboard at %d, handler 1\n", id);
943 adb_get_infos(id, &default_id, &cur_handler_id);
944 reg |= adbhid_input_reregister(id, default_id, org_handler_id,
945 cur_handler_id, 0);
948 for (i = 0; i < buttons_ids.nids; i++) {
949 int id = buttons_ids.id[i];
951 adb_get_infos(id, &default_id, &org_handler_id);
952 reg |= adbhid_input_reregister(id, default_id, org_handler_id,
953 org_handler_id, 0);
956 /* Try to switch all mice to handler 4, or 2 for three-button
957 mode and full resolution. */
958 for (i = 0; i < mouse_ids.nids; i++) {
959 int id = mouse_ids.id[i];
960 int mouse_kind;
962 adb_get_infos(id, &default_id, &org_handler_id);
964 if (adb_try_handler_change(id, 4)) {
965 printk("ADB mouse at %d, handler set to 4", id);
966 mouse_kind = ADBMOUSE_EXTENDED;
968 else if (adb_try_handler_change(id, 0x2F)) {
969 printk("ADB mouse at %d, handler set to 0x2F", id);
970 mouse_kind = ADBMOUSE_MICROSPEED;
972 else if (adb_try_handler_change(id, 0x42)) {
973 printk("ADB mouse at %d, handler set to 0x42", id);
974 mouse_kind = ADBMOUSE_TRACKBALLPRO;
976 else if (adb_try_handler_change(id, 0x66)) {
977 printk("ADB mouse at %d, handler set to 0x66", id);
978 mouse_kind = ADBMOUSE_MICROSPEED;
980 else if (adb_try_handler_change(id, 0x5F)) {
981 printk("ADB mouse at %d, handler set to 0x5F", id);
982 mouse_kind = ADBMOUSE_MICROSPEED;
984 else if (adb_try_handler_change(id, 3)) {
985 printk("ADB mouse at %d, handler set to 3", id);
986 mouse_kind = ADBMOUSE_MS_A3;
988 else if (adb_try_handler_change(id, 2)) {
989 printk("ADB mouse at %d, handler set to 2", id);
990 mouse_kind = ADBMOUSE_STANDARD_200;
992 else {
993 printk("ADB mouse at %d, handler 1", id);
994 mouse_kind = ADBMOUSE_STANDARD_100;
997 if ((mouse_kind == ADBMOUSE_TRACKBALLPRO)
998 || (mouse_kind == ADBMOUSE_MICROSPEED)) {
999 init_microspeed(id);
1000 } else if (mouse_kind == ADBMOUSE_MS_A3) {
1001 init_ms_a3(id);
1002 } else if (mouse_kind == ADBMOUSE_EXTENDED) {
1004 * Register 1 is usually used for device
1005 * identification. Here, we try to identify
1006 * a known device and call the appropriate
1007 * init function.
1009 adb_request(&req, NULL, ADBREQ_SYNC | ADBREQ_REPLY, 1,
1010 ADB_READREG(id, 1));
1012 if ((req.reply_len) &&
1013 (req.reply[1] == 0x9a) && ((req.reply[2] == 0x21)
1014 || (req.reply[2] == 0x20))) {
1015 mouse_kind = ADBMOUSE_TRACKBALL;
1016 init_trackball(id);
1018 else if ((req.reply_len >= 4) &&
1019 (req.reply[1] == 0x74) && (req.reply[2] == 0x70) &&
1020 (req.reply[3] == 0x61) && (req.reply[4] == 0x64)) {
1021 mouse_kind = ADBMOUSE_TRACKPAD;
1022 init_trackpad(id);
1024 else if ((req.reply_len >= 4) &&
1025 (req.reply[1] == 0x4b) && (req.reply[2] == 0x4d) &&
1026 (req.reply[3] == 0x4c) && (req.reply[4] == 0x31)) {
1027 mouse_kind = ADBMOUSE_TURBOMOUSE5;
1028 init_turbomouse(id);
1030 else if ((req.reply_len == 9) &&
1031 (req.reply[1] == 0x4b) && (req.reply[2] == 0x4f) &&
1032 (req.reply[3] == 0x49) && (req.reply[4] == 0x54)) {
1033 if (adb_try_handler_change(id, 0x42)) {
1034 printk("\nADB MacAlly 2-button mouse at %d, handler set to 0x42", id);
1035 mouse_kind = ADBMOUSE_MACALLY2;
1039 printk("\n");
1041 adb_get_infos(id, &default_id, &cur_handler_id);
1042 reg |= adbhid_input_reregister(id, default_id, org_handler_id,
1043 cur_handler_id, mouse_kind);
1045 adbhid_input_devcleanup(reg);
1048 static void
1049 init_trackpad(int id)
1051 struct adb_request req;
1052 unsigned char r1_buffer[8];
1054 printk(" (trackpad)");
1056 adb_request(&req, NULL, ADBREQ_SYNC | ADBREQ_REPLY, 1,
1057 ADB_READREG(id,1));
1058 if (req.reply_len < 8)
1059 printk("bad length for reg. 1\n");
1060 else
1062 memcpy(r1_buffer, &req.reply[1], 8);
1064 adb_request(&req, NULL, ADBREQ_SYNC, 9,
1065 ADB_WRITEREG(id,1),
1066 r1_buffer[0],
1067 r1_buffer[1],
1068 r1_buffer[2],
1069 r1_buffer[3],
1070 r1_buffer[4],
1071 r1_buffer[5],
1072 0x0d,
1073 r1_buffer[7]);
1075 adb_request(&req, NULL, ADBREQ_SYNC, 9,
1076 ADB_WRITEREG(id,2),
1077 0x99,
1078 0x94,
1079 0x19,
1080 0xff,
1081 0xb2,
1082 0x8a,
1083 0x1b,
1084 0x50);
1086 adb_request(&req, NULL, ADBREQ_SYNC, 9,
1087 ADB_WRITEREG(id,1),
1088 r1_buffer[0],
1089 r1_buffer[1],
1090 r1_buffer[2],
1091 r1_buffer[3],
1092 r1_buffer[4],
1093 r1_buffer[5],
1094 0x03, /*r1_buffer[6],*/
1095 r1_buffer[7]);
1097 /* Without this flush, the trackpad may be locked up */
1098 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(id));
1102 static void
1103 init_trackball(int id)
1105 struct adb_request req;
1107 printk(" (trackman/mouseman)");
1109 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1110 ADB_WRITEREG(id,1), 00,0x81);
1112 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1113 ADB_WRITEREG(id,1), 01,0x81);
1115 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1116 ADB_WRITEREG(id,1), 02,0x81);
1118 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1119 ADB_WRITEREG(id,1), 03,0x38);
1121 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1122 ADB_WRITEREG(id,1), 00,0x81);
1124 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1125 ADB_WRITEREG(id,1), 01,0x81);
1127 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1128 ADB_WRITEREG(id,1), 02,0x81);
1130 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1131 ADB_WRITEREG(id,1), 03,0x38);
1134 static void
1135 init_turbomouse(int id)
1137 struct adb_request req;
1139 printk(" (TurboMouse 5)");
1141 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(id));
1143 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(3));
1145 adb_request(&req, NULL, ADBREQ_SYNC, 9,
1146 ADB_WRITEREG(3,2),
1147 0xe7,
1148 0x8c,
1152 0xff,
1153 0xff,
1154 0x94);
1156 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(3));
1158 adb_request(&req, NULL, ADBREQ_SYNC, 9,
1159 ADB_WRITEREG(3,2),
1160 0xa5,
1161 0x14,
1164 0x69,
1165 0xff,
1166 0xff,
1167 0x27);
1170 static void
1171 init_microspeed(int id)
1173 struct adb_request req;
1175 printk(" (Microspeed/MacPoint or compatible)");
1177 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(id));
1179 /* This will initialize mice using the Microspeed, MacPoint and
1180 other compatible firmware. Bit 12 enables extended protocol.
1182 Register 1 Listen (4 Bytes)
1183 0 - 3 Button is mouse (set also for double clicking!!!)
1184 4 - 7 Button is locking (affects change speed also)
1185 8 - 11 Button changes speed
1186 12 1 = Extended mouse mode, 0 = normal mouse mode
1187 13 - 15 unused 0
1188 16 - 23 normal speed
1189 24 - 31 changed speed
1191 Register 1 talk holds version and product identification information.
1192 Register 1 Talk (4 Bytes):
1193 0 - 7 Product code
1194 8 - 23 undefined, reserved
1195 24 - 31 Version number
1197 Speed 0 is max. 1 to 255 set speed in increments of 1/256 of max.
1199 adb_request(&req, NULL, ADBREQ_SYNC, 5,
1200 ADB_WRITEREG(id,1),
1201 0x20, /* alt speed = 0x20 (rather slow) */
1202 0x00, /* norm speed = 0x00 (fastest) */
1203 0x10, /* extended protocol, no speed change */
1204 0x07); /* all buttons enabled as mouse buttons, no locking */
1207 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(id));
1210 static void
1211 init_ms_a3(int id)
1213 struct adb_request req;
1215 printk(" (Mouse Systems A3 Mouse, or compatible)");
1216 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1217 ADB_WRITEREG(id, 0x2),
1218 0x00,
1219 0x07);
1221 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(id));
1224 static int __init adbhid_init(void)
1226 #ifndef CONFIG_MAC
1227 if (!machine_is(chrp) && !machine_is(powermac))
1228 return 0;
1229 #endif
1231 led_request.complete = 1;
1233 adbhid_probe();
1235 blocking_notifier_chain_register(&adb_client_list,
1236 &adbhid_adb_notifier);
1238 return 0;
1241 static void __exit adbhid_exit(void)
1245 module_init(adbhid_init);
1246 module_exit(adbhid_exit);