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 __user *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         void __user *argp = (void __user *)arg;
 134         int __user *p = argp;
 135         static struct watchdog_info ident = {
 136                 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
 137                 .firmware_version = 1,
 138                 .identity = "Advantech WDT",
 139         };
 140
 141         switch (cmd) {
 142         case WDIOC_GETSUPPORT:
 143           if (copy_to_user(argp, &ident, sizeof(ident)))
 144             return -EFAULT;
 145           break;
 146
 147         case WDIOC_GETSTATUS:
 148         case WDIOC_GETBOOTSTATUS:
 149           return put_user(0, p);
 150
 151         case WDIOC_KEEPALIVE:
 152           advwdt_ping();
 153           break;
 154
 155         case WDIOC_SETTIMEOUT:
 156           if (get_user(new_timeout, p))
 157                   return -EFAULT;
 158           if ((new_timeout < 1) || (new_timeout > 63))
 159                   return -EINVAL;
 160           timeout = new_timeout;
 161           advwdt_ping();
 162           /* Fall */
 163
 164         case WDIOC_GETTIMEOUT:
 165           return put_user(timeout, p);
 166
 167         case WDIOC_SETOPTIONS:
 168         {
 169           int options, retval = -EINVAL;
 170
 171           if (get_user(options, p))
 172             return -EFAULT;
 173
 174           if (options & WDIOS_DISABLECARD) {
 175             advwdt_disable();
 176             retval = 0;
 177           }
 178
 179           if (options & WDIOS_ENABLECARD) {
 180             advwdt_ping();
 181             retval = 0;
 182           }
 183
 184           return retval;
 185         }
 186
 187         default:
 188           return -ENOIOCTLCMD;
 189         }
 190         return 0;
 191 }
 192
 193 static int
 194 advwdt_open(struct inode *inode, struct file *file)
 195 {
 196         if (test_and_set_bit(0, &advwdt_is_open))
 197                 return -EBUSY;
 198         /*
 199          *      Activate
 200          */
 201
 202         advwdt_ping();
 203         return 0;
 204 }
 205
 206 static int
 207 advwdt_close(struct inode *inode, struct file *file)
 208 {
 209         if (adv_expect_close == 42) {
 210                 advwdt_disable();
 211         } else {
 212                 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
 213                 advwdt_ping();
 214         }
 215         clear_bit(0, &advwdt_is_open);
 216         adv_expect_close = 0;
 217         return 0;
 218 }
 219
 220 /*
 221  *      Notifier for system down
 222  */
 223
 224 static int
 225 advwdt_notify_sys(struct notifier_block *this, unsigned long code,
 226         void *unused)
 227 {
 228         if (code == SYS_DOWN || code == SYS_HALT) {
 229                 /* Turn the WDT off */
 230                 advwdt_disable();
 231         }
 232         return NOTIFY_DONE;
 233 }
 234
 235 /*
 236  *      Kernel Interfaces
 237  */
 238
 239 static struct file_operations advwdt_fops = {
 240         .owner          = THIS_MODULE,
 241         .llseek         = no_llseek,
 242         .write          = advwdt_write,
 243         .ioctl          = advwdt_ioctl,
 244         .open           = advwdt_open,
 245         .release        = advwdt_close,
 246 };
 247
 248 static struct miscdevice advwdt_miscdev = {
 249         .minor = WATCHDOG_MINOR,
 250         .name = "watchdog",
 251         .fops = &advwdt_fops,
 252 };
 253
 254 /*
 255  *      The WDT needs to learn about soft shutdowns in order to
 256  *      turn the timebomb registers off.
 257  */
 258
 259 static struct notifier_block advwdt_notifier = {
 260         .notifier_call = advwdt_notify_sys,
 261 };
 262
 263 static int __init
 264 advwdt_init(void)
 265 {
 266         int ret;
 267
 268         printk(KERN_INFO "WDT driver for Advantech single board computer initialising.\n");
 269
 270         if (timeout < 1 || timeout > 63) {
 271                 timeout = WATCHDOG_TIMEOUT;
 272                 printk (KERN_INFO PFX "timeout value must be 1<=x<=63, using %d\n",
 273                         timeout);
 274         }
 275
 276         if (wdt_stop != wdt_start) {
 277                 if (!request_region(wdt_stop, 1, WATCHDOG_NAME)) {
 278                         printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 279                                 wdt_stop);
 280                         ret = -EIO;
 281                         goto out;
 282                 }
 283         }
 284
 285         if (!request_region(wdt_start, 1, WATCHDOG_NAME)) {
 286                 printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 287                         wdt_start);
 288                 ret = -EIO;
 289                 goto unreg_stop;
 290         }
 291
 292         ret = register_reboot_notifier(&advwdt_notifier);
 293         if (ret != 0) {
 294                 printk (KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
 295                         ret);
 296                 goto unreg_regions;
 297         }
 298
 299         ret = misc_register(&advwdt_miscdev);
 300         if (ret != 0) {
 301                 printk (KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 302                         WATCHDOG_MINOR, ret);
 303                 goto unreg_reboot;
 304         }
 305
 306         printk (KERN_INFO PFX "initialized. timeout=%d sec (nowayout=%d)\n",
 307                 timeout, nowayout);
 308
 309 out:
 310         return ret;
 311 unreg_reboot:
 312         unregister_reboot_notifier(&advwdt_notifier);
 313 unreg_regions:
 314         release_region(wdt_start, 1);
 315 unreg_stop:
 316         if (wdt_stop != wdt_start)
 317                 release_region(wdt_stop, 1);
 318         goto out;
 319 }
 320
 321 static void __exit
 322 advwdt_exit(void)
 323 {
 324         misc_deregister(&advwdt_miscdev);
 325         unregister_reboot_notifier(&advwdt_notifier);
 326         if(wdt_stop != wdt_start)
 327                 release_region(wdt_stop,1);
 328         release_region(wdt_start,1);
 329 }
 330
 331 module_init(advwdt_init);
 332 module_exit(advwdt_exit);
 333
 334 MODULE_LICENSE("GPL");
 335 MODULE_AUTHOR("Marek Michalkiewicz <marekm@linux.org.pl>");
 336 MODULE_DESCRIPTION("Advantech Single Board Computer WDT driver");
 337 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);