drivers/sbus/char/cpwatchdog.c

   1 /* cpwatchdog.c - driver implementation for hardware watchdog
   2  * timers found on Sun Microsystems CP1400 and CP1500 boards.
   3  *
   4  * This device supports both the generic Linux watchdog
   5  * interface and Solaris-compatible ioctls as best it is
   6  * able.
   7  *
   8  * NOTE:        CP1400 systems appear to have a defective intr_mask
   9  *                      register on the PLD, preventing the disabling of
  10  *                      timer interrupts.  We use a timer to periodically
  11  *                      reset 'stopped' watchdogs on affected platforms.
  12  *
  13  * TODO:        DevFS support (/dev/watchdogs/0 ... /dev/watchdogs/2)
  14  *
  15  * Copyright (c) 2000 Eric Brower (ebrower@usa.net)
  16  */
  17
  18 #include <linux/kernel.h>
  19 #include <linux/module.h>
  20 #include <linux/fs.h>
  21 #include <linux/errno.h>
  22 #include <linux/major.h>
  23 #include <linux/init.h>
  24 #include <linux/miscdevice.h>
  25 #include <linux/sched.h>
  26 #include <linux/interrupt.h>
  27 #include <linux/ioport.h>
  28 #include <linux/timer.h>
  29 #include <asm/irq.h>
  30 #include <asm/ebus.h>
  31 #include <asm/oplib.h>
  32 #include <asm/uaccess.h>
  33
  34 #include <asm/watchdog.h>
  35
  36 #define WD_OBPNAME      "watchdog"
  37 #define WD_BADMODEL "SUNW,501-5336"
  38 #define WD_BTIMEOUT     (jiffies + (HZ * 1000))
  39 #define WD_BLIMIT       0xFFFF
  40
  41 #define WD0_DEVNAME "watchdog0"
  42 #define WD1_DEVNAME "watchdog1"
  43 #define WD2_DEVNAME "watchdog2"
  44
  45 #define WD0_MINOR       212
  46 #define WD1_MINOR       213
  47 #define WD2_MINOR       214
  48
  49
  50 /* Internal driver definitions
  51  */
  52 #define WD0_ID                  0               /* Watchdog0                                            */
  53 #define WD1_ID                  1               /* Watchdog1                                            */
  54 #define WD2_ID                  2               /* Watchdog2                                            */
  55 #define WD_NUMDEVS              3               /* Device contains 3 timers                     */
  56
  57 #define WD_INTR_OFF             0               /* Interrupt disable value                      */
  58 #define WD_INTR_ON              1               /* Interrupt enable value                       */
  59
  60 #define WD_STAT_INIT    0x01    /* Watchdog timer is initialized        */
  61 #define WD_STAT_BSTOP   0x02    /* Watchdog timer is brokenstopped      */
  62 #define WD_STAT_SVCD    0x04    /* Watchdog interrupt occurred          */
  63
  64 /* Register value definitions
  65  */
  66 #define WD0_INTR_MASK   0x01    /* Watchdog device interrupt masks      */
  67 #define WD1_INTR_MASK   0x02
  68 #define WD2_INTR_MASK   0x04
  69
  70 #define WD_S_RUNNING    0x01    /* Watchdog device status running       */
  71 #define WD_S_EXPIRED    0x02    /* Watchdog device status expired       */
  72
  73 /* Sun uses Altera PLD EPF8820ATC144-4
  74  * providing three hardware watchdogs:
  75  *
  76  *      1) RIC - sends an interrupt when triggered
  77  *      2) XIR - asserts XIR_B_RESET when triggered, resets CPU
  78  *      3) POR - asserts POR_B_RESET when triggered, resets CPU, backplane, board
  79  *
  80  *** Timer register block definition (struct wd_timer_regblk)
  81  *
  82  * dcntr and limit registers (halfword access):
  83  * -------------------
  84  * | 15 | ...| 1 | 0 |
  85  * -------------------
  86  * |-  counter val  -|
  87  * -------------------
  88  * dcntr -      Current 16-bit downcounter value.
  89  *                      When downcounter reaches '0' watchdog expires.
  90  *                      Reading this register resets downcounter with 'limit' value.
  91  * limit -      16-bit countdown value in 1/10th second increments.
  92  *                      Writing this register begins countdown with input value.
  93  *                      Reading from this register does not affect counter.
  94  * NOTES:       After watchdog reset, dcntr and limit contain '1'
  95  *
  96  * status register (byte access):
  97  * ---------------------------
  98  * | 7 | ... | 2 |  1  |  0  |
  99  * --------------+------------
 100  * |-   UNUSED  -| EXP | RUN |
 101  * ---------------------------
 102  * status-      Bit 0 - Watchdog is running
 103  *                      Bit 1 - Watchdog has expired
 104  *
 105  *** PLD register block definition (struct wd_pld_regblk)
 106  *
 107  * intr_mask register (byte access):
 108  * ---------------------------------
 109  * | 7 | ... | 3 |  2  |  1  |  0  |
 110  * +-------------+------------------
 111  * |-   UNUSED  -| WD3 | WD2 | WD1 |
 112  * ---------------------------------
 113  * WD3 -  1 == Interrupt disabled for watchdog 3
 114  * WD2 -  1 == Interrupt disabled for watchdog 2
 115  * WD1 -  1 == Interrupt disabled for watchdog 1
 116  *
 117  * pld_status register (byte access):
 118  * UNKNOWN, MAGICAL MYSTERY REGISTER
 119  *
 120  */
 121 struct wd_timer_regblk {
 122         volatile __u16  dcntr;          /* down counter         - hw    */
 123         volatile __u16  dcntr_pad;
 124         volatile __u16  limit;          /* limit register       - hw    */
 125         volatile __u16  limit_pad;
 126         volatile __u8   status;         /* status register      - b             */
 127         volatile __u8   status_pad;
 128         volatile __u16  status_pad2;
 129         volatile __u32  pad32;          /* yet more padding                     */
 130 };
 131
 132 struct wd_pld_regblk {
 133         volatile __u8   intr_mask;      /* interrupt mask       - b             */
 134         volatile __u8   intr_mask_pad;
 135         volatile __u16  intr_mask_pad2;
 136         volatile __u8   status;         /* device status        - b             */
 137         volatile __u8   status_pad;
 138         volatile __u16  status_pad2;
 139 };
 140
 141 struct wd_regblk {
 142         volatile struct wd_timer_regblk         wd0_regs;
 143         volatile struct wd_timer_regblk         wd1_regs;
 144         volatile struct wd_timer_regblk         wd2_regs;
 145         volatile struct wd_pld_regblk           pld_regs;
 146 };
 147
 148 /* Individual timer structure
 149  */
 150 struct wd_timer {
 151         __u16                   timeout;
 152         __u8                    intr_mask;
 153         unsigned char   runstatus;
 154         volatile struct wd_timer_regblk* regs;
 155 };
 156
 157 /* Device structure
 158  */
 159 struct wd_device {
 160         int                             irq;
 161         spinlock_t              lock;
 162         unsigned char   isbaddoggie;    /* defective PLD */
 163         unsigned char   opt_enable;
 164         unsigned char   opt_reboot;
 165         unsigned short  opt_timeout;
 166         unsigned char   initialized;
 167         struct wd_timer watchdog[WD_NUMDEVS];
 168         volatile struct wd_regblk* regs;
 169 };
 170
 171 static struct wd_device wd_dev = {
 172                 0, SPIN_LOCK_UNLOCKED, 0, 0, 0, 0,
 173 };
 174
 175 static struct timer_list wd_timer;
 176
 177 static int wd0_timeout = 0;
 178 static int wd1_timeout = 0;
 179 static int wd2_timeout = 0;
 180
 181 #ifdef MODULE
 182 MODULE_PARM             (wd0_timeout, "i");
 183 MODULE_PARM_DESC(wd0_timeout, "Default watchdog0 timeout in 1/10secs");
 184 MODULE_PARM     (wd1_timeout, "i");
 185 MODULE_PARM_DESC(wd1_timeout, "Default watchdog1 timeout in 1/10secs");
 186 MODULE_PARM     (wd2_timeout, "i");
 187 MODULE_PARM_DESC(wd2_timeout, "Default watchdog2 timeout in 1/10secs");
 188
 189 MODULE_AUTHOR
 190         ("Eric Brower <ebrower@usa.net>");
 191 MODULE_DESCRIPTION
 192         ("Hardware watchdog driver for Sun Microsystems CP1400/1500");
 193 MODULE_LICENSE("GPL");
 194 MODULE_SUPPORTED_DEVICE
 195         ("watchdog");
 196 #endif /* ifdef MODULE */
 197
 198 /* Forward declarations of internal methods
 199  */
 200 #ifdef WD_DEBUG
 201 static void wd_dumpregs(void);
 202 #endif
 203 static irqreturn_t wd_interrupt(int irq, void *dev_id, struct pt_regs *regs);
 204 static void wd_toggleintr(struct wd_timer* pTimer, int enable);
 205 static void wd_pingtimer(struct wd_timer* pTimer);
 206 static void wd_starttimer(struct wd_timer* pTimer);
 207 static void wd_resetbrokentimer(struct wd_timer* pTimer);
 208 static void wd_stoptimer(struct wd_timer* pTimer);
 209 static void wd_brokentimer(unsigned long data);
 210 static int  wd_getstatus(struct wd_timer* pTimer);
 211
 212 /* PLD expects words to be written in LSB format,
 213  * so we must flip all words prior to writing them to regs
 214  */
 215 static inline unsigned short flip_word(unsigned short word)
 216 {
 217         return ((word & 0xff) << 8) | ((word >> 8) & 0xff);
 218 }
 219
 220 #define wd_writew(val, addr)    (writew(flip_word(val), addr))
 221 #define wd_readw(addr)                  (flip_word(readw(addr)))
 222 #define wd_writeb(val, addr)    (writeb(val, addr))
 223 #define wd_readb(addr)                  (readb(addr))
 224
 225
 226 /* CP1400s seem to have broken PLD implementations--
 227  * the interrupt_mask register cannot be written, so
 228  * no timer interrupts can be masked within the PLD.
 229  */
 230 static inline int wd_isbroken(void)
 231 {
 232         /* we could test this by read/write/read/restore
 233          * on the interrupt mask register only if OBP
 234          * 'watchdog-enable?' == FALSE, but it seems
 235          * ubiquitous on CP1400s
 236          */
 237         char val[32];
 238         prom_getproperty(prom_root_node, "model", val, sizeof(val));
 239         return((!strcmp(val, WD_BADMODEL)) ? 1 : 0);
 240 }
 241
 242 /* Retrieve watchdog-enable? option from OBP
 243  * Returns 0 if false, 1 if true
 244  */
 245 static inline int wd_opt_enable(void)
 246 {
 247         int opt_node;
 248
 249         opt_node = prom_getchild(prom_root_node);
 250         opt_node = prom_searchsiblings(opt_node, "options");
 251         return((-1 == prom_getint(opt_node, "watchdog-enable?")) ? 0 : 1);
 252 }
 253
 254 /* Retrieve watchdog-reboot? option from OBP
 255  * Returns 0 if false, 1 if true
 256  */
 257 static inline int wd_opt_reboot(void)
 258 {
 259         int opt_node;
 260
 261         opt_node = prom_getchild(prom_root_node);
 262         opt_node = prom_searchsiblings(opt_node, "options");
 263         return((-1 == prom_getint(opt_node, "watchdog-reboot?")) ? 0 : 1);
 264 }
 265
 266 /* Retrieve watchdog-timeout option from OBP
 267  * Returns OBP value, or 0 if not located
 268  */
 269 static inline int wd_opt_timeout(void)
 270 {
 271         int opt_node;
 272         char value[32];
 273         char *p = value;
 274
 275         opt_node = prom_getchild(prom_root_node);
 276         opt_node = prom_searchsiblings(opt_node, "options");
 277         opt_node = prom_getproperty(opt_node,
 278                                                                 "watchdog-timeout",
 279                                                                 value,
 280                                                                 sizeof(value));
 281         if(-1 != opt_node) {
 282                 /* atoi implementation */
 283                 for(opt_node = 0; /* nop */; p++) {
 284                         if(*p >= '0' && *p <= '9') {
 285                                 opt_node = (10*opt_node)+(*p-'0');
 286                         }
 287                         else {
 288                                 break;
 289                         }
 290                 }
 291         }
 292         return((-1 == opt_node) ? (0) : (opt_node));
 293 }
 294
 295 static int wd_open(struct inode *inode, struct file *f)
 296 {
 297         switch(iminor(inode))
 298         {
 299                 case WD0_MINOR:
 300                         f->private_data = &wd_dev.watchdog[WD0_ID];
 301                         break;
 302                 case WD1_MINOR:
 303                         f->private_data = &wd_dev.watchdog[WD1_ID];
 304                         break;
 305                 case WD2_MINOR:
 306                         f->private_data = &wd_dev.watchdog[WD2_ID];
 307                         break;
 308                 default:
 309                         return(-ENODEV);
 310         }
 311
 312         /* Register IRQ on first open of device */
 313         if(0 == wd_dev.initialized)
 314         {
 315                 if (request_irq(wd_dev.irq,
 316                                                 &wd_interrupt,
 317                                                 SA_SHIRQ,
 318                                                 WD_OBPNAME,
 319                                                 (void *)wd_dev.regs)) {
 320                         printk("%s: Cannot register IRQ %s\n",
 321                                 WD_OBPNAME, __irq_itoa(wd_dev.irq));
 322                         return(-EBUSY);
 323                 }
 324                 wd_dev.initialized = 1;
 325         }
 326
 327         return(0);
 328 }
 329
 330 static int wd_release(struct inode *inode, struct file *file)
 331 {
 332         return 0;
 333 }
 334
 335 static int wd_ioctl(struct inode *inode, struct file *file,
 336                      unsigned int cmd, unsigned long arg)
 337 {
 338         int     setopt                          = 0;
 339         struct  wd_timer* pTimer        = (struct wd_timer*)file->private_data;
 340         void __user *argp = (void __user *)arg;
 341         struct  watchdog_info info      = {
 342                 0,
 343                 0,
 344                 "Altera EPF8820ATC144-4"
 345         };
 346
 347         if(NULL == pTimer) {
 348                 return(-EINVAL);
 349         }
 350
 351         switch(cmd)
 352         {
 353                 /* Generic Linux IOCTLs */
 354                 case WDIOC_GETSUPPORT:
 355                         if(copy_to_user(argp, &info, sizeof(struct watchdog_info))) {
 356                                 return(-EFAULT);
 357                         }
 358                         break;
 359                 case WDIOC_GETSTATUS:
 360                 case WDIOC_GETBOOTSTATUS:
 361                         if (put_user(0, (int __user *)argp))
 362                                 return -EFAULT;
 363                         break;
 364                 case WDIOC_KEEPALIVE:
 365                         wd_pingtimer(pTimer);
 366                         break;
 367                 case WDIOC_SETOPTIONS:
 368                         if(copy_from_user(&setopt, argp, sizeof(unsigned int))) {
 369                                 return -EFAULT;
 370                         }
 371                         if(setopt & WDIOS_DISABLECARD) {
 372                                 if(wd_dev.opt_enable) {
 373                                         printk(
 374                                                 "%s: cannot disable watchdog in ENABLED mode\n",
 375                                                 WD_OBPNAME);
 376                                         return(-EINVAL);
 377                                 }
 378                                 wd_stoptimer(pTimer);
 379                         }
 380                         else if(setopt & WDIOS_ENABLECARD) {
 381                                 wd_starttimer(pTimer);
 382                         }
 383                         else {
 384                                 return(-EINVAL);
 385                         }
 386                         break;
 387                 /* Solaris-compatible IOCTLs */
 388                 case WIOCGSTAT:
 389                         setopt = wd_getstatus(pTimer);
 390                         if(copy_to_user(argp, &setopt, sizeof(unsigned int))) {
 391                                 return(-EFAULT);
 392                         }
 393                         break;
 394                 case WIOCSTART:
 395                         wd_starttimer(pTimer);
 396                         break;
 397                 case WIOCSTOP:
 398                         if(wd_dev.opt_enable) {
 399                                 printk("%s: cannot disable watchdog in ENABLED mode\n",
 400                                         WD_OBPNAME);
 401                                 return(-EINVAL);
 402                         }
 403                         wd_stoptimer(pTimer);
 404                         break;
 405                 default:
 406                         return(-EINVAL);
 407         }
 408         return(0);
 409 }
 410
 411 static ssize_t wd_write(struct file     *file,
 412                         const char      __user *buf,
 413                         size_t          count,
 414                         loff_t          *ppos)
 415 {
 416         struct wd_timer* pTimer = (struct wd_timer*)file->private_data;
 417
 418         if(NULL == pTimer) {
 419                 return(-EINVAL);
 420         }
 421
 422         if (ppos != &file->f_pos)
 423                 return -ESPIPE;
 424
 425         if (count) {
 426                 wd_pingtimer(pTimer);
 427                 return 1;
 428         }
 429         return 0;
 430 }
 431
 432 static ssize_t wd_read(struct file * file, char __user *buffer,
 433                         size_t count, loff_t *ppos)
 434 {
 435 #ifdef WD_DEBUG
 436         wd_dumpregs();
 437         return(0);
 438 #else
 439         return(-EINVAL);
 440 #endif /* ifdef WD_DEBUG */
 441 }
 442
 443 static irqreturn_t wd_interrupt(int irq, void *dev_id, struct pt_regs *regs)
 444 {
 445         /* Only WD0 will interrupt-- others are NMI and we won't
 446          * see them here....
 447          */
 448         spin_lock_irq(&wd_dev.lock);
 449         if((unsigned long)wd_dev.regs == (unsigned long)dev_id)
 450         {
 451                 wd_stoptimer(&wd_dev.watchdog[WD0_ID]);
 452                 wd_dev.watchdog[WD0_ID].runstatus |=  WD_STAT_SVCD;
 453         }
 454         spin_unlock_irq(&wd_dev.lock);
 455         return IRQ_HANDLED;
 456 }
 457
 458 static struct file_operations wd_fops = {
 459         .owner =        THIS_MODULE,
 460         .ioctl =        wd_ioctl,
 461         .open =         wd_open,
 462         .write =        wd_write,
 463         .read =         wd_read,
 464         .release =      wd_release,
 465 };
 466
 467 static struct miscdevice wd0_miscdev = { WD0_MINOR, WD0_DEVNAME, &wd_fops };
 468 static struct miscdevice wd1_miscdev = { WD1_MINOR, WD1_DEVNAME, &wd_fops };
 469 static struct miscdevice wd2_miscdev = { WD2_MINOR, WD2_DEVNAME, &wd_fops };
 470
 471 #ifdef WD_DEBUG
 472 static void wd_dumpregs(void)
 473 {
 474         /* Reading from downcounters initiates watchdog countdown--
 475          * Example is included below for illustration purposes.
 476          */
 477         int i;
 478         printk("%s: dumping register values\n", WD_OBPNAME);
 479         for(i = WD0_ID; i < WD_NUMDEVS; ++i) {
 480                         /* printk("\t%s%i: dcntr  at 0x%lx: 0x%x\n",
 481                          *      WD_OBPNAME,
 482                          *      i,
 483                          *      (unsigned long)(&wd_dev.watchdog[i].regs->dcntr),
 484                          *      readw(&wd_dev.watchdog[i].regs->dcntr));
 485                          */
 486                         printk("\t%s%i: limit  at 0x%lx: 0x%x\n",
 487                                 WD_OBPNAME,
 488                                 i,
 489                                 (unsigned long)(&wd_dev.watchdog[i].regs->limit),
 490                                 readw(&wd_dev.watchdog[i].regs->limit));
 491                         printk("\t%s%i: status at 0x%lx: 0x%x\n",
 492                                 WD_OBPNAME,
 493                                 i,
 494                                 (unsigned long)(&wd_dev.watchdog[i].regs->status),
 495                                 readb(&wd_dev.watchdog[i].regs->status));
 496                         printk("\t%s%i: driver status: 0x%x\n",
 497                                 WD_OBPNAME,
 498                                 i,
 499                                 wd_getstatus(&wd_dev.watchdog[i]));
 500         }
 501         printk("\tintr_mask  at 0x%lx: 0x%x\n",
 502                 (unsigned long)(&wd_dev.regs->pld_regs.intr_mask),
 503                 readb(&wd_dev.regs->pld_regs.intr_mask));
 504         printk("\tpld_status at 0x%lx: 0x%x\n",
 505                 (unsigned long)(&wd_dev.regs->pld_regs.status),
 506                 readb(&wd_dev.regs->pld_regs.status));
 507 }
 508 #endif
 509
 510 /* Enable or disable watchdog interrupts
 511  * Because of the CP1400 defect this should only be
 512  * called during initialzation or by wd_[start|stop]timer()
 513  *
 514  * pTimer       - pointer to timer device, or NULL to indicate all timers
 515  * enable       - non-zero to enable interrupts, zero to disable
 516  */
 517 static void wd_toggleintr(struct wd_timer* pTimer, int enable)
 518 {
 519         unsigned char curregs = wd_readb(&wd_dev.regs->pld_regs.intr_mask);
 520         unsigned char setregs =
 521                 (NULL == pTimer) ?
 522                         (WD0_INTR_MASK | WD1_INTR_MASK | WD2_INTR_MASK) :
 523                         (pTimer->intr_mask);
 524
 525         (WD_INTR_ON == enable) ?
 526                 (curregs &= ~setregs):
 527                 (curregs |=  setregs);
 528
 529         wd_writeb(curregs, &wd_dev.regs->pld_regs.intr_mask);
 530         return;
 531 }
 532
 533 /* Reset countdown timer with 'limit' value and continue countdown.
 534  * This will not start a stopped timer.
 535  *
 536  * pTimer       - pointer to timer device
 537  */
 538 static void wd_pingtimer(struct wd_timer* pTimer)
 539 {
 540         if(wd_readb(&pTimer->regs->status) & WD_S_RUNNING) {
 541                 wd_readw(&pTimer->regs->dcntr);
 542         }
 543 }
 544
 545 /* Stop a running watchdog timer-- the timer actually keeps
 546  * running, but the interrupt is masked so that no action is
 547  * taken upon expiration.
 548  *
 549  * pTimer       - pointer to timer device
 550  */
 551 static void wd_stoptimer(struct wd_timer* pTimer)
 552 {
 553         if(wd_readb(&pTimer->regs->status) & WD_S_RUNNING) {
 554                 wd_toggleintr(pTimer, WD_INTR_OFF);
 555
 556                 if(wd_dev.isbaddoggie) {
 557                         pTimer->runstatus |= WD_STAT_BSTOP;
 558                         wd_brokentimer((unsigned long)&wd_dev);
 559                 }
 560         }
 561 }
 562
 563 /* Start a watchdog timer with the specified limit value
 564  * If the watchdog is running, it will be restarted with
 565  * the provided limit value.
 566  *
 567  * This function will enable interrupts on the specified
 568  * watchdog.
 569  *
 570  * pTimer       - pointer to timer device
 571  * limit        - limit (countdown) value in 1/10th seconds
 572  */
 573 static void wd_starttimer(struct wd_timer* pTimer)
 574 {
 575         if(wd_dev.isbaddoggie) {
 576                 pTimer->runstatus &= ~WD_STAT_BSTOP;
 577         }
 578         pTimer->runstatus &= ~WD_STAT_SVCD;
 579
 580         wd_writew(pTimer->timeout, &pTimer->regs->limit);
 581         wd_toggleintr(pTimer, WD_INTR_ON);
 582 }
 583
 584 /* Restarts timer with maximum limit value and
 585  * does not unset 'brokenstop' value.
 586  */
 587 static void wd_resetbrokentimer(struct wd_timer* pTimer)
 588 {
 589         wd_toggleintr(pTimer, WD_INTR_ON);
 590         wd_writew(WD_BLIMIT, &pTimer->regs->limit);
 591 }
 592
 593 /* Timer device initialization helper.
 594  * Returns 0 on success, other on failure
 595  */
 596 static int wd_inittimer(int whichdog)
 597 {
 598         struct miscdevice                               *whichmisc;
 599         volatile struct wd_timer_regblk *whichregs;
 600         char                                                    whichident[8];
 601         int                                                             whichmask;
 602         __u16                                                   whichlimit;
 603
 604         switch(whichdog)
 605         {
 606                 case WD0_ID:
 607                         whichmisc = &wd0_miscdev;
 608                         strcpy(whichident, "RIC");
 609                         whichregs = &wd_dev.regs->wd0_regs;
 610                         whichmask = WD0_INTR_MASK;
 611                         whichlimit= (0 == wd0_timeout)  ?
 612                                                 (wd_dev.opt_timeout):
 613                                                 (wd0_timeout);
 614                         break;
 615                 case WD1_ID:
 616                         whichmisc = &wd1_miscdev;
 617                         strcpy(whichident, "XIR");
 618                         whichregs = &wd_dev.regs->wd1_regs;
 619                         whichmask = WD1_INTR_MASK;
 620                         whichlimit= (0 == wd1_timeout)  ?
 621                                                 (wd_dev.opt_timeout):
 622                                                 (wd1_timeout);
 623                         break;
 624                 case WD2_ID:
 625                         whichmisc = &wd2_miscdev;
 626                         strcpy(whichident, "POR");
 627                         whichregs = &wd_dev.regs->wd2_regs;
 628                         whichmask = WD2_INTR_MASK;
 629                         whichlimit= (0 == wd2_timeout)  ?
 630                                                 (wd_dev.opt_timeout):
 631                                                 (wd2_timeout);
 632                         break;
 633                 default:
 634                         printk("%s: %s: invalid watchdog id: %i\n",
 635                                 WD_OBPNAME, __FUNCTION__, whichdog);
 636                         return(1);
 637         }
 638         if(0 != misc_register(whichmisc))
 639         {
 640                 return(1);
 641         }
 642         wd_dev.watchdog[whichdog].regs                  = whichregs;
 643         wd_dev.watchdog[whichdog].timeout               = whichlimit;
 644         wd_dev.watchdog[whichdog].intr_mask             = whichmask;
 645         wd_dev.watchdog[whichdog].runstatus     &= ~WD_STAT_BSTOP;
 646         wd_dev.watchdog[whichdog].runstatus     |= WD_STAT_INIT;
 647
 648         printk("%s%i: %s hardware watchdog [%01i.%i sec] %s\n",
 649                 WD_OBPNAME,
 650                 whichdog,
 651                 whichident,
 652                 wd_dev.watchdog[whichdog].timeout / 10,
 653                 wd_dev.watchdog[whichdog].timeout % 10,
 654                 (0 != wd_dev.opt_enable) ? "in ENABLED mode" : "");
 655         return(0);
 656 }
 657
 658 /* Timer method called to reset stopped watchdogs--
 659  * because of the PLD bug on CP1400, we cannot mask
 660  * interrupts within the PLD so me must continually
 661  * reset the timers ad infinitum.
 662  */
 663 static void wd_brokentimer(unsigned long data)
 664 {
 665         struct wd_device* pDev = (struct wd_device*)data;
 666         int id, tripped = 0;
 667
 668         /* kill a running timer instance, in case we
 669          * were called directly instead of by kernel timer
 670          */
 671         if(timer_pending(&wd_timer)) {
 672                 del_timer(&wd_timer);
 673         }
 674
 675         for(id = WD0_ID; id < WD_NUMDEVS; ++id) {
 676                 if(pDev->watchdog[id].runstatus & WD_STAT_BSTOP) {
 677                         ++tripped;
 678                         wd_resetbrokentimer(&pDev->watchdog[id]);
 679                 }
 680         }
 681
 682         if(tripped) {
 683                 /* there is at least one timer brokenstopped-- reschedule */
 684                 init_timer(&wd_timer);
 685                 wd_timer.expires = WD_BTIMEOUT;
 686                 add_timer(&wd_timer);
 687         }
 688 }
 689
 690 static int wd_getstatus(struct wd_timer* pTimer)
 691 {
 692         unsigned char stat = wd_readb(&pTimer->regs->status);
 693         unsigned char intr = wd_readb(&wd_dev.regs->pld_regs.intr_mask);
 694         unsigned char ret  = WD_STOPPED;
 695
 696         /* determine STOPPED */
 697         if(0 == stat ) {
 698                 return(ret);
 699         }
 700         /* determine EXPIRED vs FREERUN vs RUNNING */
 701         else if(WD_S_EXPIRED & stat) {
 702                 ret = WD_EXPIRED;
 703         }
 704         else if(WD_S_RUNNING & stat) {
 705                 if(intr & pTimer->intr_mask) {
 706                         ret = WD_FREERUN;
 707                 }
 708                 else {
 709                         /* Fudge WD_EXPIRED status for defective CP1400--
 710                          * IF timer is running
 711                          *      AND brokenstop is set
 712                          *      AND an interrupt has been serviced
 713                          * we are WD_EXPIRED.
 714                          *
 715                          * IF timer is running
 716                          *      AND brokenstop is set
 717                          *      AND no interrupt has been serviced
 718                          * we are WD_FREERUN.
 719                          */
 720                         if(wd_dev.isbaddoggie && (pTimer->runstatus & WD_STAT_BSTOP)) {
 721                                 if(pTimer->runstatus & WD_STAT_SVCD) {
 722                                         ret = WD_EXPIRED;
 723                                 }
 724                                 else {
 725                                         /* we could as well pretend we are expired */
 726                                         ret = WD_FREERUN;
 727                                 }
 728                         }
 729                         else {
 730                                 ret = WD_RUNNING;
 731                         }
 732                 }
 733         }
 734
 735         /* determine SERVICED */
 736         if(pTimer->runstatus & WD_STAT_SVCD) {
 737                 ret |= WD_SERVICED;
 738         }
 739
 740         return(ret);
 741 }
 742
 743 static int __init wd_init(void)
 744 {
 745         int     id;
 746         struct  linux_ebus *ebus = NULL;
 747         struct  linux_ebus_device *edev = NULL;
 748
 749         for_each_ebus(ebus) {
 750                 for_each_ebusdev(edev, ebus) {
 751                         if (!strcmp(edev->prom_name, WD_OBPNAME))
 752                                 goto ebus_done;
 753                 }
 754         }
 755
 756 ebus_done:
 757         if(!edev) {
 758                 printk("%s: unable to locate device\n", WD_OBPNAME);
 759                 return -ENODEV;
 760         }
 761
 762         wd_dev.regs =
 763                 ioremap(edev->resource[0].start, sizeof(struct wd_regblk));
 764
 765         if(NULL == wd_dev.regs) {
 766                 printk("%s: unable to map registers\n", WD_OBPNAME);
 767                 return(-ENODEV);
 768         }
 769
 770         /* initialize device structure from OBP parameters */
 771         wd_dev.irq                      = edev->irqs[0];
 772         wd_dev.opt_enable       = wd_opt_enable();
 773         wd_dev.opt_reboot       = wd_opt_reboot();
 774         wd_dev.opt_timeout      = wd_opt_timeout();
 775         wd_dev.isbaddoggie      = wd_isbroken();
 776
 777         /* disable all interrupts unless watchdog-enabled? == true */
 778         if(! wd_dev.opt_enable) {
 779                 wd_toggleintr(NULL, WD_INTR_OFF);
 780         }
 781
 782         /* register miscellaneous devices */
 783         for(id = WD0_ID; id < WD_NUMDEVS; ++id) {
 784                 if(0 != wd_inittimer(id)) {
 785                         printk("%s%i: unable to initialize\n", WD_OBPNAME, id);
 786                 }
 787         }
 788
 789         /* warn about possible defective PLD */
 790         if(wd_dev.isbaddoggie) {
 791                 init_timer(&wd_timer);
 792                 wd_timer.function       = wd_brokentimer;
 793                 wd_timer.data           = (unsigned long)&wd_dev;
 794                 wd_timer.expires        = WD_BTIMEOUT;
 795
 796                 printk("%s: PLD defect workaround enabled for model %s\n",
 797                         WD_OBPNAME, WD_BADMODEL);
 798         }
 799         return(0);
 800 }
 801
 802 static void __exit wd_cleanup(void)
 803 {
 804         int id;
 805
 806         /* if 'watchdog-enable?' == TRUE, timers are not stopped
 807          * when module is unloaded.  All brokenstopped timers will
 808          * also now eventually trip.
 809          */
 810         for(id = WD0_ID; id < WD_NUMDEVS; ++id) {
 811                 if(WD_S_RUNNING == wd_readb(&wd_dev.watchdog[id].regs->status)) {
 812                         if(wd_dev.opt_enable) {
 813                                 printk(KERN_WARNING "%s%i: timer not stopped at release\n",
 814                                         WD_OBPNAME, id);
 815                         }
 816                         else {
 817                                 wd_stoptimer(&wd_dev.watchdog[id]);
 818                                 if(wd_dev.watchdog[id].runstatus & WD_STAT_BSTOP) {
 819                                         wd_resetbrokentimer(&wd_dev.watchdog[id]);
 820                                         printk(KERN_WARNING
 821                                                         "%s%i: defect workaround disabled at release, "\
 822                                                         "timer expires in ~%01i sec\n",
 823                                                         WD_OBPNAME, id,
 824                                                         wd_readw(&wd_dev.watchdog[id].regs->limit) / 10);
 825                                 }
 826                         }
 827                 }
 828         }
 829
 830         if(wd_dev.isbaddoggie && timer_pending(&wd_timer)) {
 831                 del_timer(&wd_timer);
 832         }
 833         if(0 != (wd_dev.watchdog[WD0_ID].runstatus & WD_STAT_INIT)) {
 834                 misc_deregister(&wd0_miscdev);
 835         }
 836         if(0 != (wd_dev.watchdog[WD1_ID].runstatus & WD_STAT_INIT)) {
 837                 misc_deregister(&wd1_miscdev);
 838         }
 839         if(0 != (wd_dev.watchdog[WD2_ID].runstatus & WD_STAT_INIT)) {
 840                 misc_deregister(&wd2_miscdev);
 841         }
 842         if(0 != wd_dev.initialized) {
 843                 free_irq(wd_dev.irq, (void *)wd_dev.regs);
 844         }
 845         iounmap(wd_dev.regs);
 846 }
 847
 848 module_init(wd_init);
 849 module_exit(wd_cleanup);