ucb1400_ts.c 12.2 KB
Newer Older
1 2 3 4 5 6 7
/*
 *  Philips UCB1400 touchscreen driver
 *
 *  Author:	Nicolas Pitre
 *  Created:	September 25, 2006
 *  Copyright:	MontaVista Software, Inc.
 *
8
 * Spliting done by: Marek Vasut <marek.vasut@gmail.com>
Lucas De Marchi's avatar
Lucas De Marchi committed
9
 * If something doesn't work and it worked before spliting, e-mail me,
10 11
 * dont bother Nicolas please ;-)
 *
12 13 14 15 16 17 18 19 20 21 22
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This code is heavily based on ucb1x00-*.c copyrighted by Russell King
 * covering the UCB1100, UCB1200 and UCB1300..  Support for the UCB1400 has
 * been made separate from ucb1x00-core/ucb1x00-ts on Russell's request.
 */

#include <linux/module.h>
#include <linux/delay.h>
23 24
#include <linux/sched.h>
#include <linux/wait.h>
25 26 27
#include <linux/input.h>
#include <linux/device.h>
#include <linux/interrupt.h>
28
#include <linux/ucb1400.h>
29

30 31
#define UCB1400_TS_POLL_PERIOD	10 /* ms */

32
static bool adcsync;
33 34
static int ts_delay = 55; /* us */
static int ts_delay_pressure;	/* us */
35 36

/* Switch to interrupt mode. */
37
static void ucb1400_ts_mode_int(struct ucb1400_ts *ucb)
38
{
39
	ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
40 41 42 43 44 45 46 47 48
			UCB_TS_CR_TSMX_POW | UCB_TS_CR_TSPX_POW |
			UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_GND |
			UCB_TS_CR_MODE_INT);
}

/*
 * Switch to pressure mode, and read pressure.  We don't need to wait
 * here, since both plates are being driven.
 */
49
static unsigned int ucb1400_ts_read_pressure(struct ucb1400_ts *ucb)
50
{
51
	ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
52 53 54
			UCB_TS_CR_TSMX_POW | UCB_TS_CR_TSPX_POW |
			UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_GND |
			UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
55

56
	udelay(ts_delay_pressure);
57

58
	return ucb1400_adc_read(ucb->ac97, UCB_ADC_INP_TSPY, adcsync);
59 60 61 62 63 64 65 66
}

/*
 * Switch to X position mode and measure Y plate.  We switch the plate
 * configuration in pressure mode, then switch to position mode.  This
 * gives a faster response time.  Even so, we need to wait about 55us
 * for things to stabilise.
 */
67
static unsigned int ucb1400_ts_read_xpos(struct ucb1400_ts *ucb)
68
{
69
	ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
70 71
			UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
			UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
72
	ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
73 74
			UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
			UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
75
	ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
76 77 78
			UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
			UCB_TS_CR_MODE_POS | UCB_TS_CR_BIAS_ENA);

79
	udelay(ts_delay);
80

81
	return ucb1400_adc_read(ucb->ac97, UCB_ADC_INP_TSPY, adcsync);
82 83 84 85 86 87 88 89
}

/*
 * Switch to Y position mode and measure X plate.  We switch the plate
 * configuration in pressure mode, then switch to position mode.  This
 * gives a faster response time.  Even so, we need to wait about 55us
 * for things to stabilise.
 */
90
static int ucb1400_ts_read_ypos(struct ucb1400_ts *ucb)
91
{
92
	ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
93 94
			UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
			UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
95
	ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
96 97
			UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
			UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
98
	ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
99 100 101
			UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
			UCB_TS_CR_MODE_POS | UCB_TS_CR_BIAS_ENA);

102
	udelay(ts_delay);
103

104
	return ucb1400_adc_read(ucb->ac97, UCB_ADC_INP_TSPX, adcsync);
105 106 107 108 109 110
}

/*
 * Switch to X plate resistance mode.  Set MX to ground, PX to
 * supply.  Measure current.
 */
111
static unsigned int ucb1400_ts_read_xres(struct ucb1400_ts *ucb)
112
{
113
	ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
114 115
			UCB_TS_CR_TSMX_GND | UCB_TS_CR_TSPX_POW |
			UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
116
	return ucb1400_adc_read(ucb->ac97, 0, adcsync);
117 118 119 120 121 122
}

/*
 * Switch to Y plate resistance mode.  Set MY to ground, PY to
 * supply.  Measure current.
 */
123
static unsigned int ucb1400_ts_read_yres(struct ucb1400_ts *ucb)
124
{
125
	ucb1400_reg_write(ucb->ac97, UCB_TS_CR,
126 127
			UCB_TS_CR_TSMY_GND | UCB_TS_CR_TSPY_POW |
			UCB_TS_CR_MODE_PRES | UCB_TS_CR_BIAS_ENA);
128
	return ucb1400_adc_read(ucb->ac97, 0, adcsync);
129 130
}

