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