Loading...
1/*
2 * cdc_ncm.c
3 *
4 * Copyright (C) ST-Ericsson 2010-2011
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/timer.h>
51#include <linux/spinlock.h>
52#include <linux/atomic.h>
53#include <linux/usb/usbnet.h>
54#include <linux/usb/cdc.h>
55
56#define DRIVER_VERSION "04-Aug-2011"
57
58/* CDC NCM subclass 3.2.1 */
59#define USB_CDC_NCM_NDP16_LENGTH_MIN 0x10
60
61/* Maximum NTB length */
62#define CDC_NCM_NTB_MAX_SIZE_TX 16384 /* bytes */
63#define CDC_NCM_NTB_MAX_SIZE_RX 16384 /* bytes */
64
65/* Minimum value for MaxDatagramSize, ch. 6.2.9 */
66#define CDC_NCM_MIN_DATAGRAM_SIZE 1514 /* bytes */
67
68#define CDC_NCM_MIN_TX_PKT 512 /* bytes */
69
70/* Default value for MaxDatagramSize */
71#define CDC_NCM_MAX_DATAGRAM_SIZE 2048 /* bytes */
72
73/*
74 * Maximum amount of datagrams in NCM Datagram Pointer Table, not counting
75 * the last NULL entry. Any additional datagrams in NTB would be discarded.
76 */
77#define CDC_NCM_DPT_DATAGRAMS_MAX 32
78
79/* Maximum amount of IN datagrams in NTB */
80#define CDC_NCM_DPT_DATAGRAMS_IN_MAX 0 /* unlimited */
81
82/* Restart the timer, if amount of datagrams is less than given value */
83#define CDC_NCM_RESTART_TIMER_DATAGRAM_CNT 3
84
85/* The following macro defines the minimum header space */
86#define CDC_NCM_MIN_HDR_SIZE \
87 (sizeof(struct usb_cdc_ncm_nth16) + sizeof(struct usb_cdc_ncm_ndp16) + \
88 (CDC_NCM_DPT_DATAGRAMS_MAX + 1) * sizeof(struct usb_cdc_ncm_dpe16))
89
90struct cdc_ncm_data {
91 struct usb_cdc_ncm_nth16 nth16;
92 struct usb_cdc_ncm_ndp16 ndp16;
93 struct usb_cdc_ncm_dpe16 dpe16[CDC_NCM_DPT_DATAGRAMS_MAX + 1];
94};
95
96struct cdc_ncm_ctx {
97 struct cdc_ncm_data rx_ncm;
98 struct cdc_ncm_data tx_ncm;
99 struct usb_cdc_ncm_ntb_parameters ncm_parm;
100 struct timer_list tx_timer;
101
102 const struct usb_cdc_ncm_desc *func_desc;
103 const struct usb_cdc_header_desc *header_desc;
104 const struct usb_cdc_union_desc *union_desc;
105 const struct usb_cdc_ether_desc *ether_desc;
106
107 struct net_device *netdev;
108 struct usb_device *udev;
109 struct usb_host_endpoint *in_ep;
110 struct usb_host_endpoint *out_ep;
111 struct usb_host_endpoint *status_ep;
112 struct usb_interface *intf;
113 struct usb_interface *control;
114 struct usb_interface *data;
115
116 struct sk_buff *tx_curr_skb;
117 struct sk_buff *tx_rem_skb;
118
119 spinlock_t mtx;
120
121 u32 tx_timer_pending;
122 u32 tx_curr_offset;
123 u32 tx_curr_last_offset;
124 u32 tx_curr_frame_num;
125 u32 rx_speed;
126 u32 tx_speed;
127 u32 rx_max;
128 u32 tx_max;
129 u32 max_datagram_size;
130 u16 tx_max_datagrams;
131 u16 tx_remainder;
132 u16 tx_modulus;
133 u16 tx_ndp_modulus;
134 u16 tx_seq;
135 u16 connected;
136};
137
138static void cdc_ncm_tx_timeout(unsigned long arg);
139static const struct driver_info cdc_ncm_info;
140static struct usb_driver cdc_ncm_driver;
141static struct ethtool_ops cdc_ncm_ethtool_ops;
142
143static const struct usb_device_id cdc_devs[] = {
144 { USB_INTERFACE_INFO(USB_CLASS_COMM,
145 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
146 .driver_info = (unsigned long)&cdc_ncm_info,
147 },
148 {
149 },
150};
151
152MODULE_DEVICE_TABLE(usb, cdc_devs);
153
154static void
155cdc_ncm_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
156{
157 struct usbnet *dev = netdev_priv(net);
158
159 strncpy(info->driver, dev->driver_name, sizeof(info->driver));
160 strncpy(info->version, DRIVER_VERSION, sizeof(info->version));
161 strncpy(info->fw_version, dev->driver_info->description,
162 sizeof(info->fw_version));
163 usb_make_path(dev->udev, info->bus_info, sizeof(info->bus_info));
164}
165
166static u8 cdc_ncm_setup(struct cdc_ncm_ctx *ctx)
167{
168 u32 val;
169 u8 flags;
170 u8 iface_no;
171 int err;
172 u16 ntb_fmt_supported;
173
174 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
175
176 err = usb_control_msg(ctx->udev,
177 usb_rcvctrlpipe(ctx->udev, 0),
178 USB_CDC_GET_NTB_PARAMETERS,
179 USB_TYPE_CLASS | USB_DIR_IN
180 | USB_RECIP_INTERFACE,
181 0, iface_no, &ctx->ncm_parm,
182 sizeof(ctx->ncm_parm), 10000);
183 if (err < 0) {
184 pr_debug("failed GET_NTB_PARAMETERS\n");
185 return 1;
186 }
187
188 /* read correct set of parameters according to device mode */
189 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
190 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
191 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
192 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
193 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
194 /* devices prior to NCM Errata shall set this field to zero */
195 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
196 ntb_fmt_supported = le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported);
197
198 if (ctx->func_desc != NULL)
199 flags = ctx->func_desc->bmNetworkCapabilities;
200 else
201 flags = 0;
202
203 pr_debug("dwNtbInMaxSize=%u dwNtbOutMaxSize=%u "
204 "wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u "
205 "wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
206 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
207 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, flags);
208
209 /* max count of tx datagrams */
210 if ((ctx->tx_max_datagrams == 0) ||
211 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
212 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
213
214 /* verify maximum size of received NTB in bytes */
215 if (ctx->rx_max < USB_CDC_NCM_NTB_MIN_IN_SIZE) {
216 pr_debug("Using min receive length=%d\n",
217 USB_CDC_NCM_NTB_MIN_IN_SIZE);
218 ctx->rx_max = USB_CDC_NCM_NTB_MIN_IN_SIZE;
219 }
220
221 if (ctx->rx_max > CDC_NCM_NTB_MAX_SIZE_RX) {
222 pr_debug("Using default maximum receive length=%d\n",
223 CDC_NCM_NTB_MAX_SIZE_RX);
224 ctx->rx_max = CDC_NCM_NTB_MAX_SIZE_RX;
225 }
226
227 /* inform device about NTB input size changes */
228 if (ctx->rx_max != le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize)) {
229
230 if (flags & USB_CDC_NCM_NCAP_NTB_INPUT_SIZE) {
231 struct usb_cdc_ncm_ndp_input_size *ndp_in_sz;
232
233 ndp_in_sz = kzalloc(sizeof(*ndp_in_sz), GFP_KERNEL);
234 if (!ndp_in_sz) {
235 err = -ENOMEM;
236 goto size_err;
237 }
238
239 err = usb_control_msg(ctx->udev,
240 usb_sndctrlpipe(ctx->udev, 0),
241 USB_CDC_SET_NTB_INPUT_SIZE,
242 USB_TYPE_CLASS | USB_DIR_OUT
243 | USB_RECIP_INTERFACE,
244 0, iface_no, ndp_in_sz, 8, 1000);
245 kfree(ndp_in_sz);
246 } else {
247 __le32 *dwNtbInMaxSize;
248 dwNtbInMaxSize = kzalloc(sizeof(*dwNtbInMaxSize),
249 GFP_KERNEL);
250 if (!dwNtbInMaxSize) {
251 err = -ENOMEM;
252 goto size_err;
253 }
254 *dwNtbInMaxSize = cpu_to_le32(ctx->rx_max);
255
256 err = usb_control_msg(ctx->udev,
257 usb_sndctrlpipe(ctx->udev, 0),
258 USB_CDC_SET_NTB_INPUT_SIZE,
259 USB_TYPE_CLASS | USB_DIR_OUT
260 | USB_RECIP_INTERFACE,
261 0, iface_no, dwNtbInMaxSize, 4, 1000);
262 kfree(dwNtbInMaxSize);
263 }
264size_err:
265 if (err < 0)
266 pr_debug("Setting NTB Input Size failed\n");
267 }
268
269 /* verify maximum size of transmitted NTB in bytes */
270 if ((ctx->tx_max <
271 (CDC_NCM_MIN_HDR_SIZE + CDC_NCM_MIN_DATAGRAM_SIZE)) ||
272 (ctx->tx_max > CDC_NCM_NTB_MAX_SIZE_TX)) {
273 pr_debug("Using default maximum transmit length=%d\n",
274 CDC_NCM_NTB_MAX_SIZE_TX);
275 ctx->tx_max = CDC_NCM_NTB_MAX_SIZE_TX;
276 }
277
278 /*
279 * verify that the structure alignment is:
280 * - power of two
281 * - not greater than the maximum transmit length
282 * - not less than four bytes
283 */
284 val = ctx->tx_ndp_modulus;
285
286 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
287 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
288 pr_debug("Using default alignment: 4 bytes\n");
289 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
290 }
291
292 /*
293 * verify that the payload alignment is:
294 * - power of two
295 * - not greater than the maximum transmit length
296 * - not less than four bytes
297 */
298 val = ctx->tx_modulus;
299
300 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
301 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
302 pr_debug("Using default transmit modulus: 4 bytes\n");
303 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
304 }
305
306 /* verify the payload remainder */
307 if (ctx->tx_remainder >= ctx->tx_modulus) {
308 pr_debug("Using default transmit remainder: 0 bytes\n");
309 ctx->tx_remainder = 0;
310 }
311
312 /* adjust TX-remainder according to NCM specification. */
313 ctx->tx_remainder = ((ctx->tx_remainder - ETH_HLEN) &
314 (ctx->tx_modulus - 1));
315
316 /* additional configuration */
317
318 /* set CRC Mode */
319 if (flags & USB_CDC_NCM_NCAP_CRC_MODE) {
320 err = usb_control_msg(ctx->udev, usb_sndctrlpipe(ctx->udev, 0),
321 USB_CDC_SET_CRC_MODE,
322 USB_TYPE_CLASS | USB_DIR_OUT
323 | USB_RECIP_INTERFACE,
324 USB_CDC_NCM_CRC_NOT_APPENDED,
325 iface_no, NULL, 0, 1000);
326 if (err < 0)
327 pr_debug("Setting CRC mode off failed\n");
328 }
329
330 /* set NTB format, if both formats are supported */
331 if (ntb_fmt_supported & USB_CDC_NCM_NTH32_SIGN) {
332 err = usb_control_msg(ctx->udev, usb_sndctrlpipe(ctx->udev, 0),
333 USB_CDC_SET_NTB_FORMAT, USB_TYPE_CLASS
334 | USB_DIR_OUT | USB_RECIP_INTERFACE,
335 USB_CDC_NCM_NTB16_FORMAT,
336 iface_no, NULL, 0, 1000);
337 if (err < 0)
338 pr_debug("Setting NTB format to 16-bit failed\n");
339 }
340
341 ctx->max_datagram_size = CDC_NCM_MIN_DATAGRAM_SIZE;
342
343 /* set Max Datagram Size (MTU) */
344 if (flags & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE) {
345 __le16 *max_datagram_size;
346 u16 eth_max_sz = le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
347
348 max_datagram_size = kzalloc(sizeof(*max_datagram_size),
349 GFP_KERNEL);
350 if (!max_datagram_size) {
351 err = -ENOMEM;
352 goto max_dgram_err;
353 }
354
355 err = usb_control_msg(ctx->udev, usb_rcvctrlpipe(ctx->udev, 0),
356 USB_CDC_GET_MAX_DATAGRAM_SIZE,
357 USB_TYPE_CLASS | USB_DIR_IN
358 | USB_RECIP_INTERFACE,
359 0, iface_no, max_datagram_size,
360 2, 1000);
361 if (err < 0) {
362 pr_debug("GET_MAX_DATAGRAM_SIZE failed, use size=%u\n",
363 CDC_NCM_MIN_DATAGRAM_SIZE);
364 kfree(max_datagram_size);
365 } else {
366 ctx->max_datagram_size =
367 le16_to_cpu(*max_datagram_size);
368 /* Check Eth descriptor value */
369 if (eth_max_sz < CDC_NCM_MAX_DATAGRAM_SIZE) {
370 if (ctx->max_datagram_size > eth_max_sz)
371 ctx->max_datagram_size = eth_max_sz;
372 } else {
373 if (ctx->max_datagram_size >
374 CDC_NCM_MAX_DATAGRAM_SIZE)
375 ctx->max_datagram_size =
376 CDC_NCM_MAX_DATAGRAM_SIZE;
377 }
378
379 if (ctx->max_datagram_size < CDC_NCM_MIN_DATAGRAM_SIZE)
380 ctx->max_datagram_size =
381 CDC_NCM_MIN_DATAGRAM_SIZE;
382
383 /* if value changed, update device */
384 err = usb_control_msg(ctx->udev,
385 usb_sndctrlpipe(ctx->udev, 0),
386 USB_CDC_SET_MAX_DATAGRAM_SIZE,
387 USB_TYPE_CLASS | USB_DIR_OUT
388 | USB_RECIP_INTERFACE,
389 0,
390 iface_no, max_datagram_size,
391 2, 1000);
392 kfree(max_datagram_size);
393max_dgram_err:
394 if (err < 0)
395 pr_debug("SET_MAX_DATAGRAM_SIZE failed\n");
396 }
397
398 }
399
400 if (ctx->netdev->mtu != (ctx->max_datagram_size - ETH_HLEN))
401 ctx->netdev->mtu = ctx->max_datagram_size - ETH_HLEN;
402
403 return 0;
404}
405
406static void
407cdc_ncm_find_endpoints(struct cdc_ncm_ctx *ctx, struct usb_interface *intf)
408{
409 struct usb_host_endpoint *e;
410 u8 ep;
411
412 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
413
414 e = intf->cur_altsetting->endpoint + ep;
415 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
416 case USB_ENDPOINT_XFER_INT:
417 if (usb_endpoint_dir_in(&e->desc)) {
418 if (ctx->status_ep == NULL)
419 ctx->status_ep = e;
420 }
421 break;
422
423 case USB_ENDPOINT_XFER_BULK:
424 if (usb_endpoint_dir_in(&e->desc)) {
425 if (ctx->in_ep == NULL)
426 ctx->in_ep = e;
427 } else {
428 if (ctx->out_ep == NULL)
429 ctx->out_ep = e;
430 }
431 break;
432
433 default:
434 break;
435 }
436 }
437}
438
439static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
440{
441 if (ctx == NULL)
442 return;
443
444 del_timer_sync(&ctx->tx_timer);
445
446 if (ctx->tx_rem_skb != NULL) {
447 dev_kfree_skb_any(ctx->tx_rem_skb);
448 ctx->tx_rem_skb = NULL;
449 }
450
451 if (ctx->tx_curr_skb != NULL) {
452 dev_kfree_skb_any(ctx->tx_curr_skb);
453 ctx->tx_curr_skb = NULL;
454 }
455
456 kfree(ctx);
457}
458
459static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
460{
461 struct cdc_ncm_ctx *ctx;
462 struct usb_driver *driver;
463 u8 *buf;
464 int len;
465 int temp;
466 u8 iface_no;
467
468 ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
469 if (ctx == NULL)
470 return -ENODEV;
471
472 memset(ctx, 0, sizeof(*ctx));
473
474 init_timer(&ctx->tx_timer);
475 spin_lock_init(&ctx->mtx);
476 ctx->netdev = dev->net;
477
478 /* store ctx pointer in device data field */
479 dev->data[0] = (unsigned long)ctx;
480
481 /* get some pointers */
482 driver = driver_of(intf);
483 buf = intf->cur_altsetting->extra;
484 len = intf->cur_altsetting->extralen;
485
486 ctx->udev = dev->udev;
487 ctx->intf = intf;
488
489 /* parse through descriptors associated with control interface */
490 while ((len > 0) && (buf[0] > 2) && (buf[0] <= len)) {
491
492 if (buf[1] != USB_DT_CS_INTERFACE)
493 goto advance;
494
495 switch (buf[2]) {
496 case USB_CDC_UNION_TYPE:
497 if (buf[0] < sizeof(*(ctx->union_desc)))
498 break;
499
500 ctx->union_desc =
501 (const struct usb_cdc_union_desc *)buf;
502
503 ctx->control = usb_ifnum_to_if(dev->udev,
504 ctx->union_desc->bMasterInterface0);
505 ctx->data = usb_ifnum_to_if(dev->udev,
506 ctx->union_desc->bSlaveInterface0);
507 break;
508
509 case USB_CDC_ETHERNET_TYPE:
510 if (buf[0] < sizeof(*(ctx->ether_desc)))
511 break;
512
513 ctx->ether_desc =
514 (const struct usb_cdc_ether_desc *)buf;
515 dev->hard_mtu =
516 le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
517
518 if (dev->hard_mtu < CDC_NCM_MIN_DATAGRAM_SIZE)
519 dev->hard_mtu = CDC_NCM_MIN_DATAGRAM_SIZE;
520 else if (dev->hard_mtu > CDC_NCM_MAX_DATAGRAM_SIZE)
521 dev->hard_mtu = CDC_NCM_MAX_DATAGRAM_SIZE;
522 break;
523
524 case USB_CDC_NCM_TYPE:
525 if (buf[0] < sizeof(*(ctx->func_desc)))
526 break;
527
528 ctx->func_desc = (const struct usb_cdc_ncm_desc *)buf;
529 break;
530
531 default:
532 break;
533 }
534advance:
535 /* advance to next descriptor */
536 temp = buf[0];
537 buf += temp;
538 len -= temp;
539 }
540
541 /* check if we got everything */
542 if ((ctx->control == NULL) || (ctx->data == NULL) ||
543 (ctx->ether_desc == NULL) || (ctx->control != intf))
544 goto error;
545
546 /* claim interfaces, if any */
547 temp = usb_driver_claim_interface(driver, ctx->data, dev);
548 if (temp)
549 goto error;
550
551 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
552
553 /* reset data interface */
554 temp = usb_set_interface(dev->udev, iface_no, 0);
555 if (temp)
556 goto error2;
557
558 /* initialize data interface */
559 if (cdc_ncm_setup(ctx))
560 goto error2;
561
562 /* configure data interface */
563 temp = usb_set_interface(dev->udev, iface_no, 1);
564 if (temp)
565 goto error2;
566
567 cdc_ncm_find_endpoints(ctx, ctx->data);
568 cdc_ncm_find_endpoints(ctx, ctx->control);
569
570 if ((ctx->in_ep == NULL) || (ctx->out_ep == NULL) ||
571 (ctx->status_ep == NULL))
572 goto error2;
573
574 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
575
576 usb_set_intfdata(ctx->data, dev);
577 usb_set_intfdata(ctx->control, dev);
578 usb_set_intfdata(ctx->intf, dev);
579
580 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
581 if (temp)
582 goto error2;
583
584 dev_info(&dev->udev->dev, "MAC-Address: "
585 "0x%02x:0x%02x:0x%02x:0x%02x:0x%02x:0x%02x\n",
586 dev->net->dev_addr[0], dev->net->dev_addr[1],
587 dev->net->dev_addr[2], dev->net->dev_addr[3],
588 dev->net->dev_addr[4], dev->net->dev_addr[5]);
589
590 dev->in = usb_rcvbulkpipe(dev->udev,
591 ctx->in_ep->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
592 dev->out = usb_sndbulkpipe(dev->udev,
593 ctx->out_ep->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
594 dev->status = ctx->status_ep;
595 dev->rx_urb_size = ctx->rx_max;
596
597 /*
598 * We should get an event when network connection is "connected" or
599 * "disconnected". Set network connection in "disconnected" state
600 * (carrier is OFF) during attach, so the IP network stack does not
601 * start IPv6 negotiation and more.
602 */
603 netif_carrier_off(dev->net);
604 ctx->tx_speed = ctx->rx_speed = 0;
605 return 0;
606
607error2:
608 usb_set_intfdata(ctx->control, NULL);
609 usb_set_intfdata(ctx->data, NULL);
610 usb_driver_release_interface(driver, ctx->data);
611error:
612 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
613 dev->data[0] = 0;
614 dev_info(&dev->udev->dev, "bind() failure\n");
615 return -ENODEV;
616}
617
618static void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
619{
620 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
621 struct usb_driver *driver = driver_of(intf);
622
623 if (ctx == NULL)
624 return; /* no setup */
625
626 /* disconnect master --> disconnect slave */
627 if (intf == ctx->control && ctx->data) {
628 usb_set_intfdata(ctx->data, NULL);
629 usb_driver_release_interface(driver, ctx->data);
630 ctx->data = NULL;
631
632 } else if (intf == ctx->data && ctx->control) {
633 usb_set_intfdata(ctx->control, NULL);
634 usb_driver_release_interface(driver, ctx->control);
635 ctx->control = NULL;
636 }
637
638 usb_set_intfdata(ctx->intf, NULL);
639 cdc_ncm_free(ctx);
640}
641
642static void cdc_ncm_zero_fill(u8 *ptr, u32 first, u32 end, u32 max)
643{
644 if (first >= max)
645 return;
646 if (first >= end)
647 return;
648 if (end > max)
649 end = max;
650 memset(ptr + first, 0, end - first);
651}
652
653static struct sk_buff *
654cdc_ncm_fill_tx_frame(struct cdc_ncm_ctx *ctx, struct sk_buff *skb)
655{
656 struct sk_buff *skb_out;
657 u32 rem;
658 u32 offset;
659 u32 last_offset;
660 u16 n = 0, index;
661 u8 ready2send = 0;
662
663 /* if there is a remaining skb, it gets priority */
664 if (skb != NULL)
665 swap(skb, ctx->tx_rem_skb);
666 else
667 ready2send = 1;
668
669 /*
670 * +----------------+
671 * | skb_out |
672 * +----------------+
673 * ^ offset
674 * ^ last_offset
675 */
676
677 /* check if we are resuming an OUT skb */
678 if (ctx->tx_curr_skb != NULL) {
679 /* pop variables */
680 skb_out = ctx->tx_curr_skb;
681 offset = ctx->tx_curr_offset;
682 last_offset = ctx->tx_curr_last_offset;
683 n = ctx->tx_curr_frame_num;
684
685 } else {
686 /* reset variables */
687 skb_out = alloc_skb((ctx->tx_max + 1), GFP_ATOMIC);
688 if (skb_out == NULL) {
689 if (skb != NULL) {
690 dev_kfree_skb_any(skb);
691 ctx->netdev->stats.tx_dropped++;
692 }
693 goto exit_no_skb;
694 }
695
696 /* make room for NTH and NDP */
697 offset = ALIGN(sizeof(struct usb_cdc_ncm_nth16),
698 ctx->tx_ndp_modulus) +
699 sizeof(struct usb_cdc_ncm_ndp16) +
700 (ctx->tx_max_datagrams + 1) *
701 sizeof(struct usb_cdc_ncm_dpe16);
702
703 /* store last valid offset before alignment */
704 last_offset = offset;
705 /* align first Datagram offset correctly */
706 offset = ALIGN(offset, ctx->tx_modulus) + ctx->tx_remainder;
707 /* zero buffer till the first IP datagram */
708 cdc_ncm_zero_fill(skb_out->data, 0, offset, offset);
709 n = 0;
710 ctx->tx_curr_frame_num = 0;
711 }
712
713 for (; n < ctx->tx_max_datagrams; n++) {
714 /* check if end of transmit buffer is reached */
715 if (offset >= ctx->tx_max) {
716 ready2send = 1;
717 break;
718 }
719 /* compute maximum buffer size */
720 rem = ctx->tx_max - offset;
721
722 if (skb == NULL) {
723 skb = ctx->tx_rem_skb;
724 ctx->tx_rem_skb = NULL;
725
726 /* check for end of skb */
727 if (skb == NULL)
728 break;
729 }
730
731 if (skb->len > rem) {
732 if (n == 0) {
733 /* won't fit, MTU problem? */
734 dev_kfree_skb_any(skb);
735 skb = NULL;
736 ctx->netdev->stats.tx_dropped++;
737 } else {
738 /* no room for skb - store for later */
739 if (ctx->tx_rem_skb != NULL) {
740 dev_kfree_skb_any(ctx->tx_rem_skb);
741 ctx->netdev->stats.tx_dropped++;
742 }
743 ctx->tx_rem_skb = skb;
744 skb = NULL;
745 ready2send = 1;
746 }
747 break;
748 }
749
750 memcpy(((u8 *)skb_out->data) + offset, skb->data, skb->len);
751
752 ctx->tx_ncm.dpe16[n].wDatagramLength = cpu_to_le16(skb->len);
753 ctx->tx_ncm.dpe16[n].wDatagramIndex = cpu_to_le16(offset);
754
755 /* update offset */
756 offset += skb->len;
757
758 /* store last valid offset before alignment */
759 last_offset = offset;
760
761 /* align offset correctly */
762 offset = ALIGN(offset, ctx->tx_modulus) + ctx->tx_remainder;
763
764 /* zero padding */
765 cdc_ncm_zero_fill(skb_out->data, last_offset, offset,
766 ctx->tx_max);
767 dev_kfree_skb_any(skb);
768 skb = NULL;
769 }
770
771 /* free up any dangling skb */
772 if (skb != NULL) {
773 dev_kfree_skb_any(skb);
774 skb = NULL;
775 ctx->netdev->stats.tx_dropped++;
776 }
777
778 ctx->tx_curr_frame_num = n;
779
780 if (n == 0) {
781 /* wait for more frames */
782 /* push variables */
783 ctx->tx_curr_skb = skb_out;
784 ctx->tx_curr_offset = offset;
785 ctx->tx_curr_last_offset = last_offset;
786 goto exit_no_skb;
787
788 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0)) {
789 /* wait for more frames */
790 /* push variables */
791 ctx->tx_curr_skb = skb_out;
792 ctx->tx_curr_offset = offset;
793 ctx->tx_curr_last_offset = last_offset;
794 /* set the pending count */
795 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
796 ctx->tx_timer_pending = 2;
797 goto exit_no_skb;
798
799 } else {
800 /* frame goes out */
801 /* variables will be reset at next call */
802 }
803
804 /* check for overflow */
805 if (last_offset > ctx->tx_max)
806 last_offset = ctx->tx_max;
807
808 /* revert offset */
809 offset = last_offset;
810
811 /*
812 * If collected data size is less or equal CDC_NCM_MIN_TX_PKT bytes,
813 * we send buffers as it is. If we get more data, it would be more
814 * efficient for USB HS mobile device with DMA engine to receive a full
815 * size NTB, than canceling DMA transfer and receiving a short packet.
816 */
817 if (offset > CDC_NCM_MIN_TX_PKT)
818 offset = ctx->tx_max;
819
820 /* final zero padding */
821 cdc_ncm_zero_fill(skb_out->data, last_offset, offset, ctx->tx_max);
822
823 /* store last offset */
824 last_offset = offset;
825
826 if (((last_offset < ctx->tx_max) && ((last_offset %
827 le16_to_cpu(ctx->out_ep->desc.wMaxPacketSize)) == 0)) ||
828 (((last_offset == ctx->tx_max) && ((ctx->tx_max %
829 le16_to_cpu(ctx->out_ep->desc.wMaxPacketSize)) == 0)) &&
830 (ctx->tx_max < le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize)))) {
831 /* force short packet */
832 *(((u8 *)skb_out->data) + last_offset) = 0;
833 last_offset++;
834 }
835
836 /* zero the rest of the DPEs plus the last NULL entry */
837 for (; n <= CDC_NCM_DPT_DATAGRAMS_MAX; n++) {
838 ctx->tx_ncm.dpe16[n].wDatagramLength = 0;
839 ctx->tx_ncm.dpe16[n].wDatagramIndex = 0;
840 }
841
842 /* fill out 16-bit NTB header */
843 ctx->tx_ncm.nth16.dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
844 ctx->tx_ncm.nth16.wHeaderLength =
845 cpu_to_le16(sizeof(ctx->tx_ncm.nth16));
846 ctx->tx_ncm.nth16.wSequence = cpu_to_le16(ctx->tx_seq);
847 ctx->tx_ncm.nth16.wBlockLength = cpu_to_le16(last_offset);
848 index = ALIGN(sizeof(struct usb_cdc_ncm_nth16), ctx->tx_ndp_modulus);
849 ctx->tx_ncm.nth16.wNdpIndex = cpu_to_le16(index);
850
851 memcpy(skb_out->data, &(ctx->tx_ncm.nth16), sizeof(ctx->tx_ncm.nth16));
852 ctx->tx_seq++;
853
854 /* fill out 16-bit NDP table */
855 ctx->tx_ncm.ndp16.dwSignature =
856 cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN);
857 rem = sizeof(ctx->tx_ncm.ndp16) + ((ctx->tx_curr_frame_num + 1) *
858 sizeof(struct usb_cdc_ncm_dpe16));
859 ctx->tx_ncm.ndp16.wLength = cpu_to_le16(rem);
860 ctx->tx_ncm.ndp16.wNextNdpIndex = 0; /* reserved */
861
862 memcpy(((u8 *)skb_out->data) + index,
863 &(ctx->tx_ncm.ndp16),
864 sizeof(ctx->tx_ncm.ndp16));
865
866 memcpy(((u8 *)skb_out->data) + index + sizeof(ctx->tx_ncm.ndp16),
867 &(ctx->tx_ncm.dpe16),
868 (ctx->tx_curr_frame_num + 1) *
869 sizeof(struct usb_cdc_ncm_dpe16));
870
871 /* set frame length */
872 skb_put(skb_out, last_offset);
873
874 /* return skb */
875 ctx->tx_curr_skb = NULL;
876 return skb_out;
877
878exit_no_skb:
879 return NULL;
880}
881
882static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
883{
884 /* start timer, if not already started */
885 if (timer_pending(&ctx->tx_timer) == 0) {
886 ctx->tx_timer.function = &cdc_ncm_tx_timeout;
887 ctx->tx_timer.data = (unsigned long)ctx;
888 ctx->tx_timer.expires = jiffies + ((HZ + 999) / 1000);
889 add_timer(&ctx->tx_timer);
890 }
891}
892
893static void cdc_ncm_tx_timeout(unsigned long arg)
894{
895 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)arg;
896 u8 restart;
897
898 spin_lock(&ctx->mtx);
899 if (ctx->tx_timer_pending != 0) {
900 ctx->tx_timer_pending--;
901 restart = 1;
902 } else {
903 restart = 0;
904 }
905
906 spin_unlock(&ctx->mtx);
907
908 if (restart) {
909 spin_lock(&ctx->mtx);
910 cdc_ncm_tx_timeout_start(ctx);
911 spin_unlock(&ctx->mtx);
912 } else if (ctx->netdev != NULL) {
913 usbnet_start_xmit(NULL, ctx->netdev);
914 }
915}
916
917static struct sk_buff *
918cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
919{
920 struct sk_buff *skb_out;
921 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
922 u8 need_timer = 0;
923
924 /*
925 * The Ethernet API we are using does not support transmitting
926 * multiple Ethernet frames in a single call. This driver will
927 * accumulate multiple Ethernet frames and send out a larger
928 * USB frame when the USB buffer is full or when a single jiffies
929 * timeout happens.
930 */
931 if (ctx == NULL)
932 goto error;
933
934 spin_lock(&ctx->mtx);
935 skb_out = cdc_ncm_fill_tx_frame(ctx, skb);
936 if (ctx->tx_curr_skb != NULL)
937 need_timer = 1;
938
939 /* Start timer, if there is a remaining skb */
940 if (need_timer)
941 cdc_ncm_tx_timeout_start(ctx);
942
943 if (skb_out)
944 dev->net->stats.tx_packets += ctx->tx_curr_frame_num;
945
946 spin_unlock(&ctx->mtx);
947 return skb_out;
948
949error:
950 if (skb != NULL)
951 dev_kfree_skb_any(skb);
952
953 return NULL;
954}
955
956static int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
957{
958 struct sk_buff *skb;
959 struct cdc_ncm_ctx *ctx;
960 int sumlen;
961 int actlen;
962 int temp;
963 int nframes;
964 int x;
965 int offset;
966
967 ctx = (struct cdc_ncm_ctx *)dev->data[0];
968 if (ctx == NULL)
969 goto error;
970
971 actlen = skb_in->len;
972 sumlen = CDC_NCM_NTB_MAX_SIZE_RX;
973
974 if (actlen < (sizeof(ctx->rx_ncm.nth16) + sizeof(ctx->rx_ncm.ndp16))) {
975 pr_debug("frame too short\n");
976 goto error;
977 }
978
979 memcpy(&(ctx->rx_ncm.nth16), ((u8 *)skb_in->data),
980 sizeof(ctx->rx_ncm.nth16));
981
982 if (le32_to_cpu(ctx->rx_ncm.nth16.dwSignature) !=
983 USB_CDC_NCM_NTH16_SIGN) {
984 pr_debug("invalid NTH16 signature <%u>\n",
985 le32_to_cpu(ctx->rx_ncm.nth16.dwSignature));
986 goto error;
987 }
988
989 temp = le16_to_cpu(ctx->rx_ncm.nth16.wBlockLength);
990 if (temp > sumlen) {
991 pr_debug("unsupported NTB block length %u/%u\n", temp, sumlen);
992 goto error;
993 }
994
995 temp = le16_to_cpu(ctx->rx_ncm.nth16.wNdpIndex);
996 if ((temp + sizeof(ctx->rx_ncm.ndp16)) > actlen) {
997 pr_debug("invalid DPT16 index\n");
998 goto error;
999 }
1000
1001 memcpy(&(ctx->rx_ncm.ndp16), ((u8 *)skb_in->data) + temp,
1002 sizeof(ctx->rx_ncm.ndp16));
1003
1004 if (le32_to_cpu(ctx->rx_ncm.ndp16.dwSignature) !=
1005 USB_CDC_NCM_NDP16_NOCRC_SIGN) {
1006 pr_debug("invalid DPT16 signature <%u>\n",
1007 le32_to_cpu(ctx->rx_ncm.ndp16.dwSignature));
1008 goto error;
1009 }
1010
1011 if (le16_to_cpu(ctx->rx_ncm.ndp16.wLength) <
1012 USB_CDC_NCM_NDP16_LENGTH_MIN) {
1013 pr_debug("invalid DPT16 length <%u>\n",
1014 le32_to_cpu(ctx->rx_ncm.ndp16.dwSignature));
1015 goto error;
1016 }
1017
1018 nframes = ((le16_to_cpu(ctx->rx_ncm.ndp16.wLength) -
1019 sizeof(struct usb_cdc_ncm_ndp16)) /
1020 sizeof(struct usb_cdc_ncm_dpe16));
1021 nframes--; /* we process NDP entries except for the last one */
1022
1023 pr_debug("nframes = %u\n", nframes);
1024
1025 temp += sizeof(ctx->rx_ncm.ndp16);
1026
1027 if ((temp + nframes * (sizeof(struct usb_cdc_ncm_dpe16))) > actlen) {
1028 pr_debug("Invalid nframes = %d\n", nframes);
1029 goto error;
1030 }
1031
1032 if (nframes > CDC_NCM_DPT_DATAGRAMS_MAX) {
1033 pr_debug("Truncating number of frames from %u to %u\n",
1034 nframes, CDC_NCM_DPT_DATAGRAMS_MAX);
1035 nframes = CDC_NCM_DPT_DATAGRAMS_MAX;
1036 }
1037
1038 memcpy(&(ctx->rx_ncm.dpe16), ((u8 *)skb_in->data) + temp,
1039 nframes * (sizeof(struct usb_cdc_ncm_dpe16)));
1040
1041 for (x = 0; x < nframes; x++) {
1042 offset = le16_to_cpu(ctx->rx_ncm.dpe16[x].wDatagramIndex);
1043 temp = le16_to_cpu(ctx->rx_ncm.dpe16[x].wDatagramLength);
1044
1045 /*
1046 * CDC NCM ch. 3.7
1047 * All entries after first NULL entry are to be ignored
1048 */
1049 if ((offset == 0) || (temp == 0)) {
1050 if (!x)
1051 goto error; /* empty NTB */
1052 break;
1053 }
1054
1055 /* sanity checking */
1056 if (((offset + temp) > actlen) ||
1057 (temp > CDC_NCM_MAX_DATAGRAM_SIZE) || (temp < ETH_HLEN)) {
1058 pr_debug("invalid frame detected (ignored)"
1059 "offset[%u]=%u, length=%u, skb=%p\n",
1060 x, offset, temp, skb_in);
1061 if (!x)
1062 goto error;
1063 break;
1064
1065 } else {
1066 skb = skb_clone(skb_in, GFP_ATOMIC);
1067 if (!skb)
1068 goto error;
1069 skb->len = temp;
1070 skb->data = ((u8 *)skb_in->data) + offset;
1071 skb_set_tail_pointer(skb, temp);
1072 usbnet_skb_return(dev, skb);
1073 }
1074 }
1075 return 1;
1076error:
1077 return 0;
1078}
1079
1080static void
1081cdc_ncm_speed_change(struct cdc_ncm_ctx *ctx,
1082 struct usb_cdc_speed_change *data)
1083{
1084 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1085 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1086
1087 /*
1088 * Currently the USB-NET API does not support reporting the actual
1089 * device speed. Do print it instead.
1090 */
1091 if ((tx_speed != ctx->tx_speed) || (rx_speed != ctx->rx_speed)) {
1092 ctx->tx_speed = tx_speed;
1093 ctx->rx_speed = rx_speed;
1094
1095 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1096 printk(KERN_INFO KBUILD_MODNAME
1097 ": %s: %u mbit/s downlink "
1098 "%u mbit/s uplink\n",
1099 ctx->netdev->name,
1100 (unsigned int)(rx_speed / 1000000U),
1101 (unsigned int)(tx_speed / 1000000U));
1102 } else {
1103 printk(KERN_INFO KBUILD_MODNAME
1104 ": %s: %u kbit/s downlink "
1105 "%u kbit/s uplink\n",
1106 ctx->netdev->name,
1107 (unsigned int)(rx_speed / 1000U),
1108 (unsigned int)(tx_speed / 1000U));
1109 }
1110 }
1111}
1112
1113static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1114{
1115 struct cdc_ncm_ctx *ctx;
1116 struct usb_cdc_notification *event;
1117
1118 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1119
1120 if (urb->actual_length < sizeof(*event))
1121 return;
1122
1123 /* test for split data in 8-byte chunks */
1124 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1125 cdc_ncm_speed_change(ctx,
1126 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1127 return;
1128 }
1129
1130 event = urb->transfer_buffer;
1131
1132 switch (event->bNotificationType) {
1133 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1134 /*
1135 * According to the CDC NCM specification ch.7.1
1136 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1137 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1138 */
1139 ctx->connected = event->wValue;
1140
1141 printk(KERN_INFO KBUILD_MODNAME ": %s: network connection:"
1142 " %sconnected\n",
1143 ctx->netdev->name, ctx->connected ? "" : "dis");
1144
1145 if (ctx->connected)
1146 netif_carrier_on(dev->net);
1147 else {
1148 netif_carrier_off(dev->net);
1149 ctx->tx_speed = ctx->rx_speed = 0;
1150 }
1151 break;
1152
1153 case USB_CDC_NOTIFY_SPEED_CHANGE:
1154 if (urb->actual_length < (sizeof(*event) +
1155 sizeof(struct usb_cdc_speed_change)))
1156 set_bit(EVENT_STS_SPLIT, &dev->flags);
1157 else
1158 cdc_ncm_speed_change(ctx,
1159 (struct usb_cdc_speed_change *) &event[1]);
1160 break;
1161
1162 default:
1163 dev_err(&dev->udev->dev, "NCM: unexpected "
1164 "notification 0x%02x!\n", event->bNotificationType);
1165 break;
1166 }
1167}
1168
1169static int cdc_ncm_check_connect(struct usbnet *dev)
1170{
1171 struct cdc_ncm_ctx *ctx;
1172
1173 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1174 if (ctx == NULL)
1175 return 1; /* disconnected */
1176
1177 return !ctx->connected;
1178}
1179
1180static int
1181cdc_ncm_probe(struct usb_interface *udev, const struct usb_device_id *prod)
1182{
1183 return usbnet_probe(udev, prod);
1184}
1185
1186static void cdc_ncm_disconnect(struct usb_interface *intf)
1187{
1188 struct usbnet *dev = usb_get_intfdata(intf);
1189
1190 if (dev == NULL)
1191 return; /* already disconnected */
1192
1193 usbnet_disconnect(intf);
1194}
1195
1196static int cdc_ncm_manage_power(struct usbnet *dev, int status)
1197{
1198 dev->intf->needs_remote_wakeup = status;
1199 return 0;
1200}
1201
1202static const struct driver_info cdc_ncm_info = {
1203 .description = "CDC NCM",
1204 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET,
1205 .bind = cdc_ncm_bind,
1206 .unbind = cdc_ncm_unbind,
1207 .check_connect = cdc_ncm_check_connect,
1208 .manage_power = cdc_ncm_manage_power,
1209 .status = cdc_ncm_status,
1210 .rx_fixup = cdc_ncm_rx_fixup,
1211 .tx_fixup = cdc_ncm_tx_fixup,
1212};
1213
1214static struct usb_driver cdc_ncm_driver = {
1215 .name = "cdc_ncm",
1216 .id_table = cdc_devs,
1217 .probe = cdc_ncm_probe,
1218 .disconnect = cdc_ncm_disconnect,
1219 .suspend = usbnet_suspend,
1220 .resume = usbnet_resume,
1221 .reset_resume = usbnet_resume,
1222 .supports_autosuspend = 1,
1223};
1224
1225static struct ethtool_ops cdc_ncm_ethtool_ops = {
1226 .get_drvinfo = cdc_ncm_get_drvinfo,
1227 .get_link = usbnet_get_link,
1228 .get_msglevel = usbnet_get_msglevel,
1229 .set_msglevel = usbnet_set_msglevel,
1230 .get_settings = usbnet_get_settings,
1231 .set_settings = usbnet_set_settings,
1232 .nway_reset = usbnet_nway_reset,
1233};
1234
1235static int __init cdc_ncm_init(void)
1236{
1237 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION "\n");
1238 return usb_register(&cdc_ncm_driver);
1239}
1240
1241module_init(cdc_ncm_init);
1242
1243static void __exit cdc_ncm_exit(void)
1244{
1245 usb_deregister(&cdc_ncm_driver);
1246}
1247
1248module_exit(cdc_ncm_exit);
1249
1250MODULE_AUTHOR("Hans Petter Selasky");
1251MODULE_DESCRIPTION("USB CDC NCM host driver");
1252MODULE_LICENSE("Dual BSD/GPL");
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/docs/devclass_docs/NCM10_012011.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/netdevice.h>
43#include <linux/ctype.h>
44#include <linux/etherdevice.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)
57static bool prefer_mbim = true;
58#else
59static bool prefer_mbim;
60#endif
61module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
62MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
63
64static void cdc_ncm_txpath_bh(unsigned long param);
65static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx);
66static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *hr_timer);
67static struct usb_driver cdc_ncm_driver;
68
69struct cdc_ncm_stats {
70 char stat_string[ETH_GSTRING_LEN];
71 int sizeof_stat;
72 int stat_offset;
73};
74
75#define CDC_NCM_STAT(str, m) { \
76 .stat_string = str, \
77 .sizeof_stat = sizeof(((struct cdc_ncm_ctx *)0)->m), \
78 .stat_offset = offsetof(struct cdc_ncm_ctx, m) }
79#define CDC_NCM_SIMPLE_STAT(m) CDC_NCM_STAT(__stringify(m), m)
80
81static const struct cdc_ncm_stats cdc_ncm_gstrings_stats[] = {
82 CDC_NCM_SIMPLE_STAT(tx_reason_ntb_full),
83 CDC_NCM_SIMPLE_STAT(tx_reason_ndp_full),
84 CDC_NCM_SIMPLE_STAT(tx_reason_timeout),
85 CDC_NCM_SIMPLE_STAT(tx_reason_max_datagram),
86 CDC_NCM_SIMPLE_STAT(tx_overhead),
87 CDC_NCM_SIMPLE_STAT(tx_ntbs),
88 CDC_NCM_SIMPLE_STAT(rx_overhead),
89 CDC_NCM_SIMPLE_STAT(rx_ntbs),
90};
91
92static int cdc_ncm_get_sset_count(struct net_device __always_unused *netdev, int sset)
93{
94 switch (sset) {
95 case ETH_SS_STATS:
96 return ARRAY_SIZE(cdc_ncm_gstrings_stats);
97 default:
98 return -EOPNOTSUPP;
99 }
100}
101
102static void cdc_ncm_get_ethtool_stats(struct net_device *netdev,
103 struct ethtool_stats __always_unused *stats,
104 u64 *data)
105{
106 struct usbnet *dev = netdev_priv(netdev);
107 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
108 int i;
109 char *p = NULL;
110
111 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
112 p = (char *)ctx + cdc_ncm_gstrings_stats[i].stat_offset;
113 data[i] = (cdc_ncm_gstrings_stats[i].sizeof_stat == sizeof(u64)) ? *(u64 *)p : *(u32 *)p;
114 }
115}
116
117static void cdc_ncm_get_strings(struct net_device __always_unused *netdev, u32 stringset, u8 *data)
118{
119 u8 *p = data;
120 int i;
121
122 switch (stringset) {
123 case ETH_SS_STATS:
124 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
125 memcpy(p, cdc_ncm_gstrings_stats[i].stat_string, ETH_GSTRING_LEN);
126 p += ETH_GSTRING_LEN;
127 }
128 }
129}
130
131static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
132
133static const struct ethtool_ops cdc_ncm_ethtool_ops = {
134 .get_settings = usbnet_get_settings,
135 .set_settings = usbnet_set_settings,
136 .get_link = usbnet_get_link,
137 .nway_reset = usbnet_nway_reset,
138 .get_drvinfo = usbnet_get_drvinfo,
139 .get_msglevel = usbnet_get_msglevel,
140 .set_msglevel = usbnet_set_msglevel,
141 .get_ts_info = ethtool_op_get_ts_info,
142 .get_sset_count = cdc_ncm_get_sset_count,
143 .get_strings = cdc_ncm_get_strings,
144 .get_ethtool_stats = cdc_ncm_get_ethtool_stats,
145};
146
147static u32 cdc_ncm_check_rx_max(struct usbnet *dev, u32 new_rx)
148{
149 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
150 u32 val, max, min;
151
152 /* clamp new_rx to sane values */
153 min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
154 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
155
156 /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
157 if (max < min) {
158 dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
159 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
160 max = min;
161 }
162
163 val = clamp_t(u32, new_rx, min, max);
164 if (val != new_rx)
165 dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range\n", min, max);
166
167 return val;
168}
169
170static u32 cdc_ncm_check_tx_max(struct usbnet *dev, u32 new_tx)
171{
172 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
173 u32 val, max, min;
174
175 /* clamp new_tx to sane values */
176 min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
177 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
178
179 /* some devices set dwNtbOutMaxSize too low for the above default */
180 min = min(min, max);
181
182 val = clamp_t(u32, new_tx, min, max);
183 if (val != new_tx)
184 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range\n", min, max);
185
186 return val;
187}
188
189static ssize_t cdc_ncm_show_min_tx_pkt(struct device *d, struct device_attribute *attr, char *buf)
190{
191 struct usbnet *dev = netdev_priv(to_net_dev(d));
192 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
193
194 return sprintf(buf, "%u\n", ctx->min_tx_pkt);
195}
196
197static ssize_t cdc_ncm_show_rx_max(struct device *d, struct device_attribute *attr, char *buf)
198{
199 struct usbnet *dev = netdev_priv(to_net_dev(d));
200 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
201
202 return sprintf(buf, "%u\n", ctx->rx_max);
203}
204
205static ssize_t cdc_ncm_show_tx_max(struct device *d, struct device_attribute *attr, char *buf)
206{
207 struct usbnet *dev = netdev_priv(to_net_dev(d));
208 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
209
210 return sprintf(buf, "%u\n", ctx->tx_max);
211}
212
213static ssize_t cdc_ncm_show_tx_timer_usecs(struct device *d, struct device_attribute *attr, char *buf)
214{
215 struct usbnet *dev = netdev_priv(to_net_dev(d));
216 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
217
218 return sprintf(buf, "%u\n", ctx->timer_interval / (u32)NSEC_PER_USEC);
219}
220
221static ssize_t cdc_ncm_store_min_tx_pkt(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
222{
223 struct usbnet *dev = netdev_priv(to_net_dev(d));
224 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
225 unsigned long val;
226
227 /* no need to restrict values - anything from 0 to infinity is OK */
228 if (kstrtoul(buf, 0, &val))
229 return -EINVAL;
230
231 ctx->min_tx_pkt = val;
232 return len;
233}
234
235static ssize_t cdc_ncm_store_rx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
236{
237 struct usbnet *dev = netdev_priv(to_net_dev(d));
238 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
239 unsigned long val;
240
241 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_rx_max(dev, val) != val)
242 return -EINVAL;
243
244 cdc_ncm_update_rxtx_max(dev, val, ctx->tx_max);
245 return len;
246}
247
248static ssize_t cdc_ncm_store_tx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
249{
250 struct usbnet *dev = netdev_priv(to_net_dev(d));
251 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
252 unsigned long val;
253
254 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_tx_max(dev, val) != val)
255 return -EINVAL;
256
257 cdc_ncm_update_rxtx_max(dev, ctx->rx_max, val);
258 return len;
259}
260
261static ssize_t cdc_ncm_store_tx_timer_usecs(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
262{
263 struct usbnet *dev = netdev_priv(to_net_dev(d));
264 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
265 ssize_t ret;
266 unsigned long val;
267
268 ret = kstrtoul(buf, 0, &val);
269 if (ret)
270 return ret;
271 if (val && (val < CDC_NCM_TIMER_INTERVAL_MIN || val > CDC_NCM_TIMER_INTERVAL_MAX))
272 return -EINVAL;
273
274 spin_lock_bh(&ctx->mtx);
275 ctx->timer_interval = val * NSEC_PER_USEC;
276 if (!ctx->timer_interval)
277 ctx->tx_timer_pending = 0;
278 spin_unlock_bh(&ctx->mtx);
279 return len;
280}
281
282static DEVICE_ATTR(min_tx_pkt, S_IRUGO | S_IWUSR, cdc_ncm_show_min_tx_pkt, cdc_ncm_store_min_tx_pkt);
283static DEVICE_ATTR(rx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_rx_max, cdc_ncm_store_rx_max);
284static DEVICE_ATTR(tx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_max, cdc_ncm_store_tx_max);
285static DEVICE_ATTR(tx_timer_usecs, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_timer_usecs, cdc_ncm_store_tx_timer_usecs);
286
287static ssize_t ndp_to_end_show(struct device *d, struct device_attribute *attr, char *buf)
288{
289 struct usbnet *dev = netdev_priv(to_net_dev(d));
290 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
291
292 return sprintf(buf, "%c\n", ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END ? 'Y' : 'N');
293}
294
295static ssize_t ndp_to_end_store(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
296{
297 struct usbnet *dev = netdev_priv(to_net_dev(d));
298 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
299 bool enable;
300
301 if (strtobool(buf, &enable))
302 return -EINVAL;
303
304 /* no change? */
305 if (enable == (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
306 return len;
307
308 if (enable && !ctx->delayed_ndp16) {
309 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
310 if (!ctx->delayed_ndp16)
311 return -ENOMEM;
312 }
313
314 /* flush pending data before changing flag */
315 netif_tx_lock_bh(dev->net);
316 usbnet_start_xmit(NULL, dev->net);
317 spin_lock_bh(&ctx->mtx);
318 if (enable)
319 ctx->drvflags |= CDC_NCM_FLAG_NDP_TO_END;
320 else
321 ctx->drvflags &= ~CDC_NCM_FLAG_NDP_TO_END;
322 spin_unlock_bh(&ctx->mtx);
323 netif_tx_unlock_bh(dev->net);
324
325 return len;
326}
327static DEVICE_ATTR_RW(ndp_to_end);
328
329#define NCM_PARM_ATTR(name, format, tocpu) \
330static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
331{ \
332 struct usbnet *dev = netdev_priv(to_net_dev(d)); \
333 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
334 return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name)); \
335} \
336static DEVICE_ATTR(name, S_IRUGO, cdc_ncm_show_##name, NULL)
337
338NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
339NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
340NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
341NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
342NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
343NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
344NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
345NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
346NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
347NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
348
349static struct attribute *cdc_ncm_sysfs_attrs[] = {
350 &dev_attr_min_tx_pkt.attr,
351 &dev_attr_ndp_to_end.attr,
352 &dev_attr_rx_max.attr,
353 &dev_attr_tx_max.attr,
354 &dev_attr_tx_timer_usecs.attr,
355 &dev_attr_bmNtbFormatsSupported.attr,
356 &dev_attr_dwNtbInMaxSize.attr,
357 &dev_attr_wNdpInDivisor.attr,
358 &dev_attr_wNdpInPayloadRemainder.attr,
359 &dev_attr_wNdpInAlignment.attr,
360 &dev_attr_dwNtbOutMaxSize.attr,
361 &dev_attr_wNdpOutDivisor.attr,
362 &dev_attr_wNdpOutPayloadRemainder.attr,
363 &dev_attr_wNdpOutAlignment.attr,
364 &dev_attr_wNtbOutMaxDatagrams.attr,
365 NULL,
366};
367
368static struct attribute_group cdc_ncm_sysfs_attr_group = {
369 .name = "cdc_ncm",
370 .attrs = cdc_ncm_sysfs_attrs,
371};
372
373/* handle rx_max and tx_max changes */
374static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
375{
376 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
377 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
378 u32 val;
379
380 val = cdc_ncm_check_rx_max(dev, new_rx);
381
382 /* inform device about NTB input size changes */
383 if (val != ctx->rx_max) {
384 __le32 dwNtbInMaxSize = cpu_to_le32(val);
385
386 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
387
388 /* tell device to use new size */
389 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
390 USB_TYPE_CLASS | USB_DIR_OUT
391 | USB_RECIP_INTERFACE,
392 0, iface_no, &dwNtbInMaxSize, 4) < 0)
393 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
394 else
395 ctx->rx_max = val;
396 }
397
398 /* usbnet use these values for sizing rx queues */
399 if (dev->rx_urb_size != ctx->rx_max) {
400 dev->rx_urb_size = ctx->rx_max;
401 if (netif_running(dev->net))
402 usbnet_unlink_rx_urbs(dev);
403 }
404
405 val = cdc_ncm_check_tx_max(dev, new_tx);
406 if (val != ctx->tx_max)
407 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
408
409 /* Adding a pad byte here if necessary simplifies the handling
410 * in cdc_ncm_fill_tx_frame, making tx_max always represent
411 * the real skb max size.
412 *
413 * We cannot use dev->maxpacket here because this is called from
414 * .bind which is called before usbnet sets up dev->maxpacket
415 */
416 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
417 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
418 val++;
419
420 /* we might need to flush any pending tx buffers if running */
421 if (netif_running(dev->net) && val > ctx->tx_max) {
422 netif_tx_lock_bh(dev->net);
423 usbnet_start_xmit(NULL, dev->net);
424 /* make sure tx_curr_skb is reallocated if it was empty */
425 if (ctx->tx_curr_skb) {
426 dev_kfree_skb_any(ctx->tx_curr_skb);
427 ctx->tx_curr_skb = NULL;
428 }
429 ctx->tx_max = val;
430 netif_tx_unlock_bh(dev->net);
431 } else {
432 ctx->tx_max = val;
433 }
434
435 dev->hard_mtu = ctx->tx_max;
436
437 /* max qlen depend on hard_mtu and rx_urb_size */
438 usbnet_update_max_qlen(dev);
439
440 /* never pad more than 3 full USB packets per transfer */
441 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
442 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
443}
444
445/* helpers for NCM and MBIM differences */
446static u8 cdc_ncm_flags(struct usbnet *dev)
447{
448 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
449
450 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
451 return ctx->mbim_desc->bmNetworkCapabilities;
452 if (ctx->func_desc)
453 return ctx->func_desc->bmNetworkCapabilities;
454 return 0;
455}
456
457static int cdc_ncm_eth_hlen(struct usbnet *dev)
458{
459 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
460 return 0;
461 return ETH_HLEN;
462}
463
464static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
465{
466 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
467 return CDC_MBIM_MIN_DATAGRAM_SIZE;
468 return CDC_NCM_MIN_DATAGRAM_SIZE;
469}
470
471static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
472{
473 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
474
475 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
476 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
477 if (ctx->ether_desc)
478 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
479 return CDC_NCM_MAX_DATAGRAM_SIZE;
480}
481
482/* initial one-time device setup. MUST be called with the data interface
483 * in altsetting 0
484 */
485static int cdc_ncm_init(struct usbnet *dev)
486{
487 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
488 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
489 int err;
490
491 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
492 USB_TYPE_CLASS | USB_DIR_IN
493 |USB_RECIP_INTERFACE,
494 0, iface_no, &ctx->ncm_parm,
495 sizeof(ctx->ncm_parm));
496 if (err < 0) {
497 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
498 return err; /* GET_NTB_PARAMETERS is required */
499 }
500
501 /* set CRC Mode */
502 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
503 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
504 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
505 USB_TYPE_CLASS | USB_DIR_OUT
506 | USB_RECIP_INTERFACE,
507 USB_CDC_NCM_CRC_NOT_APPENDED,
508 iface_no, NULL, 0);
509 if (err < 0)
510 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
511 }
512
513 /* set NTB format, if both formats are supported.
514 *
515 * "The host shall only send this command while the NCM Data
516 * Interface is in alternate setting 0."
517 */
518 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
519 USB_CDC_NCM_NTB32_SUPPORTED) {
520 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
521 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
522 USB_TYPE_CLASS | USB_DIR_OUT
523 | USB_RECIP_INTERFACE,
524 USB_CDC_NCM_NTB16_FORMAT,
525 iface_no, NULL, 0);
526 if (err < 0)
527 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
528 }
529
530 /* set initial device values */
531 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
532 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
533 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
534 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
535 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
536 /* devices prior to NCM Errata shall set this field to zero */
537 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
538
539 dev_dbg(&dev->intf->dev,
540 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
541 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
542 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
543
544 /* max count of tx datagrams */
545 if ((ctx->tx_max_datagrams == 0) ||
546 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
547 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
548
549 /* set up maximum NDP size */
550 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
551
552 /* initial coalescing timer interval */
553 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
554
555 return 0;
556}
557
558/* set a new max datagram size */
559static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
560{
561 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
562 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
563 __le16 max_datagram_size;
564 u16 mbim_mtu;
565 int err;
566
567 /* set default based on descriptors */
568 ctx->max_datagram_size = clamp_t(u32, new_size,
569 cdc_ncm_min_dgram_size(dev),
570 CDC_NCM_MAX_DATAGRAM_SIZE);
571
572 /* inform the device about the selected Max Datagram Size? */
573 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
574 goto out;
575
576 /* read current mtu value from device */
577 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
578 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
579 0, iface_no, &max_datagram_size, 2);
580 if (err < 0) {
581 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
582 goto out;
583 }
584
585 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
586 goto out;
587
588 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
589 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
590 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
591 0, iface_no, &max_datagram_size, 2);
592 if (err < 0)
593 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
594
595out:
596 /* set MTU to max supported by the device if necessary */
597 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
598
599 /* do not exceed operater preferred MTU */
600 if (ctx->mbim_extended_desc) {
601 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
602 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
603 dev->net->mtu = mbim_mtu;
604 }
605}
606
607static void cdc_ncm_fix_modulus(struct usbnet *dev)
608{
609 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
610 u32 val;
611
612 /*
613 * verify that the structure alignment is:
614 * - power of two
615 * - not greater than the maximum transmit length
616 * - not less than four bytes
617 */
618 val = ctx->tx_ndp_modulus;
619
620 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
621 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
622 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
623 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
624 }
625
626 /*
627 * verify that the payload alignment is:
628 * - power of two
629 * - not greater than the maximum transmit length
630 * - not less than four bytes
631 */
632 val = ctx->tx_modulus;
633
634 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
635 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
636 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
637 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
638 }
639
640 /* verify the payload remainder */
641 if (ctx->tx_remainder >= ctx->tx_modulus) {
642 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
643 ctx->tx_remainder = 0;
644 }
645
646 /* adjust TX-remainder according to NCM specification. */
647 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
648 (ctx->tx_modulus - 1));
649}
650
651static int cdc_ncm_setup(struct usbnet *dev)
652{
653 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
654 u32 def_rx, def_tx;
655
656 /* be conservative when selecting intial buffer size to
657 * increase the number of hosts this will work for
658 */
659 def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
660 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
661 def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
662 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
663
664 /* clamp rx_max and tx_max and inform device */
665 cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
666
667 /* sanitize the modulus and remainder values */
668 cdc_ncm_fix_modulus(dev);
669
670 /* set max datagram size */
671 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
672 return 0;
673}
674
675static void
676cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
677{
678 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
679 u8 ep;
680
681 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
682
683 e = intf->cur_altsetting->endpoint + ep;
684 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
685 case USB_ENDPOINT_XFER_INT:
686 if (usb_endpoint_dir_in(&e->desc)) {
687 if (!dev->status)
688 dev->status = e;
689 }
690 break;
691
692 case USB_ENDPOINT_XFER_BULK:
693 if (usb_endpoint_dir_in(&e->desc)) {
694 if (!in)
695 in = e;
696 } else {
697 if (!out)
698 out = e;
699 }
700 break;
701
702 default:
703 break;
704 }
705 }
706 if (in && !dev->in)
707 dev->in = usb_rcvbulkpipe(dev->udev,
708 in->desc.bEndpointAddress &
709 USB_ENDPOINT_NUMBER_MASK);
710 if (out && !dev->out)
711 dev->out = usb_sndbulkpipe(dev->udev,
712 out->desc.bEndpointAddress &
713 USB_ENDPOINT_NUMBER_MASK);
714}
715
716static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
717{
718 if (ctx == NULL)
719 return;
720
721 if (ctx->tx_rem_skb != NULL) {
722 dev_kfree_skb_any(ctx->tx_rem_skb);
723 ctx->tx_rem_skb = NULL;
724 }
725
726 if (ctx->tx_curr_skb != NULL) {
727 dev_kfree_skb_any(ctx->tx_curr_skb);
728 ctx->tx_curr_skb = NULL;
729 }
730
731 kfree(ctx->delayed_ndp16);
732
733 kfree(ctx);
734}
735
736/* we need to override the usbnet change_mtu ndo for two reasons:
737 * - respect the negotiated maximum datagram size
738 * - avoid unwanted changes to rx and tx buffers
739 */
740int cdc_ncm_change_mtu(struct net_device *net, int new_mtu)
741{
742 struct usbnet *dev = netdev_priv(net);
743 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
744 int maxmtu = ctx->max_datagram_size - cdc_ncm_eth_hlen(dev);
745
746 if (new_mtu <= 0 || new_mtu > maxmtu)
747 return -EINVAL;
748 net->mtu = new_mtu;
749 return 0;
750}
751EXPORT_SYMBOL_GPL(cdc_ncm_change_mtu);
752
753static const struct net_device_ops cdc_ncm_netdev_ops = {
754 .ndo_open = usbnet_open,
755 .ndo_stop = usbnet_stop,
756 .ndo_start_xmit = usbnet_start_xmit,
757 .ndo_tx_timeout = usbnet_tx_timeout,
758 .ndo_change_mtu = cdc_ncm_change_mtu,
759 .ndo_set_mac_address = eth_mac_addr,
760 .ndo_validate_addr = eth_validate_addr,
761};
762
763int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
764{
765 struct cdc_ncm_ctx *ctx;
766 struct usb_driver *driver;
767 u8 *buf;
768 int len;
769 int temp;
770 u8 iface_no;
771 struct usb_cdc_parsed_header hdr;
772
773 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
774 if (!ctx)
775 return -ENOMEM;
776
777 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
778 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
779 ctx->bh.data = (unsigned long)dev;
780 ctx->bh.func = cdc_ncm_txpath_bh;
781 atomic_set(&ctx->stop, 0);
782 spin_lock_init(&ctx->mtx);
783
784 /* store ctx pointer in device data field */
785 dev->data[0] = (unsigned long)ctx;
786
787 /* only the control interface can be successfully probed */
788 ctx->control = intf;
789
790 /* get some pointers */
791 driver = driver_of(intf);
792 buf = intf->cur_altsetting->extra;
793 len = intf->cur_altsetting->extralen;
794
795 /* parse through descriptors associated with control interface */
796 cdc_parse_cdc_header(&hdr, intf, buf, len);
797
798 if (hdr.usb_cdc_union_desc)
799 ctx->data = usb_ifnum_to_if(dev->udev,
800 hdr.usb_cdc_union_desc->bSlaveInterface0);
801 ctx->ether_desc = hdr.usb_cdc_ether_desc;
802 ctx->func_desc = hdr.usb_cdc_ncm_desc;
803 ctx->mbim_desc = hdr.usb_cdc_mbim_desc;
804 ctx->mbim_extended_desc = hdr.usb_cdc_mbim_extended_desc;
805
806 /* some buggy devices have an IAD but no CDC Union */
807 if (!hdr.usb_cdc_union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
808 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
809 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
810 }
811
812 /* check if we got everything */
813 if (!ctx->data) {
814 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
815 goto error;
816 }
817 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
818 if (!ctx->mbim_desc) {
819 dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
820 goto error;
821 }
822 } else {
823 if (!ctx->ether_desc || !ctx->func_desc) {
824 dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
825 goto error;
826 }
827 }
828
829 /* claim data interface, if different from control */
830 if (ctx->data != ctx->control) {
831 temp = usb_driver_claim_interface(driver, ctx->data, dev);
832 if (temp) {
833 dev_dbg(&intf->dev, "failed to claim data intf\n");
834 goto error;
835 }
836 }
837
838 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
839
840 /* Reset data interface. Some devices will not reset properly
841 * unless they are configured first. Toggle the altsetting to
842 * force a reset
843 */
844 usb_set_interface(dev->udev, iface_no, data_altsetting);
845 temp = usb_set_interface(dev->udev, iface_no, 0);
846 if (temp) {
847 dev_dbg(&intf->dev, "set interface failed\n");
848 goto error2;
849 }
850
851 /* initialize basic device settings */
852 if (cdc_ncm_init(dev))
853 goto error2;
854
855 /* configure data interface */
856 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
857 if (temp) {
858 dev_dbg(&intf->dev, "set interface failed\n");
859 goto error2;
860 }
861
862 cdc_ncm_find_endpoints(dev, ctx->data);
863 cdc_ncm_find_endpoints(dev, ctx->control);
864 if (!dev->in || !dev->out || !dev->status) {
865 dev_dbg(&intf->dev, "failed to collect endpoints\n");
866 goto error2;
867 }
868
869 usb_set_intfdata(ctx->data, dev);
870 usb_set_intfdata(ctx->control, dev);
871
872 if (ctx->ether_desc) {
873 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
874 if (temp) {
875 dev_dbg(&intf->dev, "failed to get mac address\n");
876 goto error2;
877 }
878 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
879 }
880
881 /* finish setting up the device specific data */
882 cdc_ncm_setup(dev);
883
884 /* Device-specific flags */
885 ctx->drvflags = drvflags;
886
887 /* Allocate the delayed NDP if needed. */
888 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
889 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
890 if (!ctx->delayed_ndp16)
891 goto error2;
892 dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
893 }
894
895 /* override ethtool_ops */
896 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
897
898 /* add our sysfs attrs */
899 dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
900
901 /* must handle MTU changes */
902 dev->net->netdev_ops = &cdc_ncm_netdev_ops;
903
904 return 0;
905
906error2:
907 usb_set_intfdata(ctx->control, NULL);
908 usb_set_intfdata(ctx->data, NULL);
909 if (ctx->data != ctx->control)
910 usb_driver_release_interface(driver, ctx->data);
911error:
912 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
913 dev->data[0] = 0;
914 dev_info(&intf->dev, "bind() failure\n");
915 return -ENODEV;
916}
917EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
918
919void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
920{
921 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
922 struct usb_driver *driver = driver_of(intf);
923
924 if (ctx == NULL)
925 return; /* no setup */
926
927 atomic_set(&ctx->stop, 1);
928
929 if (hrtimer_active(&ctx->tx_timer))
930 hrtimer_cancel(&ctx->tx_timer);
931
932 tasklet_kill(&ctx->bh);
933
934 /* handle devices with combined control and data interface */
935 if (ctx->control == ctx->data)
936 ctx->data = NULL;
937
938 /* disconnect master --> disconnect slave */
939 if (intf == ctx->control && ctx->data) {
940 usb_set_intfdata(ctx->data, NULL);
941 usb_driver_release_interface(driver, ctx->data);
942 ctx->data = NULL;
943
944 } else if (intf == ctx->data && ctx->control) {
945 usb_set_intfdata(ctx->control, NULL);
946 usb_driver_release_interface(driver, ctx->control);
947 ctx->control = NULL;
948 }
949
950 usb_set_intfdata(intf, NULL);
951 cdc_ncm_free(ctx);
952}
953EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
954
955/* Return the number of the MBIM control interface altsetting iff it
956 * is preferred and available,
957 */
958u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
959{
960 struct usb_host_interface *alt;
961
962 /* The MBIM spec defines a NCM compatible default altsetting,
963 * which we may have matched:
964 *
965 * "Functions that implement both NCM 1.0 and MBIM (an
966 * “NCM/MBIM function”) according to this recommendation
967 * shall provide two alternate settings for the
968 * Communication Interface. Alternate setting 0, and the
969 * associated class and endpoint descriptors, shall be
970 * constructed according to the rules given for the
971 * Communication Interface in section 5 of [USBNCM10].
972 * Alternate setting 1, and the associated class and
973 * endpoint descriptors, shall be constructed according to
974 * the rules given in section 6 (USB Device Model) of this
975 * specification."
976 */
977 if (intf->num_altsetting < 2)
978 return intf->cur_altsetting->desc.bAlternateSetting;
979
980 if (prefer_mbim) {
981 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
982 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
983 return CDC_NCM_COMM_ALTSETTING_MBIM;
984 }
985 return CDC_NCM_COMM_ALTSETTING_NCM;
986}
987EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
988
989static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
990{
991 /* MBIM backwards compatible function? */
992 if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
993 return -ENODEV;
994
995 /* The NCM data altsetting is fixed, so we hard-coded it.
996 * Additionally, generic NCM devices are assumed to accept arbitrarily
997 * placed NDP.
998 */
999 return cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM, 0);
1000}
1001
1002static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
1003{
1004 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
1005
1006 if (skb->len + align > max)
1007 align = max - skb->len;
1008 if (align && skb_tailroom(skb) >= align)
1009 memset(skb_put(skb, align), 0, align);
1010}
1011
1012/* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
1013 * allocating a new one within skb
1014 */
1015static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
1016{
1017 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
1018 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
1019 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
1020
1021 /* If NDP should be moved to the end of the NCM package, we can't follow the
1022 * NTH16 header as we would normally do. NDP isn't written to the SKB yet, and
1023 * the wNdpIndex field in the header is actually not consistent with reality. It will be later.
1024 */
1025 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1026 if (ctx->delayed_ndp16->dwSignature == sign)
1027 return ctx->delayed_ndp16;
1028
1029 /* We can only push a single NDP to the end. Return
1030 * NULL to send what we've already got and queue this
1031 * skb for later.
1032 */
1033 else if (ctx->delayed_ndp16->dwSignature)
1034 return NULL;
1035 }
1036
1037 /* follow the chain of NDPs, looking for a match */
1038 while (ndpoffset) {
1039 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
1040 if (ndp16->dwSignature == sign)
1041 return ndp16;
1042 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1043 }
1044
1045 /* align new NDP */
1046 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1047 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1048
1049 /* verify that there is room for the NDP and the datagram (reserve) */
1050 if ((ctx->tx_max - skb->len - reserve) < ctx->max_ndp_size)
1051 return NULL;
1052
1053 /* link to it */
1054 if (ndp16)
1055 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
1056 else
1057 nth16->wNdpIndex = cpu_to_le16(skb->len);
1058
1059 /* push a new empty NDP */
1060 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1061 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, ctx->max_ndp_size);
1062 else
1063 ndp16 = ctx->delayed_ndp16;
1064
1065 ndp16->dwSignature = sign;
1066 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
1067 return ndp16;
1068}
1069
1070struct sk_buff *
1071cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
1072{
1073 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1074 struct usb_cdc_ncm_nth16 *nth16;
1075 struct usb_cdc_ncm_ndp16 *ndp16;
1076 struct sk_buff *skb_out;
1077 u16 n = 0, index, ndplen;
1078 u8 ready2send = 0;
1079 u32 delayed_ndp_size;
1080
1081 /* When our NDP gets written in cdc_ncm_ndp(), then skb_out->len gets updated
1082 * accordingly. Otherwise, we should check here.
1083 */
1084 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1085 delayed_ndp_size = ctx->max_ndp_size;
1086 else
1087 delayed_ndp_size = 0;
1088
1089 /* if there is a remaining skb, it gets priority */
1090 if (skb != NULL) {
1091 swap(skb, ctx->tx_rem_skb);
1092 swap(sign, ctx->tx_rem_sign);
1093 } else {
1094 ready2send = 1;
1095 }
1096
1097 /* check if we are resuming an OUT skb */
1098 skb_out = ctx->tx_curr_skb;
1099
1100 /* allocate a new OUT skb */
1101 if (!skb_out) {
1102 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
1103 if (skb_out == NULL) {
1104 if (skb != NULL) {
1105 dev_kfree_skb_any(skb);
1106 dev->net->stats.tx_dropped++;
1107 }
1108 goto exit_no_skb;
1109 }
1110 /* fill out the initial 16-bit NTB header */
1111 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
1112 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1113 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1114 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
1115
1116 /* count total number of frames in this NTB */
1117 ctx->tx_curr_frame_num = 0;
1118
1119 /* recent payload counter for this skb_out */
1120 ctx->tx_curr_frame_payload = 0;
1121 }
1122
1123 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1124 /* send any remaining skb first */
1125 if (skb == NULL) {
1126 skb = ctx->tx_rem_skb;
1127 sign = ctx->tx_rem_sign;
1128 ctx->tx_rem_skb = NULL;
1129
1130 /* check for end of skb */
1131 if (skb == NULL)
1132 break;
1133 }
1134
1135 /* get the appropriate NDP for this skb */
1136 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1137
1138 /* align beginning of next frame */
1139 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
1140
1141 /* check if we had enough room left for both NDP and frame */
1142 if (!ndp16 || skb_out->len + skb->len + delayed_ndp_size > ctx->tx_max) {
1143 if (n == 0) {
1144 /* won't fit, MTU problem? */
1145 dev_kfree_skb_any(skb);
1146 skb = NULL;
1147 dev->net->stats.tx_dropped++;
1148 } else {
1149 /* no room for skb - store for later */
1150 if (ctx->tx_rem_skb != NULL) {
1151 dev_kfree_skb_any(ctx->tx_rem_skb);
1152 dev->net->stats.tx_dropped++;
1153 }
1154 ctx->tx_rem_skb = skb;
1155 ctx->tx_rem_sign = sign;
1156 skb = NULL;
1157 ready2send = 1;
1158 ctx->tx_reason_ntb_full++; /* count reason for transmitting */
1159 }
1160 break;
1161 }
1162
1163 /* calculate frame number withing this NDP */
1164 ndplen = le16_to_cpu(ndp16->wLength);
1165 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
1166
1167 /* OK, add this skb */
1168 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1169 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1170 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
1171 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
1172 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
1173 dev_kfree_skb_any(skb);
1174 skb = NULL;
1175
1176 /* send now if this NDP is full */
1177 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1178 ready2send = 1;
1179 ctx->tx_reason_ndp_full++; /* count reason for transmitting */
1180 break;
1181 }
1182 }
1183
1184 /* free up any dangling skb */
1185 if (skb != NULL) {
1186 dev_kfree_skb_any(skb);
1187 skb = NULL;
1188 dev->net->stats.tx_dropped++;
1189 }
1190
1191 ctx->tx_curr_frame_num = n;
1192
1193 if (n == 0) {
1194 /* wait for more frames */
1195 /* push variables */
1196 ctx->tx_curr_skb = skb_out;
1197 goto exit_no_skb;
1198
1199 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
1200 /* wait for more frames */
1201 /* push variables */
1202 ctx->tx_curr_skb = skb_out;
1203 /* set the pending count */
1204 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
1205 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
1206 goto exit_no_skb;
1207
1208 } else {
1209 if (n == ctx->tx_max_datagrams)
1210 ctx->tx_reason_max_datagram++; /* count reason for transmitting */
1211 /* frame goes out */
1212 /* variables will be reset at next call */
1213 }
1214
1215 /* If requested, put NDP at end of frame. */
1216 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1217 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1218 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1219 nth16->wNdpIndex = cpu_to_le16(skb_out->len);
1220 memcpy(skb_put(skb_out, ctx->max_ndp_size), ctx->delayed_ndp16, ctx->max_ndp_size);
1221
1222 /* Zero out delayed NDP - signature checking will naturally fail. */
1223 ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1224 }
1225
1226 /* If collected data size is less or equal ctx->min_tx_pkt
1227 * bytes, we send buffers as it is. If we get more data, it
1228 * would be more efficient for USB HS mobile device with DMA
1229 * engine to receive a full size NTB, than canceling DMA
1230 * transfer and receiving a short packet.
1231 *
1232 * This optimization support is pointless if we end up sending
1233 * a ZLP after full sized NTBs.
1234 */
1235 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
1236 skb_out->len > ctx->min_tx_pkt)
1237 memset(skb_put(skb_out, ctx->tx_max - skb_out->len), 0,
1238 ctx->tx_max - skb_out->len);
1239 else if (skb_out->len < ctx->tx_max && (skb_out->len % dev->maxpacket) == 0)
1240 *skb_put(skb_out, 1) = 0; /* force short packet */
1241
1242 /* set final frame length */
1243 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1244 nth16->wBlockLength = cpu_to_le16(skb_out->len);
1245
1246 /* return skb */
1247 ctx->tx_curr_skb = NULL;
1248
1249 /* keep private stats: framing overhead and number of NTBs */
1250 ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1251 ctx->tx_ntbs++;
1252
1253 /* usbnet will count all the framing overhead by default.
1254 * Adjust the stats so that the tx_bytes counter show real
1255 * payload data instead.
1256 */
1257 usbnet_set_skb_tx_stats(skb_out, n,
1258 (long)ctx->tx_curr_frame_payload - skb_out->len);
1259
1260 return skb_out;
1261
1262exit_no_skb:
1263 /* Start timer, if there is a remaining non-empty skb */
1264 if (ctx->tx_curr_skb != NULL && n > 0)
1265 cdc_ncm_tx_timeout_start(ctx);
1266 return NULL;
1267}
1268EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
1269
1270static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1271{
1272 /* start timer, if not already started */
1273 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1274 hrtimer_start(&ctx->tx_timer,
1275 ktime_set(0, ctx->timer_interval),
1276 HRTIMER_MODE_REL);
1277}
1278
1279static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
1280{
1281 struct cdc_ncm_ctx *ctx =
1282 container_of(timer, struct cdc_ncm_ctx, tx_timer);
1283
1284 if (!atomic_read(&ctx->stop))
1285 tasklet_schedule(&ctx->bh);
1286 return HRTIMER_NORESTART;
1287}
1288
1289static void cdc_ncm_txpath_bh(unsigned long param)
1290{
1291 struct usbnet *dev = (struct usbnet *)param;
1292 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1293
1294 spin_lock_bh(&ctx->mtx);
1295 if (ctx->tx_timer_pending != 0) {
1296 ctx->tx_timer_pending--;
1297 cdc_ncm_tx_timeout_start(ctx);
1298 spin_unlock_bh(&ctx->mtx);
1299 } else if (dev->net != NULL) {
1300 ctx->tx_reason_timeout++; /* count reason for transmitting */
1301 spin_unlock_bh(&ctx->mtx);
1302 netif_tx_lock_bh(dev->net);
1303 usbnet_start_xmit(NULL, dev->net);
1304 netif_tx_unlock_bh(dev->net);
1305 } else {
1306 spin_unlock_bh(&ctx->mtx);
1307 }
1308}
1309
1310struct sk_buff *
1311cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1312{
1313 struct sk_buff *skb_out;
1314 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1315
1316 /*
1317 * The Ethernet API we are using does not support transmitting
1318 * multiple Ethernet frames in a single call. This driver will
1319 * accumulate multiple Ethernet frames and send out a larger
1320 * USB frame when the USB buffer is full or when a single jiffies
1321 * timeout happens.
1322 */
1323 if (ctx == NULL)
1324 goto error;
1325
1326 spin_lock_bh(&ctx->mtx);
1327 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
1328 spin_unlock_bh(&ctx->mtx);
1329 return skb_out;
1330
1331error:
1332 if (skb != NULL)
1333 dev_kfree_skb_any(skb);
1334
1335 return NULL;
1336}
1337EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
1338
1339/* verify NTB header and return offset of first NDP, or negative error */
1340int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
1341{
1342 struct usbnet *dev = netdev_priv(skb_in->dev);
1343 struct usb_cdc_ncm_nth16 *nth16;
1344 int len;
1345 int ret = -EINVAL;
1346
1347 if (ctx == NULL)
1348 goto error;
1349
1350 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1351 sizeof(struct usb_cdc_ncm_ndp16))) {
1352 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
1353 goto error;
1354 }
1355
1356 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
1357
1358 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
1359 netif_dbg(dev, rx_err, dev->net,
1360 "invalid NTH16 signature <%#010x>\n",
1361 le32_to_cpu(nth16->dwSignature));
1362 goto error;
1363 }
1364
1365 len = le16_to_cpu(nth16->wBlockLength);
1366 if (len > ctx->rx_max) {
1367 netif_dbg(dev, rx_err, dev->net,
1368 "unsupported NTB block length %u/%u\n", len,
1369 ctx->rx_max);
1370 goto error;
1371 }
1372
1373 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
1374 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1375 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1376 netif_dbg(dev, rx_err, dev->net,
1377 "sequence number glitch prev=%d curr=%d\n",
1378 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
1379 }
1380 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1381
1382 ret = le16_to_cpu(nth16->wNdpIndex);
1383error:
1384 return ret;
1385}
1386EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
1387
1388/* verify NDP header and return number of datagrams, or negative error */
1389int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
1390{
1391 struct usbnet *dev = netdev_priv(skb_in->dev);
1392 struct usb_cdc_ncm_ndp16 *ndp16;
1393 int ret = -EINVAL;
1394
1395 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
1396 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1397 ndpoffset);
1398 goto error;
1399 }
1400 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1401
1402 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
1403 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1404 le16_to_cpu(ndp16->wLength));
1405 goto error;
1406 }
1407
1408 ret = ((le16_to_cpu(ndp16->wLength) -
1409 sizeof(struct usb_cdc_ncm_ndp16)) /
1410 sizeof(struct usb_cdc_ncm_dpe16));
1411 ret--; /* we process NDP entries except for the last one */
1412
1413 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1414 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1415 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
1416 ret = -EINVAL;
1417 }
1418
1419error:
1420 return ret;
1421}
1422EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
1423
1424int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
1425{
1426 struct sk_buff *skb;
1427 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1428 int len;
1429 int nframes;
1430 int x;
1431 int offset;
1432 struct usb_cdc_ncm_ndp16 *ndp16;
1433 struct usb_cdc_ncm_dpe16 *dpe16;
1434 int ndpoffset;
1435 int loopcount = 50; /* arbitrary max preventing infinite loop */
1436 u32 payload = 0;
1437
1438 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1439 if (ndpoffset < 0)
1440 goto error;
1441
1442next_ndp:
1443 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1444 if (nframes < 0)
1445 goto error;
1446
1447 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1448
1449 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
1450 netif_dbg(dev, rx_err, dev->net,
1451 "invalid DPT16 signature <%#010x>\n",
1452 le32_to_cpu(ndp16->dwSignature));
1453 goto err_ndp;
1454 }
1455 dpe16 = ndp16->dpe16;
1456
1457 for (x = 0; x < nframes; x++, dpe16++) {
1458 offset = le16_to_cpu(dpe16->wDatagramIndex);
1459 len = le16_to_cpu(dpe16->wDatagramLength);
1460
1461 /*
1462 * CDC NCM ch. 3.7
1463 * All entries after first NULL entry are to be ignored
1464 */
1465 if ((offset == 0) || (len == 0)) {
1466 if (!x)
1467 goto err_ndp; /* empty NTB */
1468 break;
1469 }
1470
1471 /* sanity checking */
1472 if (((offset + len) > skb_in->len) ||
1473 (len > ctx->rx_max) || (len < ETH_HLEN)) {
1474 netif_dbg(dev, rx_err, dev->net,
1475 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1476 x, offset, len, skb_in);
1477 if (!x)
1478 goto err_ndp;
1479 break;
1480
1481 } else {
1482 /* create a fresh copy to reduce truesize */
1483 skb = netdev_alloc_skb_ip_align(dev->net, len);
1484 if (!skb)
1485 goto error;
1486 memcpy(skb_put(skb, len), skb_in->data + offset, len);
1487 usbnet_skb_return(dev, skb);
1488 payload += len; /* count payload bytes in this NTB */
1489 }
1490 }
1491err_ndp:
1492 /* are there more NDPs to process? */
1493 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1494 if (ndpoffset && loopcount--)
1495 goto next_ndp;
1496
1497 /* update stats */
1498 ctx->rx_overhead += skb_in->len - payload;
1499 ctx->rx_ntbs++;
1500
1501 return 1;
1502error:
1503 return 0;
1504}
1505EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
1506
1507static void
1508cdc_ncm_speed_change(struct usbnet *dev,
1509 struct usb_cdc_speed_change *data)
1510{
1511 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1512 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
1513
1514 /*
1515 * Currently the USB-NET API does not support reporting the actual
1516 * device speed. Do print it instead.
1517 */
1518 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
1519 netif_info(dev, link, dev->net,
1520 "%u mbit/s downlink %u mbit/s uplink\n",
1521 (unsigned int)(rx_speed / 1000000U),
1522 (unsigned int)(tx_speed / 1000000U));
1523 } else {
1524 netif_info(dev, link, dev->net,
1525 "%u kbit/s downlink %u kbit/s uplink\n",
1526 (unsigned int)(rx_speed / 1000U),
1527 (unsigned int)(tx_speed / 1000U));
1528 }
1529}
1530
1531static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1532{
1533 struct cdc_ncm_ctx *ctx;
1534 struct usb_cdc_notification *event;
1535
1536 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1537
1538 if (urb->actual_length < sizeof(*event))
1539 return;
1540
1541 /* test for split data in 8-byte chunks */
1542 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
1543 cdc_ncm_speed_change(dev,
1544 (struct usb_cdc_speed_change *)urb->transfer_buffer);
1545 return;
1546 }
1547
1548 event = urb->transfer_buffer;
1549
1550 switch (event->bNotificationType) {
1551 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1552 /*
1553 * According to the CDC NCM specification ch.7.1
1554 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1555 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1556 */
1557 netif_info(dev, link, dev->net,
1558 "network connection: %sconnected\n",
1559 !!event->wValue ? "" : "dis");
1560 usbnet_link_change(dev, !!event->wValue, 0);
1561 break;
1562
1563 case USB_CDC_NOTIFY_SPEED_CHANGE:
1564 if (urb->actual_length < (sizeof(*event) +
1565 sizeof(struct usb_cdc_speed_change)))
1566 set_bit(EVENT_STS_SPLIT, &dev->flags);
1567 else
1568 cdc_ncm_speed_change(dev,
1569 (struct usb_cdc_speed_change *)&event[1]);
1570 break;
1571
1572 default:
1573 dev_dbg(&dev->udev->dev,
1574 "NCM: unexpected notification 0x%02x!\n",
1575 event->bNotificationType);
1576 break;
1577 }
1578}
1579
1580static const struct driver_info cdc_ncm_info = {
1581 .description = "CDC NCM",
1582 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1583 | FLAG_LINK_INTR,
1584 .bind = cdc_ncm_bind,
1585 .unbind = cdc_ncm_unbind,
1586 .manage_power = usbnet_manage_power,
1587 .status = cdc_ncm_status,
1588 .rx_fixup = cdc_ncm_rx_fixup,
1589 .tx_fixup = cdc_ncm_tx_fixup,
1590};
1591
1592/* Same as cdc_ncm_info, but with FLAG_WWAN */
1593static const struct driver_info wwan_info = {
1594 .description = "Mobile Broadband Network Device",
1595 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1596 | FLAG_LINK_INTR | FLAG_WWAN,
1597 .bind = cdc_ncm_bind,
1598 .unbind = cdc_ncm_unbind,
1599 .manage_power = usbnet_manage_power,
1600 .status = cdc_ncm_status,
1601 .rx_fixup = cdc_ncm_rx_fixup,
1602 .tx_fixup = cdc_ncm_tx_fixup,
1603};
1604
1605/* Same as wwan_info, but with FLAG_NOARP */
1606static const struct driver_info wwan_noarp_info = {
1607 .description = "Mobile Broadband Network Device (NO ARP)",
1608 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1609 | FLAG_LINK_INTR | FLAG_WWAN | FLAG_NOARP,
1610 .bind = cdc_ncm_bind,
1611 .unbind = cdc_ncm_unbind,
1612 .manage_power = usbnet_manage_power,
1613 .status = cdc_ncm_status,
1614 .rx_fixup = cdc_ncm_rx_fixup,
1615 .tx_fixup = cdc_ncm_tx_fixup,
1616};
1617
1618static const struct usb_device_id cdc_devs[] = {
1619 /* Ericsson MBM devices like F5521gw */
1620 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1621 | USB_DEVICE_ID_MATCH_VENDOR,
1622 .idVendor = 0x0bdb,
1623 .bInterfaceClass = USB_CLASS_COMM,
1624 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1625 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1626 .driver_info = (unsigned long) &wwan_info,
1627 },
1628
1629 /* Telit LE910 V2 */
1630 { USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x0036,
1631 USB_CLASS_COMM,
1632 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1633 .driver_info = (unsigned long)&wwan_noarp_info,
1634 },
1635
1636 /* DW5812 LTE Verizon Mobile Broadband Card
1637 * Unlike DW5550 this device requires FLAG_NOARP
1638 */
1639 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bb,
1640 USB_CLASS_COMM,
1641 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1642 .driver_info = (unsigned long)&wwan_noarp_info,
1643 },
1644
1645 /* DW5813 LTE AT&T Mobile Broadband Card
1646 * Unlike DW5550 this device requires FLAG_NOARP
1647 */
1648 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bc,
1649 USB_CLASS_COMM,
1650 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1651 .driver_info = (unsigned long)&wwan_noarp_info,
1652 },
1653
1654 /* Dell branded MBM devices like DW5550 */
1655 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1656 | USB_DEVICE_ID_MATCH_VENDOR,
1657 .idVendor = 0x413c,
1658 .bInterfaceClass = USB_CLASS_COMM,
1659 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1660 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1661 .driver_info = (unsigned long) &wwan_info,
1662 },
1663
1664 /* Toshiba branded MBM devices */
1665 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1666 | USB_DEVICE_ID_MATCH_VENDOR,
1667 .idVendor = 0x0930,
1668 .bInterfaceClass = USB_CLASS_COMM,
1669 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1670 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1671 .driver_info = (unsigned long) &wwan_info,
1672 },
1673
1674 /* tag Huawei devices as wwan */
1675 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1676 USB_CLASS_COMM,
1677 USB_CDC_SUBCLASS_NCM,
1678 USB_CDC_PROTO_NONE),
1679 .driver_info = (unsigned long)&wwan_info,
1680 },
1681
1682 /* Infineon(now Intel) HSPA Modem platform */
1683 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1684 USB_CLASS_COMM,
1685 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1686 .driver_info = (unsigned long)&wwan_noarp_info,
1687 },
1688
1689 /* Generic CDC-NCM devices */
1690 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1691 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1692 .driver_info = (unsigned long)&cdc_ncm_info,
1693 },
1694 {
1695 },
1696};
1697MODULE_DEVICE_TABLE(usb, cdc_devs);
1698
1699static struct usb_driver cdc_ncm_driver = {
1700 .name = "cdc_ncm",
1701 .id_table = cdc_devs,
1702 .probe = usbnet_probe,
1703 .disconnect = usbnet_disconnect,
1704 .suspend = usbnet_suspend,
1705 .resume = usbnet_resume,
1706 .reset_resume = usbnet_resume,
1707 .supports_autosuspend = 1,
1708 .disable_hub_initiated_lpm = 1,
1709};
1710
1711module_usb_driver(cdc_ncm_driver);
1712
1713MODULE_AUTHOR("Hans Petter Selasky");
1714MODULE_DESCRIPTION("USB CDC NCM host driver");
1715MODULE_LICENSE("Dual BSD/GPL");