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