cdc_ncm.c 35.2 KB
Newer Older
A
Alexey Orishko 已提交
1 2 3
/*
 * cdc_ncm.c
 *
4
 * Copyright (C) ST-Ericsson 2010-2012
A
Alexey Orishko 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
 * Contact: Alexey Orishko <alexey.orishko@stericsson.com>
 * Original author: Hans Petter Selasky <hans.petter.selasky@stericsson.com>
 *
 * USB Host Driver for Network Control Model (NCM)
 * http://www.usb.org/developers/devclass_docs/NCM10.zip
 *
 * The NCM encoding, decoding and initialization logic
 * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
 *
 * This software is available to you under a choice of one of two
 * licenses. You may choose this file to be licensed under the terms
 * of the GNU General Public License (GPL) Version 2 or the 2-clause
 * BSD license listed below:
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/netdevice.h>
#include <linux/ctype.h>
#include <linux/ethtool.h>
#include <linux/workqueue.h>
#include <linux/mii.h>
#include <linux/crc32.h>
#include <linux/usb.h>
50
#include <linux/hrtimer.h>
A
Alexey Orishko 已提交
51 52 53
#include <linux/atomic.h>
#include <linux/usb/usbnet.h>
#include <linux/usb/cdc.h>
54
#include <linux/usb/cdc_ncm.h>
A
Alexey Orishko 已提交
55

56 57 58 59 60 61 62 63
#if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
static bool prefer_mbim = true;
#else
static bool prefer_mbim;
#endif
module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");

64 65 66
static void cdc_ncm_txpath_bh(unsigned long param);
static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx);
static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *hr_timer);
A
Alexey Orishko 已提交
67 68
static struct usb_driver cdc_ncm_driver;

69
static u8 cdc_ncm_setup(struct usbnet *dev)
A
Alexey Orishko 已提交
70
{
71
	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
B
Bjørn Mork 已提交
72
	struct usb_cdc_ncm_ntb_parameters ncm_parm;
A
Alexey Orishko 已提交
73 74 75 76
	u32 val;
	u8 flags;
	u8 iface_no;
	int err;
77
	int eth_hlen;
78
	u16 ntb_fmt_supported;
79 80
	u32 min_dgram_size;
	u32 min_hdr_size;
A
Alexey Orishko 已提交
81 82 83

	iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;

84 85 86
	err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
			      USB_TYPE_CLASS | USB_DIR_IN
			      |USB_RECIP_INTERFACE,
B
Bjørn Mork 已提交
87 88
			      0, iface_no, &ncm_parm,
			      sizeof(ncm_parm));
89
	if (err < 0) {
A
Alexey Orishko 已提交
90 91 92 93 94
		pr_debug("failed GET_NTB_PARAMETERS\n");
		return 1;
	}

	/* read correct set of parameters according to device mode */
B
Bjørn Mork 已提交
95 96 97 98 99
	ctx->rx_max = le32_to_cpu(ncm_parm.dwNtbInMaxSize);
	ctx->tx_max = le32_to_cpu(ncm_parm.dwNtbOutMaxSize);
	ctx->tx_remainder = le16_to_cpu(ncm_parm.wNdpOutPayloadRemainder);
	ctx->tx_modulus = le16_to_cpu(ncm_parm.wNdpOutDivisor);
	ctx->tx_ndp_modulus = le16_to_cpu(ncm_parm.wNdpOutAlignment);
100
	/* devices prior to NCM Errata shall set this field to zero */
B
Bjørn Mork 已提交
101 102
	ctx->tx_max_datagrams = le16_to_cpu(ncm_parm.wNtbOutMaxDatagrams);
	ntb_fmt_supported = le16_to_cpu(ncm_parm.bmNtbFormatsSupported);
A
Alexey Orishko 已提交
103

104 105 106 107 108 109 110 111 112
	eth_hlen = ETH_HLEN;
	min_dgram_size = CDC_NCM_MIN_DATAGRAM_SIZE;
	min_hdr_size = CDC_NCM_MIN_HDR_SIZE;
	if (ctx->mbim_desc != NULL) {
		flags = ctx->mbim_desc->bmNetworkCapabilities;
		eth_hlen = 0;
		min_dgram_size = CDC_MBIM_MIN_DATAGRAM_SIZE;
		min_hdr_size = 0;
	} else if (ctx->func_desc != NULL) {
A
Alexey Orishko 已提交
113
		flags = ctx->func_desc->bmNetworkCapabilities;
114
	} else {
A
Alexey Orishko 已提交
115
		flags = 0;
116
	}
A
Alexey Orishko 已提交
117 118 119

	pr_debug("dwNtbInMaxSize=%u dwNtbOutMaxSize=%u "
		 "wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u "
120
		 "wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
A
Alexey Orishko 已提交
121
		 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
122
		 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, flags);
A
Alexey Orishko 已提交
123

