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