drivers/input/touchscreen/ucb1400_ts.c

   1 /*
   2  *  Philips UCB1400 touchscreen driver
   3  *
   4  *  Author:     Nicolas Pitre
   5  *  Created:    September 25, 2006
   6  *  Copyright:  MontaVista Software, Inc.
   7  *
   8  * Spliting done by: Marek Vasut <marek.vasut@gmail.com>
   9  * If something doesnt work and it worked before spliting, e-mail me,
  10  * dont bother Nicolas please ;-)
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License version 2 as
  14  * published by the Free Software Foundation.
  15  *
  16  * This code is heavily based on ucb1x00-*.c copyrighted by Russell King
  17  * covering the UCB1100, UCB1200 and UCB1300..  Support for the UCB1400 has
  18  * been made separate from ucb1x00-core/ucb1x00-ts on Russell's request.
  19  */
  20
  21 #include <linux/module.h>
  22 #include <linux/init.h>
  23 #include <linux/completion.h>
  24 #include <linux/delay.h>
  25 #include <linux/input.h>
  26 #include <linux/device.h>
  27 #include <linux/interrupt.h>
  28 #include <linux/suspend.h>
  29 #include <linux/slab.h>
  30 #include <linux/kthread.h>
  31 #include <linux/freezer.h>
  32 #include <linux/ucb1400.h>
  33
  34 static int adcsync;
  35 static int ts_delay = 55; /* us */
  36 static int ts_delay_pressure;   /* us */
  37
  38 /* Switch to interrupt mode. */
  39 static inline void ucb1400_ts_mode_int(struct snd_ac97 *ac97)
  40 {
  41         ucb1400_reg_write(ac97, UCB_TS_CR,
  42                         UCB_TS_CR_TSMX_POW | UCB_TS_CR_TSPX_POW |
  43                         UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_GND |
  44                         UCB_TS_CR_MODE_INT);
  45 }
  46
  47 /*
  48  * Switch to pressure mode, and read pressure.  We don't need to wait
  49  * here, since both plates are being driven.
  50  */
  51 static inline unsigned int ucb1400_ts_read_pressure(struct ucb1400_ts *ucb)
  52 {
  53         ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
  54                         UCB_TS_CR_TSMX_POW | UCB_TS_CR_TSPX_POW |
  55                         UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_GND |
  56                         UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
  57         udelay(ts_delay_pressure);
  58         return ucb1400_adc_read(ucb->ac97, UCB_ADC_INP_TSPY, adcsync);
  59 }
  60
  61 /*
  62  * Switch to X position mode and measure Y plate.  We switch the plate
  63  * configuration in pressure mode, then switch to position mode.  This
  64  * gives a faster response time.  Even so, we need to wait about 55us
  65  * for things to stabilise.
  66  */
  67 static inline unsigned int ucb1400_ts_read_xpos(struct ucb1400_ts *ucb)
  68 {
  69         ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
  70                         UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
  71                         UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
  72         ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
  73                         UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
  74                         UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
  75         ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
  76                         UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
  77                         UCB_TS_CR_MODE_POS | UCB_TS_CR_BIAS_ENA);
  78
  79         udelay(ts_delay);
  80
  81         return ucb1400_adc_read(ucb->ac97, UCB_ADC_INP_TSPY, adcsync);
  82 }
  83
  84 /*
  85  * Switch to Y position mode and measure X plate.  We switch the plate
  86  * configuration in pressure mode, then switch to position mode.  This
  87  * gives a faster response time.  Even so, we need to wait about 55us
  88  * for things to stabilise.
  89  */
  90 static inline unsigned int ucb1400_ts_read_ypos(struct ucb1400_ts *ucb)
  91 {
  92         ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
  93                         UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
  94                         UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
  95         ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
  96                         UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
  97                         UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
  98         ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
  99                         UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
 100                         UCB_TS_CR_MODE_POS | UCB_TS_CR_BIAS_ENA);
 101
 102         udelay(ts_delay);
 103
 104         return ucb1400_adc_read(ucb->ac97, UCB_ADC_INP_TSPX, adcsync);
 105 }
 106
 107 /*
 108  * Switch to X plate resistance mode.  Set MX to ground, PX to
 109  * supply.  Measure current.
 110  */
 111 static inline unsigned int ucb1400_ts_read_xres(struct ucb1400_ts *ucb)
 112 {
 113         ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
 114                         UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
 115                         UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
 116         return ucb1400_adc_read(ucb->ac97, 0, adcsync);
 117 }
 118
 119 /*
 120  * Switch to Y plate resistance mode.  Set MY to ground, PY to
 121  * supply.  Measure current.
 122  */
 123 static inline unsigned int ucb1400_ts_read_yres(struct ucb1400_ts *ucb)
 124 {
 125         ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
 126                         UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
 127                         UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
 128         return ucb1400_adc_read(ucb->ac97, 0, adcsync);
 129 }
 130
 131 static inline int ucb1400_ts_pen_up(struct snd_ac97 *ac97)
 132 {
 133         unsigned short val = ucb1400_reg_read(ac97, UCB_TS_CR);
 134
 135         return val & (UCB_TS_CR_TSPX_LOW | UCB_TS_CR_TSMX_LOW);
 136 }
 137
 138 static inline void ucb1400_ts_irq_enable(struct snd_ac97 *ac97)
 139 {
 140         ucb1400_reg_write(ac97, UCB_IE_CLEAR, UCB_IE_TSPX);
 141         ucb1400_reg_write(ac97, UCB_IE_CLEAR, 0);
 142         ucb1400_reg_write(ac97, UCB_IE_FAL, UCB_IE_TSPX);
 143 }
 144
 145 static inline void ucb1400_ts_irq_disable(struct snd_ac97 *ac97)
 146 {
 147         ucb1400_reg_write(ac97, UCB_IE_FAL, 0);
 148 }
 149
 150 static void ucb1400_ts_evt_add(struct input_dev *idev, u16 pressure, u16 x, u16 y)
 151 {
 152         input_report_abs(idev, ABS_X, x);
 153         input_report_abs(idev, ABS_Y, y);
 154         input_report_abs(idev, ABS_PRESSURE, pressure);
 155         input_report_key(idev, BTN_TOUCH, 1);
 156         input_sync(idev);
 157 }
 158
 159 static void ucb1400_ts_event_release(struct input_dev *idev)
 160 {
 161         input_report_abs(idev, ABS_PRESSURE, 0);
 162         input_report_key(idev, BTN_TOUCH, 0);
 163         input_sync(idev);
 164 }
 165
 166 static void ucb1400_handle_pending_irq(struct ucb1400_ts *ucb)
 167 {
 168         unsigned int isr;
 169
 170         isr = ucb1400_reg_read(ucb->ac97, UCB_IE_STATUS);
 171         ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, isr);
 172         ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0);
 173
 174         if (isr & UCB_IE_TSPX)
 175                 ucb1400_ts_irq_disable(ucb->ac97);
 176         else
 177                 dev_dbg(&ucb->ts_idev->dev, "ucb1400: unexpected IE_STATUS = %#x\n", isr);
 178         enable_irq(ucb->irq);
 179 }
 180
 181 static int ucb1400_ts_thread(void *_ucb)
 182 {
 183         struct ucb1400_ts *ucb = _ucb;
 184         struct task_struct *tsk = current;
 185         int valid = 0;
 186         struct sched_param param = { .sched_priority = 1 };
 187
 188         sched_setscheduler(tsk, SCHED_FIFO, &param);
 189
 190         set_freezable();
 191         while (!kthread_should_stop()) {
 192                 unsigned int x, y, p;
 193                 long timeout;
 194
 195                 ucb->ts_restart = 0;
 196
 197                 if (ucb->irq_pending) {
 198                         ucb->irq_pending = 0;
 199                         ucb1400_handle_pending_irq(ucb);
 200                 }
 201
 202                 ucb1400_adc_enable(ucb->ac97);
 203                 x = ucb1400_ts_read_xpos(ucb);
 204                 y = ucb1400_ts_read_ypos(ucb);
 205                 p = ucb1400_ts_read_pressure(ucb);
 206                 ucb1400_adc_disable(ucb->ac97);
 207
 208                 /* Switch back to interrupt mode. */
 209                 ucb1400_ts_mode_int(ucb->ac97);
 210
 211                 msleep(10);
 212
 213                 if (ucb1400_ts_pen_up(ucb->ac97)) {
 214                         ucb1400_ts_irq_enable(ucb->ac97);
 215
 216                         /*
 217                          * If we spat out a valid sample set last time,
 218                          * spit out a "pen off" sample here.
 219                          */
 220                         if (valid) {
 221                                 ucb1400_ts_event_release(ucb->ts_idev);
 222                                 valid = 0;
 223                         }
 224
 225                         timeout = MAX_SCHEDULE_TIMEOUT;
 226                 } else {
 227                         valid = 1;
 228                         ucb1400_ts_evt_add(ucb->ts_idev, p, x, y);
 229                         timeout = msecs_to_jiffies(10);
 230                 }
 231
 232                 wait_event_freezable_timeout(ucb->ts_wait,
 233                         ucb->irq_pending || ucb->ts_restart ||
 234                         kthread_should_stop(), timeout);
 235         }
 236
 237         /* Send the "pen off" if we are stopping with the pen still active */
 238         if (valid)
 239                 ucb1400_ts_event_release(ucb->ts_idev);
 240
 241         ucb->ts_task = NULL;
 242         return 0;
 243 }
 244
 245 /*
 246  * A restriction with interrupts exists when using the ucb1400, as
 247  * the codec read/write routines may sleep while waiting for codec
 248  * access completion and uses semaphores for access control to the
 249  * AC97 bus.  A complete codec read cycle could take  anywhere from
 250  * 60 to 100uSec so we *definitely* don't want to spin inside the
 251  * interrupt handler waiting for codec access.  So, we handle the
 252  * interrupt by scheduling a RT kernel thread to run in process
 253  * context instead of interrupt context.
 254  */
 255 static irqreturn_t ucb1400_hard_irq(int irqnr, void *devid)
 256 {
 257         struct ucb1400_ts *ucb = devid;
 258
 259         if (irqnr == ucb->irq) {
 260                 disable_irq_nosync(ucb->irq);
 261                 ucb->irq_pending = 1;
 262                 wake_up(&ucb->ts_wait);
 263                 return IRQ_HANDLED;
 264         }
 265         return IRQ_NONE;
 266 }
 267
 268 static int ucb1400_ts_open(struct input_dev *idev)
 269 {
 270         struct ucb1400_ts *ucb = input_get_drvdata(idev);
 271         int ret = 0;
 272
 273         BUG_ON(ucb->ts_task);
 274
 275         ucb->ts_task = kthread_run(ucb1400_ts_thread, ucb, "UCB1400_ts");
 276         if (IS_ERR(ucb->ts_task)) {
 277                 ret = PTR_ERR(ucb->ts_task);
 278                 ucb->ts_task = NULL;
 279         }
 280
 281         return ret;
 282 }
 283
 284 static void ucb1400_ts_close(struct input_dev *idev)
 285 {
 286         struct ucb1400_ts *ucb = input_get_drvdata(idev);
 287
 288         if (ucb->ts_task)
 289                 kthread_stop(ucb->ts_task);
 290
 291         ucb1400_ts_irq_disable(ucb->ac97);
 292         ucb1400_reg_write(ucb->ac97, UCB_TS_CR, 0);
 293 }
 294
 295 #ifndef NO_IRQ
 296 #define NO_IRQ  0
 297 #endif
 298
 299 /*
 300  * Try to probe our interrupt, rather than relying on lots of
 301  * hard-coded machine dependencies.
 302  */
 303 static int ucb1400_ts_detect_irq(struct ucb1400_ts *ucb)
 304 {
 305         unsigned long mask, timeout;
 306
 307         mask = probe_irq_on();
 308
 309         /* Enable the ADC interrupt. */
 310         ucb1400_reg_write(ucb->ac97, UCB_IE_RIS, UCB_IE_ADC);
 311         ucb1400_reg_write(ucb->ac97, UCB_IE_FAL, UCB_IE_ADC);
 312         ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0xffff);
 313         ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0);
 314
 315         /* Cause an ADC interrupt. */
 316         ucb1400_reg_write(ucb->ac97, UCB_ADC_CR, UCB_ADC_ENA);
 317         ucb1400_reg_write(ucb->ac97, UCB_ADC_CR, UCB_ADC_ENA | UCB_ADC_START);
 318
 319         /* Wait for the conversion to complete. */
 320         timeout = jiffies + HZ/2;
 321         while (!(ucb1400_reg_read(ucb->ac97, UCB_ADC_DATA) &
 322                                                 UCB_ADC_DAT_VALID)) {
 323                 cpu_relax();
 324                 if (time_after(jiffies, timeout)) {
 325                         printk(KERN_ERR "ucb1400: timed out in IRQ probe\n");
 326                         probe_irq_off(mask);
 327                         return -ENODEV;
 328                 }
 329         }
 330         ucb1400_reg_write(ucb->ac97, UCB_ADC_CR, 0);
 331
 332         /* Disable and clear interrupt. */
 333         ucb1400_reg_write(ucb->ac97, UCB_IE_RIS, 0);
 334         ucb1400_reg_write(ucb->ac97, UCB_IE_FAL, 0);
 335         ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0xffff);
 336         ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0);
 337
 338         /* Read triggered interrupt. */
 339         ucb->irq = probe_irq_off(mask);
 340         if (ucb->irq < 0 || ucb->irq == NO_IRQ)
 341                 return -ENODEV;
 342
 343         return 0;
 344 }
 345
 346 static int ucb1400_ts_probe(struct platform_device *dev)
 347 {
 348         int error, x_res, y_res;
 349         u16 fcsr;
 350         struct ucb1400_ts *ucb = dev->dev.platform_data;
 351
 352         ucb->ts_idev = input_allocate_device();
 353         if (!ucb->ts_idev) {
 354                 error = -ENOMEM;
 355                 goto err;
 356         }
 357
 358         /* Only in case the IRQ line wasn't supplied, try detecting it */
 359         if (ucb->irq < 0) {
 360                 error = ucb1400_ts_detect_irq(ucb);
 361                 if (error) {
 362                         printk(KERN_ERR "UCB1400: IRQ probe failed\n");
 363                         goto err_free_devs;
 364                 }
 365         }
 366
 367         init_waitqueue_head(&ucb->ts_wait);
 368
 369         error = request_irq(ucb->irq, ucb1400_hard_irq, IRQF_TRIGGER_RISING,
 370                                 "UCB1400", ucb);
 371         if (error) {
 372                 printk(KERN_ERR "ucb1400: unable to grab irq%d: %d\n",
 373                                 ucb->irq, error);
 374                 goto err_free_devs;
 375         }
 376         printk(KERN_DEBUG "UCB1400: found IRQ %d\n", ucb->irq);
 377
 378         input_set_drvdata(ucb->ts_idev, ucb);
 379
 380         ucb->ts_idev->dev.parent        = &dev->dev;
 381         ucb->ts_idev->name              = "UCB1400 touchscreen interface";
 382         ucb->ts_idev->id.vendor         = ucb1400_reg_read(ucb->ac97,
 383                                                 AC97_VENDOR_ID1);
 384         ucb->ts_idev->id.product        = ucb->id;
 385         ucb->ts_idev->open              = ucb1400_ts_open;
 386         ucb->ts_idev->close             = ucb1400_ts_close;
 387         ucb->ts_idev->evbit[0]          = BIT_MASK(EV_ABS) | BIT_MASK(EV_KEY);
 388         ucb->ts_idev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
 389
 390         /*
 391          * Enable ADC filter to prevent horrible jitter on Colibri.
 392          * This also further reduces jitter on boards where ADCSYNC
 393          * pin is connected.
 394          */
 395         fcsr = ucb1400_reg_read(ucb->ac97, UCB_FCSR);
 396         ucb1400_reg_write(ucb->ac97, UCB_FCSR, fcsr | UCB_FCSR_AVE);
 397
 398         ucb1400_adc_enable(ucb->ac97);
 399         x_res = ucb1400_ts_read_xres(ucb);
 400         y_res = ucb1400_ts_read_yres(ucb);
 401         ucb1400_adc_disable(ucb->ac97);
 402         printk(KERN_DEBUG "UCB1400: x/y = %d/%d\n", x_res, y_res);
 403
 404         input_set_abs_params(ucb->ts_idev, ABS_X, 0, x_res, 0, 0);
 405         input_set_abs_params(ucb->ts_idev, ABS_Y, 0, y_res, 0, 0);
 406         input_set_abs_params(ucb->ts_idev, ABS_PRESSURE, 0, 0, 0, 0);
 407
 408         error = input_register_device(ucb->ts_idev);
 409         if (error)
 410                 goto err_free_irq;
 411
 412         return 0;
 413
 414 err_free_irq:
 415         free_irq(ucb->irq, ucb);
 416 err_free_devs:
 417         input_free_device(ucb->ts_idev);
 418 err:
 419         return error;
 420
 421 }
 422
 423 static int ucb1400_ts_remove(struct platform_device *dev)
 424 {
 425         struct ucb1400_ts *ucb = dev->dev.platform_data;
 426
 427         free_irq(ucb->irq, ucb);
 428         input_unregister_device(ucb->ts_idev);
 429         return 0;
 430 }
 431
 432 #ifdef CONFIG_PM
 433 static int ucb1400_ts_resume(struct platform_device *dev)
 434 {
 435         struct ucb1400_ts *ucb = dev->dev.platform_data;
 436
 437         if (ucb->ts_task) {
 438                 /*
 439                  * Restart the TS thread to ensure the
 440                  * TS interrupt mode is set up again
 441                  * after sleep.
 442                  */
 443                 ucb->ts_restart = 1;
 444                 wake_up(&ucb->ts_wait);
 445         }
 446         return 0;
 447 }
 448 #else
 449 #define ucb1400_ts_resume NULL
 450 #endif
 451
 452 static struct platform_driver ucb1400_ts_driver = {
 453         .probe  = ucb1400_ts_probe,
 454         .remove = ucb1400_ts_remove,
 455         .resume = ucb1400_ts_resume,
 456         .driver = {
 457                 .name   = "ucb1400_ts",
 458         },
 459 };
 460
 461 static int __init ucb1400_ts_init(void)
 462 {
 463         return platform_driver_register(&ucb1400_ts_driver);
 464 }
 465
 466 static void __exit ucb1400_ts_exit(void)
 467 {
 468         platform_driver_unregister(&ucb1400_ts_driver);
 469 }
 470
 471 module_param(adcsync, bool, 0444);
 472 MODULE_PARM_DESC(adcsync, "Synchronize touch readings with ADCSYNC pin.");
 473
 474 module_param(ts_delay, int, 0444);
 475 MODULE_PARM_DESC(ts_delay, "Delay between panel setup and"
 476                             " position read. Default = 55us.");
 477
 478 module_param(ts_delay_pressure, int, 0444);
 479 MODULE_PARM_DESC(ts_delay_pressure,
 480                 "delay between panel setup and pressure read."
 481                 "  Default = 0us.");
 482
 483 module_init(ucb1400_ts_init);
 484 module_exit(ucb1400_ts_exit);
 485
 486 MODULE_DESCRIPTION("Philips UCB1400 touchscreen driver");
 487 MODULE_LICENSE("GPL");