124 125 126 127
	/* max count of tx datagrams */
	if ((ctx->tx_max_datagrams == 0) ||
			(ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
		ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
A
Alexey Orishko 已提交
128 129

	/* verify maximum size of received NTB in bytes */
130 131 132 133 134 135 136
	if (ctx->rx_max < USB_CDC_NCM_NTB_MIN_IN_SIZE) {
		pr_debug("Using min receive length=%d\n",
						USB_CDC_NCM_NTB_MIN_IN_SIZE);
		ctx->rx_max = USB_CDC_NCM_NTB_MIN_IN_SIZE;
	}

	if (ctx->rx_max > CDC_NCM_NTB_MAX_SIZE_RX) {
A
Alexey Orishko 已提交
137 138 139 140 141
		pr_debug("Using default maximum receive length=%d\n",
						CDC_NCM_NTB_MAX_SIZE_RX);
		ctx->rx_max = CDC_NCM_NTB_MAX_SIZE_RX;
	}

142
	/* inform device about NTB input size changes */
B
Bjørn Mork 已提交
143
	if (ctx->rx_max != le32_to_cpu(ncm_parm.dwNtbInMaxSize)) {
144
		__le32 dwNtbInMaxSize = cpu_to_le32(ctx->rx_max);
145

146 147 148 149
		err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
				       USB_TYPE_CLASS | USB_DIR_OUT
				       | USB_RECIP_INTERFACE,
				       0, iface_no, &dwNtbInMaxSize, 4);
150
		if (err < 0)
151 152 153
			pr_debug("Setting NTB Input Size failed\n");
	}

A
Alexey Orishko 已提交
154 155
	/* verify maximum size of transmitted NTB in bytes */
	if ((ctx->tx_max <
156
	    (min_hdr_size + min_dgram_size)) ||
A
Alexey Orishko 已提交
157 158 159 160
	    (ctx->tx_max > CDC_NCM_NTB_MAX_SIZE_TX)) {
		pr_debug("Using default maximum transmit length=%d\n",
						CDC_NCM_NTB_MAX_SIZE_TX);
		ctx->tx_max = CDC_NCM_NTB_MAX_SIZE_TX;
B
Bjørn Mork 已提交
161 162 163 164 165 166 167 168

		/* Adding a pad byte here simplifies the handling in
		 * cdc_ncm_fill_tx_frame, by making tx_max always
		 * represent the real skb max size.
		 */
		if (ctx->tx_max % usb_maxpacket(dev->udev, dev->out, 1) == 0)
			ctx->tx_max++;

A
Alexey Orishko 已提交
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
	}

	/*
	 * verify that the structure alignment is:
	 * - power of two
	 * - not greater than the maximum transmit length
	 * - not less than four bytes
	 */
	val = ctx->tx_ndp_modulus;

	if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
	    (val != ((-val) & val)) || (val >= ctx->tx_max)) {
		pr_debug("Using default alignment: 4 bytes\n");
		ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
	}

	/*
	 * verify that the payload alignment is:
	 * - power of two
	 * - not greater than the maximum transmit length
	 * - not less than four bytes
	 */
	val = ctx->tx_modulus;

	if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
	    (val != ((-val) & val)) || (val >= ctx->tx_max)) {
		pr_debug("Using default transmit modulus: 4 bytes\n");
		ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
	}

	/* verify the payload remainder */
	if (ctx->tx_remainder >= ctx->tx_modulus) {
		pr_debug("Using default transmit remainder: 0 bytes\n");
		ctx->tx_remainder = 0;
	}

	/* adjust TX-remainder according to NCM specification. */
206 207
	ctx->tx_remainder = ((ctx->tx_remainder - eth_hlen) &
			     (ctx->tx_modulus - 1));
A
Alexey Orishko 已提交
208 209 210 211

	/* additional configuration */

	/* set CRC Mode */
212
	if (flags & USB_CDC_NCM_NCAP_CRC_MODE) {
213 214 215 216 217
		err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
				       USB_TYPE_CLASS | USB_DIR_OUT
				       | USB_RECIP_INTERFACE,
				       USB_CDC_NCM_CRC_NOT_APPENDED,
				       iface_no, NULL, 0);
218
		if (err < 0)
219 220
			pr_debug("Setting CRC mode off failed\n");
	}
A
Alexey Orishko 已提交
221

222 223
	/* set NTB format, if both formats are supported */
	if (ntb_fmt_supported & USB_CDC_NCM_NTH32_SIGN) {
224 225 226 227 228
		err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
				       USB_TYPE_CLASS | USB_DIR_OUT
				       | USB_RECIP_INTERFACE,
				       USB_CDC_NCM_NTB16_FORMAT,
				       iface_no, NULL, 0);
229
		if (err < 0)
230 231
			pr_debug("Setting NTB format to 16-bit failed\n");
	}
A
Alexey Orishko 已提交
232

233
	ctx->max_datagram_size = min_dgram_size;
A
Alexey Orishko 已提交
234 235

	/* set Max Datagram Size (MTU) */
236
	if (flags & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE) {
237
		__le16 max_datagram_size;
238 239 240 241 242 243 244
		u16 eth_max_sz;
		if (ctx->ether_desc != NULL)
			eth_max_sz = le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
		else if (ctx->mbim_desc != NULL)
			eth_max_sz = le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
		else
			goto max_dgram_err;
245

246 247 248 249
		err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
				      USB_TYPE_CLASS | USB_DIR_IN
				      | USB_RECIP_INTERFACE,
				      0, iface_no, &max_datagram_size, 2);
250
		if (err < 0) {
251
			pr_debug("GET_MAX_DATAGRAM_SIZE failed, use size=%u\n",
252
				 min_dgram_size);
253
		} else {
254
			ctx->max_datagram_size =
255
				le16_to_cpu(max_datagram_size);
256
			/* Check Eth descriptor value */
257
			if (ctx->max_datagram_size > eth_max_sz)
258
					ctx->max_datagram_size = eth_max_sz;
259 260

			if (ctx->max_datagram_size > CDC_NCM_MAX_DATAGRAM_SIZE)
261
				ctx->max_datagram_size = CDC_NCM_MAX_DATAGRAM_SIZE;
A
Alexey Orishko 已提交
262

263 264
			if (ctx->max_datagram_size < min_dgram_size)
				ctx->max_datagram_size = min_dgram_size;
265 266

			/* if value changed, update device */
267
			if (ctx->max_datagram_size !=
268
					le16_to_cpu(max_datagram_size)) {
269
				max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
270
				err = usbnet_write_cmd(dev,
271 272 273 274
						USB_CDC_SET_MAX_DATAGRAM_SIZE,
						USB_TYPE_CLASS | USB_DIR_OUT
						 | USB_RECIP_INTERFACE,
						0,
275 276
						iface_no, &max_datagram_size,
						2);
277 278 279
				if (err < 0)
					pr_debug("SET_MAX_DGRAM_SIZE failed\n");
			}
280
		}
A
Alexey Orishko 已提交
281 282
	}

283
max_dgram_err:
284 285
	if (dev->net->mtu != (ctx->max_datagram_size - eth_hlen))
		dev->net->mtu = ctx->max_datagram_size - eth_hlen;
A
Alexey Orishko 已提交
286 287 288 289 290

	return 0;
}

