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

source code of linux/drivers/hid/hid-apple.c