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