blob: 72e2eb0304597fb83df0813b15ca6d8cd7c78580 [file] [log] [blame]
Oliver Neukumafba9372008-05-13 17:01:25 +02001/*
2 * cdc-wdm.c
3 *
4 * This driver supports USB CDC WCM Device Management.
5 *
Oliver Neukum052fbc02009-04-20 17:24:49 +02006 * Copyright (c) 2007-2009 Oliver Neukum
Oliver Neukumafba9372008-05-13 17:01:25 +02007 *
8 * Some code taken from cdc-acm.c
9 *
10 * Released under the GPLv2.
11 *
12 * Many thanks to Carl Nordbeck
13 */
14#include <linux/kernel.h>
15#include <linux/errno.h>
16#include <linux/slab.h>
17#include <linux/module.h>
Oliver Neukumafba9372008-05-13 17:01:25 +020018#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>
26
27/*
28 * Version Information
29 */
Oliver Neukum87d65e52008-06-19 14:20:18 +020030#define DRIVER_VERSION "v0.03"
Oliver Neukumafba9372008-05-13 17:01:25 +020031#define DRIVER_AUTHOR "Oliver Neukum"
Oliver Neukum87d65e52008-06-19 14:20:18 +020032#define DRIVER_DESC "USB Abstract Control Model driver for USB WCM Device Management"
Oliver Neukumafba9372008-05-13 17:01:25 +020033
Németh Márton6ef48522010-01-10 15:33:45 +010034static const struct usb_device_id wdm_ids[] = {
Oliver Neukumafba9372008-05-13 17:01:25 +020035 {
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
40 },
41 { }
42};
43
Oliver Neukumaa5380b2008-10-13 14:05:20 +020044MODULE_DEVICE_TABLE (usb, wdm_ids);
45
Oliver Neukumafba9372008-05-13 17:01:25 +020046#define WDM_MINOR_BASE 176
47
48
49#define WDM_IN_USE 1
50#define WDM_DISCONNECTING 2
51#define WDM_RESULT 3
52#define WDM_READ 4
53#define WDM_INT_STALL 5
54#define WDM_POLL_RUNNING 6
Oliver Neukum922a5ea2010-02-27 20:54:59 +010055#define WDM_RESPONDING 7
Oliver Neukumafba9372008-05-13 17:01:25 +020056
57
58#define WDM_MAX 16
59
60
61static DEFINE_MUTEX(wdm_mutex);
62
63/* --- method tables --- */
64
65struct wdm_device {
66 u8 *inbuf; /* buffer for response */
67 u8 *outbuf; /* buffer for command */
68 u8 *sbuf; /* buffer for status */
69 u8 *ubuf; /* buffer for copy to user space */
70
71 struct urb *command;
72 struct urb *response;
73 struct urb *validity;
74 struct usb_interface *intf;
75 struct usb_ctrlrequest *orq;
76 struct usb_ctrlrequest *irq;
77 spinlock_t iuspin;
78
79 unsigned long flags;
80 u16 bufsize;
81 u16 wMaxCommand;
82 u16 wMaxPacketSize;
83 u16 bMaxPacketSize0;
84 __le16 inum;
85 int reslength;
86 int length;
87 int read;
88 int count;
89 dma_addr_t shandle;
90 dma_addr_t ihandle;
Oliver Neukum860e41a2010-02-27 20:54:24 +010091 struct mutex lock;
Oliver Neukumafba9372008-05-13 17:01:25 +020092 wait_queue_head_t wait;
93 struct work_struct rxwork;
94 int werr;
95 int rerr;
96};
97
98static struct usb_driver wdm_driver;
99
100/* --- callbacks --- */
101static void wdm_out_callback(struct urb *urb)
102{
103 struct wdm_device *desc;
104 desc = urb->context;
105 spin_lock(&desc->iuspin);
106 desc->werr = urb->status;
107 spin_unlock(&desc->iuspin);
108 clear_bit(WDM_IN_USE, &desc->flags);
109 kfree(desc->outbuf);
110 wake_up(&desc->wait);
111}
112
113static void wdm_in_callback(struct urb *urb)
114{
115 struct wdm_device *desc = urb->context;
116 int status = urb->status;
117
118 spin_lock(&desc->iuspin);
Oliver Neukum922a5ea2010-02-27 20:54:59 +0100119 clear_bit(WDM_RESPONDING, &desc->flags);
Oliver Neukumafba9372008-05-13 17:01:25 +0200120
121 if (status) {
122 switch (status) {
123 case -ENOENT:
124 dev_dbg(&desc->intf->dev,
125 "nonzero urb status received: -ENOENT");
Oliver Neukum922a5ea2010-02-27 20:54:59 +0100126 goto skip_error;
Oliver Neukumafba9372008-05-13 17:01:25 +0200127 case -ECONNRESET:
128 dev_dbg(&desc->intf->dev,
129 "nonzero urb status received: -ECONNRESET");
Oliver Neukum922a5ea2010-02-27 20:54:59 +0100130 goto skip_error;
Oliver Neukumafba9372008-05-13 17:01:25 +0200131 case -ESHUTDOWN:
132 dev_dbg(&desc->intf->dev,
133 "nonzero urb status received: -ESHUTDOWN");
Oliver Neukum922a5ea2010-02-27 20:54:59 +0100134 goto skip_error;
Oliver Neukumafba9372008-05-13 17:01:25 +0200135 case -EPIPE:
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700136 dev_err(&desc->intf->dev,
137 "nonzero urb status received: -EPIPE\n");
Oliver Neukumafba9372008-05-13 17:01:25 +0200138 break;
139 default:
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700140 dev_err(&desc->intf->dev,
141 "Unexpected error %d\n", status);
Oliver Neukumafba9372008-05-13 17:01:25 +0200142 break;
143 }
144 }
145
146 desc->rerr = status;
147 desc->reslength = urb->actual_length;
148 memmove(desc->ubuf + desc->length, desc->inbuf, desc->reslength);
149 desc->length += desc->reslength;
Oliver Neukum922a5ea2010-02-27 20:54:59 +0100150skip_error:
Oliver Neukumafba9372008-05-13 17:01:25 +0200151 wake_up(&desc->wait);
152
153 set_bit(WDM_READ, &desc->flags);
154 spin_unlock(&desc->iuspin);
155}
156
157static void wdm_int_callback(struct urb *urb)
158{
159 int rv = 0;
160 int status = urb->status;
161 struct wdm_device *desc;
162 struct usb_ctrlrequest *req;
163 struct usb_cdc_notification *dr;
164
165 desc = urb->context;
166 req = desc->irq;
167 dr = (struct usb_cdc_notification *)desc->sbuf;
168
169 if (status) {
170 switch (status) {
171 case -ESHUTDOWN:
172 case -ENOENT:
173 case -ECONNRESET:
174 return; /* unplug */
175 case -EPIPE:
176 set_bit(WDM_INT_STALL, &desc->flags);
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700177 dev_err(&desc->intf->dev, "Stall on int endpoint\n");
Oliver Neukumafba9372008-05-13 17:01:25 +0200178 goto sw; /* halt is cleared in work */
179 default:
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700180 dev_err(&desc->intf->dev,
181 "nonzero urb status received: %d\n", status);
Oliver Neukumafba9372008-05-13 17:01:25 +0200182 break;
183 }
184 }
185
186 if (urb->actual_length < sizeof(struct usb_cdc_notification)) {
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700187 dev_err(&desc->intf->dev, "wdm_int_callback - %d bytes\n",
188 urb->actual_length);
Oliver Neukumafba9372008-05-13 17:01:25 +0200189 goto exit;
190 }
191
192 switch (dr->bNotificationType) {
193 case USB_CDC_NOTIFY_RESPONSE_AVAILABLE:
194 dev_dbg(&desc->intf->dev,
195 "NOTIFY_RESPONSE_AVAILABLE received: index %d len %d",
196 dr->wIndex, dr->wLength);
197 break;
198
199 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
200
201 dev_dbg(&desc->intf->dev,
202 "NOTIFY_NETWORK_CONNECTION %s network",
203 dr->wValue ? "connected to" : "disconnected from");
204 goto exit;
205 default:
206 clear_bit(WDM_POLL_RUNNING, &desc->flags);
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700207 dev_err(&desc->intf->dev,
208 "unknown notification %d received: index %d len %d\n",
Oliver Neukumafba9372008-05-13 17:01:25 +0200209 dr->bNotificationType, dr->wIndex, dr->wLength);
210 goto exit;
211 }
212
213 req->bRequestType = (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE);
214 req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
215 req->wValue = 0;
216 req->wIndex = desc->inum;
Oliver Neukum87d65e52008-06-19 14:20:18 +0200217 req->wLength = cpu_to_le16(desc->wMaxCommand);
Oliver Neukumafba9372008-05-13 17:01:25 +0200218
219 usb_fill_control_urb(
220 desc->response,
221 interface_to_usbdev(desc->intf),
222 /* using common endpoint 0 */
223 usb_rcvctrlpipe(interface_to_usbdev(desc->intf), 0),
224 (unsigned char *)req,
225 desc->inbuf,
Oliver Neukum87d65e52008-06-19 14:20:18 +0200226 desc->wMaxCommand,
Oliver Neukumafba9372008-05-13 17:01:25 +0200227 wdm_in_callback,
228 desc
229 );
230 desc->response->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
231 spin_lock(&desc->iuspin);
232 clear_bit(WDM_READ, &desc->flags);
Oliver Neukum922a5ea2010-02-27 20:54:59 +0100233 set_bit(WDM_RESPONDING, &desc->flags);
Oliver Neukumafba9372008-05-13 17:01:25 +0200234 if (!test_bit(WDM_DISCONNECTING, &desc->flags)) {
235 rv = usb_submit_urb(desc->response, GFP_ATOMIC);
236 dev_dbg(&desc->intf->dev, "%s: usb_submit_urb %d",
237 __func__, rv);
238 }
239 spin_unlock(&desc->iuspin);
240 if (rv < 0) {
Oliver Neukum922a5ea2010-02-27 20:54:59 +0100241 clear_bit(WDM_RESPONDING, &desc->flags);
Oliver Neukumafba9372008-05-13 17:01:25 +0200242 if (rv == -EPERM)
243 return;
244 if (rv == -ENOMEM) {
245sw:
246 rv = schedule_work(&desc->rxwork);
247 if (rv)
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700248 dev_err(&desc->intf->dev,
249 "Cannot schedule work\n");
Oliver Neukumafba9372008-05-13 17:01:25 +0200250 }
251 }
252exit:
253 rv = usb_submit_urb(urb, GFP_ATOMIC);
254 if (rv)
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700255 dev_err(&desc->intf->dev,
256 "%s - usb_submit_urb failed with result %d\n",
257 __func__, rv);
Oliver Neukumafba9372008-05-13 17:01:25 +0200258
259}
260
261static void kill_urbs(struct wdm_device *desc)
262{
Oliver Neukum17d80d52008-06-24 15:56:10 +0200263 /* the order here is essential */
Oliver Neukumafba9372008-05-13 17:01:25 +0200264 usb_kill_urb(desc->command);
265 usb_kill_urb(desc->validity);
266 usb_kill_urb(desc->response);
267}
268
269static void free_urbs(struct wdm_device *desc)
270{
271 usb_free_urb(desc->validity);
272 usb_free_urb(desc->response);
273 usb_free_urb(desc->command);
274}
275
276static void cleanup(struct wdm_device *desc)
277{
278 usb_buffer_free(interface_to_usbdev(desc->intf),
279 desc->wMaxPacketSize,
280 desc->sbuf,
281 desc->validity->transfer_dma);
282 usb_buffer_free(interface_to_usbdev(desc->intf),
Oliver Neukum87d65e52008-06-19 14:20:18 +0200283 desc->wMaxCommand,
Oliver Neukumafba9372008-05-13 17:01:25 +0200284 desc->inbuf,
285 desc->response->transfer_dma);
286 kfree(desc->orq);
287 kfree(desc->irq);
288 kfree(desc->ubuf);
289 free_urbs(desc);
290 kfree(desc);
291}
292
293static ssize_t wdm_write
294(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
295{
296 u8 *buf;
297 int rv = -EMSGSIZE, r, we;
298 struct wdm_device *desc = file->private_data;
299 struct usb_ctrlrequest *req;
300
301 if (count > desc->wMaxCommand)
302 count = desc->wMaxCommand;
303
304 spin_lock_irq(&desc->iuspin);
305 we = desc->werr;
306 desc->werr = 0;
307 spin_unlock_irq(&desc->iuspin);
308 if (we < 0)
309 return -EIO;
310
Oliver Neukum860e41a2010-02-27 20:54:24 +0100311 desc->outbuf = buf = kmalloc(count, GFP_KERNEL);
312 if (!buf) {
313 rv = -ENOMEM;
Oliver Neukumafba9372008-05-13 17:01:25 +0200314 goto outnl;
Oliver Neukum860e41a2010-02-27 20:54:24 +0100315 }
316
317 r = copy_from_user(buf, buffer, count);
318 if (r > 0) {
319 kfree(buf);
320 rv = -EFAULT;
321 goto outnl;
322 }
323
324 /* concurrent writes and disconnect */
325 r = mutex_lock_interruptible(&desc->lock);
326 rv = -ERESTARTSYS;
327 if (r) {
328 kfree(buf);
329 goto outnl;
330 }
331
332 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
333 kfree(buf);
334 rv = -ENODEV;
335 goto outnp;
336 }
Oliver Neukumafba9372008-05-13 17:01:25 +0200337
Oliver Neukum17d80d52008-06-24 15:56:10 +0200338 r = usb_autopm_get_interface(desc->intf);
Oliver Neukum860e41a2010-02-27 20:54:24 +0100339 if (r < 0) {
340 kfree(buf);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200341 goto outnp;
Oliver Neukum860e41a2010-02-27 20:54:24 +0100342 }
Oliver Neukum7f1dc312009-09-09 10:12:48 +0200343
344 if (!file->f_flags && O_NONBLOCK)
345 r = wait_event_interruptible(desc->wait, !test_bit(WDM_IN_USE,
346 &desc->flags));
347 else
348 if (test_bit(WDM_IN_USE, &desc->flags))
349 r = -EAGAIN;
Oliver Neukum860e41a2010-02-27 20:54:24 +0100350 if (r < 0) {
Oliver Neukumafba9372008-05-13 17:01:25 +0200351 kfree(buf);
Oliver Neukumafba9372008-05-13 17:01:25 +0200352 goto out;
353 }
354
355 req = desc->orq;
356 usb_fill_control_urb(
357 desc->command,
358 interface_to_usbdev(desc->intf),
359 /* using common endpoint 0 */
360 usb_sndctrlpipe(interface_to_usbdev(desc->intf), 0),
361 (unsigned char *)req,
362 buf,
363 count,
364 wdm_out_callback,
365 desc
366 );
367
368 req->bRequestType = (USB_DIR_OUT | USB_TYPE_CLASS |
369 USB_RECIP_INTERFACE);
370 req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
371 req->wValue = 0;
372 req->wIndex = desc->inum;
373 req->wLength = cpu_to_le16(count);
374 set_bit(WDM_IN_USE, &desc->flags);
375
376 rv = usb_submit_urb(desc->command, GFP_KERNEL);
377 if (rv < 0) {
378 kfree(buf);
379 clear_bit(WDM_IN_USE, &desc->flags);
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700380 dev_err(&desc->intf->dev, "Tx URB error: %d\n", rv);
Oliver Neukumafba9372008-05-13 17:01:25 +0200381 } else {
382 dev_dbg(&desc->intf->dev, "Tx URB has been submitted index=%d",
383 req->wIndex);
384 }
385out:
Oliver Neukum17d80d52008-06-24 15:56:10 +0200386 usb_autopm_put_interface(desc->intf);
387outnp:
Oliver Neukum860e41a2010-02-27 20:54:24 +0100388 mutex_unlock(&desc->lock);
Oliver Neukumafba9372008-05-13 17:01:25 +0200389outnl:
390 return rv < 0 ? rv : count;
391}
392
393static ssize_t wdm_read
394(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
395{
Oliver Neukum7f1dc312009-09-09 10:12:48 +0200396 int rv, cntr = 0;
Oliver Neukumafba9372008-05-13 17:01:25 +0200397 int i = 0;
398 struct wdm_device *desc = file->private_data;
399
400
Oliver Neukum860e41a2010-02-27 20:54:24 +0100401 rv = mutex_lock_interruptible(&desc->lock); /*concurrent reads */
Oliver Neukumafba9372008-05-13 17:01:25 +0200402 if (rv < 0)
403 return -ERESTARTSYS;
404
405 if (desc->length == 0) {
406 desc->read = 0;
407retry:
Oliver Neukum7f1dc312009-09-09 10:12:48 +0200408 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
409 rv = -ENODEV;
410 goto err;
411 }
Oliver Neukumafba9372008-05-13 17:01:25 +0200412 i++;
Oliver Neukum7f1dc312009-09-09 10:12:48 +0200413 if (file->f_flags & O_NONBLOCK) {
414 if (!test_bit(WDM_READ, &desc->flags)) {
415 rv = cntr ? cntr : -EAGAIN;
416 goto err;
417 }
418 rv = 0;
419 } else {
420 rv = wait_event_interruptible(desc->wait,
421 test_bit(WDM_READ, &desc->flags));
422 }
Oliver Neukumafba9372008-05-13 17:01:25 +0200423
Oliver Neukum7f1dc312009-09-09 10:12:48 +0200424 /* may have happened while we slept */
Oliver Neukum17d80d52008-06-24 15:56:10 +0200425 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
426 rv = -ENODEV;
427 goto err;
428 }
429 usb_mark_last_busy(interface_to_usbdev(desc->intf));
Oliver Neukumafba9372008-05-13 17:01:25 +0200430 if (rv < 0) {
431 rv = -ERESTARTSYS;
432 goto err;
433 }
434
435 spin_lock_irq(&desc->iuspin);
436
437 if (desc->rerr) { /* read completed, error happened */
Oliver Neukumafba9372008-05-13 17:01:25 +0200438 desc->rerr = 0;
439 spin_unlock_irq(&desc->iuspin);
Oliver Neukumafba9372008-05-13 17:01:25 +0200440 rv = -EIO;
441 goto err;
442 }
443 /*
444 * recheck whether we've lost the race
445 * against the completion handler
446 */
447 if (!test_bit(WDM_READ, &desc->flags)) { /* lost race */
448 spin_unlock_irq(&desc->iuspin);
449 goto retry;
450 }
451 if (!desc->reslength) { /* zero length read */
452 spin_unlock_irq(&desc->iuspin);
453 goto retry;
454 }
455 clear_bit(WDM_READ, &desc->flags);
456 spin_unlock_irq(&desc->iuspin);
457 }
458
459 cntr = count > desc->length ? desc->length : count;
460 rv = copy_to_user(buffer, desc->ubuf, cntr);
461 if (rv > 0) {
462 rv = -EFAULT;
463 goto err;
464 }
465
466 for (i = 0; i < desc->length - cntr; i++)
467 desc->ubuf[i] = desc->ubuf[i + cntr];
468
469 desc->length -= cntr;
Oliver Neukum87d65e52008-06-19 14:20:18 +0200470 /* in case we had outstanding data */
471 if (!desc->length)
472 clear_bit(WDM_READ, &desc->flags);
Oliver Neukumafba9372008-05-13 17:01:25 +0200473 rv = cntr;
474
475err:
Oliver Neukum860e41a2010-02-27 20:54:24 +0100476 mutex_unlock(&desc->lock);
Oliver Neukumafba9372008-05-13 17:01:25 +0200477 return rv;
478}
479
480static int wdm_flush(struct file *file, fl_owner_t id)
481{
482 struct wdm_device *desc = file->private_data;
483
484 wait_event(desc->wait, !test_bit(WDM_IN_USE, &desc->flags));
485 if (desc->werr < 0)
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700486 dev_err(&desc->intf->dev, "Error in flush path: %d\n",
487 desc->werr);
Oliver Neukumafba9372008-05-13 17:01:25 +0200488
489 return desc->werr;
490}
491
492static unsigned int wdm_poll(struct file *file, struct poll_table_struct *wait)
493{
494 struct wdm_device *desc = file->private_data;
495 unsigned long flags;
496 unsigned int mask = 0;
497
498 spin_lock_irqsave(&desc->iuspin, flags);
499 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
500 mask = POLLERR;
501 spin_unlock_irqrestore(&desc->iuspin, flags);
502 goto desc_out;
503 }
504 if (test_bit(WDM_READ, &desc->flags))
505 mask = POLLIN | POLLRDNORM;
506 if (desc->rerr || desc->werr)
507 mask |= POLLERR;
508 if (!test_bit(WDM_IN_USE, &desc->flags))
509 mask |= POLLOUT | POLLWRNORM;
510 spin_unlock_irqrestore(&desc->iuspin, flags);
511
512 poll_wait(file, &desc->wait, wait);
513
514desc_out:
515 return mask;
516}
517
518static int wdm_open(struct inode *inode, struct file *file)
519{
520 int minor = iminor(inode);
521 int rv = -ENODEV;
522 struct usb_interface *intf;
523 struct wdm_device *desc;
524
525 mutex_lock(&wdm_mutex);
526 intf = usb_find_interface(&wdm_driver, minor);
527 if (!intf)
528 goto out;
529
530 desc = usb_get_intfdata(intf);
531 if (test_bit(WDM_DISCONNECTING, &desc->flags))
532 goto out;
Oliver Neukumafba9372008-05-13 17:01:25 +0200533 file->private_data = desc;
534
Oliver Neukum17d80d52008-06-24 15:56:10 +0200535 rv = usb_autopm_get_interface(desc->intf);
Oliver Neukumafba9372008-05-13 17:01:25 +0200536 if (rv < 0) {
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700537 dev_err(&desc->intf->dev, "Error autopm - %d\n", rv);
Oliver Neukumafba9372008-05-13 17:01:25 +0200538 goto out;
539 }
Oliver Neukum17d80d52008-06-24 15:56:10 +0200540 intf->needs_remote_wakeup = 1;
Oliver Neukumafba9372008-05-13 17:01:25 +0200541
Oliver Neukum860e41a2010-02-27 20:54:24 +0100542 mutex_lock(&desc->lock);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200543 if (!desc->count++) {
544 rv = usb_submit_urb(desc->validity, GFP_KERNEL);
545 if (rv < 0) {
546 desc->count--;
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700547 dev_err(&desc->intf->dev,
548 "Error submitting int urb - %d\n", rv);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200549 }
550 } else {
551 rv = 0;
552 }
Oliver Neukum860e41a2010-02-27 20:54:24 +0100553 mutex_unlock(&desc->lock);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200554 usb_autopm_put_interface(desc->intf);
Oliver Neukumafba9372008-05-13 17:01:25 +0200555out:
556 mutex_unlock(&wdm_mutex);
557 return rv;
558}
559
560static int wdm_release(struct inode *inode, struct file *file)
561{
562 struct wdm_device *desc = file->private_data;
563
564 mutex_lock(&wdm_mutex);
Oliver Neukum860e41a2010-02-27 20:54:24 +0100565 mutex_lock(&desc->lock);
Oliver Neukumafba9372008-05-13 17:01:25 +0200566 desc->count--;
Oliver Neukum860e41a2010-02-27 20:54:24 +0100567 mutex_unlock(&desc->lock);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200568
Oliver Neukumafba9372008-05-13 17:01:25 +0200569 if (!desc->count) {
570 dev_dbg(&desc->intf->dev, "wdm_release: cleanup");
571 kill_urbs(desc);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200572 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
573 desc->intf->needs_remote_wakeup = 0;
Oliver Neukumafba9372008-05-13 17:01:25 +0200574 }
575 mutex_unlock(&wdm_mutex);
576 return 0;
577}
578
579static const struct file_operations wdm_fops = {
580 .owner = THIS_MODULE,
581 .read = wdm_read,
582 .write = wdm_write,
583 .open = wdm_open,
584 .flush = wdm_flush,
585 .release = wdm_release,
586 .poll = wdm_poll
587};
588
589static struct usb_class_driver wdm_class = {
590 .name = "cdc-wdm%d",
591 .fops = &wdm_fops,
592 .minor_base = WDM_MINOR_BASE,
593};
594
595/* --- error handling --- */
596static void wdm_rxwork(struct work_struct *work)
597{
598 struct wdm_device *desc = container_of(work, struct wdm_device, rxwork);
599 unsigned long flags;
600 int rv;
601
602 spin_lock_irqsave(&desc->iuspin, flags);
603 if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
604 spin_unlock_irqrestore(&desc->iuspin, flags);
605 } else {
606 spin_unlock_irqrestore(&desc->iuspin, flags);
607 rv = usb_submit_urb(desc->response, GFP_KERNEL);
608 if (rv < 0 && rv != -EPERM) {
609 spin_lock_irqsave(&desc->iuspin, flags);
610 if (!test_bit(WDM_DISCONNECTING, &desc->flags))
611 schedule_work(&desc->rxwork);
612 spin_unlock_irqrestore(&desc->iuspin, flags);
613 }
614 }
615}
616
617/* --- hotplug --- */
618
619static int wdm_probe(struct usb_interface *intf, const struct usb_device_id *id)
620{
621 int rv = -EINVAL;
622 struct usb_device *udev = interface_to_usbdev(intf);
623 struct wdm_device *desc;
624 struct usb_host_interface *iface;
625 struct usb_endpoint_descriptor *ep;
626 struct usb_cdc_dmm_desc *dmhd;
627 u8 *buffer = intf->altsetting->extra;
628 int buflen = intf->altsetting->extralen;
629 u16 maxcom = 0;
630
631 if (!buffer)
632 goto out;
633
Oliver Neukum052fbc02009-04-20 17:24:49 +0200634 while (buflen > 2) {
Oliver Neukumafba9372008-05-13 17:01:25 +0200635 if (buffer [1] != USB_DT_CS_INTERFACE) {
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700636 dev_err(&intf->dev, "skipping garbage\n");
Oliver Neukumafba9372008-05-13 17:01:25 +0200637 goto next_desc;
638 }
639
640 switch (buffer [2]) {
641 case USB_CDC_HEADER_TYPE:
642 break;
643 case USB_CDC_DMM_TYPE:
644 dmhd = (struct usb_cdc_dmm_desc *)buffer;
645 maxcom = le16_to_cpu(dmhd->wMaxCommand);
646 dev_dbg(&intf->dev,
647 "Finding maximum buffer length: %d", maxcom);
648 break;
649 default:
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700650 dev_err(&intf->dev,
651 "Ignoring extra header, type %d, length %d\n",
Oliver Neukumafba9372008-05-13 17:01:25 +0200652 buffer[2], buffer[0]);
653 break;
654 }
655next_desc:
656 buflen -= buffer[0];
657 buffer += buffer[0];
658 }
659
660 rv = -ENOMEM;
661 desc = kzalloc(sizeof(struct wdm_device), GFP_KERNEL);
662 if (!desc)
663 goto out;
Oliver Neukum860e41a2010-02-27 20:54:24 +0100664 mutex_init(&desc->lock);
Oliver Neukumafba9372008-05-13 17:01:25 +0200665 spin_lock_init(&desc->iuspin);
666 init_waitqueue_head(&desc->wait);
667 desc->wMaxCommand = maxcom;
Oliver Neukum052fbc02009-04-20 17:24:49 +0200668 /* this will be expanded and needed in hardware endianness */
Oliver Neukumafba9372008-05-13 17:01:25 +0200669 desc->inum = cpu_to_le16((u16)intf->cur_altsetting->desc.bInterfaceNumber);
670 desc->intf = intf;
671 INIT_WORK(&desc->rxwork, wdm_rxwork);
672
Oliver Neukum052fbc02009-04-20 17:24:49 +0200673 rv = -EINVAL;
674 iface = intf->cur_altsetting;
675 if (iface->desc.bNumEndpoints != 1)
Oliver Neukumafba9372008-05-13 17:01:25 +0200676 goto err;
Oliver Neukum052fbc02009-04-20 17:24:49 +0200677 ep = &iface->endpoint[0].desc;
678 if (!ep || !usb_endpoint_is_int_in(ep))
679 goto err;
Oliver Neukumafba9372008-05-13 17:01:25 +0200680
Al Virofa4144b2008-06-02 10:59:02 +0100681 desc->wMaxPacketSize = le16_to_cpu(ep->wMaxPacketSize);
682 desc->bMaxPacketSize0 = udev->descriptor.bMaxPacketSize0;
Oliver Neukumafba9372008-05-13 17:01:25 +0200683
684 desc->orq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
685 if (!desc->orq)
686 goto err;
687 desc->irq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
688 if (!desc->irq)
689 goto err;
690
691 desc->validity = usb_alloc_urb(0, GFP_KERNEL);
692 if (!desc->validity)
693 goto err;
694
695 desc->response = usb_alloc_urb(0, GFP_KERNEL);
696 if (!desc->response)
697 goto err;
698
699 desc->command = usb_alloc_urb(0, GFP_KERNEL);
700 if (!desc->command)
701 goto err;
702
703 desc->ubuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
704 if (!desc->ubuf)
705 goto err;
706
707 desc->sbuf = usb_buffer_alloc(interface_to_usbdev(intf),
708 desc->wMaxPacketSize,
709 GFP_KERNEL,
710 &desc->validity->transfer_dma);
711 if (!desc->sbuf)
712 goto err;
713
714 desc->inbuf = usb_buffer_alloc(interface_to_usbdev(intf),
715 desc->bMaxPacketSize0,
716 GFP_KERNEL,
717 &desc->response->transfer_dma);
718 if (!desc->inbuf)
719 goto err2;
720
721 usb_fill_int_urb(
722 desc->validity,
723 interface_to_usbdev(intf),
724 usb_rcvintpipe(interface_to_usbdev(intf), ep->bEndpointAddress),
725 desc->sbuf,
726 desc->wMaxPacketSize,
727 wdm_int_callback,
728 desc,
729 ep->bInterval
730 );
731 desc->validity->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
732
733 usb_set_intfdata(intf, desc);
734 rv = usb_register_dev(intf, &wdm_class);
Oliver Neukumafba9372008-05-13 17:01:25 +0200735 if (rv < 0)
Oliver Neukum052fbc02009-04-20 17:24:49 +0200736 goto err3;
737 else
738 dev_info(&intf->dev, "cdc-wdm%d: USB WDM device\n",
739 intf->minor - WDM_MINOR_BASE);
Oliver Neukumafba9372008-05-13 17:01:25 +0200740out:
741 return rv;
Oliver Neukum052fbc02009-04-20 17:24:49 +0200742err3:
743 usb_set_intfdata(intf, NULL);
744 usb_buffer_free(interface_to_usbdev(desc->intf),
745 desc->bMaxPacketSize0,
746 desc->inbuf,
747 desc->response->transfer_dma);
Oliver Neukumafba9372008-05-13 17:01:25 +0200748err2:
749 usb_buffer_free(interface_to_usbdev(desc->intf),
750 desc->wMaxPacketSize,
751 desc->sbuf,
752 desc->validity->transfer_dma);
753err:
754 free_urbs(desc);
755 kfree(desc->ubuf);
756 kfree(desc->orq);
757 kfree(desc->irq);
758 kfree(desc);
759 return rv;
760}
761
762static void wdm_disconnect(struct usb_interface *intf)
763{
764 struct wdm_device *desc;
765 unsigned long flags;
766
767 usb_deregister_dev(intf, &wdm_class);
768 mutex_lock(&wdm_mutex);
769 desc = usb_get_intfdata(intf);
770
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);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200775 /* to terminate pending flushes */
Oliver Neukumafba9372008-05-13 17:01:25 +0200776 clear_bit(WDM_IN_USE, &desc->flags);
777 spin_unlock_irqrestore(&desc->iuspin, flags);
778 cancel_work_sync(&desc->rxwork);
Oliver Neukum860e41a2010-02-27 20:54:24 +0100779 mutex_lock(&desc->lock);
Oliver Neukumafba9372008-05-13 17:01:25 +0200780 kill_urbs(desc);
Oliver Neukum860e41a2010-02-27 20:54:24 +0100781 mutex_unlock(&desc->lock);
Oliver Neukumafba9372008-05-13 17:01:25 +0200782 wake_up_all(&desc->wait);
783 if (!desc->count)
784 cleanup(desc);
785 mutex_unlock(&wdm_mutex);
786}
787
Oliver Neukum17d80d52008-06-24 15:56:10 +0200788static int wdm_suspend(struct usb_interface *intf, pm_message_t message)
789{
790 struct wdm_device *desc = usb_get_intfdata(intf);
791 int rv = 0;
792
793 dev_dbg(&desc->intf->dev, "wdm%d_suspend\n", intf->minor);
794
Oliver Neukum860e41a2010-02-27 20:54:24 +0100795 mutex_lock(&desc->lock);
Oliver Neukum35758582008-07-01 19:10:08 +0200796#ifdef CONFIG_PM
Alan Stern65bfd292008-11-25 16:39:18 -0500797 if ((message.event & PM_EVENT_AUTO) &&
Oliver Neukum922a5ea2010-02-27 20:54:59 +0100798 (test_bit(WDM_IN_USE, &desc->flags)
799 || test_bit(WDM_RESPONDING, &desc->flags))) {
Oliver Neukum17d80d52008-06-24 15:56:10 +0200800 rv = -EBUSY;
801 } else {
Oliver Neukum35758582008-07-01 19:10:08 +0200802#endif
Oliver Neukum17d80d52008-06-24 15:56:10 +0200803 cancel_work_sync(&desc->rxwork);
804 kill_urbs(desc);
Oliver Neukum35758582008-07-01 19:10:08 +0200805#ifdef CONFIG_PM
Oliver Neukum17d80d52008-06-24 15:56:10 +0200806 }
Oliver Neukum35758582008-07-01 19:10:08 +0200807#endif
Oliver Neukum860e41a2010-02-27 20:54:24 +0100808 mutex_unlock(&desc->lock);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200809
810 return rv;
811}
812
813static int recover_from_urb_loss(struct wdm_device *desc)
814{
815 int rv = 0;
816
817 if (desc->count) {
818 rv = usb_submit_urb(desc->validity, GFP_NOIO);
819 if (rv < 0)
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -0700820 dev_err(&desc->intf->dev,
821 "Error resume submitting int urb - %d\n", rv);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200822 }
823 return rv;
824}
825static int wdm_resume(struct usb_interface *intf)
826{
827 struct wdm_device *desc = usb_get_intfdata(intf);
828 int rv;
829
830 dev_dbg(&desc->intf->dev, "wdm%d_resume\n", intf->minor);
Oliver Neukum860e41a2010-02-27 20:54:24 +0100831 mutex_lock(&desc->lock);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200832 rv = recover_from_urb_loss(desc);
Oliver Neukum860e41a2010-02-27 20:54:24 +0100833 mutex_unlock(&desc->lock);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200834 return rv;
835}
836
837static int wdm_pre_reset(struct usb_interface *intf)
838{
839 struct wdm_device *desc = usb_get_intfdata(intf);
840
Oliver Neukum860e41a2010-02-27 20:54:24 +0100841 mutex_lock(&desc->lock);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200842 return 0;
843}
844
845static int wdm_post_reset(struct usb_interface *intf)
846{
847 struct wdm_device *desc = usb_get_intfdata(intf);
848 int rv;
849
850 rv = recover_from_urb_loss(desc);
Oliver Neukum860e41a2010-02-27 20:54:24 +0100851 mutex_unlock(&desc->lock);
Oliver Neukum17d80d52008-06-24 15:56:10 +0200852 return 0;
853}
854
Oliver Neukumafba9372008-05-13 17:01:25 +0200855static struct usb_driver wdm_driver = {
856 .name = "cdc_wdm",
857 .probe = wdm_probe,
858 .disconnect = wdm_disconnect,
Oliver Neukum17d80d52008-06-24 15:56:10 +0200859 .suspend = wdm_suspend,
860 .resume = wdm_resume,
861 .reset_resume = wdm_resume,
862 .pre_reset = wdm_pre_reset,
863 .post_reset = wdm_post_reset,
Oliver Neukumafba9372008-05-13 17:01:25 +0200864 .id_table = wdm_ids,
Oliver Neukum17d80d52008-06-24 15:56:10 +0200865 .supports_autosuspend = 1,
Oliver Neukumafba9372008-05-13 17:01:25 +0200866};
867
868/* --- low level module stuff --- */
869
870static int __init wdm_init(void)
871{
872 int rv;
873
874 rv = usb_register(&wdm_driver);
875
876 return rv;
877}
878
879static void __exit wdm_exit(void)
880{
881 usb_deregister(&wdm_driver);
882}
883
884module_init(wdm_init);
885module_exit(wdm_exit);
886
887MODULE_AUTHOR(DRIVER_AUTHOR);
Oliver Neukum87d65e52008-06-19 14:20:18 +0200888MODULE_DESCRIPTION(DRIVER_DESC);
Oliver Neukumafba9372008-05-13 17:01:25 +0200889MODULE_LICENSE("GPL");