drivers/net/usb/cdc_ether.c

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