[linux-2.6-block.git] / drivers / char / toshiba.c

/* toshiba.c -- Linux driver for accessing the SMM on Toshiba laptops
 *
 * Copyright (c) 1996-2001  Jonathan A. Buzzard (jonathan@buzzard.org.uk)
 *
 * Valuable assistance and patches from:
 *     Tom May <tom@you-bastards.com>
 *     Rob Napier <rnapier@employees.org>
 *
 * Fn status port numbers for machine ID's courtesy of
 *     0xfc02: Scott Eisert <scott.e@sky-eye.com>
 *     0xfc04: Steve VanDevender <stevev@efn.org>
 *     0xfc08: Garth Berry <garth@itsbruce.net>
 *     0xfc0a: Egbert Eich <eich@xfree86.org>
 *     0xfc10: Andrew Lofthouse <Andrew.Lofthouse@robins.af.mil>
 *     0xfc11: Spencer Olson <solson@novell.com>
 *     0xfc13: Claudius Frankewitz <kryp@gmx.de>
 *     0xfc15: Tom May <tom@you-bastards.com>
 *     0xfc17: Dave Konrad <konrad@xenia.it>
 *     0xfc1a: George Betzos <betzos@engr.colostate.edu>
 *     0xfc1b: Munemasa Wada <munemasa@jnovel.co.jp>
 *     0xfc1d: Arthur Liu <armie@slap.mine.nu>
 *     0xfc5a: Jacques L'helgoualc'h <lhh@free.fr>
 *     0xfcd1: Mr. Dave Konrad <konrad@xenia.it>
 *
 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
 *
 *   This code is covered by the GNU GPL and you are free to make any
 *   changes you wish to it under the terms of the license. However the
 *   code has the potential to render your computer and/or someone else's
 *   unusable. Please proceed with care when modifying the code.
 *
 * Note: Unfortunately the laptop hardware can close the System Configuration
 *       Interface on it's own accord. It is therefore necessary for *all*
 *       programs using this driver to be aware that *any* SCI call can fail at
 *       *any* time. It is up to any program to be aware of this eventuality
 *       and take appropriate steps.
 *
 * 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.
 *
 * The information used to write this driver has been obtained by reverse
 * engineering the software supplied by Toshiba for their portable computers in
 * strict accordance with the European Council Directive 92/250/EEC on the legal
 * protection of computer programs, and it's implementation into English Law by
 * the Copyright (Computer Programs) Regulations 1992 (S.I. 1992 No.3233).
 *
 */

#define TOSH_VERSION "1.11 26/9/2001"
#define TOSH_DEBUG 0

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/types.h>
#include <linux/fcntl.h>
#include <linux/miscdevice.h>
#include <linux/ioport.h>
#include <asm/io.h>
#include <asm/uaccess.h>
#include <linux/init.h>
#include <linux/stat.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/smp_lock.h>
#include <linux/toshiba.h>

#define TOSH_MINOR_DEV 181

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Jonathan Buzzard <jonathan@buzzard.org.uk>");
MODULE_DESCRIPTION("Toshiba laptop SMM driver");
MODULE_SUPPORTED_DEVICE("toshiba");

static int tosh_fn;
module_param_named(fn, tosh_fn, int, 0);
MODULE_PARM_DESC(fn, "User specified Fn key detection port");

static int tosh_id;
static int tosh_bios;
static int tosh_date;
static int tosh_sci;
static int tosh_fan;

static long tosh_ioctl(struct file *, unsigned int,
	unsigned long);


static const struct file_operations tosh_fops = {
	.owner		= THIS_MODULE,
	.unlocked_ioctl	= tosh_ioctl,
};

static struct miscdevice tosh_device = {
	TOSH_MINOR_DEV,
	"toshiba",
	&tosh_fops
};

/*
 * Read the Fn key status
 */
#ifdef CONFIG_PROC_FS
static int tosh_fn_status(void)
{
        unsigned char scan;
	unsigned long flags;

	if (tosh_fn!=0) {
		scan = inb(tosh_fn);
	} else {
		local_irq_save(flags);
		outb(0x8e, 0xe4);
		scan = inb(0xe5);
		local_irq_restore(flags);
	}

        return (int) scan;
}
#endif


/*
 * For the Portage 610CT and the Tecra 700CS/700CDT emulate the HCI fan function
 */