static void
291
cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
A
Alexey Orishko 已提交
292
{
293
	struct usb_host_endpoint *e, *in = NULL, *out = NULL;
A
Alexey Orishko 已提交
294 295 296 297 298 299 300 301
	u8 ep;

	for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {

		e = intf->cur_altsetting->endpoint + ep;
		switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
		case USB_ENDPOINT_XFER_INT:
			if (usb_endpoint_dir_in(&e->desc)) {
302 303
				if (!dev->status)
					dev->status = e;
A
Alexey Orishko 已提交
304 305 306 307 308
			}
			break;

		case USB_ENDPOINT_XFER_BULK:
			if (usb_endpoint_dir_in(&e->desc)) {
309 310
				if (!in)
					in = e;
A
Alexey Orishko 已提交
311
			} else {
312 313
				if (!out)
					out = e;
A
Alexey Orishko 已提交
314 315 316 317 318 319 320
			}
			break;

		default:
			break;
		}
	}
321 322 323 324 325 326 327 328
	if (in && !dev->in)
		dev->in = usb_rcvbulkpipe(dev->udev,
					  in->desc.bEndpointAddress &
					  USB_ENDPOINT_NUMBER_MASK);
	if (out && !dev->out)
		dev->out = usb_sndbulkpipe(dev->udev,
					   out->desc.bEndpointAddress &
					   USB_ENDPOINT_NUMBER_MASK);
A
Alexey Orishko 已提交
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
}

static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
{
	if (ctx == NULL)
		return;

	if (ctx->tx_rem_skb != NULL) {
		dev_kfree_skb_any(ctx->tx_rem_skb);
		ctx->tx_rem_skb = NULL;
	}

	if (ctx->tx_curr_skb != NULL) {
		dev_kfree_skb_any(ctx->tx_curr_skb);
		ctx->tx_curr_skb = NULL;
	}

	kfree(ctx);
}

349
int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting)
A
Alexey Orishko 已提交
350
{
351
	const struct usb_cdc_union_desc *union_desc = NULL;
A
Alexey Orishko 已提交
352 353 354 355 356 357 358
	struct cdc_ncm_ctx *ctx;
	struct usb_driver *driver;
	u8 *buf;
	int len;
	int temp;
	u8 iface_no;

359
	ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
360 361
	if (!ctx)
		return -ENOMEM;
A
Alexey Orishko 已提交
362

363 364
	hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
	ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
365
	ctx->bh.data = (unsigned long)dev;
366 367
	ctx->bh.func = cdc_ncm_txpath_bh;
	atomic_set(&ctx->stop, 0);
A
Alexey Orishko 已提交
368 369 370 371 372
	spin_lock_init(&ctx->mtx);

	/* store ctx pointer in device data field */
	dev->data[0] = (unsigned long)ctx;

373 374 375
	/* only the control interface can be successfully probed */
	ctx->control = intf;

A
Alexey Orishko 已提交
376 377 378 379 380 381 382 383 384 385 386 387 388
	/* get some pointers */
	driver = driver_of(intf);
	buf = intf->cur_altsetting->extra;
	len = intf->cur_altsetting->extralen;

	/* parse through descriptors associated with control interface */
	while ((len > 0) && (buf[0] > 2) && (buf[0] <= len)) {

		if (buf[1] != USB_DT_CS_INTERFACE)
			goto advance;

		switch (buf[2]) {
		case USB_CDC_UNION_TYPE:
389
			if (buf[0] < sizeof(*union_desc))
A
Alexey Orishko 已提交
390 391
				break;

392
			union_desc = (const struct usb_cdc_union_desc *)buf;
393 394 395 396
			/* the master must be the interface we are probing */
			if (intf->cur_altsetting->desc.bInterfaceNumber !=
			    union_desc->bMasterInterface0)
				goto error;
A
Alexey Orishko 已提交
397
			ctx->data = usb_ifnum_to_if(dev->udev,
398
						    union_desc->bSlaveInterface0);
A
Alexey Orishko 已提交
399 400 401 402 403 404 405 406 407 408 409
			break;

		case USB_CDC_ETHERNET_TYPE:
			if (buf[0] < sizeof(*(ctx->ether_desc)))
				break;

			ctx->ether_desc =
					(const struct usb_cdc_ether_desc *)buf;
			dev->hard_mtu =
				le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);

410 411 412 413
			if (dev->hard_mtu < CDC_NCM_MIN_DATAGRAM_SIZE)
				dev->hard_mtu =	CDC_NCM_MIN_DATAGRAM_SIZE;
			else if (dev->hard_mtu > CDC_NCM_MAX_DATAGRAM_SIZE)
				dev->hard_mtu =	CDC_NCM_MAX_DATAGRAM_SIZE;
A
Alexey Orishko 已提交
414 415 416 417 418 419 420 421 422
			break;

		case USB_CDC_NCM_TYPE:
			if (buf[0] < sizeof(*(ctx->func_desc)))
				break;

			ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
			break;

423 424 425 426 427 428 429
		case USB_CDC_MBIM_TYPE:
			if (buf[0] < sizeof(*(ctx->mbim_desc)))
				break;

			ctx->mbim_desc = (const struct usb_cdc_mbim_desc *)buf;
			break;

A
Alexey Orishko 已提交
430 431 432 433 434 435 436 437 438 439
		default:
			break;
		}
advance:
		/* advance to next descriptor */
		temp = buf[0];
		buf += temp;
		len -= temp;
	}

440
	/* some buggy devices have an IAD but no CDC Union */
441
	if (!union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
442 443
		ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
		dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
444 445
	}

A
Alexey Orishko 已提交
446
	/* check if we got everything */
447
	if (!ctx->data || (!ctx->mbim_desc && !ctx->ether_desc))
A
Alexey Orishko 已提交
448 449
		goto error;

B
Bjørn Mork 已提交
450 451 452 453 454 455
	/* claim data interface, if different from control */
	if (ctx->data != ctx->control) {
		temp = usb_driver_claim_interface(driver, ctx->data, dev);
		if (temp)
			goto error;
	}
