cdc-wdm.c 19.3 KB
Newer Older
O
Oliver Neukum 已提交
1 2 3 4 5
/*
 * cdc-wdm.c
 *
 * This driver supports USB CDC WCM Device Management.
 *
6
 * Copyright (c) 2007-2009 Oliver Neukum
O
Oliver Neukum 已提交
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 *
 * Some code taken from cdc-acm.c
 *
 * Released under the GPLv2.
 *
 * Many thanks to Carl Nordbeck
 */
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/uaccess.h>
#include <linux/bitops.h>
#include <linux/poll.h>
#include <linux/usb.h>
#include <linux/usb/cdc.h>
#include <asm/byteorder.h>
#include <asm/unaligned.h>

/*
 * Version Information
 */
O
Oliver Neukum 已提交
30
#define DRIVER_VERSION "v0.03"
O
Oliver Neukum 已提交
31
#define DRIVER_AUTHOR "Oliver Neukum"
O
Oliver Neukum 已提交
32
#define DRIVER_DESC "USB Abstract Control Model driver for USB WCM Device Management"
O
Oliver Neukum 已提交
33

34
static const struct usb_device_id wdm_ids[] = {
O
Oliver Neukum 已提交
35 36 37 38 39 40 41 42 43
	{
		.match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
				 USB_DEVICE_ID_MATCH_INT_SUBCLASS,
		.bInterfaceClass = USB_CLASS_COMM,
		.bInterfaceSubClass = USB_CDC_SUBCLASS_DMM
	},
	{ }
};

44 45
MODULE_DEVICE_TABLE (usb, wdm_ids);

O
Oliver Neukum 已提交
46 47 48 49 50 51 52 53 54
#define WDM_MINOR_BASE	176


#define WDM_IN_USE		1
#define WDM_DISCONNECTING	2
#define WDM_RESULT		3
#define WDM_READ		4
#define WDM_INT_STALL		5
#define WDM_POLL_RUNNING	6
55
#define WDM_RESPONDING		7
56
#define WDM_SUSPENDING		8
O
Oliver Neukum 已提交
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

#define WDM_MAX			16


static DEFINE_MUTEX(wdm_mutex);

/* --- method tables --- */

struct wdm_device {
	u8			*inbuf; /* buffer for response */
	u8			*outbuf; /* buffer for command */
	u8			*sbuf; /* buffer for status */
	u8			*ubuf; /* buffer for copy to user space */

	struct urb		*command;
	struct urb		*response;
	struct urb		*validity;
	struct usb_interface	*intf;
	struct usb_ctrlrequest	*orq;
	struct usb_ctrlrequest	*irq;
	spinlock_t		iuspin;

	unsigned long		flags;
	u16			bufsize;
	u16			wMaxCommand;
	u16			wMaxPacketSize;
	__le16			inum;
	int			reslength;
	int			length;
	int			read;
	int			count;
	dma_addr_t		shandle;
	dma_addr_t		ihandle;
90
	struct mutex		lock;
O
Oliver Neukum 已提交
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
	wait_queue_head_t	wait;
	struct work_struct	rxwork;
	int			werr;
	int			rerr;
};

static struct usb_driver wdm_driver;

/* --- callbacks --- */
static void wdm_out_callback(struct urb *urb)
{
	struct wdm_device *desc;
	desc = urb->context;
	spin_lock(&desc->iuspin);
	desc->werr = urb->status;
	spin_unlock(&desc->iuspin);
	clear_bit(WDM_IN_USE, &desc->flags);
	kfree(desc->outbuf);
	wake_up(&desc->wait);
}

