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/docs/devclass_docs/NCM10_012011.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/netdevice.h>
  43 #include <linux/ctype.h>
  44 #include <linux/etherdevice.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)
  57 static bool prefer_mbim = true;
  58 #else
  59 static bool prefer_mbim;
  60 #endif
  61 module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
  62 MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
  63
  64 static void cdc_ncm_txpath_bh(unsigned long param);
  65 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx);
  66 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *hr_timer);
  67 static struct usb_driver cdc_ncm_driver;
  68
  69 struct cdc_ncm_stats {
  70         char stat_string[ETH_GSTRING_LEN];
  71         int sizeof_stat;
  72         int stat_offset;
  73 };
  74
  75 #define CDC_NCM_STAT(str, m) { \
  76                 .stat_string = str, \
  77                 .sizeof_stat = sizeof(((struct cdc_ncm_ctx *)0)->m), \
  78                 .stat_offset = offsetof(struct cdc_ncm_ctx, m) }
  79 #define CDC_NCM_SIMPLE_STAT(m)  CDC_NCM_STAT(__stringify(m), m)
  80
  81 static const struct cdc_ncm_stats cdc_ncm_gstrings_stats[] = {
  82         CDC_NCM_SIMPLE_STAT(tx_reason_ntb_full),
  83         CDC_NCM_SIMPLE_STAT(tx_reason_ndp_full),
  84         CDC_NCM_SIMPLE_STAT(tx_reason_timeout),
  85         CDC_NCM_SIMPLE_STAT(tx_reason_max_datagram),
  86         CDC_NCM_SIMPLE_STAT(tx_overhead),
  87         CDC_NCM_SIMPLE_STAT(tx_ntbs),
  88         CDC_NCM_SIMPLE_STAT(rx_overhead),
  89         CDC_NCM_SIMPLE_STAT(rx_ntbs),
  90 };
  91
  92 static int cdc_ncm_get_sset_count(struct net_device __always_unused *netdev, int sset)
  93 {
  94         switch (sset) {
  95         case ETH_SS_STATS:
  96                 return ARRAY_SIZE(cdc_ncm_gstrings_stats);
  97         default:
  98                 return -EOPNOTSUPP;
  99         }
 100 }
 101
 102 static void cdc_ncm_get_ethtool_stats(struct net_device *netdev,
 103                                     struct ethtool_stats __always_unused *stats,
 104                                     u64 *data)
 105 {
 106         struct usbnet *dev = netdev_priv(netdev);
 107         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 108         int i;
 109         char *p = NULL;
 110
 111         for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
 112                 p = (char *)ctx + cdc_ncm_gstrings_stats[i].stat_offset;
 113                 data[i] = (cdc_ncm_gstrings_stats[i].sizeof_stat == sizeof(u64)) ? *(u64 *)p : *(u32 *)p;
 114         }
 115 }
 116
 117 static void cdc_ncm_get_strings(struct net_device __always_unused *netdev, u32 stringset, u8 *data)
 118 {
 119         u8 *p = data;
 120         int i;
 121
 122         switch (stringset) {
 123         case ETH_SS_STATS:
 124                 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
 125                         memcpy(p, cdc_ncm_gstrings_stats[i].stat_string, ETH_GSTRING_LEN);
 126                         p += ETH_GSTRING_LEN;
 127                 }
 128         }
 129 }
 130
 131 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
 132
 133 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
 134         .get_settings      = usbnet_get_settings,
 135         .set_settings      = usbnet_set_settings,
 136         .get_link          = usbnet_get_link,
 137         .nway_reset        = usbnet_nway_reset,
 138         .get_drvinfo       = usbnet_get_drvinfo,
 139         .get_msglevel      = usbnet_get_msglevel,
 140         .set_msglevel      = usbnet_set_msglevel,
 141         .get_ts_info       = ethtool_op_get_ts_info,
 142         .get_sset_count    = cdc_ncm_get_sset_count,
 143         .get_strings       = cdc_ncm_get_strings,
 144         .get_ethtool_stats = cdc_ncm_get_ethtool_stats,
 145 };
 146
 147 static u32 cdc_ncm_check_rx_max(struct usbnet *dev, u32 new_rx)
 148 {
 149         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 150         u32 val, max, min;
 151
 152         /* clamp new_rx to sane values */
 153         min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
 154         max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
 155
 156         /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
 157         if (max < min) {
 158                 dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
 159                          le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
 160                 max = min;
 161         }
 162
 163         val = clamp_t(u32, new_rx, min, max);
 164         if (val != new_rx)
 165                 dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range\n", min, max);
 166
 167         return val;
 168 }
 169
 170 static u32 cdc_ncm_check_tx_max(struct usbnet *dev, u32 new_tx)
 171 {
 172         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 173         u32 val, max, min;
 174
 175         /* clamp new_tx to sane values */
 176         min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
 177         max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
 178
 179         /* some devices set dwNtbOutMaxSize too low for the above default */
 180         min = min(min, max);
 181
 182         val = clamp_t(u32, new_tx, min, max);
 183         if (val != new_tx)
 184                 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range\n", min, max);
 185
 186         return val;
 187 }
 188
 189 static ssize_t cdc_ncm_show_min_tx_pkt(struct device *d, struct device_attribute *attr, char *buf)
 190 {
 191         struct usbnet *dev = netdev_priv(to_net_dev(d));
 192         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 193
 194         return sprintf(buf, "%u\n", ctx->min_tx_pkt);
 195 }
 196
 197 static ssize_t cdc_ncm_show_rx_max(struct device *d, struct device_attribute *attr, char *buf)
 198 {
 199         struct usbnet *dev = netdev_priv(to_net_dev(d));
 200         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 201
 202         return sprintf(buf, "%u\n", ctx->rx_max);
 203 }
 204
 205 static ssize_t cdc_ncm_show_tx_max(struct device *d, struct device_attribute *attr, char *buf)
 206 {
 207         struct usbnet *dev = netdev_priv(to_net_dev(d));
 208         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 209
 210         return sprintf(buf, "%u\n", ctx->tx_max);
 211 }
 212
 213 static ssize_t cdc_ncm_show_tx_timer_usecs(struct device *d, struct device_attribute *attr, char *buf)
 214 {
 215         struct usbnet *dev = netdev_priv(to_net_dev(d));
 216         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 217
 218         return sprintf(buf, "%u\n", ctx->timer_interval / (u32)NSEC_PER_USEC);
 219 }
 220
 221 static ssize_t cdc_ncm_store_min_tx_pkt(struct device *d,  struct device_attribute *attr, const char *buf, size_t len)
 222 {
 223         struct usbnet *dev = netdev_priv(to_net_dev(d));
 224         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 225         unsigned long val;
 226
 227         /* no need to restrict values - anything from 0 to infinity is OK */
 228         if (kstrtoul(buf, 0, &val))
 229                 return -EINVAL;
 230
 231         ctx->min_tx_pkt = val;
 232         return len;
 233 }
 234
 235 static ssize_t cdc_ncm_store_rx_max(struct device *d,  struct device_attribute *attr, const char *buf, size_t len)
 236 {
 237         struct usbnet *dev = netdev_priv(to_net_dev(d));
 238         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 239         unsigned long val;
 240
 241         if (kstrtoul(buf, 0, &val) || cdc_ncm_check_rx_max(dev, val) != val)
 242                 return -EINVAL;
 243
 244         cdc_ncm_update_rxtx_max(dev, val, ctx->tx_max);
 245         return len;
 246 }
 247
 248 static ssize_t cdc_ncm_store_tx_max(struct device *d,  struct device_attribute *attr, const char *buf, size_t len)
 249 {
 250         struct usbnet *dev = netdev_priv(to_net_dev(d));
 251         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 252         unsigned long val;
 253
 254         if (kstrtoul(buf, 0, &val) || cdc_ncm_check_tx_max(dev, val) != val)
 255                 return -EINVAL;
 256
 257         cdc_ncm_update_rxtx_max(dev, ctx->rx_max, val);
 258         return len;
 259 }
 260
 261 static ssize_t cdc_ncm_store_tx_timer_usecs(struct device *d,  struct device_attribute *attr, const char *buf, size_t len)
 262 {
 263         struct usbnet *dev = netdev_priv(to_net_dev(d));
 264         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 265         ssize_t ret;
 266         unsigned long val;
 267
 268         ret = kstrtoul(buf, 0, &val);
 269         if (ret)
 270                 return ret;
 271         if (val && (val < CDC_NCM_TIMER_INTERVAL_MIN || val > CDC_NCM_TIMER_INTERVAL_MAX))
 272                 return -EINVAL;
 273
 274         spin_lock_bh(&ctx->mtx);
 275         ctx->timer_interval = val * NSEC_PER_USEC;
 276         if (!ctx->timer_interval)
 277                 ctx->tx_timer_pending = 0;
 278         spin_unlock_bh(&ctx->mtx);
 279         return len;
 280 }
 281
 282 static DEVICE_ATTR(min_tx_pkt, S_IRUGO | S_IWUSR, cdc_ncm_show_min_tx_pkt, cdc_ncm_store_min_tx_pkt);
 283 static DEVICE_ATTR(rx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_rx_max, cdc_ncm_store_rx_max);
 284 static DEVICE_ATTR(tx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_max, cdc_ncm_store_tx_max);
 285 static DEVICE_ATTR(tx_timer_usecs, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_timer_usecs, cdc_ncm_store_tx_timer_usecs);
 286
 287 #define NCM_PARM_ATTR(name, format, tocpu)                              \
 288 static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
 289 { \
 290         struct usbnet *dev = netdev_priv(to_net_dev(d)); \
 291         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
 292         return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name));    \
 293 } \
 294 static DEVICE_ATTR(name, S_IRUGO, cdc_ncm_show_##name, NULL)
 295
 296 NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
 297 NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
 298 NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
 299 NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
 300 NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
 301 NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
 302 NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
 303 NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
 304 NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
 305 NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
 306
 307 static struct attribute *cdc_ncm_sysfs_attrs[] = {
 308         &dev_attr_min_tx_pkt.attr,
 309         &dev_attr_rx_max.attr,
 310         &dev_attr_tx_max.attr,
 311         &dev_attr_tx_timer_usecs.attr,
 312         &dev_attr_bmNtbFormatsSupported.attr,
 313         &dev_attr_dwNtbInMaxSize.attr,
 314         &dev_attr_wNdpInDivisor.attr,
 315         &dev_attr_wNdpInPayloadRemainder.attr,
 316         &dev_attr_wNdpInAlignment.attr,
 317         &dev_attr_dwNtbOutMaxSize.attr,
 318         &dev_attr_wNdpOutDivisor.attr,
 319         &dev_attr_wNdpOutPayloadRemainder.attr,
 320         &dev_attr_wNdpOutAlignment.attr,
 321         &dev_attr_wNtbOutMaxDatagrams.attr,
 322         NULL,
 323 };
 324
 325 static struct attribute_group cdc_ncm_sysfs_attr_group = {
 326         .name = "cdc_ncm",
 327         .attrs = cdc_ncm_sysfs_attrs,
 328 };
 329
 330 /* handle rx_max and tx_max changes */
 331 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
 332 {
 333         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 334         u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
 335         u32 val;
 336
 337         val = cdc_ncm_check_rx_max(dev, new_rx);
 338
 339         /* inform device about NTB input size changes */
 340         if (val != ctx->rx_max) {
 341                 __le32 dwNtbInMaxSize = cpu_to_le32(val);
 342
 343                 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
 344
 345                 /* tell device to use new size */
 346                 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
 347                                      USB_TYPE_CLASS | USB_DIR_OUT
 348                                      | USB_RECIP_INTERFACE,
 349                                      0, iface_no, &dwNtbInMaxSize, 4) < 0)
 350                         dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
 351                 else
 352                         ctx->rx_max = val;
 353         }
 354
 355         /* usbnet use these values for sizing rx queues */
 356         if (dev->rx_urb_size != ctx->rx_max) {
 357                 dev->rx_urb_size = ctx->rx_max;
 358                 if (netif_running(dev->net))
 359                         usbnet_unlink_rx_urbs(dev);
 360         }
 361
 362         val = cdc_ncm_check_tx_max(dev, new_tx);
 363         if (val != ctx->tx_max)
 364                 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
 365
 366         /* Adding a pad byte here if necessary simplifies the handling
 367          * in cdc_ncm_fill_tx_frame, making tx_max always represent
 368          * the real skb max size.
 369          *
 370          * We cannot use dev->maxpacket here because this is called from
 371          * .bind which is called before usbnet sets up dev->maxpacket
 372          */
 373         if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
 374             val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
 375                 val++;
 376
 377         /* we might need to flush any pending tx buffers if running */
 378         if (netif_running(dev->net) && val > ctx->tx_max) {
 379                 netif_tx_lock_bh(dev->net);
 380                 usbnet_start_xmit(NULL, dev->net);
 381                 /* make sure tx_curr_skb is reallocated if it was empty */
 382                 if (ctx->tx_curr_skb) {
 383                         dev_kfree_skb_any(ctx->tx_curr_skb);
 384                         ctx->tx_curr_skb = NULL;
 385                 }
 386                 ctx->tx_max = val;
 387                 netif_tx_unlock_bh(dev->net);
 388         } else {
 389                 ctx->tx_max = val;
 390         }
 391
 392         dev->hard_mtu = ctx->tx_max;
 393
 394         /* max qlen depend on hard_mtu and rx_urb_size */
 395         usbnet_update_max_qlen(dev);
 396
 397         /* never pad more than 3 full USB packets per transfer */
 398         ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
 399                                   CDC_NCM_MIN_TX_PKT, ctx->tx_max);
 400 }
 401
 402 /* helpers for NCM and MBIM differences */
 403 static u8 cdc_ncm_flags(struct usbnet *dev)
 404 {
 405         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 406
 407         if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
 408                 return ctx->mbim_desc->bmNetworkCapabilities;
 409         if (ctx->func_desc)
 410                 return ctx->func_desc->bmNetworkCapabilities;
 411         return 0;
 412 }
 413
 414 static int cdc_ncm_eth_hlen(struct usbnet *dev)
 415 {
 416         if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
 417                 return 0;
 418         return ETH_HLEN;
 419 }
 420
 421 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
 422 {
 423         if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
 424                 return CDC_MBIM_MIN_DATAGRAM_SIZE;
 425         return CDC_NCM_MIN_DATAGRAM_SIZE;
 426 }
 427
 428 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
 429 {
 430         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 431
 432         if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
 433                 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
 434         if (ctx->ether_desc)
 435                 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
 436         return CDC_NCM_MAX_DATAGRAM_SIZE;
 437 }
 438
 439 /* initial one-time device setup.  MUST be called with the data interface
 440  * in altsetting 0
 441  */
 442 static int cdc_ncm_init(struct usbnet *dev)
 443 {
 444         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 445         u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
 446         int err;
 447
 448         err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
 449                               USB_TYPE_CLASS | USB_DIR_IN
 450                               |USB_RECIP_INTERFACE,
 451                               0, iface_no, &ctx->ncm_parm,
 452                               sizeof(ctx->ncm_parm));
 453         if (err < 0) {
 454                 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
 455                 return err; /* GET_NTB_PARAMETERS is required */
 456         }
 457
 458         /* set CRC Mode */
 459         if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
 460                 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
 461                 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
 462                                        USB_TYPE_CLASS | USB_DIR_OUT
 463                                        | USB_RECIP_INTERFACE,
 464                                        USB_CDC_NCM_CRC_NOT_APPENDED,
 465                                        iface_no, NULL, 0);
 466                 if (err < 0)
 467                         dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
 468         }
 469
 470         /* set NTB format, if both formats are supported.
 471          *
 472          * "The host shall only send this command while the NCM Data
 473          *  Interface is in alternate setting 0."
 474          */
 475         if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
 476                                                 USB_CDC_NCM_NTB32_SUPPORTED) {
 477                 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
 478                 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
 479                                        USB_TYPE_CLASS | USB_DIR_OUT
 480                                        | USB_RECIP_INTERFACE,
 481                                        USB_CDC_NCM_NTB16_FORMAT,
 482                                        iface_no, NULL, 0);
 483                 if (err < 0)
 484                         dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
 485         }
 486
 487         /* set initial device values */
 488         ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
 489         ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
 490         ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
 491         ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
 492         ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
 493         /* devices prior to NCM Errata shall set this field to zero */
 494         ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
 495
 496         dev_dbg(&dev->intf->dev,
 497                 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
 498                 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
 499                 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
 500
 501         /* max count of tx datagrams */
 502         if ((ctx->tx_max_datagrams == 0) ||
 503                         (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
 504                 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
 505
 506         /* set up maximum NDP size */
 507         ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
 508
 509         /* initial coalescing timer interval */
 510         ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
 511
 512         return 0;
 513 }
 514
 515 /* set a new max datagram size */
 516 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
 517 {
 518         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 519         u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
 520         __le16 max_datagram_size;
 521         u16 mbim_mtu;
 522         int err;
 523
 524         /* set default based on descriptors */
 525         ctx->max_datagram_size = clamp_t(u32, new_size,
 526                                          cdc_ncm_min_dgram_size(dev),
 527                                          CDC_NCM_MAX_DATAGRAM_SIZE);
 528
 529         /* inform the device about the selected Max Datagram Size? */
 530         if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
 531                 goto out;
 532
 533         /* read current mtu value from device */
 534         err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
 535                               USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
 536                               0, iface_no, &max_datagram_size, sizeof(max_datagram_size));
 537         if (err != sizeof(max_datagram_size)) {
 538                 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
 539                 goto out;
 540         }
 541
 542         if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
 543                 goto out;
 544
 545         max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
 546         err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
 547                                USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
 548                                0, iface_no, &max_datagram_size, sizeof(max_datagram_size));
 549         if (err < 0)
 550                 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
 551
 552 out:
 553         /* set MTU to max supported by the device if necessary */
 554         dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
 555
 556         /* do not exceed operater preferred MTU */
 557         if (ctx->mbim_extended_desc) {
 558                 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
 559                 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
 560                         dev->net->mtu = mbim_mtu;
 561         }
 562 }
 563
 564 static void cdc_ncm_fix_modulus(struct usbnet *dev)
 565 {
 566         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 567         u32 val;
 568
 569         /*
 570          * verify that the structure alignment is:
 571          * - power of two
 572          * - not greater than the maximum transmit length
 573          * - not less than four bytes
 574          */
 575         val = ctx->tx_ndp_modulus;
 576
 577         if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
 578             (val != ((-val) & val)) || (val >= ctx->tx_max)) {
 579                 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
 580                 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
 581         }
 582
 583         /*
 584          * verify that the payload alignment is:
 585          * - power of two
 586          * - not greater than the maximum transmit length
 587          * - not less than four bytes
 588          */
 589         val = ctx->tx_modulus;
 590
 591         if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
 592             (val != ((-val) & val)) || (val >= ctx->tx_max)) {
 593                 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
 594                 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
 595         }
 596
 597         /* verify the payload remainder */
 598         if (ctx->tx_remainder >= ctx->tx_modulus) {
 599                 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
 600                 ctx->tx_remainder = 0;
 601         }
 602
 603         /* adjust TX-remainder according to NCM specification. */
 604         ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
 605                              (ctx->tx_modulus - 1));
 606 }
 607
 608 static int cdc_ncm_setup(struct usbnet *dev)
 609 {
 610         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 611         u32 def_rx, def_tx;
 612
 613         /* be conservative when selecting intial buffer size to
 614          * increase the number of hosts this will work for
 615          */
 616         def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
 617                        le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
 618         def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
 619                        le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
 620
 621         /* clamp rx_max and tx_max and inform device */
 622         cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
 623
 624         /* sanitize the modulus and remainder values */
 625         cdc_ncm_fix_modulus(dev);
 626
 627         /* set max datagram size */
 628         cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
 629         return 0;
 630 }
 631
 632 static void
 633 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
 634 {
 635         struct usb_host_endpoint *e, *in = NULL, *out = NULL;
 636         u8 ep;
 637
 638         for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
 639                 e = intf->cur_altsetting->endpoint + ep;
 640
 641                 /* ignore endpoints which cannot transfer data */
 642                 if (!usb_endpoint_maxp(&e->desc))
 643                         continue;
 644
 645                 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
 646                 case USB_ENDPOINT_XFER_INT:
 647                         if (usb_endpoint_dir_in(&e->desc)) {
 648                                 if (!dev->status)
 649                                         dev->status = e;
 650                         }
 651                         break;
 652
 653                 case USB_ENDPOINT_XFER_BULK:
 654                         if (usb_endpoint_dir_in(&e->desc)) {
 655                                 if (!in)
 656                                         in = e;
 657                         } else {
 658                                 if (!out)
 659                                         out = e;
 660                         }
 661                         break;
 662
 663                 default:
 664                         break;
 665                 }
 666         }
 667         if (in && !dev->in)
 668                 dev->in = usb_rcvbulkpipe(dev->udev,
 669                                           in->desc.bEndpointAddress &
 670                                           USB_ENDPOINT_NUMBER_MASK);
 671         if (out && !dev->out)
 672                 dev->out = usb_sndbulkpipe(dev->udev,
 673                                            out->desc.bEndpointAddress &
 674                                            USB_ENDPOINT_NUMBER_MASK);
 675 }
 676
 677 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
 678 {
 679         if (ctx == NULL)
 680                 return;
 681
 682         if (ctx->tx_rem_skb != NULL) {
 683                 dev_kfree_skb_any(ctx->tx_rem_skb);
 684                 ctx->tx_rem_skb = NULL;
 685         }
 686
 687         if (ctx->tx_curr_skb != NULL) {
 688                 dev_kfree_skb_any(ctx->tx_curr_skb);
 689                 ctx->tx_curr_skb = NULL;
 690         }
 691
 692         kfree(ctx->delayed_ndp16);
 693
 694         kfree(ctx);
 695 }
 696
 697 /* we need to override the usbnet change_mtu ndo for two reasons:
 698  *  - respect the negotiated maximum datagram size
 699  *  - avoid unwanted changes to rx and tx buffers
 700  */
 701 int cdc_ncm_change_mtu(struct net_device *net, int new_mtu)
 702 {
 703         struct usbnet *dev = netdev_priv(net);
 704         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 705         int maxmtu = ctx->max_datagram_size - cdc_ncm_eth_hlen(dev);
 706
 707         if (new_mtu <= 0 || new_mtu > maxmtu)
 708                 return -EINVAL;
 709         net->mtu = new_mtu;
 710         return 0;
 711 }
 712 EXPORT_SYMBOL_GPL(cdc_ncm_change_mtu);
 713
 714 static const struct net_device_ops cdc_ncm_netdev_ops = {
 715         .ndo_open            = usbnet_open,
 716         .ndo_stop            = usbnet_stop,
 717         .ndo_start_xmit      = usbnet_start_xmit,
 718         .ndo_tx_timeout      = usbnet_tx_timeout,
 719         .ndo_change_mtu      = cdc_ncm_change_mtu,
 720         .ndo_set_mac_address = eth_mac_addr,
 721         .ndo_validate_addr   = eth_validate_addr,
 722 };
 723
 724 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
 725 {
 726         struct cdc_ncm_ctx *ctx;
 727         struct usb_driver *driver;
 728         u8 *buf;
 729         int len;
 730         int temp;
 731         int err;
 732         u8 iface_no;
 733         struct usb_cdc_parsed_header hdr;
 734         __le16 curr_ntb_format;
 735
 736         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
 737         if (!ctx)
 738                 return -ENOMEM;
 739
 740         hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
 741         ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
 742         ctx->bh.data = (unsigned long)dev;
 743         ctx->bh.func = cdc_ncm_txpath_bh;
 744         atomic_set(&ctx->stop, 0);
 745         spin_lock_init(&ctx->mtx);
 746
 747         /* store ctx pointer in device data field */
 748         dev->data[0] = (unsigned long)ctx;
 749
 750         /* only the control interface can be successfully probed */
 751         ctx->control = intf;
 752
 753         /* get some pointers */
 754         driver = driver_of(intf);
 755         buf = intf->cur_altsetting->extra;
 756         len = intf->cur_altsetting->extralen;
 757
 758         /* parse through descriptors associated with control interface */
 759         cdc_parse_cdc_header(&hdr, intf, buf, len);
 760
 761         if (hdr.usb_cdc_union_desc)
 762                 ctx->data = usb_ifnum_to_if(dev->udev,
 763                                             hdr.usb_cdc_union_desc->bSlaveInterface0);
 764         ctx->ether_desc = hdr.usb_cdc_ether_desc;
 765         ctx->func_desc = hdr.usb_cdc_ncm_desc;
 766         ctx->mbim_desc = hdr.usb_cdc_mbim_desc;
 767         ctx->mbim_extended_desc = hdr.usb_cdc_mbim_extended_desc;
 768
 769         /* some buggy devices have an IAD but no CDC Union */
 770         if (!hdr.usb_cdc_union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
 771                 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
 772                 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
 773         }
 774
 775         /* check if we got everything */
 776         if (!ctx->data) {
 777                 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
 778                 goto error;
 779         }
 780         if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
 781                 if (!ctx->mbim_desc) {
 782                         dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
 783                         goto error;
 784                 }
 785         } else {
 786                 if (!ctx->ether_desc || !ctx->func_desc) {
 787                         dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
 788                         goto error;
 789                 }
 790         }
 791
 792         /* claim data interface, if different from control */
 793         if (ctx->data != ctx->control) {
 794                 temp = usb_driver_claim_interface(driver, ctx->data, dev);
 795                 if (temp) {
 796                         dev_dbg(&intf->dev, "failed to claim data intf\n");
 797                         goto error;
 798                 }
 799         }
 800
 801         iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
 802
 803         /* Reset data interface. Some devices will not reset properly
 804          * unless they are configured first.  Toggle the altsetting to
 805          * force a reset
 806          */
 807         usb_set_interface(dev->udev, iface_no, data_altsetting);
 808         temp = usb_set_interface(dev->udev, iface_no, 0);
 809         if (temp) {
 810                 dev_dbg(&intf->dev, "set interface failed\n");
 811                 goto error2;
 812         }
 813
 814         /* initialize basic device settings */
 815         if (cdc_ncm_init(dev))
 816                 goto error2;
 817
 818         /* Some firmwares need a pause here or they will silently fail
 819          * to set up the interface properly.  This value was decided
 820          * empirically on a Sierra Wireless MC7455 running 02.08.02.00
 821          * firmware.
 822          */
 823         usleep_range(10000, 20000);
 824
 825         /* configure data interface */
 826         temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
 827         if (temp) {
 828                 dev_dbg(&intf->dev, "set interface failed\n");
 829                 goto error2;
 830         }
 831
 832         /* Device-specific flags */
 833         ctx->drvflags = drvflags;
 834
 835         /*
 836          * Some Huawei devices have been observed to come out of reset in NDP32 mode.
 837          * Let's check if this is the case, and set the device to NDP16 mode again if
 838          * needed.
 839         */
 840         if (ctx->drvflags & CDC_NCM_FLAG_RESET_NTB16) {
 841                 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_FORMAT,
 842                                       USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
 843                                       0, iface_no, &curr_ntb_format, 2);
 844                 if (err < 0) {
 845                         goto error2;
 846                 }
 847
 848                 if (curr_ntb_format == cpu_to_le16(USB_CDC_NCM_NTB32_FORMAT)) {
 849                         dev_info(&intf->dev, "resetting NTB format to 16-bit");
 850                         err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
 851                                                USB_TYPE_CLASS | USB_DIR_OUT
 852                                                | USB_RECIP_INTERFACE,
 853                                                USB_CDC_NCM_NTB16_FORMAT,
 854                                                iface_no, NULL, 0);
 855
 856                         if (err < 0)
 857                                 goto error2;
 858                 }
 859         }
 860
 861         cdc_ncm_find_endpoints(dev, ctx->data);
 862         cdc_ncm_find_endpoints(dev, ctx->control);
 863         if (!dev->in || !dev->out || !dev->status) {
 864                 dev_dbg(&intf->dev, "failed to collect endpoints\n");
 865                 goto error2;
 866         }
 867
 868         usb_set_intfdata(ctx->data, dev);
 869         usb_set_intfdata(ctx->control, dev);
 870
 871         if (ctx->ether_desc) {
 872                 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
 873                 if (temp) {
 874                         dev_dbg(&intf->dev, "failed to get mac address\n");
 875                         goto error2;
 876                 }
 877                 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
 878         }
 879
 880         /* finish setting up the device specific data */
 881         cdc_ncm_setup(dev);
 882
 883         /* Allocate the delayed NDP if needed. */
 884         if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
 885                 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
 886                 if (!ctx->delayed_ndp16)
 887                         goto error2;
 888                 dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
 889         }
 890
 891         /* override ethtool_ops */
 892         dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
 893
 894         /* add our sysfs attrs */
 895         dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
 896
 897         /* must handle MTU changes */
 898         dev->net->netdev_ops = &cdc_ncm_netdev_ops;
 899
 900         return 0;
 901
 902 error2:
 903         usb_set_intfdata(ctx->control, NULL);
 904         usb_set_intfdata(ctx->data, NULL);
 905         if (ctx->data != ctx->control)
 906                 usb_driver_release_interface(driver, ctx->data);
 907 error:
 908         cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
 909         dev->data[0] = 0;
 910         dev_info(&intf->dev, "bind() failure\n");
 911         return -ENODEV;
 912 }
 913 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
 914
 915 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
 916 {
 917         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 918         struct usb_driver *driver = driver_of(intf);
 919
 920         if (ctx == NULL)
 921                 return;         /* no setup */
 922
 923         atomic_set(&ctx->stop, 1);
 924
 925         if (hrtimer_active(&ctx->tx_timer))
 926                 hrtimer_cancel(&ctx->tx_timer);
 927
 928         tasklet_kill(&ctx->bh);
 929
 930         /* handle devices with combined control and data interface */
 931         if (ctx->control == ctx->data)
 932                 ctx->data = NULL;
 933
 934         /* disconnect master --> disconnect slave */
 935         if (intf == ctx->control && ctx->data) {
 936                 usb_set_intfdata(ctx->data, NULL);
 937                 usb_driver_release_interface(driver, ctx->data);
 938                 ctx->data = NULL;
 939
 940         } else if (intf == ctx->data && ctx->control) {
 941                 usb_set_intfdata(ctx->control, NULL);
 942                 usb_driver_release_interface(driver, ctx->control);
 943                 ctx->control = NULL;
 944         }
 945
 946         usb_set_intfdata(intf, NULL);
 947         cdc_ncm_free(ctx);
 948 }
 949 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
 950
 951 /* Return the number of the MBIM control interface altsetting iff it
 952  * is preferred and available,
 953  */
 954 u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
 955 {
 956         struct usb_host_interface *alt;
 957
 958         /* The MBIM spec defines a NCM compatible default altsetting,
 959          * which we may have matched:
 960          *
 961          *  "Functions that implement both NCM 1.0 and MBIM (an
 962          *   “NCM/MBIM function”) according to this recommendation
 963          *   shall provide two alternate settings for the
 964          *   Communication Interface.  Alternate setting 0, and the
 965          *   associated class and endpoint descriptors, shall be
 966          *   constructed according to the rules given for the
 967          *   Communication Interface in section 5 of [USBNCM10].
 968          *   Alternate setting 1, and the associated class and
 969          *   endpoint descriptors, shall be constructed according to
 970          *   the rules given in section 6 (USB Device Model) of this
 971          *   specification."
 972          */
 973         if (intf->num_altsetting < 2)
 974                 return intf->cur_altsetting->desc.bAlternateSetting;
 975
 976         if (prefer_mbim) {
 977                 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
 978                 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
 979                         return CDC_NCM_COMM_ALTSETTING_MBIM;
 980         }
 981         return CDC_NCM_COMM_ALTSETTING_NCM;
 982 }
 983 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
 984
 985 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
 986 {
 987         /* MBIM backwards compatible function? */
 988         if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
 989                 return -ENODEV;
 990
 991         /* The NCM data altsetting is fixed, so we hard-coded it.
 992          * Additionally, generic NCM devices are assumed to accept arbitrarily
 993          * placed NDP.
 994          */
 995         return cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM, 0);
 996 }
 997
 998 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
 999 {
1000         size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
1001
1002         if (skb->len + align > max)
1003                 align = max - skb->len;
1004         if (align && skb_tailroom(skb) >= align)
1005                 memset(skb_put(skb, align), 0, align);
1006 }
1007
1008 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
1009  * allocating a new one within skb
1010  */
1011 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
1012 {
1013         struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
1014         struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
1015         size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
1016
1017         /* If NDP should be moved to the end of the NCM package, we can't follow the
1018         * NTH16 header as we would normally do. NDP isn't written to the SKB yet, and
1019         * the wNdpIndex field in the header is actually not consistent with reality. It will be later.
1020         */
1021         if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1022                 if (ctx->delayed_ndp16->dwSignature == sign)
1023                         return ctx->delayed_ndp16;
1024
1025                 /* We can only push a single NDP to the end. Return
1026                  * NULL to send what we've already got and queue this
1027                  * skb for later.
1028                  */
1029                 else if (ctx->delayed_ndp16->dwSignature)
1030                         return NULL;
1031         }
1032
1033         /* follow the chain of NDPs, looking for a match */
1034         while (ndpoffset) {
1035                 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
1036                 if  (ndp16->dwSignature == sign)
1037                         return ndp16;
1038                 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1039         }
1040
1041         /* align new NDP */
1042         if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1043                 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1044
1045         /* verify that there is room for the NDP and the datagram (reserve) */
1046         if ((ctx->tx_max - skb->len - reserve) < ctx->max_ndp_size)
1047                 return NULL;
1048
1049         /* link to it */
1050         if (ndp16)
1051                 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
1052         else
1053                 nth16->wNdpIndex = cpu_to_le16(skb->len);
1054
1055         /* push a new empty NDP */
1056         if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1057                 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, ctx->max_ndp_size);
1058         else
1059                 ndp16 = ctx->delayed_ndp16;
1060
1061         ndp16->dwSignature = sign;
1062         ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
1063         return ndp16;
1064 }
1065
1066 struct sk_buff *
1067 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
1068 {
1069         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1070         struct usb_cdc_ncm_nth16 *nth16;
1071         struct usb_cdc_ncm_ndp16 *ndp16;
1072         struct sk_buff *skb_out;
1073         u16 n = 0, index, ndplen;
1074         u8 ready2send = 0;
1075         u32 delayed_ndp_size;
1076         size_t padding_count;
1077
1078         /* When our NDP gets written in cdc_ncm_ndp(), then skb_out->len gets updated
1079          * accordingly. Otherwise, we should check here.
1080          */
1081         if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1082                 delayed_ndp_size = ALIGN(ctx->max_ndp_size, ctx->tx_ndp_modulus);
1083         else
1084                 delayed_ndp_size = 0;
1085
1086         /* if there is a remaining skb, it gets priority */
1087         if (skb != NULL) {
1088                 swap(skb, ctx->tx_rem_skb);
1089                 swap(sign, ctx->tx_rem_sign);
1090         } else {
1091                 ready2send = 1;
1092         }
1093
1094         /* check if we are resuming an OUT skb */
1095         skb_out = ctx->tx_curr_skb;
1096
1097         /* allocate a new OUT skb */
1098         if (!skb_out) {
1099                 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
1100                 if (skb_out == NULL) {
1101                         if (skb != NULL) {
1102                                 dev_kfree_skb_any(skb);
1103                                 dev->net->stats.tx_dropped++;
1104                         }
1105                         goto exit_no_skb;
1106                 }
1107                 /* fill out the initial 16-bit NTB header */
1108                 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
1109                 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1110                 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1111                 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
1112
1113                 /* count total number of frames in this NTB */
1114                 ctx->tx_curr_frame_num = 0;
1115
1116                 /* recent payload counter for this skb_out */
1117                 ctx->tx_curr_frame_payload = 0;
1118         }
1119
1120         for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1121                 /* send any remaining skb first */
1122                 if (skb == NULL) {
1123                         skb = ctx->tx_rem_skb;
1124                         sign = ctx->tx_rem_sign;
1125                         ctx->tx_rem_skb = NULL;
1126
1127                         /* check for end of skb */
1128                         if (skb == NULL)
1129                                 break;
1130                 }
1131
1132                 /* get the appropriate NDP for this skb */
1133                 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1134
1135                 /* align beginning of next frame */
1136                 cdc_ncm_align_tail(skb_out,  ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
1137
1138                 /* check if we had enough room left for both NDP and frame */
1139                 if (!ndp16 || skb_out->len + skb->len + delayed_ndp_size > ctx->tx_max) {
1140                         if (n == 0) {
1141                                 /* won't fit, MTU problem? */
1142                                 dev_kfree_skb_any(skb);
1143                                 skb = NULL;
1144                                 dev->net->stats.tx_dropped++;
1145                         } else {
1146                                 /* no room for skb - store for later */
1147                                 if (ctx->tx_rem_skb != NULL) {
1148                                         dev_kfree_skb_any(ctx->tx_rem_skb);
1149                                         dev->net->stats.tx_dropped++;
1150                                 }
1151                                 ctx->tx_rem_skb = skb;
1152                                 ctx->tx_rem_sign = sign;
1153                                 skb = NULL;
1154                                 ready2send = 1;
1155                                 ctx->tx_reason_ntb_full++;      /* count reason for transmitting */
1156                         }
1157                         break;
1158                 }
1159
1160                 /* calculate frame number withing this NDP */
1161                 ndplen = le16_to_cpu(ndp16->wLength);
1162                 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
1163
1164                 /* OK, add this skb */
1165                 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1166                 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1167                 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
1168                 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
1169                 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
1170                 dev_kfree_skb_any(skb);
1171                 skb = NULL;
1172
1173                 /* send now if this NDP is full */
1174                 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1175                         ready2send = 1;
1176                         ctx->tx_reason_ndp_full++;      /* count reason for transmitting */
1177                         break;
1178                 }
1179         }
1180
1181         /* free up any dangling skb */
1182         if (skb != NULL) {
1183                 dev_kfree_skb_any(skb);
1184                 skb = NULL;
1185                 dev->net->stats.tx_dropped++;
1186         }
1187
1188         ctx->tx_curr_frame_num = n;
1189
1190         if (n == 0) {
1191                 /* wait for more frames */
1192                 /* push variables */
1193                 ctx->tx_curr_skb = skb_out;
1194                 goto exit_no_skb;
1195
1196         } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1197                 /* wait for more frames */
1198                 /* push variables */
1199                 ctx->tx_curr_skb = skb_out;
1200                 /* set the pending count */
1201                 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1202                         ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1203                 goto exit_no_skb;
1204
1205         } else {
1206                 if (n == ctx->tx_max_datagrams)
1207                         ctx->tx_reason_max_datagram++;  /* count reason for transmitting */
1208                 /* frame goes out */
1209                 /* variables will be reset at next call */
1210         }
1211
1212         /* If requested, put NDP at end of frame. */
1213         if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1214                 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1215                 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_max - ctx->max_ndp_size);
1216                 nth16->wNdpIndex = cpu_to_le16(skb_out->len);
1217                 memcpy(skb_put(skb_out, ctx->max_ndp_size), ctx->delayed_ndp16, ctx->max_ndp_size);
1218
1219                 /* Zero out delayed NDP - signature checking will naturally fail. */
1220                 ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1221         }
1222
1223         /* If collected data size is less or equal ctx->min_tx_pkt
1224          * bytes, we send buffers as it is. If we get more data, it
1225          * would be more efficient for USB HS mobile device with DMA
1226          * engine to receive a full size NTB, than canceling DMA
1227          * transfer and receiving a short packet.
1228          *
1229          * This optimization support is pointless if we end up sending
1230          * a ZLP after full sized NTBs.
1231          */
1232         if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1233             skb_out->len > ctx->min_tx_pkt) {
1234                 padding_count = ctx->tx_max - skb_out->len;
1235                 memset(skb_put(skb_out, padding_count), 0, padding_count);
1236         } else if (skb_out->len < ctx->tx_max &&
1237                    (skb_out->len % dev->maxpacket) == 0) {
1238                 *skb_put(skb_out, 1) = 0;       /* force short packet */
1239         }
1240
1241         /* set final frame length */
1242         nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1243         nth16->wBlockLength = cpu_to_le16(skb_out->len);
1244
1245         /* return skb */
1246         ctx->tx_curr_skb = NULL;
1247
1248         /* keep private stats: framing overhead and number of NTBs */
1249         ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1250         ctx->tx_ntbs++;
1251
1252         /* usbnet will count all the framing overhead by default.
1253          * Adjust the stats so that the tx_bytes counter show real
1254          * payload data instead.
1255          */
1256         usbnet_set_skb_tx_stats(skb_out, n,
1257                                 (long)ctx->tx_curr_frame_payload - skb_out->len);
1258
1259         return skb_out;
1260
1261 exit_no_skb:
1262         /* Start timer, if there is a remaining non-empty skb */
1263         if (ctx->tx_curr_skb != NULL && n > 0)
1264                 cdc_ncm_tx_timeout_start(ctx);
1265         return NULL;
1266 }
1267 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1268
1269 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1270 {
1271         /* start timer, if not already started */
1272         if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1273                 hrtimer_start(&ctx->tx_timer,
1274                                 ktime_set(0, ctx->timer_interval),
1275                                 HRTIMER_MODE_REL);
1276 }
1277
1278 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1279 {
1280         struct cdc_ncm_ctx *ctx =
1281                         container_of(timer, struct cdc_ncm_ctx, tx_timer);
1282
1283         if (!atomic_read(&ctx->stop))
1284                 tasklet_schedule(&ctx->bh);
1285         return HRTIMER_NORESTART;
1286 }
1287
1288 static void cdc_ncm_txpath_bh(unsigned long param)
1289 {
1290         struct usbnet *dev = (struct usbnet *)param;
1291         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1292
1293         spin_lock_bh(&ctx->mtx);
1294         if (ctx->tx_timer_pending != 0) {
1295                 ctx->tx_timer_pending--;
1296                 cdc_ncm_tx_timeout_start(ctx);
1297                 spin_unlock_bh(&ctx->mtx);
1298         } else if (dev->net != NULL) {
1299                 ctx->tx_reason_timeout++;       /* count reason for transmitting */
1300                 spin_unlock_bh(&ctx->mtx);
1301                 netif_tx_lock_bh(dev->net);
1302                 usbnet_start_xmit(NULL, dev->net);
1303                 netif_tx_unlock_bh(dev->net);
1304         } else {
1305                 spin_unlock_bh(&ctx->mtx);
1306         }
1307 }
1308
1309 struct sk_buff *
1310 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1311 {
1312         struct sk_buff *skb_out;
1313         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1314
1315         /*
1316          * The Ethernet API we are using does not support transmitting
1317          * multiple Ethernet frames in a single call. This driver will
1318          * accumulate multiple Ethernet frames and send out a larger
1319          * USB frame when the USB buffer is full or when a single jiffies
1320          * timeout happens.
1321          */
1322         if (ctx == NULL)
1323                 goto error;
1324
1325         spin_lock_bh(&ctx->mtx);
1326         skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1327         spin_unlock_bh(&ctx->mtx);
1328         return skb_out;
1329
1330 error:
1331         if (skb != NULL)
1332                 dev_kfree_skb_any(skb);
1333
1334         return NULL;
1335 }
1336 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1337
1338 /* verify NTB header and return offset of first NDP, or negative error */
1339 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1340 {
1341         struct usbnet *dev = netdev_priv(skb_in->dev);
1342         struct usb_cdc_ncm_nth16 *nth16;
1343         int len;
1344         int ret = -EINVAL;
1345
1346         if (ctx == NULL)
1347                 goto error;
1348
1349         if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1350                                         sizeof(struct usb_cdc_ncm_ndp16))) {
1351                 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1352                 goto error;
1353         }
1354
1355         nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1356
1357         if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1358                 netif_dbg(dev, rx_err, dev->net,
1359                           "invalid NTH16 signature <%#010x>\n",
1360                           le32_to_cpu(nth16->dwSignature));
1361                 goto error;
1362         }
1363
1364         len = le16_to_cpu(nth16->wBlockLength);
1365         if (len > ctx->rx_max) {
1366                 netif_dbg(dev, rx_err, dev->net,
1367                           "unsupported NTB block length %u/%u\n", len,
1368                           ctx->rx_max);
1369                 goto error;
1370         }
1371
1372         if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1373             (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1374             !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1375                 netif_dbg(dev, rx_err, dev->net,
1376                           "sequence number glitch prev=%d curr=%d\n",
1377                           ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1378         }
1379         ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1380
1381         ret = le16_to_cpu(nth16->wNdpIndex);
1382 error:
1383         return ret;
1384 }
1385 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1386
1387 /* verify NDP header and return number of datagrams, or negative error */
1388 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1389 {
1390         struct usbnet *dev = netdev_priv(skb_in->dev);
1391         struct usb_cdc_ncm_ndp16 *ndp16;
1392         int ret = -EINVAL;
1393
1394         if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1395                 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset  <%u>\n",
1396                           ndpoffset);
1397                 goto error;
1398         }
1399         ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1400
1401         if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1402                 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1403                           le16_to_cpu(ndp16->wLength));
1404                 goto error;
1405         }
1406
1407         ret = ((le16_to_cpu(ndp16->wLength) -
1408                                         sizeof(struct usb_cdc_ncm_ndp16)) /
1409                                         sizeof(struct usb_cdc_ncm_dpe16));
1410         ret--; /* we process NDP entries except for the last one */
1411
1412         if ((sizeof(struct usb_cdc_ncm_ndp16) +
1413              ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1414                 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1415                 ret = -EINVAL;
1416         }
1417
1418 error:
1419         return ret;
1420 }
1421 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1422
1423 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1424 {
1425         struct sk_buff *skb;
1426         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1427         int len;
1428         int nframes;
1429         int x;
1430         int offset;
1431         struct usb_cdc_ncm_ndp16 *ndp16;
1432         struct usb_cdc_ncm_dpe16 *dpe16;
1433         int ndpoffset;
1434         int loopcount = 50; /* arbitrary max preventing infinite loop */
1435         u32 payload = 0;
1436
1437         ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1438         if (ndpoffset < 0)
1439                 goto error;
1440
1441 next_ndp:
1442         nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1443         if (nframes < 0)
1444                 goto error;
1445
1446         ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1447
1448         if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1449                 netif_dbg(dev, rx_err, dev->net,
1450                           "invalid DPT16 signature <%#010x>\n",
1451                           le32_to_cpu(ndp16->dwSignature));
1452                 goto err_ndp;
1453         }
1454         dpe16 = ndp16->dpe16;
1455
1456         for (x = 0; x < nframes; x++, dpe16++) {
1457                 offset = le16_to_cpu(dpe16->wDatagramIndex);
1458                 len = le16_to_cpu(dpe16->wDatagramLength);
1459
1460                 /*
1461                  * CDC NCM ch. 3.7
1462                  * All entries after first NULL entry are to be ignored
1463                  */
1464                 if ((offset == 0) || (len == 0)) {
1465                         if (!x)
1466                                 goto err_ndp; /* empty NTB */
1467                         break;
1468                 }
1469
1470                 /* sanity checking */
1471                 if (((offset + len) > skb_in->len) ||
1472                                 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1473                         netif_dbg(dev, rx_err, dev->net,
1474                                   "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1475                                   x, offset, len, skb_in);
1476                         if (!x)
1477                                 goto err_ndp;
1478                         break;
1479
1480                 } else {
1481                         /* create a fresh copy to reduce truesize */
1482                         skb = netdev_alloc_skb_ip_align(dev->net,  len);
1483                         if (!skb)
1484                                 goto error;
1485                         memcpy(skb_put(skb, len), skb_in->data + offset, len);
1486                         usbnet_skb_return(dev, skb);
1487                         payload += len; /* count payload bytes in this NTB */
1488                 }
1489         }
1490 err_ndp:
1491         /* are there more NDPs to process? */
1492         ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1493         if (ndpoffset && loopcount--)
1494                 goto next_ndp;
1495
1496         /* update stats */
1497         ctx->rx_overhead += skb_in->len - payload;
1498         ctx->rx_ntbs++;
1499
1500         return 1;
1501 error:
1502         return 0;
1503 }
1504 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1505
1506 static void
1507 cdc_ncm_speed_change(struct usbnet *dev,
1508                      struct usb_cdc_speed_change *data)
1509 {
1510         uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1511         uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1512
1513         /*
1514          * Currently the USB-NET API does not support reporting the actual
1515          * device speed. Do print it instead.
1516          */
1517         if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1518                 netif_info(dev, link, dev->net,
1519                            "%u mbit/s downlink %u mbit/s uplink\n",
1520                            (unsigned int)(rx_speed / 1000000U),
1521                            (unsigned int)(tx_speed / 1000000U));
1522         } else {
1523                 netif_info(dev, link, dev->net,
1524                            "%u kbit/s downlink %u kbit/s uplink\n",
1525                            (unsigned int)(rx_speed / 1000U),
1526                            (unsigned int)(tx_speed / 1000U));
1527         }
1528 }
1529
1530 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1531 {
1532         struct cdc_ncm_ctx *ctx;
1533         struct usb_cdc_notification *event;
1534
1535         ctx = (struct cdc_ncm_ctx *)dev->data[0];
1536
1537         if (urb->actual_length < sizeof(*event))
1538                 return;
1539
1540         /* test for split data in 8-byte chunks */
1541         if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1542                 cdc_ncm_speed_change(dev,
1543                       (struct usb_cdc_speed_change *)urb->transfer_buffer);
1544                 return;
1545         }
1546
1547         event = urb->transfer_buffer;
1548
1549         switch (event->bNotificationType) {
1550         case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1551                 /*
1552                  * According to the CDC NCM specification ch.7.1
1553                  * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1554                  * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1555                  */
1556                 netif_info(dev, link, dev->net,
1557                            "network connection: %sconnected\n",
1558                            !!event->wValue ? "" : "dis");
1559                 usbnet_link_change(dev, !!event->wValue, 0);
1560                 break;
1561
1562         case USB_CDC_NOTIFY_SPEED_CHANGE:
1563                 if (urb->actual_length < (sizeof(*event) +
1564                                         sizeof(struct usb_cdc_speed_change)))
1565                         set_bit(EVENT_STS_SPLIT, &dev->flags);
1566                 else
1567                         cdc_ncm_speed_change(dev,
1568                                              (struct usb_cdc_speed_change *)&event[1]);
1569                 break;
1570
1571         default:
1572                 dev_dbg(&dev->udev->dev,
1573                         "NCM: unexpected notification 0x%02x!\n",
1574                         event->bNotificationType);
1575                 break;
1576         }
1577 }
1578
1579 static const struct driver_info cdc_ncm_info = {
1580         .description = "CDC NCM",
1581         .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1582                         | FLAG_LINK_INTR,
1583         .bind = cdc_ncm_bind,
1584         .unbind = cdc_ncm_unbind,
1585         .manage_power = usbnet_manage_power,
1586         .status = cdc_ncm_status,
1587         .rx_fixup = cdc_ncm_rx_fixup,
1588         .tx_fixup = cdc_ncm_tx_fixup,
1589 };
1590
1591 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1592 static const struct driver_info wwan_info = {
1593         .description = "Mobile Broadband Network Device",
1594         .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1595                         | FLAG_LINK_INTR | FLAG_WWAN,
1596         .bind = cdc_ncm_bind,
1597         .unbind = cdc_ncm_unbind,
1598         .manage_power = usbnet_manage_power,
1599         .status = cdc_ncm_status,
1600         .rx_fixup = cdc_ncm_rx_fixup,
1601         .tx_fixup = cdc_ncm_tx_fixup,
1602 };
1603
1604 /* Same as wwan_info, but with FLAG_NOARP  */
1605 static const struct driver_info wwan_noarp_info = {
1606         .description = "Mobile Broadband Network Device (NO ARP)",
1607         .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1608                         | FLAG_LINK_INTR | FLAG_WWAN | FLAG_NOARP,
1609         .bind = cdc_ncm_bind,
1610         .unbind = cdc_ncm_unbind,
1611         .manage_power = usbnet_manage_power,
1612         .status = cdc_ncm_status,
1613         .rx_fixup = cdc_ncm_rx_fixup,
1614         .tx_fixup = cdc_ncm_tx_fixup,
1615 };
1616
1617 static const struct usb_device_id cdc_devs[] = {
1618         /* Ericsson MBM devices like F5521gw */
1619         { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1620                 | USB_DEVICE_ID_MATCH_VENDOR,
1621           .idVendor = 0x0bdb,
1622           .bInterfaceClass = USB_CLASS_COMM,
1623           .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1624           .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1625           .driver_info = (unsigned long) &wwan_info,
1626         },
1627
1628         /* DW5812 LTE Verizon Mobile Broadband Card
1629          * Unlike DW5550 this device requires FLAG_NOARP
1630          */
1631         { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bb,
1632                 USB_CLASS_COMM,
1633                 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1634           .driver_info = (unsigned long)&wwan_noarp_info,
1635         },
1636
1637         /* DW5813 LTE AT&T Mobile Broadband Card
1638          * Unlike DW5550 this device requires FLAG_NOARP
1639          */
1640         { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bc,
1641                 USB_CLASS_COMM,
1642                 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1643           .driver_info = (unsigned long)&wwan_noarp_info,
1644         },
1645
1646         /* Dell branded MBM devices like DW5550 */
1647         { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1648                 | USB_DEVICE_ID_MATCH_VENDOR,
1649           .idVendor = 0x413c,
1650           .bInterfaceClass = USB_CLASS_COMM,
1651           .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1652           .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1653           .driver_info = (unsigned long) &wwan_info,
1654         },
1655
1656         /* Toshiba branded MBM devices */
1657         { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1658                 | USB_DEVICE_ID_MATCH_VENDOR,
1659           .idVendor = 0x0930,
1660           .bInterfaceClass = USB_CLASS_COMM,
1661           .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1662           .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1663           .driver_info = (unsigned long) &wwan_info,
1664         },
1665
1666         /* tag Huawei devices as wwan */
1667         { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1668                                         USB_CLASS_COMM,
1669                                         USB_CDC_SUBCLASS_NCM,
1670                                         USB_CDC_PROTO_NONE),
1671           .driver_info = (unsigned long)&wwan_info,
1672         },
1673
1674         /* Infineon(now Intel) HSPA Modem platform */
1675         { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1676                 USB_CLASS_COMM,
1677                 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1678           .driver_info = (unsigned long)&wwan_noarp_info,
1679         },
1680
1681         /* Generic CDC-NCM devices */
1682         { USB_INTERFACE_INFO(USB_CLASS_COMM,
1683                 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1684                 .driver_info = (unsigned long)&cdc_ncm_info,
1685         },
1686         {
1687         },
1688 };
1689 MODULE_DEVICE_TABLE(usb, cdc_devs);
1690
1691 static struct usb_driver cdc_ncm_driver = {
1692         .name = "cdc_ncm",
1693         .id_table = cdc_devs,
1694         .probe = usbnet_probe,
1695         .disconnect = usbnet_disconnect,
1696         .suspend = usbnet_suspend,
1697         .resume = usbnet_resume,
1698         .reset_resume = usbnet_resume,
1699         .supports_autosuspend = 1,
1700         .disable_hub_initiated_lpm = 1,
1701 };
1702
1703 module_usb_driver(cdc_ncm_driver);
1704
1705 MODULE_AUTHOR("Hans Petter Selasky");
1706 MODULE_DESCRIPTION("USB CDC NCM host driver");
1707 MODULE_LICENSE("Dual BSD/GPL");