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
55 #define WDM_RESPONDING 7
56 #define WDM_SUSPENDING 8
60 /* CDC-WMC r1.1 requires wMaxCommand to be "at least 256 decimal (0x100)" */
61 #define WDM_DEFAULT_BUFSIZE 256
63 static DEFINE_MUTEX(wdm_mutex);
65 /* --- method tables --- */
68 u8 *inbuf; /* buffer for response */
69 u8 *outbuf; /* buffer for command */
70 u8 *sbuf; /* buffer for status */
71 u8 *ubuf; /* buffer for copy to user space */
76 struct usb_interface *intf;
77 struct usb_ctrlrequest *orq;
78 struct usb_ctrlrequest *irq;
95 wait_queue_head_t wait;
96 struct work_struct rxwork;
101 static struct usb_driver wdm_driver;
103 /* --- callbacks --- */
104 static void wdm_out_callback(struct urb *urb)
106 struct wdm_device *desc;
108 spin_lock(&desc->iuspin);
109 desc->werr = urb->status;
110 spin_unlock(&desc->iuspin);
111 clear_bit(WDM_IN_USE, &desc->flags);
113 wake_up(&desc->wait);
116 static void wdm_in_callback(struct urb *urb)
118 struct wdm_device *desc = urb->context;
119 int status = urb->status;
121 spin_lock(&desc->iuspin);
122 clear_bit(WDM_RESPONDING, &desc->flags);
127 dev_dbg(&desc->intf->dev,
128 "nonzero urb status received: -ENOENT");
131 dev_dbg(&desc->intf->dev,
132 "nonzero urb status received: -ECONNRESET");
135 dev_dbg(&desc->intf->dev,
136 "nonzero urb status received: -ESHUTDOWN");
139 dev_err(&desc->intf->dev,
140 "nonzero urb status received: -EPIPE\n");
143 dev_err(&desc->intf->dev,
144 "Unexpected error %d\n", status);
150 desc->reslength = urb->actual_length;
151 memmove(desc->ubuf + desc->length, desc->inbuf, desc->reslength);
152 desc->length += desc->reslength;
154 wake_up(&desc->wait);
156 set_bit(WDM_READ, &desc->flags);
157 spin_unlock(&desc->iuspin);
160 static void wdm_int_callback(struct urb *urb)
163 int status = urb->status;
164 struct wdm_device *desc;
165 struct usb_ctrlrequest *req;
166 struct usb_cdc_notification *dr;
170 dr = (struct usb_cdc_notification *)desc->sbuf;
179 set_bit(WDM_INT_STALL, &desc->flags);
180 dev_err(&desc->intf->dev, "Stall on int endpoint\n");
181 goto sw; /* halt is cleared in work */
183 dev_err(&desc->intf->dev,
184 "nonzero urb status received: %d\n", status);
189 if (urb->actual_length < sizeof(struct usb_cdc_notification)) {
190 dev_err(&desc->intf->dev, "wdm_int_callback - %d bytes\n",
195 switch (dr->bNotificationType) {
196 case USB_CDC_NOTIFY_RESPONSE_AVAILABLE:
197 dev_dbg(&desc->intf->dev,
198 "NOTIFY_RESPONSE_AVAILABLE received: index %d len %d",
199 dr->wIndex, dr->wLength);
202 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
204 dev_dbg(&desc->intf->dev,
205 "NOTIFY_NETWORK_CONNECTION %s network",
206 dr->wValue ? "connected to" : "disconnected from");
209 clear_bit(WDM_POLL_RUNNING, &desc->flags);
210 dev_err(&desc->intf->dev,
211 "unknown notification %d received: index %d len %d\n",
212 dr->bNotificationType, dr->wIndex, dr->wLength);
216 req->bRequestType = (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE);
217 req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
219 req->wIndex = desc->inum;
220 req->wLength = cpu_to_le16(desc->wMaxCommand);
222 usb_fill_control_urb(
224 interface_to_usbdev(desc->intf),
225 /* using common endpoint 0 */
226 usb_rcvctrlpipe(interface_to_usbdev(desc->intf), 0),
227 (unsigned char *)req,
233 desc->response->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
234 spin_lock(&desc->iuspin);
235 clear_bit(WDM_READ, &desc->flags);
236 set_bit(WDM_RESPONDING, &desc->flags);
237 if (!test_bit(WDM_DISCONNECTING, &desc->flags)
238 && !test_bit(WDM_SUSPENDING, &desc->flags)) {
239 rv = usb_submit_urb(desc->response, GFP_ATOMIC);
240 dev_dbg(&desc->intf->dev, "%s: usb_submit_urb %d",
243 spin_unlock(&desc->iuspin);
245 clear_bit(WDM_RESPONDING, &desc->flags);
250 rv = schedule_work(&desc->rxwork);
252 dev_err(&desc->intf->dev,
253 "Cannot schedule work\n");
257 rv = usb_submit_urb(urb, GFP_ATOMIC);
259 dev_err(&desc->intf->dev,
260 "%s - usb_submit_urb failed with result %d\n",
265 static void kill_urbs(struct wdm_device *desc)
267 /* the order here is essential */
268 usb_kill_urb(desc->command);
269 usb_kill_urb(desc->validity);
270 usb_kill_urb(desc->response);
273 static void free_urbs(struct wdm_device *desc)
275 usb_free_urb(desc->validity);
276 usb_free_urb(desc->response);
277 usb_free_urb(desc->command);
280 static void cleanup(struct wdm_device *desc)
282 usb_free_coherent(interface_to_usbdev(desc->intf),
283 desc->wMaxPacketSize,
285 desc->validity->transfer_dma);
286 usb_free_coherent(interface_to_usbdev(desc->intf),
287 desc->bMaxPacketSize0,
289 desc->response->transfer_dma);
297 static ssize_t wdm_write
298 (struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
301 int rv = -EMSGSIZE, r, we;
302 struct wdm_device *desc = file->private_data;
303 struct usb_ctrlrequest *req;
305 if (count > desc->wMaxCommand)
306 count = desc->wMaxCommand;
308 spin_lock_irq(&desc->iuspin);
311 spin_unlock_irq(&desc->iuspin);
315 desc->outbuf = buf = kmalloc(count, GFP_KERNEL);
321 r = copy_from_user(buf, buffer, count);
328 /* concurrent writes and disconnect */
329 r = mutex_lock_interruptible(&desc->wlock);
336 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
342 r = usb_autopm_get_interface(desc->intf);
348 if (!(file->f_flags & O_NONBLOCK))
349 r = wait_event_interruptible(desc->wait, !test_bit(WDM_IN_USE,
352 if (test_bit(WDM_IN_USE, &desc->flags))
360 usb_fill_control_urb(
362 interface_to_usbdev(desc->intf),
363 /* using common endpoint 0 */
364 usb_sndctrlpipe(interface_to_usbdev(desc->intf), 0),
365 (unsigned char *)req,
372 req->bRequestType = (USB_DIR_OUT | USB_TYPE_CLASS |
373 USB_RECIP_INTERFACE);
374 req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
376 req->wIndex = desc->inum;
377 req->wLength = cpu_to_le16(count);
378 set_bit(WDM_IN_USE, &desc->flags);
380 rv = usb_submit_urb(desc->command, GFP_KERNEL);
383 clear_bit(WDM_IN_USE, &desc->flags);
384 dev_err(&desc->intf->dev, "Tx URB error: %d\n", rv);
386 dev_dbg(&desc->intf->dev, "Tx URB has been submitted index=%d",
390 usb_autopm_put_interface(desc->intf);
392 mutex_unlock(&desc->wlock);
394 return rv < 0 ? rv : count;
397 static ssize_t wdm_read
398 (struct file *file, char __user *buffer, size_t count, loff_t *ppos)
402 struct wdm_device *desc = file->private_data;
405 rv = mutex_lock_interruptible(&desc->rlock); /*concurrent reads */
409 cntr = ACCESS_ONCE(desc->length);
413 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
418 if (file->f_flags & O_NONBLOCK) {
419 if (!test_bit(WDM_READ, &desc->flags)) {
420 rv = cntr ? cntr : -EAGAIN;
425 rv = wait_event_interruptible(desc->wait,
426 test_bit(WDM_READ, &desc->flags));
429 /* may have happened while we slept */
430 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
434 usb_mark_last_busy(interface_to_usbdev(desc->intf));
440 spin_lock_irq(&desc->iuspin);
442 if (desc->rerr) { /* read completed, error happened */
444 spin_unlock_irq(&desc->iuspin);
449 * recheck whether we've lost the race
450 * against the completion handler
452 if (!test_bit(WDM_READ, &desc->flags)) { /* lost race */
453 spin_unlock_irq(&desc->iuspin);
456 if (!desc->reslength) { /* zero length read */
457 spin_unlock_irq(&desc->iuspin);
461 spin_unlock_irq(&desc->iuspin);
466 rv = copy_to_user(buffer, desc->ubuf, cntr);
472 spin_lock_irq(&desc->iuspin);
474 for (i = 0; i < desc->length - cntr; i++)
475 desc->ubuf[i] = desc->ubuf[i + cntr];
477 desc->length -= cntr;
478 /* in case we had outstanding data */
480 clear_bit(WDM_READ, &desc->flags);
482 spin_unlock_irq(&desc->iuspin);
487 mutex_unlock(&desc->rlock);
491 static int wdm_flush(struct file *file, fl_owner_t id)
493 struct wdm_device *desc = file->private_data;
495 wait_event(desc->wait, !test_bit(WDM_IN_USE, &desc->flags));
497 dev_err(&desc->intf->dev, "Error in flush path: %d\n",
503 static unsigned int wdm_poll(struct file *file, struct poll_table_struct *wait)
505 struct wdm_device *desc = file->private_data;
507 unsigned int mask = 0;
509 spin_lock_irqsave(&desc->iuspin, flags);
510 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
512 spin_unlock_irqrestore(&desc->iuspin, flags);
515 if (test_bit(WDM_READ, &desc->flags))
516 mask = POLLIN | POLLRDNORM;
517 if (desc->rerr || desc->werr)
519 if (!test_bit(WDM_IN_USE, &desc->flags))
520 mask |= POLLOUT | POLLWRNORM;
521 spin_unlock_irqrestore(&desc->iuspin, flags);
523 poll_wait(file, &desc->wait, wait);
529 static int wdm_open(struct inode *inode, struct file *file)
531 int minor = iminor(inode);
533 struct usb_interface *intf;
534 struct wdm_device *desc;
536 mutex_lock(&wdm_mutex);
537 intf = usb_find_interface(&wdm_driver, minor);
541 desc = usb_get_intfdata(intf);
542 if (test_bit(WDM_DISCONNECTING, &desc->flags))
544 file->private_data = desc;
546 rv = usb_autopm_get_interface(desc->intf);
548 dev_err(&desc->intf->dev, "Error autopm - %d\n", rv);
551 intf->needs_remote_wakeup = 1;
553 /* using write lock to protect desc->count */
554 mutex_lock(&desc->wlock);
555 if (!desc->count++) {
558 rv = usb_submit_urb(desc->validity, GFP_KERNEL);
561 dev_err(&desc->intf->dev,
562 "Error submitting int urb - %d\n", rv);
567 mutex_unlock(&desc->wlock);
568 usb_autopm_put_interface(desc->intf);
570 mutex_unlock(&wdm_mutex);
574 static int wdm_release(struct inode *inode, struct file *file)
576 struct wdm_device *desc = file->private_data;
578 mutex_lock(&wdm_mutex);
580 /* using write lock to protect desc->count */
581 mutex_lock(&desc->wlock);
583 mutex_unlock(&desc->wlock);
586 dev_dbg(&desc->intf->dev, "wdm_release: cleanup");
588 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
589 desc->intf->needs_remote_wakeup = 0;
591 mutex_unlock(&wdm_mutex);
595 static const struct file_operations wdm_fops = {
596 .owner = THIS_MODULE,
601 .release = wdm_release,
603 .llseek = noop_llseek,
606 static struct usb_class_driver wdm_class = {
609 .minor_base = WDM_MINOR_BASE,
612 /* --- error handling --- */
613 static void wdm_rxwork(struct work_struct *work)
615 struct wdm_device *desc = container_of(work, struct wdm_device, rxwork);
619 spin_lock_irqsave(&desc->iuspin, flags);
620 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
621 spin_unlock_irqrestore(&desc->iuspin, flags);
623 spin_unlock_irqrestore(&desc->iuspin, flags);
624 rv = usb_submit_urb(desc->response, GFP_KERNEL);
625 if (rv < 0 && rv != -EPERM) {
626 spin_lock_irqsave(&desc->iuspin, flags);
627 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
628 schedule_work(&desc->rxwork);
629 spin_unlock_irqrestore(&desc->iuspin, flags);
634 /* --- hotplug --- */
636 static int wdm_probe(struct usb_interface *intf, const struct usb_device_id *id)
639 struct usb_device *udev = interface_to_usbdev(intf);
640 struct wdm_device *desc;
641 struct usb_host_interface *iface;
642 struct usb_endpoint_descriptor *ep;
643 struct usb_cdc_dmm_desc *dmhd;
644 u8 *buffer = intf->altsetting->extra;
645 int buflen = intf->altsetting->extralen;
646 u16 maxcom = WDM_DEFAULT_BUFSIZE;
652 if (buffer [1] != USB_DT_CS_INTERFACE) {
653 dev_err(&intf->dev, "skipping garbage\n");
657 switch (buffer [2]) {
658 case USB_CDC_HEADER_TYPE:
660 case USB_CDC_DMM_TYPE:
661 dmhd = (struct usb_cdc_dmm_desc *)buffer;
662 maxcom = le16_to_cpu(dmhd->wMaxCommand);
664 "Finding maximum buffer length: %d", maxcom);
668 "Ignoring extra header, type %d, length %d\n",
669 buffer[2], buffer[0]);
678 desc = kzalloc(sizeof(struct wdm_device), GFP_KERNEL);
681 mutex_init(&desc->rlock);
682 mutex_init(&desc->wlock);
683 spin_lock_init(&desc->iuspin);
684 init_waitqueue_head(&desc->wait);
685 desc->wMaxCommand = maxcom;
686 /* this will be expanded and needed in hardware endianness */
687 desc->inum = cpu_to_le16((u16)intf->cur_altsetting->desc.bInterfaceNumber);
689 INIT_WORK(&desc->rxwork, wdm_rxwork);
692 iface = intf->cur_altsetting;
693 if (iface->desc.bNumEndpoints != 1)
695 ep = &iface->endpoint[0].desc;
696 if (!ep || !usb_endpoint_is_int_in(ep))
699 desc->wMaxPacketSize = usb_endpoint_maxp(ep);
700 desc->bMaxPacketSize0 = udev->descriptor.bMaxPacketSize0;
702 desc->orq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
705 desc->irq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
709 desc->validity = usb_alloc_urb(0, GFP_KERNEL);
713 desc->response = usb_alloc_urb(0, GFP_KERNEL);
717 desc->command = usb_alloc_urb(0, GFP_KERNEL);
721 desc->ubuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
725 desc->sbuf = usb_alloc_coherent(interface_to_usbdev(intf),
726 desc->wMaxPacketSize,
728 &desc->validity->transfer_dma);
732 desc->inbuf = usb_alloc_coherent(interface_to_usbdev(intf),
735 &desc->response->transfer_dma);
741 interface_to_usbdev(intf),
742 usb_rcvintpipe(interface_to_usbdev(intf), ep->bEndpointAddress),
744 desc->wMaxPacketSize,
749 desc->validity->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
751 usb_set_intfdata(intf, desc);
752 rv = usb_register_dev(intf, &wdm_class);
756 dev_info(&intf->dev, "cdc-wdm%d: USB WDM device\n",
757 intf->minor - WDM_MINOR_BASE);
761 usb_set_intfdata(intf, NULL);
762 usb_free_coherent(interface_to_usbdev(desc->intf),
763 desc->bMaxPacketSize0,
765 desc->response->transfer_dma);
767 usb_free_coherent(interface_to_usbdev(desc->intf),
768 desc->wMaxPacketSize,
770 desc->validity->transfer_dma);
780 static void wdm_disconnect(struct usb_interface *intf)
782 struct wdm_device *desc;
785 usb_deregister_dev(intf, &wdm_class);
786 mutex_lock(&wdm_mutex);
787 desc = usb_get_intfdata(intf);
789 /* the spinlock makes sure no new urbs are generated in the callbacks */
790 spin_lock_irqsave(&desc->iuspin, flags);
791 set_bit(WDM_DISCONNECTING, &desc->flags);
792 set_bit(WDM_READ, &desc->flags);
793 /* to terminate pending flushes */
794 clear_bit(WDM_IN_USE, &desc->flags);
795 spin_unlock_irqrestore(&desc->iuspin, flags);
796 wake_up_all(&desc->wait);
797 mutex_lock(&desc->rlock);
798 mutex_lock(&desc->wlock);
800 cancel_work_sync(&desc->rxwork);
801 mutex_unlock(&desc->wlock);
802 mutex_unlock(&desc->rlock);
805 mutex_unlock(&wdm_mutex);
809 static int wdm_suspend(struct usb_interface *intf, pm_message_t message)
811 struct wdm_device *desc = usb_get_intfdata(intf);
814 dev_dbg(&desc->intf->dev, "wdm%d_suspend\n", intf->minor);
816 /* if this is an autosuspend the caller does the locking */
817 if (!PMSG_IS_AUTO(message)) {
818 mutex_lock(&desc->rlock);
819 mutex_lock(&desc->wlock);
821 spin_lock_irq(&desc->iuspin);
823 if (PMSG_IS_AUTO(message) &&
824 (test_bit(WDM_IN_USE, &desc->flags)
825 || test_bit(WDM_RESPONDING, &desc->flags))) {
826 spin_unlock_irq(&desc->iuspin);
830 set_bit(WDM_SUSPENDING, &desc->flags);
831 spin_unlock_irq(&desc->iuspin);
832 /* callback submits work - order is essential */
834 cancel_work_sync(&desc->rxwork);
836 if (!PMSG_IS_AUTO(message)) {
837 mutex_unlock(&desc->wlock);
838 mutex_unlock(&desc->rlock);
845 static int recover_from_urb_loss(struct wdm_device *desc)
850 rv = usb_submit_urb(desc->validity, GFP_NOIO);
852 dev_err(&desc->intf->dev,
853 "Error resume submitting int urb - %d\n", rv);
859 static int wdm_resume(struct usb_interface *intf)
861 struct wdm_device *desc = usb_get_intfdata(intf);
864 dev_dbg(&desc->intf->dev, "wdm%d_resume\n", intf->minor);
866 clear_bit(WDM_SUSPENDING, &desc->flags);
867 rv = recover_from_urb_loss(desc);
873 static int wdm_pre_reset(struct usb_interface *intf)
875 struct wdm_device *desc = usb_get_intfdata(intf);
877 mutex_lock(&desc->rlock);
878 mutex_lock(&desc->wlock);
882 * we notify everybody using poll of
883 * an exceptional situation
884 * must be done before recovery lest a spontaneous
885 * message from the device is lost
887 spin_lock_irq(&desc->iuspin);
889 spin_unlock_irq(&desc->iuspin);
890 wake_up_all(&desc->wait);
894 static int wdm_post_reset(struct usb_interface *intf)
896 struct wdm_device *desc = usb_get_intfdata(intf);
899 rv = recover_from_urb_loss(desc);
900 mutex_unlock(&desc->wlock);
901 mutex_unlock(&desc->rlock);
905 static struct usb_driver wdm_driver = {
908 .disconnect = wdm_disconnect,
910 .suspend = wdm_suspend,
911 .resume = wdm_resume,
912 .reset_resume = wdm_resume,
914 .pre_reset = wdm_pre_reset,
915 .post_reset = wdm_post_reset,
917 .supports_autosuspend = 1,
920 /* --- low level module stuff --- */
922 static int __init wdm_init(void)
926 rv = usb_register(&wdm_driver);
931 static void __exit wdm_exit(void)
933 usb_deregister(&wdm_driver);
936 module_init(wdm_init);
937 module_exit(wdm_exit);
939 MODULE_AUTHOR(DRIVER_AUTHOR);
940 MODULE_DESCRIPTION(DRIVER_DESC);
941 MODULE_LICENSE("GPL");