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