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