ads7846.c 24.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 20 21 22 23 24 25 26 27
 *
 * 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.
 */
#include <linux/device.h>
#include <linux/init.h>
#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>
28
#include <asm/irq.h>
D
David Brownell 已提交
29 30 31 32 33 34 35 36 37 38

#ifdef	CONFIG_ARM
#include <asm/mach-types.h>
#ifdef	CONFIG_ARCH_OMAP
#include <asm/arch/gpio.h>
#endif
#endif


/*
39 40
 * This code has been heavily tested on a Nokia 770, and lightly
 * tested on other ads7846 devices (OSK/Mistral, Lubbock).
D
David Brownell 已提交
41 42
 * Support for ads7843 and ads7845 has only been stubbed in.
 *
I
Imre Deak 已提交
43 44 45 46 47 48
 * 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 已提交
49 50 51
 * 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 已提交
52 53 54
 * 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 已提交
55 56
 */

57 58
#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 已提交
59

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

D
David Brownell 已提交
63 64 65
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
66
	 * with msbs zeroed).  Instead, we read them as two 8-bit values,
67
	 * *** WHICH NEED BYTESWAPPING *** and range adjustment.
D
David Brownell 已提交
68
	 */
69 70 71
	u16	x;
	u16	y;
	u16	z1, z2;
72
	int    ignore;
D
David Brownell 已提交
73 74 75
};

struct ads7846 {
76
	struct input_dev	*input;
D
David Brownell 已提交
77 78 79
	char			phys[32];

	struct spi_device	*spi;
80
	struct attribute_group	*attr_group;
D
David Brownell 已提交
81 82 83
	u16			model;
	u16			vref_delay_usecs;
	u16			x_plate_ohms;
84
	u16			pressure_max;
D
David Brownell 已提交
85

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

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

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

	spinlock_t		lock;
103
	struct hrtimer		timer;
D
David Brownell 已提交
104 105 106 107
	unsigned		pendown:1;	/* P: lock */
	unsigned		pending:1;	/* P: lock */
// FIXME remove "irq_disabled"
	unsigned		irq_disabled:1;	/* P: lock */
I
Imre Deak 已提交
108
	unsigned		disabled:1;
109

110 111 112
	int			(*filter)(void *data, int data_idx, int *val);
	void			*filter_data;
	void			(*filter_cleanup)(void *data);
113
	int			(*get_pendown_state)(void);
D
David Brownell 已提交
114 115 116 117 118 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
};

/* 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 */
149 150 151
#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 已提交
152

153 154 155
#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))
156

157 158
#define	READ_X(vref)	(READ_12BIT_DFR(x,  1, vref))
#define	PWRDOWN		(READ_12BIT_DFR(y,  0, 0))	/* LAST */
D
David Brownell 已提交
159 160 161 162 163 164 165

/* 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)

166 167
#define	REF_ON	(READ_12BIT_DFR(x, 1, 1))
#define	REF_OFF	(READ_12BIT_DFR(y, 0, 0))
D
David Brownell 已提交
168 169 170 171 172 173 174 175

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

/*
 * Non-touchscreen sensors only use single-ended conversions.
 */

struct ser_req {
176
	u8			ref_on;
D
David Brownell 已提交
177
	u8			command;
178
	u8			ref_off;
D
David Brownell 已提交
179 180 181 182 183 184
	u16			scratch;
	__be16			sample;
	struct spi_message	msg;
	struct spi_transfer	xfer[6];
};

I
Imre Deak 已提交
185 186 187
static void ads7846_enable(struct ads7846 *ts);
static void ads7846_disable(struct ads7846 *ts);

188 189 190 191 192 193
static int device_suspended(struct device *dev)
{
	struct ads7846 *ts = dev_get_drvdata(dev);
	return dev->power.power_state.event != PM_EVENT_ON || ts->disabled;
}

