4 * Copyright (C) ST-Ericsson 2010-2012
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 #define NCM_PARM_ATTR(name, format, tocpu) \
287 static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
289 struct usbnet *dev = netdev_priv(to_net_dev(d)); \
290 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
291 return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name)); \
293 static DEVICE_ATTR(name, S_IRUGO, cdc_ncm_show_##name, NULL)
295 NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
296 NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
297 NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
298 NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
299 NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
300 NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
301 NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
302 NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
303 NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
304 NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
306 static struct attribute *cdc_ncm_sysfs_attrs[] = {
307 &dev_attr_min_tx_pkt.attr,
308 &dev_attr_rx_max.attr,
309 &dev_attr_tx_max.attr,
310 &dev_attr_tx_timer_usecs.attr,
311 &dev_attr_bmNtbFormatsSupported.attr,
312 &dev_attr_dwNtbInMaxSize.attr,
313 &dev_attr_wNdpInDivisor.attr,
314 &dev_attr_wNdpInPayloadRemainder.attr,
315 &dev_attr_wNdpInAlignment.attr,
316 &dev_attr_dwNtbOutMaxSize.attr,
317 &dev_attr_wNdpOutDivisor.attr,
318 &dev_attr_wNdpOutPayloadRemainder.attr,
319 &dev_attr_wNdpOutAlignment.attr,
320 &dev_attr_wNtbOutMaxDatagrams.attr,
324 static struct attribute_group cdc_ncm_sysfs_attr_group = {
326 .attrs = cdc_ncm_sysfs_attrs,
329 /* handle rx_max and tx_max changes */
330 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
332 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
333 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
336 val = cdc_ncm_check_rx_max(dev, new_rx);
338 /* inform device about NTB input size changes */
339 if (val != ctx->rx_max) {
340 __le32 dwNtbInMaxSize = cpu_to_le32(val);
342 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
344 /* tell device to use new size */
345 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
346 USB_TYPE_CLASS | USB_DIR_OUT
347 | USB_RECIP_INTERFACE,
348 0, iface_no, &dwNtbInMaxSize, 4) < 0)
349 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
354 /* usbnet use these values for sizing rx queues */
355 if (dev->rx_urb_size != ctx->rx_max) {
356 dev->rx_urb_size = ctx->rx_max;
357 if (netif_running(dev->net))
358 usbnet_unlink_rx_urbs(dev);
361 val = cdc_ncm_check_tx_max(dev, new_tx);
362 if (val != ctx->tx_max)
363 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
365 /* Adding a pad byte here if necessary simplifies the handling
366 * in cdc_ncm_fill_tx_frame, making tx_max always represent
367 * the real skb max size.
369 * We cannot use dev->maxpacket here because this is called from
370 * .bind which is called before usbnet sets up dev->maxpacket
372 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
373 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
376 /* we might need to flush any pending tx buffers if running */
377 if (netif_running(dev->net) && val > ctx->tx_max) {
378 netif_tx_lock_bh(dev->net);
379 usbnet_start_xmit(NULL, dev->net);
380 /* make sure tx_curr_skb is reallocated if it was empty */
381 if (ctx->tx_curr_skb) {
382 dev_kfree_skb_any(ctx->tx_curr_skb);
383 ctx->tx_curr_skb = NULL;
386 netif_tx_unlock_bh(dev->net);
391 dev->hard_mtu = ctx->tx_max;
393 /* max qlen depend on hard_mtu and rx_urb_size */
394 usbnet_update_max_qlen(dev);
396 /* never pad more than 3 full USB packets per transfer */
397 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
398 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
401 /* helpers for NCM and MBIM differences */
402 static u8 cdc_ncm_flags(struct usbnet *dev)
404 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
406 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
407 return ctx->mbim_desc->bmNetworkCapabilities;
409 return ctx->func_desc->bmNetworkCapabilities;
413 static int cdc_ncm_eth_hlen(struct usbnet *dev)
415 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
420 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
422 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
423 return CDC_MBIM_MIN_DATAGRAM_SIZE;
424 return CDC_NCM_MIN_DATAGRAM_SIZE;
427 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
429 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
431 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
432 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
434 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
435 return CDC_NCM_MAX_DATAGRAM_SIZE;
438 /* initial one-time device setup. MUST be called with the data interface
441 static int cdc_ncm_init(struct usbnet *dev)
443 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
444 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
447 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
448 USB_TYPE_CLASS | USB_DIR_IN
449 |USB_RECIP_INTERFACE,
450 0, iface_no, &ctx->ncm_parm,
451 sizeof(ctx->ncm_parm));
453 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
454 return err; /* GET_NTB_PARAMETERS is required */
458 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
459 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
460 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
461 USB_TYPE_CLASS | USB_DIR_OUT
462 | USB_RECIP_INTERFACE,
463 USB_CDC_NCM_CRC_NOT_APPENDED,
466 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
469 /* set NTB format, if both formats are supported.
471 * "The host shall only send this command while the NCM Data
472 * Interface is in alternate setting 0."
474 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
475 USB_CDC_NCM_NTB32_SUPPORTED) {
476 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
477 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
478 USB_TYPE_CLASS | USB_DIR_OUT
479 | USB_RECIP_INTERFACE,
480 USB_CDC_NCM_NTB16_FORMAT,
483 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
486 /* set initial device values */
487 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
488 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
489 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
490 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
491 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
492 /* devices prior to NCM Errata shall set this field to zero */
493 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
495 dev_dbg(&dev->intf->dev,
496 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
497 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
498 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
500 /* max count of tx datagrams */
501 if ((ctx->tx_max_datagrams == 0) ||
502 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
503 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
505 /* set up maximum NDP size */
506 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
508 /* initial coalescing timer interval */
509 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
514 /* set a new max datagram size */
515 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
517 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
518 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
519 __le16 max_datagram_size;
523 /* set default based on descriptors */
524 ctx->max_datagram_size = clamp_t(u32, new_size,
525 cdc_ncm_min_dgram_size(dev),
526 CDC_NCM_MAX_DATAGRAM_SIZE);
528 /* inform the device about the selected Max Datagram Size? */
529 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
532 /* read current mtu value from device */
533 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
534 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
535 0, iface_no, &max_datagram_size, 2);
537 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
541 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
544 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
545 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
546 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
547 0, iface_no, &max_datagram_size, 2);
549 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
552 /* set MTU to max supported by the device if necessary */
553 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
555 /* do not exceed operater preferred MTU */
556 if (ctx->mbim_extended_desc) {
557 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
558 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
559 dev->net->mtu = mbim_mtu;
563 static void cdc_ncm_fix_modulus(struct usbnet *dev)
565 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
569 * verify that the structure alignment is:
571 * - not greater than the maximum transmit length
572 * - not less than four bytes
574 val = ctx->tx_ndp_modulus;
576 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
577 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
578 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
579 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
583 * verify that the payload alignment is:
585 * - not greater than the maximum transmit length
586 * - not less than four bytes
588 val = ctx->tx_modulus;
590 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
591 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
592 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
593 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
596 /* verify the payload remainder */
597 if (ctx->tx_remainder >= ctx->tx_modulus) {
598 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
599 ctx->tx_remainder = 0;
602 /* adjust TX-remainder according to NCM specification. */
603 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
604 (ctx->tx_modulus - 1));
607 static int cdc_ncm_setup(struct usbnet *dev)
609 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
612 /* be conservative when selecting intial buffer size to
613 * increase the number of hosts this will work for
615 def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
616 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
617 def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
618 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
620 /* clamp rx_max and tx_max and inform device */
621 cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
623 /* sanitize the modulus and remainder values */
624 cdc_ncm_fix_modulus(dev);
626 /* set max datagram size */
627 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
632 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
634 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
637 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
639 e = intf->cur_altsetting->endpoint + ep;
640 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
641 case USB_ENDPOINT_XFER_INT:
642 if (usb_endpoint_dir_in(&e->desc)) {
648 case USB_ENDPOINT_XFER_BULK:
649 if (usb_endpoint_dir_in(&e->desc)) {
663 dev->in = usb_rcvbulkpipe(dev->udev,
664 in->desc.bEndpointAddress &
665 USB_ENDPOINT_NUMBER_MASK);
666 if (out && !dev->out)
667 dev->out = usb_sndbulkpipe(dev->udev,
668 out->desc.bEndpointAddress &
669 USB_ENDPOINT_NUMBER_MASK);
672 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
677 if (ctx->tx_rem_skb != NULL) {
678 dev_kfree_skb_any(ctx->tx_rem_skb);
679 ctx->tx_rem_skb = NULL;
682 if (ctx->tx_curr_skb != NULL) {
683 dev_kfree_skb_any(ctx->tx_curr_skb);
684 ctx->tx_curr_skb = NULL;
687 kfree(ctx->delayed_ndp16);
692 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
694 const struct usb_cdc_union_desc *union_desc = NULL;
695 struct cdc_ncm_ctx *ctx;
696 struct usb_driver *driver;
702 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
706 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
707 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
708 ctx->bh.data = (unsigned long)dev;
709 ctx->bh.func = cdc_ncm_txpath_bh;
710 atomic_set(&ctx->stop, 0);
711 spin_lock_init(&ctx->mtx);
713 /* store ctx pointer in device data field */
714 dev->data[0] = (unsigned long)ctx;
716 /* only the control interface can be successfully probed */
719 /* get some pointers */
720 driver = driver_of(intf);
721 buf = intf->cur_altsetting->extra;
722 len = intf->cur_altsetting->extralen;
724 /* parse through descriptors associated with control interface */
725 while ((len > 0) && (buf[0] > 2) && (buf[0] <= len)) {
727 if (buf[1] != USB_DT_CS_INTERFACE)
731 case USB_CDC_UNION_TYPE:
732 if (buf[0] < sizeof(*union_desc))
735 union_desc = (const struct usb_cdc_union_desc *)buf;
736 /* the master must be the interface we are probing */
737 if (intf->cur_altsetting->desc.bInterfaceNumber !=
738 union_desc->bMasterInterface0) {
739 dev_dbg(&intf->dev, "bogus CDC Union\n");
742 ctx->data = usb_ifnum_to_if(dev->udev,
743 union_desc->bSlaveInterface0);
746 case USB_CDC_ETHERNET_TYPE:
747 if (buf[0] < sizeof(*(ctx->ether_desc)))
751 (const struct usb_cdc_ether_desc *)buf;
754 case USB_CDC_NCM_TYPE:
755 if (buf[0] < sizeof(*(ctx->func_desc)))
758 ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
761 case USB_CDC_MBIM_TYPE:
762 if (buf[0] < sizeof(*(ctx->mbim_desc)))
765 ctx->mbim_desc = (const struct usb_cdc_mbim_desc *)buf;
768 case USB_CDC_MBIM_EXTENDED_TYPE:
769 if (buf[0] < sizeof(*(ctx->mbim_extended_desc)))
772 ctx->mbim_extended_desc =
773 (const struct usb_cdc_mbim_extended_desc *)buf;
780 /* advance to next descriptor */
786 /* some buggy devices have an IAD but no CDC Union */
787 if (!union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
788 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
789 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
792 /* check if we got everything */
794 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
797 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
798 if (!ctx->mbim_desc) {
799 dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
803 if (!ctx->ether_desc || !ctx->func_desc) {
804 dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
809 /* claim data interface, if different from control */
810 if (ctx->data != ctx->control) {
811 temp = usb_driver_claim_interface(driver, ctx->data, dev);
813 dev_dbg(&intf->dev, "failed to claim data intf\n");
818 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
820 /* reset data interface */
821 temp = usb_set_interface(dev->udev, iface_no, 0);
823 dev_dbg(&intf->dev, "set interface failed\n");
827 /* initialize basic device settings */
828 if (cdc_ncm_init(dev))
831 /* configure data interface */
832 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
834 dev_dbg(&intf->dev, "set interface failed\n");
838 cdc_ncm_find_endpoints(dev, ctx->data);
839 cdc_ncm_find_endpoints(dev, ctx->control);
840 if (!dev->in || !dev->out || !dev->status) {
841 dev_dbg(&intf->dev, "failed to collect endpoints\n");
845 usb_set_intfdata(ctx->data, dev);
846 usb_set_intfdata(ctx->control, dev);
848 if (ctx->ether_desc) {
849 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
851 dev_dbg(&intf->dev, "failed to get mac address\n");
854 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
857 /* finish setting up the device specific data */
860 /* Device-specific flags */
861 ctx->drvflags = drvflags;
863 /* Allocate the delayed NDP if needed. */
864 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
865 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
866 if (!ctx->delayed_ndp16)
868 dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
871 /* override ethtool_ops */
872 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
874 /* add our sysfs attrs */
875 dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
880 usb_set_intfdata(ctx->control, NULL);
881 usb_set_intfdata(ctx->data, NULL);
882 if (ctx->data != ctx->control)
883 usb_driver_release_interface(driver, ctx->data);
885 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
887 dev_info(&intf->dev, "bind() failure\n");
890 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
892 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
894 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
895 struct usb_driver *driver = driver_of(intf);
898 return; /* no setup */
900 atomic_set(&ctx->stop, 1);
902 if (hrtimer_active(&ctx->tx_timer))
903 hrtimer_cancel(&ctx->tx_timer);
905 tasklet_kill(&ctx->bh);
907 /* handle devices with combined control and data interface */
908 if (ctx->control == ctx->data)
911 /* disconnect master --> disconnect slave */
912 if (intf == ctx->control && ctx->data) {
913 usb_set_intfdata(ctx->data, NULL);
914 usb_driver_release_interface(driver, ctx->data);
917 } else if (intf == ctx->data && ctx->control) {
918 usb_set_intfdata(ctx->control, NULL);
919 usb_driver_release_interface(driver, ctx->control);
923 usb_set_intfdata(intf, NULL);
926 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
928 /* Return the number of the MBIM control interface altsetting iff it
929 * is preferred and available,
931 u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
933 struct usb_host_interface *alt;
935 /* The MBIM spec defines a NCM compatible default altsetting,
936 * which we may have matched:
938 * "Functions that implement both NCM 1.0 and MBIM (an
939 * “NCM/MBIM function”) according to this recommendation
940 * shall provide two alternate settings for the
941 * Communication Interface. Alternate setting 0, and the
942 * associated class and endpoint descriptors, shall be
943 * constructed according to the rules given for the
944 * Communication Interface in section 5 of [USBNCM10].
945 * Alternate setting 1, and the associated class and
946 * endpoint descriptors, shall be constructed according to
947 * the rules given in section 6 (USB Device Model) of this
950 if (intf->num_altsetting < 2)
951 return intf->cur_altsetting->desc.bAlternateSetting;
954 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
955 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
956 return CDC_NCM_COMM_ALTSETTING_MBIM;
958 return CDC_NCM_COMM_ALTSETTING_NCM;
960 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
962 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
966 /* MBIM backwards compatible function? */
967 if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
970 /* The NCM data altsetting is fixed, so we hard-coded it.
971 * Additionally, generic NCM devices are assumed to accept arbitrarily
974 ret = cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM, 0);
977 * We should get an event when network connection is "connected" or
978 * "disconnected". Set network connection in "disconnected" state
979 * (carrier is OFF) during attach, so the IP network stack does not
980 * start IPv6 negotiation and more.
982 usbnet_link_change(dev, 0, 0);
986 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
988 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
990 if (skb->len + align > max)
991 align = max - skb->len;
992 if (align && skb_tailroom(skb) >= align)
993 memset(skb_put(skb, align), 0, align);
996 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
997 * allocating a new one within skb
999 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
1001 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
1002 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
1003 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
1005 /* If NDP should be moved to the end of the NCM package, we can't follow the
1006 * NTH16 header as we would normally do. NDP isn't written to the SKB yet, and
1007 * the wNdpIndex field in the header is actually not consistent with reality. It will be later.
1009 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1010 if (ctx->delayed_ndp16->dwSignature == sign)
1011 return ctx->delayed_ndp16;
1013 /* follow the chain of NDPs, looking for a match */
1015 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
1016 if (ndp16->dwSignature == sign)
1018 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1022 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1023 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1025 /* verify that there is room for the NDP and the datagram (reserve) */
1026 if ((ctx->tx_max - skb->len - reserve) < ctx->max_ndp_size)
1031 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
1033 nth16->wNdpIndex = cpu_to_le16(skb->len);
1035 /* push a new empty NDP */
1036 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1037 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, ctx->max_ndp_size);
1039 ndp16 = ctx->delayed_ndp16;
1041 ndp16->dwSignature = sign;
1042 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
1047 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
1049 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1050 struct usb_cdc_ncm_nth16 *nth16;
1051 struct usb_cdc_ncm_ndp16 *ndp16;
1052 struct sk_buff *skb_out;
1053 u16 n = 0, index, ndplen;
1055 u32 delayed_ndp_size;
1057 /* When our NDP gets written in cdc_ncm_ndp(), then skb_out->len gets updated
1058 * accordingly. Otherwise, we should check here.
1060 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1061 delayed_ndp_size = ctx->max_ndp_size;
1063 delayed_ndp_size = 0;
1065 /* if there is a remaining skb, it gets priority */
1067 swap(skb, ctx->tx_rem_skb);
1068 swap(sign, ctx->tx_rem_sign);
1073 /* check if we are resuming an OUT skb */
1074 skb_out = ctx->tx_curr_skb;
1076 /* allocate a new OUT skb */
1078 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
1079 if (skb_out == NULL) {
1081 dev_kfree_skb_any(skb);
1082 dev->net->stats.tx_dropped++;
1086 /* fill out the initial 16-bit NTB header */
1087 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
1088 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1089 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1090 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
1092 /* count total number of frames in this NTB */
1093 ctx->tx_curr_frame_num = 0;
1095 /* recent payload counter for this skb_out */
1096 ctx->tx_curr_frame_payload = 0;
1099 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1100 /* send any remaining skb first */
1102 skb = ctx->tx_rem_skb;
1103 sign = ctx->tx_rem_sign;
1104 ctx->tx_rem_skb = NULL;
1106 /* check for end of skb */
1111 /* get the appropriate NDP for this skb */
1112 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1114 /* align beginning of next frame */
1115 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
1117 /* check if we had enough room left for both NDP and frame */
1118 if (!ndp16 || skb_out->len + skb->len + delayed_ndp_size > ctx->tx_max) {
1120 /* won't fit, MTU problem? */
1121 dev_kfree_skb_any(skb);
1123 dev->net->stats.tx_dropped++;
1125 /* no room for skb - store for later */
1126 if (ctx->tx_rem_skb != NULL) {
1127 dev_kfree_skb_any(ctx->tx_rem_skb);
1128 dev->net->stats.tx_dropped++;
1130 ctx->tx_rem_skb = skb;
1131 ctx->tx_rem_sign = sign;
1134 ctx->tx_reason_ntb_full++; /* count reason for transmitting */
1139 /* calculate frame number withing this NDP */
1140 ndplen = le16_to_cpu(ndp16->wLength);
1141 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
1143 /* OK, add this skb */
1144 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1145 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1146 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
1147 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
1148 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
1149 dev_kfree_skb_any(skb);
1152 /* send now if this NDP is full */
1153 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1155 ctx->tx_reason_ndp_full++; /* count reason for transmitting */
1160 /* free up any dangling skb */
1162 dev_kfree_skb_any(skb);
1164 dev->net->stats.tx_dropped++;
1167 ctx->tx_curr_frame_num = n;
1170 /* wait for more frames */
1171 /* push variables */
1172 ctx->tx_curr_skb = skb_out;
1175 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1176 /* wait for more frames */
1177 /* push variables */
1178 ctx->tx_curr_skb = skb_out;
1179 /* set the pending count */
1180 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1181 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1185 if (n == ctx->tx_max_datagrams)
1186 ctx->tx_reason_max_datagram++; /* count reason for transmitting */
1187 /* frame goes out */
1188 /* variables will be reset at next call */
1191 /* If requested, put NDP at end of frame. */
1192 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1193 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1194 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1195 nth16->wNdpIndex = cpu_to_le16(skb_out->len);
1196 memcpy(skb_put(skb_out, ctx->max_ndp_size), ctx->delayed_ndp16, ctx->max_ndp_size);
1198 /* Zero out delayed NDP - signature checking will naturally fail. */
1199 ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1202 /* If collected data size is less or equal ctx->min_tx_pkt
1203 * bytes, we send buffers as it is. If we get more data, it
1204 * would be more efficient for USB HS mobile device with DMA
1205 * engine to receive a full size NTB, than canceling DMA
1206 * transfer and receiving a short packet.
1208 * This optimization support is pointless if we end up sending
1209 * a ZLP after full sized NTBs.
1211 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1212 skb_out->len > ctx->min_tx_pkt)
1213 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
1214 ctx->tx_max - skb_out->len);
1215 else if (skb_out->len < ctx->tx_max && (skb_out->len % dev->maxpacket) == 0)
1216 *skb_put(skb_out, 1) = 0; /* force short packet */
1218 /* set final frame length */
1219 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1220 nth16->wBlockLength = cpu_to_le16(skb_out->len);
1223 ctx->tx_curr_skb = NULL;
1225 /* keep private stats: framing overhead and number of NTBs */
1226 ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1229 /* usbnet will count all the framing overhead by default.
1230 * Adjust the stats so that the tx_bytes counter show real
1231 * payload data instead.
1233 usbnet_set_skb_tx_stats(skb_out, n,
1234 (long)ctx->tx_curr_frame_payload - skb_out->len);
1239 /* Start timer, if there is a remaining non-empty skb */
1240 if (ctx->tx_curr_skb != NULL && n > 0)
1241 cdc_ncm_tx_timeout_start(ctx);
1244 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1246 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1248 /* start timer, if not already started */
1249 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1250 hrtimer_start(&ctx->tx_timer,
1251 ktime_set(0, ctx->timer_interval),
1255 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1257 struct cdc_ncm_ctx *ctx =
1258 container_of(timer, struct cdc_ncm_ctx, tx_timer);
1260 if (!atomic_read(&ctx->stop))
1261 tasklet_schedule(&ctx->bh);
1262 return HRTIMER_NORESTART;
1265 static void cdc_ncm_txpath_bh(unsigned long param)
1267 struct usbnet *dev = (struct usbnet *)param;
1268 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1270 spin_lock_bh(&ctx->mtx);
1271 if (ctx->tx_timer_pending != 0) {
1272 ctx->tx_timer_pending--;
1273 cdc_ncm_tx_timeout_start(ctx);
1274 spin_unlock_bh(&ctx->mtx);
1275 } else if (dev->net != NULL) {
1276 ctx->tx_reason_timeout++; /* count reason for transmitting */
1277 spin_unlock_bh(&ctx->mtx);
1278 netif_tx_lock_bh(dev->net);
1279 usbnet_start_xmit(NULL, dev->net);
1280 netif_tx_unlock_bh(dev->net);
1282 spin_unlock_bh(&ctx->mtx);
1287 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1289 struct sk_buff *skb_out;
1290 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1293 * The Ethernet API we are using does not support transmitting
1294 * multiple Ethernet frames in a single call. This driver will
1295 * accumulate multiple Ethernet frames and send out a larger
1296 * USB frame when the USB buffer is full or when a single jiffies
1302 spin_lock_bh(&ctx->mtx);
1303 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1304 spin_unlock_bh(&ctx->mtx);
1309 dev_kfree_skb_any(skb);
1313 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1315 /* verify NTB header and return offset of first NDP, or negative error */
1316 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1318 struct usbnet *dev = netdev_priv(skb_in->dev);
1319 struct usb_cdc_ncm_nth16 *nth16;
1326 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1327 sizeof(struct usb_cdc_ncm_ndp16))) {
1328 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1332 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1334 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1335 netif_dbg(dev, rx_err, dev->net,
1336 "invalid NTH16 signature <%#010x>\n",
1337 le32_to_cpu(nth16->dwSignature));
1341 len = le16_to_cpu(nth16->wBlockLength);
1342 if (len > ctx->rx_max) {
1343 netif_dbg(dev, rx_err, dev->net,
1344 "unsupported NTB block length %u/%u\n", len,
1349 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1350 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1351 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1352 netif_dbg(dev, rx_err, dev->net,
1353 "sequence number glitch prev=%d curr=%d\n",
1354 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1356 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1358 ret = le16_to_cpu(nth16->wNdpIndex);
1362 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1364 /* verify NDP header and return number of datagrams, or negative error */
1365 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1367 struct usbnet *dev = netdev_priv(skb_in->dev);
1368 struct usb_cdc_ncm_ndp16 *ndp16;
1371 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1372 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1376 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1378 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1379 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1380 le16_to_cpu(ndp16->wLength));
1384 ret = ((le16_to_cpu(ndp16->wLength) -
1385 sizeof(struct usb_cdc_ncm_ndp16)) /
1386 sizeof(struct usb_cdc_ncm_dpe16));
1387 ret--; /* we process NDP entries except for the last one */
1389 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1390 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1391 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1398 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1400 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1402 struct sk_buff *skb;
1403 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1408 struct usb_cdc_ncm_ndp16 *ndp16;
1409 struct usb_cdc_ncm_dpe16 *dpe16;
1411 int loopcount = 50; /* arbitrary max preventing infinite loop */
1414 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1419 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1423 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1425 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1426 netif_dbg(dev, rx_err, dev->net,
1427 "invalid DPT16 signature <%#010x>\n",
1428 le32_to_cpu(ndp16->dwSignature));
1431 dpe16 = ndp16->dpe16;
1433 for (x = 0; x < nframes; x++, dpe16++) {
1434 offset = le16_to_cpu(dpe16->wDatagramIndex);
1435 len = le16_to_cpu(dpe16->wDatagramLength);
1439 * All entries after first NULL entry are to be ignored
1441 if ((offset == 0) || (len == 0)) {
1443 goto err_ndp; /* empty NTB */
1447 /* sanity checking */
1448 if (((offset + len) > skb_in->len) ||
1449 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1450 netif_dbg(dev, rx_err, dev->net,
1451 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1452 x, offset, len, skb_in);
1458 /* create a fresh copy to reduce truesize */
1459 skb = netdev_alloc_skb_ip_align(dev->net, len);
1462 memcpy(skb_put(skb, len), skb_in->data + offset, len);
1463 usbnet_skb_return(dev, skb);
1464 payload += len; /* count payload bytes in this NTB */
1468 /* are there more NDPs to process? */
1469 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1470 if (ndpoffset && loopcount--)
1474 ctx->rx_overhead += skb_in->len - payload;
1481 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1484 cdc_ncm_speed_change(struct usbnet *dev,
1485 struct usb_cdc_speed_change *data)
1487 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1488 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1491 * Currently the USB-NET API does not support reporting the actual
1492 * device speed. Do print it instead.
1494 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1495 netif_info(dev, link, dev->net,
1496 "%u mbit/s downlink %u mbit/s uplink\n",
1497 (unsigned int)(rx_speed / 1000000U),
1498 (unsigned int)(tx_speed / 1000000U));
1500 netif_info(dev, link, dev->net,
1501 "%u kbit/s downlink %u kbit/s uplink\n",
1502 (unsigned int)(rx_speed / 1000U),
1503 (unsigned int)(tx_speed / 1000U));
1507 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1509 struct cdc_ncm_ctx *ctx;
1510 struct usb_cdc_notification *event;
1512 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1514 if (urb->actual_length < sizeof(*event))
1517 /* test for split data in 8-byte chunks */
1518 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1519 cdc_ncm_speed_change(dev,
1520 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1524 event = urb->transfer_buffer;
1526 switch (event->bNotificationType) {
1527 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1529 * According to the CDC NCM specification ch.7.1
1530 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1531 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1533 netif_info(dev, link, dev->net,
1534 "network connection: %sconnected\n",
1535 !!event->wValue ? "" : "dis");
1536 usbnet_link_change(dev, !!event->wValue, 0);
1539 case USB_CDC_NOTIFY_SPEED_CHANGE:
1540 if (urb->actual_length < (sizeof(*event) +
1541 sizeof(struct usb_cdc_speed_change)))
1542 set_bit(EVENT_STS_SPLIT, &dev->flags);
1544 cdc_ncm_speed_change(dev,
1545 (struct usb_cdc_speed_change *)&event[1]);
1549 dev_dbg(&dev->udev->dev,
1550 "NCM: unexpected notification 0x%02x!\n",
1551 event->bNotificationType);
1556 static const struct driver_info cdc_ncm_info = {
1557 .description = "CDC NCM",
1558 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1559 .bind = cdc_ncm_bind,
1560 .unbind = cdc_ncm_unbind,
1561 .manage_power = usbnet_manage_power,
1562 .status = cdc_ncm_status,
1563 .rx_fixup = cdc_ncm_rx_fixup,
1564 .tx_fixup = cdc_ncm_tx_fixup,
1567 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1568 static const struct driver_info wwan_info = {
1569 .description = "Mobile Broadband Network Device",
1570 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1572 .bind = cdc_ncm_bind,
1573 .unbind = cdc_ncm_unbind,
1574 .manage_power = usbnet_manage_power,
1575 .status = cdc_ncm_status,
1576 .rx_fixup = cdc_ncm_rx_fixup,
1577 .tx_fixup = cdc_ncm_tx_fixup,
1580 /* Same as wwan_info, but with FLAG_NOARP */
1581 static const struct driver_info wwan_noarp_info = {
1582 .description = "Mobile Broadband Network Device (NO ARP)",
1583 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1584 | FLAG_WWAN | FLAG_NOARP,
1585 .bind = cdc_ncm_bind,
1586 .unbind = cdc_ncm_unbind,
1587 .manage_power = usbnet_manage_power,
1588 .status = cdc_ncm_status,
1589 .rx_fixup = cdc_ncm_rx_fixup,
1590 .tx_fixup = cdc_ncm_tx_fixup,
1593 static const struct usb_device_id cdc_devs[] = {
1594 /* Ericsson MBM devices like F5521gw */
1595 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1596 | USB_DEVICE_ID_MATCH_VENDOR,
1598 .bInterfaceClass = USB_CLASS_COMM,
1599 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1600 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1601 .driver_info = (unsigned long) &wwan_info,
1604 /* Dell branded MBM devices like DW5550 */
1605 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1606 | USB_DEVICE_ID_MATCH_VENDOR,
1608 .bInterfaceClass = USB_CLASS_COMM,
1609 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1610 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1611 .driver_info = (unsigned long) &wwan_info,
1614 /* Toshiba branded MBM devices */
1615 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1616 | USB_DEVICE_ID_MATCH_VENDOR,
1618 .bInterfaceClass = USB_CLASS_COMM,
1619 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1620 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1621 .driver_info = (unsigned long) &wwan_info,
1624 /* tag Huawei devices as wwan */
1625 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1627 USB_CDC_SUBCLASS_NCM,
1628 USB_CDC_PROTO_NONE),
1629 .driver_info = (unsigned long)&wwan_info,
1632 /* Infineon(now Intel) HSPA Modem platform */
1633 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1635 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1636 .driver_info = (unsigned long)&wwan_noarp_info,
1639 /* Generic CDC-NCM devices */
1640 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1641 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1642 .driver_info = (unsigned long)&cdc_ncm_info,
1647 MODULE_DEVICE_TABLE(usb, cdc_devs);
1649 static struct usb_driver cdc_ncm_driver = {
1651 .id_table = cdc_devs,
1652 .probe = usbnet_probe,
1653 .disconnect = usbnet_disconnect,
1654 .suspend = usbnet_suspend,
1655 .resume = usbnet_resume,
1656 .reset_resume = usbnet_resume,
1657 .supports_autosuspend = 1,
1658 .disable_hub_initiated_lpm = 1,
1661 module_usb_driver(cdc_ncm_driver);
1663 MODULE_AUTHOR("Hans Petter Selasky");
1664 MODULE_DESCRIPTION("USB CDC NCM host driver");
1665 MODULE_LICENSE("Dual BSD/GPL");