A
Alexey Orishko 已提交
456 457 458 459 460 461

	iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;

	/* reset data interface */
	temp = usb_set_interface(dev->udev, iface_no, 0);
	if (temp)
462
		goto error2;
A
Alexey Orishko 已提交
463 464

	/* configure data interface */
465
	temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
A
Alexey Orishko 已提交
466
	if (temp)
467
		goto error2;
A
Alexey Orishko 已提交
468

469 470 471
	cdc_ncm_find_endpoints(dev, ctx->data);
	cdc_ncm_find_endpoints(dev, ctx->control);
	if (!dev->in || !dev->out || !dev->status)
472
		goto error2;
A
Alexey Orishko 已提交
473

B
Bjørn Mork 已提交
474 475 476 477
	/* initialize data interface */
	if (cdc_ncm_setup(dev))
		goto error2;

A
Alexey Orishko 已提交
478 479 480
	usb_set_intfdata(ctx->data, dev);
	usb_set_intfdata(ctx->control, dev);

481 482 483 484 485 486
	if (ctx->ether_desc) {
		temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
		if (temp)
			goto error2;
		dev_info(&dev->udev->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
	}
A
Alexey Orishko 已提交
487 488 489 490 491

	dev->rx_urb_size = ctx->rx_max;

	return 0;

492 493 494
error2:
	usb_set_intfdata(ctx->control, NULL);
	usb_set_intfdata(ctx->data, NULL);
495 496
	if (ctx->data != ctx->control)
		usb_driver_release_interface(driver, ctx->data);
A
Alexey Orishko 已提交
497 498 499
error:
	cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
	dev->data[0] = 0;
500
	dev_info(&dev->udev->dev, "bind() failure\n");
A
Alexey Orishko 已提交
501 502
	return -ENODEV;
}
503
EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
A
Alexey Orishko 已提交
504

505
void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
A
Alexey Orishko 已提交
506 507
{
	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
508
	struct usb_driver *driver = driver_of(intf);
A
Alexey Orishko 已提交
509 510 511 512

	if (ctx == NULL)
		return;		/* no setup */

513 514 515 516 517 518 519
	atomic_set(&ctx->stop, 1);

	if (hrtimer_active(&ctx->tx_timer))
		hrtimer_cancel(&ctx->tx_timer);

	tasklet_kill(&ctx->bh);

B
Bjørn Mork 已提交
520 521 522 523
	/* handle devices with combined control and data interface */
	if (ctx->control == ctx->data)
		ctx->data = NULL;

524 525 526
	/* disconnect master --> disconnect slave */
	if (intf == ctx->control && ctx->data) {
		usb_set_intfdata(ctx->data, NULL);
A
Alexey Orishko 已提交
527
		usb_driver_release_interface(driver, ctx->data);
528
		ctx->data = NULL;
A
Alexey Orishko 已提交
529

530 531
	} else if (intf == ctx->data && ctx->control) {
		usb_set_intfdata(ctx->control, NULL);
A
Alexey Orishko 已提交
532
		usb_driver_release_interface(driver, ctx->control);
533
		ctx->control = NULL;
A
Alexey Orishko 已提交
534 535
	}

536
	usb_set_intfdata(intf, NULL);
A
Alexey Orishko 已提交
537 538
	cdc_ncm_free(ctx);
}
539
EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
A
Alexey Orishko 已提交
540

541 542 543 544
/* Select the MBIM altsetting iff it is preferred and available,
 * returning the number of the corresponding data interface altsetting
 */
u8 cdc_ncm_select_altsetting(struct usbnet *dev, struct usb_interface *intf)
545
{
546
	struct usb_host_interface *alt;
547

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
	/* The MBIM spec defines a NCM compatible default altsetting,
	 * which we may have matched:
	 *
	 *  "Functions that implement both NCM 1.0 and MBIM (an
	 *   “NCM/MBIM function”) according to this recommendation
	 *   shall provide two alternate settings for the
	 *   Communication Interface.  Alternate setting 0, and the
	 *   associated class and endpoint descriptors, shall be
	 *   constructed according to the rules given for the
	 *   Communication Interface in section 5 of [USBNCM10].
	 *   Alternate setting 1, and the associated class and
	 *   endpoint descriptors, shall be constructed according to
	 *   the rules given in section 6 (USB Device Model) of this
	 *   specification."
	 */
563 564 565 566 567 568 569
	if (prefer_mbim && intf->num_altsetting == 2) {
		alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
		if (alt && cdc_ncm_comm_intf_is_mbim(alt) &&
		    !usb_set_interface(dev->udev,
				       intf->cur_altsetting->desc.bInterfaceNumber,
				       CDC_NCM_COMM_ALTSETTING_MBIM))
			return CDC_NCM_DATA_ALTSETTING_MBIM;
570
	}
571 572 573 574 575 576 577 578 579 580 581 582
	return CDC_NCM_DATA_ALTSETTING_NCM;
}
EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);

static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
{
	int ret;

	/* MBIM backwards compatible function? */
	cdc_ncm_select_altsetting(dev, intf);
	if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting))
		return -ENODEV;
583

584 585 586 587 588 589 590 591 592
	/* NCM data altsetting is always 1 */
	ret = cdc_ncm_bind_common(dev, intf, 1);

	/*
	 * We should get an event when network connection is "connected" or
	 * "disconnected". Set network connection in "disconnected" state
	 * (carrier is OFF) during attach, so the IP network stack does not
	 * start IPv6 negotiation and more.
	 */
593
	usbnet_link_change(dev, 0, 0);
594 595 596
	return ret;
}

597
static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
A
Alexey Orishko 已提交
598
{
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
	size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;

	if (skb->len + align > max)
		align = max - skb->len;
	if (align && skb_tailroom(skb) >= align)
		memset(skb_put(skb, align), 0, align);
}

/* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
 * allocating a new one within skb
 */
