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 bool android_rndis_quirk = false;
87 struct usb_driver *driver = driver_of(intf);
88 struct usb_cdc_mdlm_desc *desc = NULL;
89 struct usb_cdc_mdlm_detail_desc *detail = NULL;
91 if (sizeof dev->data < sizeof *info)
94 /* expect strict spec conformance for the descriptors, but
95 * cope with firmware which stores them in the wrong place
97 if (len == 0 && dev->udev->actconfig->extralen) {
98 /* Motorola SB4100 (and others: Brad Hards says it's
99 * from a Broadcom design) put CDC descriptors here
101 buf = dev->udev->actconfig->extra;
102 len = dev->udev->actconfig->extralen;
103 dev_dbg(&intf->dev, "CDC descriptors on config\n");
106 /* Maybe CDC descriptors are after the endpoint? This bug has
107 * been seen on some 2Wire Inc RNDIS-ish products.
110 struct usb_host_endpoint *hep;
112 hep = intf->cur_altsetting->endpoint;
119 "CDC descriptors on endpoint\n");
122 /* this assumes that if there's a non-RNDIS vendor variant
123 * of cdc-acm, it'll fail RNDIS requests cleanly.
125 rndis = (is_rndis(&intf->cur_altsetting->desc) ||
126 is_activesync(&intf->cur_altsetting->desc) ||
127 is_wireless_rndis(&intf->cur_altsetting->desc));
129 memset(info, 0, sizeof *info);
130 info->control = intf;
132 if (buf [1] != USB_DT_CS_INTERFACE)
135 /* use bDescriptorSubType to identify the CDC descriptors.
136 * We expect devices with CDC header and union descriptors.
137 * For CDC Ethernet we need the ethernet descriptor.
138 * For RNDIS, ignore two (pointless) CDC modem descriptors
139 * in favor of a complicated OID-based RPC scheme doing what
140 * CDC Ethernet achieves with a simple descriptor.
143 case USB_CDC_HEADER_TYPE:
145 dev_dbg(&intf->dev, "extra CDC header\n");
148 info->header = (void *) buf;
149 if (info->header->bLength != sizeof *info->header) {
150 dev_dbg(&intf->dev, "CDC header len %u\n",
151 info->header->bLength);
155 case USB_CDC_ACM_TYPE:
156 /* paranoia: disambiguate a "real" vendor-specific
157 * modem interface from an RNDIS non-modem.
160 struct usb_cdc_acm_descriptor *acm;
163 if (acm->bmCapabilities) {
165 "ACM capabilities %02x, "
166 "not really RNDIS?\n",
167 acm->bmCapabilities);
172 case USB_CDC_UNION_TYPE:
174 dev_dbg(&intf->dev, "extra CDC union\n");
177 info->u = (void *) buf;
178 if (info->u->bLength != sizeof *info->u) {
179 dev_dbg(&intf->dev, "CDC union len %u\n",
184 /* we need a master/control interface (what we're
185 * probed with) and a slave/data interface; union
186 * descriptors sort this all out.
188 info->control = usb_ifnum_to_if(dev->udev,
189 info->u->bMasterInterface0);
190 info->data = usb_ifnum_to_if(dev->udev,
191 info->u->bSlaveInterface0);
192 if (!info->control || !info->data) {
194 "master #%u/%p slave #%u/%p\n",
195 info->u->bMasterInterface0,
197 info->u->bSlaveInterface0,
199 /* fall back to hard-wiring for RNDIS */
201 android_rndis_quirk = true;
206 if (info->control != intf) {
207 dev_dbg(&intf->dev, "bogus CDC Union\n");
208 /* Ambit USB Cable Modem (and maybe others)
209 * interchanges master and slave interface.
211 if (info->data == intf) {
212 info->data = info->control;
213 info->control = intf;
218 /* a data interface altsetting does the real i/o */
219 d = &info->data->cur_altsetting->desc;
220 if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
221 dev_dbg(&intf->dev, "slave class %u\n",
226 case USB_CDC_ETHERNET_TYPE:
228 dev_dbg(&intf->dev, "extra CDC ether\n");
231 info->ether = (void *) buf;
232 if (info->ether->bLength != sizeof *info->ether) {
233 dev_dbg(&intf->dev, "CDC ether len %u\n",
234 info->ether->bLength);
237 if (info->ether->wMaxSegmentSize)
238 dev->hard_mtu = le16_to_cpu(
239 info->ether->wMaxSegmentSize);
240 /* because of Zaurus, we may be ignoring the host
241 * side link address we were given.
244 case USB_CDC_MDLM_TYPE:
246 dev_dbg(&intf->dev, "extra MDLM descriptor\n");
252 if (desc->bLength != sizeof(*desc))
255 if (memcmp(&desc->bGUID, mbm_guid, 16))
258 case USB_CDC_MDLM_DETAIL_TYPE:
260 dev_dbg(&intf->dev, "extra MDLM detail descriptor\n");
264 detail = (void *)buf;
266 if (detail->bGuidDescriptorType == 0) {
267 if (detail->bLength < (sizeof(*detail) + 1))
274 len -= buf [0]; /* bLength */
278 /* Microsoft ActiveSync based and some regular RNDIS devices lack the
279 * CDC descriptors, so we'll hard-wire the interfaces and not check
282 * Some Android RNDIS devices have a CDC Union descriptor pointing
283 * to non-existing interfaces. Ignore that and attempt the same
284 * hard-wired 0 and 1 interfaces.
286 if (rndis && (!info->u || android_rndis_quirk)) {
287 info->control = usb_ifnum_to_if(dev->udev, 0);
288 info->data = usb_ifnum_to_if(dev->udev, 1);
289 if (!info->control || !info->data || info->control != intf) {
291 "rndis: master #0/%p slave #1/%p\n",
297 } else if (!info->header || !info->u || (!rndis && !info->ether)) {
298 dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
299 info->header ? "" : "header ",
300 info->u ? "" : "union ",
301 info->ether ? "" : "ether ");
305 /* claim data interface and set it up ... with side effects.
306 * network traffic can't flow until an altsetting is enabled.
308 status = usb_driver_claim_interface(driver, info->data, dev);
311 status = usbnet_get_endpoints(dev, info->data);
313 /* ensure immediate exit from usbnet_disconnect */
314 usb_set_intfdata(info->data, NULL);
315 usb_driver_release_interface(driver, info->data);
319 /* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
321 if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
322 struct usb_endpoint_descriptor *desc;
324 dev->status = &info->control->cur_altsetting->endpoint [0];
325 desc = &dev->status->desc;
326 if (!usb_endpoint_is_int_in(desc) ||
327 (le16_to_cpu(desc->wMaxPacketSize)
328 < sizeof(struct usb_cdc_notification)) ||
330 dev_dbg(&intf->dev, "bad notification endpoint\n");
334 if (rndis && !dev->status) {
335 dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
336 usb_set_intfdata(info->data, NULL);
337 usb_driver_release_interface(driver, info->data);
343 dev_info(&dev->udev->dev, "bad CDC descriptors\n");
346 EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
348 void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
350 struct cdc_state *info = (void *) &dev->data;
351 struct usb_driver *driver = driver_of(intf);
353 /* disconnect master --> disconnect slave */
354 if (intf == info->control && info->data) {
355 /* ensure immediate exit from usbnet_disconnect */
356 usb_set_intfdata(info->data, NULL);
357 usb_driver_release_interface(driver, info->data);
361 /* and vice versa (just in case) */
362 else if (intf == info->data && info->control) {
363 /* ensure immediate exit from usbnet_disconnect */
364 usb_set_intfdata(info->control, NULL);
365 usb_driver_release_interface(driver, info->control);
366 info->control = NULL;
369 EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
371 /*-------------------------------------------------------------------------
373 * Communications Device Class, Ethernet Control model
375 * Takes two interfaces. The DATA interface is inactive till an altsetting
376 * is selected. Configuration data includes class descriptors. There's
377 * an optional status endpoint on the control interface.
379 * This should interop with whatever the 2.4 "CDCEther.c" driver
380 * (by Brad Hards) talked with, with more functionality.
382 *-------------------------------------------------------------------------*/
384 static void dumpspeed(struct usbnet *dev, __le32 *speeds)
386 netif_info(dev, timer, dev->net,
387 "link speeds: %u kbps up, %u kbps down\n",
388 __le32_to_cpu(speeds[0]) / 1000,
389 __le32_to_cpu(speeds[1]) / 1000);
392 void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
394 struct usb_cdc_notification *event;
396 if (urb->actual_length < sizeof *event)
399 /* SPEED_CHANGE can get split into two 8-byte packets */
400 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
401 dumpspeed(dev, (__le32 *) urb->transfer_buffer);
405 event = urb->transfer_buffer;
406 switch (event->bNotificationType) {
407 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
408 netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
409 event->wValue ? "on" : "off");
411 netif_carrier_on(dev->net);
413 netif_carrier_off(dev->net);
415 case USB_CDC_NOTIFY_SPEED_CHANGE: /* tx/rx rates */
416 netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
418 if (urb->actual_length != (sizeof *event + 8))
419 set_bit(EVENT_STS_SPLIT, &dev->flags);
421 dumpspeed(dev, (__le32 *) &event[1]);
423 /* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
424 * but there are no standard formats for the response data.
427 netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
428 event->bNotificationType);
432 EXPORT_SYMBOL_GPL(usbnet_cdc_status);
434 int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
437 struct cdc_state *info = (void *) &dev->data;
439 status = usbnet_generic_cdc_bind(dev, intf);
443 status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
445 usb_set_intfdata(info->data, NULL);
446 usb_driver_release_interface(driver_of(intf), info->data);
450 /* FIXME cdc-ether has some multicast code too, though it complains
451 * in routine cases. info->ether describes the multicast support.
452 * Implement that here, manipulating the cdc filter as needed.
456 EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
458 static int cdc_manage_power(struct usbnet *dev, int on)
460 dev->intf->needs_remote_wakeup = on;
464 static const struct driver_info cdc_info = {
465 .description = "CDC Ethernet Device",
466 .flags = FLAG_ETHER | FLAG_POINTTOPOINT,
467 // .check_connect = cdc_check_connect,
468 .bind = usbnet_cdc_bind,
469 .unbind = usbnet_cdc_unbind,
470 .status = usbnet_cdc_status,
471 .manage_power = cdc_manage_power,
474 static const struct driver_info wwan_info = {
475 .description = "Mobile Broadband Network Device",
477 .bind = usbnet_cdc_bind,
478 .unbind = usbnet_cdc_unbind,
479 .status = usbnet_cdc_status,
480 .manage_power = cdc_manage_power,
483 /*-------------------------------------------------------------------------*/
485 #define HUAWEI_VENDOR_ID 0x12D1
486 #define NOVATEL_VENDOR_ID 0x1410
488 static const struct usb_device_id products [] = {
492 * First blacklist any products that are egregiously nonconformant
493 * with the CDC Ethernet specs. Minor braindamage we cope with; when
494 * they're not even trying, needing a separate driver is only the first
495 * of the differences to show up.
498 #define ZAURUS_MASTER_INTERFACE \
499 .bInterfaceClass = USB_CLASS_COMM, \
500 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
501 .bInterfaceProtocol = USB_CDC_PROTO_NONE
503 /* SA-1100 based Sharp Zaurus ("collie"), or compatible;
504 * wire-incompatible with true CDC Ethernet implementations.
505 * (And, it seems, needlessly so...)
508 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
509 | USB_DEVICE_ID_MATCH_DEVICE,
512 ZAURUS_MASTER_INTERFACE,
516 /* PXA-25x based Sharp Zaurii. Note that it seems some of these
517 * (later models especially) may have shipped only with firmware
518 * advertising false "CDC MDLM" compatibility ... but we're not
519 * clear which models did that, so for now let's assume the worst.
522 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
523 | USB_DEVICE_ID_MATCH_DEVICE,
525 .idProduct = 0x8005, /* A-300 */
526 ZAURUS_MASTER_INTERFACE,
529 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
530 | USB_DEVICE_ID_MATCH_DEVICE,
532 .idProduct = 0x8006, /* B-500/SL-5600 */
533 ZAURUS_MASTER_INTERFACE,
536 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
537 | USB_DEVICE_ID_MATCH_DEVICE,
539 .idProduct = 0x8007, /* C-700 */
540 ZAURUS_MASTER_INTERFACE,
543 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
544 | USB_DEVICE_ID_MATCH_DEVICE,
546 .idProduct = 0x9031, /* C-750 C-760 */
547 ZAURUS_MASTER_INTERFACE,
550 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
551 | USB_DEVICE_ID_MATCH_DEVICE,
553 .idProduct = 0x9032, /* SL-6000 */
554 ZAURUS_MASTER_INTERFACE,
557 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
558 | USB_DEVICE_ID_MATCH_DEVICE,
560 /* reported with some C860 units */
561 .idProduct = 0x9050, /* C-860 */
562 ZAURUS_MASTER_INTERFACE,
566 /* Olympus has some models with a Zaurus-compatible option.
567 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
570 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
571 | USB_DEVICE_ID_MATCH_DEVICE,
573 .idProduct = 0x0F02, /* R-1000 */
574 ZAURUS_MASTER_INTERFACE,
578 /* LG Electronics VL600 wants additional headers on every frame */
580 USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
581 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
585 /* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
587 USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
588 USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
595 * CDC Ether uses two interfaces, not necessarily consecutive.
596 * We match the main interface, ignoring the optional device
597 * class so we could handle devices that aren't exclusively
600 * NOTE: this match must come AFTER entries blacklisting devices
601 * because of bugs/quirks in a given product (like Zaurus, above).
604 /* Novatel USB551L */
605 /* This match must come *before* the generic CDC-ETHER match so that
606 * we get FLAG_WWAN set on the device, since it's descriptors are
609 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
610 | USB_DEVICE_ID_MATCH_PRODUCT
611 | USB_DEVICE_ID_MATCH_INT_INFO,
612 .idVendor = NOVATEL_VENDOR_ID,
614 .bInterfaceClass = USB_CLASS_COMM,
615 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
616 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
617 .driver_info = (unsigned long)&wwan_info,
620 USB_VENDOR_AND_INTERFACE_INFO(0x1bc7, USB_CLASS_COMM,
621 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
622 .driver_info = (kernel_ulong_t) &wwan_info,
624 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
626 .driver_info = (unsigned long) &cdc_info,
628 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
630 .driver_info = (unsigned long)&wwan_info,
633 /* Various Huawei modems with a network port like the UMG1831 */
634 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
635 | USB_DEVICE_ID_MATCH_INT_INFO,
636 .idVendor = HUAWEI_VENDOR_ID,
637 .bInterfaceClass = USB_CLASS_COMM,
638 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
639 .bInterfaceProtocol = 255,
640 .driver_info = (unsigned long)&wwan_info,
644 MODULE_DEVICE_TABLE(usb, products);
646 static struct usb_driver cdc_driver = {
648 .id_table = products,
649 .probe = usbnet_probe,
650 .disconnect = usbnet_disconnect,
651 .suspend = usbnet_suspend,
652 .resume = usbnet_resume,
653 .reset_resume = usbnet_resume,
654 .supports_autosuspend = 1,
658 static int __init cdc_init(void)
660 BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
661 < sizeof(struct cdc_state)));
663 return usb_register(&cdc_driver);
665 module_init(cdc_init);
667 static void __exit cdc_exit(void)
669 usb_deregister(&cdc_driver);
671 module_exit(cdc_exit);
673 MODULE_AUTHOR("David Brownell");
674 MODULE_DESCRIPTION("USB CDC Ethernet devices");
675 MODULE_LICENSE("GPL");