static void wdm_in_callback(struct urb *urb)
{
	struct wdm_device *desc = urb->context;
	int status = urb->status;

	spin_lock(&desc->iuspin);
118
	clear_bit(WDM_RESPONDING, &desc->flags);
O
Oliver Neukum 已提交
119 120 121 122 123 124

	if (status) {
		switch (status) {
		case -ENOENT:
			dev_dbg(&desc->intf->dev,
				"nonzero urb status received: -ENOENT");
125
			goto skip_error;
O
Oliver Neukum 已提交
126 127 128
		case -ECONNRESET:
			dev_dbg(&desc->intf->dev,
				"nonzero urb status received: -ECONNRESET");
129
			goto skip_error;
O
Oliver Neukum 已提交
130 131 132
		case -ESHUTDOWN:
			dev_dbg(&desc->intf->dev,
				"nonzero urb status received: -ESHUTDOWN");
133
			goto skip_error;
O
Oliver Neukum 已提交
134
		case -EPIPE:
135 136
			dev_err(&desc->intf->dev,
				"nonzero urb status received: -EPIPE\n");
O
Oliver Neukum 已提交
137 138
			break;
		default:
139 140
			dev_err(&desc->intf->dev,
				"Unexpected error %d\n", status);
O
Oliver Neukum 已提交
141 142 143 144 145 146 147 148
			break;
		}
	}

	desc->rerr = status;
	desc->reslength = urb->actual_length;
	memmove(desc->ubuf + desc->length, desc->inbuf, desc->reslength);
	desc->length += desc->reslength;
149
skip_error:
O
Oliver Neukum 已提交
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
	wake_up(&desc->wait);

	set_bit(WDM_READ, &desc->flags);
	spin_unlock(&desc->iuspin);
}

static void wdm_int_callback(struct urb *urb)
{
	int rv = 0;
	int status = urb->status;
	struct wdm_device *desc;
	struct usb_cdc_notification *dr;

	desc = urb->context;
	dr = (struct usb_cdc_notification *)desc->sbuf;

	if (status) {
		switch (status) {
		case -ESHUTDOWN:
		case -ENOENT:
		case -ECONNRESET:
			return; /* unplug */
		case -EPIPE:
			set_bit(WDM_INT_STALL, &desc->flags);
174
			dev_err(&desc->intf->dev, "Stall on int endpoint\n");
O
Oliver Neukum 已提交
175 176
			goto sw; /* halt is cleared in work */
		default:
177 178
			dev_err(&desc->intf->dev,
				"nonzero urb status received: %d\n", status);
O
Oliver Neukum 已提交
179 180 181 182 183
			break;
		}
	}

	if (urb->actual_length < sizeof(struct usb_cdc_notification)) {
184 185
		dev_err(&desc->intf->dev, "wdm_int_callback - %d bytes\n",
			urb->actual_length);
O
Oliver Neukum 已提交
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
		goto exit;
	}

	switch (dr->bNotificationType) {
	case USB_CDC_NOTIFY_RESPONSE_AVAILABLE:
		dev_dbg(&desc->intf->dev,
			"NOTIFY_RESPONSE_AVAILABLE received: index %d len %d",
			dr->wIndex, dr->wLength);
		break;

	case USB_CDC_NOTIFY_NETWORK_CONNECTION:

		dev_dbg(&desc->intf->dev,
			"NOTIFY_NETWORK_CONNECTION %s network",
			dr->wValue ? "connected to" : "disconnected from");
		goto exit;
	default:
		clear_bit(WDM_POLL_RUNNING, &desc->flags);
204 205
		dev_err(&desc->intf->dev,
			"unknown notification %d received: index %d len %d\n",
O
Oliver Neukum 已提交
206 207 208 209 210 211
			dr->bNotificationType, dr->wIndex, dr->wLength);
		goto exit;
	}

	spin_lock(&desc->iuspin);
	clear_bit(WDM_READ, &desc->flags);
212
	set_bit(WDM_RESPONDING, &desc->flags);
213 214
	if (!test_bit(WDM_DISCONNECTING, &desc->flags)
		&& !test_bit(WDM_SUSPENDING, &desc->flags)) {
O
Oliver Neukum 已提交
215 216 217 218 219 220
		rv = usb_submit_urb(desc->response, GFP_ATOMIC);
		dev_dbg(&desc->intf->dev, "%s: usb_submit_urb %d",
			__func__, rv);
	}
	spin_unlock(&desc->iuspin);
	if (rv < 0) {
221
		clear_bit(WDM_RESPONDING, &desc->flags);
O
Oliver Neukum 已提交
222 223 224 225 226 227
		if (rv == -EPERM)
			return;
		if (rv == -ENOMEM) {
sw:
			rv = schedule_work(&desc->rxwork);
			if (rv)
228 229
				dev_err(&desc->intf->dev,
					"Cannot schedule work\n");
O
Oliver Neukum 已提交
230 231 232 233 234
		}
	}
exit:
	rv = usb_submit_urb(urb, GFP_ATOMIC);
	if (rv)
235 236 237
		dev_err(&desc->intf->dev,
			"%s - usb_submit_urb failed with result %d\n",
			__func__, rv);
O
Oliver Neukum 已提交
238 239 240 241 242

}

