1 /* toshiba.c -- Linux driver for accessing the SMM on Toshiba laptops
3 * Copyright (c) 1996-2001 Jonathan A. Buzzard (jonathan@buzzard.org.uk)
5 * Valuable assistance and patches from:
6 * Tom May <tom@you-bastards.com>
7 * Rob Napier <rnapier@employees.org>
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>
25 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
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.
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.
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
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.
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).
56 #define TOSH_VERSION "1.11 26/9/2001"
59 #include <linux/module.h>
60 #include <linux/kernel.h>
61 #include <linux/types.h>
62 #include <linux/fcntl.h>
63 #include <linux/miscdevice.h>
64 #include <linux/ioport.h>
66 #include <asm/uaccess.h>
67 #include <linux/init.h>
68 #include <linux/stat.h>
69 #include <linux/proc_fs.h>
70 #include <linux/seq_file.h>
71 #include <linux/mutex.h>
72 #include <linux/toshiba.h>
74 #define TOSH_MINOR_DEV 181
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");
81 static DEFINE_MUTEX(tosh_mutex
);
83 module_param_named(fn
, tosh_fn
, int, 0);
84 MODULE_PARM_DESC(fn
, "User specified Fn key detection port");
92 static long tosh_ioctl(struct file
*, unsigned int,
96 static const struct file_operations tosh_fops
= {
98 .unlocked_ioctl
= tosh_ioctl
,
101 static struct miscdevice tosh_device
= {
108 * Read the Fn key status
110 #ifdef CONFIG_PROC_FS
111 static int tosh_fn_status(void)
119 local_irq_save(flags
);
122 local_irq_restore(flags
);
131 * For the Portage 610CT and the Tecra 700CS/700CDT emulate the HCI fan function
133 static int tosh_emulate_fan(SMMRegisters
*regs
)
135 unsigned long eax
,ecx
,flags
;
138 eax
= regs
->eax
& 0xff00;
139 ecx
= regs
->ecx
& 0xffff;
143 if (tosh_id
==0xfccb) {
146 local_irq_save(flags
);
149 local_irq_restore(flags
);
151 regs
->ecx
= (unsigned int) (al
& 0x01);
153 if ((eax
==0xff00) && (ecx
==0x0000)) {
155 local_irq_save(flags
);
159 outb (al
| 0x01, 0xe5);
160 local_irq_restore(flags
);
164 if ((eax
==0xff00) && (ecx
==0x0001)) {
166 local_irq_save(flags
);
170 outb(al
& 0xfe, 0xe5);
171 local_irq_restore(flags
);
177 /* Tecra 700CS/CDT */
179 if (tosh_id
==0xfccc) {
182 local_irq_save(flags
);
185 local_irq_restore(flags
);
187 regs
->ecx
= al
& 0x01;
189 if ((eax
==0xff00) && (ecx
==0x0000)) {
191 local_irq_save(flags
);
194 outw(0xe0 | ((al
& 0xfe) << 8), 0xe4);
195 local_irq_restore(flags
);
199 if ((eax
==0xff00) && (ecx
==0x0001)) {
201 local_irq_save(flags
);
204 outw(0xe0 | ((al
| 0x01) << 8), 0xe4);
205 local_irq_restore(flags
);
216 * Put the laptop into System Management Mode
218 int tosh_smm(SMMRegisters
*regs
)
222 asm ("# load the values into the registers\n\t" \
224 "movl 0(%%eax),%%edx\n\t" \
226 "movl 4(%%eax),%%ebx\n\t" \
227 "movl 8(%%eax),%%ecx\n\t" \
228 "movl 12(%%eax),%%edx\n\t" \
229 "movl 16(%%eax),%%esi\n\t" \
230 "movl 20(%%eax),%%edi\n\t" \
232 "# call the System Management mode\n\t" \
234 "# fill out the memory with the values in the registers\n\t" \
235 "xchgl %%eax,(%%esp)\n\t"
236 "movl %%ebx,4(%%eax)\n\t" \
237 "movl %%ecx,8(%%eax)\n\t" \
238 "movl %%edx,12(%%eax)\n\t" \
239 "movl %%esi,16(%%eax)\n\t" \
240 "movl %%edi,20(%%eax)\n\t" \
242 "movl %%edx,0(%%eax)\n\t" \
243 "# setup the return value to the carry flag\n\t" \
245 "shrl $8,%%eax\n\t" \
249 : "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
253 EXPORT_SYMBOL(tosh_smm
);
256 static long tosh_ioctl(struct file
*fp
, unsigned int cmd
, unsigned long arg
)
259 SMMRegisters __user
*argp
= (SMMRegisters __user
*)arg
;
260 unsigned short ax
,bx
;
266 if (copy_from_user(®s
, argp
, sizeof(SMMRegisters
)))
271 ax
= regs
.eax
& 0xff00;
272 bx
= regs
.ebx
& 0xffff;
273 /* block HCI calls to read/write memory & PCI devices */
274 if (((ax
==0xff00) || (ax
==0xfe00)) && (bx
>0x0069))
277 /* do we need to emulate the fan ? */
278 mutex_lock(&tosh_mutex
);
280 if (((ax
==0xf300) || (ax
==0xf400)) && (bx
==0x0004)) {
281 err
= tosh_emulate_fan(®s
);
282 mutex_unlock(&tosh_mutex
);
286 err
= tosh_smm(®s
);
287 mutex_unlock(&tosh_mutex
);
293 if (copy_to_user(argp
, ®s
, sizeof(SMMRegisters
)))
296 return (err
==0) ? 0:-EINVAL
;
301 * Print the information for /proc/toshiba
303 #ifdef CONFIG_PROC_FS
304 static int proc_toshiba_show(struct seq_file
*m
, void *v
)
308 key
= tosh_fn_status();
311 0) Linux driver version (this will change if format changes)
314 3) BIOS version (major, minor)
315 4) BIOS date (in SCI date format)
318 seq_printf(m
, "1.1 0x%04x %d.%d %d.%d 0x%04x 0x%02x\n",
320 (tosh_sci
& 0xff00)>>8,
322 (tosh_bios
& 0xff00)>>8,
329 static int proc_toshiba_open(struct inode
*inode
, struct file
*file
)
331 return single_open(file
, proc_toshiba_show
, NULL
);
334 static const struct file_operations proc_toshiba_fops
= {
335 .owner
= THIS_MODULE
,
336 .open
= proc_toshiba_open
,
339 .release
= single_release
,
345 * Determine which port to use for the Fn key status
347 static void tosh_set_fn_port(void)
350 case 0xfc02: case 0xfc04: case 0xfc09: case 0xfc0a: case 0xfc10:
351 case 0xfc11: case 0xfc13: case 0xfc15: case 0xfc1a: case 0xfc1b:
355 case 0xfc08: case 0xfc17: case 0xfc1d: case 0xfcd1: case 0xfce0:
369 * Get the machine identification number of the current model
371 static int tosh_get_machine_id(void __iomem
*bios
)
375 unsigned short bx
,cx
;
376 unsigned long address
;
378 id
= (0x100*(int) readb(bios
+0xfffe))+((int) readb(bios
+0xfffa));
380 /* do we have a SCTTable machine identication number on our hands */
384 /* start by getting a pointer into the BIOS */
390 bx
= (unsigned short) (regs
.ebx
& 0xffff);
392 /* At this point in the Toshiba routines under MS Windows
393 the bx register holds 0xe6f5. However my code is producing
394 a different value! For the time being I will just fudge the
395 value. This has been verified on a Satellite Pro 430CDT,
396 Tecra 750CDT, Tecra 780DVD and Satellite 310CDT. */
398 printk("toshiba: debugging ID ebx=0x%04x\n", regs
.ebx
);
402 /* now twiddle with our pointer a bit */
405 cx
= readw(bios
+ address
);
407 cx
= readw(bios
+ address
);
409 cx
= readw(bios
+ address
);
411 /* now construct our machine identification number */
413 id
= ((cx
& 0xff)<<8)+((cx
& 0xff00)>>8);
421 * Probe for the presence of a Toshiba laptop
423 * returns and non-zero if unable to detect the presence of a Toshiba
424 * laptop, otherwise zero and determines the Machine ID, BIOS version and
425 * date, and SCI version.
427 static int tosh_probe(void)
429 int i
,major
,minor
,day
,year
,month
,flag
;
430 unsigned char signature
[7] = { 0x54,0x4f,0x53,0x48,0x49,0x42,0x41 };
432 void __iomem
*bios
= ioremap_cache(0xf0000, 0x10000);
437 /* extra sanity check for the string "TOSHIBA" in the BIOS because
438 some machines that are not Toshiba's pass the next test */
441 if (readb(bios
+0xe010+i
)!=signature
[i
]) {
442 printk("toshiba: not a supported Toshiba laptop\n");
448 /* call the Toshiba SCI support check routine */
453 flag
= tosh_smm(®s
);
455 /* if this is not a Toshiba laptop carry flag is set and ah=0x86 */
457 if ((flag
==1) || ((regs
.eax
& 0xff00)==0x8600)) {
458 printk("toshiba: not a supported Toshiba laptop\n");
463 /* if we get this far then we are running on a Toshiba (probably)! */
465 tosh_sci
= regs
.edx
& 0xffff;
467 /* next get the machine ID of the current laptop */
469 tosh_id
= tosh_get_machine_id(bios
);
471 /* get the BIOS version */
473 major
= readb(bios
+0xe009)-'0';
474 minor
= ((readb(bios
+0xe00b)-'0')*10)+(readb(bios
+0xe00c)-'0');
475 tosh_bios
= (major
*0x100)+minor
;
477 /* get the BIOS date */
479 day
= ((readb(bios
+0xfff5)-'0')*10)+(readb(bios
+0xfff6)-'0');
480 month
= ((readb(bios
+0xfff8)-'0')*10)+(readb(bios
+0xfff9)-'0');
481 year
= ((readb(bios
+0xfffb)-'0')*10)+(readb(bios
+0xfffc)-'0');
482 tosh_date
= (((year
-90) & 0x1f)<<10) | ((month
& 0xf)<<6)
486 /* in theory we should check the ports we are going to use for the
487 fn key detection (and the fan on the Portage 610/Tecra700), and
488 then request them to stop other drivers using them. However as
489 the keyboard driver grabs 0x60-0x6f and the pic driver grabs
490 0xa0-0xbf we can't. We just have to live dangerously and use the
491 ports anyway, oh boy! */
493 /* do we need to emulate the fan? */
495 if ((tosh_id
==0xfccb) || (tosh_id
==0xfccc))
503 static int __init
toshiba_init(void)
506 /* are we running on a Toshiba laptop */
511 printk(KERN_INFO
"Toshiba System Management Mode driver v" TOSH_VERSION
"\n");
513 /* set the port to use for Fn status if not specified as a parameter */
517 /* register the device file */
518 retval
= misc_register(&tosh_device
);
522 #ifdef CONFIG_PROC_FS
524 struct proc_dir_entry
*pde
;
526 pde
= proc_create("toshiba", 0, NULL
, &proc_toshiba_fops
);
528 misc_deregister(&tosh_device
);
537 static void __exit
toshiba_exit(void)
539 remove_proc_entry("toshiba", NULL
);
540 misc_deregister(&tosh_device
);
543 module_init(toshiba_init
);
544 module_exit(toshiba_exit
);