ads7846.c 28.2 KB
Newer Older
D
David Brownell 已提交
1 2 3 4
/*
 * ADS7846 based touchscreen and sensor driver
 *
 * Copyright (c) 2005 David Brownell
I
Imre Deak 已提交
5 6
 * Copyright (c) 2006 Nokia Corporation
 * Various changes: Imre Deak <imre.deak@nokia.com>
D
David Brownell 已提交
7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * Using code from:
 *  - corgi_ts.c
 *	Copyright (C) 2004-2005 Richard Purdie
 *  - omap_ts.[hc], ads7846.h, ts_osk.c
 *	Copyright (C) 2002 MontaVista Software
 *	Copyright (C) 2004 Texas Instruments
 *	Copyright (C) 2005 Dirk Behme
 *
 *  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.
 */
20
#include <linux/hwmon.h>
D
David Brownell 已提交
21
#include <linux/init.h>
22
#include <linux/err.h>
D
David Brownell 已提交
23 24 25 26 27 28
#include <linux/delay.h>
#include <linux/input.h>
#include <linux/interrupt.h>
#include <linux/slab.h>
#include <linux/spi/spi.h>
#include <linux/spi/ads7846.h>
29
#include <asm/irq.h>
D
David Brownell 已提交
30 31 32


/*
33 34
 * This code has been heavily tested on a Nokia 770, and lightly
 * tested on other ads7846 devices (OSK/Mistral, Lubbock).
35
 * TSC2046 is just newer ads7846 silicon.
36 37
 * Support for ads7843 tested on Atmel at91sam926x-EK.
 * Support for ads7845 has only been stubbed in.
D
David Brownell 已提交
38
 *
I
Imre Deak 已提交
39 40 41 42 43 44
 * IRQ handling needs a workaround because of a shortcoming in handling
 * edge triggered IRQs on some platforms like the OMAP1/2. These
 * platforms don't handle the ARM lazy IRQ disabling properly, thus we
 * have to maintain our own SW IRQ disabled status. This should be
 * removed as soon as the affected platform's IRQ handling is fixed.
 *
D
David Brownell 已提交
45 46 47
 * app note sbaa036 talks in more detail about accurate sampling...
 * that ought to help in situations like LCDs inducing noise (which
 * can also be helped by using synch signals) and more generally.
I
Imre Deak 已提交
48 49 50
 * This driver tries to utilize the measures described in the app
 * note. The strength of filtering can be set in the board-* specific
 * files.
D
David Brownell 已提交
51 52
 */

53 54
#define TS_POLL_DELAY	(1 * 1000000)	/* ns delay before the first sample */
#define TS_POLL_PERIOD	(5 * 1000000)	/* ns delay between samples */
D
David Brownell 已提交
55

56 57 58
/* this driver doesn't aim at the peak continuous sample rate */
#define	SAMPLE_BITS	(8 /*cmd*/ + 16 /*sample*/ + 2 /* before, after */)

D
David Brownell 已提交
59 60 61
struct ts_event {
	/* For portability, we can't read 12 bit values using SPI (which
	 * 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.
D
David Brownell 已提交
64
	 */
65 66 67
	u16	x;
	u16	y;
	u16	z1, z2;
68
	int	ignore;
D
David Brownell 已提交
69 70 71
};

struct ads7846 {
72
	struct input_dev	*input;
D
David Brownell 已提交
73 74 75
	char			phys[32];

	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 81
#endif

D
David Brownell 已提交
82
	u16			model;
83
	u16			vref_mv;
D
David Brownell 已提交
84 85
	u16			vref_delay_usecs;
	u16			x_plate_ohms;
86
	u16			pressure_max;
D
David Brownell 已提交
87

88 89
	u8			read_x, read_y, read_z1, read_z2, pwrdown;
	u16			dummy;		/* for the pwrdown read */
D
David Brownell 已提交
90 91
	struct ts_event		tc;

92
	struct spi_transfer	xfer[18];
93
	struct spi_message	msg[5];
94
	struct spi_message	*last_msg;
95 96
	int			msg_idx;
	int			read_cnt;
97
	int			read_rep;
98 99 100 101
	int			last_read;

	u16			debounce_max;
	u16			debounce_tol;
102
	u16			debounce_rep;
D
David Brownell 已提交
103

104 105
	u16			penirq_recheck_delay_usecs;

D
David Brownell 已提交
106
	spinlock_t		lock;
107
	struct hrtimer		timer;
D
David Brownell 已提交
108 109 110 111
	unsigned		pendown:1;	/* P: lock */
	unsigned		pending:1;	/* P: lock */
// FIXME remove "irq_disabled"
	unsigned		irq_disabled:1;	/* P: lock */
I
Imre Deak 已提交
112
	unsigned		disabled:1;
113
	unsigned		is_suspended:1;
114

115 116 117
	int			(*filter)(void *data, int data_idx, int *val);
	void			*filter_data;
	void			(*filter_cleanup)(void *data);
118
	int			(*get_pendown_state)(void);
D
David Brownell 已提交
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
};

/* leave chip selected when we're done, for quicker re-select? */
#if	0
#define	CS_CHANGE(xfer)	((xfer).cs_change = 1)
#else
#define	CS_CHANGE(xfer)	((xfer).cs_change = 0)
#endif

/*--------------------------------------------------------------------------*/

/* The ADS7846 has touchscreen and other sensors.
 * Earlier ads784x chips are somewhat compatible.
 */