static void kill_urbs(struct wdm_device *desc)
{
O
Oliver Neukum 已提交
243
	/* the order here is essential */
O
Oliver Neukum 已提交
244 245 246 247 248 249 250 251 252 253 254 255 256 257
	usb_kill_urb(desc->command);
	usb_kill_urb(desc->validity);
	usb_kill_urb(desc->response);
}

static void free_urbs(struct wdm_device *desc)
{
	usb_free_urb(desc->validity);
	usb_free_urb(desc->response);
	usb_free_urb(desc->command);
}

static void cleanup(struct wdm_device *desc)
{
258 259
	kfree(desc->sbuf);
	kfree(desc->inbuf);
O
Oliver Neukum 已提交
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
	kfree(desc->orq);
	kfree(desc->irq);
	kfree(desc->ubuf);
	free_urbs(desc);
	kfree(desc);
}

static ssize_t wdm_write
(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
{
	u8 *buf;
	int rv = -EMSGSIZE, r, we;
	struct wdm_device *desc = file->private_data;
	struct usb_ctrlrequest *req;

	if (count > desc->wMaxCommand)
		count = desc->wMaxCommand;

	spin_lock_irq(&desc->iuspin);
	we = desc->werr;
	desc->werr = 0;
	spin_unlock_irq(&desc->iuspin);
	if (we < 0)
		return -EIO;

285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
	desc->outbuf = buf = kmalloc(count, GFP_KERNEL);
	if (!buf) {
		rv = -ENOMEM;
		goto outnl;
	}

	r = copy_from_user(buf, buffer, count);
	if (r > 0) {
		kfree(buf);
		rv = -EFAULT;
		goto outnl;
	}

	/* concurrent writes and disconnect */
	r = mutex_lock_interruptible(&desc->lock);
O
Oliver Neukum 已提交
300
	rv = -ERESTARTSYS;
301 302
	if (r) {
		kfree(buf);
O
Oliver Neukum 已提交
303
		goto outnl;
304 305 306 307 308 309 310
	}

	if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
		kfree(buf);
		rv = -ENODEV;
		goto outnp;
	}
O
Oliver Neukum 已提交
311

O
Oliver Neukum 已提交
312
	r = usb_autopm_get_interface(desc->intf);
313 314
	if (r < 0) {
		kfree(buf);
O
Oliver Neukum 已提交
315
		goto outnp;
316
	}
317

318
	if (!(file->f_flags & O_NONBLOCK))
319 320 321 322 323
		r = wait_event_interruptible(desc->wait, !test_bit(WDM_IN_USE,
								&desc->flags));
	else
		if (test_bit(WDM_IN_USE, &desc->flags))
			r = -EAGAIN;
324
	if (r < 0) {
O
Oliver Neukum 已提交
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
		kfree(buf);
		goto out;
	}

	req = desc->orq;
	usb_fill_control_urb(
		desc->command,
		interface_to_usbdev(desc->intf),
		/* using common endpoint 0 */
		usb_sndctrlpipe(interface_to_usbdev(desc->intf), 0),
		(unsigned char *)req,
		buf,
		count,
		wdm_out_callback,
		desc
	);

	req->bRequestType = (USB_DIR_OUT | USB_TYPE_CLASS |
			     USB_RECIP_INTERFACE);
	req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
	req->wValue = 0;
	req->wIndex = desc->inum;
	req->wLength = cpu_to_le16(count);
	set_bit(WDM_IN_USE, &desc->flags);

	rv = usb_submit_urb(desc->command, GFP_KERNEL);
	if (rv < 0) {
		kfree(buf);
		clear_bit(WDM_IN_USE, &desc->flags);
354
		dev_err(&desc->intf->dev, "Tx URB error: %d\n", rv);
O
Oliver Neukum 已提交
355 356 357 358 359
	} else {
		dev_dbg(&desc->intf->dev, "Tx URB has been submitted index=%d",
			req->wIndex);
	}
out:
O
Oliver Neukum 已提交
360 361
	usb_autopm_put_interface(desc->intf);
outnp:
362
	mutex_unlock(&desc->lock);
O
Oliver Neukum 已提交
363 364 365 366 367 368 369
outnl:
	return rv < 0 ? rv : count;
}

