[net-next-2.6.git] / drivers / char / i8k.c

/*
 * i8k.c -- Linux driver for accessing the SMM BIOS on Dell laptops.
 *	    See http://www.debian.org/~dz/i8k/ for more information
 *	    and for latest version of this driver.
 *
 * Copyright (C) 2001  Massimo Dal Zotto <dz@debian.org>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 */

#include <linux/module.h>
#include <linux/types.h>
#include <linux/init.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/dmi.h>
#include <linux/capability.h>
#include <linux/mutex.h>
#include <asm/uaccess.h>
#include <asm/io.h>

#include <linux/i8k.h>

#define I8K_VERSION		"1.14 21/02/2005"

#define I8K_SMM_FN_STATUS	0x0025
#define I8K_SMM_POWER_STATUS	0x0069
#define I8K_SMM_SET_FAN		0x01a3
#define I8K_SMM_GET_FAN		0x00a3
#define I8K_SMM_GET_SPEED	0x02a3
#define I8K_SMM_GET_TEMP	0x10a3
#define I8K_SMM_GET_DELL_SIG1	0xfea3
#define I8K_SMM_GET_DELL_SIG2	0xffa3
#define I8K_SMM_BIOS_VERSION	0x00a6

#define I8K_FAN_MULT		30
#define I8K_MAX_TEMP		127

#define I8K_FN_NONE		0x00
#define I8K_FN_UP		0x01
#define I8K_FN_DOWN		0x02
#define I8K_FN_MUTE		0x04
#define I8K_FN_MASK		0x07
#define I8K_FN_SHIFT		8

#define I8K_POWER_AC		0x05
#define I8K_POWER_BATTERY	0x01

#define I8K_TEMPERATURE_BUG	1

static DEFINE_MUTEX(i8k_mutex);
static char bios_version[4];

MODULE_AUTHOR("Massimo Dal Zotto (dz@debian.org)");
MODULE_DESCRIPTION("Driver for accessing SMM BIOS on Dell laptops");
MODULE_LICENSE("GPL");

static int force;
module_param(force, bool, 0);
MODULE_PARM_DESC(force, "Force loading without checking for supported models");

static int ignore_dmi;
module_param(ignore_dmi, bool, 0);
MODULE_PARM_DESC(ignore_dmi, "Continue probing hardware even if DMI data does not match");

static int restricted;
module_param(restricted, bool, 0);
MODULE_PARM_DESC(restricted, "Allow fan control if SYS_ADMIN capability set");

static int power_status;
module_param(power_status, bool, 0600);
MODULE_PARM_DESC(power_status, "Report power status in /proc/i8k");

static int fan_mult = I8K_FAN_MULT;
module_param(fan_mult, int, 0);
MODULE_PARM_DESC(fan_mult, "Factor to multiply fan speed with");

static int i8k_open_fs(struct inode *inode, struct file *file);
static long i8k_ioctl(struct file *, unsigned int, unsigned long);

static const struct file_operations i8k_fops = {
	.owner		= THIS_MODULE,
	.open		= i8k_open_fs,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
	.unlocked_ioctl	= i8k_ioctl,
};

struct smm_regs {
	unsigned int eax;
	unsigned int ebx __attribute__ ((packed));
	unsigned int ecx __attribute__ ((packed));
	unsigned int edx __attribute__ ((packed));
	unsigned int esi __attribute__ ((packed));
	unsigned int edi __attribute__ ((packed));
};

static inline const char *i8k_get_dmi_data(int field)
{
	const char *dmi_data = dmi_get_system_info(field);

	return dmi_data && *dmi_data ? dmi_data : "?";
}

/*
 * Call the System Management Mode BIOS. Code provided by Jonathan Buzzard.
 */
