[deliverable/linux.git] / drivers / input / touchscreen / wacom_w8001.c

/*
 * Wacom W8001 penabled serial touchscreen driver
 *
 * Copyright (c) 2008 Jaya Kumar
 * Copyright (c) 2010 Red Hat, Inc.
 * Copyright (c) 2010 - 2011 Ping Cheng, Wacom. <pingc@wacom.com>
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License. See the file COPYING in the main directory of this archive for
 * more details.
 *
 * Layout based on Elo serial touchscreen driver by Vojtech Pavlik
 */

#include <linux/errno.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/input/mt.h>
#include <linux/serio.h>
#include <linux/ctype.h>
#include <linux/delay.h>

#define DRIVER_DESC	"Wacom W8001 serial touchscreen driver"

MODULE_AUTHOR("Jaya Kumar <jayakumar.lkml@gmail.com>");
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");

#define W8001_MAX_LENGTH	11
#define W8001_LEAD_MASK		0x80
#define W8001_LEAD_BYTE		0x80
#define W8001_TAB_MASK		0x40
#define W8001_TAB_BYTE		0x40
/* set in first byte of touch data packets */
#define W8001_TOUCH_MASK	(0x10 | W8001_LEAD_MASK)
#define W8001_TOUCH_BYTE	(0x10 | W8001_LEAD_BYTE)

#define W8001_QUERY_PACKET	0x20

#define W8001_CMD_STOP		'0'
#define W8001_CMD_START		'1'
#define W8001_CMD_QUERY		'*'
#define W8001_CMD_TOUCHQUERY	'%'

/* length of data packets in bytes, depends on device. */
#define W8001_PKTLEN_TOUCH93	5
#define W8001_PKTLEN_TOUCH9A	7
#define W8001_PKTLEN_TPCPEN	9
#define W8001_PKTLEN_TPCCTL	11	/* control packet */
#define W8001_PKTLEN_TOUCH2FG	13

/* resolution in points/mm */
#define W8001_PEN_RESOLUTION    100
#define W8001_TOUCH_RESOLUTION  10

struct w8001_coord {
	u8 rdy;
	u8 tsw;
	u8 f1;
	u8 f2;
	u16 x;
	u16 y;
	u16 pen_pressure;
	u8 tilt_x;
	u8 tilt_y;
};

/* touch query reply packet */
struct w8001_touch_query {
	u16 x;
	u16 y;
	u8 panel_res;
	u8 capacity_res;
	u8 sensor_id;
};

/*
 * Per-touchscreen data.
 */

struct w8001 {
	struct input_dev *dev;
	struct serio *serio;
	struct completion cmd_done;
	int id;
	int idx;
	unsigned char response_type;
	unsigned char response[W8001_MAX_LENGTH];
	unsigned char data[W8001_MAX_LENGTH];
	char phys[32];
	int type;
	unsigned int pktlen;
	u16 max_touch_x;
	u16 max_touch_y;
	u16 max_pen_x;
	u16 max_pen_y;
	char name[64];
};

static void parse_pen_data(u8 *data, struct w8001_coord *coord)
{
	memset(coord, 0, sizeof(*coord));

	coord->rdy = data[0] & 0x20;
	coord->tsw = data[0] & 0x01;
	coord->f1 = data[0] & 0x02;
	coord->f2 = data[0] & 0x04;

	coord->x = (data[1] & 0x7F) << 9;
	coord->x |= (data[2] & 0x7F) << 2;
	coord->x |= (data[6] & 0x60) >> 5;

	coord->y = (data[3] & 0x7F) << 9;
	coord->y |= (data[4] & 0x7F) << 2;
	coord->y |= (data[6] & 0x18) >> 3;

	coord->pen_pressure = data[5] & 0x7F;
	coord->pen_pressure |= (data[6] & 0x07) << 7 ;

	coord->tilt_x = data[7] & 0x7F;
	coord->tilt_y = data[8] & 0x7F;
}

static void parse_single_touch(u8 *data, struct w8001_coord *coord)
{
	coord->x = (data[1] << 7) | data[2];
	coord->y = (data[3] << 7) | data[4];
	coord->tsw = data[0] & 0x01;
}

static void scale_touch_coordinates(struct w8001 *w8001,
				    unsigned int *x, unsigned int *y)
{
	if (w8001->max_pen_x && w8001->max_touch_x)
		*x = *x * w8001->max_pen_x / w8001->max_touch_x;

	if (w8001->max_pen_y && w8001->max_touch_y)
		*y = *y * w8001->max_pen_y / w8001->max_touch_y;
}

static void parse_multi_touch(struct w8001 *w8001)
{
	struct input_dev *dev = w8001->dev;
	unsigned char *data = w8001->data;
	unsigned int x, y;
	int i;
	int count = 0;

	for (i = 0; i < 2; i++) {
		bool touch = data[0] & (1 << i);

		input_mt_slot(dev, i);
		input_mt_report_slot_state(dev, MT_TOOL_FINGER, touch);
		if (touch) {
			x = (data[6 * i + 1] << 7) | data[6 * i + 2];
			y = (data[6 * i + 3] << 7) | data[6 * i + 4];
			/* data[5,6] and [11,12] is finger capacity */

			/* scale to pen maximum */
			scale_touch_coordinates(w8001, &x, &y);

			input_report_abs(dev, ABS_MT_POSITION_X, x);
			input_report_abs(dev, ABS_MT_POSITION_Y, y);
			count++;
		}
	}

	/* emulate single touch events when stylus is out of proximity.
	 * This is to make single touch backward support consistent
	 * across all Wacom single touch devices.
	 */
	if (w8001->type != BTN_TOOL_PEN &&
			    w8001->type != BTN_TOOL_RUBBER) {
		w8001->type = count == 1 ? BTN_TOOL_FINGER : KEY_RESERVED;
		input_mt_report_pointer_emulation(dev, true);
	}

	input_sync(dev);
}

