drivers/net/usb/cdc_ncm.c

   1 /*
   2  * cdc_ncm.c
   3  *
   4  * Copyright (C) ST-Ericsson 2010-2012
   5  * Contact: Alexey Orishko <alexey.orishko@stericsson.com>
   6  * Original author: Hans Petter Selasky <hans.petter.selasky@stericsson.com>
   7  *
   8  * USB Host Driver for Network Control Model (NCM)
   9  * http://www.usb.org/developers/devclass_docs/NCM10.zip
  10  *
  11  * The NCM encoding, decoding and initialization logic
  12  * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
  13  *
  14  * This software is available to you under a choice of one of two
  15  * licenses. You may choose this file to be licensed under the terms
  16  * of the GNU General Public License (GPL) Version 2 or the 2-clause
  17  * BSD license listed below:
  18  *
  19  * Redistribution and use in source and binary forms, with or without
  20  * modification, are permitted provided that the following conditions
  21  * are met:
  22  * 1. Redistributions of source code must retain the above copyright
  23  *    notice, this list of conditions and the following disclaimer.
  24  * 2. Redistributions in binary form must reproduce the above copyright
  25  *    notice, this list of conditions and the following disclaimer in the
  26  *    documentation and/or other materials provided with the distribution.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38  * SUCH DAMAGE.
  39  */
  40
  41 #include <linux/module.h>
  42 #include <linux/netdevice.h>
  43 #include <linux/ctype.h>
  44 #include <linux/ethtool.h>
  45 #include <linux/workqueue.h>
  46 #include <linux/mii.h>
  47 #include <linux/crc32.h>
  48 #include <linux/usb.h>
  49 #include <linux/hrtimer.h>
  50 #include <linux/atomic.h>
  51 #include <linux/usb/usbnet.h>
  52 #include <linux/usb/cdc.h>
  53 #include <linux/usb/cdc_ncm.h>
  54
  55 #if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
  56 static bool prefer_mbim = true;
  57 #else
  58 static bool prefer_mbim;
  59 #endif
  60 module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
  61 MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
  62
  63 static void cdc_ncm_txpath_bh(unsigned long param);
  64 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx);
  65 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *hr_timer);
  66 static struct usb_driver cdc_ncm_driver;
  67
  68 struct cdc_ncm_stats {
  69         char stat_string[ETH_GSTRING_LEN];
  70         int sizeof_stat;
  71         int stat_offset;
  72 };
  73
  74 #define CDC_NCM_STAT(str, m) { \
  75                 .stat_string = str, \
  76                 .sizeof_stat = sizeof(((struct cdc_ncm_ctx *)0)->m), \
  77                 .stat_offset = offsetof(struct cdc_ncm_ctx, m) }
  78 #define CDC_NCM_SIMPLE_STAT(m)  CDC_NCM_STAT(__stringify(m), m)
  79
  80 static const struct cdc_ncm_stats cdc_ncm_gstrings_stats[] = {
  81         CDC_NCM_SIMPLE_STAT(tx_reason_ntb_full),
  82         CDC_NCM_SIMPLE_STAT(tx_reason_ndp_full),
  83         CDC_NCM_SIMPLE_STAT(tx_reason_timeout),
  84         CDC_NCM_SIMPLE_STAT(tx_reason_max_datagram),
  85         CDC_NCM_SIMPLE_STAT(tx_overhead),
  86         CDC_NCM_SIMPLE_STAT(tx_ntbs),
  87         CDC_NCM_SIMPLE_STAT(rx_overhead),
  88         CDC_NCM_SIMPLE_STAT(rx_ntbs),
  89 };
  90
  91 static int cdc_ncm_get_sset_count(struct net_device __always_unused *netdev, int sset)
  92 {
  93         switch (sset) {
  94         case ETH_SS_STATS:
  95                 return ARRAY_SIZE(cdc_ncm_gstrings_stats);
  96         default:
  97                 return -EOPNOTSUPP;
  98         }
  99 }
 100
 101 static void cdc_ncm_get_ethtool_stats(struct net_device *netdev,
 102                                     struct ethtool_stats __always_unused *stats,
 103                                     u64 *data)
 104 {
 105         struct usbnet *dev = netdev_priv(netdev);
 106         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 107         int i;
 108         char *p = NULL;
 109
 110         for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
 111                 p = (char *)ctx + cdc_ncm_gstrings_stats[i].stat_offset;
 112                 data[i] = (cdc_ncm_gstrings_stats[i].sizeof_stat == sizeof(u64)) ? *(u64 *)p : *(u32 *)p;
 113         }
 114 }
 115
 116 static void cdc_ncm_get_strings(struct net_device __always_unused *netdev, u32 stringset, u8 *data)
 117 {
 118         u8 *p = data;
 119         int i;
 120
 121         switch (stringset) {
 122         case ETH_SS_STATS:
 123                 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
 124                         memcpy(p, cdc_ncm_gstrings_stats[i].stat_string, ETH_GSTRING_LEN);
 125                         p += ETH_GSTRING_LEN;
 126                 }
 127         }
 128 }
 129
 130 static int cdc_ncm_get_coalesce(struct net_device *netdev,
 131                                 struct ethtool_coalesce *ec)
 132 {
 133         struct usbnet *dev = netdev_priv(netdev);
 134         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 135
 136         /* assuming maximum sized dgrams and ignoring NDPs */
 137         ec->rx_max_coalesced_frames = ctx->rx_max / ctx->max_datagram_size;
 138         ec->tx_max_coalesced_frames = ctx->tx_max / ctx->max_datagram_size;
 139
 140         /* the timer will fire CDC_NCM_TIMER_PENDING_CNT times in a row */
 141         ec->tx_coalesce_usecs = (ctx->timer_interval * CDC_NCM_TIMER_PENDING_CNT) / NSEC_PER_USEC;
 142         return 0;
 143 }
 144
 145 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
 146
 147 static int cdc_ncm_set_coalesce(struct net_device *netdev,
 148                                 struct ethtool_coalesce *ec)
 149 {
 150         struct usbnet *dev = netdev_priv(netdev);
 151         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 152         u32 new_rx_max = ctx->rx_max;
 153         u32 new_tx_max = ctx->tx_max;
 154
 155         /* assuming maximum sized dgrams and a single NDP */
 156         if (ec->rx_max_coalesced_frames)
 157                 new_rx_max = ec->rx_max_coalesced_frames * ctx->max_datagram_size;
 158         if (ec->tx_max_coalesced_frames)
 159                 new_tx_max = ec->tx_max_coalesced_frames * ctx->max_datagram_size;
 160
 161         if (ec->tx_coalesce_usecs &&
 162             (ec->tx_coalesce_usecs < CDC_NCM_TIMER_INTERVAL_MIN * CDC_NCM_TIMER_PENDING_CNT ||
 163              ec->tx_coalesce_usecs > CDC_NCM_TIMER_INTERVAL_MAX * CDC_NCM_TIMER_PENDING_CNT))
 164                 return -EINVAL;
 165
 166         spin_lock_bh(&ctx->mtx);
 167         ctx->timer_interval = ec->tx_coalesce_usecs * NSEC_PER_USEC / CDC_NCM_TIMER_PENDING_CNT;
 168         if (!ctx->timer_interval)
 169                 ctx->tx_timer_pending = 0;
 170         spin_unlock_bh(&ctx->mtx);
 171
 172         /* inform device of new values */
 173         if (new_rx_max != ctx->rx_max || new_tx_max != ctx->tx_max)
 174                 cdc_ncm_update_rxtx_max(dev, new_rx_max, new_tx_max);
 175         return 0;
 176 }
 177
 178 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
 179         .get_settings      = usbnet_get_settings,
 180         .set_settings      = usbnet_set_settings,
 181         .get_link          = usbnet_get_link,
 182         .nway_reset        = usbnet_nway_reset,
 183         .get_drvinfo       = usbnet_get_drvinfo,
 184         .get_msglevel      = usbnet_get_msglevel,
 185         .set_msglevel      = usbnet_set_msglevel,
 186         .get_ts_info       = ethtool_op_get_ts_info,
 187         .get_sset_count    = cdc_ncm_get_sset_count,
 188         .get_strings       = cdc_ncm_get_strings,
 189         .get_ethtool_stats = cdc_ncm_get_ethtool_stats,
 190         .get_coalesce      = cdc_ncm_get_coalesce,
 191         .set_coalesce      = cdc_ncm_set_coalesce,
 192 };
 193
 194 /* handle rx_max and tx_max changes */
 195 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
 196 {
 197         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 198         u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
 199         u32 val, max, min;
 200
 201         /* clamp new_rx to sane values */
 202         min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
 203         max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
 204
 205         /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
 206         if (max < min) {
 207                 dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
 208                          le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
 209                 max = min;
 210         }
 211
 212         val = clamp_t(u32, new_rx, min, max);
 213         if (val != new_rx) {
 214                 dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range. Using %u\n",
 215                         min, max, val);
 216         }
 217
 218         /* usbnet use these values for sizing rx queues */
 219         dev->rx_urb_size = val;
 220
 221         /* inform device about NTB input size changes */
 222         if (val != ctx->rx_max) {
 223                 __le32 dwNtbInMaxSize = cpu_to_le32(val);
 224
 225                 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
 226
 227                 /* need to unlink rx urbs before increasing buffer size */
 228                 if (netif_running(dev->net) && dev->rx_urb_size > ctx->rx_max)
 229                         usbnet_unlink_rx_urbs(dev);
 230
 231                 /* tell device to use new size */
 232                 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
 233                                      USB_TYPE_CLASS | USB_DIR_OUT
 234                                      | USB_RECIP_INTERFACE,
 235                                      0, iface_no, &dwNtbInMaxSize, 4) < 0)
 236                         dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
 237                 else
 238                         ctx->rx_max = val;
 239         }
 240
 241         /* clamp new_tx to sane values */
 242         min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
 243         max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
 244
 245         /* some devices set dwNtbOutMaxSize too low for the above default */
 246         min = min(min, max);
 247
 248         val = clamp_t(u32, new_tx, min, max);
 249         if (val != new_tx) {
 250                 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range. Using %u\n",
 251                         min, max, val);
 252         }
 253         if (val != ctx->tx_max)
 254                 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
 255
 256         /* Adding a pad byte here if necessary simplifies the handling
 257          * in cdc_ncm_fill_tx_frame, making tx_max always represent
 258          * the real skb max size.
 259          *
 260          * We cannot use dev->maxpacket here because this is called from
 261          * .bind which is called before usbnet sets up dev->maxpacket
 262          */
 263         if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
 264             val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
 265                 val++;
 266
 267         /* we might need to flush any pending tx buffers if running */
 268         if (netif_running(dev->net) && val > ctx->tx_max) {
 269                 netif_tx_lock_bh(dev->net);
 270                 usbnet_start_xmit(NULL, dev->net);
 271                 ctx->tx_max = val;
 272                 netif_tx_unlock_bh(dev->net);
 273         } else {
 274                 ctx->tx_max = val;
 275         }
 276
 277         dev->hard_mtu = ctx->tx_max;
 278
 279         /* max qlen depend on hard_mtu and rx_urb_size */
 280         usbnet_update_max_qlen(dev);
 281
 282         /* never pad more than 3 full USB packets per transfer */
 283         ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
 284                                   CDC_NCM_MIN_TX_PKT, ctx->tx_max);
 285 }
 286
 287 /* helpers for NCM and MBIM differences */
 288 static u8 cdc_ncm_flags(struct usbnet *dev)
 289 {
 290         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 291
 292         if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
 293                 return ctx->mbim_desc->bmNetworkCapabilities;
 294         if (ctx->func_desc)
 295                 return ctx->func_desc->bmNetworkCapabilities;
 296         return 0;
 297 }
 298
 299 static int cdc_ncm_eth_hlen(struct usbnet *dev)
 300 {
 301         if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
 302                 return 0;
 303         return ETH_HLEN;
 304 }
 305
 306 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
 307 {
 308         if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
 309                 return CDC_MBIM_MIN_DATAGRAM_SIZE;
 310         return CDC_NCM_MIN_DATAGRAM_SIZE;
 311 }
 312
 313 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
 314 {
 315         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 316
 317         if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
 318                 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
 319         if (ctx->ether_desc)
 320                 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
 321         return CDC_NCM_MAX_DATAGRAM_SIZE;
 322 }
 323
 324 /* initial one-time device setup.  MUST be called with the data interface
 325  * in altsetting 0
 326  */
 327 static int cdc_ncm_init(struct usbnet *dev)
 328 {
 329         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 330         u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
 331         int err;
 332
 333         err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
 334                               USB_TYPE_CLASS | USB_DIR_IN
 335                               |USB_RECIP_INTERFACE,
 336                               0, iface_no, &ctx->ncm_parm,
 337                               sizeof(ctx->ncm_parm));
 338         if (err < 0) {
 339                 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
 340                 return err; /* GET_NTB_PARAMETERS is required */
 341         }
 342
 343         /* set CRC Mode */
 344         if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
 345                 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
 346                 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
 347                                        USB_TYPE_CLASS | USB_DIR_OUT
 348                                        | USB_RECIP_INTERFACE,
 349                                        USB_CDC_NCM_CRC_NOT_APPENDED,
 350                                        iface_no, NULL, 0);
 351                 if (err < 0)
 352                         dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
 353         }
 354
 355         /* set NTB format, if both formats are supported.
 356          *
 357          * "The host shall only send this command while the NCM Data
 358          *  Interface is in alternate setting 0."
 359          */
 360         if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) & USB_CDC_NCM_NTH32_SIGN) {
 361                 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
 362                 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
 363                                        USB_TYPE_CLASS | USB_DIR_OUT
 364                                        | USB_RECIP_INTERFACE,
 365                                        USB_CDC_NCM_NTB16_FORMAT,
 366                                        iface_no, NULL, 0);
 367                 if (err < 0)
 368                         dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
 369         }
 370
 371         /* set initial device values */
 372         ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
 373         ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
 374         ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
 375         ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
 376         ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
 377         /* devices prior to NCM Errata shall set this field to zero */
 378         ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
 379
 380         dev_dbg(&dev->intf->dev,
 381                 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
 382                 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
 383                 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
 384
 385         /* max count of tx datagrams */
 386         if ((ctx->tx_max_datagrams == 0) ||
 387                         (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
 388                 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
 389
 390         /* set up maximum NDP size */
 391         ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
 392
 393         /* initial coalescing timer interval */
 394         ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
 395
 396         return 0;
 397 }
 398
 399 /* set a new max datagram size */
 400 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
 401 {
 402         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 403         u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
 404         __le16 max_datagram_size;
 405         u16 mbim_mtu;
 406         int err;
 407
 408         /* set default based on descriptors */
 409         ctx->max_datagram_size = clamp_t(u32, new_size,
 410                                          cdc_ncm_min_dgram_size(dev),
 411                                          CDC_NCM_MAX_DATAGRAM_SIZE);
 412
 413         /* inform the device about the selected Max Datagram Size? */
 414         if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
 415                 goto out;
 416
 417         /* read current mtu value from device */
 418         err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
 419                               USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
 420                               0, iface_no, &max_datagram_size, 2);
 421         if (err < 0) {
 422                 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
 423                 goto out;
 424         }
 425
 426         if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
 427                 goto out;
 428
 429         max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
 430         err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
 431                                USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
 432                                0, iface_no, &max_datagram_size, 2);
 433         if (err < 0)
 434                 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
 435
 436 out:
 437         /* set MTU to max supported by the device if necessary */
 438         dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
 439
 440         /* do not exceed operater preferred MTU */
 441         if (ctx->mbim_extended_desc) {
 442                 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
 443                 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
 444                         dev->net->mtu = mbim_mtu;
 445         }
 446 }
 447
 448 static void cdc_ncm_fix_modulus(struct usbnet *dev)
 449 {
 450         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 451         u32 val;
 452
 453         /*
 454          * verify that the structure alignment is:
 455          * - power of two
 456          * - not greater than the maximum transmit length
 457          * - not less than four bytes
 458          */
 459         val = ctx->tx_ndp_modulus;
 460
 461         if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
 462             (val != ((-val) & val)) || (val >= ctx->tx_max)) {
 463                 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
 464                 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
 465         }
 466
 467         /*
 468          * verify that the payload alignment is:
 469          * - power of two
 470          * - not greater than the maximum transmit length
 471          * - not less than four bytes
 472          */
 473         val = ctx->tx_modulus;
 474
 475         if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
 476             (val != ((-val) & val)) || (val >= ctx->tx_max)) {
 477                 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
 478                 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
 479         }
 480
 481         /* verify the payload remainder */
 482         if (ctx->tx_remainder >= ctx->tx_modulus) {
 483                 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
 484                 ctx->tx_remainder = 0;
 485         }
 486
 487         /* adjust TX-remainder according to NCM specification. */
 488         ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
 489                              (ctx->tx_modulus - 1));
 490 }
 491
 492 static int cdc_ncm_setup(struct usbnet *dev)
 493 {
 494         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 495         u32 def_rx, def_tx;
 496
 497         /* be conservative when selecting intial buffer size to
 498          * increase the number of hosts this will work for
 499          */
 500         def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
 501                        le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
 502         def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
 503                        le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
 504
 505         /* clamp rx_max and tx_max and inform device */
 506         cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
 507
 508         /* sanitize the modulus and remainder values */
 509         cdc_ncm_fix_modulus(dev);
 510
 511         /* set max datagram size */
 512         cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
 513         return 0;
 514 }
 515
 516 static void
 517 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
 518 {
 519         struct usb_host_endpoint *e, *in = NULL, *out = NULL;
 520         u8 ep;
 521
 522         for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
 523
 524                 e = intf->cur_altsetting->endpoint + ep;
 525                 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
 526                 case USB_ENDPOINT_XFER_INT:
 527                         if (usb_endpoint_dir_in(&e->desc)) {
 528                                 if (!dev->status)
 529                                         dev->status = e;
 530                         }
 531                         break;
 532
 533                 case USB_ENDPOINT_XFER_BULK:
 534                         if (usb_endpoint_dir_in(&e->desc)) {
 535                                 if (!in)
 536                                         in = e;
 537                         } else {
 538                                 if (!out)
 539                                         out = e;
 540                         }
 541                         break;
 542
 543                 default:
 544                         break;
 545                 }
 546         }
 547         if (in && !dev->in)
 548                 dev->in = usb_rcvbulkpipe(dev->udev,
 549                                           in->desc.bEndpointAddress &
 550                                           USB_ENDPOINT_NUMBER_MASK);
 551         if (out && !dev->out)
 552                 dev->out = usb_sndbulkpipe(dev->udev,
 553                                            out->desc.bEndpointAddress &
 554                                            USB_ENDPOINT_NUMBER_MASK);
 555 }
 556
 557 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
 558 {
 559         if (ctx == NULL)
 560                 return;
 561
 562         if (ctx->tx_rem_skb != NULL) {
 563                 dev_kfree_skb_any(ctx->tx_rem_skb);
 564                 ctx->tx_rem_skb = NULL;
 565         }
 566
 567         if (ctx->tx_curr_skb != NULL) {
 568                 dev_kfree_skb_any(ctx->tx_curr_skb);
 569                 ctx->tx_curr_skb = NULL;
 570         }
 571
 572         kfree(ctx);
 573 }
 574
 575 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting)
 576 {
 577         const struct usb_cdc_union_desc *union_desc = NULL;
 578         struct cdc_ncm_ctx *ctx;
 579         struct usb_driver *driver;
 580         u8 *buf;
 581         int len;
 582         int temp;
 583         u8 iface_no;
 584
 585         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
 586         if (!ctx)
 587                 return -ENOMEM;
 588
 589         hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
 590         ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
 591         ctx->bh.data = (unsigned long)dev;
 592         ctx->bh.func = cdc_ncm_txpath_bh;
 593         atomic_set(&ctx->stop, 0);
 594         spin_lock_init(&ctx->mtx);
 595
 596         /* store ctx pointer in device data field */
 597         dev->data[0] = (unsigned long)ctx;
 598
 599         /* only the control interface can be successfully probed */
 600         ctx->control = intf;
 601
 602         /* get some pointers */
 603         driver = driver_of(intf);
 604         buf = intf->cur_altsetting->extra;
 605         len = intf->cur_altsetting->extralen;
 606
 607         /* parse through descriptors associated with control interface */
 608         while ((len > 0) && (buf[0] > 2) && (buf[0] <= len)) {
 609
 610                 if (buf[1] != USB_DT_CS_INTERFACE)
 611                         goto advance;
 612
 613                 switch (buf[2]) {
 614                 case USB_CDC_UNION_TYPE:
 615                         if (buf[0] < sizeof(*union_desc))
 616                                 break;
 617
 618                         union_desc = (const struct usb_cdc_union_desc *)buf;
 619                         /* the master must be the interface we are probing */
 620                         if (intf->cur_altsetting->desc.bInterfaceNumber !=
 621                             union_desc->bMasterInterface0) {
 622                                 dev_dbg(&intf->dev, "bogus CDC Union\n");
 623                                 goto error;
 624                         }
 625                         ctx->data = usb_ifnum_to_if(dev->udev,
 626                                                     union_desc->bSlaveInterface0);
 627                         break;
 628
 629                 case USB_CDC_ETHERNET_TYPE:
 630                         if (buf[0] < sizeof(*(ctx->ether_desc)))
 631                                 break;
 632
 633                         ctx->ether_desc =
 634                                         (const struct usb_cdc_ether_desc *)buf;
 635                         break;
 636
 637                 case USB_CDC_NCM_TYPE:
 638                         if (buf[0] < sizeof(*(ctx->func_desc)))
 639                                 break;
 640
 641                         ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
 642                         break;
 643
 644                 case USB_CDC_MBIM_TYPE:
 645                         if (buf[0] < sizeof(*(ctx->mbim_desc)))
 646                                 break;
 647
 648                         ctx->mbim_desc = (const struct usb_cdc_mbim_desc *)buf;
 649                         break;
 650
 651                 case USB_CDC_MBIM_EXTENDED_TYPE:
 652                         if (buf[0] < sizeof(*(ctx->mbim_extended_desc)))
 653                                 break;
 654
 655                         ctx->mbim_extended_desc =
 656                                 (const struct usb_cdc_mbim_extended_desc *)buf;
 657                         break;
 658
 659                 default:
 660                         break;
 661                 }
 662 advance:
 663                 /* advance to next descriptor */
 664                 temp = buf[0];
 665                 buf += temp;
 666                 len -= temp;
 667         }
 668
 669         /* some buggy devices have an IAD but no CDC Union */
 670         if (!union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
 671                 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
 672                 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
 673         }
 674
 675         /* check if we got everything */
 676         if (!ctx->data) {
 677                 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
 678                 goto error;
 679         }
 680         if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
 681                 if (!ctx->mbim_desc) {
 682                         dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
 683                         goto error;
 684                 }
 685         } else {
 686                 if (!ctx->ether_desc || !ctx->func_desc) {
 687                         dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
 688                         goto error;
 689                 }
 690         }
 691
 692         /* claim data interface, if different from control */
 693         if (ctx->data != ctx->control) {
 694                 temp = usb_driver_claim_interface(driver, ctx->data, dev);
 695                 if (temp) {
 696                         dev_dbg(&intf->dev, "failed to claim data intf\n");
 697                         goto error;
 698                 }
 699         }
 700
 701         iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
 702
 703         /* reset data interface */
 704         temp = usb_set_interface(dev->udev, iface_no, 0);
 705         if (temp) {
 706                 dev_dbg(&intf->dev, "set interface failed\n");
 707                 goto error2;
 708         }
 709
 710         /* initialize basic device settings */
 711         if (cdc_ncm_init(dev))
 712                 goto error2;
 713
 714         /* configure data interface */
 715         temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
 716         if (temp) {
 717                 dev_dbg(&intf->dev, "set interface failed\n");
 718                 goto error2;
 719         }
 720
 721         cdc_ncm_find_endpoints(dev, ctx->data);
 722         cdc_ncm_find_endpoints(dev, ctx->control);
 723         if (!dev->in || !dev->out || !dev->status) {
 724                 dev_dbg(&intf->dev, "failed to collect endpoints\n");
 725                 goto error2;
 726         }
 727
 728         usb_set_intfdata(ctx->data, dev);
 729         usb_set_intfdata(ctx->control, dev);
 730
 731         if (ctx->ether_desc) {
 732                 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
 733                 if (temp) {
 734                         dev_dbg(&intf->dev, "failed to get mac address\n");
 735                         goto error2;
 736                 }
 737                 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
 738         }
 739
 740         /* finish setting up the device specific data */
 741         cdc_ncm_setup(dev);
 742
 743         /* override ethtool_ops */
 744         dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
 745
 746         return 0;
 747
 748 error2:
 749         usb_set_intfdata(ctx->control, NULL);
 750         usb_set_intfdata(ctx->data, NULL);
 751         if (ctx->data != ctx->control)
 752                 usb_driver_release_interface(driver, ctx->data);
 753 error:
 754         cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
 755         dev->data[0] = 0;
 756         dev_info(&intf->dev, "bind() failure\n");
 757         return -ENODEV;
 758 }
 759 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
 760
 761 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
 762 {
 763         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 764         struct usb_driver *driver = driver_of(intf);
 765
 766         if (ctx == NULL)
 767                 return;         /* no setup */
 768
 769         atomic_set(&ctx->stop, 1);
 770
 771         if (hrtimer_active(&ctx->tx_timer))
 772                 hrtimer_cancel(&ctx->tx_timer);
 773
 774         tasklet_kill(&ctx->bh);
 775
 776         /* handle devices with combined control and data interface */
 777         if (ctx->control == ctx->data)
 778                 ctx->data = NULL;
 779
 780         /* disconnect master --> disconnect slave */
 781         if (intf == ctx->control && ctx->data) {
 782                 usb_set_intfdata(ctx->data, NULL);
 783                 usb_driver_release_interface(driver, ctx->data);
 784                 ctx->data = NULL;
 785
 786         } else if (intf == ctx->data && ctx->control) {
 787                 usb_set_intfdata(ctx->control, NULL);
 788                 usb_driver_release_interface(driver, ctx->control);
 789                 ctx->control = NULL;
 790         }
 791
 792         usb_set_intfdata(intf, NULL);
 793         cdc_ncm_free(ctx);
 794 }
 795 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
 796
 797 /* Return the number of the MBIM control interface altsetting iff it
 798  * is preferred and available,
 799  */
 800 u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
 801 {
 802         struct usb_host_interface *alt;
 803
 804         /* The MBIM spec defines a NCM compatible default altsetting,
 805          * which we may have matched:
 806          *
 807          *  "Functions that implement both NCM 1.0 and MBIM (an
 808          *   “NCM/MBIM function”) according to this recommendation
 809          *   shall provide two alternate settings for the
 810          *   Communication Interface.  Alternate setting 0, and the
 811          *   associated class and endpoint descriptors, shall be
 812          *   constructed according to the rules given for the
 813          *   Communication Interface in section 5 of [USBNCM10].
 814          *   Alternate setting 1, and the associated class and
 815          *   endpoint descriptors, shall be constructed according to
 816          *   the rules given in section 6 (USB Device Model) of this
 817          *   specification."
 818          */
 819         if (intf->num_altsetting < 2)
 820                 return intf->cur_altsetting->desc.bAlternateSetting;
 821
 822         if (prefer_mbim) {
 823                 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
 824                 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
 825                         return CDC_NCM_COMM_ALTSETTING_MBIM;
 826         }
 827         return CDC_NCM_COMM_ALTSETTING_NCM;
 828 }
 829 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
 830
 831 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
 832 {
 833         int ret;
 834
 835         /* MBIM backwards compatible function? */
 836         if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
 837                 return -ENODEV;
 838
 839         /* The NCM data altsetting is fixed */
 840         ret = cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM);
 841
 842         /*
 843          * We should get an event when network connection is "connected" or
 844          * "disconnected". Set network connection in "disconnected" state
 845          * (carrier is OFF) during attach, so the IP network stack does not
 846          * start IPv6 negotiation and more.
 847          */
 848         usbnet_link_change(dev, 0, 0);
 849         return ret;
 850 }
 851
 852 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
 853 {
 854         size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
 855
 856         if (skb->len + align > max)
 857                 align = max - skb->len;
 858         if (align && skb_tailroom(skb) >= align)
 859                 memset(skb_put(skb, align), 0, align);
 860 }
 861
 862 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
 863  * allocating a new one within skb
 864  */
 865 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
 866 {
 867         struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
 868         struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
 869         size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
 870
 871         /* follow the chain of NDPs, looking for a match */
 872         while (ndpoffset) {
 873                 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
 874                 if  (ndp16->dwSignature == sign)
 875                         return ndp16;
 876                 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
 877         }
 878
 879         /* align new NDP */
 880         cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
 881
 882         /* verify that there is room for the NDP and the datagram (reserve) */
 883         if ((ctx->tx_max - skb->len - reserve) < ctx->max_ndp_size)
 884                 return NULL;
 885
 886         /* link to it */
 887         if (ndp16)
 888                 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
 889         else
 890                 nth16->wNdpIndex = cpu_to_le16(skb->len);
 891
 892         /* push a new empty NDP */
 893         ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, ctx->max_ndp_size);
 894         ndp16->dwSignature = sign;
 895         ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
 896         return ndp16;
 897 }
 898
 899 struct sk_buff *
 900 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
 901 {
 902         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
 903         struct usb_cdc_ncm_nth16 *nth16;
 904         struct usb_cdc_ncm_ndp16 *ndp16;
 905         struct sk_buff *skb_out;
 906         u16 n = 0, index, ndplen;
 907         u8 ready2send = 0;
 908
 909         /* if there is a remaining skb, it gets priority */
 910         if (skb != NULL) {
 911                 swap(skb, ctx->tx_rem_skb);
 912                 swap(sign, ctx->tx_rem_sign);
 913         } else {
 914                 ready2send = 1;
 915         }
 916
 917         /* check if we are resuming an OUT skb */
 918         skb_out = ctx->tx_curr_skb;
 919
 920         /* allocate a new OUT skb */
 921         if (!skb_out) {
 922                 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
 923                 if (skb_out == NULL) {
 924                         if (skb != NULL) {
 925                                 dev_kfree_skb_any(skb);
 926                                 dev->net->stats.tx_dropped++;
 927                         }
 928                         goto exit_no_skb;
 929                 }
 930                 /* fill out the initial 16-bit NTB header */
 931                 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
 932                 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
 933                 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
 934                 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
 935
 936                 /* count total number of frames in this NTB */
 937                 ctx->tx_curr_frame_num = 0;
 938
 939                 /* recent payload counter for this skb_out */
 940                 ctx->tx_curr_frame_payload = 0;
 941         }
 942
 943         for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
 944                 /* send any remaining skb first */
 945                 if (skb == NULL) {
 946                         skb = ctx->tx_rem_skb;
 947                         sign = ctx->tx_rem_sign;
 948                         ctx->tx_rem_skb = NULL;
 949
 950                         /* check for end of skb */
 951                         if (skb == NULL)
 952                                 break;
 953                 }
 954
 955                 /* get the appropriate NDP for this skb */
 956                 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
 957
 958                 /* align beginning of next frame */
 959                 cdc_ncm_align_tail(skb_out,  ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
 960
 961                 /* check if we had enough room left for both NDP and frame */
 962                 if (!ndp16 || skb_out->len + skb->len > ctx->tx_max) {
 963                         if (n == 0) {
 964                                 /* won't fit, MTU problem? */
 965                                 dev_kfree_skb_any(skb);
 966                                 skb = NULL;
 967                                 dev->net->stats.tx_dropped++;
 968                         } else {
 969                                 /* no room for skb - store for later */
 970                                 if (ctx->tx_rem_skb != NULL) {
 971                                         dev_kfree_skb_any(ctx->tx_rem_skb);
 972                                         dev->net->stats.tx_dropped++;
 973                                 }
 974                                 ctx->tx_rem_skb = skb;
 975                                 ctx->tx_rem_sign = sign;
 976                                 skb = NULL;
 977                                 ready2send = 1;
 978                                 ctx->tx_reason_ntb_full++;      /* count reason for transmitting */
 979                         }
 980                         break;
 981                 }
 982
 983                 /* calculate frame number withing this NDP */
 984                 ndplen = le16_to_cpu(ndp16->wLength);
 985                 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
 986
 987                 /* OK, add this skb */
 988                 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
 989                 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
 990                 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
 991                 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
 992                 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
 993                 dev_kfree_skb_any(skb);
 994                 skb = NULL;
 995
 996                 /* send now if this NDP is full */
 997                 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
 998                         ready2send = 1;
 999                         ctx->tx_reason_ndp_full++;      /* count reason for transmitting */
1000                         break;
1001                 }
1002         }
1003
1004         /* free up any dangling skb */
1005         if (skb != NULL) {
1006                 dev_kfree_skb_any(skb);
1007                 skb = NULL;
1008                 dev->net->stats.tx_dropped++;
1009         }
1010
1011         ctx->tx_curr_frame_num = n;
1012
1013         if (n == 0) {
1014                 /* wait for more frames */
1015                 /* push variables */
1016                 ctx->tx_curr_skb = skb_out;
1017                 goto exit_no_skb;
1018
1019         } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1020                 /* wait for more frames */
1021                 /* push variables */
1022                 ctx->tx_curr_skb = skb_out;
1023                 /* set the pending count */
1024                 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1025                         ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1026                 goto exit_no_skb;
1027
1028         } else {
1029                 if (n == ctx->tx_max_datagrams)
1030                         ctx->tx_reason_max_datagram++;  /* count reason for transmitting */
1031                 /* frame goes out */
1032                 /* variables will be reset at next call */
1033         }
1034
1035         /* If collected data size is less or equal ctx->min_tx_pkt
1036          * bytes, we send buffers as it is. If we get more data, it
1037          * would be more efficient for USB HS mobile device with DMA
1038          * engine to receive a full size NTB, than canceling DMA
1039          * transfer and receiving a short packet.
1040          *
1041          * This optimization support is pointless if we end up sending
1042          * a ZLP after full sized NTBs.
1043          */
1044         if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1045             skb_out->len > ctx->min_tx_pkt)
1046                 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
1047                        ctx->tx_max - skb_out->len);
1048         else if (skb_out->len < ctx->tx_max && (skb_out->len % dev->maxpacket) == 0)
1049                 *skb_put(skb_out, 1) = 0;       /* force short packet */
1050
1051         /* set final frame length */
1052         nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1053         nth16->wBlockLength = cpu_to_le16(skb_out->len);
1054
1055         /* return skb */
1056         ctx->tx_curr_skb = NULL;
1057         dev->net->stats.tx_packets += ctx->tx_curr_frame_num;
1058
1059         /* keep private stats: framing overhead and number of NTBs */
1060         ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1061         ctx->tx_ntbs++;
1062
1063         /* usbnet has already counted all the framing overhead.
1064          * Adjust the stats so that the tx_bytes counter show real
1065          * payload data instead.
1066          */
1067         dev->net->stats.tx_bytes -= skb_out->len - ctx->tx_curr_frame_payload;
1068
1069         return skb_out;
1070
1071 exit_no_skb:
1072         /* Start timer, if there is a remaining skb */
1073         if (ctx->tx_curr_skb != NULL)
1074                 cdc_ncm_tx_timeout_start(ctx);
1075         return NULL;
1076 }
1077 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1078
1079 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1080 {
1081         /* start timer, if not already started */
1082         if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1083                 hrtimer_start(&ctx->tx_timer,
1084                                 ktime_set(0, ctx->timer_interval),
1085                                 HRTIMER_MODE_REL);
1086 }
1087
1088 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1089 {
1090         struct cdc_ncm_ctx *ctx =
1091                         container_of(timer, struct cdc_ncm_ctx, tx_timer);
1092
1093         if (!atomic_read(&ctx->stop))
1094                 tasklet_schedule(&ctx->bh);
1095         return HRTIMER_NORESTART;
1096 }
1097
1098 static void cdc_ncm_txpath_bh(unsigned long param)
1099 {
1100         struct usbnet *dev = (struct usbnet *)param;
1101         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1102
1103         spin_lock_bh(&ctx->mtx);
1104         if (ctx->tx_timer_pending != 0) {
1105                 ctx->tx_timer_pending--;
1106                 cdc_ncm_tx_timeout_start(ctx);
1107                 spin_unlock_bh(&ctx->mtx);
1108         } else if (dev->net != NULL) {
1109                 ctx->tx_reason_timeout++;       /* count reason for transmitting */
1110                 spin_unlock_bh(&ctx->mtx);
1111                 netif_tx_lock_bh(dev->net);
1112                 usbnet_start_xmit(NULL, dev->net);
1113                 netif_tx_unlock_bh(dev->net);
1114         } else {
1115                 spin_unlock_bh(&ctx->mtx);
1116         }
1117 }
1118
1119 struct sk_buff *
1120 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1121 {
1122         struct sk_buff *skb_out;
1123         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1124
1125         /*
1126          * The Ethernet API we are using does not support transmitting
1127          * multiple Ethernet frames in a single call. This driver will
1128          * accumulate multiple Ethernet frames and send out a larger
1129          * USB frame when the USB buffer is full or when a single jiffies
1130          * timeout happens.
1131          */
1132         if (ctx == NULL)
1133                 goto error;
1134
1135         spin_lock_bh(&ctx->mtx);
1136         skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1137         spin_unlock_bh(&ctx->mtx);
1138         return skb_out;
1139
1140 error:
1141         if (skb != NULL)
1142                 dev_kfree_skb_any(skb);
1143
1144         return NULL;
1145 }
1146 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1147
1148 /* verify NTB header and return offset of first NDP, or negative error */
1149 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1150 {
1151         struct usbnet *dev = netdev_priv(skb_in->dev);
1152         struct usb_cdc_ncm_nth16 *nth16;
1153         int len;
1154         int ret = -EINVAL;
1155
1156         if (ctx == NULL)
1157                 goto error;
1158
1159         if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1160                                         sizeof(struct usb_cdc_ncm_ndp16))) {
1161                 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1162                 goto error;
1163         }
1164
1165         nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1166
1167         if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1168                 netif_dbg(dev, rx_err, dev->net,
1169                           "invalid NTH16 signature <%#010x>\n",
1170                           le32_to_cpu(nth16->dwSignature));
1171                 goto error;
1172         }
1173
1174         len = le16_to_cpu(nth16->wBlockLength);
1175         if (len > ctx->rx_max) {
1176                 netif_dbg(dev, rx_err, dev->net,
1177                           "unsupported NTB block length %u/%u\n", len,
1178                           ctx->rx_max);
1179                 goto error;
1180         }
1181
1182         if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1183             (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1184             !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1185                 netif_dbg(dev, rx_err, dev->net,
1186                           "sequence number glitch prev=%d curr=%d\n",
1187                           ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1188         }
1189         ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1190
1191         ret = le16_to_cpu(nth16->wNdpIndex);
1192 error:
1193         return ret;
1194 }
1195 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1196
1197 /* verify NDP header and return number of datagrams, or negative error */
1198 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1199 {
1200         struct usbnet *dev = netdev_priv(skb_in->dev);
1201         struct usb_cdc_ncm_ndp16 *ndp16;
1202         int ret = -EINVAL;
1203
1204         if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1205                 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset  <%u>\n",
1206                           ndpoffset);
1207                 goto error;
1208         }
1209         ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1210
1211         if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1212                 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1213                           le16_to_cpu(ndp16->wLength));
1214                 goto error;
1215         }
1216
1217         ret = ((le16_to_cpu(ndp16->wLength) -
1218                                         sizeof(struct usb_cdc_ncm_ndp16)) /
1219                                         sizeof(struct usb_cdc_ncm_dpe16));
1220         ret--; /* we process NDP entries except for the last one */
1221
1222         if ((sizeof(struct usb_cdc_ncm_ndp16) +
1223              ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1224                 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1225                 ret = -EINVAL;
1226         }
1227
1228 error:
1229         return ret;
1230 }
1231 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1232
1233 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1234 {
1235         struct sk_buff *skb;
1236         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1237         int len;
1238         int nframes;
1239         int x;
1240         int offset;
1241         struct usb_cdc_ncm_ndp16 *ndp16;
1242         struct usb_cdc_ncm_dpe16 *dpe16;
1243         int ndpoffset;
1244         int loopcount = 50; /* arbitrary max preventing infinite loop */
1245         u32 payload = 0;
1246
1247         ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1248         if (ndpoffset < 0)
1249                 goto error;
1250
1251 next_ndp:
1252         nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1253         if (nframes < 0)
1254                 goto error;
1255
1256         ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1257
1258         if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1259                 netif_dbg(dev, rx_err, dev->net,
1260                           "invalid DPT16 signature <%#010x>\n",
1261                           le32_to_cpu(ndp16->dwSignature));
1262                 goto err_ndp;
1263         }
1264         dpe16 = ndp16->dpe16;
1265
1266         for (x = 0; x < nframes; x++, dpe16++) {
1267                 offset = le16_to_cpu(dpe16->wDatagramIndex);
1268                 len = le16_to_cpu(dpe16->wDatagramLength);
1269
1270                 /*
1271                  * CDC NCM ch. 3.7
1272                  * All entries after first NULL entry are to be ignored
1273                  */
1274                 if ((offset == 0) || (len == 0)) {
1275                         if (!x)
1276                                 goto err_ndp; /* empty NTB */
1277                         break;
1278                 }
1279
1280                 /* sanity checking */
1281                 if (((offset + len) > skb_in->len) ||
1282                                 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1283                         netif_dbg(dev, rx_err, dev->net,
1284                                   "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1285                                   x, offset, len, skb_in);
1286                         if (!x)
1287                                 goto err_ndp;
1288                         break;
1289
1290                 } else {
1291                         skb = skb_clone(skb_in, GFP_ATOMIC);
1292                         if (!skb)
1293                                 goto error;
1294                         skb->len = len;
1295                         skb->data = ((u8 *)skb_in->data) + offset;
1296                         skb_set_tail_pointer(skb, len);
1297                         usbnet_skb_return(dev, skb);
1298                         payload += len; /* count payload bytes in this NTB */
1299                 }
1300         }
1301 err_ndp:
1302         /* are there more NDPs to process? */
1303         ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1304         if (ndpoffset && loopcount--)
1305                 goto next_ndp;
1306
1307         /* update stats */
1308         ctx->rx_overhead += skb_in->len - payload;
1309         ctx->rx_ntbs++;
1310
1311         return 1;
1312 error:
1313         return 0;
1314 }
1315 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1316
1317 static void
1318 cdc_ncm_speed_change(struct usbnet *dev,
1319                      struct usb_cdc_speed_change *data)
1320 {
1321         uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1322         uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1323
1324         /*
1325          * Currently the USB-NET API does not support reporting the actual
1326          * device speed. Do print it instead.
1327          */
1328         if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1329                 netif_info(dev, link, dev->net,
1330                            "%u mbit/s downlink %u mbit/s uplink\n",
1331                            (unsigned int)(rx_speed / 1000000U),
1332                            (unsigned int)(tx_speed / 1000000U));
1333         } else {
1334                 netif_info(dev, link, dev->net,
1335                            "%u kbit/s downlink %u kbit/s uplink\n",
1336                            (unsigned int)(rx_speed / 1000U),
1337                            (unsigned int)(tx_speed / 1000U));
1338         }
1339 }
1340
1341 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1342 {
1343         struct cdc_ncm_ctx *ctx;
1344         struct usb_cdc_notification *event;
1345
1346         ctx = (struct cdc_ncm_ctx *)dev->data[0];
1347
1348         if (urb->actual_length < sizeof(*event))
1349                 return;
1350
1351         /* test for split data in 8-byte chunks */
1352         if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1353                 cdc_ncm_speed_change(dev,
1354                       (struct usb_cdc_speed_change *)urb->transfer_buffer);
1355                 return;
1356         }
1357
1358         event = urb->transfer_buffer;
1359
1360         switch (event->bNotificationType) {
1361         case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1362                 /*
1363                  * According to the CDC NCM specification ch.7.1
1364                  * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1365                  * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1366                  */
1367                 ctx->connected = le16_to_cpu(event->wValue);
1368                 netif_info(dev, link, dev->net,
1369                            "network connection: %sconnected\n",
1370                            ctx->connected ? "" : "dis");
1371                 usbnet_link_change(dev, ctx->connected, 0);
1372                 break;
1373
1374         case USB_CDC_NOTIFY_SPEED_CHANGE:
1375                 if (urb->actual_length < (sizeof(*event) +
1376                                         sizeof(struct usb_cdc_speed_change)))
1377                         set_bit(EVENT_STS_SPLIT, &dev->flags);
1378                 else
1379                         cdc_ncm_speed_change(dev,
1380                                              (struct usb_cdc_speed_change *)&event[1]);
1381                 break;
1382
1383         default:
1384                 dev_dbg(&dev->udev->dev,
1385                         "NCM: unexpected notification 0x%02x!\n",
1386                         event->bNotificationType);
1387                 break;
1388         }
1389 }
1390
1391 static int cdc_ncm_check_connect(struct usbnet *dev)
1392 {
1393         struct cdc_ncm_ctx *ctx;
1394
1395         ctx = (struct cdc_ncm_ctx *)dev->data[0];
1396         if (ctx == NULL)
1397                 return 1;       /* disconnected */
1398
1399         return !ctx->connected;
1400 }
1401
1402 static const struct driver_info cdc_ncm_info = {
1403         .description = "CDC NCM",
1404         .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1405         .bind = cdc_ncm_bind,
1406         .unbind = cdc_ncm_unbind,
1407         .check_connect = cdc_ncm_check_connect,
1408         .manage_power = usbnet_manage_power,
1409         .status = cdc_ncm_status,
1410         .rx_fixup = cdc_ncm_rx_fixup,
1411         .tx_fixup = cdc_ncm_tx_fixup,
1412 };
1413
1414 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1415 static const struct driver_info wwan_info = {
1416         .description = "Mobile Broadband Network Device",
1417         .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1418                         | FLAG_WWAN,
1419         .bind = cdc_ncm_bind,
1420         .unbind = cdc_ncm_unbind,
1421         .check_connect = cdc_ncm_check_connect,
1422         .manage_power = usbnet_manage_power,
1423         .status = cdc_ncm_status,
1424         .rx_fixup = cdc_ncm_rx_fixup,
1425         .tx_fixup = cdc_ncm_tx_fixup,
1426 };
1427
1428 /* Same as wwan_info, but with FLAG_NOARP  */
1429 static const struct driver_info wwan_noarp_info = {
1430         .description = "Mobile Broadband Network Device (NO ARP)",
1431         .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1432                         | FLAG_WWAN | FLAG_NOARP,
1433         .bind = cdc_ncm_bind,
1434         .unbind = cdc_ncm_unbind,
1435         .check_connect = cdc_ncm_check_connect,
1436         .manage_power = usbnet_manage_power,
1437         .status = cdc_ncm_status,
1438         .rx_fixup = cdc_ncm_rx_fixup,
1439         .tx_fixup = cdc_ncm_tx_fixup,
1440 };
1441
1442 static const struct usb_device_id cdc_devs[] = {
1443         /* Ericsson MBM devices like F5521gw */
1444         { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1445                 | USB_DEVICE_ID_MATCH_VENDOR,
1446           .idVendor = 0x0bdb,
1447           .bInterfaceClass = USB_CLASS_COMM,
1448           .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1449           .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1450           .driver_info = (unsigned long) &wwan_info,
1451         },
1452
1453         /* Dell branded MBM devices like DW5550 */
1454         { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1455                 | USB_DEVICE_ID_MATCH_VENDOR,
1456           .idVendor = 0x413c,
1457           .bInterfaceClass = USB_CLASS_COMM,
1458           .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1459           .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1460           .driver_info = (unsigned long) &wwan_info,
1461         },
1462
1463         /* Toshiba branded MBM devices */
1464         { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1465                 | USB_DEVICE_ID_MATCH_VENDOR,
1466           .idVendor = 0x0930,
1467           .bInterfaceClass = USB_CLASS_COMM,
1468           .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1469           .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1470           .driver_info = (unsigned long) &wwan_info,
1471         },
1472
1473         /* tag Huawei devices as wwan */
1474         { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1475                                         USB_CLASS_COMM,
1476                                         USB_CDC_SUBCLASS_NCM,
1477                                         USB_CDC_PROTO_NONE),
1478           .driver_info = (unsigned long)&wwan_info,
1479         },
1480
1481         /* Infineon(now Intel) HSPA Modem platform */
1482         { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1483                 USB_CLASS_COMM,
1484                 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1485           .driver_info = (unsigned long)&wwan_noarp_info,
1486         },
1487
1488         /* Generic CDC-NCM devices */
1489         { USB_INTERFACE_INFO(USB_CLASS_COMM,
1490                 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1491                 .driver_info = (unsigned long)&cdc_ncm_info,
1492         },
1493         {
1494         },
1495 };
1496 MODULE_DEVICE_TABLE(usb, cdc_devs);
1497
1498 static struct usb_driver cdc_ncm_driver = {
1499         .name = "cdc_ncm",
1500         .id_table = cdc_devs,
1501         .probe = usbnet_probe,
1502         .disconnect = usbnet_disconnect,
1503         .suspend = usbnet_suspend,
1504         .resume = usbnet_resume,
1505         .reset_resume = usbnet_resume,
1506         .supports_autosuspend = 1,
1507         .disable_hub_initiated_lpm = 1,
1508 };
1509
1510 module_usb_driver(cdc_ncm_driver);
1511
1512 MODULE_AUTHOR("Hans Petter Selasky");
1513 MODULE_DESCRIPTION("USB CDC NCM host driver");
1514 MODULE_LICENSE("Dual BSD/GPL");