static int i8k_smm(struct smm_regs *regs)
{
	int rc;
	int eax = regs->eax;

#if defined(CONFIG_X86_64)
	asm("pushq %%rax\n\t"
		"movl 0(%%rax),%%edx\n\t"
		"pushq %%rdx\n\t"
		"movl 4(%%rax),%%ebx\n\t"
		"movl 8(%%rax),%%ecx\n\t"
		"movl 12(%%rax),%%edx\n\t"
		"movl 16(%%rax),%%esi\n\t"
		"movl 20(%%rax),%%edi\n\t"
		"popq %%rax\n\t"
		"out %%al,$0xb2\n\t"
		"out %%al,$0x84\n\t"
		"xchgq %%rax,(%%rsp)\n\t"
		"movl %%ebx,4(%%rax)\n\t"
		"movl %%ecx,8(%%rax)\n\t"
		"movl %%edx,12(%%rax)\n\t"
		"movl %%esi,16(%%rax)\n\t"
		"movl %%edi,20(%%rax)\n\t"
		"popq %%rdx\n\t"
		"movl %%edx,0(%%rax)\n\t"
		"lahf\n\t"
		"shrl $8,%%eax\n\t"
		"andl $1,%%eax\n"
		:"=a"(rc)
		:    "a"(regs)
		:    "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
#else
	asm("pushl %%eax\n\t"
	    "movl 0(%%eax),%%edx\n\t"
	    "push %%edx\n\t"
	    "movl 4(%%eax),%%ebx\n\t"
	    "movl 8(%%eax),%%ecx\n\t"
	    "movl 12(%%eax),%%edx\n\t"
	    "movl 16(%%eax),%%esi\n\t"
	    "movl 20(%%eax),%%edi\n\t"
	    "popl %%eax\n\t"
	    "out %%al,$0xb2\n\t"
	    "out %%al,$0x84\n\t"
	    "xchgl %%eax,(%%esp)\n\t"
	    "movl %%ebx,4(%%eax)\n\t"
	    "movl %%ecx,8(%%eax)\n\t"
	    "movl %%edx,12(%%eax)\n\t"
	    "movl %%esi,16(%%eax)\n\t"
	    "movl %%edi,20(%%eax)\n\t"
	    "popl %%edx\n\t"
	    "movl %%edx,0(%%eax)\n\t"
	    "lahf\n\t"
	    "shrl $8,%%eax\n\t"
	    "andl $1,%%eax\n":"=a"(rc)
	    :    "a"(regs)
	    :    "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
#endif
	if (rc != 0 || (regs->eax & 0xffff) == 0xffff || regs->eax == eax)
		return -EINVAL;

	return 0;
}

/*
 * Read the bios version. Return the version as an integer corresponding
 * to the ascii value, for example "A17" is returned as 0x00413137.
 */
static int i8k_get_bios_version(void)
{
	struct smm_regs regs = { .eax = I8K_SMM_BIOS_VERSION, };

	return i8k_smm(&regs) ? : regs.eax;
}

/*
 * Read the Fn key status.
 */
static int i8k_get_fn_status(void)
{
	struct smm_regs regs = { .eax = I8K_SMM_FN_STATUS, };
	int rc;

	if ((rc = i8k_smm(&regs)) < 0)
		return rc;

	switch ((regs.eax >> I8K_FN_SHIFT) & I8K_FN_MASK) {
	case I8K_FN_UP:
		return I8K_VOL_UP;
	case I8K_FN_DOWN:
		return I8K_VOL_DOWN;
	case I8K_FN_MUTE:
		return I8K_VOL_MUTE;
	default:
		return 0;
	}
}

/*
 * Read the power status.
 */
static int i8k_get_power_status(void)
{
	struct smm_regs regs = { .eax = I8K_SMM_POWER_STATUS, };
	int rc;

	if ((rc = i8k_smm(&regs)) < 0)
		return rc;

	return (regs.eax & 0xff) == I8K_POWER_AC ? I8K_AC : I8K_BATTERY;
}

/*
 * Read the fan status.
 */
static int i8k_get_fan_status(int fan)
{
	struct smm_regs regs = { .eax = I8K_SMM_GET_FAN, };

	regs.ebx = fan & 0xff;
	return i8k_smm(&regs) ? : regs.eax & 0xff;
}

/*
 * Read the fan speed in RPM.
 */
static int i8k_get_fan_speed(int fan)
{
	struct smm_regs regs = { .eax = I8K_SMM_GET_SPEED, };

	regs.ebx = fan & 0xff;
	return i8k_smm(&regs) ? : (regs.eax & 0xffff) * fan_mult;
}

/*
 * Set the fan speed (off, low, high). Returns the new fan status.
 */
static int i8k_set_fan(int fan, int speed)
{
	struct smm_regs regs = { .eax = I8K_SMM_SET_FAN, };

	speed = (speed < 0) ? 0 : ((speed > I8K_FAN_MAX) ? I8K_FAN_MAX : speed);
	regs.ebx = (fan & 0xff) | (speed << 8);

	return i8k_smm(&regs) ? : i8k_get_fan_status(fan);
}

/*
 * Read the cpu temperature.
 */
static int i8k_get_temp(int sensor)
{
	struct smm_regs regs = { .eax = I8K_SMM_GET_TEMP, };
	int rc;
	int temp;

#ifdef I8K_TEMPERATURE_BUG
	static int prev;
#endif
	regs.ebx = sensor & 0xff;
	if ((rc = i8k_smm(&regs)) < 0)
		return rc;

	temp = regs.eax & 0xff;

#ifdef I8K_TEMPERATURE_BUG
	/*
	 * Sometimes the temperature sensor returns 0x99, which is out of range.
	 * In this case we return (once) the previous cached value. For example:
	 # 1003655137 00000058 00005a4b
	 # 1003655138 00000099 00003a80 <--- 0x99 = 153 degrees
	 # 1003655139 00000054 00005c52
	 */
	if (temp > I8K_MAX_TEMP) {
		temp = prev;
		prev = I8K_MAX_TEMP;
	} else {
		prev = temp;
	}
#endif

	return temp;
}

static int i8k_get_dell_signature(int req_fn)
{
	struct smm_regs regs = { .eax = req_fn, };
	int rc;

	if ((rc = i8k_smm(&regs)) < 0)
		return rc;

	return regs.eax == 1145651527 && regs.edx == 1145392204 ? 0 : -1;
}

static int
i8k_ioctl_unlocked(struct file *fp, unsigned int cmd, unsigned long arg)
{
	int val = 0;
	int speed;
	unsigned char buff[16];
	int __user *argp = (int __user *)arg;

	if (!argp)
		return -EINVAL;

	switch (cmd) {
	case I8K_BIOS_VERSION:
		val = i8k_get_bios_version();
		break;

	case I8K_MACHINE_ID:
		memset(buff, 0, 16);
		strlcpy(buff, i8k_get_dmi_data(DMI_PRODUCT_SERIAL), sizeof(buff));
		break;

	case I8K_FN_STATUS:
		val = i8k_get_fn_status();
		break;

	case I8K_POWER_STATUS:
		val = i8k_get_power_status();
		break;

	case I8K_GET_TEMP:
		val = i8k_get_temp(0);
		break;

	case I8K_GET_SPEED:
		if (copy_from_user(&val, argp, sizeof(int)))
			return -EFAULT;

		val = i8k_get_fan_speed(val);
		break;

	case I8K_GET_FAN:
		if (copy_from_user(&val, argp, sizeof(int)))
			return -EFAULT;

		val = i8k_get_fan_status(val);
		break;

	case I8K_SET_FAN:
		if (restricted && !capable(CAP_SYS_ADMIN))
			return -EPERM;

		if (copy_from_user(&val, argp, sizeof(int)))
			return -EFAULT;

		if (copy_from_user(&speed, argp + 1, sizeof(int)))
			return -EFAULT;

		val = i8k_set_fan(val, speed);
		break;

	default:
		return -EINVAL;
	}

	if (val < 0)
		return val;

	switch (cmd) {
	case I8K_BIOS_VERSION:
		if (copy_to_user(argp, &val, 4))
			return -EFAULT;

		break;
	case I8K_MACHINE_ID:
		if (copy_to_user(argp, buff, 16))
			return -EFAULT;

		break;
	default:
		if (copy_to_user(argp, &val, sizeof(int)))
			return -EFAULT;

		break;
	}

	return 0;
}

static long i8k_ioctl(struct file *fp, unsigned int cmd, unsigned long arg)
{
	long ret;

	mutex_lock(&i8k_mutex);
	ret = i8k_ioctl_unlocked(fp, cmd, arg);
	mutex_unlock(&i8k_mutex);

	return ret;
}

/*
 * Print the information for /proc/i8k.
 */
static int i8k_proc_show(struct seq_file *seq, void *offset)
{
	int fn_key, cpu_temp, ac_power;
	int left_fan, right_fan, left_speed, right_speed;

	cpu_temp	= i8k_get_temp(0);			/* 11100 µs */
	left_fan	= i8k_get_fan_status(I8K_FAN_LEFT);	/*   580 µs */
	right_fan	= i8k_get_fan_status(I8K_FAN_RIGHT);	/*   580 µs */
	left_speed	= i8k_get_fan_speed(I8K_FAN_LEFT);	/*   580 µs */
	right_speed	= i8k_get_fan_speed(I8K_FAN_RIGHT);	/*   580 µs */
	fn_key		= i8k_get_fn_status();			/*   750 µs */
	if (power_status)
		ac_power = i8k_get_power_status();		/* 14700 µs */
	else
		ac_power = -1;

	/*
	 * Info:
	 *
	 * 1)  Format version (this will change if format changes)
	 * 2)  BIOS version
	 * 3)  BIOS machine ID
	 * 4)  Cpu temperature
	 * 5)  Left fan status
	 * 6)  Right fan status
	 * 7)  Left fan speed
	 * 8)  Right fan speed
	 * 9)  AC power
	 * 10) Fn Key status
	 */
	return seq_printf(seq, "%s %s %s %d %d %d %d %d %d %d\n",
			  I8K_PROC_FMT,
			  bios_version,
			  i8k_get_dmi_data(DMI_PRODUCT_SERIAL),
			  cpu_temp,
			  left_fan, right_fan, left_speed, right_speed,
			  ac_power, fn_key);
}

static int i8k_open_fs(struct inode *inode, struct file *file)
{
	return single_open(file, i8k_proc_show, NULL);
}

static struct dmi_system_id __initdata i8k_dmi_table[] = {
	{
		.ident = "Dell Inspiron",
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer"),
			DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron"),
		},
	},
	{
		.ident = "Dell Latitude",
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer"),
			DMI_MATCH(DMI_PRODUCT_NAME, "Latitude"),
		},
	},
	{
		.ident = "Dell Inspiron 2",
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
			DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron"),
		},
	},
	{
		.ident = "Dell Latitude 2",
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
			DMI_MATCH(DMI_PRODUCT_NAME, "Latitude"),
		},
	},
	{	/* UK Inspiron 6400  */
		.ident = "Dell Inspiron 3",
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
			DMI_MATCH(DMI_PRODUCT_NAME, "MM061"),
		},
	},
	{
		.ident = "Dell Inspiron 3",
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
			DMI_MATCH(DMI_PRODUCT_NAME, "MP061"),
		},
	},
	{
		.ident = "Dell Precision",
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
			DMI_MATCH(DMI_PRODUCT_NAME, "Precision"),
		},
	},
	{
		.ident = "Dell Vostro",
		.matches = {
			DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
			DMI_MATCH(DMI_PRODUCT_NAME, "Vostro"),
		},
	},
        { }
};

