ti_am335x_tsc.c 13.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/*
 * TI Touch Screen driver
 *
 * Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation version 2.
 *
 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
 * kind, whether express or implied; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */


#include <linux/kernel.h>
#include <linux/err.h>
#include <linux/module.h>
#include <linux/input.h>
#include <linux/slab.h>
#include <linux/interrupt.h>
#include <linux/clk.h>
#include <linux/platform_device.h>
#include <linux/io.h>
#include <linux/delay.h>
27 28
#include <linux/of.h>
#include <linux/of_device.h>
29
#include <linux/sort.h>
30
#include <linux/pm_wakeirq.h>
31

32
#include <linux/mfd/ti_am335x_tscadc.h>
33 34

#define ADCFSM_STEPID		0x10
35 36 37
#define SEQ_SETTLE		275
#define MAX_12BIT		((1 << 12) - 1)

38 39
#define TSC_IRQENB_MASK		(IRQENB_FIFO0THRES | IRQENB_EOS | IRQENB_HW_PEN)

40 41 42 43 44 45 46
static const int config_pins[] = {
	STEPCONFIG_XPP,
	STEPCONFIG_XNN,
	STEPCONFIG_YPP,
	STEPCONFIG_YNN,
};

47
struct titsc {
48
	struct input_dev	*input;
49
	struct ti_tscadc_dev	*mfd_tscadc;
50
	struct device		*dev;
51 52 53 54
	unsigned int		irq;
	unsigned int		wires;
	unsigned int		x_plate_resistance;
	bool			pen_down;
55
	int			coordinate_readouts;
56 57 58
	u32			config_inp[4];
	u32			bit_xp, bit_xn, bit_yp, bit_yn;
	u32			inp_xp, inp_xn, inp_yp, inp_yn;
59
	u32			step_mask;
60
	u32			charge_delay;
61 62
};

63
static unsigned int titsc_readl(struct titsc *ts, unsigned int reg)
64
{
65
	return readl(ts->mfd_tscadc->tscadc_base + reg);
66 67
}

68
static void titsc_writel(struct titsc *tsc, unsigned int reg,
69 70
					unsigned int val)
{
71
	writel(val, tsc->mfd_tscadc->tscadc_base + reg);
72 73
}

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
static int titsc_config_wires(struct titsc *ts_dev)
{
	u32 analog_line[4];
	u32 wire_order[4];
	int i, bit_cfg;

	for (i = 0; i < 4; i++) {
		/*
		 * Get the order in which TSC wires are attached
		 * w.r.t. each of the analog input lines on the EVM.
		 */
		analog_line[i] = (ts_dev->config_inp[i] & 0xF0) >> 4;
		wire_order[i] = ts_dev->config_inp[i] & 0x0F;
		if (WARN_ON(analog_line[i] > 7))
			return -EINVAL;
		if (WARN_ON(wire_order[i] > ARRAY_SIZE(config_pins)))
			return -EINVAL;
	}

	for (i = 0; i < 4; i++) {
		int an_line;
		int wi_order;

		an_line = analog_line[i];
		wi_order = wire_order[i];
		bit_cfg = config_pins[wi_order];
		if (bit_cfg == 0)
			return -EINVAL;
		switch (wi_order) {
		case 0:
			ts_dev->bit_xp = bit_cfg;
			ts_dev->inp_xp = an_line;
			break;

		case 1:
			ts_dev->bit_xn = bit_cfg;
			ts_dev->inp_xn = an_line;
			break;

		case 2:
			ts_dev->bit_yp = bit_cfg;
			ts_dev->inp_yp = an_line;
			break;
		case 3:
			ts_dev->bit_yn = bit_cfg;
			ts_dev->inp_yn = an_line;
			break;
		}
	}
	return 0;
}

