xref: /openbmc/linux/drivers/hid/hid-apple.c (revision f79e4d5f)
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 	DECLARE_BITMAP(pressed_fn, KEY_CNT);
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 
188 	if (usage->code == KEY_FN) {
189 		asc->fn_on = !!value;
190 		input_event(input, usage->type, usage->code, value);
191 		return 1;
192 	}
193 
194 	if (fnmode) {
195 		int do_translate;
196 
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(usage->code, asc->pressed_fn))
209 				do_translate = 1;
210 			else if (trans->flags & APPLE_FLAG_FKEY)
211 				do_translate = (fnmode == 2 && asc->fn_on) ||
212 					(fnmode == 1 && !asc->fn_on);
213 			else
214 				do_translate = asc->fn_on;
215 
216 			if (do_translate) {
217 				if (value)
218 					set_bit(usage->code, asc->pressed_fn);
219 				else
220 					clear_bit(usage->code, asc->pressed_fn);
221 
222 				input_event(input, usage->type, trans->to,
223 						value);
224 
225 				return 1;
226 			}
227 		}
228 
229 		if (asc->quirks & APPLE_NUMLOCK_EMULATION &&
230 				(test_bit(usage->code, asc->pressed_numlock) ||
231 				test_bit(LED_NUML, input->led))) {
232 			trans = apple_find_translation(powerbook_numlock_keys,
233 					usage->code);
234 
235 			if (trans) {
236 				if (value)
237 					set_bit(usage->code,
238 							asc->pressed_numlock);
239 				else
240 					clear_bit(usage->code,
241 							asc->pressed_numlock);
242 
243 				input_event(input, usage->type, trans->to,
244 						value);
245 			}
246 
247 			return 1;
248 		}
249 	}
250 
251 	if (iso_layout) {
252 		if (hid->country == HID_COUNTRY_INTERNATIONAL_ISO) {
253 			trans = apple_find_translation(apple_iso_keyboard, usage->code);
254 			if (trans) {
255 				input_event(input, usage->type, trans->to, value);
256 				return 1;
257 			}
258 		}
259 	}
260 
261 	if (swap_opt_cmd) {
262 		trans = apple_find_translation(swapped_option_cmd_keys, usage->code);
263 		if (trans) {
264 			input_event(input, usage->type, trans->to, value);
265 			return 1;
266 		}
267 	}
268 
269 	return 0;
270 }
271 
272 static int apple_event(struct hid_device *hdev, struct hid_field *field,
273 		struct hid_usage *usage, __s32 value)
274 {
275 	struct apple_sc *asc = hid_get_drvdata(hdev);
276 
277 	if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput ||
278 			!usage->type)
279 		return 0;
280 
281 	if ((asc->quirks & APPLE_INVERT_HWHEEL) &&
282 			usage->code == REL_HWHEEL) {
283 		input_event(field->hidinput->input, usage->type, usage->code,
284 				-value);
285 		return 1;
286 	}
287 
288 	if ((asc->quirks & APPLE_HAS_FN) &&
289 			hidinput_apple_event(hdev, field->hidinput->input,
290 				usage, value))
291 		return 1;
292 
293 
294 	return 0;
295 }
296 
297 /*
298  * MacBook JIS keyboard has wrong logical maximum
299  */
300 static __u8 *apple_report_fixup(struct hid_device *hdev, __u8 *rdesc,
301 		unsigned int *rsize)
302 {
303 	struct apple_sc *asc = hid_get_drvdata(hdev);
304 
305 	if ((asc->quirks & APPLE_RDESC_JIS) && *rsize >= 60 &&
306 			rdesc[53] == 0x65 && rdesc[59] == 0x65) {
307 		hid_info(hdev,
308 			 "fixing up MacBook JIS keyboard report descriptor\n");
309 		rdesc[53] = rdesc[59] = 0xe7;
310 	}
311 	return rdesc;
312 }
313 
314 static void apple_setup_input(struct input_dev *input)
315 {
316 	const struct apple_key_translation *trans;
317 
318 	set_bit(KEY_NUMLOCK, input->keybit);
319 
320 	/* Enable all needed keys */
321 	for (trans = apple_fn_keys; trans->from; trans++)
322 		set_bit(trans->to, input->keybit);
323 
324 	for (trans = powerbook_fn_keys; trans->from; trans++)
325 		set_bit(trans->to, input->keybit);
326 
327 	for (trans = powerbook_numlock_keys; trans->from; trans++)
328 		set_bit(trans->to, input->keybit);
329 
330 	for (trans = apple_iso_keyboard; trans->from; trans++)
331 		set_bit(trans->to, input->keybit);
332 }
333 
334 static int apple_input_mapping(struct hid_device *hdev, struct hid_input *hi,
335 		struct hid_field *field, struct hid_usage *usage,
336 		unsigned long **bit, int *max)
337 {
338 	if (usage->hid == (HID_UP_CUSTOM | 0x0003)) {
339 		/* The fn key on Apple USB keyboards */
340 		set_bit(EV_REP, hi->input->evbit);
341 		hid_map_usage_clear(hi, usage, bit, max, EV_KEY, KEY_FN);
342 		apple_setup_input(hi->input);
343 		return 1;
344 	}
345 
346 	/* we want the hid layer to go through standard path (set and ignore) */
347 	return 0;
348 }
349 
350 static int apple_input_mapped(struct hid_device *hdev, struct hid_input *hi,
351 		struct hid_field *field, struct hid_usage *usage,
352 		unsigned long **bit, int *max)
353 {
354 	struct apple_sc *asc = hid_get_drvdata(hdev);
355 
356 	if (asc->quirks & APPLE_MIGHTYMOUSE) {
357 		if (usage->hid == HID_GD_Z)
358 			hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
359 		else if (usage->code == BTN_1)
360 			hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_2);
361 		else if (usage->code == BTN_2)
362 			hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_1);
363 	}
364 
365 	return 0;
366 }
367 
368 static int apple_probe(struct hid_device *hdev,
369 		const struct hid_device_id *id)
370 {
371 	unsigned long quirks = id->driver_data;
372 	struct apple_sc *asc;
373 	unsigned int connect_mask = HID_CONNECT_DEFAULT;
374 	int ret;
375 
376 	asc = devm_kzalloc(&hdev->dev, sizeof(*asc), GFP_KERNEL);
377 	if (asc == NULL) {
378 		hid_err(hdev, "can't alloc apple descriptor\n");
379 		return -ENOMEM;
380 	}
381 
382 	asc->quirks = quirks;
383 
384 	hid_set_drvdata(hdev, asc);
385 
386 	ret = hid_parse(hdev);
387 	if (ret) {
388 		hid_err(hdev, "parse failed\n");
389 		return ret;
390 	}
391 
392 	if (quirks & APPLE_HIDDEV)
393 		connect_mask |= HID_CONNECT_HIDDEV_FORCE;
394 	if (quirks & APPLE_IGNORE_HIDINPUT)
395 		connect_mask &= ~HID_CONNECT_HIDINPUT;
396 
397 	ret = hid_hw_start(hdev, connect_mask);
398 	if (ret) {
399 		hid_err(hdev, "hw start failed\n");
400 		return ret;
401 	}
402 
403 	return 0;
404 }
405 
406 static const struct hid_device_id apple_devices[] = {
407 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE),
408 		.driver_data = APPLE_MIGHTYMOUSE | APPLE_INVERT_HWHEEL },
409 
410 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI),
411 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
412 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO),
413 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
414 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI),
415 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
416 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO),
417 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
418 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS),
419 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
420 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI),
421 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
422 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO),
423 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
424 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_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_GEYSER4_ANSI),
428 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
429 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO),
430 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
431 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS),
432 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
433 			APPLE_RDESC_JIS },
434 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ANSI),
435 		.driver_data = APPLE_HAS_FN },
436 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ISO),
437 		.driver_data = APPLE_HAS_FN },
438 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_JIS),
439 		.driver_data = APPLE_HAS_FN },
440 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI),
441 		.driver_data = APPLE_HAS_FN },
442 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO),
443 		.driver_data = APPLE_HAS_FN },
444 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS),
445 		.driver_data = APPLE_HAS_FN },
446 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI),
447 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
448 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO),
449 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
450 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS),
451 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
452 			APPLE_RDESC_JIS },
453 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ANSI),
454 		.driver_data = APPLE_HAS_FN },
455 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ISO),
456 		.driver_data = APPLE_HAS_FN },
457 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_JIS),
458 		.driver_data = APPLE_HAS_FN },
459 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
460 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
461 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO),
462 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
463 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
464 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
465 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
466 				USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
467 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
468 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
469 				USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_JIS),
470 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
471 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS),
472 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
473 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_ANSI),
474 		.driver_data = APPLE_HAS_FN },
475 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI),
476 		.driver_data = APPLE_HAS_FN },
477 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO),
478 		.driver_data = APPLE_HAS_FN },
479 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS),
480 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
481 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
482 		.driver_data = APPLE_HAS_FN },
483 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
484 		.driver_data = APPLE_HAS_FN },
485 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
486 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
487 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI),
488 		.driver_data = APPLE_HAS_FN },
489 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO),
490 		.driver_data = APPLE_HAS_FN },
491 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS),
492 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
493 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI),
494 		.driver_data = APPLE_HAS_FN },
495 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ISO),
496 		.driver_data = APPLE_HAS_FN },
497 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_JIS),
498 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
499 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ANSI),
500 		.driver_data = APPLE_HAS_FN },
501 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ISO),
502 		.driver_data = APPLE_HAS_FN },
503 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS),
504 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
505 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ANSI),
506 		.driver_data = APPLE_HAS_FN },
507 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ISO),
508 		.driver_data = APPLE_HAS_FN },
509 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_JIS),
510 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
511 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ANSI),
512 		.driver_data = APPLE_HAS_FN },
513 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ISO),
514 		.driver_data = APPLE_HAS_FN },
515 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_JIS),
516 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
517 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ANSI),
518 		.driver_data = APPLE_HAS_FN },
519 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ISO),
520 		.driver_data = APPLE_HAS_FN },
521 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_JIS),
522 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
523 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ANSI),
524 		.driver_data = APPLE_HAS_FN },
525 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ISO),
526 		.driver_data = APPLE_HAS_FN },
527 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_JIS),
528 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
529 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ANSI),
530 		.driver_data = APPLE_HAS_FN },
531 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ISO),
532 		.driver_data = APPLE_HAS_FN },
533 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_JIS),
534 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
535 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ANSI),
536 		.driver_data = APPLE_HAS_FN },
537 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ISO),
538 		.driver_data = APPLE_HAS_FN },
539 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_JIS),
540 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
541 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ANSI),
542 		.driver_data = APPLE_HAS_FN },
543 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ISO),
544 		.driver_data = APPLE_HAS_FN },
545 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_JIS),
546 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
547 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ANSI),
548 		.driver_data = APPLE_HAS_FN },
549 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ISO),
550 		.driver_data = APPLE_HAS_FN },
551 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_JIS),
552 		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
553 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
554 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
555 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
556 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
557 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS),
558 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
559 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY),
560 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
561 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY),
562 		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
563 
564 	{ }
565 };
566 MODULE_DEVICE_TABLE(hid, apple_devices);
567 
568 static struct hid_driver apple_driver = {
569 	.name = "apple",
570 	.id_table = apple_devices,
571 	.report_fixup = apple_report_fixup,
572 	.probe = apple_probe,
573 	.event = apple_event,
574 	.input_mapping = apple_input_mapping,
575 	.input_mapped = apple_input_mapped,
576 };
577 module_hid_driver(apple_driver);
578 
579 MODULE_LICENSE("GPL");
580