[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / hid / hid-magicmouse.c

/*
 *   Apple "Magic" Wireless Mouse driver
 *
 *   Copyright (c) 2010 Michael Poole <mdpoole@troilus.org>
 *   Copyright (c) 2010 Chase Douglas <chase.douglas@canonical.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"

static bool emulate_3button = true;
module_param(emulate_3button, bool, 0644);
MODULE_PARM_DESC(emulate_3button, "Emulate a middle button");

static int middle_button_start = -350;
static int middle_button_stop = +350;

static bool emulate_scroll_wheel = true;
module_param(emulate_scroll_wheel, bool, 0644);
MODULE_PARM_DESC(emulate_scroll_wheel, "Emulate a scroll wheel");

static unsigned int scroll_speed = 32;
static int param_set_scroll_speed(const char *val, struct kernel_param *kp) {
	unsigned long speed;
	if (!val || strict_strtoul(val, 0, &speed) || speed > 63)
		return -EINVAL;
	scroll_speed = speed;
	return 0;
}
module_param_call(scroll_speed, param_set_scroll_speed, param_get_uint, &scroll_speed, 0644);
MODULE_PARM_DESC(scroll_speed, "Scroll speed, value from 0 (slow) to 63 (fast)");

static bool scroll_acceleration = false;
module_param(scroll_acceleration, bool, 0644);
MODULE_PARM_DESC(scroll_acceleration, "Accelerate sequential scroll events");

static bool report_touches = true;
module_param(report_touches, bool, 0644);
MODULE_PARM_DESC(report_touches, "Emit touch records (otherwise, only use them for emulation)");

static bool report_undeciphered;
module_param(report_undeciphered, bool, 0644);
MODULE_PARM_DESC(report_undeciphered, "Report undeciphered multi-touch state field using a MSC_RAW event");

#define TRACKPAD_REPORT_ID 0x28
#define MOUSE_REPORT_ID    0x29
#define DOUBLE_REPORT_ID   0xf7
/* These definitions are not precise, but they're close enough.  (Bits
 * 0x03 seem to indicate the aspect ratio of the touch, bits 0x70 seem
 * to be some kind of bit mask -- 0x20 may be a near-field reading,
 * and 0x40 is actual contact, and 0x10 may be a start/stop or change
 * indication.)
 */
#define TOUCH_STATE_MASK  0xf0
#define TOUCH_STATE_NONE  0x00
#define TOUCH_STATE_START 0x30
#define TOUCH_STATE_DRAG  0x40

#define SCROLL_ACCEL_DEFAULT 7

/* Single touch emulation should only begin when no touches are currently down.
 * This is true when single_touch_id is equal to NO_TOUCHES. If multiple touches
 * are down and the touch providing for single touch emulation is lifted,
 * single_touch_id is equal to SINGLE_TOUCH_UP. While single touch emulation is
 * occuring, single_touch_id corresponds with the tracking id of the touch used.
 */
#define NO_TOUCHES -1
#define SINGLE_TOUCH_UP -2

/**
 * struct magicmouse_sc - Tracks Magic Mouse-specific data.
 * @input: Input device through which we report events.
 * @quirks: Currently unused.
 * @ntouches: Number of touches in most recent touch report.
 * @scroll_accel: Number of consecutive scroll motions.
 * @scroll_jiffies: Time of last scroll motion.
 * @touches: Most recent data for a touch, indexed by tracking ID.
 * @tracking_ids: Mapping of current touch input data to @touches.
 */
struct magicmouse_sc {
	struct input_dev *input;
	unsigned long quirks;

	int ntouches;
	int scroll_accel;
	unsigned long scroll_jiffies;

	struct {
		short x;
		short y;
		short scroll_x;
		short scroll_y;
		u8 size;
	} touches[16];
	int tracking_ids[16];
	int single_touch_id;
};

static int magicmouse_firm_touch(struct magicmouse_sc *msc)
{
	int touch = -1;
	int ii;

	/* If there is only one "firm" touch, set touch to its
	 * tracking ID.
	 */
	for (ii = 0; ii < msc->ntouches; ii++) {
		int idx = msc->tracking_ids[ii];
		if (msc->touches[idx].size < 8) {
			/* Ignore this touch. */
		} else if (touch >= 0) {
			touch = -1;
			break;
		} else {
			touch = idx;
		}
	}

	return touch;
}

static void magicmouse_emit_buttons(struct magicmouse_sc *msc, int state)
{
	int last_state = test_bit(BTN_LEFT, msc->input->key) << 0 |
		test_bit(BTN_RIGHT, msc->input->key) << 1 |
		test_bit(BTN_MIDDLE, msc->input->key) << 2;

	if (emulate_3button) {
		int id;

		/* If some button was pressed before, keep it held
		 * down.  Otherwise, if there's exactly one firm
		 * touch, use that to override the mouse's guess.
		 */
		if (state == 0) {
			/* The button was released. */
		} else if (last_state != 0) {
			state = last_state;
		} else if ((id = magicmouse_firm_touch(msc)) >= 0) {
			int x = msc->touches[id].x;
			if (x < middle_button_start)
				state = 1;
			else if (x > middle_button_stop)
				state = 2;
			else
				state = 4;
		} /* else: we keep the mouse's guess */

		input_report_key(msc->input, BTN_MIDDLE, state & 4);
	}

	input_report_key(msc->input, BTN_LEFT, state & 1);
	input_report_key(msc->input, BTN_RIGHT, state & 2);

	if (state != last_state)
		msc->scroll_accel = SCROLL_ACCEL_DEFAULT;
}

static void magicmouse_emit_touch(struct magicmouse_sc *msc, int raw_id, u8 *tdata)
{
	struct input_dev *input = msc->input;
	int id, x, y, size, orientation, touch_major, touch_minor, state, down;

	if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
		id = (tdata[6] << 2 | tdata[5] >> 6) & 0xf;
		x = (tdata[1] << 28 | tdata[0] << 20) >> 20;
		y = -((tdata[2] << 24 | tdata[1] << 16) >> 20);
		size = tdata[5] & 0x3f;
		orientation = (tdata[6] >> 2) - 32;
		touch_major = tdata[3];
		touch_minor = tdata[4];
		state = tdata[7] & TOUCH_STATE_MASK;
		down = state != TOUCH_STATE_NONE;
	} else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
		id = (tdata[7] << 2 | tdata[6] >> 6) & 0xf;
		x = (tdata[1] << 27 | tdata[0] << 19) >> 19;
		y = -((tdata[3] << 30 | tdata[2] << 22 | tdata[1] << 14) >> 19);
		size = tdata[6] & 0x3f;
		orientation = (tdata[7] >> 2) - 32;
		touch_major = tdata[4];
		touch_minor = tdata[5];
		state = tdata[8] & TOUCH_STATE_MASK;
		down = state != TOUCH_STATE_NONE;
	}

	/* Store tracking ID and other fields. */
	msc->tracking_ids[raw_id] = id;
	msc->touches[id].x = x;
	msc->touches[id].y = y;
	msc->touches[id].size = size;

	/* If requested, emulate a scroll wheel by detecting small
	 * vertical touch motions.
	 */
	if (emulate_scroll_wheel) {
		unsigned long now = jiffies;
		int step_x = msc->touches[id].scroll_x - x;
		int step_y = msc->touches[id].scroll_y - y;

		/* Calculate and apply the scroll motion. */
		switch (state) {
		case TOUCH_STATE_START:
			msc->touches[id].scroll_x = x;
			msc->touches[id].scroll_y = y;

			/* Reset acceleration after half a second. */
			if (scroll_acceleration && time_before(now,
						msc->scroll_jiffies + HZ / 2))
				msc->scroll_accel = max_t(int,
						msc->scroll_accel - 1, 1);
			else
				msc->scroll_accel = SCROLL_ACCEL_DEFAULT;

			break;
		case TOUCH_STATE_DRAG:
			step_x /= (64 - (int)scroll_speed) * msc->scroll_accel;
			if (step_x != 0) {
				msc->touches[id].scroll_x -= step_x *
					(64 - scroll_speed) * msc->scroll_accel;
				msc->scroll_jiffies = now;
				input_report_rel(input, REL_HWHEEL, -step_x);
			}

			step_y /= (64 - (int)scroll_speed) * msc->scroll_accel;
			if (step_y != 0) {
				msc->touches[id].scroll_y -= step_y *
					(64 - scroll_speed) * msc->scroll_accel;
				msc->scroll_jiffies = now;
				input_report_rel(input, REL_WHEEL, step_y);
			}
			break;
		}
	}

	if (down) {
		msc->ntouches++;
		if (msc->single_touch_id == NO_TOUCHES)
			msc->single_touch_id = id;
	} else if (msc->single_touch_id == id)
		msc->single_touch_id = SINGLE_TOUCH_UP;

	/* Generate the input events for this touch. */
	if (report_touches && down) {
		input_report_abs(input, ABS_MT_TRACKING_ID, id);
		input_report_abs(input, ABS_MT_TOUCH_MAJOR, touch_major);
		input_report_abs(input, ABS_MT_TOUCH_MINOR, touch_minor);
		input_report_abs(input, ABS_MT_ORIENTATION, orientation);
		input_report_abs(input, ABS_MT_POSITION_X, x);
		input_report_abs(input, ABS_MT_POSITION_Y, y);

		if (report_undeciphered) {
			if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE)
				input_event(input, EV_MSC, MSC_RAW, tdata[7]);
			else /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
				input_event(input, EV_MSC, MSC_RAW, tdata[8]);
		}

		input_mt_sync(input);
	}
}

