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