/*
 * Probe for the presence of a supported laptop.
 */
static int __init i8k_probe(void)
{
	char buff[4];
	int version;

	/*
	 * Get DMI information
	 */
	if (!dmi_check_system(i8k_dmi_table)) {
		if (!ignore_dmi && !force)
			return -ENODEV;

		printk(KERN_INFO "i8k: not running on a supported Dell system.\n");
		printk(KERN_INFO "i8k: vendor=%s, model=%s, version=%s\n",
			i8k_get_dmi_data(DMI_SYS_VENDOR),
			i8k_get_dmi_data(DMI_PRODUCT_NAME),
			i8k_get_dmi_data(DMI_BIOS_VERSION));
	}

	strlcpy(bios_version, i8k_get_dmi_data(DMI_BIOS_VERSION), sizeof(bios_version));

	/*
	 * Get SMM Dell signature
	 */
	if (i8k_get_dell_signature(I8K_SMM_GET_DELL_SIG1) &&
	    i8k_get_dell_signature(I8K_SMM_GET_DELL_SIG2)) {
		printk(KERN_ERR "i8k: unable to get SMM Dell signature\n");
		if (!force)
			return -ENODEV;
	}

	/*
	 * Get SMM BIOS version.
	 */
	version = i8k_get_bios_version();
	if (version <= 0) {
		printk(KERN_WARNING "i8k: unable to get SMM BIOS version\n");
	} else {
		buff[0] = (version >> 16) & 0xff;
		buff[1] = (version >> 8) & 0xff;
		buff[2] = (version) & 0xff;
		buff[3] = '\0';
		/*
		 * If DMI BIOS version is unknown use SMM BIOS version.
		 */
		if (!dmi_get_system_info(DMI_BIOS_VERSION))
			strlcpy(bios_version, buff, sizeof(bios_version));

		/*
		 * Check if the two versions match.
		 */
		if (strncmp(buff, bios_version, sizeof(bios_version)) != 0)
			printk(KERN_WARNING "i8k: BIOS version mismatch: %s != %s\n",
				buff, bios_version);
	}

	return 0;
}

