[deliverable/linux.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

static const u8 mbm_guid[16] = {
	0xa3, 0x17, 0xa8, 0x8b, 0x04, 0x5e, 0x4f, 0x01,
	0xa6, 0x07, 0xc0, 0xff, 0xcb, 0x7e, 0x39, 0x2a,
};

/*
 * 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);
	struct usb_cdc_mdlm_desc	*desc = NULL;
	struct usb_cdc_mdlm_detail_desc *detail = NULL;

	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;
		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;
		case USB_CDC_MDLM_TYPE:
			if (desc) {
				dev_dbg(&intf->dev, "extra MDLM descriptor\n");
				goto bad_desc;
			}

			desc = (void *)buf;

			if (desc->bLength != sizeof(*desc))
				goto bad_desc;

			if (memcmp(&desc->bGUID, mbm_guid, 16))
				goto bad_desc;
			break;
		case USB_CDC_MDLM_DETAIL_TYPE:
			if (detail) {
				dev_dbg(&intf->dev, "extra MDLM detail descriptor\n");
				goto bad_desc;
			}

			detail = (void *)buf;

			if (detail->bGuidDescriptorType == 0) {
				if (detail->bLength < (sizeof(*detail) + 1))
					goto bad_desc;
			} else
				goto bad_desc;
			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)
{
	netif_info(dev, timer, dev->net,
		   "link speeds: %u kbps up, %u kbps down\n",
		   __le32_to_cpu(speeds[0]) / 1000,
		   __le32_to_cpu(speeds[1]) / 1000);
}

void usbnet_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:
		netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
			  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 */
		netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
			  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:
		netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
			   event->bNotificationType);
		break;
	}
}
EXPORT_SYMBOL_GPL(usbnet_cdc_status);

int usbnet_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;
}
EXPORT_SYMBOL_GPL(usbnet_cdc_bind);

static int cdc_manage_power(struct usbnet *dev, int on)
{
	dev->intf->needs_remote_wakeup = on;
	return 0;
}

static const struct driver_info	cdc_info = {
	.description =	"CDC Ethernet Device",
	.flags =	FLAG_ETHER | FLAG_POINTTOPOINT,
	// .check_connect = cdc_check_connect,
	.bind =		usbnet_cdc_bind,
	.unbind =	usbnet_cdc_unbind,
	.status =	usbnet_cdc_status,
	.manage_power =	cdc_manage_power,
};

static const struct driver_info mbm_info = {
	.description =	"Mobile Broadband Network Device",
	.flags =	FLAG_WWAN,
	.bind =		usbnet_cdc_bind,
	.unbind =	usbnet_cdc_unbind,
	.status =	usbnet_cdc_status,
	.manage_power =	cdc_manage_power,
};

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


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,
},

/* LG Electronics VL600 wants additional headers on every frame */
{
	USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
			USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
	.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,
}, {
	USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
			USB_CDC_PROTO_NONE),
	.driver_info = (unsigned long)&mbm_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,
	.reset_resume =	usbnet_resume,
	.supports_autosuspend = 1,
};


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