126
static void titsc_step_config(struct titsc *ts_dev)
127 128
{
	unsigned int	config;
129
	int i;
130
	int end_step, first_step, tsc_steps;
131
	u32 stepenable;
132 133

	config = STEPCONFIG_MODE_HWSYNC |
134
			STEPCONFIG_AVG_16 | ts_dev->bit_xp;
135 136
	switch (ts_dev->wires) {
	case 4:
137
		config |= STEPCONFIG_INP(ts_dev->inp_yp) | ts_dev->bit_xn;
138 139
		break;
	case 5:
140 141 142
		config |= ts_dev->bit_yn |
				STEPCONFIG_INP_AN4 | ts_dev->bit_xn |
				ts_dev->bit_yp;
143 144
		break;
	case 8:
145
		config |= STEPCONFIG_INP(ts_dev->inp_yp) | ts_dev->bit_xn;
146 147 148
		break;
	}

149 150 151 152 153
	tsc_steps = ts_dev->coordinate_readouts * 2 + 2;
	first_step = TOTAL_STEPS - tsc_steps;
	/* Steps 16 to 16-coordinate_readouts is for X */
	end_step = first_step + tsc_steps;
	for (i = end_step - ts_dev->coordinate_readouts; i < end_step; i++) {
154 155
		titsc_writel(ts_dev, REG_STEPCONFIG(i), config);
		titsc_writel(ts_dev, REG_STEPDELAY(i), STEPCONFIG_OPENDLY);
156 157 158 159
	}

	config = 0;
	config = STEPCONFIG_MODE_HWSYNC |
160
			STEPCONFIG_AVG_16 | ts_dev->bit_yn |
161
			STEPCONFIG_INM_ADCREFM;
162 163
	switch (ts_dev->wires) {
	case 4:
164
		config |= ts_dev->bit_yp | STEPCONFIG_INP(ts_dev->inp_xp);
165 166
		break;
	case 5:
167
		config |= ts_dev->bit_xp | STEPCONFIG_INP_AN4 |
168
				STEPCONFIG_XNP | STEPCONFIG_YPN;
169 170
		break;
	case 8:
171
		config |= ts_dev->bit_yp | STEPCONFIG_INP(ts_dev->inp_xp);
172 173 174
		break;
	}

175 176 177
	/* 1 ... coordinate_readouts is for Y */
	end_step = first_step + ts_dev->coordinate_readouts;
	for (i = first_step; i < end_step; i++) {
178 179
		titsc_writel(ts_dev, REG_STEPCONFIG(i), config);
		titsc_writel(ts_dev, REG_STEPDELAY(i), STEPCONFIG_OPENDLY);
180 181
	}

182
	/* Make CHARGECONFIG same as IDLECONFIG */
183

184
	config = titsc_readl(ts_dev, REG_IDLECONFIG);
185
	titsc_writel(ts_dev, REG_CHARGECONFIG, config);
186
	titsc_writel(ts_dev, REG_CHARGEDELAY, ts_dev->charge_delay);
187

188
	/* coordinate_readouts + 1 ... coordinate_readouts + 2 is for Z */
189
	config = STEPCONFIG_MODE_HWSYNC |
190 191 192
			STEPCONFIG_AVG_16 | ts_dev->bit_yp |
			ts_dev->bit_xn | STEPCONFIG_INM_ADCREFM |
			STEPCONFIG_INP(ts_dev->inp_xp);
193 194
	titsc_writel(ts_dev, REG_STEPCONFIG(end_step), config);
	titsc_writel(ts_dev, REG_STEPDELAY(end_step),
195
			STEPCONFIG_OPENDLY);
196

197 198 199 200
	end_step++;
	config |= STEPCONFIG_INP(ts_dev->inp_yn);
	titsc_writel(ts_dev, REG_STEPCONFIG(end_step), config);
	titsc_writel(ts_dev, REG_STEPDELAY(end_step),
201
			STEPCONFIG_OPENDLY);
202

203 204 205 206 207
	/* The steps end ... end - readouts * 2 + 2 and bit 0 for TS_Charge */
	stepenable = 1;
	for (i = 0; i < tsc_steps; i++)
		stepenable |= 1 << (first_step + i + 1);

208
	ts_dev->step_mask = stepenable;
209
	am335x_tsc_se_set_cache(ts_dev->mfd_tscadc, ts_dev->step_mask);
210 211
}

212 213 214 215 216
static int titsc_cmp_coord(const void *a, const void *b)
{
	return *(int *)a - *(int *)b;
}

217
static void titsc_read_coordinates(struct titsc *ts_dev,
218
		u32 *x, u32 *y, u32 *z1, u32 *z2)
