2 * Stephen Evanchik <evanchsa@gmail.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 as published by
6 * the Free Software Foundation.
8 * Trademarks are the property of their respective owners.
11 #include <linux/slab.h>
12 #include <linux/delay.h>
13 #include <linux/serio.h>
14 #include <linux/module.h>
15 #include <linux/input.h>
16 #include <linux/libps2.h>
17 #include <linux/proc_fs.h>
18 #include <asm/uaccess.h>
20 #include "trackpoint.h"
23 * Power-on Reset: Resets all trackpoint parameters, including RAM values,
25 * Returns zero on success, non-zero on failure.
27 static int trackpoint_power_on_reset(struct ps2dev *ps2dev)
29 unsigned char results[2];
31 if (ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, TP_COMMAND)) ||
32 ps2_command(ps2dev, results, MAKE_PS2_CMD(0, 2, TP_POR))) {
36 /* POR response should be 0xAA00 or 0xFC00 */
37 if ((results[0] != 0xAA && results[0] != 0xFC) || results[1] != 0x00)
43 * Device IO: read, write and toggle bit
45 static int trackpoint_read(struct ps2dev *ps2dev, unsigned char loc, unsigned char *results)
47 if (ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, TP_COMMAND)) ||
48 ps2_command(ps2dev, results, MAKE_PS2_CMD(0, 1, loc))) {
55 static int trackpoint_write(struct ps2dev *ps2dev, unsigned char loc, unsigned char val)
57 if (ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, TP_COMMAND)) ||
58 ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, TP_WRITE_MEM)) ||
59 ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, loc)) ||
60 ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, val))) {
67 static int trackpoint_toggle_bit(struct ps2dev *ps2dev, unsigned char loc, unsigned char mask)
69 /* Bad things will happen if the loc param isn't in this range */
70 if (loc < 0x20 || loc >= 0x2F)
73 if (ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, TP_COMMAND)) ||
74 ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, TP_TOGGLE)) ||
75 ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, loc)) ||
76 ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, mask))) {
85 * Trackpoint-specific attributes
87 struct trackpoint_attr_data {
89 unsigned char command;
91 unsigned char inverted;
92 unsigned char power_on_default;
95 static ssize_t trackpoint_show_int_attr(struct psmouse *psmouse, void *data, char *buf)
97 struct trackpoint_data *tp = psmouse->private;
98 struct trackpoint_attr_data *attr = data;
99 unsigned char value = *(unsigned char *)((char *)tp + attr->field_offset);
104 return sprintf(buf, "%u\n", value);
107 static ssize_t trackpoint_set_int_attr(struct psmouse *psmouse, void *data,
108 const char *buf, size_t count)
110 struct trackpoint_data *tp = psmouse->private;
111 struct trackpoint_attr_data *attr = data;
112 unsigned char *field = (unsigned char *)((char *)tp + attr->field_offset);
116 err = kstrtou8(buf, 10, &value);
121 trackpoint_write(&psmouse->ps2dev, attr->command, value);
126 #define TRACKPOINT_INT_ATTR(_name, _command, _default) \
127 static struct trackpoint_attr_data trackpoint_attr_##_name = { \
128 .field_offset = offsetof(struct trackpoint_data, _name), \
129 .command = _command, \
130 .power_on_default = _default, \
132 PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO, \
133 &trackpoint_attr_##_name, \
134 trackpoint_show_int_attr, trackpoint_set_int_attr)
136 static ssize_t trackpoint_set_bit_attr(struct psmouse *psmouse, void *data,
137 const char *buf, size_t count)
139 struct trackpoint_data *tp = psmouse->private;
140 struct trackpoint_attr_data *attr = data;
141 unsigned char *field = (unsigned char *)((char *)tp + attr->field_offset);
145 err = kstrtouint(buf, 10, &value);
155 if (*field != value) {
157 trackpoint_toggle_bit(&psmouse->ps2dev, attr->command, attr->mask);
164 #define TRACKPOINT_BIT_ATTR(_name, _command, _mask, _inv, _default) \
165 static struct trackpoint_attr_data trackpoint_attr_##_name = { \
166 .field_offset = offsetof(struct trackpoint_data, \
168 .command = _command, \
171 .power_on_default = _default, \
173 PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO, \
174 &trackpoint_attr_##_name, \
175 trackpoint_show_int_attr, trackpoint_set_bit_attr)
177 #define TRACKPOINT_UPDATE_BIT(_psmouse, _tp, _name) \
179 unsigned char _toggle; \
180 struct trackpoint_attr_data *_attr = &trackpoint_attr_##_name; \
181 trackpoint_read(&_psmouse->ps2dev, _attr->command, &_toggle); \
182 if (((_toggle & _attr->mask) == _attr->mask) != \
184 trackpoint_toggle_bit(&_psmouse->ps2dev, \
189 #define TRACKPOINT_UPDATE(_power_on, _psmouse, _tp, _name) \
191 _tp->_name != trackpoint_attr_##_name.power_on_default) { \
192 if (!trackpoint_attr_##_name.mask) \
193 trackpoint_write(&_psmouse->ps2dev, \
194 trackpoint_attr_##_name.command, \
197 TRACKPOINT_UPDATE_BIT(_psmouse, _tp, _name); \
200 #define TRACKPOINT_SET_POWER_ON_DEFAULT(_tp, _name) \
201 (_tp->_name = trackpoint_attr_##_name.power_on_default)
203 TRACKPOINT_INT_ATTR(sensitivity, TP_SENS, TP_DEF_SENS);
204 TRACKPOINT_INT_ATTR(speed, TP_SPEED, TP_DEF_SPEED);
205 TRACKPOINT_INT_ATTR(inertia, TP_INERTIA, TP_DEF_INERTIA);
206 TRACKPOINT_INT_ATTR(reach, TP_REACH, TP_DEF_REACH);
207 TRACKPOINT_INT_ATTR(draghys, TP_DRAGHYS, TP_DEF_DRAGHYS);
208 TRACKPOINT_INT_ATTR(mindrag, TP_MINDRAG, TP_DEF_MINDRAG);
209 TRACKPOINT_INT_ATTR(thresh, TP_THRESH, TP_DEF_THRESH);
210 TRACKPOINT_INT_ATTR(upthresh, TP_UP_THRESH, TP_DEF_UP_THRESH);
211 TRACKPOINT_INT_ATTR(ztime, TP_Z_TIME, TP_DEF_Z_TIME);
212 TRACKPOINT_INT_ATTR(jenks, TP_JENKS_CURV, TP_DEF_JENKS_CURV);
214 TRACKPOINT_BIT_ATTR(press_to_select, TP_TOGGLE_PTSON, TP_MASK_PTSON, 0,
216 TRACKPOINT_BIT_ATTR(skipback, TP_TOGGLE_SKIPBACK, TP_MASK_SKIPBACK, 0,
218 TRACKPOINT_BIT_ATTR(ext_dev, TP_TOGGLE_EXT_DEV, TP_MASK_EXT_DEV, 1,
220 TRACKPOINT_BIT_ATTR(twohand, TP_TOGGLE_TWOHAND, TP_MASK_TWOHAND, 0,
222 TRACKPOINT_BIT_ATTR(source_tag, TP_TOGGLE_SOURCE_TAG, TP_MASK_SOURCE_TAG, 0,
224 TRACKPOINT_BIT_ATTR(mb, TP_TOGGLE_MB, TP_MASK_MB, 0,
227 static struct attribute *trackpoint_attrs[] = {
228 &psmouse_attr_sensitivity.dattr.attr,
229 &psmouse_attr_speed.dattr.attr,
230 &psmouse_attr_inertia.dattr.attr,
231 &psmouse_attr_reach.dattr.attr,
232 &psmouse_attr_draghys.dattr.attr,
233 &psmouse_attr_mindrag.dattr.attr,
234 &psmouse_attr_thresh.dattr.attr,
235 &psmouse_attr_upthresh.dattr.attr,
236 &psmouse_attr_ztime.dattr.attr,
237 &psmouse_attr_jenks.dattr.attr,
238 &psmouse_attr_press_to_select.dattr.attr,
239 &psmouse_attr_skipback.dattr.attr,
240 &psmouse_attr_ext_dev.dattr.attr,
241 &psmouse_attr_twohand.dattr.attr,
242 &psmouse_attr_source_tag.dattr.attr,
243 &psmouse_attr_mb.dattr.attr,
247 static struct attribute_group trackpoint_attr_group = {
248 .attrs = trackpoint_attrs,
251 static int trackpoint_start_protocol(struct psmouse *psmouse, unsigned char *firmware_id)
253 unsigned char param[2] = { 0 };
255 if (ps2_command(&psmouse->ps2dev, param, MAKE_PS2_CMD(0, 2, TP_READ_ID)))
258 if (param[0] != TP_MAGIC_IDENT)
262 *firmware_id = param[1];
268 * Write parameters to trackpad.
269 * in_power_on_state: Set to true if TP is in default / power-on state (ex. if
270 * power-on reset was run). If so, values will only be
271 * written to TP if they differ from power-on default.
273 static int trackpoint_sync(struct psmouse *psmouse, bool in_power_on_state)
275 struct trackpoint_data *tp = psmouse->private;
278 * These properties can be changed in this driver. Only
279 * configure them if the values are non-default or if the TP is in
282 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, sensitivity);
283 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, inertia);
284 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, speed);
285 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, reach);
286 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, draghys);
287 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, mindrag);
288 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, thresh);
289 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, upthresh);
290 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, ztime);
291 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, jenks);
294 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, press_to_select);
295 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, skipback);
296 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, ext_dev);
297 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, twohand);
298 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, source_tag);
299 TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, mb);
304 static void trackpoint_defaults(struct trackpoint_data *tp)
306 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, sensitivity);
307 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, speed);
308 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, reach);
309 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, draghys);
310 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, mindrag);
311 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, thresh);
312 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, upthresh);
313 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, ztime);
314 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, jenks);
315 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, inertia);
318 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, press_to_select);
319 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, skipback);
320 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, ext_dev);
321 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, twohand);
322 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, source_tag);
323 TRACKPOINT_SET_POWER_ON_DEFAULT(tp, mb);
326 static void trackpoint_disconnect(struct psmouse *psmouse)
328 sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj, &trackpoint_attr_group);
330 kfree(psmouse->private);
331 psmouse->private = NULL;
334 static int trackpoint_reconnect(struct psmouse *psmouse)
338 if (trackpoint_start_protocol(psmouse, NULL))
341 reset_fail = trackpoint_power_on_reset(&psmouse->ps2dev);
342 if (trackpoint_sync(psmouse, !reset_fail))
348 int trackpoint_detect(struct psmouse *psmouse, bool set_properties)
350 struct ps2dev *ps2dev = &psmouse->ps2dev;
351 unsigned char firmware_id;
352 unsigned char button_info;
355 if (trackpoint_start_protocol(psmouse, &firmware_id))
361 if (trackpoint_read(&psmouse->ps2dev, TP_EXT_BTN, &button_info)) {
362 psmouse_warn(psmouse, "failed to get extended button data\n");
366 psmouse->private = kzalloc(sizeof(struct trackpoint_data), GFP_KERNEL);
367 if (!psmouse->private)
370 psmouse->vendor = "IBM";
371 psmouse->name = "TrackPoint";
373 psmouse->reconnect = trackpoint_reconnect;
374 psmouse->disconnect = trackpoint_disconnect;
376 if ((button_info & 0x0f) >= 3)
377 __set_bit(BTN_MIDDLE, psmouse->dev->keybit);
379 trackpoint_defaults(psmouse->private);
381 error = trackpoint_power_on_reset(&psmouse->ps2dev);
383 /* Write defaults to TP only if reset fails. */
385 trackpoint_sync(psmouse, false);
387 error = sysfs_create_group(&ps2dev->serio->dev.kobj, &trackpoint_attr_group);
390 "failed to create sysfs attributes, error: %d\n",
392 kfree(psmouse->private);
393 psmouse->private = NULL;
397 psmouse_info(psmouse,
398 "IBM TrackPoint firmware: 0x%02x, buttons: %d/%d\n",
400 (button_info & 0xf0) >> 4, button_info & 0x0f);