2 * ADS7846 based touchscreen and sensor driver
4 * Copyright (c) 2005 David Brownell
5 * Copyright (c) 2006 Nokia Corporation
6 * Various changes: Imre Deak <imre.deak@nokia.com>
10 * Copyright (C) 2004-2005 Richard Purdie
11 * - omap_ts.[hc], ads7846.h, ts_osk.c
12 * Copyright (C) 2002 MontaVista Software
13 * Copyright (C) 2004 Texas Instruments
14 * Copyright (C) 2005 Dirk Behme
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License version 2 as
18 * published by the Free Software Foundation.
20 #include <linux/types.h>
21 #include <linux/hwmon.h>
22 #include <linux/init.h>
23 #include <linux/err.h>
24 #include <linux/sched.h>
25 #include <linux/delay.h>
26 #include <linux/input.h>
27 #include <linux/interrupt.h>
28 #include <linux/slab.h>
30 #include <linux/gpio.h>
31 #include <linux/spi/spi.h>
32 #include <linux/spi/ads7846.h>
33 #include <linux/regulator/consumer.h>
37 * This code has been heavily tested on a Nokia 770, and lightly
38 * tested on other ads7846 devices (OSK/Mistral, Lubbock, Spitz).
39 * TSC2046 is just newer ads7846 silicon.
40 * Support for ads7843 tested on Atmel at91sam926x-EK.
41 * Support for ads7845 has only been stubbed in.
42 * Support for Analog Devices AD7873 and AD7843 tested.
44 * IRQ handling needs a workaround because of a shortcoming in handling
45 * edge triggered IRQs on some platforms like the OMAP1/2. These
46 * platforms don't handle the ARM lazy IRQ disabling properly, thus we
47 * have to maintain our own SW IRQ disabled status. This should be
48 * removed as soon as the affected platform's IRQ handling is fixed.
50 * App note sbaa036 talks in more detail about accurate sampling...
51 * that ought to help in situations like LCDs inducing noise (which
52 * can also be helped by using synch signals) and more generally.
53 * This driver tries to utilize the measures described in the app
54 * note. The strength of filtering can be set in the board-* specific
58 #define TS_POLL_DELAY 1 /* ms delay before the first sample */
59 #define TS_POLL_PERIOD 5 /* ms delay between samples */
61 /* this driver doesn't aim at the peak continuous sample rate */
62 #define SAMPLE_BITS (8 /*cmd*/ + 16 /*sample*/ + 2 /* before, after */)
66 * For portability, we can't read 12 bit values using SPI (which
67 * would make the controller deliver them as native byte order u16
68 * with msbs zeroed). Instead, we read them as two 8-bit values,
69 * *** WHICH NEED BYTESWAPPING *** and range adjustment.
80 * We allocate this separately to avoid cache line sharing issues when
81 * driver is used with DMA-based SPI controllers (like atmel_spi) on
82 * systems where main memory is not DMA-coherent (most non-x86 boards).
84 struct ads7846_packet {
85 u8 read_x, read_y, read_z1, read_z2, pwrdown;
86 u16 dummy; /* for the pwrdown read */
88 /* for ads7845 with mpc5121 psc spi we use 3-byte buffers */
89 u8 read_x_cmd[3], read_y_cmd[3], pwrdown_cmd[3];
93 struct input_dev *input;
97 struct spi_device *spi;
98 struct regulator *reg;
100 #if defined(CONFIG_HWMON) || defined(CONFIG_HWMON_MODULE)
101 struct attribute_group *attr_group;
102 struct device *hwmon;
107 u16 vref_delay_usecs;
114 struct ads7846_packet *packet;
116 struct spi_transfer xfer[18];
117 struct spi_message msg[5];
119 wait_queue_head_t wait;
131 u16 penirq_recheck_delay_usecs;
134 bool stopped; /* P: lock */
135 bool disabled; /* P: lock */
136 bool suspended; /* P: lock */
138 int (*filter)(void *data, int data_idx, int *val);
140 void (*filter_cleanup)(void *data);
141 int (*get_pendown_state)(void);
144 void (*wait_for_sync)(void);
147 /* leave chip selected when we're done, for quicker re-select? */
149 #define CS_CHANGE(xfer) ((xfer).cs_change = 1)
151 #define CS_CHANGE(xfer) ((xfer).cs_change = 0)
154 /*--------------------------------------------------------------------------*/
156 /* The ADS7846 has touchscreen and other sensors.
157 * Earlier ads784x chips are somewhat compatible.
159 #define ADS_START (1 << 7)
160 #define ADS_A2A1A0_d_y (1 << 4) /* differential */
161 #define ADS_A2A1A0_d_z1 (3 << 4) /* differential */
162 #define ADS_A2A1A0_d_z2 (4 << 4) /* differential */
163 #define ADS_A2A1A0_d_x (5 << 4) /* differential */
164 #define ADS_A2A1A0_temp0 (0 << 4) /* non-differential */
165 #define ADS_A2A1A0_vbatt (2 << 4) /* non-differential */
166 #define ADS_A2A1A0_vaux (6 << 4) /* non-differential */
167 #define ADS_A2A1A0_temp1 (7 << 4) /* non-differential */
168 #define ADS_8_BIT (1 << 3)
169 #define ADS_12_BIT (0 << 3)
170 #define ADS_SER (1 << 2) /* non-differential */
171 #define ADS_DFR (0 << 2) /* differential */
172 #define ADS_PD10_PDOWN (0 << 0) /* low power mode + penirq */
173 #define ADS_PD10_ADC_ON (1 << 0) /* ADC on */
174 #define ADS_PD10_REF_ON (2 << 0) /* vREF on + penirq */
175 #define ADS_PD10_ALL_ON (3 << 0) /* ADC + vREF on */
177 #define MAX_12BIT ((1<<12)-1)
179 /* leave ADC powered up (disables penirq) between differential samples */
180 #define READ_12BIT_DFR(x, adc, vref) (ADS_START | ADS_A2A1A0_d_ ## x \
181 | ADS_12_BIT | ADS_DFR | \
182 (adc ? ADS_PD10_ADC_ON : 0) | (vref ? ADS_PD10_REF_ON : 0))
184 #define READ_Y(vref) (READ_12BIT_DFR(y, 1, vref))
185 #define READ_Z1(vref) (READ_12BIT_DFR(z1, 1, vref))
186 #define READ_Z2(vref) (READ_12BIT_DFR(z2, 1, vref))
188 #define READ_X(vref) (READ_12BIT_DFR(x, 1, vref))
189 #define PWRDOWN (READ_12BIT_DFR(y, 0, 0)) /* LAST */
191 /* single-ended samples need to first power up reference voltage;
192 * we leave both ADC and VREF powered
194 #define READ_12BIT_SER(x) (ADS_START | ADS_A2A1A0_ ## x \
195 | ADS_12_BIT | ADS_SER)
197 #define REF_ON (READ_12BIT_DFR(x, 1, 1))
198 #define REF_OFF (READ_12BIT_DFR(y, 0, 0))
200 /* Must be called with ts->lock held */
201 static void ads7846_stop(struct ads7846 *ts)
203 if (!ts->disabled && !ts->suspended) {
204 /* Signal IRQ thread to stop polling and disable the handler. */
208 disable_irq(ts->spi->irq);
212 /* Must be called with ts->lock held */
213 static void ads7846_restart(struct ads7846 *ts)
215 if (!ts->disabled && !ts->suspended) {
216 /* Tell IRQ thread that it may poll the device. */
219 enable_irq(ts->spi->irq);
223 /* Must be called with ts->lock held */
224 static void __ads7846_disable(struct ads7846 *ts)
227 regulator_disable(ts->reg);
230 * We know the chip's in low power mode since we always
231 * leave it that way after every request
235 /* Must be called with ts->lock held */
236 static void __ads7846_enable(struct ads7846 *ts)
238 regulator_enable(ts->reg);
242 static void ads7846_disable(struct ads7846 *ts)
244 mutex_lock(&ts->lock);
249 __ads7846_disable(ts);
254 mutex_unlock(&ts->lock);
257 static void ads7846_enable(struct ads7846 *ts)
259 mutex_lock(&ts->lock);
263 ts->disabled = false;
266 __ads7846_enable(ts);
269 mutex_unlock(&ts->lock);
272 /*--------------------------------------------------------------------------*/
275 * Non-touchscreen sensors only use single-ended conversions.
276 * The range is GND..vREF. The ads7843 and ads7835 must use external vREF;
277 * ads7846 lets that pin be unconnected, to use internal vREF.
286 struct spi_message msg;
287 struct spi_transfer xfer[6];
290 struct ads7845_ser_req {
294 struct spi_message msg;
295 struct spi_transfer xfer[2];
298 static int ads7846_read12_ser(struct device *dev, unsigned command)
300 struct spi_device *spi = to_spi_device(dev);
301 struct ads7846 *ts = dev_get_drvdata(dev);
305 req = kzalloc(sizeof *req, GFP_KERNEL);
309 spi_message_init(&req->msg);
311 /* maybe turn on internal vREF, and let it settle */
312 if (ts->use_internal) {
313 req->ref_on = REF_ON;
314 req->xfer[0].tx_buf = &req->ref_on;
315 req->xfer[0].len = 1;
316 spi_message_add_tail(&req->xfer[0], &req->msg);
318 req->xfer[1].rx_buf = &req->scratch;
319 req->xfer[1].len = 2;
321 /* for 1uF, settle for 800 usec; no cap, 100 usec. */
322 req->xfer[1].delay_usecs = ts->vref_delay_usecs;
323 spi_message_add_tail(&req->xfer[1], &req->msg);
325 /* Enable reference voltage */
326 command |= ADS_PD10_REF_ON;
329 /* Enable ADC in every case */
330 command |= ADS_PD10_ADC_ON;
333 req->command = (u8) command;
334 req->xfer[2].tx_buf = &req->command;
335 req->xfer[2].len = 1;
336 spi_message_add_tail(&req->xfer[2], &req->msg);
338 req->xfer[3].rx_buf = &req->sample;
339 req->xfer[3].len = 2;
340 spi_message_add_tail(&req->xfer[3], &req->msg);
342 /* REVISIT: take a few more samples, and compare ... */
344 /* converter in low power mode & enable PENIRQ */
345 req->ref_off = PWRDOWN;
346 req->xfer[4].tx_buf = &req->ref_off;
347 req->xfer[4].len = 1;
348 spi_message_add_tail(&req->xfer[4], &req->msg);
350 req->xfer[5].rx_buf = &req->scratch;
351 req->xfer[5].len = 2;
352 CS_CHANGE(req->xfer[5]);
353 spi_message_add_tail(&req->xfer[5], &req->msg);
355 mutex_lock(&ts->lock);
357 status = spi_sync(spi, &req->msg);
359 mutex_unlock(&ts->lock);
362 /* on-wire is a must-ignore bit, a BE12 value, then padding */
363 status = be16_to_cpu(req->sample);
364 status = status >> 3;
372 static int ads7845_read12_ser(struct device *dev, unsigned command)
374 struct spi_device *spi = to_spi_device(dev);
375 struct ads7846 *ts = dev_get_drvdata(dev);
376 struct ads7845_ser_req *req;
379 req = kzalloc(sizeof *req, GFP_KERNEL);
383 spi_message_init(&req->msg);
385 req->command[0] = (u8) command;
386 req->xfer[0].tx_buf = req->command;
387 req->xfer[0].rx_buf = req->sample;
388 req->xfer[0].len = 3;
389 spi_message_add_tail(&req->xfer[0], &req->msg);
391 mutex_lock(&ts->lock);
393 status = spi_sync(spi, &req->msg);
395 mutex_unlock(&ts->lock);
398 /* BE12 value, then padding */
399 status = be16_to_cpu(*((u16 *)&req->sample[1]));
400 status = status >> 3;
408 #if defined(CONFIG_HWMON) || defined(CONFIG_HWMON_MODULE)
410 #define SHOW(name, var, adjust) static ssize_t \
411 name ## _show(struct device *dev, struct device_attribute *attr, char *buf) \
413 struct ads7846 *ts = dev_get_drvdata(dev); \
414 ssize_t v = ads7846_read12_ser(dev, \
415 READ_12BIT_SER(var)); \
418 return sprintf(buf, "%u\n", adjust(ts, v)); \
420 static DEVICE_ATTR(name, S_IRUGO, name ## _show, NULL);
423 /* Sysfs conventions report temperatures in millidegrees Celsius.
424 * ADS7846 could use the low-accuracy two-sample scheme, but can't do the high
425 * accuracy scheme without calibration data. For now we won't try either;
426 * userspace sees raw sensor values, and must scale/calibrate appropriately.
428 static inline unsigned null_adjust(struct ads7846 *ts, ssize_t v)
433 SHOW(temp0, temp0, null_adjust) /* temp1_input */
434 SHOW(temp1, temp1, null_adjust) /* temp2_input */
437 /* sysfs conventions report voltages in millivolts. We can convert voltages
438 * if we know vREF. userspace may need to scale vAUX to match the board's
439 * external resistors; we assume that vBATT only uses the internal ones.
441 static inline unsigned vaux_adjust(struct ads7846 *ts, ssize_t v)
445 /* external resistors may scale vAUX into 0..vREF */
446 retval *= ts->vref_mv;
447 retval = retval >> 12;
452 static inline unsigned vbatt_adjust(struct ads7846 *ts, ssize_t v)
454 unsigned retval = vaux_adjust(ts, v);
456 /* ads7846 has a resistor ladder to scale this signal down */
457 if (ts->model == 7846)
463 SHOW(in0_input, vaux, vaux_adjust)
464 SHOW(in1_input, vbatt, vbatt_adjust)
466 static struct attribute *ads7846_attributes[] = {
467 &dev_attr_temp0.attr,
468 &dev_attr_temp1.attr,
469 &dev_attr_in0_input.attr,
470 &dev_attr_in1_input.attr,
474 static struct attribute_group ads7846_attr_group = {
475 .attrs = ads7846_attributes,
478 static struct attribute *ads7843_attributes[] = {
479 &dev_attr_in0_input.attr,
480 &dev_attr_in1_input.attr,
484 static struct attribute_group ads7843_attr_group = {
485 .attrs = ads7843_attributes,
488 static struct attribute *ads7845_attributes[] = {
489 &dev_attr_in0_input.attr,
493 static struct attribute_group ads7845_attr_group = {
494 .attrs = ads7845_attributes,
497 static int ads784x_hwmon_register(struct spi_device *spi, struct ads7846 *ts)
499 struct device *hwmon;
502 /* hwmon sensors need a reference voltage */
506 dev_dbg(&spi->dev, "assuming 2.5V internal vREF\n");
508 ts->use_internal = true;
515 "external vREF for ADS%d not specified\n",
522 /* different chips have different sensor groups */
525 ts->attr_group = &ads7846_attr_group;
528 ts->attr_group = &ads7845_attr_group;
531 ts->attr_group = &ads7843_attr_group;
534 dev_dbg(&spi->dev, "ADS%d not recognized\n", ts->model);
538 err = sysfs_create_group(&spi->dev.kobj, ts->attr_group);
542 hwmon = hwmon_device_register(&spi->dev);
544 sysfs_remove_group(&spi->dev.kobj, ts->attr_group);
545 return PTR_ERR(hwmon);
552 static void ads784x_hwmon_unregister(struct spi_device *spi,
556 sysfs_remove_group(&spi->dev.kobj, ts->attr_group);
557 hwmon_device_unregister(ts->hwmon);
562 static inline int ads784x_hwmon_register(struct spi_device *spi,
568 static inline void ads784x_hwmon_unregister(struct spi_device *spi,
574 static ssize_t ads7846_pen_down_show(struct device *dev,
575 struct device_attribute *attr, char *buf)
577 struct ads7846 *ts = dev_get_drvdata(dev);
579 return sprintf(buf, "%u\n", ts->pendown);
582 static DEVICE_ATTR(pen_down, S_IRUGO, ads7846_pen_down_show, NULL);
584 static ssize_t ads7846_disable_show(struct device *dev,
585 struct device_attribute *attr, char *buf)
587 struct ads7846 *ts = dev_get_drvdata(dev);
589 return sprintf(buf, "%u\n", ts->disabled);
592 static ssize_t ads7846_disable_store(struct device *dev,
593 struct device_attribute *attr,
594 const char *buf, size_t count)
596 struct ads7846 *ts = dev_get_drvdata(dev);
599 if (strict_strtoul(buf, 10, &i))
610 static DEVICE_ATTR(disable, 0664, ads7846_disable_show, ads7846_disable_store);
612 static struct attribute *ads784x_attributes[] = {
613 &dev_attr_pen_down.attr,
614 &dev_attr_disable.attr,
618 static struct attribute_group ads784x_attr_group = {
619 .attrs = ads784x_attributes,
622 /*--------------------------------------------------------------------------*/
624 static int get_pendown_state(struct ads7846 *ts)
626 if (ts->get_pendown_state)
627 return ts->get_pendown_state();
629 return !gpio_get_value(ts->gpio_pendown);
632 static void null_wait_for_sync(void)
636 static int ads7846_debounce_filter(void *ads, int data_idx, int *val)
638 struct ads7846 *ts = ads;
640 if (!ts->read_cnt || (abs(ts->last_read - *val) > ts->debounce_tol)) {
641 /* Start over collecting consistent readings. */
644 * Repeat it, if this was the first read or the read
645 * wasn't consistent enough.
647 if (ts->read_cnt < ts->debounce_max) {
648 ts->last_read = *val;
650 return ADS7846_FILTER_REPEAT;
653 * Maximum number of debouncing reached and still
654 * not enough number of consistent readings. Abort
655 * the whole sample, repeat it in the next sampling
659 return ADS7846_FILTER_IGNORE;
662 if (++ts->read_rep > ts->debounce_rep) {
664 * Got a good reading for this coordinate,
665 * go for the next one.
669 return ADS7846_FILTER_OK;
671 /* Read more values that are consistent. */
673 return ADS7846_FILTER_REPEAT;
678 static int ads7846_no_filter(void *ads, int data_idx, int *val)
680 return ADS7846_FILTER_OK;
683 static int ads7846_get_value(struct ads7846 *ts, struct spi_message *m)
685 struct spi_transfer *t =
686 list_entry(m->transfers.prev, struct spi_transfer, transfer_list);
688 if (ts->model == 7845) {
689 return be16_to_cpup((__be16 *)&(((char*)t->rx_buf)[1])) >> 3;
692 * adjust: on-wire is a must-ignore bit, a BE12 value, then
693 * padding; built from two 8 bit values written msb-first.
695 return be16_to_cpup((__be16 *)t->rx_buf) >> 3;
699 static void ads7846_update_value(struct spi_message *m, int val)
701 struct spi_transfer *t =
702 list_entry(m->transfers.prev, struct spi_transfer, transfer_list);
704 *(u16 *)t->rx_buf = val;
707 static void ads7846_read_state(struct ads7846 *ts)
709 struct ads7846_packet *packet = ts->packet;
710 struct spi_message *m;
716 while (msg_idx < ts->msg_count) {
720 m = &ts->msg[msg_idx];
721 error = spi_sync(ts->spi, m);
723 dev_err(&ts->spi->dev, "spi_async --> %d\n", error);
724 packet->tc.ignore = true;
729 * Last message is power down request, no need to convert
730 * or filter the value.
732 if (msg_idx < ts->msg_count - 1) {
734 val = ads7846_get_value(ts, m);
736 action = ts->filter(ts->filter_data, msg_idx, &val);
738 case ADS7846_FILTER_REPEAT:
741 case ADS7846_FILTER_IGNORE:
742 packet->tc.ignore = true;
743 msg_idx = ts->msg_count - 1;
746 case ADS7846_FILTER_OK:
747 ads7846_update_value(m, val);
748 packet->tc.ignore = false;
761 static void ads7846_report_state(struct ads7846 *ts)
763 struct ads7846_packet *packet = ts->packet;
768 * ads7846_get_value() does in-place conversion (including byte swap)
769 * from on-the-wire format as part of debouncing to get stable
772 if (ts->model == 7845) {
773 x = *(u16 *)packet->tc.x_buf;
774 y = *(u16 *)packet->tc.y_buf;
784 /* range filtering */
788 if (ts->model == 7843) {
789 Rt = ts->pressure_max / 2;
790 } else if (ts->model == 7845) {
791 if (get_pendown_state(ts))
792 Rt = ts->pressure_max / 2;
795 dev_vdbg(&ts->spi->dev, "x/y: %d/%d, PD %d\n", x, y, Rt);
796 } else if (likely(x && z1)) {
797 /* compute touch pressure resistance using equation #2 */
801 Rt *= ts->x_plate_ohms;
803 Rt = (Rt + 2047) >> 12;
809 * Sample found inconsistent by debouncing or pressure is beyond
810 * the maximum. Don't report it to user space, repeat at least
811 * once more the measurement
813 if (packet->tc.ignore || Rt > ts->pressure_max) {
814 dev_vdbg(&ts->spi->dev, "ignored %d pressure %d\n",
815 packet->tc.ignore, Rt);
820 * Maybe check the pendown state before reporting. This discards
821 * false readings when the pen is lifted.
823 if (ts->penirq_recheck_delay_usecs) {
824 udelay(ts->penirq_recheck_delay_usecs);
825 if (!get_pendown_state(ts))
830 * NOTE: We can't rely on the pressure to determine the pen down
831 * state, even this controller has a pressure sensor. The pressure
832 * value can fluctuate for quite a while after lifting the pen and
833 * in some cases may not even settle at the expected value.
835 * The only safe way to check for the pen up condition is in the
836 * timer by reading the pen signal state (it's a GPIO _and_ IRQ).
839 struct input_dev *input = ts->input;
845 input_report_key(input, BTN_TOUCH, 1);
847 dev_vdbg(&ts->spi->dev, "DOWN\n");
850 input_report_abs(input, ABS_X, x);
851 input_report_abs(input, ABS_Y, y);
852 input_report_abs(input, ABS_PRESSURE, ts->pressure_max - Rt);
855 dev_vdbg(&ts->spi->dev, "%4d/%4d/%4d\n", x, y, Rt);
859 static irqreturn_t ads7846_hard_irq(int irq, void *handle)
861 struct ads7846 *ts = handle;
863 return get_pendown_state(ts) ? IRQ_WAKE_THREAD : IRQ_HANDLED;
867 static irqreturn_t ads7846_irq(int irq, void *handle)
869 struct ads7846 *ts = handle;
871 /* Start with a small delay before checking pendown state */
872 msleep(TS_POLL_DELAY);
874 while (!ts->stopped && get_pendown_state(ts)) {
876 /* pen is down, continue with the measurement */
877 ads7846_read_state(ts);
880 ads7846_report_state(ts);
882 wait_event_timeout(ts->wait, ts->stopped,
883 msecs_to_jiffies(TS_POLL_PERIOD));
887 struct input_dev *input = ts->input;
889 input_report_key(input, BTN_TOUCH, 0);
890 input_report_abs(input, ABS_PRESSURE, 0);
894 dev_vdbg(&ts->spi->dev, "UP\n");
900 #ifdef CONFIG_PM_SLEEP
901 static int ads7846_suspend(struct device *dev)
903 struct ads7846 *ts = dev_get_drvdata(dev);
905 mutex_lock(&ts->lock);
907 if (!ts->suspended) {
910 __ads7846_disable(ts);
912 if (device_may_wakeup(&ts->spi->dev))
913 enable_irq_wake(ts->spi->irq);
915 ts->suspended = true;
918 mutex_unlock(&ts->lock);
923 static int ads7846_resume(struct device *dev)
925 struct ads7846 *ts = dev_get_drvdata(dev);
927 mutex_lock(&ts->lock);
931 ts->suspended = false;
933 if (device_may_wakeup(&ts->spi->dev))
934 disable_irq_wake(ts->spi->irq);
937 __ads7846_enable(ts);
940 mutex_unlock(&ts->lock);
946 static SIMPLE_DEV_PM_OPS(ads7846_pm, ads7846_suspend, ads7846_resume);
948 static int __devinit ads7846_setup_pendown(struct spi_device *spi, struct ads7846 *ts)
950 struct ads7846_platform_data *pdata = spi->dev.platform_data;
954 * REVISIT when the irq can be triggered active-low, or if for some
955 * reason the touchscreen isn't hooked up, we don't need to access
959 if (pdata->get_pendown_state) {
960 ts->get_pendown_state = pdata->get_pendown_state;
961 } else if (gpio_is_valid(pdata->gpio_pendown)) {
963 err = gpio_request(pdata->gpio_pendown, "ads7846_pendown");
965 dev_err(&spi->dev, "failed to request pendown GPIO%d\n",
966 pdata->gpio_pendown);
969 err = gpio_direction_input(pdata->gpio_pendown);
971 dev_err(&spi->dev, "failed to setup pendown GPIO%d\n",
972 pdata->gpio_pendown);
973 gpio_free(pdata->gpio_pendown);
977 ts->gpio_pendown = pdata->gpio_pendown;
980 dev_err(&spi->dev, "no get_pendown_state nor gpio_pendown?\n");
988 * Set up the transfers to read touchscreen state; this assumes we
989 * use formula #2 for pressure, not #3.
991 static void __devinit ads7846_setup_spi_msg(struct ads7846 *ts,
992 const struct ads7846_platform_data *pdata)
994 struct spi_message *m = &ts->msg[0];
995 struct spi_transfer *x = ts->xfer;
996 struct ads7846_packet *packet = ts->packet;
997 int vref = pdata->keep_vref_on;
999 if (ts->model == 7873) {
1001 * The AD7873 is almost identical to the ADS7846
1002 * keep VREF off during differential/ratiometric
1010 spi_message_init(m);
1013 if (ts->model == 7845) {
1014 packet->read_y_cmd[0] = READ_Y(vref);
1015 packet->read_y_cmd[1] = 0;
1016 packet->read_y_cmd[2] = 0;
1017 x->tx_buf = &packet->read_y_cmd[0];
1018 x->rx_buf = &packet->tc.y_buf[0];
1020 spi_message_add_tail(x, m);
1022 /* y- still on; turn on only y+ (and ADC) */
1023 packet->read_y = READ_Y(vref);
1024 x->tx_buf = &packet->read_y;
1026 spi_message_add_tail(x, m);
1029 x->rx_buf = &packet->tc.y;
1031 spi_message_add_tail(x, m);
1035 * The first sample after switching drivers can be low quality;
1036 * optionally discard it, using a second one after the signals
1037 * have had enough time to stabilize.
1039 if (pdata->settle_delay_usecs) {
1040 x->delay_usecs = pdata->settle_delay_usecs;
1043 x->tx_buf = &packet->read_y;
1045 spi_message_add_tail(x, m);
1048 x->rx_buf = &packet->tc.y;
1050 spi_message_add_tail(x, m);
1055 spi_message_init(m);
1058 if (ts->model == 7845) {
1060 packet->read_x_cmd[0] = READ_X(vref);
1061 packet->read_x_cmd[1] = 0;
1062 packet->read_x_cmd[2] = 0;
1063 x->tx_buf = &packet->read_x_cmd[0];
1064 x->rx_buf = &packet->tc.x_buf[0];
1066 spi_message_add_tail(x, m);
1068 /* turn y- off, x+ on, then leave in lowpower */
1070 packet->read_x = READ_X(vref);
1071 x->tx_buf = &packet->read_x;
1073 spi_message_add_tail(x, m);
1076 x->rx_buf = &packet->tc.x;
1078 spi_message_add_tail(x, m);
1081 /* ... maybe discard first sample ... */
1082 if (pdata->settle_delay_usecs) {
1083 x->delay_usecs = pdata->settle_delay_usecs;
1086 x->tx_buf = &packet->read_x;
1088 spi_message_add_tail(x, m);
1091 x->rx_buf = &packet->tc.x;
1093 spi_message_add_tail(x, m);
1096 /* turn y+ off, x- on; we'll use formula #2 */
1097 if (ts->model == 7846) {
1100 spi_message_init(m);
1104 packet->read_z1 = READ_Z1(vref);
1105 x->tx_buf = &packet->read_z1;
1107 spi_message_add_tail(x, m);
1110 x->rx_buf = &packet->tc.z1;
1112 spi_message_add_tail(x, m);
1114 /* ... maybe discard first sample ... */
1115 if (pdata->settle_delay_usecs) {
1116 x->delay_usecs = pdata->settle_delay_usecs;
1119 x->tx_buf = &packet->read_z1;
1121 spi_message_add_tail(x, m);
1124 x->rx_buf = &packet->tc.z1;
1126 spi_message_add_tail(x, m);
1131 spi_message_init(m);
1135 packet->read_z2 = READ_Z2(vref);
1136 x->tx_buf = &packet->read_z2;
1138 spi_message_add_tail(x, m);
1141 x->rx_buf = &packet->tc.z2;
1143 spi_message_add_tail(x, m);
1145 /* ... maybe discard first sample ... */
1146 if (pdata->settle_delay_usecs) {
1147 x->delay_usecs = pdata->settle_delay_usecs;
1150 x->tx_buf = &packet->read_z2;
1152 spi_message_add_tail(x, m);
1155 x->rx_buf = &packet->tc.z2;
1157 spi_message_add_tail(x, m);
1164 spi_message_init(m);
1167 if (ts->model == 7845) {
1169 packet->pwrdown_cmd[0] = PWRDOWN;
1170 packet->pwrdown_cmd[1] = 0;
1171 packet->pwrdown_cmd[2] = 0;
1172 x->tx_buf = &packet->pwrdown_cmd[0];
1176 packet->pwrdown = PWRDOWN;
1177 x->tx_buf = &packet->pwrdown;
1179 spi_message_add_tail(x, m);
1182 x->rx_buf = &packet->dummy;
1187 spi_message_add_tail(x, m);
1190 static int __devinit ads7846_probe(struct spi_device *spi)
1193 struct ads7846_packet *packet;
1194 struct input_dev *input_dev;
1195 struct ads7846_platform_data *pdata = spi->dev.platform_data;
1196 unsigned long irq_flags;
1200 dev_dbg(&spi->dev, "no IRQ?\n");
1205 dev_dbg(&spi->dev, "no platform data?\n");
1209 /* don't exceed max specified sample rate */
1210 if (spi->max_speed_hz > (125000 * SAMPLE_BITS)) {
1211 dev_dbg(&spi->dev, "f(sample) %d KHz?\n",
1212 (spi->max_speed_hz/SAMPLE_BITS)/1000);
1216 /* We'd set TX word size 8 bits and RX word size to 13 bits ... except
1217 * that even if the hardware can do that, the SPI controller driver
1218 * may not. So we stick to very-portable 8 bit words, both RX and TX.
1220 spi->bits_per_word = 8;
1221 spi->mode = SPI_MODE_0;
1222 err = spi_setup(spi);
1226 ts = kzalloc(sizeof(struct ads7846), GFP_KERNEL);
1227 packet = kzalloc(sizeof(struct ads7846_packet), GFP_KERNEL);
1228 input_dev = input_allocate_device();
1229 if (!ts || !packet || !input_dev) {
1234 dev_set_drvdata(&spi->dev, ts);
1236 ts->packet = packet;
1238 ts->input = input_dev;
1239 ts->vref_mv = pdata->vref_mv;
1240 ts->swap_xy = pdata->swap_xy;
1242 mutex_init(&ts->lock);
1243 init_waitqueue_head(&ts->wait);
1245 ts->model = pdata->model ? : 7846;
1246 ts->vref_delay_usecs = pdata->vref_delay_usecs ? : 100;
1247 ts->x_plate_ohms = pdata->x_plate_ohms ? : 400;
1248 ts->pressure_max = pdata->pressure_max ? : ~0;
1250 if (pdata->filter != NULL) {
1251 if (pdata->filter_init != NULL) {
1252 err = pdata->filter_init(pdata, &ts->filter_data);
1256 ts->filter = pdata->filter;
1257 ts->filter_cleanup = pdata->filter_cleanup;
1258 } else if (pdata->debounce_max) {
1259 ts->debounce_max = pdata->debounce_max;
1260 if (ts->debounce_max < 2)
1261 ts->debounce_max = 2;
1262 ts->debounce_tol = pdata->debounce_tol;
1263 ts->debounce_rep = pdata->debounce_rep;
1264 ts->filter = ads7846_debounce_filter;
1265 ts->filter_data = ts;
1267 ts->filter = ads7846_no_filter;
1270 err = ads7846_setup_pendown(spi, ts);
1272 goto err_cleanup_filter;
1274 if (pdata->penirq_recheck_delay_usecs)
1275 ts->penirq_recheck_delay_usecs =
1276 pdata->penirq_recheck_delay_usecs;
1278 ts->wait_for_sync = pdata->wait_for_sync ? : null_wait_for_sync;
1280 snprintf(ts->phys, sizeof(ts->phys), "%s/input0", dev_name(&spi->dev));
1281 snprintf(ts->name, sizeof(ts->name), "ADS%d Touchscreen", ts->model);
1283 input_dev->name = ts->name;
1284 input_dev->phys = ts->phys;
1285 input_dev->dev.parent = &spi->dev;
1287 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
1288 input_dev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
1289 input_set_abs_params(input_dev, ABS_X,
1291 pdata->x_max ? : MAX_12BIT,
1293 input_set_abs_params(input_dev, ABS_Y,
1295 pdata->y_max ? : MAX_12BIT,
1297 input_set_abs_params(input_dev, ABS_PRESSURE,
1298 pdata->pressure_min, pdata->pressure_max, 0, 0);
1300 ads7846_setup_spi_msg(ts, pdata);
1302 ts->reg = regulator_get(&spi->dev, "vcc");
1303 if (IS_ERR(ts->reg)) {
1304 err = PTR_ERR(ts->reg);
1305 dev_err(&spi->dev, "unable to get regulator: %d\n", err);
1309 err = regulator_enable(ts->reg);
1311 dev_err(&spi->dev, "unable to enable regulator: %d\n", err);
1312 goto err_put_regulator;
1315 irq_flags = pdata->irq_flags ? : IRQF_TRIGGER_FALLING;
1316 irq_flags |= IRQF_ONESHOT;
1318 err = request_threaded_irq(spi->irq, ads7846_hard_irq, ads7846_irq,
1319 irq_flags, spi->dev.driver->name, ts);
1320 if (err && !pdata->irq_flags) {
1322 "trying pin change workaround on irq %d\n", spi->irq);
1323 irq_flags |= IRQF_TRIGGER_RISING;
1324 err = request_threaded_irq(spi->irq,
1325 ads7846_hard_irq, ads7846_irq,
1326 irq_flags, spi->dev.driver->name, ts);
1330 dev_dbg(&spi->dev, "irq %d busy?\n", spi->irq);
1331 goto err_disable_regulator;
1334 err = ads784x_hwmon_register(spi, ts);
1338 dev_info(&spi->dev, "touchscreen, irq %d\n", spi->irq);
1341 * Take a first sample, leaving nPENIRQ active and vREF off; avoid
1342 * the touchscreen, in case it's not connected.
1344 if (ts->model == 7845)
1345 ads7845_read12_ser(&spi->dev, PWRDOWN);
1347 (void) ads7846_read12_ser(&spi->dev, READ_12BIT_SER(vaux));
1349 err = sysfs_create_group(&spi->dev.kobj, &ads784x_attr_group);
1351 goto err_remove_hwmon;
1353 err = input_register_device(input_dev);
1355 goto err_remove_attr_group;
1357 device_init_wakeup(&spi->dev, pdata->wakeup);
1361 err_remove_attr_group:
1362 sysfs_remove_group(&spi->dev.kobj, &ads784x_attr_group);
1364 ads784x_hwmon_unregister(spi, ts);
1366 free_irq(spi->irq, ts);
1367 err_disable_regulator:
1368 regulator_disable(ts->reg);
1370 regulator_put(ts->reg);
1372 if (!ts->get_pendown_state)
1373 gpio_free(ts->gpio_pendown);
1375 if (ts->filter_cleanup)
1376 ts->filter_cleanup(ts->filter_data);
1378 input_free_device(input_dev);
1384 static int __devexit ads7846_remove(struct spi_device *spi)
1386 struct ads7846 *ts = dev_get_drvdata(&spi->dev);
1388 device_init_wakeup(&spi->dev, false);
1390 sysfs_remove_group(&spi->dev.kobj, &ads784x_attr_group);
1392 ads7846_disable(ts);
1393 free_irq(ts->spi->irq, ts);
1395 input_unregister_device(ts->input);
1397 ads784x_hwmon_unregister(spi, ts);
1399 regulator_disable(ts->reg);
1400 regulator_put(ts->reg);
1402 if (!ts->get_pendown_state) {
1404 * If we are not using specialized pendown method we must
1405 * have been relying on gpio we set up ourselves.
1407 gpio_free(ts->gpio_pendown);
1410 if (ts->filter_cleanup)
1411 ts->filter_cleanup(ts->filter_data);
1416 dev_dbg(&spi->dev, "unregistered touchscreen\n");
1421 static struct spi_driver ads7846_driver = {
1424 .bus = &spi_bus_type,
1425 .owner = THIS_MODULE,
1428 .probe = ads7846_probe,
1429 .remove = __devexit_p(ads7846_remove),
1432 static int __init ads7846_init(void)
1434 return spi_register_driver(&ads7846_driver);
1436 module_init(ads7846_init);
1438 static void __exit ads7846_exit(void)
1440 spi_unregister_driver(&ads7846_driver);
1442 module_exit(ads7846_exit);
1444 MODULE_DESCRIPTION("ADS7846 TouchScreen Driver");
1445 MODULE_LICENSE("GPL");
1446 MODULE_ALIAS("spi:ads7846");