[mirror_ubuntu-artful-kernel.git] / drivers / net / usb / cdc_ether.c

/*
 * CDC Ethernet based networking peripherals
 * Copyright (C) 2003-2005 by David Brownell
 * Copyright (C) 2006 by Ole Andre Vadla Ravnas (ActiveSync)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

// #define	DEBUG			// error path messages, extra info
// #define	VERBOSE			// more; success messages

#include <linux/module.h>
#include <linux/init.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/ethtool.h>
#include <linux/workqueue.h>
#include <linux/mii.h>
#include <linux/usb.h>
#include <linux/usb/cdc.h>
#include <linux/usb/usbnet.h>


#if defined(CONFIG_USB_NET_RNDIS_HOST) || defined(CONFIG_USB_NET_RNDIS_HOST_MODULE)

static int is_rndis(struct usb_interface_descriptor *desc)
{
	return desc->bInterfaceClass == USB_CLASS_COMM
		&& desc->bInterfaceSubClass == 2
		&& desc->bInterfaceProtocol == 0xff;
}

static int is_activesync(struct usb_interface_descriptor *desc)
{
	return desc->bInterfaceClass == USB_CLASS_MISC
		&& desc->bInterfaceSubClass == 1
		&& desc->bInterfaceProtocol == 1;
}

static int is_wireless_rndis(struct usb_interface_descriptor *desc)
{
	return desc->bInterfaceClass == USB_CLASS_WIRELESS_CONTROLLER
		&& desc->bInterfaceSubClass == 1
		&& desc->bInterfaceProtocol == 3;
}

#else

#define is_rndis(desc)		0
#define is_activesync(desc)	0
#define is_wireless_rndis(desc)	0

#endif

/*
 * probes control interface, claims data interface, collects the bulk
 * endpoints, activates data interface (if needed), maybe sets MTU.
 * all pure cdc, except for certain firmware workarounds, and knowing
 * that rndis uses one different rule.
 */
