drivers/input/touchscreen/goodix.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  Driver for Goodix Touchscreens
   4  *
   5  *  Copyright (c) 2014 Red Hat Inc.
   6  *  Copyright (c) 2015 K. Merker <merker@debian.org>
   7  *
   8  *  This code is based on gt9xx.c authored by andrew@goodix.com:
   9  *
  10  *  2010 - 2012 Goodix Technology.
  11  */
  12
  13
  14 #include <linux/kernel.h>
  15 #include <linux/dmi.h>
  16 #include <linux/firmware.h>
  17 #include <linux/module.h>
  18 #include <linux/delay.h>
  19 #include <linux/irq.h>
  20 #include <linux/interrupt.h>
  21 #include <linux/platform_data/x86/soc.h>
  22 #include <linux/slab.h>
  23 #include <linux/acpi.h>
  24 #include <linux/of.h>
  25 #include <asm/unaligned.h>
  26 #include "goodix.h"
  27
  28 #define GOODIX_GPIO_INT_NAME            "irq"
  29 #define GOODIX_GPIO_RST_NAME            "reset"
  30
  31 #define GOODIX_MAX_HEIGHT               4096
  32 #define GOODIX_MAX_WIDTH                4096
  33 #define GOODIX_INT_TRIGGER              1
  34 #define GOODIX_CONTACT_SIZE             8
  35 #define GOODIX_MAX_CONTACT_SIZE         9
  36 #define GOODIX_MAX_CONTACTS             10
  37
  38 #define GOODIX_CONFIG_MIN_LENGTH        186
  39 #define GOODIX_CONFIG_911_LENGTH        186
  40 #define GOODIX_CONFIG_967_LENGTH        228
  41 #define GOODIX_CONFIG_GT9X_LENGTH       240
  42
  43 #define GOODIX_BUFFER_STATUS_READY      BIT(7)
  44 #define GOODIX_HAVE_KEY                 BIT(4)
  45 #define GOODIX_BUFFER_STATUS_TIMEOUT    20
  46
  47 #define RESOLUTION_LOC          1
  48 #define MAX_CONTACTS_LOC        5
  49 #define TRIGGER_LOC             6
  50
  51 /* Our special handling for GPIO accesses through ACPI is x86 specific */
  52 #if defined CONFIG_X86 && defined CONFIG_ACPI
  53 #define ACPI_GPIO_SUPPORT
  54 #endif
  55
  56 struct goodix_chip_id {
  57         const char *id;
  58         const struct goodix_chip_data *data;
  59 };
  60
  61 static int goodix_check_cfg_8(struct goodix_ts_data *ts,
  62                               const u8 *cfg, int len);
  63 static int goodix_check_cfg_16(struct goodix_ts_data *ts,
  64                                const u8 *cfg, int len);
  65 static void goodix_calc_cfg_checksum_8(struct goodix_ts_data *ts);
  66 static void goodix_calc_cfg_checksum_16(struct goodix_ts_data *ts);
  67
  68 static const struct goodix_chip_data gt1x_chip_data = {
  69         .config_addr            = GOODIX_GT1X_REG_CONFIG_DATA,
  70         .config_len             = GOODIX_CONFIG_GT9X_LENGTH,
  71         .check_config           = goodix_check_cfg_16,
  72         .calc_config_checksum   = goodix_calc_cfg_checksum_16,
  73 };
  74
  75 static const struct goodix_chip_data gt911_chip_data = {
  76         .config_addr            = GOODIX_GT9X_REG_CONFIG_DATA,
  77         .config_len             = GOODIX_CONFIG_911_LENGTH,
  78         .check_config           = goodix_check_cfg_8,
  79         .calc_config_checksum   = goodix_calc_cfg_checksum_8,
  80 };
  81
  82 static const struct goodix_chip_data gt967_chip_data = {
  83         .config_addr            = GOODIX_GT9X_REG_CONFIG_DATA,
  84         .config_len             = GOODIX_CONFIG_967_LENGTH,
  85         .check_config           = goodix_check_cfg_8,
  86         .calc_config_checksum   = goodix_calc_cfg_checksum_8,
  87 };
  88
  89 static const struct goodix_chip_data gt9x_chip_data = {
  90         .config_addr            = GOODIX_GT9X_REG_CONFIG_DATA,
  91         .config_len             = GOODIX_CONFIG_GT9X_LENGTH,
  92         .check_config           = goodix_check_cfg_8,
  93         .calc_config_checksum   = goodix_calc_cfg_checksum_8,
  94 };
  95
  96 static const struct goodix_chip_id goodix_chip_ids[] = {
  97         { .id = "1151", .data = &gt1x_chip_data },
  98         { .id = "1158", .data = &gt1x_chip_data },
  99         { .id = "5663", .data = &gt1x_chip_data },
 100         { .id = "5688", .data = &gt1x_chip_data },
 101         { .id = "917S", .data = &gt1x_chip_data },
 102         { .id = "9286", .data = &gt1x_chip_data },
 103
 104         { .id = "911", .data = &gt911_chip_data },
 105         { .id = "9271", .data = &gt911_chip_data },
 106         { .id = "9110", .data = &gt911_chip_data },
 107         { .id = "9111", .data = &gt911_chip_data },
 108         { .id = "927", .data = &gt911_chip_data },
 109         { .id = "928", .data = &gt911_chip_data },
 110
 111         { .id = "912", .data = &gt967_chip_data },
 112         { .id = "9147", .data = &gt967_chip_data },
 113         { .id = "967", .data = &gt967_chip_data },
 114         { }
 115 };
 116
 117 static const unsigned long goodix_irq_flags[] = {
 118         IRQ_TYPE_EDGE_RISING,
 119         IRQ_TYPE_EDGE_FALLING,
 120         IRQ_TYPE_LEVEL_LOW,
 121         IRQ_TYPE_LEVEL_HIGH,
 122 };
 123
 124 static const struct dmi_system_id nine_bytes_report[] = {
 125 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
 126         {
 127                 /* Lenovo Yoga Book X90F / X90L */
 128                 .matches = {
 129                         DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Intel Corporation"),
 130                         DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "CHERRYVIEW D1 PLATFORM"),
 131                         DMI_EXACT_MATCH(DMI_PRODUCT_VERSION, "YETI-11"),
 132                 }
 133         },
 134         {
 135                 /* Lenovo Yoga Book X91F / X91L */
 136                 .matches = {
 137                         /* Non exact match to match F + L versions */
 138                         DMI_MATCH(DMI_PRODUCT_NAME, "Lenovo YB1-X91"),
 139                 }
 140         },
 141 #endif
 142         {}
 143 };
 144
 145 /*
 146  * Those tablets have their x coordinate inverted
 147  */
 148 static const struct dmi_system_id inverted_x_screen[] = {
 149 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
 150         {
 151                 .ident = "Cube I15-TC",
 152                 .matches = {
 153                         DMI_MATCH(DMI_SYS_VENDOR, "Cube"),
 154                         DMI_MATCH(DMI_PRODUCT_NAME, "I15-TC")
 155                 },
 156         },
 157 #endif
 158         {}
 159 };
 160
 161 /**
 162  * goodix_i2c_read - read data from a register of the i2c slave device.
 163  *
 164  * @client: i2c device.
 165  * @reg: the register to read from.
 166  * @buf: raw write data buffer.
 167  * @len: length of the buffer to write
 168  */
 169 int goodix_i2c_read(struct i2c_client *client, u16 reg, u8 *buf, int len)
 170 {
 171         struct i2c_msg msgs[2];
 172         __be16 wbuf = cpu_to_be16(reg);
 173         int ret;
 174
 175         msgs[0].flags = 0;
 176         msgs[0].addr  = client->addr;
 177         msgs[0].len   = 2;
 178         msgs[0].buf   = (u8 *)&wbuf;
 179
 180         msgs[1].flags = I2C_M_RD;
 181         msgs[1].addr  = client->addr;
 182         msgs[1].len   = len;
 183         msgs[1].buf   = buf;
 184
 185         ret = i2c_transfer(client->adapter, msgs, 2);
 186         if (ret >= 0)
 187                 ret = (ret == ARRAY_SIZE(msgs) ? 0 : -EIO);
 188
 189         if (ret)
 190                 dev_err(&client->dev, "Error reading %d bytes from 0x%04x: %d\n",
 191                         len, reg, ret);
 192         return ret;
 193 }
 194
 195 /**
 196  * goodix_i2c_write - write data to a register of the i2c slave device.
 197  *
 198  * @client: i2c device.
 199  * @reg: the register to write to.
 200  * @buf: raw data buffer to write.
 201  * @len: length of the buffer to write
 202  */
 203 int goodix_i2c_write(struct i2c_client *client, u16 reg, const u8 *buf, int len)
 204 {
 205         u8 *addr_buf;
 206         struct i2c_msg msg;
 207         int ret;
 208
 209         addr_buf = kmalloc(len + 2, GFP_KERNEL);
 210         if (!addr_buf)
 211                 return -ENOMEM;
 212
 213         addr_buf[0] = reg >> 8;
 214         addr_buf[1] = reg & 0xFF;
 215         memcpy(&addr_buf[2], buf, len);
 216
 217         msg.flags = 0;
 218         msg.addr = client->addr;
 219         msg.buf = addr_buf;
 220         msg.len = len + 2;
 221
 222         ret = i2c_transfer(client->adapter, &msg, 1);
 223         if (ret >= 0)
 224                 ret = (ret == 1 ? 0 : -EIO);
 225
 226         kfree(addr_buf);
 227
 228         if (ret)
 229                 dev_err(&client->dev, "Error writing %d bytes to 0x%04x: %d\n",
 230                         len, reg, ret);
 231         return ret;
 232 }
 233
 234 int goodix_i2c_write_u8(struct i2c_client *client, u16 reg, u8 value)
 235 {
 236         return goodix_i2c_write(client, reg, &value, sizeof(value));
 237 }
 238
 239 static const struct goodix_chip_data *goodix_get_chip_data(const char *id)
 240 {
 241         unsigned int i;
 242
 243         for (i = 0; goodix_chip_ids[i].id; i++) {
 244                 if (!strcmp(goodix_chip_ids[i].id, id))
 245                         return goodix_chip_ids[i].data;
 246         }
 247
 248         return &gt9x_chip_data;
 249 }
 250
 251 static int goodix_ts_read_input_report(struct goodix_ts_data *ts, u8 *data)
 252 {
 253         unsigned long max_timeout;
 254         int touch_num;
 255         int error;
 256         u16 addr = GOODIX_READ_COOR_ADDR;
 257         /*
 258          * We are going to read 1-byte header,
 259          * ts->contact_size * max(1, touch_num) bytes of coordinates
 260          * and 1-byte footer which contains the touch-key code.
 261          */
 262         const int header_contact_keycode_size = 1 + ts->contact_size + 1;
 263
 264         /*
 265          * The 'buffer status' bit, which indicates that the data is valid, is
 266          * not set as soon as the interrupt is raised, but slightly after.
 267          * This takes around 10 ms to happen, so we poll for 20 ms.
 268          */
 269         max_timeout = jiffies + msecs_to_jiffies(GOODIX_BUFFER_STATUS_TIMEOUT);
 270         do {
 271                 error = goodix_i2c_read(ts->client, addr, data,
 272                                         header_contact_keycode_size);
 273                 if (error)
 274                         return error;
 275
 276                 if (data[0] & GOODIX_BUFFER_STATUS_READY) {
 277                         touch_num = data[0] & 0x0f;
 278                         if (touch_num > ts->max_touch_num)
 279                                 return -EPROTO;
 280
 281                         if (touch_num > 1) {
 282                                 addr += header_contact_keycode_size;
 283                                 data += header_contact_keycode_size;
 284                                 error = goodix_i2c_read(ts->client,
 285                                                 addr, data,
 286                                                 ts->contact_size *
 287                                                         (touch_num - 1));
 288                                 if (error)
 289                                         return error;
 290                         }
 291
 292                         return touch_num;
 293                 }
 294
 295                 if (data[0] == 0 && ts->firmware_name) {
 296                         if (goodix_handle_fw_request(ts))
 297                                 return 0;
 298                 }
 299
 300                 usleep_range(1000, 2000); /* Poll every 1 - 2 ms */
 301         } while (time_before(jiffies, max_timeout));
 302
 303         /*
 304          * The Goodix panel will send spurious interrupts after a
 305          * 'finger up' event, which will always cause a timeout.
 306          */
 307         return -ENOMSG;
 308 }
 309
 310 static int goodix_create_pen_input(struct goodix_ts_data *ts)
 311 {
 312         struct device *dev = &ts->client->dev;
 313         struct input_dev *input;
 314
 315         input = devm_input_allocate_device(dev);
 316         if (!input)
 317                 return -ENOMEM;
 318
 319         input_copy_abs(input, ABS_X, ts->input_dev, ABS_MT_POSITION_X);
 320         input_copy_abs(input, ABS_Y, ts->input_dev, ABS_MT_POSITION_Y);
 321         /*
 322          * The resolution of these touchscreens is about 10 units/mm, the actual
 323          * resolution does not matter much since we set INPUT_PROP_DIRECT.
 324          * Userspace wants something here though, so just set it to 10 units/mm.
 325          */
 326         input_abs_set_res(input, ABS_X, 10);
 327         input_abs_set_res(input, ABS_Y, 10);
 328         input_set_abs_params(input, ABS_PRESSURE, 0, 255, 0, 0);
 329
 330         input_set_capability(input, EV_KEY, BTN_TOUCH);
 331         input_set_capability(input, EV_KEY, BTN_TOOL_PEN);
 332         input_set_capability(input, EV_KEY, BTN_STYLUS);
 333         input_set_capability(input, EV_KEY, BTN_STYLUS2);
 334         __set_bit(INPUT_PROP_DIRECT, input->propbit);
 335
 336         input->name = "Goodix Active Pen";
 337         input->phys = "input/pen";
 338         input->id.bustype = BUS_I2C;
 339         input->id.vendor = 0x0416;
 340         if (kstrtou16(ts->id, 10, &input->id.product))
 341                 input->id.product = 0x1001;
 342         input->id.version = ts->version;
 343
 344         ts->input_pen = input;
 345         return 0;
 346 }
 347
 348 static void goodix_ts_report_pen_down(struct goodix_ts_data *ts, u8 *data)
 349 {
 350         int input_x, input_y, input_w, error;
 351         u8 key_value;
 352
 353         if (!ts->pen_input_registered) {
 354                 error = input_register_device(ts->input_pen);
 355                 ts->pen_input_registered = (error == 0) ? 1 : error;
 356         }
 357
 358         if (ts->pen_input_registered < 0)
 359                 return;
 360
 361         if (ts->contact_size == 9) {
 362                 input_x = get_unaligned_le16(&data[4]);
 363                 input_y = get_unaligned_le16(&data[6]);
 364                 input_w = get_unaligned_le16(&data[8]);
 365         } else {
 366                 input_x = get_unaligned_le16(&data[2]);
 367                 input_y = get_unaligned_le16(&data[4]);
 368                 input_w = get_unaligned_le16(&data[6]);
 369         }
 370
 371         touchscreen_report_pos(ts->input_pen, &ts->prop, input_x, input_y, false);
 372         input_report_abs(ts->input_pen, ABS_PRESSURE, input_w);
 373
 374         input_report_key(ts->input_pen, BTN_TOUCH, 1);
 375         input_report_key(ts->input_pen, BTN_TOOL_PEN, 1);
 376
 377         if (data[0] & GOODIX_HAVE_KEY) {
 378                 key_value = data[1 + ts->contact_size];
 379                 input_report_key(ts->input_pen, BTN_STYLUS, key_value & 0x10);
 380                 input_report_key(ts->input_pen, BTN_STYLUS2, key_value & 0x20);
 381         } else {
 382                 input_report_key(ts->input_pen, BTN_STYLUS, 0);
 383                 input_report_key(ts->input_pen, BTN_STYLUS2, 0);
 384         }
 385
 386         input_sync(ts->input_pen);
 387 }
 388
 389 static void goodix_ts_report_pen_up(struct goodix_ts_data *ts)
 390 {
 391         if (!ts->input_pen)
 392                 return;
 393
 394         input_report_key(ts->input_pen, BTN_TOUCH, 0);
 395         input_report_key(ts->input_pen, BTN_TOOL_PEN, 0);
 396         input_report_key(ts->input_pen, BTN_STYLUS, 0);
 397         input_report_key(ts->input_pen, BTN_STYLUS2, 0);
 398
 399         input_sync(ts->input_pen);
 400 }
 401
 402 static void goodix_ts_report_touch_8b(struct goodix_ts_data *ts, u8 *coor_data)
 403 {
 404         int id = coor_data[0] & 0x0F;
 405         int input_x = get_unaligned_le16(&coor_data[1]);
 406         int input_y = get_unaligned_le16(&coor_data[3]);
 407         int input_w = get_unaligned_le16(&coor_data[5]);
 408
 409         input_mt_slot(ts->input_dev, id);
 410         input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true);
 411         touchscreen_report_pos(ts->input_dev, &ts->prop,
 412                                input_x, input_y, true);
 413         input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w);
 414         input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w);
 415 }
 416
 417 static void goodix_ts_report_touch_9b(struct goodix_ts_data *ts, u8 *coor_data)
 418 {
 419         int id = coor_data[1] & 0x0F;
 420         int input_x = get_unaligned_le16(&coor_data[3]);
 421         int input_y = get_unaligned_le16(&coor_data[5]);
 422         int input_w = get_unaligned_le16(&coor_data[7]);
 423
 424         input_mt_slot(ts->input_dev, id);
 425         input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true);
 426         touchscreen_report_pos(ts->input_dev, &ts->prop,
 427                                input_x, input_y, true);
 428         input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w);
 429         input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w);
 430 }
 431
 432 static void goodix_ts_release_keys(struct goodix_ts_data *ts)
 433 {
 434         int i;
 435
 436         for (i = 0; i < GOODIX_MAX_KEYS; i++)
 437                 input_report_key(ts->input_dev, ts->keymap[i], 0);
 438 }
 439
 440 static void goodix_ts_report_key(struct goodix_ts_data *ts, u8 *data)
 441 {
 442         int touch_num;
 443         u8 key_value;
 444         int i;
 445
 446         if (data[0] & GOODIX_HAVE_KEY) {
 447                 touch_num = data[0] & 0x0f;
 448                 key_value = data[1 + ts->contact_size * touch_num];
 449                 for (i = 0; i < GOODIX_MAX_KEYS; i++)
 450                         if (key_value & BIT(i))
 451                                 input_report_key(ts->input_dev,
 452                                                  ts->keymap[i], 1);
 453         } else {
 454                 goodix_ts_release_keys(ts);
 455         }
 456 }
 457
 458 /**
 459  * goodix_process_events - Process incoming events
 460  *
 461  * @ts: our goodix_ts_data pointer
 462  *
 463  * Called when the IRQ is triggered. Read the current device state, and push
 464  * the input events to the user space.
 465  */
 466 static void goodix_process_events(struct goodix_ts_data *ts)
 467 {
 468         u8  point_data[2 + GOODIX_MAX_CONTACT_SIZE * GOODIX_MAX_CONTACTS];
 469         int touch_num;
 470         int i;
 471
 472         touch_num = goodix_ts_read_input_report(ts, point_data);
 473         if (touch_num < 0)
 474                 return;
 475
 476         /* The pen being down is always reported as a single touch */
 477         if (touch_num == 1 && (point_data[1] & 0x80)) {
 478                 goodix_ts_report_pen_down(ts, point_data);
 479                 goodix_ts_release_keys(ts);
 480                 goto sync; /* Release any previously registered touches */
 481         } else {
 482                 goodix_ts_report_pen_up(ts);
 483         }
 484
 485         goodix_ts_report_key(ts, point_data);
 486
 487         for (i = 0; i < touch_num; i++)
 488                 if (ts->contact_size == 9)
 489                         goodix_ts_report_touch_9b(ts,
 490                                 &point_data[1 + ts->contact_size * i]);
 491                 else
 492                         goodix_ts_report_touch_8b(ts,
 493                                 &point_data[1 + ts->contact_size * i]);
 494
 495 sync:
 496         input_mt_sync_frame(ts->input_dev);
 497         input_sync(ts->input_dev);
 498 }
 499
 500 /**
 501  * goodix_ts_irq_handler - The IRQ handler
 502  *
 503  * @irq: interrupt number.
 504  * @dev_id: private data pointer.
 505  */
 506 static irqreturn_t goodix_ts_irq_handler(int irq, void *dev_id)
 507 {
 508         struct goodix_ts_data *ts = dev_id;
 509
 510         goodix_process_events(ts);
 511         goodix_i2c_write_u8(ts->client, GOODIX_READ_COOR_ADDR, 0);
 512
 513         return IRQ_HANDLED;
 514 }
 515
 516 static void goodix_free_irq(struct goodix_ts_data *ts)
 517 {
 518         devm_free_irq(&ts->client->dev, ts->client->irq, ts);
 519 }
 520
 521 static int goodix_request_irq(struct goodix_ts_data *ts)
 522 {
 523         return devm_request_threaded_irq(&ts->client->dev, ts->client->irq,
 524                                          NULL, goodix_ts_irq_handler,
 525                                          ts->irq_flags, ts->client->name, ts);
 526 }
 527
 528 static int goodix_check_cfg_8(struct goodix_ts_data *ts, const u8 *cfg, int len)
 529 {
 530         int i, raw_cfg_len = len - 2;
 531         u8 check_sum = 0;
 532
 533         for (i = 0; i < raw_cfg_len; i++)
 534                 check_sum += cfg[i];
 535         check_sum = (~check_sum) + 1;
 536         if (check_sum != cfg[raw_cfg_len]) {
 537                 dev_err(&ts->client->dev,
 538                         "The checksum of the config fw is not correct");
 539                 return -EINVAL;
 540         }
 541
 542         if (cfg[raw_cfg_len + 1] != 1) {
 543                 dev_err(&ts->client->dev,
 544                         "Config fw must have Config_Fresh register set");
 545                 return -EINVAL;
 546         }
 547
 548         return 0;
 549 }
 550
 551 static void goodix_calc_cfg_checksum_8(struct goodix_ts_data *ts)
 552 {
 553         int i, raw_cfg_len = ts->chip->config_len - 2;
 554         u8 check_sum = 0;
 555
 556         for (i = 0; i < raw_cfg_len; i++)
 557                 check_sum += ts->config[i];
 558         check_sum = (~check_sum) + 1;
 559
 560         ts->config[raw_cfg_len] = check_sum;
 561         ts->config[raw_cfg_len + 1] = 1; /* Set "config_fresh" bit */
 562 }
 563
 564 static int goodix_check_cfg_16(struct goodix_ts_data *ts, const u8 *cfg,
 565                                int len)
 566 {
 567         int i, raw_cfg_len = len - 3;
 568         u16 check_sum = 0;
 569
 570         for (i = 0; i < raw_cfg_len; i += 2)
 571                 check_sum += get_unaligned_be16(&cfg[i]);
 572         check_sum = (~check_sum) + 1;
 573         if (check_sum != get_unaligned_be16(&cfg[raw_cfg_len])) {
 574                 dev_err(&ts->client->dev,
 575                         "The checksum of the config fw is not correct");
 576                 return -EINVAL;
 577         }
 578
 579         if (cfg[raw_cfg_len + 2] != 1) {
 580                 dev_err(&ts->client->dev,
 581                         "Config fw must have Config_Fresh register set");
 582                 return -EINVAL;
 583         }
 584
 585         return 0;
 586 }
 587
 588 static void goodix_calc_cfg_checksum_16(struct goodix_ts_data *ts)
 589 {
 590         int i, raw_cfg_len = ts->chip->config_len - 3;
 591         u16 check_sum = 0;
 592
 593         for (i = 0; i < raw_cfg_len; i += 2)
 594                 check_sum += get_unaligned_be16(&ts->config[i]);
 595         check_sum = (~check_sum) + 1;
 596
 597         put_unaligned_be16(check_sum, &ts->config[raw_cfg_len]);
 598         ts->config[raw_cfg_len + 2] = 1; /* Set "config_fresh" bit */
 599 }
 600
 601 /**
 602  * goodix_check_cfg - Checks if config fw is valid
 603  *
 604  * @ts: goodix_ts_data pointer
 605  * @cfg: firmware config data
 606  * @len: config data length
 607  */
 608 static int goodix_check_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len)
 609 {
 610         if (len < GOODIX_CONFIG_MIN_LENGTH ||
 611             len > GOODIX_CONFIG_MAX_LENGTH) {
 612                 dev_err(&ts->client->dev,
 613                         "The length of the config fw is not correct");
 614                 return -EINVAL;
 615         }
 616
 617         return ts->chip->check_config(ts, cfg, len);
 618 }
 619
 620 /**
 621  * goodix_send_cfg - Write fw config to device
 622  *
 623  * @ts: goodix_ts_data pointer
 624  * @cfg: config firmware to write to device
 625  * @len: config data length
 626  */
 627 int goodix_send_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len)
 628 {
 629         int error;
 630
 631         error = goodix_check_cfg(ts, cfg, len);
 632         if (error)
 633                 return error;
 634
 635         error = goodix_i2c_write(ts->client, ts->chip->config_addr, cfg, len);
 636         if (error)
 637                 return error;
 638
 639         dev_dbg(&ts->client->dev, "Config sent successfully.");
 640
 641         /* Let the firmware reconfigure itself, so sleep for 10ms */
 642         usleep_range(10000, 11000);
 643
 644         return 0;
 645 }
 646
 647 #ifdef ACPI_GPIO_SUPPORT
 648 static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts)
 649 {
 650         acpi_handle handle = ACPI_HANDLE(&ts->client->dev);
 651         acpi_status status;
 652
 653         status = acpi_evaluate_object(handle, "INTI", NULL, NULL);
 654         return ACPI_SUCCESS(status) ? 0 : -EIO;
 655 }
 656
 657 static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value)
 658 {
 659         acpi_handle handle = ACPI_HANDLE(&ts->client->dev);
 660         acpi_status status;
 661
 662         status = acpi_execute_simple_method(handle, "INTO", value);
 663         return ACPI_SUCCESS(status) ? 0 : -EIO;
 664 }
 665 #else
 666 static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts)
 667 {
 668         dev_err(&ts->client->dev,
 669                 "%s called on device without ACPI support\n", __func__);
 670         return -EINVAL;
 671 }
 672
 673 static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value)
 674 {
 675         dev_err(&ts->client->dev,
 676                 "%s called on device without ACPI support\n", __func__);
 677         return -EINVAL;
 678 }
 679 #endif
 680
 681 static int goodix_irq_direction_output(struct goodix_ts_data *ts, int value)
 682 {
 683         switch (ts->irq_pin_access_method) {
 684         case IRQ_PIN_ACCESS_NONE:
 685                 dev_err(&ts->client->dev,
 686                         "%s called without an irq_pin_access_method set\n",
 687                         __func__);
 688                 return -EINVAL;
 689         case IRQ_PIN_ACCESS_GPIO:
 690                 return gpiod_direction_output(ts->gpiod_int, value);
 691         case IRQ_PIN_ACCESS_ACPI_GPIO:
 692                 /*
 693                  * The IRQ pin triggers on a falling edge, so its gets marked
 694                  * as active-low, use output_raw to avoid the value inversion.
 695                  */
 696                 return gpiod_direction_output_raw(ts->gpiod_int, value);
 697         case IRQ_PIN_ACCESS_ACPI_METHOD:
 698                 return goodix_pin_acpi_output_method(ts, value);
 699         }
 700
 701         return -EINVAL; /* Never reached */
 702 }
 703
 704 static int goodix_irq_direction_input(struct goodix_ts_data *ts)
 705 {
 706         switch (ts->irq_pin_access_method) {
 707         case IRQ_PIN_ACCESS_NONE:
 708                 dev_err(&ts->client->dev,
 709                         "%s called without an irq_pin_access_method set\n",
 710                         __func__);
 711                 return -EINVAL;
 712         case IRQ_PIN_ACCESS_GPIO:
 713                 return gpiod_direction_input(ts->gpiod_int);
 714         case IRQ_PIN_ACCESS_ACPI_GPIO:
 715                 return gpiod_direction_input(ts->gpiod_int);
 716         case IRQ_PIN_ACCESS_ACPI_METHOD:
 717                 return goodix_pin_acpi_direction_input(ts);
 718         }
 719
 720         return -EINVAL; /* Never reached */
 721 }
 722
 723 int goodix_int_sync(struct goodix_ts_data *ts)
 724 {
 725         int error;
 726
 727         error = goodix_irq_direction_output(ts, 0);
 728         if (error)
 729                 goto error;
 730
 731         msleep(50);                             /* T5: 50ms */
 732
 733         error = goodix_irq_direction_input(ts);
 734         if (error)
 735                 goto error;
 736
 737         return 0;
 738
 739 error:
 740         dev_err(&ts->client->dev, "Controller irq sync failed.\n");
 741         return error;
 742 }
 743
 744 /**
 745  * goodix_reset_no_int_sync - Reset device, leaving interrupt line in output mode
 746  *
 747  * @ts: goodix_ts_data pointer
 748  */
 749 int goodix_reset_no_int_sync(struct goodix_ts_data *ts)
 750 {
 751         int error;
 752
 753         /* begin select I2C slave addr */
 754         error = gpiod_direction_output(ts->gpiod_rst, 0);
 755         if (error)
 756                 goto error;
 757
 758         msleep(20);                             /* T2: > 10ms */
 759
 760         /* HIGH: 0x28/0x29, LOW: 0xBA/0xBB */
 761         error = goodix_irq_direction_output(ts, ts->client->addr == 0x14);
 762         if (error)
 763                 goto error;
 764
 765         usleep_range(100, 2000);                /* T3: > 100us */
 766
 767         error = gpiod_direction_output(ts->gpiod_rst, 1);
 768         if (error)
 769                 goto error;
 770
 771         usleep_range(6000, 10000);              /* T4: > 5ms */
 772
 773         /*
 774          * Put the reset pin back in to input / high-impedance mode to save
 775          * power. Only do this in the non ACPI case since some ACPI boards
 776          * don't have a pull-up, so there the reset pin must stay active-high.
 777          */
 778         if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_GPIO) {
 779                 error = gpiod_direction_input(ts->gpiod_rst);
 780                 if (error)
 781                         goto error;
 782         }
 783
 784         return 0;
 785
 786 error:
 787         dev_err(&ts->client->dev, "Controller reset failed.\n");
 788         return error;
 789 }
 790
 791 /**
 792  * goodix_reset - Reset device during power on
 793  *
 794  * @ts: goodix_ts_data pointer
 795  */
 796 static int goodix_reset(struct goodix_ts_data *ts)
 797 {
 798         int error;
 799
 800         error = goodix_reset_no_int_sync(ts);
 801         if (error)
 802                 return error;
 803
 804         return goodix_int_sync(ts);
 805 }
 806
 807 #ifdef ACPI_GPIO_SUPPORT
 808 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
 809 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
 810
 811 static const struct acpi_gpio_mapping acpi_goodix_int_first_gpios[] = {
 812         { GOODIX_GPIO_INT_NAME "-gpios", &first_gpio, 1 },
 813         { GOODIX_GPIO_RST_NAME "-gpios", &second_gpio, 1 },
 814         { },
 815 };
 816
 817 static const struct acpi_gpio_mapping acpi_goodix_int_last_gpios[] = {
 818         { GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 },
 819         { GOODIX_GPIO_INT_NAME "-gpios", &second_gpio, 1 },
 820         { },
 821 };
 822
 823 static const struct acpi_gpio_mapping acpi_goodix_reset_only_gpios[] = {
 824         { GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 },
 825         { },
 826 };
 827
 828 static int goodix_resource(struct acpi_resource *ares, void *data)
 829 {
 830         struct goodix_ts_data *ts = data;
 831         struct device *dev = &ts->client->dev;
 832         struct acpi_resource_gpio *gpio;
 833
 834         if (acpi_gpio_get_irq_resource(ares, &gpio)) {
 835                 if (ts->gpio_int_idx == -1) {
 836                         ts->gpio_int_idx = ts->gpio_count;
 837                 } else {
 838                         dev_err(dev, "More then one GpioInt resource, ignoring ACPI GPIO resources\n");
 839                         ts->gpio_int_idx = -2;
 840                 }
 841                 ts->gpio_count++;
 842         } else if (acpi_gpio_get_io_resource(ares, &gpio))
 843                 ts->gpio_count++;
 844
 845         return 0;
 846 }
 847
 848 /*
 849  * This function gets called in case we fail to get the irq GPIO directly
 850  * because the ACPI tables lack GPIO-name to APCI _CRS index mappings
 851  * (no _DSD UUID daffd814-6eba-4d8c-8a91-bc9bbf4aa301 data).
 852  * In that case we add our own mapping and then goodix_get_gpio_config()
 853  * retries to get the GPIOs based on the added mapping.
 854  */
 855 static int goodix_add_acpi_gpio_mappings(struct goodix_ts_data *ts)
 856 {
 857         const struct acpi_gpio_mapping *gpio_mapping = NULL;
 858         struct device *dev = &ts->client->dev;
 859         LIST_HEAD(resources);
 860         int irq, ret;
 861
 862         ts->gpio_count = 0;
 863         ts->gpio_int_idx = -1;
 864         ret = acpi_dev_get_resources(ACPI_COMPANION(dev), &resources,
 865                                      goodix_resource, ts);
 866         if (ret < 0) {
 867                 dev_err(dev, "Error getting ACPI resources: %d\n", ret);
 868                 return ret;
 869         }
 870
 871         acpi_dev_free_resource_list(&resources);
 872
 873         /*
 874          * CHT devices should have a GpioInt + a regular GPIO ACPI resource.
 875          * Some CHT devices have a bug (where the also is bogus Interrupt
 876          * resource copied from a previous BYT based generation). i2c-core-acpi
 877          * will use the non-working Interrupt resource, fix this up.
 878          */
 879         if (soc_intel_is_cht() && ts->gpio_count == 2 && ts->gpio_int_idx != -1) {
 880                 irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0);
 881                 if (irq > 0 && irq != ts->client->irq) {
 882                         dev_warn(dev, "Overriding IRQ %d -> %d\n", ts->client->irq, irq);
 883                         ts->client->irq = irq;
 884                 }
 885         }
 886
 887         if (ts->gpio_count == 2 && ts->gpio_int_idx == 0) {
 888                 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
 889                 gpio_mapping = acpi_goodix_int_first_gpios;
 890         } else if (ts->gpio_count == 2 && ts->gpio_int_idx == 1) {
 891                 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
 892                 gpio_mapping = acpi_goodix_int_last_gpios;
 893         } else if (ts->gpio_count == 1 && ts->gpio_int_idx == -1 &&
 894                    acpi_has_method(ACPI_HANDLE(dev), "INTI") &&
 895                    acpi_has_method(ACPI_HANDLE(dev), "INTO")) {
 896                 dev_info(dev, "Using ACPI INTI and INTO methods for IRQ pin access\n");
 897                 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_METHOD;
 898                 gpio_mapping = acpi_goodix_reset_only_gpios;
 899         } else if (soc_intel_is_byt() && ts->gpio_count == 2 && ts->gpio_int_idx == -1) {
 900                 dev_info(dev, "No ACPI GpioInt resource, assuming that the GPIO order is reset, int\n");
 901                 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
 902                 gpio_mapping = acpi_goodix_int_last_gpios;
 903         } else {
 904                 dev_warn(dev, "Unexpected ACPI resources: gpio_count %d, gpio_int_idx %d\n",
 905                          ts->gpio_count, ts->gpio_int_idx);
 906                 /*
 907                  * On some devices _PS0 does a reset for us and
 908                  * sometimes this is necessary for things to work.
 909                  */
 910                 acpi_device_fix_up_power(ACPI_COMPANION(dev));
 911                 return -EINVAL;
 912         }
 913
 914         /*
 915          * Normally we put the reset pin in input / high-impedance mode to save
 916          * power. But some x86/ACPI boards don't have a pull-up, so for the ACPI
 917          * case, leave the pin as is. This results in the pin not being touched
 918          * at all on x86/ACPI boards, except when needed for error-recover.
 919          */
 920         ts->gpiod_rst_flags = GPIOD_ASIS;
 921
 922         return devm_acpi_dev_add_driver_gpios(dev, gpio_mapping);
 923 }
 924 #else
 925 static int goodix_add_acpi_gpio_mappings(struct goodix_ts_data *ts)
 926 {
 927         return -EINVAL;
 928 }
 929 #endif /* CONFIG_X86 && CONFIG_ACPI */
 930
 931 /**
 932  * goodix_get_gpio_config - Get GPIO config from ACPI/DT
 933  *
 934  * @ts: goodix_ts_data pointer
 935  */
 936 static int goodix_get_gpio_config(struct goodix_ts_data *ts)
 937 {
 938         int error;
 939         struct device *dev;
 940         struct gpio_desc *gpiod;
 941         bool added_acpi_mappings = false;
 942
 943         if (!ts->client)
 944                 return -EINVAL;
 945         dev = &ts->client->dev;
 946
 947         /*
 948          * By default we request the reset pin as input, leaving it in
 949          * high-impedance when not resetting the controller to save power.
 950          */
 951         ts->gpiod_rst_flags = GPIOD_IN;
 952
 953         ts->avdd28 = devm_regulator_get(dev, "AVDD28");
 954         if (IS_ERR(ts->avdd28)) {
 955                 error = PTR_ERR(ts->avdd28);
 956                 if (error != -EPROBE_DEFER)
 957                         dev_err(dev,
 958                                 "Failed to get AVDD28 regulator: %d\n", error);
 959                 return error;
 960         }
 961
 962         ts->vddio = devm_regulator_get(dev, "VDDIO");
 963         if (IS_ERR(ts->vddio)) {
 964                 error = PTR_ERR(ts->vddio);
 965                 if (error != -EPROBE_DEFER)
 966                         dev_err(dev,
 967                                 "Failed to get VDDIO regulator: %d\n", error);
 968                 return error;
 969         }
 970
 971 retry_get_irq_gpio:
 972         /* Get the interrupt GPIO pin number */
 973         gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_INT_NAME, GPIOD_IN);
 974         if (IS_ERR(gpiod)) {
 975                 error = PTR_ERR(gpiod);
 976                 if (error != -EPROBE_DEFER)
 977                         dev_err(dev, "Failed to get %s GPIO: %d\n",
 978                                 GOODIX_GPIO_INT_NAME, error);
 979                 return error;
 980         }
 981         if (!gpiod && has_acpi_companion(dev) && !added_acpi_mappings) {
 982                 added_acpi_mappings = true;
 983                 if (goodix_add_acpi_gpio_mappings(ts) == 0)
 984                         goto retry_get_irq_gpio;
 985         }
 986
 987         ts->gpiod_int = gpiod;
 988
 989         /* Get the reset line GPIO pin number */
 990         gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_RST_NAME, ts->gpiod_rst_flags);
 991         if (IS_ERR(gpiod)) {
 992                 error = PTR_ERR(gpiod);
 993                 if (error != -EPROBE_DEFER)
 994                         dev_err(dev, "Failed to get %s GPIO: %d\n",
 995                                 GOODIX_GPIO_RST_NAME, error);
 996                 return error;
 997         }
 998
 999         ts->gpiod_rst = gpiod;
