drivers/input/touchscreen/ads7846.c

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