int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
{
	u8				*buf = intf->cur_altsetting->extra;
	int				len = intf->cur_altsetting->extralen;
	struct usb_interface_descriptor	*d;
	struct cdc_state		*info = (void *) &dev->data;
	int				status;
	int				rndis;
	struct usb_driver		*driver = driver_of(intf);

	if (sizeof dev->data < sizeof *info)
		return -EDOM;

	/* expect strict spec conformance for the descriptors, but
	 * cope with firmware which stores them in the wrong place
	 */
	if (len == 0 && dev->udev->actconfig->extralen) {
		/* Motorola SB4100 (and others: Brad Hards says it's
		 * from a Broadcom design) put CDC descriptors here
		 */
		buf = dev->udev->actconfig->extra;
		len = dev->udev->actconfig->extralen;
		if (len)
			dev_dbg(&intf->dev,
				"CDC descriptors on config\n");
	}

	/* Maybe CDC descriptors are after the endpoint?  This bug has
	 * been seen on some 2Wire Inc RNDIS-ish products.
	 */
	if (len == 0) {
		struct usb_host_endpoint	*hep;

		hep = intf->cur_altsetting->endpoint;
		if (hep) {
			buf = hep->extra;
			len = hep->extralen;
		}
		if (len)
			dev_dbg(&intf->dev,
				"CDC descriptors on endpoint\n");
	}

	/* this assumes that if there's a non-RNDIS vendor variant
	 * of cdc-acm, it'll fail RNDIS requests cleanly.
	 */
	rndis = is_rndis(&intf->cur_altsetting->desc)
		|| is_activesync(&intf->cur_altsetting->desc)
		|| is_wireless_rndis(&intf->cur_altsetting->desc);

	memset(info, 0, sizeof *info);
	info->control = intf;
	while (len > 3) {
		if (buf [1] != USB_DT_CS_INTERFACE)
			goto next_desc;

		/* use bDescriptorSubType to identify the CDC descriptors.
		 * We expect devices with CDC header and union descriptors.
		 * For CDC Ethernet we need the ethernet descriptor.
		 * For RNDIS, ignore two (pointless) CDC modem descriptors
		 * in favor of a complicated OID-based RPC scheme doing what
		 * CDC Ethernet achieves with a simple descriptor.
		 */
		switch (buf [2]) {
		case USB_CDC_HEADER_TYPE:
			if (info->header) {
				dev_dbg(&intf->dev, "extra CDC header\n");
				goto bad_desc;
			}
			info->header = (void *) buf;
			if (info->header->bLength != sizeof *info->header) {
				dev_dbg(&intf->dev, "CDC header len %u\n",
					info->header->bLength);
				goto bad_desc;
			}
			break;
		case USB_CDC_ACM_TYPE:
			/* paranoia:  disambiguate a "real" vendor-specific
			 * modem interface from an RNDIS non-modem.
			 */
			if (rndis) {
				struct usb_cdc_acm_descriptor *acm;

				acm = (void *) buf;
				if (acm->bmCapabilities) {
					dev_dbg(&intf->dev,
						"ACM capabilities %02x, "
						"not really RNDIS?\n",
						acm->bmCapabilities);
					goto bad_desc;
				}
			}
			break;
		case USB_CDC_UNION_TYPE:
			if (info->u) {
				dev_dbg(&intf->dev, "extra CDC union\n");
				goto bad_desc;
			}
			info->u = (void *) buf;
			if (info->u->bLength != sizeof *info->u) {
				dev_dbg(&intf->dev, "CDC union len %u\n",
					info->u->bLength);
				goto bad_desc;
			}

			/* we need a master/control interface (what we're
			 * probed with) and a slave/data interface; union
			 * descriptors sort this all out.
			 */
			info->control = usb_ifnum_to_if(dev->udev,
						info->u->bMasterInterface0);
			info->data = usb_ifnum_to_if(dev->udev,
						info->u->bSlaveInterface0);
			if (!info->control || !info->data) {
				dev_dbg(&intf->dev,
					"master #%u/%p slave #%u/%p\n",
					info->u->bMasterInterface0,
					info->control,
					info->u->bSlaveInterface0,
					info->data);
				goto bad_desc;
			}
			if (info->control != intf) {
				dev_dbg(&intf->dev, "bogus CDC Union\n");
				/* Ambit USB Cable Modem (and maybe others)
				 * interchanges master and slave interface.
				 */
				if (info->data == intf) {
					info->data = info->control;
					info->control = intf;
				} else
					goto bad_desc;
			}

			/* a data interface altsetting does the real i/o */
			d = &info->data->cur_altsetting->desc;
			if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
				dev_dbg(&intf->dev, "slave class %u\n",
					d->bInterfaceClass);
				goto bad_desc;
			}
			break;
		case USB_CDC_ETHERNET_TYPE:
			if (info->ether) {
				dev_dbg(&intf->dev, "extra CDC ether\n");
				goto bad_desc;
			}
			info->ether = (void *) buf;
			if (info->ether->bLength != sizeof *info->ether) {
				dev_dbg(&intf->dev, "CDC ether len %u\n",
					info->ether->bLength);
				goto bad_desc;
			}
			dev->hard_mtu = le16_to_cpu(
						info->ether->wMaxSegmentSize);
			/* because of Zaurus, we may be ignoring the host
			 * side link address we were given.
			 */
			break;
		}
next_desc:
		len -= buf [0];	/* bLength */
		buf += buf [0];
	}

	/* Microsoft ActiveSync based and some regular RNDIS devices lack the
	 * CDC descriptors, so we'll hard-wire the interfaces and not check
	 * for descriptors.
	 */
	if (rndis && !info->u) {
		info->control = usb_ifnum_to_if(dev->udev, 0);
		info->data = usb_ifnum_to_if(dev->udev, 1);
		if (!info->control || !info->data) {
			dev_dbg(&intf->dev,
				"rndis: master #0/%p slave #1/%p\n",
				info->control,
				info->data);
			goto bad_desc;
		}

	} else if (!info->header || !info->u || (!rndis && !info->ether)) {
		dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
			info->header ? "" : "header ",
			info->u ? "" : "union ",
			info->ether ? "" : "ether ");
		goto bad_desc;
	}

	/* claim data interface and set it up ... with side effects.
	 * network traffic can't flow until an altsetting is enabled.
	 */
	status = usb_driver_claim_interface(driver, info->data, dev);
	if (status < 0)
		return status;
	status = usbnet_get_endpoints(dev, info->data);
	if (status < 0) {
		/* ensure immediate exit from usbnet_disconnect */
		usb_set_intfdata(info->data, NULL);
		usb_driver_release_interface(driver, info->data);
		return status;
	}

	/* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
	dev->status = NULL;
	if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
		struct usb_endpoint_descriptor	*desc;

		dev->status = &info->control->cur_altsetting->endpoint [0];
		desc = &dev->status->desc;
		if (!usb_endpoint_is_int_in(desc)
				|| (le16_to_cpu(desc->wMaxPacketSize)
					< sizeof(struct usb_cdc_notification))
				|| !desc->bInterval) {
			dev_dbg(&intf->dev, "bad notification endpoint\n");
			dev->status = NULL;
		}
	}
	if (rndis && !dev->status) {
		dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
		usb_set_intfdata(info->data, NULL);
		usb_driver_release_interface(driver, info->data);
		return -ENODEV;
	}
	return 0;

bad_desc:
	dev_info(&dev->udev->dev, "bad CDC descriptors\n");
	return -ENODEV;
}
EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);

void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
{
	struct cdc_state		*info = (void *) &dev->data;
	struct usb_driver		*driver = driver_of(intf);

	/* disconnect master --> disconnect slave */
	if (intf == info->control && info->data) {
		/* ensure immediate exit from usbnet_disconnect */
		usb_set_intfdata(info->data, NULL);
		usb_driver_release_interface(driver, info->data);
		info->data = NULL;
	}

	/* and vice versa (just in case) */
	else if (intf == info->data && info->control) {
		/* ensure immediate exit from usbnet_disconnect */
		usb_set_intfdata(info->control, NULL);
		usb_driver_release_interface(driver, info->control);
		info->control = NULL;
	}
}
EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);