D
David Brownell 已提交
194 195 196 197
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);
198
	struct ser_req		*req = kzalloc(sizeof *req, GFP_KERNEL);
D
David Brownell 已提交
199 200
	int			status;
	int			sample;
201
	int			i;
D
David Brownell 已提交
202 203 204 205

	if (!req)
		return -ENOMEM;

206
	spi_message_init(&req->msg);
207

D
David Brownell 已提交
208
	/* activate reference, so it has time to settle; */
209 210
	req->ref_on = REF_ON;
	req->xfer[0].tx_buf = &req->ref_on;
D
David Brownell 已提交
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
	req->xfer[0].len = 1;
	req->xfer[1].rx_buf = &req->scratch;
	req->xfer[1].len = 2;

	/*
	 * for external VREF, 0 usec (and assume it's always on);
	 * for 1uF, use 800 usec;
	 * no cap, 100 usec.
	 */
	req->xfer[1].delay_usecs = ts->vref_delay_usecs;

	/* take sample */
	req->command = (u8) command;
	req->xfer[2].tx_buf = &req->command;
	req->xfer[2].len = 1;
	req->xfer[3].rx_buf = &req->sample;
	req->xfer[3].len = 2;

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

	/* turn off reference */
232 233
	req->ref_off = REF_OFF;
	req->xfer[4].tx_buf = &req->ref_off;
D
David Brownell 已提交
234 235 236 237 238 239 240 241 242
	req->xfer[4].len = 1;
	req->xfer[5].rx_buf = &req->scratch;
	req->xfer[5].len = 2;

	CS_CHANGE(req->xfer[5]);

	/* group all the transfers together, so we can't interfere with
	 * reading touchscreen state; disable penirq while sampling
	 */
243 244
	for (i = 0; i < 6; i++)
		spi_message_add_tail(&req->xfer[i], &req->msg);
D
David Brownell 已提交
245

246
	ts->irq_disabled = 1;
D
David Brownell 已提交
247 248
	disable_irq(spi->irq);
	status = spi_sync(spi, &req->msg);
249
	ts->irq_disabled = 0;
D
David Brownell 已提交
250 251 252 253
	enable_irq(spi->irq);

	if (req->msg.status)
		status = req->msg.status;
254 255

	/* on-wire is a must-ignore bit, a BE12 value, then padding */
D
David Brownell 已提交
256
	sample = be16_to_cpu(req->sample);
257 258
	sample = sample >> 3;
	sample &= 0x0fff;
D
David Brownell 已提交
259

260
	kfree(req);
D
David Brownell 已提交
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
	return status ? status : sample;
}

