[mirror_ubuntu-bionic-kernel.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 <linux/uaccess.h>
#include <linux/init.h>
#include <linux/stat.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/mutex.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 DEFINE_MUTEX(tosh_mutex);
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,
	.llseek		= noop_llseek,
};

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 ? */
			mutex_lock(&tosh_mutex);
			if (tosh_fan==1) {
				if (((ax==0xf300) || (ax==0xf400)) && (bx==0x0004)) {
					err = tosh_emulate_fan(&regs);
					mutex_unlock(&tosh_mutex);
					break;
				}
			}
			err = tosh_smm(&regs);
			mutex_unlock(&tosh_mutex);
			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(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>
7c0f6ba6	66	#include <linux/uaccess.h>
1da177e4 LT	67	#include <linux/init.h>
	68	#include <linux/stat.h>
	69	#include <linux/proc_fs.h>
967bb77c	70	#include <linux/seq_file.h>
613655fa	71	#include <linux/mutex.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
613655fa	81	static DEFINE_MUTEX(tosh_mutex);
3f5f7e2e DT	82	static int tosh_fn;
	83	module_param_named(fn, tosh_fn, int, 0);
	84	MODULE_PARM_DESC(fn, "User specified Fn key detection port");
1da177e4	85
3f5f7e2e DT	86	static int tosh_id;
	87	static int tosh_bios;
	88	static int tosh_date;
	89	static int tosh_sci;
	90	static int tosh_fan;
1da177e4	91
3e8d95d9	92	static long tosh_ioctl(struct file *, unsigned int,
1da177e4 LT	93	unsigned long);
	94
	95
62322d25	96	static const struct file_operations tosh_fops = {
1da177e4	97	.owner = THIS_MODULE,
3e8d95d9	98	.unlocked_ioctl = tosh_ioctl,
6038f373	99	.llseek = noop_llseek,
1da177e4 LT	100	};
	101
	102	static struct miscdevice tosh_device = {
	103	TOSH_MINOR_DEV,
	104	"toshiba",
	105	&tosh_fops
	106	};
	107
	108	/*
	109	* Read the Fn key status
	110	*/
	111	#ifdef CONFIG_PROC_FS
	112	static int tosh_fn_status(void)
	113	{
	114	unsigned char scan;
	115	unsigned long flags;
	116
	117	if (tosh_fn!=0) {
	118	scan = inb(tosh_fn);
	119	} else {
	120	local_irq_save(flags);
	121	outb(0x8e, 0xe4);
	122	scan = inb(0xe5);
	123	local_irq_restore(flags);
	124	}
	125
	126	return (int) scan;
	127	}
	128	#endif
	129
	130
	131	/*
	132	* For the Portage 610CT and the Tecra 700CS/700CDT emulate the HCI fan function
	133	*/
	134	static int tosh_emulate_fan(SMMRegisters *regs)
	135	{
	136	unsigned long eax,ecx,flags;
	137	unsigned char al;
	138
	139	eax = regs->eax & 0xff00;
	140	ecx = regs->ecx & 0xffff;
	141
	142	/* Portage 610CT */
	143
	144	if (tosh_id==0xfccb) {
	145	if (eax==0xfe00) {
	146	/* fan status */
	147	local_irq_save(flags);
	148	outb(0xbe, 0xe4);
	149	al = inb(0xe5);
	150	local_irq_restore(flags);
	151	regs->eax = 0x00;
	152	regs->ecx = (unsigned int) (al & 0x01);
	153	}
	154	if ((eax==0xff00) && (ecx==0x0000)) {
	155	/* fan off */
	156	local_irq_save(flags);
	157	outb(0xbe, 0xe4);
	158	al = inb(0xe5);
	159	outb(0xbe, 0xe4);
	160	outb (al \| 0x01, 0xe5);
	161	local_irq_restore(flags);
	162	regs->eax = 0x00;
	163	regs->ecx = 0x00;
164	}
165	if ((eax==0xff00) && (ecx==0x0001)) {
166	/* fan on */
167	local_irq_save(flags);
168	outb(0xbe, 0xe4);
169	al = inb(0xe5);
170	outb(0xbe, 0xe4);
171	outb(al & 0xfe, 0xe5);
172	local_irq_restore(flags);
173	regs->eax = 0x00;
174	regs->ecx = 0x01;
175	}
176	}
177
178	/* Tecra 700CS/CDT */
179
180	if (tosh_id==0xfccc) {
181	if (eax==0xfe00) {
182	/* fan status */
183	local_irq_save(flags);
184	outb(0xe0, 0xe4);
185	al = inb(0xe5);
186	local_irq_restore(flags);
187	regs->eax = 0x00;
188	regs->ecx = al & 0x01;
189	}
190	if ((eax==0xff00) && (ecx==0x0000)) {
191	/* fan off */
192	local_irq_save(flags);
193	outb(0xe0, 0xe4);
194	al = inb(0xe5);
195	outw(0xe0 \| ((al & 0xfe) << 8), 0xe4);
196	local_irq_restore(flags);
197	regs->eax = 0x00;
198	regs->ecx = 0x00;
199	}
200	if ((eax==0xff00) && (ecx==0x0001)) {
201	/* fan on */
202	local_irq_save(flags);
203	outb(0xe0, 0xe4);
204	al = inb(0xe5);
205	outw(0xe0 \| ((al \| 0x01) << 8), 0xe4);
206	local_irq_restore(flags);
207	regs->eax = 0x00;
208	regs->ecx = 0x01;
209	}
210	}
211
212	return 0;
213	}
214
215
216	/*
217	* Put the laptop into System Management Mode
218	*/
219	int tosh_smm(SMMRegisters *regs)
220	{
221	int eax;
222
223	asm ("# load the values into the registers\n\t" \
224	"pushl %%eax\n\t" \
225	"movl 0(%%eax),%%edx\n\t" \
226	"push %%edx\n\t" \
227	"movl 4(%%eax),%%ebx\n\t" \
228	"movl 8(%%eax),%%ecx\n\t" \
229	"movl 12(%%eax),%%edx\n\t" \
230	"movl 16(%%eax),%%esi\n\t" \
231	"movl 20(%%eax),%%edi\n\t" \
232	"popl %%eax\n\t" \
233	"# call the System Management mode\n\t" \
234	"inb $0xb2,%%al\n\t"
235	"# fill out the memory with the values in the registers\n\t" \
236	"xchgl %%eax,(%%esp)\n\t"
237	"movl %%ebx,4(%%eax)\n\t" \
238	"movl %%ecx,8(%%eax)\n\t" \
239	"movl %%edx,12(%%eax)\n\t" \
240	"movl %%esi,16(%%eax)\n\t" \
241	"movl %%edi,20(%%eax)\n\t" \
242	"popl %%edx\n\t" \
243	"movl %%edx,0(%%eax)\n\t" \
244	"# setup the return value to the carry flag\n\t" \
245	"lahf\n\t" \
246	"shrl $8,%%eax\n\t" \
247	"andl $1,%%eax\n" \
248	: "=a" (eax)
249	: "a" (regs)
250	: "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
251
252	return eax;
253	}
0bf93226	254	EXPORT_SYMBOL(tosh_smm);
1da177e4 LT	255
1da177e4 LT	256
3e8d95d9	257	static long tosh_ioctl(struct file *fp, unsigned int cmd, unsigned long arg)
1da177e4 LT	258	{
	259	SMMRegisters regs;
	260	SMMRegisters __user argp = (SMMRegisters __user )arg;
	261	unsigned short ax,bx;
	262	int err;
	263
	264	if (!argp)
	265	return -EINVAL;
	266
	267	if (copy_from_user(&regs, argp, sizeof(SMMRegisters)))
	268	return -EFAULT;
	269
	270	switch (cmd) {
	271	case TOSH_SMM:
	272	ax = regs.eax & 0xff00;
	273	bx = regs.ebx & 0xffff;
	274	/* block HCI calls to read/write memory & PCI devices */
	275	if (((ax==0xff00) \|\| (ax==0xfe00)) && (bx>0x0069))
	276	return -EINVAL;
	277
	278	/* do we need to emulate the fan ? */
613655fa	279	mutex_lock(&tosh_mutex);
1da177e4 LT	280	if (tosh_fan==1) {
	281	if (((ax==0xf300) \|\| (ax==0xf400)) && (bx==0x0004)) {
	282	err = tosh_emulate_fan(&regs);
613655fa	283	mutex_unlock(&tosh_mutex);
1da177e4 LT	284	break;
	285	}
	286	}
	287	err = tosh_smm(&regs);
613655fa	288	mutex_unlock(&tosh_mutex);
1da177e4 LT	289	break;
	290	default:
	291	return -EINVAL;
	292	}
	293
	294	if (copy_to_user(argp, &regs, sizeof(SMMRegisters)))
	295	return -EFAULT;
	296
	297	return (err==0) ? 0:-EINVAL;
	298	}
	299
	300
	301	/*
	302	* Print the information for /proc/toshiba
	303	*/
	304	#ifdef CONFIG_PROC_FS
967bb77c	305	static int proc_toshiba_show(struct seq_file m, void v)
1da177e4	306	{
1da177e4 LT	307	int key;
1da177e4 LT	308
1da177e4 LT	309	key = tosh_fn_status();
	310
	311	/* Arguments
	312	0) Linux driver version (this will change if format changes)
	313	1) Machine ID
	314	2) SCI version
	315	3) BIOS version (major, minor)
	316	4) BIOS date (in SCI date format)
	317	5) Fn Key status
	318	*/
967bb77c	319	seq_printf(m, "1.1 0x%04x %d.%d %d.%d 0x%04x 0x%02x\n",
1da177e4 LT	320	tosh_id,
	321	(tosh_sci & 0xff00)>>8,
	322	tosh_sci & 0xff,
	323	(tosh_bios & 0xff00)>>8,
	324	tosh_bios & 0xff,
	325	tosh_date,
	326	key);
967bb77c AD	327	return 0;
967bb77c AD	328	}
1da177e4	329
967bb77c AD	330	static int proc_toshiba_open(struct inode inode, struct file file)
	331	{
	332	return single_open(file, proc_toshiba_show, NULL);
1da177e4	333	}
967bb77c AD	334
	335	static const struct file_operations proc_toshiba_fops = {
	336	.owner = THIS_MODULE,
	337	.open = proc_toshiba_open,
	338	.read = seq_read,
	339	.llseek = seq_lseek,
	340	.release = single_release,
	341	};
1da177e4 LT	342	#endif
	343
	344
	345	/*
	346	* Determine which port to use for the Fn key status
	347	*/
	348	static void tosh_set_fn_port(void)
	349	{
	350	switch (tosh_id) {
	351	case 0xfc02: case 0xfc04: case 0xfc09: case 0xfc0a: case 0xfc10:
	352	case 0xfc11: case 0xfc13: case 0xfc15: case 0xfc1a: case 0xfc1b:
	353	case 0xfc5a:
	354	tosh_fn = 0x62;
	355	break;
	356	case 0xfc08: case 0xfc17: case 0xfc1d: case 0xfcd1: case 0xfce0:
	357	case 0xfce2:
	358	tosh_fn = 0x68;
	359	break;
	360	default:
	361	tosh_fn = 0x00;
	362	break;
	363	}
	364
	365	return;
	366	}
	367
	368
	369	/*
	370	* Get the machine identification number of the current model
	371	*/
ef5a4c8b	372	static int tosh_get_machine_id(void __iomem *bios)
1da177e4 LT	373	{
	374	int id;
	375	SMMRegisters regs;
	376	unsigned short bx,cx;
	377	unsigned long address;
	378
ef5a4c8b	379	id = (0x100*(int) readb(bios+0xfffe))+((int) readb(bios+0xfffa));
3f5f7e2e	380
1da177e4 LT	381	/* do we have a SCTTable machine identication number on our hands */
	382
	383	if (id==0xfc2f) {
	384
	385	/* start by getting a pointer into the BIOS */
	386
	387	regs.eax = 0xc000;
	388	regs.ebx = 0x0000;
	389	regs.ecx = 0x0000;
	390	tosh_smm(&regs);
	391	bx = (unsigned short) (regs.ebx & 0xffff);
	392
	393	/* At this point in the Toshiba routines under MS Windows
	394	the bx register holds 0xe6f5. However my code is producing
	395	a different value! For the time being I will just fudge the
	396	value. This has been verified on a Satellite Pro 430CDT,
	397	Tecra 750CDT, Tecra 780DVD and Satellite 310CDT. */
	398	#if TOSH_DEBUG
	399	printk("toshiba: debugging ID ebx=0x%04x\n", regs.ebx);
	400	#endif
	401	bx = 0xe6f5;
	402
	403	/* now twiddle with our pointer a bit */
	404
ef5a4c8b AV	405	address = bx;
	406	cx = readw(bios + address);
	407	address = 9+bx+cx;
	408	cx = readw(bios + address);
	409	address = 0xa+cx;
	410	cx = readw(bios + address);
1da177e4 LT	411
	412	/* now construct our machine identification number */
	413
	414	id = ((cx & 0xff)<<8)+((cx & 0xff00)>>8);
	415	}
	416
	417	return id;
	418	}
	419
	420
	421	/*
	422	* Probe for the presence of a Toshiba laptop
	423	*
	424	* returns and non-zero if unable to detect the presence of a Toshiba
	425	* laptop, otherwise zero and determines the Machine ID, BIOS version and
	426	* date, and SCI version.
	427	*/
	428	static int tosh_probe(void)
	429	{
	430	int i,major,minor,day,year,month,flag;
	431	unsigned char signature[7] = { 0x54,0x4f,0x53,0x48,0x49,0x42,0x41 };
	432	SMMRegisters regs;
48166932	433	void __iomem *bios = ioremap(0xf0000, 0x10000);
ef5a4c8b AV	434
	435	if (!bios)
	436	return -ENOMEM;
1da177e4 LT	437
	438	/* extra sanity check for the string "TOSHIBA" in the BIOS because
	439	some machines that are not Toshiba's pass the next test */
	440
	441	for (i=0;i<7;i++) {
ef5a4c8b	442	if (readb(bios+0xe010+i)!=signature[i]) {
1da177e4	443	printk("toshiba: not a supported Toshiba laptop\n");
ef5a4c8b	444	iounmap(bios);
1da177e4 LT	445	return -ENODEV;
	446	}
	447	}
	448
	449	/* call the Toshiba SCI support check routine */
3f5f7e2e	450
1da177e4 LT	451	regs.eax = 0xf0f0;
	452	regs.ebx = 0x0000;
	453	regs.ecx = 0x0000;
	454	flag = tosh_smm(&regs);
	455
	456	/* if this is not a Toshiba laptop carry flag is set and ah=0x86 */
	457
	458	if ((flag==1) \|\| ((regs.eax & 0xff00)==0x8600)) {
	459	printk("toshiba: not a supported Toshiba laptop\n");
ef5a4c8b	460	iounmap(bios);
1da177e4 LT	461	return -ENODEV;
	462	}
	463
	464	/* if we get this far then we are running on a Toshiba (probably)! */
	465
	466	tosh_sci = regs.edx & 0xffff;
3f5f7e2e	467
1da177e4 LT	468	/* next get the machine ID of the current laptop */
1da177e4 LT	469
ef5a4c8b	470	tosh_id = tosh_get_machine_id(bios);
1da177e4 LT	471
	472	/* get the BIOS version */
	473
ef5a4c8b AV	474	major = readb(bios+0xe009)-'0';
ef5a4c8b AV	475	minor = ((readb(bios+0xe00b)-'0')*10)+(readb(bios+0xe00c)-'0');
1da177e4 LT	476	tosh_bios = (major*0x100)+minor;
	477
	478	/* get the BIOS date */
	479
ef5a4c8b AV	480	day = ((readb(bios+0xfff5)-'0')*10)+(readb(bios+0xfff6)-'0');
	481	month = ((readb(bios+0xfff8)-'0')*10)+(readb(bios+0xfff9)-'0');
	482	year = ((readb(bios+0xfffb)-'0')*10)+(readb(bios+0xfffc)-'0');
1da177e4 LT	483	tosh_date = (((year-90) & 0x1f)<<10) \| ((month & 0xf)<<6)
	484	\| ((day & 0x1f)<<1);
	485
	486
	487	/* in theory we should check the ports we are going to use for the
	488	fn key detection (and the fan on the Portage 610/Tecra700), and
	489	then request them to stop other drivers using them. However as
	490	the keyboard driver grabs 0x60-0x6f and the pic driver grabs
	491	0xa0-0xbf we can't. We just have to live dangerously and use the
	492	ports anyway, oh boy! */
	493
	494	/* do we need to emulate the fan? */
	495
	496	if ((tosh_id==0xfccb) \|\| (tosh_id==0xfccc))
	497	tosh_fan = 1;
	498
ef5a4c8b AV	499	iounmap(bios);
ef5a4c8b AV	500
1da177e4 LT	501	return 0;
	502	}
	503
3f5f7e2e	504	static int __init toshiba_init(void)
1da177e4 LT	505	{
	506	int retval;
	507	/* are we running on a Toshiba laptop */
	508
3f5f7e2e DT	509	if (tosh_probe())
3f5f7e2e DT	510	return -ENODEV;
1da177e4	511
8dfba4d7	512	printk(KERN_INFO "Toshiba System Management Mode driver v" TOSH_VERSION "\n");
1da177e4 LT	513
	514	/* set the port to use for Fn status if not specified as a parameter */
	515	if (tosh_fn==0x00)
	516	tosh_set_fn_port();
	517
	518	/* register the device file */
	519	retval = misc_register(&tosh_device);
3f5f7e2e	520	if (retval < 0)
1da177e4 LT	521	return retval;
	522
	523	#ifdef CONFIG_PROC_FS
967bb77c AD	524	{
	525	struct proc_dir_entry *pde;
	526
1b502217	527	pde = proc_create("toshiba", 0, NULL, &proc_toshiba_fops);
967bb77c AD	528	if (!pde) {
	529	misc_deregister(&tosh_device);
	530	return -ENOMEM;
	531	}
1da177e4 LT	532	}
	533	#endif
	534
	535	return 0;
	536	}
	537
3f5f7e2e	538	static void __exit toshiba_exit(void)
1da177e4	539	{
1da177e4	540	remove_proc_entry("toshiba", NULL);
1da177e4 LT	541	misc_deregister(&tosh_device);
1da177e4 LT	542	}
1da177e4	543
3f5f7e2e DT	544	module_init(toshiba_init);
3f5f7e2e DT	545	module_exit(toshiba_exit);
1da177e4	546