2 * ADS7846 based touchscreen and sensor driver
4 * Copyright (c) 2005 David Brownell
5 * Copyright (c) 2006 Imre Deak <imre.deak@nokia.com>
9 * Copyright (C) 2004-2005 Richard Purdie
10 * - omap_ts.[hc], ads7846.h, ts_osk.c
11 * Copyright (C) 2002 MontaVista Software
12 * Copyright (C) 2004 Texas Instruments
13 * Copyright (C) 2005 Dirk Behme
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License version 2 as
17 * published by the Free Software Foundation.
19 #include <linux/device.h>
20 #include <linux/init.h>
21 #include <linux/delay.h>
22 #include <linux/input.h>
23 #include <linux/interrupt.h>
24 #include <linux/slab.h>
25 #include <linux/spi/spi.h>
26 #include <linux/spi/ads7846.h>
29 #include <asm/mach-types.h>
30 #ifdef CONFIG_ARCH_OMAP
31 #include <asm/arch/gpio.h>
37 * This code has been heavily tested on a Nokia 770, and lightly
38 * tested on an other ads7846 device.
39 * Support for ads7843 and ads7845 has only been stubbed in.
41 * Not yet done: How accurate are the temperature and voltage
42 * readings? (System-specific calibration should support
43 * accuracy of 0.3 degrees C; otherwise it's 2.0 degrees.)
45 * IRQ handling needs a workaround because of a shortcoming in handling
46 * edge triggered IRQs on some platforms like the OMAP1/2. These
47 * platforms don't handle the ARM lazy IRQ disabling properly, thus we
48 * have to maintain our own SW IRQ disabled status. This should be
49 * removed as soon as the affected platforms' IRQ handling is fixed.
51 * app note sbaa036 talks in more detail about accurate sampling...
52 * that ought to help in situations like LCDs inducing noise (which
53 * can also be helped by using synch signals) and more generally.
54 * This driver tries to utilize the measures described in the app
55 * note. The strength of filtering can be set in the board-* specific
59 #define TS_POLL_PERIOD msecs_to_jiffies(10)
61 /* this driver doesn't aim at the peak continuous sample rate */
62 #define SAMPLE_BITS (8 /*cmd*/ + 16 /*sample*/ + 2 /* before, after */)
65 /* For portability, we can't read 12 bit values using SPI (which
66 * would make the controller deliver them as native byteorder u16
67 * with msbs zeroed). Instead, we read them as two 8-bit values,
68 * which need byteswapping then range adjustment.
76 struct input_dev *input;
79 struct spi_device *spi;
85 u8 read_x, read_y, read_z1, read_z2, pwrdown;
86 u16 dummy; /* for the pwrdown read */
92 struct spi_transfer xfer[10];
93 struct spi_message msg[5];
102 struct timer_list timer; /* P: lock */
103 unsigned pendown:1; /* P: lock */
104 unsigned pending:1; /* P: lock */
105 // FIXME remove "irq_disabled"
106 unsigned irq_disabled:1; /* P: lock */
110 /* leave chip selected when we're done, for quicker re-select? */
112 #define CS_CHANGE(xfer) ((xfer).cs_change = 1)
114 #define CS_CHANGE(xfer) ((xfer).cs_change = 0)
117 /*--------------------------------------------------------------------------*/
119 /* The ADS7846 has touchscreen and other sensors.
120 * Earlier ads784x chips are somewhat compatible.
122 #define ADS_START (1 << 7)
123 #define ADS_A2A1A0_d_y (1 << 4) /* differential */
124 #define ADS_A2A1A0_d_z1 (3 << 4) /* differential */
125 #define ADS_A2A1A0_d_z2 (4 << 4) /* differential */
126 #define ADS_A2A1A0_d_x (5 << 4) /* differential */
127 #define ADS_A2A1A0_temp0 (0 << 4) /* non-differential */
128 #define ADS_A2A1A0_vbatt (2 << 4) /* non-differential */
129 #define ADS_A2A1A0_vaux (6 << 4) /* non-differential */
130 #define ADS_A2A1A0_temp1 (7 << 4) /* non-differential */
131 #define ADS_8_BIT (1 << 3)
132 #define ADS_12_BIT (0 << 3)
133 #define ADS_SER (1 << 2) /* non-differential */
134 #define ADS_DFR (0 << 2) /* differential */
135 #define ADS_PD10_PDOWN (0 << 0) /* lowpower mode + penirq */
136 #define ADS_PD10_ADC_ON (1 << 0) /* ADC on */
137 #define ADS_PD10_REF_ON (2 << 0) /* vREF on + penirq */
138 #define ADS_PD10_ALL_ON (3 << 0) /* ADC + vREF on */
140 #define MAX_12BIT ((1<<12)-1)
142 /* leave ADC powered up (disables penirq) between differential samples */
143 #define READ_12BIT_DFR(x) (ADS_START | ADS_A2A1A0_d_ ## x \
144 | ADS_12_BIT | ADS_DFR)
146 #define READ_Y (READ_12BIT_DFR(y) | ADS_PD10_ADC_ON)
147 #define READ_Z1 (READ_12BIT_DFR(z1) | ADS_PD10_ADC_ON)
148 #define READ_Z2 (READ_12BIT_DFR(z2) | ADS_PD10_ADC_ON)
150 #define READ_X (READ_12BIT_DFR(x) | ADS_PD10_ADC_ON)
151 #define PWRDOWN (READ_12BIT_DFR(y) | ADS_PD10_PDOWN) /* LAST */
153 /* single-ended samples need to first power up reference voltage;
154 * we leave both ADC and VREF powered
156 #define READ_12BIT_SER(x) (ADS_START | ADS_A2A1A0_ ## x \
157 | ADS_12_BIT | ADS_SER)
159 #define REF_ON (READ_12BIT_DFR(x) | ADS_PD10_ALL_ON)
160 #define REF_OFF (READ_12BIT_DFR(y) | ADS_PD10_PDOWN)
162 /*--------------------------------------------------------------------------*/
165 * Non-touchscreen sensors only use single-ended conversions.
174 struct spi_message msg;
175 struct spi_transfer xfer[6];
178 static void ads7846_enable(struct ads7846 *ts);
179 static void ads7846_disable(struct ads7846 *ts);
181 static int ads7846_read12_ser(struct device *dev, unsigned command)
183 struct spi_device *spi = to_spi_device(dev);
184 struct ads7846 *ts = dev_get_drvdata(dev);
185 struct ser_req *req = kzalloc(sizeof *req, SLAB_KERNEL);
193 spi_message_init(&req->msg);
195 /* activate reference, so it has time to settle; */
196 req->ref_on = REF_ON;
197 req->xfer[0].tx_buf = &req->ref_on;
198 req->xfer[0].len = 1;
199 req->xfer[1].rx_buf = &req->scratch;
200 req->xfer[1].len = 2;
203 * for external VREF, 0 usec (and assume it's always on);
204 * for 1uF, use 800 usec;
207 req->xfer[1].delay_usecs = ts->vref_delay_usecs;
210 req->command = (u8) command;
211 req->xfer[2].tx_buf = &req->command;
212 req->xfer[2].len = 1;
213 req->xfer[3].rx_buf = &req->sample;
214 req->xfer[3].len = 2;
216 /* REVISIT: take a few more samples, and compare ... */
218 /* turn off reference */
219 req->ref_off = REF_OFF;
220 req->xfer[4].tx_buf = &req->ref_off;
221 req->xfer[4].len = 1;
222 req->xfer[5].rx_buf = &req->scratch;
223 req->xfer[5].len = 2;
225 CS_CHANGE(req->xfer[5]);
227 /* group all the transfers together, so we can't interfere with
228 * reading touchscreen state; disable penirq while sampling
230 for (i = 0; i < 6; i++)
231 spi_message_add_tail(&req->xfer[i], &req->msg);
233 disable_irq(spi->irq);
234 status = spi_sync(spi, &req->msg);
235 enable_irq(spi->irq);
238 status = req->msg.status;
239 sample = be16_to_cpu(req->sample);
240 sample = sample >> 4;
243 return status ? status : sample;
246 #define SHOW(name) static ssize_t \
247 name ## _show(struct device *dev, struct device_attribute *attr, char *buf) \
249 ssize_t v = ads7846_read12_ser(dev, \
250 READ_12BIT_SER(name) | ADS_PD10_ALL_ON); \
253 return sprintf(buf, "%u\n", (unsigned) v); \
255 static DEVICE_ATTR(name, S_IRUGO, name ## _show, NULL);
262 static int is_pen_down(struct device *dev)
264 struct ads7846 *ts = dev_get_drvdata(dev);
269 static ssize_t ads7846_pen_down_show(struct device *dev,
270 struct device_attribute *attr, char *buf)
272 return sprintf(buf, "%u\n", is_pen_down(dev));
275 static DEVICE_ATTR(pen_down, S_IRUGO, ads7846_pen_down_show, NULL);
277 static ssize_t ads7846_disable_show(struct device *dev,
278 struct device_attribute *attr, char *buf)
280 struct ads7846 *ts = dev_get_drvdata(dev);
282 return sprintf(buf, "%u\n", ts->disabled);
285 static ssize_t ads7846_disable_store(struct device *dev,
286 struct device_attribute *attr,
287 const char *buf, size_t count)
289 struct ads7846 *ts = dev_get_drvdata(dev);
294 i = simple_strtoul(buf, &endp, 10);
295 spin_lock_irqsave(&ts->lock, flags);
302 spin_unlock_irqrestore(&ts->lock, flags);
307 static DEVICE_ATTR(disable, 0664, ads7846_disable_show, ads7846_disable_store);
309 /*--------------------------------------------------------------------------*/
312 * PENIRQ only kicks the timer. The timer only reissues the SPI transfer,
313 * to retrieve touchscreen status.
315 * The SPI transfer completion callback does the real work. It reports
316 * touchscreen events and reactivates the timer (or IRQ) as appropriate.
319 static void ads7846_rx(void *ads)
321 struct ads7846 *ts = ads;
322 struct input_dev *input_dev = ts->input;
328 /* adjust: 12 bit samples (left aligned), built from
329 * two 8 bit values writen msb-first.
336 /* range filtering */
340 if (x && z1 && ts->spi->dev.power.power_state.event == PM_EVENT_ON) {
341 /* compute touch pressure resistance using equation #2 */
345 Rt *= ts->x_plate_ohms;
347 Rt = (Rt + 2047) >> 12;
351 if (Rt > ts->pressure_max) {
352 if (ts->last_pressure) {
356 Rt = ts->pressure_max;
361 ts->last_pressure = Rt;
363 /* NOTE: "pendown" is inferred from pressure; we don't rely on
364 * being able to check nPENIRQ status, or "friendly" trigger modes
365 * (both-edges is much better than just-falling or low-level).
367 * REVISIT: some boards may require reading nPENIRQ; it's
368 * needed on 7843. and 7845 reads pressure differently...
370 * REVISIT: the touchscreen might not be connected; this code
371 * won't notice that, even if nPENIRQ never fires ...
373 if (!ts->pendown && Rt != 0) {
374 input_report_key(input_dev, BTN_TOUCH, 1);
376 } else if (ts->pendown && Rt == 0) {
377 input_report_key(input_dev, BTN_TOUCH, 0);
382 input_report_abs(input_dev, ABS_X, x);
383 input_report_abs(input_dev, ABS_Y, y);
384 input_report_abs(input_dev, ABS_PRESSURE, Rt);
388 input_sync(input_dev);
391 if (Rt || ts->pendown)
392 pr_debug("%s: %d/%d/%d%s\n", ts->spi->dev.bus_id,
393 x, y, Rt, Rt ? "" : " UP");
396 /* don't retrigger while we're suspended */
397 spin_lock_irqsave(&ts->lock, flags);
399 ts->pendown = (Rt != 0);
402 if (ts->spi->dev.power.power_state.event == PM_EVENT_ON) {
404 mod_timer(&ts->timer, jiffies + TS_POLL_PERIOD);
405 else if (ts->irq_disabled) {
406 ts->irq_disabled = 0;
407 enable_irq(ts->spi->irq);
411 spin_unlock_irqrestore(&ts->lock, flags);
414 static void ads7846_debounce(void *ads)
416 struct ads7846 *ts = ads;
417 struct spi_message *m;
418 struct spi_transfer *t;
422 m = &ts->msg[ts->msg_idx];
423 t = list_entry(m->transfers.prev, struct spi_transfer, transfer_list);
424 val = (*(u16 *)t->rx_buf) >> 3;
426 if (!ts->read_cnt || (abs(ts->last_read - val) > ts->debounce_tol &&
427 ts->read_cnt < ts->debounce_max)) {
428 /* Repeat it, if this was the first read or the read wasn't
429 * consistent enough */
433 /* Go for the next read */
438 status = spi_async(ts->spi, m);
440 dev_err(&ts->spi->dev, "spi_async --> %d\n",
444 static void ads7846_timer(unsigned long handle)
446 struct ads7846 *ts = (void *)handle;
450 status = spi_async(ts->spi, &ts->msg[0]);
452 dev_err(&ts->spi->dev, "spi_async --> %d\n", status);
455 static irqreturn_t ads7846_irq(int irq, void *handle, struct pt_regs *regs)
457 struct ads7846 *ts = handle;
460 spin_lock_irqsave(&ts->lock, flags);
461 if (likely(!ts->irq_disabled && !ts->disabled)) {
462 if (!ts->irq_disabled) {
463 ts->irq_disabled = 1;
464 /* The following has at the moment no effect whatsoever
465 * on OMAP, that's why we maintain the disabled
467 disable_irq(ts->spi->irq);
471 mod_timer(&ts->timer, jiffies);
474 spin_unlock_irqrestore(&ts->lock, flags);
479 /*--------------------------------------------------------------------------*/
481 /* Must be called with ts->lock held */
482 static void ads7846_disable(struct ads7846 *ts)
487 /* are we waiting for IRQ, or polling? */
489 if (!ts->irq_disabled) {
490 ts->irq_disabled = 1;
491 disable_irq(ts->spi->irq);
496 /* polling; force a final SPI completion;
497 * that will clean things up neatly
500 mod_timer(&ts->timer, jiffies);
502 while (ts->pendown || ts->pending) {
503 spin_unlock_irqrestore(&ts->lock, flags);
505 spin_lock_irqsave(&ts->lock, flags);
509 /* we know the chip's in lowpower mode since we always
510 * leave it that way after every request
516 /* Must be called with ts->lock held */
517 static void ads7846_enable(struct ads7846 *ts)
523 ts->irq_disabled = 0;
524 enable_irq(ts->spi->irq);
527 static int ads7846_suspend(struct spi_device *spi, pm_message_t message)
529 struct ads7846 *ts = dev_get_drvdata(&spi->dev);
532 spin_lock_irqsave(&ts->lock, flags);
534 spi->dev.power.power_state = message;
537 spin_unlock_irqrestore(&ts->lock, flags);
543 static int ads7846_resume(struct spi_device *spi)
545 struct ads7846 *ts = dev_get_drvdata(&spi->dev);
548 spin_lock_irqsave(&ts->lock, flags);
550 spi->dev.power.power_state = PMSG_ON;
553 spin_unlock_irqrestore(&ts->lock, flags);
558 static int __devinit ads7846_probe(struct spi_device *spi)
561 struct input_dev *input_dev;
562 struct ads7846_platform_data *pdata = spi->dev.platform_data;
563 struct spi_message *m;
564 struct spi_transfer *x;
568 dev_dbg(&spi->dev, "no IRQ?\n");
573 dev_dbg(&spi->dev, "no platform data?\n");
577 /* don't exceed max specified sample rate */
578 if (spi->max_speed_hz > (125000 * SAMPLE_BITS)) {
579 dev_dbg(&spi->dev, "f(sample) %d KHz?\n",
580 (spi->max_speed_hz/SAMPLE_BITS)/1000);
584 /* We'd set the wordsize to 12 bits ... except that some controllers
585 * will then treat the 8 bit command words as 12 bits (and drop the
586 * four MSBs of the 12 bit result). Result: inputs must be shifted
587 * to discard the four garbage LSBs.
590 ts = kzalloc(sizeof(struct ads7846), GFP_KERNEL);
591 input_dev = input_allocate_device();
592 if (!ts || !input_dev) {
597 dev_set_drvdata(&spi->dev, ts);
598 spi->dev.power.power_state = PMSG_ON;
601 ts->input = input_dev;
603 init_timer(&ts->timer);
604 ts->timer.data = (unsigned long) ts;
605 ts->timer.function = ads7846_timer;
607 spin_lock_init(&ts->lock);
609 ts->model = pdata->model ? : 7846;
610 ts->vref_delay_usecs = pdata->vref_delay_usecs ? : 100;
611 ts->x_plate_ohms = pdata->x_plate_ohms ? : 400;
612 ts->pressure_max = pdata->pressure_max ? : ~0;
613 ts->debounce_max = pdata->debounce_max ? : 1;
614 ts->debounce_tol = pdata->debounce_tol ? : 10;
616 snprintf(ts->phys, sizeof(ts->phys), "%s/input0", spi->dev.bus_id);
618 input_dev->name = "ADS784x Touchscreen";
619 input_dev->phys = ts->phys;
620 input_dev->cdev.dev = &spi->dev;
622 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
623 input_dev->keybit[LONG(BTN_TOUCH)] = BIT(BTN_TOUCH);
624 input_set_abs_params(input_dev, ABS_X,
626 pdata->x_max ? : MAX_12BIT,
628 input_set_abs_params(input_dev, ABS_Y,
630 pdata->y_max ? : MAX_12BIT,
632 input_set_abs_params(input_dev, ABS_PRESSURE,
633 pdata->pressure_min, pdata->pressure_max, 0, 0);
635 /* set up the transfers to read touchscreen state; this assumes we
636 * use formula #2 for pressure, not #3.
643 /* y- still on; turn on only y+ (and ADC) */
645 x->tx_buf = &ts->read_y;
647 spi_message_add_tail(x, m);
650 x->rx_buf = &ts->tc.y;
652 spi_message_add_tail(x, m);
654 m->complete = ads7846_debounce;
660 /* turn y- off, x+ on, then leave in lowpower */
663 x->tx_buf = &ts->read_x;
665 spi_message_add_tail(x, m);
668 x->rx_buf = &ts->tc.x;
670 spi_message_add_tail(x, m);
672 m->complete = ads7846_debounce;
675 /* turn y+ off, x- on; we'll use formula #2 */
676 if (ts->model == 7846) {
681 ts->read_z1 = READ_Z1;
682 x->tx_buf = &ts->read_z1;
684 spi_message_add_tail(x, m);
687 x->rx_buf = &ts->tc.z1;
689 spi_message_add_tail(x, m);
691 m->complete = ads7846_debounce;
698 ts->read_z2 = READ_Z2;
699 x->tx_buf = &ts->read_z2;
701 spi_message_add_tail(x, m);
704 x->rx_buf = &ts->tc.z2;
706 spi_message_add_tail(x, m);
708 m->complete = ads7846_debounce;
717 ts->pwrdown = PWRDOWN;
718 x->tx_buf = &ts->pwrdown;
720 spi_message_add_tail(x, m);
723 x->rx_buf = &ts->dummy;
726 spi_message_add_tail(x, m);
728 m->complete = ads7846_rx;
731 if (request_irq(spi->irq, ads7846_irq,
732 SA_SAMPLE_RANDOM | SA_TRIGGER_FALLING,
733 spi->dev.bus_id, ts)) {
734 dev_dbg(&spi->dev, "irq %d busy?\n", spi->irq);
739 dev_info(&spi->dev, "touchscreen, irq %d\n", spi->irq);
741 /* take a first sample, leaving nPENIRQ active; avoid
742 * the touchscreen, in case it's not connected.
744 (void) ads7846_read12_ser(&spi->dev,
745 READ_12BIT_SER(vaux) | ADS_PD10_ALL_ON);
747 /* ads7843/7845 don't have temperature sensors, and
748 * use the other sensors a bit differently too
750 if (ts->model == 7846) {
751 device_create_file(&spi->dev, &dev_attr_temp0);
752 device_create_file(&spi->dev, &dev_attr_temp1);
754 if (ts->model != 7845)
755 device_create_file(&spi->dev, &dev_attr_vbatt);
756 device_create_file(&spi->dev, &dev_attr_vaux);
758 device_create_file(&spi->dev, &dev_attr_pen_down);
760 device_create_file(&spi->dev, &dev_attr_disable);
762 err = input_register_device(input_dev);
764 goto err_remove_attr;
769 device_remove_file(&spi->dev, &dev_attr_disable);
770 device_remove_file(&spi->dev, &dev_attr_pen_down);
771 if (ts->model == 7846) {
772 device_remove_file(&spi->dev, &dev_attr_temp1);
773 device_remove_file(&spi->dev, &dev_attr_temp0);
775 if (ts->model != 7845)
776 device_remove_file(&spi->dev, &dev_attr_vbatt);
777 device_remove_file(&spi->dev, &dev_attr_vaux);
779 free_irq(spi->irq, ts);
781 input_free_device(input_dev);
786 static int __devexit ads7846_remove(struct spi_device *spi)
788 struct ads7846 *ts = dev_get_drvdata(&spi->dev);
790 input_unregister_device(ts->input);
792 ads7846_suspend(spi, PMSG_SUSPEND);
794 device_remove_file(&spi->dev, &dev_attr_disable);
795 device_remove_file(&spi->dev, &dev_attr_pen_down);
796 if (ts->model == 7846) {
797 device_remove_file(&spi->dev, &dev_attr_temp1);
798 device_remove_file(&spi->dev, &dev_attr_temp0);
800 if (ts->model != 7845)
801 device_remove_file(&spi->dev, &dev_attr_vbatt);
802 device_remove_file(&spi->dev, &dev_attr_vaux);
804 free_irq(ts->spi->irq, ts);
805 if (ts->irq_disabled)
806 enable_irq(ts->spi->irq);
810 dev_dbg(&spi->dev, "unregistered touchscreen\n");
814 static struct spi_driver ads7846_driver = {
817 .bus = &spi_bus_type,
818 .owner = THIS_MODULE,
820 .probe = ads7846_probe,
821 .remove = __devexit_p(ads7846_remove),
822 .suspend = ads7846_suspend,
823 .resume = ads7846_resume,
826 static int __init ads7846_init(void)
828 /* grr, board-specific init should stay out of drivers!! */
830 #ifdef CONFIG_ARCH_OMAP
831 if (machine_is_omap_osk()) {
832 /* GPIO4 = PENIRQ; GPIO6 = BUSY */
833 omap_request_gpio(4);
834 omap_set_gpio_direction(4, 1);
835 omap_request_gpio(6);
836 omap_set_gpio_direction(6, 1);
838 // also TI 1510 Innovator, bitbanging through FPGA
840 // also Palm Tungsten T2
844 // also Dell Axim X50
845 // also HP iPaq H191x/H192x/H415x/H435x
846 // also Intel Lubbock (additional to UCB1400; as temperature sensor)
847 // also Sharp Zaurus C7xx, C8xx (corgi/sheperd/husky)
849 // Atmel at91sam9261-EK uses ads7843
851 // also various AMD Au1x00 devel boards
853 return spi_register_driver(&ads7846_driver);
855 module_init(ads7846_init);
857 static void __exit ads7846_exit(void)
859 spi_unregister_driver(&ads7846_driver);
861 #ifdef CONFIG_ARCH_OMAP
862 if (machine_is_omap_osk()) {
869 module_exit(ads7846_exit);
871 MODULE_DESCRIPTION("ADS7846 TouchScreen Driver");
872 MODULE_LICENSE("GPL");