#define SHOW(name) static ssize_t \
name ## _show(struct device *dev, struct device_attribute *attr, char *buf) \
{ \
	ssize_t v = ads7846_read12_ser(dev, \
			READ_12BIT_SER(name) | ADS_PD10_ALL_ON); \
	if (v < 0) \
		return v; \
	return sprintf(buf, "%u\n", (unsigned) v); \
} \
static DEVICE_ATTR(name, S_IRUGO, name ## _show, NULL);

SHOW(temp0)
SHOW(temp1)
SHOW(vaux)
SHOW(vbatt)

280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
static int is_pen_down(struct device *dev)
{
	struct ads7846		*ts = dev_get_drvdata(dev);

	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 已提交
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
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);

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 362 363 364 365 366 367
static struct attribute *ads7846_attributes[] = {
	&dev_attr_temp0.attr,
	&dev_attr_temp1.attr,
	&dev_attr_vbatt.attr,
	&dev_attr_vaux.attr,
	&dev_attr_pen_down.attr,
	&dev_attr_disable.attr,
	NULL,
};

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

/*
 * ads7843/7845 don't have temperature sensors, and
 * use the other sensors a bit differently too
 */

static struct attribute *ads7843_attributes[] = {
	&dev_attr_vbatt.attr,
	&dev_attr_vaux.attr,
	&dev_attr_pen_down.attr,
	&dev_attr_disable.attr,
	NULL,
};

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

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

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

D
David Brownell 已提交
368 369 370 371 372 373 374 375 376 377 378 379
/*--------------------------------------------------------------------------*/

/*
 * 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)
{
380 381 382
	struct ads7846		*ts = ads;
	unsigned		Rt;
	u16			x, y, z1, z2;
D
David Brownell 已提交
383

384 385
	/* 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 已提交
386
	 */
387 388 389 390
	x = ts->tc.x;
	y = ts->tc.y;
	z1 = ts->tc.z1;
	z2 = ts->tc.z2;
D
David Brownell 已提交
391 392 393 394 395

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

396
	if (likely(x && z1)) {
D
David Brownell 已提交
397 398 399 400 401 402 403 404 405 406
		/* 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;

407
	/* Sample found inconsistent by debouncing or pressure is beyond
408 409 410
	 * the maximum. Don't report it to user space, repeat at least
	 * once more the measurement
	 */
411
	if (ts->tc.ignore || Rt > ts->pressure_max) {
412 413 414 415
#ifdef VERBOSE
		pr_debug("%s: ignored %d pressure %d\n",
			ts->spi->dev.bus_id, ts->tc.ignore, Rt);
#endif
416 417
		hrtimer_start(&ts->timer, ktime_set(0, TS_POLL_PERIOD),
			      HRTIMER_REL);
418 419 420
		return;
	}

421 422 423 424
	/* 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 已提交
425
	 *
426 427
	 * 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 已提交
428 429
	 */
	if (Rt) {
430
		struct input_dev *input = ts->input;
431

432 433 434 435 436
		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 已提交
437
#endif
438 439 440 441
		}
		input_report_abs(input, ABS_X, x);
		input_report_abs(input, ABS_Y, y);
		input_report_abs(input, ABS_PRESSURE, Rt);
D
David Brownell 已提交
442

443 444 445 446 447
		input_sync(input);
#ifdef VERBOSE
		dev_dbg(&ts->spi->dev, "%4d/%4d/%4d\n", x, y, Rt);
#endif
	}
D
David Brownell 已提交
448

449
	hrtimer_start(&ts->timer, ktime_set(0, TS_POLL_PERIOD), HRTIMER_REL);
D
David Brownell 已提交
450 451
}

452
static int ads7846_debounce(void *ads, int data_idx, int *val)
453 454 455
{
	struct ads7846		*ts = ads;

456 457 458
	if (!ts->read_cnt || (abs(ts->last_read - *val) > ts->debounce_tol)) {
		/* Start over collecting consistent readings. */
		ts->read_rep = 0;
459 460 461
		/* Repeat it, if this was the first read or the read
		 * wasn't consistent enough. */
		if (ts->read_cnt < ts->debounce_max) {
462
			ts->last_read = *val;
463
			ts->read_cnt++;
464
			return ADS7846_FILTER_REPEAT;
465 466 467 468 469 470 471
		} 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;
472
			return ADS7846_FILTER_IGNORE;
473
		}
474
	} else {
475 476 477 478 479
		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;
480 481
			return ADS7846_FILTER_OK;
		} else {
482 483
			/* Read more values that are consistent. */
			ts->read_cnt++;
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
			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;
	u16 *rx_val;
	int val;
	int action;
	int status;

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

	/* adjust:  on-wire is a must-ignore bit, a BE12 value, then padding;
	 * built from two 8 bit values written msb-first.
	 */
	val = be16_to_cpu(*rx_val) >> 3;

	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:
		*rx_val = val;
		ts->tc.ignore = 0;
		m = &ts->msg[++ts->msg_idx];
		break;
	default:
		BUG();
531 532 533 534 535 536 537
	}
	status = spi_async(ts->spi, m);
	if (status)
		dev_err(&ts->spi->dev, "spi_async --> %d\n",
				status);
}

