[mirror_ubuntu-bionic-kernel.git] / drivers / hid / hid-apple.c

/*
 *  USB HID quirks support for Linux
 *
 *  Copyright (c) 1999 Andreas Gal
 *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
 *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
 *  Copyright (c) 2006-2007 Jiri Kosina
 *  Copyright (c) 2007 Paul Walmsley
 *  Copyright (c) 2008 Jiri Slaby <jirislaby@gmail.com>
 */

/*
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 */

#include <linux/device.h>
#include <linux/hid.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/usb.h>

#include "hid-ids.h"

#define APPLE_RDESC_JIS		0x0001
#define APPLE_IGNORE_MOUSE	0x0002
#define APPLE_HAS_FN		0x0004
#define APPLE_HIDDEV		0x0008
#define APPLE_ISO_KEYBOARD	0x0010
#define APPLE_MIGHTYMOUSE	0x0020
#define APPLE_INVERT_HWHEEL	0x0040
#define APPLE_IGNORE_HIDINPUT	0x0080
#define APPLE_NUMLOCK_EMULATION	0x0100

#define APPLE_FLAG_FKEY		0x01

static unsigned int fnmode = 1;
module_param(fnmode, uint, 0644);
MODULE_PARM_DESC(fnmode, "Mode of fn key on Apple keyboards (0 = disabled, "
		"[1] = fkeyslast, 2 = fkeysfirst)");

static unsigned int iso_layout = 1;
module_param(iso_layout, uint, 0644);
MODULE_PARM_DESC(iso_layout, "Enable/Disable hardcoded ISO-layout of the keyboard. "
		"(0 = disabled, [1] = enabled)");

struct apple_sc {
	unsigned long quirks;
	unsigned int fn_on;
	DECLARE_BITMAP(pressed_fn, KEY_CNT);
	DECLARE_BITMAP(pressed_numlock, KEY_CNT);
};

struct apple_key_translation {
	u16 from;
	u16 to;
	u8 flags;
};