static ssize_t wdm_read
(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
{
370
	int rv, cntr = 0;
O
Oliver Neukum 已提交
371 372 373 374
	int i = 0;
	struct wdm_device *desc = file->private_data;


375
	rv = mutex_lock_interruptible(&desc->lock); /*concurrent reads */
O
Oliver Neukum 已提交
376 377 378 379 380 381
	if (rv < 0)
		return -ERESTARTSYS;

	if (desc->length == 0) {
		desc->read = 0;
retry:
382 383 384 385
		if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
			rv = -ENODEV;
			goto err;
		}
O
Oliver Neukum 已提交
386
		i++;
387 388 389 390 391 392 393 394 395 396
		if (file->f_flags & O_NONBLOCK) {
			if (!test_bit(WDM_READ, &desc->flags)) {
				rv = cntr ? cntr : -EAGAIN;
				goto err;
			}
			rv = 0;
		} else {
			rv = wait_event_interruptible(desc->wait,
				test_bit(WDM_READ, &desc->flags));
		}
O
Oliver Neukum 已提交
397

398
		/* may have happened while we slept */
O
Oliver Neukum 已提交
399 400 401 402 403
		if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
			rv = -ENODEV;
			goto err;
		}
		usb_mark_last_busy(interface_to_usbdev(desc->intf));
O
Oliver Neukum 已提交
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
		if (rv < 0) {
			rv = -ERESTARTSYS;
			goto err;
		}

		spin_lock_irq(&desc->iuspin);

		if (desc->rerr) { /* read completed, error happened */
			desc->rerr = 0;
			spin_unlock_irq(&desc->iuspin);
			rv = -EIO;
			goto err;
		}
		/*
		 * recheck whether we've lost the race
		 * against the completion handler
		 */
		if (!test_bit(WDM_READ, &desc->flags)) { /* lost race */
			spin_unlock_irq(&desc->iuspin);
			goto retry;
		}
		if (!desc->reslength) { /* zero length read */
			spin_unlock_irq(&desc->iuspin);
			goto retry;
		}
		clear_bit(WDM_READ, &desc->flags);
		spin_unlock_irq(&desc->iuspin);
	}

	cntr = count > desc->length ? desc->length : count;
	rv = copy_to_user(buffer, desc->ubuf, cntr);
	if (rv > 0) {
		rv = -EFAULT;
		goto err;
	}

	for (i = 0; i < desc->length - cntr; i++)
		desc->ubuf[i] = desc->ubuf[i + cntr];

	desc->length -= cntr;
O
Oliver Neukum 已提交
444 445 446
	/* in case we had outstanding data */
	if (!desc->length)
		clear_bit(WDM_READ, &desc->flags);
O
Oliver Neukum 已提交
447 448 449
	rv = cntr;

err:
450
	mutex_unlock(&desc->lock);
O
Oliver Neukum 已提交
451 452 453 454 455 456 457 458 459
	return rv;
}

static int wdm_flush(struct file *file, fl_owner_t id)
{
	struct wdm_device *desc = file->private_data;

	wait_event(desc->wait, !test_bit(WDM_IN_USE, &desc->flags));
	if (desc->werr < 0)
460 461
		dev_err(&desc->intf->dev, "Error in flush path: %d\n",
			desc->werr);
O
Oliver Neukum 已提交
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508

	return desc->werr;
}

