2 * drivers/hwmon/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 <jesper.juhl@gmail.com>
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 #include <linux/delay.h>
30 #include <linux/platform_device.h>
31 #include <linux/input-polldev.h>
32 #include <linux/kernel.h>
33 #include <linux/mutex.h>
34 #include <linux/module.h>
35 #include <linux/timer.h>
36 #include <linux/dmi.h>
37 #include <linux/jiffies.h>
41 #define HDAPS_LOW_PORT 0x1600 /* first port used by hdaps */
42 #define HDAPS_NR_PORTS 0x30 /* number of ports: 0x1600 - 0x162f */
44 #define HDAPS_PORT_STATE 0x1611 /* device state */
45 #define HDAPS_PORT_YPOS 0x1612 /* y-axis position */
46 #define HDAPS_PORT_XPOS 0x1614 /* x-axis position */
47 #define HDAPS_PORT_TEMP1 0x1616 /* device temperature, in Celsius */
48 #define HDAPS_PORT_YVAR 0x1617 /* y-axis variance (what is this?) */
49 #define HDAPS_PORT_XVAR 0x1619 /* x-axis variance (what is this?) */
50 #define HDAPS_PORT_TEMP2 0x161b /* device temperature (again?) */
51 #define HDAPS_PORT_UNKNOWN 0x161c /* what is this? */
52 #define HDAPS_PORT_KMACT 0x161d /* keyboard or mouse activity */
54 #define STATE_FRESH 0x50 /* accelerometer data is fresh */
56 #define KEYBD_MASK 0x20 /* set if keyboard activity */
57 #define MOUSE_MASK 0x40 /* set if mouse activity */
58 #define KEYBD_ISSET(n) (!! (n & KEYBD_MASK)) /* keyboard used? */
59 #define MOUSE_ISSET(n) (!! (n & MOUSE_MASK)) /* mouse used? */
61 #define INIT_TIMEOUT_MSECS 4000 /* wait up to 4s for device init ... */
62 #define INIT_WAIT_MSECS 200 /* ... in 200ms increments */
64 #define HDAPS_POLL_INTERVAL 50 /* poll for input every 1/20s (50 ms)*/
65 #define HDAPS_INPUT_FUZZ 4 /* input event threshold */
66 #define HDAPS_INPUT_FLAT 4
68 #define HDAPS_X_AXIS (1 << 0)
69 #define HDAPS_Y_AXIS (1 << 1)
70 #define HDAPS_BOTH_AXES (HDAPS_X_AXIS | HDAPS_Y_AXIS)
72 static struct platform_device *pdev;
73 static struct input_polled_dev *hdaps_idev;
74 static unsigned int hdaps_invert;
75 static u8 km_activity;
79 static DEFINE_MUTEX(hdaps_mtx);
82 * __get_latch - Get the value from a given port. Callers must hold hdaps_mtx.
84 static inline u8 __get_latch(u16 port)
86 return inb(port) & 0xff;
90 * __check_latch - Check a port latch for a given value. Returns zero if the
91 * port contains the given value. Callers must hold hdaps_mtx.
93 static inline int __check_latch(u16 port, u8 val)
95 if (__get_latch(port) == val)
101 * __wait_latch - Wait up to 100us for a port latch to get a certain value,
102 * returning zero if the value is obtained. Callers must hold hdaps_mtx.
104 static int __wait_latch(u16 port, u8 val)
108 for (i = 0; i < 20; i++) {
109 if (!__check_latch(port, val))
118 * __device_refresh - request a refresh from the accelerometer. Does not wait
119 * for refresh to complete. Callers must hold hdaps_mtx.
121 static void __device_refresh(void)
124 if (inb(0x1604) != STATE_FRESH) {
131 * __device_refresh_sync - request a synchronous refresh from the
132 * accelerometer. We wait for the refresh to complete. Returns zero if
133 * successful and nonzero on error. Callers must hold hdaps_mtx.
135 static int __device_refresh_sync(void)
138 return __wait_latch(0x1604, STATE_FRESH);
142 * __device_complete - indicate to the accelerometer that we are done reading
143 * data, and then initiate an async refresh. Callers must hold hdaps_mtx.
145 static inline void __device_complete(void)
153 * hdaps_readb_one - reads a byte from a single I/O port, placing the value in
154 * the given pointer. Returns zero on success or a negative error on failure.
157 static int hdaps_readb_one(unsigned int port, u8 *val)
161 mutex_lock(&hdaps_mtx);
163 /* do a sync refresh -- we need to be sure that we read fresh data */
164 ret = __device_refresh_sync();
172 mutex_unlock(&hdaps_mtx);
176 /* __hdaps_read_pair - internal lockless helper for hdaps_read_pair(). */
177 static int __hdaps_read_pair(unsigned int port1, unsigned int port2,
180 /* do a sync refresh -- we need to be sure that we read fresh data */
181 if (__device_refresh_sync())
186 km_activity = inb(HDAPS_PORT_KMACT);
189 /* hdaps_invert is a bitvector to negate the axes */
190 if (hdaps_invert & HDAPS_X_AXIS)
192 if (hdaps_invert & HDAPS_Y_AXIS)
199 * hdaps_read_pair - reads the values from a pair of ports, placing the values
200 * in the given pointers. Returns zero on success. Can sleep.
202 static int hdaps_read_pair(unsigned int port1, unsigned int port2,
203 int *val1, int *val2)
207 mutex_lock(&hdaps_mtx);
208 ret = __hdaps_read_pair(port1, port2, val1, val2);
209 mutex_unlock(&hdaps_mtx);
215 * hdaps_device_init - initialize the accelerometer. Returns zero on success
216 * and negative error code on failure. Can sleep.
218 static int hdaps_device_init(void)
220 int total, ret = -ENXIO;
222 mutex_lock(&hdaps_mtx);
226 if (__wait_latch(0x161f, 0x00))
230 * Most ThinkPads return 0x01.
232 * Others--namely the R50p, T41p, and T42p--return 0x03. These laptops
233 * have "inverted" axises.
235 * The 0x02 value occurs when the chip has been previously initialized.
237 if (__check_latch(0x1611, 0x03) &&
238 __check_latch(0x1611, 0x02) &&
239 __check_latch(0x1611, 0x01))
242 printk(KERN_DEBUG "hdaps: initial latch check good (0x%02x).\n",
243 __get_latch(0x1611));
248 if (__wait_latch(0x161f, 0x00))
250 if (__wait_latch(0x1611, 0x00))
252 if (__wait_latch(0x1612, 0x60))
254 if (__wait_latch(0x1613, 0x00))
259 if (__wait_latch(0x161f, 0x00))
266 if (__wait_latch(0x161f, 0x00))
268 if (__device_refresh_sync())
270 if (__wait_latch(0x1611, 0x00))
273 /* we have done our dance, now let's wait for the applause */
274 for (total = INIT_TIMEOUT_MSECS; total > 0; total -= INIT_WAIT_MSECS) {
277 /* a read of the device helps push it into action */
278 __hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y);
279 if (!__wait_latch(0x1611, 0x02)) {
284 msleep(INIT_WAIT_MSECS);
288 mutex_unlock(&hdaps_mtx);
293 /* Device model stuff */
295 static int hdaps_probe(struct platform_device *dev)
299 ret = hdaps_device_init();
303 printk(KERN_INFO "hdaps: device successfully initialized.\n");
307 static int hdaps_resume(struct platform_device *dev)
309 return hdaps_device_init();
312 static struct platform_driver hdaps_driver = {
313 .probe = hdaps_probe,
314 .resume = hdaps_resume,
317 .owner = THIS_MODULE,
322 * hdaps_calibrate - Set our "resting" values. Callers must hold hdaps_mtx.
324 static void hdaps_calibrate(void)
326 __hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &rest_x, &rest_y);
329 static void hdaps_mousedev_poll(struct input_polled_dev *dev)
331 struct input_dev *input_dev = dev->input;
334 mutex_lock(&hdaps_mtx);
336 if (__hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y))
339 input_report_abs(input_dev, ABS_X, x - rest_x);
340 input_report_abs(input_dev, ABS_Y, y - rest_y);
341 input_sync(input_dev);
344 mutex_unlock(&hdaps_mtx);
350 static ssize_t hdaps_position_show(struct device *dev,
351 struct device_attribute *attr, char *buf)
355 ret = hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y);
359 return sprintf(buf, "(%d,%d)\n", x, y);
362 static ssize_t hdaps_variance_show(struct device *dev,
363 struct device_attribute *attr, char *buf)
367 ret = hdaps_read_pair(HDAPS_PORT_XVAR, HDAPS_PORT_YVAR, &x, &y);
371 return sprintf(buf, "(%d,%d)\n", x, y);
374 static ssize_t hdaps_temp1_show(struct device *dev,
375 struct device_attribute *attr, char *buf)
380 ret = hdaps_readb_one(HDAPS_PORT_TEMP1, &temp);
384 return sprintf(buf, "%u\n", temp);
387 static ssize_t hdaps_temp2_show(struct device *dev,
388 struct device_attribute *attr, char *buf)
393 ret = hdaps_readb_one(HDAPS_PORT_TEMP2, &temp);
397 return sprintf(buf, "%u\n", temp);
400 static ssize_t hdaps_keyboard_activity_show(struct device *dev,
401 struct device_attribute *attr,
404 return sprintf(buf, "%u\n", KEYBD_ISSET(km_activity));
407 static ssize_t hdaps_mouse_activity_show(struct device *dev,
408 struct device_attribute *attr,
411 return sprintf(buf, "%u\n", MOUSE_ISSET(km_activity));
414 static ssize_t hdaps_calibrate_show(struct device *dev,
415 struct device_attribute *attr, char *buf)
417 return sprintf(buf, "(%d,%d)\n", rest_x, rest_y);
420 static ssize_t hdaps_calibrate_store(struct device *dev,
421 struct device_attribute *attr,
422 const char *buf, size_t count)
424 mutex_lock(&hdaps_mtx);
426 mutex_unlock(&hdaps_mtx);
431 static ssize_t hdaps_invert_show(struct device *dev,
432 struct device_attribute *attr, char *buf)
434 return sprintf(buf, "%u\n", hdaps_invert);
437 static ssize_t hdaps_invert_store(struct device *dev,
438 struct device_attribute *attr,
439 const char *buf, size_t count)
443 if (sscanf(buf, "%d", &invert) != 1 ||
444 invert < 0 || invert > HDAPS_BOTH_AXES)
447 hdaps_invert = invert;
453 static DEVICE_ATTR(position, 0444, hdaps_position_show, NULL);
454 static DEVICE_ATTR(variance, 0444, hdaps_variance_show, NULL);
455 static DEVICE_ATTR(temp1, 0444, hdaps_temp1_show, NULL);
456 static DEVICE_ATTR(temp2, 0444, hdaps_temp2_show, NULL);
457 static DEVICE_ATTR(keyboard_activity, 0444, hdaps_keyboard_activity_show, NULL);
458 static DEVICE_ATTR(mouse_activity, 0444, hdaps_mouse_activity_show, NULL);
459 static DEVICE_ATTR(calibrate, 0644, hdaps_calibrate_show,hdaps_calibrate_store);
460 static DEVICE_ATTR(invert, 0644, hdaps_invert_show, hdaps_invert_store);
462 static struct attribute *hdaps_attributes[] = {
463 &dev_attr_position.attr,
464 &dev_attr_variance.attr,
465 &dev_attr_temp1.attr,
466 &dev_attr_temp2.attr,
467 &dev_attr_keyboard_activity.attr,
468 &dev_attr_mouse_activity.attr,
469 &dev_attr_calibrate.attr,
470 &dev_attr_invert.attr,
474 static struct attribute_group hdaps_attribute_group = {
475 .attrs = hdaps_attributes,
481 /* hdaps_dmi_match - found a match. return one, short-circuiting the hunt. */
482 static int __init hdaps_dmi_match(const struct dmi_system_id *id)
484 printk(KERN_INFO "hdaps: %s detected.\n", id->ident);
488 /* hdaps_dmi_match_invert - found an inverted match. */
489 static int __init hdaps_dmi_match_invert(const struct dmi_system_id *id)
491 hdaps_invert = (unsigned long)id->driver_data;
492 printk(KERN_INFO "hdaps: inverting axis (%u) readings.\n",
494 return hdaps_dmi_match(id);
497 #define HDAPS_DMI_MATCH_INVERT(vendor, model, axes) { \
498 .ident = vendor " " model, \
499 .callback = hdaps_dmi_match_invert, \
500 .driver_data = (void *)axes, \
502 DMI_MATCH(DMI_BOARD_VENDOR, vendor), \
503 DMI_MATCH(DMI_PRODUCT_VERSION, model) \
507 #define HDAPS_DMI_MATCH_NORMAL(vendor, model) \
508 HDAPS_DMI_MATCH_INVERT(vendor, model, 0)
510 /* Note that HDAPS_DMI_MATCH_NORMAL("ThinkPad T42") would match
511 "ThinkPad T42p", so the order of the entries matters.
512 If your ThinkPad is not recognized, please update to latest
513 BIOS. This is especially the case for some R52 ThinkPads. */
514 static struct dmi_system_id __initdata hdaps_whitelist[] = {
515 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad R50p", HDAPS_BOTH_AXES),
516 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R50"),
517 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R51"),
518 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R52"),
519 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad R61i", HDAPS_BOTH_AXES),
520 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad R61", HDAPS_BOTH_AXES),
521 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad T41p", HDAPS_BOTH_AXES),
522 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T41"),
523 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad T42p", HDAPS_BOTH_AXES),
524 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T42"),
525 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T43"),
526 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T60", HDAPS_BOTH_AXES),
527 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T61p", HDAPS_BOTH_AXES),
528 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T61", HDAPS_BOTH_AXES),
529 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad X40"),
530 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad X41", HDAPS_Y_AXIS),
531 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X60", HDAPS_BOTH_AXES),
532 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X61s", HDAPS_BOTH_AXES),
533 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X61", HDAPS_BOTH_AXES),
534 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad Z60m"),
535 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad Z61m", HDAPS_BOTH_AXES),
536 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad Z61p", HDAPS_BOTH_AXES),
540 static int __init hdaps_init(void)
542 struct input_dev *idev;
545 if (!dmi_check_system(hdaps_whitelist)) {
546 printk(KERN_WARNING "hdaps: supported laptop not found!\n");
551 if (!request_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS, "hdaps")) {
556 ret = platform_driver_register(&hdaps_driver);
560 pdev = platform_device_register_simple("hdaps", -1, NULL, 0);
566 ret = sysfs_create_group(&pdev->dev.kobj, &hdaps_attribute_group);
570 hdaps_idev = input_allocate_polled_device();
576 hdaps_idev->poll = hdaps_mousedev_poll;
577 hdaps_idev->poll_interval = HDAPS_POLL_INTERVAL;
579 /* initial calibrate for the input device */
582 /* initialize the input class */
583 idev = hdaps_idev->input;
584 idev->name = "hdaps";
585 idev->phys = "isa1600/input0";
586 idev->id.bustype = BUS_ISA;
587 idev->dev.parent = &pdev->dev;
588 idev->evbit[0] = BIT_MASK(EV_ABS);
589 input_set_abs_params(idev, ABS_X,
590 -256, 256, HDAPS_INPUT_FUZZ, HDAPS_INPUT_FLAT);
591 input_set_abs_params(idev, ABS_Y,
592 -256, 256, HDAPS_INPUT_FUZZ, HDAPS_INPUT_FLAT);
594 ret = input_register_polled_device(hdaps_idev);
598 printk(KERN_INFO "hdaps: driver successfully loaded.\n");
602 input_free_polled_device(hdaps_idev);
604 sysfs_remove_group(&pdev->dev.kobj, &hdaps_attribute_group);
606 platform_device_unregister(pdev);
608 platform_driver_unregister(&hdaps_driver);
610 release_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS);
612 printk(KERN_WARNING "hdaps: driver init failed (ret=%d)!\n", ret);
616 static void __exit hdaps_exit(void)
618 input_unregister_polled_device(hdaps_idev);
619 input_free_polled_device(hdaps_idev);
620 sysfs_remove_group(&pdev->dev.kobj, &hdaps_attribute_group);
621 platform_device_unregister(pdev);
622 platform_driver_unregister(&hdaps_driver);
623 release_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS);
625 printk(KERN_INFO "hdaps: driver unloaded.\n");
628 module_init(hdaps_init);
629 module_exit(hdaps_exit);
631 module_param_named(invert, hdaps_invert, int, 0);
632 MODULE_PARM_DESC(invert, "invert data along each axis. 1 invert x-axis, "
633 "2 invert y-axis, 3 invert both axes.");
635 MODULE_AUTHOR("Robert Love");
636 MODULE_DESCRIPTION("IBM Hard Drive Active Protection System (HDAPS) driver");
637 MODULE_LICENSE("GPL v2");