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 * Copyright (c) 2019 Paul Pawlowski <paul@mrarm.io>
11 */
12
13 /*
14 */
15
16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17
18 #include <linux/device.h>
19 #include <linux/hid.h>
20 #include <linux/jiffies.h>
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/timer.h>
24 #include <linux/string.h>
25 #include <linux/leds.h>
26
27 #include "hid-ids.h"
28
29 #define APPLE_RDESC_JIS BIT(0)
30 #define APPLE_IGNORE_MOUSE BIT(1)
31 #define APPLE_HAS_FN BIT(2)
32 /* BIT(3) reserved, was: APPLE_HIDDEV */
33 #define APPLE_ISO_TILDE_QUIRK BIT(4)
34 #define APPLE_MIGHTYMOUSE BIT(5)
35 #define APPLE_INVERT_HWHEEL BIT(6)
36 /* BIT(7) reserved, was: APPLE_IGNORE_HIDINPUT */
37 #define APPLE_NUMLOCK_EMULATION BIT(8)
38 #define APPLE_RDESC_BATTERY BIT(9)
39 #define APPLE_BACKLIGHT_CTL BIT(10)
40 #define APPLE_IS_NON_APPLE BIT(11)
41
42 #define APPLE_FLAG_FKEY 0x01
43
44 #define HID_COUNTRY_INTERNATIONAL_ISO 13
45 #define APPLE_BATTERY_TIMEOUT_MS 60000
46
47 static unsigned int fnmode = 3;
48 module_param(fnmode, uint, 0644);
49 MODULE_PARM_DESC(fnmode, "Mode of fn key on Apple keyboards (0 = disabled, "
50 "1 = fkeyslast, 2 = fkeysfirst, [3] = auto)");
51
52 static int iso_layout = -1;
53 module_param(iso_layout, int, 0644);
54 MODULE_PARM_DESC(iso_layout, "Swap the backtick/tilde and greater-than/less-than keys. "
55 "([-1] = auto, 0 = disabled, 1 = enabled)");
56
57 static unsigned int swap_opt_cmd;
58 module_param(swap_opt_cmd, uint, 0644);
59 MODULE_PARM_DESC(swap_opt_cmd, "Swap the Option (\"Alt\") and Command (\"Flag\") keys. "
60 "(For people who want to keep Windows PC keyboard muscle memory. "
61 "[0] = as-is, Mac layout. 1 = swapped, Windows layout., 2 = swapped, Swap only left side)");
62
63 static unsigned int swap_ctrl_cmd;
64 module_param(swap_ctrl_cmd, uint, 0644);
65 MODULE_PARM_DESC(swap_ctrl_cmd, "Swap the Control (\"Ctrl\") and Command (\"Flag\") keys. "
66 "(For people who are used to Mac shortcuts involving Command instead of Control. "
67 "[0] = No change. 1 = Swapped.)");
68
69 static unsigned int swap_fn_leftctrl;
70 module_param(swap_fn_leftctrl, uint, 0644);
71 MODULE_PARM_DESC(swap_fn_leftctrl, "Swap the Fn and left Control keys. "
72 "(For people who want to keep PC keyboard muscle memory. "
73 "[0] = as-is, Mac layout, 1 = swapped, PC layout)");
74
75 struct apple_non_apple_keyboard {
76 char *name;
77 };
78
79 struct apple_sc_backlight {
80 struct led_classdev cdev;
81 struct hid_device *hdev;
82 unsigned short backlight_off, backlight_on_min, backlight_on_max;
83 };
84
85 struct apple_sc {
86 struct hid_device *hdev;
87 unsigned long quirks;
88 unsigned int fn_on;
89 unsigned int fn_found;
90 DECLARE_BITMAP(pressed_numlock, KEY_CNT);
91 struct timer_list battery_timer;
92 struct apple_sc_backlight *backlight;
93 };
94
95 struct apple_key_translation {
96 u16 from;
97 u16 to;
98 u8 flags;
99 };
100
101 static const struct apple_key_translation magic_keyboard_alu_fn_keys[] = {
102 { KEY_BACKSPACE, KEY_DELETE },
103 { KEY_ENTER, KEY_INSERT },
104 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
105 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
106 { KEY_F3, KEY_SCALE, APPLE_FLAG_FKEY },
107 { KEY_F4, KEY_DASHBOARD, APPLE_FLAG_FKEY },
108 { KEY_F6, KEY_NUMLOCK, APPLE_FLAG_FKEY },
109 { KEY_F7, KEY_PREVIOUSSONG, APPLE_FLAG_FKEY },
110 { KEY_F8, KEY_PLAYPAUSE, APPLE_FLAG_FKEY },
111 { KEY_F9, KEY_NEXTSONG, APPLE_FLAG_FKEY },
112 { KEY_F10, KEY_MUTE, APPLE_FLAG_FKEY },
113 { KEY_F11, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
114 { KEY_F12, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
115 { KEY_UP, KEY_PAGEUP },
116 { KEY_DOWN, KEY_PAGEDOWN },
117 { KEY_LEFT, KEY_HOME },
118 { KEY_RIGHT, KEY_END },
119 { }
120 };
121
122 static const struct apple_key_translation magic_keyboard_2015_fn_keys[] = {
123 { KEY_BACKSPACE, KEY_DELETE },
124 { KEY_ENTER, KEY_INSERT },
125 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
126 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
127 { KEY_F3, KEY_SCALE, APPLE_FLAG_FKEY },
128 { KEY_F4, KEY_DASHBOARD, APPLE_FLAG_FKEY },
129 { KEY_F7, KEY_PREVIOUSSONG, APPLE_FLAG_FKEY },
130 { KEY_F8, KEY_PLAYPAUSE, APPLE_FLAG_FKEY },
131 { KEY_F9, KEY_NEXTSONG, APPLE_FLAG_FKEY },
132 { KEY_F10, KEY_MUTE, APPLE_FLAG_FKEY },
133 { KEY_F11, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
134 { KEY_F12, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
135 { KEY_UP, KEY_PAGEUP },
136 { KEY_DOWN, KEY_PAGEDOWN },
137 { KEY_LEFT, KEY_HOME },
138 { KEY_RIGHT, KEY_END },
139 { }
140 };
141
142 struct apple_backlight_config_report {
143 u8 report_id;
144 u8 version;
145 u16 backlight_off, backlight_on_min, backlight_on_max;
146 };
147
148 struct apple_backlight_set_report {
149 u8 report_id;
150 u8 version;
151 u16 backlight;
152 u16 rate;
153 };
154
155
156 static const struct apple_key_translation apple2021_fn_keys[] = {
157 { KEY_BACKSPACE, KEY_DELETE },
158 { KEY_ENTER, KEY_INSERT },
159 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
160 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
161 { KEY_F3, KEY_SCALE, APPLE_FLAG_FKEY },
162 { KEY_F4, KEY_SEARCH, APPLE_FLAG_FKEY },
163 { KEY_F5, KEY_MICMUTE, APPLE_FLAG_FKEY },
164 { KEY_F6, KEY_SLEEP, APPLE_FLAG_FKEY },
165 { KEY_F7, KEY_PREVIOUSSONG, APPLE_FLAG_FKEY },
166 { KEY_F8, KEY_PLAYPAUSE, APPLE_FLAG_FKEY },
167 { KEY_F9, KEY_NEXTSONG, APPLE_FLAG_FKEY },
168 { KEY_F10, KEY_MUTE, APPLE_FLAG_FKEY },
169 { KEY_F11, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
170 { KEY_F12, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
171 { KEY_UP, KEY_PAGEUP },
172 { KEY_DOWN, KEY_PAGEDOWN },
173 { KEY_LEFT, KEY_HOME },
174 { KEY_RIGHT, KEY_END },
175 { }
176 };
177
178 static const struct apple_key_translation macbookair_fn_keys[] = {
179 { KEY_BACKSPACE, KEY_DELETE },
180 { KEY_ENTER, KEY_INSERT },
181 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
182 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
183 { KEY_F3, KEY_SCALE, APPLE_FLAG_FKEY },
184 { KEY_F4, KEY_DASHBOARD, APPLE_FLAG_FKEY },
185 { KEY_F6, KEY_PREVIOUSSONG, APPLE_FLAG_FKEY },
186 { KEY_F7, KEY_PLAYPAUSE, APPLE_FLAG_FKEY },
187 { KEY_F8, KEY_NEXTSONG, APPLE_FLAG_FKEY },
188 { KEY_F9, KEY_MUTE, APPLE_FLAG_FKEY },
189 { KEY_F10, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
190 { KEY_F11, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
191 { KEY_F12, KEY_EJECTCD, APPLE_FLAG_FKEY },
192 { KEY_UP, KEY_PAGEUP },
193 { KEY_DOWN, KEY_PAGEDOWN },
194 { KEY_LEFT, KEY_HOME },
195 { KEY_RIGHT, KEY_END },
196 { }
197 };
198
199 static const struct apple_key_translation macbookpro_no_esc_fn_keys[] = {
200 { KEY_BACKSPACE, KEY_DELETE },
201 { KEY_ENTER, KEY_INSERT },
202 { KEY_GRAVE, KEY_ESC },
203 { KEY_1, KEY_F1 },
204 { KEY_2, KEY_F2 },
205 { KEY_3, KEY_F3 },
206 { KEY_4, KEY_F4 },
207 { KEY_5, KEY_F5 },
208 { KEY_6, KEY_F6 },
209 { KEY_7, KEY_F7 },
210 { KEY_8, KEY_F8 },
211 { KEY_9, KEY_F9 },
212 { KEY_0, KEY_F10 },
213 { KEY_MINUS, KEY_F11 },
214 { KEY_EQUAL, KEY_F12 },
215 { KEY_UP, KEY_PAGEUP },
216 { KEY_DOWN, KEY_PAGEDOWN },
217 { KEY_LEFT, KEY_HOME },
218 { KEY_RIGHT, KEY_END },
219 { }
220 };
221
222 static const struct apple_key_translation macbookpro_dedicated_esc_fn_keys[] = {
223 { KEY_BACKSPACE, KEY_DELETE },
224 { KEY_ENTER, KEY_INSERT },
225 { KEY_1, KEY_F1 },
226 { KEY_2, KEY_F2 },
227 { KEY_3, KEY_F3 },
228 { KEY_4, KEY_F4 },
229 { KEY_5, KEY_F5 },
230 { KEY_6, KEY_F6 },
231 { KEY_7, KEY_F7 },
232 { KEY_8, KEY_F8 },
233 { KEY_9, KEY_F9 },
234 { KEY_0, KEY_F10 },
235 { KEY_MINUS, KEY_F11 },
236 { KEY_EQUAL, KEY_F12 },
237 { KEY_UP, KEY_PAGEUP },
238 { KEY_DOWN, KEY_PAGEDOWN },
239 { KEY_LEFT, KEY_HOME },
240 { KEY_RIGHT, KEY_END },
241 { }
242 };
243
244 static const struct apple_key_translation apple_fn_keys[] = {
245 { KEY_BACKSPACE, KEY_DELETE },
246 { KEY_ENTER, KEY_INSERT },
247 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
248 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
249 { KEY_F3, KEY_SCALE, APPLE_FLAG_FKEY },
250 { KEY_F4, KEY_DASHBOARD, APPLE_FLAG_FKEY },
251 { KEY_F5, KEY_KBDILLUMDOWN, APPLE_FLAG_FKEY },
252 { KEY_F6, KEY_KBDILLUMUP, APPLE_FLAG_FKEY },
253 { KEY_F7, KEY_PREVIOUSSONG, APPLE_FLAG_FKEY },
254 { KEY_F8, KEY_PLAYPAUSE, APPLE_FLAG_FKEY },
255 { KEY_F9, KEY_NEXTSONG, APPLE_FLAG_FKEY },
256 { KEY_F10, KEY_MUTE, APPLE_FLAG_FKEY },
257 { KEY_F11, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
258 { KEY_F12, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
259 { KEY_UP, KEY_PAGEUP },
260 { KEY_DOWN, KEY_PAGEDOWN },
261 { KEY_LEFT, KEY_HOME },
262 { KEY_RIGHT, KEY_END },
263 { }
264 };
265
266 static const struct apple_key_translation powerbook_fn_keys[] = {
267 { KEY_BACKSPACE, KEY_DELETE },
268 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
269 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
270 { KEY_F3, KEY_MUTE, APPLE_FLAG_FKEY },
271 { KEY_F4, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
272 { KEY_F5, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
273 { KEY_F6, KEY_NUMLOCK, APPLE_FLAG_FKEY },
274 { KEY_F7, KEY_SWITCHVIDEOMODE, APPLE_FLAG_FKEY },
275 { KEY_F8, KEY_KBDILLUMTOGGLE, APPLE_FLAG_FKEY },
276 { KEY_F9, KEY_KBDILLUMDOWN, APPLE_FLAG_FKEY },
277 { KEY_F10, KEY_KBDILLUMUP, APPLE_FLAG_FKEY },
278 { KEY_UP, KEY_PAGEUP },
279 { KEY_DOWN, KEY_PAGEDOWN },
280 { KEY_LEFT, KEY_HOME },
281 { KEY_RIGHT, KEY_END },
282 { }
283 };
284
285 static const struct apple_key_translation powerbook_numlock_keys[] = {
286 { KEY_J, KEY_KP1 },
287 { KEY_K, KEY_KP2 },
288 { KEY_L, KEY_KP3 },
289 { KEY_U, KEY_KP4 },
290 { KEY_I, KEY_KP5 },
291 { KEY_O, KEY_KP6 },
292 { KEY_7, KEY_KP7 },
293 { KEY_8, KEY_KP8 },
294 { KEY_9, KEY_KP9 },
295 { KEY_M, KEY_KP0 },
296 { KEY_DOT, KEY_KPDOT },
297 { KEY_SLASH, KEY_KPPLUS },
298 { KEY_SEMICOLON, KEY_KPMINUS },
299 { KEY_P, KEY_KPASTERISK },
300 { KEY_MINUS, KEY_KPEQUAL },
301 { KEY_0, KEY_KPSLASH },
302 { KEY_F6, KEY_NUMLOCK },
303 { KEY_KPENTER, KEY_KPENTER },
304 { KEY_BACKSPACE, KEY_BACKSPACE },
305 { }
306 };
307
308 static const struct apple_key_translation apple_iso_keyboard[] = {
309 { KEY_GRAVE, KEY_102ND },
310 { KEY_102ND, KEY_GRAVE },
311 { }
312 };
313
314 static const struct apple_key_translation swapped_option_cmd_keys[] = {
315 { KEY_LEFTALT, KEY_LEFTMETA },
316 { KEY_LEFTMETA, KEY_LEFTALT },
317 { KEY_RIGHTALT, KEY_RIGHTMETA },
318 { KEY_RIGHTMETA, KEY_RIGHTALT },
319 { }
320 };
321
322 static const struct apple_key_translation swapped_option_cmd_left_keys[] = {
323 { KEY_LEFTALT, KEY_LEFTMETA },
324 { KEY_LEFTMETA, KEY_LEFTALT },
325 { }
326 };
327
328 static const struct apple_key_translation swapped_ctrl_cmd_keys[] = {
329 { KEY_LEFTCTRL, KEY_LEFTMETA },
330 { KEY_LEFTMETA, KEY_LEFTCTRL },
331 { KEY_RIGHTCTRL, KEY_RIGHTMETA },
332 { KEY_RIGHTMETA, KEY_RIGHTCTRL },
333 { }
334 };
335
336 static const struct apple_key_translation swapped_fn_leftctrl_keys[] = {
337 { KEY_FN, KEY_LEFTCTRL },
338 { KEY_LEFTCTRL, KEY_FN },
339 { }
340 };
341
342 static const struct apple_non_apple_keyboard non_apple_keyboards[] = {
343 { "SONiX USB DEVICE" },
344 { "Keychron" },
345 { "AONE" },
346 { "GANSS" },
347 { "Hailuck" },
348 { "Jamesdonkey" },
349 { "A3R" },
350 };
351
apple_is_non_apple_keyboard(struct hid_device * hdev)352 static bool apple_is_non_apple_keyboard(struct hid_device *hdev)
353 {
354 int i;
355
356 for (i = 0; i < ARRAY_SIZE(non_apple_keyboards); i++) {
357 char *non_apple = non_apple_keyboards[i].name;
358
359 if (strncmp(hdev->name, non_apple, strlen(non_apple)) == 0)
360 return true;
361 }
362
363 return false;
364 }
365
apple_is_omoton_kb066(struct hid_device * hdev)366 static bool apple_is_omoton_kb066(struct hid_device *hdev)
367 {
368 return hdev->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI &&
369 strcmp(hdev->name, "Bluetooth Keyboard") == 0;
370 }
371
apple_setup_key_translation(struct input_dev * input,const struct apple_key_translation * table)372 static inline void apple_setup_key_translation(struct input_dev *input,
373 const struct apple_key_translation *table)
374 {
375 const struct apple_key_translation *trans;
376
377 for (trans = table; trans->from; trans++)
378 set_bit(trans->to, input->keybit);
379 }
380
apple_find_translation(const struct apple_key_translation * table,u16 from)381 static const struct apple_key_translation *apple_find_translation(
382 const struct apple_key_translation *table, u16 from)
383 {
384 const struct apple_key_translation *trans;
385
386 /* Look for the translation */
387 for (trans = table; trans->from; trans++)
388 if (trans->from == from)
389 return trans;
390
391 return NULL;
392 }
393
input_event_with_scancode(struct input_dev * input,__u8 type,__u16 code,unsigned int hid,__s32 value)394 static void input_event_with_scancode(struct input_dev *input,
395 __u8 type, __u16 code, unsigned int hid, __s32 value)
396 {
397 if (type == EV_KEY &&
398 (!test_bit(code, input->key)) == value)
399 input_event(input, EV_MSC, MSC_SCAN, hid);
400 input_event(input, type, code, value);
401 }
402
hidinput_apple_event(struct hid_device * hid,struct input_dev * input,struct hid_usage * usage,__s32 value)403 static int hidinput_apple_event(struct hid_device *hid, struct input_dev *input,
404 struct hid_usage *usage, __s32 value)
405 {
406 struct apple_sc *asc = hid_get_drvdata(hid);
407 const struct apple_key_translation *trans, *table;
408 bool do_translate;
409 u16 code = usage->code;
410 unsigned int real_fnmode;
411
412 if (fnmode == 3) {
413 real_fnmode = (asc->quirks & APPLE_IS_NON_APPLE) ? 2 : 1;
414 } else {
415 real_fnmode = fnmode;
416 }
417
418 if (swap_fn_leftctrl) {
419 trans = apple_find_translation(swapped_fn_leftctrl_keys, code);
420
421 if (trans)
422 code = trans->to;
423 }
424
425 if (iso_layout > 0 || (iso_layout < 0 && (asc->quirks & APPLE_ISO_TILDE_QUIRK) &&
426 hid->country == HID_COUNTRY_INTERNATIONAL_ISO)) {
427 trans = apple_find_translation(apple_iso_keyboard, code);
428
429 if (trans)
430 code = trans->to;
431 }
432
433 if (swap_opt_cmd) {
434 if (swap_opt_cmd == 2)
435 trans = apple_find_translation(swapped_option_cmd_left_keys, code);
436 else
437 trans = apple_find_translation(swapped_option_cmd_keys, code);
438
439 if (trans)
440 code = trans->to;
441 }
442
443 if (swap_ctrl_cmd) {
444 trans = apple_find_translation(swapped_ctrl_cmd_keys, code);
445
446 if (trans)
447 code = trans->to;
448 }
449
450 if (code == KEY_FN)
451 asc->fn_on = !!value;
452
453 if (real_fnmode) {
454 if (hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI ||
455 hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO ||
456 hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS ||
457 hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI ||
458 hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO ||
459 hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS ||
460 hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI ||
461 hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO ||
462 hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_JIS)
463 table = magic_keyboard_alu_fn_keys;
464 else if (hid->product == USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2015 ||
465 hid->product == USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2015)
466 table = magic_keyboard_2015_fn_keys;
467 else if (hid->product == USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2021 ||
468 hid->product == USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2024 ||
469 hid->product == USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2021 ||
470 hid->product == USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2021)
471 table = apple2021_fn_keys;
472 else if (hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J132 ||
473 hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J680 ||
474 hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J213)
475 table = macbookpro_no_esc_fn_keys;
476 else if (hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J214K ||
477 hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J223 ||
478 hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J152F)
479 table = macbookpro_dedicated_esc_fn_keys;
480 else if (hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J140K ||
481 hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J230K)
482 table = apple_fn_keys;
483 else if (hid->product >= USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI &&
484 hid->product <= USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS)
485 table = macbookair_fn_keys;
486 else if (hid->product < 0x21d || hid->product >= 0x300)
487 table = powerbook_fn_keys;
488 else
489 table = apple_fn_keys;
490
491 trans = apple_find_translation(table, code);
492
493 if (trans) {
494 bool from_is_set = test_bit(trans->from, input->key);
495 bool to_is_set = test_bit(trans->to, input->key);
496
497 if (from_is_set)
498 code = trans->from;
499 else if (to_is_set)
500 code = trans->to;
501
502 if (!(from_is_set || to_is_set)) {
503 if (trans->flags & APPLE_FLAG_FKEY) {
504 switch (real_fnmode) {
505 case 1:
506 do_translate = !asc->fn_on;
507 break;
508 case 2:
509 do_translate = asc->fn_on;
510 break;
511 default:
512 /* should never happen */
513 do_translate = false;
514 }
515 } else {
516 do_translate = asc->fn_on;
517 }
518
519 if (do_translate)
520 code = trans->to;
521 }
522 }
523
524 if (asc->quirks & APPLE_NUMLOCK_EMULATION &&
525 (test_bit(code, asc->pressed_numlock) ||
526 test_bit(LED_NUML, input->led))) {
527 trans = apple_find_translation(powerbook_numlock_keys, code);
528
529 if (trans) {
530 if (value)
531 set_bit(code, asc->pressed_numlock);
532 else
533 clear_bit(code, asc->pressed_numlock);
534
535 code = trans->to;
536 }
537 }
538 }
539
540 if (usage->code != code) {
541 input_event_with_scancode(input, usage->type, code, usage->hid, value);
542
543 return 1;
544 }
545
546 return 0;
547 }
548
apple_event(struct hid_device * hdev,struct hid_field * field,struct hid_usage * usage,__s32 value)549 static int apple_event(struct hid_device *hdev, struct hid_field *field,
550 struct hid_usage *usage, __s32 value)
551 {
552 struct apple_sc *asc = hid_get_drvdata(hdev);
553
554 if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput ||
555 !usage->type)
556 return 0;
557
558 if ((asc->quirks & APPLE_INVERT_HWHEEL) &&
559 usage->code == REL_HWHEEL) {
560 input_event_with_scancode(field->hidinput->input, usage->type,
561 usage->code, usage->hid, -value);
562 return 1;
563 }
564
565 if ((asc->quirks & APPLE_HAS_FN) &&
566 hidinput_apple_event(hdev, field->hidinput->input,
567 usage, value))
568 return 1;
569
570
571 return 0;
572 }
573
apple_fetch_battery(struct hid_device * hdev)574 static int apple_fetch_battery(struct hid_device *hdev)
575 {
576 #ifdef CONFIG_HID_BATTERY_STRENGTH
577 struct apple_sc *asc = hid_get_drvdata(hdev);
578 struct hid_report_enum *report_enum;
579 struct hid_report *report;
580
581 if (!(asc->quirks & APPLE_RDESC_BATTERY) || !hdev->battery)
582 return -1;
583
584 report_enum = &hdev->report_enum[hdev->battery_report_type];
585 report = report_enum->report_id_hash[hdev->battery_report_id];
586
587 if (!report || report->maxfield < 1)
588 return -1;
589
590 if (hdev->battery_capacity == hdev->battery_max)
591 return -1;
592
593 hid_hw_request(hdev, report, HID_REQ_GET_REPORT);
594 return 0;
595 #else
596 return -1;
597 #endif
598 }
599
apple_battery_timer_tick(struct timer_list * t)600 static void apple_battery_timer_tick(struct timer_list *t)
601 {
602 struct apple_sc *asc = from_timer(asc, t, battery_timer);
603 struct hid_device *hdev = asc->hdev;
604
605 if (apple_fetch_battery(hdev) == 0) {
606 mod_timer(&asc->battery_timer,
607 jiffies + msecs_to_jiffies(APPLE_BATTERY_TIMEOUT_MS));
608 }
609 }
610
611 /*
612 * MacBook JIS keyboard has wrong logical maximum
613 * Magic Keyboard JIS has wrong logical maximum
614 */
apple_report_fixup(struct hid_device * hdev,__u8 * rdesc,unsigned int * rsize)615 static __u8 *apple_report_fixup(struct hid_device *hdev, __u8 *rdesc,
616 unsigned int *rsize)
617 {
618 struct apple_sc *asc = hid_get_drvdata(hdev);
619
620 if(*rsize >=71 && rdesc[70] == 0x65 && rdesc[64] == 0x65) {
621 hid_info(hdev,
622 "fixing up Magic Keyboard JIS report descriptor\n");
623 rdesc[64] = rdesc[70] = 0xe7;
624 }
625
626 if ((asc->quirks & APPLE_RDESC_JIS) && *rsize >= 60 &&
627 rdesc[53] == 0x65 && rdesc[59] == 0x65) {
628 hid_info(hdev,
629 "fixing up MacBook JIS keyboard report descriptor\n");
630 rdesc[53] = rdesc[59] = 0xe7;
631 }
632
633 /*
634 * Change the usage from:
635 * 0x06, 0x00, 0xff, // Usage Page (Vendor Defined Page 1) 0
636 * 0x09, 0x0b, // Usage (Vendor Usage 0x0b) 3
637 * To:
638 * 0x05, 0x01, // Usage Page (Generic Desktop) 0
639 * 0x09, 0x06, // Usage (Keyboard) 2
640 */
641 if ((asc->quirks & APPLE_RDESC_BATTERY) && *rsize == 83 &&
642 rdesc[46] == 0x84 && rdesc[58] == 0x85) {
643 hid_info(hdev,
644 "fixing up Magic Keyboard battery report descriptor\n");
645 *rsize = *rsize - 1;
646 rdesc = kmemdup(rdesc + 1, *rsize, GFP_KERNEL);
647 if (!rdesc)
648 return NULL;
649
650 rdesc[0] = 0x05;
651 rdesc[1] = 0x01;
652 rdesc[2] = 0x09;
653 rdesc[3] = 0x06;
654 }
655
656 return rdesc;
657 }
658
apple_setup_input(struct input_dev * input)659 static void apple_setup_input(struct input_dev *input)
660 {
661 set_bit(KEY_NUMLOCK, input->keybit);
662
663 /* Enable all needed keys */
664 apple_setup_key_translation(input, apple_fn_keys);
665 apple_setup_key_translation(input, powerbook_fn_keys);
666 apple_setup_key_translation(input, powerbook_numlock_keys);
667 apple_setup_key_translation(input, apple_iso_keyboard);
668 apple_setup_key_translation(input, magic_keyboard_alu_fn_keys);
669 apple_setup_key_translation(input, magic_keyboard_2015_fn_keys);
670 apple_setup_key_translation(input, apple2021_fn_keys);
671 apple_setup_key_translation(input, macbookpro_no_esc_fn_keys);
672 apple_setup_key_translation(input, macbookpro_dedicated_esc_fn_keys);
673 }
674
apple_input_mapping(struct hid_device * hdev,struct hid_input * hi,struct hid_field * field,struct hid_usage * usage,unsigned long ** bit,int * max)675 static int apple_input_mapping(struct hid_device *hdev, struct hid_input *hi,
676 struct hid_field *field, struct hid_usage *usage,
677 unsigned long **bit, int *max)
678 {
679 struct apple_sc *asc = hid_get_drvdata(hdev);
680
681 if (usage->hid == (HID_UP_CUSTOM | 0x0003) ||
682 usage->hid == (HID_UP_MSVENDOR | 0x0003) ||
683 usage->hid == (HID_UP_HPVENDOR2 | 0x0003)) {
684 /* The fn key on Apple USB keyboards */
685 set_bit(EV_REP, hi->input->evbit);
686 hid_map_usage_clear(hi, usage, bit, max, EV_KEY, KEY_FN);
687 asc->fn_found = true;
688 apple_setup_input(hi->input);
689 return 1;
690 }
691
692 /* we want the hid layer to go through standard path (set and ignore) */
693 return 0;
694 }
695
apple_input_mapped(struct hid_device * hdev,struct hid_input * hi,struct hid_field * field,struct hid_usage * usage,unsigned long ** bit,int * max)696 static int apple_input_mapped(struct hid_device *hdev, struct hid_input *hi,
697 struct hid_field *field, struct hid_usage *usage,
698 unsigned long **bit, int *max)
699 {
700 struct apple_sc *asc = hid_get_drvdata(hdev);
701
702 if (asc->quirks & APPLE_MIGHTYMOUSE) {
703 if (usage->hid == HID_GD_Z)
704 hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
705 else if (usage->code == BTN_1)
706 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_2);
707 else if (usage->code == BTN_2)
708 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_1);
709 }
710
711 return 0;
712 }
713
apple_input_configured(struct hid_device * hdev,struct hid_input * hidinput)714 static int apple_input_configured(struct hid_device *hdev,
715 struct hid_input *hidinput)
716 {
717 struct apple_sc *asc = hid_get_drvdata(hdev);
718
719 if (((asc->quirks & APPLE_HAS_FN) && !asc->fn_found) || apple_is_omoton_kb066(hdev)) {
720 hid_info(hdev, "Fn key not found (Apple Wireless Keyboard clone?), disabling Fn key handling\n");
721 asc->quirks &= ~APPLE_HAS_FN;
722 }
723
724 if (apple_is_non_apple_keyboard(hdev)) {
725 hid_info(hdev, "Non-apple keyboard detected; function keys will default to fnmode=2 behavior\n");
726 asc->quirks |= APPLE_IS_NON_APPLE;
727 }
728
729 return 0;
730 }
731
apple_backlight_check_support(struct hid_device * hdev)732 static bool apple_backlight_check_support(struct hid_device *hdev)
733 {
734 int i;
735 unsigned int hid;
736 struct hid_report *report;
737
738 list_for_each_entry(report, &hdev->report_enum[HID_INPUT_REPORT].report_list, list) {
739 for (i = 0; i < report->maxfield; i++) {
740 hid = report->field[i]->usage->hid;
741 if ((hid & HID_USAGE_PAGE) == HID_UP_MSVENDOR && (hid & HID_USAGE) == 0xf)
742 return true;
743 }
744 }
745
746 return false;
747 }
748
apple_backlight_set(struct hid_device * hdev,u16 value,u16 rate)749 static int apple_backlight_set(struct hid_device *hdev, u16 value, u16 rate)
750 {
751 int ret = 0;
752 struct apple_backlight_set_report *rep;
753
754 rep = kmalloc(sizeof(*rep), GFP_KERNEL);
755 if (rep == NULL)
756 return -ENOMEM;
757
758 rep->report_id = 0xB0;
759 rep->version = 1;
760 rep->backlight = value;
761 rep->rate = rate;
762
763 ret = hid_hw_raw_request(hdev, 0xB0u, (u8 *) rep, sizeof(*rep),
764 HID_OUTPUT_REPORT, HID_REQ_SET_REPORT);
765
766 kfree(rep);
767 return ret;
768 }
769
apple_backlight_led_set(struct led_classdev * led_cdev,enum led_brightness brightness)770 static int apple_backlight_led_set(struct led_classdev *led_cdev,
771 enum led_brightness brightness)
772 {
773 struct apple_sc_backlight *backlight = container_of(led_cdev,
774 struct apple_sc_backlight, cdev);
775
776 return apple_backlight_set(backlight->hdev, brightness, 0);
777 }
778
apple_backlight_init(struct hid_device * hdev)779 static int apple_backlight_init(struct hid_device *hdev)
780 {
781 int ret;
782 struct apple_sc *asc = hid_get_drvdata(hdev);
783 struct apple_backlight_config_report *rep;
784
785 if (!apple_backlight_check_support(hdev))
786 return -EINVAL;
787
788 rep = kmalloc(0x200, GFP_KERNEL);
789 if (rep == NULL)
790 return -ENOMEM;
791
792 ret = hid_hw_raw_request(hdev, 0xBFu, (u8 *) rep, sizeof(*rep),
793 HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
794 if (ret < 0) {
795 hid_err(hdev, "backlight request failed: %d\n", ret);
796 goto cleanup_and_exit;
797 }
798 if (ret < 8 || rep->version != 1) {
799 hid_err(hdev, "backlight config struct: bad version %i\n", rep->version);
800 ret = -EINVAL;
801 goto cleanup_and_exit;
802 }
803
804 hid_dbg(hdev, "backlight config: off=%u, on_min=%u, on_max=%u\n",
805 rep->backlight_off, rep->backlight_on_min, rep->backlight_on_max);
806
807 asc->backlight = devm_kzalloc(&hdev->dev, sizeof(*asc->backlight), GFP_KERNEL);
808 if (!asc->backlight) {
809 ret = -ENOMEM;
810 goto cleanup_and_exit;
811 }
812
813 asc->backlight->hdev = hdev;
814 asc->backlight->cdev.name = "apple::kbd_backlight";
815 asc->backlight->cdev.max_brightness = rep->backlight_on_max;
816 asc->backlight->cdev.brightness_set_blocking = apple_backlight_led_set;
817
818 ret = apple_backlight_set(hdev, 0, 0);
819 if (ret < 0) {
820 hid_err(hdev, "backlight set request failed: %d\n", ret);
821 goto cleanup_and_exit;
822 }
823
824 ret = devm_led_classdev_register(&hdev->dev, &asc->backlight->cdev);
825
826 cleanup_and_exit:
827 kfree(rep);
828 return ret;
829 }
830
apple_probe(struct hid_device * hdev,const struct hid_device_id * id)831 static int apple_probe(struct hid_device *hdev,
832 const struct hid_device_id *id)
833 {
834 unsigned long quirks = id->driver_data;
835 struct apple_sc *asc;
836 int ret;
837
838 asc = devm_kzalloc(&hdev->dev, sizeof(*asc), GFP_KERNEL);
839 if (asc == NULL) {
840 hid_err(hdev, "can't alloc apple descriptor\n");
841 return -ENOMEM;
842 }
843
844 asc->hdev = hdev;
845 asc->quirks = quirks;
846
847 hid_set_drvdata(hdev, asc);
848
849 ret = hid_parse(hdev);
850 if (ret) {
851 hid_err(hdev, "parse failed\n");
852 return ret;
853 }
854
855 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
856 if (ret) {
857 hid_err(hdev, "hw start failed\n");
858 return ret;
859 }
860
861 timer_setup(&asc->battery_timer, apple_battery_timer_tick, 0);
862 mod_timer(&asc->battery_timer,
863 jiffies + msecs_to_jiffies(APPLE_BATTERY_TIMEOUT_MS));
864 apple_fetch_battery(hdev);
865
866 if (quirks & APPLE_BACKLIGHT_CTL)
867 apple_backlight_init(hdev);
868
869 return 0;
870 }
871
apple_remove(struct hid_device * hdev)872 static void apple_remove(struct hid_device *hdev)
873 {
874 struct apple_sc *asc = hid_get_drvdata(hdev);
875
876 del_timer_sync(&asc->battery_timer);
877
878 hid_hw_stop(hdev);
879 }
880
881 static const struct hid_device_id apple_devices[] = {
882 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE),
883 .driver_data = APPLE_MIGHTYMOUSE | APPLE_INVERT_HWHEEL },
884
885 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI),
886 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
887 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO),
888 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
889 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI),
890 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
891 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO),
892 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
893 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS),
894 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
895 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI),
896 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
897 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO),
898 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
899 APPLE_ISO_TILDE_QUIRK },
900 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS),
901 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
902 APPLE_RDESC_JIS },
903 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI),
904 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
905 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO),
906 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
907 APPLE_ISO_TILDE_QUIRK },
908 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS),
909 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
910 APPLE_RDESC_JIS },
911 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ANSI),
912 .driver_data = APPLE_HAS_FN },
913 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ISO),
914 .driver_data = APPLE_HAS_FN },
915 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_JIS),
916 .driver_data = APPLE_HAS_FN },
917 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI),
918 .driver_data = APPLE_HAS_FN },
919 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO),
920 .driver_data = APPLE_HAS_FN },
921 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS),
922 .driver_data = APPLE_HAS_FN },
923 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI),
924 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
925 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO),
926 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
927 APPLE_ISO_TILDE_QUIRK },
928 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS),
929 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
930 APPLE_RDESC_JIS },
931 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ANSI),
932 .driver_data = APPLE_HAS_FN },
933 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ANSI),
934 .driver_data = APPLE_HAS_FN },
935 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ISO),
936 .driver_data = APPLE_HAS_FN },
937 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ISO),
938 .driver_data = APPLE_HAS_FN },
939 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_JIS),
940 .driver_data = APPLE_HAS_FN },
941 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
942 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
943 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO),
944 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
945 APPLE_ISO_TILDE_QUIRK },
946 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
947 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
948 APPLE_ISO_TILDE_QUIRK },
949 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
950 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
951 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
952 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
953 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_JIS),
954 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
955 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS),
956 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
957 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2015),
958 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK | APPLE_RDESC_BATTERY },
959 { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2015),
960 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
961 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2015),
962 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK | APPLE_RDESC_BATTERY },
963 { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2015),
964 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
965 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI),
966 .driver_data = APPLE_HAS_FN },
967 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO),
968 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
969 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS),
970 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
971 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
972 .driver_data = APPLE_HAS_FN },
973 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
974 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
975 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
976 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
977 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI),
978 .driver_data = APPLE_HAS_FN },
979 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO),
980 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
981 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS),
982 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
983 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI),
984 .driver_data = APPLE_HAS_FN },
985 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ISO),
986 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
987 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_JIS),
988 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
989 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ANSI),
990 .driver_data = APPLE_HAS_FN },
991 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ISO),
992 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
993 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS),
994 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
995 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ANSI),
996 .driver_data = APPLE_HAS_FN },
997 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ISO),
998 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
999 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_JIS),
1000 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1001 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ANSI),
1002 .driver_data = APPLE_HAS_FN },
1003 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ISO),
1004 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1005 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_JIS),
1006 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1007 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ANSI),
1008 .driver_data = APPLE_HAS_FN },
1009 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ISO),
1010 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1011 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_JIS),
1012 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1013 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ANSI),
1014 .driver_data = APPLE_HAS_FN },
1015 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ISO),
1016 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1017 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_JIS),
1018 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1019 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ANSI),
1020 .driver_data = APPLE_HAS_FN },
1021 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ISO),
1022 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1023 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_JIS),
1024 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1025 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ANSI),
1026 .driver_data = APPLE_HAS_FN },
1027 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ISO),
1028 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1029 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_JIS),
1030 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1031 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ANSI),
1032 .driver_data = APPLE_HAS_FN },
1033 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ISO),
1034 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1035 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_JIS),
1036 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1037 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ANSI),
1038 .driver_data = APPLE_HAS_FN },
1039 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ISO),
1040 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1041 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_JIS),
1042 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1043 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J140K),
1044 .driver_data = APPLE_HAS_FN | APPLE_BACKLIGHT_CTL | APPLE_ISO_TILDE_QUIRK },
1045 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J132),
1046 .driver_data = APPLE_HAS_FN | APPLE_BACKLIGHT_CTL | APPLE_ISO_TILDE_QUIRK },
1047 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J680),
1048 .driver_data = APPLE_HAS_FN | APPLE_BACKLIGHT_CTL | APPLE_ISO_TILDE_QUIRK },
1049 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J213),
1050 .driver_data = APPLE_HAS_FN | APPLE_BACKLIGHT_CTL | APPLE_ISO_TILDE_QUIRK },
1051 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J214K),
1052 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1053 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J223),
1054 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1055 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J230K),
1056 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1057 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J152F),
1058 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1059 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
1060 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
1061 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
1062 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
1063 APPLE_ISO_TILDE_QUIRK },
1064 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS),
1065 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
1066 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY),
1067 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
1068 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY),
1069 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
1070 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2021),
1071 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK | APPLE_RDESC_BATTERY },
1072 { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2021),
1073 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1074 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2024),
1075 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK | APPLE_RDESC_BATTERY },
1076 { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2024),
1077 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1078 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2021),
1079 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK | APPLE_RDESC_BATTERY },
1080 { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2021),
1081 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1082 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2021),
1083 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK | APPLE_RDESC_BATTERY },
1084 { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2021),
1085 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1086
1087 { }
1088 };
1089 MODULE_DEVICE_TABLE(hid, apple_devices);
1090
1091 static struct hid_driver apple_driver = {
1092 .name = "apple",
1093 .id_table = apple_devices,
1094 .report_fixup = apple_report_fixup,
1095 .probe = apple_probe,
1096 .remove = apple_remove,
1097 .event = apple_event,
1098 .input_mapping = apple_input_mapping,
1099 .input_mapped = apple_input_mapped,
1100 .input_configured = apple_input_configured,
1101 };
1102 module_hid_driver(apple_driver);
1103
1104 MODULE_LICENSE("GPL");
1105