static unsigned int wdm_poll(struct file *file, struct poll_table_struct *wait)
{
	struct wdm_device *desc = file->private_data;
	unsigned long flags;
	unsigned int mask = 0;

	spin_lock_irqsave(&desc->iuspin, flags);
	if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
		mask = POLLERR;
		spin_unlock_irqrestore(&desc->iuspin, flags);
		goto desc_out;
	}
	if (test_bit(WDM_READ, &desc->flags))
		mask = POLLIN | POLLRDNORM;
	if (desc->rerr || desc->werr)
		mask |= POLLERR;
	if (!test_bit(WDM_IN_USE, &desc->flags))
		mask |= POLLOUT | POLLWRNORM;
	spin_unlock_irqrestore(&desc->iuspin, flags);

	poll_wait(file, &desc->wait, wait);

desc_out:
	return mask;
}

static int wdm_open(struct inode *inode, struct file *file)
{
	int minor = iminor(inode);
	int rv = -ENODEV;
	struct usb_interface *intf;
	struct wdm_device *desc;

	mutex_lock(&wdm_mutex);
	intf = usb_find_interface(&wdm_driver, minor);
	if (!intf)
		goto out;

	desc = usb_get_intfdata(intf);
	if (test_bit(WDM_DISCONNECTING, &desc->flags))
		goto out;
	file->private_data = desc;

O
Oliver Neukum 已提交
509
	rv = usb_autopm_get_interface(desc->intf);
O
Oliver Neukum 已提交
510
	if (rv < 0) {
511
		dev_err(&desc->intf->dev, "Error autopm - %d\n", rv);
O
Oliver Neukum 已提交
512 513
		goto out;
	}
O
Oliver Neukum 已提交
514
	intf->needs_remote_wakeup = 1;
O
Oliver Neukum 已提交
515

516
	mutex_lock(&desc->lock);
O
Oliver Neukum 已提交
517
	if (!desc->count++) {
518 519
		desc->werr = 0;
		desc->rerr = 0;
O
Oliver Neukum 已提交
520 521 522
		rv = usb_submit_urb(desc->validity, GFP_KERNEL);
		if (rv < 0) {
			desc->count--;
523 524
			dev_err(&desc->intf->dev,
				"Error submitting int urb - %d\n", rv);
O
Oliver Neukum 已提交
525 526 527 528
		}
	} else {
		rv = 0;
	}
529
	mutex_unlock(&desc->lock);
O
Oliver Neukum 已提交
530
	usb_autopm_put_interface(desc->intf);
O
Oliver Neukum 已提交
531 532 533 534 535 536 537 538 539 540
out:
	mutex_unlock(&wdm_mutex);
	return rv;
}

static int wdm_release(struct inode *inode, struct file *file)
{
	struct wdm_device *desc = file->private_data;

	mutex_lock(&wdm_mutex);
541
	mutex_lock(&desc->lock);
O
Oliver Neukum 已提交
542
	desc->count--;
543
	mutex_unlock(&desc->lock);
O
Oliver Neukum 已提交
544

O
Oliver Neukum 已提交
545 546 547
	if (!desc->count) {
		dev_dbg(&desc->intf->dev, "wdm_release: cleanup");
		kill_urbs(desc);
O
Oliver Neukum 已提交
548 549
		if (!test_bit(WDM_DISCONNECTING, &desc->flags))
			desc->intf->needs_remote_wakeup = 0;
O
Oliver Neukum 已提交
550 551 552 553 554 555 556 557 558 559 560 561
	}
	mutex_unlock(&wdm_mutex);
	return 0;
}

static const struct file_operations wdm_fops = {
	.owner =	THIS_MODULE,
	.read =		wdm_read,
	.write =	wdm_write,
	.open =		wdm_open,
	.flush =	wdm_flush,
	.release =	wdm_release,
562 563
	.poll =		wdm_poll,
	.llseek =	noop_llseek,
O
Oliver Neukum 已提交
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
};

static struct usb_class_driver wdm_class = {
	.name =		"cdc-wdm%d",
	.fops =		&wdm_fops,
	.minor_base =	WDM_MINOR_BASE,
};

