2 * Generic USB driver for report based interrupt in/out devices
3 * like LD Didactic's USB devices. LD Didactic's USB devices are
4 * HID devices which do not use HID report definitons (they use
5 * raw interrupt in and our reports only for communication).
7 * This driver uses a ring buffer for time critical reading of
8 * interrupt in reports and provides read and write methods for
9 * raw interrupt reports (similar to the Windows HID driver).
10 * Devices based on the book USB COMPLETE by Jan Axelson may need
11 * such a compatibility to the Windows HID driver.
13 * Copyright (C) 2005 Michael Hund <mhund@ld-didactic.de>
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License as
17 * published by the Free Software Foundation; either version 2 of
18 * the License, or (at your option) any later version.
20 * Derived from Lego USB Tower driver
21 * Copyright (C) 2003 David Glance <advidgsf@sourceforge.net>
22 * 2001-2004 Juergen Stuber <starblue@users.sourceforge.net>
25 #include <linux/kernel.h>
26 #include <linux/errno.h>
27 #include <linux/slab.h>
28 #include <linux/module.h>
29 #include <linux/mutex.h>
31 #include <asm/uaccess.h>
32 #include <linux/input.h>
33 #include <linux/usb.h>
34 #include <linux/poll.h>
36 /* Define these values to match your devices */
37 #define USB_VENDOR_ID_LD 0x0f11 /* USB Vendor ID of LD Didactic GmbH */
38 #define USB_DEVICE_ID_LD_CASSY 0x1000 /* USB Product ID of CASSY-S modules with 8 bytes endpoint size */
39 #define USB_DEVICE_ID_LD_CASSY2 0x1001 /* USB Product ID of CASSY-S modules with 64 bytes endpoint size */
40 #define USB_DEVICE_ID_LD_POCKETCASSY 0x1010 /* USB Product ID of Pocket-CASSY */
41 #define USB_DEVICE_ID_LD_POCKETCASSY2 0x1011 /* USB Product ID of Pocket-CASSY 2 (reserved) */
42 #define USB_DEVICE_ID_LD_MOBILECASSY 0x1020 /* USB Product ID of Mobile-CASSY */
43 #define USB_DEVICE_ID_LD_MOBILECASSY2 0x1021 /* USB Product ID of Mobile-CASSY 2 (reserved) */
44 #define USB_DEVICE_ID_LD_MICROCASSYVOLTAGE 0x1031 /* USB Product ID of Micro-CASSY Voltage */
45 #define USB_DEVICE_ID_LD_MICROCASSYCURRENT 0x1032 /* USB Product ID of Micro-CASSY Current */
46 #define USB_DEVICE_ID_LD_MICROCASSYTIME 0x1033 /* USB Product ID of Micro-CASSY Time (reserved) */
47 #define USB_DEVICE_ID_LD_MICROCASSYTEMPERATURE 0x1035 /* USB Product ID of Micro-CASSY Temperature */
48 #define USB_DEVICE_ID_LD_MICROCASSYPH 0x1038 /* USB Product ID of Micro-CASSY pH */
49 #define USB_DEVICE_ID_LD_POWERANALYSERCASSY 0x1040 /* USB Product ID of Power Analyser CASSY */
50 #define USB_DEVICE_ID_LD_CONVERTERCONTROLLERCASSY 0x1042 /* USB Product ID of Converter Controller CASSY */
51 #define USB_DEVICE_ID_LD_MACHINETESTCASSY 0x1043 /* USB Product ID of Machine Test CASSY */
52 #define USB_DEVICE_ID_LD_JWM 0x1080 /* USB Product ID of Joule and Wattmeter */
53 #define USB_DEVICE_ID_LD_DMMP 0x1081 /* USB Product ID of Digital Multimeter P (reserved) */
54 #define USB_DEVICE_ID_LD_UMIP 0x1090 /* USB Product ID of UMI P */
55 #define USB_DEVICE_ID_LD_UMIC 0x10A0 /* USB Product ID of UMI C */
56 #define USB_DEVICE_ID_LD_UMIB 0x10B0 /* USB Product ID of UMI B */
57 #define USB_DEVICE_ID_LD_XRAY 0x1100 /* USB Product ID of X-Ray Apparatus 55481 */
58 #define USB_DEVICE_ID_LD_XRAY2 0x1101 /* USB Product ID of X-Ray Apparatus 554800 */
59 #define USB_DEVICE_ID_LD_XRAYCT 0x1110 /* USB Product ID of X-Ray Apparatus CT 554821*/
60 #define USB_DEVICE_ID_LD_VIDEOCOM 0x1200 /* USB Product ID of VideoCom */
61 #define USB_DEVICE_ID_LD_MOTOR 0x1210 /* USB Product ID of Motor (reserved) */
62 #define USB_DEVICE_ID_LD_COM3LAB 0x2000 /* USB Product ID of COM3LAB */
63 #define USB_DEVICE_ID_LD_TELEPORT 0x2010 /* USB Product ID of Terminal Adapter */
64 #define USB_DEVICE_ID_LD_NETWORKANALYSER 0x2020 /* USB Product ID of Network Analyser */
65 #define USB_DEVICE_ID_LD_POWERCONTROL 0x2030 /* USB Product ID of Converter Control Unit */
66 #define USB_DEVICE_ID_LD_MACHINETEST 0x2040 /* USB Product ID of Machine Test System */
67 #define USB_DEVICE_ID_LD_MOSTANALYSER 0x2050 /* USB Product ID of MOST Protocol Analyser */
68 #define USB_DEVICE_ID_LD_MOSTANALYSER2 0x2051 /* USB Product ID of MOST Protocol Analyser 2 */
69 #define USB_DEVICE_ID_LD_ABSESP 0x2060 /* USB Product ID of ABS ESP */
70 #define USB_DEVICE_ID_LD_AUTODATABUS 0x2070 /* USB Product ID of Automotive Data Buses */
71 #define USB_DEVICE_ID_LD_MCT 0x2080 /* USB Product ID of Microcontroller technique */
72 #define USB_DEVICE_ID_LD_HYBRID 0x2090 /* USB Product ID of Automotive Hybrid */
73 #define USB_DEVICE_ID_LD_HEATCONTROL 0x20A0 /* USB Product ID of Heat control */
75 #ifdef CONFIG_USB_DYNAMIC_MINORS
76 #define USB_LD_MINOR_BASE 0
78 #define USB_LD_MINOR_BASE 176
81 /* table of devices that work with this driver */
82 static const struct usb_device_id ld_usb_table[] = {
83 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CASSY) },
84 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CASSY2) },
85 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POCKETCASSY) },
86 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POCKETCASSY2) },
87 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOBILECASSY) },
88 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOBILECASSY2) },
89 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MICROCASSYVOLTAGE) },
90 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MICROCASSYCURRENT) },
91 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MICROCASSYTIME) },
92 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MICROCASSYTEMPERATURE) },
93 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MICROCASSYPH) },
94 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POWERANALYSERCASSY) },
95 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CONVERTERCONTROLLERCASSY) },
96 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MACHINETESTCASSY) },
97 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_JWM) },
98 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_DMMP) },
99 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIP) },
100 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIC) },
101 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIB) },
102 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY) },
103 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY2) },
104 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_VIDEOCOM) },
105 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOTOR) },
106 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_COM3LAB) },
107 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_TELEPORT) },
108 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_NETWORKANALYSER) },
109 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POWERCONTROL) },
110 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MACHINETEST) },
111 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOSTANALYSER) },
112 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOSTANALYSER2) },
113 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_ABSESP) },
114 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_AUTODATABUS) },
115 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MCT) },
116 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_HYBRID) },
117 { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_HEATCONTROL) },
118 { } /* Terminating entry */
120 MODULE_DEVICE_TABLE(usb, ld_usb_table);
121 MODULE_VERSION("V0.14");
122 MODULE_AUTHOR("Michael Hund <mhund@ld-didactic.de>");
123 MODULE_DESCRIPTION("LD USB Driver");
124 MODULE_LICENSE("GPL");
125 MODULE_SUPPORTED_DEVICE("LD USB Devices");
127 /* All interrupt in transfers are collected in a ring buffer to
128 * avoid racing conditions and get better performance of the driver.
130 static int ring_buffer_size = 128;
131 module_param(ring_buffer_size, int, 0);
132 MODULE_PARM_DESC(ring_buffer_size, "Read ring buffer size in reports");
134 /* The write_buffer can contain more than one interrupt out transfer.
136 static int write_buffer_size = 10;
137 module_param(write_buffer_size, int, 0);
138 MODULE_PARM_DESC(write_buffer_size, "Write buffer size in reports");
140 /* As of kernel version 2.6.4 ehci-hcd uses an
141 * "only one interrupt transfer per frame" shortcut
142 * to simplify the scheduling of periodic transfers.
143 * This conflicts with our standard 1ms intervals for in and out URBs.
144 * We use default intervals of 2ms for in and 2ms for out transfers,
145 * which should be fast enough.
146 * Increase the interval to allow more devices that do interrupt transfers,
147 * or set to 1 to use the standard interval from the endpoint descriptors.
149 static int min_interrupt_in_interval = 2;
150 module_param(min_interrupt_in_interval, int, 0);
151 MODULE_PARM_DESC(min_interrupt_in_interval, "Minimum interrupt in interval in ms");
153 static int min_interrupt_out_interval = 2;
154 module_param(min_interrupt_out_interval, int, 0);
155 MODULE_PARM_DESC(min_interrupt_out_interval, "Minimum interrupt out interval in ms");
157 /* Structure to hold all of our device specific stuff */
159 struct mutex mutex; /* locks this structure */
160 struct usb_interface* intf; /* save off the usb interface pointer */
161 unsigned long disconnected:1;
163 int open_count; /* number of times this port has been opened */
166 unsigned int ring_head;
167 unsigned int ring_tail;
169 wait_queue_head_t read_wait;
170 wait_queue_head_t write_wait;
172 char* interrupt_in_buffer;
173 struct usb_endpoint_descriptor* interrupt_in_endpoint;
174 struct urb* interrupt_in_urb;
175 int interrupt_in_interval;
176 size_t interrupt_in_endpoint_size;
177 int interrupt_in_running;
178 int interrupt_in_done;
182 char* interrupt_out_buffer;
183 struct usb_endpoint_descriptor* interrupt_out_endpoint;
184 struct urb* interrupt_out_urb;
185 int interrupt_out_interval;
186 size_t interrupt_out_endpoint_size;
187 int interrupt_out_busy;
190 static struct usb_driver ld_usb_driver;
193 * ld_usb_abort_transfers
194 * aborts transfers and frees associated data structures
196 static void ld_usb_abort_transfers(struct ld_usb *dev)
198 /* shutdown transfer */
199 if (dev->interrupt_in_running) {
200 dev->interrupt_in_running = 0;
201 usb_kill_urb(dev->interrupt_in_urb);
203 if (dev->interrupt_out_busy)
204 usb_kill_urb(dev->interrupt_out_urb);
210 static void ld_usb_delete(struct ld_usb *dev)
212 /* free data structures */
213 usb_free_urb(dev->interrupt_in_urb);
214 usb_free_urb(dev->interrupt_out_urb);
215 kfree(dev->ring_buffer);
216 kfree(dev->interrupt_in_buffer);
217 kfree(dev->interrupt_out_buffer);
222 * ld_usb_interrupt_in_callback
224 static void ld_usb_interrupt_in_callback(struct urb *urb)
226 struct ld_usb *dev = urb->context;
227 size_t *actual_buffer;
228 unsigned int next_ring_head;
229 int status = urb->status;
233 if (status == -ENOENT ||
234 status == -ECONNRESET ||
235 status == -ESHUTDOWN) {
238 dev_dbg(&dev->intf->dev,
239 "%s: nonzero status received: %d\n", __func__,
241 spin_lock(&dev->rbsl);
242 goto resubmit; /* maybe we can recover */
246 spin_lock(&dev->rbsl);
247 if (urb->actual_length > 0) {
248 next_ring_head = (dev->ring_head+1) % ring_buffer_size;
249 if (next_ring_head != dev->ring_tail) {
250 actual_buffer = (size_t*)(dev->ring_buffer + dev->ring_head*(sizeof(size_t)+dev->interrupt_in_endpoint_size));
251 /* actual_buffer gets urb->actual_length + interrupt_in_buffer */
252 *actual_buffer = urb->actual_length;
253 memcpy(actual_buffer+1, dev->interrupt_in_buffer, urb->actual_length);
254 dev->ring_head = next_ring_head;
255 dev_dbg(&dev->intf->dev, "%s: received %d bytes\n",
256 __func__, urb->actual_length);
258 dev_warn(&dev->intf->dev,
259 "Ring buffer overflow, %d bytes dropped\n",
261 dev->buffer_overflow = 1;
266 /* resubmit if we're still running */
267 if (dev->interrupt_in_running && !dev->buffer_overflow) {
268 retval = usb_submit_urb(dev->interrupt_in_urb, GFP_ATOMIC);
270 dev_err(&dev->intf->dev,
271 "usb_submit_urb failed (%d)\n", retval);
272 dev->buffer_overflow = 1;
275 spin_unlock(&dev->rbsl);
277 dev->interrupt_in_done = 1;
278 wake_up_interruptible(&dev->read_wait);
282 * ld_usb_interrupt_out_callback
284 static void ld_usb_interrupt_out_callback(struct urb *urb)
286 struct ld_usb *dev = urb->context;
287 int status = urb->status;
289 /* sync/async unlink faults aren't errors */
290 if (status && !(status == -ENOENT ||
291 status == -ECONNRESET ||
292 status == -ESHUTDOWN))
293 dev_dbg(&dev->intf->dev,
294 "%s - nonzero write interrupt status received: %d\n",
297 dev->interrupt_out_busy = 0;
298 wake_up_interruptible(&dev->write_wait);
304 static int ld_usb_open(struct inode *inode, struct file *file)
309 struct usb_interface *interface;
311 nonseekable_open(inode, file);
312 subminor = iminor(inode);
314 interface = usb_find_interface(&ld_usb_driver, subminor);
317 printk(KERN_ERR "%s - error, can't find device for minor %d\n",
322 dev = usb_get_intfdata(interface);
327 /* lock this device */
328 if (mutex_lock_interruptible(&dev->mutex))
331 /* allow opening only once */
332 if (dev->open_count) {
338 /* initialize in direction */
341 dev->buffer_overflow = 0;
342 usb_fill_int_urb(dev->interrupt_in_urb,
343 interface_to_usbdev(interface),
344 usb_rcvintpipe(interface_to_usbdev(interface),
345 dev->interrupt_in_endpoint->bEndpointAddress),
346 dev->interrupt_in_buffer,
347 dev->interrupt_in_endpoint_size,
348 ld_usb_interrupt_in_callback,
350 dev->interrupt_in_interval);
352 dev->interrupt_in_running = 1;
353 dev->interrupt_in_done = 0;
355 retval = usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL);
357 dev_err(&interface->dev, "Couldn't submit interrupt_in_urb %d\n", retval);
358 dev->interrupt_in_running = 0;
363 /* save device in the file's private structure */
364 file->private_data = dev;
367 mutex_unlock(&dev->mutex);
375 static int ld_usb_release(struct inode *inode, struct file *file)
380 dev = file->private_data;
387 mutex_lock(&dev->mutex);
389 if (dev->open_count != 1) {
393 if (dev->disconnected) {
394 /* the device was unplugged before the file was released */
395 mutex_unlock(&dev->mutex);
396 /* unlock here as ld_usb_delete frees dev */
401 /* wait until write transfer is finished */
402 if (dev->interrupt_out_busy)
403 wait_event_interruptible_timeout(dev->write_wait, !dev->interrupt_out_busy, 2 * HZ);
404 ld_usb_abort_transfers(dev);
408 mutex_unlock(&dev->mutex);
417 static unsigned int ld_usb_poll(struct file *file, poll_table *wait)
420 unsigned int mask = 0;
422 dev = file->private_data;
424 if (dev->disconnected)
425 return POLLERR | POLLHUP;
427 poll_wait(file, &dev->read_wait, wait);
428 poll_wait(file, &dev->write_wait, wait);
430 if (dev->ring_head != dev->ring_tail)
431 mask |= POLLIN | POLLRDNORM;
432 if (!dev->interrupt_out_busy)
433 mask |= POLLOUT | POLLWRNORM;
441 static ssize_t ld_usb_read(struct file *file, char __user *buffer, size_t count,
445 size_t *actual_buffer;
446 size_t bytes_to_read;
450 dev = file->private_data;
452 /* verify that we actually have some data to read */
456 /* lock this object */
457 if (mutex_lock_interruptible(&dev->mutex)) {
458 retval = -ERESTARTSYS;
462 /* verify that the device wasn't unplugged */
463 if (dev->disconnected) {
465 printk(KERN_ERR "ldusb: No device or device unplugged %d\n", retval);
470 spin_lock_irq(&dev->rbsl);
471 while (dev->ring_head == dev->ring_tail) {
472 dev->interrupt_in_done = 0;
473 spin_unlock_irq(&dev->rbsl);
474 if (file->f_flags & O_NONBLOCK) {
478 retval = wait_event_interruptible(dev->read_wait, dev->interrupt_in_done);
482 spin_lock_irq(&dev->rbsl);
484 spin_unlock_irq(&dev->rbsl);
486 /* actual_buffer contains actual_length + interrupt_in_buffer */
487 actual_buffer = (size_t*)(dev->ring_buffer + dev->ring_tail*(sizeof(size_t)+dev->interrupt_in_endpoint_size));
488 if (*actual_buffer > dev->interrupt_in_endpoint_size) {
492 bytes_to_read = min(count, *actual_buffer);
493 if (bytes_to_read < *actual_buffer)
494 dev_warn(&dev->intf->dev, "Read buffer overflow, %zd bytes dropped\n",
495 *actual_buffer-bytes_to_read);
497 /* copy one interrupt_in_buffer from ring_buffer into userspace */
498 if (copy_to_user(buffer, actual_buffer+1, bytes_to_read)) {
502 retval = bytes_to_read;
504 spin_lock_irq(&dev->rbsl);
505 dev->ring_tail = (dev->ring_tail + 1) % ring_buffer_size;
507 if (dev->buffer_overflow) {
508 dev->buffer_overflow = 0;
509 spin_unlock_irq(&dev->rbsl);
510 rv = usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL);
512 dev->buffer_overflow = 1;
514 spin_unlock_irq(&dev->rbsl);
518 /* unlock the device */
519 mutex_unlock(&dev->mutex);
528 static ssize_t ld_usb_write(struct file *file, const char __user *buffer,
529 size_t count, loff_t *ppos)
532 size_t bytes_to_write;
535 dev = file->private_data;
537 /* verify that we actually have some data to write */
541 /* lock this object */
542 if (mutex_lock_interruptible(&dev->mutex)) {
543 retval = -ERESTARTSYS;
547 /* verify that the device wasn't unplugged */
548 if (dev->disconnected) {
550 printk(KERN_ERR "ldusb: No device or device unplugged %d\n", retval);
554 /* wait until previous transfer is finished */
555 if (dev->interrupt_out_busy) {
556 if (file->f_flags & O_NONBLOCK) {
560 retval = wait_event_interruptible(dev->write_wait, !dev->interrupt_out_busy);
566 /* write the data into interrupt_out_buffer from userspace */
567 bytes_to_write = min(count, write_buffer_size*dev->interrupt_out_endpoint_size);
568 if (bytes_to_write < count)
569 dev_warn(&dev->intf->dev, "Write buffer overflow, %zd bytes dropped\n",count-bytes_to_write);
570 dev_dbg(&dev->intf->dev, "%s: count = %zd, bytes_to_write = %zd\n",
571 __func__, count, bytes_to_write);
573 if (copy_from_user(dev->interrupt_out_buffer, buffer, bytes_to_write)) {
578 if (dev->interrupt_out_endpoint == NULL) {
579 /* try HID_REQ_SET_REPORT=9 on control_endpoint instead of interrupt_out_endpoint */
580 retval = usb_control_msg(interface_to_usbdev(dev->intf),
581 usb_sndctrlpipe(interface_to_usbdev(dev->intf), 0),
583 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
585 dev->interrupt_out_buffer,
587 USB_CTRL_SET_TIMEOUT);
589 dev_err(&dev->intf->dev,
590 "Couldn't submit HID_REQ_SET_REPORT %d\n",
595 /* send off the urb */
596 usb_fill_int_urb(dev->interrupt_out_urb,
597 interface_to_usbdev(dev->intf),
598 usb_sndintpipe(interface_to_usbdev(dev->intf),
599 dev->interrupt_out_endpoint->bEndpointAddress),
600 dev->interrupt_out_buffer,
602 ld_usb_interrupt_out_callback,
604 dev->interrupt_out_interval);
606 dev->interrupt_out_busy = 1;
609 retval = usb_submit_urb(dev->interrupt_out_urb, GFP_KERNEL);
611 dev->interrupt_out_busy = 0;
612 dev_err(&dev->intf->dev,
613 "Couldn't submit interrupt_out_urb %d\n", retval);
616 retval = bytes_to_write;
619 /* unlock the device */
620 mutex_unlock(&dev->mutex);
626 /* file operations needed when we register this driver */
627 static const struct file_operations ld_usb_fops = {
628 .owner = THIS_MODULE,
630 .write = ld_usb_write,
632 .release = ld_usb_release,
638 * usb class driver info in order to get a minor number from the usb core,
639 * and to have the device registered with the driver core
641 static struct usb_class_driver ld_usb_class = {
643 .fops = &ld_usb_fops,
644 .minor_base = USB_LD_MINOR_BASE,
650 * Called by the usb core when a new device is connected that it thinks
651 * this driver might be interested in.
653 static int ld_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
655 struct usb_device *udev = interface_to_usbdev(intf);
656 struct ld_usb *dev = NULL;
657 struct usb_host_interface *iface_desc;
658 struct usb_endpoint_descriptor *endpoint;
661 int retval = -ENOMEM;
663 /* allocate memory for our device state and initialize it */
665 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
668 mutex_init(&dev->mutex);
669 spin_lock_init(&dev->rbsl);
671 init_waitqueue_head(&dev->read_wait);
672 init_waitqueue_head(&dev->write_wait);
674 /* workaround for early firmware versions on fast computers */
675 if ((le16_to_cpu(udev->descriptor.idVendor) == USB_VENDOR_ID_LD) &&
676 ((le16_to_cpu(udev->descriptor.idProduct) == USB_DEVICE_ID_LD_CASSY) ||
677 (le16_to_cpu(udev->descriptor.idProduct) == USB_DEVICE_ID_LD_COM3LAB)) &&
678 (le16_to_cpu(udev->descriptor.bcdDevice) <= 0x103)) {
679 buffer = kmalloc(256, GFP_KERNEL);
682 /* usb_string makes SETUP+STALL to leave always ControlReadLoop */
683 usb_string(udev, 255, buffer, 256);
687 iface_desc = intf->cur_altsetting;
689 /* set up the endpoint information */
690 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
691 endpoint = &iface_desc->endpoint[i].desc;
693 if (usb_endpoint_is_int_in(endpoint))
694 dev->interrupt_in_endpoint = endpoint;
696 if (usb_endpoint_is_int_out(endpoint))
697 dev->interrupt_out_endpoint = endpoint;
699 if (dev->interrupt_in_endpoint == NULL) {
700 dev_err(&intf->dev, "Interrupt in endpoint not found\n");
703 if (dev->interrupt_out_endpoint == NULL)
704 dev_warn(&intf->dev, "Interrupt out endpoint not found (using control endpoint instead)\n");
706 dev->interrupt_in_endpoint_size = usb_endpoint_maxp(dev->interrupt_in_endpoint);
707 dev->ring_buffer = kcalloc(ring_buffer_size,
708 sizeof(size_t) + dev->interrupt_in_endpoint_size,
710 if (!dev->ring_buffer)
712 dev->interrupt_in_buffer = kmalloc(dev->interrupt_in_endpoint_size, GFP_KERNEL);
713 if (!dev->interrupt_in_buffer)
715 dev->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
716 if (!dev->interrupt_in_urb)
718 dev->interrupt_out_endpoint_size = dev->interrupt_out_endpoint ? usb_endpoint_maxp(dev->interrupt_out_endpoint) :
719 udev->descriptor.bMaxPacketSize0;
720 dev->interrupt_out_buffer = kmalloc(write_buffer_size*dev->interrupt_out_endpoint_size, GFP_KERNEL);
721 if (!dev->interrupt_out_buffer)
723 dev->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
724 if (!dev->interrupt_out_urb)
726 dev->interrupt_in_interval = min_interrupt_in_interval > dev->interrupt_in_endpoint->bInterval ? min_interrupt_in_interval : dev->interrupt_in_endpoint->bInterval;
727 if (dev->interrupt_out_endpoint)
728 dev->interrupt_out_interval = min_interrupt_out_interval > dev->interrupt_out_endpoint->bInterval ? min_interrupt_out_interval : dev->interrupt_out_endpoint->bInterval;
730 /* we can register the device now, as it is ready */
731 usb_set_intfdata(intf, dev);
733 retval = usb_register_dev(intf, &ld_usb_class);
735 /* something prevented us from registering this driver */
736 dev_err(&intf->dev, "Not able to get a minor for this device.\n");
737 usb_set_intfdata(intf, NULL);
741 /* let the user know what node this device is now attached to */
742 dev_info(&intf->dev, "LD USB Device #%d now attached to major %d minor %d\n",
743 (intf->minor - USB_LD_MINOR_BASE), USB_MAJOR, intf->minor);
757 * Called by the usb core when the device is removed from the system.
759 static void ld_usb_disconnect(struct usb_interface *intf)
764 dev = usb_get_intfdata(intf);
765 usb_set_intfdata(intf, NULL);
769 /* give back our minor */
770 usb_deregister_dev(intf, &ld_usb_class);
772 usb_poison_urb(dev->interrupt_in_urb);
773 usb_poison_urb(dev->interrupt_out_urb);
775 mutex_lock(&dev->mutex);
777 /* if the device is not opened, then we clean up right now */
778 if (!dev->open_count) {
779 mutex_unlock(&dev->mutex);
782 dev->disconnected = 1;
783 /* wake up pollers */
784 wake_up_interruptible_all(&dev->read_wait);
785 wake_up_interruptible_all(&dev->write_wait);
786 mutex_unlock(&dev->mutex);
789 dev_info(&intf->dev, "LD USB Device #%d now disconnected\n",
790 (minor - USB_LD_MINOR_BASE));
793 /* usb specific object needed to register this driver with the usb subsystem */
794 static struct usb_driver ld_usb_driver = {
796 .probe = ld_usb_probe,
797 .disconnect = ld_usb_disconnect,
798 .id_table = ld_usb_table,
801 module_usb_driver(ld_usb_driver);