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