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