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 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
;
93 wait_queue_head_t wait
;
94 struct work_struct rxwork
;
99 static struct usb_driver wdm_driver
;
101 /* --- callbacks --- */
102 static void wdm_out_callback(struct urb
*urb
)
104 struct wdm_device
*desc
;
106 spin_lock(&desc
->iuspin
);
107 desc
->werr
= urb
->status
;
108 spin_unlock(&desc
->iuspin
);
109 clear_bit(WDM_IN_USE
, &desc
->flags
);
111 wake_up(&desc
->wait
);
114 static void wdm_in_callback(struct urb
*urb
)
116 struct wdm_device
*desc
= urb
->context
;
117 int status
= urb
->status
;
119 spin_lock(&desc
->iuspin
);
124 dev_dbg(&desc
->intf
->dev
,
125 "nonzero urb status received: -ENOENT");
128 dev_dbg(&desc
->intf
->dev
,
129 "nonzero urb status received: -ECONNRESET");
132 dev_dbg(&desc
->intf
->dev
,
133 "nonzero urb status received: -ESHUTDOWN");
136 dev_err(&desc
->intf
->dev
,
137 "nonzero urb status received: -EPIPE\n");
140 dev_err(&desc
->intf
->dev
,
141 "Unexpected error %d\n", status
);
147 desc
->reslength
= urb
->actual_length
;
148 memmove(desc
->ubuf
+ desc
->length
, desc
->inbuf
, desc
->reslength
);
149 desc
->length
+= desc
->reslength
;
150 wake_up(&desc
->wait
);
152 set_bit(WDM_READ
, &desc
->flags
);
153 spin_unlock(&desc
->iuspin
);
156 static void wdm_int_callback(struct urb
*urb
)
159 int status
= urb
->status
;
160 struct wdm_device
*desc
;
161 struct usb_ctrlrequest
*req
;
162 struct usb_cdc_notification
*dr
;
166 dr
= (struct usb_cdc_notification
*)desc
->sbuf
;
175 set_bit(WDM_INT_STALL
, &desc
->flags
);
176 dev_err(&desc
->intf
->dev
, "Stall on int endpoint\n");
177 goto sw
; /* halt is cleared in work */
179 dev_err(&desc
->intf
->dev
,
180 "nonzero urb status received: %d\n", status
);
185 if (urb
->actual_length
< sizeof(struct usb_cdc_notification
)) {
186 dev_err(&desc
->intf
->dev
, "wdm_int_callback - %d bytes\n",
191 switch (dr
->bNotificationType
) {
192 case USB_CDC_NOTIFY_RESPONSE_AVAILABLE
:
193 dev_dbg(&desc
->intf
->dev
,
194 "NOTIFY_RESPONSE_AVAILABLE received: index %d len %d",
195 dr
->wIndex
, dr
->wLength
);
198 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
200 dev_dbg(&desc
->intf
->dev
,
201 "NOTIFY_NETWORK_CONNECTION %s network",
202 dr
->wValue
? "connected to" : "disconnected from");
205 clear_bit(WDM_POLL_RUNNING
, &desc
->flags
);
206 dev_err(&desc
->intf
->dev
,
207 "unknown notification %d received: index %d len %d\n",
208 dr
->bNotificationType
, dr
->wIndex
, dr
->wLength
);
212 req
->bRequestType
= (USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
);
213 req
->bRequest
= USB_CDC_GET_ENCAPSULATED_RESPONSE
;
215 req
->wIndex
= desc
->inum
;
216 req
->wLength
= cpu_to_le16(desc
->wMaxCommand
);
218 usb_fill_control_urb(
220 interface_to_usbdev(desc
->intf
),
221 /* using common endpoint 0 */
222 usb_rcvctrlpipe(interface_to_usbdev(desc
->intf
), 0),
223 (unsigned char *)req
,
229 desc
->response
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
230 spin_lock(&desc
->iuspin
);
231 clear_bit(WDM_READ
, &desc
->flags
);
232 if (!test_bit(WDM_DISCONNECTING
, &desc
->flags
)) {
233 rv
= usb_submit_urb(desc
->response
, GFP_ATOMIC
);
234 dev_dbg(&desc
->intf
->dev
, "%s: usb_submit_urb %d",
237 spin_unlock(&desc
->iuspin
);
243 rv
= schedule_work(&desc
->rxwork
);
245 dev_err(&desc
->intf
->dev
,
246 "Cannot schedule work\n");
250 rv
= usb_submit_urb(urb
, GFP_ATOMIC
);
252 dev_err(&desc
->intf
->dev
,
253 "%s - usb_submit_urb failed with result %d\n",
258 static void kill_urbs(struct wdm_device
*desc
)
260 /* the order here is essential */
261 usb_kill_urb(desc
->command
);
262 usb_kill_urb(desc
->validity
);
263 usb_kill_urb(desc
->response
);
266 static void free_urbs(struct wdm_device
*desc
)
268 usb_free_urb(desc
->validity
);
269 usb_free_urb(desc
->response
);
270 usb_free_urb(desc
->command
);
273 static void cleanup(struct wdm_device
*desc
)
275 usb_buffer_free(interface_to_usbdev(desc
->intf
),
276 desc
->wMaxPacketSize
,
278 desc
->validity
->transfer_dma
);
279 usb_buffer_free(interface_to_usbdev(desc
->intf
),
280 desc
->bMaxPacketSize0
,
282 desc
->response
->transfer_dma
);
290 static ssize_t wdm_write
291 (struct file
*file
, const char __user
*buffer
, size_t count
, loff_t
*ppos
)
294 int rv
= -EMSGSIZE
, r
, we
;
295 struct wdm_device
*desc
= file
->private_data
;
296 struct usb_ctrlrequest
*req
;
298 if (count
> desc
->wMaxCommand
)
299 count
= desc
->wMaxCommand
;
301 spin_lock_irq(&desc
->iuspin
);
304 spin_unlock_irq(&desc
->iuspin
);
308 r
= mutex_lock_interruptible(&desc
->wlock
); /* concurrent writes */
313 r
= usb_autopm_get_interface(desc
->intf
);
317 if (!(file
->f_flags
& O_NONBLOCK
))
318 r
= wait_event_interruptible(desc
->wait
, !test_bit(WDM_IN_USE
,
321 if (test_bit(WDM_IN_USE
, &desc
->flags
))
326 if (test_bit(WDM_DISCONNECTING
, &desc
->flags
)) {
331 desc
->outbuf
= buf
= kmalloc(count
, GFP_KERNEL
);
337 r
= copy_from_user(buf
, buffer
, count
);
345 usb_fill_control_urb(
347 interface_to_usbdev(desc
->intf
),
348 /* using common endpoint 0 */
349 usb_sndctrlpipe(interface_to_usbdev(desc
->intf
), 0),
350 (unsigned char *)req
,
357 req
->bRequestType
= (USB_DIR_OUT
| USB_TYPE_CLASS
|
358 USB_RECIP_INTERFACE
);
359 req
->bRequest
= USB_CDC_SEND_ENCAPSULATED_COMMAND
;
361 req
->wIndex
= desc
->inum
;
362 req
->wLength
= cpu_to_le16(count
);
363 set_bit(WDM_IN_USE
, &desc
->flags
);
365 rv
= usb_submit_urb(desc
->command
, GFP_KERNEL
);
368 clear_bit(WDM_IN_USE
, &desc
->flags
);
369 dev_err(&desc
->intf
->dev
, "Tx URB error: %d\n", rv
);
371 dev_dbg(&desc
->intf
->dev
, "Tx URB has been submitted index=%d",
375 usb_autopm_put_interface(desc
->intf
);
377 mutex_unlock(&desc
->wlock
);
379 return rv
< 0 ? rv
: count
;
382 static ssize_t wdm_read
383 (struct file
*file
, char __user
*buffer
, size_t count
, loff_t
*ppos
)
387 struct wdm_device
*desc
= file
->private_data
;
390 rv
= mutex_lock_interruptible(&desc
->rlock
); /*concurrent reads */
394 if (desc
->length
== 0) {
397 if (test_bit(WDM_DISCONNECTING
, &desc
->flags
)) {
402 if (file
->f_flags
& O_NONBLOCK
) {
403 if (!test_bit(WDM_READ
, &desc
->flags
)) {
404 rv
= cntr
? cntr
: -EAGAIN
;
409 rv
= wait_event_interruptible(desc
->wait
,
410 test_bit(WDM_READ
, &desc
->flags
));
413 /* may have happened while we slept */
414 if (test_bit(WDM_DISCONNECTING
, &desc
->flags
)) {
418 usb_mark_last_busy(interface_to_usbdev(desc
->intf
));
424 spin_lock_irq(&desc
->iuspin
);
426 if (desc
->rerr
) { /* read completed, error happened */
429 spin_unlock_irq(&desc
->iuspin
);
430 dev_err(&desc
->intf
->dev
,
431 "reading had resulted in %d\n", t
);
436 * recheck whether we've lost the race
437 * against the completion handler
439 if (!test_bit(WDM_READ
, &desc
->flags
)) { /* lost race */
440 spin_unlock_irq(&desc
->iuspin
);
443 if (!desc
->reslength
) { /* zero length read */
444 dev_dbg(&desc
->intf
->dev
, "%s: zero length - clearing WDM_READ\n", __func__
);
445 clear_bit(WDM_READ
, &desc
->flags
);
446 spin_unlock_irq(&desc
->iuspin
);
449 clear_bit(WDM_READ
, &desc
->flags
);
450 spin_unlock_irq(&desc
->iuspin
);
453 cntr
= count
> desc
->length
? desc
->length
: count
;
454 rv
= copy_to_user(buffer
, desc
->ubuf
, cntr
);
460 for (i
= 0; i
< desc
->length
- cntr
; i
++)
461 desc
->ubuf
[i
] = desc
->ubuf
[i
+ cntr
];
463 spin_lock_irq(&desc
->iuspin
);
464 desc
->length
-= cntr
;
465 spin_unlock_irq(&desc
->iuspin
);
466 /* in case we had outstanding data */
468 clear_bit(WDM_READ
, &desc
->flags
);
472 mutex_unlock(&desc
->rlock
);
473 if (rv
< 0 && rv
!= -EAGAIN
)
474 dev_err(&desc
->intf
->dev
, "wdm_read: exit error\n");
478 static int wdm_flush(struct file
*file
, fl_owner_t id
)
480 struct wdm_device
*desc
= file
->private_data
;
482 wait_event(desc
->wait
, !test_bit(WDM_IN_USE
, &desc
->flags
));
484 dev_err(&desc
->intf
->dev
, "Error in flush path: %d\n",
490 static unsigned int wdm_poll(struct file
*file
, struct poll_table_struct
*wait
)
492 struct wdm_device
*desc
= file
->private_data
;
494 unsigned int mask
= 0;
496 spin_lock_irqsave(&desc
->iuspin
, flags
);
497 if (test_bit(WDM_DISCONNECTING
, &desc
->flags
)) {
499 spin_unlock_irqrestore(&desc
->iuspin
, flags
);
502 if (test_bit(WDM_READ
, &desc
->flags
))
503 mask
= POLLIN
| POLLRDNORM
;
504 if (desc
->rerr
|| desc
->werr
)
506 if (!test_bit(WDM_IN_USE
, &desc
->flags
))
507 mask
|= POLLOUT
| POLLWRNORM
;
508 spin_unlock_irqrestore(&desc
->iuspin
, flags
);
510 poll_wait(file
, &desc
->wait
, wait
);
516 static int wdm_open(struct inode
*inode
, struct file
*file
)
518 int minor
= iminor(inode
);
520 struct usb_interface
*intf
;
521 struct wdm_device
*desc
;
523 mutex_lock(&wdm_mutex
);
524 intf
= usb_find_interface(&wdm_driver
, minor
);
528 desc
= usb_get_intfdata(intf
);
529 if (test_bit(WDM_DISCONNECTING
, &desc
->flags
))
531 file
->private_data
= desc
;
533 rv
= usb_autopm_get_interface(desc
->intf
);
535 dev_err(&desc
->intf
->dev
, "Error autopm - %d\n", rv
);
538 intf
->needs_remote_wakeup
= 1;
540 mutex_lock(&desc
->plock
);
541 if (!desc
->count
++) {
542 rv
= usb_submit_urb(desc
->validity
, GFP_KERNEL
);
545 dev_err(&desc
->intf
->dev
,
546 "Error submitting int urb - %d\n", rv
);
551 mutex_unlock(&desc
->plock
);
552 usb_autopm_put_interface(desc
->intf
);
554 mutex_unlock(&wdm_mutex
);
558 static int wdm_release(struct inode
*inode
, struct file
*file
)
560 struct wdm_device
*desc
= file
->private_data
;
562 mutex_lock(&wdm_mutex
);
563 mutex_lock(&desc
->plock
);
565 mutex_unlock(&desc
->plock
);
568 dev_dbg(&desc
->intf
->dev
, "wdm_release: cleanup");
570 if (!test_bit(WDM_DISCONNECTING
, &desc
->flags
))
571 desc
->intf
->needs_remote_wakeup
= 0;
573 mutex_unlock(&wdm_mutex
);
577 static const struct file_operations wdm_fops
= {
578 .owner
= THIS_MODULE
,
583 .release
= wdm_release
,
587 static struct usb_class_driver wdm_class
= {
590 .minor_base
= WDM_MINOR_BASE
,
593 /* --- error handling --- */
594 static void wdm_rxwork(struct work_struct
*work
)
596 struct wdm_device
*desc
= container_of(work
, struct wdm_device
, rxwork
);
600 spin_lock_irqsave(&desc
->iuspin
, flags
);
601 if (test_bit(WDM_DISCONNECTING
, &desc
->flags
)) {
602 spin_unlock_irqrestore(&desc
->iuspin
, flags
);
604 spin_unlock_irqrestore(&desc
->iuspin
, flags
);
605 rv
= usb_submit_urb(desc
->response
, GFP_KERNEL
);
606 if (rv
< 0 && rv
!= -EPERM
) {
607 spin_lock_irqsave(&desc
->iuspin
, flags
);
608 if (!test_bit(WDM_DISCONNECTING
, &desc
->flags
))
609 schedule_work(&desc
->rxwork
);
610 spin_unlock_irqrestore(&desc
->iuspin
, flags
);
615 /* --- hotplug --- */
617 static int wdm_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
620 struct usb_device
*udev
= interface_to_usbdev(intf
);
621 struct wdm_device
*desc
;
622 struct usb_host_interface
*iface
;
623 struct usb_endpoint_descriptor
*ep
;
624 struct usb_cdc_dmm_desc
*dmhd
;
625 u8
*buffer
= intf
->altsetting
->extra
;
626 int buflen
= intf
->altsetting
->extralen
;
633 if (buffer
[1] != USB_DT_CS_INTERFACE
) {
634 dev_err(&intf
->dev
, "skipping garbage\n");
638 switch (buffer
[2]) {
639 case USB_CDC_HEADER_TYPE
:
641 case USB_CDC_DMM_TYPE
:
642 dmhd
= (struct usb_cdc_dmm_desc
*)buffer
;
643 maxcom
= le16_to_cpu(dmhd
->wMaxCommand
);
645 "Finding maximum buffer length: %d", maxcom
);
649 "Ignoring extra header, type %d, length %d\n",
650 buffer
[2], buffer
[0]);
659 desc
= kzalloc(sizeof(struct wdm_device
), GFP_KERNEL
);
662 mutex_init(&desc
->wlock
);
663 mutex_init(&desc
->rlock
);
664 mutex_init(&desc
->plock
);
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
);
780 wake_up_all(&desc
->wait
);
783 mutex_unlock(&wdm_mutex
);
786 static int wdm_suspend(struct usb_interface
*intf
, pm_message_t message
)
788 struct wdm_device
*desc
= usb_get_intfdata(intf
);
791 dev_dbg(&desc
->intf
->dev
, "wdm%d_suspend\n", intf
->minor
);
793 mutex_lock(&desc
->plock
);
795 if ((message
.event
& PM_EVENT_AUTO
) &&
796 test_bit(WDM_IN_USE
, &desc
->flags
)) {
800 cancel_work_sync(&desc
->rxwork
);
805 mutex_unlock(&desc
->plock
);
810 static int recover_from_urb_loss(struct wdm_device
*desc
)
815 rv
= usb_submit_urb(desc
->validity
, GFP_NOIO
);
817 dev_err(&desc
->intf
->dev
,
818 "Error resume submitting int urb - %d\n", rv
);
822 static int wdm_resume(struct usb_interface
*intf
)
824 struct wdm_device
*desc
= usb_get_intfdata(intf
);
827 dev_dbg(&desc
->intf
->dev
, "wdm%d_resume\n", intf
->minor
);
828 mutex_lock(&desc
->plock
);
829 rv
= recover_from_urb_loss(desc
);
830 mutex_unlock(&desc
->plock
);
834 static int wdm_pre_reset(struct usb_interface
*intf
)
836 struct wdm_device
*desc
= usb_get_intfdata(intf
);
838 mutex_lock(&desc
->plock
);
842 static int wdm_post_reset(struct usb_interface
*intf
)
844 struct wdm_device
*desc
= usb_get_intfdata(intf
);
847 rv
= recover_from_urb_loss(desc
);
848 mutex_unlock(&desc
->plock
);
852 static struct usb_driver wdm_driver
= {
855 .disconnect
= wdm_disconnect
,
856 .suspend
= wdm_suspend
,
857 .resume
= wdm_resume
,
858 .reset_resume
= wdm_resume
,
859 .pre_reset
= wdm_pre_reset
,
860 .post_reset
= wdm_post_reset
,
862 .supports_autosuspend
= 1,
865 /* --- low level module stuff --- */
867 static int __init
wdm_init(void)
871 rv
= usb_register(&wdm_driver
);
876 static void __exit
wdm_exit(void)
878 usb_deregister(&wdm_driver
);
881 module_init(wdm_init
);
882 module_exit(wdm_exit
);
884 MODULE_AUTHOR(DRIVER_AUTHOR
);
885 MODULE_DESCRIPTION(DRIVER_DESC
);
886 MODULE_LICENSE("GPL");