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/netdevice.h>
43 #include <linux/ctype.h>
44 #include <linux/ethtool.h>
45 #include <linux/workqueue.h>
46 #include <linux/mii.h>
47 #include <linux/crc32.h>
48 #include <linux/usb.h>
49 #include <linux/hrtimer.h>
50 #include <linux/atomic.h>
51 #include <linux/usb/usbnet.h>
52 #include <linux/usb/cdc.h>
53 #include <linux/usb/cdc_ncm.h>
55 #if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
56 static bool prefer_mbim
= true;
58 static bool prefer_mbim
;
60 module_param(prefer_mbim
, bool, S_IRUGO
| S_IWUSR
);
61 MODULE_PARM_DESC(prefer_mbim
, "Prefer MBIM setting on dual NCM/MBIM functions");
63 static void cdc_ncm_txpath_bh(unsigned long param
);
64 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx
*ctx
);
65 static enum hrtimer_restart
cdc_ncm_tx_timer_cb(struct hrtimer
*hr_timer
);
66 static struct usb_driver cdc_ncm_driver
;
68 static int cdc_ncm_get_coalesce(struct net_device
*netdev
,
69 struct ethtool_coalesce
*ec
)
71 struct usbnet
*dev
= netdev_priv(netdev
);
72 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
74 /* assuming maximum sized dgrams and ignoring NDPs */
75 ec
->rx_max_coalesced_frames
= ctx
->rx_max
/ ctx
->max_datagram_size
;
76 ec
->tx_max_coalesced_frames
= ctx
->tx_max
/ ctx
->max_datagram_size
;
78 /* the timer will fire CDC_NCM_TIMER_PENDING_CNT times in a row */
79 ec
->tx_coalesce_usecs
= (ctx
->timer_interval
* CDC_NCM_TIMER_PENDING_CNT
) / NSEC_PER_USEC
;
83 static void cdc_ncm_update_rxtx_max(struct usbnet
*dev
, u32 new_rx
, u32 new_tx
);
85 static int cdc_ncm_set_coalesce(struct net_device
*netdev
,
86 struct ethtool_coalesce
*ec
)
88 struct usbnet
*dev
= netdev_priv(netdev
);
89 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
90 u32 new_rx_max
= ctx
->rx_max
;
91 u32 new_tx_max
= ctx
->tx_max
;
93 /* assuming maximum sized dgrams and a single NDP */
94 if (ec
->rx_max_coalesced_frames
)
95 new_rx_max
= ec
->rx_max_coalesced_frames
* ctx
->max_datagram_size
;
96 if (ec
->tx_max_coalesced_frames
)
97 new_tx_max
= ec
->tx_max_coalesced_frames
* ctx
->max_datagram_size
;
99 if (ec
->tx_coalesce_usecs
&&
100 (ec
->tx_coalesce_usecs
< CDC_NCM_TIMER_INTERVAL_MIN
* CDC_NCM_TIMER_PENDING_CNT
||
101 ec
->tx_coalesce_usecs
> CDC_NCM_TIMER_INTERVAL_MAX
* CDC_NCM_TIMER_PENDING_CNT
))
104 spin_lock_bh(&ctx
->mtx
);
105 ctx
->timer_interval
= ec
->tx_coalesce_usecs
* NSEC_PER_USEC
/ CDC_NCM_TIMER_PENDING_CNT
;
106 if (!ctx
->timer_interval
)
107 ctx
->tx_timer_pending
= 0;
108 spin_unlock_bh(&ctx
->mtx
);
110 /* inform device of new values */
111 if (new_rx_max
!= ctx
->rx_max
|| new_tx_max
!= ctx
->tx_max
)
112 cdc_ncm_update_rxtx_max(dev
, new_rx_max
, new_tx_max
);
116 static const struct ethtool_ops cdc_ncm_ethtool_ops
= {
117 .get_settings
= usbnet_get_settings
,
118 .set_settings
= usbnet_set_settings
,
119 .get_link
= usbnet_get_link
,
120 .nway_reset
= usbnet_nway_reset
,
121 .get_drvinfo
= usbnet_get_drvinfo
,
122 .get_msglevel
= usbnet_get_msglevel
,
123 .set_msglevel
= usbnet_set_msglevel
,
124 .get_ts_info
= ethtool_op_get_ts_info
,
125 .get_coalesce
= cdc_ncm_get_coalesce
,
126 .set_coalesce
= cdc_ncm_set_coalesce
,
129 /* handle rx_max and tx_max changes */
130 static void cdc_ncm_update_rxtx_max(struct usbnet
*dev
, u32 new_rx
, u32 new_tx
)
132 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
133 u8 iface_no
= ctx
->control
->cur_altsetting
->desc
.bInterfaceNumber
;
136 /* clamp new_rx to sane values */
137 min
= USB_CDC_NCM_NTB_MIN_IN_SIZE
;
138 max
= min_t(u32
, CDC_NCM_NTB_MAX_SIZE_RX
, le32_to_cpu(ctx
->ncm_parm
.dwNtbInMaxSize
));
140 /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
142 dev_warn(&dev
->intf
->dev
, "dwNtbInMaxSize=%u is too small. Using %u\n",
143 le32_to_cpu(ctx
->ncm_parm
.dwNtbInMaxSize
), min
);
147 val
= clamp_t(u32
, new_rx
, min
, max
);
149 dev_dbg(&dev
->intf
->dev
, "rx_max must be in the [%u, %u] range. Using %u\n",
153 /* usbnet use these values for sizing rx queues */
154 dev
->rx_urb_size
= val
;
156 /* inform device about NTB input size changes */
157 if (val
!= ctx
->rx_max
) {
158 __le32 dwNtbInMaxSize
= cpu_to_le32(val
);
160 dev_info(&dev
->intf
->dev
, "setting rx_max = %u\n", val
);
162 /* need to unlink rx urbs before increasing buffer size */
163 if (netif_running(dev
->net
) && dev
->rx_urb_size
> ctx
->rx_max
)
164 usbnet_unlink_rx_urbs(dev
);
166 /* tell device to use new size */
167 if (usbnet_write_cmd(dev
, USB_CDC_SET_NTB_INPUT_SIZE
,
168 USB_TYPE_CLASS
| USB_DIR_OUT
169 | USB_RECIP_INTERFACE
,
170 0, iface_no
, &dwNtbInMaxSize
, 4) < 0)
171 dev_dbg(&dev
->intf
->dev
, "Setting NTB Input Size failed\n");
176 /* clamp new_tx to sane values */
177 min
= CDC_NCM_MIN_HDR_SIZE
+ ctx
->max_datagram_size
;
178 max
= min_t(u32
, CDC_NCM_NTB_MAX_SIZE_TX
, le32_to_cpu(ctx
->ncm_parm
.dwNtbOutMaxSize
));
180 /* some devices set dwNtbOutMaxSize too low for the above default */
183 val
= clamp_t(u32
, new_tx
, min
, max
);
185 dev_dbg(&dev
->intf
->dev
, "tx_max must be in the [%u, %u] range. Using %u\n",
188 if (val
!= ctx
->tx_max
)
189 dev_info(&dev
->intf
->dev
, "setting tx_max = %u\n", val
);
191 /* Adding a pad byte here if necessary simplifies the handling
192 * in cdc_ncm_fill_tx_frame, making tx_max always represent
193 * the real skb max size.
195 * We cannot use dev->maxpacket here because this is called from
196 * .bind which is called before usbnet sets up dev->maxpacket
198 if (val
!= le32_to_cpu(ctx
->ncm_parm
.dwNtbOutMaxSize
) &&
199 val
% usb_maxpacket(dev
->udev
, dev
->out
, 1) == 0)
202 /* we might need to flush any pending tx buffers if running */
203 if (netif_running(dev
->net
) && val
> ctx
->tx_max
) {
204 netif_tx_lock_bh(dev
->net
);
205 usbnet_start_xmit(NULL
, dev
->net
);
207 netif_tx_unlock_bh(dev
->net
);
212 dev
->hard_mtu
= ctx
->tx_max
;
214 /* max qlen depend on hard_mtu and rx_urb_size */
215 usbnet_update_max_qlen(dev
);
218 /* helpers for NCM and MBIM differences */
219 static u8
cdc_ncm_flags(struct usbnet
*dev
)
221 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
223 if (cdc_ncm_comm_intf_is_mbim(dev
->intf
->cur_altsetting
) && ctx
->mbim_desc
)
224 return ctx
->mbim_desc
->bmNetworkCapabilities
;
226 return ctx
->func_desc
->bmNetworkCapabilities
;
230 static int cdc_ncm_eth_hlen(struct usbnet
*dev
)
232 if (cdc_ncm_comm_intf_is_mbim(dev
->intf
->cur_altsetting
))
237 static u32
cdc_ncm_min_dgram_size(struct usbnet
*dev
)
239 if (cdc_ncm_comm_intf_is_mbim(dev
->intf
->cur_altsetting
))
240 return CDC_MBIM_MIN_DATAGRAM_SIZE
;
241 return CDC_NCM_MIN_DATAGRAM_SIZE
;
244 static u32
cdc_ncm_max_dgram_size(struct usbnet
*dev
)
246 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
248 if (cdc_ncm_comm_intf_is_mbim(dev
->intf
->cur_altsetting
) && ctx
->mbim_desc
)
249 return le16_to_cpu(ctx
->mbim_desc
->wMaxSegmentSize
);
251 return le16_to_cpu(ctx
->ether_desc
->wMaxSegmentSize
);
252 return CDC_NCM_MAX_DATAGRAM_SIZE
;
255 /* initial one-time device setup. MUST be called with the data interface
258 static int cdc_ncm_init(struct usbnet
*dev
)
260 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
261 u8 iface_no
= ctx
->control
->cur_altsetting
->desc
.bInterfaceNumber
;
264 err
= usbnet_read_cmd(dev
, USB_CDC_GET_NTB_PARAMETERS
,
265 USB_TYPE_CLASS
| USB_DIR_IN
266 |USB_RECIP_INTERFACE
,
267 0, iface_no
, &ctx
->ncm_parm
,
268 sizeof(ctx
->ncm_parm
));
270 dev_err(&dev
->intf
->dev
, "failed GET_NTB_PARAMETERS\n");
271 return err
; /* GET_NTB_PARAMETERS is required */
275 if (cdc_ncm_flags(dev
) & USB_CDC_NCM_NCAP_CRC_MODE
) {
276 dev_dbg(&dev
->intf
->dev
, "Setting CRC mode off\n");
277 err
= usbnet_write_cmd(dev
, USB_CDC_SET_CRC_MODE
,
278 USB_TYPE_CLASS
| USB_DIR_OUT
279 | USB_RECIP_INTERFACE
,
280 USB_CDC_NCM_CRC_NOT_APPENDED
,
283 dev_err(&dev
->intf
->dev
, "SET_CRC_MODE failed\n");
286 /* set NTB format, if both formats are supported.
288 * "The host shall only send this command while the NCM Data
289 * Interface is in alternate setting 0."
291 if (le16_to_cpu(ctx
->ncm_parm
.bmNtbFormatsSupported
) & USB_CDC_NCM_NTH32_SIGN
) {
292 dev_dbg(&dev
->intf
->dev
, "Setting NTB format to 16-bit\n");
293 err
= usbnet_write_cmd(dev
, USB_CDC_SET_NTB_FORMAT
,
294 USB_TYPE_CLASS
| USB_DIR_OUT
295 | USB_RECIP_INTERFACE
,
296 USB_CDC_NCM_NTB16_FORMAT
,
299 dev_err(&dev
->intf
->dev
, "SET_NTB_FORMAT failed\n");
302 /* set initial device values */
303 ctx
->rx_max
= le32_to_cpu(ctx
->ncm_parm
.dwNtbInMaxSize
);
304 ctx
->tx_max
= le32_to_cpu(ctx
->ncm_parm
.dwNtbOutMaxSize
);
305 ctx
->tx_remainder
= le16_to_cpu(ctx
->ncm_parm
.wNdpOutPayloadRemainder
);
306 ctx
->tx_modulus
= le16_to_cpu(ctx
->ncm_parm
.wNdpOutDivisor
);
307 ctx
->tx_ndp_modulus
= le16_to_cpu(ctx
->ncm_parm
.wNdpOutAlignment
);
308 /* devices prior to NCM Errata shall set this field to zero */
309 ctx
->tx_max_datagrams
= le16_to_cpu(ctx
->ncm_parm
.wNtbOutMaxDatagrams
);
311 dev_dbg(&dev
->intf
->dev
,
312 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
313 ctx
->rx_max
, ctx
->tx_max
, ctx
->tx_remainder
, ctx
->tx_modulus
,
314 ctx
->tx_ndp_modulus
, ctx
->tx_max_datagrams
, cdc_ncm_flags(dev
));
316 /* max count of tx datagrams */
317 if ((ctx
->tx_max_datagrams
== 0) ||
318 (ctx
->tx_max_datagrams
> CDC_NCM_DPT_DATAGRAMS_MAX
))
319 ctx
->tx_max_datagrams
= CDC_NCM_DPT_DATAGRAMS_MAX
;
321 /* initial coalescing timer interval */
322 ctx
->timer_interval
= CDC_NCM_TIMER_INTERVAL_USEC
* NSEC_PER_USEC
;
327 /* set a new max datagram size */
328 static void cdc_ncm_set_dgram_size(struct usbnet
*dev
, int new_size
)
330 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
331 u8 iface_no
= ctx
->control
->cur_altsetting
->desc
.bInterfaceNumber
;
332 __le16 max_datagram_size
;
336 /* set default based on descriptors */
337 ctx
->max_datagram_size
= clamp_t(u32
, new_size
,
338 cdc_ncm_min_dgram_size(dev
),
339 CDC_NCM_MAX_DATAGRAM_SIZE
);
341 /* inform the device about the selected Max Datagram Size? */
342 if (!(cdc_ncm_flags(dev
) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE
))
345 /* read current mtu value from device */
346 err
= usbnet_read_cmd(dev
, USB_CDC_GET_MAX_DATAGRAM_SIZE
,
347 USB_TYPE_CLASS
| USB_DIR_IN
| USB_RECIP_INTERFACE
,
348 0, iface_no
, &max_datagram_size
, 2);
350 dev_dbg(&dev
->intf
->dev
, "GET_MAX_DATAGRAM_SIZE failed\n");
354 if (le16_to_cpu(max_datagram_size
) == ctx
->max_datagram_size
)
357 max_datagram_size
= cpu_to_le16(ctx
->max_datagram_size
);
358 err
= usbnet_write_cmd(dev
, USB_CDC_SET_MAX_DATAGRAM_SIZE
,
359 USB_TYPE_CLASS
| USB_DIR_OUT
| USB_RECIP_INTERFACE
,
360 0, iface_no
, &max_datagram_size
, 2);
362 dev_dbg(&dev
->intf
->dev
, "SET_MAX_DATAGRAM_SIZE failed\n");
365 /* set MTU to max supported by the device if necessary */
366 dev
->net
->mtu
= min_t(int, dev
->net
->mtu
, ctx
->max_datagram_size
- cdc_ncm_eth_hlen(dev
));
368 /* do not exceed operater preferred MTU */
369 if (ctx
->mbim_extended_desc
) {
370 mbim_mtu
= le16_to_cpu(ctx
->mbim_extended_desc
->wMTU
);
371 if (mbim_mtu
!= 0 && mbim_mtu
< dev
->net
->mtu
)
372 dev
->net
->mtu
= mbim_mtu
;
376 static void cdc_ncm_fix_modulus(struct usbnet
*dev
)
378 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
382 * verify that the structure alignment is:
384 * - not greater than the maximum transmit length
385 * - not less than four bytes
387 val
= ctx
->tx_ndp_modulus
;
389 if ((val
< USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
) ||
390 (val
!= ((-val
) & val
)) || (val
>= ctx
->tx_max
)) {
391 dev_dbg(&dev
->intf
->dev
, "Using default alignment: 4 bytes\n");
392 ctx
->tx_ndp_modulus
= USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
;
396 * verify that the payload alignment is:
398 * - not greater than the maximum transmit length
399 * - not less than four bytes
401 val
= ctx
->tx_modulus
;
403 if ((val
< USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
) ||
404 (val
!= ((-val
) & val
)) || (val
>= ctx
->tx_max
)) {
405 dev_dbg(&dev
->intf
->dev
, "Using default transmit modulus: 4 bytes\n");
406 ctx
->tx_modulus
= USB_CDC_NCM_NDP_ALIGN_MIN_SIZE
;
409 /* verify the payload remainder */
410 if (ctx
->tx_remainder
>= ctx
->tx_modulus
) {
411 dev_dbg(&dev
->intf
->dev
, "Using default transmit remainder: 0 bytes\n");
412 ctx
->tx_remainder
= 0;
415 /* adjust TX-remainder according to NCM specification. */
416 ctx
->tx_remainder
= ((ctx
->tx_remainder
- cdc_ncm_eth_hlen(dev
)) &
417 (ctx
->tx_modulus
- 1));
420 static int cdc_ncm_setup(struct usbnet
*dev
)
422 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
424 /* clamp rx_max and tx_max and inform device */
425 cdc_ncm_update_rxtx_max(dev
, le32_to_cpu(ctx
->ncm_parm
.dwNtbInMaxSize
),
426 le32_to_cpu(ctx
->ncm_parm
.dwNtbOutMaxSize
));
428 /* sanitize the modulus and remainder values */
429 cdc_ncm_fix_modulus(dev
);
431 /* set max datagram size */
432 cdc_ncm_set_dgram_size(dev
, cdc_ncm_max_dgram_size(dev
));
437 cdc_ncm_find_endpoints(struct usbnet
*dev
, struct usb_interface
*intf
)
439 struct usb_host_endpoint
*e
, *in
= NULL
, *out
= NULL
;
442 for (ep
= 0; ep
< intf
->cur_altsetting
->desc
.bNumEndpoints
; ep
++) {
444 e
= intf
->cur_altsetting
->endpoint
+ ep
;
445 switch (e
->desc
.bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) {
446 case USB_ENDPOINT_XFER_INT
:
447 if (usb_endpoint_dir_in(&e
->desc
)) {
453 case USB_ENDPOINT_XFER_BULK
:
454 if (usb_endpoint_dir_in(&e
->desc
)) {
468 dev
->in
= usb_rcvbulkpipe(dev
->udev
,
469 in
->desc
.bEndpointAddress
&
470 USB_ENDPOINT_NUMBER_MASK
);
471 if (out
&& !dev
->out
)
472 dev
->out
= usb_sndbulkpipe(dev
->udev
,
473 out
->desc
.bEndpointAddress
&
474 USB_ENDPOINT_NUMBER_MASK
);
477 static void cdc_ncm_free(struct cdc_ncm_ctx
*ctx
)
482 if (ctx
->tx_rem_skb
!= NULL
) {
483 dev_kfree_skb_any(ctx
->tx_rem_skb
);
484 ctx
->tx_rem_skb
= NULL
;
487 if (ctx
->tx_curr_skb
!= NULL
) {
488 dev_kfree_skb_any(ctx
->tx_curr_skb
);
489 ctx
->tx_curr_skb
= NULL
;
495 int cdc_ncm_bind_common(struct usbnet
*dev
, struct usb_interface
*intf
, u8 data_altsetting
)
497 const struct usb_cdc_union_desc
*union_desc
= NULL
;
498 struct cdc_ncm_ctx
*ctx
;
499 struct usb_driver
*driver
;
505 ctx
= kzalloc(sizeof(*ctx
), GFP_KERNEL
);
509 hrtimer_init(&ctx
->tx_timer
, CLOCK_MONOTONIC
, HRTIMER_MODE_REL
);
510 ctx
->tx_timer
.function
= &cdc_ncm_tx_timer_cb
;
511 ctx
->bh
.data
= (unsigned long)dev
;
512 ctx
->bh
.func
= cdc_ncm_txpath_bh
;
513 atomic_set(&ctx
->stop
, 0);
514 spin_lock_init(&ctx
->mtx
);
516 /* store ctx pointer in device data field */
517 dev
->data
[0] = (unsigned long)ctx
;
519 /* only the control interface can be successfully probed */
522 /* get some pointers */
523 driver
= driver_of(intf
);
524 buf
= intf
->cur_altsetting
->extra
;
525 len
= intf
->cur_altsetting
->extralen
;
527 /* parse through descriptors associated with control interface */
528 while ((len
> 0) && (buf
[0] > 2) && (buf
[0] <= len
)) {
530 if (buf
[1] != USB_DT_CS_INTERFACE
)
534 case USB_CDC_UNION_TYPE
:
535 if (buf
[0] < sizeof(*union_desc
))
538 union_desc
= (const struct usb_cdc_union_desc
*)buf
;
539 /* the master must be the interface we are probing */
540 if (intf
->cur_altsetting
->desc
.bInterfaceNumber
!=
541 union_desc
->bMasterInterface0
) {
542 dev_dbg(&intf
->dev
, "bogus CDC Union\n");
545 ctx
->data
= usb_ifnum_to_if(dev
->udev
,
546 union_desc
->bSlaveInterface0
);
549 case USB_CDC_ETHERNET_TYPE
:
550 if (buf
[0] < sizeof(*(ctx
->ether_desc
)))
554 (const struct usb_cdc_ether_desc
*)buf
;
557 case USB_CDC_NCM_TYPE
:
558 if (buf
[0] < sizeof(*(ctx
->func_desc
)))
561 ctx
->func_desc
= (const struct usb_cdc_ncm_desc
*)buf
;
564 case USB_CDC_MBIM_TYPE
:
565 if (buf
[0] < sizeof(*(ctx
->mbim_desc
)))
568 ctx
->mbim_desc
= (const struct usb_cdc_mbim_desc
*)buf
;
571 case USB_CDC_MBIM_EXTENDED_TYPE
:
572 if (buf
[0] < sizeof(*(ctx
->mbim_extended_desc
)))
575 ctx
->mbim_extended_desc
=
576 (const struct usb_cdc_mbim_extended_desc
*)buf
;
583 /* advance to next descriptor */
589 /* some buggy devices have an IAD but no CDC Union */
590 if (!union_desc
&& intf
->intf_assoc
&& intf
->intf_assoc
->bInterfaceCount
== 2) {
591 ctx
->data
= usb_ifnum_to_if(dev
->udev
, intf
->cur_altsetting
->desc
.bInterfaceNumber
+ 1);
592 dev_dbg(&intf
->dev
, "CDC Union missing - got slave from IAD\n");
595 /* check if we got everything */
597 dev_dbg(&intf
->dev
, "CDC Union missing and no IAD found\n");
600 if (cdc_ncm_comm_intf_is_mbim(intf
->cur_altsetting
)) {
601 if (!ctx
->mbim_desc
) {
602 dev_dbg(&intf
->dev
, "MBIM functional descriptor missing\n");
606 if (!ctx
->ether_desc
|| !ctx
->func_desc
) {
607 dev_dbg(&intf
->dev
, "NCM or ECM functional descriptors missing\n");
612 /* claim data interface, if different from control */
613 if (ctx
->data
!= ctx
->control
) {
614 temp
= usb_driver_claim_interface(driver
, ctx
->data
, dev
);
616 dev_dbg(&intf
->dev
, "failed to claim data intf\n");
621 iface_no
= ctx
->data
->cur_altsetting
->desc
.bInterfaceNumber
;
623 /* reset data interface */
624 temp
= usb_set_interface(dev
->udev
, iface_no
, 0);
626 dev_dbg(&intf
->dev
, "set interface failed\n");
630 /* initialize basic device settings */
631 if (cdc_ncm_init(dev
))
634 /* configure data interface */
635 temp
= usb_set_interface(dev
->udev
, iface_no
, data_altsetting
);
637 dev_dbg(&intf
->dev
, "set interface failed\n");
641 cdc_ncm_find_endpoints(dev
, ctx
->data
);
642 cdc_ncm_find_endpoints(dev
, ctx
->control
);
643 if (!dev
->in
|| !dev
->out
|| !dev
->status
) {
644 dev_dbg(&intf
->dev
, "failed to collect endpoints\n");
648 usb_set_intfdata(ctx
->data
, dev
);
649 usb_set_intfdata(ctx
->control
, dev
);
651 if (ctx
->ether_desc
) {
652 temp
= usbnet_get_ethernet_addr(dev
, ctx
->ether_desc
->iMACAddress
);
654 dev_dbg(&intf
->dev
, "failed to get mac address\n");
657 dev_info(&intf
->dev
, "MAC-Address: %pM\n", dev
->net
->dev_addr
);
660 /* finish setting up the device specific data */
663 /* override ethtool_ops */
664 dev
->net
->ethtool_ops
= &cdc_ncm_ethtool_ops
;
669 usb_set_intfdata(ctx
->control
, NULL
);
670 usb_set_intfdata(ctx
->data
, NULL
);
671 if (ctx
->data
!= ctx
->control
)
672 usb_driver_release_interface(driver
, ctx
->data
);
674 cdc_ncm_free((struct cdc_ncm_ctx
*)dev
->data
[0]);
676 dev_info(&intf
->dev
, "bind() failure\n");
679 EXPORT_SYMBOL_GPL(cdc_ncm_bind_common
);
681 void cdc_ncm_unbind(struct usbnet
*dev
, struct usb_interface
*intf
)
683 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
684 struct usb_driver
*driver
= driver_of(intf
);
687 return; /* no setup */
689 atomic_set(&ctx
->stop
, 1);
691 if (hrtimer_active(&ctx
->tx_timer
))
692 hrtimer_cancel(&ctx
->tx_timer
);
694 tasklet_kill(&ctx
->bh
);
696 /* handle devices with combined control and data interface */
697 if (ctx
->control
== ctx
->data
)
700 /* disconnect master --> disconnect slave */
701 if (intf
== ctx
->control
&& ctx
->data
) {
702 usb_set_intfdata(ctx
->data
, NULL
);
703 usb_driver_release_interface(driver
, ctx
->data
);
706 } else if (intf
== ctx
->data
&& ctx
->control
) {
707 usb_set_intfdata(ctx
->control
, NULL
);
708 usb_driver_release_interface(driver
, ctx
->control
);
712 usb_set_intfdata(intf
, NULL
);
715 EXPORT_SYMBOL_GPL(cdc_ncm_unbind
);
717 /* Return the number of the MBIM control interface altsetting iff it
718 * is preferred and available,
720 u8
cdc_ncm_select_altsetting(struct usb_interface
*intf
)
722 struct usb_host_interface
*alt
;
724 /* The MBIM spec defines a NCM compatible default altsetting,
725 * which we may have matched:
727 * "Functions that implement both NCM 1.0 and MBIM (an
728 * “NCM/MBIM function”) according to this recommendation
729 * shall provide two alternate settings for the
730 * Communication Interface. Alternate setting 0, and the
731 * associated class and endpoint descriptors, shall be
732 * constructed according to the rules given for the
733 * Communication Interface in section 5 of [USBNCM10].
734 * Alternate setting 1, and the associated class and
735 * endpoint descriptors, shall be constructed according to
736 * the rules given in section 6 (USB Device Model) of this
739 if (intf
->num_altsetting
< 2)
740 return intf
->cur_altsetting
->desc
.bAlternateSetting
;
743 alt
= usb_altnum_to_altsetting(intf
, CDC_NCM_COMM_ALTSETTING_MBIM
);
744 if (alt
&& cdc_ncm_comm_intf_is_mbim(alt
))
745 return CDC_NCM_COMM_ALTSETTING_MBIM
;
747 return CDC_NCM_COMM_ALTSETTING_NCM
;
749 EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting
);
751 static int cdc_ncm_bind(struct usbnet
*dev
, struct usb_interface
*intf
)
755 /* MBIM backwards compatible function? */
756 if (cdc_ncm_select_altsetting(intf
) != CDC_NCM_COMM_ALTSETTING_NCM
)
759 /* The NCM data altsetting is fixed */
760 ret
= cdc_ncm_bind_common(dev
, intf
, CDC_NCM_DATA_ALTSETTING_NCM
);
763 * We should get an event when network connection is "connected" or
764 * "disconnected". Set network connection in "disconnected" state
765 * (carrier is OFF) during attach, so the IP network stack does not
766 * start IPv6 negotiation and more.
768 usbnet_link_change(dev
, 0, 0);
772 static void cdc_ncm_align_tail(struct sk_buff
*skb
, size_t modulus
, size_t remainder
, size_t max
)
774 size_t align
= ALIGN(skb
->len
, modulus
) - skb
->len
+ remainder
;
776 if (skb
->len
+ align
> max
)
777 align
= max
- skb
->len
;
778 if (align
&& skb_tailroom(skb
) >= align
)
779 memset(skb_put(skb
, align
), 0, align
);
782 /* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
783 * allocating a new one within skb
785 static struct usb_cdc_ncm_ndp16
*cdc_ncm_ndp(struct cdc_ncm_ctx
*ctx
, struct sk_buff
*skb
, __le32 sign
, size_t reserve
)
787 struct usb_cdc_ncm_ndp16
*ndp16
= NULL
;
788 struct usb_cdc_ncm_nth16
*nth16
= (void *)skb
->data
;
789 size_t ndpoffset
= le16_to_cpu(nth16
->wNdpIndex
);
791 /* follow the chain of NDPs, looking for a match */
793 ndp16
= (struct usb_cdc_ncm_ndp16
*)(skb
->data
+ ndpoffset
);
794 if (ndp16
->dwSignature
== sign
)
796 ndpoffset
= le16_to_cpu(ndp16
->wNextNdpIndex
);
800 cdc_ncm_align_tail(skb
, ctx
->tx_ndp_modulus
, 0, ctx
->tx_max
);
802 /* verify that there is room for the NDP and the datagram (reserve) */
803 if ((ctx
->tx_max
- skb
->len
- reserve
) < CDC_NCM_NDP_SIZE
)
808 ndp16
->wNextNdpIndex
= cpu_to_le16(skb
->len
);
810 nth16
->wNdpIndex
= cpu_to_le16(skb
->len
);
812 /* push a new empty NDP */
813 ndp16
= (struct usb_cdc_ncm_ndp16
*)memset(skb_put(skb
, CDC_NCM_NDP_SIZE
), 0, CDC_NCM_NDP_SIZE
);
814 ndp16
->dwSignature
= sign
;
815 ndp16
->wLength
= cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16
) + sizeof(struct usb_cdc_ncm_dpe16
));
820 cdc_ncm_fill_tx_frame(struct usbnet
*dev
, struct sk_buff
*skb
, __le32 sign
)
822 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
823 struct usb_cdc_ncm_nth16
*nth16
;
824 struct usb_cdc_ncm_ndp16
*ndp16
;
825 struct sk_buff
*skb_out
;
826 u16 n
= 0, index
, ndplen
;
829 /* if there is a remaining skb, it gets priority */
831 swap(skb
, ctx
->tx_rem_skb
);
832 swap(sign
, ctx
->tx_rem_sign
);
837 /* check if we are resuming an OUT skb */
838 skb_out
= ctx
->tx_curr_skb
;
840 /* allocate a new OUT skb */
842 skb_out
= alloc_skb(ctx
->tx_max
, GFP_ATOMIC
);
843 if (skb_out
== NULL
) {
845 dev_kfree_skb_any(skb
);
846 dev
->net
->stats
.tx_dropped
++;
850 /* fill out the initial 16-bit NTB header */
851 nth16
= (struct usb_cdc_ncm_nth16
*)memset(skb_put(skb_out
, sizeof(struct usb_cdc_ncm_nth16
)), 0, sizeof(struct usb_cdc_ncm_nth16
));
852 nth16
->dwSignature
= cpu_to_le32(USB_CDC_NCM_NTH16_SIGN
);
853 nth16
->wHeaderLength
= cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16
));
854 nth16
->wSequence
= cpu_to_le16(ctx
->tx_seq
++);
856 /* count total number of frames in this NTB */
857 ctx
->tx_curr_frame_num
= 0;
860 for (n
= ctx
->tx_curr_frame_num
; n
< ctx
->tx_max_datagrams
; n
++) {
861 /* send any remaining skb first */
863 skb
= ctx
->tx_rem_skb
;
864 sign
= ctx
->tx_rem_sign
;
865 ctx
->tx_rem_skb
= NULL
;
867 /* check for end of skb */
872 /* get the appropriate NDP for this skb */
873 ndp16
= cdc_ncm_ndp(ctx
, skb_out
, sign
, skb
->len
+ ctx
->tx_modulus
+ ctx
->tx_remainder
);
875 /* align beginning of next frame */
876 cdc_ncm_align_tail(skb_out
, ctx
->tx_modulus
, ctx
->tx_remainder
, ctx
->tx_max
);
878 /* check if we had enough room left for both NDP and frame */
879 if (!ndp16
|| skb_out
->len
+ skb
->len
> ctx
->tx_max
) {
881 /* won't fit, MTU problem? */
882 dev_kfree_skb_any(skb
);
884 dev
->net
->stats
.tx_dropped
++;
886 /* no room for skb - store for later */
887 if (ctx
->tx_rem_skb
!= NULL
) {
888 dev_kfree_skb_any(ctx
->tx_rem_skb
);
889 dev
->net
->stats
.tx_dropped
++;
891 ctx
->tx_rem_skb
= skb
;
892 ctx
->tx_rem_sign
= sign
;
899 /* calculate frame number withing this NDP */
900 ndplen
= le16_to_cpu(ndp16
->wLength
);
901 index
= (ndplen
- sizeof(struct usb_cdc_ncm_ndp16
)) / sizeof(struct usb_cdc_ncm_dpe16
) - 1;
903 /* OK, add this skb */
904 ndp16
->dpe16
[index
].wDatagramLength
= cpu_to_le16(skb
->len
);
905 ndp16
->dpe16
[index
].wDatagramIndex
= cpu_to_le16(skb_out
->len
);
906 ndp16
->wLength
= cpu_to_le16(ndplen
+ sizeof(struct usb_cdc_ncm_dpe16
));
907 memcpy(skb_put(skb_out
, skb
->len
), skb
->data
, skb
->len
);
908 dev_kfree_skb_any(skb
);
911 /* send now if this NDP is full */
912 if (index
>= CDC_NCM_DPT_DATAGRAMS_MAX
) {
918 /* free up any dangling skb */
920 dev_kfree_skb_any(skb
);
922 dev
->net
->stats
.tx_dropped
++;
925 ctx
->tx_curr_frame_num
= n
;
928 /* wait for more frames */
930 ctx
->tx_curr_skb
= skb_out
;
933 } else if ((n
< ctx
->tx_max_datagrams
) && (ready2send
== 0) && (ctx
->timer_interval
> 0)) {
934 /* wait for more frames */
936 ctx
->tx_curr_skb
= skb_out
;
937 /* set the pending count */
938 if (n
< CDC_NCM_RESTART_TIMER_DATAGRAM_CNT
)
939 ctx
->tx_timer_pending
= CDC_NCM_TIMER_PENDING_CNT
;
944 /* variables will be reset at next call */
947 /* If collected data size is less or equal CDC_NCM_MIN_TX_PKT
948 * bytes, we send buffers as it is. If we get more data, it
949 * would be more efficient for USB HS mobile device with DMA
950 * engine to receive a full size NTB, than canceling DMA
951 * transfer and receiving a short packet.
953 * This optimization support is pointless if we end up sending
954 * a ZLP after full sized NTBs.
956 if (!(dev
->driver_info
->flags
& FLAG_SEND_ZLP
) &&
957 skb_out
->len
> CDC_NCM_MIN_TX_PKT
)
958 memset(skb_put(skb_out
, ctx
->tx_max
- skb_out
->len
), 0,
959 ctx
->tx_max
- skb_out
->len
);
960 else if (skb_out
->len
< ctx
->tx_max
&& (skb_out
->len
% dev
->maxpacket
) == 0)
961 *skb_put(skb_out
, 1) = 0; /* force short packet */
963 /* set final frame length */
964 nth16
= (struct usb_cdc_ncm_nth16
*)skb_out
->data
;
965 nth16
->wBlockLength
= cpu_to_le16(skb_out
->len
);
968 ctx
->tx_curr_skb
= NULL
;
969 dev
->net
->stats
.tx_packets
+= ctx
->tx_curr_frame_num
;
973 /* Start timer, if there is a remaining skb */
974 if (ctx
->tx_curr_skb
!= NULL
)
975 cdc_ncm_tx_timeout_start(ctx
);
978 EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame
);
980 static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx
*ctx
)
982 /* start timer, if not already started */
983 if (!(hrtimer_active(&ctx
->tx_timer
) || atomic_read(&ctx
->stop
)))
984 hrtimer_start(&ctx
->tx_timer
,
985 ktime_set(0, ctx
->timer_interval
),
989 static enum hrtimer_restart
cdc_ncm_tx_timer_cb(struct hrtimer
*timer
)
991 struct cdc_ncm_ctx
*ctx
=
992 container_of(timer
, struct cdc_ncm_ctx
, tx_timer
);
994 if (!atomic_read(&ctx
->stop
))
995 tasklet_schedule(&ctx
->bh
);
996 return HRTIMER_NORESTART
;
999 static void cdc_ncm_txpath_bh(unsigned long param
)
1001 struct usbnet
*dev
= (struct usbnet
*)param
;
1002 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
1004 spin_lock_bh(&ctx
->mtx
);
1005 if (ctx
->tx_timer_pending
!= 0) {
1006 ctx
->tx_timer_pending
--;
1007 cdc_ncm_tx_timeout_start(ctx
);
1008 spin_unlock_bh(&ctx
->mtx
);
1009 } else if (dev
->net
!= NULL
) {
1010 spin_unlock_bh(&ctx
->mtx
);
1011 netif_tx_lock_bh(dev
->net
);
1012 usbnet_start_xmit(NULL
, dev
->net
);
1013 netif_tx_unlock_bh(dev
->net
);
1015 spin_unlock_bh(&ctx
->mtx
);
1020 cdc_ncm_tx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
, gfp_t flags
)
1022 struct sk_buff
*skb_out
;
1023 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
1026 * The Ethernet API we are using does not support transmitting
1027 * multiple Ethernet frames in a single call. This driver will
1028 * accumulate multiple Ethernet frames and send out a larger
1029 * USB frame when the USB buffer is full or when a single jiffies
1035 spin_lock_bh(&ctx
->mtx
);
1036 skb_out
= cdc_ncm_fill_tx_frame(dev
, skb
, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN
));
1037 spin_unlock_bh(&ctx
->mtx
);
1042 dev_kfree_skb_any(skb
);
1046 EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup
);
1048 /* verify NTB header and return offset of first NDP, or negative error */
1049 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx
*ctx
, struct sk_buff
*skb_in
)
1051 struct usbnet
*dev
= netdev_priv(skb_in
->dev
);
1052 struct usb_cdc_ncm_nth16
*nth16
;
1059 if (skb_in
->len
< (sizeof(struct usb_cdc_ncm_nth16
) +
1060 sizeof(struct usb_cdc_ncm_ndp16
))) {
1061 netif_dbg(dev
, rx_err
, dev
->net
, "frame too short\n");
1065 nth16
= (struct usb_cdc_ncm_nth16
*)skb_in
->data
;
1067 if (nth16
->dwSignature
!= cpu_to_le32(USB_CDC_NCM_NTH16_SIGN
)) {
1068 netif_dbg(dev
, rx_err
, dev
->net
,
1069 "invalid NTH16 signature <%#010x>\n",
1070 le32_to_cpu(nth16
->dwSignature
));
1074 len
= le16_to_cpu(nth16
->wBlockLength
);
1075 if (len
> ctx
->rx_max
) {
1076 netif_dbg(dev
, rx_err
, dev
->net
,
1077 "unsupported NTB block length %u/%u\n", len
,
1082 if ((ctx
->rx_seq
+ 1) != le16_to_cpu(nth16
->wSequence
) &&
1083 (ctx
->rx_seq
|| le16_to_cpu(nth16
->wSequence
)) &&
1084 !((ctx
->rx_seq
== 0xffff) && !le16_to_cpu(nth16
->wSequence
))) {
1085 netif_dbg(dev
, rx_err
, dev
->net
,
1086 "sequence number glitch prev=%d curr=%d\n",
1087 ctx
->rx_seq
, le16_to_cpu(nth16
->wSequence
));
1089 ctx
->rx_seq
= le16_to_cpu(nth16
->wSequence
);
1091 ret
= le16_to_cpu(nth16
->wNdpIndex
);
1095 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16
);
1097 /* verify NDP header and return number of datagrams, or negative error */
1098 int cdc_ncm_rx_verify_ndp16(struct sk_buff
*skb_in
, int ndpoffset
)
1100 struct usbnet
*dev
= netdev_priv(skb_in
->dev
);
1101 struct usb_cdc_ncm_ndp16
*ndp16
;
1104 if ((ndpoffset
+ sizeof(struct usb_cdc_ncm_ndp16
)) > skb_in
->len
) {
1105 netif_dbg(dev
, rx_err
, dev
->net
, "invalid NDP offset <%u>\n",
1109 ndp16
= (struct usb_cdc_ncm_ndp16
*)(skb_in
->data
+ ndpoffset
);
1111 if (le16_to_cpu(ndp16
->wLength
) < USB_CDC_NCM_NDP16_LENGTH_MIN
) {
1112 netif_dbg(dev
, rx_err
, dev
->net
, "invalid DPT16 length <%u>\n",
1113 le16_to_cpu(ndp16
->wLength
));
1117 ret
= ((le16_to_cpu(ndp16
->wLength
) -
1118 sizeof(struct usb_cdc_ncm_ndp16
)) /
1119 sizeof(struct usb_cdc_ncm_dpe16
));
1120 ret
--; /* we process NDP entries except for the last one */
1122 if ((sizeof(struct usb_cdc_ncm_ndp16
) +
1123 ret
* (sizeof(struct usb_cdc_ncm_dpe16
))) > skb_in
->len
) {
1124 netif_dbg(dev
, rx_err
, dev
->net
, "Invalid nframes = %d\n", ret
);
1131 EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16
);
1133 int cdc_ncm_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb_in
)
1135 struct sk_buff
*skb
;
1136 struct cdc_ncm_ctx
*ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
1141 struct usb_cdc_ncm_ndp16
*ndp16
;
1142 struct usb_cdc_ncm_dpe16
*dpe16
;
1144 int loopcount
= 50; /* arbitrary max preventing infinite loop */
1146 ndpoffset
= cdc_ncm_rx_verify_nth16(ctx
, skb_in
);
1151 nframes
= cdc_ncm_rx_verify_ndp16(skb_in
, ndpoffset
);
1155 ndp16
= (struct usb_cdc_ncm_ndp16
*)(skb_in
->data
+ ndpoffset
);
1157 if (ndp16
->dwSignature
!= cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN
)) {
1158 netif_dbg(dev
, rx_err
, dev
->net
,
1159 "invalid DPT16 signature <%#010x>\n",
1160 le32_to_cpu(ndp16
->dwSignature
));
1163 dpe16
= ndp16
->dpe16
;
1165 for (x
= 0; x
< nframes
; x
++, dpe16
++) {
1166 offset
= le16_to_cpu(dpe16
->wDatagramIndex
);
1167 len
= le16_to_cpu(dpe16
->wDatagramLength
);
1171 * All entries after first NULL entry are to be ignored
1173 if ((offset
== 0) || (len
== 0)) {
1175 goto err_ndp
; /* empty NTB */
1179 /* sanity checking */
1180 if (((offset
+ len
) > skb_in
->len
) ||
1181 (len
> ctx
->rx_max
) || (len
< ETH_HLEN
)) {
1182 netif_dbg(dev
, rx_err
, dev
->net
,
1183 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1184 x
, offset
, len
, skb_in
);
1190 skb
= skb_clone(skb_in
, GFP_ATOMIC
);
1194 skb
->data
= ((u8
*)skb_in
->data
) + offset
;
1195 skb_set_tail_pointer(skb
, len
);
1196 usbnet_skb_return(dev
, skb
);
1200 /* are there more NDPs to process? */
1201 ndpoffset
= le16_to_cpu(ndp16
->wNextNdpIndex
);
1202 if (ndpoffset
&& loopcount
--)
1209 EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup
);
1212 cdc_ncm_speed_change(struct usbnet
*dev
,
1213 struct usb_cdc_speed_change
*data
)
1215 uint32_t rx_speed
= le32_to_cpu(data
->DLBitRRate
);
1216 uint32_t tx_speed
= le32_to_cpu(data
->ULBitRate
);
1219 * Currently the USB-NET API does not support reporting the actual
1220 * device speed. Do print it instead.
1222 if ((tx_speed
> 1000000) && (rx_speed
> 1000000)) {
1223 netif_info(dev
, link
, dev
->net
,
1224 "%u mbit/s downlink %u mbit/s uplink\n",
1225 (unsigned int)(rx_speed
/ 1000000U),
1226 (unsigned int)(tx_speed
/ 1000000U));
1228 netif_info(dev
, link
, dev
->net
,
1229 "%u kbit/s downlink %u kbit/s uplink\n",
1230 (unsigned int)(rx_speed
/ 1000U),
1231 (unsigned int)(tx_speed
/ 1000U));
1235 static void cdc_ncm_status(struct usbnet
*dev
, struct urb
*urb
)
1237 struct cdc_ncm_ctx
*ctx
;
1238 struct usb_cdc_notification
*event
;
1240 ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
1242 if (urb
->actual_length
< sizeof(*event
))
1245 /* test for split data in 8-byte chunks */
1246 if (test_and_clear_bit(EVENT_STS_SPLIT
, &dev
->flags
)) {
1247 cdc_ncm_speed_change(dev
,
1248 (struct usb_cdc_speed_change
*)urb
->transfer_buffer
);
1252 event
= urb
->transfer_buffer
;
1254 switch (event
->bNotificationType
) {
1255 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
1257 * According to the CDC NCM specification ch.7.1
1258 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1259 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1261 ctx
->connected
= le16_to_cpu(event
->wValue
);
1262 netif_info(dev
, link
, dev
->net
,
1263 "network connection: %sconnected\n",
1264 ctx
->connected
? "" : "dis");
1265 usbnet_link_change(dev
, ctx
->connected
, 0);
1268 case USB_CDC_NOTIFY_SPEED_CHANGE
:
1269 if (urb
->actual_length
< (sizeof(*event
) +
1270 sizeof(struct usb_cdc_speed_change
)))
1271 set_bit(EVENT_STS_SPLIT
, &dev
->flags
);
1273 cdc_ncm_speed_change(dev
,
1274 (struct usb_cdc_speed_change
*)&event
[1]);
1278 dev_dbg(&dev
->udev
->dev
,
1279 "NCM: unexpected notification 0x%02x!\n",
1280 event
->bNotificationType
);
1285 static int cdc_ncm_check_connect(struct usbnet
*dev
)
1287 struct cdc_ncm_ctx
*ctx
;
1289 ctx
= (struct cdc_ncm_ctx
*)dev
->data
[0];
1291 return 1; /* disconnected */
1293 return !ctx
->connected
;
1296 static const struct driver_info cdc_ncm_info
= {
1297 .description
= "CDC NCM",
1298 .flags
= FLAG_POINTTOPOINT
| FLAG_NO_SETINT
| FLAG_MULTI_PACKET
,
1299 .bind
= cdc_ncm_bind
,
1300 .unbind
= cdc_ncm_unbind
,
1301 .check_connect
= cdc_ncm_check_connect
,
1302 .manage_power
= usbnet_manage_power
,
1303 .status
= cdc_ncm_status
,
1304 .rx_fixup
= cdc_ncm_rx_fixup
,
1305 .tx_fixup
= cdc_ncm_tx_fixup
,
1308 /* Same as cdc_ncm_info, but with FLAG_WWAN */
1309 static const struct driver_info wwan_info
= {
1310 .description
= "Mobile Broadband Network Device",
1311 .flags
= FLAG_POINTTOPOINT
| FLAG_NO_SETINT
| FLAG_MULTI_PACKET
1313 .bind
= cdc_ncm_bind
,
1314 .unbind
= cdc_ncm_unbind
,
1315 .check_connect
= cdc_ncm_check_connect
,
1316 .manage_power
= usbnet_manage_power
,
1317 .status
= cdc_ncm_status
,
1318 .rx_fixup
= cdc_ncm_rx_fixup
,
1319 .tx_fixup
= cdc_ncm_tx_fixup
,
1322 /* Same as wwan_info, but with FLAG_NOARP */
1323 static const struct driver_info wwan_noarp_info
= {
1324 .description
= "Mobile Broadband Network Device (NO ARP)",
1325 .flags
= FLAG_POINTTOPOINT
| FLAG_NO_SETINT
| FLAG_MULTI_PACKET
1326 | FLAG_WWAN
| FLAG_NOARP
,
1327 .bind
= cdc_ncm_bind
,
1328 .unbind
= cdc_ncm_unbind
,
1329 .check_connect
= cdc_ncm_check_connect
,
1330 .manage_power
= usbnet_manage_power
,
1331 .status
= cdc_ncm_status
,
1332 .rx_fixup
= cdc_ncm_rx_fixup
,
1333 .tx_fixup
= cdc_ncm_tx_fixup
,
1336 static const struct usb_device_id cdc_devs
[] = {
1337 /* Ericsson MBM devices like F5521gw */
1338 { .match_flags
= USB_DEVICE_ID_MATCH_INT_INFO
1339 | USB_DEVICE_ID_MATCH_VENDOR
,
1341 .bInterfaceClass
= USB_CLASS_COMM
,
1342 .bInterfaceSubClass
= USB_CDC_SUBCLASS_NCM
,
1343 .bInterfaceProtocol
= USB_CDC_PROTO_NONE
,
1344 .driver_info
= (unsigned long) &wwan_info
,
1347 /* Dell branded MBM devices like DW5550 */
1348 { .match_flags
= USB_DEVICE_ID_MATCH_INT_INFO
1349 | USB_DEVICE_ID_MATCH_VENDOR
,
1351 .bInterfaceClass
= USB_CLASS_COMM
,
1352 .bInterfaceSubClass
= USB_CDC_SUBCLASS_NCM
,
1353 .bInterfaceProtocol
= USB_CDC_PROTO_NONE
,
1354 .driver_info
= (unsigned long) &wwan_info
,
1357 /* Toshiba branded MBM devices */
1358 { .match_flags
= USB_DEVICE_ID_MATCH_INT_INFO
1359 | USB_DEVICE_ID_MATCH_VENDOR
,
1361 .bInterfaceClass
= USB_CLASS_COMM
,
1362 .bInterfaceSubClass
= USB_CDC_SUBCLASS_NCM
,
1363 .bInterfaceProtocol
= USB_CDC_PROTO_NONE
,
1364 .driver_info
= (unsigned long) &wwan_info
,
1367 /* tag Huawei devices as wwan */
1368 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1370 USB_CDC_SUBCLASS_NCM
,
1371 USB_CDC_PROTO_NONE
),
1372 .driver_info
= (unsigned long)&wwan_info
,
1375 /* Infineon(now Intel) HSPA Modem platform */
1376 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1378 USB_CDC_SUBCLASS_NCM
, USB_CDC_PROTO_NONE
),
1379 .driver_info
= (unsigned long)&wwan_noarp_info
,
1382 /* Generic CDC-NCM devices */
1383 { USB_INTERFACE_INFO(USB_CLASS_COMM
,
1384 USB_CDC_SUBCLASS_NCM
, USB_CDC_PROTO_NONE
),
1385 .driver_info
= (unsigned long)&cdc_ncm_info
,
1390 MODULE_DEVICE_TABLE(usb
, cdc_devs
);
1392 static struct usb_driver cdc_ncm_driver
= {
1394 .id_table
= cdc_devs
,
1395 .probe
= usbnet_probe
,
1396 .disconnect
= usbnet_disconnect
,
1397 .suspend
= usbnet_suspend
,
1398 .resume
= usbnet_resume
,
1399 .reset_resume
= usbnet_resume
,
1400 .supports_autosuspend
= 1,
1401 .disable_hub_initiated_lpm
= 1,
1404 module_usb_driver(cdc_ncm_driver
);
1406 MODULE_AUTHOR("Hans Petter Selasky");
1407 MODULE_DESCRIPTION("USB CDC NCM host driver");
1408 MODULE_LICENSE("Dual BSD/GPL");