#define	ADS_START		(1 << 7)
#define	ADS_A2A1A0_d_y		(1 << 4)	/* differential */
#define	ADS_A2A1A0_d_z1		(3 << 4)	/* differential */
#define	ADS_A2A1A0_d_z2		(4 << 4)	/* differential */
#define	ADS_A2A1A0_d_x		(5 << 4)	/* differential */
#define	ADS_A2A1A0_temp0	(0 << 4)	/* non-differential */
#define	ADS_A2A1A0_vbatt	(2 << 4)	/* non-differential */
#define	ADS_A2A1A0_vaux		(6 << 4)	/* non-differential */
#define	ADS_A2A1A0_temp1	(7 << 4)	/* non-differential */
#define	ADS_8_BIT		(1 << 3)
#define	ADS_12_BIT		(0 << 3)
#define	ADS_SER			(1 << 2)	/* non-differential */
#define	ADS_DFR			(0 << 2)	/* differential */
#define	ADS_PD10_PDOWN		(0 << 0)	/* lowpower mode + penirq */
#define	ADS_PD10_ADC_ON		(1 << 0)	/* ADC on */
#define	ADS_PD10_REF_ON		(2 << 0)	/* vREF on + penirq */
#define	ADS_PD10_ALL_ON		(3 << 0)	/* ADC + vREF on */

#define	MAX_12BIT	((1<<12)-1)

/* leave ADC powered up (disables penirq) between differential samples */
154 155 156
#define	READ_12BIT_DFR(x, adc, vref) (ADS_START | ADS_A2A1A0_d_ ## x \
	| ADS_12_BIT | ADS_DFR | \
	(adc ? ADS_PD10_ADC_ON : 0) | (vref ? ADS_PD10_REF_ON : 0))
D
David Brownell 已提交
157

158 159 160
#define	READ_Y(vref)	(READ_12BIT_DFR(y,  1, vref))
#define	READ_Z1(vref)	(READ_12BIT_DFR(z1, 1, vref))
#define	READ_Z2(vref)	(READ_12BIT_DFR(z2, 1, vref))
161

162 163
#define	READ_X(vref)	(READ_12BIT_DFR(x,  1, vref))
#define	PWRDOWN		(READ_12BIT_DFR(y,  0, 0))	/* LAST */
D
David Brownell 已提交
164 165 166 167 168 169 170

/* single-ended samples need to first power up reference voltage;
 * we leave both ADC and VREF powered
 */
#define	READ_12BIT_SER(x) (ADS_START | ADS_A2A1A0_ ## x \
	| ADS_12_BIT | ADS_SER)

171 172
#define	REF_ON	(READ_12BIT_DFR(x, 1, 1))
#define	REF_OFF	(READ_12BIT_DFR(y, 0, 0))
D
David Brownell 已提交
173 174 175 176 177

/*--------------------------------------------------------------------------*/

/*
 * Non-touchscreen sensors only use single-ended conversions.
178 179
 * The range is GND..vREF. The ads7843 and ads7835 must use external vREF;
 * ads7846 lets that pin be unconnected, to use internal vREF.
D
David Brownell 已提交
180 181 182
 */

struct ser_req {
183
	u8			ref_on;
D
David Brownell 已提交
184
	u8			command;
185
	u8			ref_off;
D
David Brownell 已提交
186 187 188 189 190 191
	u16			scratch;
	__be16			sample;
	struct spi_message	msg;
	struct spi_transfer	xfer[6];
};

I
Imre Deak 已提交
192 193 194
static void ads7846_enable(struct ads7846 *ts);
static void ads7846_disable(struct ads7846 *ts);

195 196 197
static int device_suspended(struct device *dev)
{
	struct ads7846 *ts = dev_get_drvdata(dev);
198
	return ts->is_suspended || ts->disabled;
199 200
}

D
David Brownell 已提交
201 202 203 204
static int ads7846_read12_ser(struct device *dev, unsigned command)
{
	struct spi_device	*spi = to_spi_device(dev);
	struct ads7846		*ts = dev_get_drvdata(dev);
205
	struct ser_req		*req = kzalloc(sizeof *req, GFP_KERNEL);
D
David Brownell 已提交
206
	int			status;
207
	int			use_internal;
D
David Brownell 已提交
208 209 210 211

	if (!req)
		return -ENOMEM;

212
	spi_message_init(&req->msg);
213

214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
	/* FIXME boards with ads7846 might use external vref instead ... */
	use_internal = (ts->model == 7846);

	/* maybe turn on internal vREF, and let it settle */
	if (use_internal) {
		req->ref_on = REF_ON;
		req->xfer[0].tx_buf = &req->ref_on;
		req->xfer[0].len = 1;
		spi_message_add_tail(&req->xfer[0], &req->msg);

		req->xfer[1].rx_buf = &req->scratch;
		req->xfer[1].len = 2;

		/* for 1uF, settle for 800 usec; no cap, 100 usec.  */
		req->xfer[1].delay_usecs = ts->vref_delay_usecs;
		spi_message_add_tail(&req->xfer[1], &req->msg);
	}
D
David Brownell 已提交
231 232 233 234 235

	/* take sample */
	req->command = (u8) command;
	req->xfer[2].tx_buf = &req->command;
	req->xfer[2].len = 1;
236 237
	spi_message_add_tail(&req->xfer[2], &req->msg);

D
David Brownell 已提交
238 239
	req->xfer[3].rx_buf = &req->sample;
	req->xfer[3].len = 2;
240
	spi_message_add_tail(&req->xfer[3], &req->msg);
D
David Brownell 已提交
241 242 243

	/* REVISIT:  take a few more samples, and compare ... */

244 245 246 247 248 249 250 251 252 253
	/* converter in low power mode & enable PENIRQ */
	req->ref_off = PWRDOWN;
	req->xfer[4].tx_buf = &req->ref_off;
	req->xfer[4].len = 1;
	spi_message_add_tail(&req->xfer[4], &req->msg);

	req->xfer[5].rx_buf = &req->scratch;
	req->xfer[5].len = 2;
	CS_CHANGE(req->xfer[5]);
	spi_message_add_tail(&req->xfer[5], &req->msg);
D
David Brownell 已提交
254

255
	ts->irq_disabled = 1;
D
David Brownell 已提交
256 257
	disable_irq(spi->irq);
	status = spi_sync(spi, &req->msg);
258
	ts->irq_disabled = 0;
D
David Brownell 已提交
259 260
	enable_irq(spi->irq);

261 262
	if (status == 0) {
		/* on-wire is a must-ignore bit, a BE12 value, then padding */
263 264 265
		status = be16_to_cpu(req->sample);
		status = status >> 3;
		status &= 0x0fff;
266
	}
D
David Brownell 已提交
267

268
	kfree(req);
269
	return status;
D
David Brownell 已提交
270 271
}

