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