drivers/hwmon/applesmc.c

   1 /*
   2  * drivers/hwmon/applesmc.c - driver for Apple's SMC (accelerometer, temperature
   3  * sensors, fan control, keyboard backlight control) used in Intel-based Apple
   4  * computers.
   5  *
   6  * Copyright (C) 2007 Nicolas Boichat <nicolas@boichat.ch>
   7  * Copyright (C) 2010 Henrik Rydberg <rydberg@euromail.se>
   8  *
   9  * Based on hdaps.c driver:
  10  * Copyright (C) 2005 Robert Love <rml@novell.com>
  11  * Copyright (C) 2005 Jesper Juhl <jesper.juhl@gmail.com>
  12  *
  13  * Fan control based on smcFanControl:
  14  * Copyright (C) 2006 Hendrik Holtmann <holtmann@mac.com>
  15  *
  16  * This program is free software; you can redistribute it and/or modify it
  17  * under the terms of the GNU General Public License v2 as published by the
  18  * Free Software Foundation.
  19  *
  20  * This program is distributed in the hope that it will be useful, but WITHOUT
  21  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  22  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  23  * more details.
  24  *
  25  * You should have received a copy of the GNU General Public License along with
  26  * this program; if not, write to the Free Software Foundation, Inc.,
  27  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  28  */
  29
  30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  31
  32 #include <linux/delay.h>
  33 #include <linux/platform_device.h>
  34 #include <linux/input-polldev.h>
  35 #include <linux/kernel.h>
  36 #include <linux/slab.h>
  37 #include <linux/module.h>
  38 #include <linux/timer.h>
  39 #include <linux/dmi.h>
  40 #include <linux/mutex.h>
  41 #include <linux/hwmon-sysfs.h>
  42 #include <linux/io.h>
  43 #include <linux/leds.h>
  44 #include <linux/hwmon.h>
  45 #include <linux/workqueue.h>
  46
  47 /* data port used by Apple SMC */
  48 #define APPLESMC_DATA_PORT      0x300
  49 /* command/status port used by Apple SMC */
  50 #define APPLESMC_CMD_PORT       0x304
  51
  52 #define APPLESMC_NR_PORTS       32 /* 0x300-0x31f */
  53
  54 #define APPLESMC_MAX_DATA_LENGTH 32
  55
  56 /* wait up to 32 ms for a status change. */
  57 #define APPLESMC_MIN_WAIT       0x0040
  58 #define APPLESMC_MAX_WAIT       0x8000
  59
  60 #define APPLESMC_STATUS_MASK    0x0f
  61 #define APPLESMC_READ_CMD       0x10
  62 #define APPLESMC_WRITE_CMD      0x11
  63 #define APPLESMC_GET_KEY_BY_INDEX_CMD   0x12
  64 #define APPLESMC_GET_KEY_TYPE_CMD       0x13
  65
  66 #define KEY_COUNT_KEY           "#KEY" /* r-o ui32 */
  67
  68 #define LIGHT_SENSOR_LEFT_KEY   "ALV0" /* r-o {alv (6-10 bytes) */
  69 #define LIGHT_SENSOR_RIGHT_KEY  "ALV1" /* r-o {alv (6-10 bytes) */
  70 #define BACKLIGHT_KEY           "LKSB" /* w-o {lkb (2 bytes) */
  71
  72 #define CLAMSHELL_KEY           "MSLD" /* r-o ui8 (unused) */
  73
  74 #define MOTION_SENSOR_X_KEY     "MO_X" /* r-o sp78 (2 bytes) */
  75 #define MOTION_SENSOR_Y_KEY     "MO_Y" /* r-o sp78 (2 bytes) */
  76 #define MOTION_SENSOR_Z_KEY     "MO_Z" /* r-o sp78 (2 bytes) */
  77 #define MOTION_SENSOR_KEY       "MOCN" /* r/w ui16 */
  78
  79 #define FANS_COUNT              "FNum" /* r-o ui8 */
  80 #define FANS_MANUAL             "FS! " /* r-w ui16 */
  81 #define FAN_ID_FMT              "F%dID" /* r-o char[16] */
  82
  83 /* List of keys used to read/write fan speeds */
  84 static const char *const fan_speed_fmt[] = {
  85         "F%dAc",                /* actual speed */
  86         "F%dMn",                /* minimum speed (rw) */
  87         "F%dMx",                /* maximum speed */
  88         "F%dSf",                /* safe speed - not all models */
  89         "F%dTg",                /* target speed (manual: rw) */
  90 };
  91
  92 #define INIT_TIMEOUT_MSECS      5000    /* wait up to 5s for device init ... */
  93 #define INIT_WAIT_MSECS         50      /* ... in 50ms increments */
  94
  95 #define APPLESMC_POLL_INTERVAL  50      /* msecs */
  96 #define APPLESMC_INPUT_FUZZ     4       /* input event threshold */
  97 #define APPLESMC_INPUT_FLAT     4
  98
  99 #define SENSOR_X 0
 100 #define SENSOR_Y 1
 101 #define SENSOR_Z 2
 102
 103 #define to_index(attr) (to_sensor_dev_attr(attr)->index & 0xffff)
 104 #define to_option(attr) (to_sensor_dev_attr(attr)->index >> 16)
 105
 106 /* Dynamic device node attributes */
 107 struct applesmc_dev_attr {
 108         struct sensor_device_attribute sda;     /* hwmon attributes */
 109         char name[32];                          /* room for node file name */
 110 };
 111
 112 /* Dynamic device node group */
 113 struct applesmc_node_group {
 114         char *format;                           /* format string */
 115         void *show;                             /* show function */
 116         void *store;                            /* store function */
 117         int option;                             /* function argument */
 118         struct applesmc_dev_attr *nodes;        /* dynamic node array */
 119 };
 120
 121 /* AppleSMC entry - cached register information */
 122 struct applesmc_entry {
 123         char key[5];            /* four-letter key code */
 124         u8 valid;               /* set when entry is successfully read once */
 125         u8 len;                 /* bounded by APPLESMC_MAX_DATA_LENGTH */
 126         char type[5];           /* four-letter type code */
 127         u8 flags;               /* 0x10: func; 0x40: write; 0x80: read */
 128 };
 129
 130 /* Register lookup and registers common to all SMCs */
 131 static struct applesmc_registers {
 132         struct mutex mutex;             /* register read/write mutex */
 133         unsigned int key_count;         /* number of SMC registers */
 134         unsigned int fan_count;         /* number of fans */
 135         unsigned int temp_count;        /* number of temperature registers */
 136         unsigned int temp_begin;        /* temperature lower index bound */
 137         unsigned int temp_end;          /* temperature upper index bound */
 138         int num_light_sensors;          /* number of light sensors */
 139         bool has_accelerometer;         /* has motion sensor */
 140         bool has_key_backlight;         /* has keyboard backlight */
 141         bool init_complete;             /* true when fully initialized */
 142         struct applesmc_entry *cache;   /* cached key entries */
 143 } smcreg = {
 144         .mutex = __MUTEX_INITIALIZER(smcreg.mutex),
 145 };
 146
 147 static const int debug;
 148 static struct platform_device *pdev;
 149 static s16 rest_x;
 150 static s16 rest_y;
 151 static u8 backlight_state[2];
 152
 153 static struct device *hwmon_dev;
 154 static struct input_polled_dev *applesmc_idev;
 155
 156 /*
 157  * Last index written to key_at_index sysfs file, and value to use for all other
 158  * key_at_index_* sysfs files.
 159  */
 160 static unsigned int key_at_index;
 161
 162 static struct workqueue_struct *applesmc_led_wq;
 163
 164 /*
 165  * __wait_status - Wait up to 32ms for the status port to get a certain value
 166  * (masked with 0x0f), returning zero if the value is obtained.  Callers must
 167  * hold applesmc_lock.
 168  */
 169 static int __wait_status(u8 val)
 170 {
 171         int us;
 172
 173         val = val & APPLESMC_STATUS_MASK;
 174
 175         for (us = APPLESMC_MIN_WAIT; us < APPLESMC_MAX_WAIT; us <<= 1) {
 176                 udelay(us);
 177                 if ((inb(APPLESMC_CMD_PORT) & APPLESMC_STATUS_MASK) == val)
 178                         return 0;
 179         }
 180
 181         return -EIO;
 182 }
 183
 184 /*
 185  * special treatment of command port - on newer macbooks, it seems necessary
 186  * to resend the command byte before polling the status again. Callers must
 187  * hold applesmc_lock.
 188  */
 189 static int send_command(u8 cmd)
 190 {
 191         int us;
 192         for (us = APPLESMC_MIN_WAIT; us < APPLESMC_MAX_WAIT; us <<= 1) {
 193                 outb(cmd, APPLESMC_CMD_PORT);
 194                 udelay(us);
 195                 if ((inb(APPLESMC_CMD_PORT) & APPLESMC_STATUS_MASK) == 0x0c)
 196                         return 0;
 197         }
 198         return -EIO;
 199 }
 200
 201 static int send_argument(const char *key)
 202 {
 203         int i;
 204
 205         for (i = 0; i < 4; i++) {
 206                 outb(key[i], APPLESMC_DATA_PORT);
 207                 if (__wait_status(0x04))
 208                         return -EIO;
 209         }
 210         return 0;
 211 }
 212
 213 static int read_smc(u8 cmd, const char *key, u8 *buffer, u8 len)
 214 {
 215         int i;
 216
 217         if (send_command(cmd) || send_argument(key)) {
 218                 pr_warn("%.4s: read arg fail\n", key);
 219                 return -EIO;
 220         }
 221
 222         outb(len, APPLESMC_DATA_PORT);
 223
 224         for (i = 0; i < len; i++) {
 225                 if (__wait_status(0x05)) {
 226                         pr_warn("%.4s: read data fail\n", key);
 227                         return -EIO;
 228                 }
 229                 buffer[i] = inb(APPLESMC_DATA_PORT);
 230         }
 231
 232         return 0;
 233 }
 234
 235 static int write_smc(u8 cmd, const char *key, const u8 *buffer, u8 len)
 236 {
 237         int i;
 238
 239         if (send_command(cmd) || send_argument(key)) {
 240                 pr_warn("%s: write arg fail\n", key);
 241                 return -EIO;
 242         }
 243
 244         outb(len, APPLESMC_DATA_PORT);
 245
 246         for (i = 0; i < len; i++) {
 247                 if (__wait_status(0x04)) {
 248                         pr_warn("%s: write data fail\n", key);
 249                         return -EIO;
 250                 }
 251                 outb(buffer[i], APPLESMC_DATA_PORT);
 252         }
 253
 254         return 0;
 255 }
 256
 257 static int read_register_count(unsigned int *count)
 258 {
 259         __be32 be;
 260         int ret;
 261
 262         ret = read_smc(APPLESMC_READ_CMD, KEY_COUNT_KEY, (u8 *)&be, 4);
 263         if (ret)
 264                 return ret;
 265
 266         *count = be32_to_cpu(be);
 267         return 0;
 268 }
 269
 270 /*
 271  * Serialized I/O
 272  *
 273  * Returns zero on success or a negative error on failure.
 274  * All functions below are concurrency safe - callers should NOT hold lock.
 275  */
 276
 277 static int applesmc_read_entry(const struct applesmc_entry *entry,
 278                                u8 *buf, u8 len)
 279 {
 280         int ret;
 281
 282         if (entry->len != len)
 283                 return -EINVAL;
 284         mutex_lock(&smcreg.mutex);
 285         ret = read_smc(APPLESMC_READ_CMD, entry->key, buf, len);
 286         mutex_unlock(&smcreg.mutex);
 287
 288         return ret;
 289 }
 290
 291 static int applesmc_write_entry(const struct applesmc_entry *entry,
 292                                 const u8 *buf, u8 len)
 293 {
 294         int ret;
 295
 296         if (entry->len != len)
 297                 return -EINVAL;
 298         mutex_lock(&smcreg.mutex);
 299         ret = write_smc(APPLESMC_WRITE_CMD, entry->key, buf, len);
 300         mutex_unlock(&smcreg.mutex);
 301         return ret;
 302 }
 303
 304 static const struct applesmc_entry *applesmc_get_entry_by_index(int index)
 305 {
 306         struct applesmc_entry *cache = &smcreg.cache[index];
 307         u8 key[4], info[6];
 308         __be32 be;
 309         int ret = 0;
 310
 311         if (cache->valid)
 312                 return cache;
 313
 314         mutex_lock(&smcreg.mutex);
 315
 316         if (cache->valid)
 317                 goto out;
 318         be = cpu_to_be32(index);
 319         ret = read_smc(APPLESMC_GET_KEY_BY_INDEX_CMD, (u8 *)&be, key, 4);
 320         if (ret)
 321                 goto out;
 322         ret = read_smc(APPLESMC_GET_KEY_TYPE_CMD, key, info, 6);
 323         if (ret)
 324                 goto out;
 325
 326         memcpy(cache->key, key, 4);
 327         cache->len = info[0];
 328         memcpy(cache->type, &info[1], 4);
 329         cache->flags = info[5];
 330         cache->valid = 1;
 331
 332 out:
 333         mutex_unlock(&smcreg.mutex);
 334         if (ret)
 335                 return ERR_PTR(ret);
 336         return cache;
 337 }
 338
 339 static int applesmc_get_lower_bound(unsigned int *lo, const char *key)
 340 {
 341         int begin = 0, end = smcreg.key_count;
 342         const struct applesmc_entry *entry;
 343
 344         while (begin != end) {
 345                 int middle = begin + (end - begin) / 2;
 346                 entry = applesmc_get_entry_by_index(middle);
 347                 if (IS_ERR(entry))
 348                         return PTR_ERR(entry);
 349                 if (strcmp(entry->key, key) < 0)
 350                         begin = middle + 1;
 351                 else
 352                         end = middle;
 353         }
 354
 355         *lo = begin;
 356         return 0;
 357 }
 358
 359 static int applesmc_get_upper_bound(unsigned int *hi, const char *key)
 360 {
 361         int begin = 0, end = smcreg.key_count;
 362         const struct applesmc_entry *entry;
 363
 364         while (begin != end) {
 365                 int middle = begin + (end - begin) / 2;
 366                 entry = applesmc_get_entry_by_index(middle);
 367                 if (IS_ERR(entry))
 368                         return PTR_ERR(entry);
 369                 if (strcmp(key, entry->key) < 0)
 370                         end = middle;
 371                 else
 372                         begin = middle + 1;
 373         }
 374
 375         *hi = begin;
 376         return 0;
 377 }
 378
 379 static const struct applesmc_entry *applesmc_get_entry_by_key(const char *key)
 380 {
 381         int begin, end;
 382         int ret;
 383
 384         ret = applesmc_get_lower_bound(&begin, key);
 385         if (ret)
 386                 return ERR_PTR(ret);
 387         ret = applesmc_get_upper_bound(&end, key);
 388         if (ret)
 389                 return ERR_PTR(ret);
 390         if (end - begin != 1)
 391                 return ERR_PTR(-EINVAL);
 392
 393         return applesmc_get_entry_by_index(begin);
 394 }
 395
 396 static int applesmc_read_key(const char *key, u8 *buffer, u8 len)
 397 {
 398         const struct applesmc_entry *entry;
 399
 400         entry = applesmc_get_entry_by_key(key);
 401         if (IS_ERR(entry))
 402                 return PTR_ERR(entry);
 403
 404         return applesmc_read_entry(entry, buffer, len);
 405 }
 406
 407 static int applesmc_write_key(const char *key, const u8 *buffer, u8 len)
 408 {
 409         const struct applesmc_entry *entry;
 410
 411         entry = applesmc_get_entry_by_key(key);
 412         if (IS_ERR(entry))
 413                 return PTR_ERR(entry);
 414
 415         return applesmc_write_entry(entry, buffer, len);
 416 }
 417
 418 static int applesmc_has_key(const char *key, bool *value)
 419 {
 420         const struct applesmc_entry *entry;
 421
 422         entry = applesmc_get_entry_by_key(key);
 423         if (IS_ERR(entry) && PTR_ERR(entry) != -EINVAL)
 424                 return PTR_ERR(entry);
 425
 426         *value = !IS_ERR(entry);
 427         return 0;
 428 }
 429
 430 /*
 431  * applesmc_read_motion_sensor - Read motion sensor (X, Y or Z).
 432  */
 433 static int applesmc_read_motion_sensor(int index, s16 *value)
 434 {
 435         u8 buffer[2];
 436         int ret;
 437
 438         switch (index) {
 439         case SENSOR_X:
 440                 ret = applesmc_read_key(MOTION_SENSOR_X_KEY, buffer, 2);
 441                 break;
 442         case SENSOR_Y:
 443                 ret = applesmc_read_key(MOTION_SENSOR_Y_KEY, buffer, 2);
 444                 break;
 445         case SENSOR_Z:
 446                 ret = applesmc_read_key(MOTION_SENSOR_Z_KEY, buffer, 2);
 447                 break;
 448         default:
 449                 ret = -EINVAL;
 450         }
 451
 452         *value = ((s16)buffer[0] << 8) | buffer[1];
 453
 454         return ret;
 455 }
 456
 457 /*
 458  * applesmc_device_init - initialize the accelerometer.  Can sleep.
 459  */
 460 static void applesmc_device_init(void)
 461 {
 462         int total;
 463         u8 buffer[2];
 464
 465         if (!smcreg.has_accelerometer)
 466                 return;
 467
 468         for (total = INIT_TIMEOUT_MSECS; total > 0; total -= INIT_WAIT_MSECS) {
 469                 if (!applesmc_read_key(MOTION_SENSOR_KEY, buffer, 2) &&
 470                                 (buffer[0] != 0x00 || buffer[1] != 0x00))
 471                         return;
 472                 buffer[0] = 0xe0;
 473                 buffer[1] = 0x00;
 474                 applesmc_write_key(MOTION_SENSOR_KEY, buffer, 2);
 475                 msleep(INIT_WAIT_MSECS);
 476         }
 477
 478         pr_warn("failed to init the device\n");
 479 }
 480
 481 /*
 482  * applesmc_init_smcreg_try - Try to initialize register cache. Idempotent.
 483  */
 484 static int applesmc_init_smcreg_try(void)
 485 {
 486         struct applesmc_registers *s = &smcreg;
 487         bool left_light_sensor, right_light_sensor;
 488         unsigned int count;
 489         u8 tmp[1];
 490         int ret;
 491
 492         if (s->init_complete)
 493                 return 0;
 494
 495         ret = read_register_count(&count);
 496         if (ret)
 497                 return ret;
 498
 499         if (s->cache && s->key_count != count) {
 500                 pr_warn("key count changed from %d to %d\n",
 501                         s->key_count, count);
 502                 kfree(s->cache);
 503                 s->cache = NULL;
 504         }
 505         s->key_count = count;
 506
 507         if (!s->cache)
 508                 s->cache = kcalloc(s->key_count, sizeof(*s->cache), GFP_KERNEL);
 509         if (!s->cache)
 510                 return -ENOMEM;
 511
 512         ret = applesmc_read_key(FANS_COUNT, tmp, 1);
 513         if (ret)
 514                 return ret;
 515         s->fan_count = tmp[0];
 516
 517         ret = applesmc_get_lower_bound(&s->temp_begin, "T");
 518         if (ret)
 519                 return ret;
 520         ret = applesmc_get_lower_bound(&s->temp_end, "U");
 521         if (ret)
 522                 return ret;
 523         s->temp_count = s->temp_end - s->temp_begin;
 524
 525         ret = applesmc_has_key(LIGHT_SENSOR_LEFT_KEY, &left_light_sensor);
 526         if (ret)
 527                 return ret;
 528         ret = applesmc_has_key(LIGHT_SENSOR_RIGHT_KEY, &right_light_sensor);
 529         if (ret)
 530                 return ret;
 531         ret = applesmc_has_key(MOTION_SENSOR_KEY, &s->has_accelerometer);
 532         if (ret)
 533                 return ret;
 534         ret = applesmc_has_key(BACKLIGHT_KEY, &s->has_key_backlight);
 535         if (ret)
 536                 return ret;
 537
 538         s->num_light_sensors = left_light_sensor + right_light_sensor;
 539         s->init_complete = true;
 540
 541         pr_info("key=%d fan=%d temp=%d acc=%d lux=%d kbd=%d\n",
 542                s->key_count, s->fan_count, s->temp_count,
 543                s->has_accelerometer,
 544                s->num_light_sensors,
 545                s->has_key_backlight);
 546
 547         return 0;
 548 }
 549
 550 /*
 551  * applesmc_init_smcreg - Initialize register cache.
 552  *
 553  * Retries until initialization is successful, or the operation times out.
 554  *
 555  */
 556 static int applesmc_init_smcreg(void)
 557 {
 558         int ms, ret;
 559
 560         for (ms = 0; ms < INIT_TIMEOUT_MSECS; ms += INIT_WAIT_MSECS) {
 561                 ret = applesmc_init_smcreg_try();
 562                 if (!ret) {
 563                         if (ms)
 564                                 pr_info("init_smcreg() took %d ms\n", ms);
 565                         return 0;
 566                 }
 567                 msleep(INIT_WAIT_MSECS);
 568         }
 569
 570         kfree(smcreg.cache);
 571         smcreg.cache = NULL;
 572
 573         return ret;
 574 }
 575
 576 static void applesmc_destroy_smcreg(void)
 577 {
 578         kfree(smcreg.cache);
 579         smcreg.cache = NULL;
 580         smcreg.init_complete = false;
 581 }
 582
 583 /* Device model stuff */
 584 static int applesmc_probe(struct platform_device *dev)
 585 {
 586         int ret;
 587
 588         ret = applesmc_init_smcreg();
 589         if (ret)
 590                 return ret;
 591
 592         applesmc_device_init();
 593
 594         return 0;
 595 }
 596
 597 /* Synchronize device with memorized backlight state */
 598 static int applesmc_pm_resume(struct device *dev)
 599 {
 600         if (smcreg.has_key_backlight)
 601                 applesmc_write_key(BACKLIGHT_KEY, backlight_state, 2);
 602         return 0;
 603 }
 604
 605 /* Reinitialize device on resume from hibernation */
 606 static int applesmc_pm_restore(struct device *dev)
 607 {
 608         applesmc_device_init();
 609         return applesmc_pm_resume(dev);
 610 }
 611
 612 static const struct dev_pm_ops applesmc_pm_ops = {
 613         .resume = applesmc_pm_resume,
 614         .restore = applesmc_pm_restore,
 615 };
 616
 617 static struct platform_driver applesmc_driver = {
 618         .probe = applesmc_probe,
 619         .driver = {
 620                 .name = "applesmc",
 621                 .owner = THIS_MODULE,
 622                 .pm = &applesmc_pm_ops,
 623         },
 624 };
 625
 626 /*
 627  * applesmc_calibrate - Set our "resting" values.  Callers must
 628  * hold applesmc_lock.
 629  */
 630 static void applesmc_calibrate(void)
 631 {
 632         applesmc_read_motion_sensor(SENSOR_X, &rest_x);
 633         applesmc_read_motion_sensor(SENSOR_Y, &rest_y);
 634         rest_x = -rest_x;
 635 }
 636
 637 static void applesmc_idev_poll(struct input_polled_dev *dev)
 638 {
 639         struct input_dev *idev = dev->input;
 640         s16 x, y;
 641
 642         if (applesmc_read_motion_sensor(SENSOR_X, &x))
 643                 return;
 644         if (applesmc_read_motion_sensor(SENSOR_Y, &y))
 645                 return;
 646
 647         x = -x;
 648         input_report_abs(idev, ABS_X, x - rest_x);
 649         input_report_abs(idev, ABS_Y, y - rest_y);
 650         input_sync(idev);
 651 }
 652
 653 /* Sysfs Files */
 654
 655 static ssize_t applesmc_name_show(struct device *dev,
 656                                    struct device_attribute *attr, char *buf)
 657 {
 658         return snprintf(buf, PAGE_SIZE, "applesmc\n");
 659 }
 660
 661 static ssize_t applesmc_position_show(struct device *dev,
 662                                    struct device_attribute *attr, char *buf)
 663 {
 664         int ret;
 665         s16 x, y, z;
 666
 667         ret = applesmc_read_motion_sensor(SENSOR_X, &x);
 668         if (ret)
 669                 goto out;
 670         ret = applesmc_read_motion_sensor(SENSOR_Y, &y);
 671         if (ret)
 672                 goto out;
 673         ret = applesmc_read_motion_sensor(SENSOR_Z, &z);
 674         if (ret)
 675                 goto out;
 676
 677 out:
 678         if (ret)
 679                 return ret;
 680         else
 681                 return snprintf(buf, PAGE_SIZE, "(%d,%d,%d)\n", x, y, z);
 682 }
 683
 684 static ssize_t applesmc_light_show(struct device *dev,
 685                                 struct device_attribute *attr, char *sysfsbuf)
 686 {
 687         const struct applesmc_entry *entry;
 688         static int data_length;
 689         int ret;
 690         u8 left = 0, right = 0;
 691         u8 buffer[10];
 692
 693         if (!data_length) {
 694                 entry = applesmc_get_entry_by_key(LIGHT_SENSOR_LEFT_KEY);
 695                 if (IS_ERR(entry))
 696                         return PTR_ERR(entry);
 697                 if (entry->len > 10)
 698                         return -ENXIO;
 699                 data_length = entry->len;
 700                 pr_info("light sensor data length set to %d\n", data_length);
 701         }
 702
 703         ret = applesmc_read_key(LIGHT_SENSOR_LEFT_KEY, buffer, data_length);
 704         /* newer macbooks report a single 10-bit bigendian value */
 705         if (data_length == 10) {
 706                 left = be16_to_cpu(*(__be16 *)(buffer + 6)) >> 2;
 707                 goto out;
 708         }
 709         left = buffer[2];
 710         if (ret)
 711                 goto out;
 712         ret = applesmc_read_key(LIGHT_SENSOR_RIGHT_KEY, buffer, data_length);
 713         right = buffer[2];
 714
 715 out:
 716         if (ret)
 717                 return ret;
 718         else
 719                 return snprintf(sysfsbuf, PAGE_SIZE, "(%d,%d)\n", left, right);
 720 }
 721
 722 /* Displays sensor key as label */
 723 static ssize_t applesmc_show_sensor_label(struct device *dev,
 724                         struct device_attribute *devattr, char *sysfsbuf)
 725 {
 726         int index = smcreg.temp_begin + to_index(devattr);
 727         const struct applesmc_entry *entry;
 728
 729         entry = applesmc_get_entry_by_index(index);
 730         if (IS_ERR(entry))
 731                 return PTR_ERR(entry);
 732
 733         return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", entry->key);
 734 }
 735
 736 /* Displays degree Celsius * 1000 */
 737 static ssize_t applesmc_show_temperature(struct device *dev,
 738                         struct device_attribute *devattr, char *sysfsbuf)
 739 {
 740         int index = smcreg.temp_begin + to_index(devattr);
 741         const struct applesmc_entry *entry;
 742         int ret;
 743         u8 buffer[2];
 744         unsigned int temp;
 745
 746         entry = applesmc_get_entry_by_index(index);
 747         if (IS_ERR(entry))
 748                 return PTR_ERR(entry);
 749         if (entry->len > 2)
 750                 return -EINVAL;
 751
 752         ret = applesmc_read_entry(entry, buffer, entry->len);
 753         if (ret)
 754                 return ret;
 755
 756         if (entry->len == 2) {
 757                 temp = buffer[0] * 1000;
 758                 temp += (buffer[1] >> 6) * 250;
 759         } else {
 760                 temp = buffer[0] * 4000;
 761         }
 762
 763         return snprintf(sysfsbuf, PAGE_SIZE, "%u\n", temp);
 764 }
 765
 766 static ssize_t applesmc_show_fan_speed(struct device *dev,
 767                                 struct device_attribute *attr, char *sysfsbuf)
 768 {
 769         int ret;
 770         unsigned int speed = 0;
 771         char newkey[5];
 772         u8 buffer[2];
 773
 774         sprintf(newkey, fan_speed_fmt[to_option(attr)], to_index(attr));
 775
 776         ret = applesmc_read_key(newkey, buffer, 2);
 777         speed = ((buffer[0] << 8 | buffer[1]) >> 2);
 778
 779         if (ret)
 780                 return ret;
 781         else
 782                 return snprintf(sysfsbuf, PAGE_SIZE, "%u\n", speed);
 783 }
 784
 785 static ssize_t applesmc_store_fan_speed(struct device *dev,
 786                                         struct device_attribute *attr,
 787                                         const char *sysfsbuf, size_t count)
 788 {
 789         int ret;
 790         unsigned long speed;
 791         char newkey[5];
 792         u8 buffer[2];
 793
 794         if (strict_strtoul(sysfsbuf, 10, &speed) < 0 || speed >= 0x4000)
 795                 return -EINVAL;         /* Bigger than a 14-bit value */
 796
 797         sprintf(newkey, fan_speed_fmt[to_option(attr)], to_index(attr));
 798
 799         buffer[0] = (speed >> 6) & 0xff;
 800         buffer[1] = (speed << 2) & 0xff;
 801         ret = applesmc_write_key(newkey, buffer, 2);
 802
 803         if (ret)
 804                 return ret;
 805         else
 806                 return count;
 807 }
 808
 809 static ssize_t applesmc_show_fan_manual(struct device *dev,
 810                         struct device_attribute *attr, char *sysfsbuf)
 811 {
 812         int ret;
 813         u16 manual = 0;
 814         u8 buffer[2];
 815
 816         ret = applesmc_read_key(FANS_MANUAL, buffer, 2);
 817         manual = ((buffer[0] << 8 | buffer[1]) >> to_index(attr)) & 0x01;
 818
 819         if (ret)
 820                 return ret;
 821         else
 822                 return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", manual);
 823 }
 824
 825 static ssize_t applesmc_store_fan_manual(struct device *dev,
 826                                          struct device_attribute *attr,
 827                                          const char *sysfsbuf, size_t count)
 828 {
 829         int ret;
 830         u8 buffer[2];
 831         unsigned long input;
 832         u16 val;
 833
 834         if (strict_strtoul(sysfsbuf, 10, &input) < 0)
 835                 return -EINVAL;
 836
 837         ret = applesmc_read_key(FANS_MANUAL, buffer, 2);
 838         val = (buffer[0] << 8 | buffer[1]);
 839         if (ret)
 840                 goto out;
 841
 842         if (input)
 843                 val = val | (0x01 << to_index(attr));
 844         else
 845                 val = val & ~(0x01 << to_index(attr));
 846
 847         buffer[0] = (val >> 8) & 0xFF;
 848         buffer[1] = val & 0xFF;
 849
 850         ret = applesmc_write_key(FANS_MANUAL, buffer, 2);
 851
 852 out:
 853         if (ret)
 854                 return ret;
 855         else
 856                 return count;
 857 }
 858
 859 static ssize_t applesmc_show_fan_position(struct device *dev,
 860                                 struct device_attribute *attr, char *sysfsbuf)
 861 {
 862         int ret;
 863         char newkey[5];
 864         u8 buffer[17];
 865
 866         sprintf(newkey, FAN_ID_FMT, to_index(attr));
 867
 868         ret = applesmc_read_key(newkey, buffer, 16);
 869         buffer[16] = 0;
 870
 871         if (ret)
 872                 return ret;
 873         else
 874                 return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", buffer+4);
 875 }
 876
 877 static ssize_t applesmc_calibrate_show(struct device *dev,
 878                                 struct device_attribute *attr, char *sysfsbuf)
 879 {
 880         return snprintf(sysfsbuf, PAGE_SIZE, "(%d,%d)\n", rest_x, rest_y);
 881 }
 882
 883 static ssize_t applesmc_calibrate_store(struct device *dev,
 884         struct device_attribute *attr, const char *sysfsbuf, size_t count)
 885 {
 886         applesmc_calibrate();
 887
 888         return count;
 889 }
 890
 891 static void applesmc_backlight_set(struct work_struct *work)
 892 {
 893         applesmc_write_key(BACKLIGHT_KEY, backlight_state, 2);
 894 }
 895 static DECLARE_WORK(backlight_work, &applesmc_backlight_set);
 896
 897 static void applesmc_brightness_set(struct led_classdev *led_cdev,
 898                                                 enum led_brightness value)
 899 {
 900         int ret;
 901
 902         backlight_state[0] = value;
 903         ret = queue_work(applesmc_led_wq, &backlight_work);
 904
 905         if (debug && (!ret))
 906                 printk(KERN_DEBUG "applesmc: work was already on the queue.\n");
 907 }
 908
 909 static ssize_t applesmc_key_count_show(struct device *dev,
 910                                 struct device_attribute *attr, char *sysfsbuf)
 911 {
 912         int ret;
 913         u8 buffer[4];
 914         u32 count;
 915
 916         ret = applesmc_read_key(KEY_COUNT_KEY, buffer, 4);
 917         count = ((u32)buffer[0]<<24) + ((u32)buffer[1]<<16) +
 918                                                 ((u32)buffer[2]<<8) + buffer[3];
 919
 920         if (ret)
 921                 return ret;
 922         else
 923                 return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", count);
 924 }
 925
 926 static ssize_t applesmc_key_at_index_read_show(struct device *dev,
 927                                 struct device_attribute *attr, char *sysfsbuf)
 928 {
 929         const struct applesmc_entry *entry;
 930         int ret;
 931
 932         entry = applesmc_get_entry_by_index(key_at_index);
 933         if (IS_ERR(entry))
 934                 return PTR_ERR(entry);
 935         ret = applesmc_read_entry(entry, sysfsbuf, entry->len);
 936         if (ret)
 937                 return ret;
 938
 939         return entry->len;
 940 }
 941
 942 static ssize_t applesmc_key_at_index_data_length_show(struct device *dev,
 943                                 struct device_attribute *attr, char *sysfsbuf)
 944 {
 945         const struct applesmc_entry *entry;
 946
 947         entry = applesmc_get_entry_by_index(key_at_index);
 948         if (IS_ERR(entry))
 949                 return PTR_ERR(entry);
 950
 951         return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", entry->len);
 952 }
 953
 954 static ssize_t applesmc_key_at_index_type_show(struct device *dev,
 955                                 struct device_attribute *attr, char *sysfsbuf)
 956 {
 957         const struct applesmc_entry *entry;
 958
 959         entry = applesmc_get_entry_by_index(key_at_index);
 960         if (IS_ERR(entry))
 961                 return PTR_ERR(entry);
 962
 963         return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", entry->type);
 964 }
 965
 966 static ssize_t applesmc_key_at_index_name_show(struct device *dev,
 967                                 struct device_attribute *attr, char *sysfsbuf)
 968 {
 969         const struct applesmc_entry *entry;
 970
 971         entry = applesmc_get_entry_by_index(key_at_index);
 972         if (IS_ERR(entry))
 973                 return PTR_ERR(entry);
 974
 975         return snprintf(sysfsbuf, PAGE_SIZE, "%s\n", entry->key);
 976 }
 977
 978 static ssize_t applesmc_key_at_index_show(struct device *dev,
 979                                 struct device_attribute *attr, char *sysfsbuf)
 980 {
 981         return snprintf(sysfsbuf, PAGE_SIZE, "%d\n", key_at_index);
 982 }
 983
 984 static ssize_t applesmc_key_at_index_store(struct device *dev,
 985         struct device_attribute *attr, const char *sysfsbuf, size_t count)
 986 {
 987         unsigned long newkey;
 988
 989         if (strict_strtoul(sysfsbuf, 10, &newkey) < 0
 990             || newkey >= smcreg.key_count)
 991                 return -EINVAL;
 992
 993         key_at_index = newkey;
 994         return count;
 995 }
 996
 997 static struct led_classdev applesmc_backlight = {
 998         .name                   = "smc::kbd_backlight",
 999         .default_trigger        = "nand-disk",
1000         .brightness_set         = applesmc_brightness_set,
1001 };
1002
1003 static struct applesmc_node_group info_group[] = {
1004         { "name", applesmc_name_show },
1005         { "key_count", applesmc_key_count_show },
1006         { "key_at_index", applesmc_key_at_index_show, applesmc_key_at_index_store },
1007         { "key_at_index_name", applesmc_key_at_index_name_show },
1008         { "key_at_index_type", applesmc_key_at_index_type_show },
1009         { "key_at_index_data_length", applesmc_key_at_index_data_length_show },
1010         { "key_at_index_data", applesmc_key_at_index_read_show },
1011         { }
1012 };
1013
1014 static struct applesmc_node_group accelerometer_group[] = {
1015         { "position", applesmc_position_show },
1016         { "calibrate", applesmc_calibrate_show, applesmc_calibrate_store },
1017         { }
1018 };
1019
1020 static struct applesmc_node_group light_sensor_group[] = {
1021         { "light", applesmc_light_show },
1022         { }
1023 };
1024
1025 static struct applesmc_node_group fan_group[] = {
1026         { "fan%d_label", applesmc_show_fan_position },
1027         { "fan%d_input", applesmc_show_fan_speed, NULL, 0 },
1028         { "fan%d_min", applesmc_show_fan_speed, applesmc_store_fan_speed, 1 },
1029         { "fan%d_max", applesmc_show_fan_speed, NULL, 2 },
1030         { "fan%d_safe", applesmc_show_fan_speed, NULL, 3 },
1031         { "fan%d_output", applesmc_show_fan_speed, applesmc_store_fan_speed, 4 },
1032         { "fan%d_manual", applesmc_show_fan_manual, applesmc_store_fan_manual },
1033         { }
1034 };
1035
1036 static struct applesmc_node_group temp_group[] = {
1037         { "temp%d_label", applesmc_show_sensor_label },
1038         { "temp%d_input", applesmc_show_temperature },
1039         { }
1040 };
1041
1042 /* Module stuff */
1043
1044 /*
1045  * applesmc_destroy_nodes - remove files and free associated memory
1046  */
1047 static void applesmc_destroy_nodes(struct applesmc_node_group *groups)
1048 {
1049         struct applesmc_node_group *grp;
1050         struct applesmc_dev_attr *node;
1051
1052         for (grp = groups; grp->nodes; grp++) {
1053                 for (node = grp->nodes; node->sda.dev_attr.attr.name; node++)
1054                         sysfs_remove_file(&pdev->dev.kobj,
1055                                           &node->sda.dev_attr.attr);
1056                 kfree(grp->nodes);
1057                 grp->nodes = NULL;
1058         }
1059 }
1060
1061 /*
1062  * applesmc_create_nodes - create a two-dimensional group of sysfs files
1063  */
1064 static int applesmc_create_nodes(struct applesmc_node_group *groups, int num)
1065 {
1066         struct applesmc_node_group *grp;
1067         struct applesmc_dev_attr *node;
1068         struct attribute *attr;
1069         int ret, i;
1070
1071         for (grp = groups; grp->format; grp++) {
1072                 grp->nodes = kcalloc(num + 1, sizeof(*node), GFP_KERNEL);
1073                 if (!grp->nodes) {
1074                         ret = -ENOMEM;
1075                         goto out;
1076                 }
1077                 for (i = 0; i < num; i++) {
1078                         node = &grp->nodes[i];
1079                         sprintf(node->name, grp->format, i + 1);
1080                         node->sda.index = (grp->option << 16) | (i & 0xffff);
1081                         node->sda.dev_attr.show = grp->show;
1082                         node->sda.dev_attr.store = grp->store;
1083                         attr = &node->sda.dev_attr.attr;
1084                         sysfs_attr_init(attr);
1085                         attr->name = node->name;
1086                         attr->mode = S_IRUGO | (grp->store ? S_IWUSR : 0);
1087                         ret = sysfs_create_file(&pdev->dev.kobj, attr);
1088                         if (ret) {
1089                                 attr->name = NULL;
1090                                 goto out;
1091                         }
1092                 }
1093         }
1094
1095         return 0;
1096 out:
1097         applesmc_destroy_nodes(groups);
1098         return ret;
1099 }
1100
1101 /* Create accelerometer ressources */
1102 static int applesmc_create_accelerometer(void)
1103 {
1104         struct input_dev *idev;
1105         int ret;
1106
1107         if (!smcreg.has_accelerometer)
1108                 return 0;
1109
1110         ret = applesmc_create_nodes(accelerometer_group, 1);
1111         if (ret)
1112                 goto out;
1113
1114         applesmc_idev = input_allocate_polled_device();
1115         if (!applesmc_idev) {
1116                 ret = -ENOMEM;
1117                 goto out_sysfs;
1118         }
1119
1120         applesmc_idev->poll = applesmc_idev_poll;
1121         applesmc_idev->poll_interval = APPLESMC_POLL_INTERVAL;
1122
1123         /* initial calibrate for the input device */
1124         applesmc_calibrate();
1125
1126         /* initialize the input device */
1127         idev = applesmc_idev->input;
1128         idev->name = "applesmc";
1129         idev->id.bustype = BUS_HOST;
1130         idev->dev.parent = &pdev->dev;
1131         idev->evbit[0] = BIT_MASK(EV_ABS);
1132         input_set_abs_params(idev, ABS_X,
1133                         -256, 256, APPLESMC_INPUT_FUZZ, APPLESMC_INPUT_FLAT);
1134         input_set_abs_params(idev, ABS_Y,
1135                         -256, 256, APPLESMC_INPUT_FUZZ, APPLESMC_INPUT_FLAT);
1136
1137         ret = input_register_polled_device(applesmc_idev);
1138         if (ret)
1139                 goto out_idev;
1140
1141         return 0;
1142
1143 out_idev:
1144         input_free_polled_device(applesmc_idev);
1145
1146 out_sysfs:
1147         applesmc_destroy_nodes(accelerometer_group);
1148
1149 out:
1150         pr_warn("driver init failed (ret=%d)!\n", ret);
1151         return ret;
1152 }
1153
1154 /* Release all ressources used by the accelerometer */
1155 static void applesmc_release_accelerometer(void)
1156 {
1157         if (!smcreg.has_accelerometer)
1158                 return;
1159         input_unregister_polled_device(applesmc_idev);
1160         input_free_polled_device(applesmc_idev);
1161         applesmc_destroy_nodes(accelerometer_group);
1162 }
1163
1164 static int applesmc_create_light_sensor(void)
1165 {
1166         if (!smcreg.num_light_sensors)
1167                 return 0;
1168         return applesmc_create_nodes(light_sensor_group, 1);
1169 }
1170
1171 static void applesmc_release_light_sensor(void)
1172 {
1173         if (!smcreg.num_light_sensors)
1174                 return;
1175         applesmc_destroy_nodes(light_sensor_group);
1176 }
1177
1178 static int applesmc_create_key_backlight(void)
1179 {
1180         if (!smcreg.has_key_backlight)
1181                 return 0;
1182         applesmc_led_wq = create_singlethread_workqueue("applesmc-led");
1183         if (!applesmc_led_wq)
1184                 return -ENOMEM;
1185         return led_classdev_register(&pdev->dev, &applesmc_backlight);
1186 }
1187
1188 static void applesmc_release_key_backlight(void)
1189 {
1190         if (!smcreg.has_key_backlight)
1191                 return;
1192         led_classdev_unregister(&applesmc_backlight);
1193         destroy_workqueue(applesmc_led_wq);
1194 }
1195
1196 static int applesmc_dmi_match(const struct dmi_system_id *id)
1197 {
1198         return 1;
1199 }
1200
1201 /* Note that DMI_MATCH(...,"MacBook") will match "MacBookPro1,1".
1202  * So we need to put "Apple MacBook Pro" before "Apple MacBook". */
1203 static __initdata struct dmi_system_id applesmc_whitelist[] = {
1204         { applesmc_dmi_match, "Apple MacBook Air", {
1205           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1206           DMI_MATCH(DMI_PRODUCT_NAME, "MacBookAir") },
1207         },
1208         { applesmc_dmi_match, "Apple MacBook Pro", {
1209           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1210           DMI_MATCH(DMI_PRODUCT_NAME, "MacBookPro") },
1211         },
1212         { applesmc_dmi_match, "Apple MacBook", {
1213           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1214           DMI_MATCH(DMI_PRODUCT_NAME, "MacBook") },
1215         },
1216         { applesmc_dmi_match, "Apple Macmini", {
1217           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1218           DMI_MATCH(DMI_PRODUCT_NAME, "Macmini") },
1219         },
1220         { applesmc_dmi_match, "Apple MacPro", {
1221           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1222           DMI_MATCH(DMI_PRODUCT_NAME, "MacPro") },
1223         },
1224         { applesmc_dmi_match, "Apple iMac", {
1225           DMI_MATCH(DMI_BOARD_VENDOR, "Apple"),
1226           DMI_MATCH(DMI_PRODUCT_NAME, "iMac") },
1227         },
1228         { .ident = NULL }
1229 };
1230
1231 static int __init applesmc_init(void)
1232 {
1233         int ret;
1234
1235         if (!dmi_check_system(applesmc_whitelist)) {
1236                 pr_warn("supported laptop not found!\n");
1237                 ret = -ENODEV;
1238                 goto out;
1239         }
1240
1241         if (!request_region(APPLESMC_DATA_PORT, APPLESMC_NR_PORTS,
1242                                                                 "applesmc")) {
1243                 ret = -ENXIO;
1244                 goto out;
1245         }
1246
1247         ret = platform_driver_register(&applesmc_driver);
1248         if (ret)
1249                 goto out_region;
1250
1251         pdev = platform_device_register_simple("applesmc", APPLESMC_DATA_PORT,
1252                                                NULL, 0);
1253         if (IS_ERR(pdev)) {
1254                 ret = PTR_ERR(pdev);
1255                 goto out_driver;
1256         }
1257
1258         /* create register cache */
1259         ret = applesmc_init_smcreg();
1260         if (ret)
1261                 goto out_device;
1262
1263         ret = applesmc_create_nodes(info_group, 1);
1264         if (ret)
1265                 goto out_smcreg;
1266
1267         ret = applesmc_create_nodes(fan_group, smcreg.fan_count);
1268         if (ret)
1269                 goto out_info;
1270
1271         ret = applesmc_create_nodes(temp_group, smcreg.temp_count);
1272         if (ret)
1273                 goto out_fans;
1274
1275         ret = applesmc_create_accelerometer();
1276         if (ret)
1277                 goto out_temperature;
1278
1279         ret = applesmc_create_light_sensor();
1280         if (ret)
1281                 goto out_accelerometer;
1282
1283         ret = applesmc_create_key_backlight();
1284         if (ret)
1285                 goto out_light_sysfs;
1286
1287         hwmon_dev = hwmon_device_register(&pdev->dev);
1288         if (IS_ERR(hwmon_dev)) {
1289                 ret = PTR_ERR(hwmon_dev);
1290                 goto out_light_ledclass;
1291         }
1292
1293         return 0;
1294
1295 out_light_ledclass:
1296         applesmc_release_key_backlight();
1297 out_light_sysfs:
1298         applesmc_release_light_sensor();
1299 out_accelerometer:
1300         applesmc_release_accelerometer();
1301 out_temperature:
1302         applesmc_destroy_nodes(temp_group);
1303 out_fans:
1304         applesmc_destroy_nodes(fan_group);
1305 out_info:
1306         applesmc_destroy_nodes(info_group);
1307 out_smcreg:
1308         applesmc_destroy_smcreg();
1309 out_device:
1310         platform_device_unregister(pdev);
1311 out_driver:
1312         platform_driver_unregister(&applesmc_driver);
1313 out_region:
1314         release_region(APPLESMC_DATA_PORT, APPLESMC_NR_PORTS);
1315 out:
1316         pr_warn("driver init failed (ret=%d)!\n", ret);
1317         return ret;
1318 }
1319
1320 static void __exit applesmc_exit(void)
1321 {
1322         hwmon_device_unregister(hwmon_dev);
1323         applesmc_release_key_backlight();
1324         applesmc_release_light_sensor();
1325         applesmc_release_accelerometer();
1326         applesmc_destroy_nodes(temp_group);
1327         applesmc_destroy_nodes(fan_group);
1328         applesmc_destroy_nodes(info_group);
1329         applesmc_destroy_smcreg();
1330         platform_device_unregister(pdev);
1331         platform_driver_unregister(&applesmc_driver);
1332         release_region(APPLESMC_DATA_PORT, APPLESMC_NR_PORTS);
1333 }
1334
1335 module_init(applesmc_init);
1336 module_exit(applesmc_exit);
1337
1338 MODULE_AUTHOR("Nicolas Boichat");
1339 MODULE_DESCRIPTION("Apple SMC");
1340 MODULE_LICENSE("GPL v2");
1341 MODULE_DEVICE_TABLE(dmi, applesmc_whitelist);