/*-------------------------------------------------------------------------
 *
 * Communications Device Class, Ethernet Control model
 *
 * Takes two interfaces.  The DATA interface is inactive till an altsetting
 * is selected.  Configuration data includes class descriptors.  There's
 * an optional status endpoint on the control interface.
 *
 * This should interop with whatever the 2.4 "CDCEther.c" driver
 * (by Brad Hards) talked with, with more functionality.
 *
 *-------------------------------------------------------------------------*/

static void dumpspeed(struct usbnet *dev, __le32 *speeds)
{
	if (netif_msg_timer(dev))
		devinfo(dev, "link speeds: %u kbps up, %u kbps down",
			__le32_to_cpu(speeds[0]) / 1000,
		__le32_to_cpu(speeds[1]) / 1000);
}

static void cdc_status(struct usbnet *dev, struct urb *urb)
{
	struct usb_cdc_notification	*event;

	if (urb->actual_length < sizeof *event)
		return;

	/* SPEED_CHANGE can get split into two 8-byte packets */
	if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
		dumpspeed(dev, (__le32 *) urb->transfer_buffer);
		return;
	}

	event = urb->transfer_buffer;
	switch (event->bNotificationType) {
	case USB_CDC_NOTIFY_NETWORK_CONNECTION:
		if (netif_msg_timer(dev))
			devdbg(dev, "CDC: carrier %s",
					event->wValue ? "on" : "off");
		if (event->wValue)
			netif_carrier_on(dev->net);
		else
			netif_carrier_off(dev->net);
		break;
	case USB_CDC_NOTIFY_SPEED_CHANGE:	/* tx/rx rates */
		if (netif_msg_timer(dev))
			devdbg(dev, "CDC: speed change (len %d)",
					urb->actual_length);
		if (urb->actual_length != (sizeof *event + 8))
			set_bit(EVENT_STS_SPLIT, &dev->flags);
		else
			dumpspeed(dev, (__le32 *) &event[1]);
		break;
	/* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
	 * but there are no standard formats for the response data.
	 */
	default:
		deverr(dev, "CDC: unexpected notification %02x!",
				 event->bNotificationType);
		break;
	}
}

static int cdc_bind(struct usbnet *dev, struct usb_interface *intf)
{
	int				status;
	struct cdc_state		*info = (void *) &dev->data;

	status = usbnet_generic_cdc_bind(dev, intf);
	if (status < 0)
		return status;

	status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
	if (status < 0) {
		usb_set_intfdata(info->data, NULL);
		usb_driver_release_interface(driver_of(intf), info->data);
		return status;
	}

	/* FIXME cdc-ether has some multicast code too, though it complains
	 * in routine cases.  info->ether describes the multicast support.
	 * Implement that here, manipulating the cdc filter as needed.
	 */
	return 0;
}

static const struct driver_info	cdc_info = {
	.description =	"CDC Ethernet Device",
	.flags =	FLAG_ETHER,
	// .check_connect = cdc_check_connect,
	.bind =		cdc_bind,
	.unbind =	usbnet_cdc_unbind,
	.status =	cdc_status,
};

/*-------------------------------------------------------------------------*/