538
static int ads7846_timer(struct hrtimer *handle)
D
David Brownell 已提交
539
{
540
	struct ads7846	*ts = container_of(handle, struct ads7846, timer);
D
David Brownell 已提交
541
	int		status = 0;
542

543 544
	spin_lock_irq(&ts->lock);

545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
	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
		}

560
		/* measurement cycle ended */
561 562 563 564 565 566 567 568 569 570 571 572 573 574
		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);
575
	return HRTIMER_NORESTART;
576 577
}

578
static irqreturn_t ads7846_irq(int irq, void *handle)
579 580 581
{
	struct ads7846 *ts = handle;
	unsigned long flags;
D
David Brownell 已提交
582 583

	spin_lock_irqsave(&ts->lock, flags);
584
	if (likely(ts->get_pendown_state())) {
D
David Brownell 已提交
585
		if (!ts->irq_disabled) {
586 587 588 589
			/* 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...)
590
			 */
D
David Brownell 已提交
591 592
			ts->irq_disabled = 1;
			disable_irq(ts->spi->irq);
593
			ts->pending = 1;
594 595
			hrtimer_start(&ts->timer, ktime_set(0, TS_POLL_DELAY),
					HRTIMER_REL);
596
		}
D
David Brownell 已提交
597 598
	}
	spin_unlock_irqrestore(&ts->lock, flags);
I
Imre Deak 已提交
599 600

	return IRQ_HANDLED;
D
David Brownell 已提交
601 602 603 604
}

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

I
Imre Deak 已提交
605 606
/* Must be called with ts->lock held */
static void ads7846_disable(struct ads7846 *ts)
D
David Brownell 已提交
607
{
I
Imre Deak 已提交
608 609
	if (ts->disabled)
		return;
D
David Brownell 已提交
610

611 612
	ts->disabled = 1;

D
David Brownell 已提交
613
	/* are we waiting for IRQ, or polling? */
614 615 616
	if (!ts->pending) {
		ts->irq_disabled = 1;
		disable_irq(ts->spi->irq);
D
David Brownell 已提交
617
	} else {
618 619
		/* the timer will run at least once more, and
		 * leave everything in a clean state, IRQ disabled
D
David Brownell 已提交
620
		 */
621
		while (ts->pending) {
I
Imre Deak 已提交
622
			spin_unlock_irq(&ts->lock);
623
			msleep(1);
I
Imre Deak 已提交
624
			spin_lock_irq(&ts->lock);
D
David Brownell 已提交
625 626 627 628 629 630 631
		}
	}

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

I
Imre Deak 已提交
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
}

/* 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);

	spi->dev.power.power_state = message;
	ads7846_disable(ts);

	spin_unlock_irq(&ts->lock);

D
David Brownell 已提交
656
	return 0;
I
Imre Deak 已提交
657

D
David Brownell 已提交
658 659
}

660
static int ads7846_resume(struct spi_device *spi)
D
David Brownell 已提交
661
{
662
	struct ads7846 *ts = dev_get_drvdata(&spi->dev);
D
David Brownell 已提交
663

I
Imre Deak 已提交
664 665
	spin_lock_irq(&ts->lock);

666
	spi->dev.power.power_state = PMSG_ON;
I
Imre Deak 已提交
667 668 669 670
	ads7846_enable(ts);

	spin_unlock_irq(&ts->lock);

D
David Brownell 已提交
671 672 673
	return 0;
}

674
static int __devinit ads7846_probe(struct spi_device *spi)
D
David Brownell 已提交
675 676
{
	struct ads7846			*ts;
677
	struct input_dev		*input_dev;
678
	struct ads7846_platform_data	*pdata = spi->dev.platform_data;
679
	struct spi_message		*m;
D
David Brownell 已提交
680
	struct spi_transfer		*x;
681
	int				vref;
682
	int				err;
D
David Brownell 已提交
683 684

	if (!spi->irq) {
685
		dev_dbg(&spi->dev, "no IRQ?\n");
D
David Brownell 已提交
686 687 688 689
		return -ENODEV;
	}

	if (!pdata) {
690
		dev_dbg(&spi->dev, "no platform data?\n");
D
David Brownell 已提交
691 692 693 694
		return -ENODEV;
	}

	/* don't exceed max specified sample rate */
