2 * hdaps.c - driver for IBM's Hard Drive Active Protection System
4 * Copyright (C) 2005 Robert Love <rml@novell.com>
5 * Copyright (C) 2005 Jesper Juhl <jj@chaosbits.net>
7 * The HardDisk Active Protection System (hdaps) is present in IBM ThinkPads
8 * starting with the R40, T41, and X40. It provides a basic two-axis
9 * accelerometer and other data, such as the device's temperature.
11 * This driver is based on the document by Mark A. Smith available at
12 * http://www.almaden.ibm.com/cs/people/marksmith/tpaps.html and a lot of trial
15 * This program is free software; you can redistribute it and/or modify it
16 * under the terms of the GNU General Public License v2 as published by the
17 * Free Software Foundation.
19 * This program is distributed in the hope that it will be useful, but WITHOUT
20 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
24 * You should have received a copy of the GNU General Public License along with
25 * this program; if not, write to the Free Software Foundation, Inc.,
26 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
29 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31 #include <linux/delay.h>
32 #include <linux/platform_device.h>
33 #include <linux/input-polldev.h>
34 #include <linux/kernel.h>
35 #include <linux/mutex.h>
36 #include <linux/module.h>
37 #include <linux/timer.h>
38 #include <linux/dmi.h>
39 #include <linux/jiffies.h>
42 #define HDAPS_LOW_PORT 0x1600 /* first port used by hdaps */
43 #define HDAPS_NR_PORTS 0x30 /* number of ports: 0x1600 - 0x162f */
45 #define HDAPS_PORT_STATE 0x1611 /* device state */
46 #define HDAPS_PORT_YPOS 0x1612 /* y-axis position */
47 #define HDAPS_PORT_XPOS 0x1614 /* x-axis position */
48 #define HDAPS_PORT_TEMP1 0x1616 /* device temperature, in Celsius */
49 #define HDAPS_PORT_YVAR 0x1617 /* y-axis variance (what is this?) */
50 #define HDAPS_PORT_XVAR 0x1619 /* x-axis variance (what is this?) */
51 #define HDAPS_PORT_TEMP2 0x161b /* device temperature (again?) */
52 #define HDAPS_PORT_UNKNOWN 0x161c /* what is this? */
53 #define HDAPS_PORT_KMACT 0x161d /* keyboard or mouse activity */
55 #define STATE_FRESH 0x50 /* accelerometer data is fresh */
57 #define KEYBD_MASK 0x20 /* set if keyboard activity */
58 #define MOUSE_MASK 0x40 /* set if mouse activity */
59 #define KEYBD_ISSET(n) (!! (n & KEYBD_MASK)) /* keyboard used? */
60 #define MOUSE_ISSET(n) (!! (n & MOUSE_MASK)) /* mouse used? */
62 #define INIT_TIMEOUT_MSECS 4000 /* wait up to 4s for device init ... */
63 #define INIT_WAIT_MSECS 200 /* ... in 200ms increments */
65 #define HDAPS_POLL_INTERVAL 50 /* poll for input every 1/20s (50 ms)*/
66 #define HDAPS_INPUT_FUZZ 4 /* input event threshold */
67 #define HDAPS_INPUT_FLAT 4
69 #define HDAPS_X_AXIS (1 << 0)
70 #define HDAPS_Y_AXIS (1 << 1)
71 #define HDAPS_BOTH_AXES (HDAPS_X_AXIS | HDAPS_Y_AXIS)
73 static struct platform_device *pdev;
74 static struct input_polled_dev *hdaps_idev;
75 static unsigned int hdaps_invert;
76 static u8 km_activity;
80 static DEFINE_MUTEX(hdaps_mtx);
83 * __get_latch - Get the value from a given port. Callers must hold hdaps_mtx.
85 static inline u8 __get_latch(u16 port)
87 return inb(port) & 0xff;
91 * __check_latch - Check a port latch for a given value. Returns zero if the
92 * port contains the given value. Callers must hold hdaps_mtx.
94 static inline int __check_latch(u16 port, u8 val)
96 if (__get_latch(port) == val)
102 * __wait_latch - Wait up to 100us for a port latch to get a certain value,
103 * returning zero if the value is obtained. Callers must hold hdaps_mtx.
105 static int __wait_latch(u16 port, u8 val)
109 for (i = 0; i < 20; i++) {
110 if (!__check_latch(port, val))
119 * __device_refresh - request a refresh from the accelerometer. Does not wait
120 * for refresh to complete. Callers must hold hdaps_mtx.
122 static void __device_refresh(void)
125 if (inb(0x1604) != STATE_FRESH) {
132 * __device_refresh_sync - request a synchronous refresh from the
133 * accelerometer. We wait for the refresh to complete. Returns zero if
134 * successful and nonzero on error. Callers must hold hdaps_mtx.
136 static int __device_refresh_sync(void)
139 return __wait_latch(0x1604, STATE_FRESH);
143 * __device_complete - indicate to the accelerometer that we are done reading
144 * data, and then initiate an async refresh. Callers must hold hdaps_mtx.
146 static inline void __device_complete(void)
154 * hdaps_readb_one - reads a byte from a single I/O port, placing the value in
155 * the given pointer. Returns zero on success or a negative error on failure.
158 static int hdaps_readb_one(unsigned int port, u8 *val)
162 mutex_lock(&hdaps_mtx);
164 /* do a sync refresh -- we need to be sure that we read fresh data */
165 ret = __device_refresh_sync();
173 mutex_unlock(&hdaps_mtx);
177 /* __hdaps_read_pair - internal lockless helper for hdaps_read_pair(). */
178 static int __hdaps_read_pair(unsigned int port1, unsigned int port2,
181 /* do a sync refresh -- we need to be sure that we read fresh data */
182 if (__device_refresh_sync())
187 km_activity = inb(HDAPS_PORT_KMACT);
190 /* hdaps_invert is a bitvector to negate the axes */
191 if (hdaps_invert & HDAPS_X_AXIS)
193 if (hdaps_invert & HDAPS_Y_AXIS)
200 * hdaps_read_pair - reads the values from a pair of ports, placing the values
201 * in the given pointers. Returns zero on success. Can sleep.
203 static int hdaps_read_pair(unsigned int port1, unsigned int port2,
204 int *val1, int *val2)
208 mutex_lock(&hdaps_mtx);
209 ret = __hdaps_read_pair(port1, port2, val1, val2);
210 mutex_unlock(&hdaps_mtx);
216 * hdaps_device_init - initialize the accelerometer. Returns zero on success
217 * and negative error code on failure. Can sleep.
219 static int hdaps_device_init(void)
221 int total, ret = -ENXIO;
223 mutex_lock(&hdaps_mtx);
227 if (__wait_latch(0x161f, 0x00))
231 * Most ThinkPads return 0x01.
233 * Others--namely the R50p, T41p, and T42p--return 0x03. These laptops
234 * have "inverted" axises.
236 * The 0x02 value occurs when the chip has been previously initialized.
238 if (__check_latch(0x1611, 0x03) &&
239 __check_latch(0x1611, 0x02) &&
240 __check_latch(0x1611, 0x01))
243 printk(KERN_DEBUG "hdaps: initial latch check good (0x%02x)\n",
244 __get_latch(0x1611));
249 if (__wait_latch(0x161f, 0x00))
251 if (__wait_latch(0x1611, 0x00))
253 if (__wait_latch(0x1612, 0x60))
255 if (__wait_latch(0x1613, 0x00))
260 if (__wait_latch(0x161f, 0x00))
267 if (__wait_latch(0x161f, 0x00))
269 if (__device_refresh_sync())
271 if (__wait_latch(0x1611, 0x00))
274 /* we have done our dance, now let's wait for the applause */
275 for (total = INIT_TIMEOUT_MSECS; total > 0; total -= INIT_WAIT_MSECS) {
278 /* a read of the device helps push it into action */
279 __hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y);
280 if (!__wait_latch(0x1611, 0x02)) {
285 msleep(INIT_WAIT_MSECS);
289 mutex_unlock(&hdaps_mtx);
294 /* Device model stuff */
296 static int hdaps_probe(struct platform_device *dev)
300 ret = hdaps_device_init();
304 pr_info("device successfully initialized\n");
308 static int hdaps_resume(struct device *dev)
310 return hdaps_device_init();
313 static SIMPLE_DEV_PM_OPS(hdaps_pm, NULL, hdaps_resume);
315 static struct platform_driver hdaps_driver = {
316 .probe = hdaps_probe,
319 .owner = THIS_MODULE,
325 * hdaps_calibrate - Set our "resting" values. Callers must hold hdaps_mtx.
327 static void hdaps_calibrate(void)
329 __hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &rest_x, &rest_y);
332 static void hdaps_mousedev_poll(struct input_polled_dev *dev)
334 struct input_dev *input_dev = dev->input;
337 mutex_lock(&hdaps_mtx);
339 if (__hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y))
342 input_report_abs(input_dev, ABS_X, x - rest_x);
343 input_report_abs(input_dev, ABS_Y, y - rest_y);
344 input_sync(input_dev);
347 mutex_unlock(&hdaps_mtx);
353 static ssize_t hdaps_position_show(struct device *dev,
354 struct device_attribute *attr, char *buf)
358 ret = hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y);
362 return sprintf(buf, "(%d,%d)\n", x, y);
365 static ssize_t hdaps_variance_show(struct device *dev,
366 struct device_attribute *attr, char *buf)
370 ret = hdaps_read_pair(HDAPS_PORT_XVAR, HDAPS_PORT_YVAR, &x, &y);
374 return sprintf(buf, "(%d,%d)\n", x, y);
377 static ssize_t hdaps_temp1_show(struct device *dev,
378 struct device_attribute *attr, char *buf)
380 u8 uninitialized_var(temp);
383 ret = hdaps_readb_one(HDAPS_PORT_TEMP1, &temp);
387 return sprintf(buf, "%u\n", temp);
390 static ssize_t hdaps_temp2_show(struct device *dev,
391 struct device_attribute *attr, char *buf)
393 u8 uninitialized_var(temp);
396 ret = hdaps_readb_one(HDAPS_PORT_TEMP2, &temp);
400 return sprintf(buf, "%u\n", temp);
403 static ssize_t hdaps_keyboard_activity_show(struct device *dev,
404 struct device_attribute *attr,
407 return sprintf(buf, "%u\n", KEYBD_ISSET(km_activity));
410 static ssize_t hdaps_mouse_activity_show(struct device *dev,
411 struct device_attribute *attr,
414 return sprintf(buf, "%u\n", MOUSE_ISSET(km_activity));
417 static ssize_t hdaps_calibrate_show(struct device *dev,
418 struct device_attribute *attr, char *buf)
420 return sprintf(buf, "(%d,%d)\n", rest_x, rest_y);
423 static ssize_t hdaps_calibrate_store(struct device *dev,
424 struct device_attribute *attr,
425 const char *buf, size_t count)
427 mutex_lock(&hdaps_mtx);
429 mutex_unlock(&hdaps_mtx);
434 static ssize_t hdaps_invert_show(struct device *dev,
435 struct device_attribute *attr, char *buf)
437 return sprintf(buf, "%u\n", hdaps_invert);
440 static ssize_t hdaps_invert_store(struct device *dev,
441 struct device_attribute *attr,
442 const char *buf, size_t count)
446 if (sscanf(buf, "%d", &invert) != 1 ||
447 invert < 0 || invert > HDAPS_BOTH_AXES)
450 hdaps_invert = invert;
456 static DEVICE_ATTR(position, 0444, hdaps_position_show, NULL);
457 static DEVICE_ATTR(variance, 0444, hdaps_variance_show, NULL);
458 static DEVICE_ATTR(temp1, 0444, hdaps_temp1_show, NULL);
459 static DEVICE_ATTR(temp2, 0444, hdaps_temp2_show, NULL);
460 static DEVICE_ATTR(keyboard_activity, 0444, hdaps_keyboard_activity_show, NULL);
461 static DEVICE_ATTR(mouse_activity, 0444, hdaps_mouse_activity_show, NULL);
462 static DEVICE_ATTR(calibrate, 0644, hdaps_calibrate_show,hdaps_calibrate_store);
463 static DEVICE_ATTR(invert, 0644, hdaps_invert_show, hdaps_invert_store);
465 static struct attribute *hdaps_attributes[] = {
466 &dev_attr_position.attr,
467 &dev_attr_variance.attr,
468 &dev_attr_temp1.attr,
469 &dev_attr_temp2.attr,
470 &dev_attr_keyboard_activity.attr,
471 &dev_attr_mouse_activity.attr,
472 &dev_attr_calibrate.attr,
473 &dev_attr_invert.attr,
477 static struct attribute_group hdaps_attribute_group = {
478 .attrs = hdaps_attributes,
484 /* hdaps_dmi_match - found a match. return one, short-circuiting the hunt. */
485 static int __init hdaps_dmi_match(const struct dmi_system_id *id)
487 pr_info("%s detected\n", id->ident);
491 /* hdaps_dmi_match_invert - found an inverted match. */
492 static int __init hdaps_dmi_match_invert(const struct dmi_system_id *id)
494 hdaps_invert = (unsigned long)id->driver_data;
495 pr_info("inverting axis (%u) readings\n", hdaps_invert);
496 return hdaps_dmi_match(id);
499 #define HDAPS_DMI_MATCH_INVERT(vendor, model, axes) { \
500 .ident = vendor " " model, \
501 .callback = hdaps_dmi_match_invert, \
502 .driver_data = (void *)axes, \
504 DMI_MATCH(DMI_BOARD_VENDOR, vendor), \
505 DMI_MATCH(DMI_PRODUCT_VERSION, model) \
509 #define HDAPS_DMI_MATCH_NORMAL(vendor, model) \
510 HDAPS_DMI_MATCH_INVERT(vendor, model, 0)
512 /* Note that HDAPS_DMI_MATCH_NORMAL("ThinkPad T42") would match
513 "ThinkPad T42p", so the order of the entries matters.
514 If your ThinkPad is not recognized, please update to latest
515 BIOS. This is especially the case for some R52 ThinkPads. */
516 static struct dmi_system_id __initdata hdaps_whitelist[] = {
517 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad R50p", HDAPS_BOTH_AXES),
518 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R50"),
519 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R51"),
520 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R52"),
521 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad R61i", HDAPS_BOTH_AXES),
522 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad R61", HDAPS_BOTH_AXES),
523 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad T41p", HDAPS_BOTH_AXES),
524 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T41"),
525 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad T42p", HDAPS_BOTH_AXES),
526 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T42"),
527 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T43"),
528 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T400", HDAPS_BOTH_AXES),
529 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T60", HDAPS_BOTH_AXES),
530 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T61p", HDAPS_BOTH_AXES),
531 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T61", HDAPS_BOTH_AXES),
532 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad X40"),
533 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad X41", HDAPS_Y_AXIS),
534 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X60", HDAPS_BOTH_AXES),
535 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X61s", HDAPS_BOTH_AXES),
536 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X61", HDAPS_BOTH_AXES),
537 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad Z60m"),
538 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad Z61m", HDAPS_BOTH_AXES),
539 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad Z61p", HDAPS_BOTH_AXES),
543 static int __init hdaps_init(void)
545 struct input_dev *idev;
548 if (!dmi_check_system(hdaps_whitelist)) {
549 pr_warn("supported laptop not found!\n");
554 if (!request_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS, "hdaps")) {
559 ret = platform_driver_register(&hdaps_driver);
563 pdev = platform_device_register_simple("hdaps", -1, NULL, 0);
569 ret = sysfs_create_group(&pdev->dev.kobj, &hdaps_attribute_group);
573 hdaps_idev = input_allocate_polled_device();
579 hdaps_idev->poll = hdaps_mousedev_poll;
580 hdaps_idev->poll_interval = HDAPS_POLL_INTERVAL;
582 /* initial calibrate for the input device */
585 /* initialize the input class */
586 idev = hdaps_idev->input;
587 idev->name = "hdaps";
588 idev->phys = "isa1600/input0";
589 idev->id.bustype = BUS_ISA;
590 idev->dev.parent = &pdev->dev;
591 idev->evbit[0] = BIT_MASK(EV_ABS);
592 input_set_abs_params(idev, ABS_X,
593 -256, 256, HDAPS_INPUT_FUZZ, HDAPS_INPUT_FLAT);
594 input_set_abs_params(idev, ABS_Y,
595 -256, 256, HDAPS_INPUT_FUZZ, HDAPS_INPUT_FLAT);
597 ret = input_register_polled_device(hdaps_idev);
601 pr_info("driver successfully loaded\n");
605 input_free_polled_device(hdaps_idev);
607 sysfs_remove_group(&pdev->dev.kobj, &hdaps_attribute_group);
609 platform_device_unregister(pdev);
611 platform_driver_unregister(&hdaps_driver);
613 release_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS);
615 pr_warn("driver init failed (ret=%d)!\n", ret);
619 static void __exit hdaps_exit(void)
621 input_unregister_polled_device(hdaps_idev);
622 input_free_polled_device(hdaps_idev);
623 sysfs_remove_group(&pdev->dev.kobj, &hdaps_attribute_group);
624 platform_device_unregister(pdev);
625 platform_driver_unregister(&hdaps_driver);
626 release_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS);
628 pr_info("driver unloaded\n");
631 module_init(hdaps_init);
632 module_exit(hdaps_exit);
634 module_param_named(invert, hdaps_invert, int, 0);
635 MODULE_PARM_DESC(invert, "invert data along each axis. 1 invert x-axis, "
636 "2 invert y-axis, 3 invert both axes.");
638 MODULE_AUTHOR("Robert Love");
639 MODULE_DESCRIPTION("IBM Hard Drive Active Protection System (HDAPS) driver");
640 MODULE_LICENSE("GPL v2");