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