static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
{
	struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
	struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
	size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);

	/* follow the chain of NDPs, looking for a match */
	while (ndpoffset) {
		ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
		if  (ndp16->dwSignature == sign)
			return ndp16;
		ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
	}

	/* align new NDP */
	cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);

	/* verify that there is room for the NDP and the datagram (reserve) */
	if ((ctx->tx_max - skb->len - reserve) < CDC_NCM_NDP_SIZE)
		return NULL;

	/* link to it */
	if (ndp16)
		ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
	else
		nth16->wNdpIndex = cpu_to_le16(skb->len);

	/* push a new empty NDP */
	ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, CDC_NCM_NDP_SIZE), 0, CDC_NCM_NDP_SIZE);
	ndp16->dwSignature = sign;
	ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
	return ndp16;
A
Alexey Orishko 已提交
642 643
}

644
struct sk_buff *
645
cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
A
Alexey Orishko 已提交
646
{
647
	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
648 649
	struct usb_cdc_ncm_nth16 *nth16;
	struct usb_cdc_ncm_ndp16 *ndp16;
A
Alexey Orishko 已提交
650
	struct sk_buff *skb_out;
651
	u16 n = 0, index, ndplen;
652
	u8 ready2send = 0;
A
Alexey Orishko 已提交
653 654

	/* if there is a remaining skb, it gets priority */
655
	if (skb != NULL) {
A
Alexey Orishko 已提交
656
		swap(skb, ctx->tx_rem_skb);
657 658
		swap(sign, ctx->tx_rem_sign);
	} else {
659
		ready2send = 1;
660
	}
A
Alexey Orishko 已提交
661 662

	/* check if we are resuming an OUT skb */
663
	skb_out = ctx->tx_curr_skb;
A
Alexey Orishko 已提交
664

665 666
	/* allocate a new OUT skb */
	if (!skb_out) {
667
		skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
A
Alexey Orishko 已提交
668 669 670
		if (skb_out == NULL) {
			if (skb != NULL) {
				dev_kfree_skb_any(skb);
671
				dev->net->stats.tx_dropped++;
A
Alexey Orishko 已提交
672 673 674
			}
			goto exit_no_skb;
		}
675 676 677 678 679
		/* fill out the initial 16-bit NTB header */
		nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
		nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
		nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
		nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
A
Alexey Orishko 已提交
680

681
		/* count total number of frames in this NTB */
A
Alexey Orishko 已提交
682 683 684
		ctx->tx_curr_frame_num = 0;
	}

685 686
	for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
		/* send any remaining skb first */
A
Alexey Orishko 已提交
687 688
		if (skb == NULL) {
			skb = ctx->tx_rem_skb;
689
			sign = ctx->tx_rem_sign;
A
Alexey Orishko 已提交
690 691 692 693 694 695 696
			ctx->tx_rem_skb = NULL;

			/* check for end of skb */
			if (skb == NULL)
				break;
		}

697 698 699 700 701 702 703 704
		/* get the appropriate NDP for this skb */
		ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);

		/* align beginning of next frame */
		cdc_ncm_align_tail(skb_out,  ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);

		/* check if we had enough room left for both NDP and frame */
		if (!ndp16 || skb_out->len + skb->len > ctx->tx_max) {
A
Alexey Orishko 已提交
705 706 707 708
			if (n == 0) {
				/* won't fit, MTU problem? */
				dev_kfree_skb_any(skb);
				skb = NULL;
709
				dev->net->stats.tx_dropped++;
A
Alexey Orishko 已提交
710 711 712 713
			} else {
				/* no room for skb - store for later */
				if (ctx->tx_rem_skb != NULL) {
					dev_kfree_skb_any(ctx->tx_rem_skb);
714
					dev->net->stats.tx_dropped++;
A
Alexey Orishko 已提交
715 716
				}
				ctx->tx_rem_skb = skb;
717
				ctx->tx_rem_sign = sign;
A
Alexey Orishko 已提交
718
				skb = NULL;
719
				ready2send = 1;
A
Alexey Orishko 已提交
720 721 722 723
			}
			break;
		}

724 725 726
		/* calculate frame number withing this NDP */
		ndplen = le16_to_cpu(ndp16->wLength);
		index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
A
Alexey Orishko 已提交
727

728 729 730 731 732
		/* OK, add this skb */
		ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
		ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
		ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
		memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
A
Alexey Orishko 已提交
733 734
		dev_kfree_skb_any(skb);
		skb = NULL;
735 736 737 738 739 740

		/* send now if this NDP is full */
		if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
			ready2send = 1;
			break;
		}
A
Alexey Orishko 已提交
741 742 743 744 745 746
	}

	/* free up any dangling skb */
	if (skb != NULL) {
		dev_kfree_skb_any(skb);
		skb = NULL;
747
		dev->net->stats.tx_dropped++;
A
Alexey Orishko 已提交
748 749 750 751 752 753 754 755 756 757
	}

	ctx->tx_curr_frame_num = n;

	if (n == 0) {
		/* wait for more frames */
		/* push variables */
		ctx->tx_curr_skb = skb_out;
		goto exit_no_skb;

758
	} else if ((n < ctx->tx_max_datagrams) && (ready2send == 0)) {
A
Alexey Orishko 已提交
759 760 761 762 763
		/* wait for more frames */
		/* push variables */
		ctx->tx_curr_skb = skb_out;
		/* set the pending count */
		if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
764
			ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
A
Alexey Orishko 已提交
765 766 767 768 769 770 771
		goto exit_no_skb;

	} else {
		/* frame goes out */
		/* variables will be reset at next call */
	}

772 773 774 775 776
	/* If collected data size is less or equal CDC_NCM_MIN_TX_PKT
	 * bytes, we send buffers as it is. If we get more data, it
	 * would be more efficient for USB HS mobile device with DMA
	 * engine to receive a full size NTB, than canceling DMA
	 * transfer and receiving a short packet.
777 778 779
	 *
	 * This optimization support is pointless if we end up sending
	 * a ZLP after full sized NTBs.
A
Alexey Orishko 已提交
780
	 */
781 782
	if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
	    skb_out->len > CDC_NCM_MIN_TX_PKT)
783 784 785
		memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
		       ctx->tx_max - skb_out->len);
	else if ((skb_out->len % dev->maxpacket) == 0)
