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