131
static int ucb1400_ts_pen_up(struct ucb1400_ts *ucb)
132
{
133
	unsigned short val = ucb1400_reg_read(ucb->ac97, UCB_TS_CR);
134

135
	return val & (UCB_TS_CR_TSPX_LOW | UCB_TS_CR_TSMX_LOW);
136 137
}

138
static void ucb1400_ts_irq_enable(struct ucb1400_ts *ucb)
139
{
140 141 142
	ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, UCB_IE_TSPX);
	ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0);
	ucb1400_reg_write(ucb->ac97, UCB_IE_FAL, UCB_IE_TSPX);
143 144
}

145
static void ucb1400_ts_irq_disable(struct ucb1400_ts *ucb)
146
{
147
	ucb1400_reg_write(ucb->ac97, UCB_IE_FAL, 0);
148 149
}

150
static void ucb1400_ts_report_event(struct input_dev *idev, u16 pressure, u16 x, u16 y)
151 152 153 154
{
	input_report_abs(idev, ABS_X, x);
	input_report_abs(idev, ABS_Y, y);
	input_report_abs(idev, ABS_PRESSURE, pressure);
155
	input_report_key(idev, BTN_TOUCH, 1);
156 157 158 159 160 161
	input_sync(idev);
}

static void ucb1400_ts_event_release(struct input_dev *idev)
{
	input_report_abs(idev, ABS_PRESSURE, 0);
162
	input_report_key(idev, BTN_TOUCH, 0);
163 164 165
	input_sync(idev);
}

166
static void ucb1400_clear_pending_irq(struct ucb1400_ts *ucb)
167 168 169
{
	unsigned int isr;

170 171 172
	isr = ucb1400_reg_read(ucb->ac97, UCB_IE_STATUS);
	ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, isr);
	ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0);
173

174
	if (isr & UCB_IE_TSPX)
175
		ucb1400_ts_irq_disable(ucb);
176
	else
177 178
		dev_dbg(&ucb->ts_idev->dev,
			"ucb1400: unexpected IE_STATUS = %#x\n", isr);
179 180
}

181 182 183 184 185 186 187 188
/*
 * A restriction with interrupts exists when using the ucb1400, as
 * the codec read/write routines may sleep while waiting for codec
 * access completion and uses semaphores for access control to the
 * AC97 bus. Therefore the driver is forced to use threaded interrupt
 * handler.
 */
static irqreturn_t ucb1400_irq(int irqnr, void *devid)
189
{
190 191 192
	struct ucb1400_ts *ucb = devid;
	unsigned int x, y, p;
	bool penup;
193

194 195
	if (unlikely(irqnr != ucb->irq))
		return IRQ_NONE;
196

197
	ucb1400_clear_pending_irq(ucb);
198

199 200
	/* Start with a small delay before checking pendown state */
	msleep(UCB1400_TS_POLL_PERIOD);
201

202
	while (!ucb->stopped && !(penup = ucb1400_ts_pen_up(ucb))) {
203

204
		ucb1400_adc_enable(ucb->ac97);
205 206 207
		x = ucb1400_ts_read_xpos(ucb);
		y = ucb1400_ts_read_ypos(ucb);
		p = ucb1400_ts_read_pressure(ucb);
208
		ucb1400_adc_disable(ucb->ac97);
209

210
		ucb1400_ts_report_event(ucb->ts_idev, p, x, y);
211

212 213
		wait_event_timeout(ucb->ts_wait, ucb->stopped,
				   msecs_to_jiffies(UCB1400_TS_POLL_PERIOD));
214 215
	}

216
	ucb1400_ts_event_release(ucb->ts_idev);
217

218 219 220 221 222 223 224
	if (!ucb->stopped) {
		/* Switch back to interrupt mode. */
		ucb1400_ts_mode_int(ucb);
		ucb1400_ts_irq_enable(ucb);
	}

	return IRQ_HANDLED;
225 226
}

227
static void ucb1400_ts_stop(struct ucb1400_ts *ucb)
228
{
229 230 231 232 233
	/* Signal IRQ thread to stop polling and disable the handler. */
	ucb->stopped = true;
	mb();
	wake_up(&ucb->ts_wait);
	disable_irq(ucb->irq);
234

235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
	ucb1400_ts_irq_disable(ucb);
	ucb1400_reg_write(ucb->ac97, UCB_TS_CR, 0);
}

