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>
36 #include <asm/unaligned.h>
39 * This code has been heavily tested on a Nokia 770, and lightly
40 * tested on other ads7846 devices (OSK/Mistral, Lubbock, Spitz).
41 * TSC2046 is just newer ads7846 silicon.
42 * Support for ads7843 tested on Atmel at91sam926x-EK.
43 * Support for ads7845 has only been stubbed in.
44 * Support for Analog Devices AD7873 and AD7843 tested.
46 * IRQ handling needs a workaround because of a shortcoming in handling
47 * edge triggered IRQs on some platforms like the OMAP1/2. These
48 * platforms don't handle the ARM lazy IRQ disabling properly, thus we
49 * have to maintain our own SW IRQ disabled status. This should be
50 * removed as soon as the affected platform's IRQ handling is fixed.
52 * App note sbaa036 talks in more detail about accurate sampling...
53 * that ought to help in situations like LCDs inducing noise (which
54 * can also be helped by using synch signals) and more generally.
55 * This driver tries to utilize the measures described in the app
56 * note. The strength of filtering can be set in the board-* specific
60 #define TS_POLL_DELAY 1 /* ms delay before the first sample */
61 #define TS_POLL_PERIOD 5 /* ms delay between samples */
63 /* this driver doesn't aim at the peak continuous sample rate */
64 #define SAMPLE_BITS (8 /*cmd*/ + 16 /*sample*/ + 2 /* before, after */)
71 struct ads7846_buf_layout {
78 * We allocate this separately to avoid cache line sharing issues when
79 * driver is used with DMA-based SPI controllers (like atmel_spi) on
80 * systems where main memory is not DMA-coherent (most non-x86 boards).
82 struct ads7846_packet {
84 unsigned int count_skip;
86 unsigned int last_cmd_idx;
87 struct ads7846_buf_layout l[5];
88 struct ads7846_buf *rx;
89 struct ads7846_buf *tx;
91 struct ads7846_buf pwrdown_cmd;
98 struct input_dev *input;
102 struct spi_device *spi;
103 struct regulator *reg;
105 #if IS_ENABLED(CONFIG_HWMON)
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;
137 struct touchscreen_properties core_prop;
140 bool stopped; /* P: lock */
141 bool disabled; /* P: lock */
142 bool suspended; /* P: lock */
144 int (*filter)(void *data, int data_idx, int *val);
146 void (*filter_cleanup)(void *data);
147 int (*get_pendown_state)(void);
150 void (*wait_for_sync)(void);
153 /* leave chip selected when we're done, for quicker re-select? */
155 #define CS_CHANGE(xfer) ((xfer).cs_change = 1)
157 #define CS_CHANGE(xfer) ((xfer).cs_change = 0)
160 /*--------------------------------------------------------------------------*/
162 /* The ADS7846 has touchscreen and other sensors.
163 * Earlier ads784x chips are somewhat compatible.
165 #define ADS_START (1 << 7)
166 #define ADS_A2A1A0_d_y (1 << 4) /* differential */
167 #define ADS_A2A1A0_d_z1 (3 << 4) /* differential */
168 #define ADS_A2A1A0_d_z2 (4 << 4) /* differential */
169 #define ADS_A2A1A0_d_x (5 << 4) /* differential */
170 #define ADS_A2A1A0_temp0 (0 << 4) /* non-differential */
171 #define ADS_A2A1A0_vbatt (2 << 4) /* non-differential */
172 #define ADS_A2A1A0_vaux (6 << 4) /* non-differential */
173 #define ADS_A2A1A0_temp1 (7 << 4) /* non-differential */
174 #define ADS_8_BIT (1 << 3)
175 #define ADS_12_BIT (0 << 3)
176 #define ADS_SER (1 << 2) /* non-differential */
177 #define ADS_DFR (0 << 2) /* differential */
178 #define ADS_PD10_PDOWN (0 << 0) /* low power mode + penirq */
179 #define ADS_PD10_ADC_ON (1 << 0) /* ADC on */
180 #define ADS_PD10_REF_ON (2 << 0) /* vREF on + penirq */
181 #define ADS_PD10_ALL_ON (3 << 0) /* ADC + vREF on */
183 #define MAX_12BIT ((1<<12)-1)
185 /* leave ADC powered up (disables penirq) between differential samples */
186 #define READ_12BIT_DFR(x, adc, vref) (ADS_START | ADS_A2A1A0_d_ ## x \
187 | ADS_12_BIT | ADS_DFR | \
188 (adc ? ADS_PD10_ADC_ON : 0) | (vref ? ADS_PD10_REF_ON : 0))
190 #define READ_Y(vref) (READ_12BIT_DFR(y, 1, vref))
191 #define READ_Z1(vref) (READ_12BIT_DFR(z1, 1, vref))
192 #define READ_Z2(vref) (READ_12BIT_DFR(z2, 1, vref))
193 #define READ_X(vref) (READ_12BIT_DFR(x, 1, vref))
194 #define PWRDOWN (READ_12BIT_DFR(y, 0, 0)) /* LAST */
196 /* single-ended samples need to first power up reference voltage;
197 * we leave both ADC and VREF powered
199 #define READ_12BIT_SER(x) (ADS_START | ADS_A2A1A0_ ## x \
200 | ADS_12_BIT | ADS_SER)
202 #define REF_ON (READ_12BIT_DFR(x, 1, 1))
203 #define REF_OFF (READ_12BIT_DFR(y, 0, 0))
205 /* Order commands in the most optimal way to reduce Vref switching and
207 * Measure: X; Vref: X+, X-; IN: Y+
208 * Measure: Y; Vref: Y+, Y-; IN: X+
209 * Measure: Z1; Vref: Y+, X-; IN: X+
210 * Measure: Z2; Vref: Y+, X-; IN: Y-
220 static int get_pendown_state(struct ads7846 *ts)
222 if (ts->get_pendown_state)
223 return ts->get_pendown_state();
225 return !gpio_get_value(ts->gpio_pendown);
228 static void ads7846_report_pen_up(struct ads7846 *ts)
230 struct input_dev *input = ts->input;
232 input_report_key(input, BTN_TOUCH, 0);
233 input_report_abs(input, ABS_PRESSURE, 0);
237 dev_vdbg(&ts->spi->dev, "UP\n");
240 /* Must be called with ts->lock held */
241 static void ads7846_stop(struct ads7846 *ts)
243 if (!ts->disabled && !ts->suspended) {
244 /* Signal IRQ thread to stop polling and disable the handler. */
248 disable_irq(ts->spi->irq);
252 /* Must be called with ts->lock held */
253 static void ads7846_restart(struct ads7846 *ts)
255 if (!ts->disabled && !ts->suspended) {
256 /* Check if pen was released since last stop */
257 if (ts->pendown && !get_pendown_state(ts))
258 ads7846_report_pen_up(ts);
260 /* Tell IRQ thread that it may poll the device. */
263 enable_irq(ts->spi->irq);
267 /* Must be called with ts->lock held */
268 static void __ads7846_disable(struct ads7846 *ts)
271 regulator_disable(ts->reg);
274 * We know the chip's in low power mode since we always
275 * leave it that way after every request
279 /* Must be called with ts->lock held */
280 static void __ads7846_enable(struct ads7846 *ts)
284 error = regulator_enable(ts->reg);
286 dev_err(&ts->spi->dev, "Failed to enable supply: %d\n", error);
291 static void ads7846_disable(struct ads7846 *ts)
293 mutex_lock(&ts->lock);
298 __ads7846_disable(ts);
303 mutex_unlock(&ts->lock);
306 static void ads7846_enable(struct ads7846 *ts)
308 mutex_lock(&ts->lock);
312 ts->disabled = false;
315 __ads7846_enable(ts);
318 mutex_unlock(&ts->lock);
321 /*--------------------------------------------------------------------------*/
324 * Non-touchscreen sensors only use single-ended conversions.
325 * The range is GND..vREF. The ads7843 and ads7835 must use external vREF;
326 * ads7846 lets that pin be unconnected, to use internal vREF.
334 struct spi_message msg;
335 struct spi_transfer xfer[6];
337 * DMA (thus cache coherency maintenance) requires the
338 * transfer buffers to live in their own cache lines.
340 __be16 sample ____cacheline_aligned;
343 struct ads7845_ser_req {
345 struct spi_message msg;
346 struct spi_transfer xfer[2];
348 * DMA (thus cache coherency maintenance) requires the
349 * transfer buffers to live in their own cache lines.
351 u8 sample[3] ____cacheline_aligned;
354 static int ads7846_read12_ser(struct device *dev, unsigned command)
356 struct spi_device *spi = to_spi_device(dev);
357 struct ads7846 *ts = dev_get_drvdata(dev);
361 req = kzalloc(sizeof *req, GFP_KERNEL);
365 spi_message_init(&req->msg);
367 /* maybe turn on internal vREF, and let it settle */
368 if (ts->use_internal) {
369 req->ref_on = REF_ON;
370 req->xfer[0].tx_buf = &req->ref_on;
371 req->xfer[0].len = 1;
372 spi_message_add_tail(&req->xfer[0], &req->msg);
374 req->xfer[1].rx_buf = &req->scratch;
375 req->xfer[1].len = 2;
377 /* for 1uF, settle for 800 usec; no cap, 100 usec. */
378 req->xfer[1].delay.value = ts->vref_delay_usecs;
379 req->xfer[1].delay.unit = SPI_DELAY_UNIT_USECS;
380 spi_message_add_tail(&req->xfer[1], &req->msg);
382 /* Enable reference voltage */
383 command |= ADS_PD10_REF_ON;
386 /* Enable ADC in every case */
387 command |= ADS_PD10_ADC_ON;
390 req->command = (u8) command;
391 req->xfer[2].tx_buf = &req->command;
392 req->xfer[2].len = 1;
393 spi_message_add_tail(&req->xfer[2], &req->msg);
395 req->xfer[3].rx_buf = &req->sample;
396 req->xfer[3].len = 2;
397 spi_message_add_tail(&req->xfer[3], &req->msg);
399 /* REVISIT: take a few more samples, and compare ... */
401 /* converter in low power mode & enable PENIRQ */
402 req->ref_off = PWRDOWN;
403 req->xfer[4].tx_buf = &req->ref_off;
404 req->xfer[4].len = 1;
405 spi_message_add_tail(&req->xfer[4], &req->msg);
407 req->xfer[5].rx_buf = &req->scratch;
408 req->xfer[5].len = 2;
409 CS_CHANGE(req->xfer[5]);
410 spi_message_add_tail(&req->xfer[5], &req->msg);
412 mutex_lock(&ts->lock);
414 status = spi_sync(spi, &req->msg);
416 mutex_unlock(&ts->lock);
419 /* on-wire is a must-ignore bit, a BE12 value, then padding */
420 status = be16_to_cpu(req->sample);
421 status = status >> 3;
429 static int ads7845_read12_ser(struct device *dev, unsigned command)
431 struct spi_device *spi = to_spi_device(dev);
432 struct ads7846 *ts = dev_get_drvdata(dev);
433 struct ads7845_ser_req *req;
436 req = kzalloc(sizeof *req, GFP_KERNEL);
440 spi_message_init(&req->msg);
442 req->command[0] = (u8) command;
443 req->xfer[0].tx_buf = req->command;
444 req->xfer[0].rx_buf = req->sample;
445 req->xfer[0].len = 3;
446 spi_message_add_tail(&req->xfer[0], &req->msg);
448 mutex_lock(&ts->lock);
450 status = spi_sync(spi, &req->msg);
452 mutex_unlock(&ts->lock);
455 /* BE12 value, then padding */
456 status = get_unaligned_be16(&req->sample[1]);
457 status = status >> 3;
465 #if IS_ENABLED(CONFIG_HWMON)
467 #define SHOW(name, var, adjust) static ssize_t \
468 name ## _show(struct device *dev, struct device_attribute *attr, char *buf) \
470 struct ads7846 *ts = dev_get_drvdata(dev); \
471 ssize_t v = ads7846_read12_ser(&ts->spi->dev, \
472 READ_12BIT_SER(var)); \
475 return sprintf(buf, "%u\n", adjust(ts, v)); \
477 static DEVICE_ATTR(name, S_IRUGO, name ## _show, NULL);
480 /* Sysfs conventions report temperatures in millidegrees Celsius.
481 * ADS7846 could use the low-accuracy two-sample scheme, but can't do the high
482 * accuracy scheme without calibration data. For now we won't try either;
483 * userspace sees raw sensor values, and must scale/calibrate appropriately.
485 static inline unsigned null_adjust(struct ads7846 *ts, ssize_t v)
490 SHOW(temp0, temp0, null_adjust) /* temp1_input */
491 SHOW(temp1, temp1, null_adjust) /* temp2_input */
494 /* sysfs conventions report voltages in millivolts. We can convert voltages
495 * if we know vREF. userspace may need to scale vAUX to match the board's
496 * external resistors; we assume that vBATT only uses the internal ones.
498 static inline unsigned vaux_adjust(struct ads7846 *ts, ssize_t v)
502 /* external resistors may scale vAUX into 0..vREF */
503 retval *= ts->vref_mv;
504 retval = retval >> 12;
509 static inline unsigned vbatt_adjust(struct ads7846 *ts, ssize_t v)
511 unsigned retval = vaux_adjust(ts, v);
513 /* ads7846 has a resistor ladder to scale this signal down */
514 if (ts->model == 7846)
520 SHOW(in0_input, vaux, vaux_adjust)
521 SHOW(in1_input, vbatt, vbatt_adjust)
523 static umode_t ads7846_is_visible(struct kobject *kobj, struct attribute *attr,
526 struct device *dev = container_of(kobj, struct device, kobj);
527 struct ads7846 *ts = dev_get_drvdata(dev);
529 if (ts->model == 7843 && index < 2) /* in0, in1 */
531 if (ts->model == 7845 && index != 2) /* in0 */
537 static struct attribute *ads7846_attributes[] = {
538 &dev_attr_temp0.attr, /* 0 */
539 &dev_attr_temp1.attr, /* 1 */
540 &dev_attr_in0_input.attr, /* 2 */
541 &dev_attr_in1_input.attr, /* 3 */
545 static const struct attribute_group ads7846_attr_group = {
546 .attrs = ads7846_attributes,
547 .is_visible = ads7846_is_visible,
549 __ATTRIBUTE_GROUPS(ads7846_attr);
551 static int ads784x_hwmon_register(struct spi_device *spi, struct ads7846 *ts)
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 ts->hwmon = hwmon_device_register_with_groups(&spi->dev, spi->modalias,
574 ts, ads7846_attr_groups);
576 return PTR_ERR_OR_ZERO(ts->hwmon);
579 static void ads784x_hwmon_unregister(struct spi_device *spi,
583 hwmon_device_unregister(ts->hwmon);
587 static inline int ads784x_hwmon_register(struct spi_device *spi,
593 static inline void ads784x_hwmon_unregister(struct spi_device *spi,
599 static ssize_t ads7846_pen_down_show(struct device *dev,
600 struct device_attribute *attr, char *buf)
602 struct ads7846 *ts = dev_get_drvdata(dev);
604 return sprintf(buf, "%u\n", ts->pendown);
607 static DEVICE_ATTR(pen_down, S_IRUGO, ads7846_pen_down_show, NULL);
609 static ssize_t ads7846_disable_show(struct device *dev,
610 struct device_attribute *attr, char *buf)
612 struct ads7846 *ts = dev_get_drvdata(dev);
614 return sprintf(buf, "%u\n", ts->disabled);
617 static ssize_t ads7846_disable_store(struct device *dev,
618 struct device_attribute *attr,
619 const char *buf, size_t count)
621 struct ads7846 *ts = dev_get_drvdata(dev);
625 err = kstrtouint(buf, 10, &i);
637 static DEVICE_ATTR(disable, 0664, ads7846_disable_show, ads7846_disable_store);
639 static struct attribute *ads784x_attributes[] = {
640 &dev_attr_pen_down.attr,
641 &dev_attr_disable.attr,
645 static const struct attribute_group ads784x_attr_group = {
646 .attrs = ads784x_attributes,
649 /*--------------------------------------------------------------------------*/
651 static void null_wait_for_sync(void)
655 static int ads7846_debounce_filter(void *ads, int data_idx, int *val)
657 struct ads7846 *ts = ads;
659 if (!ts->read_cnt || (abs(ts->last_read - *val) > ts->debounce_tol)) {
660 /* Start over collecting consistent readings. */
663 * Repeat it, if this was the first read or the read
664 * wasn't consistent enough.
666 if (ts->read_cnt < ts->debounce_max) {
667 ts->last_read = *val;
669 return ADS7846_FILTER_REPEAT;
672 * Maximum number of debouncing reached and still
673 * not enough number of consistent readings. Abort
674 * the whole sample, repeat it in the next sampling
678 return ADS7846_FILTER_IGNORE;
681 if (++ts->read_rep > ts->debounce_rep) {
683 * Got a good reading for this coordinate,
684 * go for the next one.
688 return ADS7846_FILTER_OK;
690 /* Read more values that are consistent. */
692 return ADS7846_FILTER_REPEAT;
697 static int ads7846_no_filter(void *ads, int data_idx, int *val)
699 return ADS7846_FILTER_OK;
702 static int ads7846_get_value(struct ads7846_buf *buf)
706 value = be16_to_cpup(&buf->data);
708 /* enforce ADC output is 12 bits width */
709 return (value >> 3) & 0xfff;
712 static void ads7846_set_cmd_val(struct ads7846 *ts, enum ads7846_cmds cmd_idx,
715 struct ads7846_packet *packet = ts->packet;
735 static u8 ads7846_get_cmd(enum ads7846_cmds cmd_idx, int vref)
743 /* 7846 specific commands */
745 return READ_Z1(vref);
747 return READ_Z2(vref);
757 static bool ads7846_cmd_need_settle(enum ads7846_cmds cmd_idx)
774 static int ads7846_filter(struct ads7846 *ts)
776 struct ads7846_packet *packet = ts->packet;
779 unsigned int cmd_idx, b;
781 packet->ignore = false;
782 for (cmd_idx = packet->last_cmd_idx; cmd_idx < packet->cmds - 1; cmd_idx++) {
783 struct ads7846_buf_layout *l = &packet->l[cmd_idx];
785 packet->last_cmd_idx = cmd_idx;
787 for (b = l->skip; b < l->count; b++) {
788 val = ads7846_get_value(&packet->rx[l->offset + b]);
790 action = ts->filter(ts->filter_data, cmd_idx, &val);
791 if (action == ADS7846_FILTER_REPEAT) {
792 if (b == l->count - 1)
794 } else if (action == ADS7846_FILTER_OK) {
795 ads7846_set_cmd_val(ts, cmd_idx, val);
798 packet->ignore = true;
807 static void ads7846_read_state(struct ads7846 *ts)
809 struct ads7846_packet *packet = ts->packet;
810 struct spi_message *m;
814 packet->last_cmd_idx = 0;
819 m = &ts->msg[msg_idx];
820 error = spi_sync(ts->spi, m);
822 dev_err(&ts->spi->dev, "spi_sync --> %d\n", error);
823 packet->ignore = true;
827 error = ads7846_filter(ts);
835 static void ads7846_report_state(struct ads7846 *ts)
837 struct ads7846_packet *packet = ts->packet;
843 if (ts->model == 7845) {
851 /* range filtering */
855 if (ts->model == 7843 || ts->model == 7845) {
856 Rt = ts->pressure_max / 2;
857 } else if (likely(x && z1)) {
858 /* compute touch pressure resistance using equation #2 */
861 Rt *= ts->x_plate_ohms;
862 Rt = DIV_ROUND_CLOSEST(Rt, 16);
865 Rt = DIV_ROUND_CLOSEST(Rt, 256);
871 * Sample found inconsistent by debouncing or pressure is beyond
872 * the maximum. Don't report it to user space, repeat at least
873 * once more the measurement
875 if (packet->ignore || Rt > ts->pressure_max) {
876 dev_vdbg(&ts->spi->dev, "ignored %d pressure %d\n",
882 * Maybe check the pendown state before reporting. This discards
883 * false readings when the pen is lifted.
885 if (ts->penirq_recheck_delay_usecs) {
886 udelay(ts->penirq_recheck_delay_usecs);
887 if (!get_pendown_state(ts))
892 * NOTE: We can't rely on the pressure to determine the pen down
893 * state, even this controller has a pressure sensor. The pressure
894 * value can fluctuate for quite a while after lifting the pen and
895 * in some cases may not even settle at the expected value.
897 * The only safe way to check for the pen up condition is in the
898 * timer by reading the pen signal state (it's a GPIO _and_ IRQ).
901 struct input_dev *input = ts->input;
904 input_report_key(input, BTN_TOUCH, 1);
906 dev_vdbg(&ts->spi->dev, "DOWN\n");
909 touchscreen_report_pos(input, &ts->core_prop, x, y, false);
910 input_report_abs(input, ABS_PRESSURE, ts->pressure_max - Rt);
913 dev_vdbg(&ts->spi->dev, "%4d/%4d/%4d\n", x, y, Rt);
917 static irqreturn_t ads7846_hard_irq(int irq, void *handle)
919 struct ads7846 *ts = handle;
921 return get_pendown_state(ts) ? IRQ_WAKE_THREAD : IRQ_HANDLED;
925 static irqreturn_t ads7846_irq(int irq, void *handle)
927 struct ads7846 *ts = handle;
929 /* Start with a small delay before checking pendown state */
930 msleep(TS_POLL_DELAY);
932 while (!ts->stopped && get_pendown_state(ts)) {
934 /* pen is down, continue with the measurement */
935 ads7846_read_state(ts);
938 ads7846_report_state(ts);
940 wait_event_timeout(ts->wait, ts->stopped,
941 msecs_to_jiffies(TS_POLL_PERIOD));
944 if (ts->pendown && !ts->stopped)
945 ads7846_report_pen_up(ts);
950 static int __maybe_unused ads7846_suspend(struct device *dev)
952 struct ads7846 *ts = dev_get_drvdata(dev);
954 mutex_lock(&ts->lock);
956 if (!ts->suspended) {
959 __ads7846_disable(ts);
961 if (device_may_wakeup(&ts->spi->dev))
962 enable_irq_wake(ts->spi->irq);
964 ts->suspended = true;
967 mutex_unlock(&ts->lock);
972 static int __maybe_unused ads7846_resume(struct device *dev)
974 struct ads7846 *ts = dev_get_drvdata(dev);
976 mutex_lock(&ts->lock);
980 ts->suspended = false;
982 if (device_may_wakeup(&ts->spi->dev))
983 disable_irq_wake(ts->spi->irq);
986 __ads7846_enable(ts);
989 mutex_unlock(&ts->lock);
994 static SIMPLE_DEV_PM_OPS(ads7846_pm, ads7846_suspend, ads7846_resume);
996 static int ads7846_setup_pendown(struct spi_device *spi,
998 const struct ads7846_platform_data *pdata)
1003 * REVISIT when the irq can be triggered active-low, or if for some
1004 * reason the touchscreen isn't hooked up, we don't need to access
1005 * the pendown state.
1008 if (pdata->get_pendown_state) {
1009 ts->get_pendown_state = pdata->get_pendown_state;
1010 } else if (gpio_is_valid(pdata->gpio_pendown)) {
1012 err = gpio_request_one(pdata->gpio_pendown, GPIOF_IN,
1016 "failed to request/setup pendown GPIO%d: %d\n",
1017 pdata->gpio_pendown, err);
1021 ts->gpio_pendown = pdata->gpio_pendown;
1023 if (pdata->gpio_pendown_debounce)
1024 gpio_set_debounce(pdata->gpio_pendown,
1025 pdata->gpio_pendown_debounce);
1027 dev_err(&spi->dev, "no get_pendown_state nor gpio_pendown?\n");
1035 * Set up the transfers to read touchscreen state; this assumes we
1036 * use formula #2 for pressure, not #3.
1038 static int ads7846_setup_spi_msg(struct ads7846 *ts,
1039 const struct ads7846_platform_data *pdata)
1041 struct spi_message *m = &ts->msg[0];
1042 struct spi_transfer *x = ts->xfer;
1043 struct ads7846_packet *packet = ts->packet;
1044 int vref = pdata->keep_vref_on;
1045 unsigned int count, offset = 0;
1046 unsigned int cmd_idx, b;
1051 time = NSEC_PER_SEC / ts->spi->max_speed_hz;
1053 count = pdata->settle_delay_usecs * NSEC_PER_USEC / time;
1054 packet->count_skip = DIV_ROUND_UP(count, 24);
1056 if (ts->debounce_max && ts->debounce_rep)
1057 /* ads7846_debounce_filter() is making ts->debounce_rep + 2
1058 * reads. So we need to get all samples for normal case. */
1059 packet->count = ts->debounce_rep + 2;
1063 if (ts->model == 7846)
1064 packet->cmds = 5; /* x, y, z1, z2, pwdown */
1066 packet->cmds = 3; /* x, y, pwdown */
1068 for (cmd_idx = 0; cmd_idx < packet->cmds; cmd_idx++) {
1069 struct ads7846_buf_layout *l = &packet->l[cmd_idx];
1070 unsigned int max_count;
1072 if (cmd_idx == packet->cmds - 1)
1073 cmd_idx = ADS7846_PWDOWN;
1075 if (ads7846_cmd_need_settle(cmd_idx))
1076 max_count = packet->count + packet->count_skip;
1078 max_count = packet->count;
1081 offset += max_count;
1082 l->count = max_count;
1083 l->skip = packet->count_skip;
1084 size += sizeof(*packet->tx) * max_count;
1087 packet->tx = devm_kzalloc(&ts->spi->dev, size, GFP_KERNEL);
1091 packet->rx = devm_kzalloc(&ts->spi->dev, size, GFP_KERNEL);
1095 if (ts->model == 7873) {
1097 * The AD7873 is almost identical to the ADS7846
1098 * keep VREF off during differential/ratiometric
1106 spi_message_init(m);
1109 for (cmd_idx = 0; cmd_idx < packet->cmds; cmd_idx++) {
1110 struct ads7846_buf_layout *l = &packet->l[cmd_idx];
1113 if (cmd_idx == packet->cmds - 1)
1114 cmd_idx = ADS7846_PWDOWN;
1116 cmd = ads7846_get_cmd(cmd_idx, vref);
1118 for (b = 0; b < l->count; b++)
1119 packet->tx[l->offset + b].cmd = cmd;
1122 x->tx_buf = packet->tx;
1123 x->rx_buf = packet->rx;
1125 spi_message_add_tail(x, m);
1131 static const struct of_device_id ads7846_dt_ids[] = {
1132 { .compatible = "ti,tsc2046", .data = (void *) 7846 },
1133 { .compatible = "ti,ads7843", .data = (void *) 7843 },
1134 { .compatible = "ti,ads7845", .data = (void *) 7845 },
1135 { .compatible = "ti,ads7846", .data = (void *) 7846 },
1136 { .compatible = "ti,ads7873", .data = (void *) 7873 },
1139 MODULE_DEVICE_TABLE(of, ads7846_dt_ids);
1141 static const struct ads7846_platform_data *ads7846_probe_dt(struct device *dev)
1143 struct ads7846_platform_data *pdata;
1144 struct device_node *node = dev->of_node;
1145 const struct of_device_id *match;
1149 dev_err(dev, "Device does not have associated DT data\n");
1150 return ERR_PTR(-EINVAL);
1153 match = of_match_device(ads7846_dt_ids, dev);
1155 dev_err(dev, "Unknown device model\n");
1156 return ERR_PTR(-EINVAL);
1159 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
1161 return ERR_PTR(-ENOMEM);
1163 pdata->model = (unsigned long)match->data;
1165 of_property_read_u16(node, "ti,vref-delay-usecs",
1166 &pdata->vref_delay_usecs);
1167 of_property_read_u16(node, "ti,vref-mv", &pdata->vref_mv);
1168 pdata->keep_vref_on = of_property_read_bool(node, "ti,keep-vref-on");
1170 pdata->swap_xy = of_property_read_bool(node, "ti,swap-xy");
1172 of_property_read_u16(node, "ti,settle-delay-usec",
1173 &pdata->settle_delay_usecs);
1174 of_property_read_u16(node, "ti,penirq-recheck-delay-usecs",
1175 &pdata->penirq_recheck_delay_usecs);
1177 of_property_read_u16(node, "ti,x-plate-ohms", &pdata->x_plate_ohms);
1178 of_property_read_u16(node, "ti,y-plate-ohms", &pdata->y_plate_ohms);
1180 of_property_read_u16(node, "ti,x-min", &pdata->x_min);
1181 of_property_read_u16(node, "ti,y-min", &pdata->y_min);
1182 of_property_read_u16(node, "ti,x-max", &pdata->x_max);
1183 of_property_read_u16(node, "ti,y-max", &pdata->y_max);
1186 * touchscreen-max-pressure gets parsed during
1187 * touchscreen_parse_properties()
1189 of_property_read_u16(node, "ti,pressure-min", &pdata->pressure_min);
1190 if (!of_property_read_u32(node, "touchscreen-min-pressure", &value))
1191 pdata->pressure_min = (u16) value;
1192 of_property_read_u16(node, "ti,pressure-max", &pdata->pressure_max);
1194 of_property_read_u16(node, "ti,debounce-max", &pdata->debounce_max);
1195 if (!of_property_read_u32(node, "touchscreen-average-samples", &value))
1196 pdata->debounce_max = (u16) value;
1197 of_property_read_u16(node, "ti,debounce-tol", &pdata->debounce_tol);
1198 of_property_read_u16(node, "ti,debounce-rep", &pdata->debounce_rep);
1200 of_property_read_u32(node, "ti,pendown-gpio-debounce",
1201 &pdata->gpio_pendown_debounce);
1203 pdata->wakeup = of_property_read_bool(node, "wakeup-source") ||
1204 of_property_read_bool(node, "linux,wakeup");
1206 pdata->gpio_pendown = of_get_named_gpio(dev->of_node, "pendown-gpio", 0);
1211 static const struct ads7846_platform_data *ads7846_probe_dt(struct device *dev)
1213 dev_err(dev, "no platform data defined\n");
1214 return ERR_PTR(-EINVAL);
1218 static int ads7846_probe(struct spi_device *spi)
1220 const struct ads7846_platform_data *pdata;
1222 struct ads7846_packet *packet;
1223 struct input_dev *input_dev;
1224 unsigned long irq_flags;
1228 dev_dbg(&spi->dev, "no IRQ?\n");
1232 /* don't exceed max specified sample rate */
1233 if (spi->max_speed_hz > (125000 * SAMPLE_BITS)) {
1234 dev_err(&spi->dev, "f(sample) %d KHz?\n",
1235 (spi->max_speed_hz/SAMPLE_BITS)/1000);
1240 * We'd set TX word size 8 bits and RX word size to 13 bits ... except
1241 * that even if the hardware can do that, the SPI controller driver
1242 * may not. So we stick to very-portable 8 bit words, both RX and TX.
1244 spi->bits_per_word = 8;
1245 spi->mode = SPI_MODE_0;
1246 err = spi_setup(spi);
1250 ts = kzalloc(sizeof(struct ads7846), GFP_KERNEL);
1251 packet = kzalloc(sizeof(struct ads7846_packet), GFP_KERNEL);
1252 input_dev = input_allocate_device();
1253 if (!ts || !packet || !input_dev) {
1258 spi_set_drvdata(spi, ts);
1260 ts->packet = packet;
1262 ts->input = input_dev;
1264 mutex_init(&ts->lock);
1265 init_waitqueue_head(&ts->wait);
1267 pdata = dev_get_platdata(&spi->dev);
1269 pdata = ads7846_probe_dt(&spi->dev);
1270 if (IS_ERR(pdata)) {
1271 err = PTR_ERR(pdata);
1276 ts->model = pdata->model ? : 7846;
1277 ts->vref_delay_usecs = pdata->vref_delay_usecs ? : 100;
1278 ts->x_plate_ohms = pdata->x_plate_ohms ? : 400;
1279 ts->vref_mv = pdata->vref_mv;
1281 if (pdata->filter != NULL) {
1282 if (pdata->filter_init != NULL) {
1283 err = pdata->filter_init(pdata, &ts->filter_data);
1287 ts->filter = pdata->filter;
1288 ts->filter_cleanup = pdata->filter_cleanup;
1289 } else if (pdata->debounce_max) {
1290 ts->debounce_max = pdata->debounce_max;
1291 if (ts->debounce_max < 2)
1292 ts->debounce_max = 2;
1293 ts->debounce_tol = pdata->debounce_tol;
1294 ts->debounce_rep = pdata->debounce_rep;
1295 ts->filter = ads7846_debounce_filter;
1296 ts->filter_data = ts;
1298 ts->filter = ads7846_no_filter;
1301 err = ads7846_setup_pendown(spi, ts, pdata);
1303 goto err_cleanup_filter;
1305 if (pdata->penirq_recheck_delay_usecs)
1306 ts->penirq_recheck_delay_usecs =
1307 pdata->penirq_recheck_delay_usecs;
1309 ts->wait_for_sync = pdata->wait_for_sync ? : null_wait_for_sync;
1311 snprintf(ts->phys, sizeof(ts->phys), "%s/input0", dev_name(&spi->dev));
1312 snprintf(ts->name, sizeof(ts->name), "ADS%d Touchscreen", ts->model);
1314 input_dev->name = ts->name;
1315 input_dev->phys = ts->phys;
1316 input_dev->dev.parent = &spi->dev;
1318 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
1319 input_dev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
1320 input_set_abs_params(input_dev, ABS_X,
1322 pdata->x_max ? : MAX_12BIT,
1324 input_set_abs_params(input_dev, ABS_Y,
1326 pdata->y_max ? : MAX_12BIT,
1328 if (ts->model != 7845)
1329 input_set_abs_params(input_dev, ABS_PRESSURE,
1330 pdata->pressure_min, pdata->pressure_max, 0, 0);
1333 * Parse common framework properties. Must be done here to ensure the
1334 * correct behaviour in case of using the legacy vendor bindings. The
1335 * general binding value overrides the vendor specific one.
1337 touchscreen_parse_properties(ts->input, false, &ts->core_prop);
1338 ts->pressure_max = input_abs_get_max(input_dev, ABS_PRESSURE) ? : ~0;
1341 * Check if legacy ti,swap-xy binding is used instead of
1342 * touchscreen-swapped-x-y
1344 if (!ts->core_prop.swap_x_y && pdata->swap_xy) {
1345 swap(input_dev->absinfo[ABS_X], input_dev->absinfo[ABS_Y]);
1346 ts->core_prop.swap_x_y = true;
1349 ads7846_setup_spi_msg(ts, pdata);
1351 ts->reg = regulator_get(&spi->dev, "vcc");
1352 if (IS_ERR(ts->reg)) {
1353 err = PTR_ERR(ts->reg);
1354 dev_err(&spi->dev, "unable to get regulator: %d\n", err);
1358 err = regulator_enable(ts->reg);
1360 dev_err(&spi->dev, "unable to enable regulator: %d\n", err);
1361 goto err_put_regulator;
1364 irq_flags = pdata->irq_flags ? : IRQF_TRIGGER_FALLING;
1365 irq_flags |= IRQF_ONESHOT;
1367 err = request_threaded_irq(spi->irq, ads7846_hard_irq, ads7846_irq,
1368 irq_flags, spi->dev.driver->name, ts);
1369 if (err && !pdata->irq_flags) {
1371 "trying pin change workaround on irq %d\n", spi->irq);
1372 irq_flags |= IRQF_TRIGGER_RISING;
1373 err = request_threaded_irq(spi->irq,
1374 ads7846_hard_irq, ads7846_irq,
1375 irq_flags, spi->dev.driver->name, ts);
1379 dev_dbg(&spi->dev, "irq %d busy?\n", spi->irq);
1380 goto err_disable_regulator;
1383 err = ads784x_hwmon_register(spi, ts);
1387 dev_info(&spi->dev, "touchscreen, irq %d\n", spi->irq);
1390 * Take a first sample, leaving nPENIRQ active and vREF off; avoid
1391 * the touchscreen, in case it's not connected.
1393 if (ts->model == 7845)
1394 ads7845_read12_ser(&spi->dev, PWRDOWN);
1396 (void) ads7846_read12_ser(&spi->dev, READ_12BIT_SER(vaux));
1398 err = sysfs_create_group(&spi->dev.kobj, &ads784x_attr_group);
1400 goto err_remove_hwmon;
1402 err = input_register_device(input_dev);
1404 goto err_remove_attr_group;
1406 device_init_wakeup(&spi->dev, pdata->wakeup);
1409 * If device does not carry platform data we must have allocated it
1410 * when parsing DT data.
1412 if (!dev_get_platdata(&spi->dev))
1413 devm_kfree(&spi->dev, (void *)pdata);
1417 err_remove_attr_group:
1418 sysfs_remove_group(&spi->dev.kobj, &ads784x_attr_group);
1420 ads784x_hwmon_unregister(spi, ts);
1422 free_irq(spi->irq, ts);
1423 err_disable_regulator:
1424 regulator_disable(ts->reg);
1426 regulator_put(ts->reg);
1428 if (!ts->get_pendown_state)
1429 gpio_free(ts->gpio_pendown);
1431 if (ts->filter_cleanup)
1432 ts->filter_cleanup(ts->filter_data);
1434 input_free_device(input_dev);
1440 static int ads7846_remove(struct spi_device *spi)
1442 struct ads7846 *ts = spi_get_drvdata(spi);
1444 sysfs_remove_group(&spi->dev.kobj, &ads784x_attr_group);
1446 ads7846_disable(ts);
1447 free_irq(ts->spi->irq, ts);
1449 input_unregister_device(ts->input);
1451 ads784x_hwmon_unregister(spi, ts);
1453 regulator_put(ts->reg);
1455 if (!ts->get_pendown_state) {
1457 * If we are not using specialized pendown method we must
1458 * have been relying on gpio we set up ourselves.
1460 gpio_free(ts->gpio_pendown);
1463 if (ts->filter_cleanup)
1464 ts->filter_cleanup(ts->filter_data);
1469 dev_dbg(&spi->dev, "unregistered touchscreen\n");
1474 static struct spi_driver ads7846_driver = {
1478 .of_match_table = of_match_ptr(ads7846_dt_ids),
1480 .probe = ads7846_probe,
1481 .remove = ads7846_remove,
1484 module_spi_driver(ads7846_driver);
1486 MODULE_DESCRIPTION("ADS7846 TouchScreen Driver");
1487 MODULE_LICENSE("GPL");
1488 MODULE_ALIAS("spi:ads7846");