drivers/char/watchdog/advantechwdt.c

   1 /*
   2  *      Advantech Single Board Computer WDT driver
   3  *
   4  *      (c) Copyright 2000-2001 Marek Michalkiewicz <marekm@linux.org.pl>
   5  *
   6  *      Based on acquirewdt.c which is based on wdt.c.
   7  *      Original copyright messages:
   8  *
   9  *      (c) Copyright 1996 Alan Cox <alan@redhat.com>, All Rights Reserved.
  10  *                              http://www.redhat.com
  11  *
  12  *      This program is free software; you can redistribute it and/or
  13  *      modify it under the terms of the GNU General Public License
  14  *      as published by the Free Software Foundation; either version
  15  *      2 of the License, or (at your option) any later version.
  16  *
  17  *      Neither Alan Cox nor CymruNet Ltd. admit liability nor provide
  18  *      warranty for any of this software. This material is provided
  19  *      "AS-IS" and at no charge.
  20  *
  21  *      (c) Copyright 1995    Alan Cox <alan@redhat.com>
  22  *
  23  *      14-Dec-2001 Matt Domsch <Matt_Domsch@dell.com>
  24  *          Added nowayout module option to override CONFIG_WATCHDOG_NOWAYOUT
  25  *
  26  *      16-Oct-2002 Rob Radez <rob@osinvestor.com>
  27  *          Clean up ioctls, clean up init + exit, add expect close support,
  28  *          add wdt_start and wdt_stop as parameters.
  29  */
  30
  31 #include <linux/module.h>
  32 #include <linux/moduleparam.h>
  33 #include <linux/types.h>
  34 #include <linux/miscdevice.h>
  35 #include <linux/watchdog.h>
  36 #include <linux/fs.h>
  37 #include <linux/ioport.h>
  38 #include <linux/notifier.h>
  39 #include <linux/reboot.h>
  40 #include <linux/init.h>
  41
  42 #include <asm/io.h>
  43 #include <asm/uaccess.h>
  44 #include <asm/system.h>
  45
  46 #define WATCHDOG_NAME "Advantech WDT"
  47 #define PFX WATCHDOG_NAME ": "
  48 #define WATCHDOG_TIMEOUT 60             /* 60 sec default timeout */
  49
  50 static unsigned long advwdt_is_open;
  51 static char adv_expect_close;
  52
  53 /*
  54  *      You must set these - there is no sane way to probe for this board.
  55  *
  56  *      To enable or restart, write the timeout value in seconds (1 to 63)
  57  *      to I/O port wdt_start.  To disable, read I/O port wdt_stop.
  58  *      Both are 0x443 for most boards (tested on a PCA-6276VE-00B1), but
  59  *      check your manual (at least the PCA-6159 seems to be different -
  60  *      the manual says wdt_stop is 0x43, not 0x443).
  61  *      (0x43 is also a write-only control register for the 8254 timer!)
  62  */
  63
  64 static int wdt_stop = 0x443;
  65 module_param(wdt_stop, int, 0);
  66 MODULE_PARM_DESC(wdt_stop, "Advantech WDT 'stop' io port (default 0x443)");
  67
  68 static int wdt_start = 0x443;
  69 module_param(wdt_start, int, 0);
  70 MODULE_PARM_DESC(wdt_start, "Advantech WDT 'start' io port (default 0x443)");
  71
  72 static int timeout = WATCHDOG_TIMEOUT;  /* in seconds */
  73 module_param(timeout, int, 0);
  74 MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds. 1<= timeout <=63, default=" __MODULE_STRING(WATCHDOG_TIMEOUT) ".");
  75
  76 #ifdef CONFIG_WATCHDOG_NOWAYOUT
  77 static int nowayout = 1;
  78 #else
  79 static int nowayout = 0;
  80 #endif
  81
  82 module_param(nowayout, int, 0);
  83 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
  84
  85 /*
  86  *      Kernel methods.
  87  */
  88
  89 static void
  90 advwdt_ping(void)
  91 {
  92         /* Write a watchdog value */
  93         outb_p(timeout, wdt_start);
  94 }
  95
  96 static void
  97 advwdt_disable(void)
  98 {
  99         inb_p(wdt_stop);
 100 }
 101
 102 static ssize_t
 103 advwdt_write(struct file *file, const char *buf, size_t count, loff_t *ppos)
 104 {
 105         /*  Can't seek (pwrite) on this device  */
 106         if (ppos != &file->f_pos)
 107                 return -ESPIPE;
 108
 109         if (count) {
 110                 if (!nowayout) {
 111                         size_t i;
 112
 113                         adv_expect_close = 0;
 114
 115                         for (i = 0; i != count; i++) {
 116                                 char c;
 117                                 if (get_user(c, buf+i))
 118                                         return -EFAULT;
 119                                 if (c == 'V')
 120                                         adv_expect_close = 42;
 121                         }
 122                 }
 123                 advwdt_ping();
 124         }
 125         return count;
 126 }
 127
 128 static int
 129 advwdt_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
 130           unsigned long arg)
 131 {
 132         int new_timeout;
 133         static struct watchdog_info ident = {
 134                 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
 135                 .firmware_version = 1,
 136                 .identity = "Advantech WDT",
 137         };
 138
 139         switch (cmd) {
 140         case WDIOC_GETSUPPORT:
 141           if (copy_to_user((struct watchdog_info *)arg, &ident, sizeof(ident)))
 142             return -EFAULT;
 143           break;
 144
 145         case WDIOC_GETSTATUS:
 146         case WDIOC_GETBOOTSTATUS:
 147           return put_user(0, (int *)arg);
 148
 149         case WDIOC_KEEPALIVE:
 150           advwdt_ping();
 151           break;
 152
 153         case WDIOC_SETTIMEOUT:
 154           if (get_user(new_timeout, (int *)arg))
 155                   return -EFAULT;
 156           if ((new_timeout < 1) || (new_timeout > 63))
 157                   return -EINVAL;
 158           timeout = new_timeout;
 159           advwdt_ping();
 160           /* Fall */
 161
 162         case WDIOC_GETTIMEOUT:
 163           return put_user(timeout, (int *)arg);
 164
 165         case WDIOC_SETOPTIONS:
 166         {
 167           int options, retval = -EINVAL;
 168
 169           if (get_user(options, (int *)arg))
 170             return -EFAULT;
 171
 172           if (options & WDIOS_DISABLECARD) {
 173             advwdt_disable();
 174             retval = 0;
 175           }
 176
 177           if (options & WDIOS_ENABLECARD) {
 178             advwdt_ping();
 179             retval = 0;
 180           }
 181
 182           return retval;
 183         }
 184
 185         default:
 186           return -ENOIOCTLCMD;
 187         }
 188         return 0;
 189 }
 190
 191 static int
 192 advwdt_open(struct inode *inode, struct file *file)
 193 {
 194         if (test_and_set_bit(0, &advwdt_is_open))
 195                 return -EBUSY;
 196         /*
 197          *      Activate
 198          */
 199
 200         advwdt_ping();
 201         return 0;
 202 }
 203
 204 static int
 205 advwdt_close(struct inode *inode, struct file *file)
 206 {
 207         if (adv_expect_close == 42) {
 208                 advwdt_disable();
 209         } else {
 210                 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
 211                 advwdt_ping();
 212         }
 213         clear_bit(0, &advwdt_is_open);
 214         adv_expect_close = 0;
 215         return 0;
 216 }
 217
 218 /*
 219  *      Notifier for system down
 220  */
 221
 222 static int
 223 advwdt_notify_sys(struct notifier_block *this, unsigned long code,
 224         void *unused)
 225 {
 226         if (code == SYS_DOWN || code == SYS_HALT) {
 227                 /* Turn the WDT off */
 228                 advwdt_disable();
 229         }
 230         return NOTIFY_DONE;
 231 }
 232
 233 /*
 234  *      Kernel Interfaces
 235  */
 236
 237 static struct file_operations advwdt_fops = {
 238         .owner          = THIS_MODULE,
 239         .llseek         = no_llseek,
 240         .write          = advwdt_write,
 241         .ioctl          = advwdt_ioctl,
 242         .open           = advwdt_open,
 243         .release        = advwdt_close,
 244 };
 245
 246 static struct miscdevice advwdt_miscdev = {
 247         .minor = WATCHDOG_MINOR,
 248         .name = "watchdog",
 249         .fops = &advwdt_fops,
 250 };
 251
 252 /*
 253  *      The WDT needs to learn about soft shutdowns in order to
 254  *      turn the timebomb registers off.
 255  */
 256
 257 static struct notifier_block advwdt_notifier = {
 258         .notifier_call = advwdt_notify_sys,
 259 };
 260
 261 static int __init
 262 advwdt_init(void)
 263 {
 264         int ret;
 265
 266         printk(KERN_INFO "WDT driver for Advantech single board computer initialising.\n");
 267
 268         if (timeout < 1 || timeout > 63) {
 269                 timeout = WATCHDOG_TIMEOUT;
 270                 printk (KERN_INFO PFX "timeout value must be 1<=x<=63, using %d\n",
 271                         timeout);
 272         }
 273
 274         if (wdt_stop != wdt_start) {
 275                 if (!request_region(wdt_stop, 1, WATCHDOG_NAME)) {
 276                         printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 277                                 wdt_stop);
 278                         ret = -EIO;
 279                         goto out;
 280                 }
 281         }
 282
 283         if (!request_region(wdt_start, 1, WATCHDOG_NAME)) {
 284                 printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 285                         wdt_start);
 286                 ret = -EIO;
 287                 goto unreg_stop;
 288         }
 289
 290         ret = register_reboot_notifier(&advwdt_notifier);
 291         if (ret != 0) {
 292                 printk (KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
 293                         ret);
 294                 goto unreg_regions;
 295         }
 296
 297         ret = misc_register(&advwdt_miscdev);
 298         if (ret != 0) {
 299                 printk (KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 300                         WATCHDOG_MINOR, ret);
 301                 goto unreg_reboot;
 302         }
 303
 304         printk (KERN_INFO PFX "initialized. timeout=%d sec (nowayout=%d)\n",
 305                 timeout, nowayout);
 306
 307 out:
 308         return ret;
 309 unreg_reboot:
 310         unregister_reboot_notifier(&advwdt_notifier);
 311 unreg_regions:
 312         release_region(wdt_start, 1);
 313 unreg_stop:
 314         if (wdt_stop != wdt_start)
 315                 release_region(wdt_stop, 1);
 316         goto out;
 317 }
 318
 319 static void __exit
 320 advwdt_exit(void)
 321 {
 322         misc_deregister(&advwdt_miscdev);
 323         unregister_reboot_notifier(&advwdt_notifier);
 324         if(wdt_stop != wdt_start)
 325                 release_region(wdt_stop,1);
 326         release_region(wdt_start,1);
 327 }
 328
 329 module_init(advwdt_init);
 330 module_exit(advwdt_exit);
 331
 332 MODULE_LICENSE("GPL");
 333 MODULE_AUTHOR("Marek Michalkiewicz <marekm@linux.org.pl>");
 334 MODULE_DESCRIPTION("Advantech Single Board Computer WDT driver");
 335 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);