static int magicmouse_raw_event(struct hid_device *hdev,
		struct hid_report *report, u8 *data, int size)
{
	struct magicmouse_sc *msc = hid_get_drvdata(hdev);
	struct input_dev *input = msc->input;
	int x = 0, y = 0, ii, clicks = 0, npoints;

	switch (data[0]) {
	case 0x10:
		if (size != 6)
			return 0;
		x = (__s16)(data[2] | data[3] << 8);
		y = (__s16)(data[4] | data[5] << 8);
		clicks = data[1];
		break;
	case TRACKPAD_REPORT_ID:
		/* Expect four bytes of prefix, and N*9 bytes of touch data. */
		if (size < 4 || ((size - 4) % 9) != 0)
			return 0;
		npoints = (size - 4) / 9;
		msc->ntouches = 0;
		for (ii = 0; ii < npoints; ii++)
			magicmouse_emit_touch(msc, ii, data + ii * 9 + 4);

		/* We don't need an MT sync here because trackpad emits a
		 * BTN_TOUCH event in a new frame when all touches are released.
		 */
		if (msc->ntouches == 0)
			msc->single_touch_id = NO_TOUCHES;

		clicks = data[1];

		/* The following bits provide a device specific timestamp. They
		 * are unused here.
		 *
		 * ts = data[1] >> 6 | data[2] << 2 | data[3] << 10;
		 */
		break;
	case MOUSE_REPORT_ID:
		/* Expect six bytes of prefix, and N*8 bytes of touch data. */
		if (size < 6 || ((size - 6) % 8) != 0)
			return 0;
		npoints = (size - 6) / 8;
		msc->ntouches = 0;
		for (ii = 0; ii < npoints; ii++)
			magicmouse_emit_touch(msc, ii, data + ii * 8 + 6);

		if (report_touches && msc->ntouches == 0)
			input_mt_sync(input);

		/* When emulating three-button mode, it is important
		 * to have the current touch information before
		 * generating a click event.
		 */
		x = (int)(((data[3] & 0x0c) << 28) | (data[1] << 22)) >> 22;
		y = (int)(((data[3] & 0x30) << 26) | (data[2] << 22)) >> 22;
		clicks = data[3];

		/* The following bits provide a device specific timestamp. They
		 * are unused here.
		 *
		 * ts = data[3] >> 6 | data[4] << 2 | data[5] << 10;
		 */
		break;
	case DOUBLE_REPORT_ID:
		/* Sometimes the trackpad sends two touch reports in one
		 * packet.
		 */
		magicmouse_raw_event(hdev, report, data + 2, data[1]);
		magicmouse_raw_event(hdev, report, data + 2 + data[1],
			size - 2 - data[1]);
		break;
	case 0x20: /* Theoretically battery status (0-100), but I have
		    * never seen it -- maybe it is only upon request.
		    */
	case 0x60: /* Unknown, maybe laser on/off. */
	case 0x61: /* Laser reflection status change.
		    * data[1]: 0 = spotted, 1 = lost
		    */
	default:
		return 0;
	}

