3 * Cypress TrueTouch(TM) Standard Product (TTSP) touchscreen drivers.
4 * For use with Cypress Txx3xx parts.
5 * Supported parts include:
9 * Copyright (C) 2009, 2010, 2011 Cypress Semiconductor, Inc.
10 * Copyright (C) 2012 Javier Martinez Canillas <javier@dowhile0.org>
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * version 2, and only version 2, as published by the
15 * Free Software Foundation.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 * Contact Cypress Semiconductor at www.cypress.com <kev@cypress.com>
30 #include <linux/delay.h>
31 #include <linux/input.h>
32 #include <linux/input/mt.h>
33 #include <linux/input/touchscreen.h>
34 #include <linux/gpio.h>
35 #include <linux/interrupt.h>
36 #include <linux/slab.h>
37 #include <linux/property.h>
38 #include <linux/gpio/consumer.h>
40 #include "cyttsp_core.h"
42 /* Bootloader number of command keys */
43 #define CY_NUM_BL_KEYS 8
46 #define GET_NUM_TOUCHES(x) ((x) & 0x0F)
47 #define IS_LARGE_AREA(x) (((x) & 0x10) >> 4)
48 #define IS_BAD_PKT(x) ((x) & 0x20)
49 #define IS_VALID_APP(x) ((x) & 0x01)
50 #define IS_OPERATIONAL_ERR(x) ((x) & 0x3F)
51 #define GET_HSTMODE(reg) (((reg) & 0x70) >> 4)
52 #define GET_BOOTLOADERMODE(reg) (((reg) & 0x10) >> 4)
54 #define CY_REG_BASE 0x00
55 #define CY_REG_ACT_DIST 0x1E
56 #define CY_REG_ACT_INTRVL 0x1D
57 #define CY_REG_TCH_TMOUT (CY_REG_ACT_INTRVL + 1)
58 #define CY_REG_LP_INTRVL (CY_REG_TCH_TMOUT + 1)
60 #define CY_DELAY_DFLT 20 /* ms */
61 #define CY_DELAY_MAX 500
62 #define CY_ACT_DIST_DFLT 0xF8
63 #define CY_ACT_DIST_MASK 0x0F
64 #define CY_HNDSHK_BIT 0x80
65 /* device mode bits */
66 #define CY_OPERATE_MODE 0x00
67 #define CY_SYSINFO_MODE 0x10
68 /* power mode select bits */
69 #define CY_SOFT_RESET_MODE 0x01 /* return to Bootloader mode */
70 #define CY_DEEP_SLEEP_MODE 0x02
71 #define CY_LOW_POWER_MODE 0x04
73 /* Slots management */
74 #define CY_MAX_FINGER 4
77 static const u8 bl_command[] = {
78 0x00, /* file offset */
80 0xA5, /* exit bootloader command */
81 0, 1, 2, 3, 4, 5, 6, 7 /* default keys */
84 static int ttsp_read_block_data(struct cyttsp *ts, u8 command,
90 for (tries = 0; tries < CY_NUM_RETRY; tries++) {
91 error = ts->bus_ops->read(ts->dev, ts->xfer_buf, command,
96 msleep(CY_DELAY_DFLT);
102 static int ttsp_write_block_data(struct cyttsp *ts, u8 command,
103 u8 length, void *buf)
108 for (tries = 0; tries < CY_NUM_RETRY; tries++) {
109 error = ts->bus_ops->write(ts->dev, ts->xfer_buf, command,
114 msleep(CY_DELAY_DFLT);
120 static int ttsp_send_command(struct cyttsp *ts, u8 cmd)
122 return ttsp_write_block_data(ts, CY_REG_BASE, sizeof(cmd), &cmd);
125 static int cyttsp_handshake(struct cyttsp *ts)
128 return ttsp_send_command(ts,
129 ts->xy_data.hst_mode ^ CY_HNDSHK_BIT);
134 static int cyttsp_load_bl_regs(struct cyttsp *ts)
136 memset(&ts->bl_data, 0, sizeof(ts->bl_data));
137 ts->bl_data.bl_status = 0x10;
139 return ttsp_read_block_data(ts, CY_REG_BASE,
140 sizeof(ts->bl_data), &ts->bl_data);
143 static int cyttsp_exit_bl_mode(struct cyttsp *ts)
146 u8 bl_cmd[sizeof(bl_command)];
148 memcpy(bl_cmd, bl_command, sizeof(bl_command));
150 memcpy(&bl_cmd[sizeof(bl_command) - CY_NUM_BL_KEYS],
151 ts->bl_keys, CY_NUM_BL_KEYS);
153 error = ttsp_write_block_data(ts, CY_REG_BASE,
154 sizeof(bl_cmd), bl_cmd);
158 /* wait for TTSP Device to complete the operation */
159 msleep(CY_DELAY_DFLT);
161 error = cyttsp_load_bl_regs(ts);
165 if (GET_BOOTLOADERMODE(ts->bl_data.bl_status))
171 static int cyttsp_set_operational_mode(struct cyttsp *ts)
175 error = ttsp_send_command(ts, CY_OPERATE_MODE);
179 /* wait for TTSP Device to complete switch to Operational mode */
180 error = ttsp_read_block_data(ts, CY_REG_BASE,
181 sizeof(ts->xy_data), &ts->xy_data);
185 error = cyttsp_handshake(ts);
189 return ts->xy_data.act_dist == CY_ACT_DIST_DFLT ? -EIO : 0;
192 static int cyttsp_set_sysinfo_mode(struct cyttsp *ts)
196 memset(&ts->sysinfo_data, 0, sizeof(ts->sysinfo_data));
198 /* switch to sysinfo mode */
199 error = ttsp_send_command(ts, CY_SYSINFO_MODE);
203 /* read sysinfo registers */
204 msleep(CY_DELAY_DFLT);
205 error = ttsp_read_block_data(ts, CY_REG_BASE, sizeof(ts->sysinfo_data),
210 error = cyttsp_handshake(ts);
214 if (!ts->sysinfo_data.tts_verh && !ts->sysinfo_data.tts_verl)
220 static int cyttsp_set_sysinfo_regs(struct cyttsp *ts)
224 if (ts->act_intrvl != CY_ACT_INTRVL_DFLT ||
225 ts->tch_tmout != CY_TCH_TMOUT_DFLT ||
226 ts->lp_intrvl != CY_LP_INTRVL_DFLT) {
234 /* set intrvl registers */
235 retval = ttsp_write_block_data(ts, CY_REG_ACT_INTRVL,
236 sizeof(intrvl_ray), intrvl_ray);
237 msleep(CY_DELAY_DFLT);
243 static void cyttsp_hard_reset(struct cyttsp *ts)
245 if (ts->reset_gpio) {
246 gpiod_set_value_cansleep(ts->reset_gpio, 1);
247 msleep(CY_DELAY_DFLT);
248 gpiod_set_value_cansleep(ts->reset_gpio, 0);
249 msleep(CY_DELAY_DFLT);
253 static int cyttsp_soft_reset(struct cyttsp *ts)
255 unsigned long timeout;
258 /* wait for interrupt to set ready completion */
259 reinit_completion(&ts->bl_ready);
260 ts->state = CY_BL_STATE;
264 retval = ttsp_send_command(ts, CY_SOFT_RESET_MODE);
268 timeout = wait_for_completion_timeout(&ts->bl_ready,
269 msecs_to_jiffies(CY_DELAY_DFLT * CY_DELAY_MAX));
270 retval = timeout ? 0 : -EIO;
273 ts->state = CY_IDLE_STATE;
274 disable_irq(ts->irq);
278 static int cyttsp_act_dist_setup(struct cyttsp *ts)
280 u8 act_dist_setup = ts->act_dist;
282 /* Init gesture; active distance setup */
283 return ttsp_write_block_data(ts, CY_REG_ACT_DIST,
284 sizeof(act_dist_setup), &act_dist_setup);
287 static void cyttsp_extract_track_ids(struct cyttsp_xydata *xy_data, int *ids)
289 ids[0] = xy_data->touch12_id >> 4;
290 ids[1] = xy_data->touch12_id & 0xF;
291 ids[2] = xy_data->touch34_id >> 4;
292 ids[3] = xy_data->touch34_id & 0xF;
295 static const struct cyttsp_tch *cyttsp_get_tch(struct cyttsp_xydata *xy_data,
300 return &xy_data->tch1;
302 return &xy_data->tch2;
304 return &xy_data->tch3;
306 return &xy_data->tch4;
312 static void cyttsp_report_tchdata(struct cyttsp *ts)
314 struct cyttsp_xydata *xy_data = &ts->xy_data;
315 struct input_dev *input = ts->input;
316 int num_tch = GET_NUM_TOUCHES(xy_data->tt_stat);
317 const struct cyttsp_tch *tch;
320 DECLARE_BITMAP(used, CY_MAX_ID);
322 if (IS_LARGE_AREA(xy_data->tt_stat) == 1) {
323 /* terminate all active tracks */
325 dev_dbg(ts->dev, "%s: Large area detected\n", __func__);
326 } else if (num_tch > CY_MAX_FINGER) {
327 /* terminate all active tracks */
329 dev_dbg(ts->dev, "%s: Num touch error detected\n", __func__);
330 } else if (IS_BAD_PKT(xy_data->tt_mode)) {
331 /* terminate all active tracks */
333 dev_dbg(ts->dev, "%s: Invalid buffer detected\n", __func__);
336 cyttsp_extract_track_ids(xy_data, ids);
338 bitmap_zero(used, CY_MAX_ID);
340 for (i = 0; i < num_tch; i++) {
341 tch = cyttsp_get_tch(xy_data, i);
343 input_mt_slot(input, ids[i]);
344 input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
345 input_report_abs(input, ABS_MT_POSITION_X, be16_to_cpu(tch->x));
346 input_report_abs(input, ABS_MT_POSITION_Y, be16_to_cpu(tch->y));
347 input_report_abs(input, ABS_MT_TOUCH_MAJOR, tch->z);
349 __set_bit(ids[i], used);
352 for (i = 0; i < CY_MAX_ID; i++) {
353 if (test_bit(i, used))
356 input_mt_slot(input, i);
357 input_mt_report_slot_state(input, MT_TOOL_FINGER, false);
363 static irqreturn_t cyttsp_irq(int irq, void *handle)
365 struct cyttsp *ts = handle;
368 if (unlikely(ts->state == CY_BL_STATE)) {
369 complete(&ts->bl_ready);
373 /* Get touch data from CYTTSP device */
374 error = ttsp_read_block_data(ts, CY_REG_BASE,
375 sizeof(struct cyttsp_xydata), &ts->xy_data);
379 /* provide flow control handshake */
380 error = cyttsp_handshake(ts);
384 if (unlikely(ts->state == CY_IDLE_STATE))
387 if (GET_BOOTLOADERMODE(ts->xy_data.tt_mode)) {
389 * TTSP device has reset back to bootloader mode.
390 * Restore to operational mode.
392 error = cyttsp_exit_bl_mode(ts);
395 "Could not return to operational mode, err: %d\n",
397 ts->state = CY_IDLE_STATE;
400 cyttsp_report_tchdata(ts);
407 static int cyttsp_power_on(struct cyttsp *ts)
411 error = cyttsp_soft_reset(ts);
415 error = cyttsp_load_bl_regs(ts);
419 if (GET_BOOTLOADERMODE(ts->bl_data.bl_status) &&
420 IS_VALID_APP(ts->bl_data.bl_status)) {
421 error = cyttsp_exit_bl_mode(ts);
426 if (GET_HSTMODE(ts->bl_data.bl_file) != CY_OPERATE_MODE ||
427 IS_OPERATIONAL_ERR(ts->bl_data.bl_status)) {
431 error = cyttsp_set_sysinfo_mode(ts);
435 error = cyttsp_set_sysinfo_regs(ts);
439 error = cyttsp_set_operational_mode(ts);
443 /* init active distance */
444 error = cyttsp_act_dist_setup(ts);
448 ts->state = CY_ACTIVE_STATE;
453 static int cyttsp_enable(struct cyttsp *ts)
458 * The device firmware can wake on an I2C or SPI memory slave
459 * address match. So just reading a register is sufficient to
460 * wake up the device. The first read attempt will fail but it
461 * will wake it up making the second read attempt successful.
463 error = ttsp_read_block_data(ts, CY_REG_BASE,
464 sizeof(ts->xy_data), &ts->xy_data);
468 if (GET_HSTMODE(ts->xy_data.hst_mode))
476 static int cyttsp_disable(struct cyttsp *ts)
480 error = ttsp_send_command(ts, CY_LOW_POWER_MODE);
484 disable_irq(ts->irq);
489 static int __maybe_unused cyttsp_suspend(struct device *dev)
491 struct cyttsp *ts = dev_get_drvdata(dev);
494 mutex_lock(&ts->input->mutex);
496 if (ts->input->users) {
497 retval = cyttsp_disable(ts);
499 ts->suspended = true;
502 mutex_unlock(&ts->input->mutex);
507 static int __maybe_unused cyttsp_resume(struct device *dev)
509 struct cyttsp *ts = dev_get_drvdata(dev);
511 mutex_lock(&ts->input->mutex);
513 if (ts->input->users)
516 ts->suspended = false;
518 mutex_unlock(&ts->input->mutex);
523 SIMPLE_DEV_PM_OPS(cyttsp_pm_ops, cyttsp_suspend, cyttsp_resume);
524 EXPORT_SYMBOL_GPL(cyttsp_pm_ops);
526 static int cyttsp_open(struct input_dev *dev)
528 struct cyttsp *ts = input_get_drvdata(dev);
532 retval = cyttsp_enable(ts);
537 static void cyttsp_close(struct input_dev *dev)
539 struct cyttsp *ts = input_get_drvdata(dev);
545 static int cyttsp_parse_properties(struct cyttsp *ts)
547 struct device *dev = ts->dev;
551 ts->bl_keys = devm_kzalloc(dev, CY_NUM_BL_KEYS, GFP_KERNEL);
555 /* Set some default values */
556 ts->use_hndshk = false;
557 ts->act_dist = CY_ACT_DIST_DFLT;
558 ts->act_intrvl = CY_ACT_INTRVL_DFLT;
559 ts->tch_tmout = CY_TCH_TMOUT_DFLT;
560 ts->lp_intrvl = CY_LP_INTRVL_DFLT;
562 ret = device_property_read_u8_array(dev, "bootloader-key",
563 ts->bl_keys, CY_NUM_BL_KEYS);
566 "bootloader-key property could not be retrieved\n");
570 ts->use_hndshk = device_property_present(dev, "use-handshake");
572 if (!device_property_read_u32(dev, "active-distance", &dt_value)) {
574 dev_err(dev, "active-distance (%u) must be [0-15]\n",
578 ts->act_dist &= ~CY_ACT_DIST_MASK;
579 ts->act_dist |= dt_value;
582 if (!device_property_read_u32(dev, "active-interval-ms", &dt_value)) {
583 if (dt_value > 255) {
584 dev_err(dev, "active-interval-ms (%u) must be [0-255]\n",
588 ts->act_intrvl = dt_value;
591 if (!device_property_read_u32(dev, "lowpower-interval-ms", &dt_value)) {
592 if (dt_value > 2550) {
593 dev_err(dev, "lowpower-interval-ms (%u) must be [0-2550]\n",
597 /* Register value is expressed in 0.01s / bit */
598 ts->lp_intrvl = dt_value / 10;
601 if (!device_property_read_u32(dev, "touch-timeout-ms", &dt_value)) {
602 if (dt_value > 2550) {
603 dev_err(dev, "touch-timeout-ms (%u) must be [0-2550]\n",
607 /* Register value is expressed in 0.01s / bit */
608 ts->tch_tmout = dt_value / 10;
614 struct cyttsp *cyttsp_probe(const struct cyttsp_bus_ops *bus_ops,
615 struct device *dev, int irq, size_t xfer_buf_size)
618 struct input_dev *input_dev;
621 ts = devm_kzalloc(dev, sizeof(*ts) + xfer_buf_size, GFP_KERNEL);
623 return ERR_PTR(-ENOMEM);
625 input_dev = devm_input_allocate_device(dev);
627 return ERR_PTR(-ENOMEM);
630 ts->input = input_dev;
631 ts->bus_ops = bus_ops;
634 ts->reset_gpio = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_LOW);
635 if (IS_ERR(ts->reset_gpio)) {
636 error = PTR_ERR(ts->reset_gpio);
637 dev_err(dev, "Failed to request reset gpio, error %d\n", error);
638 return ERR_PTR(error);
641 error = cyttsp_parse_properties(ts);
643 return ERR_PTR(error);
645 init_completion(&ts->bl_ready);
646 snprintf(ts->phys, sizeof(ts->phys), "%s/input0", dev_name(dev));
648 input_dev->name = "Cypress TTSP TouchScreen";
649 input_dev->phys = ts->phys;
650 input_dev->id.bustype = bus_ops->bustype;
651 input_dev->dev.parent = ts->dev;
653 input_dev->open = cyttsp_open;
654 input_dev->close = cyttsp_close;
656 input_set_drvdata(input_dev, ts);
658 input_set_capability(input_dev, EV_ABS, ABS_MT_POSITION_X);
659 input_set_capability(input_dev, EV_ABS, ABS_MT_POSITION_Y);
660 touchscreen_parse_properties(input_dev, true, NULL);
662 error = input_mt_init_slots(input_dev, CY_MAX_ID, 0);
664 dev_err(dev, "Unable to init MT slots.\n");
665 return ERR_PTR(error);
668 error = devm_request_threaded_irq(dev, ts->irq, NULL, cyttsp_irq,
669 IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
672 dev_err(ts->dev, "failed to request IRQ %d, err: %d\n",
674 return ERR_PTR(error);
677 disable_irq(ts->irq);
679 cyttsp_hard_reset(ts);
681 error = cyttsp_power_on(ts);
683 return ERR_PTR(error);
685 error = input_register_device(input_dev);
687 dev_err(ts->dev, "failed to register input device: %d\n",
689 return ERR_PTR(error);
694 EXPORT_SYMBOL_GPL(cyttsp_probe);
696 MODULE_LICENSE("GPL");
697 MODULE_DESCRIPTION("Cypress TrueTouch(R) Standard touchscreen driver core");
698 MODULE_AUTHOR("Cypress");