static const struct usb_device_id	products [] = {
/*
 * BLACKLIST !!
 *
 * First blacklist any products that are egregiously nonconformant
 * with the CDC Ethernet specs.  Minor braindamage we cope with; when
 * they're not even trying, needing a separate driver is only the first
 * of the differences to show up.
 */

#define	ZAURUS_MASTER_INTERFACE \
	.bInterfaceClass	= USB_CLASS_COMM, \
	.bInterfaceSubClass	= USB_CDC_SUBCLASS_ETHERNET, \
	.bInterfaceProtocol	= USB_CDC_PROTO_NONE

/* SA-1100 based Sharp Zaurus ("collie"), or compatible;
 * wire-incompatible with true CDC Ethernet implementations.
 * (And, it seems, needlessly so...)
 */
{
	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
			  | USB_DEVICE_ID_MATCH_DEVICE,
	.idVendor		= 0x04DD,
	.idProduct		= 0x8004,
	ZAURUS_MASTER_INTERFACE,
	.driver_info		= 0,
},

/* PXA-25x based Sharp Zaurii.  Note that it seems some of these
 * (later models especially) may have shipped only with firmware
 * advertising false "CDC MDLM" compatibility ... but we're not
 * clear which models did that, so for now let's assume the worst.
 */
{
	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
			  | USB_DEVICE_ID_MATCH_DEVICE,
	.idVendor		= 0x04DD,
	.idProduct		= 0x8005,	/* A-300 */
	ZAURUS_MASTER_INTERFACE,
	.driver_info		= 0,
}, {
	.match_flags	=   USB_DEVICE_ID_MATCH_INT_INFO
			  | USB_DEVICE_ID_MATCH_DEVICE,
	.idVendor		= 0x04DD,
	.idProduct		= 0x8006,	/* B-500/SL-5600 */
	ZAURUS_MASTER_INTERFACE,
	.driver_info		= 0,
}, {
	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
	          | USB_DEVICE_ID_MATCH_DEVICE,
	.idVendor		= 0x04DD,
	.idProduct		= 0x8007,	/* C-700 */
	ZAURUS_MASTER_INTERFACE,
	.driver_info		= 0,
}, {
	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
		 | USB_DEVICE_ID_MATCH_DEVICE,
	.idVendor               = 0x04DD,
	.idProduct              = 0x9031,	/* C-750 C-760 */
	ZAURUS_MASTER_INTERFACE,
	.driver_info		= 0,
}, {
	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
		 | USB_DEVICE_ID_MATCH_DEVICE,
	.idVendor               = 0x04DD,
	.idProduct              = 0x9032,	/* SL-6000 */
	ZAURUS_MASTER_INTERFACE,
	.driver_info		= 0,
}, {
	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
		 | USB_DEVICE_ID_MATCH_DEVICE,
	.idVendor               = 0x04DD,
	/* reported with some C860 units */
	.idProduct              = 0x9050,	/* C-860 */
	ZAURUS_MASTER_INTERFACE,
	.driver_info		= 0,
},

/* Olympus has some models with a Zaurus-compatible option.
 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
 */
{
	.match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
		 | USB_DEVICE_ID_MATCH_DEVICE,
	.idVendor               = 0x07B4,
	.idProduct              = 0x0F02,	/* R-1000 */
	ZAURUS_MASTER_INTERFACE,
	.driver_info		= 0,
},

/*
 * WHITELIST!!!
 *
 * CDC Ether uses two interfaces, not necessarily consecutive.
 * We match the main interface, ignoring the optional device
 * class so we could handle devices that aren't exclusively
 * CDC ether.
 *
 * NOTE:  this match must come AFTER entries blacklisting devices
 * because of bugs/quirks in a given product (like Zaurus, above).
 */
{
	USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
			USB_CDC_PROTO_NONE),
	.driver_info = (unsigned long) &cdc_info,
}, {
	/* Ericsson F3507g */
	USB_DEVICE_AND_INTERFACE_INFO(0x0bdb, 0x1900, USB_CLASS_COMM,
			USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	.driver_info = (unsigned long) &cdc_info,
}, {
	/* Ericsson F3507g ver. 2 */
	USB_DEVICE_AND_INTERFACE_INFO(0x0bdb, 0x1902, USB_CLASS_COMM,
			USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	.driver_info = (unsigned long) &cdc_info,
}, {
	/* Ericsson F3607gw */
	USB_DEVICE_AND_INTERFACE_INFO(0x0bdb, 0x1904, USB_CLASS_COMM,
			USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	.driver_info = (unsigned long) &cdc_info,
}, {
	/* Ericsson F3307 */
	USB_DEVICE_AND_INTERFACE_INFO(0x0bdb, 0x1906, USB_CLASS_COMM,
			USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	.driver_info = (unsigned long) &cdc_info,
}, {
	/* Toshiba F3507g */
	USB_DEVICE_AND_INTERFACE_INFO(0x0930, 0x130b, USB_CLASS_COMM,
			USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	.driver_info = (unsigned long) &cdc_info,
}, {
	/* Dell F3507g */
	USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x8147, USB_CLASS_COMM,
			USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	.driver_info = (unsigned long) &cdc_info,
},
	{ },		// END
};
MODULE_DEVICE_TABLE(usb, products);

static struct usb_driver cdc_driver = {
	.name =		"cdc_ether",
	.id_table =	products,
	.probe =	usbnet_probe,
	.disconnect =	usbnet_disconnect,
	.suspend =	usbnet_suspend,
	.resume =	usbnet_resume,
};


static int __init cdc_init(void)
{
	BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
			< sizeof(struct cdc_state)));

 	return usb_register(&cdc_driver);
}
module_init(cdc_init);

static void __exit cdc_exit(void)
{
 	usb_deregister(&cdc_driver);
}
module_exit(cdc_exit);

MODULE_AUTHOR("David Brownell");
MODULE_DESCRIPTION("USB CDC Ethernet devices");
MODULE_LICENSE("GPL");
Commit	Line	Data
4324fd49 DB	1	/*
	2	* CDC Ethernet based networking peripherals
	3	* Copyright (C) 2003-2005 by David Brownell
ad55d71a	4	* Copyright (C) 2006 by Ole Andre Vadla Ravnas (ActiveSync)
4324fd49 DB	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
4324fd49	24	#include <linux/module.h>
4324fd49 DB	25	#include <linux/init.h>
	26	#include <linux/netdevice.h>
	27	#include <linux/etherdevice.h>
4324fd49 DB	28	#include <linux/ethtool.h>
	29	#include <linux/workqueue.h>
	30	#include <linux/mii.h>
	31	#include <linux/usb.h>
a8c28f23	32	#include <linux/usb/cdc.h>
3692e94f	33	#include <linux/usb/usbnet.h>
4324fd49 DB	34
4324fd49 DB	35
ad55d71a OAVR	36	#if defined(CONFIG_USB_NET_RNDIS_HOST) \|\| defined(CONFIG_USB_NET_RNDIS_HOST_MODULE)
	37
	38	static 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
	45	static 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
7e99eedd TB	52	static 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
ad55d71a OAVR	59	#else
	60
	61	#define is_rndis(desc) 0
	62	#define is_activesync(desc) 0
7e99eedd	63	#define is_wireless_rndis(desc) 0
ad55d71a OAVR	64
	65	#endif
	66
4324fd49 DB	67	/*
	68	* probes control interface, claims data interface, collects the bulk
	69	* endpoints, activates data interface (if needed), maybe sets MTU.
	70	* all pure cdc, except for certain firmware workarounds, and knowing
	71	* that rndis uses one different rule.
	72	*/
	73	int usbnet_generic_cdc_bind(struct usbnet dev, struct usb_interface intf)
	74	{
	75	u8 *buf = intf->cur_altsetting->extra;
	76	int len = intf->cur_altsetting->extralen;
	77	struct usb_interface_descriptor *d;
	78	struct cdc_state info = (void ) &dev->data;
	79	int status;
	80	int rndis;
	81	struct usb_driver *driver = driver_of(intf);
	82
	83	if (sizeof dev->data < sizeof *info)
	84	return -EDOM;
	85
	86	/* expect strict spec conformance for the descriptors, but
	87	* cope with firmware which stores them in the wrong place
	88	*/
	89	if (len == 0 && dev->udev->actconfig->extralen) {
	90	/* Motorola SB4100 (and others: Brad Hards says it's
	91	* from a Broadcom design) put CDC descriptors here
	92	*/
	93	buf = dev->udev->actconfig->extra;
	94	len = dev->udev->actconfig->extralen;
	95	if (len)
	96	dev_dbg(&intf->dev,
	97	"CDC descriptors on config\n");
	98	}
	99
4149b72e DB	100	/* Maybe CDC descriptors are after the endpoint? This bug has
	101	* been seen on some 2Wire Inc RNDIS-ish products.
	102	*/
	103	if (len == 0) {
	104	struct usb_host_endpoint *hep;
	105
	106	hep = intf->cur_altsetting->endpoint;
	107	if (hep) {
	108	buf = hep->extra;
	109	len = hep->extralen;
	110	}
	111	if (len)
	112	dev_dbg(&intf->dev,
	113	"CDC descriptors on endpoint\n");
	114	}
	115
4324fd49 DB	116	/* this assumes that if there's a non-RNDIS vendor variant
	117	* of cdc-acm, it'll fail RNDIS requests cleanly.
	118	*/
ad55d71a	119	rndis = is_rndis(&intf->cur_altsetting->desc)
7e99eedd TB	120	\|\| is_activesync(&intf->cur_altsetting->desc)
7e99eedd TB	121	\|\| is_wireless_rndis(&intf->cur_altsetting->desc);
4324fd49 DB	122
	123	memset(info, 0, sizeof *info);
	124	info->control = intf;
	125	while (len > 3) {
	126	if (buf [1] != USB_DT_CS_INTERFACE)
	127	goto next_desc;
	128
	129	/* use bDescriptorSubType to identify the CDC descriptors.
	130	* We expect devices with CDC header and union descriptors.
	131	* For CDC Ethernet we need the ethernet descriptor.
	132	* For RNDIS, ignore two (pointless) CDC modem descriptors
	133	* in favor of a complicated OID-based RPC scheme doing what
	134	* CDC Ethernet achieves with a simple descriptor.
	135	*/
	136	switch (buf [2]) {
	137	case USB_CDC_HEADER_TYPE:
	138	if (info->header) {
	139	dev_dbg(&intf->dev, "extra CDC header\n");
	140	goto bad_desc;
	141	}
	142	info->header = (void *) buf;
	143	if (info->header->bLength != sizeof *info->header) {
	144	dev_dbg(&intf->dev, "CDC header len %u\n",
	145	info->header->bLength);
	146	goto bad_desc;
	147	}
	148	break;
ad55d71a OAVR	149	case USB_CDC_ACM_TYPE:
	150	/* paranoia: disambiguate a "real" vendor-specific
	151	* modem interface from an RNDIS non-modem.
	152	*/
	153	if (rndis) {
afaee82c	154	struct usb_cdc_acm_descriptor *acm;
ad55d71a	155
afaee82c DB	156	acm = (void *) buf;
afaee82c DB	157	if (acm->bmCapabilities) {
ad55d71a OAVR	158	dev_dbg(&intf->dev,
	159	"ACM capabilities %02x, "
	160	"not really RNDIS?\n",
afaee82c	161	acm->bmCapabilities);
ad55d71a OAVR	162	goto bad_desc;
	163	}
	164	}
	165	break;
4324fd49 DB	166	case USB_CDC_UNION_TYPE:
	167	if (info->u) {
	168	dev_dbg(&intf->dev, "extra CDC union\n");
	169	goto bad_desc;
	170	}
	171	info->u = (void *) buf;
	172	if (info->u->bLength != sizeof *info->u) {
	173	dev_dbg(&intf->dev, "CDC union len %u\n",
	174	info->u->bLength);
	175	goto bad_desc;
	176	}
	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,
	183	info->u->bMasterInterface0);
	184	info->data = usb_ifnum_to_if(dev->udev,
	185	info->u->bSlaveInterface0);
	186	if (!info->control \|\| !info->data) {
	187	dev_dbg(&intf->dev,
	188	"master #%u/%p slave #%u/%p\n",
	189	info->u->bMasterInterface0,
	190	info->control,
	191	info->u->bSlaveInterface0,
	192	info->data);
	193	goto bad_desc;
	194	}
	195	if (info->control != intf) {
	196	dev_dbg(&intf->dev, "bogus CDC Union\n");
	197	/* Ambit USB Cable Modem (and maybe others)
	198	* interchanges master and slave interface.
	199	*/
	200	if (info->data == intf) {
	201	info->data = info->control;
	202	info->control = intf;
	203	} else
	204	goto bad_desc;
	205	}
	206
	207	/* a data interface altsetting does the real i/o */
	208	d = &info->data->cur_altsetting->desc;
	209	if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
	210	dev_dbg(&intf->dev, "slave class %u\n",
	211	d->bInterfaceClass);
	212	goto bad_desc;
	213	}
	214	break;
	215	case USB_CDC_ETHERNET_TYPE:
	216	if (info->ether) {
	217	dev_dbg(&intf->dev, "extra CDC ether\n");
	218	goto bad_desc;
	219	}
	220	info->ether = (void *) buf;
	221	if (info->ether->bLength != sizeof *info->ether) {
	222	dev_dbg(&intf->dev, "CDC ether len %u\n",
	223	info->ether->bLength);
	224	goto bad_desc;
	225	}
	226	dev->hard_mtu = le16_to_cpu(
	227	info->ether->wMaxSegmentSize);
	228	/* because of Zaurus, we may be ignoring the host
	229	* side link address we were given.
230	*/
231	break;
232	}
233	next_desc:
234	len -= buf [0]; /* bLength */
235	buf += buf [0];
236	}
237
786e3dfb BD	238	/* Microsoft ActiveSync based and some regular RNDIS devices lack the
	239	* CDC descriptors, so we'll hard-wire the interfaces and not check
	240	* for descriptors.
ad55d71a	241	*/
786e3dfb	242	if (rndis && !info->u) {
ad55d71a OAVR	243	info->control = usb_ifnum_to_if(dev->udev, 0);
	244	info->data = usb_ifnum_to_if(dev->udev, 1);
	245	if (!info->control \|\| !info->data) {
	246	dev_dbg(&intf->dev,
786e3dfb	247	"rndis: master #0/%p slave #1/%p\n",
ad55d71a OAVR	248	info->control,
	249	info->data);
	250	goto bad_desc;
	251	}
	252
	253	} else if (!info->header \|\| !info->u \|\| (!rndis && !info->ether)) {
4324fd49 DB	254	dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
	255	info->header ? "" : "header ",
	256	info->u ? "" : "union ",
	257	info->ether ? "" : "ether ");
	258	goto bad_desc;
	259	}
	260
	261	/* claim data interface and set it up ... with side effects.
	262	* network traffic can't flow until an altsetting is enabled.
	263	*/
	264	status = usb_driver_claim_interface(driver, info->data, dev);
	265	if (status < 0)
	266	return status;
	267	status = usbnet_get_endpoints(dev, info->data);
	268	if (status < 0) {
	269	/* ensure immediate exit from usbnet_disconnect */
	270	usb_set_intfdata(info->data, NULL);
	271	usb_driver_release_interface(driver, info->data);
	272	return status;
	273	}
	274
	275	/* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
	276	dev->status = NULL;
	277	if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
	278	struct usb_endpoint_descriptor *desc;
	279
	280	dev->status = &info->control->cur_altsetting->endpoint [0];
	281	desc = &dev->status->desc;
b333d5bf	282	if (!usb_endpoint_is_int_in(desc)
4324fd49 DB	283	\|\| (le16_to_cpu(desc->wMaxPacketSize)
	284	< sizeof(struct usb_cdc_notification))
	285	\|\| !desc->bInterval) {
	286	dev_dbg(&intf->dev, "bad notification endpoint\n");
	287	dev->status = NULL;
	288	}
	289	}
	290	if (rndis && !dev->status) {
	291	dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
	292	usb_set_intfdata(info->data, NULL);
	293	usb_driver_release_interface(driver, info->data);
	294	return -ENODEV;
	295	}
	296	return 0;
	297
	298	bad_desc:
	299	dev_info(&dev->udev->dev, "bad CDC descriptors\n");
	300	return -ENODEV;
	301	}
	302	EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
	303
	304	void usbnet_cdc_unbind(struct usbnet dev, struct usb_interface intf)
	305	{
	306	struct cdc_state info = (void ) &dev->data;
	307	struct usb_driver *driver = driver_of(intf);
	308
	309	/* disconnect master --> disconnect slave */
	310	if (intf == info->control && info->data) {
	311	/* ensure immediate exit from usbnet_disconnect */
	312	usb_set_intfdata(info->data, NULL);
	313	usb_driver_release_interface(driver, info->data);
	314	info->data = NULL;
	315	}
	316
	317	/* and vice versa (just in case) */
	318	else if (intf == info->data && info->control) {
	319	/* ensure immediate exit from usbnet_disconnect */
	320	usb_set_intfdata(info->control, NULL);
	321	usb_driver_release_interface(driver, info->control);
	322	info->control = NULL;
	323	}
	324	}
	325	EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
	326
