[deliverable/linux.git] / drivers / input / mouse / cypress_ps2.h

#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 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

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 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. */

	int tp_metrics_supported;
};


#ifdef CONFIG_MOUSE_PS2_CYPRESS
int cypress_detect(struct psmouse *psmouse, bool set_properties);
int cypress_init(struct psmouse *psmouse);
#else
inline int cypress_detect(struct psmouse *psmouse, bool set_properties)
{
	return -ENOSYS;
}
inline int cypress_init(struct psmouse *psmouse)
{
	return -ENOSYS;
}
#endif /* CONFIG_MOUSE_PS2_CYPRESS */

#endif  /* _CYPRESS_PS2_H */
Commit	Line	Data
0799a924 DD	1	#ifndef _CYPRESS_PS2_H
	2	#define _CYPRESS_PS2_H
	3
	4	#include "psmouse.h"
	5
	6	#define CMD_BITS_MASK 0x03
	7	#define COMPOSIT(x, s) (((x) & CMD_BITS_MASK) << (s))
	8
	9	#define ENCODE_CMD(aa, bb, cc, dd) \
	10	(COMPOSIT((aa), 6) \| COMPOSIT((bb), 4) \| COMPOSIT((cc), 2) \| COMPOSIT((dd), 0))
	11	#define CYTP_CMD_ABS_NO_PRESSURE_MODE ENCODE_CMD(0, 1, 0, 0)
	12	#define CYTP_CMD_ABS_WITH_PRESSURE_MODE ENCODE_CMD(0, 1, 0, 1)
	13	#define CYTP_CMD_SMBUS_MODE ENCODE_CMD(0, 1, 1, 0)
	14	#define CYTP_CMD_STANDARD_MODE ENCODE_CMD(0, 2, 0, 0) /* not implemented yet. */
	15	#define CYTP_CMD_CYPRESS_REL_MODE ENCODE_CMD(1, 1, 1, 1) /* not implemented yet. */
	16	#define CYTP_CMD_READ_CYPRESS_ID ENCODE_CMD(0, 0, 0, 0)
	17	#define CYTP_CMD_READ_TP_METRICS ENCODE_CMD(0, 0, 0, 1)
	18	#define CYTP_CMD_SET_HSCROLL_WIDTH(w) ENCODE_CMD(1, 1, 0, (w))
	19	#define CYTP_CMD_SET_HSCROLL_MASK ENCODE_CMD(1, 1, 0, 0)
	20	#define CYTP_CMD_SET_VSCROLL_WIDTH(w) ENCODE_CMD(1, 2, 0, (w))
	21	#define CYTP_CMD_SET_VSCROLL_MASK ENCODE_CMD(1, 2, 0, 0)
	22	#define CYTP_CMD_SET_PALM_GEOMETRY(e) ENCODE_CMD(1, 2, 1, (e))
	23	#define CYTP_CMD_PALM_GEMMETRY_MASK ENCODE_CMD(1, 2, 1, 0)
	24	#define CYTP_CMD_SET_PALM_SENSITIVITY(s) ENCODE_CMD(1, 2, 2, (s))
	25	#define CYTP_CMD_PALM_SENSITIVITY_MASK ENCODE_CMD(1, 2, 2, 0)
	26	#define CYTP_CMD_SET_MOUSE_SENSITIVITY(s) ENCODE_CMD(1, 3, ((s) >> 2), (s))
	27	#define CYTP_CMD_MOUSE_SENSITIVITY_MASK ENCODE_CMD(1, 3, 0, 0)
	28	#define CYTP_CMD_REQUEST_BASELINE_STATUS ENCODE_CMD(2, 0, 0, 1)
	29	#define CYTP_CMD_REQUEST_RECALIBRATION ENCODE_CMD(2, 0, 0, 3)
	30
	31	#define DECODE_CMD_AA(x) (((x) >> 6) & CMD_BITS_MASK)
	32	#define DECODE_CMD_BB(x) (((x) >> 4) & CMD_BITS_MASK)
	33	#define DECODE_CMD_CC(x) (((x) >> 2) & CMD_BITS_MASK)
	34	#define DECODE_CMD_DD(x) ((x) & CMD_BITS_MASK)
	35
	36	/* Cypress trackpad working mode. */
	37	#define CYTP_BIT_ABS_PRESSURE (1 << 3)
	38	#define CYTP_BIT_ABS_NO_PRESSURE (1 << 2)
	39	#define CYTP_BIT_CYPRESS_REL (1 << 1)
	40	#define CYTP_BIT_STANDARD_REL (1 << 0)
	41	#define CYTP_BIT_REL_MASK (CYTP_BIT_CYPRESS_REL \| CYTP_BIT_STANDARD_REL)
	42	#define CYTP_BIT_ABS_MASK (CYTP_BIT_ABS_PRESSURE \| CYTP_BIT_ABS_NO_PRESSURE)
	43	#define CYTP_BIT_ABS_REL_MASK (CYTP_BIT_ABS_MASK \| CYTP_BIT_REL_MASK)
	44
	45	#define CYTP_BIT_HIGH_RATE (1 << 4)
	46	/*
	47	* report mode bit is set, firmware working in Remote Mode.
	48	* report mode bit is cleared, firmware working in Stream Mode.
	49	*/
	50	#define CYTP_BIT_REPORT_MODE (1 << 5)
	51
	52	/* scrolling width values for set HSCROLL and VSCROLL width command. */
	53	#define SCROLL_WIDTH_NARROW 1
	54	#define SCROLL_WIDTH_NORMAL 2
	55	#define SCROLL_WIDTH_WIDE 3
	56
	57	#define PALM_GEOMETRY_ENABLE 1
	58	#define PALM_GEOMETRY_DISABLE 0
	59
	60	#define TP_METRICS_MASK 0x80
	61	#define FW_VERSION_MASX 0x7f
	62	#define FW_VER_HIGH_MASK 0x70
	63	#define FW_VER_LOW_MASK 0x0f
	64
