SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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_select_wd_register(void)
 125 {
 126         w83697hf_unlock();
 127
 128         w83697hf_set_reg(0x29, 0x20);   /* Set pin 119 to WDTO# mode (= CR29, WDT0) */
 129
 130         w83697hf_set_reg(0x07, 0x08);   /* Switch to logic device 8 (GPIO2) */
 131         w83697hf_set_reg(0x30, 0x01);   /* Enable timer/activate GPIO2 via bit 0 */
 132 }
 133
 134 static void
 135 w83697hf_unselect_wd_register(void)
 136 {
 137         w83697hf_lock();
 138 }
 139
 140 static void
 141 w83697hf_init(void)
 142 {
 143         unsigned char t;
 144
 145         w83697hf_select_wd_register();
 146
 147         t = w83697hf_get_reg(0xF3);     /* Read CRF3 */
 148         if (t != 0) {
 149                 printk (KERN_INFO PFX "Watchdog already running. Resetting timeout to %d sec\n", timeout);
 150                 w83697hf_set_reg(0xF3, timeout);        /* Write new timeout */
 151         }
 152         t = w83697hf_get_reg(0xF4);     /* Read CRF4 */
 153         t&=~0x0C;                       /* set second mode & disable keyboard turning off watchdog */
 154         w83697hf_set_reg(0xF4, t);      /* Write back to CRF4 */
 155
 156         w83697hf_unselect_wd_register();
 157 }
 158
 159 static void
 160 wdt_ctrl(int timeout)
 161 {
 162         spin_lock(&io_lock);
 163
 164         w83697hf_select_wdt();
 165
 166         w83697hf_write_timeout(timeout);
 167
 168         w83697hf_deselect_wdt();
 169
 170         spin_unlock(&io_lock);
 171 }
 172
 173 static int
 174 wdt_ping(void)
 175 {
 176         wdt_ctrl(timeout);
 177         return 0;
 178 }
 179
 180 static int
 181 wdt_disable(void)
 182 {
 183         wdt_ctrl(0);
 184         return 0;
 185 }
 186
 187 static int
 188 wdt_set_heartbeat(int t)
 189 {
 190         if ((t < 1) || (t > 255))
 191                 return -EINVAL;
 192
 193         timeout = t;
 194         return 0;
 195 }
 196
 197 static ssize_t
 198 wdt_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
 199 {
 200         if (count) {
 201                 if (!nowayout) {
 202                         size_t i;
 203
 204                         expect_close = 0;
 205
 206                         for (i = 0; i != count; i++) {
 207                                 char c;
 208                                 if (get_user(c, buf+i))
 209                                         return -EFAULT;
 210                                 if (c == 'V')
 211                                         expect_close = 42;
 212                         }
 213                 }
 214                 wdt_ping();
 215         }
 216         return count;
 217 }
 218
 219 static int
 220 wdt_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
 221           unsigned long arg)
 222 {
 223         void __user *argp = (void __user *)arg;
 224         int __user *p = argp;
 225         int new_timeout;
 226         static struct watchdog_info ident = {
 227                 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
 228                 .firmware_version = 1,
 229                 .identity = "W83697HF WDT",
 230         };
 231
 232         switch (cmd) {
 233         case WDIOC_GETSUPPORT:
 234                 if (copy_to_user(argp, &ident, sizeof(ident)))
 235                         return -EFAULT;
 236                 break;
 237
 238         case WDIOC_GETSTATUS:
 239         case WDIOC_GETBOOTSTATUS:
 240                 return put_user(0, p);
 241
 242         case WDIOC_KEEPALIVE:
 243                 wdt_ping();
 244                 break;
 245
 246         case WDIOC_SETTIMEOUT:
 247                 if (get_user(new_timeout, p))
 248                         return -EFAULT;
 249                 if (wdt_set_heartbeat(new_timeout))
 250                         return -EINVAL;
 251                 wdt_ping();
 252                 /* Fall */
 253
 254         case WDIOC_GETTIMEOUT:
 255                 return put_user(timeout, p);
 256
 257         case WDIOC_SETOPTIONS:
 258         {
 259                 int options, retval = -EINVAL;
 260
 261                 if (get_user(options, p))
 262                         return -EFAULT;
 263
 264                 if (options & WDIOS_DISABLECARD) {
 265                         wdt_disable();
 266                         retval = 0;
 267                 }
 268
 269                 if (options & WDIOS_ENABLECARD) {
 270                         wdt_ping();
 271                         retval = 0;
 272                 }
 273
 274                 return retval;
 275         }
 276
 277         default:
 278                 return -ENOTTY;
 279         }
 280         return 0;
 281 }
 282
 283 static int
 284 wdt_open(struct inode *inode, struct file *file)
 285 {
 286         if (test_and_set_bit(0, &wdt_is_open))
 287                 return -EBUSY;
 288         /*
 289          *      Activate
 290          */
 291
 292         wdt_ping();
 293         return nonseekable_open(inode, file);
 294 }
 295
 296 static int
 297 wdt_close(struct inode *inode, struct file *file)
 298 {
 299         if (expect_close == 42) {
 300                 wdt_disable();
 301         } else {
 302                 printk (KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
 303                 wdt_ping();
 304         }
 305         expect_close = 0;
 306         clear_bit(0, &wdt_is_open);
 307         return 0;
 308 }
 309
 310 /*
 311  *      Notifier for system down
 312  */
 313
 314 static int
 315 wdt_notify_sys(struct notifier_block *this, unsigned long code,
 316         void *unused)
 317 {
 318         if (code == SYS_DOWN || code == SYS_HALT) {
 319                 /* Turn the WDT off */
 320                 wdt_disable();
 321         }
 322         return NOTIFY_DONE;
 323 }
 324
 325 /*
 326  *      Kernel Interfaces
 327  */
 328
 329 static struct file_operations wdt_fops = {
 330         .owner          = THIS_MODULE,
 331         .llseek         = no_llseek,
 332         .write          = wdt_write,
 333         .ioctl          = wdt_ioctl,
 334         .open           = wdt_open,
 335         .release        = wdt_close,
 336 };
 337
 338 static struct miscdevice wdt_miscdev = {
 339         .minor = WATCHDOG_MINOR,
 340         .name = "watchdog",
 341         .fops = &wdt_fops,
 342 };
 343
 344 /*
 345  *      The WDT needs to learn about soft shutdowns in order to
 346  *      turn the timebomb registers off.
 347  */
 348
 349 static struct notifier_block wdt_notifier = {
 350         .notifier_call = wdt_notify_sys,
 351 };
 352
 353 static int
 354 w83697hf_check_wdt(void)
 355 {
 356         if (!request_region(wdt_io, 2, WATCHDOG_NAME)) {
 357                 printk (KERN_ERR PFX "I/O address 0x%x already in use\n", wdt_io);
 358                 return -EIO;
 359         }
 360
 361         printk (KERN_DEBUG PFX "Looking for watchdog at address 0x%x\n", wdt_io);
 362         w83697hf_unlock();
 363         if (w83697hf_get_reg(0x20) == 0x60) {
 364                 printk (KERN_INFO PFX "watchdog found at address 0x%x\n", wdt_io);
 365                 w83697hf_lock();
 366                 return 0;
 367         }
 368         w83697hf_lock();        /* Reprotect in case it was a compatible device */
 369
 370         printk (KERN_INFO PFX "watchdog not found at address 0x%x\n", wdt_io);
 371         release_region(wdt_io, 2);
 372         return -EIO;
 373 }
 374
 375 static int __init
 376 wdt_init(void)
 377 {
 378         int ret, autodetect;
 379
 380         spin_lock_init(&io_lock);
 381
 382         printk (KERN_INFO PFX "WDT driver for W83697HF/HG initializing\n");
 383
 384         autodetect = wdt_io == 0;
 385         if (autodetect)
 386                 wdt_io = 0x2e;
 387
 388         if (!w83697hf_check_wdt())
 389                 goto found;
 390
 391         if (autodetect) {
 392                 wdt_io = 0x4e;
 393                 if (!w83697hf_check_wdt())
 394                         goto found;
 395         }
 396
 397         printk (KERN_ERR PFX "No W83697HF/HG could be found\n");
 398         ret = -EIO;
 399         goto out;
 400
 401 found:
 402
 403         if (wdt_set_heartbeat(timeout)) {
 404                 wdt_set_heartbeat(WATCHDOG_TIMEOUT);
 405                 printk (KERN_INFO PFX "timeout value must be 1<=timeout<=255, using %d\n",
 406                         WATCHDOG_TIMEOUT);
 407         }
 408
 409         w83697hf_init();
 410
 411         ret = register_reboot_notifier(&wdt_notifier);
 412         if (ret != 0) {
 413                 printk (KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
 414                         ret);
 415                 goto unreg_regions;
 416         }
 417
 418         ret = misc_register(&wdt_miscdev);
 419         if (ret != 0) {
 420                 printk (KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 421                         WATCHDOG_MINOR, ret);
 422                 goto unreg_reboot;
 423         }
 424
 425         printk (KERN_INFO PFX "initialized. timeout=%d sec (nowayout=%d)\n",
 426                 timeout, nowayout);
 427
 428 out:
 429         return ret;
 430 unreg_reboot:
 431         unregister_reboot_notifier(&wdt_notifier);
 432 unreg_regions:
 433         release_region(wdt_io, 2);
 434         goto out;
 435 }
 436
 437 static void __exit
 438 wdt_exit(void)
 439 {
 440         misc_deregister(&wdt_miscdev);
 441         unregister_reboot_notifier(&wdt_notifier);
 442         release_region(wdt_io, 2);
 443 }
 444
 445 module_init(wdt_init);
 446 module_exit(wdt_exit);
 447
 448 MODULE_LICENSE("GPL");
 449 MODULE_AUTHOR("Marcus Junker <junker@anduras.de>");
 450 MODULE_DESCRIPTION("w83697hf/hg WDT driver");
 451 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);