Linux Audio

Check our new training course

Loading...
v3.15
  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
 36static 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
 43static 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
 50static 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
 65static 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/* probes control interface, claims data interface, collects the bulk
 
 71 * endpoints, activates data interface (if needed), maybe sets MTU.
 72 * all pure cdc, except for certain firmware workarounds, and knowing
 73 * that rndis uses one different rule.
 74 */
 75int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
 76{
 77	u8				*buf = intf->cur_altsetting->extra;
 78	int				len = intf->cur_altsetting->extralen;
 79	struct usb_interface_descriptor	*d;
 80	struct cdc_state		*info = (void *) &dev->data;
 81	int				status;
 82	int				rndis;
 83	bool				android_rndis_quirk = false;
 84	struct usb_driver		*driver = driver_of(intf);
 85	struct usb_cdc_mdlm_desc	*desc = NULL;
 86	struct usb_cdc_mdlm_detail_desc *detail = NULL;
 87
 88	if (sizeof(dev->data) < sizeof(*info))
 89		return -EDOM;
 90
 91	/* expect strict spec conformance for the descriptors, but
 92	 * cope with firmware which stores them in the wrong place
 93	 */
 94	if (len == 0 && dev->udev->actconfig->extralen) {
 95		/* Motorola SB4100 (and others: Brad Hards says it's
 96		 * from a Broadcom design) put CDC descriptors here
 97		 */
 98		buf = dev->udev->actconfig->extra;
 99		len = dev->udev->actconfig->extralen;
100		dev_dbg(&intf->dev, "CDC descriptors on config\n");
101	}
102
103	/* Maybe CDC descriptors are after the endpoint?  This bug has
104	 * been seen on some 2Wire Inc RNDIS-ish products.
105	 */
106	if (len == 0) {
107		struct usb_host_endpoint	*hep;
108
109		hep = intf->cur_altsetting->endpoint;
110		if (hep) {
111			buf = hep->extra;
112			len = hep->extralen;
113		}
114		if (len)
115			dev_dbg(&intf->dev,
116				"CDC descriptors on endpoint\n");
117	}
118
119	/* this assumes that if there's a non-RNDIS vendor variant
120	 * of cdc-acm, it'll fail RNDIS requests cleanly.
121	 */
122	rndis = (is_rndis(&intf->cur_altsetting->desc) ||
123		 is_activesync(&intf->cur_altsetting->desc) ||
124		 is_wireless_rndis(&intf->cur_altsetting->desc));
125
126	memset(info, 0, sizeof(*info));
127	info->control = intf;
128	while (len > 3) {
129		if (buf[1] != USB_DT_CS_INTERFACE)
130			goto next_desc;
131
132		/* use bDescriptorSubType to identify the CDC descriptors.
133		 * We expect devices with CDC header and union descriptors.
134		 * For CDC Ethernet we need the ethernet descriptor.
135		 * For RNDIS, ignore two (pointless) CDC modem descriptors
136		 * in favor of a complicated OID-based RPC scheme doing what
137		 * CDC Ethernet achieves with a simple descriptor.
138		 */
139		switch (buf[2]) {
140		case USB_CDC_HEADER_TYPE:
141			if (info->header) {
142				dev_dbg(&intf->dev, "extra CDC header\n");
143				goto bad_desc;
144			}
145			info->header = (void *) buf;
146			if (info->header->bLength != sizeof(*info->header)) {
147				dev_dbg(&intf->dev, "CDC header len %u\n",
148					info->header->bLength);
149				goto bad_desc;
150			}
151			break;
152		case USB_CDC_ACM_TYPE:
153			/* paranoia:  disambiguate a "real" vendor-specific
154			 * modem interface from an RNDIS non-modem.
155			 */
156			if (rndis) {
157				struct usb_cdc_acm_descriptor *acm;
158
159				acm = (void *) buf;
160				if (acm->bmCapabilities) {
161					dev_dbg(&intf->dev,
162						"ACM capabilities %02x, "
163						"not really RNDIS?\n",
164						acm->bmCapabilities);
165					goto bad_desc;
166				}
167			}
168			break;
169		case USB_CDC_UNION_TYPE:
170			if (info->u) {
171				dev_dbg(&intf->dev, "extra CDC union\n");
172				goto bad_desc;
173			}
174			info->u = (void *) buf;
175			if (info->u->bLength != sizeof(*info->u)) {
176				dev_dbg(&intf->dev, "CDC union len %u\n",
177					info->u->bLength);
178				goto bad_desc;
179			}
180
181			/* we need a master/control interface (what we're
182			 * probed with) and a slave/data interface; union
183			 * descriptors sort this all out.
184			 */
185			info->control = usb_ifnum_to_if(dev->udev,
186						info->u->bMasterInterface0);
187			info->data = usb_ifnum_to_if(dev->udev,
188						info->u->bSlaveInterface0);
189			if (!info->control || !info->data) {
190				dev_dbg(&intf->dev,
191					"master #%u/%p slave #%u/%p\n",
192					info->u->bMasterInterface0,
193					info->control,
194					info->u->bSlaveInterface0,
195					info->data);
196				/* fall back to hard-wiring for RNDIS */
197				if (rndis) {
198					android_rndis_quirk = true;
199					goto next_desc;
200				}
201				goto bad_desc;
202			}
203			if (info->control != intf) {
204				dev_dbg(&intf->dev, "bogus CDC Union\n");
205				/* Ambit USB Cable Modem (and maybe others)
206				 * interchanges master and slave interface.
207				 */
208				if (info->data == intf) {
209					info->data = info->control;
210					info->control = intf;
211				} else
212					goto bad_desc;
213			}
214
215			/* some devices merge these - skip class check */
216			if (info->control == info->data)
217				goto next_desc;
218
219			/* a data interface altsetting does the real i/o */
220			d = &info->data->cur_altsetting->desc;
221			if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
222				dev_dbg(&intf->dev, "slave class %u\n",
223					d->bInterfaceClass);
224				goto bad_desc;
225			}
226			break;
227		case USB_CDC_ETHERNET_TYPE:
228			if (info->ether) {
229				dev_dbg(&intf->dev, "extra CDC ether\n");
230				goto bad_desc;
231			}
232			info->ether = (void *) buf;
233			if (info->ether->bLength != sizeof(*info->ether)) {
234				dev_dbg(&intf->dev, "CDC ether len %u\n",
235					info->ether->bLength);
236				goto bad_desc;
237			}
238			dev->hard_mtu = le16_to_cpu(
239						info->ether->wMaxSegmentSize);
240			/* because of Zaurus, we may be ignoring the host
241			 * side link address we were given.
242			 */
243			break;
244		case USB_CDC_MDLM_TYPE:
245			if (desc) {
246				dev_dbg(&intf->dev, "extra MDLM descriptor\n");
247				goto bad_desc;
248			}
249
250			desc = (void *)buf;
251
252			if (desc->bLength != sizeof(*desc))
253				goto bad_desc;
254
255			if (memcmp(&desc->bGUID, mbm_guid, 16))
256				goto bad_desc;
257			break;
258		case USB_CDC_MDLM_DETAIL_TYPE:
259			if (detail) {
260				dev_dbg(&intf->dev, "extra MDLM detail descriptor\n");
261				goto bad_desc;
262			}
263
264			detail = (void *)buf;
265
266			if (detail->bGuidDescriptorType == 0) {
267				if (detail->bLength < (sizeof(*detail) + 1))
268					goto bad_desc;
269			} else
270				goto bad_desc;
271			break;
272		}
273next_desc:
274		len -= buf[0];	/* bLength */
275		buf += buf[0];
276	}
277
278	/* Microsoft ActiveSync based and some regular RNDIS devices lack the
279	 * CDC descriptors, so we'll hard-wire the interfaces and not check
280	 * for descriptors.
281	 *
282	 * Some Android RNDIS devices have a CDC Union descriptor pointing
283	 * to non-existing interfaces.  Ignore that and attempt the same
284	 * hard-wired 0 and 1 interfaces.
285	 */
286	if (rndis && (!info->u || android_rndis_quirk)) {
287		info->control = usb_ifnum_to_if(dev->udev, 0);
288		info->data = usb_ifnum_to_if(dev->udev, 1);
289		if (!info->control || !info->data || info->control != intf) {
290			dev_dbg(&intf->dev,
291				"rndis: master #0/%p slave #1/%p\n",
292				info->control,
293				info->data);
294			goto bad_desc;
295		}
296
297	} else if (!info->header || !info->u || (!rndis && !info->ether)) {
298		dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
299			info->header ? "" : "header ",
300			info->u ? "" : "union ",
301			info->ether ? "" : "ether ");
302		goto bad_desc;
303	}
304
305	/* claim data interface and set it up ... with side effects.
306	 * network traffic can't flow until an altsetting is enabled.
307	 */
308	if (info->data != info->control) {
309		status = usb_driver_claim_interface(driver, info->data, dev);
310		if (status < 0)
311			return status;
312	}
313	status = usbnet_get_endpoints(dev, info->data);
314	if (status < 0) {
315		/* ensure immediate exit from usbnet_disconnect */
316		usb_set_intfdata(info->data, NULL);
317		if (info->data != info->control)
318			usb_driver_release_interface(driver, info->data);
319		return status;
320	}
321
322	/* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
323	if (info->data != info->control)
324		dev->status = NULL;
325	if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
326		struct usb_endpoint_descriptor	*desc;
327
328		dev->status = &info->control->cur_altsetting->endpoint [0];
329		desc = &dev->status->desc;
330		if (!usb_endpoint_is_int_in(desc) ||
331		    (le16_to_cpu(desc->wMaxPacketSize)
332		     < sizeof(struct usb_cdc_notification)) ||
333		    !desc->bInterval) {
334			dev_dbg(&intf->dev, "bad notification endpoint\n");
335			dev->status = NULL;
336		}
337	}
338	if (rndis && !dev->status) {
339		dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
340		usb_set_intfdata(info->data, NULL);
341		usb_driver_release_interface(driver, info->data);
342		return -ENODEV;
343	}
344	return 0;
345
346bad_desc:
347	dev_info(&dev->udev->dev, "bad CDC descriptors\n");
348	return -ENODEV;
349}
350EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
351
352void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
353{
354	struct cdc_state		*info = (void *) &dev->data;
355	struct usb_driver		*driver = driver_of(intf);
356
357	/* combined interface - nothing  to do */
358	if (info->data == info->control)
359		return;
360
361	/* disconnect master --> disconnect slave */
362	if (intf == info->control && info->data) {
363		/* ensure immediate exit from usbnet_disconnect */
364		usb_set_intfdata(info->data, NULL);
365		usb_driver_release_interface(driver, info->data);
366		info->data = NULL;
367	}
368
369	/* and vice versa (just in case) */
370	else if (intf == info->data && info->control) {
371		/* ensure immediate exit from usbnet_disconnect */
372		usb_set_intfdata(info->control, NULL);
373		usb_driver_release_interface(driver, info->control);
374		info->control = NULL;
375	}
376}
377EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
378
379/* Communications Device Class, Ethernet Control model
 
 
380 *
381 * Takes two interfaces.  The DATA interface is inactive till an altsetting
382 * is selected.  Configuration data includes class descriptors.  There's
383 * an optional status endpoint on the control interface.
384 *
385 * This should interop with whatever the 2.4 "CDCEther.c" driver
386 * (by Brad Hards) talked with, with more functionality.
387 */
 
