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>
8 * USB Host Driver for Network Control Model (NCM)
9 * http://www.usb.org/developers/devclass_docs/NCM10.zip
11 * The NCM encoding, decoding and initialization logic
12 * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
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:
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
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.
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
41 #include <linux/module.h>
42 #include <linux/init.h>
43 #include <linux/netdevice.h>
44 #include <linux/ctype.h>
45 #include <linux/ethtool.h>
46 #include <linux/workqueue.h>
47 #include <linux/mii.h>
48 #include <linux/crc32.h>
49 #include <linux/usb.h>
50 #include <linux/hrtimer.h>
51 #include <linux/atomic.h>
52 #include <linux/usb/usbnet.h>
53 #include <linux/usb/cdc.h>
54 #include <linux/usb/cdc_ncm.h>
56 #define DRIVER_VERSION "14-Mar-2012"
58 static void cdc_ncm_txpath_bh(unsigned long param
);
59 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx
*ctx
);
60 static enum hrtimer_restart
cdc_ncm_tx_timer_cb(struct hrtimer
*hr_timer
);
61 static struct usb_driver cdc_ncm_driver
;
64 cdc_ncm_get_drvinfo(struct net_device
*net
, struct ethtool_drvinfo
*info
)
66 struct usbnet
*dev
= netdev_priv(net
);
68 strncpy(info
->driver
, dev
->driver_name
, sizeof(info
->driver
));
69 strncpy(info
->version
, DRIVER_VERSION
, sizeof(info
->version
));
70 strncpy(info
->fw_version
, dev
->driver_info
->description
,
71 sizeof(info
->fw_version
));
72 usb_make_path(dev
->udev
, info
->bus_info
, sizeof(info
->bus_info
));
75 static u8
cdc_ncm_setup(struct cdc_ncm_ctx
*ctx
)
82 u16 ntb_fmt_supported
;
86 iface_no
= ctx
->control
->cur_altsetting
->desc
.bInterfaceNumber
;
88 err
= usb_control_msg(ctx
->udev
,
89 usb_rcvctrlpipe(ctx
->udev
, 0),
90 USB_CDC_GET_NTB_PARAMETERS
,
91 USB_TYPE_CLASS
| USB_DIR_IN
92 | USB_RECIP_INTERFACE
,
93 0, iface_no
, &ctx
->ncm_parm
,
94 sizeof(ctx
->ncm_parm
), 10000);
96 pr_debug("failed GET_NTB_PARAMETERS\n");
100 /* read correct set of parameters according to device mode */
101 ctx
->rx_max
= le32_to_cpu(ctx
->ncm_parm
.dwNtbInMaxSize
);
102 ctx
->tx_max
= le32_to_cpu(ctx
->ncm_parm
.dwNtbOutMaxSize
);
103 ctx
->tx_remainder
= le16_to_cpu(ctx
->ncm_parm
.wNdpOutPayloadRemainder
);
104 ctx
->tx_modulus
= le16_to_cpu(ctx
->ncm_parm
.wNdpOutDivisor
);
105 ctx
->tx_ndp_modulus
= le16_to_cpu(ctx
->ncm_parm
.wNdpOutAlignment
);
106 /* devices prior to NCM Errata shall set this field to zero */
107 ctx
->tx_max_datagrams
= le16_to_cpu(ctx
->ncm_parm
.wNtbOutMaxDatagrams
);
108 ntb_fmt_supported
= le16_to_cpu(ctx
->ncm_parm
.bmNtbFormatsSupported
);
111 min_dgram_size
= CDC_NCM_MIN_DATAGRAM_SIZE
;
112 min_hdr_size
= CDC_NCM_MIN_HDR_SIZE
;
113 if (ctx
->mbim_desc
!= NULL
) {
114 flags
= ctx
->mbim_desc
->bmNetworkCapabilities
;
116 min_dgram_size
= CDC_MBIM_MIN_DATAGRAM_SIZE
;
118 } else if (ctx
->func_desc
!= NULL
) {
119 flags
= ctx
->func_desc
->bmNetworkCapabilities
;
124 pr_debug("dwNtbInMaxSize=%u dwNtbOutMaxSize=%u "
125 "wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u "
126 "wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
127 ctx
->rx_max
, ctx
->tx_max
, ctx
->tx_remainder
, ctx
->tx_modulus
,
128 ctx
->tx_ndp_modulus
, ctx
->tx_max_datagrams
, flags
);
130 /* max count of tx datagrams */
131 if ((ctx
->tx_max_datagrams
== 0) ||
132 (ctx
->tx_max_datagrams
> CDC_NCM_DPT_DATAGRAMS_MAX
))
133 ctx
->tx_max_datagrams
= CDC_NCM_DPT_DATAGRAMS_MAX
;
135 /* verify maximum size of received NTB in bytes */
136 if (ctx
->rx_max
< USB_CDC_NCM_NTB_MIN_IN_SIZE
) {
137 pr_debug("Using min receive length=%d\n",
138 USB_CDC_NCM_NTB_MIN_IN_SIZE
);
139 ctx
->rx_max
= USB_CDC_NCM_NTB_MIN_IN_SIZE
;
142 if (ctx
->rx_max
> CDC_NCM_NTB_MAX_SIZE_RX
) {
143 pr_debug("Using default maximum receive length=%d\n",
144 CDC_NCM_NTB_MAX_SIZE_RX
);
145 ctx
->rx_max
= CDC_NCM_NTB_MAX_SIZE_RX
;
148 /* inform device about NTB input size changes */
149 if (ctx
->rx_max
!= le32_to_cpu(ctx
->ncm_parm
.dwNtbInMaxSize
)) {
150 __le32
*dwNtbInMaxSize
;
152 dwNtbInMaxSize
= kzalloc(sizeof(*dwNtbInMaxSize
), GFP_KERNEL
);
153 if (!dwNtbInMaxSize
) {
157 *dwNtbInMaxSize
= cpu_to_le32(ctx
->rx_max
);
158 err
= usb_control_msg(ctx
->udev
,
159 usb_sndctrlpipe(ctx
->udev
, 0),
160 USB_CDC_SET_NTB_INPUT_SIZE
,
161 USB_TYPE_CLASS
| USB_DIR_OUT
162 | USB_RECIP_INTERFACE
,
163 0, iface_no
, dwNtbInMaxSize
, 4, 1000);
164 kfree(dwNtbInMaxSize
);
167 pr_debug("Setting NTB Input Size failed\n");
170 /* verify maximum size of transmitted NTB in bytes */
172 (min_hdr_size
+ min_dgram_size
)) ||
173 (ctx
->tx_max
> CDC_NCM_NTB_MAX_SIZE_TX
)) {
174 pr_debug("Using default maximum transmit length=%d\n",
175 CDC_NCM_NTB_MAX_SIZE_TX
);
176 ctx
->tx_max
= CDC_NCM_NTB_MAX_SIZE_TX
;
180 * verify that the structure alignment is:
182 * - not greater than the maximum transmit length
183 * - not less than four bytes
185 val
= ctx
->tx_ndp_modulus
;
187 if ((val
< USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
) ||
188 (val
!= ((-val
) & val
)) || (val
>= ctx
->tx_max
)) {
189 pr_debug("Using default alignment: 4 bytes\n");
190 ctx
->tx_ndp_modulus
= USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
;
194 * verify that the payload alignment is:
196 * - not greater than the maximum transmit length
197 * - not less than four bytes
199 val
= ctx
->tx_modulus
;
201 if ((val
< USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
) ||
202 (val
!= ((-val
) & val
)) || (val
>= ctx
->tx_max
)) {
203 pr_debug("Using default transmit modulus: 4 bytes\n");
204 ctx
->tx_modulus
= USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
;
207 /* verify the payload remainder */
208 if (ctx
->tx_remainder
>= ctx
->tx_modulus
) {
209 pr_debug("Using default transmit remainder: 0 bytes\n");
210 ctx
->tx_remainder
= 0;
213 /* adjust TX-remainder according to NCM specification. */
214 ctx
->tx_remainder
= ((ctx
->tx_remainder
- eth_hlen
) &
215 (ctx
->tx_modulus
- 1));
217 /* additional configuration */
220 if (flags
& USB_CDC_NCM_NCAP_CRC_MODE
) {
221 err
= usb_control_msg(ctx
->udev
, usb_sndctrlpipe(ctx
->udev
, 0),
222 USB_CDC_SET_CRC_MODE
,
223 USB_TYPE_CLASS
| USB_DIR_OUT
224 | USB_RECIP_INTERFACE
,
225 USB_CDC_NCM_CRC_NOT_APPENDED
,
226 iface_no
, NULL
, 0, 1000);
228 pr_debug("Setting CRC mode off failed\n");
231 /* set NTB format, if both formats are supported */
232 if (ntb_fmt_supported
& USB_CDC_NCM_NTH32_SIGN
) {
233 err
= usb_control_msg(ctx
->udev
, usb_sndctrlpipe(ctx
->udev
, 0),
234 USB_CDC_SET_NTB_FORMAT
, USB_TYPE_CLASS
235 | USB_DIR_OUT
| USB_RECIP_INTERFACE
,
236 USB_CDC_NCM_NTB16_FORMAT
,
237 iface_no
, NULL
, 0, 1000);
239 pr_debug("Setting NTB format to 16-bit failed\n");
242 ctx
->max_datagram_size
= min_dgram_size
;
244 /* set Max Datagram Size (MTU) */
245 if (flags
& USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE
) {
246 __le16
*max_datagram_size
;
248 if (ctx
->ether_desc
!= NULL
)
249 eth_max_sz
= le16_to_cpu(ctx
->ether_desc
->wMaxSegmentSize
);
250 else if (ctx
->mbim_desc
!= NULL
)
251 eth_max_sz
= le16_to_cpu(ctx
->mbim_desc
->wMaxSegmentSize
);
255 max_datagram_size
= kzalloc(sizeof(*max_datagram_size
),
257 if (!max_datagram_size
) {
262 err
= usb_control_msg(ctx
->udev
, usb_rcvctrlpipe(ctx
->udev
, 0),
263 USB_CDC_GET_MAX_DATAGRAM_SIZE
,
264 USB_TYPE_CLASS
| USB_DIR_IN
265 | USB_RECIP_INTERFACE
,
266 0, iface_no
, max_datagram_size
,
269 pr_debug("GET_MAX_DATAGRAM_SIZE failed, use size=%u\n",
272 ctx
->max_datagram_size
=
273 le16_to_cpu(*max_datagram_size
);
274 /* Check Eth descriptor value */
275 if (ctx
->max_datagram_size
> eth_max_sz
)
276 ctx
->max_datagram_size
= eth_max_sz
;
278 if (ctx
->max_datagram_size
> CDC_NCM_MAX_DATAGRAM_SIZE
)
279 ctx
->max_datagram_size
= CDC_NCM_MAX_DATAGRAM_SIZE
;
281 if (ctx
->max_datagram_size
< min_dgram_size
)
282 ctx
->max_datagram_size
= min_dgram_size
;
284 /* if value changed, update device */
285 if (ctx
->max_datagram_size
!=
286 le16_to_cpu(*max_datagram_size
)) {
287 err
= usb_control_msg(ctx
->udev
,
288 usb_sndctrlpipe(ctx
->udev
, 0),
289 USB_CDC_SET_MAX_DATAGRAM_SIZE
,
290 USB_TYPE_CLASS
| USB_DIR_OUT
291 | USB_RECIP_INTERFACE
,
293 iface_no
, max_datagram_size
,
296 pr_debug("SET_MAX_DGRAM_SIZE failed\n");
299 kfree(max_datagram_size
);
303 if (ctx
->netdev
->mtu
!= (ctx
->max_datagram_size
- eth_hlen
))
304 ctx
->netdev
->mtu
= ctx
->max_datagram_size
- eth_hlen
;
310 cdc_ncm_find_endpoints(struct cdc_ncm_ctx
*ctx
, struct usb_interface
*intf
)
312 struct usb_host_endpoint
*e
;
315 for (ep
= 0; ep
< intf
->cur_altsetting
->desc
.bNumEndpoints
; ep
++) {
317 e
= intf
->cur_altsetting
->endpoint
+ ep
;
318 switch (e
->desc
.bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) {
319 case USB_ENDPOINT_XFER_INT
:
320 if (usb_endpoint_dir_in(&e
->desc
)) {
321 if (ctx
->status_ep
== NULL
)
326 case USB_ENDPOINT_XFER_BULK
:
327 if (usb_endpoint_dir_in(&e
->desc
)) {
328 if (ctx
->in_ep
== NULL
)
331 if (ctx
->out_ep
== NULL
)
342 static void cdc_ncm_free(struct cdc_ncm_ctx
*ctx
)
347 if (ctx
->tx_rem_skb
!= NULL
) {
348 dev_kfree_skb_any(ctx
->tx_rem_skb
);
349 ctx
->tx_rem_skb
= NULL
;
352 if (ctx
->tx_curr_skb
!= NULL
) {
353 dev_kfree_skb_any(ctx
->tx_curr_skb
);
354 ctx
->tx_curr_skb
= NULL
;
360 static const struct ethtool_ops cdc_ncm_ethtool_ops
= {
361 .get_drvinfo
= cdc_ncm_get_drvinfo
,
362 .get_link
= usbnet_get_link
,
363 .get_msglevel
= usbnet_get_msglevel
,
364 .set_msglevel
= usbnet_set_msglevel
,
365 .get_settings
= usbnet_get_settings
,
366 .set_settings
= usbnet_set_settings
,
367 .nway_reset
= usbnet_nway_reset
,
370 int cdc_ncm_bind_common(struct usbnet
*dev
, struct usb_interface
*intf
, u8 data_altsetting
)
372 struct cdc_ncm_ctx
*ctx
;
373 struct usb_driver
*driver
;
379 ctx
= kzalloc(sizeof(*ctx
), GFP_KERNEL
);
383 hrtimer_init(&ctx
->tx_timer
, CLOCK_MONOTONIC
, HRTIMER_MODE_REL
);
384 ctx
->tx_timer
.function
= &cdc_ncm_tx_timer_cb
;
385 ctx
->bh
.data
= (unsigned long)ctx
;
386 ctx
->bh
.func
= cdc_ncm_txpath_bh
;
387 atomic_set(&ctx
->stop
, 0);
388 spin_lock_init(&ctx
->mtx
);
389 ctx
->netdev
= dev
->net
;
391 /* store ctx pointer in device data field */
392 dev
->data
[0] = (unsigned long)ctx
;
394 /* get some pointers */
395 driver
= driver_of(intf
);
396 buf
= intf
->cur_altsetting
->extra
;
397 len
= intf
->cur_altsetting
->extralen
;
399 ctx
->udev
= dev
->udev
;
402 /* parse through descriptors associated with control interface */
403 while ((len
> 0) && (buf
[0] > 2) && (buf
[0] <= len
)) {
405 if (buf
[1] != USB_DT_CS_INTERFACE
)
409 case USB_CDC_UNION_TYPE
:
410 if (buf
[0] < sizeof(*(ctx
->union_desc
)))
414 (const struct usb_cdc_union_desc
*)buf
;
416 ctx
->control
= usb_ifnum_to_if(dev
->udev
,
417 ctx
->union_desc
->bMasterInterface0
);
418 ctx
->data
= usb_ifnum_to_if(dev
->udev
,
419 ctx
->union_desc
->bSlaveInterface0
);
422 case USB_CDC_ETHERNET_TYPE
:
423 if (buf
[0] < sizeof(*(ctx
->ether_desc
)))
427 (const struct usb_cdc_ether_desc
*)buf
;
429 le16_to_cpu(ctx
->ether_desc
->wMaxSegmentSize
);
431 if (dev
->hard_mtu
< CDC_NCM_MIN_DATAGRAM_SIZE
)
432 dev
->hard_mtu
= CDC_NCM_MIN_DATAGRAM_SIZE
;
433 else if (dev
->hard_mtu
> CDC_NCM_MAX_DATAGRAM_SIZE
)
434 dev
->hard_mtu
= CDC_NCM_MAX_DATAGRAM_SIZE
;
437 case USB_CDC_NCM_TYPE
:
438 if (buf
[0] < sizeof(*(ctx
->func_desc
)))
441 ctx
->func_desc
= (const struct usb_cdc_ncm_desc
*)buf
;
444 case USB_CDC_MBIM_TYPE
:
445 if (buf
[0] < sizeof(*(ctx
->mbim_desc
)))
448 ctx
->mbim_desc
= (const struct usb_cdc_mbim_desc
*)buf
;
455 /* advance to next descriptor */
461 /* check if we got everything */
462 if ((ctx
->control
== NULL
) || (ctx
->data
== NULL
) ||
463 ((!ctx
->mbim_desc
) && ((ctx
->ether_desc
== NULL
) || (ctx
->control
!= intf
))))
466 /* claim interfaces, if any */
467 temp
= usb_driver_claim_interface(driver
, ctx
->data
, dev
);
471 iface_no
= ctx
->data
->cur_altsetting
->desc
.bInterfaceNumber
;
473 /* reset data interface */
474 temp
= usb_set_interface(dev
->udev
, iface_no
, 0);
478 /* initialize data interface */
479 if (cdc_ncm_setup(ctx
))
482 /* configure data interface */
483 temp
= usb_set_interface(dev
->udev
, iface_no
, data_altsetting
);
487 cdc_ncm_find_endpoints(ctx
, ctx
->data
);
488 cdc_ncm_find_endpoints(ctx
, ctx
->control
);
490 if ((ctx
->in_ep
== NULL
) || (ctx
->out_ep
== NULL
) ||
491 (ctx
->status_ep
== NULL
))
494 dev
->net
->ethtool_ops
= &cdc_ncm_ethtool_ops
;
496 usb_set_intfdata(ctx
->data
, dev
);
497 usb_set_intfdata(ctx
->control
, dev
);
498 usb_set_intfdata(ctx
->intf
, dev
);
500 if (ctx
->ether_desc
) {
501 temp
= usbnet_get_ethernet_addr(dev
, ctx
->ether_desc
->iMACAddress
);
504 dev_info(&dev
->udev
->dev
, "MAC-Address: %pM\n", dev
->net
->dev_addr
);
508 dev
->in
= usb_rcvbulkpipe(dev
->udev
,
509 ctx
->in_ep
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
510 dev
->out
= usb_sndbulkpipe(dev
->udev
,
511 ctx
->out_ep
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
512 dev
->status
= ctx
->status_ep
;
513 dev
->rx_urb_size
= ctx
->rx_max
;
515 ctx
->tx_speed
= ctx
->rx_speed
= 0;
519 usb_set_intfdata(ctx
->control
, NULL
);
520 usb_set_intfdata(ctx
->data
, NULL
);
521 usb_driver_release_interface(driver
, ctx
->data
);
523 cdc_ncm_free((struct cdc_ncm_ctx
*)dev
->data
[0]);
525 dev_info(&dev
->udev
->dev
, "bind() failure\n");
528 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common
);
530 void cdc_ncm_unbind(struct usbnet
*dev
, struct usb_interface
*intf
)
532 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
533 struct usb_driver
*driver
= driver_of(intf
);
536 return; /* no setup */
538 atomic_set(&ctx
->stop
, 1);
540 if (hrtimer_active(&ctx
->tx_timer
))
541 hrtimer_cancel(&ctx
->tx_timer
);
543 tasklet_kill(&ctx
->bh
);
545 /* disconnect master --> disconnect slave */
546 if (intf
== ctx
->control
&& ctx
->data
) {
547 usb_set_intfdata(ctx
->data
, NULL
);
548 usb_driver_release_interface(driver
, ctx
->data
);
551 } else if (intf
== ctx
->data
&& ctx
->control
) {
552 usb_set_intfdata(ctx
->control
, NULL
);
553 usb_driver_release_interface(driver
, ctx
->control
);
557 usb_set_intfdata(ctx
->intf
, NULL
);
560 EXPORT_SYMBOL_GPL(cdc_ncm_unbind
);
562 static int cdc_ncm_bind(struct usbnet
*dev
, struct usb_interface
*intf
)
566 /* NCM data altsetting is always 1 */
567 ret
= cdc_ncm_bind_common(dev
, intf
, 1);
570 * We should get an event when network connection is "connected" or
571 * "disconnected". Set network connection in "disconnected" state
572 * (carrier is OFF) during attach, so the IP network stack does not
573 * start IPv6 negotiation and more.
575 netif_carrier_off(dev
->net
);
579 static void cdc_ncm_align_tail(struct sk_buff
*skb
, size_t modulus
, size_t remainder
, size_t max
)
581 size_t align
= ALIGN(skb
->len
, modulus
) - skb
->len
+ remainder
;
583 if (skb
->len
+ align
> max
)
584 align
= max
- skb
->len
;
585 if (align
&& skb_tailroom(skb
) >= align
)
586 memset(skb_put(skb
, align
), 0, align
);
589 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
590 * allocating a new one within skb
592 static struct usb_cdc_ncm_ndp16
*cdc_ncm_ndp(struct cdc_ncm_ctx
*ctx
, struct sk_buff
*skb
, __le32 sign
, size_t reserve
)
594 struct usb_cdc_ncm_ndp16
*ndp16
= NULL
;
595 struct usb_cdc_ncm_nth16
*nth16
= (void *)skb
->data
;
596 size_t ndpoffset
= le16_to_cpu(nth16
->wNdpIndex
);
598 /* follow the chain of NDPs, looking for a match */
600 ndp16
= (struct usb_cdc_ncm_ndp16
*)(skb
->data
+ ndpoffset
);
601 if (ndp16
->dwSignature
== sign
)
603 ndpoffset
= le16_to_cpu(ndp16
->wNextNdpIndex
);
607 cdc_ncm_align_tail(skb
, ctx
->tx_ndp_modulus
, 0, ctx
->tx_max
);
609 /* verify that there is room for the NDP and the datagram (reserve) */
610 if ((ctx
->tx_max
- skb
->len
- reserve
) < CDC_NCM_NDP_SIZE
)
615 ndp16
->wNextNdpIndex
= cpu_to_le16(skb
->len
);
617 nth16
->wNdpIndex
= cpu_to_le16(skb
->len
);
619 /* push a new empty NDP */
620 ndp16
= (struct usb_cdc_ncm_ndp16
*)memset(skb_put(skb
, CDC_NCM_NDP_SIZE
), 0, CDC_NCM_NDP_SIZE
);
621 ndp16
->dwSignature
= sign
;
622 ndp16
->wLength
= cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16
) + sizeof(struct usb_cdc_ncm_dpe16
));
627 cdc_ncm_fill_tx_frame(struct cdc_ncm_ctx
*ctx
, struct sk_buff
*skb
, __le32 sign
)
629 struct usb_cdc_ncm_nth16
*nth16
;
630 struct usb_cdc_ncm_ndp16
*ndp16
;
631 struct sk_buff
*skb_out
;
632 u16 n
= 0, index
, ndplen
;
635 /* if there is a remaining skb, it gets priority */
637 swap(skb
, ctx
->tx_rem_skb
);
638 swap(sign
, ctx
->tx_rem_sign
);
643 /* check if we are resuming an OUT skb */
644 skb_out
= ctx
->tx_curr_skb
;
646 /* allocate a new OUT skb */
648 skb_out
= alloc_skb((ctx
->tx_max
+ 1), GFP_ATOMIC
);
649 if (skb_out
== NULL
) {
651 dev_kfree_skb_any(skb
);
652 ctx
->netdev
->stats
.tx_dropped
++;
656 /* fill out the initial 16-bit NTB header */
657 nth16
= (struct usb_cdc_ncm_nth16
*)memset(skb_put(skb_out
, sizeof(struct usb_cdc_ncm_nth16
)), 0, sizeof(struct usb_cdc_ncm_nth16
));
658 nth16
->dwSignature
= cpu_to_le32(USB_CDC_NCM_NTH16_SIGN
);
659 nth16
->wHeaderLength
= cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16
));
660 nth16
->wSequence
= cpu_to_le16(ctx
->tx_seq
++);
662 /* count total number of frames in this NTB */
663 ctx
->tx_curr_frame_num
= 0;
666 for (n
= ctx
->tx_curr_frame_num
; n
< ctx
->tx_max_datagrams
; n
++) {
667 /* send any remaining skb first */
669 skb
= ctx
->tx_rem_skb
;
670 sign
= ctx
->tx_rem_sign
;
671 ctx
->tx_rem_skb
= NULL
;
673 /* check for end of skb */
678 /* get the appropriate NDP for this skb */
679 ndp16
= cdc_ncm_ndp(ctx
, skb_out
, sign
, skb
->len
+ ctx
->tx_modulus
+ ctx
->tx_remainder
);
681 /* align beginning of next frame */
682 cdc_ncm_align_tail(skb_out
, ctx
->tx_modulus
, ctx
->tx_remainder
, ctx
->tx_max
);
684 /* check if we had enough room left for both NDP and frame */
685 if (!ndp16
|| skb_out
->len
+ skb
->len
> ctx
->tx_max
) {
687 /* won't fit, MTU problem? */
688 dev_kfree_skb_any(skb
);
690 ctx
->netdev
->stats
.tx_dropped
++;
692 /* no room for skb - store for later */
693 if (ctx
->tx_rem_skb
!= NULL
) {
694 dev_kfree_skb_any(ctx
->tx_rem_skb
);
695 ctx
->netdev
->stats
.tx_dropped
++;
697 ctx
->tx_rem_skb
= skb
;
698 ctx
->tx_rem_sign
= sign
;
705 /* calculate frame number withing this NDP */
706 ndplen
= le16_to_cpu(ndp16
->wLength
);
707 index
= (ndplen
- sizeof(struct usb_cdc_ncm_ndp16
)) / sizeof(struct usb_cdc_ncm_dpe16
) - 1;
709 /* OK, add this skb */
710 ndp16
->dpe16
[index
].wDatagramLength
= cpu_to_le16(skb
->len
);
711 ndp16
->dpe16
[index
].wDatagramIndex
= cpu_to_le16(skb_out
->len
);
712 ndp16
->wLength
= cpu_to_le16(ndplen
+ sizeof(struct usb_cdc_ncm_dpe16
));
713 memcpy(skb_put(skb_out
, skb
->len
), skb
->data
, skb
->len
);
714 dev_kfree_skb_any(skb
);
717 /* send now if this NDP is full */
718 if (index
>= CDC_NCM_DPT_DATAGRAMS_MAX
) {
724 /* free up any dangling skb */
726 dev_kfree_skb_any(skb
);
728 ctx
->netdev
->stats
.tx_dropped
++;
731 ctx
->tx_curr_frame_num
= n
;
734 /* wait for more frames */
736 ctx
->tx_curr_skb
= skb_out
;
739 } else if ((n
< ctx
->tx_max_datagrams
) && (ready2send
== 0)) {
740 /* wait for more frames */
742 ctx
->tx_curr_skb
= skb_out
;
743 /* set the pending count */
744 if (n
< CDC_NCM_RESTART_TIMER_DATAGRAM_CNT
)
745 ctx
->tx_timer_pending
= CDC_NCM_TIMER_PENDING_CNT
;
750 /* variables will be reset at next call */
754 * If collected data size is less or equal CDC_NCM_MIN_TX_PKT bytes,
755 * we send buffers as it is. If we get more data, it would be more
756 * efficient for USB HS mobile device with DMA engine to receive a full
757 * size NTB, than canceling DMA transfer and receiving a short packet.
759 if (skb_out
->len
> CDC_NCM_MIN_TX_PKT
)
760 /* final zero padding */
761 memset(skb_put(skb_out
, ctx
->tx_max
- skb_out
->len
), 0, ctx
->tx_max
- skb_out
->len
);
763 /* do we need to prevent a ZLP? */
764 if (((skb_out
->len
% le16_to_cpu(ctx
->out_ep
->desc
.wMaxPacketSize
)) == 0) &&
765 (skb_out
->len
< le32_to_cpu(ctx
->ncm_parm
.dwNtbOutMaxSize
)) && skb_tailroom(skb_out
))
766 *skb_put(skb_out
, 1) = 0; /* force short packet */
768 /* set final frame length */
769 nth16
= (struct usb_cdc_ncm_nth16
*)skb_out
->data
;
770 nth16
->wBlockLength
= cpu_to_le16(skb_out
->len
);
773 ctx
->tx_curr_skb
= NULL
;
774 ctx
->netdev
->stats
.tx_packets
+= ctx
->tx_curr_frame_num
;
778 /* Start timer, if there is a remaining skb */
779 if (ctx
->tx_curr_skb
!= NULL
)
780 cdc_ncm_tx_timeout_start(ctx
);
783 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame
);
785 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx
*ctx
)
787 /* start timer, if not already started */
788 if (!(hrtimer_active(&ctx
->tx_timer
) || atomic_read(&ctx
->stop
)))
789 hrtimer_start(&ctx
->tx_timer
,
790 ktime_set(0, CDC_NCM_TIMER_INTERVAL
),
794 static enum hrtimer_restart
cdc_ncm_tx_timer_cb(struct hrtimer
*timer
)
796 struct cdc_ncm_ctx
*ctx
=
797 container_of(timer
, struct cdc_ncm_ctx
, tx_timer
);
799 if (!atomic_read(&ctx
->stop
))
800 tasklet_schedule(&ctx
->bh
);
801 return HRTIMER_NORESTART
;
804 static void cdc_ncm_txpath_bh(unsigned long param
)
806 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)param
;
808 spin_lock_bh(&ctx
->mtx
);
809 if (ctx
->tx_timer_pending
!= 0) {
810 ctx
->tx_timer_pending
--;
811 cdc_ncm_tx_timeout_start(ctx
);
812 spin_unlock_bh(&ctx
->mtx
);
813 } else if (ctx
->netdev
!= NULL
) {
814 spin_unlock_bh(&ctx
->mtx
);
815 netif_tx_lock_bh(ctx
->netdev
);
816 usbnet_start_xmit(NULL
, ctx
->netdev
);
817 netif_tx_unlock_bh(ctx
->netdev
);
821 static struct sk_buff
*
822 cdc_ncm_tx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
, gfp_t flags
)
824 struct sk_buff
*skb_out
;
825 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
828 * The Ethernet API we are using does not support transmitting
829 * multiple Ethernet frames in a single call. This driver will
830 * accumulate multiple Ethernet frames and send out a larger
831 * USB frame when the USB buffer is full or when a single jiffies
837 spin_lock_bh(&ctx
->mtx
);
838 skb_out
= cdc_ncm_fill_tx_frame(ctx
, skb
, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN
));
839 spin_unlock_bh(&ctx
->mtx
);
844 dev_kfree_skb_any(skb
);
849 /* verify NTB header and return offset of first NDP, or negative error */
850 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx
*ctx
, struct sk_buff
*skb_in
)
852 struct usb_cdc_ncm_nth16
*nth16
;
859 if (skb_in
->len
< (sizeof(struct usb_cdc_ncm_nth16
) +
860 sizeof(struct usb_cdc_ncm_ndp16
))) {
861 pr_debug("frame too short\n");
865 nth16
= (struct usb_cdc_ncm_nth16
*)skb_in
->data
;
867 if (le32_to_cpu(nth16
->dwSignature
) != USB_CDC_NCM_NTH16_SIGN
) {
868 pr_debug("invalid NTH16 signature <%u>\n",
869 le32_to_cpu(nth16
->dwSignature
));
873 len
= le16_to_cpu(nth16
->wBlockLength
);
874 if (len
> ctx
->rx_max
) {
875 pr_debug("unsupported NTB block length %u/%u\n", len
,
880 if ((ctx
->rx_seq
+ 1) != le16_to_cpu(nth16
->wSequence
) &&
881 (ctx
->rx_seq
|| le16_to_cpu(nth16
->wSequence
)) &&
882 !((ctx
->rx_seq
== 0xffff) && !le16_to_cpu(nth16
->wSequence
))) {
883 pr_debug("sequence number glitch prev=%d curr=%d\n",
884 ctx
->rx_seq
, le16_to_cpu(nth16
->wSequence
));
886 ctx
->rx_seq
= le16_to_cpu(nth16
->wSequence
);
888 ret
= le16_to_cpu(nth16
->wNdpIndex
);
892 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16
);
894 /* verify NDP header and return number of datagrams, or negative error */
895 int cdc_ncm_rx_verify_ndp16(struct sk_buff
*skb_in
, int ndpoffset
)
897 struct usb_cdc_ncm_ndp16
*ndp16
;
900 if ((ndpoffset
+ sizeof(struct usb_cdc_ncm_ndp16
)) > skb_in
->len
) {
901 pr_debug("invalid NDP offset <%u>\n", ndpoffset
);
904 ndp16
= (struct usb_cdc_ncm_ndp16
*)(skb_in
->data
+ ndpoffset
);
906 if (le16_to_cpu(ndp16
->wLength
) < USB_CDC_NCM_NDP16_LENGTH_MIN
) {
907 pr_debug("invalid DPT16 length <%u>\n",
908 le32_to_cpu(ndp16
->dwSignature
));
912 ret
= ((le16_to_cpu(ndp16
->wLength
) -
913 sizeof(struct usb_cdc_ncm_ndp16
)) /
914 sizeof(struct usb_cdc_ncm_dpe16
));
915 ret
--; /* we process NDP entries except for the last one */
917 if ((sizeof(struct usb_cdc_ncm_ndp16
) + ret
* (sizeof(struct usb_cdc_ncm_dpe16
))) >
919 pr_debug("Invalid nframes = %d\n", ret
);
926 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16
);
928 static int cdc_ncm_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb_in
)
931 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
936 struct usb_cdc_ncm_ndp16
*ndp16
;
937 struct usb_cdc_ncm_dpe16
*dpe16
;
939 int loopcount
= 50; /* arbitrary max preventing infinite loop */
941 ndpoffset
= cdc_ncm_rx_verify_nth16(ctx
, skb_in
);
946 nframes
= cdc_ncm_rx_verify_ndp16(skb_in
, ndpoffset
);
950 ndp16
= (struct usb_cdc_ncm_ndp16
*)(skb_in
->data
+ ndpoffset
);
952 if (le32_to_cpu(ndp16
->dwSignature
) != USB_CDC_NCM_NDP16_NOCRC_SIGN
) {
953 pr_debug("invalid DPT16 signature <%u>\n",
954 le32_to_cpu(ndp16
->dwSignature
));
957 dpe16
= ndp16
->dpe16
;
959 for (x
= 0; x
< nframes
; x
++, dpe16
++) {
960 offset
= le16_to_cpu(dpe16
->wDatagramIndex
);
961 len
= le16_to_cpu(dpe16
->wDatagramLength
);
965 * All entries after first NULL entry are to be ignored
967 if ((offset
== 0) || (len
== 0)) {
969 goto err_ndp
; /* empty NTB */
973 /* sanity checking */
974 if (((offset
+ len
) > skb_in
->len
) ||
975 (len
> ctx
->rx_max
) || (len
< ETH_HLEN
)) {
976 pr_debug("invalid frame detected (ignored)"
977 "offset[%u]=%u, length=%u, skb=%p\n",
978 x
, offset
, len
, skb_in
);
984 skb
= skb_clone(skb_in
, GFP_ATOMIC
);
988 skb
->data
= ((u8
*)skb_in
->data
) + offset
;
989 skb_set_tail_pointer(skb
, len
);
990 usbnet_skb_return(dev
, skb
);
994 /* are there more NDPs to process? */
995 ndpoffset
= le16_to_cpu(ndp16
->wNextNdpIndex
);
996 if (ndpoffset
&& loopcount
--)
1005 cdc_ncm_speed_change(struct cdc_ncm_ctx
*ctx
,
1006 struct usb_cdc_speed_change
*data
)
1008 uint32_t rx_speed
= le32_to_cpu(data
->DLBitRRate
);
1009 uint32_t tx_speed
= le32_to_cpu(data
->ULBitRate
);
1012 * Currently the USB-NET API does not support reporting the actual
1013 * device speed. Do print it instead.
1015 if ((tx_speed
!= ctx
->tx_speed
) || (rx_speed
!= ctx
->rx_speed
)) {
1016 ctx
->tx_speed
= tx_speed
;
1017 ctx
->rx_speed
= rx_speed
;
1019 if ((tx_speed
> 1000000) && (rx_speed
> 1000000)) {
1020 printk(KERN_INFO KBUILD_MODNAME
1021 ": %s: %u mbit/s downlink "
1022 "%u mbit/s uplink\n",
1024 (unsigned int)(rx_speed
/ 1000000U),
1025 (unsigned int)(tx_speed
/ 1000000U));
1027 printk(KERN_INFO KBUILD_MODNAME
1028 ": %s: %u kbit/s downlink "
1029 "%u kbit/s uplink\n",
1031 (unsigned int)(rx_speed
/ 1000U),
1032 (unsigned int)(tx_speed
/ 1000U));
1037 static void cdc_ncm_status(struct usbnet
*dev
, struct urb
*urb
)
1039 struct cdc_ncm_ctx
*ctx
;
1040 struct usb_cdc_notification
*event
;
1042 ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
1044 if (urb
->actual_length
< sizeof(*event
))
1047 /* test for split data in 8-byte chunks */
1048 if (test_and_clear_bit(EVENT_STS_SPLIT
, &dev
->flags
)) {
1049 cdc_ncm_speed_change(ctx
,
1050 (struct usb_cdc_speed_change
*)urb
->transfer_buffer
);
1054 event
= urb
->transfer_buffer
;
1056 switch (event
->bNotificationType
) {
1057 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
1059 * According to the CDC NCM specification ch.7.1
1060 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1061 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1063 ctx
->connected
= event
->wValue
;
1065 printk(KERN_INFO KBUILD_MODNAME
": %s: network connection:"
1067 ctx
->netdev
->name
, ctx
->connected
? "" : "dis");
1070 netif_carrier_on(dev
->net
);
1072 netif_carrier_off(dev
->net
);
1073 ctx
->tx_speed
= ctx
->rx_speed
= 0;
1077 case USB_CDC_NOTIFY_SPEED_CHANGE
:
1078 if (urb
->actual_length
< (sizeof(*event
) +
1079 sizeof(struct usb_cdc_speed_change
)))
1080 set_bit(EVENT_STS_SPLIT
, &dev
->flags
);
1082 cdc_ncm_speed_change(ctx
,
1083 (struct usb_cdc_speed_change
*) &event
[1]);
1087 dev_err(&dev
->udev
->dev
, "NCM: unexpected "
1088 "notification 0x%02x!\n", event
->bNotificationType
);
1093 static int cdc_ncm_check_connect(struct usbnet
*dev
)
1095 struct cdc_ncm_ctx
*ctx
;
1097 ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
1099 return 1; /* disconnected */
1101 return !ctx
->connected
;
1105 cdc_ncm_probe(struct usb_interface
*udev
, const struct usb_device_id
*prod
)
1107 return usbnet_probe(udev
, prod
);
1110 static void cdc_ncm_disconnect(struct usb_interface
*intf
)
1112 struct usbnet
*dev
= usb_get_intfdata(intf
);
1115 return; /* already disconnected */
1117 usbnet_disconnect(intf
);
1120 static int cdc_ncm_manage_power(struct usbnet
*dev
, int status
)
1122 dev
->intf
->needs_remote_wakeup
= status
;
1126 static const struct driver_info cdc_ncm_info
= {
1127 .description
= "CDC NCM",
1128 .flags
= FLAG_POINTTOPOINT
| FLAG_NO_SETINT
| FLAG_MULTI_PACKET
,
1129 .bind
= cdc_ncm_bind
,
1130 .unbind
= cdc_ncm_unbind
,
1131 .check_connect
= cdc_ncm_check_connect
,
1132 .manage_power
= cdc_ncm_manage_power
,
1133 .status
= cdc_ncm_status
,
1134 .rx_fixup
= cdc_ncm_rx_fixup
,
1135 .tx_fixup
= cdc_ncm_tx_fixup
,
1138 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1139 static const struct driver_info wwan_info
= {
1140 .description
= "Mobile Broadband Network Device",
1141 .flags
= FLAG_POINTTOPOINT
| FLAG_NO_SETINT
| FLAG_MULTI_PACKET
1143 .bind
= cdc_ncm_bind
,
1144 .unbind
= cdc_ncm_unbind
,
1145 .check_connect
= cdc_ncm_check_connect
,
1146 .manage_power
= cdc_ncm_manage_power
,
1147 .status
= cdc_ncm_status
,
1148 .rx_fixup
= cdc_ncm_rx_fixup
,
1149 .tx_fixup
= cdc_ncm_tx_fixup
,
1152 static const struct usb_device_id cdc_devs
[] = {
1153 /* Ericsson MBM devices like F5521gw */
1154 { .match_flags
= USB_DEVICE_ID_MATCH_INT_INFO
1155 | USB_DEVICE_ID_MATCH_VENDOR
,
1157 .bInterfaceClass
= USB_CLASS_COMM
,
1158 .bInterfaceSubClass
= USB_CDC_SUBCLASS_NCM
,
1159 .bInterfaceProtocol
= USB_CDC_PROTO_NONE
,
1160 .driver_info
= (unsigned long) &wwan_info
,
1163 /* Dell branded MBM devices like DW5550 */
1164 { .match_flags
= USB_DEVICE_ID_MATCH_INT_INFO
1165 | USB_DEVICE_ID_MATCH_VENDOR
,
1167 .bInterfaceClass
= USB_CLASS_COMM
,
1168 .bInterfaceSubClass
= USB_CDC_SUBCLASS_NCM
,
1169 .bInterfaceProtocol
= USB_CDC_PROTO_NONE
,
1170 .driver_info
= (unsigned long) &wwan_info
,
1173 /* Toshiba branded MBM devices */
1174 { .match_flags
= USB_DEVICE_ID_MATCH_INT_INFO
1175 | USB_DEVICE_ID_MATCH_VENDOR
,
1177 .bInterfaceClass
= USB_CLASS_COMM
,
1178 .bInterfaceSubClass
= USB_CDC_SUBCLASS_NCM
,
1179 .bInterfaceProtocol
= USB_CDC_PROTO_NONE
,
1180 .driver_info
= (unsigned long) &wwan_info
,
1183 /* Generic CDC-NCM devices */
1184 { USB_INTERFACE_INFO(USB_CLASS_COMM
,
1185 USB_CDC_SUBCLASS_NCM
, USB_CDC_PROTO_NONE
),
1186 .driver_info
= (unsigned long)&cdc_ncm_info
,
1191 MODULE_DEVICE_TABLE(usb
, cdc_devs
);
1193 static struct usb_driver cdc_ncm_driver
= {
1195 .id_table
= cdc_devs
,
1196 .probe
= cdc_ncm_probe
,
1197 .disconnect
= cdc_ncm_disconnect
,
1198 .suspend
= usbnet_suspend
,
1199 .resume
= usbnet_resume
,
1200 .reset_resume
= usbnet_resume
,
1201 .supports_autosuspend
= 1,
1202 .disable_hub_initiated_lpm
= 1,
1205 module_usb_driver(cdc_ncm_driver
);
1207 MODULE_AUTHOR("Hans Petter Selasky");
1208 MODULE_DESCRIPTION("USB CDC NCM host driver");
1209 MODULE_LICENSE("Dual BSD/GPL");