static void parse_touchquery(u8 *data, struct w8001_touch_query *query)
{
	memset(query, 0, sizeof(*query));

	query->panel_res = data[1];
	query->sensor_id = data[2] & 0x7;
	query->capacity_res = data[7];

	query->x = data[3] << 9;
	query->x |= data[4] << 2;
	query->x |= (data[2] >> 5) & 0x3;

	query->y = data[5] << 9;
	query->y |= data[6] << 2;
	query->y |= (data[2] >> 3) & 0x3;

	/* Early days' single-finger touch models need the following defaults */
	if (!query->x && !query->y) {
		query->x = 1024;
		query->y = 1024;
		if (query->panel_res)
			query->x = query->y = (1 << query->panel_res);
		query->panel_res = W8001_TOUCH_RESOLUTION;
	}
}

static void report_pen_events(struct w8001 *w8001, struct w8001_coord *coord)
{
	struct input_dev *dev = w8001->dev;

	/*
	 * We have 1 bit for proximity (rdy) and 3 bits for tip, side,
	 * side2/eraser. If rdy && f2 are set, this can be either pen + side2,
	 * or eraser. Assume:
	 * - if dev is already in proximity and f2 is toggled → pen + side2
	 * - if dev comes into proximity with f2 set → eraser
	 * If f2 disappears after assuming eraser, fake proximity out for
	 * eraser and in for pen.
	 */

	switch (w8001->type) {
	case BTN_TOOL_RUBBER:
		if (!coord->f2) {
			input_report_abs(dev, ABS_PRESSURE, 0);
			input_report_key(dev, BTN_TOUCH, 0);
			input_report_key(dev, BTN_STYLUS, 0);
			input_report_key(dev, BTN_STYLUS2, 0);
			input_report_key(dev, BTN_TOOL_RUBBER, 0);
			input_sync(dev);
			w8001->type = BTN_TOOL_PEN;
		}
		break;

	case BTN_TOOL_FINGER:
		input_report_key(dev, BTN_TOUCH, 0);
		input_report_key(dev, BTN_TOOL_FINGER, 0);
		input_sync(dev);
		/* fall through */

	case KEY_RESERVED:
		w8001->type = coord->f2 ? BTN_TOOL_RUBBER : BTN_TOOL_PEN;
		break;

	default:
		input_report_key(dev, BTN_STYLUS2, coord->f2);
		break;
	}

	input_report_abs(dev, ABS_X, coord->x);
	input_report_abs(dev, ABS_Y, coord->y);
	input_report_abs(dev, ABS_PRESSURE, coord->pen_pressure);
	input_report_key(dev, BTN_TOUCH, coord->tsw);
	input_report_key(dev, BTN_STYLUS, coord->f1);
	input_report_key(dev, w8001->type, coord->rdy);
	input_sync(dev);

	if (!coord->rdy)
		w8001->type = KEY_RESERVED;
}

static void report_single_touch(struct w8001 *w8001, struct w8001_coord *coord)
{
	struct input_dev *dev = w8001->dev;
	unsigned int x = coord->x;
	unsigned int y = coord->y;

	/* scale to pen maximum */
	scale_touch_coordinates(w8001, &x, &y);

	input_report_abs(dev, ABS_X, x);
	input_report_abs(dev, ABS_Y, y);
	input_report_key(dev, BTN_TOUCH, coord->tsw);
	input_report_key(dev, BTN_TOOL_FINGER, coord->tsw);

	input_sync(dev);

	w8001->type = coord->tsw ? BTN_TOOL_FINGER : KEY_RESERVED;
}

static irqreturn_t w8001_interrupt(struct serio *serio,
				   unsigned char data, unsigned int flags)
{
	struct w8001 *w8001 = serio_get_drvdata(serio);
	struct w8001_coord coord;
	unsigned char tmp;

	w8001->data[w8001->idx] = data;
	switch (w8001->idx++) {
	case 0:
		if ((data & W8001_LEAD_MASK) != W8001_LEAD_BYTE) {
			pr_debug("w8001: unsynchronized data: 0x%02x\n", data);
			w8001->idx = 0;
		}
		break;

	case W8001_PKTLEN_TOUCH93 - 1:
	case W8001_PKTLEN_TOUCH9A - 1:
		tmp = w8001->data[0] & W8001_TOUCH_BYTE;
		if (tmp != W8001_TOUCH_BYTE)
			break;

		if (w8001->pktlen == w8001->idx) {
			w8001->idx = 0;
			if (w8001->type != BTN_TOOL_PEN &&
			    w8001->type != BTN_TOOL_RUBBER) {
				parse_single_touch(w8001->data, &coord);
				report_single_touch(w8001, &coord);
			}
		}
		break;

	/* Pen coordinates packet */
	case W8001_PKTLEN_TPCPEN - 1:
		tmp = w8001->data[0] & W8001_TAB_MASK;
		if (unlikely(tmp == W8001_TAB_BYTE))
			break;

		tmp = w8001->data[0] & W8001_TOUCH_BYTE;
		if (tmp == W8001_TOUCH_BYTE)
			break;

		w8001->idx = 0;
		parse_pen_data(w8001->data, &coord);
		report_pen_events(w8001, &coord);
		break;

	/* control packet */
	case W8001_PKTLEN_TPCCTL - 1:
		tmp = w8001->data[0] & W8001_TOUCH_MASK;
		if (tmp == W8001_TOUCH_BYTE)
			break;

		w8001->idx = 0;
		memcpy(w8001->response, w8001->data, W8001_MAX_LENGTH);
		w8001->response_type = W8001_QUERY_PACKET;
		complete(&w8001->cmd_done);
		break;

	/* 2 finger touch packet */
	case W8001_PKTLEN_TOUCH2FG - 1:
		w8001->idx = 0;
		parse_multi_touch(w8001);
		break;
	}

	return IRQ_HANDLED;
}