static const struct apple_key_translation macbookair_fn_keys[] = {
	{ KEY_BACKSPACE, KEY_DELETE },
	{ KEY_ENTER,	KEY_INSERT },
	{ KEY_F1,	KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
	{ KEY_F2,	KEY_BRIGHTNESSUP,   APPLE_FLAG_FKEY },
	{ KEY_F3,	KEY_SCALE,          APPLE_FLAG_FKEY },
	{ KEY_F4,	KEY_DASHBOARD,      APPLE_FLAG_FKEY },
	{ KEY_F6,	KEY_PREVIOUSSONG,   APPLE_FLAG_FKEY },
	{ KEY_F7,	KEY_PLAYPAUSE,      APPLE_FLAG_FKEY },
	{ KEY_F8,	KEY_NEXTSONG,       APPLE_FLAG_FKEY },
	{ KEY_F9,	KEY_MUTE,           APPLE_FLAG_FKEY },
	{ KEY_F10,	KEY_VOLUMEDOWN,     APPLE_FLAG_FKEY },
	{ KEY_F11,	KEY_VOLUMEUP,       APPLE_FLAG_FKEY },
	{ KEY_F12,	KEY_EJECTCD,        APPLE_FLAG_FKEY },
	{ KEY_UP,	KEY_PAGEUP },
	{ KEY_DOWN,	KEY_PAGEDOWN },
	{ KEY_LEFT,	KEY_HOME },
	{ KEY_RIGHT,	KEY_END },
	{ }
};

static const struct apple_key_translation apple_fn_keys[] = {
	{ KEY_BACKSPACE, KEY_DELETE },
	{ KEY_ENTER,	KEY_INSERT },
	{ KEY_F1,	KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
	{ KEY_F2,	KEY_BRIGHTNESSUP,   APPLE_FLAG_FKEY },
	{ KEY_F3,	KEY_SCALE,          APPLE_FLAG_FKEY },
	{ KEY_F4,	KEY_DASHBOARD,      APPLE_FLAG_FKEY },
	{ KEY_F5,	KEY_KBDILLUMDOWN,   APPLE_FLAG_FKEY },
	{ KEY_F6,	KEY_KBDILLUMUP,     APPLE_FLAG_FKEY },
	{ KEY_F7,	KEY_PREVIOUSSONG,   APPLE_FLAG_FKEY },
	{ KEY_F8,	KEY_PLAYPAUSE,      APPLE_FLAG_FKEY },
	{ KEY_F9,	KEY_NEXTSONG,       APPLE_FLAG_FKEY },
	{ KEY_F10,	KEY_MUTE,           APPLE_FLAG_FKEY },
	{ KEY_F11,	KEY_VOLUMEDOWN,     APPLE_FLAG_FKEY },
	{ KEY_F12,	KEY_VOLUMEUP,       APPLE_FLAG_FKEY },
	{ KEY_UP,	KEY_PAGEUP },
	{ KEY_DOWN,	KEY_PAGEDOWN },
	{ KEY_LEFT,	KEY_HOME },
	{ KEY_RIGHT,	KEY_END },
	{ }
};

static const struct apple_key_translation powerbook_fn_keys[] = {
	{ KEY_BACKSPACE, KEY_DELETE },
	{ KEY_F1,	KEY_BRIGHTNESSDOWN,     APPLE_FLAG_FKEY },
	{ KEY_F2,	KEY_BRIGHTNESSUP,       APPLE_FLAG_FKEY },
	{ KEY_F3,	KEY_MUTE,               APPLE_FLAG_FKEY },
	{ KEY_F4,	KEY_VOLUMEDOWN,         APPLE_FLAG_FKEY },
	{ KEY_F5,	KEY_VOLUMEUP,           APPLE_FLAG_FKEY },
	{ KEY_F6,	KEY_NUMLOCK,            APPLE_FLAG_FKEY },
	{ KEY_F7,	KEY_SWITCHVIDEOMODE,    APPLE_FLAG_FKEY },
	{ KEY_F8,	KEY_KBDILLUMTOGGLE,     APPLE_FLAG_FKEY },
	{ KEY_F9,	KEY_KBDILLUMDOWN,       APPLE_FLAG_FKEY },
	{ KEY_F10,	KEY_KBDILLUMUP,         APPLE_FLAG_FKEY },
	{ KEY_UP,	KEY_PAGEUP },
	{ KEY_DOWN,	KEY_PAGEDOWN },
	{ KEY_LEFT,	KEY_HOME },
	{ KEY_RIGHT,	KEY_END },
	{ }
};

static const struct apple_key_translation powerbook_numlock_keys[] = {
	{ KEY_J,	KEY_KP1 },
	{ KEY_K,	KEY_KP2 },
	{ KEY_L,	KEY_KP3 },
	{ KEY_U,	KEY_KP4 },
	{ KEY_I,	KEY_KP5 },
	{ KEY_O,	KEY_KP6 },
	{ KEY_7,	KEY_KP7 },
	{ KEY_8,	KEY_KP8 },
	{ KEY_9,	KEY_KP9 },
	{ KEY_M,	KEY_KP0 },
	{ KEY_DOT,	KEY_KPDOT },
	{ KEY_SLASH,	KEY_KPPLUS },
	{ KEY_SEMICOLON, KEY_KPMINUS },
	{ KEY_P,	KEY_KPASTERISK },
	{ KEY_MINUS,	KEY_KPEQUAL },
	{ KEY_0,	KEY_KPSLASH },
	{ KEY_F6,	KEY_NUMLOCK },
	{ KEY_KPENTER,	KEY_KPENTER },
	{ KEY_BACKSPACE, KEY_BACKSPACE },
	{ }
};

static const struct apple_key_translation apple_iso_keyboard[] = {
	{ KEY_GRAVE,	KEY_102ND },
	{ KEY_102ND,	KEY_GRAVE },
	{ }
};

static const struct apple_key_translation *apple_find_translation(
		const struct apple_key_translation *table, u16 from)
{
	const struct apple_key_translation *trans;

	/* Look for the translation */
	for (trans = table; trans->from; trans++)
		if (trans->from == from)
			return trans;

	return NULL;
}

static int hidinput_apple_event(struct hid_device *hid, struct input_dev *input,
		struct hid_usage *usage, __s32 value)
{
	struct apple_sc *asc = hid_get_drvdata(hid);
	const struct apple_key_translation *trans;

	if (usage->code == KEY_FN) {
		asc->fn_on = !!value;
		input_event(input, usage->type, usage->code, value);
		return 1;
	}

	if (fnmode) {
		int do_translate;

		if(hid->product >= USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI &&
				hid->product <= USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS) {
			trans = apple_find_translation(macbookair_fn_keys, usage->code);
		} else if (hid->product < 0x21d || hid->product >= 0x300) {
			trans = apple_find_translation(powerbook_fn_keys, usage->code);
		} else {
			trans = apple_find_translation(apple_fn_keys, usage->code);
		}

		if (trans) {
			if (test_bit(usage->code, asc->pressed_fn))
				do_translate = 1;
			else if (trans->flags & APPLE_FLAG_FKEY)
				do_translate = (fnmode == 2 && asc->fn_on) ||
					(fnmode == 1 && !asc->fn_on);
			else
				do_translate = asc->fn_on;

			if (do_translate) {
				if (value)
					set_bit(usage->code, asc->pressed_fn);
				else
					clear_bit(usage->code, asc->pressed_fn);

				input_event(input, usage->type, trans->to,
						value);

				return 1;
			}
		}

		if (asc->quirks & APPLE_NUMLOCK_EMULATION &&
				(test_bit(usage->code, asc->pressed_numlock) ||
				test_bit(LED_NUML, input->led))) {
			trans = apple_find_translation(powerbook_numlock_keys,
					usage->code);

			if (trans) {
				if (value)
					set_bit(usage->code,
							asc->pressed_numlock);
				else
					clear_bit(usage->code,
							asc->pressed_numlock);

				input_event(input, usage->type, trans->to,
						value);
			}

			return 1;
		}
	}

        if (iso_layout) {
		if (asc->quirks & APPLE_ISO_KEYBOARD) {
			trans = apple_find_translation(apple_iso_keyboard, usage->code);
			if (trans) {
				input_event(input, usage->type, trans->to, value);
				return 1;
			}
		}
	}

	return 0;
}

static int apple_event(struct hid_device *hdev, struct hid_field *field,
		struct hid_usage *usage, __s32 value)
{
	struct apple_sc *asc = hid_get_drvdata(hdev);

	if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput ||
			!usage->type)
		return 0;

	if ((asc->quirks & APPLE_INVERT_HWHEEL) &&
			usage->code == REL_HWHEEL) {
		input_event(field->hidinput->input, usage->type, usage->code,
				-value);
		return 1;
	}

	if ((asc->quirks & APPLE_HAS_FN) &&
			hidinput_apple_event(hdev, field->hidinput->input,
				usage, value))
		return 1;


	return 0;
}

/*
 * MacBook JIS keyboard has wrong logical maximum
 */
static __u8 *apple_report_fixup(struct hid_device *hdev, __u8 *rdesc,
		unsigned int *rsize)
{
	struct apple_sc *asc = hid_get_drvdata(hdev);

	if ((asc->quirks & APPLE_RDESC_JIS) && *rsize >= 60 &&
			rdesc[53] == 0x65 && rdesc[59] == 0x65) {
		dev_info(&hdev->dev, "fixing up MacBook JIS keyboard report "
				"descriptor\n");
		rdesc[53] = rdesc[59] = 0xe7;
	}
	return rdesc;
}

static void apple_setup_input(struct input_dev *input)
{
	const struct apple_key_translation *trans;

	set_bit(KEY_NUMLOCK, input->keybit);

	/* Enable all needed keys */
	for (trans = apple_fn_keys; trans->from; trans++)
		set_bit(trans->to, input->keybit);

	for (trans = powerbook_fn_keys; trans->from; trans++)
		set_bit(trans->to, input->keybit);

	for (trans = powerbook_numlock_keys; trans->from; trans++)
		set_bit(trans->to, input->keybit);

	for (trans = apple_iso_keyboard; trans->from; trans++)
		set_bit(trans->to, input->keybit);
}

static int apple_input_mapping(struct hid_device *hdev, struct hid_input *hi,
		struct hid_field *field, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	if (usage->hid == (HID_UP_CUSTOM | 0x0003)) {
		/* The fn key on Apple USB keyboards */
		set_bit(EV_REP, hi->input->evbit);
		hid_map_usage_clear(hi, usage, bit, max, EV_KEY, KEY_FN);
		apple_setup_input(hi->input);
		return 1;
	}

	/* we want the hid layer to go through standard path (set and ignore) */
	return 0;
}

static int apple_input_mapped(struct hid_device *hdev, struct hid_input *hi,
		struct hid_field *field, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	struct apple_sc *asc = hid_get_drvdata(hdev);

	if (asc->quirks & APPLE_MIGHTYMOUSE) {
		if (usage->hid == HID_GD_Z)
			hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
		else if (usage->code == BTN_1)
			hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_2);
		else if (usage->code == BTN_2)
			hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_1);
	}

	return 0;
}

