drivers/char/watchdog/w83697hf_wdt.c

   1 /*
   2  *      w83697hf/hg WDT driver
   3  *
   4  *      (c) Copyright 2006 Marcus Junker <junker@anduras.de>
   5  *
   6  *      Based on w83627hf_wdt.c which is based on advantechwdt.c
   7  *      which is based on wdt.c.
   8  *      Original copyright messages:
   9  *
  10  *      (c) Copyright 2003 Pádraig Brady <P@draigBrady.com>
  11  *
  12  *      (c) Copyright 2000-2001 Marek Michalkiewicz <marekm@linux.org.pl>
  13  *
  14  *      (c) Copyright 1996 Alan Cox <alan@redhat.com>, All Rights Reserved.
  15  *                              http://www.redhat.com
  16  *
  17  *      This program is free software; you can redistribute it and/or
  18  *      modify it under the terms of the GNU General Public License
  19  *      as published by the Free Software Foundation; either version
  20  *      2 of the License, or (at your option) any later version.
  21  *
  22  *      Neither Marcus Junker nor ANDURAS AG admit liability nor provide
  23  *      warranty for any of this software. This material is provided
  24  *      "AS-IS" and at no charge.
  25  */
  26
  27 #include <linux/module.h>
  28 #include <linux/moduleparam.h>
  29 #include <linux/types.h>
  30 #include <linux/miscdevice.h>
  31 #include <linux/watchdog.h>
  32 #include <linux/fs.h>
  33 #include <linux/ioport.h>
  34 #include <linux/notifier.h>
  35 #include <linux/reboot.h>
  36 #include <linux/init.h>
  37 #include <linux/spinlock.h>
  38
  39 #include <asm/io.h>
  40 #include <asm/uaccess.h>
  41 #include <asm/system.h>
  42
  43 #define WATCHDOG_NAME "w83697hf/hg WDT"
  44 #define PFX WATCHDOG_NAME ": "
  45 #define WATCHDOG_TIMEOUT 60             /* 60 sec default timeout */
  46
  47 static unsigned long wdt_is_open;
  48 static char expect_close;
  49 static spinlock_t io_lock;
  50
  51 /* You must set this - there is no sane way to probe for this board. */
  52 static int wdt_io = 0x2e;
  53 module_param(wdt_io, int, 0);
  54 MODULE_PARM_DESC(wdt_io, "w83697hf/hg WDT io port (default 0x2e, 0 = autodetect)");
  55
  56 static int timeout = WATCHDOG_TIMEOUT;  /* in seconds */
  57 module_param(timeout, int, 0);
  58 MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds. 1<= timeout <=255, default=" __MODULE_STRING(WATCHDOG_TIMEOUT) ".");
  59
  60 static int nowayout = WATCHDOG_NOWAYOUT;
  61 module_param(nowayout, int, 0);
  62 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
  63
  64 /*
  65  *      Kernel methods.
  66  */
  67
  68 #define W83697HF_EFER (wdt_io+0)        /* Extended Function Enable Register */
  69 #define W83697HF_EFIR (wdt_io+0)        /* Extended Function Index Register (same as EFER) */
  70 #define W83697HF_EFDR (wdt_io+1)        /* Extended Function Data Register */
  71
  72 static inline void
  73 w83697hf_unlock(void)
  74 {
  75         outb_p(0x87, W83697HF_EFER);    /* Enter extended function mode */
  76         outb_p(0x87, W83697HF_EFER);    /* Again according to manual */
  77 }
  78
  79 static inline void
  80 w83697hf_lock(void)
  81 {
  82         outb_p(0xAA, W83697HF_EFER);    /* Leave extended function mode */
  83 }
  84
  85 /*
  86  *      The three functions w83697hf_get_reg(), w83697hf_set_reg() and
  87  *      w83697hf_write_timeout() must be called with the device unlocked.
  88  */
  89
  90 static unsigned char
  91 w83697hf_get_reg(unsigned char reg)
  92 {
  93         outb_p(reg, W83697HF_EFIR);
  94         return inb_p(W83697HF_EFDR);
  95 }
  96
  97 static void
  98 w83697hf_set_reg(unsigned char reg, unsigned char data)
  99 {
 100         outb_p(reg, W83697HF_EFIR);
 101         outb_p(data, W83697HF_EFDR);
 102 }
 103
 104 static void
 105 w83697hf_write_timeout(int timeout)
 106 {
 107         w83697hf_set_reg(0xF4, timeout);        /* Write Timeout counter to CRF4 */
 108 }
 109
 110 static void
 111 w83697hf_select_wdt(void)
 112 {
 113         w83697hf_unlock();
 114         w83697hf_set_reg(0x07, 0x08);   /* Switch to logic device 8 (GPIO2) */
 115 }
 116
 117 static inline void
 118 w83697hf_deselect_wdt(void)
 119 {
 120         w83697hf_lock();
 121 }
 122
 123 static void
 124 w83697hf_init(void)
 125 {
 126         unsigned char bbuf;
 127
 128         w83697hf_select_wdt();
 129
 130         bbuf = w83697hf_get_reg(0x29);
 131         bbuf &= ~0x60;
 132         bbuf |= 0x20;
 133         w83697hf_set_reg(0x29, bbuf);   /* Set pin 119 to WDTO# mode (= CR29, WDT0) */
 134
 135         bbuf = w83697hf_get_reg(0xF3);
 136         bbuf &= ~0x04;
 137         w83697hf_set_reg(0xF3, bbuf);   /* Count mode is seconds */
 138
 139         w83697hf_deselect_wdt();
 140 }
 141
 142 static int
 143 wdt_ping(void)
 144 {
 145         spin_lock(&io_lock);
 146         w83697hf_select_wdt();
 147
 148         w83697hf_write_timeout(timeout);
 149
 150         w83697hf_deselect_wdt();
 151         spin_unlock(&io_lock);
 152         return 0;
 153 }
 154
 155 static int
 156 wdt_enable(void)
 157 {
 158         spin_lock(&io_lock);
 159         w83697hf_select_wdt();
 160
 161         w83697hf_write_timeout(timeout);
 162         w83697hf_set_reg(0x30, 1);      /* Enable timer */
 163
 164         w83697hf_deselect_wdt();
 165         spin_unlock(&io_lock);
 166         return 0;
 167 }
 168
 169 static int
 170 wdt_disable(void)
 171 {
 172         spin_lock(&io_lock);
 173         w83697hf_select_wdt();
 174
 175         w83697hf_set_reg(0x30, 0);      /* Disable timer */
 176         w83697hf_write_timeout(0);
 177
 178         w83697hf_deselect_wdt();
 179         spin_unlock(&io_lock);
 180         return 0;
 181 }
 182
 183 static int
 184 wdt_set_heartbeat(int t)
 185 {
 186         if ((t < 1) || (t > 255))
 187                 return -EINVAL;
 188
 189         timeout = t;
 190         return 0;
 191 }
 192
 193 static ssize_t
 194 wdt_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
 195 {
 196         if (count) {
 197                 if (!nowayout) {
 198                         size_t i;
 199
 200                         expect_close = 0;
 201
 202                         for (i = 0; i != count; i++) {
 203                                 char c;
 204                                 if (get_user(c, buf+i))
 205                                         return -EFAULT;
 206                                 if (c == 'V')
 207                                         expect_close = 42;
 208                         }
 209                 }
 210                 wdt_ping();
 211         }
 212         return count;
 213 }
 214
 215 static int
 216 wdt_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
 217           unsigned long arg)
 218 {
 219         void __user *argp = (void __user *)arg;
 220         int __user *p = argp;
 221         int new_timeout;
 222         static struct watchdog_info ident = {
 223                 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
 224                 .firmware_version = 1,
 225                 .identity = "W83697HF WDT",
 226         };
 227
 228         switch (cmd) {
 229         case WDIOC_GETSUPPORT:
 230                 if (copy_to_user(argp, &ident, sizeof(ident)))
 231                         return -EFAULT;
 232                 break;
 233
 234         case WDIOC_GETSTATUS:
 235         case WDIOC_GETBOOTSTATUS:
 236                 return put_user(0, p);
 237
 238         case WDIOC_KEEPALIVE:
 239                 wdt_ping();
 240                 break;
 241
 242         case WDIOC_SETTIMEOUT:
 243                 if (get_user(new_timeout, p))
 244                         return -EFAULT;
 245                 if (wdt_set_heartbeat(new_timeout))
 246                         return -EINVAL;
 247                 wdt_ping();
 248                 /* Fall */
 249
 250         case WDIOC_GETTIMEOUT:
 251                 return put_user(timeout, p);
 252
 253         case WDIOC_SETOPTIONS:
 254         {
 255                 int options, retval = -EINVAL;
 256
 257                 if (get_user(options, p))
 258                         return -EFAULT;
 259
 260                 if (options & WDIOS_DISABLECARD) {
 261                         wdt_disable();
 262                         retval = 0;
 263                 }
 264
 265                 if (options & WDIOS_ENABLECARD) {
 266                         wdt_enable();
 267                         retval = 0;
 268                 }
 269
 270                 return retval;
 271         }
 272
 273         default:
 274                 return -ENOTTY;
 275         }
 276         return 0;
 277 }
 278
 279 static int
 280 wdt_open(struct inode *inode, struct file *file)
 281 {
 282         if (test_and_set_bit(0, &wdt_is_open))
 283                 return -EBUSY;
 284         /*
 285          *      Activate
 286          */
 287
 288         wdt_enable();
 289         return nonseekable_open(inode, file);
 290 }
 291
 292 static int
 293 wdt_close(struct inode *inode, struct file *file)
 294 {
 295         if (expect_close == 42) {
 296                 wdt_disable();
 297         } else {
 298                 printk (KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
 299                 wdt_ping();
 300         }
 301         expect_close = 0;
 302         clear_bit(0, &wdt_is_open);
 303         return 0;
 304 }
 305
 306 /*
 307  *      Notifier for system down
 308  */
 309
 310 static int
 311 wdt_notify_sys(struct notifier_block *this, unsigned long code,
 312         void *unused)
 313 {
 314         if (code == SYS_DOWN || code == SYS_HALT) {
 315                 /* Turn the WDT off */
 316                 wdt_disable();
 317         }
 318         return NOTIFY_DONE;
 319 }
 320
 321 /*
 322  *      Kernel Interfaces
 323  */
 324
 325 static struct file_operations wdt_fops = {
 326         .owner          = THIS_MODULE,
 327         .llseek         = no_llseek,
 328         .write          = wdt_write,
 329         .ioctl          = wdt_ioctl,
 330         .open           = wdt_open,
 331         .release        = wdt_close,
 332 };
 333
 334 static struct miscdevice wdt_miscdev = {
 335         .minor = WATCHDOG_MINOR,
 336         .name = "watchdog",
 337         .fops = &wdt_fops,
 338 };
 339
 340 /*
 341  *      The WDT needs to learn about soft shutdowns in order to
 342  *      turn the timebomb registers off.
 343  */
 344
 345 static struct notifier_block wdt_notifier = {
 346         .notifier_call = wdt_notify_sys,
 347 };
 348
 349 static int
 350 w83697hf_check_wdt(void)
 351 {
 352         if (!request_region(wdt_io, 2, WATCHDOG_NAME)) {
 353                 printk (KERN_ERR PFX "I/O address 0x%x already in use\n", wdt_io);
 354                 return -EIO;
 355         }
 356
 357         printk (KERN_DEBUG PFX "Looking for watchdog at address 0x%x\n", wdt_io);
 358         w83697hf_unlock();
 359         if (w83697hf_get_reg(0x20) == 0x60) {
 360                 printk (KERN_INFO PFX "watchdog found at address 0x%x\n", wdt_io);
 361                 w83697hf_lock();
 362                 return 0;
 363         }
 364         w83697hf_lock();        /* Reprotect in case it was a compatible device */
 365
 366         printk (KERN_INFO PFX "watchdog not found at address 0x%x\n", wdt_io);
 367         release_region(wdt_io, 2);
 368         return -EIO;
 369 }
 370
 371 static int __init
 372 wdt_init(void)
 373 {
 374         int ret, autodetect;
 375
 376         spin_lock_init(&io_lock);
 377
 378         printk (KERN_INFO PFX "WDT driver for W83697HF/HG initializing\n");
 379
 380         autodetect = wdt_io == 0;
 381         if (autodetect)
 382                 wdt_io = 0x2e;
 383
 384         if (!w83697hf_check_wdt())
 385                 goto found;
 386
 387         if (autodetect) {
 388                 wdt_io = 0x4e;
 389                 if (!w83697hf_check_wdt())
 390                         goto found;
 391         }
 392
 393         printk (KERN_ERR PFX "No W83697HF/HG could be found\n");
 394         ret = -EIO;
 395         goto out;
 396
 397 found:
 398         w83697hf_init();
 399         wdt_disable();  /* Disable watchdog until first use */
 400
 401         if (wdt_set_heartbeat(timeout)) {
 402                 wdt_set_heartbeat(WATCHDOG_TIMEOUT);
 403                 printk (KERN_INFO PFX "timeout value must be 1<=timeout<=255, using %d\n",
 404                         WATCHDOG_TIMEOUT);
 405         }
 406
 407         ret = register_reboot_notifier(&wdt_notifier);
 408         if (ret != 0) {
 409                 printk (KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
 410                         ret);
 411                 goto unreg_regions;
 412         }
 413
 414         ret = misc_register(&wdt_miscdev);
 415         if (ret != 0) {
 416                 printk (KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 417                         WATCHDOG_MINOR, ret);
 418                 goto unreg_reboot;
 419         }
 420
 421         printk (KERN_INFO PFX "initialized. timeout=%d sec (nowayout=%d)\n",
 422                 timeout, nowayout);
 423
 424 out:
 425         return ret;
 426 unreg_reboot:
 427         unregister_reboot_notifier(&wdt_notifier);
 428 unreg_regions:
 429         release_region(wdt_io, 2);
 430         goto out;
 431 }
 432
 433 static void __exit
 434 wdt_exit(void)
 435 {
 436         misc_deregister(&wdt_miscdev);
 437         unregister_reboot_notifier(&wdt_notifier);
 438         release_region(wdt_io, 2);
 439 }
 440
 441 module_init(wdt_init);
 442 module_exit(wdt_exit);
 443
 444 MODULE_LICENSE("GPL");
 445 MODULE_AUTHOR("Marcus Junker <junker@anduras.de>");
 446 MODULE_DESCRIPTION("w83697hf/hg WDT driver");
 447 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);