/* Must be called with ts->lock held */
static void ucb1400_ts_start(struct ucb1400_ts *ucb)
{
	/* Tell IRQ thread that it may poll the device. */
	ucb->stopped = false;
	mb();

	ucb1400_ts_mode_int(ucb);
	ucb1400_ts_irq_enable(ucb);

	enable_irq(ucb->irq);
250 251 252 253
}

static int ucb1400_ts_open(struct input_dev *idev)
{
254
	struct ucb1400_ts *ucb = input_get_drvdata(idev);
255

256
	ucb1400_ts_start(ucb);
257

258
	return 0;
259 260 261 262
}

static void ucb1400_ts_close(struct input_dev *idev)
{
263
	struct ucb1400_ts *ucb = input_get_drvdata(idev);
264

265
	ucb1400_ts_stop(ucb);
266 267 268 269 270 271 272 273 274 275
}

#ifndef NO_IRQ
#define NO_IRQ	0
#endif

/*
 * Try to probe our interrupt, rather than relying on lots of
 * hard-coded machine dependencies.
 */
276
static int ucb1400_ts_detect_irq(struct ucb1400_ts *ucb,
277
					   struct platform_device *pdev)
278 279 280 281 282 283
{
	unsigned long mask, timeout;

	mask = probe_irq_on();

	/* Enable the ADC interrupt. */
284 285 286 287
	ucb1400_reg_write(ucb->ac97, UCB_IE_RIS, UCB_IE_ADC);
	ucb1400_reg_write(ucb->ac97, UCB_IE_FAL, UCB_IE_ADC);
	ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0xffff);
	ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0);
288 289

	/* Cause an ADC interrupt. */
290 291
	ucb1400_reg_write(ucb->ac97, UCB_ADC_CR, UCB_ADC_ENA);
	ucb1400_reg_write(ucb->ac97, UCB_ADC_CR, UCB_ADC_ENA | UCB_ADC_START);
292 293 294

	/* Wait for the conversion to complete. */
	timeout = jiffies + HZ/2;
295 296
	while (!(ucb1400_reg_read(ucb->ac97, UCB_ADC_DATA) &
						UCB_ADC_DAT_VALID)) {
297 298
		cpu_relax();
		if (time_after(jiffies, timeout)) {
299
			dev_err(&pdev->dev, "timed out in IRQ probe\n");
300 301 302 303
			probe_irq_off(mask);
			return -ENODEV;
		}
	}
304
	ucb1400_reg_write(ucb->ac97, UCB_ADC_CR, 0);
305 306

	/* Disable and clear interrupt. */
307 308 309 310
	ucb1400_reg_write(ucb->ac97, UCB_IE_RIS, 0);
	ucb1400_reg_write(ucb->ac97, UCB_IE_FAL, 0);
	ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0xffff);
	ucb1400_reg_write(ucb->ac97, UCB_IE_CLEAR, 0);
311 312 313 314 315 316 317 318 319

	/* Read triggered interrupt. */
	ucb->irq = probe_irq_off(mask);
	if (ucb->irq < 0 || ucb->irq == NO_IRQ)
		return -ENODEV;

	return 0;
}

