]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/input/touchscreen/ads7846.c
[PATCH] hrtimers: namespace and enum cleanup
[mirror_ubuntu-bionic-kernel.git] / drivers / input / touchscreen / ads7846.c
CommitLineData
ffa458c1
DB
1/*
2 * ADS7846 based touchscreen and sensor driver
3 *
4 * Copyright (c) 2005 David Brownell
7de90a8c
ID
5 * Copyright (c) 2006 Nokia Corporation
6 * Various changes: Imre Deak <imre.deak@nokia.com>
ffa458c1
DB
7 *
8 * Using code from:
9 * - corgi_ts.c
10 * Copyright (C) 2004-2005 Richard Purdie
11 * - omap_ts.[hc], ads7846.h, ts_osk.c
12 * Copyright (C) 2002 MontaVista Software
13 * Copyright (C) 2004 Texas Instruments
14 * Copyright (C) 2005 Dirk Behme
15 *
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License version 2 as
18 * published by the Free Software Foundation.
19 */
2c8dc071 20#include <linux/hwmon.h>
ffa458c1 21#include <linux/init.h>
2c8dc071 22#include <linux/err.h>
ffa458c1
DB
23#include <linux/delay.h>
24#include <linux/input.h>
25#include <linux/interrupt.h>
26#include <linux/slab.h>
27#include <linux/spi/spi.h>
28#include <linux/spi/ads7846.h>
3ac8bf07 29#include <asm/irq.h>
ffa458c1
DB
30
31#ifdef CONFIG_ARM
32#include <asm/mach-types.h>
33#ifdef CONFIG_ARCH_OMAP
34#include <asm/arch/gpio.h>
35#endif
ffa458c1
DB
36#endif
37
38
39/*
9084533e
DB
40 * This code has been heavily tested on a Nokia 770, and lightly
41 * tested on other ads7846 devices (OSK/Mistral, Lubbock).
ffa458c1
DB
42 * Support for ads7843 and ads7845 has only been stubbed in.
43 *
7de90a8c
ID
44 * IRQ handling needs a workaround because of a shortcoming in handling
45 * edge triggered IRQs on some platforms like the OMAP1/2. These
46 * platforms don't handle the ARM lazy IRQ disabling properly, thus we
47 * have to maintain our own SW IRQ disabled status. This should be
48 * removed as soon as the affected platform's IRQ handling is fixed.
49 *
ffa458c1
DB
50 * app note sbaa036 talks in more detail about accurate sampling...
51 * that ought to help in situations like LCDs inducing noise (which
52 * can also be helped by using synch signals) and more generally.
7de90a8c
ID
53 * This driver tries to utilize the measures described in the app
54 * note. The strength of filtering can be set in the board-* specific
55 * files.
ffa458c1
DB
56 */
57
1936d590
ID
58#define TS_POLL_DELAY (1 * 1000000) /* ns delay before the first sample */
59#define TS_POLL_PERIOD (5 * 1000000) /* ns delay between samples */
ffa458c1 60
d93f70b2
DB
61/* this driver doesn't aim at the peak continuous sample rate */
62#define SAMPLE_BITS (8 /*cmd*/ + 16 /*sample*/ + 2 /* before, after */)
63
ffa458c1
DB
64struct ts_event {
65 /* For portability, we can't read 12 bit values using SPI (which
66 * would make the controller deliver them as native byteorder u16
d93f70b2 67 * with msbs zeroed). Instead, we read them as two 8-bit values,
da970e69 68 * *** WHICH NEED BYTESWAPPING *** and range adjustment.
ffa458c1 69 */
da970e69
ID
70 u16 x;
71 u16 y;
72 u16 z1, z2;
2c8dc071 73 int ignore;
ffa458c1
DB
74};
75
76struct ads7846 {
a90f7e98 77 struct input_dev *input;
ffa458c1
DB
78 char phys[32];
79
80 struct spi_device *spi;
2c8dc071
DB
81
82#if defined(CONFIG_HWMON) || defined(CONFIG_HWMON_MODULE)
8dd51650 83 struct attribute_group *attr_group;
2c8dc071
DB
84 struct class_device *hwmon;
85#endif
86
ffa458c1
DB
87 u16 model;
88 u16 vref_delay_usecs;
89 u16 x_plate_ohms;
d5b415c9 90 u16 pressure_max;
ffa458c1 91
53a0ef89
ID
92 u8 read_x, read_y, read_z1, read_z2, pwrdown;
93 u16 dummy; /* for the pwrdown read */
ffa458c1
DB
94 struct ts_event tc;
95
53a0ef89 96 struct spi_transfer xfer[10];
0b7018aa 97 struct spi_message msg[5];
d5b415c9 98 struct spi_message *last_msg;
0b7018aa
ID
99 int msg_idx;
100 int read_cnt;
d5b415c9 101 int read_rep;
0b7018aa
ID
102 int last_read;
103
104 u16 debounce_max;
105 u16 debounce_tol;
d5b415c9 106 u16 debounce_rep;
ffa458c1
DB
107
108 spinlock_t lock;
1936d590 109 struct hrtimer timer;
ffa458c1
DB
110 unsigned pendown:1; /* P: lock */
111 unsigned pending:1; /* P: lock */
112// FIXME remove "irq_disabled"
113 unsigned irq_disabled:1; /* P: lock */
7de90a8c 114 unsigned disabled:1;
c9e617a5 115
da970e69
ID
116 int (*filter)(void *data, int data_idx, int *val);
117 void *filter_data;
118 void (*filter_cleanup)(void *data);
c9e617a5 119 int (*get_pendown_state)(void);
ffa458c1
DB
120};
121
122/* leave chip selected when we're done, for quicker re-select? */
123#if 0
124#define CS_CHANGE(xfer) ((xfer).cs_change = 1)
125#else
126#define CS_CHANGE(xfer) ((xfer).cs_change = 0)
127#endif
128
129/*--------------------------------------------------------------------------*/
130
131/* The ADS7846 has touchscreen and other sensors.
132 * Earlier ads784x chips are somewhat compatible.
133 */
134#define ADS_START (1 << 7)
135#define ADS_A2A1A0_d_y (1 << 4) /* differential */
136#define ADS_A2A1A0_d_z1 (3 << 4) /* differential */
137#define ADS_A2A1A0_d_z2 (4 << 4) /* differential */
138#define ADS_A2A1A0_d_x (5 << 4) /* differential */
139#define ADS_A2A1A0_temp0 (0 << 4) /* non-differential */
140#define ADS_A2A1A0_vbatt (2 << 4) /* non-differential */
141#define ADS_A2A1A0_vaux (6 << 4) /* non-differential */
142#define ADS_A2A1A0_temp1 (7 << 4) /* non-differential */
143#define ADS_8_BIT (1 << 3)
144#define ADS_12_BIT (0 << 3)
145#define ADS_SER (1 << 2) /* non-differential */
146#define ADS_DFR (0 << 2) /* differential */
147#define ADS_PD10_PDOWN (0 << 0) /* lowpower mode + penirq */
148#define ADS_PD10_ADC_ON (1 << 0) /* ADC on */
149#define ADS_PD10_REF_ON (2 << 0) /* vREF on + penirq */
150#define ADS_PD10_ALL_ON (3 << 0) /* ADC + vREF on */
151
152#define MAX_12BIT ((1<<12)-1)
153
154/* leave ADC powered up (disables penirq) between differential samples */
de2defd9
ID
155#define READ_12BIT_DFR(x, adc, vref) (ADS_START | ADS_A2A1A0_d_ ## x \
156 | ADS_12_BIT | ADS_DFR | \
157 (adc ? ADS_PD10_ADC_ON : 0) | (vref ? ADS_PD10_REF_ON : 0))
ffa458c1 158
de2defd9
ID
159#define READ_Y(vref) (READ_12BIT_DFR(y, 1, vref))
160#define READ_Z1(vref) (READ_12BIT_DFR(z1, 1, vref))
161#define READ_Z2(vref) (READ_12BIT_DFR(z2, 1, vref))
53a0ef89 162
de2defd9
ID
163#define READ_X(vref) (READ_12BIT_DFR(x, 1, vref))
164#define PWRDOWN (READ_12BIT_DFR(y, 0, 0)) /* LAST */
ffa458c1
DB
165
166/* single-ended samples need to first power up reference voltage;
167 * we leave both ADC and VREF powered
168 */
169#define READ_12BIT_SER(x) (ADS_START | ADS_A2A1A0_ ## x \
170 | ADS_12_BIT | ADS_SER)
171
de2defd9
ID
172#define REF_ON (READ_12BIT_DFR(x, 1, 1))
173#define REF_OFF (READ_12BIT_DFR(y, 0, 0))
ffa458c1
DB
174
175/*--------------------------------------------------------------------------*/
176
177/*
178 * Non-touchscreen sensors only use single-ended conversions.
2c8dc071
DB
179 * The range is GND..vREF. The ads7843 and ads7835 must use external vREF;
180 * ads7846 lets that pin be unconnected, to use internal vREF.
ffa458c1 181 */
2c8dc071
DB
182static unsigned vREF_mV;
183module_param(vREF_mV, uint, 0);
184MODULE_PARM_DESC(vREF_mV, "external vREF voltage, in milliVolts");
ffa458c1
DB
185
186struct ser_req {
d93f70b2 187 u8 ref_on;
ffa458c1 188 u8 command;
d93f70b2 189 u8 ref_off;
ffa458c1
DB
190 u16 scratch;
191 __be16 sample;
192 struct spi_message msg;
193 struct spi_transfer xfer[6];
194};
195
7de90a8c
ID
196static void ads7846_enable(struct ads7846 *ts);
197static void ads7846_disable(struct ads7846 *ts);
198
c9e617a5
ID
199static int device_suspended(struct device *dev)
200{
201 struct ads7846 *ts = dev_get_drvdata(dev);
202 return dev->power.power_state.event != PM_EVENT_ON || ts->disabled;
203}
204
ffa458c1
DB
205static int ads7846_read12_ser(struct device *dev, unsigned command)
206{
207 struct spi_device *spi = to_spi_device(dev);
208 struct ads7846 *ts = dev_get_drvdata(dev);
e94b1766 209 struct ser_req *req = kzalloc(sizeof *req, GFP_KERNEL);
ffa458c1
DB
210 int status;
211 int sample;
2c8dc071 212 int use_internal;
ffa458c1
DB
213
214 if (!req)
215 return -ENOMEM;
216
0b7018aa 217 spi_message_init(&req->msg);
8275c642 218
2c8dc071
DB
219 /* FIXME boards with ads7846 might use external vref instead ... */
220 use_internal = (ts->model == 7846);
221
222 /* maybe turn on internal vREF, and let it settle */
223 if (use_internal) {
224 req->ref_on = REF_ON;
225 req->xfer[0].tx_buf = &req->ref_on;
226 req->xfer[0].len = 1;
227 spi_message_add_tail(&req->xfer[0], &req->msg);
228
229 req->xfer[1].rx_buf = &req->scratch;
230 req->xfer[1].len = 2;
231
232 /* for 1uF, settle for 800 usec; no cap, 100 usec. */
233 req->xfer[1].delay_usecs = ts->vref_delay_usecs;
234 spi_message_add_tail(&req->xfer[1], &req->msg);
235 }
ffa458c1
DB
236
237 /* take sample */
238 req->command = (u8) command;
239 req->xfer[2].tx_buf = &req->command;
240 req->xfer[2].len = 1;
2c8dc071
DB
241 spi_message_add_tail(&req->xfer[2], &req->msg);
242
ffa458c1
DB
243 req->xfer[3].rx_buf = &req->sample;
244 req->xfer[3].len = 2;
2c8dc071 245 spi_message_add_tail(&req->xfer[3], &req->msg);
ffa458c1
DB
246
247 /* REVISIT: take a few more samples, and compare ... */
248
2c8dc071
DB
249 /* maybe off internal vREF */
250 if (use_internal) {
251 req->ref_off = REF_OFF;
252 req->xfer[4].tx_buf = &req->ref_off;
253 req->xfer[4].len = 1;
254 spi_message_add_tail(&req->xfer[4], &req->msg);
255
256 req->xfer[5].rx_buf = &req->scratch;
257 req->xfer[5].len = 2;
258 CS_CHANGE(req->xfer[5]);
259 spi_message_add_tail(&req->xfer[5], &req->msg);
260 }
ffa458c1 261
c9e617a5 262 ts->irq_disabled = 1;
ffa458c1
DB
263 disable_irq(spi->irq);
264 status = spi_sync(spi, &req->msg);
c9e617a5 265 ts->irq_disabled = 0;
ffa458c1
DB
266 enable_irq(spi->irq);
267
268 if (req->msg.status)
269 status = req->msg.status;
9084533e
DB
270
271 /* on-wire is a must-ignore bit, a BE12 value, then padding */
ffa458c1 272 sample = be16_to_cpu(req->sample);
9084533e
DB
273 sample = sample >> 3;
274 sample &= 0x0fff;
ffa458c1 275
9084533e 276 kfree(req);
ffa458c1
DB
277 return status ? status : sample;
278}
279
2c8dc071
DB
280#if defined(CONFIG_HWMON) || defined(CONFIG_HWMON_MODULE)
281
282#define SHOW(name, var, adjust) static ssize_t \
ffa458c1
DB
283name ## _show(struct device *dev, struct device_attribute *attr, char *buf) \
284{ \
2c8dc071 285 struct ads7846 *ts = dev_get_drvdata(dev); \
ffa458c1 286 ssize_t v = ads7846_read12_ser(dev, \
2c8dc071 287 READ_12BIT_SER(var) | ADS_PD10_ALL_ON); \
ffa458c1
DB
288 if (v < 0) \
289 return v; \
2c8dc071 290 return sprintf(buf, "%u\n", adjust(ts, v)); \
ffa458c1
DB
291} \
292static DEVICE_ATTR(name, S_IRUGO, name ## _show, NULL);
293
2c8dc071
DB
294
295/* Sysfs conventions report temperatures in millidegrees Celcius.
296 * ADS7846 could use the low-accuracy two-sample scheme, but can't do the high
297 * accuracy scheme without calibration data. For now we won't try either;
298 * userspace sees raw sensor values, and must scale/calibrate appropriately.
299 */
300static inline unsigned null_adjust(struct ads7846 *ts, ssize_t v)
301{
302 return v;
303}
304
305SHOW(temp0, temp0, null_adjust) /* temp1_input */
306SHOW(temp1, temp1, null_adjust) /* temp2_input */
307
308
309/* sysfs conventions report voltages in millivolts. We can convert voltages
310 * if we know vREF. userspace may need to scale vAUX to match the board's
311 * external resistors; we assume that vBATT only uses the internal ones.
312 */
313static inline unsigned vaux_adjust(struct ads7846 *ts, ssize_t v)
314{
315 unsigned retval = v;
316
317 /* external resistors may scale vAUX into 0..vREF */
318 retval *= vREF_mV;
319 retval = retval >> 12;
320 return retval;
321}
322
323static inline unsigned vbatt_adjust(struct ads7846 *ts, ssize_t v)
324{
325 unsigned retval = vaux_adjust(ts, v);
326
327 /* ads7846 has a resistor ladder to scale this signal down */
328 if (ts->model == 7846)
329 retval *= 4;
330 return retval;
331}
332
333SHOW(in0_input, vaux, vaux_adjust)
334SHOW(in1_input, vbatt, vbatt_adjust)
335
336
337static struct attribute *ads7846_attributes[] = {
338 &dev_attr_temp0.attr,
339 &dev_attr_temp1.attr,
340 &dev_attr_in0_input.attr,
341 &dev_attr_in1_input.attr,
342 NULL,
343};
344
345static struct attribute_group ads7846_attr_group = {
346 .attrs = ads7846_attributes,
347};
348
349static struct attribute *ads7843_attributes[] = {
350 &dev_attr_in0_input.attr,
351 &dev_attr_in1_input.attr,
352 NULL,
353};
354
355static struct attribute_group ads7843_attr_group = {
356 .attrs = ads7843_attributes,
357};
358
359static struct attribute *ads7845_attributes[] = {
360 &dev_attr_in0_input.attr,
361 NULL,
362};
363
364static struct attribute_group ads7845_attr_group = {
365 .attrs = ads7845_attributes,
366};
367
368static int ads784x_hwmon_register(struct spi_device *spi, struct ads7846 *ts)
369{
370 struct class_device *hwmon;
371 int err;
372
373 /* hwmon sensors need a reference voltage */
374 switch (ts->model) {
375 case 7846:
376 if (!vREF_mV) {
377 dev_dbg(&spi->dev, "assuming 2.5V internal vREF\n");
378 vREF_mV = 2500;
379 }
380 break;
381 case 7845:
382 case 7843:
383 if (!vREF_mV) {
384 dev_warn(&spi->dev,
385 "external vREF for ADS%d not specified\n",
386 ts->model);
387 return 0;
388 }
389 break;
390 }
391
392 /* different chips have different sensor groups */
393 switch (ts->model) {
394 case 7846:
395 ts->attr_group = &ads7846_attr_group;
396 break;
397 case 7845:
398 ts->attr_group = &ads7845_attr_group;
399 break;
400 case 7843:
401 ts->attr_group = &ads7843_attr_group;
402 break;
403 default:
404 dev_dbg(&spi->dev, "ADS%d not recognized\n", ts->model);
405 return 0;
406 }
407
408 err = sysfs_create_group(&spi->dev.kobj, ts->attr_group);
409 if (err)
410 return err;
411
412 hwmon = hwmon_device_register(&spi->dev);
413 if (IS_ERR(hwmon)) {
414 sysfs_remove_group(&spi->dev.kobj, ts->attr_group);
415 return PTR_ERR(hwmon);
416 }
417
418 ts->hwmon = hwmon;
419 return 0;
420}
421
422static void ads784x_hwmon_unregister(struct spi_device *spi,
423 struct ads7846 *ts)
424{
425 if (ts->hwmon) {
426 sysfs_remove_group(&spi->dev.kobj, ts->attr_group);
427 hwmon_device_unregister(ts->hwmon);
428 }
429}
430
431#else
432static inline int ads784x_hwmon_register(struct spi_device *spi,
433 struct ads7846 *ts)
434{
435 return 0;
436}
437
438static inline void ads784x_hwmon_unregister(struct spi_device *spi,
439 struct ads7846 *ts)
440{
441}
442#endif
ffa458c1 443
438f2a74
ID
444static int is_pen_down(struct device *dev)
445{
2c8dc071 446 struct ads7846 *ts = dev_get_drvdata(dev);
438f2a74
ID
447
448 return ts->pendown;
449}
450
451static ssize_t ads7846_pen_down_show(struct device *dev,
452 struct device_attribute *attr, char *buf)
453{
454 return sprintf(buf, "%u\n", is_pen_down(dev));
455}
456
457static DEVICE_ATTR(pen_down, S_IRUGO, ads7846_pen_down_show, NULL);
458
7de90a8c
ID
459static ssize_t ads7846_disable_show(struct device *dev,
460 struct device_attribute *attr, char *buf)
461{
462 struct ads7846 *ts = dev_get_drvdata(dev);
463
464 return sprintf(buf, "%u\n", ts->disabled);
465}
466
467static ssize_t ads7846_disable_store(struct device *dev,
468 struct device_attribute *attr,
469 const char *buf, size_t count)
470{
471 struct ads7846 *ts = dev_get_drvdata(dev);
472 char *endp;
473 int i;
474
475 i = simple_strtoul(buf, &endp, 10);
476 spin_lock_irq(&ts->lock);
477
478 if (i)
479 ads7846_disable(ts);
480 else
481 ads7846_enable(ts);
482
483 spin_unlock_irq(&ts->lock);
484
485 return count;
486}
487
488static DEVICE_ATTR(disable, 0664, ads7846_disable_show, ads7846_disable_store);
489
2c8dc071 490static struct attribute *ads784x_attributes[] = {
8dd51650
DT
491 &dev_attr_pen_down.attr,
492 &dev_attr_disable.attr,
493 NULL,
494};
495
2c8dc071
DB
496static struct attribute_group ads784x_attr_group = {
497 .attrs = ads784x_attributes,
8dd51650
DT
498};
499
ffa458c1
DB
500/*--------------------------------------------------------------------------*/
501
502/*
503 * PENIRQ only kicks the timer. The timer only reissues the SPI transfer,
504 * to retrieve touchscreen status.
505 *
506 * The SPI transfer completion callback does the real work. It reports
507 * touchscreen events and reactivates the timer (or IRQ) as appropriate.
508 */
509
510static void ads7846_rx(void *ads)
511{
a90f7e98 512 struct ads7846 *ts = ads;
a90f7e98 513 unsigned Rt;
a90f7e98 514 u16 x, y, z1, z2;
ffa458c1 515
da970e69
ID
516 /* ads7846_rx_val() did in-place conversion (including byteswap) from
517 * on-the-wire format as part of debouncing to get stable readings.
ffa458c1 518 */
da970e69
ID
519 x = ts->tc.x;
520 y = ts->tc.y;
521 z1 = ts->tc.z1;
522 z2 = ts->tc.z2;
ffa458c1
DB
523
524 /* range filtering */
525 if (x == MAX_12BIT)
526 x = 0;
527
15e3589e 528 if (likely(x && z1)) {
ffa458c1
DB
529 /* compute touch pressure resistance using equation #2 */
530 Rt = z2;
531 Rt -= z1;
532 Rt *= x;
533 Rt *= ts->x_plate_ohms;
534 Rt /= z1;
535 Rt = (Rt + 2047) >> 12;
536 } else
537 Rt = 0;
538
d5b415c9 539 /* Sample found inconsistent by debouncing or pressure is beyond
1936d590
ID
540 * the maximum. Don't report it to user space, repeat at least
541 * once more the measurement
542 */
d5b415c9 543 if (ts->tc.ignore || Rt > ts->pressure_max) {
15e3589e
ID
544#ifdef VERBOSE
545 pr_debug("%s: ignored %d pressure %d\n",
546 ts->spi->dev.bus_id, ts->tc.ignore, Rt);
547#endif
1936d590 548 hrtimer_start(&ts->timer, ktime_set(0, TS_POLL_PERIOD),
c9cb2e3d 549 HRTIMER_MODE_REL);
d5b415c9
ID
550 return;
551 }
552
15e3589e
ID
553 /* NOTE: We can't rely on the pressure to determine the pen down
554 * state, even this controller has a pressure sensor. The pressure
555 * value can fluctuate for quite a while after lifting the pen and
556 * in some cases may not even settle at the expected value.
ffa458c1 557 *
15e3589e
ID
558 * The only safe way to check for the pen up condition is in the
559 * timer by reading the pen signal state (it's a GPIO _and_ IRQ).
ffa458c1 560 */
ffa458c1 561 if (Rt) {
15e3589e 562 struct input_dev *input = ts->input;
ae82d5ab 563
15e3589e
ID
564 if (!ts->pendown) {
565 input_report_key(input, BTN_TOUCH, 1);
566 ts->pendown = 1;
567#ifdef VERBOSE
568 dev_dbg(&ts->spi->dev, "DOWN\n");
ffa458c1 569#endif
15e3589e
ID
570 }
571 input_report_abs(input, ABS_X, x);
572 input_report_abs(input, ABS_Y, y);
573 input_report_abs(input, ABS_PRESSURE, Rt);
ffa458c1 574
15e3589e
ID
575 input_sync(input);
576#ifdef VERBOSE
577 dev_dbg(&ts->spi->dev, "%4d/%4d/%4d\n", x, y, Rt);
578#endif
579 }
ffa458c1 580
c9cb2e3d
TG
581 hrtimer_start(&ts->timer, ktime_set(0, TS_POLL_PERIOD),
582 HRTIMER_MODE_REL);
ffa458c1
DB
583}
584
da970e69 585static int ads7846_debounce(void *ads, int data_idx, int *val)
0b7018aa
ID
586{
587 struct ads7846 *ts = ads;
0b7018aa 588
da970e69
ID
589 if (!ts->read_cnt || (abs(ts->last_read - *val) > ts->debounce_tol)) {
590 /* Start over collecting consistent readings. */
591 ts->read_rep = 0;
d5b415c9
ID
592 /* Repeat it, if this was the first read or the read
593 * wasn't consistent enough. */
594 if (ts->read_cnt < ts->debounce_max) {
da970e69 595 ts->last_read = *val;
d5b415c9 596 ts->read_cnt++;
da970e69 597 return ADS7846_FILTER_REPEAT;
d5b415c9
ID
598 } else {
599 /* Maximum number of debouncing reached and still
600 * not enough number of consistent readings. Abort
601 * the whole sample, repeat it in the next sampling
602 * period.
603 */
d5b415c9 604 ts->read_cnt = 0;
da970e69 605 return ADS7846_FILTER_IGNORE;
d5b415c9 606 }
0b7018aa 607 } else {
d5b415c9
ID
608 if (++ts->read_rep > ts->debounce_rep) {
609 /* Got a good reading for this coordinate,
610 * go for the next one. */
d5b415c9
ID
611 ts->read_cnt = 0;
612 ts->read_rep = 0;
da970e69
ID
613 return ADS7846_FILTER_OK;
614 } else {
d5b415c9
ID
615 /* Read more values that are consistent. */
616 ts->read_cnt++;
da970e69
ID
617 return ADS7846_FILTER_REPEAT;
618 }
619 }
620}
621
622static int ads7846_no_filter(void *ads, int data_idx, int *val)
623{
624 return ADS7846_FILTER_OK;
625}
626
627static void ads7846_rx_val(void *ads)
628{
629 struct ads7846 *ts = ads;
630 struct spi_message *m;
631 struct spi_transfer *t;
632 u16 *rx_val;
633 int val;
634 int action;
635 int status;
636
637 m = &ts->msg[ts->msg_idx];
638 t = list_entry(m->transfers.prev, struct spi_transfer, transfer_list);
639 rx_val = t->rx_buf;
640
641 /* adjust: on-wire is a must-ignore bit, a BE12 value, then padding;
642 * built from two 8 bit values written msb-first.
643 */
644 val = be16_to_cpu(*rx_val) >> 3;
645
646 action = ts->filter(ts->filter_data, ts->msg_idx, &val);
647 switch (action) {
648 case ADS7846_FILTER_REPEAT:
649 break;
650 case ADS7846_FILTER_IGNORE:
651 ts->tc.ignore = 1;
652 /* Last message will contain ads7846_rx() as the
653 * completion function.
654 */
655 m = ts->last_msg;
656 break;
657 case ADS7846_FILTER_OK:
658 *rx_val = val;
659 ts->tc.ignore = 0;
660 m = &ts->msg[++ts->msg_idx];
661 break;
662 default:
663 BUG();
0b7018aa
ID
664 }
665 status = spi_async(ts->spi, m);
666 if (status)
667 dev_err(&ts->spi->dev, "spi_async --> %d\n",
668 status);
669}
670
c9cb2e3d 671static enum hrtimer_restart ads7846_timer(struct hrtimer *handle)
ffa458c1 672{
1936d590 673 struct ads7846 *ts = container_of(handle, struct ads7846, timer);
ffa458c1 674 int status = 0;
0b7018aa 675
c9e617a5
ID
676 spin_lock_irq(&ts->lock);
677
15e3589e
ID
678 if (unlikely(!ts->get_pendown_state() ||
679 device_suspended(&ts->spi->dev))) {
680 if (ts->pendown) {
681 struct input_dev *input = ts->input;
682
683 input_report_key(input, BTN_TOUCH, 0);
684 input_report_abs(input, ABS_PRESSURE, 0);
685 input_sync(input);
686
687 ts->pendown = 0;
688#ifdef VERBOSE
689 dev_dbg(&ts->spi->dev, "UP\n");
690#endif
691 }
692
9084533e 693 /* measurement cycle ended */
c9e617a5
ID
694 if (!device_suspended(&ts->spi->dev)) {
695 ts->irq_disabled = 0;
696 enable_irq(ts->spi->irq);
697 }
698 ts->pending = 0;
c9e617a5
ID
699 } else {
700 /* pen is still down, continue with the measurement */
701 ts->msg_idx = 0;
702 status = spi_async(ts->spi, &ts->msg[0]);
703 if (status)
704 dev_err(&ts->spi->dev, "spi_async --> %d\n", status);
705 }
706
707 spin_unlock_irq(&ts->lock);
1936d590 708 return HRTIMER_NORESTART;
0b7018aa
ID
709}
710
7d12e780 711static irqreturn_t ads7846_irq(int irq, void *handle)
0b7018aa
ID
712{
713 struct ads7846 *ts = handle;
714 unsigned long flags;
ffa458c1
DB
715
716 spin_lock_irqsave(&ts->lock, flags);
c9e617a5 717 if (likely(ts->get_pendown_state())) {
ffa458c1 718 if (!ts->irq_disabled) {
9084533e
DB
719 /* The ARM do_simple_IRQ() dispatcher doesn't act
720 * like the other dispatchers: it will report IRQs
721 * even after they've been disabled. We work around
722 * that here. (The "generic irq" framework may help...)
0b7018aa 723 */
ffa458c1
DB
724 ts->irq_disabled = 1;
725 disable_irq(ts->spi->irq);
0b7018aa 726 ts->pending = 1;
1936d590 727 hrtimer_start(&ts->timer, ktime_set(0, TS_POLL_DELAY),
c9cb2e3d 728 HRTIMER_MODE_REL);
0b7018aa 729 }
ffa458c1
DB
730 }
731 spin_unlock_irqrestore(&ts->lock, flags);
7de90a8c
ID
732
733 return IRQ_HANDLED;
ffa458c1
DB
734}
735
736/*--------------------------------------------------------------------------*/
737
7de90a8c
ID
738/* Must be called with ts->lock held */
739static void ads7846_disable(struct ads7846 *ts)
ffa458c1 740{
7de90a8c
ID
741 if (ts->disabled)
742 return;
ffa458c1 743
c9e617a5
ID
744 ts->disabled = 1;
745
ffa458c1 746 /* are we waiting for IRQ, or polling? */
c9e617a5
ID
747 if (!ts->pending) {
748 ts->irq_disabled = 1;
749 disable_irq(ts->spi->irq);
ffa458c1 750 } else {
c9e617a5
ID
751 /* the timer will run at least once more, and
752 * leave everything in a clean state, IRQ disabled
ffa458c1 753 */
c9e617a5 754 while (ts->pending) {
7de90a8c 755 spin_unlock_irq(&ts->lock);
c4febb94 756 msleep(1);
7de90a8c 757 spin_lock_irq(&ts->lock);
ffa458c1
DB
758 }
759 }
760
761 /* we know the chip's in lowpower mode since we always
762 * leave it that way after every request
763 */
764
7de90a8c
ID
765}
766
767/* Must be called with ts->lock held */
768static void ads7846_enable(struct ads7846 *ts)
769{
770 if (!ts->disabled)
771 return;
772
773 ts->disabled = 0;
774 ts->irq_disabled = 0;
775 enable_irq(ts->spi->irq);
776}
777
778static int ads7846_suspend(struct spi_device *spi, pm_message_t message)
779{
780 struct ads7846 *ts = dev_get_drvdata(&spi->dev);
781
782 spin_lock_irq(&ts->lock);
783
784 spi->dev.power.power_state = message;
785 ads7846_disable(ts);
786
787 spin_unlock_irq(&ts->lock);
788
ffa458c1 789 return 0;
7de90a8c 790
ffa458c1
DB
791}
792
2e5a7bd9 793static int ads7846_resume(struct spi_device *spi)
ffa458c1 794{
2e5a7bd9 795 struct ads7846 *ts = dev_get_drvdata(&spi->dev);
ffa458c1 796
7de90a8c
ID
797 spin_lock_irq(&ts->lock);
798
2e5a7bd9 799 spi->dev.power.power_state = PMSG_ON;
7de90a8c
ID
800 ads7846_enable(ts);
801
802 spin_unlock_irq(&ts->lock);
803
ffa458c1
DB
804 return 0;
805}
806
2e5a7bd9 807static int __devinit ads7846_probe(struct spi_device *spi)
ffa458c1 808{
ffa458c1 809 struct ads7846 *ts;
a90f7e98 810 struct input_dev *input_dev;
2e5a7bd9 811 struct ads7846_platform_data *pdata = spi->dev.platform_data;
0b7018aa 812 struct spi_message *m;
ffa458c1 813 struct spi_transfer *x;
de2defd9 814 int vref;
a90f7e98 815 int err;
ffa458c1
DB
816
817 if (!spi->irq) {
2e5a7bd9 818 dev_dbg(&spi->dev, "no IRQ?\n");
ffa458c1
DB
819 return -ENODEV;
820 }
821
822 if (!pdata) {
2e5a7bd9 823 dev_dbg(&spi->dev, "no platform data?\n");
ffa458c1
DB
824 return -ENODEV;
825 }
826
827 /* don't exceed max specified sample rate */
d93f70b2 828 if (spi->max_speed_hz > (125000 * SAMPLE_BITS)) {
2e5a7bd9 829 dev_dbg(&spi->dev, "f(sample) %d KHz?\n",
d93f70b2 830 (spi->max_speed_hz/SAMPLE_BITS)/1000);
ffa458c1
DB
831 return -EINVAL;
832 }
833
9084533e
DB
834 /* REVISIT when the irq can be triggered active-low, or if for some
835 * reason the touchscreen isn't hooked up, we don't need to access
836 * the pendown state.
837 */
c9e617a5
ID
838 if (pdata->get_pendown_state == NULL) {
839 dev_dbg(&spi->dev, "no get_pendown_state function?\n");
840 return -EINVAL;
841 }
842
9084533e
DB
843 /* We'd set TX wordsize 8 bits and RX wordsize to 13 bits ... except
844 * that even if the hardware can do that, the SPI controller driver
845 * may not. So we stick to very-portable 8 bit words, both RX and TX.
ffa458c1 846 */
9084533e 847 spi->bits_per_word = 8;
7937e86a
ID
848 spi->mode = SPI_MODE_1;
849 err = spi_setup(spi);
850 if (err < 0)
851 return err;
ffa458c1 852
a90f7e98
DT
853 ts = kzalloc(sizeof(struct ads7846), GFP_KERNEL);
854 input_dev = input_allocate_device();
855 if (!ts || !input_dev) {
856 err = -ENOMEM;
857 goto err_free_mem;
858 }
ffa458c1 859
2e5a7bd9 860 dev_set_drvdata(&spi->dev, ts);
a90f7e98 861 spi->dev.power.power_state = PMSG_ON;
ffa458c1
DB
862
863 ts->spi = spi;
a90f7e98 864 ts->input = input_dev;
ffa458c1 865
c9cb2e3d 866 hrtimer_init(&ts->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
ffa458c1
DB
867 ts->timer.function = ads7846_timer;
868
7de90a8c
ID
869 spin_lock_init(&ts->lock);
870
ffa458c1
DB
871 ts->model = pdata->model ? : 7846;
872 ts->vref_delay_usecs = pdata->vref_delay_usecs ? : 100;
873 ts->x_plate_ohms = pdata->x_plate_ohms ? : 400;
d5b415c9 874 ts->pressure_max = pdata->pressure_max ? : ~0;
da970e69
ID
875
876 if (pdata->filter != NULL) {
877 if (pdata->filter_init != NULL) {
878 err = pdata->filter_init(pdata, &ts->filter_data);
879 if (err < 0)
880 goto err_free_mem;
881 }
882 ts->filter = pdata->filter;
883 ts->filter_cleanup = pdata->filter_cleanup;
884 } else if (pdata->debounce_max) {
d5b415c9 885 ts->debounce_max = pdata->debounce_max;
da970e69
ID
886 if (ts->debounce_max < 2)
887 ts->debounce_max = 2;
d5b415c9
ID
888 ts->debounce_tol = pdata->debounce_tol;
889 ts->debounce_rep = pdata->debounce_rep;
da970e69
ID
890 ts->filter = ads7846_debounce;
891 ts->filter_data = ts;
d5b415c9 892 } else
da970e69 893 ts->filter = ads7846_no_filter;
c9e617a5 894 ts->get_pendown_state = pdata->get_pendown_state;
ffa458c1 895
a90f7e98 896 snprintf(ts->phys, sizeof(ts->phys), "%s/input0", spi->dev.bus_id);
ffa458c1 897
a90f7e98
DT
898 input_dev->name = "ADS784x Touchscreen";
899 input_dev->phys = ts->phys;
900 input_dev->cdev.dev = &spi->dev;
ffa458c1 901
a90f7e98
DT
902 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
903 input_dev->keybit[LONG(BTN_TOUCH)] = BIT(BTN_TOUCH);
904 input_set_abs_params(input_dev, ABS_X,
ffa458c1
DB
905 pdata->x_min ? : 0,
906 pdata->x_max ? : MAX_12BIT,
907 0, 0);
a90f7e98 908 input_set_abs_params(input_dev, ABS_Y,
ffa458c1
DB
909 pdata->y_min ? : 0,
910 pdata->y_max ? : MAX_12BIT,
911 0, 0);
a90f7e98 912 input_set_abs_params(input_dev, ABS_PRESSURE,
ffa458c1
DB
913 pdata->pressure_min, pdata->pressure_max, 0, 0);
914
de2defd9
ID
915 vref = pdata->keep_vref_on;
916
ffa458c1
DB
917 /* set up the transfers to read touchscreen state; this assumes we
918 * use formula #2 for pressure, not #3.
919 */
0b7018aa 920 m = &ts->msg[0];
ffa458c1
DB
921 x = ts->xfer;
922
0b7018aa
ID
923 spi_message_init(m);
924
ffa458c1 925 /* y- still on; turn on only y+ (and ADC) */
de2defd9 926 ts->read_y = READ_Y(vref);
d93f70b2 927 x->tx_buf = &ts->read_y;
ffa458c1 928 x->len = 1;
0b7018aa 929 spi_message_add_tail(x, m);
d93f70b2 930
ffa458c1
DB
931 x++;
932 x->rx_buf = &ts->tc.y;
933 x->len = 2;
0b7018aa
ID
934 spi_message_add_tail(x, m);
935
da970e69 936 m->complete = ads7846_rx_val;
0b7018aa
ID
937 m->context = ts;
938
939 m++;
940 spi_message_init(m);
941
942 /* turn y- off, x+ on, then leave in lowpower */
943 x++;
de2defd9 944 ts->read_x = READ_X(vref);
0b7018aa
ID
945 x->tx_buf = &ts->read_x;
946 x->len = 1;
947 spi_message_add_tail(x, m);
948
949 x++;
950 x->rx_buf = &ts->tc.x;
951 x->len = 2;
952 spi_message_add_tail(x, m);
953
da970e69 954 m->complete = ads7846_rx_val;
0b7018aa 955 m->context = ts;
ffa458c1
DB
956
957 /* turn y+ off, x- on; we'll use formula #2 */
958 if (ts->model == 7846) {
0b7018aa
ID
959 m++;
960 spi_message_init(m);
961
d93f70b2 962 x++;
de2defd9 963 ts->read_z1 = READ_Z1(vref);
d93f70b2 964 x->tx_buf = &ts->read_z1;
ffa458c1 965 x->len = 1;
0b7018aa 966 spi_message_add_tail(x, m);
d93f70b2 967
ffa458c1
DB
968 x++;
969 x->rx_buf = &ts->tc.z1;
970 x->len = 2;
0b7018aa
ID
971 spi_message_add_tail(x, m);
972
da970e69 973 m->complete = ads7846_rx_val;
0b7018aa
ID
974 m->context = ts;
975
976 m++;
977 spi_message_init(m);
ffa458c1 978
d93f70b2 979 x++;
de2defd9 980 ts->read_z2 = READ_Z2(vref);
d93f70b2 981 x->tx_buf = &ts->read_z2;
ffa458c1 982 x->len = 1;
0b7018aa 983 spi_message_add_tail(x, m);
d93f70b2 984
ffa458c1
DB
985 x++;
986 x->rx_buf = &ts->tc.z2;
987 x->len = 2;
0b7018aa 988 spi_message_add_tail(x, m);
ffa458c1 989
da970e69 990 m->complete = ads7846_rx_val;
0b7018aa
ID
991 m->context = ts;
992 }
53a0ef89
ID
993
994 /* power down */
0b7018aa
ID
995 m++;
996 spi_message_init(m);
997
53a0ef89
ID
998 x++;
999 ts->pwrdown = PWRDOWN;
1000 x->tx_buf = &ts->pwrdown;
1001 x->len = 1;
0b7018aa 1002 spi_message_add_tail(x, m);
53a0ef89
ID
1003
1004 x++;
1005 x->rx_buf = &ts->dummy;
1006 x->len = 2;
d93f70b2 1007 CS_CHANGE(*x);
0b7018aa 1008 spi_message_add_tail(x, m);
ffa458c1 1009
0b7018aa
ID
1010 m->complete = ads7846_rx;
1011 m->context = ts;
ffa458c1 1012
d5b415c9
ID
1013 ts->last_msg = m;
1014
dace1453 1015 if (request_irq(spi->irq, ads7846_irq, IRQF_TRIGGER_FALLING,
9084533e 1016 spi->dev.driver->name, ts)) {
2e5a7bd9 1017 dev_dbg(&spi->dev, "irq %d busy?\n", spi->irq);
a90f7e98 1018 err = -EBUSY;
da970e69 1019 goto err_cleanup_filter;
ffa458c1 1020 }
ffa458c1 1021
2c8dc071
DB
1022 err = ads784x_hwmon_register(spi, ts);
1023 if (err)
1024 goto err_free_irq;
1025
2e5a7bd9 1026 dev_info(&spi->dev, "touchscreen, irq %d\n", spi->irq);
ffa458c1 1027
2c8dc071 1028 /* take a first sample, leaving nPENIRQ active and vREF off; avoid
ffa458c1
DB
1029 * the touchscreen, in case it's not connected.
1030 */
2e5a7bd9 1031 (void) ads7846_read12_ser(&spi->dev,
ffa458c1
DB
1032 READ_12BIT_SER(vaux) | ADS_PD10_ALL_ON);
1033
2c8dc071 1034 err = sysfs_create_group(&spi->dev.kobj, &ads784x_attr_group);
8dd51650 1035 if (err)
2c8dc071 1036 goto err_remove_hwmon;
7de90a8c 1037
a90f7e98
DT
1038 err = input_register_device(input_dev);
1039 if (err)
8dd51650 1040 goto err_remove_attr_group;
a90f7e98 1041
ffa458c1 1042 return 0;
a90f7e98 1043
8dd51650 1044 err_remove_attr_group:
2c8dc071
DB
1045 sysfs_remove_group(&spi->dev.kobj, &ads784x_attr_group);
1046 err_remove_hwmon:
1047 ads784x_hwmon_unregister(spi, ts);
8dd51650 1048 err_free_irq:
a90f7e98 1049 free_irq(spi->irq, ts);
da970e69
ID
1050 err_cleanup_filter:
1051 if (ts->filter_cleanup)
1052 ts->filter_cleanup(ts->filter_data);
a90f7e98
DT
1053 err_free_mem:
1054 input_free_device(input_dev);
1055 kfree(ts);
1056 return err;
ffa458c1
DB
1057}
1058
2e5a7bd9 1059static int __devexit ads7846_remove(struct spi_device *spi)
ffa458c1 1060{
2e5a7bd9 1061 struct ads7846 *ts = dev_get_drvdata(&spi->dev);
ffa458c1 1062
2c8dc071 1063 ads784x_hwmon_unregister(spi, ts);
7de90a8c
ID
1064 input_unregister_device(ts->input);
1065
2e5a7bd9 1066 ads7846_suspend(spi, PMSG_SUSPEND);
ffa458c1 1067
2c8dc071 1068 sysfs_remove_group(&spi->dev.kobj, &ads784x_attr_group);
ffa458c1 1069
7de90a8c 1070 free_irq(ts->spi->irq, ts);
c9e617a5
ID
1071 /* suspend left the IRQ disabled */
1072 enable_irq(ts->spi->irq);
7de90a8c 1073
da970e69
ID
1074 if (ts->filter_cleanup)
1075 ts->filter_cleanup(ts->filter_data);
1076
ffa458c1
DB
1077 kfree(ts);
1078
2e5a7bd9 1079 dev_dbg(&spi->dev, "unregistered touchscreen\n");
ffa458c1
DB
1080 return 0;
1081}
1082
2e5a7bd9
DB
1083static struct spi_driver ads7846_driver = {
1084 .driver = {
1085 .name = "ads7846",
1086 .bus = &spi_bus_type,
1087 .owner = THIS_MODULE,
1088 },
ffa458c1 1089 .probe = ads7846_probe,
2e5a7bd9 1090 .remove = __devexit_p(ads7846_remove),
ffa458c1
DB
1091 .suspend = ads7846_suspend,
1092 .resume = ads7846_resume,
1093};
1094
1095static int __init ads7846_init(void)
1096{
1097 /* grr, board-specific init should stay out of drivers!! */
1098
1099#ifdef CONFIG_ARCH_OMAP
1100 if (machine_is_omap_osk()) {
1101 /* GPIO4 = PENIRQ; GPIO6 = BUSY */
1102 omap_request_gpio(4);
1103 omap_set_gpio_direction(4, 1);
1104 omap_request_gpio(6);
1105 omap_set_gpio_direction(6, 1);
1106 }
1107 // also TI 1510 Innovator, bitbanging through FPGA
1108 // also Nokia 770
1109 // also Palm Tungsten T2
1110#endif
1111
1112 // PXA:
1113 // also Dell Axim X50
1114 // also HP iPaq H191x/H192x/H415x/H435x
2e5a7bd9 1115 // also Intel Lubbock (additional to UCB1400; as temperature sensor)
ffa458c1
DB
1116 // also Sharp Zaurus C7xx, C8xx (corgi/sheperd/husky)
1117
2e5a7bd9
DB
1118 // Atmel at91sam9261-EK uses ads7843
1119
ffa458c1
DB
1120 // also various AMD Au1x00 devel boards
1121
2e5a7bd9 1122 return spi_register_driver(&ads7846_driver);
ffa458c1
DB
1123}
1124module_init(ads7846_init);
1125
1126static void __exit ads7846_exit(void)
1127{
2e5a7bd9 1128 spi_unregister_driver(&ads7846_driver);
ffa458c1
DB
1129
1130#ifdef CONFIG_ARCH_OMAP
1131 if (machine_is_omap_osk()) {
1132 omap_free_gpio(4);
1133 omap_free_gpio(6);
1134 }
1135#endif
1136
1137}
1138module_exit(ads7846_exit);
1139
1140MODULE_DESCRIPTION("ADS7846 TouchScreen Driver");
1141MODULE_LICENSE("GPL");