static int tosh_emulate_fan(SMMRegisters *regs)
{
	unsigned long eax,ecx,flags;
	unsigned char al;

	eax = regs->eax & 0xff00;
	ecx = regs->ecx & 0xffff;

	/* Portage 610CT */

	if (tosh_id==0xfccb) {
		if (eax==0xfe00) {
			/* fan status */
			local_irq_save(flags);
			outb(0xbe, 0xe4);
			al = inb(0xe5);
			local_irq_restore(flags);
			regs->eax = 0x00;
			regs->ecx = (unsigned int) (al & 0x01);
		}
		if ((eax==0xff00) && (ecx==0x0000)) {
			/* fan off */
			local_irq_save(flags);
			outb(0xbe, 0xe4);
			al = inb(0xe5);
			outb(0xbe, 0xe4);
			outb (al | 0x01, 0xe5);
			local_irq_restore(flags);
			regs->eax = 0x00;
			regs->ecx = 0x00;
		}
		if ((eax==0xff00) && (ecx==0x0001)) {
			/* fan on */
			local_irq_save(flags);
			outb(0xbe, 0xe4);
			al = inb(0xe5);
			outb(0xbe, 0xe4);
			outb(al & 0xfe, 0xe5);
			local_irq_restore(flags);
			regs->eax = 0x00;
			regs->ecx = 0x01;
		}
	}

	/* Tecra 700CS/CDT */

	if (tosh_id==0xfccc) {
		if (eax==0xfe00) {
			/* fan status */
			local_irq_save(flags);
			outb(0xe0, 0xe4);
			al = inb(0xe5);
			local_irq_restore(flags);
			regs->eax = 0x00;
			regs->ecx = al & 0x01;
		}
		if ((eax==0xff00) && (ecx==0x0000)) {
			/* fan off */
			local_irq_save(flags);
			outb(0xe0, 0xe4);
			al = inb(0xe5);
			outw(0xe0 | ((al & 0xfe) << 8), 0xe4);
			local_irq_restore(flags);
			regs->eax = 0x00;
			regs->ecx = 0x00;
		}
		if ((eax==0xff00) && (ecx==0x0001)) {
			/* fan on */
			local_irq_save(flags);
			outb(0xe0, 0xe4);
			al = inb(0xe5);
			outw(0xe0 | ((al | 0x01) << 8), 0xe4);
			local_irq_restore(flags);
			regs->eax = 0x00;
			regs->ecx = 0x01;
		}
	}

	return 0;
}


/*
 * Put the laptop into System Management Mode
 */
int tosh_smm(SMMRegisters *regs)
{
	int eax;

	asm ("# load the values into the registers\n\t" \
		"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" \
		"# call the System Management mode\n\t" \
		"inb $0xb2,%%al\n\t"
		"# fill out the memory with the values in the registers\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" \
		"# setup the return value to the carry flag\n\t" \
		"lahf\n\t" \
		"shrl $8,%%eax\n\t" \
		"andl $1,%%eax\n" \
		: "=a" (eax)
		: "a" (regs)
		: "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");

	return eax;
}
EXPORT_SYMBOL(tosh_smm);


static long tosh_ioctl(struct file *fp, unsigned int cmd, unsigned long arg)
{
	SMMRegisters regs;
	SMMRegisters __user *argp = (SMMRegisters __user *)arg;
	unsigned short ax,bx;
	int err;

	if (!argp)
		return -EINVAL;

	if (copy_from_user(&regs, argp, sizeof(SMMRegisters)))
		return -EFAULT;

	switch (cmd) {
		case TOSH_SMM:
			ax = regs.eax & 0xff00;
			bx = regs.ebx & 0xffff;
			/* block HCI calls to read/write memory & PCI devices */
			if (((ax==0xff00) || (ax==0xfe00)) && (bx>0x0069))
				return -EINVAL;

			/* do we need to emulate the fan ? */
			lock_kernel();
			if (tosh_fan==1) {
				if (((ax==0xf300) || (ax==0xf400)) && (bx==0x0004)) {
					err = tosh_emulate_fan(&regs);
					unlock_kernel();
					break;
				}
			}
			err = tosh_smm(&regs);
			unlock_kernel();
			break;
		default:
			return -EINVAL;
	}

        if (copy_to_user(argp, &regs, sizeof(SMMRegisters)))
        	return -EFAULT;

	return (err==0) ? 0:-EINVAL;
}


/*
 * Print the information for /proc/toshiba
 */
#ifdef CONFIG_PROC_FS
static int proc_toshiba_show(struct seq_file *m, void *v)
{
	int key;

	key = tosh_fn_status();

	/* Arguments
	     0) Linux driver version (this will change if format changes)
	     1) Machine ID
	     2) SCI version
	     3) BIOS version (major, minor)
	     4) BIOS date (in SCI date format)
	     5) Fn Key status
	*/
	seq_printf(m, "1.1 0x%04x %d.%d %d.%d 0x%04x 0x%02x\n",
		tosh_id,
		(tosh_sci & 0xff00)>>8,
		tosh_sci & 0xff,
		(tosh_bios & 0xff00)>>8,
		tosh_bios & 0xff,
		tosh_date,
		key);
	return 0;
}

