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/init.h>
18 #include <linux/kernel.h>
19 #include <linux/err.h>
20 #include <linux/module.h>
21 #include <linux/input.h>
22 #include <linux/slab.h>
23 #include <linux/interrupt.h>
24 #include <linux/clk.h>
25 #include <linux/platform_device.h>
27 #include <linux/delay.h>
29 #include <linux/of_device.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 static const int config_pins[] = {
45 struct input_dev *input;
46 struct ti_tscadc_dev *mfd_tscadc;
49 unsigned int x_plate_resistance;
51 int coordinate_readouts;
53 u32 bit_xp, bit_xn, bit_yp, bit_yn;
54 u32 inp_xp, inp_xn, inp_yp, inp_yn;
57 static unsigned int titsc_readl(struct titsc *ts, unsigned int reg)
59 return readl(ts->mfd_tscadc->tscadc_base + reg);
62 static void titsc_writel(struct titsc *tsc, unsigned int reg,
65 writel(val, tsc->mfd_tscadc->tscadc_base + reg);
68 static int titsc_config_wires(struct titsc *ts_dev)
74 for (i = 0; i < 4; i++) {
76 * Get the order in which TSC wires are attached
77 * w.r.t. each of the analog input lines on the EVM.
79 analog_line[i] = (ts_dev->config_inp[i] & 0xF0) >> 4;
80 wire_order[i] = ts_dev->config_inp[i] & 0x0F;
81 if (WARN_ON(analog_line[i] > 7))
83 if (WARN_ON(wire_order[i] > ARRAY_SIZE(config_pins)))
87 for (i = 0; i < 4; i++) {
91 an_line = analog_line[i];
92 wi_order = wire_order[i];
93 bit_cfg = config_pins[wi_order];
98 ts_dev->bit_xp = bit_cfg;
99 ts_dev->inp_xp = an_line;
103 ts_dev->bit_xn = bit_cfg;
104 ts_dev->inp_xn = an_line;
108 ts_dev->bit_yp = bit_cfg;
109 ts_dev->inp_yp = an_line;
112 ts_dev->bit_yn = bit_cfg;
113 ts_dev->inp_yn = an_line;
120 static void titsc_step_config(struct titsc *ts_dev)
127 config = STEPCONFIG_MODE_HWSYNC |
128 STEPCONFIG_AVG_16 | ts_dev->bit_xp;
129 switch (ts_dev->wires) {
131 config |= STEPCONFIG_INP(ts_dev->inp_yp) | ts_dev->bit_xn;
134 config |= ts_dev->bit_yn |
135 STEPCONFIG_INP_AN4 | ts_dev->bit_xn |
139 config |= STEPCONFIG_INP(ts_dev->inp_yp) | ts_dev->bit_xn;
143 /* 1 … coordinate_readouts is for X */
144 end_step = ts_dev->coordinate_readouts;
145 for (i = 0; i < end_step; i++) {
146 titsc_writel(ts_dev, REG_STEPCONFIG(i), config);
147 titsc_writel(ts_dev, REG_STEPDELAY(i), STEPCONFIG_OPENDLY);
151 config = STEPCONFIG_MODE_HWSYNC |
152 STEPCONFIG_AVG_16 | ts_dev->bit_yn |
153 STEPCONFIG_INM_ADCREFM;
154 switch (ts_dev->wires) {
156 config |= ts_dev->bit_yp | STEPCONFIG_INP(ts_dev->inp_xp);
159 config |= ts_dev->bit_xp | STEPCONFIG_INP_AN4 |
160 ts_dev->bit_xn | ts_dev->bit_yp;
163 config |= ts_dev->bit_yp | STEPCONFIG_INP(ts_dev->inp_xp);
167 /* coordinate_readouts … coordinate_readouts * 2 is for Y */
168 end_step = ts_dev->coordinate_readouts * 2;
169 for (i = ts_dev->coordinate_readouts; i < end_step; i++) {
170 titsc_writel(ts_dev, REG_STEPCONFIG(i), config);
171 titsc_writel(ts_dev, REG_STEPDELAY(i), STEPCONFIG_OPENDLY);
174 /* Charge step configuration */
175 config = ts_dev->bit_xp | ts_dev->bit_yn |
176 STEPCHARGE_RFP_XPUL | STEPCHARGE_RFM_XNUR |
177 STEPCHARGE_INM_AN1 | STEPCHARGE_INP(ts_dev->inp_yp);
179 titsc_writel(ts_dev, REG_CHARGECONFIG, config);
180 titsc_writel(ts_dev, REG_CHARGEDELAY, CHARGEDLY_OPENDLY);
182 /* coordinate_readouts * 2 … coordinate_readouts * 2 + 2 is for Z */
183 config = STEPCONFIG_MODE_HWSYNC |
184 STEPCONFIG_AVG_16 | ts_dev->bit_yp |
185 ts_dev->bit_xn | STEPCONFIG_INM_ADCREFM |
186 STEPCONFIG_INP(ts_dev->inp_xp);
187 titsc_writel(ts_dev, REG_STEPCONFIG(end_step), config);
188 titsc_writel(ts_dev, REG_STEPDELAY(end_step),
192 config |= STEPCONFIG_INP(ts_dev->inp_yn);
193 titsc_writel(ts_dev, REG_STEPCONFIG(end_step), config);
194 titsc_writel(ts_dev, REG_STEPDELAY(end_step),
197 /* The steps1 … end and bit 0 for TS_Charge */
198 stepenable = (1 << (end_step + 2)) - 1;
199 am335x_tsc_se_set(ts_dev->mfd_tscadc, stepenable);
202 static void titsc_read_coordinates(struct titsc *ts_dev,
203 u32 *x, u32 *y, u32 *z1, u32 *z2)
205 unsigned int fifocount = titsc_readl(ts_dev, REG_FIFO0CNT);
206 unsigned int prev_val_x = ~0, prev_val_y = ~0;
207 unsigned int prev_diff_x = ~0, prev_diff_y = ~0;
208 unsigned int read, diff;
209 unsigned int i, channel;
210 unsigned int creads = ts_dev->coordinate_readouts;
213 if (fifocount % (creads * 2 + 2))
214 fifocount -= fifocount % (creads * 2 + 2);
216 * Delta filter is used to remove large variations in sampled
217 * values from ADC. The filter tries to predict where the next
218 * coordinate could be. This is done by taking a previous
219 * coordinate and subtracting it form current one. Further the
220 * algorithm compares the difference with that of a present value,
221 * if true the value is reported to the sub system.
223 for (i = 0; i < fifocount; i++) {
224 read = titsc_readl(ts_dev, REG_FIFO0);
226 channel = (read & 0xf0000) >> 16;
228 if (channel < creads) {
229 diff = abs(read - prev_val_x);
230 if (diff < prev_diff_x) {
236 } else if (channel < creads * 2) {
237 diff = abs(read - prev_val_y);
238 if (diff < prev_diff_y) {
244 } else if (channel < creads * 2 + 1) {
247 } else if (channel < creads * 2 + 2) {
253 static irqreturn_t titsc_irq(int irq, void *dev)
255 struct titsc *ts_dev = dev;
256 struct input_dev *input_dev = ts_dev->input;
257 unsigned int status, irqclr = 0;
258 unsigned int x = 0, y = 0;
259 unsigned int z1, z2, z;
262 status = titsc_readl(ts_dev, REG_IRQSTATUS);
263 if (status & IRQENB_FIFO0THRES) {
265 titsc_read_coordinates(ts_dev, &x, &y, &z1, &z2);
267 if (ts_dev->pen_down && z1 != 0 && z2 != 0) {
269 * Calculate pressure using formula
270 * Resistance(touch) = x plate resistance *
271 * x postion/4096 * ((z2 / z1) - 1)
275 z *= ts_dev->x_plate_resistance;
277 z = (z + 2047) >> 12;
279 if (z <= MAX_12BIT) {
280 input_report_abs(input_dev, ABS_X, x);
281 input_report_abs(input_dev, ABS_Y, y);
282 input_report_abs(input_dev, ABS_PRESSURE, z);
283 input_report_key(input_dev, BTN_TOUCH, 1);
284 input_sync(input_dev);
287 irqclr |= IRQENB_FIFO0THRES;
291 * Time for sequencer to settle, to read
292 * correct state of the sequencer.
296 status = titsc_readl(ts_dev, REG_RAWIRQSTATUS);
297 if (status & IRQENB_PENUP) {
299 fsm = titsc_readl(ts_dev, REG_ADCFSM);
300 if (fsm == ADCFSM_STEPID) {
301 ts_dev->pen_down = false;
302 input_report_key(input_dev, BTN_TOUCH, 0);
303 input_report_abs(input_dev, ABS_PRESSURE, 0);
304 input_sync(input_dev);
306 ts_dev->pen_down = true;
308 irqclr |= IRQENB_PENUP;
311 if (status & IRQENB_HW_PEN) {
313 titsc_writel(ts_dev, REG_IRQWAKEUP, 0x00);
314 titsc_writel(ts_dev, REG_IRQCLR, IRQENB_HW_PEN);
318 titsc_writel(ts_dev, REG_IRQSTATUS, irqclr);
319 am335x_tsc_se_update(ts_dev->mfd_tscadc);
325 static int titsc_parse_dt(struct platform_device *pdev,
326 struct titsc *ts_dev)
328 struct device_node *node = pdev->dev.of_node;
334 err = of_property_read_u32(node, "ti,wires", &ts_dev->wires);
337 switch (ts_dev->wires) {
346 err = of_property_read_u32(node, "ti,x-plate-resistance",
347 &ts_dev->x_plate_resistance);
351 err = of_property_read_u32(node, "ti,coordiante-readouts",
352 &ts_dev->coordinate_readouts);
356 return of_property_read_u32_array(node, "ti,wire-config",
357 ts_dev->config_inp, ARRAY_SIZE(ts_dev->config_inp));
361 * The functions for inserting/removing driver as a module.
364 static int titsc_probe(struct platform_device *pdev)
366 struct titsc *ts_dev;
367 struct input_dev *input_dev;
368 struct ti_tscadc_dev *tscadc_dev = ti_tscadc_dev_get(pdev);
371 /* Allocate memory for device */
372 ts_dev = kzalloc(sizeof(struct titsc), GFP_KERNEL);
373 input_dev = input_allocate_device();
374 if (!ts_dev || !input_dev) {
375 dev_err(&pdev->dev, "failed to allocate memory.\n");
380 tscadc_dev->tsc = ts_dev;
381 ts_dev->mfd_tscadc = tscadc_dev;
382 ts_dev->input = input_dev;
383 ts_dev->irq = tscadc_dev->irq;
385 err = titsc_parse_dt(pdev, ts_dev);
387 dev_err(&pdev->dev, "Could not find valid DT data.\n");
391 err = request_irq(ts_dev->irq, titsc_irq,
392 0, pdev->dev.driver->name, ts_dev);
394 dev_err(&pdev->dev, "failed to allocate irq.\n");
398 titsc_writel(ts_dev, REG_IRQENABLE, IRQENB_FIFO0THRES);
399 err = titsc_config_wires(ts_dev);
401 dev_err(&pdev->dev, "wrong i/p wire configuration\n");
404 titsc_step_config(ts_dev);
405 titsc_writel(ts_dev, REG_FIFO0THR,
406 ts_dev->coordinate_readouts * 2 + 2 - 1);
408 input_dev->name = "ti-tsc";
409 input_dev->dev.parent = &pdev->dev;
411 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
412 input_dev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
414 input_set_abs_params(input_dev, ABS_X, 0, MAX_12BIT, 0, 0);
415 input_set_abs_params(input_dev, ABS_Y, 0, MAX_12BIT, 0, 0);
416 input_set_abs_params(input_dev, ABS_PRESSURE, 0, MAX_12BIT, 0, 0);
418 /* register to the input system */
419 err = input_register_device(input_dev);
423 platform_set_drvdata(pdev, ts_dev);
427 free_irq(ts_dev->irq, ts_dev);
429 input_free_device(input_dev);
434 static int titsc_remove(struct platform_device *pdev)
436 struct titsc *ts_dev = platform_get_drvdata(pdev);
439 free_irq(ts_dev->irq, ts_dev);
441 /* total steps followed by the enable mask */
442 steps = 2 * ts_dev->coordinate_readouts + 2;
443 steps = (1 << steps) - 1;
444 am335x_tsc_se_clr(ts_dev->mfd_tscadc, steps);
446 input_unregister_device(ts_dev->input);
453 static int titsc_suspend(struct device *dev)
455 struct titsc *ts_dev = dev_get_drvdata(dev);
456 struct ti_tscadc_dev *tscadc_dev;
459 tscadc_dev = ti_tscadc_dev_get(to_platform_device(dev));
460 if (device_may_wakeup(tscadc_dev->dev)) {
461 idle = titsc_readl(ts_dev, REG_IRQENABLE);
462 titsc_writel(ts_dev, REG_IRQENABLE,
463 (idle | IRQENB_HW_PEN));
464 titsc_writel(ts_dev, REG_IRQWAKEUP, IRQWKUP_ENB);
469 static int titsc_resume(struct device *dev)
471 struct titsc *ts_dev = dev_get_drvdata(dev);
472 struct ti_tscadc_dev *tscadc_dev;
474 tscadc_dev = ti_tscadc_dev_get(to_platform_device(dev));
475 if (device_may_wakeup(tscadc_dev->dev)) {
476 titsc_writel(ts_dev, REG_IRQWAKEUP,
478 titsc_writel(ts_dev, REG_IRQCLR, IRQENB_HW_PEN);
480 titsc_step_config(ts_dev);
481 titsc_writel(ts_dev, REG_FIFO0THR,
482 ts_dev->coordinate_readouts * 2 + 2 - 1);
486 static const struct dev_pm_ops titsc_pm_ops = {
487 .suspend = titsc_suspend,
488 .resume = titsc_resume,
490 #define TITSC_PM_OPS (&titsc_pm_ops)
492 #define TITSC_PM_OPS NULL
495 static const struct of_device_id ti_tsc_dt_ids[] = {
496 { .compatible = "ti,am3359-tsc", },
499 MODULE_DEVICE_TABLE(of, ti_tsc_dt_ids);
501 static struct platform_driver ti_tsc_driver = {
502 .probe = titsc_probe,
503 .remove = titsc_remove,
505 .name = "TI-am335x-tsc",
506 .owner = THIS_MODULE,
508 .of_match_table = of_match_ptr(ti_tsc_dt_ids),
511 module_platform_driver(ti_tsc_driver);
513 MODULE_DESCRIPTION("TI touchscreen controller driver");
514 MODULE_AUTHOR("Rachna Patil <rachna@ti.com>");
515 MODULE_LICENSE("GPL");