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