65	/* Times to retry a ps2_command and millisecond delay between tries. */
66	#define CYTP_PS2_CMD_TRIES 3
67	#define CYTP_PS2_CMD_DELAY 500
68
69	/* time out for PS/2 command only in milliseconds. */
70	#define CYTP_CMD_TIMEOUT 200
71	#define CYTP_DATA_TIMEOUT 30
72
73	#define CYTP_EXT_CMD 0xe8
74	#define CYTP_PS2_RETRY 0xfe
75	#define CYTP_PS2_ERROR 0xfc
76
77	#define CYTP_RESP_RETRY 0x01
78	#define CYTP_RESP_ERROR 0xfe
79
80
81	#define CYTP_105001_WIDTH 97 /* Dell XPS 13 */
82	#define CYTP_105001_HIGH 59
83	#define CYTP_DEFAULT_WIDTH (CYTP_105001_WIDTH)
84	#define CYTP_DEFAULT_HIGH (CYTP_105001_HIGH)
85
86	#define CYTP_ABS_MAX_X 1600
87	#define CYTP_ABS_MAX_Y 900
88	#define CYTP_MAX_PRESSURE 255
89	#define CYTP_MIN_PRESSURE 0
90
91	/* header byte bits of relative package. */
92	#define BTN_LEFT_BIT 0x01
93	#define BTN_RIGHT_BIT 0x02
94	#define BTN_MIDDLE_BIT 0x04
95	#define REL_X_SIGN_BIT 0x10
96	#define REL_Y_SIGN_BIT 0x20
97
98	/* header byte bits of absolute package. */
99	#define ABS_VSCROLL_BIT 0x10
100	#define ABS_HSCROLL_BIT 0x20
101	#define ABS_MULTIFINGER_TAP 0x04
102	#define ABS_EDGE_MOTION_MASK 0x80
103
104	#define DFLT_RESP_BITS_VALID 0x88 /* SMBus bit should not be set. */
105	#define DFLT_RESP_SMBUS_BIT 0x80
106	#define DFLT_SMBUS_MODE 0x80
107	#define DFLT_PS2_MODE 0x00
108	#define DFLT_RESP_BIT_MODE 0x40
109	#define DFLT_RESP_REMOTE_MODE 0x40
110	#define DFLT_RESP_STREAM_MODE 0x00
111	#define DFLT_RESP_BIT_REPORTING 0x20
112	#define DFLT_RESP_BIT_SCALING 0x10
113
114	#define TP_METRICS_BIT_PALM 0x80
115	#define TP_METRICS_BIT_STUBBORN 0x40
116	#define TP_METRICS_BIT_2F_JITTER 0x30
117	#define TP_METRICS_BIT_1F_JITTER 0x0c
118	#define TP_METRICS_BIT_APA 0x02
119	#define TP_METRICS_BIT_MTG 0x01
120	#define TP_METRICS_BIT_ABS_PKT_FORMAT_SET 0xf0
121	#define TP_METRICS_BIT_2F_SPIKE 0x0c
122	#define TP_METRICS_BIT_1F_SPIKE 0x03
123
124	/* bits of first byte response of E9h-Status Request command. */
125	#define RESP_BTN_RIGHT_BIT 0x01
126	#define RESP_BTN_MIDDLE_BIT 0x02
127	#define RESP_BTN_LEFT_BIT 0x04
128	#define RESP_SCALING_BIT 0x10
129	#define RESP_ENABLE_BIT 0x20
130	#define RESP_REMOTE_BIT 0x40
131	#define RESP_SMBUS_BIT 0x80
132
133	#define CYTP_MAX_MT_SLOTS 2
134
135	struct cytp_contact {
136	int x;
137	int y;
138	int z; /* also named as touch pressure. */
139	};
140
141	/* The structure of Cypress Trackpad event data. */
142	struct cytp_report_data {
143	int contact_cnt;
144	struct cytp_contact contacts[CYTP_MAX_MT_SLOTS];
145	unsigned int left:1;
146	unsigned int right:1;
147	unsigned int middle:1;
148	unsigned int tap:1; /* multi-finger tap detected. */
149	};
150
151	/* The structure of Cypress Trackpad device private data. */
152	struct cytp_data {
153	int fw_version;
154
155	int pkt_size;
156	int mode;
157
158	int tp_min_pressure;
159	int tp_max_pressure;
160	int tp_width; /* X direction physical size in mm. */
161	int tp_high; /* Y direction physical size in mm. */
162	int tp_max_abs_x; /* Max X absolute units that can be reported. */
163	int tp_max_abs_y; /* Max Y absolute units that can be reported. */
164
165	int tp_res_x; /* X resolution in units/mm. */
166	int tp_res_y; /* Y resolution in units/mm. */
167
168	int tp_metrics_supported;
169	};
170
171
172	#ifdef CONFIG_MOUSE_PS2_CYPRESS
173	int cypress_detect(struct psmouse *psmouse, bool set_properties);
174	int cypress_init(struct psmouse *psmouse);
0799a924 DD	175	#else
	176	inline int cypress_detect(struct psmouse *psmouse, bool set_properties)
	177	{
	178	return -ENOSYS;
	179	}
	180	inline int cypress_init(struct psmouse *psmouse)
	181	{
	182	return -ENOSYS;
	183	}
0799a924 DD	184	#endif /* CONFIG_MOUSE_PS2_CYPRESS */
	185
	186	#endif /* _CYPRESS_PS2_H */