xref: /linux/drivers/net/usb/cdc_ether.c (revision e5c86679d5e864947a52fb31e45a425dea3e7fa9)
1 /*
2  * CDC Ethernet based networking peripherals
3  * Copyright (C) 2003-2005 by David Brownell
4  * Copyright (C) 2006 by Ole Andre Vadla Ravnas (ActiveSync)
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 // #define	DEBUG			// error path messages, extra info
21 // #define	VERBOSE			// more; success messages
22 
23 #include <linux/module.h>
24 #include <linux/netdevice.h>
25 #include <linux/etherdevice.h>
26 #include <linux/ethtool.h>
27 #include <linux/workqueue.h>
28 #include <linux/mii.h>
29 #include <linux/usb.h>
30 #include <linux/usb/cdc.h>
31 #include <linux/usb/usbnet.h>
32 
33 
34 #if IS_ENABLED(CONFIG_USB_NET_RNDIS_HOST)
35 
36 static int is_rndis(struct usb_interface_descriptor *desc)
37 {
38 	return (desc->bInterfaceClass == USB_CLASS_COMM &&
39 		desc->bInterfaceSubClass == 2 &&
40 		desc->bInterfaceProtocol == 0xff);
41 }
42 
43 static int is_activesync(struct usb_interface_descriptor *desc)
44 {
45 	return (desc->bInterfaceClass == USB_CLASS_MISC &&
46 		desc->bInterfaceSubClass == 1 &&
47 		desc->bInterfaceProtocol == 1);
48 }
49 
50 static int is_wireless_rndis(struct usb_interface_descriptor *desc)
51 {
52 	return (desc->bInterfaceClass == USB_CLASS_WIRELESS_CONTROLLER &&
53 		desc->bInterfaceSubClass == 1 &&
54 		desc->bInterfaceProtocol == 3);
55 }
56 
57 #else
58 
59 #define is_rndis(desc)		0
60 #define is_activesync(desc)	0
61 #define is_wireless_rndis(desc)	0
62 
63 #endif
64 
65 static const u8 mbm_guid[16] = {
66 	0xa3, 0x17, 0xa8, 0x8b, 0x04, 0x5e, 0x4f, 0x01,
67 	0xa6, 0x07, 0xc0, 0xff, 0xcb, 0x7e, 0x39, 0x2a,
68 };
69 
70 static void usbnet_cdc_update_filter(struct usbnet *dev)
71 {
72 	struct cdc_state	*info = (void *) &dev->data;
73 	struct usb_interface	*intf = info->control;
74 	struct net_device	*net = dev->net;
75 
76 	u16 cdc_filter = USB_CDC_PACKET_TYPE_DIRECTED
77 			| USB_CDC_PACKET_TYPE_BROADCAST;
78 
79 	/* filtering on the device is an optional feature and not worth
80 	 * the hassle so we just roughly care about snooping and if any
81 	 * multicast is requested, we take every multicast
82 	 */
83 	if (net->flags & IFF_PROMISC)
84 		cdc_filter |= USB_CDC_PACKET_TYPE_PROMISCUOUS;
85 	if (!netdev_mc_empty(net) || (net->flags & IFF_ALLMULTI))
86 		cdc_filter |= USB_CDC_PACKET_TYPE_ALL_MULTICAST;
87 
88 	usb_control_msg(dev->udev,
89 			usb_sndctrlpipe(dev->udev, 0),
90 			USB_CDC_SET_ETHERNET_PACKET_FILTER,
91 			USB_TYPE_CLASS | USB_RECIP_INTERFACE,
92 			cdc_filter,
93 			intf->cur_altsetting->desc.bInterfaceNumber,
94 			NULL,
95 			0,
96 			USB_CTRL_SET_TIMEOUT
97 		);
98 }
99 
100 /* probes control interface, claims data interface, collects the bulk
101  * endpoints, activates data interface (if needed), maybe sets MTU.
102  * all pure cdc, except for certain firmware workarounds, and knowing
103  * that rndis uses one different rule.
104  */
105 int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
106 {
107 	u8				*buf = intf->cur_altsetting->extra;
108 	int				len = intf->cur_altsetting->extralen;
109 	struct usb_interface_descriptor	*d;
110 	struct cdc_state		*info = (void *) &dev->data;
111 	int				status;
112 	int				rndis;
113 	bool				android_rndis_quirk = false;
114 	struct usb_driver		*driver = driver_of(intf);
115 	struct usb_cdc_parsed_header header;
116 
117 	if (sizeof(dev->data) < sizeof(*info))
118 		return -EDOM;
119 
120 	/* expect strict spec conformance for the descriptors, but
121 	 * cope with firmware which stores them in the wrong place
122 	 */
123 	if (len == 0 && dev->udev->actconfig->extralen) {
124 		/* Motorola SB4100 (and others: Brad Hards says it's
125 		 * from a Broadcom design) put CDC descriptors here
126 		 */
127 		buf = dev->udev->actconfig->extra;
128 		len = dev->udev->actconfig->extralen;
129 		dev_dbg(&intf->dev, "CDC descriptors on config\n");
130 	}
131 
132 	/* Maybe CDC descriptors are after the endpoint?  This bug has
133 	 * been seen on some 2Wire Inc RNDIS-ish products.
134 	 */
135 	if (len == 0) {
136 		struct usb_host_endpoint	*hep;
137 
138 		hep = intf->cur_altsetting->endpoint;
139 		if (hep) {
140 			buf = hep->extra;
141 			len = hep->extralen;
142 		}
143 		if (len)
144 			dev_dbg(&intf->dev,
145 				"CDC descriptors on endpoint\n");
146 	}
147 
148 	/* this assumes that if there's a non-RNDIS vendor variant
149 	 * of cdc-acm, it'll fail RNDIS requests cleanly.
150 	 */
151 	rndis = (is_rndis(&intf->cur_altsetting->desc) ||
152 		 is_activesync(&intf->cur_altsetting->desc) ||
153 		 is_wireless_rndis(&intf->cur_altsetting->desc));
154 
155 	memset(info, 0, sizeof(*info));
156 	info->control = intf;
157 
158 	cdc_parse_cdc_header(&header, intf, buf, len);
159 
160 	info->u = header.usb_cdc_union_desc;
161 	info->header = header.usb_cdc_header_desc;
162 	info->ether = header.usb_cdc_ether_desc;
163 	if (!info->u) {
164 		if (rndis)
165 			goto skip;
166 		else /* in that case a quirk is mandatory */
167 			goto bad_desc;
168 	}
169 	/* we need a master/control interface (what we're
170 	 * probed with) and a slave/data interface; union
171 	 * descriptors sort this all out.
172 	 */
173 	info->control = usb_ifnum_to_if(dev->udev,
174 	info->u->bMasterInterface0);
175 	info->data = usb_ifnum_to_if(dev->udev,
176 		info->u->bSlaveInterface0);
177 	if (!info->control || !info->data) {
178 		dev_dbg(&intf->dev,
179 			"master #%u/%p slave #%u/%p\n",
180 			info->u->bMasterInterface0,
181 			info->control,
182 			info->u->bSlaveInterface0,
183 			info->data);
184 		/* fall back to hard-wiring for RNDIS */
185 		if (rndis) {
186 			android_rndis_quirk = true;
187 			goto skip;
188 		}
189 		goto bad_desc;
190 	}
191 	if (info->control != intf) {
192 		dev_dbg(&intf->dev, "bogus CDC Union\n");
193 		/* Ambit USB Cable Modem (and maybe others)
194 		 * interchanges master and slave interface.
195 		 */
196 		if (info->data == intf) {
197 			info->data = info->control;
198 			info->control = intf;
199 		} else
200 			goto bad_desc;
201 	}
202 
203 	/* some devices merge these - skip class check */
204 	if (info->control == info->data)
205 		goto skip;
206 
207 	/* a data interface altsetting does the real i/o */
208 	d = &info->data->cur_altsetting->desc;
209 	if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
210 		dev_dbg(&intf->dev, "slave class %u\n",
211 			d->bInterfaceClass);
212 		goto bad_desc;
213 	}
214 skip:
215 	if (	rndis &&
216 		header.usb_cdc_acm_descriptor &&
217 		header.usb_cdc_acm_descriptor->bmCapabilities) {
218 			dev_dbg(&intf->dev,
219 				"ACM capabilities %02x, not really RNDIS?\n",
220 				header.usb_cdc_acm_descriptor->bmCapabilities);
221 			goto bad_desc;
222 	}
223 
224 	if (header.usb_cdc_ether_desc) {
225 		dev->hard_mtu = le16_to_cpu(info->ether->wMaxSegmentSize);
226 		/* because of Zaurus, we may be ignoring the host
227 		 * side link address we were given.
228 		 */
229 	}
230 
231 	if (header.usb_cdc_mdlm_desc &&
232 		memcmp(header.usb_cdc_mdlm_desc->bGUID, mbm_guid, 16)) {
233 		dev_dbg(&intf->dev, "GUID doesn't match\n");
234 		goto bad_desc;
235 	}
236 
237 	if (header.usb_cdc_mdlm_detail_desc &&
238 		header.usb_cdc_mdlm_detail_desc->bLength <
239 			(sizeof(struct usb_cdc_mdlm_detail_desc) + 1)) {
240 		dev_dbg(&intf->dev, "Descriptor too short\n");
241 		goto bad_desc;
242 	}
243 
244 
245 
246 	/* Microsoft ActiveSync based and some regular RNDIS devices lack the
247 	 * CDC descriptors, so we'll hard-wire the interfaces and not check
248 	 * for descriptors.
249 	 *
250 	 * Some Android RNDIS devices have a CDC Union descriptor pointing
251 	 * to non-existing interfaces.  Ignore that and attempt the same
252 	 * hard-wired 0 and 1 interfaces.
253 	 */
254 	if (rndis && (!info->u || android_rndis_quirk)) {
255 		info->control = usb_ifnum_to_if(dev->udev, 0);
256 		info->data = usb_ifnum_to_if(dev->udev, 1);
257 		if (!info->control || !info->data || info->control != intf) {
258 			dev_dbg(&intf->dev,
259 				"rndis: master #0/%p slave #1/%p\n",
260 				info->control,
261 				info->data);
262 			goto bad_desc;
263 		}
264 
265 	} else if (!info->header || (!rndis && !info->ether)) {
266 		dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
267 			info->header ? "" : "header ",
268 			info->u ? "" : "union ",
269 			info->ether ? "" : "ether ");
270 		goto bad_desc;
271 	}
272 
273 	/* claim data interface and set it up ... with side effects.
274 	 * network traffic can't flow until an altsetting is enabled.
275 	 */
276 	if (info->data != info->control) {
277 		status = usb_driver_claim_interface(driver, info->data, dev);
278 		if (status < 0)
279 			return status;
280 	}
281 	status = usbnet_get_endpoints(dev, info->data);
282 	if (status < 0) {
283 		/* ensure immediate exit from usbnet_disconnect */
284 		usb_set_intfdata(info->data, NULL);
285 		if (info->data != info->control)
286 			usb_driver_release_interface(driver, info->data);
287 		return status;
288 	}
289 
290 	/* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
291 	if (info->data != info->control)
292 		dev->status = NULL;
293 	if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
294 		struct usb_endpoint_descriptor	*desc;
295 
296 		dev->status = &info->control->cur_altsetting->endpoint [0];
297 		desc = &dev->status->desc;
298 		if (!usb_endpoint_is_int_in(desc) ||
299 		    (le16_to_cpu(desc->wMaxPacketSize)
300 		     < sizeof(struct usb_cdc_notification)) ||
301 		    !desc->bInterval) {
302 			dev_dbg(&intf->dev, "bad notification endpoint\n");
303 			dev->status = NULL;
304 		}
305 	}
306 	if (rndis && !dev->status) {
307 		dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
308 		usb_set_intfdata(info->data, NULL);
309 		usb_driver_release_interface(driver, info->data);
310 		return -ENODEV;
311 	}
312 
313 	/* Some devices don't initialise properly. In particular
314 	 * the packet filter is not reset. There are devices that
315 	 * don't do reset all the way. So the packet filter should
316 	 * be set to a sane initial value.
317 	 */
318 	usbnet_cdc_update_filter(dev);
319 
320 	return 0;
321 
322 bad_desc:
323 	dev_info(&dev->udev->dev, "bad CDC descriptors\n");
324 	return -ENODEV;
325 }
326 EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
327 
328 void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
329 {
330 	struct cdc_state		*info = (void *) &dev->data;
331 	struct usb_driver		*driver = driver_of(intf);
332 
333 	/* combined interface - nothing  to do */
334 	if (info->data == info->control)
335 		return;
336 
337 	/* disconnect master --> disconnect slave */
338 	if (intf == info->control && info->data) {
339 		/* ensure immediate exit from usbnet_disconnect */
340 		usb_set_intfdata(info->data, NULL);
341 		usb_driver_release_interface(driver, info->data);
342 		info->data = NULL;
343 	}
344 
345 	/* and vice versa (just in case) */
346 	else if (intf == info->data && info->control) {
347 		/* ensure immediate exit from usbnet_disconnect */
348 		usb_set_intfdata(info->control, NULL);
349 		usb_driver_release_interface(driver, info->control);
350 		info->control = NULL;
351 	}
352 }
353 EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
354 
355 /* Communications Device Class, Ethernet Control model
356  *
357  * Takes two interfaces.  The DATA interface is inactive till an altsetting
358  * is selected.  Configuration data includes class descriptors.  There's
359  * an optional status endpoint on the control interface.
360  *
361  * This should interop with whatever the 2.4 "CDCEther.c" driver
362  * (by Brad Hards) talked with, with more functionality.
363  */
364 
365 static void dumpspeed(struct usbnet *dev, __le32 *speeds)
366 {
367 	netif_info(dev, timer, dev->net,
368 		   "link speeds: %u kbps up, %u kbps down\n",
369 		   __le32_to_cpu(speeds[0]) / 1000,
370 		   __le32_to_cpu(speeds[1]) / 1000);
371 }
372 
373 void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
374 {
375 	struct usb_cdc_notification	*event;
376 
377 	if (urb->actual_length < sizeof(*event))
378 		return;
379 
380 	/* SPEED_CHANGE can get split into two 8-byte packets */
381 	if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
382 		dumpspeed(dev, (__le32 *) urb->transfer_buffer);
383 		return;
384 	}
385 
386 	event = urb->transfer_buffer;
387 	switch (event->bNotificationType) {
388 	case USB_CDC_NOTIFY_NETWORK_CONNECTION:
389 		netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
390 			  event->wValue ? "on" : "off");
391 		usbnet_link_change(dev, !!event->wValue, 0);
392 		break;
393 	case USB_CDC_NOTIFY_SPEED_CHANGE:	/* tx/rx rates */
394 		netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
395 			  urb->actual_length);
396 		if (urb->actual_length != (sizeof(*event) + 8))
397 			set_bit(EVENT_STS_SPLIT, &dev->flags);
398 		else
399 			dumpspeed(dev, (__le32 *) &event[1]);
400 		break;
401 	/* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
402 	 * but there are no standard formats for the response data.
403 	 */
404 	default:
405 		netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
406 			   event->bNotificationType);
407 		break;
408 	}
409 }
410 EXPORT_SYMBOL_GPL(usbnet_cdc_status);
411 
412 int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
413 {
414 	int				status;
415 	struct cdc_state		*info = (void *) &dev->data;
416 
417 	BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
418 			< sizeof(struct cdc_state)));
419 
420 	status = usbnet_generic_cdc_bind(dev, intf);
421 	if (status < 0)
422 		return status;
423 
424 	status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
425 	if (status < 0) {
426 		usb_set_intfdata(info->data, NULL);
427 		usb_driver_release_interface(driver_of(intf), info->data);
428 		return status;
429 	}
430 
431 	return 0;
432 }
433 EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
434 
435 static int usbnet_cdc_zte_bind(struct usbnet *dev, struct usb_interface *intf)
436 {
437 	int status = usbnet_cdc_bind(dev, intf);
438 
439 	if (!status && (dev->net->dev_addr[0] & 0x02))
440 		eth_hw_addr_random(dev->net);
441 
442 	return status;
443 }
444 
445 /* Make sure packets have correct destination MAC address
446  *
447  * A firmware bug observed on some devices (ZTE MF823/831/910) is that the
448  * device sends packets with a static, bogus, random MAC address (event if
449  * device MAC address has been updated). Always set MAC address to that of the
450  * device.
451  */
452 static int usbnet_cdc_zte_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
453 {
454 	if (skb->len < ETH_HLEN || !(skb->data[0] & 0x02))
455 		return 1;
456 
457 	skb_reset_mac_header(skb);
458 	ether_addr_copy(eth_hdr(skb)->h_dest, dev->net->dev_addr);
459 
460 	return 1;
461 }
462 
463 /* Ensure correct link state
464  *
465  * Some devices (ZTE MF823/831/910) export two carrier on notifications when
466  * connected. This causes the link state to be incorrect. Work around this by
467  * always setting the state to off, then on.
468  */
469 static void usbnet_cdc_zte_status(struct usbnet *dev, struct urb *urb)
470 {
471 	struct usb_cdc_notification *event;
472 
473 	if (urb->actual_length < sizeof(*event))
474 		return;
475 
476 	event = urb->transfer_buffer;
477 
478 	if (event->bNotificationType != USB_CDC_NOTIFY_NETWORK_CONNECTION) {
479 		usbnet_cdc_status(dev, urb);
480 		return;
481 	}
482 
483 	netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
484 		  event->wValue ? "on" : "off");
485 
486 	if (event->wValue &&
487 	    netif_carrier_ok(dev->net))
488 		netif_carrier_off(dev->net);
489 
490 	usbnet_link_change(dev, !!event->wValue, 0);
491 }
492 
493 static const struct driver_info	cdc_info = {
494 	.description =	"CDC Ethernet Device",
495 	.flags =	FLAG_ETHER | FLAG_POINTTOPOINT,
496 	.bind =		usbnet_cdc_bind,
497 	.unbind =	usbnet_cdc_unbind,
498 	.status =	usbnet_cdc_status,
499 	.set_rx_mode =	usbnet_cdc_update_filter,
500 	.manage_power =	usbnet_manage_power,
501 };
502 
503 static const struct driver_info	zte_cdc_info = {
504 	.description =	"ZTE CDC Ethernet Device",
505 	.flags =	FLAG_ETHER | FLAG_POINTTOPOINT,
506 	.bind =		usbnet_cdc_zte_bind,
507 	.unbind =	usbnet_cdc_unbind,
508 	.status =	usbnet_cdc_zte_status,
509 	.set_rx_mode =	usbnet_cdc_update_filter,
510 	.manage_power =	usbnet_manage_power,
511 	.rx_fixup = usbnet_cdc_zte_rx_fixup,
512 };
513 
514 static const struct driver_info wwan_info = {
515 	.description =	"Mobile Broadband Network Device",
516 	.flags =	FLAG_WWAN,
517 	.bind =		usbnet_cdc_bind,
518 	.unbind =	usbnet_cdc_unbind,
519 	.status =	usbnet_cdc_status,
520 	.set_rx_mode =	usbnet_cdc_update_filter,
521 	.manage_power =	usbnet_manage_power,
522 };
523 
524 /*-------------------------------------------------------------------------*/
525 
526 #define HUAWEI_VENDOR_ID	0x12D1
527 #define NOVATEL_VENDOR_ID	0x1410
528 #define ZTE_VENDOR_ID		0x19D2
529 #define DELL_VENDOR_ID		0x413C
530 #define REALTEK_VENDOR_ID	0x0bda
531 #define SAMSUNG_VENDOR_ID	0x04e8
532 #define LENOVO_VENDOR_ID	0x17ef
533 #define NVIDIA_VENDOR_ID	0x0955
534 #define HP_VENDOR_ID		0x03f0
535 #define MICROSOFT_VENDOR_ID	0x045e
536 
537 static const struct usb_device_id	products[] = {
538 /* BLACKLIST !!
539  *
540  * First blacklist any products that are egregiously nonconformant
541  * with the CDC Ethernet specs.  Minor braindamage we cope with; when
542  * they're not even trying, needing a separate driver is only the first
543  * of the differences to show up.
544  */
545 
546 #define	ZAURUS_MASTER_INTERFACE \
547 	.bInterfaceClass	= USB_CLASS_COMM, \
548 	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET, \
549 	.bInterfaceProtocol	= USB_CDC_PROTO_NONE
550 
551 /* SA-1100 based Sharp Zaurus ("collie"), or compatible;
552  * wire-incompatible with true CDC Ethernet implementations.
553  * (And, it seems, needlessly so...)
554  */
555 {
556 	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
557 			  | USB_DEVICE_ID_MATCH_DEVICE,
558 	.idVendor		= 0x04DD,
559 	.idProduct		= 0x8004,
560 	ZAURUS_MASTER_INTERFACE,
561 	.driver_info		= 0,
562 },
563 
564 /* PXA-25x based Sharp Zaurii.  Note that it seems some of these
565  * (later models especially) may have shipped only with firmware
566  * advertising false "CDC MDLM" compatibility ... but we're not
567  * clear which models did that, so for now let's assume the worst.
568  */
569 {
570 	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
571 			  | USB_DEVICE_ID_MATCH_DEVICE,
572 	.idVendor		= 0x04DD,
573 	.idProduct		= 0x8005,	/* A-300 */
574 	ZAURUS_MASTER_INTERFACE,
575 	.driver_info		= 0,
576 }, {
577 	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
578 			  | USB_DEVICE_ID_MATCH_DEVICE,
579 	.idVendor		= 0x04DD,
580 	.idProduct		= 0x8006,	/* B-500/SL-5600 */
581 	ZAURUS_MASTER_INTERFACE,
582 	.driver_info		= 0,
583 }, {
584 	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
585 			  | USB_DEVICE_ID_MATCH_DEVICE,
586 	.idVendor		= 0x04DD,
587 	.idProduct		= 0x8007,	/* C-700 */
588 	ZAURUS_MASTER_INTERFACE,
589 	.driver_info		= 0,
590 }, {
591 	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
592 		 | USB_DEVICE_ID_MATCH_DEVICE,
593 	.idVendor               = 0x04DD,
594 	.idProduct              = 0x9031,	/* C-750 C-760 */
595 	ZAURUS_MASTER_INTERFACE,
596 	.driver_info		= 0,
597 }, {
598 	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
599 		 | USB_DEVICE_ID_MATCH_DEVICE,
600 	.idVendor               = 0x04DD,
601 	.idProduct              = 0x9032,	/* SL-6000 */
602 	ZAURUS_MASTER_INTERFACE,
603 	.driver_info		= 0,
604 }, {
605 	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
606 		 | USB_DEVICE_ID_MATCH_DEVICE,
607 	.idVendor               = 0x04DD,
608 	/* reported with some C860 units */
609 	.idProduct              = 0x9050,	/* C-860 */
610 	ZAURUS_MASTER_INTERFACE,
611 	.driver_info		= 0,
612 },
613 
614 /* Olympus has some models with a Zaurus-compatible option.
615  * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
616  */
617 {
618 	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
619 		 | USB_DEVICE_ID_MATCH_DEVICE,
620 	.idVendor               = 0x07B4,
621 	.idProduct              = 0x0F02,	/* R-1000 */
622 	ZAURUS_MASTER_INTERFACE,
623 	.driver_info		= 0,
624 },
625 
626 /* LG Electronics VL600 wants additional headers on every frame */
627 {
628 	USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
629 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
630 	.driver_info = 0,
631 },
632 
633 /* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
634 {
635 	USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
636 			USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
637 	.driver_info		= 0,
638 },
639 
640 /* Novatel USB551L and MC551 - handled by qmi_wwan */
641 {
642 	USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0xB001, USB_CLASS_COMM,
643 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
644 	.driver_info = 0,
645 },
646 
647 /* Novatel E362 - handled by qmi_wwan */
648 {
649 	USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9010, USB_CLASS_COMM,
650 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
651 	.driver_info = 0,
652 },
653 
654 /* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
655 {
656 	USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8195, USB_CLASS_COMM,
657 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
658 	.driver_info = 0,
659 },
660 
661 /* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
662 {
663 	USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8196, USB_CLASS_COMM,
664 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
665 	.driver_info = 0,
666 },
667 
668 /* Dell Wireless 5804 (Novatel E371) - handled by qmi_wwan */
669 {
670 	USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x819b, USB_CLASS_COMM,
671 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
672 	.driver_info = 0,
673 },
674 
675 /* Novatel Expedite E371 - handled by qmi_wwan */
676 {
677 	USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9011, USB_CLASS_COMM,
678 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
679 	.driver_info = 0,
680 },
681 
682 /* HP lt2523 (Novatel E371) - handled by qmi_wwan */
683 {
684 	USB_DEVICE_AND_INTERFACE_INFO(HP_VENDOR_ID, 0x421d, USB_CLASS_COMM,
685 				      USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
686 	.driver_info = 0,
687 },
688 
689 /* AnyDATA ADU960S - handled by qmi_wwan */
690 {
691 	USB_DEVICE_AND_INTERFACE_INFO(0x16d5, 0x650a, USB_CLASS_COMM,
692 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
693 	.driver_info = 0,
694 },
695 
696 /* Huawei E1820 - handled by qmi_wwan */
697 {
698 	USB_DEVICE_INTERFACE_NUMBER(HUAWEI_VENDOR_ID, 0x14ac, 1),
699 	.driver_info = 0,
700 },
701 
702 /* Realtek RTL8152 Based USB 2.0 Ethernet Adapters */
703 {
704 	USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8152, USB_CLASS_COMM,
705 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
706 	.driver_info = 0,
707 },
708 
709 /* Realtek RTL8153 Based USB 3.0 Ethernet Adapters */
710 {
711 	USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8153, USB_CLASS_COMM,
712 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
713 	.driver_info = 0,
714 },
715 
716 /* Samsung USB Ethernet Adapters */
717 {
718 	USB_DEVICE_AND_INTERFACE_INFO(SAMSUNG_VENDOR_ID, 0xa101, USB_CLASS_COMM,
719 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
720 	.driver_info = 0,
721 },
722 
723 /* ThinkPad USB-C Dock (based on Realtek RTL8153) */
724 {
725 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x3062, USB_CLASS_COMM,
726 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
727 	.driver_info = 0,
728 },
729 
730 /* ThinkPad Thunderbolt 3 Dock (based on Realtek RTL8153) */
731 {
732 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x3069, USB_CLASS_COMM,
733 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
734 	.driver_info = 0,
735 },
736 
737 /* Lenovo Thinkpad USB 3.0 Ethernet Adapters (based on Realtek RTL8153) */
738 {
739 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x7205, USB_CLASS_COMM,
740 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
741 	.driver_info = 0,
742 },
743 
744 /* Lenovo USB C to Ethernet Adapter (based on Realtek RTL8153) */
745 {
746 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x720c, USB_CLASS_COMM,
747 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
748 	.driver_info = 0,
749 },
750 
751 /* Lenovo USB-C Travel Hub (based on Realtek RTL8153) */
752 {
753 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x7214, USB_CLASS_COMM,
754 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
755 	.driver_info = 0,
756 },
757 
758 /* NVIDIA Tegra USB 3.0 Ethernet Adapters (based on Realtek RTL8153) */
759 {
760 	USB_DEVICE_AND_INTERFACE_INFO(NVIDIA_VENDOR_ID, 0x09ff, USB_CLASS_COMM,
761 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
762 	.driver_info = 0,
763 },
764 
765 /* Microsoft Surface 2 dock (based on Realtek RTL8152) */
766 {
767 	USB_DEVICE_AND_INTERFACE_INFO(MICROSOFT_VENDOR_ID, 0x07ab, USB_CLASS_COMM,
768 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
769 	.driver_info = 0,
770 },
771 
772 /* Microsoft Surface 3 dock (based on Realtek RTL8153) */
773 {
774 	USB_DEVICE_AND_INTERFACE_INFO(MICROSOFT_VENDOR_ID, 0x07c6, USB_CLASS_COMM,
775 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
776 	.driver_info = 0,
777 },
778 
779 /* WHITELIST!!!
780  *
781  * CDC Ether uses two interfaces, not necessarily consecutive.
782  * We match the main interface, ignoring the optional device
783  * class so we could handle devices that aren't exclusively
784  * CDC ether.
785  *
786  * NOTE:  this match must come AFTER entries blacklisting devices
787  * because of bugs/quirks in a given product (like Zaurus, above).
788  */
789 {
790 	/* ZTE (Vodafone) K3805-Z */
791 	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1003, USB_CLASS_COMM,
792 				      USB_CDC_SUBCLASS_ETHERNET,
793 				      USB_CDC_PROTO_NONE),
794 	.driver_info = (unsigned long)&wwan_info,
795 }, {
796 	/* ZTE (Vodafone) K3806-Z */
797 	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1015, USB_CLASS_COMM,
798 				      USB_CDC_SUBCLASS_ETHERNET,
799 				      USB_CDC_PROTO_NONE),
800 	.driver_info = (unsigned long)&wwan_info,
801 }, {
802 	/* ZTE (Vodafone) K4510-Z */
803 	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1173, USB_CLASS_COMM,
804 				      USB_CDC_SUBCLASS_ETHERNET,
805 				      USB_CDC_PROTO_NONE),
806 	.driver_info = (unsigned long)&wwan_info,
807 }, {
808 	/* ZTE (Vodafone) K3770-Z */
809 	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1177, USB_CLASS_COMM,
810 				      USB_CDC_SUBCLASS_ETHERNET,
811 				      USB_CDC_PROTO_NONE),
812 	.driver_info = (unsigned long)&wwan_info,
813 }, {
814 	/* ZTE (Vodafone) K3772-Z */
815 	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1181, USB_CLASS_COMM,
816 				      USB_CDC_SUBCLASS_ETHERNET,
817 				      USB_CDC_PROTO_NONE),
818 	.driver_info = (unsigned long)&wwan_info,
819 }, {
820 	/* Telit modules */
821 	USB_VENDOR_AND_INTERFACE_INFO(0x1bc7, USB_CLASS_COMM,
822 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
823 	.driver_info = (kernel_ulong_t) &wwan_info,
824 }, {
825 	/* Dell DW5580 modules */
826 	USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x81ba, USB_CLASS_COMM,
827 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
828 	.driver_info = (kernel_ulong_t)&wwan_info,
829 }, {
830 	/* ZTE modules */
831 	USB_VENDOR_AND_INTERFACE_INFO(ZTE_VENDOR_ID, USB_CLASS_COMM,
832 				      USB_CDC_SUBCLASS_ETHERNET,
833 				      USB_CDC_PROTO_NONE),
834 	.driver_info = (unsigned long)&zte_cdc_info,
835 }, {
836 	USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
837 			USB_CDC_PROTO_NONE),
838 	.driver_info = (unsigned long) &cdc_info,
839 }, {
840 	USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
841 			USB_CDC_PROTO_NONE),
842 	.driver_info = (unsigned long)&wwan_info,
843 
844 }, {
845 	/* Various Huawei modems with a network port like the UMG1831 */
846 	USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_COMM,
847 				      USB_CDC_SUBCLASS_ETHERNET, 255),
848 	.driver_info = (unsigned long)&wwan_info,
849 },
850 	{ },		/* END */
851 };
852 MODULE_DEVICE_TABLE(usb, products);
853 
854 static struct usb_driver cdc_driver = {
855 	.name =		"cdc_ether",
856 	.id_table =	products,
857 	.probe =	usbnet_probe,
858 	.disconnect =	usbnet_disconnect,
859 	.suspend =	usbnet_suspend,
860 	.resume =	usbnet_resume,
861 	.reset_resume =	usbnet_resume,
862 	.supports_autosuspend = 1,
863 	.disable_hub_initiated_lpm = 1,
864 };
865 
866 module_usb_driver(cdc_driver);
867 
868 MODULE_AUTHOR("David Brownell");
869 MODULE_DESCRIPTION("USB CDC Ethernet devices");
870 MODULE_LICENSE("GPL");
871