Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * cdc-wdm.c
4 *
5 * This driver supports USB CDC WCM Device Management.
6 *
7 * Copyright (c) 2007-2009 Oliver Neukum
8 *
9 * Some code taken from cdc-acm.c
10 *
11 * Released under the GPLv2.
12 *
13 * Many thanks to Carl Nordbeck
14 */
15#include <linux/kernel.h>
16#include <linux/errno.h>
17#include <linux/ioctl.h>
18#include <linux/slab.h>
19#include <linux/module.h>
20#include <linux/mutex.h>
21#include <linux/uaccess.h>
22#include <linux/bitops.h>
23#include <linux/poll.h>
24#include <linux/usb.h>
25#include <linux/usb/cdc.h>
26#include <asm/byteorder.h>
27#include <asm/unaligned.h>
28#include <linux/usb/cdc-wdm.h>
29
30#define DRIVER_AUTHOR "Oliver Neukum"
31#define DRIVER_DESC "USB Abstract Control Model driver for USB WCM Device Management"
32
33static const struct usb_device_id wdm_ids[] = {
34 {
35 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
36 USB_DEVICE_ID_MATCH_INT_SUBCLASS,
37 .bInterfaceClass = USB_CLASS_COMM,
38 .bInterfaceSubClass = USB_CDC_SUBCLASS_DMM
39 },
40 { }
41};
42
43MODULE_DEVICE_TABLE (usb, wdm_ids);
44
45#define WDM_MINOR_BASE 176
46
47
48#define WDM_IN_USE 1
49#define WDM_DISCONNECTING 2
50#define WDM_RESULT 3
51#define WDM_READ 4
52#define WDM_INT_STALL 5
53#define WDM_POLL_RUNNING 6
54#define WDM_RESPONDING 7
55#define WDM_SUSPENDING 8
56#define WDM_RESETTING 9
57#define WDM_OVERFLOW 10
58
59#define WDM_MAX 16
60
61/* CDC-WMC r1.1 requires wMaxCommand to be "at least 256 decimal (0x100)" */
62#define WDM_DEFAULT_BUFSIZE 256
63
64static DEFINE_MUTEX(wdm_mutex);
65static DEFINE_SPINLOCK(wdm_device_list_lock);
66static LIST_HEAD(wdm_device_list);
67
68/* --- method tables --- */
69
70struct wdm_device {
71 u8 *inbuf; /* buffer for response */
72 u8 *outbuf; /* buffer for command */
73 u8 *sbuf; /* buffer for status */
74 u8 *ubuf; /* buffer for copy to user space */
75
76 struct urb *command;
77 struct urb *response;
78 struct urb *validity;
79 struct usb_interface *intf;
80 struct usb_ctrlrequest *orq;
81 struct usb_ctrlrequest *irq;
82 spinlock_t iuspin;
83
84 unsigned long flags;
85 u16 bufsize;
86 u16 wMaxCommand;
87 u16 wMaxPacketSize;
88 __le16 inum;
89 int reslength;
90 int length;
91 int read;
92 int count;
93 dma_addr_t shandle;
94 dma_addr_t ihandle;
95 struct mutex wlock;
96 struct mutex rlock;
97 wait_queue_head_t wait;
98 struct work_struct rxwork;
99 struct work_struct service_outs_intr;
100 int werr;
101 int rerr;
102 int resp_count;
103
104 struct list_head device_list;
105 int (*manage_power)(struct usb_interface *, int);
106};
107
108static struct usb_driver wdm_driver;
109
110/* return intfdata if we own the interface, else look up intf in the list */
111static struct wdm_device *wdm_find_device(struct usb_interface *intf)
112{
113 struct wdm_device *desc;
114
115 spin_lock(&wdm_device_list_lock);
116 list_for_each_entry(desc, &wdm_device_list, device_list)
117 if (desc->intf == intf)
118 goto found;
119 desc = NULL;
120found:
121 spin_unlock(&wdm_device_list_lock);
122
123 return desc;
124}
125
126static struct wdm_device *wdm_find_device_by_minor(int minor)
127{
128 struct wdm_device *desc;
129
130 spin_lock(&wdm_device_list_lock);
131 list_for_each_entry(desc, &wdm_device_list, device_list)
132 if (desc->intf->minor == minor)
133 goto found;
134 desc = NULL;
135found:
136 spin_unlock(&wdm_device_list_lock);
137
138 return desc;
139}
140
141/* --- callbacks --- */
142static void wdm_out_callback(struct urb *urb)
143{
144 struct wdm_device *desc;
145 unsigned long flags;
146
147 desc = urb->context;
148 spin_lock_irqsave(&desc->iuspin, flags);
149 desc->werr = urb->status;
150 spin_unlock_irqrestore(&desc->iuspin, flags);
151 kfree(desc->outbuf);
152 desc->outbuf = NULL;
153 clear_bit(WDM_IN_USE, &desc->flags);
154 wake_up(&desc->wait);
155}
156
157static void wdm_in_callback(struct urb *urb)
158{
159 unsigned long flags;
160 struct wdm_device *desc = urb->context;
161 int status = urb->status;
162 int length = urb->actual_length;
163
164 spin_lock_irqsave(&desc->iuspin, flags);
165 clear_bit(WDM_RESPONDING, &desc->flags);
166
167 if (status) {
168 switch (status) {
169 case -ENOENT:
170 dev_dbg(&desc->intf->dev,
171 "nonzero urb status received: -ENOENT\n");
172 goto skip_error;
173 case -ECONNRESET:
174 dev_dbg(&desc->intf->dev,
175 "nonzero urb status received: -ECONNRESET\n");
176 goto skip_error;
177 case -ESHUTDOWN:
178 dev_dbg(&desc->intf->dev,
179 "nonzero urb status received: -ESHUTDOWN\n");
180 goto skip_error;
181 case -EPIPE:
182 dev_err(&desc->intf->dev,
183 "nonzero urb status received: -EPIPE\n");
184 break;
185 default:
186 dev_err(&desc->intf->dev,
187 "Unexpected error %d\n", status);
188 break;
189 }
190 }
191
192 /*
193 * only set a new error if there is no previous error.
194 * Errors are only cleared during read/open
195 * Avoid propagating -EPIPE (stall) to userspace since it is
196 * better handled as an empty read
197 */
198 if (desc->rerr == 0 && status != -EPIPE)
199 desc->rerr = status;
200
201 if (length + desc->length > desc->wMaxCommand) {
202 /* The buffer would overflow */
203 set_bit(WDM_OVERFLOW, &desc->flags);
204 } else {
205 /* we may already be in overflow */
206 if (!test_bit(WDM_OVERFLOW, &desc->flags)) {
207 memmove(desc->ubuf + desc->length, desc->inbuf, length);
208 desc->length += length;
209 desc->reslength = length;
210 }
211 }
212skip_error:
213
214 if (desc->rerr) {
215 /*
216 * Since there was an error, userspace may decide to not read
217 * any data after poll'ing.
218 * We should respond to further attempts from the device to send
219 * data, so that we can get unstuck.
220 */
221 schedule_work(&desc->service_outs_intr);
222 } else {
223 set_bit(WDM_READ, &desc->flags);
224 wake_up(&desc->wait);
225 }
226 spin_unlock_irqrestore(&desc->iuspin, flags);
227}
228
229static void wdm_int_callback(struct urb *urb)
230{
231 unsigned long flags;
232 int rv = 0;
233 int responding;
234 int status = urb->status;
235 struct wdm_device *desc;
236 struct usb_cdc_notification *dr;
237
238 desc = urb->context;
239 dr = (struct usb_cdc_notification *)desc->sbuf;
240
241 if (status) {
242 switch (status) {
243 case -ESHUTDOWN:
244 case -ENOENT:
245 case -ECONNRESET:
246 return; /* unplug */
247 case -EPIPE:
248 set_bit(WDM_INT_STALL, &desc->flags);
249 dev_err(&desc->intf->dev, "Stall on int endpoint\n");
250 goto sw; /* halt is cleared in work */
251 default:
252 dev_err(&desc->intf->dev,
253 "nonzero urb status received: %d\n", status);
254 break;
255 }
256 }
257
258 if (urb->actual_length < sizeof(struct usb_cdc_notification)) {
259 dev_err(&desc->intf->dev, "wdm_int_callback - %d bytes\n",
260 urb->actual_length);
261 goto exit;
262 }
263
264 switch (dr->bNotificationType) {
265 case USB_CDC_NOTIFY_RESPONSE_AVAILABLE:
266 dev_dbg(&desc->intf->dev,
267 "NOTIFY_RESPONSE_AVAILABLE received: index %d len %d\n",
268 le16_to_cpu(dr->wIndex), le16_to_cpu(dr->wLength));
269 break;
270
271 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
272
273 dev_dbg(&desc->intf->dev,
274 "NOTIFY_NETWORK_CONNECTION %s network\n",
275 dr->wValue ? "connected to" : "disconnected from");
276 goto exit;
277 case USB_CDC_NOTIFY_SPEED_CHANGE:
278 dev_dbg(&desc->intf->dev, "SPEED_CHANGE received (len %u)\n",
279 urb->actual_length);
280 goto exit;
281 default:
282 clear_bit(WDM_POLL_RUNNING, &desc->flags);
283 dev_err(&desc->intf->dev,
284 "unknown notification %d received: index %d len %d\n",
285 dr->bNotificationType,
286 le16_to_cpu(dr->wIndex),
287 le16_to_cpu(dr->wLength));
288 goto exit;
289 }
290
291 spin_lock_irqsave(&desc->iuspin, flags);
292 responding = test_and_set_bit(WDM_RESPONDING, &desc->flags);
293 if (!desc->resp_count++ && !responding
294 && !test_bit(WDM_DISCONNECTING, &desc->flags)
295 && !test_bit(WDM_SUSPENDING, &desc->flags)) {
296 rv = usb_submit_urb(desc->response, GFP_ATOMIC);
297 dev_dbg(&desc->intf->dev, "submit response URB %d\n", rv);
298 }
299 spin_unlock_irqrestore(&desc->iuspin, flags);
300 if (rv < 0) {
301 clear_bit(WDM_RESPONDING, &desc->flags);
302 if (rv == -EPERM)
303 return;
304 if (rv == -ENOMEM) {
305sw:
306 rv = schedule_work(&desc->rxwork);
307 if (rv)
308 dev_err(&desc->intf->dev,
309 "Cannot schedule work\n");
310 }
311 }
312exit:
313 rv = usb_submit_urb(urb, GFP_ATOMIC);
314 if (rv)
315 dev_err(&desc->intf->dev,
316 "%s - usb_submit_urb failed with result %d\n",
317 __func__, rv);
318
319}
320
321static void kill_urbs(struct wdm_device *desc)
322{
323 /* the order here is essential */
324 usb_kill_urb(desc->command);
325 usb_kill_urb(desc->validity);
326 usb_kill_urb(desc->response);
327}
328
329static void free_urbs(struct wdm_device *desc)
330{
331 usb_free_urb(desc->validity);
332 usb_free_urb(desc->response);
333 usb_free_urb(desc->command);
334}
335
336static void cleanup(struct wdm_device *desc)
337{
338 kfree(desc->sbuf);
339 kfree(desc->inbuf);
340 kfree(desc->orq);
341 kfree(desc->irq);
342 kfree(desc->ubuf);
343 free_urbs(desc);
344 kfree(desc);
345}
346
347static ssize_t wdm_write
348(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
349{
350 u8 *buf;
351 int rv = -EMSGSIZE, r, we;
352 struct wdm_device *desc = file->private_data;
353 struct usb_ctrlrequest *req;
354
355 if (count > desc->wMaxCommand)
356 count = desc->wMaxCommand;
357
358 spin_lock_irq(&desc->iuspin);
359 we = desc->werr;
360 desc->werr = 0;
361 spin_unlock_irq(&desc->iuspin);
362 if (we < 0)
363 return usb_translate_errors(we);
364
365 buf = memdup_user(buffer, count);
366 if (IS_ERR(buf))
367 return PTR_ERR(buf);
368
369 /* concurrent writes and disconnect */
370 r = mutex_lock_interruptible(&desc->wlock);
371 rv = -ERESTARTSYS;
372 if (r)
373 goto out_free_mem;
374
375 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
376 rv = -ENODEV;
377 goto out_free_mem_lock;
378 }
379
380 r = usb_autopm_get_interface(desc->intf);
381 if (r < 0) {
382 rv = usb_translate_errors(r);
383 goto out_free_mem_lock;
384 }
385
386 if (!(file->f_flags & O_NONBLOCK))
387 r = wait_event_interruptible(desc->wait, !test_bit(WDM_IN_USE,
388 &desc->flags));
389 else
390 if (test_bit(WDM_IN_USE, &desc->flags))
391 r = -EAGAIN;
392
393 if (test_bit(WDM_RESETTING, &desc->flags))
394 r = -EIO;
395
396 if (r < 0) {
397 rv = r;
398 goto out_free_mem_pm;
399 }
400
401 req = desc->orq;
402 usb_fill_control_urb(
403 desc->command,
404 interface_to_usbdev(desc->intf),
405 /* using common endpoint 0 */
406 usb_sndctrlpipe(interface_to_usbdev(desc->intf), 0),
407 (unsigned char *)req,
408 buf,
409 count,
410 wdm_out_callback,
411 desc
412 );
413
414 req->bRequestType = (USB_DIR_OUT | USB_TYPE_CLASS |
415 USB_RECIP_INTERFACE);
416 req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
417 req->wValue = 0;
418 req->wIndex = desc->inum; /* already converted */
419 req->wLength = cpu_to_le16(count);
420 set_bit(WDM_IN_USE, &desc->flags);
421 desc->outbuf = buf;
422
423 rv = usb_submit_urb(desc->command, GFP_KERNEL);
424 if (rv < 0) {
425 desc->outbuf = NULL;
426 clear_bit(WDM_IN_USE, &desc->flags);
427 dev_err(&desc->intf->dev, "Tx URB error: %d\n", rv);
428 rv = usb_translate_errors(rv);
429 goto out_free_mem_pm;
430 } else {
431 dev_dbg(&desc->intf->dev, "Tx URB has been submitted index=%d\n",
432 le16_to_cpu(req->wIndex));
433 }
434
435 usb_autopm_put_interface(desc->intf);
436 mutex_unlock(&desc->wlock);
437 return count;
438
439out_free_mem_pm:
440 usb_autopm_put_interface(desc->intf);
441out_free_mem_lock:
442 mutex_unlock(&desc->wlock);
443out_free_mem:
444 kfree(buf);
445 return rv;
446}
447
448/*
449 * Submit the read urb if resp_count is non-zero.
450 *
451 * Called with desc->iuspin locked
452 */
453static int service_outstanding_interrupt(struct wdm_device *desc)
454{
455 int rv = 0;
456
457 /* submit read urb only if the device is waiting for it */
458 if (!desc->resp_count || !--desc->resp_count)
459 goto out;
460
461 set_bit(WDM_RESPONDING, &desc->flags);
462 spin_unlock_irq(&desc->iuspin);
463 rv = usb_submit_urb(desc->response, GFP_KERNEL);
464 spin_lock_irq(&desc->iuspin);
465 if (rv) {
466 dev_err(&desc->intf->dev,
467 "usb_submit_urb failed with result %d\n", rv);
468
469 /* make sure the next notification trigger a submit */
470 clear_bit(WDM_RESPONDING, &desc->flags);
471 desc->resp_count = 0;
472 }
473out:
474 return rv;
475}
476
477static ssize_t wdm_read
478(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
479{
480 int rv, cntr;
481 int i = 0;
482 struct wdm_device *desc = file->private_data;
483
484
485 rv = mutex_lock_interruptible(&desc->rlock); /*concurrent reads */
486 if (rv < 0)
487 return -ERESTARTSYS;
488
489 cntr = READ_ONCE(desc->length);
490 if (cntr == 0) {
491 desc->read = 0;
492retry:
493 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
494 rv = -ENODEV;
495 goto err;
496 }
497 if (test_bit(WDM_OVERFLOW, &desc->flags)) {
498 clear_bit(WDM_OVERFLOW, &desc->flags);
499 rv = -ENOBUFS;
500 goto err;
501 }
502 i++;
503 if (file->f_flags & O_NONBLOCK) {
504 if (!test_bit(WDM_READ, &desc->flags)) {
505 rv = -EAGAIN;
506 goto err;
507 }
508 rv = 0;
509 } else {
510 rv = wait_event_interruptible(desc->wait,
511 test_bit(WDM_READ, &desc->flags));
512 }
513
514 /* may have happened while we slept */
515 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
516 rv = -ENODEV;
517 goto err;
518 }
519 if (test_bit(WDM_RESETTING, &desc->flags)) {
520 rv = -EIO;
521 goto err;
522 }
523 usb_mark_last_busy(interface_to_usbdev(desc->intf));
524 if (rv < 0) {
525 rv = -ERESTARTSYS;
526 goto err;
527 }
528
529 spin_lock_irq(&desc->iuspin);
530
531 if (desc->rerr) { /* read completed, error happened */
532 rv = usb_translate_errors(desc->rerr);
533 desc->rerr = 0;
534 spin_unlock_irq(&desc->iuspin);
535 goto err;
536 }
537 /*
538 * recheck whether we've lost the race
539 * against the completion handler
540 */
541 if (!test_bit(WDM_READ, &desc->flags)) { /* lost race */
542 spin_unlock_irq(&desc->iuspin);
543 goto retry;
544 }
545
546 if (!desc->reslength) { /* zero length read */
547 dev_dbg(&desc->intf->dev, "zero length - clearing WDM_READ\n");
548 clear_bit(WDM_READ, &desc->flags);
549 rv = service_outstanding_interrupt(desc);
550 spin_unlock_irq(&desc->iuspin);
551 if (rv < 0)
552 goto err;
553 goto retry;
554 }
555 cntr = desc->length;
556 spin_unlock_irq(&desc->iuspin);
557 }
558
559 if (cntr > count)
560 cntr = count;
561 rv = copy_to_user(buffer, desc->ubuf, cntr);
562 if (rv > 0) {
563 rv = -EFAULT;
564 goto err;
565 }
566
567 spin_lock_irq(&desc->iuspin);
568
569 for (i = 0; i < desc->length - cntr; i++)
570 desc->ubuf[i] = desc->ubuf[i + cntr];
571
572 desc->length -= cntr;
573 /* in case we had outstanding data */
574 if (!desc->length) {
575 clear_bit(WDM_READ, &desc->flags);
576 service_outstanding_interrupt(desc);
577 }
578 spin_unlock_irq(&desc->iuspin);
579 rv = cntr;
580
581err:
582 mutex_unlock(&desc->rlock);
583 return rv;
584}
585
586static int wdm_flush(struct file *file, fl_owner_t id)
587{
588 struct wdm_device *desc = file->private_data;
589
590 wait_event(desc->wait,
591 /*
592 * needs both flags. We cannot do with one
593 * because resetting it would cause a race
594 * with write() yet we need to signal
595 * a disconnect
596 */
597 !test_bit(WDM_IN_USE, &desc->flags) ||
598 test_bit(WDM_DISCONNECTING, &desc->flags));
599
600 /* cannot dereference desc->intf if WDM_DISCONNECTING */
601 if (test_bit(WDM_DISCONNECTING, &desc->flags))
602 return -ENODEV;
603 if (desc->werr < 0)
604 dev_err(&desc->intf->dev, "Error in flush path: %d\n",
605 desc->werr);
606
607 return usb_translate_errors(desc->werr);
608}
609
610static __poll_t wdm_poll(struct file *file, struct poll_table_struct *wait)
611{
612 struct wdm_device *desc = file->private_data;
613 unsigned long flags;
614 __poll_t mask = 0;
615
616 spin_lock_irqsave(&desc->iuspin, flags);
617 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
618 mask = EPOLLHUP | EPOLLERR;
619 spin_unlock_irqrestore(&desc->iuspin, flags);
620 goto desc_out;
621 }
622 if (test_bit(WDM_READ, &desc->flags))
623 mask = EPOLLIN | EPOLLRDNORM;
624 if (desc->rerr || desc->werr)
625 mask |= EPOLLERR;
626 if (!test_bit(WDM_IN_USE, &desc->flags))
627 mask |= EPOLLOUT | EPOLLWRNORM;
628 spin_unlock_irqrestore(&desc->iuspin, flags);
629
630 poll_wait(file, &desc->wait, wait);
631
632desc_out:
633 return mask;
634}
635
636static int wdm_open(struct inode *inode, struct file *file)
637{
638 int minor = iminor(inode);
639 int rv = -ENODEV;
640 struct usb_interface *intf;
641 struct wdm_device *desc;
642
643 mutex_lock(&wdm_mutex);
644 desc = wdm_find_device_by_minor(minor);
645 if (!desc)
646 goto out;
647
648 intf = desc->intf;
649 if (test_bit(WDM_DISCONNECTING, &desc->flags))
650 goto out;
651 file->private_data = desc;
652
653 rv = usb_autopm_get_interface(desc->intf);
654 if (rv < 0) {
655 dev_err(&desc->intf->dev, "Error autopm - %d\n", rv);
656 goto out;
657 }
658
659 /* using write lock to protect desc->count */
660 mutex_lock(&desc->wlock);
661 if (!desc->count++) {
662 desc->werr = 0;
663 desc->rerr = 0;
664 rv = usb_submit_urb(desc->validity, GFP_KERNEL);
665 if (rv < 0) {
666 desc->count--;
667 dev_err(&desc->intf->dev,
668 "Error submitting int urb - %d\n", rv);
669 rv = usb_translate_errors(rv);
670 }
671 } else {
672 rv = 0;
673 }
674 mutex_unlock(&desc->wlock);
675 if (desc->count == 1)
676 desc->manage_power(intf, 1);
677 usb_autopm_put_interface(desc->intf);
678out:
679 mutex_unlock(&wdm_mutex);
680 return rv;
681}
682
683static int wdm_release(struct inode *inode, struct file *file)
684{
685 struct wdm_device *desc = file->private_data;
686
687 mutex_lock(&wdm_mutex);
688
689 /* using write lock to protect desc->count */
690 mutex_lock(&desc->wlock);
691 desc->count--;
692 mutex_unlock(&desc->wlock);
693
694 if (!desc->count) {
695 if (!test_bit(WDM_DISCONNECTING, &desc->flags)) {
696 dev_dbg(&desc->intf->dev, "wdm_release: cleanup\n");
697 kill_urbs(desc);
698 spin_lock_irq(&desc->iuspin);
699 desc->resp_count = 0;
700 spin_unlock_irq(&desc->iuspin);
701 desc->manage_power(desc->intf, 0);
702 } else {
703 /* must avoid dev_printk here as desc->intf is invalid */
704 pr_debug(KBUILD_MODNAME " %s: device gone - cleaning up\n", __func__);
705 cleanup(desc);
706 }
707 }
708 mutex_unlock(&wdm_mutex);
709 return 0;
710}
711
712static long wdm_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
713{
714 struct wdm_device *desc = file->private_data;
715 int rv = 0;
716
717 switch (cmd) {
718 case IOCTL_WDM_MAX_COMMAND:
719 if (copy_to_user((void __user *)arg, &desc->wMaxCommand, sizeof(desc->wMaxCommand)))
720 rv = -EFAULT;
721 break;
722 default:
723 rv = -ENOTTY;
724 }
725 return rv;
726}
727
728static const struct file_operations wdm_fops = {
729 .owner = THIS_MODULE,
730 .read = wdm_read,
731 .write = wdm_write,
732 .open = wdm_open,
733 .flush = wdm_flush,
734 .release = wdm_release,
735 .poll = wdm_poll,
736 .unlocked_ioctl = wdm_ioctl,
737 .compat_ioctl = compat_ptr_ioctl,
738 .llseek = noop_llseek,
739};
740
741static struct usb_class_driver wdm_class = {
742 .name = "cdc-wdm%d",
743 .fops = &wdm_fops,
744 .minor_base = WDM_MINOR_BASE,
745};
746
747/* --- error handling --- */
748static void wdm_rxwork(struct work_struct *work)
749{
750 struct wdm_device *desc = container_of(work, struct wdm_device, rxwork);
751 unsigned long flags;
752 int rv = 0;
753 int responding;
754
755 spin_lock_irqsave(&desc->iuspin, flags);
756 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
757 spin_unlock_irqrestore(&desc->iuspin, flags);
758 } else {
759 responding = test_and_set_bit(WDM_RESPONDING, &desc->flags);
760 spin_unlock_irqrestore(&desc->iuspin, flags);
761 if (!responding)
762 rv = usb_submit_urb(desc->response, GFP_KERNEL);
763 if (rv < 0 && rv != -EPERM) {
764 spin_lock_irqsave(&desc->iuspin, flags);
765 clear_bit(WDM_RESPONDING, &desc->flags);
766 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
767 schedule_work(&desc->rxwork);
768 spin_unlock_irqrestore(&desc->iuspin, flags);
769 }
770 }
771}
772
773static void service_interrupt_work(struct work_struct *work)
774{
775 struct wdm_device *desc;
776
777 desc = container_of(work, struct wdm_device, service_outs_intr);
778
779 spin_lock_irq(&desc->iuspin);
780 service_outstanding_interrupt(desc);
781 if (!desc->resp_count) {
782 set_bit(WDM_READ, &desc->flags);
783 wake_up(&desc->wait);
784 }
785 spin_unlock_irq(&desc->iuspin);
786}
787
788/* --- hotplug --- */
789
790static int wdm_create(struct usb_interface *intf, struct usb_endpoint_descriptor *ep,
791 u16 bufsize, int (*manage_power)(struct usb_interface *, int))
792{
793 int rv = -ENOMEM;
794 struct wdm_device *desc;
795
796 desc = kzalloc(sizeof(struct wdm_device), GFP_KERNEL);
797 if (!desc)
798 goto out;
799 INIT_LIST_HEAD(&desc->device_list);
800 mutex_init(&desc->rlock);
801 mutex_init(&desc->wlock);
802 spin_lock_init(&desc->iuspin);
803 init_waitqueue_head(&desc->wait);
804 desc->wMaxCommand = bufsize;
805 /* this will be expanded and needed in hardware endianness */
806 desc->inum = cpu_to_le16((u16)intf->cur_altsetting->desc.bInterfaceNumber);
807 desc->intf = intf;
808 INIT_WORK(&desc->rxwork, wdm_rxwork);
809 INIT_WORK(&desc->service_outs_intr, service_interrupt_work);
810
811 rv = -EINVAL;
812 if (!usb_endpoint_is_int_in(ep))
813 goto err;
814
815 desc->wMaxPacketSize = usb_endpoint_maxp(ep);
816
817 desc->orq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
818 if (!desc->orq)
819 goto err;
820 desc->irq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
821 if (!desc->irq)
822 goto err;
823
824 desc->validity = usb_alloc_urb(0, GFP_KERNEL);
825 if (!desc->validity)
826 goto err;
827
828 desc->response = usb_alloc_urb(0, GFP_KERNEL);
829 if (!desc->response)
830 goto err;
831
832 desc->command = usb_alloc_urb(0, GFP_KERNEL);
833 if (!desc->command)
834 goto err;
835
836 desc->ubuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
837 if (!desc->ubuf)
838 goto err;
839
840 desc->sbuf = kmalloc(desc->wMaxPacketSize, GFP_KERNEL);
841 if (!desc->sbuf)
842 goto err;
843
844 desc->inbuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
845 if (!desc->inbuf)
846 goto err;
847
848 usb_fill_int_urb(
849 desc->validity,
850 interface_to_usbdev(intf),
851 usb_rcvintpipe(interface_to_usbdev(intf), ep->bEndpointAddress),
852 desc->sbuf,
853 desc->wMaxPacketSize,
854 wdm_int_callback,
855 desc,
856 ep->bInterval
857 );
858
859 desc->irq->bRequestType = (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE);
860 desc->irq->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
861 desc->irq->wValue = 0;
862 desc->irq->wIndex = desc->inum; /* already converted */
863 desc->irq->wLength = cpu_to_le16(desc->wMaxCommand);
864
865 usb_fill_control_urb(
866 desc->response,
867 interface_to_usbdev(intf),
868 /* using common endpoint 0 */
869 usb_rcvctrlpipe(interface_to_usbdev(desc->intf), 0),
870 (unsigned char *)desc->irq,
871 desc->inbuf,
872 desc->wMaxCommand,
873 wdm_in_callback,
874 desc
875 );
876
877 desc->manage_power = manage_power;
878
879 spin_lock(&wdm_device_list_lock);
880 list_add(&desc->device_list, &wdm_device_list);
881 spin_unlock(&wdm_device_list_lock);
882
883 rv = usb_register_dev(intf, &wdm_class);
884 if (rv < 0)
885 goto err;
886 else
887 dev_info(&intf->dev, "%s: USB WDM device\n", dev_name(intf->usb_dev));
888out:
889 return rv;
890err:
891 spin_lock(&wdm_device_list_lock);
892 list_del(&desc->device_list);
893 spin_unlock(&wdm_device_list_lock);
894 cleanup(desc);
895 return rv;
896}
897
898static int wdm_manage_power(struct usb_interface *intf, int on)
899{
900 /* need autopm_get/put here to ensure the usbcore sees the new value */
901 int rv = usb_autopm_get_interface(intf);
902
903 intf->needs_remote_wakeup = on;
904 if (!rv)
905 usb_autopm_put_interface(intf);
906 return 0;
907}
908
909static int wdm_probe(struct usb_interface *intf, const struct usb_device_id *id)
910{
911 int rv = -EINVAL;
912 struct usb_host_interface *iface;
913 struct usb_endpoint_descriptor *ep;
914 struct usb_cdc_parsed_header hdr;
915 u8 *buffer = intf->altsetting->extra;
916 int buflen = intf->altsetting->extralen;
917 u16 maxcom = WDM_DEFAULT_BUFSIZE;
918
919 if (!buffer)
920 goto err;
921
922 cdc_parse_cdc_header(&hdr, intf, buffer, buflen);
923
924 if (hdr.usb_cdc_dmm_desc)
925 maxcom = le16_to_cpu(hdr.usb_cdc_dmm_desc->wMaxCommand);
926
927 iface = intf->cur_altsetting;
928 if (iface->desc.bNumEndpoints != 1)
929 goto err;
930 ep = &iface->endpoint[0].desc;
931
932 rv = wdm_create(intf, ep, maxcom, &wdm_manage_power);
933
934err:
935 return rv;
936}
937
938/**
939 * usb_cdc_wdm_register - register a WDM subdriver
940 * @intf: usb interface the subdriver will associate with
941 * @ep: interrupt endpoint to monitor for notifications
942 * @bufsize: maximum message size to support for read/write
943 * @manage_power: call-back invoked during open and release to
944 * manage the device's power
945 * Create WDM usb class character device and associate it with intf
946 * without binding, allowing another driver to manage the interface.
947 *
948 * The subdriver will manage the given interrupt endpoint exclusively
949 * and will issue control requests referring to the given intf. It
950 * will otherwise avoid interferring, and in particular not do
951 * usb_set_intfdata/usb_get_intfdata on intf.
952 *
953 * The return value is a pointer to the subdriver's struct usb_driver.
954 * The registering driver is responsible for calling this subdriver's
955 * disconnect, suspend, resume, pre_reset and post_reset methods from
956 * its own.
957 */
958struct usb_driver *usb_cdc_wdm_register(struct usb_interface *intf,
959 struct usb_endpoint_descriptor *ep,
960 int bufsize,
961 int (*manage_power)(struct usb_interface *, int))
962{
963 int rv;
964
965 rv = wdm_create(intf, ep, bufsize, manage_power);
966 if (rv < 0)
967 goto err;
968
969 return &wdm_driver;
970err:
971 return ERR_PTR(rv);
972}
973EXPORT_SYMBOL(usb_cdc_wdm_register);
974
975static void wdm_disconnect(struct usb_interface *intf)
976{
977 struct wdm_device *desc;
978 unsigned long flags;
979
980 usb_deregister_dev(intf, &wdm_class);
981 desc = wdm_find_device(intf);
982 mutex_lock(&wdm_mutex);
983
984 /* the spinlock makes sure no new urbs are generated in the callbacks */
985 spin_lock_irqsave(&desc->iuspin, flags);
986 set_bit(WDM_DISCONNECTING, &desc->flags);
987 set_bit(WDM_READ, &desc->flags);
988 spin_unlock_irqrestore(&desc->iuspin, flags);
989 wake_up_all(&desc->wait);
990 mutex_lock(&desc->rlock);
991 mutex_lock(&desc->wlock);
992 kill_urbs(desc);
993 cancel_work_sync(&desc->rxwork);
994 cancel_work_sync(&desc->service_outs_intr);
995 mutex_unlock(&desc->wlock);
996 mutex_unlock(&desc->rlock);
997
998 /* the desc->intf pointer used as list key is now invalid */
999 spin_lock(&wdm_device_list_lock);
1000 list_del(&desc->device_list);
1001 spin_unlock(&wdm_device_list_lock);
1002
1003 if (!desc->count)
1004 cleanup(desc);
1005 else
1006 dev_dbg(&intf->dev, "%d open files - postponing cleanup\n", desc->count);
1007 mutex_unlock(&wdm_mutex);
1008}
1009
1010#ifdef CONFIG_PM
1011static int wdm_suspend(struct usb_interface *intf, pm_message_t message)
1012{
1013 struct wdm_device *desc = wdm_find_device(intf);
1014 int rv = 0;
1015
1016 dev_dbg(&desc->intf->dev, "wdm%d_suspend\n", intf->minor);
1017
1018 /* if this is an autosuspend the caller does the locking */
1019 if (!PMSG_IS_AUTO(message)) {
1020 mutex_lock(&desc->rlock);
1021 mutex_lock(&desc->wlock);
1022 }
1023 spin_lock_irq(&desc->iuspin);
1024
1025 if (PMSG_IS_AUTO(message) &&
1026 (test_bit(WDM_IN_USE, &desc->flags)
1027 || test_bit(WDM_RESPONDING, &desc->flags))) {
1028 spin_unlock_irq(&desc->iuspin);
1029 rv = -EBUSY;
1030 } else {
1031
1032 set_bit(WDM_SUSPENDING, &desc->flags);
1033 spin_unlock_irq(&desc->iuspin);
1034 /* callback submits work - order is essential */
1035 kill_urbs(desc);
1036 cancel_work_sync(&desc->rxwork);
1037 cancel_work_sync(&desc->service_outs_intr);
1038 }
1039 if (!PMSG_IS_AUTO(message)) {
1040 mutex_unlock(&desc->wlock);
1041 mutex_unlock(&desc->rlock);
1042 }
1043
1044 return rv;
1045}
1046#endif
1047
1048static int recover_from_urb_loss(struct wdm_device *desc)
1049{
1050 int rv = 0;
1051
1052 if (desc->count) {
1053 rv = usb_submit_urb(desc->validity, GFP_NOIO);
1054 if (rv < 0)
1055 dev_err(&desc->intf->dev,
1056 "Error resume submitting int urb - %d\n", rv);
1057 }
1058 return rv;
1059}
1060
1061#ifdef CONFIG_PM
1062static int wdm_resume(struct usb_interface *intf)
1063{
1064 struct wdm_device *desc = wdm_find_device(intf);
1065 int rv;
1066
1067 dev_dbg(&desc->intf->dev, "wdm%d_resume\n", intf->minor);
1068
1069 clear_bit(WDM_SUSPENDING, &desc->flags);
1070 rv = recover_from_urb_loss(desc);
1071
1072 return rv;
1073}
1074#endif
1075
1076static int wdm_pre_reset(struct usb_interface *intf)
1077{
1078 struct wdm_device *desc = wdm_find_device(intf);
1079
1080 /*
1081 * we notify everybody using poll of
1082 * an exceptional situation
1083 * must be done before recovery lest a spontaneous
1084 * message from the device is lost
1085 */
1086 spin_lock_irq(&desc->iuspin);
1087 set_bit(WDM_RESETTING, &desc->flags); /* inform read/write */
1088 set_bit(WDM_READ, &desc->flags); /* unblock read */
1089 clear_bit(WDM_IN_USE, &desc->flags); /* unblock write */
1090 desc->rerr = -EINTR;
1091 spin_unlock_irq(&desc->iuspin);
1092 wake_up_all(&desc->wait);
1093 mutex_lock(&desc->rlock);
1094 mutex_lock(&desc->wlock);
1095 kill_urbs(desc);
1096 cancel_work_sync(&desc->rxwork);
1097 cancel_work_sync(&desc->service_outs_intr);
1098 return 0;
1099}
1100
1101static int wdm_post_reset(struct usb_interface *intf)
1102{
1103 struct wdm_device *desc = wdm_find_device(intf);
1104 int rv;
1105
1106 clear_bit(WDM_OVERFLOW, &desc->flags);
1107 clear_bit(WDM_RESETTING, &desc->flags);
1108 rv = recover_from_urb_loss(desc);
1109 mutex_unlock(&desc->wlock);
1110 mutex_unlock(&desc->rlock);
1111 return rv;
1112}
1113
1114static struct usb_driver wdm_driver = {
1115 .name = "cdc_wdm",
1116 .probe = wdm_probe,
1117 .disconnect = wdm_disconnect,
1118#ifdef CONFIG_PM
1119 .suspend = wdm_suspend,
1120 .resume = wdm_resume,
1121 .reset_resume = wdm_resume,
1122#endif
1123 .pre_reset = wdm_pre_reset,
1124 .post_reset = wdm_post_reset,
1125 .id_table = wdm_ids,
1126 .supports_autosuspend = 1,
1127 .disable_hub_initiated_lpm = 1,
1128};
1129
1130module_usb_driver(wdm_driver);
1131
1132MODULE_AUTHOR(DRIVER_AUTHOR);
1133MODULE_DESCRIPTION(DRIVER_DESC);
1134MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * cdc-wdm.c
4 *
5 * This driver supports USB CDC WCM Device Management.
6 *
7 * Copyright (c) 2007-2009 Oliver Neukum
8 *
9 * Some code taken from cdc-acm.c
10 *
11 * Released under the GPLv2.
12 *
13 * Many thanks to Carl Nordbeck
14 */
15#include <linux/kernel.h>
16#include <linux/errno.h>
17#include <linux/ioctl.h>
18#include <linux/slab.h>
19#include <linux/module.h>
20#include <linux/mutex.h>
21#include <linux/uaccess.h>
22#include <linux/bitops.h>
23#include <linux/poll.h>
24#include <linux/skbuff.h>
25#include <linux/usb.h>
26#include <linux/usb/cdc.h>
27#include <linux/wwan.h>
28#include <asm/byteorder.h>
29#include <asm/unaligned.h>
30#include <linux/usb/cdc-wdm.h>
31
32#define DRIVER_AUTHOR "Oliver Neukum"
33#define DRIVER_DESC "USB Abstract Control Model driver for USB WCM Device Management"
34
35static const struct usb_device_id wdm_ids[] = {
36 {
37 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
38 USB_DEVICE_ID_MATCH_INT_SUBCLASS,
39 .bInterfaceClass = USB_CLASS_COMM,
40 .bInterfaceSubClass = USB_CDC_SUBCLASS_DMM
41 },
42 { }
43};
44
45MODULE_DEVICE_TABLE (usb, wdm_ids);
46
47#define WDM_MINOR_BASE 176
48
49
50#define WDM_IN_USE 1
51#define WDM_DISCONNECTING 2
52#define WDM_RESULT 3
53#define WDM_READ 4
54#define WDM_INT_STALL 5
55#define WDM_POLL_RUNNING 6
56#define WDM_RESPONDING 7
57#define WDM_SUSPENDING 8
58#define WDM_RESETTING 9
59#define WDM_OVERFLOW 10
60#define WDM_WWAN_IN_USE 11
61
62#define WDM_MAX 16
63
64/* we cannot wait forever at flush() */
65#define WDM_FLUSH_TIMEOUT (30 * HZ)
66
67/* CDC-WMC r1.1 requires wMaxCommand to be "at least 256 decimal (0x100)" */
68#define WDM_DEFAULT_BUFSIZE 256
69
70static DEFINE_MUTEX(wdm_mutex);
71static DEFINE_SPINLOCK(wdm_device_list_lock);
72static LIST_HEAD(wdm_device_list);
73
74/* --- method tables --- */
75
76struct wdm_device {
77 u8 *inbuf; /* buffer for response */
78 u8 *outbuf; /* buffer for command */
79 u8 *sbuf; /* buffer for status */
80 u8 *ubuf; /* buffer for copy to user space */
81
82 struct urb *command;
83 struct urb *response;
84 struct urb *validity;
85 struct usb_interface *intf;
86 struct usb_ctrlrequest *orq;
87 struct usb_ctrlrequest *irq;
88 spinlock_t iuspin;
89
90 unsigned long flags;
91 u16 bufsize;
92 u16 wMaxCommand;
93 u16 wMaxPacketSize;
94 __le16 inum;
95 int reslength;
96 int length;
97 int read;
98 int count;
99 dma_addr_t shandle;
100 dma_addr_t ihandle;
101 struct mutex wlock;
102 struct mutex rlock;
103 wait_queue_head_t wait;
104 struct work_struct rxwork;
105 struct work_struct service_outs_intr;
106 int werr;
107 int rerr;
108 int resp_count;
109
110 struct list_head device_list;
111 int (*manage_power)(struct usb_interface *, int);
112
113 enum wwan_port_type wwanp_type;
114 struct wwan_port *wwanp;
115};
116
117static struct usb_driver wdm_driver;
118
119/* return intfdata if we own the interface, else look up intf in the list */
120static struct wdm_device *wdm_find_device(struct usb_interface *intf)
121{
122 struct wdm_device *desc;
123
124 spin_lock(&wdm_device_list_lock);
125 list_for_each_entry(desc, &wdm_device_list, device_list)
126 if (desc->intf == intf)
127 goto found;
128 desc = NULL;
129found:
130 spin_unlock(&wdm_device_list_lock);
131
132 return desc;
133}
134
135static struct wdm_device *wdm_find_device_by_minor(int minor)
136{
137 struct wdm_device *desc;
138
139 spin_lock(&wdm_device_list_lock);
140 list_for_each_entry(desc, &wdm_device_list, device_list)
141 if (desc->intf->minor == minor)
142 goto found;
143 desc = NULL;
144found:
145 spin_unlock(&wdm_device_list_lock);
146
147 return desc;
148}
149
150/* --- callbacks --- */
151static void wdm_out_callback(struct urb *urb)
152{
153 struct wdm_device *desc;
154 unsigned long flags;
155
156 desc = urb->context;
157 spin_lock_irqsave(&desc->iuspin, flags);
158 desc->werr = urb->status;
159 spin_unlock_irqrestore(&desc->iuspin, flags);
160 kfree(desc->outbuf);
161 desc->outbuf = NULL;
162 clear_bit(WDM_IN_USE, &desc->flags);
163 wake_up_all(&desc->wait);
164}
165
166static void wdm_wwan_rx(struct wdm_device *desc, int length);
167
168static void wdm_in_callback(struct urb *urb)
169{
170 unsigned long flags;
171 struct wdm_device *desc = urb->context;
172 int status = urb->status;
173 int length = urb->actual_length;
174
175 spin_lock_irqsave(&desc->iuspin, flags);
176 clear_bit(WDM_RESPONDING, &desc->flags);
177
178 if (status) {
179 switch (status) {
180 case -ENOENT:
181 dev_dbg(&desc->intf->dev,
182 "nonzero urb status received: -ENOENT\n");
183 goto skip_error;
184 case -ECONNRESET:
185 dev_dbg(&desc->intf->dev,
186 "nonzero urb status received: -ECONNRESET\n");
187 goto skip_error;
188 case -ESHUTDOWN:
189 dev_dbg(&desc->intf->dev,
190 "nonzero urb status received: -ESHUTDOWN\n");
191 goto skip_error;
192 case -EPIPE:
193 dev_err(&desc->intf->dev,
194 "nonzero urb status received: -EPIPE\n");
195 break;
196 default:
197 dev_err(&desc->intf->dev,
198 "Unexpected error %d\n", status);
199 break;
200 }
201 }
202
203 if (test_bit(WDM_WWAN_IN_USE, &desc->flags)) {
204 wdm_wwan_rx(desc, length);
205 goto out;
206 }
207
208 /*
209 * only set a new error if there is no previous error.
210 * Errors are only cleared during read/open
211 * Avoid propagating -EPIPE (stall) to userspace since it is
212 * better handled as an empty read
213 */
214 if (desc->rerr == 0 && status != -EPIPE)
215 desc->rerr = status;
216
217 if (length + desc->length > desc->wMaxCommand) {
218 /* The buffer would overflow */
219 set_bit(WDM_OVERFLOW, &desc->flags);
220 } else {
221 /* we may already be in overflow */
222 if (!test_bit(WDM_OVERFLOW, &desc->flags)) {
223 memmove(desc->ubuf + desc->length, desc->inbuf, length);
224 desc->length += length;
225 desc->reslength = length;
226 }
227 }
228skip_error:
229
230 if (desc->rerr) {
231 /*
232 * Since there was an error, userspace may decide to not read
233 * any data after poll'ing.
234 * We should respond to further attempts from the device to send
235 * data, so that we can get unstuck.
236 */
237 schedule_work(&desc->service_outs_intr);
238 } else {
239 set_bit(WDM_READ, &desc->flags);
240 wake_up(&desc->wait);
241 }
242out:
243 spin_unlock_irqrestore(&desc->iuspin, flags);
244}
245
246static void wdm_int_callback(struct urb *urb)
247{
248 unsigned long flags;
249 int rv = 0;
250 int responding;
251 int status = urb->status;
252 struct wdm_device *desc;
253 struct usb_cdc_notification *dr;
254
255 desc = urb->context;
256 dr = (struct usb_cdc_notification *)desc->sbuf;
257
258 if (status) {
259 switch (status) {
260 case -ESHUTDOWN:
261 case -ENOENT:
262 case -ECONNRESET:
263 return; /* unplug */
264 case -EPIPE:
265 set_bit(WDM_INT_STALL, &desc->flags);
266 dev_err(&desc->intf->dev, "Stall on int endpoint\n");
267 goto sw; /* halt is cleared in work */
268 default:
269 dev_err(&desc->intf->dev,
270 "nonzero urb status received: %d\n", status);
271 break;
272 }
273 }
274
275 if (urb->actual_length < sizeof(struct usb_cdc_notification)) {
276 dev_err(&desc->intf->dev, "wdm_int_callback - %d bytes\n",
277 urb->actual_length);
278 goto exit;
279 }
280
281 switch (dr->bNotificationType) {
282 case USB_CDC_NOTIFY_RESPONSE_AVAILABLE:
283 dev_dbg(&desc->intf->dev,
284 "NOTIFY_RESPONSE_AVAILABLE received: index %d len %d\n",
285 le16_to_cpu(dr->wIndex), le16_to_cpu(dr->wLength));
286 break;
287
288 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
289
290 dev_dbg(&desc->intf->dev,
291 "NOTIFY_NETWORK_CONNECTION %s network\n",
292 dr->wValue ? "connected to" : "disconnected from");
293 goto exit;
294 case USB_CDC_NOTIFY_SPEED_CHANGE:
295 dev_dbg(&desc->intf->dev, "SPEED_CHANGE received (len %u)\n",
296 urb->actual_length);
297 goto exit;
298 default:
299 clear_bit(WDM_POLL_RUNNING, &desc->flags);
300 dev_err(&desc->intf->dev,
301 "unknown notification %d received: index %d len %d\n",
302 dr->bNotificationType,
303 le16_to_cpu(dr->wIndex),
304 le16_to_cpu(dr->wLength));
305 goto exit;
306 }
307
308 spin_lock_irqsave(&desc->iuspin, flags);
309 responding = test_and_set_bit(WDM_RESPONDING, &desc->flags);
310 if (!desc->resp_count++ && !responding
311 && !test_bit(WDM_DISCONNECTING, &desc->flags)
312 && !test_bit(WDM_SUSPENDING, &desc->flags)) {
313 rv = usb_submit_urb(desc->response, GFP_ATOMIC);
314 dev_dbg(&desc->intf->dev, "submit response URB %d\n", rv);
315 }
316 spin_unlock_irqrestore(&desc->iuspin, flags);
317 if (rv < 0) {
318 clear_bit(WDM_RESPONDING, &desc->flags);
319 if (rv == -EPERM)
320 return;
321 if (rv == -ENOMEM) {
322sw:
323 rv = schedule_work(&desc->rxwork);
324 if (rv)
325 dev_err(&desc->intf->dev,
326 "Cannot schedule work\n");
327 }
328 }
329exit:
330 rv = usb_submit_urb(urb, GFP_ATOMIC);
331 if (rv)
332 dev_err(&desc->intf->dev,
333 "%s - usb_submit_urb failed with result %d\n",
334 __func__, rv);
335
336}
337
338static void poison_urbs(struct wdm_device *desc)
339{
340 /* the order here is essential */
341 usb_poison_urb(desc->command);
342 usb_poison_urb(desc->validity);
343 usb_poison_urb(desc->response);
344}
345
346static void unpoison_urbs(struct wdm_device *desc)
347{
348 /*
349 * the order here is not essential
350 * it is symmetrical just to be nice
351 */
352 usb_unpoison_urb(desc->response);
353 usb_unpoison_urb(desc->validity);
354 usb_unpoison_urb(desc->command);
355}
356
357static void free_urbs(struct wdm_device *desc)
358{
359 usb_free_urb(desc->validity);
360 usb_free_urb(desc->response);
361 usb_free_urb(desc->command);
362}
363
364static void cleanup(struct wdm_device *desc)
365{
366 kfree(desc->sbuf);
367 kfree(desc->inbuf);
368 kfree(desc->orq);
369 kfree(desc->irq);
370 kfree(desc->ubuf);
371 free_urbs(desc);
372 kfree(desc);
373}
374
375static ssize_t wdm_write
376(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
377{
378 u8 *buf;
379 int rv = -EMSGSIZE, r, we;
380 struct wdm_device *desc = file->private_data;
381 struct usb_ctrlrequest *req;
382
383 if (count > desc->wMaxCommand)
384 count = desc->wMaxCommand;
385
386 spin_lock_irq(&desc->iuspin);
387 we = desc->werr;
388 desc->werr = 0;
389 spin_unlock_irq(&desc->iuspin);
390 if (we < 0)
391 return usb_translate_errors(we);
392
393 buf = memdup_user(buffer, count);
394 if (IS_ERR(buf))
395 return PTR_ERR(buf);
396
397 /* concurrent writes and disconnect */
398 r = mutex_lock_interruptible(&desc->wlock);
399 rv = -ERESTARTSYS;
400 if (r)
401 goto out_free_mem;
402
403 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
404 rv = -ENODEV;
405 goto out_free_mem_lock;
406 }
407
408 r = usb_autopm_get_interface(desc->intf);
409 if (r < 0) {
410 rv = usb_translate_errors(r);
411 goto out_free_mem_lock;
412 }
413
414 if (!(file->f_flags & O_NONBLOCK))
415 r = wait_event_interruptible(desc->wait, !test_bit(WDM_IN_USE,
416 &desc->flags));
417 else
418 if (test_bit(WDM_IN_USE, &desc->flags))
419 r = -EAGAIN;
420
421 if (test_bit(WDM_RESETTING, &desc->flags))
422 r = -EIO;
423
424 if (test_bit(WDM_DISCONNECTING, &desc->flags))
425 r = -ENODEV;
426
427 if (r < 0) {
428 rv = r;
429 goto out_free_mem_pm;
430 }
431
432 req = desc->orq;
433 usb_fill_control_urb(
434 desc->command,
435 interface_to_usbdev(desc->intf),
436 /* using common endpoint 0 */
437 usb_sndctrlpipe(interface_to_usbdev(desc->intf), 0),
438 (unsigned char *)req,
439 buf,
440 count,
441 wdm_out_callback,
442 desc
443 );
444
445 req->bRequestType = (USB_DIR_OUT | USB_TYPE_CLASS |
446 USB_RECIP_INTERFACE);
447 req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
448 req->wValue = 0;
449 req->wIndex = desc->inum; /* already converted */
450 req->wLength = cpu_to_le16(count);
451 set_bit(WDM_IN_USE, &desc->flags);
452 desc->outbuf = buf;
453
454 rv = usb_submit_urb(desc->command, GFP_KERNEL);
455 if (rv < 0) {
456 desc->outbuf = NULL;
457 clear_bit(WDM_IN_USE, &desc->flags);
458 wake_up_all(&desc->wait); /* for wdm_wait_for_response() */
459 dev_err(&desc->intf->dev, "Tx URB error: %d\n", rv);
460 rv = usb_translate_errors(rv);
461 goto out_free_mem_pm;
462 } else {
463 dev_dbg(&desc->intf->dev, "Tx URB has been submitted index=%d\n",
464 le16_to_cpu(req->wIndex));
465 }
466
467 usb_autopm_put_interface(desc->intf);
468 mutex_unlock(&desc->wlock);
469 return count;
470
471out_free_mem_pm:
472 usb_autopm_put_interface(desc->intf);
473out_free_mem_lock:
474 mutex_unlock(&desc->wlock);
475out_free_mem:
476 kfree(buf);
477 return rv;
478}
479
480/*
481 * Submit the read urb if resp_count is non-zero.
482 *
483 * Called with desc->iuspin locked
484 */
485static int service_outstanding_interrupt(struct wdm_device *desc)
486{
487 int rv = 0;
488
489 /* submit read urb only if the device is waiting for it */
490 if (!desc->resp_count || !--desc->resp_count)
491 goto out;
492
493 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
494 rv = -ENODEV;
495 goto out;
496 }
497 if (test_bit(WDM_RESETTING, &desc->flags)) {
498 rv = -EIO;
499 goto out;
500 }
501
502 set_bit(WDM_RESPONDING, &desc->flags);
503 spin_unlock_irq(&desc->iuspin);
504 rv = usb_submit_urb(desc->response, GFP_KERNEL);
505 spin_lock_irq(&desc->iuspin);
506 if (rv) {
507 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
508 dev_err(&desc->intf->dev,
509 "usb_submit_urb failed with result %d\n", rv);
510
511 /* make sure the next notification trigger a submit */
512 clear_bit(WDM_RESPONDING, &desc->flags);
513 desc->resp_count = 0;
514 }
515out:
516 return rv;
517}
518
519static ssize_t wdm_read
520(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
521{
522 int rv, cntr;
523 int i = 0;
524 struct wdm_device *desc = file->private_data;
525
526
527 rv = mutex_lock_interruptible(&desc->rlock); /*concurrent reads */
528 if (rv < 0)
529 return -ERESTARTSYS;
530
531 cntr = READ_ONCE(desc->length);
532 if (cntr == 0) {
533 desc->read = 0;
534retry:
535 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
536 rv = -ENODEV;
537 goto err;
538 }
539 if (test_bit(WDM_OVERFLOW, &desc->flags)) {
540 clear_bit(WDM_OVERFLOW, &desc->flags);
541 rv = -ENOBUFS;
542 goto err;
543 }
544 i++;
545 if (file->f_flags & O_NONBLOCK) {
546 if (!test_bit(WDM_READ, &desc->flags)) {
547 rv = -EAGAIN;
548 goto err;
549 }
550 rv = 0;
551 } else {
552 rv = wait_event_interruptible(desc->wait,
553 test_bit(WDM_READ, &desc->flags));
554 }
555
556 /* may have happened while we slept */
557 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
558 rv = -ENODEV;
559 goto err;
560 }
561 if (test_bit(WDM_RESETTING, &desc->flags)) {
562 rv = -EIO;
563 goto err;
564 }
565 usb_mark_last_busy(interface_to_usbdev(desc->intf));
566 if (rv < 0) {
567 rv = -ERESTARTSYS;
568 goto err;
569 }
570
571 spin_lock_irq(&desc->iuspin);
572
573 if (desc->rerr) { /* read completed, error happened */
574 rv = usb_translate_errors(desc->rerr);
575 desc->rerr = 0;
576 spin_unlock_irq(&desc->iuspin);
577 goto err;
578 }
579 /*
580 * recheck whether we've lost the race
581 * against the completion handler
582 */
583 if (!test_bit(WDM_READ, &desc->flags)) { /* lost race */
584 spin_unlock_irq(&desc->iuspin);
585 goto retry;
586 }
587
588 if (!desc->reslength) { /* zero length read */
589 dev_dbg(&desc->intf->dev, "zero length - clearing WDM_READ\n");
590 clear_bit(WDM_READ, &desc->flags);
591 rv = service_outstanding_interrupt(desc);
592 spin_unlock_irq(&desc->iuspin);
593 if (rv < 0)
594 goto err;
595 goto retry;
596 }
597 cntr = desc->length;
598 spin_unlock_irq(&desc->iuspin);
599 }
600
601 if (cntr > count)
602 cntr = count;
603 rv = copy_to_user(buffer, desc->ubuf, cntr);
604 if (rv > 0) {
605 rv = -EFAULT;
606 goto err;
607 }
608
609 spin_lock_irq(&desc->iuspin);
610
611 for (i = 0; i < desc->length - cntr; i++)
612 desc->ubuf[i] = desc->ubuf[i + cntr];
613
614 desc->length -= cntr;
615 /* in case we had outstanding data */
616 if (!desc->length) {
617 clear_bit(WDM_READ, &desc->flags);
618 service_outstanding_interrupt(desc);
619 }
620 spin_unlock_irq(&desc->iuspin);
621 rv = cntr;
622
623err:
624 mutex_unlock(&desc->rlock);
625 return rv;
626}
627
628static int wdm_wait_for_response(struct file *file, long timeout)
629{
630 struct wdm_device *desc = file->private_data;
631 long rv; /* Use long here because (int) MAX_SCHEDULE_TIMEOUT < 0. */
632
633 /*
634 * Needs both flags. We cannot do with one because resetting it would
635 * cause a race with write() yet we need to signal a disconnect.
636 */
637 rv = wait_event_interruptible_timeout(desc->wait,
638 !test_bit(WDM_IN_USE, &desc->flags) ||
639 test_bit(WDM_DISCONNECTING, &desc->flags),
640 timeout);
641
642 /*
643 * To report the correct error. This is best effort.
644 * We are inevitably racing with the hardware.
645 */
646 if (test_bit(WDM_DISCONNECTING, &desc->flags))
647 return -ENODEV;
648 if (!rv)
649 return -EIO;
650 if (rv < 0)
651 return -EINTR;
652
653 spin_lock_irq(&desc->iuspin);
654 rv = desc->werr;
655 desc->werr = 0;
656 spin_unlock_irq(&desc->iuspin);
657
658 return usb_translate_errors(rv);
659
660}
661
662/*
663 * You need to send a signal when you react to malicious or defective hardware.
664 * Also, don't abort when fsync() returned -EINVAL, for older kernels which do
665 * not implement wdm_flush() will return -EINVAL.
666 */
667static int wdm_fsync(struct file *file, loff_t start, loff_t end, int datasync)
668{
669 return wdm_wait_for_response(file, MAX_SCHEDULE_TIMEOUT);
670}
671
672/*
673 * Same with wdm_fsync(), except it uses finite timeout in order to react to
674 * malicious or defective hardware which ceased communication after close() was
675 * implicitly called due to process termination.
676 */
677static int wdm_flush(struct file *file, fl_owner_t id)
678{
679 return wdm_wait_for_response(file, WDM_FLUSH_TIMEOUT);
680}
681
682static __poll_t wdm_poll(struct file *file, struct poll_table_struct *wait)
683{
684 struct wdm_device *desc = file->private_data;
685 unsigned long flags;
686 __poll_t mask = 0;
687
688 spin_lock_irqsave(&desc->iuspin, flags);
689 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
690 mask = EPOLLHUP | EPOLLERR;
691 spin_unlock_irqrestore(&desc->iuspin, flags);
692 goto desc_out;
693 }
694 if (test_bit(WDM_READ, &desc->flags))
695 mask = EPOLLIN | EPOLLRDNORM;
696 if (desc->rerr || desc->werr)
697 mask |= EPOLLERR;
698 if (!test_bit(WDM_IN_USE, &desc->flags))
699 mask |= EPOLLOUT | EPOLLWRNORM;
700 spin_unlock_irqrestore(&desc->iuspin, flags);
701
702 poll_wait(file, &desc->wait, wait);
703
704desc_out:
705 return mask;
706}
707
708static int wdm_open(struct inode *inode, struct file *file)
709{
710 int minor = iminor(inode);
711 int rv = -ENODEV;
712 struct usb_interface *intf;
713 struct wdm_device *desc;
714
715 mutex_lock(&wdm_mutex);
716 desc = wdm_find_device_by_minor(minor);
717 if (!desc)
718 goto out;
719
720 intf = desc->intf;
721 if (test_bit(WDM_DISCONNECTING, &desc->flags))
722 goto out;
723 file->private_data = desc;
724
725 if (test_bit(WDM_WWAN_IN_USE, &desc->flags)) {
726 rv = -EBUSY;
727 goto out;
728 }
729
730 rv = usb_autopm_get_interface(desc->intf);
731 if (rv < 0) {
732 dev_err(&desc->intf->dev, "Error autopm - %d\n", rv);
733 goto out;
734 }
735
736 /* using write lock to protect desc->count */
737 mutex_lock(&desc->wlock);
738 if (!desc->count++) {
739 desc->werr = 0;
740 desc->rerr = 0;
741 rv = usb_submit_urb(desc->validity, GFP_KERNEL);
742 if (rv < 0) {
743 desc->count--;
744 dev_err(&desc->intf->dev,
745 "Error submitting int urb - %d\n", rv);
746 rv = usb_translate_errors(rv);
747 }
748 } else {
749 rv = 0;
750 }
751 mutex_unlock(&desc->wlock);
752 if (desc->count == 1)
753 desc->manage_power(intf, 1);
754 usb_autopm_put_interface(desc->intf);
755out:
756 mutex_unlock(&wdm_mutex);
757 return rv;
758}
759
760static int wdm_release(struct inode *inode, struct file *file)
761{
762 struct wdm_device *desc = file->private_data;
763
764 mutex_lock(&wdm_mutex);
765
766 /* using write lock to protect desc->count */
767 mutex_lock(&desc->wlock);
768 desc->count--;
769 mutex_unlock(&desc->wlock);
770
771 if (!desc->count) {
772 if (!test_bit(WDM_DISCONNECTING, &desc->flags)) {
773 dev_dbg(&desc->intf->dev, "wdm_release: cleanup\n");
774 poison_urbs(desc);
775 spin_lock_irq(&desc->iuspin);
776 desc->resp_count = 0;
777 clear_bit(WDM_RESPONDING, &desc->flags);
778 spin_unlock_irq(&desc->iuspin);
779 desc->manage_power(desc->intf, 0);
780 unpoison_urbs(desc);
781 } else {
782 /* must avoid dev_printk here as desc->intf is invalid */
783 pr_debug(KBUILD_MODNAME " %s: device gone - cleaning up\n", __func__);
784 cleanup(desc);
785 }
786 }
787 mutex_unlock(&wdm_mutex);
788 return 0;
789}
790
791static long wdm_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
792{
793 struct wdm_device *desc = file->private_data;
794 int rv = 0;
795
796 switch (cmd) {
797 case IOCTL_WDM_MAX_COMMAND:
798 if (copy_to_user((void __user *)arg, &desc->wMaxCommand, sizeof(desc->wMaxCommand)))
799 rv = -EFAULT;
800 break;
801 default:
802 rv = -ENOTTY;
803 }
804 return rv;
805}
806
807static const struct file_operations wdm_fops = {
808 .owner = THIS_MODULE,
809 .read = wdm_read,
810 .write = wdm_write,
811 .fsync = wdm_fsync,
812 .open = wdm_open,
813 .flush = wdm_flush,
814 .release = wdm_release,
815 .poll = wdm_poll,
816 .unlocked_ioctl = wdm_ioctl,
817 .compat_ioctl = compat_ptr_ioctl,
818 .llseek = noop_llseek,
819};
820
821static struct usb_class_driver wdm_class = {
822 .name = "cdc-wdm%d",
823 .fops = &wdm_fops,
824 .minor_base = WDM_MINOR_BASE,
825};
826
827/* --- WWAN framework integration --- */
828#ifdef CONFIG_WWAN
829static int wdm_wwan_port_start(struct wwan_port *port)
830{
831 struct wdm_device *desc = wwan_port_get_drvdata(port);
832
833 /* The interface is both exposed via the WWAN framework and as a
834 * legacy usbmisc chardev. If chardev is already open, just fail
835 * to prevent concurrent usage. Otherwise, switch to WWAN mode.
836 */
837 mutex_lock(&wdm_mutex);
838 if (desc->count) {
839 mutex_unlock(&wdm_mutex);
840 return -EBUSY;
841 }
842 set_bit(WDM_WWAN_IN_USE, &desc->flags);
843 mutex_unlock(&wdm_mutex);
844
845 desc->manage_power(desc->intf, 1);
846
847 /* tx is allowed */
848 wwan_port_txon(port);
849
850 /* Start getting events */
851 return usb_submit_urb(desc->validity, GFP_KERNEL);
852}
853
854static void wdm_wwan_port_stop(struct wwan_port *port)
855{
856 struct wdm_device *desc = wwan_port_get_drvdata(port);
857
858 /* Stop all transfers and disable WWAN mode */
859 poison_urbs(desc);
860 desc->manage_power(desc->intf, 0);
861 clear_bit(WDM_READ, &desc->flags);
862 clear_bit(WDM_WWAN_IN_USE, &desc->flags);
863 unpoison_urbs(desc);
864}
865
866static void wdm_wwan_port_tx_complete(struct urb *urb)
867{
868 struct sk_buff *skb = urb->context;
869 struct wdm_device *desc = skb_shinfo(skb)->destructor_arg;
870
871 usb_autopm_put_interface(desc->intf);
872 wwan_port_txon(desc->wwanp);
873 kfree_skb(skb);
874}
875
876static int wdm_wwan_port_tx(struct wwan_port *port, struct sk_buff *skb)
877{
878 struct wdm_device *desc = wwan_port_get_drvdata(port);
879 struct usb_interface *intf = desc->intf;
880 struct usb_ctrlrequest *req = desc->orq;
881 int rv;
882
883 rv = usb_autopm_get_interface(intf);
884 if (rv)
885 return rv;
886
887 usb_fill_control_urb(
888 desc->command,
889 interface_to_usbdev(intf),
890 usb_sndctrlpipe(interface_to_usbdev(intf), 0),
891 (unsigned char *)req,
892 skb->data,
893 skb->len,
894 wdm_wwan_port_tx_complete,
895 skb
896 );
897
898 req->bRequestType = (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE);
899 req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
900 req->wValue = 0;
901 req->wIndex = desc->inum;
902 req->wLength = cpu_to_le16(skb->len);
903
904 skb_shinfo(skb)->destructor_arg = desc;
905
906 rv = usb_submit_urb(desc->command, GFP_KERNEL);
907 if (rv)
908 usb_autopm_put_interface(intf);
909 else /* One transfer at a time, stop TX until URB completion */
910 wwan_port_txoff(port);
911
912 return rv;
913}
914
915static const struct wwan_port_ops wdm_wwan_port_ops = {
916 .start = wdm_wwan_port_start,
917 .stop = wdm_wwan_port_stop,
918 .tx = wdm_wwan_port_tx,
919};
920
921static void wdm_wwan_init(struct wdm_device *desc)
922{
923 struct usb_interface *intf = desc->intf;
924 struct wwan_port *port;
925
926 /* Only register to WWAN core if protocol/type is known */
927 if (desc->wwanp_type == WWAN_PORT_UNKNOWN) {
928 dev_info(&intf->dev, "Unknown control protocol\n");
929 return;
930 }
931
932 port = wwan_create_port(&intf->dev, desc->wwanp_type, &wdm_wwan_port_ops,
933 NULL, desc);
934 if (IS_ERR(port)) {
935 dev_err(&intf->dev, "%s: Unable to create WWAN port\n",
936 dev_name(intf->usb_dev));
937 return;
938 }
939
940 desc->wwanp = port;
941}
942
943static void wdm_wwan_deinit(struct wdm_device *desc)
944{
945 if (!desc->wwanp)
946 return;
947
948 wwan_remove_port(desc->wwanp);
949 desc->wwanp = NULL;
950}
951
952static void wdm_wwan_rx(struct wdm_device *desc, int length)
953{
954 struct wwan_port *port = desc->wwanp;
955 struct sk_buff *skb;
956
957 /* Forward data to WWAN port */
958 skb = alloc_skb(length, GFP_ATOMIC);
959 if (!skb)
960 return;
961
962 skb_put_data(skb, desc->inbuf, length);
963 wwan_port_rx(port, skb);
964
965 /* inbuf has been copied, it is safe to check for outstanding data */
966 schedule_work(&desc->service_outs_intr);
967}
968#else /* CONFIG_WWAN */
969static void wdm_wwan_init(struct wdm_device *desc) {}
970static void wdm_wwan_deinit(struct wdm_device *desc) {}
971static void wdm_wwan_rx(struct wdm_device *desc, int length) {}
972#endif /* CONFIG_WWAN */
973
974/* --- error handling --- */
975static void wdm_rxwork(struct work_struct *work)
976{
977 struct wdm_device *desc = container_of(work, struct wdm_device, rxwork);
978 unsigned long flags;
979 int rv = 0;
980 int responding;
981
982 spin_lock_irqsave(&desc->iuspin, flags);
983 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
984 spin_unlock_irqrestore(&desc->iuspin, flags);
985 } else {
986 responding = test_and_set_bit(WDM_RESPONDING, &desc->flags);
987 spin_unlock_irqrestore(&desc->iuspin, flags);
988 if (!responding)
989 rv = usb_submit_urb(desc->response, GFP_KERNEL);
990 if (rv < 0 && rv != -EPERM) {
991 spin_lock_irqsave(&desc->iuspin, flags);
992 clear_bit(WDM_RESPONDING, &desc->flags);
993 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
994 schedule_work(&desc->rxwork);
995 spin_unlock_irqrestore(&desc->iuspin, flags);
996 }
997 }
998}
999
1000static void service_interrupt_work(struct work_struct *work)
1001{
1002 struct wdm_device *desc;
1003
1004 desc = container_of(work, struct wdm_device, service_outs_intr);
1005
1006 spin_lock_irq(&desc->iuspin);
1007 service_outstanding_interrupt(desc);
1008 if (!desc->resp_count) {
1009 set_bit(WDM_READ, &desc->flags);
1010 wake_up(&desc->wait);
1011 }
1012 spin_unlock_irq(&desc->iuspin);
1013}
1014
1015/* --- hotplug --- */
1016
1017static int wdm_create(struct usb_interface *intf, struct usb_endpoint_descriptor *ep,
1018 u16 bufsize, enum wwan_port_type type,
1019 int (*manage_power)(struct usb_interface *, int))
1020{
1021 int rv = -ENOMEM;
1022 struct wdm_device *desc;
1023
1024 desc = kzalloc(sizeof(struct wdm_device), GFP_KERNEL);
1025 if (!desc)
1026 goto out;
1027 INIT_LIST_HEAD(&desc->device_list);
1028 mutex_init(&desc->rlock);
1029 mutex_init(&desc->wlock);
1030 spin_lock_init(&desc->iuspin);
1031 init_waitqueue_head(&desc->wait);
1032 desc->wMaxCommand = bufsize;
1033 /* this will be expanded and needed in hardware endianness */
1034 desc->inum = cpu_to_le16((u16)intf->cur_altsetting->desc.bInterfaceNumber);
1035 desc->intf = intf;
1036 desc->wwanp_type = type;
1037 INIT_WORK(&desc->rxwork, wdm_rxwork);
1038 INIT_WORK(&desc->service_outs_intr, service_interrupt_work);
1039
1040 if (!usb_endpoint_is_int_in(ep)) {
1041 rv = -EINVAL;
1042 goto err;
1043 }
1044
1045 desc->wMaxPacketSize = usb_endpoint_maxp(ep);
1046
1047 desc->orq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
1048 if (!desc->orq)
1049 goto err;
1050 desc->irq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
1051 if (!desc->irq)
1052 goto err;
1053
1054 desc->validity = usb_alloc_urb(0, GFP_KERNEL);
1055 if (!desc->validity)
1056 goto err;
1057
1058 desc->response = usb_alloc_urb(0, GFP_KERNEL);
1059 if (!desc->response)
1060 goto err;
1061
1062 desc->command = usb_alloc_urb(0, GFP_KERNEL);
1063 if (!desc->command)
1064 goto err;
1065
1066 desc->ubuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
1067 if (!desc->ubuf)
1068 goto err;
1069
1070 desc->sbuf = kmalloc(desc->wMaxPacketSize, GFP_KERNEL);
1071 if (!desc->sbuf)
1072 goto err;
1073
1074 desc->inbuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
1075 if (!desc->inbuf)
1076 goto err;
1077
1078 usb_fill_int_urb(
1079 desc->validity,
1080 interface_to_usbdev(intf),
1081 usb_rcvintpipe(interface_to_usbdev(intf), ep->bEndpointAddress),
1082 desc->sbuf,
1083 desc->wMaxPacketSize,
1084 wdm_int_callback,
1085 desc,
1086 ep->bInterval
1087 );
1088
1089 desc->irq->bRequestType = (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE);
1090 desc->irq->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1091 desc->irq->wValue = 0;
1092 desc->irq->wIndex = desc->inum; /* already converted */
1093 desc->irq->wLength = cpu_to_le16(desc->wMaxCommand);
1094
1095 usb_fill_control_urb(
1096 desc->response,
1097 interface_to_usbdev(intf),
1098 /* using common endpoint 0 */
1099 usb_rcvctrlpipe(interface_to_usbdev(desc->intf), 0),
1100 (unsigned char *)desc->irq,
1101 desc->inbuf,
1102 desc->wMaxCommand,
1103 wdm_in_callback,
1104 desc
1105 );
1106
1107 desc->manage_power = manage_power;
1108
1109 spin_lock(&wdm_device_list_lock);
1110 list_add(&desc->device_list, &wdm_device_list);
1111 spin_unlock(&wdm_device_list_lock);
1112
1113 rv = usb_register_dev(intf, &wdm_class);
1114 if (rv < 0)
1115 goto err;
1116 else
1117 dev_info(&intf->dev, "%s: USB WDM device\n", dev_name(intf->usb_dev));
1118
1119 wdm_wwan_init(desc);
1120
1121out:
1122 return rv;
1123err:
1124 spin_lock(&wdm_device_list_lock);
1125 list_del(&desc->device_list);
1126 spin_unlock(&wdm_device_list_lock);
1127 cleanup(desc);
1128 return rv;
1129}
1130
1131static int wdm_manage_power(struct usb_interface *intf, int on)
1132{
1133 /* need autopm_get/put here to ensure the usbcore sees the new value */
1134 int rv = usb_autopm_get_interface(intf);
1135
1136 intf->needs_remote_wakeup = on;
1137 if (!rv)
1138 usb_autopm_put_interface(intf);
1139 return 0;
1140}
1141
1142static int wdm_probe(struct usb_interface *intf, const struct usb_device_id *id)
1143{
1144 int rv = -EINVAL;
1145 struct usb_host_interface *iface;
1146 struct usb_endpoint_descriptor *ep;
1147 struct usb_cdc_parsed_header hdr;
1148 u8 *buffer = intf->altsetting->extra;
1149 int buflen = intf->altsetting->extralen;
1150 u16 maxcom = WDM_DEFAULT_BUFSIZE;
1151
1152 if (!buffer)
1153 goto err;
1154
1155 cdc_parse_cdc_header(&hdr, intf, buffer, buflen);
1156
1157 if (hdr.usb_cdc_dmm_desc)
1158 maxcom = le16_to_cpu(hdr.usb_cdc_dmm_desc->wMaxCommand);
1159
1160 iface = intf->cur_altsetting;
1161 if (iface->desc.bNumEndpoints != 1)
1162 goto err;
1163 ep = &iface->endpoint[0].desc;
1164
1165 rv = wdm_create(intf, ep, maxcom, WWAN_PORT_UNKNOWN, &wdm_manage_power);
1166
1167err:
1168 return rv;
1169}
1170
1171/**
1172 * usb_cdc_wdm_register - register a WDM subdriver
1173 * @intf: usb interface the subdriver will associate with
1174 * @ep: interrupt endpoint to monitor for notifications
1175 * @bufsize: maximum message size to support for read/write
1176 * @type: Type/protocol of the transported data (MBIM, QMI...)
1177 * @manage_power: call-back invoked during open and release to
1178 * manage the device's power
1179 * Create WDM usb class character device and associate it with intf
1180 * without binding, allowing another driver to manage the interface.
1181 *
1182 * The subdriver will manage the given interrupt endpoint exclusively
1183 * and will issue control requests referring to the given intf. It
1184 * will otherwise avoid interferring, and in particular not do
1185 * usb_set_intfdata/usb_get_intfdata on intf.
1186 *
1187 * The return value is a pointer to the subdriver's struct usb_driver.
1188 * The registering driver is responsible for calling this subdriver's
1189 * disconnect, suspend, resume, pre_reset and post_reset methods from
1190 * its own.
1191 */
1192struct usb_driver *usb_cdc_wdm_register(struct usb_interface *intf,
1193 struct usb_endpoint_descriptor *ep,
1194 int bufsize, enum wwan_port_type type,
1195 int (*manage_power)(struct usb_interface *, int))
1196{
1197 int rv;
1198
1199 rv = wdm_create(intf, ep, bufsize, type, manage_power);
1200 if (rv < 0)
1201 goto err;
1202
1203 return &wdm_driver;
1204err:
1205 return ERR_PTR(rv);
1206}
1207EXPORT_SYMBOL(usb_cdc_wdm_register);
1208
1209static void wdm_disconnect(struct usb_interface *intf)
1210{
1211 struct wdm_device *desc;
1212 unsigned long flags;
1213
1214 usb_deregister_dev(intf, &wdm_class);
1215 desc = wdm_find_device(intf);
1216 mutex_lock(&wdm_mutex);
1217
1218 wdm_wwan_deinit(desc);
1219
1220 /* the spinlock makes sure no new urbs are generated in the callbacks */
1221 spin_lock_irqsave(&desc->iuspin, flags);
1222 set_bit(WDM_DISCONNECTING, &desc->flags);
1223 set_bit(WDM_READ, &desc->flags);
1224 spin_unlock_irqrestore(&desc->iuspin, flags);
1225 wake_up_all(&desc->wait);
1226 mutex_lock(&desc->rlock);
1227 mutex_lock(&desc->wlock);
1228 poison_urbs(desc);
1229 cancel_work_sync(&desc->rxwork);
1230 cancel_work_sync(&desc->service_outs_intr);
1231 mutex_unlock(&desc->wlock);
1232 mutex_unlock(&desc->rlock);
1233
1234 /* the desc->intf pointer used as list key is now invalid */
1235 spin_lock(&wdm_device_list_lock);
1236 list_del(&desc->device_list);
1237 spin_unlock(&wdm_device_list_lock);
1238
1239 if (!desc->count)
1240 cleanup(desc);
1241 else
1242 dev_dbg(&intf->dev, "%d open files - postponing cleanup\n", desc->count);
1243 mutex_unlock(&wdm_mutex);
1244}
1245
1246#ifdef CONFIG_PM
1247static int wdm_suspend(struct usb_interface *intf, pm_message_t message)
1248{
1249 struct wdm_device *desc = wdm_find_device(intf);
1250 int rv = 0;
1251
1252 dev_dbg(&desc->intf->dev, "wdm%d_suspend\n", intf->minor);
1253
1254 /* if this is an autosuspend the caller does the locking */
1255 if (!PMSG_IS_AUTO(message)) {
1256 mutex_lock(&desc->rlock);
1257 mutex_lock(&desc->wlock);
1258 }
1259 spin_lock_irq(&desc->iuspin);
1260
1261 if (PMSG_IS_AUTO(message) &&
1262 (test_bit(WDM_IN_USE, &desc->flags)
1263 || test_bit(WDM_RESPONDING, &desc->flags))) {
1264 spin_unlock_irq(&desc->iuspin);
1265 rv = -EBUSY;
1266 } else {
1267
1268 set_bit(WDM_SUSPENDING, &desc->flags);
1269 spin_unlock_irq(&desc->iuspin);
1270 /* callback submits work - order is essential */
1271 poison_urbs(desc);
1272 cancel_work_sync(&desc->rxwork);
1273 cancel_work_sync(&desc->service_outs_intr);
1274 unpoison_urbs(desc);
1275 }
1276 if (!PMSG_IS_AUTO(message)) {
1277 mutex_unlock(&desc->wlock);
1278 mutex_unlock(&desc->rlock);
1279 }
1280
1281 return rv;
1282}
1283#endif
1284
1285static int recover_from_urb_loss(struct wdm_device *desc)
1286{
1287 int rv = 0;
1288
1289 if (desc->count) {
1290 rv = usb_submit_urb(desc->validity, GFP_NOIO);
1291 if (rv < 0)
1292 dev_err(&desc->intf->dev,
1293 "Error resume submitting int urb - %d\n", rv);
1294 }
1295 return rv;
1296}
1297
1298#ifdef CONFIG_PM
1299static int wdm_resume(struct usb_interface *intf)
1300{
1301 struct wdm_device *desc = wdm_find_device(intf);
1302 int rv;
1303
1304 dev_dbg(&desc->intf->dev, "wdm%d_resume\n", intf->minor);
1305
1306 clear_bit(WDM_SUSPENDING, &desc->flags);
1307 rv = recover_from_urb_loss(desc);
1308
1309 return rv;
1310}
1311#endif
1312
1313static int wdm_pre_reset(struct usb_interface *intf)
1314{
1315 struct wdm_device *desc = wdm_find_device(intf);
1316
1317 /*
1318 * we notify everybody using poll of
1319 * an exceptional situation
1320 * must be done before recovery lest a spontaneous
1321 * message from the device is lost
1322 */
1323 spin_lock_irq(&desc->iuspin);
1324 set_bit(WDM_RESETTING, &desc->flags); /* inform read/write */
1325 set_bit(WDM_READ, &desc->flags); /* unblock read */
1326 clear_bit(WDM_IN_USE, &desc->flags); /* unblock write */
1327 desc->rerr = -EINTR;
1328 spin_unlock_irq(&desc->iuspin);
1329 wake_up_all(&desc->wait);
1330 mutex_lock(&desc->rlock);
1331 mutex_lock(&desc->wlock);
1332 poison_urbs(desc);
1333 cancel_work_sync(&desc->rxwork);
1334 cancel_work_sync(&desc->service_outs_intr);
1335 return 0;
1336}
1337
1338static int wdm_post_reset(struct usb_interface *intf)
1339{
1340 struct wdm_device *desc = wdm_find_device(intf);
1341 int rv;
1342
1343 unpoison_urbs(desc);
1344 clear_bit(WDM_OVERFLOW, &desc->flags);
1345 clear_bit(WDM_RESETTING, &desc->flags);
1346 rv = recover_from_urb_loss(desc);
1347 mutex_unlock(&desc->wlock);
1348 mutex_unlock(&desc->rlock);
1349 return rv;
1350}
1351
1352static struct usb_driver wdm_driver = {
1353 .name = "cdc_wdm",
1354 .probe = wdm_probe,
1355 .disconnect = wdm_disconnect,
1356#ifdef CONFIG_PM
1357 .suspend = wdm_suspend,
1358 .resume = wdm_resume,
1359 .reset_resume = wdm_resume,
1360#endif
1361 .pre_reset = wdm_pre_reset,
1362 .post_reset = wdm_post_reset,
1363 .id_table = wdm_ids,
1364 .supports_autosuspend = 1,
1365 .disable_hub_initiated_lpm = 1,
1366};
1367
1368module_usb_driver(wdm_driver);
1369
1370MODULE_AUTHOR(DRIVER_AUTHOR);
1371MODULE_DESCRIPTION(DRIVER_DESC);
1372MODULE_LICENSE("GPL");