1b886d83cSThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
2ca96ea86SBastien Nocera /*
3ca96ea86SBastien Nocera  *  Driver for Goodix Touchscreens
4ca96ea86SBastien Nocera  *
5ca96ea86SBastien Nocera  *  Copyright (c) 2014 Red Hat Inc.
6ad48cf5eSKarsten Merker  *  Copyright (c) 2015 K. Merker <merker@debian.org>
7ca96ea86SBastien Nocera  *
8ca96ea86SBastien Nocera  *  This code is based on gt9xx.c authored by andrew@goodix.com:
9ca96ea86SBastien Nocera  *
10ca96ea86SBastien Nocera  *  2010 - 2012 Goodix Technology.
11ca96ea86SBastien Nocera  */
12ca96ea86SBastien Nocera 
13ca96ea86SBastien Nocera 
14ca96ea86SBastien Nocera #include <linux/kernel.h>
158b5a359cSBastien Nocera #include <linux/dmi.h>
1668caf858SIrina Tirdea #include <linux/firmware.h>
17ca96ea86SBastien Nocera #include <linux/module.h>
18ca96ea86SBastien Nocera #include <linux/delay.h>
19ca96ea86SBastien Nocera #include <linux/irq.h>
20ca96ea86SBastien Nocera #include <linux/interrupt.h>
21d176708fSHans de Goede #include <linux/platform_data/x86/soc.h>
22ca96ea86SBastien Nocera #include <linux/slab.h>
23771d8f1bSAleksei Mamlin #include <linux/acpi.h>
24771d8f1bSAleksei Mamlin #include <linux/of.h>
25ca96ea86SBastien Nocera #include <asm/unaligned.h>
26a2233cb7SHans de Goede #include "goodix.h"
27ca96ea86SBastien Nocera 
28aebfc52cSHans de Goede #define GOODIX_GPIO_INT_NAME		"irq"
29aebfc52cSHans de Goede #define GOODIX_GPIO_RST_NAME		"reset"
30aebfc52cSHans de Goede 
31aebfc52cSHans de Goede #define GOODIX_MAX_HEIGHT		4096
32aebfc52cSHans de Goede #define GOODIX_MAX_WIDTH		4096
33aebfc52cSHans de Goede #define GOODIX_INT_TRIGGER		1
34aebfc52cSHans de Goede #define GOODIX_CONTACT_SIZE		8
35aebfc52cSHans de Goede #define GOODIX_MAX_CONTACT_SIZE		9
36aebfc52cSHans de Goede #define GOODIX_MAX_CONTACTS		10
37aebfc52cSHans de Goede 
38686e8a24SHans de Goede #define GOODIX_CONFIG_MIN_LENGTH	186
39aebfc52cSHans de Goede #define GOODIX_CONFIG_911_LENGTH	186
40aebfc52cSHans de Goede #define GOODIX_CONFIG_967_LENGTH	228
41686e8a24SHans de Goede #define GOODIX_CONFIG_GT9X_LENGTH	240
42aebfc52cSHans de Goede 
43aebfc52cSHans de Goede #define GOODIX_BUFFER_STATUS_READY	BIT(7)
44492ee52cSDmitry Mastykin #define GOODIX_HAVE_KEY			BIT(4)
45aebfc52cSHans de Goede #define GOODIX_BUFFER_STATUS_TIMEOUT	20
46aebfc52cSHans de Goede 
47aebfc52cSHans de Goede #define RESOLUTION_LOC		1
48aebfc52cSHans de Goede #define MAX_CONTACTS_LOC	5
49aebfc52cSHans de Goede #define TRIGGER_LOC		6
50aebfc52cSHans de Goede 
51c9c20ee3SHans de Goede /* Our special handling for GPIO accesses through ACPI is x86 specific */
52c9c20ee3SHans de Goede #if defined CONFIG_X86 && defined CONFIG_ACPI
53c9c20ee3SHans de Goede #define ACPI_GPIO_SUPPORT
54c9c20ee3SHans de Goede #endif
55c9c20ee3SHans de Goede 
56cae102e2SIcenowy Zheng struct goodix_chip_id {
57cae102e2SIcenowy Zheng 	const char *id;
58cae102e2SIcenowy Zheng 	const struct goodix_chip_data *data;
59cae102e2SIcenowy Zheng };
60cae102e2SIcenowy Zheng 
6125309004SMarcin Niestroj static int goodix_check_cfg_8(struct goodix_ts_data *ts,
621a67448fSHans de Goede 			      const u8 *cfg, int len);
6325309004SMarcin Niestroj static int goodix_check_cfg_16(struct goodix_ts_data *ts,
641a67448fSHans de Goede 			       const u8 *cfg, int len);
65de956caeSHans de Goede static void goodix_calc_cfg_checksum_8(struct goodix_ts_data *ts);
66de956caeSHans de Goede static void goodix_calc_cfg_checksum_16(struct goodix_ts_data *ts);
6725309004SMarcin Niestroj 
6825309004SMarcin Niestroj static const struct goodix_chip_data gt1x_chip_data = {
6925309004SMarcin Niestroj 	.config_addr		= GOODIX_GT1X_REG_CONFIG_DATA,
70686e8a24SHans de Goede 	.config_len		= GOODIX_CONFIG_GT9X_LENGTH,
7125309004SMarcin Niestroj 	.check_config		= goodix_check_cfg_16,
72de956caeSHans de Goede 	.calc_config_checksum	= goodix_calc_cfg_checksum_16,
7325309004SMarcin Niestroj };
7425309004SMarcin Niestroj 
7525309004SMarcin Niestroj static const struct goodix_chip_data gt911_chip_data = {
7625309004SMarcin Niestroj 	.config_addr		= GOODIX_GT9X_REG_CONFIG_DATA,
7725309004SMarcin Niestroj 	.config_len		= GOODIX_CONFIG_911_LENGTH,
7825309004SMarcin Niestroj 	.check_config		= goodix_check_cfg_8,
79de956caeSHans de Goede 	.calc_config_checksum	= goodix_calc_cfg_checksum_8,
8025309004SMarcin Niestroj };
8125309004SMarcin Niestroj 
8225309004SMarcin Niestroj static const struct goodix_chip_data gt967_chip_data = {
8325309004SMarcin Niestroj 	.config_addr		= GOODIX_GT9X_REG_CONFIG_DATA,
8425309004SMarcin Niestroj 	.config_len		= GOODIX_CONFIG_967_LENGTH,
8525309004SMarcin Niestroj 	.check_config		= goodix_check_cfg_8,
86de956caeSHans de Goede 	.calc_config_checksum	= goodix_calc_cfg_checksum_8,
8725309004SMarcin Niestroj };
8825309004SMarcin Niestroj 
8925309004SMarcin Niestroj static const struct goodix_chip_data gt9x_chip_data = {
9025309004SMarcin Niestroj 	.config_addr		= GOODIX_GT9X_REG_CONFIG_DATA,
91686e8a24SHans de Goede 	.config_len		= GOODIX_CONFIG_GT9X_LENGTH,
9225309004SMarcin Niestroj 	.check_config		= goodix_check_cfg_8,
93de956caeSHans de Goede 	.calc_config_checksum	= goodix_calc_cfg_checksum_8,
9425309004SMarcin Niestroj };
9525309004SMarcin Niestroj 
96cae102e2SIcenowy Zheng static const struct goodix_chip_id goodix_chip_ids[] = {
97cae102e2SIcenowy Zheng 	{ .id = "1151", .data = &gt1x_chip_data },
98cae102e2SIcenowy Zheng 	{ .id = "5663", .data = &gt1x_chip_data },
99cae102e2SIcenowy Zheng 	{ .id = "5688", .data = &gt1x_chip_data },
100b5e458afSIcenowy Zheng 	{ .id = "917S", .data = &gt1x_chip_data },
1012dce6db7SAngeloGioacchino Del Regno 	{ .id = "9286", .data = &gt1x_chip_data },
102cae102e2SIcenowy Zheng 
103cae102e2SIcenowy Zheng 	{ .id = "911", .data = &gt911_chip_data },
104cae102e2SIcenowy Zheng 	{ .id = "9271", .data = &gt911_chip_data },
105cae102e2SIcenowy Zheng 	{ .id = "9110", .data = &gt911_chip_data },
10681e81886SHans de Goede 	{ .id = "9111", .data = &gt911_chip_data },
107cae102e2SIcenowy Zheng 	{ .id = "927", .data = &gt911_chip_data },
108cae102e2SIcenowy Zheng 	{ .id = "928", .data = &gt911_chip_data },
109cae102e2SIcenowy Zheng 
110cae102e2SIcenowy Zheng 	{ .id = "912", .data = &gt967_chip_data },
111b9a1c116SYannick Fertre 	{ .id = "9147", .data = &gt967_chip_data },
112cae102e2SIcenowy Zheng 	{ .id = "967", .data = &gt967_chip_data },
113cae102e2SIcenowy Zheng 	{ }
114cae102e2SIcenowy Zheng };
115cae102e2SIcenowy Zheng 
116ca96ea86SBastien Nocera static const unsigned long goodix_irq_flags[] = {
117ca96ea86SBastien Nocera 	IRQ_TYPE_EDGE_RISING,
118ca96ea86SBastien Nocera 	IRQ_TYPE_EDGE_FALLING,
119ca96ea86SBastien Nocera 	IRQ_TYPE_LEVEL_LOW,
120ca96ea86SBastien Nocera 	IRQ_TYPE_LEVEL_HIGH,
121ca96ea86SBastien Nocera };
122ca96ea86SBastien Nocera 
123bd3b8480SYauhen Kharuzhy static const struct dmi_system_id nine_bytes_report[] = {
124bd3b8480SYauhen Kharuzhy #if defined(CONFIG_DMI) && defined(CONFIG_X86)
125bd3b8480SYauhen Kharuzhy 	{
126bd3b8480SYauhen Kharuzhy 		.ident = "Lenovo YogaBook",
127bd3b8480SYauhen Kharuzhy 		/* YB1-X91L/F and YB1-X90L/F */
128bd3b8480SYauhen Kharuzhy 		.matches = {
129bd3b8480SYauhen Kharuzhy 			DMI_MATCH(DMI_PRODUCT_NAME, "Lenovo YB1-X9")
130bd3b8480SYauhen Kharuzhy 		}
131bd3b8480SYauhen Kharuzhy 	},
132bd3b8480SYauhen Kharuzhy #endif
133bd3b8480SYauhen Kharuzhy 	{}
134bd3b8480SYauhen Kharuzhy };
135bd3b8480SYauhen Kharuzhy 
1361dd5ddc1SSergei A. Trusov /*
1371dd5ddc1SSergei A. Trusov  * Those tablets have their x coordinate inverted
1381dd5ddc1SSergei A. Trusov  */
1391dd5ddc1SSergei A. Trusov static const struct dmi_system_id inverted_x_screen[] = {
1401dd5ddc1SSergei A. Trusov #if defined(CONFIG_DMI) && defined(CONFIG_X86)
1411dd5ddc1SSergei A. Trusov 	{
1421dd5ddc1SSergei A. Trusov 		.ident = "Cube I15-TC",
1431dd5ddc1SSergei A. Trusov 		.matches = {
1441dd5ddc1SSergei A. Trusov 			DMI_MATCH(DMI_SYS_VENDOR, "Cube"),
1451dd5ddc1SSergei A. Trusov 			DMI_MATCH(DMI_PRODUCT_NAME, "I15-TC")
1461dd5ddc1SSergei A. Trusov 		},
1471dd5ddc1SSergei A. Trusov 	},
1481dd5ddc1SSergei A. Trusov #endif
1491dd5ddc1SSergei A. Trusov 	{}
1501dd5ddc1SSergei A. Trusov };
1511dd5ddc1SSergei A. Trusov 
152ca96ea86SBastien Nocera /**
153ca96ea86SBastien Nocera  * goodix_i2c_read - read data from a register of the i2c slave device.
154ca96ea86SBastien Nocera  *
155ca96ea86SBastien Nocera  * @client: i2c device.
156ca96ea86SBastien Nocera  * @reg: the register to read from.
157ca96ea86SBastien Nocera  * @buf: raw write data buffer.
158ca96ea86SBastien Nocera  * @len: length of the buffer to write
159ca96ea86SBastien Nocera  */
160a2233cb7SHans de Goede int goodix_i2c_read(struct i2c_client *client, u16 reg, u8 *buf, int len)
161ca96ea86SBastien Nocera {
162ca96ea86SBastien Nocera 	struct i2c_msg msgs[2];
163fafef982SMarcin Niestroj 	__be16 wbuf = cpu_to_be16(reg);
164ca96ea86SBastien Nocera 	int ret;
165ca96ea86SBastien Nocera 
166ca96ea86SBastien Nocera 	msgs[0].flags = 0;
167ca96ea86SBastien Nocera 	msgs[0].addr  = client->addr;
168ca96ea86SBastien Nocera 	msgs[0].len   = 2;
169ca96ea86SBastien Nocera 	msgs[0].buf   = (u8 *)&wbuf;
170ca96ea86SBastien Nocera 
171ca96ea86SBastien Nocera 	msgs[1].flags = I2C_M_RD;
172ca96ea86SBastien Nocera 	msgs[1].addr  = client->addr;
173ca96ea86SBastien Nocera 	msgs[1].len   = len;
174ca96ea86SBastien Nocera 	msgs[1].buf   = buf;
175ca96ea86SBastien Nocera 
176ca96ea86SBastien Nocera 	ret = i2c_transfer(client->adapter, msgs, 2);
1777642f29cSHans de Goede 	if (ret >= 0)
1787642f29cSHans de Goede 		ret = (ret == ARRAY_SIZE(msgs) ? 0 : -EIO);
1797642f29cSHans de Goede 
1807642f29cSHans de Goede 	if (ret)
1817642f29cSHans de Goede 		dev_err(&client->dev, "Error reading %d bytes from 0x%04x: %d\n",
1827642f29cSHans de Goede 			len, reg, ret);
1837642f29cSHans de Goede 	return ret;
184ca96ea86SBastien Nocera }
185ca96ea86SBastien Nocera 
18668caf858SIrina Tirdea /**
18768caf858SIrina Tirdea  * goodix_i2c_write - write data to a register of the i2c slave device.
18868caf858SIrina Tirdea  *
18968caf858SIrina Tirdea  * @client: i2c device.
19068caf858SIrina Tirdea  * @reg: the register to write to.
19168caf858SIrina Tirdea  * @buf: raw data buffer to write.
19268caf858SIrina Tirdea  * @len: length of the buffer to write
19368caf858SIrina Tirdea  */
194a2233cb7SHans de Goede int goodix_i2c_write(struct i2c_client *client, u16 reg, const u8 *buf, int len)
19568caf858SIrina Tirdea {
19668caf858SIrina Tirdea 	u8 *addr_buf;
19768caf858SIrina Tirdea 	struct i2c_msg msg;
19868caf858SIrina Tirdea 	int ret;
19968caf858SIrina Tirdea 
20068caf858SIrina Tirdea 	addr_buf = kmalloc(len + 2, GFP_KERNEL);
20168caf858SIrina Tirdea 	if (!addr_buf)
20268caf858SIrina Tirdea 		return -ENOMEM;
20368caf858SIrina Tirdea 
20468caf858SIrina Tirdea 	addr_buf[0] = reg >> 8;
20568caf858SIrina Tirdea 	addr_buf[1] = reg & 0xFF;
20668caf858SIrina Tirdea 	memcpy(&addr_buf[2], buf, len);
20768caf858SIrina Tirdea 
20868caf858SIrina Tirdea 	msg.flags = 0;
20968caf858SIrina Tirdea 	msg.addr = client->addr;
21068caf858SIrina Tirdea 	msg.buf = addr_buf;
21168caf858SIrina Tirdea 	msg.len = len + 2;
21268caf858SIrina Tirdea 
21368caf858SIrina Tirdea 	ret = i2c_transfer(client->adapter, &msg, 1);
2147642f29cSHans de Goede 	if (ret >= 0)
2157642f29cSHans de Goede 		ret = (ret == 1 ? 0 : -EIO);
2167642f29cSHans de Goede 
21768caf858SIrina Tirdea 	kfree(addr_buf);
2187642f29cSHans de Goede 
2197642f29cSHans de Goede 	if (ret)
2207642f29cSHans de Goede 		dev_err(&client->dev, "Error writing %d bytes to 0x%04x: %d\n",
2217642f29cSHans de Goede 			len, reg, ret);
2227642f29cSHans de Goede 	return ret;
22368caf858SIrina Tirdea }
22468caf858SIrina Tirdea 
225a2233cb7SHans de Goede int goodix_i2c_write_u8(struct i2c_client *client, u16 reg, u8 value)
2265ab09d6aSIrina Tirdea {
2275ab09d6aSIrina Tirdea 	return goodix_i2c_write(client, reg, &value, sizeof(value));
2285ab09d6aSIrina Tirdea }
2295ab09d6aSIrina Tirdea 
230cae102e2SIcenowy Zheng static const struct goodix_chip_data *goodix_get_chip_data(const char *id)
231a779fbc6SIrina Tirdea {
232cae102e2SIcenowy Zheng 	unsigned int i;
23325309004SMarcin Niestroj 
234cae102e2SIcenowy Zheng 	for (i = 0; goodix_chip_ids[i].id; i++) {
235cae102e2SIcenowy Zheng 		if (!strcmp(goodix_chip_ids[i].id, id))
236cae102e2SIcenowy Zheng 			return goodix_chip_ids[i].data;
237a779fbc6SIrina Tirdea 	}
238cae102e2SIcenowy Zheng 
239cae102e2SIcenowy Zheng 	return &gt9x_chip_data;
240a779fbc6SIrina Tirdea }
241a779fbc6SIrina Tirdea 
242ca96ea86SBastien Nocera static int goodix_ts_read_input_report(struct goodix_ts_data *ts, u8 *data)
243ca96ea86SBastien Nocera {
2449b5db7aaSPaul Cercueil 	unsigned long max_timeout;
245ca96ea86SBastien Nocera 	int touch_num;
246ca96ea86SBastien Nocera 	int error;
247492ee52cSDmitry Mastykin 	u16 addr = GOODIX_READ_COOR_ADDR;
248492ee52cSDmitry Mastykin 	/*
249492ee52cSDmitry Mastykin 	 * We are going to read 1-byte header,
250492ee52cSDmitry Mastykin 	 * ts->contact_size * max(1, touch_num) bytes of coordinates
251492ee52cSDmitry Mastykin 	 * and 1-byte footer which contains the touch-key code.
252492ee52cSDmitry Mastykin 	 */
253492ee52cSDmitry Mastykin 	const int header_contact_keycode_size = 1 + ts->contact_size + 1;
254ca96ea86SBastien Nocera 
2559b5db7aaSPaul Cercueil 	/*
2569b5db7aaSPaul Cercueil 	 * The 'buffer status' bit, which indicates that the data is valid, is
2579b5db7aaSPaul Cercueil 	 * not set as soon as the interrupt is raised, but slightly after.
2589b5db7aaSPaul Cercueil 	 * This takes around 10 ms to happen, so we poll for 20 ms.
2599b5db7aaSPaul Cercueil 	 */
2609b5db7aaSPaul Cercueil 	max_timeout = jiffies + msecs_to_jiffies(GOODIX_BUFFER_STATUS_TIMEOUT);
2619b5db7aaSPaul Cercueil 	do {
262492ee52cSDmitry Mastykin 		error = goodix_i2c_read(ts->client, addr, data,
263492ee52cSDmitry Mastykin 					header_contact_keycode_size);
2647642f29cSHans de Goede 		if (error)
265ca96ea86SBastien Nocera 			return error;
266ca96ea86SBastien Nocera 
2679b5db7aaSPaul Cercueil 		if (data[0] & GOODIX_BUFFER_STATUS_READY) {
268ca96ea86SBastien Nocera 			touch_num = data[0] & 0x0f;
269a7ac7c95SAleksei Mamlin 			if (touch_num > ts->max_touch_num)
270ca96ea86SBastien Nocera 				return -EPROTO;
271ca96ea86SBastien Nocera 
272ca96ea86SBastien Nocera 			if (touch_num > 1) {
273492ee52cSDmitry Mastykin 				addr += header_contact_keycode_size;
274492ee52cSDmitry Mastykin 				data += header_contact_keycode_size;
275ca96ea86SBastien Nocera 				error = goodix_i2c_read(ts->client,
276492ee52cSDmitry Mastykin 						addr, data,
277bd3b8480SYauhen Kharuzhy 						ts->contact_size *
2789b5db7aaSPaul Cercueil 							(touch_num - 1));
279ca96ea86SBastien Nocera 				if (error)
280ca96ea86SBastien Nocera 					return error;
281ca96ea86SBastien Nocera 			}
282ca96ea86SBastien Nocera 
283ca96ea86SBastien Nocera 			return touch_num;
284ca96ea86SBastien Nocera 		}
285ca96ea86SBastien Nocera 
28609182ed2SHans de Goede 		if (data[0] == 0 && ts->firmware_name) {
28709182ed2SHans de Goede 			if (goodix_handle_fw_request(ts))
28809182ed2SHans de Goede 				return 0;
28909182ed2SHans de Goede 		}
29009182ed2SHans de Goede 
2919b5db7aaSPaul Cercueil 		usleep_range(1000, 2000); /* Poll every 1 - 2 ms */
2929b5db7aaSPaul Cercueil 	} while (time_before(jiffies, max_timeout));
2939b5db7aaSPaul Cercueil 
2949b5db7aaSPaul Cercueil 	/*
2959b5db7aaSPaul Cercueil 	 * The Goodix panel will send spurious interrupts after a
2969b5db7aaSPaul Cercueil 	 * 'finger up' event, which will always cause a timeout.
2979b5db7aaSPaul Cercueil 	 */
29824ef83f6SDmitry Mastykin 	return -ENOMSG;
2999b5db7aaSPaul Cercueil }
3009b5db7aaSPaul Cercueil 
30165de58c2SHans de Goede static int goodix_create_pen_input(struct goodix_ts_data *ts)
3025ede7f0cSHans de Goede {
3035ede7f0cSHans de Goede 	struct device *dev = &ts->client->dev;
3045ede7f0cSHans de Goede 	struct input_dev *input;
3055ede7f0cSHans de Goede 
3065ede7f0cSHans de Goede 	input = devm_input_allocate_device(dev);
3075ede7f0cSHans de Goede 	if (!input)
30865de58c2SHans de Goede 		return -ENOMEM;
3095ede7f0cSHans de Goede 
310ae8e80c5SHans de Goede 	input_copy_abs(input, ABS_X, ts->input_dev, ABS_MT_POSITION_X);
311ae8e80c5SHans de Goede 	input_copy_abs(input, ABS_Y, ts->input_dev, ABS_MT_POSITION_Y);
3125ede7f0cSHans de Goede 	/*
3135ede7f0cSHans de Goede 	 * The resolution of these touchscreens is about 10 units/mm, the actual
3145ede7f0cSHans de Goede 	 * resolution does not matter much since we set INPUT_PROP_DIRECT.
3155ede7f0cSHans de Goede 	 * Userspace wants something here though, so just set it to 10 units/mm.
3165ede7f0cSHans de Goede 	 */
3175ede7f0cSHans de Goede 	input_abs_set_res(input, ABS_X, 10);
3185ede7f0cSHans de Goede 	input_abs_set_res(input, ABS_Y, 10);
319ae8e80c5SHans de Goede 	input_set_abs_params(input, ABS_PRESSURE, 0, 255, 0, 0);
320ae8e80c5SHans de Goede 
321ae8e80c5SHans de Goede 	input_set_capability(input, EV_KEY, BTN_TOUCH);
322ae8e80c5SHans de Goede 	input_set_capability(input, EV_KEY, BTN_TOOL_PEN);
323ae8e80c5SHans de Goede 	input_set_capability(input, EV_KEY, BTN_STYLUS);
324ae8e80c5SHans de Goede 	input_set_capability(input, EV_KEY, BTN_STYLUS2);
325ae8e80c5SHans de Goede 	__set_bit(INPUT_PROP_DIRECT, input->propbit);
3265ede7f0cSHans de Goede 
3275ede7f0cSHans de Goede 	input->name = "Goodix Active Pen";
3285ede7f0cSHans de Goede 	input->phys = "input/pen";
3295ede7f0cSHans de Goede 	input->id.bustype = BUS_I2C;
33071f4ecd5SHans de Goede 	input->id.vendor = 0x0416;
3315ede7f0cSHans de Goede 	if (kstrtou16(ts->id, 10, &input->id.product))
3325ede7f0cSHans de Goede 		input->id.product = 0x1001;
3335ede7f0cSHans de Goede 	input->id.version = ts->version;
3345ede7f0cSHans de Goede 
33565de58c2SHans de Goede 	ts->input_pen = input;
33665de58c2SHans de Goede 	return 0;
3375ede7f0cSHans de Goede }
3385ede7f0cSHans de Goede 
3395ede7f0cSHans de Goede static void goodix_ts_report_pen_down(struct goodix_ts_data *ts, u8 *data)
3405ede7f0cSHans de Goede {
34165de58c2SHans de Goede 	int input_x, input_y, input_w, error;
3425ede7f0cSHans de Goede 	u8 key_value;
3435ede7f0cSHans de Goede 
34465de58c2SHans de Goede 	if (!ts->pen_input_registered) {
34565de58c2SHans de Goede 		error = input_register_device(ts->input_pen);
34665de58c2SHans de Goede 		ts->pen_input_registered = (error == 0) ? 1 : error;
3475ede7f0cSHans de Goede 	}
3485ede7f0cSHans de Goede 
34965de58c2SHans de Goede 	if (ts->pen_input_registered < 0)
35065de58c2SHans de Goede 		return;
35165de58c2SHans de Goede 
3525ede7f0cSHans de Goede 	if (ts->contact_size == 9) {
3535ede7f0cSHans de Goede 		input_x = get_unaligned_le16(&data[4]);
3545ede7f0cSHans de Goede 		input_y = get_unaligned_le16(&data[6]);
3555ede7f0cSHans de Goede 		input_w = get_unaligned_le16(&data[8]);
3565ede7f0cSHans de Goede 	} else {
3575ede7f0cSHans de Goede 		input_x = get_unaligned_le16(&data[2]);
3585ede7f0cSHans de Goede 		input_y = get_unaligned_le16(&data[4]);
3595ede7f0cSHans de Goede 		input_w = get_unaligned_le16(&data[6]);
3605ede7f0cSHans de Goede 	}
3615ede7f0cSHans de Goede 
3625ede7f0cSHans de Goede 	touchscreen_report_pos(ts->input_pen, &ts->prop, input_x, input_y, false);
3635ede7f0cSHans de Goede 	input_report_abs(ts->input_pen, ABS_PRESSURE, input_w);
3645ede7f0cSHans de Goede 
3655ede7f0cSHans de Goede 	input_report_key(ts->input_pen, BTN_TOUCH, 1);
3665ede7f0cSHans de Goede 	input_report_key(ts->input_pen, BTN_TOOL_PEN, 1);
3675ede7f0cSHans de Goede 
3685ede7f0cSHans de Goede 	if (data[0] & GOODIX_HAVE_KEY) {
3695ede7f0cSHans de Goede 		key_value = data[1 + ts->contact_size];
3705ede7f0cSHans de Goede 		input_report_key(ts->input_pen, BTN_STYLUS, key_value & 0x10);
3715ede7f0cSHans de Goede 		input_report_key(ts->input_pen, BTN_STYLUS2, key_value & 0x20);
3725ede7f0cSHans de Goede 	} else {
3735ede7f0cSHans de Goede 		input_report_key(ts->input_pen, BTN_STYLUS, 0);
3745ede7f0cSHans de Goede 		input_report_key(ts->input_pen, BTN_STYLUS2, 0);
3755ede7f0cSHans de Goede 	}
3765ede7f0cSHans de Goede 
3775ede7f0cSHans de Goede 	input_sync(ts->input_pen);
3785ede7f0cSHans de Goede }
3795ede7f0cSHans de Goede 
3805ede7f0cSHans de Goede static void goodix_ts_report_pen_up(struct goodix_ts_data *ts)
3815ede7f0cSHans de Goede {
3825ede7f0cSHans de Goede 	if (!ts->input_pen)
3835ede7f0cSHans de Goede 		return;
3845ede7f0cSHans de Goede 
3855ede7f0cSHans de Goede 	input_report_key(ts->input_pen, BTN_TOUCH, 0);
3865ede7f0cSHans de Goede 	input_report_key(ts->input_pen, BTN_TOOL_PEN, 0);
3875ede7f0cSHans de Goede 	input_report_key(ts->input_pen, BTN_STYLUS, 0);
3885ede7f0cSHans de Goede 	input_report_key(ts->input_pen, BTN_STYLUS2, 0);
3895ede7f0cSHans de Goede 
3905ede7f0cSHans de Goede 	input_sync(ts->input_pen);
3915ede7f0cSHans de Goede }
3925ede7f0cSHans de Goede 
393bd3b8480SYauhen Kharuzhy static void goodix_ts_report_touch_8b(struct goodix_ts_data *ts, u8 *coor_data)
394ca96ea86SBastien Nocera {
395ca96ea86SBastien Nocera 	int id = coor_data[0] & 0x0F;
396ca96ea86SBastien Nocera 	int input_x = get_unaligned_le16(&coor_data[1]);
397ca96ea86SBastien Nocera 	int input_y = get_unaligned_le16(&coor_data[3]);
398ca96ea86SBastien Nocera 	int input_w = get_unaligned_le16(&coor_data[5]);
399ca96ea86SBastien Nocera 
400ca96ea86SBastien Nocera 	input_mt_slot(ts->input_dev, id);
401ca96ea86SBastien Nocera 	input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true);
402fafef982SMarcin Niestroj 	touchscreen_report_pos(ts->input_dev, &ts->prop,
403fafef982SMarcin Niestroj 			       input_x, input_y, true);
404ca96ea86SBastien Nocera 	input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w);
405ca96ea86SBastien Nocera 	input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w);
406ca96ea86SBastien Nocera }
407ca96ea86SBastien Nocera 
408bd3b8480SYauhen Kharuzhy static void goodix_ts_report_touch_9b(struct goodix_ts_data *ts, u8 *coor_data)
409bd3b8480SYauhen Kharuzhy {
410bd3b8480SYauhen Kharuzhy 	int id = coor_data[1] & 0x0F;
411bd3b8480SYauhen Kharuzhy 	int input_x = get_unaligned_le16(&coor_data[3]);
412bd3b8480SYauhen Kharuzhy 	int input_y = get_unaligned_le16(&coor_data[5]);
413bd3b8480SYauhen Kharuzhy 	int input_w = get_unaligned_le16(&coor_data[7]);
414bd3b8480SYauhen Kharuzhy 
415bd3b8480SYauhen Kharuzhy 	input_mt_slot(ts->input_dev, id);
416bd3b8480SYauhen Kharuzhy 	input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true);
417bd3b8480SYauhen Kharuzhy 	touchscreen_report_pos(ts->input_dev, &ts->prop,
418bd3b8480SYauhen Kharuzhy 			       input_x, input_y, true);
419bd3b8480SYauhen Kharuzhy 	input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w);
420bd3b8480SYauhen Kharuzhy 	input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w);
421bd3b8480SYauhen Kharuzhy }
422bd3b8480SYauhen Kharuzhy 
4235ede7f0cSHans de Goede static void goodix_ts_release_keys(struct goodix_ts_data *ts)
4245ede7f0cSHans de Goede {
4255ede7f0cSHans de Goede 	int i;
4265ede7f0cSHans de Goede 
4275ede7f0cSHans de Goede 	for (i = 0; i < GOODIX_MAX_KEYS; i++)
4285ede7f0cSHans de Goede 		input_report_key(ts->input_dev, ts->keymap[i], 0);
4295ede7f0cSHans de Goede }
4305ede7f0cSHans de Goede 
431492ee52cSDmitry Mastykin static void goodix_ts_report_key(struct goodix_ts_data *ts, u8 *data)
432492ee52cSDmitry Mastykin {
433492ee52cSDmitry Mastykin 	int touch_num;
434492ee52cSDmitry Mastykin 	u8 key_value;
435492ee52cSDmitry Mastykin 	int i;
436492ee52cSDmitry Mastykin 
437492ee52cSDmitry Mastykin 	if (data[0] & GOODIX_HAVE_KEY) {
438492ee52cSDmitry Mastykin 		touch_num = data[0] & 0x0f;
439492ee52cSDmitry Mastykin 		key_value = data[1 + ts->contact_size * touch_num];
440492ee52cSDmitry Mastykin 		for (i = 0; i < GOODIX_MAX_KEYS; i++)
441492ee52cSDmitry Mastykin 			if (key_value & BIT(i))
442492ee52cSDmitry Mastykin 				input_report_key(ts->input_dev,
443492ee52cSDmitry Mastykin 						 ts->keymap[i], 1);
444492ee52cSDmitry Mastykin 	} else {
4455ede7f0cSHans de Goede 		goodix_ts_release_keys(ts);
446492ee52cSDmitry Mastykin 	}
447492ee52cSDmitry Mastykin }
448492ee52cSDmitry Mastykin 
449ca96ea86SBastien Nocera /**
450ca96ea86SBastien Nocera  * goodix_process_events - Process incoming events
451ca96ea86SBastien Nocera  *
452ca96ea86SBastien Nocera  * @ts: our goodix_ts_data pointer
453ca96ea86SBastien Nocera  *
454ca96ea86SBastien Nocera  * Called when the IRQ is triggered. Read the current device state, and push
455ca96ea86SBastien Nocera  * the input events to the user space.
456ca96ea86SBastien Nocera  */
457ca96ea86SBastien Nocera static void goodix_process_events(struct goodix_ts_data *ts)
458ca96ea86SBastien Nocera {
459492ee52cSDmitry Mastykin 	u8  point_data[2 + GOODIX_MAX_CONTACT_SIZE * GOODIX_MAX_CONTACTS];
460ca96ea86SBastien Nocera 	int touch_num;
461ca96ea86SBastien Nocera 	int i;
462ca96ea86SBastien Nocera 
463ca96ea86SBastien Nocera 	touch_num = goodix_ts_read_input_report(ts, point_data);
464ca96ea86SBastien Nocera 	if (touch_num < 0)
465ca96ea86SBastien Nocera 		return;
466ca96ea86SBastien Nocera 
4675ede7f0cSHans de Goede 	/* The pen being down is always reported as a single touch */
4685ede7f0cSHans de Goede 	if (touch_num == 1 && (point_data[1] & 0x80)) {
4695ede7f0cSHans de Goede 		goodix_ts_report_pen_down(ts, point_data);
4705ede7f0cSHans de Goede 		goodix_ts_release_keys(ts);
47171f4ecd5SHans de Goede 		goto sync; /* Release any previously registered touches */
4725ede7f0cSHans de Goede 	} else {
4735ede7f0cSHans de Goede 		goodix_ts_report_pen_up(ts);
4745ede7f0cSHans de Goede 	}
4755ede7f0cSHans de Goede 
476492ee52cSDmitry Mastykin 	goodix_ts_report_key(ts, point_data);
4774a54feeaSSergei A. Trusov 
478ca96ea86SBastien Nocera 	for (i = 0; i < touch_num; i++)
479bd3b8480SYauhen Kharuzhy 		if (ts->contact_size == 9)
480bd3b8480SYauhen Kharuzhy 			goodix_ts_report_touch_9b(ts,
481bd3b8480SYauhen Kharuzhy 				&point_data[1 + ts->contact_size * i]);
482bd3b8480SYauhen Kharuzhy 		else
483bd3b8480SYauhen Kharuzhy 			goodix_ts_report_touch_8b(ts,
484bd3b8480SYauhen Kharuzhy 				&point_data[1 + ts->contact_size * i]);
485ca96ea86SBastien Nocera 
4865ede7f0cSHans de Goede sync:
487ca96ea86SBastien Nocera 	input_mt_sync_frame(ts->input_dev);
488ca96ea86SBastien Nocera 	input_sync(ts->input_dev);
489ca96ea86SBastien Nocera }
490ca96ea86SBastien Nocera 
491ca96ea86SBastien Nocera /**
492ca96ea86SBastien Nocera  * goodix_ts_irq_handler - The IRQ handler
493ca96ea86SBastien Nocera  *
494ca96ea86SBastien Nocera  * @irq: interrupt number.
495ca96ea86SBastien Nocera  * @dev_id: private data pointer.
496ca96ea86SBastien Nocera  */
497ca96ea86SBastien Nocera static irqreturn_t goodix_ts_irq_handler(int irq, void *dev_id)
498ca96ea86SBastien Nocera {
499ca96ea86SBastien Nocera 	struct goodix_ts_data *ts = dev_id;
500ca96ea86SBastien Nocera 
501ca96ea86SBastien Nocera 	goodix_process_events(ts);
5027642f29cSHans de Goede 	goodix_i2c_write_u8(ts->client, GOODIX_READ_COOR_ADDR, 0);
503ca96ea86SBastien Nocera 
504ca96ea86SBastien Nocera 	return IRQ_HANDLED;
505ca96ea86SBastien Nocera }
506ca96ea86SBastien Nocera 
5075ab09d6aSIrina Tirdea static void goodix_free_irq(struct goodix_ts_data *ts)
5085ab09d6aSIrina Tirdea {
5095ab09d6aSIrina Tirdea 	devm_free_irq(&ts->client->dev, ts->client->irq, ts);
5105ab09d6aSIrina Tirdea }
5115ab09d6aSIrina Tirdea 
5125ab09d6aSIrina Tirdea static int goodix_request_irq(struct goodix_ts_data *ts)
5135ab09d6aSIrina Tirdea {
5145ab09d6aSIrina Tirdea 	return devm_request_threaded_irq(&ts->client->dev, ts->client->irq,
5155ab09d6aSIrina Tirdea 					 NULL, goodix_ts_irq_handler,
5165ab09d6aSIrina Tirdea 					 ts->irq_flags, ts->client->name, ts);
5175ab09d6aSIrina Tirdea }
5185ab09d6aSIrina Tirdea 
5191a67448fSHans de Goede static int goodix_check_cfg_8(struct goodix_ts_data *ts, const u8 *cfg, int len)
52068caf858SIrina Tirdea {
5211a67448fSHans de Goede 	int i, raw_cfg_len = len - 2;
52268caf858SIrina Tirdea 	u8 check_sum = 0;
52368caf858SIrina Tirdea 
52468caf858SIrina Tirdea 	for (i = 0; i < raw_cfg_len; i++)
5251a67448fSHans de Goede 		check_sum += cfg[i];
52668caf858SIrina Tirdea 	check_sum = (~check_sum) + 1;
5271a67448fSHans de Goede 	if (check_sum != cfg[raw_cfg_len]) {
52868caf858SIrina Tirdea 		dev_err(&ts->client->dev,
52968caf858SIrina Tirdea 			"The checksum of the config fw is not correct");
53068caf858SIrina Tirdea 		return -EINVAL;
53168caf858SIrina Tirdea 	}
53268caf858SIrina Tirdea 
5331a67448fSHans de Goede 	if (cfg[raw_cfg_len + 1] != 1) {
53468caf858SIrina Tirdea 		dev_err(&ts->client->dev,
53568caf858SIrina Tirdea 			"Config fw must have Config_Fresh register set");
53668caf858SIrina Tirdea 		return -EINVAL;
53768caf858SIrina Tirdea 	}
53868caf858SIrina Tirdea 
53968caf858SIrina Tirdea 	return 0;
54068caf858SIrina Tirdea }
54168caf858SIrina Tirdea 
542de956caeSHans de Goede static void goodix_calc_cfg_checksum_8(struct goodix_ts_data *ts)
543de956caeSHans de Goede {
544de956caeSHans de Goede 	int i, raw_cfg_len = ts->chip->config_len - 2;
545de956caeSHans de Goede 	u8 check_sum = 0;
546de956caeSHans de Goede 
547de956caeSHans de Goede 	for (i = 0; i < raw_cfg_len; i++)
548de956caeSHans de Goede 		check_sum += ts->config[i];
549de956caeSHans de Goede 	check_sum = (~check_sum) + 1;
550de956caeSHans de Goede 
551de956caeSHans de Goede 	ts->config[raw_cfg_len] = check_sum;
552de956caeSHans de Goede 	ts->config[raw_cfg_len + 1] = 1; /* Set "config_fresh" bit */
553de956caeSHans de Goede }
554de956caeSHans de Goede 
5551a67448fSHans de Goede static int goodix_check_cfg_16(struct goodix_ts_data *ts, const u8 *cfg,
5561a67448fSHans de Goede 			       int len)
55725309004SMarcin Niestroj {
5581a67448fSHans de Goede 	int i, raw_cfg_len = len - 3;
55925309004SMarcin Niestroj 	u16 check_sum = 0;
56025309004SMarcin Niestroj 
56125309004SMarcin Niestroj 	for (i = 0; i < raw_cfg_len; i += 2)
5621a67448fSHans de Goede 		check_sum += get_unaligned_be16(&cfg[i]);
56325309004SMarcin Niestroj 	check_sum = (~check_sum) + 1;
5641a67448fSHans de Goede 	if (check_sum != get_unaligned_be16(&cfg[raw_cfg_len])) {
56525309004SMarcin Niestroj 		dev_err(&ts->client->dev,
56625309004SMarcin Niestroj 			"The checksum of the config fw is not correct");
56725309004SMarcin Niestroj 		return -EINVAL;
56825309004SMarcin Niestroj 	}
56925309004SMarcin Niestroj 
5701a67448fSHans de Goede 	if (cfg[raw_cfg_len + 2] != 1) {
57125309004SMarcin Niestroj 		dev_err(&ts->client->dev,
57225309004SMarcin Niestroj 			"Config fw must have Config_Fresh register set");
57325309004SMarcin Niestroj 		return -EINVAL;
57425309004SMarcin Niestroj 	}
57525309004SMarcin Niestroj 
57625309004SMarcin Niestroj 	return 0;
57725309004SMarcin Niestroj }
57825309004SMarcin Niestroj 
579de956caeSHans de Goede static void goodix_calc_cfg_checksum_16(struct goodix_ts_data *ts)
580de956caeSHans de Goede {
581de956caeSHans de Goede 	int i, raw_cfg_len = ts->chip->config_len - 3;
582de956caeSHans de Goede 	u16 check_sum = 0;
583de956caeSHans de Goede 
584de956caeSHans de Goede 	for (i = 0; i < raw_cfg_len; i += 2)
585de956caeSHans de Goede 		check_sum += get_unaligned_be16(&ts->config[i]);
586de956caeSHans de Goede 	check_sum = (~check_sum) + 1;
587de956caeSHans de Goede 
588de956caeSHans de Goede 	put_unaligned_be16(check_sum, &ts->config[raw_cfg_len]);
589de956caeSHans de Goede 	ts->config[raw_cfg_len + 2] = 1; /* Set "config_fresh" bit */
590de956caeSHans de Goede }
591de956caeSHans de Goede 
59225309004SMarcin Niestroj /**
59325309004SMarcin Niestroj  * goodix_check_cfg - Checks if config fw is valid
59425309004SMarcin Niestroj  *
59525309004SMarcin Niestroj  * @ts: goodix_ts_data pointer
59625309004SMarcin Niestroj  * @cfg: firmware config data
597cb690465SLee Jones  * @len: config data length
59825309004SMarcin Niestroj  */
5991a67448fSHans de Goede static int goodix_check_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len)
60025309004SMarcin Niestroj {
6011a67448fSHans de Goede 	if (len < GOODIX_CONFIG_MIN_LENGTH ||
6021a67448fSHans de Goede 	    len > GOODIX_CONFIG_MAX_LENGTH) {
60325309004SMarcin Niestroj 		dev_err(&ts->client->dev,
60425309004SMarcin Niestroj 			"The length of the config fw is not correct");
60525309004SMarcin Niestroj 		return -EINVAL;
60625309004SMarcin Niestroj 	}
60725309004SMarcin Niestroj 
6081a67448fSHans de Goede 	return ts->chip->check_config(ts, cfg, len);
60925309004SMarcin Niestroj }
61025309004SMarcin Niestroj 
61168caf858SIrina Tirdea /**
61268caf858SIrina Tirdea  * goodix_send_cfg - Write fw config to device
61368caf858SIrina Tirdea  *
61468caf858SIrina Tirdea  * @ts: goodix_ts_data pointer
61568caf858SIrina Tirdea  * @cfg: config firmware to write to device
616cb690465SLee Jones  * @len: config data length
61768caf858SIrina Tirdea  */
618a2233cb7SHans de Goede int goodix_send_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len)
61968caf858SIrina Tirdea {
62068caf858SIrina Tirdea 	int error;
62168caf858SIrina Tirdea 
6221a67448fSHans de Goede 	error = goodix_check_cfg(ts, cfg, len);
62368caf858SIrina Tirdea 	if (error)
62468caf858SIrina Tirdea 		return error;
62568caf858SIrina Tirdea 
6261a67448fSHans de Goede 	error = goodix_i2c_write(ts->client, ts->chip->config_addr, cfg, len);
6277642f29cSHans de Goede 	if (error)
62868caf858SIrina Tirdea 		return error;
6297642f29cSHans de Goede 
63068caf858SIrina Tirdea 	dev_dbg(&ts->client->dev, "Config sent successfully.");
63168caf858SIrina Tirdea 
63268caf858SIrina Tirdea 	/* Let the firmware reconfigure itself, so sleep for 10ms */
63368caf858SIrina Tirdea 	usleep_range(10000, 11000);
63468caf858SIrina Tirdea 
63568caf858SIrina Tirdea 	return 0;
63668caf858SIrina Tirdea }
63768caf858SIrina Tirdea 
638c9c20ee3SHans de Goede #ifdef ACPI_GPIO_SUPPORT
639c9c20ee3SHans de Goede static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts)
64049db3997SHans de Goede {
641c9c20ee3SHans de Goede 	acpi_handle handle = ACPI_HANDLE(&ts->client->dev);
642c5fca485SHans de Goede 	acpi_status status;
643c5fca485SHans de Goede 
644c9c20ee3SHans de Goede 	status = acpi_evaluate_object(handle, "INTI", NULL, NULL);
645c9c20ee3SHans de Goede 	return ACPI_SUCCESS(status) ? 0 : -EIO;
646c9c20ee3SHans de Goede }
647c9c20ee3SHans de Goede 
648c9c20ee3SHans de Goede static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value)
649c9c20ee3SHans de Goede {
650c9c20ee3SHans de Goede 	acpi_handle handle = ACPI_HANDLE(&ts->client->dev);
651c9c20ee3SHans de Goede 	acpi_status status;
652c9c20ee3SHans de Goede 
653c9c20ee3SHans de Goede 	status = acpi_execute_simple_method(handle, "INTO", value);
654c9c20ee3SHans de Goede 	return ACPI_SUCCESS(status) ? 0 : -EIO;
655c9c20ee3SHans de Goede }
656c9c20ee3SHans de Goede #else
657c9c20ee3SHans de Goede static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts)
658c9c20ee3SHans de Goede {
659c9c20ee3SHans de Goede 	dev_err(&ts->client->dev,
660c9c20ee3SHans de Goede 		"%s called on device without ACPI support\n", __func__);
661c9c20ee3SHans de Goede 	return -EINVAL;
662c9c20ee3SHans de Goede }
663c9c20ee3SHans de Goede 
664c9c20ee3SHans de Goede static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value)
665c9c20ee3SHans de Goede {
666c9c20ee3SHans de Goede 	dev_err(&ts->client->dev,
667c9c20ee3SHans de Goede 		"%s called on device without ACPI support\n", __func__);
668c9c20ee3SHans de Goede 	return -EINVAL;
669c9c20ee3SHans de Goede }
670c9c20ee3SHans de Goede #endif
671c9c20ee3SHans de Goede 
672c9c20ee3SHans de Goede static int goodix_irq_direction_output(struct goodix_ts_data *ts, int value)
673c9c20ee3SHans de Goede {
67449db3997SHans de Goede 	switch (ts->irq_pin_access_method) {
67549db3997SHans de Goede 	case IRQ_PIN_ACCESS_NONE:
67649db3997SHans de Goede 		dev_err(&ts->client->dev,
67749db3997SHans de Goede 			"%s called without an irq_pin_access_method set\n",
67849db3997SHans de Goede 			__func__);
67949db3997SHans de Goede 		return -EINVAL;
68049db3997SHans de Goede 	case IRQ_PIN_ACCESS_GPIO:
68149db3997SHans de Goede 		return gpiod_direction_output(ts->gpiod_int, value);
682a7d4b171SHans de Goede 	case IRQ_PIN_ACCESS_ACPI_GPIO:
683a7d4b171SHans de Goede 		/*
684a7d4b171SHans de Goede 		 * The IRQ pin triggers on a falling edge, so its gets marked
685a7d4b171SHans de Goede 		 * as active-low, use output_raw to avoid the value inversion.
686a7d4b171SHans de Goede 		 */
687a7d4b171SHans de Goede 		return gpiod_direction_output_raw(ts->gpiod_int, value);
688c5fca485SHans de Goede 	case IRQ_PIN_ACCESS_ACPI_METHOD:
689c9c20ee3SHans de Goede 		return goodix_pin_acpi_output_method(ts, value);
69049db3997SHans de Goede 	}
69149db3997SHans de Goede 
69249db3997SHans de Goede 	return -EINVAL; /* Never reached */
69349db3997SHans de Goede }
69449db3997SHans de Goede 
69549db3997SHans de Goede static int goodix_irq_direction_input(struct goodix_ts_data *ts)
69649db3997SHans de Goede {
69749db3997SHans de Goede 	switch (ts->irq_pin_access_method) {
69849db3997SHans de Goede 	case IRQ_PIN_ACCESS_NONE:
69949db3997SHans de Goede 		dev_err(&ts->client->dev,
70049db3997SHans de Goede 			"%s called without an irq_pin_access_method set\n",
70149db3997SHans de Goede 			__func__);
70249db3997SHans de Goede 		return -EINVAL;
70349db3997SHans de Goede 	case IRQ_PIN_ACCESS_GPIO:
704c9c20ee3SHans de Goede 		return gpiod_direction_input(ts->gpiod_int);
705a7d4b171SHans de Goede 	case IRQ_PIN_ACCESS_ACPI_GPIO:
70649db3997SHans de Goede 		return gpiod_direction_input(ts->gpiod_int);
707c5fca485SHans de Goede 	case IRQ_PIN_ACCESS_ACPI_METHOD:
708c9c20ee3SHans de Goede 		return goodix_pin_acpi_direction_input(ts);
70949db3997SHans de Goede 	}
71049db3997SHans de Goede 
71149db3997SHans de Goede 	return -EINVAL; /* Never reached */
71249db3997SHans de Goede }
71349db3997SHans de Goede 
714a2233cb7SHans de Goede int goodix_int_sync(struct goodix_ts_data *ts)
715ec6e1b40SIrina Tirdea {
716ec6e1b40SIrina Tirdea 	int error;
717ec6e1b40SIrina Tirdea 
71849db3997SHans de Goede 	error = goodix_irq_direction_output(ts, 0);
719ec6e1b40SIrina Tirdea 	if (error)
720209bda47SHans de Goede 		goto error;
721ec6e1b40SIrina Tirdea 
722ec6e1b40SIrina Tirdea 	msleep(50);				/* T5: 50ms */
723ec6e1b40SIrina Tirdea 
72449db3997SHans de Goede 	error = goodix_irq_direction_input(ts);
725ec6e1b40SIrina Tirdea 	if (error)
726209bda47SHans de Goede 		goto error;
727ec6e1b40SIrina Tirdea 
728ec6e1b40SIrina Tirdea 	return 0;
729209bda47SHans de Goede 
730209bda47SHans de Goede error:
731209bda47SHans de Goede 	dev_err(&ts->client->dev, "Controller irq sync failed.\n");
732209bda47SHans de Goede 	return error;
733209bda47SHans de Goede }
734209bda47SHans de Goede 
735209bda47SHans de Goede /**
736209bda47SHans de Goede  * goodix_reset_no_int_sync - Reset device, leaving interrupt line in output mode
737209bda47SHans de Goede  *
738209bda47SHans de Goede  * @ts: goodix_ts_data pointer
739209bda47SHans de Goede  */
740209bda47SHans de Goede int goodix_reset_no_int_sync(struct goodix_ts_data *ts)
741209bda47SHans de Goede {
742209bda47SHans de Goede 	int error;
743209bda47SHans de Goede 
744209bda47SHans de Goede 	/* begin select I2C slave addr */
745209bda47SHans de Goede 	error = gpiod_direction_output(ts->gpiod_rst, 0);
746209bda47SHans de Goede 	if (error)
747209bda47SHans de Goede 		goto error;
748209bda47SHans de Goede 
749209bda47SHans de Goede 	msleep(20);				/* T2: > 10ms */
750209bda47SHans de Goede 
751209bda47SHans de Goede 	/* HIGH: 0x28/0x29, LOW: 0xBA/0xBB */
752209bda47SHans de Goede 	error = goodix_irq_direction_output(ts, ts->client->addr == 0x14);
753209bda47SHans de Goede 	if (error)
754209bda47SHans de Goede 		goto error;
755209bda47SHans de Goede 
756209bda47SHans de Goede 	usleep_range(100, 2000);		/* T3: > 100us */
757209bda47SHans de Goede 
758209bda47SHans de Goede 	error = gpiod_direction_output(ts->gpiod_rst, 1);
759209bda47SHans de Goede 	if (error)
760209bda47SHans de Goede 		goto error;
761209bda47SHans de Goede 
762209bda47SHans de Goede 	usleep_range(6000, 10000);		/* T4: > 5ms */
763209bda47SHans de Goede 
764a2fd46cdSHans de Goede 	/*
765a2fd46cdSHans de Goede 	 * Put the reset pin back in to input / high-impedance mode to save
766a2fd46cdSHans de Goede 	 * power. Only do this in the non ACPI case since some ACPI boards
767a2fd46cdSHans de Goede 	 * don't have a pull-up, so there the reset pin must stay active-high.
768a2fd46cdSHans de Goede 	 */
769a2fd46cdSHans de Goede 	if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_GPIO) {
770209bda47SHans de Goede 		error = gpiod_direction_input(ts->gpiod_rst);
771209bda47SHans de Goede 		if (error)
772209bda47SHans de Goede 			goto error;
773a2fd46cdSHans de Goede 	}
774209bda47SHans de Goede 
775209bda47SHans de Goede 	return 0;
776209bda47SHans de Goede 
777209bda47SHans de Goede error:
778209bda47SHans de Goede 	dev_err(&ts->client->dev, "Controller reset failed.\n");
779209bda47SHans de Goede 	return error;
780ec6e1b40SIrina Tirdea }
781ec6e1b40SIrina Tirdea 
782ec6e1b40SIrina Tirdea /**
783ec6e1b40SIrina Tirdea  * goodix_reset - Reset device during power on
784ec6e1b40SIrina Tirdea  *
785ec6e1b40SIrina Tirdea  * @ts: goodix_ts_data pointer
786ec6e1b40SIrina Tirdea  */
787ec6e1b40SIrina Tirdea static int goodix_reset(struct goodix_ts_data *ts)
788ec6e1b40SIrina Tirdea {
789ec6e1b40SIrina Tirdea 	int error;
790ec6e1b40SIrina Tirdea 
791209bda47SHans de Goede 	error = goodix_reset_no_int_sync(ts);
792ec6e1b40SIrina Tirdea 	if (error)
793ec6e1b40SIrina Tirdea 		return error;
794ec6e1b40SIrina Tirdea 
795209bda47SHans de Goede 	return goodix_int_sync(ts);
796ec6e1b40SIrina Tirdea }
797ec6e1b40SIrina Tirdea 
798c9c20ee3SHans de Goede #ifdef ACPI_GPIO_SUPPORT
799a7d4b171SHans de Goede static const struct acpi_gpio_params first_gpio = { 0, 0, false };
800a7d4b171SHans de Goede static const struct acpi_gpio_params second_gpio = { 1, 0, false };
801a7d4b171SHans de Goede 
802a7d4b171SHans de Goede static const struct acpi_gpio_mapping acpi_goodix_int_first_gpios[] = {
803a7d4b171SHans de Goede 	{ GOODIX_GPIO_INT_NAME "-gpios", &first_gpio, 1 },
804a7d4b171SHans de Goede 	{ GOODIX_GPIO_RST_NAME "-gpios", &second_gpio, 1 },
805a7d4b171SHans de Goede 	{ },
806a7d4b171SHans de Goede };
807a7d4b171SHans de Goede 
808a7d4b171SHans de Goede static const struct acpi_gpio_mapping acpi_goodix_int_last_gpios[] = {
809a7d4b171SHans de Goede 	{ GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 },
810a7d4b171SHans de Goede 	{ GOODIX_GPIO_INT_NAME "-gpios", &second_gpio, 1 },
811a7d4b171SHans de Goede 	{ },
812a7d4b171SHans de Goede };
813a7d4b171SHans de Goede 
814c5fca485SHans de Goede static const struct acpi_gpio_mapping acpi_goodix_reset_only_gpios[] = {
815c5fca485SHans de Goede 	{ GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 },
816c5fca485SHans de Goede 	{ },
817c5fca485SHans de Goede };
818c5fca485SHans de Goede 
819a7d4b171SHans de Goede static int goodix_resource(struct acpi_resource *ares, void *data)
820a7d4b171SHans de Goede {
821a7d4b171SHans de Goede 	struct goodix_ts_data *ts = data;
822a7d4b171SHans de Goede 	struct device *dev = &ts->client->dev;
823a7d4b171SHans de Goede 	struct acpi_resource_gpio *gpio;
824a7d4b171SHans de Goede 
825*c4bcc1b9SAndy Shevchenko 	if (acpi_gpio_get_irq_resource(ares, &gpio)) {
826a7d4b171SHans de Goede 		if (ts->gpio_int_idx == -1) {
827a7d4b171SHans de Goede 			ts->gpio_int_idx = ts->gpio_count;
828a7d4b171SHans de Goede 		} else {
829a7d4b171SHans de Goede 			dev_err(dev, "More then one GpioInt resource, ignoring ACPI GPIO resources\n");
830a7d4b171SHans de Goede 			ts->gpio_int_idx = -2;
831a7d4b171SHans de Goede 		}
832a7d4b171SHans de Goede 		ts->gpio_count++;
833*c4bcc1b9SAndy Shevchenko 	} else if (acpi_gpio_get_io_resource(ares, &gpio))
834*c4bcc1b9SAndy Shevchenko 		ts->gpio_count++;
835a7d4b171SHans de Goede 
836a7d4b171SHans de Goede 	return 0;
837a7d4b171SHans de Goede }
838a7d4b171SHans de Goede 
839a7d4b171SHans de Goede /*
840a7d4b171SHans de Goede  * This function gets called in case we fail to get the irq GPIO directly
841a7d4b171SHans de Goede  * because the ACPI tables lack GPIO-name to APCI _CRS index mappings
842a7d4b171SHans de Goede  * (no _DSD UUID daffd814-6eba-4d8c-8a91-bc9bbf4aa301 data).
843a7d4b171SHans de Goede  * In that case we add our own mapping and then goodix_get_gpio_config()
844a7d4b171SHans de Goede  * retries to get the GPIOs based on the added mapping.
845a7d4b171SHans de Goede  */
846a7d4b171SHans de Goede static int goodix_add_acpi_gpio_mappings(struct goodix_ts_data *ts)
847a7d4b171SHans de Goede {
848a7d4b171SHans de Goede 	const struct acpi_gpio_mapping *gpio_mapping = NULL;
849a7d4b171SHans de Goede 	struct device *dev = &ts->client->dev;
850a7d4b171SHans de Goede 	LIST_HEAD(resources);
851d9829926SHans de Goede 	int irq, ret;
852a7d4b171SHans de Goede 
853a7d4b171SHans de Goede 	ts->gpio_count = 0;
854a7d4b171SHans de Goede 	ts->gpio_int_idx = -1;
855a7d4b171SHans de Goede 	ret = acpi_dev_get_resources(ACPI_COMPANION(dev), &resources,
856a7d4b171SHans de Goede 				     goodix_resource, ts);
857a7d4b171SHans de Goede 	if (ret < 0) {
858a7d4b171SHans de Goede 		dev_err(dev, "Error getting ACPI resources: %d\n", ret);
859a7d4b171SHans de Goede 		return ret;
860a7d4b171SHans de Goede 	}
861a7d4b171SHans de Goede 
862a7d4b171SHans de Goede 	acpi_dev_free_resource_list(&resources);
863a7d4b171SHans de Goede 
864d9829926SHans de Goede 	/*
865d9829926SHans de Goede 	 * CHT devices should have a GpioInt + a regular GPIO ACPI resource.
866d9829926SHans de Goede 	 * Some CHT devices have a bug (where the also is bogus Interrupt
867d9829926SHans de Goede 	 * resource copied from a previous BYT based generation). i2c-core-acpi
868d9829926SHans de Goede 	 * will use the non-working Interrupt resource, fix this up.
869d9829926SHans de Goede 	 */
870d9829926SHans de Goede 	if (soc_intel_is_cht() && ts->gpio_count == 2 && ts->gpio_int_idx != -1) {
871d9829926SHans de Goede 		irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0);
872d9829926SHans de Goede 		if (irq > 0 && irq != ts->client->irq) {
873d9829926SHans de Goede 			dev_warn(dev, "Overriding IRQ %d -> %d\n", ts->client->irq, irq);
874d9829926SHans de Goede 			ts->client->irq = irq;
875d9829926SHans de Goede 		}
876d9829926SHans de Goede 	}
877d9829926SHans de Goede 
878a7d4b171SHans de Goede 	if (ts->gpio_count == 2 && ts->gpio_int_idx == 0) {
879a7d4b171SHans de Goede 		ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
880a7d4b171SHans de Goede 		gpio_mapping = acpi_goodix_int_first_gpios;
881a7d4b171SHans de Goede 	} else if (ts->gpio_count == 2 && ts->gpio_int_idx == 1) {
882a7d4b171SHans de Goede 		ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
883a7d4b171SHans de Goede 		gpio_mapping = acpi_goodix_int_last_gpios;
884c5fca485SHans de Goede 	} else if (ts->gpio_count == 1 && ts->gpio_int_idx == -1 &&
885c5fca485SHans de Goede 		   acpi_has_method(ACPI_HANDLE(dev), "INTI") &&
886c5fca485SHans de Goede 		   acpi_has_method(ACPI_HANDLE(dev), "INTO")) {
887c5fca485SHans de Goede 		dev_info(dev, "Using ACPI INTI and INTO methods for IRQ pin access\n");
888c5fca485SHans de Goede 		ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_METHOD;
889c5fca485SHans de Goede 		gpio_mapping = acpi_goodix_reset_only_gpios;
890d176708fSHans de Goede 	} else if (soc_intel_is_byt() && ts->gpio_count == 2 && ts->gpio_int_idx == -1) {
89167abd9eeSHans de Goede 		dev_info(dev, "No ACPI GpioInt resource, assuming that the GPIO order is reset, int\n");
89267abd9eeSHans de Goede 		ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
89367abd9eeSHans de Goede 		gpio_mapping = acpi_goodix_int_last_gpios;
894a7d4b171SHans de Goede 	} else {
895a7d4b171SHans de Goede 		dev_warn(dev, "Unexpected ACPI resources: gpio_count %d, gpio_int_idx %d\n",
896a7d4b171SHans de Goede 			 ts->gpio_count, ts->gpio_int_idx);
897a7d4b171SHans de Goede 		return -EINVAL;
898a7d4b171SHans de Goede 	}
899a7d4b171SHans de Goede 
900a2fd46cdSHans de Goede 	/*
901a2fd46cdSHans de Goede 	 * Normally we put the reset pin in input / high-impedance mode to save
902a2fd46cdSHans de Goede 	 * power. But some x86/ACPI boards don't have a pull-up, so for the ACPI
903a2fd46cdSHans de Goede 	 * case, leave the pin as is. This results in the pin not being touched
904a2fd46cdSHans de Goede 	 * at all on x86/ACPI boards, except when needed for error-recover.
905a2fd46cdSHans de Goede 	 */
906a2fd46cdSHans de Goede 	ts->gpiod_rst_flags = GPIOD_ASIS;
907a2fd46cdSHans de Goede 
908a7d4b171SHans de Goede 	return devm_acpi_dev_add_driver_gpios(dev, gpio_mapping);
909a7d4b171SHans de Goede }
910a7d4b171SHans de Goede #else
911a7d4b171SHans de Goede static int goodix_add_acpi_gpio_mappings(struct goodix_ts_data *ts)
912a7d4b171SHans de Goede {
913a7d4b171SHans de Goede 	return -EINVAL;
914a7d4b171SHans de Goede }
915a7d4b171SHans de Goede #endif /* CONFIG_X86 && CONFIG_ACPI */
916a7d4b171SHans de Goede 
917ec6e1b40SIrina Tirdea /**
918ec6e1b40SIrina Tirdea  * goodix_get_gpio_config - Get GPIO config from ACPI/DT
919ec6e1b40SIrina Tirdea  *
920ec6e1b40SIrina Tirdea  * @ts: goodix_ts_data pointer
921ec6e1b40SIrina Tirdea  */
922ec6e1b40SIrina Tirdea static int goodix_get_gpio_config(struct goodix_ts_data *ts)
923ec6e1b40SIrina Tirdea {
924ec6e1b40SIrina Tirdea 	int error;
925ec6e1b40SIrina Tirdea 	struct device *dev;
926ec6e1b40SIrina Tirdea 	struct gpio_desc *gpiod;
927a7d4b171SHans de Goede 	bool added_acpi_mappings = false;
928ec6e1b40SIrina Tirdea 
929ec6e1b40SIrina Tirdea 	if (!ts->client)
930ec6e1b40SIrina Tirdea 		return -EINVAL;
931ec6e1b40SIrina Tirdea 	dev = &ts->client->dev;
932ec6e1b40SIrina Tirdea 
933a2fd46cdSHans de Goede 	/*
934a2fd46cdSHans de Goede 	 * By default we request the reset pin as input, leaving it in
935a2fd46cdSHans de Goede 	 * high-impedance when not resetting the controller to save power.
936a2fd46cdSHans de Goede 	 */
937a2fd46cdSHans de Goede 	ts->gpiod_rst_flags = GPIOD_IN;
938a2fd46cdSHans de Goede 
939ae97fb58SJagan Teki 	ts->avdd28 = devm_regulator_get(dev, "AVDD28");
940ae97fb58SJagan Teki 	if (IS_ERR(ts->avdd28)) {
941ae97fb58SJagan Teki 		error = PTR_ERR(ts->avdd28);
942ae97fb58SJagan Teki 		if (error != -EPROBE_DEFER)
943ae97fb58SJagan Teki 			dev_err(dev,
944ae97fb58SJagan Teki 				"Failed to get AVDD28 regulator: %d\n", error);
945ae97fb58SJagan Teki 		return error;
946ae97fb58SJagan Teki 	}
947ae97fb58SJagan Teki 
948ae97fb58SJagan Teki 	ts->vddio = devm_regulator_get(dev, "VDDIO");
949ae97fb58SJagan Teki 	if (IS_ERR(ts->vddio)) {
950ae97fb58SJagan Teki 		error = PTR_ERR(ts->vddio);
951ae97fb58SJagan Teki 		if (error != -EPROBE_DEFER)
952ae97fb58SJagan Teki 			dev_err(dev,
953ae97fb58SJagan Teki 				"Failed to get VDDIO regulator: %d\n", error);
954ae97fb58SJagan Teki 		return error;
955ae97fb58SJagan Teki 	}
956ae97fb58SJagan Teki 
957a7d4b171SHans de Goede retry_get_irq_gpio:
958ec6e1b40SIrina Tirdea 	/* Get the interrupt GPIO pin number */
959ec6e1b40SIrina Tirdea 	gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_INT_NAME, GPIOD_IN);
960ec6e1b40SIrina Tirdea 	if (IS_ERR(gpiod)) {
961ec6e1b40SIrina Tirdea 		error = PTR_ERR(gpiod);
962ec6e1b40SIrina Tirdea 		if (error != -EPROBE_DEFER)
96384345c61SHans de Goede 			dev_err(dev, "Failed to get %s GPIO: %d\n",
964ec6e1b40SIrina Tirdea 				GOODIX_GPIO_INT_NAME, error);
965ec6e1b40SIrina Tirdea 		return error;
966ec6e1b40SIrina Tirdea 	}
967a7d4b171SHans de Goede 	if (!gpiod && has_acpi_companion(dev) && !added_acpi_mappings) {
968a7d4b171SHans de Goede 		added_acpi_mappings = true;
969a7d4b171SHans de Goede 		if (goodix_add_acpi_gpio_mappings(ts) == 0)
970a7d4b171SHans de Goede 			goto retry_get_irq_gpio;
971a7d4b171SHans de Goede 	}
972ec6e1b40SIrina Tirdea 
973ec6e1b40SIrina Tirdea 	ts->gpiod_int = gpiod;
974ec6e1b40SIrina Tirdea 
975ec6e1b40SIrina Tirdea 	/* Get the reset line GPIO pin number */
976a2fd46cdSHans de Goede 	gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_RST_NAME, ts->gpiod_rst_flags);
977ec6e1b40SIrina Tirdea 	if (IS_ERR(gpiod)) {
978ec6e1b40SIrina Tirdea 		error = PTR_ERR(gpiod);
979ec6e1b40SIrina Tirdea 		if (error != -EPROBE_DEFER)
98084345c61SHans de Goede 			dev_err(dev, "Failed to get %s GPIO: %d\n",
981ec6e1b40SIrina Tirdea 				GOODIX_GPIO_RST_NAME, error);
982ec6e1b40SIrina Tirdea 		return error;
983ec6e1b40SIrina Tirdea 	}
984ec6e1b40SIrina Tirdea 
985ec6e1b40SIrina Tirdea 	ts->gpiod_rst = gpiod;
986ec6e1b40SIrina Tirdea 
987a7d4b171SHans de Goede 	switch (ts->irq_pin_access_method) {
988a7d4b171SHans de Goede 	case IRQ_PIN_ACCESS_ACPI_GPIO:
989a7d4b171SHans de Goede 		/*
990a7d4b171SHans de Goede 		 * We end up here if goodix_add_acpi_gpio_mappings() has
991a7d4b171SHans de Goede 		 * called devm_acpi_dev_add_driver_gpios() because the ACPI
992a7d4b171SHans de Goede 		 * tables did not contain name to index mappings.
993a7d4b171SHans de Goede 		 * Check that we successfully got both GPIOs after we've
994a7d4b171SHans de Goede 		 * added our own acpi_gpio_mapping and if we did not get both
995a7d4b171SHans de Goede 		 * GPIOs reset irq_pin_access_method to IRQ_PIN_ACCESS_NONE.
996a7d4b171SHans de Goede 		 */
997a7d4b171SHans de Goede 		if (!ts->gpiod_int || !ts->gpiod_rst)
998a7d4b171SHans de Goede 			ts->irq_pin_access_method = IRQ_PIN_ACCESS_NONE;
999a7d4b171SHans de Goede 		break;
1000c5fca485SHans de Goede 	case IRQ_PIN_ACCESS_ACPI_METHOD:
1001c5fca485SHans de Goede 		if (!ts->gpiod_rst)
1002c5fca485SHans de Goede 			ts->irq_pin_access_method = IRQ_PIN_ACCESS_NONE;
1003c5fca485SHans de Goede 		break;
1004a7d4b171SHans de Goede 	default:
1005e070a97bSHans de Goede 		if (ts->gpiod_int && ts->gpiod_rst) {
10061921daceSHans de Goede 			ts->reset_controller_at_probe = true;
1007e070a97bSHans de Goede 			ts->load_cfg_from_disk = true;
100849db3997SHans de Goede 			ts->irq_pin_access_method = IRQ_PIN_ACCESS_GPIO;
1009e070a97bSHans de Goede 		}
1010a7d4b171SHans de Goede 	}
101149db3997SHans de Goede 
1012ec6e1b40SIrina Tirdea 	return 0;
1013ec6e1b40SIrina Tirdea }
1014ec6e1b40SIrina Tirdea 
1015ca96ea86SBastien Nocera /**
1016ca96ea86SBastien Nocera  * goodix_read_config - Read the embedded configuration of the panel
1017ca96ea86SBastien Nocera  *
1018ca96ea86SBastien Nocera  * @ts: our goodix_ts_data pointer
1019ca96ea86SBastien Nocera  *
1020ca96ea86SBastien Nocera  * Must be called during probe
1021ca96ea86SBastien Nocera  */
1022ca96ea86SBastien Nocera static void goodix_read_config(struct goodix_ts_data *ts)
1023ca96ea86SBastien Nocera {
1024fafef982SMarcin Niestroj 	int x_max, y_max;
1025ca96ea86SBastien Nocera 	int error;
1026ca96ea86SBastien Nocera 
102709182ed2SHans de Goede 	/*
102809182ed2SHans de Goede 	 * On controllers where we need to upload the firmware
102909182ed2SHans de Goede 	 * (controllers without flash) ts->config already has the config
103009182ed2SHans de Goede 	 * at this point and the controller itself does not have it yet!
103109182ed2SHans de Goede 	 */
103209182ed2SHans de Goede 	if (!ts->firmware_name) {
103325309004SMarcin Niestroj 		error = goodix_i2c_read(ts->client, ts->chip->config_addr,
1034de956caeSHans de Goede 					ts->config, ts->chip->config_len);
1035ca96ea86SBastien Nocera 		if (error) {
1036ca96ea86SBastien Nocera 			ts->int_trigger_type = GOODIX_INT_TRIGGER;
1037a7ac7c95SAleksei Mamlin 			ts->max_touch_num = GOODIX_MAX_CONTACTS;
1038ca96ea86SBastien Nocera 			return;
1039ca96ea86SBastien Nocera 		}
104009182ed2SHans de Goede 	}
1041ca96ea86SBastien Nocera 
1042de956caeSHans de Goede 	ts->int_trigger_type = ts->config[TRIGGER_LOC] & 0x03;
1043de956caeSHans de Goede 	ts->max_touch_num = ts->config[MAX_CONTACTS_LOC] & 0x0f;
10448b5a359cSBastien Nocera 
1045de956caeSHans de Goede 	x_max = get_unaligned_le16(&ts->config[RESOLUTION_LOC]);
1046de956caeSHans de Goede 	y_max = get_unaligned_le16(&ts->config[RESOLUTION_LOC + 2]);
1047fafef982SMarcin Niestroj 	if (x_max && y_max) {
1048fafef982SMarcin Niestroj 		input_abs_set_max(ts->input_dev, ABS_MT_POSITION_X, x_max - 1);
1049fafef982SMarcin Niestroj 		input_abs_set_max(ts->input_dev, ABS_MT_POSITION_Y, y_max - 1);
1050ca96ea86SBastien Nocera 	}
1051de956caeSHans de Goede 
1052de956caeSHans de Goede 	ts->chip->calc_config_checksum(ts);
105357c80e8eSKarsten Merker }
1054ca96ea86SBastien Nocera 
1055ca96ea86SBastien Nocera /**
1056ca96ea86SBastien Nocera  * goodix_read_version - Read goodix touchscreen version
1057ca96ea86SBastien Nocera  *
105868caf858SIrina Tirdea  * @ts: our goodix_ts_data pointer
1059ca96ea86SBastien Nocera  */
106068caf858SIrina Tirdea static int goodix_read_version(struct goodix_ts_data *ts)
1061ca96ea86SBastien Nocera {
1062ca96ea86SBastien Nocera 	int error;
1063ca96ea86SBastien Nocera 	u8 buf[6];
1064cae102e2SIcenowy Zheng 	char id_str[GOODIX_ID_MAX_LEN + 1];
1065ca96ea86SBastien Nocera 
106668caf858SIrina Tirdea 	error = goodix_i2c_read(ts->client, GOODIX_REG_ID, buf, sizeof(buf));
10677642f29cSHans de Goede 	if (error)
1068ca96ea86SBastien Nocera 		return error;
1069ca96ea86SBastien Nocera 
1070cae102e2SIcenowy Zheng 	memcpy(id_str, buf, GOODIX_ID_MAX_LEN);
1071cae102e2SIcenowy Zheng 	id_str[GOODIX_ID_MAX_LEN] = 0;
1072cae102e2SIcenowy Zheng 	strscpy(ts->id, id_str, GOODIX_ID_MAX_LEN + 1);
1073e70b0307SIrina Tirdea 
107468caf858SIrina Tirdea 	ts->version = get_unaligned_le16(&buf[4]);
1075ca96ea86SBastien Nocera 
1076cae102e2SIcenowy Zheng 	dev_info(&ts->client->dev, "ID %s, version: %04x\n", ts->id,
107768caf858SIrina Tirdea 		 ts->version);
1078ca96ea86SBastien Nocera 
1079ca96ea86SBastien Nocera 	return 0;
1080ca96ea86SBastien Nocera }
1081ca96ea86SBastien Nocera 
1082ca96ea86SBastien Nocera /**
1083ca96ea86SBastien Nocera  * goodix_i2c_test - I2C test function to check if the device answers.
1084ca96ea86SBastien Nocera  *
1085ca96ea86SBastien Nocera  * @client: the i2c client
1086ca96ea86SBastien Nocera  */
1087ca96ea86SBastien Nocera static int goodix_i2c_test(struct i2c_client *client)
1088ca96ea86SBastien Nocera {
1089ca96ea86SBastien Nocera 	int retry = 0;
1090ca96ea86SBastien Nocera 	int error;
1091ca96ea86SBastien Nocera 	u8 test;
1092ca96ea86SBastien Nocera 
1093ca96ea86SBastien Nocera 	while (retry++ < 2) {
10947642f29cSHans de Goede 		error = goodix_i2c_read(client, GOODIX_REG_ID, &test, 1);
1095ca96ea86SBastien Nocera 		if (!error)
1096ca96ea86SBastien Nocera 			return 0;
1097ca96ea86SBastien Nocera 
1098ca96ea86SBastien Nocera 		msleep(20);
1099ca96ea86SBastien Nocera 	}
1100ca96ea86SBastien Nocera 
1101ca96ea86SBastien Nocera 	return error;
1102ca96ea86SBastien Nocera }
1103ca96ea86SBastien Nocera 
1104ca96ea86SBastien Nocera /**
110568caf858SIrina Tirdea  * goodix_configure_dev - Finish device initialization
110668caf858SIrina Tirdea  *
110768caf858SIrina Tirdea  * @ts: our goodix_ts_data pointer
110868caf858SIrina Tirdea  *
110968caf858SIrina Tirdea  * Must be called from probe to finish initialization of the device.
111068caf858SIrina Tirdea  * Contains the common initialization code for both devices that
111168caf858SIrina Tirdea  * declare gpio pins and devices that do not. It is either called
111268caf858SIrina Tirdea  * directly from probe or from request_firmware_wait callback.
111368caf858SIrina Tirdea  */
111468caf858SIrina Tirdea static int goodix_configure_dev(struct goodix_ts_data *ts)
111568caf858SIrina Tirdea {
111668caf858SIrina Tirdea 	int error;
1117492ee52cSDmitry Mastykin 	int i;
111868caf858SIrina Tirdea 
1119fafef982SMarcin Niestroj 	ts->int_trigger_type = GOODIX_INT_TRIGGER;
1120fafef982SMarcin Niestroj 	ts->max_touch_num = GOODIX_MAX_CONTACTS;
1121ad48cf5eSKarsten Merker 
1122fafef982SMarcin Niestroj 	ts->input_dev = devm_input_allocate_device(&ts->client->dev);
1123fafef982SMarcin Niestroj 	if (!ts->input_dev) {
1124fafef982SMarcin Niestroj 		dev_err(&ts->client->dev, "Failed to allocate input device.");
1125fafef982SMarcin Niestroj 		return -ENOMEM;
1126fafef982SMarcin Niestroj 	}
1127fafef982SMarcin Niestroj 
1128fafef982SMarcin Niestroj 	ts->input_dev->name = "Goodix Capacitive TouchScreen";
1129fafef982SMarcin Niestroj 	ts->input_dev->phys = "input/ts";
1130fafef982SMarcin Niestroj 	ts->input_dev->id.bustype = BUS_I2C;
1131fafef982SMarcin Niestroj 	ts->input_dev->id.vendor = 0x0416;
1132cae102e2SIcenowy Zheng 	if (kstrtou16(ts->id, 10, &ts->input_dev->id.product))
1133cae102e2SIcenowy Zheng 		ts->input_dev->id.product = 0x1001;
1134fafef982SMarcin Niestroj 	ts->input_dev->id.version = ts->version;
1135fafef982SMarcin Niestroj 
1136492ee52cSDmitry Mastykin 	ts->input_dev->keycode = ts->keymap;
1137492ee52cSDmitry Mastykin 	ts->input_dev->keycodesize = sizeof(ts->keymap[0]);
1138492ee52cSDmitry Mastykin 	ts->input_dev->keycodemax = GOODIX_MAX_KEYS;
1139492ee52cSDmitry Mastykin 
1140fafef982SMarcin Niestroj 	/* Capacitive Windows/Home button on some devices */
1141492ee52cSDmitry Mastykin 	for (i = 0; i < GOODIX_MAX_KEYS; ++i) {
1142492ee52cSDmitry Mastykin 		if (i == 0)
1143492ee52cSDmitry Mastykin 			ts->keymap[i] = KEY_LEFTMETA;
1144492ee52cSDmitry Mastykin 		else
1145492ee52cSDmitry Mastykin 			ts->keymap[i] = KEY_F1 + (i - 1);
1146492ee52cSDmitry Mastykin 
1147492ee52cSDmitry Mastykin 		input_set_capability(ts->input_dev, EV_KEY, ts->keymap[i]);
1148492ee52cSDmitry Mastykin 	}
1149fafef982SMarcin Niestroj 
1150fafef982SMarcin Niestroj 	input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_X);
1151fafef982SMarcin Niestroj 	input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_Y);
1152fafef982SMarcin Niestroj 	input_set_abs_params(ts->input_dev, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0);
1153fafef982SMarcin Niestroj 	input_set_abs_params(ts->input_dev, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
1154fafef982SMarcin Niestroj 
1155fafef982SMarcin Niestroj 	/* Read configuration and apply touchscreen parameters */
115668caf858SIrina Tirdea 	goodix_read_config(ts);
115768caf858SIrina Tirdea 
1158fafef982SMarcin Niestroj 	/* Try overriding touchscreen parameters via device properties */
1159fafef982SMarcin Niestroj 	touchscreen_parse_properties(ts->input_dev, true, &ts->prop);
1160fafef982SMarcin Niestroj 
1161fafef982SMarcin Niestroj 	if (!ts->prop.max_x || !ts->prop.max_y || !ts->max_touch_num) {
1162c1c00aa5SGuido Günther 		dev_err(&ts->client->dev,
1163c1c00aa5SGuido Günther 			"Invalid config (%d, %d, %d), using defaults\n",
1164c1c00aa5SGuido Günther 			ts->prop.max_x, ts->prop.max_y, ts->max_touch_num);
1165fafef982SMarcin Niestroj 		ts->prop.max_x = GOODIX_MAX_WIDTH - 1;
1166fafef982SMarcin Niestroj 		ts->prop.max_y = GOODIX_MAX_HEIGHT - 1;
1167fafef982SMarcin Niestroj 		ts->max_touch_num = GOODIX_MAX_CONTACTS;
1168fafef982SMarcin Niestroj 		input_abs_set_max(ts->input_dev,
1169fafef982SMarcin Niestroj 				  ABS_MT_POSITION_X, ts->prop.max_x);
1170fafef982SMarcin Niestroj 		input_abs_set_max(ts->input_dev,
1171fafef982SMarcin Niestroj 				  ABS_MT_POSITION_Y, ts->prop.max_y);
1172fafef982SMarcin Niestroj 	}
1173fafef982SMarcin Niestroj 
1174bd3b8480SYauhen Kharuzhy 	if (dmi_check_system(nine_bytes_report)) {
1175bd3b8480SYauhen Kharuzhy 		ts->contact_size = 9;
1176bd3b8480SYauhen Kharuzhy 
1177bd3b8480SYauhen Kharuzhy 		dev_dbg(&ts->client->dev,
1178bd3b8480SYauhen Kharuzhy 			"Non-standard 9-bytes report format quirk\n");
1179bd3b8480SYauhen Kharuzhy 	}
1180bd3b8480SYauhen Kharuzhy 
11811dd5ddc1SSergei A. Trusov 	if (dmi_check_system(inverted_x_screen)) {
11821dd5ddc1SSergei A. Trusov 		ts->prop.invert_x = true;
11831dd5ddc1SSergei A. Trusov 		dev_dbg(&ts->client->dev,
11841dd5ddc1SSergei A. Trusov 			"Applying 'inverted x screen' quirk\n");
11851dd5ddc1SSergei A. Trusov 	}
11861dd5ddc1SSergei A. Trusov 
1187fafef982SMarcin Niestroj 	error = input_mt_init_slots(ts->input_dev, ts->max_touch_num,
1188fafef982SMarcin Niestroj 				    INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
1189fafef982SMarcin Niestroj 	if (error) {
1190fafef982SMarcin Niestroj 		dev_err(&ts->client->dev,
1191fafef982SMarcin Niestroj 			"Failed to initialize MT slots: %d", error);
119268caf858SIrina Tirdea 		return error;
1193fafef982SMarcin Niestroj 	}
1194fafef982SMarcin Niestroj 
1195fafef982SMarcin Niestroj 	error = input_register_device(ts->input_dev);
1196fafef982SMarcin Niestroj 	if (error) {
1197fafef982SMarcin Niestroj 		dev_err(&ts->client->dev,
1198fafef982SMarcin Niestroj 			"Failed to register input device: %d", error);
1199fafef982SMarcin Niestroj 		return error;
1200fafef982SMarcin Niestroj 	}
120168caf858SIrina Tirdea 
120265de58c2SHans de Goede 	/*
120365de58c2SHans de Goede 	 * Create the input_pen device before goodix_request_irq() calls
120465de58c2SHans de Goede 	 * devm_request_threaded_irq() so that the devm framework frees
120565de58c2SHans de Goede 	 * it after disabling the irq.
120665de58c2SHans de Goede 	 * Unfortunately there is no way to detect if the touchscreen has pen
120765de58c2SHans de Goede 	 * support, so registering the dev is delayed till the first pen event.
120865de58c2SHans de Goede 	 */
120965de58c2SHans de Goede 	error = goodix_create_pen_input(ts);
121065de58c2SHans de Goede 	if (error)
121165de58c2SHans de Goede 		return error;
121265de58c2SHans de Goede 
12135ab09d6aSIrina Tirdea 	ts->irq_flags = goodix_irq_flags[ts->int_trigger_type] | IRQF_ONESHOT;
12145ab09d6aSIrina Tirdea 	error = goodix_request_irq(ts);
121568caf858SIrina Tirdea 	if (error) {
121668caf858SIrina Tirdea 		dev_err(&ts->client->dev, "request IRQ failed: %d\n", error);
121768caf858SIrina Tirdea 		return error;
121868caf858SIrina Tirdea 	}
121968caf858SIrina Tirdea 
122068caf858SIrina Tirdea 	return 0;
122168caf858SIrina Tirdea }
122268caf858SIrina Tirdea 
122368caf858SIrina Tirdea /**
122468caf858SIrina Tirdea  * goodix_config_cb - Callback to finish device init
122568caf858SIrina Tirdea  *
1226cb690465SLee Jones  * @cfg: firmware config
1227584da78cSLee Jones  * @ctx: our goodix_ts_data pointer
122868caf858SIrina Tirdea  *
122968caf858SIrina Tirdea  * request_firmware_wait callback that finishes
123068caf858SIrina Tirdea  * initialization of the device.
123168caf858SIrina Tirdea  */
123268caf858SIrina Tirdea static void goodix_config_cb(const struct firmware *cfg, void *ctx)
123368caf858SIrina Tirdea {
123468caf858SIrina Tirdea 	struct goodix_ts_data *ts = ctx;
123568caf858SIrina Tirdea 	int error;
123668caf858SIrina Tirdea 
123709182ed2SHans de Goede 	if (ts->firmware_name) {
123809182ed2SHans de Goede 		if (!cfg)
123909182ed2SHans de Goede 			goto err_release_cfg;
124009182ed2SHans de Goede 
124109182ed2SHans de Goede 		error = goodix_check_cfg(ts, cfg->data, cfg->size);
124209182ed2SHans de Goede 		if (error)
124309182ed2SHans de Goede 			goto err_release_cfg;
124409182ed2SHans de Goede 
124509182ed2SHans de Goede 		memcpy(ts->config, cfg->data, cfg->size);
124609182ed2SHans de Goede 	} else if (cfg) {
124768caf858SIrina Tirdea 		/* send device configuration to the firmware */
12481a67448fSHans de Goede 		error = goodix_send_cfg(ts, cfg->data, cfg->size);
124968caf858SIrina Tirdea 		if (error)
125068caf858SIrina Tirdea 			goto err_release_cfg;
125168caf858SIrina Tirdea 	}
125268caf858SIrina Tirdea 
125368caf858SIrina Tirdea 	goodix_configure_dev(ts);
125468caf858SIrina Tirdea 
125568caf858SIrina Tirdea err_release_cfg:
125668caf858SIrina Tirdea 	release_firmware(cfg);
125768caf858SIrina Tirdea 	complete_all(&ts->firmware_loading_complete);
125868caf858SIrina Tirdea }
125968caf858SIrina Tirdea 
1260ae97fb58SJagan Teki static void goodix_disable_regulators(void *arg)
1261ae97fb58SJagan Teki {
1262ae97fb58SJagan Teki 	struct goodix_ts_data *ts = arg;
1263ae97fb58SJagan Teki 
1264ae97fb58SJagan Teki 	regulator_disable(ts->vddio);
1265ae97fb58SJagan Teki 	regulator_disable(ts->avdd28);
1266ae97fb58SJagan Teki }
1267ae97fb58SJagan Teki 
1268ca96ea86SBastien Nocera static int goodix_ts_probe(struct i2c_client *client,
1269ca96ea86SBastien Nocera 			   const struct i2c_device_id *id)
1270ca96ea86SBastien Nocera {
1271ca96ea86SBastien Nocera 	struct goodix_ts_data *ts;
127220e31722SHans de Goede 	const char *cfg_name;
1273ca96ea86SBastien Nocera 	int error;
1274ca96ea86SBastien Nocera 
1275ca96ea86SBastien Nocera 	dev_dbg(&client->dev, "I2C Address: 0x%02x\n", client->addr);
1276ca96ea86SBastien Nocera 
1277ca96ea86SBastien Nocera 	if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
1278ca96ea86SBastien Nocera 		dev_err(&client->dev, "I2C check functionality failed.\n");
1279ca96ea86SBastien Nocera 		return -ENXIO;
1280ca96ea86SBastien Nocera 	}
1281ca96ea86SBastien Nocera 
1282ca96ea86SBastien Nocera 	ts = devm_kzalloc(&client->dev, sizeof(*ts), GFP_KERNEL);
1283ca96ea86SBastien Nocera 	if (!ts)
1284ca96ea86SBastien Nocera 		return -ENOMEM;
1285ca96ea86SBastien Nocera 
1286ca96ea86SBastien Nocera 	ts->client = client;
1287ca96ea86SBastien Nocera 	i2c_set_clientdata(client, ts);
128868caf858SIrina Tirdea 	init_completion(&ts->firmware_loading_complete);
1289bd3b8480SYauhen Kharuzhy 	ts->contact_size = GOODIX_CONTACT_SIZE;
1290ca96ea86SBastien Nocera 
1291ec6e1b40SIrina Tirdea 	error = goodix_get_gpio_config(ts);
1292ec6e1b40SIrina Tirdea 	if (error)
1293ec6e1b40SIrina Tirdea 		return error;
1294ec6e1b40SIrina Tirdea 
1295ae97fb58SJagan Teki 	/* power up the controller */
1296ae97fb58SJagan Teki 	error = regulator_enable(ts->avdd28);
1297ae97fb58SJagan Teki 	if (error) {
1298ae97fb58SJagan Teki 		dev_err(&client->dev,
1299ae97fb58SJagan Teki 			"Failed to enable AVDD28 regulator: %d\n",
1300ae97fb58SJagan Teki 			error);
1301ae97fb58SJagan Teki 		return error;
1302ae97fb58SJagan Teki 	}
1303ae97fb58SJagan Teki 
1304ae97fb58SJagan Teki 	error = regulator_enable(ts->vddio);
1305ae97fb58SJagan Teki 	if (error) {
1306ae97fb58SJagan Teki 		dev_err(&client->dev,
1307ae97fb58SJagan Teki 			"Failed to enable VDDIO regulator: %d\n",
1308ae97fb58SJagan Teki 			error);
1309ae97fb58SJagan Teki 		regulator_disable(ts->avdd28);
1310ae97fb58SJagan Teki 		return error;
1311ae97fb58SJagan Teki 	}
1312ae97fb58SJagan Teki 
1313ae97fb58SJagan Teki 	error = devm_add_action_or_reset(&client->dev,
1314ae97fb58SJagan Teki 					 goodix_disable_regulators, ts);
1315ae97fb58SJagan Teki 	if (error)
1316ae97fb58SJagan Teki 		return error;
1317ae97fb58SJagan Teki 
13189e1f2d70SHans de Goede reset:
13191921daceSHans de Goede 	if (ts->reset_controller_at_probe) {
1320ec6e1b40SIrina Tirdea 		/* reset the controller */
1321ec6e1b40SIrina Tirdea 		error = goodix_reset(ts);
1322209bda47SHans de Goede 		if (error)
1323ec6e1b40SIrina Tirdea 			return error;
1324ec6e1b40SIrina Tirdea 	}
1325ec6e1b40SIrina Tirdea 
1326ca96ea86SBastien Nocera 	error = goodix_i2c_test(client);
1327ca96ea86SBastien Nocera 	if (error) {
13289e1f2d70SHans de Goede 		if (!ts->reset_controller_at_probe &&
13299e1f2d70SHans de Goede 		    ts->irq_pin_access_method != IRQ_PIN_ACCESS_NONE) {
13309e1f2d70SHans de Goede 			/* Retry after a controller reset */
13319e1f2d70SHans de Goede 			ts->reset_controller_at_probe = true;
13329e1f2d70SHans de Goede 			goto reset;
13339e1f2d70SHans de Goede 		}
1334ca96ea86SBastien Nocera 		dev_err(&client->dev, "I2C communication failure: %d\n", error);
1335ca96ea86SBastien Nocera 		return error;
1336ca96ea86SBastien Nocera 	}
1337ca96ea86SBastien Nocera 
133809182ed2SHans de Goede 	error = goodix_firmware_check(ts);
133909182ed2SHans de Goede 	if (error)
134009182ed2SHans de Goede 		return error;
134109182ed2SHans de Goede 
134268caf858SIrina Tirdea 	error = goodix_read_version(ts);
13437642f29cSHans de Goede 	if (error)
1344ca96ea86SBastien Nocera 		return error;
1345ca96ea86SBastien Nocera 
134625309004SMarcin Niestroj 	ts->chip = goodix_get_chip_data(ts->id);
1347a779fbc6SIrina Tirdea 
1348e070a97bSHans de Goede 	if (ts->load_cfg_from_disk) {
134968caf858SIrina Tirdea 		/* update device config */
135020e31722SHans de Goede 		error = device_property_read_string(&client->dev,
135120e31722SHans de Goede 						    "goodix,config-name",
135220e31722SHans de Goede 						    &cfg_name);
135320e31722SHans de Goede 		if (!error)
135420e31722SHans de Goede 			snprintf(ts->cfg_name, sizeof(ts->cfg_name),
135520e31722SHans de Goede 				 "goodix/%s", cfg_name);
135620e31722SHans de Goede 		else
135720e31722SHans de Goede 			snprintf(ts->cfg_name, sizeof(ts->cfg_name),
1358cae102e2SIcenowy Zheng 				 "goodix_%s_cfg.bin", ts->id);
1359ca96ea86SBastien Nocera 
136068caf858SIrina Tirdea 		error = request_firmware_nowait(THIS_MODULE, true, ts->cfg_name,
136168caf858SIrina Tirdea 						&client->dev, GFP_KERNEL, ts,
136268caf858SIrina Tirdea 						goodix_config_cb);
1363ca96ea86SBastien Nocera 		if (error) {
136468caf858SIrina Tirdea 			dev_err(&client->dev,
136568caf858SIrina Tirdea 				"Failed to invoke firmware loader: %d\n",
136668caf858SIrina Tirdea 				error);
1367ca96ea86SBastien Nocera 			return error;
1368ca96ea86SBastien Nocera 		}
1369ca96ea86SBastien Nocera 
1370ca96ea86SBastien Nocera 		return 0;
137168caf858SIrina Tirdea 	} else {
137268caf858SIrina Tirdea 		error = goodix_configure_dev(ts);
137368caf858SIrina Tirdea 		if (error)
137468caf858SIrina Tirdea 			return error;
137568caf858SIrina Tirdea 	}
137668caf858SIrina Tirdea 
137768caf858SIrina Tirdea 	return 0;
137868caf858SIrina Tirdea }
137968caf858SIrina Tirdea 
138068caf858SIrina Tirdea static int goodix_ts_remove(struct i2c_client *client)
138168caf858SIrina Tirdea {
138268caf858SIrina Tirdea 	struct goodix_ts_data *ts = i2c_get_clientdata(client);
138368caf858SIrina Tirdea 
1384e070a97bSHans de Goede 	if (ts->load_cfg_from_disk)
138568caf858SIrina Tirdea 		wait_for_completion(&ts->firmware_loading_complete);
138668caf858SIrina Tirdea 
138768caf858SIrina Tirdea 	return 0;
1388ca96ea86SBastien Nocera }
1389ca96ea86SBastien Nocera 
13905ab09d6aSIrina Tirdea static int __maybe_unused goodix_suspend(struct device *dev)
13915ab09d6aSIrina Tirdea {
13925ab09d6aSIrina Tirdea 	struct i2c_client *client = to_i2c_client(dev);
13935ab09d6aSIrina Tirdea 	struct goodix_ts_data *ts = i2c_get_clientdata(client);
13945ab09d6aSIrina Tirdea 	int error;
13955ab09d6aSIrina Tirdea 
1396e070a97bSHans de Goede 	if (ts->load_cfg_from_disk)
1397e070a97bSHans de Goede 		wait_for_completion(&ts->firmware_loading_complete);
1398e070a97bSHans de Goede 
13995ab09d6aSIrina Tirdea 	/* We need gpio pins to suspend/resume */
140049db3997SHans de Goede 	if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) {
1401faec44b6SHans de Goede 		disable_irq(client->irq);
14025ab09d6aSIrina Tirdea 		return 0;
1403faec44b6SHans de Goede 	}
14045ab09d6aSIrina Tirdea 
14055ab09d6aSIrina Tirdea 	/* Free IRQ as IRQ pin is used as output in the suspend sequence */
14065ab09d6aSIrina Tirdea 	goodix_free_irq(ts);
14075ab09d6aSIrina Tirdea 
140809182ed2SHans de Goede 	/* Save reference (calibration) info if necessary */
140909182ed2SHans de Goede 	goodix_save_bak_ref(ts);
141009182ed2SHans de Goede 
14115ab09d6aSIrina Tirdea 	/* Output LOW on the INT pin for 5 ms */
141249db3997SHans de Goede 	error = goodix_irq_direction_output(ts, 0);
14135ab09d6aSIrina Tirdea 	if (error) {
14145ab09d6aSIrina Tirdea 		goodix_request_irq(ts);
14155ab09d6aSIrina Tirdea 		return error;
14165ab09d6aSIrina Tirdea 	}
14175ab09d6aSIrina Tirdea 
14185ab09d6aSIrina Tirdea 	usleep_range(5000, 6000);
14195ab09d6aSIrina Tirdea 
14205ab09d6aSIrina Tirdea 	error = goodix_i2c_write_u8(ts->client, GOODIX_REG_COMMAND,
14215ab09d6aSIrina Tirdea 				    GOODIX_CMD_SCREEN_OFF);
14225ab09d6aSIrina Tirdea 	if (error) {
142349db3997SHans de Goede 		goodix_irq_direction_input(ts);
14245ab09d6aSIrina Tirdea 		goodix_request_irq(ts);
14255ab09d6aSIrina Tirdea 		return -EAGAIN;
14265ab09d6aSIrina Tirdea 	}
14275ab09d6aSIrina Tirdea 
14285ab09d6aSIrina Tirdea 	/*
14295ab09d6aSIrina Tirdea 	 * The datasheet specifies that the interval between sending screen-off
14305ab09d6aSIrina Tirdea 	 * command and wake-up should be longer than 58 ms. To avoid waking up
14315ab09d6aSIrina Tirdea 	 * sooner, delay 58ms here.
14325ab09d6aSIrina Tirdea 	 */
14335ab09d6aSIrina Tirdea 	msleep(58);
14345ab09d6aSIrina Tirdea 	return 0;
14355ab09d6aSIrina Tirdea }
14365ab09d6aSIrina Tirdea 
14375ab09d6aSIrina Tirdea static int __maybe_unused goodix_resume(struct device *dev)
14385ab09d6aSIrina Tirdea {
14395ab09d6aSIrina Tirdea 	struct i2c_client *client = to_i2c_client(dev);
14405ab09d6aSIrina Tirdea 	struct goodix_ts_data *ts = i2c_get_clientdata(client);
1441273ec6bdSHans de Goede 	u8 config_ver;
14425ab09d6aSIrina Tirdea 	int error;
14435ab09d6aSIrina Tirdea 
144449db3997SHans de Goede 	if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) {
1445faec44b6SHans de Goede 		enable_irq(client->irq);
14465ab09d6aSIrina Tirdea 		return 0;
1447faec44b6SHans de Goede 	}
14485ab09d6aSIrina Tirdea 
14495ab09d6aSIrina Tirdea 	/*
14505ab09d6aSIrina Tirdea 	 * Exit sleep mode by outputting HIGH level to INT pin
14515ab09d6aSIrina Tirdea 	 * for 2ms~5ms.
14525ab09d6aSIrina Tirdea 	 */
145349db3997SHans de Goede 	error = goodix_irq_direction_output(ts, 1);
14545ab09d6aSIrina Tirdea 	if (error)
14555ab09d6aSIrina Tirdea 		return error;
14565ab09d6aSIrina Tirdea 
14575ab09d6aSIrina Tirdea 	usleep_range(2000, 5000);
14585ab09d6aSIrina Tirdea 
14595ab09d6aSIrina Tirdea 	error = goodix_int_sync(ts);
14605ab09d6aSIrina Tirdea 	if (error)
14615ab09d6aSIrina Tirdea 		return error;
14625ab09d6aSIrina Tirdea 
1463273ec6bdSHans de Goede 	error = goodix_i2c_read(ts->client, ts->chip->config_addr,
1464273ec6bdSHans de Goede 				&config_ver, 1);
14657642f29cSHans de Goede 	if (!error && config_ver != ts->config[0])
1466273ec6bdSHans de Goede 		dev_info(dev, "Config version mismatch %d != %d, resetting controller\n",
1467273ec6bdSHans de Goede 			 config_ver, ts->config[0]);
1468273ec6bdSHans de Goede 
1469273ec6bdSHans de Goede 	if (error != 0 || config_ver != ts->config[0]) {
1470273ec6bdSHans de Goede 		error = goodix_reset(ts);
1471209bda47SHans de Goede 		if (error)
1472273ec6bdSHans de Goede 			return error;
1473273ec6bdSHans de Goede 
1474273ec6bdSHans de Goede 		error = goodix_send_cfg(ts, ts->config, ts->chip->config_len);
1475273ec6bdSHans de Goede 		if (error)
1476273ec6bdSHans de Goede 			return error;
1477273ec6bdSHans de Goede 	}
1478273ec6bdSHans de Goede 
14795ab09d6aSIrina Tirdea 	error = goodix_request_irq(ts);
14805ab09d6aSIrina Tirdea 	if (error)
14815ab09d6aSIrina Tirdea 		return error;
14825ab09d6aSIrina Tirdea 
14835ab09d6aSIrina Tirdea 	return 0;
14845ab09d6aSIrina Tirdea }
14855ab09d6aSIrina Tirdea 
14865ab09d6aSIrina Tirdea static SIMPLE_DEV_PM_OPS(goodix_pm_ops, goodix_suspend, goodix_resume);
14875ab09d6aSIrina Tirdea 
1488ca96ea86SBastien Nocera static const struct i2c_device_id goodix_ts_id[] = {
1489ca96ea86SBastien Nocera 	{ "GDIX1001:00", 0 },
1490ca96ea86SBastien Nocera 	{ }
1491ca96ea86SBastien Nocera };
14922e9e910eSJavier Martinez Canillas MODULE_DEVICE_TABLE(i2c, goodix_ts_id);
1493ca96ea86SBastien Nocera 
1494771d8f1bSAleksei Mamlin #ifdef CONFIG_ACPI
1495ca96ea86SBastien Nocera static const struct acpi_device_id goodix_acpi_match[] = {
1496ca96ea86SBastien Nocera 	{ "GDIX1001", 0 },
14975ca4d1aeSEthan Lee 	{ "GDIX1002", 0 },
1498ca96ea86SBastien Nocera 	{ }
1499ca96ea86SBastien Nocera };
1500ca96ea86SBastien Nocera MODULE_DEVICE_TABLE(acpi, goodix_acpi_match);
1501771d8f1bSAleksei Mamlin #endif
1502771d8f1bSAleksei Mamlin 
1503771d8f1bSAleksei Mamlin #ifdef CONFIG_OF
1504771d8f1bSAleksei Mamlin static const struct of_device_id goodix_of_match[] = {
150525309004SMarcin Niestroj 	{ .compatible = "goodix,gt1151" },
1506a5f50c50SJagan Teki 	{ .compatible = "goodix,gt5663" },
150784ef1b33SGuido Günther 	{ .compatible = "goodix,gt5688" },
1508771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt911" },
1509771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt9110" },
1510771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt912" },
1511b9a1c116SYannick Fertre 	{ .compatible = "goodix,gt9147" },
1512b5e458afSIcenowy Zheng 	{ .compatible = "goodix,gt917s" },
1513771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt927" },
1514771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt9271" },
1515771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt928" },
15162dce6db7SAngeloGioacchino Del Regno 	{ .compatible = "goodix,gt9286" },
1517771d8f1bSAleksei Mamlin 	{ .compatible = "goodix,gt967" },
1518771d8f1bSAleksei Mamlin 	{ }
1519771d8f1bSAleksei Mamlin };
1520771d8f1bSAleksei Mamlin MODULE_DEVICE_TABLE(of, goodix_of_match);
1521771d8f1bSAleksei Mamlin #endif
1522ca96ea86SBastien Nocera 
1523ca96ea86SBastien Nocera static struct i2c_driver goodix_ts_driver = {
1524ca96ea86SBastien Nocera 	.probe = goodix_ts_probe,
152568caf858SIrina Tirdea 	.remove = goodix_ts_remove,
1526ca96ea86SBastien Nocera 	.id_table = goodix_ts_id,
1527ca96ea86SBastien Nocera 	.driver = {
1528ca96ea86SBastien Nocera 		.name = "Goodix-TS",
1529771d8f1bSAleksei Mamlin 		.acpi_match_table = ACPI_PTR(goodix_acpi_match),
1530771d8f1bSAleksei Mamlin 		.of_match_table = of_match_ptr(goodix_of_match),
15315ab09d6aSIrina Tirdea 		.pm = &goodix_pm_ops,
1532ca96ea86SBastien Nocera 	},
1533ca96ea86SBastien Nocera };
1534ca96ea86SBastien Nocera module_i2c_driver(goodix_ts_driver);
1535ca96ea86SBastien Nocera 
1536ca96ea86SBastien Nocera MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
1537ca96ea86SBastien Nocera MODULE_AUTHOR("Bastien Nocera <hadess@hadess.net>");
1538ca96ea86SBastien Nocera MODULE_DESCRIPTION("Goodix touchscreen driver");
1539ca96ea86SBastien Nocera MODULE_LICENSE("GPL v2");
1540