	if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
		magicmouse_emit_buttons(msc, clicks & 3);
		input_report_rel(input, REL_X, x);
		input_report_rel(input, REL_Y, y);
	} else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
		input_report_key(input, BTN_MOUSE, clicks & 1);
		input_report_key(input, BTN_TOUCH, msc->ntouches > 0);
		input_report_key(input, BTN_TOOL_FINGER, msc->ntouches == 1);
		input_report_key(input, BTN_TOOL_DOUBLETAP, msc->ntouches == 2);
		input_report_key(input, BTN_TOOL_TRIPLETAP, msc->ntouches == 3);
		input_report_key(input, BTN_TOOL_QUADTAP, msc->ntouches == 4);
		if (msc->single_touch_id >= 0) {
			input_report_abs(input, ABS_X,
				msc->touches[msc->single_touch_id].x);
			input_report_abs(input, ABS_Y,
				msc->touches[msc->single_touch_id].y);
		}
	}

	input_sync(input);
	return 1;
}

static int magicmouse_input_open(struct input_dev *dev)
{
	struct hid_device *hid = input_get_drvdata(dev);

	return hid->ll_driver->open(hid);
}

static void magicmouse_input_close(struct input_dev *dev)
{
	struct hid_device *hid = input_get_drvdata(dev);

	hid->ll_driver->close(hid);
}

static void magicmouse_setup_input(struct input_dev *input, struct hid_device *hdev)
{
	input_set_drvdata(input, hdev);
	input->event = hdev->ll_driver->hidinput_input_event;
	input->open = magicmouse_input_open;
	input->close = magicmouse_input_close;

	input->name = hdev->name;
	input->phys = hdev->phys;
	input->uniq = hdev->uniq;
	input->id.bustype = hdev->bus;
	input->id.vendor = hdev->vendor;
	input->id.product = hdev->product;
	input->id.version = hdev->version;
	input->dev.parent = hdev->dev.parent;

	__set_bit(EV_KEY, input->evbit);

	if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
		__set_bit(BTN_LEFT, input->keybit);
		__set_bit(BTN_RIGHT, input->keybit);
		if (emulate_3button)
			__set_bit(BTN_MIDDLE, input->keybit);

		__set_bit(EV_REL, input->evbit);
		__set_bit(REL_X, input->relbit);
		__set_bit(REL_Y, input->relbit);
		if (emulate_scroll_wheel) {
			__set_bit(REL_WHEEL, input->relbit);
			__set_bit(REL_HWHEEL, input->relbit);
		}
	} else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
		__set_bit(BTN_MOUSE, input->keybit);
		__set_bit(BTN_TOOL_FINGER, input->keybit);
		__set_bit(BTN_TOOL_DOUBLETAP, input->keybit);
		__set_bit(BTN_TOOL_TRIPLETAP, input->keybit);
		__set_bit(BTN_TOOL_QUADTAP, input->keybit);
		__set_bit(BTN_TOUCH, input->keybit);
	}

	if (report_touches) {
		__set_bit(EV_ABS, input->evbit);

		input_set_abs_params(input, ABS_MT_TRACKING_ID, 0, 15, 0, 0);
		input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 255, 4, 0);
		input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 255, 4, 0);
		input_set_abs_params(input, ABS_MT_ORIENTATION, -32, 31, 1, 0);

		/* Note: Touch Y position from the device is inverted relative
		 * to how pointer motion is reported (and relative to how USB
		 * HID recommends the coordinates work).  This driver keeps
		 * the origin at the same position, and just uses the additive
		 * inverse of the reported Y.
		 */
		if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
			input_set_abs_params(input, ABS_MT_POSITION_X, -1100,
				1358, 4, 0);
			input_set_abs_params(input, ABS_MT_POSITION_Y, -1589,
				2047, 4, 0);
		} else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
			input_set_abs_params(input, ABS_X, -2909, 3167, 4, 0);
			input_set_abs_params(input, ABS_Y, -2456, 2565, 4, 0);
			input_set_abs_params(input, ABS_MT_POSITION_X, -2909,
				3167, 4, 0);
			input_set_abs_params(input, ABS_MT_POSITION_Y, -2456,
				2565, 4, 0);
		}
	}

	if (report_undeciphered) {
		__set_bit(EV_MSC, input->evbit);
		__set_bit(MSC_RAW, input->mscbit);
	}
}

