1ca96ea86SBastien Nocera /*
2ca96ea86SBastien Nocera  *  Driver for Goodix Touchscreens
3ca96ea86SBastien Nocera  *
4ca96ea86SBastien Nocera  *  Copyright (c) 2014 Red Hat Inc.
5ca96ea86SBastien Nocera  *
6ca96ea86SBastien Nocera  *  This code is based on gt9xx.c authored by andrew@goodix.com:
7ca96ea86SBastien Nocera  *
8ca96ea86SBastien Nocera  *  2010 - 2012 Goodix Technology.
9ca96ea86SBastien Nocera  */
10ca96ea86SBastien Nocera 
11ca96ea86SBastien Nocera /*
12ca96ea86SBastien Nocera  * This program is free software; you can redistribute it and/or modify it
13ca96ea86SBastien Nocera  * under the terms of the GNU General Public License as published by the Free
14ca96ea86SBastien Nocera  * Software Foundation; version 2 of the License.
15ca96ea86SBastien Nocera  */
16ca96ea86SBastien Nocera 
17ca96ea86SBastien Nocera #include <linux/kernel.h>
188b5a359cSBastien Nocera #include <linux/dmi.h>
1968caf858SIrina Tirdea #include <linux/firmware.h>
20ec6e1b40SIrina Tirdea #include <linux/gpio/consumer.h>
21ca96ea86SBastien Nocera #include <linux/i2c.h>
22ca96ea86SBastien Nocera #include <linux/input.h>
23ca96ea86SBastien Nocera #include <linux/input/mt.h>
24ca96ea86SBastien Nocera #include <linux/module.h>
25ca96ea86SBastien Nocera #include <linux/delay.h>
26ca96ea86SBastien Nocera #include <linux/irq.h>
27ca96ea86SBastien Nocera #include <linux/interrupt.h>
28ca96ea86SBastien Nocera #include <linux/slab.h>
29771d8f1bSAleksei Mamlin #include <linux/acpi.h>
30771d8f1bSAleksei Mamlin #include <linux/of.h>
31ca96ea86SBastien Nocera #include <asm/unaligned.h>
32ca96ea86SBastien Nocera 
33ca96ea86SBastien Nocera struct goodix_ts_data {
34ca96ea86SBastien Nocera 	struct i2c_client *client;
35ca96ea86SBastien Nocera 	struct input_dev *input_dev;
36ca96ea86SBastien Nocera 	int abs_x_max;
37ca96ea86SBastien Nocera 	int abs_y_max;
38ca96ea86SBastien Nocera 	unsigned int max_touch_num;
39ca96ea86SBastien Nocera 	unsigned int int_trigger_type;
408b5a359cSBastien Nocera 	bool rotated_screen;
41a779fbc6SIrina Tirdea 	int cfg_len;
42ec6e1b40SIrina Tirdea 	struct gpio_desc *gpiod_int;
43ec6e1b40SIrina Tirdea 	struct gpio_desc *gpiod_rst;
4468caf858SIrina Tirdea 	u16 id;
4568caf858SIrina Tirdea 	u16 version;
4668caf858SIrina Tirdea 	const char *cfg_name;
4768caf858SIrina Tirdea 	struct completion firmware_loading_complete;
485ab09d6aSIrina Tirdea 	unsigned long irq_flags;
49ca96ea86SBastien Nocera };
50ca96ea86SBastien Nocera 
51ec6e1b40SIrina Tirdea #define GOODIX_GPIO_INT_NAME		"irq"
52ec6e1b40SIrina Tirdea #define GOODIX_GPIO_RST_NAME		"reset"
53ec6e1b40SIrina Tirdea 
54ca96ea86SBastien Nocera #define GOODIX_MAX_HEIGHT		4096
55ca96ea86SBastien Nocera #define GOODIX_MAX_WIDTH		4096
56ca96ea86SBastien Nocera #define GOODIX_INT_TRIGGER		1
57ca96ea86SBastien Nocera #define GOODIX_CONTACT_SIZE		8
58ca96ea86SBastien Nocera #define GOODIX_MAX_CONTACTS		10
59ca96ea86SBastien Nocera 
60ca96ea86SBastien Nocera #define GOODIX_CONFIG_MAX_LENGTH	240
61a779fbc6SIrina Tirdea #define GOODIX_CONFIG_911_LENGTH	186
62a779fbc6SIrina Tirdea #define GOODIX_CONFIG_967_LENGTH	228
63ca96ea86SBastien Nocera 
64ca96ea86SBastien Nocera /* Register defines */
655ab09d6aSIrina Tirdea #define GOODIX_REG_COMMAND		0x8040
665ab09d6aSIrina Tirdea #define GOODIX_CMD_SCREEN_OFF		0x05
675ab09d6aSIrina Tirdea 
68ca96ea86SBastien Nocera #define GOODIX_READ_COOR_ADDR		0x814E
69ca96ea86SBastien Nocera #define GOODIX_REG_CONFIG_DATA		0x8047
70e70b0307SIrina Tirdea #define GOODIX_REG_ID			0x8140
71ca96ea86SBastien Nocera 
72ca96ea86SBastien Nocera #define RESOLUTION_LOC		1
73a7ac7c95SAleksei Mamlin #define MAX_CONTACTS_LOC	5
74ca96ea86SBastien Nocera #define TRIGGER_LOC		6
75ca96ea86SBastien Nocera 
76ca96ea86SBastien Nocera static const unsigned long goodix_irq_flags[] = {
77ca96ea86SBastien Nocera 	IRQ_TYPE_EDGE_RISING,
78ca96ea86SBastien Nocera 	IRQ_TYPE_EDGE_FALLING,
79ca96ea86SBastien Nocera 	IRQ_TYPE_LEVEL_LOW,
80ca96ea86SBastien Nocera 	IRQ_TYPE_LEVEL_HIGH,
81ca96ea86SBastien Nocera };
82ca96ea86SBastien Nocera 
838b5a359cSBastien Nocera /*
848b5a359cSBastien Nocera  * Those tablets have their coordinates origin at the bottom right
858b5a359cSBastien Nocera  * of the tablet, as if rotated 180 degrees
868b5a359cSBastien Nocera  */
878b5a359cSBastien Nocera static const struct dmi_system_id rotated_screen[] = {
888b5a359cSBastien Nocera #if defined(CONFIG_DMI) && defined(CONFIG_X86)
898b5a359cSBastien Nocera 	{
908b5a359cSBastien Nocera 		.ident = "WinBook TW100",
918b5a359cSBastien Nocera 		.matches = {
928b5a359cSBastien Nocera 			DMI_MATCH(DMI_SYS_VENDOR, "WinBook"),
938b5a359cSBastien Nocera 			DMI_MATCH(DMI_PRODUCT_NAME, "TW100")
948b5a359cSBastien Nocera 		}
958b5a359cSBastien Nocera 	},
968b5a359cSBastien Nocera 	{
978b5a359cSBastien Nocera 		.ident = "WinBook TW700",
988b5a359cSBastien Nocera 		.matches = {
998b5a359cSBastien Nocera 			DMI_MATCH(DMI_SYS_VENDOR, "WinBook"),
1008b5a359cSBastien Nocera 			DMI_MATCH(DMI_PRODUCT_NAME, "TW700")
1018b5a359cSBastien Nocera 		},
1028b5a359cSBastien Nocera 	},
1038b5a359cSBastien Nocera #endif
1048b5a359cSBastien Nocera 	{}
1058b5a359cSBastien Nocera };
1068b5a359cSBastien Nocera 
107ca96ea86SBastien Nocera /**
108ca96ea86SBastien Nocera  * goodix_i2c_read - read data from a register of the i2c slave device.
109ca96ea86SBastien Nocera  *
110ca96ea86SBastien Nocera  * @client: i2c device.
111ca96ea86SBastien Nocera  * @reg: the register to read from.
112ca96ea86SBastien Nocera  * @buf: raw write data buffer.
113ca96ea86SBastien Nocera  * @len: length of the buffer to write
114ca96ea86SBastien Nocera  */
115ca96ea86SBastien Nocera static int goodix_i2c_read(struct i2c_client *client,
116ca96ea86SBastien Nocera 			   u16 reg, u8 *buf, int len)
117ca96ea86SBastien Nocera {
118ca96ea86SBastien Nocera 	struct i2c_msg msgs[2];
119ca96ea86SBastien Nocera 	u16 wbuf = cpu_to_be16(reg);
120ca96ea86SBastien Nocera 	int ret;
121ca96ea86SBastien Nocera 
122ca96ea86SBastien Nocera 	msgs[0].flags = 0;
123ca96ea86SBastien Nocera 	msgs[0].addr  = client->addr;
124ca96ea86SBastien Nocera 	msgs[0].len   = 2;
125ca96ea86SBastien Nocera 	msgs[0].buf   = (u8 *)&wbuf;
126ca96ea86SBastien Nocera 
127ca96ea86SBastien Nocera 	msgs[1].flags = I2C_M_RD;
128ca96ea86SBastien Nocera 	msgs[1].addr  = client->addr;
129ca96ea86SBastien Nocera 	msgs[1].len   = len;
130ca96ea86SBastien Nocera 	msgs[1].buf   = buf;
131ca96ea86SBastien Nocera 
132ca96ea86SBastien Nocera 	ret = i2c_transfer(client->adapter, msgs, 2);
133ca96ea86SBastien Nocera 	return ret < 0 ? ret : (ret != ARRAY_SIZE(msgs) ? -EIO : 0);
134ca96ea86SBastien Nocera }
135ca96ea86SBastien Nocera 
13668caf858SIrina Tirdea /**
13768caf858SIrina Tirdea  * goodix_i2c_write - write data to a register of the i2c slave device.
13868caf858SIrina Tirdea  *
13968caf858SIrina Tirdea  * @client: i2c device.
14068caf858SIrina Tirdea  * @reg: the register to write to.
14168caf858SIrina Tirdea  * @buf: raw data buffer to write.
14268caf858SIrina Tirdea  * @len: length of the buffer to write
14368caf858SIrina Tirdea  */
14468caf858SIrina Tirdea static int goodix_i2c_write(struct i2c_client *client, u16 reg, const u8 *buf,
14568caf858SIrina Tirdea 			    unsigned len)
14668caf858SIrina Tirdea {
14768caf858SIrina Tirdea 	u8 *addr_buf;
14868caf858SIrina Tirdea 	struct i2c_msg msg;
14968caf858SIrina Tirdea 	int ret;
15068caf858SIrina Tirdea 
15168caf858SIrina Tirdea 	addr_buf = kmalloc(len + 2, GFP_KERNEL);
15268caf858SIrina Tirdea 	if (!addr_buf)
15368caf858SIrina Tirdea 		return -ENOMEM;
15468caf858SIrina Tirdea 
15568caf858SIrina Tirdea 	addr_buf[0] = reg >> 8;
15668caf858SIrina Tirdea 	addr_buf[1] = reg & 0xFF;
15768caf858SIrina Tirdea 	memcpy(&addr_buf[2], buf, len);
15868caf858SIrina Tirdea 
15968caf858SIrina Tirdea 	msg.flags = 0;
16068caf858SIrina Tirdea 	msg.addr = client->addr;
16168caf858SIrina Tirdea 	msg.buf = addr_buf;
16268caf858SIrina Tirdea 	msg.len = len + 2;
16368caf858SIrina Tirdea 
16468caf858SIrina Tirdea 	ret = i2c_transfer(client->adapter, &msg, 1);
16568caf858SIrina Tirdea 	kfree(addr_buf);
16668caf858SIrina Tirdea 	return ret < 0 ? ret : (ret != 1 ? -EIO : 0);
16768caf858SIrina Tirdea }
16868caf858SIrina Tirdea 
1695ab09d6aSIrina Tirdea static int goodix_i2c_write_u8(struct i2c_client *client, u16 reg, u8 value)
1705ab09d6aSIrina Tirdea {
1715ab09d6aSIrina Tirdea 	return goodix_i2c_write(client, reg, &value, sizeof(value));
1725ab09d6aSIrina Tirdea }
1735ab09d6aSIrina Tirdea 
174a779fbc6SIrina Tirdea static int goodix_get_cfg_len(u16 id)
175a779fbc6SIrina Tirdea {
176a779fbc6SIrina Tirdea 	switch (id) {
177a779fbc6SIrina Tirdea 	case 911:
178a779fbc6SIrina Tirdea 	case 9271:
179a779fbc6SIrina Tirdea 	case 9110:
180a779fbc6SIrina Tirdea 	case 927:
181a779fbc6SIrina Tirdea 	case 928:
182a779fbc6SIrina Tirdea 		return GOODIX_CONFIG_911_LENGTH;
183a779fbc6SIrina Tirdea 
184a779fbc6SIrina Tirdea 	case 912:
185a779fbc6SIrina Tirdea 	case 967:
186a779fbc6SIrina Tirdea 		return GOODIX_CONFIG_967_LENGTH;
187a779fbc6SIrina Tirdea 
188a779fbc6SIrina Tirdea 	default:
189a779fbc6SIrina Tirdea 		return GOODIX_CONFIG_MAX_LENGTH;
190a779fbc6SIrina Tirdea 	}
191a779fbc6SIrina Tirdea }
192a779fbc6SIrina Tirdea 
193ca96ea86SBastien Nocera static int goodix_ts_read_input_report(struct goodix_ts_data *ts, u8 *data)
194ca96ea86SBastien Nocera {
195ca96ea86SBastien Nocera 	int touch_num;
196ca96ea86SBastien Nocera 	int error;
197ca96ea86SBastien Nocera 
198ca96ea86SBastien Nocera 	error = goodix_i2c_read(ts->client, GOODIX_READ_COOR_ADDR, data,
199ca96ea86SBastien Nocera 				GOODIX_CONTACT_SIZE + 1);
200ca96ea86SBastien Nocera 	if (error) {
201ca96ea86SBastien Nocera 		dev_err(&ts->client->dev, "I2C transfer error: %d\n", error);
202ca96ea86SBastien Nocera 		return error;
203ca96ea86SBastien Nocera 	}
204ca96ea86SBastien Nocera 
2055f6f117cSPaul Cercueil 	if (!(data[0] & 0x80))
2065f6f117cSPaul Cercueil 		return -EAGAIN;
2075f6f117cSPaul Cercueil 
208ca96ea86SBastien Nocera 	touch_num = data[0] & 0x0f;
209a7ac7c95SAleksei Mamlin 	if (touch_num > ts->max_touch_num)
210ca96ea86SBastien Nocera 		return -EPROTO;
211ca96ea86SBastien Nocera 
212ca96ea86SBastien Nocera 	if (touch_num > 1) {
213ca96ea86SBastien Nocera 		data += 1 + GOODIX_CONTACT_SIZE;
214ca96ea86SBastien Nocera 		error = goodix_i2c_read(ts->client,
215ca96ea86SBastien Nocera 					GOODIX_READ_COOR_ADDR +
216ca96ea86SBastien Nocera 						1 + GOODIX_CONTACT_SIZE,
217ca96ea86SBastien Nocera 					data,
218ca96ea86SBastien Nocera 					GOODIX_CONTACT_SIZE * (touch_num - 1));
219ca96ea86SBastien Nocera 		if (error)
220ca96ea86SBastien Nocera 			return error;
221ca96ea86SBastien Nocera 	}
222ca96ea86SBastien Nocera 
223ca96ea86SBastien Nocera 	return touch_num;
224ca96ea86SBastien Nocera }
225ca96ea86SBastien Nocera 
226ca96ea86SBastien Nocera static void goodix_ts_report_touch(struct goodix_ts_data *ts, u8 *coor_data)
227ca96ea86SBastien Nocera {
228ca96ea86SBastien Nocera 	int id = coor_data[0] & 0x0F;
229ca96ea86SBastien Nocera 	int input_x = get_unaligned_le16(&coor_data[1]);
230ca96ea86SBastien Nocera 	int input_y = get_unaligned_le16(&coor_data[3]);
231ca96ea86SBastien Nocera 	int input_w = get_unaligned_le16(&coor_data[5]);
232ca96ea86SBastien Nocera 
2338b5a359cSBastien Nocera 	if (ts->rotated_screen) {
2348b5a359cSBastien Nocera 		input_x = ts->abs_x_max - input_x;
2358b5a359cSBastien Nocera 		input_y = ts->abs_y_max - input_y;
2368b5a359cSBastien Nocera 	}
2378b5a359cSBastien Nocera 
238ca96ea86SBastien Nocera 	input_mt_slot(ts->input_dev, id);
239ca96ea86SBastien Nocera 	input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true);
240ca96ea86SBastien Nocera 	input_report_abs(ts->input_dev, ABS_MT_POSITION_X, input_x);
241ca96ea86SBastien Nocera 	input_report_abs(ts->input_dev, ABS_MT_POSITION_Y, input_y);
242ca96ea86SBastien Nocera 	input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w);
243ca96ea86SBastien Nocera 	input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w);
244ca96ea86SBastien Nocera }
245ca96ea86SBastien Nocera 
246ca96ea86SBastien Nocera /**
247ca96ea86SBastien Nocera  * goodix_process_events - Process incoming events
248ca96ea86SBastien Nocera  *
249ca96ea86SBastien Nocera  * @ts: our goodix_ts_data pointer
250ca96ea86SBastien Nocera  *
251ca96ea86SBastien Nocera  * Called when the IRQ is triggered. Read the current device state, and push
252ca96ea86SBastien Nocera  * the input events to the user space.
253ca96ea86SBastien Nocera  */
254ca96ea86SBastien Nocera static void goodix_process_events(struct goodix_ts_data *ts)
255ca96ea86SBastien Nocera {
2560e0432f0SIrina Tirdea 	u8  point_data[1 + GOODIX_CONTACT_SIZE * GOODIX_MAX_CONTACTS];
257ca96ea86SBastien Nocera 	int touch_num;
258ca96ea86SBastien Nocera 	int i;
259ca96ea86SBastien Nocera 
260ca96ea86SBastien Nocera 	touch_num = goodix_ts_read_input_report(ts, point_data);
261ca96ea86SBastien Nocera 	if (touch_num < 0)
262ca96ea86SBastien Nocera 		return;
263ca96ea86SBastien Nocera 
264ca96ea86SBastien Nocera 	for (i = 0; i < touch_num; i++)
265ca96ea86SBastien Nocera 		goodix_ts_report_touch(ts,
266ca96ea86SBastien Nocera 				&point_data[1 + GOODIX_CONTACT_SIZE * i]);
267ca96ea86SBastien Nocera 
268ca96ea86SBastien Nocera 	input_mt_sync_frame(ts->input_dev);
269ca96ea86SBastien Nocera 	input_sync(ts->input_dev);
270ca96ea86SBastien Nocera }
271ca96ea86SBastien Nocera 
272ca96ea86SBastien Nocera /**
273ca96ea86SBastien Nocera  * goodix_ts_irq_handler - The IRQ handler
274ca96ea86SBastien Nocera  *
275ca96ea86SBastien Nocera  * @irq: interrupt number.
276ca96ea86SBastien Nocera  * @dev_id: private data pointer.
277ca96ea86SBastien Nocera  */
278ca96ea86SBastien Nocera static irqreturn_t goodix_ts_irq_handler(int irq, void *dev_id)
279ca96ea86SBastien Nocera {
280ca96ea86SBastien Nocera 	static const u8 end_cmd[] = {
281ca96ea86SBastien Nocera 		GOODIX_READ_COOR_ADDR >> 8,
282ca96ea86SBastien Nocera 		GOODIX_READ_COOR_ADDR & 0xff,
283ca96ea86SBastien Nocera 		0
284ca96ea86SBastien Nocera 	};
285ca96ea86SBastien Nocera 	struct goodix_ts_data *ts = dev_id;
286ca96ea86SBastien Nocera 
287ca96ea86SBastien Nocera 	goodix_process_events(ts);
288ca96ea86SBastien Nocera 
289ca96ea86SBastien Nocera 	if (i2c_master_send(ts->client, end_cmd, sizeof(end_cmd)) < 0)
290ca96ea86SBastien Nocera 		dev_err(&ts->client->dev, "I2C write end_cmd error\n");
291ca96ea86SBastien Nocera 
292ca96ea86SBastien Nocera 	return IRQ_HANDLED;
293ca96ea86SBastien Nocera }
294ca96ea86SBastien Nocera 
2955ab09d6aSIrina Tirdea static void goodix_free_irq(struct goodix_ts_data *ts)
2965ab09d6aSIrina Tirdea {
2975ab09d6aSIrina Tirdea 	devm_free_irq(&ts->client->dev, ts->client->irq, ts);
2985ab09d6aSIrina Tirdea }
2995ab09d6aSIrina Tirdea 
3005ab09d6aSIrina Tirdea static int goodix_request_irq(struct goodix_ts_data *ts)
3015ab09d6aSIrina Tirdea {
3025ab09d6aSIrina Tirdea 	return devm_request_threaded_irq(&ts->client->dev, ts->client->irq,
3035ab09d6aSIrina Tirdea 					 NULL, goodix_ts_irq_handler,
3045ab09d6aSIrina Tirdea 					 ts->irq_flags, ts->client->name, ts);
3055ab09d6aSIrina Tirdea }
3065ab09d6aSIrina Tirdea 
30768caf858SIrina Tirdea /**
30868caf858SIrina Tirdea  * goodix_check_cfg - Checks if config fw is valid
30968caf858SIrina Tirdea  *
31068caf858SIrina Tirdea  * @ts: goodix_ts_data pointer
31168caf858SIrina Tirdea  * @cfg: firmware config data
31268caf858SIrina Tirdea  */
31368caf858SIrina Tirdea static int goodix_check_cfg(struct goodix_ts_data *ts,
31468caf858SIrina Tirdea 			    const struct firmware *cfg)
31568caf858SIrina Tirdea {
31668caf858SIrina Tirdea 	int i, raw_cfg_len;
31768caf858SIrina Tirdea 	u8 check_sum = 0;
31868caf858SIrina Tirdea 
31968caf858SIrina Tirdea 	if (cfg->size > GOODIX_CONFIG_MAX_LENGTH) {
32068caf858SIrina Tirdea 		dev_err(&ts->client->dev,
32168caf858SIrina Tirdea 			"The length of the config fw is not correct");
32268caf858SIrina Tirdea 		return -EINVAL;
32368caf858SIrina Tirdea 	}
32468caf858SIrina Tirdea 
32568caf858SIrina Tirdea 	raw_cfg_len = cfg->size - 2;
32668caf858SIrina Tirdea 	for (i = 0; i < raw_cfg_len; i++)
32768caf858SIrina Tirdea 		check_sum += cfg->data[i];
32868caf858SIrina Tirdea 	check_sum = (~check_sum) + 1;
32968caf858SIrina Tirdea 	if (check_sum != cfg->data[raw_cfg_len]) {
33068caf858SIrina Tirdea 		dev_err(&ts->client->dev,
33168caf858SIrina Tirdea 			"The checksum of the config fw is not correct");
33268caf858SIrina Tirdea 		return -EINVAL;
33368caf858SIrina Tirdea 	}
33468caf858SIrina Tirdea 
33568caf858SIrina Tirdea 	if (cfg->data[raw_cfg_len + 1] != 1) {
33668caf858SIrina Tirdea 		dev_err(&ts->client->dev,
33768caf858SIrina Tirdea 			"Config fw must have Config_Fresh register set");
33868caf858SIrina Tirdea 		return -EINVAL;
33968caf858SIrina Tirdea 	}
34068caf858SIrina Tirdea 
34168caf858SIrina Tirdea 	return 0;
34268caf858SIrina Tirdea }
34368caf858SIrina Tirdea 
34468caf858SIrina Tirdea /**
34568caf858SIrina Tirdea  * goodix_send_cfg - Write fw config to device
34668caf858SIrina Tirdea  *
34768caf858SIrina Tirdea  * @ts: goodix_ts_data pointer
34868caf858SIrina Tirdea  * @cfg: config firmware to write to device
34968caf858SIrina Tirdea  */
35068caf858SIrina Tirdea static int goodix_send_cfg(struct goodix_ts_data *ts,
35168caf858SIrina Tirdea 			   const struct firmware *cfg)
35268caf858SIrina Tirdea {
35368caf858SIrina Tirdea 	int error;
35468caf858SIrina Tirdea 
35568caf858SIrina Tirdea 	error = goodix_check_cfg(ts, cfg);
35668caf858SIrina Tirdea 	if (error)
35768caf858SIrina Tirdea 		return error;
35868caf858SIrina Tirdea 
35968caf858SIrina Tirdea 	error = goodix_i2c_write(ts->client, GOODIX_REG_CONFIG_DATA, cfg->data,
36068caf858SIrina Tirdea 				 cfg->size);
36168caf858SIrina Tirdea 	if (error) {
36268caf858SIrina Tirdea 		dev_err(&ts->client->dev, "Failed to write config data: %d",
36368caf858SIrina Tirdea 			error);
36468caf858SIrina Tirdea 		return error;
36568caf858SIrina Tirdea 	}
36668caf858SIrina Tirdea 	dev_dbg(&ts->client->dev, "Config sent successfully.");
36768caf858SIrina Tirdea 
36868caf858SIrina Tirdea 	/* Let the firmware reconfigure itself, so sleep for 10ms */
36968caf858SIrina Tirdea 	usleep_range(10000, 11000);
37068caf858SIrina Tirdea 
37168caf858SIrina Tirdea 	return 0;
37268caf858SIrina Tirdea }
37368caf858SIrina Tirdea 
374ec6e1b40SIrina Tirdea static int goodix_int_sync(struct goodix_ts_data *ts)
375ec6e1b40SIrina Tirdea {
376ec6e1b40SIrina Tirdea 	int error;
377ec6e1b40SIrina Tirdea 
378ec6e1b40SIrina Tirdea 	error = gpiod_direction_output(ts->gpiod_int, 0);
379ec6e1b40SIrina Tirdea 	if (error)
380ec6e1b40SIrina Tirdea 		return error;
381ec6e1b40SIrina Tirdea 
382ec6e1b40SIrina Tirdea 	msleep(50);				/* T5: 50ms */
383ec6e1b40SIrina Tirdea 
384ec6e1b40SIrina Tirdea 	error = gpiod_direction_input(ts->gpiod_int);
385ec6e1b40SIrina Tirdea 	if (error)
386ec6e1b40SIrina Tirdea 		return error;
387ec6e1b40SIrina Tirdea 
388ec6e1b40SIrina Tirdea 	return 0;
389ec6e1b40SIrina Tirdea }
390ec6e1b40SIrina Tirdea 
391ec6e1b40SIrina Tirdea /**
392ec6e1b40SIrina Tirdea  * goodix_reset - Reset device during power on
393ec6e1b40SIrina Tirdea  *
394ec6e1b40SIrina Tirdea  * @ts: goodix_ts_data pointer
395ec6e1b40SIrina Tirdea  */
396ec6e1b40SIrina Tirdea static int goodix_reset(struct goodix_ts_data *ts)
397ec6e1b40SIrina Tirdea {
398ec6e1b40SIrina Tirdea 	int error;
399ec6e1b40SIrina Tirdea 
400ec6e1b40SIrina Tirdea 	/* begin select I2C slave addr */
401ec6e1b40SIrina Tirdea 	error = gpiod_direction_output(ts->gpiod_rst, 0);
402ec6e1b40SIrina Tirdea 	if (error)
403ec6e1b40SIrina Tirdea 		return error;
404ec6e1b40SIrina Tirdea 
405ec6e1b40SIrina Tirdea 	msleep(20);				/* T2: > 10ms */
406ec6e1b40SIrina Tirdea 
407ec6e1b40SIrina Tirdea 	/* HIGH: 0x28/0x29, LOW: 0xBA/0xBB */
408ec6e1b40SIrina Tirdea 	error = gpiod_direction_output(ts->gpiod_int, ts->client->addr == 0x14);
409ec6e1b40SIrina Tirdea 	if (error)
410ec6e1b40SIrina Tirdea 		return error;
411ec6e1b40SIrina Tirdea 
412ec6e1b40SIrina Tirdea 	usleep_range(100, 2000);		/* T3: > 100us */
413ec6e1b40SIrina Tirdea 
414ec6e1b40SIrina Tirdea 	error = gpiod_direction_output(ts->gpiod_rst, 1);
415ec6e1b40SIrina Tirdea 	if (error)
416ec6e1b40SIrina Tirdea 		return error;
417ec6e1b40SIrina Tirdea 
418ec6e1b40SIrina Tirdea 	usleep_range(6000, 10000);		/* T4: > 5ms */
419ec6e1b40SIrina Tirdea 
420ec6e1b40SIrina Tirdea 	/* end select I2C slave addr */
421ec6e1b40SIrina Tirdea 	error = gpiod_direction_input(ts->gpiod_rst);
422ec6e1b40SIrina Tirdea 	if (error)
423ec6e1b40SIrina Tirdea 		return error;
424ec6e1b40SIrina Tirdea 
425ec6e1b40SIrina Tirdea 	error = goodix_int_sync(ts);
426ec6e1b40SIrina Tirdea 	if (error)
427ec6e1b40SIrina Tirdea 		return error;
428ec6e1b40SIrina Tirdea 
429ec6e1b40SIrina Tirdea 	return 0;
430ec6e1b40SIrina Tirdea }
431ec6e1b40SIrina Tirdea 
432ec6e1b40SIrina Tirdea /**
433ec6e1b40SIrina Tirdea  * goodix_get_gpio_config - Get GPIO config from ACPI/DT
434ec6e1b40SIrina Tirdea  *
435ec6e1b40SIrina Tirdea  * @ts: goodix_ts_data pointer
436ec6e1b40SIrina Tirdea  */
437ec6e1b40SIrina Tirdea static int goodix_get_gpio_config(struct goodix_ts_data *ts)
438ec6e1b40SIrina Tirdea {
439ec6e1b40SIrina Tirdea 	int error;
440ec6e1b40SIrina Tirdea 	struct device *dev;
441ec6e1b40SIrina Tirdea 	struct gpio_desc *gpiod;
442ec6e1b40SIrina Tirdea 
443ec6e1b40SIrina Tirdea 	if (!ts->client)
444ec6e1b40SIrina Tirdea 		return -EINVAL;
445ec6e1b40SIrina Tirdea 	dev = &ts->client->dev;
446ec6e1b40SIrina Tirdea 
447ec6e1b40SIrina Tirdea 	/* Get the interrupt GPIO pin number */
448ec6e1b40SIrina Tirdea 	gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_INT_NAME, GPIOD_IN);
449ec6e1b40SIrina Tirdea 	if (IS_ERR(gpiod)) {
450ec6e1b40SIrina Tirdea 		error = PTR_ERR(gpiod);
451ec6e1b40SIrina Tirdea 		if (error != -EPROBE_DEFER)
452ec6e1b40SIrina Tirdea 			dev_dbg(dev, "Failed to get %s GPIO: %d\n",
453ec6e1b40SIrina Tirdea 				GOODIX_GPIO_INT_NAME, error);
454ec6e1b40SIrina Tirdea 		return error;
455ec6e1b40SIrina Tirdea 	}
456ec6e1b40SIrina Tirdea 
457ec6e1b40SIrina Tirdea 	ts->gpiod_int = gpiod;
458ec6e1b40SIrina Tirdea 
459ec6e1b40SIrina Tirdea 	/* Get the reset line GPIO pin number */
460ec6e1b40SIrina Tirdea 	gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_RST_NAME, GPIOD_IN);
461ec6e1b40SIrina Tirdea 	if (IS_ERR(gpiod)) {
462ec6e1b40SIrina Tirdea 		error = PTR_ERR(gpiod);
463ec6e1b40SIrina Tirdea 		if (error != -EPROBE_DEFER)
464ec6e1b40SIrina Tirdea 			dev_dbg(dev, "Failed to get %s GPIO: %d\n",
465ec6e1b40SIrina Tirdea 				GOODIX_GPIO_RST_NAME, error);
466ec6e1b40SIrina Tirdea 		return error;
467ec6e1b40SIrina Tirdea 	}
468ec6e1b40SIrina Tirdea 
469ec6e1b40SIrina Tirdea 	ts->gpiod_rst = gpiod;
470ec6e1b40SIrina Tirdea 
471ec6e1b40SIrina Tirdea 	return 0;
472ec6e1b40SIrina Tirdea }
473ec6e1b40SIrina Tirdea 
474ca96ea86SBastien Nocera /**
475ca96ea86SBastien Nocera  * goodix_read_config - Read the embedded configuration of the panel
476ca96ea86SBastien Nocera  *
477ca96ea86SBastien Nocera  * @ts: our goodix_ts_data pointer
478ca96ea86SBastien Nocera  *
479ca96ea86SBastien Nocera  * Must be called during probe
480ca96ea86SBastien Nocera  */
481ca96ea86SBastien Nocera static void goodix_read_config(struct goodix_ts_data *ts)
482ca96ea86SBastien Nocera {
483ca96ea86SBastien Nocera 	u8 config[GOODIX_CONFIG_MAX_LENGTH];
484ca96ea86SBastien Nocera 	int error;
485ca96ea86SBastien Nocera 
486ca96ea86SBastien Nocera 	error = goodix_i2c_read(ts->client, GOODIX_REG_CONFIG_DATA,
487a779fbc6SIrina Tirdea 				config, ts->cfg_len);
488ca96ea86SBastien Nocera 	if (error) {
489ca96ea86SBastien Nocera 		dev_warn(&ts->client->dev,
490ca96ea86SBastien Nocera 			 "Error reading config (%d), using defaults\n",
491ca96ea86SBastien Nocera 			 error);
492ca96ea86SBastien Nocera 		ts->abs_x_max = GOODIX_MAX_WIDTH;
493ca96ea86SBastien Nocera 		ts->abs_y_max = GOODIX_MAX_HEIGHT;
494ca96ea86SBastien Nocera 		ts->int_trigger_type = GOODIX_INT_TRIGGER;
495a7ac7c95SAleksei Mamlin 		ts->max_touch_num = GOODIX_MAX_CONTACTS;
496ca96ea86SBastien Nocera 		return;
497ca96ea86SBastien Nocera 	}
498ca96ea86SBastien Nocera 
499ca96ea86SBastien Nocera 	ts->abs_x_max = get_unaligned_le16(&config[RESOLUTION_LOC]);
500ca96ea86SBastien Nocera 	ts->abs_y_max = get_unaligned_le16(&config[RESOLUTION_LOC + 2]);
501a7ac7c95SAleksei Mamlin 	ts->int_trigger_type = config[TRIGGER_LOC] & 0x03;
502a7ac7c95SAleksei Mamlin 	ts->max_touch_num = config[MAX_CONTACTS_LOC] & 0x0f;
503a7ac7c95SAleksei Mamlin 	if (!ts->abs_x_max || !ts->abs_y_max || !ts->max_touch_num) {
504ca96ea86SBastien Nocera 		dev_err(&ts->client->dev,
505ca96ea86SBastien Nocera 			"Invalid config, using defaults\n");
506ca96ea86SBastien Nocera 		ts->abs_x_max = GOODIX_MAX_WIDTH;
507ca96ea86SBastien Nocera 		ts->abs_y_max = GOODIX_MAX_HEIGHT;
508a7ac7c95SAleksei Mamlin 		ts->max_touch_num = GOODIX_MAX_CONTACTS;
509ca96ea86SBastien Nocera 	}
5108b5a359cSBastien Nocera 
5118b5a359cSBastien Nocera 	ts->rotated_screen = dmi_check_system(rotated_screen);
5128b5a359cSBastien Nocera 	if (ts->rotated_screen)
5138b5a359cSBastien Nocera 		dev_dbg(&ts->client->dev,
5148b5a359cSBastien Nocera 			 "Applying '180 degrees rotated screen' quirk\n");
515ca96ea86SBastien Nocera }
516ca96ea86SBastien Nocera 
517ca96ea86SBastien Nocera /**
518ca96ea86SBastien Nocera  * goodix_read_version - Read goodix touchscreen version
519ca96ea86SBastien Nocera  *
52068caf858SIrina Tirdea  * @ts: our goodix_ts_data pointer
521ca96ea86SBastien Nocera  */
52268caf858SIrina Tirdea static int goodix_read_version(struct goodix_ts_data *ts)
523ca96ea86SBastien Nocera {
524ca96ea86SBastien Nocera 	int error;
525ca96ea86SBastien Nocera 	u8 buf[6];
526e70b0307SIrina Tirdea 	char id_str[5];
527ca96ea86SBastien Nocera 
52868caf858SIrina Tirdea 	error = goodix_i2c_read(ts->client, GOODIX_REG_ID, buf, sizeof(buf));
529ca96ea86SBastien Nocera 	if (error) {
53068caf858SIrina Tirdea 		dev_err(&ts->client->dev, "read version failed: %d\n", error);
531ca96ea86SBastien Nocera 		return error;
532ca96ea86SBastien Nocera 	}
533ca96ea86SBastien Nocera 
534e70b0307SIrina Tirdea 	memcpy(id_str, buf, 4);
535e70b0307SIrina Tirdea 	id_str[4] = 0;
53668caf858SIrina Tirdea 	if (kstrtou16(id_str, 10, &ts->id))
53768caf858SIrina Tirdea 		ts->id = 0x1001;
538e70b0307SIrina Tirdea 
53968caf858SIrina Tirdea 	ts->version = get_unaligned_le16(&buf[4]);
540ca96ea86SBastien Nocera 
54168caf858SIrina Tirdea 	dev_info(&ts->client->dev, "ID %d, version: %04x\n", ts->id,
54268caf858SIrina Tirdea 		 ts->version);
543ca96ea86SBastien Nocera 
544ca96ea86SBastien Nocera 	return 0;
545ca96ea86SBastien Nocera }
546ca96ea86SBastien Nocera 
547ca96ea86SBastien Nocera /**
548ca96ea86SBastien Nocera  * goodix_i2c_test - I2C test function to check if the device answers.
549ca96ea86SBastien Nocera  *
550ca96ea86SBastien Nocera  * @client: the i2c client
551ca96ea86SBastien Nocera  */
552ca96ea86SBastien Nocera static int goodix_i2c_test(struct i2c_client *client)
553ca96ea86SBastien Nocera {
554ca96ea86SBastien Nocera 	int retry = 0;
555ca96ea86SBastien Nocera 	int error;
556ca96ea86SBastien Nocera 	u8 test;
557ca96ea86SBastien Nocera 
558ca96ea86SBastien Nocera 	while (retry++ < 2) {
559ca96ea86SBastien Nocera 		error = goodix_i2c_read(client, GOODIX_REG_CONFIG_DATA,
560ca96ea86SBastien Nocera 					&test, 1);
561ca96ea86SBastien Nocera 		if (!error)
562ca96ea86SBastien Nocera 			return 0;
563ca96ea86SBastien Nocera 
564ca96ea86SBastien Nocera 		dev_err(&client->dev, "i2c test failed attempt %d: %d\n",
565ca96ea86SBastien Nocera 			retry, error);
566ca96ea86SBastien Nocera 		msleep(20);
567ca96ea86SBastien Nocera 	}
568ca96ea86SBastien Nocera 
569ca96ea86SBastien Nocera 	return error;
570ca96ea86SBastien Nocera }
571ca96ea86SBastien Nocera 
572ca96ea86SBastien Nocera /**
573ca96ea86SBastien Nocera  * goodix_request_input_dev - Allocate, populate and register the input device
574ca96ea86SBastien Nocera  *
575ca96ea86SBastien Nocera  * @ts: our goodix_ts_data pointer
576ca96ea86SBastien Nocera  *
577ca96ea86SBastien Nocera  * Must be called during probe
578ca96ea86SBastien Nocera  */
57968caf858SIrina Tirdea static int goodix_request_input_dev(struct goodix_ts_data *ts)
580ca96ea86SBastien Nocera {
581ca96ea86SBastien Nocera 	int error;
582ca96ea86SBastien Nocera 
583ca96ea86SBastien Nocera 	ts->input_dev = devm_input_allocate_device(&ts->client->dev);
584ca96ea86SBastien Nocera 	if (!ts->input_dev) {
585ca96ea86SBastien Nocera 		dev_err(&ts->client->dev, "Failed to allocate input device.");
586ca96ea86SBastien Nocera 		return -ENOMEM;
587ca96ea86SBastien Nocera 	}
588ca96ea86SBastien Nocera 
5890dfb35bdSIrina Tirdea 	input_set_abs_params(ts->input_dev, ABS_MT_POSITION_X,
5900dfb35bdSIrina Tirdea 			     0, ts->abs_x_max, 0, 0);
5910dfb35bdSIrina Tirdea 	input_set_abs_params(ts->input_dev, ABS_MT_POSITION_Y,
5920dfb35bdSIrina Tirdea 			     0, ts->abs_y_max, 0, 0);
593ca96ea86SBastien Nocera 	input_set_abs_params(ts->input_dev, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0);
594ca96ea86SBastien Nocera 	input_set_abs_params(ts->input_dev, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
595ca96ea86SBastien Nocera 
596a7ac7c95SAleksei Mamlin 	input_mt_init_slots(ts->input_dev, ts->max_touch_num,
597ca96ea86SBastien Nocera 			    INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
598ca96ea86SBastien Nocera 
599ca96ea86SBastien Nocera 	ts->input_dev->name = "Goodix Capacitive TouchScreen";
600ca96ea86SBastien Nocera 	ts->input_dev->phys = "input/ts";
601ca96ea86SBastien Nocera 	ts->input_dev->id.bustype = BUS_I2C;
602ca96ea86SBastien Nocera 	ts->input_dev->id.vendor = 0x0416;
60368caf858SIrina Tirdea 	ts->input_dev->id.product = ts->id;
60468caf858SIrina Tirdea 	ts->input_dev->id.version = ts->version;
605ca96ea86SBastien Nocera 
606ca96ea86SBastien Nocera 	error = input_register_device(ts->input_dev);
607ca96ea86SBastien Nocera 	if (error) {
608ca96ea86SBastien Nocera 		dev_err(&ts->client->dev,
609ca96ea86SBastien Nocera 			"Failed to register input device: %d", error);
610ca96ea86SBastien Nocera 		return error;
611ca96ea86SBastien Nocera 	}
612ca96ea86SBastien Nocera 
613ca96ea86SBastien Nocera 	return 0;
614ca96ea86SBastien Nocera }
615ca96ea86SBastien Nocera 
61668caf858SIrina Tirdea /**
61768caf858SIrina Tirdea  * goodix_configure_dev - Finish device initialization
61868caf858SIrina Tirdea  *
61968caf858SIrina Tirdea  * @ts: our goodix_ts_data pointer
62068caf858SIrina Tirdea  *
62168caf858SIrina Tirdea  * Must be called from probe to finish initialization of the device.
62268caf858SIrina Tirdea  * Contains the common initialization code for both devices that
62368caf858SIrina Tirdea  * declare gpio pins and devices that do not. It is either called
62468caf858SIrina Tirdea  * directly from probe or from request_firmware_wait callback.
62568caf858SIrina Tirdea  */
62668caf858SIrina Tirdea static int goodix_configure_dev(struct goodix_ts_data *ts)
62768caf858SIrina Tirdea {
62868caf858SIrina Tirdea 	int error;
62968caf858SIrina Tirdea 
63068caf858SIrina Tirdea 	goodix_read_config(ts);
63168caf858SIrina Tirdea 
63268caf858SIrina Tirdea 	error = goodix_request_input_dev(ts);
63368caf858SIrina Tirdea 	if (error)
63468caf858SIrina Tirdea 		return error;
63568caf858SIrina Tirdea 
6365ab09d6aSIrina Tirdea 	ts->irq_flags = goodix_irq_flags[ts->int_trigger_type] | IRQF_ONESHOT;
6375ab09d6aSIrina Tirdea 	error = goodix_request_irq(ts);
63868caf858SIrina Tirdea 	if (error) {
63968caf858SIrina Tirdea 		dev_err(&ts->client->dev, "request IRQ failed: %d\n", error);
64068caf858SIrina Tirdea 		return error;
64168caf858SIrina Tirdea 	}
64268caf858SIrina Tirdea 
64368caf858SIrina Tirdea 	return 0;
64468caf858SIrina Tirdea }
64568caf858SIrina Tirdea 
64668caf858SIrina Tirdea /**
64768caf858SIrina Tirdea  * goodix_config_cb - Callback to finish device init
64868caf858SIrina Tirdea  *
64968caf858SIrina Tirdea  * @ts: our goodix_ts_data pointer
65068caf858SIrina Tirdea  *
65168caf858SIrina Tirdea  * request_firmware_wait callback that finishes
65268caf858SIrina Tirdea  * initialization of the device.
65368caf858SIrina Tirdea  */
65468caf858SIrina Tirdea static void goodix_config_cb(const struct firmware *cfg, void *ctx)
65568caf858SIrina Tirdea {
65668caf858SIrina Tirdea 	struct goodix_ts_data *ts = ctx;
65768caf858SIrina Tirdea 	int error;
65868caf858SIrina Tirdea 
65968caf858SIrina Tirdea 	if (cfg) {
66068caf858SIrina Tirdea 		/* send device configuration to the firmware */
66168caf858SIrina Tirdea 		error = goodix_send_cfg(ts, cfg);
66268caf858SIrina Tirdea 		if (error)
66368caf858SIrina Tirdea 			goto err_release_cfg;
66468caf858SIrina Tirdea 	}
66568caf858SIrina Tirdea 
66668caf858SIrina Tirdea 	goodix_configure_dev(ts);
66768caf858SIrina Tirdea 
66868caf858SIrina Tirdea err_release_cfg:
66968caf858SIrina Tirdea 	release_firmware(cfg);
67068caf858SIrina Tirdea 	complete_all(&ts->firmware_loading_complete);
67168caf858SIrina Tirdea }
67268caf858SIrina Tirdea 
673ca96ea86SBastien Nocera static int goodix_ts_probe(struct i2c_client *client,
674ca96ea86SBastien Nocera 			   const struct i2c_device_id *id)
675ca96ea86SBastien Nocera {
676ca96ea86SBastien Nocera 	struct goodix_ts_data *ts;
677ca96ea86SBastien Nocera 	int error;
678ca96ea86SBastien Nocera 
679ca96ea86SBastien Nocera 	dev_dbg(&client->dev, "I2C Address: 0x%02x\n", client->addr);
680ca96ea86SBastien Nocera 
681ca96ea86SBastien Nocera 	if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
682ca96ea86SBastien Nocera 		dev_err(&client->dev, "I2C check functionality failed.\n");
683ca96ea86SBastien Nocera 		return -ENXIO;
684ca96ea86SBastien Nocera 	}
685ca96ea86SBastien Nocera 
686ca96ea86SBastien Nocera 	ts = devm_kzalloc(&client->dev, sizeof(*ts), GFP_KERNEL);
687ca96ea86SBastien Nocera 	if (!ts)
688ca96ea86SBastien Nocera 		return -ENOMEM;
689ca96ea86SBastien Nocera 
690ca96ea86SBastien Nocera 	ts->client = client;
691ca96ea86SBastien Nocera 	i2c_set_clientdata(client, ts);
69268caf858SIrina Tirdea 	init_completion(&ts->firmware_loading_complete);
693ca96ea86SBastien Nocera 
694ec6e1b40SIrina Tirdea 	error = goodix_get_gpio_config(ts);
695ec6e1b40SIrina Tirdea 	if (error)
696ec6e1b40SIrina Tirdea 		return error;
697ec6e1b40SIrina Tirdea 
698ec6e1b40SIrina Tirdea 	if (ts->gpiod_int && ts->gpiod_rst) {
699ec6e1b40SIrina Tirdea 		/* reset the controller */
700ec6e1b40SIrina Tirdea 		error = goodix_reset(ts);
701ec6e1b40SIrina Tirdea 		if (error) {
702ec6e1b40SIrina Tirdea 			dev_err(&client->dev, "Controller reset failed.\n");
703ec6e1b40SIrina Tirdea 			return error;
704ec6e1b40SIrina Tirdea 		}
705ec6e1b40SIrina Tirdea 	}
706ec6e1b40SIrina Tirdea 
707ca96ea86SBastien Nocera 	error = goodix_i2c_test(client);
708ca96ea86SBastien Nocera 	if (error) {
709ca96ea86SBastien Nocera 		dev_err(&client->dev, "I2C communication failure: %d\n", error);
710ca96ea86SBastien Nocera 		return error;
711ca96ea86SBastien Nocera 	}
712ca96ea86SBastien Nocera 
71368caf858SIrina Tirdea 	error = goodix_read_version(ts);
714ca96ea86SBastien Nocera 	if (error) {
715ca96ea86SBastien Nocera 		dev_err(&client->dev, "Read version failed.\n");
716ca96ea86SBastien Nocera 		return error;
717ca96ea86SBastien Nocera 	}
718ca96ea86SBastien Nocera 
71968caf858SIrina Tirdea 	ts->cfg_len = goodix_get_cfg_len(ts->id);
720a779fbc6SIrina Tirdea 
72168caf858SIrina Tirdea 	if (ts->gpiod_int && ts->gpiod_rst) {
72268caf858SIrina Tirdea 		/* update device config */
72368caf858SIrina Tirdea 		ts->cfg_name = devm_kasprintf(&client->dev, GFP_KERNEL,
72468caf858SIrina Tirdea 					      "goodix_%d_cfg.bin", ts->id);
72568caf858SIrina Tirdea 		if (!ts->cfg_name)
72668caf858SIrina Tirdea 			return -ENOMEM;
727ca96ea86SBastien Nocera 
72868caf858SIrina Tirdea 		error = request_firmware_nowait(THIS_MODULE, true, ts->cfg_name,
72968caf858SIrina Tirdea 						&client->dev, GFP_KERNEL, ts,
73068caf858SIrina Tirdea 						goodix_config_cb);
731ca96ea86SBastien Nocera 		if (error) {
73268caf858SIrina Tirdea 			dev_err(&client->dev,
73368caf858SIrina Tirdea 				"Failed to invoke firmware loader: %d\n",
73468caf858SIrina Tirdea 				error);
735ca96ea86SBastien Nocera 			return error;
736ca96ea86SBastien Nocera 		}
737ca96ea86SBastien Nocera 
738ca96ea86SBastien Nocera 		return 0;
73968caf858SIrina Tirdea 	} else {
74068caf858SIrina Tirdea 		error = goodix_configure_dev(ts);
74168caf858SIrina Tirdea 		if (error)
74268caf858SIrina Tirdea 			return error;
74368caf858SIrina Tirdea 	}
74468caf858SIrina Tirdea 
74568caf858SIrina Tirdea 	return 0;
74668caf858SIrina Tirdea }
74768caf858SIrina Tirdea 
74868caf858SIrina Tirdea static int goodix_ts_remove(struct i2c_client *client)
74968caf858SIrina Tirdea {
75068caf858SIrina Tirdea 	struct goodix_ts_data *ts = i2c_get_clientdata(client);
75168caf858SIrina Tirdea 
75268caf858SIrina Tirdea 	if (ts->gpiod_int && ts->gpiod_rst)
75368caf858SIrina Tirdea 		wait_for_completion(&ts->firmware_loading_complete);
75468caf858SIrina Tirdea 
75568caf858SIrina Tirdea 	return 0;
756ca96ea86SBastien Nocera }
757ca96ea86SBastien Nocera 
7585ab09d6aSIrina Tirdea static int __maybe_unused goodix_suspend(struct device *dev)
7595ab09d6aSIrina Tirdea {
7605ab09d6aSIrina Tirdea 	struct i2c_client *client = to_i2c_client(dev);
7615ab09d6aSIrina Tirdea 	struct goodix_ts_data *ts = i2c_get_clientdata(client);
7625ab09d6aSIrina Tirdea 	int error;
7635ab09d6aSIrina Tirdea 
7645ab09d6aSIrina Tirdea 	/* We need gpio pins to suspend/resume */
7655ab09d6aSIrina Tirdea 	if (!ts->gpiod_int || !ts->gpiod_rst)
7665ab09d6aSIrina Tirdea 		return 0;
7675ab09d6aSIrina Tirdea 
7685ab09d6aSIrina Tirdea 	wait_for_completion(&ts->firmware_loading_complete);
7695ab09d6aSIrina Tirdea 
7705ab09d6aSIrina Tirdea 	/* Free IRQ as IRQ pin is used as output in the suspend sequence */
7715ab09d6aSIrina Tirdea 	goodix_free_irq(ts);
7725ab09d6aSIrina Tirdea 
7735ab09d6aSIrina Tirdea 	/* Output LOW on the INT pin for 5 ms */
7745ab09d6aSIrina Tirdea 	error = gpiod_direction_output(ts->gpiod_int, 0);
7755ab09d6aSIrina Tirdea 	if (error) {
7765ab09d6aSIrina Tirdea 		goodix_request_irq(ts);
7775ab09d6aSIrina Tirdea 		return error;
7785ab09d6aSIrina Tirdea 	}
7795ab09d6aSIrina Tirdea 
7805ab09d6aSIrina Tirdea 	usleep_range(5000, 6000);
7815ab09d6aSIrina Tirdea 
7825ab09d6aSIrina Tirdea 	error = goodix_i2c_write_u8(ts->client, GOODIX_REG_COMMAND,
7835ab09d6aSIrina Tirdea 				    GOODIX_CMD_SCREEN_OFF);
7845ab09d6aSIrina Tirdea 	if (error) {
7855ab09d6aSIrina Tirdea 		dev_err(&ts->client->dev, "Screen off command failed\n");
7865ab09d6aSIrina Tirdea 		gpiod_direction_input(ts->gpiod_int);
7875ab09d6aSIrina Tirdea 		goodix_request_irq(ts);
7885ab09d6aSIrina Tirdea 		return -EAGAIN;
7895ab09d6aSIrina Tirdea 	}
7905ab09d6aSIrina Tirdea 
7915ab09d6aSIrina Tirdea 	/*
7925ab09d6aSIrina Tirdea 	 * The datasheet specifies that the interval between sending screen-off
7935ab09d6aSIrina Tirdea 	 * command and wake-up should be longer than 58 ms. To avoid waking up
7945ab09d6aSIrina Tirdea 	 * sooner, delay 58ms here.
7955ab09d6aSIrina Tirdea 	 */
7965ab09d6aSIrina Tirdea 	msleep(58);
7975ab09d6aSIrina Tirdea 	return 0;
7985ab09d6aSIrina Tirdea }
7995ab09d6aSIrina Tirdea 
8005ab09d6aSIrina Tirdea static int __maybe_unused goodix_resume(struct device *dev)
8015ab09d6aSIrina Tirdea {
8025ab09d6aSIrina Tirdea 	struct i2c_client *client = to_i2c_client(dev);
8035ab09d6aSIrina Tirdea 	struct goodix_ts_data *ts = i2c_get_clientdata(client);
8045ab09d6aSIrina Tirdea 	int error;
8055ab09d6aSIrina Tirdea 
8065ab09d6aSIrina Tirdea 	if (!ts->gpiod_int || !ts->gpiod_rst)
8075ab09d6aSIrina Tirdea 		return 0;
8085ab09d6aSIrina Tirdea 
8095ab09d6aSIrina Tirdea 	/*
8105ab09d6aSIrina Tirdea 	 * Exit sleep mode by outputting HIGH level to INT pin
8115ab09d6aSIrina Tirdea 	 * for 2ms~5ms.
8125ab09d6aSIrina Tirdea 	 */
8135ab09d6aSIrina Tirdea 	error = gpiod_direction_output(ts->gpiod_int, 1);
8145ab09d6aSIrina Tirdea 	if (error)
8155ab09d6aSIrina Tirdea 		return error;
8165ab09d6aSIrina Tirdea 
8175ab09d6aSIrina Tirdea 	usleep_range(2000, 5000);
8185ab09d6aSIrina Tirdea 
8195ab09d6aSIrina Tirdea 	error = goodix_int_sync(ts);
8205ab09d6aSIrina Tirdea 	if (error)
8215ab09d6aSIrina Tirdea 		return error;
8225ab09d6aSIrina Tirdea 
8235ab09d6aSIrina Tirdea 	error = goodix_request_irq(ts);
8245ab09d6aSIrina Tirdea 	if (error)
8255ab09d6aSIrina Tirdea 		return error;
8265ab09d6aSIrina Tirdea 
8275ab09d6aSIrina Tirdea 	return 0;
8285ab09d6aSIrina Tirdea }
8295ab09d6aSIrina Tirdea 
8305ab09d6aSIrina Tirdea static SIMPLE_DEV_PM_OPS(goodix_pm_ops, goodix_suspend, goodix_resume);
8315ab09d6aSIrina Tirdea 
832ca96ea86SBastien Nocera static const struct i2c_device_id goodix_ts_id[] = {
833ca96ea86SBastien Nocera 	{ "GDIX1001:00", 0 },
834ca96ea86SBastien Nocera 	{ }
835ca96ea86SBastien Nocera };
8362e9e910eSJavier Martinez Canillas MODULE_DEVICE_TABLE(i2c, goodix_ts_id);
837ca96ea86SBastien Nocera 
838771d8f1bSAleksei Mamlin #ifdef CONFIG_ACPI
839ca96ea86SBastien Nocera static const struct acpi_device_id goodix_acpi_match[] = {
840ca96ea86SBastien Nocera 	{ "GDIX1001", 0 },
841ca96ea86SBastien Nocera 	{ }
842ca96ea86SBastien Nocera };
843ca96ea86SBastien Nocera MODULE_DEVICE_TABLE(acpi, goodix_acpi_match);
844771d8f1bSAleksei Mamlin #endif
845771d8f1bSAleksei Mamlin 
846771d8f1bSAleksei Mamlin #ifdef CONFIG_OF
847771d8f1bSAleksei Mamlin static const struct of_device_id goodix_of_match[] = {
848771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt911" },
849771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt9110" },
850771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt912" },
851771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt927" },
852771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt9271" },
853771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt928" },
854771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt967" },
855771d8f1bSAleksei Mamlin 	{ }
856771d8f1bSAleksei Mamlin };
857771d8f1bSAleksei Mamlin MODULE_DEVICE_TABLE(of, goodix_of_match);
858771d8f1bSAleksei Mamlin #endif
859ca96ea86SBastien Nocera 
860ca96ea86SBastien Nocera static struct i2c_driver goodix_ts_driver = {
861ca96ea86SBastien Nocera 	.probe = goodix_ts_probe,
86268caf858SIrina Tirdea 	.remove = goodix_ts_remove,
863ca96ea86SBastien Nocera 	.id_table = goodix_ts_id,
864ca96ea86SBastien Nocera 	.driver = {
865ca96ea86SBastien Nocera 		.name = "Goodix-TS",
866771d8f1bSAleksei Mamlin 		.acpi_match_table = ACPI_PTR(goodix_acpi_match),
867771d8f1bSAleksei Mamlin 		.of_match_table = of_match_ptr(goodix_of_match),
8685ab09d6aSIrina Tirdea 		.pm = &goodix_pm_ops,
869ca96ea86SBastien Nocera 	},
870ca96ea86SBastien Nocera };
871ca96ea86SBastien Nocera module_i2c_driver(goodix_ts_driver);
872ca96ea86SBastien Nocera 
873ca96ea86SBastien Nocera MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
874ca96ea86SBastien Nocera MODULE_AUTHOR("Bastien Nocera <hadess@hadess.net>");
875ca96ea86SBastien Nocera MODULE_DESCRIPTION("Goodix touchscreen driver");
876ca96ea86SBastien Nocera MODULE_LICENSE("GPL v2");
877