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 <asm/uaccess.h>
  19 #include "psmouse.h"
  20 #include "trackpoint.h"
  21
  22 /*
  23  * Device IO: read, write and toggle bit
  24  */
  25 static int trackpoint_read(struct ps2dev *ps2dev, unsigned char loc, unsigned char *results)
  26 {
  27         if (ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, TP_COMMAND)) ||
  28             ps2_command(ps2dev, results, MAKE_PS2_CMD(0, 1, loc))) {
  29                 return -1;
  30         }
  31
  32         return 0;
  33 }
  34
  35 static int trackpoint_write(struct ps2dev *ps2dev, unsigned char loc, unsigned char val)
  36 {
  37         if (ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, TP_COMMAND)) ||
  38             ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, TP_WRITE_MEM)) ||
  39             ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, loc)) ||
  40             ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, val))) {
  41                 return -1;
  42         }
  43
  44         return 0;
  45 }
  46
  47 static int trackpoint_toggle_bit(struct ps2dev *ps2dev, unsigned char loc, unsigned char mask)
  48 {
  49         /* Bad things will happen if the loc param isn't in this range */
  50         if (loc < 0x20 || loc >= 0x2F)
  51                 return -1;
  52
  53         if (ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, TP_COMMAND)) ||
  54             ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, TP_TOGGLE)) ||
  55             ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, loc)) ||
  56             ps2_command(ps2dev, NULL, MAKE_PS2_CMD(0, 0, mask))) {
  57                 return -1;
  58         }
  59
  60         return 0;
  61 }
  62
  63
  64 /*
  65  * Trackpoint-specific attributes
  66  */
  67 struct trackpoint_attr_data {
  68         size_t field_offset;
  69         unsigned char command;
  70         unsigned char mask;
  71         unsigned char inverted;
  72 };
  73
  74 static ssize_t trackpoint_show_int_attr(struct psmouse *psmouse, void *data, char *buf)
  75 {
  76         struct trackpoint_data *tp = psmouse->private;
  77         struct trackpoint_attr_data *attr = data;
  78         unsigned char value = *(unsigned char *)((char *)tp + attr->field_offset);
  79
  80         if (attr->inverted)
  81                 value = !value;
  82
  83         return sprintf(buf, "%u\n", value);
  84 }
  85
  86 static ssize_t trackpoint_set_int_attr(struct psmouse *psmouse, void *data,
  87                                         const char *buf, size_t count)
  88 {
  89         struct trackpoint_data *tp = psmouse->private;
  90         struct trackpoint_attr_data *attr = data;
  91         unsigned char *field = (unsigned char *)((char *)tp + attr->field_offset);
  92         unsigned long value;
  93
  94         if (strict_strtoul(buf, 10, &value) || value > 255)
  95                 return -EINVAL;
  96
  97         *field = value;
  98         trackpoint_write(&psmouse->ps2dev, attr->command, value);
  99
 100         return count;
 101 }
 102
 103 #define TRACKPOINT_INT_ATTR(_name, _command)                                    \
 104         static struct trackpoint_attr_data trackpoint_attr_##_name = {          \
 105                 .field_offset = offsetof(struct trackpoint_data, _name),        \
 106                 .command = _command,                                            \
 107         };                                                                      \
 108         PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO,                           \
 109                             &trackpoint_attr_##_name,                           \
 110                             trackpoint_show_int_attr, trackpoint_set_int_attr)
 111
 112 static ssize_t trackpoint_set_bit_attr(struct psmouse *psmouse, void *data,
 113                                         const char *buf, size_t count)
 114 {
 115         struct trackpoint_data *tp = psmouse->private;
 116         struct trackpoint_attr_data *attr = data;
 117         unsigned char *field = (unsigned char *)((char *)tp + attr->field_offset);
 118         unsigned long value;
 119
 120         if (strict_strtoul(buf, 10, &value) || value > 1)
 121                 return -EINVAL;
 122
 123         if (attr->inverted)
 124                 value = !value;
 125
 126         if (*field != value) {
 127                 *field = value;
 128                 trackpoint_toggle_bit(&psmouse->ps2dev, attr->command, attr->mask);
 129         }
 130
 131         return count;
 132 }
 133
 134
 135 #define TRACKPOINT_BIT_ATTR(_name, _command, _mask, _inv)                               \
 136         static struct trackpoint_attr_data trackpoint_attr_##_name = {          \
 137                 .field_offset   = offsetof(struct trackpoint_data, _name),      \
 138                 .command        = _command,                                     \
 139                 .mask           = _mask,                                        \
 140                 .inverted       = _inv,                                         \
 141         };                                                                      \
 142         PSMOUSE_DEFINE_ATTR(_name, S_IWUSR | S_IRUGO,                           \
 143                             &trackpoint_attr_##_name,                           \
 144                             trackpoint_show_int_attr, trackpoint_set_bit_attr)
 145
 146 TRACKPOINT_INT_ATTR(sensitivity, TP_SENS);
 147 TRACKPOINT_INT_ATTR(speed, TP_SPEED);
 148 TRACKPOINT_INT_ATTR(inertia, TP_INERTIA);
 149 TRACKPOINT_INT_ATTR(reach, TP_REACH);
 150 TRACKPOINT_INT_ATTR(draghys, TP_DRAGHYS);
 151 TRACKPOINT_INT_ATTR(mindrag, TP_MINDRAG);
 152 TRACKPOINT_INT_ATTR(thresh, TP_THRESH);
 153 TRACKPOINT_INT_ATTR(upthresh, TP_UP_THRESH);
 154 TRACKPOINT_INT_ATTR(ztime, TP_Z_TIME);
 155 TRACKPOINT_INT_ATTR(jenks, TP_JENKS_CURV);
 156
 157 TRACKPOINT_BIT_ATTR(press_to_select, TP_TOGGLE_PTSON, TP_MASK_PTSON, 0);
 158 TRACKPOINT_BIT_ATTR(skipback, TP_TOGGLE_SKIPBACK, TP_MASK_SKIPBACK, 0);
 159 TRACKPOINT_BIT_ATTR(ext_dev, TP_TOGGLE_EXT_DEV, TP_MASK_EXT_DEV, 1);
 160
 161 static struct attribute *trackpoint_attrs[] = {
 162         &psmouse_attr_sensitivity.dattr.attr,
 163         &psmouse_attr_speed.dattr.attr,
 164         &psmouse_attr_inertia.dattr.attr,
 165         &psmouse_attr_reach.dattr.attr,
 166         &psmouse_attr_draghys.dattr.attr,
 167         &psmouse_attr_mindrag.dattr.attr,
 168         &psmouse_attr_thresh.dattr.attr,
 169         &psmouse_attr_upthresh.dattr.attr,
 170         &psmouse_attr_ztime.dattr.attr,
 171         &psmouse_attr_jenks.dattr.attr,
 172         &psmouse_attr_press_to_select.dattr.attr,
 173         &psmouse_attr_skipback.dattr.attr,
 174         &psmouse_attr_ext_dev.dattr.attr,
 175         NULL
 176 };
 177
 178 static struct attribute_group trackpoint_attr_group = {
 179         .attrs = trackpoint_attrs,
 180 };
 181
 182 static int trackpoint_start_protocol(struct psmouse *psmouse, unsigned char *firmware_id)
 183 {
 184         unsigned char param[2] = { 0 };
 185
 186         if (ps2_command(&psmouse->ps2dev, param, MAKE_PS2_CMD(0, 2, TP_READ_ID)))
 187                 return -1;
 188
 189         /* add new TP ID. */
 190         if (!(param[0] & TP_MAGIC_IDENT))
 191                 return -1;
 192
 193         if (firmware_id)
 194                 *firmware_id = param[1];
 195
 196         return 0;
 197 }
 198
 199 static int trackpoint_sync(struct psmouse *psmouse)
 200 {
 201         struct trackpoint_data *tp = psmouse->private;
 202         unsigned char toggle;
 203
 204         /* Disable features that may make device unusable with this driver */
 205         trackpoint_read(&psmouse->ps2dev, TP_TOGGLE_TWOHAND, &toggle);
 206         if (toggle & TP_MASK_TWOHAND)
 207                 trackpoint_toggle_bit(&psmouse->ps2dev, TP_TOGGLE_TWOHAND, TP_MASK_TWOHAND);
 208
 209         trackpoint_read(&psmouse->ps2dev, TP_TOGGLE_SOURCE_TAG, &toggle);
 210         if (toggle & TP_MASK_SOURCE_TAG)
 211                 trackpoint_toggle_bit(&psmouse->ps2dev, TP_TOGGLE_SOURCE_TAG, TP_MASK_SOURCE_TAG);
 212
 213         trackpoint_read(&psmouse->ps2dev, TP_TOGGLE_MB, &toggle);
 214         if (toggle & TP_MASK_MB)
 215                 trackpoint_toggle_bit(&psmouse->ps2dev, TP_TOGGLE_MB, TP_MASK_MB);
 216
 217         /* Push the config to the device */
 218         trackpoint_write(&psmouse->ps2dev, TP_SENS, tp->sensitivity);
 219         trackpoint_write(&psmouse->ps2dev, TP_INERTIA, tp->inertia);
 220         trackpoint_write(&psmouse->ps2dev, TP_SPEED, tp->speed);
 221
 222         trackpoint_write(&psmouse->ps2dev, TP_REACH, tp->reach);
 223         trackpoint_write(&psmouse->ps2dev, TP_DRAGHYS, tp->draghys);
 224         trackpoint_write(&psmouse->ps2dev, TP_MINDRAG, tp->mindrag);
 225
 226         trackpoint_write(&psmouse->ps2dev, TP_THRESH, tp->thresh);
 227         trackpoint_write(&psmouse->ps2dev, TP_UP_THRESH, tp->upthresh);
 228
 229         trackpoint_write(&psmouse->ps2dev, TP_Z_TIME, tp->ztime);
 230         trackpoint_write(&psmouse->ps2dev, TP_JENKS_CURV, tp->jenks);
 231
 232         trackpoint_read(&psmouse->ps2dev, TP_TOGGLE_PTSON, &toggle);
 233         if (((toggle & TP_MASK_PTSON) == TP_MASK_PTSON) != tp->press_to_select)
 234                  trackpoint_toggle_bit(&psmouse->ps2dev, TP_TOGGLE_PTSON, TP_MASK_PTSON);
 235
 236         trackpoint_read(&psmouse->ps2dev, TP_TOGGLE_SKIPBACK, &toggle);
 237         if (((toggle & TP_MASK_SKIPBACK) == TP_MASK_SKIPBACK) != tp->skipback)
 238                 trackpoint_toggle_bit(&psmouse->ps2dev, TP_TOGGLE_SKIPBACK, TP_MASK_SKIPBACK);
 239
 240         trackpoint_read(&psmouse->ps2dev, TP_TOGGLE_EXT_DEV, &toggle);
 241         if (((toggle & TP_MASK_EXT_DEV) == TP_MASK_EXT_DEV) != tp->ext_dev)
 242                 trackpoint_toggle_bit(&psmouse->ps2dev, TP_TOGGLE_EXT_DEV, TP_MASK_EXT_DEV);
 243
 244         return 0;
 245 }
 246
 247 static void trackpoint_defaults(struct trackpoint_data *tp)
 248 {
 249         tp->press_to_select = TP_DEF_PTSON;
 250         tp->sensitivity = TP_DEF_SENS;
 251         tp->speed = TP_DEF_SPEED;
 252         tp->reach = TP_DEF_REACH;
 253
 254         tp->draghys = TP_DEF_DRAGHYS;
 255         tp->mindrag = TP_DEF_MINDRAG;
 256
 257         tp->thresh = TP_DEF_THRESH;
 258         tp->upthresh = TP_DEF_UP_THRESH;
 259
 260         tp->ztime = TP_DEF_Z_TIME;
 261         tp->jenks = TP_DEF_JENKS_CURV;
 262
 263         tp->inertia = TP_DEF_INERTIA;
 264         tp->skipback = TP_DEF_SKIPBACK;
 265         tp->ext_dev = TP_DEF_EXT_DEV;
 266 }
 267
 268 static void trackpoint_disconnect(struct psmouse *psmouse)
 269 {
 270         sysfs_remove_group(&psmouse->ps2dev.serio->dev.kobj, &trackpoint_attr_group);
 271
 272         kfree(psmouse->private);
 273         psmouse->private = NULL;
 274 }
 275
 276 static int trackpoint_reconnect(struct psmouse *psmouse)
 277 {
 278         if (trackpoint_start_protocol(psmouse, NULL))
 279                 return -1;
 280
 281         if (trackpoint_sync(psmouse))
 282                 return -1;
 283
 284         return 0;
 285 }
 286
 287 int trackpoint_detect(struct psmouse *psmouse, bool set_properties)
 288 {
 289         struct ps2dev *ps2dev = &psmouse->ps2dev;
 290         unsigned char firmware_id;
 291         unsigned char button_info;
 292         int error;
 293
 294         if (trackpoint_start_protocol(psmouse, &firmware_id))
 295                 return -1;
 296
 297         if (!set_properties)
 298                 return 0;
 299
 300         if (trackpoint_read(&psmouse->ps2dev, TP_EXT_BTN, &button_info)) {
 301                 printk(KERN_WARNING "trackpoint.c: failed to get extended button data, assuming 3 buttons\n");
 302                 button_info = 0x33;
 303         } else if (!button_info) {
 304                 printk(KERN_WARNING "trackpoint.c: got 0 in extended button data, assuming 3 buttons\n");
 305                 button_info = 0x33;
 306         }
 307
 308         psmouse->private = kzalloc(sizeof(struct trackpoint_data), GFP_KERNEL);
 309         if (!psmouse->private)
 310                 return -ENOMEM;
 311
 312         psmouse->vendor = "IBM";
 313         psmouse->name = "TrackPoint";
 314
 315         psmouse->reconnect = trackpoint_reconnect;
 316         psmouse->disconnect = trackpoint_disconnect;
 317
 318         if ((button_info & 0x0f) >= 3)
 319                 __set_bit(BTN_MIDDLE, psmouse->dev->keybit);
 320
 321         trackpoint_defaults(psmouse->private);
 322         trackpoint_sync(psmouse);
 323
 324         error = sysfs_create_group(&ps2dev->serio->dev.kobj, &trackpoint_attr_group);
 325         if (error) {
 326                 printk(KERN_ERR
 327                         "trackpoint.c: failed to create sysfs attributes, error: %d\n",
 328                         error);
 329                 kfree(psmouse->private);
 330                 psmouse->private = NULL;
 331                 return -1;
 332         }
 333
 334         printk(KERN_INFO "IBM TrackPoint firmware: 0x%02x, buttons: %d/%d\n",
 335                 firmware_id, (button_info & 0xf0) >> 4, button_info & 0x0f);
 336
 337         return 0;
 338 }
 339