[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/module.h>
#include <linux/i2c.h>
#include <linux/interrupt.h>
#include <linux/input.h>
#include <linux/irq.h>
#include <linux/gpio.h>
#include <linux/delay.h>
#include <linux/slab.h>
#include <linux/bitops.h>
#include <linux/input/mt.h>
#include <linux/of_gpio.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 device_node *np = client->dev.of_node;
	int gpio;
	int ret;

	if (!np)
		return -ENODEV;

	gpio = of_get_named_gpio(np, "wakeup-gpios", 0);
	if (!gpio_is_valid(gpio))
		return -ENODEV;

	ret = gpio_request(gpio, "egalax_irq");
	if (ret < 0) {
		dev_err(&client->dev,
			"request gpio failed, cannot wake up controller: %d\n",
			ret);
		return ret;
	}

	/* wake up controller via an falling edge on IRQ gpio. */
	gpio_direction_output(gpio, 0);
	gpio_set_value(gpio, 1);

	/* controller should be waken up, return irq.  */
	gpio_direction_input(gpio);
	gpio_free(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,
			   const struct i2c_device_id *id)
{
	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) {
		dev_err(&client->dev, "Failed to wake up the controller\n");
		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_TRIGGER_LOW | 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;

	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);

	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		= 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
	17	#include <linux/module.h>
59bae1db ZJ	18	#include <linux/i2c.h>
	19	#include <linux/interrupt.h>
	20	#include <linux/input.h>
	21	#include <linux/irq.h>
	22	#include <linux/gpio.h>
	23	#include <linux/delay.h>
	24	#include <linux/slab.h>
	25	#include <linux/bitops.h>
	26	#include <linux/input/mt.h>
ae495e84	27	#include <linux/of_gpio.h>
59bae1db ZJ	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	{
ae495e84 HW	122	struct device_node *np = client->dev.of_node;
ae495e84 HW	123	int gpio;
59bae1db ZJ	124	int ret;
59bae1db ZJ	125
ae495e84 HW	126	if (!np)
	127	return -ENODEV;
	128
	129	gpio = of_get_named_gpio(np, "wakeup-gpios", 0);
	130	if (!gpio_is_valid(gpio))
	131	return -ENODEV;
	132
59bae1db ZJ	133	ret = gpio_request(gpio, "egalax_irq");
	134	if (ret < 0) {
	135	dev_err(&client->dev,
	136	"request gpio failed, cannot wake up controller: %d\n",
	137	ret);
	138	return ret;
	139	}
	140
	141	/* wake up controller via an falling edge on IRQ gpio. */
	142	gpio_direction_output(gpio, 0);
	143	gpio_set_value(gpio, 1);
	144
	145	/* controller should be waken up, return irq. */
	146	gpio_direction_input(gpio);
	147	gpio_free(gpio);
	148
	149	return 0;
	150	}
	151
5298cc4c	152	static int egalax_firmware_version(struct i2c_client *client)
59bae1db ZJ	153	{
	154	static const u8 cmd[MAX_I2C_DATA_LEN] = { 0x03, 0x03, 0xa, 0x01, 0x41 };
	155	int ret;
	156
	157	ret = i2c_master_send(client, cmd, MAX_I2C_DATA_LEN);
	158	if (ret < 0)
	159	return ret;
	160
	161	return 0;
	162	}
	163
5298cc4c	164	static int egalax_ts_probe(struct i2c_client *client,
1ffb064e	165	const struct i2c_device_id *id)
59bae1db ZJ	166	{
	167	struct egalax_ts *ts;
	168	struct input_dev *input_dev;
59bae1db ZJ	169	int error;
59bae1db ZJ	170
1ffb064e	171	ts = devm_kzalloc(&client->dev, sizeof(struct egalax_ts), GFP_KERNEL);
59bae1db ZJ	172	if (!ts) {
	173	dev_err(&client->dev, "Failed to allocate memory\n");
	174	return -ENOMEM;
	175	}
	176
1ffb064e	177	input_dev = devm_input_allocate_device(&client->dev);
59bae1db ZJ	178	if (!input_dev) {
59bae1db ZJ	179	dev_err(&client->dev, "Failed to allocate memory\n");
1ffb064e	180	return -ENOMEM;
59bae1db ZJ	181	}
	182
	183	ts->client = client;
	184	ts->input_dev = input_dev;
	185
	186	/* controller may be in sleep, wake it up. */
ae495e84 HW	187	error = egalax_wake_up_device(client);
	188	if (error) {
	189	dev_err(&client->dev, "Failed to wake up the controller\n");
1ffb064e	190	return error;
ae495e84	191	}
59bae1db	192
1ffb064e AS	193	error = egalax_firmware_version(client);
1ffb064e AS	194	if (error < 0) {
59bae1db	195	dev_err(&client->dev, "Failed to read firmware version\n");
1ffb064e	196	return error;
59bae1db ZJ	197	}
	198
	199	input_dev->name = "EETI eGalax Touch Screen";
	200	input_dev->id.bustype = BUS_I2C;
59bae1db ZJ	201
	202	__set_bit(EV_ABS, input_dev->evbit);
	203	__set_bit(EV_KEY, input_dev->evbit);
	204	__set_bit(BTN_TOUCH, input_dev->keybit);
	205
	206	input_set_abs_params(input_dev, ABS_X, 0, EGALAX_MAX_X, 0, 0);
	207	input_set_abs_params(input_dev, ABS_Y, 0, EGALAX_MAX_Y, 0, 0);
	208	input_set_abs_params(input_dev,
	209	ABS_MT_POSITION_X, 0, EGALAX_MAX_X, 0, 0);
	210	input_set_abs_params(input_dev,
3c9cfa78	211	ABS_MT_POSITION_Y, 0, EGALAX_MAX_Y, 0, 0);
b4adbbef	212	input_mt_init_slots(input_dev, MAX_SUPPORT_POINTS, 0);
59bae1db	213
1ffb064e AS	214	error = devm_request_threaded_irq(&client->dev, client->irq, NULL,
	215	egalax_ts_interrupt,
	216	IRQF_TRIGGER_LOW \| IRQF_ONESHOT,
	217	"egalax_ts", ts);
59bae1db ZJ	218	if (error < 0) {
59bae1db ZJ	219	dev_err(&client->dev, "Failed to register interrupt\n");
1ffb064e	220	return error;
59bae1db ZJ	221	}
	222
	223	error = input_register_device(ts->input_dev);
	224	if (error)
1ffb064e	225	return error;
59bae1db	226
59bae1db	227	return 0;
59bae1db ZJ	228	}
	229
	230	static const struct i2c_device_id egalax_ts_id[] = {
	231	{ "egalax_ts", 0 },
	232	{ }
	233	};
	234	MODULE_DEVICE_TABLE(i2c, egalax_ts_id);
	235
02b6a58b	236	static int __maybe_unused egalax_ts_suspend(struct device *dev)
59bae1db ZJ	237	{
	238	static const u8 suspend_cmd[MAX_I2C_DATA_LEN] = {
	239	0x3, 0x6, 0xa, 0x3, 0x36, 0x3f, 0x2, 0, 0, 0
	240	};
	241	struct i2c_client *client = to_i2c_client(dev);
	242	int ret;
	243
	244	ret = i2c_master_send(client, suspend_cmd, MAX_I2C_DATA_LEN);
	245	return ret > 0 ? 0 : ret;
	246	}
	247
02b6a58b	248	static int __maybe_unused egalax_ts_resume(struct device *dev)
59bae1db ZJ	249	{
	250	struct i2c_client *client = to_i2c_client(dev);
	251
	252	return egalax_wake_up_device(client);
	253	}
59bae1db ZJ	254
	255	static SIMPLE_DEV_PM_OPS(egalax_ts_pm_ops, egalax_ts_suspend, egalax_ts_resume);
	256
a5fd844c	257	static const struct of_device_id egalax_ts_dt_ids[] = {
ae495e84 HW	258	{ .compatible = "eeti,egalax_ts" },
	259	{ /* sentinel */ }
	260	};
02d9bd05	261	MODULE_DEVICE_TABLE(of, egalax_ts_dt_ids);
ae495e84	262
59bae1db ZJ	263	static struct i2c_driver egalax_ts_driver = {
	264	.driver = {
	265	.name = "egalax_ts",
59bae1db	266	.pm = &egalax_ts_pm_ops,
085f17c6	267	.of_match_table = egalax_ts_dt_ids,
59bae1db ZJ	268	},
	269	.id_table = egalax_ts_id,
	270	.probe = egalax_ts_probe,
59bae1db ZJ	271	};
59bae1db ZJ	272
1b92c1cf	273	module_i2c_driver(egalax_ts_driver);
59bae1db ZJ	274
	275	MODULE_AUTHOR("Freescale Semiconductor, Inc.");
	276	MODULE_DESCRIPTION("Touchscreen driver for EETI eGalax touch controller");
	277	MODULE_LICENSE("GPL");