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