/* --- error handling --- */
static void wdm_rxwork(struct work_struct *work)
{
	struct wdm_device *desc = container_of(work, struct wdm_device, rxwork);
	unsigned long flags;
	int rv;

	spin_lock_irqsave(&desc->iuspin, flags);
	if (test_bit(WDM_DISCONNECTING, &desc->flags)) {
		spin_unlock_irqrestore(&desc->iuspin, flags);
	} else {
		spin_unlock_irqrestore(&desc->iuspin, flags);
		rv = usb_submit_urb(desc->response, GFP_KERNEL);
		if (rv < 0 && rv != -EPERM) {
			spin_lock_irqsave(&desc->iuspin, flags);
			if (!test_bit(WDM_DISCONNECTING, &desc->flags))
				schedule_work(&desc->rxwork);
			spin_unlock_irqrestore(&desc->iuspin, flags);
		}
	}
}

/* --- hotplug --- */

static int wdm_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	int rv = -EINVAL;
	struct wdm_device *desc;
	struct usb_host_interface *iface;
	struct usb_endpoint_descriptor *ep;
	struct usb_cdc_dmm_desc *dmhd;
	u8 *buffer = intf->altsetting->extra;
	int buflen = intf->altsetting->extralen;
	u16 maxcom = 0;

	if (!buffer)
		goto out;

610
	while (buflen > 2) {
O
Oliver Neukum 已提交
611
		if (buffer [1] != USB_DT_CS_INTERFACE) {
612
			dev_err(&intf->dev, "skipping garbage\n");
O
Oliver Neukum 已提交
613 614 615 616 617 618 619 620 621 622 623 624 625
			goto next_desc;
		}

		switch (buffer [2]) {
		case USB_CDC_HEADER_TYPE:
			break;
		case USB_CDC_DMM_TYPE:
			dmhd = (struct usb_cdc_dmm_desc *)buffer;
			maxcom = le16_to_cpu(dmhd->wMaxCommand);
			dev_dbg(&intf->dev,
				"Finding maximum buffer length: %d", maxcom);
			break;
		default:
626 627
			dev_err(&intf->dev,
				"Ignoring extra header, type %d, length %d\n",
O
Oliver Neukum 已提交
628 629 630 631 632 633 634 635 636 637 638 639
				buffer[2], buffer[0]);
			break;
		}
next_desc:
		buflen -= buffer[0];
		buffer += buffer[0];
	}

	rv = -ENOMEM;
	desc = kzalloc(sizeof(struct wdm_device), GFP_KERNEL);
	if (!desc)
		goto out;
640
	mutex_init(&desc->lock);
O
Oliver Neukum 已提交
641 642 643
	spin_lock_init(&desc->iuspin);
	init_waitqueue_head(&desc->wait);
	desc->wMaxCommand = maxcom;
644
	/* this will be expanded and needed in hardware endianness */
O
Oliver Neukum 已提交
645 646 647 648
	desc->inum = cpu_to_le16((u16)intf->cur_altsetting->desc.bInterfaceNumber);
	desc->intf = intf;
	INIT_WORK(&desc->rxwork, wdm_rxwork);

649 650 651 652
	rv = -EINVAL;
	iface = intf->cur_altsetting;
	if (iface->desc.bNumEndpoints != 1)
		goto err;
O
Oliver Neukum 已提交
653
	ep = &iface->endpoint[0].desc;
654
	if (!ep || !usb_endpoint_is_int_in(ep))
O
Oliver Neukum 已提交
655 656
		goto err;

657
	desc->wMaxPacketSize = usb_endpoint_maxp(ep);
O
Oliver Neukum 已提交
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681

	desc->orq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
	if (!desc->orq)
		goto err;
	desc->irq = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
	if (!desc->irq)
		goto err;

	desc->validity = usb_alloc_urb(0, GFP_KERNEL);
	if (!desc->validity)
		goto err;

	desc->response = usb_alloc_urb(0, GFP_KERNEL);
	if (!desc->response)
		goto err;

	desc->command = usb_alloc_urb(0, GFP_KERNEL);
	if (!desc->command)
		goto err;

	desc->ubuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
	if (!desc->ubuf)
		goto err;

682
	desc->sbuf = kmalloc(desc->wMaxPacketSize, GFP_KERNEL);
