1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Parade TrueTouch(TM) Standard Product V5 Module.
4  *
5  * Copyright (C) 2015 Parade Technologies
6  * Copyright (C) 2012-2015 Cypress Semiconductor
7  * Copyright (C) 2018 Bootlin
8  *
9  * Authors: Mylène Josserand <mylene.josserand@bootlin.com>
10  *                Alistair Francis <alistair@alistair23.me>
11  */
12 
13 #include <linux/crc-itu-t.h>
14 #include <linux/delay.h>
15 #include <linux/device.h>
16 #include <linux/gpio/consumer.h>
17 #include <linux/input/mt.h>
18 #include <linux/input/touchscreen.h>
19 #include <linux/interrupt.h>
20 #include <linux/i2c.h>
21 #include <linux/module.h>
22 #include <linux/of_device.h>
23 #include <linux/regmap.h>
24 #include <asm/unaligned.h>
25 
26 #define CYTTSP5_NAME				"cyttsp5"
27 #define CY_I2C_DATA_SIZE			(2 * 256)
28 #define HID_VERSION				0x0100
29 #define CY_MAX_INPUT				512
30 #define CYTTSP5_PREALLOCATED_CMD_BUFFER		32
31 #define CY_BITS_PER_BTN				1
32 #define CY_NUM_BTN_EVENT_ID			GENMASK(CY_BITS_PER_BTN, 0)
33 
34 #define MAX_AREA				255
35 #define HID_OUTPUT_BL_SOP			0x1
36 #define HID_OUTPUT_BL_EOP			0x17
37 #define HID_OUTPUT_BL_LAUNCH_APP		0x3B
38 #define HID_OUTPUT_BL_LAUNCH_APP_SIZE		11
39 #define HID_OUTPUT_GET_SYSINFO			0x2
40 #define HID_OUTPUT_GET_SYSINFO_SIZE		5
41 #define HID_OUTPUT_MAX_CMD_SIZE			12
42 
43 #define HID_DESC_REG				0x1
44 #define HID_INPUT_REG				0x3
45 #define HID_OUTPUT_REG				0x4
46 
47 #define REPORT_ID_TOUCH				0x1
48 #define REPORT_ID_BTN				0x3
49 #define REPORT_SIZE_5				5
50 #define REPORT_SIZE_8				8
51 #define REPORT_SIZE_16				16
52 
53 /* Touch reports offsets */
54 /* Header offsets */
55 #define TOUCH_REPORT_DESC_HDR_CONTACTCOUNT	16
56 /* Record offsets */
57 #define TOUCH_REPORT_DESC_CONTACTID		8
58 #define TOUCH_REPORT_DESC_X			16
59 #define TOUCH_REPORT_DESC_Y			32
60 #define TOUCH_REPORT_DESC_P			48
61 #define TOUCH_REPORT_DESC_MAJ			56
62 #define TOUCH_REPORT_DESC_MIN			64
63 
64 /* HID */
65 #define HID_TOUCH_REPORT_ID			0x1
66 #define HID_BTN_REPORT_ID			0x3
67 #define HID_APP_RESPONSE_REPORT_ID		0x1F
68 #define HID_APP_OUTPUT_REPORT_ID		0x2F
69 #define HID_BL_RESPONSE_REPORT_ID		0x30
70 #define HID_BL_OUTPUT_REPORT_ID			0x40
71 
72 #define HID_OUTPUT_RESPONSE_REPORT_OFFSET	2
73 #define HID_OUTPUT_RESPONSE_CMD_OFFSET		4
74 #define HID_OUTPUT_RESPONSE_CMD_MASK		GENMASK(6, 0)
75 
76 #define HID_SYSINFO_SENSING_OFFSET		33
77 #define HID_SYSINFO_BTN_OFFSET			48
78 #define HID_SYSINFO_BTN_MASK			GENMASK(7, 0)
79 #define HID_SYSINFO_MAX_BTN			8
80 
81 #define CY_HID_OUTPUT_TIMEOUT_MS		200
82 #define CY_HID_OUTPUT_GET_SYSINFO_TIMEOUT_MS	3000
83 #define CY_HID_GET_HID_DESCRIPTOR_TIMEOUT_MS	4000
84 
85 /* maximum number of concurrent tracks */
86 #define TOUCH_REPORT_SIZE			10
87 #define TOUCH_INPUT_HEADER_SIZE			7
88 #define BTN_REPORT_SIZE				9
89 #define BTN_INPUT_HEADER_SIZE			5
90 
91 #define MAX_CY_TCH_T_IDS			32
92 
93 /* All usage pages for Touch Report */
94 #define TOUCH_REPORT_USAGE_PG_X			0x00010030
95 #define TOUCH_REPORT_USAGE_PG_Y			0x00010031
96 #define TOUCH_REPORT_USAGE_PG_P			0x000D0030
97 #define TOUCH_REPORT_USAGE_PG_CONTACTID		0x000D0051
98 #define TOUCH_REPORT_USAGE_PG_CONTACTCOUNT	0x000D0054
99 #define TOUCH_REPORT_USAGE_PG_MAJ		0xFF010062
100 #define TOUCH_REPORT_USAGE_PG_MIN		0xFF010063
101 #define TOUCH_COL_USAGE_PG			0x000D0022
102 
103 /* System Information interface definitions */
104 struct cyttsp5_sensing_conf_data_dev {
105 	u8 electrodes_x;
106 	u8 electrodes_y;
107 	__le16 len_x;
108 	__le16 len_y;
109 	__le16 res_x;
110 	__le16 res_y;
111 	__le16 max_z;
112 	u8 origin_x;
113 	u8 origin_y;
114 	u8 btn;
115 	u8 scan_mode;
116 	u8 max_num_of_tch_per_refresh_cycle;
117 } __packed;
118 
119 struct cyttsp5_sensing_conf_data {
120 	u16 res_x;
121 	u16 res_y;
122 	u16 max_z;
123 	u16 len_x;
124 	u16 len_y;
125 	u8 origin_x;
126 	u8 origin_y;
127 	u8 max_tch;
128 };
129 
130 enum cyttsp5_tch_abs {	/* for ordering within the extracted touch data array */
131 	CY_TCH_X,	/* X */
132 	CY_TCH_Y,	/* Y */
133 	CY_TCH_P,	/* P (Z) */
134 	CY_TCH_T,	/* TOUCH ID */
135 	CY_TCH_MAJ,	/* TOUCH_MAJOR */
136 	CY_TCH_MIN,	/* TOUCH_MINOR */
137 	CY_TCH_NUM_ABS
138 };
139 
140 struct cyttsp5_tch_abs_params {
141 	size_t ofs;	/* abs byte offset */
142 	size_t size;	/* size in bits */
143 	size_t min;	/* min value */
144 	size_t max;	/* max value */
145 	size_t bofs;	/* bit offset */
146 };
147 
148 struct cyttsp5_touch {
149 	int abs[CY_TCH_NUM_ABS];
150 };
151 
152 struct cyttsp5_sysinfo {
153 	struct cyttsp5_sensing_conf_data sensing_conf_data;
154 	int num_btns;
155 	struct cyttsp5_tch_abs_params tch_hdr;
156 	struct cyttsp5_tch_abs_params tch_abs[CY_TCH_NUM_ABS];
157 	u32 key_code[HID_SYSINFO_MAX_BTN];
158 };
159 
160 struct cyttsp5_hid_desc {
161 	__le16 hid_desc_len;
162 	u8 packet_id;
163 	u8 reserved_byte;
164 	__le16 bcd_version;
165 	__le16 report_desc_len;
166 	__le16 report_desc_register;
167 	__le16 input_register;
168 	__le16 max_input_len;
169 	__le16 output_register;
170 	__le16 max_output_len;
171 	__le16 command_register;
172 	__le16 data_register;
173 	__le16 vendor_id;
174 	__le16 product_id;
175 	__le16 version_id;
176 	u8 reserved[4];
177 } __packed;
178 
179 struct cyttsp5 {
180 	struct device *dev;
181 	struct completion cmd_done;
182 	struct cyttsp5_sysinfo sysinfo;
183 	struct cyttsp5_hid_desc hid_desc;
184 	u8 cmd_buf[CYTTSP5_PREALLOCATED_CMD_BUFFER];
185 	u8 input_buf[CY_MAX_INPUT];
186 	u8 response_buf[CY_MAX_INPUT];
187 	struct gpio_desc *reset_gpio;
188 	struct input_dev *input;
189 	char phys[NAME_MAX];
190 	int num_prv_rec;
191 	struct regmap *regmap;
192 	struct touchscreen_properties prop;
193 	struct regulator *vdd;
194 };
195 
196 /*
197  * For what is understood in the datasheet, the register does not
198  * matter. For consistency, use the Input Register address
199  * but it does mean anything to the device. The important data
200  * to send is the I2C address
201  */
202 static int cyttsp5_read(struct cyttsp5 *ts, u8 *buf, u32 max)
203 {
204 	int error;
205 	u32 size;
206 	u8 temp[2];
207 
208 	/* Read the frame to retrieve the size */
209 	error = regmap_bulk_read(ts->regmap, HID_INPUT_REG, temp, sizeof(temp));
210 	if (error)
211 		return error;
212 
213 	size = get_unaligned_le16(temp);
214 	if (!size || size == 2)
215 		return 0;
216 
217 	if (size > max)
218 		return -EINVAL;
219 
220 	/* Get the real value */
221 	return regmap_bulk_read(ts->regmap, HID_INPUT_REG, buf, size);
222 }
223 
224 static int cyttsp5_write(struct cyttsp5 *ts, unsigned int reg, u8 *data,
225 			 size_t size)
226 {
227 	u8 cmd[HID_OUTPUT_MAX_CMD_SIZE];
228 
229 	if (size + 1 > HID_OUTPUT_MAX_CMD_SIZE)
230 		return -E2BIG;
231 
232 	/* High bytes of register address needed as first byte of cmd */
233 	cmd[0] = (reg >> 8) & 0xFF;
234 
235 	/* Copy the rest of the data */
236 	if (data)
237 		memcpy(&cmd[1], data, size);
238 
239 	/*
240 	 * The hardware wants to receive a frame with the address register
241 	 * contained in the first two bytes. As the regmap_write function
242 	 * add the register adresse in the frame, we use the low byte as
243 	 * first frame byte for the address register and the first
244 	 * data byte is the high register + left of the cmd to send
245 	 */
246 	return regmap_bulk_write(ts->regmap, reg & 0xFF, cmd, size + 1);
247 }
248 
249 static void cyttsp5_get_touch_axis(int *axis, int size, int max, u8 *xy_data,
250 				   int bofs)
251 {
252 	int nbyte;
253 
254 	for (nbyte = 0, *axis = 0; nbyte < size; nbyte++)
255 		*axis += ((xy_data[nbyte] >> bofs) << (nbyte * 8));
256 
257 	*axis &= max - 1;
258 }
259 
260 static void cyttsp5_get_touch_record(struct cyttsp5 *ts,
261 				     struct cyttsp5_touch *touch, u8 *xy_data)
262 {
263 	struct cyttsp5_sysinfo *si = &ts->sysinfo;
264 	enum cyttsp5_tch_abs abs;
265 
266 	for (abs = CY_TCH_X; abs < CY_TCH_NUM_ABS; abs++)
267 		cyttsp5_get_touch_axis(&touch->abs[abs],
268 				       si->tch_abs[abs].size,
269 				       si->tch_abs[abs].max,
270 				       xy_data + si->tch_abs[abs].ofs,
271 				       si->tch_abs[abs].bofs);
272 }
273 
274 static void cyttsp5_get_mt_touches(struct cyttsp5 *ts,
275 				   struct cyttsp5_touch *tch, int num_cur_tch)
276 {
277 	struct cyttsp5_sysinfo *si = &ts->sysinfo;
278 	int i, t = 0, offset = 0;
279 	DECLARE_BITMAP(ids, MAX_CY_TCH_T_IDS);
280 	u8 *tch_addr;
281 	int tmp;
282 
283 	bitmap_zero(ids, MAX_CY_TCH_T_IDS);
284 	memset(tch->abs, 0, sizeof(tch->abs));
285 
286 	switch (ts->input_buf[2]) {
287 	case HID_TOUCH_REPORT_ID:
288 		offset = TOUCH_INPUT_HEADER_SIZE;
289 		break;
290 	case HID_BTN_REPORT_ID:
291 		offset = BTN_INPUT_HEADER_SIZE;
292 		break;
293 	}
294 
295 	for (i = 0; i < num_cur_tch; i++) {
296 		tch_addr = ts->input_buf + offset + (i * TOUCH_REPORT_SIZE);
297 		cyttsp5_get_touch_record(ts, tch, tch_addr);
298 
299 		/* Convert MAJOR/MINOR from mm to resolution */
300 		tmp = tch->abs[CY_TCH_MAJ] * 100 * si->sensing_conf_data.res_x;
301 		tch->abs[CY_TCH_MAJ] = tmp / si->sensing_conf_data.len_x;
302 		tmp = tch->abs[CY_TCH_MIN] * 100 * si->sensing_conf_data.res_x;
303 		tch->abs[CY_TCH_MIN] = tmp / si->sensing_conf_data.len_x;
304 
305 		t = tch->abs[CY_TCH_T];
306 		input_mt_slot(ts->input, t);
307 		input_mt_report_slot_state(ts->input, MT_TOOL_FINGER, true);
308 		__set_bit(t, ids);
309 
310 		/* position and pressure fields */
311 		touchscreen_report_pos(ts->input, &ts->prop,
312 				       tch->abs[CY_TCH_X], tch->abs[CY_TCH_Y],
313 				       true);
314 		input_report_abs(ts->input, ABS_MT_PRESSURE,
315 				 tch->abs[CY_TCH_P]);
316 
317 		/* Get the extended touch fields */
318 		input_report_abs(ts->input, ABS_MT_TOUCH_MAJOR,
319 				 tch->abs[CY_TCH_MAJ]);
320 		input_report_abs(ts->input, ABS_MT_TOUCH_MINOR,
321 				 tch->abs[CY_TCH_MIN]);
322 	}
323 
324 	ts->num_prv_rec = num_cur_tch;
325 }
326 
327 static int cyttsp5_mt_attention(struct device *dev)
328 {
329 	struct cyttsp5 *ts = dev_get_drvdata(dev);
330 	struct cyttsp5_sysinfo *si = &ts->sysinfo;
331 	int max_tch = si->sensing_conf_data.max_tch;
332 	struct cyttsp5_touch tch;
333 	int num_cur_tch;
334 
335 	cyttsp5_get_touch_axis(&num_cur_tch, si->tch_hdr.size,
336 			       si->tch_hdr.max,
337 			       ts->input_buf + 3 + si->tch_hdr.ofs,
338 			       si->tch_hdr.bofs);
339 
340 	if (num_cur_tch > max_tch) {
341 		dev_err(dev, "Num touch err detected (n=%d)\n", num_cur_tch);
342 		num_cur_tch = max_tch;
343 	}
344 
345 	if (num_cur_tch == 0 && ts->num_prv_rec == 0)
346 		return 0;
347 
348 	/* extract xy_data for all currently reported touches */
349 	if (num_cur_tch)
350 		cyttsp5_get_mt_touches(ts, &tch, num_cur_tch);
351 
352 	input_mt_sync_frame(ts->input);
353 	input_sync(ts->input);
354 
355 	return 0;
356 }
357 
358 static int cyttsp5_setup_input_device(struct device *dev)
359 {
360 	struct cyttsp5 *ts = dev_get_drvdata(dev);
361 	struct cyttsp5_sysinfo *si = &ts->sysinfo;
362 	int max_x, max_y, max_p;
363 	int max_x_tmp, max_y_tmp;
364 	int error;
365 
366 	max_x_tmp = si->sensing_conf_data.res_x;
367 	max_y_tmp = si->sensing_conf_data.res_y;
368 	max_x = max_x_tmp - 1;
369 	max_y = max_y_tmp - 1;
370 	max_p = si->sensing_conf_data.max_z;
371 
372 	input_set_abs_params(ts->input, ABS_MT_POSITION_X, 0, max_x, 0, 0);
373 	input_set_abs_params(ts->input, ABS_MT_POSITION_Y, 0, max_y, 0, 0);
374 	input_set_abs_params(ts->input, ABS_MT_PRESSURE, 0, max_p, 0, 0);
375 
376 	input_set_abs_params(ts->input, ABS_MT_TOUCH_MAJOR, 0, MAX_AREA, 0, 0);
377 	input_set_abs_params(ts->input, ABS_MT_TOUCH_MINOR, 0, MAX_AREA, 0, 0);
378 
379 	error = input_mt_init_slots(ts->input, si->tch_abs[CY_TCH_T].max,
380 				    INPUT_MT_DROP_UNUSED | INPUT_MT_DIRECT);
381 	if (error)
382 		return error;
383 
384 	error = input_register_device(ts->input);
385 	if (error) {
386 		dev_err(dev, "failed to register input device: %d\n", error);
387 		return error;
388 	}
389 
390 	return error;
391 }
392 
393 static int cyttsp5_parse_dt_key_code(struct device *dev)
394 {
395 	struct cyttsp5 *ts = dev_get_drvdata(dev);
396 	struct cyttsp5_sysinfo *si = &ts->sysinfo;
397 
398 	if (!si->num_btns)
399 		return 0;
400 
401 	/* Initialize the button to RESERVED */
402 	memset32(si->key_code, KEY_RESERVED,  si->num_btns);
403 
404 	return device_property_read_u32_array(dev, "linux,keycodes",
405 					      si->key_code, si->num_btns);
406 }
407 
408 static int cyttsp5_btn_attention(struct device *dev)
409 {
410 	struct cyttsp5 *ts = dev_get_drvdata(dev);
411 	struct cyttsp5_sysinfo *si = &ts->sysinfo;
412 	int cur_btn, offset = 0;
413 	int cur_btn_state;
414 
415 	switch (ts->input_buf[2]) {
416 	case HID_TOUCH_REPORT_ID:
417 		offset = TOUCH_INPUT_HEADER_SIZE;
418 		break;
419 	case HID_BTN_REPORT_ID:
420 		offset = BTN_INPUT_HEADER_SIZE;
421 		break;
422 	}
423 
424 	if (ts->input_buf[2] != HID_BTN_REPORT_ID)
425 		return 0;
426 
427 	/* extract button press/release touch information */
428 	for (cur_btn = 0; cur_btn < si->num_btns; cur_btn++) {
429 		/* Get current button state */
430 		cur_btn_state = (ts->input_buf[offset] >> (cur_btn * CY_BITS_PER_BTN))
431 				& CY_NUM_BTN_EVENT_ID;
432 
433 		input_report_key(ts->input, si->key_code[cur_btn],
434 				 cur_btn_state);
435 		input_sync(ts->input);
436 	}
437 
438 	return 0;
439 }
440 
441 static int cyttsp5_validate_cmd_response(struct cyttsp5 *ts, u8 code)
442 {
443 	u16 size, crc;
444 	u8 status, report_id;
445 	int command_code;
446 
447 	size = get_unaligned_le16(&ts->response_buf[0]);
448 	if (!size)
449 		return 0;
450 
451 	report_id = ts->response_buf[HID_OUTPUT_RESPONSE_REPORT_OFFSET];
452 
453 	switch (report_id) {
454 	case HID_BL_RESPONSE_REPORT_ID:
455 		if (ts->response_buf[4] != HID_OUTPUT_BL_SOP) {
456 			dev_err(ts->dev, "HID output response, wrong SOP\n");
457 			return -EPROTO;
458 		}
459 
460 		if (ts->response_buf[size - 1] != HID_OUTPUT_BL_EOP) {
461 			dev_err(ts->dev, "HID output response, wrong EOP\n");
462 			return -EPROTO;
463 		}
464 
465 		crc = crc_itu_t(0xFFFF, &ts->response_buf[4], size - 7);
466 		if (get_unaligned_le16(&ts->response_buf[size - 3]) != crc) {
467 			dev_err(ts->dev,
468 				"HID output response, wrong CRC 0x%X\n",
469 				crc);
470 			return -EPROTO;
471 		}
472 
473 		status = ts->response_buf[5];
474 		if (status) {
475 			dev_err(ts->dev, "HID output response, ERROR:%d\n",
476 				status);
477 			return -EPROTO;
478 		}
479 		break;
480 
481 	case HID_APP_RESPONSE_REPORT_ID:
482 		command_code = ts->response_buf[HID_OUTPUT_RESPONSE_CMD_OFFSET]
483 			& HID_OUTPUT_RESPONSE_CMD_MASK;
484 		if (command_code != code) {
485 			dev_err(ts->dev,
486 				"HID output response, wrong command_code:%X\n",
487 				command_code);
488 			return -EPROTO;
489 		}
490 		break;
491 	}
492 
493 	return 0;
494 }
495 
496 static void cyttsp5_si_get_btn_data(struct cyttsp5 *ts)
497 {
498 	struct cyttsp5_sysinfo *si = &ts->sysinfo;
499 	unsigned int btns = ts->response_buf[HID_SYSINFO_BTN_OFFSET] &
500 				HID_SYSINFO_BTN_MASK;
501 
502 	si->num_btns = hweight8(btns);
503 }
504 
505 static int cyttsp5_get_sysinfo_regs(struct cyttsp5 *ts)
506 {
507 	struct cyttsp5_sensing_conf_data *scd = &ts->sysinfo.sensing_conf_data;
508 	struct cyttsp5_sensing_conf_data_dev *scd_dev =
509 		(struct cyttsp5_sensing_conf_data_dev *)
510 		&ts->response_buf[HID_SYSINFO_SENSING_OFFSET];
511 
512 	cyttsp5_si_get_btn_data(ts);
513 
514 	scd->max_tch = scd_dev->max_num_of_tch_per_refresh_cycle;
515 	scd->res_x = get_unaligned_le16(&scd_dev->res_x);
516 	scd->res_y = get_unaligned_le16(&scd_dev->res_y);
517 	scd->max_z = get_unaligned_le16(&scd_dev->max_z);
518 	scd->len_x = get_unaligned_le16(&scd_dev->len_x);
519 	scd->len_y = get_unaligned_le16(&scd_dev->len_y);
520 
521 	return 0;
522 }
523 
524 static int cyttsp5_hid_output_get_sysinfo(struct cyttsp5 *ts)
525 {
526 	int rc;
527 	u8 cmd[HID_OUTPUT_GET_SYSINFO_SIZE];
528 
529 	/* HI bytes of Output register address */
530 	put_unaligned_le16(HID_OUTPUT_GET_SYSINFO_SIZE, cmd);
531 	cmd[2] = HID_APP_OUTPUT_REPORT_ID;
532 	cmd[3] = 0x0; /* Reserved */
533 	cmd[4] = HID_OUTPUT_GET_SYSINFO;
534 
535 	rc = cyttsp5_write(ts, HID_OUTPUT_REG, cmd,
536 			   HID_OUTPUT_GET_SYSINFO_SIZE);
537 	if (rc) {
538 		dev_err(ts->dev, "Failed to write command %d", rc);
539 		return rc;
540 	}
541 
542 	rc = wait_for_completion_interruptible_timeout(&ts->cmd_done,
543 						msecs_to_jiffies(CY_HID_OUTPUT_GET_SYSINFO_TIMEOUT_MS));
544 	if (rc <= 0) {
545 		dev_err(ts->dev, "HID output cmd execution timed out\n");
546 		rc = -ETIMEDOUT;
547 		return rc;
548 	}
549 
550 	rc = cyttsp5_validate_cmd_response(ts, HID_OUTPUT_GET_SYSINFO);
551 	if (rc) {
552 		dev_err(ts->dev, "Validation of the response failed\n");
553 		return rc;
554 	}
555 
556 	return cyttsp5_get_sysinfo_regs(ts);
557 }
558 
559 static int cyttsp5_hid_output_bl_launch_app(struct cyttsp5 *ts)
560 {
561 	int rc;
562 	u8 cmd[HID_OUTPUT_BL_LAUNCH_APP];
563 	u16 crc;
564 
565 	put_unaligned_le16(HID_OUTPUT_BL_LAUNCH_APP_SIZE, cmd);
566 	cmd[2] = HID_BL_OUTPUT_REPORT_ID;
567 	cmd[3] = 0x0; /* Reserved */
568 	cmd[4] = HID_OUTPUT_BL_SOP;
569 	cmd[5] = HID_OUTPUT_BL_LAUNCH_APP;
570 	put_unaligned_le16(0x00, &cmd[6]);
571 	crc = crc_itu_t(0xFFFF, &cmd[4], 4);
572 	put_unaligned_le16(crc, &cmd[8]);
573 	cmd[10] = HID_OUTPUT_BL_EOP;
574 
575 	rc = cyttsp5_write(ts, HID_OUTPUT_REG, cmd,
576 			   HID_OUTPUT_BL_LAUNCH_APP_SIZE);
577 	if (rc) {
578 		dev_err(ts->dev, "Failed to write command %d", rc);
579 		return rc;
580 	}
581 
582 	rc = wait_for_completion_interruptible_timeout(&ts->cmd_done,
583 				msecs_to_jiffies(CY_HID_OUTPUT_TIMEOUT_MS));
584 	if (rc <= 0) {
585 		dev_err(ts->dev, "HID output cmd execution timed out\n");
586 		rc = -ETIMEDOUT;
587 		return rc;
588 	}
589 
590 	rc = cyttsp5_validate_cmd_response(ts, HID_OUTPUT_BL_LAUNCH_APP);
591 	if (rc) {
592 		dev_err(ts->dev, "Validation of the response failed\n");
593 		return rc;
594 	}
595 
596 	return 0;
597 }
598 
599 static int cyttsp5_get_hid_descriptor(struct cyttsp5 *ts,
600 				      struct cyttsp5_hid_desc *desc)
601 {
602 	struct device *dev = ts->dev;
603 	__le16 hid_desc_register = cpu_to_le16(HID_DESC_REG);
604 	int rc;
605 	u8 cmd[2];
606 
607 	/* Set HID descriptor register */
608 	memcpy(cmd, &hid_desc_register, sizeof(hid_desc_register));
609 
610 	rc = cyttsp5_write(ts, HID_DESC_REG, NULL, 0);
611 	if (rc) {
612 		dev_err(dev, "Failed to get HID descriptor, rc=%d\n", rc);
613 		return rc;
614 	}
615 
616 	rc = wait_for_completion_interruptible_timeout(&ts->cmd_done,
617 			msecs_to_jiffies(CY_HID_GET_HID_DESCRIPTOR_TIMEOUT_MS));
618 	if (rc <= 0) {
619 		dev_err(ts->dev, "HID get descriptor timed out\n");
620 		rc = -ETIMEDOUT;
621 		return rc;
622 	}
623 
624 	memcpy(desc, ts->response_buf, sizeof(*desc));
625 
626 	/* Check HID descriptor length and version */
627 	if (le16_to_cpu(desc->hid_desc_len) != sizeof(*desc) ||
628 	    le16_to_cpu(desc->bcd_version) != HID_VERSION) {
629 		dev_err(dev, "Unsupported HID version\n");
630 		return -ENODEV;
631 	}
632 
633 	return 0;
634 }
635 
636 static int fill_tch_abs(struct cyttsp5_tch_abs_params *tch_abs, int report_size,
637 			int offset)
638 {
639 	tch_abs->ofs = offset / 8;
640 	tch_abs->size = report_size / 8;
641 	if (report_size % 8)
642 		tch_abs->size += 1;
643 	tch_abs->min = 0;
644 	tch_abs->max = 1 << report_size;
645 	tch_abs->bofs = offset - (tch_abs->ofs << 3);
646 
647 	return 0;
648 }
649 
650 static irqreturn_t cyttsp5_handle_irq(int irq, void *handle)
651 {
652 	struct cyttsp5 *ts = handle;
653 	int report_id;
654 	int size;
655 	int error;
656 
657 	error = cyttsp5_read(ts, ts->input_buf, CY_MAX_INPUT);
658 	if (error)
659 		return IRQ_HANDLED;
660 
661 	size = get_unaligned_le16(&ts->input_buf[0]);
662 	if (size == 0) {
663 		/* reset */
664 		report_id = 0;
665 		size = 2;
666 	} else {
667 		report_id = ts->input_buf[2];
668 	}
669 
670 	switch (report_id) {
671 	case HID_TOUCH_REPORT_ID:
672 		cyttsp5_mt_attention(ts->dev);
673 		break;
674 	case HID_BTN_REPORT_ID:
675 		cyttsp5_btn_attention(ts->dev);
676 		break;
677 	default:
678 		/* It is not an input but a command response */
679 		memcpy(ts->response_buf, ts->input_buf, size);
680 		complete(&ts->cmd_done);
681 	}
682 
683 	return IRQ_HANDLED;
684 }
685 
686 static int cyttsp5_deassert_int(struct cyttsp5 *ts)
687 {
688 	u16 size;
689 	u8 buf[2];
690 	int error;
691 
692 	error = regmap_bulk_read(ts->regmap, HID_INPUT_REG, buf, sizeof(buf));
693 	if (error < 0)
694 		return error;
695 
696 	size = get_unaligned_le16(&buf[0]);
697 	if (size == 2 || size == 0)
698 		return 0;
699 
700 	return -EINVAL;
701 }
702 
703 static int cyttsp5_fill_all_touch(struct cyttsp5 *ts)
704 {
705 	struct cyttsp5_sysinfo *si = &ts->sysinfo;
706 
707 	fill_tch_abs(&si->tch_abs[CY_TCH_X], REPORT_SIZE_16,
708 		     TOUCH_REPORT_DESC_X);
709 	fill_tch_abs(&si->tch_abs[CY_TCH_Y], REPORT_SIZE_16,
710 		     TOUCH_REPORT_DESC_Y);
711 	fill_tch_abs(&si->tch_abs[CY_TCH_P], REPORT_SIZE_8,
712 		     TOUCH_REPORT_DESC_P);
713 	fill_tch_abs(&si->tch_abs[CY_TCH_T], REPORT_SIZE_5,
714 		     TOUCH_REPORT_DESC_CONTACTID);
715 	fill_tch_abs(&si->tch_hdr, REPORT_SIZE_5,
716 		     TOUCH_REPORT_DESC_HDR_CONTACTCOUNT);
717 	fill_tch_abs(&si->tch_abs[CY_TCH_MAJ], REPORT_SIZE_8,
718 		     TOUCH_REPORT_DESC_MAJ);
719 	fill_tch_abs(&si->tch_abs[CY_TCH_MIN], REPORT_SIZE_8,
720 		     TOUCH_REPORT_DESC_MIN);
721 
722 	return 0;
723 }
724 
725 static int cyttsp5_startup(struct cyttsp5 *ts)
726 {
727 	int error;
728 
729 	error = cyttsp5_deassert_int(ts);
730 	if (error) {
731 		dev_err(ts->dev, "Error on deassert int r=%d\n", error);
732 		return -ENODEV;
733 	}
734 
735 	/*
736 	 * Launch the application as the device starts in bootloader mode
737 	 * because of a power-on-reset
738 	 */
739 	error = cyttsp5_hid_output_bl_launch_app(ts);
740 	if (error < 0) {
741 		dev_err(ts->dev, "Error on launch app r=%d\n", error);
742 		return error;
743 	}
744 
745 	error = cyttsp5_get_hid_descriptor(ts, &ts->hid_desc);
746 	if (error < 0) {
747 		dev_err(ts->dev, "Error on getting HID descriptor r=%d\n", error);
748 		return error;
749 	}
750 
751 	error = cyttsp5_fill_all_touch(ts);
752 	if (error < 0) {
753 		dev_err(ts->dev, "Error on report descriptor r=%d\n", error);
754 		return error;
755 	}
756 
757 	error = cyttsp5_hid_output_get_sysinfo(ts);
758 	if (error) {
759 		dev_err(ts->dev, "Error on getting sysinfo r=%d\n", error);
760 		return error;
761 	}
762 
763 	return error;
764 }
765 
766 static void cyttsp5_cleanup(void *data)
767 {
768 	struct cyttsp5 *ts = data;
769 
770 	regulator_disable(ts->vdd);
771 }
772 
773 static int cyttsp5_probe(struct device *dev, struct regmap *regmap, int irq,
774 			 const char *name)
775 {
776 	struct cyttsp5 *ts;
777 	struct cyttsp5_sysinfo *si;
778 	int error, i;
779 
780 	ts = devm_kzalloc(dev, sizeof(*ts), GFP_KERNEL);
781 	if (!ts)
782 		return -ENOMEM;
783 
784 	/* Initialize device info */
785 	ts->regmap = regmap;
786 	ts->dev = dev;
787 	si = &ts->sysinfo;
788 	dev_set_drvdata(dev, ts);
789 
790 	init_completion(&ts->cmd_done);
791 
792 	/* Power up the device */
793 	ts->vdd = devm_regulator_get(dev, "vdd");
794 	if (IS_ERR(ts->vdd)) {
795 		error = PTR_ERR(ts->vdd);
796 		return error;
797 	}
798 
799 	error = devm_add_action_or_reset(dev, cyttsp5_cleanup, ts);
800 	if (error)
801 		return error;
802 
803 	error = regulator_enable(ts->vdd);
804 	if (error)
805 		return error;
806 
807 	ts->input = devm_input_allocate_device(dev);
808 	if (!ts->input) {
809 		dev_err(dev, "Error, failed to allocate input device\n");
810 		return -ENODEV;
811 	}
812 
813 	ts->input->name = "cyttsp5";
814 	scnprintf(ts->phys, sizeof(ts->phys), "%s/input0", dev_name(dev));
815 	ts->input->phys = ts->phys;
816 	input_set_drvdata(ts->input, ts);
817 
818 	/* Reset the gpio to be in a reset state */
819 	ts->reset_gpio = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_HIGH);
820 	if (IS_ERR(ts->reset_gpio)) {
821 		error = PTR_ERR(ts->reset_gpio);
822 		dev_err(dev, "Failed to request reset gpio, error %d\n", error);
823 		return error;
824 	}
825 	gpiod_set_value_cansleep(ts->reset_gpio, 0);
826 
827 	/* Need a delay to have device up */
828 	msleep(20);
829 
830 	error = devm_request_threaded_irq(dev, irq, NULL, cyttsp5_handle_irq,
831 					  IRQF_ONESHOT, name, ts);
832 	if (error) {
833 		dev_err(dev, "unable to request IRQ\n");
834 		return error;
835 	}
836 
837 	error = cyttsp5_startup(ts);
838 	if (error) {
839 		dev_err(ts->dev, "Fail initial startup r=%d\n", error);
840 		return error;
841 	}
842 
843 	error = cyttsp5_parse_dt_key_code(dev);
844 	if (error < 0) {
845 		dev_err(ts->dev, "Error while parsing dts %d\n", error);
846 		return error;
847 	}
848 
849 	touchscreen_parse_properties(ts->input, true, &ts->prop);
850 
851 	__set_bit(EV_KEY, ts->input->evbit);
852 	for (i = 0; i < si->num_btns; i++)
853 		__set_bit(si->key_code[i], ts->input->keybit);
854 
855 	return cyttsp5_setup_input_device(dev);
856 }
857 
858 static int cyttsp5_i2c_probe(struct i2c_client *client)
859 {
860 	struct regmap *regmap;
861 	static const struct regmap_config config = {
862 		.reg_bits = 8,
863 		.val_bits = 8,
864 	};
865 
866 	regmap = devm_regmap_init_i2c(client, &config);
867 	if (IS_ERR(regmap)) {
868 		dev_err(&client->dev, "regmap allocation failed: %ld\n",
869 			PTR_ERR(regmap));
870 		return PTR_ERR(regmap);
871 	}
872 
873 	return cyttsp5_probe(&client->dev, regmap, client->irq, client->name);
874 }
875 
876 static const struct of_device_id cyttsp5_of_match[] = {
877 	{ .compatible = "cypress,tt21000", },
878 	{ }
879 };
880 MODULE_DEVICE_TABLE(of, cyttsp5_of_match);
881 
882 static const struct i2c_device_id cyttsp5_i2c_id[] = {
883 	{ CYTTSP5_NAME, 0, },
884 	{ }
885 };
886 MODULE_DEVICE_TABLE(i2c, cyttsp5_i2c_id);
887 
888 static struct i2c_driver cyttsp5_i2c_driver = {
889 	.driver = {
890 		.name = CYTTSP5_NAME,
891 		.of_match_table = cyttsp5_of_match,
892 	},
893 	.probe_new = cyttsp5_i2c_probe,
894 	.id_table = cyttsp5_i2c_id,
895 };
896 module_i2c_driver(cyttsp5_i2c_driver);
897 
898 MODULE_LICENSE("GPL");
899 MODULE_DESCRIPTION("Touchscreen driver for Cypress TrueTouch Gen 5 Product");
900 MODULE_AUTHOR("Mylène Josserand <mylene.josserand@bootlin.com>");
901