xref: /linux/drivers/input/mouse/cypress_ps2.c (revision fabcf4d8)
1d2912cb1SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
20799a924SDudley Du /*
30799a924SDudley Du  * Cypress Trackpad PS/2 mouse driver
40799a924SDudley Du  *
50799a924SDudley Du  * Copyright (c) 2012 Cypress Semiconductor Corporation.
60799a924SDudley Du  *
70799a924SDudley Du  * Author:
80799a924SDudley Du  *   Dudley Du <dudl@cypress.com>
90799a924SDudley Du  *
100799a924SDudley Du  * Additional contributors include:
110799a924SDudley Du  *   Kamal Mostafa <kamal@canonical.com>
120799a924SDudley Du  *   Kyle Fazzari <git@status.e4ward.com>
130799a924SDudley Du  */
140799a924SDudley Du 
150799a924SDudley Du #include <linux/module.h>
160799a924SDudley Du #include <linux/kernel.h>
170799a924SDudley Du #include <linux/slab.h>
180799a924SDudley Du #include <linux/serio.h>
190799a924SDudley Du #include <linux/libps2.h>
200799a924SDudley Du #include <linux/input.h>
210799a924SDudley Du #include <linux/input/mt.h>
220799a924SDudley Du #include <linux/sched.h>
230799a924SDudley Du #include <linux/wait.h>
240799a924SDudley Du 
250799a924SDudley Du #include "cypress_ps2.h"
260799a924SDudley Du 
270799a924SDudley Du #undef CYTP_DEBUG_VERBOSE  /* define this and DEBUG for more verbose dump */
280799a924SDudley Du 
cypress_set_packet_size(struct psmouse * psmouse,unsigned int n)290799a924SDudley Du static void cypress_set_packet_size(struct psmouse *psmouse, unsigned int n)
300799a924SDudley Du {
310799a924SDudley Du 	struct cytp_data *cytp = psmouse->private;
320799a924SDudley Du 	cytp->pkt_size = n;
330799a924SDudley Du }
340799a924SDudley Du 
350799a924SDudley Du static const unsigned char cytp_rate[] = {10, 20, 40, 60, 100, 200};
360799a924SDudley Du static const unsigned char cytp_resolution[] = {0x00, 0x01, 0x02, 0x03};
370799a924SDudley Du 
cypress_ps2_sendbyte(struct psmouse * psmouse,int value)380799a924SDudley Du static int cypress_ps2_sendbyte(struct psmouse *psmouse, int value)
390799a924SDudley Du {
400799a924SDudley Du 	struct ps2dev *ps2dev = &psmouse->ps2dev;
410799a924SDudley Du 
420799a924SDudley Du 	if (ps2_sendbyte(ps2dev, value & 0xff, CYTP_CMD_TIMEOUT) < 0) {
430799a924SDudley Du 		psmouse_dbg(psmouse,
440799a924SDudley Du 				"sending command 0x%02x failed, resp 0x%02x\n",
450799a924SDudley Du 				value & 0xff, ps2dev->nak);
460799a924SDudley Du 		if (ps2dev->nak == CYTP_PS2_RETRY)
470799a924SDudley Du 			return CYTP_PS2_RETRY;
480799a924SDudley Du 		else
490799a924SDudley Du 			return CYTP_PS2_ERROR;
500799a924SDudley Du 	}
510799a924SDudley Du 
520799a924SDudley Du #ifdef CYTP_DEBUG_VERBOSE
530799a924SDudley Du 	psmouse_dbg(psmouse, "sending command 0x%02x succeeded, resp 0xfa\n",
540799a924SDudley Du 			value & 0xff);
550799a924SDudley Du #endif
560799a924SDudley Du 
570799a924SDudley Du 	return 0;
580799a924SDudley Du }
590799a924SDudley Du 
cypress_ps2_ext_cmd(struct psmouse * psmouse,unsigned short cmd,unsigned char data)600799a924SDudley Du static int cypress_ps2_ext_cmd(struct psmouse *psmouse, unsigned short cmd,
610799a924SDudley Du 			       unsigned char data)
620799a924SDudley Du {
630799a924SDudley Du 	struct ps2dev *ps2dev = &psmouse->ps2dev;
640799a924SDudley Du 	int tries = CYTP_PS2_CMD_TRIES;
650799a924SDudley Du 	int rc;
660799a924SDudley Du 
670799a924SDudley Du 	ps2_begin_command(ps2dev);
680799a924SDudley Du 
690799a924SDudley Du 	do {
700799a924SDudley Du 		/*
710799a924SDudley Du 		 * Send extension command byte (0xE8 or 0xF3).
720799a924SDudley Du 		 * If sending the command fails, send recovery command
730799a924SDudley Du 		 * to make the device return to the ready state.
740799a924SDudley Du 		 */
750799a924SDudley Du 		rc = cypress_ps2_sendbyte(psmouse, cmd & 0xff);
760799a924SDudley Du 		if (rc == CYTP_PS2_RETRY) {
770799a924SDudley Du 			rc = cypress_ps2_sendbyte(psmouse, 0x00);
780799a924SDudley Du 			if (rc == CYTP_PS2_RETRY)
790799a924SDudley Du 				rc = cypress_ps2_sendbyte(psmouse, 0x0a);
800799a924SDudley Du 		}
810799a924SDudley Du 		if (rc == CYTP_PS2_ERROR)
820799a924SDudley Du 			continue;
830799a924SDudley Du 
840799a924SDudley Du 		rc = cypress_ps2_sendbyte(psmouse, data);
850799a924SDudley Du 		if (rc == CYTP_PS2_RETRY)
860799a924SDudley Du 			rc = cypress_ps2_sendbyte(psmouse, data);
870799a924SDudley Du 		if (rc == CYTP_PS2_ERROR)
880799a924SDudley Du 			continue;
890799a924SDudley Du 		else
900799a924SDudley Du 			break;
910799a924SDudley Du 	} while (--tries > 0);
920799a924SDudley Du 
930799a924SDudley Du 	ps2_end_command(ps2dev);
940799a924SDudley Du 
950799a924SDudley Du 	return rc;
960799a924SDudley Du }
970799a924SDudley Du 
cypress_ps2_read_cmd_status(struct psmouse * psmouse,unsigned char cmd,unsigned char * param)980799a924SDudley Du static int cypress_ps2_read_cmd_status(struct psmouse *psmouse,
990799a924SDudley Du 				       unsigned char cmd,
1000799a924SDudley Du 				       unsigned char *param)
1010799a924SDudley Du {
1020799a924SDudley Du 	int rc;
1030799a924SDudley Du 	struct ps2dev *ps2dev = &psmouse->ps2dev;
1040799a924SDudley Du 	enum psmouse_state old_state;
1050799a924SDudley Du 	int pktsize;
1060799a924SDudley Du 
107ad56814fSGuenter Roeck 	ps2_begin_command(ps2dev);
1080799a924SDudley Du 
1090799a924SDudley Du 	old_state = psmouse->state;
1100799a924SDudley Du 	psmouse->state = PSMOUSE_CMD_MODE;
1110799a924SDudley Du 	psmouse->pktcnt = 0;
1120799a924SDudley Du 
1130799a924SDudley Du 	pktsize = (cmd == CYTP_CMD_READ_TP_METRICS) ? 8 : 3;
1140799a924SDudley Du 	memset(param, 0, pktsize);
1150799a924SDudley Du 
1160799a924SDudley Du 	rc = cypress_ps2_sendbyte(psmouse, 0xe9);
1170799a924SDudley Du 	if (rc < 0)
1180799a924SDudley Du 		goto out;
1190799a924SDudley Du 
1200799a924SDudley Du 	wait_event_timeout(ps2dev->wait,
1210799a924SDudley Du 			(psmouse->pktcnt >= pktsize),
1220799a924SDudley Du 			msecs_to_jiffies(CYTP_CMD_TIMEOUT));
1230799a924SDudley Du 
1240799a924SDudley Du 	memcpy(param, psmouse->packet, pktsize);
1250799a924SDudley Du 
1260799a924SDudley Du 	psmouse_dbg(psmouse, "Command 0x%02x response data (0x): %*ph\n",
1270799a924SDudley Du 			cmd, pktsize, param);
1280799a924SDudley Du 
1290799a924SDudley Du out:
1300799a924SDudley Du 	psmouse->state = old_state;
1310799a924SDudley Du 	psmouse->pktcnt = 0;
1320799a924SDudley Du 
133ad56814fSGuenter Roeck 	ps2_end_command(ps2dev);
1340799a924SDudley Du 
1350799a924SDudley Du 	return rc;
1360799a924SDudley Du }
1370799a924SDudley Du 
cypress_verify_cmd_state(struct psmouse * psmouse,unsigned char cmd,unsigned char * param)1380799a924SDudley Du static bool cypress_verify_cmd_state(struct psmouse *psmouse,
1390799a924SDudley Du 				     unsigned char cmd, unsigned char *param)
1400799a924SDudley Du {
1410799a924SDudley Du 	bool rate_match = false;
1420799a924SDudley Du 	bool resolution_match = false;
1430799a924SDudley Du 	int i;
1440799a924SDudley Du 
1450799a924SDudley Du 	/* callers will do further checking. */
1460799a924SDudley Du 	if (cmd == CYTP_CMD_READ_CYPRESS_ID ||
1470799a924SDudley Du 	    cmd == CYTP_CMD_STANDARD_MODE ||
1480799a924SDudley Du 	    cmd == CYTP_CMD_READ_TP_METRICS)
1490799a924SDudley Du 		return true;
1500799a924SDudley Du 
1510799a924SDudley Du 	if ((~param[0] & DFLT_RESP_BITS_VALID) == DFLT_RESP_BITS_VALID &&
1520799a924SDudley Du 	    (param[0] & DFLT_RESP_BIT_MODE) == DFLT_RESP_STREAM_MODE) {
1530799a924SDudley Du 		for (i = 0; i < sizeof(cytp_resolution); i++)
1540799a924SDudley Du 			if (cytp_resolution[i] == param[1])
1550799a924SDudley Du 				resolution_match = true;
1560799a924SDudley Du 
1570799a924SDudley Du 		for (i = 0; i < sizeof(cytp_rate); i++)
1580799a924SDudley Du 			if (cytp_rate[i] == param[2])
1590799a924SDudley Du 				rate_match = true;
1600799a924SDudley Du 
1610799a924SDudley Du 		if (resolution_match && rate_match)
1620799a924SDudley Du 			return true;
1630799a924SDudley Du 	}
1640799a924SDudley Du 
1650799a924SDudley Du 	psmouse_dbg(psmouse, "verify cmd state failed.\n");
1660799a924SDudley Du 	return false;
1670799a924SDudley Du }
1680799a924SDudley Du 
cypress_send_ext_cmd(struct psmouse * psmouse,unsigned char cmd,unsigned char * param)1690799a924SDudley Du static int cypress_send_ext_cmd(struct psmouse *psmouse, unsigned char cmd,
1700799a924SDudley Du 				unsigned char *param)
1710799a924SDudley Du {
1720799a924SDudley Du 	int tries = CYTP_PS2_CMD_TRIES;
1730799a924SDudley Du 	int rc;
1740799a924SDudley Du 
1750799a924SDudley Du 	psmouse_dbg(psmouse, "send extension cmd 0x%02x, [%d %d %d %d]\n",
1760799a924SDudley Du 		 cmd, DECODE_CMD_AA(cmd), DECODE_CMD_BB(cmd),
1770799a924SDudley Du 		 DECODE_CMD_CC(cmd), DECODE_CMD_DD(cmd));
1780799a924SDudley Du 
1790799a924SDudley Du 	do {
1800799a924SDudley Du 		cypress_ps2_ext_cmd(psmouse,
1810799a924SDudley Du 				    PSMOUSE_CMD_SETRES, DECODE_CMD_DD(cmd));
1820799a924SDudley Du 		cypress_ps2_ext_cmd(psmouse,
1830799a924SDudley Du 				    PSMOUSE_CMD_SETRES, DECODE_CMD_CC(cmd));
1840799a924SDudley Du 		cypress_ps2_ext_cmd(psmouse,
1850799a924SDudley Du 				    PSMOUSE_CMD_SETRES, DECODE_CMD_BB(cmd));
1860799a924SDudley Du 		cypress_ps2_ext_cmd(psmouse,
1870799a924SDudley Du 				    PSMOUSE_CMD_SETRES, DECODE_CMD_AA(cmd));
1880799a924SDudley Du 
1890799a924SDudley Du 		rc = cypress_ps2_read_cmd_status(psmouse, cmd, param);
1900799a924SDudley Du 		if (rc)
1910799a924SDudley Du 			continue;
1920799a924SDudley Du 
1930799a924SDudley Du 		if (cypress_verify_cmd_state(psmouse, cmd, param))
1940799a924SDudley Du 			return 0;
1950799a924SDudley Du 
1960799a924SDudley Du 	} while (--tries > 0);
1970799a924SDudley Du 
1980799a924SDudley Du 	return -EIO;
1990799a924SDudley Du }
2000799a924SDudley Du 
cypress_detect(struct psmouse * psmouse,bool set_properties)2010799a924SDudley Du int cypress_detect(struct psmouse *psmouse, bool set_properties)
2020799a924SDudley Du {
2030799a924SDudley Du 	unsigned char param[3];
2040799a924SDudley Du 
2050799a924SDudley Du 	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_READ_CYPRESS_ID, param))
2060799a924SDudley Du 		return -ENODEV;
2070799a924SDudley Du 
2080799a924SDudley Du 	/* Check for Cypress Trackpad signature bytes: 0x33 0xCC */
2090799a924SDudley Du 	if (param[0] != 0x33 || param[1] != 0xCC)
2100799a924SDudley Du 		return -ENODEV;
2110799a924SDudley Du 
2120799a924SDudley Du 	if (set_properties) {
2130799a924SDudley Du 		psmouse->vendor = "Cypress";
2140799a924SDudley Du 		psmouse->name = "Trackpad";
2150799a924SDudley Du 	}
2160799a924SDudley Du 
2170799a924SDudley Du 	return 0;
2180799a924SDudley Du }
2190799a924SDudley Du 
cypress_read_fw_version(struct psmouse * psmouse)2200799a924SDudley Du static int cypress_read_fw_version(struct psmouse *psmouse)
2210799a924SDudley Du {
2220799a924SDudley Du 	struct cytp_data *cytp = psmouse->private;
2230799a924SDudley Du 	unsigned char param[3];
2240799a924SDudley Du 
2250799a924SDudley Du 	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_READ_CYPRESS_ID, param))
2260799a924SDudley Du 		return -ENODEV;
2270799a924SDudley Du 
2280799a924SDudley Du 	/* Check for Cypress Trackpad signature bytes: 0x33 0xCC */
2290799a924SDudley Du 	if (param[0] != 0x33 || param[1] != 0xCC)
2300799a924SDudley Du 		return -ENODEV;
2310799a924SDudley Du 
2320799a924SDudley Du 	cytp->fw_version = param[2] & FW_VERSION_MASX;
2330799a924SDudley Du 	cytp->tp_metrics_supported = (param[2] & TP_METRICS_MASK) ? 1 : 0;
2340799a924SDudley Du 
23581bb5d31SKamal Mostafa 	/*
23681bb5d31SKamal Mostafa 	 * Trackpad fw_version 11 (in Dell XPS12) yields a bogus response to
23781bb5d31SKamal Mostafa 	 * CYTP_CMD_READ_TP_METRICS so do not try to use it. LP: #1103594.
23881bb5d31SKamal Mostafa 	 */
23981bb5d31SKamal Mostafa 	if (cytp->fw_version >= 11)
24081bb5d31SKamal Mostafa 		cytp->tp_metrics_supported = 0;
24181bb5d31SKamal Mostafa 
2420799a924SDudley Du 	psmouse_dbg(psmouse, "cytp->fw_version = %d\n", cytp->fw_version);
2430799a924SDudley Du 	psmouse_dbg(psmouse, "cytp->tp_metrics_supported = %d\n",
2440799a924SDudley Du 		 cytp->tp_metrics_supported);
2450799a924SDudley Du 
2460799a924SDudley Du 	return 0;
2470799a924SDudley Du }
2480799a924SDudley Du 
cypress_read_tp_metrics(struct psmouse * psmouse)2490799a924SDudley Du static int cypress_read_tp_metrics(struct psmouse *psmouse)
2500799a924SDudley Du {
2510799a924SDudley Du 	struct cytp_data *cytp = psmouse->private;
2520799a924SDudley Du 	unsigned char param[8];
2530799a924SDudley Du 
2540799a924SDudley Du 	/* set default values for tp metrics. */
2550799a924SDudley Du 	cytp->tp_width = CYTP_DEFAULT_WIDTH;
2560799a924SDudley Du 	cytp->tp_high = CYTP_DEFAULT_HIGH;
2570799a924SDudley Du 	cytp->tp_max_abs_x = CYTP_ABS_MAX_X;
2580799a924SDudley Du 	cytp->tp_max_abs_y = CYTP_ABS_MAX_Y;
2590799a924SDudley Du 	cytp->tp_min_pressure = CYTP_MIN_PRESSURE;
2600799a924SDudley Du 	cytp->tp_max_pressure = CYTP_MAX_PRESSURE;
2610799a924SDudley Du 	cytp->tp_res_x = cytp->tp_max_abs_x / cytp->tp_width;
2620799a924SDudley Du 	cytp->tp_res_y = cytp->tp_max_abs_y / cytp->tp_high;
2630799a924SDudley Du 
26481bb5d31SKamal Mostafa 	if (!cytp->tp_metrics_supported)
26581bb5d31SKamal Mostafa 		return 0;
26681bb5d31SKamal Mostafa 
2670799a924SDudley Du 	memset(param, 0, sizeof(param));
2680799a924SDudley Du 	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_READ_TP_METRICS, param) == 0) {
2690799a924SDudley Du 		/* Update trackpad parameters. */
2700799a924SDudley Du 		cytp->tp_max_abs_x = (param[1] << 8) | param[0];
2710799a924SDudley Du 		cytp->tp_max_abs_y = (param[3] << 8) | param[2];
2720799a924SDudley Du 		cytp->tp_min_pressure = param[4];
2730799a924SDudley Du 		cytp->tp_max_pressure = param[5];
2740799a924SDudley Du 	}
2750799a924SDudley Du 
2760799a924SDudley Du 	if (!cytp->tp_max_pressure ||
2770799a924SDudley Du 	    cytp->tp_max_pressure < cytp->tp_min_pressure ||
2780799a924SDudley Du 	    !cytp->tp_width || !cytp->tp_high ||
2790799a924SDudley Du 	    !cytp->tp_max_abs_x ||
2800799a924SDudley Du 	    cytp->tp_max_abs_x < cytp->tp_width ||
2810799a924SDudley Du 	    !cytp->tp_max_abs_y ||
2820799a924SDudley Du 	    cytp->tp_max_abs_y < cytp->tp_high)
2830799a924SDudley Du 		return -EINVAL;
2840799a924SDudley Du 
2850799a924SDudley Du 	cytp->tp_res_x = cytp->tp_max_abs_x / cytp->tp_width;
2860799a924SDudley Du 	cytp->tp_res_y = cytp->tp_max_abs_y / cytp->tp_high;
2870799a924SDudley Du 
2880799a924SDudley Du #ifdef CYTP_DEBUG_VERBOSE
2890799a924SDudley Du 	psmouse_dbg(psmouse, "Dump trackpad hardware configuration as below:\n");
2900799a924SDudley Du 	psmouse_dbg(psmouse, "cytp->tp_width = %d\n", cytp->tp_width);
2910799a924SDudley Du 	psmouse_dbg(psmouse, "cytp->tp_high = %d\n", cytp->tp_high);
2920799a924SDudley Du 	psmouse_dbg(psmouse, "cytp->tp_max_abs_x = %d\n", cytp->tp_max_abs_x);
2930799a924SDudley Du 	psmouse_dbg(psmouse, "cytp->tp_max_abs_y = %d\n", cytp->tp_max_abs_y);
2940799a924SDudley Du 	psmouse_dbg(psmouse, "cytp->tp_min_pressure = %d\n", cytp->tp_min_pressure);
2950799a924SDudley Du 	psmouse_dbg(psmouse, "cytp->tp_max_pressure = %d\n", cytp->tp_max_pressure);
2960799a924SDudley Du 	psmouse_dbg(psmouse, "cytp->tp_res_x = %d\n", cytp->tp_res_x);
2970799a924SDudley Du 	psmouse_dbg(psmouse, "cytp->tp_res_y = %d\n", cytp->tp_res_y);
2980799a924SDudley Du 
2990799a924SDudley Du 	psmouse_dbg(psmouse, "tp_type_APA = %d\n",
3000799a924SDudley Du 			(param[6] & TP_METRICS_BIT_APA) ? 1 : 0);
3010799a924SDudley Du 	psmouse_dbg(psmouse, "tp_type_MTG = %d\n",
3020799a924SDudley Du 			(param[6] & TP_METRICS_BIT_MTG) ? 1 : 0);
3030799a924SDudley Du 	psmouse_dbg(psmouse, "tp_palm = %d\n",
3040799a924SDudley Du 			(param[6] & TP_METRICS_BIT_PALM) ? 1 : 0);
3050799a924SDudley Du 	psmouse_dbg(psmouse, "tp_stubborn = %d\n",
3060799a924SDudley Du 			(param[6] & TP_METRICS_BIT_STUBBORN) ? 1 : 0);
3070799a924SDudley Du 	psmouse_dbg(psmouse, "tp_1f_jitter = %d\n",
3080799a924SDudley Du 			(param[6] & TP_METRICS_BIT_1F_JITTER) >> 2);
3090799a924SDudley Du 	psmouse_dbg(psmouse, "tp_2f_jitter = %d\n",
3100799a924SDudley Du 			(param[6] & TP_METRICS_BIT_2F_JITTER) >> 4);
3110799a924SDudley Du 	psmouse_dbg(psmouse, "tp_1f_spike = %d\n",
3120799a924SDudley Du 			param[7] & TP_METRICS_BIT_1F_SPIKE);
3130799a924SDudley Du 	psmouse_dbg(psmouse, "tp_2f_spike = %d\n",
3140799a924SDudley Du 			(param[7] & TP_METRICS_BIT_2F_SPIKE) >> 2);
3150799a924SDudley Du 	psmouse_dbg(psmouse, "tp_abs_packet_format_set = %d\n",
3160799a924SDudley Du 			(param[7] & TP_METRICS_BIT_ABS_PKT_FORMAT_SET) >> 4);
3170799a924SDudley Du #endif
3180799a924SDudley Du 
3190799a924SDudley Du 	return 0;
3200799a924SDudley Du }
3210799a924SDudley Du 
cypress_query_hardware(struct psmouse * psmouse)3220799a924SDudley Du static int cypress_query_hardware(struct psmouse *psmouse)
3230799a924SDudley Du {
3240799a924SDudley Du 	int ret;
3250799a924SDudley Du 
3260799a924SDudley Du 	ret = cypress_read_fw_version(psmouse);
3270799a924SDudley Du 	if (ret)
3280799a924SDudley Du 		return ret;
3290799a924SDudley Du 
3300799a924SDudley Du 	ret = cypress_read_tp_metrics(psmouse);
3310799a924SDudley Du 	if (ret)
3320799a924SDudley Du 		return ret;
3330799a924SDudley Du 
3340799a924SDudley Du 	return 0;
3350799a924SDudley Du }
3360799a924SDudley Du 
cypress_set_absolute_mode(struct psmouse * psmouse)3370799a924SDudley Du static int cypress_set_absolute_mode(struct psmouse *psmouse)
3380799a924SDudley Du {
3390799a924SDudley Du 	struct cytp_data *cytp = psmouse->private;
3400799a924SDudley Du 	unsigned char param[3];
3410799a924SDudley Du 
3420799a924SDudley Du 	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_ABS_WITH_PRESSURE_MODE, param) < 0)
3430799a924SDudley Du 		return -1;
3440799a924SDudley Du 
3450799a924SDudley Du 	cytp->mode = (cytp->mode & ~CYTP_BIT_ABS_REL_MASK)
3460799a924SDudley Du 			| CYTP_BIT_ABS_PRESSURE;
3470799a924SDudley Du 	cypress_set_packet_size(psmouse, 5);
3480799a924SDudley Du 
3490799a924SDudley Du 	return 0;
3500799a924SDudley Du }
3510799a924SDudley Du 
3520799a924SDudley Du /*
3530799a924SDudley Du  * Reset trackpad device.
3540799a924SDudley Du  * This is also the default mode when trackpad powered on.
3550799a924SDudley Du  */
cypress_reset(struct psmouse * psmouse)3560799a924SDudley Du static void cypress_reset(struct psmouse *psmouse)
3570799a924SDudley Du {
3580799a924SDudley Du 	struct cytp_data *cytp = psmouse->private;
3590799a924SDudley Du 
3600799a924SDudley Du 	cytp->mode = 0;
3610799a924SDudley Du 
3620799a924SDudley Du 	psmouse_reset(psmouse);
3630799a924SDudley Du }
3640799a924SDudley Du 
cypress_set_input_params(struct input_dev * input,struct cytp_data * cytp)3650799a924SDudley Du static int cypress_set_input_params(struct input_dev *input,
3660799a924SDudley Du 				    struct cytp_data *cytp)
3670799a924SDudley Du {
3680799a924SDudley Du 	int ret;
3690799a924SDudley Du 
3700799a924SDudley Du 	if (!cytp->tp_res_x || !cytp->tp_res_y)
3710799a924SDudley Du 		return -EINVAL;
3720799a924SDudley Du 
3730799a924SDudley Du 	__set_bit(EV_ABS, input->evbit);
3740799a924SDudley Du 	input_set_abs_params(input, ABS_X, 0, cytp->tp_max_abs_x, 0, 0);
3750799a924SDudley Du 	input_set_abs_params(input, ABS_Y, 0, cytp->tp_max_abs_y, 0, 0);
3760799a924SDudley Du 	input_set_abs_params(input, ABS_PRESSURE,
3770799a924SDudley Du 			     cytp->tp_min_pressure, cytp->tp_max_pressure, 0, 0);
3780799a924SDudley Du 	input_set_abs_params(input, ABS_TOOL_WIDTH, 0, 255, 0, 0);
3790799a924SDudley Du 
3800799a924SDudley Du 	/* finger position */
3810799a924SDudley Du 	input_set_abs_params(input, ABS_MT_POSITION_X, 0, cytp->tp_max_abs_x, 0, 0);
3820799a924SDudley Du 	input_set_abs_params(input, ABS_MT_POSITION_Y, 0, cytp->tp_max_abs_y, 0, 0);
3830799a924SDudley Du 	input_set_abs_params(input, ABS_MT_PRESSURE, 0, 255, 0, 0);
3840799a924SDudley Du 
3850799a924SDudley Du 	ret = input_mt_init_slots(input, CYTP_MAX_MT_SLOTS,
3860799a924SDudley Du 			INPUT_MT_DROP_UNUSED|INPUT_MT_TRACK);
3870799a924SDudley Du 	if (ret < 0)
3880799a924SDudley Du 		return ret;
3890799a924SDudley Du 
3900799a924SDudley Du 	__set_bit(INPUT_PROP_SEMI_MT, input->propbit);
3910799a924SDudley Du 
3920799a924SDudley Du 	input_abs_set_res(input, ABS_X, cytp->tp_res_x);
3930799a924SDudley Du 	input_abs_set_res(input, ABS_Y, cytp->tp_res_y);
3940799a924SDudley Du 
3950799a924SDudley Du 	input_abs_set_res(input, ABS_MT_POSITION_X, cytp->tp_res_x);
3960799a924SDudley Du 	input_abs_set_res(input, ABS_MT_POSITION_Y, cytp->tp_res_y);
3970799a924SDudley Du 
3980799a924SDudley Du 	__set_bit(BTN_TOUCH, input->keybit);
3990799a924SDudley Du 	__set_bit(BTN_TOOL_FINGER, input->keybit);
4000799a924SDudley Du 	__set_bit(BTN_TOOL_DOUBLETAP, input->keybit);
4010799a924SDudley Du 	__set_bit(BTN_TOOL_TRIPLETAP, input->keybit);
4020799a924SDudley Du 	__set_bit(BTN_TOOL_QUADTAP, input->keybit);
4030799a924SDudley Du 	__set_bit(BTN_TOOL_QUINTTAP, input->keybit);
4040799a924SDudley Du 
4050799a924SDudley Du 	__clear_bit(EV_REL, input->evbit);
4060799a924SDudley Du 	__clear_bit(REL_X, input->relbit);
4070799a924SDudley Du 	__clear_bit(REL_Y, input->relbit);
4080799a924SDudley Du 
4090799a924SDudley Du 	__set_bit(EV_KEY, input->evbit);
4100799a924SDudley Du 	__set_bit(BTN_LEFT, input->keybit);
4110799a924SDudley Du 	__set_bit(BTN_RIGHT, input->keybit);
4120799a924SDudley Du 	__set_bit(BTN_MIDDLE, input->keybit);
4130799a924SDudley Du 
4140799a924SDudley Du 	return 0;
4150799a924SDudley Du }
4160799a924SDudley Du 
cypress_get_finger_count(unsigned char header_byte)4170799a924SDudley Du static int cypress_get_finger_count(unsigned char header_byte)
4180799a924SDudley Du {
4190799a924SDudley Du 	unsigned char bits6_7;
4200799a924SDudley Du 	int finger_count;
4210799a924SDudley Du 
4220799a924SDudley Du 	bits6_7 = header_byte >> 6;
4230799a924SDudley Du 	finger_count = bits6_7 & 0x03;
4240799a924SDudley Du 
4250799a924SDudley Du 	if (finger_count == 1)
4260799a924SDudley Du 		return 1;
4270799a924SDudley Du 
4280799a924SDudley Du 	if (header_byte & ABS_HSCROLL_BIT) {
4290799a924SDudley Du 		/* HSCROLL gets added on to 0 finger count. */
4300799a924SDudley Du 		switch (finger_count) {
4310799a924SDudley Du 			case 0:	return 4;
4320799a924SDudley Du 			case 2: return 5;
4330799a924SDudley Du 			default:
4340799a924SDudley Du 				/* Invalid contact (e.g. palm). Ignore it. */
4355df682b2SJoseph Salisbury 				return 0;
4360799a924SDudley Du 		}
4370799a924SDudley Du 	}
4380799a924SDudley Du 
4390799a924SDudley Du 	return finger_count;
4400799a924SDudley Du }
4410799a924SDudley Du 
4420799a924SDudley Du 
cypress_parse_packet(struct psmouse * psmouse,struct cytp_data * cytp,struct cytp_report_data * report_data)4430799a924SDudley Du static int cypress_parse_packet(struct psmouse *psmouse,
4440799a924SDudley Du 				struct cytp_data *cytp, struct cytp_report_data *report_data)
4450799a924SDudley Du {
4460799a924SDudley Du 	unsigned char *packet = psmouse->packet;
4470799a924SDudley Du 	unsigned char header_byte = packet[0];
4480799a924SDudley Du 
4490799a924SDudley Du 	memset(report_data, 0, sizeof(struct cytp_report_data));
4500799a924SDudley Du 
4515df682b2SJoseph Salisbury 	report_data->contact_cnt = cypress_get_finger_count(header_byte);
4520799a924SDudley Du 	report_data->tap = (header_byte & ABS_MULTIFINGER_TAP) ? 1 : 0;
4530799a924SDudley Du 
4540799a924SDudley Du 	if (report_data->contact_cnt == 1) {
4550799a924SDudley Du 		report_data->contacts[0].x =
4560799a924SDudley Du 			((packet[1] & 0x70) << 4) | packet[2];
4570799a924SDudley Du 		report_data->contacts[0].y =
4580799a924SDudley Du 			((packet[1] & 0x07) << 8) | packet[3];
4590799a924SDudley Du 		if (cytp->mode & CYTP_BIT_ABS_PRESSURE)
4600799a924SDudley Du 			report_data->contacts[0].z = packet[4];
4610799a924SDudley Du 
4620799a924SDudley Du 	} else if (report_data->contact_cnt >= 2) {
4630799a924SDudley Du 		report_data->contacts[0].x =
4640799a924SDudley Du 			((packet[1] & 0x70) << 4) | packet[2];
4650799a924SDudley Du 		report_data->contacts[0].y =
4660799a924SDudley Du 			((packet[1] & 0x07) << 8) | packet[3];
4670799a924SDudley Du 		if (cytp->mode & CYTP_BIT_ABS_PRESSURE)
4680799a924SDudley Du 			report_data->contacts[0].z = packet[4];
4690799a924SDudley Du 
4700799a924SDudley Du 		report_data->contacts[1].x =
4710799a924SDudley Du 			((packet[5] & 0xf0) << 4) | packet[6];
4720799a924SDudley Du 		report_data->contacts[1].y =
4730799a924SDudley Du 			((packet[5] & 0x0f) << 8) | packet[7];
4740799a924SDudley Du 		if (cytp->mode & CYTP_BIT_ABS_PRESSURE)
4750799a924SDudley Du 			report_data->contacts[1].z = report_data->contacts[0].z;
4760799a924SDudley Du 	}
4770799a924SDudley Du 
4780799a924SDudley Du 	report_data->left = (header_byte & BTN_LEFT_BIT) ? 1 : 0;
4790799a924SDudley Du 	report_data->right = (header_byte & BTN_RIGHT_BIT) ? 1 : 0;
4800799a924SDudley Du 
4810799a924SDudley Du 	/*
4820799a924SDudley Du 	 * This is only true if one of the mouse buttons were tapped.  Make
4830799a924SDudley Du 	 * sure it doesn't turn into a click. The regular tap-to-click
4840799a924SDudley Du 	 * functionality will handle that on its own. If we don't do this,
4850799a924SDudley Du 	 * disabling tap-to-click won't affect the mouse button zones.
4860799a924SDudley Du 	 */
4870799a924SDudley Du 	if (report_data->tap)
4880799a924SDudley Du 		report_data->left = 0;
4890799a924SDudley Du 
4900799a924SDudley Du #ifdef CYTP_DEBUG_VERBOSE
4910799a924SDudley Du 	{
4920799a924SDudley Du 		int i;
4930799a924SDudley Du 		int n = report_data->contact_cnt;
4940799a924SDudley Du 		psmouse_dbg(psmouse, "Dump parsed report data as below:\n");
4950799a924SDudley Du 		psmouse_dbg(psmouse, "contact_cnt = %d\n",
4960799a924SDudley Du 			report_data->contact_cnt);
4970799a924SDudley Du 		if (n > CYTP_MAX_MT_SLOTS)
4980799a924SDudley Du 		    n = CYTP_MAX_MT_SLOTS;
4990799a924SDudley Du 		for (i = 0; i < n; i++)
5000799a924SDudley Du 			psmouse_dbg(psmouse, "contacts[%d] = {%d, %d, %d}\n", i,
5010799a924SDudley Du 					report_data->contacts[i].x,
5020799a924SDudley Du 					report_data->contacts[i].y,
5030799a924SDudley Du 					report_data->contacts[i].z);
5040799a924SDudley Du 		psmouse_dbg(psmouse, "left = %d\n", report_data->left);
5050799a924SDudley Du 		psmouse_dbg(psmouse, "right = %d\n", report_data->right);
5060799a924SDudley Du 		psmouse_dbg(psmouse, "middle = %d\n", report_data->middle);
5070799a924SDudley Du 	}
5080799a924SDudley Du #endif
5090799a924SDudley Du 
5100799a924SDudley Du 	return 0;
5110799a924SDudley Du }
5120799a924SDudley Du 
cypress_process_packet(struct psmouse * psmouse,bool zero_pkt)5130799a924SDudley Du static void cypress_process_packet(struct psmouse *psmouse, bool zero_pkt)
5140799a924SDudley Du {
5150799a924SDudley Du 	int i;
5160799a924SDudley Du 	struct input_dev *input = psmouse->dev;
5170799a924SDudley Du 	struct cytp_data *cytp = psmouse->private;
5180799a924SDudley Du 	struct cytp_report_data report_data;
5190799a924SDudley Du 	struct cytp_contact *contact;
5200799a924SDudley Du 	struct input_mt_pos pos[CYTP_MAX_MT_SLOTS];
5210799a924SDudley Du 	int slots[CYTP_MAX_MT_SLOTS];
5220799a924SDudley Du 	int n;
5230799a924SDudley Du 
5245df682b2SJoseph Salisbury 	cypress_parse_packet(psmouse, cytp, &report_data);
5250799a924SDudley Du 
5260799a924SDudley Du 	n = report_data.contact_cnt;
5270799a924SDudley Du 	if (n > CYTP_MAX_MT_SLOTS)
5280799a924SDudley Du 		n = CYTP_MAX_MT_SLOTS;
5290799a924SDudley Du 
5300799a924SDudley Du 	for (i = 0; i < n; i++) {
5310799a924SDudley Du 		contact = &report_data.contacts[i];
5320799a924SDudley Du 		pos[i].x = contact->x;
5330799a924SDudley Du 		pos[i].y = contact->y;
5340799a924SDudley Du 	}
5350799a924SDudley Du 
536448c7f38SHenrik Rydberg 	input_mt_assign_slots(input, slots, pos, n, 0);
5370799a924SDudley Du 
5380799a924SDudley Du 	for (i = 0; i < n; i++) {
5390799a924SDudley Du 		contact = &report_data.contacts[i];
5400799a924SDudley Du 		input_mt_slot(input, slots[i]);
5410799a924SDudley Du 		input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
5420799a924SDudley Du 		input_report_abs(input, ABS_MT_POSITION_X, contact->x);
5430799a924SDudley Du 		input_report_abs(input, ABS_MT_POSITION_Y, contact->y);
5440799a924SDudley Du 		input_report_abs(input, ABS_MT_PRESSURE, contact->z);
5450799a924SDudley Du 	}
5460799a924SDudley Du 
5470799a924SDudley Du 	input_mt_sync_frame(input);
5480799a924SDudley Du 
5490799a924SDudley Du 	input_mt_report_finger_count(input, report_data.contact_cnt);
5500799a924SDudley Du 
5510799a924SDudley Du 	input_report_key(input, BTN_LEFT, report_data.left);
5520799a924SDudley Du 	input_report_key(input, BTN_RIGHT, report_data.right);
5530799a924SDudley Du 	input_report_key(input, BTN_MIDDLE, report_data.middle);
5540799a924SDudley Du 
5550799a924SDudley Du 	input_sync(input);
5560799a924SDudley Du }
5570799a924SDudley Du 
cypress_validate_byte(struct psmouse * psmouse)5580799a924SDudley Du static psmouse_ret_t cypress_validate_byte(struct psmouse *psmouse)
5590799a924SDudley Du {
5600799a924SDudley Du 	int contact_cnt;
5610799a924SDudley Du 	int index = psmouse->pktcnt - 1;
5620799a924SDudley Du 	unsigned char *packet = psmouse->packet;
5630799a924SDudley Du 	struct cytp_data *cytp = psmouse->private;
5640799a924SDudley Du 
5650799a924SDudley Du 	if (index < 0 || index > cytp->pkt_size)
5660799a924SDudley Du 		return PSMOUSE_BAD_DATA;
5670799a924SDudley Du 
5680799a924SDudley Du 	if (index == 0 && (packet[0] & 0xfc) == 0) {
5690799a924SDudley Du 		/* call packet process for reporting finger leave. */
5700799a924SDudley Du 		cypress_process_packet(psmouse, 1);
5710799a924SDudley Du 		return PSMOUSE_FULL_PACKET;
5720799a924SDudley Du 	}
5730799a924SDudley Du 
5740799a924SDudley Du 	/*
5750799a924SDudley Du 	 * Perform validation (and adjust packet size) based only on the
5760799a924SDudley Du 	 * first byte; allow all further bytes through.
5770799a924SDudley Du 	 */
5780799a924SDudley Du 	if (index != 0)
5790799a924SDudley Du 		return PSMOUSE_GOOD_DATA;
5800799a924SDudley Du 
5810799a924SDudley Du 	/*
5820799a924SDudley Du 	 * If absolute/relative mode bit has not been set yet, just pass
5830799a924SDudley Du 	 * the byte through.
5840799a924SDudley Du 	 */
5850799a924SDudley Du 	if ((cytp->mode & CYTP_BIT_ABS_REL_MASK) == 0)
5860799a924SDudley Du 		return PSMOUSE_GOOD_DATA;
5870799a924SDudley Du 
5880799a924SDudley Du 	if ((packet[0] & 0x08) == 0x08)
5890799a924SDudley Du 		return PSMOUSE_BAD_DATA;
5900799a924SDudley Du 
5910799a924SDudley Du 	contact_cnt = cypress_get_finger_count(packet[0]);
5920799a924SDudley Du 	if (cytp->mode & CYTP_BIT_ABS_NO_PRESSURE)
5930799a924SDudley Du 		cypress_set_packet_size(psmouse, contact_cnt == 2 ? 7 : 4);
5940799a924SDudley Du 	else
5950799a924SDudley Du 		cypress_set_packet_size(psmouse, contact_cnt == 2 ? 8 : 5);
5960799a924SDudley Du 
5970799a924SDudley Du 	return PSMOUSE_GOOD_DATA;
5980799a924SDudley Du }
5990799a924SDudley Du 
cypress_protocol_handler(struct psmouse * psmouse)6000799a924SDudley Du static psmouse_ret_t cypress_protocol_handler(struct psmouse *psmouse)
6010799a924SDudley Du {
6020799a924SDudley Du 	struct cytp_data *cytp = psmouse->private;
6030799a924SDudley Du 
6040799a924SDudley Du 	if (psmouse->pktcnt >= cytp->pkt_size) {
6050799a924SDudley Du 		cypress_process_packet(psmouse, 0);
6060799a924SDudley Du 		return PSMOUSE_FULL_PACKET;
6070799a924SDudley Du 	}
6080799a924SDudley Du 
6090799a924SDudley Du 	return cypress_validate_byte(psmouse);
6100799a924SDudley Du }
6110799a924SDudley Du 
cypress_set_rate(struct psmouse * psmouse,unsigned int rate)6120799a924SDudley Du static void cypress_set_rate(struct psmouse *psmouse, unsigned int rate)
6130799a924SDudley Du {
6140799a924SDudley Du 	struct cytp_data *cytp = psmouse->private;
6150799a924SDudley Du 
6160799a924SDudley Du 	if (rate >= 80) {
6170799a924SDudley Du 		psmouse->rate = 80;
6180799a924SDudley Du 		cytp->mode |= CYTP_BIT_HIGH_RATE;
6190799a924SDudley Du 	} else {
6200799a924SDudley Du 		psmouse->rate = 40;
6210799a924SDudley Du 		cytp->mode &= ~CYTP_BIT_HIGH_RATE;
6220799a924SDudley Du 	}
6230799a924SDudley Du 
6240799a924SDudley Du 	ps2_command(&psmouse->ps2dev, (unsigned char *)&psmouse->rate,
6250799a924SDudley Du 		    PSMOUSE_CMD_SETRATE);
6260799a924SDudley Du }
6270799a924SDudley Du 
cypress_disconnect(struct psmouse * psmouse)6280799a924SDudley Du static void cypress_disconnect(struct psmouse *psmouse)
6290799a924SDudley Du {
6300799a924SDudley Du 	cypress_reset(psmouse);
6310799a924SDudley Du 	kfree(psmouse->private);
6320799a924SDudley Du 	psmouse->private = NULL;
6330799a924SDudley Du }
6340799a924SDudley Du 
cypress_reconnect(struct psmouse * psmouse)6350799a924SDudley Du static int cypress_reconnect(struct psmouse *psmouse)
6360799a924SDudley Du {
6370799a924SDudley Du 	int tries = CYTP_PS2_CMD_TRIES;
6380799a924SDudley Du 	int rc;
6390799a924SDudley Du 
6400799a924SDudley Du 	do {
6410799a924SDudley Du 		cypress_reset(psmouse);
6420799a924SDudley Du 		rc = cypress_detect(psmouse, false);
6430799a924SDudley Du 	} while (rc && (--tries > 0));
6440799a924SDudley Du 
6450799a924SDudley Du 	if (rc) {
6460799a924SDudley Du 		psmouse_err(psmouse, "Reconnect: unable to detect trackpad.\n");
6470799a924SDudley Du 		return -1;
6480799a924SDudley Du 	}
6490799a924SDudley Du 
6500799a924SDudley Du 	if (cypress_set_absolute_mode(psmouse)) {
6510799a924SDudley Du 		psmouse_err(psmouse, "Reconnect: Unable to initialize Cypress absolute mode.\n");
6520799a924SDudley Du 		return -1;
6530799a924SDudley Du 	}
6540799a924SDudley Du 
6550799a924SDudley Du 	return 0;
6560799a924SDudley Du }
6570799a924SDudley Du 
cypress_init(struct psmouse * psmouse)6580799a924SDudley Du int cypress_init(struct psmouse *psmouse)
6590799a924SDudley Du {
6600799a924SDudley Du 	struct cytp_data *cytp;
6610799a924SDudley Du 
662221a27c2SJingoo Han 	cytp = kzalloc(sizeof(struct cytp_data), GFP_KERNEL);
663c2e60959SGeyslan G. Bem 	if (!cytp)
6640799a924SDudley Du 		return -ENOMEM;
6650799a924SDudley Du 
666c2e60959SGeyslan G. Bem 	psmouse->private = cytp;
6670799a924SDudley Du 	psmouse->pktsize = 8;
6680799a924SDudley Du 
669c2e60959SGeyslan G. Bem 	cypress_reset(psmouse);
670c2e60959SGeyslan G. Bem 
6710799a924SDudley Du 	if (cypress_query_hardware(psmouse)) {
6720799a924SDudley Du 		psmouse_err(psmouse, "Unable to query Trackpad hardware.\n");
6730799a924SDudley Du 		goto err_exit;
6740799a924SDudley Du 	}
6750799a924SDudley Du 
6760799a924SDudley Du 	if (cypress_set_absolute_mode(psmouse)) {
6770799a924SDudley Du 		psmouse_err(psmouse, "init: Unable to initialize Cypress absolute mode.\n");
6780799a924SDudley Du 		goto err_exit;
6790799a924SDudley Du 	}
6800799a924SDudley Du 
6810799a924SDudley Du 	if (cypress_set_input_params(psmouse->dev, cytp) < 0) {
6820799a924SDudley Du 		psmouse_err(psmouse, "init: Unable to set input params.\n");
6830799a924SDudley Du 		goto err_exit;
6840799a924SDudley Du 	}
6850799a924SDudley Du 
6860799a924SDudley Du 	psmouse->model = 1;
6870799a924SDudley Du 	psmouse->protocol_handler = cypress_protocol_handler;
6880799a924SDudley Du 	psmouse->set_rate = cypress_set_rate;
6890799a924SDudley Du 	psmouse->disconnect = cypress_disconnect;
6900799a924SDudley Du 	psmouse->reconnect = cypress_reconnect;
6910799a924SDudley Du 	psmouse->cleanup = cypress_reset;
6920799a924SDudley Du 	psmouse->resync_time = 0;
6930799a924SDudley Du 
6940799a924SDudley Du 	return 0;
6950799a924SDudley Du 
6960799a924SDudley Du err_exit:
6970799a924SDudley Du 	/*
6980799a924SDudley Du 	 * Reset Cypress Trackpad as a standard mouse. Then
699fabcf4d8SJulia Lawall 	 * let psmouse driver communicating with it as default PS2 mouse.
7000799a924SDudley Du 	 */
7010799a924SDudley Du 	cypress_reset(psmouse);
7020799a924SDudley Du 
7030799a924SDudley Du 	psmouse->private = NULL;
7040799a924SDudley Du 	kfree(cytp);
7050799a924SDudley Du 
7060799a924SDudley Du 	return -1;
7070799a924SDudley Du }
708