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 /* some devices set dwNtbOutMaxSize too low for the above default */
182 val = clamp_t(u32, new_tx, min, max);
184 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range\n", min, max);
189 static ssize_t cdc_ncm_show_min_tx_pkt(struct device *d, struct device_attribute *attr, char *buf)
191 struct usbnet *dev = netdev_priv(to_net_dev(d));
192 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
194 return sprintf(buf, "%u\n", ctx->min_tx_pkt);
197 static ssize_t cdc_ncm_show_rx_max(struct device *d, struct device_attribute *attr, char *buf)
199 struct usbnet *dev = netdev_priv(to_net_dev(d));
200 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
202 return sprintf(buf, "%u\n", ctx->rx_max);
205 static ssize_t cdc_ncm_show_tx_max(struct device *d, struct device_attribute *attr, char *buf)
207 struct usbnet *dev = netdev_priv(to_net_dev(d));
208 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
210 return sprintf(buf, "%u\n", ctx->tx_max);
213 static ssize_t cdc_ncm_show_tx_timer_usecs(struct device *d, struct device_attribute *attr, char *buf)
215 struct usbnet *dev = netdev_priv(to_net_dev(d));
216 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
218 return sprintf(buf, "%u\n", ctx->timer_interval / (u32)NSEC_PER_USEC);
221 static ssize_t cdc_ncm_store_min_tx_pkt(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
223 struct usbnet *dev = netdev_priv(to_net_dev(d));
224 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
227 /* no need to restrict values - anything from 0 to infinity is OK */
228 if (kstrtoul(buf, 0, &val))
231 ctx->min_tx_pkt = val;
235 static ssize_t cdc_ncm_store_rx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
237 struct usbnet *dev = netdev_priv(to_net_dev(d));
238 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
241 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_rx_max(dev, val) != val)
244 cdc_ncm_update_rxtx_max(dev, val, ctx->tx_max);
248 static ssize_t cdc_ncm_store_tx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
250 struct usbnet *dev = netdev_priv(to_net_dev(d));
251 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
254 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_tx_max(dev, val) != val)
257 cdc_ncm_update_rxtx_max(dev, ctx->rx_max, val);
261 static ssize_t cdc_ncm_store_tx_timer_usecs(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
263 struct usbnet *dev = netdev_priv(to_net_dev(d));
264 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
268 ret = kstrtoul(buf, 0, &val);
271 if (val && (val < CDC_NCM_TIMER_INTERVAL_MIN || val > CDC_NCM_TIMER_INTERVAL_MAX))
274 spin_lock_bh(&ctx->mtx);
275 ctx->timer_interval = val * NSEC_PER_USEC;
276 if (!ctx->timer_interval)
277 ctx->tx_timer_pending = 0;
278 spin_unlock_bh(&ctx->mtx);
282 static DEVICE_ATTR(min_tx_pkt, S_IRUGO | S_IWUSR, cdc_ncm_show_min_tx_pkt, cdc_ncm_store_min_tx_pkt);
283 static DEVICE_ATTR(rx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_rx_max, cdc_ncm_store_rx_max);
284 static DEVICE_ATTR(tx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_max, cdc_ncm_store_tx_max);
285 static DEVICE_ATTR(tx_timer_usecs, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_timer_usecs, cdc_ncm_store_tx_timer_usecs);
287 #define NCM_PARM_ATTR(name, format, tocpu) \
288 static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
290 struct usbnet *dev = netdev_priv(to_net_dev(d)); \
291 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
292 return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name)); \
294 static DEVICE_ATTR(name, S_IRUGO, cdc_ncm_show_##name, NULL)
296 NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
297 NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
298 NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
299 NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
300 NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
301 NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
302 NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
303 NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
304 NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
305 NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
307 static struct attribute *cdc_ncm_sysfs_attrs[] = {
308 &dev_attr_min_tx_pkt.attr,
309 &dev_attr_rx_max.attr,
310 &dev_attr_tx_max.attr,
311 &dev_attr_tx_timer_usecs.attr,
312 &dev_attr_bmNtbFormatsSupported.attr,
313 &dev_attr_dwNtbInMaxSize.attr,
314 &dev_attr_wNdpInDivisor.attr,
315 &dev_attr_wNdpInPayloadRemainder.attr,
316 &dev_attr_wNdpInAlignment.attr,
317 &dev_attr_dwNtbOutMaxSize.attr,
318 &dev_attr_wNdpOutDivisor.attr,
319 &dev_attr_wNdpOutPayloadRemainder.attr,
320 &dev_attr_wNdpOutAlignment.attr,
321 &dev_attr_wNtbOutMaxDatagrams.attr,
325 static struct attribute_group cdc_ncm_sysfs_attr_group = {
327 .attrs = cdc_ncm_sysfs_attrs,
330 /* handle rx_max and tx_max changes */
331 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
333 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
334 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
337 val = cdc_ncm_check_rx_max(dev, new_rx);
339 /* inform device about NTB input size changes */
340 if (val != ctx->rx_max) {
341 __le32 dwNtbInMaxSize = cpu_to_le32(val);
343 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
345 /* tell device to use new size */
346 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
347 USB_TYPE_CLASS | USB_DIR_OUT
348 | USB_RECIP_INTERFACE,
349 0, iface_no, &dwNtbInMaxSize, 4) < 0)
350 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
355 /* usbnet use these values for sizing rx queues */
356 if (dev->rx_urb_size != ctx->rx_max) {
357 dev->rx_urb_size = ctx->rx_max;
358 if (netif_running(dev->net))
359 usbnet_unlink_rx_urbs(dev);
362 val = cdc_ncm_check_tx_max(dev, new_tx);
363 if (val != ctx->tx_max)
364 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
366 /* Adding a pad byte here if necessary simplifies the handling
367 * in cdc_ncm_fill_tx_frame, making tx_max always represent
368 * the real skb max size.
370 * We cannot use dev->maxpacket here because this is called from
371 * .bind which is called before usbnet sets up dev->maxpacket
373 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
374 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
377 /* we might need to flush any pending tx buffers if running */
378 if (netif_running(dev->net) && val > ctx->tx_max) {
379 netif_tx_lock_bh(dev->net);
380 usbnet_start_xmit(NULL, dev->net);
381 /* make sure tx_curr_skb is reallocated if it was empty */
382 if (ctx->tx_curr_skb) {
383 dev_kfree_skb_any(ctx->tx_curr_skb);
384 ctx->tx_curr_skb = NULL;
387 netif_tx_unlock_bh(dev->net);
392 dev->hard_mtu = ctx->tx_max;
394 /* max qlen depend on hard_mtu and rx_urb_size */
395 usbnet_update_max_qlen(dev);
397 /* never pad more than 3 full USB packets per transfer */
398 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
399 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
402 /* helpers for NCM and MBIM differences */
403 static u8 cdc_ncm_flags(struct usbnet *dev)
405 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
407 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
408 return ctx->mbim_desc->bmNetworkCapabilities;
410 return ctx->func_desc->bmNetworkCapabilities;
414 static int cdc_ncm_eth_hlen(struct usbnet *dev)
416 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
421 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
423 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
424 return CDC_MBIM_MIN_DATAGRAM_SIZE;
425 return CDC_NCM_MIN_DATAGRAM_SIZE;
428 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
430 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
432 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
433 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
435 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
436 return CDC_NCM_MAX_DATAGRAM_SIZE;
439 /* initial one-time device setup. MUST be called with the data interface
442 static int cdc_ncm_init(struct usbnet *dev)
444 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
445 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
448 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
449 USB_TYPE_CLASS | USB_DIR_IN
450 |USB_RECIP_INTERFACE,
451 0, iface_no, &ctx->ncm_parm,
452 sizeof(ctx->ncm_parm));
454 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
455 return err; /* GET_NTB_PARAMETERS is required */
459 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
460 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
461 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
462 USB_TYPE_CLASS | USB_DIR_OUT
463 | USB_RECIP_INTERFACE,
464 USB_CDC_NCM_CRC_NOT_APPENDED,
467 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
470 /* set NTB format, if both formats are supported.
472 * "The host shall only send this command while the NCM Data
473 * Interface is in alternate setting 0."
475 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
476 USB_CDC_NCM_NTB32_SUPPORTED) {
477 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
478 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
479 USB_TYPE_CLASS | USB_DIR_OUT
480 | USB_RECIP_INTERFACE,
481 USB_CDC_NCM_NTB16_FORMAT,
484 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
487 /* set initial device values */
488 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
489 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
490 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
491 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
492 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
493 /* devices prior to NCM Errata shall set this field to zero */
494 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
496 dev_dbg(&dev->intf->dev,
497 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
498 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
499 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
501 /* max count of tx datagrams */
502 if ((ctx->tx_max_datagrams == 0) ||
503 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
504 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
506 /* set up maximum NDP size */
507 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
509 /* initial coalescing timer interval */
510 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
515 /* set a new max datagram size */
516 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
518 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
519 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
520 __le16 max_datagram_size;
524 /* set default based on descriptors */
525 ctx->max_datagram_size = clamp_t(u32, new_size,
526 cdc_ncm_min_dgram_size(dev),
527 CDC_NCM_MAX_DATAGRAM_SIZE);
529 /* inform the device about the selected Max Datagram Size? */
530 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
533 /* read current mtu value from device */
534 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
535 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
536 0, iface_no, &max_datagram_size, sizeof(max_datagram_size));
537 if (err != sizeof(max_datagram_size)) {
538 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
542 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
545 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
546 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
547 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
548 0, iface_no, &max_datagram_size, sizeof(max_datagram_size));
550 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
553 /* set MTU to max supported by the device if necessary */
554 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
556 /* do not exceed operater preferred MTU */
557 if (ctx->mbim_extended_desc) {
558 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
559 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
560 dev->net->mtu = mbim_mtu;
564 static void cdc_ncm_fix_modulus(struct usbnet *dev)
566 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
570 * verify that the structure alignment is:
572 * - not greater than the maximum transmit length
573 * - not less than four bytes
575 val = ctx->tx_ndp_modulus;
577 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
578 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
579 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
580 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
584 * verify that the payload alignment is:
586 * - not greater than the maximum transmit length
587 * - not less than four bytes
589 val = ctx->tx_modulus;
591 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
592 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
593 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
594 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
597 /* verify the payload remainder */
598 if (ctx->tx_remainder >= ctx->tx_modulus) {
599 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
600 ctx->tx_remainder = 0;
603 /* adjust TX-remainder according to NCM specification. */
604 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
605 (ctx->tx_modulus - 1));
608 static int cdc_ncm_setup(struct usbnet *dev)
610 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
613 /* be conservative when selecting intial buffer size to
614 * increase the number of hosts this will work for
616 def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
617 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
618 def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
619 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
621 /* clamp rx_max and tx_max and inform device */
622 cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
624 /* sanitize the modulus and remainder values */
625 cdc_ncm_fix_modulus(dev);
627 /* set max datagram size */
628 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
633 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
635 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
638 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
639 e = intf->cur_altsetting->endpoint + ep;
641 /* ignore endpoints which cannot transfer data */
642 if (!usb_endpoint_maxp(&e->desc))
645 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
646 case USB_ENDPOINT_XFER_INT:
647 if (usb_endpoint_dir_in(&e->desc)) {
653 case USB_ENDPOINT_XFER_BULK:
654 if (usb_endpoint_dir_in(&e->desc)) {
668 dev->in = usb_rcvbulkpipe(dev->udev,
669 in->desc.bEndpointAddress &
670 USB_ENDPOINT_NUMBER_MASK);
671 if (out && !dev->out)
672 dev->out = usb_sndbulkpipe(dev->udev,
673 out->desc.bEndpointAddress &
674 USB_ENDPOINT_NUMBER_MASK);
677 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
682 if (ctx->tx_rem_skb != NULL) {
683 dev_kfree_skb_any(ctx->tx_rem_skb);
684 ctx->tx_rem_skb = NULL;
687 if (ctx->tx_curr_skb != NULL) {
688 dev_kfree_skb_any(ctx->tx_curr_skb);
689 ctx->tx_curr_skb = NULL;
692 kfree(ctx->delayed_ndp16);
697 /* we need to override the usbnet change_mtu ndo for two reasons:
698 * - respect the negotiated maximum datagram size
699 * - avoid unwanted changes to rx and tx buffers
701 int cdc_ncm_change_mtu(struct net_device *net, int new_mtu)
703 struct usbnet *dev = netdev_priv(net);
704 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
705 int maxmtu = ctx->max_datagram_size - cdc_ncm_eth_hlen(dev);
707 if (new_mtu <= 0 || new_mtu > maxmtu)
712 EXPORT_SYMBOL_GPL(cdc_ncm_change_mtu);
714 static const struct net_device_ops cdc_ncm_netdev_ops = {
715 .ndo_open = usbnet_open,
716 .ndo_stop = usbnet_stop,
717 .ndo_start_xmit = usbnet_start_xmit,
718 .ndo_tx_timeout = usbnet_tx_timeout,
719 .ndo_change_mtu = cdc_ncm_change_mtu,
720 .ndo_set_mac_address = eth_mac_addr,
721 .ndo_validate_addr = eth_validate_addr,
724 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
726 struct cdc_ncm_ctx *ctx;
727 struct usb_driver *driver;
733 struct usb_cdc_parsed_header hdr;
734 __le16 curr_ntb_format;
736 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
740 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
741 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
742 ctx->bh.data = (unsigned long)dev;
743 ctx->bh.func = cdc_ncm_txpath_bh;
744 atomic_set(&ctx->stop, 0);
745 spin_lock_init(&ctx->mtx);
747 /* store ctx pointer in device data field */
748 dev->data[0] = (unsigned long)ctx;
750 /* only the control interface can be successfully probed */
753 /* get some pointers */
754 driver = driver_of(intf);
755 buf = intf->cur_altsetting->extra;
756 len = intf->cur_altsetting->extralen;
758 /* parse through descriptors associated with control interface */
759 cdc_parse_cdc_header(&hdr, intf, buf, len);
761 if (hdr.usb_cdc_union_desc)
762 ctx->data = usb_ifnum_to_if(dev->udev,
763 hdr.usb_cdc_union_desc->bSlaveInterface0);
764 ctx->ether_desc = hdr.usb_cdc_ether_desc;
765 ctx->func_desc = hdr.usb_cdc_ncm_desc;
766 ctx->mbim_desc = hdr.usb_cdc_mbim_desc;
767 ctx->mbim_extended_desc = hdr.usb_cdc_mbim_extended_desc;
769 /* some buggy devices have an IAD but no CDC Union */
770 if (!hdr.usb_cdc_union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
771 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
772 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
775 /* check if we got everything */
777 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
780 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
781 if (!ctx->mbim_desc) {
782 dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
786 if (!ctx->ether_desc || !ctx->func_desc) {
787 dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
792 /* claim data interface, if different from control */
793 if (ctx->data != ctx->control) {
794 temp = usb_driver_claim_interface(driver, ctx->data, dev);
796 dev_dbg(&intf->dev, "failed to claim data intf\n");
801 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
803 /* Reset data interface. Some devices will not reset properly
804 * unless they are configured first. Toggle the altsetting to
807 usb_set_interface(dev->udev, iface_no, data_altsetting);
808 temp = usb_set_interface(dev->udev, iface_no, 0);
810 dev_dbg(&intf->dev, "set interface failed\n");
814 /* initialize basic device settings */
815 if (cdc_ncm_init(dev))
818 /* Some firmwares need a pause here or they will silently fail
819 * to set up the interface properly. This value was decided
820 * empirically on a Sierra Wireless MC7455 running 02.08.02.00
823 usleep_range(10000, 20000);
825 /* configure data interface */
826 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
828 dev_dbg(&intf->dev, "set interface failed\n");
832 /* Device-specific flags */
833 ctx->drvflags = drvflags;
836 * Some Huawei devices have been observed to come out of reset in NDP32 mode.
837 * Let's check if this is the case, and set the device to NDP16 mode again if
840 if (ctx->drvflags & CDC_NCM_FLAG_RESET_NTB16) {
841 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_FORMAT,
842 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
843 0, iface_no, &curr_ntb_format, 2);
848 if (curr_ntb_format == cpu_to_le16(USB_CDC_NCM_NTB32_FORMAT)) {
849 dev_info(&intf->dev, "resetting NTB format to 16-bit");
850 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
851 USB_TYPE_CLASS | USB_DIR_OUT
852 | USB_RECIP_INTERFACE,
853 USB_CDC_NCM_NTB16_FORMAT,
861 cdc_ncm_find_endpoints(dev, ctx->data);
862 cdc_ncm_find_endpoints(dev, ctx->control);
863 if (!dev->in || !dev->out || !dev->status) {
864 dev_dbg(&intf->dev, "failed to collect endpoints\n");
868 usb_set_intfdata(ctx->data, dev);
869 usb_set_intfdata(ctx->control, dev);
871 if (ctx->ether_desc) {
872 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
874 dev_dbg(&intf->dev, "failed to get mac address\n");
877 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
880 /* finish setting up the device specific data */
883 /* Allocate the delayed NDP if needed. */
884 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
885 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
886 if (!ctx->delayed_ndp16)
888 dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
891 /* override ethtool_ops */
892 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
894 /* add our sysfs attrs */
895 dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
897 /* must handle MTU changes */
898 dev->net->netdev_ops = &cdc_ncm_netdev_ops;
903 usb_set_intfdata(ctx->control, NULL);
904 usb_set_intfdata(ctx->data, NULL);
905 if (ctx->data != ctx->control)
906 usb_driver_release_interface(driver, ctx->data);
908 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
910 dev_info(&intf->dev, "bind() failure\n");
913 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
915 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
917 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
918 struct usb_driver *driver = driver_of(intf);
921 return; /* no setup */
923 atomic_set(&ctx->stop, 1);
925 if (hrtimer_active(&ctx->tx_timer))
926 hrtimer_cancel(&ctx->tx_timer);
928 tasklet_kill(&ctx->bh);
930 /* handle devices with combined control and data interface */
931 if (ctx->control == ctx->data)
934 /* disconnect master --> disconnect slave */
935 if (intf == ctx->control && ctx->data) {
936 usb_set_intfdata(ctx->data, NULL);
937 usb_driver_release_interface(driver, ctx->data);
940 } else if (intf == ctx->data && ctx->control) {
941 usb_set_intfdata(ctx->control, NULL);
942 usb_driver_release_interface(driver, ctx->control);
946 usb_set_intfdata(intf, NULL);
949 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
951 /* Return the number of the MBIM control interface altsetting iff it
952 * is preferred and available,
954 u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
956 struct usb_host_interface *alt;
958 /* The MBIM spec defines a NCM compatible default altsetting,
959 * which we may have matched:
961 * "Functions that implement both NCM 1.0 and MBIM (an
962 * “NCM/MBIM function”) according to this recommendation
963 * shall provide two alternate settings for the
964 * Communication Interface. Alternate setting 0, and the
965 * associated class and endpoint descriptors, shall be
966 * constructed according to the rules given for the
967 * Communication Interface in section 5 of [USBNCM10].
968 * Alternate setting 1, and the associated class and
969 * endpoint descriptors, shall be constructed according to
970 * the rules given in section 6 (USB Device Model) of this
973 if (intf->num_altsetting < 2)
974 return intf->cur_altsetting->desc.bAlternateSetting;
977 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
978 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
979 return CDC_NCM_COMM_ALTSETTING_MBIM;
981 return CDC_NCM_COMM_ALTSETTING_NCM;
983 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
985 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
987 /* MBIM backwards compatible function? */
988 if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
991 /* The NCM data altsetting is fixed, so we hard-coded it.
992 * Additionally, generic NCM devices are assumed to accept arbitrarily
995 return cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM, 0);
998 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
1000 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
1002 if (skb->len + align > max)
1003 align = max - skb->len;
1004 if (align && skb_tailroom(skb) >= align)
1005 memset(skb_put(skb, align), 0, align);
1008 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
1009 * allocating a new one within skb
1011 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
1013 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
1014 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
1015 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
1017 /* If NDP should be moved to the end of the NCM package, we can't follow the
1018 * NTH16 header as we would normally do. NDP isn't written to the SKB yet, and
1019 * the wNdpIndex field in the header is actually not consistent with reality. It will be later.
1021 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1022 if (ctx->delayed_ndp16->dwSignature == sign)
1023 return ctx->delayed_ndp16;
1025 /* We can only push a single NDP to the end. Return
1026 * NULL to send what we've already got and queue this
1029 else if (ctx->delayed_ndp16->dwSignature)
1033 /* follow the chain of NDPs, looking for a match */
1035 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
1036 if (ndp16->dwSignature == sign)
1038 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1042 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1043 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1045 /* verify that there is room for the NDP and the datagram (reserve) */
1046 if ((ctx->tx_max - skb->len - reserve) < ctx->max_ndp_size)
1051 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
1053 nth16->wNdpIndex = cpu_to_le16(skb->len);
1055 /* push a new empty NDP */
1056 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1057 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, ctx->max_ndp_size);
1059 ndp16 = ctx->delayed_ndp16;
1061 ndp16->dwSignature = sign;
1062 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
1067 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
1069 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1070 struct usb_cdc_ncm_nth16 *nth16;
1071 struct usb_cdc_ncm_ndp16 *ndp16;
1072 struct sk_buff *skb_out;
1073 u16 n = 0, index, ndplen;
1075 u32 delayed_ndp_size;
1076 size_t padding_count;
1078 /* When our NDP gets written in cdc_ncm_ndp(), then skb_out->len gets updated
1079 * accordingly. Otherwise, we should check here.
1081 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1082 delayed_ndp_size = ctx->max_ndp_size +
1084 ctx->tx_ndp_modulus,
1085 ctx->tx_modulus + ctx->tx_remainder) - 1;
1087 delayed_ndp_size = 0;
1089 /* if there is a remaining skb, it gets priority */
1091 swap(skb, ctx->tx_rem_skb);
1092 swap(sign, ctx->tx_rem_sign);
1097 /* check if we are resuming an OUT skb */
1098 skb_out = ctx->tx_curr_skb;
1100 /* allocate a new OUT skb */
1102 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
1103 if (skb_out == NULL) {
1105 dev_kfree_skb_any(skb);
1106 dev->net->stats.tx_dropped++;
1110 /* fill out the initial 16-bit NTB header */
1111 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
1112 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1113 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1114 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
1116 /* count total number of frames in this NTB */
1117 ctx->tx_curr_frame_num = 0;
1119 /* recent payload counter for this skb_out */
1120 ctx->tx_curr_frame_payload = 0;
1123 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1124 /* send any remaining skb first */
1126 skb = ctx->tx_rem_skb;
1127 sign = ctx->tx_rem_sign;
1128 ctx->tx_rem_skb = NULL;
1130 /* check for end of skb */
1135 /* get the appropriate NDP for this skb */
1136 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1138 /* align beginning of next frame */
1139 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
1141 /* check if we had enough room left for both NDP and frame */
1142 if (!ndp16 || skb_out->len + skb->len + delayed_ndp_size > ctx->tx_max) {
1144 /* won't fit, MTU problem? */
1145 dev_kfree_skb_any(skb);
1147 dev->net->stats.tx_dropped++;
1149 /* no room for skb - store for later */
1150 if (ctx->tx_rem_skb != NULL) {
1151 dev_kfree_skb_any(ctx->tx_rem_skb);
1152 dev->net->stats.tx_dropped++;
1154 ctx->tx_rem_skb = skb;
1155 ctx->tx_rem_sign = sign;
1158 ctx->tx_reason_ntb_full++; /* count reason for transmitting */
1163 /* calculate frame number withing this NDP */
1164 ndplen = le16_to_cpu(ndp16->wLength);
1165 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
1167 /* OK, add this skb */
1168 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1169 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1170 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
1171 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
1172 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
1173 dev_kfree_skb_any(skb);
1176 /* send now if this NDP is full */
1177 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1179 ctx->tx_reason_ndp_full++; /* count reason for transmitting */
1184 /* free up any dangling skb */
1186 dev_kfree_skb_any(skb);
1188 dev->net->stats.tx_dropped++;
1191 ctx->tx_curr_frame_num = n;
1194 /* wait for more frames */
1195 /* push variables */
1196 ctx->tx_curr_skb = skb_out;
1199 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1200 /* wait for more frames */
1201 /* push variables */
1202 ctx->tx_curr_skb = skb_out;
1203 /* set the pending count */
1204 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1205 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1209 if (n == ctx->tx_max_datagrams)
1210 ctx->tx_reason_max_datagram++; /* count reason for transmitting */
1211 /* frame goes out */
1212 /* variables will be reset at next call */
1215 /* If requested, put NDP at end of frame. */
1216 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1217 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1218 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_max - ctx->max_ndp_size);
1219 nth16->wNdpIndex = cpu_to_le16(skb_out->len);
1220 memcpy(skb_put(skb_out, ctx->max_ndp_size), ctx->delayed_ndp16, ctx->max_ndp_size);
1222 /* Zero out delayed NDP - signature checking will naturally fail. */
1223 ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1226 /* If collected data size is less or equal ctx->min_tx_pkt
1227 * bytes, we send buffers as it is. If we get more data, it
1228 * would be more efficient for USB HS mobile device with DMA
1229 * engine to receive a full size NTB, than canceling DMA
1230 * transfer and receiving a short packet.
1232 * This optimization support is pointless if we end up sending
1233 * a ZLP after full sized NTBs.
1235 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1236 skb_out->len > ctx->min_tx_pkt) {
1237 padding_count = ctx->tx_max - skb_out->len;
1238 if (!WARN_ON(padding_count > ctx->tx_max))
1239 memset(skb_put(skb_out, padding_count), 0, padding_count);
1240 } else if (skb_out->len < ctx->tx_max &&
1241 (skb_out->len % dev->maxpacket) == 0) {
1242 *skb_put(skb_out, 1) = 0; /* force short packet */
1245 /* set final frame length */
1246 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1247 nth16->wBlockLength = cpu_to_le16(skb_out->len);
1250 ctx->tx_curr_skb = NULL;
1252 /* keep private stats: framing overhead and number of NTBs */
1253 ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1256 /* usbnet will count all the framing overhead by default.
1257 * Adjust the stats so that the tx_bytes counter show real
1258 * payload data instead.
1260 usbnet_set_skb_tx_stats(skb_out, n,
1261 (long)ctx->tx_curr_frame_payload - skb_out->len);
1266 /* Start timer, if there is a remaining non-empty skb */
1267 if (ctx->tx_curr_skb != NULL && n > 0)
1268 cdc_ncm_tx_timeout_start(ctx);
1271 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1273 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1275 /* start timer, if not already started */
1276 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1277 hrtimer_start(&ctx->tx_timer,
1278 ktime_set(0, ctx->timer_interval),
1282 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1284 struct cdc_ncm_ctx *ctx =
1285 container_of(timer, struct cdc_ncm_ctx, tx_timer);
1287 if (!atomic_read(&ctx->stop))
1288 tasklet_schedule(&ctx->bh);
1289 return HRTIMER_NORESTART;
1292 static void cdc_ncm_txpath_bh(unsigned long param)
1294 struct usbnet *dev = (struct usbnet *)param;
1295 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1297 spin_lock_bh(&ctx->mtx);
1298 if (ctx->tx_timer_pending != 0) {
1299 ctx->tx_timer_pending--;
1300 cdc_ncm_tx_timeout_start(ctx);
1301 spin_unlock_bh(&ctx->mtx);
1302 } else if (dev->net != NULL) {
1303 ctx->tx_reason_timeout++; /* count reason for transmitting */
1304 spin_unlock_bh(&ctx->mtx);
1305 netif_tx_lock_bh(dev->net);
1306 usbnet_start_xmit(NULL, dev->net);
1307 netif_tx_unlock_bh(dev->net);
1309 spin_unlock_bh(&ctx->mtx);
1314 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1316 struct sk_buff *skb_out;
1317 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1320 * The Ethernet API we are using does not support transmitting
1321 * multiple Ethernet frames in a single call. This driver will
1322 * accumulate multiple Ethernet frames and send out a larger
1323 * USB frame when the USB buffer is full or when a single jiffies
1329 spin_lock_bh(&ctx->mtx);
1330 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1331 spin_unlock_bh(&ctx->mtx);
1336 dev_kfree_skb_any(skb);
1340 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1342 /* verify NTB header and return offset of first NDP, or negative error */
1343 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1345 struct usbnet *dev = netdev_priv(skb_in->dev);
1346 struct usb_cdc_ncm_nth16 *nth16;
1353 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1354 sizeof(struct usb_cdc_ncm_ndp16))) {
1355 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1359 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1361 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1362 netif_dbg(dev, rx_err, dev->net,
1363 "invalid NTH16 signature <%#010x>\n",
1364 le32_to_cpu(nth16->dwSignature));
1368 len = le16_to_cpu(nth16->wBlockLength);
1369 if (len > ctx->rx_max) {
1370 netif_dbg(dev, rx_err, dev->net,
1371 "unsupported NTB block length %u/%u\n", len,
1376 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1377 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1378 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1379 netif_dbg(dev, rx_err, dev->net,
1380 "sequence number glitch prev=%d curr=%d\n",
1381 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1383 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1385 ret = le16_to_cpu(nth16->wNdpIndex);
1389 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1391 /* verify NDP header and return number of datagrams, or negative error */
1392 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1394 struct usbnet *dev = netdev_priv(skb_in->dev);
1395 struct usb_cdc_ncm_ndp16 *ndp16;
1398 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1399 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1403 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1405 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1406 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1407 le16_to_cpu(ndp16->wLength));
1411 ret = ((le16_to_cpu(ndp16->wLength) -
1412 sizeof(struct usb_cdc_ncm_ndp16)) /
1413 sizeof(struct usb_cdc_ncm_dpe16));
1414 ret--; /* we process NDP entries except for the last one */
1416 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1417 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1418 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1425 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1427 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1429 struct sk_buff *skb;
1430 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1435 struct usb_cdc_ncm_ndp16 *ndp16;
1436 struct usb_cdc_ncm_dpe16 *dpe16;
1438 int loopcount = 50; /* arbitrary max preventing infinite loop */
1441 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1446 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1450 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1452 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1453 netif_dbg(dev, rx_err, dev->net,
1454 "invalid DPT16 signature <%#010x>\n",
1455 le32_to_cpu(ndp16->dwSignature));
1458 dpe16 = ndp16->dpe16;
1460 for (x = 0; x < nframes; x++, dpe16++) {
1461 offset = le16_to_cpu(dpe16->wDatagramIndex);
1462 len = le16_to_cpu(dpe16->wDatagramLength);
1466 * All entries after first NULL entry are to be ignored
1468 if ((offset == 0) || (len == 0)) {
1470 goto err_ndp; /* empty NTB */
1474 /* sanity checking */
1475 if (((offset + len) > skb_in->len) ||
1476 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1477 netif_dbg(dev, rx_err, dev->net,
1478 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1479 x, offset, len, skb_in);
1485 /* create a fresh copy to reduce truesize */
1486 skb = netdev_alloc_skb_ip_align(dev->net, len);
1489 memcpy(skb_put(skb, len), skb_in->data + offset, len);
1490 usbnet_skb_return(dev, skb);
1491 payload += len; /* count payload bytes in this NTB */
1495 /* are there more NDPs to process? */
1496 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1497 if (ndpoffset && loopcount--)
1501 ctx->rx_overhead += skb_in->len - payload;
1508 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1511 cdc_ncm_speed_change(struct usbnet *dev,
1512 struct usb_cdc_speed_change *data)
1514 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1515 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1518 * Currently the USB-NET API does not support reporting the actual
1519 * device speed. Do print it instead.
1521 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1522 netif_info(dev, link, dev->net,
1523 "%u mbit/s downlink %u mbit/s uplink\n",
1524 (unsigned int)(rx_speed / 1000000U),
1525 (unsigned int)(tx_speed / 1000000U));
1527 netif_info(dev, link, dev->net,
1528 "%u kbit/s downlink %u kbit/s uplink\n",
1529 (unsigned int)(rx_speed / 1000U),
1530 (unsigned int)(tx_speed / 1000U));
1534 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1536 struct cdc_ncm_ctx *ctx;
1537 struct usb_cdc_notification *event;
1539 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1541 if (urb->actual_length < sizeof(*event))
1544 /* test for split data in 8-byte chunks */
1545 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1546 cdc_ncm_speed_change(dev,
1547 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1551 event = urb->transfer_buffer;
1553 switch (event->bNotificationType) {
1554 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1556 * According to the CDC NCM specification ch.7.1
1557 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1558 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1560 usbnet_link_change(dev, !!event->wValue, 0);
1563 case USB_CDC_NOTIFY_SPEED_CHANGE:
1564 if (urb->actual_length < (sizeof(*event) +
1565 sizeof(struct usb_cdc_speed_change)))
1566 set_bit(EVENT_STS_SPLIT, &dev->flags);
1568 cdc_ncm_speed_change(dev,
1569 (struct usb_cdc_speed_change *)&event[1]);
1573 dev_dbg(&dev->udev->dev,
1574 "NCM: unexpected notification 0x%02x!\n",
1575 event->bNotificationType);
1580 static const struct driver_info cdc_ncm_info = {
1581 .description = "CDC NCM",
1582 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1583 | FLAG_LINK_INTR | FLAG_ETHER,
1584 .bind = cdc_ncm_bind,
1585 .unbind = cdc_ncm_unbind,
1586 .manage_power = usbnet_manage_power,
1587 .status = cdc_ncm_status,
1588 .rx_fixup = cdc_ncm_rx_fixup,
1589 .tx_fixup = cdc_ncm_tx_fixup,
1592 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1593 static const struct driver_info wwan_info = {
1594 .description = "Mobile Broadband Network Device",
1595 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1596 | FLAG_LINK_INTR | FLAG_WWAN,
1597 .bind = cdc_ncm_bind,
1598 .unbind = cdc_ncm_unbind,
1599 .manage_power = usbnet_manage_power,
1600 .status = cdc_ncm_status,
1601 .rx_fixup = cdc_ncm_rx_fixup,
1602 .tx_fixup = cdc_ncm_tx_fixup,
1605 /* Same as wwan_info, but with FLAG_NOARP */
1606 static const struct driver_info wwan_noarp_info = {
1607 .description = "Mobile Broadband Network Device (NO ARP)",
1608 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1609 | FLAG_LINK_INTR | FLAG_WWAN | FLAG_NOARP,
1610 .bind = cdc_ncm_bind,
1611 .unbind = cdc_ncm_unbind,
1612 .manage_power = usbnet_manage_power,
1613 .status = cdc_ncm_status,
1614 .rx_fixup = cdc_ncm_rx_fixup,
1615 .tx_fixup = cdc_ncm_tx_fixup,
1618 static const struct usb_device_id cdc_devs[] = {
1619 /* Ericsson MBM devices like F5521gw */
1620 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1621 | USB_DEVICE_ID_MATCH_VENDOR,
1623 .bInterfaceClass = USB_CLASS_COMM,
1624 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1625 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1626 .driver_info = (unsigned long) &wwan_info,
1629 /* DW5812 LTE Verizon Mobile Broadband Card
1630 * Unlike DW5550 this device requires FLAG_NOARP
1632 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bb,
1634 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1635 .driver_info = (unsigned long)&wwan_noarp_info,
1638 /* DW5813 LTE AT&T Mobile Broadband Card
1639 * Unlike DW5550 this device requires FLAG_NOARP
1641 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bc,
1643 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1644 .driver_info = (unsigned long)&wwan_noarp_info,
1647 /* Dell branded MBM devices like DW5550 */
1648 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1649 | USB_DEVICE_ID_MATCH_VENDOR,
1651 .bInterfaceClass = USB_CLASS_COMM,
1652 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1653 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1654 .driver_info = (unsigned long) &wwan_info,
1657 /* Toshiba branded MBM devices */
1658 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1659 | USB_DEVICE_ID_MATCH_VENDOR,
1661 .bInterfaceClass = USB_CLASS_COMM,
1662 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1663 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1664 .driver_info = (unsigned long) &wwan_info,
1667 /* tag Huawei devices as wwan */
1668 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1670 USB_CDC_SUBCLASS_NCM,
1671 USB_CDC_PROTO_NONE),
1672 .driver_info = (unsigned long)&wwan_info,
1675 /* Infineon(now Intel) HSPA Modem platform */
1676 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1678 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1679 .driver_info = (unsigned long)&wwan_noarp_info,
1682 /* Generic CDC-NCM devices */
1683 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1684 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1685 .driver_info = (unsigned long)&cdc_ncm_info,
1690 MODULE_DEVICE_TABLE(usb, cdc_devs);
1692 static struct usb_driver cdc_ncm_driver = {
1694 .id_table = cdc_devs,
1695 .probe = usbnet_probe,
1696 .disconnect = usbnet_disconnect,
1697 .suspend = usbnet_suspend,
1698 .resume = usbnet_resume,
1699 .reset_resume = usbnet_resume,
1700 .supports_autosuspend = 1,
1701 .disable_hub_initiated_lpm = 1,
1704 module_usb_driver(cdc_ncm_driver);
1706 MODULE_AUTHOR("Hans Petter Selasky");
1707 MODULE_DESCRIPTION("USB CDC NCM host driver");
1708 MODULE_LICENSE("Dual BSD/GPL");