drivers/net/usb/cdc_ncm.c

   1 /*
   2  * cdc_ncm.c
   3  *
   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>
   7  *
   8  * USB Host Driver for Network Control Model (NCM)
   9  * http://www.usb.org/developers/devclass_docs/NCM10.zip
  10  *
  11  * The NCM encoding, decoding and initialization logic
  12  * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
  13  *
  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:
  18  *
  19  * Redistribution and use in source and binary forms, with or without
  20  * modification, are permitted provided that the following conditions
  21  * are met:
  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.
  27  *
  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
  38  * SUCH DAMAGE.
  39  */
  40
  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>
  55
  56 #define DRIVER_VERSION                          "14-Mar-2012"
  57
  58 #if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
  59 static bool prefer_mbim = true;
  60 #else
  61 static bool prefer_mbim;
  62 #endif
  63 module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
  64 MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
  65
  66 static void cdc_ncm_txpath_bh(unsigned long param);
  67 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx);
  68 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *hr_timer);
  69 static struct usb_driver cdc_ncm_driver;
  70
  71 static void
  72 cdc_ncm_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
  73 {
  74         struct usbnet *dev = netdev_priv(net);
  75
  76         strlcpy(info->driver, dev->driver_name, sizeof(info->driver));
  77         strlcpy(info->version, DRIVER_VERSION, sizeof(info->version));
  78         strlcpy(info->fw_version, dev->driver_info->description,
  79                 sizeof(info->fw_version));
  80         usb_make_path(dev->udev, info->bus_info, sizeof(info->bus_info));
  81 }
  82
  83 static u8 cdc_ncm_setup(struct cdc_ncm_ctx *ctx)
  84 {
  85         u32 val;
  86         u8 flags;
  87         u8 iface_no;
  88         int err;
  89         int eth_hlen;
  90         u16 ntb_fmt_supported;
  91         u32 min_dgram_size;
  92         u32 min_hdr_size;
  93         struct usbnet *dev = netdev_priv(ctx->netdev);
  94
  95         iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
  96
  97         err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
  98                               USB_TYPE_CLASS | USB_DIR_IN
  99                               |USB_RECIP_INTERFACE,
 100                               0, iface_no, &ctx->ncm_parm,
 101                               sizeof(ctx->ncm_parm));
 102         if (err < 0) {
 103                 pr_debug("failed GET_NTB_PARAMETERS\n");
 104                 return 1;
 105         }
 106
 107         /* read correct set of parameters according to device mode */
 108         ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
 109         ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
 110         ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
 111         ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
 112         ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
 113         /* devices prior to NCM Errata shall set this field to zero */
 114         ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
 115         ntb_fmt_supported = le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported);
 116
 117         eth_hlen = ETH_HLEN;
 118         min_dgram_size = CDC_NCM_MIN_DATAGRAM_SIZE;
 119         min_hdr_size = CDC_NCM_MIN_HDR_SIZE;
 120         if (ctx->mbim_desc != NULL) {
 121                 flags = ctx->mbim_desc->bmNetworkCapabilities;
 122                 eth_hlen = 0;
 123                 min_dgram_size = CDC_MBIM_MIN_DATAGRAM_SIZE;
 124                 min_hdr_size = 0;
 125         } else if (ctx->func_desc != NULL) {
 126                 flags = ctx->func_desc->bmNetworkCapabilities;
 127         } else {
 128                 flags = 0;
 129         }
 130
 131         pr_debug("dwNtbInMaxSize=%u dwNtbOutMaxSize=%u "
 132                  "wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u "
 133                  "wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
 134                  ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
 135                  ctx->tx_ndp_modulus, ctx->tx_max_datagrams, flags);
 136
 137         /* max count of tx datagrams */
 138         if ((ctx->tx_max_datagrams == 0) ||
 139                         (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
 140                 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
 141
 142         /* verify maximum size of received NTB in bytes */
 143         if (ctx->rx_max < USB_CDC_NCM_NTB_MIN_IN_SIZE) {
 144                 pr_debug("Using min receive length=%d\n",
 145                                                 USB_CDC_NCM_NTB_MIN_IN_SIZE);
 146                 ctx->rx_max = USB_CDC_NCM_NTB_MIN_IN_SIZE;
 147         }
 148
 149         if (ctx->rx_max > CDC_NCM_NTB_MAX_SIZE_RX) {
 150                 pr_debug("Using default maximum receive length=%d\n",
 151                                                 CDC_NCM_NTB_MAX_SIZE_RX);
 152                 ctx->rx_max = CDC_NCM_NTB_MAX_SIZE_RX;
 153         }
 154
 155         /* inform device about NTB input size changes */
 156         if (ctx->rx_max != le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize)) {
 157                 __le32 dwNtbInMaxSize = cpu_to_le32(ctx->rx_max);
 158
 159                 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
 160                                        USB_TYPE_CLASS | USB_DIR_OUT
 161                                        | USB_RECIP_INTERFACE,
 162                                        0, iface_no, &dwNtbInMaxSize, 4);
 163                 if (err < 0)
 164                         pr_debug("Setting NTB Input Size failed\n");
 165         }
 166
 167         /* verify maximum size of transmitted NTB in bytes */
 168         if ((ctx->tx_max <
 169             (min_hdr_size + min_dgram_size)) ||
 170             (ctx->tx_max > CDC_NCM_NTB_MAX_SIZE_TX)) {
 171                 pr_debug("Using default maximum transmit length=%d\n",
 172                                                 CDC_NCM_NTB_MAX_SIZE_TX);
 173                 ctx->tx_max = CDC_NCM_NTB_MAX_SIZE_TX;
 174         }
 175
 176         /*
 177          * verify that the structure alignment is:
 178          * - power of two
 179          * - not greater than the maximum transmit length
 180          * - not less than four bytes
 181          */
 182         val = ctx->tx_ndp_modulus;
 183
 184         if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
 185             (val != ((-val) & val)) || (val >= ctx->tx_max)) {
 186                 pr_debug("Using default alignment: 4 bytes\n");
 187                 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
 188         }
 189
 190         /*
 191          * verify that the payload alignment is:
 192          * - power of two
 193          * - not greater than the maximum transmit length
 194          * - not less than four bytes
 195          */
 196         val = ctx->tx_modulus;
 197
 198         if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
 199             (val != ((-val) & val)) || (val >= ctx->tx_max)) {
 200                 pr_debug("Using default transmit modulus: 4 bytes\n");
 201                 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
 202         }
 203
 204         /* verify the payload remainder */
 205         if (ctx->tx_remainder >= ctx->tx_modulus) {
 206                 pr_debug("Using default transmit remainder: 0 bytes\n");
 207                 ctx->tx_remainder = 0;
 208         }
 209
 210         /* adjust TX-remainder according to NCM specification. */
 211         ctx->tx_remainder = ((ctx->tx_remainder - eth_hlen) &
 212                              (ctx->tx_modulus - 1));
 213
 214         /* additional configuration */
 215
 216         /* set CRC Mode */
 217         if (flags & USB_CDC_NCM_NCAP_CRC_MODE) {
 218                 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
 219                                        USB_TYPE_CLASS | USB_DIR_OUT
 220                                        | USB_RECIP_INTERFACE,
 221                                        USB_CDC_NCM_CRC_NOT_APPENDED,
 222                                        iface_no, NULL, 0);
 223                 if (err < 0)
 224                         pr_debug("Setting CRC mode off failed\n");
 225         }
 226
 227         /* set NTB format, if both formats are supported */
 228         if (ntb_fmt_supported & USB_CDC_NCM_NTH32_SIGN) {
 229                 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
 230                                        USB_TYPE_CLASS | USB_DIR_OUT
 231                                        | USB_RECIP_INTERFACE,
 232                                        USB_CDC_NCM_NTB16_FORMAT,
 233                                        iface_no, NULL, 0);
 234                 if (err < 0)
 235                         pr_debug("Setting NTB format to 16-bit failed\n");
 236         }
 237
 238         ctx->max_datagram_size = min_dgram_size;
 239
 240         /* set Max Datagram Size (MTU) */
 241         if (flags & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE) {
 242                 __le16 max_datagram_size;
 243                 u16 eth_max_sz;
 244                 if (ctx->ether_desc != NULL)
 245                         eth_max_sz = le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
 246                 else if (ctx->mbim_desc != NULL)
 247                         eth_max_sz = le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
 248                 else
 249                         goto max_dgram_err;
 250
 251                 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
 252                                       USB_TYPE_CLASS | USB_DIR_IN
 253                                       | USB_RECIP_INTERFACE,
 254                                       0, iface_no, &max_datagram_size, 2);
 255                 if (err < 0) {
 256                         pr_debug("GET_MAX_DATAGRAM_SIZE failed, use size=%u\n",
 257                                  min_dgram_size);
 258                 } else {
 259                         ctx->max_datagram_size =
 260                                 le16_to_cpu(max_datagram_size);
 261                         /* Check Eth descriptor value */
 262                         if (ctx->max_datagram_size > eth_max_sz)
 263                                         ctx->max_datagram_size = eth_max_sz;
 264
 265                         if (ctx->max_datagram_size > CDC_NCM_MAX_DATAGRAM_SIZE)
 266                                 ctx->max_datagram_size = CDC_NCM_MAX_DATAGRAM_SIZE;
 267
 268                         if (ctx->max_datagram_size < min_dgram_size)
 269                                 ctx->max_datagram_size = min_dgram_size;
 270
 271                         /* if value changed, update device */
 272                         if (ctx->max_datagram_size !=
 273                                         le16_to_cpu(max_datagram_size)) {
 274                                 err = usbnet_write_cmd(dev,
 275                                                 USB_CDC_SET_MAX_DATAGRAM_SIZE,
 276                                                 USB_TYPE_CLASS | USB_DIR_OUT
 277                                                  | USB_RECIP_INTERFACE,
 278                                                 0,
 279                                                 iface_no, &max_datagram_size,
 280                                                 2);
 281                                 if (err < 0)
 282                                         pr_debug("SET_MAX_DGRAM_SIZE failed\n");
 283                         }
 284                 }
 285         }
 286
 287 max_dgram_err:
 288         if (ctx->netdev->mtu != (ctx->max_datagram_size - eth_hlen))
 289                 ctx->netdev->mtu = ctx->max_datagram_size - eth_hlen;
 290
 291         return 0;
 292 }
 293
 294 static void
 295 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
 296 {
 297         struct usb_host_endpoint *e, *in = NULL, *out = NULL;
 298         u8 ep;
 299
 300         for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
 301
 302                 e = intf->cur_altsetting->endpoint + ep;
 303                 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
 304                 case USB_ENDPOINT_XFER_INT:
 305                         if (usb_endpoint_dir_in(&e->desc)) {
 306                                 if (!dev->status)
 307                                         dev->status = e;
 308                         }
 309                         break;
 310
 311                 case USB_ENDPOINT_XFER_BULK:
 312                         if (usb_endpoint_dir_in(&e->desc)) {
 313                                 if (!in)
 314                                         in = e;
 315                         } else {
 316                                 if (!out)
 317                                         out = e;
 318                         }
 319                         break;
 320
 321                 default:
 322                         break;
 323                 }
 324         }
 325         if (in && !dev->in)
 326                 dev->in = usb_rcvbulkpipe(dev->udev,
 327                                           in->desc.bEndpointAddress &
 328                                           USB_ENDPOINT_NUMBER_MASK);
 329         if (out && !dev->out)
 330                 dev->out = usb_sndbulkpipe(dev->udev,
 331                                            out->desc.bEndpointAddress &
 332                                            USB_ENDPOINT_NUMBER_MASK);
 333 }
 334
 335 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
 336 {
 337         if (ctx == NULL)
 338                 return;
 339
 340         if (ctx->tx_rem_skb != NULL) {
 341                 dev_kfree_skb_any(ctx->tx_rem_skb);
 342                 ctx->tx_rem_skb = NULL;
 343         }
 344
 345         if (ctx->tx_curr_skb != NULL) {
 346                 dev_kfree_skb_any(ctx->tx_curr_skb);
 347                 ctx->tx_curr_skb = NULL;
 348         }
 349
 350         kfree(ctx);
 351 }
 352
 353 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
 354         .get_drvinfo = cdc_ncm_get_drvinfo,
 355         .get_link = usbnet_get_link,
 356         .get_msglevel = usbnet_get_msglevel,
 357         .set_msglevel = usbnet_set_msglevel,
 358         .get_settings = usbnet_get_settings,
 359         .set_settings = usbnet_set_settings,
 360         .nway_reset = usbnet_nway_reset,
 361 };
 362
 363 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting)
 364 {
 365         struct cdc_ncm_ctx *ctx;
 366         struct usb_driver *driver;
 367         u8 *buf;
 368         int len;
 369         int temp;
 370         u8 iface_no;
 371
 372         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
 373         if (!ctx)
 374                 return -ENOMEM;
 375
 376         hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
 377         ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
 378         ctx->bh.data = (unsigned long)ctx;
 379         ctx->bh.func = cdc_ncm_txpath_bh;
 380         atomic_set(&ctx->stop, 0);
 381         spin_lock_init(&ctx->mtx);
 382         ctx->netdev = dev->net;
 383
 384         /* store ctx pointer in device data field */
 385         dev->data[0] = (unsigned long)ctx;
 386
 387         /* get some pointers */
 388         driver = driver_of(intf);
 389         buf = intf->cur_altsetting->extra;
 390         len = intf->cur_altsetting->extralen;
 391
 392         ctx->udev = dev->udev;
 393
 394         /* parse through descriptors associated with control interface */
 395         while ((len > 0) && (buf[0] > 2) && (buf[0] <= len)) {
 396
 397                 if (buf[1] != USB_DT_CS_INTERFACE)
 398                         goto advance;
 399
 400                 switch (buf[2]) {
 401                 case USB_CDC_UNION_TYPE:
 402                         if (buf[0] < sizeof(*(ctx->union_desc)))
 403                                 break;
 404
 405                         ctx->union_desc =
 406                                         (const struct usb_cdc_union_desc *)buf;
 407
 408                         ctx->control = usb_ifnum_to_if(dev->udev,
 409                                         ctx->union_desc->bMasterInterface0);
 410                         ctx->data = usb_ifnum_to_if(dev->udev,
 411                                         ctx->union_desc->bSlaveInterface0);
 412                         break;
 413
 414                 case USB_CDC_ETHERNET_TYPE:
 415                         if (buf[0] < sizeof(*(ctx->ether_desc)))
 416                                 break;
 417
 418                         ctx->ether_desc =
 419                                         (const struct usb_cdc_ether_desc *)buf;
 420                         dev->hard_mtu =
 421                                 le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
 422
 423                         if (dev->hard_mtu < CDC_NCM_MIN_DATAGRAM_SIZE)
 424                                 dev->hard_mtu = CDC_NCM_MIN_DATAGRAM_SIZE;
 425                         else if (dev->hard_mtu > CDC_NCM_MAX_DATAGRAM_SIZE)
 426                                 dev->hard_mtu = CDC_NCM_MAX_DATAGRAM_SIZE;
 427                         break;
 428
 429                 case USB_CDC_NCM_TYPE:
 430                         if (buf[0] < sizeof(*(ctx->func_desc)))
 431                                 break;
 432
 433                         ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
 434                         break;
 435
 436                 case USB_CDC_MBIM_TYPE:
 437                         if (buf[0] < sizeof(*(ctx->mbim_desc)))
 438                                 break;
 439
 440                         ctx->mbim_desc = (const struct usb_cdc_mbim_desc *)buf;
 441                         break;
 442
 443                 default:
 444                         break;
 445                 }
 446 advance:
 447                 /* advance to next descriptor */
 448                 temp = buf[0];
 449                 buf += temp;
 450                 len -= temp;
 451         }
 452
 453         /* some buggy devices have an IAD but no CDC Union */
 454         if (!ctx->union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
 455                 ctx->control = intf;
 456                 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
 457                 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
 458         }
 459
 460         /* check if we got everything */
 461         if ((ctx->control == NULL) || (ctx->data == NULL) ||
 462             ((!ctx->mbim_desc) && ((ctx->ether_desc == NULL) || (ctx->control != intf))))
 463                 goto error;
 464
 465         /* claim data interface, if different from control */
 466         if (ctx->data != ctx->control) {
 467                 temp = usb_driver_claim_interface(driver, ctx->data, dev);
 468                 if (temp)
 469                         goto error;
 470         }
 471
 472         iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
 473
 474         /* reset data interface */
 475         temp = usb_set_interface(dev->udev, iface_no, 0);
 476         if (temp)
 477                 goto error2;
 478
 479         /* initialize data interface */
 480         if (cdc_ncm_setup(ctx))
 481                 goto error2;
 482
 483         /* configure data interface */
 484         temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
 485         if (temp)
 486                 goto error2;
 487
 488         cdc_ncm_find_endpoints(dev, ctx->data);
 489         cdc_ncm_find_endpoints(dev, ctx->control);
 490         if (!dev->in || !dev->out || !dev->status)
 491                 goto error2;
 492
 493         dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
 494
 495         usb_set_intfdata(ctx->data, dev);
 496         usb_set_intfdata(ctx->control, dev);
 497
 498         if (ctx->ether_desc) {
 499                 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
 500                 if (temp)
 501                         goto error2;
 502                 dev_info(&dev->udev->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
 503         }
 504
 505         dev->rx_urb_size = ctx->rx_max;
 506
 507         /* cdc_ncm_setup will override dwNtbOutMaxSize if it is
 508          * outside the sane range. Adding a pad byte here if necessary
 509          * simplifies the handling in cdc_ncm_fill_tx_frame, making
 510          * tx_max always represent the real skb max size.
 511          */
 512         if (ctx->tx_max != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
 513             ctx->tx_max % usb_maxpacket(dev->udev, dev->out, 1) == 0)
 514                 ctx->tx_max++;
 515
 516         ctx->tx_speed = ctx->rx_speed = 0;
 517         return 0;
 518
 519 error2:
 520         usb_set_intfdata(ctx->control, NULL);
 521         usb_set_intfdata(ctx->data, NULL);
 522         if (ctx->data != ctx->control)
 523                 usb_driver_release_interface(driver, ctx->data);
 524 error:
 525         cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
 526         dev->data[0] = 0;
 527         dev_info(&dev->udev->dev, "bind() failure\n");
 528         return -ENODEV;
 529 }
 530 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
 531
 532 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
 533 {
 534         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 535         struct usb_driver *driver = driver_of(intf);
 536
 537         if (ctx == NULL)
 538                 return;         /* no setup */
 539
 540         atomic_set(&ctx->stop, 1);
 541
 542         if (hrtimer_active(&ctx->tx_timer))
 543                 hrtimer_cancel(&ctx->tx_timer);
 544
 545         tasklet_kill(&ctx->bh);
 546
 547         /* handle devices with combined control and data interface */
 548         if (ctx->control == ctx->data)
 549                 ctx->data = NULL;
 550
 551         /* disconnect master --> disconnect slave */
 552         if (intf == ctx->control && ctx->data) {
 553                 usb_set_intfdata(ctx->data, NULL);
 554                 usb_driver_release_interface(driver, ctx->data);
 555                 ctx->data = NULL;
 556
 557         } else if (intf == ctx->data && ctx->control) {
 558                 usb_set_intfdata(ctx->control, NULL);
 559                 usb_driver_release_interface(driver, ctx->control);
 560                 ctx->control = NULL;
 561         }
 562
 563         usb_set_intfdata(intf, NULL);
 564         cdc_ncm_free(ctx);
 565 }
 566 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
 567
 568 /* Select the MBIM altsetting iff it is preferred and available,
 569  * returning the number of the corresponding data interface altsetting
 570  */
 571 u8 cdc_ncm_select_altsetting(struct usbnet *dev, struct usb_interface *intf)
 572 {
 573         struct usb_host_interface *alt;
 574
 575         /* The MBIM spec defines a NCM compatible default altsetting,
 576          * which we may have matched:
 577          *
 578          *  "Functions that implement both NCM 1.0 and MBIM (an
 579          *   “NCM/MBIM function”) according to this recommendation
 580          *   shall provide two alternate settings for the
 581          *   Communication Interface.  Alternate setting 0, and the
 582          *   associated class and endpoint descriptors, shall be
 583          *   constructed according to the rules given for the
 584          *   Communication Interface in section 5 of [USBNCM10].
 585          *   Alternate setting 1, and the associated class and
 586          *   endpoint descriptors, shall be constructed according to
 587          *   the rules given in section 6 (USB Device Model) of this
 588          *   specification."
 589          */
 590         if (prefer_mbim && intf->num_altsetting == 2) {
 591                 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
 592                 if (alt && cdc_ncm_comm_intf_is_mbim(alt) &&
 593                     !usb_set_interface(dev->udev,
 594                                        intf->cur_altsetting->desc.bInterfaceNumber,
 595                                        CDC_NCM_COMM_ALTSETTING_MBIM))
 596                         return CDC_NCM_DATA_ALTSETTING_MBIM;
 597         }
 598         return CDC_NCM_DATA_ALTSETTING_NCM;
 599 }
 600 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
 601
 602 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
 603 {
 604         int ret;
 605
 606         /* MBIM backwards compatible function? */
 607         cdc_ncm_select_altsetting(dev, intf);
 608         if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting))
 609                 return -ENODEV;
 610
 611         /* NCM data altsetting is always 1 */
 612         ret = cdc_ncm_bind_common(dev, intf, 1);
 613
 614         /*
 615          * We should get an event when network connection is "connected" or
 616          * "disconnected". Set network connection in "disconnected" state
 617          * (carrier is OFF) during attach, so the IP network stack does not
 618          * start IPv6 negotiation and more.
 619          */
 620         usbnet_link_change(dev, 0, 0);
 621         return ret;
 622 }
 623
 624 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
 625 {
 626         size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
 627
 628         if (skb->len + align > max)
 629                 align = max - skb->len;
 630         if (align && skb_tailroom(skb) >= align)
 631                 memset(skb_put(skb, align), 0, align);
 632 }
 633
 634 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
 635  * allocating a new one within skb
 636  */
 637 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
 638 {
 639         struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
 640         struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
 641         size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
 642
 643         /* follow the chain of NDPs, looking for a match */
 644         while (ndpoffset) {
 645                 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
 646                 if  (ndp16->dwSignature == sign)
 647                         return ndp16;
 648                 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
 649         }
 650
 651         /* align new NDP */
 652         cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
 653
 654         /* verify that there is room for the NDP and the datagram (reserve) */
 655         if ((ctx->tx_max - skb->len - reserve) < CDC_NCM_NDP_SIZE)
 656                 return NULL;
 657
 658         /* link to it */
 659         if (ndp16)
 660                 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
 661         else
 662                 nth16->wNdpIndex = cpu_to_le16(skb->len);
 663
 664         /* push a new empty NDP */
 665         ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, CDC_NCM_NDP_SIZE), 0, CDC_NCM_NDP_SIZE);
 666         ndp16->dwSignature = sign;
 667         ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
 668         return ndp16;
 669 }
 670
 671 struct sk_buff *
 672 cdc_ncm_fill_tx_frame(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign)
 673 {
 674         struct usbnet *dev = netdev_priv(ctx->netdev);
 675         struct usb_cdc_ncm_nth16 *nth16;
 676         struct usb_cdc_ncm_ndp16 *ndp16;
 677         struct sk_buff *skb_out;
 678         u16 n = 0, index, ndplen;
 679         u8 ready2send = 0;
 680
 681         /* if there is a remaining skb, it gets priority */
 682         if (skb != NULL) {
 683                 swap(skb, ctx->tx_rem_skb);
 684                 swap(sign, ctx->tx_rem_sign);
 685         } else {
 686                 ready2send = 1;
 687         }
 688
 689         /* check if we are resuming an OUT skb */
 690         skb_out = ctx->tx_curr_skb;
 691
 692         /* allocate a new OUT skb */
 693         if (!skb_out) {
 694                 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
 695                 if (skb_out == NULL) {
 696                         if (skb != NULL) {
 697                                 dev_kfree_skb_any(skb);
 698                                 ctx->netdev->stats.tx_dropped++;
 699                         }
 700                         goto exit_no_skb;
 701                 }
 702                 /* fill out the initial 16-bit NTB header */
 703                 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
 704                 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
 705                 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
 706                 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
 707
 708                 /* count total number of frames in this NTB */
 709                 ctx->tx_curr_frame_num = 0;
 710         }
 711
 712         for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
 713                 /* send any remaining skb first */
 714                 if (skb == NULL) {
 715                         skb = ctx->tx_rem_skb;
 716                         sign = ctx->tx_rem_sign;
 717                         ctx->tx_rem_skb = NULL;
 718
 719                         /* check for end of skb */
 720                         if (skb == NULL)
 721                                 break;
 722                 }
 723
 724                 /* get the appropriate NDP for this skb */
 725                 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
 726
 727                 /* align beginning of next frame */
 728                 cdc_ncm_align_tail(skb_out,  ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
 729
 730                 /* check if we had enough room left for both NDP and frame */
 731                 if (!ndp16 || skb_out->len + skb->len > ctx->tx_max) {
 732                         if (n == 0) {
 733                                 /* won't fit, MTU problem? */
 734                                 dev_kfree_skb_any(skb);
 735                                 skb = NULL;
 736                                 ctx->netdev->stats.tx_dropped++;
 737                         } else {
 738                                 /* no room for skb - store for later */
 739                                 if (ctx->tx_rem_skb != NULL) {
 740                                         dev_kfree_skb_any(ctx->tx_rem_skb);
 741                                         ctx->netdev->stats.tx_dropped++;
 742                                 }
 743                                 ctx->tx_rem_skb = skb;
 744                                 ctx->tx_rem_sign = sign;
 745                                 skb = NULL;
 746                                 ready2send = 1;
 747                         }
 748                         break;
 749                 }
 750
 751                 /* calculate frame number withing this NDP */
 752                 ndplen = le16_to_cpu(ndp16->wLength);
 753                 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
 754
 755                 /* OK, add this skb */
 756                 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
 757                 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
 758                 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
 759                 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
 760                 dev_kfree_skb_any(skb);
 761                 skb = NULL;
 762
 763                 /* send now if this NDP is full */
 764                 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
 765                         ready2send = 1;
 766                         break;
 767                 }
 768         }
 769
 770         /* free up any dangling skb */
 771         if (skb != NULL) {
 772                 dev_kfree_skb_any(skb);
 773                 skb = NULL;
 774                 ctx->netdev->stats.tx_dropped++;
 775         }
 776
 777         ctx->tx_curr_frame_num = n;
 778
 779         if (n == 0) {
 780                 /* wait for more frames */
 781                 /* push variables */
 782                 ctx->tx_curr_skb = skb_out;
 783                 goto exit_no_skb;
 784
 785         } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0)) {
 786                 /* wait for more frames */
 787                 /* push variables */
 788                 ctx->tx_curr_skb = skb_out;
 789                 /* set the pending count */
 790                 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
 791                         ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
 792                 goto exit_no_skb;
 793
 794         } else {
 795                 /* frame goes out */
 796                 /* variables will be reset at next call */
 797         }
 798
 799         /* If collected data size is less or equal CDC_NCM_MIN_TX_PKT
 800          * bytes, we send buffers as it is. If we get more data, it
 801          * would be more efficient for USB HS mobile device with DMA
 802          * engine to receive a full size NTB, than canceling DMA
 803          * transfer and receiving a short packet.
 804          */
 805         if (skb_out->len > CDC_NCM_MIN_TX_PKT)
 806                 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
 807                        ctx->tx_max - skb_out->len);
 808         else if ((skb_out->len % dev->maxpacket) == 0)
 809                 *skb_put(skb_out, 1) = 0;       /* force short packet */
 810
 811         /* set final frame length */
 812         nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
 813         nth16->wBlockLength = cpu_to_le16(skb_out->len);
 814
 815         /* return skb */
 816         ctx->tx_curr_skb = NULL;
 817         ctx->netdev->stats.tx_packets += ctx->tx_curr_frame_num;
 818         return skb_out;
 819
 820 exit_no_skb:
 821         /* Start timer, if there is a remaining skb */
 822         if (ctx->tx_curr_skb != NULL)
 823                 cdc_ncm_tx_timeout_start(ctx);
 824         return NULL;
 825 }
 826 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
 827
 828 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
 829 {
 830         /* start timer, if not already started */
 831         if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
 832                 hrtimer_start(&ctx->tx_timer,
 833                                 ktime_set(0, CDC_NCM_TIMER_INTERVAL),
 834                                 HRTIMER_MODE_REL);
 835 }
 836
 837 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
 838 {
 839         struct cdc_ncm_ctx *ctx =
 840                         container_of(timer, struct cdc_ncm_ctx, tx_timer);
 841
 842         if (!atomic_read(&ctx->stop))
 843                 tasklet_schedule(&ctx->bh);
 844         return HRTIMER_NORESTART;
 845 }
 846
 847 static void cdc_ncm_txpath_bh(unsigned long param)
 848 {
 849         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)param;
 850
 851         spin_lock_bh(&ctx->mtx);
 852         if (ctx->tx_timer_pending != 0) {
 853                 ctx->tx_timer_pending--;
 854                 cdc_ncm_tx_timeout_start(ctx);
 855                 spin_unlock_bh(&ctx->mtx);
 856         } else if (ctx->netdev != NULL) {
 857                 spin_unlock_bh(&ctx->mtx);
 858                 netif_tx_lock_bh(ctx->netdev);
 859                 usbnet_start_xmit(NULL, ctx->netdev);
 860                 netif_tx_unlock_bh(ctx->netdev);
 861         } else {
 862                 spin_unlock_bh(&ctx->mtx);
 863         }
 864 }
 865
 866 static struct sk_buff *
 867 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
 868 {
 869         struct sk_buff *skb_out;
 870         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 871
 872         /*
 873          * The Ethernet API we are using does not support transmitting
 874          * multiple Ethernet frames in a single call. This driver will
 875          * accumulate multiple Ethernet frames and send out a larger
 876          * USB frame when the USB buffer is full or when a single jiffies
 877          * timeout happens.
 878          */
 879         if (ctx == NULL)
 880                 goto error;
 881
 882         spin_lock_bh(&ctx->mtx);
 883         skb_out = cdc_ncm_fill_tx_frame(ctx, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
 884         spin_unlock_bh(&ctx->mtx);
 885         return skb_out;
 886
 887 error:
 888         if (skb != NULL)
 889                 dev_kfree_skb_any(skb);
 890
 891         return NULL;
 892 }
 893
 894 /* verify NTB header and return offset of first NDP, or negative error */
 895 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
 896 {
 897         struct usb_cdc_ncm_nth16 *nth16;
 898         int len;
 899         int ret = -EINVAL;
 900
 901         if (ctx == NULL)
 902                 goto error;
 903
 904         if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
 905                                         sizeof(struct usb_cdc_ncm_ndp16))) {
 906                 pr_debug("frame too short\n");
 907                 goto error;
 908         }
 909
 910         nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
 911
 912         if (le32_to_cpu(nth16->dwSignature) != USB_CDC_NCM_NTH16_SIGN) {
 913                 pr_debug("invalid NTH16 signature <%u>\n",
 914                                         le32_to_cpu(nth16->dwSignature));
 915                 goto error;
 916         }
 917
 918         len = le16_to_cpu(nth16->wBlockLength);
 919         if (len > ctx->rx_max) {
 920                 pr_debug("unsupported NTB block length %u/%u\n", len,
 921                                                                 ctx->rx_max);
 922                 goto error;
 923         }
 924
 925         if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
 926                 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
 927                 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
 928                 pr_debug("sequence number glitch prev=%d curr=%d\n",
 929                                 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
 930         }
 931         ctx->rx_seq = le16_to_cpu(nth16->wSequence);
 932
 933         ret = le16_to_cpu(nth16->wNdpIndex);
 934 error:
 935         return ret;
 936 }
 937 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
 938
 939 /* verify NDP header and return number of datagrams, or negative error */
 940 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
 941 {
 942         struct usb_cdc_ncm_ndp16 *ndp16;
 943         int ret = -EINVAL;
 944
 945         if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
 946                 pr_debug("invalid NDP offset  <%u>\n", ndpoffset);
 947                 goto error;
 948         }
 949         ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
 950
 951         if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
 952                 pr_debug("invalid DPT16 length <%u>\n",
 953                                         le32_to_cpu(ndp16->dwSignature));
 954                 goto error;
 955         }
 956
 957         ret = ((le16_to_cpu(ndp16->wLength) -
 958                                         sizeof(struct usb_cdc_ncm_ndp16)) /
 959                                         sizeof(struct usb_cdc_ncm_dpe16));
 960         ret--; /* we process NDP entries except for the last one */
 961
 962         if ((sizeof(struct usb_cdc_ncm_ndp16) + ret * (sizeof(struct usb_cdc_ncm_dpe16))) >
 963                                                                 skb_in->len) {
 964                 pr_debug("Invalid nframes = %d\n", ret);
 965                 ret = -EINVAL;
 966         }
 967
 968 error:
 969         return ret;
 970 }
 971 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
 972
 973 static int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
 974 {
 975         struct sk_buff *skb;
 976         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 977         int len;
 978         int nframes;
 979         int x;
 980         int offset;
 981         struct usb_cdc_ncm_ndp16 *ndp16;
 982         struct usb_cdc_ncm_dpe16 *dpe16;
 983         int ndpoffset;
 984         int loopcount = 50; /* arbitrary max preventing infinite loop */
 985
 986         ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
 987         if (ndpoffset < 0)
 988                 goto error;
 989
 990 next_ndp:
 991         nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
 992         if (nframes < 0)
 993                 goto error;
 994
 995         ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
 996
 997         if (le32_to_cpu(ndp16->dwSignature) != USB_CDC_NCM_NDP16_NOCRC_SIGN) {
 998                 pr_debug("invalid DPT16 signature <%u>\n",
 999                          le32_to_cpu(ndp16->dwSignature));
1000                 goto err_ndp;
1001         }
1002         dpe16 = ndp16->dpe16;
1003
1004         for (x = 0; x < nframes; x++, dpe16++) {
1005                 offset = le16_to_cpu(dpe16->wDatagramIndex);
1006                 len = le16_to_cpu(dpe16->wDatagramLength);
1007
1008                 /*
1009                  * CDC NCM ch. 3.7
1010                  * All entries after first NULL entry are to be ignored
1011                  */
1012                 if ((offset == 0) || (len == 0)) {
1013                         if (!x)
1014                                 goto err_ndp; /* empty NTB */
1015                         break;
1016                 }
1017
1018                 /* sanity checking */
1019                 if (((offset + len) > skb_in->len) ||
1020                                 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1021                         pr_debug("invalid frame detected (ignored)"
1022                                         "offset[%u]=%u, length=%u, skb=%p\n",
1023                                         x, offset, len, skb_in);
1024                         if (!x)
1025                                 goto err_ndp;
1026                         break;
1027
1028                 } else {
1029                         skb = skb_clone(skb_in, GFP_ATOMIC);
1030                         if (!skb)
1031                                 goto error;
1032                         skb->len = len;
1033                         skb->data = ((u8 *)skb_in->data) + offset;
1034                         skb_set_tail_pointer(skb, len);
1035                         usbnet_skb_return(dev, skb);
1036                 }
1037         }
1038 err_ndp:
1039         /* are there more NDPs to process? */
1040         ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1041         if (ndpoffset && loopcount--)
1042                 goto next_ndp;
1043
1044         return 1;
1045 error:
1046         return 0;
1047 }
1048
1049 static void
1050 cdc_ncm_speed_change(struct cdc_ncm_ctx *ctx,
1051                      struct usb_cdc_speed_change *data)
1052 {
1053         uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1054         uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1055
1056         /*
1057          * Currently the USB-NET API does not support reporting the actual
1058          * device speed. Do print it instead.
1059          */
1060         if ((tx_speed != ctx->tx_speed) || (rx_speed != ctx->rx_speed)) {
1061                 ctx->tx_speed = tx_speed;
1062                 ctx->rx_speed = rx_speed;
1063
1064                 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1065                         printk(KERN_INFO KBUILD_MODNAME
1066                                 ": %s: %u mbit/s downlink "
1067                                 "%u mbit/s uplink\n",
1068                                 ctx->netdev->name,
1069                                 (unsigned int)(rx_speed / 1000000U),
1070                                 (unsigned int)(tx_speed / 1000000U));
1071                 } else {
1072                         printk(KERN_INFO KBUILD_MODNAME
1073                                 ": %s: %u kbit/s downlink "
1074                                 "%u kbit/s uplink\n",
1075                                 ctx->netdev->name,
1076                                 (unsigned int)(rx_speed / 1000U),
1077                                 (unsigned int)(tx_speed / 1000U));
1078                 }
1079         }
1080 }
1081
1082 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1083 {
1084         struct cdc_ncm_ctx *ctx;
1085         struct usb_cdc_notification *event;
1086
1087         ctx = (struct cdc_ncm_ctx *)dev->data[0];
1088
1089         if (urb->actual_length < sizeof(*event))
1090                 return;
1091
1092         /* test for split data in 8-byte chunks */
1093         if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1094                 cdc_ncm_speed_change(ctx,
1095                       (struct usb_cdc_speed_change *)urb->transfer_buffer);
1096                 return;
1097         }
1098
1099         event = urb->transfer_buffer;
1100
1101         switch (event->bNotificationType) {
1102         case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1103                 /*
1104                  * According to the CDC NCM specification ch.7.1
1105                  * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1106                  * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1107                  */
1108                 ctx->connected = le16_to_cpu(event->wValue);
1109
1110                 printk(KERN_INFO KBUILD_MODNAME ": %s: network connection:"
1111                         " %sconnected\n",
1112                         ctx->netdev->name, ctx->connected ? "" : "dis");
1113
1114                 usbnet_link_change(dev, ctx->connected, 0);
1115                 if (!ctx->connected)
1116                         ctx->tx_speed = ctx->rx_speed = 0;
1117                 break;
1118
1119         case USB_CDC_NOTIFY_SPEED_CHANGE:
1120                 if (urb->actual_length < (sizeof(*event) +
1121                                         sizeof(struct usb_cdc_speed_change)))
1122                         set_bit(EVENT_STS_SPLIT, &dev->flags);
1123                 else
1124                         cdc_ncm_speed_change(ctx,
1125                                 (struct usb_cdc_speed_change *) &event[1]);
1126                 break;
1127
1128         default:
1129                 dev_dbg(&dev->udev->dev,
1130                         "NCM: unexpected notification 0x%02x!\n",
1131                         event->bNotificationType);
1132                 break;
1133         }
1134 }
1135
1136 static int cdc_ncm_check_connect(struct usbnet *dev)
1137 {
1138         struct cdc_ncm_ctx *ctx;
1139
1140         ctx = (struct cdc_ncm_ctx *)dev->data[0];
1141         if (ctx == NULL)
1142                 return 1;       /* disconnected */
1143
1144         return !ctx->connected;
1145 }
1146
1147 static int
1148 cdc_ncm_probe(struct usb_interface *udev, const struct usb_device_id *prod)
1149 {
1150         return usbnet_probe(udev, prod);
1151 }
1152
1153 static void cdc_ncm_disconnect(struct usb_interface *intf)
1154 {
1155         struct usbnet *dev = usb_get_intfdata(intf);
1156
1157         if (dev == NULL)
1158                 return;         /* already disconnected */
1159
1160         usbnet_disconnect(intf);
1161 }
1162
1163 static const struct driver_info cdc_ncm_info = {
1164         .description = "CDC NCM",
1165         .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1166         .bind = cdc_ncm_bind,
1167         .unbind = cdc_ncm_unbind,
1168         .check_connect = cdc_ncm_check_connect,
1169         .manage_power = usbnet_manage_power,
1170         .status = cdc_ncm_status,
1171         .rx_fixup = cdc_ncm_rx_fixup,
1172         .tx_fixup = cdc_ncm_tx_fixup,
1173 };
1174
1175 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1176 static const struct driver_info wwan_info = {
1177         .description = "Mobile Broadband Network Device",
1178         .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1179                         | FLAG_WWAN,
1180         .bind = cdc_ncm_bind,
1181         .unbind = cdc_ncm_unbind,
1182         .check_connect = cdc_ncm_check_connect,
1183         .manage_power = usbnet_manage_power,
1184         .status = cdc_ncm_status,
1185         .rx_fixup = cdc_ncm_rx_fixup,
1186         .tx_fixup = cdc_ncm_tx_fixup,
1187 };
1188
1189 /* Same as wwan_info, but with FLAG_NOARP  */
1190 static const struct driver_info wwan_noarp_info = {
1191         .description = "Mobile Broadband Network Device (NO ARP)",
1192         .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1193                         | FLAG_WWAN | FLAG_NOARP,
1194         .bind = cdc_ncm_bind,
1195         .unbind = cdc_ncm_unbind,
1196         .check_connect = cdc_ncm_check_connect,
1197         .manage_power = usbnet_manage_power,
1198         .status = cdc_ncm_status,
1199         .rx_fixup = cdc_ncm_rx_fixup,
1200         .tx_fixup = cdc_ncm_tx_fixup,
1201 };
1202
1203 static const struct usb_device_id cdc_devs[] = {
1204         /* Ericsson MBM devices like F5521gw */
1205         { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1206                 | USB_DEVICE_ID_MATCH_VENDOR,
1207           .idVendor = 0x0bdb,
1208           .bInterfaceClass = USB_CLASS_COMM,
1209           .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1210           .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1211           .driver_info = (unsigned long) &wwan_info,
1212         },
1213
1214         /* Dell branded MBM devices like DW5550 */
1215         { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1216                 | USB_DEVICE_ID_MATCH_VENDOR,
1217           .idVendor = 0x413c,
1218           .bInterfaceClass = USB_CLASS_COMM,
1219           .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1220           .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1221           .driver_info = (unsigned long) &wwan_info,
1222         },
1223
1224         /* Toshiba branded MBM devices */
1225         { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1226                 | USB_DEVICE_ID_MATCH_VENDOR,
1227           .idVendor = 0x0930,
1228           .bInterfaceClass = USB_CLASS_COMM,
1229           .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1230           .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1231           .driver_info = (unsigned long) &wwan_info,
1232         },
1233
1234         /* tag Huawei devices as wwan */
1235         { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1236                                         USB_CLASS_COMM,
1237                                         USB_CDC_SUBCLASS_NCM,
1238                                         USB_CDC_PROTO_NONE),
1239           .driver_info = (unsigned long)&wwan_info,
1240         },
1241
1242         /* Huawei NCM devices disguised as vendor specific */
1243         { USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x16),
1244           .driver_info = (unsigned long)&wwan_info,
1245         },
1246         { USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x46),
1247           .driver_info = (unsigned long)&wwan_info,
1248         },
1249         { USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x76),
1250           .driver_info = (unsigned long)&wwan_info,
1251         },
1252
1253         /* Infineon(now Intel) HSPA Modem platform */
1254         { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1255                 USB_CLASS_COMM,
1256                 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1257           .driver_info = (unsigned long)&wwan_noarp_info,
1258         },
1259
1260         /* Generic CDC-NCM devices */
1261         { USB_INTERFACE_INFO(USB_CLASS_COMM,
1262                 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1263                 .driver_info = (unsigned long)&cdc_ncm_info,
1264         },
1265         {
1266         },
1267 };
1268 MODULE_DEVICE_TABLE(usb, cdc_devs);
1269
1270 static struct usb_driver cdc_ncm_driver = {
1271         .name = "cdc_ncm",
1272         .id_table = cdc_devs,
1273         .probe = cdc_ncm_probe,
1274         .disconnect = cdc_ncm_disconnect,
1275         .suspend = usbnet_suspend,
1276         .resume = usbnet_resume,
1277         .reset_resume = usbnet_resume,
1278         .supports_autosuspend = 1,
1279         .disable_hub_initiated_lpm = 1,
1280 };
1281
1282 module_usb_driver(cdc_ncm_driver);
1283
1284 MODULE_AUTHOR("Hans Petter Selasky");
1285 MODULE_DESCRIPTION("USB CDC NCM host driver");
1286 MODULE_LICENSE("Dual BSD/GPL");