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>
8 * USB Host Driver for Network Control Model (NCM)
9 * http://www.usb.org/developers/docs/devclass_docs/NCM10_012011.zip
11 * The NCM encoding, decoding and initialization logic
12 * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
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:
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
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.
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
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>
56 #if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
57 static bool prefer_mbim = true;
59 static bool prefer_mbim;
61 module_param(prefer_mbim, bool, 0644);
62 MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
64 static void cdc_ncm_txpath_bh(struct tasklet_struct *t);
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;
69 struct cdc_ncm_stats {
70 char stat_string[ETH_GSTRING_LEN];
75 #define CDC_NCM_STAT(str, m) { \
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)
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),
92 #define CDC_NCM_LOW_MEM_MAX_CNT 10
94 static int cdc_ncm_get_sset_count(struct net_device __always_unused *netdev, int sset)
98 return ARRAY_SIZE(cdc_ncm_gstrings_stats);
104 static void cdc_ncm_get_ethtool_stats(struct net_device *netdev,
105 struct ethtool_stats __always_unused *stats,
108 struct usbnet *dev = netdev_priv(netdev);
109 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
113 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
114 p = (char *)ctx + cdc_ncm_gstrings_stats[i].stat_offset;
115 data[i] = (cdc_ncm_gstrings_stats[i].sizeof_stat == sizeof(u64)) ? *(u64 *)p : *(u32 *)p;
119 static void cdc_ncm_get_strings(struct net_device __always_unused *netdev, u32 stringset, u8 *data)
126 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
127 memcpy(p, cdc_ncm_gstrings_stats[i].stat_string, ETH_GSTRING_LEN);
128 p += ETH_GSTRING_LEN;
133 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
135 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
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 .get_link_ksettings = usbnet_get_link_ksettings,
146 .set_link_ksettings = usbnet_set_link_ksettings,
149 static u32 cdc_ncm_check_rx_max(struct usbnet *dev, u32 new_rx)
151 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
154 /* clamp new_rx to sane values */
155 min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
156 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
158 /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
160 dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
161 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
165 val = clamp_t(u32, new_rx, min, max);
167 dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range\n", min, max);
172 static u32 cdc_ncm_check_tx_max(struct usbnet *dev, u32 new_tx)
174 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
177 /* clamp new_tx to sane values */
179 min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
181 min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth32);
183 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
185 /* some devices set dwNtbOutMaxSize too low for the above default */
188 val = clamp_t(u32, new_tx, min, max);
190 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range\n", min, max);
195 static ssize_t cdc_ncm_show_min_tx_pkt(struct device *d, struct device_attribute *attr, char *buf)
197 struct usbnet *dev = netdev_priv(to_net_dev(d));
198 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
200 return sprintf(buf, "%u\n", ctx->min_tx_pkt);
203 static ssize_t cdc_ncm_show_rx_max(struct device *d, struct device_attribute *attr, char *buf)
205 struct usbnet *dev = netdev_priv(to_net_dev(d));
206 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
208 return sprintf(buf, "%u\n", ctx->rx_max);
211 static ssize_t cdc_ncm_show_tx_max(struct device *d, struct device_attribute *attr, char *buf)
213 struct usbnet *dev = netdev_priv(to_net_dev(d));
214 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
216 return sprintf(buf, "%u\n", ctx->tx_max);
219 static ssize_t cdc_ncm_show_tx_timer_usecs(struct device *d, struct device_attribute *attr, char *buf)
221 struct usbnet *dev = netdev_priv(to_net_dev(d));
222 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
224 return sprintf(buf, "%u\n", ctx->timer_interval / (u32)NSEC_PER_USEC);
227 static ssize_t cdc_ncm_store_min_tx_pkt(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
229 struct usbnet *dev = netdev_priv(to_net_dev(d));
230 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
233 /* no need to restrict values - anything from 0 to infinity is OK */
234 if (kstrtoul(buf, 0, &val))
237 ctx->min_tx_pkt = val;
241 static ssize_t cdc_ncm_store_rx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
243 struct usbnet *dev = netdev_priv(to_net_dev(d));
244 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
247 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_rx_max(dev, val) != val)
250 cdc_ncm_update_rxtx_max(dev, val, ctx->tx_max);
254 static ssize_t cdc_ncm_store_tx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
256 struct usbnet *dev = netdev_priv(to_net_dev(d));
257 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
260 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_tx_max(dev, val) != val)
263 cdc_ncm_update_rxtx_max(dev, ctx->rx_max, val);
267 static ssize_t cdc_ncm_store_tx_timer_usecs(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
269 struct usbnet *dev = netdev_priv(to_net_dev(d));
270 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
274 ret = kstrtoul(buf, 0, &val);
277 if (val && (val < CDC_NCM_TIMER_INTERVAL_MIN || val > CDC_NCM_TIMER_INTERVAL_MAX))
280 spin_lock_bh(&ctx->mtx);
281 ctx->timer_interval = val * NSEC_PER_USEC;
282 if (!ctx->timer_interval)
283 ctx->tx_timer_pending = 0;
284 spin_unlock_bh(&ctx->mtx);
288 static DEVICE_ATTR(min_tx_pkt, 0644, cdc_ncm_show_min_tx_pkt, cdc_ncm_store_min_tx_pkt);
289 static DEVICE_ATTR(rx_max, 0644, cdc_ncm_show_rx_max, cdc_ncm_store_rx_max);
290 static DEVICE_ATTR(tx_max, 0644, cdc_ncm_show_tx_max, cdc_ncm_store_tx_max);
291 static DEVICE_ATTR(tx_timer_usecs, 0644, cdc_ncm_show_tx_timer_usecs, cdc_ncm_store_tx_timer_usecs);
293 static ssize_t ndp_to_end_show(struct device *d, struct device_attribute *attr, char *buf)
295 struct usbnet *dev = netdev_priv(to_net_dev(d));
296 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
298 return sprintf(buf, "%c\n", ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END ? 'Y' : 'N');
301 static ssize_t ndp_to_end_store(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
303 struct usbnet *dev = netdev_priv(to_net_dev(d));
304 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
307 if (strtobool(buf, &enable))
311 if (enable == (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
315 if (ctx->is_ndp16 && !ctx->delayed_ndp16) {
316 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
317 if (!ctx->delayed_ndp16)
320 if (!ctx->is_ndp16 && !ctx->delayed_ndp32) {
321 ctx->delayed_ndp32 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
322 if (!ctx->delayed_ndp32)
327 /* flush pending data before changing flag */
328 netif_tx_lock_bh(dev->net);
329 usbnet_start_xmit(NULL, dev->net);
330 spin_lock_bh(&ctx->mtx);
332 ctx->drvflags |= CDC_NCM_FLAG_NDP_TO_END;
334 ctx->drvflags &= ~CDC_NCM_FLAG_NDP_TO_END;
335 spin_unlock_bh(&ctx->mtx);
336 netif_tx_unlock_bh(dev->net);
340 static DEVICE_ATTR_RW(ndp_to_end);
342 #define NCM_PARM_ATTR(name, format, tocpu) \
343 static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
345 struct usbnet *dev = netdev_priv(to_net_dev(d)); \
346 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
347 return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name)); \
349 static DEVICE_ATTR(name, 0444, cdc_ncm_show_##name, NULL)
351 NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
352 NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
353 NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
354 NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
355 NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
356 NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
357 NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
358 NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
359 NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
360 NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
362 static struct attribute *cdc_ncm_sysfs_attrs[] = {
363 &dev_attr_min_tx_pkt.attr,
364 &dev_attr_ndp_to_end.attr,
365 &dev_attr_rx_max.attr,
366 &dev_attr_tx_max.attr,
367 &dev_attr_tx_timer_usecs.attr,
368 &dev_attr_bmNtbFormatsSupported.attr,
369 &dev_attr_dwNtbInMaxSize.attr,
370 &dev_attr_wNdpInDivisor.attr,
371 &dev_attr_wNdpInPayloadRemainder.attr,
372 &dev_attr_wNdpInAlignment.attr,
373 &dev_attr_dwNtbOutMaxSize.attr,
374 &dev_attr_wNdpOutDivisor.attr,
375 &dev_attr_wNdpOutPayloadRemainder.attr,
376 &dev_attr_wNdpOutAlignment.attr,
377 &dev_attr_wNtbOutMaxDatagrams.attr,
381 static const struct attribute_group cdc_ncm_sysfs_attr_group = {
383 .attrs = cdc_ncm_sysfs_attrs,
386 /* handle rx_max and tx_max changes */
387 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
389 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
390 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
393 val = cdc_ncm_check_rx_max(dev, new_rx);
395 /* inform device about NTB input size changes */
396 if (val != ctx->rx_max) {
397 __le32 dwNtbInMaxSize = cpu_to_le32(val);
399 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
401 /* tell device to use new size */
402 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
403 USB_TYPE_CLASS | USB_DIR_OUT
404 | USB_RECIP_INTERFACE,
405 0, iface_no, &dwNtbInMaxSize, 4) < 0)
406 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
411 /* usbnet use these values for sizing rx queues */
412 if (dev->rx_urb_size != ctx->rx_max) {
413 dev->rx_urb_size = ctx->rx_max;
414 if (netif_running(dev->net))
415 usbnet_unlink_rx_urbs(dev);
418 val = cdc_ncm_check_tx_max(dev, new_tx);
419 if (val != ctx->tx_max)
420 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
422 /* Adding a pad byte here if necessary simplifies the handling
423 * in cdc_ncm_fill_tx_frame, making tx_max always represent
424 * the real skb max size.
426 * We cannot use dev->maxpacket here because this is called from
427 * .bind which is called before usbnet sets up dev->maxpacket
429 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
430 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
433 /* we might need to flush any pending tx buffers if running */
434 if (netif_running(dev->net) && val > ctx->tx_max) {
435 netif_tx_lock_bh(dev->net);
436 usbnet_start_xmit(NULL, dev->net);
437 /* make sure tx_curr_skb is reallocated if it was empty */
438 if (ctx->tx_curr_skb) {
439 dev_kfree_skb_any(ctx->tx_curr_skb);
440 ctx->tx_curr_skb = NULL;
443 netif_tx_unlock_bh(dev->net);
448 dev->hard_mtu = ctx->tx_max;
450 /* max qlen depend on hard_mtu and rx_urb_size */
451 usbnet_update_max_qlen(dev);
453 /* never pad more than 3 full USB packets per transfer */
454 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
455 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
458 /* helpers for NCM and MBIM differences */
459 static u8 cdc_ncm_flags(struct usbnet *dev)
461 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
463 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
464 return ctx->mbim_desc->bmNetworkCapabilities;
466 return ctx->func_desc->bmNetworkCapabilities;
470 static int cdc_ncm_eth_hlen(struct usbnet *dev)
472 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
477 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
479 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
480 return CDC_MBIM_MIN_DATAGRAM_SIZE;
481 return CDC_NCM_MIN_DATAGRAM_SIZE;
484 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
486 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
488 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
489 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
491 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
492 return CDC_NCM_MAX_DATAGRAM_SIZE;
495 /* initial one-time device setup. MUST be called with the data interface
498 static int cdc_ncm_init(struct usbnet *dev)
500 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
501 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
504 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
505 USB_TYPE_CLASS | USB_DIR_IN
506 |USB_RECIP_INTERFACE,
507 0, iface_no, &ctx->ncm_parm,
508 sizeof(ctx->ncm_parm));
510 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
511 return err; /* GET_NTB_PARAMETERS is required */
515 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
516 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
517 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
518 USB_TYPE_CLASS | USB_DIR_OUT
519 | USB_RECIP_INTERFACE,
520 USB_CDC_NCM_CRC_NOT_APPENDED,
523 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
526 /* use ndp16 by default */
529 /* set NTB format, if both formats are supported.
531 * "The host shall only send this command while the NCM Data
532 * Interface is in alternate setting 0."
534 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
535 USB_CDC_NCM_NTB32_SUPPORTED) {
536 if (ctx->drvflags & CDC_NCM_FLAG_PREFER_NTB32) {
538 dev_dbg(&dev->intf->dev, "Setting NTB format to 32-bit\n");
539 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
540 USB_TYPE_CLASS | USB_DIR_OUT
541 | USB_RECIP_INTERFACE,
542 USB_CDC_NCM_NTB32_FORMAT,
546 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
547 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
548 USB_TYPE_CLASS | USB_DIR_OUT
549 | USB_RECIP_INTERFACE,
550 USB_CDC_NCM_NTB16_FORMAT,
555 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
559 /* set initial device values */
560 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
561 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
562 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
563 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
564 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
565 /* devices prior to NCM Errata shall set this field to zero */
566 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
568 dev_dbg(&dev->intf->dev,
569 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
570 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
571 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
573 /* max count of tx datagrams */
574 if ((ctx->tx_max_datagrams == 0) ||
575 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
576 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
578 /* set up maximum NDP size */
580 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
582 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp32) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe32);
584 /* initial coalescing timer interval */
585 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
590 /* set a new max datagram size */
591 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
593 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
594 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
595 __le16 max_datagram_size;
599 /* set default based on descriptors */
600 ctx->max_datagram_size = clamp_t(u32, new_size,
601 cdc_ncm_min_dgram_size(dev),
602 CDC_NCM_MAX_DATAGRAM_SIZE);
604 /* inform the device about the selected Max Datagram Size? */
605 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
608 /* read current mtu value from device */
609 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
610 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
611 0, iface_no, &max_datagram_size, sizeof(max_datagram_size));
612 if (err != sizeof(max_datagram_size)) {
613 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
617 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
620 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
621 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
622 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
623 0, iface_no, &max_datagram_size, sizeof(max_datagram_size));
625 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
628 /* set MTU to max supported by the device if necessary */
629 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
631 /* do not exceed operater preferred MTU */
632 if (ctx->mbim_extended_desc) {
633 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
634 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
635 dev->net->mtu = mbim_mtu;
639 static void cdc_ncm_fix_modulus(struct usbnet *dev)
641 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
645 * verify that the structure alignment is:
647 * - not greater than the maximum transmit length
648 * - not less than four bytes
650 val = ctx->tx_ndp_modulus;
652 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
653 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
654 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
655 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
659 * verify that the payload alignment is:
661 * - not greater than the maximum transmit length
662 * - not less than four bytes
664 val = ctx->tx_modulus;
666 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
667 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
668 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
669 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
672 /* verify the payload remainder */
673 if (ctx->tx_remainder >= ctx->tx_modulus) {
674 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
675 ctx->tx_remainder = 0;
678 /* adjust TX-remainder according to NCM specification. */
679 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
680 (ctx->tx_modulus - 1));
683 static int cdc_ncm_setup(struct usbnet *dev)
685 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
688 /* be conservative when selecting intial buffer size to
689 * increase the number of hosts this will work for
691 def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
692 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
693 def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
694 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
696 /* clamp rx_max and tx_max and inform device */
697 cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
699 /* sanitize the modulus and remainder values */
700 cdc_ncm_fix_modulus(dev);
702 /* set max datagram size */
703 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
708 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
710 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
713 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
714 e = intf->cur_altsetting->endpoint + ep;
716 /* ignore endpoints which cannot transfer data */
717 if (!usb_endpoint_maxp(&e->desc))
720 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
721 case USB_ENDPOINT_XFER_INT:
722 if (usb_endpoint_dir_in(&e->desc)) {
728 case USB_ENDPOINT_XFER_BULK:
729 if (usb_endpoint_dir_in(&e->desc)) {
743 dev->in = usb_rcvbulkpipe(dev->udev,
744 in->desc.bEndpointAddress &
745 USB_ENDPOINT_NUMBER_MASK);
746 if (out && !dev->out)
747 dev->out = usb_sndbulkpipe(dev->udev,
748 out->desc.bEndpointAddress &
749 USB_ENDPOINT_NUMBER_MASK);
752 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
757 if (ctx->tx_rem_skb != NULL) {
758 dev_kfree_skb_any(ctx->tx_rem_skb);
759 ctx->tx_rem_skb = NULL;
762 if (ctx->tx_curr_skb != NULL) {
763 dev_kfree_skb_any(ctx->tx_curr_skb);
764 ctx->tx_curr_skb = NULL;
768 kfree(ctx->delayed_ndp16);
770 kfree(ctx->delayed_ndp32);
775 /* we need to override the usbnet change_mtu ndo for two reasons:
776 * - respect the negotiated maximum datagram size
777 * - avoid unwanted changes to rx and tx buffers
779 int cdc_ncm_change_mtu(struct net_device *net, int new_mtu)
781 struct usbnet *dev = netdev_priv(net);
784 cdc_ncm_set_dgram_size(dev, new_mtu + cdc_ncm_eth_hlen(dev));
788 EXPORT_SYMBOL_GPL(cdc_ncm_change_mtu);
790 static const struct net_device_ops cdc_ncm_netdev_ops = {
791 .ndo_open = usbnet_open,
792 .ndo_stop = usbnet_stop,
793 .ndo_start_xmit = usbnet_start_xmit,
794 .ndo_tx_timeout = usbnet_tx_timeout,
795 .ndo_set_rx_mode = usbnet_set_rx_mode,
796 .ndo_get_stats64 = dev_get_tstats64,
797 .ndo_change_mtu = cdc_ncm_change_mtu,
798 .ndo_set_mac_address = eth_mac_addr,
799 .ndo_validate_addr = eth_validate_addr,
802 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
804 struct cdc_ncm_ctx *ctx;
805 struct usb_driver *driver;
810 struct usb_cdc_parsed_header hdr;
812 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
818 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
819 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
820 tasklet_setup(&ctx->bh, cdc_ncm_txpath_bh);
821 atomic_set(&ctx->stop, 0);
822 spin_lock_init(&ctx->mtx);
824 /* store ctx pointer in device data field */
825 dev->data[0] = (unsigned long)ctx;
827 /* only the control interface can be successfully probed */
830 /* get some pointers */
831 driver = driver_of(intf);
832 buf = intf->cur_altsetting->extra;
833 len = intf->cur_altsetting->extralen;
835 /* parse through descriptors associated with control interface */
836 cdc_parse_cdc_header(&hdr, intf, buf, len);
838 if (hdr.usb_cdc_union_desc)
839 ctx->data = usb_ifnum_to_if(dev->udev,
840 hdr.usb_cdc_union_desc->bSlaveInterface0);
841 ctx->ether_desc = hdr.usb_cdc_ether_desc;
842 ctx->func_desc = hdr.usb_cdc_ncm_desc;
843 ctx->mbim_desc = hdr.usb_cdc_mbim_desc;
844 ctx->mbim_extended_desc = hdr.usb_cdc_mbim_extended_desc;
846 /* some buggy devices have an IAD but no CDC Union */
847 if (!hdr.usb_cdc_union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
848 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
849 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
852 /* check if we got everything */
854 dev_err(&intf->dev, "CDC Union missing and no IAD found\n");
857 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
858 if (!ctx->mbim_desc) {
859 dev_err(&intf->dev, "MBIM functional descriptor missing\n");
863 if (!ctx->ether_desc || !ctx->func_desc) {
864 dev_err(&intf->dev, "NCM or ECM functional descriptors missing\n");
869 /* claim data interface, if different from control */
870 if (ctx->data != ctx->control) {
871 temp = usb_driver_claim_interface(driver, ctx->data, dev);
873 dev_err(&intf->dev, "failed to claim data intf\n");
878 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
880 /* Device-specific flags */
881 ctx->drvflags = drvflags;
883 /* Reset data interface. Some devices will not reset properly
884 * unless they are configured first. Toggle the altsetting to
886 * Some other devices do not work properly with this procedure
887 * that can be avoided using quirk CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE
889 if (!(ctx->drvflags & CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE))
890 usb_set_interface(dev->udev, iface_no, data_altsetting);
892 temp = usb_set_interface(dev->udev, iface_no, 0);
894 dev_dbg(&intf->dev, "set interface failed\n");
898 /* initialize basic device settings */
899 if (cdc_ncm_init(dev))
902 /* Some firmwares need a pause here or they will silently fail
903 * to set up the interface properly. This value was decided
904 * empirically on a Sierra Wireless MC7455 running 02.08.02.00
907 usleep_range(10000, 20000);
909 /* configure data interface */
910 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
912 dev_dbg(&intf->dev, "set interface failed\n");
916 cdc_ncm_find_endpoints(dev, ctx->data);
917 cdc_ncm_find_endpoints(dev, ctx->control);
918 if (!dev->in || !dev->out || !dev->status) {
919 dev_dbg(&intf->dev, "failed to collect endpoints\n");
923 usb_set_intfdata(ctx->data, dev);
924 usb_set_intfdata(ctx->control, dev);
926 if (ctx->ether_desc) {
927 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
929 dev_err(&intf->dev, "failed to get mac address\n");
932 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
935 /* finish setting up the device specific data */
938 /* Allocate the delayed NDP if needed. */
939 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
941 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
942 if (!ctx->delayed_ndp16)
945 ctx->delayed_ndp32 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
946 if (!ctx->delayed_ndp32)
949 dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
952 /* override ethtool_ops */
953 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
955 /* add our sysfs attrs */
956 dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
958 /* must handle MTU changes */
959 dev->net->netdev_ops = &cdc_ncm_netdev_ops;
960 dev->net->max_mtu = cdc_ncm_max_dgram_size(dev) - cdc_ncm_eth_hlen(dev);
965 usb_set_intfdata(ctx->control, NULL);
966 usb_set_intfdata(ctx->data, NULL);
967 if (ctx->data != ctx->control)
968 usb_driver_release_interface(driver, ctx->data);
970 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
972 dev_info(&intf->dev, "bind() failure\n");
975 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
977 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
979 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
980 struct usb_driver *driver = driver_of(intf);
983 return; /* no setup */
985 atomic_set(&ctx->stop, 1);
987 hrtimer_cancel(&ctx->tx_timer);
989 tasklet_kill(&ctx->bh);
991 /* handle devices with combined control and data interface */
992 if (ctx->control == ctx->data)
995 /* disconnect master --> disconnect slave */
996 if (intf == ctx->control && ctx->data) {
997 usb_set_intfdata(ctx->data, NULL);
998 usb_driver_release_interface(driver, ctx->data);
1001 } else if (intf == ctx->data && ctx->control) {
1002 usb_set_intfdata(ctx->control, NULL);
1003 usb_driver_release_interface(driver, ctx->control);
1004 ctx->control = NULL;
1007 usb_set_intfdata(intf, NULL);
1010 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
1012 /* Return the number of the MBIM control interface altsetting iff it
1013 * is preferred and available,
1015 u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
1017 struct usb_host_interface *alt;
1019 /* The MBIM spec defines a NCM compatible default altsetting,
1020 * which we may have matched:
1022 * "Functions that implement both NCM 1.0 and MBIM (an
1023 * “NCM/MBIM function”) according to this recommendation
1024 * shall provide two alternate settings for the
1025 * Communication Interface. Alternate setting 0, and the
1026 * associated class and endpoint descriptors, shall be
1027 * constructed according to the rules given for the
1028 * Communication Interface in section 5 of [USBNCM10].
1029 * Alternate setting 1, and the associated class and
1030 * endpoint descriptors, shall be constructed according to
1031 * the rules given in section 6 (USB Device Model) of this
1034 if (intf->num_altsetting < 2)
1035 return intf->cur_altsetting->desc.bAlternateSetting;
1038 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
1039 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
1040 return CDC_NCM_COMM_ALTSETTING_MBIM;
1042 return CDC_NCM_COMM_ALTSETTING_NCM;
1044 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
1046 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
1048 /* MBIM backwards compatible function? */
1049 if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
1052 /* The NCM data altsetting is fixed, so we hard-coded it.
1053 * Additionally, generic NCM devices are assumed to accept arbitrarily
1056 return cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM, 0);
1059 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
1061 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
1063 if (skb->len + align > max)
1064 align = max - skb->len;
1065 if (align && skb_tailroom(skb) >= align)
1066 skb_put_zero(skb, align);
1069 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
1070 * allocating a new one within skb
1072 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
1074 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
1075 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
1076 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
1078 /* If NDP should be moved to the end of the NCM package, we can't follow the
1079 * NTH16 header as we would normally do. NDP isn't written to the SKB yet, and
1080 * the wNdpIndex field in the header is actually not consistent with reality. It will be later.
1082 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1083 if (ctx->delayed_ndp16->dwSignature == sign)
1084 return ctx->delayed_ndp16;
1086 /* We can only push a single NDP to the end. Return
1087 * NULL to send what we've already got and queue this
1090 else if (ctx->delayed_ndp16->dwSignature)
1094 /* follow the chain of NDPs, looking for a match */
1096 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
1097 if (ndp16->dwSignature == sign)
1099 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1103 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1104 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_curr_size);
1106 /* verify that there is room for the NDP and the datagram (reserve) */
1107 if ((ctx->tx_curr_size - skb->len - reserve) < ctx->max_ndp_size)
1112 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
1114 nth16->wNdpIndex = cpu_to_le16(skb->len);
1116 /* push a new empty NDP */
1117 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1118 ndp16 = skb_put_zero(skb, ctx->max_ndp_size);
1120 ndp16 = ctx->delayed_ndp16;
1122 ndp16->dwSignature = sign;
1123 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
1127 static struct usb_cdc_ncm_ndp32 *cdc_ncm_ndp32(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
1129 struct usb_cdc_ncm_ndp32 *ndp32 = NULL;
1130 struct usb_cdc_ncm_nth32 *nth32 = (void *)skb->data;
1131 size_t ndpoffset = le32_to_cpu(nth32->dwNdpIndex);
1133 /* If NDP should be moved to the end of the NCM package, we can't follow the
1134 * NTH32 header as we would normally do. NDP isn't written to the SKB yet, and
1135 * the wNdpIndex field in the header is actually not consistent with reality. It will be later.
1137 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1138 if (ctx->delayed_ndp32->dwSignature == sign)
1139 return ctx->delayed_ndp32;
1141 /* We can only push a single NDP to the end. Return
1142 * NULL to send what we've already got and queue this
1145 else if (ctx->delayed_ndp32->dwSignature)
1149 /* follow the chain of NDPs, looking for a match */
1151 ndp32 = (struct usb_cdc_ncm_ndp32 *)(skb->data + ndpoffset);
1152 if (ndp32->dwSignature == sign)
1154 ndpoffset = le32_to_cpu(ndp32->dwNextNdpIndex);
1158 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1159 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_curr_size);
1161 /* verify that there is room for the NDP and the datagram (reserve) */
1162 if ((ctx->tx_curr_size - skb->len - reserve) < ctx->max_ndp_size)
1167 ndp32->dwNextNdpIndex = cpu_to_le32(skb->len);
1169 nth32->dwNdpIndex = cpu_to_le32(skb->len);
1171 /* push a new empty NDP */
1172 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1173 ndp32 = skb_put_zero(skb, ctx->max_ndp_size);
1175 ndp32 = ctx->delayed_ndp32;
1177 ndp32->dwSignature = sign;
1178 ndp32->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp32) + sizeof(struct usb_cdc_ncm_dpe32));
1183 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
1185 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1187 struct usb_cdc_ncm_nth16 *nth16;
1188 struct usb_cdc_ncm_nth32 *nth32;
1191 struct usb_cdc_ncm_ndp16 *ndp16;
1192 struct usb_cdc_ncm_ndp32 *ndp32;
1194 struct sk_buff *skb_out;
1195 u16 n = 0, index, ndplen;
1197 u32 delayed_ndp_size;
1198 size_t padding_count;
1200 /* When our NDP gets written in cdc_ncm_ndp(), then skb_out->len gets updated
1201 * accordingly. Otherwise, we should check here.
1203 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1204 delayed_ndp_size = ctx->max_ndp_size +
1206 ctx->tx_ndp_modulus,
1207 ctx->tx_modulus + ctx->tx_remainder) - 1;
1209 delayed_ndp_size = 0;
1211 /* if there is a remaining skb, it gets priority */
1213 swap(skb, ctx->tx_rem_skb);
1214 swap(sign, ctx->tx_rem_sign);
1219 /* check if we are resuming an OUT skb */
1220 skb_out = ctx->tx_curr_skb;
1222 /* allocate a new OUT skb */
1224 if (ctx->tx_low_mem_val == 0) {
1225 ctx->tx_curr_size = ctx->tx_max;
1226 skb_out = alloc_skb(ctx->tx_curr_size, GFP_ATOMIC);
1227 /* If the memory allocation fails we will wait longer
1228 * each time before attempting another full size
1229 * allocation again to not overload the system
1232 if (skb_out == NULL) {
1233 ctx->tx_low_mem_max_cnt = min(ctx->tx_low_mem_max_cnt + 1,
1234 (unsigned)CDC_NCM_LOW_MEM_MAX_CNT);
1235 ctx->tx_low_mem_val = ctx->tx_low_mem_max_cnt;
1238 if (skb_out == NULL) {
1239 /* See if a very small allocation is possible.
1240 * We will send this packet immediately and hope
1241 * that there is more memory available later.
1244 ctx->tx_curr_size = max(skb->len,
1245 (u32)USB_CDC_NCM_NTB_MIN_OUT_SIZE);
1247 ctx->tx_curr_size = USB_CDC_NCM_NTB_MIN_OUT_SIZE;
1248 skb_out = alloc_skb(ctx->tx_curr_size, GFP_ATOMIC);
1250 /* No allocation possible so we will abort */
1251 if (skb_out == NULL) {
1253 dev_kfree_skb_any(skb);
1254 dev->net->stats.tx_dropped++;
1258 ctx->tx_low_mem_val--;
1260 if (ctx->is_ndp16) {
1261 /* fill out the initial 16-bit NTB header */
1262 nth.nth16 = skb_put_zero(skb_out, sizeof(struct usb_cdc_ncm_nth16));
1263 nth.nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1264 nth.nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1265 nth.nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
1267 /* fill out the initial 32-bit NTB header */
1268 nth.nth32 = skb_put_zero(skb_out, sizeof(struct usb_cdc_ncm_nth32));
1269 nth.nth32->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH32_SIGN);
1270 nth.nth32->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth32));
1271 nth.nth32->wSequence = cpu_to_le16(ctx->tx_seq++);
1274 /* count total number of frames in this NTB */
1275 ctx->tx_curr_frame_num = 0;
1277 /* recent payload counter for this skb_out */
1278 ctx->tx_curr_frame_payload = 0;
1281 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1282 /* send any remaining skb first */
1284 skb = ctx->tx_rem_skb;
1285 sign = ctx->tx_rem_sign;
1286 ctx->tx_rem_skb = NULL;
1288 /* check for end of skb */
1293 /* get the appropriate NDP for this skb */
1295 ndp.ndp16 = cdc_ncm_ndp16(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1297 ndp.ndp32 = cdc_ncm_ndp32(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1299 /* align beginning of next frame */
1300 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_curr_size);
1302 /* check if we had enough room left for both NDP and frame */
1303 if ((ctx->is_ndp16 && !ndp.ndp16) || (!ctx->is_ndp16 && !ndp.ndp32) ||
1304 skb_out->len + skb->len + delayed_ndp_size > ctx->tx_curr_size) {
1306 /* won't fit, MTU problem? */
1307 dev_kfree_skb_any(skb);
1309 dev->net->stats.tx_dropped++;
1311 /* no room for skb - store for later */
1312 if (ctx->tx_rem_skb != NULL) {
1313 dev_kfree_skb_any(ctx->tx_rem_skb);
1314 dev->net->stats.tx_dropped++;
1316 ctx->tx_rem_skb = skb;
1317 ctx->tx_rem_sign = sign;
1320 ctx->tx_reason_ntb_full++; /* count reason for transmitting */
1325 /* calculate frame number within this NDP */
1326 if (ctx->is_ndp16) {
1327 ndplen = le16_to_cpu(ndp.ndp16->wLength);
1328 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
1330 /* OK, add this skb */
1331 ndp.ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1332 ndp.ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1333 ndp.ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
1335 ndplen = le16_to_cpu(ndp.ndp32->wLength);
1336 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp32)) / sizeof(struct usb_cdc_ncm_dpe32) - 1;
1338 ndp.ndp32->dpe32[index].dwDatagramLength = cpu_to_le32(skb->len);
1339 ndp.ndp32->dpe32[index].dwDatagramIndex = cpu_to_le32(skb_out->len);
1340 ndp.ndp32->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe32));
1342 skb_put_data(skb_out, skb->data, skb->len);
1343 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
1344 dev_kfree_skb_any(skb);
1347 /* send now if this NDP is full */
1348 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1350 ctx->tx_reason_ndp_full++; /* count reason for transmitting */
1355 /* free up any dangling skb */
1357 dev_kfree_skb_any(skb);
1359 dev->net->stats.tx_dropped++;
1362 ctx->tx_curr_frame_num = n;
1365 /* wait for more frames */
1366 /* push variables */
1367 ctx->tx_curr_skb = skb_out;
1370 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1371 /* wait for more frames */
1372 /* push variables */
1373 ctx->tx_curr_skb = skb_out;
1374 /* set the pending count */
1375 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1376 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1380 if (n == ctx->tx_max_datagrams)
1381 ctx->tx_reason_max_datagram++; /* count reason for transmitting */
1382 /* frame goes out */
1383 /* variables will be reset at next call */
1386 /* If requested, put NDP at end of frame. */
1387 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1388 if (ctx->is_ndp16) {
1389 nth.nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1390 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_curr_size - ctx->max_ndp_size);
1391 nth.nth16->wNdpIndex = cpu_to_le16(skb_out->len);
1392 skb_put_data(skb_out, ctx->delayed_ndp16, ctx->max_ndp_size);
1394 /* Zero out delayed NDP - signature checking will naturally fail. */
1395 ndp.ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1397 nth.nth32 = (struct usb_cdc_ncm_nth32 *)skb_out->data;
1398 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_curr_size - ctx->max_ndp_size);
1399 nth.nth32->dwNdpIndex = cpu_to_le32(skb_out->len);
1400 skb_put_data(skb_out, ctx->delayed_ndp32, ctx->max_ndp_size);
1402 ndp.ndp32 = memset(ctx->delayed_ndp32, 0, ctx->max_ndp_size);
1406 /* If collected data size is less or equal ctx->min_tx_pkt
1407 * bytes, we send buffers as it is. If we get more data, it
1408 * would be more efficient for USB HS mobile device with DMA
1409 * engine to receive a full size NTB, than canceling DMA
1410 * transfer and receiving a short packet.
1412 * This optimization support is pointless if we end up sending
1413 * a ZLP after full sized NTBs.
1415 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1416 skb_out->len > ctx->min_tx_pkt) {
1417 padding_count = ctx->tx_curr_size - skb_out->len;
1418 if (!WARN_ON(padding_count > ctx->tx_curr_size))
1419 skb_put_zero(skb_out, padding_count);
1420 } else if (skb_out->len < ctx->tx_curr_size &&
1421 (skb_out->len % dev->maxpacket) == 0) {
1422 skb_put_u8(skb_out, 0); /* force short packet */
1425 /* set final frame length */
1426 if (ctx->is_ndp16) {
1427 nth.nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1428 nth.nth16->wBlockLength = cpu_to_le16(skb_out->len);
1430 nth.nth32 = (struct usb_cdc_ncm_nth32 *)skb_out->data;
1431 nth.nth32->dwBlockLength = cpu_to_le32(skb_out->len);
1435 ctx->tx_curr_skb = NULL;
1437 /* keep private stats: framing overhead and number of NTBs */
1438 ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1441 /* usbnet will count all the framing overhead by default.
1442 * Adjust the stats so that the tx_bytes counter show real
1443 * payload data instead.
1445 usbnet_set_skb_tx_stats(skb_out, n,
1446 (long)ctx->tx_curr_frame_payload - skb_out->len);
1451 /* Start timer, if there is a remaining non-empty skb */
1452 if (ctx->tx_curr_skb != NULL && n > 0)
1453 cdc_ncm_tx_timeout_start(ctx);
1456 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1458 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1460 /* start timer, if not already started */
1461 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1462 hrtimer_start(&ctx->tx_timer,
1463 ctx->timer_interval,
1467 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1469 struct cdc_ncm_ctx *ctx =
1470 container_of(timer, struct cdc_ncm_ctx, tx_timer);
1472 if (!atomic_read(&ctx->stop))
1473 tasklet_schedule(&ctx->bh);
1474 return HRTIMER_NORESTART;
1477 static void cdc_ncm_txpath_bh(struct tasklet_struct *t)
1479 struct cdc_ncm_ctx *ctx = from_tasklet(ctx, t, bh);
1480 struct usbnet *dev = ctx->dev;
1482 spin_lock_bh(&ctx->mtx);
1483 if (ctx->tx_timer_pending != 0) {
1484 ctx->tx_timer_pending--;
1485 cdc_ncm_tx_timeout_start(ctx);
1486 spin_unlock_bh(&ctx->mtx);
1487 } else if (dev->net != NULL) {
1488 ctx->tx_reason_timeout++; /* count reason for transmitting */
1489 spin_unlock_bh(&ctx->mtx);
1490 netif_tx_lock_bh(dev->net);
1491 usbnet_start_xmit(NULL, dev->net);
1492 netif_tx_unlock_bh(dev->net);
1494 spin_unlock_bh(&ctx->mtx);
1499 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1501 struct sk_buff *skb_out;
1502 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1505 * The Ethernet API we are using does not support transmitting
1506 * multiple Ethernet frames in a single call. This driver will
1507 * accumulate multiple Ethernet frames and send out a larger
1508 * USB frame when the USB buffer is full or when a single jiffies
1514 spin_lock_bh(&ctx->mtx);
1517 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1519 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP32_NOCRC_SIGN));
1521 spin_unlock_bh(&ctx->mtx);
1526 dev_kfree_skb_any(skb);
1530 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1532 /* verify NTB header and return offset of first NDP, or negative error */
1533 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1535 struct usbnet *dev = netdev_priv(skb_in->dev);
1536 struct usb_cdc_ncm_nth16 *nth16;
1543 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1544 sizeof(struct usb_cdc_ncm_ndp16))) {
1545 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1549 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1551 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1552 netif_dbg(dev, rx_err, dev->net,
1553 "invalid NTH16 signature <%#010x>\n",
1554 le32_to_cpu(nth16->dwSignature));
1558 len = le16_to_cpu(nth16->wBlockLength);
1559 if (len > ctx->rx_max) {
1560 netif_dbg(dev, rx_err, dev->net,
1561 "unsupported NTB block length %u/%u\n", len,
1566 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1567 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1568 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1569 netif_dbg(dev, rx_err, dev->net,
1570 "sequence number glitch prev=%d curr=%d\n",
1571 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1573 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1575 ret = le16_to_cpu(nth16->wNdpIndex);
1579 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1581 int cdc_ncm_rx_verify_nth32(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1583 struct usbnet *dev = netdev_priv(skb_in->dev);
1584 struct usb_cdc_ncm_nth32 *nth32;
1591 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth32) +
1592 sizeof(struct usb_cdc_ncm_ndp32))) {
1593 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1597 nth32 = (struct usb_cdc_ncm_nth32 *)skb_in->data;
1599 if (nth32->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH32_SIGN)) {
1600 netif_dbg(dev, rx_err, dev->net,
1601 "invalid NTH32 signature <%#010x>\n",
1602 le32_to_cpu(nth32->dwSignature));
1606 len = le32_to_cpu(nth32->dwBlockLength);
1607 if (len > ctx->rx_max) {
1608 netif_dbg(dev, rx_err, dev->net,
1609 "unsupported NTB block length %u/%u\n", len,
1614 if ((ctx->rx_seq + 1) != le16_to_cpu(nth32->wSequence) &&
1615 (ctx->rx_seq || le16_to_cpu(nth32->wSequence)) &&
1616 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth32->wSequence))) {
1617 netif_dbg(dev, rx_err, dev->net,
1618 "sequence number glitch prev=%d curr=%d\n",
1619 ctx->rx_seq, le16_to_cpu(nth32->wSequence));
1621 ctx->rx_seq = le16_to_cpu(nth32->wSequence);
1623 ret = le32_to_cpu(nth32->dwNdpIndex);
1627 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth32);
1629 /* verify NDP header and return number of datagrams, or negative error */
1630 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1632 struct usbnet *dev = netdev_priv(skb_in->dev);
1633 struct usb_cdc_ncm_ndp16 *ndp16;
1636 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1637 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1641 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1643 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1644 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1645 le16_to_cpu(ndp16->wLength));
1649 ret = ((le16_to_cpu(ndp16->wLength) -
1650 sizeof(struct usb_cdc_ncm_ndp16)) /
1651 sizeof(struct usb_cdc_ncm_dpe16));
1652 ret--; /* we process NDP entries except for the last one */
1654 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1655 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1656 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1663 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1665 /* verify NDP header and return number of datagrams, or negative error */
1666 int cdc_ncm_rx_verify_ndp32(struct sk_buff *skb_in, int ndpoffset)
1668 struct usbnet *dev = netdev_priv(skb_in->dev);
1669 struct usb_cdc_ncm_ndp32 *ndp32;
1672 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp32)) > skb_in->len) {
1673 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1677 ndp32 = (struct usb_cdc_ncm_ndp32 *)(skb_in->data + ndpoffset);
1679 if (le16_to_cpu(ndp32->wLength) < USB_CDC_NCM_NDP32_LENGTH_MIN) {
1680 netif_dbg(dev, rx_err, dev->net, "invalid DPT32 length <%u>\n",
1681 le16_to_cpu(ndp32->wLength));
1685 ret = ((le16_to_cpu(ndp32->wLength) -
1686 sizeof(struct usb_cdc_ncm_ndp32)) /
1687 sizeof(struct usb_cdc_ncm_dpe32));
1688 ret--; /* we process NDP entries except for the last one */
1690 if ((sizeof(struct usb_cdc_ncm_ndp32) +
1691 ret * (sizeof(struct usb_cdc_ncm_dpe32))) > skb_in->len) {
1692 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1699 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp32);
1701 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1703 struct sk_buff *skb;
1704 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1710 struct usb_cdc_ncm_ndp16 *ndp16;
1711 struct usb_cdc_ncm_ndp32 *ndp32;
1714 struct usb_cdc_ncm_dpe16 *dpe16;
1715 struct usb_cdc_ncm_dpe32 *dpe32;
1719 int loopcount = 50; /* arbitrary max preventing infinite loop */
1723 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1725 ndpoffset = cdc_ncm_rx_verify_nth32(ctx, skb_in);
1731 if (ctx->is_ndp16) {
1732 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1736 ndp.ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1738 if (ndp.ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1739 netif_dbg(dev, rx_err, dev->net,
1740 "invalid DPT16 signature <%#010x>\n",
1741 le32_to_cpu(ndp.ndp16->dwSignature));
1744 dpe.dpe16 = ndp.ndp16->dpe16;
1746 nframes = cdc_ncm_rx_verify_ndp32(skb_in, ndpoffset);
1750 ndp.ndp32 = (struct usb_cdc_ncm_ndp32 *)(skb_in->data + ndpoffset);
1752 if (ndp.ndp32->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP32_NOCRC_SIGN)) {
1753 netif_dbg(dev, rx_err, dev->net,
1754 "invalid DPT32 signature <%#010x>\n",
1755 le32_to_cpu(ndp.ndp32->dwSignature));
1758 dpe.dpe32 = ndp.ndp32->dpe32;
1761 for (x = 0; x < nframes; x++) {
1762 if (ctx->is_ndp16) {
1763 offset = le16_to_cpu(dpe.dpe16->wDatagramIndex);
1764 len = le16_to_cpu(dpe.dpe16->wDatagramLength);
1766 offset = le32_to_cpu(dpe.dpe32->dwDatagramIndex);
1767 len = le32_to_cpu(dpe.dpe32->dwDatagramLength);
1772 * All entries after first NULL entry are to be ignored
1774 if ((offset == 0) || (len == 0)) {
1776 goto err_ndp; /* empty NTB */
1780 /* sanity checking */
1781 if (((offset + len) > skb_in->len) ||
1782 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1783 netif_dbg(dev, rx_err, dev->net,
1784 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1785 x, offset, len, skb_in);
1791 /* create a fresh copy to reduce truesize */
1792 skb = netdev_alloc_skb_ip_align(dev->net, len);
1795 skb_put_data(skb, skb_in->data + offset, len);
1796 usbnet_skb_return(dev, skb);
1797 payload += len; /* count payload bytes in this NTB */
1806 /* are there more NDPs to process? */
1808 ndpoffset = le16_to_cpu(ndp.ndp16->wNextNdpIndex);
1810 ndpoffset = le32_to_cpu(ndp.ndp32->dwNextNdpIndex);
1812 if (ndpoffset && loopcount--)
1816 ctx->rx_overhead += skb_in->len - payload;
1823 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1826 cdc_ncm_speed_change(struct usbnet *dev,
1827 struct usb_cdc_speed_change *data)
1829 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1830 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1832 /* if the speed hasn't changed, don't report it.
1833 * RTL8156 shipped before 2021 sends notification about every 32ms.
1835 if (dev->rx_speed == rx_speed && dev->tx_speed == tx_speed)
1838 dev->rx_speed = rx_speed;
1839 dev->tx_speed = tx_speed;
1842 * Currently the USB-NET API does not support reporting the actual
1843 * device speed. Do print it instead.
1845 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1846 netif_info(dev, link, dev->net,
1847 "%u mbit/s downlink %u mbit/s uplink\n",
1848 (unsigned int)(rx_speed / 1000000U),
1849 (unsigned int)(tx_speed / 1000000U));
1851 netif_info(dev, link, dev->net,
1852 "%u kbit/s downlink %u kbit/s uplink\n",
1853 (unsigned int)(rx_speed / 1000U),
1854 (unsigned int)(tx_speed / 1000U));
1858 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1860 struct usb_cdc_notification *event;
1862 if (urb->actual_length < sizeof(*event))
1865 /* test for split data in 8-byte chunks */
1866 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1867 cdc_ncm_speed_change(dev,
1868 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1872 event = urb->transfer_buffer;
1874 switch (event->bNotificationType) {
1875 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1877 * According to the CDC NCM specification ch.7.1
1878 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1879 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1881 if (netif_carrier_ok(dev->net) != !!event->wValue)
1882 usbnet_link_change(dev, !!event->wValue, 0);
1885 case USB_CDC_NOTIFY_SPEED_CHANGE:
1886 if (urb->actual_length < (sizeof(*event) +
1887 sizeof(struct usb_cdc_speed_change)))
1888 set_bit(EVENT_STS_SPLIT, &dev->flags);
1890 cdc_ncm_speed_change(dev,
1891 (struct usb_cdc_speed_change *)&event[1]);
1895 dev_dbg(&dev->udev->dev,
1896 "NCM: unexpected notification 0x%02x!\n",
1897 event->bNotificationType);
1902 static const struct driver_info cdc_ncm_info = {
1903 .description = "CDC NCM",
1904 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1906 .bind = cdc_ncm_bind,
1907 .unbind = cdc_ncm_unbind,
1908 .manage_power = usbnet_manage_power,
1909 .status = cdc_ncm_status,
1910 .rx_fixup = cdc_ncm_rx_fixup,
1911 .tx_fixup = cdc_ncm_tx_fixup,
1912 .set_rx_mode = usbnet_cdc_update_filter,
1915 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1916 static const struct driver_info wwan_info = {
1917 .description = "Mobile Broadband Network Device",
1918 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1919 | FLAG_LINK_INTR | FLAG_WWAN,
1920 .bind = cdc_ncm_bind,
1921 .unbind = cdc_ncm_unbind,
1922 .manage_power = usbnet_manage_power,
1923 .status = cdc_ncm_status,
1924 .rx_fixup = cdc_ncm_rx_fixup,
1925 .tx_fixup = cdc_ncm_tx_fixup,
1926 .set_rx_mode = usbnet_cdc_update_filter,
1929 /* Same as wwan_info, but with FLAG_NOARP */
1930 static const struct driver_info wwan_noarp_info = {
1931 .description = "Mobile Broadband Network Device (NO ARP)",
1932 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1933 | FLAG_LINK_INTR | FLAG_WWAN | FLAG_NOARP,
1934 .bind = cdc_ncm_bind,
1935 .unbind = cdc_ncm_unbind,
1936 .manage_power = usbnet_manage_power,
1937 .status = cdc_ncm_status,
1938 .rx_fixup = cdc_ncm_rx_fixup,
1939 .tx_fixup = cdc_ncm_tx_fixup,
1940 .set_rx_mode = usbnet_cdc_update_filter,
1943 static const struct usb_device_id cdc_devs[] = {
1944 /* Ericsson MBM devices like F5521gw */
1945 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1946 | USB_DEVICE_ID_MATCH_VENDOR,
1948 .bInterfaceClass = USB_CLASS_COMM,
1949 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1950 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1951 .driver_info = (unsigned long) &wwan_info,
1954 /* Telit LE910 V2 */
1955 { USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x0036,
1957 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1958 .driver_info = (unsigned long)&wwan_noarp_info,
1961 /* DW5812 LTE Verizon Mobile Broadband Card
1962 * Unlike DW5550 this device requires FLAG_NOARP
1964 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bb,
1966 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1967 .driver_info = (unsigned long)&wwan_noarp_info,
1970 /* DW5813 LTE AT&T Mobile Broadband Card
1971 * Unlike DW5550 this device requires FLAG_NOARP
1973 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bc,
1975 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1976 .driver_info = (unsigned long)&wwan_noarp_info,
1979 /* Dell branded MBM devices like DW5550 */
1980 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1981 | USB_DEVICE_ID_MATCH_VENDOR,
1983 .bInterfaceClass = USB_CLASS_COMM,
1984 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1985 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1986 .driver_info = (unsigned long) &wwan_info,
1989 /* Toshiba branded MBM devices */
1990 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1991 | USB_DEVICE_ID_MATCH_VENDOR,
1993 .bInterfaceClass = USB_CLASS_COMM,
1994 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1995 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1996 .driver_info = (unsigned long) &wwan_info,
1999 /* tag Huawei devices as wwan */
2000 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
2002 USB_CDC_SUBCLASS_NCM,
2003 USB_CDC_PROTO_NONE),
2004 .driver_info = (unsigned long)&wwan_info,
2007 /* Infineon(now Intel) HSPA Modem platform */
2008 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
2010 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
2011 .driver_info = (unsigned long)&wwan_noarp_info,
2014 /* u-blox TOBY-L4 */
2015 { USB_DEVICE_AND_INTERFACE_INFO(0x1546, 0x1010,
2017 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
2018 .driver_info = (unsigned long)&wwan_info,
2021 /* Generic CDC-NCM devices */
2022 { USB_INTERFACE_INFO(USB_CLASS_COMM,
2023 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
2024 .driver_info = (unsigned long)&cdc_ncm_info,
2029 MODULE_DEVICE_TABLE(usb, cdc_devs);
2031 static struct usb_driver cdc_ncm_driver = {
2033 .id_table = cdc_devs,
2034 .probe = usbnet_probe,
2035 .disconnect = usbnet_disconnect,
2036 .suspend = usbnet_suspend,
2037 .resume = usbnet_resume,
2038 .reset_resume = usbnet_resume,
2039 .supports_autosuspend = 1,
2040 .disable_hub_initiated_lpm = 1,
2043 module_usb_driver(cdc_ncm_driver);
2045 MODULE_AUTHOR("Hans Petter Selasky");
2046 MODULE_DESCRIPTION("USB CDC NCM host driver");
2047 MODULE_LICENSE("Dual BSD/GPL");