4324fd49 DB	327	/*-------------------------------------------------------------------------
	328	*
	329	* Communications Device Class, Ethernet Control model
	330	*
	331	* Takes two interfaces. The DATA interface is inactive till an altsetting
	332	* is selected. Configuration data includes class descriptors. There's
	333	* an optional status endpoint on the control interface.
	334	*
	335	* This should interop with whatever the 2.4 "CDCEther.c" driver
	336	* (by Brad Hards) talked with, with more functionality.
	337	*
	338	-------------------------------------------------------------------------/
	339
	340	static void dumpspeed(struct usbnet dev, __le32 speeds)
	341	{
	342	if (netif_msg_timer(dev))
	343	devinfo(dev, "link speeds: %u kbps up, %u kbps down",
	344	__le32_to_cpu(speeds[0]) / 1000,
	345	__le32_to_cpu(speeds[1]) / 1000);
	346	}
	347
	348	static void cdc_status(struct usbnet dev, struct urb urb)
	349	{
	350	struct usb_cdc_notification *event;
	351
	352	if (urb->actual_length < sizeof *event)
	353	return;
	354
	355	/* SPEED_CHANGE can get split into two 8-byte packets */
	356	if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
	357	dumpspeed(dev, (__le32 *) urb->transfer_buffer);
	358	return;
	359	}
	360
	361	event = urb->transfer_buffer;
	362	switch (event->bNotificationType) {
	363	case USB_CDC_NOTIFY_NETWORK_CONNECTION:
	364	if (netif_msg_timer(dev))
	365	devdbg(dev, "CDC: carrier %s",
	366	event->wValue ? "on" : "off");
	367	if (event->wValue)
	368	netif_carrier_on(dev->net);
	369	else
	370	netif_carrier_off(dev->net);
	371	break;
	372	case USB_CDC_NOTIFY_SPEED_CHANGE: /* tx/rx rates */
	373	if (netif_msg_timer(dev))
	374	devdbg(dev, "CDC: speed change (len %d)",
	375	urb->actual_length);
	376	if (urb->actual_length != (sizeof *event + 8))
	377	set_bit(EVENT_STS_SPLIT, &dev->flags);
	378	else
	379	dumpspeed(dev, (__le32 *) &event[1]);
	380	break;
	381	/* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
	382	* but there are no standard formats for the response data.
	383	*/
	384	default:
	385	deverr(dev, "CDC: unexpected notification %02x!",
	386	event->bNotificationType);
	387	break;
	388	}
	389	}
	390
