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/ethtool.h>
45 #include <linux/workqueue.h>
46 #include <linux/mii.h>
47 #include <linux/crc32.h>
48 #include <linux/usb.h>
49 #include <linux/hrtimer.h>
50 #include <linux/atomic.h>
51 #include <linux/usb/usbnet.h>
52 #include <linux/usb/cdc.h>
53 #include <linux/usb/cdc_ncm.h>
55 #if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
56 static bool prefer_mbim = true;
58 static bool prefer_mbim;
60 module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
61 MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
63 static void cdc_ncm_txpath_bh(unsigned long param);
64 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx);
65 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *hr_timer);
66 static struct usb_driver cdc_ncm_driver;
68 struct cdc_ncm_stats {
69 char stat_string[ETH_GSTRING_LEN];
74 #define CDC_NCM_STAT(str, m) { \
76 .sizeof_stat = sizeof(((struct cdc_ncm_ctx *)0)->m), \
77 .stat_offset = offsetof(struct cdc_ncm_ctx, m) }
78 #define CDC_NCM_SIMPLE_STAT(m) CDC_NCM_STAT(__stringify(m), m)
80 static const struct cdc_ncm_stats cdc_ncm_gstrings_stats[] = {
81 CDC_NCM_SIMPLE_STAT(tx_reason_ntb_full),
82 CDC_NCM_SIMPLE_STAT(tx_reason_ndp_full),
83 CDC_NCM_SIMPLE_STAT(tx_reason_timeout),
84 CDC_NCM_SIMPLE_STAT(tx_reason_max_datagram),
85 CDC_NCM_SIMPLE_STAT(tx_overhead),
86 CDC_NCM_SIMPLE_STAT(tx_ntbs),
87 CDC_NCM_SIMPLE_STAT(rx_overhead),
88 CDC_NCM_SIMPLE_STAT(rx_ntbs),
91 static int cdc_ncm_get_sset_count(struct net_device __always_unused *netdev, int sset)
95 return ARRAY_SIZE(cdc_ncm_gstrings_stats);
101 static void cdc_ncm_get_ethtool_stats(struct net_device *netdev,
102 struct ethtool_stats __always_unused *stats,
105 struct usbnet *dev = netdev_priv(netdev);
106 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
110 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
111 p = (char *)ctx + cdc_ncm_gstrings_stats[i].stat_offset;
112 data[i] = (cdc_ncm_gstrings_stats[i].sizeof_stat == sizeof(u64)) ? *(u64 *)p : *(u32 *)p;
116 static void cdc_ncm_get_strings(struct net_device __always_unused *netdev, u32 stringset, u8 *data)
123 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
124 memcpy(p, cdc_ncm_gstrings_stats[i].stat_string, ETH_GSTRING_LEN);
125 p += ETH_GSTRING_LEN;
130 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
132 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
133 .get_settings = usbnet_get_settings,
134 .set_settings = usbnet_set_settings,
135 .get_link = usbnet_get_link,
136 .nway_reset = usbnet_nway_reset,
137 .get_drvinfo = usbnet_get_drvinfo,
138 .get_msglevel = usbnet_get_msglevel,
139 .set_msglevel = usbnet_set_msglevel,
140 .get_ts_info = ethtool_op_get_ts_info,
141 .get_sset_count = cdc_ncm_get_sset_count,
142 .get_strings = cdc_ncm_get_strings,
143 .get_ethtool_stats = cdc_ncm_get_ethtool_stats,
146 static u32 cdc_ncm_check_rx_max(struct usbnet *dev, u32 new_rx)
148 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
151 /* clamp new_rx to sane values */
152 min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
153 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
155 /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
157 dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
158 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
162 val = clamp_t(u32, new_rx, min, max);
164 dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range\n", min, max);
169 static u32 cdc_ncm_check_tx_max(struct usbnet *dev, u32 new_tx)
171 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
174 /* clamp new_tx to sane values */
175 min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
176 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
178 /* some devices set dwNtbOutMaxSize too low for the above default */
181 val = clamp_t(u32, new_tx, min, max);
183 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range\n", min, max);
188 static ssize_t cdc_ncm_show_min_tx_pkt(struct device *d, struct device_attribute *attr, char *buf)
190 struct usbnet *dev = netdev_priv(to_net_dev(d));
191 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
193 return sprintf(buf, "%u\n", ctx->min_tx_pkt);
196 static ssize_t cdc_ncm_show_rx_max(struct device *d, struct device_attribute *attr, char *buf)
198 struct usbnet *dev = netdev_priv(to_net_dev(d));
199 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
201 return sprintf(buf, "%u\n", ctx->rx_max);
204 static ssize_t cdc_ncm_show_tx_max(struct device *d, struct device_attribute *attr, char *buf)
206 struct usbnet *dev = netdev_priv(to_net_dev(d));
207 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
209 return sprintf(buf, "%u\n", ctx->tx_max);
212 static ssize_t cdc_ncm_show_tx_timer_usecs(struct device *d, struct device_attribute *attr, char *buf)
214 struct usbnet *dev = netdev_priv(to_net_dev(d));
215 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
217 return sprintf(buf, "%u\n", ctx->timer_interval / (u32)NSEC_PER_USEC);
220 static ssize_t cdc_ncm_store_min_tx_pkt(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
222 struct usbnet *dev = netdev_priv(to_net_dev(d));
223 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
226 /* no need to restrict values - anything from 0 to infinity is OK */
227 if (kstrtoul(buf, 0, &val))
230 ctx->min_tx_pkt = val;
234 static ssize_t cdc_ncm_store_rx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
236 struct usbnet *dev = netdev_priv(to_net_dev(d));
237 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
240 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_rx_max(dev, val) != val)
243 cdc_ncm_update_rxtx_max(dev, val, ctx->tx_max);
247 static ssize_t cdc_ncm_store_tx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
249 struct usbnet *dev = netdev_priv(to_net_dev(d));
250 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
253 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_tx_max(dev, val) != val)
256 cdc_ncm_update_rxtx_max(dev, ctx->rx_max, val);
260 static ssize_t cdc_ncm_store_tx_timer_usecs(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
262 struct usbnet *dev = netdev_priv(to_net_dev(d));
263 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
267 ret = kstrtoul(buf, 0, &val);
270 if (val && (val < CDC_NCM_TIMER_INTERVAL_MIN || val > CDC_NCM_TIMER_INTERVAL_MAX))
273 spin_lock_bh(&ctx->mtx);
274 ctx->timer_interval = val * NSEC_PER_USEC;
275 if (!ctx->timer_interval)
276 ctx->tx_timer_pending = 0;
277 spin_unlock_bh(&ctx->mtx);
281 static DEVICE_ATTR(min_tx_pkt, S_IRUGO | S_IWUSR, cdc_ncm_show_min_tx_pkt, cdc_ncm_store_min_tx_pkt);
282 static DEVICE_ATTR(rx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_rx_max, cdc_ncm_store_rx_max);
283 static DEVICE_ATTR(tx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_max, cdc_ncm_store_tx_max);
284 static DEVICE_ATTR(tx_timer_usecs, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_timer_usecs, cdc_ncm_store_tx_timer_usecs);
286 static ssize_t ndp_to_end_show(struct device *d, struct device_attribute *attr, char *buf)
288 struct usbnet *dev = netdev_priv(to_net_dev(d));
289 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
291 return sprintf(buf, "%c\n", ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END ? 'Y' : 'N');
294 static ssize_t ndp_to_end_store(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
296 struct usbnet *dev = netdev_priv(to_net_dev(d));
297 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
300 if (strtobool(buf, &enable))
304 if (enable == (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
307 if (enable && !ctx->delayed_ndp16) {
308 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
309 if (!ctx->delayed_ndp16)
313 /* flush pending data before changing flag */
314 netif_tx_lock_bh(dev->net);
315 usbnet_start_xmit(NULL, dev->net);
316 spin_lock_bh(&ctx->mtx);
318 ctx->drvflags |= CDC_NCM_FLAG_NDP_TO_END;
320 ctx->drvflags &= ~CDC_NCM_FLAG_NDP_TO_END;
321 spin_unlock_bh(&ctx->mtx);
322 netif_tx_unlock_bh(dev->net);
326 static DEVICE_ATTR_RW(ndp_to_end);
328 #define NCM_PARM_ATTR(name, format, tocpu) \
329 static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
331 struct usbnet *dev = netdev_priv(to_net_dev(d)); \
332 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
333 return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name)); \
335 static DEVICE_ATTR(name, S_IRUGO, cdc_ncm_show_##name, NULL)
337 NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
338 NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
339 NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
340 NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
341 NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
342 NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
343 NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
344 NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
345 NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
346 NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
348 static struct attribute *cdc_ncm_sysfs_attrs[] = {
349 &dev_attr_min_tx_pkt.attr,
350 &dev_attr_ndp_to_end.attr,
351 &dev_attr_rx_max.attr,
352 &dev_attr_tx_max.attr,
353 &dev_attr_tx_timer_usecs.attr,
354 &dev_attr_bmNtbFormatsSupported.attr,
355 &dev_attr_dwNtbInMaxSize.attr,
356 &dev_attr_wNdpInDivisor.attr,
357 &dev_attr_wNdpInPayloadRemainder.attr,
358 &dev_attr_wNdpInAlignment.attr,
359 &dev_attr_dwNtbOutMaxSize.attr,
360 &dev_attr_wNdpOutDivisor.attr,
361 &dev_attr_wNdpOutPayloadRemainder.attr,
362 &dev_attr_wNdpOutAlignment.attr,
363 &dev_attr_wNtbOutMaxDatagrams.attr,
367 static struct attribute_group cdc_ncm_sysfs_attr_group = {
369 .attrs = cdc_ncm_sysfs_attrs,
372 /* handle rx_max and tx_max changes */
373 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
375 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
376 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
379 val = cdc_ncm_check_rx_max(dev, new_rx);
381 /* inform device about NTB input size changes */
382 if (val != ctx->rx_max) {
383 __le32 dwNtbInMaxSize = cpu_to_le32(val);
385 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
387 /* tell device to use new size */
388 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
389 USB_TYPE_CLASS | USB_DIR_OUT
390 | USB_RECIP_INTERFACE,
391 0, iface_no, &dwNtbInMaxSize, 4) < 0)
392 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
397 /* usbnet use these values for sizing rx queues */
398 if (dev->rx_urb_size != ctx->rx_max) {
399 dev->rx_urb_size = ctx->rx_max;
400 if (netif_running(dev->net))
401 usbnet_unlink_rx_urbs(dev);
404 val = cdc_ncm_check_tx_max(dev, new_tx);
405 if (val != ctx->tx_max)
406 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
408 /* Adding a pad byte here if necessary simplifies the handling
409 * in cdc_ncm_fill_tx_frame, making tx_max always represent
410 * the real skb max size.
412 * We cannot use dev->maxpacket here because this is called from
413 * .bind which is called before usbnet sets up dev->maxpacket
415 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
416 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
419 /* we might need to flush any pending tx buffers if running */
420 if (netif_running(dev->net) && val > ctx->tx_max) {
421 netif_tx_lock_bh(dev->net);
422 usbnet_start_xmit(NULL, dev->net);
423 /* make sure tx_curr_skb is reallocated if it was empty */
424 if (ctx->tx_curr_skb) {
425 dev_kfree_skb_any(ctx->tx_curr_skb);
426 ctx->tx_curr_skb = NULL;
429 netif_tx_unlock_bh(dev->net);
434 dev->hard_mtu = ctx->tx_max;
436 /* max qlen depend on hard_mtu and rx_urb_size */
437 usbnet_update_max_qlen(dev);
439 /* never pad more than 3 full USB packets per transfer */
440 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
441 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
444 /* helpers for NCM and MBIM differences */
445 static u8 cdc_ncm_flags(struct usbnet *dev)
447 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
449 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
450 return ctx->mbim_desc->bmNetworkCapabilities;
452 return ctx->func_desc->bmNetworkCapabilities;
456 static int cdc_ncm_eth_hlen(struct usbnet *dev)
458 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
463 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
465 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
466 return CDC_MBIM_MIN_DATAGRAM_SIZE;
467 return CDC_NCM_MIN_DATAGRAM_SIZE;
470 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
472 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
474 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
475 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
477 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
478 return CDC_NCM_MAX_DATAGRAM_SIZE;
481 /* initial one-time device setup. MUST be called with the data interface
484 static int cdc_ncm_init(struct usbnet *dev)
486 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
487 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
490 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
491 USB_TYPE_CLASS | USB_DIR_IN
492 |USB_RECIP_INTERFACE,
493 0, iface_no, &ctx->ncm_parm,
494 sizeof(ctx->ncm_parm));
496 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
497 return err; /* GET_NTB_PARAMETERS is required */
501 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
502 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
503 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
504 USB_TYPE_CLASS | USB_DIR_OUT
505 | USB_RECIP_INTERFACE,
506 USB_CDC_NCM_CRC_NOT_APPENDED,
509 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
512 /* set NTB format, if both formats are supported.
514 * "The host shall only send this command while the NCM Data
515 * Interface is in alternate setting 0."
517 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
518 USB_CDC_NCM_NTB32_SUPPORTED) {
519 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
520 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
521 USB_TYPE_CLASS | USB_DIR_OUT
522 | USB_RECIP_INTERFACE,
523 USB_CDC_NCM_NTB16_FORMAT,
526 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
529 /* set initial device values */
530 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
531 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
532 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
533 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
534 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
535 /* devices prior to NCM Errata shall set this field to zero */
536 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
538 dev_dbg(&dev->intf->dev,
539 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
540 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
541 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
543 /* max count of tx datagrams */
544 if ((ctx->tx_max_datagrams == 0) ||
545 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
546 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
548 /* set up maximum NDP size */
549 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
551 /* initial coalescing timer interval */
552 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
557 /* set a new max datagram size */
558 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
560 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
561 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
562 __le16 max_datagram_size;
566 /* set default based on descriptors */
567 ctx->max_datagram_size = clamp_t(u32, new_size,
568 cdc_ncm_min_dgram_size(dev),
569 CDC_NCM_MAX_DATAGRAM_SIZE);
571 /* inform the device about the selected Max Datagram Size? */
572 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
575 /* read current mtu value from device */
576 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
577 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
578 0, iface_no, &max_datagram_size, 2);
580 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
584 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
587 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
588 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
589 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
590 0, iface_no, &max_datagram_size, 2);
592 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
595 /* set MTU to max supported by the device if necessary */
596 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
598 /* do not exceed operater preferred MTU */
599 if (ctx->mbim_extended_desc) {
600 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
601 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
602 dev->net->mtu = mbim_mtu;
606 static void cdc_ncm_fix_modulus(struct usbnet *dev)
608 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
612 * verify that the structure alignment is:
614 * - not greater than the maximum transmit length
615 * - not less than four bytes
617 val = ctx->tx_ndp_modulus;
619 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
620 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
621 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
622 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
626 * verify that the payload alignment is:
628 * - not greater than the maximum transmit length
629 * - not less than four bytes
631 val = ctx->tx_modulus;
633 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
634 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
635 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
636 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
639 /* verify the payload remainder */
640 if (ctx->tx_remainder >= ctx->tx_modulus) {
641 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
642 ctx->tx_remainder = 0;
645 /* adjust TX-remainder according to NCM specification. */
646 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
647 (ctx->tx_modulus - 1));
650 static int cdc_ncm_setup(struct usbnet *dev)
652 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
655 /* be conservative when selecting intial buffer size to
656 * increase the number of hosts this will work for
658 def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
659 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
660 def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
661 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
663 /* clamp rx_max and tx_max and inform device */
664 cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
666 /* sanitize the modulus and remainder values */
667 cdc_ncm_fix_modulus(dev);
669 /* set max datagram size */
670 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
675 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
677 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
680 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
682 e = intf->cur_altsetting->endpoint + ep;
683 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
684 case USB_ENDPOINT_XFER_INT:
685 if (usb_endpoint_dir_in(&e->desc)) {
691 case USB_ENDPOINT_XFER_BULK:
692 if (usb_endpoint_dir_in(&e->desc)) {
706 dev->in = usb_rcvbulkpipe(dev->udev,
707 in->desc.bEndpointAddress &
708 USB_ENDPOINT_NUMBER_MASK);
709 if (out && !dev->out)
710 dev->out = usb_sndbulkpipe(dev->udev,
711 out->desc.bEndpointAddress &
712 USB_ENDPOINT_NUMBER_MASK);
715 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
720 if (ctx->tx_rem_skb != NULL) {
721 dev_kfree_skb_any(ctx->tx_rem_skb);
722 ctx->tx_rem_skb = NULL;
725 if (ctx->tx_curr_skb != NULL) {
726 dev_kfree_skb_any(ctx->tx_curr_skb);
727 ctx->tx_curr_skb = NULL;
730 kfree(ctx->delayed_ndp16);
735 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
737 struct cdc_ncm_ctx *ctx;
738 struct usb_driver *driver;
743 struct usb_cdc_parsed_header hdr;
745 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
749 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
750 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
751 ctx->bh.data = (unsigned long)dev;
752 ctx->bh.func = cdc_ncm_txpath_bh;
753 atomic_set(&ctx->stop, 0);
754 spin_lock_init(&ctx->mtx);
756 /* store ctx pointer in device data field */
757 dev->data[0] = (unsigned long)ctx;
759 /* only the control interface can be successfully probed */
762 /* get some pointers */
763 driver = driver_of(intf);
764 buf = intf->cur_altsetting->extra;
765 len = intf->cur_altsetting->extralen;
767 /* parse through descriptors associated with control interface */
768 cdc_parse_cdc_header(&hdr, intf, buf, len);
770 if (hdr.usb_cdc_union_desc)
771 ctx->data = usb_ifnum_to_if(dev->udev,
772 hdr.usb_cdc_union_desc->bSlaveInterface0);
773 ctx->ether_desc = hdr.usb_cdc_ether_desc;
774 ctx->func_desc = hdr.usb_cdc_ncm_desc;
775 ctx->mbim_desc = hdr.usb_cdc_mbim_desc;
776 ctx->mbim_extended_desc = hdr.usb_cdc_mbim_extended_desc;
778 /* some buggy devices have an IAD but no CDC Union */
779 if (!hdr.usb_cdc_union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
780 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
781 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
784 /* check if we got everything */
786 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
789 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
790 if (!ctx->mbim_desc) {
791 dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
795 if (!ctx->ether_desc || !ctx->func_desc) {
796 dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
801 /* claim data interface, if different from control */
802 if (ctx->data != ctx->control) {
803 temp = usb_driver_claim_interface(driver, ctx->data, dev);
805 dev_dbg(&intf->dev, "failed to claim data intf\n");
810 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
812 /* reset data interface */
813 temp = usb_set_interface(dev->udev, iface_no, 0);
815 dev_dbg(&intf->dev, "set interface failed\n");
819 /* initialize basic device settings */
820 if (cdc_ncm_init(dev))
823 /* configure data interface */
824 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
826 dev_dbg(&intf->dev, "set interface failed\n");
830 cdc_ncm_find_endpoints(dev, ctx->data);
831 cdc_ncm_find_endpoints(dev, ctx->control);
832 if (!dev->in || !dev->out || !dev->status) {
833 dev_dbg(&intf->dev, "failed to collect endpoints\n");
837 usb_set_intfdata(ctx->data, dev);
838 usb_set_intfdata(ctx->control, dev);
840 if (ctx->ether_desc) {
841 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
843 dev_dbg(&intf->dev, "failed to get mac address\n");
846 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
849 /* finish setting up the device specific data */
852 /* Device-specific flags */
853 ctx->drvflags = drvflags;
855 /* Allocate the delayed NDP if needed. */
856 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
857 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
858 if (!ctx->delayed_ndp16)
860 dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
863 /* override ethtool_ops */
864 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
866 /* add our sysfs attrs */
867 dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
872 usb_set_intfdata(ctx->control, NULL);
873 usb_set_intfdata(ctx->data, NULL);
874 if (ctx->data != ctx->control)
875 usb_driver_release_interface(driver, ctx->data);
877 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
879 dev_info(&intf->dev, "bind() failure\n");
882 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
884 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
886 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
887 struct usb_driver *driver = driver_of(intf);
890 return; /* no setup */
892 atomic_set(&ctx->stop, 1);
894 if (hrtimer_active(&ctx->tx_timer))
895 hrtimer_cancel(&ctx->tx_timer);
897 tasklet_kill(&ctx->bh);
899 /* handle devices with combined control and data interface */
900 if (ctx->control == ctx->data)
903 /* disconnect master --> disconnect slave */
904 if (intf == ctx->control && ctx->data) {
905 usb_set_intfdata(ctx->data, NULL);
906 usb_driver_release_interface(driver, ctx->data);
909 } else if (intf == ctx->data && ctx->control) {
910 usb_set_intfdata(ctx->control, NULL);
911 usb_driver_release_interface(driver, ctx->control);
915 usb_set_intfdata(intf, NULL);
918 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
920 /* Return the number of the MBIM control interface altsetting iff it
921 * is preferred and available,
923 u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
925 struct usb_host_interface *alt;
927 /* The MBIM spec defines a NCM compatible default altsetting,
928 * which we may have matched:
930 * "Functions that implement both NCM 1.0 and MBIM (an
931 * “NCM/MBIM function”) according to this recommendation
932 * shall provide two alternate settings for the
933 * Communication Interface. Alternate setting 0, and the
934 * associated class and endpoint descriptors, shall be
935 * constructed according to the rules given for the
936 * Communication Interface in section 5 of [USBNCM10].
937 * Alternate setting 1, and the associated class and
938 * endpoint descriptors, shall be constructed according to
939 * the rules given in section 6 (USB Device Model) of this
942 if (intf->num_altsetting < 2)
943 return intf->cur_altsetting->desc.bAlternateSetting;
946 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
947 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
948 return CDC_NCM_COMM_ALTSETTING_MBIM;
950 return CDC_NCM_COMM_ALTSETTING_NCM;
952 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
954 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
958 /* MBIM backwards compatible function? */
959 if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
962 /* The NCM data altsetting is fixed, so we hard-coded it.
963 * Additionally, generic NCM devices are assumed to accept arbitrarily
966 ret = cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM, 0);
969 * We should get an event when network connection is "connected" or
970 * "disconnected". Set network connection in "disconnected" state
971 * (carrier is OFF) during attach, so the IP network stack does not
972 * start IPv6 negotiation and more.
974 usbnet_link_change(dev, 0, 0);
978 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
980 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
982 if (skb->len + align > max)
983 align = max - skb->len;
984 if (align && skb_tailroom(skb) >= align)
985 memset(skb_put(skb, align), 0, align);
988 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
989 * allocating a new one within skb
991 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
993 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
994 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
995 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
997 /* If NDP should be moved to the end of the NCM package, we can't follow the
998 * NTH16 header as we would normally do. NDP isn't written to the SKB yet, and
999 * the wNdpIndex field in the header is actually not consistent with reality. It will be later.
1001 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1002 if (ctx->delayed_ndp16->dwSignature == sign)
1003 return ctx->delayed_ndp16;
1005 /* follow the chain of NDPs, looking for a match */
1007 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
1008 if (ndp16->dwSignature == sign)
1010 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1014 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1015 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1017 /* verify that there is room for the NDP and the datagram (reserve) */
1018 if ((ctx->tx_max - skb->len - reserve) < ctx->max_ndp_size)
1023 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
1025 nth16->wNdpIndex = cpu_to_le16(skb->len);
1027 /* push a new empty NDP */
1028 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1029 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, ctx->max_ndp_size);
1031 ndp16 = ctx->delayed_ndp16;
1033 ndp16->dwSignature = sign;
1034 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
1039 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
1041 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1042 struct usb_cdc_ncm_nth16 *nth16;
1043 struct usb_cdc_ncm_ndp16 *ndp16;
1044 struct sk_buff *skb_out;
1045 u16 n = 0, index, ndplen;
1047 u32 delayed_ndp_size;
1049 /* When our NDP gets written in cdc_ncm_ndp(), then skb_out->len gets updated
1050 * accordingly. Otherwise, we should check here.
1052 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1053 delayed_ndp_size = ctx->max_ndp_size;
1055 delayed_ndp_size = 0;
1057 /* if there is a remaining skb, it gets priority */
1059 swap(skb, ctx->tx_rem_skb);
1060 swap(sign, ctx->tx_rem_sign);
1065 /* check if we are resuming an OUT skb */
1066 skb_out = ctx->tx_curr_skb;
1068 /* allocate a new OUT skb */
1070 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
1071 if (skb_out == NULL) {
1073 dev_kfree_skb_any(skb);
1074 dev->net->stats.tx_dropped++;
1078 /* fill out the initial 16-bit NTB header */
1079 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
1080 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1081 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1082 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
1084 /* count total number of frames in this NTB */
1085 ctx->tx_curr_frame_num = 0;
1087 /* recent payload counter for this skb_out */
1088 ctx->tx_curr_frame_payload = 0;
1091 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1092 /* send any remaining skb first */
1094 skb = ctx->tx_rem_skb;
1095 sign = ctx->tx_rem_sign;
1096 ctx->tx_rem_skb = NULL;
1098 /* check for end of skb */
1103 /* get the appropriate NDP for this skb */
1104 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1106 /* align beginning of next frame */
1107 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
1109 /* check if we had enough room left for both NDP and frame */
1110 if (!ndp16 || skb_out->len + skb->len + delayed_ndp_size > ctx->tx_max) {
1112 /* won't fit, MTU problem? */
1113 dev_kfree_skb_any(skb);
1115 dev->net->stats.tx_dropped++;
1117 /* no room for skb - store for later */
1118 if (ctx->tx_rem_skb != NULL) {
1119 dev_kfree_skb_any(ctx->tx_rem_skb);
1120 dev->net->stats.tx_dropped++;
1122 ctx->tx_rem_skb = skb;
1123 ctx->tx_rem_sign = sign;
1126 ctx->tx_reason_ntb_full++; /* count reason for transmitting */
1131 /* calculate frame number withing this NDP */
1132 ndplen = le16_to_cpu(ndp16->wLength);
1133 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
1135 /* OK, add this skb */
1136 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1137 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1138 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
1139 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
1140 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
1141 dev_kfree_skb_any(skb);
1144 /* send now if this NDP is full */
1145 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1147 ctx->tx_reason_ndp_full++; /* count reason for transmitting */
1152 /* free up any dangling skb */
1154 dev_kfree_skb_any(skb);
1156 dev->net->stats.tx_dropped++;
1159 ctx->tx_curr_frame_num = n;
1162 /* wait for more frames */
1163 /* push variables */
1164 ctx->tx_curr_skb = skb_out;
1167 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1168 /* wait for more frames */
1169 /* push variables */
1170 ctx->tx_curr_skb = skb_out;
1171 /* set the pending count */
1172 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1173 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1177 if (n == ctx->tx_max_datagrams)
1178 ctx->tx_reason_max_datagram++; /* count reason for transmitting */
1179 /* frame goes out */
1180 /* variables will be reset at next call */
1183 /* If requested, put NDP at end of frame. */
1184 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1185 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1186 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1187 nth16->wNdpIndex = cpu_to_le16(skb_out->len);
1188 memcpy(skb_put(skb_out, ctx->max_ndp_size), ctx->delayed_ndp16, ctx->max_ndp_size);
1190 /* Zero out delayed NDP - signature checking will naturally fail. */
1191 ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1194 /* If collected data size is less or equal ctx->min_tx_pkt
1195 * bytes, we send buffers as it is. If we get more data, it
1196 * would be more efficient for USB HS mobile device with DMA
1197 * engine to receive a full size NTB, than canceling DMA
1198 * transfer and receiving a short packet.
1200 * This optimization support is pointless if we end up sending
1201 * a ZLP after full sized NTBs.
1203 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1204 skb_out->len > ctx->min_tx_pkt)
1205 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
1206 ctx->tx_max - skb_out->len);
1207 else if (skb_out->len < ctx->tx_max && (skb_out->len % dev->maxpacket) == 0)
1208 *skb_put(skb_out, 1) = 0; /* force short packet */
1210 /* set final frame length */
1211 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1212 nth16->wBlockLength = cpu_to_le16(skb_out->len);
1215 ctx->tx_curr_skb = NULL;
1217 /* keep private stats: framing overhead and number of NTBs */
1218 ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1221 /* usbnet will count all the framing overhead by default.
1222 * Adjust the stats so that the tx_bytes counter show real
1223 * payload data instead.
1225 usbnet_set_skb_tx_stats(skb_out, n,
1226 (long)ctx->tx_curr_frame_payload - skb_out->len);
1231 /* Start timer, if there is a remaining non-empty skb */
1232 if (ctx->tx_curr_skb != NULL && n > 0)
1233 cdc_ncm_tx_timeout_start(ctx);
1236 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1238 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1240 /* start timer, if not already started */
1241 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1242 hrtimer_start(&ctx->tx_timer,
1243 ktime_set(0, ctx->timer_interval),
1247 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1249 struct cdc_ncm_ctx *ctx =
1250 container_of(timer, struct cdc_ncm_ctx, tx_timer);
1252 if (!atomic_read(&ctx->stop))
1253 tasklet_schedule(&ctx->bh);
1254 return HRTIMER_NORESTART;
1257 static void cdc_ncm_txpath_bh(unsigned long param)
1259 struct usbnet *dev = (struct usbnet *)param;
1260 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1262 spin_lock_bh(&ctx->mtx);
1263 if (ctx->tx_timer_pending != 0) {
1264 ctx->tx_timer_pending--;
1265 cdc_ncm_tx_timeout_start(ctx);
1266 spin_unlock_bh(&ctx->mtx);
1267 } else if (dev->net != NULL) {
1268 ctx->tx_reason_timeout++; /* count reason for transmitting */
1269 spin_unlock_bh(&ctx->mtx);
1270 netif_tx_lock_bh(dev->net);
1271 usbnet_start_xmit(NULL, dev->net);
1272 netif_tx_unlock_bh(dev->net);
1274 spin_unlock_bh(&ctx->mtx);
1279 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1281 struct sk_buff *skb_out;
1282 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1285 * The Ethernet API we are using does not support transmitting
1286 * multiple Ethernet frames in a single call. This driver will
1287 * accumulate multiple Ethernet frames and send out a larger
1288 * USB frame when the USB buffer is full or when a single jiffies
1294 spin_lock_bh(&ctx->mtx);
1295 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1296 spin_unlock_bh(&ctx->mtx);
1301 dev_kfree_skb_any(skb);
1305 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1307 /* verify NTB header and return offset of first NDP, or negative error */
1308 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1310 struct usbnet *dev = netdev_priv(skb_in->dev);
1311 struct usb_cdc_ncm_nth16 *nth16;
1318 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1319 sizeof(struct usb_cdc_ncm_ndp16))) {
1320 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1324 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1326 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1327 netif_dbg(dev, rx_err, dev->net,
1328 "invalid NTH16 signature <%#010x>\n",
1329 le32_to_cpu(nth16->dwSignature));
1333 len = le16_to_cpu(nth16->wBlockLength);
1334 if (len > ctx->rx_max) {
1335 netif_dbg(dev, rx_err, dev->net,
1336 "unsupported NTB block length %u/%u\n", len,
1341 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1342 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1343 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1344 netif_dbg(dev, rx_err, dev->net,
1345 "sequence number glitch prev=%d curr=%d\n",
1346 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1348 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1350 ret = le16_to_cpu(nth16->wNdpIndex);
1354 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1356 /* verify NDP header and return number of datagrams, or negative error */
1357 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1359 struct usbnet *dev = netdev_priv(skb_in->dev);
1360 struct usb_cdc_ncm_ndp16 *ndp16;
1363 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1364 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1368 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1370 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1371 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1372 le16_to_cpu(ndp16->wLength));
1376 ret = ((le16_to_cpu(ndp16->wLength) -
1377 sizeof(struct usb_cdc_ncm_ndp16)) /
1378 sizeof(struct usb_cdc_ncm_dpe16));
1379 ret--; /* we process NDP entries except for the last one */
1381 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1382 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1383 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1390 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1392 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1394 struct sk_buff *skb;
1395 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1400 struct usb_cdc_ncm_ndp16 *ndp16;
1401 struct usb_cdc_ncm_dpe16 *dpe16;
1403 int loopcount = 50; /* arbitrary max preventing infinite loop */
1406 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1411 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1415 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1417 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1418 netif_dbg(dev, rx_err, dev->net,
1419 "invalid DPT16 signature <%#010x>\n",
1420 le32_to_cpu(ndp16->dwSignature));
1423 dpe16 = ndp16->dpe16;
1425 for (x = 0; x < nframes; x++, dpe16++) {
1426 offset = le16_to_cpu(dpe16->wDatagramIndex);
1427 len = le16_to_cpu(dpe16->wDatagramLength);
1431 * All entries after first NULL entry are to be ignored
1433 if ((offset == 0) || (len == 0)) {
1435 goto err_ndp; /* empty NTB */
1439 /* sanity checking */
1440 if (((offset + len) > skb_in->len) ||
1441 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1442 netif_dbg(dev, rx_err, dev->net,
1443 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1444 x, offset, len, skb_in);
1450 /* create a fresh copy to reduce truesize */
1451 skb = netdev_alloc_skb_ip_align(dev->net, len);
1454 memcpy(skb_put(skb, len), skb_in->data + offset, len);
1455 usbnet_skb_return(dev, skb);
1456 payload += len; /* count payload bytes in this NTB */
1460 /* are there more NDPs to process? */
1461 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1462 if (ndpoffset && loopcount--)
1466 ctx->rx_overhead += skb_in->len - payload;
1473 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1476 cdc_ncm_speed_change(struct usbnet *dev,
1477 struct usb_cdc_speed_change *data)
1479 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1480 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1483 * Currently the USB-NET API does not support reporting the actual
1484 * device speed. Do print it instead.
1486 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1487 netif_info(dev, link, dev->net,
1488 "%u mbit/s downlink %u mbit/s uplink\n",
1489 (unsigned int)(rx_speed / 1000000U),
1490 (unsigned int)(tx_speed / 1000000U));
1492 netif_info(dev, link, dev->net,
1493 "%u kbit/s downlink %u kbit/s uplink\n",
1494 (unsigned int)(rx_speed / 1000U),
1495 (unsigned int)(tx_speed / 1000U));
1499 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1501 struct cdc_ncm_ctx *ctx;
1502 struct usb_cdc_notification *event;
1504 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1506 if (urb->actual_length < sizeof(*event))
1509 /* test for split data in 8-byte chunks */
1510 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1511 cdc_ncm_speed_change(dev,
1512 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1516 event = urb->transfer_buffer;
1518 switch (event->bNotificationType) {
1519 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1521 * According to the CDC NCM specification ch.7.1
1522 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1523 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1525 netif_info(dev, link, dev->net,
1526 "network connection: %sconnected\n",
1527 !!event->wValue ? "" : "dis");
1528 usbnet_link_change(dev, !!event->wValue, 0);
1531 case USB_CDC_NOTIFY_SPEED_CHANGE:
1532 if (urb->actual_length < (sizeof(*event) +
1533 sizeof(struct usb_cdc_speed_change)))
1534 set_bit(EVENT_STS_SPLIT, &dev->flags);
1536 cdc_ncm_speed_change(dev,
1537 (struct usb_cdc_speed_change *)&event[1]);
1541 dev_dbg(&dev->udev->dev,
1542 "NCM: unexpected notification 0x%02x!\n",
1543 event->bNotificationType);
1548 static const struct driver_info cdc_ncm_info = {
1549 .description = "CDC NCM",
1550 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1551 .bind = cdc_ncm_bind,
1552 .unbind = cdc_ncm_unbind,
1553 .manage_power = usbnet_manage_power,
1554 .status = cdc_ncm_status,
1555 .rx_fixup = cdc_ncm_rx_fixup,
1556 .tx_fixup = cdc_ncm_tx_fixup,
1559 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1560 static const struct driver_info wwan_info = {
1561 .description = "Mobile Broadband Network Device",
1562 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1564 .bind = cdc_ncm_bind,
1565 .unbind = cdc_ncm_unbind,
1566 .manage_power = usbnet_manage_power,
1567 .status = cdc_ncm_status,
1568 .rx_fixup = cdc_ncm_rx_fixup,
1569 .tx_fixup = cdc_ncm_tx_fixup,
1572 /* Same as wwan_info, but with FLAG_NOARP */
1573 static const struct driver_info wwan_noarp_info = {
1574 .description = "Mobile Broadband Network Device (NO ARP)",
1575 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1576 | FLAG_WWAN | FLAG_NOARP,
1577 .bind = cdc_ncm_bind,
1578 .unbind = cdc_ncm_unbind,
1579 .manage_power = usbnet_manage_power,
1580 .status = cdc_ncm_status,
1581 .rx_fixup = cdc_ncm_rx_fixup,
1582 .tx_fixup = cdc_ncm_tx_fixup,
1585 static const struct usb_device_id cdc_devs[] = {
1586 /* Ericsson MBM devices like F5521gw */
1587 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1588 | USB_DEVICE_ID_MATCH_VENDOR,
1590 .bInterfaceClass = USB_CLASS_COMM,
1591 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1592 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1593 .driver_info = (unsigned long) &wwan_info,
1596 /* Dell branded MBM devices like DW5550 */
1597 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1598 | USB_DEVICE_ID_MATCH_VENDOR,
1600 .bInterfaceClass = USB_CLASS_COMM,
1601 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1602 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1603 .driver_info = (unsigned long) &wwan_info,
1606 /* Toshiba branded MBM devices */
1607 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1608 | USB_DEVICE_ID_MATCH_VENDOR,
1610 .bInterfaceClass = USB_CLASS_COMM,
1611 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1612 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1613 .driver_info = (unsigned long) &wwan_info,
1616 /* tag Huawei devices as wwan */
1617 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1619 USB_CDC_SUBCLASS_NCM,
1620 USB_CDC_PROTO_NONE),
1621 .driver_info = (unsigned long)&wwan_info,
1624 /* Infineon(now Intel) HSPA Modem platform */
1625 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1627 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1628 .driver_info = (unsigned long)&wwan_noarp_info,
1631 /* Generic CDC-NCM devices */
1632 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1633 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1634 .driver_info = (unsigned long)&cdc_ncm_info,
1639 MODULE_DEVICE_TABLE(usb, cdc_devs);
1641 static struct usb_driver cdc_ncm_driver = {
1643 .id_table = cdc_devs,
1644 .probe = usbnet_probe,
1645 .disconnect = usbnet_disconnect,
1646 .suspend = usbnet_suspend,
1647 .resume = usbnet_resume,
1648 .reset_resume = usbnet_resume,
1649 .supports_autosuspend = 1,
1650 .disable_hub_initiated_lpm = 1,
1653 module_usb_driver(cdc_ncm_driver);
1655 MODULE_AUTHOR("Hans Petter Selasky");
1656 MODULE_DESCRIPTION("USB CDC NCM host driver");
1657 MODULE_LICENSE("Dual BSD/GPL");