1 // SPDX-License-Identifier: GPL-2.0
3 * drivers/macintosh/adbhid.c
5 * ADB HID driver for Power Macintosh computers.
7 * Adapted from drivers/macintosh/mac_keyb.c by Franz Sirl.
8 * drivers/macintosh/mac_keyb.c was Copyright (C) 1996 Paul Mackerras
9 * with considerable contributions from Ben Herrenschmidt and others.
11 * Copyright (C) 2000 Franz Sirl.
13 * Adapted to ADB changes and support for more devices by
14 * Benjamin Herrenschmidt. Adapted from code in MkLinux
19 * - Standard 1 button mouse
20 * - All standard Apple Extended protocol (handler ID 4)
21 * - mouseman and trackman mice & trackballs
22 * - PowerBook Trackpad (default setup: enable tapping)
23 * - MicroSpeed mouse & trackball (needs testing)
24 * - CH Products Trackball Pro (needs testing)
25 * - Contour Design (Contour Mouse)
26 * - Hunter digital (NoHandsMouse)
27 * - Kensignton TurboMouse 5 (needs testing)
28 * - Mouse Systems A3 mice and trackballs <aidan@kublai.com>
29 * - MacAlly 2-buttons mouse (needs testing) <pochini@denise.shiny.it>
33 * Improve Kensington support.
38 #include <linux/module.h>
39 #include <linux/slab.h>
40 #include <linux/init.h>
41 #include <linux/notifier.h>
42 #include <linux/input.h>
44 #include <linux/adb.h>
45 #include <linux/cuda.h>
46 #include <linux/pmu.h>
48 #include <asm/machdep.h>
49 #ifdef CONFIG_PPC_PMAC
50 #include <asm/backlight.h>
51 #include <asm/pmac_feature.h>
54 MODULE_AUTHOR("Franz Sirl <Franz.Sirl-kernel@lauterbach.com>");
56 static int restore_capslock_events;
57 module_param(restore_capslock_events, int, 0644);
58 MODULE_PARM_DESC(restore_capslock_events,
59 "Produce keypress events for capslock on both keyup and keydown.");
61 #define KEYB_KEYREG 0 /* register # for key up/down data */
62 #define KEYB_LEDREG 2 /* register # for leds on ADB keyboard */
63 #define MOUSE_DATAREG 0 /* reg# for movement/button codes from mouse */
65 static int adb_message_handler(struct notifier_block *, unsigned long, void *);
66 static struct notifier_block adbhid_adb_notifier = {
67 .notifier_call = adb_message_handler,
70 /* Some special keys */
71 #define ADB_KEY_DEL 0x33
72 #define ADB_KEY_CMD 0x37
73 #define ADB_KEY_CAPSLOCK 0x39
74 #define ADB_KEY_FN 0x3f
75 #define ADB_KEY_FWDEL 0x75
76 #define ADB_KEY_POWER_OLD 0x7e
77 #define ADB_KEY_POWER 0x7f
79 static const u16 adb_to_linux_keycodes[128] = {
80 /* 0x00 */ KEY_A, /* 30 */
81 /* 0x01 */ KEY_S, /* 31 */
82 /* 0x02 */ KEY_D, /* 32 */
83 /* 0x03 */ KEY_F, /* 33 */
84 /* 0x04 */ KEY_H, /* 35 */
85 /* 0x05 */ KEY_G, /* 34 */
86 /* 0x06 */ KEY_Z, /* 44 */
87 /* 0x07 */ KEY_X, /* 45 */
88 /* 0x08 */ KEY_C, /* 46 */
89 /* 0x09 */ KEY_V, /* 47 */
90 /* 0x0a */ KEY_102ND, /* 86 */
91 /* 0x0b */ KEY_B, /* 48 */
92 /* 0x0c */ KEY_Q, /* 16 */
93 /* 0x0d */ KEY_W, /* 17 */
94 /* 0x0e */ KEY_E, /* 18 */
95 /* 0x0f */ KEY_R, /* 19 */
96 /* 0x10 */ KEY_Y, /* 21 */
97 /* 0x11 */ KEY_T, /* 20 */
98 /* 0x12 */ KEY_1, /* 2 */
99 /* 0x13 */ KEY_2, /* 3 */
100 /* 0x14 */ KEY_3, /* 4 */
101 /* 0x15 */ KEY_4, /* 5 */
102 /* 0x16 */ KEY_6, /* 7 */
103 /* 0x17 */ KEY_5, /* 6 */
104 /* 0x18 */ KEY_EQUAL, /* 13 */
105 /* 0x19 */ KEY_9, /* 10 */
106 /* 0x1a */ KEY_7, /* 8 */
107 /* 0x1b */ KEY_MINUS, /* 12 */
108 /* 0x1c */ KEY_8, /* 9 */
109 /* 0x1d */ KEY_0, /* 11 */
110 /* 0x1e */ KEY_RIGHTBRACE, /* 27 */
111 /* 0x1f */ KEY_O, /* 24 */
112 /* 0x20 */ KEY_U, /* 22 */
113 /* 0x21 */ KEY_LEFTBRACE, /* 26 */
114 /* 0x22 */ KEY_I, /* 23 */
115 /* 0x23 */ KEY_P, /* 25 */
116 /* 0x24 */ KEY_ENTER, /* 28 */
117 /* 0x25 */ KEY_L, /* 38 */
118 /* 0x26 */ KEY_J, /* 36 */
119 /* 0x27 */ KEY_APOSTROPHE, /* 40 */
120 /* 0x28 */ KEY_K, /* 37 */
121 /* 0x29 */ KEY_SEMICOLON, /* 39 */
122 /* 0x2a */ KEY_BACKSLASH, /* 43 */
123 /* 0x2b */ KEY_COMMA, /* 51 */
124 /* 0x2c */ KEY_SLASH, /* 53 */
125 /* 0x2d */ KEY_N, /* 49 */
126 /* 0x2e */ KEY_M, /* 50 */
127 /* 0x2f */ KEY_DOT, /* 52 */
128 /* 0x30 */ KEY_TAB, /* 15 */
129 /* 0x31 */ KEY_SPACE, /* 57 */
130 /* 0x32 */ KEY_GRAVE, /* 41 */
131 /* 0x33 */ KEY_BACKSPACE, /* 14 */
132 /* 0x34 */ KEY_KPENTER, /* 96 */
133 /* 0x35 */ KEY_ESC, /* 1 */
134 /* 0x36 */ KEY_LEFTCTRL, /* 29 */
135 /* 0x37 */ KEY_LEFTMETA, /* 125 */
136 /* 0x38 */ KEY_LEFTSHIFT, /* 42 */
137 /* 0x39 */ KEY_CAPSLOCK, /* 58 */
138 /* 0x3a */ KEY_LEFTALT, /* 56 */
139 /* 0x3b */ KEY_LEFT, /* 105 */
140 /* 0x3c */ KEY_RIGHT, /* 106 */
141 /* 0x3d */ KEY_DOWN, /* 108 */
142 /* 0x3e */ KEY_UP, /* 103 */
143 /* 0x3f */ KEY_FN, /* 0x1d0 */
145 /* 0x41 */ KEY_KPDOT, /* 83 */
147 /* 0x43 */ KEY_KPASTERISK, /* 55 */
149 /* 0x45 */ KEY_KPPLUS, /* 78 */
151 /* 0x47 */ KEY_NUMLOCK, /* 69 */
155 /* 0x4b */ KEY_KPSLASH, /* 98 */
156 /* 0x4c */ KEY_KPENTER, /* 96 */
158 /* 0x4e */ KEY_KPMINUS, /* 74 */
161 /* 0x51 */ KEY_KPEQUAL, /* 117 */
162 /* 0x52 */ KEY_KP0, /* 82 */
163 /* 0x53 */ KEY_KP1, /* 79 */
164 /* 0x54 */ KEY_KP2, /* 80 */
165 /* 0x55 */ KEY_KP3, /* 81 */
166 /* 0x56 */ KEY_KP4, /* 75 */
167 /* 0x57 */ KEY_KP5, /* 76 */
168 /* 0x58 */ KEY_KP6, /* 77 */
169 /* 0x59 */ KEY_KP7, /* 71 */
171 /* 0x5b */ KEY_KP8, /* 72 */
172 /* 0x5c */ KEY_KP9, /* 73 */
173 /* 0x5d */ KEY_YEN, /* 124 */
174 /* 0x5e */ KEY_RO, /* 89 */
175 /* 0x5f */ KEY_KPCOMMA, /* 121 */
176 /* 0x60 */ KEY_F5, /* 63 */
177 /* 0x61 */ KEY_F6, /* 64 */
178 /* 0x62 */ KEY_F7, /* 65 */
179 /* 0x63 */ KEY_F3, /* 61 */
180 /* 0x64 */ KEY_F8, /* 66 */
181 /* 0x65 */ KEY_F9, /* 67 */
182 /* 0x66 */ KEY_HANJA, /* 123 */
183 /* 0x67 */ KEY_F11, /* 87 */
184 /* 0x68 */ KEY_HANGEUL, /* 122 */
185 /* 0x69 */ KEY_SYSRQ, /* 99 */
187 /* 0x6b */ KEY_SCROLLLOCK, /* 70 */
189 /* 0x6d */ KEY_F10, /* 68 */
190 /* 0x6e */ KEY_COMPOSE, /* 127 */
191 /* 0x6f */ KEY_F12, /* 88 */
193 /* 0x71 */ KEY_PAUSE, /* 119 */
194 /* 0x72 */ KEY_INSERT, /* 110 */
195 /* 0x73 */ KEY_HOME, /* 102 */
196 /* 0x74 */ KEY_PAGEUP, /* 104 */
197 /* 0x75 */ KEY_DELETE, /* 111 */
198 /* 0x76 */ KEY_F4, /* 62 */
199 /* 0x77 */ KEY_END, /* 107 */
200 /* 0x78 */ KEY_F2, /* 60 */
201 /* 0x79 */ KEY_PAGEDOWN, /* 109 */
202 /* 0x7a */ KEY_F1, /* 59 */
203 /* 0x7b */ KEY_RIGHTSHIFT, /* 54 */
204 /* 0x7c */ KEY_RIGHTALT, /* 100 */
205 /* 0x7d */ KEY_RIGHTCTRL, /* 97 */
206 /* 0x7e */ KEY_RIGHTMETA, /* 126 */
207 /* 0x7f */ KEY_POWER, /* 116 */
211 struct input_dev *input;
214 int original_handler_id;
215 int current_handler_id;
223 #define FLAG_FN_KEY_PRESSED 0x00000001
224 #define FLAG_POWER_FROM_FN 0x00000002
225 #define FLAG_EMU_FWDEL_DOWN 0x00000004
226 #define FLAG_CAPSLOCK_TRANSLATE 0x00000008
227 #define FLAG_CAPSLOCK_DOWN 0x00000010
228 #define FLAG_CAPSLOCK_IGNORE_NEXT 0x00000020
229 #define FLAG_POWER_KEY_PRESSED 0x00000040
231 static struct adbhid *adbhid[16];
233 static void adbhid_probe(void);
235 static void adbhid_input_keycode(int, int, int);
237 static void init_trackpad(int id);
238 static void init_trackball(int id);
239 static void init_turbomouse(int id);
240 static void init_microspeed(int id);
241 static void init_ms_a3(int id);
243 static struct adb_ids keyboard_ids;
244 static struct adb_ids mouse_ids;
245 static struct adb_ids buttons_ids;
247 /* Kind of keyboard, see Apple technote 1152 */
248 #define ADB_KEYBOARD_UNKNOWN 0
249 #define ADB_KEYBOARD_ANSI 0x0100
250 #define ADB_KEYBOARD_ISO 0x0200
251 #define ADB_KEYBOARD_JIS 0x0300
254 #define ADBMOUSE_STANDARD_100 0 /* Standard 100cpi mouse (handler 1) */
255 #define ADBMOUSE_STANDARD_200 1 /* Standard 200cpi mouse (handler 2) */
256 #define ADBMOUSE_EXTENDED 2 /* Apple Extended mouse (handler 4) */
257 #define ADBMOUSE_TRACKBALL 3 /* TrackBall (handler 4) */
258 #define ADBMOUSE_TRACKPAD 4 /* Apple's PowerBook trackpad (handler 4) */
259 #define ADBMOUSE_TURBOMOUSE5 5 /* Turbomouse 5 (previously req. mousehack) */
260 #define ADBMOUSE_MICROSPEED 6 /* Microspeed mouse (&trackball ?), MacPoint */
261 #define ADBMOUSE_TRACKBALLPRO 7 /* Trackball Pro (special buttons) */
262 #define ADBMOUSE_MS_A3 8 /* Mouse systems A3 trackball (handler 3) */
263 #define ADBMOUSE_MACALLY2 9 /* MacAlly 2-button mouse */
266 adbhid_keyboard_input(unsigned char *data, int nb, int apoll)
268 int id = (data[0] >> 4) & 0x0f;
271 pr_err("ADB HID on ID %d not yet registered, packet %#02x, %#02x, %#02x, %#02x\n",
272 id, data[0], data[1], data[2], data[3]);
276 /* first check this is from register 0 */
277 if (nb != 3 || (data[0] & 3) != KEYB_KEYREG)
278 return; /* ignore it */
279 adbhid_input_keycode(id, data[1], 0);
280 if (!(data[2] == 0xff || (data[2] == 0x7f && data[1] == 0x7f)))
281 adbhid_input_keycode(id, data[2], 0);
285 adbhid_input_keycode(int id, int scancode, int repeat)
287 struct adbhid *ahid = adbhid[id];
288 int keycode, up_flag, key;
290 keycode = scancode & 0x7f;
291 up_flag = scancode & 0x80;
293 if (restore_capslock_events) {
294 if (keycode == ADB_KEY_CAPSLOCK && !up_flag) {
295 /* Key pressed, turning on the CapsLock LED.
296 * The next 0xff will be interpreted as a release. */
297 if (ahid->flags & FLAG_CAPSLOCK_IGNORE_NEXT) {
298 /* Throw away this key event if it happens
299 * just after resume. */
300 ahid->flags &= ~FLAG_CAPSLOCK_IGNORE_NEXT;
303 ahid->flags |= FLAG_CAPSLOCK_TRANSLATE
304 | FLAG_CAPSLOCK_DOWN;
306 } else if (scancode == 0xff &&
307 !(ahid->flags & FLAG_POWER_KEY_PRESSED)) {
308 /* Scancode 0xff usually signifies that the capslock
309 * key was either pressed or released, or that the
310 * power button was released. */
311 if (ahid->flags & FLAG_CAPSLOCK_TRANSLATE) {
312 keycode = ADB_KEY_CAPSLOCK;
313 if (ahid->flags & FLAG_CAPSLOCK_DOWN) {
316 ahid->flags &= ~FLAG_CAPSLOCK_DOWN;
320 ahid->flags &= ~FLAG_CAPSLOCK_TRANSLATE;
323 pr_info("Spurious caps lock event (scancode 0xff).\n");
329 case ADB_KEY_CAPSLOCK:
330 if (!restore_capslock_events) {
331 /* Generate down/up events for CapsLock every time. */
332 input_report_key(ahid->input, KEY_CAPSLOCK, 1);
333 input_sync(ahid->input);
334 input_report_key(ahid->input, KEY_CAPSLOCK, 0);
335 input_sync(ahid->input);
339 #ifdef CONFIG_PPC_PMAC
340 case ADB_KEY_POWER_OLD: /* Power key on PBook 3400 needs remapping */
341 switch(pmac_call_feature(PMAC_FTR_GET_MB_INFO,
342 NULL, PMAC_MB_INFO_MODEL, 0)) {
343 case PMAC_TYPE_COMET:
344 case PMAC_TYPE_HOOPER:
345 case PMAC_TYPE_KANGA:
346 keycode = ADB_KEY_POWER;
350 /* Keep track of the power key state */
352 ahid->flags &= ~FLAG_POWER_KEY_PRESSED;
354 ahid->flags |= FLAG_POWER_KEY_PRESSED;
356 /* Fn + Command will produce a bogus "power" keycode */
357 if (ahid->flags & FLAG_FN_KEY_PRESSED) {
358 keycode = ADB_KEY_CMD;
360 ahid->flags &= ~FLAG_POWER_FROM_FN;
362 ahid->flags |= FLAG_POWER_FROM_FN;
363 } else if (ahid->flags & FLAG_POWER_FROM_FN) {
364 keycode = ADB_KEY_CMD;
365 ahid->flags &= ~FLAG_POWER_FROM_FN;
369 /* Keep track of the Fn key state */
371 ahid->flags &= ~FLAG_FN_KEY_PRESSED;
372 /* Emulate Fn+delete = forward delete */
373 if (ahid->flags & FLAG_EMU_FWDEL_DOWN) {
374 ahid->flags &= ~FLAG_EMU_FWDEL_DOWN;
375 keycode = ADB_KEY_FWDEL;
379 ahid->flags |= FLAG_FN_KEY_PRESSED;
382 /* Emulate Fn+delete = forward delete */
383 if (ahid->flags & FLAG_FN_KEY_PRESSED) {
384 keycode = ADB_KEY_FWDEL;
386 ahid->flags &= ~FLAG_EMU_FWDEL_DOWN;
388 ahid->flags |= FLAG_EMU_FWDEL_DOWN;
391 #endif /* CONFIG_PPC_PMAC */
394 key = adbhid[id]->keycode[keycode];
396 input_report_key(adbhid[id]->input, key, !up_flag);
397 input_sync(adbhid[id]->input);
399 pr_info("Unhandled ADB key (scancode %#02x) %s.\n", keycode,
400 up_flag ? "released" : "pressed");
405 adbhid_mouse_input(unsigned char *data, int nb, int autopoll)
407 int id = (data[0] >> 4) & 0x0f;
410 pr_err("ADB HID on ID %d not yet registered\n", id);
415 Handler 1 -- 100cpi original Apple mouse protocol.
416 Handler 2 -- 200cpi original Apple mouse protocol.
418 For Apple's standard one-button mouse protocol the data array will
419 contain the following values:
422 data[0] = dddd 1100 ADB command: Talk, register 0, for device dddd.
423 data[1] = bxxx xxxx First button and x-axis motion.
424 data[2] = byyy yyyy Second button and y-axis motion.
426 Handler 4 -- Apple Extended mouse protocol.
428 For Apple's 3-button mouse protocol the data array will contain the
432 data[0] = dddd 1100 ADB command: Talk, register 0, for device dddd.
433 data[1] = bxxx xxxx Left button and x-axis motion.
434 data[2] = byyy yyyy Second button and y-axis motion.
435 data[3] = byyy bxxx Third button and fourth button. Y is additional
436 high bits of y-axis motion. XY is additional
437 high bits of x-axis motion.
439 MacAlly 2-button mouse protocol.
441 For MacAlly 2-button mouse protocol the data array will contain the
445 data[0] = dddd 1100 ADB command: Talk, register 0, for device dddd.
446 data[1] = bxxx xxxx Left button and x-axis motion.
447 data[2] = byyy yyyy Right button and y-axis motion.
448 data[3] = ???? ???? unknown
449 data[4] = ???? ???? unknown
453 /* If it's a trackpad, we alias the second button to the first.
454 NOTE: Apple sends an ADB flush command to the trackpad when
455 the first (the real) button is released. We could do
456 this here using async flush requests.
458 switch (adbhid[id]->mouse_kind)
460 case ADBMOUSE_TRACKPAD:
461 data[1] = (data[1] & 0x7f) | ((data[1] & data[2]) & 0x80);
462 data[2] = data[2] | 0x80;
464 case ADBMOUSE_MICROSPEED:
465 data[1] = (data[1] & 0x7f) | ((data[3] & 0x01) << 7);
466 data[2] = (data[2] & 0x7f) | ((data[3] & 0x02) << 6);
467 data[3] = (data[3] & 0x77) | ((data[3] & 0x04) << 5)
470 case ADBMOUSE_TRACKBALLPRO:
471 data[1] = (data[1] & 0x7f) | (((data[3] & 0x04) << 5)
472 & ((data[3] & 0x08) << 4));
473 data[2] = (data[2] & 0x7f) | ((data[3] & 0x01) << 7);
474 data[3] = (data[3] & 0x77) | ((data[3] & 0x02) << 6);
477 data[1] = (data[1] & 0x7f) | ((data[3] & 0x01) << 7);
478 data[2] = (data[2] & 0x7f) | ((data[3] & 0x02) << 6);
479 data[3] = ((data[3] & 0x04) << 5);
481 case ADBMOUSE_MACALLY2:
482 data[3] = (data[2] & 0x80) ? 0x80 : 0x00;
483 data[2] |= 0x80; /* Right button is mapped as button 3 */
488 input_report_key(adbhid[id]->input, BTN_LEFT, !((data[1] >> 7) & 1));
489 input_report_key(adbhid[id]->input, BTN_MIDDLE, !((data[2] >> 7) & 1));
491 if (nb >= 4 && adbhid[id]->mouse_kind != ADBMOUSE_TRACKPAD)
492 input_report_key(adbhid[id]->input, BTN_RIGHT, !((data[3] >> 7) & 1));
494 input_report_rel(adbhid[id]->input, REL_X,
495 ((data[2]&0x7f) < 64 ? (data[2]&0x7f) : (data[2]&0x7f)-128 ));
496 input_report_rel(adbhid[id]->input, REL_Y,
497 ((data[1]&0x7f) < 64 ? (data[1]&0x7f) : (data[1]&0x7f)-128 ));
499 input_sync(adbhid[id]->input);
503 adbhid_buttons_input(unsigned char *data, int nb, int autopoll)
505 int id = (data[0] >> 4) & 0x0f;
508 pr_err("ADB HID on ID %d not yet registered\n", id);
512 switch (adbhid[id]->original_handler_id) {
514 case 0x02: /* Adjustable keyboard button device */
516 int down = (data[1] == (data[1] & 0xf));
518 switch (data[1] & 0x0f) {
519 case 0x0: /* microphone */
520 input_report_key(adbhid[id]->input, KEY_SOUND, down);
524 input_report_key(adbhid[id]->input, KEY_MUTE, down);
527 case 0x2: /* volume decrease */
528 input_report_key(adbhid[id]->input, KEY_VOLUMEDOWN, down);
531 case 0x3: /* volume increase */
532 input_report_key(adbhid[id]->input, KEY_VOLUMEUP, down);
536 pr_info("Unhandled ADB_MISC event %02x, %02x, %02x, %02x\n",
537 data[0], data[1], data[2], data[3]);
543 case 0x1f: /* Powerbook button device */
545 int down = (data[1] == (data[1] & 0xf));
548 * XXX: Where is the contrast control for the passive?
552 switch (data[1] & 0x0f) {
554 input_report_key(adbhid[id]->input, KEY_MUTE, down);
557 case 0x7: /* volume decrease */
558 input_report_key(adbhid[id]->input, KEY_VOLUMEDOWN, down);
561 case 0x6: /* volume increase */
562 input_report_key(adbhid[id]->input, KEY_VOLUMEUP, down);
565 case 0xb: /* eject */
566 input_report_key(adbhid[id]->input, KEY_EJECTCD, down);
569 case 0xa: /* brightness decrease */
570 #ifdef CONFIG_PMAC_BACKLIGHT
572 pmac_backlight_key_down();
574 input_report_key(adbhid[id]->input, KEY_BRIGHTNESSDOWN, down);
577 case 0x9: /* brightness increase */
578 #ifdef CONFIG_PMAC_BACKLIGHT
580 pmac_backlight_key_up();
582 input_report_key(adbhid[id]->input, KEY_BRIGHTNESSUP, down);
585 case 0xc: /* videomode switch */
586 input_report_key(adbhid[id]->input, KEY_SWITCHVIDEOMODE, down);
589 case 0xd: /* keyboard illumination toggle */
590 input_report_key(adbhid[id]->input, KEY_KBDILLUMTOGGLE, down);
593 case 0xe: /* keyboard illumination decrease */
594 input_report_key(adbhid[id]->input, KEY_KBDILLUMDOWN, down);
601 /* keyboard illumination increase */
602 input_report_key(adbhid[id]->input, KEY_KBDILLUMUP, down);
607 /* keypad overlay toogle */
611 pr_info("Unhandled ADB_MISC event %02x, %02x, %02x, %02x\n",
612 data[0], data[1], data[2], data[3]);
617 pr_info("Unhandled ADB_MISC event %02x, %02x, %02x, %02x\n",
618 data[0], data[1], data[2], data[3]);
625 input_sync(adbhid[id]->input);
628 static struct adb_request led_request;
629 static int leds_pending[16];
630 static int leds_req_pending;
631 static int pending_devs[16];
632 static int pending_led_start;
633 static int pending_led_end;
634 static DEFINE_SPINLOCK(leds_lock);
636 static void leds_done(struct adb_request *req)
638 int leds = 0, device = 0, pending = 0;
641 spin_lock_irqsave(&leds_lock, flags);
643 if (pending_led_start != pending_led_end) {
644 device = pending_devs[pending_led_start];
645 leds = leds_pending[device] & 0xff;
646 leds_pending[device] = 0;
648 pending_led_start = (pending_led_start < 16) ? pending_led_start : 0;
649 pending = leds_req_pending;
651 leds_req_pending = 0;
652 spin_unlock_irqrestore(&leds_lock, flags);
654 adb_request(&led_request, leds_done, 0, 3,
655 ADB_WRITEREG(device, KEYB_LEDREG), 0xff, ~leds);
658 static void real_leds(unsigned char leds, int device)
662 spin_lock_irqsave(&leds_lock, flags);
663 if (!leds_req_pending) {
664 leds_req_pending = 1;
665 spin_unlock_irqrestore(&leds_lock, flags);
666 adb_request(&led_request, leds_done, 0, 3,
667 ADB_WRITEREG(device, KEYB_LEDREG), 0xff, ~leds);
670 if (!(leds_pending[device] & 0x100)) {
671 pending_devs[pending_led_end] = device;
673 pending_led_end = (pending_led_end < 16) ? pending_led_end : 0;
675 leds_pending[device] = leds | 0x100;
677 spin_unlock_irqrestore(&leds_lock, flags);
681 * Event callback from the input module. Events that change the state of
682 * the hardware are processed here.
684 static int adbhid_kbd_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
686 struct adbhid *adbhid = input_get_drvdata(dev);
691 leds = (test_bit(LED_SCROLLL, dev->led) ? 4 : 0) |
692 (test_bit(LED_NUML, dev->led) ? 1 : 0) |
693 (test_bit(LED_CAPSL, dev->led) ? 2 : 0);
694 real_leds(leds, adbhid->id);
702 adbhid_kbd_capslock_remember(void)
707 for (i = 1; i < 16; i++) {
710 if (ahid && ahid->id == ADB_KEYBOARD)
711 if (ahid->flags & FLAG_CAPSLOCK_TRANSLATE)
712 ahid->flags |= FLAG_CAPSLOCK_IGNORE_NEXT;
717 adb_message_handler(struct notifier_block *this, unsigned long code, void *x)
720 case ADB_MSG_PRE_RESET:
721 case ADB_MSG_POWERDOWN:
722 /* Stop the repeat timer. Autopoll is already off at this point */
725 for (i = 1; i < 16; i++) {
727 del_timer_sync(&adbhid[i]->input->timer);
731 /* Stop pending led requests */
732 while (leds_req_pending)
735 /* After resume, and if the capslock LED is on, the PMU will
736 * send a "capslock down" key event. This confuses the
737 * restore_capslock_events logic. Remember if the capslock
738 * LED was on before suspend so the unwanted key event can
739 * be ignored after resume. */
740 if (restore_capslock_events)
741 adbhid_kbd_capslock_remember();
745 case ADB_MSG_POST_RESET:
753 adbhid_input_register(int id, int default_id, int original_handler_id,
754 int current_handler_id, int mouse_kind)
757 struct input_dev *input_dev;
763 pr_err("Trying to reregister ADB HID on ID %d\n", id);
767 adbhid[id] = hid = kzalloc(sizeof(struct adbhid), GFP_KERNEL);
768 input_dev = input_allocate_device();
769 if (!hid || !input_dev) {
774 sprintf(hid->phys, "adb%d:%d.%02x/input", id, default_id, original_handler_id);
776 hid->input = input_dev;
777 hid->id = default_id;
778 hid->original_handler_id = original_handler_id;
779 hid->current_handler_id = current_handler_id;
780 hid->mouse_kind = mouse_kind;
782 input_set_drvdata(input_dev, hid);
783 input_dev->name = hid->name;
784 input_dev->phys = hid->phys;
785 input_dev->id.bustype = BUS_ADB;
786 input_dev->id.vendor = 0x0001;
787 input_dev->id.product = (id << 12) | (default_id << 8) | original_handler_id;
788 input_dev->id.version = 0x0100;
790 switch (default_id) {
792 hid->keycode = kmalloc(sizeof(adb_to_linux_keycodes), GFP_KERNEL);
798 sprintf(hid->name, "ADB keyboard");
800 memcpy(hid->keycode, adb_to_linux_keycodes, sizeof(adb_to_linux_keycodes));
802 switch (original_handler_id) {
804 keyboard_type = "<unknown>";
805 input_dev->id.version = ADB_KEYBOARD_UNKNOWN;
808 case 0x01: case 0x02: case 0x03: case 0x06: case 0x08:
809 case 0x0C: case 0x10: case 0x18: case 0x1B: case 0x1C:
810 case 0xC0: case 0xC3: case 0xC6:
811 keyboard_type = "ANSI";
812 input_dev->id.version = ADB_KEYBOARD_ANSI;
815 case 0x04: case 0x05: case 0x07: case 0x09: case 0x0D:
816 case 0x11: case 0x14: case 0x19: case 0x1D: case 0xC1:
817 case 0xC4: case 0xC7:
818 keyboard_type = "ISO, swapping keys";
819 input_dev->id.version = ADB_KEYBOARD_ISO;
820 i = hid->keycode[10];
821 hid->keycode[10] = hid->keycode[50];
822 hid->keycode[50] = i;
825 case 0x12: case 0x15: case 0x16: case 0x17: case 0x1A:
826 case 0x1E: case 0xC2: case 0xC5: case 0xC8: case 0xC9:
827 keyboard_type = "JIS";
828 input_dev->id.version = ADB_KEYBOARD_JIS;
831 pr_info("Detected ADB keyboard, type %s.\n", keyboard_type);
833 for (i = 0; i < 128; i++)
835 set_bit(hid->keycode[i], input_dev->keybit);
837 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_LED) |
839 input_dev->ledbit[0] = BIT_MASK(LED_SCROLLL) |
840 BIT_MASK(LED_CAPSL) | BIT_MASK(LED_NUML);
841 input_dev->event = adbhid_kbd_event;
842 input_dev->keycodemax = KEY_FN;
843 input_dev->keycodesize = sizeof(hid->keycode[0]);
847 sprintf(hid->name, "ADB mouse");
849 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
850 input_dev->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |
851 BIT_MASK(BTN_MIDDLE) | BIT_MASK(BTN_RIGHT);
852 input_dev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
856 switch (original_handler_id) {
857 case 0x02: /* Adjustable keyboard button device */
858 sprintf(hid->name, "ADB adjustable keyboard buttons");
859 input_dev->evbit[0] = BIT_MASK(EV_KEY) |
861 set_bit(KEY_SOUND, input_dev->keybit);
862 set_bit(KEY_MUTE, input_dev->keybit);
863 set_bit(KEY_VOLUMEUP, input_dev->keybit);
864 set_bit(KEY_VOLUMEDOWN, input_dev->keybit);
866 case 0x1f: /* Powerbook button device */
867 sprintf(hid->name, "ADB Powerbook buttons");
868 input_dev->evbit[0] = BIT_MASK(EV_KEY) |
870 set_bit(KEY_MUTE, input_dev->keybit);
871 set_bit(KEY_VOLUMEUP, input_dev->keybit);
872 set_bit(KEY_VOLUMEDOWN, input_dev->keybit);
873 set_bit(KEY_BRIGHTNESSUP, input_dev->keybit);
874 set_bit(KEY_BRIGHTNESSDOWN, input_dev->keybit);
875 set_bit(KEY_EJECTCD, input_dev->keybit);
876 set_bit(KEY_SWITCHVIDEOMODE, input_dev->keybit);
877 set_bit(KEY_KBDILLUMTOGGLE, input_dev->keybit);
878 set_bit(KEY_KBDILLUMDOWN, input_dev->keybit);
879 set_bit(KEY_KBDILLUMUP, input_dev->keybit);
884 /* else fall through */
887 pr_info("Trying to register unknown ADB device to input layer.\n");
892 input_dev->keycode = hid->keycode;
894 err = input_register_device(input_dev);
898 if (default_id == ADB_KEYBOARD) {
899 /* HACK WARNING!! This should go away as soon there is an utility
900 * to control that for event devices.
902 input_dev->rep[REP_DELAY] = 500; /* input layer default: 250 */
903 input_dev->rep[REP_PERIOD] = 66; /* input layer default: 33 */
908 fail: input_free_device(input_dev);
917 static void adbhid_input_unregister(int id)
919 input_unregister_device(adbhid[id]->input);
920 kfree(adbhid[id]->keycode);
927 adbhid_input_reregister(int id, int default_id, int org_handler_id,
928 int cur_handler_id, int mk)
931 if (adbhid[id]->input->id.product !=
932 ((id << 12)|(default_id << 8)|org_handler_id)) {
933 adbhid_input_unregister(id);
934 adbhid_input_register(id, default_id, org_handler_id,
938 adbhid_input_register(id, default_id, org_handler_id,
944 adbhid_input_devcleanup(u16 exist)
948 if (adbhid[i] && !(exist&(1<<i)))
949 adbhid_input_unregister(i);
955 struct adb_request req;
956 int i, default_id, org_handler_id, cur_handler_id;
959 adb_register(ADB_MOUSE, 0, &mouse_ids, adbhid_mouse_input);
960 adb_register(ADB_KEYBOARD, 0, &keyboard_ids, adbhid_keyboard_input);
961 adb_register(ADB_MISC, 0, &buttons_ids, adbhid_buttons_input);
963 for (i = 0; i < keyboard_ids.nids; i++) {
964 int id = keyboard_ids.id[i];
966 adb_get_infos(id, &default_id, &org_handler_id);
968 /* turn off all leds */
969 adb_request(&req, NULL, ADBREQ_SYNC, 3,
970 ADB_WRITEREG(id, KEYB_LEDREG), 0xff, 0xff);
972 /* Enable full feature set of the keyboard
973 ->get it to send separate codes for left and right shift,
974 control, option keys */
975 #if 0 /* handler 5 doesn't send separate codes for R modifiers */
976 if (!adb_try_handler_change(id, 5))
978 adb_try_handler_change(id, 3);
980 adb_get_infos(id, &default_id, &cur_handler_id);
981 printk(KERN_DEBUG "ADB keyboard at %d has handler 0x%X\n",
983 reg |= adbhid_input_reregister(id, default_id, org_handler_id,
987 for (i = 0; i < buttons_ids.nids; i++) {
988 int id = buttons_ids.id[i];
990 adb_get_infos(id, &default_id, &org_handler_id);
991 reg |= adbhid_input_reregister(id, default_id, org_handler_id,
995 /* Try to switch all mice to handler 4, or 2 for three-button
996 mode and full resolution. */
997 for (i = 0; i < mouse_ids.nids; i++) {
998 int id = mouse_ids.id[i];
1000 char *desc = "standard";
1002 adb_get_infos(id, &default_id, &org_handler_id);
1004 if (adb_try_handler_change(id, 4)) {
1005 mouse_kind = ADBMOUSE_EXTENDED;
1007 else if (adb_try_handler_change(id, 0x2F)) {
1008 mouse_kind = ADBMOUSE_MICROSPEED;
1010 else if (adb_try_handler_change(id, 0x42)) {
1011 mouse_kind = ADBMOUSE_TRACKBALLPRO;
1013 else if (adb_try_handler_change(id, 0x66)) {
1014 mouse_kind = ADBMOUSE_MICROSPEED;
1016 else if (adb_try_handler_change(id, 0x5F)) {
1017 mouse_kind = ADBMOUSE_MICROSPEED;
1019 else if (adb_try_handler_change(id, 3)) {
1020 mouse_kind = ADBMOUSE_MS_A3;
1022 else if (adb_try_handler_change(id, 2)) {
1023 mouse_kind = ADBMOUSE_STANDARD_200;
1026 mouse_kind = ADBMOUSE_STANDARD_100;
1029 if ((mouse_kind == ADBMOUSE_TRACKBALLPRO)
1030 || (mouse_kind == ADBMOUSE_MICROSPEED)) {
1031 desc = "Microspeed/MacPoint or compatible";
1032 init_microspeed(id);
1033 } else if (mouse_kind == ADBMOUSE_MS_A3) {
1034 desc = "Mouse Systems A3 Mouse or compatible";
1036 } else if (mouse_kind == ADBMOUSE_EXTENDED) {
1039 * Register 1 is usually used for device
1040 * identification. Here, we try to identify
1041 * a known device and call the appropriate
1044 adb_request(&req, NULL, ADBREQ_SYNC | ADBREQ_REPLY, 1,
1045 ADB_READREG(id, 1));
1047 if ((req.reply_len) &&
1048 (req.reply[1] == 0x9a) && ((req.reply[2] == 0x21)
1049 || (req.reply[2] == 0x20))) {
1050 mouse_kind = ADBMOUSE_TRACKBALL;
1051 desc = "trackman/mouseman";
1054 else if ((req.reply_len >= 4) &&
1055 (req.reply[1] == 0x74) && (req.reply[2] == 0x70) &&
1056 (req.reply[3] == 0x61) && (req.reply[4] == 0x64)) {
1057 mouse_kind = ADBMOUSE_TRACKPAD;
1061 else if ((req.reply_len >= 4) &&
1062 (req.reply[1] == 0x4b) && (req.reply[2] == 0x4d) &&
1063 (req.reply[3] == 0x4c) && (req.reply[4] == 0x31)) {
1064 mouse_kind = ADBMOUSE_TURBOMOUSE5;
1065 desc = "TurboMouse 5";
1066 init_turbomouse(id);
1068 else if ((req.reply_len == 9) &&
1069 (req.reply[1] == 0x4b) && (req.reply[2] == 0x4f) &&
1070 (req.reply[3] == 0x49) && (req.reply[4] == 0x54)) {
1071 if (adb_try_handler_change(id, 0x42)) {
1072 mouse_kind = ADBMOUSE_MACALLY2;
1073 desc = "MacAlly 2-button";
1078 adb_get_infos(id, &default_id, &cur_handler_id);
1079 printk(KERN_DEBUG "ADB mouse (%s) at %d has handler 0x%X\n",
1080 desc, id, cur_handler_id);
1081 reg |= adbhid_input_reregister(id, default_id, org_handler_id,
1082 cur_handler_id, mouse_kind);
1084 adbhid_input_devcleanup(reg);
1088 init_trackpad(int id)
1090 struct adb_request req;
1091 unsigned char r1_buffer[8];
1093 adb_request(&req, NULL, ADBREQ_SYNC | ADBREQ_REPLY, 1,
1095 if (req.reply_len < 8)
1096 pr_err("%s: bad length for reg. 1\n", __func__);
1099 memcpy(r1_buffer, &req.reply[1], 8);
1101 adb_request(&req, NULL, ADBREQ_SYNC, 9,
1112 adb_request(&req, NULL, ADBREQ_SYNC, 9,
1123 adb_request(&req, NULL, ADBREQ_SYNC, 9,
1131 0x03, /*r1_buffer[6],*/
1134 /* Without this flush, the trackpad may be locked up */
1135 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(id));
1140 init_trackball(int id)
1142 struct adb_request req;
1144 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1145 ADB_WRITEREG(id,1), 00,0x81);
1147 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1148 ADB_WRITEREG(id,1), 01,0x81);
1150 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1151 ADB_WRITEREG(id,1), 02,0x81);
1153 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1154 ADB_WRITEREG(id,1), 03,0x38);
1156 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1157 ADB_WRITEREG(id,1), 00,0x81);
1159 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1160 ADB_WRITEREG(id,1), 01,0x81);
1162 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1163 ADB_WRITEREG(id,1), 02,0x81);
1165 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1166 ADB_WRITEREG(id,1), 03,0x38);
1170 init_turbomouse(int id)
1172 struct adb_request req;
1174 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(id));
1176 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(3));
1178 adb_request(&req, NULL, ADBREQ_SYNC, 9,
1189 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(3));
1191 adb_request(&req, NULL, ADBREQ_SYNC, 9,
1204 init_microspeed(int id)
1206 struct adb_request req;
1208 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(id));
1210 /* This will initialize mice using the Microspeed, MacPoint and
1211 other compatible firmware. Bit 12 enables extended protocol.
1213 Register 1 Listen (4 Bytes)
1214 0 - 3 Button is mouse (set also for double clicking!!!)
1215 4 - 7 Button is locking (affects change speed also)
1216 8 - 11 Button changes speed
1217 12 1 = Extended mouse mode, 0 = normal mouse mode
1219 16 - 23 normal speed
1220 24 - 31 changed speed
1222 Register 1 talk holds version and product identification information.
1223 Register 1 Talk (4 Bytes):
1225 8 - 23 undefined, reserved
1226 24 - 31 Version number
1228 Speed 0 is max. 1 to 255 set speed in increments of 1/256 of max.
1230 adb_request(&req, NULL, ADBREQ_SYNC, 5,
1232 0x20, /* alt speed = 0x20 (rather slow) */
1233 0x00, /* norm speed = 0x00 (fastest) */
1234 0x10, /* extended protocol, no speed change */
1235 0x07); /* all buttons enabled as mouse buttons, no locking */
1238 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(id));
1244 struct adb_request req;
1246 adb_request(&req, NULL, ADBREQ_SYNC, 3,
1247 ADB_WRITEREG(id, 0x2),
1251 adb_request(&req, NULL, ADBREQ_SYNC, 1, ADB_FLUSH(id));
1254 static int __init adbhid_init(void)
1257 if (!machine_is(chrp) && !machine_is(powermac))
1261 led_request.complete = 1;
1265 blocking_notifier_chain_register(&adb_client_list,
1266 &adbhid_adb_notifier);
1271 static void __exit adbhid_exit(void)
1275 module_init(adbhid_init);
1276 module_exit(adbhid_exit);