static int magicmouse_probe(struct hid_device *hdev,
	const struct hid_device_id *id)
{
	__u8 feature[] = { 0xd7, 0x01 };
	struct input_dev *input;
	struct magicmouse_sc *msc;
	struct hid_report *report;
	int ret;

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

	msc->scroll_accel = SCROLL_ACCEL_DEFAULT;

	msc->quirks = id->driver_data;
	hid_set_drvdata(hdev, msc);

	msc->single_touch_id = NO_TOUCHES;

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

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

	/* we are handling the input ourselves */
	hidinput_disconnect(hdev);

	if (id->product == USB_DEVICE_ID_APPLE_MAGICMOUSE)
		report = hid_register_report(hdev, HID_INPUT_REPORT,
			MOUSE_REPORT_ID);
	else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
		report = hid_register_report(hdev, HID_INPUT_REPORT,
			TRACKPAD_REPORT_ID);
		report = hid_register_report(hdev, HID_INPUT_REPORT,
			DOUBLE_REPORT_ID);
	}

	if (!report) {
		dev_err(&hdev->dev, "unable to register touch report\n");
		ret = -ENOMEM;
		goto err_stop_hw;
	}
	report->size = 6;

	ret = hdev->hid_output_raw_report(hdev, feature, sizeof(feature),
			HID_FEATURE_REPORT);
	if (ret != sizeof(feature)) {
		dev_err(&hdev->dev, "unable to request touch data (%d)\n",
				ret);
		goto err_stop_hw;
	}

	input = input_allocate_device();
	if (!input) {
		dev_err(&hdev->dev, "can't alloc input device\n");
		ret = -ENOMEM;
		goto err_stop_hw;
	}
	magicmouse_setup_input(input, hdev);

	ret = input_register_device(input);
	if (ret) {
		dev_err(&hdev->dev, "input device registration failed\n");
		goto err_input;
	}
	msc->input = input;

	return 0;
err_input:
	input_free_device(input);
err_stop_hw:
	hid_hw_stop(hdev);
err_free:
	kfree(msc);
	return ret;
}

static void magicmouse_remove(struct hid_device *hdev)
{
	struct magicmouse_sc *msc = hid_get_drvdata(hdev);

	hid_hw_stop(hdev);
	input_unregister_device(msc->input);
	kfree(msc);
}

static const struct hid_device_id magic_mice[] = {
	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
		USB_DEVICE_ID_APPLE_MAGICMOUSE), .driver_data = 0 },
	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
		USB_DEVICE_ID_APPLE_MAGICTRACKPAD), .driver_data = 0 },
	{ }
};
MODULE_DEVICE_TABLE(hid, magic_mice);

static struct hid_driver magicmouse_driver = {
	.name = "magicmouse",
	.id_table = magic_mice,
	.probe = magicmouse_probe,
	.remove = magicmouse_remove,
	.raw_event = magicmouse_raw_event,
};

static int __init magicmouse_init(void)
{
	int ret;

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

	return ret;
}

static void __exit magicmouse_exit(void)
{
	hid_unregister_driver(&magicmouse_driver);
}

module_init(magicmouse_init);
module_exit(magicmouse_exit);
MODULE_LICENSE("GPL");
Commit	Line	Data
128537ce MP	1	/*
	2	* Apple "Magic" Wireless Mouse driver
	3	*
	4	* Copyright (c) 2010 Michael Poole <mdpoole@troilus.org>
a462230e	5	* Copyright (c) 2010 Chase Douglas <chase.douglas@canonical.com>
128537ce MP	6	*/
	7
	8	/*
	9	* This program is free software; you can redistribute it and/or modify it
	10	* under the terms of the GNU General Public License as published by the Free
	11	* Software Foundation; either version 2 of the License, or (at your option)
	12	* any later version.
	13	*/
	14
	15	#include <linux/device.h>
	16	#include <linux/hid.h>
	17	#include <linux/module.h>
5a0e3ad6	18	#include <linux/slab.h>
128537ce MP	19	#include <linux/usb.h>
	20
	21	#include "hid-ids.h"
	22
71b38bd4	23	static bool emulate_3button = true;
128537ce MP	24	module_param(emulate_3button, bool, 0644);
	25	MODULE_PARM_DESC(emulate_3button, "Emulate a middle button");
	26
	27	static int middle_button_start = -350;
	28	static int middle_button_stop = +350;
	29
71b38bd4	30	static bool emulate_scroll_wheel = true;
128537ce MP	31	module_param(emulate_scroll_wheel, bool, 0644);
	32	MODULE_PARM_DESC(emulate_scroll_wheel, "Emulate a scroll wheel");
	33
0b778e76 CD	34	static unsigned int scroll_speed = 32;
	35	static int param_set_scroll_speed(const char val, struct kernel_param kp) {
	36	unsigned long speed;
	37	if (!val \|\| strict_strtoul(val, 0, &speed) \|\| speed > 63)
	38	return -EINVAL;
	39	scroll_speed = speed;
	40	return 0;
	41	}
	42	module_param_call(scroll_speed, param_set_scroll_speed, param_get_uint, &scroll_speed, 0644);
	43	MODULE_PARM_DESC(scroll_speed, "Scroll speed, value from 0 (slow) to 63 (fast)");
	44
9846f350 CD	45	static bool scroll_acceleration = false;
	46	module_param(scroll_acceleration, bool, 0644);
	47	MODULE_PARM_DESC(scroll_acceleration, "Accelerate sequential scroll events");
	48
71b38bd4	49	static bool report_touches = true;
128537ce MP	50	module_param(report_touches, bool, 0644);
	51	MODULE_PARM_DESC(report_touches, "Emit touch records (otherwise, only use them for emulation)");
	52
71b38bd4	53	static bool report_undeciphered;
128537ce MP	54	module_param(report_undeciphered, bool, 0644);
	55	MODULE_PARM_DESC(report_undeciphered, "Report undeciphered multi-touch state field using a MSC_RAW event");
	56
a462230e CD	57	#define TRACKPAD_REPORT_ID 0x28
	58	#define MOUSE_REPORT_ID 0x29
	59	#define DOUBLE_REPORT_ID 0xf7
128537ce MP	60	/* These definitions are not precise, but they're close enough. (Bits
	61	* 0x03 seem to indicate the aspect ratio of the touch, bits 0x70 seem
	62	* to be some kind of bit mask -- 0x20 may be a near-field reading,
	63	* and 0x40 is actual contact, and 0x10 may be a start/stop or change
	64	* indication.)
	65	*/
	66	#define TOUCH_STATE_MASK 0xf0
	67	#define TOUCH_STATE_NONE 0x00
	68	#define TOUCH_STATE_START 0x30
	69	#define TOUCH_STATE_DRAG 0x40
	70
