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_setup(struct usbnet *dev)
70 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
77 u16 ntb_fmt_supported;
78 __le16 max_datagram_size;
80 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
82 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
83 USB_TYPE_CLASS | USB_DIR_IN
85 0, iface_no, &ctx->ncm_parm,
86 sizeof(ctx->ncm_parm));
88 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
89 return err; /* GET_NTB_PARAMETERS is required */
92 /* read correct set of parameters according to device mode */
93 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
94 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
95 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
96 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
97 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
98 /* devices prior to NCM Errata shall set this field to zero */
99 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
100 ntb_fmt_supported = le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported);
102 /* there are some minor differences in NCM and MBIM defaults */
103 if (cdc_ncm_comm_intf_is_mbim(ctx->control->cur_altsetting)) {
107 flags = ctx->mbim_desc->bmNetworkCapabilities;
108 ctx->max_datagram_size = le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
109 if (ctx->max_datagram_size < CDC_MBIM_MIN_DATAGRAM_SIZE)
110 ctx->max_datagram_size = CDC_MBIM_MIN_DATAGRAM_SIZE;
115 flags = ctx->func_desc->bmNetworkCapabilities;
116 ctx->max_datagram_size = le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
117 if (ctx->max_datagram_size < CDC_NCM_MIN_DATAGRAM_SIZE)
118 ctx->max_datagram_size = CDC_NCM_MIN_DATAGRAM_SIZE;
121 /* common absolute max for NCM and MBIM */
122 if (ctx->max_datagram_size > CDC_NCM_MAX_DATAGRAM_SIZE)
123 ctx->max_datagram_size = CDC_NCM_MAX_DATAGRAM_SIZE;
125 dev_dbg(&dev->intf->dev,
126 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
127 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
128 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, flags);
130 /* max count of tx datagrams */
131 if ((ctx->tx_max_datagrams == 0) ||
132 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
133 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
135 /* verify maximum size of received NTB in bytes */
136 if (ctx->rx_max < USB_CDC_NCM_NTB_MIN_IN_SIZE) {
137 dev_dbg(&dev->intf->dev, "Using min receive length=%d\n",
138 USB_CDC_NCM_NTB_MIN_IN_SIZE);
139 ctx->rx_max = USB_CDC_NCM_NTB_MIN_IN_SIZE;
142 if (ctx->rx_max > CDC_NCM_NTB_MAX_SIZE_RX) {
143 dev_dbg(&dev->intf->dev, "Using default maximum receive length=%d\n",
144 CDC_NCM_NTB_MAX_SIZE_RX);
145 ctx->rx_max = CDC_NCM_NTB_MAX_SIZE_RX;
148 /* inform device about NTB input size changes */
149 if (ctx->rx_max != le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize)) {
150 __le32 dwNtbInMaxSize = cpu_to_le32(ctx->rx_max);
152 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
153 USB_TYPE_CLASS | USB_DIR_OUT
154 | USB_RECIP_INTERFACE,
155 0, iface_no, &dwNtbInMaxSize, 4);
157 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
160 /* verify maximum size of transmitted NTB in bytes */
161 if (ctx->tx_max > CDC_NCM_NTB_MAX_SIZE_TX) {
162 dev_dbg(&dev->intf->dev, "Using default maximum transmit length=%d\n",
163 CDC_NCM_NTB_MAX_SIZE_TX);
164 ctx->tx_max = CDC_NCM_NTB_MAX_SIZE_TX;
168 * verify that the structure alignment is:
170 * - not greater than the maximum transmit length
171 * - not less than four bytes
173 val = ctx->tx_ndp_modulus;
175 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
176 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
177 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
178 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
182 * verify that the payload alignment is:
184 * - not greater than the maximum transmit length
185 * - not less than four bytes
187 val = ctx->tx_modulus;
189 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
190 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
191 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
192 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
195 /* verify the payload remainder */
196 if (ctx->tx_remainder >= ctx->tx_modulus) {
197 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
198 ctx->tx_remainder = 0;
201 /* adjust TX-remainder according to NCM specification. */
202 ctx->tx_remainder = ((ctx->tx_remainder - eth_hlen) &
203 (ctx->tx_modulus - 1));
205 /* additional configuration */
208 if (flags & USB_CDC_NCM_NCAP_CRC_MODE) {
209 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
210 USB_TYPE_CLASS | USB_DIR_OUT
211 | USB_RECIP_INTERFACE,
212 USB_CDC_NCM_CRC_NOT_APPENDED,
215 dev_dbg(&dev->intf->dev, "Setting CRC mode off failed\n");
218 /* set NTB format, if both formats are supported */
219 if (ntb_fmt_supported & USB_CDC_NCM_NTH32_SIGN) {
220 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
221 USB_TYPE_CLASS | USB_DIR_OUT
222 | USB_RECIP_INTERFACE,
223 USB_CDC_NCM_NTB16_FORMAT,
226 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit failed\n");
229 /* inform the device about the selected Max Datagram Size */
230 if (!(flags & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
233 /* read current mtu value from device */
234 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
235 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
236 0, iface_no, &max_datagram_size, 2);
238 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
242 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
245 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
246 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
247 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
248 0, iface_no, &max_datagram_size, 2);
250 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
253 /* set MTU to max supported by the device if necessary */
254 if (dev->net->mtu > ctx->max_datagram_size - eth_hlen)
255 dev->net->mtu = ctx->max_datagram_size - eth_hlen;
257 /* do not exceed operater preferred MTU */
258 if (ctx->mbim_extended_desc) {
259 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
260 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
261 dev->net->mtu = mbim_mtu;
268 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
270 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
273 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
275 e = intf->cur_altsetting->endpoint + ep;
276 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
277 case USB_ENDPOINT_XFER_INT:
278 if (usb_endpoint_dir_in(&e->desc)) {
284 case USB_ENDPOINT_XFER_BULK:
285 if (usb_endpoint_dir_in(&e->desc)) {
299 dev->in = usb_rcvbulkpipe(dev->udev,
300 in->desc.bEndpointAddress &
301 USB_ENDPOINT_NUMBER_MASK);
302 if (out && !dev->out)
303 dev->out = usb_sndbulkpipe(dev->udev,
304 out->desc.bEndpointAddress &
305 USB_ENDPOINT_NUMBER_MASK);
308 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
313 if (ctx->tx_rem_skb != NULL) {
314 dev_kfree_skb_any(ctx->tx_rem_skb);
315 ctx->tx_rem_skb = NULL;
318 if (ctx->tx_curr_skb != NULL) {
319 dev_kfree_skb_any(ctx->tx_curr_skb);
320 ctx->tx_curr_skb = NULL;
326 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting)
328 const struct usb_cdc_union_desc *union_desc = NULL;
329 struct cdc_ncm_ctx *ctx;
330 struct usb_driver *driver;
336 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
340 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
341 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
342 ctx->bh.data = (unsigned long)dev;
343 ctx->bh.func = cdc_ncm_txpath_bh;
344 atomic_set(&ctx->stop, 0);
345 spin_lock_init(&ctx->mtx);
347 /* store ctx pointer in device data field */
348 dev->data[0] = (unsigned long)ctx;
350 /* only the control interface can be successfully probed */
353 /* get some pointers */
354 driver = driver_of(intf);
355 buf = intf->cur_altsetting->extra;
356 len = intf->cur_altsetting->extralen;
358 /* parse through descriptors associated with control interface */
359 while ((len > 0) && (buf[0] > 2) && (buf[0] <= len)) {
361 if (buf[1] != USB_DT_CS_INTERFACE)
365 case USB_CDC_UNION_TYPE:
366 if (buf[0] < sizeof(*union_desc))
369 union_desc = (const struct usb_cdc_union_desc *)buf;
370 /* the master must be the interface we are probing */
371 if (intf->cur_altsetting->desc.bInterfaceNumber !=
372 union_desc->bMasterInterface0) {
373 dev_dbg(&intf->dev, "bogus CDC Union\n");
376 ctx->data = usb_ifnum_to_if(dev->udev,
377 union_desc->bSlaveInterface0);
380 case USB_CDC_ETHERNET_TYPE:
381 if (buf[0] < sizeof(*(ctx->ether_desc)))
385 (const struct usb_cdc_ether_desc *)buf;
388 case USB_CDC_NCM_TYPE:
389 if (buf[0] < sizeof(*(ctx->func_desc)))
392 ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
395 case USB_CDC_MBIM_TYPE:
396 if (buf[0] < sizeof(*(ctx->mbim_desc)))
399 ctx->mbim_desc = (const struct usb_cdc_mbim_desc *)buf;
402 case USB_CDC_MBIM_EXTENDED_TYPE:
403 if (buf[0] < sizeof(*(ctx->mbim_extended_desc)))
406 ctx->mbim_extended_desc =
407 (const struct usb_cdc_mbim_extended_desc *)buf;
414 /* advance to next descriptor */
420 /* some buggy devices have an IAD but no CDC Union */
421 if (!union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
422 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
423 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
426 /* check if we got everything */
427 if (!ctx->data || (!ctx->mbim_desc && !ctx->ether_desc)) {
428 dev_dbg(&intf->dev, "CDC descriptors missing\n");
432 /* claim data interface, if different from control */
433 if (ctx->data != ctx->control) {
434 temp = usb_driver_claim_interface(driver, ctx->data, dev);
436 dev_dbg(&intf->dev, "failed to claim data intf\n");
441 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
443 /* reset data interface */
444 temp = usb_set_interface(dev->udev, iface_no, 0);
446 dev_dbg(&intf->dev, "set interface failed\n");
450 /* initialize data interface */
451 if (cdc_ncm_setup(dev))
454 /* configure data interface */
455 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
457 dev_dbg(&intf->dev, "set interface failed\n");
461 cdc_ncm_find_endpoints(dev, ctx->data);
462 cdc_ncm_find_endpoints(dev, ctx->control);
463 if (!dev->in || !dev->out || !dev->status) {
464 dev_dbg(&intf->dev, "failed to collect endpoints\n");
468 usb_set_intfdata(ctx->data, dev);
469 usb_set_intfdata(ctx->control, dev);
471 if (ctx->ether_desc) {
472 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
474 dev_dbg(&intf->dev, "failed to get mac address\n");
477 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
480 /* usbnet use these values for sizing tx/rx queues */
481 dev->hard_mtu = ctx->tx_max;
482 dev->rx_urb_size = ctx->rx_max;
484 /* cdc_ncm_setup will override dwNtbOutMaxSize if it is
485 * outside the sane range. Adding a pad byte here if necessary
486 * simplifies the handling in cdc_ncm_fill_tx_frame, making
487 * tx_max always represent the real skb max size.
489 if (ctx->tx_max != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
490 ctx->tx_max % usb_maxpacket(dev->udev, dev->out, 1) == 0)
496 usb_set_intfdata(ctx->control, NULL);
497 usb_set_intfdata(ctx->data, NULL);
498 if (ctx->data != ctx->control)
499 usb_driver_release_interface(driver, ctx->data);
501 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
503 dev_info(&intf->dev, "bind() failure\n");
506 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
508 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
510 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
511 struct usb_driver *driver = driver_of(intf);
514 return; /* no setup */
516 atomic_set(&ctx->stop, 1);
518 if (hrtimer_active(&ctx->tx_timer))
519 hrtimer_cancel(&ctx->tx_timer);
521 tasklet_kill(&ctx->bh);
523 /* handle devices with combined control and data interface */
524 if (ctx->control == ctx->data)
527 /* disconnect master --> disconnect slave */
528 if (intf == ctx->control && ctx->data) {
529 usb_set_intfdata(ctx->data, NULL);
530 usb_driver_release_interface(driver, ctx->data);
533 } else if (intf == ctx->data && ctx->control) {
534 usb_set_intfdata(ctx->control, NULL);
535 usb_driver_release_interface(driver, ctx->control);
539 usb_set_intfdata(intf, NULL);
542 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
544 /* Select the MBIM altsetting iff it is preferred and available,
545 * returning the number of the corresponding data interface altsetting
547 u8 cdc_ncm_select_altsetting(struct usbnet *dev, struct usb_interface *intf)
549 struct usb_host_interface *alt;
551 /* The MBIM spec defines a NCM compatible default altsetting,
552 * which we may have matched:
554 * "Functions that implement both NCM 1.0 and MBIM (an
555 * “NCM/MBIM function”) according to this recommendation
556 * shall provide two alternate settings for the
557 * Communication Interface. Alternate setting 0, and the
558 * associated class and endpoint descriptors, shall be
559 * constructed according to the rules given for the
560 * Communication Interface in section 5 of [USBNCM10].
561 * Alternate setting 1, and the associated class and
562 * endpoint descriptors, shall be constructed according to
563 * the rules given in section 6 (USB Device Model) of this
566 if (prefer_mbim && intf->num_altsetting == 2) {
567 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
568 if (alt && cdc_ncm_comm_intf_is_mbim(alt) &&
569 !usb_set_interface(dev->udev,
570 intf->cur_altsetting->desc.bInterfaceNumber,
571 CDC_NCM_COMM_ALTSETTING_MBIM))
572 return CDC_NCM_DATA_ALTSETTING_MBIM;
574 return CDC_NCM_DATA_ALTSETTING_NCM;
576 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
578 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
582 /* MBIM backwards compatible function? */
583 cdc_ncm_select_altsetting(dev, intf);
584 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting))
587 /* NCM data altsetting is always 1 */
588 ret = cdc_ncm_bind_common(dev, intf, 1);
591 * We should get an event when network connection is "connected" or
592 * "disconnected". Set network connection in "disconnected" state
593 * (carrier is OFF) during attach, so the IP network stack does not
594 * start IPv6 negotiation and more.
596 usbnet_link_change(dev, 0, 0);
600 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
602 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
604 if (skb->len + align > max)
605 align = max - skb->len;
606 if (align && skb_tailroom(skb) >= align)
607 memset(skb_put(skb, align), 0, align);
610 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
611 * allocating a new one within skb
613 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
615 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
616 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
617 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
619 /* follow the chain of NDPs, looking for a match */
621 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
622 if (ndp16->dwSignature == sign)
624 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
628 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
630 /* verify that there is room for the NDP and the datagram (reserve) */
631 if ((ctx->tx_max - skb->len - reserve) < CDC_NCM_NDP_SIZE)
636 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
638 nth16->wNdpIndex = cpu_to_le16(skb->len);
640 /* push a new empty NDP */
641 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, CDC_NCM_NDP_SIZE), 0, CDC_NCM_NDP_SIZE);
642 ndp16->dwSignature = sign;
643 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
648 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
650 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
651 struct usb_cdc_ncm_nth16 *nth16;
652 struct usb_cdc_ncm_ndp16 *ndp16;
653 struct sk_buff *skb_out;
654 u16 n = 0, index, ndplen;
657 /* if there is a remaining skb, it gets priority */
659 swap(skb, ctx->tx_rem_skb);
660 swap(sign, ctx->tx_rem_sign);
665 /* check if we are resuming an OUT skb */
666 skb_out = ctx->tx_curr_skb;
668 /* allocate a new OUT skb */
670 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
671 if (skb_out == NULL) {
673 dev_kfree_skb_any(skb);
674 dev->net->stats.tx_dropped++;
678 /* fill out the initial 16-bit NTB header */
679 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
680 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
681 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
682 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
684 /* count total number of frames in this NTB */
685 ctx->tx_curr_frame_num = 0;
688 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
689 /* send any remaining skb first */
691 skb = ctx->tx_rem_skb;
692 sign = ctx->tx_rem_sign;
693 ctx->tx_rem_skb = NULL;
695 /* check for end of skb */
700 /* get the appropriate NDP for this skb */
701 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
703 /* align beginning of next frame */
704 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
706 /* check if we had enough room left for both NDP and frame */
707 if (!ndp16 || skb_out->len + skb->len > ctx->tx_max) {
709 /* won't fit, MTU problem? */
710 dev_kfree_skb_any(skb);
712 dev->net->stats.tx_dropped++;
714 /* no room for skb - store for later */
715 if (ctx->tx_rem_skb != NULL) {
716 dev_kfree_skb_any(ctx->tx_rem_skb);
717 dev->net->stats.tx_dropped++;
719 ctx->tx_rem_skb = skb;
720 ctx->tx_rem_sign = sign;
727 /* calculate frame number withing this NDP */
728 ndplen = le16_to_cpu(ndp16->wLength);
729 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
731 /* OK, add this skb */
732 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
733 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
734 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
735 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
736 dev_kfree_skb_any(skb);
739 /* send now if this NDP is full */
740 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
746 /* free up any dangling skb */
748 dev_kfree_skb_any(skb);
750 dev->net->stats.tx_dropped++;
753 ctx->tx_curr_frame_num = n;
756 /* wait for more frames */
758 ctx->tx_curr_skb = skb_out;
761 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0)) {
762 /* wait for more frames */
764 ctx->tx_curr_skb = skb_out;
765 /* set the pending count */
766 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
767 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
772 /* variables will be reset at next call */
775 /* If collected data size is less or equal CDC_NCM_MIN_TX_PKT
776 * bytes, we send buffers as it is. If we get more data, it
777 * would be more efficient for USB HS mobile device with DMA
778 * engine to receive a full size NTB, than canceling DMA
779 * transfer and receiving a short packet.
781 * This optimization support is pointless if we end up sending
782 * a ZLP after full sized NTBs.
784 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
785 skb_out->len > CDC_NCM_MIN_TX_PKT)
786 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
787 ctx->tx_max - skb_out->len);
788 else if (skb_out->len < ctx->tx_max && (skb_out->len % dev->maxpacket) == 0)
789 *skb_put(skb_out, 1) = 0; /* force short packet */
791 /* set final frame length */
792 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
793 nth16->wBlockLength = cpu_to_le16(skb_out->len);
796 ctx->tx_curr_skb = NULL;
797 dev->net->stats.tx_packets += ctx->tx_curr_frame_num;
801 /* Start timer, if there is a remaining skb */
802 if (ctx->tx_curr_skb != NULL)
803 cdc_ncm_tx_timeout_start(ctx);
806 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
808 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
810 /* start timer, if not already started */
811 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
812 hrtimer_start(&ctx->tx_timer,
813 ktime_set(0, CDC_NCM_TIMER_INTERVAL),
817 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
819 struct cdc_ncm_ctx *ctx =
820 container_of(timer, struct cdc_ncm_ctx, tx_timer);
822 if (!atomic_read(&ctx->stop))
823 tasklet_schedule(&ctx->bh);
824 return HRTIMER_NORESTART;
827 static void cdc_ncm_txpath_bh(unsigned long param)
829 struct usbnet *dev = (struct usbnet *)param;
830 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
832 spin_lock_bh(&ctx->mtx);
833 if (ctx->tx_timer_pending != 0) {
834 ctx->tx_timer_pending--;
835 cdc_ncm_tx_timeout_start(ctx);
836 spin_unlock_bh(&ctx->mtx);
837 } else if (dev->net != NULL) {
838 spin_unlock_bh(&ctx->mtx);
839 netif_tx_lock_bh(dev->net);
840 usbnet_start_xmit(NULL, dev->net);
841 netif_tx_unlock_bh(dev->net);
843 spin_unlock_bh(&ctx->mtx);
848 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
850 struct sk_buff *skb_out;
851 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
854 * The Ethernet API we are using does not support transmitting
855 * multiple Ethernet frames in a single call. This driver will
856 * accumulate multiple Ethernet frames and send out a larger
857 * USB frame when the USB buffer is full or when a single jiffies
863 spin_lock_bh(&ctx->mtx);
864 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
865 spin_unlock_bh(&ctx->mtx);
870 dev_kfree_skb_any(skb);
874 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
876 /* verify NTB header and return offset of first NDP, or negative error */
877 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
879 struct usbnet *dev = netdev_priv(skb_in->dev);
880 struct usb_cdc_ncm_nth16 *nth16;
887 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
888 sizeof(struct usb_cdc_ncm_ndp16))) {
889 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
893 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
895 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
896 netif_dbg(dev, rx_err, dev->net,
897 "invalid NTH16 signature <%#010x>\n",
898 le32_to_cpu(nth16->dwSignature));
902 len = le16_to_cpu(nth16->wBlockLength);
903 if (len > ctx->rx_max) {
904 netif_dbg(dev, rx_err, dev->net,
905 "unsupported NTB block length %u/%u\n", len,
910 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
911 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
912 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
913 netif_dbg(dev, rx_err, dev->net,
914 "sequence number glitch prev=%d curr=%d\n",
915 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
917 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
919 ret = le16_to_cpu(nth16->wNdpIndex);
923 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
925 /* verify NDP header and return number of datagrams, or negative error */
926 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
928 struct usbnet *dev = netdev_priv(skb_in->dev);
929 struct usb_cdc_ncm_ndp16 *ndp16;
932 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
933 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
937 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
939 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
940 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
941 le16_to_cpu(ndp16->wLength));
945 ret = ((le16_to_cpu(ndp16->wLength) -
946 sizeof(struct usb_cdc_ncm_ndp16)) /
947 sizeof(struct usb_cdc_ncm_dpe16));
948 ret--; /* we process NDP entries except for the last one */
950 if ((sizeof(struct usb_cdc_ncm_ndp16) +
951 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
952 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
959 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
961 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
964 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
969 struct usb_cdc_ncm_ndp16 *ndp16;
970 struct usb_cdc_ncm_dpe16 *dpe16;
972 int loopcount = 50; /* arbitrary max preventing infinite loop */
974 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
979 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
983 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
985 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
986 netif_dbg(dev, rx_err, dev->net,
987 "invalid DPT16 signature <%#010x>\n",
988 le32_to_cpu(ndp16->dwSignature));
991 dpe16 = ndp16->dpe16;
993 for (x = 0; x < nframes; x++, dpe16++) {
994 offset = le16_to_cpu(dpe16->wDatagramIndex);
995 len = le16_to_cpu(dpe16->wDatagramLength);
999 * All entries after first NULL entry are to be ignored
1001 if ((offset == 0) || (len == 0)) {
1003 goto err_ndp; /* empty NTB */
1007 /* sanity checking */
1008 if (((offset + len) > skb_in->len) ||
1009 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1010 netif_dbg(dev, rx_err, dev->net,
1011 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1012 x, offset, len, skb_in);
1018 skb = skb_clone(skb_in, GFP_ATOMIC);
1022 skb->data = ((u8 *)skb_in->data) + offset;
1023 skb_set_tail_pointer(skb, len);
1024 usbnet_skb_return(dev, skb);
1028 /* are there more NDPs to process? */
1029 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1030 if (ndpoffset && loopcount--)
1037 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1040 cdc_ncm_speed_change(struct usbnet *dev,
1041 struct usb_cdc_speed_change *data)
1043 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1044 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1047 * Currently the USB-NET API does not support reporting the actual
1048 * device speed. Do print it instead.
1050 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1051 netif_info(dev, link, dev->net,
1052 "%u mbit/s downlink %u mbit/s uplink\n",
1053 (unsigned int)(rx_speed / 1000000U),
1054 (unsigned int)(tx_speed / 1000000U));
1056 netif_info(dev, link, dev->net,
1057 "%u kbit/s downlink %u kbit/s uplink\n",
1058 (unsigned int)(rx_speed / 1000U),
1059 (unsigned int)(tx_speed / 1000U));
1063 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1065 struct cdc_ncm_ctx *ctx;
1066 struct usb_cdc_notification *event;
1068 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1070 if (urb->actual_length < sizeof(*event))
1073 /* test for split data in 8-byte chunks */
1074 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1075 cdc_ncm_speed_change(dev,
1076 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1080 event = urb->transfer_buffer;
1082 switch (event->bNotificationType) {
1083 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1085 * According to the CDC NCM specification ch.7.1
1086 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1087 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1089 ctx->connected = le16_to_cpu(event->wValue);
1090 netif_info(dev, link, dev->net,
1091 "network connection: %sconnected\n",
1092 ctx->connected ? "" : "dis");
1093 usbnet_link_change(dev, ctx->connected, 0);
1096 case USB_CDC_NOTIFY_SPEED_CHANGE:
1097 if (urb->actual_length < (sizeof(*event) +
1098 sizeof(struct usb_cdc_speed_change)))
1099 set_bit(EVENT_STS_SPLIT, &dev->flags);
1101 cdc_ncm_speed_change(dev,
1102 (struct usb_cdc_speed_change *)&event[1]);
1106 dev_dbg(&dev->udev->dev,
1107 "NCM: unexpected notification 0x%02x!\n",
1108 event->bNotificationType);
1113 static int cdc_ncm_check_connect(struct usbnet *dev)
1115 struct cdc_ncm_ctx *ctx;
1117 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1119 return 1; /* disconnected */
1121 return !ctx->connected;
1124 static const struct driver_info cdc_ncm_info = {
1125 .description = "CDC NCM",
1126 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1127 .bind = cdc_ncm_bind,
1128 .unbind = cdc_ncm_unbind,
1129 .check_connect = cdc_ncm_check_connect,
1130 .manage_power = usbnet_manage_power,
1131 .status = cdc_ncm_status,
1132 .rx_fixup = cdc_ncm_rx_fixup,
1133 .tx_fixup = cdc_ncm_tx_fixup,
1136 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1137 static const struct driver_info wwan_info = {
1138 .description = "Mobile Broadband Network Device",
1139 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1141 .bind = cdc_ncm_bind,
1142 .unbind = cdc_ncm_unbind,
1143 .check_connect = cdc_ncm_check_connect,
1144 .manage_power = usbnet_manage_power,
1145 .status = cdc_ncm_status,
1146 .rx_fixup = cdc_ncm_rx_fixup,
1147 .tx_fixup = cdc_ncm_tx_fixup,
1150 /* Same as wwan_info, but with FLAG_NOARP */
1151 static const struct driver_info wwan_noarp_info = {
1152 .description = "Mobile Broadband Network Device (NO ARP)",
1153 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1154 | FLAG_WWAN | FLAG_NOARP,
1155 .bind = cdc_ncm_bind,
1156 .unbind = cdc_ncm_unbind,
1157 .check_connect = cdc_ncm_check_connect,
1158 .manage_power = usbnet_manage_power,
1159 .status = cdc_ncm_status,
1160 .rx_fixup = cdc_ncm_rx_fixup,
1161 .tx_fixup = cdc_ncm_tx_fixup,
1164 static const struct usb_device_id cdc_devs[] = {
1165 /* Ericsson MBM devices like F5521gw */
1166 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1167 | USB_DEVICE_ID_MATCH_VENDOR,
1169 .bInterfaceClass = USB_CLASS_COMM,
1170 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1171 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1172 .driver_info = (unsigned long) &wwan_info,
1175 /* Dell branded MBM devices like DW5550 */
1176 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1177 | USB_DEVICE_ID_MATCH_VENDOR,
1179 .bInterfaceClass = USB_CLASS_COMM,
1180 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1181 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1182 .driver_info = (unsigned long) &wwan_info,
1185 /* Toshiba branded MBM devices */
1186 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1187 | USB_DEVICE_ID_MATCH_VENDOR,
1189 .bInterfaceClass = USB_CLASS_COMM,
1190 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1191 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1192 .driver_info = (unsigned long) &wwan_info,
1195 /* tag Huawei devices as wwan */
1196 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1198 USB_CDC_SUBCLASS_NCM,
1199 USB_CDC_PROTO_NONE),
1200 .driver_info = (unsigned long)&wwan_info,
1203 /* Infineon(now Intel) HSPA Modem platform */
1204 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1206 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1207 .driver_info = (unsigned long)&wwan_noarp_info,
1210 /* Generic CDC-NCM devices */
1211 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1212 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1213 .driver_info = (unsigned long)&cdc_ncm_info,
1218 MODULE_DEVICE_TABLE(usb, cdc_devs);
1220 static struct usb_driver cdc_ncm_driver = {
1222 .id_table = cdc_devs,
1223 .probe = usbnet_probe,
1224 .disconnect = usbnet_disconnect,
1225 .suspend = usbnet_suspend,
1226 .resume = usbnet_resume,
1227 .reset_resume = usbnet_resume,
1228 .supports_autosuspend = 1,
1229 .disable_hub_initiated_lpm = 1,
1232 module_usb_driver(cdc_ncm_driver);
1234 MODULE_AUTHOR("Hans Petter Selasky");
1235 MODULE_DESCRIPTION("USB CDC NCM host driver");
1236 MODULE_LICENSE("Dual BSD/GPL");