Merge tag 'trace-v4.14-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt...
[linux-2.6-block.git] / drivers / input / touchscreen / ucb1400_ts.c
CommitLineData
f40219bf
NP
1/*
2 * Philips UCB1400 touchscreen driver
3 *
4 * Author: Nicolas Pitre
5 * Created: September 25, 2006
6 * Copyright: MontaVista Software, Inc.
7 *
d9105c2b 8 * Spliting done by: Marek Vasut <marek.vasut@gmail.com>
25985edc 9 * If something doesn't work and it worked before spliting, e-mail me,
d9105c2b
MV
10 * dont bother Nicolas please ;-)
11 *
f40219bf
NP
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>
f40219bf 22#include <linux/delay.h>
c899afed
DT
23#include <linux/sched.h>
24#include <linux/wait.h>
f40219bf
NP
25#include <linux/input.h>
26#include <linux/device.h>
27#include <linux/interrupt.h>
d9105c2b 28#include <linux/ucb1400.h>
f40219bf 29
c899afed
DT
30#define UCB1400_TS_POLL_PERIOD 10 /* ms */
31
90ab5ee9 32static bool adcsync;
b5b16c52
CB
33static int ts_delay = 55; /* us */
34static int ts_delay_pressure; /* us */
f40219bf 35
f40219bf 36/* Switch to interrupt mode. */
c899afed 37static void ucb1400_ts_mode_int(struct ucb1400_ts *ucb)
f40219bf 38{
c899afed 39 ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
f40219bf
NP
40 UCB_TS_CR_TSMX_POW | UCB_TS_CR_TSPX_POW |
41 UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_GND |
42 UCB_TS_CR_MODE_INT);
43}
44
45/*
46 * Switch to pressure mode, and read pressure. We don't need to wait
47 * here, since both plates are being driven.
48 */
75072323 49static unsigned int ucb1400_ts_read_pressure(struct ucb1400_ts *ucb)
f40219bf 50{
d9105c2b 51 ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
f40219bf
NP
52 UCB_TS_CR_TSMX_POW | UCB_TS_CR_TSPX_POW |
53 UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_GND |
54 UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
c899afed 55
b5b16c52 56 udelay(ts_delay_pressure);
c899afed 57
d9105c2b 58 return ucb1400_adc_read(ucb->ac97, UCB_ADC_INP_TSPY, adcsync);
f40219bf
NP
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 */
75072323 67static unsigned int ucb1400_ts_read_xpos(struct ucb1400_ts *ucb)
f40219bf 68{
d9105c2b 69 ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
f40219bf
NP
70 UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
71 UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
d9105c2b 72 ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
f40219bf
NP
73 UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
74 UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
d9105c2b 75 ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
f40219bf
NP
76 UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
77 UCB_TS_CR_MODE_POS | UCB_TS_CR_BIAS_ENA);
78
b5b16c52 79 udelay(ts_delay);
f40219bf 80
d9105c2b 81 return ucb1400_adc_read(ucb->ac97, UCB_ADC_INP_TSPY, adcsync);
f40219bf
NP
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 */
75072323 90static int ucb1400_ts_read_ypos(struct ucb1400_ts *ucb)
f40219bf 91{
d9105c2b 92 ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
f40219bf
NP
93 UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
94 UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
d9105c2b 95 ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
f40219bf
NP
96 UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
97 UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
d9105c2b 98 ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
f40219bf
NP
99 UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
100 UCB_TS_CR_MODE_POS | UCB_TS_CR_BIAS_ENA);
101
b5b16c52 102 udelay(ts_delay);
f40219bf 103
d9105c2b 104 return ucb1400_adc_read(ucb->ac97, UCB_ADC_INP_TSPX, adcsync);
f40219bf
NP
105}
106
107/*
108 * Switch to X plate resistance mode. Set MX to ground, PX to
109 * supply. Measure current.
110 */
75072323 111static unsigned int ucb1400_ts_read_xres(struct ucb1400_ts *ucb)
f40219bf 112{
d9105c2b 113 ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
f40219bf
NP
114 UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
115 UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
d9105c2b 116 return ucb1400_adc_read(ucb->ac97, 0, adcsync);
f40219bf
NP
117}
118
119/*
120 * Switch to Y plate resistance mode. Set MY to ground, PY to
121 * supply. Measure current.
122 */
75072323 123static unsigned int ucb1400_ts_read_yres(struct ucb1400_ts *ucb)
f40219bf 124{
d9105c2b 125 ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
f40219bf
NP
126 UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
127 UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
d9105c2b 128 return ucb1400_adc_read(ucb->ac97, 0, adcsync);
f40219bf
NP
129}
130
c899afed 131static int ucb1400_ts_pen_up(struct ucb1400_ts *ucb)
f40219bf 132{
c899afed 133 unsigned short val = ucb1400_reg_read(ucb->ac97, UCB_TS_CR);
f9c22736 134
d9105c2b 135 return val & (UCB_TS_CR_TSPX_LOW | UCB_TS_CR_TSMX_LOW);
f40219bf
NP
136}
137
c899afed 138static void ucb1400_ts_irq_enable(struct ucb1400_ts *ucb)
f40219bf 139{
c899afed
DT
140 ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, UCB_IE_TSPX);
141 ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0);
142 ucb1400_reg_write(ucb->ac97, UCB_IE_FAL, UCB_IE_TSPX);
f40219bf
NP
143}
144
c899afed 145static void ucb1400_ts_irq_disable(struct ucb1400_ts *ucb)
f40219bf 146{
c899afed 147 ucb1400_reg_write(ucb->ac97, UCB_IE_FAL, 0);
f40219bf
NP
148}
149
c899afed 150static void ucb1400_ts_report_event(struct input_dev *idev, u16 pressure, u16 x, u16 y)
f40219bf
NP
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);
cd2d64b1 155 input_report_key(idev, BTN_TOUCH, 1);
f40219bf
NP
156 input_sync(idev);
157}
158
159static void ucb1400_ts_event_release(struct input_dev *idev)
160{
161 input_report_abs(idev, ABS_PRESSURE, 0);
cd2d64b1 162 input_report_key(idev, BTN_TOUCH, 0);
f40219bf
NP
163 input_sync(idev);
164}
165
c899afed 166static void ucb1400_clear_pending_irq(struct ucb1400_ts *ucb)
f40219bf
NP
167{
168 unsigned int isr;
169
d9105c2b
MV
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);
f40219bf 173
9b2fb2da 174 if (isr & UCB_IE_TSPX)
c899afed 175 ucb1400_ts_irq_disable(ucb);
9b2fb2da 176 else
c899afed
DT
177 dev_dbg(&ucb->ts_idev->dev,
178 "ucb1400: unexpected IE_STATUS = %#x\n", isr);
f40219bf
NP
179}
180
c899afed
DT
181/*
182 * A restriction with interrupts exists when using the ucb1400, as
183 * the codec read/write routines may sleep while waiting for codec
184 * access completion and uses semaphores for access control to the
185 * AC97 bus. Therefore the driver is forced to use threaded interrupt
186 * handler.
187 */
188static irqreturn_t ucb1400_irq(int irqnr, void *devid)
f40219bf 189{
c899afed
DT
190 struct ucb1400_ts *ucb = devid;
191 unsigned int x, y, p;
192 bool penup;
f40219bf 193
c899afed
DT
194 if (unlikely(irqnr != ucb->irq))
195 return IRQ_NONE;
f40219bf 196
c899afed 197 ucb1400_clear_pending_irq(ucb);
f40219bf 198
c899afed
DT
199 /* Start with a small delay before checking pendown state */
200 msleep(UCB1400_TS_POLL_PERIOD);
f40219bf 201
c899afed 202 while (!ucb->stopped && !(penup = ucb1400_ts_pen_up(ucb))) {
f40219bf 203
d9105c2b 204 ucb1400_adc_enable(ucb->ac97);
f40219bf
NP
205 x = ucb1400_ts_read_xpos(ucb);
206 y = ucb1400_ts_read_ypos(ucb);
207 p = ucb1400_ts_read_pressure(ucb);
d9105c2b 208 ucb1400_adc_disable(ucb->ac97);
f40219bf 209
c899afed 210 ucb1400_ts_report_event(ucb->ts_idev, p, x, y);
f40219bf 211
c899afed
DT
212 wait_event_timeout(ucb->ts_wait, ucb->stopped,
213 msecs_to_jiffies(UCB1400_TS_POLL_PERIOD));
f40219bf
NP
214 }
215
c899afed 216 ucb1400_ts_event_release(ucb->ts_idev);
f40219bf 217
c899afed
DT
218 if (!ucb->stopped) {
219 /* Switch back to interrupt mode. */
220 ucb1400_ts_mode_int(ucb);
221 ucb1400_ts_irq_enable(ucb);
222 }
223
224 return IRQ_HANDLED;
f40219bf
NP
225}
226
c899afed 227static void ucb1400_ts_stop(struct ucb1400_ts *ucb)
f40219bf 228{
c899afed
DT
229 /* Signal IRQ thread to stop polling and disable the handler. */
230 ucb->stopped = true;
231 mb();
232 wake_up(&ucb->ts_wait);
233 disable_irq(ucb->irq);
f40219bf 234
c899afed
DT
235 ucb1400_ts_irq_disable(ucb);
236 ucb1400_reg_write(ucb->ac97, UCB_TS_CR, 0);
237}
238
239/* Must be called with ts->lock held */
240static void ucb1400_ts_start(struct ucb1400_ts *ucb)
241{
242 /* Tell IRQ thread that it may poll the device. */
243 ucb->stopped = false;
244 mb();
245
246 ucb1400_ts_mode_int(ucb);
247 ucb1400_ts_irq_enable(ucb);
248
249 enable_irq(ucb->irq);
f40219bf
NP
250}
251
252static int ucb1400_ts_open(struct input_dev *idev)
253{
d9105c2b 254 struct ucb1400_ts *ucb = input_get_drvdata(idev);
f40219bf 255
c899afed 256 ucb1400_ts_start(ucb);
f40219bf 257
c899afed 258 return 0;
f40219bf
NP
259}
260
261static void ucb1400_ts_close(struct input_dev *idev)
262{
d9105c2b 263 struct ucb1400_ts *ucb = input_get_drvdata(idev);
f40219bf 264
c899afed 265 ucb1400_ts_stop(ucb);
f40219bf 266}
f40219bf
NP
267
268#ifndef NO_IRQ
269#define NO_IRQ 0
270#endif
271
272/*
273 * Try to probe our interrupt, rather than relying on lots of
274 * hard-coded machine dependencies.
275 */
5298cc4c 276static int ucb1400_ts_detect_irq(struct ucb1400_ts *ucb,
bd100e2c 277 struct platform_device *pdev)
f40219bf
NP
278{
279 unsigned long mask, timeout;
280
281 mask = probe_irq_on();
f40219bf
NP
282
283 /* Enable the ADC interrupt. */
d9105c2b
MV
284 ucb1400_reg_write(ucb->ac97, UCB_IE_RIS, UCB_IE_ADC);
285 ucb1400_reg_write(ucb->ac97, UCB_IE_FAL, UCB_IE_ADC);
286 ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0xffff);
287 ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0);
f40219bf
NP
288
289 /* Cause an ADC interrupt. */
d9105c2b
MV
290 ucb1400_reg_write(ucb->ac97, UCB_ADC_CR, UCB_ADC_ENA);
291 ucb1400_reg_write(ucb->ac97, UCB_ADC_CR, UCB_ADC_ENA | UCB_ADC_START);
f40219bf
NP
292
293 /* Wait for the conversion to complete. */
294 timeout = jiffies + HZ/2;
d9105c2b
MV
295 while (!(ucb1400_reg_read(ucb->ac97, UCB_ADC_DATA) &
296 UCB_ADC_DAT_VALID)) {
f40219bf
NP
297 cpu_relax();
298 if (time_after(jiffies, timeout)) {
bd100e2c 299 dev_err(&pdev->dev, "timed out in IRQ probe\n");
f40219bf
NP
300 probe_irq_off(mask);
301 return -ENODEV;
302 }
303 }
d9105c2b 304 ucb1400_reg_write(ucb->ac97, UCB_ADC_CR, 0);
f40219bf
NP
305
306 /* Disable and clear interrupt. */
d9105c2b
MV
307 ucb1400_reg_write(ucb->ac97, UCB_IE_RIS, 0);
308 ucb1400_reg_write(ucb->ac97, UCB_IE_FAL, 0);
309 ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0xffff);
310 ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0);
f40219bf
NP
311
312 /* Read triggered interrupt. */
313 ucb->irq = probe_irq_off(mask);
314 if (ucb->irq < 0 || ucb->irq == NO_IRQ)
315 return -ENODEV;
316
317 return 0;
318}
319
5298cc4c 320static int ucb1400_ts_probe(struct platform_device *pdev)
f40219bf 321{
c838cb3d 322 struct ucb1400_ts *ucb = dev_get_platdata(&pdev->dev);
d9105c2b 323 int error, x_res, y_res;
1700f5fd 324 u16 fcsr;
f40219bf 325
d9105c2b
MV
326 ucb->ts_idev = input_allocate_device();
327 if (!ucb->ts_idev) {
f40219bf 328 error = -ENOMEM;
d9105c2b 329 goto err;
f40219bf
NP
330 }
331
fb141597
MV
332 /* Only in case the IRQ line wasn't supplied, try detecting it */
333 if (ucb->irq < 0) {
bd100e2c 334 error = ucb1400_ts_detect_irq(ucb, pdev);
fb141597 335 if (error) {
bd100e2c 336 dev_err(&pdev->dev, "IRQ probe failed\n");
fb141597
MV
337 goto err_free_devs;
338 }
f40219bf 339 }
bd100e2c 340 dev_dbg(&pdev->dev, "found IRQ %d\n", ucb->irq);
f40219bf 341
d9105c2b
MV
342 init_waitqueue_head(&ucb->ts_wait);
343
d9105c2b 344 input_set_drvdata(ucb->ts_idev, ucb);
40b9b0b8 345
c899afed 346 ucb->ts_idev->dev.parent = &pdev->dev;
d9105c2b
MV
347 ucb->ts_idev->name = "UCB1400 touchscreen interface";
348 ucb->ts_idev->id.vendor = ucb1400_reg_read(ucb->ac97,
349 AC97_VENDOR_ID1);
350 ucb->ts_idev->id.product = ucb->id;
351 ucb->ts_idev->open = ucb1400_ts_open;
352 ucb->ts_idev->close = ucb1400_ts_close;
cd2d64b1
MR
353 ucb->ts_idev->evbit[0] = BIT_MASK(EV_ABS) | BIT_MASK(EV_KEY);
354 ucb->ts_idev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
f40219bf 355
1700f5fd
MV
356 /*
357 * Enable ADC filter to prevent horrible jitter on Colibri.
358 * This also further reduces jitter on boards where ADCSYNC
359 * pin is connected.
360 */
361 fcsr = ucb1400_reg_read(ucb->ac97, UCB_FCSR);
362 ucb1400_reg_write(ucb->ac97, UCB_FCSR, fcsr | UCB_FCSR_AVE);
363
d9105c2b 364 ucb1400_adc_enable(ucb->ac97);
f40219bf
NP
365 x_res = ucb1400_ts_read_xres(ucb);
366 y_res = ucb1400_ts_read_yres(ucb);
d9105c2b 367 ucb1400_adc_disable(ucb->ac97);
bd100e2c 368 dev_dbg(&pdev->dev, "x/y = %d/%d\n", x_res, y_res);
f40219bf 369
d9105c2b
MV
370 input_set_abs_params(ucb->ts_idev, ABS_X, 0, x_res, 0, 0);
371 input_set_abs_params(ucb->ts_idev, ABS_Y, 0, y_res, 0, 0);
372 input_set_abs_params(ucb->ts_idev, ABS_PRESSURE, 0, 0, 0, 0);
f40219bf 373
c899afed
DT
374 ucb1400_ts_stop(ucb);
375
376 error = request_threaded_irq(ucb->irq, NULL, ucb1400_irq,
377 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
378 "UCB1400", ucb);
379 if (error) {
bd100e2c
DT
380 dev_err(&pdev->dev,
381 "unable to grab irq%d: %d\n", ucb->irq, error);
c899afed
DT
382 goto err_free_devs;
383 }
384
d9105c2b 385 error = input_register_device(ucb->ts_idev);
f40219bf
NP
386 if (error)
387 goto err_free_irq;
388
f40219bf
NP
389 return 0;
390
d9105c2b 391err_free_irq:
f40219bf 392 free_irq(ucb->irq, ucb);
d9105c2b
MV
393err_free_devs:
394 input_free_device(ucb->ts_idev);
395err:
f40219bf
NP
396 return error;
397}
398
e2619cf7 399static int ucb1400_ts_remove(struct platform_device *pdev)
f40219bf 400{
c838cb3d 401 struct ucb1400_ts *ucb = dev_get_platdata(&pdev->dev);
f40219bf
NP
402
403 free_irq(ucb->irq, ucb);
404 input_unregister_device(ucb->ts_idev);
9fea9291 405
f40219bf
NP
406 return 0;
407}
408
02b6a58b 409static int __maybe_unused ucb1400_ts_suspend(struct device *dev)
c899afed 410{
c838cb3d 411 struct ucb1400_ts *ucb = dev_get_platdata(dev);
c899afed
DT
412 struct input_dev *idev = ucb->ts_idev;
413
414 mutex_lock(&idev->mutex);
415
416 if (idev->users)
39467fc1 417 ucb1400_ts_stop(ucb);
c899afed
DT
418
419 mutex_unlock(&idev->mutex);
420 return 0;
421}
422
02b6a58b 423static int __maybe_unused ucb1400_ts_resume(struct device *dev)
d9105c2b 424{
c838cb3d 425 struct ucb1400_ts *ucb = dev_get_platdata(dev);
c899afed 426 struct input_dev *idev = ucb->ts_idev;
d9105c2b 427
c899afed
DT
428 mutex_lock(&idev->mutex);
429
430 if (idev->users)
39467fc1 431 ucb1400_ts_start(ucb);
c899afed
DT
432
433 mutex_unlock(&idev->mutex);
d9105c2b
MV
434 return 0;
435}
d9105c2b 436
c899afed
DT
437static SIMPLE_DEV_PM_OPS(ucb1400_ts_pm_ops,
438 ucb1400_ts_suspend, ucb1400_ts_resume);
3db8a537 439
d9105c2b
MV
440static struct platform_driver ucb1400_ts_driver = {
441 .probe = ucb1400_ts_probe,
1cb0aa88 442 .remove = ucb1400_ts_remove,
d9105c2b
MV
443 .driver = {
444 .name = "ucb1400_ts",
3db8a537 445 .pm = &ucb1400_ts_pm_ops,
d9105c2b 446 },
f40219bf 447};
cdcc96e2 448module_platform_driver(ucb1400_ts_driver);
f40219bf 449
b5b16c52
CB
450module_param(adcsync, bool, 0444);
451MODULE_PARM_DESC(adcsync, "Synchronize touch readings with ADCSYNC pin.");
452
453module_param(ts_delay, int, 0444);
d9105c2b
MV
454MODULE_PARM_DESC(ts_delay, "Delay between panel setup and"
455 " position read. Default = 55us.");
b5b16c52
CB
456
457module_param(ts_delay_pressure, int, 0444);
458MODULE_PARM_DESC(ts_delay_pressure,
d9105c2b
MV
459 "delay between panel setup and pressure read."
460 " Default = 0us.");
f40219bf 461
f40219bf
NP
462MODULE_DESCRIPTION("Philips UCB1400 touchscreen driver");
463MODULE_LICENSE("GPL");