drivers/input/touchscreen/goodix.c

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