drivers/char/watchdog/sc1200wdt.c

   1 /*
   2  *      National Semiconductor PC87307/PC97307 (ala SC1200) WDT driver
   3  *      (c) Copyright 2002 Zwane Mwaikambo <zwane@commfireservices.com>,
   4  *                      All Rights Reserved.
   5  *      Based on wdt.c and wdt977.c by Alan Cox and Woody Suwalski respectively.
   6  *
   7  *      This program is free software; you can redistribute it and/or
   8  *      modify it under the terms of the GNU General Public License
   9  *      as published by the Free Software Foundation; either version
  10  *      2 of the License, or (at your option) any later version.
  11  *
  12  *      The author(s) of this software shall not be held liable for damages
  13  *      of any nature resulting due to the use of this software. This
  14  *      software is provided AS-IS with no warranties.
  15  *
  16  *      Changelog:
  17  *      20020220 Zwane Mwaikambo        Code based on datasheet, no hardware.
  18  *      20020221 Zwane Mwaikambo        Cleanups as suggested by Jeff Garzik and Alan Cox.
  19  *      20020222 Zwane Mwaikambo        Added probing.
  20  *      20020225 Zwane Mwaikambo        Added ISAPNP support.
  21  *      20020412 Rob Radez              Broke out start/stop functions
  22  *               <rob@osinvestor.com>   Return proper status instead of temperature warning
  23  *                                      Add WDIOC_GETBOOTSTATUS and WDIOC_SETOPTIONS ioctls
  24  *                                      Fix CONFIG_WATCHDOG_NOWAYOUT
  25  *      20020530 Joel Becker            Add Matt Domsch's nowayout module option
  26  *      20030116 Adam Belay             Updated to the latest pnp code
  27  *
  28  */
  29
  30 #include <linux/config.h>
  31 #include <linux/module.h>
  32 #include <linux/moduleparam.h>
  33 #include <linux/miscdevice.h>
  34 #include <linux/watchdog.h>
  35 #include <linux/ioport.h>
  36 #include <linux/spinlock.h>
  37 #include <linux/notifier.h>
  38 #include <linux/reboot.h>
  39 #include <linux/init.h>
  40 #include <linux/pnp.h>
  41 #include <linux/pci.h>
  42
  43 #include <asm/semaphore.h>
  44 #include <asm/io.h>
  45 #include <asm/uaccess.h>
  46
  47 #define SC1200_MODULE_VER       "build 20020303"
  48 #define SC1200_MODULE_NAME      "sc1200wdt"
  49 #define PFX                     SC1200_MODULE_NAME ": "
  50
  51 #define MAX_TIMEOUT     255     /* 255 minutes */
  52 #define PMIR            (io)    /* Power Management Index Register */
  53 #define PMDR            (io+1)  /* Power Management Data Register */
  54
  55 /* Data Register indexes */
  56 #define FER1            0x00    /* Function enable register 1 */
  57 #define FER2            0x01    /* Function enable register 2 */
  58 #define PMC1            0x02    /* Power Management Ctrl 1 */
  59 #define PMC2            0x03    /* Power Management Ctrl 2 */
  60 #define PMC3            0x04    /* Power Management Ctrl 3 */
  61 #define WDTO            0x05    /* Watchdog timeout register */
  62 #define WDCF            0x06    /* Watchdog config register */
  63 #define WDST            0x07    /* Watchdog status register */
  64
  65 /* WDCF bitfields - which devices assert WDO */
  66 #define KBC_IRQ         0x01    /* Keyboard Controller */
  67 #define MSE_IRQ         0x02    /* Mouse */
  68 #define UART1_IRQ       0x03    /* Serial0 */
  69 #define UART2_IRQ       0x04    /* Serial1 */
  70 /* 5 -7 are reserved */
  71
  72 static char banner[] __initdata = KERN_INFO PFX SC1200_MODULE_VER;
  73 static int timeout = 1;
  74 static int io = -1;
  75 static int io_len = 2;          /* for non plug and play */
  76 struct semaphore open_sem;
  77 static char expect_close;
  78 spinlock_t sc1200wdt_lock;      /* io port access serialisation */
  79
  80 #if defined CONFIG_PNP
  81 static int isapnp = 1;
  82 static struct pnp_dev *wdt_dev;
  83
  84 module_param(isapnp, int, 0);
  85 MODULE_PARM_DESC(isapnp, "When set to 0 driver ISA PnP support will be disabled");
  86 #endif
  87
  88 module_param(io, int, 0);
  89 MODULE_PARM_DESC(io, "io port");
  90 module_param(timeout, int, 0);
  91 MODULE_PARM_DESC(timeout, "range is 0-255 minutes, default is 1");
  92
  93 #ifdef CONFIG_WATCHDOG_NOWAYOUT
  94 static int nowayout = 1;
  95 #else
  96 static int nowayout = 0;
  97 #endif
  98
  99 module_param(nowayout, int, 0);
 100 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
 101
 102
 103
 104 /* Read from Data Register */
 105 static inline void sc1200wdt_read_data(unsigned char index, unsigned char *data)
 106 {
 107         spin_lock(&sc1200wdt_lock);
 108         outb_p(index, PMIR);
 109         *data = inb(PMDR);
 110         spin_unlock(&sc1200wdt_lock);
 111 }
 112
 113
 114 /* Write to Data Register */
 115 static inline void sc1200wdt_write_data(unsigned char index, unsigned char data)
 116 {
 117         spin_lock(&sc1200wdt_lock);
 118         outb_p(index, PMIR);
 119         outb(data, PMDR);
 120         spin_unlock(&sc1200wdt_lock);
 121 }
 122
 123
 124 static void sc1200wdt_start(void)
 125 {
 126         unsigned char reg;
 127
 128         sc1200wdt_read_data(WDCF, &reg);
 129         /* assert WDO when any of the following interrupts are triggered too */
 130         reg |= (KBC_IRQ | MSE_IRQ | UART1_IRQ | UART2_IRQ);
 131         sc1200wdt_write_data(WDCF, reg);
 132         /* set the timeout and get the ball rolling */
 133         sc1200wdt_write_data(WDTO, timeout);
 134 }
 135
 136
 137 static void sc1200wdt_stop(void)
 138 {
 139         sc1200wdt_write_data(WDTO, 0);
 140 }
 141
 142
 143 /* This returns the status of the WDO signal, inactive high. */
 144 static inline int sc1200wdt_status(void)
 145 {
 146         unsigned char ret;
 147
 148         sc1200wdt_read_data(WDST, &ret);
 149         /* If the bit is inactive, the watchdog is enabled, so return
 150          * KEEPALIVEPING which is a bit of a kludge because there's nothing
 151          * else for enabled/disabled status
 152          */
 153         return (ret & 0x01) ? 0 : WDIOF_KEEPALIVEPING;  /* bits 1 - 7 are undefined */
 154 }
 155
 156
 157 static int sc1200wdt_open(struct inode *inode, struct file *file)
 158 {
 159         /* allow one at a time */
 160         if (down_trylock(&open_sem))
 161                 return -EBUSY;
 162
 163         if (timeout > MAX_TIMEOUT)
 164                 timeout = MAX_TIMEOUT;
 165
 166         sc1200wdt_start();
 167         printk(KERN_INFO PFX "Watchdog enabled, timeout = %d min(s)", timeout);
 168
 169         return 0;
 170 }
 171
 172
 173 static int sc1200wdt_ioctl(struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg)
 174 {
 175         int new_timeout;
 176         static struct watchdog_info ident = {
 177                 .options = WDIOF_KEEPALIVEPING | WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE,
 178                 .firmware_version = 0,
 179                 .identity = "PC87307/PC97307",
 180         };
 181
 182         switch (cmd) {
 183                 default:
 184                         return -ENOIOCTLCMD;    /* Keep Pavel Machek amused ;) */
 185
 186                 case WDIOC_GETSUPPORT:
 187                         if (copy_to_user((struct watchdog_info *)arg, &ident, sizeof ident))
 188                                 return -EFAULT;
 189                         return 0;
 190
 191                 case WDIOC_GETSTATUS:
 192                         return put_user(sc1200wdt_status(), (int *)arg);
 193
 194                 case WDIOC_GETBOOTSTATUS:
 195                         return put_user(0, (int *)arg);
 196
 197                 case WDIOC_KEEPALIVE:
 198                         sc1200wdt_write_data(WDTO, timeout);
 199                         return 0;
 200
 201                 case WDIOC_SETTIMEOUT:
 202                         if (get_user(new_timeout, (int *)arg))
 203                                 return -EFAULT;
 204
 205                         /* the API states this is given in secs */
 206                         new_timeout /= 60;
 207                         if (new_timeout < 0 || new_timeout > MAX_TIMEOUT)
 208                                 return -EINVAL;
 209
 210                         timeout = new_timeout;
 211                         sc1200wdt_write_data(WDTO, timeout);
 212                         /* fall through and return the new timeout */
 213
 214                 case WDIOC_GETTIMEOUT:
 215                         return put_user(timeout * 60, (int *)arg);
 216
 217                 case WDIOC_SETOPTIONS:
 218                 {
 219                         int options, retval = -EINVAL;
 220
 221                         if (get_user(options, (int *)arg))
 222                                 return -EFAULT;
 223
 224                         if (options & WDIOS_DISABLECARD) {
 225                                 sc1200wdt_stop();
 226                                 retval = 0;
 227                         }
 228
 229                         if (options & WDIOS_ENABLECARD) {
 230                                 sc1200wdt_start();
 231                                 retval = 0;
 232                         }
 233
 234                         return retval;
 235                 }
 236         }
 237 }
 238
 239
 240 static int sc1200wdt_release(struct inode *inode, struct file *file)
 241 {
 242         if (expect_close == 42) {
 243                 sc1200wdt_stop();
 244                 printk(KERN_INFO PFX "Watchdog disabled\n");
 245         } else {
 246                 sc1200wdt_write_data(WDTO, timeout);
 247                 printk(KERN_CRIT PFX "Unexpected close!, timeout = %d min(s)\n", timeout);
 248         }
 249         up(&open_sem);
 250         expect_close = 0;
 251
 252         return 0;
 253 }
 254
 255
 256 static ssize_t sc1200wdt_write(struct file *file, const char *data, size_t len, loff_t *ppos)
 257 {
 258         if (ppos != &file->f_pos)
 259                 return -ESPIPE;
 260
 261         if (len) {
 262                 if (!nowayout) {
 263                         size_t i;
 264
 265                         expect_close = 0;
 266
 267                         for (i = 0; i != len; i++) {
 268                                 char c;
 269
 270                                 if (get_user(c, data+i))
 271                                         return -EFAULT;
 272                                 if (c == 'V')
 273                                         expect_close = 42;
 274                         }
 275                 }
 276
 277                 sc1200wdt_write_data(WDTO, timeout);
 278                 return len;
 279         }
 280
 281         return 0;
 282 }
 283
 284
 285 static int sc1200wdt_notify_sys(struct notifier_block *this, unsigned long code, void *unused)
 286 {
 287         if (code == SYS_DOWN || code == SYS_HALT)
 288                 sc1200wdt_stop();
 289
 290         return NOTIFY_DONE;
 291 }
 292
 293
 294 static struct notifier_block sc1200wdt_notifier =
 295 {
 296         .notifier_call =        sc1200wdt_notify_sys,
 297 };
 298
 299 static struct file_operations sc1200wdt_fops =
 300 {
 301         .owner          = THIS_MODULE,
 302         .write          = sc1200wdt_write,
 303         .ioctl          = sc1200wdt_ioctl,
 304         .open           = sc1200wdt_open,
 305         .release        = sc1200wdt_release,
 306 };
 307
 308 static struct miscdevice sc1200wdt_miscdev =
 309 {
 310         .minor          = WATCHDOG_MINOR,
 311         .name           = "watchdog",
 312         .fops           = &sc1200wdt_fops,
 313 };
 314
 315
 316 static int __init sc1200wdt_probe(void)
 317 {
 318         /* The probe works by reading the PMC3 register's default value of 0x0e
 319          * there is one caveat, if the device disables the parallel port or any
 320          * of the UARTs we won't be able to detect it.
 321          * Nb. This could be done with accuracy by reading the SID registers, but
 322          * we don't have access to those io regions.
 323          */
 324
 325         unsigned char reg;
 326
 327         sc1200wdt_read_data(PMC3, &reg);
 328         reg &= 0x0f;                            /* we don't want the UART busy bits */
 329         return (reg == 0x0e) ? 0 : -ENODEV;
 330 }
 331
 332
 333 #if defined CONFIG_PNP
 334
 335 struct pnp_device_id scl200wdt_pnp_devices[] = {
 336         /* National Semiconductor PC87307/PC97307 watchdog component */
 337         {.id = "NSC0800", .driver_data = 0},
 338         {.id = ""},
 339 };
 340
 341 static int scl200wdt_pnp_probe(struct pnp_dev * dev, const struct pnp_device_id *dev_id)
 342 {
 343         /* this driver only supports one card at a time */
 344         if (wdt_dev || !isapnp)
 345                 return -EBUSY;
 346
 347         wdt_dev = dev;
 348         io = pnp_port_start(wdt_dev, 0);
 349         io_len = pnp_port_len(wdt_dev, 0);
 350
 351         if (!request_region(io, io_len, SC1200_MODULE_NAME)) {
 352                 printk(KERN_ERR PFX "Unable to register IO port %#x\n", io);
 353                 return -EBUSY;
 354         }
 355
 356         printk(KERN_INFO "scl200wdt: PnP device found at io port %#x/%d\n", io, io_len);
 357         return 0;
 358 }
 359
 360 static void scl200wdt_pnp_remove(struct pnp_dev * dev)
 361 {
 362         if (wdt_dev){
 363                 release_region(io, io_len);
 364                 wdt_dev = NULL;
 365         }
 366 }
 367
 368 static struct pnp_driver scl200wdt_pnp_driver = {
 369         .name           = "scl200wdt",
 370         .id_table       = scl200wdt_pnp_devices,
 371         .probe          = scl200wdt_pnp_probe,
 372         .remove         = scl200wdt_pnp_remove,
 373 };
 374
 375 #endif /* CONFIG_PNP */
 376
 377
 378 static int __init sc1200wdt_init(void)
 379 {
 380         int ret;
 381
 382         printk(banner);
 383
 384         spin_lock_init(&sc1200wdt_lock);
 385         sema_init(&open_sem, 1);
 386
 387 #if defined CONFIG_PNP
 388         if (isapnp) {
 389                 ret = pnp_register_driver(&scl200wdt_pnp_driver);
 390                 if (ret)
 391                         goto out_clean;
 392         }
 393 #endif
 394
 395         if (io == -1) {
 396                 printk(KERN_ERR PFX "io parameter must be specified\n");
 397                 ret = -EINVAL;
 398                 goto out_clean;
 399         }
 400
 401 #if defined CONFIG_PNP
 402         /* now that the user has specified an IO port and we haven't detected
 403          * any devices, disable pnp support */
 404         isapnp = 0;
 405         pnp_unregister_driver(&scl200wdt_pnp_driver);
 406 #endif
 407
 408         if (!request_region(io, io_len, SC1200_MODULE_NAME)) {
 409                 printk(KERN_ERR PFX "Unable to register IO port %#x\n", io);
 410                 ret = -EBUSY;
 411                 goto out_clean;
 412         }
 413
 414         ret = sc1200wdt_probe();
 415         if (ret)
 416                 goto out_io;
 417
 418         ret = register_reboot_notifier(&sc1200wdt_notifier);
 419         if (ret) {
 420                 printk(KERN_ERR PFX "Unable to register reboot notifier err = %d\n", ret);
 421                 goto out_io;
 422         }
 423
 424         ret = misc_register(&sc1200wdt_miscdev);
 425         if (ret) {
 426                 printk(KERN_ERR PFX "Unable to register miscdev on minor %d\n", WATCHDOG_MINOR);
 427                 goto out_rbt;
 428         }
 429
 430         /* ret = 0 */
 431
 432 out_clean:
 433         return ret;
 434
 435 out_rbt:
 436         unregister_reboot_notifier(&sc1200wdt_notifier);
 437
 438 out_io:
 439         release_region(io, io_len);
 440
 441         goto out_clean;
 442 }
 443
 444
 445 static void __exit sc1200wdt_exit(void)
 446 {
 447         misc_deregister(&sc1200wdt_miscdev);
 448         unregister_reboot_notifier(&sc1200wdt_notifier);
 449
 450 #if defined CONFIG_PNP
 451         if(isapnp)
 452                 pnp_unregister_driver(&scl200wdt_pnp_driver);
 453         else
 454 #endif
 455         release_region(io, io_len);
 456 }
 457
 458 module_init(sc1200wdt_init);
 459 module_exit(sc1200wdt_exit);
 460
 461 MODULE_AUTHOR("Zwane Mwaikambo <zwane@commfireservices.com>");
 462 MODULE_DESCRIPTION("Driver for National Semiconductor PC87307/PC97307 watchdog component");
 463 MODULE_LICENSE("GPL");
 464 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);