272 273 274
#if defined(CONFIG_HWMON) || defined(CONFIG_HWMON_MODULE)

#define SHOW(name, var, adjust) static ssize_t \
D
David Brownell 已提交
275 276
name ## _show(struct device *dev, struct device_attribute *attr, char *buf) \
{ \
277
	struct ads7846 *ts = dev_get_drvdata(dev); \
D
David Brownell 已提交
278
	ssize_t v = ads7846_read12_ser(dev, \
279
			READ_12BIT_SER(var) | ADS_PD10_ALL_ON); \
D
David Brownell 已提交
280 281
	if (v < 0) \
		return v; \
282
	return sprintf(buf, "%u\n", adjust(ts, v)); \
D
David Brownell 已提交
283 284 285
} \
static DEVICE_ATTR(name, S_IRUGO, name ## _show, NULL);

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309

/* Sysfs conventions report temperatures in millidegrees Celcius.
 * ADS7846 could use the low-accuracy two-sample scheme, but can't do the high
 * accuracy scheme without calibration data.  For now we won't try either;
 * userspace sees raw sensor values, and must scale/calibrate appropriately.
 */
static inline unsigned null_adjust(struct ads7846 *ts, ssize_t v)
{
	return v;
}

SHOW(temp0, temp0, null_adjust)		/* temp1_input */
SHOW(temp1, temp1, null_adjust)		/* temp2_input */


/* sysfs conventions report voltages in millivolts.  We can convert voltages
 * if we know vREF.  userspace may need to scale vAUX to match the board's
 * external resistors; we assume that vBATT only uses the internal ones.
 */
static inline unsigned vaux_adjust(struct ads7846 *ts, ssize_t v)
{
	unsigned retval = v;

	/* external resistors may scale vAUX into 0..vREF */
310
	retval *= ts->vref_mv;
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
	retval = retval >> 12;
	return retval;
}

static inline unsigned vbatt_adjust(struct ads7846 *ts, ssize_t v)
{
	unsigned retval = vaux_adjust(ts, v);

	/* ads7846 has a resistor ladder to scale this signal down */
	if (ts->model == 7846)
		retval *= 4;
	return retval;
}

SHOW(in0_input, vaux, vaux_adjust)
SHOW(in1_input, vbatt, vbatt_adjust)


static struct attribute *ads7846_attributes[] = {
	&dev_attr_temp0.attr,
	&dev_attr_temp1.attr,
	&dev_attr_in0_input.attr,
	&dev_attr_in1_input.attr,
	NULL,
};

static struct attribute_group ads7846_attr_group = {
	.attrs = ads7846_attributes,
};

static struct attribute *ads7843_attributes[] = {
	&dev_attr_in0_input.attr,
	&dev_attr_in1_input.attr,
	NULL,
};

static struct attribute_group ads7843_attr_group = {
	.attrs = ads7843_attributes,
};

static struct attribute *ads7845_attributes[] = {
	&dev_attr_in0_input.attr,
	NULL,
};

static struct attribute_group ads7845_attr_group = {
	.attrs = ads7845_attributes,
};

static int ads784x_hwmon_register(struct spi_device *spi, struct ads7846 *ts)
{
362
	struct device *hwmon;
363 364 365 366 367
	int err;

	/* hwmon sensors need a reference voltage */
	switch (ts->model) {
	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 373 374
		}
		break;
	case 7845:
	case 7843:
375
		if (!ts->vref_mv) {
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
			dev_warn(&spi->dev,
				"external vREF for ADS%d not specified\n",
				ts->model);
			return 0;
		}
		break;
	}

	/* different chips have different sensor groups */
	switch (ts->model) {
	case 7846:
		ts->attr_group = &ads7846_attr_group;
		break;
	case 7845:
		ts->attr_group = &ads7845_attr_group;
		break;
	case 7843:
		ts->attr_group = &ads7843_attr_group;
		break;
	default:
		dev_dbg(&spi->dev, "ADS%d not recognized\n", ts->model);
		return 0;
	}

	err = sysfs_create_group(&spi->dev.kobj, ts->attr_group);
	if (err)
		return err;

	hwmon = hwmon_device_register(&spi->dev);
	if (IS_ERR(hwmon)) {
		sysfs_remove_group(&spi->dev.kobj, ts->attr_group);
		return PTR_ERR(hwmon);
	}

	ts->hwmon = hwmon;
	return 0;
}

static void ads784x_hwmon_unregister(struct spi_device *spi,
				     struct ads7846 *ts)
{
	if (ts->hwmon) {
		sysfs_remove_group(&spi->dev.kobj, ts->attr_group);
		hwmon_device_unregister(ts->hwmon);
	}
}

#else
static inline int ads784x_hwmon_register(struct spi_device *spi,
					 struct ads7846 *ts)
{
	return 0;
}

