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