695
	if (spi->max_speed_hz > (125000 * SAMPLE_BITS)) {
696
		dev_dbg(&spi->dev, "f(sample) %d KHz?\n",
697
				(spi->max_speed_hz/SAMPLE_BITS)/1000);
D
David Brownell 已提交
698 699 700
		return -EINVAL;
	}

701 702 703 704
	/* 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.
	 */
705 706 707 708 709
	if (pdata->get_pendown_state == NULL) {
		dev_dbg(&spi->dev, "no get_pendown_state function?\n");
		return -EINVAL;
	}

710 711 712
	/* 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 已提交
713
	 */
714
	spi->bits_per_word = 8;
715 716 717 718
	spi->mode = SPI_MODE_1;
	err = spi_setup(spi);
	if (err < 0)
		return err;
D
David Brownell 已提交
719

720 721 722 723 724 725
	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 已提交
726

727
	dev_set_drvdata(&spi->dev, ts);
728
	spi->dev.power.power_state = PMSG_ON;
D
David Brownell 已提交
729 730

	ts->spi = spi;
731
	ts->input = input_dev;
D
David Brownell 已提交
732

733
	hrtimer_init(&ts->timer, CLOCK_MONOTONIC, HRTIMER_REL);
D
David Brownell 已提交
734 735
	ts->timer.function = ads7846_timer;

I
Imre Deak 已提交
736 737
	spin_lock_init(&ts->lock);

D
David Brownell 已提交
738 739 740
	ts->model = pdata->model ? : 7846;
	ts->vref_delay_usecs = pdata->vref_delay_usecs ? : 100;
	ts->x_plate_ohms = pdata->x_plate_ohms ? : 400;
741
	ts->pressure_max = pdata->pressure_max ? : ~0;
742 743 744 745 746 747 748 749 750 751

	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) {
752
		ts->debounce_max = pdata->debounce_max;
753 754
		if (ts->debounce_max < 2)
			ts->debounce_max = 2;
755 756
		ts->debounce_tol = pdata->debounce_tol;
		ts->debounce_rep = pdata->debounce_rep;
757 758
		ts->filter = ads7846_debounce;
		ts->filter_data = ts;
759
	} else
760
		ts->filter = ads7846_no_filter;
761
	ts->get_pendown_state = pdata->get_pendown_state;
D
David Brownell 已提交
762

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

765 766 767
	input_dev->name = "ADS784x Touchscreen";
	input_dev->phys = ts->phys;
	input_dev->cdev.dev = &spi->dev;
D
David Brownell 已提交
768

769 770 771
	input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
	input_dev->keybit[LONG(BTN_TOUCH)] = BIT(BTN_TOUCH);
	input_set_abs_params(input_dev, ABS_X,
D
David Brownell 已提交
772 773 774
			pdata->x_min ? : 0,
			pdata->x_max ? : MAX_12BIT,
			0, 0);
775
	input_set_abs_params(input_dev, ABS_Y,
D
David Brownell 已提交
776 777 778
			pdata->y_min ? : 0,
			pdata->y_max ? : MAX_12BIT,
			0, 0);
779
	input_set_abs_params(input_dev, ABS_PRESSURE,
D
David Brownell 已提交
780 781
			pdata->pressure_min, pdata->pressure_max, 0, 0);

782 783
	vref = pdata->keep_vref_on;

