pcwd_usb.c 22 KB

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