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