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