O
Oliver Neukum 已提交
683 684 685
	if (!desc->sbuf)
		goto err;

686
	desc->inbuf = kmalloc(desc->wMaxCommand, GFP_KERNEL);
O
Oliver Neukum 已提交
687
	if (!desc->inbuf)
688
		goto err;
O
Oliver Neukum 已提交
689 690 691 692 693 694 695 696 697 698 699 700

	usb_fill_int_urb(
		desc->validity,
		interface_to_usbdev(intf),
		usb_rcvintpipe(interface_to_usbdev(intf), ep->bEndpointAddress),
		desc->sbuf,
		desc->wMaxPacketSize,
		wdm_int_callback,
		desc,
		ep->bInterval
	);

701 702 703 704 705 706 707 708
	desc->irq->bRequestType = (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE);
	desc->irq->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
	desc->irq->wValue = 0;
	desc->irq->wIndex = desc->inum;
	desc->irq->wLength = cpu_to_le16(desc->wMaxCommand);

	usb_fill_control_urb(
		desc->response,
709
		interface_to_usbdev(intf),
710 711 712 713 714 715 716 717 718
		/* using common endpoint 0 */
		usb_rcvctrlpipe(interface_to_usbdev(desc->intf), 0),
		(unsigned char *)desc->irq,
		desc->inbuf,
		desc->wMaxCommand,
		wdm_in_callback,
		desc
	);

O
Oliver Neukum 已提交
719 720 721
	usb_set_intfdata(intf, desc);
	rv = usb_register_dev(intf, &wdm_class);
	if (rv < 0)
722
		goto err2;
723 724 725
	else
		dev_info(&intf->dev, "cdc-wdm%d: USB WDM device\n",
			intf->minor - WDM_MINOR_BASE);
O
Oliver Neukum 已提交
726 727 728
out:
	return rv;
err2:
729
	usb_set_intfdata(intf, NULL);
O
Oliver Neukum 已提交
730 731
err:
	free_urbs(desc);
732 733
	kfree(desc->inbuf);
	kfree(desc->sbuf);
O
Oliver Neukum 已提交
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
	kfree(desc->ubuf);
	kfree(desc->orq);
	kfree(desc->irq);
	kfree(desc);
	return rv;
}

static void wdm_disconnect(struct usb_interface *intf)
{
	struct wdm_device *desc;
	unsigned long flags;

	usb_deregister_dev(intf, &wdm_class);
	mutex_lock(&wdm_mutex);
	desc = usb_get_intfdata(intf);

	/* the spinlock makes sure no new urbs are generated in the callbacks */
	spin_lock_irqsave(&desc->iuspin, flags);
	set_bit(WDM_DISCONNECTING, &desc->flags);
	set_bit(WDM_READ, &desc->flags);
O
Oliver Neukum 已提交
754
	/* to terminate pending flushes */
O
Oliver Neukum 已提交
755 756
	clear_bit(WDM_IN_USE, &desc->flags);
	spin_unlock_irqrestore(&desc->iuspin, flags);
757
	mutex_lock(&desc->lock);
O
Oliver Neukum 已提交
758
	kill_urbs(desc);
759
	cancel_work_sync(&desc->rxwork);
760
	mutex_unlock(&desc->lock);
O
Oliver Neukum 已提交
761 762 763 764 765 766
	wake_up_all(&desc->wait);
	if (!desc->count)
		cleanup(desc);
	mutex_unlock(&wdm_mutex);
}

