1 // SPDX-License-Identifier: GPL-2.0-only
3 * hdaps.c - driver for IBM's Hard Drive Active Protection System
8 * The HardDisk Active Protection System (hdaps) is present in IBM ThinkPads
9 * starting with the R40, T41, and X40. It provides a basic two-axis
10 * accelerometer and other data, such as the device's temperature.
12 * This driver is based on the document by Mark A. Smith available at
13 * http://www.almaden.ibm.com/cs/people/marksmith/tpaps.html and a lot of trial
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/delay.h>
20 #include <linux/platform_device.h>
21 #include <linux/input-polldev.h>
22 #include <linux/kernel.h>
23 #include <linux/mutex.h>
24 #include <linux/module.h>
25 #include <linux/timer.h>
26 #include <linux/dmi.h>
27 #include <linux/jiffies.h>
30 #define HDAPS_LOW_PORT 0x1600 /* first port used by hdaps */
31 #define HDAPS_NR_PORTS 0x30 /* number of ports: 0x1600 - 0x162f */
33 #define HDAPS_PORT_STATE 0x1611 /* device state */
34 #define HDAPS_PORT_YPOS 0x1612 /* y-axis position */
35 #define HDAPS_PORT_XPOS 0x1614 /* x-axis position */
36 #define HDAPS_PORT_TEMP1 0x1616 /* device temperature, in Celsius */
37 #define HDAPS_PORT_YVAR 0x1617 /* y-axis variance (what is this?) */
38 #define HDAPS_PORT_XVAR 0x1619 /* x-axis variance (what is this?) */
39 #define HDAPS_PORT_TEMP2 0x161b /* device temperature (again?) */
40 #define HDAPS_PORT_UNKNOWN 0x161c /* what is this? */
41 #define HDAPS_PORT_KMACT 0x161d /* keyboard or mouse activity */
43 #define STATE_FRESH 0x50 /* accelerometer data is fresh */
45 #define KEYBD_MASK 0x20 /* set if keyboard activity */
46 #define MOUSE_MASK 0x40 /* set if mouse activity */
47 #define KEYBD_ISSET(n) (!! (n & KEYBD_MASK)) /* keyboard used? */
48 #define MOUSE_ISSET(n) (!! (n & MOUSE_MASK)) /* mouse used? */
50 #define INIT_TIMEOUT_MSECS 4000 /* wait up to 4s for device init ... */
51 #define INIT_WAIT_MSECS 200 /* ... in 200ms increments */
53 #define HDAPS_POLL_INTERVAL 50 /* poll for input every 1/20s (50 ms)*/
54 #define HDAPS_INPUT_FUZZ 4 /* input event threshold */
55 #define HDAPS_INPUT_FLAT 4
57 #define HDAPS_X_AXIS (1 << 0)
58 #define HDAPS_Y_AXIS (1 << 1)
59 #define HDAPS_BOTH_AXES (HDAPS_X_AXIS | HDAPS_Y_AXIS)
61 static struct platform_device *pdev;
62 static struct input_polled_dev *hdaps_idev;
63 static unsigned int hdaps_invert;
64 static u8 km_activity;
68 static DEFINE_MUTEX(hdaps_mtx);
71 * __get_latch - Get the value from a given port. Callers must hold hdaps_mtx.
73 static inline u8 __get_latch(u16 port)
75 return inb(port) & 0xff;
79 * __check_latch - Check a port latch for a given value. Returns zero if the
80 * port contains the given value. Callers must hold hdaps_mtx.
82 static inline int __check_latch(u16 port, u8 val)
84 if (__get_latch(port) == val)
90 * __wait_latch - Wait up to 100us for a port latch to get a certain value,
91 * returning zero if the value is obtained. Callers must hold hdaps_mtx.
93 static int __wait_latch(u16 port, u8 val)
97 for (i = 0; i < 20; i++) {
98 if (!__check_latch(port, val))
107 * __device_refresh - request a refresh from the accelerometer. Does not wait
108 * for refresh to complete. Callers must hold hdaps_mtx.
110 static void __device_refresh(void)
113 if (inb(0x1604) != STATE_FRESH) {
120 * __device_refresh_sync - request a synchronous refresh from the
121 * accelerometer. We wait for the refresh to complete. Returns zero if
122 * successful and nonzero on error. Callers must hold hdaps_mtx.
124 static int __device_refresh_sync(void)
127 return __wait_latch(0x1604, STATE_FRESH);
131 * __device_complete - indicate to the accelerometer that we are done reading
132 * data, and then initiate an async refresh. Callers must hold hdaps_mtx.
134 static inline void __device_complete(void)
142 * hdaps_readb_one - reads a byte from a single I/O port, placing the value in
143 * the given pointer. Returns zero on success or a negative error on failure.
146 static int hdaps_readb_one(unsigned int port, u8 *val)
150 mutex_lock(&hdaps_mtx);
152 /* do a sync refresh -- we need to be sure that we read fresh data */
153 ret = __device_refresh_sync();
161 mutex_unlock(&hdaps_mtx);
165 /* __hdaps_read_pair - internal lockless helper for hdaps_read_pair(). */
166 static int __hdaps_read_pair(unsigned int port1, unsigned int port2,
169 /* do a sync refresh -- we need to be sure that we read fresh data */
170 if (__device_refresh_sync())
175 km_activity = inb(HDAPS_PORT_KMACT);
178 /* hdaps_invert is a bitvector to negate the axes */
179 if (hdaps_invert & HDAPS_X_AXIS)
181 if (hdaps_invert & HDAPS_Y_AXIS)
188 * hdaps_read_pair - reads the values from a pair of ports, placing the values
189 * in the given pointers. Returns zero on success. Can sleep.
191 static int hdaps_read_pair(unsigned int port1, unsigned int port2,
192 int *val1, int *val2)
196 mutex_lock(&hdaps_mtx);
197 ret = __hdaps_read_pair(port1, port2, val1, val2);
198 mutex_unlock(&hdaps_mtx);
204 * hdaps_device_init - initialize the accelerometer. Returns zero on success
205 * and negative error code on failure. Can sleep.
207 static int hdaps_device_init(void)
209 int total, ret = -ENXIO;
211 mutex_lock(&hdaps_mtx);
215 if (__wait_latch(0x161f, 0x00))
219 * Most ThinkPads return 0x01.
221 * Others--namely the R50p, T41p, and T42p--return 0x03. These laptops
222 * have "inverted" axises.
224 * The 0x02 value occurs when the chip has been previously initialized.
226 if (__check_latch(0x1611, 0x03) &&
227 __check_latch(0x1611, 0x02) &&
228 __check_latch(0x1611, 0x01))
231 printk(KERN_DEBUG "hdaps: initial latch check good (0x%02x)\n",
232 __get_latch(0x1611));
237 if (__wait_latch(0x161f, 0x00))
239 if (__wait_latch(0x1611, 0x00))
241 if (__wait_latch(0x1612, 0x60))
243 if (__wait_latch(0x1613, 0x00))
248 if (__wait_latch(0x161f, 0x00))
255 if (__wait_latch(0x161f, 0x00))
257 if (__device_refresh_sync())
259 if (__wait_latch(0x1611, 0x00))
262 /* we have done our dance, now let's wait for the applause */
263 for (total = INIT_TIMEOUT_MSECS; total > 0; total -= INIT_WAIT_MSECS) {
266 /* a read of the device helps push it into action */
267 __hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y);
268 if (!__wait_latch(0x1611, 0x02)) {
273 msleep(INIT_WAIT_MSECS);
277 mutex_unlock(&hdaps_mtx);
282 /* Device model stuff */
284 static int hdaps_probe(struct platform_device *dev)
288 ret = hdaps_device_init();
292 pr_info("device successfully initialized\n");
296 #ifdef CONFIG_PM_SLEEP
297 static int hdaps_resume(struct device *dev)
299 return hdaps_device_init();
303 static SIMPLE_DEV_PM_OPS(hdaps_pm, NULL, hdaps_resume);
305 static struct platform_driver hdaps_driver = {
306 .probe = hdaps_probe,
314 * hdaps_calibrate - Set our "resting" values. Callers must hold hdaps_mtx.
316 static void hdaps_calibrate(void)
318 __hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &rest_x, &rest_y);
321 static void hdaps_mousedev_poll(struct input_polled_dev *dev)
323 struct input_dev *input_dev = dev->input;
326 mutex_lock(&hdaps_mtx);
328 if (__hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y))
331 input_report_abs(input_dev, ABS_X, x - rest_x);
332 input_report_abs(input_dev, ABS_Y, y - rest_y);
333 input_sync(input_dev);
336 mutex_unlock(&hdaps_mtx);
342 static ssize_t hdaps_position_show(struct device *dev,
343 struct device_attribute *attr, char *buf)
347 ret = hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y);
351 return sprintf(buf, "(%d,%d)\n", x, y);
354 static ssize_t hdaps_variance_show(struct device *dev,
355 struct device_attribute *attr, char *buf)
359 ret = hdaps_read_pair(HDAPS_PORT_XVAR, HDAPS_PORT_YVAR, &x, &y);
363 return sprintf(buf, "(%d,%d)\n", x, y);
366 static ssize_t hdaps_temp1_show(struct device *dev,
367 struct device_attribute *attr, char *buf)
369 u8 uninitialized_var(temp);
372 ret = hdaps_readb_one(HDAPS_PORT_TEMP1, &temp);
376 return sprintf(buf, "%u\n", temp);
379 static ssize_t hdaps_temp2_show(struct device *dev,
380 struct device_attribute *attr, char *buf)
382 u8 uninitialized_var(temp);
385 ret = hdaps_readb_one(HDAPS_PORT_TEMP2, &temp);
389 return sprintf(buf, "%u\n", temp);
392 static ssize_t hdaps_keyboard_activity_show(struct device *dev,
393 struct device_attribute *attr,
396 return sprintf(buf, "%u\n", KEYBD_ISSET(km_activity));
399 static ssize_t hdaps_mouse_activity_show(struct device *dev,
400 struct device_attribute *attr,
403 return sprintf(buf, "%u\n", MOUSE_ISSET(km_activity));
406 static ssize_t hdaps_calibrate_show(struct device *dev,
407 struct device_attribute *attr, char *buf)
409 return sprintf(buf, "(%d,%d)\n", rest_x, rest_y);
412 static ssize_t hdaps_calibrate_store(struct device *dev,
413 struct device_attribute *attr,
414 const char *buf, size_t count)
416 mutex_lock(&hdaps_mtx);
418 mutex_unlock(&hdaps_mtx);
423 static ssize_t hdaps_invert_show(struct device *dev,
424 struct device_attribute *attr, char *buf)
426 return sprintf(buf, "%u\n", hdaps_invert);
429 static ssize_t hdaps_invert_store(struct device *dev,
430 struct device_attribute *attr,
431 const char *buf, size_t count)
435 if (sscanf(buf, "%d", &invert) != 1 ||
436 invert < 0 || invert > HDAPS_BOTH_AXES)
439 hdaps_invert = invert;
445 static DEVICE_ATTR(position, 0444, hdaps_position_show, NULL);
446 static DEVICE_ATTR(variance, 0444, hdaps_variance_show, NULL);
447 static DEVICE_ATTR(temp1, 0444, hdaps_temp1_show, NULL);
448 static DEVICE_ATTR(temp2, 0444, hdaps_temp2_show, NULL);
449 static DEVICE_ATTR(keyboard_activity, 0444, hdaps_keyboard_activity_show, NULL);
450 static DEVICE_ATTR(mouse_activity, 0444, hdaps_mouse_activity_show, NULL);
451 static DEVICE_ATTR(calibrate, 0644, hdaps_calibrate_show,hdaps_calibrate_store);
452 static DEVICE_ATTR(invert, 0644, hdaps_invert_show, hdaps_invert_store);
454 static struct attribute *hdaps_attributes[] = {
455 &dev_attr_position.attr,
456 &dev_attr_variance.attr,
457 &dev_attr_temp1.attr,
458 &dev_attr_temp2.attr,
459 &dev_attr_keyboard_activity.attr,
460 &dev_attr_mouse_activity.attr,
461 &dev_attr_calibrate.attr,
462 &dev_attr_invert.attr,
466 static struct attribute_group hdaps_attribute_group = {
467 .attrs = hdaps_attributes,
473 /* hdaps_dmi_match - found a match. return one, short-circuiting the hunt. */
474 static int __init hdaps_dmi_match(const struct dmi_system_id *id)
476 pr_info("%s detected\n", id->ident);
480 /* hdaps_dmi_match_invert - found an inverted match. */
481 static int __init hdaps_dmi_match_invert(const struct dmi_system_id *id)
483 hdaps_invert = (unsigned long)id->driver_data;
484 pr_info("inverting axis (%u) readings\n", hdaps_invert);
485 return hdaps_dmi_match(id);
488 #define HDAPS_DMI_MATCH_INVERT(vendor, model, axes) { \
489 .ident = vendor " " model, \
490 .callback = hdaps_dmi_match_invert, \
491 .driver_data = (void *)axes, \
493 DMI_MATCH(DMI_BOARD_VENDOR, vendor), \
494 DMI_MATCH(DMI_PRODUCT_VERSION, model) \
498 #define HDAPS_DMI_MATCH_NORMAL(vendor, model) \
499 HDAPS_DMI_MATCH_INVERT(vendor, model, 0)
501 /* Note that HDAPS_DMI_MATCH_NORMAL("ThinkPad T42") would match
502 "ThinkPad T42p", so the order of the entries matters.
503 If your ThinkPad is not recognized, please update to latest
504 BIOS. This is especially the case for some R52 ThinkPads. */
505 static const struct dmi_system_id hdaps_whitelist[] __initconst = {
506 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad R50p", HDAPS_BOTH_AXES),
507 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R50"),
508 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R51"),
509 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R52"),
510 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad R61i", HDAPS_BOTH_AXES),
511 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad R61", HDAPS_BOTH_AXES),
512 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad T41p", HDAPS_BOTH_AXES),
513 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T41"),
514 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad T42p", HDAPS_BOTH_AXES),
515 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T42"),
516 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T43"),
517 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T400", HDAPS_BOTH_AXES),
518 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T60", HDAPS_BOTH_AXES),
519 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T61p", HDAPS_BOTH_AXES),
520 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T61", HDAPS_BOTH_AXES),
521 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad X40"),
522 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad X41", HDAPS_Y_AXIS),
523 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X60", HDAPS_BOTH_AXES),
524 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X61s", HDAPS_BOTH_AXES),
525 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X61", HDAPS_BOTH_AXES),
526 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad Z60m"),
527 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad Z61m", HDAPS_BOTH_AXES),
528 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad Z61p", HDAPS_BOTH_AXES),
532 static int __init hdaps_init(void)
534 struct input_dev *idev;
537 if (!dmi_check_system(hdaps_whitelist)) {
538 pr_warn("supported laptop not found!\n");
543 if (!request_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS, "hdaps")) {
548 ret = platform_driver_register(&hdaps_driver);
552 pdev = platform_device_register_simple("hdaps", -1, NULL, 0);
558 ret = sysfs_create_group(&pdev->dev.kobj, &hdaps_attribute_group);
562 hdaps_idev = input_allocate_polled_device();
568 hdaps_idev->poll = hdaps_mousedev_poll;
569 hdaps_idev->poll_interval = HDAPS_POLL_INTERVAL;
571 /* initial calibrate for the input device */
574 /* initialize the input class */
575 idev = hdaps_idev->input;
576 idev->name = "hdaps";
577 idev->phys = "isa1600/input0";
578 idev->id.bustype = BUS_ISA;
579 idev->dev.parent = &pdev->dev;
580 idev->evbit[0] = BIT_MASK(EV_ABS);
581 input_set_abs_params(idev, ABS_X,
582 -256, 256, HDAPS_INPUT_FUZZ, HDAPS_INPUT_FLAT);
583 input_set_abs_params(idev, ABS_Y,
584 -256, 256, HDAPS_INPUT_FUZZ, HDAPS_INPUT_FLAT);
586 ret = input_register_polled_device(hdaps_idev);
590 pr_info("driver successfully loaded\n");
594 input_free_polled_device(hdaps_idev);
596 sysfs_remove_group(&pdev->dev.kobj, &hdaps_attribute_group);
598 platform_device_unregister(pdev);
600 platform_driver_unregister(&hdaps_driver);
602 release_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS);
604 pr_warn("driver init failed (ret=%d)!\n", ret);
608 static void __exit hdaps_exit(void)
610 input_unregister_polled_device(hdaps_idev);
611 input_free_polled_device(hdaps_idev);
612 sysfs_remove_group(&pdev->dev.kobj, &hdaps_attribute_group);
613 platform_device_unregister(pdev);
614 platform_driver_unregister(&hdaps_driver);
615 release_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS);
617 pr_info("driver unloaded\n");
620 module_init(hdaps_init);
621 module_exit(hdaps_exit);
623 module_param_named(invert, hdaps_invert, int, 0);
624 MODULE_PARM_DESC(invert, "invert data along each axis. 1 invert x-axis, "
625 "2 invert y-axis, 3 invert both axes.");
627 MODULE_AUTHOR("Robert Love");
628 MODULE_DESCRIPTION("IBM Hard Drive Active Protection System (HDAPS) driver");
629 MODULE_LICENSE("GPL v2");