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