Linux Audio

Check our new training course

Loading...
v5.9
   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");
v3.5.6
 
   1/*
   2 * cdc-wdm.c
   3 *
   4 * This driver supports USB CDC WCM Device Management.
   5 *
   6 * Copyright (c) 2007-2009 Oliver Neukum
   7 *
   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>
  18#include <linux/mutex.h>
  19#include <linux/uaccess.h>
  20#include <linux/bitops.h>
  21#include <linux/poll.h>
  22#include <linux/usb.h>
  23#include <linux/usb/cdc.h>
  24#include <asm/byteorder.h>
  25#include <asm/unaligned.h>
  26#include <linux/usb/cdc-wdm.h>
  27
  28/*
  29 * Version Information
  30 */
  31#define DRIVER_VERSION "v0.03"
  32#define DRIVER_AUTHOR "Oliver Neukum"
  33#define DRIVER_DESC "USB Abstract Control Model driver for USB WCM Device Management"
  34
  35#define HUAWEI_VENDOR_ID	0x12D1
  36
  37static const struct usb_device_id wdm_ids[] = {
  38	{
  39		.match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
  40				 USB_DEVICE_ID_MATCH_INT_SUBCLASS,
  41		.bInterfaceClass = USB_CLASS_COMM,
  42		.bInterfaceSubClass = USB_CDC_SUBCLASS_DMM
  43	},
  44	{
  45		/* 
  46		 * Huawei E392, E398 and possibly other Qualcomm based modems
  47		 * embed the Qualcomm QMI protocol inside CDC on CDC ECM like
  48		 * control interfaces.  Userspace access to this is required
  49		 * to configure the accompanying data interface
  50		 */
  51		.match_flags        = USB_DEVICE_ID_MATCH_VENDOR |
  52					USB_DEVICE_ID_MATCH_INT_INFO,
  53		.idVendor           = HUAWEI_VENDOR_ID,
  54		.bInterfaceClass    = USB_CLASS_VENDOR_SPEC,
  55		.bInterfaceSubClass = 1,
  56		.bInterfaceProtocol = 9, /* NOTE: CDC ECM control interface! */
  57	},
  58	{
  59		 /* Vodafone/Huawei K5005 (12d1:14c8) and similar modems */
  60		.match_flags        = USB_DEVICE_ID_MATCH_VENDOR |
  61				      USB_DEVICE_ID_MATCH_INT_INFO,
  62		.idVendor           = HUAWEI_VENDOR_ID,
  63		.bInterfaceClass    = USB_CLASS_VENDOR_SPEC,
  64		.bInterfaceSubClass = 1,
  65		.bInterfaceProtocol = 57, /* NOTE: CDC ECM control interface! */
  66	},
  67	{ }
  68};
  69
  70MODULE_DEVICE_TABLE (usb, wdm_ids);
  71
  72#define WDM_MINOR_BASE	176
  73
  74
  75#define WDM_IN_USE		1
  76#define WDM_DISCONNECTING	2
  77#define WDM_RESULT		3
  78#define WDM_READ		4
  79#define WDM_INT_STALL		5
  80#define WDM_POLL_RUNNING	6
  81#define WDM_RESPONDING		7
  82#define WDM_SUSPENDING		8
  83#define WDM_RESETTING		9
 
  84
  85#define WDM_MAX			16
  86
  87/* CDC-WMC r1.1 requires wMaxCommand to be "at least 256 decimal (0x100)" */
  88#define WDM_DEFAULT_BUFSIZE	256
  89
  90static DEFINE_MUTEX(wdm_mutex);
  91static DEFINE_SPINLOCK(wdm_device_list_lock);
  92static LIST_HEAD(wdm_device_list);
  93
  94/* --- method tables --- */
  95
  96struct wdm_device {
  97	u8			*inbuf; /* buffer for response */
  98	u8			*outbuf; /* buffer for command */
  99	u8			*sbuf; /* buffer for status */
 100	u8			*ubuf; /* buffer for copy to user space */
 101
 102	struct urb		*command;
 103	struct urb		*response;
 104	struct urb		*validity;
 105	struct usb_interface	*intf;
 106	struct usb_ctrlrequest	*orq;
 107	struct usb_ctrlrequest	*irq;
 108	spinlock_t		iuspin;
 109
 110	unsigned long		flags;
 111	u16			bufsize;
 112	u16			wMaxCommand;
 113	u16			wMaxPacketSize;
 114	__le16			inum;
 115	int			reslength;
 116	int			length;
 117	int			read;
 118	int			count;
 119	dma_addr_t		shandle;
 120	dma_addr_t		ihandle;
 121	struct mutex		wlock;
 122	struct mutex		rlock;
 123	wait_queue_head_t	wait;
 124	struct work_struct	rxwork;
 
 125	int			werr;
 126	int			rerr;
 
 127
 128	struct list_head	device_list;
 129	int			(*manage_power)(struct usb_interface *, int);
 130};
 131
 132static struct usb_driver wdm_driver;
 133
 134/* return intfdata if we own the interface, else look up intf in the list */
 135static struct wdm_device *wdm_find_device(struct usb_interface *intf)
 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 == intf)
 142			goto found;
 143	desc = NULL;
 144found:
 145	spin_unlock(&wdm_device_list_lock);
 146
 147	return desc;
 148}
 149
 150static struct wdm_device *wdm_find_device_by_minor(int minor)
 151{
 152	struct wdm_device *desc;
 153
 154	spin_lock(&wdm_device_list_lock);
 155	list_for_each_entry(desc, &wdm_device_list, device_list)
 156		if (desc->intf->minor == minor)
 157			goto found;
 158	desc = NULL;
 159found:
 160	spin_unlock(&wdm_device_list_lock);
 161
 162	return desc;
 163}
 164
 165/* --- callbacks --- */
 166static void wdm_out_callback(struct urb *urb)
 167{
 168	struct wdm_device *desc;
 
 
 169	desc = urb->context;
 170	spin_lock(&desc->iuspin);
 171	desc->werr = urb->status;
 172	spin_unlock(&desc->iuspin);
 173	kfree(desc->outbuf);
 174	desc->outbuf = NULL;
 175	clear_bit(WDM_IN_USE, &desc->flags);
 176	wake_up(&desc->wait);
 177}
 178
 179static void wdm_in_callback(struct urb *urb)
 180{
 
 181	struct wdm_device *desc = urb->context;
 182	int status = urb->status;
 
 183
 184	spin_lock(&desc->iuspin);
 185	clear_bit(WDM_RESPONDING, &desc->flags);
 186
 187	if (status) {
 188		switch (status) {
 189		case -ENOENT:
 190			dev_dbg(&desc->intf->dev,
 191				"nonzero urb status received: -ENOENT");
 192			goto skip_error;
 193		case -ECONNRESET:
 194			dev_dbg(&desc->intf->dev,
 195				"nonzero urb status received: -ECONNRESET");
 196			goto skip_error;
 197		case -ESHUTDOWN:
 198			dev_dbg(&desc->intf->dev,
 199				"nonzero urb status received: -ESHUTDOWN");
 200			goto skip_error;
 201		case -EPIPE:
 202			dev_err(&desc->intf->dev,
 203				"nonzero urb status received: -EPIPE\n");
 204			break;
 205		default:
 206			dev_err(&desc->intf->dev,
 207				"Unexpected error %d\n", status);
 208			break;
 209		}
 210	}
 211
 212	desc->rerr = status;
 213	desc->reslength = urb->actual_length;
 214	memmove(desc->ubuf + desc->length, desc->inbuf, desc->reslength);
 215	desc->length += desc->reslength;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 216skip_error:
 217	wake_up(&desc->wait);
 218
 219	set_bit(WDM_READ, &desc->flags);
 220	spin_unlock(&desc->iuspin);
 
 
 
 
 
 
 
 
 
 
 
 221}
 222
 223static void wdm_int_callback(struct urb *urb)
 224{
 
 225	int rv = 0;
 
 226	int status = urb->status;
 227	struct wdm_device *desc;
 228	struct usb_cdc_notification *dr;
 229
 230	desc = urb->context;
 231	dr = (struct usb_cdc_notification *)desc->sbuf;
 232
 233	if (status) {
 234		switch (status) {
 235		case -ESHUTDOWN:
 236		case -ENOENT:
 237		case -ECONNRESET:
 238			return; /* unplug */
 239		case -EPIPE:
 240			set_bit(WDM_INT_STALL, &desc->flags);
 241			dev_err(&desc->intf->dev, "Stall on int endpoint\n");
 242			goto sw; /* halt is cleared in work */
 243		default:
 244			dev_err(&desc->intf->dev,
 245				"nonzero urb status received: %d\n", status);
 246			break;
 247		}
 248	}
 249
 250	if (urb->actual_length < sizeof(struct usb_cdc_notification)) {
 251		dev_err(&desc->intf->dev, "wdm_int_callback - %d bytes\n",
 252			urb->actual_length);
 253		goto exit;
 254	}
 255
 256	switch (dr->bNotificationType) {
 257	case USB_CDC_NOTIFY_RESPONSE_AVAILABLE:
 258		dev_dbg(&desc->intf->dev,
 259			"NOTIFY_RESPONSE_AVAILABLE received: index %d len %d",
 260			dr->wIndex, dr->wLength);
 261		break;
 262
 263	case USB_CDC_NOTIFY_NETWORK_CONNECTION:
 264
 265		dev_dbg(&desc->intf->dev,
 266			"NOTIFY_NETWORK_CONNECTION %s network",
 267			dr->wValue ? "connected to" : "disconnected from");
 268		goto exit;
 
 
 
 
 269	default:
 270		clear_bit(WDM_POLL_RUNNING, &desc->flags);
 271		dev_err(&desc->intf->dev,
 272			"unknown notification %d received: index %d len %d\n",
 273			dr->bNotificationType, dr->wIndex, dr->wLength);
 
 
 274		goto exit;
 275	}
 276
 277	spin_lock(&desc->iuspin);
 278	clear_bit(WDM_READ, &desc->flags);
 279	set_bit(WDM_RESPONDING, &desc->flags);
 280	if (!test_bit(WDM_DISCONNECTING, &desc->flags)
 281		&& !test_bit(WDM_SUSPENDING, &desc->flags)) {
 282		rv = usb_submit_urb(desc->response, GFP_ATOMIC);
 283		dev_dbg(&desc->intf->dev, "%s: usb_submit_urb %d",
 284			__func__, rv);
 285	}
 286	spin_unlock(&desc->iuspin);
 287	if (rv < 0) {
 288		clear_bit(WDM_RESPONDING, &desc->flags);
 289		if (rv == -EPERM)
 290			return;
 291		if (rv == -ENOMEM) {
 292sw:
 293			rv = schedule_work(&desc->rxwork);
 294			if (rv)
 295				dev_err(&desc->intf->dev,
 296					"Cannot schedule work\n");
 297		}
 298	}
 299exit:
 300	rv = usb_submit_urb(urb, GFP_ATOMIC);
 301	if (rv)
 302		dev_err(&desc->intf->dev,
 303			"%s - usb_submit_urb failed with result %d\n",
 304			__func__, rv);
 305
 306}
 307
 308static void kill_urbs(struct wdm_device *desc)
 309{
 310	/* the order here is essential */
 311	usb_kill_urb(desc->command);
 312	usb_kill_urb(desc->validity);
 313	usb_kill_urb(desc->response);
 314}
 315
 316static void free_urbs(struct wdm_device *desc)
 317{
 318	usb_free_urb(desc->validity);
 319	usb_free_urb(desc->response);
 320	usb_free_urb(desc->command);
 321}
 322
 323static void cleanup(struct wdm_device *desc)
 324{
 325	kfree(desc->sbuf);
 326	kfree(desc->inbuf);
 327	kfree(desc->orq);
 328	kfree(desc->irq);
 329	kfree(desc->ubuf);
 330	free_urbs(desc);
 331	kfree(desc);
 332}
 333
 334static ssize_t wdm_write
 335(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
 336{
 337	u8 *buf;
 338	int rv = -EMSGSIZE, r, we;
 339	struct wdm_device *desc = file->private_data;
 340	struct usb_ctrlrequest *req;
 341
 342	if (count > desc->wMaxCommand)
 343		count = desc->wMaxCommand;
 344
 345	spin_lock_irq(&desc->iuspin);
 346	we = desc->werr;
 347	desc->werr = 0;
 348	spin_unlock_irq(&desc->iuspin);
 349	if (we < 0)
 350		return -EIO;
 351
 352	buf = kmalloc(count, GFP_KERNEL);
 353	if (!buf) {
 354		rv = -ENOMEM;
 355		goto outnl;
 356	}
 357
 358	r = copy_from_user(buf, buffer, count);
 359	if (r > 0) {
 360		kfree(buf);
 361		rv = -EFAULT;
 362		goto outnl;
 363	}
 364
 365	/* concurrent writes and disconnect */
 366	r = mutex_lock_interruptible(&desc->wlock);
 367	rv = -ERESTARTSYS;
 368	if (r) {
 369		kfree(buf);
 370		goto outnl;
 371	}
 372
 373	if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
 374		kfree(buf);
 375		rv = -ENODEV;
 376		goto outnp;
 377	}
 378
 379	r = usb_autopm_get_interface(desc->intf);
 380	if (r < 0) {
 381		kfree(buf);
 382		rv = usb_translate_errors(r);
 383		goto outnp;
 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		kfree(buf);
 398		rv = r;
 399		goto out;
 400	}
 401
 402	req = desc->orq;
 403	usb_fill_control_urb(
 404		desc->command,
 405		interface_to_usbdev(desc->intf),
 406		/* using common endpoint 0 */
 407		usb_sndctrlpipe(interface_to_usbdev(desc->intf), 0),
 408		(unsigned char *)req,
 409		buf,
 410		count,
 411		wdm_out_callback,
 412		desc
 413	);
 414
 415	req->bRequestType = (USB_DIR_OUT | USB_TYPE_CLASS |
 416			     USB_RECIP_INTERFACE);
 417	req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
 418	req->wValue = 0;
 419	req->wIndex = desc->inum;
 420	req->wLength = cpu_to_le16(count);
 421	set_bit(WDM_IN_USE, &desc->flags);
 422	desc->outbuf = buf;
 423
 424	rv = usb_submit_urb(desc->command, GFP_KERNEL);
 425	if (rv < 0) {
 426		kfree(buf);
 427		desc->outbuf = NULL;
 428		clear_bit(WDM_IN_USE, &desc->flags);
 429		dev_err(&desc->intf->dev, "Tx URB error: %d\n", rv);
 430		rv = usb_translate_errors(rv);
 
 431	} else {
 432		dev_dbg(&desc->intf->dev, "Tx URB has been submitted index=%d",
 433			req->wIndex);
 434	}
 435out:
 
 
 
 
 
 436	usb_autopm_put_interface(desc->intf);
 437outnp:
 438	mutex_unlock(&desc->wlock);
 439outnl:
 440	return rv < 0 ? rv : count;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 441}
 442
 443static ssize_t wdm_read
 444(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
 445{
 446	int rv, cntr;
 447	int i = 0;
 448	struct wdm_device *desc = file->private_data;
 449
 450
 451	rv = mutex_lock_interruptible(&desc->rlock); /*concurrent reads */
 452	if (rv < 0)
 453		return -ERESTARTSYS;
 454
 455	cntr = ACCESS_ONCE(desc->length);
 456	if (cntr == 0) {
 457		desc->read = 0;
 458retry:
 459		if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
 460			rv = -ENODEV;
 461			goto err;
 462		}
 
 
 
 
 
 463		i++;
 464		if (file->f_flags & O_NONBLOCK) {
 465			if (!test_bit(WDM_READ, &desc->flags)) {
 466				rv = cntr ? cntr : -EAGAIN;
 467				goto err;
 468			}
 469			rv = 0;
 470		} else {
 471			rv = wait_event_interruptible(desc->wait,
 472				test_bit(WDM_READ, &desc->flags));
 473		}
 474
 475		/* may have happened while we slept */
 476		if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
 477			rv = -ENODEV;
 478			goto err;
 479		}
 480		if (test_bit(WDM_RESETTING, &desc->flags)) {
 481			rv = -EIO;
 482			goto err;
 483		}
 484		usb_mark_last_busy(interface_to_usbdev(desc->intf));
 485		if (rv < 0) {
 486			rv = -ERESTARTSYS;
 487			goto err;
 488		}
 489
 490		spin_lock_irq(&desc->iuspin);
 491
 492		if (desc->rerr) { /* read completed, error happened */
 
 493			desc->rerr = 0;
 494			spin_unlock_irq(&desc->iuspin);
 495			rv = -EIO;
 496			goto err;
 497		}
 498		/*
 499		 * recheck whether we've lost the race
 500		 * against the completion handler
 501		 */
 502		if (!test_bit(WDM_READ, &desc->flags)) { /* lost race */
 503			spin_unlock_irq(&desc->iuspin);
 504			goto retry;
 505		}
 
 506		if (!desc->reslength) { /* zero length read */
 507			dev_dbg(&desc->intf->dev, "%s: zero length - clearing WDM_READ\n", __func__);
 508			clear_bit(WDM_READ, &desc->flags);
 
 509			spin_unlock_irq(&desc->iuspin);
 
 
 510			goto retry;
 511		}
 512		cntr = desc->length;
 513		spin_unlock_irq(&desc->iuspin);
 514	}
 515
 516	if (cntr > count)
 517		cntr = count;
 518	rv = copy_to_user(buffer, desc->ubuf, cntr);
 519	if (rv > 0) {
 520		rv = -EFAULT;
 521		goto err;
 522	}
 523
 524	spin_lock_irq(&desc->iuspin);
 525
 526	for (i = 0; i < desc->length - cntr; i++)
 527		desc->ubuf[i] = desc->ubuf[i + cntr];
 528
 529	desc->length -= cntr;
 530	/* in case we had outstanding data */
 531	if (!desc->length)
 532		clear_bit(WDM_READ, &desc->flags);
 533
 
 534	spin_unlock_irq(&desc->iuspin);
 535
 536	rv = cntr;
 537
 538err:
 539	mutex_unlock(&desc->rlock);
 540	return rv;
 541}
 542
 543static int wdm_flush(struct file *file, fl_owner_t id)
 544{
 545	struct wdm_device *desc = file->private_data;
 546
 547	wait_event(desc->wait, !test_bit(WDM_IN_USE, &desc->flags));
 
 
 
 
 
 
 
 
 548
 549	/* cannot dereference desc->intf if WDM_DISCONNECTING */
 550	if (desc->werr < 0 && !test_bit(WDM_DISCONNECTING, &desc->flags))
 
 
 551		dev_err(&desc->intf->dev, "Error in flush path: %d\n",
 552			desc->werr);
 553
 554	return usb_translate_errors(desc->werr);
 555}
 556
 557static unsigned int wdm_poll(struct file *file, struct poll_table_struct *wait)
 558{
 559	struct wdm_device *desc = file->private_data;
 560	unsigned long flags;
 561	unsigned int mask = 0;
 562
 563	spin_lock_irqsave(&desc->iuspin, flags);
 564	if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
 565		mask = POLLHUP | POLLERR;
 566		spin_unlock_irqrestore(&desc->iuspin, flags);
 567		goto desc_out;
 568	}
 569	if (test_bit(WDM_READ, &desc->flags))
 570		mask = POLLIN | POLLRDNORM;
 571	if (desc->rerr || desc->werr)
 572		mask |= POLLERR;
 573	if (!test_bit(WDM_IN_USE, &desc->flags))
 574		mask |= POLLOUT | POLLWRNORM;
 575	spin_unlock_irqrestore(&desc->iuspin, flags);
 576
 577	poll_wait(file, &desc->wait, wait);
 578
 579desc_out:
 580	return mask;
 581}
 582
 583static int wdm_open(struct inode *inode, struct file *file)
 584{
 585	int minor = iminor(inode);
 586	int rv = -ENODEV;
 587	struct usb_interface *intf;
 588	struct wdm_device *desc;
 589
 590	mutex_lock(&wdm_mutex);
 591	desc = wdm_find_device_by_minor(minor);
 592	if (!desc)
 593		goto out;
 594
 595	intf = desc->intf;
 596	if (test_bit(WDM_DISCONNECTING, &desc->flags))
 597		goto out;
 598	file->private_data = desc;
 599
 600	rv = usb_autopm_get_interface(desc->intf);
 601	if (rv < 0) {
 602		dev_err(&desc->intf->dev, "Error autopm - %d\n", rv);
 603		goto out;
 604	}
 605
 606	/* using write lock to protect desc->count */
 607	mutex_lock(&desc->wlock);
 608	if (!desc->count++) {
 609		desc->werr = 0;
 610		desc->rerr = 0;
 611		rv = usb_submit_urb(desc->validity, GFP_KERNEL);
 612		if (rv < 0) {
 613			desc->count--;
 614			dev_err(&desc->intf->dev,
 615				"Error submitting int urb - %d\n", rv);
 616			rv = usb_translate_errors(rv);
 617		}
 618	} else {
 619		rv = 0;
 620	}
 621	mutex_unlock(&desc->wlock);
 622	if (desc->count == 1)
 623		desc->manage_power(intf, 1);
 624	usb_autopm_put_interface(desc->intf);
 625out:
 626	mutex_unlock(&wdm_mutex);
 627	return rv;
 628}
 629
 630static int wdm_release(struct inode *inode, struct file *file)
 631{
 632	struct wdm_device *desc = file->private_data;
 633
 634	mutex_lock(&wdm_mutex);
 635
 636	/* using write lock to protect desc->count */
 637	mutex_lock(&desc->wlock);
 638	desc->count--;
 639	mutex_unlock(&desc->wlock);
 640
 641	if (!desc->count) {
 642		if (!test_bit(WDM_DISCONNECTING, &desc->flags)) {
 643			dev_dbg(&desc->intf->dev, "wdm_release: cleanup");
 644			kill_urbs(desc);
 
 
 
 645			desc->manage_power(desc->intf, 0);
 646		} else {
 647			/* must avoid dev_printk here as desc->intf is invalid */
 648			pr_debug(KBUILD_MODNAME " %s: device gone - cleaning up\n", __func__);
 649			cleanup(desc);
 650		}
 651	}
 652	mutex_unlock(&wdm_mutex);
 653	return 0;
 654}
 655
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 656static const struct file_operations wdm_fops = {
 657	.owner =	THIS_MODULE,
 658	.read =		wdm_read,
 659	.write =	wdm_write,
 660	.open =		wdm_open,
 661	.flush =	wdm_flush,
 662	.release =	wdm_release,
 663	.poll =		wdm_poll,
 
 
 664	.llseek =	noop_llseek,
 665};
 666
 667static struct usb_class_driver wdm_class = {
 668	.name =		"cdc-wdm%d",
 669	.fops =		&wdm_fops,
 670	.minor_base =	WDM_MINOR_BASE,
 671};
 672
 673/* --- error handling --- */
 674static void wdm_rxwork(struct work_struct *work)
 675{
 676	struct wdm_device *desc = container_of(work, struct wdm_device, rxwork);
 677	unsigned long flags;
 678	int rv;
 
 679
 680	spin_lock_irqsave(&desc->iuspin, flags);
 681	if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
 682		spin_unlock_irqrestore(&desc->iuspin, flags);
 683	} else {
 
 684		spin_unlock_irqrestore(&desc->iuspin, flags);
 685		rv = usb_submit_urb(desc->response, GFP_KERNEL);
 
 686		if (rv < 0 && rv != -EPERM) {
 687			spin_lock_irqsave(&desc->iuspin, flags);
 
 688			if (!test_bit(WDM_DISCONNECTING, &desc->flags))
 689				schedule_work(&desc->rxwork);
 690			spin_unlock_irqrestore(&desc->iuspin, flags);
 691		}
 692	}
 693}
 694
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 695/* --- hotplug --- */
 696
 697static int wdm_create(struct usb_interface *intf, struct usb_endpoint_descriptor *ep,
 698		u16 bufsize, int (*manage_power)(struct usb_interface *, int))
 699{
 700	int rv = -ENOMEM;
 701	struct wdm_device *desc;
 702
 703	desc = kzalloc(sizeof(struct wdm_device), GFP_KERNEL);
 704	if (!desc)
 705		goto out;
 706	INIT_LIST_HEAD(&desc->device_list);
 707	mutex_init(&desc->rlock);
 708	mutex_init(&desc->wlock);
 709	spin_lock_init(&desc->iuspin);
 710	init_waitqueue_head(&desc->wait);
 711	desc->wMaxCommand = bufsize;
 712	/* this will be expanded and needed in hardware endianness */
 713	desc->inum = cpu_to_le16((u16)intf->cur_altsetting->desc.bInterfaceNumber);
 714	desc->intf = intf;
 715	INIT_WORK(&desc->rxwork, wdm_rxwork);
 
 716
 717	rv = -EINVAL;
 718	if (!usb_endpoint_is_int_in(ep))
 719		goto err;
 720
 721	desc->wMaxPacketSize = usb_endpoint_maxp(ep);
 722
 723	desc->orq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
 724	if (!desc->orq)
 725		goto err;
 726	desc->irq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
 727	if (!desc->irq)
 728		goto err;
 729
 730	desc->validity = usb_alloc_urb(0, GFP_KERNEL);
 731	if (!desc->validity)
 732		goto err;
 733
 734	desc->response = usb_alloc_urb(0, GFP_KERNEL);
 735	if (!desc->response)
 736		goto err;
 737
 738	desc->command = usb_alloc_urb(0, GFP_KERNEL);
 739	if (!desc->command)
 740		goto err;
 741
 742	desc->ubuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
 743	if (!desc->ubuf)
 744		goto err;
 745
 746	desc->sbuf = kmalloc(desc->wMaxPacketSize, GFP_KERNEL);
 747	if (!desc->sbuf)
 748		goto err;
 749
 750	desc->inbuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
 751	if (!desc->inbuf)
 752		goto err;
 753
 754	usb_fill_int_urb(
 755		desc->validity,
 756		interface_to_usbdev(intf),
 757		usb_rcvintpipe(interface_to_usbdev(intf), ep->bEndpointAddress),
 758		desc->sbuf,
 759		desc->wMaxPacketSize,
 760		wdm_int_callback,
 761		desc,
 762		ep->bInterval
 763	);
 764
 765	desc->irq->bRequestType = (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE);
 766	desc->irq->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
 767	desc->irq->wValue = 0;
 768	desc->irq->wIndex = desc->inum;
 769	desc->irq->wLength = cpu_to_le16(desc->wMaxCommand);
 770
 771	usb_fill_control_urb(
 772		desc->response,
 773		interface_to_usbdev(intf),
 774		/* using common endpoint 0 */
 775		usb_rcvctrlpipe(interface_to_usbdev(desc->intf), 0),
 776		(unsigned char *)desc->irq,
 777		desc->inbuf,
 778		desc->wMaxCommand,
 779		wdm_in_callback,
 780		desc
 781	);
 782
 783	desc->manage_power = manage_power;
 784
 785	spin_lock(&wdm_device_list_lock);
 786	list_add(&desc->device_list, &wdm_device_list);
 787	spin_unlock(&wdm_device_list_lock);
 788
 789	rv = usb_register_dev(intf, &wdm_class);
 790	if (rv < 0)
 791		goto err;
 792	else
 793		dev_info(&intf->dev, "%s: USB WDM device\n", dev_name(intf->usb_dev));
 794out:
 795	return rv;
 796err:
 797	spin_lock(&wdm_device_list_lock);
 798	list_del(&desc->device_list);
 799	spin_unlock(&wdm_device_list_lock);
 800	cleanup(desc);
 801	return rv;
 802}
 803
 804static int wdm_manage_power(struct usb_interface *intf, int on)
 805{
 806	/* need autopm_get/put here to ensure the usbcore sees the new value */
 807	int rv = usb_autopm_get_interface(intf);
 808	if (rv < 0)
 809		goto err;
 810
 811	intf->needs_remote_wakeup = on;
 812	usb_autopm_put_interface(intf);
 813err:
 814	return rv;
 815}
 816
 817static int wdm_probe(struct usb_interface *intf, const struct usb_device_id *id)
 818{
 819	int rv = -EINVAL;
 820	struct usb_host_interface *iface;
 821	struct usb_endpoint_descriptor *ep;
 822	struct usb_cdc_dmm_desc *dmhd;
 823	u8 *buffer = intf->altsetting->extra;
 824	int buflen = intf->altsetting->extralen;
 825	u16 maxcom = WDM_DEFAULT_BUFSIZE;
 826
 827	if (!buffer)
 828		goto err;
 829	while (buflen > 2) {
 830		if (buffer[1] != USB_DT_CS_INTERFACE) {
 831			dev_err(&intf->dev, "skipping garbage\n");
 832			goto next_desc;
 833		}
 834
 835		switch (buffer[2]) {
 836		case USB_CDC_HEADER_TYPE:
 837			break;
 838		case USB_CDC_DMM_TYPE:
 839			dmhd = (struct usb_cdc_dmm_desc *)buffer;
 840			maxcom = le16_to_cpu(dmhd->wMaxCommand);
 841			dev_dbg(&intf->dev,
 842				"Finding maximum buffer length: %d", maxcom);
 843			break;
 844		default:
 845			dev_err(&intf->dev,
 846				"Ignoring extra header, type %d, length %d\n",
 847				buffer[2], buffer[0]);
 848			break;
 849		}
 850next_desc:
 851		buflen -= buffer[0];
 852		buffer += buffer[0];
 853	}
 854
 855	iface = intf->cur_altsetting;
 856	if (iface->desc.bNumEndpoints != 1)
 857		goto err;
 858	ep = &iface->endpoint[0].desc;
 859
 860	rv = wdm_create(intf, ep, maxcom, &wdm_manage_power);
 861
 862err:
 863	return rv;
 864}
 865
 866/**
 867 * usb_cdc_wdm_register - register a WDM subdriver
 868 * @intf: usb interface the subdriver will associate with
 869 * @ep: interrupt endpoint to monitor for notifications
 870 * @bufsize: maximum message size to support for read/write
 871 *
 
 872 * Create WDM usb class character device and associate it with intf
 873 * without binding, allowing another driver to manage the interface.
 874 *
 875 * The subdriver will manage the given interrupt endpoint exclusively
 876 * and will issue control requests referring to the given intf. It
 877 * will otherwise avoid interferring, and in particular not do
 878 * usb_set_intfdata/usb_get_intfdata on intf.
 879 *
 880 * The return value is a pointer to the subdriver's struct usb_driver.
 881 * The registering driver is responsible for calling this subdriver's
 882 * disconnect, suspend, resume, pre_reset and post_reset methods from
 883 * its own.
 884 */
 885struct usb_driver *usb_cdc_wdm_register(struct usb_interface *intf,
 886					struct usb_endpoint_descriptor *ep,
 887					int bufsize,
 888					int (*manage_power)(struct usb_interface *, int))
 889{
 890	int rv = -EINVAL;
 891
 892	rv = wdm_create(intf, ep, bufsize, manage_power);
 893	if (rv < 0)
 894		goto err;
 895
 896	return &wdm_driver;
 897err:
 898	return ERR_PTR(rv);
 899}
 900EXPORT_SYMBOL(usb_cdc_wdm_register);
 901
 902static void wdm_disconnect(struct usb_interface *intf)
 903{
 904	struct wdm_device *desc;
 905	unsigned long flags;
 906
 907	usb_deregister_dev(intf, &wdm_class);
 908	desc = wdm_find_device(intf);
 909	mutex_lock(&wdm_mutex);
 910
 911	/* the spinlock makes sure no new urbs are generated in the callbacks */
 912	spin_lock_irqsave(&desc->iuspin, flags);
 913	set_bit(WDM_DISCONNECTING, &desc->flags);
 914	set_bit(WDM_READ, &desc->flags);
 915	/* to terminate pending flushes */
 916	clear_bit(WDM_IN_USE, &desc->flags);
 917	spin_unlock_irqrestore(&desc->iuspin, flags);
 918	wake_up_all(&desc->wait);
 919	mutex_lock(&desc->rlock);
 920	mutex_lock(&desc->wlock);
 921	kill_urbs(desc);
 922	cancel_work_sync(&desc->rxwork);
 
 923	mutex_unlock(&desc->wlock);
 924	mutex_unlock(&desc->rlock);
 925
 926	/* the desc->intf pointer used as list key is now invalid */
 927	spin_lock(&wdm_device_list_lock);
 928	list_del(&desc->device_list);
 929	spin_unlock(&wdm_device_list_lock);
 930
 931	if (!desc->count)
 932		cleanup(desc);
 933	else
 934		dev_dbg(&intf->dev, "%s: %d open files - postponing cleanup\n", __func__, desc->count);
 935	mutex_unlock(&wdm_mutex);
 936}
 937
 938#ifdef CONFIG_PM
 939static int wdm_suspend(struct usb_interface *intf, pm_message_t message)
 940{
 941	struct wdm_device *desc = wdm_find_device(intf);
 942	int rv = 0;
 943
 944	dev_dbg(&desc->intf->dev, "wdm%d_suspend\n", intf->minor);
 945
 946	/* if this is an autosuspend the caller does the locking */
 947	if (!PMSG_IS_AUTO(message)) {
 948		mutex_lock(&desc->rlock);
 949		mutex_lock(&desc->wlock);
 950	}
 951	spin_lock_irq(&desc->iuspin);
 952
 953	if (PMSG_IS_AUTO(message) &&
 954			(test_bit(WDM_IN_USE, &desc->flags)
 955			|| test_bit(WDM_RESPONDING, &desc->flags))) {
 956		spin_unlock_irq(&desc->iuspin);
 957		rv = -EBUSY;
 958	} else {
 959
 960		set_bit(WDM_SUSPENDING, &desc->flags);
 961		spin_unlock_irq(&desc->iuspin);
 962		/* callback submits work - order is essential */
 963		kill_urbs(desc);
 964		cancel_work_sync(&desc->rxwork);
 
 965	}
 966	if (!PMSG_IS_AUTO(message)) {
 967		mutex_unlock(&desc->wlock);
 968		mutex_unlock(&desc->rlock);
 969	}
 970
 971	return rv;
 972}
 973#endif
 974
 975static int recover_from_urb_loss(struct wdm_device *desc)
 976{
 977	int rv = 0;
 978
 979	if (desc->count) {
 980		rv = usb_submit_urb(desc->validity, GFP_NOIO);
 981		if (rv < 0)
 982			dev_err(&desc->intf->dev,
 983				"Error resume submitting int urb - %d\n", rv);
 984	}
 985	return rv;
 986}
 987
 988#ifdef CONFIG_PM
 989static int wdm_resume(struct usb_interface *intf)
 990{
 991	struct wdm_device *desc = wdm_find_device(intf);
 992	int rv;
 993
 994	dev_dbg(&desc->intf->dev, "wdm%d_resume\n", intf->minor);
 995
 996	clear_bit(WDM_SUSPENDING, &desc->flags);
 997	rv = recover_from_urb_loss(desc);
 998
 999	return rv;
1000}
1001#endif
1002
1003static int wdm_pre_reset(struct usb_interface *intf)
1004{
1005	struct wdm_device *desc = wdm_find_device(intf);
1006
1007	/*
1008	 * we notify everybody using poll of
1009	 * an exceptional situation
1010	 * must be done before recovery lest a spontaneous
1011	 * message from the device is lost
1012	 */
1013	spin_lock_irq(&desc->iuspin);
1014	set_bit(WDM_RESETTING, &desc->flags);	/* inform read/write */
1015	set_bit(WDM_READ, &desc->flags);	/* unblock read */
1016	clear_bit(WDM_IN_USE, &desc->flags);	/* unblock write */
1017	desc->rerr = -EINTR;
1018	spin_unlock_irq(&desc->iuspin);
1019	wake_up_all(&desc->wait);
1020	mutex_lock(&desc->rlock);
1021	mutex_lock(&desc->wlock);
1022	kill_urbs(desc);
1023	cancel_work_sync(&desc->rxwork);
 
1024	return 0;
1025}
1026
1027static int wdm_post_reset(struct usb_interface *intf)
1028{
1029	struct wdm_device *desc = wdm_find_device(intf);
1030	int rv;
1031
 
1032	clear_bit(WDM_RESETTING, &desc->flags);
1033	rv = recover_from_urb_loss(desc);
1034	mutex_unlock(&desc->wlock);
1035	mutex_unlock(&desc->rlock);
1036	return 0;
1037}
1038
1039static struct usb_driver wdm_driver = {
1040	.name =		"cdc_wdm",
1041	.probe =	wdm_probe,
1042	.disconnect =	wdm_disconnect,
1043#ifdef CONFIG_PM
1044	.suspend =	wdm_suspend,
1045	.resume =	wdm_resume,
1046	.reset_resume =	wdm_resume,
1047#endif
1048	.pre_reset =	wdm_pre_reset,
1049	.post_reset =	wdm_post_reset,
1050	.id_table =	wdm_ids,
1051	.supports_autosuspend = 1,
1052	.disable_hub_initiated_lpm = 1,
1053};
1054
1055module_usb_driver(wdm_driver);
1056
1057MODULE_AUTHOR(DRIVER_AUTHOR);
1058MODULE_DESCRIPTION(DRIVER_DESC);
1059MODULE_LICENSE("GPL");