xref: /openbmc/linux/drivers/net/usb/cdc_ncm.c (revision 9fe0234c)
1 /*
2  * cdc_ncm.c
3  *
4  * Copyright (C) ST-Ericsson 2010-2012
5  * Contact: Alexey Orishko <alexey.orishko@stericsson.com>
6  * Original author: Hans Petter Selasky <hans.petter.selasky@stericsson.com>
7  *
8  * USB Host Driver for Network Control Model (NCM)
9  * http://www.usb.org/developers/devclass_docs/NCM10.zip
10  *
11  * The NCM encoding, decoding and initialization logic
12  * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
13  *
14  * This software is available to you under a choice of one of two
15  * licenses. You may choose this file to be licensed under the terms
16  * of the GNU General Public License (GPL) Version 2 or the 2-clause
17  * BSD license listed below:
18  *
19  * Redistribution and use in source and binary forms, with or without
20  * modification, are permitted provided that the following conditions
21  * are met:
22  * 1. Redistributions of source code must retain the above copyright
23  *    notice, this list of conditions and the following disclaimer.
24  * 2. Redistributions in binary form must reproduce the above copyright
25  *    notice, this list of conditions and the following disclaimer in the
26  *    documentation and/or other materials provided with the distribution.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  */
40 
41 #include <linux/module.h>
42 #include <linux/init.h>
43 #include <linux/netdevice.h>
44 #include <linux/ctype.h>
45 #include <linux/ethtool.h>
46 #include <linux/workqueue.h>
47 #include <linux/mii.h>
48 #include <linux/crc32.h>
49 #include <linux/usb.h>
50 #include <linux/hrtimer.h>
51 #include <linux/atomic.h>
52 #include <linux/usb/usbnet.h>
53 #include <linux/usb/cdc.h>
54 #include <linux/usb/cdc_ncm.h>
55 
56 #define	DRIVER_VERSION				"14-Mar-2012"
57 
58 #if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
59 static bool prefer_mbim = true;
60 #else
61 static bool prefer_mbim;
62 #endif
63 module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
64 MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
65 
66 static void cdc_ncm_txpath_bh(unsigned long param);
67 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx);
68 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *hr_timer);
69 static struct usb_driver cdc_ncm_driver;
70 
71 static void
72 cdc_ncm_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
73 {
74 	struct usbnet *dev = netdev_priv(net);
75 
76 	strlcpy(info->driver, dev->driver_name, sizeof(info->driver));
77 	strlcpy(info->version, DRIVER_VERSION, sizeof(info->version));
78 	strlcpy(info->fw_version, dev->driver_info->description,
79 		sizeof(info->fw_version));
80 	usb_make_path(dev->udev, info->bus_info, sizeof(info->bus_info));
81 }
82 
83 static u8 cdc_ncm_setup(struct usbnet *dev)
84 {
85 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
86 	struct usb_cdc_ncm_ntb_parameters ncm_parm;
87 	u32 val;
88 	u8 flags;
89 	u8 iface_no;
90 	int err;
91 	int eth_hlen;
92 	u16 ntb_fmt_supported;
93 	u32 min_dgram_size;
94 	u32 min_hdr_size;
95 
96 	iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
97 
98 	err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
99 			      USB_TYPE_CLASS | USB_DIR_IN
100 			      |USB_RECIP_INTERFACE,
101 			      0, iface_no, &ncm_parm,
102 			      sizeof(ncm_parm));
103 	if (err < 0) {
104 		pr_debug("failed GET_NTB_PARAMETERS\n");
105 		return 1;
106 	}
107 
108 	/* read correct set of parameters according to device mode */
109 	ctx->rx_max = le32_to_cpu(ncm_parm.dwNtbInMaxSize);
110 	ctx->tx_max = le32_to_cpu(ncm_parm.dwNtbOutMaxSize);
111 	ctx->tx_remainder = le16_to_cpu(ncm_parm.wNdpOutPayloadRemainder);
112 	ctx->tx_modulus = le16_to_cpu(ncm_parm.wNdpOutDivisor);
113 	ctx->tx_ndp_modulus = le16_to_cpu(ncm_parm.wNdpOutAlignment);
114 	/* devices prior to NCM Errata shall set this field to zero */
115 	ctx->tx_max_datagrams = le16_to_cpu(ncm_parm.wNtbOutMaxDatagrams);
116 	ntb_fmt_supported = le16_to_cpu(ncm_parm.bmNtbFormatsSupported);
117 
118 	eth_hlen = ETH_HLEN;
119 	min_dgram_size = CDC_NCM_MIN_DATAGRAM_SIZE;
120 	min_hdr_size = CDC_NCM_MIN_HDR_SIZE;
121 	if (ctx->mbim_desc != NULL) {
122 		flags = ctx->mbim_desc->bmNetworkCapabilities;
123 		eth_hlen = 0;
124 		min_dgram_size = CDC_MBIM_MIN_DATAGRAM_SIZE;
125 		min_hdr_size = 0;
126 	} else if (ctx->func_desc != NULL) {
127 		flags = ctx->func_desc->bmNetworkCapabilities;
128 	} else {
129 		flags = 0;
130 	}
131 
132 	pr_debug("dwNtbInMaxSize=%u dwNtbOutMaxSize=%u "
133 		 "wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u "
134 		 "wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
135 		 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
136 		 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, flags);
137 
138 	/* max count of tx datagrams */
139 	if ((ctx->tx_max_datagrams == 0) ||
140 			(ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
141 		ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
142 
143 	/* verify maximum size of received NTB in bytes */
144 	if (ctx->rx_max < USB_CDC_NCM_NTB_MIN_IN_SIZE) {
145 		pr_debug("Using min receive length=%d\n",
146 						USB_CDC_NCM_NTB_MIN_IN_SIZE);
147 		ctx->rx_max = USB_CDC_NCM_NTB_MIN_IN_SIZE;
148 	}
149 
150 	if (ctx->rx_max > CDC_NCM_NTB_MAX_SIZE_RX) {
151 		pr_debug("Using default maximum receive length=%d\n",
152 						CDC_NCM_NTB_MAX_SIZE_RX);
153 		ctx->rx_max = CDC_NCM_NTB_MAX_SIZE_RX;
154 	}
155 
156 	/* inform device about NTB input size changes */
157 	if (ctx->rx_max != le32_to_cpu(ncm_parm.dwNtbInMaxSize)) {
158 		__le32 dwNtbInMaxSize = cpu_to_le32(ctx->rx_max);
159 
160 		err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
161 				       USB_TYPE_CLASS | USB_DIR_OUT
162 				       | USB_RECIP_INTERFACE,
163 				       0, iface_no, &dwNtbInMaxSize, 4);
164 		if (err < 0)
165 			pr_debug("Setting NTB Input Size failed\n");
166 	}
167 
168 	/* verify maximum size of transmitted NTB in bytes */
169 	if ((ctx->tx_max <
170 	    (min_hdr_size + min_dgram_size)) ||
171 	    (ctx->tx_max > CDC_NCM_NTB_MAX_SIZE_TX)) {
172 		pr_debug("Using default maximum transmit length=%d\n",
173 						CDC_NCM_NTB_MAX_SIZE_TX);
174 		ctx->tx_max = CDC_NCM_NTB_MAX_SIZE_TX;
175 
176 		/* Adding a pad byte here simplifies the handling in
177 		 * cdc_ncm_fill_tx_frame, by making tx_max always
178 		 * represent the real skb max size.
179 		 */
180 		if (ctx->tx_max % usb_maxpacket(dev->udev, dev->out, 1) == 0)
181 			ctx->tx_max++;
182 
183 	}
184 
185 	/*
186 	 * verify that the structure alignment is:
187 	 * - power of two
188 	 * - not greater than the maximum transmit length
189 	 * - not less than four bytes
190 	 */
191 	val = ctx->tx_ndp_modulus;
192 
193 	if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
194 	    (val != ((-val) & val)) || (val >= ctx->tx_max)) {
195 		pr_debug("Using default alignment: 4 bytes\n");
196 		ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
197 	}
198 
199 	/*
200 	 * verify that the payload alignment is:
201 	 * - power of two
202 	 * - not greater than the maximum transmit length
203 	 * - not less than four bytes
204 	 */
205 	val = ctx->tx_modulus;
206 
207 	if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
208 	    (val != ((-val) & val)) || (val >= ctx->tx_max)) {
209 		pr_debug("Using default transmit modulus: 4 bytes\n");
210 		ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
211 	}
212 
213 	/* verify the payload remainder */
214 	if (ctx->tx_remainder >= ctx->tx_modulus) {
215 		pr_debug("Using default transmit remainder: 0 bytes\n");
216 		ctx->tx_remainder = 0;
217 	}
218 
219 	/* adjust TX-remainder according to NCM specification. */
220 	ctx->tx_remainder = ((ctx->tx_remainder - eth_hlen) &
221 			     (ctx->tx_modulus - 1));
222 
223 	/* additional configuration */
224 
225 	/* set CRC Mode */
226 	if (flags & USB_CDC_NCM_NCAP_CRC_MODE) {
227 		err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
228 				       USB_TYPE_CLASS | USB_DIR_OUT
229 				       | USB_RECIP_INTERFACE,
230 				       USB_CDC_NCM_CRC_NOT_APPENDED,
231 				       iface_no, NULL, 0);
232 		if (err < 0)
233 			pr_debug("Setting CRC mode off failed\n");
234 	}
235 
236 	/* set NTB format, if both formats are supported */
237 	if (ntb_fmt_supported & USB_CDC_NCM_NTH32_SIGN) {
238 		err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
239 				       USB_TYPE_CLASS | USB_DIR_OUT
240 				       | USB_RECIP_INTERFACE,
241 				       USB_CDC_NCM_NTB16_FORMAT,
242 				       iface_no, NULL, 0);
243 		if (err < 0)
244 			pr_debug("Setting NTB format to 16-bit failed\n");
245 	}
246 
247 	ctx->max_datagram_size = min_dgram_size;
248 
249 	/* set Max Datagram Size (MTU) */
250 	if (flags & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE) {
251 		__le16 max_datagram_size;
252 		u16 eth_max_sz;
253 		if (ctx->ether_desc != NULL)
254 			eth_max_sz = le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
255 		else if (ctx->mbim_desc != NULL)
256 			eth_max_sz = le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
257 		else
258 			goto max_dgram_err;
259 
260 		err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
261 				      USB_TYPE_CLASS | USB_DIR_IN
262 				      | USB_RECIP_INTERFACE,
263 				      0, iface_no, &max_datagram_size, 2);
264 		if (err < 0) {
265 			pr_debug("GET_MAX_DATAGRAM_SIZE failed, use size=%u\n",
266 				 min_dgram_size);
267 		} else {
268 			ctx->max_datagram_size =
269 				le16_to_cpu(max_datagram_size);
270 			/* Check Eth descriptor value */
271 			if (ctx->max_datagram_size > eth_max_sz)
272 					ctx->max_datagram_size = eth_max_sz;
273 
274 			if (ctx->max_datagram_size > CDC_NCM_MAX_DATAGRAM_SIZE)
275 				ctx->max_datagram_size = CDC_NCM_MAX_DATAGRAM_SIZE;
276 
277 			if (ctx->max_datagram_size < min_dgram_size)
278 				ctx->max_datagram_size = min_dgram_size;
279 
280 			/* if value changed, update device */
281 			if (ctx->max_datagram_size !=
282 					le16_to_cpu(max_datagram_size)) {
283 				max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
284 				err = usbnet_write_cmd(dev,
285 						USB_CDC_SET_MAX_DATAGRAM_SIZE,
286 						USB_TYPE_CLASS | USB_DIR_OUT
287 						 | USB_RECIP_INTERFACE,
288 						0,
289 						iface_no, &max_datagram_size,
290 						2);
291 				if (err < 0)
292 					pr_debug("SET_MAX_DGRAM_SIZE failed\n");
293 			}
294 		}
295 	}
296 
297 max_dgram_err:
298 	if (dev->net->mtu != (ctx->max_datagram_size - eth_hlen))
299 		dev->net->mtu = ctx->max_datagram_size - eth_hlen;
300 
301 	return 0;
302 }
303 
304 static void
305 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
306 {
307 	struct usb_host_endpoint *e, *in = NULL, *out = NULL;
308 	u8 ep;
309 
310 	for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
311 
312 		e = intf->cur_altsetting->endpoint + ep;
313 		switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
314 		case USB_ENDPOINT_XFER_INT:
315 			if (usb_endpoint_dir_in(&e->desc)) {
316 				if (!dev->status)
317 					dev->status = e;
318 			}
319 			break;
320 
321 		case USB_ENDPOINT_XFER_BULK:
322 			if (usb_endpoint_dir_in(&e->desc)) {
323 				if (!in)
324 					in = e;
325 			} else {
326 				if (!out)
327 					out = e;
328 			}
329 			break;
330 
331 		default:
332 			break;
333 		}
334 	}
335 	if (in && !dev->in)
336 		dev->in = usb_rcvbulkpipe(dev->udev,
337 					  in->desc.bEndpointAddress &
338 					  USB_ENDPOINT_NUMBER_MASK);
339 	if (out && !dev->out)
340 		dev->out = usb_sndbulkpipe(dev->udev,
341 					   out->desc.bEndpointAddress &
342 					   USB_ENDPOINT_NUMBER_MASK);
343 }
344 
345 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
346 {
347 	if (ctx == NULL)
348 		return;
349 
350 	if (ctx->tx_rem_skb != NULL) {
351 		dev_kfree_skb_any(ctx->tx_rem_skb);
352 		ctx->tx_rem_skb = NULL;
353 	}
354 
355 	if (ctx->tx_curr_skb != NULL) {
356 		dev_kfree_skb_any(ctx->tx_curr_skb);
357 		ctx->tx_curr_skb = NULL;
358 	}
359 
360 	kfree(ctx);
361 }
362 
363 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
364 	.get_drvinfo = cdc_ncm_get_drvinfo,
365 	.get_link = usbnet_get_link,
366 	.get_msglevel = usbnet_get_msglevel,
367 	.set_msglevel = usbnet_set_msglevel,
368 	.get_settings = usbnet_get_settings,
369 	.set_settings = usbnet_set_settings,
370 	.nway_reset = usbnet_nway_reset,
371 };
372 
373 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting)
374 {
375 	const struct usb_cdc_union_desc *union_desc = NULL;
376 	struct cdc_ncm_ctx *ctx;
377 	struct usb_driver *driver;
378 	u8 *buf;
379 	int len;
380 	int temp;
381 	u8 iface_no;
382 
383 	ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
384 	if (!ctx)
385 		return -ENOMEM;
386 
387 	hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
388 	ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
389 	ctx->bh.data = (unsigned long)dev;
390 	ctx->bh.func = cdc_ncm_txpath_bh;
391 	atomic_set(&ctx->stop, 0);
392 	spin_lock_init(&ctx->mtx);
393 
394 	/* store ctx pointer in device data field */
395 	dev->data[0] = (unsigned long)ctx;
396 
397 	/* only the control interface can be successfully probed */
398 	ctx->control = intf;
399 
400 	/* get some pointers */
401 	driver = driver_of(intf);
402 	buf = intf->cur_altsetting->extra;
403 	len = intf->cur_altsetting->extralen;
404 
405 	/* parse through descriptors associated with control interface */
406 	while ((len > 0) && (buf[0] > 2) && (buf[0] <= len)) {
407 
408 		if (buf[1] != USB_DT_CS_INTERFACE)
409 			goto advance;
410 
411 		switch (buf[2]) {
412 		case USB_CDC_UNION_TYPE:
413 			if (buf[0] < sizeof(*union_desc))
414 				break;
415 
416 			union_desc = (const struct usb_cdc_union_desc *)buf;
417 			/* the master must be the interface we are probing */
418 			if (intf->cur_altsetting->desc.bInterfaceNumber !=
419 			    union_desc->bMasterInterface0)
420 				goto error;
421 			ctx->data = usb_ifnum_to_if(dev->udev,
422 						    union_desc->bSlaveInterface0);
423 			break;
424 
425 		case USB_CDC_ETHERNET_TYPE:
426 			if (buf[0] < sizeof(*(ctx->ether_desc)))
427 				break;
428 
429 			ctx->ether_desc =
430 					(const struct usb_cdc_ether_desc *)buf;
431 			dev->hard_mtu =
432 				le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
433 
434 			if (dev->hard_mtu < CDC_NCM_MIN_DATAGRAM_SIZE)
435 				dev->hard_mtu =	CDC_NCM_MIN_DATAGRAM_SIZE;
436 			else if (dev->hard_mtu > CDC_NCM_MAX_DATAGRAM_SIZE)
437 				dev->hard_mtu =	CDC_NCM_MAX_DATAGRAM_SIZE;
438 			break;
439 
440 		case USB_CDC_NCM_TYPE:
441 			if (buf[0] < sizeof(*(ctx->func_desc)))
442 				break;
443 
444 			ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
445 			break;
446 
447 		case USB_CDC_MBIM_TYPE:
448 			if (buf[0] < sizeof(*(ctx->mbim_desc)))
449 				break;
450 
451 			ctx->mbim_desc = (const struct usb_cdc_mbim_desc *)buf;
452 			break;
453 
454 		default:
455 			break;
456 		}
457 advance:
458 		/* advance to next descriptor */
459 		temp = buf[0];
460 		buf += temp;
461 		len -= temp;
462 	}
463 
464 	/* some buggy devices have an IAD but no CDC Union */
465 	if (!union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
466 		ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
467 		dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
468 	}
469 
470 	/* check if we got everything */
471 	if (!ctx->data || (!ctx->mbim_desc && !ctx->ether_desc))
472 		goto error;
473 
474 	/* claim data interface, if different from control */
475 	if (ctx->data != ctx->control) {
476 		temp = usb_driver_claim_interface(driver, ctx->data, dev);
477 		if (temp)
478 			goto error;
479 	}
480 
481 	iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
482 
483 	/* reset data interface */
484 	temp = usb_set_interface(dev->udev, iface_no, 0);
485 	if (temp)
486 		goto error2;
487 
488 	/* configure data interface */
489 	temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
490 	if (temp)
491 		goto error2;
492 
493 	cdc_ncm_find_endpoints(dev, ctx->data);
494 	cdc_ncm_find_endpoints(dev, ctx->control);
495 	if (!dev->in || !dev->out || !dev->status)
496 		goto error2;
497 
498 	/* initialize data interface */
499 	if (cdc_ncm_setup(dev))
500 		goto error2;
501 
502 	dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
503 
504 	usb_set_intfdata(ctx->data, dev);
505 	usb_set_intfdata(ctx->control, dev);
506 
507 	if (ctx->ether_desc) {
508 		temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
509 		if (temp)
510 			goto error2;
511 		dev_info(&dev->udev->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
512 	}
513 
514 	dev->rx_urb_size = ctx->rx_max;
515 
516 	return 0;
517 
518 error2:
519 	usb_set_intfdata(ctx->control, NULL);
520 	usb_set_intfdata(ctx->data, NULL);
521 	if (ctx->data != ctx->control)
522 		usb_driver_release_interface(driver, ctx->data);
523 error:
524 	cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
525 	dev->data[0] = 0;
526 	dev_info(&dev->udev->dev, "bind() failure\n");
527 	return -ENODEV;
528 }
529 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
530 
531 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
532 {
533 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
534 	struct usb_driver *driver = driver_of(intf);
535 
536 	if (ctx == NULL)
537 		return;		/* no setup */
538 
539 	atomic_set(&ctx->stop, 1);
540 
541 	if (hrtimer_active(&ctx->tx_timer))
542 		hrtimer_cancel(&ctx->tx_timer);
543 
544 	tasklet_kill(&ctx->bh);
545 
546 	/* handle devices with combined control and data interface */
547 	if (ctx->control == ctx->data)
548 		ctx->data = NULL;
549 
550 	/* disconnect master --> disconnect slave */
551 	if (intf == ctx->control && ctx->data) {
552 		usb_set_intfdata(ctx->data, NULL);
553 		usb_driver_release_interface(driver, ctx->data);
554 		ctx->data = NULL;
555 
556 	} else if (intf == ctx->data && ctx->control) {
557 		usb_set_intfdata(ctx->control, NULL);
558 		usb_driver_release_interface(driver, ctx->control);
559 		ctx->control = NULL;
560 	}
561 
562 	usb_set_intfdata(intf, NULL);
563 	cdc_ncm_free(ctx);
564 }
565 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
566 
567 /* Select the MBIM altsetting iff it is preferred and available,
568  * returning the number of the corresponding data interface altsetting
569  */
570 u8 cdc_ncm_select_altsetting(struct usbnet *dev, struct usb_interface *intf)
571 {
572 	struct usb_host_interface *alt;
573 
574 	/* The MBIM spec defines a NCM compatible default altsetting,
575 	 * which we may have matched:
576 	 *
577 	 *  "Functions that implement both NCM 1.0 and MBIM (an
578 	 *   “NCM/MBIM function”) according to this recommendation
579 	 *   shall provide two alternate settings for the
580 	 *   Communication Interface.  Alternate setting 0, and the
581 	 *   associated class and endpoint descriptors, shall be
582 	 *   constructed according to the rules given for the
583 	 *   Communication Interface in section 5 of [USBNCM10].
584 	 *   Alternate setting 1, and the associated class and
585 	 *   endpoint descriptors, shall be constructed according to
586 	 *   the rules given in section 6 (USB Device Model) of this
587 	 *   specification."
588 	 */
589 	if (prefer_mbim && intf->num_altsetting == 2) {
590 		alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
591 		if (alt && cdc_ncm_comm_intf_is_mbim(alt) &&
592 		    !usb_set_interface(dev->udev,
593 				       intf->cur_altsetting->desc.bInterfaceNumber,
594 				       CDC_NCM_COMM_ALTSETTING_MBIM))
595 			return CDC_NCM_DATA_ALTSETTING_MBIM;
596 	}
597 	return CDC_NCM_DATA_ALTSETTING_NCM;
598 }
599 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
600 
601 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
602 {
603 	int ret;
604 
605 	/* MBIM backwards compatible function? */
606 	cdc_ncm_select_altsetting(dev, intf);
607 	if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting))
608 		return -ENODEV;
609 
610 	/* NCM data altsetting is always 1 */
611 	ret = cdc_ncm_bind_common(dev, intf, 1);
612 
613 	/*
614 	 * We should get an event when network connection is "connected" or
615 	 * "disconnected". Set network connection in "disconnected" state
616 	 * (carrier is OFF) during attach, so the IP network stack does not
617 	 * start IPv6 negotiation and more.
618 	 */
619 	usbnet_link_change(dev, 0, 0);
620 	return ret;
621 }
622 
623 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
624 {
625 	size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
626 
627 	if (skb->len + align > max)
628 		align = max - skb->len;
629 	if (align && skb_tailroom(skb) >= align)
630 		memset(skb_put(skb, align), 0, align);
631 }
632 
633 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
634  * allocating a new one within skb
635  */
636 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
637 {
638 	struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
639 	struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
640 	size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
641 
642 	/* follow the chain of NDPs, looking for a match */
643 	while (ndpoffset) {
644 		ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
645 		if  (ndp16->dwSignature == sign)
646 			return ndp16;
647 		ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
648 	}
649 
650 	/* align new NDP */
651 	cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
652 
653 	/* verify that there is room for the NDP and the datagram (reserve) */
654 	if ((ctx->tx_max - skb->len - reserve) < CDC_NCM_NDP_SIZE)
655 		return NULL;
656 
657 	/* link to it */
658 	if (ndp16)
659 		ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
660 	else
661 		nth16->wNdpIndex = cpu_to_le16(skb->len);
662 
663 	/* push a new empty NDP */
664 	ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, CDC_NCM_NDP_SIZE), 0, CDC_NCM_NDP_SIZE);
665 	ndp16->dwSignature = sign;
666 	ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
667 	return ndp16;
668 }
669 
670 struct sk_buff *
671 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
672 {
673 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
674 	struct usb_cdc_ncm_nth16 *nth16;
675 	struct usb_cdc_ncm_ndp16 *ndp16;
676 	struct sk_buff *skb_out;
677 	u16 n = 0, index, ndplen;
678 	u8 ready2send = 0;
679 
680 	/* if there is a remaining skb, it gets priority */
681 	if (skb != NULL) {
682 		swap(skb, ctx->tx_rem_skb);
683 		swap(sign, ctx->tx_rem_sign);
684 	} else {
685 		ready2send = 1;
686 	}
687 
688 	/* check if we are resuming an OUT skb */
689 	skb_out = ctx->tx_curr_skb;
690 
691 	/* allocate a new OUT skb */
692 	if (!skb_out) {
693 		skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
694 		if (skb_out == NULL) {
695 			if (skb != NULL) {
696 				dev_kfree_skb_any(skb);
697 				dev->net->stats.tx_dropped++;
698 			}
699 			goto exit_no_skb;
700 		}
701 		/* fill out the initial 16-bit NTB header */
702 		nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
703 		nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
704 		nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
705 		nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
706 
707 		/* count total number of frames in this NTB */
708 		ctx->tx_curr_frame_num = 0;
709 	}
710 
711 	for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
712 		/* send any remaining skb first */
713 		if (skb == NULL) {
714 			skb = ctx->tx_rem_skb;
715 			sign = ctx->tx_rem_sign;
716 			ctx->tx_rem_skb = NULL;
717 
718 			/* check for end of skb */
719 			if (skb == NULL)
720 				break;
721 		}
722 
723 		/* get the appropriate NDP for this skb */
724 		ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
725 
726 		/* align beginning of next frame */
727 		cdc_ncm_align_tail(skb_out,  ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
728 
729 		/* check if we had enough room left for both NDP and frame */
730 		if (!ndp16 || skb_out->len + skb->len > ctx->tx_max) {
731 			if (n == 0) {
732 				/* won't fit, MTU problem? */
733 				dev_kfree_skb_any(skb);
734 				skb = NULL;
735 				dev->net->stats.tx_dropped++;
736 			} else {
737 				/* no room for skb - store for later */
738 				if (ctx->tx_rem_skb != NULL) {
739 					dev_kfree_skb_any(ctx->tx_rem_skb);
740 					dev->net->stats.tx_dropped++;
741 				}
742 				ctx->tx_rem_skb = skb;
743 				ctx->tx_rem_sign = sign;
744 				skb = NULL;
745 				ready2send = 1;
746 			}
747 			break;
748 		}
749 
750 		/* calculate frame number withing this NDP */
751 		ndplen = le16_to_cpu(ndp16->wLength);
752 		index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
753 
754 		/* OK, add this skb */
755 		ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
756 		ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
757 		ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
758 		memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
759 		dev_kfree_skb_any(skb);
760 		skb = NULL;
761 
762 		/* send now if this NDP is full */
763 		if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
764 			ready2send = 1;
765 			break;
766 		}
767 	}
768 
769 	/* free up any dangling skb */
770 	if (skb != NULL) {
771 		dev_kfree_skb_any(skb);
772 		skb = NULL;
773 		dev->net->stats.tx_dropped++;
774 	}
775 
776 	ctx->tx_curr_frame_num = n;
777 
778 	if (n == 0) {
779 		/* wait for more frames */
780 		/* push variables */
781 		ctx->tx_curr_skb = skb_out;
782 		goto exit_no_skb;
783 
784 	} else if ((n < ctx->tx_max_datagrams) && (ready2send == 0)) {
785 		/* wait for more frames */
786 		/* push variables */
787 		ctx->tx_curr_skb = skb_out;
788 		/* set the pending count */
789 		if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
790 			ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
791 		goto exit_no_skb;
792 
793 	} else {
794 		/* frame goes out */
795 		/* variables will be reset at next call */
796 	}
797 
798 	/* If collected data size is less or equal CDC_NCM_MIN_TX_PKT
799 	 * bytes, we send buffers as it is. If we get more data, it
800 	 * would be more efficient for USB HS mobile device with DMA
801 	 * engine to receive a full size NTB, than canceling DMA
802 	 * transfer and receiving a short packet.
803 	 */
804 	if (skb_out->len > CDC_NCM_MIN_TX_PKT)
805 		memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
806 		       ctx->tx_max - skb_out->len);
807 	else if ((skb_out->len % dev->maxpacket) == 0)
808 		*skb_put(skb_out, 1) = 0;	/* force short packet */
809 
810 	/* set final frame length */
811 	nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
812 	nth16->wBlockLength = cpu_to_le16(skb_out->len);
813 
814 	/* return skb */
815 	ctx->tx_curr_skb = NULL;
816 	dev->net->stats.tx_packets += ctx->tx_curr_frame_num;
817 	return skb_out;
818 
819 exit_no_skb:
820 	/* Start timer, if there is a remaining skb */
821 	if (ctx->tx_curr_skb != NULL)
822 		cdc_ncm_tx_timeout_start(ctx);
823 	return NULL;
824 }
825 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
826 
827 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
828 {
829 	/* start timer, if not already started */
830 	if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
831 		hrtimer_start(&ctx->tx_timer,
832 				ktime_set(0, CDC_NCM_TIMER_INTERVAL),
833 				HRTIMER_MODE_REL);
834 }
835 
836 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
837 {
838 	struct cdc_ncm_ctx *ctx =
839 			container_of(timer, struct cdc_ncm_ctx, tx_timer);
840 
841 	if (!atomic_read(&ctx->stop))
842 		tasklet_schedule(&ctx->bh);
843 	return HRTIMER_NORESTART;
844 }
845 
846 static void cdc_ncm_txpath_bh(unsigned long param)
847 {
848 	struct usbnet *dev = (struct usbnet *)param;
849 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
850 
851 	spin_lock_bh(&ctx->mtx);
852 	if (ctx->tx_timer_pending != 0) {
853 		ctx->tx_timer_pending--;
854 		cdc_ncm_tx_timeout_start(ctx);
855 		spin_unlock_bh(&ctx->mtx);
856 	} else if (dev->net != NULL) {
857 		spin_unlock_bh(&ctx->mtx);
858 		netif_tx_lock_bh(dev->net);
859 		usbnet_start_xmit(NULL, dev->net);
860 		netif_tx_unlock_bh(dev->net);
861 	} else {
862 		spin_unlock_bh(&ctx->mtx);
863 	}
864 }
865 
866 static struct sk_buff *
867 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
868 {
869 	struct sk_buff *skb_out;
870 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
871 
872 	/*
873 	 * The Ethernet API we are using does not support transmitting
874 	 * multiple Ethernet frames in a single call. This driver will
875 	 * accumulate multiple Ethernet frames and send out a larger
876 	 * USB frame when the USB buffer is full or when a single jiffies
877 	 * timeout happens.
878 	 */
879 	if (ctx == NULL)
880 		goto error;
881 
882 	spin_lock_bh(&ctx->mtx);
883 	skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
884 	spin_unlock_bh(&ctx->mtx);
885 	return skb_out;
886 
887 error:
888 	if (skb != NULL)
889 		dev_kfree_skb_any(skb);
890 
891 	return NULL;
892 }
893 
894 /* verify NTB header and return offset of first NDP, or negative error */
895 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
896 {
897 	struct usb_cdc_ncm_nth16 *nth16;
898 	int len;
899 	int ret = -EINVAL;
900 
901 	if (ctx == NULL)
902 		goto error;
903 
904 	if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
905 					sizeof(struct usb_cdc_ncm_ndp16))) {
906 		pr_debug("frame too short\n");
907 		goto error;
908 	}
909 
910 	nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
911 
912 	if (le32_to_cpu(nth16->dwSignature) != USB_CDC_NCM_NTH16_SIGN) {
913 		pr_debug("invalid NTH16 signature <%u>\n",
914 					le32_to_cpu(nth16->dwSignature));
915 		goto error;
916 	}
917 
918 	len = le16_to_cpu(nth16->wBlockLength);
919 	if (len > ctx->rx_max) {
920 		pr_debug("unsupported NTB block length %u/%u\n", len,
921 								ctx->rx_max);
922 		goto error;
923 	}
924 
925 	if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
926 		(ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
927 		!((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
928 		pr_debug("sequence number glitch prev=%d curr=%d\n",
929 				ctx->rx_seq, le16_to_cpu(nth16->wSequence));
930 	}
931 	ctx->rx_seq = le16_to_cpu(nth16->wSequence);
932 
933 	ret = le16_to_cpu(nth16->wNdpIndex);
934 error:
935 	return ret;
936 }
937 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
938 
939 /* verify NDP header and return number of datagrams, or negative error */
940 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
941 {
942 	struct usb_cdc_ncm_ndp16 *ndp16;
943 	int ret = -EINVAL;
944 
945 	if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
946 		pr_debug("invalid NDP offset  <%u>\n", ndpoffset);
947 		goto error;
948 	}
949 	ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
950 
951 	if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
952 		pr_debug("invalid DPT16 length <%u>\n",
953 					le32_to_cpu(ndp16->dwSignature));
954 		goto error;
955 	}
956 
957 	ret = ((le16_to_cpu(ndp16->wLength) -
958 					sizeof(struct usb_cdc_ncm_ndp16)) /
959 					sizeof(struct usb_cdc_ncm_dpe16));
960 	ret--; /* we process NDP entries except for the last one */
961 
962 	if ((sizeof(struct usb_cdc_ncm_ndp16) + ret * (sizeof(struct usb_cdc_ncm_dpe16))) >
963 								skb_in->len) {
964 		pr_debug("Invalid nframes = %d\n", ret);
965 		ret = -EINVAL;
966 	}
967 
968 error:
969 	return ret;
970 }
971 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
972 
973 static int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
974 {
975 	struct sk_buff *skb;
976 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
977 	int len;
978 	int nframes;
979 	int x;
980 	int offset;
981 	struct usb_cdc_ncm_ndp16 *ndp16;
982 	struct usb_cdc_ncm_dpe16 *dpe16;
983 	int ndpoffset;
984 	int loopcount = 50; /* arbitrary max preventing infinite loop */
985 
986 	ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
987 	if (ndpoffset < 0)
988 		goto error;
989 
990 next_ndp:
991 	nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
992 	if (nframes < 0)
993 		goto error;
994 
995 	ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
996 
997 	if (le32_to_cpu(ndp16->dwSignature) != USB_CDC_NCM_NDP16_NOCRC_SIGN) {
998 		pr_debug("invalid DPT16 signature <%u>\n",
999 			 le32_to_cpu(ndp16->dwSignature));
1000 		goto err_ndp;
1001 	}
1002 	dpe16 = ndp16->dpe16;
1003 
1004 	for (x = 0; x < nframes; x++, dpe16++) {
1005 		offset = le16_to_cpu(dpe16->wDatagramIndex);
1006 		len = le16_to_cpu(dpe16->wDatagramLength);
1007 
1008 		/*
1009 		 * CDC NCM ch. 3.7
1010 		 * All entries after first NULL entry are to be ignored
1011 		 */
1012 		if ((offset == 0) || (len == 0)) {
1013 			if (!x)
1014 				goto err_ndp; /* empty NTB */
1015 			break;
1016 		}
1017 
1018 		/* sanity checking */
1019 		if (((offset + len) > skb_in->len) ||
1020 				(len > ctx->rx_max) || (len < ETH_HLEN)) {
1021 			pr_debug("invalid frame detected (ignored)"
1022 					"offset[%u]=%u, length=%u, skb=%p\n",
1023 					x, offset, len, skb_in);
1024 			if (!x)
1025 				goto err_ndp;
1026 			break;
1027 
1028 		} else {
1029 			skb = skb_clone(skb_in, GFP_ATOMIC);
1030 			if (!skb)
1031 				goto error;
1032 			skb->len = len;
1033 			skb->data = ((u8 *)skb_in->data) + offset;
1034 			skb_set_tail_pointer(skb, len);
1035 			usbnet_skb_return(dev, skb);
1036 		}
1037 	}
1038 err_ndp:
1039 	/* are there more NDPs to process? */
1040 	ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1041 	if (ndpoffset && loopcount--)
1042 		goto next_ndp;
1043 
1044 	return 1;
1045 error:
1046 	return 0;
1047 }
1048 
1049 static void
1050 cdc_ncm_speed_change(struct usbnet *dev,
1051 		     struct usb_cdc_speed_change *data)
1052 {
1053 	uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1054 	uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1055 
1056 	/*
1057 	 * Currently the USB-NET API does not support reporting the actual
1058 	 * device speed. Do print it instead.
1059 	 */
1060 	if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1061 		printk(KERN_INFO KBUILD_MODNAME
1062 		       ": %s: %u mbit/s downlink "
1063 		       "%u mbit/s uplink\n",
1064 		       dev->net->name,
1065 		       (unsigned int)(rx_speed / 1000000U),
1066 		       (unsigned int)(tx_speed / 1000000U));
1067 	} else {
1068 		printk(KERN_INFO KBUILD_MODNAME
1069 		       ": %s: %u kbit/s downlink "
1070 		       "%u kbit/s uplink\n",
1071 		       dev->net->name,
1072 		       (unsigned int)(rx_speed / 1000U),
1073 		       (unsigned int)(tx_speed / 1000U));
1074 	}
1075 }
1076 
1077 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1078 {
1079 	struct cdc_ncm_ctx *ctx;
1080 	struct usb_cdc_notification *event;
1081 
1082 	ctx = (struct cdc_ncm_ctx *)dev->data[0];
1083 
1084 	if (urb->actual_length < sizeof(*event))
1085 		return;
1086 
1087 	/* test for split data in 8-byte chunks */
1088 	if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1089 		cdc_ncm_speed_change(dev,
1090 		      (struct usb_cdc_speed_change *)urb->transfer_buffer);
1091 		return;
1092 	}
1093 
1094 	event = urb->transfer_buffer;
1095 
1096 	switch (event->bNotificationType) {
1097 	case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1098 		/*
1099 		 * According to the CDC NCM specification ch.7.1
1100 		 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1101 		 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1102 		 */
1103 		ctx->connected = le16_to_cpu(event->wValue);
1104 
1105 		printk(KERN_INFO KBUILD_MODNAME ": %s: network connection:"
1106 		       " %sconnected\n",
1107 		       dev->net->name, ctx->connected ? "" : "dis");
1108 
1109 		usbnet_link_change(dev, ctx->connected, 0);
1110 		break;
1111 
1112 	case USB_CDC_NOTIFY_SPEED_CHANGE:
1113 		if (urb->actual_length < (sizeof(*event) +
1114 					sizeof(struct usb_cdc_speed_change)))
1115 			set_bit(EVENT_STS_SPLIT, &dev->flags);
1116 		else
1117 			cdc_ncm_speed_change(dev,
1118 					     (struct usb_cdc_speed_change *)&event[1]);
1119 		break;
1120 
1121 	default:
1122 		dev_dbg(&dev->udev->dev,
1123 			"NCM: unexpected notification 0x%02x!\n",
1124 			event->bNotificationType);
1125 		break;
1126 	}
1127 }
1128 
1129 static int cdc_ncm_check_connect(struct usbnet *dev)
1130 {
1131 	struct cdc_ncm_ctx *ctx;
1132 
1133 	ctx = (struct cdc_ncm_ctx *)dev->data[0];
1134 	if (ctx == NULL)
1135 		return 1;	/* disconnected */
1136 
1137 	return !ctx->connected;
1138 }
1139 
1140 static int
1141 cdc_ncm_probe(struct usb_interface *udev, const struct usb_device_id *prod)
1142 {
1143 	return usbnet_probe(udev, prod);
1144 }
1145 
1146 static void cdc_ncm_disconnect(struct usb_interface *intf)
1147 {
1148 	struct usbnet *dev = usb_get_intfdata(intf);
1149 
1150 	if (dev == NULL)
1151 		return;		/* already disconnected */
1152 
1153 	usbnet_disconnect(intf);
1154 }
1155 
1156 static const struct driver_info cdc_ncm_info = {
1157 	.description = "CDC NCM",
1158 	.flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1159 	.bind = cdc_ncm_bind,
1160 	.unbind = cdc_ncm_unbind,
1161 	.check_connect = cdc_ncm_check_connect,
1162 	.manage_power = usbnet_manage_power,
1163 	.status = cdc_ncm_status,
1164 	.rx_fixup = cdc_ncm_rx_fixup,
1165 	.tx_fixup = cdc_ncm_tx_fixup,
1166 };
1167 
1168 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1169 static const struct driver_info wwan_info = {
1170 	.description = "Mobile Broadband Network Device",
1171 	.flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1172 			| FLAG_WWAN,
1173 	.bind = cdc_ncm_bind,
1174 	.unbind = cdc_ncm_unbind,
1175 	.check_connect = cdc_ncm_check_connect,
1176 	.manage_power = usbnet_manage_power,
1177 	.status = cdc_ncm_status,
1178 	.rx_fixup = cdc_ncm_rx_fixup,
1179 	.tx_fixup = cdc_ncm_tx_fixup,
1180 };
1181 
1182 /* Same as wwan_info, but with FLAG_NOARP  */
1183 static const struct driver_info wwan_noarp_info = {
1184 	.description = "Mobile Broadband Network Device (NO ARP)",
1185 	.flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1186 			| FLAG_WWAN | FLAG_NOARP,
1187 	.bind = cdc_ncm_bind,
1188 	.unbind = cdc_ncm_unbind,
1189 	.check_connect = cdc_ncm_check_connect,
1190 	.manage_power = usbnet_manage_power,
1191 	.status = cdc_ncm_status,
1192 	.rx_fixup = cdc_ncm_rx_fixup,
1193 	.tx_fixup = cdc_ncm_tx_fixup,
1194 };
1195 
1196 static const struct usb_device_id cdc_devs[] = {
1197 	/* Ericsson MBM devices like F5521gw */
1198 	{ .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1199 		| USB_DEVICE_ID_MATCH_VENDOR,
1200 	  .idVendor = 0x0bdb,
1201 	  .bInterfaceClass = USB_CLASS_COMM,
1202 	  .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1203 	  .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1204 	  .driver_info = (unsigned long) &wwan_info,
1205 	},
1206 
1207 	/* Dell branded MBM devices like DW5550 */
1208 	{ .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1209 		| USB_DEVICE_ID_MATCH_VENDOR,
1210 	  .idVendor = 0x413c,
1211 	  .bInterfaceClass = USB_CLASS_COMM,
1212 	  .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1213 	  .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1214 	  .driver_info = (unsigned long) &wwan_info,
1215 	},
1216 
1217 	/* Toshiba branded MBM devices */
1218 	{ .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1219 		| USB_DEVICE_ID_MATCH_VENDOR,
1220 	  .idVendor = 0x0930,
1221 	  .bInterfaceClass = USB_CLASS_COMM,
1222 	  .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1223 	  .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1224 	  .driver_info = (unsigned long) &wwan_info,
1225 	},
1226 
1227 	/* tag Huawei devices as wwan */
1228 	{ USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1229 					USB_CLASS_COMM,
1230 					USB_CDC_SUBCLASS_NCM,
1231 					USB_CDC_PROTO_NONE),
1232 	  .driver_info = (unsigned long)&wwan_info,
1233 	},
1234 
1235 	/* Huawei NCM devices disguised as vendor specific */
1236 	{ USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x16),
1237 	  .driver_info = (unsigned long)&wwan_info,
1238 	},
1239 	{ USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x46),
1240 	  .driver_info = (unsigned long)&wwan_info,
1241 	},
1242 	{ USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x76),
1243 	  .driver_info = (unsigned long)&wwan_info,
1244 	},
1245 
1246 	/* Infineon(now Intel) HSPA Modem platform */
1247 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1248 		USB_CLASS_COMM,
1249 		USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1250 	  .driver_info = (unsigned long)&wwan_noarp_info,
1251 	},
1252 
1253 	/* Generic CDC-NCM devices */
1254 	{ USB_INTERFACE_INFO(USB_CLASS_COMM,
1255 		USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1256 		.driver_info = (unsigned long)&cdc_ncm_info,
1257 	},
1258 	{
1259 	},
1260 };
1261 MODULE_DEVICE_TABLE(usb, cdc_devs);
1262 
1263 static struct usb_driver cdc_ncm_driver = {
1264 	.name = "cdc_ncm",
1265 	.id_table = cdc_devs,
1266 	.probe = cdc_ncm_probe,
1267 	.disconnect = cdc_ncm_disconnect,
1268 	.suspend = usbnet_suspend,
1269 	.resume = usbnet_resume,
1270 	.reset_resume =	usbnet_resume,
1271 	.supports_autosuspend = 1,
1272 	.disable_hub_initiated_lpm = 1,
1273 };
1274 
1275 module_usb_driver(cdc_ncm_driver);
1276 
1277 MODULE_AUTHOR("Hans Petter Selasky");
1278 MODULE_DESCRIPTION("USB CDC NCM host driver");
1279 MODULE_LICENSE("Dual BSD/GPL");
1280