xref: /linux/drivers/net/usb/cdc_mbim.c (revision 4ce06406958b67fdddcc2e6948237dd6ff6ba112)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (c) 2012  Smith Micro Software, Inc.
4  * Copyright (c) 2012  Bjørn Mork <bjorn@mork.no>
5  *
6  * This driver is based on and reuse most of cdc_ncm, which is
7  * Copyright (C) ST-Ericsson 2010-2012
8  */
9 
10 #include <linux/module.h>
11 #include <linux/netdevice.h>
12 #include <linux/ethtool.h>
13 #include <linux/if_vlan.h>
14 #include <linux/ip.h>
15 #include <linux/mii.h>
16 #include <linux/usb.h>
17 #include <linux/usb/cdc.h>
18 #include <linux/usb/usbnet.h>
19 #include <linux/usb/cdc-wdm.h>
20 #include <linux/usb/cdc_ncm.h>
21 #include <net/ipv6.h>
22 #include <net/addrconf.h>
23 #include <net/ndisc.h>
24 
25 /* alternative VLAN for IP session 0 if not untagged */
26 #define MBIM_IPS0_VID	4094
27 
28 /* driver specific data - must match cdc_ncm usage */
29 struct cdc_mbim_state {
30 	struct cdc_ncm_ctx *ctx;
31 	atomic_t pmcount;
32 	struct usb_driver *subdriver;
33 	unsigned long _unused;
34 	unsigned long flags;
35 };
36 
37 /* flags for the cdc_mbim_state.flags field */
38 enum cdc_mbim_flags {
39 	FLAG_IPS0_VLAN = 1 << 0,	/* IP session 0 is tagged  */
40 };
41 
42 /* using a counter to merge subdriver requests with our own into a combined state */
43 static int cdc_mbim_manage_power(struct usbnet *dev, int on)
44 {
45 	struct cdc_mbim_state *info = (void *)&dev->data;
46 	int rv = 0;
47 
48 	dev_dbg(&dev->intf->dev, "%s() pmcount=%d, on=%d\n", __func__, atomic_read(&info->pmcount), on);
49 
50 	if ((on && atomic_add_return(1, &info->pmcount) == 1) || (!on && atomic_dec_and_test(&info->pmcount))) {
51 		/* need autopm_get/put here to ensure the usbcore sees the new value */
52 		rv = usb_autopm_get_interface(dev->intf);
53 		dev->intf->needs_remote_wakeup = on;
54 		if (!rv)
55 			usb_autopm_put_interface(dev->intf);
56 	}
57 	return 0;
58 }
59 
60 static int cdc_mbim_wdm_manage_power(struct usb_interface *intf, int status)
61 {
62 	struct usbnet *dev = usb_get_intfdata(intf);
63 
64 	/* can be called while disconnecting */
65 	if (!dev)
66 		return 0;
67 
68 	return cdc_mbim_manage_power(dev, status);
69 }
70 
71 static int cdc_mbim_rx_add_vid(struct net_device *netdev, __be16 proto, u16 vid)
72 {
73 	struct usbnet *dev = netdev_priv(netdev);
74 	struct cdc_mbim_state *info = (void *)&dev->data;
75 
76 	/* creation of this VLAN is a request to tag IP session 0 */
77 	if (vid == MBIM_IPS0_VID)
78 		info->flags |= FLAG_IPS0_VLAN;
79 	else
80 		if (vid >= 512)	/* we don't map these to MBIM session */
81 			return -EINVAL;
82 	return 0;
83 }
84 
85 static int cdc_mbim_rx_kill_vid(struct net_device *netdev, __be16 proto, u16 vid)
86 {
87 	struct usbnet *dev = netdev_priv(netdev);
88 	struct cdc_mbim_state *info = (void *)&dev->data;
89 
90 	/* this is a request for an untagged IP session 0 */
91 	if (vid == MBIM_IPS0_VID)
92 		info->flags &= ~FLAG_IPS0_VLAN;
93 	return 0;
94 }
95 
96 static const struct net_device_ops cdc_mbim_netdev_ops = {
97 	.ndo_open             = usbnet_open,
98 	.ndo_stop             = usbnet_stop,
99 	.ndo_start_xmit       = usbnet_start_xmit,
100 	.ndo_tx_timeout       = usbnet_tx_timeout,
101 	.ndo_get_stats64      = dev_get_tstats64,
102 	.ndo_change_mtu       = cdc_ncm_change_mtu,
103 	.ndo_set_mac_address  = eth_mac_addr,
104 	.ndo_validate_addr    = eth_validate_addr,
105 	.ndo_vlan_rx_add_vid  = cdc_mbim_rx_add_vid,
106 	.ndo_vlan_rx_kill_vid = cdc_mbim_rx_kill_vid,
107 };
108 
109 /* Change the control interface altsetting and update the .driver_info
110  * pointer if the matching entry after changing class codes points to
111  * a different struct
112  */
113 static int cdc_mbim_set_ctrlalt(struct usbnet *dev, struct usb_interface *intf, u8 alt)
114 {
115 	struct usb_driver *driver = to_usb_driver(intf->dev.driver);
116 	const struct usb_device_id *id;
117 	struct driver_info *info;
118 	int ret;
119 
120 	ret = usb_set_interface(dev->udev,
121 				intf->cur_altsetting->desc.bInterfaceNumber,
122 				alt);
123 	if (ret)
124 		return ret;
125 
126 	id = usb_match_id(intf, driver->id_table);
127 	if (!id)
128 		return -ENODEV;
129 
130 	info = (struct driver_info *)id->driver_info;
131 	if (info != dev->driver_info) {
132 		dev_dbg(&intf->dev, "driver_info updated to '%s'\n",
133 			info->description);
134 		dev->driver_info = info;
135 	}
136 	return 0;
137 }
138 
139 static int cdc_mbim_bind(struct usbnet *dev, struct usb_interface *intf)
140 {
141 	struct cdc_ncm_ctx *ctx;
142 	struct usb_driver *subdriver = ERR_PTR(-ENODEV);
143 	int ret = -ENODEV;
144 	u8 data_altsetting = 1;
145 	struct cdc_mbim_state *info = (void *)&dev->data;
146 
147 	/* should we change control altsetting on a NCM/MBIM function? */
148 	if (cdc_ncm_select_altsetting(intf) == CDC_NCM_COMM_ALTSETTING_MBIM) {
149 		data_altsetting = CDC_NCM_DATA_ALTSETTING_MBIM;
150 		ret = cdc_mbim_set_ctrlalt(dev, intf, CDC_NCM_COMM_ALTSETTING_MBIM);
151 		if (ret)
152 			goto err;
153 		ret = -ENODEV;
154 	}
155 
156 	/* we will hit this for NCM/MBIM functions if prefer_mbim is false */
157 	if (!cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting))
158 		goto err;
159 
160 	ret = cdc_ncm_bind_common(dev, intf, data_altsetting, dev->driver_info->data);
161 	if (ret)
162 		goto err;
163 
164 	ctx = info->ctx;
165 
166 	/* The MBIM descriptor and the status endpoint are required */
167 	if (ctx->mbim_desc && dev->status)
168 		subdriver = usb_cdc_wdm_register(ctx->control,
169 						 &dev->status->desc,
170 						 le16_to_cpu(ctx->mbim_desc->wMaxControlMessage),
171 						 WWAN_PORT_MBIM,
172 						 cdc_mbim_wdm_manage_power);
173 	if (IS_ERR(subdriver)) {
174 		ret = PTR_ERR(subdriver);
175 		cdc_ncm_unbind(dev, intf);
176 		goto err;
177 	}
178 
179 	/* can't let usbnet use the interrupt endpoint */
180 	dev->status = NULL;
181 	info->subdriver = subdriver;
182 
183 	/* MBIM cannot do ARP */
184 	dev->net->flags |= IFF_NOARP;
185 
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;
188 
189 	/* monitor VLAN additions and removals */
190 	dev->net->netdev_ops = &cdc_mbim_netdev_ops;
191 err:
192 	return ret;
193 }
194 
195 static void cdc_mbim_unbind(struct usbnet *dev, struct usb_interface *intf)
196 {
197 	struct cdc_mbim_state *info = (void *)&dev->data;
198 	struct cdc_ncm_ctx *ctx = info->ctx;
199 
200 	/* disconnect subdriver from control interface */
201 	if (info->subdriver && info->subdriver->disconnect)
202 		info->subdriver->disconnect(ctx->control);
203 	info->subdriver = NULL;
204 
205 	/* let NCM unbind clean up both control and data interface */
206 	cdc_ncm_unbind(dev, intf);
207 }
208 
209 /* verify that the ethernet protocol is IPv4 or IPv6 */
210 static bool is_ip_proto(__be16 proto)
211 {
212 	switch (proto) {
213 	case htons(ETH_P_IP):
214 	case htons(ETH_P_IPV6):
215 		return true;
216 	}
217 	return false;
218 }
219 
220 static struct sk_buff *cdc_mbim_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
221 {
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);
226 	u16 tci = 0;
227 	bool is_ip;
228 	u8 *c;
229 
230 	if (!ctx)
231 		goto error;
232 
233 	if (skb) {
234 		if (skb->len <= ETH_HLEN)
235 			goto error;
236 
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
241 		 * required
242 		 */
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);
248 		} else {
249 			is_ip = is_ip_proto(eth_hdr(skb)->h_proto);
250 			skb_pull(skb, ETH_HLEN);
251 		}
252 
253 		/* Is IP session <0> tagged too? */
254 		if (info->flags & FLAG_IPS0_VLAN) {
255 			/* drop all untagged packets */
256 			if (!tci)
257 				goto error;
258 			/* map MBIM_IPS0_VID to IPS<0> */
259 			if (tci == MBIM_IPS0_VID)
260 				tci = 0;
261 		}
262 
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
269 		 */
270 
271 		switch (tci & 0x0f00) {
272 		case 0x0000: /* VLAN ID 0 - 255 */
273 			if (!is_ip)
274 				goto error;
275 			c = (u8 *)&sign;
276 			c[3] = tci;
277 			break;
278 		case 0x0100: /* VLAN ID 256 - 511 */
279 			if (is_ip)
280 				goto error;
281 			sign = cpu_to_le32(USB_CDC_MBIM_NDP16_DSS_SIGN);
282 			c = (u8 *)&sign;
283 			c[3] = tci;
284 			break;
285 		default:
286 			netif_err(dev, tx_err, dev->net,
287 				  "unsupported tci=0x%04x\n", tci);
288 			goto error;
289 		}
290 	}
291 
292 	spin_lock_bh(&ctx->mtx);
293 	skb_out = cdc_ncm_fill_tx_frame(dev, skb, sign);
294 	spin_unlock_bh(&ctx->mtx);
295 	return skb_out;
296 
297 error:
298 	if (skb)
299 		dev_kfree_skb_any(skb);
300 
301 	return NULL;
302 }
303 
304 #if IS_ENABLED(CONFIG_IPV6)
305 /* Some devices are known to send Neighbor Solicitation messages and
306  * require Neighbor Advertisement replies.  The IPv6 core will not
307  * respond since IFF_NOARP is set, so we must handle them ourselves.
308  */
309 static void do_neigh_solicit(struct usbnet *dev, u8 *buf, u16 tci)
310 {
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;
315 	bool is_router;
316 
317 	/* we'll only respond to requests from unicast addresses to
318 	 * our solicited node addresses.
319 	 */
320 	if (!ipv6_addr_is_solict_mult(&iph->daddr) ||
321 	    !(ipv6_addr_type(&iph->saddr) & IPV6_ADDR_UNICAST))
322 		return;
323 
324 	/* need to send the NA on the VLAN dev, if any */
325 	rcu_read_lock();
326 	if (tci) {
327 		netdev = __vlan_find_dev_deep_rcu(dev->net, htons(ETH_P_8021Q),
328 						  tci);
329 		if (!netdev) {
330 			rcu_read_unlock();
331 			return;
332 		}
333 	} else {
334 		netdev = dev->net;
335 	}
336 	dev_hold(netdev);
337 	rcu_read_unlock();
338 
339 	in6_dev = in6_dev_get(netdev);
340 	if (!in6_dev)
341 		goto out;
342 	is_router = !!READ_ONCE(in6_dev->cnf.forwarding);
343 	in6_dev_put(in6_dev);
344 
345 	ndisc_send_na(netdev, &iph->saddr, &msg->target,
346 		      is_router /* router */,
347 		      true /* solicited */,
348 		      false /* override */,
349 		      true /* inc_opt */);
350 out:
351 	dev_put(netdev);
352 }
353 
354 static bool is_neigh_solicit(u8 *buf, size_t len)
355 {
356 	struct ipv6hdr *iph = (void *)buf;
357 	struct nd_msg *msg = (void *)(iph + 1);
358 
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);
363 }
364 #endif /* IPV6 */
365 
366 static struct sk_buff *cdc_mbim_process_dgram(struct usbnet *dev, u8 *buf, size_t len, u16 tci)
367 {
368 	__be16 proto = htons(ETH_P_802_3);
369 	struct sk_buff *skb = NULL;
370 
371 	if (tci < 256 || tci == MBIM_IPS0_VID) { /* IPS session? */
372 		if (len < sizeof(struct iphdr))
373 			goto err;
374 
375 		switch (*buf & 0xf0) {
376 		case 0x40:
377 			proto = htons(ETH_P_IP);
378 			break;
379 		case 0x60:
380 #if IS_ENABLED(CONFIG_IPV6)
381 			if (is_neigh_solicit(buf, len))
382 				do_neigh_solicit(dev, buf, tci);
383 #endif
384 			proto = htons(ETH_P_IPV6);
385 			break;
386 		default:
387 			goto err;
388 		}
389 	}
390 
391 	skb = netdev_alloc_skb_ip_align(dev->net,  len + ETH_HLEN);
392 	if (!skb)
393 		goto err;
394 
395 	/* add an ethernet header */
396 	skb_put(skb, ETH_HLEN);
397 	skb_reset_mac_header(skb);
398 	eth_hdr(skb)->h_proto = proto;
399 	eth_zero_addr(eth_hdr(skb)->h_source);
400 	memcpy(eth_hdr(skb)->h_dest, dev->net->dev_addr, ETH_ALEN);
401 
402 	/* add datagram */
403 	skb_put_data(skb, buf, len);
404 
405 	/* map MBIM session to VLAN */
406 	if (tci)
407 		__vlan_hwaccel_put_tag(skb, htons(ETH_P_8021Q), tci);
408 err:
409 	return skb;
410 }
411 
412 static int cdc_mbim_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
413 {
414 	struct sk_buff *skb;
415 	struct cdc_mbim_state *info = (void *)&dev->data;
416 	struct cdc_ncm_ctx *ctx = info->ctx;
417 	int len;
418 	int nframes;
419 	int x;
420 	int offset;
421 	struct usb_cdc_ncm_ndp16 *ndp16;
422 	struct usb_cdc_ncm_dpe16 *dpe16;
423 	int ndpoffset;
424 	int loopcount = 50; /* arbitrary max preventing infinite loop */
425 	u32 payload = 0;
426 	u8 *c;
427 	u16 tci;
428 
429 	ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
430 	if (ndpoffset < 0)
431 		goto error;
432 
433 next_ndp:
434 	nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
435 	if (nframes < 0)
436 		goto error;
437 
438 	ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
439 
440 	switch (ndp16->dwSignature & cpu_to_le32(0x00ffffff)) {
441 	case cpu_to_le32(USB_CDC_MBIM_NDP16_IPS_SIGN):
442 		c = (u8 *)&ndp16->dwSignature;
443 		tci = c[3];
444 		/* tag IPS<0> packets too if MBIM_IPS0_VID exists */
445 		if (!tci && info->flags & FLAG_IPS0_VLAN)
446 			tci = MBIM_IPS0_VID;
447 		break;
448 	case cpu_to_le32(USB_CDC_MBIM_NDP16_DSS_SIGN):
449 		c = (u8 *)&ndp16->dwSignature;
450 		tci = c[3] + 256;
451 		break;
452 	default:
453 		netif_dbg(dev, rx_err, dev->net,
454 			  "unsupported NDP signature <0x%08x>\n",
455 			  le32_to_cpu(ndp16->dwSignature));
456 		goto err_ndp;
457 
458 	}
459 
460 	dpe16 = ndp16->dpe16;
461 	for (x = 0; x < nframes; x++, dpe16++) {
462 		offset = le16_to_cpu(dpe16->wDatagramIndex);
463 		len = le16_to_cpu(dpe16->wDatagramLength);
464 
465 		/*
466 		 * CDC NCM ch. 3.7
467 		 * All entries after first NULL entry are to be ignored
468 		 */
469 		if ((offset == 0) || (len == 0)) {
470 			if (!x)
471 				goto err_ndp; /* empty NTB */
472 			break;
473 		}
474 
475 		/* sanity checking */
476 		if (((offset + len) > skb_in->len) || (len > ctx->rx_max)) {
477 			netif_dbg(dev, rx_err, dev->net,
478 				  "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
479 				  x, offset, len, skb_in);
480 			if (!x)
481 				goto err_ndp;
482 			break;
483 		} else {
484 			skb = cdc_mbim_process_dgram(dev, skb_in->data + offset, len, tci);
485 			if (!skb)
486 				goto error;
487 			usbnet_skb_return(dev, skb);
488 			payload += len;	/* count payload bytes in this NTB */
489 		}
490 	}
491 err_ndp:
492 	/* are there more NDPs to process? */
493 	ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
494 	if (ndpoffset && loopcount--)
495 		goto next_ndp;
496 
497 	/* update stats */
498 	ctx->rx_overhead += skb_in->len - payload;
499 	ctx->rx_ntbs++;
500 
501 	return 1;
502 error:
503 	return 0;
504 }
505 
506 static int cdc_mbim_suspend(struct usb_interface *intf, pm_message_t message)
507 {
508 	int ret = -ENODEV;
509 	struct usbnet *dev = usb_get_intfdata(intf);
510 	struct cdc_mbim_state *info = (void *)&dev->data;
511 	struct cdc_ncm_ctx *ctx = info->ctx;
512 
513 	if (!ctx)
514 		goto error;
515 
516 	/*
517 	 * Both usbnet_suspend() and subdriver->suspend() MUST return 0
518 	 * in system sleep context, otherwise, the resume callback has
519 	 * to recover device from previous suspend failure.
520 	 */
521 	ret = usbnet_suspend(intf, message);
522 	if (ret < 0)
523 		goto error;
524 
525 	if (intf == ctx->control && info->subdriver && info->subdriver->suspend)
526 		ret = info->subdriver->suspend(intf, message);
527 	if (ret < 0)
528 		usbnet_resume(intf);
529 
530 error:
531 	return ret;
532 }
533 
534 static int cdc_mbim_resume(struct usb_interface *intf)
535 {
536 	int  ret = 0;
537 	struct usbnet *dev = usb_get_intfdata(intf);
538 	struct cdc_mbim_state *info = (void *)&dev->data;
539 	struct cdc_ncm_ctx *ctx = info->ctx;
540 	bool callsub = (intf == ctx->control && info->subdriver && info->subdriver->resume);
541 
542 	if (callsub)
543 		ret = info->subdriver->resume(intf);
544 	if (ret < 0)
545 		goto err;
546 	ret = usbnet_resume(intf);
547 	if (ret < 0 && callsub)
548 		info->subdriver->suspend(intf, PMSG_SUSPEND);
549 err:
550 	return ret;
551 }
552 
553 static const struct driver_info cdc_mbim_info = {
554 	.description = "CDC MBIM",
555 	.flags = FLAG_NO_SETINT | FLAG_MULTI_PACKET | FLAG_WWAN,
556 	.bind = cdc_mbim_bind,
557 	.unbind = cdc_mbim_unbind,
558 	.manage_power = cdc_mbim_manage_power,
559 	.rx_fixup = cdc_mbim_rx_fixup,
560 	.tx_fixup = cdc_mbim_tx_fixup,
561 };
562 
563 /* MBIM and NCM devices should not need a ZLP after NTBs with
564  * dwNtbOutMaxSize length. Nevertheless, a number of devices from
565  * different vendor IDs will fail unless we send ZLPs, forcing us
566  * to make this the default.
567  *
568  * This default may cause a performance penalty for spec conforming
569  * devices wanting to take advantage of optimizations possible without
570  * ZLPs.  A whitelist is added in an attempt to avoid this for devices
571  * known to conform to the MBIM specification.
572  *
573  * All known devices supporting NCM compatibility mode are also
574  * conforming to the NCM and MBIM specifications. For this reason, the
575  * NCM subclass entry is also in the ZLP whitelist.
576  */
577 static const struct driver_info cdc_mbim_info_zlp = {
578 	.description = "CDC MBIM",
579 	.flags = FLAG_NO_SETINT | FLAG_MULTI_PACKET | FLAG_WWAN | FLAG_SEND_ZLP,
580 	.bind = cdc_mbim_bind,
581 	.unbind = cdc_mbim_unbind,
582 	.manage_power = cdc_mbim_manage_power,
583 	.rx_fixup = cdc_mbim_rx_fixup,
584 	.tx_fixup = cdc_mbim_tx_fixup,
585 };
586 
587 /* The spefication explicitly allows NDPs to be placed anywhere in the
588  * frame, but some devices fail unless the NDP is placed after the IP
589  * packets.  Using the CDC_NCM_FLAG_NDP_TO_END flags to force this
590  * behaviour.
591  *
592  * Note: The current implementation of this feature restricts each NTB
593  * to a single NDP, implying that multiplexed sessions cannot share an
594  * NTB. This might affect performance for multiplexed sessions.
595  */
596 static const struct driver_info cdc_mbim_info_ndp_to_end = {
597 	.description = "CDC MBIM",
598 	.flags = FLAG_NO_SETINT | FLAG_MULTI_PACKET | FLAG_WWAN,
599 	.bind = cdc_mbim_bind,
600 	.unbind = cdc_mbim_unbind,
601 	.manage_power = cdc_mbim_manage_power,
602 	.rx_fixup = cdc_mbim_rx_fixup,
603 	.tx_fixup = cdc_mbim_tx_fixup,
604 	.data = CDC_NCM_FLAG_NDP_TO_END,
605 };
606 
607 /* Some modems (e.g. Telit LE922A6) do not work properly with altsetting
608  * toggle done in cdc_ncm_bind_common. CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE
609  * flag is used to avoid this procedure.
610  */
611 static const struct driver_info cdc_mbim_info_avoid_altsetting_toggle = {
612 	.description = "CDC MBIM",
613 	.flags = FLAG_NO_SETINT | FLAG_MULTI_PACKET | FLAG_WWAN | FLAG_SEND_ZLP,
614 	.bind = cdc_mbim_bind,
615 	.unbind = cdc_mbim_unbind,
616 	.manage_power = cdc_mbim_manage_power,
617 	.rx_fixup = cdc_mbim_rx_fixup,
618 	.tx_fixup = cdc_mbim_tx_fixup,
619 	.data = CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE,
620 };
621 
622 static const struct usb_device_id mbim_devs[] = {
623 	/* This duplicate NCM entry is intentional. MBIM devices can
624 	 * be disguised as NCM by default, and this is necessary to
625 	 * allow us to bind the correct driver_info to such devices.
626 	 *
627 	 * bind() will sort out this for us, selecting the correct
628 	 * entry and reject the other
629 	 */
630 	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
631 	  .driver_info = (unsigned long)&cdc_mbim_info,
632 	},
633 	/* ZLP conformance whitelist: All Ericsson MBIM devices */
634 	{ USB_VENDOR_AND_INTERFACE_INFO(0x0bdb, USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE),
635 	  .driver_info = (unsigned long)&cdc_mbim_info,
636 	},
637 
638 	/* Some Huawei devices, ME906s-158 (12d1:15c1) and E3372
639 	 * (12d1:157d), are known to fail unless the NDP is placed
640 	 * after the IP packets.  Applying the quirk to all Huawei
641 	 * devices is broader than necessary, but harmless.
642 	 */
643 	{ USB_VENDOR_AND_INTERFACE_INFO(0x12d1, USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE),
644 	  .driver_info = (unsigned long)&cdc_mbim_info_ndp_to_end,
645 	},
646 
647 	/* The HP lt4132 (03f0:a31d) is a rebranded Huawei ME906s-158,
648 	 * therefore it too requires the above "NDP to end" quirk.
649 	 */
650 	{ USB_DEVICE_AND_INTERFACE_INFO(0x03f0, 0xa31d, USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE),
651 	  .driver_info = (unsigned long)&cdc_mbim_info_ndp_to_end,
652 	},
653 
654 	/* Telit LE922A6 in MBIM composition */
655 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x1041, USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE),
656 	  .driver_info = (unsigned long)&cdc_mbim_info_avoid_altsetting_toggle,
657 	},
658 
659 	/* Telit LN920 */
660 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x1061, USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE),
661 	  .driver_info = (unsigned long)&cdc_mbim_info_avoid_altsetting_toggle,
662 	},
663 
664 	/* Telit FN990A */
665 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x1071, USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE),
666 	  .driver_info = (unsigned long)&cdc_mbim_info_avoid_altsetting_toggle,
667 	},
668 
669 	/* Telit FE990A */
670 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x1081, USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE),
671 	  .driver_info = (unsigned long)&cdc_mbim_info_avoid_altsetting_toggle,
672 	},
673 
674 	/* default entry */
675 	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE),
676 	  .driver_info = (unsigned long)&cdc_mbim_info_zlp,
677 	},
678 	{
679 	},
680 };
681 MODULE_DEVICE_TABLE(usb, mbim_devs);
682 
683 static struct usb_driver cdc_mbim_driver = {
684 	.name = "cdc_mbim",
685 	.id_table = mbim_devs,
686 	.probe = usbnet_probe,
687 	.disconnect = usbnet_disconnect,
688 	.suspend = cdc_mbim_suspend,
689 	.resume = cdc_mbim_resume,
690 	.reset_resume =	cdc_mbim_resume,
691 	.supports_autosuspend = 1,
692 	.disable_hub_initiated_lpm = 1,
693 };
694 module_usb_driver(cdc_mbim_driver);
695 
696 MODULE_AUTHOR("Greg Suarez <gsuarez@smithmicro.com>");
697 MODULE_AUTHOR("Bjørn Mork <bjorn@mork.no>");
698 MODULE_DESCRIPTION("USB CDC MBIM host driver");
699 MODULE_LICENSE("GPL");
700