static inline void ads784x_hwmon_unregister(struct spi_device *spi,
					    struct ads7846 *ts)
{
}
#endif
D
David Brownell 已提交
435

436 437
static int is_pen_down(struct device *dev)
{
438
	struct ads7846	*ts = dev_get_drvdata(dev);
439 440 441 442 443 444 445 446 447 448 449 450

	return ts->pendown;
}

static ssize_t ads7846_pen_down_show(struct device *dev,
				     struct device_attribute *attr, char *buf)
{
	return sprintf(buf, "%u\n", is_pen_down(dev));
}

static DEVICE_ATTR(pen_down, S_IRUGO, ads7846_pen_down_show, NULL);

I
Imre Deak 已提交
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
static ssize_t ads7846_disable_show(struct device *dev,
				     struct device_attribute *attr, char *buf)
{
	struct ads7846	*ts = dev_get_drvdata(dev);

	return sprintf(buf, "%u\n", ts->disabled);
}

static ssize_t ads7846_disable_store(struct device *dev,
				     struct device_attribute *attr,
				     const char *buf, size_t count)
{
	struct ads7846 *ts = dev_get_drvdata(dev);
	char *endp;
	int i;

	i = simple_strtoul(buf, &endp, 10);
	spin_lock_irq(&ts->lock);

	if (i)
		ads7846_disable(ts);
	else
		ads7846_enable(ts);

	spin_unlock_irq(&ts->lock);

	return count;
}

static DEVICE_ATTR(disable, 0664, ads7846_disable_show, ads7846_disable_store);

482
static struct attribute *ads784x_attributes[] = {
483 484 485 486 487
	&dev_attr_pen_down.attr,
	&dev_attr_disable.attr,
	NULL,
};

488 489
static struct attribute_group ads784x_attr_group = {
	.attrs = ads784x_attributes,
490 491
};

D
David Brownell 已提交
492 493 494 495 496 497 498 499 500 501 502 503
/*--------------------------------------------------------------------------*/

/*
 * PENIRQ only kicks the timer.  The timer only reissues the SPI transfer,
 * to retrieve touchscreen status.
 *
 * The SPI transfer completion callback does the real work.  It reports
 * touchscreen events and reactivates the timer (or IRQ) as appropriate.
 */

static void ads7846_rx(void *ads)
{
504 505 506
	struct ads7846		*ts = ads;
	unsigned		Rt;
	u16			x, y, z1, z2;
D
David Brownell 已提交
507

508 509
	/* ads7846_rx_val() did in-place conversion (including byteswap) from
	 * on-the-wire format as part of debouncing to get stable readings.
D
David Brownell 已提交
510
	 */
511 512 513 514
	x = ts->tc.x;
	y = ts->tc.y;
	z1 = ts->tc.z1;
	z2 = ts->tc.z2;
D
David Brownell 已提交
515 516 517 518 519

	/* range filtering */
	if (x == MAX_12BIT)
		x = 0;

520
	if (likely(x && z1)) {
D
David Brownell 已提交
521 522 523 524 525 526 527 528 529 530
		/* compute touch pressure resistance using equation #2 */
		Rt = z2;
		Rt -= z1;
		Rt *= x;
		Rt *= ts->x_plate_ohms;
		Rt /= z1;
		Rt = (Rt + 2047) >> 12;
	} else
		Rt = 0;

531 532 533
	if (ts->model == 7843)
		Rt = ts->pressure_max / 2;

534
	/* Sample found inconsistent by debouncing or pressure is beyond
535 536 537
	 * the maximum. Don't report it to user space, repeat at least
	 * once more the measurement
	 */
538
	if (ts->tc.ignore || Rt > ts->pressure_max) {
539 540 541 542
#ifdef VERBOSE
		pr_debug("%s: ignored %d pressure %d\n",
			ts->spi->dev.bus_id, ts->tc.ignore, Rt);
#endif
543
		hrtimer_start(&ts->timer, ktime_set(0, TS_POLL_PERIOD),
544
			      HRTIMER_MODE_REL);
545 546 547
		return;
	}

548 549 550 551 552 553 554 555 556
	/* Maybe check the pendown state before reporting. This discards
	 * false readings when the pen is lifted.
	 */
	if (ts->penirq_recheck_delay_usecs) {
		udelay(ts->penirq_recheck_delay_usecs);
		if (!ts->get_pendown_state())
			Rt = 0;
	}

557 558 559 560
	/* NOTE: We can't rely on the pressure to determine the pen down
	 * state, even this controller has a pressure sensor.  The pressure
	 * value can fluctuate for quite a while after lifting the pen and
	 * in some cases may not even settle at the expected value.
D
David Brownell 已提交
561
	 *
562 563
	 * The only safe way to check for the pen up condition is in the
	 * timer by reading the pen signal state (it's a GPIO _and_ IRQ).
D
David Brownell 已提交
564 565
	 */
	if (Rt) {
566
		struct input_dev *input = ts->input;
567

568 569 570 571 572
		if (!ts->pendown) {
			input_report_key(input, BTN_TOUCH, 1);
			ts->pendown = 1;
#ifdef VERBOSE
			dev_dbg(&ts->spi->dev, "DOWN\n");
D
David Brownell 已提交
573
#endif
574 575 576 577
		}
		input_report_abs(input, ABS_X, x);
		input_report_abs(input, ABS_Y, y);
		input_report_abs(input, ABS_PRESSURE, Rt);
D
David Brownell 已提交
578

579 580 581 582 583
		input_sync(input);
#ifdef VERBOSE
		dev_dbg(&ts->spi->dev, "%4d/%4d/%4d\n", x, y, Rt);
#endif
	}
D
David Brownell 已提交
584

585 586
	hrtimer_start(&ts->timer, ktime_set(0, TS_POLL_PERIOD),
			HRTIMER_MODE_REL);
D
David Brownell 已提交
587 588
}