static int w8001_command(struct w8001 *w8001, unsigned char command,
			 bool wait_response)
{
	int rc;

	w8001->response_type = 0;
	init_completion(&w8001->cmd_done);

	rc = serio_write(w8001->serio, command);
	if (rc == 0 && wait_response) {

		wait_for_completion_timeout(&w8001->cmd_done, HZ);
		if (w8001->response_type != W8001_QUERY_PACKET)
			rc = -EIO;
	}

	return rc;
}

static int w8001_open(struct input_dev *dev)
{
	struct w8001 *w8001 = input_get_drvdata(dev);

	return w8001_command(w8001, W8001_CMD_START, false);
}

static void w8001_close(struct input_dev *dev)
{
	struct w8001 *w8001 = input_get_drvdata(dev);

	w8001_command(w8001, W8001_CMD_STOP, false);
}

static int w8001_setup(struct w8001 *w8001)
{
	struct input_dev *dev = w8001->dev;
	struct w8001_coord coord;
	struct w8001_touch_query touch;
	int error;

	error = w8001_command(w8001, W8001_CMD_STOP, false);
	if (error)
		return error;

	msleep(250);	/* wait 250ms before querying the device */

	dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
	strlcat(w8001->name, "Wacom Serial", sizeof(w8001->name));

	__set_bit(INPUT_PROP_DIRECT, dev->propbit);

	/* penabled? */
	error = w8001_command(w8001, W8001_CMD_QUERY, true);
	if (!error) {
		__set_bit(BTN_TOUCH, dev->keybit);
		__set_bit(BTN_TOOL_PEN, dev->keybit);
		__set_bit(BTN_TOOL_RUBBER, dev->keybit);
		__set_bit(BTN_STYLUS, dev->keybit);
		__set_bit(BTN_STYLUS2, dev->keybit);

		parse_pen_data(w8001->response, &coord);
		w8001->max_pen_x = coord.x;
		w8001->max_pen_y = coord.y;

		input_set_abs_params(dev, ABS_X, 0, coord.x, 0, 0);
		input_set_abs_params(dev, ABS_Y, 0, coord.y, 0, 0);
		input_abs_set_res(dev, ABS_X, W8001_PEN_RESOLUTION);
		input_abs_set_res(dev, ABS_Y, W8001_PEN_RESOLUTION);
		input_set_abs_params(dev, ABS_PRESSURE, 0, coord.pen_pressure, 0, 0);
		if (coord.tilt_x && coord.tilt_y) {
			input_set_abs_params(dev, ABS_TILT_X, 0, coord.tilt_x, 0, 0);
			input_set_abs_params(dev, ABS_TILT_Y, 0, coord.tilt_y, 0, 0);
		}
		w8001->id = 0x90;
		strlcat(w8001->name, " Penabled", sizeof(w8001->name));
	}

	/* Touch enabled? */
	error = w8001_command(w8001, W8001_CMD_TOUCHQUERY, true);

	/*
	 * Some non-touch devices may reply to the touch query. But their
	 * second byte is empty, which indicates touch is not supported.
	 */
	if (!error && w8001->response[1]) {
		__set_bit(BTN_TOUCH, dev->keybit);
		__set_bit(BTN_TOOL_FINGER, dev->keybit);

		parse_touchquery(w8001->response, &touch);
		w8001->max_touch_x = touch.x;
		w8001->max_touch_y = touch.y;

		if (w8001->max_pen_x && w8001->max_pen_y) {
			/* if pen is supported scale to pen maximum */
			touch.x = w8001->max_pen_x;
			touch.y = w8001->max_pen_y;
			touch.panel_res = W8001_PEN_RESOLUTION;
		}

		input_set_abs_params(dev, ABS_X, 0, touch.x, 0, 0);
		input_set_abs_params(dev, ABS_Y, 0, touch.y, 0, 0);
		input_abs_set_res(dev, ABS_X, touch.panel_res);
		input_abs_set_res(dev, ABS_Y, touch.panel_res);

		switch (touch.sensor_id) {
		case 0:
		case 2:
			w8001->pktlen = W8001_PKTLEN_TOUCH93;
			w8001->id = 0x93;
			strlcat(w8001->name, " 1FG", sizeof(w8001->name));
			break;

		case 1:
		case 3:
		case 4:
			w8001->pktlen = W8001_PKTLEN_TOUCH9A;
			strlcat(w8001->name, " 1FG", sizeof(w8001->name));
			w8001->id = 0x9a;
			break;

		case 5:
			w8001->pktlen = W8001_PKTLEN_TOUCH2FG;

			input_mt_init_slots(dev, 2, 0);
			input_set_abs_params(dev, ABS_MT_POSITION_X,
						0, touch.x, 0, 0);
			input_set_abs_params(dev, ABS_MT_POSITION_Y,
						0, touch.y, 0, 0);
			input_set_abs_params(dev, ABS_MT_TOOL_TYPE,
						0, MT_TOOL_MAX, 0, 0);

			strlcat(w8001->name, " 2FG", sizeof(w8001->name));
			if (w8001->max_pen_x && w8001->max_pen_y)
				w8001->id = 0xE3;
			else
				w8001->id = 0xE2;
			break;
		}
	}

	strlcat(w8001->name, " Touchscreen", sizeof(w8001->name));

	return 0;
}

/*
 * w8001_disconnect() is the opposite of w8001_connect()
 */

static void w8001_disconnect(struct serio *serio)
{
	struct w8001 *w8001 = serio_get_drvdata(serio);

	serio_close(serio);

	input_unregister_device(w8001->dev);
	kfree(w8001);

	serio_set_drvdata(serio, NULL);
}

/*
 * w8001_connect() is the routine that is called when someone adds a
 * new serio device that supports the w8001 protocol and registers it as
 * an input device.
 */

