2 * AD7879/AD7889 based touchscreen and GPIO driver
4 * Copyright (C) 2008-2010 Michael Hennerich, Analog Devices Inc.
6 * Licensed under the GPL-2 or later.
9 * Copyright (c) 2005 David Brownell
10 * Copyright (c) 2006 Nokia Corporation
11 * Various changes: Imre Deak <imre.deak@nokia.com>
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
21 * Copyright (C) 2006-2008 Analog Devices Inc.
24 #include <linux/device.h>
25 #include <linux/init.h>
26 #include <linux/delay.h>
27 #include <linux/input.h>
28 #include <linux/interrupt.h>
29 #include <linux/irq.h>
30 #include <linux/slab.h>
31 #include <linux/spi/spi.h>
32 #include <linux/i2c.h>
33 #include <linux/gpio.h>
35 #include <linux/spi/ad7879.h>
38 #define AD7879_REG_ZEROS 0
39 #define AD7879_REG_CTRL1 1
40 #define AD7879_REG_CTRL2 2
41 #define AD7879_REG_CTRL3 3
42 #define AD7879_REG_AUX1HIGH 4
43 #define AD7879_REG_AUX1LOW 5
44 #define AD7879_REG_TEMP1HIGH 6
45 #define AD7879_REG_TEMP1LOW 7
46 #define AD7879_REG_XPLUS 8
47 #define AD7879_REG_YPLUS 9
48 #define AD7879_REG_Z1 10
49 #define AD7879_REG_Z2 11
50 #define AD7879_REG_AUXVBAT 12
51 #define AD7879_REG_TEMP 13
52 #define AD7879_REG_REVID 14
55 #define AD7879_TMR(x) ((x & 0xFF) << 0)
56 #define AD7879_ACQ(x) ((x & 0x3) << 8)
57 #define AD7879_MODE_NOC (0 << 10) /* Do not convert */
58 #define AD7879_MODE_SCC (1 << 10) /* Single channel conversion */
59 #define AD7879_MODE_SEQ0 (2 << 10) /* Sequence 0 in Slave Mode */
60 #define AD7879_MODE_SEQ1 (3 << 10) /* Sequence 1 in Master Mode */
61 #define AD7879_MODE_INT (1 << 15) /* PENIRQ disabled INT enabled */
64 #define AD7879_FCD(x) ((x & 0x3) << 0)
65 #define AD7879_RESET (1 << 4)
66 #define AD7879_MFS(x) ((x & 0x3) << 5)
67 #define AD7879_AVG(x) ((x & 0x3) << 7)
68 #define AD7879_SER (1 << 9) /* non-differential */
69 #define AD7879_DFR (0 << 9) /* differential */
70 #define AD7879_GPIOPOL (1 << 10)
71 #define AD7879_GPIODIR (1 << 11)
72 #define AD7879_GPIO_DATA (1 << 12)
73 #define AD7879_GPIO_EN (1 << 13)
74 #define AD7879_PM(x) ((x & 0x3) << 14)
75 #define AD7879_PM_SHUTDOWN (0)
76 #define AD7879_PM_DYN (1)
77 #define AD7879_PM_FULLON (2)
80 #define AD7879_TEMPMASK_BIT (1<<15)
81 #define AD7879_AUXVBATMASK_BIT (1<<14)
82 #define AD7879_INTMODE_BIT (1<<13)
83 #define AD7879_GPIOALERTMASK_BIT (1<<12)
84 #define AD7879_AUXLOW_BIT (1<<11)
85 #define AD7879_AUXHIGH_BIT (1<<10)
86 #define AD7879_TEMPLOW_BIT (1<<9)
87 #define AD7879_TEMPHIGH_BIT (1<<8)
88 #define AD7879_YPLUS_BIT (1<<7)
89 #define AD7879_XPLUS_BIT (1<<6)
90 #define AD7879_Z1_BIT (1<<5)
91 #define AD7879_Z2_BIT (1<<4)
92 #define AD7879_AUX_BIT (1<<3)
93 #define AD7879_VBAT_BIT (1<<2)
94 #define AD7879_TEMP_BIT (1<<1)
104 #define MAX_12BIT ((1<<12)-1)
105 #define TS_PEN_UP_TIMEOUT msecs_to_jiffies(50)
108 const struct ad7879_bus_ops *bops;
111 struct input_dev *input;
112 struct timer_list timer;
113 #ifdef CONFIG_GPIOLIB
118 bool disabled; /* P: mutex */
119 u16 conversion_data[AD7879_NR_SENSE];
121 u8 first_conversion_delay;
124 u8 pen_down_acc_interval;
133 static int ad7879_read(struct ad7879 *ts, u8 reg)
135 return ts->bops->read(ts->dev, reg);
138 static int ad7879_multi_read(struct ad7879 *ts, u8 first_reg, u8 count, u16 *buf)
140 return ts->bops->multi_read(ts->dev, first_reg, count, buf);
143 static int ad7879_write(struct ad7879 *ts, u8 reg, u16 val)
145 return ts->bops->write(ts->dev, reg, val);
148 static void ad7879_report(struct ad7879 *ts)
150 struct input_dev *input_dev = ts->input;
154 x = ts->conversion_data[AD7879_SEQ_XPOS] & MAX_12BIT;
155 y = ts->conversion_data[AD7879_SEQ_YPOS] & MAX_12BIT;
156 z1 = ts->conversion_data[AD7879_SEQ_Z1] & MAX_12BIT;
157 z2 = ts->conversion_data[AD7879_SEQ_Z2] & MAX_12BIT;
160 * The samples processed here are already preprocessed by the AD7879.
161 * The preprocessing function consists of a median and an averaging
162 * filter. The combination of these two techniques provides a robust
163 * solution, discarding the spurious noise in the signal and keeping
164 * only the data of interest. The size of both filters is
165 * programmable. (dev.platform_data, see linux/spi/ad7879.h) Other
166 * user-programmable conversion controls include variable acquisition
167 * time, and first conversion delay. Up to 16 averages can be taken
171 if (likely(x && z1)) {
172 /* compute touch pressure resistance using equation #1 */
173 Rt = (z2 - z1) * x * ts->x_plate_ohms;
175 Rt = (Rt + 2047) >> 12;
177 input_report_abs(input_dev, ABS_X, x);
178 input_report_abs(input_dev, ABS_Y, y);
179 input_report_abs(input_dev, ABS_PRESSURE, Rt);
180 input_sync(input_dev);
184 static void ad7879_ts_event_release(struct ad7879 *ts)
186 struct input_dev *input_dev = ts->input;
188 input_report_abs(input_dev, ABS_PRESSURE, 0);
189 input_sync(input_dev);
192 static void ad7879_timer(unsigned long handle)
194 struct ad7879 *ts = (void *)handle;
196 ad7879_ts_event_release(ts);
199 static irqreturn_t ad7879_irq(int irq, void *handle)
201 struct ad7879 *ts = handle;
203 ad7879_multi_read(ts, AD7879_REG_XPLUS, AD7879_NR_SENSE, ts->conversion_data);
206 mod_timer(&ts->timer, jiffies + TS_PEN_UP_TIMEOUT);
211 static void ad7879_setup(struct ad7879 *ts)
213 ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
214 ad7879_write(ts, AD7879_REG_CTRL3, ts->cmd_crtl3);
215 ad7879_write(ts, AD7879_REG_CTRL1, ts->cmd_crtl1);
218 void ad7879_disable(struct ad7879 *ts)
220 mutex_lock(&ts->mutex);
225 disable_irq(ts->irq);
227 if (del_timer_sync(&ts->timer))
228 ad7879_ts_event_release(ts);
230 ad7879_write(ts, AD7879_REG_CTRL2,
231 AD7879_PM(AD7879_PM_SHUTDOWN));
234 mutex_unlock(&ts->mutex);
236 EXPORT_SYMBOL(ad7879_disable);
238 void ad7879_enable(struct ad7879 *ts)
240 mutex_lock(&ts->mutex);
244 ts->disabled = false;
248 mutex_unlock(&ts->mutex);
250 EXPORT_SYMBOL(ad7879_enable);
252 static ssize_t ad7879_disable_show(struct device *dev,
253 struct device_attribute *attr, char *buf)
255 struct ad7879 *ts = dev_get_drvdata(dev);
257 return sprintf(buf, "%u\n", ts->disabled);
260 static ssize_t ad7879_disable_store(struct device *dev,
261 struct device_attribute *attr,
262 const char *buf, size_t count)
264 struct ad7879 *ts = dev_get_drvdata(dev);
268 error = strict_strtoul(buf, 10, &val);
280 static DEVICE_ATTR(disable, 0664, ad7879_disable_show, ad7879_disable_store);
282 static struct attribute *ad7879_attributes[] = {
283 &dev_attr_disable.attr,
287 static const struct attribute_group ad7879_attr_group = {
288 .attrs = ad7879_attributes,
291 #ifdef CONFIG_GPIOLIB
292 static int ad7879_gpio_direction_input(struct gpio_chip *chip,
295 struct ad7879 *ts = container_of(chip, struct ad7879, gc);
298 mutex_lock(&ts->mutex);
299 ts->cmd_crtl2 |= AD7879_GPIO_EN | AD7879_GPIODIR | AD7879_GPIOPOL;
300 err = ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
301 mutex_unlock(&ts->mutex);
306 static int ad7879_gpio_direction_output(struct gpio_chip *chip,
307 unsigned gpio, int level)
309 struct ad7879 *ts = container_of(chip, struct ad7879, gc);
312 mutex_lock(&ts->mutex);
313 ts->cmd_crtl2 &= ~AD7879_GPIODIR;
314 ts->cmd_crtl2 |= AD7879_GPIO_EN | AD7879_GPIOPOL;
316 ts->cmd_crtl2 |= AD7879_GPIO_DATA;
318 ts->cmd_crtl2 &= ~AD7879_GPIO_DATA;
320 err = ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
321 mutex_unlock(&ts->mutex);
326 static int ad7879_gpio_get_value(struct gpio_chip *chip, unsigned gpio)
328 struct ad7879 *ts = container_of(chip, struct ad7879, gc);
331 mutex_lock(&ts->mutex);
332 val = ad7879_read(ts, AD7879_REG_CTRL2);
333 mutex_unlock(&ts->mutex);
335 return !!(val & AD7879_GPIO_DATA);
338 static void ad7879_gpio_set_value(struct gpio_chip *chip,
339 unsigned gpio, int value)
341 struct ad7879 *ts = container_of(chip, struct ad7879, gc);
343 mutex_lock(&ts->mutex);
345 ts->cmd_crtl2 |= AD7879_GPIO_DATA;
347 ts->cmd_crtl2 &= ~AD7879_GPIO_DATA;
349 ad7879_write(ts, AD7879_REG_CTRL2, ts->cmd_crtl2);
350 mutex_unlock(&ts->mutex);
353 static int ad7879_gpio_add(struct ad7879 *ts,
354 const struct ad7879_platform_data *pdata)
358 if (pdata->gpio_export) {
359 ts->gc.direction_input = ad7879_gpio_direction_input;
360 ts->gc.direction_output = ad7879_gpio_direction_output;
361 ts->gc.get = ad7879_gpio_get_value;
362 ts->gc.set = ad7879_gpio_set_value;
363 ts->gc.can_sleep = 1;
364 ts->gc.base = pdata->gpio_base;
366 ts->gc.label = "AD7879-GPIO";
367 ts->gc.owner = THIS_MODULE;
368 ts->gc.dev = ts->dev;
370 ret = gpiochip_add(&ts->gc);
372 dev_err(ts->dev, "failed to register gpio %d\n",
379 static void ad7879_gpio_remove(struct ad7879 *ts)
381 const struct ad7879_platform_data *pdata = ts->dev->platform_data;
384 if (pdata->gpio_export) {
385 ret = gpiochip_remove(&ts->gc);
387 dev_err(ts->dev, "failed to remove gpio %d\n",
392 static inline int ad7879_gpio_add(struct ad7879 *ts,
393 const struct ad7879_platform_data *pdata)
398 static inline void ad7879_gpio_remove(struct ad7879 *ts)
403 struct ad7879 *ad7879_probe(struct device *dev, u8 devid, unsigned int irq,
404 const struct ad7879_bus_ops *bops)
406 struct ad7879_platform_data *pdata = dev->platform_data;
408 struct input_dev *input_dev;
413 dev_err(dev, "no IRQ?\n");
419 dev_err(dev, "no platform data?\n");
424 ts = kzalloc(sizeof(*ts), GFP_KERNEL);
425 input_dev = input_allocate_device();
426 if (!ts || !input_dev) {
433 ts->input = input_dev;
435 setup_timer(&ts->timer, ad7879_timer, (unsigned long) ts);
436 mutex_init(&ts->mutex);
440 ts->x_plate_ohms = pdata->x_plate_ohms ? : 400;
441 ts->pressure_max = pdata->pressure_max ? : ~0;
443 ts->first_conversion_delay = pdata->first_conversion_delay;
444 ts->acquisition_time = pdata->acquisition_time;
445 ts->averaging = pdata->averaging;
446 ts->pen_down_acc_interval = pdata->pen_down_acc_interval;
447 ts->median = pdata->median;
449 snprintf(ts->phys, sizeof(ts->phys), "%s/input0", dev_name(dev));
451 input_dev->name = "AD7879 Touchscreen";
452 input_dev->phys = ts->phys;
453 input_dev->dev.parent = dev;
454 input_dev->id.bustype = bops->bustype;
456 __set_bit(EV_ABS, input_dev->evbit);
457 __set_bit(ABS_X, input_dev->absbit);
458 __set_bit(ABS_Y, input_dev->absbit);
459 __set_bit(ABS_PRESSURE, input_dev->absbit);
461 input_set_abs_params(input_dev, ABS_X,
463 pdata->x_max ? : MAX_12BIT,
465 input_set_abs_params(input_dev, ABS_Y,
467 pdata->y_max ? : MAX_12BIT,
469 input_set_abs_params(input_dev, ABS_PRESSURE,
470 pdata->pressure_min, pdata->pressure_max, 0, 0);
472 err = ad7879_write(ts, AD7879_REG_CTRL2, AD7879_RESET);
474 dev_err(dev, "Failed to write %s\n", input_dev->name);
478 revid = ad7879_read(ts, AD7879_REG_REVID);
479 input_dev->id.product = (revid & 0xff);
480 input_dev->id.version = revid >> 8;
481 if (input_dev->id.product != devid) {
482 dev_err(dev, "Failed to probe %s (%x vs %x)\n",
483 input_dev->name, devid, revid);
488 ts->cmd_crtl3 = AD7879_YPLUS_BIT |
492 AD7879_TEMPMASK_BIT |
493 AD7879_AUXVBATMASK_BIT |
494 AD7879_GPIOALERTMASK_BIT;
496 ts->cmd_crtl2 = AD7879_PM(AD7879_PM_DYN) | AD7879_DFR |
497 AD7879_AVG(ts->averaging) |
498 AD7879_MFS(ts->median) |
499 AD7879_FCD(ts->first_conversion_delay);
501 ts->cmd_crtl1 = AD7879_MODE_INT | AD7879_MODE_SEQ1 |
502 AD7879_ACQ(ts->acquisition_time) |
503 AD7879_TMR(ts->pen_down_acc_interval);
507 err = request_threaded_irq(ts->irq, NULL, ad7879_irq,
508 IRQF_TRIGGER_FALLING,
511 dev_err(dev, "irq %d busy?\n", ts->irq);
515 err = sysfs_create_group(&dev->kobj, &ad7879_attr_group);
519 err = ad7879_gpio_add(ts, pdata);
521 goto err_remove_attr;
523 err = input_register_device(input_dev);
525 goto err_remove_gpio;
530 ad7879_gpio_remove(ts);
532 sysfs_remove_group(&dev->kobj, &ad7879_attr_group);
534 free_irq(ts->irq, ts);
536 input_free_device(input_dev);
541 EXPORT_SYMBOL(ad7879_probe);
543 void ad7879_remove(struct ad7879 *ts)
545 ad7879_gpio_remove(ts);
547 sysfs_remove_group(&ts->dev->kobj, &ad7879_attr_group);
548 free_irq(ts->irq, ts);
549 input_unregister_device(ts->input);
552 EXPORT_SYMBOL(ad7879_remove);
554 MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
555 MODULE_DESCRIPTION("AD7879(-1) touchscreen Driver");
556 MODULE_LICENSE("GPL");