0b778e76 CD	71	#define SCROLL_ACCEL_DEFAULT 7
0b778e76 CD	72
a462230e CD	73	/* Single touch emulation should only begin when no touches are currently down.
	74	* This is true when single_touch_id is equal to NO_TOUCHES. If multiple touches
	75	* are down and the touch providing for single touch emulation is lifted,
	76	* single_touch_id is equal to SINGLE_TOUCH_UP. While single touch emulation is
	77	* occuring, single_touch_id corresponds with the tracking id of the touch used.
	78	*/
	79	#define NO_TOUCHES -1
	80	#define SINGLE_TOUCH_UP -2
	81
128537ce MP	82	/**
	83	* struct magicmouse_sc - Tracks Magic Mouse-specific data.
	84	* @input: Input device through which we report events.
	85	* @quirks: Currently unused.
128537ce MP	86	* @ntouches: Number of touches in most recent touch report.
	87	* @scroll_accel: Number of consecutive scroll motions.
	88	* @scroll_jiffies: Time of last scroll motion.
	89	* @touches: Most recent data for a touch, indexed by tracking ID.
	90	* @tracking_ids: Mapping of current touch input data to @touches.
	91	*/
	92	struct magicmouse_sc {
	93	struct input_dev *input;
	94	unsigned long quirks;
	95
128537ce MP	96	int ntouches;
	97	int scroll_accel;
	98	unsigned long scroll_jiffies;
	99
	100	struct {
	101	short x;
	102	short y;
c0426688	103	short scroll_x;
128537ce MP	104	short scroll_y;
	105	u8 size;
	106	} touches[16];
	107	int tracking_ids[16];
a462230e	108	int single_touch_id;
128537ce MP	109	};
	110
	111	static int magicmouse_firm_touch(struct magicmouse_sc *msc)
	112	{
	113	int touch = -1;
	114	int ii;
	115
	116	/* If there is only one "firm" touch, set touch to its
	117	* tracking ID.
	118	*/
	119	for (ii = 0; ii < msc->ntouches; ii++) {
	120	int idx = msc->tracking_ids[ii];
	121	if (msc->touches[idx].size < 8) {
	122	/* Ignore this touch. */
	123	} else if (touch >= 0) {
	124	touch = -1;
	125	break;
	126	} else {
	127	touch = idx;
	128	}
	129	}
	130
	131	return touch;
	132	}
	133
	134	static void magicmouse_emit_buttons(struct magicmouse_sc *msc, int state)
	135	{
71b38bd4 MP	136	int last_state = test_bit(BTN_LEFT, msc->input->key) << 0 \|
	137	test_bit(BTN_RIGHT, msc->input->key) << 1 \|
	138	test_bit(BTN_MIDDLE, msc->input->key) << 2;
128537ce MP	139
	140	if (emulate_3button) {
	141	int id;
	142
	143	/* If some button was pressed before, keep it held
	144	* down. Otherwise, if there's exactly one firm
	145	* touch, use that to override the mouse's guess.
	146	*/
	147	if (state == 0) {
	148	/* The button was released. */
	149	} else if (last_state != 0) {
	150	state = last_state;
	151	} else if ((id = magicmouse_firm_touch(msc)) >= 0) {
	152	int x = msc->touches[id].x;
	153	if (x < middle_button_start)
	154	state = 1;
	155	else if (x > middle_button_stop)
	156	state = 2;
	157	else
	158	state = 4;
	159	} /* else: we keep the mouse's guess */
	160
	161	input_report_key(msc->input, BTN_MIDDLE, state & 4);
	162	}
	163
	164	input_report_key(msc->input, BTN_LEFT, state & 1);
	165	input_report_key(msc->input, BTN_RIGHT, state & 2);
	166
	167	if (state != last_state)
0b778e76	168	msc->scroll_accel = SCROLL_ACCEL_DEFAULT;
128537ce MP	169	}
	170
	171	static void magicmouse_emit_touch(struct magicmouse_sc msc, int raw_id, u8 tdata)
	172	{
	173	struct input_dev *input = msc->input;
a462230e CD	174	int id, x, y, size, orientation, touch_major, touch_minor, state, down;
	175
	176	if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
	177	id = (tdata[6] << 2 \| tdata[5] >> 6) & 0xf;
	178	x = (tdata[1] << 28 \| tdata[0] << 20) >> 20;
	179	y = -((tdata[2] << 24 \| tdata[1] << 16) >> 20);
	180	size = tdata[5] & 0x3f;
	181	orientation = (tdata[6] >> 2) - 32;
	182	touch_major = tdata[3];
	183	touch_minor = tdata[4];
	184	state = tdata[7] & TOUCH_STATE_MASK;
	185	down = state != TOUCH_STATE_NONE;
	186	} else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
	187	id = (tdata[7] << 2 \| tdata[6] >> 6) & 0xf;
	188	x = (tdata[1] << 27 \| tdata[0] << 19) >> 19;
	189	y = -((tdata[3] << 30 \| tdata[2] << 22 \| tdata[1] << 14) >> 19);
	190	size = tdata[6] & 0x3f;
	191	orientation = (tdata[7] >> 2) - 32;
	192	touch_major = tdata[4];
	193	touch_minor = tdata[5];
	194	state = tdata[8] & TOUCH_STATE_MASK;
	195	down = state != TOUCH_STATE_NONE;
	196	}
128537ce MP	197
	198	/* Store tracking ID and other fields. */
	199	msc->tracking_ids[raw_id] = id;
	200	msc->touches[id].x = x;
	201	msc->touches[id].y = y;
