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/usb.h>
23 #include <linux/usb/cdc.h>
24 #include <asm/byteorder.h>
25 #include <asm/unaligned.h>
30 #define DRIVER_VERSION "v0.03"
31 #define DRIVER_AUTHOR "Oliver Neukum"
32 #define DRIVER_DESC "USB Abstract Control Model driver for USB WCM Device Management"
34 static const struct usb_device_id wdm_ids[] = {
36 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
37 USB_DEVICE_ID_MATCH_INT_SUBCLASS,
38 .bInterfaceClass = USB_CLASS_COMM,
39 .bInterfaceSubClass = USB_CDC_SUBCLASS_DMM
44 MODULE_DEVICE_TABLE (usb, wdm_ids);
46 #define WDM_MINOR_BASE 176
50 #define WDM_DISCONNECTING 2
53 #define WDM_INT_STALL 5
54 #define WDM_POLL_RUNNING 6
60 static DEFINE_MUTEX(wdm_mutex);
62 /* --- method tables --- */
65 u8 *inbuf; /* buffer for response */
66 u8 *outbuf; /* buffer for command */
67 u8 *sbuf; /* buffer for status */
68 u8 *ubuf; /* buffer for copy to user space */
73 struct usb_interface *intf;
74 struct usb_ctrlrequest *orq;
75 struct usb_ctrlrequest *irq;
91 wait_queue_head_t wait;
92 struct work_struct rxwork;
97 static struct usb_driver wdm_driver;
99 /* --- callbacks --- */
100 static void wdm_out_callback(struct urb *urb)
102 struct wdm_device *desc;
104 spin_lock(&desc->iuspin);
105 desc->werr = urb->status;
106 spin_unlock(&desc->iuspin);
107 clear_bit(WDM_IN_USE, &desc->flags);
109 wake_up(&desc->wait);
112 static void wdm_in_callback(struct urb *urb)
114 struct wdm_device *desc = urb->context;
115 int status = urb->status;
117 spin_lock(&desc->iuspin);
122 dev_dbg(&desc->intf->dev,
123 "nonzero urb status received: -ENOENT");
126 dev_dbg(&desc->intf->dev,
127 "nonzero urb status received: -ECONNRESET");
130 dev_dbg(&desc->intf->dev,
131 "nonzero urb status received: -ESHUTDOWN");
134 dev_err(&desc->intf->dev,
135 "nonzero urb status received: -EPIPE\n");
138 dev_err(&desc->intf->dev,
139 "Unexpected error %d\n", status);
145 desc->reslength = urb->actual_length;
146 memmove(desc->ubuf + desc->length, desc->inbuf, desc->reslength);
147 desc->length += desc->reslength;
148 wake_up(&desc->wait);
150 set_bit(WDM_READ, &desc->flags);
151 spin_unlock(&desc->iuspin);
154 static void wdm_int_callback(struct urb *urb)
157 int status = urb->status;
158 struct wdm_device *desc;
159 struct usb_ctrlrequest *req;
160 struct usb_cdc_notification *dr;
164 dr = (struct usb_cdc_notification *)desc->sbuf;
173 set_bit(WDM_INT_STALL, &desc->flags);
174 dev_err(&desc->intf->dev, "Stall on int endpoint\n");
175 goto sw; /* halt is cleared in work */
177 dev_err(&desc->intf->dev,
178 "nonzero urb status received: %d\n", status);
183 if (urb->actual_length < sizeof(struct usb_cdc_notification)) {
184 dev_err(&desc->intf->dev, "wdm_int_callback - %d bytes\n",
189 switch (dr->bNotificationType) {
190 case USB_CDC_NOTIFY_RESPONSE_AVAILABLE:
191 dev_dbg(&desc->intf->dev,
192 "NOTIFY_RESPONSE_AVAILABLE received: index %d len %d",
193 dr->wIndex, dr->wLength);
196 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
198 dev_dbg(&desc->intf->dev,
199 "NOTIFY_NETWORK_CONNECTION %s network",
200 dr->wValue ? "connected to" : "disconnected from");
203 clear_bit(WDM_POLL_RUNNING, &desc->flags);
204 dev_err(&desc->intf->dev,
205 "unknown notification %d received: index %d len %d\n",
206 dr->bNotificationType, dr->wIndex, dr->wLength);
210 req->bRequestType = (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE);
211 req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
213 req->wIndex = desc->inum;
214 req->wLength = cpu_to_le16(desc->wMaxCommand);
216 usb_fill_control_urb(
218 interface_to_usbdev(desc->intf),
219 /* using common endpoint 0 */
220 usb_rcvctrlpipe(interface_to_usbdev(desc->intf), 0),
221 (unsigned char *)req,
227 desc->response->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
228 spin_lock(&desc->iuspin);
229 clear_bit(WDM_READ, &desc->flags);
230 if (!test_bit(WDM_DISCONNECTING, &desc->flags)) {
231 rv = usb_submit_urb(desc->response, GFP_ATOMIC);
232 dev_dbg(&desc->intf->dev, "%s: usb_submit_urb %d",
235 spin_unlock(&desc->iuspin);
241 rv = schedule_work(&desc->rxwork);
243 dev_err(&desc->intf->dev,
244 "Cannot schedule work\n");
248 rv = usb_submit_urb(urb, GFP_ATOMIC);
250 dev_err(&desc->intf->dev,
251 "%s - usb_submit_urb failed with result %d\n",
256 static void kill_urbs(struct wdm_device *desc)
258 /* the order here is essential */
259 usb_kill_urb(desc->command);
260 usb_kill_urb(desc->validity);
261 usb_kill_urb(desc->response);
264 static void free_urbs(struct wdm_device *desc)
266 usb_free_urb(desc->validity);
267 usb_free_urb(desc->response);
268 usb_free_urb(desc->command);
271 static void cleanup(struct wdm_device *desc)
273 usb_buffer_free(interface_to_usbdev(desc->intf),
274 desc->wMaxPacketSize,
276 desc->validity->transfer_dma);
277 usb_buffer_free(interface_to_usbdev(desc->intf),
280 desc->response->transfer_dma);
288 static ssize_t wdm_write
289 (struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
292 int rv = -EMSGSIZE, r, we;
293 struct wdm_device *desc = file->private_data;
294 struct usb_ctrlrequest *req;
296 if (count > desc->wMaxCommand)
297 count = desc->wMaxCommand;
299 spin_lock_irq(&desc->iuspin);
302 spin_unlock_irq(&desc->iuspin);
306 desc->outbuf = buf = kmalloc(count, GFP_KERNEL);
312 r = copy_from_user(buf, buffer, count);
319 /* concurrent writes and disconnect */
320 r = mutex_lock_interruptible(&desc->lock);
327 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
333 r = usb_autopm_get_interface(desc->intf);
339 if (!file->f_flags && O_NONBLOCK)
340 r = wait_event_interruptible(desc->wait, !test_bit(WDM_IN_USE,
343 if (test_bit(WDM_IN_USE, &desc->flags))
351 usb_fill_control_urb(
353 interface_to_usbdev(desc->intf),
354 /* using common endpoint 0 */
355 usb_sndctrlpipe(interface_to_usbdev(desc->intf), 0),
356 (unsigned char *)req,
363 req->bRequestType = (USB_DIR_OUT | USB_TYPE_CLASS |
364 USB_RECIP_INTERFACE);
365 req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
367 req->wIndex = desc->inum;
368 req->wLength = cpu_to_le16(count);
369 set_bit(WDM_IN_USE, &desc->flags);
371 rv = usb_submit_urb(desc->command, GFP_KERNEL);
374 clear_bit(WDM_IN_USE, &desc->flags);
375 dev_err(&desc->intf->dev, "Tx URB error: %d\n", rv);
377 dev_dbg(&desc->intf->dev, "Tx URB has been submitted index=%d",
381 usb_autopm_put_interface(desc->intf);
383 mutex_unlock(&desc->lock);
385 return rv < 0 ? rv : count;
388 static ssize_t wdm_read
389 (struct file *file, char __user *buffer, size_t count, loff_t *ppos)
393 struct wdm_device *desc = file->private_data;
396 rv = mutex_lock_interruptible(&desc->lock); /*concurrent reads */
400 if (desc->length == 0) {
403 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
408 if (file->f_flags & O_NONBLOCK) {
409 if (!test_bit(WDM_READ, &desc->flags)) {
410 rv = cntr ? cntr : -EAGAIN;
415 rv = wait_event_interruptible(desc->wait,
416 test_bit(WDM_READ, &desc->flags));
419 /* may have happened while we slept */
420 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
424 usb_mark_last_busy(interface_to_usbdev(desc->intf));
430 spin_lock_irq(&desc->iuspin);
432 if (desc->rerr) { /* read completed, error happened */
435 spin_unlock_irq(&desc->iuspin);
436 dev_err(&desc->intf->dev,
437 "reading had resulted in %d\n", t);
442 * recheck whether we've lost the race
443 * against the completion handler
445 if (!test_bit(WDM_READ, &desc->flags)) { /* lost race */
446 spin_unlock_irq(&desc->iuspin);
449 if (!desc->reslength) { /* zero length read */
450 spin_unlock_irq(&desc->iuspin);
453 clear_bit(WDM_READ, &desc->flags);
454 spin_unlock_irq(&desc->iuspin);
457 cntr = count > desc->length ? desc->length : count;
458 rv = copy_to_user(buffer, desc->ubuf, cntr);
464 for (i = 0; i < desc->length - cntr; i++)
465 desc->ubuf[i] = desc->ubuf[i + cntr];
467 desc->length -= cntr;
468 /* in case we had outstanding data */
470 clear_bit(WDM_READ, &desc->flags);
474 mutex_unlock(&desc->lock);
475 if (rv < 0 && rv != -EAGAIN)
476 dev_err(&desc->intf->dev, "wdm_read: exit error\n");
480 static int wdm_flush(struct file *file, fl_owner_t id)
482 struct wdm_device *desc = file->private_data;
484 wait_event(desc->wait, !test_bit(WDM_IN_USE, &desc->flags));
486 dev_err(&desc->intf->dev, "Error in flush path: %d\n",
492 static unsigned int wdm_poll(struct file *file, struct poll_table_struct *wait)
494 struct wdm_device *desc = file->private_data;
496 unsigned int mask = 0;
498 spin_lock_irqsave(&desc->iuspin, flags);
499 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
501 spin_unlock_irqrestore(&desc->iuspin, flags);
504 if (test_bit(WDM_READ, &desc->flags))
505 mask = POLLIN | POLLRDNORM;
506 if (desc->rerr || desc->werr)
508 if (!test_bit(WDM_IN_USE, &desc->flags))
509 mask |= POLLOUT | POLLWRNORM;
510 spin_unlock_irqrestore(&desc->iuspin, flags);
512 poll_wait(file, &desc->wait, wait);
518 static int wdm_open(struct inode *inode, struct file *file)
520 int minor = iminor(inode);
522 struct usb_interface *intf;
523 struct wdm_device *desc;
525 mutex_lock(&wdm_mutex);
526 intf = usb_find_interface(&wdm_driver, minor);
530 desc = usb_get_intfdata(intf);
531 if (test_bit(WDM_DISCONNECTING, &desc->flags))
533 file->private_data = desc;
535 rv = usb_autopm_get_interface(desc->intf);
537 dev_err(&desc->intf->dev, "Error autopm - %d\n", rv);
540 intf->needs_remote_wakeup = 1;
542 mutex_lock(&desc->lock);
543 if (!desc->count++) {
544 rv = usb_submit_urb(desc->validity, GFP_KERNEL);
547 dev_err(&desc->intf->dev,
548 "Error submitting int urb - %d\n", rv);
553 mutex_unlock(&desc->lock);
554 usb_autopm_put_interface(desc->intf);
556 mutex_unlock(&wdm_mutex);
560 static int wdm_release(struct inode *inode, struct file *file)
562 struct wdm_device *desc = file->private_data;
564 mutex_lock(&wdm_mutex);
565 mutex_lock(&desc->lock);
567 mutex_unlock(&desc->lock);
570 dev_dbg(&desc->intf->dev, "wdm_release: cleanup");
572 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
573 desc->intf->needs_remote_wakeup = 0;
575 mutex_unlock(&wdm_mutex);
579 static const struct file_operations wdm_fops = {
580 .owner = THIS_MODULE,
585 .release = wdm_release,
589 static struct usb_class_driver wdm_class = {
592 .minor_base = WDM_MINOR_BASE,
595 /* --- error handling --- */
596 static void wdm_rxwork(struct work_struct *work)
598 struct wdm_device *desc = container_of(work, struct wdm_device, rxwork);
602 spin_lock_irqsave(&desc->iuspin, flags);
603 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
604 spin_unlock_irqrestore(&desc->iuspin, flags);
606 spin_unlock_irqrestore(&desc->iuspin, flags);
607 rv = usb_submit_urb(desc->response, GFP_KERNEL);
608 if (rv < 0 && rv != -EPERM) {
609 spin_lock_irqsave(&desc->iuspin, flags);
610 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
611 schedule_work(&desc->rxwork);
612 spin_unlock_irqrestore(&desc->iuspin, flags);
617 /* --- hotplug --- */
619 static int wdm_probe(struct usb_interface *intf, const struct usb_device_id *id)
622 struct usb_device *udev = interface_to_usbdev(intf);
623 struct wdm_device *desc;
624 struct usb_host_interface *iface;
625 struct usb_endpoint_descriptor *ep;
626 struct usb_cdc_dmm_desc *dmhd;
627 u8 *buffer = intf->altsetting->extra;
628 int buflen = intf->altsetting->extralen;
635 if (buffer [1] != USB_DT_CS_INTERFACE) {
636 dev_err(&intf->dev, "skipping garbage\n");
640 switch (buffer [2]) {
641 case USB_CDC_HEADER_TYPE:
643 case USB_CDC_DMM_TYPE:
644 dmhd = (struct usb_cdc_dmm_desc *)buffer;
645 maxcom = le16_to_cpu(dmhd->wMaxCommand);
647 "Finding maximum buffer length: %d", maxcom);
651 "Ignoring extra header, type %d, length %d\n",
652 buffer[2], buffer[0]);
661 desc = kzalloc(sizeof(struct wdm_device), GFP_KERNEL);
664 mutex_init(&desc->lock);
665 spin_lock_init(&desc->iuspin);
666 init_waitqueue_head(&desc->wait);
667 desc->wMaxCommand = maxcom;
668 /* this will be expanded and needed in hardware endianness */
669 desc->inum = cpu_to_le16((u16)intf->cur_altsetting->desc.bInterfaceNumber);
671 INIT_WORK(&desc->rxwork, wdm_rxwork);
674 iface = intf->cur_altsetting;
675 if (iface->desc.bNumEndpoints != 1)
677 ep = &iface->endpoint[0].desc;
678 if (!ep || !usb_endpoint_is_int_in(ep))
681 desc->wMaxPacketSize = le16_to_cpu(ep->wMaxPacketSize);
682 desc->bMaxPacketSize0 = udev->descriptor.bMaxPacketSize0;
684 desc->orq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
687 desc->irq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
691 desc->validity = usb_alloc_urb(0, GFP_KERNEL);
695 desc->response = usb_alloc_urb(0, GFP_KERNEL);
699 desc->command = usb_alloc_urb(0, GFP_KERNEL);
703 desc->ubuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
707 desc->sbuf = usb_buffer_alloc(interface_to_usbdev(intf),
708 desc->wMaxPacketSize,
710 &desc->validity->transfer_dma);
714 desc->inbuf = usb_buffer_alloc(interface_to_usbdev(intf),
715 desc->bMaxPacketSize0,
717 &desc->response->transfer_dma);
723 interface_to_usbdev(intf),
724 usb_rcvintpipe(interface_to_usbdev(intf), ep->bEndpointAddress),
726 desc->wMaxPacketSize,
731 desc->validity->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
733 usb_set_intfdata(intf, desc);
734 rv = usb_register_dev(intf, &wdm_class);
738 dev_info(&intf->dev, "cdc-wdm%d: USB WDM device\n",
739 intf->minor - WDM_MINOR_BASE);
743 usb_set_intfdata(intf, NULL);
744 usb_buffer_free(interface_to_usbdev(desc->intf),
745 desc->bMaxPacketSize0,
747 desc->response->transfer_dma);
749 usb_buffer_free(interface_to_usbdev(desc->intf),
750 desc->wMaxPacketSize,
752 desc->validity->transfer_dma);
762 static void wdm_disconnect(struct usb_interface *intf)
764 struct wdm_device *desc;
767 usb_deregister_dev(intf, &wdm_class);
768 mutex_lock(&wdm_mutex);
769 desc = usb_get_intfdata(intf);
771 /* the spinlock makes sure no new urbs are generated in the callbacks */
772 spin_lock_irqsave(&desc->iuspin, flags);
773 set_bit(WDM_DISCONNECTING, &desc->flags);
774 set_bit(WDM_READ, &desc->flags);
775 /* to terminate pending flushes */
776 clear_bit(WDM_IN_USE, &desc->flags);
777 spin_unlock_irqrestore(&desc->iuspin, flags);
778 cancel_work_sync(&desc->rxwork);
779 mutex_lock(&desc->lock);
781 mutex_unlock(&desc->lock);
782 wake_up_all(&desc->wait);
785 mutex_unlock(&wdm_mutex);
788 static int wdm_suspend(struct usb_interface *intf, pm_message_t message)
790 struct wdm_device *desc = usb_get_intfdata(intf);
793 dev_dbg(&desc->intf->dev, "wdm%d_suspend\n", intf->minor);
795 mutex_lock(&desc->lock);
797 if ((message.event & PM_EVENT_AUTO) &&
798 test_bit(WDM_IN_USE, &desc->flags)) {
802 cancel_work_sync(&desc->rxwork);
807 mutex_unlock(&desc->lock);
812 static int recover_from_urb_loss(struct wdm_device *desc)
817 rv = usb_submit_urb(desc->validity, GFP_NOIO);
819 dev_err(&desc->intf->dev,
820 "Error resume submitting int urb - %d\n", rv);
824 static int wdm_resume(struct usb_interface *intf)
826 struct wdm_device *desc = usb_get_intfdata(intf);
829 dev_dbg(&desc->intf->dev, "wdm%d_resume\n", intf->minor);
830 mutex_lock(&desc->lock);
831 rv = recover_from_urb_loss(desc);
832 mutex_unlock(&desc->lock);
836 static int wdm_pre_reset(struct usb_interface *intf)
838 struct wdm_device *desc = usb_get_intfdata(intf);
840 mutex_lock(&desc->lock);
844 static int wdm_post_reset(struct usb_interface *intf)
846 struct wdm_device *desc = usb_get_intfdata(intf);
849 rv = recover_from_urb_loss(desc);
850 mutex_unlock(&desc->lock);
854 static struct usb_driver wdm_driver = {
857 .disconnect = wdm_disconnect,
858 .suspend = wdm_suspend,
859 .resume = wdm_resume,
860 .reset_resume = wdm_resume,
861 .pre_reset = wdm_pre_reset,
862 .post_reset = wdm_post_reset,
864 .supports_autosuspend = 1,
867 /* --- low level module stuff --- */
869 static int __init wdm_init(void)
873 rv = usb_register(&wdm_driver);
878 static void __exit wdm_exit(void)
880 usb_deregister(&wdm_driver);
883 module_init(wdm_init);
884 module_exit(wdm_exit);
886 MODULE_AUTHOR(DRIVER_AUTHOR);
887 MODULE_DESCRIPTION(DRIVER_DESC);
888 MODULE_LICENSE("GPL");