drivers/char/watchdog/i8xx_tco.c

   1 /*
   2  *      i8xx_tco 0.07:  TCO timer driver for i8xx chipsets
   3  *
   4  *      (c) Copyright 2000 kernel concepts <nils@kernelconcepts.de>, All Rights Reserved.
   5  *                              http://www.kernelconcepts.de
   6  *
   7  *      This program is free software; you can redistribute it and/or
   8  *      modify it under the terms of the GNU General Public License
   9  *      as published by the Free Software Foundation; either version
  10  *      2 of the License, or (at your option) any later version.
  11  *
  12  *      Neither kernel concepts nor Nils Faerber admit liability nor provide
  13  *      warranty for any of this software. This material is provided
  14  *      "AS-IS" and at no charge.
  15  *
  16  *      (c) Copyright 2000      kernel concepts <nils@kernelconcepts.de>
  17  *                              developed for
  18  *                              Jentro AG, Haar/Munich (Germany)
  19  *
  20  *      TCO timer driver for i8xx chipsets
  21  *      based on softdog.c by Alan Cox <alan@redhat.com>
  22  *
  23  *      The TCO timer is implemented in the following I/O controller hubs:
  24  *      (See the intel documentation on http://developer.intel.com.)
  25  *      82801AA  (ICH)    : document number 290655-003, 290677-014,
  26  *      82801AB  (ICHO)   : document number 290655-003, 290677-014,
  27  *      82801BA  (ICH2)   : document number 290687-002, 298242-027,
  28  *      82801BAM (ICH2-M) : document number 290687-002, 298242-027,
  29  *      82801CA  (ICH3-S) : document number 290733-003, 290739-013,
  30  *      82801CAM (ICH3-M) : document number 290716-001, 290718-007,
  31  *      82801DB  (ICH4)   : document number 290744-001, 290745-020,
  32  *      82801DBM (ICH4-M) : document number 252337-001, 252663-005,
  33  *      82801E   (C-ICH)  : document number 273599-001, 273645-002,
  34  *      82801EB  (ICH5)   : document number 252516-001, 252517-003,
  35  *      82801ER  (ICH5R)  : document number 252516-001, 252517-003,
  36  *      82801FB  (ICH6)   : document number 301473-002, 301474-007,
  37  *      82801FR  (ICH6R)  : document number 301473-002, 301474-007,
  38  *      82801FBM (ICH6-M) : document number 301473-002, 301474-007,
  39  *      82801FW  (ICH6W)  : document number 301473-001, 301474-007,
  40  *      82801FRW (ICH6RW) : document number 301473-001, 301474-007
  41  *
  42  *  20000710 Nils Faerber
  43  *      Initial Version 0.01
  44  *  20000728 Nils Faerber
  45  *      0.02 Fix for SMI_EN->TCO_EN bit, some cleanups
  46  *  20011214 Matt Domsch <Matt_Domsch@dell.com>
  47  *      0.03 Added nowayout module option to override CONFIG_WATCHDOG_NOWAYOUT
  48  *           Didn't add timeout option as i810_margin already exists.
  49  *  20020224 Joel Becker, Wim Van Sebroeck
  50  *      0.04 Support for 82801CA(M) chipset, timer margin needs to be > 3,
  51  *           add support for WDIOC_SETTIMEOUT and WDIOC_GETTIMEOUT.
  52  *  20020412 Rob Radez <rob@osinvestor.com>, Wim Van Sebroeck
  53  *      0.05 Fix possible timer_alive race, add expect close support,
  54  *           clean up ioctls (WDIOC_GETSTATUS, WDIOC_GETBOOTSTATUS and
  55  *           WDIOC_SETOPTIONS), made i810tco_getdevice __init,
  56  *           removed boot_status, removed tco_timer_read,
  57  *           added support for 82801DB and 82801E chipset,
  58  *           added support for 82801EB and 8280ER chipset,
  59  *           general cleanup.
  60  *  20030921 Wim Van Sebroeck <wim@iguana.be>
  61  *      0.06 change i810_margin to heartbeat, use module_param,
  62  *           added notify system support, renamed module to i8xx_tco.
  63  *  20050128 Wim Van Sebroeck <wim@iguana.be>
  64  *      0.07 Added support for the ICH4-M, ICH6, ICH6R, ICH6-M, ICH6W and ICH6RW
  65  *           chipsets. Also added support for the "undocumented" ICH7 chipset.
  66  */
  67
  68 /*
  69  *      Includes, defines, variables, module parameters, ...
  70  */
  71
  72 #include <linux/module.h>
  73 #include <linux/moduleparam.h>
  74 #include <linux/types.h>
  75 #include <linux/miscdevice.h>
  76 #include <linux/watchdog.h>
  77 #include <linux/notifier.h>
  78 #include <linux/reboot.h>
  79 #include <linux/init.h>
  80 #include <linux/fs.h>
  81 #include <linux/pci.h>
  82 #include <linux/ioport.h>
  83
  84 #include <asm/uaccess.h>
  85 #include <asm/io.h>
  86
  87 #include "i8xx_tco.h"
  88
  89 /* Module and version information */
  90 #define TCO_VERSION "0.07"
  91 #define TCO_MODULE_NAME "i8xx TCO timer"
  92 #define TCO_DRIVER_NAME   TCO_MODULE_NAME ", v" TCO_VERSION
  93 #define PFX TCO_MODULE_NAME ": "
  94
  95 /* internal variables */
  96 static unsigned int ACPIBASE;
  97 static spinlock_t tco_lock;     /* Guards the hardware */
  98 static unsigned long timer_alive;
  99 static char tco_expect_close;
 100 static struct pci_dev *i8xx_tco_pci;
 101
 102 /* module parameters */
 103 #define WATCHDOG_HEARTBEAT 30   /* 30 sec default heartbeat (2<heartbeat<39) */
 104 static int heartbeat = WATCHDOG_HEARTBEAT;  /* in seconds */
 105 module_param(heartbeat, int, 0);
 106 MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. (2<heartbeat<39, default=" __MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
 107
 108 static int nowayout = WATCHDOG_NOWAYOUT;
 109 module_param(nowayout, int, 0);
 110 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
 111
 112 /*
 113  * Some TCO specific functions
 114  */
 115
 116 static inline unsigned char seconds_to_ticks(int seconds)
 117 {
 118         /* the internal timer is stored as ticks which decrement
 119          * every 0.6 seconds */
 120         return (seconds * 10) / 6;
 121 }
 122
 123 static int tco_timer_start (void)
 124 {
 125         unsigned char val;
 126
 127         spin_lock(&tco_lock);
 128         val = inb (TCO1_CNT + 1);
 129         val &= 0xf7;
 130         outb (val, TCO1_CNT + 1);
 131         val = inb (TCO1_CNT + 1);
 132         spin_unlock(&tco_lock);
 133
 134         if (val & 0x08)
 135                 return -1;
 136         return 0;
 137 }
 138
 139 static int tco_timer_stop (void)
 140 {
 141         unsigned char val;
 142
 143         spin_lock(&tco_lock);
 144         val = inb (TCO1_CNT + 1);
 145         val |= 0x08;
 146         outb (val, TCO1_CNT + 1);
 147         val = inb (TCO1_CNT + 1);
 148         spin_unlock(&tco_lock);
 149
 150         if ((val & 0x08) == 0)
 151                 return -1;
 152         return 0;
 153 }
 154
 155 static int tco_timer_keepalive (void)
 156 {
 157         spin_lock(&tco_lock);
 158         outb (0x01, TCO1_RLD);
 159         spin_unlock(&tco_lock);
 160         return 0;
 161 }
 162
 163 static int tco_timer_set_heartbeat (int t)
 164 {
 165         unsigned char val;
 166         unsigned char tmrval;
 167
 168         tmrval = seconds_to_ticks(t);
 169         /* from the specs: */
 170         /* "Values of 0h-3h are ignored and should not be attempted" */
 171         if (tmrval > 0x3f || tmrval < 0x04)
 172                 return -EINVAL;
 173
 174         /* Write new heartbeat to watchdog */
 175         spin_lock(&tco_lock);
 176         val = inb (TCO1_TMR);
 177         val &= 0xc0;
 178         val |= tmrval;
 179         outb (val, TCO1_TMR);
 180         val = inb (TCO1_TMR);
 181         spin_unlock(&tco_lock);
 182
 183         if ((val & 0x3f) != tmrval)
 184                 return -EINVAL;
 185
 186         heartbeat = t;
 187         return 0;
 188 }
 189
 190 /*
 191  *      /dev/watchdog handling
 192  */
 193
 194 static int i8xx_tco_open (struct inode *inode, struct file *file)
 195 {
 196         /* /dev/watchdog can only be opened once */
 197         if (test_and_set_bit(0, &timer_alive))
 198                 return -EBUSY;
 199
 200         /*
 201          *      Reload and activate timer
 202          */
 203         tco_timer_keepalive ();
 204         tco_timer_start ();
 205         return nonseekable_open(inode, file);
 206 }
 207
 208 static int i8xx_tco_release (struct inode *inode, struct file *file)
 209 {
 210         /*
 211          *      Shut off the timer.
 212          */
 213         if (tco_expect_close == 42) {
 214                 tco_timer_stop ();
 215         } else {
 216                 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
 217                 tco_timer_keepalive ();
 218         }
 219         clear_bit(0, &timer_alive);
 220         tco_expect_close = 0;
 221         return 0;
 222 }
 223
 224 static ssize_t i8xx_tco_write (struct file *file, const char __user *data,
 225                               size_t len, loff_t * ppos)
 226 {
 227         /* See if we got the magic character 'V' and reload the timer */
 228         if (len) {
 229                 if (!nowayout) {
 230                         size_t i;
 231
 232                         /* note: just in case someone wrote the magic character
 233                          * five months ago... */
 234                         tco_expect_close = 0;
 235
 236                         /* scan to see whether or not we got the magic character */
 237                         for (i = 0; i != len; i++) {
 238                                 char c;
 239                                 if(get_user(c, data+i))
 240                                         return -EFAULT;
 241                                 if (c == 'V')
 242                                         tco_expect_close = 42;
 243                         }
 244                 }
 245
 246                 /* someone wrote to us, we should reload the timer */
 247                 tco_timer_keepalive ();
 248         }
 249         return len;
 250 }
 251
 252 static int i8xx_tco_ioctl (struct inode *inode, struct file *file,
 253                           unsigned int cmd, unsigned long arg)
 254 {
 255         int new_options, retval = -EINVAL;
 256         int new_heartbeat;
 257         void __user *argp = (void __user *)arg;
 258         int __user *p = argp;
 259         static struct watchdog_info ident = {
 260                 .options =              WDIOF_SETTIMEOUT |
 261                                         WDIOF_KEEPALIVEPING |
 262                                         WDIOF_MAGICCLOSE,
 263                 .firmware_version =     0,
 264                 .identity =             TCO_MODULE_NAME,
 265         };
 266
 267         switch (cmd) {
 268                 case WDIOC_GETSUPPORT:
 269                         return copy_to_user(argp, &ident,
 270                                 sizeof (ident)) ? -EFAULT : 0;
 271
 272                 case WDIOC_GETSTATUS:
 273                 case WDIOC_GETBOOTSTATUS:
 274                         return put_user (0, p);
 275
 276                 case WDIOC_KEEPALIVE:
 277                         tco_timer_keepalive ();
 278                         return 0;
 279
 280                 case WDIOC_SETOPTIONS:
 281                 {
 282                         if (get_user (new_options, p))
 283                                 return -EFAULT;
 284
 285                         if (new_options & WDIOS_DISABLECARD) {
 286                                 tco_timer_stop ();
 287                                 retval = 0;
 288                         }
 289
 290                         if (new_options & WDIOS_ENABLECARD) {
 291                                 tco_timer_keepalive ();
 292                                 tco_timer_start ();
 293                                 retval = 0;
 294                         }
 295
 296                         return retval;
 297                 }
 298
 299                 case WDIOC_SETTIMEOUT:
 300                 {
 301                         if (get_user(new_heartbeat, p))
 302                                 return -EFAULT;
 303
 304                         if (tco_timer_set_heartbeat(new_heartbeat))
 305                             return -EINVAL;
 306
 307                         tco_timer_keepalive ();
 308                         /* Fall */
 309                 }
 310
 311                 case WDIOC_GETTIMEOUT:
 312                         return put_user(heartbeat, p);
 313
 314                 default:
 315                         return -ENOIOCTLCMD;
 316         }
 317 }
 318
 319 /*
 320  *      Notify system
 321  */
 322
 323 static int i8xx_tco_notify_sys (struct notifier_block *this, unsigned long code, void *unused)
 324 {
 325         if (code==SYS_DOWN || code==SYS_HALT) {
 326                 /* Turn the WDT off */
 327                 tco_timer_stop ();
 328         }
 329
 330         return NOTIFY_DONE;
 331 }
 332
 333 /*
 334  *      Kernel Interfaces
 335  */
 336
 337 static struct file_operations i8xx_tco_fops = {
 338         .owner =        THIS_MODULE,
 339         .llseek =       no_llseek,
 340         .write =        i8xx_tco_write,
 341         .ioctl =        i8xx_tco_ioctl,
 342         .open =         i8xx_tco_open,
 343         .release =      i8xx_tco_release,
 344 };
 345
 346 static struct miscdevice i8xx_tco_miscdev = {
 347         .minor =        WATCHDOG_MINOR,
 348         .name =         "watchdog",
 349         .fops =         &i8xx_tco_fops,
 350 };
 351
 352 static struct notifier_block i8xx_tco_notifier = {
 353         .notifier_call =        i8xx_tco_notify_sys,
 354 };
 355
 356 /*
 357  * Data for PCI driver interface
 358  *
 359  * This data only exists for exporting the supported
 360  * PCI ids via MODULE_DEVICE_TABLE.  We do not actually
 361  * register a pci_driver, because someone else might one day
 362  * want to register another driver on the same PCI id.
 363  */
 364 static struct pci_device_id i8xx_tco_pci_tbl[] = {
 365         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AA_0,   PCI_ANY_ID, PCI_ANY_ID, },
 366         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AB_0,   PCI_ANY_ID, PCI_ANY_ID, },
 367         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801BA_0,   PCI_ANY_ID, PCI_ANY_ID, },
 368         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801BA_10,  PCI_ANY_ID, PCI_ANY_ID, },
 369         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801CA_0,   PCI_ANY_ID, PCI_ANY_ID, },
 370         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801CA_12,  PCI_ANY_ID, PCI_ANY_ID, },
 371         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801DB_0,   PCI_ANY_ID, PCI_ANY_ID, },
 372         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801DB_12,  PCI_ANY_ID, PCI_ANY_ID, },
 373         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801E_0,    PCI_ANY_ID, PCI_ANY_ID, },
 374         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801EB_0,   PCI_ANY_ID, PCI_ANY_ID, },
 375         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH6_0,      PCI_ANY_ID, PCI_ANY_ID, },
 376         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH6_1,      PCI_ANY_ID, PCI_ANY_ID, },
 377         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH6_2,      PCI_ANY_ID, PCI_ANY_ID, },
 378         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH7_0,      PCI_ANY_ID, PCI_ANY_ID, },
 379         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH7_1,      PCI_ANY_ID, PCI_ANY_ID, },
 380         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ESB_1,       PCI_ANY_ID, PCI_ANY_ID, },
 381         { 0, },                 /* End of list */
 382 };
 383 MODULE_DEVICE_TABLE (pci, i8xx_tco_pci_tbl);
 384
 385 /*
 386  *      Init & exit routines
 387  */
 388
 389 static unsigned char __init i8xx_tco_getdevice (void)
 390 {
 391         struct pci_dev *dev = NULL;
 392         u8 val1, val2;
 393         u16 badr;
 394         /*
 395          *      Find the PCI device
 396          */
 397
 398         while ((dev = pci_find_device(PCI_ANY_ID, PCI_ANY_ID, dev)) != NULL) {
 399                 if (pci_match_id(i8xx_tco_pci_tbl, dev)) {
 400                         i8xx_tco_pci = dev;
 401                         break;
 402                 }
 403         }
 404
 405         if (i8xx_tco_pci) {
 406                 /*
 407                  *      Find the ACPI base I/O address which is the base
 408                  *      for the TCO registers (TCOBASE=ACPIBASE + 0x60)
 409                  *      ACPIBASE is bits [15:7] from 0x40-0x43
 410                  */
 411                 pci_read_config_byte (i8xx_tco_pci, 0x40, &val1);
 412                 pci_read_config_byte (i8xx_tco_pci, 0x41, &val2);
 413                 badr = ((val2 << 1) | (val1 >> 7)) << 7;
 414                 ACPIBASE = badr;
 415                 /* Something's wrong here, ACPIBASE has to be set */
 416                 if (badr == 0x0001 || badr == 0x0000) {
 417                         printk (KERN_ERR PFX "failed to get TCOBASE address\n");
 418                         return 0;
 419                 }
 420                 /*
 421                  * Check chipset's NO_REBOOT bit
 422                  */
 423                 pci_read_config_byte (i8xx_tco_pci, 0xd4, &val1);
 424                 if (val1 & 0x02) {
 425                         val1 &= 0xfd;
 426                         pci_write_config_byte (i8xx_tco_pci, 0xd4, val1);
 427                         pci_read_config_byte (i8xx_tco_pci, 0xd4, &val1);
 428                         if (val1 & 0x02) {
 429                                 printk (KERN_ERR PFX "failed to reset NO_REBOOT flag, reboot disabled by hardware\n");
 430                                 return 0;       /* Cannot reset NO_REBOOT bit */
 431                         }
 432                 }
 433                 /* Set the TCO_EN bit in SMI_EN register */
 434                 if (!request_region (SMI_EN + 1, 1, "i8xx TCO")) {
 435                         printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 436                                 SMI_EN + 1);
 437                         return 0;
 438                 }
 439                 val1 = inb (SMI_EN + 1);
 440                 val1 &= 0xdf;
 441                 outb (val1, SMI_EN + 1);
 442                 release_region (SMI_EN + 1, 1);
 443                 return 1;
 444         }
 445         return 0;
 446 }
 447
 448 static int __init watchdog_init (void)
 449 {
 450         int ret;
 451
 452         spin_lock_init(&tco_lock);
 453
 454         /* Check whether or not the hardware watchdog is there */
 455         if (!i8xx_tco_getdevice () || i8xx_tco_pci == NULL)
 456                 return -ENODEV;
 457
 458         if (!request_region (TCOBASE, 0x10, "i8xx TCO")) {
 459                 printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 460                         TCOBASE);
 461                 ret = -EIO;
 462                 goto out;
 463         }
 464
 465         /* Clear out the (probably old) status */
 466         outb (0, TCO1_STS);
 467         outb (3, TCO2_STS);
 468
 469         /* Check that the heartbeat value is within it's range ; if not reset to the default */
 470         if (tco_timer_set_heartbeat (heartbeat)) {
 471                 heartbeat = WATCHDOG_HEARTBEAT;
 472                 tco_timer_set_heartbeat (heartbeat);
 473                 printk(KERN_INFO PFX "heartbeat value must be 2<heartbeat<39, using %d\n",
 474                         heartbeat);
 475         }
 476
 477         ret = register_reboot_notifier(&i8xx_tco_notifier);
 478         if (ret != 0) {
 479                 printk(KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
 480                         ret);
 481                 goto unreg_region;
 482         }
 483
 484         ret = misc_register(&i8xx_tco_miscdev);
 485         if (ret != 0) {
 486                 printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 487                         WATCHDOG_MINOR, ret);
 488                 goto unreg_notifier;
 489         }
 490
 491         tco_timer_stop ();
 492
 493         printk (KERN_INFO PFX "initialized (0x%04x). heartbeat=%d sec (nowayout=%d)\n",
 494                 TCOBASE, heartbeat, nowayout);
 495
 496         return 0;
 497
 498 unreg_notifier:
 499         unregister_reboot_notifier(&i8xx_tco_notifier);
 500 unreg_region:
 501         release_region (TCOBASE, 0x10);
 502 out:
 503         return ret;
 504 }
 505
 506 static void __exit watchdog_cleanup (void)
 507 {
 508         u8 val;
 509
 510         /* Stop the timer before we leave */
 511         if (!nowayout)
 512                 tco_timer_stop ();
 513
 514         /* Set the NO_REBOOT bit to prevent later reboots, just for sure */
 515         pci_read_config_byte (i8xx_tco_pci, 0xd4, &val);
 516         val |= 0x02;
 517         pci_write_config_byte (i8xx_tco_pci, 0xd4, val);
 518
 519         /* Deregister */
 520         misc_deregister (&i8xx_tco_miscdev);
 521         unregister_reboot_notifier(&i8xx_tco_notifier);
 522         release_region (TCOBASE, 0x10);
 523 }
 524
 525 module_init(watchdog_init);
 526 module_exit(watchdog_cleanup);
 527
 528 MODULE_AUTHOR("Nils Faerber");
 529 MODULE_DESCRIPTION("TCO timer driver for i8xx chipsets");
 530 MODULE_LICENSE("GPL");
 531 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);