2 * TI Touch Screen driver
4 * Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation version 2.
10 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
11 * kind, whether express or implied; without even the implied warranty
12 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
17 #include <linux/kernel.h>
18 #include <linux/err.h>
19 #include <linux/module.h>
20 #include <linux/input.h>
21 #include <linux/slab.h>
22 #include <linux/interrupt.h>
23 #include <linux/clk.h>
24 #include <linux/platform_device.h>
26 #include <linux/delay.h>
28 #include <linux/of_device.h>
29 #include <linux/sort.h>
31 #include <linux/mfd/ti_am335x_tscadc.h>
33 #define ADCFSM_STEPID 0x10
34 #define SEQ_SETTLE 275
35 #define MAX_12BIT ((1 << 12) - 1)
37 #define TSC_IRQENB_MASK (IRQENB_FIFO0THRES | IRQENB_EOS | IRQENB_HW_PEN)
39 static const int config_pins[] = {
47 struct input_dev *input;
48 struct ti_tscadc_dev *mfd_tscadc;
51 unsigned int x_plate_resistance;
53 int coordinate_readouts;
55 u32 bit_xp, bit_xn, bit_yp, bit_yn;
56 u32 inp_xp, inp_xn, inp_yp, inp_yn;
61 static unsigned int titsc_readl(struct titsc *ts, unsigned int reg)
63 return readl(ts->mfd_tscadc->tscadc_base + reg);
66 static void titsc_writel(struct titsc *tsc, unsigned int reg,
69 writel(val, tsc->mfd_tscadc->tscadc_base + reg);
72 static int titsc_config_wires(struct titsc *ts_dev)
78 for (i = 0; i < 4; i++) {
80 * Get the order in which TSC wires are attached
81 * w.r.t. each of the analog input lines on the EVM.
83 analog_line[i] = (ts_dev->config_inp[i] & 0xF0) >> 4;
84 wire_order[i] = ts_dev->config_inp[i] & 0x0F;
85 if (WARN_ON(analog_line[i] > 7))
87 if (WARN_ON(wire_order[i] > ARRAY_SIZE(config_pins)))
91 for (i = 0; i < 4; i++) {
95 an_line = analog_line[i];
96 wi_order = wire_order[i];
97 bit_cfg = config_pins[wi_order];
102 ts_dev->bit_xp = bit_cfg;
103 ts_dev->inp_xp = an_line;
107 ts_dev->bit_xn = bit_cfg;
108 ts_dev->inp_xn = an_line;
112 ts_dev->bit_yp = bit_cfg;
113 ts_dev->inp_yp = an_line;
116 ts_dev->bit_yn = bit_cfg;
117 ts_dev->inp_yn = an_line;
124 static void titsc_step_config(struct titsc *ts_dev)
128 int end_step, first_step, tsc_steps;
131 config = STEPCONFIG_MODE_HWSYNC |
132 STEPCONFIG_AVG_16 | ts_dev->bit_xp;
133 switch (ts_dev->wires) {
135 config |= STEPCONFIG_INP(ts_dev->inp_yp) | ts_dev->bit_xn;
138 config |= ts_dev->bit_yn |
139 STEPCONFIG_INP_AN4 | ts_dev->bit_xn |
143 config |= STEPCONFIG_INP(ts_dev->inp_yp) | ts_dev->bit_xn;
147 tsc_steps = ts_dev->coordinate_readouts * 2 + 2;
148 first_step = TOTAL_STEPS - tsc_steps;
149 /* Steps 16 to 16-coordinate_readouts is for X */
150 end_step = first_step + tsc_steps;
151 for (i = end_step - ts_dev->coordinate_readouts; i < end_step; i++) {
152 titsc_writel(ts_dev, REG_STEPCONFIG(i), config);
153 titsc_writel(ts_dev, REG_STEPDELAY(i), STEPCONFIG_OPENDLY);
157 config = STEPCONFIG_MODE_HWSYNC |
158 STEPCONFIG_AVG_16 | ts_dev->bit_yn |
159 STEPCONFIG_INM_ADCREFM;
160 switch (ts_dev->wires) {
162 config |= ts_dev->bit_yp | STEPCONFIG_INP(ts_dev->inp_xp);
165 config |= ts_dev->bit_xp | STEPCONFIG_INP_AN4 |
166 STEPCONFIG_XNP | STEPCONFIG_YPN;
169 config |= ts_dev->bit_yp | STEPCONFIG_INP(ts_dev->inp_xp);
173 /* 1 ... coordinate_readouts is for Y */
174 end_step = first_step + ts_dev->coordinate_readouts;
175 for (i = first_step; i < end_step; i++) {
176 titsc_writel(ts_dev, REG_STEPCONFIG(i), config);
177 titsc_writel(ts_dev, REG_STEPDELAY(i), STEPCONFIG_OPENDLY);
180 /* Make CHARGECONFIG same as IDLECONFIG */
182 config = titsc_readl(ts_dev, REG_IDLECONFIG);
183 titsc_writel(ts_dev, REG_CHARGECONFIG, config);
184 titsc_writel(ts_dev, REG_CHARGEDELAY, ts_dev->charge_delay);
186 /* coordinate_readouts + 1 ... coordinate_readouts + 2 is for Z */
187 config = STEPCONFIG_MODE_HWSYNC |
188 STEPCONFIG_AVG_16 | ts_dev->bit_yp |
189 ts_dev->bit_xn | STEPCONFIG_INM_ADCREFM |
190 STEPCONFIG_INP(ts_dev->inp_xp);
191 titsc_writel(ts_dev, REG_STEPCONFIG(end_step), config);
192 titsc_writel(ts_dev, REG_STEPDELAY(end_step),
196 config |= STEPCONFIG_INP(ts_dev->inp_yn);
197 titsc_writel(ts_dev, REG_STEPCONFIG(end_step), config);
198 titsc_writel(ts_dev, REG_STEPDELAY(end_step),
201 /* The steps end ... end - readouts * 2 + 2 and bit 0 for TS_Charge */
203 for (i = 0; i < tsc_steps; i++)
204 stepenable |= 1 << (first_step + i + 1);
206 ts_dev->step_mask = stepenable;
207 am335x_tsc_se_set_cache(ts_dev->mfd_tscadc, ts_dev->step_mask);
210 static int titsc_cmp_coord(const void *a, const void *b)
212 return *(int *)a - *(int *)b;
215 static void titsc_read_coordinates(struct titsc *ts_dev,
216 u32 *x, u32 *y, u32 *z1, u32 *z2)
218 unsigned int yvals[7], xvals[7];
219 unsigned int i, xsum = 0, ysum = 0;
220 unsigned int creads = ts_dev->coordinate_readouts;
222 for (i = 0; i < creads; i++) {
223 yvals[i] = titsc_readl(ts_dev, REG_FIFO0);
227 *z1 = titsc_readl(ts_dev, REG_FIFO0);
229 *z2 = titsc_readl(ts_dev, REG_FIFO0);
232 for (i = 0; i < creads; i++) {
233 xvals[i] = titsc_readl(ts_dev, REG_FIFO0);
238 * If co-ordinates readouts is less than 4 then
239 * report the average. In case of 4 or more
240 * readouts, sort the co-ordinate samples, drop
241 * min and max values and report the average of
245 for (i = 0; i < creads; i++) {
252 sort(yvals, creads, sizeof(unsigned int),
253 titsc_cmp_coord, NULL);
254 sort(xvals, creads, sizeof(unsigned int),
255 titsc_cmp_coord, NULL);
256 for (i = 1; i < creads - 1; i++) {
267 static irqreturn_t titsc_irq(int irq, void *dev)
269 struct titsc *ts_dev = dev;
270 struct input_dev *input_dev = ts_dev->input;
271 unsigned int fsm, status, irqclr = 0;
272 unsigned int x = 0, y = 0;
273 unsigned int z1, z2, z;
275 status = titsc_readl(ts_dev, REG_RAWIRQSTATUS);
276 if (status & IRQENB_HW_PEN) {
277 ts_dev->pen_down = true;
278 irqclr |= IRQENB_HW_PEN;
279 pm_stay_awake(ts_dev->mfd_tscadc->dev);
282 if (status & IRQENB_PENUP) {
283 fsm = titsc_readl(ts_dev, REG_ADCFSM);
284 if (fsm == ADCFSM_STEPID) {
285 ts_dev->pen_down = false;
286 input_report_key(input_dev, BTN_TOUCH, 0);
287 input_report_abs(input_dev, ABS_PRESSURE, 0);
288 input_sync(input_dev);
289 pm_relax(ts_dev->mfd_tscadc->dev);
291 ts_dev->pen_down = true;
293 irqclr |= IRQENB_PENUP;
296 if (status & IRQENB_EOS)
297 irqclr |= IRQENB_EOS;
300 * ADC and touchscreen share the IRQ line.
301 * FIFO1 interrupts are used by ADC. Handle FIFO0 IRQs here only
303 if (status & IRQENB_FIFO0THRES) {
305 titsc_read_coordinates(ts_dev, &x, &y, &z1, &z2);
307 if (ts_dev->pen_down && z1 != 0 && z2 != 0) {
309 * Calculate pressure using formula
310 * Resistance(touch) = x plate resistance *
311 * x postion/4096 * ((z2 / z1) - 1)
315 z *= ts_dev->x_plate_resistance;
317 z = (z + 2047) >> 12;
319 if (z <= MAX_12BIT) {
320 input_report_abs(input_dev, ABS_X, x);
321 input_report_abs(input_dev, ABS_Y, y);
322 input_report_abs(input_dev, ABS_PRESSURE, z);
323 input_report_key(input_dev, BTN_TOUCH, 1);
324 input_sync(input_dev);
327 irqclr |= IRQENB_FIFO0THRES;
330 titsc_writel(ts_dev, REG_IRQSTATUS, irqclr);
331 if (status & IRQENB_EOS)
332 am335x_tsc_se_set_cache(ts_dev->mfd_tscadc,
339 static int titsc_parse_dt(struct platform_device *pdev,
340 struct titsc *ts_dev)
342 struct device_node *node = pdev->dev.of_node;
348 err = of_property_read_u32(node, "ti,wires", &ts_dev->wires);
351 switch (ts_dev->wires) {
360 err = of_property_read_u32(node, "ti,x-plate-resistance",
361 &ts_dev->x_plate_resistance);
366 * Try with the new binding first. If it fails, try again with
367 * bogus, miss-spelled version.
369 err = of_property_read_u32(node, "ti,coordinate-readouts",
370 &ts_dev->coordinate_readouts);
372 dev_warn(&pdev->dev, "please use 'ti,coordinate-readouts' instead\n");
373 err = of_property_read_u32(node, "ti,coordiante-readouts",
374 &ts_dev->coordinate_readouts);
380 if (ts_dev->coordinate_readouts <= 0) {
382 "invalid co-ordinate readouts, resetting it to 5\n");
383 ts_dev->coordinate_readouts = 5;
386 err = of_property_read_u32(node, "ti,charge-delay",
387 &ts_dev->charge_delay);
389 * If ti,charge-delay value is not specified, then use
390 * CHARGEDLY_OPENDLY as the default value.
393 ts_dev->charge_delay = CHARGEDLY_OPENDLY;
394 dev_warn(&pdev->dev, "ti,charge-delay not specified\n");
397 return of_property_read_u32_array(node, "ti,wire-config",
398 ts_dev->config_inp, ARRAY_SIZE(ts_dev->config_inp));
402 * The functions for inserting/removing driver as a module.
405 static int titsc_probe(struct platform_device *pdev)
407 struct titsc *ts_dev;
408 struct input_dev *input_dev;
409 struct ti_tscadc_dev *tscadc_dev = ti_tscadc_dev_get(pdev);
412 /* Allocate memory for device */
413 ts_dev = kzalloc(sizeof(*ts_dev), GFP_KERNEL);
414 input_dev = input_allocate_device();
415 if (!ts_dev || !input_dev) {
416 dev_err(&pdev->dev, "failed to allocate memory.\n");
421 tscadc_dev->tsc = ts_dev;
422 ts_dev->mfd_tscadc = tscadc_dev;
423 ts_dev->input = input_dev;
424 ts_dev->irq = tscadc_dev->irq;
426 err = titsc_parse_dt(pdev, ts_dev);
428 dev_err(&pdev->dev, "Could not find valid DT data.\n");
432 err = request_irq(ts_dev->irq, titsc_irq,
433 IRQF_SHARED, pdev->dev.driver->name, ts_dev);
435 dev_err(&pdev->dev, "failed to allocate irq.\n");
439 titsc_writel(ts_dev, REG_IRQSTATUS, TSC_IRQENB_MASK);
440 titsc_writel(ts_dev, REG_IRQENABLE, IRQENB_FIFO0THRES);
441 titsc_writel(ts_dev, REG_IRQENABLE, IRQENB_EOS);
442 err = titsc_config_wires(ts_dev);
444 dev_err(&pdev->dev, "wrong i/p wire configuration\n");
447 titsc_step_config(ts_dev);
448 titsc_writel(ts_dev, REG_FIFO0THR,
449 ts_dev->coordinate_readouts * 2 + 2 - 1);
451 input_dev->name = "ti-tsc";
452 input_dev->dev.parent = &pdev->dev;
454 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
455 input_dev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
457 input_set_abs_params(input_dev, ABS_X, 0, MAX_12BIT, 0, 0);
458 input_set_abs_params(input_dev, ABS_Y, 0, MAX_12BIT, 0, 0);
459 input_set_abs_params(input_dev, ABS_PRESSURE, 0, MAX_12BIT, 0, 0);
461 /* register to the input system */
462 err = input_register_device(input_dev);
466 platform_set_drvdata(pdev, ts_dev);
470 free_irq(ts_dev->irq, ts_dev);
472 input_free_device(input_dev);
477 static int titsc_remove(struct platform_device *pdev)
479 struct titsc *ts_dev = platform_get_drvdata(pdev);
482 free_irq(ts_dev->irq, ts_dev);
484 /* total steps followed by the enable mask */
485 steps = 2 * ts_dev->coordinate_readouts + 2;
486 steps = (1 << steps) - 1;
487 am335x_tsc_se_clr(ts_dev->mfd_tscadc, steps);
489 input_unregister_device(ts_dev->input);
495 static int __maybe_unused titsc_suspend(struct device *dev)
497 struct titsc *ts_dev = dev_get_drvdata(dev);
498 struct ti_tscadc_dev *tscadc_dev;
501 tscadc_dev = ti_tscadc_dev_get(to_platform_device(dev));
502 if (device_may_wakeup(tscadc_dev->dev)) {
503 titsc_writel(ts_dev, REG_IRQSTATUS, TSC_IRQENB_MASK);
504 idle = titsc_readl(ts_dev, REG_IRQENABLE);
505 titsc_writel(ts_dev, REG_IRQENABLE,
506 (idle | IRQENB_HW_PEN));
507 titsc_writel(ts_dev, REG_IRQWAKEUP, IRQWKUP_ENB);
512 static int __maybe_unused titsc_resume(struct device *dev)
514 struct titsc *ts_dev = dev_get_drvdata(dev);
515 struct ti_tscadc_dev *tscadc_dev;
517 tscadc_dev = ti_tscadc_dev_get(to_platform_device(dev));
518 if (device_may_wakeup(tscadc_dev->dev)) {
519 titsc_writel(ts_dev, REG_IRQWAKEUP,
521 titsc_writel(ts_dev, REG_IRQCLR, IRQENB_HW_PEN);
522 pm_relax(ts_dev->mfd_tscadc->dev);
524 titsc_step_config(ts_dev);
525 titsc_writel(ts_dev, REG_FIFO0THR,
526 ts_dev->coordinate_readouts * 2 + 2 - 1);
530 static SIMPLE_DEV_PM_OPS(titsc_pm_ops, titsc_suspend, titsc_resume);
532 static const struct of_device_id ti_tsc_dt_ids[] = {
533 { .compatible = "ti,am3359-tsc", },
536 MODULE_DEVICE_TABLE(of, ti_tsc_dt_ids);
538 static struct platform_driver ti_tsc_driver = {
539 .probe = titsc_probe,
540 .remove = titsc_remove,
542 .name = "TI-am335x-tsc",
544 .of_match_table = ti_tsc_dt_ids,
547 module_platform_driver(ti_tsc_driver);
549 MODULE_DESCRIPTION("TI touchscreen controller driver");
550 MODULE_AUTHOR("Rachna Patil <rachna@ti.com>");
551 MODULE_LICENSE("GPL");