projects/linux·blob master · refs

1262 lines · 43.1 KiB

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