[linux-2.6-block.git] / drivers / input / touchscreen / egalax_ts.c

// SPDX-License-Identifier: GPL-2.0
/*
 * Driver for EETI eGalax Multiple Touch Controller
 *
 * Copyright (C) 2011 Freescale Semiconductor, Inc.
 *
 * based on max11801_ts.c
 */

/* EETI eGalax serial touch screen controller is a I2C based multiple
 * touch screen controller, it supports 5 point multiple touch. */

/* TODO:
  - auto idle mode support
*/

#include <linux/err.h>
#include <linux/module.h>
#include <linux/i2c.h>
#include <linux/interrupt.h>
#include <linux/input.h>
#include <linux/irq.h>
#include <linux/gpio/consumer.h>
#include <linux/delay.h>
#include <linux/slab.h>
#include <linux/bitops.h>
#include <linux/input/mt.h>

/*
 * Mouse Mode: some panel may configure the controller to mouse mode,
 * which can only report one point at a given time.
 * This driver will ignore events in this mode.
 */
#define REPORT_MODE_MOUSE		0x1
/*
 * Vendor Mode: this mode is used to transfer some vendor specific
 * messages.
 * This driver will ignore events in this mode.
 */
#define REPORT_MODE_VENDOR		0x3
/* Multiple Touch Mode */
#define REPORT_MODE_MTTOUCH		0x4

#define MAX_SUPPORT_POINTS		5

#define EVENT_VALID_OFFSET	7
#define EVENT_VALID_MASK	(0x1 << EVENT_VALID_OFFSET)
#define EVENT_ID_OFFSET		2
#define EVENT_ID_MASK		(0xf << EVENT_ID_OFFSET)
#define EVENT_IN_RANGE		(0x1 << 1)
#define EVENT_DOWN_UP		(0X1 << 0)

#define MAX_I2C_DATA_LEN	10

#define EGALAX_MAX_X	32760
#define EGALAX_MAX_Y	32760
#define EGALAX_MAX_TRIES 100

struct egalax_ts {
	struct i2c_client		*client;
	struct input_dev		*input_dev;
};

static irqreturn_t egalax_ts_interrupt(int irq, void *dev_id)
{
	struct egalax_ts *ts = dev_id;
	struct input_dev *input_dev = ts->input_dev;
	struct i2c_client *client = ts->client;
	u8 buf[MAX_I2C_DATA_LEN];
	int id, ret, x, y, z;
	int tries = 0;
	bool down, valid;
	u8 state;

	do {
		ret = i2c_master_recv(client, buf, MAX_I2C_DATA_LEN);
	} while (ret == -EAGAIN && tries++ < EGALAX_MAX_TRIES);

	if (ret < 0)
		return IRQ_HANDLED;

	if (buf[0] != REPORT_MODE_MTTOUCH) {
		/* ignore mouse events and vendor events */
		return IRQ_HANDLED;
	}

	state = buf[1];
	x = (buf[3] << 8) | buf[2];
	y = (buf[5] << 8) | buf[4];
	z = (buf[7] << 8) | buf[6];

	valid = state & EVENT_VALID_MASK;
	id = (state & EVENT_ID_MASK) >> EVENT_ID_OFFSET;
	down = state & EVENT_DOWN_UP;

	if (!valid || id > MAX_SUPPORT_POINTS) {
		dev_dbg(&client->dev, "point invalid\n");
		return IRQ_HANDLED;
	}

	input_mt_slot(input_dev, id);
	input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, down);

	dev_dbg(&client->dev, "%s id:%d x:%d y:%d z:%d",
		down ? "down" : "up", id, x, y, z);

	if (down) {
		input_report_abs(input_dev, ABS_MT_POSITION_X, x);
		input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
		input_report_abs(input_dev, ABS_MT_PRESSURE, z);
	}

	input_mt_report_pointer_emulation(input_dev, true);
	input_sync(input_dev);

	return IRQ_HANDLED;
}

