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 <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 #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 platform_device
*dev
)
310 return hdaps_device_init();
313 static struct platform_driver hdaps_driver
= {
314 .probe
= hdaps_probe
,
315 .resume
= hdaps_resume
,
318 .owner
= THIS_MODULE
,
323 * hdaps_calibrate - Set our "resting" values. Callers must hold hdaps_mtx.
325 static void hdaps_calibrate(void)
327 __hdaps_read_pair(HDAPS_PORT_XPOS
, HDAPS_PORT_YPOS
, &rest_x
, &rest_y
);
330 static void hdaps_mousedev_poll(struct input_polled_dev
*dev
)
332 struct input_dev
*input_dev
= dev
->input
;
335 mutex_lock(&hdaps_mtx
);
337 if (__hdaps_read_pair(HDAPS_PORT_XPOS
, HDAPS_PORT_YPOS
, &x
, &y
))
340 input_report_abs(input_dev
, ABS_X
, x
- rest_x
);
341 input_report_abs(input_dev
, ABS_Y
, y
- rest_y
);
342 input_sync(input_dev
);
345 mutex_unlock(&hdaps_mtx
);
351 static ssize_t
hdaps_position_show(struct device
*dev
,
352 struct device_attribute
*attr
, char *buf
)
356 ret
= hdaps_read_pair(HDAPS_PORT_XPOS
, HDAPS_PORT_YPOS
, &x
, &y
);
360 return sprintf(buf
, "(%d,%d)\n", x
, y
);
363 static ssize_t
hdaps_variance_show(struct device
*dev
,
364 struct device_attribute
*attr
, char *buf
)
368 ret
= hdaps_read_pair(HDAPS_PORT_XVAR
, HDAPS_PORT_YVAR
, &x
, &y
);
372 return sprintf(buf
, "(%d,%d)\n", x
, y
);
375 static ssize_t
hdaps_temp1_show(struct device
*dev
,
376 struct device_attribute
*attr
, char *buf
)
381 ret
= hdaps_readb_one(HDAPS_PORT_TEMP1
, &temp
);
385 return sprintf(buf
, "%u\n", temp
);
388 static ssize_t
hdaps_temp2_show(struct device
*dev
,
389 struct device_attribute
*attr
, char *buf
)
394 ret
= hdaps_readb_one(HDAPS_PORT_TEMP2
, &temp
);
398 return sprintf(buf
, "%u\n", temp
);
401 static ssize_t
hdaps_keyboard_activity_show(struct device
*dev
,
402 struct device_attribute
*attr
,
405 return sprintf(buf
, "%u\n", KEYBD_ISSET(km_activity
));
408 static ssize_t
hdaps_mouse_activity_show(struct device
*dev
,
409 struct device_attribute
*attr
,
412 return sprintf(buf
, "%u\n", MOUSE_ISSET(km_activity
));
415 static ssize_t
hdaps_calibrate_show(struct device
*dev
,
416 struct device_attribute
*attr
, char *buf
)
418 return sprintf(buf
, "(%d,%d)\n", rest_x
, rest_y
);
421 static ssize_t
hdaps_calibrate_store(struct device
*dev
,
422 struct device_attribute
*attr
,
423 const char *buf
, size_t count
)
425 mutex_lock(&hdaps_mtx
);
427 mutex_unlock(&hdaps_mtx
);
432 static ssize_t
hdaps_invert_show(struct device
*dev
,
433 struct device_attribute
*attr
, char *buf
)
435 return sprintf(buf
, "%u\n", hdaps_invert
);
438 static ssize_t
hdaps_invert_store(struct device
*dev
,
439 struct device_attribute
*attr
,
440 const char *buf
, size_t count
)
444 if (sscanf(buf
, "%d", &invert
) != 1 ||
445 invert
< 0 || invert
> HDAPS_BOTH_AXES
)
448 hdaps_invert
= invert
;
454 static DEVICE_ATTR(position
, 0444, hdaps_position_show
, NULL
);
455 static DEVICE_ATTR(variance
, 0444, hdaps_variance_show
, NULL
);
456 static DEVICE_ATTR(temp1
, 0444, hdaps_temp1_show
, NULL
);
457 static DEVICE_ATTR(temp2
, 0444, hdaps_temp2_show
, NULL
);
458 static DEVICE_ATTR(keyboard_activity
, 0444, hdaps_keyboard_activity_show
, NULL
);
459 static DEVICE_ATTR(mouse_activity
, 0444, hdaps_mouse_activity_show
, NULL
);
460 static DEVICE_ATTR(calibrate
, 0644, hdaps_calibrate_show
,hdaps_calibrate_store
);
461 static DEVICE_ATTR(invert
, 0644, hdaps_invert_show
, hdaps_invert_store
);
463 static struct attribute
*hdaps_attributes
[] = {
464 &dev_attr_position
.attr
,
465 &dev_attr_variance
.attr
,
466 &dev_attr_temp1
.attr
,
467 &dev_attr_temp2
.attr
,
468 &dev_attr_keyboard_activity
.attr
,
469 &dev_attr_mouse_activity
.attr
,
470 &dev_attr_calibrate
.attr
,
471 &dev_attr_invert
.attr
,
475 static struct attribute_group hdaps_attribute_group
= {
476 .attrs
= hdaps_attributes
,
482 /* hdaps_dmi_match - found a match. return one, short-circuiting the hunt. */
483 static int __init
hdaps_dmi_match(const struct dmi_system_id
*id
)
485 pr_info("%s detected\n", id
->ident
);
489 /* hdaps_dmi_match_invert - found an inverted match. */
490 static int __init
hdaps_dmi_match_invert(const struct dmi_system_id
*id
)
492 hdaps_invert
= (unsigned long)id
->driver_data
;
493 pr_info("inverting axis (%u) readings\n", hdaps_invert
);
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 T400", HDAPS_BOTH_AXES
),
527 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T60", HDAPS_BOTH_AXES
),
528 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T61p", HDAPS_BOTH_AXES
),
529 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T61", HDAPS_BOTH_AXES
),
530 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad X40"),
531 HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad X41", HDAPS_Y_AXIS
),
532 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X60", HDAPS_BOTH_AXES
),
533 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X61s", HDAPS_BOTH_AXES
),
534 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X61", HDAPS_BOTH_AXES
),
535 HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad Z60m"),
536 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad Z61m", HDAPS_BOTH_AXES
),
537 HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad Z61p", HDAPS_BOTH_AXES
),
541 static int __init
hdaps_init(void)
543 struct input_dev
*idev
;
546 if (!dmi_check_system(hdaps_whitelist
)) {
547 pr_warn("supported laptop not found!\n");
552 if (!request_region(HDAPS_LOW_PORT
, HDAPS_NR_PORTS
, "hdaps")) {
557 ret
= platform_driver_register(&hdaps_driver
);
561 pdev
= platform_device_register_simple("hdaps", -1, NULL
, 0);
567 ret
= sysfs_create_group(&pdev
->dev
.kobj
, &hdaps_attribute_group
);
571 hdaps_idev
= input_allocate_polled_device();
577 hdaps_idev
->poll
= hdaps_mousedev_poll
;
578 hdaps_idev
->poll_interval
= HDAPS_POLL_INTERVAL
;
580 /* initial calibrate for the input device */
583 /* initialize the input class */
584 idev
= hdaps_idev
->input
;
585 idev
->name
= "hdaps";
586 idev
->phys
= "isa1600/input0";
587 idev
->id
.bustype
= BUS_ISA
;
588 idev
->dev
.parent
= &pdev
->dev
;
589 idev
->evbit
[0] = BIT_MASK(EV_ABS
);
590 input_set_abs_params(idev
, ABS_X
,
591 -256, 256, HDAPS_INPUT_FUZZ
, HDAPS_INPUT_FLAT
);
592 input_set_abs_params(idev
, ABS_Y
,
593 -256, 256, HDAPS_INPUT_FUZZ
, HDAPS_INPUT_FLAT
);
595 ret
= input_register_polled_device(hdaps_idev
);
599 pr_info("driver successfully loaded\n");
603 input_free_polled_device(hdaps_idev
);
605 sysfs_remove_group(&pdev
->dev
.kobj
, &hdaps_attribute_group
);
607 platform_device_unregister(pdev
);
609 platform_driver_unregister(&hdaps_driver
);
611 release_region(HDAPS_LOW_PORT
, HDAPS_NR_PORTS
);
613 pr_warn("driver init failed (ret=%d)!\n", ret
);
617 static void __exit
hdaps_exit(void)
619 input_unregister_polled_device(hdaps_idev
);
620 input_free_polled_device(hdaps_idev
);
621 sysfs_remove_group(&pdev
->dev
.kobj
, &hdaps_attribute_group
);
622 platform_device_unregister(pdev
);
623 platform_driver_unregister(&hdaps_driver
);
624 release_region(HDAPS_LOW_PORT
, HDAPS_NR_PORTS
);
626 pr_info("driver unloaded\n");
629 module_init(hdaps_init
);
630 module_exit(hdaps_exit
);
632 module_param_named(invert
, hdaps_invert
, int, 0);
633 MODULE_PARM_DESC(invert
, "invert data along each axis. 1 invert x-axis, "
634 "2 invert y-axis, 3 invert both axes.");
636 MODULE_AUTHOR("Robert Love");
637 MODULE_DESCRIPTION("IBM Hard Drive Active Protection System (HDAPS) driver");
638 MODULE_LICENSE("GPL v2");