static int apple_probe(struct hid_device *hdev,
		const struct hid_device_id *id)
{
	unsigned long quirks = id->driver_data;
	struct apple_sc *asc;
	unsigned int connect_mask = HID_CONNECT_DEFAULT;
	int ret;

	asc = kzalloc(sizeof(*asc), GFP_KERNEL);
	if (asc == NULL) {
		dev_err(&hdev->dev, "can't alloc apple descriptor\n");
		return -ENOMEM;
	}

	asc->quirks = quirks;

	hid_set_drvdata(hdev, asc);

	ret = hid_parse(hdev);
	if (ret) {
		dev_err(&hdev->dev, "parse failed\n");
		goto err_free;
	}

	if (quirks & APPLE_HIDDEV)
		connect_mask |= HID_CONNECT_HIDDEV_FORCE;
	if (quirks & APPLE_IGNORE_HIDINPUT)
		connect_mask &= ~HID_CONNECT_HIDINPUT;

	ret = hid_hw_start(hdev, connect_mask);
	if (ret) {
		dev_err(&hdev->dev, "hw start failed\n");
		goto err_free;
	}

	return 0;
err_free:
	kfree(asc);
	return ret;
}

static void apple_remove(struct hid_device *hdev)
{
	hid_hw_stop(hdev);
	kfree(hid_get_drvdata(hdev));
}