/* wake up controller by an falling edge of interrupt gpio.  */
static int egalax_wake_up_device(struct i2c_client *client)
{
	struct gpio_desc *gpio;
	int ret;

	/* wake up controller via an falling edge on IRQ gpio. */
	gpio = gpiod_get(&client->dev, "wakeup", GPIOD_OUT_HIGH);
	ret = PTR_ERR_OR_ZERO(gpio);
	if (ret) {
		if (ret != -EPROBE_DEFER)
			dev_err(&client->dev,
				"failed to request wakeup gpio, cannot wake up controller: %d\n",
				ret);
		return ret;
	}

	/* release the line */
	gpiod_set_value_cansleep(gpio, 0);

	/* controller should be woken up, return irq.  */
	gpiod_direction_input(gpio);
	gpiod_put(gpio);

	return 0;
}

static int egalax_firmware_version(struct i2c_client *client)
{
	static const u8 cmd[MAX_I2C_DATA_LEN] = { 0x03, 0x03, 0xa, 0x01, 0x41 };
	int ret;

	ret = i2c_master_send(client, cmd, MAX_I2C_DATA_LEN);
	if (ret < 0)
		return ret;

	return 0;
}

static int egalax_ts_probe(struct i2c_client *client)
{
	struct egalax_ts *ts;
	struct input_dev *input_dev;
	int error;

	ts = devm_kzalloc(&client->dev, sizeof(struct egalax_ts), GFP_KERNEL);
	if (!ts) {
		dev_err(&client->dev, "Failed to allocate memory\n");
		return -ENOMEM;
	}

	input_dev = devm_input_allocate_device(&client->dev);
	if (!input_dev) {
		dev_err(&client->dev, "Failed to allocate memory\n");
		return -ENOMEM;
	}

	ts->client = client;
	ts->input_dev = input_dev;

	/* controller may be in sleep, wake it up. */
	error = egalax_wake_up_device(client);
	if (error)
		return error;

	error = egalax_firmware_version(client);
	if (error < 0) {
		dev_err(&client->dev, "Failed to read firmware version\n");
		return error;
	}

	input_dev->name = "EETI eGalax Touch Screen";
	input_dev->id.bustype = BUS_I2C;

	__set_bit(EV_ABS, input_dev->evbit);
	__set_bit(EV_KEY, input_dev->evbit);
	__set_bit(BTN_TOUCH, input_dev->keybit);

	input_set_abs_params(input_dev, ABS_X, 0, EGALAX_MAX_X, 0, 0);
	input_set_abs_params(input_dev, ABS_Y, 0, EGALAX_MAX_Y, 0, 0);
	input_set_abs_params(input_dev,
			     ABS_MT_POSITION_X, 0, EGALAX_MAX_X, 0, 0);
	input_set_abs_params(input_dev,
			     ABS_MT_POSITION_Y, 0, EGALAX_MAX_Y, 0, 0);
	input_mt_init_slots(input_dev, MAX_SUPPORT_POINTS, 0);

	error = devm_request_threaded_irq(&client->dev, client->irq,
					  NULL, egalax_ts_interrupt,
					  IRQF_ONESHOT, "egalax_ts", ts);
	if (error < 0) {
		dev_err(&client->dev, "Failed to register interrupt\n");
		return error;
	}

	error = input_register_device(ts->input_dev);
	if (error)
		return error;

	return 0;
}

static const struct i2c_device_id egalax_ts_id[] = {
	{ "egalax_ts", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, egalax_ts_id);

static int __maybe_unused egalax_ts_suspend(struct device *dev)
{
	static const u8 suspend_cmd[MAX_I2C_DATA_LEN] = {
		0x3, 0x6, 0xa, 0x3, 0x36, 0x3f, 0x2, 0, 0, 0
	};
	struct i2c_client *client = to_i2c_client(dev);
	int ret;

	if (device_may_wakeup(dev))
		return enable_irq_wake(client->irq);

	ret = i2c_master_send(client, suspend_cmd, MAX_I2C_DATA_LEN);
	return ret > 0 ? 0 : ret;
}

static int __maybe_unused egalax_ts_resume(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);

	if (device_may_wakeup(dev))
		return disable_irq_wake(client->irq);

	return egalax_wake_up_device(client);
}

static SIMPLE_DEV_PM_OPS(egalax_ts_pm_ops, egalax_ts_suspend, egalax_ts_resume);

static const struct of_device_id egalax_ts_dt_ids[] = {
	{ .compatible = "eeti,egalax_ts" },
	{ /* sentinel */ }
};
MODULE_DEVICE_TABLE(of, egalax_ts_dt_ids);