D
David Brownell 已提交
784 785 786
	/* set up the transfers to read touchscreen state; this assumes we
	 * use formula #2 for pressure, not #3.
	 */
787
	m = &ts->msg[0];
D
David Brownell 已提交
788 789
	x = ts->xfer;

790 791
	spi_message_init(m);

D
David Brownell 已提交
792
	/* y- still on; turn on only y+ (and ADC) */
793
	ts->read_y = READ_Y(vref);
794
	x->tx_buf = &ts->read_y;
D
David Brownell 已提交
795
	x->len = 1;
796
	spi_message_add_tail(x, m);
797

D
David Brownell 已提交
798 799 800
	x++;
	x->rx_buf = &ts->tc.y;
	x->len = 2;
801 802
	spi_message_add_tail(x, m);

803
	m->complete = ads7846_rx_val;
804 805 806 807 808 809 810
	m->context = ts;

	m++;
	spi_message_init(m);

	/* turn y- off, x+ on, then leave in lowpower */
	x++;
811
	ts->read_x = READ_X(vref);
812 813 814 815 816 817 818 819 820
	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);

821
	m->complete = ads7846_rx_val;
822
	m->context = ts;
D
David Brownell 已提交
823 824 825

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

829
		x++;
830
		ts->read_z1 = READ_Z1(vref);
831
		x->tx_buf = &ts->read_z1;
D
David Brownell 已提交
832
		x->len = 1;
833
		spi_message_add_tail(x, m);
834

D
David Brownell 已提交
835 836 837
		x++;
		x->rx_buf = &ts->tc.z1;
		x->len = 2;
838 839
		spi_message_add_tail(x, m);

840
		m->complete = ads7846_rx_val;
841 842 843 844
		m->context = ts;

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

846
		x++;
847
		ts->read_z2 = READ_Z2(vref);
848
		x->tx_buf = &ts->read_z2;
D
David Brownell 已提交
849
		x->len = 1;
850
		spi_message_add_tail(x, m);
851

D
David Brownell 已提交
852 853 854
		x++;
		x->rx_buf = &ts->tc.z2;
		x->len = 2;
855
		spi_message_add_tail(x, m);
D
David Brownell 已提交
856

857
		m->complete = ads7846_rx_val;
858 859
		m->context = ts;
	}
860 861

	/* power down */
862 863 864
	m++;
	spi_message_init(m);

865 866 867 868
	x++;
	ts->pwrdown = PWRDOWN;
	x->tx_buf = &ts->pwrdown;
	x->len = 1;
869
	spi_message_add_tail(x, m);
870 871 872 873

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

877 878
	m->complete = ads7846_rx;
	m->context = ts;
D
David Brownell 已提交
879

880 881
	ts->last_msg = m;

882
	if (request_irq(spi->irq, ads7846_irq, IRQF_TRIGGER_FALLING,
883
			spi->dev.driver->name, ts)) {
884
		dev_dbg(&spi->dev, "irq %d busy?\n", spi->irq);
885
		err = -EBUSY;
886
		goto err_cleanup_filter;
D
David Brownell 已提交
887 888
	}

889
	dev_info(&spi->dev, "touchscreen, irq %d\n", spi->irq);
D
David Brownell 已提交
890 891 892 893

	/* take a first sample, leaving nPENIRQ active; avoid
	 * the touchscreen, in case it's not connected.
	 */
894
	(void) ads7846_read12_ser(&spi->dev,
D
David Brownell 已提交
895 896
			  READ_12BIT_SER(vaux) | ADS_PD10_ALL_ON);

897 898 899 900 901 902 903 904 905 906
	switch (ts->model) {
	case 7846:
		ts->attr_group = &ads7846_attr_group;
		break;
	case 7845:
		ts->attr_group = &ads7845_attr_group;
		break;
	default:
		ts->attr_group = &ads7843_attr_group;
		break;
D
David Brownell 已提交
907
	}
