drivers/hwmon/dell-smm-hwmon.c

   1 /*
   2  * dell-smm-hwmon.c -- Linux driver for accessing the SMM BIOS on Dell laptops.
   3  *
   4  * Copyright (C) 2001  Massimo Dal Zotto <dz@debian.org>
   5  *
   6  * Hwmon integration:
   7  * Copyright (C) 2011  Jean Delvare <jdelvare@suse.de>
   8  * Copyright (C) 2013, 2014  Guenter Roeck <linux@roeck-us.net>
   9  * Copyright (C) 2014, 2015  Pali Rohár <pali.rohar@gmail.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU General Public License as published by the
  13  * Free Software Foundation; either version 2, or (at your option) any
  14  * later version.
  15  *
  16  * This program is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * General Public License for more details.
  20  */
  21
  22 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  23
  24 #include <linux/delay.h>
  25 #include <linux/module.h>
  26 #include <linux/types.h>
  27 #include <linux/init.h>
  28 #include <linux/proc_fs.h>
  29 #include <linux/seq_file.h>
  30 #include <linux/dmi.h>
  31 #include <linux/capability.h>
  32 #include <linux/mutex.h>
  33 #include <linux/hwmon.h>
  34 #include <linux/hwmon-sysfs.h>
  35 #include <linux/uaccess.h>
  36 #include <linux/io.h>
  37 #include <linux/sched.h>
  38 #include <linux/ctype.h>
  39
  40 #include <linux/i8k.h>
  41
  42 #define I8K_SMM_FN_STATUS       0x0025
  43 #define I8K_SMM_POWER_STATUS    0x0069
  44 #define I8K_SMM_SET_FAN         0x01a3
  45 #define I8K_SMM_GET_FAN         0x00a3
  46 #define I8K_SMM_GET_SPEED       0x02a3
  47 #define I8K_SMM_GET_FAN_TYPE    0x03a3
  48 #define I8K_SMM_GET_NOM_SPEED   0x04a3
  49 #define I8K_SMM_GET_TEMP        0x10a3
  50 #define I8K_SMM_GET_TEMP_TYPE   0x11a3
  51 #define I8K_SMM_GET_DELL_SIG1   0xfea3
  52 #define I8K_SMM_GET_DELL_SIG2   0xffa3
  53
  54 #define I8K_FAN_MULT            30
  55 #define I8K_FAN_MAX_RPM         30000
  56 #define I8K_MAX_TEMP            127
  57
  58 #define I8K_FN_NONE             0x00
  59 #define I8K_FN_UP               0x01
  60 #define I8K_FN_DOWN             0x02
  61 #define I8K_FN_MUTE             0x04
  62 #define I8K_FN_MASK             0x07
  63 #define I8K_FN_SHIFT            8
  64
  65 #define I8K_POWER_AC            0x05
  66 #define I8K_POWER_BATTERY       0x01
  67
  68 static DEFINE_MUTEX(i8k_mutex);
  69 static char bios_version[4];
  70 static char bios_machineid[16];
  71 static struct device *i8k_hwmon_dev;
  72 static u32 i8k_hwmon_flags;
  73 static uint i8k_fan_mult = I8K_FAN_MULT;
  74 static uint i8k_pwm_mult;
  75 static uint i8k_fan_max = I8K_FAN_HIGH;
  76 static bool disallow_fan_type_call;
  77
  78 #define I8K_HWMON_HAVE_TEMP1    (1 << 0)
  79 #define I8K_HWMON_HAVE_TEMP2    (1 << 1)
  80 #define I8K_HWMON_HAVE_TEMP3    (1 << 2)
  81 #define I8K_HWMON_HAVE_TEMP4    (1 << 3)
  82 #define I8K_HWMON_HAVE_FAN1     (1 << 4)
  83 #define I8K_HWMON_HAVE_FAN2     (1 << 5)
  84
  85 MODULE_AUTHOR("Massimo Dal Zotto (dz@debian.org)");
  86 MODULE_AUTHOR("Pali Rohár <pali.rohar@gmail.com>");
  87 MODULE_DESCRIPTION("Dell laptop SMM BIOS hwmon driver");
  88 MODULE_LICENSE("GPL");
  89 MODULE_ALIAS("i8k");
  90
  91 static bool force;
  92 module_param(force, bool, 0);
  93 MODULE_PARM_DESC(force, "Force loading without checking for supported models");
  94
  95 static bool ignore_dmi;
  96 module_param(ignore_dmi, bool, 0);
  97 MODULE_PARM_DESC(ignore_dmi, "Continue probing hardware even if DMI data does not match");
  98
  99 #if IS_ENABLED(CONFIG_I8K)
 100 static bool restricted = true;
 101 module_param(restricted, bool, 0);
 102 MODULE_PARM_DESC(restricted, "Restrict fan control and serial number to CAP_SYS_ADMIN (default: 1)");
 103
 104 static bool power_status;
 105 module_param(power_status, bool, 0600);
 106 MODULE_PARM_DESC(power_status, "Report power status in /proc/i8k (default: 0)");
 107 #endif
 108
 109 static uint fan_mult;
 110 module_param(fan_mult, uint, 0);
 111 MODULE_PARM_DESC(fan_mult, "Factor to multiply fan speed with (default: autodetect)");
 112
 113 static uint fan_max;
 114 module_param(fan_max, uint, 0);
 115 MODULE_PARM_DESC(fan_max, "Maximum configurable fan speed (default: autodetect)");
 116
 117 struct smm_regs {
 118         unsigned int eax;
 119         unsigned int ebx __packed;
 120         unsigned int ecx __packed;
 121         unsigned int edx __packed;
 122         unsigned int esi __packed;
 123         unsigned int edi __packed;
 124 };
 125
 126 static inline const char *i8k_get_dmi_data(int field)
 127 {
 128         const char *dmi_data = dmi_get_system_info(field);
 129
 130         return dmi_data && *dmi_data ? dmi_data : "?";
 131 }
 132
 133 /*
 134  * Call the System Management Mode BIOS. Code provided by Jonathan Buzzard.
 135  */
 136 static int i8k_smm(struct smm_regs *regs)
 137 {
 138         int rc;
 139         int eax = regs->eax;
 140         cpumask_var_t old_mask;
 141
 142         /* SMM requires CPU 0 */
 143         if (!alloc_cpumask_var(&old_mask, GFP_KERNEL))
 144                 return -ENOMEM;
 145         cpumask_copy(old_mask, &current->cpus_allowed);
 146         rc = set_cpus_allowed_ptr(current, cpumask_of(0));
 147         if (rc)
 148                 goto out;
 149         if (smp_processor_id() != 0) {
 150                 rc = -EBUSY;
 151                 goto out;
 152         }
 153
 154 #if defined(CONFIG_X86_64)
 155         asm volatile("pushq %%rax\n\t"
 156                 "movl 0(%%rax),%%edx\n\t"
 157                 "pushq %%rdx\n\t"
 158                 "movl 4(%%rax),%%ebx\n\t"
 159                 "movl 8(%%rax),%%ecx\n\t"
 160                 "movl 12(%%rax),%%edx\n\t"
 161                 "movl 16(%%rax),%%esi\n\t"
 162                 "movl 20(%%rax),%%edi\n\t"
 163                 "popq %%rax\n\t"
 164                 "out %%al,$0xb2\n\t"
 165                 "out %%al,$0x84\n\t"
 166                 "xchgq %%rax,(%%rsp)\n\t"
 167                 "movl %%ebx,4(%%rax)\n\t"
 168                 "movl %%ecx,8(%%rax)\n\t"
 169                 "movl %%edx,12(%%rax)\n\t"
 170                 "movl %%esi,16(%%rax)\n\t"
 171                 "movl %%edi,20(%%rax)\n\t"
 172                 "popq %%rdx\n\t"
 173                 "movl %%edx,0(%%rax)\n\t"
 174                 "pushfq\n\t"
 175                 "popq %%rax\n\t"
 176                 "andl $1,%%eax\n"
 177                 : "=a"(rc)
 178                 :    "a"(regs)
 179                 :    "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
 180 #else
 181         asm volatile("pushl %%eax\n\t"
 182             "movl 0(%%eax),%%edx\n\t"
 183             "push %%edx\n\t"
 184             "movl 4(%%eax),%%ebx\n\t"
 185             "movl 8(%%eax),%%ecx\n\t"
 186             "movl 12(%%eax),%%edx\n\t"
 187             "movl 16(%%eax),%%esi\n\t"
 188             "movl 20(%%eax),%%edi\n\t"
 189             "popl %%eax\n\t"
 190             "out %%al,$0xb2\n\t"
 191             "out %%al,$0x84\n\t"
 192             "xchgl %%eax,(%%esp)\n\t"
 193             "movl %%ebx,4(%%eax)\n\t"
 194             "movl %%ecx,8(%%eax)\n\t"
 195             "movl %%edx,12(%%eax)\n\t"
 196             "movl %%esi,16(%%eax)\n\t"
 197             "movl %%edi,20(%%eax)\n\t"
 198             "popl %%edx\n\t"
 199             "movl %%edx,0(%%eax)\n\t"
 200             "lahf\n\t"
 201             "shrl $8,%%eax\n\t"
 202             "andl $1,%%eax\n"
 203             : "=a"(rc)
 204             :    "a"(regs)
 205             :    "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
 206 #endif
 207         if (rc != 0 || (regs->eax & 0xffff) == 0xffff || regs->eax == eax)
 208                 rc = -EINVAL;
 209
 210 out:
 211         set_cpus_allowed_ptr(current, old_mask);
 212         free_cpumask_var(old_mask);
 213         return rc;
 214 }
 215
 216 /*
 217  * Read the fan status.
 218  */
 219 static int i8k_get_fan_status(int fan)
 220 {
 221         struct smm_regs regs = { .eax = I8K_SMM_GET_FAN, };
 222
 223         regs.ebx = fan & 0xff;
 224         return i8k_smm(&regs) ? : regs.eax & 0xff;
 225 }
 226
 227 /*
 228  * Read the fan speed in RPM.
 229  */
 230 static int i8k_get_fan_speed(int fan)
 231 {
 232         struct smm_regs regs = { .eax = I8K_SMM_GET_SPEED, };
 233
 234         regs.ebx = fan & 0xff;
 235         return i8k_smm(&regs) ? : (regs.eax & 0xffff) * i8k_fan_mult;
 236 }
 237
 238 /*
 239  * Read the fan type.
 240  */
 241 static int i8k_get_fan_type(int fan)
 242 {
 243         struct smm_regs regs = { .eax = I8K_SMM_GET_FAN_TYPE, };
 244
 245         if (disallow_fan_type_call)
 246                 return -EINVAL;
 247
 248         regs.ebx = fan & 0xff;
 249         return i8k_smm(&regs) ? : regs.eax & 0xff;
 250 }
 251
 252 /*
 253  * Read the fan nominal rpm for specific fan speed.
 254  */
 255 static int i8k_get_fan_nominal_speed(int fan, int speed)
 256 {
 257         struct smm_regs regs = { .eax = I8K_SMM_GET_NOM_SPEED, };
 258
 259         regs.ebx = (fan & 0xff) | (speed << 8);
 260         return i8k_smm(&regs) ? : (regs.eax & 0xffff) * i8k_fan_mult;
 261 }
 262
 263 /*
 264  * Set the fan speed (off, low, high). Returns the new fan status.
 265  */
 266 static int i8k_set_fan(int fan, int speed)
 267 {
 268         struct smm_regs regs = { .eax = I8K_SMM_SET_FAN, };
 269
 270         speed = (speed < 0) ? 0 : ((speed > i8k_fan_max) ? i8k_fan_max : speed);
 271         regs.ebx = (fan & 0xff) | (speed << 8);
 272
 273         return i8k_smm(&regs) ? : i8k_get_fan_status(fan);
 274 }
 275
 276 static int i8k_get_temp_type(int sensor)
 277 {
 278         struct smm_regs regs = { .eax = I8K_SMM_GET_TEMP_TYPE, };
 279
 280         regs.ebx = sensor & 0xff;
 281         return i8k_smm(&regs) ? : regs.eax & 0xff;
 282 }
 283
 284 /*
 285  * Read the cpu temperature.
 286  */
 287 static int _i8k_get_temp(int sensor)
 288 {
 289         struct smm_regs regs = {
 290                 .eax = I8K_SMM_GET_TEMP,
 291                 .ebx = sensor & 0xff,
 292         };
 293
 294         return i8k_smm(&regs) ? : regs.eax & 0xff;
 295 }
 296
 297 static int i8k_get_temp(int sensor)
 298 {
 299         int temp = _i8k_get_temp(sensor);
 300
 301         /*
 302          * Sometimes the temperature sensor returns 0x99, which is out of range.
 303          * In this case we retry (once) before returning an error.
 304          # 1003655137 00000058 00005a4b
 305          # 1003655138 00000099 00003a80 <--- 0x99 = 153 degrees
 306          # 1003655139 00000054 00005c52
 307          */
 308         if (temp == 0x99) {
 309                 msleep(100);
 310                 temp = _i8k_get_temp(sensor);
 311         }
 312         /*
 313          * Return -ENODATA for all invalid temperatures.
 314          *
 315          * Known instances are the 0x99 value as seen above as well as
 316          * 0xc1 (193), which may be returned when trying to read the GPU
 317          * temperature if the system supports a GPU and it is currently
 318          * turned off.
 319          */
 320         if (temp > I8K_MAX_TEMP)
 321                 return -ENODATA;
 322
 323         return temp;
 324 }
 325
 326 static int i8k_get_dell_signature(int req_fn)
 327 {
 328         struct smm_regs regs = { .eax = req_fn, };
 329         int rc;
 330
 331         rc = i8k_smm(&regs);
 332         if (rc < 0)
 333                 return rc;
 334
 335         return regs.eax == 1145651527 && regs.edx == 1145392204 ? 0 : -1;
 336 }
 337
 338 #if IS_ENABLED(CONFIG_I8K)
 339
 340 /*
 341  * Read the Fn key status.
 342  */
 343 static int i8k_get_fn_status(void)
 344 {
 345         struct smm_regs regs = { .eax = I8K_SMM_FN_STATUS, };
 346         int rc;
 347
 348         rc = i8k_smm(&regs);
 349         if (rc < 0)
 350                 return rc;
 351
 352         switch ((regs.eax >> I8K_FN_SHIFT) & I8K_FN_MASK) {
 353         case I8K_FN_UP:
 354                 return I8K_VOL_UP;
 355         case I8K_FN_DOWN:
 356                 return I8K_VOL_DOWN;
 357         case I8K_FN_MUTE:
 358                 return I8K_VOL_MUTE;
 359         default:
 360                 return 0;
 361         }
 362 }
 363
 364 /*
 365  * Read the power status.
 366  */
 367 static int i8k_get_power_status(void)
 368 {
 369         struct smm_regs regs = { .eax = I8K_SMM_POWER_STATUS, };
 370         int rc;
 371
 372         rc = i8k_smm(&regs);
 373         if (rc < 0)
 374                 return rc;
 375
 376         return (regs.eax & 0xff) == I8K_POWER_AC ? I8K_AC : I8K_BATTERY;
 377 }
 378
 379 /*
 380  * Procfs interface
 381  */
 382
 383 static int
 384 i8k_ioctl_unlocked(struct file *fp, unsigned int cmd, unsigned long arg)
 385 {
 386         int val = 0;
 387         int speed;
 388         unsigned char buff[16];
 389         int __user *argp = (int __user *)arg;
 390
 391         if (!argp)
 392                 return -EINVAL;
 393
 394         switch (cmd) {
 395         case I8K_BIOS_VERSION:
 396                 if (!isdigit(bios_version[0]) || !isdigit(bios_version[1]) ||
 397                     !isdigit(bios_version[2]))
 398                         return -EINVAL;
 399
 400                 val = (bios_version[0] << 16) |
 401                                 (bios_version[1] << 8) | bios_version[2];
 402                 break;
 403
 404         case I8K_MACHINE_ID:
 405                 if (restricted && !capable(CAP_SYS_ADMIN))
 406                         return -EPERM;
 407
 408                 memset(buff, 0, sizeof(buff));
 409                 strlcpy(buff, bios_machineid, sizeof(buff));
 410                 break;
 411
 412         case I8K_FN_STATUS:
 413                 val = i8k_get_fn_status();
 414                 break;
 415
 416         case I8K_POWER_STATUS:
 417                 val = i8k_get_power_status();
 418                 break;
 419
 420         case I8K_GET_TEMP:
 421                 val = i8k_get_temp(0);
 422                 break;
 423
 424         case I8K_GET_SPEED:
 425                 if (copy_from_user(&val, argp, sizeof(int)))
 426                         return -EFAULT;
 427
 428                 val = i8k_get_fan_speed(val);
 429                 break;
 430
 431         case I8K_GET_FAN:
 432                 if (copy_from_user(&val, argp, sizeof(int)))
 433                         return -EFAULT;
 434
 435                 val = i8k_get_fan_status(val);
 436                 break;
 437
 438         case I8K_SET_FAN:
 439                 if (restricted && !capable(CAP_SYS_ADMIN))
 440                         return -EPERM;
 441
 442                 if (copy_from_user(&val, argp, sizeof(int)))
 443                         return -EFAULT;
 444
 445                 if (copy_from_user(&speed, argp + 1, sizeof(int)))
 446                         return -EFAULT;
 447
 448                 val = i8k_set_fan(val, speed);
 449                 break;
 450
 451         default:
 452                 return -EINVAL;
 453         }
 454
 455         if (val < 0)
 456                 return val;
 457
 458         switch (cmd) {
 459         case I8K_BIOS_VERSION:
 460                 if (copy_to_user(argp, &val, 4))
 461                         return -EFAULT;
 462
 463                 break;
 464         case I8K_MACHINE_ID:
 465                 if (copy_to_user(argp, buff, 16))
 466                         return -EFAULT;
 467
 468                 break;
 469         default:
 470                 if (copy_to_user(argp, &val, sizeof(int)))
 471                         return -EFAULT;
 472
 473                 break;
 474         }
 475
 476         return 0;
 477 }
 478
 479 static long i8k_ioctl(struct file *fp, unsigned int cmd, unsigned long arg)
 480 {
 481         long ret;
 482
 483         mutex_lock(&i8k_mutex);
 484         ret = i8k_ioctl_unlocked(fp, cmd, arg);
 485         mutex_unlock(&i8k_mutex);
 486
 487         return ret;
 488 }
 489
 490 /*
 491  * Print the information for /proc/i8k.
 492  */
 493 static int i8k_proc_show(struct seq_file *seq, void *offset)
 494 {
 495         int fn_key, cpu_temp, ac_power;
 496         int left_fan, right_fan, left_speed, right_speed;
 497
 498         cpu_temp        = i8k_get_temp(0);                      /* 11100 µs */
 499         left_fan        = i8k_get_fan_status(I8K_FAN_LEFT);     /*   580 µs */
 500         right_fan       = i8k_get_fan_status(I8K_FAN_RIGHT);    /*   580 µs */
 501         left_speed      = i8k_get_fan_speed(I8K_FAN_LEFT);      /*   580 µs */
 502         right_speed     = i8k_get_fan_speed(I8K_FAN_RIGHT);     /*   580 µs */
 503         fn_key          = i8k_get_fn_status();                  /*   750 µs */
 504         if (power_status)
 505                 ac_power = i8k_get_power_status();              /* 14700 µs */
 506         else
 507                 ac_power = -1;
 508
 509         /*
 510          * Info:
 511          *
 512          * 1)  Format version (this will change if format changes)
 513          * 2)  BIOS version
 514          * 3)  BIOS machine ID
 515          * 4)  Cpu temperature
 516          * 5)  Left fan status
 517          * 6)  Right fan status
 518          * 7)  Left fan speed
 519          * 8)  Right fan speed
 520          * 9)  AC power
 521          * 10) Fn Key status
 522          */
 523         seq_printf(seq, "%s %s %s %d %d %d %d %d %d %d\n",
 524                    I8K_PROC_FMT,
 525                    bios_version,
 526                    (restricted && !capable(CAP_SYS_ADMIN)) ? "-1" : bios_machineid,
 527                    cpu_temp,
 528                    left_fan, right_fan, left_speed, right_speed,
 529                    ac_power, fn_key);
 530
 531         return 0;
 532 }
 533
 534 static int i8k_open_fs(struct inode *inode, struct file *file)
 535 {
 536         return single_open(file, i8k_proc_show, NULL);
 537 }
 538
 539 static const struct file_operations i8k_fops = {
 540         .owner          = THIS_MODULE,
 541         .open           = i8k_open_fs,
 542         .read           = seq_read,
 543         .llseek         = seq_lseek,
 544         .release        = single_release,
 545         .unlocked_ioctl = i8k_ioctl,
 546 };
 547
 548 static void __init i8k_init_procfs(void)
 549 {
 550         /* Register the proc entry */
 551         proc_create("i8k", 0, NULL, &i8k_fops);
 552 }
 553
 554 static void __exit i8k_exit_procfs(void)
 555 {
 556         remove_proc_entry("i8k", NULL);
 557 }
 558
 559 #else
 560
 561 static inline void __init i8k_init_procfs(void)
 562 {
 563 }
 564
 565 static inline void __exit i8k_exit_procfs(void)
 566 {
 567 }
 568
 569 #endif
 570
 571 /*
 572  * Hwmon interface
 573  */
 574
 575 static ssize_t i8k_hwmon_show_temp_label(struct device *dev,
 576                                          struct device_attribute *devattr,
 577                                          char *buf)
 578 {
 579         static const char * const labels[] = {
 580                 "CPU",
 581                 "GPU",
 582                 "SODIMM",
 583                 "Other",
 584                 "Ambient",
 585                 "Other",
 586         };
 587         int index = to_sensor_dev_attr(devattr)->index;
 588         int type;
 589
 590         type = i8k_get_temp_type(index);
 591         if (type < 0)
 592                 return type;
 593         if (type >= ARRAY_SIZE(labels))
 594                 type = ARRAY_SIZE(labels) - 1;
 595         return sprintf(buf, "%s\n", labels[type]);
 596 }
 597
 598 static ssize_t i8k_hwmon_show_temp(struct device *dev,
 599                                    struct device_attribute *devattr,
 600                                    char *buf)
 601 {
 602         int index = to_sensor_dev_attr(devattr)->index;
 603         int temp;
 604
 605         temp = i8k_get_temp(index);
 606         if (temp < 0)
 607                 return temp;
 608         return sprintf(buf, "%d\n", temp * 1000);
 609 }
 610
 611 static ssize_t i8k_hwmon_show_fan_label(struct device *dev,
 612                                         struct device_attribute *devattr,
 613                                         char *buf)
 614 {
 615         static const char * const labels[] = {
 616                 "Processor Fan",
 617                 "Motherboard Fan",
 618                 "Video Fan",
 619                 "Power Supply Fan",
 620                 "Chipset Fan",
 621                 "Other Fan",
 622         };
 623         int index = to_sensor_dev_attr(devattr)->index;
 624         bool dock = false;
 625         int type;
 626
 627         type = i8k_get_fan_type(index);
 628         if (type < 0)
 629                 return type;
 630
 631         if (type & 0x10) {
 632                 dock = true;
 633                 type &= 0x0F;
 634         }
 635
 636         if (type >= ARRAY_SIZE(labels))
 637                 type = (ARRAY_SIZE(labels) - 1);
 638
 639         return sprintf(buf, "%s%s\n", (dock ? "Docking " : ""), labels[type]);
 640 }
 641
 642 static ssize_t i8k_hwmon_show_fan(struct device *dev,
 643                                   struct device_attribute *devattr,
 644                                   char *buf)
 645 {
 646         int index = to_sensor_dev_attr(devattr)->index;
 647         int fan_speed;
 648
 649         fan_speed = i8k_get_fan_speed(index);
 650         if (fan_speed < 0)
 651                 return fan_speed;
 652         return sprintf(buf, "%d\n", fan_speed);
 653 }
 654
 655 static ssize_t i8k_hwmon_show_pwm(struct device *dev,
 656                                   struct device_attribute *devattr,
 657                                   char *buf)
 658 {
 659         int index = to_sensor_dev_attr(devattr)->index;
 660         int status;
 661
 662         status = i8k_get_fan_status(index);
 663         if (status < 0)
 664                 return -EIO;
 665         return sprintf(buf, "%d\n", clamp_val(status * i8k_pwm_mult, 0, 255));
 666 }
 667
 668 static ssize_t i8k_hwmon_set_pwm(struct device *dev,
 669                                  struct device_attribute *attr,
 670                                  const char *buf, size_t count)
 671 {
 672         int index = to_sensor_dev_attr(attr)->index;
 673         unsigned long val;
 674         int err;
 675
 676         err = kstrtoul(buf, 10, &val);
 677         if (err)
 678                 return err;
 679         val = clamp_val(DIV_ROUND_CLOSEST(val, i8k_pwm_mult), 0, i8k_fan_max);
 680
 681         mutex_lock(&i8k_mutex);
 682         err = i8k_set_fan(index, val);
 683         mutex_unlock(&i8k_mutex);
 684
 685         return err < 0 ? -EIO : count;
 686 }
 687
 688 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, i8k_hwmon_show_temp, NULL, 0);
 689 static SENSOR_DEVICE_ATTR(temp1_label, S_IRUGO, i8k_hwmon_show_temp_label, NULL,
 690                           0);
 691 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, i8k_hwmon_show_temp, NULL, 1);
 692 static SENSOR_DEVICE_ATTR(temp2_label, S_IRUGO, i8k_hwmon_show_temp_label, NULL,
 693                           1);
 694 static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, i8k_hwmon_show_temp, NULL, 2);
 695 static SENSOR_DEVICE_ATTR(temp3_label, S_IRUGO, i8k_hwmon_show_temp_label, NULL,
 696                           2);
 697 static SENSOR_DEVICE_ATTR(temp4_input, S_IRUGO, i8k_hwmon_show_temp, NULL, 3);
 698 static SENSOR_DEVICE_ATTR(temp4_label, S_IRUGO, i8k_hwmon_show_temp_label, NULL,
 699                           3);
 700 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, i8k_hwmon_show_fan, NULL, 0);
 701 static SENSOR_DEVICE_ATTR(fan1_label, S_IRUGO, i8k_hwmon_show_fan_label, NULL,
 702                           0);
 703 static SENSOR_DEVICE_ATTR(pwm1, S_IRUGO | S_IWUSR, i8k_hwmon_show_pwm,
 704                           i8k_hwmon_set_pwm, 0);
 705 static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, i8k_hwmon_show_fan, NULL,
 706                           1);
 707 static SENSOR_DEVICE_ATTR(fan2_label, S_IRUGO, i8k_hwmon_show_fan_label, NULL,
 708                           1);
 709 static SENSOR_DEVICE_ATTR(pwm2, S_IRUGO | S_IWUSR, i8k_hwmon_show_pwm,
 710                           i8k_hwmon_set_pwm, 1);
 711
 712 static struct attribute *i8k_attrs[] = {
 713         &sensor_dev_attr_temp1_input.dev_attr.attr,     /* 0 */
 714         &sensor_dev_attr_temp1_label.dev_attr.attr,     /* 1 */
 715         &sensor_dev_attr_temp2_input.dev_attr.attr,     /* 2 */
 716         &sensor_dev_attr_temp2_label.dev_attr.attr,     /* 3 */
 717         &sensor_dev_attr_temp3_input.dev_attr.attr,     /* 4 */
 718         &sensor_dev_attr_temp3_label.dev_attr.attr,     /* 5 */
 719         &sensor_dev_attr_temp4_input.dev_attr.attr,     /* 6 */
 720         &sensor_dev_attr_temp4_label.dev_attr.attr,     /* 7 */
 721         &sensor_dev_attr_fan1_input.dev_attr.attr,      /* 8 */
 722         &sensor_dev_attr_fan1_label.dev_attr.attr,      /* 9 */
 723         &sensor_dev_attr_pwm1.dev_attr.attr,            /* 10 */
 724         &sensor_dev_attr_fan2_input.dev_attr.attr,      /* 11 */
 725         &sensor_dev_attr_fan2_label.dev_attr.attr,      /* 12 */
 726         &sensor_dev_attr_pwm2.dev_attr.attr,            /* 13 */
 727         NULL
 728 };
 729
 730 static umode_t i8k_is_visible(struct kobject *kobj, struct attribute *attr,
 731                               int index)
 732 {
 733         if (disallow_fan_type_call &&
 734             (index == 9 || index == 12))
 735                 return 0;
 736         if (index >= 0 && index <= 1 &&
 737             !(i8k_hwmon_flags & I8K_HWMON_HAVE_TEMP1))
 738                 return 0;
 739         if (index >= 2 && index <= 3 &&
 740             !(i8k_hwmon_flags & I8K_HWMON_HAVE_TEMP2))
 741                 return 0;
 742         if (index >= 4 && index <= 5 &&
 743             !(i8k_hwmon_flags & I8K_HWMON_HAVE_TEMP3))
 744                 return 0;
 745         if (index >= 6 && index <= 7 &&
 746             !(i8k_hwmon_flags & I8K_HWMON_HAVE_TEMP4))
 747                 return 0;
 748         if (index >= 8 && index <= 10 &&
 749             !(i8k_hwmon_flags & I8K_HWMON_HAVE_FAN1))
 750                 return 0;
 751         if (index >= 11 && index <= 13 &&
 752             !(i8k_hwmon_flags & I8K_HWMON_HAVE_FAN2))
 753                 return 0;
 754
 755         return attr->mode;
 756 }
 757
 758 static const struct attribute_group i8k_group = {
 759         .attrs = i8k_attrs,
 760         .is_visible = i8k_is_visible,
 761 };
 762 __ATTRIBUTE_GROUPS(i8k);
 763
 764 static int __init i8k_init_hwmon(void)
 765 {
 766         int err;
 767
 768         i8k_hwmon_flags = 0;
 769
 770         /* CPU temperature attributes, if temperature type is OK */
 771         err = i8k_get_temp_type(0);
 772         if (err >= 0)
 773                 i8k_hwmon_flags |= I8K_HWMON_HAVE_TEMP1;
 774         /* check for additional temperature sensors */
 775         err = i8k_get_temp_type(1);
 776         if (err >= 0)
 777                 i8k_hwmon_flags |= I8K_HWMON_HAVE_TEMP2;
 778         err = i8k_get_temp_type(2);
 779         if (err >= 0)
 780                 i8k_hwmon_flags |= I8K_HWMON_HAVE_TEMP3;
 781         err = i8k_get_temp_type(3);
 782         if (err >= 0)
 783                 i8k_hwmon_flags |= I8K_HWMON_HAVE_TEMP4;
 784
 785         /* First fan attributes, if fan type is OK */
 786         err = i8k_get_fan_type(0);
 787         if (err >= 0)
 788                 i8k_hwmon_flags |= I8K_HWMON_HAVE_FAN1;
 789
 790         /* Second fan attributes, if fan type is OK */
 791         err = i8k_get_fan_type(1);
 792         if (err >= 0)
 793                 i8k_hwmon_flags |= I8K_HWMON_HAVE_FAN2;
 794
 795         i8k_hwmon_dev = hwmon_device_register_with_groups(NULL, "dell_smm",
 796                                                           NULL, i8k_groups);
 797         if (IS_ERR(i8k_hwmon_dev)) {
 798                 err = PTR_ERR(i8k_hwmon_dev);
 799                 i8k_hwmon_dev = NULL;
 800                 pr_err("hwmon registration failed (%d)\n", err);
 801                 return err;
 802         }
 803         return 0;
 804 }
 805
 806 struct i8k_config_data {
 807         uint fan_mult;
 808         uint fan_max;
 809 };
 810
 811 enum i8k_configs {
 812         DELL_LATITUDE_D520,
 813         DELL_PRECISION_490,
 814         DELL_STUDIO,
 815         DELL_XPS,
 816 };
 817
 818 static const struct i8k_config_data i8k_config_data[] = {
 819         [DELL_LATITUDE_D520] = {
 820                 .fan_mult = 1,
 821                 .fan_max = I8K_FAN_TURBO,
 822         },
 823         [DELL_PRECISION_490] = {
 824                 .fan_mult = 1,
 825                 .fan_max = I8K_FAN_TURBO,
 826         },
 827         [DELL_STUDIO] = {
 828                 .fan_mult = 1,
 829                 .fan_max = I8K_FAN_HIGH,
 830         },
 831         [DELL_XPS] = {
 832                 .fan_mult = 1,
 833                 .fan_max = I8K_FAN_HIGH,
 834         },
 835 };
 836
 837 static struct dmi_system_id i8k_dmi_table[] __initdata = {
 838         {
 839                 .ident = "Dell Inspiron",
 840                 .matches = {
 841                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer"),
 842                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron"),
 843                 },
 844         },
 845         {
 846                 .ident = "Dell Latitude",
 847                 .matches = {
 848                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer"),
 849                         DMI_MATCH(DMI_PRODUCT_NAME, "Latitude"),
 850                 },
 851         },
 852         {
 853                 .ident = "Dell Inspiron 2",
 854                 .matches = {
 855                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 856                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron"),
 857                 },
 858         },
 859         {
 860                 .ident = "Dell Latitude D520",
 861                 .matches = {
 862                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 863                         DMI_MATCH(DMI_PRODUCT_NAME, "Latitude D520"),
 864                 },
 865                 .driver_data = (void *)&i8k_config_data[DELL_LATITUDE_D520],
 866         },
 867         {
 868                 .ident = "Dell Latitude 2",
 869                 .matches = {
 870                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 871                         DMI_MATCH(DMI_PRODUCT_NAME, "Latitude"),
 872                 },
 873         },
 874         {       /* UK Inspiron 6400  */
 875                 .ident = "Dell Inspiron 3",
 876                 .matches = {
 877                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 878                         DMI_MATCH(DMI_PRODUCT_NAME, "MM061"),
 879                 },
 880         },
 881         {
 882                 .ident = "Dell Inspiron 3",
 883                 .matches = {
 884                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 885                         DMI_MATCH(DMI_PRODUCT_NAME, "MP061"),
 886                 },
 887         },
 888         {
 889                 .ident = "Dell Precision 490",
 890                 .matches = {
 891                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 892                         DMI_MATCH(DMI_PRODUCT_NAME,
 893                                   "Precision WorkStation 490"),
 894                 },
 895                 .driver_data = (void *)&i8k_config_data[DELL_PRECISION_490],
 896         },
 897         {
 898                 .ident = "Dell Precision",
 899                 .matches = {
 900                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 901                         DMI_MATCH(DMI_PRODUCT_NAME, "Precision"),
 902                 },
 903         },
 904         {
 905                 .ident = "Dell Vostro",
 906                 .matches = {
 907                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 908                         DMI_MATCH(DMI_PRODUCT_NAME, "Vostro"),
 909                 },
 910         },
 911         {
 912                 .ident = "Dell XPS421",
 913                 .matches = {
 914                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 915                         DMI_MATCH(DMI_PRODUCT_NAME, "XPS L421X"),
 916                 },
 917         },
 918         {
 919                 .ident = "Dell Studio",
 920                 .matches = {
 921                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 922                         DMI_MATCH(DMI_PRODUCT_NAME, "Studio"),
 923                 },
 924                 .driver_data = (void *)&i8k_config_data[DELL_STUDIO],
 925         },
 926         {
 927                 .ident = "Dell XPS 13",
 928                 .matches = {
 929                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 930                         DMI_MATCH(DMI_PRODUCT_NAME, "XPS13"),
 931                 },
 932                 .driver_data = (void *)&i8k_config_data[DELL_XPS],
 933         },
 934         {
 935                 .ident = "Dell XPS M140",
 936                 .matches = {
 937                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 938                         DMI_MATCH(DMI_PRODUCT_NAME, "MXC051"),
 939                 },
 940                 .driver_data = (void *)&i8k_config_data[DELL_XPS],
 941         },
 942         { }
 943 };
 944
 945 MODULE_DEVICE_TABLE(dmi, i8k_dmi_table);
 946
 947 /*
 948  * On some machines once I8K_SMM_GET_FAN_TYPE is issued then CPU fan speed
 949  * randomly going up and down due to bug in Dell SMM or BIOS. Here is blacklist
 950  * of affected Dell machines for which we disallow I8K_SMM_GET_FAN_TYPE call.
 951  * See bug: https://bugzilla.kernel.org/show_bug.cgi?id=100121
 952  */
 953 static struct dmi_system_id i8k_blacklist_fan_type_dmi_table[] __initdata = {
 954         {
 955                 .ident = "Dell Studio XPS 8000",
 956                 .matches = {
 957                         DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 958                         DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Studio XPS 8000"),
 959                 },
 960         },
 961         {
 962                 .ident = "Dell Studio XPS 8100",
 963                 .matches = {
 964                         DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 965                         DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Studio XPS 8100"),
 966                 },
 967         },
 968         {
 969                 .ident = "Dell Inspiron 580",
 970                 .matches = {
 971                         DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 972                         DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Inspiron 580 "),
 973                 },
 974         },
 975         { }
 976 };
 977
 978 /*
 979  * Probe for the presence of a supported laptop.
 980  */
 981 static int __init i8k_probe(void)
 982 {
 983         const struct dmi_system_id *id;
 984         int fan, ret;
 985
 986         /*
 987          * Get DMI information
 988          */
 989         if (!dmi_check_system(i8k_dmi_table)) {
 990                 if (!ignore_dmi && !force)
 991                         return -ENODEV;
 992
 993                 pr_info("not running on a supported Dell system.\n");
 994                 pr_info("vendor=%s, model=%s, version=%s\n",
 995                         i8k_get_dmi_data(DMI_SYS_VENDOR),
 996                         i8k_get_dmi_data(DMI_PRODUCT_NAME),
 997                         i8k_get_dmi_data(DMI_BIOS_VERSION));
 998         }
 999
1000         if (dmi_check_system(i8k_blacklist_fan_type_dmi_table))
1001                 disallow_fan_type_call = true;
1002
1003         strlcpy(bios_version, i8k_get_dmi_data(DMI_BIOS_VERSION),
1004                 sizeof(bios_version));
1005         strlcpy(bios_machineid, i8k_get_dmi_data(DMI_PRODUCT_SERIAL),
1006                 sizeof(bios_machineid));
1007
1008         /*
1009          * Get SMM Dell signature
1010          */
1011         if (i8k_get_dell_signature(I8K_SMM_GET_DELL_SIG1) &&
1012             i8k_get_dell_signature(I8K_SMM_GET_DELL_SIG2)) {
1013                 pr_err("unable to get SMM Dell signature\n");
1014                 if (!force)
1015                         return -ENODEV;
1016         }
1017
1018         /*
1019          * Set fan multiplier and maximal fan speed from dmi config
1020          * Values specified in module parameters override values from dmi
1021          */
1022         id = dmi_first_match(i8k_dmi_table);
1023         if (id && id->driver_data) {
1024                 const struct i8k_config_data *conf = id->driver_data;
1025                 if (!fan_mult && conf->fan_mult)
1026                         fan_mult = conf->fan_mult;
1027                 if (!fan_max && conf->fan_max)
1028                         fan_max = conf->fan_max;
1029         }
1030
1031         i8k_fan_max = fan_max ? : I8K_FAN_HIGH; /* Must not be 0 */
1032         i8k_pwm_mult = DIV_ROUND_UP(255, i8k_fan_max);
1033
1034         if (!fan_mult) {
1035                 /*
1036                  * Autodetect fan multiplier based on nominal rpm
1037                  * If fan reports rpm value too high then set multiplier to 1
1038                  */
1039                 for (fan = 0; fan < 2; ++fan) {
1040                         ret = i8k_get_fan_nominal_speed(fan, i8k_fan_max);
1041                         if (ret < 0)
1042                                 continue;
1043                         if (ret > I8K_FAN_MAX_RPM)
1044                                 i8k_fan_mult = 1;
1045                         break;
1046                 }
1047         } else {
1048                 /* Fan multiplier was specified in module param or in dmi */
1049                 i8k_fan_mult = fan_mult;
1050         }
1051
1052         return 0;
1053 }
1054
1055 static int __init i8k_init(void)
1056 {
1057         int err;
1058
1059         /* Are we running on an supported laptop? */
1060         if (i8k_probe())
1061                 return -ENODEV;
1062
1063         err = i8k_init_hwmon();
1064         if (err)
1065                 return err;
1066
1067         i8k_init_procfs();
1068         return 0;
1069 }
1070
1071 static void __exit i8k_exit(void)
1072 {
1073         hwmon_device_unregister(i8k_hwmon_dev);
1074         i8k_exit_procfs();
1075 }
1076
1077 module_init(i8k_init);
1078 module_exit(i8k_exit);