trackpoint.c 13 KB

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