irqchip/s3c24xx: Mark init_eint as __maybe_unused
[linux/fpc-iii.git] / drivers / net / usb / cdc_ncm.c
blobe8a1144c5a8bfa28c1ddca137c56c888b176ab32
1 /*
2 * cdc_ncm.c
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>
8 * USB Host Driver for Network Control Model (NCM)
9 * http://www.usb.org/developers/docs/devclass_docs/NCM10_012011.zip
11 * The NCM encoding, decoding and initialization logic
12 * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
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:
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.
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.
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>
56 #if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
57 static bool prefer_mbim = true;
58 #else
59 static bool prefer_mbim;
60 #endif
61 module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
62 MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
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;
69 struct cdc_ncm_stats {
70 char stat_string[ETH_GSTRING_LEN];
71 int sizeof_stat;
72 int stat_offset;
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)
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),
92 static int cdc_ncm_get_sset_count(struct net_device __always_unused *netdev, int sset)
94 switch (sset) {
95 case ETH_SS_STATS:
96 return ARRAY_SIZE(cdc_ncm_gstrings_stats);
97 default:
98 return -EOPNOTSUPP;
102 static void cdc_ncm_get_ethtool_stats(struct net_device *netdev,
103 struct ethtool_stats __always_unused *stats,
104 u64 *data)
106 struct usbnet *dev = netdev_priv(netdev);
107 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
108 int i;
109 char *p = NULL;
111 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
112 p = (char *)ctx + cdc_ncm_gstrings_stats[i].stat_offset;
113 data[i] = (cdc_ncm_gstrings_stats[i].sizeof_stat == sizeof(u64)) ? *(u64 *)p : *(u32 *)p;
117 static void cdc_ncm_get_strings(struct net_device __always_unused *netdev, u32 stringset, u8 *data)
119 u8 *p = data;
120 int i;
122 switch (stringset) {
123 case ETH_SS_STATS:
124 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
125 memcpy(p, cdc_ncm_gstrings_stats[i].stat_string, ETH_GSTRING_LEN);
126 p += ETH_GSTRING_LEN;
131 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
133 static const struct ethtool_ops cdc_ncm_ethtool_ops = {
134 .get_settings = usbnet_get_settings,
135 .set_settings = usbnet_set_settings,
136 .get_link = usbnet_get_link,
137 .nway_reset = usbnet_nway_reset,
138 .get_drvinfo = usbnet_get_drvinfo,
139 .get_msglevel = usbnet_get_msglevel,
140 .set_msglevel = usbnet_set_msglevel,
141 .get_ts_info = ethtool_op_get_ts_info,
142 .get_sset_count = cdc_ncm_get_sset_count,
143 .get_strings = cdc_ncm_get_strings,
144 .get_ethtool_stats = cdc_ncm_get_ethtool_stats,
147 static u32 cdc_ncm_check_rx_max(struct usbnet *dev, u32 new_rx)
149 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
150 u32 val, max, min;
152 /* clamp new_rx to sane values */
153 min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
154 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
156 /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
157 if (max < min) {
158 dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
159 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
160 max = min;
163 val = clamp_t(u32, new_rx, min, max);
164 if (val != new_rx)
165 dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range\n", min, max);
167 return val;
170 static u32 cdc_ncm_check_tx_max(struct usbnet *dev, u32 new_tx)
172 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
173 u32 val, max, min;
175 /* clamp new_tx to sane values */
176 min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
177 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
179 /* some devices set dwNtbOutMaxSize too low for the above default */
180 min = min(min, max);
182 val = clamp_t(u32, new_tx, min, max);
183 if (val != new_tx)
184 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range\n", min, max);
186 return val;
189 static ssize_t cdc_ncm_show_min_tx_pkt(struct device *d, struct device_attribute *attr, char *buf)
191 struct usbnet *dev = netdev_priv(to_net_dev(d));
192 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
194 return sprintf(buf, "%u\n", ctx->min_tx_pkt);
197 static ssize_t cdc_ncm_show_rx_max(struct device *d, struct device_attribute *attr, char *buf)
199 struct usbnet *dev = netdev_priv(to_net_dev(d));
200 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
202 return sprintf(buf, "%u\n", ctx->rx_max);
205 static ssize_t cdc_ncm_show_tx_max(struct device *d, struct device_attribute *attr, char *buf)
207 struct usbnet *dev = netdev_priv(to_net_dev(d));
208 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
210 return sprintf(buf, "%u\n", ctx->tx_max);
213 static ssize_t cdc_ncm_show_tx_timer_usecs(struct device *d, struct device_attribute *attr, char *buf)
215 struct usbnet *dev = netdev_priv(to_net_dev(d));
216 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
218 return sprintf(buf, "%u\n", ctx->timer_interval / (u32)NSEC_PER_USEC);
221 static ssize_t cdc_ncm_store_min_tx_pkt(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
223 struct usbnet *dev = netdev_priv(to_net_dev(d));
224 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
225 unsigned long val;
227 /* no need to restrict values - anything from 0 to infinity is OK */
228 if (kstrtoul(buf, 0, &val))
229 return -EINVAL;
231 ctx->min_tx_pkt = val;
232 return len;
235 static ssize_t cdc_ncm_store_rx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
237 struct usbnet *dev = netdev_priv(to_net_dev(d));
238 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
239 unsigned long val;
241 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_rx_max(dev, val) != val)
242 return -EINVAL;
244 cdc_ncm_update_rxtx_max(dev, val, ctx->tx_max);
245 return len;
248 static ssize_t cdc_ncm_store_tx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
250 struct usbnet *dev = netdev_priv(to_net_dev(d));
251 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
252 unsigned long val;
254 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_tx_max(dev, val) != val)
255 return -EINVAL;
257 cdc_ncm_update_rxtx_max(dev, ctx->rx_max, val);
258 return len;
261 static ssize_t cdc_ncm_store_tx_timer_usecs(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
263 struct usbnet *dev = netdev_priv(to_net_dev(d));
264 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
265 ssize_t ret;
266 unsigned long val;
268 ret = kstrtoul(buf, 0, &val);
269 if (ret)
270 return ret;
271 if (val && (val < CDC_NCM_TIMER_INTERVAL_MIN || val > CDC_NCM_TIMER_INTERVAL_MAX))
272 return -EINVAL;
274 spin_lock_bh(&ctx->mtx);
275 ctx->timer_interval = val * NSEC_PER_USEC;
276 if (!ctx->timer_interval)
277 ctx->tx_timer_pending = 0;
278 spin_unlock_bh(&ctx->mtx);
279 return len;
282 static DEVICE_ATTR(min_tx_pkt, S_IRUGO | S_IWUSR, cdc_ncm_show_min_tx_pkt, cdc_ncm_store_min_tx_pkt);
283 static DEVICE_ATTR(rx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_rx_max, cdc_ncm_store_rx_max);
284 static DEVICE_ATTR(tx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_max, cdc_ncm_store_tx_max);
285 static DEVICE_ATTR(tx_timer_usecs, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_timer_usecs, cdc_ncm_store_tx_timer_usecs);
287 #define NCM_PARM_ATTR(name, format, tocpu) \
288 static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
290 struct usbnet *dev = netdev_priv(to_net_dev(d)); \
291 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
292 return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name)); \
294 static DEVICE_ATTR(name, S_IRUGO, cdc_ncm_show_##name, NULL)
296 NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
297 NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
298 NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
299 NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
300 NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
301 NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
302 NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
303 NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
304 NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
305 NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
307 static struct attribute *cdc_ncm_sysfs_attrs[] = {
308 &dev_attr_min_tx_pkt.attr,
309 &dev_attr_rx_max.attr,
310 &dev_attr_tx_max.attr,
311 &dev_attr_tx_timer_usecs.attr,
312 &dev_attr_bmNtbFormatsSupported.attr,
313 &dev_attr_dwNtbInMaxSize.attr,
314 &dev_attr_wNdpInDivisor.attr,
315 &dev_attr_wNdpInPayloadRemainder.attr,
316 &dev_attr_wNdpInAlignment.attr,
317 &dev_attr_dwNtbOutMaxSize.attr,
318 &dev_attr_wNdpOutDivisor.attr,
319 &dev_attr_wNdpOutPayloadRemainder.attr,
320 &dev_attr_wNdpOutAlignment.attr,
321 &dev_attr_wNtbOutMaxDatagrams.attr,
322 NULL,
325 static struct attribute_group cdc_ncm_sysfs_attr_group = {
326 .name = "cdc_ncm",
327 .attrs = cdc_ncm_sysfs_attrs,
330 /* handle rx_max and tx_max changes */
331 static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
333 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
334 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
335 u32 val;
337 val = cdc_ncm_check_rx_max(dev, new_rx);
339 /* inform device about NTB input size changes */
340 if (val != ctx->rx_max) {
341 __le32 dwNtbInMaxSize = cpu_to_le32(val);
343 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
345 /* tell device to use new size */
346 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
347 USB_TYPE_CLASS | USB_DIR_OUT
348 | USB_RECIP_INTERFACE,
349 0, iface_no, &dwNtbInMaxSize, 4) < 0)
350 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
351 else
352 ctx->rx_max = val;
355 /* usbnet use these values for sizing rx queues */
356 if (dev->rx_urb_size != ctx->rx_max) {
357 dev->rx_urb_size = ctx->rx_max;
358 if (netif_running(dev->net))
359 usbnet_unlink_rx_urbs(dev);
362 val = cdc_ncm_check_tx_max(dev, new_tx);
363 if (val != ctx->tx_max)
364 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
366 /* Adding a pad byte here if necessary simplifies the handling
367 * in cdc_ncm_fill_tx_frame, making tx_max always represent
368 * the real skb max size.
370 * We cannot use dev->maxpacket here because this is called from
371 * .bind which is called before usbnet sets up dev->maxpacket
373 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
374 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
375 val++;
377 /* we might need to flush any pending tx buffers if running */
378 if (netif_running(dev->net) && val > ctx->tx_max) {
379 netif_tx_lock_bh(dev->net);
380 usbnet_start_xmit(NULL, dev->net);
381 /* make sure tx_curr_skb is reallocated if it was empty */
382 if (ctx->tx_curr_skb) {
383 dev_kfree_skb_any(ctx->tx_curr_skb);
384 ctx->tx_curr_skb = NULL;
386 ctx->tx_max = val;
387 netif_tx_unlock_bh(dev->net);
388 } else {
389 ctx->tx_max = val;
392 dev->hard_mtu = ctx->tx_max;
394 /* max qlen depend on hard_mtu and rx_urb_size */
395 usbnet_update_max_qlen(dev);
397 /* never pad more than 3 full USB packets per transfer */
398 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
399 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
402 /* helpers for NCM and MBIM differences */
403 static u8 cdc_ncm_flags(struct usbnet *dev)
405 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
407 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
408 return ctx->mbim_desc->bmNetworkCapabilities;
409 if (ctx->func_desc)
410 return ctx->func_desc->bmNetworkCapabilities;
411 return 0;
414 static int cdc_ncm_eth_hlen(struct usbnet *dev)
416 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
417 return 0;
418 return ETH_HLEN;
421 static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
423 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
424 return CDC_MBIM_MIN_DATAGRAM_SIZE;
425 return CDC_NCM_MIN_DATAGRAM_SIZE;
428 static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
430 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
432 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
433 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
434 if (ctx->ether_desc)
435 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
436 return CDC_NCM_MAX_DATAGRAM_SIZE;
439 /* initial one-time device setup. MUST be called with the data interface
440 * in altsetting 0
442 static int cdc_ncm_init(struct usbnet *dev)
444 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
445 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
446 int err;
448 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
449 USB_TYPE_CLASS | USB_DIR_IN
450 |USB_RECIP_INTERFACE,
451 0, iface_no, &ctx->ncm_parm,
452 sizeof(ctx->ncm_parm));
453 if (err < 0) {
454 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
455 return err; /* GET_NTB_PARAMETERS is required */
458 /* set CRC Mode */
459 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
460 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
461 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
462 USB_TYPE_CLASS | USB_DIR_OUT
463 | USB_RECIP_INTERFACE,
464 USB_CDC_NCM_CRC_NOT_APPENDED,
465 iface_no, NULL, 0);
466 if (err < 0)
467 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
470 /* set NTB format, if both formats are supported.
472 * "The host shall only send this command while the NCM Data
473 * Interface is in alternate setting 0."
475 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
476 USB_CDC_NCM_NTB32_SUPPORTED) {
477 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
478 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
479 USB_TYPE_CLASS | USB_DIR_OUT
480 | USB_RECIP_INTERFACE,
481 USB_CDC_NCM_NTB16_FORMAT,
482 iface_no, NULL, 0);
483 if (err < 0)
484 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
487 /* set initial device values */
488 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
489 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
490 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
491 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
492 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
493 /* devices prior to NCM Errata shall set this field to zero */
494 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
496 dev_dbg(&dev->intf->dev,
497 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
498 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
499 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
501 /* max count of tx datagrams */
502 if ((ctx->tx_max_datagrams == 0) ||
503 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
504 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
506 /* set up maximum NDP size */
507 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
509 /* initial coalescing timer interval */
510 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
512 return 0;
515 /* set a new max datagram size */
516 static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
518 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
519 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
520 __le16 max_datagram_size;
521 u16 mbim_mtu;
522 int err;
524 /* set default based on descriptors */
525 ctx->max_datagram_size = clamp_t(u32, new_size,
526 cdc_ncm_min_dgram_size(dev),
527 CDC_NCM_MAX_DATAGRAM_SIZE);
529 /* inform the device about the selected Max Datagram Size? */
530 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
531 goto out;
533 /* read current mtu value from device */
534 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
535 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
536 0, iface_no, &max_datagram_size, 2);
537 if (err < 0) {
538 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
539 goto out;
542 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
543 goto out;
545 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
546 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
547 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
548 0, iface_no, &max_datagram_size, 2);
549 if (err < 0)
550 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
552 out:
553 /* set MTU to max supported by the device if necessary */
554 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
556 /* do not exceed operater preferred MTU */
557 if (ctx->mbim_extended_desc) {
558 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
559 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
560 dev->net->mtu = mbim_mtu;
564 static void cdc_ncm_fix_modulus(struct usbnet *dev)
566 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
567 u32 val;
570 * verify that the structure alignment is:
571 * - power of two
572 * - not greater than the maximum transmit length
573 * - not less than four bytes
575 val = ctx->tx_ndp_modulus;
577 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
578 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
579 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
580 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
584 * verify that the payload alignment is:
585 * - power of two
586 * - not greater than the maximum transmit length
587 * - not less than four bytes
589 val = ctx->tx_modulus;
591 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
592 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
593 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
594 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
597 /* verify the payload remainder */
598 if (ctx->tx_remainder >= ctx->tx_modulus) {
599 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
600 ctx->tx_remainder = 0;
603 /* adjust TX-remainder according to NCM specification. */
604 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
605 (ctx->tx_modulus - 1));
608 static int cdc_ncm_setup(struct usbnet *dev)
610 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
611 u32 def_rx, def_tx;
613 /* be conservative when selecting intial buffer size to
614 * increase the number of hosts this will work for
616 def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
617 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
618 def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
619 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
621 /* clamp rx_max and tx_max and inform device */
622 cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
624 /* sanitize the modulus and remainder values */
625 cdc_ncm_fix_modulus(dev);
627 /* set max datagram size */
628 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
629 return 0;
632 static void
633 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
635 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
636 u8 ep;
638 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
640 e = intf->cur_altsetting->endpoint + ep;
641 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
642 case USB_ENDPOINT_XFER_INT:
643 if (usb_endpoint_dir_in(&e->desc)) {
644 if (!dev->status)
645 dev->status = e;
647 break;
649 case USB_ENDPOINT_XFER_BULK:
650 if (usb_endpoint_dir_in(&e->desc)) {
651 if (!in)
652 in = e;
653 } else {
654 if (!out)
655 out = e;
657 break;
659 default:
660 break;
663 if (in && !dev->in)
664 dev->in = usb_rcvbulkpipe(dev->udev,
665 in->desc.bEndpointAddress &
666 USB_ENDPOINT_NUMBER_MASK);
667 if (out && !dev->out)
668 dev->out = usb_sndbulkpipe(dev->udev,
669 out->desc.bEndpointAddress &
670 USB_ENDPOINT_NUMBER_MASK);
673 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
675 if (ctx == NULL)
676 return;
678 if (ctx->tx_rem_skb != NULL) {
679 dev_kfree_skb_any(ctx->tx_rem_skb);
680 ctx->tx_rem_skb = NULL;
683 if (ctx->tx_curr_skb != NULL) {
684 dev_kfree_skb_any(ctx->tx_curr_skb);
685 ctx->tx_curr_skb = NULL;
688 kfree(ctx->delayed_ndp16);
690 kfree(ctx);
693 /* we need to override the usbnet change_mtu ndo for two reasons:
694 * - respect the negotiated maximum datagram size
695 * - avoid unwanted changes to rx and tx buffers
697 int cdc_ncm_change_mtu(struct net_device *net, int new_mtu)
699 struct usbnet *dev = netdev_priv(net);
700 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
701 int maxmtu = ctx->max_datagram_size - cdc_ncm_eth_hlen(dev);
703 if (new_mtu <= 0 || new_mtu > maxmtu)
704 return -EINVAL;
705 net->mtu = new_mtu;
706 return 0;
708 EXPORT_SYMBOL_GPL(cdc_ncm_change_mtu);
710 static const struct net_device_ops cdc_ncm_netdev_ops = {
711 .ndo_open = usbnet_open,
712 .ndo_stop = usbnet_stop,
713 .ndo_start_xmit = usbnet_start_xmit,
714 .ndo_tx_timeout = usbnet_tx_timeout,
715 .ndo_change_mtu = cdc_ncm_change_mtu,
716 .ndo_set_mac_address = eth_mac_addr,
717 .ndo_validate_addr = eth_validate_addr,
720 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
722 struct cdc_ncm_ctx *ctx;
723 struct usb_driver *driver;
724 u8 *buf;
725 int len;
726 int temp;
727 u8 iface_no;
728 struct usb_cdc_parsed_header hdr;
730 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
731 if (!ctx)
732 return -ENOMEM;
734 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
735 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
736 ctx->bh.data = (unsigned long)dev;
737 ctx->bh.func = cdc_ncm_txpath_bh;
738 atomic_set(&ctx->stop, 0);
739 spin_lock_init(&ctx->mtx);
741 /* store ctx pointer in device data field */
742 dev->data[0] = (unsigned long)ctx;
744 /* only the control interface can be successfully probed */
745 ctx->control = intf;
747 /* get some pointers */
748 driver = driver_of(intf);
749 buf = intf->cur_altsetting->extra;
750 len = intf->cur_altsetting->extralen;
752 /* parse through descriptors associated with control interface */
753 cdc_parse_cdc_header(&hdr, intf, buf, len);
755 if (hdr.usb_cdc_union_desc)
756 ctx->data = usb_ifnum_to_if(dev->udev,
757 hdr.usb_cdc_union_desc->bSlaveInterface0);
758 ctx->ether_desc = hdr.usb_cdc_ether_desc;
759 ctx->func_desc = hdr.usb_cdc_ncm_desc;
760 ctx->mbim_desc = hdr.usb_cdc_mbim_desc;
761 ctx->mbim_extended_desc = hdr.usb_cdc_mbim_extended_desc;
763 /* some buggy devices have an IAD but no CDC Union */
764 if (!hdr.usb_cdc_union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
765 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
766 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
769 /* check if we got everything */
770 if (!ctx->data) {
771 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
772 goto error;
774 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
775 if (!ctx->mbim_desc) {
776 dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
777 goto error;
779 } else {
780 if (!ctx->ether_desc || !ctx->func_desc) {
781 dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
782 goto error;
786 /* claim data interface, if different from control */
787 if (ctx->data != ctx->control) {
788 temp = usb_driver_claim_interface(driver, ctx->data, dev);
789 if (temp) {
790 dev_dbg(&intf->dev, "failed to claim data intf\n");
791 goto error;
795 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
797 /* reset data interface */
798 temp = usb_set_interface(dev->udev, iface_no, 0);
799 if (temp) {
800 dev_dbg(&intf->dev, "set interface failed\n");
801 goto error2;
804 /* initialize basic device settings */
805 if (cdc_ncm_init(dev))
806 goto error2;
808 /* configure data interface */
809 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
810 if (temp) {
811 dev_dbg(&intf->dev, "set interface failed\n");
812 goto error2;
815 cdc_ncm_find_endpoints(dev, ctx->data);
816 cdc_ncm_find_endpoints(dev, ctx->control);
817 if (!dev->in || !dev->out || !dev->status) {
818 dev_dbg(&intf->dev, "failed to collect endpoints\n");
819 goto error2;
822 usb_set_intfdata(ctx->data, dev);
823 usb_set_intfdata(ctx->control, dev);
825 if (ctx->ether_desc) {
826 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
827 if (temp) {
828 dev_dbg(&intf->dev, "failed to get mac address\n");
829 goto error2;
831 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
834 /* finish setting up the device specific data */
835 cdc_ncm_setup(dev);
837 /* Device-specific flags */
838 ctx->drvflags = drvflags;
840 /* Allocate the delayed NDP if needed. */
841 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
842 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
843 if (!ctx->delayed_ndp16)
844 goto error2;
845 dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
848 /* override ethtool_ops */
849 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
851 /* add our sysfs attrs */
852 dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
854 /* must handle MTU changes */
855 dev->net->netdev_ops = &cdc_ncm_netdev_ops;
857 return 0;
859 error2:
860 usb_set_intfdata(ctx->control, NULL);
861 usb_set_intfdata(ctx->data, NULL);
862 if (ctx->data != ctx->control)
863 usb_driver_release_interface(driver, ctx->data);
864 error:
865 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
866 dev->data[0] = 0;
867 dev_info(&intf->dev, "bind() failure\n");
868 return -ENODEV;
870 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
872 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
874 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
875 struct usb_driver *driver = driver_of(intf);
877 if (ctx == NULL)
878 return; /* no setup */
880 atomic_set(&ctx->stop, 1);
882 if (hrtimer_active(&ctx->tx_timer))
883 hrtimer_cancel(&ctx->tx_timer);
885 tasklet_kill(&ctx->bh);
887 /* handle devices with combined control and data interface */
888 if (ctx->control == ctx->data)
889 ctx->data = NULL;
891 /* disconnect master --> disconnect slave */
892 if (intf == ctx->control && ctx->data) {
893 usb_set_intfdata(ctx->data, NULL);
894 usb_driver_release_interface(driver, ctx->data);
895 ctx->data = NULL;
897 } else if (intf == ctx->data && ctx->control) {
898 usb_set_intfdata(ctx->control, NULL);
899 usb_driver_release_interface(driver, ctx->control);
900 ctx->control = NULL;
903 usb_set_intfdata(intf, NULL);
904 cdc_ncm_free(ctx);
906 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
908 /* Return the number of the MBIM control interface altsetting iff it
909 * is preferred and available,
911 u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
913 struct usb_host_interface *alt;
915 /* The MBIM spec defines a NCM compatible default altsetting,
916 * which we may have matched:
918 * "Functions that implement both NCM 1.0 and MBIM (an
919 * “NCM/MBIM function”) according to this recommendation
920 * shall provide two alternate settings for the
921 * Communication Interface. Alternate setting 0, and the
922 * associated class and endpoint descriptors, shall be
923 * constructed according to the rules given for the
924 * Communication Interface in section 5 of [USBNCM10].
925 * Alternate setting 1, and the associated class and
926 * endpoint descriptors, shall be constructed according to
927 * the rules given in section 6 (USB Device Model) of this
928 * specification."
930 if (intf->num_altsetting < 2)
931 return intf->cur_altsetting->desc.bAlternateSetting;
933 if (prefer_mbim) {
934 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
935 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
936 return CDC_NCM_COMM_ALTSETTING_MBIM;
938 return CDC_NCM_COMM_ALTSETTING_NCM;
940 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
942 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
944 int ret;
946 /* MBIM backwards compatible function? */
947 if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
948 return -ENODEV;
950 /* The NCM data altsetting is fixed, so we hard-coded it.
951 * Additionally, generic NCM devices are assumed to accept arbitrarily
952 * placed NDP.
954 ret = cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM, 0);
957 * We should get an event when network connection is "connected" or
958 * "disconnected". Set network connection in "disconnected" state
959 * (carrier is OFF) during attach, so the IP network stack does not
960 * start IPv6 negotiation and more.
962 usbnet_link_change(dev, 0, 0);
963 return ret;
966 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
968 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
970 if (skb->len + align > max)
971 align = max - skb->len;
972 if (align && skb_tailroom(skb) >= align)
973 memset(skb_put(skb, align), 0, align);
976 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
977 * allocating a new one within skb
979 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
981 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
982 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
983 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
985 /* If NDP should be moved to the end of the NCM package, we can't follow the
986 * NTH16 header as we would normally do. NDP isn't written to the SKB yet, and
987 * the wNdpIndex field in the header is actually not consistent with reality. It will be later.
989 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
990 if (ctx->delayed_ndp16->dwSignature == sign)
991 return ctx->delayed_ndp16;
993 /* We can only push a single NDP to the end. Return
994 * NULL to send what we've already got and queue this
995 * skb for later.
997 else if (ctx->delayed_ndp16->dwSignature)
998 return NULL;
1001 /* follow the chain of NDPs, looking for a match */
1002 while (ndpoffset) {
1003 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
1004 if (ndp16->dwSignature == sign)
1005 return ndp16;
1006 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1009 /* align new NDP */
1010 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1011 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1013 /* verify that there is room for the NDP and the datagram (reserve) */
1014 if ((ctx->tx_max - skb->len - reserve) < ctx->max_ndp_size)
1015 return NULL;
1017 /* link to it */
1018 if (ndp16)
1019 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
1020 else
1021 nth16->wNdpIndex = cpu_to_le16(skb->len);
1023 /* push a new empty NDP */
1024 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1025 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, ctx->max_ndp_size);
1026 else
1027 ndp16 = ctx->delayed_ndp16;
1029 ndp16->dwSignature = sign;
1030 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
1031 return ndp16;
1034 struct sk_buff *
1035 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
1037 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1038 struct usb_cdc_ncm_nth16 *nth16;
1039 struct usb_cdc_ncm_ndp16 *ndp16;
1040 struct sk_buff *skb_out;
1041 u16 n = 0, index, ndplen;
1042 u8 ready2send = 0;
1043 u32 delayed_ndp_size;
1045 /* When our NDP gets written in cdc_ncm_ndp(), then skb_out->len gets updated
1046 * accordingly. Otherwise, we should check here.
1048 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1049 delayed_ndp_size = ctx->max_ndp_size;
1050 else
1051 delayed_ndp_size = 0;
1053 /* if there is a remaining skb, it gets priority */
1054 if (skb != NULL) {
1055 swap(skb, ctx->tx_rem_skb);
1056 swap(sign, ctx->tx_rem_sign);
1057 } else {
1058 ready2send = 1;
1061 /* check if we are resuming an OUT skb */
1062 skb_out = ctx->tx_curr_skb;
1064 /* allocate a new OUT skb */
1065 if (!skb_out) {
1066 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
1067 if (skb_out == NULL) {
1068 if (skb != NULL) {
1069 dev_kfree_skb_any(skb);
1070 dev->net->stats.tx_dropped++;
1072 goto exit_no_skb;
1074 /* fill out the initial 16-bit NTB header */
1075 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
1076 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1077 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1078 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
1080 /* count total number of frames in this NTB */
1081 ctx->tx_curr_frame_num = 0;
1083 /* recent payload counter for this skb_out */
1084 ctx->tx_curr_frame_payload = 0;
1087 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1088 /* send any remaining skb first */
1089 if (skb == NULL) {
1090 skb = ctx->tx_rem_skb;
1091 sign = ctx->tx_rem_sign;
1092 ctx->tx_rem_skb = NULL;
1094 /* check for end of skb */
1095 if (skb == NULL)
1096 break;
1099 /* get the appropriate NDP for this skb */
1100 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1102 /* align beginning of next frame */
1103 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
1105 /* check if we had enough room left for both NDP and frame */
1106 if (!ndp16 || skb_out->len + skb->len + delayed_ndp_size > ctx->tx_max) {
1107 if (n == 0) {
1108 /* won't fit, MTU problem? */
1109 dev_kfree_skb_any(skb);
1110 skb = NULL;
1111 dev->net->stats.tx_dropped++;
1112 } else {
1113 /* no room for skb - store for later */
1114 if (ctx->tx_rem_skb != NULL) {
1115 dev_kfree_skb_any(ctx->tx_rem_skb);
1116 dev->net->stats.tx_dropped++;
1118 ctx->tx_rem_skb = skb;
1119 ctx->tx_rem_sign = sign;
1120 skb = NULL;
1121 ready2send = 1;
1122 ctx->tx_reason_ntb_full++; /* count reason for transmitting */
1124 break;
1127 /* calculate frame number withing this NDP */
1128 ndplen = le16_to_cpu(ndp16->wLength);
1129 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
1131 /* OK, add this skb */
1132 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1133 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1134 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
1135 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
1136 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
1137 dev_kfree_skb_any(skb);
1138 skb = NULL;
1140 /* send now if this NDP is full */
1141 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1142 ready2send = 1;
1143 ctx->tx_reason_ndp_full++; /* count reason for transmitting */
1144 break;
1148 /* free up any dangling skb */
1149 if (skb != NULL) {
1150 dev_kfree_skb_any(skb);
1151 skb = NULL;
1152 dev->net->stats.tx_dropped++;
1155 ctx->tx_curr_frame_num = n;
1157 if (n == 0) {
1158 /* wait for more frames */
1159 /* push variables */
1160 ctx->tx_curr_skb = skb_out;
1161 goto exit_no_skb;
1163 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1164 /* wait for more frames */
1165 /* push variables */
1166 ctx->tx_curr_skb = skb_out;
1167 /* set the pending count */
1168 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1169 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1170 goto exit_no_skb;
1172 } else {
1173 if (n == ctx->tx_max_datagrams)
1174 ctx->tx_reason_max_datagram++; /* count reason for transmitting */
1175 /* frame goes out */
1176 /* variables will be reset at next call */
1179 /* If requested, put NDP at end of frame. */
1180 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1181 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1182 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1183 nth16->wNdpIndex = cpu_to_le16(skb_out->len);
1184 memcpy(skb_put(skb_out, ctx->max_ndp_size), ctx->delayed_ndp16, ctx->max_ndp_size);
1186 /* Zero out delayed NDP - signature checking will naturally fail. */
1187 ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1190 /* If collected data size is less or equal ctx->min_tx_pkt
1191 * bytes, we send buffers as it is. If we get more data, it
1192 * would be more efficient for USB HS mobile device with DMA
1193 * engine to receive a full size NTB, than canceling DMA
1194 * transfer and receiving a short packet.
1196 * This optimization support is pointless if we end up sending
1197 * a ZLP after full sized NTBs.
1199 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1200 skb_out->len > ctx->min_tx_pkt)
1201 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
1202 ctx->tx_max - skb_out->len);
1203 else if (skb_out->len < ctx->tx_max && (skb_out->len % dev->maxpacket) == 0)
1204 *skb_put(skb_out, 1) = 0; /* force short packet */
1206 /* set final frame length */
1207 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1208 nth16->wBlockLength = cpu_to_le16(skb_out->len);
1210 /* return skb */
1211 ctx->tx_curr_skb = NULL;
1213 /* keep private stats: framing overhead and number of NTBs */
1214 ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1215 ctx->tx_ntbs++;
1217 /* usbnet will count all the framing overhead by default.
1218 * Adjust the stats so that the tx_bytes counter show real
1219 * payload data instead.
1221 usbnet_set_skb_tx_stats(skb_out, n,
1222 (long)ctx->tx_curr_frame_payload - skb_out->len);
1224 return skb_out;
1226 exit_no_skb:
1227 /* Start timer, if there is a remaining non-empty skb */
1228 if (ctx->tx_curr_skb != NULL && n > 0)
1229 cdc_ncm_tx_timeout_start(ctx);
1230 return NULL;
1232 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1234 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1236 /* start timer, if not already started */
1237 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1238 hrtimer_start(&ctx->tx_timer,
1239 ktime_set(0, ctx->timer_interval),
1240 HRTIMER_MODE_REL);
1243 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1245 struct cdc_ncm_ctx *ctx =
1246 container_of(timer, struct cdc_ncm_ctx, tx_timer);
1248 if (!atomic_read(&ctx->stop))
1249 tasklet_schedule(&ctx->bh);
1250 return HRTIMER_NORESTART;
1253 static void cdc_ncm_txpath_bh(unsigned long param)
1255 struct usbnet *dev = (struct usbnet *)param;
1256 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1258 spin_lock_bh(&ctx->mtx);
1259 if (ctx->tx_timer_pending != 0) {
1260 ctx->tx_timer_pending--;
1261 cdc_ncm_tx_timeout_start(ctx);
1262 spin_unlock_bh(&ctx->mtx);
1263 } else if (dev->net != NULL) {
1264 ctx->tx_reason_timeout++; /* count reason for transmitting */
1265 spin_unlock_bh(&ctx->mtx);
1266 netif_tx_lock_bh(dev->net);
1267 usbnet_start_xmit(NULL, dev->net);
1268 netif_tx_unlock_bh(dev->net);
1269 } else {
1270 spin_unlock_bh(&ctx->mtx);
1274 struct sk_buff *
1275 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1277 struct sk_buff *skb_out;
1278 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1281 * The Ethernet API we are using does not support transmitting
1282 * multiple Ethernet frames in a single call. This driver will
1283 * accumulate multiple Ethernet frames and send out a larger
1284 * USB frame when the USB buffer is full or when a single jiffies
1285 * timeout happens.
1287 if (ctx == NULL)
1288 goto error;
1290 spin_lock_bh(&ctx->mtx);
1291 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1292 spin_unlock_bh(&ctx->mtx);
1293 return skb_out;
1295 error:
1296 if (skb != NULL)
1297 dev_kfree_skb_any(skb);
1299 return NULL;
1301 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1303 /* verify NTB header and return offset of first NDP, or negative error */
1304 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1306 struct usbnet *dev = netdev_priv(skb_in->dev);
1307 struct usb_cdc_ncm_nth16 *nth16;
1308 int len;
1309 int ret = -EINVAL;
1311 if (ctx == NULL)
1312 goto error;
1314 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1315 sizeof(struct usb_cdc_ncm_ndp16))) {
1316 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1317 goto error;
1320 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1322 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1323 netif_dbg(dev, rx_err, dev->net,
1324 "invalid NTH16 signature <%#010x>\n",
1325 le32_to_cpu(nth16->dwSignature));
1326 goto error;
1329 len = le16_to_cpu(nth16->wBlockLength);
1330 if (len > ctx->rx_max) {
1331 netif_dbg(dev, rx_err, dev->net,
1332 "unsupported NTB block length %u/%u\n", len,
1333 ctx->rx_max);
1334 goto error;
1337 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1338 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1339 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1340 netif_dbg(dev, rx_err, dev->net,
1341 "sequence number glitch prev=%d curr=%d\n",
1342 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1344 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1346 ret = le16_to_cpu(nth16->wNdpIndex);
1347 error:
1348 return ret;
1350 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1352 /* verify NDP header and return number of datagrams, or negative error */
1353 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1355 struct usbnet *dev = netdev_priv(skb_in->dev);
1356 struct usb_cdc_ncm_ndp16 *ndp16;
1357 int ret = -EINVAL;
1359 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1360 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1361 ndpoffset);
1362 goto error;
1364 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1366 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1367 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1368 le16_to_cpu(ndp16->wLength));
1369 goto error;
1372 ret = ((le16_to_cpu(ndp16->wLength) -
1373 sizeof(struct usb_cdc_ncm_ndp16)) /
1374 sizeof(struct usb_cdc_ncm_dpe16));
1375 ret--; /* we process NDP entries except for the last one */
1377 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1378 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1379 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1380 ret = -EINVAL;
1383 error:
1384 return ret;
1386 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1388 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1390 struct sk_buff *skb;
1391 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1392 int len;
1393 int nframes;
1394 int x;
1395 int offset;
1396 struct usb_cdc_ncm_ndp16 *ndp16;
1397 struct usb_cdc_ncm_dpe16 *dpe16;
1398 int ndpoffset;
1399 int loopcount = 50; /* arbitrary max preventing infinite loop */
1400 u32 payload = 0;
1402 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1403 if (ndpoffset < 0)
1404 goto error;
1406 next_ndp:
1407 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1408 if (nframes < 0)
1409 goto error;
1411 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1413 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1414 netif_dbg(dev, rx_err, dev->net,
1415 "invalid DPT16 signature <%#010x>\n",
1416 le32_to_cpu(ndp16->dwSignature));
1417 goto err_ndp;
1419 dpe16 = ndp16->dpe16;
1421 for (x = 0; x < nframes; x++, dpe16++) {
1422 offset = le16_to_cpu(dpe16->wDatagramIndex);
1423 len = le16_to_cpu(dpe16->wDatagramLength);
1426 * CDC NCM ch. 3.7
1427 * All entries after first NULL entry are to be ignored
1429 if ((offset == 0) || (len == 0)) {
1430 if (!x)
1431 goto err_ndp; /* empty NTB */
1432 break;
1435 /* sanity checking */
1436 if (((offset + len) > skb_in->len) ||
1437 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1438 netif_dbg(dev, rx_err, dev->net,
1439 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1440 x, offset, len, skb_in);
1441 if (!x)
1442 goto err_ndp;
1443 break;
1445 } else {
1446 /* create a fresh copy to reduce truesize */
1447 skb = netdev_alloc_skb_ip_align(dev->net, len);
1448 if (!skb)
1449 goto error;
1450 memcpy(skb_put(skb, len), skb_in->data + offset, len);
1451 usbnet_skb_return(dev, skb);
1452 payload += len; /* count payload bytes in this NTB */
1455 err_ndp:
1456 /* are there more NDPs to process? */
1457 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1458 if (ndpoffset && loopcount--)
1459 goto next_ndp;
1461 /* update stats */
1462 ctx->rx_overhead += skb_in->len - payload;
1463 ctx->rx_ntbs++;
1465 return 1;
1466 error:
1467 return 0;
1469 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1471 static void
1472 cdc_ncm_speed_change(struct usbnet *dev,
1473 struct usb_cdc_speed_change *data)
1475 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1476 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1479 * Currently the USB-NET API does not support reporting the actual
1480 * device speed. Do print it instead.
1482 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1483 netif_info(dev, link, dev->net,
1484 "%u mbit/s downlink %u mbit/s uplink\n",
1485 (unsigned int)(rx_speed / 1000000U),
1486 (unsigned int)(tx_speed / 1000000U));
1487 } else {
1488 netif_info(dev, link, dev->net,
1489 "%u kbit/s downlink %u kbit/s uplink\n",
1490 (unsigned int)(rx_speed / 1000U),
1491 (unsigned int)(tx_speed / 1000U));
1495 static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1497 struct cdc_ncm_ctx *ctx;
1498 struct usb_cdc_notification *event;
1500 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1502 if (urb->actual_length < sizeof(*event))
1503 return;
1505 /* test for split data in 8-byte chunks */
1506 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1507 cdc_ncm_speed_change(dev,
1508 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1509 return;
1512 event = urb->transfer_buffer;
1514 switch (event->bNotificationType) {
1515 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1517 * According to the CDC NCM specification ch.7.1
1518 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1519 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1521 netif_info(dev, link, dev->net,
1522 "network connection: %sconnected\n",
1523 !!event->wValue ? "" : "dis");
1524 usbnet_link_change(dev, !!event->wValue, 0);
1525 break;
1527 case USB_CDC_NOTIFY_SPEED_CHANGE:
1528 if (urb->actual_length < (sizeof(*event) +
1529 sizeof(struct usb_cdc_speed_change)))
1530 set_bit(EVENT_STS_SPLIT, &dev->flags);
1531 else
1532 cdc_ncm_speed_change(dev,
1533 (struct usb_cdc_speed_change *)&event[1]);
1534 break;
1536 default:
1537 dev_dbg(&dev->udev->dev,
1538 "NCM: unexpected notification 0x%02x!\n",
1539 event->bNotificationType);
1540 break;
1544 static const struct driver_info cdc_ncm_info = {
1545 .description = "CDC NCM",
1546 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1547 .bind = cdc_ncm_bind,
1548 .unbind = cdc_ncm_unbind,
1549 .manage_power = usbnet_manage_power,
1550 .status = cdc_ncm_status,
1551 .rx_fixup = cdc_ncm_rx_fixup,
1552 .tx_fixup = cdc_ncm_tx_fixup,
1555 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1556 static const struct driver_info wwan_info = {
1557 .description = "Mobile Broadband Network Device",
1558 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1559 | FLAG_WWAN,
1560 .bind = cdc_ncm_bind,
1561 .unbind = cdc_ncm_unbind,
1562 .manage_power = usbnet_manage_power,
1563 .status = cdc_ncm_status,
1564 .rx_fixup = cdc_ncm_rx_fixup,
1565 .tx_fixup = cdc_ncm_tx_fixup,
1568 /* Same as wwan_info, but with FLAG_NOARP */
1569 static const struct driver_info wwan_noarp_info = {
1570 .description = "Mobile Broadband Network Device (NO ARP)",
1571 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1572 | FLAG_WWAN | FLAG_NOARP,
1573 .bind = cdc_ncm_bind,
1574 .unbind = cdc_ncm_unbind,
1575 .manage_power = usbnet_manage_power,
1576 .status = cdc_ncm_status,
1577 .rx_fixup = cdc_ncm_rx_fixup,
1578 .tx_fixup = cdc_ncm_tx_fixup,
1581 static const struct usb_device_id cdc_devs[] = {
1582 /* Ericsson MBM devices like F5521gw */
1583 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1584 | USB_DEVICE_ID_MATCH_VENDOR,
1585 .idVendor = 0x0bdb,
1586 .bInterfaceClass = USB_CLASS_COMM,
1587 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1588 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1589 .driver_info = (unsigned long) &wwan_info,
1592 /* DW5812 LTE Verizon Mobile Broadband Card
1593 * Unlike DW5550 this device requires FLAG_NOARP
1595 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bb,
1596 USB_CLASS_COMM,
1597 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1598 .driver_info = (unsigned long)&wwan_noarp_info,
1601 /* DW5813 LTE AT&T Mobile Broadband Card
1602 * Unlike DW5550 this device requires FLAG_NOARP
1604 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bc,
1605 USB_CLASS_COMM,
1606 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1607 .driver_info = (unsigned long)&wwan_noarp_info,
1610 /* Dell branded MBM devices like DW5550 */
1611 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1612 | USB_DEVICE_ID_MATCH_VENDOR,
1613 .idVendor = 0x413c,
1614 .bInterfaceClass = USB_CLASS_COMM,
1615 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1616 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1617 .driver_info = (unsigned long) &wwan_info,
1620 /* Toshiba branded MBM devices */
1621 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1622 | USB_DEVICE_ID_MATCH_VENDOR,
1623 .idVendor = 0x0930,
1624 .bInterfaceClass = USB_CLASS_COMM,
1625 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1626 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1627 .driver_info = (unsigned long) &wwan_info,
1630 /* tag Huawei devices as wwan */
1631 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1632 USB_CLASS_COMM,
1633 USB_CDC_SUBCLASS_NCM,
1634 USB_CDC_PROTO_NONE),
1635 .driver_info = (unsigned long)&wwan_info,
1638 /* Infineon(now Intel) HSPA Modem platform */
1639 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1640 USB_CLASS_COMM,
1641 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1642 .driver_info = (unsigned long)&wwan_noarp_info,
1645 /* Generic CDC-NCM devices */
1646 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1647 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1648 .driver_info = (unsigned long)&cdc_ncm_info,
1653 MODULE_DEVICE_TABLE(usb, cdc_devs);
1655 static struct usb_driver cdc_ncm_driver = {
1656 .name = "cdc_ncm",
1657 .id_table = cdc_devs,
1658 .probe = usbnet_probe,
1659 .disconnect = usbnet_disconnect,
1660 .suspend = usbnet_suspend,
1661 .resume = usbnet_resume,
1662 .reset_resume = usbnet_resume,
1663 .supports_autosuspend = 1,
1664 .disable_hub_initiated_lpm = 1,
1667 module_usb_driver(cdc_ncm_driver);
1669 MODULE_AUTHOR("Hans Petter Selasky");
1670 MODULE_DESCRIPTION("USB CDC NCM host driver");
1671 MODULE_LICENSE("Dual BSD/GPL");