589
static int ads7846_debounce(void *ads, int data_idx, int *val)
590 591 592
{
	struct ads7846		*ts = ads;

593 594 595
	if (!ts->read_cnt || (abs(ts->last_read - *val) > ts->debounce_tol)) {
		/* Start over collecting consistent readings. */
		ts->read_rep = 0;
596 597 598
		/* Repeat it, if this was the first read or the read
		 * wasn't consistent enough. */
		if (ts->read_cnt < ts->debounce_max) {
599
			ts->last_read = *val;
600
			ts->read_cnt++;
601
			return ADS7846_FILTER_REPEAT;
602 603 604 605 606 607 608
		} else {
			/* Maximum number of debouncing reached and still
			 * not enough number of consistent readings. Abort
			 * the whole sample, repeat it in the next sampling
			 * period.
			 */
			ts->read_cnt = 0;
609
			return ADS7846_FILTER_IGNORE;
610
		}
611
	} else {
612 613 614 615 616
		if (++ts->read_rep > ts->debounce_rep) {
			/* Got a good reading for this coordinate,
			 * go for the next one. */
			ts->read_cnt = 0;
			ts->read_rep = 0;
617 618
			return ADS7846_FILTER_OK;
		} else {
619 620
			/* Read more values that are consistent. */
			ts->read_cnt++;
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
			return ADS7846_FILTER_REPEAT;
		}
	}
}

static int ads7846_no_filter(void *ads, int data_idx, int *val)
{
	return ADS7846_FILTER_OK;
}

static void ads7846_rx_val(void *ads)
{
	struct ads7846 *ts = ads;
	struct spi_message *m;
	struct spi_transfer *t;
	int val;
	int action;
	int status;

	m = &ts->msg[ts->msg_idx];
	t = list_entry(m->transfers.prev, struct spi_transfer, transfer_list);

	/* adjust:  on-wire is a must-ignore bit, a BE12 value, then padding;
	 * built from two 8 bit values written msb-first.
	 */
646
	val = be16_to_cpup((__be16 *)t->rx_buf) >> 3;
647 648 649 650 651 652 653 654 655 656 657 658 659

	action = ts->filter(ts->filter_data, ts->msg_idx, &val);
	switch (action) {
	case ADS7846_FILTER_REPEAT:
		break;
	case ADS7846_FILTER_IGNORE:
		ts->tc.ignore = 1;
		/* Last message will contain ads7846_rx() as the
		 * completion function.
		 */
		m = ts->last_msg;
		break;
	case ADS7846_FILTER_OK:
660
		*(u16 *)t->rx_buf = val;
661 662 663 664 665
		ts->tc.ignore = 0;
		m = &ts->msg[++ts->msg_idx];
		break;
	default:
		BUG();
666 667 668 669 670 671 672
	}
	status = spi_async(ts->spi, m);
	if (status)
		dev_err(&ts->spi->dev, "spi_async --> %d\n",
				status);
}

673
static enum hrtimer_restart ads7846_timer(struct hrtimer *handle)
D
David Brownell 已提交
674
{
675
	struct ads7846	*ts = container_of(handle, struct ads7846, timer);
D
David Brownell 已提交
676
	int		status = 0;
677

678 679
	spin_lock_irq(&ts->lock);

680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
	if (unlikely(!ts->get_pendown_state() ||
		     device_suspended(&ts->spi->dev))) {
		if (ts->pendown) {
			struct input_dev *input = ts->input;

			input_report_key(input, BTN_TOUCH, 0);
			input_report_abs(input, ABS_PRESSURE, 0);
			input_sync(input);

			ts->pendown = 0;
#ifdef VERBOSE
			dev_dbg(&ts->spi->dev, "UP\n");
#endif
		}

695
		/* measurement cycle ended */
696 697 698 699 700 701 702 703 704 705 706 707 708 709
		if (!device_suspended(&ts->spi->dev)) {
			ts->irq_disabled = 0;
			enable_irq(ts->spi->irq);
		}
		ts->pending = 0;
	} else {
		/* pen is still down, continue with the measurement */
		ts->msg_idx = 0;
		status = spi_async(ts->spi, &ts->msg[0]);
		if (status)
			dev_err(&ts->spi->dev, "spi_async --> %d\n", status);
	}

	spin_unlock_irq(&ts->lock);
710
	return HRTIMER_NORESTART;
711 712
}

713
static irqreturn_t ads7846_irq(int irq, void *handle)
714 715 716
{
	struct ads7846 *ts = handle;
	unsigned long flags;
D
David Brownell 已提交
717 718

	spin_lock_irqsave(&ts->lock, flags);
719
	if (likely(ts->get_pendown_state())) {
D
David Brownell 已提交
720
		if (!ts->irq_disabled) {
721 722 723 724
			/* The ARM do_simple_IRQ() dispatcher doesn't act
			 * like the other dispatchers:  it will report IRQs
			 * even after they've been disabled.  We work around
			 * that here.  (The "generic irq" framework may help...)
725
			 */
D
David Brownell 已提交
726 727
			ts->irq_disabled = 1;
			disable_irq(ts->spi->irq);
728
			ts->pending = 1;
729
			hrtimer_start(&ts->timer, ktime_set(0, TS_POLL_DELAY),
730
					HRTIMER_MODE_REL);
731
		}
D
David Brownell 已提交
732 733
	}
	spin_unlock_irqrestore(&ts->lock, flags);
I
Imre Deak 已提交
734 735

	return IRQ_HANDLED;
D
David Brownell 已提交
736 737 738 739
}

/*--------------------------------------------------------------------------*/

