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