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