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>
31 #include <linux/of_gpio.h>
32 #include <linux/of_device.h>
33 #include <linux/gpio.h>
34 #include <linux/spi/spi.h>
35 #include <linux/spi/ads7846.h>
36 #include <linux/regulator/consumer.h>
37 #include <linux/module.h>
41 * This code has been heavily tested on a Nokia 770, and lightly
42 * tested on other ads7846 devices (OSK/Mistral, Lubbock, Spitz).
43 * TSC2046 is just newer ads7846 silicon.
44 * Support for ads7843 tested on Atmel at91sam926x-EK.
45 * Support for ads7845 has only been stubbed in.
46 * Support for Analog Devices AD7873 and AD7843 tested.
48 * IRQ handling needs a workaround because of a shortcoming in handling
49 * edge triggered IRQs on some platforms like the OMAP1/2. These
50 * platforms don't handle the ARM lazy IRQ disabling properly, thus we
51 * have to maintain our own SW IRQ disabled status. This should be
52 * removed as soon as the affected platform's IRQ handling is fixed.
54 * App note sbaa036 talks in more detail about accurate sampling...
55 * that ought to help in situations like LCDs inducing noise (which
56 * can also be helped by using synch signals) and more generally.
57 * This driver tries to utilize the measures described in the app
58 * note. The strength of filtering can be set in the board-* specific
62 #define TS_POLL_DELAY 1 /* ms delay before the first sample */
63 #define TS_POLL_PERIOD 5 /* ms delay between samples */
65 /* this driver doesn't aim at the peak continuous sample rate */
66 #define SAMPLE_BITS (8 /*cmd*/ + 16 /*sample*/ + 2 /* before, after */)
70 * For portability, we can't read 12 bit values using SPI (which
71 * would make the controller deliver them as native byte order u16
72 * with msbs zeroed). Instead, we read them as two 8-bit values,
73 * *** WHICH NEED BYTESWAPPING *** and range adjustment.
84 * We allocate this separately to avoid cache line sharing issues when
85 * driver is used with DMA-based SPI controllers (like atmel_spi) on
86 * systems where main memory is not DMA-coherent (most non-x86 boards).
88 struct ads7846_packet
{
89 u8 read_x
, read_y
, read_z1
, read_z2
, pwrdown
;
90 u16 dummy
; /* for the pwrdown read */
92 /* for ads7845 with mpc5121 psc spi we use 3-byte buffers */
93 u8 read_x_cmd
[3], read_y_cmd
[3], pwrdown_cmd
[3];
97 struct input_dev
*input
;
101 struct spi_device
*spi
;
102 struct regulator
*reg
;
104 #if defined(CONFIG_HWMON) || defined(CONFIG_HWMON_MODULE)
105 struct attribute_group
*attr_group
;
106 struct device
*hwmon
;
111 u16 vref_delay_usecs
;
118 struct ads7846_packet
*packet
;
120 struct spi_transfer xfer
[18];
121 struct spi_message msg
[5];
123 wait_queue_head_t wait
;
135 u16 penirq_recheck_delay_usecs
;
138 bool stopped
; /* P: lock */
139 bool disabled
; /* P: lock */
140 bool suspended
; /* P: lock */
142 int (*filter
)(void *data
, int data_idx
, int *val
);
144 void (*filter_cleanup
)(void *data
);
145 int (*get_pendown_state
)(void);
148 void (*wait_for_sync
)(void);
151 /* leave chip selected when we're done, for quicker re-select? */
153 #define CS_CHANGE(xfer) ((xfer).cs_change = 1)
155 #define CS_CHANGE(xfer) ((xfer).cs_change = 0)
158 /*--------------------------------------------------------------------------*/
160 /* The ADS7846 has touchscreen and other sensors.
161 * Earlier ads784x chips are somewhat compatible.
163 #define ADS_START (1 << 7)
164 #define ADS_A2A1A0_d_y (1 << 4) /* differential */
165 #define ADS_A2A1A0_d_z1 (3 << 4) /* differential */
166 #define ADS_A2A1A0_d_z2 (4 << 4) /* differential */
167 #define ADS_A2A1A0_d_x (5 << 4) /* differential */
168 #define ADS_A2A1A0_temp0 (0 << 4) /* non-differential */
169 #define ADS_A2A1A0_vbatt (2 << 4) /* non-differential */
170 #define ADS_A2A1A0_vaux (6 << 4) /* non-differential */
171 #define ADS_A2A1A0_temp1 (7 << 4) /* non-differential */
172 #define ADS_8_BIT (1 << 3)
173 #define ADS_12_BIT (0 << 3)
174 #define ADS_SER (1 << 2) /* non-differential */
175 #define ADS_DFR (0 << 2) /* differential */
176 #define ADS_PD10_PDOWN (0 << 0) /* low power mode + penirq */
177 #define ADS_PD10_ADC_ON (1 << 0) /* ADC on */
178 #define ADS_PD10_REF_ON (2 << 0) /* vREF on + penirq */
179 #define ADS_PD10_ALL_ON (3 << 0) /* ADC + vREF on */
181 #define MAX_12BIT ((1<<12)-1)
183 /* leave ADC powered up (disables penirq) between differential samples */
184 #define READ_12BIT_DFR(x, adc, vref) (ADS_START | ADS_A2A1A0_d_ ## x \
185 | ADS_12_BIT | ADS_DFR | \
186 (adc ? ADS_PD10_ADC_ON : 0) | (vref ? ADS_PD10_REF_ON : 0))
188 #define READ_Y(vref) (READ_12BIT_DFR(y, 1, vref))
189 #define READ_Z1(vref) (READ_12BIT_DFR(z1, 1, vref))
190 #define READ_Z2(vref) (READ_12BIT_DFR(z2, 1, vref))
192 #define READ_X(vref) (READ_12BIT_DFR(x, 1, vref))
193 #define PWRDOWN (READ_12BIT_DFR(y, 0, 0)) /* LAST */
195 /* single-ended samples need to first power up reference voltage;
196 * we leave both ADC and VREF powered
198 #define READ_12BIT_SER(x) (ADS_START | ADS_A2A1A0_ ## x \
199 | ADS_12_BIT | ADS_SER)
201 #define REF_ON (READ_12BIT_DFR(x, 1, 1))
202 #define REF_OFF (READ_12BIT_DFR(y, 0, 0))
204 /* Must be called with ts->lock held */
205 static void ads7846_stop(struct ads7846
*ts
)
207 if (!ts
->disabled
&& !ts
->suspended
) {
208 /* Signal IRQ thread to stop polling and disable the handler. */
212 disable_irq(ts
->spi
->irq
);
216 /* Must be called with ts->lock held */
217 static void ads7846_restart(struct ads7846
*ts
)
219 if (!ts
->disabled
&& !ts
->suspended
) {
220 /* Tell IRQ thread that it may poll the device. */
223 enable_irq(ts
->spi
->irq
);
227 /* Must be called with ts->lock held */
228 static void __ads7846_disable(struct ads7846
*ts
)
231 regulator_disable(ts
->reg
);
234 * We know the chip's in low power mode since we always
235 * leave it that way after every request
239 /* Must be called with ts->lock held */
240 static void __ads7846_enable(struct ads7846
*ts
)
244 error
= regulator_enable(ts
->reg
);
246 dev_err(&ts
->spi
->dev
, "Failed to enable supply: %d\n", error
);
251 static void ads7846_disable(struct ads7846
*ts
)
253 mutex_lock(&ts
->lock
);
258 __ads7846_disable(ts
);
263 mutex_unlock(&ts
->lock
);
266 static void ads7846_enable(struct ads7846
*ts
)
268 mutex_lock(&ts
->lock
);
272 ts
->disabled
= false;
275 __ads7846_enable(ts
);
278 mutex_unlock(&ts
->lock
);
281 /*--------------------------------------------------------------------------*/
284 * Non-touchscreen sensors only use single-ended conversions.
285 * The range is GND..vREF. The ads7843 and ads7835 must use external vREF;
286 * ads7846 lets that pin be unconnected, to use internal vREF.
294 struct spi_message msg
;
295 struct spi_transfer xfer
[6];
297 * DMA (thus cache coherency maintenance) requires the
298 * transfer buffers to live in their own cache lines.
300 __be16 sample ____cacheline_aligned
;
303 struct ads7845_ser_req
{
305 struct spi_message msg
;
306 struct spi_transfer xfer
[2];
308 * DMA (thus cache coherency maintenance) requires the
309 * transfer buffers to live in their own cache lines.
311 u8 sample
[3] ____cacheline_aligned
;
314 static int ads7846_read12_ser(struct device
*dev
, unsigned command
)
316 struct spi_device
*spi
= to_spi_device(dev
);
317 struct ads7846
*ts
= dev_get_drvdata(dev
);
321 req
= kzalloc(sizeof *req
, GFP_KERNEL
);
325 spi_message_init(&req
->msg
);
327 /* maybe turn on internal vREF, and let it settle */
328 if (ts
->use_internal
) {
329 req
->ref_on
= REF_ON
;
330 req
->xfer
[0].tx_buf
= &req
->ref_on
;
331 req
->xfer
[0].len
= 1;
332 spi_message_add_tail(&req
->xfer
[0], &req
->msg
);
334 req
->xfer
[1].rx_buf
= &req
->scratch
;
335 req
->xfer
[1].len
= 2;
337 /* for 1uF, settle for 800 usec; no cap, 100 usec. */
338 req
->xfer
[1].delay_usecs
= ts
->vref_delay_usecs
;
339 spi_message_add_tail(&req
->xfer
[1], &req
->msg
);
341 /* Enable reference voltage */
342 command
|= ADS_PD10_REF_ON
;
345 /* Enable ADC in every case */
346 command
|= ADS_PD10_ADC_ON
;
349 req
->command
= (u8
) command
;
350 req
->xfer
[2].tx_buf
= &req
->command
;
351 req
->xfer
[2].len
= 1;
352 spi_message_add_tail(&req
->xfer
[2], &req
->msg
);
354 req
->xfer
[3].rx_buf
= &req
->sample
;
355 req
->xfer
[3].len
= 2;
356 spi_message_add_tail(&req
->xfer
[3], &req
->msg
);
358 /* REVISIT: take a few more samples, and compare ... */
360 /* converter in low power mode & enable PENIRQ */
361 req
->ref_off
= PWRDOWN
;
362 req
->xfer
[4].tx_buf
= &req
->ref_off
;
363 req
->xfer
[4].len
= 1;
364 spi_message_add_tail(&req
->xfer
[4], &req
->msg
);
366 req
->xfer
[5].rx_buf
= &req
->scratch
;
367 req
->xfer
[5].len
= 2;
368 CS_CHANGE(req
->xfer
[5]);
369 spi_message_add_tail(&req
->xfer
[5], &req
->msg
);
371 mutex_lock(&ts
->lock
);
373 status
= spi_sync(spi
, &req
->msg
);
375 mutex_unlock(&ts
->lock
);
378 /* on-wire is a must-ignore bit, a BE12 value, then padding */
379 status
= be16_to_cpu(req
->sample
);
380 status
= status
>> 3;
388 static int ads7845_read12_ser(struct device
*dev
, unsigned command
)
390 struct spi_device
*spi
= to_spi_device(dev
);
391 struct ads7846
*ts
= dev_get_drvdata(dev
);
392 struct ads7845_ser_req
*req
;
395 req
= kzalloc(sizeof *req
, GFP_KERNEL
);
399 spi_message_init(&req
->msg
);
401 req
->command
[0] = (u8
) command
;
402 req
->xfer
[0].tx_buf
= req
->command
;
403 req
->xfer
[0].rx_buf
= req
->sample
;
404 req
->xfer
[0].len
= 3;
405 spi_message_add_tail(&req
->xfer
[0], &req
->msg
);
407 mutex_lock(&ts
->lock
);
409 status
= spi_sync(spi
, &req
->msg
);
411 mutex_unlock(&ts
->lock
);
414 /* BE12 value, then padding */
415 status
= be16_to_cpu(*((u16
*)&req
->sample
[1]));
416 status
= status
>> 3;
424 #if defined(CONFIG_HWMON) || defined(CONFIG_HWMON_MODULE)
426 #define SHOW(name, var, adjust) static ssize_t \
427 name ## _show(struct device *dev, struct device_attribute *attr, char *buf) \
429 struct ads7846 *ts = dev_get_drvdata(dev); \
430 ssize_t v = ads7846_read12_ser(dev, \
431 READ_12BIT_SER(var)); \
434 return sprintf(buf, "%u\n", adjust(ts, v)); \
436 static DEVICE_ATTR(name, S_IRUGO, name ## _show, NULL);
439 /* Sysfs conventions report temperatures in millidegrees Celsius.
440 * ADS7846 could use the low-accuracy two-sample scheme, but can't do the high
441 * accuracy scheme without calibration data. For now we won't try either;
442 * userspace sees raw sensor values, and must scale/calibrate appropriately.
444 static inline unsigned null_adjust(struct ads7846
*ts
, ssize_t v
)
449 SHOW(temp0
, temp0
, null_adjust
) /* temp1_input */
450 SHOW(temp1
, temp1
, null_adjust
) /* temp2_input */
453 /* sysfs conventions report voltages in millivolts. We can convert voltages
454 * if we know vREF. userspace may need to scale vAUX to match the board's
455 * external resistors; we assume that vBATT only uses the internal ones.
457 static inline unsigned vaux_adjust(struct ads7846
*ts
, ssize_t v
)
461 /* external resistors may scale vAUX into 0..vREF */
462 retval
*= ts
->vref_mv
;
463 retval
= retval
>> 12;
468 static inline unsigned vbatt_adjust(struct ads7846
*ts
, ssize_t v
)
470 unsigned retval
= vaux_adjust(ts
, v
);
472 /* ads7846 has a resistor ladder to scale this signal down */
473 if (ts
->model
== 7846)
479 SHOW(in0_input
, vaux
, vaux_adjust
)
480 SHOW(in1_input
, vbatt
, vbatt_adjust
)
482 static struct attribute
*ads7846_attributes
[] = {
483 &dev_attr_temp0
.attr
,
484 &dev_attr_temp1
.attr
,
485 &dev_attr_in0_input
.attr
,
486 &dev_attr_in1_input
.attr
,
490 static struct attribute_group ads7846_attr_group
= {
491 .attrs
= ads7846_attributes
,
494 static struct attribute
*ads7843_attributes
[] = {
495 &dev_attr_in0_input
.attr
,
496 &dev_attr_in1_input
.attr
,
500 static struct attribute_group ads7843_attr_group
= {
501 .attrs
= ads7843_attributes
,
504 static struct attribute
*ads7845_attributes
[] = {
505 &dev_attr_in0_input
.attr
,
509 static struct attribute_group ads7845_attr_group
= {
510 .attrs
= ads7845_attributes
,
513 static int ads784x_hwmon_register(struct spi_device
*spi
, struct ads7846
*ts
)
515 struct device
*hwmon
;
518 /* hwmon sensors need a reference voltage */
522 dev_dbg(&spi
->dev
, "assuming 2.5V internal vREF\n");
524 ts
->use_internal
= true;
531 "external vREF for ADS%d not specified\n",
538 /* different chips have different sensor groups */
541 ts
->attr_group
= &ads7846_attr_group
;
544 ts
->attr_group
= &ads7845_attr_group
;
547 ts
->attr_group
= &ads7843_attr_group
;
550 dev_dbg(&spi
->dev
, "ADS%d not recognized\n", ts
->model
);
554 err
= sysfs_create_group(&spi
->dev
.kobj
, ts
->attr_group
);
558 hwmon
= hwmon_device_register(&spi
->dev
);
560 sysfs_remove_group(&spi
->dev
.kobj
, ts
->attr_group
);
561 return PTR_ERR(hwmon
);
568 static void ads784x_hwmon_unregister(struct spi_device
*spi
,
572 sysfs_remove_group(&spi
->dev
.kobj
, ts
->attr_group
);
573 hwmon_device_unregister(ts
->hwmon
);
578 static inline int ads784x_hwmon_register(struct spi_device
*spi
,
584 static inline void ads784x_hwmon_unregister(struct spi_device
*spi
,
590 static ssize_t
ads7846_pen_down_show(struct device
*dev
,
591 struct device_attribute
*attr
, char *buf
)
593 struct ads7846
*ts
= dev_get_drvdata(dev
);
595 return sprintf(buf
, "%u\n", ts
->pendown
);
598 static DEVICE_ATTR(pen_down
, S_IRUGO
, ads7846_pen_down_show
, NULL
);
600 static ssize_t
ads7846_disable_show(struct device
*dev
,
601 struct device_attribute
*attr
, char *buf
)
603 struct ads7846
*ts
= dev_get_drvdata(dev
);
605 return sprintf(buf
, "%u\n", ts
->disabled
);
608 static ssize_t
ads7846_disable_store(struct device
*dev
,
609 struct device_attribute
*attr
,
610 const char *buf
, size_t count
)
612 struct ads7846
*ts
= dev_get_drvdata(dev
);
616 err
= kstrtouint(buf
, 10, &i
);
628 static DEVICE_ATTR(disable
, 0664, ads7846_disable_show
, ads7846_disable_store
);
630 static struct attribute
*ads784x_attributes
[] = {
631 &dev_attr_pen_down
.attr
,
632 &dev_attr_disable
.attr
,
636 static struct attribute_group ads784x_attr_group
= {
637 .attrs
= ads784x_attributes
,
640 /*--------------------------------------------------------------------------*/
642 static int get_pendown_state(struct ads7846
*ts
)
644 if (ts
->get_pendown_state
)
645 return ts
->get_pendown_state();
647 return !gpio_get_value(ts
->gpio_pendown
);
650 static void null_wait_for_sync(void)
654 static int ads7846_debounce_filter(void *ads
, int data_idx
, int *val
)
656 struct ads7846
*ts
= ads
;
658 if (!ts
->read_cnt
|| (abs(ts
->last_read
- *val
) > ts
->debounce_tol
)) {
659 /* Start over collecting consistent readings. */
662 * Repeat it, if this was the first read or the read
663 * wasn't consistent enough.
665 if (ts
->read_cnt
< ts
->debounce_max
) {
666 ts
->last_read
= *val
;
668 return ADS7846_FILTER_REPEAT
;
671 * Maximum number of debouncing reached and still
672 * not enough number of consistent readings. Abort
673 * the whole sample, repeat it in the next sampling
677 return ADS7846_FILTER_IGNORE
;
680 if (++ts
->read_rep
> ts
->debounce_rep
) {
682 * Got a good reading for this coordinate,
683 * go for the next one.
687 return ADS7846_FILTER_OK
;
689 /* Read more values that are consistent. */
691 return ADS7846_FILTER_REPEAT
;
696 static int ads7846_no_filter(void *ads
, int data_idx
, int *val
)
698 return ADS7846_FILTER_OK
;
701 static int ads7846_get_value(struct ads7846
*ts
, struct spi_message
*m
)
704 struct spi_transfer
*t
=
705 list_entry(m
->transfers
.prev
, struct spi_transfer
, transfer_list
);
707 if (ts
->model
== 7845) {
708 value
= be16_to_cpup((__be16
*)&(((char *)t
->rx_buf
)[1]));
711 * adjust: on-wire is a must-ignore bit, a BE12 value, then
712 * padding; built from two 8 bit values written msb-first.
714 value
= be16_to_cpup((__be16
*)t
->rx_buf
);
717 /* enforce ADC output is 12 bits width */
718 return (value
>> 3) & 0xfff;
721 static void ads7846_update_value(struct spi_message
*m
, int val
)
723 struct spi_transfer
*t
=
724 list_entry(m
->transfers
.prev
, struct spi_transfer
, transfer_list
);
726 *(u16
*)t
->rx_buf
= val
;
729 static void ads7846_read_state(struct ads7846
*ts
)
731 struct ads7846_packet
*packet
= ts
->packet
;
732 struct spi_message
*m
;
738 while (msg_idx
< ts
->msg_count
) {
742 m
= &ts
->msg
[msg_idx
];
743 error
= spi_sync(ts
->spi
, m
);
745 dev_err(&ts
->spi
->dev
, "spi_async --> %d\n", error
);
746 packet
->tc
.ignore
= true;
751 * Last message is power down request, no need to convert
752 * or filter the value.
754 if (msg_idx
< ts
->msg_count
- 1) {
756 val
= ads7846_get_value(ts
, m
);
758 action
= ts
->filter(ts
->filter_data
, msg_idx
, &val
);
760 case ADS7846_FILTER_REPEAT
:
763 case ADS7846_FILTER_IGNORE
:
764 packet
->tc
.ignore
= true;
765 msg_idx
= ts
->msg_count
- 1;
768 case ADS7846_FILTER_OK
:
769 ads7846_update_value(m
, val
);
770 packet
->tc
.ignore
= false;
783 static void ads7846_report_state(struct ads7846
*ts
)
785 struct ads7846_packet
*packet
= ts
->packet
;
790 * ads7846_get_value() does in-place conversion (including byte swap)
791 * from on-the-wire format as part of debouncing to get stable
794 if (ts
->model
== 7845) {
795 x
= *(u16
*)packet
->tc
.x_buf
;
796 y
= *(u16
*)packet
->tc
.y_buf
;
806 /* range filtering */
810 if (ts
->model
== 7843) {
811 Rt
= ts
->pressure_max
/ 2;
812 } else if (ts
->model
== 7845) {
813 if (get_pendown_state(ts
))
814 Rt
= ts
->pressure_max
/ 2;
817 dev_vdbg(&ts
->spi
->dev
, "x/y: %d/%d, PD %d\n", x
, y
, Rt
);
818 } else if (likely(x
&& z1
)) {
819 /* compute touch pressure resistance using equation #2 */
823 Rt
*= ts
->x_plate_ohms
;
825 Rt
= (Rt
+ 2047) >> 12;
831 * Sample found inconsistent by debouncing or pressure is beyond
832 * the maximum. Don't report it to user space, repeat at least
833 * once more the measurement
835 if (packet
->tc
.ignore
|| Rt
> ts
->pressure_max
) {
836 dev_vdbg(&ts
->spi
->dev
, "ignored %d pressure %d\n",
837 packet
->tc
.ignore
, Rt
);
842 * Maybe check the pendown state before reporting. This discards
843 * false readings when the pen is lifted.
845 if (ts
->penirq_recheck_delay_usecs
) {
846 udelay(ts
->penirq_recheck_delay_usecs
);
847 if (!get_pendown_state(ts
))
852 * NOTE: We can't rely on the pressure to determine the pen down
853 * state, even this controller has a pressure sensor. The pressure
854 * value can fluctuate for quite a while after lifting the pen and
855 * in some cases may not even settle at the expected value.
857 * The only safe way to check for the pen up condition is in the
858 * timer by reading the pen signal state (it's a GPIO _and_ IRQ).
861 struct input_dev
*input
= ts
->input
;
867 input_report_key(input
, BTN_TOUCH
, 1);
869 dev_vdbg(&ts
->spi
->dev
, "DOWN\n");
872 input_report_abs(input
, ABS_X
, x
);
873 input_report_abs(input
, ABS_Y
, y
);
874 input_report_abs(input
, ABS_PRESSURE
, ts
->pressure_max
- Rt
);
877 dev_vdbg(&ts
->spi
->dev
, "%4d/%4d/%4d\n", x
, y
, Rt
);
881 static irqreturn_t
ads7846_hard_irq(int irq
, void *handle
)
883 struct ads7846
*ts
= handle
;
885 return get_pendown_state(ts
) ? IRQ_WAKE_THREAD
: IRQ_HANDLED
;
889 static irqreturn_t
ads7846_irq(int irq
, void *handle
)
891 struct ads7846
*ts
= handle
;
893 /* Start with a small delay before checking pendown state */
894 msleep(TS_POLL_DELAY
);
896 while (!ts
->stopped
&& get_pendown_state(ts
)) {
898 /* pen is down, continue with the measurement */
899 ads7846_read_state(ts
);
902 ads7846_report_state(ts
);
904 wait_event_timeout(ts
->wait
, ts
->stopped
,
905 msecs_to_jiffies(TS_POLL_PERIOD
));
909 struct input_dev
*input
= ts
->input
;
911 input_report_key(input
, BTN_TOUCH
, 0);
912 input_report_abs(input
, ABS_PRESSURE
, 0);
916 dev_vdbg(&ts
->spi
->dev
, "UP\n");
922 #ifdef CONFIG_PM_SLEEP
923 static int ads7846_suspend(struct device
*dev
)
925 struct ads7846
*ts
= dev_get_drvdata(dev
);
927 mutex_lock(&ts
->lock
);
929 if (!ts
->suspended
) {
932 __ads7846_disable(ts
);
934 if (device_may_wakeup(&ts
->spi
->dev
))
935 enable_irq_wake(ts
->spi
->irq
);
937 ts
->suspended
= true;
940 mutex_unlock(&ts
->lock
);
945 static int ads7846_resume(struct device
*dev
)
947 struct ads7846
*ts
= dev_get_drvdata(dev
);
949 mutex_lock(&ts
->lock
);
953 ts
->suspended
= false;
955 if (device_may_wakeup(&ts
->spi
->dev
))
956 disable_irq_wake(ts
->spi
->irq
);
959 __ads7846_enable(ts
);
962 mutex_unlock(&ts
->lock
);
968 static SIMPLE_DEV_PM_OPS(ads7846_pm
, ads7846_suspend
, ads7846_resume
);
970 static int ads7846_setup_pendown(struct spi_device
*spi
,
972 const struct ads7846_platform_data
*pdata
)
977 * REVISIT when the irq can be triggered active-low, or if for some
978 * reason the touchscreen isn't hooked up, we don't need to access
982 if (pdata
->get_pendown_state
) {
983 ts
->get_pendown_state
= pdata
->get_pendown_state
;
984 } else if (gpio_is_valid(pdata
->gpio_pendown
)) {
986 err
= gpio_request_one(pdata
->gpio_pendown
, GPIOF_IN
,
990 "failed to request/setup pendown GPIO%d: %d\n",
991 pdata
->gpio_pendown
, err
);
995 ts
->gpio_pendown
= pdata
->gpio_pendown
;
997 if (pdata
->gpio_pendown_debounce
)
998 gpio_set_debounce(pdata
->gpio_pendown
,
999 pdata
->gpio_pendown_debounce
);
1001 dev_err(&spi
->dev
, "no get_pendown_state nor gpio_pendown?\n");
1009 * Set up the transfers to read touchscreen state; this assumes we
1010 * use formula #2 for pressure, not #3.
1012 static void ads7846_setup_spi_msg(struct ads7846
*ts
,
1013 const struct ads7846_platform_data
*pdata
)
1015 struct spi_message
*m
= &ts
->msg
[0];
1016 struct spi_transfer
*x
= ts
->xfer
;
1017 struct ads7846_packet
*packet
= ts
->packet
;
1018 int vref
= pdata
->keep_vref_on
;
1020 if (ts
->model
== 7873) {
1022 * The AD7873 is almost identical to the ADS7846
1023 * keep VREF off during differential/ratiometric
1031 spi_message_init(m
);
1034 if (ts
->model
== 7845) {
1035 packet
->read_y_cmd
[0] = READ_Y(vref
);
1036 packet
->read_y_cmd
[1] = 0;
1037 packet
->read_y_cmd
[2] = 0;
1038 x
->tx_buf
= &packet
->read_y_cmd
[0];
1039 x
->rx_buf
= &packet
->tc
.y_buf
[0];
1041 spi_message_add_tail(x
, m
);
1043 /* y- still on; turn on only y+ (and ADC) */
1044 packet
->read_y
= READ_Y(vref
);
1045 x
->tx_buf
= &packet
->read_y
;
1047 spi_message_add_tail(x
, m
);
1050 x
->rx_buf
= &packet
->tc
.y
;
1052 spi_message_add_tail(x
, m
);
1056 * The first sample after switching drivers can be low quality;
1057 * optionally discard it, using a second one after the signals
1058 * have had enough time to stabilize.
1060 if (pdata
->settle_delay_usecs
) {
1061 x
->delay_usecs
= pdata
->settle_delay_usecs
;
1064 x
->tx_buf
= &packet
->read_y
;
1066 spi_message_add_tail(x
, m
);
1069 x
->rx_buf
= &packet
->tc
.y
;
1071 spi_message_add_tail(x
, m
);
1076 spi_message_init(m
);
1079 if (ts
->model
== 7845) {
1081 packet
->read_x_cmd
[0] = READ_X(vref
);
1082 packet
->read_x_cmd
[1] = 0;
1083 packet
->read_x_cmd
[2] = 0;
1084 x
->tx_buf
= &packet
->read_x_cmd
[0];
1085 x
->rx_buf
= &packet
->tc
.x_buf
[0];
1087 spi_message_add_tail(x
, m
);
1089 /* turn y- off, x+ on, then leave in lowpower */
1091 packet
->read_x
= READ_X(vref
);
1092 x
->tx_buf
= &packet
->read_x
;
1094 spi_message_add_tail(x
, m
);
1097 x
->rx_buf
= &packet
->tc
.x
;
1099 spi_message_add_tail(x
, m
);
1102 /* ... maybe discard first sample ... */
1103 if (pdata
->settle_delay_usecs
) {
1104 x
->delay_usecs
= pdata
->settle_delay_usecs
;
1107 x
->tx_buf
= &packet
->read_x
;
1109 spi_message_add_tail(x
, m
);
1112 x
->rx_buf
= &packet
->tc
.x
;
1114 spi_message_add_tail(x
, m
);
1117 /* turn y+ off, x- on; we'll use formula #2 */
1118 if (ts
->model
== 7846) {
1121 spi_message_init(m
);
1125 packet
->read_z1
= READ_Z1(vref
);
1126 x
->tx_buf
= &packet
->read_z1
;
1128 spi_message_add_tail(x
, m
);
1131 x
->rx_buf
= &packet
->tc
.z1
;
1133 spi_message_add_tail(x
, m
);
1135 /* ... maybe discard first sample ... */
1136 if (pdata
->settle_delay_usecs
) {
1137 x
->delay_usecs
= pdata
->settle_delay_usecs
;
1140 x
->tx_buf
= &packet
->read_z1
;
1142 spi_message_add_tail(x
, m
);
1145 x
->rx_buf
= &packet
->tc
.z1
;
1147 spi_message_add_tail(x
, m
);
1152 spi_message_init(m
);
1156 packet
->read_z2
= READ_Z2(vref
);
1157 x
->tx_buf
= &packet
->read_z2
;
1159 spi_message_add_tail(x
, m
);
1162 x
->rx_buf
= &packet
->tc
.z2
;
1164 spi_message_add_tail(x
, m
);
1166 /* ... maybe discard first sample ... */
1167 if (pdata
->settle_delay_usecs
) {
1168 x
->delay_usecs
= pdata
->settle_delay_usecs
;
1171 x
->tx_buf
= &packet
->read_z2
;
1173 spi_message_add_tail(x
, m
);
1176 x
->rx_buf
= &packet
->tc
.z2
;
1178 spi_message_add_tail(x
, m
);
1185 spi_message_init(m
);
1188 if (ts
->model
== 7845) {
1190 packet
->pwrdown_cmd
[0] = PWRDOWN
;
1191 packet
->pwrdown_cmd
[1] = 0;
1192 packet
->pwrdown_cmd
[2] = 0;
1193 x
->tx_buf
= &packet
->pwrdown_cmd
[0];
1197 packet
->pwrdown
= PWRDOWN
;
1198 x
->tx_buf
= &packet
->pwrdown
;
1200 spi_message_add_tail(x
, m
);
1203 x
->rx_buf
= &packet
->dummy
;
1208 spi_message_add_tail(x
, m
);
1212 static const struct of_device_id ads7846_dt_ids
[] = {
1213 { .compatible
= "ti,tsc2046", .data
= (void *) 7846 },
1214 { .compatible
= "ti,ads7843", .data
= (void *) 7843 },
1215 { .compatible
= "ti,ads7845", .data
= (void *) 7845 },
1216 { .compatible
= "ti,ads7846", .data
= (void *) 7846 },
1217 { .compatible
= "ti,ads7873", .data
= (void *) 7873 },
1220 MODULE_DEVICE_TABLE(of
, ads7846_dt_ids
);
1222 static const struct ads7846_platform_data
*ads7846_probe_dt(struct device
*dev
)
1224 struct ads7846_platform_data
*pdata
;
1225 struct device_node
*node
= dev
->of_node
;
1226 const struct of_device_id
*match
;
1229 dev_err(dev
, "Device does not have associated DT data\n");
1230 return ERR_PTR(-EINVAL
);
1233 match
= of_match_device(ads7846_dt_ids
, dev
);
1235 dev_err(dev
, "Unknown device model\n");
1236 return ERR_PTR(-EINVAL
);
1239 pdata
= devm_kzalloc(dev
, sizeof(*pdata
), GFP_KERNEL
);
1241 return ERR_PTR(-ENOMEM
);
1243 pdata
->model
= (unsigned long)match
->data
;
1245 of_property_read_u16(node
, "ti,vref-delay-usecs",
1246 &pdata
->vref_delay_usecs
);
1247 of_property_read_u16(node
, "ti,vref-mv", &pdata
->vref_mv
);
1248 pdata
->keep_vref_on
= of_property_read_bool(node
, "ti,keep-vref-on");
1250 pdata
->swap_xy
= of_property_read_bool(node
, "ti,swap-xy");
1252 of_property_read_u16(node
, "ti,settle-delay-usec",
1253 &pdata
->settle_delay_usecs
);
1254 of_property_read_u16(node
, "ti,penirq-recheck-delay-usecs",
1255 &pdata
->penirq_recheck_delay_usecs
);
1257 of_property_read_u16(node
, "ti,x-plate-ohms", &pdata
->x_plate_ohms
);
1258 of_property_read_u16(node
, "ti,y-plate-ohms", &pdata
->y_plate_ohms
);
1260 of_property_read_u16(node
, "ti,x-min", &pdata
->x_min
);
1261 of_property_read_u16(node
, "ti,y-min", &pdata
->y_min
);
1262 of_property_read_u16(node
, "ti,x-max", &pdata
->x_max
);
1263 of_property_read_u16(node
, "ti,y-max", &pdata
->y_max
);
1265 of_property_read_u16(node
, "ti,pressure-min", &pdata
->pressure_min
);
1266 of_property_read_u16(node
, "ti,pressure-max", &pdata
->pressure_max
);
1268 of_property_read_u16(node
, "ti,debounce-max", &pdata
->debounce_max
);
1269 of_property_read_u16(node
, "ti,debounce-tol", &pdata
->debounce_tol
);
1270 of_property_read_u16(node
, "ti,debounce-rep", &pdata
->debounce_rep
);
1272 of_property_read_u32(node
, "ti,pendown-gpio-debounce",
1273 &pdata
->gpio_pendown_debounce
);
1275 pdata
->wakeup
= of_property_read_bool(node
, "linux,wakeup");
1277 pdata
->gpio_pendown
= of_get_named_gpio(dev
->of_node
, "pendown-gpio", 0);
1282 static const struct ads7846_platform_data
*ads7846_probe_dt(struct device
*dev
)
1284 dev_err(dev
, "no platform data defined\n");
1285 return ERR_PTR(-EINVAL
);
1289 static int ads7846_probe(struct spi_device
*spi
)
1291 const struct ads7846_platform_data
*pdata
;
1293 struct ads7846_packet
*packet
;
1294 struct input_dev
*input_dev
;
1295 unsigned long irq_flags
;
1299 dev_dbg(&spi
->dev
, "no IRQ?\n");
1303 /* don't exceed max specified sample rate */
1304 if (spi
->max_speed_hz
> (125000 * SAMPLE_BITS
)) {
1305 dev_err(&spi
->dev
, "f(sample) %d KHz?\n",
1306 (spi
->max_speed_hz
/SAMPLE_BITS
)/1000);
1311 * We'd set TX word size 8 bits and RX word size to 13 bits ... except
1312 * that even if the hardware can do that, the SPI controller driver
1313 * may not. So we stick to very-portable 8 bit words, both RX and TX.
1315 spi
->bits_per_word
= 8;
1316 spi
->mode
= SPI_MODE_0
;
1317 err
= spi_setup(spi
);
1321 ts
= kzalloc(sizeof(struct ads7846
), GFP_KERNEL
);
1322 packet
= kzalloc(sizeof(struct ads7846_packet
), GFP_KERNEL
);
1323 input_dev
= input_allocate_device();
1324 if (!ts
|| !packet
|| !input_dev
) {
1329 spi_set_drvdata(spi
, ts
);
1331 ts
->packet
= packet
;
1333 ts
->input
= input_dev
;
1335 mutex_init(&ts
->lock
);
1336 init_waitqueue_head(&ts
->wait
);
1338 pdata
= dev_get_platdata(&spi
->dev
);
1340 pdata
= ads7846_probe_dt(&spi
->dev
);
1342 return PTR_ERR(pdata
);
1345 ts
->model
= pdata
->model
? : 7846;
1346 ts
->vref_delay_usecs
= pdata
->vref_delay_usecs
? : 100;
1347 ts
->x_plate_ohms
= pdata
->x_plate_ohms
? : 400;
1348 ts
->pressure_max
= pdata
->pressure_max
? : ~0;
1350 ts
->vref_mv
= pdata
->vref_mv
;
1351 ts
->swap_xy
= pdata
->swap_xy
;
1353 if (pdata
->filter
!= NULL
) {
1354 if (pdata
->filter_init
!= NULL
) {
1355 err
= pdata
->filter_init(pdata
, &ts
->filter_data
);
1359 ts
->filter
= pdata
->filter
;
1360 ts
->filter_cleanup
= pdata
->filter_cleanup
;
1361 } else if (pdata
->debounce_max
) {
1362 ts
->debounce_max
= pdata
->debounce_max
;
1363 if (ts
->debounce_max
< 2)
1364 ts
->debounce_max
= 2;
1365 ts
->debounce_tol
= pdata
->debounce_tol
;
1366 ts
->debounce_rep
= pdata
->debounce_rep
;
1367 ts
->filter
= ads7846_debounce_filter
;
1368 ts
->filter_data
= ts
;
1370 ts
->filter
= ads7846_no_filter
;
1373 err
= ads7846_setup_pendown(spi
, ts
, pdata
);
1375 goto err_cleanup_filter
;
1377 if (pdata
->penirq_recheck_delay_usecs
)
1378 ts
->penirq_recheck_delay_usecs
=
1379 pdata
->penirq_recheck_delay_usecs
;
1381 ts
->wait_for_sync
= pdata
->wait_for_sync
? : null_wait_for_sync
;
1383 snprintf(ts
->phys
, sizeof(ts
->phys
), "%s/input0", dev_name(&spi
->dev
));
1384 snprintf(ts
->name
, sizeof(ts
->name
), "ADS%d Touchscreen", ts
->model
);
1386 input_dev
->name
= ts
->name
;
1387 input_dev
->phys
= ts
->phys
;
1388 input_dev
->dev
.parent
= &spi
->dev
;
1390 input_dev
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_ABS
);
1391 input_dev
->keybit
[BIT_WORD(BTN_TOUCH
)] = BIT_MASK(BTN_TOUCH
);
1392 input_set_abs_params(input_dev
, ABS_X
,
1394 pdata
->x_max
? : MAX_12BIT
,
1396 input_set_abs_params(input_dev
, ABS_Y
,
1398 pdata
->y_max
? : MAX_12BIT
,
1400 input_set_abs_params(input_dev
, ABS_PRESSURE
,
1401 pdata
->pressure_min
, pdata
->pressure_max
, 0, 0);
1403 ads7846_setup_spi_msg(ts
, pdata
);
1405 ts
->reg
= regulator_get(&spi
->dev
, "vcc");
1406 if (IS_ERR(ts
->reg
)) {
1407 err
= PTR_ERR(ts
->reg
);
1408 dev_err(&spi
->dev
, "unable to get regulator: %d\n", err
);
1412 err
= regulator_enable(ts
->reg
);
1414 dev_err(&spi
->dev
, "unable to enable regulator: %d\n", err
);
1415 goto err_put_regulator
;
1418 irq_flags
= pdata
->irq_flags
? : IRQF_TRIGGER_FALLING
;
1419 irq_flags
|= IRQF_ONESHOT
;
1421 err
= request_threaded_irq(spi
->irq
, ads7846_hard_irq
, ads7846_irq
,
1422 irq_flags
, spi
->dev
.driver
->name
, ts
);
1423 if (err
&& !pdata
->irq_flags
) {
1425 "trying pin change workaround on irq %d\n", spi
->irq
);
1426 irq_flags
|= IRQF_TRIGGER_RISING
;
1427 err
= request_threaded_irq(spi
->irq
,
1428 ads7846_hard_irq
, ads7846_irq
,
1429 irq_flags
, spi
->dev
.driver
->name
, ts
);
1433 dev_dbg(&spi
->dev
, "irq %d busy?\n", spi
->irq
);
1434 goto err_disable_regulator
;
1437 err
= ads784x_hwmon_register(spi
, ts
);
1441 dev_info(&spi
->dev
, "touchscreen, irq %d\n", spi
->irq
);
1444 * Take a first sample, leaving nPENIRQ active and vREF off; avoid
1445 * the touchscreen, in case it's not connected.
1447 if (ts
->model
== 7845)
1448 ads7845_read12_ser(&spi
->dev
, PWRDOWN
);
1450 (void) ads7846_read12_ser(&spi
->dev
, READ_12BIT_SER(vaux
));
1452 err
= sysfs_create_group(&spi
->dev
.kobj
, &ads784x_attr_group
);
1454 goto err_remove_hwmon
;
1456 err
= input_register_device(input_dev
);
1458 goto err_remove_attr_group
;
1460 device_init_wakeup(&spi
->dev
, pdata
->wakeup
);
1463 * If device does not carry platform data we must have allocated it
1464 * when parsing DT data.
1466 if (!dev_get_platdata(&spi
->dev
))
1467 devm_kfree(&spi
->dev
, (void *)pdata
);
1471 err_remove_attr_group
:
1472 sysfs_remove_group(&spi
->dev
.kobj
, &ads784x_attr_group
);
1474 ads784x_hwmon_unregister(spi
, ts
);
1476 free_irq(spi
->irq
, ts
);
1477 err_disable_regulator
:
1478 regulator_disable(ts
->reg
);
1480 regulator_put(ts
->reg
);
1482 if (!ts
->get_pendown_state
)
1483 gpio_free(ts
->gpio_pendown
);
1485 if (ts
->filter_cleanup
)
1486 ts
->filter_cleanup(ts
->filter_data
);
1488 input_free_device(input_dev
);
1494 static int ads7846_remove(struct spi_device
*spi
)
1496 struct ads7846
*ts
= spi_get_drvdata(spi
);
1498 device_init_wakeup(&spi
->dev
, false);
1500 sysfs_remove_group(&spi
->dev
.kobj
, &ads784x_attr_group
);
1502 ads7846_disable(ts
);
1503 free_irq(ts
->spi
->irq
, ts
);
1505 input_unregister_device(ts
->input
);
1507 ads784x_hwmon_unregister(spi
, ts
);
1509 regulator_disable(ts
->reg
);
1510 regulator_put(ts
->reg
);
1512 if (!ts
->get_pendown_state
) {
1514 * If we are not using specialized pendown method we must
1515 * have been relying on gpio we set up ourselves.
1517 gpio_free(ts
->gpio_pendown
);
1520 if (ts
->filter_cleanup
)
1521 ts
->filter_cleanup(ts
->filter_data
);
1526 dev_dbg(&spi
->dev
, "unregistered touchscreen\n");
1531 static struct spi_driver ads7846_driver
= {
1534 .owner
= THIS_MODULE
,
1536 .of_match_table
= of_match_ptr(ads7846_dt_ids
),
1538 .probe
= ads7846_probe
,
1539 .remove
= ads7846_remove
,
1542 module_spi_driver(ads7846_driver
);
1544 MODULE_DESCRIPTION("ADS7846 TouchScreen Driver");
1545 MODULE_LICENSE("GPL");
1546 MODULE_ALIAS("spi:ads7846");