drivers/char/watchdog/w83627hf_wdt.c

   1 /*
   2  *      w83627hf WDT driver
   3  *
   4  *      (c) Copyright 2003 Pádraig Brady <P@draigBrady.com>
   5  *
   6  *      Based on advantechwdt.c which is based on wdt.c.
   7  *      Original copyright messages:
   8  *
   9  *      (c) Copyright 2000-2001 Marek Michalkiewicz <marekm@linux.org.pl>
  10  *
  11  *      (c) Copyright 1996 Alan Cox <alan@redhat.com>, All Rights Reserved.
  12  *                              http://www.redhat.com
  13  *
  14  *      This program is free software; you can redistribute it and/or
  15  *      modify it under the terms of the GNU General Public License
  16  *      as published by the Free Software Foundation; either version
  17  *      2 of the License, or (at your option) any later version.
  18  *
  19  *      Neither Alan Cox nor CymruNet Ltd. admit liability nor provide
  20  *      warranty for any of this software. This material is provided
  21  *      "AS-IS" and at no charge.
  22  *
  23  *      (c) Copyright 1995    Alan Cox <alan@redhat.com>
  24  */
  25
  26 #include <linux/module.h>
  27 #include <linux/moduleparam.h>
  28 #include <linux/types.h>
  29 #include <linux/miscdevice.h>
  30 #include <linux/watchdog.h>
  31 #include <linux/fs.h>
  32 #include <linux/ioport.h>
  33 #include <linux/notifier.h>
  34 #include <linux/reboot.h>
  35 #include <linux/init.h>
  36
  37 #include <asm/io.h>
  38 #include <asm/uaccess.h>
  39 #include <asm/system.h>
  40
  41 #define WATCHDOG_NAME "w83627hf WDT"
  42 #define PFX WATCHDOG_NAME ": "
  43 #define WATCHDOG_TIMEOUT 60             /* 60 sec default timeout */
  44
  45 static unsigned long wdt_is_open;
  46 static char expect_close;
  47
  48 /* You must set this - there is no sane way to probe for this board. */
  49 static int wdt_io = 0x2E;
  50 module_param(wdt_io, int, 0);
  51 MODULE_PARM_DESC(wdt_io, "w83627hf WDT io port (default 0x2E)");
  52
  53 static int timeout = WATCHDOG_TIMEOUT;  /* in seconds */
  54 module_param(timeout, int, 0);
  55 MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds. 1<= timeout <=63, default=" __MODULE_STRING(WATCHDOG_TIMEOUT) ".");
  56
  57 #ifdef CONFIG_WATCHDOG_NOWAYOUT
  58 static int nowayout = 1;
  59 #else
  60 static int nowayout = 0;
  61 #endif
  62
  63 module_param(nowayout, int, 0);
  64 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
  65
  66 /*
  67  *      Kernel methods.
  68  */
  69
  70 #define WDT_EFER (wdt_io+0)   /* Extended Function Enable Registers */
  71 #define WDT_EFIR (wdt_io+0)   /* Extended Function Index Register (same as EFER) */
  72 #define WDT_EFDR (WDT_EFIR+1) /* Extended Function Data Register */
  73
  74 static void
  75 w83627hf_select_wd_register(void)
  76 {
  77         outb_p(0x87, WDT_EFER); /* Enter extended function mode */
  78         outb_p(0x87, WDT_EFER); /* Again according to manual */
  79
  80         outb_p(0x07, WDT_EFER); /* point to logical device number reg */
  81         outb_p(0x08, WDT_EFDR); /* select logical device 8 (GPIO2) */
  82         outb_p(0x30, WDT_EFER); /* select CR30 */
  83         outb_p(0x01, WDT_EFDR); /* set bit 0 to activate GPIO2 */
  84 }
  85
  86 static void
  87 w83627hf_unselect_wd_register(void)
  88 {
  89         outb_p(0xAA, WDT_EFER); /* Leave extended function mode */
  90 }
  91
  92 /* tyan motherboards seem to set F5 to 0x4C ?
  93  * So explicitly init to appropriate value. */
  94 static void
  95 w83627hf_init(void)
  96 {
  97         unsigned char t;
  98
  99         w83627hf_select_wd_register();
 100
 101         outb_p(0xF5, WDT_EFER); /* Select CRF5 */
 102         t=inb_p(WDT_EFDR);      /* read CRF5 */
 103         t&=~0x0C;               /* set second mode & disable keyboard turning off watchdog */
 104         outb_p(t, WDT_EFDR);    /* Write back to CRF5 */
 105
 106         w83627hf_unselect_wd_register();
 107 }
 108
 109 static void
 110 wdt_ctrl(int timeout)
 111 {
 112         w83627hf_select_wd_register();
 113
 114         outb_p(0xF6, WDT_EFER);    /* Select CRF6 */
 115         outb_p(timeout, WDT_EFDR); /* Write Timeout counter to CRF6 */
 116
 117         w83627hf_unselect_wd_register();
 118 }
 119
 120 static int
 121 wdt_ping(void)
 122 {
 123         wdt_ctrl(timeout);
 124         return 0;
 125 }
 126
 127 static int
 128 wdt_disable(void)
 129 {
 130         wdt_ctrl(0);
 131         return 0;
 132 }
 133
 134 static int
 135 wdt_set_heartbeat(int t)
 136 {
 137         if ((t < 1) || (t > 63))
 138                 return -EINVAL;
 139
 140         timeout = t;
 141         return 0;
 142 }
 143
 144 static ssize_t
 145 wdt_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
 146 {
 147         /*  Can't seek (pwrite) on this device  */
 148         if (ppos != &file->f_pos)
 149                 return -ESPIPE;
 150
 151         if (count) {
 152                 if (!nowayout) {
 153                         size_t i;
 154
 155                         expect_close = 0;
 156
 157                         for (i = 0; i != count; i++) {
 158                                 char c;
 159                                 if (get_user(c, buf+i))
 160                                         return -EFAULT;
 161                                 if (c == 'V')
 162                                         expect_close = 42;
 163                         }
 164                 }
 165                 wdt_ping();
 166         }
 167         return count;
 168 }
 169
 170 static int
 171 wdt_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
 172           unsigned long arg)
 173 {
 174         void __user *argp = (void __user *)arg;
 175         int __user *p = argp;
 176         int new_timeout;
 177         static struct watchdog_info ident = {
 178                 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
 179                 .firmware_version = 1,
 180                 .identity = "W83627HF WDT",
 181         };
 182
 183         switch (cmd) {
 184         case WDIOC_GETSUPPORT:
 185           if (copy_to_user(argp, &ident, sizeof(ident)))
 186             return -EFAULT;
 187           break;
 188
 189         case WDIOC_GETSTATUS:
 190         case WDIOC_GETBOOTSTATUS:
 191           return put_user(0, p);
 192
 193         case WDIOC_KEEPALIVE:
 194           wdt_ping();
 195           break;
 196
 197         case WDIOC_SETTIMEOUT:
 198           if (get_user(new_timeout, p))
 199                   return -EFAULT;
 200           if (wdt_set_heartbeat(new_timeout))
 201                   return -EINVAL;
 202           wdt_ping();
 203           /* Fall */
 204
 205         case WDIOC_GETTIMEOUT:
 206           return put_user(timeout, p);
 207
 208         case WDIOC_SETOPTIONS:
 209         {
 210           int options, retval = -EINVAL;
 211
 212           if (get_user(options, p))
 213             return -EFAULT;
 214
 215           if (options & WDIOS_DISABLECARD) {
 216             wdt_disable();
 217             retval = 0;
 218           }
 219
 220           if (options & WDIOS_ENABLECARD) {
 221             wdt_ping();
 222             retval = 0;
 223           }
 224
 225           return retval;
 226         }
 227
 228         default:
 229           return -ENOIOCTLCMD;
 230         }
 231         return 0;
 232 }
 233
 234 static int
 235 wdt_open(struct inode *inode, struct file *file)
 236 {
 237         if (test_and_set_bit(0, &wdt_is_open))
 238                 return -EBUSY;
 239         /*
 240          *      Activate
 241          */
 242
 243         wdt_ping();
 244         return 0;
 245 }
 246
 247 static int
 248 wdt_close(struct inode *inode, struct file *file)
 249 {
 250         if (expect_close == 42) {
 251                 wdt_disable();
 252         } else {
 253                 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
 254                 wdt_ping();
 255         }
 256         expect_close = 0;
 257         clear_bit(0, &wdt_is_open);
 258         return 0;
 259 }
 260
 261 /*
 262  *      Notifier for system down
 263  */
 264
 265 static int
 266 wdt_notify_sys(struct notifier_block *this, unsigned long code,
 267         void *unused)
 268 {
 269         if (code == SYS_DOWN || code == SYS_HALT) {
 270                 /* Turn the WDT off */
 271                 wdt_disable();
 272         }
 273         return NOTIFY_DONE;
 274 }
 275
 276 /*
 277  *      Kernel Interfaces
 278  */
 279
 280 static struct file_operations wdt_fops = {
 281         .owner          = THIS_MODULE,
 282         .llseek         = no_llseek,
 283         .write          = wdt_write,
 284         .ioctl          = wdt_ioctl,
 285         .open           = wdt_open,
 286         .release        = wdt_close,
 287 };
 288
 289 static struct miscdevice wdt_miscdev = {
 290         .minor = WATCHDOG_MINOR,
 291         .name = "watchdog",
 292         .fops = &wdt_fops,
 293 };
 294
 295 /*
 296  *      The WDT needs to learn about soft shutdowns in order to
 297  *      turn the timebomb registers off.
 298  */
 299
 300 static struct notifier_block wdt_notifier = {
 301         .notifier_call = wdt_notify_sys,
 302 };
 303
 304 static int __init
 305 wdt_init(void)
 306 {
 307         int ret;
 308
 309         printk(KERN_INFO "WDT driver for the Winbond(TM) W83627HF Super I/O chip initialising.\n");
 310
 311         if (wdt_set_heartbeat(timeout)) {
 312                 wdt_set_heartbeat(WATCHDOG_TIMEOUT);
 313                 printk (KERN_INFO PFX "timeout value must be 1<=timeout<=63, using %d\n",
 314                         WATCHDOG_TIMEOUT);
 315         }
 316
 317         if (!request_region(wdt_io, 1, WATCHDOG_NAME)) {
 318                 printk (KERN_ERR PFX "I/O address 0x%04x already in use\n",
 319                         wdt_io);
 320                 ret = -EIO;
 321                 goto out;
 322         }
 323
 324         w83627hf_init();
 325
 326         ret = register_reboot_notifier(&wdt_notifier);
 327         if (ret != 0) {
 328                 printk (KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
 329                         ret);
 330                 goto unreg_regions;
 331         }
 332
 333         ret = misc_register(&wdt_miscdev);
 334         if (ret != 0) {
 335                 printk (KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 336                         WATCHDOG_MINOR, ret);
 337                 goto unreg_reboot;
 338         }
 339
 340         printk (KERN_INFO PFX "initialized. timeout=%d sec (nowayout=%d)\n",
 341                 timeout, nowayout);
 342
 343 out:
 344         return ret;
 345 unreg_reboot:
 346         unregister_reboot_notifier(&wdt_notifier);
 347 unreg_regions:
 348         release_region(wdt_io, 1);
 349         goto out;
 350 }
 351
 352 static void __exit
 353 wdt_exit(void)
 354 {
 355         misc_deregister(&wdt_miscdev);
 356         unregister_reboot_notifier(&wdt_notifier);
 357         release_region(wdt_io,1);
 358 }
 359
 360 module_init(wdt_init);
 361 module_exit(wdt_exit);
 362
 363 MODULE_LICENSE("GPL");
 364 MODULE_AUTHOR("Pádraig Brady <P@draigBrady.com>");
 365 MODULE_DESCRIPTION("w38627hf WDT driver");
 366 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);