6de048bf	202	msc->touches[id].size = size;
128537ce MP	203
128537ce MP	204	/* If requested, emulate a scroll wheel by detecting small
ef566d30	205	* vertical touch motions.
128537ce	206	*/
ef566d30	207	if (emulate_scroll_wheel) {
128537ce	208	unsigned long now = jiffies;
c0426688 CD	209	int step_x = msc->touches[id].scroll_x - x;
c0426688 CD	210	int step_y = msc->touches[id].scroll_y - y;
128537ce	211
128537ce	212	/* Calculate and apply the scroll motion. */
6de048bf	213	switch (state) {
128537ce	214	case TOUCH_STATE_START:
c0426688	215	msc->touches[id].scroll_x = x;
128537ce	216	msc->touches[id].scroll_y = y;
0b778e76 CD	217
	218	/* Reset acceleration after half a second. */
	219	if (scroll_acceleration && time_before(now,
	220	msc->scroll_jiffies + HZ / 2))
	221	msc->scroll_accel = max_t(int,
	222	msc->scroll_accel - 1, 1);
	223	else
	224	msc->scroll_accel = SCROLL_ACCEL_DEFAULT;
	225
128537ce MP	226	break;
128537ce MP	227	case TOUCH_STATE_DRAG:
c0426688 CD	228	step_x /= (64 - (int)scroll_speed) * msc->scroll_accel;
	229	if (step_x != 0) {
	230	msc->touches[id].scroll_x -= step_x *
0b778e76	231	(64 - scroll_speed) * msc->scroll_accel;
128537ce	232	msc->scroll_jiffies = now;
c0426688 CD	233	input_report_rel(input, REL_HWHEEL, -step_x);
	234	}
	235
	236	step_y /= (64 - (int)scroll_speed) * msc->scroll_accel;
	237	if (step_y != 0) {
	238	msc->touches[id].scroll_y -= step_y *
	239	(64 - scroll_speed) * msc->scroll_accel;
	240	msc->scroll_jiffies = now;
	241	input_report_rel(input, REL_WHEEL, step_y);
128537ce MP	242	}
	243	break;
	244	}
	245	}
	246
a462230e CD	247	if (down) {
	248	msc->ntouches++;
	249	if (msc->single_touch_id == NO_TOUCHES)
	250	msc->single_touch_id = id;
	251	} else if (msc->single_touch_id == id)
	252	msc->single_touch_id = SINGLE_TOUCH_UP;
	253
128537ce	254	/* Generate the input events for this touch. */
e3612e86	255	if (report_touches && down) {
128537ce	256	input_report_abs(input, ABS_MT_TRACKING_ID, id);
6de048bf CD	257	input_report_abs(input, ABS_MT_TOUCH_MAJOR, touch_major);
6de048bf CD	258	input_report_abs(input, ABS_MT_TOUCH_MINOR, touch_minor);
128537ce MP	259	input_report_abs(input, ABS_MT_ORIENTATION, orientation);
	260	input_report_abs(input, ABS_MT_POSITION_X, x);
	261	input_report_abs(input, ABS_MT_POSITION_Y, y);
	262
a462230e CD	263	if (report_undeciphered) {
	264	if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE)
	265	input_event(input, EV_MSC, MSC_RAW, tdata[7]);
	266	else /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
	267	input_event(input, EV_MSC, MSC_RAW, tdata[8]);
	268	}
128537ce MP	269
	270	input_mt_sync(input);
	271	}
	272	}
	273
	274	static int magicmouse_raw_event(struct hid_device *hdev,
	275	struct hid_report report, u8 data, int size)
	276	{
	277	struct magicmouse_sc *msc = hid_get_drvdata(hdev);
	278	struct input_dev *input = msc->input;
a462230e	279	int x = 0, y = 0, ii, clicks = 0, npoints;
128537ce MP	280
	281	switch (data[0]) {
	282	case 0x10:
	283	if (size != 6)
	284	return 0;
	285	x = (__s16)(data[2] \| data[3] << 8);
	286	y = (__s16)(data[4] \| data[5] << 8);
	287	clicks = data[1];
	288	break;
a462230e CD	289	case TRACKPAD_REPORT_ID:
	290	/* Expect four bytes of prefix, and N9 bytes of touch data. /
	291	if (size < 4 \|\| ((size - 4) % 9) != 0)
	292	return 0;
	293	npoints = (size - 4) / 9;
	294	msc->ntouches = 0;
	295	for (ii = 0; ii < npoints; ii++)
	296	magicmouse_emit_touch(msc, ii, data + ii * 9 + 4);
	297
	298	/* We don't need an MT sync here because trackpad emits a
	299	* BTN_TOUCH event in a new frame when all touches are released.
	300	*/
	301	if (msc->ntouches == 0)
	302	msc->single_touch_id = NO_TOUCHES;
	303
	304	clicks = data[1];
	305
	306	/* The following bits provide a device specific timestamp. They
	307	* are unused here.
	308	*
	309	* ts = data[1] >> 6 \| data[2] << 2 \| data[3] << 10;
	310	*/
	311	break;
	312	case MOUSE_REPORT_ID:
128537ce MP	313	/* Expect six bytes of prefix, and N8 bytes of touch data. /
	314	if (size < 6 \|\| ((size - 6) % 8) != 0)
	315	return 0;
0228db70 CD	316	npoints = (size - 6) / 8;
	317	msc->ntouches = 0;
	318	for (ii = 0; ii < npoints; ii++)
128537ce	319	magicmouse_emit_touch(msc, ii, data + ii * 8 + 6);
e3612e86	320
0228db70 CD	321	if (report_touches && msc->ntouches == 0)
0228db70 CD	322	input_mt_sync(input);
e3612e86	323
128537ce MP	324	/* When emulating three-button mode, it is important
	325	* to have the current touch information before
	326	* generating a click event.
	327	*/
7d876c05 MP	328	x = (int)(((data[3] & 0x0c) << 28) \| (data[1] << 22)) >> 22;
7d876c05 MP	329	y = (int)(((data[3] & 0x30) << 26) \| (data[2] << 22)) >> 22;
128537ce	330	clicks = data[3];
c61b7cee CD	331
	332	/* The following bits provide a device specific timestamp. They
	333	* are unused here.
	334	*
	335	* ts = data[3] >> 6 \| data[4] << 2 \| data[5] << 10;
	336	*/
128537ce	337	break;
a462230e CD	338	case DOUBLE_REPORT_ID:
	339	/* Sometimes the trackpad sends two touch reports in one
	340	* packet.
	341	*/
	342	magicmouse_raw_event(hdev, report, data + 2, data[1]);
	343	magicmouse_raw_event(hdev, report, data + 2 + data[1],
	344	size - 2 - data[1]);
	345	break;
128537ce MP	346	case 0x20: /* Theoretically battery status (0-100), but I have
	347	* never seen it -- maybe it is only upon request.
	348	*/
	349	case 0x60: /* Unknown, maybe laser on/off. */
	350	case 0x61: /* Laser reflection status change.
	351	* data[1]: 0 = spotted, 1 = lost
	352	*/
	353	default:
	354	return 0;
	355	}
	356
a462230e CD	357	if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
	358	magicmouse_emit_buttons(msc, clicks & 3);
	359	input_report_rel(input, REL_X, x);
	360	input_report_rel(input, REL_Y, y);
	361	} else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
	362	input_report_key(input, BTN_MOUSE, clicks & 1);
	363	input_report_key(input, BTN_TOUCH, msc->ntouches > 0);
	364	input_report_key(input, BTN_TOOL_FINGER, msc->ntouches == 1);
	365	input_report_key(input, BTN_TOOL_DOUBLETAP, msc->ntouches == 2);
	366	input_report_key(input, BTN_TOOL_TRIPLETAP, msc->ntouches == 3);
	367	input_report_key(input, BTN_TOOL_QUADTAP, msc->ntouches == 4);
	368	if (msc->single_touch_id >= 0) {
	369	input_report_abs(input, ABS_X,
	370	msc->touches[msc->single_touch_id].x);
	371	input_report_abs(input, ABS_Y,
	372	msc->touches[msc->single_touch_id].y);
	373	}
	374	}
	375
