Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * CDC Ethernet based networking peripherals
4 * Copyright (C) 2003-2005 by David Brownell
5 * Copyright (C) 2006 by Ole Andre Vadla Ravnas (ActiveSync)
6 */
7
8// #define DEBUG // error path messages, extra info
9// #define VERBOSE // more; success messages
10
11#include <linux/module.h>
12#include <linux/netdevice.h>
13#include <linux/etherdevice.h>
14#include <linux/ethtool.h>
15#include <linux/workqueue.h>
16#include <linux/mii.h>
17#include <linux/usb.h>
18#include <linux/usb/cdc.h>
19#include <linux/usb/usbnet.h>
20
21
22#if IS_ENABLED(CONFIG_USB_NET_RNDIS_HOST)
23
24static int is_rndis(struct usb_interface_descriptor *desc)
25{
26 return (desc->bInterfaceClass == USB_CLASS_COMM &&
27 desc->bInterfaceSubClass == 2 &&
28 desc->bInterfaceProtocol == 0xff);
29}
30
31static int is_activesync(struct usb_interface_descriptor *desc)
32{
33 return (desc->bInterfaceClass == USB_CLASS_MISC &&
34 desc->bInterfaceSubClass == 1 &&
35 desc->bInterfaceProtocol == 1);
36}
37
38static int is_wireless_rndis(struct usb_interface_descriptor *desc)
39{
40 return (desc->bInterfaceClass == USB_CLASS_WIRELESS_CONTROLLER &&
41 desc->bInterfaceSubClass == 1 &&
42 desc->bInterfaceProtocol == 3);
43}
44
45static int is_novatel_rndis(struct usb_interface_descriptor *desc)
46{
47 return (desc->bInterfaceClass == USB_CLASS_MISC &&
48 desc->bInterfaceSubClass == 4 &&
49 desc->bInterfaceProtocol == 1);
50}
51
52#else
53
54#define is_rndis(desc) 0
55#define is_activesync(desc) 0
56#define is_wireless_rndis(desc) 0
57#define is_novatel_rndis(desc) 0
58
59#endif
60
61static const u8 mbm_guid[16] = {
62 0xa3, 0x17, 0xa8, 0x8b, 0x04, 0x5e, 0x4f, 0x01,
63 0xa6, 0x07, 0xc0, 0xff, 0xcb, 0x7e, 0x39, 0x2a,
64};
65
66void usbnet_cdc_update_filter(struct usbnet *dev)
67{
68 struct net_device *net = dev->net;
69
70 u16 cdc_filter = USB_CDC_PACKET_TYPE_DIRECTED
71 | USB_CDC_PACKET_TYPE_BROADCAST;
72
73 /* filtering on the device is an optional feature and not worth
74 * the hassle so we just roughly care about snooping and if any
75 * multicast is requested, we take every multicast
76 */
77 if (net->flags & IFF_PROMISC)
78 cdc_filter |= USB_CDC_PACKET_TYPE_PROMISCUOUS;
79 if (!netdev_mc_empty(net) || (net->flags & IFF_ALLMULTI))
80 cdc_filter |= USB_CDC_PACKET_TYPE_ALL_MULTICAST;
81
82 usb_control_msg(dev->udev,
83 usb_sndctrlpipe(dev->udev, 0),
84 USB_CDC_SET_ETHERNET_PACKET_FILTER,
85 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
86 cdc_filter,
87 dev->intf->cur_altsetting->desc.bInterfaceNumber,
88 NULL,
89 0,
90 USB_CTRL_SET_TIMEOUT
91 );
92}
93EXPORT_SYMBOL_GPL(usbnet_cdc_update_filter);
94
95/* We need to override usbnet_*_link_ksettings in bind() */
96static const struct ethtool_ops cdc_ether_ethtool_ops = {
97 .get_link = usbnet_get_link,
98 .nway_reset = usbnet_nway_reset,
99 .get_drvinfo = usbnet_get_drvinfo,
100 .get_msglevel = usbnet_get_msglevel,
101 .set_msglevel = usbnet_set_msglevel,
102 .get_ts_info = ethtool_op_get_ts_info,
103 .get_link_ksettings = usbnet_get_link_ksettings_internal,
104 .set_link_ksettings = NULL,
105};
106
107/* probes control interface, claims data interface, collects the bulk
108 * endpoints, activates data interface (if needed), maybe sets MTU.
109 * all pure cdc, except for certain firmware workarounds, and knowing
110 * that rndis uses one different rule.
111 */
112int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
113{
114 u8 *buf = intf->cur_altsetting->extra;
115 int len = intf->cur_altsetting->extralen;
116 struct usb_interface_descriptor *d;
117 struct cdc_state *info = (void *) &dev->data;
118 int status;
119 int rndis;
120 bool android_rndis_quirk = false;
121 struct usb_driver *driver = driver_of(intf);
122 struct usb_cdc_parsed_header header;
123
124 if (sizeof(dev->data) < sizeof(*info))
125 return -EDOM;
126
127 /* expect strict spec conformance for the descriptors, but
128 * cope with firmware which stores them in the wrong place
129 */
130 if (len == 0 && dev->udev->actconfig->extralen) {
131 /* Motorola SB4100 (and others: Brad Hards says it's
132 * from a Broadcom design) put CDC descriptors here
133 */
134 buf = dev->udev->actconfig->extra;
135 len = dev->udev->actconfig->extralen;
136 dev_dbg(&intf->dev, "CDC descriptors on config\n");
137 }
138
139 /* Maybe CDC descriptors are after the endpoint? This bug has
140 * been seen on some 2Wire Inc RNDIS-ish products.
141 */
142 if (len == 0) {
143 struct usb_host_endpoint *hep;
144
145 hep = intf->cur_altsetting->endpoint;
146 if (hep) {
147 buf = hep->extra;
148 len = hep->extralen;
149 }
150 if (len)
151 dev_dbg(&intf->dev,
152 "CDC descriptors on endpoint\n");
153 }
154
155 /* this assumes that if there's a non-RNDIS vendor variant
156 * of cdc-acm, it'll fail RNDIS requests cleanly.
157 */
158 rndis = (is_rndis(&intf->cur_altsetting->desc) ||
159 is_activesync(&intf->cur_altsetting->desc) ||
160 is_wireless_rndis(&intf->cur_altsetting->desc) ||
161 is_novatel_rndis(&intf->cur_altsetting->desc));
162
163 memset(info, 0, sizeof(*info));
164 info->control = intf;
165
166 cdc_parse_cdc_header(&header, intf, buf, len);
167
168 info->u = header.usb_cdc_union_desc;
169 info->header = header.usb_cdc_header_desc;
170 info->ether = header.usb_cdc_ether_desc;
171 if (!info->u) {
172 if (rndis)
173 goto skip;
174 else /* in that case a quirk is mandatory */
175 goto bad_desc;
176 }
177 /* we need a master/control interface (what we're
178 * probed with) and a slave/data interface; union
179 * descriptors sort this all out.
180 */
181 info->control = usb_ifnum_to_if(dev->udev, info->u->bMasterInterface0);
182 info->data = usb_ifnum_to_if(dev->udev, info->u->bSlaveInterface0);
183 if (!info->control || !info->data) {
184 dev_dbg(&intf->dev,
185 "master #%u/%p slave #%u/%p\n",
186 info->u->bMasterInterface0,
187 info->control,
188 info->u->bSlaveInterface0,
189 info->data);
190 /* fall back to hard-wiring for RNDIS */
191 if (rndis) {
192 android_rndis_quirk = true;
193 goto skip;
194 }
195 goto bad_desc;
196 }
197 if (info->control != intf) {
198 dev_dbg(&intf->dev, "bogus CDC Union\n");
199 /* Ambit USB Cable Modem (and maybe others)
200 * interchanges master and slave interface.
201 */
202 if (info->data == intf) {
203 info->data = info->control;
204 info->control = intf;
205 } else
206 goto bad_desc;
207 }
208
209 /* some devices merge these - skip class check */
210 if (info->control == info->data)
211 goto skip;
212
213 /* a data interface altsetting does the real i/o */
214 d = &info->data->cur_altsetting->desc;
215 if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
216 dev_dbg(&intf->dev, "slave class %u\n", d->bInterfaceClass);
217 goto bad_desc;
218 }
219skip:
220 /* Communication class functions with bmCapabilities are not
221 * RNDIS. But some Wireless class RNDIS functions use
222 * bmCapabilities for their own purpose. The failsafe is
223 * therefore applied only to Communication class RNDIS
224 * functions. The rndis test is redundant, but a cheap
225 * optimization.
226 */
227 if (rndis && is_rndis(&intf->cur_altsetting->desc) &&
228 header.usb_cdc_acm_descriptor &&
229 header.usb_cdc_acm_descriptor->bmCapabilities) {
230 dev_dbg(&intf->dev,
231 "ACM capabilities %02x, not really RNDIS?\n",
232 header.usb_cdc_acm_descriptor->bmCapabilities);
233 goto bad_desc;
234 }
235
236 if (header.usb_cdc_ether_desc && info->ether->wMaxSegmentSize) {
237 dev->hard_mtu = le16_to_cpu(info->ether->wMaxSegmentSize);
238 /* because of Zaurus, we may be ignoring the host
239 * side link address we were given.
240 */
241 }
242
243 if (header.usb_cdc_mdlm_desc &&
244 memcmp(header.usb_cdc_mdlm_desc->bGUID, mbm_guid, 16)) {
245 dev_dbg(&intf->dev, "GUID doesn't match\n");
246 goto bad_desc;
247 }
248
249 if (header.usb_cdc_mdlm_detail_desc &&
250 header.usb_cdc_mdlm_detail_desc->bLength <
251 (sizeof(struct usb_cdc_mdlm_detail_desc) + 1)) {
252 dev_dbg(&intf->dev, "Descriptor too short\n");
253 goto bad_desc;
254 }
255
256
257
258 /* Microsoft ActiveSync based and some regular RNDIS devices lack the
259 * CDC descriptors, so we'll hard-wire the interfaces and not check
260 * for descriptors.
261 *
262 * Some Android RNDIS devices have a CDC Union descriptor pointing
263 * to non-existing interfaces. Ignore that and attempt the same
264 * hard-wired 0 and 1 interfaces.
265 */
266 if (rndis && (!info->u || android_rndis_quirk)) {
267 info->control = usb_ifnum_to_if(dev->udev, 0);
268 info->data = usb_ifnum_to_if(dev->udev, 1);
269 if (!info->control || !info->data || info->control != intf) {
270 dev_dbg(&intf->dev,
271 "rndis: master #0/%p slave #1/%p\n",
272 info->control,
273 info->data);
274 goto bad_desc;
275 }
276
277 } else if (!info->header || (!rndis && !info->ether)) {
278 dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
279 info->header ? "" : "header ",
280 info->u ? "" : "union ",
281 info->ether ? "" : "ether ");
282 goto bad_desc;
283 }
284
285 /* claim data interface and set it up ... with side effects.
286 * network traffic can't flow until an altsetting is enabled.
287 */
288 if (info->data != info->control) {
289 status = usb_driver_claim_interface(driver, info->data, dev);
290 if (status < 0)
291 return status;
292 }
293 status = usbnet_get_endpoints(dev, info->data);
294 if (status < 0) {
295 /* ensure immediate exit from usbnet_disconnect */
296 usb_set_intfdata(info->data, NULL);
297 if (info->data != info->control)
298 usb_driver_release_interface(driver, info->data);
299 return status;
300 }
301
302 /* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
303 if (info->data != info->control)
304 dev->status = NULL;
305 if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
306 struct usb_endpoint_descriptor *desc;
307
308 dev->status = &info->control->cur_altsetting->endpoint[0];
309 desc = &dev->status->desc;
310 if (!usb_endpoint_is_int_in(desc) ||
311 (le16_to_cpu(desc->wMaxPacketSize)
312 < sizeof(struct usb_cdc_notification)) ||
313 !desc->bInterval) {
314 dev_dbg(&intf->dev, "bad notification endpoint\n");
315 dev->status = NULL;
316 }
317 }
318 if (rndis && !dev->status) {
319 dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
320 usb_set_intfdata(info->data, NULL);
321 usb_driver_release_interface(driver, info->data);
322 return -ENODEV;
323 }
324
325 /* override ethtool_ops */
326 dev->net->ethtool_ops = &cdc_ether_ethtool_ops;
327
328 return 0;
329
330bad_desc:
331 dev_info(&dev->udev->dev, "bad CDC descriptors\n");
332 return -ENODEV;
333}
334EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
335
336
337/* like usbnet_generic_cdc_bind() but handles filter initialization
338 * correctly
339 */
340int usbnet_ether_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
341{
342 int rv;
343
344 rv = usbnet_generic_cdc_bind(dev, intf);
345 if (rv < 0)
346 goto bail_out;
347
348 /* Some devices don't initialise properly. In particular
349 * the packet filter is not reset. There are devices that
350 * don't do reset all the way. So the packet filter should
351 * be set to a sane initial value.
352 */
353 usbnet_cdc_update_filter(dev);
354
355bail_out:
356 return rv;
357}
358EXPORT_SYMBOL_GPL(usbnet_ether_cdc_bind);
359
360void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
361{
362 struct cdc_state *info = (void *) &dev->data;
363 struct usb_driver *driver = driver_of(intf);
364
365 /* combined interface - nothing to do */
366 if (info->data == info->control)
367 return;
368
369 /* disconnect master --> disconnect slave */
370 if (intf == info->control && info->data) {
371 /* ensure immediate exit from usbnet_disconnect */
372 usb_set_intfdata(info->data, NULL);
373 usb_driver_release_interface(driver, info->data);
374 info->data = NULL;
375 }
376
377 /* and vice versa (just in case) */
378 else if (intf == info->data && info->control) {
379 /* ensure immediate exit from usbnet_disconnect */
380 usb_set_intfdata(info->control, NULL);
381 usb_driver_release_interface(driver, info->control);
382 info->control = NULL;
383 }
384}
385EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
386
387/* Communications Device Class, Ethernet Control model
388 *
389 * Takes two interfaces. The DATA interface is inactive till an altsetting
390 * is selected. Configuration data includes class descriptors. There's
391 * an optional status endpoint on the control interface.
392 *
393 * This should interop with whatever the 2.4 "CDCEther.c" driver
394 * (by Brad Hards) talked with, with more functionality.
395 */
396
397static void speed_change(struct usbnet *dev, __le32 *speeds)
398{
399 dev->tx_speed = __le32_to_cpu(speeds[0]);
400 dev->rx_speed = __le32_to_cpu(speeds[1]);
401}
402
403void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
404{
405 struct usb_cdc_notification *event;
406
407 if (urb->actual_length < sizeof(*event))
408 return;
409
410 /* SPEED_CHANGE can get split into two 8-byte packets */
411 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
412 speed_change(dev, (__le32 *) urb->transfer_buffer);
413 return;
414 }
415
416 event = urb->transfer_buffer;
417 switch (event->bNotificationType) {
418 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
419 netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
420 event->wValue ? "on" : "off");
421 usbnet_link_change(dev, !!event->wValue, 0);
422 break;
423 case USB_CDC_NOTIFY_SPEED_CHANGE: /* tx/rx rates */
424 netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
425 urb->actual_length);
426 if (urb->actual_length != (sizeof(*event) + 8))
427 set_bit(EVENT_STS_SPLIT, &dev->flags);
428 else
429 speed_change(dev, (__le32 *) &event[1]);
430 break;
431 /* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
432 * but there are no standard formats for the response data.
433 */
434 default:
435 netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
436 event->bNotificationType);
437 break;
438 }
439}
440EXPORT_SYMBOL_GPL(usbnet_cdc_status);
441
442int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
443{
444 int status;
445 struct cdc_state *info = (void *) &dev->data;
446
447 BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
448 < sizeof(struct cdc_state)));
449
450 status = usbnet_ether_cdc_bind(dev, intf);
451 if (status < 0)
452 return status;
453
454 status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
455 if (status < 0) {
456 usb_set_intfdata(info->data, NULL);
457 usb_driver_release_interface(driver_of(intf), info->data);
458 return status;
459 }
460
461 return 0;
462}
463EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
464
465static int usbnet_cdc_zte_bind(struct usbnet *dev, struct usb_interface *intf)
466{
467 int status = usbnet_cdc_bind(dev, intf);
468
469 if (!status && (dev->net->dev_addr[0] & 0x02))
470 eth_hw_addr_random(dev->net);
471
472 return status;
473}
474
475/* Make sure packets have correct destination MAC address
476 *
477 * A firmware bug observed on some devices (ZTE MF823/831/910) is that the
478 * device sends packets with a static, bogus, random MAC address (event if
479 * device MAC address has been updated). Always set MAC address to that of the
480 * device.
481 */
482static int usbnet_cdc_zte_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
483{
484 if (skb->len < ETH_HLEN || !(skb->data[0] & 0x02))
485 return 1;
486
487 skb_reset_mac_header(skb);
488 ether_addr_copy(eth_hdr(skb)->h_dest, dev->net->dev_addr);
489
490 return 1;
491}
492
493/* Ensure correct link state
494 *
495 * Some devices (ZTE MF823/831/910) export two carrier on notifications when
496 * connected. This causes the link state to be incorrect. Work around this by
497 * always setting the state to off, then on.
498 */
499static void usbnet_cdc_zte_status(struct usbnet *dev, struct urb *urb)
500{
501 struct usb_cdc_notification *event;
502
503 if (urb->actual_length < sizeof(*event))
504 return;
505
506 event = urb->transfer_buffer;
507
508 if (event->bNotificationType != USB_CDC_NOTIFY_NETWORK_CONNECTION) {
509 usbnet_cdc_status(dev, urb);
510 return;
511 }
512
513 netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
514 event->wValue ? "on" : "off");
515
516 if (event->wValue &&
517 netif_carrier_ok(dev->net))
518 netif_carrier_off(dev->net);
519
520 usbnet_link_change(dev, !!event->wValue, 0);
521}
522
523static const struct driver_info cdc_info = {
524 .description = "CDC Ethernet Device",
525 .flags = FLAG_ETHER | FLAG_POINTTOPOINT,
526 .bind = usbnet_cdc_bind,
527 .unbind = usbnet_cdc_unbind,
528 .status = usbnet_cdc_status,
529 .set_rx_mode = usbnet_cdc_update_filter,
530 .manage_power = usbnet_manage_power,
531};
532
533static const struct driver_info zte_cdc_info = {
534 .description = "ZTE CDC Ethernet Device",
535 .flags = FLAG_ETHER | FLAG_POINTTOPOINT,
536 .bind = usbnet_cdc_zte_bind,
537 .unbind = usbnet_cdc_unbind,
538 .status = usbnet_cdc_zte_status,
539 .set_rx_mode = usbnet_cdc_update_filter,
540 .manage_power = usbnet_manage_power,
541 .rx_fixup = usbnet_cdc_zte_rx_fixup,
542};
543
544static const struct driver_info wwan_info = {
545 .description = "Mobile Broadband Network Device",
546 .flags = FLAG_WWAN,
547 .bind = usbnet_cdc_bind,
548 .unbind = usbnet_cdc_unbind,
549 .status = usbnet_cdc_status,
550 .set_rx_mode = usbnet_cdc_update_filter,
551 .manage_power = usbnet_manage_power,
552};
553
554/*-------------------------------------------------------------------------*/
555
556#define HUAWEI_VENDOR_ID 0x12D1
557#define NOVATEL_VENDOR_ID 0x1410
558#define ZTE_VENDOR_ID 0x19D2
559#define DELL_VENDOR_ID 0x413C
560#define REALTEK_VENDOR_ID 0x0bda
561#define SAMSUNG_VENDOR_ID 0x04e8
562#define LENOVO_VENDOR_ID 0x17ef
563#define LINKSYS_VENDOR_ID 0x13b1
564#define NVIDIA_VENDOR_ID 0x0955
565#define HP_VENDOR_ID 0x03f0
566#define MICROSOFT_VENDOR_ID 0x045e
567#define UBLOX_VENDOR_ID 0x1546
568#define TPLINK_VENDOR_ID 0x2357
569#define AQUANTIA_VENDOR_ID 0x2eca
570#define ASIX_VENDOR_ID 0x0b95
571
572static const struct usb_device_id products[] = {
573/* BLACKLIST !!
574 *
575 * First blacklist any products that are egregiously nonconformant
576 * with the CDC Ethernet specs. Minor braindamage we cope with; when
577 * they're not even trying, needing a separate driver is only the first
578 * of the differences to show up.
579 */
580
581#define ZAURUS_MASTER_INTERFACE \
582 .bInterfaceClass = USB_CLASS_COMM, \
583 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
584 .bInterfaceProtocol = USB_CDC_PROTO_NONE
585
586/* SA-1100 based Sharp Zaurus ("collie"), or compatible;
587 * wire-incompatible with true CDC Ethernet implementations.
588 * (And, it seems, needlessly so...)
589 */
590{
591 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
592 | USB_DEVICE_ID_MATCH_DEVICE,
593 .idVendor = 0x04DD,
594 .idProduct = 0x8004,
595 ZAURUS_MASTER_INTERFACE,
596 .driver_info = 0,
597},
598
599/* PXA-25x based Sharp Zaurii. Note that it seems some of these
600 * (later models especially) may have shipped only with firmware
601 * advertising false "CDC MDLM" compatibility ... but we're not
602 * clear which models did that, so for now let's assume the worst.
603 */
604{
605 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
606 | USB_DEVICE_ID_MATCH_DEVICE,
607 .idVendor = 0x04DD,
608 .idProduct = 0x8005, /* A-300 */
609 ZAURUS_MASTER_INTERFACE,
610 .driver_info = 0,
611}, {
612 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
613 | USB_DEVICE_ID_MATCH_DEVICE,
614 .idVendor = 0x04DD,
615 .idProduct = 0x8006, /* B-500/SL-5600 */
616 ZAURUS_MASTER_INTERFACE,
617 .driver_info = 0,
618}, {
619 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
620 | USB_DEVICE_ID_MATCH_DEVICE,
621 .idVendor = 0x04DD,
622 .idProduct = 0x8007, /* C-700 */
623 ZAURUS_MASTER_INTERFACE,
624 .driver_info = 0,
625}, {
626 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
627 | USB_DEVICE_ID_MATCH_DEVICE,
628 .idVendor = 0x04DD,
629 .idProduct = 0x9031, /* C-750 C-760 */
630 ZAURUS_MASTER_INTERFACE,
631 .driver_info = 0,
632}, {
633 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
634 | USB_DEVICE_ID_MATCH_DEVICE,
635 .idVendor = 0x04DD,
636 .idProduct = 0x9032, /* SL-6000 */
637 ZAURUS_MASTER_INTERFACE,
638 .driver_info = 0,
639}, {
640 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
641 | USB_DEVICE_ID_MATCH_DEVICE,
642 .idVendor = 0x04DD,
643 /* reported with some C860 units */
644 .idProduct = 0x9050, /* C-860 */
645 ZAURUS_MASTER_INTERFACE,
646 .driver_info = 0,
647},
648
649/* Olympus has some models with a Zaurus-compatible option.
650 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
651 */
652{
653 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
654 | USB_DEVICE_ID_MATCH_DEVICE,
655 .idVendor = 0x07B4,
656 .idProduct = 0x0F02, /* R-1000 */
657 ZAURUS_MASTER_INTERFACE,
658 .driver_info = 0,
659},
660
661/* LG Electronics VL600 wants additional headers on every frame */
662{
663 USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
664 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
665 .driver_info = 0,
666},
667
668/* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
669{
670 USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
671 USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
672 .driver_info = 0,
673},
674
675/* Novatel USB551L and MC551 - handled by qmi_wwan */
676{
677 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0xB001, USB_CLASS_COMM,
678 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
679 .driver_info = 0,
680},
681
682/* Novatel E362 - handled by qmi_wwan */
683{
684 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9010, USB_CLASS_COMM,
685 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
686 .driver_info = 0,
687},
688
689/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
690{
691 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8195, USB_CLASS_COMM,
692 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
693 .driver_info = 0,
694},
695
696/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
697{
698 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8196, USB_CLASS_COMM,
699 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
700 .driver_info = 0,
701},
702
703/* Dell Wireless 5804 (Novatel E371) - handled by qmi_wwan */
704{
705 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x819b, USB_CLASS_COMM,
706 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
707 .driver_info = 0,
708},
709
710/* Novatel Expedite E371 - handled by qmi_wwan */
711{
712 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9011, USB_CLASS_COMM,
713 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
714 .driver_info = 0,
715},
716
717/* HP lt2523 (Novatel E371) - handled by qmi_wwan */
718{
719 USB_DEVICE_AND_INTERFACE_INFO(HP_VENDOR_ID, 0x421d, USB_CLASS_COMM,
720 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
721 .driver_info = 0,
722},
723
724/* AnyDATA ADU960S - handled by qmi_wwan */
725{
726 USB_DEVICE_AND_INTERFACE_INFO(0x16d5, 0x650a, USB_CLASS_COMM,
727 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
728 .driver_info = 0,
729},
730
731/* Huawei E1820 - handled by qmi_wwan */
732{
733 USB_DEVICE_INTERFACE_NUMBER(HUAWEI_VENDOR_ID, 0x14ac, 1),
734 .driver_info = 0,
735},
736
737/* Realtek RTL8152 Based USB 2.0 Ethernet Adapters */
738{
739 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8152, USB_CLASS_COMM,
740 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
741 .driver_info = 0,
742},
743
744/* Realtek RTL8153 Based USB 3.0 Ethernet Adapters */
745{
746 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8153, USB_CLASS_COMM,
747 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
748 .driver_info = 0,
749},
750
751/* Samsung USB Ethernet Adapters */
752{
753 USB_DEVICE_AND_INTERFACE_INFO(SAMSUNG_VENDOR_ID, 0xa101, USB_CLASS_COMM,
754 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
755 .driver_info = 0,
756},
757
758#if IS_ENABLED(CONFIG_USB_RTL8152)
759/* Linksys USB3GIGV1 Ethernet Adapter */
760{
761 USB_DEVICE_AND_INTERFACE_INFO(LINKSYS_VENDOR_ID, 0x0041, USB_CLASS_COMM,
762 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
763 .driver_info = 0,
764},
765#endif
766
767/* ThinkPad USB-C Dock (based on Realtek RTL8153) */
768{
769 USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x3062, USB_CLASS_COMM,
770 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
771 .driver_info = 0,
772},
773
774/* ThinkPad Thunderbolt 3 Dock (based on Realtek RTL8153) */
775{
776 USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x3069, USB_CLASS_COMM,
777 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
778 .driver_info = 0,
779},
780
781/* ThinkPad Thunderbolt 3 Dock Gen 2 (based on Realtek RTL8153) */
782{
783 USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x3082, USB_CLASS_COMM,
784 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
785 .driver_info = 0,
786},
787
788/* Lenovo Thinkpad USB 3.0 Ethernet Adapters (based on Realtek RTL8153) */
789{
790 USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x7205, USB_CLASS_COMM,
791 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
792 .driver_info = 0,
793},
794
795/* Lenovo USB C to Ethernet Adapter (based on Realtek RTL8153) */
796{
797 USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x720c, USB_CLASS_COMM,
798 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
799 .driver_info = 0,
800},
801
802/* Lenovo USB-C Travel Hub (based on Realtek RTL8153) */
803{
804 USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x7214, USB_CLASS_COMM,
805 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
806 .driver_info = 0,
807},
808
809/* Lenovo Powered USB-C Travel Hub (4X90S92381, based on Realtek RTL8153) */
810{
811 USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x721e, USB_CLASS_COMM,
812 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
813 .driver_info = 0,
814},
815
816/* ThinkPad USB-C Dock Gen 2 (based on Realtek RTL8153) */
817{
818 USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0xa387, USB_CLASS_COMM,
819 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
820 .driver_info = 0,
821},
822
823/* NVIDIA Tegra USB 3.0 Ethernet Adapters (based on Realtek RTL8153) */
824{
825 USB_DEVICE_AND_INTERFACE_INFO(NVIDIA_VENDOR_ID, 0x09ff, USB_CLASS_COMM,
826 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
827 .driver_info = 0,
828},
829
830/* Microsoft Surface 2 dock (based on Realtek RTL8152) */
831{
832 USB_DEVICE_AND_INTERFACE_INFO(MICROSOFT_VENDOR_ID, 0x07ab, USB_CLASS_COMM,
833 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
834 .driver_info = 0,
835},
836
837/* Microsoft Surface Ethernet Adapter (based on Realtek RTL8153) */
838{
839 USB_DEVICE_AND_INTERFACE_INFO(MICROSOFT_VENDOR_ID, 0x07c6, USB_CLASS_COMM,
840 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
841 .driver_info = 0,
842},
843
844/* Microsoft Surface Ethernet Adapter (based on Realtek RTL8153B) */
845{
846 USB_DEVICE_AND_INTERFACE_INFO(MICROSOFT_VENDOR_ID, 0x0927, USB_CLASS_COMM,
847 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
848 .driver_info = 0,
849},
850
851/* TP-LINK UE300 USB 3.0 Ethernet Adapters (based on Realtek RTL8153) */
852{
853 USB_DEVICE_AND_INTERFACE_INFO(TPLINK_VENDOR_ID, 0x0601, USB_CLASS_COMM,
854 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
855 .driver_info = 0,
856},
857
858/* Aquantia AQtion USB to 5GbE Controller (based on AQC111U) */
859{
860 USB_DEVICE_AND_INTERFACE_INFO(AQUANTIA_VENDOR_ID, 0xc101,
861 USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
862 USB_CDC_PROTO_NONE),
863 .driver_info = 0,
864},
865
866/* ASIX USB 3.1 Gen1 to 5G Multi-Gigabit Ethernet Adapter(based on AQC111U) */
867{
868 USB_DEVICE_AND_INTERFACE_INFO(ASIX_VENDOR_ID, 0x2790, USB_CLASS_COMM,
869 USB_CDC_SUBCLASS_ETHERNET,
870 USB_CDC_PROTO_NONE),
871 .driver_info = 0,
872},
873
874/* ASIX USB 3.1 Gen1 to 2.5G Multi-Gigabit Ethernet Adapter(based on AQC112U) */
875{
876 USB_DEVICE_AND_INTERFACE_INFO(ASIX_VENDOR_ID, 0x2791, USB_CLASS_COMM,
877 USB_CDC_SUBCLASS_ETHERNET,
878 USB_CDC_PROTO_NONE),
879 .driver_info = 0,
880},
881
882/* USB-C 3.1 to 5GBASE-T Ethernet Adapter (based on AQC111U) */
883{
884 USB_DEVICE_AND_INTERFACE_INFO(0x20f4, 0xe05a, USB_CLASS_COMM,
885 USB_CDC_SUBCLASS_ETHERNET,
886 USB_CDC_PROTO_NONE),
887 .driver_info = 0,
888},
889
890/* QNAP QNA-UC5G1T USB to 5GbE Adapter (based on AQC111U) */
891{
892 USB_DEVICE_AND_INTERFACE_INFO(0x1c04, 0x0015, USB_CLASS_COMM,
893 USB_CDC_SUBCLASS_ETHERNET,
894 USB_CDC_PROTO_NONE),
895 .driver_info = 0,
896},
897
898/* WHITELIST!!!
899 *
900 * CDC Ether uses two interfaces, not necessarily consecutive.
901 * We match the main interface, ignoring the optional device
902 * class so we could handle devices that aren't exclusively
903 * CDC ether.
904 *
905 * NOTE: this match must come AFTER entries blacklisting devices
906 * because of bugs/quirks in a given product (like Zaurus, above).
907 */
908{
909 /* ZTE (Vodafone) K3805-Z */
910 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1003, USB_CLASS_COMM,
911 USB_CDC_SUBCLASS_ETHERNET,
912 USB_CDC_PROTO_NONE),
913 .driver_info = (unsigned long)&wwan_info,
914}, {
915 /* ZTE (Vodafone) K3806-Z */
916 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1015, USB_CLASS_COMM,
917 USB_CDC_SUBCLASS_ETHERNET,
918 USB_CDC_PROTO_NONE),
919 .driver_info = (unsigned long)&wwan_info,
920}, {
921 /* ZTE (Vodafone) K4510-Z */
922 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1173, USB_CLASS_COMM,
923 USB_CDC_SUBCLASS_ETHERNET,
924 USB_CDC_PROTO_NONE),
925 .driver_info = (unsigned long)&wwan_info,
926}, {
927 /* ZTE (Vodafone) K3770-Z */
928 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1177, USB_CLASS_COMM,
929 USB_CDC_SUBCLASS_ETHERNET,
930 USB_CDC_PROTO_NONE),
931 .driver_info = (unsigned long)&wwan_info,
932}, {
933 /* ZTE (Vodafone) K3772-Z */
934 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1181, USB_CLASS_COMM,
935 USB_CDC_SUBCLASS_ETHERNET,
936 USB_CDC_PROTO_NONE),
937 .driver_info = (unsigned long)&wwan_info,
938}, {
939 /* Telit modules */
940 USB_VENDOR_AND_INTERFACE_INFO(0x1bc7, USB_CLASS_COMM,
941 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
942 .driver_info = (kernel_ulong_t) &wwan_info,
943}, {
944 /* Dell DW5580 modules */
945 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x81ba, USB_CLASS_COMM,
946 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
947 .driver_info = (kernel_ulong_t)&wwan_info,
948}, {
949 /* Huawei ME906 and ME909 */
950 USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, 0x15c1, USB_CLASS_COMM,
951 USB_CDC_SUBCLASS_ETHERNET,
952 USB_CDC_PROTO_NONE),
953 .driver_info = (unsigned long)&wwan_info,
954}, {
955 /* ZTE modules */
956 USB_VENDOR_AND_INTERFACE_INFO(ZTE_VENDOR_ID, USB_CLASS_COMM,
957 USB_CDC_SUBCLASS_ETHERNET,
958 USB_CDC_PROTO_NONE),
959 .driver_info = (unsigned long)&zte_cdc_info,
960}, {
961 /* U-blox TOBY-L2 */
962 USB_DEVICE_AND_INTERFACE_INFO(UBLOX_VENDOR_ID, 0x1143, USB_CLASS_COMM,
963 USB_CDC_SUBCLASS_ETHERNET,
964 USB_CDC_PROTO_NONE),
965 .driver_info = (unsigned long)&wwan_info,
966}, {
967 /* U-blox SARA-U2 */
968 USB_DEVICE_AND_INTERFACE_INFO(UBLOX_VENDOR_ID, 0x1104, USB_CLASS_COMM,
969 USB_CDC_SUBCLASS_ETHERNET,
970 USB_CDC_PROTO_NONE),
971 .driver_info = (unsigned long)&wwan_info,
972}, {
973 /* Cinterion PLS8 modem by GEMALTO */
974 USB_DEVICE_AND_INTERFACE_INFO(0x1e2d, 0x0061, USB_CLASS_COMM,
975 USB_CDC_SUBCLASS_ETHERNET,
976 USB_CDC_PROTO_NONE),
977 .driver_info = (unsigned long)&wwan_info,
978}, {
979 /* Cinterion AHS3 modem by GEMALTO */
980 USB_DEVICE_AND_INTERFACE_INFO(0x1e2d, 0x0055, USB_CLASS_COMM,
981 USB_CDC_SUBCLASS_ETHERNET,
982 USB_CDC_PROTO_NONE),
983 .driver_info = (unsigned long)&wwan_info,
984}, {
985 /* Cinterion PLS83/PLS63 modem by GEMALTO/THALES */
986 USB_DEVICE_AND_INTERFACE_INFO(0x1e2d, 0x0069, USB_CLASS_COMM,
987 USB_CDC_SUBCLASS_ETHERNET,
988 USB_CDC_PROTO_NONE),
989 .driver_info = (unsigned long)&wwan_info,
990}, {
991 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
992 USB_CDC_PROTO_NONE),
993 .driver_info = (unsigned long) &cdc_info,
994}, {
995 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
996 USB_CDC_PROTO_NONE),
997 .driver_info = (unsigned long)&wwan_info,
998
999}, {
1000 /* Various Huawei modems with a network port like the UMG1831 */
1001 USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_COMM,
1002 USB_CDC_SUBCLASS_ETHERNET, 255),
1003 .driver_info = (unsigned long)&wwan_info,
1004},
1005 { }, /* END */
1006};
1007MODULE_DEVICE_TABLE(usb, products);
1008
1009static struct usb_driver cdc_driver = {
1010 .name = "cdc_ether",
1011 .id_table = products,
1012 .probe = usbnet_probe,
1013 .disconnect = usbnet_disconnect,
1014 .suspend = usbnet_suspend,
1015 .resume = usbnet_resume,
1016 .reset_resume = usbnet_resume,
1017 .supports_autosuspend = 1,
1018 .disable_hub_initiated_lpm = 1,
1019};
1020
1021module_usb_driver(cdc_driver);
1022
1023MODULE_AUTHOR("David Brownell");
1024MODULE_DESCRIPTION("USB CDC Ethernet devices");
1025MODULE_LICENSE("GPL");
1/*
2 * CDC Ethernet based networking peripherals
3 * Copyright (C) 2003-2005 by David Brownell
4 * Copyright (C) 2006 by Ole Andre Vadla Ravnas (ActiveSync)
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21// #define DEBUG // error path messages, extra info
22// #define VERBOSE // more; success messages
23
24#include <linux/module.h>
25#include <linux/init.h>
26#include <linux/netdevice.h>
27#include <linux/etherdevice.h>
28#include <linux/ethtool.h>
29#include <linux/workqueue.h>
30#include <linux/mii.h>
31#include <linux/usb.h>
32#include <linux/usb/cdc.h>
33#include <linux/usb/usbnet.h>
34
35
36#if defined(CONFIG_USB_NET_RNDIS_HOST) || defined(CONFIG_USB_NET_RNDIS_HOST_MODULE)
37
38static int is_rndis(struct usb_interface_descriptor *desc)
39{
40 return (desc->bInterfaceClass == USB_CLASS_COMM &&
41 desc->bInterfaceSubClass == 2 &&
42 desc->bInterfaceProtocol == 0xff);
43}
44
45static int is_activesync(struct usb_interface_descriptor *desc)
46{
47 return (desc->bInterfaceClass == USB_CLASS_MISC &&
48 desc->bInterfaceSubClass == 1 &&
49 desc->bInterfaceProtocol == 1);
50}
51
52static int is_wireless_rndis(struct usb_interface_descriptor *desc)
53{
54 return (desc->bInterfaceClass == USB_CLASS_WIRELESS_CONTROLLER &&
55 desc->bInterfaceSubClass == 1 &&
56 desc->bInterfaceProtocol == 3);
57}
58
59#else
60
61#define is_rndis(desc) 0
62#define is_activesync(desc) 0
63#define is_wireless_rndis(desc) 0
64
65#endif
66
67static const u8 mbm_guid[16] = {
68 0xa3, 0x17, 0xa8, 0x8b, 0x04, 0x5e, 0x4f, 0x01,
69 0xa6, 0x07, 0xc0, 0xff, 0xcb, 0x7e, 0x39, 0x2a,
70};
71
72/*
73 * probes control interface, claims data interface, collects the bulk
74 * endpoints, activates data interface (if needed), maybe sets MTU.
75 * all pure cdc, except for certain firmware workarounds, and knowing
76 * that rndis uses one different rule.
77 */
78int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
79{
80 u8 *buf = intf->cur_altsetting->extra;
81 int len = intf->cur_altsetting->extralen;
82 struct usb_interface_descriptor *d;
83 struct cdc_state *info = (void *) &dev->data;
84 int status;
85 int rndis;
86 bool android_rndis_quirk = false;
87 struct usb_driver *driver = driver_of(intf);
88 struct usb_cdc_mdlm_desc *desc = NULL;
89 struct usb_cdc_mdlm_detail_desc *detail = NULL;
90
91 if (sizeof dev->data < sizeof *info)
92 return -EDOM;
93
94 /* expect strict spec conformance for the descriptors, but
95 * cope with firmware which stores them in the wrong place
96 */
97 if (len == 0 && dev->udev->actconfig->extralen) {
98 /* Motorola SB4100 (and others: Brad Hards says it's
99 * from a Broadcom design) put CDC descriptors here
100 */
101 buf = dev->udev->actconfig->extra;
102 len = dev->udev->actconfig->extralen;
103 dev_dbg(&intf->dev, "CDC descriptors on config\n");
104 }
105
106 /* Maybe CDC descriptors are after the endpoint? This bug has
107 * been seen on some 2Wire Inc RNDIS-ish products.
108 */
109 if (len == 0) {
110 struct usb_host_endpoint *hep;
111
112 hep = intf->cur_altsetting->endpoint;
113 if (hep) {
114 buf = hep->extra;
115 len = hep->extralen;
116 }
117 if (len)
118 dev_dbg(&intf->dev,
119 "CDC descriptors on endpoint\n");
120 }
121
122 /* this assumes that if there's a non-RNDIS vendor variant
123 * of cdc-acm, it'll fail RNDIS requests cleanly.
124 */
125 rndis = (is_rndis(&intf->cur_altsetting->desc) ||
126 is_activesync(&intf->cur_altsetting->desc) ||
127 is_wireless_rndis(&intf->cur_altsetting->desc));
128
129 memset(info, 0, sizeof *info);
130 info->control = intf;
131 while (len > 3) {
132 if (buf [1] != USB_DT_CS_INTERFACE)
133 goto next_desc;
134
135 /* use bDescriptorSubType to identify the CDC descriptors.
136 * We expect devices with CDC header and union descriptors.
137 * For CDC Ethernet we need the ethernet descriptor.
138 * For RNDIS, ignore two (pointless) CDC modem descriptors
139 * in favor of a complicated OID-based RPC scheme doing what
140 * CDC Ethernet achieves with a simple descriptor.
141 */
142 switch (buf [2]) {
143 case USB_CDC_HEADER_TYPE:
144 if (info->header) {
145 dev_dbg(&intf->dev, "extra CDC header\n");
146 goto bad_desc;
147 }
148 info->header = (void *) buf;
149 if (info->header->bLength != sizeof *info->header) {
150 dev_dbg(&intf->dev, "CDC header len %u\n",
151 info->header->bLength);
152 goto bad_desc;
153 }
154 break;
155 case USB_CDC_ACM_TYPE:
156 /* paranoia: disambiguate a "real" vendor-specific
157 * modem interface from an RNDIS non-modem.
158 */
159 if (rndis) {
160 struct usb_cdc_acm_descriptor *acm;
161
162 acm = (void *) buf;
163 if (acm->bmCapabilities) {
164 dev_dbg(&intf->dev,
165 "ACM capabilities %02x, "
166 "not really RNDIS?\n",
167 acm->bmCapabilities);
168 goto bad_desc;
169 }
170 }
171 break;
172 case USB_CDC_UNION_TYPE:
173 if (info->u) {
174 dev_dbg(&intf->dev, "extra CDC union\n");
175 goto bad_desc;
176 }
177 info->u = (void *) buf;
178 if (info->u->bLength != sizeof *info->u) {
179 dev_dbg(&intf->dev, "CDC union len %u\n",
180 info->u->bLength);
181 goto bad_desc;
182 }
183
184 /* we need a master/control interface (what we're
185 * probed with) and a slave/data interface; union
186 * descriptors sort this all out.
187 */
188 info->control = usb_ifnum_to_if(dev->udev,
189 info->u->bMasterInterface0);
190 info->data = usb_ifnum_to_if(dev->udev,
191 info->u->bSlaveInterface0);
192 if (!info->control || !info->data) {
193 dev_dbg(&intf->dev,
194 "master #%u/%p slave #%u/%p\n",
195 info->u->bMasterInterface0,
196 info->control,
197 info->u->bSlaveInterface0,
198 info->data);
199 /* fall back to hard-wiring for RNDIS */
200 if (rndis) {
201 android_rndis_quirk = true;
202 goto next_desc;
203 }
204 goto bad_desc;
205 }
206 if (info->control != intf) {
207 dev_dbg(&intf->dev, "bogus CDC Union\n");
208 /* Ambit USB Cable Modem (and maybe others)
209 * interchanges master and slave interface.
210 */
211 if (info->data == intf) {
212 info->data = info->control;
213 info->control = intf;
214 } else
215 goto bad_desc;
216 }
217
218 /* a data interface altsetting does the real i/o */
219 d = &info->data->cur_altsetting->desc;
220 if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
221 dev_dbg(&intf->dev, "slave class %u\n",
222 d->bInterfaceClass);
223 goto bad_desc;
224 }
225 break;
226 case USB_CDC_ETHERNET_TYPE:
227 if (info->ether) {
228 dev_dbg(&intf->dev, "extra CDC ether\n");
229 goto bad_desc;
230 }
231 info->ether = (void *) buf;
232 if (info->ether->bLength != sizeof *info->ether) {
233 dev_dbg(&intf->dev, "CDC ether len %u\n",
234 info->ether->bLength);
235 goto bad_desc;
236 }
237 dev->hard_mtu = le16_to_cpu(
238 info->ether->wMaxSegmentSize);
239 /* because of Zaurus, we may be ignoring the host
240 * side link address we were given.
241 */
242 break;
243 case USB_CDC_MDLM_TYPE:
244 if (desc) {
245 dev_dbg(&intf->dev, "extra MDLM descriptor\n");
246 goto bad_desc;
247 }
248
249 desc = (void *)buf;
250
251 if (desc->bLength != sizeof(*desc))
252 goto bad_desc;
253
254 if (memcmp(&desc->bGUID, mbm_guid, 16))
255 goto bad_desc;
256 break;
257 case USB_CDC_MDLM_DETAIL_TYPE:
258 if (detail) {
259 dev_dbg(&intf->dev, "extra MDLM detail descriptor\n");
260 goto bad_desc;
261 }
262
263 detail = (void *)buf;
264
265 if (detail->bGuidDescriptorType == 0) {
266 if (detail->bLength < (sizeof(*detail) + 1))
267 goto bad_desc;
268 } else
269 goto bad_desc;
270 break;
271 }
272next_desc:
273 len -= buf [0]; /* bLength */
274 buf += buf [0];
275 }
276
277 /* Microsoft ActiveSync based and some regular RNDIS devices lack the
278 * CDC descriptors, so we'll hard-wire the interfaces and not check
279 * for descriptors.
280 *
281 * Some Android RNDIS devices have a CDC Union descriptor pointing
282 * to non-existing interfaces. Ignore that and attempt the same
283 * hard-wired 0 and 1 interfaces.
284 */
285 if (rndis && (!info->u || android_rndis_quirk)) {
286 info->control = usb_ifnum_to_if(dev->udev, 0);
287 info->data = usb_ifnum_to_if(dev->udev, 1);
288 if (!info->control || !info->data || info->control != intf) {
289 dev_dbg(&intf->dev,
290 "rndis: master #0/%p slave #1/%p\n",
291 info->control,
292 info->data);
293 goto bad_desc;
294 }
295
296 } else if (!info->header || !info->u || (!rndis && !info->ether)) {
297 dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
298 info->header ? "" : "header ",
299 info->u ? "" : "union ",
300 info->ether ? "" : "ether ");
301 goto bad_desc;
302 }
303
304 /* claim data interface and set it up ... with side effects.
305 * network traffic can't flow until an altsetting is enabled.
306 */
307 status = usb_driver_claim_interface(driver, info->data, dev);
308 if (status < 0)
309 return status;
310 status = usbnet_get_endpoints(dev, info->data);
311 if (status < 0) {
312 /* ensure immediate exit from usbnet_disconnect */
313 usb_set_intfdata(info->data, NULL);
314 usb_driver_release_interface(driver, info->data);
315 return status;
316 }
317
318 /* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
319 dev->status = NULL;
320 if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
321 struct usb_endpoint_descriptor *desc;
322
323 dev->status = &info->control->cur_altsetting->endpoint [0];
324 desc = &dev->status->desc;
325 if (!usb_endpoint_is_int_in(desc) ||
326 (le16_to_cpu(desc->wMaxPacketSize)
327 < sizeof(struct usb_cdc_notification)) ||
328 !desc->bInterval) {
329 dev_dbg(&intf->dev, "bad notification endpoint\n");
330 dev->status = NULL;
331 }
332 }
333 if (rndis && !dev->status) {
334 dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
335 usb_set_intfdata(info->data, NULL);
336 usb_driver_release_interface(driver, info->data);
337 return -ENODEV;
338 }
339 return 0;
340
341bad_desc:
342 dev_info(&dev->udev->dev, "bad CDC descriptors\n");
343 return -ENODEV;
344}
345EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
346
347void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
348{
349 struct cdc_state *info = (void *) &dev->data;
350 struct usb_driver *driver = driver_of(intf);
351
352 /* disconnect master --> disconnect slave */
353 if (intf == info->control && info->data) {
354 /* ensure immediate exit from usbnet_disconnect */
355 usb_set_intfdata(info->data, NULL);
356 usb_driver_release_interface(driver, info->data);
357 info->data = NULL;
358 }
359
360 /* and vice versa (just in case) */
361 else if (intf == info->data && info->control) {
362 /* ensure immediate exit from usbnet_disconnect */
363 usb_set_intfdata(info->control, NULL);
364 usb_driver_release_interface(driver, info->control);
365 info->control = NULL;
366 }
367}
368EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
369
370/*-------------------------------------------------------------------------
371 *
372 * Communications Device Class, Ethernet Control model
373 *
374 * Takes two interfaces. The DATA interface is inactive till an altsetting
375 * is selected. Configuration data includes class descriptors. There's
376 * an optional status endpoint on the control interface.
377 *
378 * This should interop with whatever the 2.4 "CDCEther.c" driver
379 * (by Brad Hards) talked with, with more functionality.
380 *
381 *-------------------------------------------------------------------------*/
382
383static void dumpspeed(struct usbnet *dev, __le32 *speeds)
384{
385 netif_info(dev, timer, dev->net,
386 "link speeds: %u kbps up, %u kbps down\n",
387 __le32_to_cpu(speeds[0]) / 1000,
388 __le32_to_cpu(speeds[1]) / 1000);
389}
390
391void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
392{
393 struct usb_cdc_notification *event;
394
395 if (urb->actual_length < sizeof *event)
396 return;
397
398 /* SPEED_CHANGE can get split into two 8-byte packets */
399 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
400 dumpspeed(dev, (__le32 *) urb->transfer_buffer);
401 return;
402 }
403
404 event = urb->transfer_buffer;
405 switch (event->bNotificationType) {
406 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
407 netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
408 event->wValue ? "on" : "off");
409 if (event->wValue)
410 netif_carrier_on(dev->net);
411 else
412 netif_carrier_off(dev->net);
413 break;
414 case USB_CDC_NOTIFY_SPEED_CHANGE: /* tx/rx rates */
415 netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
416 urb->actual_length);
417 if (urb->actual_length != (sizeof *event + 8))
418 set_bit(EVENT_STS_SPLIT, &dev->flags);
419 else
420 dumpspeed(dev, (__le32 *) &event[1]);
421 break;
422 /* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
423 * but there are no standard formats for the response data.
424 */
425 default:
426 netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
427 event->bNotificationType);
428 break;
429 }
430}
431EXPORT_SYMBOL_GPL(usbnet_cdc_status);
432
433int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
434{
435 int status;
436 struct cdc_state *info = (void *) &dev->data;
437
438 BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
439 < sizeof(struct cdc_state)));
440
441 status = usbnet_generic_cdc_bind(dev, intf);
442 if (status < 0)
443 return status;
444
445 status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
446 if (status < 0) {
447 usb_set_intfdata(info->data, NULL);
448 usb_driver_release_interface(driver_of(intf), info->data);
449 return status;
450 }
451
452 /* FIXME cdc-ether has some multicast code too, though it complains
453 * in routine cases. info->ether describes the multicast support.
454 * Implement that here, manipulating the cdc filter as needed.
455 */
456 return 0;
457}
458EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
459
460static int cdc_manage_power(struct usbnet *dev, int on)
461{
462 dev->intf->needs_remote_wakeup = on;
463 return 0;
464}
465
466static const struct driver_info cdc_info = {
467 .description = "CDC Ethernet Device",
468 .flags = FLAG_ETHER | FLAG_POINTTOPOINT,
469 // .check_connect = cdc_check_connect,
470 .bind = usbnet_cdc_bind,
471 .unbind = usbnet_cdc_unbind,
472 .status = usbnet_cdc_status,
473 .manage_power = cdc_manage_power,
474};
475
476static const struct driver_info wwan_info = {
477 .description = "Mobile Broadband Network Device",
478 .flags = FLAG_WWAN,
479 .bind = usbnet_cdc_bind,
480 .unbind = usbnet_cdc_unbind,
481 .status = usbnet_cdc_status,
482 .manage_power = cdc_manage_power,
483};
484
485/*-------------------------------------------------------------------------*/
486
487#define HUAWEI_VENDOR_ID 0x12D1
488#define NOVATEL_VENDOR_ID 0x1410
489#define ZTE_VENDOR_ID 0x19D2
490
491static const struct usb_device_id products [] = {
492/*
493 * BLACKLIST !!
494 *
495 * First blacklist any products that are egregiously nonconformant
496 * with the CDC Ethernet specs. Minor braindamage we cope with; when
497 * they're not even trying, needing a separate driver is only the first
498 * of the differences to show up.
499 */
500
501#define ZAURUS_MASTER_INTERFACE \
502 .bInterfaceClass = USB_CLASS_COMM, \
503 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
504 .bInterfaceProtocol = USB_CDC_PROTO_NONE
505
506/* SA-1100 based Sharp Zaurus ("collie"), or compatible;
507 * wire-incompatible with true CDC Ethernet implementations.
508 * (And, it seems, needlessly so...)
509 */
510{
511 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
512 | USB_DEVICE_ID_MATCH_DEVICE,
513 .idVendor = 0x04DD,
514 .idProduct = 0x8004,
515 ZAURUS_MASTER_INTERFACE,
516 .driver_info = 0,
517},
518
519/* PXA-25x based Sharp Zaurii. Note that it seems some of these
520 * (later models especially) may have shipped only with firmware
521 * advertising false "CDC MDLM" compatibility ... but we're not
522 * clear which models did that, so for now let's assume the worst.
523 */
524{
525 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
526 | USB_DEVICE_ID_MATCH_DEVICE,
527 .idVendor = 0x04DD,
528 .idProduct = 0x8005, /* A-300 */
529 ZAURUS_MASTER_INTERFACE,
530 .driver_info = 0,
531}, {
532 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
533 | USB_DEVICE_ID_MATCH_DEVICE,
534 .idVendor = 0x04DD,
535 .idProduct = 0x8006, /* B-500/SL-5600 */
536 ZAURUS_MASTER_INTERFACE,
537 .driver_info = 0,
538}, {
539 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
540 | USB_DEVICE_ID_MATCH_DEVICE,
541 .idVendor = 0x04DD,
542 .idProduct = 0x8007, /* C-700 */
543 ZAURUS_MASTER_INTERFACE,
544 .driver_info = 0,
545}, {
546 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
547 | USB_DEVICE_ID_MATCH_DEVICE,
548 .idVendor = 0x04DD,
549 .idProduct = 0x9031, /* C-750 C-760 */
550 ZAURUS_MASTER_INTERFACE,
551 .driver_info = 0,
552}, {
553 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
554 | USB_DEVICE_ID_MATCH_DEVICE,
555 .idVendor = 0x04DD,
556 .idProduct = 0x9032, /* SL-6000 */
557 ZAURUS_MASTER_INTERFACE,
558 .driver_info = 0,
559}, {
560 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
561 | USB_DEVICE_ID_MATCH_DEVICE,
562 .idVendor = 0x04DD,
563 /* reported with some C860 units */
564 .idProduct = 0x9050, /* C-860 */
565 ZAURUS_MASTER_INTERFACE,
566 .driver_info = 0,
567},
568
569/* Olympus has some models with a Zaurus-compatible option.
570 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
571 */
572{
573 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
574 | USB_DEVICE_ID_MATCH_DEVICE,
575 .idVendor = 0x07B4,
576 .idProduct = 0x0F02, /* R-1000 */
577 ZAURUS_MASTER_INTERFACE,
578 .driver_info = 0,
579},
580
581/* LG Electronics VL600 wants additional headers on every frame */
582{
583 USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
584 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
585 .driver_info = 0,
586},
587
588/* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
589{
590 USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
591 USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
592 .driver_info = 0,
593},
594
595/*
596 * WHITELIST!!!
597 *
598 * CDC Ether uses two interfaces, not necessarily consecutive.
599 * We match the main interface, ignoring the optional device
600 * class so we could handle devices that aren't exclusively
601 * CDC ether.
602 *
603 * NOTE: this match must come AFTER entries blacklisting devices
604 * because of bugs/quirks in a given product (like Zaurus, above).
605 */
606{
607 /* Novatel USB551L */
608 /* This match must come *before* the generic CDC-ETHER match so that
609 * we get FLAG_WWAN set on the device, since it's descriptors are
610 * generic CDC-ETHER.
611 */
612 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
613 | USB_DEVICE_ID_MATCH_PRODUCT
614 | USB_DEVICE_ID_MATCH_INT_INFO,
615 .idVendor = NOVATEL_VENDOR_ID,
616 .idProduct = 0xB001,
617 .bInterfaceClass = USB_CLASS_COMM,
618 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
619 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
620 .driver_info = (unsigned long)&wwan_info,
621}, {
622 /* ZTE (Vodafone) K3805-Z */
623 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
624 | USB_DEVICE_ID_MATCH_PRODUCT
625 | USB_DEVICE_ID_MATCH_INT_INFO,
626 .idVendor = ZTE_VENDOR_ID,
627 .idProduct = 0x1003,
628 .bInterfaceClass = USB_CLASS_COMM,
629 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
630 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
631 .driver_info = (unsigned long)&wwan_info,
632}, {
633 /* ZTE (Vodafone) K3806-Z */
634 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
635 | USB_DEVICE_ID_MATCH_PRODUCT
636 | USB_DEVICE_ID_MATCH_INT_INFO,
637 .idVendor = ZTE_VENDOR_ID,
638 .idProduct = 0x1015,
639 .bInterfaceClass = USB_CLASS_COMM,
640 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
641 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
642 .driver_info = (unsigned long)&wwan_info,
643}, {
644 /* ZTE (Vodafone) K4510-Z */
645 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
646 | USB_DEVICE_ID_MATCH_PRODUCT
647 | USB_DEVICE_ID_MATCH_INT_INFO,
648 .idVendor = ZTE_VENDOR_ID,
649 .idProduct = 0x1173,
650 .bInterfaceClass = USB_CLASS_COMM,
651 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
652 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
653 .driver_info = (unsigned long)&wwan_info,
654}, {
655 /* ZTE (Vodafone) K3770-Z */
656 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
657 | USB_DEVICE_ID_MATCH_PRODUCT
658 | USB_DEVICE_ID_MATCH_INT_INFO,
659 .idVendor = ZTE_VENDOR_ID,
660 .idProduct = 0x1177,
661 .bInterfaceClass = USB_CLASS_COMM,
662 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
663 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
664 .driver_info = (unsigned long)&wwan_info,
665}, {
666 /* ZTE (Vodafone) K3772-Z */
667 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
668 | USB_DEVICE_ID_MATCH_PRODUCT
669 | USB_DEVICE_ID_MATCH_INT_INFO,
670 .idVendor = ZTE_VENDOR_ID,
671 .idProduct = 0x1181,
672 .bInterfaceClass = USB_CLASS_COMM,
673 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
674 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
675 .driver_info = (unsigned long)&wwan_info,
676}, {
677 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
678 USB_CDC_PROTO_NONE),
679 .driver_info = (unsigned long) &cdc_info,
680}, {
681 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
682 USB_CDC_PROTO_NONE),
683 .driver_info = (unsigned long)&wwan_info,
684
685}, {
686 /* Various Huawei modems with a network port like the UMG1831 */
687 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
688 | USB_DEVICE_ID_MATCH_INT_INFO,
689 .idVendor = HUAWEI_VENDOR_ID,
690 .bInterfaceClass = USB_CLASS_COMM,
691 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
692 .bInterfaceProtocol = 255,
693 .driver_info = (unsigned long)&wwan_info,
694},
695 { }, // END
696};
697MODULE_DEVICE_TABLE(usb, products);
698
699static struct usb_driver cdc_driver = {
700 .name = "cdc_ether",
701 .id_table = products,
702 .probe = usbnet_probe,
703 .disconnect = usbnet_disconnect,
704 .suspend = usbnet_suspend,
705 .resume = usbnet_resume,
706 .reset_resume = usbnet_resume,
707 .supports_autosuspend = 1,
708 .disable_hub_initiated_lpm = 1,
709};
710
711module_usb_driver(cdc_driver);
712
713MODULE_AUTHOR("David Brownell");
714MODULE_DESCRIPTION("USB CDC Ethernet devices");
715MODULE_LICENSE("GPL");