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