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 static int cdc_ncm_get_sset_count(struct net_device __always_unused *netdev, int sset)
96 return ARRAY_SIZE(cdc_ncm_gstrings_stats);
102 static void cdc_ncm_get_ethtool_stats(struct net_device *netdev,
103 struct ethtool_stats __always_unused *stats,
106 struct usbnet *dev = netdev_priv(netdev);
107 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
111 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
112 p = (char *)ctx + cdc_ncm_gstrings_stats[i].stat_offset;
113 data[i] = (cdc_ncm_gstrings_stats[i].sizeof_stat == sizeof(u64)) ? *(u64 *)p : *(u32 *)p;
117 static void cdc_ncm_get_strings(struct net_device __always_unused *netdev, u32 stringset, u8 *data)
124 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
125 memcpy(p, cdc_ncm_gstrings_stats[i].stat_string, ETH_GSTRING_LEN);
126 p += ETH_GSTRING_LEN;
131 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
133 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
134 .get_settings = usbnet_get_settings,
135 .set_settings = usbnet_set_settings,
136 .get_link = usbnet_get_link,
137 .nway_reset = usbnet_nway_reset,
138 .get_drvinfo = usbnet_get_drvinfo,
139 .get_msglevel = usbnet_get_msglevel,
140 .set_msglevel = usbnet_set_msglevel,
141 .get_ts_info = ethtool_op_get_ts_info,
142 .get_sset_count = cdc_ncm_get_sset_count,
143 .get_strings = cdc_ncm_get_strings,
144 .get_ethtool_stats = cdc_ncm_get_ethtool_stats,
147 static u32 cdc_ncm_check_rx_max(struct usbnet *dev, u32 new_rx)
149 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
152 /* clamp new_rx to sane values */
153 min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
154 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
156 /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
158 dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
159 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
163 val = clamp_t(u32, new_rx, min, max);
165 dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range\n", min, max);
170 static u32 cdc_ncm_check_tx_max(struct usbnet *dev, u32 new_tx)
172 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
175 /* clamp new_tx to sane values */
176 min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
177 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
179 max = CDC_NCM_NTB_MAX_SIZE_TX; /* dwNtbOutMaxSize not set */
181 /* some devices set dwNtbOutMaxSize too low for the above default */
184 val = clamp_t(u32, new_tx, min, max);
186 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range\n", min, max);
191 static ssize_t cdc_ncm_show_min_tx_pkt(struct device *d, struct device_attribute *attr, char *buf)
193 struct usbnet *dev = netdev_priv(to_net_dev(d));
194 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
196 return sprintf(buf, "%u\n", ctx->min_tx_pkt);
199 static ssize_t cdc_ncm_show_rx_max(struct device *d, struct device_attribute *attr, char *buf)
201 struct usbnet *dev = netdev_priv(to_net_dev(d));
202 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
204 return sprintf(buf, "%u\n", ctx->rx_max);
207 static ssize_t cdc_ncm_show_tx_max(struct device *d, struct device_attribute *attr, char *buf)
209 struct usbnet *dev = netdev_priv(to_net_dev(d));
210 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
212 return sprintf(buf, "%u\n", ctx->tx_max);
215 static ssize_t cdc_ncm_show_tx_timer_usecs(struct device *d, struct device_attribute *attr, char *buf)
217 struct usbnet *dev = netdev_priv(to_net_dev(d));
218 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
220 return sprintf(buf, "%u\n", ctx->timer_interval / (u32)NSEC_PER_USEC);
223 static ssize_t cdc_ncm_store_min_tx_pkt(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
225 struct usbnet *dev = netdev_priv(to_net_dev(d));
226 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
229 /* no need to restrict values - anything from 0 to infinity is OK */
230 if (kstrtoul(buf, 0, &val))
233 ctx->min_tx_pkt = val;
237 static ssize_t cdc_ncm_store_rx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
239 struct usbnet *dev = netdev_priv(to_net_dev(d));
240 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
243 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_rx_max(dev, val) != val)
246 cdc_ncm_update_rxtx_max(dev, val, ctx->tx_max);
250 static ssize_t cdc_ncm_store_tx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
252 struct usbnet *dev = netdev_priv(to_net_dev(d));
253 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
256 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_tx_max(dev, val) != val)
259 cdc_ncm_update_rxtx_max(dev, ctx->rx_max, val);
263 static ssize_t cdc_ncm_store_tx_timer_usecs(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
265 struct usbnet *dev = netdev_priv(to_net_dev(d));
266 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
270 ret = kstrtoul(buf, 0, &val);
273 if (val && (val < CDC_NCM_TIMER_INTERVAL_MIN || val > CDC_NCM_TIMER_INTERVAL_MAX))
276 spin_lock_bh(&ctx->mtx);
277 ctx->timer_interval = val * NSEC_PER_USEC;
278 if (!ctx->timer_interval)
279 ctx->tx_timer_pending = 0;
280 spin_unlock_bh(&ctx->mtx);
284 static DEVICE_ATTR(min_tx_pkt, S_IRUGO | S_IWUSR, cdc_ncm_show_min_tx_pkt, cdc_ncm_store_min_tx_pkt);
285 static DEVICE_ATTR(rx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_rx_max, cdc_ncm_store_rx_max);
286 static DEVICE_ATTR(tx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_max, cdc_ncm_store_tx_max);
287 static DEVICE_ATTR(tx_timer_usecs, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_timer_usecs, cdc_ncm_store_tx_timer_usecs);
289 static ssize_t ndp_to_end_show(struct device *d, struct device_attribute *attr, char *buf)
291 struct usbnet *dev = netdev_priv(to_net_dev(d));
292 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
294 return sprintf(buf, "%c\n", ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END ? 'Y' : 'N');
297 static ssize_t ndp_to_end_store(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
299 struct usbnet *dev = netdev_priv(to_net_dev(d));
300 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
303 if (strtobool(buf, &enable))
307 if (enable == (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
310 if (enable && !ctx->delayed_ndp16) {
311 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
312 if (!ctx->delayed_ndp16)
316 /* flush pending data before changing flag */
317 netif_tx_lock_bh(dev->net);
318 usbnet_start_xmit(NULL, dev->net);
319 spin_lock_bh(&ctx->mtx);
321 ctx->drvflags |= CDC_NCM_FLAG_NDP_TO_END;
323 ctx->drvflags &= ~CDC_NCM_FLAG_NDP_TO_END;
324 spin_unlock_bh(&ctx->mtx);
325 netif_tx_unlock_bh(dev->net);
329 static DEVICE_ATTR_RW(ndp_to_end);
331 #define NCM_PARM_ATTR(name, format, tocpu) \
332 static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
334 struct usbnet *dev = netdev_priv(to_net_dev(d)); \
335 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
336 return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name)); \
338 static DEVICE_ATTR(name, S_IRUGO, cdc_ncm_show_##name, NULL)
340 NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
341 NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
342 NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
343 NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
344 NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
345 NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
346 NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
347 NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
348 NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
349 NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
351 static struct attribute *cdc_ncm_sysfs_attrs[] = {
352 &dev_attr_min_tx_pkt.attr,
353 &dev_attr_ndp_to_end.attr,
354 &dev_attr_rx_max.attr,
355 &dev_attr_tx_max.attr,
356 &dev_attr_tx_timer_usecs.attr,
357 &dev_attr_bmNtbFormatsSupported.attr,
358 &dev_attr_dwNtbInMaxSize.attr,
359 &dev_attr_wNdpInDivisor.attr,
360 &dev_attr_wNdpInPayloadRemainder.attr,
361 &dev_attr_wNdpInAlignment.attr,
362 &dev_attr_dwNtbOutMaxSize.attr,
363 &dev_attr_wNdpOutDivisor.attr,
364 &dev_attr_wNdpOutPayloadRemainder.attr,
365 &dev_attr_wNdpOutAlignment.attr,
366 &dev_attr_wNtbOutMaxDatagrams.attr,
370 static struct attribute_group cdc_ncm_sysfs_attr_group = {
372 .attrs = cdc_ncm_sysfs_attrs,
375 /* handle rx_max and tx_max changes */
376 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
378 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
379 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
382 val = cdc_ncm_check_rx_max(dev, new_rx);
384 /* inform device about NTB input size changes */
385 if (val != ctx->rx_max) {
386 __le32 dwNtbInMaxSize = cpu_to_le32(val);
388 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
390 /* tell device to use new size */
391 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
392 USB_TYPE_CLASS | USB_DIR_OUT
393 | USB_RECIP_INTERFACE,
394 0, iface_no, &dwNtbInMaxSize, 4) < 0)
395 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
400 /* usbnet use these values for sizing rx queues */
401 if (dev->rx_urb_size != ctx->rx_max) {
402 dev->rx_urb_size = ctx->rx_max;
403 if (netif_running(dev->net))
404 usbnet_unlink_rx_urbs(dev);
407 val = cdc_ncm_check_tx_max(dev, new_tx);
408 if (val != ctx->tx_max)
409 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
411 /* Adding a pad byte here if necessary simplifies the handling
412 * in cdc_ncm_fill_tx_frame, making tx_max always represent
413 * the real skb max size.
415 * We cannot use dev->maxpacket here because this is called from
416 * .bind which is called before usbnet sets up dev->maxpacket
418 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
419 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
422 /* we might need to flush any pending tx buffers if running */
423 if (netif_running(dev->net) && val > ctx->tx_max) {
424 netif_tx_lock_bh(dev->net);
425 usbnet_start_xmit(NULL, dev->net);
426 /* make sure tx_curr_skb is reallocated if it was empty */
427 if (ctx->tx_curr_skb) {
428 dev_kfree_skb_any(ctx->tx_curr_skb);
429 ctx->tx_curr_skb = NULL;
432 netif_tx_unlock_bh(dev->net);
437 dev->hard_mtu = ctx->tx_max;
439 /* max qlen depend on hard_mtu and rx_urb_size */
440 usbnet_update_max_qlen(dev);
442 /* never pad more than 3 full USB packets per transfer */
443 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
444 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
447 /* helpers for NCM and MBIM differences */
448 static u8 cdc_ncm_flags(struct usbnet *dev)
450 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
452 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
453 return ctx->mbim_desc->bmNetworkCapabilities;
455 return ctx->func_desc->bmNetworkCapabilities;
459 static int cdc_ncm_eth_hlen(struct usbnet *dev)
461 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
466 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
468 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
469 return CDC_MBIM_MIN_DATAGRAM_SIZE;
470 return CDC_NCM_MIN_DATAGRAM_SIZE;
473 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
475 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
477 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
478 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
480 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
481 return CDC_NCM_MAX_DATAGRAM_SIZE;
484 /* initial one-time device setup. MUST be called with the data interface
487 static int cdc_ncm_init(struct usbnet *dev)
489 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
490 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
493 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
494 USB_TYPE_CLASS | USB_DIR_IN
495 |USB_RECIP_INTERFACE,
496 0, iface_no, &ctx->ncm_parm,
497 sizeof(ctx->ncm_parm));
499 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
500 return err; /* GET_NTB_PARAMETERS is required */
504 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
505 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
506 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
507 USB_TYPE_CLASS | USB_DIR_OUT
508 | USB_RECIP_INTERFACE,
509 USB_CDC_NCM_CRC_NOT_APPENDED,
512 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
515 /* set NTB format, if both formats are supported.
517 * "The host shall only send this command while the NCM Data
518 * Interface is in alternate setting 0."
520 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
521 USB_CDC_NCM_NTB32_SUPPORTED) {
522 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
523 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
524 USB_TYPE_CLASS | USB_DIR_OUT
525 | USB_RECIP_INTERFACE,
526 USB_CDC_NCM_NTB16_FORMAT,
529 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
532 /* set initial device values */
533 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
534 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
535 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
536 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
537 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
538 /* devices prior to NCM Errata shall set this field to zero */
539 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
541 dev_dbg(&dev->intf->dev,
542 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
543 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
544 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
546 /* max count of tx datagrams */
547 if ((ctx->tx_max_datagrams == 0) ||
548 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
549 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
551 /* set up maximum NDP size */
552 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
554 /* initial coalescing timer interval */
555 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
560 /* set a new max datagram size */
561 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
563 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
564 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
565 __le16 max_datagram_size;
569 /* set default based on descriptors */
570 ctx->max_datagram_size = clamp_t(u32, new_size,
571 cdc_ncm_min_dgram_size(dev),
572 CDC_NCM_MAX_DATAGRAM_SIZE);
574 /* inform the device about the selected Max Datagram Size? */
575 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
578 /* read current mtu value from device */
579 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
580 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
581 0, iface_no, &max_datagram_size, sizeof(max_datagram_size));
582 if (err != sizeof(max_datagram_size)) {
583 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
587 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
590 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
591 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
592 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
593 0, iface_no, &max_datagram_size, sizeof(max_datagram_size));
595 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
598 /* set MTU to max supported by the device if necessary */
599 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
601 /* do not exceed operater preferred MTU */
602 if (ctx->mbim_extended_desc) {
603 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
604 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
605 dev->net->mtu = mbim_mtu;
609 static void cdc_ncm_fix_modulus(struct usbnet *dev)
611 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
615 * verify that the structure alignment is:
617 * - not greater than the maximum transmit length
618 * - not less than four bytes
620 val = ctx->tx_ndp_modulus;
622 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
623 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
624 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
625 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
629 * verify that the payload alignment is:
631 * - not greater than the maximum transmit length
632 * - not less than four bytes
634 val = ctx->tx_modulus;
636 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
637 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
638 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
639 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
642 /* verify the payload remainder */
643 if (ctx->tx_remainder >= ctx->tx_modulus) {
644 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
645 ctx->tx_remainder = 0;
648 /* adjust TX-remainder according to NCM specification. */
649 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
650 (ctx->tx_modulus - 1));
653 static int cdc_ncm_setup(struct usbnet *dev)
655 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
658 /* be conservative when selecting intial buffer size to
659 * increase the number of hosts this will work for
661 def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
662 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
663 def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
664 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
666 /* clamp rx_max and tx_max and inform device */
667 cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
669 /* sanitize the modulus and remainder values */
670 cdc_ncm_fix_modulus(dev);
672 /* set max datagram size */
673 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
678 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
680 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
683 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
684 e = intf->cur_altsetting->endpoint + ep;
686 /* ignore endpoints which cannot transfer data */
687 if (!usb_endpoint_maxp(&e->desc))
690 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
691 case USB_ENDPOINT_XFER_INT:
692 if (usb_endpoint_dir_in(&e->desc)) {
698 case USB_ENDPOINT_XFER_BULK:
699 if (usb_endpoint_dir_in(&e->desc)) {
713 dev->in = usb_rcvbulkpipe(dev->udev,
714 in->desc.bEndpointAddress &
715 USB_ENDPOINT_NUMBER_MASK);
716 if (out && !dev->out)
717 dev->out = usb_sndbulkpipe(dev->udev,
718 out->desc.bEndpointAddress &
719 USB_ENDPOINT_NUMBER_MASK);
722 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
727 if (ctx->tx_rem_skb != NULL) {
728 dev_kfree_skb_any(ctx->tx_rem_skb);
729 ctx->tx_rem_skb = NULL;
732 if (ctx->tx_curr_skb != NULL) {
733 dev_kfree_skb_any(ctx->tx_curr_skb);
734 ctx->tx_curr_skb = NULL;
737 kfree(ctx->delayed_ndp16);
742 /* we need to override the usbnet change_mtu ndo for two reasons:
743 * - respect the negotiated maximum datagram size
744 * - avoid unwanted changes to rx and tx buffers
746 int cdc_ncm_change_mtu(struct net_device *net, int new_mtu)
748 struct usbnet *dev = netdev_priv(net);
749 int maxmtu = cdc_ncm_max_dgram_size(dev) - cdc_ncm_eth_hlen(dev);
751 if (new_mtu <= 0 || new_mtu > maxmtu)
755 cdc_ncm_set_dgram_size(dev, new_mtu + cdc_ncm_eth_hlen(dev));
759 EXPORT_SYMBOL_GPL(cdc_ncm_change_mtu);
761 static const struct net_device_ops cdc_ncm_netdev_ops = {
762 .ndo_open = usbnet_open,
763 .ndo_stop = usbnet_stop,
764 .ndo_start_xmit = usbnet_start_xmit,
765 .ndo_tx_timeout = usbnet_tx_timeout,
766 .ndo_change_mtu = cdc_ncm_change_mtu,
767 .ndo_set_mac_address = eth_mac_addr,
768 .ndo_validate_addr = eth_validate_addr,
771 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
773 struct cdc_ncm_ctx *ctx;
774 struct usb_driver *driver;
780 struct usb_cdc_parsed_header hdr;
781 __le16 curr_ntb_format;
783 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
787 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
788 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
789 ctx->bh.data = (unsigned long)dev;
790 ctx->bh.func = cdc_ncm_txpath_bh;
791 atomic_set(&ctx->stop, 0);
792 spin_lock_init(&ctx->mtx);
794 /* store ctx pointer in device data field */
795 dev->data[0] = (unsigned long)ctx;
797 /* only the control interface can be successfully probed */
800 /* get some pointers */
801 driver = driver_of(intf);
802 buf = intf->cur_altsetting->extra;
803 len = intf->cur_altsetting->extralen;
805 /* parse through descriptors associated with control interface */
806 cdc_parse_cdc_header(&hdr, intf, buf, len);
808 if (hdr.usb_cdc_union_desc)
809 ctx->data = usb_ifnum_to_if(dev->udev,
810 hdr.usb_cdc_union_desc->bSlaveInterface0);
811 ctx->ether_desc = hdr.usb_cdc_ether_desc;
812 ctx->func_desc = hdr.usb_cdc_ncm_desc;
813 ctx->mbim_desc = hdr.usb_cdc_mbim_desc;
814 ctx->mbim_extended_desc = hdr.usb_cdc_mbim_extended_desc;
816 /* some buggy devices have an IAD but no CDC Union */
817 if (!hdr.usb_cdc_union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
818 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
819 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
822 /* check if we got everything */
824 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
827 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
828 if (!ctx->mbim_desc) {
829 dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
833 if (!ctx->ether_desc || !ctx->func_desc) {
834 dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
839 /* claim data interface, if different from control */
840 if (ctx->data != ctx->control) {
841 temp = usb_driver_claim_interface(driver, ctx->data, dev);
843 dev_dbg(&intf->dev, "failed to claim data intf\n");
848 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
850 /* Device-specific flags */
851 ctx->drvflags = drvflags;
853 /* Reset data interface. Some devices will not reset properly
854 * unless they are configured first. Toggle the altsetting to
856 * Some other devices do not work properly with this procedure
857 * that can be avoided using quirk CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE
859 if (!(ctx->drvflags & CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE))
860 usb_set_interface(dev->udev, iface_no, data_altsetting);
862 temp = usb_set_interface(dev->udev, iface_no, 0);
864 dev_dbg(&intf->dev, "set interface failed\n");
868 /* initialize basic device settings */
869 if (cdc_ncm_init(dev))
872 /* Some firmwares need a pause here or they will silently fail
873 * to set up the interface properly. This value was decided
874 * empirically on a Sierra Wireless MC7455 running 02.08.02.00
877 usleep_range(10000, 20000);
879 /* configure data interface */
880 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
882 dev_dbg(&intf->dev, "set interface failed\n");
887 * Some Huawei devices have been observed to come out of reset in NDP32 mode.
888 * Let's check if this is the case, and set the device to NDP16 mode again if
891 if (ctx->drvflags & CDC_NCM_FLAG_RESET_NTB16) {
892 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_FORMAT,
893 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
894 0, iface_no, &curr_ntb_format, 2);
899 if (curr_ntb_format == cpu_to_le16(USB_CDC_NCM_NTB32_FORMAT)) {
900 dev_info(&intf->dev, "resetting NTB format to 16-bit");
901 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
902 USB_TYPE_CLASS | USB_DIR_OUT
903 | USB_RECIP_INTERFACE,
904 USB_CDC_NCM_NTB16_FORMAT,
912 cdc_ncm_find_endpoints(dev, ctx->data);
913 cdc_ncm_find_endpoints(dev, ctx->control);
914 if (!dev->in || !dev->out || !dev->status) {
915 dev_dbg(&intf->dev, "failed to collect endpoints\n");
919 usb_set_intfdata(ctx->data, dev);
920 usb_set_intfdata(ctx->control, dev);
922 if (ctx->ether_desc) {
923 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
925 dev_dbg(&intf->dev, "failed to get mac address\n");
928 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
931 /* finish setting up the device specific data */
934 /* Allocate the delayed NDP if needed. */
935 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
936 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
937 if (!ctx->delayed_ndp16)
939 dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
942 /* override ethtool_ops */
943 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
945 /* add our sysfs attrs */
946 dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
948 /* must handle MTU changes */
949 dev->net->netdev_ops = &cdc_ncm_netdev_ops;
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 memset(skb_put(skb, align), 0, 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_max);
1096 /* verify that there is room for the NDP and the datagram (reserve) */
1097 if ((ctx->tx_max - 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 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, 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 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
1154 if (skb_out == NULL) {
1156 dev_kfree_skb_any(skb);
1157 dev->net->stats.tx_dropped++;
1161 /* fill out the initial 16-bit NTB header */
1162 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
1163 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1164 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1165 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
1167 /* count total number of frames in this NTB */
1168 ctx->tx_curr_frame_num = 0;
1170 /* recent payload counter for this skb_out */
1171 ctx->tx_curr_frame_payload = 0;
1174 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1175 /* send any remaining skb first */
1177 skb = ctx->tx_rem_skb;
1178 sign = ctx->tx_rem_sign;
1179 ctx->tx_rem_skb = NULL;
1181 /* check for end of skb */
1186 /* get the appropriate NDP for this skb */
1187 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1189 /* align beginning of next frame */
1190 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
1192 /* check if we had enough room left for both NDP and frame */
1193 if (!ndp16 || skb_out->len + skb->len + delayed_ndp_size > ctx->tx_max) {
1195 /* won't fit, MTU problem? */
1196 dev_kfree_skb_any(skb);
1198 dev->net->stats.tx_dropped++;
1200 /* no room for skb - store for later */
1201 if (ctx->tx_rem_skb != NULL) {
1202 dev_kfree_skb_any(ctx->tx_rem_skb);
1203 dev->net->stats.tx_dropped++;
1205 ctx->tx_rem_skb = skb;
1206 ctx->tx_rem_sign = sign;
1209 ctx->tx_reason_ntb_full++; /* count reason for transmitting */
1214 /* calculate frame number withing this NDP */
1215 ndplen = le16_to_cpu(ndp16->wLength);
1216 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
1218 /* OK, add this skb */
1219 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1220 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1221 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
1222 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
1223 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
1224 dev_kfree_skb_any(skb);
1227 /* send now if this NDP is full */
1228 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1230 ctx->tx_reason_ndp_full++; /* count reason for transmitting */
1235 /* free up any dangling skb */
1237 dev_kfree_skb_any(skb);
1239 dev->net->stats.tx_dropped++;
1242 ctx->tx_curr_frame_num = n;
1245 /* wait for more frames */
1246 /* push variables */
1247 ctx->tx_curr_skb = skb_out;
1250 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1251 /* wait for more frames */
1252 /* push variables */
1253 ctx->tx_curr_skb = skb_out;
1254 /* set the pending count */
1255 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1256 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1260 if (n == ctx->tx_max_datagrams)
1261 ctx->tx_reason_max_datagram++; /* count reason for transmitting */
1262 /* frame goes out */
1263 /* variables will be reset at next call */
1266 /* If requested, put NDP at end of frame. */
1267 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1268 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1269 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_max - ctx->max_ndp_size);
1270 nth16->wNdpIndex = cpu_to_le16(skb_out->len);
1271 memcpy(skb_put(skb_out, ctx->max_ndp_size), ctx->delayed_ndp16, ctx->max_ndp_size);
1273 /* Zero out delayed NDP - signature checking will naturally fail. */
1274 ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1277 /* If collected data size is less or equal ctx->min_tx_pkt
1278 * bytes, we send buffers as it is. If we get more data, it
1279 * would be more efficient for USB HS mobile device with DMA
1280 * engine to receive a full size NTB, than canceling DMA
1281 * transfer and receiving a short packet.
1283 * This optimization support is pointless if we end up sending
1284 * a ZLP after full sized NTBs.
1286 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1287 skb_out->len > ctx->min_tx_pkt) {
1288 padding_count = ctx->tx_max - skb_out->len;
1289 if (!WARN_ON(padding_count > ctx->tx_max))
1290 memset(skb_put(skb_out, padding_count), 0, padding_count);
1291 } else if (skb_out->len < ctx->tx_max &&
1292 (skb_out->len % dev->maxpacket) == 0) {
1293 *skb_put(skb_out, 1) = 0; /* force short packet */
1296 /* set final frame length */
1297 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1298 nth16->wBlockLength = cpu_to_le16(skb_out->len);
1301 ctx->tx_curr_skb = NULL;
1303 /* keep private stats: framing overhead and number of NTBs */
1304 ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1307 /* usbnet will count all the framing overhead by default.
1308 * Adjust the stats so that the tx_bytes counter show real
1309 * payload data instead.
1311 usbnet_set_skb_tx_stats(skb_out, n,
1312 (long)ctx->tx_curr_frame_payload - skb_out->len);
1317 /* Start timer, if there is a remaining non-empty skb */
1318 if (ctx->tx_curr_skb != NULL && n > 0)
1319 cdc_ncm_tx_timeout_start(ctx);
1322 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1324 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1326 /* start timer, if not already started */
1327 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1328 hrtimer_start(&ctx->tx_timer,
1329 ktime_set(0, ctx->timer_interval),
1333 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1335 struct cdc_ncm_ctx *ctx =
1336 container_of(timer, struct cdc_ncm_ctx, tx_timer);
1338 if (!atomic_read(&ctx->stop))
1339 tasklet_schedule(&ctx->bh);
1340 return HRTIMER_NORESTART;
1343 static void cdc_ncm_txpath_bh(unsigned long param)
1345 struct usbnet *dev = (struct usbnet *)param;
1346 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1348 spin_lock_bh(&ctx->mtx);
1349 if (ctx->tx_timer_pending != 0) {
1350 ctx->tx_timer_pending--;
1351 cdc_ncm_tx_timeout_start(ctx);
1352 spin_unlock_bh(&ctx->mtx);
1353 } else if (dev->net != NULL) {
1354 ctx->tx_reason_timeout++; /* count reason for transmitting */
1355 spin_unlock_bh(&ctx->mtx);
1356 netif_tx_lock_bh(dev->net);
1357 usbnet_start_xmit(NULL, dev->net);
1358 netif_tx_unlock_bh(dev->net);
1360 spin_unlock_bh(&ctx->mtx);
1365 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1367 struct sk_buff *skb_out;
1368 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1371 * The Ethernet API we are using does not support transmitting
1372 * multiple Ethernet frames in a single call. This driver will
1373 * accumulate multiple Ethernet frames and send out a larger
1374 * USB frame when the USB buffer is full or when a single jiffies
1380 spin_lock_bh(&ctx->mtx);
1381 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1382 spin_unlock_bh(&ctx->mtx);
1387 dev_kfree_skb_any(skb);
1391 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1393 /* verify NTB header and return offset of first NDP, or negative error */
1394 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1396 struct usbnet *dev = netdev_priv(skb_in->dev);
1397 struct usb_cdc_ncm_nth16 *nth16;
1404 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1405 sizeof(struct usb_cdc_ncm_ndp16))) {
1406 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1410 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1412 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1413 netif_dbg(dev, rx_err, dev->net,
1414 "invalid NTH16 signature <%#010x>\n",
1415 le32_to_cpu(nth16->dwSignature));
1419 len = le16_to_cpu(nth16->wBlockLength);
1420 if (len > ctx->rx_max) {
1421 netif_dbg(dev, rx_err, dev->net,
1422 "unsupported NTB block length %u/%u\n", len,
1427 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1428 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1429 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1430 netif_dbg(dev, rx_err, dev->net,
1431 "sequence number glitch prev=%d curr=%d\n",
1432 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1434 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1436 ret = le16_to_cpu(nth16->wNdpIndex);
1440 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1442 /* verify NDP header and return number of datagrams, or negative error */
1443 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1445 struct usbnet *dev = netdev_priv(skb_in->dev);
1446 struct usb_cdc_ncm_ndp16 *ndp16;
1449 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1450 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1454 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1456 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1457 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1458 le16_to_cpu(ndp16->wLength));
1462 ret = ((le16_to_cpu(ndp16->wLength) -
1463 sizeof(struct usb_cdc_ncm_ndp16)) /
1464 sizeof(struct usb_cdc_ncm_dpe16));
1465 ret--; /* we process NDP entries except for the last one */
1467 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1468 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1469 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1476 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1478 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1480 struct sk_buff *skb;
1481 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1486 struct usb_cdc_ncm_ndp16 *ndp16;
1487 struct usb_cdc_ncm_dpe16 *dpe16;
1489 int loopcount = 50; /* arbitrary max preventing infinite loop */
1492 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1497 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1501 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1503 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1504 netif_dbg(dev, rx_err, dev->net,
1505 "invalid DPT16 signature <%#010x>\n",
1506 le32_to_cpu(ndp16->dwSignature));
1509 dpe16 = ndp16->dpe16;
1511 for (x = 0; x < nframes; x++, dpe16++) {
1512 offset = le16_to_cpu(dpe16->wDatagramIndex);
1513 len = le16_to_cpu(dpe16->wDatagramLength);
1517 * All entries after first NULL entry are to be ignored
1519 if ((offset == 0) || (len == 0)) {
1521 goto err_ndp; /* empty NTB */
1525 /* sanity checking */
1526 if (((offset + len) > skb_in->len) ||
1527 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1528 netif_dbg(dev, rx_err, dev->net,
1529 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1530 x, offset, len, skb_in);
1536 /* create a fresh copy to reduce truesize */
1537 skb = netdev_alloc_skb_ip_align(dev->net, len);
1540 memcpy(skb_put(skb, len), skb_in->data + offset, len);
1541 usbnet_skb_return(dev, skb);
1542 payload += len; /* count payload bytes in this NTB */
1546 /* are there more NDPs to process? */
1547 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1548 if (ndpoffset && loopcount--)
1552 ctx->rx_overhead += skb_in->len - payload;
1559 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1562 cdc_ncm_speed_change(struct usbnet *dev,
1563 struct usb_cdc_speed_change *data)
1565 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1566 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1568 /* if the speed hasn't changed, don't report it.
1569 * RTL8156 shipped before 2021 sends notification about every 32ms.
1571 if (dev->rx_speed == rx_speed && dev->tx_speed == tx_speed)
1574 dev->rx_speed = rx_speed;
1575 dev->tx_speed = tx_speed;
1578 * Currently the USB-NET API does not support reporting the actual
1579 * device speed. Do print it instead.
1581 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1582 netif_info(dev, link, dev->net,
1583 "%u mbit/s downlink %u mbit/s uplink\n",
1584 (unsigned int)(rx_speed / 1000000U),
1585 (unsigned int)(tx_speed / 1000000U));
1587 netif_info(dev, link, dev->net,
1588 "%u kbit/s downlink %u kbit/s uplink\n",
1589 (unsigned int)(rx_speed / 1000U),
1590 (unsigned int)(tx_speed / 1000U));
1594 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1596 struct cdc_ncm_ctx *ctx;
1597 struct usb_cdc_notification *event;
1599 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1601 if (urb->actual_length < sizeof(*event))
1604 /* test for split data in 8-byte chunks */
1605 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1606 cdc_ncm_speed_change(dev,
1607 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1611 event = urb->transfer_buffer;
1613 switch (event->bNotificationType) {
1614 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1616 * According to the CDC NCM specification ch.7.1
1617 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1618 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1620 if (netif_carrier_ok(dev->net) != !!event->wValue)
1621 usbnet_link_change(dev, !!event->wValue, 0);
1624 case USB_CDC_NOTIFY_SPEED_CHANGE:
1625 if (urb->actual_length < (sizeof(*event) +
1626 sizeof(struct usb_cdc_speed_change)))
1627 set_bit(EVENT_STS_SPLIT, &dev->flags);
1629 cdc_ncm_speed_change(dev,
1630 (struct usb_cdc_speed_change *)&event[1]);
1634 dev_dbg(&dev->udev->dev,
1635 "NCM: unexpected notification 0x%02x!\n",
1636 event->bNotificationType);
1641 static const struct driver_info cdc_ncm_info = {
1642 .description = "CDC NCM",
1643 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1644 | FLAG_LINK_INTR | FLAG_ETHER,
1645 .bind = cdc_ncm_bind,
1646 .unbind = cdc_ncm_unbind,
1647 .manage_power = usbnet_manage_power,
1648 .status = cdc_ncm_status,
1649 .rx_fixup = cdc_ncm_rx_fixup,
1650 .tx_fixup = cdc_ncm_tx_fixup,
1653 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1654 static const struct driver_info wwan_info = {
1655 .description = "Mobile Broadband Network Device",
1656 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1657 | FLAG_LINK_INTR | FLAG_WWAN,
1658 .bind = cdc_ncm_bind,
1659 .unbind = cdc_ncm_unbind,
1660 .manage_power = usbnet_manage_power,
1661 .status = cdc_ncm_status,
1662 .rx_fixup = cdc_ncm_rx_fixup,
1663 .tx_fixup = cdc_ncm_tx_fixup,
1666 /* Same as wwan_info, but with FLAG_NOARP */
1667 static const struct driver_info wwan_noarp_info = {
1668 .description = "Mobile Broadband Network Device (NO ARP)",
1669 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1670 | FLAG_LINK_INTR | FLAG_WWAN | FLAG_NOARP,
1671 .bind = cdc_ncm_bind,
1672 .unbind = cdc_ncm_unbind,
1673 .manage_power = usbnet_manage_power,
1674 .status = cdc_ncm_status,
1675 .rx_fixup = cdc_ncm_rx_fixup,
1676 .tx_fixup = cdc_ncm_tx_fixup,
1679 static const struct usb_device_id cdc_devs[] = {
1680 /* Ericsson MBM devices like F5521gw */
1681 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1682 | USB_DEVICE_ID_MATCH_VENDOR,
1684 .bInterfaceClass = USB_CLASS_COMM,
1685 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1686 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1687 .driver_info = (unsigned long) &wwan_info,
1690 /* Telit LE910 V2 */
1691 { USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x0036,
1693 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1694 .driver_info = (unsigned long)&wwan_noarp_info,
1697 /* DW5812 LTE Verizon Mobile Broadband Card
1698 * Unlike DW5550 this device requires FLAG_NOARP
1700 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bb,
1702 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1703 .driver_info = (unsigned long)&wwan_noarp_info,
1706 /* DW5813 LTE AT&T Mobile Broadband Card
1707 * Unlike DW5550 this device requires FLAG_NOARP
1709 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bc,
1711 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1712 .driver_info = (unsigned long)&wwan_noarp_info,
1715 /* Dell branded MBM devices like DW5550 */
1716 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1717 | USB_DEVICE_ID_MATCH_VENDOR,
1719 .bInterfaceClass = USB_CLASS_COMM,
1720 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1721 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1722 .driver_info = (unsigned long) &wwan_info,
1725 /* Toshiba branded MBM devices */
1726 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1727 | USB_DEVICE_ID_MATCH_VENDOR,
1729 .bInterfaceClass = USB_CLASS_COMM,
1730 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1731 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1732 .driver_info = (unsigned long) &wwan_info,
1735 /* tag Huawei devices as wwan */
1736 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1738 USB_CDC_SUBCLASS_NCM,
1739 USB_CDC_PROTO_NONE),
1740 .driver_info = (unsigned long)&wwan_info,
1743 /* Infineon(now Intel) HSPA Modem platform */
1744 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1746 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1747 .driver_info = (unsigned long)&wwan_noarp_info,
1750 /* Generic CDC-NCM devices */
1751 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1752 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1753 .driver_info = (unsigned long)&cdc_ncm_info,
1758 MODULE_DEVICE_TABLE(usb, cdc_devs);
1760 static struct usb_driver cdc_ncm_driver = {
1762 .id_table = cdc_devs,
1763 .probe = usbnet_probe,
1764 .disconnect = usbnet_disconnect,
1765 .suspend = usbnet_suspend,
1766 .resume = usbnet_resume,
1767 .reset_resume = usbnet_resume,
1768 .supports_autosuspend = 1,
1769 .disable_hub_initiated_lpm = 1,
1772 module_usb_driver(cdc_ncm_driver);
1774 MODULE_AUTHOR("Hans Petter Selasky");
1775 MODULE_DESCRIPTION("USB CDC NCM host driver");
1776 MODULE_LICENSE("Dual BSD/GPL");