2 * Focaltech TouchPad PS/2 mouse driver
4 * Copyright (c) 2014 Red Hat Inc.
5 * Copyright (c) 2014 Mathias Gottschlag <mgottschlag@gmail.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
14 * Hans de Goede <hdegoede@redhat.com>
18 #include <linux/device.h>
19 #include <linux/libps2.h>
20 #include <linux/input/mt.h>
21 #include <linux/serio.h>
22 #include <linux/slab.h>
24 #include "focaltech.h"
26 static const char * const focaltech_pnp_ids[] = {
34 * Even if the kernel is built without support for Focaltech PS/2 touchpads (or
35 * when the real driver fails to recognize the device), we still have to detect
36 * them in order to avoid further detection attempts confusing the touchpad.
37 * This way it at least works in PS/2 mouse compatibility mode.
39 int focaltech_detect(struct psmouse *psmouse, bool set_properties)
41 if (!psmouse_matches_pnp_id(psmouse, focaltech_pnp_ids))
45 psmouse->vendor = "FocalTech";
46 psmouse->name = "FocalTech Touchpad";
52 static void focaltech_reset(struct psmouse *psmouse)
54 ps2_command(&psmouse->ps2dev, NULL, PSMOUSE_CMD_RESET_DIS);
55 psmouse_reset(psmouse);
58 #ifdef CONFIG_MOUSE_PS2_FOCALTECH
61 * Packet types - the numbers are not consecutive, so we might be missing
64 #define FOC_TOUCH 0x3 /* bitmap of active fingers */
65 #define FOC_ABS 0x6 /* absolute position of one finger */
66 #define FOC_REL 0x9 /* relative position of 1-2 fingers */
68 #define FOC_MAX_FINGERS 5
71 * Current state of a single finger on the touchpad.
73 struct focaltech_finger_state {
74 /* The touchpad has generated a touch event for the finger */
78 * The touchpad has sent position data for the finger. The
79 * flag is 0 when the finger is not active, and there is a
80 * time between the first touch event for the finger and the
81 * following absolute position packet for the finger where the
82 * touchpad has declared the finger to be valid, but we do not
83 * have any valid position yet.
88 * Absolute position (from the bottom left corner) of the
96 * Description of the current state of the touchpad hardware.
98 struct focaltech_hw_state {
100 * The touchpad tracks the positions of the fingers for us,
101 * the array indices correspond to the finger indices returned
102 * in the report packages.
104 struct focaltech_finger_state fingers[FOC_MAX_FINGERS];
106 /* True if the clickpad has been pressed. */
110 struct focaltech_data {
111 unsigned int x_max, y_max;
112 struct focaltech_hw_state state;
115 static void focaltech_report_state(struct psmouse *psmouse)
117 struct focaltech_data *priv = psmouse->private;
118 struct focaltech_hw_state *state = &priv->state;
119 struct input_dev *dev = psmouse->dev;
122 for (i = 0; i < FOC_MAX_FINGERS; i++) {
123 struct focaltech_finger_state *finger = &state->fingers[i];
124 bool active = finger->active && finger->valid;
126 input_mt_slot(dev, i);
127 input_mt_report_slot_state(dev, MT_TOOL_FINGER, active);
129 unsigned int clamped_x, clamped_y;
131 * The touchpad might report invalid data, so we clamp
132 * the resulting values so that we do not confuse
135 clamped_x = clamp(finger->x, 0U, priv->x_max);
136 clamped_y = clamp(finger->y, 0U, priv->y_max);
137 input_report_abs(dev, ABS_MT_POSITION_X, clamped_x);
138 input_report_abs(dev, ABS_MT_POSITION_Y,
139 priv->y_max - clamped_y);
142 input_mt_report_pointer_emulation(dev, true);
144 input_report_key(psmouse->dev, BTN_LEFT, state->pressed);
145 input_sync(psmouse->dev);
148 static void focaltech_process_touch_packet(struct psmouse *psmouse,
149 unsigned char *packet)
151 struct focaltech_data *priv = psmouse->private;
152 struct focaltech_hw_state *state = &priv->state;
153 unsigned char fingers = packet[1];
156 state->pressed = (packet[0] >> 4) & 1;
158 /* the second byte contains a bitmap of all fingers touching the pad */
159 for (i = 0; i < FOC_MAX_FINGERS; i++) {
160 state->fingers[i].active = fingers & 0x1;
161 if (!state->fingers[i].active) {
163 * Even when the finger becomes active again, we still
164 * will have to wait for the first valid position.
166 state->fingers[i].valid = false;
172 static void focaltech_process_abs_packet(struct psmouse *psmouse,
173 unsigned char *packet)
175 struct focaltech_data *priv = psmouse->private;
176 struct focaltech_hw_state *state = &priv->state;
179 finger = (packet[1] >> 4) - 1;
180 if (finger >= FOC_MAX_FINGERS) {
181 psmouse_err(psmouse, "Invalid finger in abs packet: %d\n",
186 state->pressed = (packet[0] >> 4) & 1;
189 * packet[5] contains some kind of tool size in the most
190 * significant nibble. 0xff is a special value (latching) that
191 * signals a large contact area.
193 if (packet[5] == 0xff) {
194 state->fingers[finger].valid = false;
198 state->fingers[finger].x = ((packet[1] & 0xf) << 8) | packet[2];
199 state->fingers[finger].y = (packet[3] << 8) | packet[4];
200 state->fingers[finger].valid = true;
203 static void focaltech_process_rel_packet(struct psmouse *psmouse,
204 unsigned char *packet)
206 struct focaltech_data *priv = psmouse->private;
207 struct focaltech_hw_state *state = &priv->state;
208 int finger1, finger2;
210 state->pressed = packet[0] >> 7;
211 finger1 = ((packet[0] >> 4) & 0x7) - 1;
212 if (finger1 < FOC_MAX_FINGERS) {
213 state->fingers[finger1].x += (char)packet[1];
214 state->fingers[finger1].y += (char)packet[2];
216 psmouse_err(psmouse, "First finger in rel packet invalid: %d\n",
221 * If there is an odd number of fingers, the last relative
222 * packet only contains one finger. In this case, the second
223 * finger index in the packet is 0 (we subtract 1 in the lines
224 * above to create array indices, so the finger will overflow
225 * and be above FOC_MAX_FINGERS).
227 finger2 = ((packet[3] >> 4) & 0x7) - 1;
228 if (finger2 < FOC_MAX_FINGERS) {
229 state->fingers[finger2].x += (char)packet[4];
230 state->fingers[finger2].y += (char)packet[5];
234 static void focaltech_process_packet(struct psmouse *psmouse)
236 unsigned char *packet = psmouse->packet;
238 switch (packet[0] & 0xf) {
240 focaltech_process_touch_packet(psmouse, packet);
244 focaltech_process_abs_packet(psmouse, packet);
248 focaltech_process_rel_packet(psmouse, packet);
252 psmouse_err(psmouse, "Unknown packet type: %02x\n", packet[0]);
256 focaltech_report_state(psmouse);
259 static psmouse_ret_t focaltech_process_byte(struct psmouse *psmouse)
261 if (psmouse->pktcnt >= 6) { /* Full packet received */
262 focaltech_process_packet(psmouse);
263 return PSMOUSE_FULL_PACKET;
267 * We might want to do some validation of the data here, but
268 * we do not know the protocol well enough
270 return PSMOUSE_GOOD_DATA;
273 static int focaltech_switch_protocol(struct psmouse *psmouse)
275 struct ps2dev *ps2dev = &psmouse->ps2dev;
276 unsigned char param[3];
279 if (ps2_command(ps2dev, param, 0x10f8))
282 if (ps2_command(ps2dev, param, 0x10f8))
285 if (ps2_command(ps2dev, param, 0x10f8))
289 if (ps2_command(ps2dev, param, 0x10f8))
292 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETSCALE11))
295 if (ps2_command(ps2dev, param, PSMOUSE_CMD_ENABLE))
301 static void focaltech_disconnect(struct psmouse *psmouse)
303 focaltech_reset(psmouse);
304 kfree(psmouse->private);
305 psmouse->private = NULL;
308 static int focaltech_reconnect(struct psmouse *psmouse)
312 focaltech_reset(psmouse);
314 error = focaltech_switch_protocol(psmouse);
316 psmouse_err(psmouse, "Unable to initialize the device\n");
323 static void focaltech_set_input_params(struct psmouse *psmouse)
325 struct input_dev *dev = psmouse->dev;
326 struct focaltech_data *priv = psmouse->private;
329 * Undo part of setup done for us by psmouse core since touchpad
330 * is not a relative device.
332 __clear_bit(EV_REL, dev->evbit);
333 __clear_bit(REL_X, dev->relbit);
334 __clear_bit(REL_Y, dev->relbit);
335 __clear_bit(BTN_RIGHT, dev->keybit);
336 __clear_bit(BTN_MIDDLE, dev->keybit);
339 * Now set up our capabilities.
341 __set_bit(EV_ABS, dev->evbit);
342 input_set_abs_params(dev, ABS_MT_POSITION_X, 0, priv->x_max, 0, 0);
343 input_set_abs_params(dev, ABS_MT_POSITION_Y, 0, priv->y_max, 0, 0);
344 input_mt_init_slots(dev, 5, INPUT_MT_POINTER);
345 __set_bit(INPUT_PROP_BUTTONPAD, dev->propbit);
348 static int focaltech_read_register(struct ps2dev *ps2dev, int reg,
349 unsigned char *param)
351 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETSCALE11))
355 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES))
358 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES))
361 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES))
365 if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES))
368 if (ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
374 static int focaltech_read_size(struct psmouse *psmouse)
376 struct ps2dev *ps2dev = &psmouse->ps2dev;
377 struct focaltech_data *priv = psmouse->private;
380 if (focaltech_read_register(ps2dev, 2, param))
383 /* not sure whether this is 100% correct */
384 priv->x_max = (unsigned char)param[1] * 128;
385 priv->y_max = (unsigned char)param[2] * 128;
390 void focaltech_set_resolution(struct psmouse *psmouse, unsigned int resolution)
392 /* not supported yet */
395 static void focaltech_set_rate(struct psmouse *psmouse, unsigned int rate)
397 /* not supported yet */
400 static void focaltech_set_scale(struct psmouse *psmouse,
401 enum psmouse_scale scale)
403 /* not supported yet */
406 int focaltech_init(struct psmouse *psmouse)
408 struct focaltech_data *priv;
411 psmouse->private = priv = kzalloc(sizeof(struct focaltech_data),
416 focaltech_reset(psmouse);
418 error = focaltech_read_size(psmouse);
421 "Unable to read the size of the touchpad\n");
425 error = focaltech_switch_protocol(psmouse);
427 psmouse_err(psmouse, "Unable to initialize the device\n");
431 focaltech_set_input_params(psmouse);
433 psmouse->protocol_handler = focaltech_process_byte;
434 psmouse->pktsize = 6;
435 psmouse->disconnect = focaltech_disconnect;
436 psmouse->reconnect = focaltech_reconnect;
437 psmouse->cleanup = focaltech_reset;
438 /* resync is not supported yet */
439 psmouse->resync_time = 0;
441 * rate/resolution/scale changes are not supported yet, and
442 * the generic implementations of these functions seem to
443 * confuse some touchpads
445 psmouse->set_resolution = focaltech_set_resolution;
446 psmouse->set_rate = focaltech_set_rate;
447 psmouse->set_scale = focaltech_set_scale;
452 focaltech_reset(psmouse);
457 #else /* CONFIG_MOUSE_PS2_FOCALTECH */
459 int focaltech_init(struct psmouse *psmouse)
461 focaltech_reset(psmouse);
466 #endif /* CONFIG_MOUSE_PS2_FOCALTECH */