Linux 4.19.133
[linux/fpc-iii.git] / drivers / input / touchscreen / auo-pixcir-ts.c
blobdf8ca856393b60ac56ec60e556c3284d4dcd669a
1 /*
2 * Driver for AUO in-cell touchscreens
4 * Copyright (c) 2011 Heiko Stuebner <heiko@sntech.de>
6 * loosely based on auo_touch.c from Dell Streak vendor-kernel
8 * Copyright (c) 2008 QUALCOMM Incorporated.
9 * Copyright (c) 2008 QUALCOMM USA, INC.
12 * This software is licensed under the terms of the GNU General Public
13 * License version 2, as published by the Free Software Foundation, and
14 * may be copied, distributed, and modified under those terms.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/interrupt.h>
26 #include <linux/slab.h>
27 #include <linux/input.h>
28 #include <linux/jiffies.h>
29 #include <linux/i2c.h>
30 #include <linux/mutex.h>
31 #include <linux/delay.h>
32 #include <linux/gpio.h>
33 #include <linux/input/auo-pixcir-ts.h>
34 #include <linux/of.h>
35 #include <linux/of_gpio.h>
38 * Coordinate calculation:
39 * X1 = X1_LSB + X1_MSB*256
40 * Y1 = Y1_LSB + Y1_MSB*256
41 * X2 = X2_LSB + X2_MSB*256
42 * Y2 = Y2_LSB + Y2_MSB*256
44 #define AUO_PIXCIR_REG_X1_LSB 0x00
45 #define AUO_PIXCIR_REG_X1_MSB 0x01
46 #define AUO_PIXCIR_REG_Y1_LSB 0x02
47 #define AUO_PIXCIR_REG_Y1_MSB 0x03
48 #define AUO_PIXCIR_REG_X2_LSB 0x04
49 #define AUO_PIXCIR_REG_X2_MSB 0x05
50 #define AUO_PIXCIR_REG_Y2_LSB 0x06
51 #define AUO_PIXCIR_REG_Y2_MSB 0x07
53 #define AUO_PIXCIR_REG_STRENGTH 0x0d
54 #define AUO_PIXCIR_REG_STRENGTH_X1_LSB 0x0e
55 #define AUO_PIXCIR_REG_STRENGTH_X1_MSB 0x0f
57 #define AUO_PIXCIR_REG_RAW_DATA_X 0x2b
58 #define AUO_PIXCIR_REG_RAW_DATA_Y 0x4f
60 #define AUO_PIXCIR_REG_X_SENSITIVITY 0x6f
61 #define AUO_PIXCIR_REG_Y_SENSITIVITY 0x70
62 #define AUO_PIXCIR_REG_INT_SETTING 0x71
63 #define AUO_PIXCIR_REG_INT_WIDTH 0x72
64 #define AUO_PIXCIR_REG_POWER_MODE 0x73
66 #define AUO_PIXCIR_REG_VERSION 0x77
67 #define AUO_PIXCIR_REG_CALIBRATE 0x78
69 #define AUO_PIXCIR_REG_TOUCHAREA_X1 0x1e
70 #define AUO_PIXCIR_REG_TOUCHAREA_Y1 0x1f
71 #define AUO_PIXCIR_REG_TOUCHAREA_X2 0x20
72 #define AUO_PIXCIR_REG_TOUCHAREA_Y2 0x21
74 #define AUO_PIXCIR_REG_EEPROM_CALIB_X 0x42
75 #define AUO_PIXCIR_REG_EEPROM_CALIB_Y 0xad
77 #define AUO_PIXCIR_INT_TPNUM_MASK 0xe0
78 #define AUO_PIXCIR_INT_TPNUM_SHIFT 5
79 #define AUO_PIXCIR_INT_RELEASE (1 << 4)
80 #define AUO_PIXCIR_INT_ENABLE (1 << 3)
81 #define AUO_PIXCIR_INT_POL_HIGH (1 << 2)
82 #define AUO_PIXCIR_INT_MODE_MASK 0x03
85 * Power modes:
86 * active: scan speed 60Hz
87 * sleep: scan speed 10Hz can be auto-activated, wakeup on 1st touch
88 * deep sleep: scan speed 1Hz can only be entered or left manually.
90 #define AUO_PIXCIR_POWER_ACTIVE 0x00
91 #define AUO_PIXCIR_POWER_SLEEP 0x01
92 #define AUO_PIXCIR_POWER_DEEP_SLEEP 0x02
93 #define AUO_PIXCIR_POWER_MASK 0x03
95 #define AUO_PIXCIR_POWER_ALLOW_SLEEP (1 << 2)
96 #define AUO_PIXCIR_POWER_IDLE_TIME(ms) ((ms & 0xf) << 4)
98 #define AUO_PIXCIR_CALIBRATE 0x03
100 #define AUO_PIXCIR_EEPROM_CALIB_X_LEN 62
101 #define AUO_PIXCIR_EEPROM_CALIB_Y_LEN 36
103 #define AUO_PIXCIR_RAW_DATA_X_LEN 18
104 #define AUO_PIXCIR_RAW_DATA_Y_LEN 11
106 #define AUO_PIXCIR_STRENGTH_ENABLE (1 << 0)
108 /* Touchscreen absolute values */
109 #define AUO_PIXCIR_REPORT_POINTS 2
110 #define AUO_PIXCIR_MAX_AREA 0xff
111 #define AUO_PIXCIR_PENUP_TIMEOUT_MS 10
113 struct auo_pixcir_ts {
114 struct i2c_client *client;
115 struct input_dev *input;
116 const struct auo_pixcir_ts_platdata *pdata;
117 char phys[32];
119 /* special handling for touch_indicate interupt mode */
120 bool touch_ind_mode;
122 wait_queue_head_t wait;
123 bool stopped;
126 struct auo_point_t {
127 int coord_x;
128 int coord_y;
129 int area_major;
130 int area_minor;
131 int orientation;
134 static int auo_pixcir_collect_data(struct auo_pixcir_ts *ts,
135 struct auo_point_t *point)
137 struct i2c_client *client = ts->client;
138 const struct auo_pixcir_ts_platdata *pdata = ts->pdata;
139 uint8_t raw_coord[8];
140 uint8_t raw_area[4];
141 int i, ret;
143 /* touch coordinates */
144 ret = i2c_smbus_read_i2c_block_data(client, AUO_PIXCIR_REG_X1_LSB,
145 8, raw_coord);
146 if (ret < 0) {
147 dev_err(&client->dev, "failed to read coordinate, %d\n", ret);
148 return ret;
151 /* touch area */
152 ret = i2c_smbus_read_i2c_block_data(client, AUO_PIXCIR_REG_TOUCHAREA_X1,
153 4, raw_area);
154 if (ret < 0) {
155 dev_err(&client->dev, "could not read touch area, %d\n", ret);
156 return ret;
159 for (i = 0; i < AUO_PIXCIR_REPORT_POINTS; i++) {
160 point[i].coord_x =
161 raw_coord[4 * i + 1] << 8 | raw_coord[4 * i];
162 point[i].coord_y =
163 raw_coord[4 * i + 3] << 8 | raw_coord[4 * i + 2];
165 if (point[i].coord_x > pdata->x_max ||
166 point[i].coord_y > pdata->y_max) {
167 dev_warn(&client->dev, "coordinates (%d,%d) invalid\n",
168 point[i].coord_x, point[i].coord_y);
169 point[i].coord_x = point[i].coord_y = 0;
172 /* determine touch major, minor and orientation */
173 point[i].area_major = max(raw_area[2 * i], raw_area[2 * i + 1]);
174 point[i].area_minor = min(raw_area[2 * i], raw_area[2 * i + 1]);
175 point[i].orientation = raw_area[2 * i] > raw_area[2 * i + 1];
178 return 0;
181 static irqreturn_t auo_pixcir_interrupt(int irq, void *dev_id)
183 struct auo_pixcir_ts *ts = dev_id;
184 const struct auo_pixcir_ts_platdata *pdata = ts->pdata;
185 struct auo_point_t point[AUO_PIXCIR_REPORT_POINTS];
186 int i;
187 int ret;
188 int fingers = 0;
189 int abs = -1;
191 while (!ts->stopped) {
193 /* check for up event in touch touch_ind_mode */
194 if (ts->touch_ind_mode) {
195 if (gpio_get_value(pdata->gpio_int) == 0) {
196 input_mt_sync(ts->input);
197 input_report_key(ts->input, BTN_TOUCH, 0);
198 input_sync(ts->input);
199 break;
203 ret = auo_pixcir_collect_data(ts, point);
204 if (ret < 0) {
205 /* we want to loop only in touch_ind_mode */
206 if (!ts->touch_ind_mode)
207 break;
209 wait_event_timeout(ts->wait, ts->stopped,
210 msecs_to_jiffies(AUO_PIXCIR_PENUP_TIMEOUT_MS));
211 continue;
214 for (i = 0; i < AUO_PIXCIR_REPORT_POINTS; i++) {
215 if (point[i].coord_x > 0 || point[i].coord_y > 0) {
216 input_report_abs(ts->input, ABS_MT_POSITION_X,
217 point[i].coord_x);
218 input_report_abs(ts->input, ABS_MT_POSITION_Y,
219 point[i].coord_y);
220 input_report_abs(ts->input, ABS_MT_TOUCH_MAJOR,
221 point[i].area_major);
222 input_report_abs(ts->input, ABS_MT_TOUCH_MINOR,
223 point[i].area_minor);
224 input_report_abs(ts->input, ABS_MT_ORIENTATION,
225 point[i].orientation);
226 input_mt_sync(ts->input);
228 /* use first finger as source for singletouch */
229 if (fingers == 0)
230 abs = i;
232 /* number of touch points could also be queried
233 * via i2c but would require an additional call
235 fingers++;
239 input_report_key(ts->input, BTN_TOUCH, fingers > 0);
241 if (abs > -1) {
242 input_report_abs(ts->input, ABS_X, point[abs].coord_x);
243 input_report_abs(ts->input, ABS_Y, point[abs].coord_y);
246 input_sync(ts->input);
248 /* we want to loop only in touch_ind_mode */
249 if (!ts->touch_ind_mode)
250 break;
252 wait_event_timeout(ts->wait, ts->stopped,
253 msecs_to_jiffies(AUO_PIXCIR_PENUP_TIMEOUT_MS));
256 return IRQ_HANDLED;
260 * Set the power mode of the device.
261 * Valid modes are
262 * - AUO_PIXCIR_POWER_ACTIVE
263 * - AUO_PIXCIR_POWER_SLEEP - automatically left on first touch
264 * - AUO_PIXCIR_POWER_DEEP_SLEEP
266 static int auo_pixcir_power_mode(struct auo_pixcir_ts *ts, int mode)
268 struct i2c_client *client = ts->client;
269 int ret;
271 ret = i2c_smbus_read_byte_data(client, AUO_PIXCIR_REG_POWER_MODE);
272 if (ret < 0) {
273 dev_err(&client->dev, "unable to read reg %Xh, %d\n",
274 AUO_PIXCIR_REG_POWER_MODE, ret);
275 return ret;
278 ret &= ~AUO_PIXCIR_POWER_MASK;
279 ret |= mode;
281 ret = i2c_smbus_write_byte_data(client, AUO_PIXCIR_REG_POWER_MODE, ret);
282 if (ret) {
283 dev_err(&client->dev, "unable to write reg %Xh, %d\n",
284 AUO_PIXCIR_REG_POWER_MODE, ret);
285 return ret;
288 return 0;
291 static int auo_pixcir_int_config(struct auo_pixcir_ts *ts,
292 int int_setting)
294 struct i2c_client *client = ts->client;
295 const struct auo_pixcir_ts_platdata *pdata = ts->pdata;
296 int ret;
298 ret = i2c_smbus_read_byte_data(client, AUO_PIXCIR_REG_INT_SETTING);
299 if (ret < 0) {
300 dev_err(&client->dev, "unable to read reg %Xh, %d\n",
301 AUO_PIXCIR_REG_INT_SETTING, ret);
302 return ret;
305 ret &= ~AUO_PIXCIR_INT_MODE_MASK;
306 ret |= int_setting;
307 ret |= AUO_PIXCIR_INT_POL_HIGH; /* always use high for interrupts */
309 ret = i2c_smbus_write_byte_data(client, AUO_PIXCIR_REG_INT_SETTING,
310 ret);
311 if (ret < 0) {
312 dev_err(&client->dev, "unable to write reg %Xh, %d\n",
313 AUO_PIXCIR_REG_INT_SETTING, ret);
314 return ret;
317 ts->touch_ind_mode = pdata->int_setting == AUO_PIXCIR_INT_TOUCH_IND;
319 return 0;
322 /* control the generation of interrupts on the device side */
323 static int auo_pixcir_int_toggle(struct auo_pixcir_ts *ts, bool enable)
325 struct i2c_client *client = ts->client;
326 int ret;
328 ret = i2c_smbus_read_byte_data(client, AUO_PIXCIR_REG_INT_SETTING);
329 if (ret < 0) {
330 dev_err(&client->dev, "unable to read reg %Xh, %d\n",
331 AUO_PIXCIR_REG_INT_SETTING, ret);
332 return ret;
335 if (enable)
336 ret |= AUO_PIXCIR_INT_ENABLE;
337 else
338 ret &= ~AUO_PIXCIR_INT_ENABLE;
340 ret = i2c_smbus_write_byte_data(client, AUO_PIXCIR_REG_INT_SETTING,
341 ret);
342 if (ret < 0) {
343 dev_err(&client->dev, "unable to write reg %Xh, %d\n",
344 AUO_PIXCIR_REG_INT_SETTING, ret);
345 return ret;
348 return 0;
351 static int auo_pixcir_start(struct auo_pixcir_ts *ts)
353 struct i2c_client *client = ts->client;
354 int ret;
356 ret = auo_pixcir_power_mode(ts, AUO_PIXCIR_POWER_ACTIVE);
357 if (ret < 0) {
358 dev_err(&client->dev, "could not set power mode, %d\n",
359 ret);
360 return ret;
363 ts->stopped = false;
364 mb();
365 enable_irq(client->irq);
367 ret = auo_pixcir_int_toggle(ts, 1);
368 if (ret < 0) {
369 dev_err(&client->dev, "could not enable interrupt, %d\n",
370 ret);
371 disable_irq(client->irq);
372 return ret;
375 return 0;
378 static int auo_pixcir_stop(struct auo_pixcir_ts *ts)
380 struct i2c_client *client = ts->client;
381 int ret;
383 ret = auo_pixcir_int_toggle(ts, 0);
384 if (ret < 0) {
385 dev_err(&client->dev, "could not disable interrupt, %d\n",
386 ret);
387 return ret;
390 /* disable receiving of interrupts */
391 disable_irq(client->irq);
392 ts->stopped = true;
393 mb();
394 wake_up(&ts->wait);
396 return auo_pixcir_power_mode(ts, AUO_PIXCIR_POWER_DEEP_SLEEP);
399 static int auo_pixcir_input_open(struct input_dev *dev)
401 struct auo_pixcir_ts *ts = input_get_drvdata(dev);
403 return auo_pixcir_start(ts);
406 static void auo_pixcir_input_close(struct input_dev *dev)
408 struct auo_pixcir_ts *ts = input_get_drvdata(dev);
410 auo_pixcir_stop(ts);
413 static int __maybe_unused auo_pixcir_suspend(struct device *dev)
415 struct i2c_client *client = to_i2c_client(dev);
416 struct auo_pixcir_ts *ts = i2c_get_clientdata(client);
417 struct input_dev *input = ts->input;
418 int ret = 0;
420 mutex_lock(&input->mutex);
422 /* when configured as wakeup source, device should always wake system
423 * therefore start device if necessary
425 if (device_may_wakeup(&client->dev)) {
426 /* need to start device if not open, to be wakeup source */
427 if (!input->users) {
428 ret = auo_pixcir_start(ts);
429 if (ret)
430 goto unlock;
433 enable_irq_wake(client->irq);
434 ret = auo_pixcir_power_mode(ts, AUO_PIXCIR_POWER_SLEEP);
435 } else if (input->users) {
436 ret = auo_pixcir_stop(ts);
439 unlock:
440 mutex_unlock(&input->mutex);
442 return ret;
445 static int __maybe_unused auo_pixcir_resume(struct device *dev)
447 struct i2c_client *client = to_i2c_client(dev);
448 struct auo_pixcir_ts *ts = i2c_get_clientdata(client);
449 struct input_dev *input = ts->input;
450 int ret = 0;
452 mutex_lock(&input->mutex);
454 if (device_may_wakeup(&client->dev)) {
455 disable_irq_wake(client->irq);
457 /* need to stop device if it was not open on suspend */
458 if (!input->users) {
459 ret = auo_pixcir_stop(ts);
460 if (ret)
461 goto unlock;
464 /* device wakes automatically from SLEEP */
465 } else if (input->users) {
466 ret = auo_pixcir_start(ts);
469 unlock:
470 mutex_unlock(&input->mutex);
472 return ret;
475 static SIMPLE_DEV_PM_OPS(auo_pixcir_pm_ops,
476 auo_pixcir_suspend, auo_pixcir_resume);
478 #ifdef CONFIG_OF
479 static struct auo_pixcir_ts_platdata *auo_pixcir_parse_dt(struct device *dev)
481 struct auo_pixcir_ts_platdata *pdata;
482 struct device_node *np = dev->of_node;
484 if (!np)
485 return ERR_PTR(-ENOENT);
487 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
488 if (!pdata)
489 return ERR_PTR(-ENOMEM);
491 pdata->gpio_int = of_get_gpio(np, 0);
492 if (!gpio_is_valid(pdata->gpio_int)) {
493 dev_err(dev, "failed to get interrupt gpio\n");
494 return ERR_PTR(-EINVAL);
497 pdata->gpio_rst = of_get_gpio(np, 1);
498 if (!gpio_is_valid(pdata->gpio_rst)) {
499 dev_err(dev, "failed to get reset gpio\n");
500 return ERR_PTR(-EINVAL);
503 if (of_property_read_u32(np, "x-size", &pdata->x_max)) {
504 dev_err(dev, "failed to get x-size property\n");
505 return ERR_PTR(-EINVAL);
508 if (of_property_read_u32(np, "y-size", &pdata->y_max)) {
509 dev_err(dev, "failed to get y-size property\n");
510 return ERR_PTR(-EINVAL);
513 /* default to asserting the interrupt when the screen is touched */
514 pdata->int_setting = AUO_PIXCIR_INT_TOUCH_IND;
516 return pdata;
518 #else
519 static struct auo_pixcir_ts_platdata *auo_pixcir_parse_dt(struct device *dev)
521 return ERR_PTR(-EINVAL);
523 #endif
525 static void auo_pixcir_reset(void *data)
527 struct auo_pixcir_ts *ts = data;
529 gpio_set_value(ts->pdata->gpio_rst, 0);
532 static int auo_pixcir_probe(struct i2c_client *client,
533 const struct i2c_device_id *id)
535 const struct auo_pixcir_ts_platdata *pdata;
536 struct auo_pixcir_ts *ts;
537 struct input_dev *input_dev;
538 int version;
539 int error;
541 pdata = dev_get_platdata(&client->dev);
542 if (!pdata) {
543 pdata = auo_pixcir_parse_dt(&client->dev);
544 if (IS_ERR(pdata))
545 return PTR_ERR(pdata);
548 ts = devm_kzalloc(&client->dev,
549 sizeof(struct auo_pixcir_ts), GFP_KERNEL);
550 if (!ts)
551 return -ENOMEM;
553 input_dev = devm_input_allocate_device(&client->dev);
554 if (!input_dev) {
555 dev_err(&client->dev, "could not allocate input device\n");
556 return -ENOMEM;
559 ts->pdata = pdata;
560 ts->client = client;
561 ts->input = input_dev;
562 ts->touch_ind_mode = 0;
563 ts->stopped = true;
564 init_waitqueue_head(&ts->wait);
566 snprintf(ts->phys, sizeof(ts->phys),
567 "%s/input0", dev_name(&client->dev));
569 input_dev->name = "AUO-Pixcir touchscreen";
570 input_dev->phys = ts->phys;
571 input_dev->id.bustype = BUS_I2C;
573 input_dev->open = auo_pixcir_input_open;
574 input_dev->close = auo_pixcir_input_close;
576 __set_bit(EV_ABS, input_dev->evbit);
577 __set_bit(EV_KEY, input_dev->evbit);
579 __set_bit(BTN_TOUCH, input_dev->keybit);
581 /* For single touch */
582 input_set_abs_params(input_dev, ABS_X, 0, pdata->x_max, 0, 0);
583 input_set_abs_params(input_dev, ABS_Y, 0, pdata->y_max, 0, 0);
585 /* For multi touch */
586 input_set_abs_params(input_dev, ABS_MT_POSITION_X, 0,
587 pdata->x_max, 0, 0);
588 input_set_abs_params(input_dev, ABS_MT_POSITION_Y, 0,
589 pdata->y_max, 0, 0);
590 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR, 0,
591 AUO_PIXCIR_MAX_AREA, 0, 0);
592 input_set_abs_params(input_dev, ABS_MT_TOUCH_MINOR, 0,
593 AUO_PIXCIR_MAX_AREA, 0, 0);
594 input_set_abs_params(input_dev, ABS_MT_ORIENTATION, 0, 1, 0, 0);
596 input_set_drvdata(ts->input, ts);
598 error = devm_gpio_request_one(&client->dev, pdata->gpio_int,
599 GPIOF_DIR_IN, "auo_pixcir_ts_int");
600 if (error) {
601 dev_err(&client->dev, "request of gpio %d failed, %d\n",
602 pdata->gpio_int, error);
603 return error;
606 error = devm_gpio_request_one(&client->dev, pdata->gpio_rst,
607 GPIOF_DIR_OUT | GPIOF_INIT_HIGH,
608 "auo_pixcir_ts_rst");
609 if (error) {
610 dev_err(&client->dev, "request of gpio %d failed, %d\n",
611 pdata->gpio_rst, error);
612 return error;
615 error = devm_add_action(&client->dev, auo_pixcir_reset, ts);
616 if (error) {
617 auo_pixcir_reset(ts);
618 dev_err(&client->dev, "failed to register reset action, %d\n",
619 error);
620 return error;
623 msleep(200);
625 version = i2c_smbus_read_byte_data(client, AUO_PIXCIR_REG_VERSION);
626 if (version < 0) {
627 error = version;
628 return error;
631 dev_info(&client->dev, "firmware version 0x%X\n", version);
633 error = auo_pixcir_int_config(ts, pdata->int_setting);
634 if (error)
635 return error;
637 error = devm_request_threaded_irq(&client->dev, client->irq,
638 NULL, auo_pixcir_interrupt,
639 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
640 input_dev->name, ts);
641 if (error) {
642 dev_err(&client->dev, "irq %d requested failed, %d\n",
643 client->irq, error);
644 return error;
647 /* stop device and put it into deep sleep until it is opened */
648 error = auo_pixcir_stop(ts);
649 if (error)
650 return error;
652 error = input_register_device(input_dev);
653 if (error) {
654 dev_err(&client->dev, "could not register input device, %d\n",
655 error);
656 return error;
659 i2c_set_clientdata(client, ts);
661 return 0;
664 static const struct i2c_device_id auo_pixcir_idtable[] = {
665 { "auo_pixcir_ts", 0 },
668 MODULE_DEVICE_TABLE(i2c, auo_pixcir_idtable);
670 #ifdef CONFIG_OF
671 static const struct of_device_id auo_pixcir_ts_dt_idtable[] = {
672 { .compatible = "auo,auo_pixcir_ts" },
675 MODULE_DEVICE_TABLE(of, auo_pixcir_ts_dt_idtable);
676 #endif
678 static struct i2c_driver auo_pixcir_driver = {
679 .driver = {
680 .name = "auo_pixcir_ts",
681 .pm = &auo_pixcir_pm_ops,
682 .of_match_table = of_match_ptr(auo_pixcir_ts_dt_idtable),
684 .probe = auo_pixcir_probe,
685 .id_table = auo_pixcir_idtable,
688 module_i2c_driver(auo_pixcir_driver);
690 MODULE_DESCRIPTION("AUO-PIXCIR touchscreen driver");
691 MODULE_LICENSE("GPL v2");
692 MODULE_AUTHOR("Heiko Stuebner <heiko@sntech.de>");