drivers/input/touchscreen/tinker_ft5406.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *
   4  * TINKER BOARD FT5406 touch driver.
   5  *
   6  * Copyright (c) 2016 ASUSTek Computer Inc.
   7  * Copyright (c) 2012-2014, The Linux Foundation. All rights reserved.
   8  *
   9  * This software is licensed under the terms of the GNU General Public
  10  * License version 2, as published by the Free Software Foundation, and
  11  * may be copied, distributed, and modified under those terms.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  */
  19
  20 #include <linux/module.h>
  21 #include <linux/slab.h>
  22 #include <linux/delay.h>
  23 #include <linux/i2c.h>
  24 #include <linux/input.h>
  25 #include <linux/input/mt.h>
  26 #include <linux/module.h>
  27 #include <linux/workqueue.h>
  28
  29 #define LOG_DBG(fmt, arg...) pr_debug("tinker-ft5406: %s: "fmt, __func__, ##arg)
  30 #define LOG_INFO(fmt, arg...) pr_info("tinker-ft5406: %s: "fmt, __func__, ##arg)
  31 #define LOG_ERR(fmt, arg...) pr_err("tinker-ft5406: %s: "fmt, __func__, ##arg)
  32
  33 #define RETRY_COUNT 10
  34 #define FT_ONE_TCH_LEN  6
  35
  36 #define FT_REG_FW_VER                   0xA6
  37 #define FT_REG_FW_MIN_VER               0xB2
  38 #define FT_REG_FW_SUB_MIN_VER   0xB3
  39
  40 #define VALID_TD_STATUS_VAL             10
  41 #define MAX_TOUCH_POINTS                5
  42
  43 #define FT_PRESS                        0x7F
  44 #define FT_MAX_ID                       0x0F
  45
  46 #define FT_TOUCH_X_H    0
  47 #define FT_TOUCH_X_L    1
  48 #define FT_TOUCH_Y_H    2
  49 #define FT_TOUCH_Y_L    3
  50 #define FT_TOUCH_EVENT  0
  51 #define FT_TOUCH_ID             2
  52
  53 #define FT_TOUCH_X_H_REG        3
  54 #define FT_TOUCH_X_L_REG        4
  55 #define FT_TOUCH_Y_H_REG        5
  56 #define FT_TOUCH_Y_L_REG        6
  57 #define FT_TD_STATUS_REG        2
  58 #define FT_TOUCH_EVENT_REG      3
  59 #define FT_TOUCH_ID_REG         5
  60
  61 #define FT_TOUCH_DOWN           0
  62 #define FT_TOUCH_CONTACT        2
  63
  64 struct ts_event {
  65         u16 au16_x[MAX_TOUCH_POINTS]; /*x coordinate */
  66         u16 au16_y[MAX_TOUCH_POINTS]; /*y coordinate */
  67         u8 au8_touch_event[MAX_TOUCH_POINTS]; /*touch event: 0:down; 1:up; 2:contact */
  68         u8 au8_finger_id[MAX_TOUCH_POINTS]; /*touch ID */
  69         u16 pressure;
  70         u8 touch_point;
  71         u8 point_num;
  72 };
  73
  74 struct tinker_ft5406_data {
  75         struct device *dev;
  76         struct i2c_client *client;
  77         struct input_dev *input_dev;
  78         struct ts_event event;
  79         struct work_struct ft5406_work;
  80
  81         int screen_width;
  82         int screen_height;
  83         int xy_reverse;
  84         int known_ids;
  85         int retry_count;
  86         bool finish_work;
  87 };
  88
  89 struct tinker_ft5406_data *g_ts_data;
  90
  91 static int fts_i2c_read(struct i2c_client *client, char *writebuf,
  92                            int writelen, char *readbuf, int readlen)
  93 {
  94         int ret;
  95
  96         if (writelen > 0) {
  97                 struct i2c_msg msgs[] = {
  98                         {
  99                                  .addr = client->addr,
 100                                  .flags = 0,
 101                                  .len = writelen,
 102                                  .buf = writebuf,
 103                          },
 104                         {
 105                                  .addr = client->addr,
 106                                  .flags = I2C_M_RD,
 107                                  .len = readlen,
 108                                  .buf = readbuf,
 109                          },
 110                 };
 111                 ret = i2c_transfer(client->adapter, msgs, 2);
 112                 if (ret < 0)
 113                         LOG_ERR("i2c read error, %d\n", ret);
 114         } else {
 115                 struct i2c_msg msgs[] = {
 116                         {
 117                                  .addr = client->addr,
 118                                  .flags = I2C_M_RD,
 119                                  .len = readlen,
 120                                  .buf = readbuf,
 121                          },
 122                 };
 123                 ret = i2c_transfer(client->adapter, msgs, 1);
 124                 if (ret < 0)
 125                         LOG_ERR("i2c read error, %d\n", ret);
 126         }
 127
 128         return ret;
 129 }
 130
 131 static int fts_read_reg(struct i2c_client *client, u8 addr, u8 *val)
 132 {
 133         return fts_i2c_read(client, &addr, 1, val, 1);
 134 }
 135
 136 static int fts_check_fw_ver(struct i2c_client *client)
 137 {
 138         u8 reg_addr, fw_ver[3];
 139         int ret;
 140
 141         reg_addr = FT_REG_FW_VER;
 142         ret = fts_i2c_read(client, &reg_addr, 1, &fw_ver[0], 1);
 143         if (ret < 0)
 144                 goto error;
 145
 146         reg_addr = FT_REG_FW_MIN_VER;
 147         ret = fts_i2c_read(client, &reg_addr, 1, &fw_ver[1], 1);
 148         if (ret < 0)
 149                 goto error;
 150
 151         reg_addr = FT_REG_FW_SUB_MIN_VER;
 152         ret = fts_i2c_read(client, &reg_addr, 1, &fw_ver[2], 1);
 153         if (ret < 0)
 154                 goto error;
 155
 156         LOG_INFO("Firmware version = %d.%d.%d\n", fw_ver[0], fw_ver[1], fw_ver[2]);
 157         return 0;
 158
 159 error:
 160         return ret;
 161 }
 162
 163 static int fts_read_td_status(struct tinker_ft5406_data *ts_data)
 164 {
 165         u8 td_status;
 166         int ret = -1;
 167
 168         ret = fts_read_reg(ts_data->client, FT_TD_STATUS_REG, &td_status);
 169         if (ret < 0) {
 170                 LOG_ERR("get reg td_status failed, %d\n", ret);
 171                 return ret;
 172         }
 173         return (int)td_status;
 174 }
 175
 176 static int fts_read_touchdata(struct tinker_ft5406_data *ts_data)
 177 {
 178         struct ts_event *event = &ts_data->event;
 179         int ret = -1, i;
 180         u8 buf[FT_ONE_TCH_LEN-2] = { 0 };
 181         u8 reg_addr, pointid = FT_MAX_ID;
 182
 183         for (i = 0; i < event->touch_point && i < MAX_TOUCH_POINTS; i++) {
 184                 reg_addr = FT_TOUCH_X_H_REG + (i * FT_ONE_TCH_LEN);
 185                 ret = fts_i2c_read(ts_data->client, &reg_addr, 1, buf, FT_ONE_TCH_LEN-2);
 186                 if (ret < 0) {
 187                         LOG_ERR("read touchdata failed.\n");
 188                         return ret;
 189                 }
 190
 191                 pointid = (buf[FT_TOUCH_ID]) >> 4;
 192                 if (pointid >= MAX_TOUCH_POINTS)
 193                         break;
 194                 event->au8_finger_id[i] = pointid;
 195                 event->au16_x[i] = (s16) (buf[FT_TOUCH_X_H] & 0x0F) << 8 | (s16) buf[FT_TOUCH_X_L];
 196                 event->au16_y[i] = (s16) (buf[FT_TOUCH_Y_H] & 0x0F) << 8 | (s16) buf[FT_TOUCH_Y_L];
 197                 event->au8_touch_event[i] = buf[FT_TOUCH_EVENT] >> 6;
 198
 199                 if (ts_data->xy_reverse) {
 200                         event->au16_x[i] = ts_data->screen_width - event->au16_x[i] - 1;
 201                         event->au16_y[i] = ts_data->screen_height - event->au16_y[i] - 1;
 202                 }
 203         }
 204         event->pressure = FT_PRESS;
 205
 206         return 0;
 207 }
 208
 209 static void fts_report_value(struct tinker_ft5406_data *ts_data)
 210 {
 211         struct ts_event *event = &ts_data->event;
 212         int i, modified_ids = 0, released_ids;
 213
 214         for (i = 0; i < event->touch_point && i < MAX_TOUCH_POINTS; i++) {
 215                 if (event->au8_touch_event[i] == FT_TOUCH_DOWN ||
 216                         event->au8_touch_event[i] == FT_TOUCH_CONTACT) {
 217                         modified_ids |= 1 << event->au8_finger_id[i];
 218                         input_mt_slot(ts_data->input_dev, event->au8_finger_id[i]);
 219                         input_mt_report_slot_state(ts_data->input_dev, MT_TOOL_FINGER,
 220                                 true);
 221                         input_report_abs(ts_data->input_dev, ABS_MT_TOUCH_MAJOR,
 222                                         event->pressure);
 223                         input_report_abs(ts_data->input_dev, ABS_MT_POSITION_X,
 224                                         event->au16_x[i]);
 225                         input_report_abs(ts_data->input_dev, ABS_MT_POSITION_Y,
 226                                         event->au16_y[i]);
 227
 228                         if (!((1 << event->au8_finger_id[i]) & ts_data->known_ids))
 229                                 LOG_DBG("Touch id-%d: x = %d, y = %d\n",
 230                                         event->au8_finger_id[i],
 231                                         event->au16_x[i],
 232                                         event->au16_y[i]);
 233                 }
 234         }
 235
 236         released_ids = ts_data->known_ids & ~modified_ids;
 237         for (i = 0; released_ids && i < MAX_TOUCH_POINTS; i++) {
 238                 if (released_ids & (1<<i)) {
 239                         LOG_DBG("Release id-%d, known = %x modified = %x\n",
 240                                         i, ts_data->known_ids, modified_ids);
 241                         input_mt_slot(ts_data->input_dev, i);
 242                         input_mt_report_slot_state(ts_data->input_dev, MT_TOOL_FINGER, false);
 243                         modified_ids &= ~(1 << i);
 244                 }
 245         }
 246         ts_data->known_ids = modified_ids;
 247         input_mt_report_pointer_emulation(ts_data->input_dev, true);
 248         input_sync(ts_data->input_dev);
 249 }
 250
 251 static void fts_retry_clear(struct tinker_ft5406_data *ts_data)
 252 {
 253         if (ts_data->retry_count != 0)
 254                 ts_data->retry_count = 0;
 255 }
 256
 257 static int fts_retry_wait(struct tinker_ft5406_data *ts_data)
 258 {
 259         if (ts_data->retry_count < RETRY_COUNT) {
 260                 LOG_INFO("wait and retry, count = %d\n", ts_data->retry_count);
 261                 ts_data->retry_count++;
 262                 msleep(1000);
 263                 return 1;
 264         }
 265         LOG_ERR("attach retry count\n");
 266         return 0;
 267 }
 268
 269 static void tinker_ft5406_work(struct work_struct *work)
 270 {
 271         struct ts_event *event = &g_ts_data->event;
 272         int ret = 0, td_status;
 273
 274         /* polling 60fps */
 275         while (!g_ts_data->finish_work) {
 276                 td_status = fts_read_td_status(g_ts_data);
 277                 if (td_status < 0) {
 278                         ret = fts_retry_wait(g_ts_data);
 279                         if (ret == 0) {
 280                                 LOG_ERR("stop touch polling\n");
 281                                 break;
 282                         }
 283                 } else if (td_status < VALID_TD_STATUS_VAL + 1 &&
 284                         (td_status > 0 || g_ts_data->known_ids != 0)) {
 285                         fts_retry_clear(g_ts_data);
 286                         memset(event, -1, sizeof(struct ts_event));
 287                         event->touch_point = td_status;
 288                         ret = fts_read_touchdata(g_ts_data);
 289                         if (ret == 0)
 290                                 fts_report_value(g_ts_data);
 291                 }
 292                 msleep_interruptible(17);
 293         }
 294 }
 295
 296 static int tinker_ft5406_open(struct input_dev *dev)
 297 {
 298         schedule_work(&g_ts_data->ft5406_work);
 299         return 0;
 300 }
 301
 302 static void tinker_ft5406_close(struct input_dev *dev)
 303 {
 304         g_ts_data->finish_work = true;
 305         cancel_work_sync(&g_ts_data->ft5406_work);
 306         g_ts_data->finish_work = false;
 307 }
 308
 309 static int tinker_ft5406_probe(struct i2c_client *client,
 310                         const struct i2c_device_id *id)
 311 {
 312         struct input_dev *input_dev;
 313         int ret = 0;
 314
 315         LOG_INFO("address = 0x%x\n", client->addr);
 316
 317         g_ts_data = kzalloc(sizeof(struct tinker_ft5406_data), GFP_KERNEL);
 318         if (g_ts_data == NULL) {
 319                 LOG_ERR("no memory for device\n");
 320                 return -ENOMEM;
 321         }
 322
 323         g_ts_data->client = client;
 324         i2c_set_clientdata(client, g_ts_data);
 325
 326         g_ts_data->screen_width = 800;
 327         g_ts_data->screen_height = 480;
 328         g_ts_data->xy_reverse = 1;
 329
 330         LOG_INFO("width = %d, height = %d, reverse = %d\n",
 331                         g_ts_data->screen_width, g_ts_data->screen_height, g_ts_data->xy_reverse);
 332
 333         ret = fts_check_fw_ver(g_ts_data->client);
 334         if (ret) {
 335                 LOG_ERR("checking touch ic failed\n");
 336                 goto check_fw_err;
 337         }
 338
 339         input_dev = input_allocate_device();
 340         if (!input_dev) {
 341                 LOG_ERR("failed to allocate input device\n");
 342                 goto input_allocate_failed;
 343         }
 344         input_dev->name = "fts_ts";
 345         input_dev->id.bustype = BUS_I2C;
 346         input_dev->dev.parent = &g_ts_data->client->dev;
 347         input_dev->open = tinker_ft5406_open;
 348         input_dev->close = tinker_ft5406_close;
 349
 350         g_ts_data->input_dev = input_dev;
 351         input_set_drvdata(input_dev, g_ts_data);
 352
 353         __set_bit(EV_SYN, input_dev->evbit);
 354         __set_bit(EV_KEY, input_dev->evbit);
 355         __set_bit(EV_ABS, input_dev->evbit);
 356         __set_bit(BTN_TOUCH, input_dev->keybit);
 357
 358         input_mt_init_slots(input_dev, MAX_TOUCH_POINTS, 0);
 359         input_set_abs_params(input_dev, ABS_MT_POSITION_X, 0, g_ts_data->screen_width, 0, 0);
 360         input_set_abs_params(input_dev, ABS_MT_POSITION_Y, 0, g_ts_data->screen_height, 0, 0);
 361
 362         ret = input_register_device(input_dev);
 363         if (ret) {
 364                 LOG_ERR("Input device registration failed\n");
 365                 goto input_register_failed;
 366         }
 367
 368         msleep(1000);
 369
 370         INIT_WORK(&g_ts_data->ft5406_work, tinker_ft5406_work);
 371
 372         return 0;
 373
 374 input_register_failed:
 375         input_free_device(input_dev);
 376 input_allocate_failed:
 377 check_fw_err:
 378         kfree(g_ts_data);
 379         g_ts_data = NULL;
 380         return ret;
 381 }
 382
 383 static int tinker_ft5406_remove(struct i2c_client *client)
 384 {
 385         cancel_work_sync(&g_ts_data->ft5406_work);
 386         if (g_ts_data->input_dev) {
 387                 input_unregister_device(g_ts_data->input_dev);
 388                 input_free_device(g_ts_data->input_dev);
 389         }
 390         kfree(g_ts_data);
 391         g_ts_data = NULL;
 392         return 0;
 393 }
 394
 395 static const struct i2c_device_id tinker_ft5406_id[] = {
 396         {"tinker_ft5406", 0},
 397         {},
 398 };
 399
 400 static struct i2c_driver tinker_ft5406_driver = {
 401         .driver = {
 402                 .name = "tinker_ft5406",
 403         },
 404         .probe = tinker_ft5406_probe,
 405         .remove = tinker_ft5406_remove,
 406         .id_table = tinker_ft5406_id,
 407 };
 408 module_i2c_driver(tinker_ft5406_driver);
 409
 410 MODULE_DESCRIPTION("TINKER BOARD FT5406 Touch driver");
 411 MODULE_LICENSE("GPL v2");