Loading...
1/*
2 * USB HID quirks support for Linux
3 *
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) 2008 Jiri Slaby <jirislaby@gmail.com>
9 */
10
11/*
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 2 of the License, or (at your option)
15 * any later version.
16 */
17
18#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19
20#include <linux/device.h>
21#include <linux/hid.h>
22#include <linux/module.h>
23#include <linux/slab.h>
24
25#include "hid-ids.h"
26
27#define APPLE_RDESC_JIS 0x0001
28#define APPLE_IGNORE_MOUSE 0x0002
29#define APPLE_HAS_FN 0x0004
30#define APPLE_HIDDEV 0x0008
31#define APPLE_ISO_KEYBOARD 0x0010
32#define APPLE_MIGHTYMOUSE 0x0020
33#define APPLE_INVERT_HWHEEL 0x0040
34#define APPLE_IGNORE_HIDINPUT 0x0080
35#define APPLE_NUMLOCK_EMULATION 0x0100
36
37#define APPLE_FLAG_FKEY 0x01
38
39static unsigned int fnmode = 1;
40module_param(fnmode, uint, 0644);
41MODULE_PARM_DESC(fnmode, "Mode of fn key on Apple keyboards (0 = disabled, "
42 "[1] = fkeyslast, 2 = fkeysfirst)");
43
44static unsigned int iso_layout = 1;
45module_param(iso_layout, uint, 0644);
46MODULE_PARM_DESC(iso_layout, "Enable/Disable hardcoded ISO-layout of the keyboard. "
47 "(0 = disabled, [1] = enabled)");
48
49static unsigned int swap_opt_cmd;
50module_param(swap_opt_cmd, uint, 0644);
51MODULE_PARM_DESC(swap_opt_cmd, "Swap the Option (\"Alt\") and Command (\"Flag\") keys. "
52 "(For people who want to keep Windows PC keyboard muscle memory. "
53 "[0] = as-is, Mac layout. 1 = swapped, Windows layout.)");
54
55struct apple_sc {
56 unsigned long quirks;
57 unsigned int fn_on;
58 DECLARE_BITMAP(pressed_fn, KEY_CNT);
59 DECLARE_BITMAP(pressed_numlock, KEY_CNT);
60};
61
62struct apple_key_translation {
63 u16 from;
64 u16 to;
65 u8 flags;
66};
67
68static const struct apple_key_translation macbookair_fn_keys[] = {
69 { KEY_BACKSPACE, KEY_DELETE },
70 { KEY_ENTER, KEY_INSERT },
71 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
72 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
73 { KEY_F3, KEY_SCALE, APPLE_FLAG_FKEY },
74 { KEY_F4, KEY_DASHBOARD, APPLE_FLAG_FKEY },
75 { KEY_F6, KEY_PREVIOUSSONG, APPLE_FLAG_FKEY },
76 { KEY_F7, KEY_PLAYPAUSE, APPLE_FLAG_FKEY },
77 { KEY_F8, KEY_NEXTSONG, APPLE_FLAG_FKEY },
78 { KEY_F9, KEY_MUTE, APPLE_FLAG_FKEY },
79 { KEY_F10, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
80 { KEY_F11, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
81 { KEY_F12, KEY_EJECTCD, APPLE_FLAG_FKEY },
82 { KEY_UP, KEY_PAGEUP },
83 { KEY_DOWN, KEY_PAGEDOWN },
84 { KEY_LEFT, KEY_HOME },
85 { KEY_RIGHT, KEY_END },
86 { }
87};
88
89static const struct apple_key_translation apple_fn_keys[] = {
90 { KEY_BACKSPACE, KEY_DELETE },
91 { KEY_ENTER, KEY_INSERT },
92 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
93 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
94 { KEY_F3, KEY_SCALE, APPLE_FLAG_FKEY },
95 { KEY_F4, KEY_DASHBOARD, APPLE_FLAG_FKEY },
96 { KEY_F5, KEY_KBDILLUMDOWN, APPLE_FLAG_FKEY },
97 { KEY_F6, KEY_KBDILLUMUP, APPLE_FLAG_FKEY },
98 { KEY_F7, KEY_PREVIOUSSONG, APPLE_FLAG_FKEY },
99 { KEY_F8, KEY_PLAYPAUSE, APPLE_FLAG_FKEY },
100 { KEY_F9, KEY_NEXTSONG, APPLE_FLAG_FKEY },
101 { KEY_F10, KEY_MUTE, APPLE_FLAG_FKEY },
102 { KEY_F11, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
103 { KEY_F12, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
104 { KEY_UP, KEY_PAGEUP },
105 { KEY_DOWN, KEY_PAGEDOWN },
106 { KEY_LEFT, KEY_HOME },
107 { KEY_RIGHT, KEY_END },
108 { }
109};
110
111static const struct apple_key_translation powerbook_fn_keys[] = {
112 { KEY_BACKSPACE, KEY_DELETE },
113 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
114 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
115 { KEY_F3, KEY_MUTE, APPLE_FLAG_FKEY },
116 { KEY_F4, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
117 { KEY_F5, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
118 { KEY_F6, KEY_NUMLOCK, APPLE_FLAG_FKEY },
119 { KEY_F7, KEY_SWITCHVIDEOMODE, APPLE_FLAG_FKEY },
120 { KEY_F8, KEY_KBDILLUMTOGGLE, APPLE_FLAG_FKEY },
121 { KEY_F9, KEY_KBDILLUMDOWN, APPLE_FLAG_FKEY },
122 { KEY_F10, KEY_KBDILLUMUP, APPLE_FLAG_FKEY },
123 { KEY_UP, KEY_PAGEUP },
124 { KEY_DOWN, KEY_PAGEDOWN },
125 { KEY_LEFT, KEY_HOME },
126 { KEY_RIGHT, KEY_END },
127 { }
128};
129
130static const struct apple_key_translation powerbook_numlock_keys[] = {
131 { KEY_J, KEY_KP1 },
132 { KEY_K, KEY_KP2 },
133 { KEY_L, KEY_KP3 },
134 { KEY_U, KEY_KP4 },
135 { KEY_I, KEY_KP5 },
136 { KEY_O, KEY_KP6 },
137 { KEY_7, KEY_KP7 },
138 { KEY_8, KEY_KP8 },
139 { KEY_9, KEY_KP9 },
140 { KEY_M, KEY_KP0 },
141 { KEY_DOT, KEY_KPDOT },
142 { KEY_SLASH, KEY_KPPLUS },
143 { KEY_SEMICOLON, KEY_KPMINUS },
144 { KEY_P, KEY_KPASTERISK },
145 { KEY_MINUS, KEY_KPEQUAL },
146 { KEY_0, KEY_KPSLASH },
147 { KEY_F6, KEY_NUMLOCK },
148 { KEY_KPENTER, KEY_KPENTER },
149 { KEY_BACKSPACE, KEY_BACKSPACE },
150 { }
151};
152
153static const struct apple_key_translation apple_iso_keyboard[] = {
154 { KEY_GRAVE, KEY_102ND },
155 { KEY_102ND, KEY_GRAVE },
156 { }
157};
158
159static const struct apple_key_translation swapped_option_cmd_keys[] = {
160 { KEY_LEFTALT, KEY_LEFTMETA },
161 { KEY_LEFTMETA, KEY_LEFTALT },
162 { KEY_RIGHTALT, KEY_RIGHTMETA },
163 { KEY_RIGHTMETA,KEY_RIGHTALT },
164 { }
165};
166
167static const struct apple_key_translation *apple_find_translation(
168 const struct apple_key_translation *table, u16 from)
169{
170 const struct apple_key_translation *trans;
171
172 /* Look for the translation */
173 for (trans = table; trans->from; trans++)
174 if (trans->from == from)
175 return trans;
176
177 return NULL;
178}
179
180static int hidinput_apple_event(struct hid_device *hid, struct input_dev *input,
181 struct hid_usage *usage, __s32 value)
182{
183 struct apple_sc *asc = hid_get_drvdata(hid);
184 const struct apple_key_translation *trans, *table;
185
186 if (usage->code == KEY_FN) {
187 asc->fn_on = !!value;
188 input_event(input, usage->type, usage->code, value);
189 return 1;
190 }
191
192 if (fnmode) {
193 int do_translate;
194
195 if (hid->product >= USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI &&
196 hid->product <= USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS)
197 table = macbookair_fn_keys;
198 else if (hid->product < 0x21d || hid->product >= 0x300)
199 table = powerbook_fn_keys;
200 else
201 table = apple_fn_keys;
202
203 trans = apple_find_translation (table, usage->code);
204
205 if (trans) {
206 if (test_bit(usage->code, asc->pressed_fn))
207 do_translate = 1;
208 else if (trans->flags & APPLE_FLAG_FKEY)
209 do_translate = (fnmode == 2 && asc->fn_on) ||
210 (fnmode == 1 && !asc->fn_on);
211 else
212 do_translate = asc->fn_on;
213
214 if (do_translate) {
215 if (value)
216 set_bit(usage->code, asc->pressed_fn);
217 else
218 clear_bit(usage->code, asc->pressed_fn);
219
220 input_event(input, usage->type, trans->to,
221 value);
222
223 return 1;
224 }
225 }
226
227 if (asc->quirks & APPLE_NUMLOCK_EMULATION &&
228 (test_bit(usage->code, asc->pressed_numlock) ||
229 test_bit(LED_NUML, input->led))) {
230 trans = apple_find_translation(powerbook_numlock_keys,
231 usage->code);
232
233 if (trans) {
234 if (value)
235 set_bit(usage->code,
236 asc->pressed_numlock);
237 else
238 clear_bit(usage->code,
239 asc->pressed_numlock);
240
241 input_event(input, usage->type, trans->to,
242 value);
243 }
244
245 return 1;
246 }
247 }
248
249 if (iso_layout) {
250 if (asc->quirks & APPLE_ISO_KEYBOARD) {
251 trans = apple_find_translation(apple_iso_keyboard, usage->code);
252 if (trans) {
253 input_event(input, usage->type, trans->to, value);
254 return 1;
255 }
256 }
257 }
258
259 if (swap_opt_cmd) {
260 trans = apple_find_translation(swapped_option_cmd_keys, usage->code);
261 if (trans) {
262 input_event(input, usage->type, trans->to, value);
263 return 1;
264 }
265 }
266
267 return 0;
268}
269
270static int apple_event(struct hid_device *hdev, struct hid_field *field,
271 struct hid_usage *usage, __s32 value)
272{
273 struct apple_sc *asc = hid_get_drvdata(hdev);
274
275 if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput ||
276 !usage->type)
277 return 0;
278
279 if ((asc->quirks & APPLE_INVERT_HWHEEL) &&
280 usage->code == REL_HWHEEL) {
281 input_event(field->hidinput->input, usage->type, usage->code,
282 -value);
283 return 1;
284 }
285
286 if ((asc->quirks & APPLE_HAS_FN) &&
287 hidinput_apple_event(hdev, field->hidinput->input,
288 usage, value))
289 return 1;
290
291
292 return 0;
293}
294
295/*
296 * MacBook JIS keyboard has wrong logical maximum
297 */
298static __u8 *apple_report_fixup(struct hid_device *hdev, __u8 *rdesc,
299 unsigned int *rsize)
300{
301 struct apple_sc *asc = hid_get_drvdata(hdev);
302
303 if ((asc->quirks & APPLE_RDESC_JIS) && *rsize >= 60 &&
304 rdesc[53] == 0x65 && rdesc[59] == 0x65) {
305 hid_info(hdev,
306 "fixing up MacBook JIS keyboard report descriptor\n");
307 rdesc[53] = rdesc[59] = 0xe7;
308 }
309 return rdesc;
310}
311
312static void apple_setup_input(struct input_dev *input)
313{
314 const struct apple_key_translation *trans;
315
316 set_bit(KEY_NUMLOCK, input->keybit);
317
318 /* Enable all needed keys */
319 for (trans = apple_fn_keys; trans->from; trans++)
320 set_bit(trans->to, input->keybit);
321
322 for (trans = powerbook_fn_keys; trans->from; trans++)
323 set_bit(trans->to, input->keybit);
324
325 for (trans = powerbook_numlock_keys; trans->from; trans++)
326 set_bit(trans->to, input->keybit);
327
328 for (trans = apple_iso_keyboard; trans->from; trans++)
329 set_bit(trans->to, input->keybit);
330}
331
332static int apple_input_mapping(struct hid_device *hdev, struct hid_input *hi,
333 struct hid_field *field, struct hid_usage *usage,
334 unsigned long **bit, int *max)
335{
336 if (usage->hid == (HID_UP_CUSTOM | 0x0003)) {
337 /* The fn key on Apple USB keyboards */
338 set_bit(EV_REP, hi->input->evbit);
339 hid_map_usage_clear(hi, usage, bit, max, EV_KEY, KEY_FN);
340 apple_setup_input(hi->input);
341 return 1;
342 }
343
344 /* we want the hid layer to go through standard path (set and ignore) */
345 return 0;
346}
347
348static int apple_input_mapped(struct hid_device *hdev, struct hid_input *hi,
349 struct hid_field *field, struct hid_usage *usage,
350 unsigned long **bit, int *max)
351{
352 struct apple_sc *asc = hid_get_drvdata(hdev);
353
354 if (asc->quirks & APPLE_MIGHTYMOUSE) {
355 if (usage->hid == HID_GD_Z)
356 hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
357 else if (usage->code == BTN_1)
358 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_2);
359 else if (usage->code == BTN_2)
360 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_1);
361 }
362
363 return 0;
364}
365
366static int apple_probe(struct hid_device *hdev,
367 const struct hid_device_id *id)
368{
369 unsigned long quirks = id->driver_data;
370 struct apple_sc *asc;
371 unsigned int connect_mask = HID_CONNECT_DEFAULT;
372 int ret;
373
374 asc = devm_kzalloc(&hdev->dev, sizeof(*asc), GFP_KERNEL);
375 if (asc == NULL) {
376 hid_err(hdev, "can't alloc apple descriptor\n");
377 return -ENOMEM;
378 }
379
380 asc->quirks = quirks;
381
382 hid_set_drvdata(hdev, asc);
383
384 ret = hid_parse(hdev);
385 if (ret) {
386 hid_err(hdev, "parse failed\n");
387 return ret;
388 }
389
390 if (quirks & APPLE_HIDDEV)
391 connect_mask |= HID_CONNECT_HIDDEV_FORCE;
392 if (quirks & APPLE_IGNORE_HIDINPUT)
393 connect_mask &= ~HID_CONNECT_HIDINPUT;
394
395 ret = hid_hw_start(hdev, connect_mask);
396 if (ret) {
397 hid_err(hdev, "hw start failed\n");
398 return ret;
399 }
400
401 return 0;
402}
403
404static const struct hid_device_id apple_devices[] = {
405 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE),
406 .driver_data = APPLE_MIGHTYMOUSE | APPLE_INVERT_HWHEEL },
407
408 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI),
409 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
410 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO),
411 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
412 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI),
413 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
414 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO),
415 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
416 APPLE_ISO_KEYBOARD },
417 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS),
418 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
419 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI),
420 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
421 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO),
422 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
423 APPLE_ISO_KEYBOARD },
424 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS),
425 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
426 APPLE_RDESC_JIS },
427 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI),
428 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
429 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO),
430 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
431 APPLE_ISO_KEYBOARD },
432 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS),
433 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
434 APPLE_RDESC_JIS },
435 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ANSI),
436 .driver_data = APPLE_HAS_FN },
437 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ISO),
438 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
439 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_JIS),
440 .driver_data = APPLE_HAS_FN },
441 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI),
442 .driver_data = APPLE_HAS_FN },
443 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO),
444 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
445 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS),
446 .driver_data = APPLE_HAS_FN },
447 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI),
448 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
449 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO),
450 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
451 APPLE_ISO_KEYBOARD },
452 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS),
453 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
454 APPLE_RDESC_JIS },
455 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ANSI),
456 .driver_data = APPLE_HAS_FN },
457 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ISO),
458 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
459 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_JIS),
460 .driver_data = APPLE_HAS_FN },
461 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
462 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
463 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO),
464 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
465 APPLE_ISO_KEYBOARD },
466 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
467 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
468 APPLE_ISO_KEYBOARD },
469 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
470 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
471 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
472 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
473 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_JIS),
474 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
475 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS),
476 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
477 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI),
478 .driver_data = APPLE_HAS_FN },
479 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO),
480 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
481 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS),
482 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
483 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
484 .driver_data = APPLE_HAS_FN },
485 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
486 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
487 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
488 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
489 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI),
490 .driver_data = APPLE_HAS_FN },
491 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO),
492 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
493 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS),
494 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
495 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI),
496 .driver_data = APPLE_HAS_FN },
497 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ISO),
498 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
499 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_JIS),
500 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
501 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ANSI),
502 .driver_data = APPLE_HAS_FN },
503 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ISO),
504 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
505 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS),
506 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
507 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ANSI),
508 .driver_data = APPLE_HAS_FN },
509 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ISO),
510 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
511 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_JIS),
512 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
513 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ANSI),
514 .driver_data = APPLE_HAS_FN },
515 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ISO),
516 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
517 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_JIS),
518 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
519 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ANSI),
520 .driver_data = APPLE_HAS_FN },
521 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ISO),
522 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
523 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_JIS),
524 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
525 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ANSI),
526 .driver_data = APPLE_HAS_FN },
527 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ISO),
528 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
529 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_JIS),
530 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
531 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ANSI),
532 .driver_data = APPLE_HAS_FN },
533 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ISO),
534 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
535 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_JIS),
536 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
537 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ANSI),
538 .driver_data = APPLE_HAS_FN },
539 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ISO),
540 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
541 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_JIS),
542 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
543 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ANSI),
544 .driver_data = APPLE_HAS_FN },
545 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ISO),
546 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
547 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_JIS),
548 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
549 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ANSI),
550 .driver_data = APPLE_HAS_FN },
551 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ISO),
552 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
553 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_JIS),
554 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
555 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
556 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
557 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
558 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
559 APPLE_ISO_KEYBOARD },
560 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS),
561 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
562 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY),
563 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
564 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY),
565 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
566
567 { }
568};
569MODULE_DEVICE_TABLE(hid, apple_devices);
570
571static struct hid_driver apple_driver = {
572 .name = "apple",
573 .id_table = apple_devices,
574 .report_fixup = apple_report_fixup,
575 .probe = apple_probe,
576 .event = apple_event,
577 .input_mapping = apple_input_mapping,
578 .input_mapped = apple_input_mapped,
579};
580module_hid_driver(apple_driver);
581
582MODULE_LICENSE("GPL");
1/*
2 * USB HID quirks support for Linux
3 *
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>
10 */
11
12/*
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)
16 * any later version.
17 */
18
19#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
20
21#include <linux/device.h>
22#include <linux/hid.h>
23#include <linux/module.h>
24#include <linux/slab.h>
25#include <linux/usb.h>
26
27#include "hid-ids.h"
28
29#define APPLE_RDESC_JIS 0x0001
30#define APPLE_IGNORE_MOUSE 0x0002
31#define APPLE_HAS_FN 0x0004
32#define APPLE_HIDDEV 0x0008
33#define APPLE_ISO_KEYBOARD 0x0010
34#define APPLE_MIGHTYMOUSE 0x0020
35#define APPLE_INVERT_HWHEEL 0x0040
36#define APPLE_IGNORE_HIDINPUT 0x0080
37#define APPLE_NUMLOCK_EMULATION 0x0100
38
39#define APPLE_FLAG_FKEY 0x01
40
41static unsigned int fnmode = 1;
42module_param(fnmode, uint, 0644);
43MODULE_PARM_DESC(fnmode, "Mode of fn key on Apple keyboards (0 = disabled, "
44 "[1] = fkeyslast, 2 = fkeysfirst)");
45
46static unsigned int iso_layout = 1;
47module_param(iso_layout, uint, 0644);
48MODULE_PARM_DESC(iso_layout, "Enable/Disable hardcoded ISO-layout of the keyboard. "
49 "(0 = disabled, [1] = enabled)");
50
51struct apple_sc {
52 unsigned long quirks;
53 unsigned int fn_on;
54 DECLARE_BITMAP(pressed_fn, KEY_CNT);
55 DECLARE_BITMAP(pressed_numlock, KEY_CNT);
56};
57
58struct apple_key_translation {
59 u16 from;
60 u16 to;
61 u8 flags;
62};
63
64static const struct apple_key_translation macbookair_fn_keys[] = {
65 { KEY_BACKSPACE, KEY_DELETE },
66 { KEY_ENTER, KEY_INSERT },
67 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
68 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
69 { KEY_F3, KEY_SCALE, APPLE_FLAG_FKEY },
70 { KEY_F4, KEY_DASHBOARD, APPLE_FLAG_FKEY },
71 { KEY_F6, KEY_PREVIOUSSONG, APPLE_FLAG_FKEY },
72 { KEY_F7, KEY_PLAYPAUSE, APPLE_FLAG_FKEY },
73 { KEY_F8, KEY_NEXTSONG, APPLE_FLAG_FKEY },
74 { KEY_F9, KEY_MUTE, APPLE_FLAG_FKEY },
75 { KEY_F10, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
76 { KEY_F11, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
77 { KEY_F12, KEY_EJECTCD, APPLE_FLAG_FKEY },
78 { KEY_UP, KEY_PAGEUP },
79 { KEY_DOWN, KEY_PAGEDOWN },
80 { KEY_LEFT, KEY_HOME },
81 { KEY_RIGHT, KEY_END },
82 { }
83};
84
85static const struct apple_key_translation apple_fn_keys[] = {
86 { KEY_BACKSPACE, KEY_DELETE },
87 { KEY_ENTER, KEY_INSERT },
88 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
89 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
90 { KEY_F3, KEY_SCALE, APPLE_FLAG_FKEY },
91 { KEY_F4, KEY_DASHBOARD, APPLE_FLAG_FKEY },
92 { KEY_F5, KEY_KBDILLUMDOWN, APPLE_FLAG_FKEY },
93 { KEY_F6, KEY_KBDILLUMUP, APPLE_FLAG_FKEY },
94 { KEY_F7, KEY_PREVIOUSSONG, APPLE_FLAG_FKEY },
95 { KEY_F8, KEY_PLAYPAUSE, APPLE_FLAG_FKEY },
96 { KEY_F9, KEY_NEXTSONG, APPLE_FLAG_FKEY },
97 { KEY_F10, KEY_MUTE, APPLE_FLAG_FKEY },
98 { KEY_F11, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
99 { KEY_F12, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
100 { KEY_UP, KEY_PAGEUP },
101 { KEY_DOWN, KEY_PAGEDOWN },
102 { KEY_LEFT, KEY_HOME },
103 { KEY_RIGHT, KEY_END },
104 { }
105};
106
107static const struct apple_key_translation powerbook_fn_keys[] = {
108 { KEY_BACKSPACE, KEY_DELETE },
109 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
110 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
111 { KEY_F3, KEY_MUTE, APPLE_FLAG_FKEY },
112 { KEY_F4, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
113 { KEY_F5, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
114 { KEY_F6, KEY_NUMLOCK, APPLE_FLAG_FKEY },
115 { KEY_F7, KEY_SWITCHVIDEOMODE, APPLE_FLAG_FKEY },
116 { KEY_F8, KEY_KBDILLUMTOGGLE, APPLE_FLAG_FKEY },
117 { KEY_F9, KEY_KBDILLUMDOWN, APPLE_FLAG_FKEY },
118 { KEY_F10, KEY_KBDILLUMUP, APPLE_FLAG_FKEY },
119 { KEY_UP, KEY_PAGEUP },
120 { KEY_DOWN, KEY_PAGEDOWN },
121 { KEY_LEFT, KEY_HOME },
122 { KEY_RIGHT, KEY_END },
123 { }
124};
125
126static const struct apple_key_translation powerbook_numlock_keys[] = {
127 { KEY_J, KEY_KP1 },
128 { KEY_K, KEY_KP2 },
129 { KEY_L, KEY_KP3 },
130 { KEY_U, KEY_KP4 },
131 { KEY_I, KEY_KP5 },
132 { KEY_O, KEY_KP6 },
133 { KEY_7, KEY_KP7 },
134 { KEY_8, KEY_KP8 },
135 { KEY_9, KEY_KP9 },
136 { KEY_M, KEY_KP0 },
137 { KEY_DOT, KEY_KPDOT },
138 { KEY_SLASH, KEY_KPPLUS },
139 { KEY_SEMICOLON, KEY_KPMINUS },
140 { KEY_P, KEY_KPASTERISK },
141 { KEY_MINUS, KEY_KPEQUAL },
142 { KEY_0, KEY_KPSLASH },
143 { KEY_F6, KEY_NUMLOCK },
144 { KEY_KPENTER, KEY_KPENTER },
145 { KEY_BACKSPACE, KEY_BACKSPACE },
146 { }
147};
148
149static const struct apple_key_translation apple_iso_keyboard[] = {
150 { KEY_GRAVE, KEY_102ND },
151 { KEY_102ND, KEY_GRAVE },
152 { }
153};
154
155static const struct apple_key_translation *apple_find_translation(
156 const struct apple_key_translation *table, u16 from)
157{
158 const struct apple_key_translation *trans;
159
160 /* Look for the translation */
161 for (trans = table; trans->from; trans++)
162 if (trans->from == from)
163 return trans;
164
165 return NULL;
166}
167
168static int hidinput_apple_event(struct hid_device *hid, struct input_dev *input,
169 struct hid_usage *usage, __s32 value)
170{
171 struct apple_sc *asc = hid_get_drvdata(hid);
172 const struct apple_key_translation *trans, *table;
173
174 if (usage->code == KEY_FN) {
175 asc->fn_on = !!value;
176 input_event(input, usage->type, usage->code, value);
177 return 1;
178 }
179
180 if (fnmode) {
181 int do_translate;
182
183 if (hid->product >= USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI &&
184 hid->product <= USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS)
185 table = macbookair_fn_keys;
186 else if (hid->product < 0x21d || hid->product >= 0x300)
187 table = powerbook_fn_keys;
188 else
189 table = apple_fn_keys;
190
191 trans = apple_find_translation (table, usage->code);
192
193 if (trans) {
194 if (test_bit(usage->code, asc->pressed_fn))
195 do_translate = 1;
196 else if (trans->flags & APPLE_FLAG_FKEY)
197 do_translate = (fnmode == 2 && asc->fn_on) ||
198 (fnmode == 1 && !asc->fn_on);
199 else
200 do_translate = asc->fn_on;
201
202 if (do_translate) {
203 if (value)
204 set_bit(usage->code, asc->pressed_fn);
205 else
206 clear_bit(usage->code, asc->pressed_fn);
207
208 input_event(input, usage->type, trans->to,
209 value);
210
211 return 1;
212 }
213 }
214
215 if (asc->quirks & APPLE_NUMLOCK_EMULATION &&
216 (test_bit(usage->code, asc->pressed_numlock) ||
217 test_bit(LED_NUML, input->led))) {
218 trans = apple_find_translation(powerbook_numlock_keys,
219 usage->code);
220
221 if (trans) {
222 if (value)
223 set_bit(usage->code,
224 asc->pressed_numlock);
225 else
226 clear_bit(usage->code,
227 asc->pressed_numlock);
228
229 input_event(input, usage->type, trans->to,
230 value);
231 }
232
233 return 1;
234 }
235 }
236
237 if (iso_layout) {
238 if (asc->quirks & APPLE_ISO_KEYBOARD) {
239 trans = apple_find_translation(apple_iso_keyboard, usage->code);
240 if (trans) {
241 input_event(input, usage->type, trans->to, value);
242 return 1;
243 }
244 }
245 }
246
247 return 0;
248}
249
250static int apple_event(struct hid_device *hdev, struct hid_field *field,
251 struct hid_usage *usage, __s32 value)
252{
253 struct apple_sc *asc = hid_get_drvdata(hdev);
254
255 if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput ||
256 !usage->type)
257 return 0;
258
259 if ((asc->quirks & APPLE_INVERT_HWHEEL) &&
260 usage->code == REL_HWHEEL) {
261 input_event(field->hidinput->input, usage->type, usage->code,
262 -value);
263 return 1;
264 }
265
266 if ((asc->quirks & APPLE_HAS_FN) &&
267 hidinput_apple_event(hdev, field->hidinput->input,
268 usage, value))
269 return 1;
270
271
272 return 0;
273}
274
275/*
276 * MacBook JIS keyboard has wrong logical maximum
277 */
278static __u8 *apple_report_fixup(struct hid_device *hdev, __u8 *rdesc,
279 unsigned int *rsize)
280{
281 struct apple_sc *asc = hid_get_drvdata(hdev);
282
283 if ((asc->quirks & APPLE_RDESC_JIS) && *rsize >= 60 &&
284 rdesc[53] == 0x65 && rdesc[59] == 0x65) {
285 hid_info(hdev,
286 "fixing up MacBook JIS keyboard report descriptor\n");
287 rdesc[53] = rdesc[59] = 0xe7;
288 }
289 return rdesc;
290}
291
292static void apple_setup_input(struct input_dev *input)
293{
294 const struct apple_key_translation *trans;
295
296 set_bit(KEY_NUMLOCK, input->keybit);
297
298 /* Enable all needed keys */
299 for (trans = apple_fn_keys; trans->from; trans++)
300 set_bit(trans->to, input->keybit);
301
302 for (trans = powerbook_fn_keys; trans->from; trans++)
303 set_bit(trans->to, input->keybit);
304
305 for (trans = powerbook_numlock_keys; trans->from; trans++)
306 set_bit(trans->to, input->keybit);
307
308 for (trans = apple_iso_keyboard; trans->from; trans++)
309 set_bit(trans->to, input->keybit);
310}
311
312static int apple_input_mapping(struct hid_device *hdev, struct hid_input *hi,
313 struct hid_field *field, struct hid_usage *usage,
314 unsigned long **bit, int *max)
315{
316 if (usage->hid == (HID_UP_CUSTOM | 0x0003)) {
317 /* The fn key on Apple USB keyboards */
318 set_bit(EV_REP, hi->input->evbit);
319 hid_map_usage_clear(hi, usage, bit, max, EV_KEY, KEY_FN);
320 apple_setup_input(hi->input);
321 return 1;
322 }
323
324 /* we want the hid layer to go through standard path (set and ignore) */
325 return 0;
326}
327
328static int apple_input_mapped(struct hid_device *hdev, struct hid_input *hi,
329 struct hid_field *field, struct hid_usage *usage,
330 unsigned long **bit, int *max)
331{
332 struct apple_sc *asc = hid_get_drvdata(hdev);
333
334 if (asc->quirks & APPLE_MIGHTYMOUSE) {
335 if (usage->hid == HID_GD_Z)
336 hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
337 else if (usage->code == BTN_1)
338 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_2);
339 else if (usage->code == BTN_2)
340 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_1);
341 }
342
343 return 0;
344}
345
346static int apple_probe(struct hid_device *hdev,
347 const struct hid_device_id *id)
348{
349 unsigned long quirks = id->driver_data;
350 struct apple_sc *asc;
351 unsigned int connect_mask = HID_CONNECT_DEFAULT;
352 int ret;
353
354 asc = kzalloc(sizeof(*asc), GFP_KERNEL);
355 if (asc == NULL) {
356 hid_err(hdev, "can't alloc apple descriptor\n");
357 return -ENOMEM;
358 }
359
360 asc->quirks = quirks;
361
362 hid_set_drvdata(hdev, asc);
363
364 ret = hid_parse(hdev);
365 if (ret) {
366 hid_err(hdev, "parse failed\n");
367 goto err_free;
368 }
369
370 if (quirks & APPLE_HIDDEV)
371 connect_mask |= HID_CONNECT_HIDDEV_FORCE;
372 if (quirks & APPLE_IGNORE_HIDINPUT)
373 connect_mask &= ~HID_CONNECT_HIDINPUT;
374
375 ret = hid_hw_start(hdev, connect_mask);
376 if (ret) {
377 hid_err(hdev, "hw start failed\n");
378 goto err_free;
379 }
380
381 return 0;
382err_free:
383 kfree(asc);
384 return ret;
385}
386
387static void apple_remove(struct hid_device *hdev)
388{
389 hid_hw_stop(hdev);
390 kfree(hid_get_drvdata(hdev));
391}
392
393static const struct hid_device_id apple_devices[] = {
394 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ATV_IRCONTROL),
395 .driver_data = APPLE_HIDDEV | APPLE_IGNORE_HIDINPUT },
396 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_IRCONTROL4),
397 .driver_data = APPLE_HIDDEV | APPLE_IGNORE_HIDINPUT },
398 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE),
399 .driver_data = APPLE_MIGHTYMOUSE | APPLE_INVERT_HWHEEL },
400
401 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI),
402 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
403 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO),
404 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
405 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI),
406 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
407 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO),
408 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
409 APPLE_ISO_KEYBOARD },
410 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS),
411 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
412 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI),
413 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
414 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO),
415 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
416 APPLE_ISO_KEYBOARD },
417 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS),
418 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
419 APPLE_RDESC_JIS },
420 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI),
421 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
422 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO),
423 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
424 APPLE_ISO_KEYBOARD },
425 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS),
426 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
427 APPLE_RDESC_JIS },
428 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ANSI),
429 .driver_data = APPLE_HAS_FN },
430 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ISO),
431 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
432 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_JIS),
433 .driver_data = APPLE_HAS_FN },
434 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI),
435 .driver_data = APPLE_HAS_FN },
436 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO),
437 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
438 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS),
439 .driver_data = APPLE_HAS_FN },
440 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI),
441 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
442 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO),
443 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
444 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS),
445 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
446 APPLE_RDESC_JIS },
447 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ANSI),
448 .driver_data = APPLE_HAS_FN },
449 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ISO),
450 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
451 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_JIS),
452 .driver_data = APPLE_HAS_FN },
453 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
454 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
455 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO),
456 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
457 APPLE_ISO_KEYBOARD },
458 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS),
459 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
460 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI),
461 .driver_data = APPLE_HAS_FN },
462 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO),
463 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
464 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS),
465 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
466 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
467 .driver_data = APPLE_HAS_FN },
468 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
469 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
470 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
471 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
472 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI),
473 .driver_data = APPLE_HAS_FN },
474 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO),
475 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
476 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS),
477 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
478 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI),
479 .driver_data = APPLE_HAS_FN },
480 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ISO),
481 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
482 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_JIS),
483 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
484 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ANSI),
485 .driver_data = APPLE_HAS_FN },
486 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ISO),
487 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
488 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS),
489 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
490 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ANSI),
491 .driver_data = APPLE_HAS_FN },
492 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ISO),
493 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
494 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_JIS),
495 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
496 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
497 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
498 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
499 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
500 APPLE_ISO_KEYBOARD },
501 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS),
502 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
503 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY),
504 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
505 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY),
506 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
507
508 { }
509};
510MODULE_DEVICE_TABLE(hid, apple_devices);
511
512static struct hid_driver apple_driver = {
513 .name = "apple",
514 .id_table = apple_devices,
515 .report_fixup = apple_report_fixup,
516 .probe = apple_probe,
517 .remove = apple_remove,
518 .event = apple_event,
519 .input_mapping = apple_input_mapping,
520 .input_mapped = apple_input_mapped,
521};
522
523static int __init apple_init(void)
524{
525 int ret;
526
527 ret = hid_register_driver(&apple_driver);
528 if (ret)
529 pr_err("can't register apple driver\n");
530
531 return ret;
532}
533
534static void __exit apple_exit(void)
535{
536 hid_unregister_driver(&apple_driver);
537}
538
539module_init(apple_init);
540module_exit(apple_exit);
541MODULE_LICENSE("GPL");