219
{
220 221
	unsigned int yvals[7], xvals[7];
	unsigned int i, xsum = 0, ysum = 0;
222
	unsigned int creads = ts_dev->coordinate_readouts;
223

224 225 226 227
	for (i = 0; i < creads; i++) {
		yvals[i] = titsc_readl(ts_dev, REG_FIFO0);
		yvals[i] &= 0xfff;
	}
228

229 230 231 232
	*z1 = titsc_readl(ts_dev, REG_FIFO0);
	*z1 &= 0xfff;
	*z2 = titsc_readl(ts_dev, REG_FIFO0);
	*z2 &= 0xfff;
233

234 235 236 237
	for (i = 0; i < creads; i++) {
		xvals[i] = titsc_readl(ts_dev, REG_FIFO0);
		xvals[i] &= 0xfff;
	}
238

239 240 241 242 243 244 245 246 247 248 249
	/*
	 * If co-ordinates readouts is less than 4 then
	 * report the average. In case of 4 or more
	 * readouts, sort the co-ordinate samples, drop
	 * min and max values and report the average of
	 * remaining values.
	 */
	if (creads <=  3) {
		for (i = 0; i < creads; i++) {
			ysum += yvals[i];
			xsum += xvals[i];
250
		}
251 252 253 254 255 256 257 258 259 260 261 262 263
		ysum /= creads;
		xsum /= creads;
	} else {
		sort(yvals, creads, sizeof(unsigned int),
		     titsc_cmp_coord, NULL);
		sort(xvals, creads, sizeof(unsigned int),
		     titsc_cmp_coord, NULL);
		for (i = 1; i < creads - 1; i++) {
			ysum += yvals[i];
			xsum += xvals[i];
		}
		ysum /= creads - 2;
		xsum /= creads - 2;
264
	}
265 266
	*y = ysum;
	*x = xsum;
267 268
}

269
static irqreturn_t titsc_irq(int irq, void *dev)
270
{
271
	struct titsc *ts_dev = dev;
272
	struct input_dev *input_dev = ts_dev->input;
273
	unsigned int fsm, status, irqclr = 0;
274 275 276
	unsigned int x = 0, y = 0;
	unsigned int z1, z2, z;

277 278 279 280
	status = titsc_readl(ts_dev, REG_RAWIRQSTATUS);
	if (status & IRQENB_HW_PEN) {
		ts_dev->pen_down = true;
		irqclr |= IRQENB_HW_PEN;
281
		pm_stay_awake(ts_dev->dev);
282 283 284 285 286 287 288 289 290
	}

	if (status & IRQENB_PENUP) {
		fsm = titsc_readl(ts_dev, REG_ADCFSM);
		if (fsm == ADCFSM_STEPID) {
			ts_dev->pen_down = false;
			input_report_key(input_dev, BTN_TOUCH, 0);
			input_report_abs(input_dev, ABS_PRESSURE, 0);
			input_sync(input_dev);
291
			pm_relax(ts_dev->dev);
292 293 294 295 296 297 298 299 300
		} else {
			ts_dev->pen_down = true;
		}
		irqclr |= IRQENB_PENUP;
	}

	if (status & IRQENB_EOS)
		irqclr |= IRQENB_EOS;

301 302 303 304
	/*
	 * ADC and touchscreen share the IRQ line.
	 * FIFO1 interrupts are used by ADC. Handle FIFO0 IRQs here only
	 */
305
	if (status & IRQENB_FIFO0THRES) {
306

307
		titsc_read_coordinates(ts_dev, &x, &y, &z1, &z2);
308

309 310 311 312 313 314
		if (ts_dev->pen_down && z1 != 0 && z2 != 0) {
			/*
			 * Calculate pressure using formula
			 * Resistance(touch) = x plate resistance *
			 * x postion/4096 * ((z2 / z1) - 1)
			 */
315
			z = z1 - z2;
316 317
			z *= x;
			z *= ts_dev->x_plate_resistance;
318
			z /= z2;
319 320 321 322 323 324 325 326 327 328
			z = (z + 2047) >> 12;

			if (z <= MAX_12BIT) {
				input_report_abs(input_dev, ABS_X, x);
				input_report_abs(input_dev, ABS_Y, y);
				input_report_abs(input_dev, ABS_PRESSURE, z);
				input_report_key(input_dev, BTN_TOUCH, 1);
				input_sync(input_dev);
			}
		}
329
		irqclr |= IRQENB_FIFO0THRES;
330
	}
331 332
	if (irqclr) {
		titsc_writel(ts_dev, REG_IRQSTATUS, irqclr);
333 334 335
		if (status & IRQENB_EOS)
			am335x_tsc_se_set_cache(ts_dev->mfd_tscadc,
						ts_dev->step_mask);
336 337 338
		return IRQ_HANDLED;
	}
	return IRQ_NONE;
339 340
}

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
static int titsc_parse_dt(struct platform_device *pdev,
					struct titsc *ts_dev)
{
	struct device_node *node = pdev->dev.of_node;
	int err;

