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/sched.h>
62 #include <linux/types.h>
63 #include <linux/fcntl.h>
64 #include <linux/miscdevice.h>
65 #include <linux/ioport.h>
67 #include <asm/uaccess.h>
68 #include <linux/init.h>
69 #include <linux/stat.h>
70 #include <linux/proc_fs.h>
72 #include <linux/toshiba.h>
74 #define TOSH_MINOR_DEV 181
76 static int tosh_id = 0x0000;
77 static int tosh_bios = 0x0000;
78 static int tosh_date = 0x0000;
79 static int tosh_sci = 0x0000;
80 static int tosh_fan = 0;
82 static int tosh_fn = 0;
84 MODULE_PARM(tosh_fn, "i");
87 static int tosh_ioctl(struct inode *, struct file *, unsigned int,
91 static struct file_operations tosh_fops = {
96 static struct miscdevice tosh_device = {
103 * Read the Fn key status
105 #ifdef CONFIG_PROC_FS
106 static int tosh_fn_status(void)
114 local_irq_save(flags);
117 local_irq_restore(flags);
126 * For the Portage 610CT and the Tecra 700CS/700CDT emulate the HCI fan function
128 static int tosh_emulate_fan(SMMRegisters *regs)
130 unsigned long eax,ecx,flags;
133 eax = regs->eax & 0xff00;
134 ecx = regs->ecx & 0xffff;
138 if (tosh_id==0xfccb) {
141 local_irq_save(flags);
144 local_irq_restore(flags);
146 regs->ecx = (unsigned int) (al & 0x01);
148 if ((eax==0xff00) && (ecx==0x0000)) {
150 local_irq_save(flags);
154 outb (al | 0x01, 0xe5);
155 local_irq_restore(flags);
159 if ((eax==0xff00) && (ecx==0x0001)) {
161 local_irq_save(flags);
165 outb(al & 0xfe, 0xe5);
166 local_irq_restore(flags);
172 /* Tecra 700CS/CDT */
174 if (tosh_id==0xfccc) {
177 local_irq_save(flags);
180 local_irq_restore(flags);
182 regs->ecx = al & 0x01;
184 if ((eax==0xff00) && (ecx==0x0000)) {
186 local_irq_save(flags);
189 outw(0xe0 | ((al & 0xfe) << 8), 0xe4);
190 local_irq_restore(flags);
194 if ((eax==0xff00) && (ecx==0x0001)) {
196 local_irq_save(flags);
199 outw(0xe0 | ((al | 0x01) << 8), 0xe4);
200 local_irq_restore(flags);
211 * Put the laptop into System Management Mode
213 int tosh_smm(SMMRegisters *regs)
217 asm ("# load the values into the registers\n\t" \
219 "movl 0(%%eax),%%edx\n\t" \
221 "movl 4(%%eax),%%ebx\n\t" \
222 "movl 8(%%eax),%%ecx\n\t" \
223 "movl 12(%%eax),%%edx\n\t" \
224 "movl 16(%%eax),%%esi\n\t" \
225 "movl 20(%%eax),%%edi\n\t" \
227 "# call the System Management mode\n\t" \
229 "# fill out the memory with the values in the registers\n\t" \
230 "xchgl %%eax,(%%esp)\n\t"
231 "movl %%ebx,4(%%eax)\n\t" \
232 "movl %%ecx,8(%%eax)\n\t" \
233 "movl %%edx,12(%%eax)\n\t" \
234 "movl %%esi,16(%%eax)\n\t" \
235 "movl %%edi,20(%%eax)\n\t" \
237 "movl %%edx,0(%%eax)\n\t" \
238 "# setup the return value to the carry flag\n\t" \
240 "shrl $8,%%eax\n\t" \
244 : "%ebx", "%ecx", "%edx", "%esi", "%edi", "memory");
250 static int tosh_ioctl(struct inode *ip, struct file *fp, unsigned int cmd,
254 unsigned short ax,bx;
260 if (copy_from_user(®s, (SMMRegisters *) arg, sizeof(SMMRegisters)))
265 ax = regs.eax & 0xff00;
266 bx = regs.ebx & 0xffff;
267 /* block HCI calls to read/write memory & PCI devices */
268 if (((ax==0xff00) || (ax==0xfe00)) && (bx>0x0069))
271 /* do we need to emulate the fan ? */
273 if (((ax==0xf300) || (ax==0xf400)) && (bx==0x0004)) {
274 err = tosh_emulate_fan(®s);
278 err = tosh_smm(®s);
284 if (copy_to_user((SMMRegisters *) arg, ®s, sizeof(SMMRegisters)))
287 return (err==0) ? 0:-EINVAL;
292 * Print the information for /proc/toshiba
294 #ifdef CONFIG_PROC_FS
295 static int tosh_get_info(char *buffer, char **start, off_t fpos, int length)
301 key = tosh_fn_status();
304 0) Linux driver version (this will change if format changes)
307 3) BIOS version (major, minor)
308 4) BIOS date (in SCI date format)
312 temp += sprintf(temp, "1.1 0x%04x %d.%d %d.%d 0x%04x 0x%02x\n",
314 (tosh_sci & 0xff00)>>8,
316 (tosh_bios & 0xff00)>>8,
327 * Determine which port to use for the Fn key status
329 static void tosh_set_fn_port(void)
332 case 0xfc02: case 0xfc04: case 0xfc09: case 0xfc0a: case 0xfc10:
333 case 0xfc11: case 0xfc13: case 0xfc15: case 0xfc1a: case 0xfc1b:
337 case 0xfc08: case 0xfc17: case 0xfc1d: case 0xfcd1: case 0xfce0:
351 * Get the machine identification number of the current model
353 static int tosh_get_machine_id(void)
357 unsigned short bx,cx;
358 unsigned long address;
360 id = (0x100*(int) isa_readb(0xffffe))+((int) isa_readb(0xffffa));
362 /* do we have a SCTTable machine identication number on our hands */
366 /* start by getting a pointer into the BIOS */
372 bx = (unsigned short) (regs.ebx & 0xffff);
374 /* At this point in the Toshiba routines under MS Windows
375 the bx register holds 0xe6f5. However my code is producing
376 a different value! For the time being I will just fudge the
377 value. This has been verified on a Satellite Pro 430CDT,
378 Tecra 750CDT, Tecra 780DVD and Satellite 310CDT. */
380 printk("toshiba: debugging ID ebx=0x%04x\n", regs.ebx);
384 /* now twiddle with our pointer a bit */
386 address = 0x000f0000+bx;
387 cx = isa_readw(address);
388 address = 0x000f0009+bx+cx;
389 cx = isa_readw(address);
390 address = 0x000f000a+cx;
391 cx = isa_readw(address);
393 /* now construct our machine identification number */
395 id = ((cx & 0xff)<<8)+((cx & 0xff00)>>8);
403 * Probe for the presence of a Toshiba laptop
405 * returns and non-zero if unable to detect the presence of a Toshiba
406 * laptop, otherwise zero and determines the Machine ID, BIOS version and
407 * date, and SCI version.
411 int i,major,minor,day,year,month,flag;
412 unsigned char signature[7] = { 0x54,0x4f,0x53,0x48,0x49,0x42,0x41 };
415 /* extra sanity check for the string "TOSHIBA" in the BIOS because
416 some machines that are not Toshiba's pass the next test */
419 if (isa_readb(0xfe010+i)!=signature[i]) {
420 printk("toshiba: not a supported Toshiba laptop\n");
425 /* call the Toshiba SCI support check routine */
430 flag = tosh_smm(®s);
432 /* if this is not a Toshiba laptop carry flag is set and ah=0x86 */
434 if ((flag==1) || ((regs.eax & 0xff00)==0x8600)) {
435 printk("toshiba: not a supported Toshiba laptop\n");
439 /* if we get this far then we are running on a Toshiba (probably)! */
441 tosh_sci = regs.edx & 0xffff;
443 /* next get the machine ID of the current laptop */
445 tosh_id = tosh_get_machine_id();
447 /* get the BIOS version */
449 major = isa_readb(0xfe009)-'0';
450 minor = ((isa_readb(0xfe00b)-'0')*10)+(isa_readb(0xfe00c)-'0');
451 tosh_bios = (major*0x100)+minor;
453 /* get the BIOS date */
455 day = ((isa_readb(0xffff5)-'0')*10)+(isa_readb(0xffff6)-'0');
456 month = ((isa_readb(0xffff8)-'0')*10)+(isa_readb(0xffff9)-'0');
457 year = ((isa_readb(0xffffb)-'0')*10)+(isa_readb(0xffffc)-'0');
458 tosh_date = (((year-90) & 0x1f)<<10) | ((month & 0xf)<<6)
462 /* in theory we should check the ports we are going to use for the
463 fn key detection (and the fan on the Portage 610/Tecra700), and
464 then request them to stop other drivers using them. However as
465 the keyboard driver grabs 0x60-0x6f and the pic driver grabs
466 0xa0-0xbf we can't. We just have to live dangerously and use the
467 ports anyway, oh boy! */
469 /* do we need to emulate the fan? */
471 if ((tosh_id==0xfccb) || (tosh_id==0xfccc))
477 int __init tosh_init(void)
480 /* are we running on a Toshiba laptop */
485 printk(KERN_INFO "Toshiba System Managment Mode driver v"
488 /* set the port to use for Fn status if not specified as a parameter */
492 /* register the device file */
493 retval = misc_register(&tosh_device);
497 #ifdef CONFIG_PROC_FS
498 /* register the proc entry */
499 if(create_proc_info_entry("toshiba", 0, NULL, tosh_get_info) == NULL){
500 misc_deregister(&tosh_device);
509 int init_module(void)
514 void cleanup_module(void)
516 /* remove the proc entry */
518 remove_proc_entry("toshiba", NULL);
520 /* unregister the device file */
522 misc_deregister(&tosh_device);
526 MODULE_LICENSE("GPL");
527 MODULE_PARM_DESC(tosh_fn, "User specified Fn key detection port");
528 MODULE_AUTHOR("Jonathan Buzzard <jonathan@buzzard.org.uk>");
529 MODULE_DESCRIPTION("Toshiba laptop SMM driver");
530 MODULE_SUPPORTED_DEVICE("toshiba");