Loading...
1/*
2 * AD7879/AD7889 based touchscreen and GPIO driver
3 *
4 * Copyright (C) 2008-2010 Michael Hennerich, Analog Devices Inc.
5 *
6 * Licensed under the GPL-2 or later.
7 *
8 * History:
9 * Copyright (c) 2005 David Brownell
10 * Copyright (c) 2006 Nokia Corporation
11 * Various changes: Imre Deak <imre.deak@nokia.com>
12 *
13 * Using code from:
14 * - corgi_ts.c
15 * Copyright (C) 2004-2005 Richard Purdie
16 * - omap_ts.[hc], ads7846.h, ts_osk.c
17 * Copyright (C) 2002 MontaVista Software
18 * Copyright (C) 2004 Texas Instruments
19 * Copyright (C) 2005 Dirk Behme
20 * - ad7877.c
21 * Copyright (C) 2006-2008 Analog Devices Inc.
22 */
23
24#include <linux/device.h>
25#include <linux/delay.h>
26#include <linux/input.h>
27#include <linux/interrupt.h>
28#include <linux/irq.h>
29#include <linux/slab.h>
30#include <linux/spi/spi.h>
31#include <linux/i2c.h>
32#include <linux/gpio.h>
33
34#include <linux/input/touchscreen.h>
35#include <linux/platform_data/ad7879.h>
36#include <linux/module.h>
37#include "ad7879.h"
38
39#define AD7879_REG_ZEROS 0
40#define AD7879_REG_CTRL1 1
41#define AD7879_REG_CTRL2 2
42#define AD7879_REG_CTRL3 3
43#define AD7879_REG_AUX1HIGH 4
44#define AD7879_REG_AUX1LOW 5
45#define AD7879_REG_TEMP1HIGH 6
46#define AD7879_REG_TEMP1LOW 7
47#define AD7879_REG_XPLUS 8
48#define AD7879_REG_YPLUS 9
49#define AD7879_REG_Z1 10
50#define AD7879_REG_Z2 11
51#define AD7879_REG_AUXVBAT 12
52#define AD7879_REG_TEMP 13
53#define AD7879_REG_REVID 14
54
55/* Control REG 1 */
56#define AD7879_TMR(x) ((x & 0xFF) << 0)
57#define AD7879_ACQ(x) ((x & 0x3) << 8)
58#define AD7879_MODE_NOC (0 << 10) /* Do not convert */
59#define AD7879_MODE_SCC (1 << 10) /* Single channel conversion */
60#define AD7879_MODE_SEQ0 (2 << 10) /* Sequence 0 in Slave Mode */
61#define AD7879_MODE_SEQ1 (3 << 10) /* Sequence 1 in Master Mode */
62#define AD7879_MODE_INT (1 << 15) /* PENIRQ disabled INT enabled */
63
64/* Control REG 2 */
65#define AD7879_FCD(x) ((x & 0x3) << 0)
66#define AD7879_RESET (1 << 4)
67#define AD7879_MFS(x) ((x & 0x3) << 5)
68#define AD7879_AVG(x) ((x & 0x3) << 7)
69#define AD7879_SER (1 << 9) /* non-differential */
70#define AD7879_DFR (0 << 9) /* differential */
71#define AD7879_GPIOPOL (1 << 10)
72#define AD7879_GPIODIR (1 << 11)
73#define AD7879_GPIO_DATA (1 << 12)
74#define AD7879_GPIO_EN (1 << 13)
75#define AD7879_PM(x) ((x & 0x3) << 14)
76#define AD7879_PM_SHUTDOWN (0)
77#define AD7879_PM_DYN (1)
78#define AD7879_PM_FULLON (2)
79
80/* Control REG 3 */
81#define AD7879_TEMPMASK_BIT (1<<15)
82#define AD7879_AUXVBATMASK_BIT (1<<14)
83#define AD7879_INTMODE_BIT (1<<13)
84#define AD7879_GPIOALERTMASK_BIT (1<<12)
85#define AD7879_AUXLOW_BIT (1<<11)
86#define AD7879_AUXHIGH_BIT (1<<10)
87#define AD7879_TEMPLOW_BIT (1<<9)
88#define AD7879_TEMPHIGH_BIT (1<<8)
89#define AD7879_YPLUS_BIT (1<<7)
90#define AD7879_XPLUS_BIT (1<<6)
91#define AD7879_Z1_BIT (1<<5)
92#define AD7879_Z2_BIT (1<<4)
93#define AD7879_AUX_BIT (1<<3)
94#define AD7879_VBAT_BIT (1<<2)
95#define AD7879_TEMP_BIT (1<<1)
96
97enum {
98 AD7879_SEQ_YPOS = 0,
99 AD7879_SEQ_XPOS = 1,
100 AD7879_SEQ_Z1 = 2,
101 AD7879_SEQ_Z2 = 3,
102 AD7879_NR_SENSE = 4,
103};
104
105#define MAX_12BIT ((1<<12)-1)
106#define TS_PEN_UP_TIMEOUT msecs_to_jiffies(50)
107
108struct ad7879 {
109 const struct ad7879_bus_ops *bops;
110
111 struct device *dev;
112 struct input_dev *input;
113 struct timer_list timer;
114#ifdef CONFIG_GPIOLIB
115 struct gpio_chip gc;
116 struct mutex mutex;
117#endif
118 unsigned int irq;
119 bool disabled; /* P: input->mutex */
120 bool suspended; /* P: input->mutex */
121 bool swap_xy;
122 u16 conversion_data[AD7879_NR_SENSE];
123 char phys[32];
124 u8 first_conversion_delay;
125 u8 acquisition_time;
126 u8 averaging;
127 u8 pen_down_acc_interval;
128 u8 median;
129 u16 x_plate_ohms;
130 u16 cmd_crtl1;
131 u16 cmd_crtl2;
132 u16 cmd_crtl3;
133 int x;
134 int y;
135 int Rt;
136};
137
138static int ad7879_read(struct ad7879 *ts, u8 reg)
139{
140 return ts->bops->read(ts->dev, reg);
141}
142
143static int ad7879_multi_read(struct ad7879 *ts, u8 first_reg, u8 count, u16 *buf)
144{
145 return ts->bops->multi_read(ts->dev, first_reg, count, buf);
146}
147
148static int ad7879_write(struct ad7879 *ts, u8 reg, u16 val)
149{
150 return ts->bops->write(ts->dev, reg, val);
151}
152
153static int ad7879_report(struct ad7879 *ts)
154{
155 struct input_dev *input_dev = ts->input;
156 unsigned Rt;
157 u16 x, y, z1, z2;
158
159 x = ts->conversion_data[AD7879_SEQ_XPOS] & MAX_12BIT;
160 y = ts->conversion_data[AD7879_SEQ_YPOS] & MAX_12BIT;
161 z1 = ts->conversion_data[AD7879_SEQ_Z1] & MAX_12BIT;
162 z2 = ts->conversion_data[AD7879_SEQ_Z2] & MAX_12BIT;
163
164 if (ts->swap_xy)
165 swap(x, y);
166
167 /*
168 * The samples processed here are already preprocessed by the AD7879.
169 * The preprocessing function consists of a median and an averaging
170 * filter. The combination of these two techniques provides a robust
171 * solution, discarding the spurious noise in the signal and keeping
172 * only the data of interest. The size of both filters is
173 * programmable. (dev.platform_data, see linux/platform_data/ad7879.h)
174 * Other user-programmable conversion controls include variable
175 * acquisition time, and first conversion delay. Up to 16 averages can
176 * be taken per conversion.
177 */
178
179 if (likely(x && z1)) {
180 /* compute touch pressure resistance using equation #1 */
181 Rt = (z2 - z1) * x * ts->x_plate_ohms;
182 Rt /= z1;
183 Rt = (Rt + 2047) >> 12;
184
185 /*
186 * Sample found inconsistent, pressure is beyond
187 * the maximum. Don't report it to user space.
188 */
189 if (Rt > input_abs_get_max(input_dev, ABS_PRESSURE))
190 return -EINVAL;
191
192 /*
193 * Note that we delay reporting events by one sample.
194 * This is done to avoid reporting last sample of the
195 * touch sequence, which may be incomplete if finger
196 * leaves the surface before last reading is taken.
197 */
198 if (timer_pending(&ts->timer)) {
199 /* Touch continues */
200 input_report_key(input_dev, BTN_TOUCH, 1);
201 input_report_abs(input_dev, ABS_X, ts->x);
202 input_report_abs(input_dev, ABS_Y, ts->y);
203 input_report_abs(input_dev, ABS_PRESSURE, ts->Rt);
204 input_sync(input_dev);
205 }
206
207 ts->x = x;
208 ts->y = y;
209 ts->Rt = Rt;
210
211 return 0;
212 }
213
214 return -EINVAL;
215}
216
217static void ad7879_ts_event_release(struct ad7879 *ts)
218{
219 struct input_dev *input_dev = ts->input;
220
221 input_report_abs(input_dev, ABS_PRESSURE, 0);
222 input_report_key(input_dev, BTN_TOUCH, 0);
223 input_sync(input_dev);
224}
225
226static void ad7879_timer(unsigned long handle)
227{
228 struct ad7879 *ts = (void *)handle;
229
230 ad7879_ts_event_release(ts);
231}
232
233static irqreturn_t ad7879_irq(int irq, void *handle)
234{
235 struct ad7879 *ts = handle;
236
237 ad7879_multi_read(ts, AD7879_REG_XPLUS, AD7879_NR_SENSE, ts->conversion_data);
238
239 if (!ad7879_report(ts))
240 mod_timer(&ts->timer, jiffies + TS_PEN_UP_TIMEOUT);
241
242 return IRQ_HANDLED;
243}
244
245static void __ad7879_enable(struct ad7879 *ts)
246{
247 ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
248 ad7879_write(ts, AD7879_REG_CTRL3, ts->cmd_crtl3);
249 ad7879_write(ts, AD7879_REG_CTRL1, ts->cmd_crtl1);
250
251 enable_irq(ts->irq);
252}
253
254static void __ad7879_disable(struct ad7879 *ts)
255{
256 u16 reg = (ts->cmd_crtl2 & ~AD7879_PM(-1)) |
257 AD7879_PM(AD7879_PM_SHUTDOWN);
258 disable_irq(ts->irq);
259
260 if (del_timer_sync(&ts->timer))
261 ad7879_ts_event_release(ts);
262
263 ad7879_write(ts, AD7879_REG_CTRL2, reg);
264}
265
266
267static int ad7879_open(struct input_dev *input)
268{
269 struct ad7879 *ts = input_get_drvdata(input);
270
271 /* protected by input->mutex */
272 if (!ts->disabled && !ts->suspended)
273 __ad7879_enable(ts);
274
275 return 0;
276}
277
278static void ad7879_close(struct input_dev* input)
279{
280 struct ad7879 *ts = input_get_drvdata(input);
281
282 /* protected by input->mutex */
283 if (!ts->disabled && !ts->suspended)
284 __ad7879_disable(ts);
285}
286
287static int __maybe_unused ad7879_suspend(struct device *dev)
288{
289 struct ad7879 *ts = dev_get_drvdata(dev);
290
291 mutex_lock(&ts->input->mutex);
292
293 if (!ts->suspended && !ts->disabled && ts->input->users)
294 __ad7879_disable(ts);
295
296 ts->suspended = true;
297
298 mutex_unlock(&ts->input->mutex);
299
300 return 0;
301}
302
303static int __maybe_unused ad7879_resume(struct device *dev)
304{
305 struct ad7879 *ts = dev_get_drvdata(dev);
306
307 mutex_lock(&ts->input->mutex);
308
309 if (ts->suspended && !ts->disabled && ts->input->users)
310 __ad7879_enable(ts);
311
312 ts->suspended = false;
313
314 mutex_unlock(&ts->input->mutex);
315
316 return 0;
317}
318
319SIMPLE_DEV_PM_OPS(ad7879_pm_ops, ad7879_suspend, ad7879_resume);
320EXPORT_SYMBOL(ad7879_pm_ops);
321
322static void ad7879_toggle(struct ad7879 *ts, bool disable)
323{
324 mutex_lock(&ts->input->mutex);
325
326 if (!ts->suspended && ts->input->users != 0) {
327
328 if (disable) {
329 if (ts->disabled)
330 __ad7879_enable(ts);
331 } else {
332 if (!ts->disabled)
333 __ad7879_disable(ts);
334 }
335 }
336
337 ts->disabled = disable;
338
339 mutex_unlock(&ts->input->mutex);
340}
341
342static ssize_t ad7879_disable_show(struct device *dev,
343 struct device_attribute *attr, char *buf)
344{
345 struct ad7879 *ts = dev_get_drvdata(dev);
346
347 return sprintf(buf, "%u\n", ts->disabled);
348}
349
350static ssize_t ad7879_disable_store(struct device *dev,
351 struct device_attribute *attr,
352 const char *buf, size_t count)
353{
354 struct ad7879 *ts = dev_get_drvdata(dev);
355 unsigned int val;
356 int error;
357
358 error = kstrtouint(buf, 10, &val);
359 if (error)
360 return error;
361
362 ad7879_toggle(ts, val);
363
364 return count;
365}
366
367static DEVICE_ATTR(disable, 0664, ad7879_disable_show, ad7879_disable_store);
368
369static struct attribute *ad7879_attributes[] = {
370 &dev_attr_disable.attr,
371 NULL
372};
373
374static const struct attribute_group ad7879_attr_group = {
375 .attrs = ad7879_attributes,
376};
377
378#ifdef CONFIG_GPIOLIB
379static int ad7879_gpio_direction_input(struct gpio_chip *chip,
380 unsigned gpio)
381{
382 struct ad7879 *ts = container_of(chip, struct ad7879, gc);
383 int err;
384
385 mutex_lock(&ts->mutex);
386 ts->cmd_crtl2 |= AD7879_GPIO_EN | AD7879_GPIODIR | AD7879_GPIOPOL;
387 err = ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
388 mutex_unlock(&ts->mutex);
389
390 return err;
391}
392
393static int ad7879_gpio_direction_output(struct gpio_chip *chip,
394 unsigned gpio, int level)
395{
396 struct ad7879 *ts = container_of(chip, struct ad7879, gc);
397 int err;
398
399 mutex_lock(&ts->mutex);
400 ts->cmd_crtl2 &= ~AD7879_GPIODIR;
401 ts->cmd_crtl2 |= AD7879_GPIO_EN | AD7879_GPIOPOL;
402 if (level)
403 ts->cmd_crtl2 |= AD7879_GPIO_DATA;
404 else
405 ts->cmd_crtl2 &= ~AD7879_GPIO_DATA;
406
407 err = ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
408 mutex_unlock(&ts->mutex);
409
410 return err;
411}
412
413static int ad7879_gpio_get_value(struct gpio_chip *chip, unsigned gpio)
414{
415 struct ad7879 *ts = container_of(chip, struct ad7879, gc);
416 u16 val;
417
418 mutex_lock(&ts->mutex);
419 val = ad7879_read(ts, AD7879_REG_CTRL2);
420 mutex_unlock(&ts->mutex);
421
422 return !!(val & AD7879_GPIO_DATA);
423}
424
425static void ad7879_gpio_set_value(struct gpio_chip *chip,
426 unsigned gpio, int value)
427{
428 struct ad7879 *ts = container_of(chip, struct ad7879, gc);
429
430 mutex_lock(&ts->mutex);
431 if (value)
432 ts->cmd_crtl2 |= AD7879_GPIO_DATA;
433 else
434 ts->cmd_crtl2 &= ~AD7879_GPIO_DATA;
435
436 ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
437 mutex_unlock(&ts->mutex);
438}
439
440static int ad7879_gpio_add(struct ad7879 *ts,
441 const struct ad7879_platform_data *pdata)
442{
443 int ret = 0;
444
445 mutex_init(&ts->mutex);
446
447 if (pdata->gpio_export) {
448 ts->gc.direction_input = ad7879_gpio_direction_input;
449 ts->gc.direction_output = ad7879_gpio_direction_output;
450 ts->gc.get = ad7879_gpio_get_value;
451 ts->gc.set = ad7879_gpio_set_value;
452 ts->gc.can_sleep = 1;
453 ts->gc.base = pdata->gpio_base;
454 ts->gc.ngpio = 1;
455 ts->gc.label = "AD7879-GPIO";
456 ts->gc.owner = THIS_MODULE;
457 ts->gc.parent = ts->dev;
458
459 ret = gpiochip_add(&ts->gc);
460 if (ret)
461 dev_err(ts->dev, "failed to register gpio %d\n",
462 ts->gc.base);
463 }
464
465 return ret;
466}
467
468static void ad7879_gpio_remove(struct ad7879 *ts)
469{
470 const struct ad7879_platform_data *pdata = dev_get_platdata(ts->dev);
471
472 if (pdata && pdata->gpio_export)
473 gpiochip_remove(&ts->gc);
474
475}
476#else
477static inline int ad7879_gpio_add(struct ad7879 *ts,
478 const struct ad7879_platform_data *pdata)
479{
480 return 0;
481}
482
483static inline void ad7879_gpio_remove(struct ad7879 *ts)
484{
485}
486#endif
487
488static int ad7879_parse_dt(struct device *dev, struct ad7879 *ts)
489{
490 int err;
491 u32 tmp;
492
493 err = device_property_read_u32(dev, "adi,resistance-plate-x", &tmp);
494 if (err) {
495 dev_err(dev, "failed to get resistance-plate-x property\n");
496 return err;
497 }
498 ts->x_plate_ohms = (u16)tmp;
499
500 device_property_read_u8(dev, "adi,first-conversion-delay",
501 &ts->first_conversion_delay);
502 device_property_read_u8(dev, "adi,acquisition-time",
503 &ts->acquisition_time);
504 device_property_read_u8(dev, "adi,median-filter-size", &ts->median);
505 device_property_read_u8(dev, "adi,averaging", &ts->averaging);
506 device_property_read_u8(dev, "adi,conversion-interval",
507 &ts->pen_down_acc_interval);
508
509 ts->swap_xy = device_property_read_bool(dev, "touchscreen-swapped-x-y");
510
511 return 0;
512}
513
514struct ad7879 *ad7879_probe(struct device *dev, u8 devid, unsigned int irq,
515 const struct ad7879_bus_ops *bops)
516{
517 struct ad7879_platform_data *pdata = dev_get_platdata(dev);
518 struct ad7879 *ts;
519 struct input_dev *input_dev;
520 int err;
521 u16 revid;
522
523 if (!irq) {
524 dev_err(dev, "No IRQ specified\n");
525 return ERR_PTR(-EINVAL);
526 }
527
528 ts = devm_kzalloc(dev, sizeof(*ts), GFP_KERNEL);
529 if (!ts)
530 return ERR_PTR(-ENOMEM);
531
532 if (pdata) {
533 /* Platform data use swapped axis (backward compatibility) */
534 ts->swap_xy = !pdata->swap_xy;
535
536 ts->x_plate_ohms = pdata->x_plate_ohms ? : 400;
537
538 ts->first_conversion_delay = pdata->first_conversion_delay;
539 ts->acquisition_time = pdata->acquisition_time;
540 ts->averaging = pdata->averaging;
541 ts->pen_down_acc_interval = pdata->pen_down_acc_interval;
542 ts->median = pdata->median;
543 } else if (dev->of_node) {
544 ad7879_parse_dt(dev, ts);
545 } else {
546 dev_err(dev, "No platform data\n");
547 return ERR_PTR(-EINVAL);
548 }
549
550 input_dev = devm_input_allocate_device(dev);
551 if (!input_dev) {
552 dev_err(dev, "Failed to allocate input device\n");
553 return ERR_PTR(-ENOMEM);
554 }
555
556 ts->bops = bops;
557 ts->dev = dev;
558 ts->input = input_dev;
559 ts->irq = irq;
560
561 setup_timer(&ts->timer, ad7879_timer, (unsigned long) ts);
562 snprintf(ts->phys, sizeof(ts->phys), "%s/input0", dev_name(dev));
563
564 input_dev->name = "AD7879 Touchscreen";
565 input_dev->phys = ts->phys;
566 input_dev->dev.parent = dev;
567 input_dev->id.bustype = bops->bustype;
568
569 input_dev->open = ad7879_open;
570 input_dev->close = ad7879_close;
571
572 input_set_drvdata(input_dev, ts);
573
574 __set_bit(EV_ABS, input_dev->evbit);
575 __set_bit(ABS_X, input_dev->absbit);
576 __set_bit(ABS_Y, input_dev->absbit);
577 __set_bit(ABS_PRESSURE, input_dev->absbit);
578
579 __set_bit(EV_KEY, input_dev->evbit);
580 __set_bit(BTN_TOUCH, input_dev->keybit);
581
582 if (pdata) {
583 input_set_abs_params(input_dev, ABS_X,
584 pdata->x_min ? : 0,
585 pdata->x_max ? : MAX_12BIT,
586 0, 0);
587 input_set_abs_params(input_dev, ABS_Y,
588 pdata->y_min ? : 0,
589 pdata->y_max ? : MAX_12BIT,
590 0, 0);
591 input_set_abs_params(input_dev, ABS_PRESSURE,
592 pdata->pressure_min,
593 pdata->pressure_max ? : ~0,
594 0, 0);
595 } else {
596 input_set_abs_params(input_dev, ABS_X, 0, MAX_12BIT, 0, 0);
597 input_set_abs_params(input_dev, ABS_Y, 0, MAX_12BIT, 0, 0);
598 touchscreen_parse_properties(input_dev, false);
599 if (!input_abs_get_max(input_dev, ABS_PRESSURE)) {
600 dev_err(dev, "Touchscreen pressure is not specified\n");
601 return ERR_PTR(-EINVAL);
602 }
603 }
604
605 err = ad7879_write(ts, AD7879_REG_CTRL2, AD7879_RESET);
606 if (err < 0) {
607 dev_err(dev, "Failed to write %s\n", input_dev->name);
608 return ERR_PTR(err);
609 }
610
611 revid = ad7879_read(ts, AD7879_REG_REVID);
612 input_dev->id.product = (revid & 0xff);
613 input_dev->id.version = revid >> 8;
614 if (input_dev->id.product != devid) {
615 dev_err(dev, "Failed to probe %s (%x vs %x)\n",
616 input_dev->name, devid, revid);
617 return ERR_PTR(-ENODEV);
618 }
619
620 ts->cmd_crtl3 = AD7879_YPLUS_BIT |
621 AD7879_XPLUS_BIT |
622 AD7879_Z2_BIT |
623 AD7879_Z1_BIT |
624 AD7879_TEMPMASK_BIT |
625 AD7879_AUXVBATMASK_BIT |
626 AD7879_GPIOALERTMASK_BIT;
627
628 ts->cmd_crtl2 = AD7879_PM(AD7879_PM_DYN) | AD7879_DFR |
629 AD7879_AVG(ts->averaging) |
630 AD7879_MFS(ts->median) |
631 AD7879_FCD(ts->first_conversion_delay);
632
633 ts->cmd_crtl1 = AD7879_MODE_INT | AD7879_MODE_SEQ1 |
634 AD7879_ACQ(ts->acquisition_time) |
635 AD7879_TMR(ts->pen_down_acc_interval);
636
637 err = devm_request_threaded_irq(dev, ts->irq, NULL, ad7879_irq,
638 IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
639 dev_name(dev), ts);
640 if (err) {
641 dev_err(dev, "Failed to request IRQ: %d\n", err);
642 return ERR_PTR(err);
643 }
644
645 __ad7879_disable(ts);
646
647 err = sysfs_create_group(&dev->kobj, &ad7879_attr_group);
648 if (err)
649 goto err_out;
650
651 if (pdata) {
652 err = ad7879_gpio_add(ts, pdata);
653 if (err)
654 goto err_remove_attr;
655 }
656
657 err = input_register_device(input_dev);
658 if (err)
659 goto err_remove_gpio;
660
661 return ts;
662
663err_remove_gpio:
664 ad7879_gpio_remove(ts);
665err_remove_attr:
666 sysfs_remove_group(&dev->kobj, &ad7879_attr_group);
667err_out:
668 return ERR_PTR(err);
669}
670EXPORT_SYMBOL(ad7879_probe);
671
672void ad7879_remove(struct ad7879 *ts)
673{
674 ad7879_gpio_remove(ts);
675 sysfs_remove_group(&ts->dev->kobj, &ad7879_attr_group);
676}
677EXPORT_SYMBOL(ad7879_remove);
678
679MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
680MODULE_DESCRIPTION("AD7879(-1) touchscreen Driver");
681MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * AD7879/AD7889 based touchscreen and GPIO driver
4 *
5 * Copyright (C) 2008-2010 Michael Hennerich, Analog Devices Inc.
6 *
7 * History:
8 * Copyright (c) 2005 David Brownell
9 * Copyright (c) 2006 Nokia Corporation
10 * Various changes: Imre Deak <imre.deak@nokia.com>
11 *
12 * Using code from:
13 * - corgi_ts.c
14 * Copyright (C) 2004-2005 Richard Purdie
15 * - omap_ts.[hc], ads7846.h, ts_osk.c
16 * Copyright (C) 2002 MontaVista Software
17 * Copyright (C) 2004 Texas Instruments
18 * Copyright (C) 2005 Dirk Behme
19 * - ad7877.c
20 * Copyright (C) 2006-2008 Analog Devices Inc.
21 */
22
23#include <linux/device.h>
24#include <linux/delay.h>
25#include <linux/input.h>
26#include <linux/interrupt.h>
27#include <linux/irq.h>
28#include <linux/property.h>
29#include <linux/regmap.h>
30#include <linux/slab.h>
31#include <linux/gpio/driver.h>
32
33#include <linux/input/touchscreen.h>
34#include <linux/module.h>
35#include "ad7879.h"
36
37#define AD7879_REG_ZEROS 0
38#define AD7879_REG_CTRL1 1
39#define AD7879_REG_CTRL2 2
40#define AD7879_REG_CTRL3 3
41#define AD7879_REG_AUX1HIGH 4
42#define AD7879_REG_AUX1LOW 5
43#define AD7879_REG_TEMP1HIGH 6
44#define AD7879_REG_TEMP1LOW 7
45#define AD7879_REG_XPLUS 8
46#define AD7879_REG_YPLUS 9
47#define AD7879_REG_Z1 10
48#define AD7879_REG_Z2 11
49#define AD7879_REG_AUXVBAT 12
50#define AD7879_REG_TEMP 13
51#define AD7879_REG_REVID 14
52
53/* Control REG 1 */
54#define AD7879_TMR(x) ((x & 0xFF) << 0)
55#define AD7879_ACQ(x) ((x & 0x3) << 8)
56#define AD7879_MODE_NOC (0 << 10) /* Do not convert */
57#define AD7879_MODE_SCC (1 << 10) /* Single channel conversion */
58#define AD7879_MODE_SEQ0 (2 << 10) /* Sequence 0 in Slave Mode */
59#define AD7879_MODE_SEQ1 (3 << 10) /* Sequence 1 in Master Mode */
60#define AD7879_MODE_INT (1 << 15) /* PENIRQ disabled INT enabled */
61
62/* Control REG 2 */
63#define AD7879_FCD(x) ((x & 0x3) << 0)
64#define AD7879_RESET (1 << 4)
65#define AD7879_MFS(x) ((x & 0x3) << 5)
66#define AD7879_AVG(x) ((x & 0x3) << 7)
67#define AD7879_SER (1 << 9) /* non-differential */
68#define AD7879_DFR (0 << 9) /* differential */
69#define AD7879_GPIOPOL (1 << 10)
70#define AD7879_GPIODIR (1 << 11)
71#define AD7879_GPIO_DATA (1 << 12)
72#define AD7879_GPIO_EN (1 << 13)
73#define AD7879_PM(x) ((x & 0x3) << 14)
74#define AD7879_PM_SHUTDOWN (0)
75#define AD7879_PM_DYN (1)
76#define AD7879_PM_FULLON (2)
77
78/* Control REG 3 */
79#define AD7879_TEMPMASK_BIT (1<<15)
80#define AD7879_AUXVBATMASK_BIT (1<<14)
81#define AD7879_INTMODE_BIT (1<<13)
82#define AD7879_GPIOALERTMASK_BIT (1<<12)
83#define AD7879_AUXLOW_BIT (1<<11)
84#define AD7879_AUXHIGH_BIT (1<<10)
85#define AD7879_TEMPLOW_BIT (1<<9)
86#define AD7879_TEMPHIGH_BIT (1<<8)
87#define AD7879_YPLUS_BIT (1<<7)
88#define AD7879_XPLUS_BIT (1<<6)
89#define AD7879_Z1_BIT (1<<5)
90#define AD7879_Z2_BIT (1<<4)
91#define AD7879_AUX_BIT (1<<3)
92#define AD7879_VBAT_BIT (1<<2)
93#define AD7879_TEMP_BIT (1<<1)
94
95enum {
96 AD7879_SEQ_YPOS = 0,
97 AD7879_SEQ_XPOS = 1,
98 AD7879_SEQ_Z1 = 2,
99 AD7879_SEQ_Z2 = 3,
100 AD7879_NR_SENSE = 4,
101};
102
103#define MAX_12BIT ((1<<12)-1)
104#define TS_PEN_UP_TIMEOUT msecs_to_jiffies(50)
105
106struct ad7879 {
107 struct regmap *regmap;
108 struct device *dev;
109 struct input_dev *input;
110 struct timer_list timer;
111#ifdef CONFIG_GPIOLIB
112 struct gpio_chip gc;
113 struct mutex mutex;
114#endif
115 unsigned int irq;
116 bool disabled; /* P: input->mutex */
117 bool suspended; /* P: input->mutex */
118 bool swap_xy;
119 u16 conversion_data[AD7879_NR_SENSE];
120 char phys[32];
121 u8 first_conversion_delay;
122 u8 acquisition_time;
123 u8 averaging;
124 u8 pen_down_acc_interval;
125 u8 median;
126 u16 x_plate_ohms;
127 u16 cmd_crtl1;
128 u16 cmd_crtl2;
129 u16 cmd_crtl3;
130 int x;
131 int y;
132 int Rt;
133};
134
135static int ad7879_read(struct ad7879 *ts, u8 reg)
136{
137 unsigned int val;
138 int error;
139
140 error = regmap_read(ts->regmap, reg, &val);
141 if (error) {
142 dev_err(ts->dev, "failed to read register %#02x: %d\n",
143 reg, error);
144 return error;
145 }
146
147 return val;
148}
149
150static int ad7879_write(struct ad7879 *ts, u8 reg, u16 val)
151{
152 int error;
153
154 error = regmap_write(ts->regmap, reg, val);
155 if (error) {
156 dev_err(ts->dev,
157 "failed to write %#04x to register %#02x: %d\n",
158 val, reg, error);
159 return error;
160 }
161
162 return 0;
163}
164
165static int ad7879_report(struct ad7879 *ts)
166{
167 struct input_dev *input_dev = ts->input;
168 unsigned Rt;
169 u16 x, y, z1, z2;
170
171 x = ts->conversion_data[AD7879_SEQ_XPOS] & MAX_12BIT;
172 y = ts->conversion_data[AD7879_SEQ_YPOS] & MAX_12BIT;
173 z1 = ts->conversion_data[AD7879_SEQ_Z1] & MAX_12BIT;
174 z2 = ts->conversion_data[AD7879_SEQ_Z2] & MAX_12BIT;
175
176 if (ts->swap_xy)
177 swap(x, y);
178
179 /*
180 * The samples processed here are already preprocessed by the AD7879.
181 * The preprocessing function consists of a median and an averaging
182 * filter. The combination of these two techniques provides a robust
183 * solution, discarding the spurious noise in the signal and keeping
184 * only the data of interest. The size of both filters is
185 * programmable. (dev.platform_data, see linux/platform_data/ad7879.h)
186 * Other user-programmable conversion controls include variable
187 * acquisition time, and first conversion delay. Up to 16 averages can
188 * be taken per conversion.
189 */
190
191 if (likely(x && z1)) {
192 /* compute touch pressure resistance using equation #1 */
193 Rt = (z2 - z1) * x * ts->x_plate_ohms;
194 Rt /= z1;
195 Rt = (Rt + 2047) >> 12;
196
197 /*
198 * Sample found inconsistent, pressure is beyond
199 * the maximum. Don't report it to user space.
200 */
201 if (Rt > input_abs_get_max(input_dev, ABS_PRESSURE))
202 return -EINVAL;
203
204 /*
205 * Note that we delay reporting events by one sample.
206 * This is done to avoid reporting last sample of the
207 * touch sequence, which may be incomplete if finger
208 * leaves the surface before last reading is taken.
209 */
210 if (timer_pending(&ts->timer)) {
211 /* Touch continues */
212 input_report_key(input_dev, BTN_TOUCH, 1);
213 input_report_abs(input_dev, ABS_X, ts->x);
214 input_report_abs(input_dev, ABS_Y, ts->y);
215 input_report_abs(input_dev, ABS_PRESSURE, ts->Rt);
216 input_sync(input_dev);
217 }
218
219 ts->x = x;
220 ts->y = y;
221 ts->Rt = Rt;
222
223 return 0;
224 }
225
226 return -EINVAL;
227}
228
229static void ad7879_ts_event_release(struct ad7879 *ts)
230{
231 struct input_dev *input_dev = ts->input;
232
233 input_report_abs(input_dev, ABS_PRESSURE, 0);
234 input_report_key(input_dev, BTN_TOUCH, 0);
235 input_sync(input_dev);
236}
237
238static void ad7879_timer(struct timer_list *t)
239{
240 struct ad7879 *ts = from_timer(ts, t, timer);
241
242 ad7879_ts_event_release(ts);
243}
244
245static irqreturn_t ad7879_irq(int irq, void *handle)
246{
247 struct ad7879 *ts = handle;
248 int error;
249
250 error = regmap_bulk_read(ts->regmap, AD7879_REG_XPLUS,
251 ts->conversion_data, AD7879_NR_SENSE);
252 if (error)
253 dev_err_ratelimited(ts->dev, "failed to read %#02x: %d\n",
254 AD7879_REG_XPLUS, error);
255 else if (!ad7879_report(ts))
256 mod_timer(&ts->timer, jiffies + TS_PEN_UP_TIMEOUT);
257
258 return IRQ_HANDLED;
259}
260
261static void __ad7879_enable(struct ad7879 *ts)
262{
263 ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
264 ad7879_write(ts, AD7879_REG_CTRL3, ts->cmd_crtl3);
265 ad7879_write(ts, AD7879_REG_CTRL1, ts->cmd_crtl1);
266
267 enable_irq(ts->irq);
268}
269
270static void __ad7879_disable(struct ad7879 *ts)
271{
272 u16 reg = (ts->cmd_crtl2 & ~AD7879_PM(-1)) |
273 AD7879_PM(AD7879_PM_SHUTDOWN);
274 disable_irq(ts->irq);
275
276 if (del_timer_sync(&ts->timer))
277 ad7879_ts_event_release(ts);
278
279 ad7879_write(ts, AD7879_REG_CTRL2, reg);
280}
281
282
283static int ad7879_open(struct input_dev *input)
284{
285 struct ad7879 *ts = input_get_drvdata(input);
286
287 /* protected by input->mutex */
288 if (!ts->disabled && !ts->suspended)
289 __ad7879_enable(ts);
290
291 return 0;
292}
293
294static void ad7879_close(struct input_dev *input)
295{
296 struct ad7879 *ts = input_get_drvdata(input);
297
298 /* protected by input->mutex */
299 if (!ts->disabled && !ts->suspended)
300 __ad7879_disable(ts);
301}
302
303static int __maybe_unused ad7879_suspend(struct device *dev)
304{
305 struct ad7879 *ts = dev_get_drvdata(dev);
306
307 mutex_lock(&ts->input->mutex);
308
309 if (!ts->suspended && !ts->disabled && input_device_enabled(ts->input))
310 __ad7879_disable(ts);
311
312 ts->suspended = true;
313
314 mutex_unlock(&ts->input->mutex);
315
316 return 0;
317}
318
319static int __maybe_unused ad7879_resume(struct device *dev)
320{
321 struct ad7879 *ts = dev_get_drvdata(dev);
322
323 mutex_lock(&ts->input->mutex);
324
325 if (ts->suspended && !ts->disabled && input_device_enabled(ts->input))
326 __ad7879_enable(ts);
327
328 ts->suspended = false;
329
330 mutex_unlock(&ts->input->mutex);
331
332 return 0;
333}
334
335SIMPLE_DEV_PM_OPS(ad7879_pm_ops, ad7879_suspend, ad7879_resume);
336EXPORT_SYMBOL(ad7879_pm_ops);
337
338static void ad7879_toggle(struct ad7879 *ts, bool disable)
339{
340 mutex_lock(&ts->input->mutex);
341
342 if (!ts->suspended && input_device_enabled(ts->input)) {
343
344 if (disable) {
345 if (ts->disabled)
346 __ad7879_enable(ts);
347 } else {
348 if (!ts->disabled)
349 __ad7879_disable(ts);
350 }
351 }
352
353 ts->disabled = disable;
354
355 mutex_unlock(&ts->input->mutex);
356}
357
358static ssize_t ad7879_disable_show(struct device *dev,
359 struct device_attribute *attr, char *buf)
360{
361 struct ad7879 *ts = dev_get_drvdata(dev);
362
363 return sprintf(buf, "%u\n", ts->disabled);
364}
365
366static ssize_t ad7879_disable_store(struct device *dev,
367 struct device_attribute *attr,
368 const char *buf, size_t count)
369{
370 struct ad7879 *ts = dev_get_drvdata(dev);
371 unsigned int val;
372 int error;
373
374 error = kstrtouint(buf, 10, &val);
375 if (error)
376 return error;
377
378 ad7879_toggle(ts, val);
379
380 return count;
381}
382
383static DEVICE_ATTR(disable, 0664, ad7879_disable_show, ad7879_disable_store);
384
385static struct attribute *ad7879_attributes[] = {
386 &dev_attr_disable.attr,
387 NULL
388};
389
390static const struct attribute_group ad7879_attr_group = {
391 .attrs = ad7879_attributes,
392};
393
394const struct attribute_group *ad7879_groups[] = {
395 &ad7879_attr_group,
396 NULL
397};
398EXPORT_SYMBOL_GPL(ad7879_groups);
399
400#ifdef CONFIG_GPIOLIB
401static int ad7879_gpio_direction_input(struct gpio_chip *chip,
402 unsigned gpio)
403{
404 struct ad7879 *ts = gpiochip_get_data(chip);
405 int err;
406
407 mutex_lock(&ts->mutex);
408 ts->cmd_crtl2 |= AD7879_GPIO_EN | AD7879_GPIODIR | AD7879_GPIOPOL;
409 err = ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
410 mutex_unlock(&ts->mutex);
411
412 return err;
413}
414
415static int ad7879_gpio_direction_output(struct gpio_chip *chip,
416 unsigned gpio, int level)
417{
418 struct ad7879 *ts = gpiochip_get_data(chip);
419 int err;
420
421 mutex_lock(&ts->mutex);
422 ts->cmd_crtl2 &= ~AD7879_GPIODIR;
423 ts->cmd_crtl2 |= AD7879_GPIO_EN | AD7879_GPIOPOL;
424 if (level)
425 ts->cmd_crtl2 |= AD7879_GPIO_DATA;
426 else
427 ts->cmd_crtl2 &= ~AD7879_GPIO_DATA;
428
429 err = ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
430 mutex_unlock(&ts->mutex);
431
432 return err;
433}
434
435static int ad7879_gpio_get_value(struct gpio_chip *chip, unsigned gpio)
436{
437 struct ad7879 *ts = gpiochip_get_data(chip);
438 u16 val;
439
440 mutex_lock(&ts->mutex);
441 val = ad7879_read(ts, AD7879_REG_CTRL2);
442 mutex_unlock(&ts->mutex);
443
444 return !!(val & AD7879_GPIO_DATA);
445}
446
447static void ad7879_gpio_set_value(struct gpio_chip *chip,
448 unsigned gpio, int value)
449{
450 struct ad7879 *ts = gpiochip_get_data(chip);
451
452 mutex_lock(&ts->mutex);
453 if (value)
454 ts->cmd_crtl2 |= AD7879_GPIO_DATA;
455 else
456 ts->cmd_crtl2 &= ~AD7879_GPIO_DATA;
457
458 ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
459 mutex_unlock(&ts->mutex);
460}
461
462static int ad7879_gpio_add(struct ad7879 *ts)
463{
464 int ret = 0;
465
466 mutex_init(&ts->mutex);
467
468 /* Do not create a chip unless flagged for it */
469 if (!device_property_read_bool(ts->dev, "gpio-controller"))
470 return 0;
471
472 ts->gc.direction_input = ad7879_gpio_direction_input;
473 ts->gc.direction_output = ad7879_gpio_direction_output;
474 ts->gc.get = ad7879_gpio_get_value;
475 ts->gc.set = ad7879_gpio_set_value;
476 ts->gc.can_sleep = 1;
477 ts->gc.base = -1;
478 ts->gc.ngpio = 1;
479 ts->gc.label = "AD7879-GPIO";
480 ts->gc.owner = THIS_MODULE;
481 ts->gc.parent = ts->dev;
482
483 ret = devm_gpiochip_add_data(ts->dev, &ts->gc, ts);
484 if (ret)
485 dev_err(ts->dev, "failed to register gpio %d\n",
486 ts->gc.base);
487
488 return ret;
489}
490#else
491static int ad7879_gpio_add(struct ad7879 *ts)
492{
493 return 0;
494}
495#endif
496
497static int ad7879_parse_dt(struct device *dev, struct ad7879 *ts)
498{
499 int err;
500 u32 tmp;
501
502 err = device_property_read_u32(dev, "adi,resistance-plate-x", &tmp);
503 if (err) {
504 dev_err(dev, "failed to get resistance-plate-x property\n");
505 return err;
506 }
507 ts->x_plate_ohms = (u16)tmp;
508
509 device_property_read_u8(dev, "adi,first-conversion-delay",
510 &ts->first_conversion_delay);
511 device_property_read_u8(dev, "adi,acquisition-time",
512 &ts->acquisition_time);
513 device_property_read_u8(dev, "adi,median-filter-size", &ts->median);
514 device_property_read_u8(dev, "adi,averaging", &ts->averaging);
515 device_property_read_u8(dev, "adi,conversion-interval",
516 &ts->pen_down_acc_interval);
517
518 ts->swap_xy = device_property_read_bool(dev, "touchscreen-swapped-x-y");
519
520 return 0;
521}
522
523int ad7879_probe(struct device *dev, struct regmap *regmap,
524 int irq, u16 bustype, u8 devid)
525{
526 struct ad7879 *ts;
527 struct input_dev *input_dev;
528 int err;
529 u16 revid;
530
531 if (irq <= 0) {
532 dev_err(dev, "No IRQ specified\n");
533 return -EINVAL;
534 }
535
536 ts = devm_kzalloc(dev, sizeof(*ts), GFP_KERNEL);
537 if (!ts)
538 return -ENOMEM;
539
540 err = ad7879_parse_dt(dev, ts);
541 if (err)
542 return err;
543
544 input_dev = devm_input_allocate_device(dev);
545 if (!input_dev) {
546 dev_err(dev, "Failed to allocate input device\n");
547 return -ENOMEM;
548 }
549
550 ts->dev = dev;
551 ts->input = input_dev;
552 ts->irq = irq;
553 ts->regmap = regmap;
554
555 timer_setup(&ts->timer, ad7879_timer, 0);
556 snprintf(ts->phys, sizeof(ts->phys), "%s/input0", dev_name(dev));
557
558 input_dev->name = "AD7879 Touchscreen";
559 input_dev->phys = ts->phys;
560 input_dev->dev.parent = dev;
561 input_dev->id.bustype = bustype;
562
563 input_dev->open = ad7879_open;
564 input_dev->close = ad7879_close;
565
566 input_set_drvdata(input_dev, ts);
567
568 input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
569
570 input_set_abs_params(input_dev, ABS_X, 0, MAX_12BIT, 0, 0);
571 input_set_abs_params(input_dev, ABS_Y, 0, MAX_12BIT, 0, 0);
572 input_set_capability(input_dev, EV_ABS, ABS_PRESSURE);
573 touchscreen_parse_properties(input_dev, false, NULL);
574 if (!input_abs_get_max(input_dev, ABS_PRESSURE)) {
575 dev_err(dev, "Touchscreen pressure is not specified\n");
576 return -EINVAL;
577 }
578
579 err = ad7879_write(ts, AD7879_REG_CTRL2, AD7879_RESET);
580 if (err < 0) {
581 dev_err(dev, "Failed to write %s\n", input_dev->name);
582 return err;
583 }
584
585 revid = ad7879_read(ts, AD7879_REG_REVID);
586 input_dev->id.product = (revid & 0xff);
587 input_dev->id.version = revid >> 8;
588 if (input_dev->id.product != devid) {
589 dev_err(dev, "Failed to probe %s (%x vs %x)\n",
590 input_dev->name, devid, revid);
591 return -ENODEV;
592 }
593
594 ts->cmd_crtl3 = AD7879_YPLUS_BIT |
595 AD7879_XPLUS_BIT |
596 AD7879_Z2_BIT |
597 AD7879_Z1_BIT |
598 AD7879_TEMPMASK_BIT |
599 AD7879_AUXVBATMASK_BIT |
600 AD7879_GPIOALERTMASK_BIT;
601
602 ts->cmd_crtl2 = AD7879_PM(AD7879_PM_DYN) | AD7879_DFR |
603 AD7879_AVG(ts->averaging) |
604 AD7879_MFS(ts->median) |
605 AD7879_FCD(ts->first_conversion_delay);
606
607 ts->cmd_crtl1 = AD7879_MODE_INT | AD7879_MODE_SEQ1 |
608 AD7879_ACQ(ts->acquisition_time) |
609 AD7879_TMR(ts->pen_down_acc_interval);
610
611 err = devm_request_threaded_irq(dev, ts->irq, NULL, ad7879_irq,
612 IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
613 dev_name(dev), ts);
614 if (err) {
615 dev_err(dev, "Failed to request IRQ: %d\n", err);
616 return err;
617 }
618
619 __ad7879_disable(ts);
620
621 err = ad7879_gpio_add(ts);
622 if (err)
623 return err;
624
625 err = input_register_device(input_dev);
626 if (err)
627 return err;
628
629 dev_set_drvdata(dev, ts);
630
631 return 0;
632}
633EXPORT_SYMBOL(ad7879_probe);
634
635MODULE_AUTHOR("Michael Hennerich <michael.hennerich@analog.com>");
636MODULE_DESCRIPTION("AD7879(-1) touchscreen Driver");
637MODULE_LICENSE("GPL");