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