drivers/char/watchdog/w83627hf_wdt.c

   1 /*
   2  *      w83627hf WDT driver
   3  *
   4  *      (c) Copyright 2003 Pádraig Brady <P@draigBrady.com>
   5  *
   6  *      Based on advantechwdt.c which is based on wdt.c.
   7  *      Original copyright messages:
   8  *
   9  *      (c) Copyright 2000-2001 Marek Michalkiewicz <marekm@linux.org.pl>
  10  *
  11  *      (c) Copyright 1996 Alan Cox <alan@redhat.com>, All Rights Reserved.
  12  *                              http://www.redhat.com
  13  *
  14  *      This program is free software; you can redistribute it and/or
  15  *      modify it under the terms of the GNU General Public License
  16  *      as published by the Free Software Foundation; either version
  17  *      2 of the License, or (at your option) any later version.
  18  *
  19  *      Neither Alan Cox nor CymruNet Ltd. admit liability nor provide
  20  *      warranty for any of this software. This material is provided
  21  *      "AS-IS" and at no charge.
  22  *
  23  *      (c) Copyright 1995    Alan Cox <alan@redhat.com>
  24  */
  25
  26 #include <linux/module.h>
  27 #include <linux/moduleparam.h>
  28 #include <linux/types.h>
  29 #include <linux/miscdevice.h>
  30 #include <linux/watchdog.h>
  31 #include <linux/fs.h>
  32 #include <linux/ioport.h>
  33 #include <linux/notifier.h>
  34 #include <linux/reboot.h>
  35 #include <linux/init.h>
  36
  37 #include <asm/io.h>
  38 #include <asm/uaccess.h>
  39 #include <asm/system.h>
  40
  41 #define WATCHDOG_NAME "w83627hf WDT"
  42 #define PFX WATCHDOG_NAME ": "
  43 #define WATCHDOG_TIMEOUT 60             /* 60 sec default timeout */
  44
  45 static unsigned long wdt_is_open;
  46 static char expect_close;
  47
  48 /* You must set this - there is no sane way to probe for this board. */
  49 static int wdt_io = 0x2E;
  50 module_param(wdt_io, int, 0);
  51 MODULE_PARM_DESC(wdt_io, "w83627hf WDT io port (default 0x2E)");
  52
  53 static int timeout = WATCHDOG_TIMEOUT;  /* in seconds */
  54 module_param(timeout, int, 0);
  55 MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds. 1<= timeout <=63, default=" __MODULE_STRING(WATCHDOG_TIMEOUT) ".");
  56
  57 static int nowayout = WATCHDOG_NOWAYOUT;
  58 module_param(nowayout, int, 0);
  59 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
  60
  61 /*
  62  *      Kernel methods.
  63  */
  64
  65 #define WDT_EFER (wdt_io+0)   /* Extended Function Enable Registers */
  66 #define WDT_EFIR (wdt_io+0)   /* Extended Function Index Register (same as EFER) */
  67 #define WDT_EFDR (WDT_EFIR+1) /* Extended Function Data Register */
  68
  69 static void
  70 w83627hf_select_wd_register(void)
  71 {
  72         outb_p(0x87, WDT_EFER); /* Enter extended function mode */
  73         outb_p(0x87, WDT_EFER); /* Again according to manual */
  74
  75         outb_p(0x07, WDT_EFER); /* point to logical device number reg */
  76         outb_p(0x08, WDT_EFDR); /* select logical device 8 (GPIO2) */
  77         outb_p(0x30, WDT_EFER); /* select CR30 */
  78         outb_p(0x01, WDT_EFDR); /* set bit 0 to activate GPIO2 */
  79 }
  80
  81 static void
  82 w83627hf_unselect_wd_register(void)
  83 {
  84         outb_p(0xAA, WDT_EFER); /* Leave extended function mode */
  85 }
  86
  87 /* tyan motherboards seem to set F5 to 0x4C ?
  88  * So explicitly init to appropriate value. */
  89 static void
  90 w83627hf_init(void)
  91 {
  92         unsigned char t;
  93
  94         w83627hf_select_wd_register();
  95
  96         outb_p(0xF5, WDT_EFER); /* Select CRF5 */
  97         t=inb_p(WDT_EFDR);      /* read CRF5 */
  98         t&=~0x0C;               /* set second mode & disable keyboard turning off watchdog */
  99         outb_p(t, WDT_EFDR);    /* Write back to CRF5 */
 100
 101         w83627hf_unselect_wd_register();
 102 }
 103
 104 static void
 105 wdt_ctrl(int timeout)
 106 {
 107         w83627hf_select_wd_register();
 108
 109         outb_p(0xF6, WDT_EFER);    /* Select CRF6 */
 110         outb_p(timeout, WDT_EFDR); /* Write Timeout counter to CRF6 */
 111
 112         w83627hf_unselect_wd_register();
 113 }
 114
 115 static int
 116 wdt_ping(void)
 117 {
 118         wdt_ctrl(timeout);
 119         return 0;
 120 }
 121
 122 static int
 123 wdt_disable(void)
 124 {
 125         wdt_ctrl(0);
 126         return 0;
 127 }
 128
 129 static int
 130 wdt_set_heartbeat(int t)
 131 {
 132         if ((t < 1) || (t > 63))
 133                 return -EINVAL;
 134
 135         timeout = t;
 136         return 0;
 137 }
 138
 139 static ssize_t
 140 wdt_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
 141 {
 142         if (count) {
 143                 if (!nowayout) {
 144                         size_t i;
 145
 146                         expect_close = 0;
 147
 148                         for (i = 0; i != count; i++) {
 149                                 char c;
 150                                 if (get_user(c, buf+i))
 151                                         return -EFAULT;
 152                                 if (c == 'V')
 153                                         expect_close = 42;
 154                         }
 155                 }
 156                 wdt_ping();
 157         }
 158         return count;
 159 }
 160
 161 static int
 162 wdt_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
 163           unsigned long arg)
 164 {
 165         void __user *argp = (void __user *)arg;
 166         int __user *p = argp;
 167         int new_timeout;
 168         static struct watchdog_info ident = {
 169                 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
 170                 .firmware_version = 1,
 171                 .identity = "W83627HF WDT",
 172         };
 173
 174         switch (cmd) {
 175         case WDIOC_GETSUPPORT:
 176           if (copy_to_user(argp, &ident, sizeof(ident)))
 177             return -EFAULT;
 178           break;
 179
 180         case WDIOC_GETSTATUS:
 181         case WDIOC_GETBOOTSTATUS:
 182           return put_user(0, p);
 183
 184         case WDIOC_KEEPALIVE:
 185           wdt_ping();
 186           break;
 187
 188         case WDIOC_SETTIMEOUT:
 189           if (get_user(new_timeout, p))
 190                   return -EFAULT;
 191           if (wdt_set_heartbeat(new_timeout))
 192                   return -EINVAL;
 193           wdt_ping();
 194           /* Fall */
 195
 196         case WDIOC_GETTIMEOUT:
 197           return put_user(timeout, p);
 198
 199         case WDIOC_SETOPTIONS:
 200         {
 201           int options, retval = -EINVAL;
 202
 203           if (get_user(options, p))
 204             return -EFAULT;
 205
 206           if (options & WDIOS_DISABLECARD) {
 207             wdt_disable();
 208             retval = 0;
 209           }
 210
 211           if (options & WDIOS_ENABLECARD) {
 212             wdt_ping();
 213             retval = 0;
 214           }
 215
 216           return retval;
 217         }
 218
 219         default:
 220           return -ENOIOCTLCMD;
 221         }
 222         return 0;
 223 }
 224
 225 static int
 226 wdt_open(struct inode *inode, struct file *file)
 227 {
 228         if (test_and_set_bit(0, &wdt_is_open))
 229                 return -EBUSY;
 230         /*
 231          *      Activate
 232          */
 233
 234         wdt_ping();
 235         return nonseekable_open(inode, file);
 236 }
 237
 238 static int
 239 wdt_close(struct inode *inode, struct file *file)
 240 {
 241         if (expect_close == 42) {
 242                 wdt_disable();
 243         } else {
 244                 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
 245                 wdt_ping();
 246         }
 247         expect_close = 0;
 248         clear_bit(0, &wdt_is_open);
 249         return 0;
 250 }
 251
 252 /*
 253  *      Notifier for system down
 254  */
 255
 256 static int
 257 wdt_notify_sys(struct notifier_block *this, unsigned long code,
 258         void *unused)
 259 {
 260         if (code == SYS_DOWN || code == SYS_HALT) {
 261                 /* Turn the WDT off */
 262                 wdt_disable();
 263         }
 264         return NOTIFY_DONE;
 265 }
 266
 267 /*
 268  *      Kernel Interfaces
 269  */
 270
 271 static struct file_operations wdt_fops = {
 272         .owner          = THIS_MODULE,
 273         .llseek         = no_llseek,
 274         .write          = wdt_write,
 275         .ioctl          = wdt_ioctl,
 276         .open           = wdt_open,
 277         .release        = wdt_close,
 278 };
 279
 280 static struct miscdevice wdt_miscdev = {
 281         .minor = WATCHDOG_MINOR,
 282         .name = "watchdog",
 283         .fops = &wdt_fops,
 284 };
 285
 286 /*
 287  *      The WDT needs to learn about soft shutdowns in order to
 288  *      turn the timebomb registers off.
 289  */
 290
 291 static struct notifier_block wdt_notifier = {
 292         .notifier_call = wdt_notify_sys,
 293 };
 294
 295 static int __init
 296 wdt_init(void)
 297 {
 298         int ret;
 299
 300         printk(KERN_INFO "WDT driver for the Winbond(TM) W83627HF Super I/O chip initialising.\n");
 301
 302         if (wdt_set_heartbeat(timeout)) {
 303                 wdt_set_heartbeat(WATCHDOG_TIMEOUT);
 304                 printk (KERN_INFO PFX "timeout value must be 1<=timeout<=63, using %d\n",
 305                         WATCHDOG_TIMEOUT);
 306         }
 307
 308         if (!request_region(wdt_io, 1, WATCHDOG_NAME)) {
 309                 printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 310                         wdt_io);
 311                 ret = -EIO;
 312                 goto out;
 313         }
 314
 315         w83627hf_init();
 316
 317         ret = register_reboot_notifier(&wdt_notifier);
 318         if (ret != 0) {
 319                 printk (KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
 320                         ret);
 321                 goto unreg_regions;
 322         }
 323
 324         ret = misc_register(&wdt_miscdev);
 325         if (ret != 0) {
 326                 printk (KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 327                         WATCHDOG_MINOR, ret);
 328                 goto unreg_reboot;
 329         }
 330
 331         printk (KERN_INFO PFX "initialized. timeout=%d sec (nowayout=%d)\n",
 332                 timeout, nowayout);
 333
 334 out:
 335         return ret;
 336 unreg_reboot:
 337         unregister_reboot_notifier(&wdt_notifier);
 338 unreg_regions:
 339         release_region(wdt_io, 1);
 340         goto out;
 341 }
 342
 343 static void __exit
 344 wdt_exit(void)
 345 {
 346         misc_deregister(&wdt_miscdev);
 347         unregister_reboot_notifier(&wdt_notifier);
 348         release_region(wdt_io,1);
 349 }
 350
 351 module_init(wdt_init);
 352 module_exit(wdt_exit);
 353
 354 MODULE_LICENSE("GPL");
 355 MODULE_AUTHOR("Pádraig Brady <P@draigBrady.com>");
 356 MODULE_DESCRIPTION("w38627hf WDT driver");
 357 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);