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