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>
28 #include <linux/of_gpio.h>
29 #include <linux/of_device.h>
30 #include <linux/gpio.h>
31 #include <linux/spi/spi.h>
32 #include <linux/spi/ads7846.h>
33 #include <linux/regulator/consumer.h>
34 #include <linux/module.h>
35 #include <asm/unaligned.h>
38 * This code has been heavily tested on a Nokia 770, and lightly
39 * tested on other ads7846 devices (OSK/Mistral, Lubbock, Spitz).
40 * TSC2046 is just newer ads7846 silicon.
41 * Support for ads7843 tested on Atmel at91sam926x-EK.
42 * Support for ads7845 has only been stubbed in.
43 * Support for Analog Devices AD7873 and AD7843 tested.
45 * IRQ handling needs a workaround because of a shortcoming in handling
46 * edge triggered IRQs on some platforms like the OMAP1/2. These
47 * platforms don't handle the ARM lazy IRQ disabling properly, thus we
48 * have to maintain our own SW IRQ disabled status. This should be
49 * removed as soon as the affected platform's IRQ handling is fixed.
51 * App note sbaa036 talks in more detail about accurate sampling...
52 * that ought to help in situations like LCDs inducing noise (which
53 * can also be helped by using synch signals) and more generally.
54 * This driver tries to utilize the measures described in the app
55 * note. The strength of filtering can be set in the board-* specific
59 #define TS_POLL_DELAY 1 /* ms delay before the first sample */
60 #define TS_POLL_PERIOD 5 /* ms delay between samples */
62 /* this driver doesn't aim at the peak continuous sample rate */
63 #define SAMPLE_BITS (8 /*cmd*/ + 16 /*sample*/ + 2 /* before, after */)
70 struct ads7846_buf_layout {
77 * We allocate this separately to avoid cache line sharing issues when
78 * driver is used with DMA-based SPI controllers (like atmel_spi) on
79 * systems where main memory is not DMA-coherent (most non-x86 boards).
81 struct ads7846_packet {
83 unsigned int count_skip;
85 unsigned int last_cmd_idx;
86 struct ads7846_buf_layout l[5];
87 struct ads7846_buf *rx;
88 struct ads7846_buf *tx;
90 struct ads7846_buf pwrdown_cmd;
97 struct input_dev *input;
101 struct spi_device *spi;
102 struct regulator *reg;
104 #if IS_ENABLED(CONFIG_HWMON)
105 struct device *hwmon;
110 u16 vref_delay_usecs;
117 struct ads7846_packet *packet;
119 struct spi_transfer xfer[18];
120 struct spi_message msg[5];
122 wait_queue_head_t wait;
134 u16 penirq_recheck_delay_usecs;
136 struct touchscreen_properties core_prop;
139 bool stopped; /* P: lock */
140 bool disabled; /* P: lock */
141 bool suspended; /* P: lock */
143 int (*filter)(void *data, int data_idx, int *val);
145 void (*filter_cleanup)(void *data);
146 int (*get_pendown_state)(void);
149 void (*wait_for_sync)(void);
152 /* leave chip selected when we're done, for quicker re-select? */
154 #define CS_CHANGE(xfer) ((xfer).cs_change = 1)
156 #define CS_CHANGE(xfer) ((xfer).cs_change = 0)
159 /*--------------------------------------------------------------------------*/
161 /* The ADS7846 has touchscreen and other sensors.
162 * Earlier ads784x chips are somewhat compatible.
164 #define ADS_START (1 << 7)
165 #define ADS_A2A1A0_d_y (1 << 4) /* differential */
166 #define ADS_A2A1A0_d_z1 (3 << 4) /* differential */
167 #define ADS_A2A1A0_d_z2 (4 << 4) /* differential */
168 #define ADS_A2A1A0_d_x (5 << 4) /* differential */
169 #define ADS_A2A1A0_temp0 (0 << 4) /* non-differential */
170 #define ADS_A2A1A0_vbatt (2 << 4) /* non-differential */
171 #define ADS_A2A1A0_vaux (6 << 4) /* non-differential */
172 #define ADS_A2A1A0_temp1 (7 << 4) /* non-differential */
173 #define ADS_8_BIT (1 << 3)
174 #define ADS_12_BIT (0 << 3)
175 #define ADS_SER (1 << 2) /* non-differential */
176 #define ADS_DFR (0 << 2) /* differential */
177 #define ADS_PD10_PDOWN (0 << 0) /* low power mode + penirq */
178 #define ADS_PD10_ADC_ON (1 << 0) /* ADC on */
179 #define ADS_PD10_REF_ON (2 << 0) /* vREF on + penirq */
180 #define ADS_PD10_ALL_ON (3 << 0) /* ADC + vREF on */
182 #define MAX_12BIT ((1<<12)-1)
184 /* leave ADC powered up (disables penirq) between differential samples */
185 #define READ_12BIT_DFR(x, adc, vref) (ADS_START | ADS_A2A1A0_d_ ## x \
186 | ADS_12_BIT | ADS_DFR | \
187 (adc ? ADS_PD10_ADC_ON : 0) | (vref ? ADS_PD10_REF_ON : 0))
189 #define READ_Y(vref) (READ_12BIT_DFR(y, 1, vref))
190 #define READ_Z1(vref) (READ_12BIT_DFR(z1, 1, vref))
191 #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 /* Order commands in the most optimal way to reduce Vref switching and
206 * Measure: X; Vref: X+, X-; IN: Y+
207 * Measure: Y; Vref: Y+, Y-; IN: X+
208 * Measure: Z1; Vref: Y+, X-; IN: X+
209 * Measure: Z2; Vref: Y+, X-; IN: Y-
219 static int get_pendown_state(struct ads7846 *ts)
221 if (ts->get_pendown_state)
222 return ts->get_pendown_state();
224 return !gpio_get_value(ts->gpio_pendown);
227 static void ads7846_report_pen_up(struct ads7846 *ts)
229 struct input_dev *input = ts->input;
231 input_report_key(input, BTN_TOUCH, 0);
232 input_report_abs(input, ABS_PRESSURE, 0);
236 dev_vdbg(&ts->spi->dev, "UP\n");
239 /* Must be called with ts->lock held */
240 static void ads7846_stop(struct ads7846 *ts)
242 if (!ts->disabled && !ts->suspended) {
243 /* Signal IRQ thread to stop polling and disable the handler. */
247 disable_irq(ts->spi->irq);
251 /* Must be called with ts->lock held */
252 static void ads7846_restart(struct ads7846 *ts)
254 if (!ts->disabled && !ts->suspended) {
255 /* Check if pen was released since last stop */
256 if (ts->pendown && !get_pendown_state(ts))
257 ads7846_report_pen_up(ts);
259 /* Tell IRQ thread that it may poll the device. */
262 enable_irq(ts->spi->irq);
266 /* Must be called with ts->lock held */
267 static void __ads7846_disable(struct ads7846 *ts)
270 regulator_disable(ts->reg);
273 * We know the chip's in low power mode since we always
274 * leave it that way after every request
278 /* Must be called with ts->lock held */
279 static void __ads7846_enable(struct ads7846 *ts)
283 error = regulator_enable(ts->reg);
285 dev_err(&ts->spi->dev, "Failed to enable supply: %d\n", error);
290 static void ads7846_disable(struct ads7846 *ts)
292 mutex_lock(&ts->lock);
297 __ads7846_disable(ts);
302 mutex_unlock(&ts->lock);
305 static void ads7846_enable(struct ads7846 *ts)
307 mutex_lock(&ts->lock);
311 ts->disabled = false;
314 __ads7846_enable(ts);
317 mutex_unlock(&ts->lock);
320 /*--------------------------------------------------------------------------*/
323 * Non-touchscreen sensors only use single-ended conversions.
324 * The range is GND..vREF. The ads7843 and ads7835 must use external vREF;
325 * ads7846 lets that pin be unconnected, to use internal vREF.
333 struct spi_message msg;
334 struct spi_transfer xfer[6];
336 * DMA (thus cache coherency maintenance) requires the
337 * transfer buffers to live in their own cache lines.
339 __be16 sample ____cacheline_aligned;
342 struct ads7845_ser_req {
344 struct spi_message msg;
345 struct spi_transfer xfer[2];
347 * DMA (thus cache coherency maintenance) requires the
348 * transfer buffers to live in their own cache lines.
350 u8 sample[3] ____cacheline_aligned;
353 static int ads7846_read12_ser(struct device *dev, unsigned command)
355 struct spi_device *spi = to_spi_device(dev);
356 struct ads7846 *ts = dev_get_drvdata(dev);
360 req = kzalloc(sizeof *req, GFP_KERNEL);
364 spi_message_init(&req->msg);
366 /* maybe turn on internal vREF, and let it settle */
367 if (ts->use_internal) {
368 req->ref_on = REF_ON;
369 req->xfer[0].tx_buf = &req->ref_on;
370 req->xfer[0].len = 1;
371 spi_message_add_tail(&req->xfer[0], &req->msg);
373 req->xfer[1].rx_buf = &req->scratch;
374 req->xfer[1].len = 2;
376 /* for 1uF, settle for 800 usec; no cap, 100 usec. */
377 req->xfer[1].delay.value = ts->vref_delay_usecs;
378 req->xfer[1].delay.unit = SPI_DELAY_UNIT_USECS;
379 spi_message_add_tail(&req->xfer[1], &req->msg);
381 /* Enable reference voltage */
382 command |= ADS_PD10_REF_ON;
385 /* Enable ADC in every case */
386 command |= ADS_PD10_ADC_ON;
389 req->command = (u8) command;
390 req->xfer[2].tx_buf = &req->command;
391 req->xfer[2].len = 1;
392 spi_message_add_tail(&req->xfer[2], &req->msg);
394 req->xfer[3].rx_buf = &req->sample;
395 req->xfer[3].len = 2;
396 spi_message_add_tail(&req->xfer[3], &req->msg);
398 /* REVISIT: take a few more samples, and compare ... */
400 /* converter in low power mode & enable PENIRQ */
401 req->ref_off = PWRDOWN;
402 req->xfer[4].tx_buf = &req->ref_off;
403 req->xfer[4].len = 1;
404 spi_message_add_tail(&req->xfer[4], &req->msg);
406 req->xfer[5].rx_buf = &req->scratch;
407 req->xfer[5].len = 2;
408 CS_CHANGE(req->xfer[5]);
409 spi_message_add_tail(&req->xfer[5], &req->msg);
411 mutex_lock(&ts->lock);
413 status = spi_sync(spi, &req->msg);
415 mutex_unlock(&ts->lock);
418 /* on-wire is a must-ignore bit, a BE12 value, then padding */
419 status = be16_to_cpu(req->sample);
420 status = status >> 3;
428 static int ads7845_read12_ser(struct device *dev, unsigned command)
430 struct spi_device *spi = to_spi_device(dev);
431 struct ads7846 *ts = dev_get_drvdata(dev);
432 struct ads7845_ser_req *req;
435 req = kzalloc(sizeof *req, GFP_KERNEL);
439 spi_message_init(&req->msg);
441 req->command[0] = (u8) command;
442 req->xfer[0].tx_buf = req->command;
443 req->xfer[0].rx_buf = req->sample;
444 req->xfer[0].len = 3;
445 spi_message_add_tail(&req->xfer[0], &req->msg);
447 mutex_lock(&ts->lock);
449 status = spi_sync(spi, &req->msg);
451 mutex_unlock(&ts->lock);
454 /* BE12 value, then padding */
455 status = get_unaligned_be16(&req->sample[1]);
456 status = status >> 3;
464 #if IS_ENABLED(CONFIG_HWMON)
466 #define SHOW(name, var, adjust) static ssize_t \
467 name ## _show(struct device *dev, struct device_attribute *attr, char *buf) \
469 struct ads7846 *ts = dev_get_drvdata(dev); \
470 ssize_t v = ads7846_read12_ser(&ts->spi->dev, \
471 READ_12BIT_SER(var)); \
474 return sprintf(buf, "%u\n", adjust(ts, v)); \
476 static DEVICE_ATTR(name, S_IRUGO, name ## _show, NULL);
479 /* Sysfs conventions report temperatures in millidegrees Celsius.
480 * ADS7846 could use the low-accuracy two-sample scheme, but can't do the high
481 * accuracy scheme without calibration data. For now we won't try either;
482 * userspace sees raw sensor values, and must scale/calibrate appropriately.
484 static inline unsigned null_adjust(struct ads7846 *ts, ssize_t v)
489 SHOW(temp0, temp0, null_adjust) /* temp1_input */
490 SHOW(temp1, temp1, null_adjust) /* temp2_input */
493 /* sysfs conventions report voltages in millivolts. We can convert voltages
494 * if we know vREF. userspace may need to scale vAUX to match the board's
495 * external resistors; we assume that vBATT only uses the internal ones.
497 static inline unsigned vaux_adjust(struct ads7846 *ts, ssize_t v)
501 /* external resistors may scale vAUX into 0..vREF */
502 retval *= ts->vref_mv;
503 retval = retval >> 12;
508 static inline unsigned vbatt_adjust(struct ads7846 *ts, ssize_t v)
510 unsigned retval = vaux_adjust(ts, v);
512 /* ads7846 has a resistor ladder to scale this signal down */
513 if (ts->model == 7846)
519 SHOW(in0_input, vaux, vaux_adjust)
520 SHOW(in1_input, vbatt, vbatt_adjust)
522 static umode_t ads7846_is_visible(struct kobject *kobj, struct attribute *attr,
525 struct device *dev = kobj_to_dev(kobj);
526 struct ads7846 *ts = dev_get_drvdata(dev);
528 if (ts->model == 7843 && index < 2) /* in0, in1 */
530 if (ts->model == 7845 && index != 2) /* in0 */
536 static struct attribute *ads7846_attributes[] = {
537 &dev_attr_temp0.attr, /* 0 */
538 &dev_attr_temp1.attr, /* 1 */
539 &dev_attr_in0_input.attr, /* 2 */
540 &dev_attr_in1_input.attr, /* 3 */
544 static const struct attribute_group ads7846_attr_group = {
545 .attrs = ads7846_attributes,
546 .is_visible = ads7846_is_visible,
548 __ATTRIBUTE_GROUPS(ads7846_attr);
550 static int ads784x_hwmon_register(struct spi_device *spi, struct ads7846 *ts)
552 /* hwmon sensors need a reference voltage */
556 dev_dbg(&spi->dev, "assuming 2.5V internal vREF\n");
558 ts->use_internal = true;
565 "external vREF for ADS%d not specified\n",
572 ts->hwmon = hwmon_device_register_with_groups(&spi->dev, spi->modalias,
573 ts, ads7846_attr_groups);
575 return PTR_ERR_OR_ZERO(ts->hwmon);
578 static void ads784x_hwmon_unregister(struct spi_device *spi,
582 hwmon_device_unregister(ts->hwmon);
586 static inline int ads784x_hwmon_register(struct spi_device *spi,
592 static inline void ads784x_hwmon_unregister(struct spi_device *spi,
598 static ssize_t ads7846_pen_down_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->pendown);
606 static DEVICE_ATTR(pen_down, S_IRUGO, ads7846_pen_down_show, NULL);
608 static ssize_t ads7846_disable_show(struct device *dev,
609 struct device_attribute *attr, char *buf)
611 struct ads7846 *ts = dev_get_drvdata(dev);
613 return sprintf(buf, "%u\n", ts->disabled);
616 static ssize_t ads7846_disable_store(struct device *dev,
617 struct device_attribute *attr,
618 const char *buf, size_t count)
620 struct ads7846 *ts = dev_get_drvdata(dev);
624 err = kstrtouint(buf, 10, &i);
636 static DEVICE_ATTR(disable, 0664, ads7846_disable_show, ads7846_disable_store);
638 static struct attribute *ads784x_attributes[] = {
639 &dev_attr_pen_down.attr,
640 &dev_attr_disable.attr,
644 static const struct attribute_group ads784x_attr_group = {
645 .attrs = ads784x_attributes,
648 /*--------------------------------------------------------------------------*/
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_buf *buf)
705 value = be16_to_cpup(&buf->data);
707 /* enforce ADC output is 12 bits width */
708 return (value >> 3) & 0xfff;
711 static void ads7846_set_cmd_val(struct ads7846 *ts, enum ads7846_cmds cmd_idx,
714 struct ads7846_packet *packet = ts->packet;
734 static u8 ads7846_get_cmd(enum ads7846_cmds cmd_idx, int vref)
742 /* 7846 specific commands */
744 return READ_Z1(vref);
746 return READ_Z2(vref);
756 static bool ads7846_cmd_need_settle(enum ads7846_cmds cmd_idx)
773 static int ads7846_filter(struct ads7846 *ts)
775 struct ads7846_packet *packet = ts->packet;
778 unsigned int cmd_idx, b;
780 packet->ignore = false;
781 for (cmd_idx = packet->last_cmd_idx; cmd_idx < packet->cmds - 1; cmd_idx++) {
782 struct ads7846_buf_layout *l = &packet->l[cmd_idx];
784 packet->last_cmd_idx = cmd_idx;
786 for (b = l->skip; b < l->count; b++) {
787 val = ads7846_get_value(&packet->rx[l->offset + b]);
789 action = ts->filter(ts->filter_data, cmd_idx, &val);
790 if (action == ADS7846_FILTER_REPEAT) {
791 if (b == l->count - 1)
793 } else if (action == ADS7846_FILTER_OK) {
794 ads7846_set_cmd_val(ts, cmd_idx, val);
797 packet->ignore = true;
806 static void ads7846_read_state(struct ads7846 *ts)
808 struct ads7846_packet *packet = ts->packet;
809 struct spi_message *m;
813 packet->last_cmd_idx = 0;
818 m = &ts->msg[msg_idx];
819 error = spi_sync(ts->spi, m);
821 dev_err(&ts->spi->dev, "spi_sync --> %d\n", error);
822 packet->ignore = true;
826 error = ads7846_filter(ts);
834 static void ads7846_report_state(struct ads7846 *ts)
836 struct ads7846_packet *packet = ts->packet;
842 if (ts->model == 7845) {
850 /* range filtering */
854 if (ts->model == 7843) {
855 Rt = ts->pressure_max / 2;
856 } else if (ts->model == 7845) {
857 if (get_pendown_state(ts))
858 Rt = ts->pressure_max / 2;
861 dev_vdbg(&ts->spi->dev, "x/y: %d/%d, PD %d\n", x, y, Rt);
862 } else if (likely(x && z1)) {
863 /* compute touch pressure resistance using equation #2 */
866 Rt *= ts->x_plate_ohms;
867 Rt = DIV_ROUND_CLOSEST(Rt, 16);
870 Rt = DIV_ROUND_CLOSEST(Rt, 256);
876 * Sample found inconsistent by debouncing or pressure is beyond
877 * the maximum. Don't report it to user space, repeat at least
878 * once more the measurement
880 if (packet->ignore || Rt > ts->pressure_max) {
881 dev_vdbg(&ts->spi->dev, "ignored %d pressure %d\n",
887 * Maybe check the pendown state before reporting. This discards
888 * false readings when the pen is lifted.
890 if (ts->penirq_recheck_delay_usecs) {
891 udelay(ts->penirq_recheck_delay_usecs);
892 if (!get_pendown_state(ts))
897 * NOTE: We can't rely on the pressure to determine the pen down
898 * state, even this controller has a pressure sensor. The pressure
899 * value can fluctuate for quite a while after lifting the pen and
900 * in some cases may not even settle at the expected value.
902 * The only safe way to check for the pen up condition is in the
903 * timer by reading the pen signal state (it's a GPIO _and_ IRQ).
906 struct input_dev *input = ts->input;
909 input_report_key(input, BTN_TOUCH, 1);
911 dev_vdbg(&ts->spi->dev, "DOWN\n");
914 touchscreen_report_pos(input, &ts->core_prop, x, y, false);
915 input_report_abs(input, ABS_PRESSURE, ts->pressure_max - Rt);
918 dev_vdbg(&ts->spi->dev, "%4d/%4d/%4d\n", x, y, Rt);
922 static irqreturn_t ads7846_hard_irq(int irq, void *handle)
924 struct ads7846 *ts = handle;
926 return get_pendown_state(ts) ? IRQ_WAKE_THREAD : IRQ_HANDLED;
930 static irqreturn_t ads7846_irq(int irq, void *handle)
932 struct ads7846 *ts = handle;
934 /* Start with a small delay before checking pendown state */
935 msleep(TS_POLL_DELAY);
937 while (!ts->stopped && get_pendown_state(ts)) {
939 /* pen is down, continue with the measurement */
940 ads7846_read_state(ts);
943 ads7846_report_state(ts);
945 wait_event_timeout(ts->wait, ts->stopped,
946 msecs_to_jiffies(TS_POLL_PERIOD));
949 if (ts->pendown && !ts->stopped)
950 ads7846_report_pen_up(ts);
955 static int __maybe_unused ads7846_suspend(struct device *dev)
957 struct ads7846 *ts = dev_get_drvdata(dev);
959 mutex_lock(&ts->lock);
961 if (!ts->suspended) {
964 __ads7846_disable(ts);
966 if (device_may_wakeup(&ts->spi->dev))
967 enable_irq_wake(ts->spi->irq);
969 ts->suspended = true;
972 mutex_unlock(&ts->lock);
977 static int __maybe_unused ads7846_resume(struct device *dev)
979 struct ads7846 *ts = dev_get_drvdata(dev);
981 mutex_lock(&ts->lock);
985 ts->suspended = false;
987 if (device_may_wakeup(&ts->spi->dev))
988 disable_irq_wake(ts->spi->irq);
991 __ads7846_enable(ts);
994 mutex_unlock(&ts->lock);
999 static SIMPLE_DEV_PM_OPS(ads7846_pm, ads7846_suspend, ads7846_resume);
1001 static int ads7846_setup_pendown(struct spi_device *spi,
1003 const struct ads7846_platform_data *pdata)
1008 * REVISIT when the irq can be triggered active-low, or if for some
1009 * reason the touchscreen isn't hooked up, we don't need to access
1010 * the pendown state.
1013 if (pdata->get_pendown_state) {
1014 ts->get_pendown_state = pdata->get_pendown_state;
1015 } else if (gpio_is_valid(pdata->gpio_pendown)) {
1017 err = gpio_request_one(pdata->gpio_pendown, GPIOF_IN,
1021 "failed to request/setup pendown GPIO%d: %d\n",
1022 pdata->gpio_pendown, err);
1026 ts->gpio_pendown = pdata->gpio_pendown;
1028 if (pdata->gpio_pendown_debounce)
1029 gpio_set_debounce(pdata->gpio_pendown,
1030 pdata->gpio_pendown_debounce);
1032 dev_err(&spi->dev, "no get_pendown_state nor gpio_pendown?\n");
1040 * Set up the transfers to read touchscreen state; this assumes we
1041 * use formula #2 for pressure, not #3.
1043 static int ads7846_setup_spi_msg(struct ads7846 *ts,
1044 const struct ads7846_platform_data *pdata)
1046 struct spi_message *m = &ts->msg[0];
1047 struct spi_transfer *x = ts->xfer;
1048 struct ads7846_packet *packet = ts->packet;
1049 int vref = pdata->keep_vref_on;
1050 unsigned int count, offset = 0;
1051 unsigned int cmd_idx, b;
1056 time = NSEC_PER_SEC / ts->spi->max_speed_hz;
1058 count = pdata->settle_delay_usecs * NSEC_PER_USEC / time;
1059 packet->count_skip = DIV_ROUND_UP(count, 24);
1061 if (ts->debounce_max && ts->debounce_rep)
1062 /* ads7846_debounce_filter() is making ts->debounce_rep + 2
1063 * reads. So we need to get all samples for normal case. */
1064 packet->count = ts->debounce_rep + 2;
1068 if (ts->model == 7846)
1069 packet->cmds = 5; /* x, y, z1, z2, pwdown */
1071 packet->cmds = 3; /* x, y, pwdown */
1073 for (cmd_idx = 0; cmd_idx < packet->cmds; cmd_idx++) {
1074 struct ads7846_buf_layout *l = &packet->l[cmd_idx];
1075 unsigned int max_count;
1077 if (ads7846_cmd_need_settle(cmd_idx))
1078 max_count = packet->count + packet->count_skip;
1080 max_count = packet->count;
1083 offset += max_count;
1084 l->count = max_count;
1085 l->skip = packet->count_skip;
1086 size += sizeof(*packet->tx) * max_count;
1089 packet->tx = devm_kzalloc(&ts->spi->dev, size, GFP_KERNEL);
1093 packet->rx = devm_kzalloc(&ts->spi->dev, size, GFP_KERNEL);
1097 if (ts->model == 7873) {
1099 * The AD7873 is almost identical to the ADS7846
1100 * keep VREF off during differential/ratiometric
1108 spi_message_init(m);
1111 for (cmd_idx = 0; cmd_idx < packet->cmds; cmd_idx++) {
1112 struct ads7846_buf_layout *l = &packet->l[cmd_idx];
1113 u8 cmd = ads7846_get_cmd(cmd_idx, vref);
1115 for (b = 0; b < l->count; b++)
1116 packet->tx[l->offset + b].cmd = cmd;
1119 x->tx_buf = packet->tx;
1120 x->rx_buf = packet->rx;
1122 spi_message_add_tail(x, m);
1128 static const struct of_device_id ads7846_dt_ids[] = {
1129 { .compatible = "ti,tsc2046", .data = (void *) 7846 },
1130 { .compatible = "ti,ads7843", .data = (void *) 7843 },
1131 { .compatible = "ti,ads7845", .data = (void *) 7845 },
1132 { .compatible = "ti,ads7846", .data = (void *) 7846 },
1133 { .compatible = "ti,ads7873", .data = (void *) 7873 },
1136 MODULE_DEVICE_TABLE(of, ads7846_dt_ids);
1138 static const struct ads7846_platform_data *ads7846_probe_dt(struct device *dev)
1140 struct ads7846_platform_data *pdata;
1141 struct device_node *node = dev->of_node;
1142 const struct of_device_id *match;
1146 dev_err(dev, "Device does not have associated DT data\n");
1147 return ERR_PTR(-EINVAL);
1150 match = of_match_device(ads7846_dt_ids, dev);
1152 dev_err(dev, "Unknown device model\n");
1153 return ERR_PTR(-EINVAL);
1156 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
1158 return ERR_PTR(-ENOMEM);
1160 pdata->model = (unsigned long)match->data;
1162 of_property_read_u16(node, "ti,vref-delay-usecs",
1163 &pdata->vref_delay_usecs);
1164 of_property_read_u16(node, "ti,vref-mv", &pdata->vref_mv);
1165 pdata->keep_vref_on = of_property_read_bool(node, "ti,keep-vref-on");
1167 pdata->swap_xy = of_property_read_bool(node, "ti,swap-xy");
1169 of_property_read_u16(node, "ti,settle-delay-usec",
1170 &pdata->settle_delay_usecs);
1171 of_property_read_u16(node, "ti,penirq-recheck-delay-usecs",
1172 &pdata->penirq_recheck_delay_usecs);
1174 of_property_read_u16(node, "ti,x-plate-ohms", &pdata->x_plate_ohms);
1175 of_property_read_u16(node, "ti,y-plate-ohms", &pdata->y_plate_ohms);
1177 of_property_read_u16(node, "ti,x-min", &pdata->x_min);
1178 of_property_read_u16(node, "ti,y-min", &pdata->y_min);
1179 of_property_read_u16(node, "ti,x-max", &pdata->x_max);
1180 of_property_read_u16(node, "ti,y-max", &pdata->y_max);
1183 * touchscreen-max-pressure gets parsed during
1184 * touchscreen_parse_properties()
1186 of_property_read_u16(node, "ti,pressure-min", &pdata->pressure_min);
1187 if (!of_property_read_u32(node, "touchscreen-min-pressure", &value))
1188 pdata->pressure_min = (u16) value;
1189 of_property_read_u16(node, "ti,pressure-max", &pdata->pressure_max);
1191 of_property_read_u16(node, "ti,debounce-max", &pdata->debounce_max);
1192 if (!of_property_read_u32(node, "touchscreen-average-samples", &value))
1193 pdata->debounce_max = (u16) value;
1194 of_property_read_u16(node, "ti,debounce-tol", &pdata->debounce_tol);
1195 of_property_read_u16(node, "ti,debounce-rep", &pdata->debounce_rep);
1197 of_property_read_u32(node, "ti,pendown-gpio-debounce",
1198 &pdata->gpio_pendown_debounce);
1200 pdata->wakeup = of_property_read_bool(node, "wakeup-source") ||
1201 of_property_read_bool(node, "linux,wakeup");
1203 pdata->gpio_pendown = of_get_named_gpio(dev->of_node, "pendown-gpio", 0);
1208 static const struct ads7846_platform_data *ads7846_probe_dt(struct device *dev)
1210 dev_err(dev, "no platform data defined\n");
1211 return ERR_PTR(-EINVAL);
1215 static int ads7846_probe(struct spi_device *spi)
1217 const struct ads7846_platform_data *pdata;
1219 struct ads7846_packet *packet;
1220 struct input_dev *input_dev;
1221 unsigned long irq_flags;
1225 dev_dbg(&spi->dev, "no IRQ?\n");
1229 /* don't exceed max specified sample rate */
1230 if (spi->max_speed_hz > (125000 * SAMPLE_BITS)) {
1231 dev_err(&spi->dev, "f(sample) %d KHz?\n",
1232 (spi->max_speed_hz/SAMPLE_BITS)/1000);
1237 * We'd set TX word size 8 bits and RX word size to 13 bits ... except
1238 * that even if the hardware can do that, the SPI controller driver
1239 * may not. So we stick to very-portable 8 bit words, both RX and TX.
1241 spi->bits_per_word = 8;
1242 spi->mode &= ~SPI_MODE_X_MASK;
1243 spi->mode |= SPI_MODE_0;
1244 err = spi_setup(spi);
1248 ts = kzalloc(sizeof(struct ads7846), GFP_KERNEL);
1249 packet = kzalloc(sizeof(struct ads7846_packet), GFP_KERNEL);
1250 input_dev = input_allocate_device();
1251 if (!ts || !packet || !input_dev) {
1256 spi_set_drvdata(spi, ts);
1258 ts->packet = packet;
1260 ts->input = input_dev;
1262 mutex_init(&ts->lock);
1263 init_waitqueue_head(&ts->wait);
1265 pdata = dev_get_platdata(&spi->dev);
1267 pdata = ads7846_probe_dt(&spi->dev);
1268 if (IS_ERR(pdata)) {
1269 err = PTR_ERR(pdata);
1274 ts->model = pdata->model ? : 7846;
1275 ts->vref_delay_usecs = pdata->vref_delay_usecs ? : 100;
1276 ts->x_plate_ohms = pdata->x_plate_ohms ? : 400;
1277 ts->vref_mv = pdata->vref_mv;
1279 if (pdata->filter != NULL) {
1280 if (pdata->filter_init != NULL) {
1281 err = pdata->filter_init(pdata, &ts->filter_data);
1285 ts->filter = pdata->filter;
1286 ts->filter_cleanup = pdata->filter_cleanup;
1287 } else if (pdata->debounce_max) {
1288 ts->debounce_max = pdata->debounce_max;
1289 if (ts->debounce_max < 2)
1290 ts->debounce_max = 2;
1291 ts->debounce_tol = pdata->debounce_tol;
1292 ts->debounce_rep = pdata->debounce_rep;
1293 ts->filter = ads7846_debounce_filter;
1294 ts->filter_data = ts;
1296 ts->filter = ads7846_no_filter;
1299 err = ads7846_setup_pendown(spi, ts, pdata);
1301 goto err_cleanup_filter;
1303 if (pdata->penirq_recheck_delay_usecs)
1304 ts->penirq_recheck_delay_usecs =
1305 pdata->penirq_recheck_delay_usecs;
1307 ts->wait_for_sync = pdata->wait_for_sync ? : null_wait_for_sync;
1309 snprintf(ts->phys, sizeof(ts->phys), "%s/input0", dev_name(&spi->dev));
1310 snprintf(ts->name, sizeof(ts->name), "ADS%d Touchscreen", ts->model);
1312 input_dev->name = ts->name;
1313 input_dev->phys = ts->phys;
1314 input_dev->dev.parent = &spi->dev;
1316 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
1317 input_dev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
1318 input_set_abs_params(input_dev, ABS_X,
1320 pdata->x_max ? : MAX_12BIT,
1322 input_set_abs_params(input_dev, ABS_Y,
1324 pdata->y_max ? : MAX_12BIT,
1326 input_set_abs_params(input_dev, ABS_PRESSURE,
1327 pdata->pressure_min, pdata->pressure_max, 0, 0);
1330 * Parse common framework properties. Must be done here to ensure the
1331 * correct behaviour in case of using the legacy vendor bindings. The
1332 * general binding value overrides the vendor specific one.
1334 touchscreen_parse_properties(ts->input, false, &ts->core_prop);
1335 ts->pressure_max = input_abs_get_max(input_dev, ABS_PRESSURE) ? : ~0;
1338 * Check if legacy ti,swap-xy binding is used instead of
1339 * touchscreen-swapped-x-y
1341 if (!ts->core_prop.swap_x_y && pdata->swap_xy) {
1342 swap(input_dev->absinfo[ABS_X], input_dev->absinfo[ABS_Y]);
1343 ts->core_prop.swap_x_y = true;
1346 ads7846_setup_spi_msg(ts, pdata);
1348 ts->reg = regulator_get(&spi->dev, "vcc");
1349 if (IS_ERR(ts->reg)) {
1350 err = PTR_ERR(ts->reg);
1351 dev_err(&spi->dev, "unable to get regulator: %d\n", err);
1355 err = regulator_enable(ts->reg);
1357 dev_err(&spi->dev, "unable to enable regulator: %d\n", err);
1358 goto err_put_regulator;
1361 irq_flags = pdata->irq_flags ? : IRQF_TRIGGER_FALLING;
1362 irq_flags |= IRQF_ONESHOT;
1364 err = request_threaded_irq(spi->irq, ads7846_hard_irq, ads7846_irq,
1365 irq_flags, spi->dev.driver->name, ts);
1366 if (err && !pdata->irq_flags) {
1368 "trying pin change workaround on irq %d\n", spi->irq);
1369 irq_flags |= IRQF_TRIGGER_RISING;
1370 err = request_threaded_irq(spi->irq,
1371 ads7846_hard_irq, ads7846_irq,
1372 irq_flags, spi->dev.driver->name, ts);
1376 dev_dbg(&spi->dev, "irq %d busy?\n", spi->irq);
1377 goto err_disable_regulator;
1380 err = ads784x_hwmon_register(spi, ts);
1384 dev_info(&spi->dev, "touchscreen, irq %d\n", spi->irq);
1387 * Take a first sample, leaving nPENIRQ active and vREF off; avoid
1388 * the touchscreen, in case it's not connected.
1390 if (ts->model == 7845)
1391 ads7845_read12_ser(&spi->dev, PWRDOWN);
1393 (void) ads7846_read12_ser(&spi->dev, READ_12BIT_SER(vaux));
1395 err = sysfs_create_group(&spi->dev.kobj, &ads784x_attr_group);
1397 goto err_remove_hwmon;
1399 err = input_register_device(input_dev);
1401 goto err_remove_attr_group;
1403 device_init_wakeup(&spi->dev, pdata->wakeup);
1406 * If device does not carry platform data we must have allocated it
1407 * when parsing DT data.
1409 if (!dev_get_platdata(&spi->dev))
1410 devm_kfree(&spi->dev, (void *)pdata);
1414 err_remove_attr_group:
1415 sysfs_remove_group(&spi->dev.kobj, &ads784x_attr_group);
1417 ads784x_hwmon_unregister(spi, ts);
1419 free_irq(spi->irq, ts);
1420 err_disable_regulator:
1421 regulator_disable(ts->reg);
1423 regulator_put(ts->reg);
1425 if (!ts->get_pendown_state)
1426 gpio_free(ts->gpio_pendown);
1428 if (ts->filter_cleanup)
1429 ts->filter_cleanup(ts->filter_data);
1431 input_free_device(input_dev);
1437 static int ads7846_remove(struct spi_device *spi)
1439 struct ads7846 *ts = spi_get_drvdata(spi);
1441 sysfs_remove_group(&spi->dev.kobj, &ads784x_attr_group);
1443 ads7846_disable(ts);
1444 free_irq(ts->spi->irq, ts);
1446 input_unregister_device(ts->input);
1448 ads784x_hwmon_unregister(spi, ts);
1450 regulator_put(ts->reg);
1452 if (!ts->get_pendown_state) {
1454 * If we are not using specialized pendown method we must
1455 * have been relying on gpio we set up ourselves.
1457 gpio_free(ts->gpio_pendown);
1460 if (ts->filter_cleanup)
1461 ts->filter_cleanup(ts->filter_data);
1466 dev_dbg(&spi->dev, "unregistered touchscreen\n");
1471 static struct spi_driver ads7846_driver = {
1475 .of_match_table = of_match_ptr(ads7846_dt_ids),
1477 .probe = ads7846_probe,
1478 .remove = ads7846_remove,
1481 module_spi_driver(ads7846_driver);
1483 MODULE_DESCRIPTION("ADS7846 TouchScreen Driver");
1484 MODULE_LICENSE("GPL");
1485 MODULE_ALIAS("spi:ads7846");