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