static int __init i8k_init(void)
{
	struct proc_dir_entry *proc_i8k;

	/* Are we running on an supported laptop? */
	if (i8k_probe())
		return -ENODEV;

	/* Register the proc entry */
	proc_i8k = proc_create("i8k", 0, NULL, &i8k_fops);
	if (!proc_i8k)
		return -ENOENT;

	printk(KERN_INFO
	       "Dell laptop SMM driver v%s Massimo Dal Zotto (dz@debian.org)\n",
	       I8K_VERSION);

	return 0;
}

static void __exit i8k_exit(void)
{
	remove_proc_entry("i8k", NULL);
}

module_init(i8k_init);
module_exit(i8k_exit);
Commit	Line	Data
1da177e4 LT	1	/*
	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.
	5	*
	6	* Copyright (C) 2001 Massimo Dal Zotto <dz@debian.org>
	7	*
	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
	11	* later version.
	12	*
	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.
	17	*/
	18
	19	#include <linux/module.h>
	20	#include <linux/types.h>
	21	#include <linux/init.h>
	22	#include <linux/proc_fs.h>
352f8f8b	23	#include <linux/seq_file.h>
e70c9d5e	24	#include <linux/dmi.h>
7e80d0d0	25	#include <linux/capability.h>
613655fa	26	#include <linux/mutex.h>
1da177e4 LT	27	#include <asm/uaccess.h>
	28	#include <asm/io.h>
	29
	30	#include <linux/i8k.h>
	31
352f8f8b	32	#define I8K_VERSION "1.14 21/02/2005"
1da177e4 LT	33
	34	#define I8K_SMM_FN_STATUS 0x0025
	35	#define I8K_SMM_POWER_STATUS 0x0069
	36	#define I8K_SMM_SET_FAN 0x01a3
	37	#define I8K_SMM_GET_FAN 0x00a3
	38	#define I8K_SMM_GET_SPEED 0x02a3
	39	#define I8K_SMM_GET_TEMP 0x10a3
7e0fa31d DT	40	#define I8K_SMM_GET_DELL_SIG1 0xfea3
7e0fa31d DT	41	#define I8K_SMM_GET_DELL_SIG2 0xffa3
1da177e4 LT	42	#define I8K_SMM_BIOS_VERSION 0x00a6
	43
	44	#define I8K_FAN_MULT 30
	45	#define I8K_MAX_TEMP 127
	46
	47	#define I8K_FN_NONE 0x00
	48	#define I8K_FN_UP 0x01
	49	#define I8K_FN_DOWN 0x02
	50	#define I8K_FN_MUTE 0x04
	51	#define I8K_FN_MASK 0x07
	52	#define I8K_FN_SHIFT 8
	53
	54	#define I8K_POWER_AC 0x05
	55	#define I8K_POWER_BATTERY 0x01
	56
	57	#define I8K_TEMPERATURE_BUG 1
	58
613655fa	59	static DEFINE_MUTEX(i8k_mutex);
e70c9d5e	60	static char bios_version[4];
1da177e4 LT	61
	62	MODULE_AUTHOR("Massimo Dal Zotto (dz@debian.org)");
	63	MODULE_DESCRIPTION("Driver for accessing SMM BIOS on Dell laptops");
	64	MODULE_LICENSE("GPL");
	65
	66	static int force;
	67	module_param(force, bool, 0);
	68	MODULE_PARM_DESC(force, "Force loading without checking for supported models");
	69
e70c9d5e DT	70	static int ignore_dmi;
	71	module_param(ignore_dmi, bool, 0);
	72	MODULE_PARM_DESC(ignore_dmi, "Continue probing hardware even if DMI data does not match");
	73
1da177e4 LT	74	static int restricted;
	75	module_param(restricted, bool, 0);
	76	MODULE_PARM_DESC(restricted, "Allow fan control if SYS_ADMIN capability set");
	77
	78	static int power_status;
	79	module_param(power_status, bool, 0600);
	80	MODULE_PARM_DESC(power_status, "Report power status in /proc/i8k");
	81
4ed99a27 JE	82	static int fan_mult = I8K_FAN_MULT;
	83	module_param(fan_mult, int, 0);
	84	MODULE_PARM_DESC(fan_mult, "Factor to multiply fan speed with");
	85