388
389static void dumpspeed(struct usbnet *dev, __le32 *speeds)
390{
391	netif_info(dev, timer, dev->net,
392		   "link speeds: %u kbps up, %u kbps down\n",
393		   __le32_to_cpu(speeds[0]) / 1000,
394		   __le32_to_cpu(speeds[1]) / 1000);
395}
396
397void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
398{
399	struct usb_cdc_notification	*event;
400
401	if (urb->actual_length < sizeof(*event))
402		return;
403
404	/* SPEED_CHANGE can get split into two 8-byte packets */
405	if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
406		dumpspeed(dev, (__le32 *) urb->transfer_buffer);
407		return;
408	}
409
410	event = urb->transfer_buffer;
411	switch (event->bNotificationType) {
412	case USB_CDC_NOTIFY_NETWORK_CONNECTION:
413		netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
414			  event->wValue ? "on" : "off");
415		usbnet_link_change(dev, !!event->wValue, 0);
 
 
 
416		break;
417	case USB_CDC_NOTIFY_SPEED_CHANGE:	/* tx/rx rates */
418		netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
419			  urb->actual_length);
420		if (urb->actual_length != (sizeof(*event) + 8))
421			set_bit(EVENT_STS_SPLIT, &dev->flags);
422		else
423			dumpspeed(dev, (__le32 *) &event[1]);
424		break;
425	/* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
426	 * but there are no standard formats for the response data.
427	 */
428	default:
429		netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
430			   event->bNotificationType);
431		break;
432	}
433}
434EXPORT_SYMBOL_GPL(usbnet_cdc_status);
435
436int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
437{
438	int				status;
439	struct cdc_state		*info = (void *) &dev->data;
440
441	BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
442			< sizeof(struct cdc_state)));
443
444	status = usbnet_generic_cdc_bind(dev, intf);
445	if (status < 0)
446		return status;
447
448	status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
449	if (status < 0) {
450		usb_set_intfdata(info->data, NULL);
451		usb_driver_release_interface(driver_of(intf), info->data);
452		return status;
453	}
454
455	/* FIXME cdc-ether has some multicast code too, though it complains
456	 * in routine cases.  info->ether describes the multicast support.
457	 * Implement that here, manipulating the cdc filter as needed.
458	 */
459	return 0;
460}
461EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
462
 
 
 
 
 
 
463static const struct driver_info	cdc_info = {
464	.description =	"CDC Ethernet Device",
465	.flags =	FLAG_ETHER | FLAG_POINTTOPOINT,
 
466	.bind =		usbnet_cdc_bind,
467	.unbind =	usbnet_cdc_unbind,
468	.status =	usbnet_cdc_status,
469	.manage_power =	usbnet_manage_power,
470};
471
472static const struct driver_info wwan_info = {
473	.description =	"Mobile Broadband Network Device",
474	.flags =	FLAG_WWAN,
475	.bind =		usbnet_cdc_bind,
476	.unbind =	usbnet_cdc_unbind,
477	.status =	usbnet_cdc_status,
478	.manage_power =	usbnet_manage_power,
479};
480
481/*-------------------------------------------------------------------------*/
482
483#define HUAWEI_VENDOR_ID	0x12D1
484#define NOVATEL_VENDOR_ID	0x1410
485#define ZTE_VENDOR_ID		0x19D2
486#define DELL_VENDOR_ID		0x413C
487#define REALTEK_VENDOR_ID	0x0bda
488#define SAMSUNG_VENDOR_ID	0x04e8
489
490static const struct usb_device_id	products[] = {
491/* BLACKLIST !!
 
492 *
493 * First blacklist any products that are egregiously nonconformant
494 * with the CDC Ethernet specs.  Minor braindamage we cope with; when
495 * they're not even trying, needing a separate driver is only the first
496 * of the differences to show up.
497 */
498
499#define	ZAURUS_MASTER_INTERFACE \
500	.bInterfaceClass	= USB_CLASS_COMM, \
501	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET, \
502	.bInterfaceProtocol	= USB_CDC_PROTO_NONE
503
504/* SA-1100 based Sharp Zaurus ("collie"), or compatible;
505 * wire-incompatible with true CDC Ethernet implementations.
506 * (And, it seems, needlessly so...)
507 */
508{
509	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
510			  | USB_DEVICE_ID_MATCH_DEVICE,
511	.idVendor		= 0x04DD,
512	.idProduct		= 0x8004,
513	ZAURUS_MASTER_INTERFACE,
514	.driver_info		= 0,
515},
516
517/* PXA-25x based Sharp Zaurii.  Note that it seems some of these
518 * (later models especially) may have shipped only with firmware
519 * advertising false "CDC MDLM" compatibility ... but we're not
520 * clear which models did that, so for now let's assume the worst.
521 */
522{
523	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
524			  | USB_DEVICE_ID_MATCH_DEVICE,
525	.idVendor		= 0x04DD,
526	.idProduct		= 0x8005,	/* A-300 */
527	ZAURUS_MASTER_INTERFACE,
528	.driver_info		= 0,
529}, {
530	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
531			  | USB_DEVICE_ID_MATCH_DEVICE,
532	.idVendor		= 0x04DD,
533	.idProduct		= 0x8006,	/* B-500/SL-5600 */
534	ZAURUS_MASTER_INTERFACE,
535	.driver_info		= 0,
536}, {
537	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
538			  | USB_DEVICE_ID_MATCH_DEVICE,
539	.idVendor		= 0x04DD,
540	.idProduct		= 0x8007,	/* C-700 */
541	ZAURUS_MASTER_INTERFACE,
542	.driver_info		= 0,
543}, {
544	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
545		 | USB_DEVICE_ID_MATCH_DEVICE,
546	.idVendor               = 0x04DD,
547	.idProduct              = 0x9031,	/* C-750 C-760 */
548	ZAURUS_MASTER_INTERFACE,
549	.driver_info		= 0,
550}, {
551	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
552		 | USB_DEVICE_ID_MATCH_DEVICE,
553	.idVendor               = 0x04DD,
554	.idProduct              = 0x9032,	/* SL-6000 */
555	ZAURUS_MASTER_INTERFACE,
556	.driver_info		= 0,
557}, {
558	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
559		 | USB_DEVICE_ID_MATCH_DEVICE,
560	.idVendor               = 0x04DD,
561	/* reported with some C860 units */
562	.idProduct              = 0x9050,	/* C-860 */
563	ZAURUS_MASTER_INTERFACE,
564	.driver_info		= 0,
565},
566
567/* Olympus has some models with a Zaurus-compatible option.
568 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
569 */
570{
571	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
572		 | USB_DEVICE_ID_MATCH_DEVICE,
573	.idVendor               = 0x07B4,
574	.idProduct              = 0x0F02,	/* R-1000 */
575	ZAURUS_MASTER_INTERFACE,
576	.driver_info		= 0,
577},
578
579/* LG Electronics VL600 wants additional headers on every frame */
580{
581	USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
582			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
583	.driver_info = 0,
584},
585
586/* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
587{
588	USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
589			USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
590	.driver_info		= 0,
591},
592
593/* Novatel USB551L and MC551 - handled by qmi_wwan */
594{
595	USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0xB001, USB_CLASS_COMM,
596			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
597	.driver_info = 0,
598},
599
600/* Novatel E362 - handled by qmi_wwan */
601{
602	USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9010, USB_CLASS_COMM,
603			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
604	.driver_info = 0,
605},
606
607/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
608{
609	USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8195, USB_CLASS_COMM,
610			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
611	.driver_info = 0,
612},
613
614/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
615{
616	USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8196, USB_CLASS_COMM,
617			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
618	.driver_info = 0,
619},
620
621/* Dell Wireless 5804 (Novatel E371) - handled by qmi_wwan */
622{
623	USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x819b, USB_CLASS_COMM,
624			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
625	.driver_info = 0,
626},
627
628/* Novatel Expedite E371 - handled by qmi_wwan */
629{
630	USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9011, USB_CLASS_COMM,
631			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
632	.driver_info = 0,
633},
634
635/* AnyDATA ADU960S - handled by qmi_wwan */
636{
637	USB_DEVICE_AND_INTERFACE_INFO(0x16d5, 0x650a, USB_CLASS_COMM,
638			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
639	.driver_info = 0,
640},
641
642/* Huawei E1820 - handled by qmi_wwan */
643{
644	USB_DEVICE_INTERFACE_NUMBER(HUAWEI_VENDOR_ID, 0x14ac, 1),
645	.driver_info = 0,
646},
647
648/* Realtek RTL8152 Based USB 2.0 Ethernet Adapters */
649{
650	USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8152, USB_CLASS_COMM,
651			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
652	.driver_info = 0,
653},
654
655/* Realtek RTL8153 Based USB 3.0 Ethernet Adapters */
656{
657	USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8153, USB_CLASS_COMM,
658			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
659	.driver_info = 0,
660},
661
662/* Samsung USB Ethernet Adapters */
663{
664	USB_DEVICE_AND_INTERFACE_INFO(SAMSUNG_VENDOR_ID, 0xa101, USB_CLASS_COMM,
665			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
666	.driver_info = 0,
667},
668
669/* WHITELIST!!!
670 *
671 * CDC Ether uses two interfaces, not necessarily consecutive.
672 * We match the main interface, ignoring the optional device
673 * class so we could handle devices that aren't exclusively
674 * CDC ether.
675 *
676 * NOTE:  this match must come AFTER entries blacklisting devices
677 * because of bugs/quirks in a given product (like Zaurus, above).
678 */
679{
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
680	/* ZTE (Vodafone) K3805-Z */
681	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1003, USB_CLASS_COMM,
682				      USB_CDC_SUBCLASS_ETHERNET,
683				      USB_CDC_PROTO_NONE),
 
 
 
 
 
684	.driver_info = (unsigned long)&wwan_info,
685}, {
686	/* ZTE (Vodafone) K3806-Z */
687	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1015, USB_CLASS_COMM,
688				      USB_CDC_SUBCLASS_ETHERNET,
689				      USB_CDC_PROTO_NONE),
 
 
 
 
 
690	.driver_info = (unsigned long)&wwan_info,
691}, {
692	/* ZTE (Vodafone) K4510-Z */
693	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1173, USB_CLASS_COMM,
694				      USB_CDC_SUBCLASS_ETHERNET,
695				      USB_CDC_PROTO_NONE),
 
 
 
 
 
696	.driver_info = (unsigned long)&wwan_info,
697}, {
698	/* ZTE (Vodafone) K3770-Z */
699	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1177, USB_CLASS_COMM,
700				      USB_CDC_SUBCLASS_ETHERNET,
701				      USB_CDC_PROTO_NONE),
 
 
 
 
 