786
		*skb_put(skb_out, 1) = 0;	/* force short packet */
A
Alexey Orishko 已提交
787

788 789 790
	/* set final frame length */
	nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
	nth16->wBlockLength = cpu_to_le16(skb_out->len);
A
Alexey Orishko 已提交
791 792 793

	/* return skb */
	ctx->tx_curr_skb = NULL;
794
	dev->net->stats.tx_packets += ctx->tx_curr_frame_num;
A
Alexey Orishko 已提交
795 796 797
	return skb_out;

exit_no_skb:
798 799 800
	/* Start timer, if there is a remaining skb */
	if (ctx->tx_curr_skb != NULL)
		cdc_ncm_tx_timeout_start(ctx);
A
Alexey Orishko 已提交
801 802
	return NULL;
}
803
EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
A
Alexey Orishko 已提交
804 805 806 807

static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
{
	/* start timer, if not already started */
808 809 810 811
	if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
		hrtimer_start(&ctx->tx_timer,
				ktime_set(0, CDC_NCM_TIMER_INTERVAL),
				HRTIMER_MODE_REL);
A
Alexey Orishko 已提交
812 813
}

814
static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
A
Alexey Orishko 已提交
815
{
816 817
	struct cdc_ncm_ctx *ctx =
			container_of(timer, struct cdc_ncm_ctx, tx_timer);
A
Alexey Orishko 已提交
818

819 820 821 822
	if (!atomic_read(&ctx->stop))
		tasklet_schedule(&ctx->bh);
	return HRTIMER_NORESTART;
}
A
Alexey Orishko 已提交
823

824 825
static void cdc_ncm_txpath_bh(unsigned long param)
{
826 827
	struct usbnet *dev = (struct usbnet *)param;
	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
A
Alexey Orishko 已提交
828

829 830 831
	spin_lock_bh(&ctx->mtx);
	if (ctx->tx_timer_pending != 0) {
		ctx->tx_timer_pending--;
A
Alexey Orishko 已提交
832
		cdc_ncm_tx_timeout_start(ctx);
833
		spin_unlock_bh(&ctx->mtx);
834
	} else if (dev->net != NULL) {
835
		spin_unlock_bh(&ctx->mtx);
836 837 838
		netif_tx_lock_bh(dev->net);
		usbnet_start_xmit(NULL, dev->net);
		netif_tx_unlock_bh(dev->net);
B
Bjørn Mork 已提交
839 840
	} else {
		spin_unlock_bh(&ctx->mtx);
841
	}
A
Alexey Orishko 已提交
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
}

static struct sk_buff *
cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
{
	struct sk_buff *skb_out;
	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];

	/*
	 * The Ethernet API we are using does not support transmitting
	 * multiple Ethernet frames in a single call. This driver will
	 * accumulate multiple Ethernet frames and send out a larger
	 * USB frame when the USB buffer is full or when a single jiffies
	 * timeout happens.
	 */
	if (ctx == NULL)
		goto error;

860
	spin_lock_bh(&ctx->mtx);
861
	skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
862
	spin_unlock_bh(&ctx->mtx);
A
Alexey Orishko 已提交
863 864 865 866 867 868 869 870 871
	return skb_out;

error:
	if (skb != NULL)
		dev_kfree_skb_any(skb);

	return NULL;
}

872
/* verify NTB header and return offset of first NDP, or negative error */
873
int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
A
Alexey Orishko 已提交
874
{
875
	struct usb_cdc_ncm_nth16 *nth16;
876 877
	int len;
	int ret = -EINVAL;
A
Alexey Orishko 已提交
878 879 880 881

	if (ctx == NULL)
		goto error;

882 883
	if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
					sizeof(struct usb_cdc_ncm_ndp16))) {
A
Alexey Orishko 已提交
884 885 886 887
		pr_debug("frame too short\n");
		goto error;
	}

888
	nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
A
Alexey Orishko 已提交
889

890
	if (le32_to_cpu(nth16->dwSignature) != USB_CDC_NCM_NTH16_SIGN) {
A
Alexey Orishko 已提交
891
		pr_debug("invalid NTH16 signature <%u>\n",
892
					le32_to_cpu(nth16->dwSignature));
A
Alexey Orishko 已提交
893 894 895
		goto error;
	}

896 897 898 899
	len = le16_to_cpu(nth16->wBlockLength);
	if (len > ctx->rx_max) {
		pr_debug("unsupported NTB block length %u/%u\n", len,
								ctx->rx_max);
A
Alexey Orishko 已提交
900 901 902
		goto error;
	}

903 904 905 906 907 908 909 910
	if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
		(ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
		!((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
		pr_debug("sequence number glitch prev=%d curr=%d\n",
				ctx->rx_seq, le16_to_cpu(nth16->wSequence));
	}
	ctx->rx_seq = le16_to_cpu(nth16->wSequence);

911 912 913 914
	ret = le16_to_cpu(nth16->wNdpIndex);
error:
	return ret;
}
915
EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
916 917

/* verify NDP header and return number of datagrams, or negative error */
918
int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
919 920 921 922
{
	struct usb_cdc_ncm_ndp16 *ndp16;
	int ret = -EINVAL;

B
Bjørn Mork 已提交
923 924
	if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
		pr_debug("invalid NDP offset  <%u>\n", ndpoffset);
A
Alexey Orishko 已提交
925 926
		goto error;
	}
B
Bjørn Mork 已提交
927
	ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
A
Alexey Orishko 已提交
928

929
	if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
A
Alexey Orishko 已提交
930
		pr_debug("invalid DPT16 length <%u>\n",
931
					le32_to_cpu(ndp16->dwSignature));
932
		goto error;
A
Alexey Orishko 已提交
933 934
	}

935
	ret = ((le16_to_cpu(ndp16->wLength) -
A
Alexey Orishko 已提交
936 937
					sizeof(struct usb_cdc_ncm_ndp16)) /
					sizeof(struct usb_cdc_ncm_dpe16));
938
	ret--; /* we process NDP entries except for the last one */
