xref: /linux/drivers/net/usb/cdc_ncm.c (revision f3a8b6645dc2e60d11f20c1c23afd964ff4e55ae)
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/docs/devclass_docs/NCM10_012011.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/netdevice.h>
43 #include <linux/ctype.h>
44 #include <linux/etherdevice.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 #if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
57 static bool prefer_mbim = true;
58 #else
59 static bool prefer_mbim;
60 #endif
61 module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
62 MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
63 
64 static void cdc_ncm_txpath_bh(unsigned long param);
65 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx);
66 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *hr_timer);
67 static struct usb_driver cdc_ncm_driver;
68 
69 struct cdc_ncm_stats {
70 	char stat_string[ETH_GSTRING_LEN];
71 	int sizeof_stat;
72 	int stat_offset;
73 };
74 
75 #define CDC_NCM_STAT(str, m) { \
76 		.stat_string = str, \
77 		.sizeof_stat = sizeof(((struct cdc_ncm_ctx *)0)->m), \
78 		.stat_offset = offsetof(struct cdc_ncm_ctx, m) }
79 #define CDC_NCM_SIMPLE_STAT(m)	CDC_NCM_STAT(__stringify(m), m)
80 
81 static const struct cdc_ncm_stats cdc_ncm_gstrings_stats[] = {
82 	CDC_NCM_SIMPLE_STAT(tx_reason_ntb_full),
83 	CDC_NCM_SIMPLE_STAT(tx_reason_ndp_full),
84 	CDC_NCM_SIMPLE_STAT(tx_reason_timeout),
85 	CDC_NCM_SIMPLE_STAT(tx_reason_max_datagram),
86 	CDC_NCM_SIMPLE_STAT(tx_overhead),
87 	CDC_NCM_SIMPLE_STAT(tx_ntbs),
88 	CDC_NCM_SIMPLE_STAT(rx_overhead),
89 	CDC_NCM_SIMPLE_STAT(rx_ntbs),
90 };
91 
92 static int cdc_ncm_get_sset_count(struct net_device __always_unused *netdev, int sset)
93 {
94 	switch (sset) {
95 	case ETH_SS_STATS:
96 		return ARRAY_SIZE(cdc_ncm_gstrings_stats);
97 	default:
98 		return -EOPNOTSUPP;
99 	}
100 }
101 
102 static void cdc_ncm_get_ethtool_stats(struct net_device *netdev,
103 				    struct ethtool_stats __always_unused *stats,
104 				    u64 *data)
105 {
106 	struct usbnet *dev = netdev_priv(netdev);
107 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
108 	int i;
109 	char *p = NULL;
110 
111 	for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
112 		p = (char *)ctx + cdc_ncm_gstrings_stats[i].stat_offset;
113 		data[i] = (cdc_ncm_gstrings_stats[i].sizeof_stat == sizeof(u64)) ? *(u64 *)p : *(u32 *)p;
114 	}
115 }
116 
117 static void cdc_ncm_get_strings(struct net_device __always_unused *netdev, u32 stringset, u8 *data)
118 {
119 	u8 *p = data;
120 	int i;
121 
122 	switch (stringset) {
123 	case ETH_SS_STATS:
124 		for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
125 			memcpy(p, cdc_ncm_gstrings_stats[i].stat_string, ETH_GSTRING_LEN);
126 			p += ETH_GSTRING_LEN;
127 		}
128 	}
129 }
130 
131 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
132 
133 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
134 	.get_settings      = usbnet_get_settings,
135 	.set_settings      = usbnet_set_settings,
136 	.get_link          = usbnet_get_link,
137 	.nway_reset        = usbnet_nway_reset,
138 	.get_drvinfo       = usbnet_get_drvinfo,
139 	.get_msglevel      = usbnet_get_msglevel,
140 	.set_msglevel      = usbnet_set_msglevel,
141 	.get_ts_info       = ethtool_op_get_ts_info,
142 	.get_sset_count    = cdc_ncm_get_sset_count,
143 	.get_strings       = cdc_ncm_get_strings,
144 	.get_ethtool_stats = cdc_ncm_get_ethtool_stats,
145 };
146 
147 static u32 cdc_ncm_check_rx_max(struct usbnet *dev, u32 new_rx)
148 {
149 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
150 	u32 val, max, min;
151 
152 	/* clamp new_rx to sane values */
153 	min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
154 	max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
155 
156 	/* dwNtbInMaxSize spec violation? Use MIN size for both limits */
157 	if (max < min) {
158 		dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
159 			 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
160 		max = min;
161 	}
162 
163 	val = clamp_t(u32, new_rx, min, max);
164 	if (val != new_rx)
165 		dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range\n", min, max);
166 
167 	return val;
168 }
169 
170 static u32 cdc_ncm_check_tx_max(struct usbnet *dev, u32 new_tx)
171 {
172 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
173 	u32 val, max, min;
174 
175 	/* clamp new_tx to sane values */
176 	min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
177 	max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
178 
179 	/* some devices set dwNtbOutMaxSize too low for the above default */
180 	min = min(min, max);
181 
182 	val = clamp_t(u32, new_tx, min, max);
183 	if (val != new_tx)
184 		dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range\n", min, max);
185 
186 	return val;
187 }
188 
189 static ssize_t cdc_ncm_show_min_tx_pkt(struct device *d, struct device_attribute *attr, char *buf)
190 {
191 	struct usbnet *dev = netdev_priv(to_net_dev(d));
192 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
193 
194 	return sprintf(buf, "%u\n", ctx->min_tx_pkt);
195 }
196 
197 static ssize_t cdc_ncm_show_rx_max(struct device *d, struct device_attribute *attr, char *buf)
198 {
199 	struct usbnet *dev = netdev_priv(to_net_dev(d));
200 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
201 
202 	return sprintf(buf, "%u\n", ctx->rx_max);
203 }
204 
205 static ssize_t cdc_ncm_show_tx_max(struct device *d, struct device_attribute *attr, char *buf)
206 {
207 	struct usbnet *dev = netdev_priv(to_net_dev(d));
208 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
209 
210 	return sprintf(buf, "%u\n", ctx->tx_max);
211 }
212 
213 static ssize_t cdc_ncm_show_tx_timer_usecs(struct device *d, struct device_attribute *attr, char *buf)
214 {
215 	struct usbnet *dev = netdev_priv(to_net_dev(d));
216 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
217 
218 	return sprintf(buf, "%u\n", ctx->timer_interval / (u32)NSEC_PER_USEC);
219 }
220 
221 static ssize_t cdc_ncm_store_min_tx_pkt(struct device *d,  struct device_attribute *attr, const char *buf, size_t len)
222 {
223 	struct usbnet *dev = netdev_priv(to_net_dev(d));
224 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
225 	unsigned long val;
226 
227 	/* no need to restrict values - anything from 0 to infinity is OK */
228 	if (kstrtoul(buf, 0, &val))
229 		return -EINVAL;
230 
231 	ctx->min_tx_pkt = val;
232 	return len;
233 }
234 
235 static ssize_t cdc_ncm_store_rx_max(struct device *d,  struct device_attribute *attr, const char *buf, size_t len)
236 {
237 	struct usbnet *dev = netdev_priv(to_net_dev(d));
238 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
239 	unsigned long val;
240 
241 	if (kstrtoul(buf, 0, &val) || cdc_ncm_check_rx_max(dev, val) != val)
242 		return -EINVAL;
243 
244 	cdc_ncm_update_rxtx_max(dev, val, ctx->tx_max);
245 	return len;
246 }
247 
248 static ssize_t cdc_ncm_store_tx_max(struct device *d,  struct device_attribute *attr, const char *buf, size_t len)
249 {
250 	struct usbnet *dev = netdev_priv(to_net_dev(d));
251 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
252 	unsigned long val;
253 
254 	if (kstrtoul(buf, 0, &val) || cdc_ncm_check_tx_max(dev, val) != val)
255 		return -EINVAL;
256 
257 	cdc_ncm_update_rxtx_max(dev, ctx->rx_max, val);
258 	return len;
259 }
260 
261 static ssize_t cdc_ncm_store_tx_timer_usecs(struct device *d,  struct device_attribute *attr, const char *buf, size_t len)
262 {
263 	struct usbnet *dev = netdev_priv(to_net_dev(d));
264 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
265 	ssize_t ret;
266 	unsigned long val;
267 
268 	ret = kstrtoul(buf, 0, &val);
269 	if (ret)
270 		return ret;
271 	if (val && (val < CDC_NCM_TIMER_INTERVAL_MIN || val > CDC_NCM_TIMER_INTERVAL_MAX))
272 		return -EINVAL;
273 
274 	spin_lock_bh(&ctx->mtx);
275 	ctx->timer_interval = val * NSEC_PER_USEC;
276 	if (!ctx->timer_interval)
277 		ctx->tx_timer_pending = 0;
278 	spin_unlock_bh(&ctx->mtx);
279 	return len;
280 }
281 
282 static DEVICE_ATTR(min_tx_pkt, S_IRUGO | S_IWUSR, cdc_ncm_show_min_tx_pkt, cdc_ncm_store_min_tx_pkt);
283 static DEVICE_ATTR(rx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_rx_max, cdc_ncm_store_rx_max);
284 static DEVICE_ATTR(tx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_max, cdc_ncm_store_tx_max);
285 static DEVICE_ATTR(tx_timer_usecs, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_timer_usecs, cdc_ncm_store_tx_timer_usecs);
286 
287 static ssize_t ndp_to_end_show(struct device *d, struct device_attribute *attr, char *buf)
288 {
289 	struct usbnet *dev = netdev_priv(to_net_dev(d));
290 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
291 
292 	return sprintf(buf, "%c\n", ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END ? 'Y' : 'N');
293 }
294 
295 static ssize_t ndp_to_end_store(struct device *d,  struct device_attribute *attr, const char *buf, size_t len)
296 {
297 	struct usbnet *dev = netdev_priv(to_net_dev(d));
298 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
299 	bool enable;
300 
301 	if (strtobool(buf, &enable))
302 		return -EINVAL;
303 
304 	/* no change? */
305 	if (enable == (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
306 		return len;
307 
308 	if (enable && !ctx->delayed_ndp16) {
309 		ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
310 		if (!ctx->delayed_ndp16)
311 			return -ENOMEM;
312 	}
313 
314 	/* flush pending data before changing flag */
315 	netif_tx_lock_bh(dev->net);
316 	usbnet_start_xmit(NULL, dev->net);
317 	spin_lock_bh(&ctx->mtx);
318 	if (enable)
319 		ctx->drvflags |= CDC_NCM_FLAG_NDP_TO_END;
320 	else
321 		ctx->drvflags &= ~CDC_NCM_FLAG_NDP_TO_END;
322 	spin_unlock_bh(&ctx->mtx);
323 	netif_tx_unlock_bh(dev->net);
324 
325 	return len;
326 }
327 static DEVICE_ATTR_RW(ndp_to_end);
328 
329 #define NCM_PARM_ATTR(name, format, tocpu)				\
330 static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
331 { \
332 	struct usbnet *dev = netdev_priv(to_net_dev(d)); \
333 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
334 	return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name));	\
335 } \
336 static DEVICE_ATTR(name, S_IRUGO, cdc_ncm_show_##name, NULL)
337 
338 NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
339 NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
340 NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
341 NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
342 NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
343 NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
344 NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
345 NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
346 NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
347 NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
348 
349 static struct attribute *cdc_ncm_sysfs_attrs[] = {
350 	&dev_attr_min_tx_pkt.attr,
351 	&dev_attr_ndp_to_end.attr,
352 	&dev_attr_rx_max.attr,
353 	&dev_attr_tx_max.attr,
354 	&dev_attr_tx_timer_usecs.attr,
355 	&dev_attr_bmNtbFormatsSupported.attr,
356 	&dev_attr_dwNtbInMaxSize.attr,
357 	&dev_attr_wNdpInDivisor.attr,
358 	&dev_attr_wNdpInPayloadRemainder.attr,
359 	&dev_attr_wNdpInAlignment.attr,
360 	&dev_attr_dwNtbOutMaxSize.attr,
361 	&dev_attr_wNdpOutDivisor.attr,
362 	&dev_attr_wNdpOutPayloadRemainder.attr,
363 	&dev_attr_wNdpOutAlignment.attr,
364 	&dev_attr_wNtbOutMaxDatagrams.attr,
365 	NULL,
366 };
367 
368 static struct attribute_group cdc_ncm_sysfs_attr_group = {
369 	.name = "cdc_ncm",
370 	.attrs = cdc_ncm_sysfs_attrs,
371 };
372 
373 /* handle rx_max and tx_max changes */
374 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
375 {
376 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
377 	u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
378 	u32 val;
379 
380 	val = cdc_ncm_check_rx_max(dev, new_rx);
381 
382 	/* inform device about NTB input size changes */
383 	if (val != ctx->rx_max) {
384 		__le32 dwNtbInMaxSize = cpu_to_le32(val);
385 
386 		dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
387 
388 		/* tell device to use new size */
389 		if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
390 				     USB_TYPE_CLASS | USB_DIR_OUT
391 				     | USB_RECIP_INTERFACE,
392 				     0, iface_no, &dwNtbInMaxSize, 4) < 0)
393 			dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
394 		else
395 			ctx->rx_max = val;
396 	}
397 
398 	/* usbnet use these values for sizing rx queues */
399 	if (dev->rx_urb_size != ctx->rx_max) {
400 		dev->rx_urb_size = ctx->rx_max;
401 		if (netif_running(dev->net))
402 			usbnet_unlink_rx_urbs(dev);
403 	}
404 
405 	val = cdc_ncm_check_tx_max(dev, new_tx);
406 	if (val != ctx->tx_max)
407 		dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
408 
409 	/* Adding a pad byte here if necessary simplifies the handling
410 	 * in cdc_ncm_fill_tx_frame, making tx_max always represent
411 	 * the real skb max size.
412 	 *
413 	 * We cannot use dev->maxpacket here because this is called from
414 	 * .bind which is called before usbnet sets up dev->maxpacket
415 	 */
416 	if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
417 	    val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
418 		val++;
419 
420 	/* we might need to flush any pending tx buffers if running */
421 	if (netif_running(dev->net) && val > ctx->tx_max) {
422 		netif_tx_lock_bh(dev->net);
423 		usbnet_start_xmit(NULL, dev->net);
424 		/* make sure tx_curr_skb is reallocated if it was empty */
425 		if (ctx->tx_curr_skb) {
426 			dev_kfree_skb_any(ctx->tx_curr_skb);
427 			ctx->tx_curr_skb = NULL;
428 		}
429 		ctx->tx_max = val;
430 		netif_tx_unlock_bh(dev->net);
431 	} else {
432 		ctx->tx_max = val;
433 	}
434 
435 	dev->hard_mtu = ctx->tx_max;
436 
437 	/* max qlen depend on hard_mtu and rx_urb_size */
438 	usbnet_update_max_qlen(dev);
439 
440 	/* never pad more than 3 full USB packets per transfer */
441 	ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
442 				  CDC_NCM_MIN_TX_PKT, ctx->tx_max);
443 }
444 
445 /* helpers for NCM and MBIM differences */
446 static u8 cdc_ncm_flags(struct usbnet *dev)
447 {
448 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
449 
450 	if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
451 		return ctx->mbim_desc->bmNetworkCapabilities;
452 	if (ctx->func_desc)
453 		return ctx->func_desc->bmNetworkCapabilities;
454 	return 0;
455 }
456 
457 static int cdc_ncm_eth_hlen(struct usbnet *dev)
458 {
459 	if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
460 		return 0;
461 	return ETH_HLEN;
462 }
463 
464 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
465 {
466 	if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
467 		return CDC_MBIM_MIN_DATAGRAM_SIZE;
468 	return CDC_NCM_MIN_DATAGRAM_SIZE;
469 }
470 
471 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
472 {
473 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
474 
475 	if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
476 		return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
477 	if (ctx->ether_desc)
478 		return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
479 	return CDC_NCM_MAX_DATAGRAM_SIZE;
480 }
481 
482 /* initial one-time device setup.  MUST be called with the data interface
483  * in altsetting 0
484  */
485 static int cdc_ncm_init(struct usbnet *dev)
486 {
487 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
488 	u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
489 	int err;
490 
491 	err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
492 			      USB_TYPE_CLASS | USB_DIR_IN
493 			      |USB_RECIP_INTERFACE,
494 			      0, iface_no, &ctx->ncm_parm,
495 			      sizeof(ctx->ncm_parm));
496 	if (err < 0) {
497 		dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
498 		return err; /* GET_NTB_PARAMETERS is required */
499 	}
500 
501 	/* set CRC Mode */
502 	if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
503 		dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
504 		err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
505 				       USB_TYPE_CLASS | USB_DIR_OUT
506 				       | USB_RECIP_INTERFACE,
507 				       USB_CDC_NCM_CRC_NOT_APPENDED,
508 				       iface_no, NULL, 0);
509 		if (err < 0)
510 			dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
511 	}
512 
513 	/* set NTB format, if both formats are supported.
514 	 *
515 	 * "The host shall only send this command while the NCM Data
516 	 *  Interface is in alternate setting 0."
517 	 */
518 	if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
519 						USB_CDC_NCM_NTB32_SUPPORTED) {
520 		dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
521 		err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
522 				       USB_TYPE_CLASS | USB_DIR_OUT
523 				       | USB_RECIP_INTERFACE,
524 				       USB_CDC_NCM_NTB16_FORMAT,
525 				       iface_no, NULL, 0);
526 		if (err < 0)
527 			dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
528 	}
529 
530 	/* set initial device values */
531 	ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
532 	ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
533 	ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
534 	ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
535 	ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
536 	/* devices prior to NCM Errata shall set this field to zero */
537 	ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
538 
539 	dev_dbg(&dev->intf->dev,
540 		"dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
541 		ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
542 		ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
543 
544 	/* max count of tx datagrams */
545 	if ((ctx->tx_max_datagrams == 0) ||
546 			(ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
547 		ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
548 
549 	/* set up maximum NDP size */
550 	ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
551 
552 	/* initial coalescing timer interval */
553 	ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
554 
555 	return 0;
556 }
557 
558 /* set a new max datagram size */
559 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
560 {
561 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
562 	u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
563 	__le16 max_datagram_size;
564 	u16 mbim_mtu;
565 	int err;
566 
567 	/* set default based on descriptors */
568 	ctx->max_datagram_size = clamp_t(u32, new_size,
569 					 cdc_ncm_min_dgram_size(dev),
570 					 CDC_NCM_MAX_DATAGRAM_SIZE);
571 
572 	/* inform the device about the selected Max Datagram Size? */
573 	if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
574 		goto out;
575 
576 	/* read current mtu value from device */
577 	err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
578 			      USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
579 			      0, iface_no, &max_datagram_size, 2);
580 	if (err < 0) {
581 		dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
582 		goto out;
583 	}
584 
585 	if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
586 		goto out;
587 
588 	max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
589 	err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
590 			       USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
591 			       0, iface_no, &max_datagram_size, 2);
592 	if (err < 0)
593 		dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
594 
595 out:
596 	/* set MTU to max supported by the device if necessary */
597 	dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
598 
599 	/* do not exceed operater preferred MTU */
600 	if (ctx->mbim_extended_desc) {
601 		mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
602 		if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
603 			dev->net->mtu = mbim_mtu;
604 	}
605 }
606 
607 static void cdc_ncm_fix_modulus(struct usbnet *dev)
608 {
609 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
610 	u32 val;
611 
612 	/*
613 	 * verify that the structure alignment is:
614 	 * - power of two
615 	 * - not greater than the maximum transmit length
616 	 * - not less than four bytes
617 	 */
618 	val = ctx->tx_ndp_modulus;
619 
620 	if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
621 	    (val != ((-val) & val)) || (val >= ctx->tx_max)) {
622 		dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
623 		ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
624 	}
625 
626 	/*
627 	 * verify that the payload alignment is:
628 	 * - power of two
629 	 * - not greater than the maximum transmit length
630 	 * - not less than four bytes
631 	 */
632 	val = ctx->tx_modulus;
633 
634 	if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
635 	    (val != ((-val) & val)) || (val >= ctx->tx_max)) {
636 		dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
637 		ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
638 	}
639 
640 	/* verify the payload remainder */
641 	if (ctx->tx_remainder >= ctx->tx_modulus) {
642 		dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
643 		ctx->tx_remainder = 0;
644 	}
645 
646 	/* adjust TX-remainder according to NCM specification. */
647 	ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
648 			     (ctx->tx_modulus - 1));
649 }
650 
651 static int cdc_ncm_setup(struct usbnet *dev)
652 {
653 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
654 	u32 def_rx, def_tx;
655 
656 	/* be conservative when selecting intial buffer size to
657 	 * increase the number of hosts this will work for
658 	 */
659 	def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
660 		       le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
661 	def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
662 		       le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
663 
664 	/* clamp rx_max and tx_max and inform device */
665 	cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
666 
667 	/* sanitize the modulus and remainder values */
668 	cdc_ncm_fix_modulus(dev);
669 
670 	/* set max datagram size */
671 	cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
672 	return 0;
673 }
674 
675 static void
676 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
677 {
678 	struct usb_host_endpoint *e, *in = NULL, *out = NULL;
679 	u8 ep;
680 
681 	for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
682 
683 		e = intf->cur_altsetting->endpoint + ep;
684 		switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
685 		case USB_ENDPOINT_XFER_INT:
686 			if (usb_endpoint_dir_in(&e->desc)) {
687 				if (!dev->status)
688 					dev->status = e;
689 			}
690 			break;
691 
692 		case USB_ENDPOINT_XFER_BULK:
693 			if (usb_endpoint_dir_in(&e->desc)) {
694 				if (!in)
695 					in = e;
696 			} else {
697 				if (!out)
698 					out = e;
699 			}
700 			break;
701 
702 		default:
703 			break;
704 		}
705 	}
706 	if (in && !dev->in)
707 		dev->in = usb_rcvbulkpipe(dev->udev,
708 					  in->desc.bEndpointAddress &
709 					  USB_ENDPOINT_NUMBER_MASK);
710 	if (out && !dev->out)
711 		dev->out = usb_sndbulkpipe(dev->udev,
712 					   out->desc.bEndpointAddress &
713 					   USB_ENDPOINT_NUMBER_MASK);
714 }
715 
716 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
717 {
718 	if (ctx == NULL)
719 		return;
720 
721 	if (ctx->tx_rem_skb != NULL) {
722 		dev_kfree_skb_any(ctx->tx_rem_skb);
723 		ctx->tx_rem_skb = NULL;
724 	}
725 
726 	if (ctx->tx_curr_skb != NULL) {
727 		dev_kfree_skb_any(ctx->tx_curr_skb);
728 		ctx->tx_curr_skb = NULL;
729 	}
730 
731 	kfree(ctx->delayed_ndp16);
732 
733 	kfree(ctx);
734 }
735 
736 /* we need to override the usbnet change_mtu ndo for two reasons:
737  *  - respect the negotiated maximum datagram size
738  *  - avoid unwanted changes to rx and tx buffers
739  */
740 int cdc_ncm_change_mtu(struct net_device *net, int new_mtu)
741 {
742 	struct usbnet *dev = netdev_priv(net);
743 	int maxmtu = cdc_ncm_max_dgram_size(dev) - cdc_ncm_eth_hlen(dev);
744 
745 	if (new_mtu <= 0 || new_mtu > maxmtu)
746 		return -EINVAL;
747 
748 	net->mtu = new_mtu;
749 	cdc_ncm_set_dgram_size(dev, new_mtu + cdc_ncm_eth_hlen(dev));
750 
751 	return 0;
752 }
753 EXPORT_SYMBOL_GPL(cdc_ncm_change_mtu);
754 
755 static const struct net_device_ops cdc_ncm_netdev_ops = {
756 	.ndo_open	     = usbnet_open,
757 	.ndo_stop	     = usbnet_stop,
758 	.ndo_start_xmit	     = usbnet_start_xmit,
759 	.ndo_tx_timeout	     = usbnet_tx_timeout,
760 	.ndo_change_mtu	     = cdc_ncm_change_mtu,
761 	.ndo_set_mac_address = eth_mac_addr,
762 	.ndo_validate_addr   = eth_validate_addr,
763 };
764 
765 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
766 {
767 	struct cdc_ncm_ctx *ctx;
768 	struct usb_driver *driver;
769 	u8 *buf;
770 	int len;
771 	int temp;
772 	u8 iface_no;
773 	struct usb_cdc_parsed_header hdr;
774 
775 	ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
776 	if (!ctx)
777 		return -ENOMEM;
778 
779 	hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
780 	ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
781 	ctx->bh.data = (unsigned long)dev;
782 	ctx->bh.func = cdc_ncm_txpath_bh;
783 	atomic_set(&ctx->stop, 0);
784 	spin_lock_init(&ctx->mtx);
785 
786 	/* store ctx pointer in device data field */
787 	dev->data[0] = (unsigned long)ctx;
788 
789 	/* only the control interface can be successfully probed */
790 	ctx->control = intf;
791 
792 	/* get some pointers */
793 	driver = driver_of(intf);
794 	buf = intf->cur_altsetting->extra;
795 	len = intf->cur_altsetting->extralen;
796 
797 	/* parse through descriptors associated with control interface */
798 	cdc_parse_cdc_header(&hdr, intf, buf, len);
799 
800 	if (hdr.usb_cdc_union_desc)
801 		ctx->data = usb_ifnum_to_if(dev->udev,
802 					    hdr.usb_cdc_union_desc->bSlaveInterface0);
803 	ctx->ether_desc = hdr.usb_cdc_ether_desc;
804 	ctx->func_desc = hdr.usb_cdc_ncm_desc;
805 	ctx->mbim_desc = hdr.usb_cdc_mbim_desc;
806 	ctx->mbim_extended_desc = hdr.usb_cdc_mbim_extended_desc;
807 
808 	/* some buggy devices have an IAD but no CDC Union */
809 	if (!hdr.usb_cdc_union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
810 		ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
811 		dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
812 	}
813 
814 	/* check if we got everything */
815 	if (!ctx->data) {
816 		dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
817 		goto error;
818 	}
819 	if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
820 		if (!ctx->mbim_desc) {
821 			dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
822 			goto error;
823 		}
824 	} else {
825 		if (!ctx->ether_desc || !ctx->func_desc) {
826 			dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
827 			goto error;
828 		}
829 	}
830 
831 	/* claim data interface, if different from control */
832 	if (ctx->data != ctx->control) {
833 		temp = usb_driver_claim_interface(driver, ctx->data, dev);
834 		if (temp) {
835 			dev_dbg(&intf->dev, "failed to claim data intf\n");
836 			goto error;
837 		}
838 	}
839 
840 	iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
841 
842 	/* Reset data interface. Some devices will not reset properly
843 	 * unless they are configured first.  Toggle the altsetting to
844 	 * force a reset
845 	 */
846 	usb_set_interface(dev->udev, iface_no, data_altsetting);
847 	temp = usb_set_interface(dev->udev, iface_no, 0);
848 	if (temp) {
849 		dev_dbg(&intf->dev, "set interface failed\n");
850 		goto error2;
851 	}
852 
853 	/* initialize basic device settings */
854 	if (cdc_ncm_init(dev))
855 		goto error2;
856 
857 	/* Some firmwares need a pause here or they will silently fail
858 	 * to set up the interface properly.  This value was decided
859 	 * empirically on a Sierra Wireless MC7455 running 02.08.02.00
860 	 * firmware.
861 	 */
862 	usleep_range(10000, 20000);
863 
864 	/* configure data interface */
865 	temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
866 	if (temp) {
867 		dev_dbg(&intf->dev, "set interface failed\n");
868 		goto error2;
869 	}
870 
871 	cdc_ncm_find_endpoints(dev, ctx->data);
872 	cdc_ncm_find_endpoints(dev, ctx->control);
873 	if (!dev->in || !dev->out || !dev->status) {
874 		dev_dbg(&intf->dev, "failed to collect endpoints\n");
875 		goto error2;
876 	}
877 
878 	usb_set_intfdata(ctx->data, dev);
879 	usb_set_intfdata(ctx->control, dev);
880 
881 	if (ctx->ether_desc) {
882 		temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
883 		if (temp) {
884 			dev_dbg(&intf->dev, "failed to get mac address\n");
885 			goto error2;
886 		}
887 		dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
888 	}
889 
890 	/* finish setting up the device specific data */
891 	cdc_ncm_setup(dev);
892 
893 	/* Device-specific flags */
894 	ctx->drvflags = drvflags;
895 
896 	/* Allocate the delayed NDP if needed. */
897 	if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
898 		ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
899 		if (!ctx->delayed_ndp16)
900 			goto error2;
901 		dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
902 	}
903 
904 	/* override ethtool_ops */
905 	dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
906 
907 	/* add our sysfs attrs */
908 	dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
909 
910 	/* must handle MTU changes */
911 	dev->net->netdev_ops = &cdc_ncm_netdev_ops;
912 
913 	return 0;
914 
915 error2:
916 	usb_set_intfdata(ctx->control, NULL);
917 	usb_set_intfdata(ctx->data, NULL);
918 	if (ctx->data != ctx->control)
919 		usb_driver_release_interface(driver, ctx->data);
920 error:
921 	cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
922 	dev->data[0] = 0;
923 	dev_info(&intf->dev, "bind() failure\n");
924 	return -ENODEV;
925 }
926 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
927 
928 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
929 {
930 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
931 	struct usb_driver *driver = driver_of(intf);
932 
933 	if (ctx == NULL)
934 		return;		/* no setup */
935 
936 	atomic_set(&ctx->stop, 1);
937 
938 	if (hrtimer_active(&ctx->tx_timer))
939 		hrtimer_cancel(&ctx->tx_timer);
940 
941 	tasklet_kill(&ctx->bh);
942 
943 	/* handle devices with combined control and data interface */
944 	if (ctx->control == ctx->data)
945 		ctx->data = NULL;
946 
947 	/* disconnect master --> disconnect slave */
948 	if (intf == ctx->control && ctx->data) {
949 		usb_set_intfdata(ctx->data, NULL);
950 		usb_driver_release_interface(driver, ctx->data);
951 		ctx->data = NULL;
952 
953 	} else if (intf == ctx->data && ctx->control) {
954 		usb_set_intfdata(ctx->control, NULL);
955 		usb_driver_release_interface(driver, ctx->control);
956 		ctx->control = NULL;
957 	}
958 
959 	usb_set_intfdata(intf, NULL);
960 	cdc_ncm_free(ctx);
961 }
962 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
963 
964 /* Return the number of the MBIM control interface altsetting iff it
965  * is preferred and available,
966  */
967 u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
968 {
969 	struct usb_host_interface *alt;
970 
971 	/* The MBIM spec defines a NCM compatible default altsetting,
972 	 * which we may have matched:
973 	 *
974 	 *  "Functions that implement both NCM 1.0 and MBIM (an
975 	 *   “NCM/MBIM function”) according to this recommendation
976 	 *   shall provide two alternate settings for the
977 	 *   Communication Interface.  Alternate setting 0, and the
978 	 *   associated class and endpoint descriptors, shall be
979 	 *   constructed according to the rules given for the
980 	 *   Communication Interface in section 5 of [USBNCM10].
981 	 *   Alternate setting 1, and the associated class and
982 	 *   endpoint descriptors, shall be constructed according to
983 	 *   the rules given in section 6 (USB Device Model) of this
984 	 *   specification."
985 	 */
986 	if (intf->num_altsetting < 2)
987 		return intf->cur_altsetting->desc.bAlternateSetting;
988 
989 	if (prefer_mbim) {
990 		alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
991 		if (alt && cdc_ncm_comm_intf_is_mbim(alt))
992 			return CDC_NCM_COMM_ALTSETTING_MBIM;
993 	}
994 	return CDC_NCM_COMM_ALTSETTING_NCM;
995 }
996 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
997 
998 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
999 {
1000 	/* MBIM backwards compatible function? */
1001 	if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
1002 		return -ENODEV;
1003 
1004 	/* The NCM data altsetting is fixed, so we hard-coded it.
1005 	 * Additionally, generic NCM devices are assumed to accept arbitrarily
1006 	 * placed NDP.
1007 	 */
1008 	return cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM, 0);
1009 }
1010 
1011 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
1012 {
1013 	size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
1014 
1015 	if (skb->len + align > max)
1016 		align = max - skb->len;
1017 	if (align && skb_tailroom(skb) >= align)
1018 		memset(skb_put(skb, align), 0, align);
1019 }
1020 
1021 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
1022  * allocating a new one within skb
1023  */
1024 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
1025 {
1026 	struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
1027 	struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
1028 	size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
1029 
1030 	/* If NDP should be moved to the end of the NCM package, we can't follow the
1031 	* NTH16 header as we would normally do. NDP isn't written to the SKB yet, and
1032 	* the wNdpIndex field in the header is actually not consistent with reality. It will be later.
1033 	*/
1034 	if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1035 		if (ctx->delayed_ndp16->dwSignature == sign)
1036 			return ctx->delayed_ndp16;
1037 
1038 		/* We can only push a single NDP to the end. Return
1039 		 * NULL to send what we've already got and queue this
1040 		 * skb for later.
1041 		 */
1042 		else if (ctx->delayed_ndp16->dwSignature)
1043 			return NULL;
1044 	}
1045 
1046 	/* follow the chain of NDPs, looking for a match */
1047 	while (ndpoffset) {
1048 		ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
1049 		if  (ndp16->dwSignature == sign)
1050 			return ndp16;
1051 		ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1052 	}
1053 
1054 	/* align new NDP */
1055 	if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1056 		cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1057 
1058 	/* verify that there is room for the NDP and the datagram (reserve) */
1059 	if ((ctx->tx_max - skb->len - reserve) < ctx->max_ndp_size)
1060 		return NULL;
1061 
1062 	/* link to it */
1063 	if (ndp16)
1064 		ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
1065 	else
1066 		nth16->wNdpIndex = cpu_to_le16(skb->len);
1067 
1068 	/* push a new empty NDP */
1069 	if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1070 		ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, ctx->max_ndp_size);
1071 	else
1072 		ndp16 = ctx->delayed_ndp16;
1073 
1074 	ndp16->dwSignature = sign;
1075 	ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
1076 	return ndp16;
1077 }
1078 
1079 struct sk_buff *
1080 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
1081 {
1082 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1083 	struct usb_cdc_ncm_nth16 *nth16;
1084 	struct usb_cdc_ncm_ndp16 *ndp16;
1085 	struct sk_buff *skb_out;
1086 	u16 n = 0, index, ndplen;
1087 	u8 ready2send = 0;
1088 	u32 delayed_ndp_size;
1089 
1090 	/* When our NDP gets written in cdc_ncm_ndp(), then skb_out->len gets updated
1091 	 * accordingly. Otherwise, we should check here.
1092 	 */
1093 	if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1094 		delayed_ndp_size = ctx->max_ndp_size;
1095 	else
1096 		delayed_ndp_size = 0;
1097 
1098 	/* if there is a remaining skb, it gets priority */
1099 	if (skb != NULL) {
1100 		swap(skb, ctx->tx_rem_skb);
1101 		swap(sign, ctx->tx_rem_sign);
1102 	} else {
1103 		ready2send = 1;
1104 	}
1105 
1106 	/* check if we are resuming an OUT skb */
1107 	skb_out = ctx->tx_curr_skb;
1108 
1109 	/* allocate a new OUT skb */
1110 	if (!skb_out) {
1111 		skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
1112 		if (skb_out == NULL) {
1113 			if (skb != NULL) {
1114 				dev_kfree_skb_any(skb);
1115 				dev->net->stats.tx_dropped++;
1116 			}
1117 			goto exit_no_skb;
1118 		}
1119 		/* fill out the initial 16-bit NTB header */
1120 		nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
1121 		nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1122 		nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1123 		nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
1124 
1125 		/* count total number of frames in this NTB */
1126 		ctx->tx_curr_frame_num = 0;
1127 
1128 		/* recent payload counter for this skb_out */
1129 		ctx->tx_curr_frame_payload = 0;
1130 	}
1131 
1132 	for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1133 		/* send any remaining skb first */
1134 		if (skb == NULL) {
1135 			skb = ctx->tx_rem_skb;
1136 			sign = ctx->tx_rem_sign;
1137 			ctx->tx_rem_skb = NULL;
1138 
1139 			/* check for end of skb */
1140 			if (skb == NULL)
1141 				break;
1142 		}
1143 
1144 		/* get the appropriate NDP for this skb */
1145 		ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1146 
1147 		/* align beginning of next frame */
1148 		cdc_ncm_align_tail(skb_out,  ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
1149 
1150 		/* check if we had enough room left for both NDP and frame */
1151 		if (!ndp16 || skb_out->len + skb->len + delayed_ndp_size > ctx->tx_max) {
1152 			if (n == 0) {
1153 				/* won't fit, MTU problem? */
1154 				dev_kfree_skb_any(skb);
1155 				skb = NULL;
1156 				dev->net->stats.tx_dropped++;
1157 			} else {
1158 				/* no room for skb - store for later */
1159 				if (ctx->tx_rem_skb != NULL) {
1160 					dev_kfree_skb_any(ctx->tx_rem_skb);
1161 					dev->net->stats.tx_dropped++;
1162 				}
1163 				ctx->tx_rem_skb = skb;
1164 				ctx->tx_rem_sign = sign;
1165 				skb = NULL;
1166 				ready2send = 1;
1167 				ctx->tx_reason_ntb_full++;	/* count reason for transmitting */
1168 			}
1169 			break;
1170 		}
1171 
1172 		/* calculate frame number withing this NDP */
1173 		ndplen = le16_to_cpu(ndp16->wLength);
1174 		index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
1175 
1176 		/* OK, add this skb */
1177 		ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1178 		ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1179 		ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
1180 		memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
1181 		ctx->tx_curr_frame_payload += skb->len;	/* count real tx payload data */
1182 		dev_kfree_skb_any(skb);
1183 		skb = NULL;
1184 
1185 		/* send now if this NDP is full */
1186 		if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1187 			ready2send = 1;
1188 			ctx->tx_reason_ndp_full++;	/* count reason for transmitting */
1189 			break;
1190 		}
1191 	}
1192 
1193 	/* free up any dangling skb */
1194 	if (skb != NULL) {
1195 		dev_kfree_skb_any(skb);
1196 		skb = NULL;
1197 		dev->net->stats.tx_dropped++;
1198 	}
1199 
1200 	ctx->tx_curr_frame_num = n;
1201 
1202 	if (n == 0) {
1203 		/* wait for more frames */
1204 		/* push variables */
1205 		ctx->tx_curr_skb = skb_out;
1206 		goto exit_no_skb;
1207 
1208 	} else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1209 		/* wait for more frames */
1210 		/* push variables */
1211 		ctx->tx_curr_skb = skb_out;
1212 		/* set the pending count */
1213 		if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1214 			ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1215 		goto exit_no_skb;
1216 
1217 	} else {
1218 		if (n == ctx->tx_max_datagrams)
1219 			ctx->tx_reason_max_datagram++;	/* count reason for transmitting */
1220 		/* frame goes out */
1221 		/* variables will be reset at next call */
1222 	}
1223 
1224 	/* If requested, put NDP at end of frame. */
1225 	if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1226 		nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1227 		cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1228 		nth16->wNdpIndex = cpu_to_le16(skb_out->len);
1229 		memcpy(skb_put(skb_out, ctx->max_ndp_size), ctx->delayed_ndp16, ctx->max_ndp_size);
1230 
1231 		/* Zero out delayed NDP - signature checking will naturally fail. */
1232 		ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1233 	}
1234 
1235 	/* If collected data size is less or equal ctx->min_tx_pkt
1236 	 * bytes, we send buffers as it is. If we get more data, it
1237 	 * would be more efficient for USB HS mobile device with DMA
1238 	 * engine to receive a full size NTB, than canceling DMA
1239 	 * transfer and receiving a short packet.
1240 	 *
1241 	 * This optimization support is pointless if we end up sending
1242 	 * a ZLP after full sized NTBs.
1243 	 */
1244 	if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1245 	    skb_out->len > ctx->min_tx_pkt)
1246 		memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
1247 		       ctx->tx_max - skb_out->len);
1248 	else if (skb_out->len < ctx->tx_max && (skb_out->len % dev->maxpacket) == 0)
1249 		*skb_put(skb_out, 1) = 0;	/* force short packet */
1250 
1251 	/* set final frame length */
1252 	nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1253 	nth16->wBlockLength = cpu_to_le16(skb_out->len);
1254 
1255 	/* return skb */
1256 	ctx->tx_curr_skb = NULL;
1257 
1258 	/* keep private stats: framing overhead and number of NTBs */
1259 	ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1260 	ctx->tx_ntbs++;
1261 
1262 	/* usbnet will count all the framing overhead by default.
1263 	 * Adjust the stats so that the tx_bytes counter show real
1264 	 * payload data instead.
1265 	 */
1266 	usbnet_set_skb_tx_stats(skb_out, n,
1267 				(long)ctx->tx_curr_frame_payload - skb_out->len);
1268 
1269 	return skb_out;
1270 
1271 exit_no_skb:
1272 	/* Start timer, if there is a remaining non-empty skb */
1273 	if (ctx->tx_curr_skb != NULL && n > 0)
1274 		cdc_ncm_tx_timeout_start(ctx);
1275 	return NULL;
1276 }
1277 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1278 
1279 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1280 {
1281 	/* start timer, if not already started */
1282 	if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1283 		hrtimer_start(&ctx->tx_timer,
1284 				ktime_set(0, ctx->timer_interval),
1285 				HRTIMER_MODE_REL);
1286 }
1287 
1288 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1289 {
1290 	struct cdc_ncm_ctx *ctx =
1291 			container_of(timer, struct cdc_ncm_ctx, tx_timer);
1292 
1293 	if (!atomic_read(&ctx->stop))
1294 		tasklet_schedule(&ctx->bh);
1295 	return HRTIMER_NORESTART;
1296 }
1297 
1298 static void cdc_ncm_txpath_bh(unsigned long param)
1299 {
1300 	struct usbnet *dev = (struct usbnet *)param;
1301 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1302 
1303 	spin_lock_bh(&ctx->mtx);
1304 	if (ctx->tx_timer_pending != 0) {
1305 		ctx->tx_timer_pending--;
1306 		cdc_ncm_tx_timeout_start(ctx);
1307 		spin_unlock_bh(&ctx->mtx);
1308 	} else if (dev->net != NULL) {
1309 		ctx->tx_reason_timeout++;	/* count reason for transmitting */
1310 		spin_unlock_bh(&ctx->mtx);
1311 		netif_tx_lock_bh(dev->net);
1312 		usbnet_start_xmit(NULL, dev->net);
1313 		netif_tx_unlock_bh(dev->net);
1314 	} else {
1315 		spin_unlock_bh(&ctx->mtx);
1316 	}
1317 }
1318 
1319 struct sk_buff *
1320 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1321 {
1322 	struct sk_buff *skb_out;
1323 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1324 
1325 	/*
1326 	 * The Ethernet API we are using does not support transmitting
1327 	 * multiple Ethernet frames in a single call. This driver will
1328 	 * accumulate multiple Ethernet frames and send out a larger
1329 	 * USB frame when the USB buffer is full or when a single jiffies
1330 	 * timeout happens.
1331 	 */
1332 	if (ctx == NULL)
1333 		goto error;
1334 
1335 	spin_lock_bh(&ctx->mtx);
1336 	skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1337 	spin_unlock_bh(&ctx->mtx);
1338 	return skb_out;
1339 
1340 error:
1341 	if (skb != NULL)
1342 		dev_kfree_skb_any(skb);
1343 
1344 	return NULL;
1345 }
1346 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1347 
1348 /* verify NTB header and return offset of first NDP, or negative error */
1349 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1350 {
1351 	struct usbnet *dev = netdev_priv(skb_in->dev);
1352 	struct usb_cdc_ncm_nth16 *nth16;
1353 	int len;
1354 	int ret = -EINVAL;
1355 
1356 	if (ctx == NULL)
1357 		goto error;
1358 
1359 	if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1360 					sizeof(struct usb_cdc_ncm_ndp16))) {
1361 		netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1362 		goto error;
1363 	}
1364 
1365 	nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1366 
1367 	if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1368 		netif_dbg(dev, rx_err, dev->net,
1369 			  "invalid NTH16 signature <%#010x>\n",
1370 			  le32_to_cpu(nth16->dwSignature));
1371 		goto error;
1372 	}
1373 
1374 	len = le16_to_cpu(nth16->wBlockLength);
1375 	if (len > ctx->rx_max) {
1376 		netif_dbg(dev, rx_err, dev->net,
1377 			  "unsupported NTB block length %u/%u\n", len,
1378 			  ctx->rx_max);
1379 		goto error;
1380 	}
1381 
1382 	if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1383 	    (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1384 	    !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1385 		netif_dbg(dev, rx_err, dev->net,
1386 			  "sequence number glitch prev=%d curr=%d\n",
1387 			  ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1388 	}
1389 	ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1390 
1391 	ret = le16_to_cpu(nth16->wNdpIndex);
1392 error:
1393 	return ret;
1394 }
1395 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1396 
1397 /* verify NDP header and return number of datagrams, or negative error */
1398 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1399 {
1400 	struct usbnet *dev = netdev_priv(skb_in->dev);
1401 	struct usb_cdc_ncm_ndp16 *ndp16;
1402 	int ret = -EINVAL;
1403 
1404 	if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1405 		netif_dbg(dev, rx_err, dev->net, "invalid NDP offset  <%u>\n",
1406 			  ndpoffset);
1407 		goto error;
1408 	}
1409 	ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1410 
1411 	if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1412 		netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1413 			  le16_to_cpu(ndp16->wLength));
1414 		goto error;
1415 	}
1416 
1417 	ret = ((le16_to_cpu(ndp16->wLength) -
1418 					sizeof(struct usb_cdc_ncm_ndp16)) /
1419 					sizeof(struct usb_cdc_ncm_dpe16));
1420 	ret--; /* we process NDP entries except for the last one */
1421 
1422 	if ((sizeof(struct usb_cdc_ncm_ndp16) +
1423 	     ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1424 		netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1425 		ret = -EINVAL;
1426 	}
1427 
1428 error:
1429 	return ret;
1430 }
1431 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1432 
1433 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1434 {
1435 	struct sk_buff *skb;
1436 	struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1437 	int len;
1438 	int nframes;
1439 	int x;
1440 	int offset;
1441 	struct usb_cdc_ncm_ndp16 *ndp16;
1442 	struct usb_cdc_ncm_dpe16 *dpe16;
1443 	int ndpoffset;
1444 	int loopcount = 50; /* arbitrary max preventing infinite loop */
1445 	u32 payload = 0;
1446 
1447 	ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1448 	if (ndpoffset < 0)
1449 		goto error;
1450 
1451 next_ndp:
1452 	nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1453 	if (nframes < 0)
1454 		goto error;
1455 
1456 	ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1457 
1458 	if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1459 		netif_dbg(dev, rx_err, dev->net,
1460 			  "invalid DPT16 signature <%#010x>\n",
1461 			  le32_to_cpu(ndp16->dwSignature));
1462 		goto err_ndp;
1463 	}
1464 	dpe16 = ndp16->dpe16;
1465 
1466 	for (x = 0; x < nframes; x++, dpe16++) {
1467 		offset = le16_to_cpu(dpe16->wDatagramIndex);
1468 		len = le16_to_cpu(dpe16->wDatagramLength);
1469 
1470 		/*
1471 		 * CDC NCM ch. 3.7
1472 		 * All entries after first NULL entry are to be ignored
1473 		 */
1474 		if ((offset == 0) || (len == 0)) {
1475 			if (!x)
1476 				goto err_ndp; /* empty NTB */
1477 			break;
1478 		}
1479 
1480 		/* sanity checking */
1481 		if (((offset + len) > skb_in->len) ||
1482 				(len > ctx->rx_max) || (len < ETH_HLEN)) {
1483 			netif_dbg(dev, rx_err, dev->net,
1484 				  "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1485 				  x, offset, len, skb_in);
1486 			if (!x)
1487 				goto err_ndp;
1488 			break;
1489 
1490 		} else {
1491 			/* create a fresh copy to reduce truesize */
1492 			skb = netdev_alloc_skb_ip_align(dev->net,  len);
1493 			if (!skb)
1494 				goto error;
1495 			memcpy(skb_put(skb, len), skb_in->data + offset, len);
1496 			usbnet_skb_return(dev, skb);
1497 			payload += len;	/* count payload bytes in this NTB */
1498 		}
1499 	}
1500 err_ndp:
1501 	/* are there more NDPs to process? */
1502 	ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1503 	if (ndpoffset && loopcount--)
1504 		goto next_ndp;
1505 
1506 	/* update stats */
1507 	ctx->rx_overhead += skb_in->len - payload;
1508 	ctx->rx_ntbs++;
1509 
1510 	return 1;
1511 error:
1512 	return 0;
1513 }
1514 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1515 
1516 static void
1517 cdc_ncm_speed_change(struct usbnet *dev,
1518 		     struct usb_cdc_speed_change *data)
1519 {
1520 	uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1521 	uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1522 
1523 	/*
1524 	 * Currently the USB-NET API does not support reporting the actual
1525 	 * device speed. Do print it instead.
1526 	 */
1527 	if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1528 		netif_info(dev, link, dev->net,
1529 			   "%u mbit/s downlink %u mbit/s uplink\n",
1530 			   (unsigned int)(rx_speed / 1000000U),
1531 			   (unsigned int)(tx_speed / 1000000U));
1532 	} else {
1533 		netif_info(dev, link, dev->net,
1534 			   "%u kbit/s downlink %u kbit/s uplink\n",
1535 			   (unsigned int)(rx_speed / 1000U),
1536 			   (unsigned int)(tx_speed / 1000U));
1537 	}
1538 }
1539 
1540 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1541 {
1542 	struct cdc_ncm_ctx *ctx;
1543 	struct usb_cdc_notification *event;
1544 
1545 	ctx = (struct cdc_ncm_ctx *)dev->data[0];
1546 
1547 	if (urb->actual_length < sizeof(*event))
1548 		return;
1549 
1550 	/* test for split data in 8-byte chunks */
1551 	if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1552 		cdc_ncm_speed_change(dev,
1553 		      (struct usb_cdc_speed_change *)urb->transfer_buffer);
1554 		return;
1555 	}
1556 
1557 	event = urb->transfer_buffer;
1558 
1559 	switch (event->bNotificationType) {
1560 	case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1561 		/*
1562 		 * According to the CDC NCM specification ch.7.1
1563 		 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1564 		 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1565 		 */
1566 		netif_info(dev, link, dev->net,
1567 			   "network connection: %sconnected\n",
1568 			   !!event->wValue ? "" : "dis");
1569 		usbnet_link_change(dev, !!event->wValue, 0);
1570 		break;
1571 
1572 	case USB_CDC_NOTIFY_SPEED_CHANGE:
1573 		if (urb->actual_length < (sizeof(*event) +
1574 					sizeof(struct usb_cdc_speed_change)))
1575 			set_bit(EVENT_STS_SPLIT, &dev->flags);
1576 		else
1577 			cdc_ncm_speed_change(dev,
1578 					     (struct usb_cdc_speed_change *)&event[1]);
1579 		break;
1580 
1581 	default:
1582 		dev_dbg(&dev->udev->dev,
1583 			"NCM: unexpected notification 0x%02x!\n",
1584 			event->bNotificationType);
1585 		break;
1586 	}
1587 }
1588 
1589 static const struct driver_info cdc_ncm_info = {
1590 	.description = "CDC NCM",
1591 	.flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1592 			| FLAG_LINK_INTR,
1593 	.bind = cdc_ncm_bind,
1594 	.unbind = cdc_ncm_unbind,
1595 	.manage_power = usbnet_manage_power,
1596 	.status = cdc_ncm_status,
1597 	.rx_fixup = cdc_ncm_rx_fixup,
1598 	.tx_fixup = cdc_ncm_tx_fixup,
1599 };
1600 
1601 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1602 static const struct driver_info wwan_info = {
1603 	.description = "Mobile Broadband Network Device",
1604 	.flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1605 			| FLAG_LINK_INTR | FLAG_WWAN,
1606 	.bind = cdc_ncm_bind,
1607 	.unbind = cdc_ncm_unbind,
1608 	.manage_power = usbnet_manage_power,
1609 	.status = cdc_ncm_status,
1610 	.rx_fixup = cdc_ncm_rx_fixup,
1611 	.tx_fixup = cdc_ncm_tx_fixup,
1612 };
1613 
1614 /* Same as wwan_info, but with FLAG_NOARP  */
1615 static const struct driver_info wwan_noarp_info = {
1616 	.description = "Mobile Broadband Network Device (NO ARP)",
1617 	.flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1618 			| FLAG_LINK_INTR | FLAG_WWAN | FLAG_NOARP,
1619 	.bind = cdc_ncm_bind,
1620 	.unbind = cdc_ncm_unbind,
1621 	.manage_power = usbnet_manage_power,
1622 	.status = cdc_ncm_status,
1623 	.rx_fixup = cdc_ncm_rx_fixup,
1624 	.tx_fixup = cdc_ncm_tx_fixup,
1625 };
1626 
1627 static const struct usb_device_id cdc_devs[] = {
1628 	/* Ericsson MBM devices like F5521gw */
1629 	{ .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1630 		| USB_DEVICE_ID_MATCH_VENDOR,
1631 	  .idVendor = 0x0bdb,
1632 	  .bInterfaceClass = USB_CLASS_COMM,
1633 	  .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1634 	  .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1635 	  .driver_info = (unsigned long) &wwan_info,
1636 	},
1637 
1638 	/* Telit LE910 V2 */
1639 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x0036,
1640 		USB_CLASS_COMM,
1641 		USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1642 	  .driver_info = (unsigned long)&wwan_noarp_info,
1643 	},
1644 
1645 	/* DW5812 LTE Verizon Mobile Broadband Card
1646 	 * Unlike DW5550 this device requires FLAG_NOARP
1647 	 */
1648 	{ USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bb,
1649 		USB_CLASS_COMM,
1650 		USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1651 	  .driver_info = (unsigned long)&wwan_noarp_info,
1652 	},
1653 
1654 	/* DW5813 LTE AT&T Mobile Broadband Card
1655 	 * Unlike DW5550 this device requires FLAG_NOARP
1656 	 */
1657 	{ USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bc,
1658 		USB_CLASS_COMM,
1659 		USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1660 	  .driver_info = (unsigned long)&wwan_noarp_info,
1661 	},
1662 
1663 	/* Dell branded MBM devices like DW5550 */
1664 	{ .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1665 		| USB_DEVICE_ID_MATCH_VENDOR,
1666 	  .idVendor = 0x413c,
1667 	  .bInterfaceClass = USB_CLASS_COMM,
1668 	  .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1669 	  .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1670 	  .driver_info = (unsigned long) &wwan_info,
1671 	},
1672 
1673 	/* Toshiba branded MBM devices */
1674 	{ .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1675 		| USB_DEVICE_ID_MATCH_VENDOR,
1676 	  .idVendor = 0x0930,
1677 	  .bInterfaceClass = USB_CLASS_COMM,
1678 	  .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1679 	  .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1680 	  .driver_info = (unsigned long) &wwan_info,
1681 	},
1682 
1683 	/* tag Huawei devices as wwan */
1684 	{ USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1685 					USB_CLASS_COMM,
1686 					USB_CDC_SUBCLASS_NCM,
1687 					USB_CDC_PROTO_NONE),
1688 	  .driver_info = (unsigned long)&wwan_info,
1689 	},
1690 
1691 	/* Infineon(now Intel) HSPA Modem platform */
1692 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1693 		USB_CLASS_COMM,
1694 		USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1695 	  .driver_info = (unsigned long)&wwan_noarp_info,
1696 	},
1697 
1698 	/* Generic CDC-NCM devices */
1699 	{ USB_INTERFACE_INFO(USB_CLASS_COMM,
1700 		USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1701 		.driver_info = (unsigned long)&cdc_ncm_info,
1702 	},
1703 	{
1704 	},
1705 };
1706 MODULE_DEVICE_TABLE(usb, cdc_devs);
1707 
1708 static struct usb_driver cdc_ncm_driver = {
1709 	.name = "cdc_ncm",
1710 	.id_table = cdc_devs,
1711 	.probe = usbnet_probe,
1712 	.disconnect = usbnet_disconnect,
1713 	.suspend = usbnet_suspend,
1714 	.resume = usbnet_resume,
1715 	.reset_resume =	usbnet_resume,
1716 	.supports_autosuspend = 1,
1717 	.disable_hub_initiated_lpm = 1,
1718 };
1719 
1720 module_usb_driver(cdc_ncm_driver);
1721 
1722 MODULE_AUTHOR("Hans Petter Selasky");
1723 MODULE_DESCRIPTION("USB CDC NCM host driver");
1724 MODULE_LICENSE("Dual BSD/GPL");
1725