static int w8001_connect(struct serio *serio, struct serio_driver *drv)
{
	struct w8001 *w8001;
	struct input_dev *input_dev;
	int err;

	w8001 = kzalloc(sizeof(struct w8001), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!w8001 || !input_dev) {
		err = -ENOMEM;
		goto fail1;
	}

	w8001->serio = serio;
	w8001->dev = input_dev;
	init_completion(&w8001->cmd_done);
	snprintf(w8001->phys, sizeof(w8001->phys), "%s/input0", serio->phys);

	serio_set_drvdata(serio, w8001);
	err = serio_open(serio, drv);
	if (err)
		goto fail2;

	err = w8001_setup(w8001);
	if (err)
		goto fail3;

	input_dev->name = w8001->name;
	input_dev->phys = w8001->phys;
	input_dev->id.product = w8001->id;
	input_dev->id.bustype = BUS_RS232;
	input_dev->id.vendor = 0x056a;
	input_dev->id.version = 0x0100;
	input_dev->dev.parent = &serio->dev;

	input_dev->open = w8001_open;
	input_dev->close = w8001_close;

	input_set_drvdata(input_dev, w8001);

	err = input_register_device(w8001->dev);
	if (err)
		goto fail3;

	return 0;

fail3:
	serio_close(serio);
fail2:
	serio_set_drvdata(serio, NULL);
fail1:
	input_free_device(input_dev);
	kfree(w8001);
	return err;
}

static struct serio_device_id w8001_serio_ids[] = {
	{
		.type	= SERIO_RS232,
		.proto	= SERIO_W8001,
		.id	= SERIO_ANY,
		.extra	= SERIO_ANY,
	},
	{ 0 }
};

MODULE_DEVICE_TABLE(serio, w8001_serio_ids);

static struct serio_driver w8001_drv = {
	.driver		= {
		.name	= "w8001",
	},
	.description	= DRIVER_DESC,
	.id_table	= w8001_serio_ids,
	.interrupt	= w8001_interrupt,
	.connect	= w8001_connect,
	.disconnect	= w8001_disconnect,
};

module_serio_driver(w8001_drv);
Commit	Line	Data
3eb1aa43 JK	1	/*
	2	* Wacom W8001 penabled serial touchscreen driver
	3	*
	4	* Copyright (c) 2008 Jaya Kumar
aaba933e	5	* Copyright (c) 2010 Red Hat, Inc.
5fca6cac	6	* Copyright (c) 2010 - 2011 Ping Cheng, Wacom. <pingc@wacom.com>
3eb1aa43 JK	7	*
	8	* This file is subject to the terms and conditions of the GNU General Public
	9	* License. See the file COPYING in the main directory of this archive for
	10	* more details.
	11	*
	12	* Layout based on Elo serial touchscreen driver by Vojtech Pavlik
	13	*/
	14
	15	#include <linux/errno.h>
	16	#include <linux/kernel.h>
	17	#include <linux/module.h>
	18	#include <linux/slab.h>
47c78e89	19	#include <linux/input/mt.h>
3eb1aa43	20	#include <linux/serio.h>
3eb1aa43	21	#include <linux/ctype.h>
a6d38f88	22	#include <linux/delay.h>
3eb1aa43 JK	23
	24	#define DRIVER_DESC "Wacom W8001 serial touchscreen driver"
	25
	26	MODULE_AUTHOR("Jaya Kumar <jayakumar.lkml@gmail.com>");
	27	MODULE_DESCRIPTION(DRIVER_DESC);
	28	MODULE_LICENSE("GPL");
	29
3eb1aa43	30	#define W8001_MAX_LENGTH 11
41c372dc DT	31	#define W8001_LEAD_MASK 0x80
	32	#define W8001_LEAD_BYTE 0x80
	33	#define W8001_TAB_MASK 0x40
	34	#define W8001_TAB_BYTE 0x40
aaba933e PH	35	/* set in first byte of touch data packets */
	36	#define W8001_TOUCH_MASK (0x10 \| W8001_LEAD_MASK)
	37	#define W8001_TOUCH_BYTE (0x10 \| W8001_LEAD_BYTE)
3eb1aa43	38
41c372dc DT	39	#define W8001_QUERY_PACKET 0x20
41c372dc DT	40
a6d38f88	41	#define W8001_CMD_STOP '0'
41c372dc DT	42	#define W8001_CMD_START '1'
41c372dc DT	43	#define W8001_CMD_QUERY '*'
aaba933e PH	44	#define W8001_CMD_TOUCHQUERY '%'
	45
	46	/* length of data packets in bytes, depends on device. */
	47	#define W8001_PKTLEN_TOUCH93 5
	48	#define W8001_PKTLEN_TOUCH9A 7
	49	#define W8001_PKTLEN_TPCPEN 9
	50	#define W8001_PKTLEN_TPCCTL 11 /* control packet */
	51	#define W8001_PKTLEN_TOUCH2FG 13
3eb1aa43	52
28a1bc1c PC	53	/* resolution in points/mm */
	54	#define W8001_PEN_RESOLUTION 100
	55	#define W8001_TOUCH_RESOLUTION 10
	56
3eb1aa43 JK	57	struct w8001_coord {
	58	u8 rdy;
	59	u8 tsw;
	60	u8 f1;
	61	u8 f2;
	62	u16 x;
	63	u16 y;
	64	u16 pen_pressure;
	65	u8 tilt_x;
	66	u8 tilt_y;
	67	};
	68