A
Alexey Orishko 已提交
939

940
	if ((sizeof(struct usb_cdc_ncm_ndp16) + ret * (sizeof(struct usb_cdc_ncm_dpe16))) >
941
								skb_in->len) {
942 943
		pr_debug("Invalid nframes = %d\n", ret);
		ret = -EINVAL;
A
Alexey Orishko 已提交
944 945
	}

946 947 948
error:
	return ret;
}
949
EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980

static int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
{
	struct sk_buff *skb;
	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
	int len;
	int nframes;
	int x;
	int offset;
	struct usb_cdc_ncm_ndp16 *ndp16;
	struct usb_cdc_ncm_dpe16 *dpe16;
	int ndpoffset;
	int loopcount = 50; /* arbitrary max preventing infinite loop */

	ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
	if (ndpoffset < 0)
		goto error;

next_ndp:
	nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
	if (nframes < 0)
		goto error;

	ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);

	if (le32_to_cpu(ndp16->dwSignature) != USB_CDC_NCM_NDP16_NOCRC_SIGN) {
		pr_debug("invalid DPT16 signature <%u>\n",
			 le32_to_cpu(ndp16->dwSignature));
		goto err_ndp;
	}
	dpe16 = ndp16->dpe16;
A
Alexey Orishko 已提交
981

982 983 984
	for (x = 0; x < nframes; x++, dpe16++) {
		offset = le16_to_cpu(dpe16->wDatagramIndex);
		len = le16_to_cpu(dpe16->wDatagramLength);
A
Alexey Orishko 已提交
985 986 987 988 989

		/*
		 * CDC NCM ch. 3.7
		 * All entries after first NULL entry are to be ignored
		 */
990
		if ((offset == 0) || (len == 0)) {
A
Alexey Orishko 已提交
991
			if (!x)
B
Bjørn Mork 已提交
992
				goto err_ndp; /* empty NTB */
A
Alexey Orishko 已提交
993 994 995 996
			break;
		}

		/* sanity checking */
997 998
		if (((offset + len) > skb_in->len) ||
				(len > ctx->rx_max) || (len < ETH_HLEN)) {
A
Alexey Orishko 已提交
999
			pr_debug("invalid frame detected (ignored)"
1000
					"offset[%u]=%u, length=%u, skb=%p\n",
1001
					x, offset, len, skb_in);
A
Alexey Orishko 已提交
1002
			if (!x)
B
Bjørn Mork 已提交
1003
				goto err_ndp;
A
Alexey Orishko 已提交
1004 1005 1006 1007
			break;

		} else {
			skb = skb_clone(skb_in, GFP_ATOMIC);
1008 1009
			if (!skb)
				goto error;
1010
			skb->len = len;
A
Alexey Orishko 已提交
1011
			skb->data = ((u8 *)skb_in->data) + offset;
1012
			skb_set_tail_pointer(skb, len);
A
Alexey Orishko 已提交
1013 1014 1015
			usbnet_skb_return(dev, skb);
		}
	}
B
Bjørn Mork 已提交
1016 1017 1018 1019 1020 1021
err_ndp:
	/* are there more NDPs to process? */
	ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
	if (ndpoffset && loopcount--)
		goto next_ndp;

A
Alexey Orishko 已提交
1022 1023 1024 1025 1026 1027
	return 1;
error:
	return 0;
}

static void
1028
cdc_ncm_speed_change(struct usbnet *dev,
1029
		     struct usb_cdc_speed_change *data)
A
Alexey Orishko 已提交
1030
{
1031 1032
	uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
	uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
A
Alexey Orishko 已提交
1033 1034 1035 1036 1037

	/*
	 * Currently the USB-NET API does not support reporting the actual
	 * device speed. Do print it instead.
	 */
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
	if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
		printk(KERN_INFO KBUILD_MODNAME
		       ": %s: %u mbit/s downlink "
		       "%u mbit/s uplink\n",
		       dev->net->name,
		       (unsigned int)(rx_speed / 1000000U),
		       (unsigned int)(tx_speed / 1000000U));
	} else {
		printk(KERN_INFO KBUILD_MODNAME
		       ": %s: %u kbit/s downlink "
		       "%u kbit/s uplink\n",
		       dev->net->name,
		       (unsigned int)(rx_speed / 1000U),
		       (unsigned int)(tx_speed / 1000U));
A
Alexey Orishko 已提交
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
	}
}

static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
{
	struct cdc_ncm_ctx *ctx;
	struct usb_cdc_notification *event;

	ctx = (struct cdc_ncm_ctx *)dev->data[0];

	if (urb->actual_length < sizeof(*event))
		return;

	/* test for split data in 8-byte chunks */
	if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1067
		cdc_ncm_speed_change(dev,
1068
		      (struct usb_cdc_speed_change *)urb->transfer_buffer);
A
Alexey Orishko 已提交
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
		return;
	}

	event = urb->transfer_buffer;

	switch (event->bNotificationType) {
	case USB_CDC_NOTIFY_NETWORK_CONNECTION:
		/*
		 * According to the CDC NCM specification ch.7.1
		 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
		 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
		 */
B
Bjørn Mork 已提交
1081
		ctx->connected = le16_to_cpu(event->wValue);
A
Alexey Orishko 已提交
1082 1083

		printk(KERN_INFO KBUILD_MODNAME ": %s: network connection:"
1084 1085
		       " %sconnected\n",
		       dev->net->name, ctx->connected ? "" : "dis");
A
Alexey Orishko 已提交
1086

1087
		usbnet_link_change(dev, ctx->connected, 0);
A
Alexey Orishko 已提交
1088 1089 1090
		break;

	case USB_CDC_NOTIFY_SPEED_CHANGE:
1091 1092
		if (urb->actual_length < (sizeof(*event) +
					sizeof(struct usb_cdc_speed_change)))
A
Alexey Orishko 已提交
1093 1094
			set_bit(EVENT_STS_SPLIT, &dev->flags);
		else
1095 1096
			cdc_ncm_speed_change(dev,
					     (struct usb_cdc_speed_change *)&event[1]);
A
Alexey Orishko 已提交
1097 1098 1099
		break;

	default:
1100 1101 1102
		dev_dbg(&dev->udev->dev,
			"NCM: unexpected notification 0x%02x!\n",
			event->bNotificationType);
A
Alexey Orishko 已提交
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
		break;
	}
}