908 909 910
	err = sysfs_create_group(&spi->dev.kobj, ts->attr_group);
	if (err)
		goto err_free_irq;
I
Imre Deak 已提交
911

912 913
	err = input_register_device(input_dev);
	if (err)
914
		goto err_remove_attr_group;
915

D
David Brownell 已提交
916
	return 0;
917

918 919 920
 err_remove_attr_group:
	sysfs_remove_group(&spi->dev.kobj, ts->attr_group);
 err_free_irq:
921
	free_irq(spi->irq, ts);
922 923 924
 err_cleanup_filter:
	if (ts->filter_cleanup)
		ts->filter_cleanup(ts->filter_data);
925 926 927 928
 err_free_mem:
	input_free_device(input_dev);
	kfree(ts);
	return err;
D
David Brownell 已提交
929 930
}

931
static int __devexit ads7846_remove(struct spi_device *spi)
D
David Brownell 已提交
932
{
933
	struct ads7846		*ts = dev_get_drvdata(&spi->dev);
D
David Brownell 已提交
934

I
Imre Deak 已提交
935 936
	input_unregister_device(ts->input);

937
	ads7846_suspend(spi, PMSG_SUSPEND);
D
David Brownell 已提交
938

939
	sysfs_remove_group(&spi->dev.kobj, ts->attr_group);
D
David Brownell 已提交
940

I
Imre Deak 已提交
941
	free_irq(ts->spi->irq, ts);
942 943
	/* suspend left the IRQ disabled */
	enable_irq(ts->spi->irq);
I
Imre Deak 已提交
944

945 946 947
	if (ts->filter_cleanup)
		ts->filter_cleanup(ts->filter_data);

D
David Brownell 已提交
948 949
	kfree(ts);

950
	dev_dbg(&spi->dev, "unregistered touchscreen\n");
D
David Brownell 已提交
951 952 953
	return 0;
}

954 955 956 957 958 959
static struct spi_driver ads7846_driver = {
	.driver = {
		.name	= "ads7846",
		.bus	= &spi_bus_type,
		.owner	= THIS_MODULE,
	},
D
David Brownell 已提交
960
	.probe		= ads7846_probe,
961
	.remove		= __devexit_p(ads7846_remove),
D
David Brownell 已提交
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
	.suspend	= ads7846_suspend,
	.resume		= ads7846_resume,
};

static int __init ads7846_init(void)
{
	/* grr, board-specific init should stay out of drivers!! */

#ifdef	CONFIG_ARCH_OMAP
	if (machine_is_omap_osk()) {
		/* GPIO4 = PENIRQ; GPIO6 = BUSY */
		omap_request_gpio(4);
		omap_set_gpio_direction(4, 1);
		omap_request_gpio(6);
		omap_set_gpio_direction(6, 1);
	}
	// also TI 1510 Innovator, bitbanging through FPGA
	// also Nokia 770
	// also Palm Tungsten T2
#endif

	// PXA:
	// also Dell Axim X50
	// also HP iPaq H191x/H192x/H415x/H435x
986
	// also Intel Lubbock (additional to UCB1400; as temperature sensor)
D
David Brownell 已提交
987 988
	// also Sharp Zaurus C7xx, C8xx (corgi/sheperd/husky)

989 990
	// Atmel at91sam9261-EK uses ads7843

D
David Brownell 已提交
991 992
	// also various AMD Au1x00 devel boards

993
	return spi_register_driver(&ads7846_driver);
D
David Brownell 已提交
994 995 996 997 998
}
module_init(ads7846_init);

static void __exit ads7846_exit(void)
{
999
	spi_unregister_driver(&ads7846_driver);
D
David Brownell 已提交
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012

#ifdef	CONFIG_ARCH_OMAP
	if (machine_is_omap_osk()) {
		omap_free_gpio(4);
		omap_free_gpio(6);
	}
#endif

}
module_exit(ads7846_exit);

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