aaba933e PH	69	/* touch query reply packet */
aaba933e PH	70	struct w8001_touch_query {
5fca6cac PC	71	u16 x;
5fca6cac PC	72	u16 y;
aaba933e PH	73	u8 panel_res;
	74	u8 capacity_res;
	75	u8 sensor_id;
aaba933e PH	76	};
aaba933e PH	77
3eb1aa43 JK	78	/*
	79	* Per-touchscreen data.
	80	*/
	81
	82	struct w8001 {
	83	struct input_dev *dev;
	84	struct serio *serio;
3eb1aa43 JK	85	struct completion cmd_done;
	86	int id;
	87	int idx;
41c372dc DT	88	unsigned char response_type;
41c372dc DT	89	unsigned char response[W8001_MAX_LENGTH];
3eb1aa43	90	unsigned char data[W8001_MAX_LENGTH];
3eb1aa43	91	char phys[32];
2072f8db	92	int type;
aaba933e	93	unsigned int pktlen;
5fca6cac PC	94	u16 max_touch_x;
	95	u16 max_touch_y;
	96	u16 max_pen_x;
	97	u16 max_pen_y;
	98	char name[64];
3eb1aa43 JK	99	};
3eb1aa43 JK	100
5fca6cac	101	static void parse_pen_data(u8 data, struct w8001_coord coord)
3eb1aa43	102	{
41c372dc DT	103	memset(coord, 0, sizeof(*coord));
41c372dc DT	104
3eb1aa43 JK	105	coord->rdy = data[0] & 0x20;
	106	coord->tsw = data[0] & 0x01;
	107	coord->f1 = data[0] & 0x02;
	108	coord->f2 = data[0] & 0x04;
	109
	110	coord->x = (data[1] & 0x7F) << 9;
	111	coord->x \|= (data[2] & 0x7F) << 2;
	112	coord->x \|= (data[6] & 0x60) >> 5;
	113
	114	coord->y = (data[3] & 0x7F) << 9;
	115	coord->y \|= (data[4] & 0x7F) << 2;
	116	coord->y \|= (data[6] & 0x18) >> 3;
	117
	118	coord->pen_pressure = data[5] & 0x7F;
	119	coord->pen_pressure \|= (data[6] & 0x07) << 7 ;
	120
	121	coord->tilt_x = data[7] & 0x7F;
	122	coord->tilt_y = data[8] & 0x7F;
3eb1aa43 JK	123	}
3eb1aa43 JK	124
5fca6cac PC	125	static void parse_single_touch(u8 data, struct w8001_coord coord)
	126	{
	127	coord->x = (data[1] << 7) \| data[2];
	128	coord->y = (data[3] << 7) \| data[4];
	129	coord->tsw = data[0] & 0x01;
	130	}
	131
	132	static void scale_touch_coordinates(struct w8001 *w8001,
	133	unsigned int x, unsigned int y)
	134	{
	135	if (w8001->max_pen_x && w8001->max_touch_x)
	136	x = x * w8001->max_pen_x / w8001->max_touch_x;
	137
	138	if (w8001->max_pen_y && w8001->max_touch_y)
	139	y = y * w8001->max_pen_y / w8001->max_touch_y;
	140	}
	141
	142	static void parse_multi_touch(struct w8001 *w8001)
5e8b9140	143	{
5e8b9140 PH	144	struct input_dev *dev = w8001->dev;
5e8b9140 PH	145	unsigned char *data = w8001->data;
5fca6cac	146	unsigned int x, y;
5e8b9140	147	int i;
5fca6cac	148	int count = 0;
5e8b9140 PH	149
5e8b9140 PH	150	for (i = 0; i < 2; i++) {
c5f4dec1	151	bool touch = data[0] & (1 << i);
5e8b9140	152
c5f4dec1 HR	153	input_mt_slot(dev, i);
	154	input_mt_report_slot_state(dev, MT_TOOL_FINGER, touch);
	155	if (touch) {
5fca6cac PC	156	x = (data[6 * i + 1] << 7) \| data[6 * i + 2];
5fca6cac PC	157	y = (data[6 * i + 3] << 7) \| data[6 * i + 4];
5e8b9140 PH	158	/* data[5,6] and [11,12] is finger capacity */
5e8b9140 PH	159
5fca6cac PC	160	/* scale to pen maximum */
	161	scale_touch_coordinates(w8001, &x, &y);
	162
5e8b9140 PH	163	input_report_abs(dev, ABS_MT_POSITION_X, x);
5e8b9140 PH	164	input_report_abs(dev, ABS_MT_POSITION_Y, y);
5fca6cac	165	count++;
5e8b9140	166	}
5e8b9140 PH	167	}
5e8b9140 PH	168
5fca6cac PC	169	/* emulate single touch events when stylus is out of proximity.
	170	* This is to make single touch backward support consistent
	171	* across all Wacom single touch devices.
	172	*/
	173	if (w8001->type != BTN_TOOL_PEN &&
	174	w8001->type != BTN_TOOL_RUBBER) {
	175	w8001->type = count == 1 ? BTN_TOOL_FINGER : KEY_RESERVED;
	176	input_mt_report_pointer_emulation(dev, true);
	177	}
	178
5e8b9140 PH	179	input_sync(dev);
	180	}
	181
