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 static int cdc_ncm_get_coalesce(struct net_device *netdev,
69 struct ethtool_coalesce *ec)
71 struct usbnet *dev = netdev_priv(netdev);
72 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
74 /* assuming maximum sized dgrams and ignoring NDPs */
75 ec->rx_max_coalesced_frames = ctx->rx_max / ctx->max_datagram_size;
76 ec->tx_max_coalesced_frames = ctx->tx_max / ctx->max_datagram_size;
78 /* the timer will fire CDC_NCM_TIMER_PENDING_CNT times in a row */
79 ec->tx_coalesce_usecs = (ctx->timer_interval * CDC_NCM_TIMER_PENDING_CNT) / NSEC_PER_USEC;
83 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
85 static int cdc_ncm_set_coalesce(struct net_device *netdev,
86 struct ethtool_coalesce *ec)
88 struct usbnet *dev = netdev_priv(netdev);
89 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
90 u32 new_rx_max = ctx->rx_max;
91 u32 new_tx_max = ctx->tx_max;
93 /* assuming maximum sized dgrams and a single NDP */
94 if (ec->rx_max_coalesced_frames)
95 new_rx_max = ec->rx_max_coalesced_frames * ctx->max_datagram_size;
96 if (ec->tx_max_coalesced_frames)
97 new_tx_max = ec->tx_max_coalesced_frames * ctx->max_datagram_size;
99 if (ec->tx_coalesce_usecs &&
100 (ec->tx_coalesce_usecs < CDC_NCM_TIMER_INTERVAL_MIN * CDC_NCM_TIMER_PENDING_CNT ||
101 ec->tx_coalesce_usecs > CDC_NCM_TIMER_INTERVAL_MAX * CDC_NCM_TIMER_PENDING_CNT))
104 spin_lock_bh(&ctx->mtx);
105 ctx->timer_interval = ec->tx_coalesce_usecs * NSEC_PER_USEC / CDC_NCM_TIMER_PENDING_CNT;
106 if (!ctx->timer_interval)
107 ctx->tx_timer_pending = 0;
108 spin_unlock_bh(&ctx->mtx);
110 /* inform device of new values */
111 if (new_rx_max != ctx->rx_max || new_tx_max != ctx->tx_max)
112 cdc_ncm_update_rxtx_max(dev, new_rx_max, new_tx_max);
116 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
117 .get_settings = usbnet_get_settings,
118 .set_settings = usbnet_set_settings,
119 .get_link = usbnet_get_link,
120 .nway_reset = usbnet_nway_reset,
121 .get_drvinfo = usbnet_get_drvinfo,
122 .get_msglevel = usbnet_get_msglevel,
123 .set_msglevel = usbnet_set_msglevel,
124 .get_ts_info = ethtool_op_get_ts_info,
125 .get_coalesce = cdc_ncm_get_coalesce,
126 .set_coalesce = cdc_ncm_set_coalesce,
129 /* handle rx_max and tx_max changes */
130 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
132 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
133 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
136 /* clamp new_rx to sane values */
137 min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
138 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
140 /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
142 dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
143 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
147 val = clamp_t(u32, new_rx, min, max);
149 dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range. Using %u\n",
153 /* usbnet use these values for sizing rx queues */
154 dev->rx_urb_size = val;
156 /* inform device about NTB input size changes */
157 if (val != ctx->rx_max) {
158 __le32 dwNtbInMaxSize = cpu_to_le32(val);
160 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
162 /* need to unlink rx urbs before increasing buffer size */
163 if (netif_running(dev->net) && dev->rx_urb_size > ctx->rx_max)
164 usbnet_unlink_rx_urbs(dev);
166 /* tell device to use new size */
167 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
168 USB_TYPE_CLASS | USB_DIR_OUT
169 | USB_RECIP_INTERFACE,
170 0, iface_no, &dwNtbInMaxSize, 4) < 0)
171 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
176 /* clamp new_tx to sane values */
177 min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
178 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
180 /* some devices set dwNtbOutMaxSize too low for the above default */
183 val = clamp_t(u32, new_tx, min, max);
185 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range. Using %u\n",
188 if (val != ctx->tx_max)
189 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
191 /* Adding a pad byte here if necessary simplifies the handling
192 * in cdc_ncm_fill_tx_frame, making tx_max always represent
193 * the real skb max size.
195 * We cannot use dev->maxpacket here because this is called from
196 * .bind which is called before usbnet sets up dev->maxpacket
198 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
199 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
202 /* we might need to flush any pending tx buffers if running */
203 if (netif_running(dev->net) && val > ctx->tx_max) {
204 netif_tx_lock_bh(dev->net);
205 usbnet_start_xmit(NULL, dev->net);
207 netif_tx_unlock_bh(dev->net);
212 dev->hard_mtu = ctx->tx_max;
214 /* max qlen depend on hard_mtu and rx_urb_size */
215 usbnet_update_max_qlen(dev);
217 /* never pad more than 3 full USB packets per transfer */
218 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
219 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
222 /* helpers for NCM and MBIM differences */
223 static u8 cdc_ncm_flags(struct usbnet *dev)
225 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
227 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
228 return ctx->mbim_desc->bmNetworkCapabilities;
230 return ctx->func_desc->bmNetworkCapabilities;
234 static int cdc_ncm_eth_hlen(struct usbnet *dev)
236 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
241 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
243 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
244 return CDC_MBIM_MIN_DATAGRAM_SIZE;
245 return CDC_NCM_MIN_DATAGRAM_SIZE;
248 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
250 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
252 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
253 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
255 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
256 return CDC_NCM_MAX_DATAGRAM_SIZE;
259 /* initial one-time device setup. MUST be called with the data interface
262 static int cdc_ncm_init(struct usbnet *dev)
264 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
265 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
268 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
269 USB_TYPE_CLASS | USB_DIR_IN
270 |USB_RECIP_INTERFACE,
271 0, iface_no, &ctx->ncm_parm,
272 sizeof(ctx->ncm_parm));
274 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
275 return err; /* GET_NTB_PARAMETERS is required */
279 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
280 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
281 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
282 USB_TYPE_CLASS | USB_DIR_OUT
283 | USB_RECIP_INTERFACE,
284 USB_CDC_NCM_CRC_NOT_APPENDED,
287 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
290 /* set NTB format, if both formats are supported.
292 * "The host shall only send this command while the NCM Data
293 * Interface is in alternate setting 0."
295 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) & USB_CDC_NCM_NTH32_SIGN) {
296 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
297 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
298 USB_TYPE_CLASS | USB_DIR_OUT
299 | USB_RECIP_INTERFACE,
300 USB_CDC_NCM_NTB16_FORMAT,
303 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
306 /* set initial device values */
307 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
308 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
309 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
310 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
311 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
312 /* devices prior to NCM Errata shall set this field to zero */
313 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
315 dev_dbg(&dev->intf->dev,
316 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
317 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
318 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
320 /* max count of tx datagrams */
321 if ((ctx->tx_max_datagrams == 0) ||
322 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
323 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
325 /* set up maximum NDP size */
326 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
328 /* initial coalescing timer interval */
329 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
334 /* set a new max datagram size */
335 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
337 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
338 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
339 __le16 max_datagram_size;
343 /* set default based on descriptors */
344 ctx->max_datagram_size = clamp_t(u32, new_size,
345 cdc_ncm_min_dgram_size(dev),
346 CDC_NCM_MAX_DATAGRAM_SIZE);
348 /* inform the device about the selected Max Datagram Size? */
349 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
352 /* read current mtu value from device */
353 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
354 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
355 0, iface_no, &max_datagram_size, 2);
357 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
361 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
364 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
365 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
366 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
367 0, iface_no, &max_datagram_size, 2);
369 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
372 /* set MTU to max supported by the device if necessary */
373 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
375 /* do not exceed operater preferred MTU */
376 if (ctx->mbim_extended_desc) {
377 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
378 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
379 dev->net->mtu = mbim_mtu;
383 static void cdc_ncm_fix_modulus(struct usbnet *dev)
385 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
389 * verify that the structure alignment is:
391 * - not greater than the maximum transmit length
392 * - not less than four bytes
394 val = ctx->tx_ndp_modulus;
396 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
397 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
398 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
399 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
403 * verify that the payload alignment is:
405 * - not greater than the maximum transmit length
406 * - not less than four bytes
408 val = ctx->tx_modulus;
410 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
411 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
412 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
413 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
416 /* verify the payload remainder */
417 if (ctx->tx_remainder >= ctx->tx_modulus) {
418 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
419 ctx->tx_remainder = 0;
422 /* adjust TX-remainder according to NCM specification. */
423 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
424 (ctx->tx_modulus - 1));
427 static int cdc_ncm_setup(struct usbnet *dev)
429 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
431 /* clamp rx_max and tx_max and inform device */
432 cdc_ncm_update_rxtx_max(dev, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize),
433 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
435 /* sanitize the modulus and remainder values */
436 cdc_ncm_fix_modulus(dev);
438 /* set max datagram size */
439 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
444 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
446 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
449 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
451 e = intf->cur_altsetting->endpoint + ep;
452 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
453 case USB_ENDPOINT_XFER_INT:
454 if (usb_endpoint_dir_in(&e->desc)) {
460 case USB_ENDPOINT_XFER_BULK:
461 if (usb_endpoint_dir_in(&e->desc)) {
475 dev->in = usb_rcvbulkpipe(dev->udev,
476 in->desc.bEndpointAddress &
477 USB_ENDPOINT_NUMBER_MASK);
478 if (out && !dev->out)
479 dev->out = usb_sndbulkpipe(dev->udev,
480 out->desc.bEndpointAddress &
481 USB_ENDPOINT_NUMBER_MASK);
484 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
489 if (ctx->tx_rem_skb != NULL) {
490 dev_kfree_skb_any(ctx->tx_rem_skb);
491 ctx->tx_rem_skb = NULL;
494 if (ctx->tx_curr_skb != NULL) {
495 dev_kfree_skb_any(ctx->tx_curr_skb);
496 ctx->tx_curr_skb = NULL;
502 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting)
504 const struct usb_cdc_union_desc *union_desc = NULL;
505 struct cdc_ncm_ctx *ctx;
506 struct usb_driver *driver;
512 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
516 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
517 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
518 ctx->bh.data = (unsigned long)dev;
519 ctx->bh.func = cdc_ncm_txpath_bh;
520 atomic_set(&ctx->stop, 0);
521 spin_lock_init(&ctx->mtx);
523 /* store ctx pointer in device data field */
524 dev->data[0] = (unsigned long)ctx;
526 /* only the control interface can be successfully probed */
529 /* get some pointers */
530 driver = driver_of(intf);
531 buf = intf->cur_altsetting->extra;
532 len = intf->cur_altsetting->extralen;
534 /* parse through descriptors associated with control interface */
535 while ((len > 0) && (buf[0] > 2) && (buf[0] <= len)) {
537 if (buf[1] != USB_DT_CS_INTERFACE)
541 case USB_CDC_UNION_TYPE:
542 if (buf[0] < sizeof(*union_desc))
545 union_desc = (const struct usb_cdc_union_desc *)buf;
546 /* the master must be the interface we are probing */
547 if (intf->cur_altsetting->desc.bInterfaceNumber !=
548 union_desc->bMasterInterface0) {
549 dev_dbg(&intf->dev, "bogus CDC Union\n");
552 ctx->data = usb_ifnum_to_if(dev->udev,
553 union_desc->bSlaveInterface0);
556 case USB_CDC_ETHERNET_TYPE:
557 if (buf[0] < sizeof(*(ctx->ether_desc)))
561 (const struct usb_cdc_ether_desc *)buf;
564 case USB_CDC_NCM_TYPE:
565 if (buf[0] < sizeof(*(ctx->func_desc)))
568 ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
571 case USB_CDC_MBIM_TYPE:
572 if (buf[0] < sizeof(*(ctx->mbim_desc)))
575 ctx->mbim_desc = (const struct usb_cdc_mbim_desc *)buf;
578 case USB_CDC_MBIM_EXTENDED_TYPE:
579 if (buf[0] < sizeof(*(ctx->mbim_extended_desc)))
582 ctx->mbim_extended_desc =
583 (const struct usb_cdc_mbim_extended_desc *)buf;
590 /* advance to next descriptor */
596 /* some buggy devices have an IAD but no CDC Union */
597 if (!union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
598 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
599 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
602 /* check if we got everything */
604 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
607 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
608 if (!ctx->mbim_desc) {
609 dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
613 if (!ctx->ether_desc || !ctx->func_desc) {
614 dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
619 /* claim data interface, if different from control */
620 if (ctx->data != ctx->control) {
621 temp = usb_driver_claim_interface(driver, ctx->data, dev);
623 dev_dbg(&intf->dev, "failed to claim data intf\n");
628 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
630 /* reset data interface */
631 temp = usb_set_interface(dev->udev, iface_no, 0);
633 dev_dbg(&intf->dev, "set interface failed\n");
637 /* initialize basic device settings */
638 if (cdc_ncm_init(dev))
641 /* configure data interface */
642 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
644 dev_dbg(&intf->dev, "set interface failed\n");
648 cdc_ncm_find_endpoints(dev, ctx->data);
649 cdc_ncm_find_endpoints(dev, ctx->control);
650 if (!dev->in || !dev->out || !dev->status) {
651 dev_dbg(&intf->dev, "failed to collect endpoints\n");
655 usb_set_intfdata(ctx->data, dev);
656 usb_set_intfdata(ctx->control, dev);
658 if (ctx->ether_desc) {
659 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
661 dev_dbg(&intf->dev, "failed to get mac address\n");
664 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
667 /* finish setting up the device specific data */
670 /* override ethtool_ops */
671 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
676 usb_set_intfdata(ctx->control, NULL);
677 usb_set_intfdata(ctx->data, NULL);
678 if (ctx->data != ctx->control)
679 usb_driver_release_interface(driver, ctx->data);
681 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
683 dev_info(&intf->dev, "bind() failure\n");
686 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
688 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
690 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
691 struct usb_driver *driver = driver_of(intf);
694 return; /* no setup */
696 atomic_set(&ctx->stop, 1);
698 if (hrtimer_active(&ctx->tx_timer))
699 hrtimer_cancel(&ctx->tx_timer);
701 tasklet_kill(&ctx->bh);
703 /* handle devices with combined control and data interface */
704 if (ctx->control == ctx->data)
707 /* disconnect master --> disconnect slave */
708 if (intf == ctx->control && ctx->data) {
709 usb_set_intfdata(ctx->data, NULL);
710 usb_driver_release_interface(driver, ctx->data);
713 } else if (intf == ctx->data && ctx->control) {
714 usb_set_intfdata(ctx->control, NULL);
715 usb_driver_release_interface(driver, ctx->control);
719 usb_set_intfdata(intf, NULL);
722 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
724 /* Return the number of the MBIM control interface altsetting iff it
725 * is preferred and available,
727 u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
729 struct usb_host_interface *alt;
731 /* The MBIM spec defines a NCM compatible default altsetting,
732 * which we may have matched:
734 * "Functions that implement both NCM 1.0 and MBIM (an
735 * “NCM/MBIM function”) according to this recommendation
736 * shall provide two alternate settings for the
737 * Communication Interface. Alternate setting 0, and the
738 * associated class and endpoint descriptors, shall be
739 * constructed according to the rules given for the
740 * Communication Interface in section 5 of [USBNCM10].
741 * Alternate setting 1, and the associated class and
742 * endpoint descriptors, shall be constructed according to
743 * the rules given in section 6 (USB Device Model) of this
746 if (intf->num_altsetting < 2)
747 return intf->cur_altsetting->desc.bAlternateSetting;
750 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
751 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
752 return CDC_NCM_COMM_ALTSETTING_MBIM;
754 return CDC_NCM_COMM_ALTSETTING_NCM;
756 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
758 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
762 /* MBIM backwards compatible function? */
763 if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
766 /* The NCM data altsetting is fixed */
767 ret = cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM);
770 * We should get an event when network connection is "connected" or
771 * "disconnected". Set network connection in "disconnected" state
772 * (carrier is OFF) during attach, so the IP network stack does not
773 * start IPv6 negotiation and more.
775 usbnet_link_change(dev, 0, 0);
779 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
781 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
783 if (skb->len + align > max)
784 align = max - skb->len;
785 if (align && skb_tailroom(skb) >= align)
786 memset(skb_put(skb, align), 0, align);
789 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
790 * allocating a new one within skb
792 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
794 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
795 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
796 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
798 /* follow the chain of NDPs, looking for a match */
800 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
801 if (ndp16->dwSignature == sign)
803 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
807 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
809 /* verify that there is room for the NDP and the datagram (reserve) */
810 if ((ctx->tx_max - skb->len - reserve) < ctx->max_ndp_size)
815 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
817 nth16->wNdpIndex = cpu_to_le16(skb->len);
819 /* push a new empty NDP */
820 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, ctx->max_ndp_size);
821 ndp16->dwSignature = sign;
822 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
827 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
829 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
830 struct usb_cdc_ncm_nth16 *nth16;
831 struct usb_cdc_ncm_ndp16 *ndp16;
832 struct sk_buff *skb_out;
833 u16 n = 0, index, ndplen;
836 /* if there is a remaining skb, it gets priority */
838 swap(skb, ctx->tx_rem_skb);
839 swap(sign, ctx->tx_rem_sign);
844 /* check if we are resuming an OUT skb */
845 skb_out = ctx->tx_curr_skb;
847 /* allocate a new OUT skb */
849 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
850 if (skb_out == NULL) {
852 dev_kfree_skb_any(skb);
853 dev->net->stats.tx_dropped++;
857 /* fill out the initial 16-bit NTB header */
858 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
859 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
860 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
861 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
863 /* count total number of frames in this NTB */
864 ctx->tx_curr_frame_num = 0;
867 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
868 /* send any remaining skb first */
870 skb = ctx->tx_rem_skb;
871 sign = ctx->tx_rem_sign;
872 ctx->tx_rem_skb = NULL;
874 /* check for end of skb */
879 /* get the appropriate NDP for this skb */
880 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
882 /* align beginning of next frame */
883 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
885 /* check if we had enough room left for both NDP and frame */
886 if (!ndp16 || skb_out->len + skb->len > ctx->tx_max) {
888 /* won't fit, MTU problem? */
889 dev_kfree_skb_any(skb);
891 dev->net->stats.tx_dropped++;
893 /* no room for skb - store for later */
894 if (ctx->tx_rem_skb != NULL) {
895 dev_kfree_skb_any(ctx->tx_rem_skb);
896 dev->net->stats.tx_dropped++;
898 ctx->tx_rem_skb = skb;
899 ctx->tx_rem_sign = sign;
906 /* calculate frame number withing this NDP */
907 ndplen = le16_to_cpu(ndp16->wLength);
908 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
910 /* OK, add this skb */
911 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
912 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
913 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
914 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
915 dev_kfree_skb_any(skb);
918 /* send now if this NDP is full */
919 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
925 /* free up any dangling skb */
927 dev_kfree_skb_any(skb);
929 dev->net->stats.tx_dropped++;
932 ctx->tx_curr_frame_num = n;
935 /* wait for more frames */
937 ctx->tx_curr_skb = skb_out;
940 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
941 /* wait for more frames */
943 ctx->tx_curr_skb = skb_out;
944 /* set the pending count */
945 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
946 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
951 /* variables will be reset at next call */
954 /* If collected data size is less or equal ctx->min_tx_pkt
955 * bytes, we send buffers as it is. If we get more data, it
956 * would be more efficient for USB HS mobile device with DMA
957 * engine to receive a full size NTB, than canceling DMA
958 * transfer and receiving a short packet.
960 * This optimization support is pointless if we end up sending
961 * a ZLP after full sized NTBs.
963 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
964 skb_out->len > ctx->min_tx_pkt)
965 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
966 ctx->tx_max - skb_out->len);
967 else if (skb_out->len < ctx->tx_max && (skb_out->len % dev->maxpacket) == 0)
968 *skb_put(skb_out, 1) = 0; /* force short packet */
970 /* set final frame length */
971 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
972 nth16->wBlockLength = cpu_to_le16(skb_out->len);
975 ctx->tx_curr_skb = NULL;
976 dev->net->stats.tx_packets += ctx->tx_curr_frame_num;
980 /* Start timer, if there is a remaining skb */
981 if (ctx->tx_curr_skb != NULL)
982 cdc_ncm_tx_timeout_start(ctx);
985 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
987 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
989 /* start timer, if not already started */
990 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
991 hrtimer_start(&ctx->tx_timer,
992 ktime_set(0, ctx->timer_interval),
996 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
998 struct cdc_ncm_ctx *ctx =
999 container_of(timer, struct cdc_ncm_ctx, tx_timer);
1001 if (!atomic_read(&ctx->stop))
1002 tasklet_schedule(&ctx->bh);
1003 return HRTIMER_NORESTART;
1006 static void cdc_ncm_txpath_bh(unsigned long param)
1008 struct usbnet *dev = (struct usbnet *)param;
1009 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1011 spin_lock_bh(&ctx->mtx);
1012 if (ctx->tx_timer_pending != 0) {
1013 ctx->tx_timer_pending--;
1014 cdc_ncm_tx_timeout_start(ctx);
1015 spin_unlock_bh(&ctx->mtx);
1016 } else if (dev->net != NULL) {
1017 spin_unlock_bh(&ctx->mtx);
1018 netif_tx_lock_bh(dev->net);
1019 usbnet_start_xmit(NULL, dev->net);
1020 netif_tx_unlock_bh(dev->net);
1022 spin_unlock_bh(&ctx->mtx);
1027 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1029 struct sk_buff *skb_out;
1030 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1033 * The Ethernet API we are using does not support transmitting
1034 * multiple Ethernet frames in a single call. This driver will
1035 * accumulate multiple Ethernet frames and send out a larger
1036 * USB frame when the USB buffer is full or when a single jiffies
1042 spin_lock_bh(&ctx->mtx);
1043 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1044 spin_unlock_bh(&ctx->mtx);
1049 dev_kfree_skb_any(skb);
1053 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1055 /* verify NTB header and return offset of first NDP, or negative error */
1056 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1058 struct usbnet *dev = netdev_priv(skb_in->dev);
1059 struct usb_cdc_ncm_nth16 *nth16;
1066 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1067 sizeof(struct usb_cdc_ncm_ndp16))) {
1068 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1072 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1074 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1075 netif_dbg(dev, rx_err, dev->net,
1076 "invalid NTH16 signature <%#010x>\n",
1077 le32_to_cpu(nth16->dwSignature));
1081 len = le16_to_cpu(nth16->wBlockLength);
1082 if (len > ctx->rx_max) {
1083 netif_dbg(dev, rx_err, dev->net,
1084 "unsupported NTB block length %u/%u\n", len,
1089 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1090 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1091 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1092 netif_dbg(dev, rx_err, dev->net,
1093 "sequence number glitch prev=%d curr=%d\n",
1094 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1096 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1098 ret = le16_to_cpu(nth16->wNdpIndex);
1102 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1104 /* verify NDP header and return number of datagrams, or negative error */
1105 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1107 struct usbnet *dev = netdev_priv(skb_in->dev);
1108 struct usb_cdc_ncm_ndp16 *ndp16;
1111 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1112 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1116 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1118 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1119 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1120 le16_to_cpu(ndp16->wLength));
1124 ret = ((le16_to_cpu(ndp16->wLength) -
1125 sizeof(struct usb_cdc_ncm_ndp16)) /
1126 sizeof(struct usb_cdc_ncm_dpe16));
1127 ret--; /* we process NDP entries except for the last one */
1129 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1130 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1131 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1138 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1140 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1142 struct sk_buff *skb;
1143 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1148 struct usb_cdc_ncm_ndp16 *ndp16;
1149 struct usb_cdc_ncm_dpe16 *dpe16;
1151 int loopcount = 50; /* arbitrary max preventing infinite loop */
1153 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1158 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1162 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1164 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1165 netif_dbg(dev, rx_err, dev->net,
1166 "invalid DPT16 signature <%#010x>\n",
1167 le32_to_cpu(ndp16->dwSignature));
1170 dpe16 = ndp16->dpe16;
1172 for (x = 0; x < nframes; x++, dpe16++) {
1173 offset = le16_to_cpu(dpe16->wDatagramIndex);
1174 len = le16_to_cpu(dpe16->wDatagramLength);
1178 * All entries after first NULL entry are to be ignored
1180 if ((offset == 0) || (len == 0)) {
1182 goto err_ndp; /* empty NTB */
1186 /* sanity checking */
1187 if (((offset + len) > skb_in->len) ||
1188 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1189 netif_dbg(dev, rx_err, dev->net,
1190 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1191 x, offset, len, skb_in);
1197 skb = skb_clone(skb_in, GFP_ATOMIC);
1201 skb->data = ((u8 *)skb_in->data) + offset;
1202 skb_set_tail_pointer(skb, len);
1203 usbnet_skb_return(dev, skb);
1207 /* are there more NDPs to process? */
1208 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1209 if (ndpoffset && loopcount--)
1216 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1219 cdc_ncm_speed_change(struct usbnet *dev,
1220 struct usb_cdc_speed_change *data)
1222 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1223 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1226 * Currently the USB-NET API does not support reporting the actual
1227 * device speed. Do print it instead.
1229 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1230 netif_info(dev, link, dev->net,
1231 "%u mbit/s downlink %u mbit/s uplink\n",
1232 (unsigned int)(rx_speed / 1000000U),
1233 (unsigned int)(tx_speed / 1000000U));
1235 netif_info(dev, link, dev->net,
1236 "%u kbit/s downlink %u kbit/s uplink\n",
1237 (unsigned int)(rx_speed / 1000U),
1238 (unsigned int)(tx_speed / 1000U));
1242 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1244 struct cdc_ncm_ctx *ctx;
1245 struct usb_cdc_notification *event;
1247 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1249 if (urb->actual_length < sizeof(*event))
1252 /* test for split data in 8-byte chunks */
1253 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1254 cdc_ncm_speed_change(dev,
1255 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1259 event = urb->transfer_buffer;
1261 switch (event->bNotificationType) {
1262 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1264 * According to the CDC NCM specification ch.7.1
1265 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1266 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1268 ctx->connected = le16_to_cpu(event->wValue);
1269 netif_info(dev, link, dev->net,
1270 "network connection: %sconnected\n",
1271 ctx->connected ? "" : "dis");
1272 usbnet_link_change(dev, ctx->connected, 0);
1275 case USB_CDC_NOTIFY_SPEED_CHANGE:
1276 if (urb->actual_length < (sizeof(*event) +
1277 sizeof(struct usb_cdc_speed_change)))
1278 set_bit(EVENT_STS_SPLIT, &dev->flags);
1280 cdc_ncm_speed_change(dev,
1281 (struct usb_cdc_speed_change *)&event[1]);
1285 dev_dbg(&dev->udev->dev,
1286 "NCM: unexpected notification 0x%02x!\n",
1287 event->bNotificationType);
1292 static int cdc_ncm_check_connect(struct usbnet *dev)
1294 struct cdc_ncm_ctx *ctx;
1296 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1298 return 1; /* disconnected */
1300 return !ctx->connected;
1303 static const struct driver_info cdc_ncm_info = {
1304 .description = "CDC NCM",
1305 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1306 .bind = cdc_ncm_bind,
1307 .unbind = cdc_ncm_unbind,
1308 .check_connect = cdc_ncm_check_connect,
1309 .manage_power = usbnet_manage_power,
1310 .status = cdc_ncm_status,
1311 .rx_fixup = cdc_ncm_rx_fixup,
1312 .tx_fixup = cdc_ncm_tx_fixup,
1315 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1316 static const struct driver_info wwan_info = {
1317 .description = "Mobile Broadband Network Device",
1318 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1320 .bind = cdc_ncm_bind,
1321 .unbind = cdc_ncm_unbind,
1322 .check_connect = cdc_ncm_check_connect,
1323 .manage_power = usbnet_manage_power,
1324 .status = cdc_ncm_status,
1325 .rx_fixup = cdc_ncm_rx_fixup,
1326 .tx_fixup = cdc_ncm_tx_fixup,
1329 /* Same as wwan_info, but with FLAG_NOARP */
1330 static const struct driver_info wwan_noarp_info = {
1331 .description = "Mobile Broadband Network Device (NO ARP)",
1332 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1333 | FLAG_WWAN | FLAG_NOARP,
1334 .bind = cdc_ncm_bind,
1335 .unbind = cdc_ncm_unbind,
1336 .check_connect = cdc_ncm_check_connect,
1337 .manage_power = usbnet_manage_power,
1338 .status = cdc_ncm_status,
1339 .rx_fixup = cdc_ncm_rx_fixup,
1340 .tx_fixup = cdc_ncm_tx_fixup,
1343 static const struct usb_device_id cdc_devs[] = {
1344 /* Ericsson MBM devices like F5521gw */
1345 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1346 | USB_DEVICE_ID_MATCH_VENDOR,
1348 .bInterfaceClass = USB_CLASS_COMM,
1349 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1350 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1351 .driver_info = (unsigned long) &wwan_info,
1354 /* Dell branded MBM devices like DW5550 */
1355 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1356 | USB_DEVICE_ID_MATCH_VENDOR,
1358 .bInterfaceClass = USB_CLASS_COMM,
1359 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1360 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1361 .driver_info = (unsigned long) &wwan_info,
1364 /* Toshiba branded MBM devices */
1365 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1366 | USB_DEVICE_ID_MATCH_VENDOR,
1368 .bInterfaceClass = USB_CLASS_COMM,
1369 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1370 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1371 .driver_info = (unsigned long) &wwan_info,
1374 /* tag Huawei devices as wwan */
1375 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1377 USB_CDC_SUBCLASS_NCM,
1378 USB_CDC_PROTO_NONE),
1379 .driver_info = (unsigned long)&wwan_info,
1382 /* Infineon(now Intel) HSPA Modem platform */
1383 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1385 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1386 .driver_info = (unsigned long)&wwan_noarp_info,
1389 /* Generic CDC-NCM devices */
1390 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1391 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1392 .driver_info = (unsigned long)&cdc_ncm_info,
1397 MODULE_DEVICE_TABLE(usb, cdc_devs);
1399 static struct usb_driver cdc_ncm_driver = {
1401 .id_table = cdc_devs,
1402 .probe = usbnet_probe,
1403 .disconnect = usbnet_disconnect,
1404 .suspend = usbnet_suspend,
1405 .resume = usbnet_resume,
1406 .reset_resume = usbnet_resume,
1407 .supports_autosuspend = 1,
1408 .disable_hub_initiated_lpm = 1,
1411 module_usb_driver(cdc_ncm_driver);
1413 MODULE_AUTHOR("Hans Petter Selasky");
1414 MODULE_DESCRIPTION("USB CDC NCM host driver");
1415 MODULE_LICENSE("Dual BSD/GPL");