2 * Driver for Goodix Touchscreens
4 * Copyright (c) 2014 Red Hat Inc.
5 * Copyright (c) 2015 K. Merker <merker@debian.org>
7 * This code is based on gt9xx.c authored by andrew@goodix.com:
9 * 2010 - 2012 Goodix Technology.
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License as published by the Free
15 * Software Foundation; version 2 of the License.
18 #include <linux/kernel.h>
19 #include <linux/dmi.h>
20 #include <linux/firmware.h>
21 #include <linux/gpio/consumer.h>
22 #include <linux/i2c.h>
23 #include <linux/input.h>
24 #include <linux/input/mt.h>
25 #include <linux/module.h>
26 #include <linux/delay.h>
27 #include <linux/irq.h>
28 #include <linux/interrupt.h>
29 #include <linux/slab.h>
30 #include <linux/acpi.h>
32 #include <asm/unaligned.h>
34 struct goodix_ts_data {
35 struct i2c_client *client;
36 struct input_dev *input_dev;
42 unsigned int max_touch_num;
43 unsigned int int_trigger_type;
45 struct gpio_desc *gpiod_int;
46 struct gpio_desc *gpiod_rst;
50 struct completion firmware_loading_complete;
51 unsigned long irq_flags;
54 #define GOODIX_GPIO_INT_NAME "irq"
55 #define GOODIX_GPIO_RST_NAME "reset"
57 #define GOODIX_MAX_HEIGHT 4096
58 #define GOODIX_MAX_WIDTH 4096
59 #define GOODIX_INT_TRIGGER 1
60 #define GOODIX_CONTACT_SIZE 8
61 #define GOODIX_MAX_CONTACTS 10
63 #define GOODIX_CONFIG_MAX_LENGTH 240
64 #define GOODIX_CONFIG_911_LENGTH 186
65 #define GOODIX_CONFIG_967_LENGTH 228
67 /* Register defines */
68 #define GOODIX_REG_COMMAND 0x8040
69 #define GOODIX_CMD_SCREEN_OFF 0x05
71 #define GOODIX_READ_COOR_ADDR 0x814E
72 #define GOODIX_REG_CONFIG_DATA 0x8047
73 #define GOODIX_REG_ID 0x8140
75 #define RESOLUTION_LOC 1
76 #define MAX_CONTACTS_LOC 5
79 static const unsigned long goodix_irq_flags[] = {
81 IRQ_TYPE_EDGE_FALLING,
87 * Those tablets have their coordinates origin at the bottom right
88 * of the tablet, as if rotated 180 degrees
90 static const struct dmi_system_id rotated_screen[] = {
91 #if defined(CONFIG_DMI) && defined(CONFIG_X86)
93 .ident = "WinBook TW100",
95 DMI_MATCH(DMI_SYS_VENDOR, "WinBook"),
96 DMI_MATCH(DMI_PRODUCT_NAME, "TW100")
100 .ident = "WinBook TW700",
102 DMI_MATCH(DMI_SYS_VENDOR, "WinBook"),
103 DMI_MATCH(DMI_PRODUCT_NAME, "TW700")
111 * goodix_i2c_read - read data from a register of the i2c slave device.
113 * @client: i2c device.
114 * @reg: the register to read from.
115 * @buf: raw write data buffer.
116 * @len: length of the buffer to write
118 static int goodix_i2c_read(struct i2c_client *client,
119 u16 reg, u8 *buf, int len)
121 struct i2c_msg msgs[2];
122 u16 wbuf = cpu_to_be16(reg);
126 msgs[0].addr = client->addr;
128 msgs[0].buf = (u8 *)&wbuf;
130 msgs[1].flags = I2C_M_RD;
131 msgs[1].addr = client->addr;
135 ret = i2c_transfer(client->adapter, msgs, 2);
136 return ret < 0 ? ret : (ret != ARRAY_SIZE(msgs) ? -EIO : 0);
140 * goodix_i2c_write - write data to a register of the i2c slave device.
142 * @client: i2c device.
143 * @reg: the register to write to.
144 * @buf: raw data buffer to write.
145 * @len: length of the buffer to write
147 static int goodix_i2c_write(struct i2c_client *client, u16 reg, const u8 *buf,
154 addr_buf = kmalloc(len + 2, GFP_KERNEL);
158 addr_buf[0] = reg >> 8;
159 addr_buf[1] = reg & 0xFF;
160 memcpy(&addr_buf[2], buf, len);
163 msg.addr = client->addr;
167 ret = i2c_transfer(client->adapter, &msg, 1);
169 return ret < 0 ? ret : (ret != 1 ? -EIO : 0);
172 static int goodix_i2c_write_u8(struct i2c_client *client, u16 reg, u8 value)
174 return goodix_i2c_write(client, reg, &value, sizeof(value));
177 static int goodix_get_cfg_len(u16 id)
185 return GOODIX_CONFIG_911_LENGTH;
189 return GOODIX_CONFIG_967_LENGTH;
192 return GOODIX_CONFIG_MAX_LENGTH;
196 static int goodix_ts_read_input_report(struct goodix_ts_data *ts, u8 *data)
201 error = goodix_i2c_read(ts->client, GOODIX_READ_COOR_ADDR, data,
202 GOODIX_CONTACT_SIZE + 1);
204 dev_err(&ts->client->dev, "I2C transfer error: %d\n", error);
208 if (!(data[0] & 0x80))
211 touch_num = data[0] & 0x0f;
212 if (touch_num > ts->max_touch_num)
216 data += 1 + GOODIX_CONTACT_SIZE;
217 error = goodix_i2c_read(ts->client,
218 GOODIX_READ_COOR_ADDR +
219 1 + GOODIX_CONTACT_SIZE,
221 GOODIX_CONTACT_SIZE * (touch_num - 1));
229 static void goodix_ts_report_touch(struct goodix_ts_data *ts, u8 *coor_data)
231 int id = coor_data[0] & 0x0F;
232 int input_x = get_unaligned_le16(&coor_data[1]);
233 int input_y = get_unaligned_le16(&coor_data[3]);
234 int input_w = get_unaligned_le16(&coor_data[5]);
236 /* Inversions have to happen before axis swapping */
238 input_x = ts->abs_x_max - input_x;
240 input_y = ts->abs_y_max - input_y;
242 swap(input_x, input_y);
244 input_mt_slot(ts->input_dev, id);
245 input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true);
246 input_report_abs(ts->input_dev, ABS_MT_POSITION_X, input_x);
247 input_report_abs(ts->input_dev, ABS_MT_POSITION_Y, input_y);
248 input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w);
249 input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w);
253 * goodix_process_events - Process incoming events
255 * @ts: our goodix_ts_data pointer
257 * Called when the IRQ is triggered. Read the current device state, and push
258 * the input events to the user space.
260 static void goodix_process_events(struct goodix_ts_data *ts)
262 u8 point_data[1 + GOODIX_CONTACT_SIZE * GOODIX_MAX_CONTACTS];
266 touch_num = goodix_ts_read_input_report(ts, point_data);
270 for (i = 0; i < touch_num; i++)
271 goodix_ts_report_touch(ts,
272 &point_data[1 + GOODIX_CONTACT_SIZE * i]);
274 input_mt_sync_frame(ts->input_dev);
275 input_sync(ts->input_dev);
279 * goodix_ts_irq_handler - The IRQ handler
281 * @irq: interrupt number.
282 * @dev_id: private data pointer.
284 static irqreturn_t goodix_ts_irq_handler(int irq, void *dev_id)
286 struct goodix_ts_data *ts = dev_id;
288 goodix_process_events(ts);
290 if (goodix_i2c_write_u8(ts->client, GOODIX_READ_COOR_ADDR, 0) < 0)
291 dev_err(&ts->client->dev, "I2C write end_cmd error\n");
296 static void goodix_free_irq(struct goodix_ts_data *ts)
298 devm_free_irq(&ts->client->dev, ts->client->irq, ts);
301 static int goodix_request_irq(struct goodix_ts_data *ts)
303 return devm_request_threaded_irq(&ts->client->dev, ts->client->irq,
304 NULL, goodix_ts_irq_handler,
305 ts->irq_flags, ts->client->name, ts);
309 * goodix_check_cfg - Checks if config fw is valid
311 * @ts: goodix_ts_data pointer
312 * @cfg: firmware config data
314 static int goodix_check_cfg(struct goodix_ts_data *ts,
315 const struct firmware *cfg)
320 if (cfg->size > GOODIX_CONFIG_MAX_LENGTH) {
321 dev_err(&ts->client->dev,
322 "The length of the config fw is not correct");
326 raw_cfg_len = cfg->size - 2;
327 for (i = 0; i < raw_cfg_len; i++)
328 check_sum += cfg->data[i];
329 check_sum = (~check_sum) + 1;
330 if (check_sum != cfg->data[raw_cfg_len]) {
331 dev_err(&ts->client->dev,
332 "The checksum of the config fw is not correct");
336 if (cfg->data[raw_cfg_len + 1] != 1) {
337 dev_err(&ts->client->dev,
338 "Config fw must have Config_Fresh register set");
346 * goodix_send_cfg - Write fw config to device
348 * @ts: goodix_ts_data pointer
349 * @cfg: config firmware to write to device
351 static int goodix_send_cfg(struct goodix_ts_data *ts,
352 const struct firmware *cfg)
356 error = goodix_check_cfg(ts, cfg);
360 error = goodix_i2c_write(ts->client, GOODIX_REG_CONFIG_DATA, cfg->data,
363 dev_err(&ts->client->dev, "Failed to write config data: %d",
367 dev_dbg(&ts->client->dev, "Config sent successfully.");
369 /* Let the firmware reconfigure itself, so sleep for 10ms */
370 usleep_range(10000, 11000);
375 static int goodix_int_sync(struct goodix_ts_data *ts)
379 error = gpiod_direction_output(ts->gpiod_int, 0);
383 msleep(50); /* T5: 50ms */
385 error = gpiod_direction_input(ts->gpiod_int);
393 * goodix_reset - Reset device during power on
395 * @ts: goodix_ts_data pointer
397 static int goodix_reset(struct goodix_ts_data *ts)
401 /* begin select I2C slave addr */
402 error = gpiod_direction_output(ts->gpiod_rst, 0);
406 msleep(20); /* T2: > 10ms */
408 /* HIGH: 0x28/0x29, LOW: 0xBA/0xBB */
409 error = gpiod_direction_output(ts->gpiod_int, ts->client->addr == 0x14);
413 usleep_range(100, 2000); /* T3: > 100us */
415 error = gpiod_direction_output(ts->gpiod_rst, 1);
419 usleep_range(6000, 10000); /* T4: > 5ms */
421 /* end select I2C slave addr */
422 error = gpiod_direction_input(ts->gpiod_rst);
426 error = goodix_int_sync(ts);
434 * goodix_get_gpio_config - Get GPIO config from ACPI/DT
436 * @ts: goodix_ts_data pointer
438 static int goodix_get_gpio_config(struct goodix_ts_data *ts)
442 struct gpio_desc *gpiod;
446 dev = &ts->client->dev;
448 /* Get the interrupt GPIO pin number */
449 gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_INT_NAME, GPIOD_IN);
451 error = PTR_ERR(gpiod);
452 if (error != -EPROBE_DEFER)
453 dev_dbg(dev, "Failed to get %s GPIO: %d\n",
454 GOODIX_GPIO_INT_NAME, error);
458 ts->gpiod_int = gpiod;
460 /* Get the reset line GPIO pin number */
461 gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_RST_NAME, GPIOD_IN);
463 error = PTR_ERR(gpiod);
464 if (error != -EPROBE_DEFER)
465 dev_dbg(dev, "Failed to get %s GPIO: %d\n",
466 GOODIX_GPIO_RST_NAME, error);
470 ts->gpiod_rst = gpiod;
476 * goodix_read_config - Read the embedded configuration of the panel
478 * @ts: our goodix_ts_data pointer
480 * Must be called during probe
482 static void goodix_read_config(struct goodix_ts_data *ts)
484 u8 config[GOODIX_CONFIG_MAX_LENGTH];
487 error = goodix_i2c_read(ts->client, GOODIX_REG_CONFIG_DATA,
488 config, ts->cfg_len);
490 dev_warn(&ts->client->dev,
491 "Error reading config (%d), using defaults\n",
493 ts->abs_x_max = GOODIX_MAX_WIDTH;
494 ts->abs_y_max = GOODIX_MAX_HEIGHT;
496 swap(ts->abs_x_max, ts->abs_y_max);
497 ts->int_trigger_type = GOODIX_INT_TRIGGER;
498 ts->max_touch_num = GOODIX_MAX_CONTACTS;
502 ts->abs_x_max = get_unaligned_le16(&config[RESOLUTION_LOC]);
503 ts->abs_y_max = get_unaligned_le16(&config[RESOLUTION_LOC + 2]);
505 swap(ts->abs_x_max, ts->abs_y_max);
506 ts->int_trigger_type = config[TRIGGER_LOC] & 0x03;
507 ts->max_touch_num = config[MAX_CONTACTS_LOC] & 0x0f;
508 if (!ts->abs_x_max || !ts->abs_y_max || !ts->max_touch_num) {
509 dev_err(&ts->client->dev,
510 "Invalid config, using defaults\n");
511 ts->abs_x_max = GOODIX_MAX_WIDTH;
512 ts->abs_y_max = GOODIX_MAX_HEIGHT;
514 swap(ts->abs_x_max, ts->abs_y_max);
515 ts->max_touch_num = GOODIX_MAX_CONTACTS;
518 if (dmi_check_system(rotated_screen)) {
519 ts->inverted_x = true;
520 ts->inverted_y = true;
521 dev_dbg(&ts->client->dev,
522 "Applying '180 degrees rotated screen' quirk\n");
527 * goodix_read_version - Read goodix touchscreen version
529 * @ts: our goodix_ts_data pointer
531 static int goodix_read_version(struct goodix_ts_data *ts)
537 error = goodix_i2c_read(ts->client, GOODIX_REG_ID, buf, sizeof(buf));
539 dev_err(&ts->client->dev, "read version failed: %d\n", error);
543 memcpy(id_str, buf, 4);
545 if (kstrtou16(id_str, 10, &ts->id))
548 ts->version = get_unaligned_le16(&buf[4]);
550 dev_info(&ts->client->dev, "ID %d, version: %04x\n", ts->id,
557 * goodix_i2c_test - I2C test function to check if the device answers.
559 * @client: the i2c client
561 static int goodix_i2c_test(struct i2c_client *client)
567 while (retry++ < 2) {
568 error = goodix_i2c_read(client, GOODIX_REG_CONFIG_DATA,
573 dev_err(&client->dev, "i2c test failed attempt %d: %d\n",
582 * goodix_request_input_dev - Allocate, populate and register the input device
584 * @ts: our goodix_ts_data pointer
586 * Must be called during probe
588 static int goodix_request_input_dev(struct goodix_ts_data *ts)
592 ts->input_dev = devm_input_allocate_device(&ts->client->dev);
593 if (!ts->input_dev) {
594 dev_err(&ts->client->dev, "Failed to allocate input device.");
598 input_set_abs_params(ts->input_dev, ABS_MT_POSITION_X,
599 0, ts->abs_x_max, 0, 0);
600 input_set_abs_params(ts->input_dev, ABS_MT_POSITION_Y,
601 0, ts->abs_y_max, 0, 0);
602 input_set_abs_params(ts->input_dev, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0);
603 input_set_abs_params(ts->input_dev, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
605 input_mt_init_slots(ts->input_dev, ts->max_touch_num,
606 INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
608 ts->input_dev->name = "Goodix Capacitive TouchScreen";
609 ts->input_dev->phys = "input/ts";
610 ts->input_dev->id.bustype = BUS_I2C;
611 ts->input_dev->id.vendor = 0x0416;
612 ts->input_dev->id.product = ts->id;
613 ts->input_dev->id.version = ts->version;
615 error = input_register_device(ts->input_dev);
617 dev_err(&ts->client->dev,
618 "Failed to register input device: %d", error);
626 * goodix_configure_dev - Finish device initialization
628 * @ts: our goodix_ts_data pointer
630 * Must be called from probe to finish initialization of the device.
631 * Contains the common initialization code for both devices that
632 * declare gpio pins and devices that do not. It is either called
633 * directly from probe or from request_firmware_wait callback.
635 static int goodix_configure_dev(struct goodix_ts_data *ts)
639 ts->swapped_x_y = device_property_read_bool(&ts->client->dev,
640 "touchscreen-swapped-x-y");
641 ts->inverted_x = device_property_read_bool(&ts->client->dev,
642 "touchscreen-inverted-x");
643 ts->inverted_y = device_property_read_bool(&ts->client->dev,
644 "touchscreen-inverted-y");
646 goodix_read_config(ts);
648 error = goodix_request_input_dev(ts);
652 ts->irq_flags = goodix_irq_flags[ts->int_trigger_type] | IRQF_ONESHOT;
653 error = goodix_request_irq(ts);
655 dev_err(&ts->client->dev, "request IRQ failed: %d\n", error);
663 * goodix_config_cb - Callback to finish device init
665 * @ts: our goodix_ts_data pointer
667 * request_firmware_wait callback that finishes
668 * initialization of the device.
670 static void goodix_config_cb(const struct firmware *cfg, void *ctx)
672 struct goodix_ts_data *ts = ctx;
676 /* send device configuration to the firmware */
677 error = goodix_send_cfg(ts, cfg);
679 goto err_release_cfg;
682 goodix_configure_dev(ts);
685 release_firmware(cfg);
686 complete_all(&ts->firmware_loading_complete);
689 static int goodix_ts_probe(struct i2c_client *client,
690 const struct i2c_device_id *id)
692 struct goodix_ts_data *ts;
695 dev_dbg(&client->dev, "I2C Address: 0x%02x\n", client->addr);
697 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
698 dev_err(&client->dev, "I2C check functionality failed.\n");
702 ts = devm_kzalloc(&client->dev, sizeof(*ts), GFP_KERNEL);
707 i2c_set_clientdata(client, ts);
708 init_completion(&ts->firmware_loading_complete);
710 error = goodix_get_gpio_config(ts);
714 if (ts->gpiod_int && ts->gpiod_rst) {
715 /* reset the controller */
716 error = goodix_reset(ts);
718 dev_err(&client->dev, "Controller reset failed.\n");
723 error = goodix_i2c_test(client);
725 dev_err(&client->dev, "I2C communication failure: %d\n", error);
729 error = goodix_read_version(ts);
731 dev_err(&client->dev, "Read version failed.\n");
735 ts->cfg_len = goodix_get_cfg_len(ts->id);
737 if (ts->gpiod_int && ts->gpiod_rst) {
738 /* update device config */
739 ts->cfg_name = devm_kasprintf(&client->dev, GFP_KERNEL,
740 "goodix_%d_cfg.bin", ts->id);
744 error = request_firmware_nowait(THIS_MODULE, true, ts->cfg_name,
745 &client->dev, GFP_KERNEL, ts,
748 dev_err(&client->dev,
749 "Failed to invoke firmware loader: %d\n",
756 error = goodix_configure_dev(ts);
764 static int goodix_ts_remove(struct i2c_client *client)
766 struct goodix_ts_data *ts = i2c_get_clientdata(client);
768 if (ts->gpiod_int && ts->gpiod_rst)
769 wait_for_completion(&ts->firmware_loading_complete);
774 static int __maybe_unused goodix_suspend(struct device *dev)
776 struct i2c_client *client = to_i2c_client(dev);
777 struct goodix_ts_data *ts = i2c_get_clientdata(client);
780 /* We need gpio pins to suspend/resume */
781 if (!ts->gpiod_int || !ts->gpiod_rst)
784 wait_for_completion(&ts->firmware_loading_complete);
786 /* Free IRQ as IRQ pin is used as output in the suspend sequence */
789 /* Output LOW on the INT pin for 5 ms */
790 error = gpiod_direction_output(ts->gpiod_int, 0);
792 goodix_request_irq(ts);
796 usleep_range(5000, 6000);
798 error = goodix_i2c_write_u8(ts->client, GOODIX_REG_COMMAND,
799 GOODIX_CMD_SCREEN_OFF);
801 dev_err(&ts->client->dev, "Screen off command failed\n");
802 gpiod_direction_input(ts->gpiod_int);
803 goodix_request_irq(ts);
808 * The datasheet specifies that the interval between sending screen-off
809 * command and wake-up should be longer than 58 ms. To avoid waking up
810 * sooner, delay 58ms here.
816 static int __maybe_unused goodix_resume(struct device *dev)
818 struct i2c_client *client = to_i2c_client(dev);
819 struct goodix_ts_data *ts = i2c_get_clientdata(client);
822 if (!ts->gpiod_int || !ts->gpiod_rst)
826 * Exit sleep mode by outputting HIGH level to INT pin
829 error = gpiod_direction_output(ts->gpiod_int, 1);
833 usleep_range(2000, 5000);
835 error = goodix_int_sync(ts);
839 error = goodix_request_irq(ts);
846 static SIMPLE_DEV_PM_OPS(goodix_pm_ops, goodix_suspend, goodix_resume);
848 static const struct i2c_device_id goodix_ts_id[] = {
849 { "GDIX1001:00", 0 },
852 MODULE_DEVICE_TABLE(i2c, goodix_ts_id);
855 static const struct acpi_device_id goodix_acpi_match[] = {
859 MODULE_DEVICE_TABLE(acpi, goodix_acpi_match);
863 static const struct of_device_id goodix_of_match[] = {
864 { .compatible = "goodix,gt911" },
865 { .compatible = "goodix,gt9110" },
866 { .compatible = "goodix,gt912" },
867 { .compatible = "goodix,gt927" },
868 { .compatible = "goodix,gt9271" },
869 { .compatible = "goodix,gt928" },
870 { .compatible = "goodix,gt967" },
873 MODULE_DEVICE_TABLE(of, goodix_of_match);
876 static struct i2c_driver goodix_ts_driver = {
877 .probe = goodix_ts_probe,
878 .remove = goodix_ts_remove,
879 .id_table = goodix_ts_id,
882 .acpi_match_table = ACPI_PTR(goodix_acpi_match),
883 .of_match_table = of_match_ptr(goodix_of_match),
884 .pm = &goodix_pm_ops,
887 module_i2c_driver(goodix_ts_driver);
889 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
890 MODULE_AUTHOR("Bastien Nocera <hadess@hadess.net>");
891 MODULE_DESCRIPTION("Goodix touchscreen driver");
892 MODULE_LICENSE("GPL v2");