static struct i2c_driver egalax_ts_driver = {
	.driver = {
		.name	= "egalax_ts",
		.pm	= &egalax_ts_pm_ops,
		.of_match_table	= egalax_ts_dt_ids,
	},
	.id_table	= egalax_ts_id,
	.probe_new	= egalax_ts_probe,
};

module_i2c_driver(egalax_ts_driver);

MODULE_AUTHOR("Freescale Semiconductor, Inc.");
MODULE_DESCRIPTION("Touchscreen driver for EETI eGalax touch controller");
MODULE_LICENSE("GPL");
Commit	Line	Data
a150c1fe	1	// SPDX-License-Identifier: GPL-2.0
59bae1db ZJ	2	/*
	3	* Driver for EETI eGalax Multiple Touch Controller
	4	*
	5	* Copyright (C) 2011 Freescale Semiconductor, Inc.
	6	*
	7	* based on max11801_ts.c
59bae1db ZJ	8	*/
	9
	10	/* EETI eGalax serial touch screen controller is a I2C based multiple
	11	* touch screen controller, it supports 5 point multiple touch. */
	12
	13	/* TODO:
	14	- auto idle mode support
	15	*/
	16
d19e719d	17	#include <linux/err.h>
59bae1db	18	#include <linux/module.h>
59bae1db ZJ	19	#include <linux/i2c.h>
	20	#include <linux/interrupt.h>
	21	#include <linux/input.h>
	22	#include <linux/irq.h>
d19e719d	23	#include <linux/gpio/consumer.h>
59bae1db ZJ	24	#include <linux/delay.h>
	25	#include <linux/slab.h>
	26	#include <linux/bitops.h>
	27	#include <linux/input/mt.h>
	28
	29	/*
	30	* Mouse Mode: some panel may configure the controller to mouse mode,
	31	* which can only report one point at a given time.
	32	* This driver will ignore events in this mode.
	33	*/
	34	#define REPORT_MODE_MOUSE 0x1
	35	/*
	36	* Vendor Mode: this mode is used to transfer some vendor specific
	37	* messages.
	38	* This driver will ignore events in this mode.
	39	*/
	40	#define REPORT_MODE_VENDOR 0x3
	41	/* Multiple Touch Mode */
	42	#define REPORT_MODE_MTTOUCH 0x4
	43
	44	#define MAX_SUPPORT_POINTS 5
	45
	46	#define EVENT_VALID_OFFSET 7
	47	#define EVENT_VALID_MASK (0x1 << EVENT_VALID_OFFSET)
	48	#define EVENT_ID_OFFSET 2
	49	#define EVENT_ID_MASK (0xf << EVENT_ID_OFFSET)
	50	#define EVENT_IN_RANGE (0x1 << 1)
	51	#define EVENT_DOWN_UP (0X1 << 0)
	52
	53	#define MAX_I2C_DATA_LEN 10
	54
	55	#define EGALAX_MAX_X 32760
	56	#define EGALAX_MAX_Y 32760
	57	#define EGALAX_MAX_TRIES 100
	58
	59	struct egalax_ts {
	60	struct i2c_client *client;
	61	struct input_dev *input_dev;
	62	};
	63
	64	static irqreturn_t egalax_ts_interrupt(int irq, void *dev_id)
	65	{
	66	struct egalax_ts *ts = dev_id;
	67	struct input_dev *input_dev = ts->input_dev;
	68	struct i2c_client *client = ts->client;
	69	u8 buf[MAX_I2C_DATA_LEN];
	70	int id, ret, x, y, z;
	71	int tries = 0;
	72	bool down, valid;
	73	u8 state;
	74
	75	do {
	76	ret = i2c_master_recv(client, buf, MAX_I2C_DATA_LEN);
	77	} while (ret == -EAGAIN && tries++ < EGALAX_MAX_TRIES);
	78
	79	if (ret < 0)
	80	return IRQ_HANDLED;
	81
	82	if (buf[0] != REPORT_MODE_MTTOUCH) {
	83	/* ignore mouse events and vendor events */
	84	return IRQ_HANDLED;
	85	}
	86
	87	state = buf[1];
88	x = (buf[3] << 8) \| buf[2];
89	y = (buf[5] << 8) \| buf[4];
90	z = (buf[7] << 8) \| buf[6];
91
92	valid = state & EVENT_VALID_MASK;
93	id = (state & EVENT_ID_MASK) >> EVENT_ID_OFFSET;
94	down = state & EVENT_DOWN_UP;
95
96	if (!valid \|\| id > MAX_SUPPORT_POINTS) {
97	dev_dbg(&client->dev, "point invalid\n");
98	return IRQ_HANDLED;
99	}
100
101	input_mt_slot(input_dev, id);
102	input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, down);
103
104	dev_dbg(&client->dev, "%s id:%d x:%d y:%d z:%d",
105	down ? "down" : "up", id, x, y, z);
106
107	if (down) {
108	input_report_abs(input_dev, ABS_MT_POSITION_X, x);
109	input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
110	input_report_abs(input_dev, ABS_MT_PRESSURE, z);
111	}
112
113	input_mt_report_pointer_emulation(input_dev, true);
114	input_sync(input_dev);
115
116	return IRQ_HANDLED;
117	}
118
119	/* wake up controller by an falling edge of interrupt gpio. */
120	static int egalax_wake_up_device(struct i2c_client *client)
121	{
d19e719d	122	struct gpio_desc *gpio;
59bae1db ZJ	123	int ret;
59bae1db ZJ	124
d19e719d DT	125	/* wake up controller via an falling edge on IRQ gpio. */
	126	gpio = gpiod_get(&client->dev, "wakeup", GPIOD_OUT_HIGH);
	127	ret = PTR_ERR_OR_ZERO(gpio);
	128	if (ret) {
	129	if (ret != -EPROBE_DEFER)
	130	dev_err(&client->dev,
	131	"failed to request wakeup gpio, cannot wake up controller: %d\n",
	132	ret);
59bae1db ZJ	133	return ret;
	134	}
	135
d19e719d DT	136	/* release the line */
d19e719d DT	137	gpiod_set_value_cansleep(gpio, 0);
59bae1db	138
d19e719d DT	139	/* controller should be woken up, return irq. */
	140	gpiod_direction_input(gpio);
	141	gpiod_put(gpio);
59bae1db ZJ	142
	143	return 0;
	144	}
	145
