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