2 * CDC Ethernet based networking peripherals
3 * Copyright (C) 2003-2005 by David Brownell
4 * Copyright (C) 2006 by Ole Andre Vadla Ravnas (ActiveSync)
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.
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.
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
21 // #define DEBUG // error path messages, extra info
22 // #define VERBOSE // more; success messages
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>
36 #if defined(CONFIG_USB_NET_RNDIS_HOST) || defined(CONFIG_USB_NET_RNDIS_HOST_MODULE)
38 static int is_rndis(struct usb_interface_descriptor *desc)
40 return (desc->bInterfaceClass == USB_CLASS_COMM &&
41 desc->bInterfaceSubClass == 2 &&
42 desc->bInterfaceProtocol == 0xff);
45 static int is_activesync(struct usb_interface_descriptor *desc)
47 return (desc->bInterfaceClass == USB_CLASS_MISC &&
48 desc->bInterfaceSubClass == 1 &&
49 desc->bInterfaceProtocol == 1);
52 static int is_wireless_rndis(struct usb_interface_descriptor *desc)
54 return (desc->bInterfaceClass == USB_CLASS_WIRELESS_CONTROLLER &&
55 desc->bInterfaceSubClass == 1 &&
56 desc->bInterfaceProtocol == 3);
61 #define is_rndis(desc) 0
62 #define is_activesync(desc) 0
63 #define is_wireless_rndis(desc) 0
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,
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.
78 int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
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;
86 struct usb_driver *driver = driver_of(intf);
87 struct usb_cdc_mdlm_desc *desc = NULL;
88 struct usb_cdc_mdlm_detail_desc *detail = NULL;
90 if (sizeof dev->data < sizeof *info)
93 /* expect strict spec conformance for the descriptors, but
94 * cope with firmware which stores them in the wrong place
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
100 buf = dev->udev->actconfig->extra;
101 len = dev->udev->actconfig->extralen;
102 dev_dbg(&intf->dev, "CDC descriptors on config\n");
105 /* Maybe CDC descriptors are after the endpoint? This bug has
106 * been seen on some 2Wire Inc RNDIS-ish products.
109 struct usb_host_endpoint *hep;
111 hep = intf->cur_altsetting->endpoint;
118 "CDC descriptors on endpoint\n");
121 /* this assumes that if there's a non-RNDIS vendor variant
122 * of cdc-acm, it'll fail RNDIS requests cleanly.
124 rndis = (is_rndis(&intf->cur_altsetting->desc) ||
125 is_activesync(&intf->cur_altsetting->desc) ||
126 is_wireless_rndis(&intf->cur_altsetting->desc));
128 memset(info, 0, sizeof *info);
129 info->control = intf;
131 if (buf [1] != USB_DT_CS_INTERFACE)
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.
142 case USB_CDC_HEADER_TYPE:
144 dev_dbg(&intf->dev, "extra CDC header\n");
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);
154 case USB_CDC_ACM_TYPE:
155 /* paranoia: disambiguate a "real" vendor-specific
156 * modem interface from an RNDIS non-modem.
159 struct usb_cdc_acm_descriptor *acm;
162 if (acm->bmCapabilities) {
164 "ACM capabilities %02x, "
165 "not really RNDIS?\n",
166 acm->bmCapabilities);
171 case USB_CDC_UNION_TYPE:
173 dev_dbg(&intf->dev, "extra CDC union\n");
176 info->u = (void *) buf;
177 if (info->u->bLength != sizeof *info->u) {
178 dev_dbg(&intf->dev, "CDC union len %u\n",
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.
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) {
193 "master #%u/%p slave #%u/%p\n",
194 info->u->bMasterInterface0,
196 info->u->bSlaveInterface0,
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.
205 if (info->data == intf) {
206 info->data = info->control;
207 info->control = intf;
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",
220 case USB_CDC_ETHERNET_TYPE:
222 dev_dbg(&intf->dev, "extra CDC ether\n");
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);
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.
237 case USB_CDC_MDLM_TYPE:
239 dev_dbg(&intf->dev, "extra MDLM descriptor\n");
245 if (desc->bLength != sizeof(*desc))
248 if (memcmp(&desc->bGUID, mbm_guid, 16))
251 case USB_CDC_MDLM_DETAIL_TYPE:
253 dev_dbg(&intf->dev, "extra MDLM detail descriptor\n");
257 detail = (void *)buf;
259 if (detail->bGuidDescriptorType == 0) {
260 if (detail->bLength < (sizeof(*detail) + 1))
267 len -= buf [0]; /* bLength */
271 /* Microsoft ActiveSync based and some regular RNDIS devices lack the
272 * CDC descriptors, so we'll hard-wire the interfaces and not check
275 if (rndis && !info->u) {
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) {
280 "rndis: master #0/%p slave #1/%p\n",
286 } else if (!info->header || !info->u || (!rndis && !info->ether)) {
287 dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
288 info->header ? "" : "header ",
289 info->u ? "" : "union ",
290 info->ether ? "" : "ether ");
294 /* claim data interface and set it up ... with side effects.
295 * network traffic can't flow until an altsetting is enabled.
297 status = usb_driver_claim_interface(driver, info->data, dev);
300 status = usbnet_get_endpoints(dev, info->data);
302 /* ensure immediate exit from usbnet_disconnect */
303 usb_set_intfdata(info->data, NULL);
304 usb_driver_release_interface(driver, info->data);
308 /* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
310 if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
311 struct usb_endpoint_descriptor *desc;
313 dev->status = &info->control->cur_altsetting->endpoint [0];
314 desc = &dev->status->desc;
315 if (!usb_endpoint_is_int_in(desc) ||
316 (le16_to_cpu(desc->wMaxPacketSize)
317 < sizeof(struct usb_cdc_notification)) ||
319 dev_dbg(&intf->dev, "bad notification endpoint\n");
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);
332 dev_info(&dev->udev->dev, "bad CDC descriptors\n");
335 EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
337 void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
339 struct cdc_state *info = (void *) &dev->data;
340 struct usb_driver *driver = driver_of(intf);
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);
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;
358 EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
360 /*-------------------------------------------------------------------------
362 * Communications Device Class, Ethernet Control model
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.
368 * This should interop with whatever the 2.4 "CDCEther.c" driver
369 * (by Brad Hards) talked with, with more functionality.
371 *-------------------------------------------------------------------------*/
373 static void dumpspeed(struct usbnet *dev, __le32 *speeds)
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);
381 void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
383 struct usb_cdc_notification *event;
385 if (urb->actual_length < sizeof *event)
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);
394 event = urb->transfer_buffer;
395 switch (event->bNotificationType) {
396 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
397 netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
398 event->wValue ? "on" : "off");
400 netif_carrier_on(dev->net);
402 netif_carrier_off(dev->net);
404 case USB_CDC_NOTIFY_SPEED_CHANGE: /* tx/rx rates */
405 netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
407 if (urb->actual_length != (sizeof *event + 8))
408 set_bit(EVENT_STS_SPLIT, &dev->flags);
410 dumpspeed(dev, (__le32 *) &event[1]);
412 /* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
413 * but there are no standard formats for the response data.
416 netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
417 event->bNotificationType);
421 EXPORT_SYMBOL_GPL(usbnet_cdc_status);
423 int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
426 struct cdc_state *info = (void *) &dev->data;
428 status = usbnet_generic_cdc_bind(dev, intf);
432 status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
434 usb_set_intfdata(info->data, NULL);
435 usb_driver_release_interface(driver_of(intf), info->data);
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.
445 EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
447 static int cdc_manage_power(struct usbnet *dev, int on)
449 dev->intf->needs_remote_wakeup = on;
453 static const struct driver_info cdc_info = {
454 .description = "CDC Ethernet Device",
456 // .check_connect = cdc_check_connect,
457 .bind = usbnet_cdc_bind,
458 .unbind = usbnet_cdc_unbind,
459 .status = usbnet_cdc_status,
460 .manage_power = cdc_manage_power,
463 static const struct driver_info mbm_info = {
464 .description = "Mobile Broadband Network Device",
466 .bind = usbnet_cdc_bind,
467 .unbind = usbnet_cdc_unbind,
468 .status = usbnet_cdc_status,
469 .manage_power = cdc_manage_power,
472 /*-------------------------------------------------------------------------*/
475 static const struct usb_device_id products [] = {
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.
485 #define ZAURUS_MASTER_INTERFACE \
486 .bInterfaceClass = USB_CLASS_COMM, \
487 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
488 .bInterfaceProtocol = USB_CDC_PROTO_NONE
490 /* SA-1100 based Sharp Zaurus ("collie"), or compatible;
491 * wire-incompatible with true CDC Ethernet implementations.
492 * (And, it seems, needlessly so...)
495 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
496 | USB_DEVICE_ID_MATCH_DEVICE,
499 ZAURUS_MASTER_INTERFACE,
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.
509 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
510 | USB_DEVICE_ID_MATCH_DEVICE,
512 .idProduct = 0x8005, /* A-300 */
513 ZAURUS_MASTER_INTERFACE,
516 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
517 | USB_DEVICE_ID_MATCH_DEVICE,
519 .idProduct = 0x8006, /* B-500/SL-5600 */
520 ZAURUS_MASTER_INTERFACE,
523 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
524 | USB_DEVICE_ID_MATCH_DEVICE,
526 .idProduct = 0x8007, /* C-700 */
527 ZAURUS_MASTER_INTERFACE,
530 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
531 | USB_DEVICE_ID_MATCH_DEVICE,
533 .idProduct = 0x9031, /* C-750 C-760 */
534 ZAURUS_MASTER_INTERFACE,
537 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
538 | USB_DEVICE_ID_MATCH_DEVICE,
540 .idProduct = 0x9032, /* SL-6000 */
541 ZAURUS_MASTER_INTERFACE,
544 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
545 | USB_DEVICE_ID_MATCH_DEVICE,
547 /* reported with some C860 units */
548 .idProduct = 0x9050, /* C-860 */
549 ZAURUS_MASTER_INTERFACE,
553 /* Olympus has some models with a Zaurus-compatible option.
554 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
557 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
558 | USB_DEVICE_ID_MATCH_DEVICE,
560 .idProduct = 0x0F02, /* R-1000 */
561 ZAURUS_MASTER_INTERFACE,
565 /* LG Electronics VL600 wants additional headers on every frame */
567 USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
568 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
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
580 * NOTE: this match must come AFTER entries blacklisting devices
581 * because of bugs/quirks in a given product (like Zaurus, above).
584 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
586 .driver_info = (unsigned long) &cdc_info,
588 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
590 .driver_info = (unsigned long)&mbm_info,
595 MODULE_DEVICE_TABLE(usb, products);
597 static struct usb_driver cdc_driver = {
599 .id_table = products,
600 .probe = usbnet_probe,
601 .disconnect = usbnet_disconnect,
602 .suspend = usbnet_suspend,
603 .resume = usbnet_resume,
604 .reset_resume = usbnet_resume,
605 .supports_autosuspend = 1,
609 static int __init cdc_init(void)
611 BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
612 < sizeof(struct cdc_state)));
614 return usb_register(&cdc_driver);
616 module_init(cdc_init);
618 static void __exit cdc_exit(void)
620 usb_deregister(&cdc_driver);
622 module_exit(cdc_exit);
624 MODULE_AUTHOR("David Brownell");
625 MODULE_DESCRIPTION("USB CDC Ethernet devices");
626 MODULE_LICENSE("GPL");