	if (!node)
		return -EINVAL;

	err = of_property_read_u32(node, "ti,wires", &ts_dev->wires);
	if (err < 0)
		return err;
	switch (ts_dev->wires) {
	case 4:
	case 5:
	case 8:
		break;
	default:
		return -EINVAL;
	}

	err = of_property_read_u32(node, "ti,x-plate-resistance",
			&ts_dev->x_plate_resistance);
	if (err < 0)
		return err;

367 368 369 370 371
	/*
	 * Try with the new binding first. If it fails, try again with
	 * bogus, miss-spelled version.
	 */
	err = of_property_read_u32(node, "ti,coordinate-readouts",
372
			&ts_dev->coordinate_readouts);
373 374
	if (err < 0) {
		dev_warn(&pdev->dev, "please use 'ti,coordinate-readouts' instead\n");
375 376
		err = of_property_read_u32(node, "ti,coordiante-readouts",
				&ts_dev->coordinate_readouts);
377 378
	}

379 380 381
	if (err < 0)
		return err;

382 383 384 385 386 387
	if (ts_dev->coordinate_readouts <= 0) {
		dev_warn(&pdev->dev,
			 "invalid co-ordinate readouts, resetting it to 5\n");
		ts_dev->coordinate_readouts = 5;
	}

388 389 390 391 392 393 394 395 396 397 398
	err = of_property_read_u32(node, "ti,charge-delay",
				   &ts_dev->charge_delay);
	/*
	 * If ti,charge-delay value is not specified, then use
	 * CHARGEDLY_OPENDLY as the default value.
	 */
	if (err < 0) {
		ts_dev->charge_delay = CHARGEDLY_OPENDLY;
		dev_warn(&pdev->dev, "ti,charge-delay not specified\n");
	}

399 400
	return of_property_read_u32_array(node, "ti,wire-config",
			ts_dev->config_inp, ARRAY_SIZE(ts_dev->config_inp));
401 402 403 404 405 406
}

/*
 * The functions for inserting/removing driver as a module.
 */

407
static int titsc_probe(struct platform_device *pdev)
408
{
409
	struct titsc *ts_dev;
410
	struct input_dev *input_dev;
411
	struct ti_tscadc_dev *tscadc_dev = ti_tscadc_dev_get(pdev);
412 413 414
	int err;

	/* Allocate memory for device */
415
	ts_dev = kzalloc(sizeof(*ts_dev), GFP_KERNEL);
416 417 418 419 420 421 422
	input_dev = input_allocate_device();
	if (!ts_dev || !input_dev) {
		dev_err(&pdev->dev, "failed to allocate memory.\n");
		err = -ENOMEM;
		goto err_free_mem;
	}

423 424
	tscadc_dev->tsc = ts_dev;
	ts_dev->mfd_tscadc = tscadc_dev;
425
	ts_dev->input = input_dev;
426
	ts_dev->irq = tscadc_dev->irq;
427
	ts_dev->dev = &pdev->dev;
428

429
	err = titsc_parse_dt(pdev, ts_dev);
430 431 432 433
	if (err) {
		dev_err(&pdev->dev, "Could not find valid DT data.\n");
		goto err_free_mem;
	}
434

435
	err = request_irq(ts_dev->irq, titsc_irq,
436
			  IRQF_SHARED, pdev->dev.driver->name, ts_dev);
437 438
	if (err) {
		dev_err(&pdev->dev, "failed to allocate irq.\n");
439
		goto err_free_mem;
440 441
	}

442
	device_init_wakeup(&pdev->dev, true);
443 444 445
	err = dev_pm_set_wake_irq(&pdev->dev, ts_dev->irq);
	if (err)
		dev_err(&pdev->dev, "irq wake enable failed.\n");
446

447
	titsc_writel(ts_dev, REG_IRQSTATUS, TSC_IRQENB_MASK);
448
	titsc_writel(ts_dev, REG_IRQENABLE, IRQENB_FIFO0THRES);
449
	titsc_writel(ts_dev, REG_IRQENABLE, IRQENB_EOS);
450 451 452 453 454
	err = titsc_config_wires(ts_dev);
	if (err) {
		dev_err(&pdev->dev, "wrong i/p wire configuration\n");
		goto err_free_irq;
	}
455
	titsc_step_config(ts_dev);
456 457
	titsc_writel(ts_dev, REG_FIFO0THR,
			ts_dev->coordinate_readouts * 2 + 2 - 1);
458

459
	input_dev->name = "ti-tsc";
460 461 462 463 464 465 466 467 468 469 470 471
	input_dev->dev.parent = &pdev->dev;

	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
	input_dev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);

	input_set_abs_params(input_dev, ABS_X, 0, MAX_12BIT, 0, 0);
	input_set_abs_params(input_dev, ABS_Y, 0, MAX_12BIT, 0, 0);
	input_set_abs_params(input_dev, ABS_PRESSURE, 0, MAX_12BIT, 0, 0);

	/* register to the input system */
	err = input_register_device(input_dev);
	if (err)
