drivers/watchdog/pcwd_usb.c

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