static int cdc_ncm_check_connect(struct usbnet *dev)
{
	struct cdc_ncm_ctx *ctx;

	ctx = (struct cdc_ncm_ctx *)dev->data[0];
	if (ctx == NULL)
		return 1;	/* disconnected */

	return !ctx->connected;
}

static const struct driver_info cdc_ncm_info = {
	.description = "CDC NCM",
1120
	.flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
A
Alexey Orishko 已提交
1121 1122 1123
	.bind = cdc_ncm_bind,
	.unbind = cdc_ncm_unbind,
	.check_connect = cdc_ncm_check_connect,
O
Oliver Neukum 已提交
1124
	.manage_power = usbnet_manage_power,
A
Alexey Orishko 已提交
1125 1126 1127 1128 1129
	.status = cdc_ncm_status,
	.rx_fixup = cdc_ncm_rx_fixup,
	.tx_fixup = cdc_ncm_tx_fixup,
};

1130 1131 1132 1133 1134 1135 1136 1137
/* Same as cdc_ncm_info, but with FLAG_WWAN */
static const struct driver_info wwan_info = {
	.description = "Mobile Broadband Network Device",
	.flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
			| FLAG_WWAN,
	.bind = cdc_ncm_bind,
	.unbind = cdc_ncm_unbind,
	.check_connect = cdc_ncm_check_connect,
O
Oliver Neukum 已提交
1138
	.manage_power = usbnet_manage_power,
1139 1140 1141 1142 1143
	.status = cdc_ncm_status,
	.rx_fixup = cdc_ncm_rx_fixup,
	.tx_fixup = cdc_ncm_tx_fixup,
};

1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
/* Same as wwan_info, but with FLAG_NOARP  */
static const struct driver_info wwan_noarp_info = {
	.description = "Mobile Broadband Network Device (NO ARP)",
	.flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
			| FLAG_WWAN | FLAG_NOARP,
	.bind = cdc_ncm_bind,
	.unbind = cdc_ncm_unbind,
	.check_connect = cdc_ncm_check_connect,
	.manage_power = usbnet_manage_power,
	.status = cdc_ncm_status,
	.rx_fixup = cdc_ncm_rx_fixup,
	.tx_fixup = cdc_ncm_tx_fixup,
};

1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
static const struct usb_device_id cdc_devs[] = {
	/* Ericsson MBM devices like F5521gw */
	{ .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
		| USB_DEVICE_ID_MATCH_VENDOR,
	  .idVendor = 0x0bdb,
	  .bInterfaceClass = USB_CLASS_COMM,
	  .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
	  .bInterfaceProtocol = USB_CDC_PROTO_NONE,
	  .driver_info = (unsigned long) &wwan_info,
	},

1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
	/* Dell branded MBM devices like DW5550 */
	{ .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
		| USB_DEVICE_ID_MATCH_VENDOR,
	  .idVendor = 0x413c,
	  .bInterfaceClass = USB_CLASS_COMM,
	  .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
	  .bInterfaceProtocol = USB_CDC_PROTO_NONE,
	  .driver_info = (unsigned long) &wwan_info,
	},

	/* Toshiba branded MBM devices */
	{ .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
		| USB_DEVICE_ID_MATCH_VENDOR,
	  .idVendor = 0x0930,
	  .bInterfaceClass = USB_CLASS_COMM,
	  .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
	  .bInterfaceProtocol = USB_CDC_PROTO_NONE,
	  .driver_info = (unsigned long) &wwan_info,
	},

1189 1190 1191 1192 1193 1194 1195 1196
	/* tag Huawei devices as wwan */
	{ USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
					USB_CLASS_COMM,
					USB_CDC_SUBCLASS_NCM,
					USB_CDC_PROTO_NONE),
	  .driver_info = (unsigned long)&wwan_info,
	},

B
Bjørn Mork 已提交
1197 1198 1199 1200 1201 1202 1203
	/* Huawei NCM devices disguised as vendor specific */
	{ USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x16),
	  .driver_info = (unsigned long)&wwan_info,
	},
	{ USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x46),
	  .driver_info = (unsigned long)&wwan_info,
	},
1204 1205 1206
	{ USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x76),
	  .driver_info = (unsigned long)&wwan_info,
	},
B
Bjørn Mork 已提交
1207

1208 1209 1210 1211 1212 1213 1214
	/* Infineon(now Intel) HSPA Modem platform */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
		USB_CLASS_COMM,
		USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
	  .driver_info = (unsigned long)&wwan_noarp_info,
	},

1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
	/* Generic CDC-NCM devices */
	{ USB_INTERFACE_INFO(USB_CLASS_COMM,
		USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
		.driver_info = (unsigned long)&cdc_ncm_info,
	},
	{
	},
};
MODULE_DEVICE_TABLE(usb, cdc_devs);

A
Alexey Orishko 已提交
1225 1226 1227
static struct usb_driver cdc_ncm_driver = {
	.name = "cdc_ncm",
	.id_table = cdc_devs,
1228 1229
	.probe = usbnet_probe,
	.disconnect = usbnet_disconnect,
A
Alexey Orishko 已提交
1230 1231
	.suspend = usbnet_suspend,
	.resume = usbnet_resume,
1232
	.reset_resume =	usbnet_resume,
A
Alexey Orishko 已提交
1233
	.supports_autosuspend = 1,
1234
	.disable_hub_initiated_lpm = 1,
A
Alexey Orishko 已提交
1235 1236
};

1237
module_usb_driver(cdc_ncm_driver);
A
Alexey Orishko 已提交
1238 1239 1240 1241

MODULE_AUTHOR("Hans Petter Selasky");
MODULE_DESCRIPTION("USB CDC NCM host driver");
MODULE_LICENSE("Dual BSD/GPL");