702	.driver_info = (unsigned long)&wwan_info,
703}, {
704	/* ZTE (Vodafone) K3772-Z */
705	USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1181, USB_CLASS_COMM,
706				      USB_CDC_SUBCLASS_ETHERNET,
707				      USB_CDC_PROTO_NONE),
 
 
 
 
 
708	.driver_info = (unsigned long)&wwan_info,
709}, {
710	/* Telit modules */
711	USB_VENDOR_AND_INTERFACE_INFO(0x1bc7, USB_CLASS_COMM,
712			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
713	.driver_info = (kernel_ulong_t) &wwan_info,
714}, {
715	USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
716			USB_CDC_PROTO_NONE),
717	.driver_info = (unsigned long) &cdc_info,
718}, {
719	USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
720			USB_CDC_PROTO_NONE),
721	.driver_info = (unsigned long)&wwan_info,
722
723}, {
724	/* Various Huawei modems with a network port like the UMG1831 */
725	USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_COMM,
726				      USB_CDC_SUBCLASS_ETHERNET, 255),
 
 
 
 
727	.driver_info = (unsigned long)&wwan_info,
728},
729	{ },		/* END */
730};
731MODULE_DEVICE_TABLE(usb, products);
732
733static struct usb_driver cdc_driver = {
734	.name =		"cdc_ether",
735	.id_table =	products,
736	.probe =	usbnet_probe,
737	.disconnect =	usbnet_disconnect,
738	.suspend =	usbnet_suspend,
739	.resume =	usbnet_resume,
740	.reset_resume =	usbnet_resume,
741	.supports_autosuspend = 1,
742	.disable_hub_initiated_lpm = 1,
743};
744
745module_usb_driver(cdc_driver);
746
747MODULE_AUTHOR("David Brownell");
748MODULE_DESCRIPTION("USB CDC Ethernet devices");
749MODULE_LICENSE("GPL");
v3.5.6
  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, write to the Free Software
 18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 19 */
 20
 21// #define	DEBUG			// error path messages, extra info
 22// #define	VERBOSE			// more; success messages
 23
 24#include <linux/module.h>
 25#include <linux/init.h>
 26#include <linux/netdevice.h>
 27#include <linux/etherdevice.h>
 28#include <linux/ethtool.h>
 29#include <linux/workqueue.h>
 30#include <linux/mii.h>
 31#include <linux/usb.h>
 32#include <linux/usb/cdc.h>
 33#include <linux/usb/usbnet.h>
 34
 35
 36#if defined(CONFIG_USB_NET_RNDIS_HOST) || defined(CONFIG_USB_NET_RNDIS_HOST_MODULE)
 37
 38static int is_rndis(struct usb_interface_descriptor *desc)
 39{
 40	return (desc->bInterfaceClass == USB_CLASS_COMM &&
 41		desc->bInterfaceSubClass == 2 &&
 42		desc->bInterfaceProtocol == 0xff);
 43}
 44
 45static int is_activesync(struct usb_interface_descriptor *desc)
 46{
 47	return (desc->bInterfaceClass == USB_CLASS_MISC &&
 48		desc->bInterfaceSubClass == 1 &&
 49		desc->bInterfaceProtocol == 1);
 50}
 51
 52static int is_wireless_rndis(struct usb_interface_descriptor *desc)
 53{
 54	return (desc->bInterfaceClass == USB_CLASS_WIRELESS_CONTROLLER &&
 55		desc->bInterfaceSubClass == 1 &&
 56		desc->bInterfaceProtocol == 3);
 57}
 58
 59#else
 60
 61#define is_rndis(desc)		0
 62#define is_activesync(desc)	0
 63#define is_wireless_rndis(desc)	0
 64
 65#endif
 66
 67static const u8 mbm_guid[16] = {
 68	0xa3, 0x17, 0xa8, 0x8b, 0x04, 0x5e, 0x4f, 0x01,
 69	0xa6, 0x07, 0xc0, 0xff, 0xcb, 0x7e, 0x39, 0x2a,
 70};
 71
 72/*
 73 * probes control interface, claims data interface, collects the bulk
 74 * endpoints, activates data interface (if needed), maybe sets MTU.
 75 * all pure cdc, except for certain firmware workarounds, and knowing
 76 * that rndis uses one different rule.
 77 */
 78int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
 79{
 80	u8				*buf = intf->cur_altsetting->extra;
 81	int				len = intf->cur_altsetting->extralen;
 82	struct usb_interface_descriptor	*d;
 83	struct cdc_state		*info = (void *) &dev->data;
 84	int				status;
 85	int				rndis;
 86	bool				android_rndis_quirk = false;
 87	struct usb_driver		*driver = driver_of(intf);
 88	struct usb_cdc_mdlm_desc	*desc = NULL;
 89	struct usb_cdc_mdlm_detail_desc *detail = NULL;
 90
 91	if (sizeof dev->data < sizeof *info)
 92		return -EDOM;
 93
 94	/* expect strict spec conformance for the descriptors, but
 95	 * cope with firmware which stores them in the wrong place
 96	 */
 97	if (len == 0 && dev->udev->actconfig->extralen) {
 98		/* Motorola SB4100 (and others: Brad Hards says it's
 99		 * from a Broadcom design) put CDC descriptors here
100		 */
101		buf = dev->udev->actconfig->extra;
102		len = dev->udev->actconfig->extralen;
103		dev_dbg(&intf->dev, "CDC descriptors on config\n");
104	}
105
106	/* Maybe CDC descriptors are after the endpoint?  This bug has
107	 * been seen on some 2Wire Inc RNDIS-ish products.
108	 */
109	if (len == 0) {
110		struct usb_host_endpoint	*hep;
111
112		hep = intf->cur_altsetting->endpoint;
113		if (hep) {
114			buf = hep->extra;
115			len = hep->extralen;
116		}
117		if (len)
118			dev_dbg(&intf->dev,
119				"CDC descriptors on endpoint\n");
120	}
121
122	/* this assumes that if there's a non-RNDIS vendor variant
123	 * of cdc-acm, it'll fail RNDIS requests cleanly.
124	 */
125	rndis = (is_rndis(&intf->cur_altsetting->desc) ||
126		 is_activesync(&intf->cur_altsetting->desc) ||
127		 is_wireless_rndis(&intf->cur_altsetting->desc));
128
129	memset(info, 0, sizeof *info);
130	info->control = intf;
131	while (len > 3) {
132		if (buf [1] != USB_DT_CS_INTERFACE)
133			goto next_desc;
134
135		/* use bDescriptorSubType to identify the CDC descriptors.
136		 * We expect devices with CDC header and union descriptors.
137		 * For CDC Ethernet we need the ethernet descriptor.
138		 * For RNDIS, ignore two (pointless) CDC modem descriptors
139		 * in favor of a complicated OID-based RPC scheme doing what
140		 * CDC Ethernet achieves with a simple descriptor.
141		 */
142		switch (buf [2]) {
143		case USB_CDC_HEADER_TYPE:
144			if (info->header) {
145				dev_dbg(&intf->dev, "extra CDC header\n");
146				goto bad_desc;
147			}
148			info->header = (void *) buf;
149			if (info->header->bLength != sizeof *info->header) {
150				dev_dbg(&intf->dev, "CDC header len %u\n",
151					info->header->bLength);
152				goto bad_desc;
153			}
154			break;
155		case USB_CDC_ACM_TYPE:
156			/* paranoia:  disambiguate a "real" vendor-specific
157			 * modem interface from an RNDIS non-modem.
158			 */
159			if (rndis) {
160				struct usb_cdc_acm_descriptor *acm;
161
162				acm = (void *) buf;
163				if (acm->bmCapabilities) {
164					dev_dbg(&intf->dev,
165						"ACM capabilities %02x, "
166						"not really RNDIS?\n",
167						acm->bmCapabilities);
168					goto bad_desc;
169				}
170			}
171			break;
172		case USB_CDC_UNION_TYPE:
173			if (info->u) {
174				dev_dbg(&intf->dev, "extra CDC union\n");
175				goto bad_desc;
176			}
177			info->u = (void *) buf;
178			if (info->u->bLength != sizeof *info->u) {
179				dev_dbg(&intf->dev, "CDC union len %u\n",
180					info->u->bLength);
181				goto bad_desc;
182			}
183
184			/* we need a master/control interface (what we're
185			 * probed with) and a slave/data interface; union
186			 * descriptors sort this all out.
187			 */
188			info->control = usb_ifnum_to_if(dev->udev,
189						info->u->bMasterInterface0);
190			info->data = usb_ifnum_to_if(dev->udev,
191						info->u->bSlaveInterface0);
192			if (!info->control || !info->data) {
193				dev_dbg(&intf->dev,
194					"master #%u/%p slave #%u/%p\n",
195					info->u->bMasterInterface0,
196					info->control,
197					info->u->bSlaveInterface0,
198					info->data);
199				/* fall back to hard-wiring for RNDIS */
200				if (rndis) {
201					android_rndis_quirk = true;
202					goto next_desc;
203				}
204				goto bad_desc;
205			}
206			if (info->control != intf) {
207				dev_dbg(&intf->dev, "bogus CDC Union\n");
208				/* Ambit USB Cable Modem (and maybe others)
209				 * interchanges master and slave interface.
210				 */
211				if (info->data == intf) {
212					info->data = info->control;
213					info->control = intf;
214				} else
215					goto bad_desc;
216			}
217
 
 
 
 
218			/* a data interface altsetting does the real i/o */
219			d = &info->data->cur_altsetting->desc;
220			if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
221				dev_dbg(&intf->dev, "slave class %u\n",
222					d->bInterfaceClass);
223				goto bad_desc;
224			}
225			break;
226		case USB_CDC_ETHERNET_TYPE:
227			if (info->ether) {
228				dev_dbg(&intf->dev, "extra CDC ether\n");
229				goto bad_desc;
230			}
231			info->ether = (void *) buf;
232			if (info->ether->bLength != sizeof *info->ether) {
233				dev_dbg(&intf->dev, "CDC ether len %u\n",
234					info->ether->bLength);
235				goto bad_desc;
236			}
237			dev->hard_mtu = le16_to_cpu(
238						info->ether->wMaxSegmentSize);
239			/* because of Zaurus, we may be ignoring the host
240			 * side link address we were given.
241			 */
242			break;
243		case USB_CDC_MDLM_TYPE:
244			if (desc) {
245				dev_dbg(&intf->dev, "extra MDLM descriptor\n");
246				goto bad_desc;
247			}
248
249			desc = (void *)buf;
250
251			if (desc->bLength != sizeof(*desc))
252				goto bad_desc;
253
254			if (memcmp(&desc->bGUID, mbm_guid, 16))
255				goto bad_desc;
256			break;
257		case USB_CDC_MDLM_DETAIL_TYPE:
258			if (detail) {
259				dev_dbg(&intf->dev, "extra MDLM detail descriptor\n");
260				goto bad_desc;
261			}
262
263			detail = (void *)buf;
264
265			if (detail->bGuidDescriptorType == 0) {
266				if (detail->bLength < (sizeof(*detail) + 1))
267					goto bad_desc;
268			} else
269				goto bad_desc;
270			break;
271		}
272next_desc:
273		len -= buf [0];	/* bLength */
274		buf += buf [0];
275	}
276
277	/* Microsoft ActiveSync based and some regular RNDIS devices lack the
278	 * CDC descriptors, so we'll hard-wire the interfaces and not check
279	 * for descriptors.
280	 *
281	 * Some Android RNDIS devices have a CDC Union descriptor pointing
282	 * to non-existing interfaces.  Ignore that and attempt the same
283	 * hard-wired 0 and 1 interfaces.
284	 */
285	if (rndis && (!info->u || android_rndis_quirk)) {
286		info->control = usb_ifnum_to_if(dev->udev, 0);
287		info->data = usb_ifnum_to_if(dev->udev, 1);
288		if (!info->control || !info->data || info->control != intf) {
289			dev_dbg(&intf->dev,
290				"rndis: master #0/%p slave #1/%p\n",
291				info->control,
292				info->data);
293			goto bad_desc;
294		}
295
296	} else if (!info->header || !info->u || (!rndis && !info->ether)) {
297		dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
298			info->header ? "" : "header ",
299			info->u ? "" : "union ",
300			info->ether ? "" : "ether ");
301		goto bad_desc;
302	}
303
304	/* claim data interface and set it up ... with side effects.
305	 * network traffic can't flow until an altsetting is enabled.
306	 */
307	status = usb_driver_claim_interface(driver, info->data, dev);
308	if (status < 0)
309		return status;
 
 
310	status = usbnet_get_endpoints(dev, info->data);
311	if (status < 0) {
312		/* ensure immediate exit from usbnet_disconnect */
313		usb_set_intfdata(info->data, NULL);
314		usb_driver_release_interface(driver, info->data);
 
315		return status;
316	}
317
318	/* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
319	dev->status = NULL;
 
320	if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
321		struct usb_endpoint_descriptor	*desc;
322
323		dev->status = &info->control->cur_altsetting->endpoint [0];
324		desc = &dev->status->desc;
325		if (!usb_endpoint_is_int_in(desc) ||
326		    (le16_to_cpu(desc->wMaxPacketSize)
327		     < sizeof(struct usb_cdc_notification)) ||
328		    !desc->bInterval) {
329			dev_dbg(&intf->dev, "bad notification endpoint\n");
330			dev->status = NULL;
331		}
332	}
333	if (rndis && !dev->status) {
334		dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
335		usb_set_intfdata(info->data, NULL);
336		usb_driver_release_interface(driver, info->data);
337		return -ENODEV;
338	}
339	return 0;
340
341bad_desc:
342	dev_info(&dev->udev->dev, "bad CDC descriptors\n");
343	return -ENODEV;
344}
345EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
346
347void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
348{
349	struct cdc_state		*info = (void *) &dev->data;
350	struct usb_driver		*driver = driver_of(intf);
351
 
 
 
 
352	/* disconnect master --> disconnect slave */
353	if (intf == info->control && info->data) {
354		/* ensure immediate exit from usbnet_disconnect */
355		usb_set_intfdata(info->data, NULL);
356		usb_driver_release_interface(driver, info->data);
357		info->data = NULL;
358	}
359
360	/* and vice versa (just in case) */
361	else if (intf == info->data && info->control) {
362		/* ensure immediate exit from usbnet_disconnect */
363		usb_set_intfdata(info->control, NULL);
364		usb_driver_release_interface(driver, info->control);
365		info->control = NULL;
366	}
367}
368EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
369
370/*-------------------------------------------------------------------------
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
383static void dumpspeed(struct usbnet *dev, __le32 *speeds)
384{
385	netif_info(dev, timer, dev->net,
386		   "link speeds: %u kbps up, %u kbps down\n",
387		   __le32_to_cpu(speeds[0]) / 1000,
388		   __le32_to_cpu(speeds[1]) / 1000);
389}
390
391void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
392{
393	struct usb_cdc_notification	*event;
394
395	if (urb->actual_length < sizeof *event)
396		return;
397
398	/* SPEED_CHANGE can get split into two 8-byte packets */
399	if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
400		dumpspeed(dev, (__le32 *) urb->transfer_buffer);
401		return;
402	}
403
404	event = urb->transfer_buffer;
405	switch (event->bNotificationType) {
406	case USB_CDC_NOTIFY_NETWORK_CONNECTION:
407		netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
408			  event->wValue ? "on" : "off");
409		if (event->wValue)
410			netif_carrier_on(dev->net);
411		else
412			netif_carrier_off(dev->net);
413		break;
414	case USB_CDC_NOTIFY_SPEED_CHANGE:	/* tx/rx rates */
415		netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
416			  urb->actual_length);
417		if (urb->actual_length != (sizeof *event + 8))
418			set_bit(EVENT_STS_SPLIT, &dev->flags);
419		else
420			dumpspeed(dev, (__le32 *) &event[1]);
421		break;
422	/* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
423	 * but there are no standard formats for the response data.
424	 */
425	default:
426		netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
427			   event->bNotificationType);
428		break;
429	}
430}
431EXPORT_SYMBOL_GPL(usbnet_cdc_status);
432
433int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
434{
435	int				status;
436	struct cdc_state		*info = (void *) &dev->data;
437
438	BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
439			< sizeof(struct cdc_state)));
440
441	status = usbnet_generic_cdc_bind(dev, intf);
442	if (status < 0)
443		return status;
444
445	status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
446	if (status < 0) {
447		usb_set_intfdata(info->data, NULL);
448		usb_driver_release_interface(driver_of(intf), info->data);
449		return status;
450	}
451
452	/* FIXME cdc-ether has some multicast code too, though it complains
453	 * in routine cases.  info->ether describes the multicast support.
454	 * Implement that here, manipulating the cdc filter as needed.
455	 */
456	return 0;
457}
458EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
459
460static int cdc_manage_power(struct usbnet *dev, int on)
461{
462	dev->intf->needs_remote_wakeup = on;
463	return 0;
464}
465
466static const struct driver_info	cdc_info = {
467	.description =	"CDC Ethernet Device",
468	.flags =	FLAG_ETHER | FLAG_POINTTOPOINT,
469	// .check_connect = cdc_check_connect,
470	.bind =		usbnet_cdc_bind,
471	.unbind =	usbnet_cdc_unbind,
472	.status =	usbnet_cdc_status,
473	.manage_power =	cdc_manage_power,
474};
475
476static const struct driver_info wwan_info = {
477	.description =	"Mobile Broadband Network Device",
478	.flags =	FLAG_WWAN,
479	.bind =		usbnet_cdc_bind,
480	.unbind =	usbnet_cdc_unbind,
481	.status =	usbnet_cdc_status,
482	.manage_power =	cdc_manage_power,
483};
484
485/*-------------------------------------------------------------------------*/
486
487#define HUAWEI_VENDOR_ID	0x12D1
488#define NOVATEL_VENDOR_ID	0x1410
489#define ZTE_VENDOR_ID		0x19D2
 
 
 
