2 * USB HID quirks support for Linux
4 * Copyright (c) 1999 Andreas Gal
5 * Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
6 * Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
7 * Copyright (c) 2006-2007 Jiri Kosina
8 * Copyright (c) 2007 Paul Walmsley
9 * Copyright (c) 2008 Jiri Slaby <jirislaby@gmail.com>
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License as published by the Free
15 * Software Foundation; either version 2 of the License, or (at your option)
19 #include <linux/device.h>
20 #include <linux/hid.h>
21 #include <linux/module.h>
22 #include <linux/usb.h>
26 #define APPLE_RDESC_JIS 0x0001
27 #define APPLE_IGNORE_MOUSE 0x0002
28 #define APPLE_HAS_FN 0x0004
29 #define APPLE_HIDDEV 0x0008
30 #define APPLE_ISO_KEYBOARD 0x0010
31 #define APPLE_MIGHTYMOUSE 0x0020
32 #define APPLE_INVERT_HWHEEL 0x0040
33 #define APPLE_IGNORE_HIDINPUT 0x0080
34 #define APPLE_NUMLOCK_EMULATION 0x0100
36 #define APPLE_FLAG_FKEY 0x01
38 static unsigned int fnmode
= 1;
39 module_param(fnmode
, uint
, 0644);
40 MODULE_PARM_DESC(fnmode
, "Mode of fn key on Apple keyboards (0 = disabled, "
41 "[1] = fkeyslast, 2 = fkeysfirst)");
46 DECLARE_BITMAP(pressed_fn
, KEY_CNT
);
47 DECLARE_BITMAP(pressed_numlock
, KEY_CNT
);
50 struct apple_key_translation
{
56 static struct apple_key_translation apple_fn_keys
[] = {
57 { KEY_BACKSPACE
, KEY_DELETE
},
58 { KEY_F1
, KEY_BRIGHTNESSDOWN
, APPLE_FLAG_FKEY
},
59 { KEY_F2
, KEY_BRIGHTNESSUP
, APPLE_FLAG_FKEY
},
60 { KEY_F3
, KEY_FN_F5
, APPLE_FLAG_FKEY
}, /* Exposé */
61 { KEY_F4
, KEY_FN_F4
, APPLE_FLAG_FKEY
}, /* Dashboard */
62 { KEY_F5
, KEY_KBDILLUMDOWN
, APPLE_FLAG_FKEY
},
63 { KEY_F6
, KEY_KBDILLUMUP
, APPLE_FLAG_FKEY
},
64 { KEY_F7
, KEY_PREVIOUSSONG
, APPLE_FLAG_FKEY
},
65 { KEY_F8
, KEY_PLAYPAUSE
, APPLE_FLAG_FKEY
},
66 { KEY_F9
, KEY_NEXTSONG
, APPLE_FLAG_FKEY
},
67 { KEY_F10
, KEY_MUTE
, APPLE_FLAG_FKEY
},
68 { KEY_F11
, KEY_VOLUMEDOWN
, APPLE_FLAG_FKEY
},
69 { KEY_F12
, KEY_VOLUMEUP
, APPLE_FLAG_FKEY
},
70 { KEY_UP
, KEY_PAGEUP
},
71 { KEY_DOWN
, KEY_PAGEDOWN
},
72 { KEY_LEFT
, KEY_HOME
},
73 { KEY_RIGHT
, KEY_END
},
77 static struct apple_key_translation powerbook_fn_keys
[] = {
78 { KEY_BACKSPACE
, KEY_DELETE
},
79 { KEY_F1
, KEY_BRIGHTNESSDOWN
, APPLE_FLAG_FKEY
},
80 { KEY_F2
, KEY_BRIGHTNESSUP
, APPLE_FLAG_FKEY
},
81 { KEY_F3
, KEY_MUTE
, APPLE_FLAG_FKEY
},
82 { KEY_F4
, KEY_VOLUMEDOWN
, APPLE_FLAG_FKEY
},
83 { KEY_F5
, KEY_VOLUMEUP
, APPLE_FLAG_FKEY
},
84 { KEY_F6
, KEY_NUMLOCK
, APPLE_FLAG_FKEY
},
85 { KEY_F7
, KEY_SWITCHVIDEOMODE
, APPLE_FLAG_FKEY
},
86 { KEY_F8
, KEY_KBDILLUMTOGGLE
, APPLE_FLAG_FKEY
},
87 { KEY_F9
, KEY_KBDILLUMDOWN
, APPLE_FLAG_FKEY
},
88 { KEY_F10
, KEY_KBDILLUMUP
, APPLE_FLAG_FKEY
},
89 { KEY_UP
, KEY_PAGEUP
},
90 { KEY_DOWN
, KEY_PAGEDOWN
},
91 { KEY_LEFT
, KEY_HOME
},
92 { KEY_RIGHT
, KEY_END
},
96 static struct apple_key_translation powerbook_numlock_keys
[] = {
107 { KEY_DOT
, KEY_KPDOT
},
108 { KEY_SLASH
, KEY_KPPLUS
},
109 { KEY_SEMICOLON
, KEY_KPMINUS
},
110 { KEY_P
, KEY_KPASTERISK
},
111 { KEY_MINUS
, KEY_KPEQUAL
},
112 { KEY_0
, KEY_KPSLASH
},
113 { KEY_F6
, KEY_NUMLOCK
},
114 { KEY_KPENTER
, KEY_KPENTER
},
115 { KEY_BACKSPACE
, KEY_BACKSPACE
},
119 static struct apple_key_translation apple_iso_keyboard
[] = {
120 { KEY_GRAVE
, KEY_102ND
},
121 { KEY_102ND
, KEY_GRAVE
},
125 static struct apple_key_translation
*apple_find_translation(
126 struct apple_key_translation
*table
, u16 from
)
128 struct apple_key_translation
*trans
;
130 /* Look for the translation */
131 for (trans
= table
; trans
->from
; trans
++)
132 if (trans
->from
== from
)
138 static int hidinput_apple_event(struct hid_device
*hid
, struct input_dev
*input
,
139 struct hid_usage
*usage
, __s32 value
)
141 struct apple_sc
*asc
= hid_get_drvdata(hid
);
142 struct apple_key_translation
*trans
;
144 if (usage
->code
== KEY_FN
) {
145 asc
->fn_on
= !!value
;
146 input_event(input
, usage
->type
, usage
->code
, value
);
153 trans
= apple_find_translation((hid
->product
< 0x220 ||
154 hid
->product
>= 0x300) ?
155 powerbook_fn_keys
: apple_fn_keys
,
158 if (test_bit(usage
->code
, asc
->pressed_fn
))
160 else if (trans
->flags
& APPLE_FLAG_FKEY
)
161 do_translate
= (fnmode
== 2 && asc
->fn_on
) ||
162 (fnmode
== 1 && !asc
->fn_on
);
164 do_translate
= asc
->fn_on
;
168 set_bit(usage
->code
, asc
->pressed_fn
);
170 clear_bit(usage
->code
, asc
->pressed_fn
);
172 input_event(input
, usage
->type
, trans
->to
,
179 if (asc
->quirks
& APPLE_NUMLOCK_EMULATION
&&
180 (test_bit(usage
->code
, asc
->pressed_numlock
) ||
181 test_bit(LED_NUML
, input
->led
))) {
182 trans
= apple_find_translation(powerbook_numlock_keys
,
188 asc
->pressed_numlock
);
190 clear_bit(usage
->code
,
191 asc
->pressed_numlock
);
193 input_event(input
, usage
->type
, trans
->to
,
201 if (asc
->quirks
& APPLE_ISO_KEYBOARD
) {
202 trans
= apple_find_translation(apple_iso_keyboard
, usage
->code
);
204 input_event(input
, usage
->type
, trans
->to
, value
);
212 static int apple_event(struct hid_device
*hdev
, struct hid_field
*field
,
213 struct hid_usage
*usage
, __s32 value
)
215 struct apple_sc
*asc
= hid_get_drvdata(hdev
);
217 if (!(hdev
->claimed
& HID_CLAIMED_INPUT
) || !field
->hidinput
||
221 if ((asc
->quirks
& APPLE_INVERT_HWHEEL
) &&
222 usage
->code
== REL_HWHEEL
) {
223 input_event(field
->hidinput
->input
, usage
->type
, usage
->code
,
228 if ((asc
->quirks
& APPLE_HAS_FN
) &&
229 hidinput_apple_event(hdev
, field
->hidinput
->input
,
238 * MacBook JIS keyboard has wrong logical maximum
240 static void apple_report_fixup(struct hid_device
*hdev
, __u8
*rdesc
,
243 struct apple_sc
*asc
= hid_get_drvdata(hdev
);
245 if ((asc
->quirks
& APPLE_RDESC_JIS
) && rsize
>= 60 &&
246 rdesc
[53] == 0x65 && rdesc
[59] == 0x65) {
247 dev_info(&hdev
->dev
, "fixing up MacBook JIS keyboard report "
249 rdesc
[53] = rdesc
[59] = 0xe7;
253 static void apple_setup_input(struct input_dev
*input
)
255 struct apple_key_translation
*trans
;
257 set_bit(KEY_NUMLOCK
, input
->keybit
);
259 /* Enable all needed keys */
260 for (trans
= apple_fn_keys
; trans
->from
; trans
++)
261 set_bit(trans
->to
, input
->keybit
);
263 for (trans
= powerbook_fn_keys
; trans
->from
; trans
++)
264 set_bit(trans
->to
, input
->keybit
);
266 for (trans
= powerbook_numlock_keys
; trans
->from
; trans
++)
267 set_bit(trans
->to
, input
->keybit
);
269 for (trans
= apple_iso_keyboard
; trans
->from
; trans
++)
270 set_bit(trans
->to
, input
->keybit
);
273 static int apple_input_mapping(struct hid_device
*hdev
, struct hid_input
*hi
,
274 struct hid_field
*field
, struct hid_usage
*usage
,
275 unsigned long **bit
, int *max
)
277 if (usage
->hid
== (HID_UP_CUSTOM
| 0x0003)) {
278 /* The fn key on Apple USB keyboards */
279 set_bit(EV_REP
, hi
->input
->evbit
);
280 hid_map_usage_clear(hi
, usage
, bit
, max
, EV_KEY
, KEY_FN
);
281 apple_setup_input(hi
->input
);
285 /* we want the hid layer to go through standard path (set and ignore) */
289 static int apple_input_mapped(struct hid_device
*hdev
, struct hid_input
*hi
,
290 struct hid_field
*field
, struct hid_usage
*usage
,
291 unsigned long **bit
, int *max
)
293 struct apple_sc
*asc
= hid_get_drvdata(hdev
);
295 if (asc
->quirks
& APPLE_MIGHTYMOUSE
) {
296 if (usage
->hid
== HID_GD_Z
)
297 hid_map_usage(hi
, usage
, bit
, max
, EV_REL
, REL_HWHEEL
);
298 else if (usage
->code
== BTN_1
)
299 hid_map_usage(hi
, usage
, bit
, max
, EV_KEY
, BTN_2
);
300 else if (usage
->code
== BTN_2
)
301 hid_map_usage(hi
, usage
, bit
, max
, EV_KEY
, BTN_1
);
307 static int apple_probe(struct hid_device
*hdev
,
308 const struct hid_device_id
*id
)
310 unsigned long quirks
= id
->driver_data
;
311 struct apple_sc
*asc
;
312 unsigned int connect_mask
= HID_CONNECT_DEFAULT
;
315 /* return something else or move to hid layer? device will reside
317 if (id
->bus
== BUS_USB
&& (quirks
& APPLE_IGNORE_MOUSE
) &&
318 to_usb_interface(hdev
->dev
.parent
)->cur_altsetting
->
319 desc
.bInterfaceProtocol
== USB_INTERFACE_PROTOCOL_MOUSE
)
322 asc
= kzalloc(sizeof(*asc
), GFP_KERNEL
);
324 dev_err(&hdev
->dev
, "can't alloc apple descriptor\n");
328 asc
->quirks
= quirks
;
330 hid_set_drvdata(hdev
, asc
);
332 ret
= hid_parse(hdev
);
334 dev_err(&hdev
->dev
, "parse failed\n");
338 if (quirks
& APPLE_HIDDEV
)
339 connect_mask
|= HID_CONNECT_HIDDEV_FORCE
;
340 if (quirks
& APPLE_IGNORE_HIDINPUT
)
341 connect_mask
&= ~HID_CONNECT_HIDINPUT
;
343 ret
= hid_hw_start(hdev
, connect_mask
);
345 dev_err(&hdev
->dev
, "hw start failed\n");
355 static void apple_remove(struct hid_device
*hdev
)
358 kfree(hid_get_drvdata(hdev
));
361 static const struct hid_device_id apple_devices
[] = {
362 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_ATV_IRCONTROL
),
363 .driver_data
= APPLE_HIDDEV
| APPLE_IGNORE_HIDINPUT
},
364 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_IRCONTROL4
),
365 .driver_data
= APPLE_HIDDEV
| APPLE_IGNORE_HIDINPUT
},
366 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_MIGHTYMOUSE
),
367 .driver_data
= APPLE_MIGHTYMOUSE
| APPLE_INVERT_HWHEEL
},
369 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI
),
370 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
371 APPLE_IGNORE_MOUSE
},
372 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO
),
373 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
374 APPLE_IGNORE_MOUSE
},
375 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER_ANSI
),
376 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
377 APPLE_IGNORE_MOUSE
},
378 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER_ISO
),
379 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
380 APPLE_IGNORE_MOUSE
| APPLE_ISO_KEYBOARD
},
381 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER_JIS
),
382 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
383 APPLE_IGNORE_MOUSE
},
384 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER3_ANSI
),
385 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
386 APPLE_IGNORE_MOUSE
},
387 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER3_ISO
),
388 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
389 APPLE_IGNORE_MOUSE
| APPLE_ISO_KEYBOARD
},
390 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER3_JIS
),
391 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
392 APPLE_IGNORE_MOUSE
| APPLE_RDESC_JIS
},
393 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER4_ANSI
),
394 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
395 APPLE_IGNORE_MOUSE
},
396 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER4_ISO
),
397 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
398 APPLE_IGNORE_MOUSE
| APPLE_ISO_KEYBOARD
},
399 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER4_JIS
),
400 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
401 APPLE_IGNORE_MOUSE
| APPLE_RDESC_JIS
},
402 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_ALU_ANSI
),
403 .driver_data
= APPLE_HAS_FN
},
404 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_ALU_ISO
),
405 .driver_data
= APPLE_HAS_FN
| APPLE_ISO_KEYBOARD
},
406 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_ALU_JIS
),
407 .driver_data
= APPLE_HAS_FN
},
408 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI
),
409 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
410 APPLE_IGNORE_MOUSE
},
411 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO
),
412 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
413 APPLE_IGNORE_MOUSE
},
414 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS
),
415 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
416 APPLE_IGNORE_MOUSE
| APPLE_RDESC_JIS
},
417 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI
),
418 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
},
419 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO
),
420 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
421 APPLE_ISO_KEYBOARD
},
422 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS
),
423 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
},
424 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI
),
425 .driver_data
= APPLE_HAS_FN
| APPLE_IGNORE_MOUSE
},
426 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_WELLSPRING_ISO
),
427 .driver_data
= APPLE_HAS_FN
| APPLE_ISO_KEYBOARD
|
428 APPLE_IGNORE_MOUSE
},
429 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_WELLSPRING_JIS
),
430 .driver_data
= APPLE_HAS_FN
| APPLE_IGNORE_MOUSE
| APPLE_RDESC_JIS
},
431 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI
),
432 .driver_data
= APPLE_HAS_FN
| APPLE_IGNORE_MOUSE
},
433 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO
),
434 .driver_data
= APPLE_HAS_FN
| APPLE_ISO_KEYBOARD
|
435 APPLE_IGNORE_MOUSE
},
436 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS
),
437 .driver_data
= APPLE_HAS_FN
| APPLE_IGNORE_MOUSE
| APPLE_RDESC_JIS
},
438 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY
),
439 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
440 APPLE_IGNORE_MOUSE
},
441 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE
, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY
),
442 .driver_data
= APPLE_NUMLOCK_EMULATION
| APPLE_HAS_FN
|
443 APPLE_IGNORE_MOUSE
},
445 /* Apple wireless Mighty Mouse */
446 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE
, 0x030c),
447 .driver_data
= APPLE_MIGHTYMOUSE
| APPLE_INVERT_HWHEEL
},
451 MODULE_DEVICE_TABLE(hid
, apple_devices
);
453 static struct hid_driver apple_driver
= {
455 .id_table
= apple_devices
,
456 .report_fixup
= apple_report_fixup
,
457 .probe
= apple_probe
,
458 .remove
= apple_remove
,
459 .event
= apple_event
,
460 .input_mapping
= apple_input_mapping
,
461 .input_mapped
= apple_input_mapped
,
464 static int apple_init(void)
468 ret
= hid_register_driver(&apple_driver
);
470 printk(KERN_ERR
"can't register apple driver\n");
475 static void apple_exit(void)
477 hid_unregister_driver(&apple_driver
);
480 module_init(apple_init
);
481 module_exit(apple_exit
);
482 MODULE_LICENSE("GPL");
484 HID_COMPAT_LOAD_DRIVER(apple
);