drivers/input/mouse/trackpoint.c

   1 /*
   2  * Stephen Evanchik <evanchsa@gmail.com>
   3  *
   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.
   7  *
   8  * Trademarks are the property of their respective owners.
   9  */
  10
  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 <linux/uaccess.h>
  19 #include "psmouse.h"
  20 #include "trackpoint.h"
  21
  22 static const char * const trackpoint_variants[] = {
  23         [TP_VARIANT_IBM]                = "IBM",
  24         [TP_VARIANT_ALPS]               = "ALPS",
  25         [TP_VARIANT_ELAN]               = "Elan",
  26         [TP_VARIANT_NXP]                = "NXP",
  27         [TP_VARIANT_JYT_SYNAPTICS]      = "JYT_Synaptics",
  28         [TP_VARIANT_SYNAPTICS]          = "Synaptics",
  29 };
  30
  31 /*
  32  * Power-on Reset: Resets all trackpoint parameters, including RAM values,
  33  * to defaults.
  34  * Returns zero on success, non-zero on failure.
  35  */
  36 static int trackpoint_power_on_reset(struct ps2dev *ps2dev)
  37 {
  38         u8 param[2] = { TP_POR };
  39         int err;
  40
  41         err = ps2_command(ps2dev, param, MAKE_PS2_CMD(1, 2, TP_COMMAND));
  42         if (err)
  43                 return err;
  44
  45         /* Check for success response -- 0xAA00 */
  46         if (param[0] != 0xAA || param[1] != 0x00)
  47                 return -ENODEV;
  48
  49         return 0;
  50 }
  51
  52 /*
  53  * Device IO: read, write and toggle bit
  54  */
  55 static int trackpoint_read(struct ps2dev *ps2dev, u8 loc, u8 *results)
  56 {
  57         results[0] = loc;
  58
  59         return ps2_command(ps2dev, results, MAKE_PS2_CMD(1, 1, TP_COMMAND));
  60 }
  61
  62 static int trackpoint_write(struct ps2dev *ps2dev, u8 loc, u8 val)
  63 {
  64         u8 param[3] = { TP_WRITE_MEM, loc, val };
  65
  66         return ps2_command(ps2dev, param, MAKE_PS2_CMD(3, 0, TP_COMMAND));
  67 }
  68
  69 static int trackpoint_toggle_bit(struct ps2dev *ps2dev, u8 loc, u8 mask)
  70 {
  71         u8 param[3] = { TP_TOGGLE, loc, mask };
  72
  73         /* Bad things will happen if the loc param isn't in this range */
  74         if (loc < 0x20 || loc >= 0x2F)
  75                 return -EINVAL;
  76
  77         return ps2_command(ps2dev, param, MAKE_PS2_CMD(3, 0, TP_COMMAND));
  78 }
  79
  80 static int trackpoint_update_bit(struct ps2dev *ps2dev,
  81                                  u8 loc, u8 mask, u8 value)
  82 {
  83         int retval;
  84         u8 data;
  85
  86         retval = trackpoint_read(ps2dev, loc, &data);
  87         if (retval)
  88                 return retval;
  89
  90         if (((data & mask) == mask) != !!value)
  91                 retval = trackpoint_toggle_bit(ps2dev, loc, mask);
  92
  93         return retval;
  94 }
  95
  96 /*
  97  * Trackpoint-specific attributes
  98  */
  99 struct trackpoint_attr_data {
 100         size_t field_offset;
 101         u8 command;
 102         u8 mask;
 103         bool inverted;
 104         u8 power_on_default;
 105 };
 106
 107 static ssize_t trackpoint_show_int_attr(struct psmouse *psmouse,
 108                                         void *data, char *buf)
 109 {
 110         struct trackpoint_data *tp = psmouse->private;
 111         struct trackpoint_attr_data *attr = data;
 112         u8 value = *(u8 *)((void *)tp + attr->field_offset);
 113
 114         if (attr->inverted)
 115                 value = !value;
 116
 117         return sprintf(buf, "%u\n", value);
 118 }
 119
 120 static ssize_t trackpoint_set_int_attr(struct psmouse *psmouse, void *data,
 121                                         const char *buf, size_t count)
 122 {
 123         struct trackpoint_data *tp = psmouse->private;
 124         struct trackpoint_attr_data *attr = data;
 125         u8 *field = (void *)tp + attr->field_offset;
 126         u8 value;
 127         int err;
 128
 129         err = kstrtou8(buf, 10, &value);
 130         if (err)
 131                 return err;
 132
 133         *field = value;
 134         err = trackpoint_write(&psmouse->ps2dev, attr->command, value);
 135
 136         return err ?: count;
 137 }
 138
 139 #define TRACKPOINT_INT_ATTR(_name, _command, _default)                          \
 140         static struct trackpoint_attr_data trackpoint_attr_##_name = {          \
 141                 .field_offset = offsetof(struct trackpoint_data, _name),        \
 142                 .command = _command,                                            \
 143                 .power_on_default = _default,                                   \
 144         };                                                                      \
 145         PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO,                           \
 146                             &trackpoint_attr_##_name,                           \
 147                             trackpoint_show_int_attr, trackpoint_set_int_attr)
 148
 149 static ssize_t trackpoint_set_bit_attr(struct psmouse *psmouse, void *data,
 150                                         const char *buf, size_t count)
 151 {
 152         struct trackpoint_data *tp = psmouse->private;
 153         struct trackpoint_attr_data *attr = data;
 154         bool *field = (void *)tp + attr->field_offset;
 155         bool value;
 156         int err;
 157
 158         err = kstrtobool(buf, &value);
 159         if (err)
 160                 return err;
 161
 162         if (attr->inverted)
 163                 value = !value;
 164
 165         if (*field != value) {
 166                 *field = value;
 167                 err = trackpoint_toggle_bit(&psmouse->ps2dev,
 168                                             attr->command, attr->mask);
 169         }
 170
 171         return err ?: count;
 172 }
 173
 174
 175 #define TRACKPOINT_BIT_ATTR(_name, _command, _mask, _inv, _default)     \
 176 static struct trackpoint_attr_data trackpoint_attr_##_name = {          \
 177         .field_offset           = offsetof(struct trackpoint_data,      \
 178                                            _name),                      \
 179         .command                = _command,                             \
 180         .mask                   = _mask,                                \
 181         .inverted               = _inv,                                 \
 182         .power_on_default       = _default,                             \
 183         };                                                              \
 184 PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO,                           \
 185                     &trackpoint_attr_##_name,                           \
 186                     trackpoint_show_int_attr, trackpoint_set_bit_attr)
 187
 188 TRACKPOINT_INT_ATTR(sensitivity, TP_SENS, TP_DEF_SENS);
 189 TRACKPOINT_INT_ATTR(speed, TP_SPEED, TP_DEF_SPEED);
 190 TRACKPOINT_INT_ATTR(inertia, TP_INERTIA, TP_DEF_INERTIA);
 191 TRACKPOINT_INT_ATTR(reach, TP_REACH, TP_DEF_REACH);
 192 TRACKPOINT_INT_ATTR(draghys, TP_DRAGHYS, TP_DEF_DRAGHYS);
 193 TRACKPOINT_INT_ATTR(mindrag, TP_MINDRAG, TP_DEF_MINDRAG);
 194 TRACKPOINT_INT_ATTR(thresh, TP_THRESH, TP_DEF_THRESH);
 195 TRACKPOINT_INT_ATTR(upthresh, TP_UP_THRESH, TP_DEF_UP_THRESH);
 196 TRACKPOINT_INT_ATTR(ztime, TP_Z_TIME, TP_DEF_Z_TIME);
 197 TRACKPOINT_INT_ATTR(jenks, TP_JENKS_CURV, TP_DEF_JENKS_CURV);
 198 TRACKPOINT_INT_ATTR(drift_time, TP_DRIFT_TIME, TP_DEF_DRIFT_TIME);
 199
 200 TRACKPOINT_BIT_ATTR(press_to_select, TP_TOGGLE_PTSON, TP_MASK_PTSON, false,
 201                     TP_DEF_PTSON);
 202 TRACKPOINT_BIT_ATTR(skipback, TP_TOGGLE_SKIPBACK, TP_MASK_SKIPBACK, false,
 203                     TP_DEF_SKIPBACK);
 204 TRACKPOINT_BIT_ATTR(ext_dev, TP_TOGGLE_EXT_DEV, TP_MASK_EXT_DEV, true,
 205                     TP_DEF_EXT_DEV);
 206
 207 static bool trackpoint_is_attr_available(struct psmouse *psmouse,
 208                                          struct attribute *attr)
 209 {
 210         struct trackpoint_data *tp = psmouse->private;
 211
 212         return tp->variant_id == TP_VARIANT_IBM ||
 213                 attr == &psmouse_attr_sensitivity.dattr.attr ||
 214                 attr == &psmouse_attr_press_to_select.dattr.attr;
 215 }
 216
 217 static umode_t trackpoint_is_attr_visible(struct kobject *kobj,
 218                                           struct attribute *attr, int n)
 219 {
 220         struct device *dev = container_of(kobj, struct device, kobj);
 221         struct serio *serio = to_serio_port(dev);
 222         struct psmouse *psmouse = serio_get_drvdata(serio);
 223
 224         return trackpoint_is_attr_available(psmouse, attr) ? attr->mode : 0;
 225 }
 226
 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_drift_time.dattr.attr,
 239         &psmouse_attr_press_to_select.dattr.attr,
 240         &psmouse_attr_skipback.dattr.attr,
 241         &psmouse_attr_ext_dev.dattr.attr,
 242         NULL
 243 };
 244
 245 static struct attribute_group trackpoint_attr_group = {
 246         .is_visible     = trackpoint_is_attr_visible,
 247         .attrs          = trackpoint_attrs,
 248 };
 249
 250 #define TRACKPOINT_UPDATE(_power_on, _psmouse, _tp, _name)              \
 251 do {                                                                    \
 252         struct trackpoint_attr_data *_attr = &trackpoint_attr_##_name;  \
 253                                                                         \
 254         if ((!_power_on || _tp->_name != _attr->power_on_default) &&    \
 255             trackpoint_is_attr_available(_psmouse,                      \
 256                                 &psmouse_attr_##_name.dattr.attr)) {    \
 257                 if (!_attr->mask)                                       \
 258                         trackpoint_write(&_psmouse->ps2dev,             \
 259                                          _attr->command, _tp->_name);   \
 260                 else                                                    \
 261                         trackpoint_update_bit(&_psmouse->ps2dev,        \
 262                                         _attr->command, _attr->mask,    \
 263                                         _tp->_name);                    \
 264         }                                                               \
 265 } while (0)
 266
 267 #define TRACKPOINT_SET_POWER_ON_DEFAULT(_tp, _name)                     \
 268 do {                                                                    \
 269         _tp->_name = trackpoint_attr_##_name.power_on_default;          \
 270 } while (0)
 271
 272 static int trackpoint_start_protocol(struct psmouse *psmouse,
 273                                      u8 *variant_id, u8 *firmware_id)
 274 {
 275         u8 param[2] = { 0 };
 276         int error;
 277
 278         error = ps2_command(&psmouse->ps2dev,
 279                             param, MAKE_PS2_CMD(0, 2, TP_READ_ID));
 280         if (error)
 281                 return error;
 282
 283         switch (param[0]) {
 284         case TP_VARIANT_IBM:
 285         case TP_VARIANT_ALPS:
 286         case TP_VARIANT_ELAN:
 287         case TP_VARIANT_NXP:
 288         case TP_VARIANT_JYT_SYNAPTICS:
 289         case TP_VARIANT_SYNAPTICS:
 290                 if (variant_id)
 291                         *variant_id = param[0];
 292                 if (firmware_id)
 293                         *firmware_id = param[1];
 294                 return 0;
 295         }
 296
 297         return -ENODEV;
 298 }
 299
 300 /*
 301  * Write parameters to trackpad.
 302  * in_power_on_state: Set to true if TP is in default / power-on state (ex. if
 303  *                    power-on reset was run). If so, values will only be
 304  *                    written to TP if they differ from power-on default.
 305  */
 306 static int trackpoint_sync(struct psmouse *psmouse, bool in_power_on_state)
 307 {
 308         struct trackpoint_data *tp = psmouse->private;
 309
 310         if (!in_power_on_state && tp->variant_id == TP_VARIANT_IBM) {
 311                 /*
 312                  * Disable features that may make device unusable
 313                  * with this driver.
 314                  */
 315                 trackpoint_update_bit(&psmouse->ps2dev, TP_TOGGLE_TWOHAND,
 316                                       TP_MASK_TWOHAND, TP_DEF_TWOHAND);
 317
 318                 trackpoint_update_bit(&psmouse->ps2dev, TP_TOGGLE_SOURCE_TAG,
 319                                       TP_MASK_SOURCE_TAG, TP_DEF_SOURCE_TAG);
 320
 321                 trackpoint_update_bit(&psmouse->ps2dev, TP_TOGGLE_MB,
 322                                       TP_MASK_MB, TP_DEF_MB);
 323         }
 324
 325         /*
 326          * These properties can be changed in this driver. Only
 327          * configure them if the values are non-default or if the TP is in
 328          * an unknown state.
 329          */
 330         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, sensitivity);
 331         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, inertia);
 332         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, speed);
 333         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, reach);
 334         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, draghys);
 335         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, mindrag);
 336         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, thresh);
 337         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, upthresh);
 338         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, ztime);
 339         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, jenks);
 340         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, drift_time);
 341
 342         /* toggles */
 343         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, press_to_select);
 344         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, skipback);
 345         TRACKPOINT_UPDATE(in_power_on_state, psmouse, tp, ext_dev);
 346
 347         return 0;
 348 }
 349
 350 static void trackpoint_defaults(struct trackpoint_data *tp)
 351 {
 352         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, sensitivity);
 353         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, speed);
 354         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, reach);
 355         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, draghys);
 356         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, mindrag);
 357         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, thresh);
 358         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, upthresh);
 359         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, ztime);
 360         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, jenks);
 361         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, drift_time);
 362         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, inertia);
 363
 364         /* toggles */
 365         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, press_to_select);
 366         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, skipback);
 367         TRACKPOINT_SET_POWER_ON_DEFAULT(tp, ext_dev);
 368 }
 369
 370 static void trackpoint_disconnect(struct psmouse *psmouse)
 371 {
 372         device_remove_group(&psmouse->ps2dev.serio->dev,
 373                             &trackpoint_attr_group);
 374
 375         kfree(psmouse->private);
 376         psmouse->private = NULL;
 377 }
 378
 379 static int trackpoint_reconnect(struct psmouse *psmouse)
 380 {
 381         struct trackpoint_data *tp = psmouse->private;
 382         int error;
 383         bool was_reset;
 384
 385         error = trackpoint_start_protocol(psmouse, NULL, NULL);
 386         if (error)
 387                 return error;
 388
 389         was_reset = tp->variant_id == TP_VARIANT_IBM &&
 390                     trackpoint_power_on_reset(&psmouse->ps2dev) == 0;
 391
 392         error = trackpoint_sync(psmouse, was_reset);
 393         if (error)
 394                 return error;
 395
 396         return 0;
 397 }
 398
 399 int trackpoint_detect(struct psmouse *psmouse, bool set_properties)
 400 {
 401         struct ps2dev *ps2dev = &psmouse->ps2dev;
 402         struct trackpoint_data *tp;
 403         u8 variant_id;
 404         u8 firmware_id;
 405         u8 button_info;
 406         int error;
 407
 408         error = trackpoint_start_protocol(psmouse, &variant_id, &firmware_id);
 409         if (error)
 410                 return error;
 411
 412         if (!set_properties)
 413                 return 0;
 414
 415         tp = kzalloc(sizeof(*tp), GFP_KERNEL);
 416         if (!tp)
 417                 return -ENOMEM;
 418
 419         trackpoint_defaults(tp);
 420         tp->variant_id = variant_id;
 421         tp->firmware_id = firmware_id;
 422
 423         psmouse->private = tp;
 424
 425         psmouse->vendor = trackpoint_variants[variant_id];
 426         psmouse->name = "TrackPoint";
 427
 428         psmouse->reconnect = trackpoint_reconnect;
 429         psmouse->disconnect = trackpoint_disconnect;
 430
 431         if (variant_id != TP_VARIANT_IBM) {
 432                 /* Newer variants do not support extended button query. */
 433                 button_info = 0x33;
 434         } else {
 435                 error = trackpoint_read(ps2dev, TP_EXT_BTN, &button_info);
 436                 if (error) {
 437                         psmouse_warn(psmouse,
 438                                      "failed to get extended button data, assuming 3 buttons\n");
 439                         button_info = 0x33;
 440                 } else if (!button_info) {
 441                         psmouse_warn(psmouse,
 442                                      "got 0 in extended button data, assuming 3 buttons\n");
 443                         button_info = 0x33;
 444                 }
 445         }
 446
 447         if ((button_info & 0x0f) >= 3)
 448                 input_set_capability(psmouse->dev, EV_KEY, BTN_MIDDLE);
 449
 450         __set_bit(INPUT_PROP_POINTER, psmouse->dev->propbit);
 451         __set_bit(INPUT_PROP_POINTING_STICK, psmouse->dev->propbit);
 452
 453         if (variant_id != TP_VARIANT_IBM ||
 454             trackpoint_power_on_reset(ps2dev) != 0) {
 455                 /*
 456                  * Write defaults to TP if we did not reset the trackpoint.
 457                  */
 458                 trackpoint_sync(psmouse, false);
 459         }
 460
 461         error = device_add_group(&ps2dev->serio->dev, &trackpoint_attr_group);
 462         if (error) {
 463                 psmouse_err(psmouse,
 464                             "failed to create sysfs attributes, error: %d\n",
 465                             error);
 466                 kfree(psmouse->private);
 467                 psmouse->private = NULL;
 468                 return -1;
 469         }
 470
 471         psmouse_info(psmouse,
 472                      "%s TrackPoint firmware: 0x%02x, buttons: %d/%d\n",
 473                      psmouse->vendor, firmware_id,
 474                      (button_info & 0xf0) >> 4, button_info & 0x0f);
 475
 476         return 0;
 477 }
 478