diff mbox

[v5,2/3] input: Cypress PS/2 Trackpad psmouse driver

Message ID 1354752976-27257-3-git-send-email-kamal@canonical.com (mailing list archive)
State New, archived
Headers show

Commit Message

Kamal Mostafa Dec. 6, 2012, 12:16 a.m. UTC
From: Dudley Du <dudl@cypress.com>

Input/mouse driver for Cypress PS/2 Trackpad.

Original code contributed by Dudley Du (Cypress Semiconductor Corporation),
modified by Kamal Mostafa and Kyle Fazzari.

BugLink: http://launchpad.net/bugs/978807

Signed-off-by: Dudley Du <dudl@cypress.com>
Signed-off-by: Kamal Mostafa <kamal@canonical.com>
Signed-off-by: Kyle Fazzari <git@status.e4ward.com>
Signed-off-by: Mario Limonciello <mario_limonciello@dell.com>
Signed-off-by: Tim Gardner <tim.gardner@canonical.com>
Acked-by: Herton Krzesinski <herton.krzesinski@canonical.com>
---
 drivers/input/mouse/cypress_ps2.c |  740 +++++++++++++++++++++++++++++++++++++
 drivers/input/mouse/cypress_ps2.h |  216 +++++++++++
 2 files changed, 956 insertions(+)
 create mode 100644 drivers/input/mouse/cypress_ps2.c
 create mode 100644 drivers/input/mouse/cypress_ps2.h

Comments

Dmitry Torokhov Dec. 6, 2012, 8:08 a.m. UTC | #1
Hi Kamal,

On Wed, Dec 05, 2012 at 04:16:15PM -0800, Kamal Mostafa wrote:
> From: Dudley Du <dudl@cypress.com>
> 
> Input/mouse driver for Cypress PS/2 Trackpad.
> 
> Original code contributed by Dudley Du (Cypress Semiconductor Corporation),
> modified by Kamal Mostafa and Kyle Fazzari.
> 
> BugLink: http://launchpad.net/bugs/978807
> 
> Signed-off-by: Dudley Du <dudl@cypress.com>
> Signed-off-by: Kamal Mostafa <kamal@canonical.com>
> Signed-off-by: Kyle Fazzari <git@status.e4ward.com>
> Signed-off-by: Mario Limonciello <mario_limonciello@dell.com>
> Signed-off-by: Tim Gardner <tim.gardner@canonical.com>
> Acked-by: Herton Krzesinski <herton.krzesinski@canonical.com>
> ---
>  drivers/input/mouse/cypress_ps2.c |  740 +++++++++++++++++++++++++++++++++++++
>  drivers/input/mouse/cypress_ps2.h |  216 +++++++++++
>  2 files changed, 956 insertions(+)
>  create mode 100644 drivers/input/mouse/cypress_ps2.c
>  create mode 100644 drivers/input/mouse/cypress_ps2.h
> 
> diff --git a/drivers/input/mouse/cypress_ps2.c b/drivers/input/mouse/cypress_ps2.c
> new file mode 100644
> index 0000000..02c4c61
> --- /dev/null
> +++ b/drivers/input/mouse/cypress_ps2.c
> @@ -0,0 +1,740 @@
> +/*
> + * Cypress Trackpad PS/2 mouse driver
> + *
> + * Copyright (c) 2012 Cypress Semiconductor Corporation.
> + *
> + * Author:
> + *   Dudley Du <dudl@cypress.com>
> + *
> + * Additional contributors include:
> + *   Kamal Mostafa <kamal@canonical.com>
> + *   Kyle Fazzari <git@status.e4ward.com>
> + *
> + * This program is free software; you can redistribute it and/or modify it
> + * under the terms of the GNU General Public License version 2 as published by
> + * the Free Software Foundation.
> + */
> +
> +#include <linux/init.h>
> +#include <linux/module.h>
> +#include <linux/kernel.h>
> +#include <linux/slab.h>
> +#include <linux/serio.h>
> +#include <linux/libps2.h>
> +#include <linux/input.h>
> +#include <linux/input/mt.h>
> +#include <linux/sched.h>
> +#include <linux/wait.h>
> +
> +#include "cypress_ps2.h"
> +
> +#undef CYTP_DEBUG_VERBOSE  /* define this and DEBUG for more verbose dump */
> +
> +#define cytp_dbg(fmt, ...)  psmouse_dbg(psmouse, pr_fmt(fmt), ##__VA_ARGS__)

Just use psmouse_dbg directly, no need to redefine it. And we might need
psmouse_vdbg() for your CYTP_DEBUG_VERBOSE bits.

> +
> +
> +static int is_cypress_key(const unsigned char *param)
> +{
> +	return (param[0] == CYPRESS_KEY_1) && (param[1] == CYPRESS_KEY_2);

CYPRESS_KEY_1 and CYPRESS_KEY_2 and the function itself are misnamed.
Why key? If anything it's signature. I'd just use real constants with
proper comment right in cypress_detect().

> +}
> +
> +static void cypress_set_packet_size(struct psmouse *psmouse, unsigned int n)
> +{
> +	struct cytp_data *cytp = psmouse->private;
> +	psmouse->pktsize = cytp->pkt_size = n;

Why are we changing psmouse->pktsize all the time? Leave it at max.

> +}
> +
> +static void cypress_set_abs_rel_mode(struct cytp_data *cytp,
> +			unsigned int cytp_mode_bit)
> +{
> +	cytp->mode = (cytp->mode & ~CYTP_BIT_ABS_REL_MASK) | cytp_mode_bit;

I find this more confusing than if you manipulated the bits directly.
When I am looking at call sites I expect this function doing device IO
which it does not. Just set the bits directly.

> +}
> +
> +static const unsigned char cytp_rate[] = {10, 20, 40, 60, 100, 200};
> +static const unsigned char cytp_resolution[] = {0x00, 0x01, 0x02, 0x03};
> +
> +static int cypress_ps2_sendbyte(struct psmouse *psmouse, int value)
> +{
> +	struct ps2dev *ps2dev = &psmouse->ps2dev;
> +
> +	if (ps2_sendbyte(ps2dev, value & 0xff, CYTP_CMD_TIMEOUT) < 0) {
> +		cytp_dbg("send command 0x%02x failed, resp 0x%02x\n",
> +			 value & 0xff, ps2dev->nak);
> +		if (ps2dev->nak == CYTP_PS2_RETRY)
> +			return CYTP_PS2_RETRY;
> +		else
> +			return CYTP_PS2_ERROR;
> +	}
> +
> +	cytp_dbg("send command 0x%02x success, resp 0xfa\n", value & 0xff);
> +
> +	return 0;
> +}
> +
> +static int cypress_ps2_ext_cmd(struct psmouse *psmouse, unsigned short cmd,
> +			       unsigned char data)
> +{
> +	struct ps2dev *ps2dev = &psmouse->ps2dev;
> +	int tries = CYTP_PS2_CMD_TRIES;
> +	int rc;
> +
> +	ps2_begin_command(ps2dev);
> +
> +	do {
> +		/*
> +		 * Send extension command byte (0xE8 or 0xF3).
> +		 * If sending the command fails, send recovery command
> +		 * to make the device return to the ready state.
> +		 */
> +		rc = cypress_ps2_sendbyte(psmouse, cmd & 0xff);
> +		if (rc == CYTP_PS2_RETRY) {
> +			rc = cypress_ps2_sendbyte(psmouse, 0x00);
> +			if (rc == CYTP_PS2_RETRY)
> +				rc = cypress_ps2_sendbyte(psmouse, 0x0a);
> +		}
> +		if (rc == CYTP_PS2_ERROR)
> +			continue;
> +
> +		rc = cypress_ps2_sendbyte(psmouse, data);
> +		if (rc == CYTP_PS2_RETRY)
> +			rc = cypress_ps2_sendbyte(psmouse, data);
> +		if (rc == CYTP_PS2_ERROR)
> +			continue;
> +		else
> +			break;
> +	} while (--tries > 0);
> +
> +	ps2_end_command(ps2dev);
> +
> +	return rc;
> +}
> +
> +static int cypress_ps2_read_cmd_status(struct psmouse *psmouse,
> +				       unsigned char cmd,
> +				       unsigned char *param)
> +{
> +	int i;
> +	int rc;
> +	struct ps2dev *ps2dev = &psmouse->ps2dev;
> +	enum psmouse_state old_state;
> +	unsigned char old_pktsize;
> +
> +	ps2_begin_command(&psmouse->ps2dev);
> +
> +	old_state = psmouse->state;
> +	psmouse->state = PSMOUSE_CMD_MODE;
> +	psmouse->pktcnt = 0;
> +	old_pktsize = psmouse->pktsize;
> +	psmouse->pktsize = 3;
> +	if (cmd == CYTP_CMD_READ_TP_METRICS)
> +		psmouse->pktsize = 8;
> +	memset(param, 0, psmouse->pktsize);
> +
> +	rc = cypress_ps2_sendbyte(psmouse, 0xe9);
> +	if (rc < 0)
> +		goto out;
> +
> +	wait_event_timeout(ps2dev->wait,
> +			(psmouse->pktcnt >= psmouse->pktsize),
> +			msecs_to_jiffies(CYTP_CMD_TIMEOUT));
> +
> +	memcpy(param, psmouse->packet, psmouse->pktsize);
> +
> +	cytp_dbg("Command 0x%02x response data: (0x)", cmd);
> +	for (i = 0; i < psmouse->pktsize; i++)
> +		cytp_dbg(" %02x", param[i]);
> +	cytp_dbg("\n");

We have "%*ph" for this. Also I need to think some more about this
function but I do not like it as it messes too much with psmouse state.
I think there should be a better way.

> +
> +out:
> +	psmouse->state = old_state;
> +	psmouse->pktcnt = 0;
> +	psmouse->pktsize = old_pktsize;
> +
> +	ps2_end_command(&psmouse->ps2dev);
> +
> +	return rc;
> +}
> +
> +static int cypress_verify_cmd_state(struct psmouse *psmouse,
> +				    unsigned char cmd, unsigned char *param)
> +{
> +	bool rate_match = 0;
> +	bool resolution_match = 0;
> +	int i;
> +
> +	/* callers will do further checking. */
> +	if ((cmd == CYTP_CMD_READ_CYPRESS_ID) ||
> +	    (cmd == CYTP_CMD_STANDARD_MODE) ||
> +	    (cmd == CYTP_CMD_READ_TP_METRICS))
> +		return 0;

You do not need so many ().

> +	if (((~param[0] & DFLT_RESP_BITS_VALID) == DFLT_RESP_BITS_VALID) &&
> +	    ((param[0] & DFLT_RESP_BIT_MODE) == DFLT_RESP_STREAM_MODE)) {
> +		for (i = 0; i < sizeof(cytp_resolution); i++)
> +			if (cytp_resolution[i] == param[1])
> +				resolution_match =  1;
> +
> +		for (i = 0; i < sizeof(cytp_rate); i++)
> +			if (cytp_rate[i] == param[2])
> +				rate_match = 1;
> +
> +		if (resolution_match && rate_match)
> +			return 0;
> +	}
> +
> +	cytp_dbg("verify cmd state failed.\n");
> +	return -1;
> +}
> +
> +static int cypress_send_ext_cmd(struct psmouse *psmouse, unsigned char cmd,
> +				unsigned char *param)
> +{
> +	int tries = CYTP_PS2_CMD_TRIES;
> +	int rc;
> +
> +	cytp_dbg("send extension cmd 0x%02x, [%d %d %d %d]\n",
> +		 cmd, DECODE_CMD_AA(cmd), DECODE_CMD_BB(cmd),
> +		 DECODE_CMD_CC(cmd), DECODE_CMD_DD(cmd));
> +	do {
> +		cypress_ps2_ext_cmd(psmouse,
> +				    PSMOUSE_CMD_SETRES, DECODE_CMD_DD(cmd));
> +		cypress_ps2_ext_cmd(psmouse,
> +				    PSMOUSE_CMD_SETRES, DECODE_CMD_CC(cmd));
> +		cypress_ps2_ext_cmd(psmouse,
> +				    PSMOUSE_CMD_SETRES, DECODE_CMD_BB(cmd));
> +		cypress_ps2_ext_cmd(psmouse,
> +				    PSMOUSE_CMD_SETRES, DECODE_CMD_AA(cmd));
> +
> +		rc = cypress_ps2_read_cmd_status(psmouse, cmd, param);
> +		if (rc)
> +			continue;
> +
> +		rc = cypress_verify_cmd_state(psmouse, cmd, param);
> +		if (rc == 0)
> +			return 0;
> +	} while (--tries > 0);
> +
> +	return -1;
> +}
> +
> +int cypress_detect(struct psmouse *psmouse, bool set_properties)
> +{
> +	unsigned char param[3];
> +
> +	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_READ_CYPRESS_ID, param))
> +		return -1;

