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/devclass_docs/NCM10.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 int cdc_ncm_get_coalesce(struct net_device *netdev,
131 struct ethtool_coalesce *ec)
133 struct usbnet *dev = netdev_priv(netdev);
134 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
136 /* assuming maximum sized dgrams and ignoring NDPs */
137 ec->rx_max_coalesced_frames = ctx->rx_max / ctx->max_datagram_size;
138 ec->tx_max_coalesced_frames = ctx->tx_max / ctx->max_datagram_size;
140 /* the timer will fire CDC_NCM_TIMER_PENDING_CNT times in a row */
141 ec->tx_coalesce_usecs = ctx->timer_interval / (NSEC_PER_USEC / CDC_NCM_TIMER_PENDING_CNT);
145 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
147 static int cdc_ncm_set_coalesce(struct net_device *netdev,
148 struct ethtool_coalesce *ec)
150 struct usbnet *dev = netdev_priv(netdev);
151 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
152 u32 new_rx_max = ctx->rx_max;
153 u32 new_tx_max = ctx->tx_max;
155 /* assuming maximum sized dgrams and a single NDP */
156 if (ec->rx_max_coalesced_frames)
157 new_rx_max = ec->rx_max_coalesced_frames * ctx->max_datagram_size;
158 if (ec->tx_max_coalesced_frames)
159 new_tx_max = ec->tx_max_coalesced_frames * ctx->max_datagram_size;
161 if (ec->tx_coalesce_usecs &&
162 (ec->tx_coalesce_usecs < CDC_NCM_TIMER_INTERVAL_MIN * CDC_NCM_TIMER_PENDING_CNT ||
163 ec->tx_coalesce_usecs > CDC_NCM_TIMER_INTERVAL_MAX * CDC_NCM_TIMER_PENDING_CNT))
166 spin_lock_bh(&ctx->mtx);
167 ctx->timer_interval = ec->tx_coalesce_usecs * (NSEC_PER_USEC / CDC_NCM_TIMER_PENDING_CNT);
168 if (!ctx->timer_interval)
169 ctx->tx_timer_pending = 0;
170 spin_unlock_bh(&ctx->mtx);
172 /* inform device of new values */
173 if (new_rx_max != ctx->rx_max || new_tx_max != ctx->tx_max)
174 cdc_ncm_update_rxtx_max(dev, new_rx_max, new_tx_max);
178 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
179 .get_settings = usbnet_get_settings,
180 .set_settings = usbnet_set_settings,
181 .get_link = usbnet_get_link,
182 .nway_reset = usbnet_nway_reset,
183 .get_drvinfo = usbnet_get_drvinfo,
184 .get_msglevel = usbnet_get_msglevel,
185 .set_msglevel = usbnet_set_msglevel,
186 .get_ts_info = ethtool_op_get_ts_info,
187 .get_sset_count = cdc_ncm_get_sset_count,
188 .get_strings = cdc_ncm_get_strings,
189 .get_ethtool_stats = cdc_ncm_get_ethtool_stats,
190 .get_coalesce = cdc_ncm_get_coalesce,
191 .set_coalesce = cdc_ncm_set_coalesce,
194 /* handle rx_max and tx_max changes */
195 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
197 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
198 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
201 /* clamp new_rx to sane values */
202 min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
203 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
205 /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
207 dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
208 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
212 val = clamp_t(u32, new_rx, min, max);
214 dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range. Using %u\n",
218 /* usbnet use these values for sizing rx queues */
219 dev->rx_urb_size = val;
221 /* inform device about NTB input size changes */
222 if (val != ctx->rx_max) {
223 __le32 dwNtbInMaxSize = cpu_to_le32(val);
225 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
227 /* need to unlink rx urbs before increasing buffer size */
228 if (netif_running(dev->net) && dev->rx_urb_size > ctx->rx_max)
229 usbnet_unlink_rx_urbs(dev);
231 /* tell device to use new size */
232 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
233 USB_TYPE_CLASS | USB_DIR_OUT
234 | USB_RECIP_INTERFACE,
235 0, iface_no, &dwNtbInMaxSize, 4) < 0)
236 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
241 /* clamp new_tx to sane values */
242 min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
243 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
245 /* some devices set dwNtbOutMaxSize too low for the above default */
248 val = clamp_t(u32, new_tx, min, max);
250 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range. Using %u\n",
253 if (val != ctx->tx_max)
254 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
256 /* Adding a pad byte here if necessary simplifies the handling
257 * in cdc_ncm_fill_tx_frame, making tx_max always represent
258 * the real skb max size.
260 * We cannot use dev->maxpacket here because this is called from
261 * .bind which is called before usbnet sets up dev->maxpacket
263 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
264 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
267 /* we might need to flush any pending tx buffers if running */
268 if (netif_running(dev->net) && val > ctx->tx_max) {
269 netif_tx_lock_bh(dev->net);
270 usbnet_start_xmit(NULL, dev->net);
272 netif_tx_unlock_bh(dev->net);
277 dev->hard_mtu = ctx->tx_max;
279 /* max qlen depend on hard_mtu and rx_urb_size */
280 usbnet_update_max_qlen(dev);
282 /* never pad more than 3 full USB packets per transfer */
283 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
284 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
287 /* helpers for NCM and MBIM differences */
288 static u8 cdc_ncm_flags(struct usbnet *dev)
290 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
292 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
293 return ctx->mbim_desc->bmNetworkCapabilities;
295 return ctx->func_desc->bmNetworkCapabilities;
299 static int cdc_ncm_eth_hlen(struct usbnet *dev)
301 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
306 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
308 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
309 return CDC_MBIM_MIN_DATAGRAM_SIZE;
310 return CDC_NCM_MIN_DATAGRAM_SIZE;
313 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
315 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
317 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
318 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
320 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
321 return CDC_NCM_MAX_DATAGRAM_SIZE;
324 /* initial one-time device setup. MUST be called with the data interface
327 static int cdc_ncm_init(struct usbnet *dev)
329 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
330 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
333 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
334 USB_TYPE_CLASS | USB_DIR_IN
335 |USB_RECIP_INTERFACE,
336 0, iface_no, &ctx->ncm_parm,
337 sizeof(ctx->ncm_parm));
339 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
340 return err; /* GET_NTB_PARAMETERS is required */
344 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
345 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
346 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
347 USB_TYPE_CLASS | USB_DIR_OUT
348 | USB_RECIP_INTERFACE,
349 USB_CDC_NCM_CRC_NOT_APPENDED,
352 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
355 /* set NTB format, if both formats are supported.
357 * "The host shall only send this command while the NCM Data
358 * Interface is in alternate setting 0."
360 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) & USB_CDC_NCM_NTH32_SIGN) {
361 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
362 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
363 USB_TYPE_CLASS | USB_DIR_OUT
364 | USB_RECIP_INTERFACE,
365 USB_CDC_NCM_NTB16_FORMAT,
368 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
371 /* set initial device values */
372 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
373 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
374 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
375 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
376 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
377 /* devices prior to NCM Errata shall set this field to zero */
378 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
380 dev_dbg(&dev->intf->dev,
381 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
382 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
383 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
385 /* max count of tx datagrams */
386 if ((ctx->tx_max_datagrams == 0) ||
387 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
388 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
390 /* set up maximum NDP size */
391 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
393 /* initial coalescing timer interval */
394 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
399 /* set a new max datagram size */
400 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
402 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
403 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
404 __le16 max_datagram_size;
408 /* set default based on descriptors */
409 ctx->max_datagram_size = clamp_t(u32, new_size,
410 cdc_ncm_min_dgram_size(dev),
411 CDC_NCM_MAX_DATAGRAM_SIZE);
413 /* inform the device about the selected Max Datagram Size? */
414 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
417 /* read current mtu value from device */
418 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
419 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
420 0, iface_no, &max_datagram_size, 2);
422 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
426 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
429 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
430 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
431 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
432 0, iface_no, &max_datagram_size, 2);
434 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
437 /* set MTU to max supported by the device if necessary */
438 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
440 /* do not exceed operater preferred MTU */
441 if (ctx->mbim_extended_desc) {
442 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
443 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
444 dev->net->mtu = mbim_mtu;
448 static void cdc_ncm_fix_modulus(struct usbnet *dev)
450 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
454 * verify that the structure alignment is:
456 * - not greater than the maximum transmit length
457 * - not less than four bytes
459 val = ctx->tx_ndp_modulus;
461 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
462 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
463 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
464 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
468 * verify that the payload alignment is:
470 * - not greater than the maximum transmit length
471 * - not less than four bytes
473 val = ctx->tx_modulus;
475 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
476 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
477 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
478 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
481 /* verify the payload remainder */
482 if (ctx->tx_remainder >= ctx->tx_modulus) {
483 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
484 ctx->tx_remainder = 0;
487 /* adjust TX-remainder according to NCM specification. */
488 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
489 (ctx->tx_modulus - 1));
492 static int cdc_ncm_setup(struct usbnet *dev)
494 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
497 /* be conservative when selecting intial buffer size to
498 * increase the number of hosts this will work for
500 def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
501 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
502 def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
503 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
505 /* clamp rx_max and tx_max and inform device */
506 cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
508 /* sanitize the modulus and remainder values */
509 cdc_ncm_fix_modulus(dev);
511 /* set max datagram size */
512 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
517 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
519 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
522 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
524 e = intf->cur_altsetting->endpoint + ep;
525 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
526 case USB_ENDPOINT_XFER_INT:
527 if (usb_endpoint_dir_in(&e->desc)) {
533 case USB_ENDPOINT_XFER_BULK:
534 if (usb_endpoint_dir_in(&e->desc)) {
548 dev->in = usb_rcvbulkpipe(dev->udev,
549 in->desc.bEndpointAddress &
550 USB_ENDPOINT_NUMBER_MASK);
551 if (out && !dev->out)
552 dev->out = usb_sndbulkpipe(dev->udev,
553 out->desc.bEndpointAddress &
554 USB_ENDPOINT_NUMBER_MASK);
557 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
562 if (ctx->tx_rem_skb != NULL) {
563 dev_kfree_skb_any(ctx->tx_rem_skb);
564 ctx->tx_rem_skb = NULL;
567 if (ctx->tx_curr_skb != NULL) {
568 dev_kfree_skb_any(ctx->tx_curr_skb);
569 ctx->tx_curr_skb = NULL;
575 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting)
577 const struct usb_cdc_union_desc *union_desc = NULL;
578 struct cdc_ncm_ctx *ctx;
579 struct usb_driver *driver;
585 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
589 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
590 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
591 ctx->bh.data = (unsigned long)dev;
592 ctx->bh.func = cdc_ncm_txpath_bh;
593 atomic_set(&ctx->stop, 0);
594 spin_lock_init(&ctx->mtx);
596 /* store ctx pointer in device data field */
597 dev->data[0] = (unsigned long)ctx;
599 /* only the control interface can be successfully probed */
602 /* get some pointers */
603 driver = driver_of(intf);
604 buf = intf->cur_altsetting->extra;
605 len = intf->cur_altsetting->extralen;
607 /* parse through descriptors associated with control interface */
608 while ((len > 0) && (buf[0] > 2) && (buf[0] <= len)) {
610 if (buf[1] != USB_DT_CS_INTERFACE)
614 case USB_CDC_UNION_TYPE:
615 if (buf[0] < sizeof(*union_desc))
618 union_desc = (const struct usb_cdc_union_desc *)buf;
619 /* the master must be the interface we are probing */
620 if (intf->cur_altsetting->desc.bInterfaceNumber !=
621 union_desc->bMasterInterface0) {
622 dev_dbg(&intf->dev, "bogus CDC Union\n");
625 ctx->data = usb_ifnum_to_if(dev->udev,
626 union_desc->bSlaveInterface0);
629 case USB_CDC_ETHERNET_TYPE:
630 if (buf[0] < sizeof(*(ctx->ether_desc)))
634 (const struct usb_cdc_ether_desc *)buf;
637 case USB_CDC_NCM_TYPE:
638 if (buf[0] < sizeof(*(ctx->func_desc)))
641 ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
644 case USB_CDC_MBIM_TYPE:
645 if (buf[0] < sizeof(*(ctx->mbim_desc)))
648 ctx->mbim_desc = (const struct usb_cdc_mbim_desc *)buf;
651 case USB_CDC_MBIM_EXTENDED_TYPE:
652 if (buf[0] < sizeof(*(ctx->mbim_extended_desc)))
655 ctx->mbim_extended_desc =
656 (const struct usb_cdc_mbim_extended_desc *)buf;
663 /* advance to next descriptor */
669 /* some buggy devices have an IAD but no CDC Union */
670 if (!union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
671 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
672 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
675 /* check if we got everything */
677 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
680 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
681 if (!ctx->mbim_desc) {
682 dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
686 if (!ctx->ether_desc || !ctx->func_desc) {
687 dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
692 /* claim data interface, if different from control */
693 if (ctx->data != ctx->control) {
694 temp = usb_driver_claim_interface(driver, ctx->data, dev);
696 dev_dbg(&intf->dev, "failed to claim data intf\n");
701 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
703 /* reset data interface */
704 temp = usb_set_interface(dev->udev, iface_no, 0);
706 dev_dbg(&intf->dev, "set interface failed\n");
710 /* initialize basic device settings */
711 if (cdc_ncm_init(dev))
714 /* configure data interface */
715 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
717 dev_dbg(&intf->dev, "set interface failed\n");
721 cdc_ncm_find_endpoints(dev, ctx->data);
722 cdc_ncm_find_endpoints(dev, ctx->control);
723 if (!dev->in || !dev->out || !dev->status) {
724 dev_dbg(&intf->dev, "failed to collect endpoints\n");
728 usb_set_intfdata(ctx->data, dev);
729 usb_set_intfdata(ctx->control, dev);
731 if (ctx->ether_desc) {
732 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
734 dev_dbg(&intf->dev, "failed to get mac address\n");
737 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
740 /* finish setting up the device specific data */
743 /* override ethtool_ops */
744 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
749 usb_set_intfdata(ctx->control, NULL);
750 usb_set_intfdata(ctx->data, NULL);
751 if (ctx->data != ctx->control)
752 usb_driver_release_interface(driver, ctx->data);
754 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
756 dev_info(&intf->dev, "bind() failure\n");
759 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
761 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
763 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
764 struct usb_driver *driver = driver_of(intf);
767 return; /* no setup */
769 atomic_set(&ctx->stop, 1);
771 if (hrtimer_active(&ctx->tx_timer))
772 hrtimer_cancel(&ctx->tx_timer);
774 tasklet_kill(&ctx->bh);
776 /* handle devices with combined control and data interface */
777 if (ctx->control == ctx->data)
780 /* disconnect master --> disconnect slave */
781 if (intf == ctx->control && ctx->data) {
782 usb_set_intfdata(ctx->data, NULL);
783 usb_driver_release_interface(driver, ctx->data);
786 } else if (intf == ctx->data && ctx->control) {
787 usb_set_intfdata(ctx->control, NULL);
788 usb_driver_release_interface(driver, ctx->control);
792 usb_set_intfdata(intf, NULL);
795 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
797 /* Return the number of the MBIM control interface altsetting iff it
798 * is preferred and available,
800 u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
802 struct usb_host_interface *alt;
804 /* The MBIM spec defines a NCM compatible default altsetting,
805 * which we may have matched:
807 * "Functions that implement both NCM 1.0 and MBIM (an
808 * “NCM/MBIM function”) according to this recommendation
809 * shall provide two alternate settings for the
810 * Communication Interface. Alternate setting 0, and the
811 * associated class and endpoint descriptors, shall be
812 * constructed according to the rules given for the
813 * Communication Interface in section 5 of [USBNCM10].
814 * Alternate setting 1, and the associated class and
815 * endpoint descriptors, shall be constructed according to
816 * the rules given in section 6 (USB Device Model) of this
819 if (intf->num_altsetting < 2)
820 return intf->cur_altsetting->desc.bAlternateSetting;
823 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
824 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
825 return CDC_NCM_COMM_ALTSETTING_MBIM;
827 return CDC_NCM_COMM_ALTSETTING_NCM;
829 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
831 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
835 /* MBIM backwards compatible function? */
836 if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
839 /* The NCM data altsetting is fixed */
840 ret = cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM);
843 * We should get an event when network connection is "connected" or
844 * "disconnected". Set network connection in "disconnected" state
845 * (carrier is OFF) during attach, so the IP network stack does not
846 * start IPv6 negotiation and more.
848 usbnet_link_change(dev, 0, 0);
852 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
854 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
856 if (skb->len + align > max)
857 align = max - skb->len;
858 if (align && skb_tailroom(skb) >= align)
859 memset(skb_put(skb, align), 0, align);
862 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
863 * allocating a new one within skb
865 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
867 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
868 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
869 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
871 /* follow the chain of NDPs, looking for a match */
873 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
874 if (ndp16->dwSignature == sign)
876 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
880 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
882 /* verify that there is room for the NDP and the datagram (reserve) */
883 if ((ctx->tx_max - skb->len - reserve) < ctx->max_ndp_size)
888 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
890 nth16->wNdpIndex = cpu_to_le16(skb->len);
892 /* push a new empty NDP */
893 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, ctx->max_ndp_size);
894 ndp16->dwSignature = sign;
895 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
900 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
902 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
903 struct usb_cdc_ncm_nth16 *nth16;
904 struct usb_cdc_ncm_ndp16 *ndp16;
905 struct sk_buff *skb_out;
906 u16 n = 0, index, ndplen;
909 /* if there is a remaining skb, it gets priority */
911 swap(skb, ctx->tx_rem_skb);
912 swap(sign, ctx->tx_rem_sign);
917 /* check if we are resuming an OUT skb */
918 skb_out = ctx->tx_curr_skb;
920 /* allocate a new OUT skb */
922 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
923 if (skb_out == NULL) {
925 dev_kfree_skb_any(skb);
926 dev->net->stats.tx_dropped++;
930 /* fill out the initial 16-bit NTB header */
931 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
932 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
933 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
934 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
936 /* count total number of frames in this NTB */
937 ctx->tx_curr_frame_num = 0;
939 /* recent payload counter for this skb_out */
940 ctx->tx_curr_frame_payload = 0;
943 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
944 /* send any remaining skb first */
946 skb = ctx->tx_rem_skb;
947 sign = ctx->tx_rem_sign;
948 ctx->tx_rem_skb = NULL;
950 /* check for end of skb */
955 /* get the appropriate NDP for this skb */
956 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
958 /* align beginning of next frame */
959 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
961 /* check if we had enough room left for both NDP and frame */
962 if (!ndp16 || skb_out->len + skb->len > ctx->tx_max) {
964 /* won't fit, MTU problem? */
965 dev_kfree_skb_any(skb);
967 dev->net->stats.tx_dropped++;
969 /* no room for skb - store for later */
970 if (ctx->tx_rem_skb != NULL) {
971 dev_kfree_skb_any(ctx->tx_rem_skb);
972 dev->net->stats.tx_dropped++;
974 ctx->tx_rem_skb = skb;
975 ctx->tx_rem_sign = sign;
978 ctx->tx_reason_ntb_full++; /* count reason for transmitting */
983 /* calculate frame number withing this NDP */
984 ndplen = le16_to_cpu(ndp16->wLength);
985 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
987 /* OK, add this skb */
988 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
989 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
990 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
991 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
992 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
993 dev_kfree_skb_any(skb);
996 /* send now if this NDP is full */
997 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
999 ctx->tx_reason_ndp_full++; /* count reason for transmitting */
1004 /* free up any dangling skb */
1006 dev_kfree_skb_any(skb);
1008 dev->net->stats.tx_dropped++;
1011 ctx->tx_curr_frame_num = n;
1014 /* wait for more frames */
1015 /* push variables */
1016 ctx->tx_curr_skb = skb_out;
1019 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1020 /* wait for more frames */
1021 /* push variables */
1022 ctx->tx_curr_skb = skb_out;
1023 /* set the pending count */
1024 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1025 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1029 if (n == ctx->tx_max_datagrams)
1030 ctx->tx_reason_max_datagram++; /* count reason for transmitting */
1031 /* frame goes out */
1032 /* variables will be reset at next call */
1035 /* If collected data size is less or equal ctx->min_tx_pkt
1036 * bytes, we send buffers as it is. If we get more data, it
1037 * would be more efficient for USB HS mobile device with DMA
1038 * engine to receive a full size NTB, than canceling DMA
1039 * transfer and receiving a short packet.
1041 * This optimization support is pointless if we end up sending
1042 * a ZLP after full sized NTBs.
1044 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1045 skb_out->len > ctx->min_tx_pkt)
1046 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
1047 ctx->tx_max - skb_out->len);
1048 else if (skb_out->len < ctx->tx_max && (skb_out->len % dev->maxpacket) == 0)
1049 *skb_put(skb_out, 1) = 0; /* force short packet */
1051 /* set final frame length */
1052 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1053 nth16->wBlockLength = cpu_to_le16(skb_out->len);
1056 ctx->tx_curr_skb = NULL;
1057 dev->net->stats.tx_packets += ctx->tx_curr_frame_num;
1059 /* keep private stats: framing overhead and number of NTBs */
1060 ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1063 /* usbnet has already counted all the framing overhead.
1064 * Adjust the stats so that the tx_bytes counter show real
1065 * payload data instead.
1067 dev->net->stats.tx_bytes -= skb_out->len - ctx->tx_curr_frame_payload;
1072 /* Start timer, if there is a remaining non-empty skb */
1073 if (ctx->tx_curr_skb != NULL && n > 0)
1074 cdc_ncm_tx_timeout_start(ctx);
1077 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1079 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1081 /* start timer, if not already started */
1082 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1083 hrtimer_start(&ctx->tx_timer,
1084 ktime_set(0, ctx->timer_interval),
1088 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1090 struct cdc_ncm_ctx *ctx =
1091 container_of(timer, struct cdc_ncm_ctx, tx_timer);
1093 if (!atomic_read(&ctx->stop))
1094 tasklet_schedule(&ctx->bh);
1095 return HRTIMER_NORESTART;
1098 static void cdc_ncm_txpath_bh(unsigned long param)
1100 struct usbnet *dev = (struct usbnet *)param;
1101 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1103 spin_lock_bh(&ctx->mtx);
1104 if (ctx->tx_timer_pending != 0) {
1105 ctx->tx_timer_pending--;
1106 cdc_ncm_tx_timeout_start(ctx);
1107 spin_unlock_bh(&ctx->mtx);
1108 } else if (dev->net != NULL) {
1109 ctx->tx_reason_timeout++; /* count reason for transmitting */
1110 spin_unlock_bh(&ctx->mtx);
1111 netif_tx_lock_bh(dev->net);
1112 usbnet_start_xmit(NULL, dev->net);
1113 netif_tx_unlock_bh(dev->net);
1115 spin_unlock_bh(&ctx->mtx);
1120 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1122 struct sk_buff *skb_out;
1123 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1126 * The Ethernet API we are using does not support transmitting
1127 * multiple Ethernet frames in a single call. This driver will
1128 * accumulate multiple Ethernet frames and send out a larger
1129 * USB frame when the USB buffer is full or when a single jiffies
1135 spin_lock_bh(&ctx->mtx);
1136 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1137 spin_unlock_bh(&ctx->mtx);
1142 dev_kfree_skb_any(skb);
1146 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1148 /* verify NTB header and return offset of first NDP, or negative error */
1149 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1151 struct usbnet *dev = netdev_priv(skb_in->dev);
1152 struct usb_cdc_ncm_nth16 *nth16;
1159 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1160 sizeof(struct usb_cdc_ncm_ndp16))) {
1161 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1165 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1167 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1168 netif_dbg(dev, rx_err, dev->net,
1169 "invalid NTH16 signature <%#010x>\n",
1170 le32_to_cpu(nth16->dwSignature));
1174 len = le16_to_cpu(nth16->wBlockLength);
1175 if (len > ctx->rx_max) {
1176 netif_dbg(dev, rx_err, dev->net,
1177 "unsupported NTB block length %u/%u\n", len,
1182 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1183 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1184 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1185 netif_dbg(dev, rx_err, dev->net,
1186 "sequence number glitch prev=%d curr=%d\n",
1187 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1189 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1191 ret = le16_to_cpu(nth16->wNdpIndex);
1195 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1197 /* verify NDP header and return number of datagrams, or negative error */
1198 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1200 struct usbnet *dev = netdev_priv(skb_in->dev);
1201 struct usb_cdc_ncm_ndp16 *ndp16;
1204 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1205 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1209 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1211 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1212 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1213 le16_to_cpu(ndp16->wLength));
1217 ret = ((le16_to_cpu(ndp16->wLength) -
1218 sizeof(struct usb_cdc_ncm_ndp16)) /
1219 sizeof(struct usb_cdc_ncm_dpe16));
1220 ret--; /* we process NDP entries except for the last one */
1222 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1223 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1224 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1231 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1233 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1235 struct sk_buff *skb;
1236 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1241 struct usb_cdc_ncm_ndp16 *ndp16;
1242 struct usb_cdc_ncm_dpe16 *dpe16;
1244 int loopcount = 50; /* arbitrary max preventing infinite loop */
1247 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1252 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1256 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1258 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1259 netif_dbg(dev, rx_err, dev->net,
1260 "invalid DPT16 signature <%#010x>\n",
1261 le32_to_cpu(ndp16->dwSignature));
1264 dpe16 = ndp16->dpe16;
1266 for (x = 0; x < nframes; x++, dpe16++) {
1267 offset = le16_to_cpu(dpe16->wDatagramIndex);
1268 len = le16_to_cpu(dpe16->wDatagramLength);
1272 * All entries after first NULL entry are to be ignored
1274 if ((offset == 0) || (len == 0)) {
1276 goto err_ndp; /* empty NTB */
1280 /* sanity checking */
1281 if (((offset + len) > skb_in->len) ||
1282 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1283 netif_dbg(dev, rx_err, dev->net,
1284 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1285 x, offset, len, skb_in);
1291 skb = skb_clone(skb_in, GFP_ATOMIC);
1295 skb->data = ((u8 *)skb_in->data) + offset;
1296 skb_set_tail_pointer(skb, len);
1297 usbnet_skb_return(dev, skb);
1298 payload += len; /* count payload bytes in this NTB */
1302 /* are there more NDPs to process? */
1303 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1304 if (ndpoffset && loopcount--)
1308 ctx->rx_overhead += skb_in->len - payload;
1315 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1318 cdc_ncm_speed_change(struct usbnet *dev,
1319 struct usb_cdc_speed_change *data)
1321 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1322 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1325 * Currently the USB-NET API does not support reporting the actual
1326 * device speed. Do print it instead.
1328 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1329 netif_info(dev, link, dev->net,
1330 "%u mbit/s downlink %u mbit/s uplink\n",
1331 (unsigned int)(rx_speed / 1000000U),
1332 (unsigned int)(tx_speed / 1000000U));
1334 netif_info(dev, link, dev->net,
1335 "%u kbit/s downlink %u kbit/s uplink\n",
1336 (unsigned int)(rx_speed / 1000U),
1337 (unsigned int)(tx_speed / 1000U));
1341 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1343 struct cdc_ncm_ctx *ctx;
1344 struct usb_cdc_notification *event;
1346 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1348 if (urb->actual_length < sizeof(*event))
1351 /* test for split data in 8-byte chunks */
1352 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1353 cdc_ncm_speed_change(dev,
1354 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1358 event = urb->transfer_buffer;
1360 switch (event->bNotificationType) {
1361 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1363 * According to the CDC NCM specification ch.7.1
1364 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1365 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1367 netif_info(dev, link, dev->net,
1368 "network connection: %sconnected\n",
1369 !!event->wValue ? "" : "dis");
1370 usbnet_link_change(dev, !!event->wValue, 0);
1373 case USB_CDC_NOTIFY_SPEED_CHANGE:
1374 if (urb->actual_length < (sizeof(*event) +
1375 sizeof(struct usb_cdc_speed_change)))
1376 set_bit(EVENT_STS_SPLIT, &dev->flags);
1378 cdc_ncm_speed_change(dev,
1379 (struct usb_cdc_speed_change *)&event[1]);
1383 dev_dbg(&dev->udev->dev,
1384 "NCM: unexpected notification 0x%02x!\n",
1385 event->bNotificationType);
1390 static const struct driver_info cdc_ncm_info = {
1391 .description = "CDC NCM",
1392 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1393 .bind = cdc_ncm_bind,
1394 .unbind = cdc_ncm_unbind,
1395 .manage_power = usbnet_manage_power,
1396 .status = cdc_ncm_status,
1397 .rx_fixup = cdc_ncm_rx_fixup,
1398 .tx_fixup = cdc_ncm_tx_fixup,
1401 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1402 static const struct driver_info wwan_info = {
1403 .description = "Mobile Broadband Network Device",
1404 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1406 .bind = cdc_ncm_bind,
1407 .unbind = cdc_ncm_unbind,
1408 .manage_power = usbnet_manage_power,
1409 .status = cdc_ncm_status,
1410 .rx_fixup = cdc_ncm_rx_fixup,
1411 .tx_fixup = cdc_ncm_tx_fixup,
1414 /* Same as wwan_info, but with FLAG_NOARP */
1415 static const struct driver_info wwan_noarp_info = {
1416 .description = "Mobile Broadband Network Device (NO ARP)",
1417 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1418 | FLAG_WWAN | FLAG_NOARP,
1419 .bind = cdc_ncm_bind,
1420 .unbind = cdc_ncm_unbind,
1421 .manage_power = usbnet_manage_power,
1422 .status = cdc_ncm_status,
1423 .rx_fixup = cdc_ncm_rx_fixup,
1424 .tx_fixup = cdc_ncm_tx_fixup,
1427 static const struct usb_device_id cdc_devs[] = {
1428 /* Ericsson MBM devices like F5521gw */
1429 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1430 | USB_DEVICE_ID_MATCH_VENDOR,
1432 .bInterfaceClass = USB_CLASS_COMM,
1433 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1434 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1435 .driver_info = (unsigned long) &wwan_info,
1438 /* Dell branded MBM devices like DW5550 */
1439 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1440 | USB_DEVICE_ID_MATCH_VENDOR,
1442 .bInterfaceClass = USB_CLASS_COMM,
1443 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1444 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1445 .driver_info = (unsigned long) &wwan_info,
1448 /* Toshiba branded MBM devices */
1449 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1450 | USB_DEVICE_ID_MATCH_VENDOR,
1452 .bInterfaceClass = USB_CLASS_COMM,
1453 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1454 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1455 .driver_info = (unsigned long) &wwan_info,
1458 /* tag Huawei devices as wwan */
1459 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1461 USB_CDC_SUBCLASS_NCM,
1462 USB_CDC_PROTO_NONE),
1463 .driver_info = (unsigned long)&wwan_info,
1466 /* Infineon(now Intel) HSPA Modem platform */
1467 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1469 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1470 .driver_info = (unsigned long)&wwan_noarp_info,
1473 /* Generic CDC-NCM devices */
1474 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1475 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1476 .driver_info = (unsigned long)&cdc_ncm_info,
1481 MODULE_DEVICE_TABLE(usb, cdc_devs);
1483 static struct usb_driver cdc_ncm_driver = {
1485 .id_table = cdc_devs,
1486 .probe = usbnet_probe,
1487 .disconnect = usbnet_disconnect,
1488 .suspend = usbnet_suspend,
1489 .resume = usbnet_resume,
1490 .reset_resume = usbnet_resume,
1491 .supports_autosuspend = 1,
1492 .disable_hub_initiated_lpm = 1,
1495 module_usb_driver(cdc_ncm_driver);
1497 MODULE_AUTHOR("Hans Petter Selasky");
1498 MODULE_DESCRIPTION("USB CDC NCM host driver");
1499 MODULE_LICENSE("Dual BSD/GPL");