I
Imre Deak 已提交
740 741
/* Must be called with ts->lock held */
static void ads7846_disable(struct ads7846 *ts)
D
David Brownell 已提交
742
{
I
Imre Deak 已提交
743 744
	if (ts->disabled)
		return;
D
David Brownell 已提交
745

746 747
	ts->disabled = 1;

D
David Brownell 已提交
748
	/* are we waiting for IRQ, or polling? */
749 750 751
	if (!ts->pending) {
		ts->irq_disabled = 1;
		disable_irq(ts->spi->irq);
D
David Brownell 已提交
752
	} else {
753 754
		/* the timer will run at least once more, and
		 * leave everything in a clean state, IRQ disabled
D
David Brownell 已提交
755
		 */
756
		while (ts->pending) {
I
Imre Deak 已提交
757
			spin_unlock_irq(&ts->lock);
758
			msleep(1);
I
Imre Deak 已提交
759
			spin_lock_irq(&ts->lock);
D
David Brownell 已提交
760 761 762 763 764 765 766
		}
	}

	/* we know the chip's in lowpower mode since we always
	 * leave it that way after every request
	 */

I
Imre Deak 已提交
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
}

/* Must be called with ts->lock held */
static void ads7846_enable(struct ads7846 *ts)
{
	if (!ts->disabled)
		return;

	ts->disabled = 0;
	ts->irq_disabled = 0;
	enable_irq(ts->spi->irq);
}

static int ads7846_suspend(struct spi_device *spi, pm_message_t message)
{
	struct ads7846 *ts = dev_get_drvdata(&spi->dev);

	spin_lock_irq(&ts->lock);

786
	ts->is_suspended = 1;
I
Imre Deak 已提交
787 788 789 790
	ads7846_disable(ts);

	spin_unlock_irq(&ts->lock);

D
David Brownell 已提交
791
	return 0;
I
Imre Deak 已提交
792

D
David Brownell 已提交
793 794
}

795
static int ads7846_resume(struct spi_device *spi)
D
David Brownell 已提交
796
{
797
	struct ads7846 *ts = dev_get_drvdata(&spi->dev);
D
David Brownell 已提交
798

I
Imre Deak 已提交
799 800
	spin_lock_irq(&ts->lock);

801
	ts->is_suspended = 0;
I
Imre Deak 已提交
802 803 804 805
	ads7846_enable(ts);

	spin_unlock_irq(&ts->lock);

D
David Brownell 已提交
806 807 808
	return 0;
}