128537ce MP	376	input_sync(input);
	377	return 1;
	378	}
	379
	380	static int magicmouse_input_open(struct input_dev *dev)
	381	{
	382	struct hid_device *hid = input_get_drvdata(dev);
	383
	384	return hid->ll_driver->open(hid);
	385	}
	386
	387	static void magicmouse_input_close(struct input_dev *dev)
	388	{
	389	struct hid_device *hid = input_get_drvdata(dev);
	390
	391	hid->ll_driver->close(hid);
	392	}
	393
	394	static void magicmouse_setup_input(struct input_dev input, struct hid_device hdev)
	395	{
	396	input_set_drvdata(input, hdev);
	397	input->event = hdev->ll_driver->hidinput_input_event;
	398	input->open = magicmouse_input_open;
	399	input->close = magicmouse_input_close;
	400
	401	input->name = hdev->name;
	402	input->phys = hdev->phys;
	403	input->uniq = hdev->uniq;
	404	input->id.bustype = hdev->bus;
	405	input->id.vendor = hdev->vendor;
	406	input->id.product = hdev->product;
	407	input->id.version = hdev->version;
	408	input->dev.parent = hdev->dev.parent;
	409
71b38bd4	410	__set_bit(EV_KEY, input->evbit);
a462230e CD	411
	412	if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
	413	__set_bit(BTN_LEFT, input->keybit);
	414	__set_bit(BTN_RIGHT, input->keybit);
	415	if (emulate_3button)
	416	__set_bit(BTN_MIDDLE, input->keybit);
	417
	418	__set_bit(EV_REL, input->evbit);
	419	__set_bit(REL_X, input->relbit);
	420	__set_bit(REL_Y, input->relbit);
	421	if (emulate_scroll_wheel) {
	422	__set_bit(REL_WHEEL, input->relbit);
	423	__set_bit(REL_HWHEEL, input->relbit);
	424	}
	425	} else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
	426	__set_bit(BTN_MOUSE, input->keybit);
	427	__set_bit(BTN_TOOL_FINGER, input->keybit);
	428	__set_bit(BTN_TOOL_DOUBLETAP, input->keybit);
	429	__set_bit(BTN_TOOL_TRIPLETAP, input->keybit);
	430	__set_bit(BTN_TOOL_QUADTAP, input->keybit);
	431	__set_bit(BTN_TOUCH, input->keybit);
c0426688	432	}
128537ce MP	433
128537ce MP	434	if (report_touches) {
71b38bd4 MP	435	__set_bit(EV_ABS, input->evbit);
	436
	437	input_set_abs_params(input, ABS_MT_TRACKING_ID, 0, 15, 0, 0);
	438	input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 255, 4, 0);
	439	input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 255, 4, 0);
	440	input_set_abs_params(input, ABS_MT_ORIENTATION, -32, 31, 1, 0);
a462230e	441
128537ce MP	442	/* Note: Touch Y position from the device is inverted relative
	443	* to how pointer motion is reported (and relative to how USB
	444	* HID recommends the coordinates work). This driver keeps
	445	* the origin at the same position, and just uses the additive
	446	* inverse of the reported Y.
	447	*/
a462230e CD	448	if (input->id.product == USB_DEVICE_ID_APPLE_MAGICMOUSE) {
	449	input_set_abs_params(input, ABS_MT_POSITION_X, -1100,
	450	1358, 4, 0);
	451	input_set_abs_params(input, ABS_MT_POSITION_Y, -1589,
	452	2047, 4, 0);
	453	} else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
	454	input_set_abs_params(input, ABS_X, -2909, 3167, 4, 0);
	455	input_set_abs_params(input, ABS_Y, -2456, 2565, 4, 0);
	456	input_set_abs_params(input, ABS_MT_POSITION_X, -2909,
	457	3167, 4, 0);
	458	input_set_abs_params(input, ABS_MT_POSITION_Y, -2456,
	459	2565, 4, 0);
	460	}
