ipv6: ip6_append_data_mtu do not handle the mtu of the second fragment properly
[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>
900d495a
AO
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>
c84ff1d6 49#include <linux/hrtimer.h>
900d495a
AO
50#include <linux/atomic.h>
51#include <linux/usb/usbnet.h>
52#include <linux/usb/cdc.h>
c91ce3b6 53#include <linux/usb/cdc_ncm.h>
900d495a 54
1e8bbe6c
BM
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
c84ff1d6
AO
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);
900d495a 66static struct usb_driver cdc_ncm_driver;
900d495a 67
64b8c8e5 68static int cdc_ncm_setup(struct usbnet *dev)
900d495a 69{
bed6f762 70 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
6a9612e2 71 struct usb_cdc_ncm_ntb_parameters ncm_parm;
900d495a 72 u32 val;
900d495a
AO
73 u8 flags;
74 u8 iface_no;
75 int err;
2d1c4310 76 int eth_hlen;
84e77a8b 77 u16 ntb_fmt_supported;
47175e5f 78 __le16 max_datagram_size;
900d495a
AO
79
80 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
81
90b8b037
ML
82 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
83 USB_TYPE_CLASS | USB_DIR_IN
84 |USB_RECIP_INTERFACE,
6a9612e2
BM
85 0, iface_no, &ncm_parm,
86 sizeof(ncm_parm));
36c35416 87 if (err < 0) {
59ede316
BM
88 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
89 return err; /* GET_NTB_PARAMETERS is required */
900d495a
AO
90 }
91
92 /* read correct set of parameters according to device mode */
6a9612e2
BM
93 ctx->rx_max = le32_to_cpu(ncm_parm.dwNtbInMaxSize);
94 ctx->tx_max = le32_to_cpu(ncm_parm.dwNtbOutMaxSize);
95 ctx->tx_remainder = le16_to_cpu(ncm_parm.wNdpOutPayloadRemainder);
96 ctx->tx_modulus = le16_to_cpu(ncm_parm.wNdpOutDivisor);
97 ctx->tx_ndp_modulus = le16_to_cpu(ncm_parm.wNdpOutAlignment);
84e77a8b 98 /* devices prior to NCM Errata shall set this field to zero */
6a9612e2
BM
99 ctx->tx_max_datagrams = le16_to_cpu(ncm_parm.wNtbOutMaxDatagrams);
100 ntb_fmt_supported = le16_to_cpu(ncm_parm.bmNtbFormatsSupported);
900d495a 101
47175e5f
BM
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;
2d1c4310 106 eth_hlen = 0;
47175e5f
BM
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;
2d1c4310 111 } else {
47175e5f
BM
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;
2d1c4310 119 }
900d495a 120
47175e5f
BM
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
ae223cd4
BM
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);
900d495a 129
84e77a8b
AO
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;
900d495a
AO
134
135 /* verify maximum size of received NTB in bytes */
84e77a8b 136 if (ctx->rx_max < USB_CDC_NCM_NTB_MIN_IN_SIZE) {
ae223cd4
BM
137 dev_dbg(&dev->intf->dev, "Using min receive length=%d\n",
138 USB_CDC_NCM_NTB_MIN_IN_SIZE);
84e77a8b
AO
139 ctx->rx_max = USB_CDC_NCM_NTB_MIN_IN_SIZE;
140 }
141
142 if (ctx->rx_max > CDC_NCM_NTB_MAX_SIZE_RX) {
ae223cd4
BM
143 dev_dbg(&dev->intf->dev, "Using default maximum receive length=%d\n",
144 CDC_NCM_NTB_MAX_SIZE_RX);
900d495a
AO
145 ctx->rx_max = CDC_NCM_NTB_MAX_SIZE_RX;
146 }
147
84e77a8b 148 /* inform device about NTB input size changes */
6a9612e2 149 if (ctx->rx_max != le32_to_cpu(ncm_parm.dwNtbInMaxSize)) {
90b8b037 150 __le32 dwNtbInMaxSize = cpu_to_le32(ctx->rx_max);
84e77a8b 151
90b8b037
ML
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);
36c35416 156 if (err < 0)
ae223cd4 157 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
84e77a8b
AO
158 }
159
900d495a 160 /* verify maximum size of transmitted NTB in bytes */
a6fe6708 161 if (ctx->tx_max > CDC_NCM_NTB_MAX_SIZE_TX) {
ae223cd4
BM
162 dev_dbg(&dev->intf->dev, "Using default maximum transmit length=%d\n",
163 CDC_NCM_NTB_MAX_SIZE_TX);
900d495a 164 ctx->tx_max = CDC_NCM_NTB_MAX_SIZE_TX;
6a9612e2
BM
165
166 /* Adding a pad byte here simplifies the handling in
167 * cdc_ncm_fill_tx_frame, by making tx_max always
168 * represent the real skb max size.
169 */
170 if (ctx->tx_max % usb_maxpacket(dev->udev, dev->out, 1) == 0)
171 ctx->tx_max++;
172
900d495a
AO
173 }
174
175 /*
176 * verify that the structure alignment is:
177 * - power of two
178 * - not greater than the maximum transmit length
179 * - not less than four bytes
180 */
181 val = ctx->tx_ndp_modulus;
182
183 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
184 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
ae223cd4 185 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
900d495a
AO
186 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
187 }
188
189 /*
190 * verify that the payload alignment is:
191 * - power of two
192 * - not greater than the maximum transmit length
193 * - not less than four bytes
194 */
195 val = ctx->tx_modulus;
196
197 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
198 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
ae223cd4 199 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
900d495a
AO
200 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
201 }
202
203 /* verify the payload remainder */
204 if (ctx->tx_remainder >= ctx->tx_modulus) {
ae223cd4 205 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
900d495a
AO
206 ctx->tx_remainder = 0;
207 }
208
209 /* adjust TX-remainder according to NCM specification. */
2d1c4310
GS
210 ctx->tx_remainder = ((ctx->tx_remainder - eth_hlen) &
211 (ctx->tx_modulus - 1));
900d495a
AO
212
213 /* additional configuration */
214
215 /* set CRC Mode */
84e77a8b 216 if (flags & USB_CDC_NCM_NCAP_CRC_MODE) {
90b8b037
ML
217 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
218 USB_TYPE_CLASS | USB_DIR_OUT
219 | USB_RECIP_INTERFACE,
220 USB_CDC_NCM_CRC_NOT_APPENDED,
221 iface_no, NULL, 0);
36c35416 222 if (err < 0)
ae223cd4 223 dev_dbg(&dev->intf->dev, "Setting CRC mode off failed\n");
84e77a8b 224 }
900d495a 225
84e77a8b
AO
226 /* set NTB format, if both formats are supported */
227 if (ntb_fmt_supported & USB_CDC_NCM_NTH32_SIGN) {
90b8b037
ML
228 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
229 USB_TYPE_CLASS | USB_DIR_OUT
230 | USB_RECIP_INTERFACE,
231 USB_CDC_NCM_NTB16_FORMAT,
232 iface_no, NULL, 0);
36c35416 233 if (err < 0)
ae223cd4 234 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit failed\n");
84e77a8b 235 }
900d495a 236
47175e5f
BM
237 /* inform the device about the selected Max Datagram Size */
238 if (!(flags & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
239 goto out;
240
241 /* read current mtu value from device */
242 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
243 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
244 0, iface_no, &max_datagram_size, 2);
245 if (err < 0) {
246 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
247 goto out;
900d495a
AO
248 }
249
47175e5f
BM
250 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
251 goto out;
252
253 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
254 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
255 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
256 0, iface_no, &max_datagram_size, 2);
257 if (err < 0)
258 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
900d495a 259
47175e5f
BM
260out:
261 /* set MTU to max supported by the device if necessary */
262 if (dev->net->mtu > ctx->max_datagram_size - eth_hlen)
263 dev->net->mtu = ctx->max_datagram_size - eth_hlen;
900d495a
AO
264 return 0;
265}
266
267static void
ff1632aa 268cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
900d495a 269{
ff1632aa 270 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
900d495a
AO
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)) {
ff1632aa
BM
279 if (!dev->status)
280 dev->status = e;
900d495a
AO
281 }
282 break;
283
284 case USB_ENDPOINT_XFER_BULK:
285 if (usb_endpoint_dir_in(&e->desc)) {
ff1632aa
BM
286 if (!in)
287 in = e;
900d495a 288 } else {
ff1632aa
BM
289 if (!out)
290 out = e;
900d495a
AO
291 }
292 break;
293
294 default:
295 break;
296 }
297 }
ff1632aa
BM
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);
900d495a
AO
306}
307
308static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
309{
310 if (ctx == NULL)
311 return;
312
900d495a
AO
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
c91ce3b6 326int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting)
900d495a 327{
83292236 328 const struct usb_cdc_union_desc *union_desc = NULL;
900d495a
AO
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
c796984f 336 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
8f0923c1
DN
337 if (!ctx)
338 return -ENOMEM;
900d495a 339
c84ff1d6
AO
340 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
341 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
bed6f762 342 ctx->bh.data = (unsigned long)dev;
c84ff1d6
AO
343 ctx->bh.func = cdc_ncm_txpath_bh;
344 atomic_set(&ctx->stop, 0);
900d495a 345 spin_lock_init(&ctx->mtx);
900d495a
AO
346
347 /* store ctx pointer in device data field */
348 dev->data[0] = (unsigned long)ctx;
349
9fe0234c
BM
350 /* only the control interface can be successfully probed */
351 ctx->control = intf;
352
900d495a
AO
353 /* get some pointers */
354 driver = driver_of(intf);
355 buf = intf->cur_altsetting->extra;
356 len = intf->cur_altsetting->extralen;
357
900d495a
AO
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:
83292236 366 if (buf[0] < sizeof(*union_desc))
900d495a
AO
367 break;
368
83292236 369 union_desc = (const struct usb_cdc_union_desc *)buf;
9fe0234c
BM
370 /* the master must be the interface we are probing */
371 if (intf->cur_altsetting->desc.bInterfaceNumber !=
296e81f8
BM
372 union_desc->bMasterInterface0) {
373 dev_dbg(&intf->dev, "bogus CDC Union\n");
9fe0234c 374 goto error;
296e81f8 375 }
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 */
296e81f8
BM
419 if (!ctx->data || (!ctx->mbim_desc && !ctx->ether_desc)) {
420 dev_dbg(&intf->dev, "CDC descriptors missing\n");
900d495a 421 goto error;
296e81f8 422 }
900d495a 423
bbc8d922
BM
424 /* claim data interface, if different from control */
425 if (ctx->data != ctx->control) {
426 temp = usb_driver_claim_interface(driver, ctx->data, dev);
296e81f8
BM
427 if (temp) {
428 dev_dbg(&intf->dev, "failed to claim data intf\n");
bbc8d922 429 goto error;
296e81f8 430 }
bbc8d922 431 }
900d495a
AO
432
433 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
434
435 /* reset data interface */
436 temp = usb_set_interface(dev->udev, iface_no, 0);
296e81f8
BM
437 if (temp) {
438 dev_dbg(&intf->dev, "set interface failed\n");
19694ac8 439 goto error2;
296e81f8 440 }
900d495a 441
900d495a 442 /* configure data interface */
38396e4c 443 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
296e81f8
BM
444 if (temp) {
445 dev_dbg(&intf->dev, "set interface failed\n");
19694ac8 446 goto error2;
296e81f8 447 }
900d495a 448
ff1632aa
BM
449 cdc_ncm_find_endpoints(dev, ctx->data);
450 cdc_ncm_find_endpoints(dev, ctx->control);
296e81f8
BM
451 if (!dev->in || !dev->out || !dev->status) {
452 dev_dbg(&intf->dev, "failed to collect endpoints\n");
19694ac8 453 goto error2;
296e81f8 454 }
900d495a 455
6a9612e2 456 /* initialize data interface */
296e81f8
BM
457 if (cdc_ncm_setup(dev)) {
458 dev_dbg(&intf->dev, "cdc_ncm_setup() failed\n");
6a9612e2 459 goto error2;
296e81f8 460 }
6a9612e2 461
900d495a
AO
462 usb_set_intfdata(ctx->data, dev);
463 usb_set_intfdata(ctx->control, dev);
900d495a 464
38396e4c
GS
465 if (ctx->ether_desc) {
466 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
296e81f8
BM
467 if (temp) {
468 dev_dbg(&intf->dev, "failed to get mac address\n");
38396e4c 469 goto error2;
296e81f8
BM
470 }
471 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
38396e4c 472 }
900d495a 473
43c87f78
BM
474 /* usbnet use these values for sizing tx/rx queues */
475 dev->hard_mtu = ctx->tx_max;
900d495a
AO
476 dev->rx_urb_size = ctx->rx_max;
477
900d495a
AO
478 return 0;
479
19694ac8
AO
480error2:
481 usb_set_intfdata(ctx->control, NULL);
482 usb_set_intfdata(ctx->data, NULL);
6b4ef602
BM
483 if (ctx->data != ctx->control)
484 usb_driver_release_interface(driver, ctx->data);
900d495a
AO
485error:
486 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
487 dev->data[0] = 0;
296e81f8 488 dev_info(&intf->dev, "bind() failure\n");
900d495a
AO
489 return -ENODEV;
490}
c91ce3b6 491EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
900d495a 492
c91ce3b6 493void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
900d495a
AO
494{
495 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
19694ac8 496 struct usb_driver *driver = driver_of(intf);
900d495a
AO
497
498 if (ctx == NULL)
499 return; /* no setup */
500
c84ff1d6
AO
501 atomic_set(&ctx->stop, 1);
502
503 if (hrtimer_active(&ctx->tx_timer))
504 hrtimer_cancel(&ctx->tx_timer);
505
506 tasklet_kill(&ctx->bh);
507
bbc8d922
BM
508 /* handle devices with combined control and data interface */
509 if (ctx->control == ctx->data)
510 ctx->data = NULL;
511
19694ac8
AO
512 /* disconnect master --> disconnect slave */
513 if (intf == ctx->control && ctx->data) {
514 usb_set_intfdata(ctx->data, NULL);
900d495a 515 usb_driver_release_interface(driver, ctx->data);
19694ac8 516 ctx->data = NULL;
900d495a 517
19694ac8
AO
518 } else if (intf == ctx->data && ctx->control) {
519 usb_set_intfdata(ctx->control, NULL);
900d495a 520 usb_driver_release_interface(driver, ctx->control);
19694ac8 521 ctx->control = NULL;
900d495a
AO
522 }
523
3e515665 524 usb_set_intfdata(intf, NULL);
900d495a
AO
525 cdc_ncm_free(ctx);
526}
c91ce3b6 527EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
900d495a 528
1e8bbe6c
BM
529/* Select the MBIM altsetting iff it is preferred and available,
530 * returning the number of the corresponding data interface altsetting
531 */
532u8 cdc_ncm_select_altsetting(struct usbnet *dev, struct usb_interface *intf)
38396e4c 533{
1e8bbe6c 534 struct usb_host_interface *alt;
38396e4c 535
bd329e12
BM
536 /* The MBIM spec defines a NCM compatible default altsetting,
537 * which we may have matched:
538 *
539 * "Functions that implement both NCM 1.0 and MBIM (an
540 * “NCM/MBIM function”) according to this recommendation
541 * shall provide two alternate settings for the
542 * Communication Interface. Alternate setting 0, and the
543 * associated class and endpoint descriptors, shall be
544 * constructed according to the rules given for the
545 * Communication Interface in section 5 of [USBNCM10].
546 * Alternate setting 1, and the associated class and
547 * endpoint descriptors, shall be constructed according to
548 * the rules given in section 6 (USB Device Model) of this
549 * specification."
bd329e12 550 */
1e8bbe6c
BM
551 if (prefer_mbim && intf->num_altsetting == 2) {
552 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
553 if (alt && cdc_ncm_comm_intf_is_mbim(alt) &&
554 !usb_set_interface(dev->udev,
555 intf->cur_altsetting->desc.bInterfaceNumber,
556 CDC_NCM_COMM_ALTSETTING_MBIM))
557 return CDC_NCM_DATA_ALTSETTING_MBIM;
f350ca03 558 }
1e8bbe6c
BM
559 return CDC_NCM_DATA_ALTSETTING_NCM;
560}
561EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
562
563static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
564{
565 int ret;
566
567 /* MBIM backwards compatible function? */
568 cdc_ncm_select_altsetting(dev, intf);
569 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting))
570 return -ENODEV;
bd329e12 571
38396e4c
GS
572 /* NCM data altsetting is always 1 */
573 ret = cdc_ncm_bind_common(dev, intf, 1);
574
575 /*
576 * We should get an event when network connection is "connected" or
577 * "disconnected". Set network connection in "disconnected" state
578 * (carrier is OFF) during attach, so the IP network stack does not
579 * start IPv6 negotiation and more.
580 */
8a34b0ae 581 usbnet_link_change(dev, 0, 0);
38396e4c
GS
582 return ret;
583}
584
c78b7c58 585static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
900d495a 586{
c78b7c58
BM
587 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
588
589 if (skb->len + align > max)
590 align = max - skb->len;
591 if (align && skb_tailroom(skb) >= align)
592 memset(skb_put(skb, align), 0, align);
593}
594
595/* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
596 * allocating a new one within skb
597 */
598static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
599{
600 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
601 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
602 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
603
604 /* follow the chain of NDPs, looking for a match */
605 while (ndpoffset) {
606 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
607 if (ndp16->dwSignature == sign)
608 return ndp16;
609 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
610 }
611
612 /* align new NDP */
613 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
614
615 /* verify that there is room for the NDP and the datagram (reserve) */
616 if ((ctx->tx_max - skb->len - reserve) < CDC_NCM_NDP_SIZE)
617 return NULL;
618
619 /* link to it */
620 if (ndp16)
621 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
622 else
623 nth16->wNdpIndex = cpu_to_le16(skb->len);
624
625 /* push a new empty NDP */
626 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, CDC_NCM_NDP_SIZE), 0, CDC_NCM_NDP_SIZE);
627 ndp16->dwSignature = sign;
628 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
629 return ndp16;
900d495a
AO
630}
631
c91ce3b6 632struct sk_buff *
bed6f762 633cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
900d495a 634{
bed6f762 635 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
c78b7c58
BM
636 struct usb_cdc_ncm_nth16 *nth16;
637 struct usb_cdc_ncm_ndp16 *ndp16;
900d495a 638 struct sk_buff *skb_out;
c78b7c58 639 u16 n = 0, index, ndplen;
84e77a8b 640 u8 ready2send = 0;
900d495a
AO
641
642 /* if there is a remaining skb, it gets priority */
c78b7c58 643 if (skb != NULL) {
900d495a 644 swap(skb, ctx->tx_rem_skb);
c78b7c58
BM
645 swap(sign, ctx->tx_rem_sign);
646 } else {
84e77a8b 647 ready2send = 1;
c78b7c58 648 }
900d495a
AO
649
650 /* check if we are resuming an OUT skb */
c78b7c58 651 skb_out = ctx->tx_curr_skb;
900d495a 652
c78b7c58
BM
653 /* allocate a new OUT skb */
654 if (!skb_out) {
20572226 655 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
900d495a
AO
656 if (skb_out == NULL) {
657 if (skb != NULL) {
658 dev_kfree_skb_any(skb);
bed6f762 659 dev->net->stats.tx_dropped++;
900d495a
AO
660 }
661 goto exit_no_skb;
662 }
c78b7c58
BM
663 /* fill out the initial 16-bit NTB header */
664 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
665 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
666 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
667 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
900d495a 668
c78b7c58 669 /* count total number of frames in this NTB */
900d495a
AO
670 ctx->tx_curr_frame_num = 0;
671 }
672
c78b7c58
BM
673 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
674 /* send any remaining skb first */
900d495a
AO
675 if (skb == NULL) {
676 skb = ctx->tx_rem_skb;
c78b7c58 677 sign = ctx->tx_rem_sign;
900d495a
AO
678 ctx->tx_rem_skb = NULL;
679
680 /* check for end of skb */
681 if (skb == NULL)
682 break;
683 }
684
c78b7c58
BM
685 /* get the appropriate NDP for this skb */
686 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
687
688 /* align beginning of next frame */
689 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
690
691 /* check if we had enough room left for both NDP and frame */
692 if (!ndp16 || skb_out->len + skb->len > ctx->tx_max) {
900d495a
AO
693 if (n == 0) {
694 /* won't fit, MTU problem? */
695 dev_kfree_skb_any(skb);
696 skb = NULL;
bed6f762 697 dev->net->stats.tx_dropped++;
900d495a
AO
698 } else {
699 /* no room for skb - store for later */
700 if (ctx->tx_rem_skb != NULL) {
701 dev_kfree_skb_any(ctx->tx_rem_skb);
bed6f762 702 dev->net->stats.tx_dropped++;
900d495a
AO
703 }
704 ctx->tx_rem_skb = skb;
c78b7c58 705 ctx->tx_rem_sign = sign;
900d495a 706 skb = NULL;
84e77a8b 707 ready2send = 1;
900d495a
AO
708 }
709 break;
710 }
711
c78b7c58
BM
712 /* calculate frame number withing this NDP */
713 ndplen = le16_to_cpu(ndp16->wLength);
714 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
900d495a 715
c78b7c58
BM
716 /* OK, add this skb */
717 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
718 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
719 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
720 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
900d495a
AO
721 dev_kfree_skb_any(skb);
722 skb = NULL;
c78b7c58
BM
723
724 /* send now if this NDP is full */
725 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
726 ready2send = 1;
727 break;
728 }
900d495a
AO
729 }
730
731 /* free up any dangling skb */
732 if (skb != NULL) {
733 dev_kfree_skb_any(skb);
734 skb = NULL;
bed6f762 735 dev->net->stats.tx_dropped++;
900d495a
AO
736 }
737
738 ctx->tx_curr_frame_num = n;
739
740 if (n == 0) {
741 /* wait for more frames */
742 /* push variables */
743 ctx->tx_curr_skb = skb_out;
900d495a
AO
744 goto exit_no_skb;
745
84e77a8b 746 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0)) {
900d495a
AO
747 /* wait for more frames */
748 /* push variables */
749 ctx->tx_curr_skb = skb_out;
900d495a
AO
750 /* set the pending count */
751 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
c84ff1d6 752 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
900d495a
AO
753 goto exit_no_skb;
754
755 } else {
756 /* frame goes out */
757 /* variables will be reset at next call */
758 }
759
20572226
BM
760 /* If collected data size is less or equal CDC_NCM_MIN_TX_PKT
761 * bytes, we send buffers as it is. If we get more data, it
762 * would be more efficient for USB HS mobile device with DMA
763 * engine to receive a full size NTB, than canceling DMA
764 * transfer and receiving a short packet.
4d619f62
BM
765 *
766 * This optimization support is pointless if we end up sending
767 * a ZLP after full sized NTBs.
900d495a 768 */
4d619f62
BM
769 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
770 skb_out->len > CDC_NCM_MIN_TX_PKT)
20572226
BM
771 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
772 ctx->tx_max - skb_out->len);
773 else if ((skb_out->len % dev->maxpacket) == 0)
c78b7c58 774 *skb_put(skb_out, 1) = 0; /* force short packet */
900d495a 775
c78b7c58
BM
776 /* set final frame length */
777 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
778 nth16->wBlockLength = cpu_to_le16(skb_out->len);
900d495a
AO
779
780 /* return skb */
781 ctx->tx_curr_skb = NULL;
bed6f762 782 dev->net->stats.tx_packets += ctx->tx_curr_frame_num;
900d495a
AO
783 return skb_out;
784
785exit_no_skb:
c84ff1d6
AO
786 /* Start timer, if there is a remaining skb */
787 if (ctx->tx_curr_skb != NULL)
788 cdc_ncm_tx_timeout_start(ctx);
900d495a
AO
789 return NULL;
790}
c91ce3b6 791EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
900d495a
AO
792
793static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
794{
795 /* start timer, if not already started */
c84ff1d6
AO
796 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
797 hrtimer_start(&ctx->tx_timer,
798 ktime_set(0, CDC_NCM_TIMER_INTERVAL),
799 HRTIMER_MODE_REL);
900d495a
AO
800}
801
c84ff1d6 802static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
900d495a 803{
c84ff1d6
AO
804 struct cdc_ncm_ctx *ctx =
805 container_of(timer, struct cdc_ncm_ctx, tx_timer);
900d495a 806
c84ff1d6
AO
807 if (!atomic_read(&ctx->stop))
808 tasklet_schedule(&ctx->bh);
809 return HRTIMER_NORESTART;
810}
900d495a 811
c84ff1d6
AO
812static void cdc_ncm_txpath_bh(unsigned long param)
813{
bed6f762
BM
814 struct usbnet *dev = (struct usbnet *)param;
815 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
900d495a 816
c84ff1d6
AO
817 spin_lock_bh(&ctx->mtx);
818 if (ctx->tx_timer_pending != 0) {
819 ctx->tx_timer_pending--;
900d495a 820 cdc_ncm_tx_timeout_start(ctx);
c84ff1d6 821 spin_unlock_bh(&ctx->mtx);
bed6f762 822 } else if (dev->net != NULL) {
c84ff1d6 823 spin_unlock_bh(&ctx->mtx);
bed6f762
BM
824 netif_tx_lock_bh(dev->net);
825 usbnet_start_xmit(NULL, dev->net);
826 netif_tx_unlock_bh(dev->net);
7b1e0cba
BM
827 } else {
828 spin_unlock_bh(&ctx->mtx);
f742aa8a 829 }
900d495a
AO
830}
831
2f69702c 832struct sk_buff *
900d495a
AO
833cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
834{
835 struct sk_buff *skb_out;
836 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
900d495a
AO
837
838 /*
839 * The Ethernet API we are using does not support transmitting
840 * multiple Ethernet frames in a single call. This driver will
841 * accumulate multiple Ethernet frames and send out a larger
842 * USB frame when the USB buffer is full or when a single jiffies
843 * timeout happens.
844 */
845 if (ctx == NULL)
846 goto error;
847
c84ff1d6 848 spin_lock_bh(&ctx->mtx);
bed6f762 849 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
c84ff1d6 850 spin_unlock_bh(&ctx->mtx);
900d495a
AO
851 return skb_out;
852
853error:
854 if (skb != NULL)
855 dev_kfree_skb_any(skb);
856
857 return NULL;
858}
2f69702c 859EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
900d495a 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 945
2f69702c 946int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
ff06ab13
BM
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}
2f69702c 1022EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
900d495a
AO
1023
1024static void
bed6f762 1025cdc_ncm_speed_change(struct usbnet *dev,
84e77a8b 1026 struct usb_cdc_speed_change *data)
900d495a 1027{
84e77a8b
AO
1028 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1029 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
900d495a
AO
1030
1031 /*
1032 * Currently the USB-NET API does not support reporting the actual
1033 * device speed. Do print it instead.
1034 */
f3028c52 1035 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
ae223cd4
BM
1036 netif_info(dev, link, dev->net,
1037 "%u mbit/s downlink %u mbit/s uplink\n",
f3028c52
BM
1038 (unsigned int)(rx_speed / 1000000U),
1039 (unsigned int)(tx_speed / 1000000U));
1040 } else {
ae223cd4
BM
1041 netif_info(dev, link, dev->net,
1042 "%u kbit/s downlink %u kbit/s uplink\n",
f3028c52
BM
1043 (unsigned int)(rx_speed / 1000U),
1044 (unsigned int)(tx_speed / 1000U));
900d495a
AO
1045 }
1046}
1047
1048static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1049{
1050 struct cdc_ncm_ctx *ctx;
1051 struct usb_cdc_notification *event;
1052
1053 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1054
1055 if (urb->actual_length < sizeof(*event))
1056 return;
1057
1058 /* test for split data in 8-byte chunks */
1059 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
bed6f762 1060 cdc_ncm_speed_change(dev,
84e77a8b 1061 (struct usb_cdc_speed_change *)urb->transfer_buffer);
900d495a
AO
1062 return;
1063 }
1064
1065 event = urb->transfer_buffer;
1066
1067 switch (event->bNotificationType) {
1068 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1069 /*
1070 * According to the CDC NCM specification ch.7.1
1071 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1072 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1073 */
1a7c6cc6 1074 ctx->connected = le16_to_cpu(event->wValue);
ae223cd4
BM
1075 netif_info(dev, link, dev->net,
1076 "network connection: %sconnected\n",
1077 ctx->connected ? "" : "dis");
8a34b0ae 1078 usbnet_link_change(dev, ctx->connected, 0);
900d495a
AO
1079 break;
1080
1081 case USB_CDC_NOTIFY_SPEED_CHANGE:
84e77a8b
AO
1082 if (urb->actual_length < (sizeof(*event) +
1083 sizeof(struct usb_cdc_speed_change)))
900d495a
AO
1084 set_bit(EVENT_STS_SPLIT, &dev->flags);
1085 else
bed6f762
BM
1086 cdc_ncm_speed_change(dev,
1087 (struct usb_cdc_speed_change *)&event[1]);
900d495a
AO
1088 break;
1089
1090 default:
67a36606
BM
1091 dev_dbg(&dev->udev->dev,
1092 "NCM: unexpected notification 0x%02x!\n",
1093 event->bNotificationType);
900d495a
AO
1094 break;
1095 }
1096}
1097
1098static int cdc_ncm_check_connect(struct usbnet *dev)
1099{
1100 struct cdc_ncm_ctx *ctx;
1101
1102 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1103 if (ctx == NULL)
1104 return 1; /* disconnected */
1105
1106 return !ctx->connected;
1107}
1108
900d495a
AO
1109static const struct driver_info cdc_ncm_info = {
1110 .description = "CDC NCM",
c261344d 1111 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
900d495a
AO
1112 .bind = cdc_ncm_bind,
1113 .unbind = cdc_ncm_unbind,
1114 .check_connect = cdc_ncm_check_connect,
a5e40708 1115 .manage_power = usbnet_manage_power,
900d495a
AO
1116 .status = cdc_ncm_status,
1117 .rx_fixup = cdc_ncm_rx_fixup,
1118 .tx_fixup = cdc_ncm_tx_fixup,
1119};
1120
f94898ea
DW
1121/* Same as cdc_ncm_info, but with FLAG_WWAN */
1122static const struct driver_info wwan_info = {
1123 .description = "Mobile Broadband Network Device",
1124 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1125 | FLAG_WWAN,
1126 .bind = cdc_ncm_bind,
1127 .unbind = cdc_ncm_unbind,
1128 .check_connect = cdc_ncm_check_connect,
a5e40708 1129 .manage_power = usbnet_manage_power,
f94898ea
DW
1130 .status = cdc_ncm_status,
1131 .rx_fixup = cdc_ncm_rx_fixup,
1132 .tx_fixup = cdc_ncm_tx_fixup,
1133};
1134
2f62d5aa
WS
1135/* Same as wwan_info, but with FLAG_NOARP */
1136static const struct driver_info wwan_noarp_info = {
1137 .description = "Mobile Broadband Network Device (NO ARP)",
1138 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1139 | FLAG_WWAN | FLAG_NOARP,
1140 .bind = cdc_ncm_bind,
1141 .unbind = cdc_ncm_unbind,
1142 .check_connect = cdc_ncm_check_connect,
1143 .manage_power = usbnet_manage_power,
1144 .status = cdc_ncm_status,
1145 .rx_fixup = cdc_ncm_rx_fixup,
1146 .tx_fixup = cdc_ncm_tx_fixup,
1147};
1148
f94898ea
DW
1149static const struct usb_device_id cdc_devs[] = {
1150 /* Ericsson MBM devices like F5521gw */
1151 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1152 | USB_DEVICE_ID_MATCH_VENDOR,
1153 .idVendor = 0x0bdb,
1154 .bInterfaceClass = USB_CLASS_COMM,
1155 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1156 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1157 .driver_info = (unsigned long) &wwan_info,
1158 },
1159
f3a1ef9c
PM
1160 /* Dell branded MBM devices like DW5550 */
1161 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1162 | USB_DEVICE_ID_MATCH_VENDOR,
1163 .idVendor = 0x413c,
1164 .bInterfaceClass = USB_CLASS_COMM,
1165 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1166 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1167 .driver_info = (unsigned long) &wwan_info,
1168 },
1169
1170 /* Toshiba branded MBM devices */
1171 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1172 | USB_DEVICE_ID_MATCH_VENDOR,
1173 .idVendor = 0x0930,
1174 .bInterfaceClass = USB_CLASS_COMM,
1175 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1176 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1177 .driver_info = (unsigned long) &wwan_info,
1178 },
1179
1f84eab4
BM
1180 /* tag Huawei devices as wwan */
1181 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1182 USB_CLASS_COMM,
1183 USB_CDC_SUBCLASS_NCM,
1184 USB_CDC_PROTO_NONE),
1185 .driver_info = (unsigned long)&wwan_info,
1186 },
1187
2f62d5aa
WS
1188 /* Infineon(now Intel) HSPA Modem platform */
1189 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1190 USB_CLASS_COMM,
1191 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1192 .driver_info = (unsigned long)&wwan_noarp_info,
1193 },
1194
f94898ea
DW
1195 /* Generic CDC-NCM devices */
1196 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1197 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1198 .driver_info = (unsigned long)&cdc_ncm_info,
1199 },
1200 {
1201 },
1202};
1203MODULE_DEVICE_TABLE(usb, cdc_devs);
1204
900d495a
AO
1205static struct usb_driver cdc_ncm_driver = {
1206 .name = "cdc_ncm",
1207 .id_table = cdc_devs,
085e50e1
BM
1208 .probe = usbnet_probe,
1209 .disconnect = usbnet_disconnect,
900d495a
AO
1210 .suspend = usbnet_suspend,
1211 .resume = usbnet_resume,
85e3c65f 1212 .reset_resume = usbnet_resume,
900d495a 1213 .supports_autosuspend = 1,
e1f12eb6 1214 .disable_hub_initiated_lpm = 1,
900d495a
AO
1215};
1216
d632eb1b 1217module_usb_driver(cdc_ncm_driver);
900d495a
AO
1218
1219MODULE_AUTHOR("Hans Petter Selasky");
1220MODULE_DESCRIPTION("USB CDC NCM host driver");
1221MODULE_LICENSE("Dual BSD/GPL");