110494dceSDaniel Mack /*
210494dceSDaniel Mack  * Touch Screen driver for EETI's I2C connected touch screen panels
310494dceSDaniel Mack  *   Copyright (c) 2009 Daniel Mack <daniel@caiaq.de>
410494dceSDaniel Mack  *
510494dceSDaniel Mack  * See EETI's software guide for the protocol specification:
610494dceSDaniel Mack  *   http://home.eeti.com.tw/web20/eg/guide.htm
710494dceSDaniel Mack  *
810494dceSDaniel Mack  * Based on migor_ts.c
910494dceSDaniel Mack  *   Copyright (c) 2008 Magnus Damm
1010494dceSDaniel Mack  *   Copyright (c) 2007 Ujjwal Pande <ujjwal@kenati.com>
1110494dceSDaniel Mack  *
1210494dceSDaniel Mack  * This file is free software; you can redistribute it and/or
1310494dceSDaniel Mack  * modify it under the terms of the GNU  General Public
1410494dceSDaniel Mack  * License as published by the Free Software Foundation; either
1510494dceSDaniel Mack  * version 2 of the License, or (at your option) any later version.
1610494dceSDaniel Mack  *
1710494dceSDaniel Mack  * This file is distributed in the hope that it will be useful,
1810494dceSDaniel Mack  * but WITHOUT ANY WARRANTY; without even the implied warranty of
1910494dceSDaniel Mack  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
2010494dceSDaniel Mack  *  General Public License for more details.
2110494dceSDaniel Mack  *
2210494dceSDaniel Mack  * You should have received a copy of the GNU General Public
2310494dceSDaniel Mack  * License along with this library; if not, write to the Free Software
2410494dceSDaniel Mack  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
2510494dceSDaniel Mack  */
2610494dceSDaniel Mack 
2710494dceSDaniel Mack #include <linux/module.h>
2810494dceSDaniel Mack #include <linux/moduleparam.h>
2910494dceSDaniel Mack #include <linux/kernel.h>
3010494dceSDaniel Mack #include <linux/input.h>
3110494dceSDaniel Mack #include <linux/interrupt.h>
3210494dceSDaniel Mack #include <linux/i2c.h>
3310494dceSDaniel Mack #include <linux/timer.h>
3410494dceSDaniel Mack #include <linux/gpio.h>
3525a70e38SDaniel Mack #include <linux/input/eeti_ts.h>
3610494dceSDaniel Mack 
3710494dceSDaniel Mack static int flip_x;
3810494dceSDaniel Mack module_param(flip_x, bool, 0644);
3910494dceSDaniel Mack MODULE_PARM_DESC(flip_x, "flip x coordinate");
4010494dceSDaniel Mack 
4110494dceSDaniel Mack static int flip_y;
4210494dceSDaniel Mack module_param(flip_y, bool, 0644);
4310494dceSDaniel Mack MODULE_PARM_DESC(flip_y, "flip y coordinate");
4410494dceSDaniel Mack 
4510494dceSDaniel Mack struct eeti_ts_priv {
4610494dceSDaniel Mack 	struct i2c_client *client;
4710494dceSDaniel Mack 	struct input_dev *input;
4810494dceSDaniel Mack 	struct work_struct work;
4910494dceSDaniel Mack 	struct mutex mutex;
5025a70e38SDaniel Mack 	int irq, irq_active_high;
5110494dceSDaniel Mack };
5210494dceSDaniel Mack 
5310494dceSDaniel Mack #define EETI_TS_BITDEPTH	(11)
5410494dceSDaniel Mack #define EETI_MAXVAL		((1 << (EETI_TS_BITDEPTH + 1)) - 1)
5510494dceSDaniel Mack 
5610494dceSDaniel Mack #define REPORT_BIT_PRESSED	(1 << 0)
5710494dceSDaniel Mack #define REPORT_BIT_AD0		(1 << 1)
5810494dceSDaniel Mack #define REPORT_BIT_AD1		(1 << 2)
5910494dceSDaniel Mack #define REPORT_BIT_HAS_PRESSURE	(1 << 6)
6010494dceSDaniel Mack #define REPORT_RES_BITS(v)	(((v) >> 1) + EETI_TS_BITDEPTH)
6110494dceSDaniel Mack 
6225a70e38SDaniel Mack static inline int eeti_ts_irq_active(struct eeti_ts_priv *priv)
6325a70e38SDaniel Mack {
6425a70e38SDaniel Mack 	return gpio_get_value(irq_to_gpio(priv->irq)) == priv->irq_active_high;
6525a70e38SDaniel Mack }
6625a70e38SDaniel Mack 
6710494dceSDaniel Mack static void eeti_ts_read(struct work_struct *work)
6810494dceSDaniel Mack {
6910494dceSDaniel Mack 	char buf[6];
7010494dceSDaniel Mack 	unsigned int x, y, res, pressed, to = 100;
7110494dceSDaniel Mack 	struct eeti_ts_priv *priv =
7210494dceSDaniel Mack 		container_of(work, struct eeti_ts_priv, work);
7310494dceSDaniel Mack 
7410494dceSDaniel Mack 	mutex_lock(&priv->mutex);
7510494dceSDaniel Mack 
7625a70e38SDaniel Mack 	while (eeti_ts_irq_active(priv) && --to)
7710494dceSDaniel Mack 		i2c_master_recv(priv->client, buf, sizeof(buf));
7810494dceSDaniel Mack 
7910494dceSDaniel Mack 	if (!to) {
8010494dceSDaniel Mack 		dev_err(&priv->client->dev,
8110494dceSDaniel Mack 			"unable to clear IRQ - line stuck?\n");
8210494dceSDaniel Mack 		goto out;
8310494dceSDaniel Mack 	}
8410494dceSDaniel Mack 
8510494dceSDaniel Mack 	/* drop non-report packets */
8610494dceSDaniel Mack 	if (!(buf[0] & 0x80))
8710494dceSDaniel Mack 		goto out;
8810494dceSDaniel Mack 
8910494dceSDaniel Mack 	pressed = buf[0] & REPORT_BIT_PRESSED;
9010494dceSDaniel Mack 	res = REPORT_RES_BITS(buf[0] & (REPORT_BIT_AD0 | REPORT_BIT_AD1));
9110494dceSDaniel Mack 	x = buf[2] | (buf[1] << 8);
9210494dceSDaniel Mack 	y = buf[4] | (buf[3] << 8);
9310494dceSDaniel Mack 
9410494dceSDaniel Mack 	/* fix the range to 11 bits */
9510494dceSDaniel Mack 	x >>= res - EETI_TS_BITDEPTH;
9610494dceSDaniel Mack 	y >>= res - EETI_TS_BITDEPTH;
9710494dceSDaniel Mack 
9810494dceSDaniel Mack 	if (flip_x)
9910494dceSDaniel Mack 		x = EETI_MAXVAL - x;
10010494dceSDaniel Mack 
10110494dceSDaniel Mack 	if (flip_y)
10210494dceSDaniel Mack 		y = EETI_MAXVAL - y;
10310494dceSDaniel Mack 
10410494dceSDaniel Mack 	if (buf[0] & REPORT_BIT_HAS_PRESSURE)
10510494dceSDaniel Mack 		input_report_abs(priv->input, ABS_PRESSURE, buf[5]);
10610494dceSDaniel Mack 
10710494dceSDaniel Mack 	input_report_abs(priv->input, ABS_X, x);
10810494dceSDaniel Mack 	input_report_abs(priv->input, ABS_Y, y);
10910494dceSDaniel Mack 	input_report_key(priv->input, BTN_TOUCH, !!pressed);
11010494dceSDaniel Mack 	input_sync(priv->input);
11110494dceSDaniel Mack 
11210494dceSDaniel Mack out:
11310494dceSDaniel Mack 	mutex_unlock(&priv->mutex);
11410494dceSDaniel Mack }
11510494dceSDaniel Mack 
11610494dceSDaniel Mack static irqreturn_t eeti_ts_isr(int irq, void *dev_id)
11710494dceSDaniel Mack {
11810494dceSDaniel Mack 	struct eeti_ts_priv *priv = dev_id;
11910494dceSDaniel Mack 
12010494dceSDaniel Mack 	 /* postpone I2C transactions as we are atomic */
12110494dceSDaniel Mack 	schedule_work(&priv->work);
12210494dceSDaniel Mack 
12310494dceSDaniel Mack 	return IRQ_HANDLED;
12410494dceSDaniel Mack }
12510494dceSDaniel Mack 
1267fbef0d1SDaniel Mack static void eeti_ts_start(struct eeti_ts_priv *priv)
12710494dceSDaniel Mack {
12810494dceSDaniel Mack 	enable_irq(priv->irq);
12910494dceSDaniel Mack 
13010494dceSDaniel Mack 	/* Read the events once to arm the IRQ */
13110494dceSDaniel Mack 	eeti_ts_read(&priv->work);
1327fbef0d1SDaniel Mack }
1337fbef0d1SDaniel Mack 
1347fbef0d1SDaniel Mack static void eeti_ts_stop(struct eeti_ts_priv *priv)
1357fbef0d1SDaniel Mack {
1367fbef0d1SDaniel Mack 	disable_irq(priv->irq);
1377fbef0d1SDaniel Mack 	cancel_work_sync(&priv->work);
1387fbef0d1SDaniel Mack }
1397fbef0d1SDaniel Mack 
1407fbef0d1SDaniel Mack static int eeti_ts_open(struct input_dev *dev)
1417fbef0d1SDaniel Mack {
1427fbef0d1SDaniel Mack 	struct eeti_ts_priv *priv = input_get_drvdata(dev);
1437fbef0d1SDaniel Mack 
1447fbef0d1SDaniel Mack 	eeti_ts_start(priv);
14510494dceSDaniel Mack 
14610494dceSDaniel Mack 	return 0;
14710494dceSDaniel Mack }
14810494dceSDaniel Mack 
14910494dceSDaniel Mack static void eeti_ts_close(struct input_dev *dev)
15010494dceSDaniel Mack {
15110494dceSDaniel Mack 	struct eeti_ts_priv *priv = input_get_drvdata(dev);
15210494dceSDaniel Mack 
1537fbef0d1SDaniel Mack 	eeti_ts_stop(priv);
15410494dceSDaniel Mack }
15510494dceSDaniel Mack 
15610494dceSDaniel Mack static int __devinit eeti_ts_probe(struct i2c_client *client,
15710494dceSDaniel Mack 				   const struct i2c_device_id *idp)
15810494dceSDaniel Mack {
15925a70e38SDaniel Mack 	struct eeti_ts_platform_data *pdata;
16010494dceSDaniel Mack 	struct eeti_ts_priv *priv;
16110494dceSDaniel Mack 	struct input_dev *input;
16225a70e38SDaniel Mack 	unsigned int irq_flags;
16310494dceSDaniel Mack 	int err = -ENOMEM;
16410494dceSDaniel Mack 
1657fbef0d1SDaniel Mack 	/*
1667fbef0d1SDaniel Mack 	 * In contrast to what's described in the datasheet, there seems
16710494dceSDaniel Mack 	 * to be no way of probing the presence of that device using I2C
16810494dceSDaniel Mack 	 * commands. So we need to blindly believe it is there, and wait
1697fbef0d1SDaniel Mack 	 * for interrupts to occur.
1707fbef0d1SDaniel Mack 	 */
17110494dceSDaniel Mack 
17210494dceSDaniel Mack 	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
17310494dceSDaniel Mack 	if (!priv) {
17410494dceSDaniel Mack 		dev_err(&client->dev, "failed to allocate driver data\n");
17510494dceSDaniel Mack 		goto err0;
17610494dceSDaniel Mack 	}
17710494dceSDaniel Mack 
17810494dceSDaniel Mack 	mutex_init(&priv->mutex);
17910494dceSDaniel Mack 	input = input_allocate_device();
18010494dceSDaniel Mack 
18110494dceSDaniel Mack 	if (!input) {
18210494dceSDaniel Mack 		dev_err(&client->dev, "Failed to allocate input device.\n");
18310494dceSDaniel Mack 		goto err1;
18410494dceSDaniel Mack 	}
18510494dceSDaniel Mack 
18610494dceSDaniel Mack 	input->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
18710494dceSDaniel Mack 	input->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
18810494dceSDaniel Mack 
18910494dceSDaniel Mack 	input_set_abs_params(input, ABS_X, 0, EETI_MAXVAL, 0, 0);
19010494dceSDaniel Mack 	input_set_abs_params(input, ABS_Y, 0, EETI_MAXVAL, 0, 0);
19110494dceSDaniel Mack 	input_set_abs_params(input, ABS_PRESSURE, 0, 0xff, 0, 0);
19210494dceSDaniel Mack 
19310494dceSDaniel Mack 	input->name = client->name;
19410494dceSDaniel Mack 	input->id.bustype = BUS_I2C;
19510494dceSDaniel Mack 	input->dev.parent = &client->dev;
19610494dceSDaniel Mack 	input->open = eeti_ts_open;
19710494dceSDaniel Mack 	input->close = eeti_ts_close;
19810494dceSDaniel Mack 
19910494dceSDaniel Mack 	priv->client = client;
20010494dceSDaniel Mack 	priv->input = input;
20110494dceSDaniel Mack 	priv->irq = client->irq;
20210494dceSDaniel Mack 
20325a70e38SDaniel Mack 	pdata = client->dev.platform_data;
20425a70e38SDaniel Mack 
20525a70e38SDaniel Mack 	if (pdata)
20625a70e38SDaniel Mack 		priv->irq_active_high = pdata->irq_active_high;
20725a70e38SDaniel Mack 
20825a70e38SDaniel Mack 	irq_flags = priv->irq_active_high ?
20925a70e38SDaniel Mack 		IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
21025a70e38SDaniel Mack 
21110494dceSDaniel Mack 	INIT_WORK(&priv->work, eeti_ts_read);
21210494dceSDaniel Mack 	i2c_set_clientdata(client, priv);
21310494dceSDaniel Mack 	input_set_drvdata(input, priv);
21410494dceSDaniel Mack 
21510494dceSDaniel Mack 	err = input_register_device(input);
21610494dceSDaniel Mack 	if (err)
21710494dceSDaniel Mack 		goto err1;
21810494dceSDaniel Mack 
21925a70e38SDaniel Mack 	err = request_irq(priv->irq, eeti_ts_isr, irq_flags,
22010494dceSDaniel Mack 			  client->name, priv);
22110494dceSDaniel Mack 	if (err) {
22210494dceSDaniel Mack 		dev_err(&client->dev, "Unable to request touchscreen IRQ.\n");
22310494dceSDaniel Mack 		goto err2;
22410494dceSDaniel Mack 	}
22510494dceSDaniel Mack 
2267fbef0d1SDaniel Mack 	/*
2277fbef0d1SDaniel Mack 	 * Disable the device for now. It will be enabled once the
2287fbef0d1SDaniel Mack 	 * input device is opened.
2297fbef0d1SDaniel Mack 	 */
2307fbef0d1SDaniel Mack 	eeti_ts_stop(priv);
23110494dceSDaniel Mack 
23210494dceSDaniel Mack 	device_init_wakeup(&client->dev, 0);
23310494dceSDaniel Mack 	return 0;
23410494dceSDaniel Mack 
23510494dceSDaniel Mack err2:
23610494dceSDaniel Mack 	input_unregister_device(input);
23710494dceSDaniel Mack 	input = NULL; /* so we dont try to free it below */
23810494dceSDaniel Mack err1:
23910494dceSDaniel Mack 	input_free_device(input);
24010494dceSDaniel Mack 	i2c_set_clientdata(client, NULL);
24110494dceSDaniel Mack 	kfree(priv);
24210494dceSDaniel Mack err0:
24310494dceSDaniel Mack 	return err;
24410494dceSDaniel Mack }
24510494dceSDaniel Mack 
24610494dceSDaniel Mack static int __devexit eeti_ts_remove(struct i2c_client *client)
24710494dceSDaniel Mack {
24810494dceSDaniel Mack 	struct eeti_ts_priv *priv = i2c_get_clientdata(client);
24910494dceSDaniel Mack 
25010494dceSDaniel Mack 	free_irq(priv->irq, priv);
2517fbef0d1SDaniel Mack 	/*
2527fbef0d1SDaniel Mack 	 * eeti_ts_stop() leaves IRQ disabled. We need to re-enable it
2537fbef0d1SDaniel Mack 	 * so that device still works if we reload the driver.
2547fbef0d1SDaniel Mack 	 */
2557fbef0d1SDaniel Mack 	enable_irq(priv->irq);
2567fbef0d1SDaniel Mack 
25710494dceSDaniel Mack 	input_unregister_device(priv->input);
25810494dceSDaniel Mack 	i2c_set_clientdata(client, NULL);
25910494dceSDaniel Mack 	kfree(priv);
26010494dceSDaniel Mack 
26110494dceSDaniel Mack 	return 0;
26210494dceSDaniel Mack }
26310494dceSDaniel Mack 
26410494dceSDaniel Mack #ifdef CONFIG_PM
26510494dceSDaniel Mack static int eeti_ts_suspend(struct i2c_client *client, pm_message_t mesg)
26610494dceSDaniel Mack {
26710494dceSDaniel Mack 	struct eeti_ts_priv *priv = i2c_get_clientdata(client);
2687fbef0d1SDaniel Mack 	struct input_dev *input_dev = priv->input;
2697fbef0d1SDaniel Mack 
2707fbef0d1SDaniel Mack 	mutex_lock(&input_dev->mutex);
2717fbef0d1SDaniel Mack 
2727fbef0d1SDaniel Mack 	if (input_dev->users)
2737fbef0d1SDaniel Mack 		eeti_ts_stop(priv);
2747fbef0d1SDaniel Mack 
2757fbef0d1SDaniel Mack 	mutex_unlock(&input_dev->mutex);
27610494dceSDaniel Mack 
27710494dceSDaniel Mack 	if (device_may_wakeup(&client->dev))
27810494dceSDaniel Mack 		enable_irq_wake(priv->irq);
27910494dceSDaniel Mack 
28010494dceSDaniel Mack 	return 0;
28110494dceSDaniel Mack }
28210494dceSDaniel Mack 
28310494dceSDaniel Mack static int eeti_ts_resume(struct i2c_client *client)
28410494dceSDaniel Mack {
28510494dceSDaniel Mack 	struct eeti_ts_priv *priv = i2c_get_clientdata(client);
2867fbef0d1SDaniel Mack 	struct input_dev *input_dev = priv->input;
28710494dceSDaniel Mack 
28810494dceSDaniel Mack 	if (device_may_wakeup(&client->dev))
28910494dceSDaniel Mack 		disable_irq_wake(priv->irq);
29010494dceSDaniel Mack 
2917fbef0d1SDaniel Mack 	mutex_lock(&input_dev->mutex);
2927fbef0d1SDaniel Mack 
2937fbef0d1SDaniel Mack 	if (input_dev->users)
2947fbef0d1SDaniel Mack 		eeti_ts_start(priv);
2957fbef0d1SDaniel Mack 
2967fbef0d1SDaniel Mack 	mutex_unlock(&input_dev->mutex);
2977fbef0d1SDaniel Mack 
29810494dceSDaniel Mack 	return 0;
29910494dceSDaniel Mack }
30010494dceSDaniel Mack #else
30110494dceSDaniel Mack #define eeti_ts_suspend NULL
30210494dceSDaniel Mack #define eeti_ts_resume NULL
30310494dceSDaniel Mack #endif
30410494dceSDaniel Mack 
30510494dceSDaniel Mack static const struct i2c_device_id eeti_ts_id[] = {
30610494dceSDaniel Mack 	{ "eeti_ts", 0 },
30710494dceSDaniel Mack 	{ }
30810494dceSDaniel Mack };
30910494dceSDaniel Mack MODULE_DEVICE_TABLE(i2c, eeti_ts_id);
31010494dceSDaniel Mack 
31110494dceSDaniel Mack static struct i2c_driver eeti_ts_driver = {
31210494dceSDaniel Mack 	.driver = {
31310494dceSDaniel Mack 		.name = "eeti_ts",
31410494dceSDaniel Mack 	},
31510494dceSDaniel Mack 	.probe = eeti_ts_probe,
31610494dceSDaniel Mack 	.remove = __devexit_p(eeti_ts_remove),
31710494dceSDaniel Mack 	.suspend = eeti_ts_suspend,
31810494dceSDaniel Mack 	.resume = eeti_ts_resume,
31910494dceSDaniel Mack 	.id_table = eeti_ts_id,
32010494dceSDaniel Mack };
32110494dceSDaniel Mack 
32210494dceSDaniel Mack static int __init eeti_ts_init(void)
32310494dceSDaniel Mack {
32410494dceSDaniel Mack 	return i2c_add_driver(&eeti_ts_driver);
32510494dceSDaniel Mack }
32610494dceSDaniel Mack 
32710494dceSDaniel Mack static void __exit eeti_ts_exit(void)
32810494dceSDaniel Mack {
32910494dceSDaniel Mack 	i2c_del_driver(&eeti_ts_driver);
33010494dceSDaniel Mack }
33110494dceSDaniel Mack 
33210494dceSDaniel Mack MODULE_DESCRIPTION("EETI Touchscreen driver");
33310494dceSDaniel Mack MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
33410494dceSDaniel Mack MODULE_LICENSE("GPL");
33510494dceSDaniel Mack 
33610494dceSDaniel Mack module_init(eeti_ts_init);
33710494dceSDaniel Mack module_exit(eeti_ts_exit);
33810494dceSDaniel Mack 
339