-ENODEV here as well?

> +
> +	if (!is_cypress_key(param))
> +		return -ENODEV;
> +
> +	if (set_properties) {
> +		psmouse->vendor = "Cypress";
> +		psmouse->name = "Trackpad";
> +	}
> +
> +	return 0;
> +}
> +
> +static int cypress_read_fw_version(struct psmouse *psmouse)
> +{
> +	struct cytp_data *cytp = psmouse->private;
> +	unsigned char param[3];
> +
> +	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_READ_CYPRESS_ID, param))
> +		return -1;
> +
> +	if (!is_cypress_key(param))
> +		return -ENODEV;
> +
> +	cytp->fw_version = param[2] & FW_VERSION_MASX;
> +	cytp->tp_metrics_supported = (param[2] & TP_METRICS_MASK) ? 1 : 0;
> +
> +	cytp_dbg("cytp->fw_version = %d\n", cytp->fw_version);
> +	cytp_dbg("cytp->tp_metrics_supported = %d\n",
> +		 cytp->tp_metrics_supported);
> +	return 0;
> +}
> +
> +static int cypress_read_tp_metrics(struct psmouse *psmouse)
> +{
> +	struct cytp_data *cytp = psmouse->private;
> +	unsigned char param[8];
> +
> +	/* set default values for tp metrics. */
> +	cytp->tp_width = CYTP_DEFAULT_WIDTH;
> +	cytp->tp_high = CYTP_DEFAULT_HIGH;
> +	cytp->tp_max_abs_x = CYTP_ABS_MAX_X;
> +	cytp->tp_max_abs_y = CYTP_ABS_MAX_Y;
> +	cytp->tp_min_pressure = CYTP_MIN_PRESSURE;
> +	cytp->tp_max_pressure = CYTP_MAX_PRESSURE;
> +	cytp->tp_res_x = cytp->tp_max_abs_x / cytp->tp_width;
> +	cytp->tp_res_y = cytp->tp_max_abs_y / cytp->tp_high;
> +
> +	memset(param, 0, sizeof(param));
> +	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_READ_TP_METRICS, param) == 0) {
> +		/* Update trackpad parameters. */
> +		cytp->tp_max_abs_x = (param[1] << 8) | param[0];
> +		cytp->tp_max_abs_y = (param[3] << 8) | param[2];
> +		cytp->tp_min_pressure = param[4];
> +		cytp->tp_max_pressure = param[5];
> +
> +		if (param[6] & TP_METRICS_BIT_APA)
> +			cytp->tp_type = CYTP_APA;
> +		else if (param[6] & TP_METRICS_BIT_MTG)
> +			cytp->tp_type = CYTP_MTG;
> +		else
> +			cytp->tp_type = CYTP_STG;
> +		cytp->tp_palm = (param[6] & TP_METRICS_BIT_PALM) ? 1 : 0;
> +		cytp->tp_stubborn = (param[6] & TP_METRICS_BIT_STUBBORN) ? 1 : 0;
> +		cytp->tp_2f_jitter = (param[6] & TP_METRICS_BIT_2F_JITTER) >> 4;
> +		cytp->tp_1f_jitter = (param[6] & TP_METRICS_BIT_1F_JITTER) >> 2;
> +		cytp->tp_abs_packet_format_set =
> +			(param[7] & TP_METRICS_BIT_ABS_PKT_FORMAT_SET) >> 4;
> +		cytp->tp_2f_spike = (param[7] & TP_METRICS_BIT_2F_SPIKE) >> 2;
> +		cytp->tp_1f_spike = (param[7] & TP_METRICS_BIT_1F_SPIKE);
> +
> +	}
> +
> +	if (!cytp->tp_max_pressure ||
> +	    (cytp->tp_max_pressure < cytp->tp_min_pressure) ||
> +	    (!cytp->tp_width || !cytp->tp_high) ||
> +	    (!cytp->tp_max_abs_x) ||
> +	    (cytp->tp_max_abs_x < cytp->tp_width) ||
> +	    (!cytp->tp_max_abs_y) ||
> +	    (cytp->tp_max_abs_y < cytp->tp_high))
> +		return -1;
> +

Again, some () can be dropped.

