ipv6: remove old conditions on flow label sharing
[linux-2.6-block.git] / drivers / net / usb / cdc_ncm.c
CommitLineData
900d495a
AO
1/*
2 * cdc_ncm.c
3 *
c84ff1d6 4 * Copyright (C) ST-Ericsson 2010-2012
900d495a
AO
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/init.h>
43#include <linux/netdevice.h>
44#include <linux/ctype.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>
c84ff1d6 50#include <linux/hrtimer.h>
900d495a
AO
51#include <linux/atomic.h>
52#include <linux/usb/usbnet.h>
53#include <linux/usb/cdc.h>
c91ce3b6 54#include <linux/usb/cdc_ncm.h>
900d495a 55
1e8bbe6c
BM
56#if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
57static bool prefer_mbim = true;
58#else
59static bool prefer_mbim;
60#endif
61module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
62MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
63
c84ff1d6
AO
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);
900d495a 67static struct usb_driver cdc_ncm_driver;
900d495a 68
bed6f762 69static u8 cdc_ncm_setup(struct usbnet *dev)
900d495a 70{
bed6f762 71 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
6a9612e2 72 struct usb_cdc_ncm_ntb_parameters ncm_parm;
900d495a 73 u32 val;
900d495a
AO
74 u8 flags;
75 u8 iface_no;
76 int err;
2d1c4310 77 int eth_hlen;
84e77a8b 78 u16 ntb_fmt_supported;
47175e5f 79 __le16 max_datagram_size;
900d495a
AO
80
81 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
82
90b8b037
ML
83 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
84 USB_TYPE_CLASS | USB_DIR_IN
85 |USB_RECIP_INTERFACE,
6a9612e2
BM
86 0, iface_no, &ncm_parm,
87 sizeof(ncm_parm));
36c35416 88 if (err < 0) {
59ede316
BM
89 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
90 return err; /* GET_NTB_PARAMETERS is required */
900d495a
AO
91 }
92
93 /* read correct set of parameters according to device mode */
6a9612e2
BM
94 ctx->rx_max = le32_to_cpu(ncm_parm.dwNtbInMaxSize);
95 ctx->tx_max = le32_to_cpu(ncm_parm.dwNtbOutMaxSize);
96 ctx->tx_remainder = le16_to_cpu(ncm_parm.wNdpOutPayloadRemainder);
97 ctx->tx_modulus = le16_to_cpu(ncm_parm.wNdpOutDivisor);
98 ctx->tx_ndp_modulus = le16_to_cpu(ncm_parm.wNdpOutAlignment);
84e77a8b 99 /* devices prior to NCM Errata shall set this field to zero */
6a9612e2
BM
100 ctx->tx_max_datagrams = le16_to_cpu(ncm_parm.wNtbOutMaxDatagrams);
101 ntb_fmt_supported = le16_to_cpu(ncm_parm.bmNtbFormatsSupported);
900d495a 102
47175e5f
BM
103 /* there are some minor differences in NCM and MBIM defaults */
104 if (cdc_ncm_comm_intf_is_mbim(ctx->control->cur_altsetting)) {
105 if (!ctx->mbim_desc)
106 return -EINVAL;
2d1c4310 107 eth_hlen = 0;
47175e5f
BM
108 flags = ctx->mbim_desc->bmNetworkCapabilities;
109 ctx->max_datagram_size = le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
110 if (ctx->max_datagram_size < CDC_MBIM_MIN_DATAGRAM_SIZE)
111 ctx->max_datagram_size = CDC_MBIM_MIN_DATAGRAM_SIZE;
2d1c4310 112 } else {
47175e5f
BM
113 if (!ctx->func_desc)
114 return -EINVAL;
115 eth_hlen = ETH_HLEN;
116 flags = ctx->func_desc->bmNetworkCapabilities;
117 ctx->max_datagram_size = le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
118 if (ctx->max_datagram_size < CDC_NCM_MIN_DATAGRAM_SIZE)
119 ctx->max_datagram_size = CDC_NCM_MIN_DATAGRAM_SIZE;
2d1c4310 120 }
900d495a 121
47175e5f
BM
122 /* common absolute max for NCM and MBIM */
123 if (ctx->max_datagram_size > CDC_NCM_MAX_DATAGRAM_SIZE)
124 ctx->max_datagram_size = CDC_NCM_MAX_DATAGRAM_SIZE;
125
ae223cd4
BM
126 dev_dbg(&dev->intf->dev,
127 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
128 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
129 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, flags);
900d495a 130
84e77a8b
AO
131 /* max count of tx datagrams */
132 if ((ctx->tx_max_datagrams == 0) ||
133 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
134 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
900d495a
AO
135
136 /* verify maximum size of received NTB in bytes */
84e77a8b 137 if (ctx->rx_max < USB_CDC_NCM_NTB_MIN_IN_SIZE) {
ae223cd4
BM
138 dev_dbg(&dev->intf->dev, "Using min receive length=%d\n",
139 USB_CDC_NCM_NTB_MIN_IN_SIZE);
84e77a8b
AO
140 ctx->rx_max = USB_CDC_NCM_NTB_MIN_IN_SIZE;
141 }
142
143 if (ctx->rx_max > CDC_NCM_NTB_MAX_SIZE_RX) {
ae223cd4
BM
144 dev_dbg(&dev->intf->dev, "Using default maximum receive length=%d\n",
145 CDC_NCM_NTB_MAX_SIZE_RX);
900d495a
AO
146 ctx->rx_max = CDC_NCM_NTB_MAX_SIZE_RX;
147 }
148
84e77a8b 149 /* inform device about NTB input size changes */
6a9612e2 150 if (ctx->rx_max != le32_to_cpu(ncm_parm.dwNtbInMaxSize)) {
90b8b037 151 __le32 dwNtbInMaxSize = cpu_to_le32(ctx->rx_max);
84e77a8b 152
90b8b037
ML
153 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
154 USB_TYPE_CLASS | USB_DIR_OUT
155 | USB_RECIP_INTERFACE,
156 0, iface_no, &dwNtbInMaxSize, 4);
36c35416 157 if (err < 0)
ae223cd4 158 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
84e77a8b
AO
159 }
160
900d495a 161 /* verify maximum size of transmitted NTB in bytes */
a6fe6708 162 if (ctx->tx_max > CDC_NCM_NTB_MAX_SIZE_TX) {
ae223cd4
BM
163 dev_dbg(&dev->intf->dev, "Using default maximum transmit length=%d\n",
164 CDC_NCM_NTB_MAX_SIZE_TX);
900d495a 165 ctx->tx_max = CDC_NCM_NTB_MAX_SIZE_TX;
6a9612e2
BM
166
167 /* Adding a pad byte here simplifies the handling in
168 * cdc_ncm_fill_tx_frame, by making tx_max always
169 * represent the real skb max size.
170 */
171 if (ctx->tx_max % usb_maxpacket(dev->udev, dev->out, 1) == 0)
172 ctx->tx_max++;
173
900d495a
AO
174 }
175
176 /*
177 * verify that the structure alignment is:
178 * - power of two
179 * - not greater than the maximum transmit length
180 * - not less than four bytes
181 */
182 val = ctx->tx_ndp_modulus;
183
184 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
185 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
ae223cd4 186 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
900d495a
AO
187 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
188 }
189
190 /*
191 * verify that the payload alignment is:
192 * - power of two
193 * - not greater than the maximum transmit length
194 * - not less than four bytes
195 */
196 val = ctx->tx_modulus;
197
198 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
199 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
ae223cd4 200 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
900d495a
AO
201 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
202 }
203
204 /* verify the payload remainder */
205 if (ctx->tx_remainder >= ctx->tx_modulus) {
ae223cd4 206 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
900d495a
AO
207 ctx->tx_remainder = 0;
208 }
209
210 /* adjust TX-remainder according to NCM specification. */
2d1c4310
GS
211 ctx->tx_remainder = ((ctx->tx_remainder - eth_hlen) &
212 (ctx->tx_modulus - 1));
900d495a
AO
213
214 /* additional configuration */
215
216 /* set CRC Mode */
84e77a8b 217 if (flags & USB_CDC_NCM_NCAP_CRC_MODE) {
90b8b037
ML
218 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
219 USB_TYPE_CLASS | USB_DIR_OUT
220 | USB_RECIP_INTERFACE,
221 USB_CDC_NCM_CRC_NOT_APPENDED,
222 iface_no, NULL, 0);
36c35416 223 if (err < 0)
ae223cd4 224 dev_dbg(&dev->intf->dev, "Setting CRC mode off failed\n");
84e77a8b 225 }
900d495a 226
84e77a8b
AO
227 /* set NTB format, if both formats are supported */
228 if (ntb_fmt_supported & USB_CDC_NCM_NTH32_SIGN) {
90b8b037
ML
229 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
230 USB_TYPE_CLASS | USB_DIR_OUT
231 | USB_RECIP_INTERFACE,
232 USB_CDC_NCM_NTB16_FORMAT,
233 iface_no, NULL, 0);
36c35416 234 if (err < 0)
ae223cd4 235 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit failed\n");
84e77a8b 236 }
900d495a 237
47175e5f
BM
238 /* inform the device about the selected Max Datagram Size */
239 if (!(flags & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
240 goto out;
241
242 /* read current mtu value from device */
243 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
244 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
245 0, iface_no, &max_datagram_size, 2);
246 if (err < 0) {
247 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
248 goto out;
900d495a
AO
249 }
250
47175e5f
BM
251 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
252 goto out;
253
254 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
255 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
256 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
257 0, iface_no, &max_datagram_size, 2);
258 if (err < 0)
259 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
900d495a 260
47175e5f
BM
261out:
262 /* set MTU to max supported by the device if necessary */
263 if (dev->net->mtu > ctx->max_datagram_size - eth_hlen)
264 dev->net->mtu = ctx->max_datagram_size - eth_hlen;
900d495a
AO
265 return 0;
266}
267
268static void
ff1632aa 269cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
900d495a 270{
ff1632aa 271 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
900d495a
AO
272 u8 ep;
273
274 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
275
276 e = intf->cur_altsetting->endpoint + ep;
277 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
278 case USB_ENDPOINT_XFER_INT:
279 if (usb_endpoint_dir_in(&e->desc)) {
ff1632aa
BM
280 if (!dev->status)
281 dev->status = e;
900d495a
AO
282 }
283 break;
284
285 case USB_ENDPOINT_XFER_BULK:
286 if (usb_endpoint_dir_in(&e->desc)) {
ff1632aa
BM
287 if (!in)
288 in = e;
900d495a 289 } else {
ff1632aa
BM
290 if (!out)
291 out = e;
900d495a
AO
292 }
293 break;
294
295 default:
296 break;
297 }
298 }
ff1632aa
BM
299 if (in && !dev->in)
300 dev->in = usb_rcvbulkpipe(dev->udev,
301 in->desc.bEndpointAddress &
302 USB_ENDPOINT_NUMBER_MASK);
303 if (out && !dev->out)
304 dev->out = usb_sndbulkpipe(dev->udev,
305 out->desc.bEndpointAddress &
306 USB_ENDPOINT_NUMBER_MASK);
900d495a
AO
307}
308
309static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
310{
311 if (ctx == NULL)
312 return;
313
900d495a
AO
314 if (ctx->tx_rem_skb != NULL) {
315 dev_kfree_skb_any(ctx->tx_rem_skb);
316 ctx->tx_rem_skb = NULL;
317 }
318
319 if (ctx->tx_curr_skb != NULL) {
320 dev_kfree_skb_any(ctx->tx_curr_skb);
321 ctx->tx_curr_skb = NULL;
322 }
323
324 kfree(ctx);
325}
326
c91ce3b6 327int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting)
900d495a 328{
83292236 329 const struct usb_cdc_union_desc *union_desc = NULL;
900d495a
AO
330 struct cdc_ncm_ctx *ctx;
331 struct usb_driver *driver;
332 u8 *buf;
333 int len;
334 int temp;
335 u8 iface_no;
336
c796984f 337 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
8f0923c1
DN
338 if (!ctx)
339 return -ENOMEM;
900d495a 340
c84ff1d6
AO
341 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
342 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
bed6f762 343 ctx->bh.data = (unsigned long)dev;
c84ff1d6
AO
344 ctx->bh.func = cdc_ncm_txpath_bh;
345 atomic_set(&ctx->stop, 0);
900d495a 346 spin_lock_init(&ctx->mtx);
900d495a
AO
347
348 /* store ctx pointer in device data field */
349 dev->data[0] = (unsigned long)ctx;
350
9fe0234c
BM
351 /* only the control interface can be successfully probed */
352 ctx->control = intf;
353
900d495a
AO
354 /* get some pointers */
355 driver = driver_of(intf);
356 buf = intf->cur_altsetting->extra;
357 len = intf->cur_altsetting->extralen;
358
900d495a
AO
359 /* parse through descriptors associated with control interface */
360 while ((len > 0) && (buf[0] > 2) && (buf[0] <= len)) {
361
362 if (buf[1] != USB_DT_CS_INTERFACE)
363 goto advance;
364
365 switch (buf[2]) {
366 case USB_CDC_UNION_TYPE:
83292236 367 if (buf[0] < sizeof(*union_desc))
900d495a
AO
368 break;
369
83292236 370 union_desc = (const struct usb_cdc_union_desc *)buf;
9fe0234c
BM
371 /* the master must be the interface we are probing */
372 if (intf->cur_altsetting->desc.bInterfaceNumber !=
296e81f8
BM
373 union_desc->bMasterInterface0) {
374 dev_dbg(&intf->dev, "bogus CDC Union\n");
9fe0234c 375 goto error;
296e81f8 376 }
900d495a 377 ctx->data = usb_ifnum_to_if(dev->udev,
83292236 378 union_desc->bSlaveInterface0);
900d495a
AO
379 break;
380
381 case USB_CDC_ETHERNET_TYPE:
382 if (buf[0] < sizeof(*(ctx->ether_desc)))
383 break;
384
385 ctx->ether_desc =
386 (const struct usb_cdc_ether_desc *)buf;
900d495a
AO
387 break;
388
389 case USB_CDC_NCM_TYPE:
390 if (buf[0] < sizeof(*(ctx->func_desc)))
391 break;
392
393 ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
394 break;
395
38396e4c
GS
396 case USB_CDC_MBIM_TYPE:
397 if (buf[0] < sizeof(*(ctx->mbim_desc)))
398 break;
399
400 ctx->mbim_desc = (const struct usb_cdc_mbim_desc *)buf;
401 break;
402
900d495a
AO
403 default:
404 break;
405 }
406advance:
407 /* advance to next descriptor */
408 temp = buf[0];
409 buf += temp;
410 len -= temp;
411 }
412
9992c2e2 413 /* some buggy devices have an IAD but no CDC Union */
83292236 414 if (!union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
56a666dc
BM
415 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
416 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
9992c2e2
BM
417 }
418
900d495a 419 /* check if we got everything */
296e81f8
BM
420 if (!ctx->data || (!ctx->mbim_desc && !ctx->ether_desc)) {
421 dev_dbg(&intf->dev, "CDC descriptors missing\n");
900d495a 422 goto error;
296e81f8 423 }
900d495a 424
bbc8d922
BM
425 /* claim data interface, if different from control */
426 if (ctx->data != ctx->control) {
427 temp = usb_driver_claim_interface(driver, ctx->data, dev);
296e81f8
BM
428 if (temp) {
429 dev_dbg(&intf->dev, "failed to claim data intf\n");
bbc8d922 430 goto error;
296e81f8 431 }
bbc8d922 432 }
900d495a
AO
433
434 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
435
436 /* reset data interface */
437 temp = usb_set_interface(dev->udev, iface_no, 0);
296e81f8
BM
438 if (temp) {
439 dev_dbg(&intf->dev, "set interface failed\n");
19694ac8 440 goto error2;
296e81f8 441 }
900d495a 442
900d495a 443 /* configure data interface */
38396e4c 444 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
296e81f8
BM
445 if (temp) {
446 dev_dbg(&intf->dev, "set interface failed\n");
19694ac8 447 goto error2;
296e81f8 448 }
900d495a 449
ff1632aa
BM
450 cdc_ncm_find_endpoints(dev, ctx->data);
451 cdc_ncm_find_endpoints(dev, ctx->control);
296e81f8
BM
452 if (!dev->in || !dev->out || !dev->status) {
453 dev_dbg(&intf->dev, "failed to collect endpoints\n");
19694ac8 454 goto error2;
296e81f8 455 }
900d495a 456
6a9612e2 457 /* initialize data interface */
296e81f8
BM
458 if (cdc_ncm_setup(dev)) {
459 dev_dbg(&intf->dev, "cdc_ncm_setup() failed\n");
6a9612e2 460 goto error2;
296e81f8 461 }
6a9612e2 462
900d495a
AO
463 usb_set_intfdata(ctx->data, dev);
464 usb_set_intfdata(ctx->control, dev);
900d495a 465
38396e4c
GS
466 if (ctx->ether_desc) {
467 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
296e81f8
BM
468 if (temp) {
469 dev_dbg(&intf->dev, "failed to get mac address\n");
38396e4c 470 goto error2;
296e81f8
BM
471 }
472 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
38396e4c 473 }
900d495a 474
43c87f78
BM
475 /* usbnet use these values for sizing tx/rx queues */
476 dev->hard_mtu = ctx->tx_max;
900d495a
AO
477 dev->rx_urb_size = ctx->rx_max;
478
900d495a
AO
479 return 0;
480
19694ac8
AO
481error2:
482 usb_set_intfdata(ctx->control, NULL);
483 usb_set_intfdata(ctx->data, NULL);
6b4ef602
BM
484 if (ctx->data != ctx->control)
485 usb_driver_release_interface(driver, ctx->data);
900d495a
AO
486error:
487 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
488 dev->data[0] = 0;
296e81f8 489 dev_info(&intf->dev, "bind() failure\n");
900d495a
AO
490 return -ENODEV;
491}
c91ce3b6 492EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
900d495a 493
c91ce3b6 494void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
900d495a
AO
495{
496 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
19694ac8 497 struct usb_driver *driver = driver_of(intf);
900d495a
AO
498
499 if (ctx == NULL)
500 return; /* no setup */
501
c84ff1d6
AO
502 atomic_set(&ctx->stop, 1);
503
504 if (hrtimer_active(&ctx->tx_timer))
505 hrtimer_cancel(&ctx->tx_timer);
506
507 tasklet_kill(&ctx->bh);
508
bbc8d922
BM
509 /* handle devices with combined control and data interface */
510 if (ctx->control == ctx->data)
511 ctx->data = NULL;
512
19694ac8
AO
513 /* disconnect master --> disconnect slave */
514 if (intf == ctx->control && ctx->data) {
515 usb_set_intfdata(ctx->data, NULL);
900d495a 516 usb_driver_release_interface(driver, ctx->data);
19694ac8 517 ctx->data = NULL;
900d495a 518
19694ac8
AO
519 } else if (intf == ctx->data && ctx->control) {
520 usb_set_intfdata(ctx->control, NULL);
900d495a 521 usb_driver_release_interface(driver, ctx->control);
19694ac8 522 ctx->control = NULL;
900d495a
AO
523 }
524
3e515665 525 usb_set_intfdata(intf, NULL);
900d495a
AO
526 cdc_ncm_free(ctx);
527}
c91ce3b6 528EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
900d495a 529
1e8bbe6c
BM
530/* Select the MBIM altsetting iff it is preferred and available,
531 * returning the number of the corresponding data interface altsetting
532 */
533u8 cdc_ncm_select_altsetting(struct usbnet *dev, struct usb_interface *intf)
38396e4c 534{
1e8bbe6c 535 struct usb_host_interface *alt;
38396e4c 536
bd329e12
BM
537 /* The MBIM spec defines a NCM compatible default altsetting,
538 * which we may have matched:
539 *
540 * "Functions that implement both NCM 1.0 and MBIM (an
541 * “NCM/MBIM function”) according to this recommendation
542 * shall provide two alternate settings for the
543 * Communication Interface. Alternate setting 0, and the
544 * associated class and endpoint descriptors, shall be
545 * constructed according to the rules given for the
546 * Communication Interface in section 5 of [USBNCM10].
547 * Alternate setting 1, and the associated class and
548 * endpoint descriptors, shall be constructed according to
549 * the rules given in section 6 (USB Device Model) of this
550 * specification."
bd329e12 551 */
1e8bbe6c
BM
552 if (prefer_mbim && intf->num_altsetting == 2) {
553 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
554 if (alt && cdc_ncm_comm_intf_is_mbim(alt) &&
555 !usb_set_interface(dev->udev,
556 intf->cur_altsetting->desc.bInterfaceNumber,
557 CDC_NCM_COMM_ALTSETTING_MBIM))
558 return CDC_NCM_DATA_ALTSETTING_MBIM;
f350ca03 559 }
1e8bbe6c
BM
560 return CDC_NCM_DATA_ALTSETTING_NCM;
561}
562EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
563
564static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
565{
566 int ret;
567
568 /* MBIM backwards compatible function? */
569 cdc_ncm_select_altsetting(dev, intf);
570 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting))
571 return -ENODEV;
bd329e12 572
38396e4c
GS
573 /* NCM data altsetting is always 1 */
574 ret = cdc_ncm_bind_common(dev, intf, 1);
575
576 /*
577 * We should get an event when network connection is "connected" or
578 * "disconnected". Set network connection in "disconnected" state
579 * (carrier is OFF) during attach, so the IP network stack does not
580 * start IPv6 negotiation and more.
581 */
8a34b0ae 582 usbnet_link_change(dev, 0, 0);
38396e4c
GS
583 return ret;
584}
585
c78b7c58 586static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
900d495a 587{
c78b7c58
BM
588 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
589
590 if (skb->len + align > max)
591 align = max - skb->len;
592 if (align && skb_tailroom(skb) >= align)
593 memset(skb_put(skb, align), 0, align);
594}
595
596/* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
597 * allocating a new one within skb
598 */
599static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
600{
601 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
602 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
603 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
604
605 /* follow the chain of NDPs, looking for a match */
606 while (ndpoffset) {
607 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
608 if (ndp16->dwSignature == sign)
609 return ndp16;
610 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
611 }
612
613 /* align new NDP */
614 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
615
616 /* verify that there is room for the NDP and the datagram (reserve) */
617 if ((ctx->tx_max - skb->len - reserve) < CDC_NCM_NDP_SIZE)
618 return NULL;
619
620 /* link to it */
621 if (ndp16)
622 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
623 else
624 nth16->wNdpIndex = cpu_to_le16(skb->len);
625
626 /* push a new empty NDP */
627 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, CDC_NCM_NDP_SIZE), 0, CDC_NCM_NDP_SIZE);
628 ndp16->dwSignature = sign;
629 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
630 return ndp16;
900d495a
AO
631}
632
c91ce3b6 633struct sk_buff *
bed6f762 634cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
900d495a 635{
bed6f762 636 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
c78b7c58
BM
637 struct usb_cdc_ncm_nth16 *nth16;
638 struct usb_cdc_ncm_ndp16 *ndp16;
900d495a 639 struct sk_buff *skb_out;
c78b7c58 640 u16 n = 0, index, ndplen;
84e77a8b 641 u8 ready2send = 0;
900d495a
AO
642
643 /* if there is a remaining skb, it gets priority */
c78b7c58 644 if (skb != NULL) {
900d495a 645 swap(skb, ctx->tx_rem_skb);
c78b7c58
BM
646 swap(sign, ctx->tx_rem_sign);
647 } else {
84e77a8b 648 ready2send = 1;
c78b7c58 649 }
900d495a
AO
650
651 /* check if we are resuming an OUT skb */
c78b7c58 652 skb_out = ctx->tx_curr_skb;
900d495a 653
c78b7c58
BM
654 /* allocate a new OUT skb */
655 if (!skb_out) {
20572226 656 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
900d495a
AO
657 if (skb_out == NULL) {
658 if (skb != NULL) {
659 dev_kfree_skb_any(skb);
bed6f762 660 dev->net->stats.tx_dropped++;
900d495a
AO
661 }
662 goto exit_no_skb;
663 }
c78b7c58
BM
664 /* fill out the initial 16-bit NTB header */
665 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
666 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
667 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
668 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
900d495a 669
c78b7c58 670 /* count total number of frames in this NTB */
900d495a
AO
671 ctx->tx_curr_frame_num = 0;
672 }
673
c78b7c58
BM
674 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
675 /* send any remaining skb first */
900d495a
AO
676 if (skb == NULL) {
677 skb = ctx->tx_rem_skb;
c78b7c58 678 sign = ctx->tx_rem_sign;
900d495a
AO
679 ctx->tx_rem_skb = NULL;
680
681 /* check for end of skb */
682 if (skb == NULL)
683 break;
684 }
685
c78b7c58
BM
686 /* get the appropriate NDP for this skb */
687 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
688
689 /* align beginning of next frame */
690 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
691
692 /* check if we had enough room left for both NDP and frame */
693 if (!ndp16 || skb_out->len + skb->len > ctx->tx_max) {
900d495a
AO
694 if (n == 0) {
695 /* won't fit, MTU problem? */
696 dev_kfree_skb_any(skb);
697 skb = NULL;
bed6f762 698 dev->net->stats.tx_dropped++;
900d495a
AO
699 } else {
700 /* no room for skb - store for later */
701 if (ctx->tx_rem_skb != NULL) {
702 dev_kfree_skb_any(ctx->tx_rem_skb);
bed6f762 703 dev->net->stats.tx_dropped++;
900d495a
AO
704 }
705 ctx->tx_rem_skb = skb;
c78b7c58 706 ctx->tx_rem_sign = sign;
900d495a 707 skb = NULL;
84e77a8b 708 ready2send = 1;
900d495a
AO
709 }
710 break;
711 }
712
c78b7c58
BM
713 /* calculate frame number withing this NDP */
714 ndplen = le16_to_cpu(ndp16->wLength);
715 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
900d495a 716
c78b7c58
BM
717 /* OK, add this skb */
718 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
719 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
720 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
721 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
900d495a
AO
722 dev_kfree_skb_any(skb);
723 skb = NULL;
c78b7c58
BM
724
725 /* send now if this NDP is full */
726 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
727 ready2send = 1;
728 break;
729 }
900d495a
AO
730 }
731
732 /* free up any dangling skb */
733 if (skb != NULL) {
734 dev_kfree_skb_any(skb);
735 skb = NULL;
bed6f762 736 dev->net->stats.tx_dropped++;
900d495a
AO
737 }
738
739 ctx->tx_curr_frame_num = n;
740
741 if (n == 0) {
742 /* wait for more frames */
743 /* push variables */
744 ctx->tx_curr_skb = skb_out;
900d495a
AO
745 goto exit_no_skb;
746
84e77a8b 747 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0)) {
900d495a
AO
748 /* wait for more frames */
749 /* push variables */
750 ctx->tx_curr_skb = skb_out;
900d495a
AO
751 /* set the pending count */
752 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
c84ff1d6 753 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
900d495a
AO
754 goto exit_no_skb;
755
756 } else {
757 /* frame goes out */
758 /* variables will be reset at next call */
759 }
760
20572226
BM
761 /* If collected data size is less or equal CDC_NCM_MIN_TX_PKT
762 * bytes, we send buffers as it is. If we get more data, it
763 * would be more efficient for USB HS mobile device with DMA
764 * engine to receive a full size NTB, than canceling DMA
765 * transfer and receiving a short packet.
4d619f62
BM
766 *
767 * This optimization support is pointless if we end up sending
768 * a ZLP after full sized NTBs.
900d495a 769 */
4d619f62
BM
770 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
771 skb_out->len > CDC_NCM_MIN_TX_PKT)
20572226
BM
772 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
773 ctx->tx_max - skb_out->len);
774 else if ((skb_out->len % dev->maxpacket) == 0)
c78b7c58 775 *skb_put(skb_out, 1) = 0; /* force short packet */
900d495a 776
c78b7c58
BM
777 /* set final frame length */
778 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
779 nth16->wBlockLength = cpu_to_le16(skb_out->len);
900d495a
AO
780
781 /* return skb */
782 ctx->tx_curr_skb = NULL;
bed6f762 783 dev->net->stats.tx_packets += ctx->tx_curr_frame_num;
900d495a
AO
784 return skb_out;
785
786exit_no_skb:
c84ff1d6
AO
787 /* Start timer, if there is a remaining skb */
788 if (ctx->tx_curr_skb != NULL)
789 cdc_ncm_tx_timeout_start(ctx);
900d495a
AO
790 return NULL;
791}
c91ce3b6 792EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
900d495a
AO
793
794static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
795{
796 /* start timer, if not already started */
c84ff1d6
AO
797 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
798 hrtimer_start(&ctx->tx_timer,
799 ktime_set(0, CDC_NCM_TIMER_INTERVAL),
800 HRTIMER_MODE_REL);
900d495a
AO
801}
802
c84ff1d6 803static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
900d495a 804{
c84ff1d6
AO
805 struct cdc_ncm_ctx *ctx =
806 container_of(timer, struct cdc_ncm_ctx, tx_timer);
900d495a 807
c84ff1d6
AO
808 if (!atomic_read(&ctx->stop))
809 tasklet_schedule(&ctx->bh);
810 return HRTIMER_NORESTART;
811}
900d495a 812
c84ff1d6
AO
813static void cdc_ncm_txpath_bh(unsigned long param)
814{
bed6f762
BM
815 struct usbnet *dev = (struct usbnet *)param;
816 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
900d495a 817
c84ff1d6
AO
818 spin_lock_bh(&ctx->mtx);
819 if (ctx->tx_timer_pending != 0) {
820 ctx->tx_timer_pending--;
900d495a 821 cdc_ncm_tx_timeout_start(ctx);
c84ff1d6 822 spin_unlock_bh(&ctx->mtx);
bed6f762 823 } else if (dev->net != NULL) {
c84ff1d6 824 spin_unlock_bh(&ctx->mtx);
bed6f762
BM
825 netif_tx_lock_bh(dev->net);
826 usbnet_start_xmit(NULL, dev->net);
827 netif_tx_unlock_bh(dev->net);
7b1e0cba
BM
828 } else {
829 spin_unlock_bh(&ctx->mtx);
f742aa8a 830 }
900d495a
AO
831}
832
833static struct sk_buff *
834cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
835{
836 struct sk_buff *skb_out;
837 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
900d495a
AO
838
839 /*
840 * The Ethernet API we are using does not support transmitting
841 * multiple Ethernet frames in a single call. This driver will
842 * accumulate multiple Ethernet frames and send out a larger
843 * USB frame when the USB buffer is full or when a single jiffies
844 * timeout happens.
845 */
846 if (ctx == NULL)
847 goto error;
848
c84ff1d6 849 spin_lock_bh(&ctx->mtx);
bed6f762 850 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
c84ff1d6 851 spin_unlock_bh(&ctx->mtx);
900d495a
AO
852 return skb_out;
853
854error:
855 if (skb != NULL)
856 dev_kfree_skb_any(skb);
857
858 return NULL;
859}
860
ff06ab13 861/* verify NTB header and return offset of first NDP, or negative error */
c91ce3b6 862int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
900d495a 863{
ae223cd4 864 struct usbnet *dev = netdev_priv(skb_in->dev);
d5ddb4a5 865 struct usb_cdc_ncm_nth16 *nth16;
ff06ab13
BM
866 int len;
867 int ret = -EINVAL;
900d495a 868
900d495a
AO
869 if (ctx == NULL)
870 goto error;
871
d5ddb4a5
AO
872 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
873 sizeof(struct usb_cdc_ncm_ndp16))) {
ae223cd4 874 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
900d495a
AO
875 goto error;
876 }
877
d5ddb4a5 878 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
900d495a 879
986e10d6 880 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
5448d75f
BM
881 netif_dbg(dev, rx_err, dev->net,
882 "invalid NTH16 signature <%#010x>\n",
883 le32_to_cpu(nth16->dwSignature));
900d495a
AO
884 goto error;
885 }
886
d5ddb4a5
AO
887 len = le16_to_cpu(nth16->wBlockLength);
888 if (len > ctx->rx_max) {
ae223cd4
BM
889 netif_dbg(dev, rx_err, dev->net,
890 "unsupported NTB block length %u/%u\n", len,
891 ctx->rx_max);
900d495a
AO
892 goto error;
893 }
894
d5ddb4a5 895 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
ae223cd4
BM
896 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
897 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
898 netif_dbg(dev, rx_err, dev->net,
899 "sequence number glitch prev=%d curr=%d\n",
900 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
d5ddb4a5
AO
901 }
902 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
903
ff06ab13
BM
904 ret = le16_to_cpu(nth16->wNdpIndex);
905error:
906 return ret;
907}
c91ce3b6 908EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
ff06ab13
BM
909
910/* verify NDP header and return number of datagrams, or negative error */
c91ce3b6 911int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
ff06ab13 912{
ae223cd4 913 struct usbnet *dev = netdev_priv(skb_in->dev);
ff06ab13
BM
914 struct usb_cdc_ncm_ndp16 *ndp16;
915 int ret = -EINVAL;
916
75d67d35 917 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
ae223cd4
BM
918 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
919 ndpoffset);
900d495a
AO
920 goto error;
921 }
75d67d35 922 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
900d495a 923
d5ddb4a5 924 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
ae223cd4
BM
925 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
926 le16_to_cpu(ndp16->wLength));
ff06ab13 927 goto error;
900d495a
AO
928 }
929
ff06ab13 930 ret = ((le16_to_cpu(ndp16->wLength) -
900d495a
AO
931 sizeof(struct usb_cdc_ncm_ndp16)) /
932 sizeof(struct usb_cdc_ncm_dpe16));
ff06ab13 933 ret--; /* we process NDP entries except for the last one */
900d495a 934
ae223cd4
BM
935 if ((sizeof(struct usb_cdc_ncm_ndp16) +
936 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
937 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
ff06ab13 938 ret = -EINVAL;
900d495a
AO
939 }
940
ff06ab13
BM
941error:
942 return ret;
943}
c91ce3b6 944EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
ff06ab13
BM
945
946static int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
947{
948 struct sk_buff *skb;
949 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
950 int len;
951 int nframes;
952 int x;
953 int offset;
954 struct usb_cdc_ncm_ndp16 *ndp16;
955 struct usb_cdc_ncm_dpe16 *dpe16;
956 int ndpoffset;
957 int loopcount = 50; /* arbitrary max preventing infinite loop */
958
959 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
960 if (ndpoffset < 0)
961 goto error;
962
963next_ndp:
964 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
965 if (nframes < 0)
966 goto error;
967
968 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
969
986e10d6 970 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
5448d75f
BM
971 netif_dbg(dev, rx_err, dev->net,
972 "invalid DPT16 signature <%#010x>\n",
973 le32_to_cpu(ndp16->dwSignature));
ff06ab13
BM
974 goto err_ndp;
975 }
976 dpe16 = ndp16->dpe16;
900d495a 977
d5ddb4a5
AO
978 for (x = 0; x < nframes; x++, dpe16++) {
979 offset = le16_to_cpu(dpe16->wDatagramIndex);
980 len = le16_to_cpu(dpe16->wDatagramLength);
900d495a
AO
981
982 /*
983 * CDC NCM ch. 3.7
984 * All entries after first NULL entry are to be ignored
985 */
d5ddb4a5 986 if ((offset == 0) || (len == 0)) {
900d495a 987 if (!x)
75d67d35 988 goto err_ndp; /* empty NTB */
900d495a
AO
989 break;
990 }
991
992 /* sanity checking */
d5ddb4a5
AO
993 if (((offset + len) > skb_in->len) ||
994 (len > ctx->rx_max) || (len < ETH_HLEN)) {
ae223cd4
BM
995 netif_dbg(dev, rx_err, dev->net,
996 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
997 x, offset, len, skb_in);
900d495a 998 if (!x)
75d67d35 999 goto err_ndp;
900d495a
AO
1000 break;
1001
1002 } else {
1003 skb = skb_clone(skb_in, GFP_ATOMIC);
9e56790a
JJ
1004 if (!skb)
1005 goto error;
d5ddb4a5 1006 skb->len = len;
900d495a 1007 skb->data = ((u8 *)skb_in->data) + offset;
d5ddb4a5 1008 skb_set_tail_pointer(skb, len);
900d495a
AO
1009 usbnet_skb_return(dev, skb);
1010 }
1011 }
75d67d35
BM
1012err_ndp:
1013 /* are there more NDPs to process? */
1014 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1015 if (ndpoffset && loopcount--)
1016 goto next_ndp;
1017
900d495a
AO
1018 return 1;
1019error:
1020 return 0;
1021}
1022
1023static void
bed6f762 1024cdc_ncm_speed_change(struct usbnet *dev,
84e77a8b 1025 struct usb_cdc_speed_change *data)
900d495a 1026{
84e77a8b
AO
1027 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1028 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
900d495a
AO
1029
1030 /*
1031 * Currently the USB-NET API does not support reporting the actual
1032 * device speed. Do print it instead.
1033 */
f3028c52 1034 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
ae223cd4
BM
1035 netif_info(dev, link, dev->net,
1036 "%u mbit/s downlink %u mbit/s uplink\n",
f3028c52
BM
1037 (unsigned int)(rx_speed / 1000000U),
1038 (unsigned int)(tx_speed / 1000000U));
1039 } else {
ae223cd4
BM
1040 netif_info(dev, link, dev->net,
1041 "%u kbit/s downlink %u kbit/s uplink\n",
f3028c52
BM
1042 (unsigned int)(rx_speed / 1000U),
1043 (unsigned int)(tx_speed / 1000U));
900d495a
AO
1044 }
1045}
1046
1047static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1048{
1049 struct cdc_ncm_ctx *ctx;
1050 struct usb_cdc_notification *event;
1051
1052 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1053
1054 if (urb->actual_length < sizeof(*event))
1055 return;
1056
1057 /* test for split data in 8-byte chunks */
1058 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
bed6f762 1059 cdc_ncm_speed_change(dev,
84e77a8b 1060 (struct usb_cdc_speed_change *)urb->transfer_buffer);
900d495a
AO
1061 return;
1062 }
1063
1064 event = urb->transfer_buffer;
1065
1066 switch (event->bNotificationType) {
1067 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1068 /*
1069 * According to the CDC NCM specification ch.7.1
1070 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1071 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1072 */
1a7c6cc6 1073 ctx->connected = le16_to_cpu(event->wValue);
ae223cd4
BM
1074 netif_info(dev, link, dev->net,
1075 "network connection: %sconnected\n",
1076 ctx->connected ? "" : "dis");
8a34b0ae 1077 usbnet_link_change(dev, ctx->connected, 0);
900d495a
AO
1078 break;
1079
1080 case USB_CDC_NOTIFY_SPEED_CHANGE:
84e77a8b
AO
1081 if (urb->actual_length < (sizeof(*event) +
1082 sizeof(struct usb_cdc_speed_change)))
900d495a
AO
1083 set_bit(EVENT_STS_SPLIT, &dev->flags);
1084 else
bed6f762
BM
1085 cdc_ncm_speed_change(dev,
1086 (struct usb_cdc_speed_change *)&event[1]);
900d495a
AO
1087 break;
1088
1089 default:
67a36606
BM
1090 dev_dbg(&dev->udev->dev,
1091 "NCM: unexpected notification 0x%02x!\n",
1092 event->bNotificationType);
900d495a
AO
1093 break;
1094 }
1095}
1096
1097static int cdc_ncm_check_connect(struct usbnet *dev)
1098{
1099 struct cdc_ncm_ctx *ctx;
1100
1101 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1102 if (ctx == NULL)
1103 return 1; /* disconnected */
1104
1105 return !ctx->connected;
1106}
1107
900d495a
AO
1108static const struct driver_info cdc_ncm_info = {
1109 .description = "CDC NCM",
c261344d 1110 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
900d495a
AO
1111 .bind = cdc_ncm_bind,
1112 .unbind = cdc_ncm_unbind,
1113 .check_connect = cdc_ncm_check_connect,
a5e40708 1114 .manage_power = usbnet_manage_power,
900d495a
AO
1115 .status = cdc_ncm_status,
1116 .rx_fixup = cdc_ncm_rx_fixup,
1117 .tx_fixup = cdc_ncm_tx_fixup,
1118};
1119
f94898ea
DW
1120/* Same as cdc_ncm_info, but with FLAG_WWAN */
1121static const struct driver_info wwan_info = {
1122 .description = "Mobile Broadband Network Device",
1123 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1124 | FLAG_WWAN,
1125 .bind = cdc_ncm_bind,
1126 .unbind = cdc_ncm_unbind,
1127 .check_connect = cdc_ncm_check_connect,
a5e40708 1128 .manage_power = usbnet_manage_power,
f94898ea
DW
1129 .status = cdc_ncm_status,
1130 .rx_fixup = cdc_ncm_rx_fixup,
1131 .tx_fixup = cdc_ncm_tx_fixup,
1132};
1133
2f62d5aa
WS
1134/* Same as wwan_info, but with FLAG_NOARP */
1135static const struct driver_info wwan_noarp_info = {
1136 .description = "Mobile Broadband Network Device (NO ARP)",
1137 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1138 | FLAG_WWAN | FLAG_NOARP,
1139 .bind = cdc_ncm_bind,
1140 .unbind = cdc_ncm_unbind,
1141 .check_connect = cdc_ncm_check_connect,
1142 .manage_power = usbnet_manage_power,
1143 .status = cdc_ncm_status,
1144 .rx_fixup = cdc_ncm_rx_fixup,
1145 .tx_fixup = cdc_ncm_tx_fixup,
1146};
1147
f94898ea
DW
1148static const struct usb_device_id cdc_devs[] = {
1149 /* Ericsson MBM devices like F5521gw */
1150 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1151 | USB_DEVICE_ID_MATCH_VENDOR,
1152 .idVendor = 0x0bdb,
1153 .bInterfaceClass = USB_CLASS_COMM,
1154 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1155 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1156 .driver_info = (unsigned long) &wwan_info,
1157 },
1158
f3a1ef9c
PM
1159 /* Dell branded MBM devices like DW5550 */
1160 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1161 | USB_DEVICE_ID_MATCH_VENDOR,
1162 .idVendor = 0x413c,
1163 .bInterfaceClass = USB_CLASS_COMM,
1164 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1165 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1166 .driver_info = (unsigned long) &wwan_info,
1167 },
1168
1169 /* Toshiba branded MBM devices */
1170 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1171 | USB_DEVICE_ID_MATCH_VENDOR,
1172 .idVendor = 0x0930,
1173 .bInterfaceClass = USB_CLASS_COMM,
1174 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1175 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1176 .driver_info = (unsigned long) &wwan_info,
1177 },
1178
1f84eab4
BM
1179 /* tag Huawei devices as wwan */
1180 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1181 USB_CLASS_COMM,
1182 USB_CDC_SUBCLASS_NCM,
1183 USB_CDC_PROTO_NONE),
1184 .driver_info = (unsigned long)&wwan_info,
1185 },
1186
bbc8d922
BM
1187 /* Huawei NCM devices disguised as vendor specific */
1188 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x16),
1189 .driver_info = (unsigned long)&wwan_info,
1190 },
1191 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x46),
1192 .driver_info = (unsigned long)&wwan_info,
1193 },
96316c59
BM
1194 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x76),
1195 .driver_info = (unsigned long)&wwan_info,
1196 },
bbc8d922 1197
2f62d5aa
WS
1198 /* Infineon(now Intel) HSPA Modem platform */
1199 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1200 USB_CLASS_COMM,
1201 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1202 .driver_info = (unsigned long)&wwan_noarp_info,
1203 },
1204
f94898ea
DW
1205 /* Generic CDC-NCM devices */
1206 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1207 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1208 .driver_info = (unsigned long)&cdc_ncm_info,
1209 },
1210 {
1211 },
1212};
1213MODULE_DEVICE_TABLE(usb, cdc_devs);
1214
900d495a
AO
1215static struct usb_driver cdc_ncm_driver = {
1216 .name = "cdc_ncm",
1217 .id_table = cdc_devs,
085e50e1
BM
1218 .probe = usbnet_probe,
1219 .disconnect = usbnet_disconnect,
900d495a
AO
1220 .suspend = usbnet_suspend,
1221 .resume = usbnet_resume,
85e3c65f 1222 .reset_resume = usbnet_resume,
900d495a 1223 .supports_autosuspend = 1,
e1f12eb6 1224 .disable_hub_initiated_lpm = 1,
900d495a
AO
1225};
1226
d632eb1b 1227module_usb_driver(cdc_ncm_driver);
900d495a
AO
1228
1229MODULE_AUTHOR("Hans Petter Selasky");
1230MODULE_DESCRIPTION("USB CDC NCM host driver");
1231MODULE_LICENSE("Dual BSD/GPL");