xref: /openbmc/linux/drivers/net/usb/cdc_ether.c (revision 84b102f5)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * CDC Ethernet based networking peripherals
4  * Copyright (C) 2003-2005 by David Brownell
5  * Copyright (C) 2006 by Ole Andre Vadla Ravnas (ActiveSync)
6  */
7 
8 // #define	DEBUG			// error path messages, extra info
9 // #define	VERBOSE			// more; success messages
10 
11 #include <linux/module.h>
12 #include <linux/netdevice.h>
13 #include <linux/etherdevice.h>
14 #include <linux/ethtool.h>
15 #include <linux/workqueue.h>
16 #include <linux/mii.h>
17 #include <linux/usb.h>
18 #include <linux/usb/cdc.h>
19 #include <linux/usb/usbnet.h>
20 
21 
22 #if IS_ENABLED(CONFIG_USB_NET_RNDIS_HOST)
23 
24 static int is_rndis(struct usb_interface_descriptor *desc)
25 {
26 	return (desc->bInterfaceClass == USB_CLASS_COMM &&
27 		desc->bInterfaceSubClass == 2 &&
28 		desc->bInterfaceProtocol == 0xff);
29 }
30 
31 static int is_activesync(struct usb_interface_descriptor *desc)
32 {
33 	return (desc->bInterfaceClass == USB_CLASS_MISC &&
34 		desc->bInterfaceSubClass == 1 &&
35 		desc->bInterfaceProtocol == 1);
36 }
37 
38 static int is_wireless_rndis(struct usb_interface_descriptor *desc)
39 {
40 	return (desc->bInterfaceClass == USB_CLASS_WIRELESS_CONTROLLER &&
41 		desc->bInterfaceSubClass == 1 &&
42 		desc->bInterfaceProtocol == 3);
43 }
44 
45 static int is_novatel_rndis(struct usb_interface_descriptor *desc)
46 {
47 	return (desc->bInterfaceClass == USB_CLASS_MISC &&
48 		desc->bInterfaceSubClass == 4 &&
49 		desc->bInterfaceProtocol == 1);
50 }
51 
52 #else
53 
54 #define is_rndis(desc)		0
55 #define is_activesync(desc)	0
56 #define is_wireless_rndis(desc)	0
57 #define is_novatel_rndis(desc)	0
58 
59 #endif
60 
61 static const u8 mbm_guid[16] = {
62 	0xa3, 0x17, 0xa8, 0x8b, 0x04, 0x5e, 0x4f, 0x01,
63 	0xa6, 0x07, 0xc0, 0xff, 0xcb, 0x7e, 0x39, 0x2a,
64 };
65 
66 void usbnet_cdc_update_filter(struct usbnet *dev)
67 {
68 	struct net_device	*net = dev->net;
69 
70 	u16 cdc_filter = USB_CDC_PACKET_TYPE_DIRECTED
71 			| USB_CDC_PACKET_TYPE_BROADCAST;
72 
73 	/* filtering on the device is an optional feature and not worth
74 	 * the hassle so we just roughly care about snooping and if any
75 	 * multicast is requested, we take every multicast
76 	 */
77 	if (net->flags & IFF_PROMISC)
78 		cdc_filter |= USB_CDC_PACKET_TYPE_PROMISCUOUS;
79 	if (!netdev_mc_empty(net) || (net->flags & IFF_ALLMULTI))
80 		cdc_filter |= USB_CDC_PACKET_TYPE_ALL_MULTICAST;
81 
82 	usb_control_msg(dev->udev,
83 			usb_sndctrlpipe(dev->udev, 0),
84 			USB_CDC_SET_ETHERNET_PACKET_FILTER,
85 			USB_TYPE_CLASS | USB_RECIP_INTERFACE,
86 			cdc_filter,
87 			dev->intf->cur_altsetting->desc.bInterfaceNumber,
88 			NULL,
89 			0,
90 			USB_CTRL_SET_TIMEOUT
91 		);
92 }
93 EXPORT_SYMBOL_GPL(usbnet_cdc_update_filter);
94 
95 /* probes control interface, claims data interface, collects the bulk
96  * endpoints, activates data interface (if needed), maybe sets MTU.
97  * all pure cdc, except for certain firmware workarounds, and knowing
98  * that rndis uses one different rule.
99  */
100 int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
101 {
102 	u8				*buf = intf->cur_altsetting->extra;
103 	int				len = intf->cur_altsetting->extralen;
104 	struct usb_interface_descriptor	*d;
105 	struct cdc_state		*info = (void *) &dev->data;
106 	int				status;
107 	int				rndis;
108 	bool				android_rndis_quirk = false;
109 	struct usb_driver		*driver = driver_of(intf);
110 	struct usb_cdc_parsed_header header;
111 
112 	if (sizeof(dev->data) < sizeof(*info))
113 		return -EDOM;
114 
115 	/* expect strict spec conformance for the descriptors, but
116 	 * cope with firmware which stores them in the wrong place
117 	 */
118 	if (len == 0 && dev->udev->actconfig->extralen) {
119 		/* Motorola SB4100 (and others: Brad Hards says it's
120 		 * from a Broadcom design) put CDC descriptors here
121 		 */
122 		buf = dev->udev->actconfig->extra;
123 		len = dev->udev->actconfig->extralen;
124 		dev_dbg(&intf->dev, "CDC descriptors on config\n");
125 	}
126 
127 	/* Maybe CDC descriptors are after the endpoint?  This bug has
128 	 * been seen on some 2Wire Inc RNDIS-ish products.
129 	 */
130 	if (len == 0) {
131 		struct usb_host_endpoint	*hep;
132 
133 		hep = intf->cur_altsetting->endpoint;
134 		if (hep) {
135 			buf = hep->extra;
136 			len = hep->extralen;
137 		}
138 		if (len)
139 			dev_dbg(&intf->dev,
140 				"CDC descriptors on endpoint\n");
141 	}
142 
143 	/* this assumes that if there's a non-RNDIS vendor variant
144 	 * of cdc-acm, it'll fail RNDIS requests cleanly.
145 	 */
146 	rndis = (is_rndis(&intf->cur_altsetting->desc) ||
147 		 is_activesync(&intf->cur_altsetting->desc) ||
148 		 is_wireless_rndis(&intf->cur_altsetting->desc) ||
149 		 is_novatel_rndis(&intf->cur_altsetting->desc));
150 
151 	memset(info, 0, sizeof(*info));
152 	info->control = intf;
153 
154 	cdc_parse_cdc_header(&header, intf, buf, len);
155 
156 	info->u = header.usb_cdc_union_desc;
157 	info->header = header.usb_cdc_header_desc;
158 	info->ether = header.usb_cdc_ether_desc;
159 	if (!info->u) {
160 		if (rndis)
161 			goto skip;
162 		else /* in that case a quirk is mandatory */
163 			goto bad_desc;
164 	}
165 	/* we need a master/control interface (what we're
166 	 * probed with) and a slave/data interface; union
167 	 * descriptors sort this all out.
168 	 */
169 	info->control = usb_ifnum_to_if(dev->udev, info->u->bMasterInterface0);
170 	info->data = usb_ifnum_to_if(dev->udev, info->u->bSlaveInterface0);
171 	if (!info->control || !info->data) {
172 		dev_dbg(&intf->dev,
173 			"master #%u/%p slave #%u/%p\n",
174 			info->u->bMasterInterface0,
175 			info->control,
176 			info->u->bSlaveInterface0,
177 			info->data);
178 		/* fall back to hard-wiring for RNDIS */
179 		if (rndis) {
180 			android_rndis_quirk = true;
181 			goto skip;
182 		}
183 		goto bad_desc;
184 	}
185 	if (info->control != intf) {
186 		dev_dbg(&intf->dev, "bogus CDC Union\n");
187 		/* Ambit USB Cable Modem (and maybe others)
188 		 * interchanges master and slave interface.
189 		 */
190 		if (info->data == intf) {
191 			info->data = info->control;
192 			info->control = intf;
193 		} else
194 			goto bad_desc;
195 	}
196 
197 	/* some devices merge these - skip class check */
198 	if (info->control == info->data)
199 		goto skip;
200 
201 	/* a data interface altsetting does the real i/o */
202 	d = &info->data->cur_altsetting->desc;
203 	if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
204 		dev_dbg(&intf->dev, "slave class %u\n", d->bInterfaceClass);
205 		goto bad_desc;
206 	}
207 skip:
208 	/* Communcation class functions with bmCapabilities are not
209 	 * RNDIS.  But some Wireless class RNDIS functions use
210 	 * bmCapabilities for their own purpose. The failsafe is
211 	 * therefore applied only to Communication class RNDIS
212 	 * functions.  The rndis test is redundant, but a cheap
213 	 * optimization.
214 	 */
215 	if (rndis && is_rndis(&intf->cur_altsetting->desc) &&
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 && info->ether->wMaxSegmentSize) {
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 	return 0;
314 
315 bad_desc:
316 	dev_info(&dev->udev->dev, "bad CDC descriptors\n");
317 	return -ENODEV;
318 }
319 EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
320 
321 
322 /* like usbnet_generic_cdc_bind() but handles filter initialization
323  * correctly
324  */
325 int usbnet_ether_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
326 {
327 	int rv;
328 
329 	rv = usbnet_generic_cdc_bind(dev, intf);
330 	if (rv < 0)
331 		goto bail_out;
332 
333 	/* Some devices don't initialise properly. In particular
334 	 * the packet filter is not reset. There are devices that
335 	 * don't do reset all the way. So the packet filter should
336 	 * be set to a sane initial value.
337 	 */
338 	usbnet_cdc_update_filter(dev);
339 
340 bail_out:
341 	return rv;
342 }
343 EXPORT_SYMBOL_GPL(usbnet_ether_cdc_bind);
344 
345 void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
346 {
347 	struct cdc_state		*info = (void *) &dev->data;
348 	struct usb_driver		*driver = driver_of(intf);
349 
350 	/* combined interface - nothing  to do */
351 	if (info->data == info->control)
352 		return;
353 
354 	/* disconnect master --> disconnect slave */
355 	if (intf == info->control && info->data) {
356 		/* ensure immediate exit from usbnet_disconnect */
357 		usb_set_intfdata(info->data, NULL);
358 		usb_driver_release_interface(driver, info->data);
359 		info->data = NULL;
360 	}
361 
362 	/* and vice versa (just in case) */
363 	else if (intf == info->data && info->control) {
364 		/* ensure immediate exit from usbnet_disconnect */
365 		usb_set_intfdata(info->control, NULL);
366 		usb_driver_release_interface(driver, info->control);
367 		info->control = NULL;
368 	}
369 }
370 EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
371 
372 /* Communications Device Class, Ethernet Control model
373  *
374  * Takes two interfaces.  The DATA interface is inactive till an altsetting
375  * is selected.  Configuration data includes class descriptors.  There's
376  * an optional status endpoint on the control interface.
377  *
378  * This should interop with whatever the 2.4 "CDCEther.c" driver
379  * (by Brad Hards) talked with, with more functionality.
380  */
381 
382 static void dumpspeed(struct usbnet *dev, __le32 *speeds)
383 {
384 	netif_info(dev, timer, dev->net,
385 		   "link speeds: %u kbps up, %u kbps down\n",
386 		   __le32_to_cpu(speeds[0]) / 1000,
387 		   __le32_to_cpu(speeds[1]) / 1000);
388 }
389 
390 void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
391 {
392 	struct usb_cdc_notification	*event;
393 
394 	if (urb->actual_length < sizeof(*event))
395 		return;
396 
397 	/* SPEED_CHANGE can get split into two 8-byte packets */
398 	if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
399 		dumpspeed(dev, (__le32 *) urb->transfer_buffer);
400 		return;
401 	}
402 
403 	event = urb->transfer_buffer;
404 	switch (event->bNotificationType) {
405 	case USB_CDC_NOTIFY_NETWORK_CONNECTION:
406 		netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
407 			  event->wValue ? "on" : "off");
408 		usbnet_link_change(dev, !!event->wValue, 0);
409 		break;
410 	case USB_CDC_NOTIFY_SPEED_CHANGE:	/* tx/rx rates */
411 		netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
412 			  urb->actual_length);
413 		if (urb->actual_length != (sizeof(*event) + 8))
414 			set_bit(EVENT_STS_SPLIT, &dev->flags);
415 		else
416 			dumpspeed(dev, (__le32 *) &event[1]);
417 		break;
418 	/* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
419 	 * but there are no standard formats for the response data.
420 	 */
421 	default:
422 		netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
423 			   event->bNotificationType);
424 		break;
425 	}
426 }
427 EXPORT_SYMBOL_GPL(usbnet_cdc_status);
428 
429 int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
430 {
431 	int				status;
432 	struct cdc_state		*info = (void *) &dev->data;
433 
434 	BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
435 			< sizeof(struct cdc_state)));
436 
437 	status = usbnet_ether_cdc_bind(dev, intf);
438 	if (status < 0)
439 		return status;
440 
441 	status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
442 	if (status < 0) {
443 		usb_set_intfdata(info->data, NULL);
444 		usb_driver_release_interface(driver_of(intf), info->data);
445 		return status;
446 	}
447 
448 	return 0;
449 }
450 EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
451 
452 static int usbnet_cdc_zte_bind(struct usbnet *dev, struct usb_interface *intf)
453 {
454 	int status = usbnet_cdc_bind(dev, intf);
455 
456 	if (!status && (dev->net->dev_addr[0] & 0x02))
457 		eth_hw_addr_random(dev->net);
458 
459 	return status;
460 }
461 
462 /* Make sure packets have correct destination MAC address
463  *
464  * A firmware bug observed on some devices (ZTE MF823/831/910) is that the
465  * device sends packets with a static, bogus, random MAC address (event if
466  * device MAC address has been updated). Always set MAC address to that of the
467  * device.
468  */
469 static int usbnet_cdc_zte_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
470 {
471 	if (skb->len < ETH_HLEN || !(skb->data[0] & 0x02))
472 		return 1;
473 
474 	skb_reset_mac_header(skb);
475 	ether_addr_copy(eth_hdr(skb)->h_dest, dev->net->dev_addr);
476 
477 	return 1;
478 }
479 
480 /* Ensure correct link state
481  *
482  * Some devices (ZTE MF823/831/910) export two carrier on notifications when
483  * connected. This causes the link state to be incorrect. Work around this by
484  * always setting the state to off, then on.
485  */
486 static void usbnet_cdc_zte_status(struct usbnet *dev, struct urb *urb)
487 {
488 	struct usb_cdc_notification *event;
489 
490 	if (urb->actual_length < sizeof(*event))
491 		return;
492 
493 	event = urb->transfer_buffer;
494 
495 	if (event->bNotificationType != USB_CDC_NOTIFY_NETWORK_CONNECTION) {
496 		usbnet_cdc_status(dev, urb);
497 		return;
498 	}
499 
500 	netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
501 		  event->wValue ? "on" : "off");
502 
503 	if (event->wValue &&
504 	    netif_carrier_ok(dev->net))
505 		netif_carrier_off(dev->net);
506 
507 	usbnet_link_change(dev, !!event->wValue, 0);
508 }
509 
510 static const struct driver_info	cdc_info = {
511 	.description =	"CDC Ethernet Device",
512 	.flags =	FLAG_ETHER | FLAG_POINTTOPOINT,
513 	.bind =		usbnet_cdc_bind,
514 	.unbind =	usbnet_cdc_unbind,
515 	.status =	usbnet_cdc_status,
516 	.set_rx_mode =	usbnet_cdc_update_filter,
517 	.manage_power =	usbnet_manage_power,
518 };
519 
520 static const struct driver_info	zte_cdc_info = {
521 	.description =	"ZTE CDC Ethernet Device",
522 	.flags =	FLAG_ETHER | FLAG_POINTTOPOINT,
523 	.bind =		usbnet_cdc_zte_bind,
524 	.unbind =	usbnet_cdc_unbind,
525 	.status =	usbnet_cdc_zte_status,
526 	.set_rx_mode =	usbnet_cdc_update_filter,
527 	.manage_power =	usbnet_manage_power,
528 	.rx_fixup = usbnet_cdc_zte_rx_fixup,
529 };
530 
531 static const struct driver_info wwan_info = {
532 	.description =	"Mobile Broadband Network Device",
533 	.flags =	FLAG_WWAN,
534 	.bind =		usbnet_cdc_bind,
535 	.unbind =	usbnet_cdc_unbind,
536 	.status =	usbnet_cdc_status,
537 	.set_rx_mode =	usbnet_cdc_update_filter,
538 	.manage_power =	usbnet_manage_power,
539 };
540 
541 /*-------------------------------------------------------------------------*/
542 
543 #define HUAWEI_VENDOR_ID	0x12D1
544 #define NOVATEL_VENDOR_ID	0x1410
545 #define ZTE_VENDOR_ID		0x19D2
546 #define DELL_VENDOR_ID		0x413C
547 #define REALTEK_VENDOR_ID	0x0bda
548 #define SAMSUNG_VENDOR_ID	0x04e8
549 #define LENOVO_VENDOR_ID	0x17ef
550 #define LINKSYS_VENDOR_ID	0x13b1
551 #define NVIDIA_VENDOR_ID	0x0955
552 #define HP_VENDOR_ID		0x03f0
553 #define MICROSOFT_VENDOR_ID	0x045e
554 #define UBLOX_VENDOR_ID		0x1546
555 #define TPLINK_VENDOR_ID	0x2357
556 #define AQUANTIA_VENDOR_ID	0x2eca
557 #define ASIX_VENDOR_ID		0x0b95
558 
559 static const struct usb_device_id	products[] = {
560 /* BLACKLIST !!
561  *
562  * First blacklist any products that are egregiously nonconformant
563  * with the CDC Ethernet specs.  Minor braindamage we cope with; when
564  * they're not even trying, needing a separate driver is only the first
565  * of the differences to show up.
566  */
567 
568 #define	ZAURUS_MASTER_INTERFACE \
569 	.bInterfaceClass	= USB_CLASS_COMM, \
570 	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET, \
571 	.bInterfaceProtocol	= USB_CDC_PROTO_NONE
572 
573 /* SA-1100 based Sharp Zaurus ("collie"), or compatible;
574  * wire-incompatible with true CDC Ethernet implementations.
575  * (And, it seems, needlessly so...)
576  */
577 {
578 	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
579 			  | USB_DEVICE_ID_MATCH_DEVICE,
580 	.idVendor		= 0x04DD,
581 	.idProduct		= 0x8004,
582 	ZAURUS_MASTER_INTERFACE,
583 	.driver_info		= 0,
584 },
585 
586 /* PXA-25x based Sharp Zaurii.  Note that it seems some of these
587  * (later models especially) may have shipped only with firmware
588  * advertising false "CDC MDLM" compatibility ... but we're not
589  * clear which models did that, so for now let's assume the worst.
590  */
591 {
592 	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
593 			  | USB_DEVICE_ID_MATCH_DEVICE,
594 	.idVendor		= 0x04DD,
595 	.idProduct		= 0x8005,	/* A-300 */
596 	ZAURUS_MASTER_INTERFACE,
597 	.driver_info		= 0,
598 }, {
599 	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
600 			  | USB_DEVICE_ID_MATCH_DEVICE,
601 	.idVendor		= 0x04DD,
602 	.idProduct		= 0x8006,	/* B-500/SL-5600 */
603 	ZAURUS_MASTER_INTERFACE,
604 	.driver_info		= 0,
605 }, {
606 	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
607 			  | USB_DEVICE_ID_MATCH_DEVICE,
608 	.idVendor		= 0x04DD,
609 	.idProduct		= 0x8007,	/* C-700 */
610 	ZAURUS_MASTER_INTERFACE,
611 	.driver_info		= 0,
612 }, {
613 	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
614 		 | USB_DEVICE_ID_MATCH_DEVICE,
615 	.idVendor               = 0x04DD,
616 	.idProduct              = 0x9031,	/* C-750 C-760 */
617 	ZAURUS_MASTER_INTERFACE,
618 	.driver_info		= 0,
619 }, {
620 	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
621 		 | USB_DEVICE_ID_MATCH_DEVICE,
622 	.idVendor               = 0x04DD,
623 	.idProduct              = 0x9032,	/* SL-6000 */
624 	ZAURUS_MASTER_INTERFACE,
625 	.driver_info		= 0,
626 }, {
627 	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
628 		 | USB_DEVICE_ID_MATCH_DEVICE,
629 	.idVendor               = 0x04DD,
630 	/* reported with some C860 units */
631 	.idProduct              = 0x9050,	/* C-860 */
632 	ZAURUS_MASTER_INTERFACE,
633 	.driver_info		= 0,
634 },
635 
636 /* Olympus has some models with a Zaurus-compatible option.
637  * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
638  */
639 {
640 	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
641 		 | USB_DEVICE_ID_MATCH_DEVICE,
642 	.idVendor               = 0x07B4,
643 	.idProduct              = 0x0F02,	/* R-1000 */
644 	ZAURUS_MASTER_INTERFACE,
645 	.driver_info		= 0,
646 },
647 
648 /* LG Electronics VL600 wants additional headers on every frame */
649 {
650 	USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
651 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
652 	.driver_info = 0,
653 },
654 
655 /* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
656 {
657 	USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
658 			USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
659 	.driver_info		= 0,
660 },
661 
662 /* Novatel USB551L and MC551 - handled by qmi_wwan */
663 {
664 	USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0xB001, USB_CLASS_COMM,
665 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
666 	.driver_info = 0,
667 },
668 
669 /* Novatel E362 - handled by qmi_wwan */
670 {
671 	USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9010, USB_CLASS_COMM,
672 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
673 	.driver_info = 0,
674 },
675 
676 /* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
677 {
678 	USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8195, USB_CLASS_COMM,
679 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
680 	.driver_info = 0,
681 },
682 
683 /* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
684 {
685 	USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8196, USB_CLASS_COMM,
686 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
687 	.driver_info = 0,
688 },
689 
690 /* Dell Wireless 5804 (Novatel E371) - handled by qmi_wwan */
691 {
692 	USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x819b, USB_CLASS_COMM,
693 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
694 	.driver_info = 0,
695 },
696 
697 /* Novatel Expedite E371 - handled by qmi_wwan */
698 {
699 	USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9011, USB_CLASS_COMM,
700 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
701 	.driver_info = 0,
702 },
703 
704 /* HP lt2523 (Novatel E371) - handled by qmi_wwan */
705 {
706 	USB_DEVICE_AND_INTERFACE_INFO(HP_VENDOR_ID, 0x421d, USB_CLASS_COMM,
707 				      USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
708 	.driver_info = 0,
709 },
710 
711 /* AnyDATA ADU960S - handled by qmi_wwan */
712 {
713 	USB_DEVICE_AND_INTERFACE_INFO(0x16d5, 0x650a, USB_CLASS_COMM,
714 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
715 	.driver_info = 0,
716 },
717 
718 /* Huawei E1820 - handled by qmi_wwan */
719 {
720 	USB_DEVICE_INTERFACE_NUMBER(HUAWEI_VENDOR_ID, 0x14ac, 1),
721 	.driver_info = 0,
722 },
723 
724 /* Realtek RTL8152 Based USB 2.0 Ethernet Adapters */
725 {
726 	USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8152, USB_CLASS_COMM,
727 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
728 	.driver_info = 0,
729 },
730 
731 /* Realtek RTL8153 Based USB 3.0 Ethernet Adapters */
732 {
733 	USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8153, USB_CLASS_COMM,
734 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
735 	.driver_info = 0,
736 },
737 
738 /* Samsung USB Ethernet Adapters */
739 {
740 	USB_DEVICE_AND_INTERFACE_INFO(SAMSUNG_VENDOR_ID, 0xa101, USB_CLASS_COMM,
741 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
742 	.driver_info = 0,
743 },
744 
745 #if IS_ENABLED(CONFIG_USB_RTL8152)
746 /* Linksys USB3GIGV1 Ethernet Adapter */
747 {
748 	USB_DEVICE_AND_INTERFACE_INFO(LINKSYS_VENDOR_ID, 0x0041, USB_CLASS_COMM,
749 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
750 	.driver_info = 0,
751 },
752 #endif
753 
754 /* ThinkPad USB-C Dock (based on Realtek RTL8153) */
755 {
756 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x3062, USB_CLASS_COMM,
757 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
758 	.driver_info = 0,
759 },
760 
761 /* ThinkPad Thunderbolt 3 Dock (based on Realtek RTL8153) */
762 {
763 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x3069, USB_CLASS_COMM,
764 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
765 	.driver_info = 0,
766 },
767 
768 /* ThinkPad Thunderbolt 3 Dock Gen 2 (based on Realtek RTL8153) */
769 {
770 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x3082, USB_CLASS_COMM,
771 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
772 	.driver_info = 0,
773 },
774 
775 /* Lenovo Thinkpad USB 3.0 Ethernet Adapters (based on Realtek RTL8153) */
776 {
777 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x7205, USB_CLASS_COMM,
778 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
779 	.driver_info = 0,
780 },
781 
782 /* Lenovo USB C to Ethernet Adapter (based on Realtek RTL8153) */
783 {
784 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x720c, USB_CLASS_COMM,
785 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
786 	.driver_info = 0,
787 },
788 
789 /* Lenovo USB-C Travel Hub (based on Realtek RTL8153) */
790 {
791 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x7214, USB_CLASS_COMM,
792 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
793 	.driver_info = 0,
794 },
795 
796 /* Lenovo Powered USB-C Travel Hub (4X90S92381, based on Realtek RTL8153) */
797 {
798 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x721e, USB_CLASS_COMM,
799 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
800 	.driver_info = 0,
801 },
802 
803 /* ThinkPad USB-C Dock Gen 2 (based on Realtek RTL8153) */
804 {
805 	USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0xa387, USB_CLASS_COMM,
806 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
807 	.driver_info = 0,
808 },
809 
810 /* NVIDIA Tegra USB 3.0 Ethernet Adapters (based on Realtek RTL8153) */
811 {
812 	USB_DEVICE_AND_INTERFACE_INFO(NVIDIA_VENDOR_ID, 0x09ff, USB_CLASS_COMM,
813 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
814 	.driver_info = 0,
815 },
816 
817 /* Microsoft Surface 2 dock (based on Realtek RTL8152) */
818 {
819 	USB_DEVICE_AND_INTERFACE_INFO(MICROSOFT_VENDOR_ID, 0x07ab, USB_CLASS_COMM,
820 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
821 	.driver_info = 0,
822 },
823 
824 /* Microsoft Surface Ethernet Adapter (based on Realtek RTL8153) */
825 {
826 	USB_DEVICE_AND_INTERFACE_INFO(MICROSOFT_VENDOR_ID, 0x07c6, USB_CLASS_COMM,
827 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
828 	.driver_info = 0,
829 },
830 
831 /* Microsoft Surface Ethernet Adapter (based on Realtek RTL8153B) */
832 {
833 	USB_DEVICE_AND_INTERFACE_INFO(MICROSOFT_VENDOR_ID, 0x0927, USB_CLASS_COMM,
834 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
835 	.driver_info = 0,
836 },
837 
838 /* TP-LINK UE300 USB 3.0 Ethernet Adapters (based on Realtek RTL8153) */
839 {
840 	USB_DEVICE_AND_INTERFACE_INFO(TPLINK_VENDOR_ID, 0x0601, USB_CLASS_COMM,
841 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
842 	.driver_info = 0,
843 },
844 
845 /* Aquantia AQtion USB to 5GbE Controller (based on AQC111U) */
846 {
847 	USB_DEVICE_AND_INTERFACE_INFO(AQUANTIA_VENDOR_ID, 0xc101,
848 				      USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
849 				      USB_CDC_PROTO_NONE),
850 	.driver_info = 0,
851 },
852 
853 /* ASIX USB 3.1 Gen1 to 5G Multi-Gigabit Ethernet Adapter(based on AQC111U) */
854 {
855 	USB_DEVICE_AND_INTERFACE_INFO(ASIX_VENDOR_ID, 0x2790, USB_CLASS_COMM,
856 				      USB_CDC_SUBCLASS_ETHERNET,
857 				      USB_CDC_PROTO_NONE),
858 	.driver_info = 0,
859 },
860 
861 /* ASIX USB 3.1 Gen1 to 2.5G Multi-Gigabit Ethernet Adapter(based on AQC112U) */
862 {
863 	USB_DEVICE_AND_INTERFACE_INFO(ASIX_VENDOR_ID, 0x2791, USB_CLASS_COMM,
864 				      USB_CDC_SUBCLASS_ETHERNET,
865 				      USB_CDC_PROTO_NONE),
866 	.driver_info = 0,
867 },
868 
869 /* USB-C 3.1 to 5GBASE-T Ethernet Adapter (based on AQC111U) */
870 {
871 	USB_DEVICE_AND_INTERFACE_INFO(0x20f4, 0xe05a, USB_CLASS_COMM,
872 				      USB_CDC_SUBCLASS_ETHERNET,
873 				      USB_CDC_PROTO_NONE),
874 	.driver_info = 0,
875 },
876 
877 /* QNAP QNA-UC5G1T USB to 5GbE Adapter (based on AQC111U) */
878 {
879 	USB_DEVICE_AND_INTERFACE_INFO(0x1c04, 0x0015, USB_CLASS_COMM,
880 				      USB_CDC_SUBCLASS_ETHERNET,
881 				      USB_CDC_PROTO_NONE),
882 	.driver_info = 0,
883 },
884 
885 /* WHITELIST!!!
886  *
887  * CDC Ether uses two interfaces, not necessarily consecutive.
888  * We match the main interface, ignoring the optional device
889  * class so we could handle devices that aren't exclusively
890  * CDC ether.
891  *
892  * NOTE:  this match must come AFTER entries blacklisting devices
893  * because of bugs/quirks in a given product (like Zaurus, above).
894  */
895 {
896 	/* ZTE (Vodafone) K3805-Z */
897 	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1003, USB_CLASS_COMM,
898 				      USB_CDC_SUBCLASS_ETHERNET,
899 				      USB_CDC_PROTO_NONE),
900 	.driver_info = (unsigned long)&wwan_info,
901 }, {
902 	/* ZTE (Vodafone) K3806-Z */
903 	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1015, USB_CLASS_COMM,
904 				      USB_CDC_SUBCLASS_ETHERNET,
905 				      USB_CDC_PROTO_NONE),
906 	.driver_info = (unsigned long)&wwan_info,
907 }, {
908 	/* ZTE (Vodafone) K4510-Z */
909 	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1173, USB_CLASS_COMM,
910 				      USB_CDC_SUBCLASS_ETHERNET,
911 				      USB_CDC_PROTO_NONE),
912 	.driver_info = (unsigned long)&wwan_info,
913 }, {
914 	/* ZTE (Vodafone) K3770-Z */
915 	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1177, USB_CLASS_COMM,
916 				      USB_CDC_SUBCLASS_ETHERNET,
917 				      USB_CDC_PROTO_NONE),
918 	.driver_info = (unsigned long)&wwan_info,
919 }, {
920 	/* ZTE (Vodafone) K3772-Z */
921 	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1181, USB_CLASS_COMM,
922 				      USB_CDC_SUBCLASS_ETHERNET,
923 				      USB_CDC_PROTO_NONE),
924 	.driver_info = (unsigned long)&wwan_info,
925 }, {
926 	/* Telit modules */
927 	USB_VENDOR_AND_INTERFACE_INFO(0x1bc7, USB_CLASS_COMM,
928 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
929 	.driver_info = (kernel_ulong_t) &wwan_info,
930 }, {
931 	/* Dell DW5580 modules */
932 	USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x81ba, USB_CLASS_COMM,
933 			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
934 	.driver_info = (kernel_ulong_t)&wwan_info,
935 }, {
936 	/* Huawei ME906 and ME909 */
937 	USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, 0x15c1, USB_CLASS_COMM,
938 				      USB_CDC_SUBCLASS_ETHERNET,
939 				      USB_CDC_PROTO_NONE),
940 	.driver_info = (unsigned long)&wwan_info,
941 }, {
942 	/* ZTE modules */
943 	USB_VENDOR_AND_INTERFACE_INFO(ZTE_VENDOR_ID, USB_CLASS_COMM,
944 				      USB_CDC_SUBCLASS_ETHERNET,
945 				      USB_CDC_PROTO_NONE),
946 	.driver_info = (unsigned long)&zte_cdc_info,
947 }, {
948 	/* U-blox TOBY-L2 */
949 	USB_DEVICE_AND_INTERFACE_INFO(UBLOX_VENDOR_ID, 0x1143, USB_CLASS_COMM,
950 				      USB_CDC_SUBCLASS_ETHERNET,
951 				      USB_CDC_PROTO_NONE),
952 	.driver_info = (unsigned long)&wwan_info,
953 }, {
954 	/* U-blox SARA-U2 */
955 	USB_DEVICE_AND_INTERFACE_INFO(UBLOX_VENDOR_ID, 0x1104, USB_CLASS_COMM,
956 				      USB_CDC_SUBCLASS_ETHERNET,
957 				      USB_CDC_PROTO_NONE),
958 	.driver_info = (unsigned long)&wwan_info,
959 }, {
960 	/* Cinterion PLS8 modem by GEMALTO */
961 	USB_DEVICE_AND_INTERFACE_INFO(0x1e2d, 0x0061, USB_CLASS_COMM,
962 				      USB_CDC_SUBCLASS_ETHERNET,
963 				      USB_CDC_PROTO_NONE),
964 	.driver_info = (unsigned long)&wwan_info,
965 }, {
966 	/* Cinterion AHS3 modem by GEMALTO */
967 	USB_DEVICE_AND_INTERFACE_INFO(0x1e2d, 0x0055, USB_CLASS_COMM,
968 				      USB_CDC_SUBCLASS_ETHERNET,
969 				      USB_CDC_PROTO_NONE),
970 	.driver_info = (unsigned long)&wwan_info,
971 }, {
972 	/* Cinterion PLS83/PLS63 modem by GEMALTO/THALES */
973 	USB_DEVICE_AND_INTERFACE_INFO(0x1e2d, 0x0069, USB_CLASS_COMM,
974 				      USB_CDC_SUBCLASS_ETHERNET,
975 				      USB_CDC_PROTO_NONE),
976 	.driver_info = (unsigned long)&wwan_info,
977 }, {
978 	USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
979 			USB_CDC_PROTO_NONE),
980 	.driver_info = (unsigned long) &cdc_info,
981 }, {
982 	USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
983 			USB_CDC_PROTO_NONE),
984 	.driver_info = (unsigned long)&wwan_info,
985 
986 }, {
987 	/* Various Huawei modems with a network port like the UMG1831 */
988 	USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_COMM,
989 				      USB_CDC_SUBCLASS_ETHERNET, 255),
990 	.driver_info = (unsigned long)&wwan_info,
991 },
992 	{ },		/* END */
993 };
994 MODULE_DEVICE_TABLE(usb, products);
995 
996 static struct usb_driver cdc_driver = {
997 	.name =		"cdc_ether",
998 	.id_table =	products,
999 	.probe =	usbnet_probe,
1000 	.disconnect =	usbnet_disconnect,
1001 	.suspend =	usbnet_suspend,
1002 	.resume =	usbnet_resume,
1003 	.reset_resume =	usbnet_resume,
1004 	.supports_autosuspend = 1,
1005 	.disable_hub_initiated_lpm = 1,
1006 };
1007 
1008 module_usb_driver(cdc_driver);
1009 
1010 MODULE_AUTHOR("David Brownell");
1011 MODULE_DESCRIPTION("USB CDC Ethernet devices");
1012 MODULE_LICENSE("GPL");
1013