> +	cytp->tp_res_x = cytp->tp_max_abs_x / cytp->tp_width;
> +	cytp->tp_res_y = cytp->tp_max_abs_y / cytp->tp_high;
> +
> +#ifdef CYTP_DEBUG_VERBOSE
> +	cytp_dbg("Dump trackpad hardware configuration as below:\n");
> +	cytp_dbg("cytp->tp_width = %d\n", cytp->tp_width);
> +	cytp_dbg("cytp->tp_high = %d\n", cytp->tp_high);
> +	cytp_dbg("cytp->tp_max_abs_x = %d\n", cytp->tp_max_abs_x);
> +	cytp_dbg("cytp->tp_max_abs_y = %d\n", cytp->tp_max_abs_y);
> +	cytp_dbg("cytp->tp_min_pressure = %d\n", cytp->tp_min_pressure);
> +	cytp_dbg("cytp->tp_max_pressure = %d\n", cytp->tp_max_pressure);
> +	cytp_dbg("cytp->tp_res_x = %d\n", cytp->tp_res_x);
> +	cytp_dbg("cytp->tp_res_y = %d\n", cytp->tp_res_y);
> +	cytp_dbg("cytp->tp_type = %d\n", cytp->tp_type);
> +	cytp_dbg("cytp->tp_palm = %d\n", cytp->tp_palm);
> +	cytp_dbg("cytp->tp_stubborn = %d\n", cytp->tp_stubborn);
> +	cytp_dbg("cytp->tp_1f_jitter = %d\n", cytp->tp_1f_jitter);
> +	cytp_dbg("cytp->tp_2f_jitter = %d\n", cytp->tp_2f_jitter);
> +	cytp_dbg("cytp->tp_1f_spike = %d\n", cytp->tp_1f_spike);
> +	cytp_dbg("cytp->tp_2f_spike = %d\n", cytp->tp_2f_spike);
> +	cytp_dbg("cytp->tp_abs_packet_format_set = %d\n",
> +		      cytp->tp_abs_packet_format_set);
> +#endif
> +
> +	return 0;
> +}
> +
> +static int cypress_query_hardware(struct psmouse *psmouse)
> +{
> +	struct cytp_data *cytp = psmouse->private;
> +	int ret;
> +
> +	ret = cypress_read_fw_version(psmouse);
> +	if (ret)
> +		return ret;
> +
> +	if (cytp->tp_metrics_supported) {
> +		ret = cypress_read_tp_metrics(psmouse);
> +		if (ret)
> +			return ret;
> +	}
> +
> +	return 0;
> +}
> +
> +static int cypress_set_absolute_mode(struct psmouse *psmouse)
> +{
> +	struct cytp_data *cytp = psmouse->private;
> +	unsigned char param[3];
> +
> +	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_ABS_WITH_PRESSURE_MODE, param) < 0)
> +		return -1;
> +
> +	cypress_set_abs_rel_mode(cytp, CYTP_BIT_ABS_PRESSURE);
> +	cypress_set_packet_size(psmouse, 5);
> +
> +	return 0;
> +}
> +
> +/*
> + * reset trackpad device to standard relative mode.
> + * This is also the defalut mode when trackpad powered on.
> + */
> +static void cypress_reset(struct psmouse *psmouse)
> +{
> +	struct cytp_data *cytp = psmouse->private;
> +
> +	psmouse_reset(psmouse);
> +
> +	cypress_set_abs_rel_mode(cytp, CYTP_BIT_STANDARD_REL);
> +	cypress_set_packet_size(psmouse, 3);
> +
> +	cytp->prev_contact_cnt = 0;

No, just call psmouse_reset(), the rest is not needed.

> +}
> +
> +static int cypress_set_input_params(struct input_dev *input,
> +				    struct cytp_data *cytp)
> +{
> +	int ret;
> +
> +	if (!(cytp->tp_res_x && cytp->tp_res_y))

Too many ().

> +		return -EINVAL;
> +
> +	__set_bit(EV_ABS, input->evbit);
> +	input_set_abs_params(input, ABS_X, 0, cytp->tp_max_abs_x, 0, 0);
> +	input_set_abs_params(input, ABS_Y, 0, cytp->tp_max_abs_y, 0, 0);
> +	input_set_abs_params(input, ABS_PRESSURE,
> +			     cytp->tp_min_pressure, cytp->tp_max_pressure, 0, 0);
> +	input_set_abs_params(input, ABS_TOOL_WIDTH, 0, 255, 0, 0);
> +
> +	/* finger position */
> +	input_set_abs_params(input, ABS_MT_POSITION_X, 0, cytp->tp_max_abs_x, 0, 0);
> +	input_set_abs_params(input, ABS_MT_POSITION_Y, 0, cytp->tp_max_abs_y, 0, 0);
> +	input_set_abs_params(input, ABS_MT_PRESSURE, 0, 255, 0, 0);
> +
> +	ret = input_mt_init_slots(input, CYTP_MAX_MT_SLOTS,
> +			INPUT_MT_DROP_UNUSED|INPUT_MT_TRACK);
> +	if (ret < 0)
> +		return ret;
> +
> +	__set_bit(INPUT_PROP_SEMI_MT, input->propbit);
> +
> +	input_abs_set_res(input, ABS_X, cytp->tp_res_x);
> +	input_abs_set_res(input, ABS_Y, cytp->tp_res_y);
> +
> +	input_abs_set_res(input, ABS_MT_POSITION_X, cytp->tp_res_x);
> +	input_abs_set_res(input, ABS_MT_POSITION_Y, cytp->tp_res_y);
> +
> +	__set_bit(BTN_TOUCH, input->keybit);
> +	__set_bit(BTN_TOOL_FINGER, input->keybit);
> +	__set_bit(BTN_TOOL_DOUBLETAP, input->keybit);
> +	__set_bit(BTN_TOOL_TRIPLETAP, input->keybit);
> +	__set_bit(BTN_TOOL_QUADTAP, input->keybit);
> +	__set_bit(BTN_TOOL_QUINTTAP, input->keybit);
> +
> +	__clear_bit(EV_REL, input->evbit);
> +	__clear_bit(REL_X, input->relbit);
> +	__clear_bit(REL_Y, input->relbit);
> +
> +	__set_bit(INPUT_PROP_BUTTONPAD, input->propbit);

I do not think it should be marked INPUT_PROP_BUTTONPAD if it has
physical buttons...

> +	__set_bit(EV_KEY, input->evbit);
> +	__set_bit(BTN_LEFT, input->keybit);
> +	__set_bit(BTN_RIGHT, input->keybit);
> +	__set_bit(BTN_MIDDLE, input->keybit);
> +
> +	input_set_drvdata(input, cytp);
> +
> +	return 0;
> +}
> +
> +static int cypress_get_finger_count(unsigned char header_byte)
> +{
> +	unsigned char bits6_7;
> +	int finger_count;
> +
> +	bits6_7 = header_byte >> 6;
> +	finger_count = bits6_7 & 0x03;
> +
> +	if (finger_count == 1)
> +		return 1;
> +
> +	if (header_byte & ABS_HSCROLL_BIT) {
> +		if (finger_count == 0) {

		switch (finger_count) {
		case 0:
		case 2:
		default:
		}
> +			/* HSCROLL gets added on to 0 finger count. */
> +			finger_count = 4;
> +			/* should remove HSCROLL bit. */
> +		} else {
> +			if (finger_count == 2) {
> +				finger_count = 5;
> +				/* should remove HSCROLL bit. */
> +			} else {
> +				/* Invalid contact (e.g. palm). Ignore it. */
> +				finger_count = 0;
> +			}
> +		}
> +	}
> +
> +	return finger_count;
> +}
> +
> +
> +static int cypress_parse_packet(struct psmouse *psmouse,
> +				struct cytp_data *cytp, struct cytp_report_data *report_data)
> +{
> +	unsigned char *packet = psmouse->packet;
> +	unsigned char header_byte = packet[0];
> +
> +	memset(report_data, 0, sizeof(struct cytp_report_data));
> +
> +	report_data->contact_cnt = cypress_get_finger_count(header_byte);
> +
> +	if (report_data->contact_cnt == 0) /* e.g. palm detect */
> +		return 0;
> +
> +	report_data->tap = (header_byte & ABS_MULTIFINGER_TAP) ? 1 : 0;
> +
> +	if (report_data->contact_cnt == 1) {
> +		report_data->contacts[0].x =
> +			((packet[1] & 0x70) << 4) | packet[2];
> +		report_data->contacts[0].y =
> +			((packet[1] & 0x07) << 8) | packet[3];
> +		if (cytp->mode & CYTP_BIT_ABS_PRESSURE)
> +			report_data->contacts[0].z = packet[4];
> +
> +	} else if (report_data->contact_cnt >= 2) {
> +		report_data->contacts[0].x =
> +			((packet[1] & 0x70) << 4) | packet[2];
> +		report_data->contacts[0].y =
> +			((packet[1] & 0x07) << 8) | packet[3];
> +		if (cytp->mode & CYTP_BIT_ABS_PRESSURE)
> +			report_data->contacts[0].z = packet[4];
> +
> +		report_data->contacts[1].x =
> +			((packet[5] & 0xf0) << 4) | packet[6];
> +		report_data->contacts[1].y =
> +			((packet[5] & 0x0f) << 8) | packet[7];
> +		if (cytp->mode & CYTP_BIT_ABS_PRESSURE)
> +			report_data->contacts[1].z = report_data->contacts[0].z;
> +	}
> +
> +	report_data->left = (header_byte & BTN_LEFT_BIT) ? 1 : 0;
> +	report_data->right = (header_byte & BTN_RIGHT_BIT) ? 1 : 0;
> +
> +	/* This is only true if one of the mouse buttons were tapped.
> +	 * Make sure it doesn't turn into a click. The regular tap-to-
> +	 * click functionality will handle that on its own. If we don't
> +	 * do this, disabling tap-to-click won't affect the mouse button
> +	 * zones. */

The preferred comment format is:

	/*
	 * Text
	 * text
	 */

> +	if (report_data->tap)
> +		report_data->left = 0;
> +
> +#ifdef CYTP_DEBUG_VERBOSE
> +	{
> +		int i;
> +		int n = report_data->contact_cnt;
> +		cytp_dbg("cypress_parse_packet cytp->zero_packet_cnt = %d\n",
> +				cytp->zero_packet_cnt);
> +		cytp_dbg("Dump parsed report data as below:\n");
> +		cytp_dbg("contact_cnt = %d\n", report_data->contact_cnt);
> +		if (n > CYTP_MAX_MT_SLOTS)
> +		    n = CYTP_MAX_MT_SLOTS;
> +		for (i = 0; i < n; i++)
> +			cytp_dbg("contacts[%d] = {%d, %d, %d}\n", i,
> +					report_data->contacts[i].x,
> +					report_data->contacts[i].y,
> +					report_data->contacts[i].z);
> +		cytp_dbg("left = %d\n", report_data->left);
> +		cytp_dbg("right = %d\n", report_data->right);
> +		cytp_dbg("middle = %d\n", report_data->middle);
> +	}
> +#endif
> +
> +	return 0;
> +}
> +
> +static void cypress_process_packet(struct psmouse *psmouse, bool zero_pkt)
> +{
> +	int i;
> +	struct input_dev *input = psmouse->dev;
> +	struct cytp_data *cytp = psmouse->private;
> +	struct cytp_report_data report_data;
> +	struct cytp_contact *contact;
> +	struct input_mt_pos pos[CYTP_MAX_MT_SLOTS];
> +	int slots[CYTP_MAX_MT_SLOTS];
> +	int n;
> +
> +	if (cypress_parse_packet(psmouse, cytp, &report_data))
> +		return;
> +
> +	n = report_data.contact_cnt;
> +
> +	if (n > CYTP_MAX_MT_SLOTS)
> +		n = CYTP_MAX_MT_SLOTS;
> +
> +	for (i = 0; i < n; i++) {
> +		contact = &report_data.contacts[i];
> +		pos[i].x = contact->x;
> +		pos[i].y = contact->y;
> +	}
> +
> +	input_mt_assign_slots(input, slots, pos, n);
> +
> +	for (i = 0; i < n; i++) {
> +		contact = &report_data.contacts[i];
> +		input_mt_slot(input, slots[i]);
> +		input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
> +		input_report_abs(input, ABS_MT_POSITION_X, contact->x);
> +		input_report_abs(input, ABS_MT_POSITION_Y, contact->y);
> +		input_report_abs(input, ABS_MT_PRESSURE, contact->z);
> +	}
> +
> +	input_mt_sync_frame(input);
> +
> +	input_mt_report_finger_count(input, report_data.contact_cnt);
> +
> +	input_report_key(input, BTN_LEFT, report_data.left);
> +	input_report_key(input, BTN_RIGHT, report_data.right);
> +	input_report_key(input, BTN_MIDDLE, report_data.middle);
> +
> +	input_sync(input);
> +}
> +
> +static psmouse_ret_t cypress_validate_byte(struct psmouse *psmouse)
> +{
> +	int contact_cnt;
> +	int index = psmouse->pktcnt - 1;
> +	unsigned char *packet = psmouse->packet;
> +	struct cytp_data *cytp = psmouse->private;
> +
> +	if (index < 0 || index > cytp->pkt_size)
> +		return PSMOUSE_BAD_DATA;
> +
> +	if ((index == 0) && ((packet[0] & 0xfc) == 0)) {
> +		/* call packet process for reporting finger leave. */
> +		cypress_process_packet(psmouse, 1);
> +		return PSMOUSE_FULL_PACKET;
> +	}
> +
> +	if (cytp->mode & CYTP_BIT_ABS_MASK) {

It can't be anything else, can it?

> +		if (index == 0) {
> +			if ((packet[0] & 0x08) == 0x08)
> +				return PSMOUSE_BAD_DATA;
> +
> +			contact_cnt = cypress_get_finger_count(packet[0]);
> +
> +			if (contact_cnt > 5)
> +				return PSMOUSE_BAD_DATA;
> +
> +			if (cytp->mode & CYTP_BIT_ABS_NO_PRESSURE) {
> +				cypress_set_packet_size(psmouse, 4);
> +				if (contact_cnt == 2)
> +					cypress_set_packet_size(psmouse, 7);
> +			} else {
> +				cypress_set_packet_size(psmouse, 5);
> +				if (contact_cnt == 2)
> +					cypress_set_packet_size(psmouse, 8);
> +			}
> +		}
> +	}
> +
> +	return PSMOUSE_GOOD_DATA;
> +}
> +
> +static psmouse_ret_t cypress_protocol_handler(struct psmouse *psmouse)
> +{
> +	struct cytp_data *cytp = psmouse->private;
> +
> +	if (psmouse->pktcnt >= cytp->pkt_size) {
> +		cypress_process_packet(psmouse, 0);
> +		return PSMOUSE_FULL_PACKET;
> +	}
> +
> +	return cypress_validate_byte(psmouse);
> +}
> +
> +static void cypress_set_rate(struct psmouse *psmouse, unsigned int rate)
> +{
> +	struct cytp_data *cytp = psmouse->private;
> +
> +	if (rate >= 80) {
> +		psmouse->rate = 80;
> +		cytp->mode |= CYTP_BIT_HIGH_RATE;
> +	} else {
> +		psmouse->rate = 40;
> +		cytp->mode &= ~CYTP_BIT_HIGH_RATE;
> +	}
> +
> +	ps2_command(&psmouse->ps2dev, (unsigned char *)&psmouse->rate,
> +		    PSMOUSE_CMD_SETRATE);
> +}
> +
> +static void cypress_disconnect(struct psmouse *psmouse)
> +{
> +	cypress_reset(psmouse);
> +	kfree(psmouse->private);
> +	psmouse->private = NULL;
> +}
> +
> +static int cypress_reconnect(struct psmouse *psmouse)
> +{
> +	int tries = CYTP_PS2_CMD_TRIES;
> +	int rc;
> +
> +	do {
> +		cypress_reset(psmouse);
> +		rc = cypress_detect(psmouse, false);
> +	} while (rc && (--tries > 0));
> +
> +	if (rc) {
> +		psmouse_err(psmouse, "Reconnect: unable to detect trackpad.\n");
> +		return -1;
> +	}
> +
> +	if (cypress_set_absolute_mode(psmouse)) {
> +		psmouse_err(psmouse, "Reconnect: Unable to initialize Cypress absolute mode.\n");
> +		return -1;
> +	}
> +
> +	return 0;
> +}
> +
> +int cypress_init(struct psmouse *psmouse)
> +{
> +	struct cytp_data *cytp;
> +
> +	cytp = (struct cytp_data *)kzalloc(sizeof(struct cytp_data), GFP_KERNEL);
> +	psmouse->private = (void *)cytp;
> +	if (cytp == NULL)
> +		return -ENOMEM;
> +
> +	cypress_reset(psmouse);
> +
> +	if (cypress_query_hardware(psmouse)) {
> +		psmouse_err(psmouse, "Unable to query Trackpad hardware.\n");
> +		goto err_exit;
> +	}
> +
> +	if (cypress_set_absolute_mode(psmouse)) {
> +		psmouse_err(psmouse, "init: Unable to initialize Cypress absolute mode.\n");
> +		goto err_exit;
> +	}
> +
> +	if (cypress_set_input_params(psmouse->dev, cytp) < 0) {
> +		psmouse_err(psmouse, "init: Unable to set input params.\n");
> +		goto err_exit;
> +	}
> +
> +	psmouse->model = 1;
> +	psmouse->protocol_handler = cypress_protocol_handler;
> +	psmouse->set_rate = cypress_set_rate;
> +	psmouse->disconnect = cypress_disconnect;
> +	psmouse->reconnect = cypress_reconnect;
> +	psmouse->cleanup = cypress_reset;
> +	psmouse->pktsize = 8;
> +	psmouse->resync_time = 0;
> +
> +	return 0;
> +
> +err_exit:
> +	/*
> +	 * Reset Cypress Trackpad as a standard mouse. Then
> +	 * let psmouse driver commmunicating with it as default PS2 mouse.
> +	 */
> +	cypress_reset(psmouse);
> +
> +	psmouse->private = NULL;
> +	kfree(cytp);
> +
> +	return -1;
> +}
> +
> +bool cypress_supported(void)
> +{
> +	return true;
> +}
> diff --git a/drivers/input/mouse/cypress_ps2.h b/drivers/input/mouse/cypress_ps2.h
> new file mode 100644
> index 0000000..142fa8f
> --- /dev/null
> +++ b/drivers/input/mouse/cypress_ps2.h
> @@ -0,0 +1,216 @@
> +#ifndef _CYPRESS_PS2_H
> +#define _CYPRESS_PS2_H
> +
> +#include "psmouse.h"
> +
> +#define CMD_BITS_MASK 0x03
> +#define COMPOSIT(x, s) (((x) & CMD_BITS_MASK) << (s))
> +
> +#define ENCODE_CMD(aa, bb, cc, dd) \
> +	(COMPOSIT((aa), 6) | COMPOSIT((bb), 4) | COMPOSIT((cc), 2) | COMPOSIT((dd), 0))
> +#define CYTP_CMD_ABS_NO_PRESSURE_MODE       ENCODE_CMD(0, 1, 0, 0)
> +#define CYTP_CMD_ABS_WITH_PRESSURE_MODE     ENCODE_CMD(0, 1, 0, 1)
> +#define CYTP_CMD_SMBUS_MODE                 ENCODE_CMD(0, 1, 1, 0)
> +#define CYTP_CMD_STANDARD_MODE              ENCODE_CMD(0, 2, 0, 0)  /* not implemented yet. */
> +#define CYTP_CMD_CYPRESS_REL_MODE           ENCODE_CMD(1, 1, 1, 1)  /* not implemented yet. */
> +#define CYTP_CMD_READ_CYPRESS_ID            ENCODE_CMD(0, 0, 0, 0)
> +#define CYTP_CMD_READ_TP_METRICS            ENCODE_CMD(0, 0, 0, 1)
> +#define CYTP_CMD_SET_HSCROLL_WIDTH(w)       ENCODE_CMD(1, 1, 0, (w))
> +#define     CYTP_CMD_SET_HSCROLL_MASK       ENCODE_CMD(1, 1, 0, 0)
> +#define CYTP_CMD_SET_VSCROLL_WIDTH(w)       ENCODE_CMD(1, 2, 0, (w))
> +#define     CYTP_CMD_SET_VSCROLL_MASK       ENCODE_CMD(1, 2, 0, 0)
> +#define CYTP_CMD_SET_PALM_GEOMETRY(e)       ENCODE_CMD(1, 2, 1, (e))
> +#define     CYTP_CMD_PALM_GEMMETRY_MASK     ENCODE_CMD(1, 2, 1, 0)
> +#define CYTP_CMD_SET_PALM_SENSITIVITY(s)    ENCODE_CMD(1, 2, 2, (s))
> +#define     CYTP_CMD_PALM_SENSITIVITY_MASK  ENCODE_CMD(1, 2, 2, 0)
> +#define CYTP_CMD_SET_MOUSE_SENSITIVITY(s)   ENCODE_CMD(1, 3, ((s) >> 2), (s))
> +#define     CYTP_CMD_MOUSE_SENSITIVITY_MASK ENCODE_CMD(1, 3, 0, 0)
> +#define CYTP_CMD_REQUEST_BASELINE_STATUS    ENCODE_CMD(2, 0, 0, 1)
> +#define CYTP_CMD_REQUEST_RECALIBRATION      ENCODE_CMD(2, 0, 0, 3)
> +
> +#define DECODE_CMD_AA(x) (((x) >> 6) & CMD_BITS_MASK)
> +#define DECODE_CMD_BB(x) (((x) >> 4) & CMD_BITS_MASK)
> +#define DECODE_CMD_CC(x) (((x) >> 2) & CMD_BITS_MASK)
> +#define DECODE_CMD_DD(x) ((x) & CMD_BITS_MASK)
> +
> +/* Cypress trackpad working mode. */
> +#define CYTP_BIT_ABS_PRESSURE    (1 << 3)
> +#define CYTP_BIT_ABS_NO_PRESSURE (1 << 2)
> +#define CYTP_BIT_CYPRESS_REL     (1 << 1)
> +#define CYTP_BIT_STANDARD_REL    (1 << 0)
> +#define CYTP_BIT_REL_MASK (CYTP_BIT_CYPRESS_REL | CYTP_BIT_STANDARD_REL)
> +#define CYTP_BIT_ABS_MASK (CYTP_BIT_ABS_PRESSURE | CYTP_BIT_ABS_NO_PRESSURE)
> +#define CYTP_BIT_ABS_REL_MASK (CYTP_BIT_ABS_MASK | CYTP_BIT_REL_MASK)
> +
> +#define CYTP_BIT_HIGH_RATE       (1 << 4)
> +/*
> + * report mode bit is set, firmware working in Remote Mode.
> + * report mode bit is cleared, firmware working in Stream Mode.
> + */
> +#define CYTP_BIT_REPORT_MODE     (1 << 5)
> +
> +/* scrolling width values for set HSCROLL and VSCROLL width command. */
> +#define SCROLL_WIDTH_NARROW 1
> +#define SCROLL_WIDTH_NORMAL 2
> +#define SCROLL_WIDTH_WIDE   3
> +
> +#define PALM_GEOMETRY_ENABLE  1
> +#define PALM_GEOMETRY_DISABLE 0
> +
> +#define CYPRESS_KEY_1 0x33
> +#define CYPRESS_KEY_2 0xCC
> +
> +#define TP_METRICS_MASK  0x80
> +#define FW_VERSION_MASX    0x7f
> +#define FW_VER_HIGH_MASK 0x70
> +#define FW_VER_LOW_MASK  0x0f
> +
> +/* Times to retry a ps2_command and millisecond delay between tries. */
> +#define CYTP_PS2_CMD_TRIES 3
> +#define CYTP_PS2_CMD_DELAY 500
> +
> +/* time out for PS/2 command only in milliseconds. */
> +#define CYTP_CMD_TIMEOUT  200
> +#define CYTP_DATA_TIMEOUT 30
> +
> +#define CYTP_EXT_CMD   0xe8
> +#define CYTP_PS2_RETRY 0xfe
> +#define CYTP_PS2_ERROR 0xfc
> +
> +#define CYTP_RESP_RETRY 0x01
> +#define CYTP_RESP_ERROR 0xfe
> +
> +
> +#define CYTP_105001_WIDTH  97   /* Dell XPS 13 */
> +#define CYTP_105001_HIGH   59
> +#define CYTP_DEFAULT_WIDTH (CYTP_105001_WIDTH)
> +#define CYTP_DEFAULT_HIGH  (CYTP_105001_HIGH)
> +
> +#define CYTP_ABS_MAX_X     1600
> +#define CYTP_ABS_MAX_Y     900
> +#define CYTP_MAX_PRESSURE  255
> +#define CYTP_MIN_PRESSURE  0
> +
> +/* header byte bits of relative package. */
> +#define BTN_LEFT_BIT   0x01
> +#define BTN_RIGHT_BIT  0x02
> +#define BTN_MIDDLE_BIT 0x04
> +#define REL_X_SIGN_BIT 0x10
> +#define REL_Y_SIGN_BIT 0x20
> +
> +/* header byte bits of absolute package. */
> +#define ABS_VSCROLL_BIT 0x10
> +#define ABS_HSCROLL_BIT 0x20
> +#define ABS_MULTIFINGER_TAP 0x04
> +#define ABS_EDGE_MOTION_MASK 0x80
> +
> +#define DFLT_RESP_BITS_VALID     0x88  /* SMBus bit should not be set. */
> +#define DFLT_RESP_SMBUS_BIT      0x80
> +#define   DFLT_SMBUS_MODE        0x80
> +#define   DFLT_PS2_MODE          0x00
> +#define DFLT_RESP_BIT_MODE       0x40
> +#define   DFLT_RESP_REMOTE_MODE  0x40
> +#define   DFLT_RESP_STREAM_MODE  0x00
> +#define DFLT_RESP_BIT_REPORTING  0x20
> +#define DFLT_RESP_BIT_SCALING    0x10
> +
> +#define TP_METRICS_BIT_PALM               0x80
> +#define TP_METRICS_BIT_STUBBORN           0x40
> +#define TP_METRICS_BIT_2F_JITTER          0x30
> +#define TP_METRICS_BIT_1F_JITTER          0x0c
> +#define TP_METRICS_BIT_APA                0x02
> +#define TP_METRICS_BIT_MTG                0x01
> +#define TP_METRICS_BIT_ABS_PKT_FORMAT_SET 0xf0
> +#define TP_METRICS_BIT_2F_SPIKE           0x0c
> +#define TP_METRICS_BIT_1F_SPIKE           0x03
> +
> +/* bits of first byte response of E9h-Status Request command. */
> +#define RESP_BTN_RIGHT_BIT  0x01
> +#define RESP_BTN_MIDDLE_BIT 0x02
> +#define RESP_BTN_LEFT_BIT   0x04
> +#define RESP_SCALING_BIT    0x10
> +#define RESP_ENABLE_BIT     0x20
> +#define RESP_REMOTE_BIT     0x40
> +#define RESP_SMBUS_BIT      0x80
> +
> +#define CYTP_MAX_MT_SLOTS 2
> +
> +enum cytp_type {
> +	CYTP_STG,
> +	CYTP_MTG,
> +	CYTP_APA,
> +};
> +
> +struct cytp_contact {
> +	int x;
> +	int y;
> +	int z;  /* also named as touch pressure. */
> +};
> +
> +/* The structure of Cypress Trackpad event data. */
> +struct cytp_report_data {
> +	int contact_cnt;
> +	struct cytp_contact contacts[CYTP_MAX_MT_SLOTS];
> +	unsigned int left:1;
> +	unsigned int right:1;
> +	unsigned int middle:1;
> +	unsigned int tap:1;  /* multi-finger tap detected. */
> +};
> +
> +/* The structure of Cypress Trackpad device private data. */
> +struct cytp_data {
> +	int fw_version;
> +
> +	int pkt_size;
> +	int mode;
> +
> +	int scaling;
> +	int reporting;
> +
> +	int tp_min_pressure;
> +	int tp_max_pressure;
> +	int tp_width;  /* X direction physical size in mm. */
> +	int tp_high;  /* Y direction physical size in mm. */
> +	int tp_max_abs_x;  /* Max X absolute units that can be reported. */
> +	int tp_max_abs_y;  /* Max Y absolute units that can be reported. */
> +
> +	int tp_res_x;  /* X resolution in units/mm. */
> +	int tp_res_y;  /* Y resolution in units/mm. */
> +
> +	enum cytp_type tp_type;
> +	unsigned char tp_palm;
> +	unsigned char tp_stubborn;
> +	unsigned char tp_2f_jitter;
> +	unsigned char tp_1f_jitter;
> +	unsigned char tp_abs_packet_format_set;
> +	unsigned char tp_2f_spike;
> +	unsigned char tp_1f_spike;

I do not think most of these needs to be stored here.

> +
> +	int tp_metrics_supported;
> +
> +	int prev_contact_cnt;
> +	int zero_packet_cnt;
> +	struct cytp_report_data prev_report_data;
> +};
> +
> +
> +#ifdef CONFIG_MOUSE_PS2_CYPRESS
> +int cypress_detect(struct psmouse *psmouse, bool set_properties);
> +int cypress_init(struct psmouse *psmouse);
> +bool cypress_supported(void);
> +#else
> +inline int cypress_detect(struct psmouse *psmouse, bool set_properties)
> +{
> +	return -ENOSYS;
> +}
> +inline int cypress_init(struct psmouse *psmouse)
> +{
> +	return -ENOSYS;
> +}
> +inline bool cypress_supported(void)
> +{
> +	return 0;
> +}
> +#endif /* CONFIG_MOUSE_PS2_CYPRESS */
> +
> +#endif  /* _CYPRESS_PS2_H */
> -- 
> 1.7.10.4
> 

