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