static int proc_toshiba_open(struct inode *inode, struct file *file)
{
	return single_open(file, proc_toshiba_show, NULL);
}

static const struct file_operations proc_toshiba_fops = {
	.owner		= THIS_MODULE,
	.open		= proc_toshiba_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};
#endif


/*
 * Determine which port to use for the Fn key status
 */
static void tosh_set_fn_port(void)
{
	switch (tosh_id) {
		case 0xfc02: case 0xfc04: case 0xfc09: case 0xfc0a: case 0xfc10:
		case 0xfc11: case 0xfc13: case 0xfc15: case 0xfc1a: case 0xfc1b:
		case 0xfc5a:
			tosh_fn = 0x62;
			break;
		case 0xfc08: case 0xfc17: case 0xfc1d: case 0xfcd1: case 0xfce0:
		case 0xfce2:
			tosh_fn = 0x68;
			break;
		default:
			tosh_fn = 0x00;
			break;
	}

	return;
}


/*
 * Get the machine identification number of the current model
 */
static int tosh_get_machine_id(void __iomem *bios)
{
	int id;
	SMMRegisters regs;
	unsigned short bx,cx;
	unsigned long address;

	id = (0x100*(int) readb(bios+0xfffe))+((int) readb(bios+0xfffa));

	/* do we have a SCTTable machine identication number on our hands */

	if (id==0xfc2f) {

		/* start by getting a pointer into the BIOS */

		regs.eax = 0xc000;
		regs.ebx = 0x0000;
		regs.ecx = 0x0000;
		tosh_smm(&regs);
		bx = (unsigned short) (regs.ebx & 0xffff);

		/* At this point in the Toshiba routines under MS Windows
		   the bx register holds 0xe6f5. However my code is producing
		   a different value! For the time being I will just fudge the
		   value. This has been verified on a Satellite Pro 430CDT,
		   Tecra 750CDT, Tecra 780DVD and Satellite 310CDT. */
#if TOSH_DEBUG
		printk("toshiba: debugging ID ebx=0x%04x\n", regs.ebx);
#endif
		bx = 0xe6f5;

		/* now twiddle with our pointer a bit */

		address = bx;
		cx = readw(bios + address);
		address = 9+bx+cx;
		cx = readw(bios + address);
		address = 0xa+cx;
		cx = readw(bios + address);

		/* now construct our machine identification number */

		id = ((cx & 0xff)<<8)+((cx & 0xff00)>>8);
	}

	return id;
}


/*
 * Probe for the presence of a Toshiba laptop
 *
 *   returns and non-zero if unable to detect the presence of a Toshiba
 *   laptop, otherwise zero and determines the Machine ID, BIOS version and
 *   date, and SCI version.
 */
static int tosh_probe(void)
{
	int i,major,minor,day,year,month,flag;
	unsigned char signature[7] = { 0x54,0x4f,0x53,0x48,0x49,0x42,0x41 };
	SMMRegisters regs;
	void __iomem *bios = ioremap_cache(0xf0000, 0x10000);

	if (!bios)
		return -ENOMEM;

	/* extra sanity check for the string "TOSHIBA" in the BIOS because
	   some machines that are not Toshiba's pass the next test */

	for (i=0;i<7;i++) {
		if (readb(bios+0xe010+i)!=signature[i]) {
			printk("toshiba: not a supported Toshiba laptop\n");
			iounmap(bios);
			return -ENODEV;
		}
	}

	/* call the Toshiba SCI support check routine */

	regs.eax = 0xf0f0;
	regs.ebx = 0x0000;
	regs.ecx = 0x0000;
	flag = tosh_smm(&regs);

	/* if this is not a Toshiba laptop carry flag is set and ah=0x86 */

	if ((flag==1) || ((regs.eax & 0xff00)==0x8600)) {
		printk("toshiba: not a supported Toshiba laptop\n");
		iounmap(bios);
		return -ENODEV;
	}

	/* if we get this far then we are running on a Toshiba (probably)! */

	tosh_sci = regs.edx & 0xffff;

	/* next get the machine ID of the current laptop */

	tosh_id = tosh_get_machine_id(bios);

	/* get the BIOS version */

	major = readb(bios+0xe009)-'0';
	minor = ((readb(bios+0xe00b)-'0')*10)+(readb(bios+0xe00c)-'0');
	tosh_bios = (major*0x100)+minor;

	/* get the BIOS date */

	day = ((readb(bios+0xfff5)-'0')*10)+(readb(bios+0xfff6)-'0');
	month = ((readb(bios+0xfff8)-'0')*10)+(readb(bios+0xfff9)-'0');
	year = ((readb(bios+0xfffb)-'0')*10)+(readb(bios+0xfffc)-'0');
	tosh_date = (((year-90) & 0x1f)<<10) | ((month & 0xf)<<6)
		| ((day & 0x1f)<<1);


	/* in theory we should check the ports we are going to use for the
	   fn key detection (and the fan on the Portage 610/Tecra700), and
	   then request them to stop other drivers using them. However as
	   the keyboard driver grabs 0x60-0x6f and the pic driver grabs
	   0xa0-0xbf we can't. We just have to live dangerously and use the
	   ports anyway, oh boy! */

	/* do we need to emulate the fan? */

	if ((tosh_id==0xfccb) || (tosh_id==0xfccc))
		tosh_fan = 1;

	iounmap(bios);

	return 0;
}

