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, S_IRUGO | S_IWUSR);
62 MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
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;
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 */
178 min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
179 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
181 max = CDC_NCM_NTB_MAX_SIZE_TX; /* dwNtbOutMaxSize not set */
183 /* some devices set dwNtbOutMaxSize too low for the above default */
186 val = clamp_t(u32, new_tx, min, max);
188 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range\n", min, max);
193 static ssize_t cdc_ncm_show_min_tx_pkt(struct device *d, struct device_attribute *attr, char *buf)
195 struct usbnet *dev = netdev_priv(to_net_dev(d));
196 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
198 return sprintf(buf, "%u\n", ctx->min_tx_pkt);
201 static ssize_t cdc_ncm_show_rx_max(struct device *d, struct device_attribute *attr, char *buf)
203 struct usbnet *dev = netdev_priv(to_net_dev(d));
204 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
206 return sprintf(buf, "%u\n", ctx->rx_max);
209 static ssize_t cdc_ncm_show_tx_max(struct device *d, struct device_attribute *attr, char *buf)
211 struct usbnet *dev = netdev_priv(to_net_dev(d));
212 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
214 return sprintf(buf, "%u\n", ctx->tx_max);
217 static ssize_t cdc_ncm_show_tx_timer_usecs(struct device *d, struct device_attribute *attr, char *buf)
219 struct usbnet *dev = netdev_priv(to_net_dev(d));
220 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
222 return sprintf(buf, "%u\n", ctx->timer_interval / (u32)NSEC_PER_USEC);
225 static ssize_t cdc_ncm_store_min_tx_pkt(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
227 struct usbnet *dev = netdev_priv(to_net_dev(d));
228 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
231 /* no need to restrict values - anything from 0 to infinity is OK */
232 if (kstrtoul(buf, 0, &val))
235 ctx->min_tx_pkt = val;
239 static ssize_t cdc_ncm_store_rx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
241 struct usbnet *dev = netdev_priv(to_net_dev(d));
242 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
245 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_rx_max(dev, val) != val)
248 cdc_ncm_update_rxtx_max(dev, val, ctx->tx_max);
252 static ssize_t cdc_ncm_store_tx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
254 struct usbnet *dev = netdev_priv(to_net_dev(d));
255 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
258 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_tx_max(dev, val) != val)
261 cdc_ncm_update_rxtx_max(dev, ctx->rx_max, val);
265 static ssize_t cdc_ncm_store_tx_timer_usecs(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
267 struct usbnet *dev = netdev_priv(to_net_dev(d));
268 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
272 ret = kstrtoul(buf, 0, &val);
275 if (val && (val < CDC_NCM_TIMER_INTERVAL_MIN || val > CDC_NCM_TIMER_INTERVAL_MAX))
278 spin_lock_bh(&ctx->mtx);
279 ctx->timer_interval = val * NSEC_PER_USEC;
280 if (!ctx->timer_interval)
281 ctx->tx_timer_pending = 0;
282 spin_unlock_bh(&ctx->mtx);
286 static DEVICE_ATTR(min_tx_pkt, S_IRUGO | S_IWUSR, cdc_ncm_show_min_tx_pkt, cdc_ncm_store_min_tx_pkt);
287 static DEVICE_ATTR(rx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_rx_max, cdc_ncm_store_rx_max);
288 static DEVICE_ATTR(tx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_max, cdc_ncm_store_tx_max);
289 static DEVICE_ATTR(tx_timer_usecs, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_timer_usecs, cdc_ncm_store_tx_timer_usecs);
291 static ssize_t ndp_to_end_show(struct device *d, struct device_attribute *attr, char *buf)
293 struct usbnet *dev = netdev_priv(to_net_dev(d));
294 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
296 return sprintf(buf, "%c\n", ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END ? 'Y' : 'N');
299 static ssize_t ndp_to_end_store(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
301 struct usbnet *dev = netdev_priv(to_net_dev(d));
302 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
305 if (strtobool(buf, &enable))
309 if (enable == (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
312 if (enable && !ctx->delayed_ndp16) {
313 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
314 if (!ctx->delayed_ndp16)
318 /* flush pending data before changing flag */
319 netif_tx_lock_bh(dev->net);
320 usbnet_start_xmit(NULL, dev->net);
321 spin_lock_bh(&ctx->mtx);
323 ctx->drvflags |= CDC_NCM_FLAG_NDP_TO_END;
325 ctx->drvflags &= ~CDC_NCM_FLAG_NDP_TO_END;
326 spin_unlock_bh(&ctx->mtx);
327 netif_tx_unlock_bh(dev->net);
331 static DEVICE_ATTR_RW(ndp_to_end);
333 #define NCM_PARM_ATTR(name, format, tocpu) \
334 static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
336 struct usbnet *dev = netdev_priv(to_net_dev(d)); \
337 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
338 return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name)); \
340 static DEVICE_ATTR(name, S_IRUGO, cdc_ncm_show_##name, NULL)
342 NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
343 NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
344 NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
345 NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
346 NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
347 NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
348 NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
349 NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
350 NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
351 NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
353 static struct attribute *cdc_ncm_sysfs_attrs[] = {
354 &dev_attr_min_tx_pkt.attr,
355 &dev_attr_ndp_to_end.attr,
356 &dev_attr_rx_max.attr,
357 &dev_attr_tx_max.attr,
358 &dev_attr_tx_timer_usecs.attr,
359 &dev_attr_bmNtbFormatsSupported.attr,
360 &dev_attr_dwNtbInMaxSize.attr,
361 &dev_attr_wNdpInDivisor.attr,
362 &dev_attr_wNdpInPayloadRemainder.attr,
363 &dev_attr_wNdpInAlignment.attr,
364 &dev_attr_dwNtbOutMaxSize.attr,
365 &dev_attr_wNdpOutDivisor.attr,
366 &dev_attr_wNdpOutPayloadRemainder.attr,
367 &dev_attr_wNdpOutAlignment.attr,
368 &dev_attr_wNtbOutMaxDatagrams.attr,
372 static const struct attribute_group cdc_ncm_sysfs_attr_group = {
374 .attrs = cdc_ncm_sysfs_attrs,
377 /* handle rx_max and tx_max changes */
378 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
380 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
381 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
384 val = cdc_ncm_check_rx_max(dev, new_rx);
386 /* inform device about NTB input size changes */
387 if (val != ctx->rx_max) {
388 __le32 dwNtbInMaxSize = cpu_to_le32(val);
390 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
392 /* tell device to use new size */
393 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
394 USB_TYPE_CLASS | USB_DIR_OUT
395 | USB_RECIP_INTERFACE,
396 0, iface_no, &dwNtbInMaxSize, 4) < 0)
397 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
402 /* usbnet use these values for sizing rx queues */
403 if (dev->rx_urb_size != ctx->rx_max) {
404 dev->rx_urb_size = ctx->rx_max;
405 if (netif_running(dev->net))
406 usbnet_unlink_rx_urbs(dev);
409 val = cdc_ncm_check_tx_max(dev, new_tx);
410 if (val != ctx->tx_max)
411 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
413 /* Adding a pad byte here if necessary simplifies the handling
414 * in cdc_ncm_fill_tx_frame, making tx_max always represent
415 * the real skb max size.
417 * We cannot use dev->maxpacket here because this is called from
418 * .bind which is called before usbnet sets up dev->maxpacket
420 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
421 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
424 /* we might need to flush any pending tx buffers if running */
425 if (netif_running(dev->net) && val > ctx->tx_max) {
426 netif_tx_lock_bh(dev->net);
427 usbnet_start_xmit(NULL, dev->net);
428 /* make sure tx_curr_skb is reallocated if it was empty */
429 if (ctx->tx_curr_skb) {
430 dev_kfree_skb_any(ctx->tx_curr_skb);
431 ctx->tx_curr_skb = NULL;
434 netif_tx_unlock_bh(dev->net);
439 dev->hard_mtu = ctx->tx_max;
441 /* max qlen depend on hard_mtu and rx_urb_size */
442 usbnet_update_max_qlen(dev);
444 /* never pad more than 3 full USB packets per transfer */
445 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
446 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
449 /* helpers for NCM and MBIM differences */
450 static u8 cdc_ncm_flags(struct usbnet *dev)
452 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
454 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
455 return ctx->mbim_desc->bmNetworkCapabilities;
457 return ctx->func_desc->bmNetworkCapabilities;
461 static int cdc_ncm_eth_hlen(struct usbnet *dev)
463 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
468 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
470 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
471 return CDC_MBIM_MIN_DATAGRAM_SIZE;
472 return CDC_NCM_MIN_DATAGRAM_SIZE;
475 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
477 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
479 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
480 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
482 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
483 return CDC_NCM_MAX_DATAGRAM_SIZE;
486 /* initial one-time device setup. MUST be called with the data interface
489 static int cdc_ncm_init(struct usbnet *dev)
491 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
492 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
495 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
496 USB_TYPE_CLASS | USB_DIR_IN
497 |USB_RECIP_INTERFACE,
498 0, iface_no, &ctx->ncm_parm,
499 sizeof(ctx->ncm_parm));
501 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
502 return err; /* GET_NTB_PARAMETERS is required */
506 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
507 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
508 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
509 USB_TYPE_CLASS | USB_DIR_OUT
510 | USB_RECIP_INTERFACE,
511 USB_CDC_NCM_CRC_NOT_APPENDED,
514 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
517 /* set NTB format, if both formats are supported.
519 * "The host shall only send this command while the NCM Data
520 * Interface is in alternate setting 0."
522 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
523 USB_CDC_NCM_NTB32_SUPPORTED) {
524 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
525 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
526 USB_TYPE_CLASS | USB_DIR_OUT
527 | USB_RECIP_INTERFACE,
528 USB_CDC_NCM_NTB16_FORMAT,
531 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
534 /* set initial device values */
535 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
536 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
537 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
538 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
539 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
540 /* devices prior to NCM Errata shall set this field to zero */
541 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
543 dev_dbg(&dev->intf->dev,
544 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
545 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
546 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
548 /* max count of tx datagrams */
549 if ((ctx->tx_max_datagrams == 0) ||
550 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
551 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
553 /* set up maximum NDP size */
554 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
556 /* initial coalescing timer interval */
557 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
562 /* set a new max datagram size */
563 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
565 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
566 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
567 __le16 max_datagram_size;
571 /* set default based on descriptors */
572 ctx->max_datagram_size = clamp_t(u32, new_size,
573 cdc_ncm_min_dgram_size(dev),
574 CDC_NCM_MAX_DATAGRAM_SIZE);
576 /* inform the device about the selected Max Datagram Size? */
577 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
580 /* read current mtu value from device */
581 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
582 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
583 0, iface_no, &max_datagram_size, sizeof(max_datagram_size));
584 if (err != sizeof(max_datagram_size)) {
585 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
589 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
592 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
593 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
594 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
595 0, iface_no, &max_datagram_size, sizeof(max_datagram_size));
597 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
600 /* set MTU to max supported by the device if necessary */
601 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
603 /* do not exceed operater preferred MTU */
604 if (ctx->mbim_extended_desc) {
605 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
606 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
607 dev->net->mtu = mbim_mtu;
611 static void cdc_ncm_fix_modulus(struct usbnet *dev)
613 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
617 * verify that the structure alignment is:
619 * - not greater than the maximum transmit length
620 * - not less than four bytes
622 val = ctx->tx_ndp_modulus;
624 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
625 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
626 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
627 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
631 * verify that the payload alignment is:
633 * - not greater than the maximum transmit length
634 * - not less than four bytes
636 val = ctx->tx_modulus;
638 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
639 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
640 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
641 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
644 /* verify the payload remainder */
645 if (ctx->tx_remainder >= ctx->tx_modulus) {
646 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
647 ctx->tx_remainder = 0;
650 /* adjust TX-remainder according to NCM specification. */
651 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
652 (ctx->tx_modulus - 1));
655 static int cdc_ncm_setup(struct usbnet *dev)
657 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
660 /* be conservative when selecting intial buffer size to
661 * increase the number of hosts this will work for
663 def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
664 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
665 def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
666 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
668 /* clamp rx_max and tx_max and inform device */
669 cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
671 /* sanitize the modulus and remainder values */
672 cdc_ncm_fix_modulus(dev);
674 /* set max datagram size */
675 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
680 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
682 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
685 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
686 e = intf->cur_altsetting->endpoint + ep;
688 /* ignore endpoints which cannot transfer data */
689 if (!usb_endpoint_maxp(&e->desc))
692 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
693 case USB_ENDPOINT_XFER_INT:
694 if (usb_endpoint_dir_in(&e->desc)) {
700 case USB_ENDPOINT_XFER_BULK:
701 if (usb_endpoint_dir_in(&e->desc)) {
715 dev->in = usb_rcvbulkpipe(dev->udev,
716 in->desc.bEndpointAddress &
717 USB_ENDPOINT_NUMBER_MASK);
718 if (out && !dev->out)
719 dev->out = usb_sndbulkpipe(dev->udev,
720 out->desc.bEndpointAddress &
721 USB_ENDPOINT_NUMBER_MASK);
724 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
729 if (ctx->tx_rem_skb != NULL) {
730 dev_kfree_skb_any(ctx->tx_rem_skb);
731 ctx->tx_rem_skb = NULL;
734 if (ctx->tx_curr_skb != NULL) {
735 dev_kfree_skb_any(ctx->tx_curr_skb);
736 ctx->tx_curr_skb = NULL;
739 kfree(ctx->delayed_ndp16);
744 /* we need to override the usbnet change_mtu ndo for two reasons:
745 * - respect the negotiated maximum datagram size
746 * - avoid unwanted changes to rx and tx buffers
748 int cdc_ncm_change_mtu(struct net_device *net, int new_mtu)
750 struct usbnet *dev = netdev_priv(net);
753 cdc_ncm_set_dgram_size(dev, new_mtu + cdc_ncm_eth_hlen(dev));
757 EXPORT_SYMBOL_GPL(cdc_ncm_change_mtu);
759 static const struct net_device_ops cdc_ncm_netdev_ops = {
760 .ndo_open = usbnet_open,
761 .ndo_stop = usbnet_stop,
762 .ndo_start_xmit = usbnet_start_xmit,
763 .ndo_tx_timeout = usbnet_tx_timeout,
764 .ndo_get_stats64 = usbnet_get_stats64,
765 .ndo_change_mtu = cdc_ncm_change_mtu,
766 .ndo_set_mac_address = eth_mac_addr,
767 .ndo_validate_addr = eth_validate_addr,
770 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
772 struct cdc_ncm_ctx *ctx;
773 struct usb_driver *driver;
779 struct usb_cdc_parsed_header hdr;
780 __le16 curr_ntb_format;
782 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
786 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
787 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
788 ctx->bh.data = (unsigned long)dev;
789 ctx->bh.func = cdc_ncm_txpath_bh;
790 atomic_set(&ctx->stop, 0);
791 spin_lock_init(&ctx->mtx);
793 /* store ctx pointer in device data field */
794 dev->data[0] = (unsigned long)ctx;
796 /* only the control interface can be successfully probed */
799 /* get some pointers */
800 driver = driver_of(intf);
801 buf = intf->cur_altsetting->extra;
802 len = intf->cur_altsetting->extralen;
804 /* parse through descriptors associated with control interface */
805 cdc_parse_cdc_header(&hdr, intf, buf, len);
807 if (hdr.usb_cdc_union_desc)
808 ctx->data = usb_ifnum_to_if(dev->udev,
809 hdr.usb_cdc_union_desc->bSlaveInterface0);
810 ctx->ether_desc = hdr.usb_cdc_ether_desc;
811 ctx->func_desc = hdr.usb_cdc_ncm_desc;
812 ctx->mbim_desc = hdr.usb_cdc_mbim_desc;
813 ctx->mbim_extended_desc = hdr.usb_cdc_mbim_extended_desc;
815 /* some buggy devices have an IAD but no CDC Union */
816 if (!hdr.usb_cdc_union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
817 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
818 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
821 /* check if we got everything */
823 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
826 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
827 if (!ctx->mbim_desc) {
828 dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
832 if (!ctx->ether_desc || !ctx->func_desc) {
833 dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
838 /* claim data interface, if different from control */
839 if (ctx->data != ctx->control) {
840 temp = usb_driver_claim_interface(driver, ctx->data, dev);
842 dev_dbg(&intf->dev, "failed to claim data intf\n");
847 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
849 /* Device-specific flags */
850 ctx->drvflags = drvflags;
852 /* Reset data interface. Some devices will not reset properly
853 * unless they are configured first. Toggle the altsetting to
855 * Some other devices do not work properly with this procedure
856 * that can be avoided using quirk CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE
858 if (!(ctx->drvflags & CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE))
859 usb_set_interface(dev->udev, iface_no, data_altsetting);
861 temp = usb_set_interface(dev->udev, iface_no, 0);
863 dev_dbg(&intf->dev, "set interface failed\n");
867 /* initialize basic device settings */
868 if (cdc_ncm_init(dev))
871 /* Some firmwares need a pause here or they will silently fail
872 * to set up the interface properly. This value was decided
873 * empirically on a Sierra Wireless MC7455 running 02.08.02.00
876 usleep_range(10000, 20000);
878 /* configure data interface */
879 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
881 dev_dbg(&intf->dev, "set interface failed\n");
886 * Some Huawei devices have been observed to come out of reset in NDP32 mode.
887 * Let's check if this is the case, and set the device to NDP16 mode again if
890 if (ctx->drvflags & CDC_NCM_FLAG_RESET_NTB16) {
891 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_FORMAT,
892 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
893 0, iface_no, &curr_ntb_format, 2);
898 if (curr_ntb_format == cpu_to_le16(USB_CDC_NCM_NTB32_FORMAT)) {
899 dev_info(&intf->dev, "resetting NTB format to 16-bit");
900 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
901 USB_TYPE_CLASS | USB_DIR_OUT
902 | USB_RECIP_INTERFACE,
903 USB_CDC_NCM_NTB16_FORMAT,
911 cdc_ncm_find_endpoints(dev, ctx->data);
912 cdc_ncm_find_endpoints(dev, ctx->control);
913 if (!dev->in || !dev->out || !dev->status) {
914 dev_dbg(&intf->dev, "failed to collect endpoints\n");
918 usb_set_intfdata(ctx->data, dev);
919 usb_set_intfdata(ctx->control, dev);
921 if (ctx->ether_desc) {
922 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
924 dev_dbg(&intf->dev, "failed to get mac address\n");
927 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
930 /* finish setting up the device specific data */
933 /* Allocate the delayed NDP if needed. */
934 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
935 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
936 if (!ctx->delayed_ndp16)
938 dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
941 /* override ethtool_ops */
942 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
944 /* add our sysfs attrs */
945 dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
947 /* must handle MTU changes */
948 dev->net->netdev_ops = &cdc_ncm_netdev_ops;
949 dev->net->max_mtu = cdc_ncm_max_dgram_size(dev) - cdc_ncm_eth_hlen(dev);
954 usb_set_intfdata(ctx->control, NULL);
955 usb_set_intfdata(ctx->data, NULL);
956 if (ctx->data != ctx->control)
957 usb_driver_release_interface(driver, ctx->data);
959 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
961 dev_info(&intf->dev, "bind() failure\n");
964 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
966 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
968 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
969 struct usb_driver *driver = driver_of(intf);
972 return; /* no setup */
974 atomic_set(&ctx->stop, 1);
976 if (hrtimer_active(&ctx->tx_timer))
977 hrtimer_cancel(&ctx->tx_timer);
979 tasklet_kill(&ctx->bh);
981 /* handle devices with combined control and data interface */
982 if (ctx->control == ctx->data)
985 /* disconnect master --> disconnect slave */
986 if (intf == ctx->control && ctx->data) {
987 usb_set_intfdata(ctx->data, NULL);
988 usb_driver_release_interface(driver, ctx->data);
991 } else if (intf == ctx->data && ctx->control) {
992 usb_set_intfdata(ctx->control, NULL);
993 usb_driver_release_interface(driver, ctx->control);
997 usb_set_intfdata(intf, NULL);
1000 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
1002 /* Return the number of the MBIM control interface altsetting iff it
1003 * is preferred and available,
1005 u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
1007 struct usb_host_interface *alt;
1009 /* The MBIM spec defines a NCM compatible default altsetting,
1010 * which we may have matched:
1012 * "Functions that implement both NCM 1.0 and MBIM (an
1013 * “NCM/MBIM function”) according to this recommendation
1014 * shall provide two alternate settings for the
1015 * Communication Interface. Alternate setting 0, and the
1016 * associated class and endpoint descriptors, shall be
1017 * constructed according to the rules given for the
1018 * Communication Interface in section 5 of [USBNCM10].
1019 * Alternate setting 1, and the associated class and
1020 * endpoint descriptors, shall be constructed according to
1021 * the rules given in section 6 (USB Device Model) of this
1024 if (intf->num_altsetting < 2)
1025 return intf->cur_altsetting->desc.bAlternateSetting;
1028 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
1029 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
1030 return CDC_NCM_COMM_ALTSETTING_MBIM;
1032 return CDC_NCM_COMM_ALTSETTING_NCM;
1034 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
1036 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
1038 /* MBIM backwards compatible function? */
1039 if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
1042 /* The NCM data altsetting is fixed, so we hard-coded it.
1043 * Additionally, generic NCM devices are assumed to accept arbitrarily
1046 return cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM, 0);
1049 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
1051 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
1053 if (skb->len + align > max)
1054 align = max - skb->len;
1055 if (align && skb_tailroom(skb) >= align)
1056 skb_put_zero(skb, align);
1059 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
1060 * allocating a new one within skb
1062 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
1064 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
1065 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
1066 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
1068 /* If NDP should be moved to the end of the NCM package, we can't follow the
1069 * NTH16 header as we would normally do. NDP isn't written to the SKB yet, and
1070 * the wNdpIndex field in the header is actually not consistent with reality. It will be later.
1072 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1073 if (ctx->delayed_ndp16->dwSignature == sign)
1074 return ctx->delayed_ndp16;
1076 /* We can only push a single NDP to the end. Return
1077 * NULL to send what we've already got and queue this
1080 else if (ctx->delayed_ndp16->dwSignature)
1084 /* follow the chain of NDPs, looking for a match */
1086 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
1087 if (ndp16->dwSignature == sign)
1089 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1093 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1094 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_curr_size);
1096 /* verify that there is room for the NDP and the datagram (reserve) */
1097 if ((ctx->tx_curr_size - skb->len - reserve) < ctx->max_ndp_size)
1102 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
1104 nth16->wNdpIndex = cpu_to_le16(skb->len);
1106 /* push a new empty NDP */
1107 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1108 ndp16 = skb_put_zero(skb, ctx->max_ndp_size);
1110 ndp16 = ctx->delayed_ndp16;
1112 ndp16->dwSignature = sign;
1113 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
1118 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
1120 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1121 struct usb_cdc_ncm_nth16 *nth16;
1122 struct usb_cdc_ncm_ndp16 *ndp16;
1123 struct sk_buff *skb_out;
1124 u16 n = 0, index, ndplen;
1126 u32 delayed_ndp_size;
1127 size_t padding_count;
1129 /* When our NDP gets written in cdc_ncm_ndp(), then skb_out->len gets updated
1130 * accordingly. Otherwise, we should check here.
1132 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1133 delayed_ndp_size = ctx->max_ndp_size +
1135 ctx->tx_ndp_modulus,
1136 ctx->tx_modulus + ctx->tx_remainder) - 1;
1138 delayed_ndp_size = 0;
1140 /* if there is a remaining skb, it gets priority */
1142 swap(skb, ctx->tx_rem_skb);
1143 swap(sign, ctx->tx_rem_sign);
1148 /* check if we are resuming an OUT skb */
1149 skb_out = ctx->tx_curr_skb;
1151 /* allocate a new OUT skb */
1153 if (ctx->tx_low_mem_val == 0) {
1154 ctx->tx_curr_size = ctx->tx_max;
1155 skb_out = alloc_skb(ctx->tx_curr_size, GFP_ATOMIC);
1156 /* If the memory allocation fails we will wait longer
1157 * each time before attempting another full size
1158 * allocation again to not overload the system
1161 if (skb_out == NULL) {
1162 ctx->tx_low_mem_max_cnt = min(ctx->tx_low_mem_max_cnt + 1,
1163 (unsigned)CDC_NCM_LOW_MEM_MAX_CNT);
1164 ctx->tx_low_mem_val = ctx->tx_low_mem_max_cnt;
1167 if (skb_out == NULL) {
1168 /* See if a very small allocation is possible.
1169 * We will send this packet immediately and hope
1170 * that there is more memory available later.
1173 ctx->tx_curr_size = max(skb->len,
1174 (u32)USB_CDC_NCM_NTB_MIN_OUT_SIZE);
1176 ctx->tx_curr_size = USB_CDC_NCM_NTB_MIN_OUT_SIZE;
1177 skb_out = alloc_skb(ctx->tx_curr_size, GFP_ATOMIC);
1179 /* No allocation possible so we will abort */
1180 if (skb_out == NULL) {
1182 dev_kfree_skb_any(skb);
1183 dev->net->stats.tx_dropped++;
1187 ctx->tx_low_mem_val--;
1189 /* fill out the initial 16-bit NTB header */
1190 nth16 = skb_put_zero(skb_out, sizeof(struct usb_cdc_ncm_nth16));
1191 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1192 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1193 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
1195 /* count total number of frames in this NTB */
1196 ctx->tx_curr_frame_num = 0;
1198 /* recent payload counter for this skb_out */
1199 ctx->tx_curr_frame_payload = 0;
1202 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1203 /* send any remaining skb first */
1205 skb = ctx->tx_rem_skb;
1206 sign = ctx->tx_rem_sign;
1207 ctx->tx_rem_skb = NULL;
1209 /* check for end of skb */
1214 /* get the appropriate NDP for this skb */
1215 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1217 /* align beginning of next frame */
1218 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_curr_size);
1220 /* check if we had enough room left for both NDP and frame */
1221 if (!ndp16 || skb_out->len + skb->len + delayed_ndp_size > ctx->tx_curr_size) {
1223 /* won't fit, MTU problem? */
1224 dev_kfree_skb_any(skb);
1226 dev->net->stats.tx_dropped++;
1228 /* no room for skb - store for later */
1229 if (ctx->tx_rem_skb != NULL) {
1230 dev_kfree_skb_any(ctx->tx_rem_skb);
1231 dev->net->stats.tx_dropped++;
1233 ctx->tx_rem_skb = skb;
1234 ctx->tx_rem_sign = sign;
1237 ctx->tx_reason_ntb_full++; /* count reason for transmitting */
1242 /* calculate frame number withing this NDP */
1243 ndplen = le16_to_cpu(ndp16->wLength);
1244 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
1246 /* OK, add this skb */
1247 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1248 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1249 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
1250 skb_put_data(skb_out, skb->data, skb->len);
1251 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
1252 dev_kfree_skb_any(skb);
1255 /* send now if this NDP is full */
1256 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1258 ctx->tx_reason_ndp_full++; /* count reason for transmitting */
1263 /* free up any dangling skb */
1265 dev_kfree_skb_any(skb);
1267 dev->net->stats.tx_dropped++;
1270 ctx->tx_curr_frame_num = n;
1273 /* wait for more frames */
1274 /* push variables */
1275 ctx->tx_curr_skb = skb_out;
1278 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1279 /* wait for more frames */
1280 /* push variables */
1281 ctx->tx_curr_skb = skb_out;
1282 /* set the pending count */
1283 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1284 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1288 if (n == ctx->tx_max_datagrams)
1289 ctx->tx_reason_max_datagram++; /* count reason for transmitting */
1290 /* frame goes out */
1291 /* variables will be reset at next call */
1294 /* If requested, put NDP at end of frame. */
1295 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1296 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1297 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_curr_size - ctx->max_ndp_size);
1298 nth16->wNdpIndex = cpu_to_le16(skb_out->len);
1299 skb_put_data(skb_out, ctx->delayed_ndp16, ctx->max_ndp_size);
1301 /* Zero out delayed NDP - signature checking will naturally fail. */
1302 ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1305 /* If collected data size is less or equal ctx->min_tx_pkt
1306 * bytes, we send buffers as it is. If we get more data, it
1307 * would be more efficient for USB HS mobile device with DMA
1308 * engine to receive a full size NTB, than canceling DMA
1309 * transfer and receiving a short packet.
1311 * This optimization support is pointless if we end up sending
1312 * a ZLP after full sized NTBs.
1314 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1315 skb_out->len > ctx->min_tx_pkt) {
1316 padding_count = ctx->tx_curr_size - skb_out->len;
1317 if (!WARN_ON(padding_count > ctx->tx_curr_size))
1318 skb_put_zero(skb_out, padding_count);
1319 } else if (skb_out->len < ctx->tx_curr_size &&
1320 (skb_out->len % dev->maxpacket) == 0) {
1321 skb_put_u8(skb_out, 0); /* force short packet */
1324 /* set final frame length */
1325 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1326 nth16->wBlockLength = cpu_to_le16(skb_out->len);
1329 ctx->tx_curr_skb = NULL;
1331 /* keep private stats: framing overhead and number of NTBs */
1332 ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1335 /* usbnet will count all the framing overhead by default.
1336 * Adjust the stats so that the tx_bytes counter show real
1337 * payload data instead.
1339 usbnet_set_skb_tx_stats(skb_out, n,
1340 (long)ctx->tx_curr_frame_payload - skb_out->len);
1345 /* Start timer, if there is a remaining non-empty skb */
1346 if (ctx->tx_curr_skb != NULL && n > 0)
1347 cdc_ncm_tx_timeout_start(ctx);
1350 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1352 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1354 /* start timer, if not already started */
1355 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1356 hrtimer_start(&ctx->tx_timer,
1357 ctx->timer_interval,
1361 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1363 struct cdc_ncm_ctx *ctx =
1364 container_of(timer, struct cdc_ncm_ctx, tx_timer);
1366 if (!atomic_read(&ctx->stop))
1367 tasklet_schedule(&ctx->bh);
1368 return HRTIMER_NORESTART;
1371 static void cdc_ncm_txpath_bh(unsigned long param)
1373 struct usbnet *dev = (struct usbnet *)param;
1374 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1376 spin_lock_bh(&ctx->mtx);
1377 if (ctx->tx_timer_pending != 0) {
1378 ctx->tx_timer_pending--;
1379 cdc_ncm_tx_timeout_start(ctx);
1380 spin_unlock_bh(&ctx->mtx);
1381 } else if (dev->net != NULL) {
1382 ctx->tx_reason_timeout++; /* count reason for transmitting */
1383 spin_unlock_bh(&ctx->mtx);
1384 netif_tx_lock_bh(dev->net);
1385 usbnet_start_xmit(NULL, dev->net);
1386 netif_tx_unlock_bh(dev->net);
1388 spin_unlock_bh(&ctx->mtx);
1393 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1395 struct sk_buff *skb_out;
1396 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1399 * The Ethernet API we are using does not support transmitting
1400 * multiple Ethernet frames in a single call. This driver will
1401 * accumulate multiple Ethernet frames and send out a larger
1402 * USB frame when the USB buffer is full or when a single jiffies
1408 spin_lock_bh(&ctx->mtx);
1409 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1410 spin_unlock_bh(&ctx->mtx);
1415 dev_kfree_skb_any(skb);
1419 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1421 /* verify NTB header and return offset of first NDP, or negative error */
1422 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1424 struct usbnet *dev = netdev_priv(skb_in->dev);
1425 struct usb_cdc_ncm_nth16 *nth16;
1432 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1433 sizeof(struct usb_cdc_ncm_ndp16))) {
1434 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1438 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1440 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1441 netif_dbg(dev, rx_err, dev->net,
1442 "invalid NTH16 signature <%#010x>\n",
1443 le32_to_cpu(nth16->dwSignature));
1447 len = le16_to_cpu(nth16->wBlockLength);
1448 if (len > ctx->rx_max) {
1449 netif_dbg(dev, rx_err, dev->net,
1450 "unsupported NTB block length %u/%u\n", len,
1455 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1456 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1457 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1458 netif_dbg(dev, rx_err, dev->net,
1459 "sequence number glitch prev=%d curr=%d\n",
1460 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1462 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1464 ret = le16_to_cpu(nth16->wNdpIndex);
1468 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1470 /* verify NDP header and return number of datagrams, or negative error */
1471 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1473 struct usbnet *dev = netdev_priv(skb_in->dev);
1474 struct usb_cdc_ncm_ndp16 *ndp16;
1477 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1478 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1482 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1484 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1485 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1486 le16_to_cpu(ndp16->wLength));
1490 ret = ((le16_to_cpu(ndp16->wLength) -
1491 sizeof(struct usb_cdc_ncm_ndp16)) /
1492 sizeof(struct usb_cdc_ncm_dpe16));
1493 ret--; /* we process NDP entries except for the last one */
1495 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1496 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1497 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1504 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1506 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1508 struct sk_buff *skb;
1509 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1514 struct usb_cdc_ncm_ndp16 *ndp16;
1515 struct usb_cdc_ncm_dpe16 *dpe16;
1517 int loopcount = 50; /* arbitrary max preventing infinite loop */
1520 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1525 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1529 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1531 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1532 netif_dbg(dev, rx_err, dev->net,
1533 "invalid DPT16 signature <%#010x>\n",
1534 le32_to_cpu(ndp16->dwSignature));
1537 dpe16 = ndp16->dpe16;
1539 for (x = 0; x < nframes; x++, dpe16++) {
1540 offset = le16_to_cpu(dpe16->wDatagramIndex);
1541 len = le16_to_cpu(dpe16->wDatagramLength);
1545 * All entries after first NULL entry are to be ignored
1547 if ((offset == 0) || (len == 0)) {
1549 goto err_ndp; /* empty NTB */
1553 /* sanity checking */
1554 if (((offset + len) > skb_in->len) ||
1555 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1556 netif_dbg(dev, rx_err, dev->net,
1557 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1558 x, offset, len, skb_in);
1564 /* create a fresh copy to reduce truesize */
1565 skb = netdev_alloc_skb_ip_align(dev->net, len);
1568 skb_put_data(skb, skb_in->data + offset, len);
1569 usbnet_skb_return(dev, skb);
1570 payload += len; /* count payload bytes in this NTB */
1574 /* are there more NDPs to process? */
1575 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1576 if (ndpoffset && loopcount--)
1580 ctx->rx_overhead += skb_in->len - payload;
1587 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1590 cdc_ncm_speed_change(struct usbnet *dev,
1591 struct usb_cdc_speed_change *data)
1593 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1594 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1596 /* if the speed hasn't changed, don't report it.
1597 * RTL8156 shipped before 2021 sends notification about every 32ms.
1599 if (dev->rx_speed == rx_speed && dev->tx_speed == tx_speed)
1602 dev->rx_speed = rx_speed;
1603 dev->tx_speed = tx_speed;
1606 * Currently the USB-NET API does not support reporting the actual
1607 * device speed. Do print it instead.
1609 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1610 netif_info(dev, link, dev->net,
1611 "%u mbit/s downlink %u mbit/s uplink\n",
1612 (unsigned int)(rx_speed / 1000000U),
1613 (unsigned int)(tx_speed / 1000000U));
1615 netif_info(dev, link, dev->net,
1616 "%u kbit/s downlink %u kbit/s uplink\n",
1617 (unsigned int)(rx_speed / 1000U),
1618 (unsigned int)(tx_speed / 1000U));
1622 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1624 struct cdc_ncm_ctx *ctx;
1625 struct usb_cdc_notification *event;
1627 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1629 if (urb->actual_length < sizeof(*event))
1632 /* test for split data in 8-byte chunks */
1633 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1634 cdc_ncm_speed_change(dev,
1635 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1639 event = urb->transfer_buffer;
1641 switch (event->bNotificationType) {
1642 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1644 * According to the CDC NCM specification ch.7.1
1645 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1646 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1648 if (netif_carrier_ok(dev->net) != !!event->wValue)
1649 usbnet_link_change(dev, !!event->wValue, 0);
1652 case USB_CDC_NOTIFY_SPEED_CHANGE:
1653 if (urb->actual_length < (sizeof(*event) +
1654 sizeof(struct usb_cdc_speed_change)))
1655 set_bit(EVENT_STS_SPLIT, &dev->flags);
1657 cdc_ncm_speed_change(dev,
1658 (struct usb_cdc_speed_change *)&event[1]);
1662 dev_dbg(&dev->udev->dev,
1663 "NCM: unexpected notification 0x%02x!\n",
1664 event->bNotificationType);
1669 static const struct driver_info cdc_ncm_info = {
1670 .description = "CDC NCM",
1671 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1672 | FLAG_LINK_INTR | FLAG_ETHER,
1673 .bind = cdc_ncm_bind,
1674 .unbind = cdc_ncm_unbind,
1675 .manage_power = usbnet_manage_power,
1676 .status = cdc_ncm_status,
1677 .rx_fixup = cdc_ncm_rx_fixup,
1678 .tx_fixup = cdc_ncm_tx_fixup,
1681 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1682 static const struct driver_info wwan_info = {
1683 .description = "Mobile Broadband Network Device",
1684 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1685 | FLAG_LINK_INTR | FLAG_WWAN,
1686 .bind = cdc_ncm_bind,
1687 .unbind = cdc_ncm_unbind,
1688 .manage_power = usbnet_manage_power,
1689 .status = cdc_ncm_status,
1690 .rx_fixup = cdc_ncm_rx_fixup,
1691 .tx_fixup = cdc_ncm_tx_fixup,
1694 /* Same as wwan_info, but with FLAG_NOARP */
1695 static const struct driver_info wwan_noarp_info = {
1696 .description = "Mobile Broadband Network Device (NO ARP)",
1697 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1698 | FLAG_LINK_INTR | FLAG_WWAN | FLAG_NOARP,
1699 .bind = cdc_ncm_bind,
1700 .unbind = cdc_ncm_unbind,
1701 .manage_power = usbnet_manage_power,
1702 .status = cdc_ncm_status,
1703 .rx_fixup = cdc_ncm_rx_fixup,
1704 .tx_fixup = cdc_ncm_tx_fixup,
1707 static const struct usb_device_id cdc_devs[] = {
1708 /* Ericsson MBM devices like F5521gw */
1709 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1710 | USB_DEVICE_ID_MATCH_VENDOR,
1712 .bInterfaceClass = USB_CLASS_COMM,
1713 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1714 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1715 .driver_info = (unsigned long) &wwan_info,
1718 /* Telit LE910 V2 */
1719 { USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x0036,
1721 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1722 .driver_info = (unsigned long)&wwan_noarp_info,
1725 /* DW5812 LTE Verizon Mobile Broadband Card
1726 * Unlike DW5550 this device requires FLAG_NOARP
1728 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bb,
1730 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1731 .driver_info = (unsigned long)&wwan_noarp_info,
1734 /* DW5813 LTE AT&T Mobile Broadband Card
1735 * Unlike DW5550 this device requires FLAG_NOARP
1737 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bc,
1739 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1740 .driver_info = (unsigned long)&wwan_noarp_info,
1743 /* Dell branded MBM devices like DW5550 */
1744 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1745 | USB_DEVICE_ID_MATCH_VENDOR,
1747 .bInterfaceClass = USB_CLASS_COMM,
1748 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1749 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1750 .driver_info = (unsigned long) &wwan_info,
1753 /* Toshiba branded MBM devices */
1754 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1755 | USB_DEVICE_ID_MATCH_VENDOR,
1757 .bInterfaceClass = USB_CLASS_COMM,
1758 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1759 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1760 .driver_info = (unsigned long) &wwan_info,
1763 /* tag Huawei devices as wwan */
1764 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1766 USB_CDC_SUBCLASS_NCM,
1767 USB_CDC_PROTO_NONE),
1768 .driver_info = (unsigned long)&wwan_info,
1771 /* Infineon(now Intel) HSPA Modem platform */
1772 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1774 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1775 .driver_info = (unsigned long)&wwan_noarp_info,
1778 /* u-blox TOBY-L4 */
1779 { USB_DEVICE_AND_INTERFACE_INFO(0x1546, 0x1010,
1781 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1782 .driver_info = (unsigned long)&wwan_info,
1785 /* Generic CDC-NCM devices */
1786 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1787 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1788 .driver_info = (unsigned long)&cdc_ncm_info,
1793 MODULE_DEVICE_TABLE(usb, cdc_devs);
1795 static struct usb_driver cdc_ncm_driver = {
1797 .id_table = cdc_devs,
1798 .probe = usbnet_probe,
1799 .disconnect = usbnet_disconnect,
1800 .suspend = usbnet_suspend,
1801 .resume = usbnet_resume,
1802 .reset_resume = usbnet_resume,
1803 .supports_autosuspend = 1,
1804 .disable_hub_initiated_lpm = 1,
1807 module_usb_driver(cdc_ncm_driver);
1809 MODULE_AUTHOR("Hans Petter Selasky");
1810 MODULE_DESCRIPTION("USB CDC NCM host driver");
1811 MODULE_LICENSE("Dual BSD/GPL");