aaba933e PH	182	static void parse_touchquery(u8 data, struct w8001_touch_query query)
	183	{
	184	memset(query, 0, sizeof(*query));
	185
	186	query->panel_res = data[1];
	187	query->sensor_id = data[2] & 0x7;
	188	query->capacity_res = data[7];
	189
	190	query->x = data[3] << 9;
	191	query->x \|= data[4] << 2;
	192	query->x \|= (data[2] >> 5) & 0x3;
	193
	194	query->y = data[5] << 9;
	195	query->y \|= data[6] << 2;
	196	query->y \|= (data[2] >> 3) & 0x3;
5fca6cac PC	197
	198	/* Early days' single-finger touch models need the following defaults */
	199	if (!query->x && !query->y) {
	200	query->x = 1024;
	201	query->y = 1024;
	202	if (query->panel_res)
	203	query->x = query->y = (1 << query->panel_res);
28a1bc1c	204	query->panel_res = W8001_TOUCH_RESOLUTION;
5fca6cac	205	}
aaba933e PH	206	}
aaba933e PH	207
2072f8db PH	208	static void report_pen_events(struct w8001 w8001, struct w8001_coord coord)
	209	{
	210	struct input_dev *dev = w8001->dev;
	211
	212	/*
	213	* We have 1 bit for proximity (rdy) and 3 bits for tip, side,
	214	* side2/eraser. If rdy && f2 are set, this can be either pen + side2,
5fca6cac	215	* or eraser. Assume:
2072f8db PH	216	* - if dev is already in proximity and f2 is toggled → pen + side2
	217	* - if dev comes into proximity with f2 set → eraser
	218	* If f2 disappears after assuming eraser, fake proximity out for
	219	* eraser and in for pen.
	220	*/
	221
5fca6cac PC	222	switch (w8001->type) {
5fca6cac PC	223	case BTN_TOOL_RUBBER:
2072f8db PH	224	if (!coord->f2) {
	225	input_report_abs(dev, ABS_PRESSURE, 0);
	226	input_report_key(dev, BTN_TOUCH, 0);
	227	input_report_key(dev, BTN_STYLUS, 0);
	228	input_report_key(dev, BTN_STYLUS2, 0);
	229	input_report_key(dev, BTN_TOOL_RUBBER, 0);
	230	input_sync(dev);
	231	w8001->type = BTN_TOOL_PEN;
	232	}
5fca6cac PC	233	break;
	234
	235	case BTN_TOOL_FINGER:
	236	input_report_key(dev, BTN_TOUCH, 0);
	237	input_report_key(dev, BTN_TOOL_FINGER, 0);
	238	input_sync(dev);
	239	/* fall through */
	240
	241	case KEY_RESERVED:
	242	w8001->type = coord->f2 ? BTN_TOOL_RUBBER : BTN_TOOL_PEN;
	243	break;
	244
	245	default:
2072f8db	246	input_report_key(dev, BTN_STYLUS2, coord->f2);
5fca6cac	247	break;
2072f8db PH	248	}
	249
	250	input_report_abs(dev, ABS_X, coord->x);
	251	input_report_abs(dev, ABS_Y, coord->y);
	252	input_report_abs(dev, ABS_PRESSURE, coord->pen_pressure);
	253	input_report_key(dev, BTN_TOUCH, coord->tsw);
	254	input_report_key(dev, BTN_STYLUS, coord->f1);
	255	input_report_key(dev, w8001->type, coord->rdy);
	256	input_sync(dev);
	257
	258	if (!coord->rdy)
5fca6cac PC	259	w8001->type = KEY_RESERVED;
	260	}
	261
	262	static void report_single_touch(struct w8001 w8001, struct w8001_coord coord)
	263	{
	264	struct input_dev *dev = w8001->dev;
	265	unsigned int x = coord->x;
	266	unsigned int y = coord->y;
	267
	268	/* scale to pen maximum */
	269	scale_touch_coordinates(w8001, &x, &y);
	270
	271	input_report_abs(dev, ABS_X, x);
	272	input_report_abs(dev, ABS_Y, y);
	273	input_report_key(dev, BTN_TOUCH, coord->tsw);
	274	input_report_key(dev, BTN_TOOL_FINGER, coord->tsw);
	275
	276	input_sync(dev);
	277
	278	w8001->type = coord->tsw ? BTN_TOOL_FINGER : KEY_RESERVED;
2072f8db PH	279	}
2072f8db PH	280
41c372dc DT	281	static irqreturn_t w8001_interrupt(struct serio *serio,
41c372dc DT	282	unsigned char data, unsigned int flags)
3eb1aa43	283	{
41c372dc	284	struct w8001 *w8001 = serio_get_drvdata(serio);
3eb1aa43	285	struct w8001_coord coord;
41c372dc	286	unsigned char tmp;
3eb1aa43 JK	287
	288	w8001->data[w8001->idx] = data;
	289	switch (w8001->idx++) {
	290	case 0:
	291	if ((data & W8001_LEAD_MASK) != W8001_LEAD_BYTE) {
	292	pr_debug("w8001: unsynchronized data: 0x%02x\n", data);
	293	w8001->idx = 0;
	294	}
	295	break;
41c372dc	296
aaba933e PH	297	case W8001_PKTLEN_TOUCH93 - 1:
aaba933e PH	298	case W8001_PKTLEN_TOUCH9A - 1:
5fca6cac PC	299	tmp = w8001->data[0] & W8001_TOUCH_BYTE;
	300	if (tmp != W8001_TOUCH_BYTE)
	301	break;
	302
	303	if (w8001->pktlen == w8001->idx) {
aaba933e	304	w8001->idx = 0;
5fca6cac PC	305	if (w8001->type != BTN_TOOL_PEN &&
	306	w8001->type != BTN_TOOL_RUBBER) {
	307	parse_single_touch(w8001->data, &coord);
	308	report_single_touch(w8001, &coord);
	309	}
	310	}
aaba933e PH	311	break;
	312
	313	/* Pen coordinates packet */
	314	case W8001_PKTLEN_TPCPEN - 1:
3eb1aa43 JK	315	tmp = w8001->data[0] & W8001_TAB_MASK;
	316	if (unlikely(tmp == W8001_TAB_BYTE))
	317	break;
41c372dc	318
5fca6cac	319	tmp = w8001->data[0] & W8001_TOUCH_BYTE;
aaba933e PH	320	if (tmp == W8001_TOUCH_BYTE)
	321	break;
	322
3eb1aa43	323	w8001->idx = 0;
5fca6cac	324	parse_pen_data(w8001->data, &coord);
2072f8db	325	report_pen_events(w8001, &coord);
3eb1aa43	326	break;
41c372dc	327
aaba933e PH	328	/* control packet */
aaba933e PH	329	case W8001_PKTLEN_TPCCTL - 1:
5fca6cac	330	tmp = w8001->data[0] & W8001_TOUCH_MASK;
aaba933e PH	331	if (tmp == W8001_TOUCH_BYTE)
	332	break;
	333
3eb1aa43	334	w8001->idx = 0;
41c372dc DT	335	memcpy(w8001->response, w8001->data, W8001_MAX_LENGTH);
41c372dc DT	336	w8001->response_type = W8001_QUERY_PACKET;
3eb1aa43 JK	337	complete(&w8001->cmd_done);
3eb1aa43 JK	338	break;
aaba933e	339
5e8b9140	340	/* 2 finger touch packet */
aaba933e	341	case W8001_PKTLEN_TOUCH2FG - 1:
5e8b9140	342	w8001->idx = 0;
5fca6cac	343	parse_multi_touch(w8001);
aaba933e	344	break;
3eb1aa43	345	}
3eb1aa43 JK	346
	347	return IRQ_HANDLED;
	348	}
	349