472
		goto err_free_irq;
473 474 475 476 477

	platform_set_drvdata(pdev, ts_dev);
	return 0;

err_free_irq:
478
	dev_pm_clear_wake_irq(&pdev->dev);
479
	device_init_wakeup(&pdev->dev, false);
480 481 482 483 484 485 486
	free_irq(ts_dev->irq, ts_dev);
err_free_mem:
	input_free_device(input_dev);
	kfree(ts_dev);
	return err;
}

487
static int titsc_remove(struct platform_device *pdev)
488
{
489 490
	struct titsc *ts_dev = platform_get_drvdata(pdev);
	u32 steps;
491

492
	dev_pm_clear_wake_irq(&pdev->dev);
493
	device_init_wakeup(&pdev->dev, false);
494 495
	free_irq(ts_dev->irq, ts_dev);

496
	/* total steps followed by the enable mask */
497
	steps = 2 * ts_dev->coordinate_readouts + 2;
498 499 500
	steps = (1 << steps) - 1;
	am335x_tsc_se_clr(ts_dev->mfd_tscadc, steps);

501 502
	input_unregister_device(ts_dev->input);

503 504 505
	kfree(ts_dev);
	return 0;
}
506

507
static int __maybe_unused titsc_suspend(struct device *dev)
508
{
509 510
	struct titsc *ts_dev = dev_get_drvdata(dev);
	struct ti_tscadc_dev *tscadc_dev;
511 512
	unsigned int idle;

513
	tscadc_dev = ti_tscadc_dev_get(to_platform_device(dev));
514
	if (device_may_wakeup(dev)) {
515
		titsc_writel(ts_dev, REG_IRQSTATUS, TSC_IRQENB_MASK);
516 517 518 519 520 521 522
		idle = titsc_readl(ts_dev, REG_IRQENABLE);
		titsc_writel(ts_dev, REG_IRQENABLE,
				(idle | IRQENB_HW_PEN));
		titsc_writel(ts_dev, REG_IRQWAKEUP, IRQWKUP_ENB);
	}
	return 0;
}
523

524
static int __maybe_unused titsc_resume(struct device *dev)
525
{
526 527
	struct titsc *ts_dev = dev_get_drvdata(dev);
	struct ti_tscadc_dev *tscadc_dev;
528

529
	tscadc_dev = ti_tscadc_dev_get(to_platform_device(dev));
530
	if (device_may_wakeup(dev)) {
531 532 533
		titsc_writel(ts_dev, REG_IRQWAKEUP,
				0x00);
		titsc_writel(ts_dev, REG_IRQCLR, IRQENB_HW_PEN);
534
		pm_relax(dev);
535 536 537
	}
	titsc_step_config(ts_dev);
	titsc_writel(ts_dev, REG_FIFO0THR,
538
			ts_dev->coordinate_readouts * 2 + 2 - 1);
539 540 541
	return 0;
}

542
static SIMPLE_DEV_PM_OPS(titsc_pm_ops, titsc_suspend, titsc_resume);
543

544 545 546 547 548 549
static const struct of_device_id ti_tsc_dt_ids[] = {
	{ .compatible = "ti,am3359-tsc", },
	{ }
};
MODULE_DEVICE_TABLE(of, ti_tsc_dt_ids);

550
static struct platform_driver ti_tsc_driver = {
551
	.probe	= titsc_probe,
552
	.remove	= titsc_remove,
553
	.driver	= {
554
		.name   = "TI-am335x-tsc",
555
		.pm	= &titsc_pm_ops,
556
		.of_match_table = ti_tsc_dt_ids,
557 558 559 560 561 562 563
	},
};
module_platform_driver(ti_tsc_driver);

MODULE_DESCRIPTION("TI touchscreen controller driver");
MODULE_AUTHOR("Rachna Patil <rachna@ti.com>");
MODULE_LICENSE("GPL");