4 * This driver supports USB CDC WCM Device Management.
6 * Copyright (c) 2007-2009 Oliver Neukum
8 * Some code taken from cdc-acm.c
10 * Released under the GPLv2.
12 * Many thanks to Carl Nordbeck
14 #include <linux/kernel.h>
15 #include <linux/errno.h>
16 #include <linux/slab.h>
17 #include <linux/module.h>
18 #include <linux/mutex.h>
19 #include <linux/uaccess.h>
20 #include <linux/bitops.h>
21 #include <linux/poll.h>
22 #include <linux/smp_lock.h>
23 #include <linux/usb.h>
24 #include <linux/usb/cdc.h>
25 #include <asm/byteorder.h>
26 #include <asm/unaligned.h>
31 #define DRIVER_VERSION "v0.03"
32 #define DRIVER_AUTHOR "Oliver Neukum"
33 #define DRIVER_DESC "USB Abstract Control Model driver for USB WCM Device Management"
35 static const struct usb_device_id wdm_ids[] = {
37 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
38 USB_DEVICE_ID_MATCH_INT_SUBCLASS,
39 .bInterfaceClass = USB_CLASS_COMM,
40 .bInterfaceSubClass = USB_CDC_SUBCLASS_DMM
45 MODULE_DEVICE_TABLE (usb, wdm_ids);
47 #define WDM_MINOR_BASE 176
51 #define WDM_DISCONNECTING 2
54 #define WDM_INT_STALL 5
55 #define WDM_POLL_RUNNING 6
61 static DEFINE_MUTEX(wdm_mutex);
63 /* --- method tables --- */
66 u8 *inbuf; /* buffer for response */
67 u8 *outbuf; /* buffer for command */
68 u8 *sbuf; /* buffer for status */
69 u8 *ubuf; /* buffer for copy to user space */
74 struct usb_interface *intf;
75 struct usb_ctrlrequest *orq;
76 struct usb_ctrlrequest *irq;
94 wait_queue_head_t wait;
95 struct work_struct rxwork;
100 static struct usb_driver wdm_driver;
102 /* --- callbacks --- */
103 static void wdm_out_callback(struct urb *urb)
105 struct wdm_device *desc;
107 spin_lock(&desc->iuspin);
108 desc->werr = urb->status;
109 spin_unlock(&desc->iuspin);
110 clear_bit(WDM_IN_USE, &desc->flags);
112 wake_up(&desc->wait);
115 static void wdm_in_callback(struct urb *urb)
117 struct wdm_device *desc = urb->context;
118 int status = urb->status;
120 spin_lock(&desc->iuspin);
125 dev_dbg(&desc->intf->dev,
126 "nonzero urb status received: -ENOENT");
129 dev_dbg(&desc->intf->dev,
130 "nonzero urb status received: -ECONNRESET");
133 dev_dbg(&desc->intf->dev,
134 "nonzero urb status received: -ESHUTDOWN");
137 dev_err(&desc->intf->dev,
138 "nonzero urb status received: -EPIPE\n");
141 dev_err(&desc->intf->dev,
142 "Unexpected error %d\n", status);
148 desc->reslength = urb->actual_length;
149 memmove(desc->ubuf + desc->length, desc->inbuf, desc->reslength);
150 desc->length += desc->reslength;
151 wake_up(&desc->wait);
153 set_bit(WDM_READ, &desc->flags);
154 spin_unlock(&desc->iuspin);
157 static void wdm_int_callback(struct urb *urb)
160 int status = urb->status;
161 struct wdm_device *desc;
162 struct usb_ctrlrequest *req;
163 struct usb_cdc_notification *dr;
167 dr = (struct usb_cdc_notification *)desc->sbuf;
176 set_bit(WDM_INT_STALL, &desc->flags);
177 dev_err(&desc->intf->dev, "Stall on int endpoint\n");
178 goto sw; /* halt is cleared in work */
180 dev_err(&desc->intf->dev,
181 "nonzero urb status received: %d\n", status);
186 if (urb->actual_length < sizeof(struct usb_cdc_notification)) {
187 dev_err(&desc->intf->dev, "wdm_int_callback - %d bytes\n",
192 switch (dr->bNotificationType) {
193 case USB_CDC_NOTIFY_RESPONSE_AVAILABLE:
194 dev_dbg(&desc->intf->dev,
195 "NOTIFY_RESPONSE_AVAILABLE received: index %d len %d",
196 dr->wIndex, dr->wLength);
199 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
201 dev_dbg(&desc->intf->dev,
202 "NOTIFY_NETWORK_CONNECTION %s network",
203 dr->wValue ? "connected to" : "disconnected from");
206 clear_bit(WDM_POLL_RUNNING, &desc->flags);
207 dev_err(&desc->intf->dev,
208 "unknown notification %d received: index %d len %d\n",
209 dr->bNotificationType, dr->wIndex, dr->wLength);
213 req->bRequestType = (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE);
214 req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
216 req->wIndex = desc->inum;
217 req->wLength = cpu_to_le16(desc->wMaxCommand);
219 usb_fill_control_urb(
221 interface_to_usbdev(desc->intf),
222 /* using common endpoint 0 */
223 usb_rcvctrlpipe(interface_to_usbdev(desc->intf), 0),
224 (unsigned char *)req,
230 desc->response->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
231 spin_lock(&desc->iuspin);
232 clear_bit(WDM_READ, &desc->flags);
233 if (!test_bit(WDM_DISCONNECTING, &desc->flags)) {
234 rv = usb_submit_urb(desc->response, GFP_ATOMIC);
235 dev_dbg(&desc->intf->dev, "%s: usb_submit_urb %d",
238 spin_unlock(&desc->iuspin);
244 rv = schedule_work(&desc->rxwork);
246 dev_err(&desc->intf->dev,
247 "Cannot schedule work\n");
251 rv = usb_submit_urb(urb, GFP_ATOMIC);
253 dev_err(&desc->intf->dev,
254 "%s - usb_submit_urb failed with result %d\n",
259 static void kill_urbs(struct wdm_device *desc)
261 /* the order here is essential */
262 usb_kill_urb(desc->command);
263 usb_kill_urb(desc->validity);
264 usb_kill_urb(desc->response);
267 static void free_urbs(struct wdm_device *desc)
269 usb_free_urb(desc->validity);
270 usb_free_urb(desc->response);
271 usb_free_urb(desc->command);
274 static void cleanup(struct wdm_device *desc)
276 usb_buffer_free(interface_to_usbdev(desc->intf),
277 desc->wMaxPacketSize,
279 desc->validity->transfer_dma);
280 usb_buffer_free(interface_to_usbdev(desc->intf),
283 desc->response->transfer_dma);
291 static ssize_t wdm_write
292 (struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
295 int rv = -EMSGSIZE, r, we;
296 struct wdm_device *desc = file->private_data;
297 struct usb_ctrlrequest *req;
299 if (count > desc->wMaxCommand)
300 count = desc->wMaxCommand;
302 spin_lock_irq(&desc->iuspin);
305 spin_unlock_irq(&desc->iuspin);
309 r = mutex_lock_interruptible(&desc->wlock); /* concurrent writes */
314 r = usb_autopm_get_interface(desc->intf);
318 if (!file->f_flags && O_NONBLOCK)
319 r = wait_event_interruptible(desc->wait, !test_bit(WDM_IN_USE,
322 if (test_bit(WDM_IN_USE, &desc->flags))
327 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
332 desc->outbuf = buf = kmalloc(count, GFP_KERNEL);
338 r = copy_from_user(buf, buffer, count);
346 usb_fill_control_urb(
348 interface_to_usbdev(desc->intf),
349 /* using common endpoint 0 */
350 usb_sndctrlpipe(interface_to_usbdev(desc->intf), 0),
351 (unsigned char *)req,
358 req->bRequestType = (USB_DIR_OUT | USB_TYPE_CLASS |
359 USB_RECIP_INTERFACE);
360 req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
362 req->wIndex = desc->inum;
363 req->wLength = cpu_to_le16(count);
364 set_bit(WDM_IN_USE, &desc->flags);
366 rv = usb_submit_urb(desc->command, GFP_KERNEL);
369 clear_bit(WDM_IN_USE, &desc->flags);
370 dev_err(&desc->intf->dev, "Tx URB error: %d\n", rv);
372 dev_dbg(&desc->intf->dev, "Tx URB has been submitted index=%d",
376 usb_autopm_put_interface(desc->intf);
378 mutex_unlock(&desc->wlock);
380 return rv < 0 ? rv : count;
383 static ssize_t wdm_read
384 (struct file *file, char __user *buffer, size_t count, loff_t *ppos)
388 struct wdm_device *desc = file->private_data;
391 rv = mutex_lock_interruptible(&desc->rlock); /*concurrent reads */
395 if (desc->length == 0) {
398 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
403 if (file->f_flags & O_NONBLOCK) {
404 if (!test_bit(WDM_READ, &desc->flags)) {
405 rv = cntr ? cntr : -EAGAIN;
410 rv = wait_event_interruptible(desc->wait,
411 test_bit(WDM_READ, &desc->flags));
414 /* may have happened while we slept */
415 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
419 usb_mark_last_busy(interface_to_usbdev(desc->intf));
425 spin_lock_irq(&desc->iuspin);
427 if (desc->rerr) { /* read completed, error happened */
430 spin_unlock_irq(&desc->iuspin);
431 dev_err(&desc->intf->dev,
432 "reading had resulted in %d\n", t);
437 * recheck whether we've lost the race
438 * against the completion handler
440 if (!test_bit(WDM_READ, &desc->flags)) { /* lost race */
441 spin_unlock_irq(&desc->iuspin);
444 if (!desc->reslength) { /* zero length read */
445 spin_unlock_irq(&desc->iuspin);
448 clear_bit(WDM_READ, &desc->flags);
449 spin_unlock_irq(&desc->iuspin);
452 cntr = count > desc->length ? desc->length : count;
453 rv = copy_to_user(buffer, desc->ubuf, cntr);
459 for (i = 0; i < desc->length - cntr; i++)
460 desc->ubuf[i] = desc->ubuf[i + cntr];
462 desc->length -= cntr;
463 /* in case we had outstanding data */
465 clear_bit(WDM_READ, &desc->flags);
469 mutex_unlock(&desc->rlock);
470 if (rv < 0 && rv != -EAGAIN)
471 dev_err(&desc->intf->dev, "wdm_read: exit error\n");
475 static int wdm_flush(struct file *file, fl_owner_t id)
477 struct wdm_device *desc = file->private_data;
479 wait_event(desc->wait, !test_bit(WDM_IN_USE, &desc->flags));
481 dev_err(&desc->intf->dev, "Error in flush path: %d\n",
487 static unsigned int wdm_poll(struct file *file, struct poll_table_struct *wait)
489 struct wdm_device *desc = file->private_data;
491 unsigned int mask = 0;
493 spin_lock_irqsave(&desc->iuspin, flags);
494 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
496 spin_unlock_irqrestore(&desc->iuspin, flags);
499 if (test_bit(WDM_READ, &desc->flags))
500 mask = POLLIN | POLLRDNORM;
501 if (desc->rerr || desc->werr)
503 if (!test_bit(WDM_IN_USE, &desc->flags))
504 mask |= POLLOUT | POLLWRNORM;
505 spin_unlock_irqrestore(&desc->iuspin, flags);
507 poll_wait(file, &desc->wait, wait);
513 static int wdm_open(struct inode *inode, struct file *file)
515 int minor = iminor(inode);
517 struct usb_interface *intf;
518 struct wdm_device *desc;
521 mutex_lock(&wdm_mutex);
522 intf = usb_find_interface(&wdm_driver, minor);
526 desc = usb_get_intfdata(intf);
527 if (test_bit(WDM_DISCONNECTING, &desc->flags))
529 file->private_data = desc;
531 rv = usb_autopm_get_interface(desc->intf);
533 dev_err(&desc->intf->dev, "Error autopm - %d\n", rv);
536 intf->needs_remote_wakeup = 1;
538 mutex_lock(&desc->plock);
539 if (!desc->count++) {
540 rv = usb_submit_urb(desc->validity, GFP_KERNEL);
543 dev_err(&desc->intf->dev,
544 "Error submitting int urb - %d\n", rv);
549 mutex_unlock(&desc->plock);
550 usb_autopm_put_interface(desc->intf);
552 mutex_unlock(&wdm_mutex);
557 static int wdm_release(struct inode *inode, struct file *file)
559 struct wdm_device *desc = file->private_data;
561 mutex_lock(&wdm_mutex);
562 mutex_lock(&desc->plock);
564 mutex_unlock(&desc->plock);
567 dev_dbg(&desc->intf->dev, "wdm_release: cleanup");
569 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
570 desc->intf->needs_remote_wakeup = 0;
572 mutex_unlock(&wdm_mutex);
576 static const struct file_operations wdm_fops = {
577 .owner = THIS_MODULE,
582 .release = wdm_release,
586 static struct usb_class_driver wdm_class = {
589 .minor_base = WDM_MINOR_BASE,
592 /* --- error handling --- */
593 static void wdm_rxwork(struct work_struct *work)
595 struct wdm_device *desc = container_of(work, struct wdm_device, rxwork);
599 spin_lock_irqsave(&desc->iuspin, flags);
600 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
601 spin_unlock_irqrestore(&desc->iuspin, flags);
603 spin_unlock_irqrestore(&desc->iuspin, flags);
604 rv = usb_submit_urb(desc->response, GFP_KERNEL);
605 if (rv < 0 && rv != -EPERM) {
606 spin_lock_irqsave(&desc->iuspin, flags);
607 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
608 schedule_work(&desc->rxwork);
609 spin_unlock_irqrestore(&desc->iuspin, flags);
614 /* --- hotplug --- */
616 static int wdm_probe(struct usb_interface *intf, const struct usb_device_id *id)
619 struct usb_device *udev = interface_to_usbdev(intf);
620 struct wdm_device *desc;
621 struct usb_host_interface *iface;
622 struct usb_endpoint_descriptor *ep;
623 struct usb_cdc_dmm_desc *dmhd;
624 u8 *buffer = intf->altsetting->extra;
625 int buflen = intf->altsetting->extralen;
632 if (buffer [1] != USB_DT_CS_INTERFACE) {
633 dev_err(&intf->dev, "skipping garbage\n");
637 switch (buffer [2]) {
638 case USB_CDC_HEADER_TYPE:
640 case USB_CDC_DMM_TYPE:
641 dmhd = (struct usb_cdc_dmm_desc *)buffer;
642 maxcom = le16_to_cpu(dmhd->wMaxCommand);
644 "Finding maximum buffer length: %d", maxcom);
648 "Ignoring extra header, type %d, length %d\n",
649 buffer[2], buffer[0]);
658 desc = kzalloc(sizeof(struct wdm_device), GFP_KERNEL);
661 mutex_init(&desc->wlock);
662 mutex_init(&desc->rlock);
663 mutex_init(&desc->plock);
664 spin_lock_init(&desc->iuspin);
665 init_waitqueue_head(&desc->wait);
666 desc->wMaxCommand = maxcom;
667 /* this will be expanded and needed in hardware endianness */
668 desc->inum = cpu_to_le16((u16)intf->cur_altsetting->desc.bInterfaceNumber);
670 INIT_WORK(&desc->rxwork, wdm_rxwork);
673 iface = intf->cur_altsetting;
674 if (iface->desc.bNumEndpoints != 1)
676 ep = &iface->endpoint[0].desc;
677 if (!ep || !usb_endpoint_is_int_in(ep))
680 desc->wMaxPacketSize = le16_to_cpu(ep->wMaxPacketSize);
681 desc->bMaxPacketSize0 = udev->descriptor.bMaxPacketSize0;
683 desc->orq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
686 desc->irq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
690 desc->validity = usb_alloc_urb(0, GFP_KERNEL);
694 desc->response = usb_alloc_urb(0, GFP_KERNEL);
698 desc->command = usb_alloc_urb(0, GFP_KERNEL);
702 desc->ubuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
706 desc->sbuf = usb_buffer_alloc(interface_to_usbdev(intf),
707 desc->wMaxPacketSize,
709 &desc->validity->transfer_dma);
713 desc->inbuf = usb_buffer_alloc(interface_to_usbdev(intf),
714 desc->bMaxPacketSize0,
716 &desc->response->transfer_dma);
722 interface_to_usbdev(intf),
723 usb_rcvintpipe(interface_to_usbdev(intf), ep->bEndpointAddress),
725 desc->wMaxPacketSize,
730 desc->validity->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
732 usb_set_intfdata(intf, desc);
733 rv = usb_register_dev(intf, &wdm_class);
737 dev_info(&intf->dev, "cdc-wdm%d: USB WDM device\n",
738 intf->minor - WDM_MINOR_BASE);
742 usb_set_intfdata(intf, NULL);
743 usb_buffer_free(interface_to_usbdev(desc->intf),
744 desc->bMaxPacketSize0,
746 desc->response->transfer_dma);
748 usb_buffer_free(interface_to_usbdev(desc->intf),
749 desc->wMaxPacketSize,
751 desc->validity->transfer_dma);
761 static void wdm_disconnect(struct usb_interface *intf)
763 struct wdm_device *desc;
766 usb_deregister_dev(intf, &wdm_class);
767 mutex_lock(&wdm_mutex);
768 desc = usb_get_intfdata(intf);
770 /* the spinlock makes sure no new urbs are generated in the callbacks */
771 spin_lock_irqsave(&desc->iuspin, flags);
772 set_bit(WDM_DISCONNECTING, &desc->flags);
773 set_bit(WDM_READ, &desc->flags);
774 /* to terminate pending flushes */
775 clear_bit(WDM_IN_USE, &desc->flags);
776 spin_unlock_irqrestore(&desc->iuspin, flags);
777 cancel_work_sync(&desc->rxwork);
779 wake_up_all(&desc->wait);
782 mutex_unlock(&wdm_mutex);
785 static int wdm_suspend(struct usb_interface *intf, pm_message_t message)
787 struct wdm_device *desc = usb_get_intfdata(intf);
790 dev_dbg(&desc->intf->dev, "wdm%d_suspend\n", intf->minor);
792 mutex_lock(&desc->plock);
794 if ((message.event & PM_EVENT_AUTO) &&
795 test_bit(WDM_IN_USE, &desc->flags)) {
799 cancel_work_sync(&desc->rxwork);
804 mutex_unlock(&desc->plock);
809 static int recover_from_urb_loss(struct wdm_device *desc)
814 rv = usb_submit_urb(desc->validity, GFP_NOIO);
816 dev_err(&desc->intf->dev,
817 "Error resume submitting int urb - %d\n", rv);
821 static int wdm_resume(struct usb_interface *intf)
823 struct wdm_device *desc = usb_get_intfdata(intf);
826 dev_dbg(&desc->intf->dev, "wdm%d_resume\n", intf->minor);
827 mutex_lock(&desc->plock);
828 rv = recover_from_urb_loss(desc);
829 mutex_unlock(&desc->plock);
833 static int wdm_pre_reset(struct usb_interface *intf)
835 struct wdm_device *desc = usb_get_intfdata(intf);
837 mutex_lock(&desc->plock);
841 static int wdm_post_reset(struct usb_interface *intf)
843 struct wdm_device *desc = usb_get_intfdata(intf);
846 rv = recover_from_urb_loss(desc);
847 mutex_unlock(&desc->plock);
851 static struct usb_driver wdm_driver = {
854 .disconnect = wdm_disconnect,
855 .suspend = wdm_suspend,
856 .resume = wdm_resume,
857 .reset_resume = wdm_resume,
858 .pre_reset = wdm_pre_reset,
859 .post_reset = wdm_post_reset,
861 .supports_autosuspend = 1,
864 /* --- low level module stuff --- */
866 static int __init wdm_init(void)
870 rv = usb_register(&wdm_driver);
875 static void __exit wdm_exit(void)
877 usb_deregister(&wdm_driver);
880 module_init(wdm_init);
881 module_exit(wdm_exit);
883 MODULE_AUTHOR(DRIVER_AUTHOR);
884 MODULE_DESCRIPTION(DRIVER_DESC);
885 MODULE_LICENSE("GPL");