41c372dc DT	350	static int w8001_command(struct w8001 *w8001, unsigned char command,
41c372dc DT	351	bool wait_response)
3eb1aa43	352	{
41c372dc	353	int rc;
3eb1aa43	354
41c372dc	355	w8001->response_type = 0;
3eb1aa43	356	init_completion(&w8001->cmd_done);
3eb1aa43	357
41c372dc DT	358	rc = serio_write(w8001->serio, command);
41c372dc DT	359	if (rc == 0 && wait_response) {
3eb1aa43	360
41c372dc DT	361	wait_for_completion_timeout(&w8001->cmd_done, HZ);
	362	if (w8001->response_type != W8001_QUERY_PACKET)
	363	rc = -EIO;
3eb1aa43 JK	364	}
3eb1aa43 JK	365
3eb1aa43 JK	366	return rc;
	367	}
	368
e9496746 DT	369	static int w8001_open(struct input_dev *dev)
	370	{
	371	struct w8001 *w8001 = input_get_drvdata(dev);
	372
	373	return w8001_command(w8001, W8001_CMD_START, false);
	374	}
	375
	376	static void w8001_close(struct input_dev *dev)
	377	{
	378	struct w8001 *w8001 = input_get_drvdata(dev);
	379
	380	w8001_command(w8001, W8001_CMD_STOP, false);
	381	}
	382
