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/init.h>
43 #include <linux/netdevice.h>
44 #include <linux/ctype.h>
45 #include <linux/ethtool.h>
46 #include <linux/workqueue.h>
47 #include <linux/mii.h>
48 #include <linux/crc32.h>
49 #include <linux/usb.h>
50 #include <linux/hrtimer.h>
51 #include <linux/atomic.h>
52 #include <linux/usb/usbnet.h>
53 #include <linux/usb/cdc.h>
54 #include <linux/usb/cdc_ncm.h>
56 #define DRIVER_VERSION "14-Mar-2012"
58 static void cdc_ncm_txpath_bh(unsigned long param);
59 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx);
60 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *hr_timer);
61 static struct usb_driver cdc_ncm_driver;
64 cdc_ncm_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
66 struct usbnet *dev = netdev_priv(net);
68 strncpy(info->driver, dev->driver_name, sizeof(info->driver));
69 strncpy(info->version, DRIVER_VERSION, sizeof(info->version));
70 strncpy(info->fw_version, dev->driver_info->description,
71 sizeof(info->fw_version));
72 usb_make_path(dev->udev, info->bus_info, sizeof(info->bus_info));
75 static u8 cdc_ncm_setup(struct cdc_ncm_ctx *ctx)
82 u16 ntb_fmt_supported;
85 struct usbnet *dev = netdev_priv(ctx->netdev);
87 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
89 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
90 USB_TYPE_CLASS | USB_DIR_IN
92 0, iface_no, &ctx->ncm_parm,
93 sizeof(ctx->ncm_parm));
95 pr_debug("failed GET_NTB_PARAMETERS\n");
99 /* read correct set of parameters according to device mode */
100 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
101 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
102 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
103 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
104 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
105 /* devices prior to NCM Errata shall set this field to zero */
106 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
107 ntb_fmt_supported = le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported);
110 min_dgram_size = CDC_NCM_MIN_DATAGRAM_SIZE;
111 min_hdr_size = CDC_NCM_MIN_HDR_SIZE;
112 if (ctx->mbim_desc != NULL) {
113 flags = ctx->mbim_desc->bmNetworkCapabilities;
115 min_dgram_size = CDC_MBIM_MIN_DATAGRAM_SIZE;
117 } else if (ctx->func_desc != NULL) {
118 flags = ctx->func_desc->bmNetworkCapabilities;
123 pr_debug("dwNtbInMaxSize=%u dwNtbOutMaxSize=%u "
124 "wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u "
125 "wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
126 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
127 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, flags);
129 /* max count of tx datagrams */
130 if ((ctx->tx_max_datagrams == 0) ||
131 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
132 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
134 /* verify maximum size of received NTB in bytes */
135 if (ctx->rx_max < USB_CDC_NCM_NTB_MIN_IN_SIZE) {
136 pr_debug("Using min receive length=%d\n",
137 USB_CDC_NCM_NTB_MIN_IN_SIZE);
138 ctx->rx_max = USB_CDC_NCM_NTB_MIN_IN_SIZE;
141 if (ctx->rx_max > CDC_NCM_NTB_MAX_SIZE_RX) {
142 pr_debug("Using default maximum receive length=%d\n",
143 CDC_NCM_NTB_MAX_SIZE_RX);
144 ctx->rx_max = CDC_NCM_NTB_MAX_SIZE_RX;
147 /* inform device about NTB input size changes */
148 if (ctx->rx_max != le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize)) {
149 __le32 dwNtbInMaxSize = cpu_to_le32(ctx->rx_max);
151 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
152 USB_TYPE_CLASS | USB_DIR_OUT
153 | USB_RECIP_INTERFACE,
154 0, iface_no, &dwNtbInMaxSize, 4);
156 pr_debug("Setting NTB Input Size failed\n");
159 /* verify maximum size of transmitted NTB in bytes */
161 (min_hdr_size + min_dgram_size)) ||
162 (ctx->tx_max > CDC_NCM_NTB_MAX_SIZE_TX)) {
163 pr_debug("Using default maximum transmit length=%d\n",
164 CDC_NCM_NTB_MAX_SIZE_TX);
165 ctx->tx_max = CDC_NCM_NTB_MAX_SIZE_TX;
169 * verify that the structure alignment is:
171 * - not greater than the maximum transmit length
172 * - not less than four bytes
174 val = ctx->tx_ndp_modulus;
176 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
177 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
178 pr_debug("Using default alignment: 4 bytes\n");
179 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
183 * verify that the payload alignment is:
185 * - not greater than the maximum transmit length
186 * - not less than four bytes
188 val = ctx->tx_modulus;
190 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
191 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
192 pr_debug("Using default transmit modulus: 4 bytes\n");
193 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
196 /* verify the payload remainder */
197 if (ctx->tx_remainder >= ctx->tx_modulus) {
198 pr_debug("Using default transmit remainder: 0 bytes\n");
199 ctx->tx_remainder = 0;
202 /* adjust TX-remainder according to NCM specification. */
203 ctx->tx_remainder = ((ctx->tx_remainder - eth_hlen) &
204 (ctx->tx_modulus - 1));
206 /* additional configuration */
209 if (flags & USB_CDC_NCM_NCAP_CRC_MODE) {
210 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
211 USB_TYPE_CLASS | USB_DIR_OUT
212 | USB_RECIP_INTERFACE,
213 USB_CDC_NCM_CRC_NOT_APPENDED,
216 pr_debug("Setting CRC mode off failed\n");
219 /* set NTB format, if both formats are supported */
220 if (ntb_fmt_supported & USB_CDC_NCM_NTH32_SIGN) {
221 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
222 USB_TYPE_CLASS | USB_DIR_OUT
223 | USB_RECIP_INTERFACE,
224 USB_CDC_NCM_NTB16_FORMAT,
227 pr_debug("Setting NTB format to 16-bit failed\n");
230 ctx->max_datagram_size = min_dgram_size;
232 /* set Max Datagram Size (MTU) */
233 if (flags & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE) {
234 __le16 max_datagram_size;
236 if (ctx->ether_desc != NULL)
237 eth_max_sz = le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
238 else if (ctx->mbim_desc != NULL)
239 eth_max_sz = le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
243 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
244 USB_TYPE_CLASS | USB_DIR_IN
245 | USB_RECIP_INTERFACE,
246 0, iface_no, &max_datagram_size, 2);
248 pr_debug("GET_MAX_DATAGRAM_SIZE failed, use size=%u\n",
251 ctx->max_datagram_size =
252 le16_to_cpu(max_datagram_size);
253 /* Check Eth descriptor value */
254 if (ctx->max_datagram_size > eth_max_sz)
255 ctx->max_datagram_size = eth_max_sz;
257 if (ctx->max_datagram_size > CDC_NCM_MAX_DATAGRAM_SIZE)
258 ctx->max_datagram_size = CDC_NCM_MAX_DATAGRAM_SIZE;
260 if (ctx->max_datagram_size < min_dgram_size)
261 ctx->max_datagram_size = min_dgram_size;
263 /* if value changed, update device */
264 if (ctx->max_datagram_size !=
265 le16_to_cpu(max_datagram_size)) {
266 err = usbnet_write_cmd(dev,
267 USB_CDC_SET_MAX_DATAGRAM_SIZE,
268 USB_TYPE_CLASS | USB_DIR_OUT
269 | USB_RECIP_INTERFACE,
271 iface_no, &max_datagram_size,
274 pr_debug("SET_MAX_DGRAM_SIZE failed\n");
280 if (ctx->netdev->mtu != (ctx->max_datagram_size - eth_hlen))
281 ctx->netdev->mtu = ctx->max_datagram_size - eth_hlen;
287 cdc_ncm_find_endpoints(struct cdc_ncm_ctx *ctx, struct usb_interface *intf)
289 struct usb_host_endpoint *e;
292 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
294 e = intf->cur_altsetting->endpoint + ep;
295 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
296 case USB_ENDPOINT_XFER_INT:
297 if (usb_endpoint_dir_in(&e->desc)) {
298 if (ctx->status_ep == NULL)
303 case USB_ENDPOINT_XFER_BULK:
304 if (usb_endpoint_dir_in(&e->desc)) {
305 if (ctx->in_ep == NULL)
308 if (ctx->out_ep == NULL)
319 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
324 if (ctx->tx_rem_skb != NULL) {
325 dev_kfree_skb_any(ctx->tx_rem_skb);
326 ctx->tx_rem_skb = NULL;
329 if (ctx->tx_curr_skb != NULL) {
330 dev_kfree_skb_any(ctx->tx_curr_skb);
331 ctx->tx_curr_skb = NULL;
337 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
338 .get_drvinfo = cdc_ncm_get_drvinfo,
339 .get_link = usbnet_get_link,
340 .get_msglevel = usbnet_get_msglevel,
341 .set_msglevel = usbnet_set_msglevel,
342 .get_settings = usbnet_get_settings,
343 .set_settings = usbnet_set_settings,
344 .nway_reset = usbnet_nway_reset,
347 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting)
349 struct cdc_ncm_ctx *ctx;
350 struct usb_driver *driver;
356 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
360 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
361 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
362 ctx->bh.data = (unsigned long)ctx;
363 ctx->bh.func = cdc_ncm_txpath_bh;
364 atomic_set(&ctx->stop, 0);
365 spin_lock_init(&ctx->mtx);
366 ctx->netdev = dev->net;
368 /* store ctx pointer in device data field */
369 dev->data[0] = (unsigned long)ctx;
371 /* get some pointers */
372 driver = driver_of(intf);
373 buf = intf->cur_altsetting->extra;
374 len = intf->cur_altsetting->extralen;
376 ctx->udev = dev->udev;
379 /* parse through descriptors associated with control interface */
380 while ((len > 0) && (buf[0] > 2) && (buf[0] <= len)) {
382 if (buf[1] != USB_DT_CS_INTERFACE)
386 case USB_CDC_UNION_TYPE:
387 if (buf[0] < sizeof(*(ctx->union_desc)))
391 (const struct usb_cdc_union_desc *)buf;
393 ctx->control = usb_ifnum_to_if(dev->udev,
394 ctx->union_desc->bMasterInterface0);
395 ctx->data = usb_ifnum_to_if(dev->udev,
396 ctx->union_desc->bSlaveInterface0);
399 case USB_CDC_ETHERNET_TYPE:
400 if (buf[0] < sizeof(*(ctx->ether_desc)))
404 (const struct usb_cdc_ether_desc *)buf;
406 le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
408 if (dev->hard_mtu < CDC_NCM_MIN_DATAGRAM_SIZE)
409 dev->hard_mtu = CDC_NCM_MIN_DATAGRAM_SIZE;
410 else if (dev->hard_mtu > CDC_NCM_MAX_DATAGRAM_SIZE)
411 dev->hard_mtu = CDC_NCM_MAX_DATAGRAM_SIZE;
414 case USB_CDC_NCM_TYPE:
415 if (buf[0] < sizeof(*(ctx->func_desc)))
418 ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
421 case USB_CDC_MBIM_TYPE:
422 if (buf[0] < sizeof(*(ctx->mbim_desc)))
425 ctx->mbim_desc = (const struct usb_cdc_mbim_desc *)buf;
432 /* advance to next descriptor */
438 /* check if we got everything */
439 if ((ctx->control == NULL) || (ctx->data == NULL) ||
440 ((!ctx->mbim_desc) && ((ctx->ether_desc == NULL) || (ctx->control != intf))))
443 /* claim interfaces, if any */
444 temp = usb_driver_claim_interface(driver, ctx->data, dev);
448 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
450 /* reset data interface */
451 temp = usb_set_interface(dev->udev, iface_no, 0);
455 /* initialize data interface */
456 if (cdc_ncm_setup(ctx))
459 /* configure data interface */
460 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
464 cdc_ncm_find_endpoints(ctx, ctx->data);
465 cdc_ncm_find_endpoints(ctx, ctx->control);
467 if ((ctx->in_ep == NULL) || (ctx->out_ep == NULL) ||
468 (ctx->status_ep == NULL))
471 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
473 usb_set_intfdata(ctx->data, dev);
474 usb_set_intfdata(ctx->control, dev);
475 usb_set_intfdata(ctx->intf, dev);
477 if (ctx->ether_desc) {
478 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
481 dev_info(&dev->udev->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
485 dev->in = usb_rcvbulkpipe(dev->udev,
486 ctx->in_ep->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
487 dev->out = usb_sndbulkpipe(dev->udev,
488 ctx->out_ep->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
489 dev->status = ctx->status_ep;
490 dev->rx_urb_size = ctx->rx_max;
492 ctx->tx_speed = ctx->rx_speed = 0;
496 usb_set_intfdata(ctx->control, NULL);
497 usb_set_intfdata(ctx->data, NULL);
498 usb_driver_release_interface(driver, ctx->data);
500 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
502 dev_info(&dev->udev->dev, "bind() failure\n");
505 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
507 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
509 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
510 struct usb_driver *driver = driver_of(intf);
513 return; /* no setup */
515 atomic_set(&ctx->stop, 1);
517 if (hrtimer_active(&ctx->tx_timer))
518 hrtimer_cancel(&ctx->tx_timer);
520 tasklet_kill(&ctx->bh);
522 /* disconnect master --> disconnect slave */
523 if (intf == ctx->control && ctx->data) {
524 usb_set_intfdata(ctx->data, NULL);
525 usb_driver_release_interface(driver, ctx->data);
528 } else if (intf == ctx->data && ctx->control) {
529 usb_set_intfdata(ctx->control, NULL);
530 usb_driver_release_interface(driver, ctx->control);
534 usb_set_intfdata(ctx->intf, NULL);
537 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
539 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
543 /* The MBIM spec defines a NCM compatible default altsetting,
544 * which we may have matched:
546 * "Functions that implement both NCM 1.0 and MBIM (an
547 * “NCM/MBIM function”) according to this recommendation
548 * shall provide two alternate settings for the
549 * Communication Interface. Alternate setting 0, and the
550 * associated class and endpoint descriptors, shall be
551 * constructed according to the rules given for the
552 * Communication Interface in section 5 of [USBNCM10].
553 * Alternate setting 1, and the associated class and
554 * endpoint descriptors, shall be constructed according to
555 * the rules given in section 6 (USB Device Model) of this
558 * Do not bind to such interfaces, allowing cdc_mbim to handle
561 #if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
562 if ((intf->num_altsetting == 2) &&
563 !usb_set_interface(dev->udev,
564 intf->cur_altsetting->desc.bInterfaceNumber,
565 CDC_NCM_COMM_ALTSETTING_MBIM) &&
566 cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting))
570 /* NCM data altsetting is always 1 */
571 ret = cdc_ncm_bind_common(dev, intf, 1);
574 * We should get an event when network connection is "connected" or
575 * "disconnected". Set network connection in "disconnected" state
576 * (carrier is OFF) during attach, so the IP network stack does not
577 * start IPv6 negotiation and more.
579 netif_carrier_off(dev->net);
583 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
585 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
587 if (skb->len + align > max)
588 align = max - skb->len;
589 if (align && skb_tailroom(skb) >= align)
590 memset(skb_put(skb, align), 0, align);
593 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
594 * allocating a new one within skb
596 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
598 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
599 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
600 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
602 /* follow the chain of NDPs, looking for a match */
604 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
605 if (ndp16->dwSignature == sign)
607 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
611 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
613 /* verify that there is room for the NDP and the datagram (reserve) */
614 if ((ctx->tx_max - skb->len - reserve) < CDC_NCM_NDP_SIZE)
619 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
621 nth16->wNdpIndex = cpu_to_le16(skb->len);
623 /* push a new empty NDP */
624 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, CDC_NCM_NDP_SIZE), 0, CDC_NCM_NDP_SIZE);
625 ndp16->dwSignature = sign;
626 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
631 cdc_ncm_fill_tx_frame(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign)
633 struct usb_cdc_ncm_nth16 *nth16;
634 struct usb_cdc_ncm_ndp16 *ndp16;
635 struct sk_buff *skb_out;
636 u16 n = 0, index, ndplen;
639 /* if there is a remaining skb, it gets priority */
641 swap(skb, ctx->tx_rem_skb);
642 swap(sign, ctx->tx_rem_sign);
647 /* check if we are resuming an OUT skb */
648 skb_out = ctx->tx_curr_skb;
650 /* allocate a new OUT skb */
652 skb_out = alloc_skb((ctx->tx_max + 1), GFP_ATOMIC);
653 if (skb_out == NULL) {
655 dev_kfree_skb_any(skb);
656 ctx->netdev->stats.tx_dropped++;
660 /* fill out the initial 16-bit NTB header */
661 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
662 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
663 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
664 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
666 /* count total number of frames in this NTB */
667 ctx->tx_curr_frame_num = 0;
670 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
671 /* send any remaining skb first */
673 skb = ctx->tx_rem_skb;
674 sign = ctx->tx_rem_sign;
675 ctx->tx_rem_skb = NULL;
677 /* check for end of skb */
682 /* get the appropriate NDP for this skb */
683 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
685 /* align beginning of next frame */
686 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
688 /* check if we had enough room left for both NDP and frame */
689 if (!ndp16 || skb_out->len + skb->len > ctx->tx_max) {
691 /* won't fit, MTU problem? */
692 dev_kfree_skb_any(skb);
694 ctx->netdev->stats.tx_dropped++;
696 /* no room for skb - store for later */
697 if (ctx->tx_rem_skb != NULL) {
698 dev_kfree_skb_any(ctx->tx_rem_skb);
699 ctx->netdev->stats.tx_dropped++;
701 ctx->tx_rem_skb = skb;
702 ctx->tx_rem_sign = sign;
709 /* calculate frame number withing this NDP */
710 ndplen = le16_to_cpu(ndp16->wLength);
711 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
713 /* OK, add this skb */
714 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
715 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
716 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
717 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
718 dev_kfree_skb_any(skb);
721 /* send now if this NDP is full */
722 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
728 /* free up any dangling skb */
730 dev_kfree_skb_any(skb);
732 ctx->netdev->stats.tx_dropped++;
735 ctx->tx_curr_frame_num = n;
738 /* wait for more frames */
740 ctx->tx_curr_skb = skb_out;
743 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0)) {
744 /* wait for more frames */
746 ctx->tx_curr_skb = skb_out;
747 /* set the pending count */
748 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
749 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
754 /* variables will be reset at next call */
758 * If collected data size is less or equal CDC_NCM_MIN_TX_PKT bytes,
759 * we send buffers as it is. If we get more data, it would be more
760 * efficient for USB HS mobile device with DMA engine to receive a full
761 * size NTB, than canceling DMA transfer and receiving a short packet.
763 if (skb_out->len > CDC_NCM_MIN_TX_PKT)
764 /* final zero padding */
765 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0, ctx->tx_max - skb_out->len);
767 /* do we need to prevent a ZLP? */
768 if (((skb_out->len % le16_to_cpu(ctx->out_ep->desc.wMaxPacketSize)) == 0) &&
769 (skb_out->len < le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize)) && skb_tailroom(skb_out))
770 *skb_put(skb_out, 1) = 0; /* force short packet */
772 /* set final frame length */
773 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
774 nth16->wBlockLength = cpu_to_le16(skb_out->len);
777 ctx->tx_curr_skb = NULL;
778 ctx->netdev->stats.tx_packets += ctx->tx_curr_frame_num;
782 /* Start timer, if there is a remaining skb */
783 if (ctx->tx_curr_skb != NULL)
784 cdc_ncm_tx_timeout_start(ctx);
787 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
789 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
791 /* start timer, if not already started */
792 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
793 hrtimer_start(&ctx->tx_timer,
794 ktime_set(0, CDC_NCM_TIMER_INTERVAL),
798 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
800 struct cdc_ncm_ctx *ctx =
801 container_of(timer, struct cdc_ncm_ctx, tx_timer);
803 if (!atomic_read(&ctx->stop))
804 tasklet_schedule(&ctx->bh);
805 return HRTIMER_NORESTART;
808 static void cdc_ncm_txpath_bh(unsigned long param)
810 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)param;
812 spin_lock_bh(&ctx->mtx);
813 if (ctx->tx_timer_pending != 0) {
814 ctx->tx_timer_pending--;
815 cdc_ncm_tx_timeout_start(ctx);
816 spin_unlock_bh(&ctx->mtx);
817 } else if (ctx->netdev != NULL) {
818 spin_unlock_bh(&ctx->mtx);
819 netif_tx_lock_bh(ctx->netdev);
820 usbnet_start_xmit(NULL, ctx->netdev);
821 netif_tx_unlock_bh(ctx->netdev);
823 spin_unlock_bh(&ctx->mtx);
827 static struct sk_buff *
828 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
830 struct sk_buff *skb_out;
831 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
834 * The Ethernet API we are using does not support transmitting
835 * multiple Ethernet frames in a single call. This driver will
836 * accumulate multiple Ethernet frames and send out a larger
837 * USB frame when the USB buffer is full or when a single jiffies
843 spin_lock_bh(&ctx->mtx);
844 skb_out = cdc_ncm_fill_tx_frame(ctx, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
845 spin_unlock_bh(&ctx->mtx);
850 dev_kfree_skb_any(skb);
855 /* verify NTB header and return offset of first NDP, or negative error */
856 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
858 struct usb_cdc_ncm_nth16 *nth16;
865 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
866 sizeof(struct usb_cdc_ncm_ndp16))) {
867 pr_debug("frame too short\n");
871 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
873 if (le32_to_cpu(nth16->dwSignature) != USB_CDC_NCM_NTH16_SIGN) {
874 pr_debug("invalid NTH16 signature <%u>\n",
875 le32_to_cpu(nth16->dwSignature));
879 len = le16_to_cpu(nth16->wBlockLength);
880 if (len > ctx->rx_max) {
881 pr_debug("unsupported NTB block length %u/%u\n", len,
886 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
887 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
888 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
889 pr_debug("sequence number glitch prev=%d curr=%d\n",
890 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
892 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
894 ret = le16_to_cpu(nth16->wNdpIndex);
898 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
900 /* verify NDP header and return number of datagrams, or negative error */
901 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
903 struct usb_cdc_ncm_ndp16 *ndp16;
906 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
907 pr_debug("invalid NDP offset <%u>\n", ndpoffset);
910 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
912 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
913 pr_debug("invalid DPT16 length <%u>\n",
914 le32_to_cpu(ndp16->dwSignature));
918 ret = ((le16_to_cpu(ndp16->wLength) -
919 sizeof(struct usb_cdc_ncm_ndp16)) /
920 sizeof(struct usb_cdc_ncm_dpe16));
921 ret--; /* we process NDP entries except for the last one */
923 if ((sizeof(struct usb_cdc_ncm_ndp16) + ret * (sizeof(struct usb_cdc_ncm_dpe16))) >
925 pr_debug("Invalid nframes = %d\n", ret);
932 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
934 static int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
937 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
942 struct usb_cdc_ncm_ndp16 *ndp16;
943 struct usb_cdc_ncm_dpe16 *dpe16;
945 int loopcount = 50; /* arbitrary max preventing infinite loop */
947 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
952 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
956 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
958 if (le32_to_cpu(ndp16->dwSignature) != USB_CDC_NCM_NDP16_NOCRC_SIGN) {
959 pr_debug("invalid DPT16 signature <%u>\n",
960 le32_to_cpu(ndp16->dwSignature));
963 dpe16 = ndp16->dpe16;
965 for (x = 0; x < nframes; x++, dpe16++) {
966 offset = le16_to_cpu(dpe16->wDatagramIndex);
967 len = le16_to_cpu(dpe16->wDatagramLength);
971 * All entries after first NULL entry are to be ignored
973 if ((offset == 0) || (len == 0)) {
975 goto err_ndp; /* empty NTB */
979 /* sanity checking */
980 if (((offset + len) > skb_in->len) ||
981 (len > ctx->rx_max) || (len < ETH_HLEN)) {
982 pr_debug("invalid frame detected (ignored)"
983 "offset[%u]=%u, length=%u, skb=%p\n",
984 x, offset, len, skb_in);
990 skb = skb_clone(skb_in, GFP_ATOMIC);
994 skb->data = ((u8 *)skb_in->data) + offset;
995 skb_set_tail_pointer(skb, len);
996 usbnet_skb_return(dev, skb);
1000 /* are there more NDPs to process? */
1001 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1002 if (ndpoffset && loopcount--)
1011 cdc_ncm_speed_change(struct cdc_ncm_ctx *ctx,
1012 struct usb_cdc_speed_change *data)
1014 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1015 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1018 * Currently the USB-NET API does not support reporting the actual
1019 * device speed. Do print it instead.
1021 if ((tx_speed != ctx->tx_speed) || (rx_speed != ctx->rx_speed)) {
1022 ctx->tx_speed = tx_speed;
1023 ctx->rx_speed = rx_speed;
1025 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1026 printk(KERN_INFO KBUILD_MODNAME
1027 ": %s: %u mbit/s downlink "
1028 "%u mbit/s uplink\n",
1030 (unsigned int)(rx_speed / 1000000U),
1031 (unsigned int)(tx_speed / 1000000U));
1033 printk(KERN_INFO KBUILD_MODNAME
1034 ": %s: %u kbit/s downlink "
1035 "%u kbit/s uplink\n",
1037 (unsigned int)(rx_speed / 1000U),
1038 (unsigned int)(tx_speed / 1000U));
1043 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1045 struct cdc_ncm_ctx *ctx;
1046 struct usb_cdc_notification *event;
1048 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1050 if (urb->actual_length < sizeof(*event))
1053 /* test for split data in 8-byte chunks */
1054 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1055 cdc_ncm_speed_change(ctx,
1056 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1060 event = urb->transfer_buffer;
1062 switch (event->bNotificationType) {
1063 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1065 * According to the CDC NCM specification ch.7.1
1066 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1067 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1069 ctx->connected = le16_to_cpu(event->wValue);
1071 printk(KERN_INFO KBUILD_MODNAME ": %s: network connection:"
1073 ctx->netdev->name, ctx->connected ? "" : "dis");
1076 netif_carrier_on(dev->net);
1078 netif_carrier_off(dev->net);
1079 ctx->tx_speed = ctx->rx_speed = 0;
1083 case USB_CDC_NOTIFY_SPEED_CHANGE:
1084 if (urb->actual_length < (sizeof(*event) +
1085 sizeof(struct usb_cdc_speed_change)))
1086 set_bit(EVENT_STS_SPLIT, &dev->flags);
1088 cdc_ncm_speed_change(ctx,
1089 (struct usb_cdc_speed_change *) &event[1]);
1093 dev_err(&dev->udev->dev, "NCM: unexpected "
1094 "notification 0x%02x!\n", event->bNotificationType);
1099 static int cdc_ncm_check_connect(struct usbnet *dev)
1101 struct cdc_ncm_ctx *ctx;
1103 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1105 return 1; /* disconnected */
1107 return !ctx->connected;
1111 cdc_ncm_probe(struct usb_interface *udev, const struct usb_device_id *prod)
1113 return usbnet_probe(udev, prod);
1116 static void cdc_ncm_disconnect(struct usb_interface *intf)
1118 struct usbnet *dev = usb_get_intfdata(intf);
1121 return; /* already disconnected */
1123 usbnet_disconnect(intf);
1126 static int cdc_ncm_manage_power(struct usbnet *dev, int status)
1128 dev->intf->needs_remote_wakeup = status;
1132 static const struct driver_info cdc_ncm_info = {
1133 .description = "CDC NCM",
1134 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1135 .bind = cdc_ncm_bind,
1136 .unbind = cdc_ncm_unbind,
1137 .check_connect = cdc_ncm_check_connect,
1138 .manage_power = cdc_ncm_manage_power,
1139 .status = cdc_ncm_status,
1140 .rx_fixup = cdc_ncm_rx_fixup,
1141 .tx_fixup = cdc_ncm_tx_fixup,
1144 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1145 static const struct driver_info wwan_info = {
1146 .description = "Mobile Broadband Network Device",
1147 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1149 .bind = cdc_ncm_bind,
1150 .unbind = cdc_ncm_unbind,
1151 .check_connect = cdc_ncm_check_connect,
1152 .manage_power = cdc_ncm_manage_power,
1153 .status = cdc_ncm_status,
1154 .rx_fixup = cdc_ncm_rx_fixup,
1155 .tx_fixup = cdc_ncm_tx_fixup,
1158 static const struct usb_device_id cdc_devs[] = {
1159 /* Ericsson MBM devices like F5521gw */
1160 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1161 | USB_DEVICE_ID_MATCH_VENDOR,
1163 .bInterfaceClass = USB_CLASS_COMM,
1164 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1165 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1166 .driver_info = (unsigned long) &wwan_info,
1169 /* Dell branded MBM devices like DW5550 */
1170 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1171 | USB_DEVICE_ID_MATCH_VENDOR,
1173 .bInterfaceClass = USB_CLASS_COMM,
1174 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1175 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1176 .driver_info = (unsigned long) &wwan_info,
1179 /* Toshiba branded MBM devices */
1180 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1181 | USB_DEVICE_ID_MATCH_VENDOR,
1183 .bInterfaceClass = USB_CLASS_COMM,
1184 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1185 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1186 .driver_info = (unsigned long) &wwan_info,
1189 /* Generic CDC-NCM devices */
1190 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1191 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1192 .driver_info = (unsigned long)&cdc_ncm_info,
1197 MODULE_DEVICE_TABLE(usb, cdc_devs);
1199 static struct usb_driver cdc_ncm_driver = {
1201 .id_table = cdc_devs,
1202 .probe = cdc_ncm_probe,
1203 .disconnect = cdc_ncm_disconnect,
1204 .suspend = usbnet_suspend,
1205 .resume = usbnet_resume,
1206 .reset_resume = usbnet_resume,
1207 .supports_autosuspend = 1,
1208 .disable_hub_initiated_lpm = 1,
1211 module_usb_driver(cdc_ncm_driver);
1213 MODULE_AUTHOR("Hans Petter Selasky");
1214 MODULE_DESCRIPTION("USB CDC NCM host driver");
1215 MODULE_LICENSE("Dual BSD/GPL");