1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * Driver for Goodix Touchscreens 4 * 5 * Copyright (c) 2014 Red Hat Inc. 6 * Copyright (c) 2015 K. Merker <merker@debian.org> 7 * 8 * This code is based on gt9xx.c authored by andrew@goodix.com: 9 * 10 * 2010 - 2012 Goodix Technology. 11 */ 12 13 14 #include <linux/kernel.h> 15 #include <linux/dmi.h> 16 #include <linux/firmware.h> 17 #include <linux/gpio/consumer.h> 18 #include <linux/i2c.h> 19 #include <linux/input.h> 20 #include <linux/input/mt.h> 21 #include <linux/input/touchscreen.h> 22 #include <linux/module.h> 23 #include <linux/delay.h> 24 #include <linux/irq.h> 25 #include <linux/interrupt.h> 26 #include <linux/regulator/consumer.h> 27 #include <linux/slab.h> 28 #include <linux/acpi.h> 29 #include <linux/of.h> 30 #include <asm/unaligned.h> 31 32 #define GOODIX_GPIO_INT_NAME "irq" 33 #define GOODIX_GPIO_RST_NAME "reset" 34 35 #define GOODIX_MAX_HEIGHT 4096 36 #define GOODIX_MAX_WIDTH 4096 37 #define GOODIX_INT_TRIGGER 1 38 #define GOODIX_CONTACT_SIZE 8 39 #define GOODIX_MAX_CONTACT_SIZE 9 40 #define GOODIX_MAX_CONTACTS 10 41 #define GOODIX_MAX_KEYS 7 42 43 #define GOODIX_CONFIG_MIN_LENGTH 186 44 #define GOODIX_CONFIG_911_LENGTH 186 45 #define GOODIX_CONFIG_967_LENGTH 228 46 #define GOODIX_CONFIG_GT9X_LENGTH 240 47 #define GOODIX_CONFIG_MAX_LENGTH 240 48 49 /* Register defines */ 50 #define GOODIX_REG_COMMAND 0x8040 51 #define GOODIX_CMD_SCREEN_OFF 0x05 52 53 #define GOODIX_READ_COOR_ADDR 0x814E 54 #define GOODIX_GT1X_REG_CONFIG_DATA 0x8050 55 #define GOODIX_GT9X_REG_CONFIG_DATA 0x8047 56 #define GOODIX_REG_ID 0x8140 57 58 #define GOODIX_BUFFER_STATUS_READY BIT(7) 59 #define GOODIX_HAVE_KEY BIT(4) 60 #define GOODIX_BUFFER_STATUS_TIMEOUT 20 61 62 #define RESOLUTION_LOC 1 63 #define MAX_CONTACTS_LOC 5 64 #define TRIGGER_LOC 6 65 66 /* Our special handling for GPIO accesses through ACPI is x86 specific */ 67 #if defined CONFIG_X86 && defined CONFIG_ACPI 68 #define ACPI_GPIO_SUPPORT 69 #endif 70 71 struct goodix_ts_data; 72 73 enum goodix_irq_pin_access_method { 74 IRQ_PIN_ACCESS_NONE, 75 IRQ_PIN_ACCESS_GPIO, 76 IRQ_PIN_ACCESS_ACPI_GPIO, 77 IRQ_PIN_ACCESS_ACPI_METHOD, 78 }; 79 80 struct goodix_chip_data { 81 u16 config_addr; 82 int config_len; 83 int (*check_config)(struct goodix_ts_data *ts, const u8 *cfg, int len); 84 void (*calc_config_checksum)(struct goodix_ts_data *ts); 85 }; 86 87 struct goodix_chip_id { 88 const char *id; 89 const struct goodix_chip_data *data; 90 }; 91 92 #define GOODIX_ID_MAX_LEN 4 93 94 struct goodix_ts_data { 95 struct i2c_client *client; 96 struct input_dev *input_dev; 97 const struct goodix_chip_data *chip; 98 struct touchscreen_properties prop; 99 unsigned int max_touch_num; 100 unsigned int int_trigger_type; 101 struct regulator *avdd28; 102 struct regulator *vddio; 103 struct gpio_desc *gpiod_int; 104 struct gpio_desc *gpiod_rst; 105 int gpio_count; 106 int gpio_int_idx; 107 char id[GOODIX_ID_MAX_LEN + 1]; 108 u16 version; 109 const char *cfg_name; 110 bool reset_controller_at_probe; 111 bool load_cfg_from_disk; 112 struct completion firmware_loading_complete; 113 unsigned long irq_flags; 114 enum goodix_irq_pin_access_method irq_pin_access_method; 115 unsigned int contact_size; 116 u8 config[GOODIX_CONFIG_MAX_LENGTH]; 117 unsigned short keymap[GOODIX_MAX_KEYS]; 118 }; 119 120 static int goodix_check_cfg_8(struct goodix_ts_data *ts, 121 const u8 *cfg, int len); 122 static int goodix_check_cfg_16(struct goodix_ts_data *ts, 123 const u8 *cfg, int len); 124 static void goodix_calc_cfg_checksum_8(struct goodix_ts_data *ts); 125 static void goodix_calc_cfg_checksum_16(struct goodix_ts_data *ts); 126 127 static const struct goodix_chip_data gt1x_chip_data = { 128 .config_addr = GOODIX_GT1X_REG_CONFIG_DATA, 129 .config_len = GOODIX_CONFIG_GT9X_LENGTH, 130 .check_config = goodix_check_cfg_16, 131 .calc_config_checksum = goodix_calc_cfg_checksum_16, 132 }; 133 134 static const struct goodix_chip_data gt911_chip_data = { 135 .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 136 .config_len = GOODIX_CONFIG_911_LENGTH, 137 .check_config = goodix_check_cfg_8, 138 .calc_config_checksum = goodix_calc_cfg_checksum_8, 139 }; 140 141 static const struct goodix_chip_data gt967_chip_data = { 142 .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 143 .config_len = GOODIX_CONFIG_967_LENGTH, 144 .check_config = goodix_check_cfg_8, 145 .calc_config_checksum = goodix_calc_cfg_checksum_8, 146 }; 147 148 static const struct goodix_chip_data gt9x_chip_data = { 149 .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 150 .config_len = GOODIX_CONFIG_GT9X_LENGTH, 151 .check_config = goodix_check_cfg_8, 152 .calc_config_checksum = goodix_calc_cfg_checksum_8, 153 }; 154 155 static const struct goodix_chip_id goodix_chip_ids[] = { 156 { .id = "1151", .data = >1x_chip_data }, 157 { .id = "5663", .data = >1x_chip_data }, 158 { .id = "5688", .data = >1x_chip_data }, 159 { .id = "917S", .data = >1x_chip_data }, 160 161 { .id = "911", .data = >911_chip_data }, 162 { .id = "9271", .data = >911_chip_data }, 163 { .id = "9110", .data = >911_chip_data }, 164 { .id = "927", .data = >911_chip_data }, 165 { .id = "928", .data = >911_chip_data }, 166 167 { .id = "912", .data = >967_chip_data }, 168 { .id = "9147", .data = >967_chip_data }, 169 { .id = "967", .data = >967_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 >9x_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 */ 580 static int goodix_check_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len) 581 { 582 if (len < GOODIX_CONFIG_MIN_LENGTH || 583 len > GOODIX_CONFIG_MAX_LENGTH) { 584 dev_err(&ts->client->dev, 585 "The length of the config fw is not correct"); 586 return -EINVAL; 587 } 588 589 return ts->chip->check_config(ts, cfg, len); 590 } 591 592 /** 593 * goodix_send_cfg - Write fw config to device 594 * 595 * @ts: goodix_ts_data pointer 596 * @cfg: config firmware to write to device 597 */ 598 static int goodix_send_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len) 599 { 600 int error; 601 602 error = goodix_check_cfg(ts, cfg, len); 603 if (error) 604 return error; 605 606 error = goodix_i2c_write(ts->client, ts->chip->config_addr, cfg, len); 607 if (error) { 608 dev_err(&ts->client->dev, "Failed to write config data: %d", 609 error); 610 return error; 611 } 612 dev_dbg(&ts->client->dev, "Config sent successfully."); 613 614 /* Let the firmware reconfigure itself, so sleep for 10ms */ 615 usleep_range(10000, 11000); 616 617 return 0; 618 } 619 620 #ifdef ACPI_GPIO_SUPPORT 621 static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts) 622 { 623 acpi_handle handle = ACPI_HANDLE(&ts->client->dev); 624 acpi_status status; 625 626 status = acpi_evaluate_object(handle, "INTI", NULL, NULL); 627 return ACPI_SUCCESS(status) ? 0 : -EIO; 628 } 629 630 static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value) 631 { 632 acpi_handle handle = ACPI_HANDLE(&ts->client->dev); 633 acpi_status status; 634 635 status = acpi_execute_simple_method(handle, "INTO", value); 636 return ACPI_SUCCESS(status) ? 0 : -EIO; 637 } 638 #else 639 static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts) 640 { 641 dev_err(&ts->client->dev, 642 "%s called on device without ACPI support\n", __func__); 643 return -EINVAL; 644 } 645 646 static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value) 647 { 648 dev_err(&ts->client->dev, 649 "%s called on device without ACPI support\n", __func__); 650 return -EINVAL; 651 } 652 #endif 653 654 static int goodix_irq_direction_output(struct goodix_ts_data *ts, int value) 655 { 656 switch (ts->irq_pin_access_method) { 657 case IRQ_PIN_ACCESS_NONE: 658 dev_err(&ts->client->dev, 659 "%s called without an irq_pin_access_method set\n", 660 __func__); 661 return -EINVAL; 662 case IRQ_PIN_ACCESS_GPIO: 663 return gpiod_direction_output(ts->gpiod_int, value); 664 case IRQ_PIN_ACCESS_ACPI_GPIO: 665 /* 666 * The IRQ pin triggers on a falling edge, so its gets marked 667 * as active-low, use output_raw to avoid the value inversion. 668 */ 669 return gpiod_direction_output_raw(ts->gpiod_int, value); 670 case IRQ_PIN_ACCESS_ACPI_METHOD: 671 return goodix_pin_acpi_output_method(ts, value); 672 } 673 674 return -EINVAL; /* Never reached */ 675 } 676 677 static int goodix_irq_direction_input(struct goodix_ts_data *ts) 678 { 679 switch (ts->irq_pin_access_method) { 680 case IRQ_PIN_ACCESS_NONE: 681 dev_err(&ts->client->dev, 682 "%s called without an irq_pin_access_method set\n", 683 __func__); 684 return -EINVAL; 685 case IRQ_PIN_ACCESS_GPIO: 686 return gpiod_direction_input(ts->gpiod_int); 687 case IRQ_PIN_ACCESS_ACPI_GPIO: 688 return gpiod_direction_input(ts->gpiod_int); 689 case IRQ_PIN_ACCESS_ACPI_METHOD: 690 return goodix_pin_acpi_direction_input(ts); 691 } 692 693 return -EINVAL; /* Never reached */ 694 } 695 696 static int goodix_int_sync(struct goodix_ts_data *ts) 697 { 698 int error; 699 700 error = goodix_irq_direction_output(ts, 0); 701 if (error) 702 return error; 703 704 msleep(50); /* T5: 50ms */ 705 706 error = goodix_irq_direction_input(ts); 707 if (error) 708 return error; 709 710 return 0; 711 } 712 713 /** 714 * goodix_reset - Reset device during power on 715 * 716 * @ts: goodix_ts_data pointer 717 */ 718 static int goodix_reset(struct goodix_ts_data *ts) 719 { 720 int error; 721 722 /* begin select I2C slave addr */ 723 error = gpiod_direction_output(ts->gpiod_rst, 0); 724 if (error) 725 return error; 726 727 msleep(20); /* T2: > 10ms */ 728 729 /* HIGH: 0x28/0x29, LOW: 0xBA/0xBB */ 730 error = goodix_irq_direction_output(ts, ts->client->addr == 0x14); 731 if (error) 732 return error; 733 734 usleep_range(100, 2000); /* T3: > 100us */ 735 736 error = gpiod_direction_output(ts->gpiod_rst, 1); 737 if (error) 738 return error; 739 740 usleep_range(6000, 10000); /* T4: > 5ms */ 741 742 /* end select I2C slave addr */ 743 error = gpiod_direction_input(ts->gpiod_rst); 744 if (error) 745 return error; 746 747 error = goodix_int_sync(ts); 748 if (error) 749 return error; 750 751 return 0; 752 } 753 754 #ifdef ACPI_GPIO_SUPPORT 755 #include <asm/cpu_device_id.h> 756 #include <asm/intel-family.h> 757 758 static const struct x86_cpu_id baytrail_cpu_ids[] = { 759 { X86_VENDOR_INTEL, 6, INTEL_FAM6_ATOM_SILVERMONT, X86_FEATURE_ANY, }, 760 {} 761 }; 762 763 static inline bool is_byt(void) 764 { 765 const struct x86_cpu_id *id = x86_match_cpu(baytrail_cpu_ids); 766 767 return !!id; 768 } 769 770 static const struct acpi_gpio_params first_gpio = { 0, 0, false }; 771 static const struct acpi_gpio_params second_gpio = { 1, 0, false }; 772 773 static const struct acpi_gpio_mapping acpi_goodix_int_first_gpios[] = { 774 { GOODIX_GPIO_INT_NAME "-gpios", &first_gpio, 1 }, 775 { GOODIX_GPIO_RST_NAME "-gpios", &second_gpio, 1 }, 776 { }, 777 }; 778 779 static const struct acpi_gpio_mapping acpi_goodix_int_last_gpios[] = { 780 { GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 }, 781 { GOODIX_GPIO_INT_NAME "-gpios", &second_gpio, 1 }, 782 { }, 783 }; 784 785 static const struct acpi_gpio_mapping acpi_goodix_reset_only_gpios[] = { 786 { GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 }, 787 { }, 788 }; 789 790 static int goodix_resource(struct acpi_resource *ares, void *data) 791 { 792 struct goodix_ts_data *ts = data; 793 struct device *dev = &ts->client->dev; 794 struct acpi_resource_gpio *gpio; 795 796 switch (ares->type) { 797 case ACPI_RESOURCE_TYPE_GPIO: 798 gpio = &ares->data.gpio; 799 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) { 800 if (ts->gpio_int_idx == -1) { 801 ts->gpio_int_idx = ts->gpio_count; 802 } else { 803 dev_err(dev, "More then one GpioInt resource, ignoring ACPI GPIO resources\n"); 804 ts->gpio_int_idx = -2; 805 } 806 } 807 ts->gpio_count++; 808 break; 809 default: 810 break; 811 } 812 813 return 0; 814 } 815 816 /* 817 * This function gets called in case we fail to get the irq GPIO directly 818 * because the ACPI tables lack GPIO-name to APCI _CRS index mappings 819 * (no _DSD UUID daffd814-6eba-4d8c-8a91-bc9bbf4aa301 data). 820 * In that case we add our own mapping and then goodix_get_gpio_config() 821 * retries to get the GPIOs based on the added mapping. 822 */ 823 static int goodix_add_acpi_gpio_mappings(struct goodix_ts_data *ts) 824 { 825 const struct acpi_gpio_mapping *gpio_mapping = NULL; 826 struct device *dev = &ts->client->dev; 827 LIST_HEAD(resources); 828 int ret; 829 830 ts->gpio_count = 0; 831 ts->gpio_int_idx = -1; 832 ret = acpi_dev_get_resources(ACPI_COMPANION(dev), &resources, 833 goodix_resource, ts); 834 if (ret < 0) { 835 dev_err(dev, "Error getting ACPI resources: %d\n", ret); 836 return ret; 837 } 838 839 acpi_dev_free_resource_list(&resources); 840 841 if (ts->gpio_count == 2 && ts->gpio_int_idx == 0) { 842 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO; 843 gpio_mapping = acpi_goodix_int_first_gpios; 844 } else if (ts->gpio_count == 2 && ts->gpio_int_idx == 1) { 845 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO; 846 gpio_mapping = acpi_goodix_int_last_gpios; 847 } else if (ts->gpio_count == 1 && ts->gpio_int_idx == -1 && 848 acpi_has_method(ACPI_HANDLE(dev), "INTI") && 849 acpi_has_method(ACPI_HANDLE(dev), "INTO")) { 850 dev_info(dev, "Using ACPI INTI and INTO methods for IRQ pin access\n"); 851 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_METHOD; 852 gpio_mapping = acpi_goodix_reset_only_gpios; 853 } else if (is_byt() && ts->gpio_count == 2 && ts->gpio_int_idx == -1) { 854 dev_info(dev, "No ACPI GpioInt resource, assuming that the GPIO order is reset, int\n"); 855 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO; 856 gpio_mapping = acpi_goodix_int_last_gpios; 857 } else { 858 dev_warn(dev, "Unexpected ACPI resources: gpio_count %d, gpio_int_idx %d\n", 859 ts->gpio_count, ts->gpio_int_idx); 860 return -EINVAL; 861 } 862 863 return devm_acpi_dev_add_driver_gpios(dev, gpio_mapping); 864 } 865 #else 866 static int goodix_add_acpi_gpio_mappings(struct goodix_ts_data *ts) 867 { 868 return -EINVAL; 869 } 870 #endif /* CONFIG_X86 && CONFIG_ACPI */ 871 872 /** 873 * goodix_get_gpio_config - Get GPIO config from ACPI/DT 874 * 875 * @ts: goodix_ts_data pointer 876 */ 877 static int goodix_get_gpio_config(struct goodix_ts_data *ts) 878 { 879 int error; 880 struct device *dev; 881 struct gpio_desc *gpiod; 882 bool added_acpi_mappings = false; 883 884 if (!ts->client) 885 return -EINVAL; 886 dev = &ts->client->dev; 887 888 ts->avdd28 = devm_regulator_get(dev, "AVDD28"); 889 if (IS_ERR(ts->avdd28)) { 890 error = PTR_ERR(ts->avdd28); 891 if (error != -EPROBE_DEFER) 892 dev_err(dev, 893 "Failed to get AVDD28 regulator: %d\n", error); 894 return error; 895 } 896 897 ts->vddio = devm_regulator_get(dev, "VDDIO"); 898 if (IS_ERR(ts->vddio)) { 899 error = PTR_ERR(ts->vddio); 900 if (error != -EPROBE_DEFER) 901 dev_err(dev, 902 "Failed to get VDDIO regulator: %d\n", error); 903 return error; 904 } 905 906 retry_get_irq_gpio: 907 /* Get the interrupt GPIO pin number */ 908 gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_INT_NAME, GPIOD_IN); 909 if (IS_ERR(gpiod)) { 910 error = PTR_ERR(gpiod); 911 if (error != -EPROBE_DEFER) 912 dev_dbg(dev, "Failed to get %s GPIO: %d\n", 913 GOODIX_GPIO_INT_NAME, error); 914 return error; 915 } 916 if (!gpiod && has_acpi_companion(dev) && !added_acpi_mappings) { 917 added_acpi_mappings = true; 918 if (goodix_add_acpi_gpio_mappings(ts) == 0) 919 goto retry_get_irq_gpio; 920 } 921 922 ts->gpiod_int = gpiod; 923 924 /* Get the reset line GPIO pin number */ 925 gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_RST_NAME, GPIOD_IN); 926 if (IS_ERR(gpiod)) { 927 error = PTR_ERR(gpiod); 928 if (error != -EPROBE_DEFER) 929 dev_dbg(dev, "Failed to get %s GPIO: %d\n", 930 GOODIX_GPIO_RST_NAME, error); 931 return error; 932 } 933 934 ts->gpiod_rst = gpiod; 935 936 switch (ts->irq_pin_access_method) { 937 case IRQ_PIN_ACCESS_ACPI_GPIO: 938 /* 939 * We end up here if goodix_add_acpi_gpio_mappings() has 940 * called devm_acpi_dev_add_driver_gpios() because the ACPI 941 * tables did not contain name to index mappings. 942 * Check that we successfully got both GPIOs after we've 943 * added our own acpi_gpio_mapping and if we did not get both 944 * GPIOs reset irq_pin_access_method to IRQ_PIN_ACCESS_NONE. 945 */ 946 if (!ts->gpiod_int || !ts->gpiod_rst) 947 ts->irq_pin_access_method = IRQ_PIN_ACCESS_NONE; 948 break; 949 case IRQ_PIN_ACCESS_ACPI_METHOD: 950 if (!ts->gpiod_rst) 951 ts->irq_pin_access_method = IRQ_PIN_ACCESS_NONE; 952 break; 953 default: 954 if (ts->gpiod_int && ts->gpiod_rst) { 955 ts->reset_controller_at_probe = true; 956 ts->load_cfg_from_disk = true; 957 ts->irq_pin_access_method = IRQ_PIN_ACCESS_GPIO; 958 } 959 } 960 961 return 0; 962 } 963 964 /** 965 * goodix_read_config - Read the embedded configuration of the panel 966 * 967 * @ts: our goodix_ts_data pointer 968 * 969 * Must be called during probe 970 */ 971 static void goodix_read_config(struct goodix_ts_data *ts) 972 { 973 int x_max, y_max; 974 int error; 975 976 error = goodix_i2c_read(ts->client, ts->chip->config_addr, 977 ts->config, ts->chip->config_len); 978 if (error) { 979 dev_warn(&ts->client->dev, "Error reading config: %d\n", 980 error); 981 ts->int_trigger_type = GOODIX_INT_TRIGGER; 982 ts->max_touch_num = GOODIX_MAX_CONTACTS; 983 return; 984 } 985 986 ts->int_trigger_type = ts->config[TRIGGER_LOC] & 0x03; 987 ts->max_touch_num = ts->config[MAX_CONTACTS_LOC] & 0x0f; 988 989 x_max = get_unaligned_le16(&ts->config[RESOLUTION_LOC]); 990 y_max = get_unaligned_le16(&ts->config[RESOLUTION_LOC + 2]); 991 if (x_max && y_max) { 992 input_abs_set_max(ts->input_dev, ABS_MT_POSITION_X, x_max - 1); 993 input_abs_set_max(ts->input_dev, ABS_MT_POSITION_Y, y_max - 1); 994 } 995 996 ts->chip->calc_config_checksum(ts); 997 } 998 999 /** 1000 * goodix_read_version - Read goodix touchscreen version 1001 * 1002 * @ts: our goodix_ts_data pointer 1003 */ 1004 static int goodix_read_version(struct goodix_ts_data *ts) 1005 { 1006 int error; 1007 u8 buf[6]; 1008 char id_str[GOODIX_ID_MAX_LEN + 1]; 1009 1010 error = goodix_i2c_read(ts->client, GOODIX_REG_ID, buf, sizeof(buf)); 1011 if (error) { 1012 dev_err(&ts->client->dev, "read version failed: %d\n", error); 1013 return error; 1014 } 1015 1016 memcpy(id_str, buf, GOODIX_ID_MAX_LEN); 1017 id_str[GOODIX_ID_MAX_LEN] = 0; 1018 strscpy(ts->id, id_str, GOODIX_ID_MAX_LEN + 1); 1019 1020 ts->version = get_unaligned_le16(&buf[4]); 1021 1022 dev_info(&ts->client->dev, "ID %s, version: %04x\n", ts->id, 1023 ts->version); 1024 1025 return 0; 1026 } 1027 1028 /** 1029 * goodix_i2c_test - I2C test function to check if the device answers. 1030 * 1031 * @client: the i2c client 1032 */ 1033 static int goodix_i2c_test(struct i2c_client *client) 1034 { 1035 int retry = 0; 1036 int error; 1037 u8 test; 1038 1039 while (retry++ < 2) { 1040 error = goodix_i2c_read(client, GOODIX_REG_ID, 1041 &test, 1); 1042 if (!error) 1043 return 0; 1044 1045 dev_err(&client->dev, "i2c test failed attempt %d: %d\n", 1046 retry, error); 1047 msleep(20); 1048 } 1049 1050 return error; 1051 } 1052 1053 /** 1054 * goodix_configure_dev - Finish device initialization 1055 * 1056 * @ts: our goodix_ts_data pointer 1057 * 1058 * Must be called from probe to finish initialization of the device. 1059 * Contains the common initialization code for both devices that 1060 * declare gpio pins and devices that do not. It is either called 1061 * directly from probe or from request_firmware_wait callback. 1062 */ 1063 static int goodix_configure_dev(struct goodix_ts_data *ts) 1064 { 1065 int error; 1066 int i; 1067 1068 ts->int_trigger_type = GOODIX_INT_TRIGGER; 1069 ts->max_touch_num = GOODIX_MAX_CONTACTS; 1070 1071 ts->input_dev = devm_input_allocate_device(&ts->client->dev); 1072 if (!ts->input_dev) { 1073 dev_err(&ts->client->dev, "Failed to allocate input device."); 1074 return -ENOMEM; 1075 } 1076 1077 ts->input_dev->name = "Goodix Capacitive TouchScreen"; 1078 ts->input_dev->phys = "input/ts"; 1079 ts->input_dev->id.bustype = BUS_I2C; 1080 ts->input_dev->id.vendor = 0x0416; 1081 if (kstrtou16(ts->id, 10, &ts->input_dev->id.product)) 1082 ts->input_dev->id.product = 0x1001; 1083 ts->input_dev->id.version = ts->version; 1084 1085 ts->input_dev->keycode = ts->keymap; 1086 ts->input_dev->keycodesize = sizeof(ts->keymap[0]); 1087 ts->input_dev->keycodemax = GOODIX_MAX_KEYS; 1088 1089 /* Capacitive Windows/Home button on some devices */ 1090 for (i = 0; i < GOODIX_MAX_KEYS; ++i) { 1091 if (i == 0) 1092 ts->keymap[i] = KEY_LEFTMETA; 1093 else 1094 ts->keymap[i] = KEY_F1 + (i - 1); 1095 1096 input_set_capability(ts->input_dev, EV_KEY, ts->keymap[i]); 1097 } 1098 1099 input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_X); 1100 input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_Y); 1101 input_set_abs_params(ts->input_dev, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0); 1102 input_set_abs_params(ts->input_dev, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0); 1103 1104 /* Read configuration and apply touchscreen parameters */ 1105 goodix_read_config(ts); 1106 1107 /* Try overriding touchscreen parameters via device properties */ 1108 touchscreen_parse_properties(ts->input_dev, true, &ts->prop); 1109 1110 if (!ts->prop.max_x || !ts->prop.max_y || !ts->max_touch_num) { 1111 dev_err(&ts->client->dev, 1112 "Invalid config (%d, %d, %d), using defaults\n", 1113 ts->prop.max_x, ts->prop.max_y, ts->max_touch_num); 1114 ts->prop.max_x = GOODIX_MAX_WIDTH - 1; 1115 ts->prop.max_y = GOODIX_MAX_HEIGHT - 1; 1116 ts->max_touch_num = GOODIX_MAX_CONTACTS; 1117 input_abs_set_max(ts->input_dev, 1118 ABS_MT_POSITION_X, ts->prop.max_x); 1119 input_abs_set_max(ts->input_dev, 1120 ABS_MT_POSITION_Y, ts->prop.max_y); 1121 } 1122 1123 if (dmi_check_system(rotated_screen)) { 1124 ts->prop.invert_x = true; 1125 ts->prop.invert_y = true; 1126 dev_dbg(&ts->client->dev, 1127 "Applying '180 degrees rotated screen' quirk\n"); 1128 } 1129 1130 if (dmi_check_system(nine_bytes_report)) { 1131 ts->contact_size = 9; 1132 1133 dev_dbg(&ts->client->dev, 1134 "Non-standard 9-bytes report format quirk\n"); 1135 } 1136 1137 if (dmi_check_system(inverted_x_screen)) { 1138 ts->prop.invert_x = true; 1139 dev_dbg(&ts->client->dev, 1140 "Applying 'inverted x screen' quirk\n"); 1141 } 1142 1143 error = input_mt_init_slots(ts->input_dev, ts->max_touch_num, 1144 INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED); 1145 if (error) { 1146 dev_err(&ts->client->dev, 1147 "Failed to initialize MT slots: %d", error); 1148 return error; 1149 } 1150 1151 error = input_register_device(ts->input_dev); 1152 if (error) { 1153 dev_err(&ts->client->dev, 1154 "Failed to register input device: %d", error); 1155 return error; 1156 } 1157 1158 ts->irq_flags = goodix_irq_flags[ts->int_trigger_type] | IRQF_ONESHOT; 1159 error = goodix_request_irq(ts); 1160 if (error) { 1161 dev_err(&ts->client->dev, "request IRQ failed: %d\n", error); 1162 return error; 1163 } 1164 1165 return 0; 1166 } 1167 1168 /** 1169 * goodix_config_cb - Callback to finish device init 1170 * 1171 * @ts: our goodix_ts_data pointer 1172 * 1173 * request_firmware_wait callback that finishes 1174 * initialization of the device. 1175 */ 1176 static void goodix_config_cb(const struct firmware *cfg, void *ctx) 1177 { 1178 struct goodix_ts_data *ts = ctx; 1179 int error; 1180 1181 if (cfg) { 1182 /* send device configuration to the firmware */ 1183 error = goodix_send_cfg(ts, cfg->data, cfg->size); 1184 if (error) 1185 goto err_release_cfg; 1186 } 1187 1188 goodix_configure_dev(ts); 1189 1190 err_release_cfg: 1191 release_firmware(cfg); 1192 complete_all(&ts->firmware_loading_complete); 1193 } 1194 1195 static void goodix_disable_regulators(void *arg) 1196 { 1197 struct goodix_ts_data *ts = arg; 1198 1199 regulator_disable(ts->vddio); 1200 regulator_disable(ts->avdd28); 1201 } 1202 1203 static int goodix_ts_probe(struct i2c_client *client, 1204 const struct i2c_device_id *id) 1205 { 1206 struct goodix_ts_data *ts; 1207 int error; 1208 1209 dev_dbg(&client->dev, "I2C Address: 0x%02x\n", client->addr); 1210 1211 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) { 1212 dev_err(&client->dev, "I2C check functionality failed.\n"); 1213 return -ENXIO; 1214 } 1215 1216 ts = devm_kzalloc(&client->dev, sizeof(*ts), GFP_KERNEL); 1217 if (!ts) 1218 return -ENOMEM; 1219 1220 ts->client = client; 1221 i2c_set_clientdata(client, ts); 1222 init_completion(&ts->firmware_loading_complete); 1223 ts->contact_size = GOODIX_CONTACT_SIZE; 1224 1225 error = goodix_get_gpio_config(ts); 1226 if (error) 1227 return error; 1228 1229 /* power up the controller */ 1230 error = regulator_enable(ts->avdd28); 1231 if (error) { 1232 dev_err(&client->dev, 1233 "Failed to enable AVDD28 regulator: %d\n", 1234 error); 1235 return error; 1236 } 1237 1238 error = regulator_enable(ts->vddio); 1239 if (error) { 1240 dev_err(&client->dev, 1241 "Failed to enable VDDIO regulator: %d\n", 1242 error); 1243 regulator_disable(ts->avdd28); 1244 return error; 1245 } 1246 1247 error = devm_add_action_or_reset(&client->dev, 1248 goodix_disable_regulators, ts); 1249 if (error) 1250 return error; 1251 1252 reset: 1253 if (ts->reset_controller_at_probe) { 1254 /* reset the controller */ 1255 error = goodix_reset(ts); 1256 if (error) { 1257 dev_err(&client->dev, "Controller reset failed.\n"); 1258 return error; 1259 } 1260 } 1261 1262 error = goodix_i2c_test(client); 1263 if (error) { 1264 if (!ts->reset_controller_at_probe && 1265 ts->irq_pin_access_method != IRQ_PIN_ACCESS_NONE) { 1266 /* Retry after a controller reset */ 1267 ts->reset_controller_at_probe = true; 1268 goto reset; 1269 } 1270 dev_err(&client->dev, "I2C communication failure: %d\n", error); 1271 return error; 1272 } 1273 1274 error = goodix_read_version(ts); 1275 if (error) { 1276 dev_err(&client->dev, "Read version failed.\n"); 1277 return error; 1278 } 1279 1280 ts->chip = goodix_get_chip_data(ts->id); 1281 1282 if (ts->load_cfg_from_disk) { 1283 /* update device config */ 1284 ts->cfg_name = devm_kasprintf(&client->dev, GFP_KERNEL, 1285 "goodix_%s_cfg.bin", ts->id); 1286 if (!ts->cfg_name) 1287 return -ENOMEM; 1288 1289 error = request_firmware_nowait(THIS_MODULE, true, ts->cfg_name, 1290 &client->dev, GFP_KERNEL, ts, 1291 goodix_config_cb); 1292 if (error) { 1293 dev_err(&client->dev, 1294 "Failed to invoke firmware loader: %d\n", 1295 error); 1296 return error; 1297 } 1298 1299 return 0; 1300 } else { 1301 error = goodix_configure_dev(ts); 1302 if (error) 1303 return error; 1304 } 1305 1306 return 0; 1307 } 1308 1309 static int goodix_ts_remove(struct i2c_client *client) 1310 { 1311 struct goodix_ts_data *ts = i2c_get_clientdata(client); 1312 1313 if (ts->load_cfg_from_disk) 1314 wait_for_completion(&ts->firmware_loading_complete); 1315 1316 return 0; 1317 } 1318 1319 static int __maybe_unused goodix_suspend(struct device *dev) 1320 { 1321 struct i2c_client *client = to_i2c_client(dev); 1322 struct goodix_ts_data *ts = i2c_get_clientdata(client); 1323 int error; 1324 1325 if (ts->load_cfg_from_disk) 1326 wait_for_completion(&ts->firmware_loading_complete); 1327 1328 /* We need gpio pins to suspend/resume */ 1329 if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) { 1330 disable_irq(client->irq); 1331 return 0; 1332 } 1333 1334 /* Free IRQ as IRQ pin is used as output in the suspend sequence */ 1335 goodix_free_irq(ts); 1336 1337 /* Output LOW on the INT pin for 5 ms */ 1338 error = goodix_irq_direction_output(ts, 0); 1339 if (error) { 1340 goodix_request_irq(ts); 1341 return error; 1342 } 1343 1344 usleep_range(5000, 6000); 1345 1346 error = goodix_i2c_write_u8(ts->client, GOODIX_REG_COMMAND, 1347 GOODIX_CMD_SCREEN_OFF); 1348 if (error) { 1349 dev_err(&ts->client->dev, "Screen off command failed\n"); 1350 goodix_irq_direction_input(ts); 1351 goodix_request_irq(ts); 1352 return -EAGAIN; 1353 } 1354 1355 /* 1356 * The datasheet specifies that the interval between sending screen-off 1357 * command and wake-up should be longer than 58 ms. To avoid waking up 1358 * sooner, delay 58ms here. 1359 */ 1360 msleep(58); 1361 return 0; 1362 } 1363 1364 static int __maybe_unused goodix_resume(struct device *dev) 1365 { 1366 struct i2c_client *client = to_i2c_client(dev); 1367 struct goodix_ts_data *ts = i2c_get_clientdata(client); 1368 u8 config_ver; 1369 int error; 1370 1371 if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) { 1372 enable_irq(client->irq); 1373 return 0; 1374 } 1375 1376 /* 1377 * Exit sleep mode by outputting HIGH level to INT pin 1378 * for 2ms~5ms. 1379 */ 1380 error = goodix_irq_direction_output(ts, 1); 1381 if (error) 1382 return error; 1383 1384 usleep_range(2000, 5000); 1385 1386 error = goodix_int_sync(ts); 1387 if (error) 1388 return error; 1389 1390 error = goodix_i2c_read(ts->client, ts->chip->config_addr, 1391 &config_ver, 1); 1392 if (error) 1393 dev_warn(dev, "Error reading config version: %d, resetting controller\n", 1394 error); 1395 else if (config_ver != ts->config[0]) 1396 dev_info(dev, "Config version mismatch %d != %d, resetting controller\n", 1397 config_ver, ts->config[0]); 1398 1399 if (error != 0 || config_ver != ts->config[0]) { 1400 error = goodix_reset(ts); 1401 if (error) { 1402 dev_err(dev, "Controller reset failed.\n"); 1403 return error; 1404 } 1405 1406 error = goodix_send_cfg(ts, ts->config, ts->chip->config_len); 1407 if (error) 1408 return error; 1409 } 1410 1411 error = goodix_request_irq(ts); 1412 if (error) 1413 return error; 1414 1415 return 0; 1416 } 1417 1418 static SIMPLE_DEV_PM_OPS(goodix_pm_ops, goodix_suspend, goodix_resume); 1419 1420 static const struct i2c_device_id goodix_ts_id[] = { 1421 { "GDIX1001:00", 0 }, 1422 { } 1423 }; 1424 MODULE_DEVICE_TABLE(i2c, goodix_ts_id); 1425 1426 #ifdef CONFIG_ACPI 1427 static const struct acpi_device_id goodix_acpi_match[] = { 1428 { "GDIX1001", 0 }, 1429 { "GDIX1002", 0 }, 1430 { } 1431 }; 1432 MODULE_DEVICE_TABLE(acpi, goodix_acpi_match); 1433 #endif 1434 1435 #ifdef CONFIG_OF 1436 static const struct of_device_id goodix_of_match[] = { 1437 { .compatible = "goodix,gt1151" }, 1438 { .compatible = "goodix,gt5663" }, 1439 { .compatible = "goodix,gt5688" }, 1440 { .compatible = "goodix,gt911" }, 1441 { .compatible = "goodix,gt9110" }, 1442 { .compatible = "goodix,gt912" }, 1443 { .compatible = "goodix,gt9147" }, 1444 { .compatible = "goodix,gt917s" }, 1445 { .compatible = "goodix,gt927" }, 1446 { .compatible = "goodix,gt9271" }, 1447 { .compatible = "goodix,gt928" }, 1448 { .compatible = "goodix,gt967" }, 1449 { } 1450 }; 1451 MODULE_DEVICE_TABLE(of, goodix_of_match); 1452 #endif 1453 1454 static struct i2c_driver goodix_ts_driver = { 1455 .probe = goodix_ts_probe, 1456 .remove = goodix_ts_remove, 1457 .id_table = goodix_ts_id, 1458 .driver = { 1459 .name = "Goodix-TS", 1460 .acpi_match_table = ACPI_PTR(goodix_acpi_match), 1461 .of_match_table = of_match_ptr(goodix_of_match), 1462 .pm = &goodix_pm_ops, 1463 }, 1464 }; 1465 module_i2c_driver(goodix_ts_driver); 1466 1467 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>"); 1468 MODULE_AUTHOR("Bastien Nocera <hadess@hadess.net>"); 1469 MODULE_DESCRIPTION("Goodix touchscreen driver"); 1470 MODULE_LICENSE("GPL v2"); 1471