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 #define HUAWEI_VENDOR_ID 0x12D1
36 static const struct usb_device_id wdm_ids[] = {
38 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
39 USB_DEVICE_ID_MATCH_INT_SUBCLASS,
40 .bInterfaceClass = USB_CLASS_COMM,
41 .bInterfaceSubClass = USB_CDC_SUBCLASS_DMM
45 * Huawei E392, E398 and possibly other Qualcomm based modems
46 * embed the Qualcomm QMI protocol inside CDC on CDC ECM like
47 * control interfaces. Userspace access to this is required
48 * to configure the accompanying data interface
50 .match_flags = USB_DEVICE_ID_MATCH_VENDOR |
51 USB_DEVICE_ID_MATCH_INT_INFO,
52 .idVendor = HUAWEI_VENDOR_ID,
53 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
54 .bInterfaceSubClass = 1,
55 .bInterfaceProtocol = 9, /* NOTE: CDC ECM control interface! */
60 MODULE_DEVICE_TABLE (usb, wdm_ids);
62 #define WDM_MINOR_BASE 176
66 #define WDM_DISCONNECTING 2
69 #define WDM_INT_STALL 5
70 #define WDM_POLL_RUNNING 6
71 #define WDM_RESPONDING 7
72 #define WDM_SUSPENDING 8
73 #define WDM_RESETTING 9
77 /* CDC-WMC r1.1 requires wMaxCommand to be "at least 256 decimal (0x100)" */
78 #define WDM_DEFAULT_BUFSIZE 256
80 static DEFINE_MUTEX(wdm_mutex);
82 /* --- method tables --- */
85 u8 *inbuf; /* buffer for response */
86 u8 *outbuf; /* buffer for command */
87 u8 *sbuf; /* buffer for status */
88 u8 *ubuf; /* buffer for copy to user space */
93 struct usb_interface *intf;
94 struct usb_ctrlrequest *orq;
95 struct usb_ctrlrequest *irq;
111 wait_queue_head_t wait;
112 struct work_struct rxwork;
117 static struct usb_driver wdm_driver;
119 /* --- callbacks --- */
120 static void wdm_out_callback(struct urb *urb)
122 struct wdm_device *desc;
124 spin_lock(&desc->iuspin);
125 desc->werr = urb->status;
126 spin_unlock(&desc->iuspin);
127 clear_bit(WDM_IN_USE, &desc->flags);
129 wake_up(&desc->wait);
132 static void wdm_in_callback(struct urb *urb)
134 struct wdm_device *desc = urb->context;
135 int status = urb->status;
137 spin_lock(&desc->iuspin);
138 clear_bit(WDM_RESPONDING, &desc->flags);
143 dev_dbg(&desc->intf->dev,
144 "nonzero urb status received: -ENOENT");
147 dev_dbg(&desc->intf->dev,
148 "nonzero urb status received: -ECONNRESET");
151 dev_dbg(&desc->intf->dev,
152 "nonzero urb status received: -ESHUTDOWN");
155 dev_err(&desc->intf->dev,
156 "nonzero urb status received: -EPIPE\n");
159 dev_err(&desc->intf->dev,
160 "Unexpected error %d\n", status);
166 desc->reslength = urb->actual_length;
167 memmove(desc->ubuf + desc->length, desc->inbuf, desc->reslength);
168 desc->length += desc->reslength;
170 wake_up(&desc->wait);
172 set_bit(WDM_READ, &desc->flags);
173 spin_unlock(&desc->iuspin);
176 static void wdm_int_callback(struct urb *urb)
179 int status = urb->status;
180 struct wdm_device *desc;
181 struct usb_cdc_notification *dr;
184 dr = (struct usb_cdc_notification *)desc->sbuf;
193 set_bit(WDM_INT_STALL, &desc->flags);
194 dev_err(&desc->intf->dev, "Stall on int endpoint\n");
195 goto sw; /* halt is cleared in work */
197 dev_err(&desc->intf->dev,
198 "nonzero urb status received: %d\n", status);
203 if (urb->actual_length < sizeof(struct usb_cdc_notification)) {
204 dev_err(&desc->intf->dev, "wdm_int_callback - %d bytes\n",
209 switch (dr->bNotificationType) {
210 case USB_CDC_NOTIFY_RESPONSE_AVAILABLE:
211 dev_dbg(&desc->intf->dev,
212 "NOTIFY_RESPONSE_AVAILABLE received: index %d len %d",
213 dr->wIndex, dr->wLength);
216 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
218 dev_dbg(&desc->intf->dev,
219 "NOTIFY_NETWORK_CONNECTION %s network",
220 dr->wValue ? "connected to" : "disconnected from");
223 clear_bit(WDM_POLL_RUNNING, &desc->flags);
224 dev_err(&desc->intf->dev,
225 "unknown notification %d received: index %d len %d\n",
226 dr->bNotificationType, dr->wIndex, dr->wLength);
230 spin_lock(&desc->iuspin);
231 clear_bit(WDM_READ, &desc->flags);
232 set_bit(WDM_RESPONDING, &desc->flags);
233 if (!test_bit(WDM_DISCONNECTING, &desc->flags)
234 && !test_bit(WDM_SUSPENDING, &desc->flags)) {
235 rv = usb_submit_urb(desc->response, GFP_ATOMIC);
236 dev_dbg(&desc->intf->dev, "%s: usb_submit_urb %d",
239 spin_unlock(&desc->iuspin);
241 clear_bit(WDM_RESPONDING, &desc->flags);
246 rv = schedule_work(&desc->rxwork);
248 dev_err(&desc->intf->dev,
249 "Cannot schedule work\n");
253 rv = usb_submit_urb(urb, GFP_ATOMIC);
255 dev_err(&desc->intf->dev,
256 "%s - usb_submit_urb failed with result %d\n",
261 static void kill_urbs(struct wdm_device *desc)
263 /* the order here is essential */
264 usb_kill_urb(desc->command);
265 usb_kill_urb(desc->validity);
266 usb_kill_urb(desc->response);
269 static void free_urbs(struct wdm_device *desc)
271 usb_free_urb(desc->validity);
272 usb_free_urb(desc->response);
273 usb_free_urb(desc->command);
276 static void cleanup(struct wdm_device *desc)
287 static ssize_t wdm_write
288 (struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
291 int rv = -EMSGSIZE, r, we;
292 struct wdm_device *desc = file->private_data;
293 struct usb_ctrlrequest *req;
295 if (count > desc->wMaxCommand)
296 count = desc->wMaxCommand;
298 spin_lock_irq(&desc->iuspin);
301 spin_unlock_irq(&desc->iuspin);
305 desc->outbuf = buf = kmalloc(count, GFP_KERNEL);
311 r = copy_from_user(buf, buffer, count);
318 /* concurrent writes and disconnect */
319 r = mutex_lock_interruptible(&desc->wlock);
326 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
332 r = usb_autopm_get_interface(desc->intf);
338 if (!(file->f_flags & O_NONBLOCK))
339 r = wait_event_interruptible(desc->wait, !test_bit(WDM_IN_USE,
342 if (test_bit(WDM_IN_USE, &desc->flags))
345 if (test_bit(WDM_RESETTING, &desc->flags))
354 usb_fill_control_urb(
356 interface_to_usbdev(desc->intf),
357 /* using common endpoint 0 */
358 usb_sndctrlpipe(interface_to_usbdev(desc->intf), 0),
359 (unsigned char *)req,
366 req->bRequestType = (USB_DIR_OUT | USB_TYPE_CLASS |
367 USB_RECIP_INTERFACE);
368 req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
370 req->wIndex = desc->inum;
371 req->wLength = cpu_to_le16(count);
372 set_bit(WDM_IN_USE, &desc->flags);
374 rv = usb_submit_urb(desc->command, GFP_KERNEL);
377 clear_bit(WDM_IN_USE, &desc->flags);
378 dev_err(&desc->intf->dev, "Tx URB error: %d\n", rv);
380 dev_dbg(&desc->intf->dev, "Tx URB has been submitted index=%d",
384 usb_autopm_put_interface(desc->intf);
386 mutex_unlock(&desc->wlock);
388 return rv < 0 ? rv : count;
391 static ssize_t wdm_read
392 (struct file *file, char __user *buffer, size_t count, loff_t *ppos)
396 struct wdm_device *desc = file->private_data;
399 rv = mutex_lock_interruptible(&desc->rlock); /*concurrent reads */
403 if (desc->length == 0) {
406 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
411 if (file->f_flags & O_NONBLOCK) {
412 if (!test_bit(WDM_READ, &desc->flags)) {
413 rv = cntr ? cntr : -EAGAIN;
418 rv = wait_event_interruptible(desc->wait,
419 test_bit(WDM_READ, &desc->flags));
422 /* may have happened while we slept */
423 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
427 if (test_bit(WDM_RESETTING, &desc->flags)) {
431 usb_mark_last_busy(interface_to_usbdev(desc->intf));
437 spin_lock_irq(&desc->iuspin);
439 if (desc->rerr) { /* read completed, error happened */
441 spin_unlock_irq(&desc->iuspin);
446 * recheck whether we've lost the race
447 * against the completion handler
449 if (!test_bit(WDM_READ, &desc->flags)) { /* lost race */
450 spin_unlock_irq(&desc->iuspin);
453 if (!desc->reslength) { /* zero length read */
454 spin_unlock_irq(&desc->iuspin);
457 clear_bit(WDM_READ, &desc->flags);
458 spin_unlock_irq(&desc->iuspin);
461 cntr = count > desc->length ? desc->length : count;
462 rv = copy_to_user(buffer, desc->ubuf, cntr);
468 for (i = 0; i < desc->length - cntr; i++)
469 desc->ubuf[i] = desc->ubuf[i + cntr];
471 spin_lock_irq(&desc->iuspin);
472 desc->length -= cntr;
473 spin_unlock_irq(&desc->iuspin);
474 /* in case we had outstanding data */
476 clear_bit(WDM_READ, &desc->flags);
480 mutex_unlock(&desc->rlock);
484 static int wdm_flush(struct file *file, fl_owner_t id)
486 struct wdm_device *desc = file->private_data;
488 wait_event(desc->wait, !test_bit(WDM_IN_USE, &desc->flags));
490 dev_err(&desc->intf->dev, "Error in flush path: %d\n",
496 static unsigned int wdm_poll(struct file *file, struct poll_table_struct *wait)
498 struct wdm_device *desc = file->private_data;
500 unsigned int mask = 0;
502 spin_lock_irqsave(&desc->iuspin, flags);
503 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
505 spin_unlock_irqrestore(&desc->iuspin, flags);
508 if (test_bit(WDM_READ, &desc->flags))
509 mask = POLLIN | POLLRDNORM;
510 if (desc->rerr || desc->werr)
512 if (!test_bit(WDM_IN_USE, &desc->flags))
513 mask |= POLLOUT | POLLWRNORM;
514 spin_unlock_irqrestore(&desc->iuspin, flags);
516 poll_wait(file, &desc->wait, wait);
522 static int wdm_open(struct inode *inode, struct file *file)
524 int minor = iminor(inode);
526 struct usb_interface *intf;
527 struct wdm_device *desc;
529 mutex_lock(&wdm_mutex);
530 intf = usb_find_interface(&wdm_driver, minor);
534 desc = usb_get_intfdata(intf);
535 if (test_bit(WDM_DISCONNECTING, &desc->flags))
537 file->private_data = desc;
539 rv = usb_autopm_get_interface(desc->intf);
541 dev_err(&desc->intf->dev, "Error autopm - %d\n", rv);
544 intf->needs_remote_wakeup = 1;
546 /* using write lock to protect desc->count */
547 mutex_lock(&desc->wlock);
548 if (!desc->count++) {
551 rv = usb_submit_urb(desc->validity, GFP_KERNEL);
554 dev_err(&desc->intf->dev,
555 "Error submitting int urb - %d\n", rv);
560 mutex_unlock(&desc->wlock);
561 usb_autopm_put_interface(desc->intf);
563 mutex_unlock(&wdm_mutex);
567 static int wdm_release(struct inode *inode, struct file *file)
569 struct wdm_device *desc = file->private_data;
571 mutex_lock(&wdm_mutex);
573 /* using write lock to protect desc->count */
574 mutex_lock(&desc->wlock);
576 mutex_unlock(&desc->wlock);
579 dev_dbg(&desc->intf->dev, "wdm_release: cleanup");
581 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
582 desc->intf->needs_remote_wakeup = 0;
584 mutex_unlock(&wdm_mutex);
588 static const struct file_operations wdm_fops = {
589 .owner = THIS_MODULE,
594 .release = wdm_release,
596 .llseek = noop_llseek,
599 static struct usb_class_driver wdm_class = {
602 .minor_base = WDM_MINOR_BASE,
605 /* --- error handling --- */
606 static void wdm_rxwork(struct work_struct *work)
608 struct wdm_device *desc = container_of(work, struct wdm_device, rxwork);
612 spin_lock_irqsave(&desc->iuspin, flags);
613 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
614 spin_unlock_irqrestore(&desc->iuspin, flags);
616 spin_unlock_irqrestore(&desc->iuspin, flags);
617 rv = usb_submit_urb(desc->response, GFP_KERNEL);
618 if (rv < 0 && rv != -EPERM) {
619 spin_lock_irqsave(&desc->iuspin, flags);
620 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
621 schedule_work(&desc->rxwork);
622 spin_unlock_irqrestore(&desc->iuspin, flags);
627 /* --- hotplug --- */
629 static int wdm_probe(struct usb_interface *intf, const struct usb_device_id *id)
632 struct wdm_device *desc;
633 struct usb_host_interface *iface;
634 struct usb_endpoint_descriptor *ep;
635 struct usb_cdc_dmm_desc *dmhd;
636 u8 *buffer = intf->altsetting->extra;
637 int buflen = intf->altsetting->extralen;
638 u16 maxcom = WDM_DEFAULT_BUFSIZE;
644 if (buffer [1] != USB_DT_CS_INTERFACE) {
645 dev_err(&intf->dev, "skipping garbage\n");
649 switch (buffer [2]) {
650 case USB_CDC_HEADER_TYPE:
652 case USB_CDC_DMM_TYPE:
653 dmhd = (struct usb_cdc_dmm_desc *)buffer;
654 maxcom = le16_to_cpu(dmhd->wMaxCommand);
656 "Finding maximum buffer length: %d", maxcom);
660 "Ignoring extra header, type %d, length %d\n",
661 buffer[2], buffer[0]);
670 desc = kzalloc(sizeof(struct wdm_device), GFP_KERNEL);
673 mutex_init(&desc->rlock);
674 mutex_init(&desc->wlock);
675 spin_lock_init(&desc->iuspin);
676 init_waitqueue_head(&desc->wait);
677 desc->wMaxCommand = maxcom;
678 /* this will be expanded and needed in hardware endianness */
679 desc->inum = cpu_to_le16((u16)intf->cur_altsetting->desc.bInterfaceNumber);
681 INIT_WORK(&desc->rxwork, wdm_rxwork);
684 iface = intf->cur_altsetting;
685 if (iface->desc.bNumEndpoints != 1)
687 ep = &iface->endpoint[0].desc;
688 if (!ep || !usb_endpoint_is_int_in(ep))
691 desc->wMaxPacketSize = usb_endpoint_maxp(ep);
693 desc->orq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
696 desc->irq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
700 desc->validity = usb_alloc_urb(0, GFP_KERNEL);
704 desc->response = usb_alloc_urb(0, GFP_KERNEL);
708 desc->command = usb_alloc_urb(0, GFP_KERNEL);
712 desc->ubuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
716 desc->sbuf = kmalloc(desc->wMaxPacketSize, GFP_KERNEL);
720 desc->inbuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
726 interface_to_usbdev(intf),
727 usb_rcvintpipe(interface_to_usbdev(intf), ep->bEndpointAddress),
729 desc->wMaxPacketSize,
735 desc->irq->bRequestType = (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE);
736 desc->irq->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
737 desc->irq->wValue = 0;
738 desc->irq->wIndex = desc->inum;
739 desc->irq->wLength = cpu_to_le16(desc->wMaxCommand);
741 usb_fill_control_urb(
743 interface_to_usbdev(intf),
744 /* using common endpoint 0 */
745 usb_rcvctrlpipe(interface_to_usbdev(desc->intf), 0),
746 (unsigned char *)desc->irq,
753 usb_set_intfdata(intf, desc);
754 rv = usb_register_dev(intf, &wdm_class);
758 dev_info(&intf->dev, "%s: USB WDM device\n", dev_name(intf->usb_dev));
762 usb_set_intfdata(intf, NULL);
774 static void wdm_disconnect(struct usb_interface *intf)
776 struct wdm_device *desc;
779 usb_deregister_dev(intf, &wdm_class);
780 mutex_lock(&wdm_mutex);
781 desc = usb_get_intfdata(intf);
783 /* the spinlock makes sure no new urbs are generated in the callbacks */
784 spin_lock_irqsave(&desc->iuspin, flags);
785 set_bit(WDM_DISCONNECTING, &desc->flags);
786 set_bit(WDM_READ, &desc->flags);
787 /* to terminate pending flushes */
788 clear_bit(WDM_IN_USE, &desc->flags);
789 spin_unlock_irqrestore(&desc->iuspin, flags);
790 wake_up_all(&desc->wait);
791 mutex_lock(&desc->rlock);
792 mutex_lock(&desc->wlock);
794 cancel_work_sync(&desc->rxwork);
795 mutex_unlock(&desc->wlock);
796 mutex_unlock(&desc->rlock);
799 mutex_unlock(&wdm_mutex);
803 static int wdm_suspend(struct usb_interface *intf, pm_message_t message)
805 struct wdm_device *desc = usb_get_intfdata(intf);
808 dev_dbg(&desc->intf->dev, "wdm%d_suspend\n", intf->minor);
810 /* if this is an autosuspend the caller does the locking */
811 if (!PMSG_IS_AUTO(message)) {
812 mutex_lock(&desc->rlock);
813 mutex_lock(&desc->wlock);
815 spin_lock_irq(&desc->iuspin);
817 if (PMSG_IS_AUTO(message) &&
818 (test_bit(WDM_IN_USE, &desc->flags)
819 || test_bit(WDM_RESPONDING, &desc->flags))) {
820 spin_unlock_irq(&desc->iuspin);
824 set_bit(WDM_SUSPENDING, &desc->flags);
825 spin_unlock_irq(&desc->iuspin);
826 /* callback submits work - order is essential */
828 cancel_work_sync(&desc->rxwork);
830 if (!PMSG_IS_AUTO(message)) {
831 mutex_unlock(&desc->wlock);
832 mutex_unlock(&desc->rlock);
839 static int recover_from_urb_loss(struct wdm_device *desc)
844 rv = usb_submit_urb(desc->validity, GFP_NOIO);
846 dev_err(&desc->intf->dev,
847 "Error resume submitting int urb - %d\n", rv);
853 static int wdm_resume(struct usb_interface *intf)
855 struct wdm_device *desc = usb_get_intfdata(intf);
858 dev_dbg(&desc->intf->dev, "wdm%d_resume\n", intf->minor);
860 clear_bit(WDM_SUSPENDING, &desc->flags);
861 rv = recover_from_urb_loss(desc);
867 static int wdm_pre_reset(struct usb_interface *intf)
869 struct wdm_device *desc = usb_get_intfdata(intf);
872 * we notify everybody using poll of
873 * an exceptional situation
874 * must be done before recovery lest a spontaneous
875 * message from the device is lost
877 spin_lock_irq(&desc->iuspin);
878 set_bit(WDM_RESETTING, &desc->flags); /* inform read/write */
879 set_bit(WDM_READ, &desc->flags); /* unblock read */
880 clear_bit(WDM_IN_USE, &desc->flags); /* unblock write */
882 spin_unlock_irq(&desc->iuspin);
883 wake_up_all(&desc->wait);
884 mutex_lock(&desc->rlock);
885 mutex_lock(&desc->wlock);
887 cancel_work_sync(&desc->rxwork);
891 static int wdm_post_reset(struct usb_interface *intf)
893 struct wdm_device *desc = usb_get_intfdata(intf);
896 clear_bit(WDM_RESETTING, &desc->flags);
897 rv = recover_from_urb_loss(desc);
898 mutex_unlock(&desc->wlock);
899 mutex_unlock(&desc->rlock);
903 static struct usb_driver wdm_driver = {
906 .disconnect = wdm_disconnect,
908 .suspend = wdm_suspend,
909 .resume = wdm_resume,
910 .reset_resume = wdm_resume,
912 .pre_reset = wdm_pre_reset,
913 .post_reset = wdm_post_reset,
915 .supports_autosuspend = 1,
918 module_usb_driver(wdm_driver);
920 MODULE_AUTHOR(DRIVER_AUTHOR);
921 MODULE_DESCRIPTION(DRIVER_DESC);
922 MODULE_LICENSE("GPL");