809
static int __devinit ads7846_probe(struct spi_device *spi)
D
David Brownell 已提交
810 811
{
	struct ads7846			*ts;
812
	struct input_dev		*input_dev;
813
	struct ads7846_platform_data	*pdata = spi->dev.platform_data;
814
	struct spi_message		*m;
D
David Brownell 已提交
815
	struct spi_transfer		*x;
816
	int				vref;
817
	int				err;
D
David Brownell 已提交
818 819

	if (!spi->irq) {
820
		dev_dbg(&spi->dev, "no IRQ?\n");
D
David Brownell 已提交
821 822 823 824
		return -ENODEV;
	}

	if (!pdata) {
825
		dev_dbg(&spi->dev, "no platform data?\n");
D
David Brownell 已提交
826 827 828 829
		return -ENODEV;
	}

	/* don't exceed max specified sample rate */
830
	if (spi->max_speed_hz > (125000 * SAMPLE_BITS)) {
831
		dev_dbg(&spi->dev, "f(sample) %d KHz?\n",
832
				(spi->max_speed_hz/SAMPLE_BITS)/1000);
D
David Brownell 已提交
833 834 835
		return -EINVAL;
	}

836 837 838 839
	/* REVISIT when the irq can be triggered active-low, or if for some
	 * reason the touchscreen isn't hooked up, we don't need to access
	 * the pendown state.
	 */
840 841 842 843 844
	if (pdata->get_pendown_state == NULL) {
		dev_dbg(&spi->dev, "no get_pendown_state function?\n");
		return -EINVAL;
	}

845 846 847
	/* We'd set TX wordsize 8 bits and RX wordsize to 13 bits ... except
	 * that even if the hardware can do that, the SPI controller driver
	 * may not.  So we stick to very-portable 8 bit words, both RX and TX.
D
David Brownell 已提交
848
	 */
849
	spi->bits_per_word = 8;
850
	spi->mode = SPI_MODE_0;
851 852 853
	err = spi_setup(spi);
	if (err < 0)
		return err;
D
David Brownell 已提交
854

855 856 857 858 859 860
	ts = kzalloc(sizeof(struct ads7846), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!ts || !input_dev) {
		err = -ENOMEM;
		goto err_free_mem;
	}
D
David Brownell 已提交
861

862
	dev_set_drvdata(&spi->dev, ts);
D
David Brownell 已提交
863 864

	ts->spi = spi;
865
	ts->input = input_dev;
866
	ts->vref_mv = pdata->vref_mv;
D
David Brownell 已提交
867

868
	hrtimer_init(&ts->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
D
David Brownell 已提交
869 870
	ts->timer.function = ads7846_timer;

I
Imre Deak 已提交
871 872
	spin_lock_init(&ts->lock);

D
David Brownell 已提交
873 874 875
	ts->model = pdata->model ? : 7846;
	ts->vref_delay_usecs = pdata->vref_delay_usecs ? : 100;
	ts->x_plate_ohms = pdata->x_plate_ohms ? : 400;
876
	ts->pressure_max = pdata->pressure_max ? : ~0;
877 878 879 880 881 882 883 884 885 886

	if (pdata->filter != NULL) {
		if (pdata->filter_init != NULL) {
			err = pdata->filter_init(pdata, &ts->filter_data);
			if (err < 0)
				goto err_free_mem;
		}
		ts->filter = pdata->filter;
		ts->filter_cleanup = pdata->filter_cleanup;
	} else if (pdata->debounce_max) {
887
		ts->debounce_max = pdata->debounce_max;
888 889
		if (ts->debounce_max < 2)
			ts->debounce_max = 2;
890 891
		ts->debounce_tol = pdata->debounce_tol;
		ts->debounce_rep = pdata->debounce_rep;
892 893
		ts->filter = ads7846_debounce;
		ts->filter_data = ts;
894
	} else
895
		ts->filter = ads7846_no_filter;
896
	ts->get_pendown_state = pdata->get_pendown_state;
D
David Brownell 已提交
897

898 899 900 901
	if (pdata->penirq_recheck_delay_usecs)
		ts->penirq_recheck_delay_usecs =
				pdata->penirq_recheck_delay_usecs;

902
	snprintf(ts->phys, sizeof(ts->phys), "%s/input0", spi->dev.bus_id);
D
David Brownell 已提交
903

904 905
	input_dev->name = "ADS784x Touchscreen";
	input_dev->phys = ts->phys;
906
	input_dev->dev.parent = &spi->dev;
D
David Brownell 已提交
907

908 909
	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
	input_dev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
910
	input_set_abs_params(input_dev, ABS_X,
D
David Brownell 已提交
911 912 913
			pdata->x_min ? : 0,
			pdata->x_max ? : MAX_12BIT,
			0, 0);
914
	input_set_abs_params(input_dev, ABS_Y,
D
David Brownell 已提交
915 916 917
			pdata->y_min ? : 0,
			pdata->y_max ? : MAX_12BIT,
			0, 0);
918
	input_set_abs_params(input_dev, ABS_PRESSURE,
D
David Brownell 已提交
919 920
			pdata->pressure_min, pdata->pressure_max, 0, 0);

921 922
	vref = pdata->keep_vref_on;

D
David Brownell 已提交
923 924 925
	/* set up the transfers to read touchscreen state; this assumes we
	 * use formula #2 for pressure, not #3.
	 */
926
	m = &ts->msg[0];
D
David Brownell 已提交
927 928
	x = ts->xfer;

929 930
	spi_message_init(m);

D
David Brownell 已提交
931
	/* y- still on; turn on only y+ (and ADC) */
932
	ts->read_y = READ_Y(vref);
933
	x->tx_buf = &ts->read_y;
D
David Brownell 已提交
934
	x->len = 1;
935
	spi_message_add_tail(x, m);
936

D
David Brownell 已提交
937 938 939
	x++;
	x->rx_buf = &ts->tc.y;
	x->len = 2;
940 941
	spi_message_add_tail(x, m);

942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
	/* the first sample after switching drivers can be low quality;
	 * optionally discard it, using a second one after the signals
	 * have had enough time to stabilize.
	 */
	if (pdata->settle_delay_usecs) {
		x->delay_usecs = pdata->settle_delay_usecs;

		x++;
		x->tx_buf = &ts->read_y;
		x->len = 1;
		spi_message_add_tail(x, m);

		x++;
		x->rx_buf = &ts->tc.y;
		x->len = 2;
		spi_message_add_tail(x, m);
	}

960
	m->complete = ads7846_rx_val;
961 962 963 964 965 966 967
	m->context = ts;

	m++;
	spi_message_init(m);

	/* turn y- off, x+ on, then leave in lowpower */
	x++;
968
	ts->read_x = READ_X(vref);
969 970 971 972 973 974 975 976 977
	x->tx_buf = &ts->read_x;
	x->len = 1;
	spi_message_add_tail(x, m);

	x++;
	x->rx_buf = &ts->tc.x;
	x->len = 2;
	spi_message_add_tail(x, m);

978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
	/* ... maybe discard first sample ... */
	if (pdata->settle_delay_usecs) {
		x->delay_usecs = pdata->settle_delay_usecs;

		x++;
		x->tx_buf = &ts->read_x;
		x->len = 1;
		spi_message_add_tail(x, m);

		x++;
		x->rx_buf = &ts->tc.x;
		x->len = 2;
		spi_message_add_tail(x, m);
	}

993
	m->complete = ads7846_rx_val;
994
	m->context = ts;
D
David Brownell 已提交
995 996 997

	/* turn y+ off, x- on; we'll use formula #2 */
	if (ts->model == 7846) {
998 999 1000
		m++;
		spi_message_init(m);

1001
		x++;
1002
		ts->read_z1 = READ_Z1(vref);
1003
		x->tx_buf = &ts->read_z1;
D
David Brownell 已提交
1004
		x->len = 1;
1005
		spi_message_add_tail(x, m);
1006

D
David Brownell 已提交
1007 1008 1009
		x++;
		x->rx_buf = &ts->tc.z1;
		x->len = 2;
1010 1011
		spi_message_add_tail(x, m);

1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
		/* ... maybe discard first sample ... */
		if (pdata->settle_delay_usecs) {
			x->delay_usecs = pdata->settle_delay_usecs;

			x++;
			x->tx_buf = &ts->read_z1;
			x->len = 1;
			spi_message_add_tail(x, m);

			x++;
			x->rx_buf = &ts->tc.z1;
			x->len = 2;
			spi_message_add_tail(x, m);
		}

1027
		m->complete = ads7846_rx_val;
1028 1029 1030 1031
		m->context = ts;

		m++;
		spi_message_init(m);
D
David Brownell 已提交
1032

1033
		x++;
1034
		ts->read_z2 = READ_Z2(vref);
1035
		x->tx_buf = &ts->read_z2;
D
David Brownell 已提交
1036
		x->len = 1;
1037
		spi_message_add_tail(x, m);
1038

D
David Brownell 已提交
1039 1040 1041
		x++;
		x->rx_buf = &ts->tc.z2;
		x->len = 2;
1042
		spi_message_add_tail(x, m);
D
David Brownell 已提交
1043

1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
		/* ... maybe discard first sample ... */
		if (pdata->settle_delay_usecs) {
			x->delay_usecs = pdata->settle_delay_usecs;

			x++;
			x->tx_buf = &ts->read_z2;
			x->len = 1;
			spi_message_add_tail(x, m);

			x++;
			x->rx_buf = &ts->tc.z2;
			x->len = 2;
			spi_message_add_tail(x, m);
		}

1059
		m->complete = ads7846_rx_val;
1060 1061
		m->context = ts;
	}
1062 1063

	/* power down */
1064 1065 1066
	m++;
	spi_message_init(m);

1067 1068 1069 1070
	x++;
	ts->pwrdown = PWRDOWN;
	x->tx_buf = &ts->pwrdown;
	x->len = 1;
1071
	spi_message_add_tail(x, m);
1072 1073 1074 1075

	x++;
	x->rx_buf = &ts->dummy;
	x->len = 2;
1076
	CS_CHANGE(*x);
1077
	spi_message_add_tail(x, m);
D
David Brownell 已提交
1078

1079 1080
	m->complete = ads7846_rx;
	m->context = ts;
D
David Brownell 已提交
1081

1082 1083
	ts->last_msg = m;

1084
	if (request_irq(spi->irq, ads7846_irq, IRQF_TRIGGER_FALLING,
1085
			spi->dev.driver->name, ts)) {
1086
		dev_dbg(&spi->dev, "irq %d busy?\n", spi->irq);
1087
		err = -EBUSY;
1088
		goto err_cleanup_filter;
D
David Brownell 已提交
1089 1090
	}

1091 1092 1093 1094
	err = ads784x_hwmon_register(spi, ts);
	if (err)
		goto err_free_irq;

1095
	dev_info(&spi->dev, "touchscreen, irq %d\n", spi->irq);
D
David Brownell 已提交
1096

1097
	/* take a first sample, leaving nPENIRQ active and vREF off; avoid
D
David Brownell 已提交
1098 1099
	 * the touchscreen, in case it's not connected.
	 */
1100
	(void) ads7846_read12_ser(&spi->dev,
D
David Brownell 已提交
1101 1102
			  READ_12BIT_SER(vaux) | ADS_PD10_ALL_ON);

1103
	err = sysfs_create_group(&spi->dev.kobj, &ads784x_attr_group);
1104
	if (err)
1105
		goto err_remove_hwmon;
I
Imre Deak 已提交
1106

1107 1108
	err = input_register_device(input_dev);
	if (err)
1109
		goto err_remove_attr_group;
1110

D
David Brownell 已提交
1111
	return 0;
1112

1113
 err_remove_attr_group:
1114 1115 1116
	sysfs_remove_group(&spi->dev.kobj, &ads784x_attr_group);
 err_remove_hwmon:
	ads784x_hwmon_unregister(spi, ts);
1117
 err_free_irq:
1118
	free_irq(spi->irq, ts);
1119 1120 1121
 err_cleanup_filter:
	if (ts->filter_cleanup)
		ts->filter_cleanup(ts->filter_data);
1122 1123 1124 1125
 err_free_mem:
	input_free_device(input_dev);
	kfree(ts);
	return err;
D
David Brownell 已提交
1126 1127
}

1128
static int __devexit ads7846_remove(struct spi_device *spi)
D
David Brownell 已提交
1129
{
1130
	struct ads7846		*ts = dev_get_drvdata(&spi->dev);
D
David Brownell 已提交
1131

1132
	ads784x_hwmon_unregister(spi, ts);
I
Imre Deak 已提交
1133 1134
	input_unregister_device(ts->input);

1135
	ads7846_suspend(spi, PMSG_SUSPEND);
D
David Brownell 已提交
1136

1137
	sysfs_remove_group(&spi->dev.kobj, &ads784x_attr_group);
D
David Brownell 已提交
1138

I
Imre Deak 已提交
1139
	free_irq(ts->spi->irq, ts);
1140 1141
	/* suspend left the IRQ disabled */
	enable_irq(ts->spi->irq);
I
Imre Deak 已提交
1142

1143 1144 1145
	if (ts->filter_cleanup)
		ts->filter_cleanup(ts->filter_data);

D
David Brownell 已提交
1146 1147
	kfree(ts);

1148
	dev_dbg(&spi->dev, "unregistered touchscreen\n");
D
David Brownell 已提交
1149 1150 1151
	return 0;
}

1152 1153 1154 1155 1156 1157
static struct spi_driver ads7846_driver = {
	.driver = {
		.name	= "ads7846",
		.bus	= &spi_bus_type,
		.owner	= THIS_MODULE,
	},
D
David Brownell 已提交
1158
	.probe		= ads7846_probe,
1159
	.remove		= __devexit_p(ads7846_remove),
D
David Brownell 已提交
1160 1161 1162 1163 1164 1165
	.suspend	= ads7846_suspend,
	.resume		= ads7846_resume,
};

static int __init ads7846_init(void)
{
1166
	return spi_register_driver(&ads7846_driver);
D
David Brownell 已提交
1167 1168 1169 1170 1171
}
module_init(ads7846_init);

static void __exit ads7846_exit(void)
{
1172
	spi_unregister_driver(&ads7846_driver);
D
David Brownell 已提交
1173 1174 1175 1176 1177
}
module_exit(ads7846_exit);

MODULE_DESCRIPTION("ADS7846 TouchScreen Driver");
MODULE_LICENSE("GPL");