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
),
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
);
316 r
= wait_event_interruptible(desc
->wait
, !test_bit(WDM_IN_USE
,
321 if (test_bit(WDM_DISCONNECTING
, &desc
->flags
)) {
326 desc
->outbuf
= buf
= kmalloc(count
, GFP_KERNEL
);
332 r
= copy_from_user(buf
, buffer
, count
);
340 usb_fill_control_urb(
342 interface_to_usbdev(desc
->intf
),
343 /* using common endpoint 0 */
344 usb_sndctrlpipe(interface_to_usbdev(desc
->intf
), 0),
345 (unsigned char *)req
,
352 req
->bRequestType
= (USB_DIR_OUT
| USB_TYPE_CLASS
|
353 USB_RECIP_INTERFACE
);
354 req
->bRequest
= USB_CDC_SEND_ENCAPSULATED_COMMAND
;
356 req
->wIndex
= desc
->inum
;
357 req
->wLength
= cpu_to_le16(count
);
358 set_bit(WDM_IN_USE
, &desc
->flags
);
360 rv
= usb_submit_urb(desc
->command
, GFP_KERNEL
);
363 clear_bit(WDM_IN_USE
, &desc
->flags
);
364 dev_err(&desc
->intf
->dev
, "Tx URB error: %d\n", rv
);
366 dev_dbg(&desc
->intf
->dev
, "Tx URB has been submitted index=%d",
370 usb_autopm_put_interface(desc
->intf
);
372 mutex_unlock(&desc
->wlock
);
374 return rv
< 0 ? rv
: count
;
377 static ssize_t wdm_read
378 (struct file
*file
, char __user
*buffer
, size_t count
, loff_t
*ppos
)
382 struct wdm_device
*desc
= file
->private_data
;
385 rv
= mutex_lock_interruptible(&desc
->rlock
); /*concurrent reads */
389 if (desc
->length
== 0) {
393 rv
= wait_event_interruptible(desc
->wait
,
394 test_bit(WDM_READ
, &desc
->flags
));
396 if (test_bit(WDM_DISCONNECTING
, &desc
->flags
)) {
400 usb_mark_last_busy(interface_to_usbdev(desc
->intf
));
406 spin_lock_irq(&desc
->iuspin
);
408 if (desc
->rerr
) { /* read completed, error happened */
411 spin_unlock_irq(&desc
->iuspin
);
412 dev_err(&desc
->intf
->dev
,
413 "reading had resulted in %d\n", t
);
418 * recheck whether we've lost the race
419 * against the completion handler
421 if (!test_bit(WDM_READ
, &desc
->flags
)) { /* lost race */
422 spin_unlock_irq(&desc
->iuspin
);
425 if (!desc
->reslength
) { /* zero length read */
426 spin_unlock_irq(&desc
->iuspin
);
429 clear_bit(WDM_READ
, &desc
->flags
);
430 spin_unlock_irq(&desc
->iuspin
);
433 cntr
= count
> desc
->length
? desc
->length
: count
;
434 rv
= copy_to_user(buffer
, desc
->ubuf
, cntr
);
440 for (i
= 0; i
< desc
->length
- cntr
; i
++)
441 desc
->ubuf
[i
] = desc
->ubuf
[i
+ cntr
];
443 desc
->length
-= cntr
;
444 /* in case we had outstanding data */
446 clear_bit(WDM_READ
, &desc
->flags
);
450 mutex_unlock(&desc
->rlock
);
452 dev_err(&desc
->intf
->dev
, "wdm_read: exit error\n");
456 static int wdm_flush(struct file
*file
, fl_owner_t id
)
458 struct wdm_device
*desc
= file
->private_data
;
460 wait_event(desc
->wait
, !test_bit(WDM_IN_USE
, &desc
->flags
));
462 dev_err(&desc
->intf
->dev
, "Error in flush path: %d\n",
468 static unsigned int wdm_poll(struct file
*file
, struct poll_table_struct
*wait
)
470 struct wdm_device
*desc
= file
->private_data
;
472 unsigned int mask
= 0;
474 spin_lock_irqsave(&desc
->iuspin
, flags
);
475 if (test_bit(WDM_DISCONNECTING
, &desc
->flags
)) {
477 spin_unlock_irqrestore(&desc
->iuspin
, flags
);
480 if (test_bit(WDM_READ
, &desc
->flags
))
481 mask
= POLLIN
| POLLRDNORM
;
482 if (desc
->rerr
|| desc
->werr
)
484 if (!test_bit(WDM_IN_USE
, &desc
->flags
))
485 mask
|= POLLOUT
| POLLWRNORM
;
486 spin_unlock_irqrestore(&desc
->iuspin
, flags
);
488 poll_wait(file
, &desc
->wait
, wait
);
494 static int wdm_open(struct inode
*inode
, struct file
*file
)
496 int minor
= iminor(inode
);
498 struct usb_interface
*intf
;
499 struct wdm_device
*desc
;
501 mutex_lock(&wdm_mutex
);
502 intf
= usb_find_interface(&wdm_driver
, minor
);
506 desc
= usb_get_intfdata(intf
);
507 if (test_bit(WDM_DISCONNECTING
, &desc
->flags
))
509 file
->private_data
= desc
;
511 rv
= usb_autopm_get_interface(desc
->intf
);
513 dev_err(&desc
->intf
->dev
, "Error autopm - %d\n", rv
);
516 intf
->needs_remote_wakeup
= 1;
518 mutex_lock(&desc
->plock
);
519 if (!desc
->count
++) {
520 rv
= usb_submit_urb(desc
->validity
, GFP_KERNEL
);
523 dev_err(&desc
->intf
->dev
,
524 "Error submitting int urb - %d\n", rv
);
529 mutex_unlock(&desc
->plock
);
530 usb_autopm_put_interface(desc
->intf
);
532 mutex_unlock(&wdm_mutex
);
536 static int wdm_release(struct inode
*inode
, struct file
*file
)
538 struct wdm_device
*desc
= file
->private_data
;
540 mutex_lock(&wdm_mutex
);
541 mutex_lock(&desc
->plock
);
543 mutex_unlock(&desc
->plock
);
546 dev_dbg(&desc
->intf
->dev
, "wdm_release: cleanup");
548 if (!test_bit(WDM_DISCONNECTING
, &desc
->flags
))
549 desc
->intf
->needs_remote_wakeup
= 0;
551 mutex_unlock(&wdm_mutex
);
555 static const struct file_operations wdm_fops
= {
556 .owner
= THIS_MODULE
,
561 .release
= wdm_release
,
565 static struct usb_class_driver wdm_class
= {
568 .minor_base
= WDM_MINOR_BASE
,
571 /* --- error handling --- */
572 static void wdm_rxwork(struct work_struct
*work
)
574 struct wdm_device
*desc
= container_of(work
, struct wdm_device
, rxwork
);
578 spin_lock_irqsave(&desc
->iuspin
, flags
);
579 if (test_bit(WDM_DISCONNECTING
, &desc
->flags
)) {
580 spin_unlock_irqrestore(&desc
->iuspin
, flags
);
582 spin_unlock_irqrestore(&desc
->iuspin
, flags
);
583 rv
= usb_submit_urb(desc
->response
, GFP_KERNEL
);
584 if (rv
< 0 && rv
!= -EPERM
) {
585 spin_lock_irqsave(&desc
->iuspin
, flags
);
586 if (!test_bit(WDM_DISCONNECTING
, &desc
->flags
))
587 schedule_work(&desc
->rxwork
);
588 spin_unlock_irqrestore(&desc
->iuspin
, flags
);
593 /* --- hotplug --- */
595 static int wdm_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
598 struct usb_device
*udev
= interface_to_usbdev(intf
);
599 struct wdm_device
*desc
;
600 struct usb_host_interface
*iface
;
601 struct usb_endpoint_descriptor
*ep
;
602 struct usb_cdc_dmm_desc
*dmhd
;
603 u8
*buffer
= intf
->altsetting
->extra
;
604 int buflen
= intf
->altsetting
->extralen
;
611 if (buffer
[1] != USB_DT_CS_INTERFACE
) {
612 dev_err(&intf
->dev
, "skipping garbage\n");
616 switch (buffer
[2]) {
617 case USB_CDC_HEADER_TYPE
:
619 case USB_CDC_DMM_TYPE
:
620 dmhd
= (struct usb_cdc_dmm_desc
*)buffer
;
621 maxcom
= le16_to_cpu(dmhd
->wMaxCommand
);
623 "Finding maximum buffer length: %d", maxcom
);
627 "Ignoring extra header, type %d, length %d\n",
628 buffer
[2], buffer
[0]);
637 desc
= kzalloc(sizeof(struct wdm_device
), GFP_KERNEL
);
640 mutex_init(&desc
->wlock
);
641 mutex_init(&desc
->rlock
);
642 mutex_init(&desc
->plock
);
643 spin_lock_init(&desc
->iuspin
);
644 init_waitqueue_head(&desc
->wait
);
645 desc
->wMaxCommand
= maxcom
;
646 /* this will be expanded and needed in hardware endianness */
647 desc
->inum
= cpu_to_le16((u16
)intf
->cur_altsetting
->desc
.bInterfaceNumber
);
649 INIT_WORK(&desc
->rxwork
, wdm_rxwork
);
652 iface
= intf
->cur_altsetting
;
653 if (iface
->desc
.bNumEndpoints
!= 1)
655 ep
= &iface
->endpoint
[0].desc
;
656 if (!ep
|| !usb_endpoint_is_int_in(ep
))
659 desc
->wMaxPacketSize
= le16_to_cpu(ep
->wMaxPacketSize
);
660 desc
->bMaxPacketSize0
= udev
->descriptor
.bMaxPacketSize0
;
662 desc
->orq
= kmalloc(sizeof(struct usb_ctrlrequest
), GFP_KERNEL
);
665 desc
->irq
= kmalloc(sizeof(struct usb_ctrlrequest
), GFP_KERNEL
);
669 desc
->validity
= usb_alloc_urb(0, GFP_KERNEL
);
673 desc
->response
= usb_alloc_urb(0, GFP_KERNEL
);
677 desc
->command
= usb_alloc_urb(0, GFP_KERNEL
);
681 desc
->ubuf
= kmalloc(desc
->wMaxCommand
, GFP_KERNEL
);
685 desc
->sbuf
= usb_buffer_alloc(interface_to_usbdev(intf
),
686 desc
->wMaxPacketSize
,
688 &desc
->validity
->transfer_dma
);
692 desc
->inbuf
= usb_buffer_alloc(interface_to_usbdev(intf
),
693 desc
->bMaxPacketSize0
,
695 &desc
->response
->transfer_dma
);
701 interface_to_usbdev(intf
),
702 usb_rcvintpipe(interface_to_usbdev(intf
), ep
->bEndpointAddress
),
704 desc
->wMaxPacketSize
,
709 desc
->validity
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
711 usb_set_intfdata(intf
, desc
);
712 rv
= usb_register_dev(intf
, &wdm_class
);
716 dev_info(&intf
->dev
, "cdc-wdm%d: USB WDM device\n",
717 intf
->minor
- WDM_MINOR_BASE
);
721 usb_set_intfdata(intf
, NULL
);
722 usb_buffer_free(interface_to_usbdev(desc
->intf
),
723 desc
->bMaxPacketSize0
,
725 desc
->response
->transfer_dma
);
727 usb_buffer_free(interface_to_usbdev(desc
->intf
),
728 desc
->wMaxPacketSize
,
730 desc
->validity
->transfer_dma
);
740 static void wdm_disconnect(struct usb_interface
*intf
)
742 struct wdm_device
*desc
;
745 usb_deregister_dev(intf
, &wdm_class
);
746 mutex_lock(&wdm_mutex
);
747 desc
= usb_get_intfdata(intf
);
749 /* the spinlock makes sure no new urbs are generated in the callbacks */
750 spin_lock_irqsave(&desc
->iuspin
, flags
);
751 set_bit(WDM_DISCONNECTING
, &desc
->flags
);
752 set_bit(WDM_READ
, &desc
->flags
);
753 /* to terminate pending flushes */
754 clear_bit(WDM_IN_USE
, &desc
->flags
);
755 spin_unlock_irqrestore(&desc
->iuspin
, flags
);
756 cancel_work_sync(&desc
->rxwork
);
758 wake_up_all(&desc
->wait
);
761 mutex_unlock(&wdm_mutex
);
764 static int wdm_suspend(struct usb_interface
*intf
, pm_message_t message
)
766 struct wdm_device
*desc
= usb_get_intfdata(intf
);
769 dev_dbg(&desc
->intf
->dev
, "wdm%d_suspend\n", intf
->minor
);
771 mutex_lock(&desc
->plock
);
773 if ((message
.event
& PM_EVENT_AUTO
) &&
774 test_bit(WDM_IN_USE
, &desc
->flags
)) {
778 cancel_work_sync(&desc
->rxwork
);
783 mutex_unlock(&desc
->plock
);
788 static int recover_from_urb_loss(struct wdm_device
*desc
)
793 rv
= usb_submit_urb(desc
->validity
, GFP_NOIO
);
795 dev_err(&desc
->intf
->dev
,
796 "Error resume submitting int urb - %d\n", rv
);
800 static int wdm_resume(struct usb_interface
*intf
)
802 struct wdm_device
*desc
= usb_get_intfdata(intf
);
805 dev_dbg(&desc
->intf
->dev
, "wdm%d_resume\n", intf
->minor
);
806 mutex_lock(&desc
->plock
);
807 rv
= recover_from_urb_loss(desc
);
808 mutex_unlock(&desc
->plock
);
812 static int wdm_pre_reset(struct usb_interface
*intf
)
814 struct wdm_device
*desc
= usb_get_intfdata(intf
);
816 mutex_lock(&desc
->plock
);
820 static int wdm_post_reset(struct usb_interface
*intf
)
822 struct wdm_device
*desc
= usb_get_intfdata(intf
);
825 rv
= recover_from_urb_loss(desc
);
826 mutex_unlock(&desc
->plock
);
830 static struct usb_driver wdm_driver
= {
833 .disconnect
= wdm_disconnect
,
834 .suspend
= wdm_suspend
,
835 .resume
= wdm_resume
,
836 .reset_resume
= wdm_resume
,
837 .pre_reset
= wdm_pre_reset
,
838 .post_reset
= wdm_post_reset
,
840 .supports_autosuspend
= 1,
843 /* --- low level module stuff --- */
845 static int __init
wdm_init(void)
849 rv
= usb_register(&wdm_driver
);
854 static void __exit
wdm_exit(void)
856 usb_deregister(&wdm_driver
);
859 module_init(wdm_init
);
860 module_exit(wdm_exit
);
862 MODULE_AUTHOR(DRIVER_AUTHOR
);
863 MODULE_DESCRIPTION(DRIVER_DESC
);
864 MODULE_LICENSE("GPL");