352f8f8b	86	static int i8k_open_fs(struct inode inode, struct file file);
d79b6f4d	87	static long i8k_ioctl(struct file *, unsigned int, unsigned long);
1da177e4	88
62322d25	89	static const struct file_operations i8k_fops = {
1b502217	90	.owner = THIS_MODULE,
352f8f8b DT	91	.open = i8k_open_fs,
	92	.read = seq_read,
	93	.llseek = seq_lseek,
	94	.release = single_release,
d79b6f4d	95	.unlocked_ioctl = i8k_ioctl,
1da177e4 LT	96	};
1da177e4 LT	97
8378b924	98	struct smm_regs {
dec63ec3 DT	99	unsigned int eax;
	100	unsigned int ebx __attribute__ ((packed));
	101	unsigned int ecx __attribute__ ((packed));
	102	unsigned int edx __attribute__ ((packed));
	103	unsigned int esi __attribute__ ((packed));
	104	unsigned int edi __attribute__ ((packed));
8378b924	105	};
1da177e4	106
1855256c	107	static inline const char *i8k_get_dmi_data(int field)
e70c9d5e	108	{
1855256c	109	const char *dmi_data = dmi_get_system_info(field);
4f005551 DT	110
4f005551 DT	111	return dmi_data && *dmi_data ? dmi_data : "?";
e70c9d5e	112	}
1da177e4 LT	113
	114	/*
	115	* Call the System Management Mode BIOS. Code provided by Jonathan Buzzard.
	116	*/
