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