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