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>
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/timer.h>
51 #include <linux/spinlock.h>
52 #include <linux/atomic.h>
53 #include <linux/usb/usbnet.h>
54 #include <linux/usb/cdc.h>
56 #define DRIVER_VERSION "04-Aug-2011"
58 /* CDC NCM subclass 3.2.1 */
59 #define USB_CDC_NCM_NDP16_LENGTH_MIN 0x10
61 /* Maximum NTB length */
62 #define CDC_NCM_NTB_MAX_SIZE_TX 16384 /* bytes */
63 #define CDC_NCM_NTB_MAX_SIZE_RX 16384 /* bytes */
65 /* Minimum value for MaxDatagramSize, ch. 6.2.9 */
66 #define CDC_NCM_MIN_DATAGRAM_SIZE 1514 /* bytes */
68 #define CDC_NCM_MIN_TX_PKT 512 /* bytes */
70 /* Default value for MaxDatagramSize */
71 #define CDC_NCM_MAX_DATAGRAM_SIZE 2048 /* bytes */
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.
77 #define CDC_NCM_DPT_DATAGRAMS_MAX 32
79 /* Maximum amount of IN datagrams in NTB */
80 #define CDC_NCM_DPT_DATAGRAMS_IN_MAX 0 /* unlimited */
82 /* Restart the timer, if amount of datagrams is less than given value */
83 #define CDC_NCM_RESTART_TIMER_DATAGRAM_CNT 3
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))
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];
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
;
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
;
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
;
116 struct sk_buff
*tx_curr_skb
;
117 struct sk_buff
*tx_rem_skb
;
121 u32 tx_timer_pending
;
123 u32 tx_curr_last_offset
;
124 u32 tx_curr_frame_num
;
129 u32 max_datagram_size
;
130 u16 tx_max_datagrams
;
138 static void cdc_ncm_tx_timeout(unsigned long arg
);
139 static const struct driver_info cdc_ncm_info
;
140 static struct usb_driver cdc_ncm_driver
;
141 static const struct ethtool_ops cdc_ncm_ethtool_ops
;
143 static 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
,
152 MODULE_DEVICE_TABLE(usb
, cdc_devs
);
155 cdc_ncm_get_drvinfo(struct net_device
*net
, struct ethtool_drvinfo
*info
)
157 struct usbnet
*dev
= netdev_priv(net
);
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
));
166 static u8
cdc_ncm_setup(struct cdc_ncm_ctx
*ctx
)
172 u16 ntb_fmt_supported
;
174 iface_no
= ctx
->control
->cur_altsetting
->desc
.bInterfaceNumber
;
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);
184 pr_debug("failed GET_NTB_PARAMETERS\n");
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
);
198 if (ctx
->func_desc
!= NULL
)
199 flags
= ctx
->func_desc
->bmNetworkCapabilities
;
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
);
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
;
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
;
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
;
227 /* inform device about NTB input size changes */
228 if (ctx
->rx_max
!= le32_to_cpu(ctx
->ncm_parm
.dwNtbInMaxSize
)) {
230 if (flags
& USB_CDC_NCM_NCAP_NTB_INPUT_SIZE
) {
231 struct usb_cdc_ncm_ndp_input_size
*ndp_in_sz
;
233 ndp_in_sz
= kzalloc(sizeof(*ndp_in_sz
), GFP_KERNEL
);
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);
247 __le32
*dwNtbInMaxSize
;
248 dwNtbInMaxSize
= kzalloc(sizeof(*dwNtbInMaxSize
),
250 if (!dwNtbInMaxSize
) {
254 *dwNtbInMaxSize
= cpu_to_le32(ctx
->rx_max
);
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
);
266 pr_debug("Setting NTB Input Size failed\n");
269 /* verify maximum size of transmitted NTB in bytes */
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
;
279 * verify that the structure alignment is:
281 * - not greater than the maximum transmit length
282 * - not less than four bytes
284 val
= ctx
->tx_ndp_modulus
;
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
;
293 * verify that the payload alignment is:
295 * - not greater than the maximum transmit length
296 * - not less than four bytes
298 val
= ctx
->tx_modulus
;
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
;
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;
312 /* adjust TX-remainder according to NCM specification. */
313 ctx
->tx_remainder
= ((ctx
->tx_remainder
- ETH_HLEN
) &
314 (ctx
->tx_modulus
- 1));
316 /* additional configuration */
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);
327 pr_debug("Setting CRC mode off failed\n");
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);
338 pr_debug("Setting NTB format to 16-bit failed\n");
341 ctx
->max_datagram_size
= CDC_NCM_MIN_DATAGRAM_SIZE
;
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
);
348 max_datagram_size
= kzalloc(sizeof(*max_datagram_size
),
350 if (!max_datagram_size
) {
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
,
362 pr_debug("GET_MAX_DATAGRAM_SIZE failed, use size=%u\n",
363 CDC_NCM_MIN_DATAGRAM_SIZE
);
364 kfree(max_datagram_size
);
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
;
373 if (ctx
->max_datagram_size
>
374 CDC_NCM_MAX_DATAGRAM_SIZE
)
375 ctx
->max_datagram_size
=
376 CDC_NCM_MAX_DATAGRAM_SIZE
;
379 if (ctx
->max_datagram_size
< CDC_NCM_MIN_DATAGRAM_SIZE
)
380 ctx
->max_datagram_size
=
381 CDC_NCM_MIN_DATAGRAM_SIZE
;
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
,
390 iface_no
, max_datagram_size
,
392 kfree(max_datagram_size
);
395 pr_debug("SET_MAX_DATAGRAM_SIZE failed\n");
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 del_timer_sync(&ctx
->tx_timer
);
446 if (ctx
->tx_rem_skb
!= NULL
) {
447 dev_kfree_skb_any(ctx
->tx_rem_skb
);
448 ctx
->tx_rem_skb
= NULL
;
451 if (ctx
->tx_curr_skb
!= NULL
) {
452 dev_kfree_skb_any(ctx
->tx_curr_skb
);
453 ctx
->tx_curr_skb
= NULL
;
459 static int cdc_ncm_bind(struct usbnet
*dev
, struct usb_interface
*intf
)
461 struct cdc_ncm_ctx
*ctx
;
462 struct usb_driver
*driver
;
468 ctx
= kzalloc(sizeof(*ctx
), GFP_KERNEL
);
472 init_timer(&ctx
->tx_timer
);
473 spin_lock_init(&ctx
->mtx
);
474 ctx
->netdev
= dev
->net
;
476 /* store ctx pointer in device data field */
477 dev
->data
[0] = (unsigned long)ctx
;
479 /* get some pointers */
480 driver
= driver_of(intf
);
481 buf
= intf
->cur_altsetting
->extra
;
482 len
= intf
->cur_altsetting
->extralen
;
484 ctx
->udev
= dev
->udev
;
487 /* parse through descriptors associated with control interface */
488 while ((len
> 0) && (buf
[0] > 2) && (buf
[0] <= len
)) {
490 if (buf
[1] != USB_DT_CS_INTERFACE
)
494 case USB_CDC_UNION_TYPE
:
495 if (buf
[0] < sizeof(*(ctx
->union_desc
)))
499 (const struct usb_cdc_union_desc
*)buf
;
501 ctx
->control
= usb_ifnum_to_if(dev
->udev
,
502 ctx
->union_desc
->bMasterInterface0
);
503 ctx
->data
= usb_ifnum_to_if(dev
->udev
,
504 ctx
->union_desc
->bSlaveInterface0
);
507 case USB_CDC_ETHERNET_TYPE
:
508 if (buf
[0] < sizeof(*(ctx
->ether_desc
)))
512 (const struct usb_cdc_ether_desc
*)buf
;
514 le16_to_cpu(ctx
->ether_desc
->wMaxSegmentSize
);
516 if (dev
->hard_mtu
< CDC_NCM_MIN_DATAGRAM_SIZE
)
517 dev
->hard_mtu
= CDC_NCM_MIN_DATAGRAM_SIZE
;
518 else if (dev
->hard_mtu
> CDC_NCM_MAX_DATAGRAM_SIZE
)
519 dev
->hard_mtu
= CDC_NCM_MAX_DATAGRAM_SIZE
;
522 case USB_CDC_NCM_TYPE
:
523 if (buf
[0] < sizeof(*(ctx
->func_desc
)))
526 ctx
->func_desc
= (const struct usb_cdc_ncm_desc
*)buf
;
533 /* advance to next descriptor */
539 /* check if we got everything */
540 if ((ctx
->control
== NULL
) || (ctx
->data
== NULL
) ||
541 (ctx
->ether_desc
== NULL
) || (ctx
->control
!= intf
))
544 /* claim interfaces, if any */
545 temp
= usb_driver_claim_interface(driver
, ctx
->data
, dev
);
549 iface_no
= ctx
->data
->cur_altsetting
->desc
.bInterfaceNumber
;
551 /* reset data interface */
552 temp
= usb_set_interface(dev
->udev
, iface_no
, 0);
556 /* initialize data interface */
557 if (cdc_ncm_setup(ctx
))
560 /* configure data interface */
561 temp
= usb_set_interface(dev
->udev
, iface_no
, 1);
565 cdc_ncm_find_endpoints(ctx
, ctx
->data
);
566 cdc_ncm_find_endpoints(ctx
, ctx
->control
);
568 if ((ctx
->in_ep
== NULL
) || (ctx
->out_ep
== NULL
) ||
569 (ctx
->status_ep
== NULL
))
572 dev
->net
->ethtool_ops
= &cdc_ncm_ethtool_ops
;
574 usb_set_intfdata(ctx
->data
, dev
);
575 usb_set_intfdata(ctx
->control
, dev
);
576 usb_set_intfdata(ctx
->intf
, dev
);
578 temp
= usbnet_get_ethernet_addr(dev
, ctx
->ether_desc
->iMACAddress
);
582 dev_info(&dev
->udev
->dev
, "MAC-Address: "
583 "0x%02x:0x%02x:0x%02x:0x%02x:0x%02x:0x%02x\n",
584 dev
->net
->dev_addr
[0], dev
->net
->dev_addr
[1],
585 dev
->net
->dev_addr
[2], dev
->net
->dev_addr
[3],
586 dev
->net
->dev_addr
[4], dev
->net
->dev_addr
[5]);
588 dev
->in
= usb_rcvbulkpipe(dev
->udev
,
589 ctx
->in_ep
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
590 dev
->out
= usb_sndbulkpipe(dev
->udev
,
591 ctx
->out_ep
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
592 dev
->status
= ctx
->status_ep
;
593 dev
->rx_urb_size
= ctx
->rx_max
;
596 * We should get an event when network connection is "connected" or
597 * "disconnected". Set network connection in "disconnected" state
598 * (carrier is OFF) during attach, so the IP network stack does not
599 * start IPv6 negotiation and more.
601 netif_carrier_off(dev
->net
);
602 ctx
->tx_speed
= ctx
->rx_speed
= 0;
606 usb_set_intfdata(ctx
->control
, NULL
);
607 usb_set_intfdata(ctx
->data
, NULL
);
608 usb_driver_release_interface(driver
, ctx
->data
);
610 cdc_ncm_free((struct cdc_ncm_ctx
*)dev
->data
[0]);
612 dev_info(&dev
->udev
->dev
, "bind() failure\n");
616 static void cdc_ncm_unbind(struct usbnet
*dev
, struct usb_interface
*intf
)
618 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
619 struct usb_driver
*driver
= driver_of(intf
);
622 return; /* no setup */
624 /* disconnect master --> disconnect slave */
625 if (intf
== ctx
->control
&& ctx
->data
) {
626 usb_set_intfdata(ctx
->data
, NULL
);
627 usb_driver_release_interface(driver
, ctx
->data
);
630 } else if (intf
== ctx
->data
&& ctx
->control
) {
631 usb_set_intfdata(ctx
->control
, NULL
);
632 usb_driver_release_interface(driver
, ctx
->control
);
636 usb_set_intfdata(ctx
->intf
, NULL
);
640 static void cdc_ncm_zero_fill(u8
*ptr
, u32 first
, u32 end
, u32 max
)
648 memset(ptr
+ first
, 0, end
- first
);
651 static struct sk_buff
*
652 cdc_ncm_fill_tx_frame(struct cdc_ncm_ctx
*ctx
, struct sk_buff
*skb
)
654 struct sk_buff
*skb_out
;
661 /* if there is a remaining skb, it gets priority */
663 swap(skb
, ctx
->tx_rem_skb
);
675 /* check if we are resuming an OUT skb */
676 if (ctx
->tx_curr_skb
!= NULL
) {
678 skb_out
= ctx
->tx_curr_skb
;
679 offset
= ctx
->tx_curr_offset
;
680 last_offset
= ctx
->tx_curr_last_offset
;
681 n
= ctx
->tx_curr_frame_num
;
684 /* reset variables */
685 skb_out
= alloc_skb((ctx
->tx_max
+ 1), GFP_ATOMIC
);
686 if (skb_out
== NULL
) {
688 dev_kfree_skb_any(skb
);
689 ctx
->netdev
->stats
.tx_dropped
++;
694 /* make room for NTH and NDP */
695 offset
= ALIGN(sizeof(struct usb_cdc_ncm_nth16
),
696 ctx
->tx_ndp_modulus
) +
697 sizeof(struct usb_cdc_ncm_ndp16
) +
698 (ctx
->tx_max_datagrams
+ 1) *
699 sizeof(struct usb_cdc_ncm_dpe16
);
701 /* store last valid offset before alignment */
702 last_offset
= offset
;
703 /* align first Datagram offset correctly */
704 offset
= ALIGN(offset
, ctx
->tx_modulus
) + ctx
->tx_remainder
;
705 /* zero buffer till the first IP datagram */
706 cdc_ncm_zero_fill(skb_out
->data
, 0, offset
, offset
);
708 ctx
->tx_curr_frame_num
= 0;
711 for (; n
< ctx
->tx_max_datagrams
; n
++) {
712 /* check if end of transmit buffer is reached */
713 if (offset
>= ctx
->tx_max
) {
717 /* compute maximum buffer size */
718 rem
= ctx
->tx_max
- offset
;
721 skb
= ctx
->tx_rem_skb
;
722 ctx
->tx_rem_skb
= NULL
;
724 /* check for end of skb */
729 if (skb
->len
> rem
) {
731 /* won't fit, MTU problem? */
732 dev_kfree_skb_any(skb
);
734 ctx
->netdev
->stats
.tx_dropped
++;
736 /* no room for skb - store for later */
737 if (ctx
->tx_rem_skb
!= NULL
) {
738 dev_kfree_skb_any(ctx
->tx_rem_skb
);
739 ctx
->netdev
->stats
.tx_dropped
++;
741 ctx
->tx_rem_skb
= skb
;
748 memcpy(((u8
*)skb_out
->data
) + offset
, skb
->data
, skb
->len
);
750 ctx
->tx_ncm
.dpe16
[n
].wDatagramLength
= cpu_to_le16(skb
->len
);
751 ctx
->tx_ncm
.dpe16
[n
].wDatagramIndex
= cpu_to_le16(offset
);
756 /* store last valid offset before alignment */
757 last_offset
= offset
;
759 /* align offset correctly */
760 offset
= ALIGN(offset
, ctx
->tx_modulus
) + ctx
->tx_remainder
;
763 cdc_ncm_zero_fill(skb_out
->data
, last_offset
, offset
,
765 dev_kfree_skb_any(skb
);
769 /* free up any dangling skb */
771 dev_kfree_skb_any(skb
);
773 ctx
->netdev
->stats
.tx_dropped
++;
776 ctx
->tx_curr_frame_num
= n
;
779 /* wait for more frames */
781 ctx
->tx_curr_skb
= skb_out
;
782 ctx
->tx_curr_offset
= offset
;
783 ctx
->tx_curr_last_offset
= last_offset
;
786 } else if ((n
< ctx
->tx_max_datagrams
) && (ready2send
== 0)) {
787 /* wait for more frames */
789 ctx
->tx_curr_skb
= skb_out
;
790 ctx
->tx_curr_offset
= offset
;
791 ctx
->tx_curr_last_offset
= last_offset
;
792 /* set the pending count */
793 if (n
< CDC_NCM_RESTART_TIMER_DATAGRAM_CNT
)
794 ctx
->tx_timer_pending
= 2;
799 /* variables will be reset at next call */
802 /* check for overflow */
803 if (last_offset
> ctx
->tx_max
)
804 last_offset
= ctx
->tx_max
;
807 offset
= last_offset
;
810 * If collected data size is less or equal CDC_NCM_MIN_TX_PKT bytes,
811 * we send buffers as it is. If we get more data, it would be more
812 * efficient for USB HS mobile device with DMA engine to receive a full
813 * size NTB, than canceling DMA transfer and receiving a short packet.
815 if (offset
> CDC_NCM_MIN_TX_PKT
)
816 offset
= ctx
->tx_max
;
818 /* final zero padding */
819 cdc_ncm_zero_fill(skb_out
->data
, last_offset
, offset
, ctx
->tx_max
);
821 /* store last offset */
822 last_offset
= offset
;
824 if (((last_offset
< ctx
->tx_max
) && ((last_offset
%
825 le16_to_cpu(ctx
->out_ep
->desc
.wMaxPacketSize
)) == 0)) ||
826 (((last_offset
== ctx
->tx_max
) && ((ctx
->tx_max
%
827 le16_to_cpu(ctx
->out_ep
->desc
.wMaxPacketSize
)) == 0)) &&
828 (ctx
->tx_max
< le32_to_cpu(ctx
->ncm_parm
.dwNtbOutMaxSize
)))) {
829 /* force short packet */
830 *(((u8
*)skb_out
->data
) + last_offset
) = 0;
834 /* zero the rest of the DPEs plus the last NULL entry */
835 for (; n
<= CDC_NCM_DPT_DATAGRAMS_MAX
; n
++) {
836 ctx
->tx_ncm
.dpe16
[n
].wDatagramLength
= 0;
837 ctx
->tx_ncm
.dpe16
[n
].wDatagramIndex
= 0;
840 /* fill out 16-bit NTB header */
841 ctx
->tx_ncm
.nth16
.dwSignature
= cpu_to_le32(USB_CDC_NCM_NTH16_SIGN
);
842 ctx
->tx_ncm
.nth16
.wHeaderLength
=
843 cpu_to_le16(sizeof(ctx
->tx_ncm
.nth16
));
844 ctx
->tx_ncm
.nth16
.wSequence
= cpu_to_le16(ctx
->tx_seq
);
845 ctx
->tx_ncm
.nth16
.wBlockLength
= cpu_to_le16(last_offset
);
846 index
= ALIGN(sizeof(struct usb_cdc_ncm_nth16
), ctx
->tx_ndp_modulus
);
847 ctx
->tx_ncm
.nth16
.wNdpIndex
= cpu_to_le16(index
);
849 memcpy(skb_out
->data
, &(ctx
->tx_ncm
.nth16
), sizeof(ctx
->tx_ncm
.nth16
));
852 /* fill out 16-bit NDP table */
853 ctx
->tx_ncm
.ndp16
.dwSignature
=
854 cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN
);
855 rem
= sizeof(ctx
->tx_ncm
.ndp16
) + ((ctx
->tx_curr_frame_num
+ 1) *
856 sizeof(struct usb_cdc_ncm_dpe16
));
857 ctx
->tx_ncm
.ndp16
.wLength
= cpu_to_le16(rem
);
858 ctx
->tx_ncm
.ndp16
.wNextNdpIndex
= 0; /* reserved */
860 memcpy(((u8
*)skb_out
->data
) + index
,
861 &(ctx
->tx_ncm
.ndp16
),
862 sizeof(ctx
->tx_ncm
.ndp16
));
864 memcpy(((u8
*)skb_out
->data
) + index
+ sizeof(ctx
->tx_ncm
.ndp16
),
865 &(ctx
->tx_ncm
.dpe16
),
866 (ctx
->tx_curr_frame_num
+ 1) *
867 sizeof(struct usb_cdc_ncm_dpe16
));
869 /* set frame length */
870 skb_put(skb_out
, last_offset
);
873 ctx
->tx_curr_skb
= NULL
;
880 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx
*ctx
)
882 /* start timer, if not already started */
883 if (timer_pending(&ctx
->tx_timer
) == 0) {
884 ctx
->tx_timer
.function
= &cdc_ncm_tx_timeout
;
885 ctx
->tx_timer
.data
= (unsigned long)ctx
;
886 ctx
->tx_timer
.expires
= jiffies
+ ((HZ
+ 999) / 1000);
887 add_timer(&ctx
->tx_timer
);
891 static void cdc_ncm_tx_timeout(unsigned long arg
)
893 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)arg
;
896 spin_lock(&ctx
->mtx
);
897 if (ctx
->tx_timer_pending
!= 0) {
898 ctx
->tx_timer_pending
--;
904 spin_unlock(&ctx
->mtx
);
907 spin_lock(&ctx
->mtx
);
908 cdc_ncm_tx_timeout_start(ctx
);
909 spin_unlock(&ctx
->mtx
);
910 } else if (ctx
->netdev
!= NULL
) {
911 usbnet_start_xmit(NULL
, ctx
->netdev
);
915 static struct sk_buff
*
916 cdc_ncm_tx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
, gfp_t flags
)
918 struct sk_buff
*skb_out
;
919 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
923 * The Ethernet API we are using does not support transmitting
924 * multiple Ethernet frames in a single call. This driver will
925 * accumulate multiple Ethernet frames and send out a larger
926 * USB frame when the USB buffer is full or when a single jiffies
932 spin_lock(&ctx
->mtx
);
933 skb_out
= cdc_ncm_fill_tx_frame(ctx
, skb
);
934 if (ctx
->tx_curr_skb
!= NULL
)
937 /* Start timer, if there is a remaining skb */
939 cdc_ncm_tx_timeout_start(ctx
);
942 dev
->net
->stats
.tx_packets
+= ctx
->tx_curr_frame_num
;
944 spin_unlock(&ctx
->mtx
);
949 dev_kfree_skb_any(skb
);
954 static int cdc_ncm_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb_in
)
957 struct cdc_ncm_ctx
*ctx
;
965 ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
969 actlen
= skb_in
->len
;
970 sumlen
= CDC_NCM_NTB_MAX_SIZE_RX
;
972 if (actlen
< (sizeof(ctx
->rx_ncm
.nth16
) + sizeof(ctx
->rx_ncm
.ndp16
))) {
973 pr_debug("frame too short\n");
977 memcpy(&(ctx
->rx_ncm
.nth16
), ((u8
*)skb_in
->data
),
978 sizeof(ctx
->rx_ncm
.nth16
));
980 if (le32_to_cpu(ctx
->rx_ncm
.nth16
.dwSignature
) !=
981 USB_CDC_NCM_NTH16_SIGN
) {
982 pr_debug("invalid NTH16 signature <%u>\n",
983 le32_to_cpu(ctx
->rx_ncm
.nth16
.dwSignature
));
987 temp
= le16_to_cpu(ctx
->rx_ncm
.nth16
.wBlockLength
);
989 pr_debug("unsupported NTB block length %u/%u\n", temp
, sumlen
);
993 temp
= le16_to_cpu(ctx
->rx_ncm
.nth16
.wNdpIndex
);
994 if ((temp
+ sizeof(ctx
->rx_ncm
.ndp16
)) > actlen
) {
995 pr_debug("invalid DPT16 index\n");
999 memcpy(&(ctx
->rx_ncm
.ndp16
), ((u8
*)skb_in
->data
) + temp
,
1000 sizeof(ctx
->rx_ncm
.ndp16
));
1002 if (le32_to_cpu(ctx
->rx_ncm
.ndp16
.dwSignature
) !=
1003 USB_CDC_NCM_NDP16_NOCRC_SIGN
) {
1004 pr_debug("invalid DPT16 signature <%u>\n",
1005 le32_to_cpu(ctx
->rx_ncm
.ndp16
.dwSignature
));
1009 if (le16_to_cpu(ctx
->rx_ncm
.ndp16
.wLength
) <
1010 USB_CDC_NCM_NDP16_LENGTH_MIN
) {
1011 pr_debug("invalid DPT16 length <%u>\n",
1012 le32_to_cpu(ctx
->rx_ncm
.ndp16
.dwSignature
));
1016 nframes
= ((le16_to_cpu(ctx
->rx_ncm
.ndp16
.wLength
) -
1017 sizeof(struct usb_cdc_ncm_ndp16
)) /
1018 sizeof(struct usb_cdc_ncm_dpe16
));
1019 nframes
--; /* we process NDP entries except for the last one */
1021 pr_debug("nframes = %u\n", nframes
);
1023 temp
+= sizeof(ctx
->rx_ncm
.ndp16
);
1025 if ((temp
+ nframes
* (sizeof(struct usb_cdc_ncm_dpe16
))) > actlen
) {
1026 pr_debug("Invalid nframes = %d\n", nframes
);
1030 if (nframes
> CDC_NCM_DPT_DATAGRAMS_MAX
) {
1031 pr_debug("Truncating number of frames from %u to %u\n",
1032 nframes
, CDC_NCM_DPT_DATAGRAMS_MAX
);
1033 nframes
= CDC_NCM_DPT_DATAGRAMS_MAX
;
1036 memcpy(&(ctx
->rx_ncm
.dpe16
), ((u8
*)skb_in
->data
) + temp
,
1037 nframes
* (sizeof(struct usb_cdc_ncm_dpe16
)));
1039 for (x
= 0; x
< nframes
; x
++) {
1040 offset
= le16_to_cpu(ctx
->rx_ncm
.dpe16
[x
].wDatagramIndex
);
1041 temp
= le16_to_cpu(ctx
->rx_ncm
.dpe16
[x
].wDatagramLength
);
1045 * All entries after first NULL entry are to be ignored
1047 if ((offset
== 0) || (temp
== 0)) {
1049 goto error
; /* empty NTB */
1053 /* sanity checking */
1054 if (((offset
+ temp
) > actlen
) ||
1055 (temp
> CDC_NCM_MAX_DATAGRAM_SIZE
) || (temp
< ETH_HLEN
)) {
1056 pr_debug("invalid frame detected (ignored)"
1057 "offset[%u]=%u, length=%u, skb=%p\n",
1058 x
, offset
, temp
, skb_in
);
1064 skb
= skb_clone(skb_in
, GFP_ATOMIC
);
1068 skb
->data
= ((u8
*)skb_in
->data
) + offset
;
1069 skb_set_tail_pointer(skb
, temp
);
1070 usbnet_skb_return(dev
, skb
);
1079 cdc_ncm_speed_change(struct cdc_ncm_ctx
*ctx
,
1080 struct usb_cdc_speed_change
*data
)
1082 uint32_t rx_speed
= le32_to_cpu(data
->DLBitRRate
);
1083 uint32_t tx_speed
= le32_to_cpu(data
->ULBitRate
);
1086 * Currently the USB-NET API does not support reporting the actual
1087 * device speed. Do print it instead.
1089 if ((tx_speed
!= ctx
->tx_speed
) || (rx_speed
!= ctx
->rx_speed
)) {
1090 ctx
->tx_speed
= tx_speed
;
1091 ctx
->rx_speed
= rx_speed
;
1093 if ((tx_speed
> 1000000) && (rx_speed
> 1000000)) {
1094 printk(KERN_INFO KBUILD_MODNAME
1095 ": %s: %u mbit/s downlink "
1096 "%u mbit/s uplink\n",
1098 (unsigned int)(rx_speed
/ 1000000U),
1099 (unsigned int)(tx_speed
/ 1000000U));
1101 printk(KERN_INFO KBUILD_MODNAME
1102 ": %s: %u kbit/s downlink "
1103 "%u kbit/s uplink\n",
1105 (unsigned int)(rx_speed
/ 1000U),
1106 (unsigned int)(tx_speed
/ 1000U));
1111 static void cdc_ncm_status(struct usbnet
*dev
, struct urb
*urb
)
1113 struct cdc_ncm_ctx
*ctx
;
1114 struct usb_cdc_notification
*event
;
1116 ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
1118 if (urb
->actual_length
< sizeof(*event
))
1121 /* test for split data in 8-byte chunks */
1122 if (test_and_clear_bit(EVENT_STS_SPLIT
, &dev
->flags
)) {
1123 cdc_ncm_speed_change(ctx
,
1124 (struct usb_cdc_speed_change
*)urb
->transfer_buffer
);
1128 event
= urb
->transfer_buffer
;
1130 switch (event
->bNotificationType
) {
1131 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
1133 * According to the CDC NCM specification ch.7.1
1134 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1135 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1137 ctx
->connected
= event
->wValue
;
1139 printk(KERN_INFO KBUILD_MODNAME
": %s: network connection:"
1141 ctx
->netdev
->name
, ctx
->connected
? "" : "dis");
1144 netif_carrier_on(dev
->net
);
1146 netif_carrier_off(dev
->net
);
1147 ctx
->tx_speed
= ctx
->rx_speed
= 0;
1151 case USB_CDC_NOTIFY_SPEED_CHANGE
:
1152 if (urb
->actual_length
< (sizeof(*event
) +
1153 sizeof(struct usb_cdc_speed_change
)))
1154 set_bit(EVENT_STS_SPLIT
, &dev
->flags
);
1156 cdc_ncm_speed_change(ctx
,
1157 (struct usb_cdc_speed_change
*) &event
[1]);
1161 dev_err(&dev
->udev
->dev
, "NCM: unexpected "
1162 "notification 0x%02x!\n", event
->bNotificationType
);
1167 static int cdc_ncm_check_connect(struct usbnet
*dev
)
1169 struct cdc_ncm_ctx
*ctx
;
1171 ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
1173 return 1; /* disconnected */
1175 return !ctx
->connected
;
1179 cdc_ncm_probe(struct usb_interface
*udev
, const struct usb_device_id
*prod
)
1181 return usbnet_probe(udev
, prod
);
1184 static void cdc_ncm_disconnect(struct usb_interface
*intf
)
1186 struct usbnet
*dev
= usb_get_intfdata(intf
);
1189 return; /* already disconnected */
1191 usbnet_disconnect(intf
);
1194 static int cdc_ncm_manage_power(struct usbnet
*dev
, int status
)
1196 dev
->intf
->needs_remote_wakeup
= status
;
1200 static const struct driver_info cdc_ncm_info
= {
1201 .description
= "CDC NCM",
1202 .flags
= FLAG_POINTTOPOINT
| FLAG_NO_SETINT
| FLAG_MULTI_PACKET
,
1203 .bind
= cdc_ncm_bind
,
1204 .unbind
= cdc_ncm_unbind
,
1205 .check_connect
= cdc_ncm_check_connect
,
1206 .manage_power
= cdc_ncm_manage_power
,
1207 .status
= cdc_ncm_status
,
1208 .rx_fixup
= cdc_ncm_rx_fixup
,
1209 .tx_fixup
= cdc_ncm_tx_fixup
,
1212 static struct usb_driver cdc_ncm_driver
= {
1214 .id_table
= cdc_devs
,
1215 .probe
= cdc_ncm_probe
,
1216 .disconnect
= cdc_ncm_disconnect
,
1217 .suspend
= usbnet_suspend
,
1218 .resume
= usbnet_resume
,
1219 .reset_resume
= usbnet_resume
,
1220 .supports_autosuspend
= 1,
1223 static const struct ethtool_ops cdc_ncm_ethtool_ops
= {
1224 .get_drvinfo
= cdc_ncm_get_drvinfo
,
1225 .get_link
= usbnet_get_link
,
1226 .get_msglevel
= usbnet_get_msglevel
,
1227 .set_msglevel
= usbnet_set_msglevel
,
1228 .get_settings
= usbnet_get_settings
,
1229 .set_settings
= usbnet_set_settings
,
1230 .nway_reset
= usbnet_nway_reset
,
1233 module_usb_driver(cdc_ncm_driver
);
1235 MODULE_AUTHOR("Hans Petter Selasky");
1236 MODULE_DESCRIPTION("USB CDC NCM host driver");
1237 MODULE_LICENSE("Dual BSD/GPL");