2 * i8k.c -- Linux driver for accessing the SMM BIOS on Dell laptops.
3 * See http://www.debian.org/~dz/i8k/ for more information
4 * and for latest version of this driver.
6 * Copyright (C) 2001 Massimo Dal Zotto <dz@debian.org>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2, or (at your option) any
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
19 #include <linux/module.h>
20 #include <linux/types.h>
21 #include <linux/init.h>
22 #include <linux/proc_fs.h>
23 #include <linux/apm_bios.h>
24 #include <asm/uaccess.h>
27 #include <linux/i8k.h>
29 #define I8K_VERSION "1.13 14/05/2002"
31 #define I8K_SMM_FN_STATUS 0x0025
32 #define I8K_SMM_POWER_STATUS 0x0069
33 #define I8K_SMM_SET_FAN 0x01a3
34 #define I8K_SMM_GET_FAN 0x00a3
35 #define I8K_SMM_GET_SPEED 0x02a3
36 #define I8K_SMM_GET_TEMP 0x10a3
37 #define I8K_SMM_GET_DELL_SIG 0xffa3
38 #define I8K_SMM_BIOS_VERSION 0x00a6
40 #define I8K_FAN_MULT 30
41 #define I8K_MAX_TEMP 127
43 #define I8K_FN_NONE 0x00
44 #define I8K_FN_UP 0x01
45 #define I8K_FN_DOWN 0x02
46 #define I8K_FN_MUTE 0x04
47 #define I8K_FN_MASK 0x07
48 #define I8K_FN_SHIFT 8
50 #define I8K_POWER_AC 0x05
51 #define I8K_POWER_BATTERY 0x01
53 #define I8K_TEMPERATURE_BUG 1
55 #define DELL_SIGNATURE "Dell Computer"
57 static char *supported_models[] = {
63 static char system_vendor[48] = "?";
64 static char product_name [48] = "?";
65 static char bios_version [4] = "?";
66 static char serial_number[16] = "?";
68 MODULE_AUTHOR("Massimo Dal Zotto (dz@debian.org)");
69 MODULE_DESCRIPTION("Driver for accessing SMM BIOS on Dell laptops");
70 MODULE_LICENSE("GPL");
73 module_param(force, bool, 0);
74 MODULE_PARM_DESC(force, "Force loading without checking for supported models");
76 static int restricted;
77 module_param(restricted, bool, 0);
78 MODULE_PARM_DESC(restricted, "Allow fan control if SYS_ADMIN capability set");
80 static int power_status;
81 module_param(power_status, bool, 0600);
82 MODULE_PARM_DESC(power_status, "Report power status in /proc/i8k");
84 static ssize_t i8k_read(struct file *, char __user *, size_t, loff_t *);
85 static int i8k_ioctl(struct inode *, struct file *, unsigned int,
88 static struct file_operations i8k_fops = {
95 unsigned int ebx __attribute__ ((packed));
96 unsigned int ecx __attribute__ ((packed));
97 unsigned int edx __attribute__ ((packed));
98 unsigned int esi __attribute__ ((packed));
99 unsigned int edi __attribute__ ((packed));
109 * Call the System Management Mode BIOS. Code provided by Jonathan Buzzard.
111 static int i8k_smm(SMMRegisters *regs)
116 asm("pushl %%eax\n\t" \
117 "movl 0(%%eax),%%edx\n\t" \
119 "movl 4(%%eax),%%ebx\n\t" \
120 "movl 8(%%eax),%%ecx\n\t" \
121 "movl 12(%%eax),%%edx\n\t" \
122 "movl 16(%%eax),%%esi\n\t" \
123 "movl 20(%%eax),%%edi\n\t" \
125 "out %%al,$0xb2\n\t" \
126 "out %%al,$0x84\n\t" \
127 "xchgl %%eax,(%%esp)\n\t"
128 "movl %%ebx,4(%%eax)\n\t" \
129 "movl %%ecx,8(%%eax)\n\t" \
130 "movl %%edx,12(%%eax)\n\t" \
131 "movl %%esi,16(%%eax)\n\t" \
132 "movl %%edi,20(%%eax)\n\t" \
134 "movl %%edx,0(%%eax)\n\t" \
136 "shrl $8,%%eax\n\t" \
140 : "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
142 if ((rc != 0) || ((regs->eax & 0xffff) == 0xffff) || (regs->eax == eax)) {
150 * Read the bios version. Return the version as an integer corresponding
151 * to the ascii value, for example "A17" is returned as 0x00413137.
153 static int i8k_get_bios_version(void)
155 SMMRegisters regs = { 0, 0, 0, 0, 0, 0 };
158 regs.eax = I8K_SMM_BIOS_VERSION;
159 if ((rc=i8k_smm(®s)) < 0) {
167 * Read the machine id.
169 static int i8k_get_serial_number(unsigned char *buff)
171 strlcpy(buff, serial_number, sizeof(serial_number));
176 * Read the Fn key status.
178 static int i8k_get_fn_status(void)
180 SMMRegisters regs = { 0, 0, 0, 0, 0, 0 };
183 regs.eax = I8K_SMM_FN_STATUS;
184 if ((rc=i8k_smm(®s)) < 0) {
188 switch ((regs.eax >> I8K_FN_SHIFT) & I8K_FN_MASK) {
201 * Read the power status.
203 static int i8k_get_power_status(void)
205 SMMRegisters regs = { 0, 0, 0, 0, 0, 0 };
208 regs.eax = I8K_SMM_POWER_STATUS;
209 if ((rc=i8k_smm(®s)) < 0) {
213 switch (regs.eax & 0xff) {
222 * Read the fan status.
224 static int i8k_get_fan_status(int fan)
226 SMMRegisters regs = { 0, 0, 0, 0, 0, 0 };
229 regs.eax = I8K_SMM_GET_FAN;
230 regs.ebx = fan & 0xff;
231 if ((rc=i8k_smm(®s)) < 0) {
235 return (regs.eax & 0xff);
239 * Read the fan speed in RPM.
241 static int i8k_get_fan_speed(int fan)
243 SMMRegisters regs = { 0, 0, 0, 0, 0, 0 };
246 regs.eax = I8K_SMM_GET_SPEED;
247 regs.ebx = fan & 0xff;
248 if ((rc=i8k_smm(®s)) < 0) {
252 return (regs.eax & 0xffff) * I8K_FAN_MULT;
256 * Set the fan speed (off, low, high). Returns the new fan status.
258 static int i8k_set_fan(int fan, int speed)
260 SMMRegisters regs = { 0, 0, 0, 0, 0, 0 };
263 speed = (speed < 0) ? 0 : ((speed > I8K_FAN_MAX) ? I8K_FAN_MAX : speed);
265 regs.eax = I8K_SMM_SET_FAN;
266 regs.ebx = (fan & 0xff) | (speed << 8);
267 if ((rc=i8k_smm(®s)) < 0) {
271 return (i8k_get_fan_status(fan));
275 * Read the cpu temperature.
277 static int i8k_get_cpu_temp(void)
279 SMMRegisters regs = { 0, 0, 0, 0, 0, 0 };
283 #ifdef I8K_TEMPERATURE_BUG
287 regs.eax = I8K_SMM_GET_TEMP;
288 if ((rc=i8k_smm(®s)) < 0) {
291 temp = regs.eax & 0xff;
293 #ifdef I8K_TEMPERATURE_BUG
295 * Sometimes the temperature sensor returns 0x99, which is out of range.
296 * In this case we return (once) the previous cached value. For example:
297 # 1003655137 00000058 00005a4b
298 # 1003655138 00000099 00003a80 <--- 0x99 = 153 degrees
299 # 1003655139 00000054 00005c52
301 if (temp > I8K_MAX_TEMP) {
312 static int i8k_get_dell_signature(void)
314 SMMRegisters regs = { 0, 0, 0, 0, 0, 0 };
317 regs.eax = I8K_SMM_GET_DELL_SIG;
318 if ((rc=i8k_smm(®s)) < 0) {
322 if ((regs.eax == 1145651527) && (regs.edx == 1145392204)) {
329 static int i8k_ioctl(struct inode *ip, struct file *fp, unsigned int cmd,
334 unsigned char buff[16];
335 int __user *argp = (int __user *)arg;
341 case I8K_BIOS_VERSION:
342 val = i8k_get_bios_version();
347 val = i8k_get_serial_number(buff);
351 val = i8k_get_fn_status();
354 case I8K_POWER_STATUS:
355 val = i8k_get_power_status();
359 val = i8k_get_cpu_temp();
363 if (copy_from_user(&val, argp, sizeof(int))) {
366 val = i8k_get_fan_speed(val);
370 if (copy_from_user(&val, argp, sizeof(int))) {
373 val = i8k_get_fan_status(val);
377 if (restricted && !capable(CAP_SYS_ADMIN)) {
380 if (copy_from_user(&val, argp, sizeof(int))) {
383 if (copy_from_user(&speed, argp+1, sizeof(int))) {
386 val = i8k_set_fan(val, speed);
398 case I8K_BIOS_VERSION:
399 if (copy_to_user(argp, &val, 4)) {
404 if (copy_to_user(argp, buff, 16)) {
409 if (copy_to_user(argp, &val, sizeof(int))) {
419 * Print the information for /proc/i8k.
421 static int i8k_get_info(char *buffer, char **start, off_t fpos, int length)
423 int n, fn_key, cpu_temp, ac_power;
424 int left_fan, right_fan, left_speed, right_speed;
426 cpu_temp = i8k_get_cpu_temp(); /* 11100 µs */
427 left_fan = i8k_get_fan_status(I8K_FAN_LEFT); /* 580 µs */
428 right_fan = i8k_get_fan_status(I8K_FAN_RIGHT); /* 580 µs */
429 left_speed = i8k_get_fan_speed(I8K_FAN_LEFT); /* 580 µs */
430 right_speed = i8k_get_fan_speed(I8K_FAN_RIGHT); /* 580 µs */
431 fn_key = i8k_get_fn_status(); /* 750 µs */
433 ac_power = i8k_get_power_status(); /* 14700 µs */
441 * 1) Format version (this will change if format changes)
446 * 6) Right fan status
452 n = sprintf(buffer, "%s %s %s %d %d %d %d %d %d %d\n",
467 static ssize_t i8k_read(struct file *f, char __user *buffer, size_t len, loff_t *fpos)
472 n = i8k_get_info(info, NULL, 0, 128);
481 if ((*fpos + len) >= n) {
485 if (copy_to_user(buffer, info, len) != 0) {
493 static char* __init string_trim(char *s, int size)
498 if ((len = strlen(s)) > size) {
502 for (p=s+len-1; len && (*p==' '); len--,p--) {
509 /* DMI code, stolen from arch/i386/kernel/dmi_scan.c */
512 * |<-- dmi->length -->|
514 * |dmi header s=N | string1,\0, ..., stringN,\0, ..., \0
516 * +-----------------------+
518 static char* __init dmi_string(DMIHeader *dmi, u8 s)
527 p = (u8 *)dmi + dmi->length;
537 static void __init dmi_decode(DMIHeader *dmi)
539 u8 *data = (u8 *) dmi;
544 printk("%08x ", (int)data);
545 for (i=0; i<data[1] && i<64; i++) {
546 printk("%02x ", data[i]);
552 case 0: /* BIOS Information */
553 p = dmi_string(dmi,data[5]);
555 strlcpy(bios_version, p, sizeof(bios_version));
556 string_trim(bios_version, sizeof(bios_version));
559 case 1: /* System Information */
560 p = dmi_string(dmi,data[4]);
562 strlcpy(system_vendor, p, sizeof(system_vendor));
563 string_trim(system_vendor, sizeof(system_vendor));
565 p = dmi_string(dmi,data[5]);
567 strlcpy(product_name, p, sizeof(product_name));
568 string_trim(product_name, sizeof(product_name));
570 p = dmi_string(dmi,data[7]);
572 strlcpy(serial_number, p, sizeof(serial_number));
573 string_trim(serial_number, sizeof(serial_number));
579 static int __init dmi_table(u32 base, int len, int num, void (*fn)(DMIHeader*))
586 buf = ioremap(base, len);
593 * Stop when we see al the items the table claimed to have
594 * or we run off the end of the table (also happens)
596 while ((i<num) && ((data-buf) < len)) {
597 dmi = (DMIHeader *)data;
599 * Avoid misparsing crud if the length of the last
602 if ((data-buf+dmi->length) >= len) {
608 * Don't go off the end of the data if there is
609 * stuff looking like string fill past the end
611 while (((data-buf) < len) && (*data || data[1])) {
622 static int __init dmi_iterate(void (*decode)(DMIHeader *))
624 unsigned char buf[20];
625 void __iomem *p = ioremap(0xe0000, 0x20000), *q;
630 for (q = p; q < p + 0x20000; q += 16) {
631 memcpy_fromio(buf, q, 20);
632 if (memcmp(buf, "_DMI_", 5)==0) {
633 u16 num = buf[13]<<8 | buf[12];
634 u16 len = buf [7]<<8 | buf [6];
635 u32 base = buf[11]<<24 | buf[10]<<16 | buf[9]<<8 | buf[8];
637 printk(KERN_INFO "DMI %d.%d present.\n",
638 buf[14]>>4, buf[14]&0x0F);
639 printk(KERN_INFO "%d structures occupying %d bytes.\n",
640 buf[13]<<8 | buf[12],
641 buf [7]<<8 | buf[6]);
642 printk(KERN_INFO "DMI table at 0x%08X.\n",
643 buf[11]<<24 | buf[10]<<16 | buf[9]<<8 | buf[8]);
645 if (dmi_table(base, len, num, decode)==0) {
654 /* end of DMI code */
657 * Get DMI information.
659 static int __init i8k_dmi_probe(void)
663 if (dmi_iterate(dmi_decode) != 0) {
664 printk(KERN_INFO "i8k: unable to get DMI information\n");
668 if (strncmp(system_vendor,DELL_SIGNATURE,strlen(DELL_SIGNATURE)) != 0) {
669 printk(KERN_INFO "i8k: not running on a Dell system\n");
673 for (p=supported_models; ; p++) {
675 printk(KERN_INFO "i8k: unsupported model: %s\n", product_name);
678 if (strncmp(product_name,*p,strlen(*p)) == 0) {
687 * Probe for the presence of a supported laptop.
689 static int __init i8k_probe(void)
696 * Get DMI information
698 if (i8k_dmi_probe() != 0) {
699 printk(KERN_INFO "i8k: vendor=%s, model=%s, version=%s\n",
700 system_vendor, product_name, bios_version);
704 * Get SMM Dell signature
706 if (i8k_get_dell_signature() != 0) {
707 printk(KERN_INFO "i8k: unable to get SMM Dell signature\n");
713 * Get SMM BIOS version.
715 version = i8k_get_bios_version();
717 printk(KERN_INFO "i8k: unable to get SMM BIOS version\n");
720 buff[0] = (version >> 16) & 0xff;
721 buff[1] = (version >> 8) & 0xff;
722 buff[2] = (version) & 0xff;
725 * If DMI BIOS version is unknown use SMM BIOS version.
727 if (bios_version[0] == '?') {
728 strcpy(bios_version, buff);
731 * Check if the two versions match.
733 if (strncmp(buff,bios_version,sizeof(bios_version)) != 0) {
734 printk(KERN_INFO "i8k: BIOS version mismatch: %s != %s\n",
739 if (!smm_found && !force) {
749 int __init i8k_init(void)
751 struct proc_dir_entry *proc_i8k;
753 /* Are we running on an supported laptop? */
754 if (i8k_probe() != 0) {
758 /* Register the proc entry */
759 proc_i8k = create_proc_info_entry("i8k", 0, NULL, i8k_get_info);
763 proc_i8k->proc_fops = &i8k_fops;
764 proc_i8k->owner = THIS_MODULE;
767 "Dell laptop SMM driver v%s Massimo Dal Zotto (dz@debian.org)\n",
774 int init_module(void)
779 void cleanup_module(void)
781 /* Remove the proc entry */
782 remove_proc_entry("i8k", NULL);
784 printk(KERN_INFO "i8k: module unloaded\n");