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/platform_device.h>
  41 #include <linux/init.h>
  42
  43 #include <asm/io.h>
  44 #include <asm/uaccess.h>
  45 #include <asm/system.h>
  46
  47 #define DRV_NAME "advantechwdt"
  48 #define PFX DRV_NAME ": "
  49 #define WATCHDOG_NAME "Advantech WDT"
  50 #define WATCHDOG_TIMEOUT 60             /* 60 sec default timeout */
  51
  52 static struct platform_device *advwdt_platform_device;  /* the watchdog platform device */
  53 static unsigned long advwdt_is_open;
  54 static char adv_expect_close;
  55
  56 /*
  57  *      You must set these - there is no sane way to probe for this board.
  58  *
  59  *      To enable or restart, write the timeout value in seconds (1 to 63)
  60  *      to I/O port wdt_start.  To disable, read I/O port wdt_stop.
  61  *      Both are 0x443 for most boards (tested on a PCA-6276VE-00B1), but
  62  *      check your manual (at least the PCA-6159 seems to be different -
  63  *      the manual says wdt_stop is 0x43, not 0x443).
  64  *      (0x43 is also a write-only control register for the 8254 timer!)
  65  */
  66
  67 static int wdt_stop = 0x443;
  68 module_param(wdt_stop, int, 0);
  69 MODULE_PARM_DESC(wdt_stop, "Advantech WDT 'stop' io port (default 0x443)");
  70
  71 static int wdt_start = 0x443;
  72 module_param(wdt_start, int, 0);
  73 MODULE_PARM_DESC(wdt_start, "Advantech WDT 'start' io port (default 0x443)");
  74
  75 static int timeout = WATCHDOG_TIMEOUT;  /* in seconds */
  76 module_param(timeout, int, 0);
  77 MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds. 1<= timeout <=63, default=" __MODULE_STRING(WATCHDOG_TIMEOUT) ".");
  78
  79 static int nowayout = WATCHDOG_NOWAYOUT;
  80 module_param(nowayout, int, 0);
  81 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=" __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
  82
  83 /*
  84  *      Watchdog Operations
  85  */
  86
  87 static void
  88 advwdt_ping(void)
  89 {
  90         /* Write a watchdog value */
  91         outb_p(timeout, wdt_start);
  92 }
  93
  94 static void
  95 advwdt_disable(void)
  96 {
  97         inb_p(wdt_stop);
  98 }
  99
 100 static int
 101 advwdt_set_heartbeat(int t)
 102 {
 103         if ((t < 1) || (t > 63))
 104                 return -EINVAL;
 105
 106         timeout = t;
 107         return 0;
 108 }
 109
 110 /*
 111  *      /dev/watchdog handling
 112  */
 113
 114 static ssize_t
 115 advwdt_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
 116 {
 117         if (count) {
 118                 if (!nowayout) {
 119                         size_t i;
 120
 121                         adv_expect_close = 0;
 122
 123                         for (i = 0; i != count; i++) {
 124                                 char c;
 125                                 if (get_user(c, buf+i))
 126                                         return -EFAULT;
 127                                 if (c == 'V')
 128                                         adv_expect_close = 42;
 129                         }
 130                 }
 131                 advwdt_ping();
 132         }
 133         return count;
 134 }
 135
 136 static int
 137 advwdt_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
 138           unsigned long arg)
 139 {
 140         int new_timeout;
 141         void __user *argp = (void __user *)arg;
 142         int __user *p = argp;
 143         static struct watchdog_info ident = {
 144                 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
 145                 .firmware_version = 1,
 146                 .identity = WATCHDOG_NAME,
 147         };
 148
 149         switch (cmd) {
 150         case WDIOC_GETSUPPORT:
 151           if (copy_to_user(argp, &ident, sizeof(ident)))
 152             return -EFAULT;
 153           break;
 154
 155         case WDIOC_GETSTATUS:
 156         case WDIOC_GETBOOTSTATUS:
 157           return put_user(0, p);
 158
 159         case WDIOC_KEEPALIVE:
 160           advwdt_ping();
 161           break;
 162
 163         case WDIOC_SETTIMEOUT:
 164           if (get_user(new_timeout, p))
 165                   return -EFAULT;
 166           if (advwdt_set_heartbeat(new_timeout))
 167                   return -EINVAL;
 168           advwdt_ping();
 169           /* Fall */
 170
 171         case WDIOC_GETTIMEOUT:
 172           return put_user(timeout, p);
 173
 174         case WDIOC_SETOPTIONS:
 175         {
 176           int options, retval = -EINVAL;
 177
 178           if (get_user(options, p))
 179             return -EFAULT;
 180
 181           if (options & WDIOS_DISABLECARD) {
 182             advwdt_disable();
 183             retval = 0;
 184           }
 185
 186           if (options & WDIOS_ENABLECARD) {
 187             advwdt_ping();
 188             retval = 0;
 189           }
 190
 191           return retval;
 192         }
 193
 194         default:
 195           return -ENOTTY;
 196         }
 197         return 0;
 198 }
 199
 200 static int
 201 advwdt_open(struct inode *inode, struct file *file)
 202 {
 203         if (test_and_set_bit(0, &advwdt_is_open))
 204                 return -EBUSY;
 205         /*
 206          *      Activate
 207          */
 208
 209         advwdt_ping();
 210         return nonseekable_open(inode, file);
 211 }
 212
 213 static int
 214 advwdt_close(struct inode *inode, struct file *file)
 215 {
 216         if (adv_expect_close == 42) {
 217                 advwdt_disable();
 218         } else {
 219                 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
 220                 advwdt_ping();
 221         }
 222         clear_bit(0, &advwdt_is_open);
 223         adv_expect_close = 0;
 224         return 0;
 225 }
 226
 227 /*
 228  *      Notifier for system down
 229  */
 230
 231 static int
 232 advwdt_notify_sys(struct notifier_block *this, unsigned long code,
 233         void *unused)
 234 {
 235         if (code == SYS_DOWN || code == SYS_HALT) {
 236                 /* Turn the WDT off */
 237                 advwdt_disable();
 238         }
 239         return NOTIFY_DONE;
 240 }
 241
 242 /*
 243  *      Kernel Interfaces
 244  */
 245
 246 static const struct file_operations advwdt_fops = {
 247         .owner          = THIS_MODULE,
 248         .llseek         = no_llseek,
 249         .write          = advwdt_write,
 250         .ioctl          = advwdt_ioctl,
 251         .open           = advwdt_open,
 252         .release        = advwdt_close,
 253 };
 254
 255 static struct miscdevice advwdt_miscdev = {
 256         .minor  = WATCHDOG_MINOR,
 257         .name   = "watchdog",
 258         .fops   = &advwdt_fops,
 259 };
 260
 261 /*
 262  *      The WDT needs to learn about soft shutdowns in order to
 263  *      turn the timebomb registers off.
 264  */
 265
 266 static struct notifier_block advwdt_notifier = {
 267         .notifier_call = advwdt_notify_sys,
 268 };
 269
 270 /*
 271  *      Init & exit routines
 272  */
 273
 274 static int __devinit
 275 advwdt_probe(struct platform_device *dev)
 276 {
 277         int ret;
 278
 279         if (wdt_stop != wdt_start) {
 280                 if (!request_region(wdt_stop, 1, WATCHDOG_NAME)) {
 281                         printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 282                                 wdt_stop);
 283                         ret = -EIO;
 284                         goto out;
 285                 }
 286         }
 287
 288         if (!request_region(wdt_start, 1, WATCHDOG_NAME)) {
 289                 printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 290                         wdt_start);
 291                 ret = -EIO;
 292                 goto unreg_stop;
 293         }
 294
 295         /* Check that the heartbeat value is within it's range ; if not reset to the default */
 296         if (advwdt_set_heartbeat(timeout)) {
 297                 advwdt_set_heartbeat(WATCHDOG_TIMEOUT);
 298                 printk (KERN_INFO PFX "timeout value must be 1<=x<=63, using %d\n",
 299                         timeout);
 300         }
 301
 302         ret = register_reboot_notifier(&advwdt_notifier);
 303         if (ret != 0) {
 304                 printk (KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
 305                         ret);
 306                 goto unreg_regions;
 307         }
 308
 309         ret = misc_register(&advwdt_miscdev);
 310         if (ret != 0) {
 311                 printk (KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 312                         WATCHDOG_MINOR, ret);
 313                 goto unreg_reboot;
 314         }
 315
 316         printk (KERN_INFO PFX "initialized. timeout=%d sec (nowayout=%d)\n",
 317                 timeout, nowayout);
 318
 319 out:
 320         return ret;
 321 unreg_reboot:
 322         unregister_reboot_notifier(&advwdt_notifier);
 323 unreg_regions:
 324         release_region(wdt_start, 1);
 325 unreg_stop:
 326         if (wdt_stop != wdt_start)
 327                 release_region(wdt_stop, 1);
 328         goto out;
 329 }
 330
 331 static int __devexit
 332 advwdt_remove(struct platform_device *dev)
 333 {
 334         misc_deregister(&advwdt_miscdev);
 335         unregister_reboot_notifier(&advwdt_notifier);
 336         release_region(wdt_start,1);
 337         if(wdt_stop != wdt_start)
 338                 release_region(wdt_stop,1);
 339
 340         return 0;
 341 }
 342
 343 static struct platform_driver advwdt_driver = {
 344         .probe          = advwdt_probe,
 345         .remove         = __devexit_p(advwdt_remove),
 346         .driver         = {
 347                 .owner  = THIS_MODULE,
 348                 .name   = DRV_NAME,
 349         },
 350 };
 351
 352 static int __init
 353 advwdt_init(void)
 354 {
 355         int err;
 356
 357         printk(KERN_INFO "WDT driver for Advantech single board computer initialising.\n");
 358
 359         err = platform_driver_register(&advwdt_driver);
 360         if (err)
 361                 return err;
 362
 363         advwdt_platform_device = platform_device_register_simple(DRV_NAME, -1, NULL, 0);
 364         if (IS_ERR(advwdt_platform_device)) {
 365                 err = PTR_ERR(advwdt_platform_device);
 366                 goto unreg_platform_driver;
 367         }
 368
 369         return 0;
 370
 371 unreg_platform_driver:
 372         platform_driver_unregister(&advwdt_driver);
 373         return err;
 374 }
 375
 376 static void __exit
 377 advwdt_exit(void)
 378 {
 379         platform_device_unregister(advwdt_platform_device);
 380         platform_driver_unregister(&advwdt_driver);
 381         printk(KERN_INFO PFX "Watchdog Module Unloaded.\n");
 382 }
 383
 384 module_init(advwdt_init);
 385 module_exit(advwdt_exit);
 386
 387 MODULE_LICENSE("GPL");
 388 MODULE_AUTHOR("Marek Michalkiewicz <marekm@linux.org.pl>");
 389 MODULE_DESCRIPTION("Advantech Single Board Computer WDT driver");
 390 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);