drivers/char/watchdog/pcwd_usb.c

   1 /*
   2  *      Berkshire USB-PC Watchdog Card Driver
   3  *
   4  *      (c) Copyright 2004 Wim Van Sebroeck <wim@iguana.be>.
   5  *
   6  *      Based on source code of the following authors:
   7  *        Ken Hollis <kenji@bitgate.com>,
   8  *        Alan Cox <alan@redhat.com>,
   9  *        Matt Domsch <Matt_Domsch@dell.com>,
  10  *        Rob Radez <rob@osinvestor.com>,
  11  *        Greg Kroah-Hartman <greg@kroah.com>
  12  *
  13  *      This program is free software; you can redistribute it and/or
  14  *      modify it under the terms of the GNU General Public License
  15  *      as published by the Free Software Foundation; either version
  16  *      2 of the License, or (at your option) any later version.
  17  *
  18  *      Neither Wim Van Sebroeck nor Iguana vzw. admit liability nor
  19  *      provide warranty for any of this software. This material is
  20  *      provided "AS-IS" and at no charge.
  21  *
  22  *      Thanks also to Simon Machell at Berkshire Products Inc. for
  23  *      providing the test hardware. More info is available at
  24  *      http://www.berkprod.com/ or http://www.pcwatchdog.com/
  25  */
  26
  27 #include <linux/config.h>
  28 #include <linux/kernel.h>
  29 #include <linux/errno.h>
  30 #include <linux/init.h>
  31 #include <linux/slab.h>
  32 #include <linux/module.h>
  33 #include <linux/moduleparam.h>
  34 #include <linux/types.h>
  35 #include <linux/delay.h>
  36 #include <linux/miscdevice.h>
  37 #include <linux/watchdog.h>
  38 #include <linux/notifier.h>
  39 #include <linux/reboot.h>
  40 #include <linux/fs.h>
  41 #include <linux/smp_lock.h>
  42 #include <linux/completion.h>
  43 #include <asm/uaccess.h>
  44 #include <linux/usb.h>
  45
  46
  47 #ifdef CONFIG_USB_DEBUG
  48         static int debug = 1;
  49 #else
  50         static int debug;
  51 #endif
  52
  53 /* Use our own dbg macro */
  54 #undef dbg
  55 #define dbg(format, arg...) do { if (debug) printk(KERN_DEBUG PFX format "\n" , ## arg); } while (0)
  56
  57
  58 /* Module and Version Information */
  59 #define DRIVER_VERSION "1.00"
  60 #define DRIVER_DATE "12 Jun 2004"
  61 #define DRIVER_AUTHOR "Wim Van Sebroeck <wim@iguana.be>"
  62 #define DRIVER_DESC "Berkshire USB-PC Watchdog driver"
  63 #define DRIVER_LICENSE "GPL"
  64 #define DRIVER_NAME "pcwd_usb"
  65 #define PFX DRIVER_NAME ": "
  66
  67 MODULE_AUTHOR(DRIVER_AUTHOR);
  68 MODULE_DESCRIPTION(DRIVER_DESC);
  69 MODULE_LICENSE(DRIVER_LICENSE);
  70 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);
  71 MODULE_ALIAS_MISCDEV(TEMP_MINOR);
  72
  73 /* Module Parameters */
  74 module_param(debug, int, 0);
  75 MODULE_PARM_DESC(debug, "Debug enabled or not");
  76
  77 #define WATCHDOG_HEARTBEAT 2    /* 2 sec default heartbeat */
  78 static int heartbeat = WATCHDOG_HEARTBEAT;
  79 module_param(heartbeat, int, 0);
  80 MODULE_PARM_DESC(heartbeat, "Watchdog heartbeat in seconds. (0<heartbeat<65536, default=" __MODULE_STRING(WATCHDOG_HEARTBEAT) ")");
  81
  82 #ifdef CONFIG_WATCHDOG_NOWAYOUT
  83 static int nowayout = 1;
  84 #else
  85 static int nowayout = 0;
  86 #endif
  87
  88 module_param(nowayout, int, 0);
  89 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
  90
  91 /* The vendor and product id's for the USB-PC Watchdog card */
  92 #define USB_PCWD_VENDOR_ID      0x0c98
  93 #define USB_PCWD_PRODUCT_ID     0x1140
  94
  95 /* table of devices that work with this driver */
  96 static struct usb_device_id usb_pcwd_table [] = {
  97         { USB_DEVICE(USB_PCWD_VENDOR_ID, USB_PCWD_PRODUCT_ID) },
  98         { }                                     /* Terminating entry */
  99 };
 100 MODULE_DEVICE_TABLE (usb, usb_pcwd_table);
 101
 102 /* according to documentation max. time to process a command for the USB
 103  * watchdog card is 100 or 200 ms, so we give it 250 ms to do it's job */
 104 #define USB_COMMAND_TIMEOUT     250
 105
 106 /* Watchdog's internal commands */
 107 #define CMD_READ_TEMP                   0x02    /* Read Temperature; Re-trigger Watchdog */
 108 #define CMD_TRIGGER                     CMD_READ_TEMP
 109 #define CMD_GET_STATUS                  0x04    /* Get Status Information */
 110 #define CMD_GET_FIRMWARE_VERSION        0x08    /* Get Firmware Version */
 111 #define CMD_GET_DIP_SWITCH_SETTINGS     0x0c    /* Get Dip Switch Settings */
 112 #define CMD_READ_WATCHDOG_TIMEOUT       0x18    /* Read Current Watchdog Time */
 113 #define CMD_WRITE_WATCHDOG_TIMEOUT      0x19    /* Write Current Watchdog Time */
 114 #define CMD_ENABLE_WATCHDOG             0x30    /* Enable / Disable Watchdog */
 115 #define CMD_DISABLE_WATCHDOG            CMD_ENABLE_WATCHDOG
 116
 117 /* Some defines that I like to be somewhere else like include/linux/usb_hid.h */
 118 #define HID_REQ_SET_REPORT              0x09
 119 #define HID_DT_REPORT                   (USB_TYPE_CLASS | 0x02)
 120
 121 /* We can only use 1 card due to the /dev/watchdog restriction */
 122 static int cards_found;
 123
 124 /* some internal variables */
 125 static unsigned long is_active;
 126 static char expect_release;
 127
 128 /* Structure to hold all of our device specific stuff */
 129 struct usb_pcwd_private {
 130         struct usb_device *     udev;                   /* save off the usb device pointer */
 131         struct usb_interface *  interface;              /* the interface for this device */
 132
 133         unsigned int            interface_number;       /* the interface number used for cmd's */
 134
 135         unsigned char *         intr_buffer;            /* the buffer to intr data */
 136         dma_addr_t              intr_dma;               /* the dma address for the intr buffer */
 137         size_t                  intr_size;              /* the size of the intr buffer */
 138         struct urb *            intr_urb;               /* the urb used for the intr pipe */
 139
 140         unsigned char           cmd_command;            /* The command that is reported back */
 141         unsigned char           cmd_data_msb;           /* The data MSB that is reported back */
 142         unsigned char           cmd_data_lsb;           /* The data LSB that is reported back */
 143         atomic_t                cmd_received;           /* true if we received a report after a command */
 144
 145         int                     exists;                 /* Wether or not the device exists */
 146         struct semaphore        sem;                    /* locks this structure */
 147 };
 148 static struct usb_pcwd_private *usb_pcwd_device;
 149
 150 /* prevent races between open() and disconnect() */
 151 static DECLARE_MUTEX (disconnect_sem);
 152
 153 /* local function prototypes */
 154 static int usb_pcwd_probe       (struct usb_interface *interface, const struct usb_device_id *id);
 155 static void usb_pcwd_disconnect (struct usb_interface *interface);
 156
 157 /* usb specific object needed to register this driver with the usb subsystem */
 158 static struct usb_driver usb_pcwd_driver = {
 159         .owner =        THIS_MODULE,
 160         .name =         DRIVER_NAME,
 161         .probe =        usb_pcwd_probe,
 162         .disconnect =   usb_pcwd_disconnect,
 163         .id_table =     usb_pcwd_table,
 164 };
 165
 166
 167 static void usb_pcwd_intr_done(struct urb *urb, struct pt_regs *regs)
 168 {
 169         struct usb_pcwd_private *usb_pcwd = (struct usb_pcwd_private *)urb->context;
 170         unsigned char *data = usb_pcwd->intr_buffer;
 171         int retval;
 172
 173         switch (urb->status) {
 174         case 0:                 /* success */
 175                 break;
 176         case -ECONNRESET:       /* unlink */
 177         case -ENOENT:
 178         case -ESHUTDOWN:
 179                 /* this urb is terminated, clean up */
 180                 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
 181                 return;
 182         /* -EPIPE:  should clear the halt */
 183         default:                /* error */
 184                 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
 185                 goto resubmit;
 186         }
 187
 188         dbg("received following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
 189                 data[0], data[1], data[2]);
 190
 191         usb_pcwd->cmd_command  = data[0];
 192         usb_pcwd->cmd_data_msb = data[1];
 193         usb_pcwd->cmd_data_lsb = data[2];
 194
 195         /* notify anyone waiting that the cmd has finished */
 196         atomic_set (&usb_pcwd->cmd_received, 1);
 197
 198 resubmit:
 199         retval = usb_submit_urb (urb, GFP_ATOMIC);
 200         if (retval)
 201                 printk(KERN_ERR PFX "can't resubmit intr, usb_submit_urb failed with result %d\n",
 202                         retval);
 203 }
 204
 205 static int usb_pcwd_send_command(struct usb_pcwd_private *usb_pcwd, unsigned char cmd,
 206         unsigned char *msb, unsigned char *lsb)
 207 {
 208         int got_response, count;
 209         unsigned char buf[6];
 210
 211         /* We will not send any commands if the USB PCWD device does not exist */
 212         if ((!usb_pcwd) || (!usb_pcwd->exists))
 213                 return -1;
 214
 215         /* The USB PC Watchdog uses a 6 byte report format. The board currently uses
 216          * only 3 of the six bytes of the report. */
 217         buf[0] = cmd;                   /* Byte 0 = CMD */
 218         buf[1] = *msb;                  /* Byte 1 = Data MSB */
 219         buf[2] = *lsb;                  /* Byte 2 = Data LSB */
 220         buf[3] = buf[4] = buf[5] = 0;   /* All other bytes not used */
 221
 222         dbg("sending following data cmd=0x%02x msb=0x%02x lsb=0x%02x",
 223                 buf[0], buf[1], buf[2]);
 224
 225         atomic_set (&usb_pcwd->cmd_received, 0);
 226
 227         if (usb_control_msg(usb_pcwd->udev, usb_sndctrlpipe(usb_pcwd->udev, 0),
 228                         HID_REQ_SET_REPORT, HID_DT_REPORT,
 229                         0x0200, usb_pcwd->interface_number, buf, sizeof(buf),
 230                         HZ) != sizeof(buf)) {
 231                 dbg("usb_pcwd_send_command: error in usb_control_msg for cmd 0x%x 0x%x 0x%x\n", cmd, *msb, *lsb);
 232         }
 233         /* wait till the usb card processed the command,
 234          * with a max. timeout of USB_COMMAND_TIMEOUT */
 235         got_response = 0;
 236         for (count = 0; (count < USB_COMMAND_TIMEOUT) && (!got_response); count++) {
 237                 mdelay(1);
 238                 if (atomic_read (&usb_pcwd->cmd_received))
 239                         got_response = 1;
 240         }
 241
 242         if ((got_response) && (cmd == usb_pcwd->cmd_command)) {
 243                 /* read back response */
 244                 *msb = usb_pcwd->cmd_data_msb;
 245                 *lsb = usb_pcwd->cmd_data_lsb;
 246         }
 247
 248         return got_response;
 249 }
 250
 251 static int usb_pcwd_start(struct usb_pcwd_private *usb_pcwd)
 252 {
 253         unsigned char msb = 0x00;
 254         unsigned char lsb = 0x00;
 255         int retval;
 256
 257         /* Enable Watchdog */
 258         retval = usb_pcwd_send_command(usb_pcwd, CMD_ENABLE_WATCHDOG, &msb, &lsb);
 259
 260         if ((retval == 0) || (lsb == 0)) {
 261                 printk(KERN_ERR PFX "Card did not acknowledge enable attempt\n");
 262                 return -1;
 263         }
 264
 265         return 0;
 266 }
 267
 268 static int usb_pcwd_stop(struct usb_pcwd_private *usb_pcwd)
 269 {
 270         unsigned char msb = 0xA5;
 271         unsigned char lsb = 0xC3;
 272         int retval;
 273
 274         /* Disable Watchdog */
 275         retval = usb_pcwd_send_command(usb_pcwd, CMD_DISABLE_WATCHDOG, &msb, &lsb);
 276
 277         if ((retval == 0) || (lsb != 0)) {
 278                 printk(KERN_ERR PFX "Card did not acknowledge disable attempt\n");
 279                 return -1;
 280         }
 281
 282         return 0;
 283 }
 284
 285 static int usb_pcwd_keepalive(struct usb_pcwd_private *usb_pcwd)
 286 {
 287         unsigned char dummy;
 288
 289         /* Re-trigger Watchdog */
 290         usb_pcwd_send_command(usb_pcwd, CMD_TRIGGER, &dummy, &dummy);
 291
 292         return 0;
 293 }
 294
 295 static int usb_pcwd_set_heartbeat(struct usb_pcwd_private *usb_pcwd, int t)
 296 {
 297         unsigned char msb = t / 256;
 298         unsigned char lsb = t % 256;
 299
 300         if ((t < 0x0001) || (t > 0xFFFF))
 301                 return -EINVAL;
 302
 303         /* Write new heartbeat to watchdog */
 304         usb_pcwd_send_command(usb_pcwd, CMD_WRITE_WATCHDOG_TIMEOUT, &msb, &lsb);
 305
 306         heartbeat = t;
 307         return 0;
 308 }
 309
 310 static int usb_pcwd_get_temperature(struct usb_pcwd_private *usb_pcwd, int *temperature)
 311 {
 312         unsigned char msb, lsb;
 313
 314         usb_pcwd_send_command(usb_pcwd, CMD_READ_TEMP, &msb, &lsb);
 315
 316         /*
 317          * Convert celsius to fahrenheit, since this was
 318          * the decided 'standard' for this return value.
 319          */
 320         *temperature = (lsb * 9 / 5) + 32;
 321
 322         return 0;
 323 }
 324
 325 /*
 326  *      /dev/watchdog handling
 327  */
 328
 329 static ssize_t usb_pcwd_write(struct file *file, const char *data,
 330                               size_t len, loff_t *ppos)
 331 {
 332         /* Can't seek (pwrite) on this device  */
 333         if (ppos != &file->f_pos)
 334                 return -ESPIPE;
 335
 336         /* See if we got the magic character 'V' and reload the timer */
 337         if (len) {
 338                 if (!nowayout) {
 339                         size_t i;
 340
 341                         /* note: just in case someone wrote the magic character
 342                          * five months ago... */
 343                         expect_release = 0;
 344
 345                         /* scan to see whether or not we got the magic character */
 346                         for (i = 0; i != len; i++) {
 347                                 char c;
 348                                 if(get_user(c, data+i))
 349                                         return -EFAULT;
 350                                 if (c == 'V')
 351                                         expect_release = 42;
 352                         }
 353                 }
 354
 355                 /* someone wrote to us, we should reload the timer */
 356                 usb_pcwd_keepalive(usb_pcwd_device);
 357         }
 358         return len;
 359 }
 360
 361 static int usb_pcwd_ioctl(struct inode *inode, struct file *file,
 362                           unsigned int cmd, unsigned long arg)
 363 {
 364         static struct watchdog_info ident = {
 365                 .options =              WDIOF_KEEPALIVEPING |
 366                                         WDIOF_SETTIMEOUT |
 367                                         WDIOF_MAGICCLOSE,
 368                 .firmware_version =     1,
 369                 .identity =             DRIVER_NAME,
 370         };
 371
 372         switch (cmd) {
 373                 case WDIOC_GETSUPPORT:
 374                         return copy_to_user((struct watchdog_info *) arg, &ident,
 375                                 sizeof (ident)) ? -EFAULT : 0;
 376
 377                 case WDIOC_GETSTATUS:
 378                 case WDIOC_GETBOOTSTATUS:
 379                         return put_user(0, (int *) arg);
 380
 381                 case WDIOC_GETTEMP:
 382                 {
 383                         int temperature;
 384
 385                         if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
 386                                 return -EFAULT;
 387
 388                         return put_user(temperature, (int *) arg);
 389                 }
 390
 391                 case WDIOC_KEEPALIVE:
 392                         usb_pcwd_keepalive(usb_pcwd_device);
 393                         return 0;
 394
 395                 case WDIOC_SETOPTIONS:
 396                 {
 397                         int new_options, retval = -EINVAL;
 398
 399                         if (get_user (new_options, (int *) arg))
 400                                 return -EFAULT;
 401
 402                         if (new_options & WDIOS_DISABLECARD) {
 403                                 usb_pcwd_stop(usb_pcwd_device);
 404                                 retval = 0;
 405                         }
 406
 407                         if (new_options & WDIOS_ENABLECARD) {
 408                                 usb_pcwd_start(usb_pcwd_device);
 409                                 retval = 0;
 410                         }
 411
 412                         return retval;
 413                 }
 414
 415                 case WDIOC_SETTIMEOUT:
 416                 {
 417                         int new_heartbeat;
 418
 419                         if (get_user(new_heartbeat, (int *) arg))
 420                                 return -EFAULT;
 421
 422                         if (usb_pcwd_set_heartbeat(usb_pcwd_device, new_heartbeat))
 423                             return -EINVAL;
 424
 425                         usb_pcwd_keepalive(usb_pcwd_device);
 426                         /* Fall */
 427                 }
 428
 429                 case WDIOC_GETTIMEOUT:
 430                         return put_user(heartbeat, (int *)arg);
 431
 432                 default:
 433                         return -ENOIOCTLCMD;
 434         }
 435 }
 436
 437 static int usb_pcwd_open(struct inode *inode, struct file *file)
 438 {
 439         /* /dev/watchdog can only be opened once */
 440         if (test_and_set_bit(0, &is_active))
 441                 return -EBUSY;
 442
 443         /* Activate */
 444         usb_pcwd_start(usb_pcwd_device);
 445         usb_pcwd_keepalive(usb_pcwd_device);
 446         return 0;
 447 }
 448
 449 static int usb_pcwd_release(struct inode *inode, struct file *file)
 450 {
 451         /*
 452          *      Shut off the timer.
 453          */
 454         if (expect_release == 42) {
 455                 usb_pcwd_stop(usb_pcwd_device);
 456         } else {
 457                 printk(KERN_CRIT PFX "Unexpected close, not stopping watchdog!\n");
 458                 usb_pcwd_keepalive(usb_pcwd_device);
 459         }
 460         expect_release = 0;
 461         clear_bit(0, &is_active);
 462         return 0;
 463 }
 464
 465 /*
 466  *      /dev/temperature handling
 467  */
 468
 469 static ssize_t usb_pcwd_temperature_read(struct file *file, char *data,
 470                                 size_t len, loff_t *ppos)
 471 {
 472         int temperature;
 473
 474         /* Can't seek (pwrite) on this device  */
 475         if (ppos != &file->f_pos)
 476                 return -ESPIPE;
 477
 478         if (usb_pcwd_get_temperature(usb_pcwd_device, &temperature))
 479                 return -EFAULT;
 480
 481         if (copy_to_user (data, &temperature, 1))
 482                 return -EFAULT;
 483
 484         return 1;
 485 }
 486
 487 static int usb_pcwd_temperature_open(struct inode *inode, struct file *file)
 488 {
 489         return 0;
 490 }
 491
 492 static int usb_pcwd_temperature_release(struct inode *inode, struct file *file)
 493 {
 494         return 0;
 495 }
 496
 497 /*
 498  *      Notify system
 499  */
 500
 501 static int usb_pcwd_notify_sys(struct notifier_block *this, unsigned long code, void *unused)
 502 {
 503         if (code==SYS_DOWN || code==SYS_HALT) {
 504                 /* Turn the WDT off */
 505                 usb_pcwd_stop(usb_pcwd_device);
 506         }
 507
 508         return NOTIFY_DONE;
 509 }
 510
 511 /*
 512  *      Kernel Interfaces
 513  */
 514
 515 static struct file_operations usb_pcwd_fops = {
 516         .owner =        THIS_MODULE,
 517         .llseek =       no_llseek,
 518         .write =        usb_pcwd_write,
 519         .ioctl =        usb_pcwd_ioctl,
 520         .open =         usb_pcwd_open,
 521         .release =      usb_pcwd_release,
 522 };
 523
 524 static struct miscdevice usb_pcwd_miscdev = {
 525         .minor =        WATCHDOG_MINOR,
 526         .name =         "watchdog",
 527         .fops =         &usb_pcwd_fops,
 528 };
 529
 530 static struct file_operations usb_pcwd_temperature_fops = {
 531         .owner =        THIS_MODULE,
 532         .llseek =       no_llseek,
 533         .read =         usb_pcwd_temperature_read,
 534         .open =         usb_pcwd_temperature_open,
 535         .release =      usb_pcwd_temperature_release,
 536 };
 537
 538 static struct miscdevice usb_pcwd_temperature_miscdev = {
 539         .minor =        TEMP_MINOR,
 540         .name =         "temperature",
 541         .fops =         &usb_pcwd_temperature_fops,
 542 };
 543
 544 static struct notifier_block usb_pcwd_notifier = {
 545         .notifier_call =        usb_pcwd_notify_sys,
 546 };
 547
 548 /**
 549  *      usb_pcwd_delete
 550  */
 551 static inline void usb_pcwd_delete (struct usb_pcwd_private *usb_pcwd)
 552 {
 553         if (usb_pcwd->intr_urb != NULL)
 554                 usb_free_urb (usb_pcwd->intr_urb);
 555         if (usb_pcwd->intr_buffer != NULL)
 556                 usb_buffer_free(usb_pcwd->udev, usb_pcwd->intr_size,
 557                                 usb_pcwd->intr_buffer, usb_pcwd->intr_dma);
 558         kfree (usb_pcwd);
 559 }
 560
 561 /**
 562  *      usb_pcwd_probe
 563  *
 564  *      Called by the usb core when a new device is connected that it thinks
 565  *      this driver might be interested in.
 566  */
 567 static int usb_pcwd_probe(struct usb_interface *interface, const struct usb_device_id *id)
 568 {
 569         struct usb_device *udev = interface_to_usbdev(interface);
 570         struct usb_host_interface *iface_desc;
 571         struct usb_endpoint_descriptor *endpoint;
 572         struct usb_pcwd_private *usb_pcwd = NULL;
 573         int pipe, maxp;
 574         int retval = -ENOMEM;
 575         int got_fw_rev;
 576         unsigned char fw_rev_major, fw_rev_minor;
 577         char fw_ver_str[20];
 578         unsigned char option_switches, dummy;
 579
 580         /* See if the device offered us matches what we can accept */
 581         if ((udev->descriptor.idVendor != USB_PCWD_VENDOR_ID) ||
 582             (udev->descriptor.idProduct != USB_PCWD_PRODUCT_ID)) {
 583                 return -ENODEV;
 584         }
 585
 586         cards_found++;
 587         if (cards_found > 1) {
 588                 printk(KERN_ERR PFX "This driver only supports 1 device\n");
 589                 return -ENODEV;
 590         }
 591
 592         /* get the active interface descriptor */
 593         iface_desc = interface->cur_altsetting;
 594
 595         /* check out that we have a HID device */
 596         if (!(iface_desc->desc.bInterfaceClass == USB_CLASS_HID)) {
 597                 printk(KERN_ERR PFX "The device isn't a Human Interface Device\n");
 598                 return -ENODEV;
 599         }
 600
 601         /* check out the endpoint: it has to be Interrupt & IN */
 602         endpoint = &iface_desc->endpoint[0].desc;
 603
 604         if (!((endpoint->bEndpointAddress & USB_DIR_IN) &&
 605              ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
 606                                 == USB_ENDPOINT_XFER_INT))) {
 607                 /* we didn't find a Interrupt endpoint with direction IN */
 608                 printk(KERN_ERR PFX "Couldn't find an INTR & IN endpoint\n");
 609                 return -ENODEV;
 610         }
 611
 612         /* get a handle to the interrupt data pipe */
 613         pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
 614         maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
 615
 616         /* allocate memory for our device and initialize it */
 617         usb_pcwd = kmalloc (sizeof(struct usb_pcwd_private), GFP_KERNEL);
 618         if (usb_pcwd == NULL) {
 619                 printk(KERN_ERR PFX "Out of memory\n");
 620                 goto error;
 621         }
 622         memset (usb_pcwd, 0x00, sizeof (*usb_pcwd));
 623
 624         usb_pcwd_device = usb_pcwd;
 625
 626         init_MUTEX (&usb_pcwd->sem);
 627         usb_pcwd->udev = udev;
 628         usb_pcwd->interface = interface;
 629         usb_pcwd->interface_number = iface_desc->desc.bInterfaceNumber;
 630         usb_pcwd->intr_size = (endpoint->wMaxPacketSize > 8 ? endpoint->wMaxPacketSize : 8);
 631
 632         /* set up the memory buffer's */
 633         if (!(usb_pcwd->intr_buffer = usb_buffer_alloc(udev, usb_pcwd->intr_size, SLAB_ATOMIC, &usb_pcwd->intr_dma))) {
 634                 printk(KERN_ERR PFX "Out of memory\n");
 635                 goto error;
 636         }
 637
 638         /* allocate the urb's */
 639         usb_pcwd->intr_urb = usb_alloc_urb(0, GFP_KERNEL);
 640         if (!usb_pcwd->intr_urb) {
 641                 printk(KERN_ERR PFX "Out of memory\n");
 642                 goto error;
 643         }
 644
 645         /* initialise the intr urb's */
 646         usb_fill_int_urb(usb_pcwd->intr_urb, udev, pipe,
 647                         usb_pcwd->intr_buffer, usb_pcwd->intr_size,
 648                         usb_pcwd_intr_done, usb_pcwd, endpoint->bInterval);
 649         usb_pcwd->intr_urb->transfer_dma = usb_pcwd->intr_dma;
 650         usb_pcwd->intr_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 651
 652         /* register our interrupt URB with the USB system */
 653         if (usb_submit_urb(usb_pcwd->intr_urb, GFP_KERNEL)) {
 654                 printk(KERN_ERR PFX "Problem registering interrupt URB\n");
 655                 retval = -EIO; /* failure */
 656                 goto error;
 657         }
 658
 659         /* The device exists and can be communicated with */
 660         usb_pcwd->exists = 1;
 661
 662         /* disable card */
 663         usb_pcwd_stop(usb_pcwd);
 664
 665         /* Get the Firmware Version */
 666         got_fw_rev = usb_pcwd_send_command(usb_pcwd, CMD_GET_FIRMWARE_VERSION, &fw_rev_major, &fw_rev_minor);
 667         if (got_fw_rev) {
 668                 sprintf(fw_ver_str, "%u.%02u", fw_rev_major, fw_rev_minor);
 669         } else {
 670                 sprintf(fw_ver_str, "<card no answer>");
 671         }
 672
 673         printk(KERN_INFO PFX "Found card (Firmware: %s) with temp option\n",
 674                 fw_ver_str);
 675
 676         /* Get switch settings */
 677         usb_pcwd_send_command(usb_pcwd, CMD_GET_DIP_SWITCH_SETTINGS, &dummy, &option_switches);
 678
 679         printk(KERN_INFO PFX "Option switches (0x%02x): Temperature Reset Enable=%s, Power On Delay=%s\n",
 680                 option_switches,
 681                 ((option_switches & 0x10) ? "ON" : "OFF"),
 682                 ((option_switches & 0x08) ? "ON" : "OFF"));
 683
 684         /* Check that the heartbeat value is within it's range ; if not reset to the default */
 685         if (usb_pcwd_set_heartbeat(usb_pcwd, heartbeat)) {
 686                 usb_pcwd_set_heartbeat(usb_pcwd, WATCHDOG_HEARTBEAT);
 687                 printk(KERN_INFO PFX "heartbeat value must be 0<heartbeat<65536, using %d\n",
 688                         WATCHDOG_HEARTBEAT);
 689         }
 690
 691         retval = register_reboot_notifier(&usb_pcwd_notifier);
 692         if (retval != 0) {
 693                 printk(KERN_ERR PFX "cannot register reboot notifier (err=%d)\n",
 694                         retval);
 695                 goto error;
 696         }
 697
 698         retval = misc_register(&usb_pcwd_temperature_miscdev);
 699         if (retval != 0) {
 700                 printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 701                         TEMP_MINOR, retval);
 702                 goto err_out_unregister_reboot;
 703         }
 704
 705         retval = misc_register(&usb_pcwd_miscdev);
 706         if (retval != 0) {
 707                 printk(KERN_ERR PFX "cannot register miscdev on minor=%d (err=%d)\n",
 708                         WATCHDOG_MINOR, retval);
 709                 goto err_out_misc_deregister;
 710         }
 711
 712         /* we can register the device now, as it is ready */
 713         usb_set_intfdata (interface, usb_pcwd);
 714
 715         printk(KERN_INFO PFX "initialized. heartbeat=%d sec (nowayout=%d)\n",
 716                 heartbeat, nowayout);
 717
 718         return 0;
 719
 720 err_out_misc_deregister:
 721         misc_deregister(&usb_pcwd_temperature_miscdev);
 722 err_out_unregister_reboot:
 723         unregister_reboot_notifier(&usb_pcwd_notifier);
 724 error:
 725         usb_pcwd_delete (usb_pcwd);
 726         usb_pcwd_device = NULL;
 727         return retval;
 728 }
 729
 730
 731 /**
 732  *      usb_pcwd_disconnect
 733  *
 734  *      Called by the usb core when the device is removed from the system.
 735  *
 736  *      This routine guarantees that the driver will not submit any more urbs
 737  *      by clearing dev->udev.
 738  */
 739 static void usb_pcwd_disconnect(struct usb_interface *interface)
 740 {
 741         struct usb_pcwd_private *usb_pcwd;
 742
 743         /* prevent races with open() */
 744         down (&disconnect_sem);
 745
 746         usb_pcwd = usb_get_intfdata (interface);
 747         usb_set_intfdata (interface, NULL);
 748
 749         down (&usb_pcwd->sem);
 750
 751         /* Stop the timer before we leave */
 752         if (!nowayout)
 753                 usb_pcwd_stop(usb_pcwd);
 754
 755         /* We should now stop communicating with the USB PCWD device */
 756         usb_pcwd->exists = 0;
 757
 758         /* Deregister */
 759         misc_deregister(&usb_pcwd_miscdev);
 760         misc_deregister(&usb_pcwd_temperature_miscdev);
 761         unregister_reboot_notifier(&usb_pcwd_notifier);
 762
 763         up (&usb_pcwd->sem);
 764
 765         /* Delete the USB PCWD device */
 766         usb_pcwd_delete(usb_pcwd);
 767
 768         cards_found--;
 769
 770         up (&disconnect_sem);
 771
 772         printk(KERN_INFO PFX "USB PC Watchdog disconnected\n");
 773 }
 774
 775
 776
 777 /**
 778  *      usb_pcwd_init
 779  */
 780 static int __init usb_pcwd_init(void)
 781 {
 782         int result;
 783
 784         /* register this driver with the USB subsystem */
 785         result = usb_register(&usb_pcwd_driver);
 786         if (result) {
 787                 printk(KERN_ERR PFX "usb_register failed. Error number %d\n",
 788                     result);
 789                 return result;
 790         }
 791
 792         printk(KERN_INFO PFX DRIVER_DESC " v" DRIVER_VERSION " (" DRIVER_DATE ")\n");
 793         return 0;
 794 }
 795
 796
 797 /**
 798  *      usb_pcwd_exit
 799  */
 800 static void __exit usb_pcwd_exit(void)
 801 {
 802         /* deregister this driver with the USB subsystem */
 803         usb_deregister(&usb_pcwd_driver);
 804 }
 805
 806
 807 module_init (usb_pcwd_init);
 808 module_exit (usb_pcwd_exit);