5298cc4c	146	static int egalax_firmware_version(struct i2c_client *client)
59bae1db ZJ	147	{
	148	static const u8 cmd[MAX_I2C_DATA_LEN] = { 0x03, 0x03, 0xa, 0x01, 0x41 };
	149	int ret;
	150
	151	ret = i2c_master_send(client, cmd, MAX_I2C_DATA_LEN);
	152	if (ret < 0)
	153	return ret;
	154
	155	return 0;
	156	}
	157
0b754b03	158	static int egalax_ts_probe(struct i2c_client *client)
59bae1db ZJ	159	{
	160	struct egalax_ts *ts;
	161	struct input_dev *input_dev;
59bae1db ZJ	162	int error;
59bae1db ZJ	163
1ffb064e	164	ts = devm_kzalloc(&client->dev, sizeof(struct egalax_ts), GFP_KERNEL);
59bae1db ZJ	165	if (!ts) {
	166	dev_err(&client->dev, "Failed to allocate memory\n");
	167	return -ENOMEM;
	168	}
	169
1ffb064e	170	input_dev = devm_input_allocate_device(&client->dev);
59bae1db ZJ	171	if (!input_dev) {
59bae1db ZJ	172	dev_err(&client->dev, "Failed to allocate memory\n");
1ffb064e	173	return -ENOMEM;
59bae1db ZJ	174	}
	175
	176	ts->client = client;
	177	ts->input_dev = input_dev;
	178
	179	/* controller may be in sleep, wake it up. */
ae495e84	180	error = egalax_wake_up_device(client);
d19e719d	181	if (error)
1ffb064e	182	return error;
59bae1db	183
1ffb064e AS	184	error = egalax_firmware_version(client);
1ffb064e AS	185	if (error < 0) {
59bae1db	186	dev_err(&client->dev, "Failed to read firmware version\n");
1ffb064e	187	return error;
59bae1db ZJ	188	}
	189
	190	input_dev->name = "EETI eGalax Touch Screen";
	191	input_dev->id.bustype = BUS_I2C;
59bae1db ZJ	192
	193	__set_bit(EV_ABS, input_dev->evbit);
	194	__set_bit(EV_KEY, input_dev->evbit);
	195	__set_bit(BTN_TOUCH, input_dev->keybit);
	196
	197	input_set_abs_params(input_dev, ABS_X, 0, EGALAX_MAX_X, 0, 0);
	198	input_set_abs_params(input_dev, ABS_Y, 0, EGALAX_MAX_Y, 0, 0);
	199	input_set_abs_params(input_dev,
	200	ABS_MT_POSITION_X, 0, EGALAX_MAX_X, 0, 0);
	201	input_set_abs_params(input_dev,
3c9cfa78	202	ABS_MT_POSITION_Y, 0, EGALAX_MAX_Y, 0, 0);
b4adbbef	203	input_mt_init_slots(input_dev, MAX_SUPPORT_POINTS, 0);
59bae1db	204
1ffb0cd8 DT	205	error = devm_request_threaded_irq(&client->dev, client->irq,
	206	NULL, egalax_ts_interrupt,
	207	IRQF_ONESHOT, "egalax_ts", ts);
59bae1db ZJ	208	if (error < 0) {
59bae1db ZJ	209	dev_err(&client->dev, "Failed to register interrupt\n");
1ffb064e	210	return error;
59bae1db ZJ	211	}
	212
	213	error = input_register_device(ts->input_dev);
	214	if (error)
1ffb064e	215	return error;
59bae1db	216
59bae1db	217	return 0;
59bae1db ZJ	218	}
	219
	220	static const struct i2c_device_id egalax_ts_id[] = {
	221	{ "egalax_ts", 0 },
	222	{ }
	223	};
	224	MODULE_DEVICE_TABLE(i2c, egalax_ts_id);
	225
