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_change_mtu = usbnet_change_mtu,
104 .ndo_set_mac_address = eth_mac_addr,
105 .ndo_validate_addr = eth_validate_addr,
106 .ndo_vlan_rx_add_vid = cdc_mbim_rx_add_vid,
107 .ndo_vlan_rx_kill_vid = cdc_mbim_rx_kill_vid,
110 /* Change the control interface altsetting and update the .driver_info
111 * pointer if the matching entry after changing class codes points to
114 static int cdc_mbim_set_ctrlalt(struct usbnet *dev, struct usb_interface *intf, u8 alt)
116 struct usb_driver *driver = to_usb_driver(intf->dev.driver);
117 const struct usb_device_id *id;
118 struct driver_info *info;
121 ret = usb_set_interface(dev->udev,
122 intf->cur_altsetting->desc.bInterfaceNumber,
127 id = usb_match_id(intf, driver->id_table);
131 info = (struct driver_info *)id->driver_info;
132 if (info != dev->driver_info) {
133 dev_dbg(&intf->dev, "driver_info updated to '%s'\n",
135 dev->driver_info = info;
140 static int cdc_mbim_bind(struct usbnet *dev, struct usb_interface *intf)
142 struct cdc_ncm_ctx *ctx;
143 struct usb_driver *subdriver = ERR_PTR(-ENODEV);
145 u8 data_altsetting = 1;
146 struct cdc_mbim_state *info = (void *)&dev->data;
148 /* should we change control altsetting on a NCM/MBIM function? */
149 if (cdc_ncm_select_altsetting(intf) == CDC_NCM_COMM_ALTSETTING_MBIM) {
150 data_altsetting = CDC_NCM_DATA_ALTSETTING_MBIM;
151 ret = cdc_mbim_set_ctrlalt(dev, intf, CDC_NCM_COMM_ALTSETTING_MBIM);
157 /* we will hit this for NCM/MBIM functions if prefer_mbim is false */
158 if (!cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting))
161 ret = cdc_ncm_bind_common(dev, intf, data_altsetting);
167 /* The MBIM descriptor and the status endpoint are required */
168 if (ctx->mbim_desc && dev->status)
169 subdriver = usb_cdc_wdm_register(ctx->control,
171 le16_to_cpu(ctx->mbim_desc->wMaxControlMessage),
172 cdc_mbim_wdm_manage_power);
173 if (IS_ERR(subdriver)) {
174 ret = PTR_ERR(subdriver);
175 cdc_ncm_unbind(dev, intf);
179 /* can't let usbnet use the interrupt endpoint */
181 info->subdriver = subdriver;
183 /* MBIM cannot do ARP */
184 dev->net->flags |= IFF_NOARP;
186 /* no need to put the VLAN tci in the packet headers */
187 dev->net->features |= NETIF_F_HW_VLAN_CTAG_TX | NETIF_F_HW_VLAN_CTAG_FILTER;
189 /* monitor VLAN additions and removals */
190 dev->net->netdev_ops = &cdc_mbim_netdev_ops;
195 static void cdc_mbim_unbind(struct usbnet *dev, struct usb_interface *intf)
197 struct cdc_mbim_state *info = (void *)&dev->data;
198 struct cdc_ncm_ctx *ctx = info->ctx;
200 /* disconnect subdriver from control interface */
201 if (info->subdriver && info->subdriver->disconnect)
202 info->subdriver->disconnect(ctx->control);
203 info->subdriver = NULL;
205 /* let NCM unbind clean up both control and data interface */
206 cdc_ncm_unbind(dev, intf);
209 /* verify that the ethernet protocol is IPv4 or IPv6 */
210 static bool is_ip_proto(__be16 proto)
213 case htons(ETH_P_IP):
214 case htons(ETH_P_IPV6):
220 static struct sk_buff *cdc_mbim_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
222 struct sk_buff *skb_out;
223 struct cdc_mbim_state *info = (void *)&dev->data;
224 struct cdc_ncm_ctx *ctx = info->ctx;
225 __le32 sign = cpu_to_le32(USB_CDC_MBIM_NDP16_IPS_SIGN);
234 if (skb->len <= ETH_HLEN)
237 /* Some applications using e.g. packet sockets will
238 * bypass the VLAN acceleration and create tagged
239 * ethernet frames directly. We primarily look for
240 * the accelerated out-of-band tag, but fall back if
243 skb_reset_mac_header(skb);
244 if (vlan_get_tag(skb, &tci) < 0 && skb->len > VLAN_ETH_HLEN &&
245 __vlan_get_tag(skb, &tci) == 0) {
246 is_ip = is_ip_proto(vlan_eth_hdr(skb)->h_vlan_encapsulated_proto);
247 skb_pull(skb, VLAN_ETH_HLEN);
249 is_ip = is_ip_proto(eth_hdr(skb)->h_proto);
250 skb_pull(skb, ETH_HLEN);
253 /* Is IP session <0> tagged too? */
254 if (info->flags & FLAG_IPS0_VLAN) {
255 /* drop all untagged packets */
258 /* map MBIM_IPS0_VID to IPS<0> */
259 if (tci == MBIM_IPS0_VID)
263 /* mapping VLANs to MBIM sessions:
264 * no tag => IPS session <0> if !FLAG_IPS0_VLAN
265 * 1 - 255 => IPS session <vlanid>
266 * 256 - 511 => DSS session <vlanid - 256>
267 * 512 - 4093 => unsupported, drop
268 * 4094 => IPS session <0> if FLAG_IPS0_VLAN
271 switch (tci & 0x0f00) {
272 case 0x0000: /* VLAN ID 0 - 255 */
278 case 0x0100: /* VLAN ID 256 - 511 */
281 sign = cpu_to_le32(USB_CDC_MBIM_NDP16_DSS_SIGN);
286 netif_err(dev, tx_err, dev->net,
287 "unsupported tci=0x%04x\n", tci);
292 spin_lock_bh(&ctx->mtx);
293 skb_out = cdc_ncm_fill_tx_frame(dev, skb, sign);
294 spin_unlock_bh(&ctx->mtx);
299 dev_kfree_skb_any(skb);
304 /* Some devices are known to send Neigbor Solicitation messages and
305 * require Neigbor Advertisement replies. The IPv6 core will not
306 * respond since IFF_NOARP is set, so we must handle them ourselves.
308 static void do_neigh_solicit(struct usbnet *dev, u8 *buf, u16 tci)
310 struct ipv6hdr *iph = (void *)buf;
311 struct nd_msg *msg = (void *)(iph + 1);
312 struct net_device *netdev;
313 struct inet6_dev *in6_dev;
316 /* we'll only respond to requests from unicast addresses to
317 * our solicited node addresses.
319 if (!ipv6_addr_is_solict_mult(&iph->daddr) ||
320 !(ipv6_addr_type(&iph->saddr) & IPV6_ADDR_UNICAST))
323 /* need to send the NA on the VLAN dev, if any */
326 netdev = __vlan_find_dev_deep_rcu(dev->net, htons(ETH_P_8021Q),
338 in6_dev = in6_dev_get(netdev);
341 is_router = !!in6_dev->cnf.forwarding;
342 in6_dev_put(in6_dev);
344 /* ipv6_stub != NULL if in6_dev_get returned an inet6_dev */
345 ipv6_stub->ndisc_send_na(netdev, NULL, &iph->saddr, &msg->target,
346 is_router /* router */,
347 true /* solicited */,
348 false /* override */,
354 static bool is_neigh_solicit(u8 *buf, size_t len)
356 struct ipv6hdr *iph = (void *)buf;
357 struct nd_msg *msg = (void *)(iph + 1);
359 return (len >= sizeof(struct ipv6hdr) + sizeof(struct nd_msg) &&
360 iph->nexthdr == IPPROTO_ICMPV6 &&
361 msg->icmph.icmp6_code == 0 &&
362 msg->icmph.icmp6_type == NDISC_NEIGHBOUR_SOLICITATION);
366 static struct sk_buff *cdc_mbim_process_dgram(struct usbnet *dev, u8 *buf, size_t len, u16 tci)
368 __be16 proto = htons(ETH_P_802_3);
369 struct sk_buff *skb = NULL;
371 if (tci < 256 || tci == MBIM_IPS0_VID) { /* IPS session? */
372 if (len < sizeof(struct iphdr))
375 switch (*buf & 0xf0) {
377 proto = htons(ETH_P_IP);
380 if (is_neigh_solicit(buf, len))
381 do_neigh_solicit(dev, buf, tci);
382 proto = htons(ETH_P_IPV6);
389 skb = netdev_alloc_skb_ip_align(dev->net, len + ETH_HLEN);
393 /* add an ethernet header */
394 skb_put(skb, ETH_HLEN);
395 skb_reset_mac_header(skb);
396 eth_hdr(skb)->h_proto = proto;
397 memset(eth_hdr(skb)->h_source, 0, ETH_ALEN);
398 memcpy(eth_hdr(skb)->h_dest, dev->net->dev_addr, ETH_ALEN);
401 memcpy(skb_put(skb, len), buf, len);
403 /* map MBIM session to VLAN */
405 vlan_put_tag(skb, htons(ETH_P_8021Q), tci);
410 static int cdc_mbim_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
413 struct cdc_mbim_state *info = (void *)&dev->data;
414 struct cdc_ncm_ctx *ctx = info->ctx;
419 struct usb_cdc_ncm_ndp16 *ndp16;
420 struct usb_cdc_ncm_dpe16 *dpe16;
422 int loopcount = 50; /* arbitrary max preventing infinite loop */
426 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
431 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
435 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
437 switch (ndp16->dwSignature & cpu_to_le32(0x00ffffff)) {
438 case cpu_to_le32(USB_CDC_MBIM_NDP16_IPS_SIGN):
439 c = (u8 *)&ndp16->dwSignature;
441 /* tag IPS<0> packets too if MBIM_IPS0_VID exists */
442 if (!tci && info->flags & FLAG_IPS0_VLAN)
445 case cpu_to_le32(USB_CDC_MBIM_NDP16_DSS_SIGN):
446 c = (u8 *)&ndp16->dwSignature;
450 netif_dbg(dev, rx_err, dev->net,
451 "unsupported NDP signature <0x%08x>\n",
452 le32_to_cpu(ndp16->dwSignature));
457 dpe16 = ndp16->dpe16;
458 for (x = 0; x < nframes; x++, dpe16++) {
459 offset = le16_to_cpu(dpe16->wDatagramIndex);
460 len = le16_to_cpu(dpe16->wDatagramLength);
464 * All entries after first NULL entry are to be ignored
466 if ((offset == 0) || (len == 0)) {
468 goto err_ndp; /* empty NTB */
472 /* sanity checking */
473 if (((offset + len) > skb_in->len) || (len > ctx->rx_max)) {
474 netif_dbg(dev, rx_err, dev->net,
475 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
476 x, offset, len, skb_in);
481 skb = cdc_mbim_process_dgram(dev, skb_in->data + offset, len, tci);
484 usbnet_skb_return(dev, skb);
488 /* are there more NDPs to process? */
489 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
490 if (ndpoffset && loopcount--)
498 static int cdc_mbim_suspend(struct usb_interface *intf, pm_message_t message)
501 struct usbnet *dev = usb_get_intfdata(intf);
502 struct cdc_mbim_state *info = (void *)&dev->data;
503 struct cdc_ncm_ctx *ctx = info->ctx;
509 * Both usbnet_suspend() and subdriver->suspend() MUST return 0
510 * in system sleep context, otherwise, the resume callback has
511 * to recover device from previous suspend failure.
513 ret = usbnet_suspend(intf, message);
517 if (intf == ctx->control && info->subdriver && info->subdriver->suspend)
518 ret = info->subdriver->suspend(intf, message);
526 static int cdc_mbim_resume(struct usb_interface *intf)
529 struct usbnet *dev = usb_get_intfdata(intf);
530 struct cdc_mbim_state *info = (void *)&dev->data;
531 struct cdc_ncm_ctx *ctx = info->ctx;
532 bool callsub = (intf == ctx->control && info->subdriver && info->subdriver->resume);
535 ret = info->subdriver->resume(intf);
538 ret = usbnet_resume(intf);
539 if (ret < 0 && callsub)
540 info->subdriver->suspend(intf, PMSG_SUSPEND);
545 static const struct driver_info cdc_mbim_info = {
546 .description = "CDC MBIM",
547 .flags = FLAG_NO_SETINT | FLAG_MULTI_PACKET | FLAG_WWAN,
548 .bind = cdc_mbim_bind,
549 .unbind = cdc_mbim_unbind,
550 .manage_power = cdc_mbim_manage_power,
551 .rx_fixup = cdc_mbim_rx_fixup,
552 .tx_fixup = cdc_mbim_tx_fixup,
555 /* MBIM and NCM devices should not need a ZLP after NTBs with
556 * dwNtbOutMaxSize length. Nevertheless, a number of devices from
557 * different vendor IDs will fail unless we send ZLPs, forcing us
558 * to make this the default.
560 * This default may cause a performance penalty for spec conforming
561 * devices wanting to take advantage of optimizations possible without
562 * ZLPs. A whitelist is added in an attempt to avoid this for devices
563 * known to conform to the MBIM specification.
565 * All known devices supporting NCM compatibility mode are also
566 * conforming to the NCM and MBIM specifications. For this reason, the
567 * NCM subclass entry is also in the ZLP whitelist.
569 static const struct driver_info cdc_mbim_info_zlp = {
570 .description = "CDC MBIM",
571 .flags = FLAG_NO_SETINT | FLAG_MULTI_PACKET | FLAG_WWAN | FLAG_SEND_ZLP,
572 .bind = cdc_mbim_bind,
573 .unbind = cdc_mbim_unbind,
574 .manage_power = cdc_mbim_manage_power,
575 .rx_fixup = cdc_mbim_rx_fixup,
576 .tx_fixup = cdc_mbim_tx_fixup,
579 static const struct usb_device_id mbim_devs[] = {
580 /* This duplicate NCM entry is intentional. MBIM devices can
581 * be disguised as NCM by default, and this is necessary to
582 * allow us to bind the correct driver_info to such devices.
584 * bind() will sort out this for us, selecting the correct
585 * entry and reject the other
587 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
588 .driver_info = (unsigned long)&cdc_mbim_info,
590 /* ZLP conformance whitelist: All Ericsson MBIM devices */
591 { USB_VENDOR_AND_INTERFACE_INFO(0x0bdb, USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE),
592 .driver_info = (unsigned long)&cdc_mbim_info,
595 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE),
596 .driver_info = (unsigned long)&cdc_mbim_info_zlp,
601 MODULE_DEVICE_TABLE(usb, mbim_devs);
603 static struct usb_driver cdc_mbim_driver = {
605 .id_table = mbim_devs,
606 .probe = usbnet_probe,
607 .disconnect = usbnet_disconnect,
608 .suspend = cdc_mbim_suspend,
609 .resume = cdc_mbim_resume,
610 .reset_resume = cdc_mbim_resume,
611 .supports_autosuspend = 1,
612 .disable_hub_initiated_lpm = 1,
614 module_usb_driver(cdc_mbim_driver);
616 MODULE_AUTHOR("Greg Suarez <gsuarez@smithmicro.com>");
617 MODULE_AUTHOR("Bjørn Mork <bjorn@mork.no>");
618 MODULE_DESCRIPTION("USB CDC MBIM host driver");
619 MODULE_LICENSE("GPL");