4324fd49 DB	391	static int cdc_bind(struct usbnet dev, struct usb_interface intf)
	392	{
	393	int status;
	394	struct cdc_state info = (void ) &dev->data;
	395
	396	status = usbnet_generic_cdc_bind(dev, intf);
	397	if (status < 0)
	398	return status;
	399
03ad032b	400	status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
4324fd49 DB	401	if (status < 0) {
	402	usb_set_intfdata(info->data, NULL);
	403	usb_driver_release_interface(driver_of(intf), info->data);
	404	return status;
	405	}
	406
	407	/* FIXME cdc-ether has some multicast code too, though it complains
	408	* in routine cases. info->ether describes the multicast support.
	409	* Implement that here, manipulating the cdc filter as needed.
	410	*/
	411	return 0;
	412	}
	413
	414	static const struct driver_info cdc_info = {
	415	.description = "CDC Ethernet Device",
	416	.flags = FLAG_ETHER,
	417	// .check_connect = cdc_check_connect,
	418	.bind = cdc_bind,
	419	.unbind = usbnet_cdc_unbind,
	420	.status = cdc_status,
	421	};
	422
	423	/-------------------------------------------------------------------------/
	424
	425
	426	static const struct usb_device_id products [] = {
	427	/*
	428	* BLACKLIST !!
	429	*
	430	* First blacklist any products that are egregiously nonconformant
	431	* with the CDC Ethernet specs. Minor braindamage we cope with; when
	432	* they're not even trying, needing a separate driver is only the first
	433	* of the differences to show up.
	434	*/
	435
	436	#define ZAURUS_MASTER_INTERFACE \
	437	.bInterfaceClass = USB_CLASS_COMM, \
	438	.bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
	439	.bInterfaceProtocol = USB_CDC_PROTO_NONE
	440
	441	/* SA-1100 based Sharp Zaurus ("collie"), or compatible;
	442	* wire-incompatible with true CDC Ethernet implementations.
	443	* (And, it seems, needlessly so...)
	444	*/
	445	{
	446	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO
	447	\| USB_DEVICE_ID_MATCH_DEVICE,
	448	.idVendor = 0x04DD,
	449	.idProduct = 0x8004,
	450	ZAURUS_MASTER_INTERFACE,
	451	.driver_info = 0,
	452	},
	453
	454	/* PXA-25x based Sharp Zaurii. Note that it seems some of these
	455	* (later models especially) may have shipped only with firmware
	456	* advertising false "CDC MDLM" compatibility ... but we're not
	457	* clear which models did that, so for now let's assume the worst.
	458	*/
	459	{
	460	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO
	461	\| USB_DEVICE_ID_MATCH_DEVICE,
	462	.idVendor = 0x04DD,
	463	.idProduct = 0x8005, /* A-300 */
	464	ZAURUS_MASTER_INTERFACE,
465	.driver_info = 0,
466	}, {
467	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO
468	\| USB_DEVICE_ID_MATCH_DEVICE,
469	.idVendor = 0x04DD,
470	.idProduct = 0x8006, /* B-500/SL-5600 */
471	ZAURUS_MASTER_INTERFACE,
472	.driver_info = 0,
473	}, {
474	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO
475	\| USB_DEVICE_ID_MATCH_DEVICE,
476	.idVendor = 0x04DD,
477	.idProduct = 0x8007, /* C-700 */
478	ZAURUS_MASTER_INTERFACE,
479	.driver_info = 0,
480	}, {
481	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO
482	\| USB_DEVICE_ID_MATCH_DEVICE,
483	.idVendor = 0x04DD,
484	.idProduct = 0x9031, /* C-750 C-760 */
485	ZAURUS_MASTER_INTERFACE,
486	.driver_info = 0,
487	}, {
488	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO
489	\| USB_DEVICE_ID_MATCH_DEVICE,
490	.idVendor = 0x04DD,
491	.idProduct = 0x9032, /* SL-6000 */
492	ZAURUS_MASTER_INTERFACE,
493	.driver_info = 0,
494	}, {
495	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO
496	\| USB_DEVICE_ID_MATCH_DEVICE,
497	.idVendor = 0x04DD,
498	/* reported with some C860 units */
499	.idProduct = 0x9050, /* C-860 */
500	ZAURUS_MASTER_INTERFACE,
501	.driver_info = 0,
502	},
503
efcaa205 DB	504	/* Olympus has some models with a Zaurus-compatible option.
	505	* R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
	506	*/
	507	{
	508	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO
	509	\| USB_DEVICE_ID_MATCH_DEVICE,
	510	.idVendor = 0x07B4,
	511	.idProduct = 0x0F02, /* R-1000 */
	512	ZAURUS_MASTER_INTERFACE,
	513	.driver_info = 0,
	514	},
	515
4324fd49 DB	516	/*
	517	* WHITELIST!!!
	518	*
	519	* CDC Ether uses two interfaces, not necessarily consecutive.
	520	* We match the main interface, ignoring the optional device
	521	* class so we could handle devices that aren't exclusively
	522	* CDC ether.
	523	*
	524	* NOTE: this match must come AFTER entries blacklisting devices
	525	* because of bugs/quirks in a given product (like Zaurus, above).
	526	*/
	527	{
	528	USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
	529	USB_CDC_PROTO_NONE),
	530	.driver_info = (unsigned long) &cdc_info,
cac477e8 BM	531	}, {
	532	/* Ericsson F3507g */
	533	USB_DEVICE_AND_INTERFACE_INFO(0x0bdb, 0x1900, USB_CLASS_COMM,
	534	USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	535	.driver_info = (unsigned long) &cdc_info,
68924920 JS	536	}, {
	537	/* Ericsson F3507g ver. 2 */
	538	USB_DEVICE_AND_INTERFACE_INFO(0x0bdb, 0x1902, USB_CLASS_COMM,
	539	USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	540	.driver_info = (unsigned long) &cdc_info,
	541	}, {
	542	/* Ericsson F3607gw */
	543	USB_DEVICE_AND_INTERFACE_INFO(0x0bdb, 0x1904, USB_CLASS_COMM,
	544	USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	545	.driver_info = (unsigned long) &cdc_info,
	546	}, {
	547	/* Ericsson F3307 */
	548	USB_DEVICE_AND_INTERFACE_INFO(0x0bdb, 0x1906, USB_CLASS_COMM,
	549	USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	550	.driver_info = (unsigned long) &cdc_info,
	551	}, {
	552	/* Toshiba F3507g */
	553	USB_DEVICE_AND_INTERFACE_INFO(0x0930, 0x130b, USB_CLASS_COMM,
	554	USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	555	.driver_info = (unsigned long) &cdc_info,
	556	}, {
	557	/* Dell F3507g */
	558	USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x8147, USB_CLASS_COMM,
	559	USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
	560	.driver_info = (unsigned long) &cdc_info,
4324fd49 DB	561	},
	562	{ }, // END
	563	};
	564	MODULE_DEVICE_TABLE(usb, products);
	565
	566	static struct usb_driver cdc_driver = {
4324fd49 DB	567	.name = "cdc_ether",
	568	.id_table = products,
	569	.probe = usbnet_probe,
	570	.disconnect = usbnet_disconnect,
	571	.suspend = usbnet_suspend,
	572	.resume = usbnet_resume,
	573	};
	574
	575
	576	static int __init cdc_init(void)
	577	{
f8ac232a	578	BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
4324fd49 DB	579	< sizeof(struct cdc_state)));
	580
	581	return usb_register(&cdc_driver);
	582	}
	583	module_init(cdc_init);
	584
	585	static void __exit cdc_exit(void)
	586	{
	587	usb_deregister(&cdc_driver);
	588	}
	589	module_exit(cdc_exit);
	590
	591	MODULE_AUTHOR("David Brownell");
	592	MODULE_DESCRIPTION("USB CDC Ethernet devices");
	593	MODULE_LICENSE("GPL");