3eb1aa43 JK	383	static int w8001_setup(struct w8001 *w8001)
3eb1aa43 JK	384	{
3eb1aa43	385	struct input_dev *dev = w8001->dev;
41c372dc	386	struct w8001_coord coord;
5fca6cac	387	struct w8001_touch_query touch;
41c372dc	388	int error;
3eb1aa43	389
a6d38f88	390	error = w8001_command(w8001, W8001_CMD_STOP, false);
41c372dc DT	391	if (error)
41c372dc DT	392	return error;
3eb1aa43	393
a6d38f88	394	msleep(250); /* wait 250ms before querying the device */
3eb1aa43	395
5fca6cac PC	396	dev->evbit[0] = BIT_MASK(EV_KEY) \| BIT_MASK(EV_ABS);
	397	strlcat(w8001->name, "Wacom Serial", sizeof(w8001->name));
	398
3512069e JG	399	__set_bit(INPUT_PROP_DIRECT, dev->propbit);
3512069e JG	400
a6d38f88 PC	401	/* penabled? */
	402	error = w8001_command(w8001, W8001_CMD_QUERY, true);
	403	if (!error) {
5fca6cac	404	__set_bit(BTN_TOUCH, dev->keybit);
a6d38f88 PC	405	__set_bit(BTN_TOOL_PEN, dev->keybit);
	406	__set_bit(BTN_TOOL_RUBBER, dev->keybit);
	407	__set_bit(BTN_STYLUS, dev->keybit);
	408	__set_bit(BTN_STYLUS2, dev->keybit);
5fca6cac PC	409
	410	parse_pen_data(w8001->response, &coord);
	411	w8001->max_pen_x = coord.x;
	412	w8001->max_pen_y = coord.y;
a6d38f88 PC	413
	414	input_set_abs_params(dev, ABS_X, 0, coord.x, 0, 0);
	415	input_set_abs_params(dev, ABS_Y, 0, coord.y, 0, 0);
28a1bc1c PC	416	input_abs_set_res(dev, ABS_X, W8001_PEN_RESOLUTION);
28a1bc1c PC	417	input_abs_set_res(dev, ABS_Y, W8001_PEN_RESOLUTION);
a6d38f88 PC	418	input_set_abs_params(dev, ABS_PRESSURE, 0, coord.pen_pressure, 0, 0);
	419	if (coord.tilt_x && coord.tilt_y) {
	420	input_set_abs_params(dev, ABS_TILT_X, 0, coord.tilt_x, 0, 0);
	421	input_set_abs_params(dev, ABS_TILT_Y, 0, coord.tilt_y, 0, 0);
	422	}
5fca6cac PC	423	w8001->id = 0x90;
5fca6cac PC	424	strlcat(w8001->name, " Penabled", sizeof(w8001->name));
a6d38f88	425	}
3eb1aa43	426
a6d38f88	427	/* Touch enabled? */
aaba933e	428	error = w8001_command(w8001, W8001_CMD_TOUCHQUERY, true);
a6d38f88 PC	429
	430	/*
	431	* Some non-touch devices may reply to the touch query. But their
	432	* second byte is empty, which indicates touch is not supported.
	433	*/
	434	if (!error && w8001->response[1]) {
5fca6cac PC	435	__set_bit(BTN_TOUCH, dev->keybit);
5fca6cac PC	436	__set_bit(BTN_TOOL_FINGER, dev->keybit);
aaba933e PH	437
aaba933e PH	438	parse_touchquery(w8001->response, &touch);
5fca6cac PC	439	w8001->max_touch_x = touch.x;
	440	w8001->max_touch_y = touch.y;
	441
5fca6cac	442	if (w8001->max_pen_x && w8001->max_pen_y) {
28a1bc1c	443	/* if pen is supported scale to pen maximum */
5fca6cac PC	444	touch.x = w8001->max_pen_x;
5fca6cac PC	445	touch.y = w8001->max_pen_y;
28a1bc1c	446	touch.panel_res = W8001_PEN_RESOLUTION;
5fca6cac	447	}
aaba933e	448
a6d38f88 PC	449	input_set_abs_params(dev, ABS_X, 0, touch.x, 0, 0);
a6d38f88 PC	450	input_set_abs_params(dev, ABS_Y, 0, touch.y, 0, 0);
28a1bc1c PC	451	input_abs_set_res(dev, ABS_X, touch.panel_res);
28a1bc1c PC	452	input_abs_set_res(dev, ABS_Y, touch.panel_res);
a6d38f88	453
aaba933e PH	454	switch (touch.sensor_id) {
	455	case 0:
	456	case 2:
	457	w8001->pktlen = W8001_PKTLEN_TOUCH93;
5fca6cac PC	458	w8001->id = 0x93;
5fca6cac PC	459	strlcat(w8001->name, " 1FG", sizeof(w8001->name));
aaba933e	460	break;
5fca6cac	461
aaba933e PH	462	case 1:
	463	case 3:
	464	case 4:
	465	w8001->pktlen = W8001_PKTLEN_TOUCH9A;
5fca6cac PC	466	strlcat(w8001->name, " 1FG", sizeof(w8001->name));
5fca6cac PC	467	w8001->id = 0x9a;
aaba933e	468	break;
5fca6cac	469
aaba933e PH	470	case 5:
aaba933e PH	471	w8001->pktlen = W8001_PKTLEN_TOUCH2FG;
5e8b9140	472
b4adbbef	473	input_mt_init_slots(dev, 2, 0);
5e8b9140 PH	474	input_set_abs_params(dev, ABS_MT_POSITION_X,
	475	0, touch.x, 0, 0);
	476	input_set_abs_params(dev, ABS_MT_POSITION_Y,
	477	0, touch.y, 0, 0);
	478	input_set_abs_params(dev, ABS_MT_TOOL_TYPE,
c5f4dec1	479	0, MT_TOOL_MAX, 0, 0);
5fca6cac PC	480
	481	strlcat(w8001->name, " 2FG", sizeof(w8001->name));
	482	if (w8001->max_pen_x && w8001->max_pen_y)
	483	w8001->id = 0xE3;
	484	else
	485	w8001->id = 0xE2;
aaba933e PH	486	break;
	487	}
	488	}
	489
5fca6cac PC	490	strlcat(w8001->name, " Touchscreen", sizeof(w8001->name));
5fca6cac PC	491
e9496746	492	return 0;
3eb1aa43 JK	493	}
	494
	495	/*
	496	* w8001_disconnect() is the opposite of w8001_connect()
	497	*/
	498
	499	static void w8001_disconnect(struct serio *serio)
	500	{
	501	struct w8001 *w8001 = serio_get_drvdata(serio);
	502
3eb1aa43	503	serio_close(serio);
66fd9385 DT	504
66fd9385 DT	505	input_unregister_device(w8001->dev);
3eb1aa43	506	kfree(w8001);
66fd9385 DT	507
66fd9385 DT	508	serio_set_drvdata(serio, NULL);
3eb1aa43 JK	509	}
	510
	511	/*
	512	* w8001_connect() is the routine that is called when someone adds a
	513	* new serio device that supports the w8001 protocol and registers it as
	514	* an input device.
	515	*/
	516
	517	static int w8001_connect(struct serio serio, struct serio_driver drv)
	518	{
	519	struct w8001 *w8001;
	520	struct input_dev *input_dev;
	521	int err;
	522
	523	w8001 = kzalloc(sizeof(struct w8001), GFP_KERNEL);
	524	input_dev = input_allocate_device();
	525	if (!w8001 \|\| !input_dev) {
	526	err = -ENOMEM;
	527	goto fail1;
	528	}
	529
	530	w8001->serio = serio;
3eb1aa43	531	w8001->dev = input_dev;
3eb1aa43 JK	532	init_completion(&w8001->cmd_done);
	533	snprintf(w8001->phys, sizeof(w8001->phys), "%s/input0", serio->phys);
	534
3eb1aa43 JK	535	serio_set_drvdata(serio, w8001);
	536	err = serio_open(serio, drv);
	537	if (err)
	538	goto fail2;
	539
41c372dc DT	540	err = w8001_setup(w8001);
41c372dc DT	541	if (err)
3eb1aa43 JK	542	goto fail3;
3eb1aa43 JK	543
5fca6cac PC	544	input_dev->name = w8001->name;
	545	input_dev->phys = w8001->phys;
	546	input_dev->id.product = w8001->id;
	547	input_dev->id.bustype = BUS_RS232;
	548	input_dev->id.vendor = 0x056a;
	549	input_dev->id.version = 0x0100;
	550	input_dev->dev.parent = &serio->dev;
	551
e9496746 DT	552	input_dev->open = w8001_open;
	553	input_dev->close = w8001_close;
	554
	555	input_set_drvdata(input_dev, w8001);
	556
3eb1aa43 JK	557	err = input_register_device(w8001->dev);
	558	if (err)
	559	goto fail3;
	560
	561	return 0;
	562
	563	fail3:
	564	serio_close(serio);
	565	fail2:
	566	serio_set_drvdata(serio, NULL);
	567	fail1:
	568	input_free_device(input_dev);
	569	kfree(w8001);
	570	return err;
	571	}
	572
	573	static struct serio_device_id w8001_serio_ids[] = {
	574	{
	575	.type = SERIO_RS232,
	576	.proto = SERIO_W8001,
	577	.id = SERIO_ANY,
	578	.extra = SERIO_ANY,
	579	},
	580	{ 0 }
	581	};
	582
	583	MODULE_DEVICE_TABLE(serio, w8001_serio_ids);
	584
	585	static struct serio_driver w8001_drv = {
	586	.driver = {
	587	.name = "w8001",
	588	},
	589	.description = DRIVER_DESC,
	590	.id_table = w8001_serio_ids,
	591	.interrupt = w8001_interrupt,
	592	.connect = w8001_connect,
	593	.disconnect = w8001_disconnect,
	594	};
	595
65ac9f7a	596	module_serio_driver(w8001_drv);