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/slab.h> 22 #include <linux/acpi.h> 23 #include <linux/of.h> 24 #include <asm/unaligned.h> 25 #include "goodix.h" 26 27 #define GOODIX_GPIO_INT_NAME "irq" 28 #define GOODIX_GPIO_RST_NAME "reset" 29 30 #define GOODIX_MAX_HEIGHT 4096 31 #define GOODIX_MAX_WIDTH 4096 32 #define GOODIX_INT_TRIGGER 1 33 #define GOODIX_CONTACT_SIZE 8 34 #define GOODIX_MAX_CONTACT_SIZE 9 35 #define GOODIX_MAX_CONTACTS 10 36 37 #define GOODIX_CONFIG_MIN_LENGTH 186 38 #define GOODIX_CONFIG_911_LENGTH 186 39 #define GOODIX_CONFIG_967_LENGTH 228 40 #define GOODIX_CONFIG_GT9X_LENGTH 240 41 42 #define GOODIX_BUFFER_STATUS_READY BIT(7) 43 #define GOODIX_HAVE_KEY BIT(4) 44 #define GOODIX_BUFFER_STATUS_TIMEOUT 20 45 46 #define RESOLUTION_LOC 1 47 #define MAX_CONTACTS_LOC 5 48 #define TRIGGER_LOC 6 49 50 /* Our special handling for GPIO accesses through ACPI is x86 specific */ 51 #if defined CONFIG_X86 && defined CONFIG_ACPI 52 #define ACPI_GPIO_SUPPORT 53 #endif 54 55 struct goodix_chip_id { 56 const char *id; 57 const struct goodix_chip_data *data; 58 }; 59 60 static int goodix_check_cfg_8(struct goodix_ts_data *ts, 61 const u8 *cfg, int len); 62 static int goodix_check_cfg_16(struct goodix_ts_data *ts, 63 const u8 *cfg, int len); 64 static void goodix_calc_cfg_checksum_8(struct goodix_ts_data *ts); 65 static void goodix_calc_cfg_checksum_16(struct goodix_ts_data *ts); 66 67 static const struct goodix_chip_data gt1x_chip_data = { 68 .config_addr = GOODIX_GT1X_REG_CONFIG_DATA, 69 .config_len = GOODIX_CONFIG_GT9X_LENGTH, 70 .check_config = goodix_check_cfg_16, 71 .calc_config_checksum = goodix_calc_cfg_checksum_16, 72 }; 73 74 static const struct goodix_chip_data gt911_chip_data = { 75 .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 76 .config_len = GOODIX_CONFIG_911_LENGTH, 77 .check_config = goodix_check_cfg_8, 78 .calc_config_checksum = goodix_calc_cfg_checksum_8, 79 }; 80 81 static const struct goodix_chip_data gt967_chip_data = { 82 .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 83 .config_len = GOODIX_CONFIG_967_LENGTH, 84 .check_config = goodix_check_cfg_8, 85 .calc_config_checksum = goodix_calc_cfg_checksum_8, 86 }; 87 88 static const struct goodix_chip_data gt9x_chip_data = { 89 .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 90 .config_len = GOODIX_CONFIG_GT9X_LENGTH, 91 .check_config = goodix_check_cfg_8, 92 .calc_config_checksum = goodix_calc_cfg_checksum_8, 93 }; 94 95 static const struct goodix_chip_id goodix_chip_ids[] = { 96 { .id = "1151", .data = >1x_chip_data }, 97 { .id = "5663", .data = >1x_chip_data }, 98 { .id = "5688", .data = >1x_chip_data }, 99 { .id = "917S", .data = >1x_chip_data }, 100 { .id = "9286", .data = >1x_chip_data }, 101 102 { .id = "911", .data = >911_chip_data }, 103 { .id = "9271", .data = >911_chip_data }, 104 { .id = "9110", .data = >911_chip_data }, 105 { .id = "9111", .data = >911_chip_data }, 106 { .id = "927", .data = >911_chip_data }, 107 { .id = "928", .data = >911_chip_data }, 108 109 { .id = "912", .data = >967_chip_data }, 110 { .id = "9147", .data = >967_chip_data }, 111 { .id = "967", .data = >967_chip_data }, 112 { } 113 }; 114 115 static const unsigned long goodix_irq_flags[] = { 116 IRQ_TYPE_EDGE_RISING, 117 IRQ_TYPE_EDGE_FALLING, 118 IRQ_TYPE_LEVEL_LOW, 119 IRQ_TYPE_LEVEL_HIGH, 120 }; 121 122 static const struct dmi_system_id nine_bytes_report[] = { 123 #if defined(CONFIG_DMI) && defined(CONFIG_X86) 124 { 125 .ident = "Lenovo YogaBook", 126 /* YB1-X91L/F and YB1-X90L/F */ 127 .matches = { 128 DMI_MATCH(DMI_PRODUCT_NAME, "Lenovo YB1-X9") 129 } 130 }, 131 #endif 132 {} 133 }; 134 135 /* 136 * Those tablets have their x coordinate inverted 137 */ 138 static const struct dmi_system_id inverted_x_screen[] = { 139 #if defined(CONFIG_DMI) && defined(CONFIG_X86) 140 { 141 .ident = "Cube I15-TC", 142 .matches = { 143 DMI_MATCH(DMI_SYS_VENDOR, "Cube"), 144 DMI_MATCH(DMI_PRODUCT_NAME, "I15-TC") 145 }, 146 }, 147 #endif 148 {} 149 }; 150 151 /** 152 * goodix_i2c_read - read data from a register of the i2c slave device. 153 * 154 * @client: i2c device. 155 * @reg: the register to read from. 156 * @buf: raw write data buffer. 157 * @len: length of the buffer to write 158 */ 159 int goodix_i2c_read(struct i2c_client *client, u16 reg, u8 *buf, int len) 160 { 161 struct i2c_msg msgs[2]; 162 __be16 wbuf = cpu_to_be16(reg); 163 int ret; 164 165 msgs[0].flags = 0; 166 msgs[0].addr = client->addr; 167 msgs[0].len = 2; 168 msgs[0].buf = (u8 *)&wbuf; 169 170 msgs[1].flags = I2C_M_RD; 171 msgs[1].addr = client->addr; 172 msgs[1].len = len; 173 msgs[1].buf = buf; 174 175 ret = i2c_transfer(client->adapter, msgs, 2); 176 if (ret >= 0) 177 ret = (ret == ARRAY_SIZE(msgs) ? 0 : -EIO); 178 179 if (ret) 180 dev_err(&client->dev, "Error reading %d bytes from 0x%04x: %d\n", 181 len, reg, ret); 182 return ret; 183 } 184 185 /** 186 * goodix_i2c_write - write data to a register of the i2c slave device. 187 * 188 * @client: i2c device. 189 * @reg: the register to write to. 190 * @buf: raw data buffer to write. 191 * @len: length of the buffer to write 192 */ 193 int goodix_i2c_write(struct i2c_client *client, u16 reg, const u8 *buf, int len) 194 { 195 u8 *addr_buf; 196 struct i2c_msg msg; 197 int ret; 198 199 addr_buf = kmalloc(len + 2, GFP_KERNEL); 200 if (!addr_buf) 201 return -ENOMEM; 202 203 addr_buf[0] = reg >> 8; 204 addr_buf[1] = reg & 0xFF; 205 memcpy(&addr_buf[2], buf, len); 206 207 msg.flags = 0; 208 msg.addr = client->addr; 209 msg.buf = addr_buf; 210 msg.len = len + 2; 211 212 ret = i2c_transfer(client->adapter, &msg, 1); 213 if (ret >= 0) 214 ret = (ret == 1 ? 0 : -EIO); 215 216 kfree(addr_buf); 217 218 if (ret) 219 dev_err(&client->dev, "Error writing %d bytes to 0x%04x: %d\n", 220 len, reg, ret); 221 return ret; 222 } 223 224 int goodix_i2c_write_u8(struct i2c_client *client, u16 reg, u8 value) 225 { 226 return goodix_i2c_write(client, reg, &value, sizeof(value)); 227 } 228 229 static const struct goodix_chip_data *goodix_get_chip_data(const char *id) 230 { 231 unsigned int i; 232 233 for (i = 0; goodix_chip_ids[i].id; i++) { 234 if (!strcmp(goodix_chip_ids[i].id, id)) 235 return goodix_chip_ids[i].data; 236 } 237 238 return >9x_chip_data; 239 } 240 241 static int goodix_ts_read_input_report(struct goodix_ts_data *ts, u8 *data) 242 { 243 unsigned long max_timeout; 244 int touch_num; 245 int error; 246 u16 addr = GOODIX_READ_COOR_ADDR; 247 /* 248 * We are going to read 1-byte header, 249 * ts->contact_size * max(1, touch_num) bytes of coordinates 250 * and 1-byte footer which contains the touch-key code. 251 */ 252 const int header_contact_keycode_size = 1 + ts->contact_size + 1; 253 254 /* 255 * The 'buffer status' bit, which indicates that the data is valid, is 256 * not set as soon as the interrupt is raised, but slightly after. 257 * This takes around 10 ms to happen, so we poll for 20 ms. 258 */ 259 max_timeout = jiffies + msecs_to_jiffies(GOODIX_BUFFER_STATUS_TIMEOUT); 260 do { 261 error = goodix_i2c_read(ts->client, addr, data, 262 header_contact_keycode_size); 263 if (error) 264 return error; 265 266 if (data[0] & GOODIX_BUFFER_STATUS_READY) { 267 touch_num = data[0] & 0x0f; 268 if (touch_num > ts->max_touch_num) 269 return -EPROTO; 270 271 if (touch_num > 1) { 272 addr += header_contact_keycode_size; 273 data += header_contact_keycode_size; 274 error = goodix_i2c_read(ts->client, 275 addr, data, 276 ts->contact_size * 277 (touch_num - 1)); 278 if (error) 279 return error; 280 } 281 282 return touch_num; 283 } 284 285 if (data[0] == 0 && ts->firmware_name) { 286 if (goodix_handle_fw_request(ts)) 287 return 0; 288 } 289 290 usleep_range(1000, 2000); /* Poll every 1 - 2 ms */ 291 } while (time_before(jiffies, max_timeout)); 292 293 /* 294 * The Goodix panel will send spurious interrupts after a 295 * 'finger up' event, which will always cause a timeout. 296 */ 297 return -ENOMSG; 298 } 299 300 static int goodix_create_pen_input(struct goodix_ts_data *ts) 301 { 302 struct device *dev = &ts->client->dev; 303 struct input_dev *input; 304 305 input = devm_input_allocate_device(dev); 306 if (!input) 307 return -ENOMEM; 308 309 input_copy_abs(input, ABS_X, ts->input_dev, ABS_MT_POSITION_X); 310 input_copy_abs(input, ABS_Y, ts->input_dev, ABS_MT_POSITION_Y); 311 /* 312 * The resolution of these touchscreens is about 10 units/mm, the actual 313 * resolution does not matter much since we set INPUT_PROP_DIRECT. 314 * Userspace wants something here though, so just set it to 10 units/mm. 315 */ 316 input_abs_set_res(input, ABS_X, 10); 317 input_abs_set_res(input, ABS_Y, 10); 318 input_set_abs_params(input, ABS_PRESSURE, 0, 255, 0, 0); 319 320 input_set_capability(input, EV_KEY, BTN_TOUCH); 321 input_set_capability(input, EV_KEY, BTN_TOOL_PEN); 322 input_set_capability(input, EV_KEY, BTN_STYLUS); 323 input_set_capability(input, EV_KEY, BTN_STYLUS2); 324 __set_bit(INPUT_PROP_DIRECT, input->propbit); 325 326 input->name = "Goodix Active Pen"; 327 input->phys = "input/pen"; 328 input->id.bustype = BUS_I2C; 329 input->id.vendor = 0x0416; 330 if (kstrtou16(ts->id, 10, &input->id.product)) 331 input->id.product = 0x1001; 332 input->id.version = ts->version; 333 334 ts->input_pen = input; 335 return 0; 336 } 337 338 static void goodix_ts_report_pen_down(struct goodix_ts_data *ts, u8 *data) 339 { 340 int input_x, input_y, input_w, error; 341 u8 key_value; 342 343 if (!ts->pen_input_registered) { 344 error = input_register_device(ts->input_pen); 345 ts->pen_input_registered = (error == 0) ? 1 : error; 346 } 347 348 if (ts->pen_input_registered < 0) 349 return; 350 351 if (ts->contact_size == 9) { 352 input_x = get_unaligned_le16(&data[4]); 353 input_y = get_unaligned_le16(&data[6]); 354 input_w = get_unaligned_le16(&data[8]); 355 } else { 356 input_x = get_unaligned_le16(&data[2]); 357 input_y = get_unaligned_le16(&data[4]); 358 input_w = get_unaligned_le16(&data[6]); 359 } 360 361 touchscreen_report_pos(ts->input_pen, &ts->prop, input_x, input_y, false); 362 input_report_abs(ts->input_pen, ABS_PRESSURE, input_w); 363 364 input_report_key(ts->input_pen, BTN_TOUCH, 1); 365 input_report_key(ts->input_pen, BTN_TOOL_PEN, 1); 366 367 if (data[0] & GOODIX_HAVE_KEY) { 368 key_value = data[1 + ts->contact_size]; 369 input_report_key(ts->input_pen, BTN_STYLUS, key_value & 0x10); 370 input_report_key(ts->input_pen, BTN_STYLUS2, key_value & 0x20); 371 } else { 372 input_report_key(ts->input_pen, BTN_STYLUS, 0); 373 input_report_key(ts->input_pen, BTN_STYLUS2, 0); 374 } 375 376 input_sync(ts->input_pen); 377 } 378 379 static void goodix_ts_report_pen_up(struct goodix_ts_data *ts) 380 { 381 if (!ts->input_pen) 382 return; 383 384 input_report_key(ts->input_pen, BTN_TOUCH, 0); 385 input_report_key(ts->input_pen, BTN_TOOL_PEN, 0); 386 input_report_key(ts->input_pen, BTN_STYLUS, 0); 387 input_report_key(ts->input_pen, BTN_STYLUS2, 0); 388 389 input_sync(ts->input_pen); 390 } 391 392 static void goodix_ts_report_touch_8b(struct goodix_ts_data *ts, u8 *coor_data) 393 { 394 int id = coor_data[0] & 0x0F; 395 int input_x = get_unaligned_le16(&coor_data[1]); 396 int input_y = get_unaligned_le16(&coor_data[3]); 397 int input_w = get_unaligned_le16(&coor_data[5]); 398 399 input_mt_slot(ts->input_dev, id); 400 input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true); 401 touchscreen_report_pos(ts->input_dev, &ts->prop, 402 input_x, input_y, true); 403 input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w); 404 input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w); 405 } 406 407 static void goodix_ts_report_touch_9b(struct goodix_ts_data *ts, u8 *coor_data) 408 { 409 int id = coor_data[1] & 0x0F; 410 int input_x = get_unaligned_le16(&coor_data[3]); 411 int input_y = get_unaligned_le16(&coor_data[5]); 412 int input_w = get_unaligned_le16(&coor_data[7]); 413 414 input_mt_slot(ts->input_dev, id); 415 input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true); 416 touchscreen_report_pos(ts->input_dev, &ts->prop, 417 input_x, input_y, true); 418 input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w); 419 input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w); 420 } 421 422 static void goodix_ts_release_keys(struct goodix_ts_data *ts) 423 { 424 int i; 425 426 for (i = 0; i < GOODIX_MAX_KEYS; i++) 427 input_report_key(ts->input_dev, ts->keymap[i], 0); 428 } 429 430 static void goodix_ts_report_key(struct goodix_ts_data *ts, u8 *data) 431 { 432 int touch_num; 433 u8 key_value; 434 int i; 435 436 if (data[0] & GOODIX_HAVE_KEY) { 437 touch_num = data[0] & 0x0f; 438 key_value = data[1 + ts->contact_size * touch_num]; 439 for (i = 0; i < GOODIX_MAX_KEYS; i++) 440 if (key_value & BIT(i)) 441 input_report_key(ts->input_dev, 442 ts->keymap[i], 1); 443 } else { 444 goodix_ts_release_keys(ts); 445 } 446 } 447 448 /** 449 * goodix_process_events - Process incoming events 450 * 451 * @ts: our goodix_ts_data pointer 452 * 453 * Called when the IRQ is triggered. Read the current device state, and push 454 * the input events to the user space. 455 */ 456 static void goodix_process_events(struct goodix_ts_data *ts) 457 { 458 u8 point_data[2 + GOODIX_MAX_CONTACT_SIZE * GOODIX_MAX_CONTACTS]; 459 int touch_num; 460 int i; 461 462 touch_num = goodix_ts_read_input_report(ts, point_data); 463 if (touch_num < 0) 464 return; 465 466 /* The pen being down is always reported as a single touch */ 467 if (touch_num == 1 && (point_data[1] & 0x80)) { 468 goodix_ts_report_pen_down(ts, point_data); 469 goodix_ts_release_keys(ts); 470 goto sync; /* Release any previously registered touches */ 471 } else { 472 goodix_ts_report_pen_up(ts); 473 } 474 475 goodix_ts_report_key(ts, point_data); 476 477 for (i = 0; i < touch_num; i++) 478 if (ts->contact_size == 9) 479 goodix_ts_report_touch_9b(ts, 480 &point_data[1 + ts->contact_size * i]); 481 else 482 goodix_ts_report_touch_8b(ts, 483 &point_data[1 + ts->contact_size * i]); 484 485 sync: 486 input_mt_sync_frame(ts->input_dev); 487 input_sync(ts->input_dev); 488 } 489 490 /** 491 * goodix_ts_irq_handler - The IRQ handler 492 * 493 * @irq: interrupt number. 494 * @dev_id: private data pointer. 495 */ 496 static irqreturn_t goodix_ts_irq_handler(int irq, void *dev_id) 497 { 498 struct goodix_ts_data *ts = dev_id; 499 500 goodix_process_events(ts); 501 goodix_i2c_write_u8(ts->client, GOODIX_READ_COOR_ADDR, 0); 502 503 return IRQ_HANDLED; 504 } 505 506 static void goodix_free_irq(struct goodix_ts_data *ts) 507 { 508 devm_free_irq(&ts->client->dev, ts->client->irq, ts); 509 } 510 511 static int goodix_request_irq(struct goodix_ts_data *ts) 512 { 513 return devm_request_threaded_irq(&ts->client->dev, ts->client->irq, 514 NULL, goodix_ts_irq_handler, 515 ts->irq_flags, ts->client->name, ts); 516 } 517 518 static int goodix_check_cfg_8(struct goodix_ts_data *ts, const u8 *cfg, int len) 519 { 520 int i, raw_cfg_len = len - 2; 521 u8 check_sum = 0; 522 523 for (i = 0; i < raw_cfg_len; i++) 524 check_sum += cfg[i]; 525 check_sum = (~check_sum) + 1; 526 if (check_sum != cfg[raw_cfg_len]) { 527 dev_err(&ts->client->dev, 528 "The checksum of the config fw is not correct"); 529 return -EINVAL; 530 } 531 532 if (cfg[raw_cfg_len + 1] != 1) { 533 dev_err(&ts->client->dev, 534 "Config fw must have Config_Fresh register set"); 535 return -EINVAL; 536 } 537 538 return 0; 539 } 540 541 static void goodix_calc_cfg_checksum_8(struct goodix_ts_data *ts) 542 { 543 int i, raw_cfg_len = ts->chip->config_len - 2; 544 u8 check_sum = 0; 545 546 for (i = 0; i < raw_cfg_len; i++) 547 check_sum += ts->config[i]; 548 check_sum = (~check_sum) + 1; 549 550 ts->config[raw_cfg_len] = check_sum; 551 ts->config[raw_cfg_len + 1] = 1; /* Set "config_fresh" bit */ 552 } 553 554 static int goodix_check_cfg_16(struct goodix_ts_data *ts, const u8 *cfg, 555 int len) 556 { 557 int i, raw_cfg_len = len - 3; 558 u16 check_sum = 0; 559 560 for (i = 0; i < raw_cfg_len; i += 2) 561 check_sum += get_unaligned_be16(&cfg[i]); 562 check_sum = (~check_sum) + 1; 563 if (check_sum != get_unaligned_be16(&cfg[raw_cfg_len])) { 564 dev_err(&ts->client->dev, 565 "The checksum of the config fw is not correct"); 566 return -EINVAL; 567 } 568 569 if (cfg[raw_cfg_len + 2] != 1) { 570 dev_err(&ts->client->dev, 571 "Config fw must have Config_Fresh register set"); 572 return -EINVAL; 573 } 574 575 return 0; 576 } 577 578 static void goodix_calc_cfg_checksum_16(struct goodix_ts_data *ts) 579 { 580 int i, raw_cfg_len = ts->chip->config_len - 3; 581 u16 check_sum = 0; 582 583 for (i = 0; i < raw_cfg_len; i += 2) 584 check_sum += get_unaligned_be16(&ts->config[i]); 585 check_sum = (~check_sum) + 1; 586 587 put_unaligned_be16(check_sum, &ts->config[raw_cfg_len]); 588 ts->config[raw_cfg_len + 2] = 1; /* Set "config_fresh" bit */ 589 } 590 591 /** 592 * goodix_check_cfg - Checks if config fw is valid 593 * 594 * @ts: goodix_ts_data pointer 595 * @cfg: firmware config data 596 * @len: config data length 597 */ 598 static int goodix_check_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len) 599 { 600 if (len < GOODIX_CONFIG_MIN_LENGTH || 601 len > GOODIX_CONFIG_MAX_LENGTH) { 602 dev_err(&ts->client->dev, 603 "The length of the config fw is not correct"); 604 return -EINVAL; 605 } 606 607 return ts->chip->check_config(ts, cfg, len); 608 } 609 610 /** 611 * goodix_send_cfg - Write fw config to device 612 * 613 * @ts: goodix_ts_data pointer 614 * @cfg: config firmware to write to device 615 * @len: config data length 616 */ 617 int goodix_send_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len) 618 { 619 int error; 620 621 error = goodix_check_cfg(ts, cfg, len); 622 if (error) 623 return error; 624 625 error = goodix_i2c_write(ts->client, ts->chip->config_addr, cfg, len); 626 if (error) 627 return error; 628 629 dev_dbg(&ts->client->dev, "Config sent successfully."); 630 631 /* Let the firmware reconfigure itself, so sleep for 10ms */ 632 usleep_range(10000, 11000); 633 634 return 0; 635 } 636 637 #ifdef ACPI_GPIO_SUPPORT 638 static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts) 639 { 640 acpi_handle handle = ACPI_HANDLE(&ts->client->dev); 641 acpi_status status; 642 643 status = acpi_evaluate_object(handle, "INTI", NULL, NULL); 644 return ACPI_SUCCESS(status) ? 0 : -EIO; 645 } 646 647 static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value) 648 { 649 acpi_handle handle = ACPI_HANDLE(&ts->client->dev); 650 acpi_status status; 651 652 status = acpi_execute_simple_method(handle, "INTO", value); 653 return ACPI_SUCCESS(status) ? 0 : -EIO; 654 } 655 #else 656 static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts) 657 { 658 dev_err(&ts->client->dev, 659 "%s called on device without ACPI support\n", __func__); 660 return -EINVAL; 661 } 662 663 static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value) 664 { 665 dev_err(&ts->client->dev, 666 "%s called on device without ACPI support\n", __func__); 667 return -EINVAL; 668 } 669 #endif 670 671 static int goodix_irq_direction_output(struct goodix_ts_data *ts, int value) 672 { 673 switch (ts->irq_pin_access_method) { 674 case IRQ_PIN_ACCESS_NONE: 675 dev_err(&ts->client->dev, 676 "%s called without an irq_pin_access_method set\n", 677 __func__); 678 return -EINVAL; 679 case IRQ_PIN_ACCESS_GPIO: 680 return gpiod_direction_output(ts->gpiod_int, value); 681 case IRQ_PIN_ACCESS_ACPI_GPIO: 682 /* 683 * The IRQ pin triggers on a falling edge, so its gets marked 684 * as active-low, use output_raw to avoid the value inversion. 685 */ 686 return gpiod_direction_output_raw(ts->gpiod_int, value); 687 case IRQ_PIN_ACCESS_ACPI_METHOD: 688 return goodix_pin_acpi_output_method(ts, value); 689 } 690 691 return -EINVAL; /* Never reached */ 692 } 693 694 static int goodix_irq_direction_input(struct goodix_ts_data *ts) 695 { 696 switch (ts->irq_pin_access_method) { 697 case IRQ_PIN_ACCESS_NONE: 698 dev_err(&ts->client->dev, 699 "%s called without an irq_pin_access_method set\n", 700 __func__); 701 return -EINVAL; 702 case IRQ_PIN_ACCESS_GPIO: 703 return gpiod_direction_input(ts->gpiod_int); 704 case IRQ_PIN_ACCESS_ACPI_GPIO: 705 return gpiod_direction_input(ts->gpiod_int); 706 case IRQ_PIN_ACCESS_ACPI_METHOD: 707 return goodix_pin_acpi_direction_input(ts); 708 } 709 710 return -EINVAL; /* Never reached */ 711 } 712 713 int goodix_int_sync(struct goodix_ts_data *ts) 714 { 715 int error; 716 717 error = goodix_irq_direction_output(ts, 0); 718 if (error) 719 goto error; 720 721 msleep(50); /* T5: 50ms */ 722 723 error = goodix_irq_direction_input(ts); 724 if (error) 725 goto error; 726 727 return 0; 728 729 error: 730 dev_err(&ts->client->dev, "Controller irq sync failed.\n"); 731 return error; 732 } 733 734 /** 735 * goodix_reset_no_int_sync - Reset device, leaving interrupt line in output mode 736 * 737 * @ts: goodix_ts_data pointer 738 */ 739 int goodix_reset_no_int_sync(struct goodix_ts_data *ts) 740 { 741 int error; 742 743 /* begin select I2C slave addr */ 744 error = gpiod_direction_output(ts->gpiod_rst, 0); 745 if (error) 746 goto error; 747 748 msleep(20); /* T2: > 10ms */ 749 750 /* HIGH: 0x28/0x29, LOW: 0xBA/0xBB */ 751 error = goodix_irq_direction_output(ts, ts->client->addr == 0x14); 752 if (error) 753 goto error; 754 755 usleep_range(100, 2000); /* T3: > 100us */ 756 757 error = gpiod_direction_output(ts->gpiod_rst, 1); 758 if (error) 759 goto error; 760 761 usleep_range(6000, 10000); /* T4: > 5ms */ 762 763 /* 764 * Put the reset pin back in to input / high-impedance mode to save 765 * power. Only do this in the non ACPI case since some ACPI boards 766 * don't have a pull-up, so there the reset pin must stay active-high. 767 */ 768 if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_GPIO) { 769 error = gpiod_direction_input(ts->gpiod_rst); 770 if (error) 771 goto error; 772 } 773 774 return 0; 775 776 error: 777 dev_err(&ts->client->dev, "Controller reset failed.\n"); 778 return error; 779 } 780 781 /** 782 * goodix_reset - Reset device during power on 783 * 784 * @ts: goodix_ts_data pointer 785 */ 786 static int goodix_reset(struct goodix_ts_data *ts) 787 { 788 int error; 789 790 error = goodix_reset_no_int_sync(ts); 791 if (error) 792 return error; 793 794 return goodix_int_sync(ts); 795 } 796 797 #ifdef ACPI_GPIO_SUPPORT 798 #include <asm/cpu_device_id.h> 799 #include <asm/intel-family.h> 800 801 static const struct x86_cpu_id baytrail_cpu_ids[] = { 802 { X86_VENDOR_INTEL, 6, INTEL_FAM6_ATOM_SILVERMONT, X86_FEATURE_ANY, }, 803 {} 804 }; 805 806 static inline bool is_byt(void) 807 { 808 const struct x86_cpu_id *id = x86_match_cpu(baytrail_cpu_ids); 809 810 return !!id; 811 } 812 813 static const struct acpi_gpio_params first_gpio = { 0, 0, false }; 814 static const struct acpi_gpio_params second_gpio = { 1, 0, false }; 815 816 static const struct acpi_gpio_mapping acpi_goodix_int_first_gpios[] = { 817 { GOODIX_GPIO_INT_NAME "-gpios", &first_gpio, 1 }, 818 { GOODIX_GPIO_RST_NAME "-gpios", &second_gpio, 1 }, 819 { }, 820 }; 821 822 static const struct acpi_gpio_mapping acpi_goodix_int_last_gpios[] = { 823 { GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 }, 824 { GOODIX_GPIO_INT_NAME "-gpios", &second_gpio, 1 }, 825 { }, 826 }; 827 828 static const struct acpi_gpio_mapping acpi_goodix_reset_only_gpios[] = { 829 { GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 }, 830 { }, 831 }; 832 833 static int goodix_resource(struct acpi_resource *ares, void *data) 834 { 835 struct goodix_ts_data *ts = data; 836 struct device *dev = &ts->client->dev; 837 struct acpi_resource_gpio *gpio; 838 839 switch (ares->type) { 840 case ACPI_RESOURCE_TYPE_GPIO: 841 gpio = &ares->data.gpio; 842 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) { 843 if (ts->gpio_int_idx == -1) { 844 ts->gpio_int_idx = ts->gpio_count; 845 } else { 846 dev_err(dev, "More then one GpioInt resource, ignoring ACPI GPIO resources\n"); 847 ts->gpio_int_idx = -2; 848 } 849 } 850 ts->gpio_count++; 851 break; 852 default: 853 break; 854 } 855 856 return 0; 857 } 858 859 /* 860 * This function gets called in case we fail to get the irq GPIO directly 861 * because the ACPI tables lack GPIO-name to APCI _CRS index mappings 862 * (no _DSD UUID daffd814-6eba-4d8c-8a91-bc9bbf4aa301 data). 863 * In that case we add our own mapping and then goodix_get_gpio_config() 864 * retries to get the GPIOs based on the added mapping. 865 */ 866 static int goodix_add_acpi_gpio_mappings(struct goodix_ts_data *ts) 867 { 868 const struct acpi_gpio_mapping *gpio_mapping = NULL; 869 struct device *dev = &ts->client->dev; 870 LIST_HEAD(resources); 871 int ret; 872 873 ts->gpio_count = 0; 874 ts->gpio_int_idx = -1; 875 ret = acpi_dev_get_resources(ACPI_COMPANION(dev), &resources, 876 goodix_resource, ts); 877 if (ret < 0) { 878 dev_err(dev, "Error getting ACPI resources: %d\n", ret); 879 return ret; 880 } 881 882 acpi_dev_free_resource_list(&resources); 883 884 if (ts->gpio_count == 2 && ts->gpio_int_idx == 0) { 885 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO; 886 gpio_mapping = acpi_goodix_int_first_gpios; 887 } else if (ts->gpio_count == 2 && ts->gpio_int_idx == 1) { 888 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO; 889 gpio_mapping = acpi_goodix_int_last_gpios; 890 } else if (ts->gpio_count == 1 && ts->gpio_int_idx == -1 && 891 acpi_has_method(ACPI_HANDLE(dev), "INTI") && 892 acpi_has_method(ACPI_HANDLE(dev), "INTO")) { 893 dev_info(dev, "Using ACPI INTI and INTO methods for IRQ pin access\n"); 894 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_METHOD; 895 gpio_mapping = acpi_goodix_reset_only_gpios; 896 } else if (is_byt() && ts->gpio_count == 2 && ts->gpio_int_idx == -1) { 897 dev_info(dev, "No ACPI GpioInt resource, assuming that the GPIO order is reset, int\n"); 898 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO; 899 gpio_mapping = acpi_goodix_int_last_gpios; 900 } else { 901 dev_warn(dev, "Unexpected ACPI resources: gpio_count %d, gpio_int_idx %d\n", 902 ts->gpio_count, ts->gpio_int_idx); 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 int 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 return 0; 1394 } 1395 1396 static int __maybe_unused goodix_suspend(struct device *dev) 1397 { 1398 struct i2c_client *client = to_i2c_client(dev); 1399 struct goodix_ts_data *ts = i2c_get_clientdata(client); 1400 int error; 1401 1402 if (ts->load_cfg_from_disk) 1403 wait_for_completion(&ts->firmware_loading_complete); 1404 1405 /* We need gpio pins to suspend/resume */ 1406 if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) { 1407 disable_irq(client->irq); 1408 return 0; 1409 } 1410 1411 /* Free IRQ as IRQ pin is used as output in the suspend sequence */ 1412 goodix_free_irq(ts); 1413 1414 /* Save reference (calibration) info if necessary */ 1415 goodix_save_bak_ref(ts); 1416 1417 /* Output LOW on the INT pin for 5 ms */ 1418 error = goodix_irq_direction_output(ts, 0); 1419 if (error) { 1420 goodix_request_irq(ts); 1421 return error; 1422 } 1423 1424 usleep_range(5000, 6000); 1425 1426 error = goodix_i2c_write_u8(ts->client, GOODIX_REG_COMMAND, 1427 GOODIX_CMD_SCREEN_OFF); 1428 if (error) { 1429 goodix_irq_direction_input(ts); 1430 goodix_request_irq(ts); 1431 return -EAGAIN; 1432 } 1433 1434 /* 1435 * The datasheet specifies that the interval between sending screen-off 1436 * command and wake-up should be longer than 58 ms. To avoid waking up 1437 * sooner, delay 58ms here. 1438 */ 1439 msleep(58); 1440 return 0; 1441 } 1442 1443 static int __maybe_unused goodix_resume(struct device *dev) 1444 { 1445 struct i2c_client *client = to_i2c_client(dev); 1446 struct goodix_ts_data *ts = i2c_get_clientdata(client); 1447 u8 config_ver; 1448 int error; 1449 1450 if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) { 1451 enable_irq(client->irq); 1452 return 0; 1453 } 1454 1455 /* 1456 * Exit sleep mode by outputting HIGH level to INT pin 1457 * for 2ms~5ms. 1458 */ 1459 error = goodix_irq_direction_output(ts, 1); 1460 if (error) 1461 return error; 1462 1463 usleep_range(2000, 5000); 1464 1465 error = goodix_int_sync(ts); 1466 if (error) 1467 return error; 1468 1469 error = goodix_i2c_read(ts->client, ts->chip->config_addr, 1470 &config_ver, 1); 1471 if (!error && config_ver != ts->config[0]) 1472 dev_info(dev, "Config version mismatch %d != %d, resetting controller\n", 1473 config_ver, ts->config[0]); 1474 1475 if (error != 0 || config_ver != ts->config[0]) { 1476 error = goodix_reset(ts); 1477 if (error) 1478 return error; 1479 1480 error = goodix_send_cfg(ts, ts->config, ts->chip->config_len); 1481 if (error) 1482 return error; 1483 } 1484 1485 error = goodix_request_irq(ts); 1486 if (error) 1487 return error; 1488 1489 return 0; 1490 } 1491 1492 static SIMPLE_DEV_PM_OPS(goodix_pm_ops, goodix_suspend, goodix_resume); 1493 1494 static const struct i2c_device_id goodix_ts_id[] = { 1495 { "GDIX1001:00", 0 }, 1496 { } 1497 }; 1498 MODULE_DEVICE_TABLE(i2c, goodix_ts_id); 1499 1500 #ifdef CONFIG_ACPI 1501 static const struct acpi_device_id goodix_acpi_match[] = { 1502 { "GDIX1001", 0 }, 1503 { "GDIX1002", 0 }, 1504 { } 1505 }; 1506 MODULE_DEVICE_TABLE(acpi, goodix_acpi_match); 1507 #endif 1508 1509 #ifdef CONFIG_OF 1510 static const struct of_device_id goodix_of_match[] = { 1511 { .compatible = "goodix,gt1151" }, 1512 { .compatible = "goodix,gt5663" }, 1513 { .compatible = "goodix,gt5688" }, 1514 { .compatible = "goodix,gt911" }, 1515 { .compatible = "goodix,gt9110" }, 1516 { .compatible = "goodix,gt912" }, 1517 { .compatible = "goodix,gt9147" }, 1518 { .compatible = "goodix,gt917s" }, 1519 { .compatible = "goodix,gt927" }, 1520 { .compatible = "goodix,gt9271" }, 1521 { .compatible = "goodix,gt928" }, 1522 { .compatible = "goodix,gt9286" }, 1523 { .compatible = "goodix,gt967" }, 1524 { } 1525 }; 1526 MODULE_DEVICE_TABLE(of, goodix_of_match); 1527 #endif 1528 1529 static struct i2c_driver goodix_ts_driver = { 1530 .probe = goodix_ts_probe, 1531 .remove = goodix_ts_remove, 1532 .id_table = goodix_ts_id, 1533 .driver = { 1534 .name = "Goodix-TS", 1535 .acpi_match_table = ACPI_PTR(goodix_acpi_match), 1536 .of_match_table = of_match_ptr(goodix_of_match), 1537 .pm = &goodix_pm_ops, 1538 }, 1539 }; 1540 module_i2c_driver(goodix_ts_driver); 1541 1542 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>"); 1543 MODULE_AUTHOR("Bastien Nocera <hadess@hadess.net>"); 1544 MODULE_DESCRIPTION("Goodix touchscreen driver"); 1545 MODULE_LICENSE("GPL v2"); 1546