Thanks!
Kamal Mostafa Dec. 7, 2012, 2:09 a.m. UTC | #2
On Thu, 2012-12-06 at 00:08 -0800, Dmitry Torokhov wrote:
> [...]


Hi Dmitry-

Thanks again for your review.  The forthcoming PATCH v6 addresses all of
your requests, except for:

> > +	__set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
> 
> I do not think it should be marked INPUT_PROP_BUTTONPAD if it has
> physical buttons...

This device (my particular Cypress Trackpad unit anyway) does not have
physical buttons.  The pad is clickable; I think it is a standard
"buttonpad" device.



And just FYI, this issue has been addressed but to answer your question:

> > +
> > +	if (cytp->mode & CYTP_BIT_ABS_MASK) {
> 
> It can't be anything else, can it?

It can: in the case when the mode hasn't been set at all yet (during
detect and reconnect).  I cleaned up the logic of this routine
(cypress_validate_byte) and added explanatory comments.


 -Kamal


--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/drivers/input/mouse/cypress_ps2.c b/drivers/input/mouse/cypress_ps2.c
new file mode 100644
index 0000000..02c4c61
--- /dev/null
+++ b/drivers/input/mouse/cypress_ps2.c
@@ -0,0 +1,740 @@ 
+/*
+ * Cypress Trackpad PS/2 mouse driver
+ *
+ * Copyright (c) 2012 Cypress Semiconductor Corporation.
+ *
+ * Author:
+ *   Dudley Du <dudl@cypress.com>
+ *
+ * Additional contributors include:
+ *   Kamal Mostafa <kamal@canonical.com>
+ *   Kyle Fazzari <git@status.e4ward.com>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 as published by
+ * the Free Software Foundation.
+ */
+
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/kernel.h>
+#include <linux/slab.h>
+#include <linux/serio.h>
+#include <linux/libps2.h>
+#include <linux/input.h>
+#include <linux/input/mt.h>
+#include <linux/sched.h>
+#include <linux/wait.h>
+
+#include "cypress_ps2.h"
+
+#undef CYTP_DEBUG_VERBOSE  /* define this and DEBUG for more verbose dump */
+
+#define cytp_dbg(fmt, ...)  psmouse_dbg(psmouse, pr_fmt(fmt), ##__VA_ARGS__)
+
+
+static int is_cypress_key(const unsigned char *param)
+{
+	return (param[0] == CYPRESS_KEY_1) && (param[1] == CYPRESS_KEY_2);
+}
+
+static void cypress_set_packet_size(struct psmouse *psmouse, unsigned int n)
+{
+	struct cytp_data *cytp = psmouse->private;
+	psmouse->pktsize = cytp->pkt_size = n;
+}
+
+static void cypress_set_abs_rel_mode(struct cytp_data *cytp,
+			unsigned int cytp_mode_bit)
+{
+	cytp->mode = (cytp->mode & ~CYTP_BIT_ABS_REL_MASK) | cytp_mode_bit;
+}
+
+static const unsigned char cytp_rate[] = {10, 20, 40, 60, 100, 200};
+static const unsigned char cytp_resolution[] = {0x00, 0x01, 0x02, 0x03};
+
+static int cypress_ps2_sendbyte(struct psmouse *psmouse, int value)
+{
+	struct ps2dev *ps2dev = &psmouse->ps2dev;
+
+	if (ps2_sendbyte(ps2dev, value & 0xff, CYTP_CMD_TIMEOUT) < 0) {
+		cytp_dbg("send command 0x%02x failed, resp 0x%02x\n",
+			 value & 0xff, ps2dev->nak);
+		if (ps2dev->nak == CYTP_PS2_RETRY)
+			return CYTP_PS2_RETRY;
+		else
+			return CYTP_PS2_ERROR;
+	}
+
+	cytp_dbg("send command 0x%02x success, resp 0xfa\n", value & 0xff);
+
+	return 0;
+}
+
+static int cypress_ps2_ext_cmd(struct psmouse *psmouse, unsigned short cmd,
+			       unsigned char data)
+{
+	struct ps2dev *ps2dev = &psmouse->ps2dev;
+	int tries = CYTP_PS2_CMD_TRIES;
+	int rc;
+
+	ps2_begin_command(ps2dev);
+
+	do {
+		/*
+		 * Send extension command byte (0xE8 or 0xF3).
+		 * If sending the command fails, send recovery command
+		 * to make the device return to the ready state.
+		 */
+		rc = cypress_ps2_sendbyte(psmouse, cmd & 0xff);
+		if (rc == CYTP_PS2_RETRY) {
+			rc = cypress_ps2_sendbyte(psmouse, 0x00);
+			if (rc == CYTP_PS2_RETRY)
+				rc = cypress_ps2_sendbyte(psmouse, 0x0a);
+		}
+		if (rc == CYTP_PS2_ERROR)
+			continue;
+
+		rc = cypress_ps2_sendbyte(psmouse, data);
+		if (rc == CYTP_PS2_RETRY)
+			rc = cypress_ps2_sendbyte(psmouse, data);
+		if (rc == CYTP_PS2_ERROR)
+			continue;
+		else
+			break;
+	} while (--tries > 0);
+
+	ps2_end_command(ps2dev);
+
+	return rc;
+}
+
+static int cypress_ps2_read_cmd_status(struct psmouse *psmouse,
+				       unsigned char cmd,
+				       unsigned char *param)
+{
+	int i;
+	int rc;
+	struct ps2dev *ps2dev = &psmouse->ps2dev;
+	enum psmouse_state old_state;
+	unsigned char old_pktsize;
+
+	ps2_begin_command(&psmouse->ps2dev);
+
+	old_state = psmouse->state;
+	psmouse->state = PSMOUSE_CMD_MODE;
+	psmouse->pktcnt = 0;
+	old_pktsize = psmouse->pktsize;
+	psmouse->pktsize = 3;
+	if (cmd == CYTP_CMD_READ_TP_METRICS)
+		psmouse->pktsize = 8;
+	memset(param, 0, psmouse->pktsize);
+
+	rc = cypress_ps2_sendbyte(psmouse, 0xe9);
+	if (rc < 0)
+		goto out;
+
+	wait_event_timeout(ps2dev->wait,
+			(psmouse->pktcnt >= psmouse->pktsize),
+			msecs_to_jiffies(CYTP_CMD_TIMEOUT));
+
+	memcpy(param, psmouse->packet, psmouse->pktsize);
+
+	cytp_dbg("Command 0x%02x response data: (0x)", cmd);
+	for (i = 0; i < psmouse->pktsize; i++)
+		cytp_dbg(" %02x", param[i]);
+	cytp_dbg("\n");
+
+out:
+	psmouse->state = old_state;
+	psmouse->pktcnt = 0;
+	psmouse->pktsize = old_pktsize;
+
+	ps2_end_command(&psmouse->ps2dev);
+
+	return rc;
+}
+
+static int cypress_verify_cmd_state(struct psmouse *psmouse,
+				    unsigned char cmd, unsigned char *param)
+{
+	bool rate_match = 0;
+	bool resolution_match = 0;
+	int i;
+
+	/* callers will do further checking. */
+	if ((cmd == CYTP_CMD_READ_CYPRESS_ID) ||
+	    (cmd == CYTP_CMD_STANDARD_MODE) ||
+	    (cmd == CYTP_CMD_READ_TP_METRICS))
+		return 0;
+	if (((~param[0] & DFLT_RESP_BITS_VALID) == DFLT_RESP_BITS_VALID) &&
+	    ((param[0] & DFLT_RESP_BIT_MODE) == DFLT_RESP_STREAM_MODE)) {
+		for (i = 0; i < sizeof(cytp_resolution); i++)
+			if (cytp_resolution[i] == param[1])
+				resolution_match =  1;
+
+		for (i = 0; i < sizeof(cytp_rate); i++)
+			if (cytp_rate[i] == param[2])
+				rate_match = 1;
+
+		if (resolution_match && rate_match)
+			return 0;
+	}
+
+	cytp_dbg("verify cmd state failed.\n");
+	return -1;
+}
+
+static int cypress_send_ext_cmd(struct psmouse *psmouse, unsigned char cmd,
+				unsigned char *param)
+{
+	int tries = CYTP_PS2_CMD_TRIES;
+	int rc;
+
+	cytp_dbg("send extension cmd 0x%02x, [%d %d %d %d]\n",
+		 cmd, DECODE_CMD_AA(cmd), DECODE_CMD_BB(cmd),
+		 DECODE_CMD_CC(cmd), DECODE_CMD_DD(cmd));
+	do {
+		cypress_ps2_ext_cmd(psmouse,
+				    PSMOUSE_CMD_SETRES, DECODE_CMD_DD(cmd));
+		cypress_ps2_ext_cmd(psmouse,
+				    PSMOUSE_CMD_SETRES, DECODE_CMD_CC(cmd));
+		cypress_ps2_ext_cmd(psmouse,
+				    PSMOUSE_CMD_SETRES, DECODE_CMD_BB(cmd));
+		cypress_ps2_ext_cmd(psmouse,
+				    PSMOUSE_CMD_SETRES, DECODE_CMD_AA(cmd));
+
+		rc = cypress_ps2_read_cmd_status(psmouse, cmd, param);
+		if (rc)
+			continue;
+
+		rc = cypress_verify_cmd_state(psmouse, cmd, param);
+		if (rc == 0)
+			return 0;
+	} while (--tries > 0);
+
+	return -1;
+}
+
+int cypress_detect(struct psmouse *psmouse, bool set_properties)
+{
+	unsigned char param[3];
+
+	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_READ_CYPRESS_ID, param))
+		return -1;
+
+	if (!is_cypress_key(param))
+		return -ENODEV;
+
+	if (set_properties) {
+		psmouse->vendor = "Cypress";
+		psmouse->name = "Trackpad";
+	}
+
+	return 0;
+}
+
+static int cypress_read_fw_version(struct psmouse *psmouse)
+{
+	struct cytp_data *cytp = psmouse->private;
+	unsigned char param[3];
+
+	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_READ_CYPRESS_ID, param))
+		return -1;
+
+	if (!is_cypress_key(param))
+		return -ENODEV;
+
+	cytp->fw_version = param[2] & FW_VERSION_MASX;
+	cytp->tp_metrics_supported = (param[2] & TP_METRICS_MASK) ? 1 : 0;
+
+	cytp_dbg("cytp->fw_version = %d\n", cytp->fw_version);
+	cytp_dbg("cytp->tp_metrics_supported = %d\n",
+		 cytp->tp_metrics_supported);
+	return 0;
+}
+
+static int cypress_read_tp_metrics(struct psmouse *psmouse)
+{
+	struct cytp_data *cytp = psmouse->private;
+	unsigned char param[8];
+
+	/* set default values for tp metrics. */
+	cytp->tp_width = CYTP_DEFAULT_WIDTH;
+	cytp->tp_high = CYTP_DEFAULT_HIGH;
+	cytp->tp_max_abs_x = CYTP_ABS_MAX_X;
+	cytp->tp_max_abs_y = CYTP_ABS_MAX_Y;
+	cytp->tp_min_pressure = CYTP_MIN_PRESSURE;
+	cytp->tp_max_pressure = CYTP_MAX_PRESSURE;
+	cytp->tp_res_x = cytp->tp_max_abs_x / cytp->tp_width;
+	cytp->tp_res_y = cytp->tp_max_abs_y / cytp->tp_high;
+
+	memset(param, 0, sizeof(param));
+	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_READ_TP_METRICS, param) == 0) {
+		/* Update trackpad parameters. */
+		cytp->tp_max_abs_x = (param[1] << 8) | param[0];
+		cytp->tp_max_abs_y = (param[3] << 8) | param[2];
+		cytp->tp_min_pressure = param[4];
+		cytp->tp_max_pressure = param[5];
+
+		if (param[6] & TP_METRICS_BIT_APA)
+			cytp->tp_type = CYTP_APA;
+		else if (param[6] & TP_METRICS_BIT_MTG)
+			cytp->tp_type = CYTP_MTG;
+		else
+			cytp->tp_type = CYTP_STG;
+		cytp->tp_palm = (param[6] & TP_METRICS_BIT_PALM) ? 1 : 0;
+		cytp->tp_stubborn = (param[6] & TP_METRICS_BIT_STUBBORN) ? 1 : 0;
+		cytp->tp_2f_jitter = (param[6] & TP_METRICS_BIT_2F_JITTER) >> 4;
+		cytp->tp_1f_jitter = (param[6] & TP_METRICS_BIT_1F_JITTER) >> 2;
+		cytp->tp_abs_packet_format_set =
+			(param[7] & TP_METRICS_BIT_ABS_PKT_FORMAT_SET) >> 4;
+		cytp->tp_2f_spike = (param[7] & TP_METRICS_BIT_2F_SPIKE) >> 2;
+		cytp->tp_1f_spike = (param[7] & TP_METRICS_BIT_1F_SPIKE);
+
+	}
+
+	if (!cytp->tp_max_pressure ||
+	    (cytp->tp_max_pressure < cytp->tp_min_pressure) ||
+	    (!cytp->tp_width || !cytp->tp_high) ||
+	    (!cytp->tp_max_abs_x) ||
+	    (cytp->tp_max_abs_x < cytp->tp_width) ||
+	    (!cytp->tp_max_abs_y) ||
+	    (cytp->tp_max_abs_y < cytp->tp_high))
+		return -1;
+
+	cytp->tp_res_x = cytp->tp_max_abs_x / cytp->tp_width;
+	cytp->tp_res_y = cytp->tp_max_abs_y / cytp->tp_high;
+
+#ifdef CYTP_DEBUG_VERBOSE
+	cytp_dbg("Dump trackpad hardware configuration as below:\n");
+	cytp_dbg("cytp->tp_width = %d\n", cytp->tp_width);
+	cytp_dbg("cytp->tp_high = %d\n", cytp->tp_high);
+	cytp_dbg("cytp->tp_max_abs_x = %d\n", cytp->tp_max_abs_x);
+	cytp_dbg("cytp->tp_max_abs_y = %d\n", cytp->tp_max_abs_y);
+	cytp_dbg("cytp->tp_min_pressure = %d\n", cytp->tp_min_pressure);
+	cytp_dbg("cytp->tp_max_pressure = %d\n", cytp->tp_max_pressure);
+	cytp_dbg("cytp->tp_res_x = %d\n", cytp->tp_res_x);
+	cytp_dbg("cytp->tp_res_y = %d\n", cytp->tp_res_y);
+	cytp_dbg("cytp->tp_type = %d\n", cytp->tp_type);
+	cytp_dbg("cytp->tp_palm = %d\n", cytp->tp_palm);
+	cytp_dbg("cytp->tp_stubborn = %d\n", cytp->tp_stubborn);
+	cytp_dbg("cytp->tp_1f_jitter = %d\n", cytp->tp_1f_jitter);
+	cytp_dbg("cytp->tp_2f_jitter = %d\n", cytp->tp_2f_jitter);
+	cytp_dbg("cytp->tp_1f_spike = %d\n", cytp->tp_1f_spike);
+	cytp_dbg("cytp->tp_2f_spike = %d\n", cytp->tp_2f_spike);
+	cytp_dbg("cytp->tp_abs_packet_format_set = %d\n",
+		      cytp->tp_abs_packet_format_set);
+#endif
+
+	return 0;
+}
+
+static int cypress_query_hardware(struct psmouse *psmouse)
+{
+	struct cytp_data *cytp = psmouse->private;
+	int ret;
+
+	ret = cypress_read_fw_version(psmouse);
+	if (ret)
+		return ret;
+
+	if (cytp->tp_metrics_supported) {
+		ret = cypress_read_tp_metrics(psmouse);
+		if (ret)
+			return ret;
+	}
+
+	return 0;
+}
+
+static int cypress_set_absolute_mode(struct psmouse *psmouse)
+{
+	struct cytp_data *cytp = psmouse->private;
+	unsigned char param[3];
+
+	if (cypress_send_ext_cmd(psmouse, CYTP_CMD_ABS_WITH_PRESSURE_MODE, param) < 0)
+		return -1;
+
+	cypress_set_abs_rel_mode(cytp, CYTP_BIT_ABS_PRESSURE);
+	cypress_set_packet_size(psmouse, 5);
+
+	return 0;
+}
+
+/*
+ * reset trackpad device to standard relative mode.
+ * This is also the defalut mode when trackpad powered on.
+ */
+static void cypress_reset(struct psmouse *psmouse)
+{
+	struct cytp_data *cytp = psmouse->private;
+
+	psmouse_reset(psmouse);
+
+	cypress_set_abs_rel_mode(cytp, CYTP_BIT_STANDARD_REL);
+	cypress_set_packet_size(psmouse, 3);
+
+	cytp->prev_contact_cnt = 0;
+}
+
+static int cypress_set_input_params(struct input_dev *input,
+				    struct cytp_data *cytp)
+{
+	int ret;
+
+	if (!(cytp->tp_res_x && cytp->tp_res_y))
+		return -EINVAL;
+
+	__set_bit(EV_ABS, input->evbit);
+	input_set_abs_params(input, ABS_X, 0, cytp->tp_max_abs_x, 0, 0);
+	input_set_abs_params(input, ABS_Y, 0, cytp->tp_max_abs_y, 0, 0);
+	input_set_abs_params(input, ABS_PRESSURE,
+			     cytp->tp_min_pressure, cytp->tp_max_pressure, 0, 0);
+	input_set_abs_params(input, ABS_TOOL_WIDTH, 0, 255, 0, 0);
+
+	/* finger position */
+	input_set_abs_params(input, ABS_MT_POSITION_X, 0, cytp->tp_max_abs_x, 0, 0);
+	input_set_abs_params(input, ABS_MT_POSITION_Y, 0, cytp->tp_max_abs_y, 0, 0);
+	input_set_abs_params(input, ABS_MT_PRESSURE, 0, 255, 0, 0);
+
+	ret = input_mt_init_slots(input, CYTP_MAX_MT_SLOTS,
+			INPUT_MT_DROP_UNUSED|INPUT_MT_TRACK);
+	if (ret < 0)
+		return ret;
+
+	__set_bit(INPUT_PROP_SEMI_MT, input->propbit);
+
+	input_abs_set_res(input, ABS_X, cytp->tp_res_x);
+	input_abs_set_res(input, ABS_Y, cytp->tp_res_y);
+
+	input_abs_set_res(input, ABS_MT_POSITION_X, cytp->tp_res_x);
+	input_abs_set_res(input, ABS_MT_POSITION_Y, cytp->tp_res_y);
+
+	__set_bit(BTN_TOUCH, input->keybit);
+	__set_bit(BTN_TOOL_FINGER, input->keybit);
+	__set_bit(BTN_TOOL_DOUBLETAP, input->keybit);
+	__set_bit(BTN_TOOL_TRIPLETAP, input->keybit);
+	__set_bit(BTN_TOOL_QUADTAP, input->keybit);
+	__set_bit(BTN_TOOL_QUINTTAP, input->keybit);
+
+	__clear_bit(EV_REL, input->evbit);
+	__clear_bit(REL_X, input->relbit);
+	__clear_bit(REL_Y, input->relbit);
+
+	__set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
+	__set_bit(EV_KEY, input->evbit);
+	__set_bit(BTN_LEFT, input->keybit);
+	__set_bit(BTN_RIGHT, input->keybit);
+	__set_bit(BTN_MIDDLE, input->keybit);
+
+	input_set_drvdata(input, cytp);
+
+	return 0;
+}
+
+static int cypress_get_finger_count(unsigned char header_byte)
+{
+	unsigned char bits6_7;
+	int finger_count;
+
+	bits6_7 = header_byte >> 6;
+	finger_count = bits6_7 & 0x03;
+
+	if (finger_count == 1)
+		return 1;
+
+	if (header_byte & ABS_HSCROLL_BIT) {
+		if (finger_count == 0) {
+			/* HSCROLL gets added on to 0 finger count. */
+			finger_count = 4;
+			/* should remove HSCROLL bit. */
+		} else {
+			if (finger_count == 2) {
+				finger_count = 5;
+				/* should remove HSCROLL bit. */
+			} else {
+				/* Invalid contact (e.g. palm). Ignore it. */
+				finger_count = 0;
+			}
+		}
+	}
+
+	return finger_count;
+}
+
+
+static int cypress_parse_packet(struct psmouse *psmouse,
+				struct cytp_data *cytp, struct cytp_report_data *report_data)
+{
+	unsigned char *packet = psmouse->packet;
+	unsigned char header_byte = packet[0];
+
+	memset(report_data, 0, sizeof(struct cytp_report_data));
+
+	report_data->contact_cnt = cypress_get_finger_count(header_byte);
+
+	if (report_data->contact_cnt == 0) /* e.g. palm detect */
+		return 0;
+
+	report_data->tap = (header_byte & ABS_MULTIFINGER_TAP) ? 1 : 0;
+
+	if (report_data->contact_cnt == 1) {
+		report_data->contacts[0].x =
+			((packet[1] & 0x70) << 4) | packet[2];
+		report_data->contacts[0].y =
+			((packet[1] & 0x07) << 8) | packet[3];
+		if (cytp->mode & CYTP_BIT_ABS_PRESSURE)
+			report_data->contacts[0].z = packet[4];
+
+	} else if (report_data->contact_cnt >= 2) {
+		report_data->contacts[0].x =
+			((packet[1] & 0x70) << 4) | packet[2];
+		report_data->contacts[0].y =
+			((packet[1] & 0x07) << 8) | packet[3];
+		if (cytp->mode & CYTP_BIT_ABS_PRESSURE)
+			report_data->contacts[0].z = packet[4];
+
+		report_data->contacts[1].x =
+			((packet[5] & 0xf0) << 4) | packet[6];
+		report_data->contacts[1].y =
+			((packet[5] & 0x0f) << 8) | packet[7];
+		if (cytp->mode & CYTP_BIT_ABS_PRESSURE)
+			report_data->contacts[1].z = report_data->contacts[0].z;
+	}
+
+	report_data->left = (header_byte & BTN_LEFT_BIT) ? 1 : 0;
+	report_data->right = (header_byte & BTN_RIGHT_BIT) ? 1 : 0;
+
+	/* This is only true if one of the mouse buttons were tapped.
+	 * Make sure it doesn't turn into a click. The regular tap-to-
+	 * click functionality will handle that on its own. If we don't
+	 * do this, disabling tap-to-click won't affect the mouse button
+	 * zones. */
+	if (report_data->tap)
+		report_data->left = 0;
+
+#ifdef CYTP_DEBUG_VERBOSE
+	{
+		int i;
+		int n = report_data->contact_cnt;
+		cytp_dbg("cypress_parse_packet cytp->zero_packet_cnt = %d\n",
+				cytp->zero_packet_cnt);
+		cytp_dbg("Dump parsed report data as below:\n");
+		cytp_dbg("contact_cnt = %d\n", report_data->contact_cnt);
+		if (n > CYTP_MAX_MT_SLOTS)
+		    n = CYTP_MAX_MT_SLOTS;
+		for (i = 0; i < n; i++)
+			cytp_dbg("contacts[%d] = {%d, %d, %d}\n", i,
+					report_data->contacts[i].x,
+					report_data->contacts[i].y,
+					report_data->contacts[i].z);
+		cytp_dbg("left = %d\n", report_data->left);
+		cytp_dbg("right = %d\n", report_data->right);
+		cytp_dbg("middle = %d\n", report_data->middle);
+	}
+#endif
+
+	return 0;
+}
+
+static void cypress_process_packet(struct psmouse *psmouse, bool zero_pkt)
+{
+	int i;
+	struct input_dev *input = psmouse->dev;
+	struct cytp_data *cytp = psmouse->private;
+	struct cytp_report_data report_data;
+	struct cytp_contact *contact;
+	struct input_mt_pos pos[CYTP_MAX_MT_SLOTS];
+	int slots[CYTP_MAX_MT_SLOTS];
+	int n;
+
+	if (cypress_parse_packet(psmouse, cytp, &report_data))
+		return;
+
+	n = report_data.contact_cnt;
+
+	if (n > CYTP_MAX_MT_SLOTS)
+		n = CYTP_MAX_MT_SLOTS;
+
+	for (i = 0; i < n; i++) {
+		contact = &report_data.contacts[i];
+		pos[i].x = contact->x;
+		pos[i].y = contact->y;
+	}
+
+	input_mt_assign_slots(input, slots, pos, n);
+
+	for (i = 0; i < n; i++) {
+		contact = &report_data.contacts[i];
+		input_mt_slot(input, slots[i]);
+		input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
+		input_report_abs(input, ABS_MT_POSITION_X, contact->x);
+		input_report_abs(input, ABS_MT_POSITION_Y, contact->y);
+		input_report_abs(input, ABS_MT_PRESSURE, contact->z);
+	}
+
+	input_mt_sync_frame(input);
+
+	input_mt_report_finger_count(input, report_data.contact_cnt);
+
+	input_report_key(input, BTN_LEFT, report_data.left);
+	input_report_key(input, BTN_RIGHT, report_data.right);
+	input_report_key(input, BTN_MIDDLE, report_data.middle);
+
+	input_sync(input);
+}
+
+static psmouse_ret_t cypress_validate_byte(struct psmouse *psmouse)
+{
+	int contact_cnt;
+	int index = psmouse->pktcnt - 1;
+	unsigned char *packet = psmouse->packet;
+	struct cytp_data *cytp = psmouse->private;
+
+	if (index < 0 || index > cytp->pkt_size)
+		return PSMOUSE_BAD_DATA;
+
+	if ((index == 0) && ((packet[0] & 0xfc) == 0)) {
+		/* call packet process for reporting finger leave. */
+		cypress_process_packet(psmouse, 1);
+		return PSMOUSE_FULL_PACKET;
+	}
+
+	if (cytp->mode & CYTP_BIT_ABS_MASK) {
+		if (index == 0) {
+			if ((packet[0] & 0x08) == 0x08)
+				return PSMOUSE_BAD_DATA;
+
+			contact_cnt = cypress_get_finger_count(packet[0]);
+
+			if (contact_cnt > 5)
+				return PSMOUSE_BAD_DATA;
+
+			if (cytp->mode & CYTP_BIT_ABS_NO_PRESSURE) {
+				cypress_set_packet_size(psmouse, 4);
+				if (contact_cnt == 2)
+					cypress_set_packet_size(psmouse, 7);
+			} else {
+				cypress_set_packet_size(psmouse, 5);
+				if (contact_cnt == 2)
+					cypress_set_packet_size(psmouse, 8);
+			}
+		}
+	}
+
+	return PSMOUSE_GOOD_DATA;
+}
+
+static psmouse_ret_t cypress_protocol_handler(struct psmouse *psmouse)
+{
+	struct cytp_data *cytp = psmouse->private;
+
+	if (psmouse->pktcnt >= cytp->pkt_size) {
+		cypress_process_packet(psmouse, 0);
+		return PSMOUSE_FULL_PACKET;
+	}
+
+	return cypress_validate_byte(psmouse);
+}
+
+static void cypress_set_rate(struct psmouse *psmouse, unsigned int rate)
+{
+	struct cytp_data *cytp = psmouse->private;
+
+	if (rate >= 80) {
+		psmouse->rate = 80;
+		cytp->mode |= CYTP_BIT_HIGH_RATE;
+	} else {
+		psmouse->rate = 40;
+		cytp->mode &= ~CYTP_BIT_HIGH_RATE;
+	}
+
+	ps2_command(&psmouse->ps2dev, (unsigned char *)&psmouse->rate,
+		    PSMOUSE_CMD_SETRATE);
+}
+
+static void cypress_disconnect(struct psmouse *psmouse)
+{
+	cypress_reset(psmouse);
+	kfree(psmouse->private);
+	psmouse->private = NULL;
+}
+
+static int cypress_reconnect(struct psmouse *psmouse)
+{
+	int tries = CYTP_PS2_CMD_TRIES;
+	int rc;
+
+	do {
+		cypress_reset(psmouse);
+		rc = cypress_detect(psmouse, false);
+	} while (rc && (--tries > 0));
+
+	if (rc) {
+		psmouse_err(psmouse, "Reconnect: unable to detect trackpad.\n");
+		return -1;
+	}
+
+	if (cypress_set_absolute_mode(psmouse)) {
+		psmouse_err(psmouse, "Reconnect: Unable to initialize Cypress absolute mode.\n");
+		return -1;
+	}
+
+	return 0;
+}
+
+int cypress_init(struct psmouse *psmouse)
+{
+	struct cytp_data *cytp;
+
+	cytp = (struct cytp_data *)kzalloc(sizeof(struct cytp_data), GFP_KERNEL);
+	psmouse->private = (void *)cytp;
+	if (cytp == NULL)
+		return -ENOMEM;
+
+	cypress_reset(psmouse);
+
+	if (cypress_query_hardware(psmouse)) {
+		psmouse_err(psmouse, "Unable to query Trackpad hardware.\n");
+		goto err_exit;
+	}
+
+	if (cypress_set_absolute_mode(psmouse)) {
+		psmouse_err(psmouse, "init: Unable to initialize Cypress absolute mode.\n");
+		goto err_exit;
+	}
+
+	if (cypress_set_input_params(psmouse->dev, cytp) < 0) {
+		psmouse_err(psmouse, "init: Unable to set input params.\n");
+		goto err_exit;
+	}
+
+	psmouse->model = 1;
+	psmouse->protocol_handler = cypress_protocol_handler;
+	psmouse->set_rate = cypress_set_rate;
+	psmouse->disconnect = cypress_disconnect;
+	psmouse->reconnect = cypress_reconnect;
+	psmouse->cleanup = cypress_reset;
+	psmouse->pktsize = 8;
+	psmouse->resync_time = 0;
+
+	return 0;
+
+err_exit:
+	/*
+	 * Reset Cypress Trackpad as a standard mouse. Then
+	 * let psmouse driver commmunicating with it as default PS2 mouse.
+	 */
+	cypress_reset(psmouse);
+
+	psmouse->private = NULL;
+	kfree(cytp);
+
+	return -1;
+}
+
+bool cypress_supported(void)
+{
+	return true;
+}
diff --git a/drivers/input/mouse/cypress_ps2.h b/drivers/input/mouse/cypress_ps2.h
new file mode 100644
index 0000000..142fa8f
--- /dev/null
+++ b/drivers/input/mouse/cypress_ps2.h
@@ -0,0 +1,216 @@ 
+#ifndef _CYPRESS_PS2_H
+#define _CYPRESS_PS2_H
+
+#include "psmouse.h"
+
+#define CMD_BITS_MASK 0x03
+#define COMPOSIT(x, s) (((x) & CMD_BITS_MASK) << (s))
+
+#define ENCODE_CMD(aa, bb, cc, dd) \
+	(COMPOSIT((aa), 6) | COMPOSIT((bb), 4) | COMPOSIT((cc), 2) | COMPOSIT((dd), 0))
+#define CYTP_CMD_ABS_NO_PRESSURE_MODE       ENCODE_CMD(0, 1, 0, 0)
+#define CYTP_CMD_ABS_WITH_PRESSURE_MODE     ENCODE_CMD(0, 1, 0, 1)
+#define CYTP_CMD_SMBUS_MODE                 ENCODE_CMD(0, 1, 1, 0)
+#define CYTP_CMD_STANDARD_MODE              ENCODE_CMD(0, 2, 0, 0)  /* not implemented yet. */
+#define CYTP_CMD_CYPRESS_REL_MODE           ENCODE_CMD(1, 1, 1, 1)  /* not implemented yet. */
+#define CYTP_CMD_READ_CYPRESS_ID            ENCODE_CMD(0, 0, 0, 0)
+#define CYTP_CMD_READ_TP_METRICS            ENCODE_CMD(0, 0, 0, 1)
+#define CYTP_CMD_SET_HSCROLL_WIDTH(w)       ENCODE_CMD(1, 1, 0, (w))
+#define     CYTP_CMD_SET_HSCROLL_MASK       ENCODE_CMD(1, 1, 0, 0)
+#define CYTP_CMD_SET_VSCROLL_WIDTH(w)       ENCODE_CMD(1, 2, 0, (w))
+#define     CYTP_CMD_SET_VSCROLL_MASK       ENCODE_CMD(1, 2, 0, 0)
+#define CYTP_CMD_SET_PALM_GEOMETRY(e)       ENCODE_CMD(1, 2, 1, (e))
+#define     CYTP_CMD_PALM_GEMMETRY_MASK     ENCODE_CMD(1, 2, 1, 0)
+#define CYTP_CMD_SET_PALM_SENSITIVITY(s)    ENCODE_CMD(1, 2, 2, (s))
+#define     CYTP_CMD_PALM_SENSITIVITY_MASK  ENCODE_CMD(1, 2, 2, 0)
+#define CYTP_CMD_SET_MOUSE_SENSITIVITY(s)   ENCODE_CMD(1, 3, ((s) >> 2), (s))
+#define     CYTP_CMD_MOUSE_SENSITIVITY_MASK ENCODE_CMD(1, 3, 0, 0)
+#define CYTP_CMD_REQUEST_BASELINE_STATUS    ENCODE_CMD(2, 0, 0, 1)
+#define CYTP_CMD_REQUEST_RECALIBRATION      ENCODE_CMD(2, 0, 0, 3)
+
+#define DECODE_CMD_AA(x) (((x) >> 6) & CMD_BITS_MASK)
+#define DECODE_CMD_BB(x) (((x) >> 4) & CMD_BITS_MASK)
+#define DECODE_CMD_CC(x) (((x) >> 2) & CMD_BITS_MASK)
+#define DECODE_CMD_DD(x) ((x) & CMD_BITS_MASK)
+
+/* Cypress trackpad working mode. */
+#define CYTP_BIT_ABS_PRESSURE    (1 << 3)
+#define CYTP_BIT_ABS_NO_PRESSURE (1 << 2)
+#define CYTP_BIT_CYPRESS_REL     (1 << 1)
+#define CYTP_BIT_STANDARD_REL    (1 << 0)
+#define CYTP_BIT_REL_MASK (CYTP_BIT_CYPRESS_REL | CYTP_BIT_STANDARD_REL)
+#define CYTP_BIT_ABS_MASK (CYTP_BIT_ABS_PRESSURE | CYTP_BIT_ABS_NO_PRESSURE)
+#define CYTP_BIT_ABS_REL_MASK (CYTP_BIT_ABS_MASK | CYTP_BIT_REL_MASK)
+
+#define CYTP_BIT_HIGH_RATE       (1 << 4)
+/*
+ * report mode bit is set, firmware working in Remote Mode.
+ * report mode bit is cleared, firmware working in Stream Mode.
+ */
+#define CYTP_BIT_REPORT_MODE     (1 << 5)
+
+/* scrolling width values for set HSCROLL and VSCROLL width command. */
+#define SCROLL_WIDTH_NARROW 1
+#define SCROLL_WIDTH_NORMAL 2
+#define SCROLL_WIDTH_WIDE   3
+
+#define PALM_GEOMETRY_ENABLE  1
+#define PALM_GEOMETRY_DISABLE 0
+
+#define CYPRESS_KEY_1 0x33
+#define CYPRESS_KEY_2 0xCC
+
+#define TP_METRICS_MASK  0x80
+#define FW_VERSION_MASX    0x7f
+#define FW_VER_HIGH_MASK 0x70
+#define FW_VER_LOW_MASK  0x0f
+
+/* Times to retry a ps2_command and millisecond delay between tries. */
+#define CYTP_PS2_CMD_TRIES 3
+#define CYTP_PS2_CMD_DELAY 500
+
+/* time out for PS/2 command only in milliseconds. */
+#define CYTP_CMD_TIMEOUT  200
+#define CYTP_DATA_TIMEOUT 30
+
+#define CYTP_EXT_CMD   0xe8
+#define CYTP_PS2_RETRY 0xfe
+#define CYTP_PS2_ERROR 0xfc
+
+#define CYTP_RESP_RETRY 0x01
+#define CYTP_RESP_ERROR 0xfe
+
+
+#define CYTP_105001_WIDTH  97   /* Dell XPS 13 */
+#define CYTP_105001_HIGH   59
+#define CYTP_DEFAULT_WIDTH (CYTP_105001_WIDTH)
+#define CYTP_DEFAULT_HIGH  (CYTP_105001_HIGH)
+
+#define CYTP_ABS_MAX_X     1600
+#define CYTP_ABS_MAX_Y     900
+#define CYTP_MAX_PRESSURE  255
+#define CYTP_MIN_PRESSURE  0
+
+/* header byte bits of relative package. */
+#define BTN_LEFT_BIT   0x01
+#define BTN_RIGHT_BIT  0x02
+#define BTN_MIDDLE_BIT 0x04
+#define REL_X_SIGN_BIT 0x10
+#define REL_Y_SIGN_BIT 0x20
+
+/* header byte bits of absolute package. */
+#define ABS_VSCROLL_BIT 0x10
+#define ABS_HSCROLL_BIT 0x20
+#define ABS_MULTIFINGER_TAP 0x04
+#define ABS_EDGE_MOTION_MASK 0x80
+
+#define DFLT_RESP_BITS_VALID     0x88  /* SMBus bit should not be set. */
+#define DFLT_RESP_SMBUS_BIT      0x80
+#define   DFLT_SMBUS_MODE        0x80
+#define   DFLT_PS2_MODE          0x00
+#define DFLT_RESP_BIT_MODE       0x40
+#define   DFLT_RESP_REMOTE_MODE  0x40
+#define   DFLT_RESP_STREAM_MODE  0x00
+#define DFLT_RESP_BIT_REPORTING  0x20
+#define DFLT_RESP_BIT_SCALING    0x10
+
+#define TP_METRICS_BIT_PALM               0x80
+#define TP_METRICS_BIT_STUBBORN           0x40
+#define TP_METRICS_BIT_2F_JITTER          0x30
+#define TP_METRICS_BIT_1F_JITTER          0x0c
+#define TP_METRICS_BIT_APA                0x02
+#define TP_METRICS_BIT_MTG                0x01
+#define TP_METRICS_BIT_ABS_PKT_FORMAT_SET 0xf0
+#define TP_METRICS_BIT_2F_SPIKE           0x0c
+#define TP_METRICS_BIT_1F_SPIKE           0x03
+
+/* bits of first byte response of E9h-Status Request command. */
+#define RESP_BTN_RIGHT_BIT  0x01
+#define RESP_BTN_MIDDLE_BIT 0x02
+#define RESP_BTN_LEFT_BIT   0x04
+#define RESP_SCALING_BIT    0x10
+#define RESP_ENABLE_BIT     0x20
+#define RESP_REMOTE_BIT     0x40
+#define RESP_SMBUS_BIT      0x80
+
+#define CYTP_MAX_MT_SLOTS 2
+
+enum cytp_type {
+	CYTP_STG,
+	CYTP_MTG,
+	CYTP_APA,
+};
+
+struct cytp_contact {
+	int x;
+	int y;
+	int z;  /* also named as touch pressure. */
+};
+
+/* The structure of Cypress Trackpad event data. */
+struct cytp_report_data {
+	int contact_cnt;
+	struct cytp_contact contacts[CYTP_MAX_MT_SLOTS];
+	unsigned int left:1;
+	unsigned int right:1;
+	unsigned int middle:1;
+	unsigned int tap:1;  /* multi-finger tap detected. */
+};
+
+/* The structure of Cypress Trackpad device private data. */
+struct cytp_data {
+	int fw_version;
+
+	int pkt_size;
+	int mode;
+
+	int scaling;
+	int reporting;
+
+	int tp_min_pressure;
+	int tp_max_pressure;
+	int tp_width;  /* X direction physical size in mm. */
+	int tp_high;  /* Y direction physical size in mm. */
+	int tp_max_abs_x;  /* Max X absolute units that can be reported. */
+	int tp_max_abs_y;  /* Max Y absolute units that can be reported. */
+
+	int tp_res_x;  /* X resolution in units/mm. */
+	int tp_res_y;  /* Y resolution in units/mm. */
+
+	enum cytp_type tp_type;
+	unsigned char tp_palm;
+	unsigned char tp_stubborn;
+	unsigned char tp_2f_jitter;
+	unsigned char tp_1f_jitter;
+	unsigned char tp_abs_packet_format_set;
+	unsigned char tp_2f_spike;
+	unsigned char tp_1f_spike;
+
+	int tp_metrics_supported;
+
+	int prev_contact_cnt;
+	int zero_packet_cnt;
+	struct cytp_report_data prev_report_data;
+};
+
+
+#ifdef CONFIG_MOUSE_PS2_CYPRESS
+int cypress_detect(struct psmouse *psmouse, bool set_properties);
+int cypress_init(struct psmouse *psmouse);
+bool cypress_supported(void);
+#else
+inline int cypress_detect(struct psmouse *psmouse, bool set_properties)
+{
+	return -ENOSYS;
+}
+inline int cypress_init(struct psmouse *psmouse)
+{
+	return -ENOSYS;
+}
+inline bool cypress_supported(void)
+{
+	return 0;
+}
+#endif /* CONFIG_MOUSE_PS2_CYPRESS */
+
+#endif  /* _CYPRESS_PS2_H */