1 // SPDX-License-Identifier: GPL-2.0-only
3 * ADS7846 based touchscreen and sensor driver
5 * Copyright (c) 2005 David Brownell
6 * Copyright (c) 2006 Nokia Corporation
7 * Various changes: Imre Deak <imre.deak@nokia.com>
11 * Copyright (C) 2004-2005 Richard Purdie
12 * - omap_ts.[hc], ads7846.h, ts_osk.c
13 * Copyright (C) 2002 MontaVista Software
14 * Copyright (C) 2004 Texas Instruments
15 * Copyright (C) 2005 Dirk Behme
17 #include <linux/types.h>
18 #include <linux/hwmon.h>
19 #include <linux/err.h>
20 #include <linux/sched.h>
21 #include <linux/delay.h>
22 #include <linux/input.h>
23 #include <linux/input/touchscreen.h>
24 #include <linux/interrupt.h>
25 #include <linux/slab.h>
27 #include <linux/property.h>
28 #include <linux/gpio/consumer.h>
29 #include <linux/spi/spi.h>
30 #include <linux/spi/ads7846.h>
31 #include <linux/regulator/consumer.h>
32 #include <linux/module.h>
33 #include <asm/unaligned.h>
36 * This code has been heavily tested on a Nokia 770, and lightly
37 * tested on other ads7846 devices (OSK/Mistral, Lubbock, Spitz).
38 * TSC2046 is just newer ads7846 silicon.
39 * Support for ads7843 tested on Atmel at91sam926x-EK.
40 * Support for ads7845 has only been stubbed in.
41 * Support for Analog Devices AD7873 and AD7843 tested.
43 * IRQ handling needs a workaround because of a shortcoming in handling
44 * edge triggered IRQs on some platforms like the OMAP1/2. These
45 * platforms don't handle the ARM lazy IRQ disabling properly, thus we
46 * have to maintain our own SW IRQ disabled status. This should be
47 * removed as soon as the affected platform's IRQ handling is fixed.
49 * App note sbaa036 talks in more detail about accurate sampling...
50 * that ought to help in situations like LCDs inducing noise (which
51 * can also be helped by using synch signals) and more generally.
52 * This driver tries to utilize the measures described in the app
53 * note. The strength of filtering can be set in the board-* specific
57 #define TS_POLL_DELAY 1 /* ms delay before the first sample */
58 #define TS_POLL_PERIOD 5 /* ms delay between samples */
60 /* this driver doesn't aim at the peak continuous sample rate */
61 #define SAMPLE_BITS (8 /*cmd*/ + 16 /*sample*/ + 2 /* before, after */)
68 struct ads7846_buf_layout {
75 * We allocate this separately to avoid cache line sharing issues when
76 * driver is used with DMA-based SPI controllers (like atmel_spi) on
77 * systems where main memory is not DMA-coherent (most non-x86 boards).
79 struct ads7846_packet {
81 unsigned int count_skip;
83 unsigned int last_cmd_idx;
84 struct ads7846_buf_layout l[5];
85 struct ads7846_buf *rx;
86 struct ads7846_buf *tx;
88 struct ads7846_buf pwrdown_cmd;
95 struct input_dev *input;
99 struct spi_device *spi;
100 struct regulator *reg;
104 u16 vref_delay_usecs;
111 struct ads7846_packet *packet;
113 struct spi_transfer xfer[18];
114 struct spi_message msg[5];
116 wait_queue_head_t wait;
128 u16 penirq_recheck_delay_usecs;
130 struct touchscreen_properties core_prop;
133 bool stopped; /* P: lock */
134 bool disabled; /* P: lock */
135 bool suspended; /* P: lock */
137 int (*filter)(void *data, int data_idx, int *val);
139 int (*get_pendown_state)(void);
140 struct gpio_desc *gpio_pendown;
142 void (*wait_for_sync)(void);
145 enum ads7846_filter {
147 ADS7846_FILTER_REPEAT,
148 ADS7846_FILTER_IGNORE,
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))
191 #define READ_X(vref) (READ_12BIT_DFR(x, 1, vref))
192 #define PWRDOWN (READ_12BIT_DFR(y, 0, 0)) /* LAST */
194 /* single-ended samples need to first power up reference voltage;
195 * we leave both ADC and VREF powered
197 #define READ_12BIT_SER(x) (ADS_START | ADS_A2A1A0_ ## x \
198 | ADS_12_BIT | ADS_SER)
200 #define REF_ON (READ_12BIT_DFR(x, 1, 1))
201 #define REF_OFF (READ_12BIT_DFR(y, 0, 0))
203 /* Order commands in the most optimal way to reduce Vref switching and
205 * Measure: X; Vref: X+, X-; IN: Y+
206 * Measure: Y; Vref: Y+, Y-; IN: X+
207 * Measure: Z1; Vref: Y+, X-; IN: X+
208 * Measure: Z2; Vref: Y+, X-; IN: Y-
218 static int get_pendown_state(struct ads7846 *ts)
220 if (ts->get_pendown_state)
221 return ts->get_pendown_state();
223 return gpiod_get_value(ts->gpio_pendown);
226 static void ads7846_report_pen_up(struct ads7846 *ts)
228 struct input_dev *input = ts->input;
230 input_report_key(input, BTN_TOUCH, 0);
231 input_report_abs(input, ABS_PRESSURE, 0);
235 dev_vdbg(&ts->spi->dev, "UP\n");
238 /* Must be called with ts->lock held */
239 static void ads7846_stop(struct ads7846 *ts)
241 if (!ts->disabled && !ts->suspended) {
242 /* Signal IRQ thread to stop polling and disable the handler. */
246 disable_irq(ts->spi->irq);
250 /* Must be called with ts->lock held */
251 static void ads7846_restart(struct ads7846 *ts)
253 if (!ts->disabled && !ts->suspended) {
254 /* Check if pen was released since last stop */
255 if (ts->pendown && !get_pendown_state(ts))
256 ads7846_report_pen_up(ts);
258 /* Tell IRQ thread that it may poll the device. */
261 enable_irq(ts->spi->irq);
265 /* Must be called with ts->lock held */
266 static void __ads7846_disable(struct ads7846 *ts)
269 regulator_disable(ts->reg);
272 * We know the chip's in low power mode since we always
273 * leave it that way after every request
277 /* Must be called with ts->lock held */
278 static void __ads7846_enable(struct ads7846 *ts)
282 error = regulator_enable(ts->reg);
284 dev_err(&ts->spi->dev, "Failed to enable supply: %d\n", error);
289 static void ads7846_disable(struct ads7846 *ts)
291 mutex_lock(&ts->lock);
296 __ads7846_disable(ts);
301 mutex_unlock(&ts->lock);
304 static void ads7846_enable(struct ads7846 *ts)
306 mutex_lock(&ts->lock);
310 ts->disabled = false;
313 __ads7846_enable(ts);
316 mutex_unlock(&ts->lock);
319 /*--------------------------------------------------------------------------*/
322 * Non-touchscreen sensors only use single-ended conversions.
323 * The range is GND..vREF. The ads7843 and ads7835 must use external vREF;
324 * ads7846 lets that pin be unconnected, to use internal vREF.
332 struct spi_message msg;
333 struct spi_transfer xfer[6];
335 * DMA (thus cache coherency maintenance) requires the
336 * transfer buffers to live in their own cache lines.
338 __be16 sample ____cacheline_aligned;
341 struct ads7845_ser_req {
343 struct spi_message msg;
344 struct spi_transfer xfer[2];
346 * DMA (thus cache coherency maintenance) requires the
347 * transfer buffers to live in their own cache lines.
349 u8 sample[3] ____cacheline_aligned;
352 static int ads7846_read12_ser(struct device *dev, unsigned command)
354 struct spi_device *spi = to_spi_device(dev);
355 struct ads7846 *ts = dev_get_drvdata(dev);
359 req = kzalloc(sizeof *req, GFP_KERNEL);
363 spi_message_init(&req->msg);
365 /* maybe turn on internal vREF, and let it settle */
366 if (ts->use_internal) {
367 req->ref_on = REF_ON;
368 req->xfer[0].tx_buf = &req->ref_on;
369 req->xfer[0].len = 1;
370 spi_message_add_tail(&req->xfer[0], &req->msg);
372 req->xfer[1].rx_buf = &req->scratch;
373 req->xfer[1].len = 2;
375 /* for 1uF, settle for 800 usec; no cap, 100 usec. */
376 req->xfer[1].delay.value = ts->vref_delay_usecs;
377 req->xfer[1].delay.unit = SPI_DELAY_UNIT_USECS;
378 spi_message_add_tail(&req->xfer[1], &req->msg);
380 /* Enable reference voltage */
381 command |= ADS_PD10_REF_ON;
384 /* Enable ADC in every case */
385 command |= ADS_PD10_ADC_ON;
388 req->command = (u8) command;
389 req->xfer[2].tx_buf = &req->command;
390 req->xfer[2].len = 1;
391 spi_message_add_tail(&req->xfer[2], &req->msg);
393 req->xfer[3].rx_buf = &req->sample;
394 req->xfer[3].len = 2;
395 spi_message_add_tail(&req->xfer[3], &req->msg);
397 /* REVISIT: take a few more samples, and compare ... */
399 /* converter in low power mode & enable PENIRQ */
400 req->ref_off = PWRDOWN;
401 req->xfer[4].tx_buf = &req->ref_off;
402 req->xfer[4].len = 1;
403 spi_message_add_tail(&req->xfer[4], &req->msg);
405 req->xfer[5].rx_buf = &req->scratch;
406 req->xfer[5].len = 2;
407 CS_CHANGE(req->xfer[5]);
408 spi_message_add_tail(&req->xfer[5], &req->msg);
410 mutex_lock(&ts->lock);
412 status = spi_sync(spi, &req->msg);
414 mutex_unlock(&ts->lock);
417 /* on-wire is a must-ignore bit, a BE12 value, then padding */
418 status = be16_to_cpu(req->sample);
419 status = status >> 3;
427 static int ads7845_read12_ser(struct device *dev, unsigned command)
429 struct spi_device *spi = to_spi_device(dev);
430 struct ads7846 *ts = dev_get_drvdata(dev);
431 struct ads7845_ser_req *req;
434 req = kzalloc(sizeof *req, GFP_KERNEL);
438 spi_message_init(&req->msg);
440 req->command[0] = (u8) command;
441 req->xfer[0].tx_buf = req->command;
442 req->xfer[0].rx_buf = req->sample;
443 req->xfer[0].len = 3;
444 spi_message_add_tail(&req->xfer[0], &req->msg);
446 mutex_lock(&ts->lock);
448 status = spi_sync(spi, &req->msg);
450 mutex_unlock(&ts->lock);
453 /* BE12 value, then padding */
454 status = get_unaligned_be16(&req->sample[1]);
455 status = status >> 3;
463 #if IS_ENABLED(CONFIG_HWMON)
465 #define SHOW(name, var, adjust) static ssize_t \
466 name ## _show(struct device *dev, struct device_attribute *attr, char *buf) \
468 struct ads7846 *ts = dev_get_drvdata(dev); \
469 ssize_t v = ads7846_read12_ser(&ts->spi->dev, \
470 READ_12BIT_SER(var)); \
473 return sprintf(buf, "%u\n", adjust(ts, v)); \
475 static DEVICE_ATTR(name, S_IRUGO, name ## _show, NULL);
478 /* Sysfs conventions report temperatures in millidegrees Celsius.
479 * ADS7846 could use the low-accuracy two-sample scheme, but can't do the high
480 * accuracy scheme without calibration data. For now we won't try either;
481 * userspace sees raw sensor values, and must scale/calibrate appropriately.
483 static inline unsigned null_adjust(struct ads7846 *ts, ssize_t v)
488 SHOW(temp0, temp0, null_adjust) /* temp1_input */
489 SHOW(temp1, temp1, null_adjust) /* temp2_input */
492 /* sysfs conventions report voltages in millivolts. We can convert voltages
493 * if we know vREF. userspace may need to scale vAUX to match the board's
494 * external resistors; we assume that vBATT only uses the internal ones.
496 static inline unsigned vaux_adjust(struct ads7846 *ts, ssize_t v)
500 /* external resistors may scale vAUX into 0..vREF */
501 retval *= ts->vref_mv;
502 retval = retval >> 12;
507 static inline unsigned vbatt_adjust(struct ads7846 *ts, ssize_t v)
509 unsigned retval = vaux_adjust(ts, v);
511 /* ads7846 has a resistor ladder to scale this signal down */
512 if (ts->model == 7846)
518 SHOW(in0_input, vaux, vaux_adjust)
519 SHOW(in1_input, vbatt, vbatt_adjust)
521 static umode_t ads7846_is_visible(struct kobject *kobj, struct attribute *attr,
524 struct device *dev = kobj_to_dev(kobj);
525 struct ads7846 *ts = dev_get_drvdata(dev);
527 if (ts->model == 7843 && index < 2) /* in0, in1 */
529 if (ts->model == 7845 && index != 2) /* in0 */
535 static struct attribute *ads7846_attributes[] = {
536 &dev_attr_temp0.attr, /* 0 */
537 &dev_attr_temp1.attr, /* 1 */
538 &dev_attr_in0_input.attr, /* 2 */
539 &dev_attr_in1_input.attr, /* 3 */
543 static const struct attribute_group ads7846_attr_group = {
544 .attrs = ads7846_attributes,
545 .is_visible = ads7846_is_visible,
547 __ATTRIBUTE_GROUPS(ads7846_attr);
549 static int ads784x_hwmon_register(struct spi_device *spi, struct ads7846 *ts)
551 struct device *hwmon;
553 /* hwmon sensors need a reference voltage */
557 dev_dbg(&spi->dev, "assuming 2.5V internal vREF\n");
559 ts->use_internal = true;
566 "external vREF for ADS%d not specified\n",
573 hwmon = devm_hwmon_device_register_with_groups(&spi->dev,
575 ads7846_attr_groups);
577 return PTR_ERR_OR_ZERO(hwmon);
581 static inline int ads784x_hwmon_register(struct spi_device *spi,
588 static ssize_t ads7846_pen_down_show(struct device *dev,
589 struct device_attribute *attr, char *buf)
591 struct ads7846 *ts = dev_get_drvdata(dev);
593 return sprintf(buf, "%u\n", ts->pendown);
596 static DEVICE_ATTR(pen_down, S_IRUGO, ads7846_pen_down_show, NULL);
598 static ssize_t ads7846_disable_show(struct device *dev,
599 struct device_attribute *attr, char *buf)
601 struct ads7846 *ts = dev_get_drvdata(dev);
603 return sprintf(buf, "%u\n", ts->disabled);
606 static ssize_t ads7846_disable_store(struct device *dev,
607 struct device_attribute *attr,
608 const char *buf, size_t count)
610 struct ads7846 *ts = dev_get_drvdata(dev);
614 err = kstrtouint(buf, 10, &i);
626 static DEVICE_ATTR(disable, 0664, ads7846_disable_show, ads7846_disable_store);
628 static struct attribute *ads784x_attrs[] = {
629 &dev_attr_pen_down.attr,
630 &dev_attr_disable.attr,
633 ATTRIBUTE_GROUPS(ads784x);
635 /*--------------------------------------------------------------------------*/
637 static void null_wait_for_sync(void)
641 static int ads7846_debounce_filter(void *ads, int data_idx, int *val)
643 struct ads7846 *ts = ads;
645 if (!ts->read_cnt || (abs(ts->last_read - *val) > ts->debounce_tol)) {
646 /* Start over collecting consistent readings. */
649 * Repeat it, if this was the first read or the read
650 * wasn't consistent enough.
652 if (ts->read_cnt < ts->debounce_max) {
653 ts->last_read = *val;
655 return ADS7846_FILTER_REPEAT;
658 * Maximum number of debouncing reached and still
659 * not enough number of consistent readings. Abort
660 * the whole sample, repeat it in the next sampling
664 return ADS7846_FILTER_IGNORE;
667 if (++ts->read_rep > ts->debounce_rep) {
669 * Got a good reading for this coordinate,
670 * go for the next one.
674 return ADS7846_FILTER_OK;
676 /* Read more values that are consistent. */
678 return ADS7846_FILTER_REPEAT;
683 static int ads7846_no_filter(void *ads, int data_idx, int *val)
685 return ADS7846_FILTER_OK;
688 static int ads7846_get_value(struct ads7846_buf *buf)
692 value = be16_to_cpup(&buf->data);
694 /* enforce ADC output is 12 bits width */
695 return (value >> 3) & 0xfff;
698 static void ads7846_set_cmd_val(struct ads7846 *ts, enum ads7846_cmds cmd_idx,
701 struct ads7846_packet *packet = ts->packet;
721 static u8 ads7846_get_cmd(enum ads7846_cmds cmd_idx, int vref)
729 /* 7846 specific commands */
731 return READ_Z1(vref);
733 return READ_Z2(vref);
743 static bool ads7846_cmd_need_settle(enum ads7846_cmds cmd_idx)
760 static int ads7846_filter(struct ads7846 *ts)
762 struct ads7846_packet *packet = ts->packet;
765 unsigned int cmd_idx, b;
767 packet->ignore = false;
768 for (cmd_idx = packet->last_cmd_idx; cmd_idx < packet->cmds - 1; cmd_idx++) {
769 struct ads7846_buf_layout *l = &packet->l[cmd_idx];
771 packet->last_cmd_idx = cmd_idx;
773 for (b = l->skip; b < l->count; b++) {
774 val = ads7846_get_value(&packet->rx[l->offset + b]);
776 action = ts->filter(ts->filter_data, cmd_idx, &val);
777 if (action == ADS7846_FILTER_REPEAT) {
778 if (b == l->count - 1)
780 } else if (action == ADS7846_FILTER_OK) {
781 ads7846_set_cmd_val(ts, cmd_idx, val);
784 packet->ignore = true;
793 static void ads7846_read_state(struct ads7846 *ts)
795 struct ads7846_packet *packet = ts->packet;
796 struct spi_message *m;
800 packet->last_cmd_idx = 0;
805 m = &ts->msg[msg_idx];
806 error = spi_sync(ts->spi, m);
808 dev_err(&ts->spi->dev, "spi_sync --> %d\n", error);
809 packet->ignore = true;
813 error = ads7846_filter(ts);
821 static void ads7846_report_state(struct ads7846 *ts)
823 struct ads7846_packet *packet = ts->packet;
829 if (ts->model == 7845) {
837 /* range filtering */
841 if (ts->model == 7843 || ts->model == 7845) {
842 Rt = ts->pressure_max / 2;
843 } else if (likely(x && z1)) {
844 /* compute touch pressure resistance using equation #2 */
847 Rt *= ts->x_plate_ohms;
848 Rt = DIV_ROUND_CLOSEST(Rt, 16);
851 Rt = DIV_ROUND_CLOSEST(Rt, 256);
857 * Sample found inconsistent by debouncing or pressure is beyond
858 * the maximum. Don't report it to user space, repeat at least
859 * once more the measurement
861 if (packet->ignore || Rt > ts->pressure_max) {
862 dev_vdbg(&ts->spi->dev, "ignored %d pressure %d\n",
868 * Maybe check the pendown state before reporting. This discards
869 * false readings when the pen is lifted.
871 if (ts->penirq_recheck_delay_usecs) {
872 udelay(ts->penirq_recheck_delay_usecs);
873 if (!get_pendown_state(ts))
878 * NOTE: We can't rely on the pressure to determine the pen down
879 * state, even this controller has a pressure sensor. The pressure
880 * value can fluctuate for quite a while after lifting the pen and
881 * in some cases may not even settle at the expected value.
883 * The only safe way to check for the pen up condition is in the
884 * timer by reading the pen signal state (it's a GPIO _and_ IRQ).
887 struct input_dev *input = ts->input;
890 input_report_key(input, BTN_TOUCH, 1);
892 dev_vdbg(&ts->spi->dev, "DOWN\n");
895 touchscreen_report_pos(input, &ts->core_prop, x, y, false);
896 input_report_abs(input, ABS_PRESSURE, ts->pressure_max - Rt);
899 dev_vdbg(&ts->spi->dev, "%4d/%4d/%4d\n", x, y, Rt);
903 static irqreturn_t ads7846_hard_irq(int irq, void *handle)
905 struct ads7846 *ts = handle;
907 return get_pendown_state(ts) ? IRQ_WAKE_THREAD : IRQ_HANDLED;
911 static irqreturn_t ads7846_irq(int irq, void *handle)
913 struct ads7846 *ts = handle;
915 /* Start with a small delay before checking pendown state */
916 msleep(TS_POLL_DELAY);
918 while (!ts->stopped && get_pendown_state(ts)) {
920 /* pen is down, continue with the measurement */
921 ads7846_read_state(ts);
924 ads7846_report_state(ts);
926 wait_event_timeout(ts->wait, ts->stopped,
927 msecs_to_jiffies(TS_POLL_PERIOD));
930 if (ts->pendown && !ts->stopped)
931 ads7846_report_pen_up(ts);
936 static int ads7846_suspend(struct device *dev)
938 struct ads7846 *ts = dev_get_drvdata(dev);
940 mutex_lock(&ts->lock);
942 if (!ts->suspended) {
945 __ads7846_disable(ts);
947 if (device_may_wakeup(&ts->spi->dev))
948 enable_irq_wake(ts->spi->irq);
950 ts->suspended = true;
953 mutex_unlock(&ts->lock);
958 static int ads7846_resume(struct device *dev)
960 struct ads7846 *ts = dev_get_drvdata(dev);
962 mutex_lock(&ts->lock);
966 ts->suspended = false;
968 if (device_may_wakeup(&ts->spi->dev))
969 disable_irq_wake(ts->spi->irq);
972 __ads7846_enable(ts);
975 mutex_unlock(&ts->lock);
980 static DEFINE_SIMPLE_DEV_PM_OPS(ads7846_pm, ads7846_suspend, ads7846_resume);
982 static int ads7846_setup_pendown(struct spi_device *spi,
984 const struct ads7846_platform_data *pdata)
987 * REVISIT when the irq can be triggered active-low, or if for some
988 * reason the touchscreen isn't hooked up, we don't need to access
992 if (pdata->get_pendown_state) {
993 ts->get_pendown_state = pdata->get_pendown_state;
995 ts->gpio_pendown = gpiod_get(&spi->dev, "pendown", GPIOD_IN);
996 if (IS_ERR(ts->gpio_pendown)) {
997 dev_err(&spi->dev, "failed to request pendown GPIO\n");
998 return PTR_ERR(ts->gpio_pendown);
1000 if (pdata->gpio_pendown_debounce)
1001 gpiod_set_debounce(ts->gpio_pendown,
1002 pdata->gpio_pendown_debounce);
1009 * Set up the transfers to read touchscreen state; this assumes we
1010 * use formula #2 for pressure, not #3.
1012 static int 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;
1019 unsigned int count, offset = 0;
1020 unsigned int cmd_idx, b;
1025 time = NSEC_PER_SEC / ts->spi->max_speed_hz;
1027 count = pdata->settle_delay_usecs * NSEC_PER_USEC / time;
1028 packet->count_skip = DIV_ROUND_UP(count, 24);
1030 if (ts->debounce_max && ts->debounce_rep)
1031 /* ads7846_debounce_filter() is making ts->debounce_rep + 2
1032 * reads. So we need to get all samples for normal case. */
1033 packet->count = ts->debounce_rep + 2;
1037 if (ts->model == 7846)
1038 packet->cmds = 5; /* x, y, z1, z2, pwdown */
1040 packet->cmds = 3; /* x, y, pwdown */
1042 for (cmd_idx = 0; cmd_idx < packet->cmds; cmd_idx++) {
1043 struct ads7846_buf_layout *l = &packet->l[cmd_idx];
1044 unsigned int max_count;
1046 if (cmd_idx == packet->cmds - 1)
1047 cmd_idx = ADS7846_PWDOWN;
1049 if (ads7846_cmd_need_settle(cmd_idx))
1050 max_count = packet->count + packet->count_skip;
1052 max_count = packet->count;
1055 offset += max_count;
1056 l->count = max_count;
1057 l->skip = packet->count_skip;
1058 size += sizeof(*packet->tx) * max_count;
1061 packet->tx = devm_kzalloc(&ts->spi->dev, size, GFP_KERNEL);
1065 packet->rx = devm_kzalloc(&ts->spi->dev, size, GFP_KERNEL);
1069 if (ts->model == 7873) {
1071 * The AD7873 is almost identical to the ADS7846
1072 * keep VREF off during differential/ratiometric
1080 spi_message_init(m);
1083 for (cmd_idx = 0; cmd_idx < packet->cmds; cmd_idx++) {
1084 struct ads7846_buf_layout *l = &packet->l[cmd_idx];
1087 if (cmd_idx == packet->cmds - 1)
1088 cmd_idx = ADS7846_PWDOWN;
1090 cmd = ads7846_get_cmd(cmd_idx, vref);
1092 for (b = 0; b < l->count; b++)
1093 packet->tx[l->offset + b].cmd = cmd;
1096 x->tx_buf = packet->tx;
1097 x->rx_buf = packet->rx;
1099 spi_message_add_tail(x, m);
1104 static const struct of_device_id ads7846_dt_ids[] = {
1105 { .compatible = "ti,tsc2046", .data = (void *) 7846 },
1106 { .compatible = "ti,ads7843", .data = (void *) 7843 },
1107 { .compatible = "ti,ads7845", .data = (void *) 7845 },
1108 { .compatible = "ti,ads7846", .data = (void *) 7846 },
1109 { .compatible = "ti,ads7873", .data = (void *) 7873 },
1112 MODULE_DEVICE_TABLE(of, ads7846_dt_ids);
1114 static const struct ads7846_platform_data *ads7846_get_props(struct device *dev)
1116 struct ads7846_platform_data *pdata;
1119 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
1121 return ERR_PTR(-ENOMEM);
1123 pdata->model = (uintptr_t)device_get_match_data(dev);
1125 device_property_read_u16(dev, "ti,vref-delay-usecs",
1126 &pdata->vref_delay_usecs);
1127 device_property_read_u16(dev, "ti,vref-mv", &pdata->vref_mv);
1128 pdata->keep_vref_on = device_property_read_bool(dev, "ti,keep-vref-on");
1130 pdata->swap_xy = device_property_read_bool(dev, "ti,swap-xy");
1132 device_property_read_u16(dev, "ti,settle-delay-usec",
1133 &pdata->settle_delay_usecs);
1134 device_property_read_u16(dev, "ti,penirq-recheck-delay-usecs",
1135 &pdata->penirq_recheck_delay_usecs);
1137 device_property_read_u16(dev, "ti,x-plate-ohms", &pdata->x_plate_ohms);
1138 device_property_read_u16(dev, "ti,y-plate-ohms", &pdata->y_plate_ohms);
1140 device_property_read_u16(dev, "ti,x-min", &pdata->x_min);
1141 device_property_read_u16(dev, "ti,y-min", &pdata->y_min);
1142 device_property_read_u16(dev, "ti,x-max", &pdata->x_max);
1143 device_property_read_u16(dev, "ti,y-max", &pdata->y_max);
1146 * touchscreen-max-pressure gets parsed during
1147 * touchscreen_parse_properties()
1149 device_property_read_u16(dev, "ti,pressure-min", &pdata->pressure_min);
1150 if (!device_property_read_u32(dev, "touchscreen-min-pressure", &value))
1151 pdata->pressure_min = (u16) value;
1152 device_property_read_u16(dev, "ti,pressure-max", &pdata->pressure_max);
1154 device_property_read_u16(dev, "ti,debounce-max", &pdata->debounce_max);
1155 if (!device_property_read_u32(dev, "touchscreen-average-samples", &value))
1156 pdata->debounce_max = (u16) value;
1157 device_property_read_u16(dev, "ti,debounce-tol", &pdata->debounce_tol);
1158 device_property_read_u16(dev, "ti,debounce-rep", &pdata->debounce_rep);
1160 device_property_read_u32(dev, "ti,pendown-gpio-debounce",
1161 &pdata->gpio_pendown_debounce);
1163 pdata->wakeup = device_property_read_bool(dev, "wakeup-source") ||
1164 device_property_read_bool(dev, "linux,wakeup");
1169 static void ads7846_regulator_disable(void *regulator)
1171 regulator_disable(regulator);
1174 static int ads7846_probe(struct spi_device *spi)
1176 const struct ads7846_platform_data *pdata;
1178 struct device *dev = &spi->dev;
1179 struct ads7846_packet *packet;
1180 struct input_dev *input_dev;
1181 unsigned long irq_flags;
1185 dev_dbg(dev, "no IRQ?\n");
1189 /* don't exceed max specified sample rate */
1190 if (spi->max_speed_hz > (125000 * SAMPLE_BITS)) {
1191 dev_err(dev, "f(sample) %d KHz?\n",
1192 (spi->max_speed_hz/SAMPLE_BITS)/1000);
1197 * We'd set TX word size 8 bits and RX word size to 13 bits ... except
1198 * that even if the hardware can do that, the SPI controller driver
1199 * may not. So we stick to very-portable 8 bit words, both RX and TX.
1201 spi->bits_per_word = 8;
1202 spi->mode &= ~SPI_MODE_X_MASK;
1203 spi->mode |= SPI_MODE_0;
1204 err = spi_setup(spi);
1208 ts = devm_kzalloc(dev, sizeof(struct ads7846), GFP_KERNEL);
1212 packet = devm_kzalloc(dev, sizeof(struct ads7846_packet), GFP_KERNEL);
1216 input_dev = devm_input_allocate_device(dev);
1220 spi_set_drvdata(spi, ts);
1222 ts->packet = packet;
1224 ts->input = input_dev;
1226 mutex_init(&ts->lock);
1227 init_waitqueue_head(&ts->wait);
1229 pdata = dev_get_platdata(dev);
1231 pdata = ads7846_get_props(dev);
1233 return PTR_ERR(pdata);
1236 ts->model = pdata->model ? : 7846;
1237 ts->vref_delay_usecs = pdata->vref_delay_usecs ? : 100;
1238 ts->x_plate_ohms = pdata->x_plate_ohms ? : 400;
1239 ts->vref_mv = pdata->vref_mv;
1241 if (pdata->debounce_max) {
1242 ts->debounce_max = pdata->debounce_max;
1243 if (ts->debounce_max < 2)
1244 ts->debounce_max = 2;
1245 ts->debounce_tol = pdata->debounce_tol;
1246 ts->debounce_rep = pdata->debounce_rep;
1247 ts->filter = ads7846_debounce_filter;
1248 ts->filter_data = ts;
1250 ts->filter = ads7846_no_filter;
1253 err = ads7846_setup_pendown(spi, ts, pdata);
1257 if (pdata->penirq_recheck_delay_usecs)
1258 ts->penirq_recheck_delay_usecs =
1259 pdata->penirq_recheck_delay_usecs;
1261 ts->wait_for_sync = pdata->wait_for_sync ? : null_wait_for_sync;
1263 snprintf(ts->phys, sizeof(ts->phys), "%s/input0", dev_name(dev));
1264 snprintf(ts->name, sizeof(ts->name), "ADS%d Touchscreen", ts->model);
1266 input_dev->name = ts->name;
1267 input_dev->phys = ts->phys;
1269 input_dev->id.bustype = BUS_SPI;
1270 input_dev->id.product = pdata->model;
1272 input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
1273 input_set_abs_params(input_dev, ABS_X,
1275 pdata->x_max ? : MAX_12BIT,
1277 input_set_abs_params(input_dev, ABS_Y,
1279 pdata->y_max ? : MAX_12BIT,
1281 if (ts->model != 7845)
1282 input_set_abs_params(input_dev, ABS_PRESSURE,
1283 pdata->pressure_min, pdata->pressure_max, 0, 0);
1286 * Parse common framework properties. Must be done here to ensure the
1287 * correct behaviour in case of using the legacy vendor bindings. The
1288 * general binding value overrides the vendor specific one.
1290 touchscreen_parse_properties(ts->input, false, &ts->core_prop);
1291 ts->pressure_max = input_abs_get_max(input_dev, ABS_PRESSURE) ? : ~0;
1294 * Check if legacy ti,swap-xy binding is used instead of
1295 * touchscreen-swapped-x-y
1297 if (!ts->core_prop.swap_x_y && pdata->swap_xy) {
1298 swap(input_dev->absinfo[ABS_X], input_dev->absinfo[ABS_Y]);
1299 ts->core_prop.swap_x_y = true;
1302 ads7846_setup_spi_msg(ts, pdata);
1304 ts->reg = devm_regulator_get(dev, "vcc");
1305 if (IS_ERR(ts->reg)) {
1306 err = PTR_ERR(ts->reg);
1307 dev_err(dev, "unable to get regulator: %d\n", err);
1311 err = regulator_enable(ts->reg);
1313 dev_err(dev, "unable to enable regulator: %d\n", err);
1317 err = devm_add_action_or_reset(dev, ads7846_regulator_disable, ts->reg);
1321 irq_flags = pdata->irq_flags ? : IRQF_TRIGGER_FALLING;
1322 irq_flags |= IRQF_ONESHOT;
1324 err = devm_request_threaded_irq(dev, spi->irq,
1325 ads7846_hard_irq, ads7846_irq,
1326 irq_flags, dev->driver->name, ts);
1327 if (err && err != -EPROBE_DEFER && !pdata->irq_flags) {
1329 "trying pin change workaround on irq %d\n", spi->irq);
1330 irq_flags |= IRQF_TRIGGER_RISING;
1331 err = devm_request_threaded_irq(dev, spi->irq,
1332 ads7846_hard_irq, ads7846_irq,
1333 irq_flags, dev->driver->name,
1338 dev_dbg(dev, "irq %d busy?\n", spi->irq);
1342 err = ads784x_hwmon_register(spi, ts);
1346 dev_info(dev, "touchscreen, irq %d\n", spi->irq);
1349 * Take a first sample, leaving nPENIRQ active and vREF off; avoid
1350 * the touchscreen, in case it's not connected.
1352 if (ts->model == 7845)
1353 ads7845_read12_ser(dev, PWRDOWN);
1355 (void) ads7846_read12_ser(dev, READ_12BIT_SER(vaux));
1357 err = input_register_device(input_dev);
1361 device_init_wakeup(dev, pdata->wakeup);
1364 * If device does not carry platform data we must have allocated it
1365 * when parsing DT data.
1367 if (!dev_get_platdata(dev))
1368 devm_kfree(dev, (void *)pdata);
1373 static void ads7846_remove(struct spi_device *spi)
1375 struct ads7846 *ts = spi_get_drvdata(spi);
1380 static struct spi_driver ads7846_driver = {
1383 .dev_groups = ads784x_groups,
1384 .pm = pm_sleep_ptr(&ads7846_pm),
1385 .of_match_table = ads7846_dt_ids,
1387 .probe = ads7846_probe,
1388 .remove = ads7846_remove,
1391 module_spi_driver(ads7846_driver);
1393 MODULE_DESCRIPTION("ADS7846 TouchScreen Driver");
1394 MODULE_LICENSE("GPL");
1395 MODULE_ALIAS("spi:ads7846");