xref: /linux/drivers/input/touchscreen/edt-ft5x06.c (revision ffd01c3bcc1af4d8c3e7949152af0d9fe3d1fda5)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (C) 2012 Simon Budig, <simon.budig@kernelconcepts.de>
4  * Daniel Wagener <daniel.wagener@kernelconcepts.de> (M09 firmware support)
5  * Lothar Waßmann <LW@KARO-electronics.de> (DT support)
6  * Dario Binacchi <dario.binacchi@amarulasolutions.com> (regmap support)
7  */
8 
9 /*
10  * This is a driver for the EDT "Polytouch" family of touch controllers
11  * based on the FocalTech FT5x06 line of chips.
12  *
13  * Development of this driver has been sponsored by Glyn:
14  *    http://www.glyn.com/Products/Displays
15  */
16 
17 #include <linux/debugfs.h>
18 #include <linux/delay.h>
19 #include <linux/gpio/consumer.h>
20 #include <linux/i2c.h>
21 #include <linux/interrupt.h>
22 #include <linux/input.h>
23 #include <linux/input/mt.h>
24 #include <linux/input/touchscreen.h>
25 #include <linux/irq.h>
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/property.h>
29 #include <linux/ratelimit.h>
30 #include <linux/regmap.h>
31 #include <linux/regulator/consumer.h>
32 #include <linux/slab.h>
33 #include <linux/uaccess.h>
34 
35 #include <linux/unaligned.h>
36 
37 #define WORK_REGISTER_THRESHOLD		0x00
38 #define WORK_REGISTER_REPORT_RATE	0x08
39 #define WORK_REGISTER_GAIN		0x30
40 #define WORK_REGISTER_OFFSET		0x31
41 #define WORK_REGISTER_NUM_X		0x33
42 #define WORK_REGISTER_NUM_Y		0x34
43 
44 #define PMOD_REGISTER_ACTIVE		0x00
45 #define PMOD_REGISTER_HIBERNATE		0x03
46 
47 #define M09_REGISTER_THRESHOLD		0x80
48 #define M09_REGISTER_GAIN		0x92
49 #define M09_REGISTER_OFFSET		0x93
50 #define M09_REGISTER_NUM_X		0x94
51 #define M09_REGISTER_NUM_Y		0x95
52 
53 #define M12_REGISTER_REPORT_RATE	0x88
54 
55 #define EV_REGISTER_THRESHOLD		0x40
56 #define EV_REGISTER_GAIN		0x41
57 #define EV_REGISTER_OFFSET_Y		0x45
58 #define EV_REGISTER_OFFSET_X		0x46
59 
60 #define NO_REGISTER			0xff
61 
62 #define WORK_REGISTER_OPMODE		0x3c
63 #define FACTORY_REGISTER_OPMODE		0x01
64 #define PMOD_REGISTER_OPMODE		0xa5
65 
66 #define TOUCH_EVENT_DOWN		0x00
67 #define TOUCH_EVENT_UP			0x01
68 #define TOUCH_EVENT_ON			0x02
69 #define TOUCH_EVENT_RESERVED		0x03
70 
71 #define EDT_NAME_LEN			23
72 #define EDT_SWITCH_MODE_RETRIES		10
73 #define EDT_SWITCH_MODE_DELAY		5 /* msec */
74 #define EDT_RAW_DATA_RETRIES		100
75 #define EDT_RAW_DATA_DELAY		1000 /* usec */
76 
77 #define EDT_DEFAULT_NUM_X		1024
78 #define EDT_DEFAULT_NUM_Y		1024
79 
80 #define M06_REG_CMD(factory) ((factory) ? 0xf3 : 0xfc)
81 #define M06_REG_ADDR(factory, addr) ((factory) ? (addr) & 0x7f : (addr) & 0x3f)
82 
83 enum edt_pmode {
84 	EDT_PMODE_NOT_SUPPORTED,
85 	EDT_PMODE_HIBERNATE,
86 	EDT_PMODE_POWEROFF,
87 };
88 
89 enum edt_ver {
90 	EDT_M06,
91 	EDT_M09,
92 	EDT_M12,
93 	EV_FT,
94 	GENERIC_FT,
95 };
96 
97 struct edt_reg_addr {
98 	int reg_threshold;
99 	int reg_report_rate;
100 	int reg_gain;
101 	int reg_offset;
102 	int reg_offset_x;
103 	int reg_offset_y;
104 	int reg_num_x;
105 	int reg_num_y;
106 };
107 
108 struct edt_ft5x06_ts_data {
109 	struct i2c_client *client;
110 	struct input_dev *input;
111 	struct touchscreen_properties prop;
112 	u16 num_x;
113 	u16 num_y;
114 	struct regulator *vcc;
115 	struct regulator *iovcc;
116 
117 	struct gpio_desc *reset_gpio;
118 	struct gpio_desc *wake_gpio;
119 
120 	struct regmap *regmap;
121 
122 #if defined(CONFIG_DEBUG_FS)
123 	u8 *raw_buffer;
124 	size_t raw_bufsize;
125 #endif
126 
127 	struct mutex mutex;
128 	bool factory_mode;
129 	enum edt_pmode suspend_mode;
130 	int threshold;
131 	int gain;
132 	int offset;
133 	int offset_x;
134 	int offset_y;
135 	int report_rate;
136 	int max_support_points;
137 	int point_len;
138 	u8 tdata_cmd;
139 	int tdata_len;
140 	int tdata_offset;
141 
142 	char name[EDT_NAME_LEN];
143 	char fw_version[EDT_NAME_LEN];
144 
145 	struct edt_reg_addr reg_addr;
146 	enum edt_ver version;
147 	unsigned int crc_errors;
148 	unsigned int header_errors;
149 };
150 
151 struct edt_i2c_chip_data {
152 	int  max_support_points;
153 };
154 
155 static const struct regmap_config edt_ft5x06_i2c_regmap_config = {
156 	.reg_bits = 8,
157 	.val_bits = 8,
158 };
159 
160 static bool edt_ft5x06_ts_check_crc(struct edt_ft5x06_ts_data *tsdata,
161 				    u8 *buf, int buflen)
162 {
163 	int i;
164 	u8 crc = 0;
165 
166 	for (i = 0; i < buflen - 1; i++)
167 		crc ^= buf[i];
168 
169 	if (crc != buf[buflen - 1]) {
170 		tsdata->crc_errors++;
171 		dev_err_ratelimited(&tsdata->client->dev,
172 				    "crc error: 0x%02x expected, got 0x%02x\n",
173 				    crc, buf[buflen - 1]);
174 		return false;
175 	}
176 
177 	return true;
178 }
179 
180 static int edt_M06_i2c_read(void *context, const void *reg_buf, size_t reg_size,
181 			    void *val_buf, size_t val_size)
182 {
183 	struct device *dev = context;
184 	struct i2c_client *i2c = to_i2c_client(dev);
185 	struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(i2c);
186 	struct i2c_msg xfer[2];
187 	bool reg_read = false;
188 	u8 addr;
189 	u8 wlen;
190 	u8 wbuf[4], rbuf[3];
191 	int ret;
192 
193 	addr = *((u8 *)reg_buf);
194 	wbuf[0] = addr;
195 	switch (addr) {
196 	case 0xf5:
197 		wlen = 3;
198 		wbuf[0] = 0xf5;
199 		wbuf[1] = 0xe;
200 		wbuf[2] = *((u8 *)val_buf);
201 		break;
202 	case 0xf9:
203 		wlen = 1;
204 		break;
205 	default:
206 		wlen = 2;
207 		reg_read = true;
208 		wbuf[0] = M06_REG_CMD(tsdata->factory_mode);
209 		wbuf[1] = M06_REG_ADDR(tsdata->factory_mode, addr);
210 		wbuf[1] |= tsdata->factory_mode ? 0x80 : 0x40;
211 	}
212 
213 	xfer[0].addr  = i2c->addr;
214 	xfer[0].flags = 0;
215 	xfer[0].len = wlen;
216 	xfer[0].buf = wbuf;
217 
218 	xfer[1].addr = i2c->addr;
219 	xfer[1].flags = I2C_M_RD;
220 	xfer[1].len = reg_read ? 2 : val_size;
221 	xfer[1].buf = reg_read ? rbuf : val_buf;
222 
223 	ret = i2c_transfer(i2c->adapter, xfer, 2);
224 	if (ret != 2) {
225 		if (ret < 0)
226 			return ret;
227 
228 		return -EIO;
229 	}
230 
231 	if (addr == 0xf9) {
232 		u8 *buf = (u8 *)val_buf;
233 
234 		if (buf[0] != 0xaa || buf[1] != 0xaa ||
235 		    buf[2] != val_size) {
236 			tsdata->header_errors++;
237 			dev_err_ratelimited(dev,
238 					    "Unexpected header: %02x%02x%02x\n",
239 					    buf[0], buf[1], buf[2]);
240 			return -EIO;
241 		}
242 
243 		if (!edt_ft5x06_ts_check_crc(tsdata, val_buf, val_size))
244 			return -EIO;
245 	} else if (reg_read) {
246 		wbuf[2] = rbuf[0];
247 		wbuf[3] = rbuf[1];
248 		if (!edt_ft5x06_ts_check_crc(tsdata, wbuf, 4))
249 			return -EIO;
250 
251 		*((u8 *)val_buf) = rbuf[0];
252 	}
253 
254 	return 0;
255 }
256 
257 static int edt_M06_i2c_write(void *context, const void *data, size_t count)
258 {
259 	struct device *dev = context;
260 	struct i2c_client *i2c = to_i2c_client(dev);
261 	struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(i2c);
262 	u8 addr, val;
263 	u8 wbuf[4];
264 	struct i2c_msg xfer;
265 	int ret;
266 
267 	addr = *((u8 *)data);
268 	val = *((u8 *)data + 1);
269 
270 	wbuf[0] = M06_REG_CMD(tsdata->factory_mode);
271 	wbuf[1] = M06_REG_ADDR(tsdata->factory_mode, addr);
272 	wbuf[2] = val;
273 	wbuf[3] = wbuf[0] ^ wbuf[1] ^ wbuf[2];
274 
275 	xfer.addr  = i2c->addr;
276 	xfer.flags = 0;
277 	xfer.len = 4;
278 	xfer.buf = wbuf;
279 
280 	ret = i2c_transfer(i2c->adapter, &xfer, 1);
281 	if (ret != 1) {
282 		if (ret < 0)
283 			return ret;
284 
285 		return -EIO;
286 	}
287 
288 	return 0;
289 }
290 
291 static const struct regmap_config edt_M06_i2c_regmap_config = {
292 	.reg_bits = 8,
293 	.val_bits = 8,
294 	.read = edt_M06_i2c_read,
295 	.write = edt_M06_i2c_write,
296 };
297 
298 static irqreturn_t edt_ft5x06_ts_isr(int irq, void *dev_id)
299 {
300 	struct edt_ft5x06_ts_data *tsdata = dev_id;
301 	struct device *dev = &tsdata->client->dev;
302 	u8 rdbuf[63];
303 	int i, type, x, y, id;
304 	int error;
305 
306 	memset(rdbuf, 0, sizeof(rdbuf));
307 	error = regmap_bulk_read(tsdata->regmap, tsdata->tdata_cmd, rdbuf,
308 				 tsdata->tdata_len);
309 	if (error) {
310 		dev_err_ratelimited(dev, "Unable to fetch data, error: %d\n",
311 				    error);
312 		goto out;
313 	}
314 
315 	for (i = 0; i < tsdata->max_support_points; i++) {
316 		u8 *buf = &rdbuf[i * tsdata->point_len + tsdata->tdata_offset];
317 
318 		type = buf[0] >> 6;
319 		/* ignore Reserved events */
320 		if (type == TOUCH_EVENT_RESERVED)
321 			continue;
322 
323 		/* M06 sometimes sends bogus coordinates in TOUCH_DOWN */
324 		if (tsdata->version == EDT_M06 && type == TOUCH_EVENT_DOWN)
325 			continue;
326 
327 		x = get_unaligned_be16(buf) & 0x0fff;
328 		y = get_unaligned_be16(buf + 2) & 0x0fff;
329 		/* The FT5x26 send the y coordinate first */
330 		if (tsdata->version == EV_FT)
331 			swap(x, y);
332 
333 		id = (buf[2] >> 4) & 0x0f;
334 
335 		input_mt_slot(tsdata->input, id);
336 		if (input_mt_report_slot_state(tsdata->input, MT_TOOL_FINGER,
337 					       type != TOUCH_EVENT_UP))
338 			touchscreen_report_pos(tsdata->input, &tsdata->prop,
339 					       x, y, true);
340 	}
341 
342 	input_mt_report_pointer_emulation(tsdata->input, true);
343 	input_sync(tsdata->input);
344 
345 out:
346 	return IRQ_HANDLED;
347 }
348 
349 struct edt_ft5x06_attribute {
350 	struct device_attribute dattr;
351 	size_t field_offset;
352 	u8 limit_low;
353 	u8 limit_high;
354 	u8 addr_m06;
355 	u8 addr_m09;
356 	u8 addr_ev;
357 };
358 
359 #define EDT_ATTR(_field, _mode, _addr_m06, _addr_m09, _addr_ev,		\
360 		_limit_low, _limit_high)				\
361 	struct edt_ft5x06_attribute edt_ft5x06_attr_##_field = {	\
362 		.dattr = __ATTR(_field, _mode,				\
363 				edt_ft5x06_setting_show,		\
364 				edt_ft5x06_setting_store),		\
365 		.field_offset = offsetof(struct edt_ft5x06_ts_data, _field), \
366 		.addr_m06 = _addr_m06,					\
367 		.addr_m09 = _addr_m09,					\
368 		.addr_ev  = _addr_ev,					\
369 		.limit_low = _limit_low,				\
370 		.limit_high = _limit_high,				\
371 	}
372 
373 static ssize_t edt_ft5x06_setting_show(struct device *dev,
374 				       struct device_attribute *dattr,
375 				       char *buf)
376 {
377 	struct i2c_client *client = to_i2c_client(dev);
378 	struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
379 	struct edt_ft5x06_attribute *attr =
380 			container_of(dattr, struct edt_ft5x06_attribute, dattr);
381 	u8 *field = (u8 *)tsdata + attr->field_offset;
382 	unsigned int val;
383 	int error;
384 	u8 addr;
385 
386 	guard(mutex)(&tsdata->mutex);
387 
388 	if (tsdata->factory_mode)
389 		return -EIO;
390 
391 	switch (tsdata->version) {
392 	case EDT_M06:
393 		addr = attr->addr_m06;
394 		break;
395 
396 	case EDT_M09:
397 	case EDT_M12:
398 	case GENERIC_FT:
399 		addr = attr->addr_m09;
400 		break;
401 
402 	case EV_FT:
403 		addr = attr->addr_ev;
404 		break;
405 
406 	default:
407 		return -ENODEV;
408 	}
409 
410 	if (addr != NO_REGISTER) {
411 		error = regmap_read(tsdata->regmap, addr, &val);
412 		if (error) {
413 			dev_err(&tsdata->client->dev,
414 				"Failed to fetch attribute %s, error %d\n",
415 				dattr->attr.name, error);
416 			return error;
417 		}
418 	} else {
419 		val = *field;
420 	}
421 
422 	if (val != *field) {
423 		dev_warn(&tsdata->client->dev,
424 			 "%s: read (%d) and stored value (%d) differ\n",
425 			 dattr->attr.name, val, *field);
426 		*field = val;
427 	}
428 
429 	return sysfs_emit(buf, "%d\n", val);
430 }
431 
432 static ssize_t edt_ft5x06_setting_store(struct device *dev,
433 					struct device_attribute *dattr,
434 					const char *buf, size_t count)
435 {
436 	struct i2c_client *client = to_i2c_client(dev);
437 	struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
438 	struct edt_ft5x06_attribute *attr =
439 			container_of(dattr, struct edt_ft5x06_attribute, dattr);
440 	u8 *field = (u8 *)tsdata + attr->field_offset;
441 	unsigned int val;
442 	int error;
443 	u8 addr;
444 
445 	guard(mutex)(&tsdata->mutex);
446 
447 	if (tsdata->factory_mode)
448 		return -EIO;
449 
450 	error = kstrtouint(buf, 0, &val);
451 	if (error)
452 		return error;
453 
454 	if (val < attr->limit_low || val > attr->limit_high)
455 		return -ERANGE;
456 
457 	switch (tsdata->version) {
458 	case EDT_M06:
459 		addr = attr->addr_m06;
460 		break;
461 
462 	case EDT_M09:
463 	case EDT_M12:
464 	case GENERIC_FT:
465 		addr = attr->addr_m09;
466 		break;
467 
468 	case EV_FT:
469 		addr = attr->addr_ev;
470 		break;
471 
472 	default:
473 		return -ENODEV;
474 	}
475 
476 	if (addr != NO_REGISTER) {
477 		error = regmap_write(tsdata->regmap, addr, val);
478 		if (error) {
479 			dev_err(&tsdata->client->dev,
480 				"Failed to update attribute %s, error: %d\n",
481 				dattr->attr.name, error);
482 			return error;
483 		}
484 	}
485 	*field = val;
486 
487 	return count;
488 }
489 
490 /* m06, m09: range 0-31, m12: range 0-5 */
491 static EDT_ATTR(gain, S_IWUSR | S_IRUGO, WORK_REGISTER_GAIN,
492 		M09_REGISTER_GAIN, EV_REGISTER_GAIN, 0, 31);
493 /* m06, m09: range 0-31, m12: range 0-16 */
494 static EDT_ATTR(offset, S_IWUSR | S_IRUGO, WORK_REGISTER_OFFSET,
495 		M09_REGISTER_OFFSET, NO_REGISTER, 0, 31);
496 /* m06, m09, m12: no supported, ev_ft: range 0-80 */
497 static EDT_ATTR(offset_x, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
498 		EV_REGISTER_OFFSET_X, 0, 80);
499 /* m06, m09, m12: no supported, ev_ft: range 0-80 */
500 static EDT_ATTR(offset_y, S_IWUSR | S_IRUGO, NO_REGISTER, NO_REGISTER,
501 		EV_REGISTER_OFFSET_Y, 0, 80);
502 /* m06: range 20 to 80, m09: range 0 to 30, m12: range 1 to 255... */
503 static EDT_ATTR(threshold, S_IWUSR | S_IRUGO, WORK_REGISTER_THRESHOLD,
504 		M09_REGISTER_THRESHOLD, EV_REGISTER_THRESHOLD, 0, 255);
505 /* m06: range 3 to 14, m12: range 1 to 255 */
506 static EDT_ATTR(report_rate, S_IWUSR | S_IRUGO, WORK_REGISTER_REPORT_RATE,
507 		M12_REGISTER_REPORT_RATE, NO_REGISTER, 0, 255);
508 
509 static ssize_t model_show(struct device *dev, struct device_attribute *attr,
510 			  char *buf)
511 {
512 	struct i2c_client *client = to_i2c_client(dev);
513 	struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
514 
515 	return sysfs_emit(buf, "%s\n", tsdata->name);
516 }
517 
518 static DEVICE_ATTR_RO(model);
519 
520 static ssize_t fw_version_show(struct device *dev,
521 			       struct device_attribute *attr, char *buf)
522 {
523 	struct i2c_client *client = to_i2c_client(dev);
524 	struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
525 
526 	return sysfs_emit(buf, "%s\n", tsdata->fw_version);
527 }
528 
529 static DEVICE_ATTR_RO(fw_version);
530 
531 /* m06 only */
532 static ssize_t header_errors_show(struct device *dev,
533 				  struct device_attribute *attr, char *buf)
534 {
535 	struct i2c_client *client = to_i2c_client(dev);
536 	struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
537 
538 	return sysfs_emit(buf, "%d\n", tsdata->header_errors);
539 }
540 
541 static DEVICE_ATTR_RO(header_errors);
542 
543 /* m06 only */
544 static ssize_t crc_errors_show(struct device *dev,
545 			       struct device_attribute *attr, char *buf)
546 {
547 	struct i2c_client *client = to_i2c_client(dev);
548 	struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
549 
550 	return sysfs_emit(buf, "%d\n", tsdata->crc_errors);
551 }
552 
553 static DEVICE_ATTR_RO(crc_errors);
554 
555 static struct attribute *edt_ft5x06_attrs[] = {
556 	&edt_ft5x06_attr_gain.dattr.attr,
557 	&edt_ft5x06_attr_offset.dattr.attr,
558 	&edt_ft5x06_attr_offset_x.dattr.attr,
559 	&edt_ft5x06_attr_offset_y.dattr.attr,
560 	&edt_ft5x06_attr_threshold.dattr.attr,
561 	&edt_ft5x06_attr_report_rate.dattr.attr,
562 	&dev_attr_model.attr,
563 	&dev_attr_fw_version.attr,
564 	&dev_attr_header_errors.attr,
565 	&dev_attr_crc_errors.attr,
566 	NULL
567 };
568 ATTRIBUTE_GROUPS(edt_ft5x06);
569 
570 static void edt_ft5x06_restore_reg_parameters(struct edt_ft5x06_ts_data *tsdata)
571 {
572 	struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
573 	struct regmap *regmap = tsdata->regmap;
574 
575 	regmap_write(regmap, reg_addr->reg_threshold, tsdata->threshold);
576 	regmap_write(regmap, reg_addr->reg_gain, tsdata->gain);
577 	if (reg_addr->reg_offset != NO_REGISTER)
578 		regmap_write(regmap, reg_addr->reg_offset, tsdata->offset);
579 	if (reg_addr->reg_offset_x != NO_REGISTER)
580 		regmap_write(regmap, reg_addr->reg_offset_x, tsdata->offset_x);
581 	if (reg_addr->reg_offset_y != NO_REGISTER)
582 		regmap_write(regmap, reg_addr->reg_offset_y, tsdata->offset_y);
583 	if (reg_addr->reg_report_rate != NO_REGISTER)
584 		regmap_write(regmap, reg_addr->reg_report_rate,
585 			     tsdata->report_rate);
586 }
587 
588 #ifdef CONFIG_DEBUG_FS
589 static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
590 {
591 	struct i2c_client *client = tsdata->client;
592 	int retries = EDT_SWITCH_MODE_RETRIES;
593 	unsigned int val;
594 	int error;
595 
596 	if (tsdata->version != EDT_M06) {
597 		dev_err(&client->dev,
598 			"No factory mode support for non-M06 devices\n");
599 		return -EINVAL;
600 	}
601 
602 	disable_irq(client->irq);
603 
604 	if (!tsdata->raw_buffer) {
605 		tsdata->raw_bufsize = tsdata->num_x * tsdata->num_y *
606 				      sizeof(u16);
607 		tsdata->raw_buffer = kzalloc(tsdata->raw_bufsize, GFP_KERNEL);
608 		if (!tsdata->raw_buffer) {
609 			error = -ENOMEM;
610 			goto err_out;
611 		}
612 	}
613 
614 	/* mode register is 0x3c when in the work mode */
615 	error = regmap_write(tsdata->regmap, WORK_REGISTER_OPMODE, 0x03);
616 	if (error) {
617 		dev_err(&client->dev,
618 			"failed to switch to factory mode, error %d\n", error);
619 		goto err_out;
620 	}
621 
622 	tsdata->factory_mode = true;
623 	do {
624 		mdelay(EDT_SWITCH_MODE_DELAY);
625 		/* mode register is 0x01 when in factory mode */
626 		error = regmap_read(tsdata->regmap, FACTORY_REGISTER_OPMODE,
627 				    &val);
628 		if (!error && val == 0x03)
629 			break;
630 	} while (--retries > 0);
631 
632 	if (retries == 0) {
633 		dev_err(&client->dev, "not in factory mode after %dms.\n",
634 			EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
635 		error = -EIO;
636 		goto err_out;
637 	}
638 
639 	return 0;
640 
641 err_out:
642 	kfree(tsdata->raw_buffer);
643 	tsdata->raw_buffer = NULL;
644 	tsdata->factory_mode = false;
645 	enable_irq(client->irq);
646 
647 	return error;
648 }
649 
650 static int edt_ft5x06_work_mode(struct edt_ft5x06_ts_data *tsdata)
651 {
652 	struct i2c_client *client = tsdata->client;
653 	int retries = EDT_SWITCH_MODE_RETRIES;
654 	unsigned int val;
655 	int error;
656 
657 	/* mode register is 0x01 when in the factory mode */
658 	error = regmap_write(tsdata->regmap, FACTORY_REGISTER_OPMODE, 0x1);
659 	if (error) {
660 		dev_err(&client->dev,
661 			"failed to switch to work mode, error: %d\n", error);
662 		return error;
663 	}
664 
665 	tsdata->factory_mode = false;
666 
667 	do {
668 		mdelay(EDT_SWITCH_MODE_DELAY);
669 		/* mode register is 0x01 when in factory mode */
670 		error = regmap_read(tsdata->regmap, WORK_REGISTER_OPMODE, &val);
671 		if (!error && val == 0x01)
672 			break;
673 	} while (--retries > 0);
674 
675 	if (retries == 0) {
676 		dev_err(&client->dev, "not in work mode after %dms.\n",
677 			EDT_SWITCH_MODE_RETRIES * EDT_SWITCH_MODE_DELAY);
678 		tsdata->factory_mode = true;
679 		return -EIO;
680 	}
681 
682 	kfree(tsdata->raw_buffer);
683 	tsdata->raw_buffer = NULL;
684 
685 	edt_ft5x06_restore_reg_parameters(tsdata);
686 	enable_irq(client->irq);
687 
688 	return 0;
689 }
690 
691 static int edt_ft5x06_debugfs_mode_get(void *data, u64 *mode)
692 {
693 	struct edt_ft5x06_ts_data *tsdata = data;
694 
695 	*mode = tsdata->factory_mode;
696 
697 	return 0;
698 };
699 
700 static int edt_ft5x06_debugfs_mode_set(void *data, u64 mode)
701 {
702 	struct edt_ft5x06_ts_data *tsdata = data;
703 
704 	if (mode > 1)
705 		return -ERANGE;
706 
707 	guard(mutex)(&tsdata->mutex);
708 
709 	if (mode == tsdata->factory_mode)
710 		return 0;
711 
712 	return mode ? edt_ft5x06_factory_mode(tsdata) :
713 		      edt_ft5x06_work_mode(tsdata);
714 };
715 
716 DEFINE_SIMPLE_ATTRIBUTE(debugfs_mode_fops, edt_ft5x06_debugfs_mode_get,
717 			edt_ft5x06_debugfs_mode_set, "%llu\n");
718 
719 static ssize_t edt_ft5x06_debugfs_raw_data_read(struct file *file,
720 						char __user *buf, size_t count,
721 						loff_t *off)
722 {
723 	struct edt_ft5x06_ts_data *tsdata = file->private_data;
724 	struct i2c_client *client = tsdata->client;
725 	int retries  = EDT_RAW_DATA_RETRIES;
726 	unsigned int val;
727 	int i, error;
728 	size_t read = 0;
729 	int colbytes;
730 	u8 *rdbuf;
731 
732 	if (*off < 0 || *off >= tsdata->raw_bufsize)
733 		return 0;
734 
735 	guard(mutex)(&tsdata->mutex);
736 
737 	if (!tsdata->factory_mode || !tsdata->raw_buffer)
738 		return -EIO;
739 
740 	error = regmap_write(tsdata->regmap, 0x08, 0x01);
741 	if (error) {
742 		dev_err(&client->dev,
743 			"failed to write 0x08 register, error %d\n", error);
744 		return error;
745 	}
746 
747 	do {
748 		usleep_range(EDT_RAW_DATA_DELAY, EDT_RAW_DATA_DELAY + 100);
749 		error = regmap_read(tsdata->regmap, 0x08, &val);
750 		if (error) {
751 			dev_err(&client->dev,
752 				"failed to read 0x08 register, error %d\n",
753 				error);
754 			return error;
755 		}
756 
757 		if (val == 1)
758 			break;
759 	} while (--retries > 0);
760 
761 	if (retries == 0) {
762 		dev_err(&client->dev,
763 			"timed out waiting for register to settle\n");
764 		return -ETIMEDOUT;
765 	}
766 
767 	rdbuf = tsdata->raw_buffer;
768 	colbytes = tsdata->num_y * sizeof(u16);
769 
770 	for (i = 0; i < tsdata->num_x; i++) {
771 		rdbuf[0] = i;  /* column index */
772 		error = regmap_bulk_read(tsdata->regmap, 0xf5, rdbuf, colbytes);
773 		if (error)
774 			return error;
775 
776 		rdbuf += colbytes;
777 	}
778 
779 	read = min_t(size_t, count, tsdata->raw_bufsize - *off);
780 	if (copy_to_user(buf, tsdata->raw_buffer + *off, read))
781 		return -EFAULT;
782 
783 	*off += read;
784 	return read;
785 };
786 
787 static const struct file_operations debugfs_raw_data_fops = {
788 	.open = simple_open,
789 	.read = edt_ft5x06_debugfs_raw_data_read,
790 };
791 
792 static void edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata)
793 {
794 	struct dentry *debug_dir = tsdata->client->debugfs;
795 
796 	debugfs_create_u16("num_x", S_IRUSR, debug_dir, &tsdata->num_x);
797 	debugfs_create_u16("num_y", S_IRUSR, debug_dir, &tsdata->num_y);
798 
799 	debugfs_create_file("mode", S_IRUSR | S_IWUSR,
800 			    debug_dir, tsdata, &debugfs_mode_fops);
801 	debugfs_create_file("raw_data", S_IRUSR,
802 			    debug_dir, tsdata, &debugfs_raw_data_fops);
803 }
804 
805 static void edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
806 {
807 	kfree(tsdata->raw_buffer);
808 }
809 
810 #else
811 
812 static int edt_ft5x06_factory_mode(struct edt_ft5x06_ts_data *tsdata)
813 {
814 	return -ENOSYS;
815 }
816 
817 static void edt_ft5x06_ts_prepare_debugfs(struct edt_ft5x06_ts_data *tsdata)
818 {
819 }
820 
821 static void edt_ft5x06_ts_teardown_debugfs(struct edt_ft5x06_ts_data *tsdata)
822 {
823 }
824 
825 #endif /* CONFIG_DEBUGFS */
826 
827 static int edt_ft5x06_ts_identify(struct i2c_client *client,
828 				  struct edt_ft5x06_ts_data *tsdata)
829 {
830 	u8 rdbuf[EDT_NAME_LEN];
831 	char *p;
832 	int error;
833 	char *model_name = tsdata->name;
834 	char *fw_version = tsdata->fw_version;
835 
836 	/* see what we find if we assume it is a M06 *
837 	 * if we get less than EDT_NAME_LEN, we don't want
838 	 * to have garbage in there
839 	 */
840 	memset(rdbuf, 0, sizeof(rdbuf));
841 	error = regmap_bulk_read(tsdata->regmap, 0xBB, rdbuf, EDT_NAME_LEN - 1);
842 	if (error)
843 		return error;
844 
845 	/* Probe content for something consistent.
846 	 * M06 starts with a response byte, M12 gives the data directly.
847 	 * M09/Generic does not provide model number information.
848 	 */
849 	if (!strncasecmp(rdbuf + 1, "EP0", 3)) {
850 		tsdata->version = EDT_M06;
851 
852 		/* remove last '$' end marker */
853 		rdbuf[EDT_NAME_LEN - 1] = '\0';
854 		if (rdbuf[EDT_NAME_LEN - 2] == '$')
855 			rdbuf[EDT_NAME_LEN - 2] = '\0';
856 
857 		/* look for Model/Version separator */
858 		p = strchr(rdbuf, '*');
859 		if (p)
860 			*p++ = '\0';
861 		strscpy(model_name, rdbuf + 1, EDT_NAME_LEN);
862 		strscpy(fw_version, p ? p : "", EDT_NAME_LEN);
863 
864 		regmap_exit(tsdata->regmap);
865 		tsdata->regmap = regmap_init_i2c(client,
866 						 &edt_M06_i2c_regmap_config);
867 		if (IS_ERR(tsdata->regmap)) {
868 			dev_err(&client->dev, "regmap allocation failed\n");
869 			return PTR_ERR(tsdata->regmap);
870 		}
871 	} else if (!strncasecmp(rdbuf, "EP0", 3)) {
872 		tsdata->version = EDT_M12;
873 
874 		/* remove last '$' end marker */
875 		rdbuf[EDT_NAME_LEN - 2] = '\0';
876 		if (rdbuf[EDT_NAME_LEN - 3] == '$')
877 			rdbuf[EDT_NAME_LEN - 3] = '\0';
878 
879 		/* look for Model/Version separator */
880 		p = strchr(rdbuf, '*');
881 		if (p)
882 			*p++ = '\0';
883 		strscpy(model_name, rdbuf, EDT_NAME_LEN);
884 		strscpy(fw_version, p ? p : "", EDT_NAME_LEN);
885 	} else {
886 		/* If it is not an EDT M06/M12 touchscreen, then the model
887 		 * detection is a bit hairy. The different ft5x06
888 		 * firmwares around don't reliably implement the
889 		 * identification registers. Well, we'll take a shot.
890 		 *
891 		 * The main difference between generic focaltec based
892 		 * touches and EDT M09 is that we know how to retrieve
893 		 * the max coordinates for the latter.
894 		 */
895 		tsdata->version = GENERIC_FT;
896 
897 		error = regmap_bulk_read(tsdata->regmap, 0xA6, rdbuf, 2);
898 		if (error)
899 			return error;
900 
901 		strscpy(fw_version, rdbuf, 2);
902 
903 		error = regmap_bulk_read(tsdata->regmap, 0xA8, rdbuf, 1);
904 		if (error)
905 			return error;
906 
907 		/* This "model identification" is not exact. Unfortunately
908 		 * not all firmwares for the ft5x06 put useful values in
909 		 * the identification registers.
910 		 */
911 		switch (rdbuf[0]) {
912 		case 0x11:   /* EDT EP0110M09 */
913 		case 0x35:   /* EDT EP0350M09 */
914 		case 0x43:   /* EDT EP0430M09 */
915 		case 0x50:   /* EDT EP0500M09 */
916 		case 0x57:   /* EDT EP0570M09 */
917 		case 0x70:   /* EDT EP0700M09 */
918 			tsdata->version = EDT_M09;
919 			snprintf(model_name, EDT_NAME_LEN, "EP0%i%i0M09",
920 				 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
921 			break;
922 		case 0xa1:   /* EDT EP1010ML00 */
923 			tsdata->version = EDT_M09;
924 			snprintf(model_name, EDT_NAME_LEN, "EP%i%i0ML00",
925 				 rdbuf[0] >> 4, rdbuf[0] & 0x0F);
926 			break;
927 		case 0x5a:   /* Solomon Goldentek Display */
928 			snprintf(model_name, EDT_NAME_LEN, "GKTW50SCED1R0");
929 			break;
930 		case 0x59:  /* Evervision Display with FT5xx6 TS */
931 			tsdata->version = EV_FT;
932 			error = regmap_bulk_read(tsdata->regmap, 0x53, rdbuf, 1);
933 			if (error)
934 				return error;
935 			strscpy(fw_version, rdbuf, 1);
936 			snprintf(model_name, EDT_NAME_LEN,
937 				 "EVERVISION-FT5726NEi");
938 			break;
939 		default:
940 			snprintf(model_name, EDT_NAME_LEN,
941 				 "generic ft5x06 (%02x)",
942 				 rdbuf[0]);
943 			break;
944 		}
945 	}
946 
947 	return 0;
948 }
949 
950 static void edt_ft5x06_ts_get_defaults(struct device *dev,
951 				       struct edt_ft5x06_ts_data *tsdata)
952 {
953 	struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
954 	struct regmap *regmap = tsdata->regmap;
955 	u32 val;
956 	int error;
957 
958 	error = device_property_read_u32(dev, "threshold", &val);
959 	if (!error) {
960 		regmap_write(regmap, reg_addr->reg_threshold, val);
961 		tsdata->threshold = val;
962 	}
963 
964 	error = device_property_read_u32(dev, "gain", &val);
965 	if (!error) {
966 		regmap_write(regmap, reg_addr->reg_gain, val);
967 		tsdata->gain = val;
968 	}
969 
970 	error = device_property_read_u32(dev, "offset", &val);
971 	if (!error) {
972 		if (reg_addr->reg_offset != NO_REGISTER)
973 			regmap_write(regmap, reg_addr->reg_offset, val);
974 		tsdata->offset = val;
975 	}
976 
977 	error = device_property_read_u32(dev, "offset-x", &val);
978 	if (!error) {
979 		if (reg_addr->reg_offset_x != NO_REGISTER)
980 			regmap_write(regmap, reg_addr->reg_offset_x, val);
981 		tsdata->offset_x = val;
982 	}
983 
984 	error = device_property_read_u32(dev, "offset-y", &val);
985 	if (!error) {
986 		if (reg_addr->reg_offset_y != NO_REGISTER)
987 			regmap_write(regmap, reg_addr->reg_offset_y, val);
988 		tsdata->offset_y = val;
989 	}
990 }
991 
992 static void edt_ft5x06_ts_get_parameters(struct edt_ft5x06_ts_data *tsdata)
993 {
994 	struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
995 	struct regmap *regmap = tsdata->regmap;
996 	unsigned int val;
997 
998 	regmap_read(regmap, reg_addr->reg_threshold, &tsdata->threshold);
999 	regmap_read(regmap, reg_addr->reg_gain, &tsdata->gain);
1000 	if (reg_addr->reg_offset != NO_REGISTER)
1001 		regmap_read(regmap, reg_addr->reg_offset, &tsdata->offset);
1002 	if (reg_addr->reg_offset_x != NO_REGISTER)
1003 		regmap_read(regmap, reg_addr->reg_offset_x, &tsdata->offset_x);
1004 	if (reg_addr->reg_offset_y != NO_REGISTER)
1005 		regmap_read(regmap, reg_addr->reg_offset_y, &tsdata->offset_y);
1006 	if (reg_addr->reg_report_rate != NO_REGISTER)
1007 		regmap_read(regmap, reg_addr->reg_report_rate,
1008 			    &tsdata->report_rate);
1009 	tsdata->num_x = EDT_DEFAULT_NUM_X;
1010 	if (reg_addr->reg_num_x != NO_REGISTER) {
1011 		if (!regmap_read(regmap, reg_addr->reg_num_x, &val))
1012 			tsdata->num_x = val;
1013 	}
1014 	tsdata->num_y = EDT_DEFAULT_NUM_Y;
1015 	if (reg_addr->reg_num_y != NO_REGISTER) {
1016 		if (!regmap_read(regmap, reg_addr->reg_num_y, &val))
1017 			tsdata->num_y = val;
1018 	}
1019 }
1020 
1021 static void edt_ft5x06_ts_set_tdata_parameters(struct edt_ft5x06_ts_data *tsdata)
1022 {
1023 	int crclen;
1024 
1025 	if (tsdata->version == EDT_M06) {
1026 		tsdata->tdata_cmd = 0xf9;
1027 		tsdata->tdata_offset = 5;
1028 		tsdata->point_len = 4;
1029 		crclen = 1;
1030 	} else {
1031 		tsdata->tdata_cmd = 0x0;
1032 		tsdata->tdata_offset = 3;
1033 		tsdata->point_len = 6;
1034 		crclen = 0;
1035 	}
1036 
1037 	tsdata->tdata_len = tsdata->point_len * tsdata->max_support_points +
1038 		tsdata->tdata_offset + crclen;
1039 }
1040 
1041 static void edt_ft5x06_ts_set_regs(struct edt_ft5x06_ts_data *tsdata)
1042 {
1043 	struct edt_reg_addr *reg_addr = &tsdata->reg_addr;
1044 
1045 	switch (tsdata->version) {
1046 	case EDT_M06:
1047 		reg_addr->reg_threshold = WORK_REGISTER_THRESHOLD;
1048 		reg_addr->reg_report_rate = WORK_REGISTER_REPORT_RATE;
1049 		reg_addr->reg_gain = WORK_REGISTER_GAIN;
1050 		reg_addr->reg_offset = WORK_REGISTER_OFFSET;
1051 		reg_addr->reg_offset_x = NO_REGISTER;
1052 		reg_addr->reg_offset_y = NO_REGISTER;
1053 		reg_addr->reg_num_x = WORK_REGISTER_NUM_X;
1054 		reg_addr->reg_num_y = WORK_REGISTER_NUM_Y;
1055 		break;
1056 
1057 	case EDT_M09:
1058 	case EDT_M12:
1059 		reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
1060 		reg_addr->reg_report_rate = tsdata->version == EDT_M12 ?
1061 			M12_REGISTER_REPORT_RATE : NO_REGISTER;
1062 		reg_addr->reg_gain = M09_REGISTER_GAIN;
1063 		reg_addr->reg_offset = M09_REGISTER_OFFSET;
1064 		reg_addr->reg_offset_x = NO_REGISTER;
1065 		reg_addr->reg_offset_y = NO_REGISTER;
1066 		reg_addr->reg_num_x = M09_REGISTER_NUM_X;
1067 		reg_addr->reg_num_y = M09_REGISTER_NUM_Y;
1068 		break;
1069 
1070 	case EV_FT:
1071 		reg_addr->reg_threshold = EV_REGISTER_THRESHOLD;
1072 		reg_addr->reg_report_rate = NO_REGISTER;
1073 		reg_addr->reg_gain = EV_REGISTER_GAIN;
1074 		reg_addr->reg_offset = NO_REGISTER;
1075 		reg_addr->reg_offset_x = EV_REGISTER_OFFSET_X;
1076 		reg_addr->reg_offset_y = EV_REGISTER_OFFSET_Y;
1077 		reg_addr->reg_num_x = NO_REGISTER;
1078 		reg_addr->reg_num_y = NO_REGISTER;
1079 		break;
1080 
1081 	case GENERIC_FT:
1082 		/* this is a guesswork */
1083 		reg_addr->reg_threshold = M09_REGISTER_THRESHOLD;
1084 		reg_addr->reg_report_rate = NO_REGISTER;
1085 		reg_addr->reg_gain = M09_REGISTER_GAIN;
1086 		reg_addr->reg_offset = M09_REGISTER_OFFSET;
1087 		reg_addr->reg_offset_x = NO_REGISTER;
1088 		reg_addr->reg_offset_y = NO_REGISTER;
1089 		reg_addr->reg_num_x = NO_REGISTER;
1090 		reg_addr->reg_num_y = NO_REGISTER;
1091 		break;
1092 	}
1093 }
1094 
1095 static void edt_ft5x06_exit_regmap(void *arg)
1096 {
1097 	struct edt_ft5x06_ts_data *data = arg;
1098 
1099 	if (!IS_ERR_OR_NULL(data->regmap))
1100 		regmap_exit(data->regmap);
1101 }
1102 
1103 static void edt_ft5x06_disable_regulators(void *arg)
1104 {
1105 	struct edt_ft5x06_ts_data *data = arg;
1106 
1107 	regulator_disable(data->vcc);
1108 	regulator_disable(data->iovcc);
1109 }
1110 
1111 static int edt_ft5x06_ts_probe(struct i2c_client *client)
1112 {
1113 	const struct i2c_device_id *id = i2c_client_get_device_id(client);
1114 	const struct edt_i2c_chip_data *chip_data;
1115 	struct edt_ft5x06_ts_data *tsdata;
1116 	unsigned int val;
1117 	struct input_dev *input;
1118 	unsigned long irq_flags;
1119 	int error;
1120 	u32 report_rate;
1121 
1122 	dev_dbg(&client->dev, "probing for EDT FT5x06 I2C\n");
1123 
1124 	tsdata = devm_kzalloc(&client->dev, sizeof(*tsdata), GFP_KERNEL);
1125 	if (!tsdata) {
1126 		dev_err(&client->dev, "failed to allocate driver data.\n");
1127 		return -ENOMEM;
1128 	}
1129 
1130 	tsdata->regmap = regmap_init_i2c(client, &edt_ft5x06_i2c_regmap_config);
1131 	if (IS_ERR(tsdata->regmap)) {
1132 		dev_err(&client->dev, "regmap allocation failed\n");
1133 		return PTR_ERR(tsdata->regmap);
1134 	}
1135 
1136 	/*
1137 	 * We are not using devm_regmap_init_i2c() and instead install a
1138 	 * custom action because we may replace regmap with M06-specific one
1139 	 * and we need to make sure that it will not be released too early.
1140 	 */
1141 	error = devm_add_action_or_reset(&client->dev, edt_ft5x06_exit_regmap,
1142 					 tsdata);
1143 	if (error)
1144 		return error;
1145 
1146 	chip_data = device_get_match_data(&client->dev);
1147 	if (!chip_data)
1148 		chip_data = (const struct edt_i2c_chip_data *)id->driver_data;
1149 	if (!chip_data || !chip_data->max_support_points) {
1150 		dev_err(&client->dev, "invalid or missing chip data\n");
1151 		return -EINVAL;
1152 	}
1153 
1154 	tsdata->max_support_points = chip_data->max_support_points;
1155 
1156 	tsdata->vcc = devm_regulator_get(&client->dev, "vcc");
1157 	if (IS_ERR(tsdata->vcc))
1158 		return dev_err_probe(&client->dev, PTR_ERR(tsdata->vcc),
1159 				     "failed to request regulator\n");
1160 
1161 	tsdata->iovcc = devm_regulator_get(&client->dev, "iovcc");
1162 	if (IS_ERR(tsdata->iovcc)) {
1163 		error = PTR_ERR(tsdata->iovcc);
1164 		if (error != -EPROBE_DEFER)
1165 			dev_err(&client->dev,
1166 				"failed to request iovcc regulator: %d\n", error);
1167 		return error;
1168 	}
1169 
1170 	error = regulator_enable(tsdata->iovcc);
1171 	if (error < 0) {
1172 		dev_err(&client->dev, "failed to enable iovcc: %d\n", error);
1173 		return error;
1174 	}
1175 
1176 	/* Delay enabling VCC for > 10us (T_ivd) after IOVCC */
1177 	usleep_range(10, 100);
1178 
1179 	error = regulator_enable(tsdata->vcc);
1180 	if (error < 0) {
1181 		dev_err(&client->dev, "failed to enable vcc: %d\n", error);
1182 		regulator_disable(tsdata->iovcc);
1183 		return error;
1184 	}
1185 
1186 	error = devm_add_action_or_reset(&client->dev,
1187 					 edt_ft5x06_disable_regulators,
1188 					 tsdata);
1189 	if (error)
1190 		return error;
1191 
1192 	tsdata->reset_gpio = devm_gpiod_get_optional(&client->dev,
1193 						     "reset", GPIOD_OUT_HIGH);
1194 	if (IS_ERR(tsdata->reset_gpio)) {
1195 		error = PTR_ERR(tsdata->reset_gpio);
1196 		dev_err(&client->dev,
1197 			"Failed to request GPIO reset pin, error %d\n", error);
1198 		return error;
1199 	}
1200 
1201 	tsdata->wake_gpio = devm_gpiod_get_optional(&client->dev,
1202 						    "wake", GPIOD_OUT_LOW);
1203 	if (IS_ERR(tsdata->wake_gpio)) {
1204 		error = PTR_ERR(tsdata->wake_gpio);
1205 		dev_err(&client->dev,
1206 			"Failed to request GPIO wake pin, error %d\n", error);
1207 		return error;
1208 	}
1209 
1210 	/*
1211 	 * Check which sleep modes we can support. Power-off requires the
1212 	 * reset-pin to ensure correct power-down/power-up behaviour. Start with
1213 	 * the EDT_PMODE_POWEROFF test since this is the deepest possible sleep
1214 	 * mode.
1215 	 */
1216 	if (tsdata->reset_gpio)
1217 		tsdata->suspend_mode = EDT_PMODE_POWEROFF;
1218 	else if (tsdata->wake_gpio)
1219 		tsdata->suspend_mode = EDT_PMODE_HIBERNATE;
1220 	else
1221 		tsdata->suspend_mode = EDT_PMODE_NOT_SUPPORTED;
1222 
1223 	if (tsdata->wake_gpio) {
1224 		usleep_range(5000, 6000);
1225 		gpiod_set_value_cansleep(tsdata->wake_gpio, 1);
1226 		usleep_range(5000, 6000);
1227 	}
1228 
1229 	if (tsdata->reset_gpio) {
1230 		usleep_range(5000, 6000);
1231 		gpiod_set_value_cansleep(tsdata->reset_gpio, 0);
1232 		msleep(300);
1233 	}
1234 
1235 	input = devm_input_allocate_device(&client->dev);
1236 	if (!input) {
1237 		dev_err(&client->dev, "failed to allocate input device.\n");
1238 		return -ENOMEM;
1239 	}
1240 
1241 	mutex_init(&tsdata->mutex);
1242 	tsdata->client = client;
1243 	tsdata->input = input;
1244 	tsdata->factory_mode = false;
1245 	i2c_set_clientdata(client, tsdata);
1246 
1247 	error = edt_ft5x06_ts_identify(client, tsdata);
1248 	if (error) {
1249 		dev_err(&client->dev, "touchscreen probe failed\n");
1250 		return error;
1251 	}
1252 
1253 	/*
1254 	 * Dummy read access. EP0700MLP1 returns bogus data on the first
1255 	 * register read access and ignores writes.
1256 	 */
1257 	regmap_read(tsdata->regmap, 0x00, &val);
1258 
1259 	edt_ft5x06_ts_set_tdata_parameters(tsdata);
1260 	edt_ft5x06_ts_set_regs(tsdata);
1261 	edt_ft5x06_ts_get_defaults(&client->dev, tsdata);
1262 	edt_ft5x06_ts_get_parameters(tsdata);
1263 
1264 	if (tsdata->reg_addr.reg_report_rate != NO_REGISTER &&
1265 	    !device_property_read_u32(&client->dev,
1266 				      "report-rate-hz", &report_rate)) {
1267 		if (tsdata->version == EDT_M06)
1268 			tsdata->report_rate = clamp_val(report_rate, 30, 140);
1269 		else
1270 			tsdata->report_rate = clamp_val(report_rate, 1, 255);
1271 
1272 		if (report_rate != tsdata->report_rate)
1273 			dev_warn(&client->dev,
1274 				 "report-rate %dHz is unsupported, use %dHz\n",
1275 				 report_rate, tsdata->report_rate);
1276 
1277 		if (tsdata->version == EDT_M06)
1278 			tsdata->report_rate /= 10;
1279 
1280 		regmap_write(tsdata->regmap, tsdata->reg_addr.reg_report_rate,
1281 			     tsdata->report_rate);
1282 	}
1283 
1284 	dev_dbg(&client->dev,
1285 		"Model \"%s\", Rev. \"%s\", %dx%d sensors\n",
1286 		tsdata->name, tsdata->fw_version, tsdata->num_x, tsdata->num_y);
1287 
1288 	input->name = tsdata->name;
1289 	input->id.bustype = BUS_I2C;
1290 	input->dev.parent = &client->dev;
1291 
1292 	input_set_abs_params(input, ABS_MT_POSITION_X,
1293 			     0, tsdata->num_x * 64 - 1, 0, 0);
1294 	input_set_abs_params(input, ABS_MT_POSITION_Y,
1295 			     0, tsdata->num_y * 64 - 1, 0, 0);
1296 
1297 	touchscreen_parse_properties(input, true, &tsdata->prop);
1298 
1299 	error = input_mt_init_slots(input, tsdata->max_support_points,
1300 				    INPUT_MT_DIRECT);
1301 	if (error) {
1302 		dev_err(&client->dev, "Unable to init MT slots.\n");
1303 		return error;
1304 	}
1305 
1306 	irq_flags = irq_get_trigger_type(client->irq);
1307 	if (irq_flags == IRQF_TRIGGER_NONE)
1308 		irq_flags = IRQF_TRIGGER_FALLING;
1309 	irq_flags |= IRQF_ONESHOT;
1310 
1311 	error = devm_request_threaded_irq(&client->dev, client->irq,
1312 					  NULL, edt_ft5x06_ts_isr, irq_flags,
1313 					  client->name, tsdata);
1314 	if (error) {
1315 		dev_err(&client->dev, "Unable to request touchscreen IRQ.\n");
1316 		return error;
1317 	}
1318 
1319 	error = input_register_device(input);
1320 	if (error)
1321 		return error;
1322 
1323 	edt_ft5x06_ts_prepare_debugfs(tsdata);
1324 
1325 	dev_dbg(&client->dev,
1326 		"EDT FT5x06 initialized: IRQ %d, WAKE pin %d, Reset pin %d.\n",
1327 		client->irq,
1328 		tsdata->wake_gpio ? desc_to_gpio(tsdata->wake_gpio) : -1,
1329 		tsdata->reset_gpio ? desc_to_gpio(tsdata->reset_gpio) : -1);
1330 
1331 	return 0;
1332 }
1333 
1334 static void edt_ft5x06_ts_remove(struct i2c_client *client)
1335 {
1336 	struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1337 
1338 	edt_ft5x06_ts_teardown_debugfs(tsdata);
1339 }
1340 
1341 static int edt_ft5x06_ts_suspend(struct device *dev)
1342 {
1343 	struct i2c_client *client = to_i2c_client(dev);
1344 	struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1345 	struct gpio_desc *reset_gpio = tsdata->reset_gpio;
1346 	int ret;
1347 
1348 	if (device_may_wakeup(dev))
1349 		return 0;
1350 
1351 	if (tsdata->suspend_mode == EDT_PMODE_NOT_SUPPORTED)
1352 		return 0;
1353 
1354 	/* Enter hibernate mode. */
1355 	ret = regmap_write(tsdata->regmap, PMOD_REGISTER_OPMODE,
1356 			   PMOD_REGISTER_HIBERNATE);
1357 	if (ret)
1358 		dev_warn(dev, "Failed to set hibernate mode\n");
1359 
1360 	if (tsdata->suspend_mode == EDT_PMODE_HIBERNATE)
1361 		return 0;
1362 
1363 	/*
1364 	 * Power-off according the datasheet. Cut the power may leaf the irq
1365 	 * line in an undefined state depending on the host pull resistor
1366 	 * settings. Disable the irq to avoid adjusting each host till the
1367 	 * device is back in a full functional state.
1368 	 */
1369 	disable_irq(tsdata->client->irq);
1370 
1371 	gpiod_set_value_cansleep(reset_gpio, 1);
1372 	usleep_range(1000, 2000);
1373 
1374 	ret = regulator_disable(tsdata->vcc);
1375 	if (ret)
1376 		dev_warn(dev, "Failed to disable vcc\n");
1377 	ret = regulator_disable(tsdata->iovcc);
1378 	if (ret)
1379 		dev_warn(dev, "Failed to disable iovcc\n");
1380 
1381 	return 0;
1382 }
1383 
1384 static int edt_ft5x06_ts_resume(struct device *dev)
1385 {
1386 	struct i2c_client *client = to_i2c_client(dev);
1387 	struct edt_ft5x06_ts_data *tsdata = i2c_get_clientdata(client);
1388 	int ret = 0;
1389 
1390 	if (device_may_wakeup(dev))
1391 		return 0;
1392 
1393 	if (tsdata->suspend_mode == EDT_PMODE_NOT_SUPPORTED)
1394 		return 0;
1395 
1396 	if (tsdata->suspend_mode == EDT_PMODE_POWEROFF) {
1397 		struct gpio_desc *reset_gpio = tsdata->reset_gpio;
1398 
1399 		/*
1400 		 * We can't check if the regulator is a dummy or a real
1401 		 * regulator. So we need to specify the 5ms reset time (T_rst)
1402 		 * here instead of the 100us T_rtp time. We also need to wait
1403 		 * 300ms in case it was a real supply and the power was cutted
1404 		 * of. Toggle the reset pin is also a way to exit the hibernate
1405 		 * mode.
1406 		 */
1407 		gpiod_set_value_cansleep(reset_gpio, 1);
1408 		usleep_range(5000, 6000);
1409 
1410 		ret = regulator_enable(tsdata->iovcc);
1411 		if (ret) {
1412 			dev_err(dev, "Failed to enable iovcc\n");
1413 			return ret;
1414 		}
1415 
1416 		/* Delay enabling VCC for > 10us (T_ivd) after IOVCC */
1417 		usleep_range(10, 100);
1418 
1419 		ret = regulator_enable(tsdata->vcc);
1420 		if (ret) {
1421 			dev_err(dev, "Failed to enable vcc\n");
1422 			regulator_disable(tsdata->iovcc);
1423 			return ret;
1424 		}
1425 
1426 		usleep_range(1000, 2000);
1427 		gpiod_set_value_cansleep(reset_gpio, 0);
1428 		msleep(300);
1429 
1430 		edt_ft5x06_restore_reg_parameters(tsdata);
1431 		enable_irq(tsdata->client->irq);
1432 
1433 		if (tsdata->factory_mode)
1434 			ret = edt_ft5x06_factory_mode(tsdata);
1435 	} else {
1436 		struct gpio_desc *wake_gpio = tsdata->wake_gpio;
1437 
1438 		gpiod_set_value_cansleep(wake_gpio, 0);
1439 		usleep_range(5000, 6000);
1440 		gpiod_set_value_cansleep(wake_gpio, 1);
1441 	}
1442 
1443 	return ret;
1444 }
1445 
1446 static DEFINE_SIMPLE_DEV_PM_OPS(edt_ft5x06_ts_pm_ops,
1447 				edt_ft5x06_ts_suspend, edt_ft5x06_ts_resume);
1448 
1449 static const struct edt_i2c_chip_data edt_ft5x06_data = {
1450 	.max_support_points = 5,
1451 };
1452 
1453 static const struct edt_i2c_chip_data edt_ft3518_data = {
1454 	.max_support_points = 10,
1455 };
1456 
1457 static const struct edt_i2c_chip_data edt_ft5452_data = {
1458 	.max_support_points = 5,
1459 };
1460 
1461 static const struct edt_i2c_chip_data edt_ft5506_data = {
1462 	.max_support_points = 10,
1463 };
1464 
1465 static const struct edt_i2c_chip_data edt_ft6236_data = {
1466 	.max_support_points = 2,
1467 };
1468 
1469 static const struct edt_i2c_chip_data edt_ft8201_data = {
1470 	.max_support_points = 10,
1471 };
1472 
1473 static const struct edt_i2c_chip_data edt_ft8716_data = {
1474 	.max_support_points = 10,
1475 };
1476 
1477 static const struct edt_i2c_chip_data edt_ft8719_data = {
1478 	.max_support_points = 10,
1479 };
1480 
1481 static const struct i2c_device_id edt_ft5x06_ts_id[] = {
1482 	{ .name = "edt-ft5x06", .driver_data = (long)&edt_ft5x06_data },
1483 	{ .name = "edt-ft5506", .driver_data = (long)&edt_ft5506_data },
1484 	{ .name = "ev-ft5726", .driver_data = (long)&edt_ft5506_data },
1485 	{ .name = "ft3518", .driver_data = (long)&edt_ft3518_data },
1486 	{ .name = "ft5452", .driver_data = (long)&edt_ft5452_data },
1487 	/* Note no edt- prefix for compatibility with the ft6236.c driver */
1488 	{ .name = "ft6236", .driver_data = (long)&edt_ft6236_data },
1489 	{ .name = "ft8201", .driver_data = (long)&edt_ft8201_data },
1490 	{ .name = "ft8716", .driver_data = (long)&edt_ft8716_data },
1491 	{ .name = "ft8719", .driver_data = (long)&edt_ft8719_data },
1492 	{ /* sentinel */ }
1493 };
1494 MODULE_DEVICE_TABLE(i2c, edt_ft5x06_ts_id);
1495 
1496 static const struct of_device_id edt_ft5x06_of_match[] = {
1497 	{ .compatible = "edt,edt-ft5206", .data = &edt_ft5x06_data },
1498 	{ .compatible = "edt,edt-ft5306", .data = &edt_ft5x06_data },
1499 	{ .compatible = "edt,edt-ft5406", .data = &edt_ft5x06_data },
1500 	{ .compatible = "edt,edt-ft5506", .data = &edt_ft5506_data },
1501 	{ .compatible = "evervision,ev-ft5726", .data = &edt_ft5506_data },
1502 	{ .compatible = "focaltech,ft3518", .data = &edt_ft3518_data },
1503 	{ .compatible = "focaltech,ft5426", .data = &edt_ft5506_data },
1504 	{ .compatible = "focaltech,ft5452", .data = &edt_ft5452_data },
1505 	/* Note focaltech vendor prefix for compatibility with ft6236.c */
1506 	{ .compatible = "focaltech,ft6236", .data = &edt_ft6236_data },
1507 	{ .compatible = "focaltech,ft8201", .data = &edt_ft8201_data },
1508 	{ .compatible = "focaltech,ft8716", .data = &edt_ft8716_data },
1509 	{ .compatible = "focaltech,ft8719", .data = &edt_ft8719_data },
1510 	{ /* sentinel */ }
1511 };
1512 MODULE_DEVICE_TABLE(of, edt_ft5x06_of_match);
1513 
1514 static struct i2c_driver edt_ft5x06_ts_driver = {
1515 	.driver = {
1516 		.name = "edt_ft5x06",
1517 		.dev_groups = edt_ft5x06_groups,
1518 		.of_match_table = edt_ft5x06_of_match,
1519 		.pm = pm_sleep_ptr(&edt_ft5x06_ts_pm_ops),
1520 		.probe_type = PROBE_PREFER_ASYNCHRONOUS,
1521 	},
1522 	.id_table = edt_ft5x06_ts_id,
1523 	.probe    = edt_ft5x06_ts_probe,
1524 	.remove   = edt_ft5x06_ts_remove,
1525 };
1526 
1527 module_i2c_driver(edt_ft5x06_ts_driver);
1528 
1529 MODULE_AUTHOR("Simon Budig <simon.budig@kernelconcepts.de>");
1530 MODULE_DESCRIPTION("EDT FT5x06 I2C Touchscreen Driver");
1531 MODULE_LICENSE("GPL v2");
1532