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