static int __init toshiba_init(void)
{
	int retval;
	/* are we running on a Toshiba laptop */

	if (tosh_probe())
		return -ENODEV;

	printk(KERN_INFO "Toshiba System Management Mode driver v" TOSH_VERSION "\n");

	/* set the port to use for Fn status if not specified as a parameter */
	if (tosh_fn==0x00)
		tosh_set_fn_port();

	/* register the device file */
	retval = misc_register(&tosh_device);
	if (retval < 0)
		return retval;

#ifdef CONFIG_PROC_FS
	{
		struct proc_dir_entry *pde;

		pde = proc_create("toshiba", 0, NULL, &proc_toshiba_fops);
		if (!pde) {
			misc_deregister(&tosh_device);
			return -ENOMEM;
		}
	}
#endif

	return 0;
}

static void __exit toshiba_exit(void)
{
	remove_proc_entry("toshiba", NULL);
	misc_deregister(&tosh_device);
}

module_init(toshiba_init);
module_exit(toshiba_exit);
Commit	Line	Data
1da177e4 LT	1	/* toshiba.c -- Linux driver for accessing the SMM on Toshiba laptops
	2	*
	3	* Copyright (c) 1996-2001 Jonathan A. Buzzard (jonathan@buzzard.org.uk)
	4	*
	5	* Valuable assistance and patches from:
	6	* Tom May <tom@you-bastards.com>
	7	* Rob Napier <rnapier@employees.org>
	8	*
	9	* Fn status port numbers for machine ID's courtesy of
	10	* 0xfc02: Scott Eisert <scott.e@sky-eye.com>
	11	* 0xfc04: Steve VanDevender <stevev@efn.org>
	12	* 0xfc08: Garth Berry <garth@itsbruce.net>
	13	* 0xfc0a: Egbert Eich <eich@xfree86.org>
	14	* 0xfc10: Andrew Lofthouse <Andrew.Lofthouse@robins.af.mil>
	15	* 0xfc11: Spencer Olson <solson@novell.com>
	16	* 0xfc13: Claudius Frankewitz <kryp@gmx.de>
	17	* 0xfc15: Tom May <tom@you-bastards.com>
	18	* 0xfc17: Dave Konrad <konrad@xenia.it>
	19	* 0xfc1a: George Betzos <betzos@engr.colostate.edu>
	20	* 0xfc1b: Munemasa Wada <munemasa@jnovel.co.jp>
	21	* 0xfc1d: Arthur Liu <armie@slap.mine.nu>
	22	* 0xfc5a: Jacques L'helgoualc'h <lhh@free.fr>
	23	* 0xfcd1: Mr. Dave Konrad <konrad@xenia.it>
	24	*
	25	* WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
	26	*
	27	* This code is covered by the GNU GPL and you are free to make any
	28	* changes you wish to it under the terms of the license. However the
	29	* code has the potential to render your computer and/or someone else's
	30	* unusable. Please proceed with care when modifying the code.
	31	*
	32	* Note: Unfortunately the laptop hardware can close the System Configuration
	33	* Interface on it's own accord. It is therefore necessary for all
	34	* programs using this driver to be aware that any SCI call can fail at
	35	* any time. It is up to any program to be aware of this eventuality
	36	* and take appropriate steps.
	37	*
	38	* This program is free software; you can redistribute it and/or modify it
	39	* under the terms of the GNU General Public License as published by the
	40	* Free Software Foundation; either version 2, or (at your option) any
	41	* later version.
	42	*
	43	* This program is distributed in the hope that it will be useful, but
	44	* WITHOUT ANY WARRANTY; without even the implied warranty of
	45	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	46	* General Public License for more details.
	47	*
	48	* The information used to write this driver has been obtained by reverse
	49	* engineering the software supplied by Toshiba for their portable computers in
	50	* strict accordance with the European Council Directive 92/250/EEC on the legal
	51	* protection of computer programs, and it's implementation into English Law by
	52	* the Copyright (Computer Programs) Regulations 1992 (S.I. 1992 No.3233).
	53	*
	54	*/
	55
	56	#define TOSH_VERSION "1.11 26/9/2001"
	57	#define TOSH_DEBUG 0
	58
	59	#include <linux/module.h>
	60	#include <linux/kernel.h>
