2 * Copyright (c) 2012 Smith Micro Software, Inc.
3 * Copyright (c) 2012 Bjørn Mork <bjorn@mork.no>
5 * This driver is based on and reuse most of cdc_ncm, which is
6 * Copyright (C) ST-Ericsson 2010-2012
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/netdevice.h>
15 #include <linux/ethtool.h>
16 #include <linux/if_vlan.h>
18 #include <linux/mii.h>
19 #include <linux/usb.h>
20 #include <linux/usb/cdc.h>
21 #include <linux/usb/usbnet.h>
22 #include <linux/usb/cdc-wdm.h>
23 #include <linux/usb/cdc_ncm.h>
25 #include <net/addrconf.h>
27 /* alternative VLAN for IP session 0 if not untagged */
28 #define MBIM_IPS0_VID 4094
30 /* driver specific data - must match cdc_ncm usage */
31 struct cdc_mbim_state
{
32 struct cdc_ncm_ctx
*ctx
;
34 struct usb_driver
*subdriver
;
35 unsigned long _unused
;
39 /* flags for the cdc_mbim_state.flags field */
41 FLAG_IPS0_VLAN
= 1 << 0, /* IP session 0 is tagged */
44 /* using a counter to merge subdriver requests with our own into a combined state */
45 static int cdc_mbim_manage_power(struct usbnet
*dev
, int on
)
47 struct cdc_mbim_state
*info
= (void *)&dev
->data
;
50 dev_dbg(&dev
->intf
->dev
, "%s() pmcount=%d, on=%d\n", __func__
, atomic_read(&info
->pmcount
), on
);
52 if ((on
&& atomic_add_return(1, &info
->pmcount
) == 1) || (!on
&& atomic_dec_and_test(&info
->pmcount
))) {
53 /* need autopm_get/put here to ensure the usbcore sees the new value */
54 rv
= usb_autopm_get_interface(dev
->intf
);
55 dev
->intf
->needs_remote_wakeup
= on
;
57 usb_autopm_put_interface(dev
->intf
);
62 static int cdc_mbim_wdm_manage_power(struct usb_interface
*intf
, int status
)
64 struct usbnet
*dev
= usb_get_intfdata(intf
);
66 /* can be called while disconnecting */
70 return cdc_mbim_manage_power(dev
, status
);
73 static int cdc_mbim_rx_add_vid(struct net_device
*netdev
, __be16 proto
, u16 vid
)
75 struct usbnet
*dev
= netdev_priv(netdev
);
76 struct cdc_mbim_state
*info
= (void *)&dev
->data
;
78 /* creation of this VLAN is a request to tag IP session 0 */
79 if (vid
== MBIM_IPS0_VID
)
80 info
->flags
|= FLAG_IPS0_VLAN
;
82 if (vid
>= 512) /* we don't map these to MBIM session */
87 static int cdc_mbim_rx_kill_vid(struct net_device
*netdev
, __be16 proto
, u16 vid
)
89 struct usbnet
*dev
= netdev_priv(netdev
);
90 struct cdc_mbim_state
*info
= (void *)&dev
->data
;
92 /* this is a request for an untagged IP session 0 */
93 if (vid
== MBIM_IPS0_VID
)
94 info
->flags
&= ~FLAG_IPS0_VLAN
;
98 static const struct net_device_ops cdc_mbim_netdev_ops
= {
99 .ndo_open
= usbnet_open
,
100 .ndo_stop
= usbnet_stop
,
101 .ndo_start_xmit
= usbnet_start_xmit
,
102 .ndo_tx_timeout
= usbnet_tx_timeout
,
103 .ndo_get_stats64
= usbnet_get_stats64
,
104 .ndo_change_mtu
= cdc_ncm_change_mtu
,
105 .ndo_set_mac_address
= eth_mac_addr
,
106 .ndo_validate_addr
= eth_validate_addr
,
107 .ndo_vlan_rx_add_vid
= cdc_mbim_rx_add_vid
,
108 .ndo_vlan_rx_kill_vid
= cdc_mbim_rx_kill_vid
,
111 /* Change the control interface altsetting and update the .driver_info
112 * pointer if the matching entry after changing class codes points to
115 static int cdc_mbim_set_ctrlalt(struct usbnet
*dev
, struct usb_interface
*intf
, u8 alt
)
117 struct usb_driver
*driver
= to_usb_driver(intf
->dev
.driver
);
118 const struct usb_device_id
*id
;
119 struct driver_info
*info
;
122 ret
= usb_set_interface(dev
->udev
,
123 intf
->cur_altsetting
->desc
.bInterfaceNumber
,
128 id
= usb_match_id(intf
, driver
->id_table
);
132 info
= (struct driver_info
*)id
->driver_info
;
133 if (info
!= dev
->driver_info
) {
134 dev_dbg(&intf
->dev
, "driver_info updated to '%s'\n",
136 dev
->driver_info
= info
;
141 static int cdc_mbim_bind(struct usbnet
*dev
, struct usb_interface
*intf
)
143 struct cdc_ncm_ctx
*ctx
;
144 struct usb_driver
*subdriver
= ERR_PTR(-ENODEV
);
146 u8 data_altsetting
= 1;
147 struct cdc_mbim_state
*info
= (void *)&dev
->data
;
149 /* should we change control altsetting on a NCM/MBIM function? */
150 if (cdc_ncm_select_altsetting(intf
) == CDC_NCM_COMM_ALTSETTING_MBIM
) {
151 data_altsetting
= CDC_NCM_DATA_ALTSETTING_MBIM
;
152 ret
= cdc_mbim_set_ctrlalt(dev
, intf
, CDC_NCM_COMM_ALTSETTING_MBIM
);
158 /* we will hit this for NCM/MBIM functions if prefer_mbim is false */
159 if (!cdc_ncm_comm_intf_is_mbim(intf
->cur_altsetting
))
162 ret
= cdc_ncm_bind_common(dev
, intf
, data_altsetting
, dev
->driver_info
->data
);
168 /* The MBIM descriptor and the status endpoint are required */
169 if (ctx
->mbim_desc
&& dev
->status
)
170 subdriver
= usb_cdc_wdm_register(ctx
->control
,
172 le16_to_cpu(ctx
->mbim_desc
->wMaxControlMessage
),
173 cdc_mbim_wdm_manage_power
);
174 if (IS_ERR(subdriver
)) {
175 ret
= PTR_ERR(subdriver
);
176 cdc_ncm_unbind(dev
, intf
);
180 /* can't let usbnet use the interrupt endpoint */
182 info
->subdriver
= subdriver
;
184 /* MBIM cannot do ARP */
185 dev
->net
->flags
|= IFF_NOARP
;
187 /* no need to put the VLAN tci in the packet headers */
188 dev
->net
->features
|= NETIF_F_HW_VLAN_CTAG_TX
| NETIF_F_HW_VLAN_CTAG_FILTER
;
190 /* monitor VLAN additions and removals */
191 dev
->net
->netdev_ops
= &cdc_mbim_netdev_ops
;
196 static void cdc_mbim_unbind(struct usbnet
*dev
, struct usb_interface
*intf
)
198 struct cdc_mbim_state
*info
= (void *)&dev
->data
;
199 struct cdc_ncm_ctx
*ctx
= info
->ctx
;
201 /* disconnect subdriver from control interface */
202 if (info
->subdriver
&& info
->subdriver
->disconnect
)
203 info
->subdriver
->disconnect(ctx
->control
);
204 info
->subdriver
= NULL
;
206 /* let NCM unbind clean up both control and data interface */
207 cdc_ncm_unbind(dev
, intf
);
210 /* verify that the ethernet protocol is IPv4 or IPv6 */
211 static bool is_ip_proto(__be16 proto
)
214 case htons(ETH_P_IP
):
215 case htons(ETH_P_IPV6
):
221 static struct sk_buff
*cdc_mbim_tx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
, gfp_t flags
)
223 struct sk_buff
*skb_out
;
224 struct cdc_mbim_state
*info
= (void *)&dev
->data
;
225 struct cdc_ncm_ctx
*ctx
= info
->ctx
;
226 __le32 sign
= cpu_to_le32(USB_CDC_MBIM_NDP16_IPS_SIGN
);
235 if (skb
->len
<= ETH_HLEN
)
238 /* Some applications using e.g. packet sockets will
239 * bypass the VLAN acceleration and create tagged
240 * ethernet frames directly. We primarily look for
241 * the accelerated out-of-band tag, but fall back if
244 skb_reset_mac_header(skb
);
245 if (vlan_get_tag(skb
, &tci
) < 0 && skb
->len
> VLAN_ETH_HLEN
&&
246 __vlan_get_tag(skb
, &tci
) == 0) {
247 is_ip
= is_ip_proto(vlan_eth_hdr(skb
)->h_vlan_encapsulated_proto
);
248 skb_pull(skb
, VLAN_ETH_HLEN
);
250 is_ip
= is_ip_proto(eth_hdr(skb
)->h_proto
);
251 skb_pull(skb
, ETH_HLEN
);
254 /* Is IP session <0> tagged too? */
255 if (info
->flags
& FLAG_IPS0_VLAN
) {
256 /* drop all untagged packets */
259 /* map MBIM_IPS0_VID to IPS<0> */
260 if (tci
== MBIM_IPS0_VID
)
264 /* mapping VLANs to MBIM sessions:
265 * no tag => IPS session <0> if !FLAG_IPS0_VLAN
266 * 1 - 255 => IPS session <vlanid>
267 * 256 - 511 => DSS session <vlanid - 256>
268 * 512 - 4093 => unsupported, drop
269 * 4094 => IPS session <0> if FLAG_IPS0_VLAN
272 switch (tci
& 0x0f00) {
273 case 0x0000: /* VLAN ID 0 - 255 */
279 case 0x0100: /* VLAN ID 256 - 511 */
282 sign
= cpu_to_le32(USB_CDC_MBIM_NDP16_DSS_SIGN
);
287 netif_err(dev
, tx_err
, dev
->net
,
288 "unsupported tci=0x%04x\n", tci
);
293 spin_lock_bh(&ctx
->mtx
);
294 skb_out
= cdc_ncm_fill_tx_frame(dev
, skb
, sign
);
295 spin_unlock_bh(&ctx
->mtx
);
300 dev_kfree_skb_any(skb
);
305 /* Some devices are known to send Neigbor Solicitation messages and
306 * require Neigbor Advertisement replies. The IPv6 core will not
307 * respond since IFF_NOARP is set, so we must handle them ourselves.
309 static void do_neigh_solicit(struct usbnet
*dev
, u8
*buf
, u16 tci
)
311 struct ipv6hdr
*iph
= (void *)buf
;
312 struct nd_msg
*msg
= (void *)(iph
+ 1);
313 struct net_device
*netdev
;
314 struct inet6_dev
*in6_dev
;
317 /* we'll only respond to requests from unicast addresses to
318 * our solicited node addresses.
320 if (!ipv6_addr_is_solict_mult(&iph
->daddr
) ||
321 !(ipv6_addr_type(&iph
->saddr
) & IPV6_ADDR_UNICAST
))
324 /* need to send the NA on the VLAN dev, if any */
327 netdev
= __vlan_find_dev_deep_rcu(dev
->net
, htons(ETH_P_8021Q
),
339 in6_dev
= in6_dev_get(netdev
);
342 is_router
= !!in6_dev
->cnf
.forwarding
;
343 in6_dev_put(in6_dev
);
345 /* ipv6_stub != NULL if in6_dev_get returned an inet6_dev */
346 ipv6_stub
->ndisc_send_na(netdev
, &iph
->saddr
, &msg
->target
,
347 is_router
/* router */,
348 true /* solicited */,
349 false /* override */,
355 static bool is_neigh_solicit(u8
*buf
, size_t len
)
357 struct ipv6hdr
*iph
= (void *)buf
;
358 struct nd_msg
*msg
= (void *)(iph
+ 1);
360 return (len
>= sizeof(struct ipv6hdr
) + sizeof(struct nd_msg
) &&
361 iph
->nexthdr
== IPPROTO_ICMPV6
&&
362 msg
->icmph
.icmp6_code
== 0 &&
363 msg
->icmph
.icmp6_type
== NDISC_NEIGHBOUR_SOLICITATION
);
367 static struct sk_buff
*cdc_mbim_process_dgram(struct usbnet
*dev
, u8
*buf
, size_t len
, u16 tci
)
369 __be16 proto
= htons(ETH_P_802_3
);
370 struct sk_buff
*skb
= NULL
;
372 if (tci
< 256 || tci
== MBIM_IPS0_VID
) { /* IPS session? */
373 if (len
< sizeof(struct iphdr
))
376 switch (*buf
& 0xf0) {
378 proto
= htons(ETH_P_IP
);
381 if (is_neigh_solicit(buf
, len
))
382 do_neigh_solicit(dev
, buf
, tci
);
383 proto
= htons(ETH_P_IPV6
);
390 skb
= netdev_alloc_skb_ip_align(dev
->net
, len
+ ETH_HLEN
);
394 /* add an ethernet header */
395 skb_put(skb
, ETH_HLEN
);
396 skb_reset_mac_header(skb
);
397 eth_hdr(skb
)->h_proto
= proto
;
398 eth_zero_addr(eth_hdr(skb
)->h_source
);
399 memcpy(eth_hdr(skb
)->h_dest
, dev
->net
->dev_addr
, ETH_ALEN
);
402 skb_put_data(skb
, buf
, len
);
404 /* map MBIM session to VLAN */
406 __vlan_hwaccel_put_tag(skb
, htons(ETH_P_8021Q
), tci
);
411 static int cdc_mbim_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb_in
)
414 struct cdc_mbim_state
*info
= (void *)&dev
->data
;
415 struct cdc_ncm_ctx
*ctx
= info
->ctx
;
420 struct usb_cdc_ncm_ndp16
*ndp16
;
421 struct usb_cdc_ncm_dpe16
*dpe16
;
423 int loopcount
= 50; /* arbitrary max preventing infinite loop */
428 ndpoffset
= cdc_ncm_rx_verify_nth16(ctx
, skb_in
);
433 nframes
= cdc_ncm_rx_verify_ndp16(skb_in
, ndpoffset
);
437 ndp16
= (struct usb_cdc_ncm_ndp16
*)(skb_in
->data
+ ndpoffset
);
439 switch (ndp16
->dwSignature
& cpu_to_le32(0x00ffffff)) {
440 case cpu_to_le32(USB_CDC_MBIM_NDP16_IPS_SIGN
):
441 c
= (u8
*)&ndp16
->dwSignature
;
443 /* tag IPS<0> packets too if MBIM_IPS0_VID exists */
444 if (!tci
&& info
->flags
& FLAG_IPS0_VLAN
)
447 case cpu_to_le32(USB_CDC_MBIM_NDP16_DSS_SIGN
):
448 c
= (u8
*)&ndp16
->dwSignature
;
452 netif_dbg(dev
, rx_err
, dev
->net
,
453 "unsupported NDP signature <0x%08x>\n",
454 le32_to_cpu(ndp16
->dwSignature
));
459 dpe16
= ndp16
->dpe16
;
460 for (x
= 0; x
< nframes
; x
++, dpe16
++) {
461 offset
= le16_to_cpu(dpe16
->wDatagramIndex
);
462 len
= le16_to_cpu(dpe16
->wDatagramLength
);
466 * All entries after first NULL entry are to be ignored
468 if ((offset
== 0) || (len
== 0)) {
470 goto err_ndp
; /* empty NTB */
474 /* sanity checking */
475 if (((offset
+ len
) > skb_in
->len
) || (len
> ctx
->rx_max
)) {
476 netif_dbg(dev
, rx_err
, dev
->net
,
477 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
478 x
, offset
, len
, skb_in
);
483 skb
= cdc_mbim_process_dgram(dev
, skb_in
->data
+ offset
, len
, tci
);
486 usbnet_skb_return(dev
, skb
);
487 payload
+= len
; /* count payload bytes in this NTB */
491 /* are there more NDPs to process? */
492 ndpoffset
= le16_to_cpu(ndp16
->wNextNdpIndex
);
493 if (ndpoffset
&& loopcount
--)
497 ctx
->rx_overhead
+= skb_in
->len
- payload
;
505 static int cdc_mbim_suspend(struct usb_interface
*intf
, pm_message_t message
)
508 struct usbnet
*dev
= usb_get_intfdata(intf
);
509 struct cdc_mbim_state
*info
= (void *)&dev
->data
;
510 struct cdc_ncm_ctx
*ctx
= info
->ctx
;
516 * Both usbnet_suspend() and subdriver->suspend() MUST return 0
517 * in system sleep context, otherwise, the resume callback has
518 * to recover device from previous suspend failure.
520 ret
= usbnet_suspend(intf
, message
);
524 if (intf
== ctx
->control
&& info
->subdriver
&& info
->subdriver
->suspend
)
525 ret
= info
->subdriver
->suspend(intf
, message
);
533 static int cdc_mbim_resume(struct usb_interface
*intf
)
536 struct usbnet
*dev
= usb_get_intfdata(intf
);
537 struct cdc_mbim_state
*info
= (void *)&dev
->data
;
538 struct cdc_ncm_ctx
*ctx
= info
->ctx
;
539 bool callsub
= (intf
== ctx
->control
&& info
->subdriver
&& info
->subdriver
->resume
);
542 ret
= info
->subdriver
->resume(intf
);
545 ret
= usbnet_resume(intf
);
546 if (ret
< 0 && callsub
)
547 info
->subdriver
->suspend(intf
, PMSG_SUSPEND
);
552 static const struct driver_info cdc_mbim_info
= {
553 .description
= "CDC MBIM",
554 .flags
= FLAG_NO_SETINT
| FLAG_MULTI_PACKET
| FLAG_WWAN
,
555 .bind
= cdc_mbim_bind
,
556 .unbind
= cdc_mbim_unbind
,
557 .manage_power
= cdc_mbim_manage_power
,
558 .rx_fixup
= cdc_mbim_rx_fixup
,
559 .tx_fixup
= cdc_mbim_tx_fixup
,
562 /* MBIM and NCM devices should not need a ZLP after NTBs with
563 * dwNtbOutMaxSize length. Nevertheless, a number of devices from
564 * different vendor IDs will fail unless we send ZLPs, forcing us
565 * to make this the default.
567 * This default may cause a performance penalty for spec conforming
568 * devices wanting to take advantage of optimizations possible without
569 * ZLPs. A whitelist is added in an attempt to avoid this for devices
570 * known to conform to the MBIM specification.
572 * All known devices supporting NCM compatibility mode are also
573 * conforming to the NCM and MBIM specifications. For this reason, the
574 * NCM subclass entry is also in the ZLP whitelist.
576 static const struct driver_info cdc_mbim_info_zlp
= {
577 .description
= "CDC MBIM",
578 .flags
= FLAG_NO_SETINT
| FLAG_MULTI_PACKET
| FLAG_WWAN
| FLAG_SEND_ZLP
,
579 .bind
= cdc_mbim_bind
,
580 .unbind
= cdc_mbim_unbind
,
581 .manage_power
= cdc_mbim_manage_power
,
582 .rx_fixup
= cdc_mbim_rx_fixup
,
583 .tx_fixup
= cdc_mbim_tx_fixup
,
586 /* The spefication explicitly allows NDPs to be placed anywhere in the
587 * frame, but some devices fail unless the NDP is placed after the IP
588 * packets. Using the CDC_NCM_FLAG_NDP_TO_END flags to force this
591 * Note: The current implementation of this feature restricts each NTB
592 * to a single NDP, implying that multiplexed sessions cannot share an
593 * NTB. This might affect performace for multiplexed sessions.
595 static const struct driver_info cdc_mbim_info_ndp_to_end
= {
596 .description
= "CDC MBIM",
597 .flags
= FLAG_NO_SETINT
| FLAG_MULTI_PACKET
| FLAG_WWAN
,
598 .bind
= cdc_mbim_bind
,
599 .unbind
= cdc_mbim_unbind
,
600 .manage_power
= cdc_mbim_manage_power
,
601 .rx_fixup
= cdc_mbim_rx_fixup
,
602 .tx_fixup
= cdc_mbim_tx_fixup
,
603 .data
= CDC_NCM_FLAG_NDP_TO_END
,
606 /* Some modems (e.g. Telit LE922A6) do not work properly with altsetting
607 * toggle done in cdc_ncm_bind_common. CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE
608 * flag is used to avoid this procedure.
610 static const struct driver_info cdc_mbim_info_avoid_altsetting_toggle
= {
611 .description
= "CDC MBIM",
612 .flags
= FLAG_NO_SETINT
| FLAG_MULTI_PACKET
| FLAG_WWAN
,
613 .bind
= cdc_mbim_bind
,
614 .unbind
= cdc_mbim_unbind
,
615 .manage_power
= cdc_mbim_manage_power
,
616 .rx_fixup
= cdc_mbim_rx_fixup
,
617 .tx_fixup
= cdc_mbim_tx_fixup
,
618 .data
= CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE
,
621 static const struct usb_device_id mbim_devs
[] = {
622 /* This duplicate NCM entry is intentional. MBIM devices can
623 * be disguised as NCM by default, and this is necessary to
624 * allow us to bind the correct driver_info to such devices.
626 * bind() will sort out this for us, selecting the correct
627 * entry and reject the other
629 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_NCM
, USB_CDC_PROTO_NONE
),
630 .driver_info
= (unsigned long)&cdc_mbim_info
,
632 /* ZLP conformance whitelist: All Ericsson MBIM devices */
633 { USB_VENDOR_AND_INTERFACE_INFO(0x0bdb, USB_CLASS_COMM
, USB_CDC_SUBCLASS_MBIM
, USB_CDC_PROTO_NONE
),
634 .driver_info
= (unsigned long)&cdc_mbim_info
,
637 /* Some Huawei devices, ME906s-158 (12d1:15c1) and E3372
638 * (12d1:157d), are known to fail unless the NDP is placed
639 * after the IP packets. Applying the quirk to all Huawei
640 * devices is broader than necessary, but harmless.
642 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1, USB_CLASS_COMM
, USB_CDC_SUBCLASS_MBIM
, USB_CDC_PROTO_NONE
),
643 .driver_info
= (unsigned long)&cdc_mbim_info_ndp_to_end
,
646 /* The HP lt4132 (03f0:a31d) is a rebranded Huawei ME906s-158,
647 * therefore it too requires the above "NDP to end" quirk.
649 { USB_DEVICE_AND_INTERFACE_INFO(0x03f0, 0xa31d, USB_CLASS_COMM
, USB_CDC_SUBCLASS_MBIM
, USB_CDC_PROTO_NONE
),
650 .driver_info
= (unsigned long)&cdc_mbim_info_ndp_to_end
,
653 /* Telit LE922A6 in MBIM composition */
654 { USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x1041, USB_CLASS_COMM
, USB_CDC_SUBCLASS_MBIM
, USB_CDC_PROTO_NONE
),
655 .driver_info
= (unsigned long)&cdc_mbim_info_avoid_altsetting_toggle
,
659 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_MBIM
, USB_CDC_PROTO_NONE
),
660 .driver_info
= (unsigned long)&cdc_mbim_info_zlp
,
665 MODULE_DEVICE_TABLE(usb
, mbim_devs
);
667 static struct usb_driver cdc_mbim_driver
= {
669 .id_table
= mbim_devs
,
670 .probe
= usbnet_probe
,
671 .disconnect
= usbnet_disconnect
,
672 .suspend
= cdc_mbim_suspend
,
673 .resume
= cdc_mbim_resume
,
674 .reset_resume
= cdc_mbim_resume
,
675 .supports_autosuspend
= 1,
676 .disable_hub_initiated_lpm
= 1,
678 module_usb_driver(cdc_mbim_driver
);
680 MODULE_AUTHOR("Greg Suarez <gsuarez@smithmicro.com>");
681 MODULE_AUTHOR("Bjørn Mork <bjorn@mork.no>");
682 MODULE_DESCRIPTION("USB CDC MBIM host driver");
683 MODULE_LICENSE("GPL");