02b6a58b	226	static int __maybe_unused egalax_ts_suspend(struct device *dev)
59bae1db ZJ	227	{
	228	static const u8 suspend_cmd[MAX_I2C_DATA_LEN] = {
	229	0x3, 0x6, 0xa, 0x3, 0x36, 0x3f, 0x2, 0, 0, 0
	230	};
	231	struct i2c_client *client = to_i2c_client(dev);
	232	int ret;
	233
49f62249 AH	234	if (device_may_wakeup(dev))
	235	return enable_irq_wake(client->irq);
	236
59bae1db ZJ	237	ret = i2c_master_send(client, suspend_cmd, MAX_I2C_DATA_LEN);
	238	return ret > 0 ? 0 : ret;
	239	}
	240
02b6a58b	241	static int __maybe_unused egalax_ts_resume(struct device *dev)
59bae1db ZJ	242	{
	243	struct i2c_client *client = to_i2c_client(dev);
	244
49f62249 AH	245	if (device_may_wakeup(dev))
	246	return disable_irq_wake(client->irq);
	247
59bae1db ZJ	248	return egalax_wake_up_device(client);
59bae1db ZJ	249	}
59bae1db ZJ	250
	251	static SIMPLE_DEV_PM_OPS(egalax_ts_pm_ops, egalax_ts_suspend, egalax_ts_resume);
	252
a5fd844c	253	static const struct of_device_id egalax_ts_dt_ids[] = {
ae495e84 HW	254	{ .compatible = "eeti,egalax_ts" },
	255	{ /* sentinel */ }
	256	};
02d9bd05	257	MODULE_DEVICE_TABLE(of, egalax_ts_dt_ids);
ae495e84	258
59bae1db ZJ	259	static struct i2c_driver egalax_ts_driver = {
	260	.driver = {
	261	.name = "egalax_ts",
59bae1db	262	.pm = &egalax_ts_pm_ops,
085f17c6	263	.of_match_table = egalax_ts_dt_ids,
59bae1db ZJ	264	},
59bae1db ZJ	265	.id_table = egalax_ts_id,
0b754b03	266	.probe_new = egalax_ts_probe,
59bae1db ZJ	267	};
59bae1db ZJ	268
1b92c1cf	269	module_i2c_driver(egalax_ts_driver);
59bae1db ZJ	270
	271	MODULE_AUTHOR("Freescale Semiconductor, Inc.");
	272	MODULE_DESCRIPTION("Touchscreen driver for EETI eGalax touch controller");
	273	MODULE_LICENSE("GPL");