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