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