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 static struct platform_device *pdev;
 
  69 static struct input_polled_dev *hdaps_idev;
 
  70 static unsigned int hdaps_invert;
 
  71 static u8 km_activity;
 
  75 static DEFINE_MUTEX(hdaps_mtx);
 
  78  * __get_latch - Get the value from a given port.  Callers must hold hdaps_mtx.
 
  80 static inline u8 __get_latch(u16 port)
 
  82         return inb(port) & 0xff;
 
  86  * __check_latch - Check a port latch for a given value.  Returns zero if the
 
  87  * port contains the given value.  Callers must hold hdaps_mtx.
 
  89 static inline int __check_latch(u16 port, u8 val)
 
  91         if (__get_latch(port) == val)
 
  97  * __wait_latch - Wait up to 100us for a port latch to get a certain value,
 
  98  * returning zero if the value is obtained.  Callers must hold hdaps_mtx.
 
 100 static int __wait_latch(u16 port, u8 val)
 
 104         for (i = 0; i < 20; i++) {
 
 105                 if (!__check_latch(port, val))
 
 114  * __device_refresh - request a refresh from the accelerometer.  Does not wait
 
 115  * for refresh to complete.  Callers must hold hdaps_mtx.
 
 117 static void __device_refresh(void)
 
 120         if (inb(0x1604) != STATE_FRESH) {
 
 127  * __device_refresh_sync - request a synchronous refresh from the
 
 128  * accelerometer.  We wait for the refresh to complete.  Returns zero if
 
 129  * successful and nonzero on error.  Callers must hold hdaps_mtx.
 
 131 static int __device_refresh_sync(void)
 
 134         return __wait_latch(0x1604, STATE_FRESH);
 
 138  * __device_complete - indicate to the accelerometer that we are done reading
 
 139  * data, and then initiate an async refresh.  Callers must hold hdaps_mtx.
 
 141 static inline void __device_complete(void)
 
 149  * hdaps_readb_one - reads a byte from a single I/O port, placing the value in
 
 150  * the given pointer.  Returns zero on success or a negative error on failure.
 
 153 static int hdaps_readb_one(unsigned int port, u8 *val)
 
 157         mutex_lock(&hdaps_mtx);
 
 159         /* do a sync refresh -- we need to be sure that we read fresh data */
 
 160         ret = __device_refresh_sync();
 
 168         mutex_unlock(&hdaps_mtx);
 
 172 /* __hdaps_read_pair - internal lockless helper for hdaps_read_pair(). */
 
 173 static int __hdaps_read_pair(unsigned int port1, unsigned int port2,
 
 176         /* do a sync refresh -- we need to be sure that we read fresh data */
 
 177         if (__device_refresh_sync())
 
 182         km_activity = inb(HDAPS_PORT_KMACT);
 
 185         /* if hdaps_invert is set, negate the two values */
 
 195  * hdaps_read_pair - reads the values from a pair of ports, placing the values
 
 196  * in the given pointers.  Returns zero on success.  Can sleep.
 
 198 static int hdaps_read_pair(unsigned int port1, unsigned int port2,
 
 199                            int *val1, int *val2)
 
 203         mutex_lock(&hdaps_mtx);
 
 204         ret = __hdaps_read_pair(port1, port2, val1, val2);
 
 205         mutex_unlock(&hdaps_mtx);
 
 211  * hdaps_device_init - initialize the accelerometer.  Returns zero on success
 
 212  * and negative error code on failure.  Can sleep.
 
 214 static int hdaps_device_init(void)
 
 216         int total, ret = -ENXIO;
 
 218         mutex_lock(&hdaps_mtx);
 
 222         if (__wait_latch(0x161f, 0x00))
 
 226          * Most ThinkPads return 0x01.
 
 228          * Others--namely the R50p, T41p, and T42p--return 0x03.  These laptops
 
 229          * have "inverted" axises.
 
 231          * The 0x02 value occurs when the chip has been previously initialized.
 
 233         if (__check_latch(0x1611, 0x03) &&
 
 234                      __check_latch(0x1611, 0x02) &&
 
 235                      __check_latch(0x1611, 0x01))
 
 238         printk(KERN_DEBUG "hdaps: initial latch check good (0x%02x).\n",
 
 239                __get_latch(0x1611));
 
 244         if (__wait_latch(0x161f, 0x00))
 
 246         if (__wait_latch(0x1611, 0x00))
 
 248         if (__wait_latch(0x1612, 0x60))
 
 250         if (__wait_latch(0x1613, 0x00))
 
 255         if (__wait_latch(0x161f, 0x00))
 
 262         if (__wait_latch(0x161f, 0x00))
 
 264         if (__device_refresh_sync())
 
 266         if (__wait_latch(0x1611, 0x00))
 
 269         /* we have done our dance, now let's wait for the applause */
 
 270         for (total = INIT_TIMEOUT_MSECS; total > 0; total -= INIT_WAIT_MSECS) {
 
 273                 /* a read of the device helps push it into action */
 
 274                 __hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y);
 
 275                 if (!__wait_latch(0x1611, 0x02)) {
 
 280                 msleep(INIT_WAIT_MSECS);
 
 284         mutex_unlock(&hdaps_mtx);
 
 289 /* Device model stuff */
 
 291 static int hdaps_probe(struct platform_device *dev)
 
 295         ret = hdaps_device_init();
 
 299         printk(KERN_INFO "hdaps: device successfully initialized.\n");
 
 303 static int hdaps_resume(struct platform_device *dev)
 
 305         return hdaps_device_init();
 
 308 static struct platform_driver hdaps_driver = {
 
 309         .probe = hdaps_probe,
 
 310         .resume = hdaps_resume,
 
 313                 .owner = THIS_MODULE,
 
 318  * hdaps_calibrate - Set our "resting" values.  Callers must hold hdaps_mtx.
 
 320 static void hdaps_calibrate(void)
 
 322         __hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &rest_x, &rest_y);
 
 325 static void hdaps_mousedev_poll(struct input_polled_dev *dev)
 
 327         struct input_dev *input_dev = dev->input;
 
 330         mutex_lock(&hdaps_mtx);
 
 332         if (__hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y))
 
 335         input_report_abs(input_dev, ABS_X, x - rest_x);
 
 336         input_report_abs(input_dev, ABS_Y, y - rest_y);
 
 337         input_sync(input_dev);
 
 340         mutex_unlock(&hdaps_mtx);
 
 346 static ssize_t hdaps_position_show(struct device *dev,
 
 347                                    struct device_attribute *attr, char *buf)
 
 351         ret = hdaps_read_pair(HDAPS_PORT_XPOS, HDAPS_PORT_YPOS, &x, &y);
 
 355         return sprintf(buf, "(%d,%d)\n", x, y);
 
 358 static ssize_t hdaps_variance_show(struct device *dev,
 
 359                                    struct device_attribute *attr, char *buf)
 
 363         ret = hdaps_read_pair(HDAPS_PORT_XVAR, HDAPS_PORT_YVAR, &x, &y);
 
 367         return sprintf(buf, "(%d,%d)\n", x, y);
 
 370 static ssize_t hdaps_temp1_show(struct device *dev,
 
 371                                 struct device_attribute *attr, char *buf)
 
 376         ret = hdaps_readb_one(HDAPS_PORT_TEMP1, &temp);
 
 380         return sprintf(buf, "%u\n", temp);
 
 383 static ssize_t hdaps_temp2_show(struct device *dev,
 
 384                                 struct device_attribute *attr, char *buf)
 
 389         ret = hdaps_readb_one(HDAPS_PORT_TEMP2, &temp);
 
 393         return sprintf(buf, "%u\n", temp);
 
 396 static ssize_t hdaps_keyboard_activity_show(struct device *dev,
 
 397                                             struct device_attribute *attr,
 
 400         return sprintf(buf, "%u\n", KEYBD_ISSET(km_activity));
 
 403 static ssize_t hdaps_mouse_activity_show(struct device *dev,
 
 404                                          struct device_attribute *attr,
 
 407         return sprintf(buf, "%u\n", MOUSE_ISSET(km_activity));
 
 410 static ssize_t hdaps_calibrate_show(struct device *dev,
 
 411                                     struct device_attribute *attr, char *buf)
 
 413         return sprintf(buf, "(%d,%d)\n", rest_x, rest_y);
 
 416 static ssize_t hdaps_calibrate_store(struct device *dev,
 
 417                                      struct device_attribute *attr,
 
 418                                      const char *buf, size_t count)
 
 420         mutex_lock(&hdaps_mtx);
 
 422         mutex_unlock(&hdaps_mtx);
 
 427 static ssize_t hdaps_invert_show(struct device *dev,
 
 428                                  struct device_attribute *attr, char *buf)
 
 430         return sprintf(buf, "%u\n", hdaps_invert);
 
 433 static ssize_t hdaps_invert_store(struct device *dev,
 
 434                                   struct device_attribute *attr,
 
 435                                   const char *buf, size_t count)
 
 439         if (sscanf(buf, "%d", &invert) != 1 || (invert != 1 && invert != 0))
 
 442         hdaps_invert = invert;
 
 448 static DEVICE_ATTR(position, 0444, hdaps_position_show, NULL);
 
 449 static DEVICE_ATTR(variance, 0444, hdaps_variance_show, NULL);
 
 450 static DEVICE_ATTR(temp1, 0444, hdaps_temp1_show, NULL);
 
 451 static DEVICE_ATTR(temp2, 0444, hdaps_temp2_show, NULL);
 
 452 static DEVICE_ATTR(keyboard_activity, 0444, hdaps_keyboard_activity_show, NULL);
 
 453 static DEVICE_ATTR(mouse_activity, 0444, hdaps_mouse_activity_show, NULL);
 
 454 static DEVICE_ATTR(calibrate, 0644, hdaps_calibrate_show,hdaps_calibrate_store);
 
 455 static DEVICE_ATTR(invert, 0644, hdaps_invert_show, hdaps_invert_store);
 
 457 static struct attribute *hdaps_attributes[] = {
 
 458         &dev_attr_position.attr,
 
 459         &dev_attr_variance.attr,
 
 460         &dev_attr_temp1.attr,
 
 461         &dev_attr_temp2.attr,
 
 462         &dev_attr_keyboard_activity.attr,
 
 463         &dev_attr_mouse_activity.attr,
 
 464         &dev_attr_calibrate.attr,
 
 465         &dev_attr_invert.attr,
 
 469 static struct attribute_group hdaps_attribute_group = {
 
 470         .attrs = hdaps_attributes,
 
 476 /* hdaps_dmi_match - found a match.  return one, short-circuiting the hunt. */
 
 477 static int __init hdaps_dmi_match(const struct dmi_system_id *id)
 
 479         printk(KERN_INFO "hdaps: %s detected.\n", id->ident);
 
 483 /* hdaps_dmi_match_invert - found an inverted match. */
 
 484 static int __init hdaps_dmi_match_invert(const struct dmi_system_id *id)
 
 487         printk(KERN_INFO "hdaps: inverting axis readings.\n");
 
 488         return hdaps_dmi_match(id);
 
 491 #define HDAPS_DMI_MATCH_NORMAL(vendor, model) {         \
 
 492         .ident = vendor " " model,                      \
 
 493         .callback = hdaps_dmi_match,                    \
 
 495                 DMI_MATCH(DMI_BOARD_VENDOR, vendor),    \
 
 496                 DMI_MATCH(DMI_PRODUCT_VERSION, model)   \
 
 500 #define HDAPS_DMI_MATCH_INVERT(vendor, model) {         \
 
 501         .ident = vendor " " model,                      \
 
 502         .callback = hdaps_dmi_match_invert,             \
 
 504                 DMI_MATCH(DMI_BOARD_VENDOR, vendor),    \
 
 505                 DMI_MATCH(DMI_PRODUCT_VERSION, model)   \
 
 509 /* Note that HDAPS_DMI_MATCH_NORMAL("ThinkPad T42") would match
 
 510    "ThinkPad T42p", so the order of the entries matters.
 
 511    If your ThinkPad is not recognized, please update to latest
 
 512    BIOS. This is especially the case for some R52 ThinkPads. */
 
 513 static struct dmi_system_id __initdata hdaps_whitelist[] = {
 
 514         HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad R50p"),
 
 515         HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R50"),
 
 516         HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R51"),
 
 517         HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad R52"),
 
 518         HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad T41p"),
 
 519         HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T41"),
 
 520         HDAPS_DMI_MATCH_INVERT("IBM", "ThinkPad T42p"),
 
 521         HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T42"),
 
 522         HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad T43"),
 
 523         HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad T60"),
 
 524         HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad X40"),
 
 525         HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad X41"),
 
 526         HDAPS_DMI_MATCH_INVERT("LENOVO", "ThinkPad X60"),
 
 527         HDAPS_DMI_MATCH_NORMAL("IBM", "ThinkPad Z60m"),
 
 531 static int __init hdaps_init(void)
 
 533         struct input_dev *idev;
 
 536         if (!dmi_check_system(hdaps_whitelist)) {
 
 537                 printk(KERN_WARNING "hdaps: supported laptop not found!\n");
 
 542         if (!request_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS, "hdaps")) {
 
 547         ret = platform_driver_register(&hdaps_driver);
 
 551         pdev = platform_device_register_simple("hdaps", -1, NULL, 0);
 
 557         ret = sysfs_create_group(&pdev->dev.kobj, &hdaps_attribute_group);
 
 561         hdaps_idev = input_allocate_polled_device();
 
 567         hdaps_idev->poll = hdaps_mousedev_poll;
 
 568         hdaps_idev->poll_interval = HDAPS_POLL_INTERVAL;
 
 570         /* initial calibrate for the input device */
 
 573         /* initialize the input class */
 
 574         idev = hdaps_idev->input;
 
 575         idev->name = "hdaps";
 
 576         idev->dev.parent = &pdev->dev;
 
 577         idev->evbit[0] = BIT_MASK(EV_ABS);
 
 578         input_set_abs_params(idev, ABS_X,
 
 579                         -256, 256, HDAPS_INPUT_FUZZ, HDAPS_INPUT_FLAT);
 
 580         input_set_abs_params(idev, ABS_Y,
 
 581                         -256, 256, HDAPS_INPUT_FUZZ, HDAPS_INPUT_FLAT);
 
 583         ret = input_register_polled_device(hdaps_idev);
 
 587         printk(KERN_INFO "hdaps: driver successfully loaded.\n");
 
 591         input_free_polled_device(hdaps_idev);
 
 593         sysfs_remove_group(&pdev->dev.kobj, &hdaps_attribute_group);
 
 595         platform_device_unregister(pdev);
 
 597         platform_driver_unregister(&hdaps_driver);
 
 599         release_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS);
 
 601         printk(KERN_WARNING "hdaps: driver init failed (ret=%d)!\n", ret);
 
 605 static void __exit hdaps_exit(void)
 
 607         input_unregister_polled_device(hdaps_idev);
 
 608         input_free_polled_device(hdaps_idev);
 
 609         sysfs_remove_group(&pdev->dev.kobj, &hdaps_attribute_group);
 
 610         platform_device_unregister(pdev);
 
 611         platform_driver_unregister(&hdaps_driver);
 
 612         release_region(HDAPS_LOW_PORT, HDAPS_NR_PORTS);
 
 614         printk(KERN_INFO "hdaps: driver unloaded.\n");
 
 617 module_init(hdaps_init);
 
 618 module_exit(hdaps_exit);
 
 620 module_param_named(invert, hdaps_invert, bool, 0);
 
 621 MODULE_PARM_DESC(invert, "invert data along each axis");
 
 623 MODULE_AUTHOR("Robert Love");
 
 624 MODULE_DESCRIPTION("IBM Hard Drive Active Protection System (HDAPS) driver");
 
 625 MODULE_LICENSE("GPL v2");