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>
55 #define DRIVER_VERSION "14-Mar-2012"
57 /* CDC NCM subclass 3.2.1 */
58 #define USB_CDC_NCM_NDP16_LENGTH_MIN 0x10
60 /* Maximum NTB length */
61 #define CDC_NCM_NTB_MAX_SIZE_TX 32768 /* bytes */
62 #define CDC_NCM_NTB_MAX_SIZE_RX 32768 /* bytes */
64 /* Minimum value for MaxDatagramSize, ch. 6.2.9 */
65 #define CDC_NCM_MIN_DATAGRAM_SIZE 1514 /* bytes */
67 #define CDC_NCM_MIN_TX_PKT 512 /* bytes */
69 /* Default value for MaxDatagramSize */
70 #define CDC_NCM_MAX_DATAGRAM_SIZE 8192 /* bytes */
73 * Maximum amount of datagrams in NCM Datagram Pointer Table, not counting
74 * the last NULL entry.
76 #define CDC_NCM_DPT_DATAGRAMS_MAX 40
78 /* Restart the timer, if amount of datagrams is less than given value */
79 #define CDC_NCM_RESTART_TIMER_DATAGRAM_CNT 3
80 #define CDC_NCM_TIMER_PENDING_CNT 2
81 #define CDC_NCM_TIMER_INTERVAL (400UL * NSEC_PER_USEC)
83 /* The following macro defines the minimum header space */
84 #define CDC_NCM_MIN_HDR_SIZE \
85 (sizeof(struct usb_cdc_ncm_nth16) + sizeof(struct usb_cdc_ncm_ndp16) + \
86 (CDC_NCM_DPT_DATAGRAMS_MAX + 1) * sizeof(struct usb_cdc_ncm_dpe16))
89 struct usb_cdc_ncm_nth16 nth16
;
90 struct usb_cdc_ncm_ndp16 ndp16
;
91 struct usb_cdc_ncm_dpe16 dpe16
[CDC_NCM_DPT_DATAGRAMS_MAX
+ 1];
95 struct cdc_ncm_data tx_ncm
;
96 struct usb_cdc_ncm_ntb_parameters ncm_parm
;
97 struct hrtimer tx_timer
;
98 struct tasklet_struct bh
;
100 const struct usb_cdc_ncm_desc
*func_desc
;
101 const struct usb_cdc_header_desc
*header_desc
;
102 const struct usb_cdc_union_desc
*union_desc
;
103 const struct usb_cdc_ether_desc
*ether_desc
;
105 struct net_device
*netdev
;
106 struct usb_device
*udev
;
107 struct usb_host_endpoint
*in_ep
;
108 struct usb_host_endpoint
*out_ep
;
109 struct usb_host_endpoint
*status_ep
;
110 struct usb_interface
*intf
;
111 struct usb_interface
*control
;
112 struct usb_interface
*data
;
114 struct sk_buff
*tx_curr_skb
;
115 struct sk_buff
*tx_rem_skb
;
120 u32 tx_timer_pending
;
122 u32 tx_curr_last_offset
;
123 u32 tx_curr_frame_num
;
128 u32 max_datagram_size
;
129 u16 tx_max_datagrams
;
138 static void cdc_ncm_txpath_bh(unsigned long param
);
139 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx
*ctx
);
140 static enum hrtimer_restart
cdc_ncm_tx_timer_cb(struct hrtimer
*hr_timer
);
141 static const struct driver_info cdc_ncm_info
;
142 static struct usb_driver cdc_ncm_driver
;
143 static const struct ethtool_ops cdc_ncm_ethtool_ops
;
145 static const struct usb_device_id cdc_devs
[] = {
146 { USB_INTERFACE_INFO(USB_CLASS_COMM
,
147 USB_CDC_SUBCLASS_NCM
, USB_CDC_PROTO_NONE
),
148 .driver_info
= (unsigned long)&cdc_ncm_info
,
154 MODULE_DEVICE_TABLE(usb
, cdc_devs
);
157 cdc_ncm_get_drvinfo(struct net_device
*net
, struct ethtool_drvinfo
*info
)
159 struct usbnet
*dev
= netdev_priv(net
);
161 strncpy(info
->driver
, dev
->driver_name
, sizeof(info
->driver
));
162 strncpy(info
->version
, DRIVER_VERSION
, sizeof(info
->version
));
163 strncpy(info
->fw_version
, dev
->driver_info
->description
,
164 sizeof(info
->fw_version
));
165 usb_make_path(dev
->udev
, info
->bus_info
, sizeof(info
->bus_info
));
168 static u8
cdc_ncm_setup(struct cdc_ncm_ctx
*ctx
)
174 u16 ntb_fmt_supported
;
176 iface_no
= ctx
->control
->cur_altsetting
->desc
.bInterfaceNumber
;
178 err
= usb_control_msg(ctx
->udev
,
179 usb_rcvctrlpipe(ctx
->udev
, 0),
180 USB_CDC_GET_NTB_PARAMETERS
,
181 USB_TYPE_CLASS
| USB_DIR_IN
182 | USB_RECIP_INTERFACE
,
183 0, iface_no
, &ctx
->ncm_parm
,
184 sizeof(ctx
->ncm_parm
), 10000);
186 pr_debug("failed GET_NTB_PARAMETERS\n");
190 /* read correct set of parameters according to device mode */
191 ctx
->rx_max
= le32_to_cpu(ctx
->ncm_parm
.dwNtbInMaxSize
);
192 ctx
->tx_max
= le32_to_cpu(ctx
->ncm_parm
.dwNtbOutMaxSize
);
193 ctx
->tx_remainder
= le16_to_cpu(ctx
->ncm_parm
.wNdpOutPayloadRemainder
);
194 ctx
->tx_modulus
= le16_to_cpu(ctx
->ncm_parm
.wNdpOutDivisor
);
195 ctx
->tx_ndp_modulus
= le16_to_cpu(ctx
->ncm_parm
.wNdpOutAlignment
);
196 /* devices prior to NCM Errata shall set this field to zero */
197 ctx
->tx_max_datagrams
= le16_to_cpu(ctx
->ncm_parm
.wNtbOutMaxDatagrams
);
198 ntb_fmt_supported
= le16_to_cpu(ctx
->ncm_parm
.bmNtbFormatsSupported
);
200 if (ctx
->func_desc
!= NULL
)
201 flags
= ctx
->func_desc
->bmNetworkCapabilities
;
205 pr_debug("dwNtbInMaxSize=%u dwNtbOutMaxSize=%u "
206 "wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u "
207 "wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
208 ctx
->rx_max
, ctx
->tx_max
, ctx
->tx_remainder
, ctx
->tx_modulus
,
209 ctx
->tx_ndp_modulus
, ctx
->tx_max_datagrams
, flags
);
211 /* max count of tx datagrams */
212 if ((ctx
->tx_max_datagrams
== 0) ||
213 (ctx
->tx_max_datagrams
> CDC_NCM_DPT_DATAGRAMS_MAX
))
214 ctx
->tx_max_datagrams
= CDC_NCM_DPT_DATAGRAMS_MAX
;
216 /* verify maximum size of received NTB in bytes */
217 if (ctx
->rx_max
< USB_CDC_NCM_NTB_MIN_IN_SIZE
) {
218 pr_debug("Using min receive length=%d\n",
219 USB_CDC_NCM_NTB_MIN_IN_SIZE
);
220 ctx
->rx_max
= USB_CDC_NCM_NTB_MIN_IN_SIZE
;
223 if (ctx
->rx_max
> CDC_NCM_NTB_MAX_SIZE_RX
) {
224 pr_debug("Using default maximum receive length=%d\n",
225 CDC_NCM_NTB_MAX_SIZE_RX
);
226 ctx
->rx_max
= CDC_NCM_NTB_MAX_SIZE_RX
;
229 /* inform device about NTB input size changes */
230 if (ctx
->rx_max
!= le32_to_cpu(ctx
->ncm_parm
.dwNtbInMaxSize
)) {
232 if (flags
& USB_CDC_NCM_NCAP_NTB_INPUT_SIZE
) {
233 struct usb_cdc_ncm_ndp_input_size
*ndp_in_sz
;
235 ndp_in_sz
= kzalloc(sizeof(*ndp_in_sz
), GFP_KERNEL
);
241 err
= usb_control_msg(ctx
->udev
,
242 usb_sndctrlpipe(ctx
->udev
, 0),
243 USB_CDC_SET_NTB_INPUT_SIZE
,
244 USB_TYPE_CLASS
| USB_DIR_OUT
245 | USB_RECIP_INTERFACE
,
246 0, iface_no
, ndp_in_sz
, 8, 1000);
249 __le32
*dwNtbInMaxSize
;
250 dwNtbInMaxSize
= kzalloc(sizeof(*dwNtbInMaxSize
),
252 if (!dwNtbInMaxSize
) {
256 *dwNtbInMaxSize
= cpu_to_le32(ctx
->rx_max
);
258 err
= usb_control_msg(ctx
->udev
,
259 usb_sndctrlpipe(ctx
->udev
, 0),
260 USB_CDC_SET_NTB_INPUT_SIZE
,
261 USB_TYPE_CLASS
| USB_DIR_OUT
262 | USB_RECIP_INTERFACE
,
263 0, iface_no
, dwNtbInMaxSize
, 4, 1000);
264 kfree(dwNtbInMaxSize
);
268 pr_debug("Setting NTB Input Size failed\n");
271 /* verify maximum size of transmitted NTB in bytes */
273 (CDC_NCM_MIN_HDR_SIZE
+ CDC_NCM_MIN_DATAGRAM_SIZE
)) ||
274 (ctx
->tx_max
> CDC_NCM_NTB_MAX_SIZE_TX
)) {
275 pr_debug("Using default maximum transmit length=%d\n",
276 CDC_NCM_NTB_MAX_SIZE_TX
);
277 ctx
->tx_max
= CDC_NCM_NTB_MAX_SIZE_TX
;
281 * verify that the structure alignment is:
283 * - not greater than the maximum transmit length
284 * - not less than four bytes
286 val
= ctx
->tx_ndp_modulus
;
288 if ((val
< USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
) ||
289 (val
!= ((-val
) & val
)) || (val
>= ctx
->tx_max
)) {
290 pr_debug("Using default alignment: 4 bytes\n");
291 ctx
->tx_ndp_modulus
= USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
;
295 * verify that the payload alignment is:
297 * - not greater than the maximum transmit length
298 * - not less than four bytes
300 val
= ctx
->tx_modulus
;
302 if ((val
< USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
) ||
303 (val
!= ((-val
) & val
)) || (val
>= ctx
->tx_max
)) {
304 pr_debug("Using default transmit modulus: 4 bytes\n");
305 ctx
->tx_modulus
= USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
;
308 /* verify the payload remainder */
309 if (ctx
->tx_remainder
>= ctx
->tx_modulus
) {
310 pr_debug("Using default transmit remainder: 0 bytes\n");
311 ctx
->tx_remainder
= 0;
314 /* adjust TX-remainder according to NCM specification. */
315 ctx
->tx_remainder
= ((ctx
->tx_remainder
- ETH_HLEN
) &
316 (ctx
->tx_modulus
- 1));
318 /* additional configuration */
321 if (flags
& USB_CDC_NCM_NCAP_CRC_MODE
) {
322 err
= usb_control_msg(ctx
->udev
, usb_sndctrlpipe(ctx
->udev
, 0),
323 USB_CDC_SET_CRC_MODE
,
324 USB_TYPE_CLASS
| USB_DIR_OUT
325 | USB_RECIP_INTERFACE
,
326 USB_CDC_NCM_CRC_NOT_APPENDED
,
327 iface_no
, NULL
, 0, 1000);
329 pr_debug("Setting CRC mode off failed\n");
332 /* set NTB format, if both formats are supported */
333 if (ntb_fmt_supported
& USB_CDC_NCM_NTH32_SIGN
) {
334 err
= usb_control_msg(ctx
->udev
, usb_sndctrlpipe(ctx
->udev
, 0),
335 USB_CDC_SET_NTB_FORMAT
, USB_TYPE_CLASS
336 | USB_DIR_OUT
| USB_RECIP_INTERFACE
,
337 USB_CDC_NCM_NTB16_FORMAT
,
338 iface_no
, NULL
, 0, 1000);
340 pr_debug("Setting NTB format to 16-bit failed\n");
343 ctx
->max_datagram_size
= CDC_NCM_MIN_DATAGRAM_SIZE
;
345 /* set Max Datagram Size (MTU) */
346 if (flags
& USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE
) {
347 __le16
*max_datagram_size
;
348 u16 eth_max_sz
= le16_to_cpu(ctx
->ether_desc
->wMaxSegmentSize
);
350 max_datagram_size
= kzalloc(sizeof(*max_datagram_size
),
352 if (!max_datagram_size
) {
357 err
= usb_control_msg(ctx
->udev
, usb_rcvctrlpipe(ctx
->udev
, 0),
358 USB_CDC_GET_MAX_DATAGRAM_SIZE
,
359 USB_TYPE_CLASS
| USB_DIR_IN
360 | USB_RECIP_INTERFACE
,
361 0, iface_no
, max_datagram_size
,
364 pr_debug("GET_MAX_DATAGRAM_SIZE failed, use size=%u\n",
365 CDC_NCM_MIN_DATAGRAM_SIZE
);
367 ctx
->max_datagram_size
=
368 le16_to_cpu(*max_datagram_size
);
369 /* Check Eth descriptor value */
370 if (ctx
->max_datagram_size
> eth_max_sz
)
371 ctx
->max_datagram_size
= eth_max_sz
;
373 if (ctx
->max_datagram_size
> CDC_NCM_MAX_DATAGRAM_SIZE
)
374 ctx
->max_datagram_size
=
375 CDC_NCM_MAX_DATAGRAM_SIZE
;
377 if (ctx
->max_datagram_size
< CDC_NCM_MIN_DATAGRAM_SIZE
)
378 ctx
->max_datagram_size
=
379 CDC_NCM_MIN_DATAGRAM_SIZE
;
381 /* if value changed, update device */
382 if (ctx
->max_datagram_size
!=
383 le16_to_cpu(*max_datagram_size
)) {
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
,
390 iface_no
, max_datagram_size
,
393 pr_debug("SET_MAX_DGRAM_SIZE failed\n");
396 kfree(max_datagram_size
);
400 if (ctx
->netdev
->mtu
!= (ctx
->max_datagram_size
- ETH_HLEN
))
401 ctx
->netdev
->mtu
= ctx
->max_datagram_size
- ETH_HLEN
;
407 cdc_ncm_find_endpoints(struct cdc_ncm_ctx
*ctx
, struct usb_interface
*intf
)
409 struct usb_host_endpoint
*e
;
412 for (ep
= 0; ep
< intf
->cur_altsetting
->desc
.bNumEndpoints
; ep
++) {
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
)
423 case USB_ENDPOINT_XFER_BULK
:
424 if (usb_endpoint_dir_in(&e
->desc
)) {
425 if (ctx
->in_ep
== NULL
)
428 if (ctx
->out_ep
== NULL
)
439 static void cdc_ncm_free(struct cdc_ncm_ctx
*ctx
)
444 if (ctx
->tx_rem_skb
!= NULL
) {
445 dev_kfree_skb_any(ctx
->tx_rem_skb
);
446 ctx
->tx_rem_skb
= NULL
;
449 if (ctx
->tx_curr_skb
!= NULL
) {
450 dev_kfree_skb_any(ctx
->tx_curr_skb
);
451 ctx
->tx_curr_skb
= NULL
;
457 static int cdc_ncm_bind(struct usbnet
*dev
, struct usb_interface
*intf
)
459 struct cdc_ncm_ctx
*ctx
;
460 struct usb_driver
*driver
;
466 ctx
= kzalloc(sizeof(*ctx
), GFP_KERNEL
);
470 hrtimer_init(&ctx
->tx_timer
, CLOCK_MONOTONIC
, HRTIMER_MODE_REL
);
471 ctx
->tx_timer
.function
= &cdc_ncm_tx_timer_cb
;
472 ctx
->bh
.data
= (unsigned long)ctx
;
473 ctx
->bh
.func
= cdc_ncm_txpath_bh
;
474 atomic_set(&ctx
->stop
, 0);
475 spin_lock_init(&ctx
->mtx
);
476 ctx
->netdev
= dev
->net
;
478 /* store ctx pointer in device data field */
479 dev
->data
[0] = (unsigned long)ctx
;
481 /* get some pointers */
482 driver
= driver_of(intf
);
483 buf
= intf
->cur_altsetting
->extra
;
484 len
= intf
->cur_altsetting
->extralen
;
486 ctx
->udev
= dev
->udev
;
489 /* parse through descriptors associated with control interface */
490 while ((len
> 0) && (buf
[0] > 2) && (buf
[0] <= len
)) {
492 if (buf
[1] != USB_DT_CS_INTERFACE
)
496 case USB_CDC_UNION_TYPE
:
497 if (buf
[0] < sizeof(*(ctx
->union_desc
)))
501 (const struct usb_cdc_union_desc
*)buf
;
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
);
509 case USB_CDC_ETHERNET_TYPE
:
510 if (buf
[0] < sizeof(*(ctx
->ether_desc
)))
514 (const struct usb_cdc_ether_desc
*)buf
;
516 le16_to_cpu(ctx
->ether_desc
->wMaxSegmentSize
);
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
;
524 case USB_CDC_NCM_TYPE
:
525 if (buf
[0] < sizeof(*(ctx
->func_desc
)))
528 ctx
->func_desc
= (const struct usb_cdc_ncm_desc
*)buf
;
535 /* advance to next descriptor */
541 /* check if we got everything */
542 if ((ctx
->control
== NULL
) || (ctx
->data
== NULL
) ||
543 (ctx
->ether_desc
== NULL
) || (ctx
->control
!= intf
))
546 /* claim interfaces, if any */
547 temp
= usb_driver_claim_interface(driver
, ctx
->data
, dev
);
551 iface_no
= ctx
->data
->cur_altsetting
->desc
.bInterfaceNumber
;
553 /* reset data interface */
554 temp
= usb_set_interface(dev
->udev
, iface_no
, 0);
558 /* initialize data interface */
559 if (cdc_ncm_setup(ctx
))
562 /* configure data interface */
563 temp
= usb_set_interface(dev
->udev
, iface_no
, 1);
567 cdc_ncm_find_endpoints(ctx
, ctx
->data
);
568 cdc_ncm_find_endpoints(ctx
, ctx
->control
);
570 if ((ctx
->in_ep
== NULL
) || (ctx
->out_ep
== NULL
) ||
571 (ctx
->status_ep
== NULL
))
574 dev
->net
->ethtool_ops
= &cdc_ncm_ethtool_ops
;
576 usb_set_intfdata(ctx
->data
, dev
);
577 usb_set_intfdata(ctx
->control
, dev
);
578 usb_set_intfdata(ctx
->intf
, dev
);
580 temp
= usbnet_get_ethernet_addr(dev
, ctx
->ether_desc
->iMACAddress
);
584 dev_info(&dev
->udev
->dev
, "MAC-Address: %pM\n", dev
->net
->dev_addr
);
586 dev
->in
= usb_rcvbulkpipe(dev
->udev
,
587 ctx
->in_ep
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
588 dev
->out
= usb_sndbulkpipe(dev
->udev
,
589 ctx
->out_ep
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
590 dev
->status
= ctx
->status_ep
;
591 dev
->rx_urb_size
= ctx
->rx_max
;
594 * We should get an event when network connection is "connected" or
595 * "disconnected". Set network connection in "disconnected" state
596 * (carrier is OFF) during attach, so the IP network stack does not
597 * start IPv6 negotiation and more.
599 netif_carrier_off(dev
->net
);
600 ctx
->tx_speed
= ctx
->rx_speed
= 0;
604 usb_set_intfdata(ctx
->control
, NULL
);
605 usb_set_intfdata(ctx
->data
, NULL
);
606 usb_driver_release_interface(driver
, ctx
->data
);
608 cdc_ncm_free((struct cdc_ncm_ctx
*)dev
->data
[0]);
610 dev_info(&dev
->udev
->dev
, "bind() failure\n");
614 static void cdc_ncm_unbind(struct usbnet
*dev
, struct usb_interface
*intf
)
616 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
617 struct usb_driver
*driver
= driver_of(intf
);
620 return; /* no setup */
622 atomic_set(&ctx
->stop
, 1);
624 if (hrtimer_active(&ctx
->tx_timer
))
625 hrtimer_cancel(&ctx
->tx_timer
);
627 tasklet_kill(&ctx
->bh
);
629 /* disconnect master --> disconnect slave */
630 if (intf
== ctx
->control
&& ctx
->data
) {
631 usb_set_intfdata(ctx
->data
, NULL
);
632 usb_driver_release_interface(driver
, ctx
->data
);
635 } else if (intf
== ctx
->data
&& ctx
->control
) {
636 usb_set_intfdata(ctx
->control
, NULL
);
637 usb_driver_release_interface(driver
, ctx
->control
);
641 usb_set_intfdata(ctx
->intf
, NULL
);
645 static void cdc_ncm_zero_fill(u8
*ptr
, u32 first
, u32 end
, u32 max
)
653 memset(ptr
+ first
, 0, end
- first
);
656 static struct sk_buff
*
657 cdc_ncm_fill_tx_frame(struct cdc_ncm_ctx
*ctx
, struct sk_buff
*skb
)
659 struct sk_buff
*skb_out
;
666 /* if there is a remaining skb, it gets priority */
668 swap(skb
, ctx
->tx_rem_skb
);
680 /* check if we are resuming an OUT skb */
681 if (ctx
->tx_curr_skb
!= NULL
) {
683 skb_out
= ctx
->tx_curr_skb
;
684 offset
= ctx
->tx_curr_offset
;
685 last_offset
= ctx
->tx_curr_last_offset
;
686 n
= ctx
->tx_curr_frame_num
;
689 /* reset variables */
690 skb_out
= alloc_skb((ctx
->tx_max
+ 1), GFP_ATOMIC
);
691 if (skb_out
== NULL
) {
693 dev_kfree_skb_any(skb
);
694 ctx
->netdev
->stats
.tx_dropped
++;
699 /* make room for NTH and NDP */
700 offset
= ALIGN(sizeof(struct usb_cdc_ncm_nth16
),
701 ctx
->tx_ndp_modulus
) +
702 sizeof(struct usb_cdc_ncm_ndp16
) +
703 (ctx
->tx_max_datagrams
+ 1) *
704 sizeof(struct usb_cdc_ncm_dpe16
);
706 /* store last valid offset before alignment */
707 last_offset
= offset
;
708 /* align first Datagram offset correctly */
709 offset
= ALIGN(offset
, ctx
->tx_modulus
) + ctx
->tx_remainder
;
710 /* zero buffer till the first IP datagram */
711 cdc_ncm_zero_fill(skb_out
->data
, 0, offset
, offset
);
713 ctx
->tx_curr_frame_num
= 0;
716 for (; n
< ctx
->tx_max_datagrams
; n
++) {
717 /* check if end of transmit buffer is reached */
718 if (offset
>= ctx
->tx_max
) {
722 /* compute maximum buffer size */
723 rem
= ctx
->tx_max
- offset
;
726 skb
= ctx
->tx_rem_skb
;
727 ctx
->tx_rem_skb
= NULL
;
729 /* check for end of skb */
734 if (skb
->len
> rem
) {
736 /* won't fit, MTU problem? */
737 dev_kfree_skb_any(skb
);
739 ctx
->netdev
->stats
.tx_dropped
++;
741 /* no room for skb - store for later */
742 if (ctx
->tx_rem_skb
!= NULL
) {
743 dev_kfree_skb_any(ctx
->tx_rem_skb
);
744 ctx
->netdev
->stats
.tx_dropped
++;
746 ctx
->tx_rem_skb
= skb
;
753 memcpy(((u8
*)skb_out
->data
) + offset
, skb
->data
, skb
->len
);
755 ctx
->tx_ncm
.dpe16
[n
].wDatagramLength
= cpu_to_le16(skb
->len
);
756 ctx
->tx_ncm
.dpe16
[n
].wDatagramIndex
= cpu_to_le16(offset
);
761 /* store last valid offset before alignment */
762 last_offset
= offset
;
764 /* align offset correctly */
765 offset
= ALIGN(offset
, ctx
->tx_modulus
) + ctx
->tx_remainder
;
768 cdc_ncm_zero_fill(skb_out
->data
, last_offset
, offset
,
770 dev_kfree_skb_any(skb
);
774 /* free up any dangling skb */
776 dev_kfree_skb_any(skb
);
778 ctx
->netdev
->stats
.tx_dropped
++;
781 ctx
->tx_curr_frame_num
= n
;
784 /* wait for more frames */
786 ctx
->tx_curr_skb
= skb_out
;
787 ctx
->tx_curr_offset
= offset
;
788 ctx
->tx_curr_last_offset
= last_offset
;
791 } else if ((n
< ctx
->tx_max_datagrams
) && (ready2send
== 0)) {
792 /* wait for more frames */
794 ctx
->tx_curr_skb
= skb_out
;
795 ctx
->tx_curr_offset
= offset
;
796 ctx
->tx_curr_last_offset
= last_offset
;
797 /* set the pending count */
798 if (n
< CDC_NCM_RESTART_TIMER_DATAGRAM_CNT
)
799 ctx
->tx_timer_pending
= CDC_NCM_TIMER_PENDING_CNT
;
804 /* variables will be reset at next call */
807 /* check for overflow */
808 if (last_offset
> ctx
->tx_max
)
809 last_offset
= ctx
->tx_max
;
812 offset
= last_offset
;
815 * If collected data size is less or equal CDC_NCM_MIN_TX_PKT bytes,
816 * we send buffers as it is. If we get more data, it would be more
817 * efficient for USB HS mobile device with DMA engine to receive a full
818 * size NTB, than canceling DMA transfer and receiving a short packet.
820 if (offset
> CDC_NCM_MIN_TX_PKT
)
821 offset
= ctx
->tx_max
;
823 /* final zero padding */
824 cdc_ncm_zero_fill(skb_out
->data
, last_offset
, offset
, ctx
->tx_max
);
826 /* store last offset */
827 last_offset
= offset
;
829 if (((last_offset
< ctx
->tx_max
) && ((last_offset
%
830 le16_to_cpu(ctx
->out_ep
->desc
.wMaxPacketSize
)) == 0)) ||
831 (((last_offset
== ctx
->tx_max
) && ((ctx
->tx_max
%
832 le16_to_cpu(ctx
->out_ep
->desc
.wMaxPacketSize
)) == 0)) &&
833 (ctx
->tx_max
< le32_to_cpu(ctx
->ncm_parm
.dwNtbOutMaxSize
)))) {
834 /* force short packet */
835 *(((u8
*)skb_out
->data
) + last_offset
) = 0;
839 /* zero the rest of the DPEs plus the last NULL entry */
840 for (; n
<= CDC_NCM_DPT_DATAGRAMS_MAX
; n
++) {
841 ctx
->tx_ncm
.dpe16
[n
].wDatagramLength
= 0;
842 ctx
->tx_ncm
.dpe16
[n
].wDatagramIndex
= 0;
845 /* fill out 16-bit NTB header */
846 ctx
->tx_ncm
.nth16
.dwSignature
= cpu_to_le32(USB_CDC_NCM_NTH16_SIGN
);
847 ctx
->tx_ncm
.nth16
.wHeaderLength
=
848 cpu_to_le16(sizeof(ctx
->tx_ncm
.nth16
));
849 ctx
->tx_ncm
.nth16
.wSequence
= cpu_to_le16(ctx
->tx_seq
);
850 ctx
->tx_ncm
.nth16
.wBlockLength
= cpu_to_le16(last_offset
);
851 index
= ALIGN(sizeof(struct usb_cdc_ncm_nth16
), ctx
->tx_ndp_modulus
);
852 ctx
->tx_ncm
.nth16
.wNdpIndex
= cpu_to_le16(index
);
854 memcpy(skb_out
->data
, &(ctx
->tx_ncm
.nth16
), sizeof(ctx
->tx_ncm
.nth16
));
857 /* fill out 16-bit NDP table */
858 ctx
->tx_ncm
.ndp16
.dwSignature
=
859 cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN
);
860 rem
= sizeof(ctx
->tx_ncm
.ndp16
) + ((ctx
->tx_curr_frame_num
+ 1) *
861 sizeof(struct usb_cdc_ncm_dpe16
));
862 ctx
->tx_ncm
.ndp16
.wLength
= cpu_to_le16(rem
);
863 ctx
->tx_ncm
.ndp16
.wNextNdpIndex
= 0; /* reserved */
865 memcpy(((u8
*)skb_out
->data
) + index
,
866 &(ctx
->tx_ncm
.ndp16
),
867 sizeof(ctx
->tx_ncm
.ndp16
));
869 memcpy(((u8
*)skb_out
->data
) + index
+ sizeof(ctx
->tx_ncm
.ndp16
),
870 &(ctx
->tx_ncm
.dpe16
),
871 (ctx
->tx_curr_frame_num
+ 1) *
872 sizeof(struct usb_cdc_ncm_dpe16
));
874 /* set frame length */
875 skb_put(skb_out
, last_offset
);
878 ctx
->tx_curr_skb
= NULL
;
879 ctx
->netdev
->stats
.tx_packets
+= ctx
->tx_curr_frame_num
;
883 /* Start timer, if there is a remaining skb */
884 if (ctx
->tx_curr_skb
!= NULL
)
885 cdc_ncm_tx_timeout_start(ctx
);
889 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx
*ctx
)
891 /* start timer, if not already started */
892 if (!(hrtimer_active(&ctx
->tx_timer
) || atomic_read(&ctx
->stop
)))
893 hrtimer_start(&ctx
->tx_timer
,
894 ktime_set(0, CDC_NCM_TIMER_INTERVAL
),
898 static enum hrtimer_restart
cdc_ncm_tx_timer_cb(struct hrtimer
*timer
)
900 struct cdc_ncm_ctx
*ctx
=
901 container_of(timer
, struct cdc_ncm_ctx
, tx_timer
);
903 if (!atomic_read(&ctx
->stop
))
904 tasklet_schedule(&ctx
->bh
);
905 return HRTIMER_NORESTART
;
908 static void cdc_ncm_txpath_bh(unsigned long param
)
910 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)param
;
912 spin_lock_bh(&ctx
->mtx
);
913 if (ctx
->tx_timer_pending
!= 0) {
914 ctx
->tx_timer_pending
--;
915 cdc_ncm_tx_timeout_start(ctx
);
916 spin_unlock_bh(&ctx
->mtx
);
917 } else if (ctx
->netdev
!= NULL
) {
918 spin_unlock_bh(&ctx
->mtx
);
919 netif_tx_lock_bh(ctx
->netdev
);
920 usbnet_start_xmit(NULL
, ctx
->netdev
);
921 netif_tx_unlock_bh(ctx
->netdev
);
925 static struct sk_buff
*
926 cdc_ncm_tx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
, gfp_t flags
)
928 struct sk_buff
*skb_out
;
929 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
932 * The Ethernet API we are using does not support transmitting
933 * multiple Ethernet frames in a single call. This driver will
934 * accumulate multiple Ethernet frames and send out a larger
935 * USB frame when the USB buffer is full or when a single jiffies
941 spin_lock_bh(&ctx
->mtx
);
942 skb_out
= cdc_ncm_fill_tx_frame(ctx
, skb
);
943 spin_unlock_bh(&ctx
->mtx
);
948 dev_kfree_skb_any(skb
);
953 static int cdc_ncm_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb_in
)
956 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
961 struct usb_cdc_ncm_nth16
*nth16
;
962 struct usb_cdc_ncm_ndp16
*ndp16
;
963 struct usb_cdc_ncm_dpe16
*dpe16
;
968 if (skb_in
->len
< (sizeof(struct usb_cdc_ncm_nth16
) +
969 sizeof(struct usb_cdc_ncm_ndp16
))) {
970 pr_debug("frame too short\n");
974 nth16
= (struct usb_cdc_ncm_nth16
*)skb_in
->data
;
976 if (le32_to_cpu(nth16
->dwSignature
) != USB_CDC_NCM_NTH16_SIGN
) {
977 pr_debug("invalid NTH16 signature <%u>\n",
978 le32_to_cpu(nth16
->dwSignature
));
982 len
= le16_to_cpu(nth16
->wBlockLength
);
983 if (len
> ctx
->rx_max
) {
984 pr_debug("unsupported NTB block length %u/%u\n", len
,
989 if ((ctx
->rx_seq
+ 1) != le16_to_cpu(nth16
->wSequence
) &&
990 (ctx
->rx_seq
|| le16_to_cpu(nth16
->wSequence
)) &&
991 !((ctx
->rx_seq
== 0xffff) && !le16_to_cpu(nth16
->wSequence
))) {
992 pr_debug("sequence number glitch prev=%d curr=%d\n",
993 ctx
->rx_seq
, le16_to_cpu(nth16
->wSequence
));
995 ctx
->rx_seq
= le16_to_cpu(nth16
->wSequence
);
997 len
= le16_to_cpu(nth16
->wNdpIndex
);
998 if ((len
+ sizeof(struct usb_cdc_ncm_ndp16
)) > skb_in
->len
) {
999 pr_debug("invalid DPT16 index <%u>\n",
1000 le16_to_cpu(nth16
->wNdpIndex
));
1004 ndp16
= (struct usb_cdc_ncm_ndp16
*)(((u8
*)skb_in
->data
) + len
);
1006 if (le32_to_cpu(ndp16
->dwSignature
) != USB_CDC_NCM_NDP16_NOCRC_SIGN
) {
1007 pr_debug("invalid DPT16 signature <%u>\n",
1008 le32_to_cpu(ndp16
->dwSignature
));
1012 if (le16_to_cpu(ndp16
->wLength
) < USB_CDC_NCM_NDP16_LENGTH_MIN
) {
1013 pr_debug("invalid DPT16 length <%u>\n",
1014 le32_to_cpu(ndp16
->dwSignature
));
1018 nframes
= ((le16_to_cpu(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 */
1023 len
+= sizeof(struct usb_cdc_ncm_ndp16
);
1025 if ((len
+ nframes
* (sizeof(struct usb_cdc_ncm_dpe16
))) >
1027 pr_debug("Invalid nframes = %d\n", nframes
);
1031 dpe16
= (struct usb_cdc_ncm_dpe16
*)(((u8
*)skb_in
->data
) + len
);
1033 for (x
= 0; x
< nframes
; x
++, dpe16
++) {
1034 offset
= le16_to_cpu(dpe16
->wDatagramIndex
);
1035 len
= le16_to_cpu(dpe16
->wDatagramLength
);
1039 * All entries after first NULL entry are to be ignored
1041 if ((offset
== 0) || (len
== 0)) {
1043 goto error
; /* empty NTB */
1047 /* sanity checking */
1048 if (((offset
+ len
) > skb_in
->len
) ||
1049 (len
> ctx
->rx_max
) || (len
< ETH_HLEN
)) {
1050 pr_debug("invalid frame detected (ignored)"
1051 "offset[%u]=%u, length=%u, skb=%p\n",
1052 x
, offset
, len
, skb_in
);
1058 skb
= skb_clone(skb_in
, GFP_ATOMIC
);
1062 skb
->data
= ((u8
*)skb_in
->data
) + offset
;
1063 skb_set_tail_pointer(skb
, len
);
1064 usbnet_skb_return(dev
, skb
);
1073 cdc_ncm_speed_change(struct cdc_ncm_ctx
*ctx
,
1074 struct usb_cdc_speed_change
*data
)
1076 uint32_t rx_speed
= le32_to_cpu(data
->DLBitRRate
);
1077 uint32_t tx_speed
= le32_to_cpu(data
->ULBitRate
);
1080 * Currently the USB-NET API does not support reporting the actual
1081 * device speed. Do print it instead.
1083 if ((tx_speed
!= ctx
->tx_speed
) || (rx_speed
!= ctx
->rx_speed
)) {
1084 ctx
->tx_speed
= tx_speed
;
1085 ctx
->rx_speed
= rx_speed
;
1087 if ((tx_speed
> 1000000) && (rx_speed
> 1000000)) {
1088 printk(KERN_INFO KBUILD_MODNAME
1089 ": %s: %u mbit/s downlink "
1090 "%u mbit/s uplink\n",
1092 (unsigned int)(rx_speed
/ 1000000U),
1093 (unsigned int)(tx_speed
/ 1000000U));
1095 printk(KERN_INFO KBUILD_MODNAME
1096 ": %s: %u kbit/s downlink "
1097 "%u kbit/s uplink\n",
1099 (unsigned int)(rx_speed
/ 1000U),
1100 (unsigned int)(tx_speed
/ 1000U));
1105 static void cdc_ncm_status(struct usbnet
*dev
, struct urb
*urb
)
1107 struct cdc_ncm_ctx
*ctx
;
1108 struct usb_cdc_notification
*event
;
1110 ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
1112 if (urb
->actual_length
< sizeof(*event
))
1115 /* test for split data in 8-byte chunks */
1116 if (test_and_clear_bit(EVENT_STS_SPLIT
, &dev
->flags
)) {
1117 cdc_ncm_speed_change(ctx
,
1118 (struct usb_cdc_speed_change
*)urb
->transfer_buffer
);
1122 event
= urb
->transfer_buffer
;
1124 switch (event
->bNotificationType
) {
1125 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
1127 * According to the CDC NCM specification ch.7.1
1128 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1129 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1131 ctx
->connected
= event
->wValue
;
1133 printk(KERN_INFO KBUILD_MODNAME
": %s: network connection:"
1135 ctx
->netdev
->name
, ctx
->connected
? "" : "dis");
1138 netif_carrier_on(dev
->net
);
1140 netif_carrier_off(dev
->net
);
1141 ctx
->tx_speed
= ctx
->rx_speed
= 0;
1145 case USB_CDC_NOTIFY_SPEED_CHANGE
:
1146 if (urb
->actual_length
< (sizeof(*event
) +
1147 sizeof(struct usb_cdc_speed_change
)))
1148 set_bit(EVENT_STS_SPLIT
, &dev
->flags
);
1150 cdc_ncm_speed_change(ctx
,
1151 (struct usb_cdc_speed_change
*) &event
[1]);
1155 dev_err(&dev
->udev
->dev
, "NCM: unexpected "
1156 "notification 0x%02x!\n", event
->bNotificationType
);
1161 static int cdc_ncm_check_connect(struct usbnet
*dev
)
1163 struct cdc_ncm_ctx
*ctx
;
1165 ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
1167 return 1; /* disconnected */
1169 return !ctx
->connected
;
1173 cdc_ncm_probe(struct usb_interface
*udev
, const struct usb_device_id
*prod
)
1175 return usbnet_probe(udev
, prod
);
1178 static void cdc_ncm_disconnect(struct usb_interface
*intf
)
1180 struct usbnet
*dev
= usb_get_intfdata(intf
);
1183 return; /* already disconnected */
1185 usbnet_disconnect(intf
);
1188 static int cdc_ncm_manage_power(struct usbnet
*dev
, int status
)
1190 dev
->intf
->needs_remote_wakeup
= status
;
1194 static const struct driver_info cdc_ncm_info
= {
1195 .description
= "CDC NCM",
1196 .flags
= FLAG_POINTTOPOINT
| FLAG_NO_SETINT
| FLAG_MULTI_PACKET
,
1197 .bind
= cdc_ncm_bind
,
1198 .unbind
= cdc_ncm_unbind
,
1199 .check_connect
= cdc_ncm_check_connect
,
1200 .manage_power
= cdc_ncm_manage_power
,
1201 .status
= cdc_ncm_status
,
1202 .rx_fixup
= cdc_ncm_rx_fixup
,
1203 .tx_fixup
= cdc_ncm_tx_fixup
,
1206 static struct usb_driver cdc_ncm_driver
= {
1208 .id_table
= cdc_devs
,
1209 .probe
= cdc_ncm_probe
,
1210 .disconnect
= cdc_ncm_disconnect
,
1211 .suspend
= usbnet_suspend
,
1212 .resume
= usbnet_resume
,
1213 .reset_resume
= usbnet_resume
,
1214 .supports_autosuspend
= 1,
1217 static const struct ethtool_ops cdc_ncm_ethtool_ops
= {
1218 .get_drvinfo
= cdc_ncm_get_drvinfo
,
1219 .get_link
= usbnet_get_link
,
1220 .get_msglevel
= usbnet_get_msglevel
,
1221 .set_msglevel
= usbnet_set_msglevel
,
1222 .get_settings
= usbnet_get_settings
,
1223 .set_settings
= usbnet_set_settings
,
1224 .nway_reset
= usbnet_nway_reset
,
1227 module_usb_driver(cdc_ncm_driver
);
1229 MODULE_AUTHOR("Hans Petter Selasky");
1230 MODULE_DESCRIPTION("USB CDC NCM host driver");
1231 MODULE_LICENSE("Dual BSD/GPL");