320
static int ucb1400_ts_probe(struct platform_device *pdev)
321
{
Jingoo Han's avatar
Jingoo Han committed
322
	struct ucb1400_ts *ucb = dev_get_platdata(&pdev->dev);
323
	int error, x_res, y_res;
324
	u16 fcsr;
325

326 327
	ucb->ts_idev = input_allocate_device();
	if (!ucb->ts_idev) {
328
		error = -ENOMEM;
329
		goto err;
330 331
	}

332 333
	/* Only in case the IRQ line wasn't supplied, try detecting it */
	if (ucb->irq < 0) {
334
		error = ucb1400_ts_detect_irq(ucb, pdev);
335
		if (error) {
336
			dev_err(&pdev->dev, "IRQ probe failed\n");
337 338
			goto err_free_devs;
		}
339
	}
340
	dev_dbg(&pdev->dev, "found IRQ %d\n", ucb->irq);
341

342 343 344
	init_waitqueue_head(&ucb->ts_wait);

	input_set_drvdata(ucb->ts_idev, ucb);
345

346
	ucb->ts_idev->dev.parent	= &pdev->dev;
347 348 349 350 351 352
	ucb->ts_idev->name		= "UCB1400 touchscreen interface";
	ucb->ts_idev->id.vendor		= ucb1400_reg_read(ucb->ac97,
						AC97_VENDOR_ID1);
	ucb->ts_idev->id.product	= ucb->id;
	ucb->ts_idev->open		= ucb1400_ts_open;
	ucb->ts_idev->close		= ucb1400_ts_close;
353 354
	ucb->ts_idev->evbit[0]		= BIT_MASK(EV_ABS) | BIT_MASK(EV_KEY);
	ucb->ts_idev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
355

356 357 358 359 360 361 362 363
	/*
	 * Enable ADC filter to prevent horrible jitter on Colibri.
	 * This also further reduces jitter on boards where ADCSYNC
	 * pin is connected.
	 */
	fcsr = ucb1400_reg_read(ucb->ac97, UCB_FCSR);
	ucb1400_reg_write(ucb->ac97, UCB_FCSR, fcsr | UCB_FCSR_AVE);

364
	ucb1400_adc_enable(ucb->ac97);
365 366
	x_res = ucb1400_ts_read_xres(ucb);
	y_res = ucb1400_ts_read_yres(ucb);
367
	ucb1400_adc_disable(ucb->ac97);
368
	dev_dbg(&pdev->dev, "x/y = %d/%d\n", x_res, y_res);
369

370 371 372
	input_set_abs_params(ucb->ts_idev, ABS_X, 0, x_res, 0, 0);
	input_set_abs_params(ucb->ts_idev, ABS_Y, 0, y_res, 0, 0);
	input_set_abs_params(ucb->ts_idev, ABS_PRESSURE, 0, 0, 0, 0);
373

374 375 376 377 378 379
	ucb1400_ts_stop(ucb);

	error = request_threaded_irq(ucb->irq, NULL, ucb1400_irq,
				     IRQF_TRIGGER_RISING | IRQF_ONESHOT,
				     "UCB1400", ucb);
	if (error) {
380 381
		dev_err(&pdev->dev,
			"unable to grab irq%d: %d\n", ucb->irq, error);
382 383 384
		goto err_free_devs;
	}

385
	error = input_register_device(ucb->ts_idev);
386 387 388 389 390
	if (error)
		goto err_free_irq;

	return 0;

391
err_free_irq:
392
	free_irq(ucb->irq, ucb);
393 394 395
err_free_devs:
	input_free_device(ucb->ts_idev);
err:
396 397 398
	return error;
}

399
static int ucb1400_ts_remove(struct platform_device *pdev)
400
{
Jingoo Han's avatar
Jingoo Han committed
401
	struct ucb1400_ts *ucb = dev_get_platdata(&pdev->dev);
402 403 404

	free_irq(ucb->irq, ucb);
	input_unregister_device(ucb->ts_idev);
405

406 407 408
	return 0;
}

409
static int __maybe_unused ucb1400_ts_suspend(struct device *dev)
410
{
Jingoo Han's avatar
Jingoo Han committed
411
	struct ucb1400_ts *ucb = dev_get_platdata(dev);
412 413 414 415 416
	struct input_dev *idev = ucb->ts_idev;

	mutex_lock(&idev->mutex);

	if (idev->users)
417
		ucb1400_ts_stop(ucb);
418 419 420 421 422

	mutex_unlock(&idev->mutex);
	return 0;
}

423
static int __maybe_unused ucb1400_ts_resume(struct device *dev)
424
{
Jingoo Han's avatar
Jingoo Han committed
425
	struct ucb1400_ts *ucb = dev_get_platdata(dev);
426
	struct input_dev *idev = ucb->ts_idev;
427

428 429 430
	mutex_lock(&idev->mutex);

	if (idev->users)
431
		ucb1400_ts_start(ucb);
432 433

	mutex_unlock(&idev->mutex);
434 435 436
	return 0;
}

437 438
static SIMPLE_DEV_PM_OPS(ucb1400_ts_pm_ops,
			 ucb1400_ts_suspend, ucb1400_ts_resume);
439

440 441
static struct platform_driver ucb1400_ts_driver = {
	.probe	= ucb1400_ts_probe,
442
	.remove	= ucb1400_ts_remove,
443 444
	.driver	= {
		.name	= "ucb1400_ts",
445
		.pm	= &ucb1400_ts_pm_ops,
446
	},
447
};
448
module_platform_driver(ucb1400_ts_driver);
449

450 451 452 453
module_param(adcsync, bool, 0444);
MODULE_PARM_DESC(adcsync, "Synchronize touch readings with ADCSYNC pin.");

module_param(ts_delay, int, 0444);
454 455
MODULE_PARM_DESC(ts_delay, "Delay between panel setup and"
			    " position read. Default = 55us.");
456 457 458

module_param(ts_delay_pressure, int, 0444);
MODULE_PARM_DESC(ts_delay_pressure,
459 460
		"delay between panel setup and pressure read."
		"  Default = 0us.");
461 462 463

MODULE_DESCRIPTION("Philips UCB1400 touchscreen driver");
MODULE_LICENSE("GPL");