1da177e4 LT	61	#include <linux/types.h>
	62	#include <linux/fcntl.h>
	63	#include <linux/miscdevice.h>
	64	#include <linux/ioport.h>
	65	#include <asm/io.h>
	66	#include <asm/uaccess.h>
	67	#include <linux/init.h>
	68	#include <linux/stat.h>
	69	#include <linux/proc_fs.h>
967bb77c	70	#include <linux/seq_file.h>
3e8d95d9	71	#include <linux/smp_lock.h>
1da177e4 LT	72	#include <linux/toshiba.h>
	73
	74	#define TOSH_MINOR_DEV 181
	75
3f5f7e2e DT	76	MODULE_LICENSE("GPL");
	77	MODULE_AUTHOR("Jonathan Buzzard <jonathan@buzzard.org.uk>");
	78	MODULE_DESCRIPTION("Toshiba laptop SMM driver");
	79	MODULE_SUPPORTED_DEVICE("toshiba");
1da177e4	80
3f5f7e2e DT	81	static int tosh_fn;
	82	module_param_named(fn, tosh_fn, int, 0);
	83	MODULE_PARM_DESC(fn, "User specified Fn key detection port");
1da177e4	84
3f5f7e2e DT	85	static int tosh_id;
	86	static int tosh_bios;
	87	static int tosh_date;
	88	static int tosh_sci;
	89	static int tosh_fan;
1da177e4	90
3e8d95d9	91	static long tosh_ioctl(struct file *, unsigned int,
1da177e4 LT	92	unsigned long);
	93
	94