128537ce MP	461	}
	462
	463	if (report_undeciphered) {
71b38bd4 MP	464	__set_bit(EV_MSC, input->evbit);
71b38bd4 MP	465	__set_bit(MSC_RAW, input->mscbit);
128537ce MP	466	}
	467	}
	468
	469	static int magicmouse_probe(struct hid_device *hdev,
	470	const struct hid_device_id *id)
	471	{
0773590c	472	__u8 feature[] = { 0xd7, 0x01 };
128537ce MP	473	struct input_dev *input;
	474	struct magicmouse_sc *msc;
	475	struct hid_report *report;
	476	int ret;
	477
	478	msc = kzalloc(sizeof(*msc), GFP_KERNEL);
	479	if (msc == NULL) {
	480	dev_err(&hdev->dev, "can't alloc magicmouse descriptor\n");
	481	return -ENOMEM;
	482	}
	483
0b778e76 CD	484	msc->scroll_accel = SCROLL_ACCEL_DEFAULT;
0b778e76 CD	485
128537ce MP	486	msc->quirks = id->driver_data;
	487	hid_set_drvdata(hdev, msc);
	488
a462230e CD	489	msc->single_touch_id = NO_TOUCHES;
a462230e CD	490
128537ce MP	491	ret = hid_parse(hdev);
	492	if (ret) {
	493	dev_err(&hdev->dev, "magicmouse hid parse failed\n");
	494	goto err_free;
	495	}
	496
23d02116	497	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
128537ce MP	498	if (ret) {
	499	dev_err(&hdev->dev, "magicmouse hw start failed\n");
	500	goto err_free;
	501	}
	502
23d02116 JK	503	/* we are handling the input ourselves */
	504	hidinput_disconnect(hdev);
	505
a462230e CD	506	if (id->product == USB_DEVICE_ID_APPLE_MAGICMOUSE)
	507	report = hid_register_report(hdev, HID_INPUT_REPORT,
	508	MOUSE_REPORT_ID);
	509	else { /* USB_DEVICE_ID_APPLE_MAGICTRACKPAD */
	510	report = hid_register_report(hdev, HID_INPUT_REPORT,
	511	TRACKPAD_REPORT_ID);
	512	report = hid_register_report(hdev, HID_INPUT_REPORT,
	513	DOUBLE_REPORT_ID);
	514	}
	515
128537ce MP	516	if (!report) {
	517	dev_err(&hdev->dev, "unable to register touch report\n");
	518	ret = -ENOMEM;
71b38bd4	519	goto err_stop_hw;
128537ce MP	520	}
	521	report->size = 6;
	522
0773590c	523	ret = hdev->hid_output_raw_report(hdev, feature, sizeof(feature),
128537ce	524	HID_FEATURE_REPORT);
0773590c CD	525	if (ret != sizeof(feature)) {
0773590c CD	526	dev_err(&hdev->dev, "unable to request touch data (%d)\n",
128537ce	527	ret);
71b38bd4	528	goto err_stop_hw;
128537ce MP	529	}
	530
	531	input = input_allocate_device();
	532	if (!input) {
	533	dev_err(&hdev->dev, "can't alloc input device\n");
	534	ret = -ENOMEM;
71b38bd4	535	goto err_stop_hw;
128537ce MP	536	}
	537	magicmouse_setup_input(input, hdev);
	538
	539	ret = input_register_device(input);
	540	if (ret) {
	541	dev_err(&hdev->dev, "input device registration failed\n");
71b38bd4	542	goto err_input;
128537ce MP	543	}
	544	msc->input = input;
	545
	546	return 0;
71b38bd4	547	err_input:
128537ce	548	input_free_device(input);
71b38bd4 MP	549	err_stop_hw:
	550	hid_hw_stop(hdev);
	551	err_free:
128537ce MP	552	kfree(msc);
	553	return ret;
	554	}
	555
	556	static void magicmouse_remove(struct hid_device *hdev)
	557	{
28918c21 MP	558	struct magicmouse_sc *msc = hid_get_drvdata(hdev);
28918c21 MP	559
128537ce	560	hid_hw_stop(hdev);
28918c21 MP	561	input_unregister_device(msc->input);
28918c21 MP	562	kfree(msc);
128537ce MP	563	}
	564
	565	static const struct hid_device_id magic_mice[] = {
a462230e CD	566	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
	567	USB_DEVICE_ID_APPLE_MAGICMOUSE), .driver_data = 0 },
	568	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
	569	USB_DEVICE_ID_APPLE_MAGICTRACKPAD), .driver_data = 0 },
128537ce MP	570	{ }
	571	};
	572	MODULE_DEVICE_TABLE(hid, magic_mice);
	573
	574	static struct hid_driver magicmouse_driver = {
	575	.name = "magicmouse",
	576	.id_table = magic_mice,
	577	.probe = magicmouse_probe,
	578	.remove = magicmouse_remove,
	579	.raw_event = magicmouse_raw_event,
	580	};
	581
	582	static int __init magicmouse_init(void)
	583	{
	584	int ret;
	585
	586	ret = hid_register_driver(&magicmouse_driver);
	587	if (ret)
	588	printk(KERN_ERR "can't register magicmouse driver\n");
	589
	590	return ret;
	591	}
	592
	593	static void __exit magicmouse_exit(void)
	594	{
	595	hid_unregister_driver(&magicmouse_driver);
	596	}
	597
	598	module_init(magicmouse_init);
	599	module_exit(magicmouse_exit);
	600	MODULE_LICENSE("GPL");