drivers/char/watchdog/scx200_wdt.c

   1 /* drivers/char/watchdog/scx200_wdt.c
   2
   3    National Semiconductor SCx200 Watchdog support
   4
   5    Copyright (c) 2001,2002 Christer Weinigel <wingel@nano-system.com>
   6
   7    Som code taken from:
   8    National Semiconductor PC87307/PC97307 (ala SC1200) WDT driver
   9    (c) Copyright 2002 Zwane Mwaikambo <zwane@commfireservices.com>
  10
  11    This program is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU General Public License as
  13    published by the Free Software Foundation; either version 2 of the
  14    License, or (at your option) any later version.
  15
  16    The author(s) of this software shall not be held liable for damages
  17    of any nature resulting due to the use of this software. This
  18    software is provided AS-IS with no warranties. */
  19
  20 #include <linux/config.h>
  21 #include <linux/module.h>
  22 #include <linux/moduleparam.h>
  23 #include <linux/init.h>
  24 #include <linux/miscdevice.h>
  25 #include <linux/watchdog.h>
  26 #include <linux/notifier.h>
  27 #include <linux/reboot.h>
  28 #include <linux/fs.h>
  29 #include <linux/pci.h>
  30 #include <linux/scx200.h>
  31
  32 #include <asm/uaccess.h>
  33 #include <asm/io.h>
  34
  35 #define NAME "scx200_wdt"
  36
  37 MODULE_AUTHOR("Christer Weinigel <wingel@nano-system.com>");
  38 MODULE_DESCRIPTION("NatSemi SCx200 Watchdog Driver");
  39 MODULE_LICENSE("GPL");
  40 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
  41
  42 #ifndef CONFIG_WATCHDOG_NOWAYOUT
  43 #define CONFIG_WATCHDOG_NOWAYOUT 0
  44 #endif
  45
  46 static int margin = 60;         /* in seconds */
  47 module_param(margin, int, 0);
  48 MODULE_PARM_DESC(margin, "Watchdog margin in seconds");
  49
  50 static int nowayout = CONFIG_WATCHDOG_NOWAYOUT;
  51 module_param(nowayout, int, 0);
  52 MODULE_PARM_DESC(nowayout, "Disable watchdog shutdown on close");
  53
  54 static u16 wdto_restart;
  55 static struct semaphore open_semaphore;
  56 static char expect_close;
  57
  58 /* Bits of the WDCNFG register */
  59 #define W_ENABLE 0x00fa         /* Enable watchdog */
  60 #define W_DISABLE 0x0000        /* Disable watchdog */
  61
  62 /* The scaling factor for the timer, this depends on the value of W_ENABLE */
  63 #define W_SCALE (32768/1024)
  64
  65 static void scx200_wdt_ping(void)
  66 {
  67         outw(wdto_restart, SCx200_CB_BASE + SCx200_WDT_WDTO);
  68 }
  69
  70 static void scx200_wdt_update_margin(void)
  71 {
  72         printk(KERN_INFO NAME ": timer margin %d seconds\n", margin);
  73         wdto_restart = margin * W_SCALE;
  74 }
  75
  76 static void scx200_wdt_enable(void)
  77 {
  78         printk(KERN_DEBUG NAME ": enabling watchdog timer, wdto_restart = %d\n",
  79                wdto_restart);
  80
  81         outw(0, SCx200_CB_BASE + SCx200_WDT_WDTO);
  82         outb(SCx200_WDT_WDSTS_WDOVF, SCx200_CB_BASE + SCx200_WDT_WDSTS);
  83         outw(W_ENABLE, SCx200_CB_BASE + SCx200_WDT_WDCNFG);
  84
  85         scx200_wdt_ping();
  86 }
  87
  88 static void scx200_wdt_disable(void)
  89 {
  90         printk(KERN_DEBUG NAME ": disabling watchdog timer\n");
  91
  92         outw(0, SCx200_CB_BASE + SCx200_WDT_WDTO);
  93         outb(SCx200_WDT_WDSTS_WDOVF, SCx200_CB_BASE + SCx200_WDT_WDSTS);
  94         outw(W_DISABLE, SCx200_CB_BASE + SCx200_WDT_WDCNFG);
  95 }
  96
  97 static int scx200_wdt_open(struct inode *inode, struct file *file)
  98 {
  99         /* only allow one at a time */
 100         if (down_trylock(&open_semaphore))
 101                 return -EBUSY;
 102         scx200_wdt_enable();
 103
 104         return 0;
 105 }
 106
 107 static int scx200_wdt_release(struct inode *inode, struct file *file)
 108 {
 109         if (expect_close != 42) {
 110                 printk(KERN_WARNING NAME ": watchdog device closed unexpectedly, will not disable the watchdog timer\n");
 111         } else if (!nowayout) {
 112                 scx200_wdt_disable();
 113         }
 114         expect_close = 0;
 115         up(&open_semaphore);
 116
 117         return 0;
 118 }
 119
 120 static int scx200_wdt_notify_sys(struct notifier_block *this,
 121                                       unsigned long code, void *unused)
 122 {
 123         if (code == SYS_HALT || code == SYS_POWER_OFF)
 124                 if (!nowayout)
 125                         scx200_wdt_disable();
 126
 127         return NOTIFY_DONE;
 128 }
 129
 130 static struct notifier_block scx200_wdt_notifier =
 131 {
 132         .notifier_call = scx200_wdt_notify_sys,
 133 };
 134
 135 static ssize_t scx200_wdt_write(struct file *file, const char *data,
 136                                      size_t len, loff_t *ppos)
 137 {
 138         if (ppos != &file->f_pos)
 139                 return -ESPIPE;
 140
 141         /* check for a magic close character */
 142         if (len)
 143         {
 144                 size_t i;
 145
 146                 scx200_wdt_ping();
 147
 148                 expect_close = 0;
 149                 for (i = 0; i < len; ++i) {
 150                         char c;
 151                         if (get_user(c, data+i))
 152                                 return -EFAULT;
 153                         if (c == 'V')
 154                                 expect_close = 42;
 155                 }
 156
 157                 return len;
 158         }
 159
 160         return 0;
 161 }
 162
 163 static int scx200_wdt_ioctl(struct inode *inode, struct file *file,
 164         unsigned int cmd, unsigned long arg)
 165 {
 166         static struct watchdog_info ident = {
 167                 .identity = "NatSemi SCx200 Watchdog",
 168                 .firmware_version = 1,
 169                 .options = (WDIOF_SETTIMEOUT | WDIOF_KEEPALIVEPING),
 170         };
 171         int new_margin;
 172
 173         switch (cmd) {
 174         default:
 175                 return -ENOIOCTLCMD;
 176         case WDIOC_GETSUPPORT:
 177                 if(copy_to_user((struct watchdog_info *)arg, &ident,
 178                                 sizeof(ident)))
 179                         return -EFAULT;
 180                 return 0;
 181         case WDIOC_GETSTATUS:
 182         case WDIOC_GETBOOTSTATUS:
 183                 if (put_user(0, (int *)arg))
 184                         return -EFAULT;
 185                 return 0;
 186         case WDIOC_KEEPALIVE:
 187                 scx200_wdt_ping();
 188                 return 0;
 189         case WDIOC_SETTIMEOUT:
 190                 if (get_user(new_margin, (int *)arg))
 191                         return -EFAULT;
 192                 if (new_margin < 1)
 193                         return -EINVAL;
 194                 margin = new_margin;
 195                 scx200_wdt_update_margin();
 196                 scx200_wdt_ping();
 197         case WDIOC_GETTIMEOUT:
 198                 if (put_user(margin, (int *)arg))
 199                         return -EFAULT;
 200                 return 0;
 201         }
 202 }
 203
 204 static struct file_operations scx200_wdt_fops = {
 205         .owner   = THIS_MODULE,
 206         .write   = scx200_wdt_write,
 207         .ioctl   = scx200_wdt_ioctl,
 208         .open    = scx200_wdt_open,
 209         .release = scx200_wdt_release,
 210 };
 211
 212 static struct miscdevice scx200_wdt_miscdev = {
 213         .minor = WATCHDOG_MINOR,
 214         .name  = NAME,
 215         .fops  = &scx200_wdt_fops,
 216 };
 217
 218 static int __init scx200_wdt_init(void)
 219 {
 220         int r;
 221
 222         printk(KERN_DEBUG NAME ": NatSemi SCx200 Watchdog Driver\n");
 223
 224         /*
 225          * First check that this really is a NatSemi SCx200 CPU or a Geode
 226          * SC1100 processor
 227          */
 228         if ((pci_find_device(PCI_VENDOR_ID_NS,
 229                              PCI_DEVICE_ID_NS_SCx200_BRIDGE,
 230                              NULL)) == NULL
 231             && (pci_find_device(PCI_VENDOR_ID_NS,
 232                                 PCI_DEVICE_ID_NS_SC1100_BRIDGE,
 233                                 NULL)) == NULL)
 234                 return -ENODEV;
 235
 236         /* More sanity checks, verify that the configuration block is there */
 237         if (!scx200_cb_probe(SCx200_CB_BASE)) {
 238                 printk(KERN_WARNING NAME ": no configuration block found\n");
 239                 return -ENODEV;
 240         }
 241
 242         if (!request_region(SCx200_CB_BASE + SCx200_WDT_OFFSET,
 243                             SCx200_WDT_SIZE,
 244                             "NatSemi SCx200 Watchdog")) {
 245                 printk(KERN_WARNING NAME ": watchdog I/O region busy\n");
 246                 return -EBUSY;
 247         }
 248
 249         scx200_wdt_update_margin();
 250         scx200_wdt_disable();
 251
 252         sema_init(&open_semaphore, 1);
 253
 254         r = misc_register(&scx200_wdt_miscdev);
 255         if (r) {
 256                 release_region(SCx200_CB_BASE + SCx200_WDT_OFFSET,
 257                                 SCx200_WDT_SIZE);
 258                 return r;
 259         }
 260
 261         r = register_reboot_notifier(&scx200_wdt_notifier);
 262         if (r) {
 263                 printk(KERN_ERR NAME ": unable to register reboot notifier");
 264                 misc_deregister(&scx200_wdt_miscdev);
 265                 release_region(SCx200_CB_BASE + SCx200_WDT_OFFSET,
 266                                 SCx200_WDT_SIZE);
 267                 return r;
 268         }
 269
 270         return 0;
 271 }
 272
 273 static void __exit scx200_wdt_cleanup(void)
 274 {
 275         unregister_reboot_notifier(&scx200_wdt_notifier);
 276         misc_deregister(&scx200_wdt_miscdev);
 277         release_region(SCx200_CB_BASE + SCx200_WDT_OFFSET,
 278                        SCx200_WDT_SIZE);
 279 }
 280
 281 module_init(scx200_wdt_init);
 282 module_exit(scx200_wdt_cleanup);
 283
 284 /*
 285     Local variables:
 286         compile-command: "make -k -C ../.. SUBDIRS=drivers/char modules"
 287         c-basic-offset: 8
 288     End:
 289 */