767
#ifdef CONFIG_PM
O
Oliver Neukum 已提交
768 769 770 771 772 773 774
static int wdm_suspend(struct usb_interface *intf, pm_message_t message)
{
	struct wdm_device *desc = usb_get_intfdata(intf);
	int rv = 0;

	dev_dbg(&desc->intf->dev, "wdm%d_suspend\n", intf->minor);

775
	/* if this is an autosuspend the caller does the locking */
776
	if (!PMSG_IS_AUTO(message))
777
		mutex_lock(&desc->lock);
778
	spin_lock_irq(&desc->iuspin);
779

780
	if (PMSG_IS_AUTO(message) &&
781 782
			(test_bit(WDM_IN_USE, &desc->flags)
			|| test_bit(WDM_RESPONDING, &desc->flags))) {
783
		spin_unlock_irq(&desc->iuspin);
O
Oliver Neukum 已提交
784 785
		rv = -EBUSY;
	} else {
786

787
		set_bit(WDM_SUSPENDING, &desc->flags);
788
		spin_unlock_irq(&desc->iuspin);
789
		/* callback submits work - order is essential */
O
Oliver Neukum 已提交
790
		kill_urbs(desc);
791
		cancel_work_sync(&desc->rxwork);
O
Oliver Neukum 已提交
792
	}
793
	if (!PMSG_IS_AUTO(message))
794
		mutex_unlock(&desc->lock);
O
Oliver Neukum 已提交
795 796 797

	return rv;
}
798
#endif
O
Oliver Neukum 已提交
799 800 801 802 803 804 805 806

static int recover_from_urb_loss(struct wdm_device *desc)
{
	int rv = 0;

	if (desc->count) {
		rv = usb_submit_urb(desc->validity, GFP_NOIO);
		if (rv < 0)
807 808
			dev_err(&desc->intf->dev,
				"Error resume submitting int urb - %d\n", rv);
O
Oliver Neukum 已提交
809 810 811
	}
	return rv;
}
812 813

#ifdef CONFIG_PM
O
Oliver Neukum 已提交
814 815 816 817 818 819
static int wdm_resume(struct usb_interface *intf)
{
	struct wdm_device *desc = usb_get_intfdata(intf);
	int rv;

	dev_dbg(&desc->intf->dev, "wdm%d_resume\n", intf->minor);
820

821
	clear_bit(WDM_SUSPENDING, &desc->flags);
822
	rv = recover_from_urb_loss(desc);
823

O
Oliver Neukum 已提交
824 825
	return rv;
}
826
#endif
O
Oliver Neukum 已提交
827 828 829 830 831

static int wdm_pre_reset(struct usb_interface *intf)
{
	struct wdm_device *desc = usb_get_intfdata(intf);

832
	mutex_lock(&desc->lock);
833 834 835 836 837 838 839 840 841 842 843 844
	kill_urbs(desc);

	/*
	 * we notify everybody using poll of
	 * an exceptional situation
	 * must be done before recovery lest a spontaneous
	 * message from the device is lost
	 */
	spin_lock_irq(&desc->iuspin);
	desc->rerr = -EINTR;
	spin_unlock_irq(&desc->iuspin);
	wake_up_all(&desc->wait);
O
Oliver Neukum 已提交
845 846 847 848 849 850 851 852 853
	return 0;
}

static int wdm_post_reset(struct usb_interface *intf)
{
	struct wdm_device *desc = usb_get_intfdata(intf);
	int rv;

	rv = recover_from_urb_loss(desc);
854
	mutex_unlock(&desc->lock);
O
Oliver Neukum 已提交
855 856 857
	return 0;
}

O
Oliver Neukum 已提交
858 859 860 861
static struct usb_driver wdm_driver = {
	.name =		"cdc_wdm",
	.probe =	wdm_probe,
	.disconnect =	wdm_disconnect,
862
#ifdef CONFIG_PM
O
Oliver Neukum 已提交
863 864 865
	.suspend =	wdm_suspend,
	.resume =	wdm_resume,
	.reset_resume =	wdm_resume,
866
#endif
O
Oliver Neukum 已提交
867 868
	.pre_reset =	wdm_pre_reset,
	.post_reset =	wdm_post_reset,
O
Oliver Neukum 已提交
869
	.id_table =	wdm_ids,
O
Oliver Neukum 已提交
870
	.supports_autosuspend = 1,
O
Oliver Neukum 已提交
871 872
};

873
module_usb_driver(wdm_driver);
O
Oliver Neukum 已提交
874 875

MODULE_AUTHOR(DRIVER_AUTHOR);
O
Oliver Neukum 已提交
876
MODULE_DESCRIPTION(DRIVER_DESC);
O
Oliver Neukum 已提交
877
MODULE_LICENSE("GPL");