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