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 #ifdef CONFIG_WATCHDOG_NOWAYOUT
  58 static int nowayout = 1;
  59 #else
  60 static int nowayout = 0;
  61 #endif
  62
  63 module_param(nowayout, int, 0);
  64 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
  65
  66 /*
  67  *      Kernel methods.
  68  */
  69
  70 #define WDT_EFER (wdt_io+0)   /* Extended Function Enable Registers */
  71 #define WDT_EFIR (wdt_io+0)   /* Extended Function Index Register (same as EFER) */
  72 #define WDT_EFDR (WDT_EFIR+1) /* Extended Function Data Register */
  73
  74 static void
  75 wdt_ctrl(int timeout)
  76 {
  77         outb_p(0x87, WDT_EFER); /* Enter extended function mode */
  78         outb_p(0x87, WDT_EFER); /* Again according to manual */
  79
  80         outb_p(0x07, WDT_EFER); /* point to logical device number reg */
  81         outb_p(0x08, WDT_EFDR); /* select logical device 8 (GPIO2) */
  82         outb_p(0x30, WDT_EFER); /* select CR30 */
  83         outb_p(0x01, WDT_EFDR); /* set bit 0 to activate GPIO2 */
  84
  85         outb_p(0xF6, WDT_EFER);    /* Select CRF6 */
  86         outb_p(timeout, WDT_EFDR); /* Write Timeout counter to CRF6 */
  87
  88         outb_p(0xAA, WDT_EFER); /* Leave extended function mode */
  89 }
  90
  91 static void
  92 wdt_ping(void)
  93 {
  94         wdt_ctrl(timeout);
  95 }
  96
  97 static void
  98 wdt_disable(void)
  99 {
 100         wdt_ctrl(0);
 101 }
 102
 103 static ssize_t
 104 wdt_write(struct file *file, const char *buf, size_t count, loff_t *ppos)
 105 {
 106         /*  Can't seek (pwrite) on this device  */
 107         if (ppos != &file->f_pos)
 108                 return -ESPIPE;
 109
 110         if (count) {
 111                 if (!nowayout) {
 112                         size_t i;
 113
 114                         expect_close = 0;
 115
 116                         for (i = 0; i != count; i++) {
 117                                 char c;
 118                                 if (get_user(c, buf+i))
 119                                         return -EFAULT;
 120                                 if (c == 'V')
 121                                         expect_close = 42;
 122                         }
 123                 }
 124                 wdt_ping();
 125         }
 126         return count;
 127 }
 128
 129 static int
 130 wdt_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
 131           unsigned long arg)
 132 {
 133         int new_timeout;
 134         static struct watchdog_info ident = {
 135                 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
 136                 .firmware_version = 1,
 137                 .identity = "Advantech WDT",
 138         };
 139
 140         switch (cmd) {
 141         case WDIOC_GETSUPPORT:
 142           if (copy_to_user((struct watchdog_info *)arg, &ident, sizeof(ident)))
 143             return -EFAULT;
 144           break;
 145
 146         case WDIOC_GETSTATUS:
 147         case WDIOC_GETBOOTSTATUS:
 148           return put_user(0, (int *)arg);
 149
 150         case WDIOC_KEEPALIVE:
 151           wdt_ping();
 152           break;
 153
 154         case WDIOC_SETTIMEOUT:
 155           if (get_user(new_timeout, (int *)arg))
 156                   return -EFAULT;
 157           if ((new_timeout < 1) || (new_timeout > 63))
 158                   return -EINVAL;
 159           timeout = new_timeout;
 160           wdt_ping();
 161           /* Fall */
 162
 163         case WDIOC_GETTIMEOUT:
 164           return put_user(timeout, (int *)arg);
 165
 166         case WDIOC_SETOPTIONS:
 167         {
 168           int options, retval = -EINVAL;
 169
 170           if (get_user(options, (int *)arg))
 171             return -EFAULT;
 172
 173           if (options & WDIOS_DISABLECARD) {
 174             wdt_disable();
 175             retval = 0;
 176           }
 177
 178           if (options & WDIOS_ENABLECARD) {
 179             wdt_ping();
 180             retval = 0;
 181           }
 182
 183           return retval;
 184         }
 185
 186         default:
 187           return -ENOIOCTLCMD;
 188         }
 189         return 0;
 190 }
 191
 192 static int
 193 wdt_open(struct inode *inode, struct file *file)
 194 {
 195         if (test_and_set_bit(0, &wdt_is_open))
 196                 return -EBUSY;
 197         /*
 198          *      Activate
 199          */
 200
 201         wdt_ping();
 202         return 0;
 203 }
 204
 205 static int
 206 wdt_close(struct inode *inode, struct file *file)
 207 {
 208         if (expect_close == 42) {
 209                 wdt_disable();
 210         } else {
 211                 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
 212                 wdt_ping();
 213         }
 214         clear_bit(0, &wdt_is_open);
 215         expect_close = 0;
 216         return 0;
 217 }
 218
 219 /*
 220  *      Notifier for system down
 221  */
 222
 223 static int
 224 wdt_notify_sys(struct notifier_block *this, unsigned long code,
 225         void *unused)
 226 {
 227         if (code == SYS_DOWN || code == SYS_HALT) {
 228                 /* Turn the WDT off */
 229                 wdt_disable();
 230         }
 231         return NOTIFY_DONE;
 232 }
 233
 234 /*
 235  *      Kernel Interfaces
 236  */
 237
 238 static struct file_operations wdt_fops = {
 239         .owner          = THIS_MODULE,
 240         .llseek         = no_llseek,
 241         .write          = wdt_write,
 242         .ioctl          = wdt_ioctl,
 243         .open           = wdt_open,
 244         .release        = wdt_close,
 245 };
 246
 247 static struct miscdevice wdt_miscdev = {
 248         .minor = WATCHDOG_MINOR,
 249         .name = "watchdog",
 250         .fops = &wdt_fops,
 251 };
 252
 253 /*
 254  *      The WDT needs to learn about soft shutdowns in order to
 255  *      turn the timebomb registers off.
 256  */
 257
 258 static struct notifier_block wdt_notifier = {
 259         .notifier_call = wdt_notify_sys,
 260 };
 261
 262 static int __init
 263 wdt_init(void)
 264 {
 265         int ret;
 266
 267         printk(KERN_INFO "WDT driver for Advantech single board computer initialising.\n");
 268
 269         if (timeout < 1 || timeout > 63) {
 270                 timeout = WATCHDOG_TIMEOUT;
 271                 printk (KERN_INFO PFX "timeout value must be 1<=x<=63, using %d\n",
 272                         timeout);
 273         }
 274
 275         if (!request_region(wdt_io, 1, WATCHDOG_NAME)) {
 276                 printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 277                         wdt_io);
 278                 ret = -EIO;
 279                 goto out;
 280         }
 281
 282         ret = register_reboot_notifier(&wdt_notifier);
 283         if (ret != 0) {
 284                 printk (KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
 285                         ret);
 286                 goto unreg_regions;
 287         }
 288
 289         ret = misc_register(&wdt_miscdev);
 290         if (ret != 0) {
 291                 printk (KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 292                         WATCHDOG_MINOR, ret);
 293                 goto unreg_reboot;
 294         }
 295
 296         printk (KERN_INFO PFX "initialized. timeout=%d sec (nowayout=%d)\n",
 297                 timeout, nowayout);
 298
 299 out:
 300         return ret;
 301 unreg_reboot:
 302         unregister_reboot_notifier(&wdt_notifier);
 303 unreg_regions:
 304         release_region(wdt_io, 1);
 305         goto out;
 306 }
 307
 308 static void __exit
 309 wdt_exit(void)
 310 {
 311         misc_deregister(&wdt_miscdev);
 312         unregister_reboot_notifier(&wdt_notifier);
 313         release_region(wdt_io,1);
 314 }
 315
 316 module_init(wdt_init);
 317 module_exit(wdt_exit);
 318
 319 MODULE_LICENSE("GPL");
 320 MODULE_AUTHOR("Pádraig Brady <P@draigBrady.com>");
 321 MODULE_DESCRIPTION("w38627hf WDT driver");
 322 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);