490
491static const struct usb_device_id	products [] = {
492/*
493 * BLACKLIST !!
494 *
495 * First blacklist any products that are egregiously nonconformant
496 * with the CDC Ethernet specs.  Minor braindamage we cope with; when
497 * they're not even trying, needing a separate driver is only the first
498 * of the differences to show up.
499 */
500
501#define	ZAURUS_MASTER_INTERFACE \
502	.bInterfaceClass	= USB_CLASS_COMM, \
503	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET, \
504	.bInterfaceProtocol	= USB_CDC_PROTO_NONE
505
506/* SA-1100 based Sharp Zaurus ("collie"), or compatible;
507 * wire-incompatible with true CDC Ethernet implementations.
508 * (And, it seems, needlessly so...)
509 */
510{
511	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
512			  | USB_DEVICE_ID_MATCH_DEVICE,
513	.idVendor		= 0x04DD,
514	.idProduct		= 0x8004,
515	ZAURUS_MASTER_INTERFACE,
516	.driver_info		= 0,
517},
518
519/* PXA-25x based Sharp Zaurii.  Note that it seems some of these
520 * (later models especially) may have shipped only with firmware
521 * advertising false "CDC MDLM" compatibility ... but we're not
522 * clear which models did that, so for now let's assume the worst.
523 */
524{
525	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
526			  | USB_DEVICE_ID_MATCH_DEVICE,
527	.idVendor		= 0x04DD,
528	.idProduct		= 0x8005,	/* A-300 */
529	ZAURUS_MASTER_INTERFACE,
530	.driver_info		= 0,
531}, {
532	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
533			  | USB_DEVICE_ID_MATCH_DEVICE,
534	.idVendor		= 0x04DD,
535	.idProduct		= 0x8006,	/* B-500/SL-5600 */
536	ZAURUS_MASTER_INTERFACE,
537	.driver_info		= 0,
538}, {
539	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
540	          | USB_DEVICE_ID_MATCH_DEVICE,
541	.idVendor		= 0x04DD,
542	.idProduct		= 0x8007,	/* C-700 */
543	ZAURUS_MASTER_INTERFACE,
544	.driver_info		= 0,
545}, {
546	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
547		 | USB_DEVICE_ID_MATCH_DEVICE,
548	.idVendor               = 0x04DD,
549	.idProduct              = 0x9031,	/* C-750 C-760 */
550	ZAURUS_MASTER_INTERFACE,
551	.driver_info		= 0,
552}, {
553	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
554		 | USB_DEVICE_ID_MATCH_DEVICE,
555	.idVendor               = 0x04DD,
556	.idProduct              = 0x9032,	/* SL-6000 */
557	ZAURUS_MASTER_INTERFACE,
558	.driver_info		= 0,
559}, {
560	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
561		 | USB_DEVICE_ID_MATCH_DEVICE,
562	.idVendor               = 0x04DD,
563	/* reported with some C860 units */
564	.idProduct              = 0x9050,	/* C-860 */
565	ZAURUS_MASTER_INTERFACE,
566	.driver_info		= 0,
567},
568
569/* Olympus has some models with a Zaurus-compatible option.
570 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
571 */
572{
573	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
574		 | USB_DEVICE_ID_MATCH_DEVICE,
575	.idVendor               = 0x07B4,
576	.idProduct              = 0x0F02,	/* R-1000 */
577	ZAURUS_MASTER_INTERFACE,
578	.driver_info		= 0,
579},
580
581/* LG Electronics VL600 wants additional headers on every frame */
582{
583	USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
584			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
585	.driver_info = 0,
586},
587
588/* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
589{
590	USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
591			USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
592	.driver_info		= 0,
593},
594
595/*
596 * WHITELIST!!!
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
597 *
598 * CDC Ether uses two interfaces, not necessarily consecutive.
599 * We match the main interface, ignoring the optional device
600 * class so we could handle devices that aren't exclusively
601 * CDC ether.
602 *
603 * NOTE:  this match must come AFTER entries blacklisting devices
604 * because of bugs/quirks in a given product (like Zaurus, above).
605 */
606{
607	/* Novatel USB551L */
608	/* This match must come *before* the generic CDC-ETHER match so that
609	 * we get FLAG_WWAN set on the device, since it's descriptors are
610	 * generic CDC-ETHER.
611	 */
612	.match_flags    =   USB_DEVICE_ID_MATCH_VENDOR
613		 | USB_DEVICE_ID_MATCH_PRODUCT
614		 | USB_DEVICE_ID_MATCH_INT_INFO,
615	.idVendor               = NOVATEL_VENDOR_ID,
616	.idProduct		= 0xB001,
617	.bInterfaceClass	= USB_CLASS_COMM,
618	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET,
619	.bInterfaceProtocol	= USB_CDC_PROTO_NONE,
620	.driver_info = (unsigned long)&wwan_info,
621}, {
622	/* ZTE (Vodafone) K3805-Z */
623	.match_flags    =   USB_DEVICE_ID_MATCH_VENDOR
624		 | USB_DEVICE_ID_MATCH_PRODUCT
625		 | USB_DEVICE_ID_MATCH_INT_INFO,
626	.idVendor               = ZTE_VENDOR_ID,
627	.idProduct		= 0x1003,
628	.bInterfaceClass	= USB_CLASS_COMM,
629	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET,
630	.bInterfaceProtocol	= USB_CDC_PROTO_NONE,
631	.driver_info = (unsigned long)&wwan_info,
632}, {
633	/* ZTE (Vodafone) K3806-Z */
634	.match_flags    =   USB_DEVICE_ID_MATCH_VENDOR
635		 | USB_DEVICE_ID_MATCH_PRODUCT
636		 | USB_DEVICE_ID_MATCH_INT_INFO,
637	.idVendor               = ZTE_VENDOR_ID,
638	.idProduct		= 0x1015,
639	.bInterfaceClass	= USB_CLASS_COMM,
640	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET,
641	.bInterfaceProtocol	= USB_CDC_PROTO_NONE,
642	.driver_info = (unsigned long)&wwan_info,
643}, {
644	/* ZTE (Vodafone) K4510-Z */
645	.match_flags    =   USB_DEVICE_ID_MATCH_VENDOR
646		 | USB_DEVICE_ID_MATCH_PRODUCT
647		 | USB_DEVICE_ID_MATCH_INT_INFO,
648	.idVendor               = ZTE_VENDOR_ID,
649	.idProduct		= 0x1173,
650	.bInterfaceClass	= USB_CLASS_COMM,
651	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET,
652	.bInterfaceProtocol	= USB_CDC_PROTO_NONE,
653	.driver_info = (unsigned long)&wwan_info,
654}, {
655	/* ZTE (Vodafone) K3770-Z */
656	.match_flags    =   USB_DEVICE_ID_MATCH_VENDOR
657		 | USB_DEVICE_ID_MATCH_PRODUCT
658		 | USB_DEVICE_ID_MATCH_INT_INFO,
659	.idVendor               = ZTE_VENDOR_ID,
660	.idProduct		= 0x1177,
661	.bInterfaceClass	= USB_CLASS_COMM,
662	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET,
663	.bInterfaceProtocol	= USB_CDC_PROTO_NONE,
664	.driver_info = (unsigned long)&wwan_info,
665}, {
666	/* ZTE (Vodafone) K3772-Z */
667	.match_flags    =   USB_DEVICE_ID_MATCH_VENDOR
668		 | USB_DEVICE_ID_MATCH_PRODUCT
669		 | USB_DEVICE_ID_MATCH_INT_INFO,
670	.idVendor               = ZTE_VENDOR_ID,
671	.idProduct		= 0x1181,
672	.bInterfaceClass	= USB_CLASS_COMM,
673	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET,
674	.bInterfaceProtocol	= USB_CDC_PROTO_NONE,
675	.driver_info = (unsigned long)&wwan_info,
676}, {
 
 
 
 
 
677	USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
678			USB_CDC_PROTO_NONE),
679	.driver_info = (unsigned long) &cdc_info,
680}, {
681	USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
682			USB_CDC_PROTO_NONE),
683	.driver_info = (unsigned long)&wwan_info,
684
685}, {
686	/* Various Huawei modems with a network port like the UMG1831 */
687	.match_flags    =   USB_DEVICE_ID_MATCH_VENDOR
688		 | USB_DEVICE_ID_MATCH_INT_INFO,
689	.idVendor               = HUAWEI_VENDOR_ID,
690	.bInterfaceClass	= USB_CLASS_COMM,
691	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET,
692	.bInterfaceProtocol	= 255,
693	.driver_info = (unsigned long)&wwan_info,
694},
695	{ },		// END
696};
697MODULE_DEVICE_TABLE(usb, products);
698
699static struct usb_driver cdc_driver = {
700	.name =		"cdc_ether",
701	.id_table =	products,
702	.probe =	usbnet_probe,
703	.disconnect =	usbnet_disconnect,
704	.suspend =	usbnet_suspend,
705	.resume =	usbnet_resume,
706	.reset_resume =	usbnet_resume,
707	.supports_autosuspend = 1,
708	.disable_hub_initiated_lpm = 1,
709};
710
711module_usb_driver(cdc_driver);
712
713MODULE_AUTHOR("David Brownell");
714MODULE_DESCRIPTION("USB CDC Ethernet devices");
715MODULE_LICENSE("GPL");