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