8378b924	117	static int i8k_smm(struct smm_regs *regs)
1da177e4	118	{
dec63ec3 DT	119	int rc;
	120	int eax = regs->eax;
	121
fe04f22f BS	122	#if defined(CONFIG_X86_64)
	123	asm("pushq %%rax\n\t"
	124	"movl 0(%%rax),%%edx\n\t"
	125	"pushq %%rdx\n\t"
	126	"movl 4(%%rax),%%ebx\n\t"
	127	"movl 8(%%rax),%%ecx\n\t"
	128	"movl 12(%%rax),%%edx\n\t"
	129	"movl 16(%%rax),%%esi\n\t"
	130	"movl 20(%%rax),%%edi\n\t"
	131	"popq %%rax\n\t"
	132	"out %%al,$0xb2\n\t"
	133	"out %%al,$0x84\n\t"
	134	"xchgq %%rax,(%%rsp)\n\t"
	135	"movl %%ebx,4(%%rax)\n\t"
	136	"movl %%ecx,8(%%rax)\n\t"
	137	"movl %%edx,12(%%rax)\n\t"
	138	"movl %%esi,16(%%rax)\n\t"
	139	"movl %%edi,20(%%rax)\n\t"
	140	"popq %%rdx\n\t"
	141	"movl %%edx,0(%%rax)\n\t"
	142	"lahf\n\t"
	143	"shrl $8,%%eax\n\t"
	144	"andl $1,%%eax\n"
	145	:"=a"(rc)
	146	: "a"(regs)
	147	: "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
	148	#else
dec63ec3 DT	149	asm("pushl %%eax\n\t"
	150	"movl 0(%%eax),%%edx\n\t"
	151	"push %%edx\n\t"
	152	"movl 4(%%eax),%%ebx\n\t"
	153	"movl 8(%%eax),%%ecx\n\t"
	154	"movl 12(%%eax),%%edx\n\t"
	155	"movl 16(%%eax),%%esi\n\t"
	156	"movl 20(%%eax),%%edi\n\t"
	157	"popl %%eax\n\t"
	158	"out %%al,$0xb2\n\t"
	159	"out %%al,$0x84\n\t"
	160	"xchgl %%eax,(%%esp)\n\t"
	161	"movl %%ebx,4(%%eax)\n\t"
	162	"movl %%ecx,8(%%eax)\n\t"
	163	"movl %%edx,12(%%eax)\n\t"
	164	"movl %%esi,16(%%eax)\n\t"
	165	"movl %%edi,20(%%eax)\n\t"
	166	"popl %%edx\n\t"
	167	"movl %%edx,0(%%eax)\n\t"
	168	"lahf\n\t"
	169	"shrl $8,%%eax\n\t"
	170	"andl $1,%%eax\n":"=a"(rc)
	171	: "a"(regs)
	172	: "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
fe04f22f	173	#endif
8378b924	174	if (rc != 0 \|\| (regs->eax & 0xffff) == 0xffff \|\| regs->eax == eax)
dec63ec3	175	return -EINVAL;
dec63ec3 DT	176
dec63ec3 DT	177	return 0;
1da177e4 LT	178	}
	179
	180	/*
	181	* Read the bios version. Return the version as an integer corresponding
	182	* to the ascii value, for example "A17" is returned as 0x00413137.
	183	*/
	184	static int i8k_get_bios_version(void)
	185	{
8378b924	186	struct smm_regs regs = { .eax = I8K_SMM_BIOS_VERSION, };
1da177e4	187
8378b924	188	return i8k_smm(&regs) ? : regs.eax;
1da177e4 LT	189	}
1da177e4 LT	190
1da177e4 LT	191	/*
	192	* Read the Fn key status.
	193	*/
	194	static int i8k_get_fn_status(void)
	195	{
8378b924	196	struct smm_regs regs = { .eax = I8K_SMM_FN_STATUS, };
dec63ec3 DT	197	int rc;
dec63ec3 DT	198
8378b924	199	if ((rc = i8k_smm(&regs)) < 0)
dec63ec3	200	return rc;
dec63ec3 DT	201
	202	switch ((regs.eax >> I8K_FN_SHIFT) & I8K_FN_MASK) {
	203	case I8K_FN_UP:
	204	return I8K_VOL_UP;
	205	case I8K_FN_DOWN:
	206	return I8K_VOL_DOWN;
	207	case I8K_FN_MUTE:
	208	return I8K_VOL_MUTE;
	209	default:
	210	return 0;
	211	}
1da177e4 LT	212	}
	213
	214	/*
	215	* Read the power status.
	216	*/
	217	static int i8k_get_power_status(void)
	218	{
8378b924	219	struct smm_regs regs = { .eax = I8K_SMM_POWER_STATUS, };
dec63ec3 DT	220	int rc;
dec63ec3 DT	221
8378b924	222	if ((rc = i8k_smm(&regs)) < 0)
dec63ec3	223	return rc;
dec63ec3	224
8378b924	225	return (regs.eax & 0xff) == I8K_POWER_AC ? I8K_AC : I8K_BATTERY;
1da177e4 LT	226	}
	227
	228	/*
	229	* Read the fan status.
	230	*/
	231	static int i8k_get_fan_status(int fan)
	232	{
8378b924	233	struct smm_regs regs = { .eax = I8K_SMM_GET_FAN, };
1da177e4	234
dec63ec3	235	regs.ebx = fan & 0xff;
8378b924	236	return i8k_smm(&regs) ? : regs.eax & 0xff;
1da177e4 LT	237	}
	238
	239	/*
	240	* Read the fan speed in RPM.
	241	*/
	242	static int i8k_get_fan_speed(int fan)
	243	{
8378b924	244	struct smm_regs regs = { .eax = I8K_SMM_GET_SPEED, };
1da177e4	245
dec63ec3	246	regs.ebx = fan & 0xff;
4ed99a27	247	return i8k_smm(&regs) ? : (regs.eax & 0xffff) * fan_mult;
1da177e4 LT	248	}
	249
	250	/*
	251	* Set the fan speed (off, low, high). Returns the new fan status.
	252	*/
	253	static int i8k_set_fan(int fan, int speed)
	254	{
8378b924	255	struct smm_regs regs = { .eax = I8K_SMM_SET_FAN, };
1da177e4	256
dec63ec3	257	speed = (speed < 0) ? 0 : ((speed > I8K_FAN_MAX) ? I8K_FAN_MAX : speed);
dec63ec3	258	regs.ebx = (fan & 0xff) \| (speed << 8);
1da177e4	259
8378b924	260	return i8k_smm(&regs) ? : i8k_get_fan_status(fan);
1da177e4 LT	261	}
	262
	263	/*
	264	* Read the cpu temperature.
	265	*/
7e0fa31d	266	static int i8k_get_temp(int sensor)
1da177e4	267	{
8378b924	268	struct smm_regs regs = { .eax = I8K_SMM_GET_TEMP, };
dec63ec3 DT	269	int rc;
dec63ec3 DT	270	int temp;
1da177e4 LT	271
1da177e4 LT	272	#ifdef I8K_TEMPERATURE_BUG
8378b924	273	static int prev;
1da177e4	274	#endif
7e0fa31d	275	regs.ebx = sensor & 0xff;
8378b924	276	if ((rc = i8k_smm(&regs)) < 0)
dec63ec3	277	return rc;
8378b924	278
dec63ec3	279	temp = regs.eax & 0xff;
1da177e4 LT	280
1da177e4 LT	281	#ifdef I8K_TEMPERATURE_BUG
dec63ec3 DT	282	/*
	283	* Sometimes the temperature sensor returns 0x99, which is out of range.
	284	* In this case we return (once) the previous cached value. For example:
	285	# 1003655137 00000058 00005a4b
	286	# 1003655138 00000099 00003a80 <--- 0x99 = 153 degrees
	287	# 1003655139 00000054 00005c52
	288	*/
	289	if (temp > I8K_MAX_TEMP) {
	290	temp = prev;
	291	prev = I8K_MAX_TEMP;
	292	} else {
	293	prev = temp;
	294	}
1da177e4 LT	295	#endif
1da177e4 LT	296
dec63ec3	297	return temp;
1da177e4 LT	298	}
1da177e4 LT	299
7e0fa31d	300	static int i8k_get_dell_signature(int req_fn)
1da177e4	301	{
7e0fa31d	302	struct smm_regs regs = { .eax = req_fn, };
dec63ec3	303	int rc;
1da177e4	304
8378b924	305	if ((rc = i8k_smm(&regs)) < 0)
dec63ec3	306	return rc;
1da177e4	307
8378b924	308	return regs.eax == 1145651527 && regs.edx == 1145392204 ? 0 : -1;
1da177e4 LT	309	}
1da177e4 LT	310
d79b6f4d FW	311	static int
d79b6f4d FW	312	i8k_ioctl_unlocked(struct file *fp, unsigned int cmd, unsigned long arg)
1da177e4	313	{
e70c9d5e	314	int val = 0;
dec63ec3 DT	315	int speed;
	316	unsigned char buff[16];
	317	int __user argp = (int __user )arg;
	318
	319	if (!argp)
	320	return -EINVAL;
	321
	322	switch (cmd) {
	323	case I8K_BIOS_VERSION:
	324	val = i8k_get_bios_version();
	325	break;
	326
	327	case I8K_MACHINE_ID:
	328	memset(buff, 0, 16);
e70c9d5e	329	strlcpy(buff, i8k_get_dmi_data(DMI_PRODUCT_SERIAL), sizeof(buff));
dec63ec3 DT	330	break;
	331
	332	case I8K_FN_STATUS:
	333	val = i8k_get_fn_status();
	334	break;
	335
	336	case I8K_POWER_STATUS:
	337	val = i8k_get_power_status();
	338	break;
	339
	340	case I8K_GET_TEMP:
7e0fa31d	341	val = i8k_get_temp(0);
dec63ec3 DT	342	break;
	343
	344	case I8K_GET_SPEED:
8378b924	345	if (copy_from_user(&val, argp, sizeof(int)))
dec63ec3	346	return -EFAULT;
8378b924	347
dec63ec3 DT	348	val = i8k_get_fan_speed(val);
dec63ec3 DT	349	break;
1da177e4	350
dec63ec3	351	case I8K_GET_FAN:
8378b924	352	if (copy_from_user(&val, argp, sizeof(int)))
dec63ec3	353	return -EFAULT;
8378b924	354
dec63ec3 DT	355	val = i8k_get_fan_status(val);
dec63ec3 DT	356	break;
1da177e4	357
dec63ec3	358	case I8K_SET_FAN:
8378b924	359	if (restricted && !capable(CAP_SYS_ADMIN))
dec63ec3	360	return -EPERM;
8378b924 DT	361
8378b924 DT	362	if (copy_from_user(&val, argp, sizeof(int)))
dec63ec3	363	return -EFAULT;
8378b924 DT	364
8378b924 DT	365	if (copy_from_user(&speed, argp + 1, sizeof(int)))
dec63ec3	366	return -EFAULT;
8378b924	367
dec63ec3 DT	368	val = i8k_set_fan(val, speed);
dec63ec3 DT	369	break;
1da177e4	370
dec63ec3 DT	371	default:
dec63ec3 DT	372	return -EINVAL;
1da177e4	373	}
1da177e4	374
8378b924	375	if (val < 0)
dec63ec3	376	return val;
1da177e4	377
dec63ec3 DT	378	switch (cmd) {
dec63ec3 DT	379	case I8K_BIOS_VERSION:
8378b924	380	if (copy_to_user(argp, &val, 4))
dec63ec3	381	return -EFAULT;
8378b924	382
dec63ec3 DT	383	break;
dec63ec3 DT	384	case I8K_MACHINE_ID:
8378b924	385	if (copy_to_user(argp, buff, 16))
dec63ec3	386	return -EFAULT;
8378b924	387
dec63ec3 DT	388	break;
dec63ec3 DT	389	default:
8378b924	390	if (copy_to_user(argp, &val, sizeof(int)))
dec63ec3	391	return -EFAULT;
8378b924	392
dec63ec3	393	break;
1da177e4	394	}
1da177e4	395
dec63ec3	396	return 0;
1da177e4 LT	397	}
1da177e4 LT	398
d79b6f4d FW	399	static long i8k_ioctl(struct file *fp, unsigned int cmd, unsigned long arg)
	400	{
	401	long ret;
	402
613655fa	403	mutex_lock(&i8k_mutex);
d79b6f4d	404	ret = i8k_ioctl_unlocked(fp, cmd, arg);
613655fa	405	mutex_unlock(&i8k_mutex);
d79b6f4d FW	406
	407	return ret;
	408	}
	409
1da177e4 LT	410	/*
	411	* Print the information for /proc/i8k.
	412	*/
352f8f8b	413	static int i8k_proc_show(struct seq_file seq, void offset)
1da177e4	414	{
352f8f8b	415	int fn_key, cpu_temp, ac_power;
dec63ec3 DT	416	int left_fan, right_fan, left_speed, right_speed;
dec63ec3 DT	417
96de0e25 JE	418	cpu_temp = i8k_get_temp(0); /* 11100 µs */
	419	left_fan = i8k_get_fan_status(I8K_FAN_LEFT); /* 580 µs */
	420	right_fan = i8k_get_fan_status(I8K_FAN_RIGHT); /* 580 µs */
	421	left_speed = i8k_get_fan_speed(I8K_FAN_LEFT); /* 580 µs */
	422	right_speed = i8k_get_fan_speed(I8K_FAN_RIGHT); /* 580 µs */
	423	fn_key = i8k_get_fn_status(); /* 750 µs */
8378b924	424	if (power_status)
96de0e25	425	ac_power = i8k_get_power_status(); /* 14700 µs */
8378b924	426	else
dec63ec3	427	ac_power = -1;
dec63ec3 DT	428
	429	/*
	430	* Info:
	431	*
	432	* 1) Format version (this will change if format changes)
	433	* 2) BIOS version
	434	* 3) BIOS machine ID
	435	* 4) Cpu temperature
	436	* 5) Left fan status
	437	* 6) Right fan status
	438	* 7) Left fan speed
	439	* 8) Right fan speed
	440	* 9) AC power
	441	* 10) Fn Key status
	442	*/
352f8f8b DT	443	return seq_printf(seq, "%s %s %s %d %d %d %d %d %d %d\n",
	444	I8K_PROC_FMT,
	445	bios_version,
4f005551	446	i8k_get_dmi_data(DMI_PRODUCT_SERIAL),
352f8f8b DT	447	cpu_temp,
	448	left_fan, right_fan, left_speed, right_speed,
	449	ac_power, fn_key);
1da177e4 LT	450	}
1da177e4 LT	451
352f8f8b	452	static int i8k_open_fs(struct inode inode, struct file file)
1da177e4	453	{
352f8f8b	454	return single_open(file, i8k_proc_show, NULL);
1da177e4 LT	455	}
1da177e4 LT	456
e70c9d5e DT	457	static struct dmi_system_id __initdata i8k_dmi_table[] = {
	458	{
	459	.ident = "Dell Inspiron",
	460	.matches = {
	461	DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer"),
	462	DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron"),
	463	},
	464	},
	465	{
	466	.ident = "Dell Latitude",
	467	.matches = {
	468	DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer"),
	469	DMI_MATCH(DMI_PRODUCT_NAME, "Latitude"),
	470	},
	471	},
7e0fa31d DT	472	{
	473	.ident = "Dell Inspiron 2",
	474	.matches = {
	475	DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
	476	DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron"),
	477	},
	478	},
	479	{
	480	.ident = "Dell Latitude 2",
	481	.matches = {
	482	DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
	483	DMI_MATCH(DMI_PRODUCT_NAME, "Latitude"),
	484	},
	485	},
a9000d03 NW	486	{ /* UK Inspiron 6400 */
	487	.ident = "Dell Inspiron 3",
	488	.matches = {
	489	DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
	490	DMI_MATCH(DMI_PRODUCT_NAME, "MM061"),
	491	},
	492	},
48103c52 FS	493	{
	494	.ident = "Dell Inspiron 3",
	495	.matches = {
	496	DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
	497	DMI_MATCH(DMI_PRODUCT_NAME, "MP061"),
	498	},
	499	},
7ab21a86 AS	500	{
	501	.ident = "Dell Precision",
	502	.matches = {
	503	DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
	504	DMI_MATCH(DMI_PRODUCT_NAME, "Precision"),
	505	},
	506	},
bef2a508 FH	507	{
	508	.ident = "Dell Vostro",
	509	.matches = {
	510	DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
	511	DMI_MATCH(DMI_PRODUCT_NAME, "Vostro"),
	512	},
	513	},
	514	{ }
e70c9d5e	515	};
1da177e4 LT	516
	517	/*
	518	* Probe for the presence of a supported laptop.
	519	*/
	520	static int __init i8k_probe(void)
	521	{
dec63ec3 DT	522	char buff[4];
dec63ec3 DT	523	int version;
dec63ec3	524
1da177e4	525	/*
dec63ec3	526	* Get DMI information
1da177e4	527	*/
e70c9d5e DT	528	if (!dmi_check_system(i8k_dmi_table)) {
	529	if (!ignore_dmi && !force)
	530	return -ENODEV;
	531
	532	printk(KERN_INFO "i8k: not running on a supported Dell system.\n");
dec63ec3	533	printk(KERN_INFO "i8k: vendor=%s, model=%s, version=%s\n",
e70c9d5e DT	534	i8k_get_dmi_data(DMI_SYS_VENDOR),
	535	i8k_get_dmi_data(DMI_PRODUCT_NAME),
	536	i8k_get_dmi_data(DMI_BIOS_VERSION));
1da177e4	537	}
dec63ec3	538
e70c9d5e DT	539	strlcpy(bios_version, i8k_get_dmi_data(DMI_BIOS_VERSION), sizeof(bios_version));
e70c9d5e DT	540
1da177e4	541	/*
dec63ec3	542	* Get SMM Dell signature
1da177e4	543	*/
7e0fa31d DT	544	if (i8k_get_dell_signature(I8K_SMM_GET_DELL_SIG1) &&
7e0fa31d DT	545	i8k_get_dell_signature(I8K_SMM_GET_DELL_SIG2)) {
e70c9d5e DT	546	printk(KERN_ERR "i8k: unable to get SMM Dell signature\n");
	547	if (!force)
	548	return -ENODEV;
1da177e4	549	}
1da177e4	550
dec63ec3 DT	551	/*
	552	* Get SMM BIOS version.
	553	*/
	554	version = i8k_get_bios_version();
	555	if (version <= 0) {
e70c9d5e	556	printk(KERN_WARNING "i8k: unable to get SMM BIOS version\n");
dec63ec3	557	} else {
dec63ec3 DT	558	buff[0] = (version >> 16) & 0xff;
	559	buff[1] = (version >> 8) & 0xff;
	560	buff[2] = (version) & 0xff;
	561	buff[3] = '\0';
	562	/*
	563	* If DMI BIOS version is unknown use SMM BIOS version.
	564	*/
e70c9d5e DT	565	if (!dmi_get_system_info(DMI_BIOS_VERSION))
	566	strlcpy(bios_version, buff, sizeof(bios_version));
	567
dec63ec3 DT	568	/*
	569	* Check if the two versions match.
	570	*/
e70c9d5e DT	571	if (strncmp(buff, bios_version, sizeof(bios_version)) != 0)
	572	printk(KERN_WARNING "i8k: BIOS version mismatch: %s != %s\n",
	573	buff, bios_version);
dec63ec3	574	}
1da177e4	575
dec63ec3	576	return 0;
1da177e4 LT	577	}
1da177e4 LT	578
8378b924	579	static int __init i8k_init(void)
1da177e4	580	{
dec63ec3 DT	581	struct proc_dir_entry *proc_i8k;
	582
	583	/* Are we running on an supported laptop? */
e70c9d5e	584	if (i8k_probe())
dec63ec3	585	return -ENODEV;
dec63ec3 DT	586
dec63ec3 DT	587	/* Register the proc entry */
1b502217	588	proc_i8k = proc_create("i8k", 0, NULL, &i8k_fops);
352f8f8b	589	if (!proc_i8k)
dec63ec3	590	return -ENOENT;
352f8f8b	591
dec63ec3 DT	592	printk(KERN_INFO
	593	"Dell laptop SMM driver v%s Massimo Dal Zotto (dz@debian.org)\n",
	594	I8K_VERSION);
	595
	596	return 0;
1da177e4 LT	597	}
1da177e4 LT	598
8378b924	599	static void __exit i8k_exit(void)
1da177e4	600	{
dec63ec3	601	remove_proc_entry("i8k", NULL);
1da177e4	602	}
1da177e4	603
8378b924 DT	604	module_init(i8k_init);
8378b924 DT	605	module_exit(i8k_exit);