static const struct hid_device_id apple_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ATV_IRCONTROL),
		.driver_data = APPLE_HIDDEV | APPLE_IGNORE_HIDINPUT },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_IRCONTROL4),
		.driver_data = APPLE_HIDDEV | APPLE_IGNORE_HIDINPUT },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE),
		.driver_data = APPLE_MIGHTYMOUSE | APPLE_INVERT_HWHEEL },

	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
			APPLE_ISO_KEYBOARD },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
			APPLE_ISO_KEYBOARD },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
			APPLE_RDESC_JIS },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
			APPLE_ISO_KEYBOARD },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
			APPLE_RDESC_JIS },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ANSI),
		.driver_data = APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ISO),
		.driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_JIS),
		.driver_data = APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI),
		.driver_data = APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO),
		.driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS),
		.driver_data = APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
			APPLE_RDESC_JIS },
	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
			APPLE_ISO_KEYBOARD },
	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI),
		.driver_data = APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO),
		.driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS),
		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
		.driver_data = APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
		.driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI),
		.driver_data = APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO),
		.driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS),
		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI),
		.driver_data = APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ISO),
		.driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_JIS),
		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ANSI),
		.driver_data = APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ISO),
		.driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS),
		.driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
			APPLE_ISO_KEYBOARD },
	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY),
		.driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },

	{ }
};
MODULE_DEVICE_TABLE(hid, apple_devices);

static struct hid_driver apple_driver = {
	.name = "apple",
	.id_table = apple_devices,
	.report_fixup = apple_report_fixup,
	.probe = apple_probe,
	.remove = apple_remove,
	.event = apple_event,
	.input_mapping = apple_input_mapping,
	.input_mapped = apple_input_mapped,
};

static int __init apple_init(void)
{
	int ret;

	ret = hid_register_driver(&apple_driver);
	if (ret)
		printk(KERN_ERR "can't register apple driver\n");

	return ret;
}

static void __exit apple_exit(void)
{
	hid_unregister_driver(&apple_driver);
}

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