drivers/char/watchdog/acquirewdt.c

   1 /*
   2  *      Acquire Single Board Computer Watchdog Timer driver
   3  *
   4  *      Based on wdt.c. Original copyright messages:
   5  *
   6  *      (c) Copyright 1996 Alan Cox <alan@redhat.com>, All Rights Reserved.
   7  *                              http://www.redhat.com
   8  *
   9  *      This program is free software; you can redistribute it and/or
  10  *      modify it under the terms of the GNU General Public License
  11  *      as published by the Free Software Foundation; either version
  12  *      2 of the License, or (at your option) any later version.
  13  *
  14  *      Neither Alan Cox nor CymruNet Ltd. admit liability nor provide
  15  *      warranty for any of this software. This material is provided
  16  *      "AS-IS" and at no charge.
  17  *
  18  *      (c) Copyright 1995    Alan Cox <alan@redhat.com>
  19  *
  20  *      14-Dec-2001 Matt Domsch <Matt_Domsch@dell.com>
  21  *          Added nowayout module option to override CONFIG_WATCHDOG_NOWAYOUT
  22  *          Can't add timeout - driver doesn't allow changing value
  23  */
  24
  25 /*
  26  *      Theory of Operation:
  27  *              The Watch-Dog Timer is provided to ensure that standalone
  28  *              Systems can always recover from catastrophic conditions that
  29  *              caused the CPU to crash. This condition may have occured by
  30  *              external EMI or a software bug. When the CPU stops working
  31  *              correctly, hardware on the board will either perform a hardware
  32  *              reset (cold boot) or a non-maskable interrupt (NMI) to bring the
  33  *              system back to a known state.
  34  *
  35  *              The Watch-Dog Timer is controlled by two I/O Ports.
  36  *                443 hex       - Read  - Enable or refresh the Watch-Dog Timer
  37  *                043 hex       - Read  - Disable the Watch-Dog Timer
  38  *
  39  *              To enable the Watch-Dog Timer, a read from I/O port 443h must
  40  *              be performed. This will enable and activate the countdown timer
  41  *              which will eventually time out and either reset the CPU or cause
  42  *              an NMI depending on the setting of a jumper. To ensure that this
  43  *              reset condition does not occur, the Watch-Dog Timer must be
  44  *              periodically refreshed by reading the same I/O port 443h.
  45  *              The Watch-Dog Timer is disabled by reading I/O port 043h.
  46  *
  47  *              The Watch-Dog Timer Time-Out Period is set via jumpers.
  48  *              It can be 1, 2, 10, 20, 110 or 220 seconds.
  49  */
  50
  51 #include <linux/module.h>
  52 #include <linux/moduleparam.h>
  53 #include <linux/types.h>
  54 #include <linux/miscdevice.h>
  55 #include <linux/watchdog.h>
  56 #include <linux/fs.h>
  57 #include <linux/ioport.h>
  58 #include <linux/notifier.h>
  59 #include <linux/reboot.h>
  60 #include <linux/init.h>
  61
  62 #include <asm/io.h>
  63 #include <asm/uaccess.h>
  64 #include <asm/system.h>
  65
  66 #define WATCHDOG_NAME "Acquire WDT"
  67 #define PFX WATCHDOG_NAME ": "
  68 #define WATCHDOG_HEARTBEAT 0    /* There is no way to see what the correct time-out period is */
  69
  70 static unsigned long acq_is_open;
  71 static char expect_close;
  72
  73 /*
  74  *      You must set these - there is no sane way to probe for this board.
  75  */
  76
  77 static int wdt_stop = 0x43;
  78 module_param(wdt_stop, int, 0);
  79 MODULE_PARM_DESC(wdt_stop, "Acquire WDT 'stop' io port (default 0x43)");
  80
  81 static int wdt_start = 0x443;
  82 module_param(wdt_start, int, 0);
  83 MODULE_PARM_DESC(wdt_start, "Acquire WDT 'start' io port (default 0x443)");
  84
  85 #ifdef CONFIG_WATCHDOG_NOWAYOUT
  86 static int nowayout = 1;
  87 #else
  88 static int nowayout = 0;
  89 #endif
  90
  91 module_param(nowayout, int, 0);
  92 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
  93
  94 /*
  95  *      Kernel methods.
  96  */
  97
  98 static void acq_keepalive(void)
  99 {
 100         /* Write a watchdog value */
 101         inb_p(wdt_start);
 102 }
 103
 104 static void acq_stop(void)
 105 {
 106         /* Turn the card off */
 107         inb_p(wdt_stop);
 108 }
 109
 110 /*
 111  *      /dev/watchdog handling.
 112  */
 113
 114 static ssize_t acq_write(struct file *file, const char *buf, size_t count, loff_t *ppos)
 115 {
 116         /*  Can't seek (pwrite) on this device  */
 117         if (ppos != &file->f_pos)
 118                 return -ESPIPE;
 119
 120         /* See if we got the magic character 'V' and reload the timer */
 121         if(count) {
 122                 if (!nowayout) {
 123                         size_t i;
 124
 125                         /* note: just in case someone wrote the magic character
 126                          * five months ago... */
 127                         expect_close = 0;
 128
 129                         /* scan to see whether or not we got the magic character */
 130                         for (i = 0; i != count; i++) {
 131                                 char c;
 132                                 if (get_user(c, buf + i))
 133                                         return -EFAULT;
 134                                 if (c == 'V')
 135                                         expect_close = 42;
 136                         }
 137                 }
 138
 139                 /* Well, anyhow someone wrote to us, we should return that favour */
 140                 acq_keepalive();
 141         }
 142         return count;
 143 }
 144
 145 static int acq_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
 146         unsigned long arg)
 147 {
 148         int options, retval = -EINVAL;
 149         static struct watchdog_info ident =
 150         {
 151                 .options = WDIOF_KEEPALIVEPING | WDIOF_MAGICCLOSE,
 152                 .firmware_version = 1,
 153                 .identity = "Acquire WDT",
 154         };
 155
 156         switch(cmd)
 157         {
 158         case WDIOC_GETSUPPORT:
 159           return copy_to_user((struct watchdog_info *)arg, &ident, sizeof(ident)) ? -EFAULT : 0;
 160
 161         case WDIOC_GETSTATUS:
 162         case WDIOC_GETBOOTSTATUS:
 163           return put_user(0, (int *)arg);
 164
 165         case WDIOC_KEEPALIVE:
 166           acq_keepalive();
 167           return 0;
 168
 169         case WDIOC_GETTIMEOUT:
 170           return put_user(WATCHDOG_HEARTBEAT, (int *)arg);
 171
 172         case WDIOC_SETOPTIONS:
 173         {
 174             if (get_user(options, (int *)arg))
 175               return -EFAULT;
 176
 177             if (options & WDIOS_DISABLECARD)
 178             {
 179               acq_stop();
 180               retval = 0;
 181             }
 182
 183             if (options & WDIOS_ENABLECARD)
 184             {
 185               acq_keepalive();
 186               retval = 0;
 187             }
 188
 189             return retval;
 190         }
 191
 192         default:
 193           return -ENOIOCTLCMD;
 194         }
 195 }
 196
 197 static int acq_open(struct inode *inode, struct file *file)
 198 {
 199         if (test_and_set_bit(0, &acq_is_open))
 200                 return -EBUSY;
 201
 202         if (nowayout)
 203                 __module_get(THIS_MODULE);
 204
 205         /* Activate */
 206         acq_keepalive();
 207         return 0;
 208 }
 209
 210 static int acq_close(struct inode *inode, struct file *file)
 211 {
 212         if (expect_close == 42) {
 213                 acq_stop();
 214         } else {
 215                 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
 216                 acq_keepalive();
 217         }
 218         clear_bit(0, &acq_is_open);
 219         expect_close = 0;
 220         return 0;
 221 }
 222
 223 /*
 224  *      Notifier for system down
 225  */
 226
 227 static int acq_notify_sys(struct notifier_block *this, unsigned long code,
 228         void *unused)
 229 {
 230         if(code==SYS_DOWN || code==SYS_HALT) {
 231                 /* Turn the WDT off */
 232                 acq_stop();
 233         }
 234         return NOTIFY_DONE;
 235 }
 236
 237 /*
 238  *      Kernel Interfaces
 239  */
 240
 241 static struct file_operations acq_fops = {
 242         .owner          = THIS_MODULE,
 243         .llseek         = no_llseek,
 244         .write          = acq_write,
 245         .ioctl          = acq_ioctl,
 246         .open           = acq_open,
 247         .release        = acq_close,
 248 };
 249
 250 static struct miscdevice acq_miscdev=
 251 {
 252         .minor = WATCHDOG_MINOR,
 253         .name = "watchdog",
 254         .fops = &acq_fops,
 255 };
 256
 257 /*
 258  *      The WDT card needs to learn about soft shutdowns in order to
 259  *      turn the timebomb registers off.
 260  */
 261
 262 static struct notifier_block acq_notifier =
 263 {
 264         .notifier_call = acq_notify_sys,
 265 };
 266
 267 static int __init acq_init(void)
 268 {
 269         int ret;
 270
 271         printk(KERN_INFO "WDT driver for Acquire single board computer initialising.\n");
 272
 273         if (wdt_stop != wdt_start) {
 274                 if (!request_region(wdt_stop, 1, WATCHDOG_NAME)) {
 275                         printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 276                                 wdt_stop);
 277                         ret = -EIO;
 278                         goto out;
 279                 }
 280         }
 281
 282         if (!request_region(wdt_start, 1, WATCHDOG_NAME)) {
 283                 printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 284                         wdt_start);
 285                 ret = -EIO;
 286                 goto unreg_stop;
 287         }
 288
 289         ret = register_reboot_notifier(&acq_notifier);
 290         if (ret != 0) {
 291                 printk (KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
 292                         ret);
 293                 goto unreg_regions;
 294         }
 295
 296         ret = misc_register(&acq_miscdev);
 297         if (ret != 0) {
 298                 printk (KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 299                         WATCHDOG_MINOR, ret);
 300                 goto unreg_reboot;
 301         }
 302
 303         printk (KERN_INFO PFX "initialized. (nowayout=%d)\n",
 304                 nowayout);
 305
 306         return 0;
 307
 308 unreg_reboot:
 309         unregister_reboot_notifier(&acq_notifier);
 310 unreg_regions:
 311         release_region(wdt_start, 1);
 312 unreg_stop:
 313         if (wdt_stop != wdt_start)
 314                 release_region(wdt_stop, 1);
 315 out:
 316         return ret;
 317 }
 318
 319 static void __exit acq_exit(void)
 320 {
 321         misc_deregister(&acq_miscdev);
 322         unregister_reboot_notifier(&acq_notifier);
 323         if(wdt_stop != wdt_start)
 324                 release_region(wdt_stop,1);
 325         release_region(wdt_start,1);
 326 }
 327
 328 module_init(acq_init);
 329 module_exit(acq_exit);
 330
 331 MODULE_AUTHOR("David Woodhouse");
 332 MODULE_DESCRIPTION("Acquire Inc. Single Board Computer Watchdog Timer driver");
 333 MODULE_LICENSE("GPL");
 334 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);