1000
1001         switch (ts->irq_pin_access_method) {
1002         case IRQ_PIN_ACCESS_ACPI_GPIO:
1003                 /*
1004                  * We end up here if goodix_add_acpi_gpio_mappings() has
1005                  * called devm_acpi_dev_add_driver_gpios() because the ACPI
1006                  * tables did not contain name to index mappings.
1007                  * Check that we successfully got both GPIOs after we've
1008                  * added our own acpi_gpio_mapping and if we did not get both
1009                  * GPIOs reset irq_pin_access_method to IRQ_PIN_ACCESS_NONE.
1010                  */
1011                 if (!ts->gpiod_int || !ts->gpiod_rst)
1012                         ts->irq_pin_access_method = IRQ_PIN_ACCESS_NONE;
1013                 break;
1014         case IRQ_PIN_ACCESS_ACPI_METHOD:
1015                 if (!ts->gpiod_rst)
1016                         ts->irq_pin_access_method = IRQ_PIN_ACCESS_NONE;
1017                 break;
1018         default:
1019                 if (ts->gpiod_int && ts->gpiod_rst) {
1020                         ts->reset_controller_at_probe = true;
1021                         ts->load_cfg_from_disk = true;
1022                         ts->irq_pin_access_method = IRQ_PIN_ACCESS_GPIO;
1023                 }
1024         }
1025
1026         return 0;
1027 }
1028
1029 /**
1030  * goodix_read_config - Read the embedded configuration of the panel
1031  *
1032  * @ts: our goodix_ts_data pointer
1033  *
1034  * Must be called during probe
1035  */
1036 static void goodix_read_config(struct goodix_ts_data *ts)
1037 {
1038         int x_max, y_max;
1039         int error;
1040
1041         /*
1042          * On controllers where we need to upload the firmware
1043          * (controllers without flash) ts->config already has the config
1044          * at this point and the controller itself does not have it yet!
1045          */
1046         if (!ts->firmware_name) {
1047                 error = goodix_i2c_read(ts->client, ts->chip->config_addr,
1048                                         ts->config, ts->chip->config_len);
1049                 if (error) {
1050                         ts->int_trigger_type = GOODIX_INT_TRIGGER;
1051                         ts->max_touch_num = GOODIX_MAX_CONTACTS;
1052                         return;
1053                 }
1054         }
1055
1056         ts->int_trigger_type = ts->config[TRIGGER_LOC] & 0x03;
1057         ts->max_touch_num = ts->config[MAX_CONTACTS_LOC] & 0x0f;
1058
1059         x_max = get_unaligned_le16(&ts->config[RESOLUTION_LOC]);
1060         y_max = get_unaligned_le16(&ts->config[RESOLUTION_LOC + 2]);
1061         if (x_max && y_max) {
1062                 input_abs_set_max(ts->input_dev, ABS_MT_POSITION_X, x_max - 1);
1063                 input_abs_set_max(ts->input_dev, ABS_MT_POSITION_Y, y_max - 1);
1064         }
1065
1066         ts->chip->calc_config_checksum(ts);
1067 }
1068
1069 /**
1070  * goodix_read_version - Read goodix touchscreen version
1071  *
1072  * @ts: our goodix_ts_data pointer
1073  */
1074 static int goodix_read_version(struct goodix_ts_data *ts)
1075 {
1076         int error;
1077         u8 buf[6];
1078         char id_str[GOODIX_ID_MAX_LEN + 1];
1079
1080         error = goodix_i2c_read(ts->client, GOODIX_REG_ID, buf, sizeof(buf));
1081         if (error)
1082                 return error;
1083
1084         memcpy(id_str, buf, GOODIX_ID_MAX_LEN);
1085         id_str[GOODIX_ID_MAX_LEN] = 0;
1086         strscpy(ts->id, id_str, GOODIX_ID_MAX_LEN + 1);
1087
1088         ts->version = get_unaligned_le16(&buf[4]);
1089
1090         dev_info(&ts->client->dev, "ID %s, version: %04x\n", ts->id,
1091                  ts->version);
1092
1093         return 0;
1094 }
1095
1096 /**
1097  * goodix_i2c_test - I2C test function to check if the device answers.
1098  *
1099  * @client: the i2c client
1100  */
1101 static int goodix_i2c_test(struct i2c_client *client)
1102 {
1103         int retry = 0;
1104         int error;
1105         u8 test;
1106
1107         while (retry++ < 2) {
1108                 error = goodix_i2c_read(client, GOODIX_REG_ID, &test, 1);
1109                 if (!error)
1110                         return 0;
1111
1112                 msleep(20);
1113         }
1114
1115         return error;
1116 }
1117
1118 /**
1119  * goodix_configure_dev - Finish device initialization
1120  *
1121  * @ts: our goodix_ts_data pointer
1122  *
1123  * Must be called from probe to finish initialization of the device.
1124  * Contains the common initialization code for both devices that
1125  * declare gpio pins and devices that do not. It is either called
1126  * directly from probe or from request_firmware_wait callback.
1127  */
1128 static int goodix_configure_dev(struct goodix_ts_data *ts)
1129 {
1130         int error;
1131         int i;
1132
1133         ts->int_trigger_type = GOODIX_INT_TRIGGER;
1134         ts->max_touch_num = GOODIX_MAX_CONTACTS;
1135
1136         ts->input_dev = devm_input_allocate_device(&ts->client->dev);
1137         if (!ts->input_dev) {
1138                 dev_err(&ts->client->dev, "Failed to allocate input device.");
1139                 return -ENOMEM;
1140         }
1141
1142         ts->input_dev->name = "Goodix Capacitive TouchScreen";
1143         ts->input_dev->phys = "input/ts";
1144         ts->input_dev->id.bustype = BUS_I2C;
1145         ts->input_dev->id.vendor = 0x0416;
1146         if (kstrtou16(ts->id, 10, &ts->input_dev->id.product))
1147                 ts->input_dev->id.product = 0x1001;
1148         ts->input_dev->id.version = ts->version;
1149
1150         ts->input_dev->keycode = ts->keymap;
1151         ts->input_dev->keycodesize = sizeof(ts->keymap[0]);
1152         ts->input_dev->keycodemax = GOODIX_MAX_KEYS;
1153
1154         /* Capacitive Windows/Home button on some devices */
1155         for (i = 0; i < GOODIX_MAX_KEYS; ++i) {
1156                 if (i == 0)
1157                         ts->keymap[i] = KEY_LEFTMETA;
1158                 else
1159                         ts->keymap[i] = KEY_F1 + (i - 1);
1160
1161                 input_set_capability(ts->input_dev, EV_KEY, ts->keymap[i]);
1162         }
1163
1164         input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_X);
1165         input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_Y);
1166         input_set_abs_params(ts->input_dev, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0);
1167         input_set_abs_params(ts->input_dev, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
1168
1169 retry_read_config:
1170         /* Read configuration and apply touchscreen parameters */
1171         goodix_read_config(ts);
1172
1173         /* Try overriding touchscreen parameters via device properties */
1174         touchscreen_parse_properties(ts->input_dev, true, &ts->prop);
1175
1176         if (!ts->prop.max_x || !ts->prop.max_y || !ts->max_touch_num) {
1177                 if (!ts->reset_controller_at_probe &&
1178                     ts->irq_pin_access_method != IRQ_PIN_ACCESS_NONE) {
1179                         dev_info(&ts->client->dev, "Config not set, resetting controller\n");
1180                         /* Retry after a controller reset */
1181                         ts->reset_controller_at_probe = true;
1182                         error = goodix_reset(ts);
1183                         if (error)
1184                                 return error;
1185                         goto retry_read_config;
1186                 }
1187                 dev_err(&ts->client->dev,
1188                         "Invalid config (%d, %d, %d), using defaults\n",
1189                         ts->prop.max_x, ts->prop.max_y, ts->max_touch_num);
1190                 ts->prop.max_x = GOODIX_MAX_WIDTH - 1;
1191                 ts->prop.max_y = GOODIX_MAX_HEIGHT - 1;
1192                 ts->max_touch_num = GOODIX_MAX_CONTACTS;
1193                 input_abs_set_max(ts->input_dev,
1194                                   ABS_MT_POSITION_X, ts->prop.max_x);
1195                 input_abs_set_max(ts->input_dev,
1196                                   ABS_MT_POSITION_Y, ts->prop.max_y);
1197         }
1198
1199         if (dmi_check_system(nine_bytes_report)) {
1200                 ts->contact_size = 9;
1201
1202                 dev_dbg(&ts->client->dev,
1203                         "Non-standard 9-bytes report format quirk\n");
1204         }
1205
1206         if (dmi_check_system(inverted_x_screen)) {
1207                 ts->prop.invert_x = true;
1208                 dev_dbg(&ts->client->dev,
1209                         "Applying 'inverted x screen' quirk\n");
1210         }
1211
1212         error = input_mt_init_slots(ts->input_dev, ts->max_touch_num,
1213                                     INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
1214         if (error) {
1215                 dev_err(&ts->client->dev,
1216                         "Failed to initialize MT slots: %d", error);
1217                 return error;
1218         }
1219
1220         error = input_register_device(ts->input_dev);
1221         if (error) {
1222                 dev_err(&ts->client->dev,
1223                         "Failed to register input device: %d", error);
1224                 return error;
1225         }
1226
1227         /*
1228          * Create the input_pen device before goodix_request_irq() calls
1229          * devm_request_threaded_irq() so that the devm framework frees
1230          * it after disabling the irq.
1231          * Unfortunately there is no way to detect if the touchscreen has pen
1232          * support, so registering the dev is delayed till the first pen event.
1233          */
1234         error = goodix_create_pen_input(ts);
1235         if (error)
1236                 return error;
1237
1238         ts->irq_flags = goodix_irq_flags[ts->int_trigger_type] | IRQF_ONESHOT;
1239         error = goodix_request_irq(ts);
1240         if (error) {
1241                 dev_err(&ts->client->dev, "request IRQ failed: %d\n", error);
1242                 return error;
1243         }
1244
1245         return 0;
1246 }
1247
1248 /**
1249  * goodix_config_cb - Callback to finish device init
1250  *
1251  * @cfg: firmware config
1252  * @ctx: our goodix_ts_data pointer
1253  *
1254  * request_firmware_wait callback that finishes
1255  * initialization of the device.
1256  */
1257 static void goodix_config_cb(const struct firmware *cfg, void *ctx)
1258 {
1259         struct goodix_ts_data *ts = ctx;
1260         int error;
1261
1262         if (ts->firmware_name) {
1263                 if (!cfg)
1264                         goto err_release_cfg;
1265
1266                 error = goodix_check_cfg(ts, cfg->data, cfg->size);
1267                 if (error)
1268                         goto err_release_cfg;
1269
1270                 memcpy(ts->config, cfg->data, cfg->size);
1271         } else if (cfg) {
1272                 /* send device configuration to the firmware */
1273                 error = goodix_send_cfg(ts, cfg->data, cfg->size);
1274                 if (error)
1275                         goto err_release_cfg;
1276         }
1277
1278         goodix_configure_dev(ts);
1279
1280 err_release_cfg:
1281         release_firmware(cfg);
1282         complete_all(&ts->firmware_loading_complete);
1283 }
1284
1285 static void goodix_disable_regulators(void *arg)
1286 {
1287         struct goodix_ts_data *ts = arg;
1288
1289         regulator_disable(ts->vddio);
1290         regulator_disable(ts->avdd28);
1291 }
1292
1293 static int goodix_ts_probe(struct i2c_client *client)
1294 {
1295         struct goodix_ts_data *ts;
1296         const char *cfg_name;
1297         int error;
1298
1299         dev_dbg(&client->dev, "I2C Address: 0x%02x\n", client->addr);
1300
1301         if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
1302                 dev_err(&client->dev, "I2C check functionality failed.\n");
1303                 return -ENXIO;
1304         }
1305
1306         ts = devm_kzalloc(&client->dev, sizeof(*ts), GFP_KERNEL);
1307         if (!ts)
1308                 return -ENOMEM;
1309
1310         ts->client = client;
1311         i2c_set_clientdata(client, ts);
1312         init_completion(&ts->firmware_loading_complete);
1313         ts->contact_size = GOODIX_CONTACT_SIZE;
1314
1315         error = goodix_get_gpio_config(ts);
1316         if (error)
1317                 return error;
1318
1319         /* power up the controller */
1320         error = regulator_enable(ts->avdd28);
1321         if (error) {
1322                 dev_err(&client->dev,
1323                         "Failed to enable AVDD28 regulator: %d\n",
1324                         error);
1325                 return error;
1326         }
1327
1328         error = regulator_enable(ts->vddio);
1329         if (error) {
1330                 dev_err(&client->dev,
1331                         "Failed to enable VDDIO regulator: %d\n",
1332                         error);
1333                 regulator_disable(ts->avdd28);
1334                 return error;
1335         }
1336
1337         error = devm_add_action_or_reset(&client->dev,
1338                                          goodix_disable_regulators, ts);
1339         if (error)
1340                 return error;
1341
1342 reset:
1343         if (ts->reset_controller_at_probe) {
1344                 /* reset the controller */
1345                 error = goodix_reset(ts);
1346                 if (error)
1347                         return error;
1348         }
1349
1350         error = goodix_i2c_test(client);
1351         if (error) {
1352                 if (!ts->reset_controller_at_probe &&
1353                     ts->irq_pin_access_method != IRQ_PIN_ACCESS_NONE) {
1354                         /* Retry after a controller reset */
1355                         ts->reset_controller_at_probe = true;
1356                         goto reset;
1357                 }
1358                 dev_err(&client->dev, "I2C communication failure: %d\n", error);
1359                 return error;
1360         }
1361
1362         error = goodix_firmware_check(ts);
1363         if (error)
1364                 return error;
1365
1366         error = goodix_read_version(ts);
1367         if (error)
1368                 return error;
1369
1370         ts->chip = goodix_get_chip_data(ts->id);
1371
1372         if (ts->load_cfg_from_disk) {
1373                 /* update device config */
1374                 error = device_property_read_string(&client->dev,
1375                                                     "goodix,config-name",
1376                                                     &cfg_name);
1377                 if (!error)
1378                         snprintf(ts->cfg_name, sizeof(ts->cfg_name),
1379                                  "goodix/%s", cfg_name);
1380                 else
1381                         snprintf(ts->cfg_name, sizeof(ts->cfg_name),
1382                                  "goodix_%s_cfg.bin", ts->id);
1383
1384                 error = request_firmware_nowait(THIS_MODULE, true, ts->cfg_name,
1385                                                 &client->dev, GFP_KERNEL, ts,
1386                                                 goodix_config_cb);
1387                 if (error) {
1388                         dev_err(&client->dev,
1389                                 "Failed to invoke firmware loader: %d\n",
1390                                 error);
1391                         return error;
1392                 }
1393
1394                 return 0;
1395         } else {
1396                 error = goodix_configure_dev(ts);
1397                 if (error)
1398                         return error;
1399         }
1400
1401         return 0;
1402 }
1403
1404 static void goodix_ts_remove(struct i2c_client *client)
1405 {
1406         struct goodix_ts_data *ts = i2c_get_clientdata(client);
1407
1408         if (ts->load_cfg_from_disk)
1409                 wait_for_completion(&ts->firmware_loading_complete);
1410 }
1411
1412 static int goodix_suspend(struct device *dev)
1413 {
1414         struct i2c_client *client = to_i2c_client(dev);
1415         struct goodix_ts_data *ts = i2c_get_clientdata(client);
1416         int error;
1417
1418         if (ts->load_cfg_from_disk)
1419                 wait_for_completion(&ts->firmware_loading_complete);
1420
1421         /* We need gpio pins to suspend/resume */
1422         if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) {
1423                 disable_irq(client->irq);
1424                 return 0;
1425         }
1426
1427         /* Free IRQ as IRQ pin is used as output in the suspend sequence */
1428         goodix_free_irq(ts);
1429
1430         /* Save reference (calibration) info if necessary */
1431         goodix_save_bak_ref(ts);
1432
1433         /* Output LOW on the INT pin for 5 ms */
1434         error = goodix_irq_direction_output(ts, 0);
1435         if (error) {
1436                 goodix_request_irq(ts);
1437                 return error;
1438         }
1439
1440         usleep_range(5000, 6000);
1441
1442         error = goodix_i2c_write_u8(ts->client, GOODIX_REG_COMMAND,
1443                                     GOODIX_CMD_SCREEN_OFF);
1444         if (error) {
1445                 goodix_irq_direction_input(ts);
1446                 goodix_request_irq(ts);
1447                 return -EAGAIN;
1448         }
1449
1450         /*
1451          * The datasheet specifies that the interval between sending screen-off
1452          * command and wake-up should be longer than 58 ms. To avoid waking up
1453          * sooner, delay 58ms here.
1454          */
1455         msleep(58);
1456         return 0;
1457 }
1458
1459 static int goodix_resume(struct device *dev)
1460 {
1461         struct i2c_client *client = to_i2c_client(dev);
1462         struct goodix_ts_data *ts = i2c_get_clientdata(client);
1463         u8 config_ver;
1464         int error;
1465
1466         if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) {
1467                 enable_irq(client->irq);
1468                 return 0;
1469         }
1470
1471         /*
1472          * Exit sleep mode by outputting HIGH level to INT pin
1473          * for 2ms~5ms.
1474          */
1475         error = goodix_irq_direction_output(ts, 1);
1476         if (error)
1477                 return error;
1478
1479         usleep_range(2000, 5000);
1480
1481         error = goodix_int_sync(ts);
1482         if (error)
1483                 return error;
1484
1485         error = goodix_i2c_read(ts->client, ts->chip->config_addr,
1486                                 &config_ver, 1);
1487         if (!error && config_ver != ts->config[0])
1488                 dev_info(dev, "Config version mismatch %d != %d, resetting controller\n",
1489                          config_ver, ts->config[0]);
1490
1491         if (error != 0 || config_ver != ts->config[0]) {
1492                 error = goodix_reset(ts);
1493                 if (error)
1494                         return error;
1495
1496                 error = goodix_send_cfg(ts, ts->config, ts->chip->config_len);
1497                 if (error)
1498                         return error;
1499         }
1500
1501         error = goodix_request_irq(ts);
1502         if (error)
1503                 return error;
1504
1505         return 0;
1506 }
1507
1508 static DEFINE_SIMPLE_DEV_PM_OPS(goodix_pm_ops, goodix_suspend, goodix_resume);
1509
1510 static const struct i2c_device_id goodix_ts_id[] = {
1511         { "GDIX1001:00", 0 },
1512         { }
1513 };
1514 MODULE_DEVICE_TABLE(i2c, goodix_ts_id);
1515
1516 #ifdef CONFIG_ACPI
1517 static const struct acpi_device_id goodix_acpi_match[] = {
1518         { "GDIX1001", 0 },
1519         { "GDIX1002", 0 },
1520         { }
1521 };
1522 MODULE_DEVICE_TABLE(acpi, goodix_acpi_match);
1523 #endif
1524
1525 #ifdef CONFIG_OF
1526 static const struct of_device_id goodix_of_match[] = {
1527         { .compatible = "goodix,gt1151" },
1528         { .compatible = "goodix,gt1158" },
1529         { .compatible = "goodix,gt5663" },
1530         { .compatible = "goodix,gt5688" },
1531         { .compatible = "goodix,gt911" },
1532         { .compatible = "goodix,gt9110" },
1533         { .compatible = "goodix,gt912" },
1534         { .compatible = "goodix,gt9147" },
1535         { .compatible = "goodix,gt917s" },
1536         { .compatible = "goodix,gt927" },
1537         { .compatible = "goodix,gt9271" },
1538         { .compatible = "goodix,gt928" },
1539         { .compatible = "goodix,gt9286" },
1540         { .compatible = "goodix,gt967" },
1541         { }
1542 };
1543 MODULE_DEVICE_TABLE(of, goodix_of_match);
1544 #endif
1545
1546 static struct i2c_driver goodix_ts_driver = {
1547         .probe = goodix_ts_probe,
1548         .remove = goodix_ts_remove,
1549         .id_table = goodix_ts_id,
1550         .driver = {
1551                 .name = "Goodix-TS",
1552                 .acpi_match_table = ACPI_PTR(goodix_acpi_match),
1553                 .of_match_table = of_match_ptr(goodix_of_match),
1554                 .pm = pm_sleep_ptr(&goodix_pm_ops),
1555         },
1556 };
1557 module_i2c_driver(goodix_ts_driver);
1558
1559 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
1560 MODULE_AUTHOR("Bastien Nocera <hadess@hadess.net>");
1561 MODULE_DESCRIPTION("Goodix touchscreen driver");
1562 MODULE_LICENSE("GPL v2");