1 // SPDX-License-Identifier: GPL-2.0-only
3 * Driver for Goodix Touchscreens
5 * Copyright (c) 2014 Red Hat Inc.
6 * Copyright (c) 2015 K. Merker <merker@debian.org>
8 * This code is based on gt9xx.c authored by andrew@goodix.com:
10 * 2010 - 2012 Goodix Technology.
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>
24 #include <asm/unaligned.h>
27 #define GOODIX_GPIO_INT_NAME "irq"
28 #define GOODIX_GPIO_RST_NAME "reset"
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
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
42 #define GOODIX_BUFFER_STATUS_READY BIT(7)
43 #define GOODIX_HAVE_KEY BIT(4)
44 #define GOODIX_BUFFER_STATUS_TIMEOUT 20
46 #define RESOLUTION_LOC 1
47 #define MAX_CONTACTS_LOC 5
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
55 struct goodix_chip_id {
57 const struct goodix_chip_data *data;
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);
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,
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,
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,
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,
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 },
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 },
109 { .id = "912", .data = >967_chip_data },
110 { .id = "9147", .data = >967_chip_data },
111 { .id = "967", .data = >967_chip_data },
115 static const unsigned long goodix_irq_flags[] = {
116 IRQ_TYPE_EDGE_RISING,
117 IRQ_TYPE_EDGE_FALLING,
122 static const struct dmi_system_id nine_bytes_report[] = {
123 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
125 .ident = "Lenovo YogaBook",
126 /* YB1-X91L/F and YB1-X90L/F */
128 DMI_MATCH(DMI_PRODUCT_NAME, "Lenovo YB1-X9")
136 * Those tablets have their x coordinate inverted
138 static const struct dmi_system_id inverted_x_screen[] = {
139 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
141 .ident = "Cube I15-TC",
143 DMI_MATCH(DMI_SYS_VENDOR, "Cube"),
144 DMI_MATCH(DMI_PRODUCT_NAME, "I15-TC")
152 * goodix_i2c_read - read data from a register of the i2c slave device.
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
159 int goodix_i2c_read(struct i2c_client *client, u16 reg, u8 *buf, int len)
161 struct i2c_msg msgs[2];
162 __be16 wbuf = cpu_to_be16(reg);
166 msgs[0].addr = client->addr;
168 msgs[0].buf = (u8 *)&wbuf;
170 msgs[1].flags = I2C_M_RD;
171 msgs[1].addr = client->addr;
175 ret = i2c_transfer(client->adapter, msgs, 2);
176 return ret < 0 ? ret : (ret != ARRAY_SIZE(msgs) ? -EIO : 0);
180 * goodix_i2c_write - write data to a register of the i2c slave device.
182 * @client: i2c device.
183 * @reg: the register to write to.
184 * @buf: raw data buffer to write.
185 * @len: length of the buffer to write
187 int goodix_i2c_write(struct i2c_client *client, u16 reg, const u8 *buf, int len)
193 addr_buf = kmalloc(len + 2, GFP_KERNEL);
197 addr_buf[0] = reg >> 8;
198 addr_buf[1] = reg & 0xFF;
199 memcpy(&addr_buf[2], buf, len);
202 msg.addr = client->addr;
206 ret = i2c_transfer(client->adapter, &msg, 1);
208 return ret < 0 ? ret : (ret != 1 ? -EIO : 0);
211 int goodix_i2c_write_u8(struct i2c_client *client, u16 reg, u8 value)
213 return goodix_i2c_write(client, reg, &value, sizeof(value));
216 static const struct goodix_chip_data *goodix_get_chip_data(const char *id)
220 for (i = 0; goodix_chip_ids[i].id; i++) {
221 if (!strcmp(goodix_chip_ids[i].id, id))
222 return goodix_chip_ids[i].data;
225 return >9x_chip_data;
228 static int goodix_ts_read_input_report(struct goodix_ts_data *ts, u8 *data)
230 unsigned long max_timeout;
233 u16 addr = GOODIX_READ_COOR_ADDR;
235 * We are going to read 1-byte header,
236 * ts->contact_size * max(1, touch_num) bytes of coordinates
237 * and 1-byte footer which contains the touch-key code.
239 const int header_contact_keycode_size = 1 + ts->contact_size + 1;
242 * The 'buffer status' bit, which indicates that the data is valid, is
243 * not set as soon as the interrupt is raised, but slightly after.
244 * This takes around 10 ms to happen, so we poll for 20 ms.
246 max_timeout = jiffies + msecs_to_jiffies(GOODIX_BUFFER_STATUS_TIMEOUT);
248 error = goodix_i2c_read(ts->client, addr, data,
249 header_contact_keycode_size);
251 dev_err(&ts->client->dev, "I2C transfer error: %d\n",
256 if (data[0] & GOODIX_BUFFER_STATUS_READY) {
257 touch_num = data[0] & 0x0f;
258 if (touch_num > ts->max_touch_num)
262 addr += header_contact_keycode_size;
263 data += header_contact_keycode_size;
264 error = goodix_i2c_read(ts->client,
275 usleep_range(1000, 2000); /* Poll every 1 - 2 ms */
276 } while (time_before(jiffies, max_timeout));
279 * The Goodix panel will send spurious interrupts after a
280 * 'finger up' event, which will always cause a timeout.
285 static void goodix_ts_report_touch_8b(struct goodix_ts_data *ts, u8 *coor_data)
287 int id = coor_data[0] & 0x0F;
288 int input_x = get_unaligned_le16(&coor_data[1]);
289 int input_y = get_unaligned_le16(&coor_data[3]);
290 int input_w = get_unaligned_le16(&coor_data[5]);
292 input_mt_slot(ts->input_dev, id);
293 input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true);
294 touchscreen_report_pos(ts->input_dev, &ts->prop,
295 input_x, input_y, true);
296 input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w);
297 input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w);
300 static void goodix_ts_report_touch_9b(struct goodix_ts_data *ts, u8 *coor_data)
302 int id = coor_data[1] & 0x0F;
303 int input_x = get_unaligned_le16(&coor_data[3]);
304 int input_y = get_unaligned_le16(&coor_data[5]);
305 int input_w = get_unaligned_le16(&coor_data[7]);
307 input_mt_slot(ts->input_dev, id);
308 input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true);
309 touchscreen_report_pos(ts->input_dev, &ts->prop,
310 input_x, input_y, true);
311 input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w);
312 input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w);
315 static void goodix_ts_report_key(struct goodix_ts_data *ts, u8 *data)
321 if (data[0] & GOODIX_HAVE_KEY) {
322 touch_num = data[0] & 0x0f;
323 key_value = data[1 + ts->contact_size * touch_num];
324 for (i = 0; i < GOODIX_MAX_KEYS; i++)
325 if (key_value & BIT(i))
326 input_report_key(ts->input_dev,
329 for (i = 0; i < GOODIX_MAX_KEYS; i++)
330 input_report_key(ts->input_dev, ts->keymap[i], 0);
335 * goodix_process_events - Process incoming events
337 * @ts: our goodix_ts_data pointer
339 * Called when the IRQ is triggered. Read the current device state, and push
340 * the input events to the user space.
342 static void goodix_process_events(struct goodix_ts_data *ts)
344 u8 point_data[2 + GOODIX_MAX_CONTACT_SIZE * GOODIX_MAX_CONTACTS];
348 touch_num = goodix_ts_read_input_report(ts, point_data);
352 goodix_ts_report_key(ts, point_data);
354 for (i = 0; i < touch_num; i++)
355 if (ts->contact_size == 9)
356 goodix_ts_report_touch_9b(ts,
357 &point_data[1 + ts->contact_size * i]);
359 goodix_ts_report_touch_8b(ts,
360 &point_data[1 + ts->contact_size * i]);
362 input_mt_sync_frame(ts->input_dev);
363 input_sync(ts->input_dev);
367 * goodix_ts_irq_handler - The IRQ handler
369 * @irq: interrupt number.
370 * @dev_id: private data pointer.
372 static irqreturn_t goodix_ts_irq_handler(int irq, void *dev_id)
374 struct goodix_ts_data *ts = dev_id;
376 goodix_process_events(ts);
378 if (goodix_i2c_write_u8(ts->client, GOODIX_READ_COOR_ADDR, 0) < 0)
379 dev_err(&ts->client->dev, "I2C write end_cmd error\n");
384 static void goodix_free_irq(struct goodix_ts_data *ts)
386 devm_free_irq(&ts->client->dev, ts->client->irq, ts);
389 static int goodix_request_irq(struct goodix_ts_data *ts)
391 return devm_request_threaded_irq(&ts->client->dev, ts->client->irq,
392 NULL, goodix_ts_irq_handler,
393 ts->irq_flags, ts->client->name, ts);
396 static int goodix_check_cfg_8(struct goodix_ts_data *ts, const u8 *cfg, int len)
398 int i, raw_cfg_len = len - 2;
401 for (i = 0; i < raw_cfg_len; i++)
403 check_sum = (~check_sum) + 1;
404 if (check_sum != cfg[raw_cfg_len]) {
405 dev_err(&ts->client->dev,
406 "The checksum of the config fw is not correct");
410 if (cfg[raw_cfg_len + 1] != 1) {
411 dev_err(&ts->client->dev,
412 "Config fw must have Config_Fresh register set");
419 static void goodix_calc_cfg_checksum_8(struct goodix_ts_data *ts)
421 int i, raw_cfg_len = ts->chip->config_len - 2;
424 for (i = 0; i < raw_cfg_len; i++)
425 check_sum += ts->config[i];
426 check_sum = (~check_sum) + 1;
428 ts->config[raw_cfg_len] = check_sum;
429 ts->config[raw_cfg_len + 1] = 1; /* Set "config_fresh" bit */
432 static int goodix_check_cfg_16(struct goodix_ts_data *ts, const u8 *cfg,
435 int i, raw_cfg_len = len - 3;
438 for (i = 0; i < raw_cfg_len; i += 2)
439 check_sum += get_unaligned_be16(&cfg[i]);
440 check_sum = (~check_sum) + 1;
441 if (check_sum != get_unaligned_be16(&cfg[raw_cfg_len])) {
442 dev_err(&ts->client->dev,
443 "The checksum of the config fw is not correct");
447 if (cfg[raw_cfg_len + 2] != 1) {
448 dev_err(&ts->client->dev,
449 "Config fw must have Config_Fresh register set");
456 static void goodix_calc_cfg_checksum_16(struct goodix_ts_data *ts)
458 int i, raw_cfg_len = ts->chip->config_len - 3;
461 for (i = 0; i < raw_cfg_len; i += 2)
462 check_sum += get_unaligned_be16(&ts->config[i]);
463 check_sum = (~check_sum) + 1;
465 put_unaligned_be16(check_sum, &ts->config[raw_cfg_len]);
466 ts->config[raw_cfg_len + 2] = 1; /* Set "config_fresh" bit */
470 * goodix_check_cfg - Checks if config fw is valid
472 * @ts: goodix_ts_data pointer
473 * @cfg: firmware config data
474 * @len: config data length
476 static int goodix_check_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len)
478 if (len < GOODIX_CONFIG_MIN_LENGTH ||
479 len > GOODIX_CONFIG_MAX_LENGTH) {
480 dev_err(&ts->client->dev,
481 "The length of the config fw is not correct");
485 return ts->chip->check_config(ts, cfg, len);
489 * goodix_send_cfg - Write fw config to device
491 * @ts: goodix_ts_data pointer
492 * @cfg: config firmware to write to device
493 * @len: config data length
495 int goodix_send_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len)
499 error = goodix_check_cfg(ts, cfg, len);
503 error = goodix_i2c_write(ts->client, ts->chip->config_addr, cfg, len);
505 dev_err(&ts->client->dev, "Failed to write config data: %d",
509 dev_dbg(&ts->client->dev, "Config sent successfully.");
511 /* Let the firmware reconfigure itself, so sleep for 10ms */
512 usleep_range(10000, 11000);
517 #ifdef ACPI_GPIO_SUPPORT
518 static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts)
520 acpi_handle handle = ACPI_HANDLE(&ts->client->dev);
523 status = acpi_evaluate_object(handle, "INTI", NULL, NULL);
524 return ACPI_SUCCESS(status) ? 0 : -EIO;
527 static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value)
529 acpi_handle handle = ACPI_HANDLE(&ts->client->dev);
532 status = acpi_execute_simple_method(handle, "INTO", value);
533 return ACPI_SUCCESS(status) ? 0 : -EIO;
536 static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts)
538 dev_err(&ts->client->dev,
539 "%s called on device without ACPI support\n", __func__);
543 static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value)
545 dev_err(&ts->client->dev,
546 "%s called on device without ACPI support\n", __func__);
551 static int goodix_irq_direction_output(struct goodix_ts_data *ts, int value)
553 switch (ts->irq_pin_access_method) {
554 case IRQ_PIN_ACCESS_NONE:
555 dev_err(&ts->client->dev,
556 "%s called without an irq_pin_access_method set\n",
559 case IRQ_PIN_ACCESS_GPIO:
560 return gpiod_direction_output(ts->gpiod_int, value);
561 case IRQ_PIN_ACCESS_ACPI_GPIO:
563 * The IRQ pin triggers on a falling edge, so its gets marked
564 * as active-low, use output_raw to avoid the value inversion.
566 return gpiod_direction_output_raw(ts->gpiod_int, value);
567 case IRQ_PIN_ACCESS_ACPI_METHOD:
568 return goodix_pin_acpi_output_method(ts, value);
571 return -EINVAL; /* Never reached */
574 static int goodix_irq_direction_input(struct goodix_ts_data *ts)
576 switch (ts->irq_pin_access_method) {
577 case IRQ_PIN_ACCESS_NONE:
578 dev_err(&ts->client->dev,
579 "%s called without an irq_pin_access_method set\n",
582 case IRQ_PIN_ACCESS_GPIO:
583 return gpiod_direction_input(ts->gpiod_int);
584 case IRQ_PIN_ACCESS_ACPI_GPIO:
585 return gpiod_direction_input(ts->gpiod_int);
586 case IRQ_PIN_ACCESS_ACPI_METHOD:
587 return goodix_pin_acpi_direction_input(ts);
590 return -EINVAL; /* Never reached */
593 int goodix_int_sync(struct goodix_ts_data *ts)
597 error = goodix_irq_direction_output(ts, 0);
601 msleep(50); /* T5: 50ms */
603 error = goodix_irq_direction_input(ts);
610 dev_err(&ts->client->dev, "Controller irq sync failed.\n");
615 * goodix_reset_no_int_sync - Reset device, leaving interrupt line in output mode
617 * @ts: goodix_ts_data pointer
619 int goodix_reset_no_int_sync(struct goodix_ts_data *ts)
623 /* begin select I2C slave addr */
624 error = gpiod_direction_output(ts->gpiod_rst, 0);
628 msleep(20); /* T2: > 10ms */
630 /* HIGH: 0x28/0x29, LOW: 0xBA/0xBB */
631 error = goodix_irq_direction_output(ts, ts->client->addr == 0x14);
635 usleep_range(100, 2000); /* T3: > 100us */
637 error = gpiod_direction_output(ts->gpiod_rst, 1);
641 usleep_range(6000, 10000); /* T4: > 5ms */
644 * Put the reset pin back in to input / high-impedance mode to save
645 * power. Only do this in the non ACPI case since some ACPI boards
646 * don't have a pull-up, so there the reset pin must stay active-high.
648 if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_GPIO) {
649 error = gpiod_direction_input(ts->gpiod_rst);
657 dev_err(&ts->client->dev, "Controller reset failed.\n");
662 * goodix_reset - Reset device during power on
664 * @ts: goodix_ts_data pointer
666 static int goodix_reset(struct goodix_ts_data *ts)
670 error = goodix_reset_no_int_sync(ts);
674 return goodix_int_sync(ts);
677 #ifdef ACPI_GPIO_SUPPORT
678 #include <asm/cpu_device_id.h>
679 #include <asm/intel-family.h>
681 static const struct x86_cpu_id baytrail_cpu_ids[] = {
682 { X86_VENDOR_INTEL, 6, INTEL_FAM6_ATOM_SILVERMONT, X86_FEATURE_ANY, },
686 static inline bool is_byt(void)
688 const struct x86_cpu_id *id = x86_match_cpu(baytrail_cpu_ids);
693 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
694 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
696 static const struct acpi_gpio_mapping acpi_goodix_int_first_gpios[] = {
697 { GOODIX_GPIO_INT_NAME "-gpios", &first_gpio, 1 },
698 { GOODIX_GPIO_RST_NAME "-gpios", &second_gpio, 1 },
702 static const struct acpi_gpio_mapping acpi_goodix_int_last_gpios[] = {
703 { GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 },
704 { GOODIX_GPIO_INT_NAME "-gpios", &second_gpio, 1 },
708 static const struct acpi_gpio_mapping acpi_goodix_reset_only_gpios[] = {
709 { GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 },
713 static int goodix_resource(struct acpi_resource *ares, void *data)
715 struct goodix_ts_data *ts = data;
716 struct device *dev = &ts->client->dev;
717 struct acpi_resource_gpio *gpio;
719 switch (ares->type) {
720 case ACPI_RESOURCE_TYPE_GPIO:
721 gpio = &ares->data.gpio;
722 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
723 if (ts->gpio_int_idx == -1) {
724 ts->gpio_int_idx = ts->gpio_count;
726 dev_err(dev, "More then one GpioInt resource, ignoring ACPI GPIO resources\n");
727 ts->gpio_int_idx = -2;
740 * This function gets called in case we fail to get the irq GPIO directly
741 * because the ACPI tables lack GPIO-name to APCI _CRS index mappings
742 * (no _DSD UUID daffd814-6eba-4d8c-8a91-bc9bbf4aa301 data).
743 * In that case we add our own mapping and then goodix_get_gpio_config()
744 * retries to get the GPIOs based on the added mapping.
746 static int goodix_add_acpi_gpio_mappings(struct goodix_ts_data *ts)
748 const struct acpi_gpio_mapping *gpio_mapping = NULL;
749 struct device *dev = &ts->client->dev;
750 LIST_HEAD(resources);
754 ts->gpio_int_idx = -1;
755 ret = acpi_dev_get_resources(ACPI_COMPANION(dev), &resources,
756 goodix_resource, ts);
758 dev_err(dev, "Error getting ACPI resources: %d\n", ret);
762 acpi_dev_free_resource_list(&resources);
764 if (ts->gpio_count == 2 && ts->gpio_int_idx == 0) {
765 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
766 gpio_mapping = acpi_goodix_int_first_gpios;
767 } else if (ts->gpio_count == 2 && ts->gpio_int_idx == 1) {
768 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
769 gpio_mapping = acpi_goodix_int_last_gpios;
770 } else if (ts->gpio_count == 1 && ts->gpio_int_idx == -1 &&
771 acpi_has_method(ACPI_HANDLE(dev), "INTI") &&
772 acpi_has_method(ACPI_HANDLE(dev), "INTO")) {
773 dev_info(dev, "Using ACPI INTI and INTO methods for IRQ pin access\n");
774 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_METHOD;
775 gpio_mapping = acpi_goodix_reset_only_gpios;
776 } else if (is_byt() && ts->gpio_count == 2 && ts->gpio_int_idx == -1) {
777 dev_info(dev, "No ACPI GpioInt resource, assuming that the GPIO order is reset, int\n");
778 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
779 gpio_mapping = acpi_goodix_int_last_gpios;
781 dev_warn(dev, "Unexpected ACPI resources: gpio_count %d, gpio_int_idx %d\n",
782 ts->gpio_count, ts->gpio_int_idx);
787 * Normally we put the reset pin in input / high-impedance mode to save
788 * power. But some x86/ACPI boards don't have a pull-up, so for the ACPI
789 * case, leave the pin as is. This results in the pin not being touched
790 * at all on x86/ACPI boards, except when needed for error-recover.
792 ts->gpiod_rst_flags = GPIOD_ASIS;
794 return devm_acpi_dev_add_driver_gpios(dev, gpio_mapping);
797 static int goodix_add_acpi_gpio_mappings(struct goodix_ts_data *ts)
801 #endif /* CONFIG_X86 && CONFIG_ACPI */
804 * goodix_get_gpio_config - Get GPIO config from ACPI/DT
806 * @ts: goodix_ts_data pointer
808 static int goodix_get_gpio_config(struct goodix_ts_data *ts)
812 struct gpio_desc *gpiod;
813 bool added_acpi_mappings = false;
817 dev = &ts->client->dev;
820 * By default we request the reset pin as input, leaving it in
821 * high-impedance when not resetting the controller to save power.
823 ts->gpiod_rst_flags = GPIOD_IN;
825 ts->avdd28 = devm_regulator_get(dev, "AVDD28");
826 if (IS_ERR(ts->avdd28)) {
827 error = PTR_ERR(ts->avdd28);
828 if (error != -EPROBE_DEFER)
830 "Failed to get AVDD28 regulator: %d\n", error);
834 ts->vddio = devm_regulator_get(dev, "VDDIO");
835 if (IS_ERR(ts->vddio)) {
836 error = PTR_ERR(ts->vddio);
837 if (error != -EPROBE_DEFER)
839 "Failed to get VDDIO regulator: %d\n", error);
844 /* Get the interrupt GPIO pin number */
845 gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_INT_NAME, GPIOD_IN);
847 error = PTR_ERR(gpiod);
848 if (error != -EPROBE_DEFER)
849 dev_dbg(dev, "Failed to get %s GPIO: %d\n",
850 GOODIX_GPIO_INT_NAME, error);
853 if (!gpiod && has_acpi_companion(dev) && !added_acpi_mappings) {
854 added_acpi_mappings = true;
855 if (goodix_add_acpi_gpio_mappings(ts) == 0)
856 goto retry_get_irq_gpio;
859 ts->gpiod_int = gpiod;
861 /* Get the reset line GPIO pin number */
862 gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_RST_NAME, ts->gpiod_rst_flags);
864 error = PTR_ERR(gpiod);
865 if (error != -EPROBE_DEFER)
866 dev_dbg(dev, "Failed to get %s GPIO: %d\n",
867 GOODIX_GPIO_RST_NAME, error);
871 ts->gpiod_rst = gpiod;
873 switch (ts->irq_pin_access_method) {
874 case IRQ_PIN_ACCESS_ACPI_GPIO:
876 * We end up here if goodix_add_acpi_gpio_mappings() has
877 * called devm_acpi_dev_add_driver_gpios() because the ACPI
878 * tables did not contain name to index mappings.
879 * Check that we successfully got both GPIOs after we've
880 * added our own acpi_gpio_mapping and if we did not get both
881 * GPIOs reset irq_pin_access_method to IRQ_PIN_ACCESS_NONE.
883 if (!ts->gpiod_int || !ts->gpiod_rst)
884 ts->irq_pin_access_method = IRQ_PIN_ACCESS_NONE;
886 case IRQ_PIN_ACCESS_ACPI_METHOD:
888 ts->irq_pin_access_method = IRQ_PIN_ACCESS_NONE;
891 if (ts->gpiod_int && ts->gpiod_rst) {
892 ts->reset_controller_at_probe = true;
893 ts->load_cfg_from_disk = true;
894 ts->irq_pin_access_method = IRQ_PIN_ACCESS_GPIO;
902 * goodix_read_config - Read the embedded configuration of the panel
904 * @ts: our goodix_ts_data pointer
906 * Must be called during probe
908 static void goodix_read_config(struct goodix_ts_data *ts)
913 error = goodix_i2c_read(ts->client, ts->chip->config_addr,
914 ts->config, ts->chip->config_len);
916 dev_warn(&ts->client->dev, "Error reading config: %d\n",
918 ts->int_trigger_type = GOODIX_INT_TRIGGER;
919 ts->max_touch_num = GOODIX_MAX_CONTACTS;
923 ts->int_trigger_type = ts->config[TRIGGER_LOC] & 0x03;
924 ts->max_touch_num = ts->config[MAX_CONTACTS_LOC] & 0x0f;
926 x_max = get_unaligned_le16(&ts->config[RESOLUTION_LOC]);
927 y_max = get_unaligned_le16(&ts->config[RESOLUTION_LOC + 2]);
928 if (x_max && y_max) {
929 input_abs_set_max(ts->input_dev, ABS_MT_POSITION_X, x_max - 1);
930 input_abs_set_max(ts->input_dev, ABS_MT_POSITION_Y, y_max - 1);
933 ts->chip->calc_config_checksum(ts);
937 * goodix_read_version - Read goodix touchscreen version
939 * @ts: our goodix_ts_data pointer
941 static int goodix_read_version(struct goodix_ts_data *ts)
945 char id_str[GOODIX_ID_MAX_LEN + 1];
947 error = goodix_i2c_read(ts->client, GOODIX_REG_ID, buf, sizeof(buf));
949 dev_err(&ts->client->dev, "read version failed: %d\n", error);
953 memcpy(id_str, buf, GOODIX_ID_MAX_LEN);
954 id_str[GOODIX_ID_MAX_LEN] = 0;
955 strscpy(ts->id, id_str, GOODIX_ID_MAX_LEN + 1);
957 ts->version = get_unaligned_le16(&buf[4]);
959 dev_info(&ts->client->dev, "ID %s, version: %04x\n", ts->id,
966 * goodix_i2c_test - I2C test function to check if the device answers.
968 * @client: the i2c client
970 static int goodix_i2c_test(struct i2c_client *client)
976 while (retry++ < 2) {
977 error = goodix_i2c_read(client, GOODIX_REG_ID,
982 dev_err(&client->dev, "i2c test failed attempt %d: %d\n",
991 * goodix_configure_dev - Finish device initialization
993 * @ts: our goodix_ts_data pointer
995 * Must be called from probe to finish initialization of the device.
996 * Contains the common initialization code for both devices that
997 * declare gpio pins and devices that do not. It is either called
998 * directly from probe or from request_firmware_wait callback.
1000 static int goodix_configure_dev(struct goodix_ts_data *ts)
1005 ts->int_trigger_type = GOODIX_INT_TRIGGER;
1006 ts->max_touch_num = GOODIX_MAX_CONTACTS;
1008 ts->input_dev = devm_input_allocate_device(&ts->client->dev);
1009 if (!ts->input_dev) {
1010 dev_err(&ts->client->dev, "Failed to allocate input device.");
1014 ts->input_dev->name = "Goodix Capacitive TouchScreen";
1015 ts->input_dev->phys = "input/ts";
1016 ts->input_dev->id.bustype = BUS_I2C;
1017 ts->input_dev->id.vendor = 0x0416;
1018 if (kstrtou16(ts->id, 10, &ts->input_dev->id.product))
1019 ts->input_dev->id.product = 0x1001;
1020 ts->input_dev->id.version = ts->version;
1022 ts->input_dev->keycode = ts->keymap;
1023 ts->input_dev->keycodesize = sizeof(ts->keymap[0]);
1024 ts->input_dev->keycodemax = GOODIX_MAX_KEYS;
1026 /* Capacitive Windows/Home button on some devices */
1027 for (i = 0; i < GOODIX_MAX_KEYS; ++i) {
1029 ts->keymap[i] = KEY_LEFTMETA;
1031 ts->keymap[i] = KEY_F1 + (i - 1);
1033 input_set_capability(ts->input_dev, EV_KEY, ts->keymap[i]);
1036 input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_X);
1037 input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_Y);
1038 input_set_abs_params(ts->input_dev, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0);
1039 input_set_abs_params(ts->input_dev, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
1041 /* Read configuration and apply touchscreen parameters */
1042 goodix_read_config(ts);
1044 /* Try overriding touchscreen parameters via device properties */
1045 touchscreen_parse_properties(ts->input_dev, true, &ts->prop);
1047 if (!ts->prop.max_x || !ts->prop.max_y || !ts->max_touch_num) {
1048 dev_err(&ts->client->dev,
1049 "Invalid config (%d, %d, %d), using defaults\n",
1050 ts->prop.max_x, ts->prop.max_y, ts->max_touch_num);
1051 ts->prop.max_x = GOODIX_MAX_WIDTH - 1;
1052 ts->prop.max_y = GOODIX_MAX_HEIGHT - 1;
1053 ts->max_touch_num = GOODIX_MAX_CONTACTS;
1054 input_abs_set_max(ts->input_dev,
1055 ABS_MT_POSITION_X, ts->prop.max_x);
1056 input_abs_set_max(ts->input_dev,
1057 ABS_MT_POSITION_Y, ts->prop.max_y);
1060 if (dmi_check_system(nine_bytes_report)) {
1061 ts->contact_size = 9;
1063 dev_dbg(&ts->client->dev,
1064 "Non-standard 9-bytes report format quirk\n");
1067 if (dmi_check_system(inverted_x_screen)) {
1068 ts->prop.invert_x = true;
1069 dev_dbg(&ts->client->dev,
1070 "Applying 'inverted x screen' quirk\n");
1073 error = input_mt_init_slots(ts->input_dev, ts->max_touch_num,
1074 INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
1076 dev_err(&ts->client->dev,
1077 "Failed to initialize MT slots: %d", error);
1081 error = input_register_device(ts->input_dev);
1083 dev_err(&ts->client->dev,
1084 "Failed to register input device: %d", error);
1088 ts->irq_flags = goodix_irq_flags[ts->int_trigger_type] | IRQF_ONESHOT;
1089 error = goodix_request_irq(ts);
1091 dev_err(&ts->client->dev, "request IRQ failed: %d\n", error);
1099 * goodix_config_cb - Callback to finish device init
1101 * @cfg: firmware config
1102 * @ctx: our goodix_ts_data pointer
1104 * request_firmware_wait callback that finishes
1105 * initialization of the device.
1107 static void goodix_config_cb(const struct firmware *cfg, void *ctx)
1109 struct goodix_ts_data *ts = ctx;
1113 /* send device configuration to the firmware */
1114 error = goodix_send_cfg(ts, cfg->data, cfg->size);
1116 goto err_release_cfg;
1119 goodix_configure_dev(ts);
1122 release_firmware(cfg);
1123 complete_all(&ts->firmware_loading_complete);
1126 static void goodix_disable_regulators(void *arg)
1128 struct goodix_ts_data *ts = arg;
1130 regulator_disable(ts->vddio);
1131 regulator_disable(ts->avdd28);
1134 static int goodix_ts_probe(struct i2c_client *client,
1135 const struct i2c_device_id *id)
1137 struct goodix_ts_data *ts;
1140 dev_dbg(&client->dev, "I2C Address: 0x%02x\n", client->addr);
1142 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
1143 dev_err(&client->dev, "I2C check functionality failed.\n");
1147 ts = devm_kzalloc(&client->dev, sizeof(*ts), GFP_KERNEL);
1151 ts->client = client;
1152 i2c_set_clientdata(client, ts);
1153 init_completion(&ts->firmware_loading_complete);
1154 ts->contact_size = GOODIX_CONTACT_SIZE;
1156 error = goodix_get_gpio_config(ts);
1160 /* power up the controller */
1161 error = regulator_enable(ts->avdd28);
1163 dev_err(&client->dev,
1164 "Failed to enable AVDD28 regulator: %d\n",
1169 error = regulator_enable(ts->vddio);
1171 dev_err(&client->dev,
1172 "Failed to enable VDDIO regulator: %d\n",
1174 regulator_disable(ts->avdd28);
1178 error = devm_add_action_or_reset(&client->dev,
1179 goodix_disable_regulators, ts);
1184 if (ts->reset_controller_at_probe) {
1185 /* reset the controller */
1186 error = goodix_reset(ts);
1191 error = goodix_i2c_test(client);
1193 if (!ts->reset_controller_at_probe &&
1194 ts->irq_pin_access_method != IRQ_PIN_ACCESS_NONE) {
1195 /* Retry after a controller reset */
1196 ts->reset_controller_at_probe = true;
1199 dev_err(&client->dev, "I2C communication failure: %d\n", error);
1203 error = goodix_read_version(ts);
1205 dev_err(&client->dev, "Read version failed.\n");
1209 ts->chip = goodix_get_chip_data(ts->id);
1211 if (ts->load_cfg_from_disk) {
1212 /* update device config */
1213 ts->cfg_name = devm_kasprintf(&client->dev, GFP_KERNEL,
1214 "goodix_%s_cfg.bin", ts->id);
1218 error = request_firmware_nowait(THIS_MODULE, true, ts->cfg_name,
1219 &client->dev, GFP_KERNEL, ts,
1222 dev_err(&client->dev,
1223 "Failed to invoke firmware loader: %d\n",
1230 error = goodix_configure_dev(ts);
1238 static int goodix_ts_remove(struct i2c_client *client)
1240 struct goodix_ts_data *ts = i2c_get_clientdata(client);
1242 if (ts->load_cfg_from_disk)
1243 wait_for_completion(&ts->firmware_loading_complete);
1248 static int __maybe_unused goodix_suspend(struct device *dev)
1250 struct i2c_client *client = to_i2c_client(dev);
1251 struct goodix_ts_data *ts = i2c_get_clientdata(client);
1254 if (ts->load_cfg_from_disk)
1255 wait_for_completion(&ts->firmware_loading_complete);
1257 /* We need gpio pins to suspend/resume */
1258 if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) {
1259 disable_irq(client->irq);
1263 /* Free IRQ as IRQ pin is used as output in the suspend sequence */
1264 goodix_free_irq(ts);
1266 /* Output LOW on the INT pin for 5 ms */
1267 error = goodix_irq_direction_output(ts, 0);
1269 goodix_request_irq(ts);
1273 usleep_range(5000, 6000);
1275 error = goodix_i2c_write_u8(ts->client, GOODIX_REG_COMMAND,
1276 GOODIX_CMD_SCREEN_OFF);
1278 dev_err(&ts->client->dev, "Screen off command failed\n");
1279 goodix_irq_direction_input(ts);
1280 goodix_request_irq(ts);
1285 * The datasheet specifies that the interval between sending screen-off
1286 * command and wake-up should be longer than 58 ms. To avoid waking up
1287 * sooner, delay 58ms here.
1293 static int __maybe_unused goodix_resume(struct device *dev)
1295 struct i2c_client *client = to_i2c_client(dev);
1296 struct goodix_ts_data *ts = i2c_get_clientdata(client);
1300 if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) {
1301 enable_irq(client->irq);
1306 * Exit sleep mode by outputting HIGH level to INT pin
1309 error = goodix_irq_direction_output(ts, 1);
1313 usleep_range(2000, 5000);
1315 error = goodix_int_sync(ts);
1319 error = goodix_i2c_read(ts->client, ts->chip->config_addr,
1322 dev_warn(dev, "Error reading config version: %d, resetting controller\n",
1324 else if (config_ver != ts->config[0])
1325 dev_info(dev, "Config version mismatch %d != %d, resetting controller\n",
1326 config_ver, ts->config[0]);
1328 if (error != 0 || config_ver != ts->config[0]) {
1329 error = goodix_reset(ts);
1333 error = goodix_send_cfg(ts, ts->config, ts->chip->config_len);
1338 error = goodix_request_irq(ts);
1345 static SIMPLE_DEV_PM_OPS(goodix_pm_ops, goodix_suspend, goodix_resume);
1347 static const struct i2c_device_id goodix_ts_id[] = {
1348 { "GDIX1001:00", 0 },
1351 MODULE_DEVICE_TABLE(i2c, goodix_ts_id);
1354 static const struct acpi_device_id goodix_acpi_match[] = {
1359 MODULE_DEVICE_TABLE(acpi, goodix_acpi_match);
1363 static const struct of_device_id goodix_of_match[] = {
1364 { .compatible = "goodix,gt1151" },
1365 { .compatible = "goodix,gt5663" },
1366 { .compatible = "goodix,gt5688" },
1367 { .compatible = "goodix,gt911" },
1368 { .compatible = "goodix,gt9110" },
1369 { .compatible = "goodix,gt912" },
1370 { .compatible = "goodix,gt9147" },
1371 { .compatible = "goodix,gt917s" },
1372 { .compatible = "goodix,gt927" },
1373 { .compatible = "goodix,gt9271" },
1374 { .compatible = "goodix,gt928" },
1375 { .compatible = "goodix,gt9286" },
1376 { .compatible = "goodix,gt967" },
1379 MODULE_DEVICE_TABLE(of, goodix_of_match);
1382 static struct i2c_driver goodix_ts_driver = {
1383 .probe = goodix_ts_probe,
1384 .remove = goodix_ts_remove,
1385 .id_table = goodix_ts_id,
1387 .name = "Goodix-TS",
1388 .acpi_match_table = ACPI_PTR(goodix_acpi_match),
1389 .of_match_table = of_match_ptr(goodix_of_match),
1390 .pm = &goodix_pm_ops,
1393 module_i2c_driver(goodix_ts_driver);
1395 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
1396 MODULE_AUTHOR("Bastien Nocera <hadess@hadess.net>");
1397 MODULE_DESCRIPTION("Goodix touchscreen driver");
1398 MODULE_LICENSE("GPL v2");