net: cdc_ncm: improve bind error debug messages
[pandora-kernel.git] / drivers / net / usb / cdc_ncm.c
1 /*
2  * cdc_ncm.c
3  *
4  * Copyright (C) ST-Ericsson 2010-2012
5  * Contact: Alexey Orishko <alexey.orishko@stericsson.com>
6  * Original author: Hans Petter Selasky <hans.petter.selasky@stericsson.com>
7  *
8  * USB Host Driver for Network Control Model (NCM)
9  * http://www.usb.org/developers/devclass_docs/NCM10.zip
10  *
11  * The NCM encoding, decoding and initialization logic
12  * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
13  *
14  * This software is available to you under a choice of one of two
15  * licenses. You may choose this file to be licensed under the terms
16  * of the GNU General Public License (GPL) Version 2 or the 2-clause
17  * BSD license listed below:
18  *
19  * Redistribution and use in source and binary forms, with or without
20  * modification, are permitted provided that the following conditions
21  * are met:
22  * 1. Redistributions of source code must retain the above copyright
23  *    notice, this list of conditions and the following disclaimer.
24  * 2. Redistributions in binary form must reproduce the above copyright
25  *    notice, this list of conditions and the following disclaimer in the
26  *    documentation and/or other materials provided with the distribution.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  */
40
41 #include <linux/module.h>
42 #include <linux/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>
50 #include <linux/hrtimer.h>
51 #include <linux/atomic.h>
52 #include <linux/usb/usbnet.h>
53 #include <linux/usb/cdc.h>
54 #include <linux/usb/cdc_ncm.h>
55
56 #if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
57 static bool prefer_mbim = true;
58 #else
59 static bool prefer_mbim;
60 #endif
61 module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
62 MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
63
64 static void cdc_ncm_txpath_bh(unsigned long param);
65 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx);
66 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *hr_timer);
67 static struct usb_driver cdc_ncm_driver;
68
69 static u8 cdc_ncm_setup(struct usbnet *dev)
70 {
71         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
72         struct usb_cdc_ncm_ntb_parameters ncm_parm;
73         u32 val;
74         u8 flags;
75         u8 iface_no;
76         int err;
77         int eth_hlen;
78         u16 ntb_fmt_supported;
79         __le16 max_datagram_size;
80
81         iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
82
83         err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
84                               USB_TYPE_CLASS | USB_DIR_IN
85                               |USB_RECIP_INTERFACE,
86                               0, iface_no, &ncm_parm,
87                               sizeof(ncm_parm));
88         if (err < 0) {
89                 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
90                 return err; /* GET_NTB_PARAMETERS is required */
91         }
92
93         /* read correct set of parameters according to device mode */
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);
99         /* devices prior to NCM Errata shall set this field to zero */
100         ctx->tx_max_datagrams = le16_to_cpu(ncm_parm.wNtbOutMaxDatagrams);
101         ntb_fmt_supported = le16_to_cpu(ncm_parm.bmNtbFormatsSupported);
102
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;
107                 eth_hlen = 0;
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;
112         } else {
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;
120         }
121
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
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);
130
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;
135
136         /* verify maximum size of received NTB in bytes */
137         if (ctx->rx_max < USB_CDC_NCM_NTB_MIN_IN_SIZE) {
138                 dev_dbg(&dev->intf->dev, "Using min receive length=%d\n",
139                         USB_CDC_NCM_NTB_MIN_IN_SIZE);
140                 ctx->rx_max = USB_CDC_NCM_NTB_MIN_IN_SIZE;
141         }
142
143         if (ctx->rx_max > CDC_NCM_NTB_MAX_SIZE_RX) {
144                 dev_dbg(&dev->intf->dev, "Using default maximum receive length=%d\n",
145                         CDC_NCM_NTB_MAX_SIZE_RX);
146                 ctx->rx_max = CDC_NCM_NTB_MAX_SIZE_RX;
147         }
148
149         /* inform device about NTB input size changes */
150         if (ctx->rx_max != le32_to_cpu(ncm_parm.dwNtbInMaxSize)) {
151                 __le32 dwNtbInMaxSize = cpu_to_le32(ctx->rx_max);
152
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);
157                 if (err < 0)
158                         dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
159         }
160
161         /* verify maximum size of transmitted NTB in bytes */
162         if ((ctx->tx_max < (CDC_NCM_MIN_HDR_SIZE + ctx->max_datagram_size)) ||
163             (ctx->tx_max > CDC_NCM_NTB_MAX_SIZE_TX)) {
164                 dev_dbg(&dev->intf->dev, "Using default maximum transmit length=%d\n",
165                         CDC_NCM_NTB_MAX_SIZE_TX);
166                 ctx->tx_max = CDC_NCM_NTB_MAX_SIZE_TX;
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
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)) {
187                 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
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)) {
201                 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
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) {
207                 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
208                 ctx->tx_remainder = 0;
209         }
210
211         /* adjust TX-remainder according to NCM specification. */
212         ctx->tx_remainder = ((ctx->tx_remainder - eth_hlen) &
213                              (ctx->tx_modulus - 1));
214
215         /* additional configuration */
216
217         /* set CRC Mode */
218         if (flags & USB_CDC_NCM_NCAP_CRC_MODE) {
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);
224                 if (err < 0)
225                         dev_dbg(&dev->intf->dev, "Setting CRC mode off failed\n");
226         }
227
228         /* set NTB format, if both formats are supported */
229         if (ntb_fmt_supported & USB_CDC_NCM_NTH32_SIGN) {
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);
235                 if (err < 0)
236                         dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit failed\n");
237         }
238
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;
250         }
251
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");
261
262 out:
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;
266         return 0;
267 }
268
269 static void
270 cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
271 {
272         struct usb_host_endpoint *e, *in = NULL, *out = NULL;
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)) {
281                                 if (!dev->status)
282                                         dev->status = e;
283                         }
284                         break;
285
286                 case USB_ENDPOINT_XFER_BULK:
287                         if (usb_endpoint_dir_in(&e->desc)) {
288                                 if (!in)
289                                         in = e;
290                         } else {
291                                 if (!out)
292                                         out = e;
293                         }
294                         break;
295
296                 default:
297                         break;
298                 }
299         }
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);
308 }
309
310 static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
311 {
312         if (ctx == NULL)
313                 return;
314
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
328 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting)
329 {
330         const struct usb_cdc_union_desc *union_desc = NULL;
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
338         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
339         if (!ctx)
340                 return -ENOMEM;
341
342         hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
343         ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
344         ctx->bh.data = (unsigned long)dev;
345         ctx->bh.func = cdc_ncm_txpath_bh;
346         atomic_set(&ctx->stop, 0);
347         spin_lock_init(&ctx->mtx);
348
349         /* store ctx pointer in device data field */
350         dev->data[0] = (unsigned long)ctx;
351
352         /* only the control interface can be successfully probed */
353         ctx->control = intf;
354
355         /* get some pointers */
356         driver = driver_of(intf);
357         buf = intf->cur_altsetting->extra;
358         len = intf->cur_altsetting->extralen;
359
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:
368                         if (buf[0] < sizeof(*union_desc))
369                                 break;
370
371                         union_desc = (const struct usb_cdc_union_desc *)buf;
372                         /* the master must be the interface we are probing */
373                         if (intf->cur_altsetting->desc.bInterfaceNumber !=
374                             union_desc->bMasterInterface0) {
375                                 dev_dbg(&intf->dev, "bogus CDC Union\n");
376                                 goto error;
377                         }
378                         ctx->data = usb_ifnum_to_if(dev->udev,
379                                                     union_desc->bSlaveInterface0);
380                         break;
381
382                 case USB_CDC_ETHERNET_TYPE:
383                         if (buf[0] < sizeof(*(ctx->ether_desc)))
384                                 break;
385
386                         ctx->ether_desc =
387                                         (const struct usb_cdc_ether_desc *)buf;
388                         break;
389
390                 case USB_CDC_NCM_TYPE:
391                         if (buf[0] < sizeof(*(ctx->func_desc)))
392                                 break;
393
394                         ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
395                         break;
396
397                 case USB_CDC_MBIM_TYPE:
398                         if (buf[0] < sizeof(*(ctx->mbim_desc)))
399                                 break;
400
401                         ctx->mbim_desc = (const struct usb_cdc_mbim_desc *)buf;
402                         break;
403
404                 default:
405                         break;
406                 }
407 advance:
408                 /* advance to next descriptor */
409                 temp = buf[0];
410                 buf += temp;
411                 len -= temp;
412         }
413
414         /* some buggy devices have an IAD but no CDC Union */
415         if (!union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
416                 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
417                 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
418         }
419
420         /* check if we got everything */
421         if (!ctx->data || (!ctx->mbim_desc && !ctx->ether_desc)) {
422                 dev_dbg(&intf->dev, "CDC descriptors missing\n");
423                 goto error;
424         }
425
426         /* claim data interface, if different from control */
427         if (ctx->data != ctx->control) {
428                 temp = usb_driver_claim_interface(driver, ctx->data, dev);
429                 if (temp) {
430                         dev_dbg(&intf->dev, "failed to claim data intf\n");
431                         goto error;
432                 }
433         }
434
435         iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
436
437         /* reset data interface */
438         temp = usb_set_interface(dev->udev, iface_no, 0);
439         if (temp) {
440                 dev_dbg(&intf->dev, "set interface failed\n");
441                 goto error2;
442         }
443
444         /* configure data interface */
445         temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
446         if (temp) {
447                 dev_dbg(&intf->dev, "set interface failed\n");
448                 goto error2;
449         }
450
451         cdc_ncm_find_endpoints(dev, ctx->data);
452         cdc_ncm_find_endpoints(dev, ctx->control);
453         if (!dev->in || !dev->out || !dev->status) {
454                 dev_dbg(&intf->dev, "failed to collect endpoints\n");
455                 goto error2;
456         }
457
458         /* initialize data interface */
459         if (cdc_ncm_setup(dev)) {
460                 dev_dbg(&intf->dev, "cdc_ncm_setup() failed\n");
461                 goto error2;
462         }
463
464         usb_set_intfdata(ctx->data, dev);
465         usb_set_intfdata(ctx->control, dev);
466
467         if (ctx->ether_desc) {
468                 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
469                 if (temp) {
470                         dev_dbg(&intf->dev, "failed to get mac address\n");
471                         goto error2;
472                 }
473                 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
474         }
475
476         /* usbnet use these values for sizing tx/rx queues */
477         dev->hard_mtu = ctx->tx_max;
478         dev->rx_urb_size = ctx->rx_max;
479
480         return 0;
481
482 error2:
483         usb_set_intfdata(ctx->control, NULL);
484         usb_set_intfdata(ctx->data, NULL);
485         if (ctx->data != ctx->control)
486                 usb_driver_release_interface(driver, ctx->data);
487 error:
488         cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
489         dev->data[0] = 0;
490         dev_info(&intf->dev, "bind() failure\n");
491         return -ENODEV;
492 }
493 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
494
495 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
496 {
497         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
498         struct usb_driver *driver = driver_of(intf);
499
500         if (ctx == NULL)
501                 return;         /* no setup */
502
503         atomic_set(&ctx->stop, 1);
504
505         if (hrtimer_active(&ctx->tx_timer))
506                 hrtimer_cancel(&ctx->tx_timer);
507
508         tasklet_kill(&ctx->bh);
509
510         /* handle devices with combined control and data interface */
511         if (ctx->control == ctx->data)
512                 ctx->data = NULL;
513
514         /* disconnect master --> disconnect slave */
515         if (intf == ctx->control && ctx->data) {
516                 usb_set_intfdata(ctx->data, NULL);
517                 usb_driver_release_interface(driver, ctx->data);
518                 ctx->data = NULL;
519
520         } else if (intf == ctx->data && ctx->control) {
521                 usb_set_intfdata(ctx->control, NULL);
522                 usb_driver_release_interface(driver, ctx->control);
523                 ctx->control = NULL;
524         }
525
526         usb_set_intfdata(intf, NULL);
527         cdc_ncm_free(ctx);
528 }
529 EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
530
531 /* Select the MBIM altsetting iff it is preferred and available,
532  * returning the number of the corresponding data interface altsetting
533  */
534 u8 cdc_ncm_select_altsetting(struct usbnet *dev, struct usb_interface *intf)
535 {
536         struct usb_host_interface *alt;
537
538         /* The MBIM spec defines a NCM compatible default altsetting,
539          * which we may have matched:
540          *
541          *  "Functions that implement both NCM 1.0 and MBIM (an
542          *   “NCM/MBIM function”) according to this recommendation
543          *   shall provide two alternate settings for the
544          *   Communication Interface.  Alternate setting 0, and the
545          *   associated class and endpoint descriptors, shall be
546          *   constructed according to the rules given for the
547          *   Communication Interface in section 5 of [USBNCM10].
548          *   Alternate setting 1, and the associated class and
549          *   endpoint descriptors, shall be constructed according to
550          *   the rules given in section 6 (USB Device Model) of this
551          *   specification."
552          */
553         if (prefer_mbim && intf->num_altsetting == 2) {
554                 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
555                 if (alt && cdc_ncm_comm_intf_is_mbim(alt) &&
556                     !usb_set_interface(dev->udev,
557                                        intf->cur_altsetting->desc.bInterfaceNumber,
558                                        CDC_NCM_COMM_ALTSETTING_MBIM))
559                         return CDC_NCM_DATA_ALTSETTING_MBIM;
560         }
561         return CDC_NCM_DATA_ALTSETTING_NCM;
562 }
563 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
564
565 static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
566 {
567         int ret;
568
569         /* MBIM backwards compatible function? */
570         cdc_ncm_select_altsetting(dev, intf);
571         if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting))
572                 return -ENODEV;
573
574         /* NCM data altsetting is always 1 */
575         ret = cdc_ncm_bind_common(dev, intf, 1);
576
577         /*
578          * We should get an event when network connection is "connected" or
579          * "disconnected". Set network connection in "disconnected" state
580          * (carrier is OFF) during attach, so the IP network stack does not
581          * start IPv6 negotiation and more.
582          */
583         usbnet_link_change(dev, 0, 0);
584         return ret;
585 }
586
587 static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
588 {
589         size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
590
591         if (skb->len + align > max)
592                 align = max - skb->len;
593         if (align && skb_tailroom(skb) >= align)
594                 memset(skb_put(skb, align), 0, align);
595 }
596
597 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
598  * allocating a new one within skb
599  */
600 static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
601 {
602         struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
603         struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
604         size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
605
606         /* follow the chain of NDPs, looking for a match */
607         while (ndpoffset) {
608                 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
609                 if  (ndp16->dwSignature == sign)
610                         return ndp16;
611                 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
612         }
613
614         /* align new NDP */
615         cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
616
617         /* verify that there is room for the NDP and the datagram (reserve) */
618         if ((ctx->tx_max - skb->len - reserve) < CDC_NCM_NDP_SIZE)
619                 return NULL;
620
621         /* link to it */
622         if (ndp16)
623                 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
624         else
625                 nth16->wNdpIndex = cpu_to_le16(skb->len);
626
627         /* push a new empty NDP */
628         ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, CDC_NCM_NDP_SIZE), 0, CDC_NCM_NDP_SIZE);
629         ndp16->dwSignature = sign;
630         ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
631         return ndp16;
632 }
633
634 struct sk_buff *
635 cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
636 {
637         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
638         struct usb_cdc_ncm_nth16 *nth16;
639         struct usb_cdc_ncm_ndp16 *ndp16;
640         struct sk_buff *skb_out;
641         u16 n = 0, index, ndplen;
642         u8 ready2send = 0;
643
644         /* if there is a remaining skb, it gets priority */
645         if (skb != NULL) {
646                 swap(skb, ctx->tx_rem_skb);
647                 swap(sign, ctx->tx_rem_sign);
648         } else {
649                 ready2send = 1;
650         }
651
652         /* check if we are resuming an OUT skb */
653         skb_out = ctx->tx_curr_skb;
654
655         /* allocate a new OUT skb */
656         if (!skb_out) {
657                 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
658                 if (skb_out == NULL) {
659                         if (skb != NULL) {
660                                 dev_kfree_skb_any(skb);
661                                 dev->net->stats.tx_dropped++;
662                         }
663                         goto exit_no_skb;
664                 }
665                 /* fill out the initial 16-bit NTB header */
666                 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
667                 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
668                 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
669                 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
670
671                 /* count total number of frames in this NTB */
672                 ctx->tx_curr_frame_num = 0;
673         }
674
675         for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
676                 /* send any remaining skb first */
677                 if (skb == NULL) {
678                         skb = ctx->tx_rem_skb;
679                         sign = ctx->tx_rem_sign;
680                         ctx->tx_rem_skb = NULL;
681
682                         /* check for end of skb */
683                         if (skb == NULL)
684                                 break;
685                 }
686
687                 /* get the appropriate NDP for this skb */
688                 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
689
690                 /* align beginning of next frame */
691                 cdc_ncm_align_tail(skb_out,  ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
692
693                 /* check if we had enough room left for both NDP and frame */
694                 if (!ndp16 || skb_out->len + skb->len > ctx->tx_max) {
695                         if (n == 0) {
696                                 /* won't fit, MTU problem? */
697                                 dev_kfree_skb_any(skb);
698                                 skb = NULL;
699                                 dev->net->stats.tx_dropped++;
700                         } else {
701                                 /* no room for skb - store for later */
702                                 if (ctx->tx_rem_skb != NULL) {
703                                         dev_kfree_skb_any(ctx->tx_rem_skb);
704                                         dev->net->stats.tx_dropped++;
705                                 }
706                                 ctx->tx_rem_skb = skb;
707                                 ctx->tx_rem_sign = sign;
708                                 skb = NULL;
709                                 ready2send = 1;
710                         }
711                         break;
712                 }
713
714                 /* calculate frame number withing this NDP */
715                 ndplen = le16_to_cpu(ndp16->wLength);
716                 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
717
718                 /* OK, add this skb */
719                 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
720                 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
721                 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
722                 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
723                 dev_kfree_skb_any(skb);
724                 skb = NULL;
725
726                 /* send now if this NDP is full */
727                 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
728                         ready2send = 1;
729                         break;
730                 }
731         }
732
733         /* free up any dangling skb */
734         if (skb != NULL) {
735                 dev_kfree_skb_any(skb);
736                 skb = NULL;
737                 dev->net->stats.tx_dropped++;
738         }
739
740         ctx->tx_curr_frame_num = n;
741
742         if (n == 0) {
743                 /* wait for more frames */
744                 /* push variables */
745                 ctx->tx_curr_skb = skb_out;
746                 goto exit_no_skb;
747
748         } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0)) {
749                 /* wait for more frames */
750                 /* push variables */
751                 ctx->tx_curr_skb = skb_out;
752                 /* set the pending count */
753                 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
754                         ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
755                 goto exit_no_skb;
756
757         } else {
758                 /* frame goes out */
759                 /* variables will be reset at next call */
760         }
761
762         /* If collected data size is less or equal CDC_NCM_MIN_TX_PKT
763          * bytes, we send buffers as it is. If we get more data, it
764          * would be more efficient for USB HS mobile device with DMA
765          * engine to receive a full size NTB, than canceling DMA
766          * transfer and receiving a short packet.
767          *
768          * This optimization support is pointless if we end up sending
769          * a ZLP after full sized NTBs.
770          */
771         if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
772             skb_out->len > CDC_NCM_MIN_TX_PKT)
773                 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
774                        ctx->tx_max - skb_out->len);
775         else if ((skb_out->len % dev->maxpacket) == 0)
776                 *skb_put(skb_out, 1) = 0;       /* force short packet */
777
778         /* set final frame length */
779         nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
780         nth16->wBlockLength = cpu_to_le16(skb_out->len);
781
782         /* return skb */
783         ctx->tx_curr_skb = NULL;
784         dev->net->stats.tx_packets += ctx->tx_curr_frame_num;
785         return skb_out;
786
787 exit_no_skb:
788         /* Start timer, if there is a remaining skb */
789         if (ctx->tx_curr_skb != NULL)
790                 cdc_ncm_tx_timeout_start(ctx);
791         return NULL;
792 }
793 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
794
795 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
796 {
797         /* start timer, if not already started */
798         if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
799                 hrtimer_start(&ctx->tx_timer,
800                                 ktime_set(0, CDC_NCM_TIMER_INTERVAL),
801                                 HRTIMER_MODE_REL);
802 }
803
804 static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
805 {
806         struct cdc_ncm_ctx *ctx =
807                         container_of(timer, struct cdc_ncm_ctx, tx_timer);
808
809         if (!atomic_read(&ctx->stop))
810                 tasklet_schedule(&ctx->bh);
811         return HRTIMER_NORESTART;
812 }
813
814 static void cdc_ncm_txpath_bh(unsigned long param)
815 {
816         struct usbnet *dev = (struct usbnet *)param;
817         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
818
819         spin_lock_bh(&ctx->mtx);
820         if (ctx->tx_timer_pending != 0) {
821                 ctx->tx_timer_pending--;
822                 cdc_ncm_tx_timeout_start(ctx);
823                 spin_unlock_bh(&ctx->mtx);
824         } else if (dev->net != NULL) {
825                 spin_unlock_bh(&ctx->mtx);
826                 netif_tx_lock_bh(dev->net);
827                 usbnet_start_xmit(NULL, dev->net);
828                 netif_tx_unlock_bh(dev->net);
829         } else {
830                 spin_unlock_bh(&ctx->mtx);
831         }
832 }
833
834 static struct sk_buff *
835 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
836 {
837         struct sk_buff *skb_out;
838         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
839
840         /*
841          * The Ethernet API we are using does not support transmitting
842          * multiple Ethernet frames in a single call. This driver will
843          * accumulate multiple Ethernet frames and send out a larger
844          * USB frame when the USB buffer is full or when a single jiffies
845          * timeout happens.
846          */
847         if (ctx == NULL)
848                 goto error;
849
850         spin_lock_bh(&ctx->mtx);
851         skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
852         spin_unlock_bh(&ctx->mtx);
853         return skb_out;
854
855 error:
856         if (skb != NULL)
857                 dev_kfree_skb_any(skb);
858
859         return NULL;
860 }
861
862 /* verify NTB header and return offset of first NDP, or negative error */
863 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
864 {
865         struct usbnet *dev = netdev_priv(skb_in->dev);
866         struct usb_cdc_ncm_nth16 *nth16;
867         int len;
868         int ret = -EINVAL;
869
870         if (ctx == NULL)
871                 goto error;
872
873         if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
874                                         sizeof(struct usb_cdc_ncm_ndp16))) {
875                 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
876                 goto error;
877         }
878
879         nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
880
881         if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
882                 netif_dbg(dev, rx_err, dev->net,
883                           "invalid NTH16 signature <%#010x>\n",
884                           le32_to_cpu(nth16->dwSignature));
885                 goto error;
886         }
887
888         len = le16_to_cpu(nth16->wBlockLength);
889         if (len > ctx->rx_max) {
890                 netif_dbg(dev, rx_err, dev->net,
891                           "unsupported NTB block length %u/%u\n", len,
892                           ctx->rx_max);
893                 goto error;
894         }
895
896         if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
897             (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
898             !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
899                 netif_dbg(dev, rx_err, dev->net,
900                           "sequence number glitch prev=%d curr=%d\n",
901                           ctx->rx_seq, le16_to_cpu(nth16->wSequence));
902         }
903         ctx->rx_seq = le16_to_cpu(nth16->wSequence);
904
905         ret = le16_to_cpu(nth16->wNdpIndex);
906 error:
907         return ret;
908 }
909 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
910
911 /* verify NDP header and return number of datagrams, or negative error */
912 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
913 {
914         struct usbnet *dev = netdev_priv(skb_in->dev);
915         struct usb_cdc_ncm_ndp16 *ndp16;
916         int ret = -EINVAL;
917
918         if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
919                 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset  <%u>\n",
920                           ndpoffset);
921                 goto error;
922         }
923         ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
924
925         if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
926                 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
927                           le16_to_cpu(ndp16->wLength));
928                 goto error;
929         }
930
931         ret = ((le16_to_cpu(ndp16->wLength) -
932                                         sizeof(struct usb_cdc_ncm_ndp16)) /
933                                         sizeof(struct usb_cdc_ncm_dpe16));
934         ret--; /* we process NDP entries except for the last one */
935
936         if ((sizeof(struct usb_cdc_ncm_ndp16) +
937              ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
938                 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
939                 ret = -EINVAL;
940         }
941
942 error:
943         return ret;
944 }
945 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
946
947 static int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
948 {
949         struct sk_buff *skb;
950         struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
951         int len;
952         int nframes;
953         int x;
954         int offset;
955         struct usb_cdc_ncm_ndp16 *ndp16;
956         struct usb_cdc_ncm_dpe16 *dpe16;
957         int ndpoffset;
958         int loopcount = 50; /* arbitrary max preventing infinite loop */
959
960         ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
961         if (ndpoffset < 0)
962                 goto error;
963
964 next_ndp:
965         nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
966         if (nframes < 0)
967                 goto error;
968
969         ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
970
971         if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
972                 netif_dbg(dev, rx_err, dev->net,
973                           "invalid DPT16 signature <%#010x>\n",
974                           le32_to_cpu(ndp16->dwSignature));
975                 goto err_ndp;
976         }
977         dpe16 = ndp16->dpe16;
978
979         for (x = 0; x < nframes; x++, dpe16++) {
980                 offset = le16_to_cpu(dpe16->wDatagramIndex);
981                 len = le16_to_cpu(dpe16->wDatagramLength);
982
983                 /*
984                  * CDC NCM ch. 3.7
985                  * All entries after first NULL entry are to be ignored
986                  */
987                 if ((offset == 0) || (len == 0)) {
988                         if (!x)
989                                 goto err_ndp; /* empty NTB */
990                         break;
991                 }
992
993                 /* sanity checking */
994                 if (((offset + len) > skb_in->len) ||
995                                 (len > ctx->rx_max) || (len < ETH_HLEN)) {
996                         netif_dbg(dev, rx_err, dev->net,
997                                   "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
998                                   x, offset, len, skb_in);
999                         if (!x)
1000                                 goto err_ndp;
1001                         break;
1002
1003                 } else {
1004                         skb = skb_clone(skb_in, GFP_ATOMIC);
1005                         if (!skb)
1006                                 goto error;
1007                         skb->len = len;
1008                         skb->data = ((u8 *)skb_in->data) + offset;
1009                         skb_set_tail_pointer(skb, len);
1010                         usbnet_skb_return(dev, skb);
1011                 }
1012         }
1013 err_ndp:
1014         /* are there more NDPs to process? */
1015         ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1016         if (ndpoffset && loopcount--)
1017                 goto next_ndp;
1018
1019         return 1;
1020 error:
1021         return 0;
1022 }
1023
1024 static void
1025 cdc_ncm_speed_change(struct usbnet *dev,
1026                      struct usb_cdc_speed_change *data)
1027 {
1028         uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1029         uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1030
1031         /*
1032          * Currently the USB-NET API does not support reporting the actual
1033          * device speed. Do print it instead.
1034          */
1035         if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1036                 netif_info(dev, link, dev->net,
1037                        "%u mbit/s downlink %u mbit/s uplink\n",
1038                        (unsigned int)(rx_speed / 1000000U),
1039                        (unsigned int)(tx_speed / 1000000U));
1040         } else {
1041                 netif_info(dev, link, dev->net,
1042                        "%u kbit/s downlink %u kbit/s uplink\n",
1043                        (unsigned int)(rx_speed / 1000U),
1044                        (unsigned int)(tx_speed / 1000U));
1045         }
1046 }
1047
1048 static 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)) {
1060                 cdc_ncm_speed_change(dev,
1061                       (struct usb_cdc_speed_change *)urb->transfer_buffer);
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                  */
1074                 ctx->connected = le16_to_cpu(event->wValue);
1075                 netif_info(dev, link, dev->net,
1076                            "network connection: %sconnected\n",
1077                            ctx->connected ? "" : "dis");
1078                 usbnet_link_change(dev, ctx->connected, 0);
1079                 break;
1080
1081         case USB_CDC_NOTIFY_SPEED_CHANGE:
1082                 if (urb->actual_length < (sizeof(*event) +
1083                                         sizeof(struct usb_cdc_speed_change)))
1084                         set_bit(EVENT_STS_SPLIT, &dev->flags);
1085                 else
1086                         cdc_ncm_speed_change(dev,
1087                                              (struct usb_cdc_speed_change *)&event[1]);
1088                 break;
1089
1090         default:
1091                 dev_dbg(&dev->udev->dev,
1092                         "NCM: unexpected notification 0x%02x!\n",
1093                         event->bNotificationType);
1094                 break;
1095         }
1096 }
1097
1098 static 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
1109 static const struct driver_info cdc_ncm_info = {
1110         .description = "CDC NCM",
1111         .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1112         .bind = cdc_ncm_bind,
1113         .unbind = cdc_ncm_unbind,
1114         .check_connect = cdc_ncm_check_connect,
1115         .manage_power = usbnet_manage_power,
1116         .status = cdc_ncm_status,
1117         .rx_fixup = cdc_ncm_rx_fixup,
1118         .tx_fixup = cdc_ncm_tx_fixup,
1119 };
1120
1121 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1122 static 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,
1129         .manage_power = usbnet_manage_power,
1130         .status = cdc_ncm_status,
1131         .rx_fixup = cdc_ncm_rx_fixup,
1132         .tx_fixup = cdc_ncm_tx_fixup,
1133 };
1134
1135 /* Same as wwan_info, but with FLAG_NOARP  */
1136 static 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
1149 static 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
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
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
1188         /* Huawei NCM devices disguised as vendor specific */
1189         { USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x16),
1190           .driver_info = (unsigned long)&wwan_info,
1191         },
1192         { USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x46),
1193           .driver_info = (unsigned long)&wwan_info,
1194         },
1195         { USB_VENDOR_AND_INTERFACE_INFO(0x12d1, 0xff, 0x02, 0x76),
1196           .driver_info = (unsigned long)&wwan_info,
1197         },
1198
1199         /* Infineon(now Intel) HSPA Modem platform */
1200         { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1201                 USB_CLASS_COMM,
1202                 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1203           .driver_info = (unsigned long)&wwan_noarp_info,
1204         },
1205
1206         /* Generic CDC-NCM devices */
1207         { USB_INTERFACE_INFO(USB_CLASS_COMM,
1208                 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1209                 .driver_info = (unsigned long)&cdc_ncm_info,
1210         },
1211         {
1212         },
1213 };
1214 MODULE_DEVICE_TABLE(usb, cdc_devs);
1215
1216 static struct usb_driver cdc_ncm_driver = {
1217         .name = "cdc_ncm",
1218         .id_table = cdc_devs,
1219         .probe = usbnet_probe,
1220         .disconnect = usbnet_disconnect,
1221         .suspend = usbnet_suspend,
1222         .resume = usbnet_resume,
1223         .reset_resume = usbnet_resume,
1224         .supports_autosuspend = 1,
1225         .disable_hub_initiated_lpm = 1,
1226 };
1227
1228 module_usb_driver(cdc_ncm_driver);
1229
1230 MODULE_AUTHOR("Hans Petter Selasky");
1231 MODULE_DESCRIPTION("USB CDC NCM host driver");
1232 MODULE_LICENSE("Dual BSD/GPL");