62322d25	95	static const struct file_operations tosh_fops = {
1da177e4	96	.owner = THIS_MODULE,
3e8d95d9	97	.unlocked_ioctl = tosh_ioctl,
1da177e4 LT	98	};
	99
	100	static struct miscdevice tosh_device = {
	101	TOSH_MINOR_DEV,
	102	"toshiba",
	103	&tosh_fops
	104	};
	105
	106	/*
	107	* Read the Fn key status
	108	*/
	109	#ifdef CONFIG_PROC_FS
	110	static int tosh_fn_status(void)
	111	{
	112	unsigned char scan;
	113	unsigned long flags;
	114
	115	if (tosh_fn!=0) {
	116	scan = inb(tosh_fn);
	117	} else {
	118	local_irq_save(flags);
	119	outb(0x8e, 0xe4);
	120	scan = inb(0xe5);
	121	local_irq_restore(flags);
	122	}
	123
	124	return (int) scan;
	125	}
	126	#endif
	127
	128
	129	/*
	130	* For the Portage 610CT and the Tecra 700CS/700CDT emulate the HCI fan function
	131	*/
	132	static int tosh_emulate_fan(SMMRegisters *regs)
	133	{
	134	unsigned long eax,ecx,flags;
	135	unsigned char al;
	136
	137	eax = regs->eax & 0xff00;
	138	ecx = regs->ecx & 0xffff;
	139
	140	/* Portage 610CT */
	141
	142	if (tosh_id==0xfccb) {
	143	if (eax==0xfe00) {
	144	/* fan status */
	145	local_irq_save(flags);
	146	outb(0xbe, 0xe4);
	147	al = inb(0xe5);
	148	local_irq_restore(flags);
	149	regs->eax = 0x00;
	150	regs->ecx = (unsigned int) (al & 0x01);
	151	}
	152	if ((eax==0xff00) && (ecx==0x0000)) {
	153	/* fan off */
	154	local_irq_save(flags);
	155	outb(0xbe, 0xe4);
	156	al = inb(0xe5);
	157	outb(0xbe, 0xe4);
	158	outb (al \| 0x01, 0xe5);
	159	local_irq_restore(flags);
	160	regs->eax = 0x00;
	161	regs->ecx = 0x00;
162	}
163	if ((eax==0xff00) && (ecx==0x0001)) {
164	/* fan on */
165	local_irq_save(flags);
166	outb(0xbe, 0xe4);
167	al = inb(0xe5);
168	outb(0xbe, 0xe4);
169	outb(al & 0xfe, 0xe5);
170	local_irq_restore(flags);
171	regs->eax = 0x00;
172	regs->ecx = 0x01;
173	}
174	}
175
176	/* Tecra 700CS/CDT */
177
178	if (tosh_id==0xfccc) {
179	if (eax==0xfe00) {
180	/* fan status */
181	local_irq_save(flags);
182	outb(0xe0, 0xe4);
183	al = inb(0xe5);
184	local_irq_restore(flags);
185	regs->eax = 0x00;
186	regs->ecx = al & 0x01;
187	}
188	if ((eax==0xff00) && (ecx==0x0000)) {
189	/* fan off */
190	local_irq_save(flags);
191	outb(0xe0, 0xe4);
192	al = inb(0xe5);
193	outw(0xe0 \| ((al & 0xfe) << 8), 0xe4);
194	local_irq_restore(flags);
195	regs->eax = 0x00;
196	regs->ecx = 0x00;
197	}
198	if ((eax==0xff00) && (ecx==0x0001)) {
199	/* fan on */
200	local_irq_save(flags);
201	outb(0xe0, 0xe4);
202	al = inb(0xe5);
203	outw(0xe0 \| ((al \| 0x01) << 8), 0xe4);
204	local_irq_restore(flags);
205	regs->eax = 0x00;
206	regs->ecx = 0x01;
207	}
208	}
209
210	return 0;
211	}
212
213
214	/*
215	* Put the laptop into System Management Mode
216	*/
217	int tosh_smm(SMMRegisters *regs)
218	{
219	int eax;
220
221	asm ("# load the values into the registers\n\t" \
222	"pushl %%eax\n\t" \
223	"movl 0(%%eax),%%edx\n\t" \
224	"push %%edx\n\t" \
225	"movl 4(%%eax),%%ebx\n\t" \
226	"movl 8(%%eax),%%ecx\n\t" \
227	"movl 12(%%eax),%%edx\n\t" \
228	"movl 16(%%eax),%%esi\n\t" \
229	"movl 20(%%eax),%%edi\n\t" \
230	"popl %%eax\n\t" \
231	"# call the System Management mode\n\t" \
232	"inb $0xb2,%%al\n\t"
233	"# fill out the memory with the values in the registers\n\t" \
234	"xchgl %%eax,(%%esp)\n\t"
235	"movl %%ebx,4(%%eax)\n\t" \
236	"movl %%ecx,8(%%eax)\n\t" \
237	"movl %%edx,12(%%eax)\n\t" \
238	"movl %%esi,16(%%eax)\n\t" \
239	"movl %%edi,20(%%eax)\n\t" \
240	"popl %%edx\n\t" \
241	"movl %%edx,0(%%eax)\n\t" \
242	"# setup the return value to the carry flag\n\t" \
243	"lahf\n\t" \
244	"shrl $8,%%eax\n\t" \
245	"andl $1,%%eax\n" \
246	: "=a" (eax)
247	: "a" (regs)
248	: "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
249
250	return eax;
251	}
0bf93226	252	EXPORT_SYMBOL(tosh_smm);
1da177e4 LT	253
1da177e4 LT	254
3e8d95d9	255	static long tosh_ioctl(struct file *fp, unsigned int cmd, unsigned long arg)
1da177e4 LT	256	{
	257	SMMRegisters regs;
	258	SMMRegisters __user argp = (SMMRegisters __user )arg;
	259	unsigned short ax,bx;
	260	int err;
	261
	262	if (!argp)
	263	return -EINVAL;
	264
	265	if (copy_from_user(&regs, argp, sizeof(SMMRegisters)))
	266	return -EFAULT;
	267
	268	switch (cmd) {
	269	case TOSH_SMM:
	270	ax = regs.eax & 0xff00;
	271	bx = regs.ebx & 0xffff;
	272	/* block HCI calls to read/write memory & PCI devices */
	273	if (((ax==0xff00) \|\| (ax==0xfe00)) && (bx>0x0069))
	274	return -EINVAL;
	275
	276	/* do we need to emulate the fan ? */
3e8d95d9	277	lock_kernel();
1da177e4 LT	278	if (tosh_fan==1) {
	279	if (((ax==0xf300) \|\| (ax==0xf400)) && (bx==0x0004)) {
	280	err = tosh_emulate_fan(&regs);
3e8d95d9	281	unlock_kernel();
1da177e4 LT	282	break;
	283	}
	284	}
	285	err = tosh_smm(&regs);
3e8d95d9	286	unlock_kernel();
1da177e4 LT	287	break;
	288	default:
	289	return -EINVAL;
	290	}
	291
	292	if (copy_to_user(argp, &regs, sizeof(SMMRegisters)))
	293	return -EFAULT;
	294
	295	return (err==0) ? 0:-EINVAL;
	296	}
	297
	298
	299	/*
	300	* Print the information for /proc/toshiba
	301	*/
	302	#ifdef CONFIG_PROC_FS
967bb77c	303	static int proc_toshiba_show(struct seq_file m, void v)
1da177e4	304	{
1da177e4 LT	305	int key;
1da177e4 LT	306
1da177e4 LT	307	key = tosh_fn_status();
	308
	309	/* Arguments
	310	0) Linux driver version (this will change if format changes)
	311	1) Machine ID
	312	2) SCI version
	313	3) BIOS version (major, minor)
	314	4) BIOS date (in SCI date format)
	315	5) Fn Key status
	316	*/
967bb77c	317	seq_printf(m, "1.1 0x%04x %d.%d %d.%d 0x%04x 0x%02x\n",
1da177e4 LT	318	tosh_id,
	319	(tosh_sci & 0xff00)>>8,
	320	tosh_sci & 0xff,
	321	(tosh_bios & 0xff00)>>8,
	322	tosh_bios & 0xff,
	323	tosh_date,
	324	key);
967bb77c AD	325	return 0;
967bb77c AD	326	}
1da177e4	327
967bb77c AD	328	static int proc_toshiba_open(struct inode inode, struct file file)
	329	{
	330	return single_open(file, proc_toshiba_show, NULL);
1da177e4	331	}
967bb77c AD	332
	333	static const struct file_operations proc_toshiba_fops = {
	334	.owner = THIS_MODULE,
	335	.open = proc_toshiba_open,
	336	.read = seq_read,
	337	.llseek = seq_lseek,
	338	.release = single_release,
	339	};
1da177e4 LT	340	#endif
	341
	342
	343	/*
	344	* Determine which port to use for the Fn key status
	345	*/
	346	static void tosh_set_fn_port(void)
	347	{
	348	switch (tosh_id) {
	349	case 0xfc02: case 0xfc04: case 0xfc09: case 0xfc0a: case 0xfc10:
	350	case 0xfc11: case 0xfc13: case 0xfc15: case 0xfc1a: case 0xfc1b:
	351	case 0xfc5a:
	352	tosh_fn = 0x62;
	353	break;
	354	case 0xfc08: case 0xfc17: case 0xfc1d: case 0xfcd1: case 0xfce0:
	355	case 0xfce2:
	356	tosh_fn = 0x68;
	357	break;
	358	default:
	359	tosh_fn = 0x00;
	360	break;
	361	}
	362
	363	return;
	364	}
	365
	366
	367	/*
	368	* Get the machine identification number of the current model
	369	*/
ef5a4c8b	370	static int tosh_get_machine_id(void __iomem *bios)
1da177e4 LT	371	{
	372	int id;
	373	SMMRegisters regs;
	374	unsigned short bx,cx;
	375	unsigned long address;
	376
ef5a4c8b	377	id = (0x100*(int) readb(bios+0xfffe))+((int) readb(bios+0xfffa));
3f5f7e2e	378
1da177e4 LT	379	/* do we have a SCTTable machine identication number on our hands */
	380
	381	if (id==0xfc2f) {
	382
	383	/* start by getting a pointer into the BIOS */
	384
	385	regs.eax = 0xc000;
	386	regs.ebx = 0x0000;
	387	regs.ecx = 0x0000;
	388	tosh_smm(&regs);
	389	bx = (unsigned short) (regs.ebx & 0xffff);
	390
	391	/* At this point in the Toshiba routines under MS Windows
	392	the bx register holds 0xe6f5. However my code is producing
	393	a different value! For the time being I will just fudge the
	394	value. This has been verified on a Satellite Pro 430CDT,
	395	Tecra 750CDT, Tecra 780DVD and Satellite 310CDT. */
	396	#if TOSH_DEBUG
	397	printk("toshiba: debugging ID ebx=0x%04x\n", regs.ebx);
	398	#endif
	399	bx = 0xe6f5;
	400
	401	/* now twiddle with our pointer a bit */
	402
ef5a4c8b AV	403	address = bx;
	404	cx = readw(bios + address);
	405	address = 9+bx+cx;
	406	cx = readw(bios + address);
	407	address = 0xa+cx;
	408	cx = readw(bios + address);
1da177e4 LT	409
	410	/* now construct our machine identification number */
	411
	412	id = ((cx & 0xff)<<8)+((cx & 0xff00)>>8);
	413	}
	414
	415	return id;
	416	}
	417
	418
	419	/*
	420	* Probe for the presence of a Toshiba laptop
	421	*
	422	* returns and non-zero if unable to detect the presence of a Toshiba
	423	* laptop, otherwise zero and determines the Machine ID, BIOS version and
	424	* date, and SCI version.
	425	*/
	426	static int tosh_probe(void)
	427	{
	428	int i,major,minor,day,year,month,flag;
	429	unsigned char signature[7] = { 0x54,0x4f,0x53,0x48,0x49,0x42,0x41 };
	430	SMMRegisters regs;
1dcf83fd	431	void __iomem *bios = ioremap_cache(0xf0000, 0x10000);
ef5a4c8b AV	432
	433	if (!bios)
	434	return -ENOMEM;
1da177e4 LT	435
	436	/* extra sanity check for the string "TOSHIBA" in the BIOS because
	437	some machines that are not Toshiba's pass the next test */
	438
	439	for (i=0;i<7;i++) {
ef5a4c8b	440	if (readb(bios+0xe010+i)!=signature[i]) {
1da177e4	441	printk("toshiba: not a supported Toshiba laptop\n");
ef5a4c8b	442	iounmap(bios);
1da177e4 LT	443	return -ENODEV;
	444	}
	445	}
	446
	447	/* call the Toshiba SCI support check routine */
3f5f7e2e	448
1da177e4 LT	449	regs.eax = 0xf0f0;
	450	regs.ebx = 0x0000;
	451	regs.ecx = 0x0000;
	452	flag = tosh_smm(&regs);
	453
	454	/* if this is not a Toshiba laptop carry flag is set and ah=0x86 */
	455
	456	if ((flag==1) \|\| ((regs.eax & 0xff00)==0x8600)) {
	457	printk("toshiba: not a supported Toshiba laptop\n");
ef5a4c8b	458	iounmap(bios);
1da177e4 LT	459	return -ENODEV;
	460	}
	461
	462	/* if we get this far then we are running on a Toshiba (probably)! */
	463
	464	tosh_sci = regs.edx & 0xffff;
3f5f7e2e	465
1da177e4 LT	466	/* next get the machine ID of the current laptop */
1da177e4 LT	467
ef5a4c8b	468	tosh_id = tosh_get_machine_id(bios);
1da177e4 LT	469
	470	/* get the BIOS version */
	471
ef5a4c8b AV	472	major = readb(bios+0xe009)-'0';
ef5a4c8b AV	473	minor = ((readb(bios+0xe00b)-'0')*10)+(readb(bios+0xe00c)-'0');
1da177e4 LT	474	tosh_bios = (major*0x100)+minor;
	475
	476	/* get the BIOS date */
	477
ef5a4c8b AV	478	day = ((readb(bios+0xfff5)-'0')*10)+(readb(bios+0xfff6)-'0');
	479	month = ((readb(bios+0xfff8)-'0')*10)+(readb(bios+0xfff9)-'0');
	480	year = ((readb(bios+0xfffb)-'0')*10)+(readb(bios+0xfffc)-'0');
1da177e4 LT	481	tosh_date = (((year-90) & 0x1f)<<10) \| ((month & 0xf)<<6)
	482	\| ((day & 0x1f)<<1);
	483
	484
	485	/* in theory we should check the ports we are going to use for the
	486	fn key detection (and the fan on the Portage 610/Tecra700), and
	487	then request them to stop other drivers using them. However as
	488	the keyboard driver grabs 0x60-0x6f and the pic driver grabs
	489	0xa0-0xbf we can't. We just have to live dangerously and use the
	490	ports anyway, oh boy! */
	491
	492	/* do we need to emulate the fan? */
	493
	494	if ((tosh_id==0xfccb) \|\| (tosh_id==0xfccc))
	495	tosh_fan = 1;
	496
ef5a4c8b AV	497	iounmap(bios);
ef5a4c8b AV	498
1da177e4 LT	499	return 0;
	500	}
	501
3f5f7e2e	502	static int __init toshiba_init(void)
1da177e4 LT	503	{
	504	int retval;
	505	/* are we running on a Toshiba laptop */
	506
3f5f7e2e DT	507	if (tosh_probe())
3f5f7e2e DT	508	return -ENODEV;
1da177e4	509
8dfba4d7	510	printk(KERN_INFO "Toshiba System Management Mode driver v" TOSH_VERSION "\n");
1da177e4 LT	511
	512	/* set the port to use for Fn status if not specified as a parameter */
	513	if (tosh_fn==0x00)
	514	tosh_set_fn_port();
	515
	516	/* register the device file */
	517	retval = misc_register(&tosh_device);
3f5f7e2e	518	if (retval < 0)
1da177e4 LT	519	return retval;
	520
	521	#ifdef CONFIG_PROC_FS
967bb77c AD	522	{
	523	struct proc_dir_entry *pde;
	524
1b502217	525	pde = proc_create("toshiba", 0, NULL, &proc_toshiba_fops);
967bb77c AD	526	if (!pde) {
	527	misc_deregister(&tosh_device);
	528	return -ENOMEM;
	529	}
1da177e4 LT	530	}
	531	#endif
	532
	533	return 0;
	534	}
	535
3f5f7e2e	536	static void __exit toshiba_exit(void)
1da177e4	537	{
1da177e4	538	remove_proc_entry("toshiba", NULL);
1da177e4 LT	539	misc_deregister(&tosh_device);
1da177e4 LT	540	}
1da177e4	541
3f5f7e2e DT	542	module_init(toshiba_init);
3f5f7e2e DT	543	module_exit(toshiba_exit);
1da177e4	544