drivers/char/toshiba.c

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