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 void 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 }
  93 EXPORT_SYMBOL_GPL(usbnet_cdc_update_filter);
  94
  95 /* We need to override usbnet_*_link_ksettings in bind() */
  96 static 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  */
 112 int 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         }
 219 skip:
 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
 330 bad_desc:
 331         dev_info(&dev->udev->dev, "bad CDC descriptors\n");
 332         return -ENODEV;
 333 }
 334 EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
 335
 336
 337 /* like usbnet_generic_cdc_bind() but handles filter initialization
 338  * correctly
 339  */
 340 int 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
 355 bail_out:
 356         return rv;
 357 }
 358 EXPORT_SYMBOL_GPL(usbnet_ether_cdc_bind);
 359
 360 void 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 }
 385 EXPORT_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
 397 static 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
 403 void 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                 if (netif_carrier_ok(dev->net) != !!event->wValue)
 422                         usbnet_link_change(dev, !!event->wValue, 0);
 423                 break;
 424         case USB_CDC_NOTIFY_SPEED_CHANGE:       /* tx/rx rates */
 425                 netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
 426                           urb->actual_length);
 427                 if (urb->actual_length != (sizeof(*event) + 8))
 428                         set_bit(EVENT_STS_SPLIT, &dev->flags);
 429                 else
 430                         speed_change(dev, (__le32 *) &event[1]);
 431                 break;
 432         /* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
 433          * but there are no standard formats for the response data.
 434          */
 435         default:
 436                 netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
 437                            event->bNotificationType);
 438                 break;
 439         }
 440 }
 441 EXPORT_SYMBOL_GPL(usbnet_cdc_status);
 442
 443 int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
 444 {
 445         int                             status;
 446         struct cdc_state                *info = (void *) &dev->data;
 447
 448         BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
 449                         < sizeof(struct cdc_state)));
 450
 451         status = usbnet_ether_cdc_bind(dev, intf);
 452         if (status < 0)
 453                 return status;
 454
 455         status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
 456         if (status < 0) {
 457                 usb_set_intfdata(info->data, NULL);
 458                 usb_driver_release_interface(driver_of(intf), info->data);
 459                 return status;
 460         }
 461
 462         return 0;
 463 }
 464 EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
 465
 466 static int usbnet_cdc_zte_bind(struct usbnet *dev, struct usb_interface *intf)
 467 {
 468         int status = usbnet_cdc_bind(dev, intf);
 469
 470         if (!status && (dev->net->dev_addr[0] & 0x02))
 471                 eth_hw_addr_random(dev->net);
 472
 473         return status;
 474 }
 475
 476 /* Make sure packets have correct destination MAC address
 477  *
 478  * A firmware bug observed on some devices (ZTE MF823/831/910) is that the
 479  * device sends packets with a static, bogus, random MAC address (event if
 480  * device MAC address has been updated). Always set MAC address to that of the
 481  * device.
 482  */
 483 int usbnet_cdc_zte_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
 484 {
 485         if (skb->len < ETH_HLEN || !(skb->data[0] & 0x02))
 486                 return 1;
 487
 488         skb_reset_mac_header(skb);
 489         ether_addr_copy(eth_hdr(skb)->h_dest, dev->net->dev_addr);
 490
 491         return 1;
 492 }
 493 EXPORT_SYMBOL_GPL(usbnet_cdc_zte_rx_fixup);
 494
 495 /* Ensure correct link state
 496  *
 497  * Some devices (ZTE MF823/831/910) export two carrier on notifications when
 498  * connected. This causes the link state to be incorrect. Work around this by
 499  * always setting the state to off, then on.
 500  */
 501 static void usbnet_cdc_zte_status(struct usbnet *dev, struct urb *urb)
 502 {
 503         struct usb_cdc_notification *event;
 504
 505         if (urb->actual_length < sizeof(*event))
 506                 return;
 507
 508         event = urb->transfer_buffer;
 509
 510         if (event->bNotificationType != USB_CDC_NOTIFY_NETWORK_CONNECTION) {
 511                 usbnet_cdc_status(dev, urb);
 512                 return;
 513         }
 514
 515         netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
 516                   event->wValue ? "on" : "off");
 517
 518         if (event->wValue &&
 519             netif_carrier_ok(dev->net))
 520                 netif_carrier_off(dev->net);
 521
 522         usbnet_link_change(dev, !!event->wValue, 0);
 523 }
 524
 525 static const struct driver_info cdc_info = {
 526         .description =  "CDC Ethernet Device",
 527         .flags =        FLAG_ETHER | FLAG_POINTTOPOINT,
 528         .bind =         usbnet_cdc_bind,
 529         .unbind =       usbnet_cdc_unbind,
 530         .status =       usbnet_cdc_status,
 531         .set_rx_mode =  usbnet_cdc_update_filter,
 532         .manage_power = usbnet_manage_power,
 533 };
 534
 535 static const struct driver_info zte_cdc_info = {
 536         .description =  "ZTE CDC Ethernet Device",
 537         .flags =        FLAG_ETHER | FLAG_POINTTOPOINT,
 538         .bind =         usbnet_cdc_zte_bind,
 539         .unbind =       usbnet_cdc_unbind,
 540         .status =       usbnet_cdc_zte_status,
 541         .set_rx_mode =  usbnet_cdc_update_filter,
 542         .manage_power = usbnet_manage_power,
 543         .rx_fixup = usbnet_cdc_zte_rx_fixup,
 544 };
 545
 546 static const struct driver_info wwan_info = {
 547         .description =  "Mobile Broadband Network Device",
 548         .flags =        FLAG_WWAN,
 549         .bind =         usbnet_cdc_bind,
 550         .unbind =       usbnet_cdc_unbind,
 551         .status =       usbnet_cdc_status,
 552         .set_rx_mode =  usbnet_cdc_update_filter,
 553         .manage_power = usbnet_manage_power,
 554 };
 555
 556 /*-------------------------------------------------------------------------*/
 557
 558 #define HUAWEI_VENDOR_ID        0x12D1
 559 #define NOVATEL_VENDOR_ID       0x1410
 560 #define ZTE_VENDOR_ID           0x19D2
 561 #define DELL_VENDOR_ID          0x413C
 562 #define REALTEK_VENDOR_ID       0x0bda
 563 #define SAMSUNG_VENDOR_ID       0x04e8
 564 #define LENOVO_VENDOR_ID        0x17ef
 565 #define LINKSYS_VENDOR_ID       0x13b1
 566 #define NVIDIA_VENDOR_ID        0x0955
 567 #define HP_VENDOR_ID            0x03f0
 568 #define MICROSOFT_VENDOR_ID     0x045e
 569 #define UBLOX_VENDOR_ID         0x1546
 570 #define TPLINK_VENDOR_ID        0x2357
 571 #define AQUANTIA_VENDOR_ID      0x2eca
 572 #define ASIX_VENDOR_ID          0x0b95
 573
 574 static const struct usb_device_id       products[] = {
 575 /* BLACKLIST !!
 576  *
 577  * First blacklist any products that are egregiously nonconformant
 578  * with the CDC Ethernet specs.  Minor braindamage we cope with; when
 579  * they're not even trying, needing a separate driver is only the first
 580  * of the differences to show up.
 581  */
 582
 583 #define ZAURUS_MASTER_INTERFACE \
 584         .bInterfaceClass        = USB_CLASS_COMM, \
 585         .bInterfaceSubClass     = USB_CDC_SUBCLASS_ETHERNET, \
 586         .bInterfaceProtocol     = USB_CDC_PROTO_NONE
 587
 588 #define ZAURUS_FAKE_INTERFACE \
 589         .bInterfaceClass        = USB_CLASS_COMM, \
 590         .bInterfaceSubClass     = USB_CDC_SUBCLASS_MDLM, \
 591         .bInterfaceProtocol     = USB_CDC_PROTO_NONE
 592
 593 /* SA-1100 based Sharp Zaurus ("collie"), or compatible;
 594  * wire-incompatible with true CDC Ethernet implementations.
 595  * (And, it seems, needlessly so...)
 596  */
 597 {
 598         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 599                           | USB_DEVICE_ID_MATCH_DEVICE,
 600         .idVendor               = 0x04DD,
 601         .idProduct              = 0x8004,
 602         ZAURUS_MASTER_INTERFACE,
 603         .driver_info            = 0,
 604 },
 605
 606 /* PXA-25x based Sharp Zaurii.  Note that it seems some of these
 607  * (later models especially) may have shipped only with firmware
 608  * advertising false "CDC MDLM" compatibility ... but we're not
 609  * clear which models did that, so for now let's assume the worst.
 610  */
 611 {
 612         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 613                           | USB_DEVICE_ID_MATCH_DEVICE,
 614         .idVendor               = 0x04DD,
 615         .idProduct              = 0x8005,       /* A-300 */
 616         ZAURUS_MASTER_INTERFACE,
 617         .driver_info            = 0,
 618 }, {
 619         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 620                           | USB_DEVICE_ID_MATCH_DEVICE,
 621         .idVendor               = 0x04DD,
 622         .idProduct              = 0x8005,   /* A-300 */
 623         ZAURUS_FAKE_INTERFACE,
 624         .driver_info        = 0,
 625 }, {
 626         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 627                           | USB_DEVICE_ID_MATCH_DEVICE,
 628         .idVendor               = 0x04DD,
 629         .idProduct              = 0x8006,       /* B-500/SL-5600 */
 630         ZAURUS_MASTER_INTERFACE,
 631         .driver_info            = 0,
 632 }, {
 633         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 634                           | USB_DEVICE_ID_MATCH_DEVICE,
 635         .idVendor               = 0x04DD,
 636         .idProduct              = 0x8006,   /* B-500/SL-5600 */
 637         ZAURUS_FAKE_INTERFACE,
 638         .driver_info        = 0,
 639 }, {
 640         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 641                           | USB_DEVICE_ID_MATCH_DEVICE,
 642         .idVendor               = 0x04DD,
 643         .idProduct              = 0x8007,       /* C-700 */
 644         ZAURUS_MASTER_INTERFACE,
 645         .driver_info            = 0,
 646 }, {
 647         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 648                           | USB_DEVICE_ID_MATCH_DEVICE,
 649         .idVendor               = 0x04DD,
 650         .idProduct              = 0x8007,   /* C-700 */
 651         ZAURUS_FAKE_INTERFACE,
 652         .driver_info        = 0,
 653 }, {
 654         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 655                  | USB_DEVICE_ID_MATCH_DEVICE,
 656         .idVendor               = 0x04DD,
 657         .idProduct              = 0x9031,       /* C-750 C-760 */
 658         ZAURUS_MASTER_INTERFACE,
 659         .driver_info            = 0,
 660 }, {
 661         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 662                  | USB_DEVICE_ID_MATCH_DEVICE,
 663         .idVendor               = 0x04DD,
 664         .idProduct              = 0x9032,       /* SL-6000 */
 665         ZAURUS_MASTER_INTERFACE,
 666         .driver_info            = 0,
 667 }, {
 668         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 669                  | USB_DEVICE_ID_MATCH_DEVICE,
 670         .idVendor               = 0x04DD,
 671         .idProduct              = 0x9032,       /* SL-6000 */
 672         ZAURUS_FAKE_INTERFACE,
 673         .driver_info            = 0,
 674 }, {
 675         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 676                  | USB_DEVICE_ID_MATCH_DEVICE,
 677         .idVendor               = 0x04DD,
 678         /* reported with some C860 units */
 679         .idProduct              = 0x9050,       /* C-860 */
 680         ZAURUS_MASTER_INTERFACE,
 681         .driver_info            = 0,
 682 },
 683
 684 /* Olympus has some models with a Zaurus-compatible option.
 685  * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
 686  */
 687 {
 688         .match_flags    =   USB_DEVICE_ID_MATCH_INT_INFO
 689                  | USB_DEVICE_ID_MATCH_DEVICE,
 690         .idVendor               = 0x07B4,
 691         .idProduct              = 0x0F02,       /* R-1000 */
 692         ZAURUS_MASTER_INTERFACE,
 693         .driver_info            = 0,
 694 },
 695
 696 /* LG Electronics VL600 wants additional headers on every frame */
 697 {
 698         USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
 699                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 700         .driver_info = 0,
 701 },
 702
 703 /* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
 704 {
 705         USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
 706                         USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
 707         .driver_info            = 0,
 708 },
 709
 710 /* Novatel USB551L and MC551 - handled by qmi_wwan */
 711 {
 712         USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0xB001, USB_CLASS_COMM,
 713                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 714         .driver_info = 0,
 715 },
 716
 717 /* Novatel E362 - handled by qmi_wwan */
 718 {
 719         USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9010, USB_CLASS_COMM,
 720                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 721         .driver_info = 0,
 722 },
 723
 724 /* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
 725 {
 726         USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8195, USB_CLASS_COMM,
 727                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 728         .driver_info = 0,
 729 },
 730
 731 /* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
 732 {
 733         USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8196, USB_CLASS_COMM,
 734                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 735         .driver_info = 0,
 736 },
 737
 738 /* Dell Wireless 5804 (Novatel E371) - handled by qmi_wwan */
 739 {
 740         USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x819b, USB_CLASS_COMM,
 741                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 742         .driver_info = 0,
 743 },
 744
 745 /* Novatel Expedite E371 - handled by qmi_wwan */
 746 {
 747         USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9011, USB_CLASS_COMM,
 748                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 749         .driver_info = 0,
 750 },
 751
 752 /* HP lt2523 (Novatel E371) - handled by qmi_wwan */
 753 {
 754         USB_DEVICE_AND_INTERFACE_INFO(HP_VENDOR_ID, 0x421d, USB_CLASS_COMM,
 755                                       USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 756         .driver_info = 0,
 757 },
 758
 759 /* AnyDATA ADU960S - handled by qmi_wwan */
 760 {
 761         USB_DEVICE_AND_INTERFACE_INFO(0x16d5, 0x650a, USB_CLASS_COMM,
 762                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 763         .driver_info = 0,
 764 },
 765
 766 /* Huawei E1820 - handled by qmi_wwan */
 767 {
 768         USB_DEVICE_INTERFACE_NUMBER(HUAWEI_VENDOR_ID, 0x14ac, 1),
 769         .driver_info = 0,
 770 },
 771
 772 /* Realtek RTL8153 Based USB 3.0 Ethernet Adapters */
 773 {
 774         USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8153, USB_CLASS_COMM,
 775                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 776         .driver_info = 0,
 777 },
 778
 779 /* Lenovo Powered USB-C Travel Hub (4X90S92381, based on Realtek RTL8153) */
 780 {
 781         USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x721e, USB_CLASS_COMM,
 782                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 783         .driver_info = 0,
 784 },
 785
 786 /* Aquantia AQtion USB to 5GbE Controller (based on AQC111U) */
 787 {
 788         USB_DEVICE_AND_INTERFACE_INFO(AQUANTIA_VENDOR_ID, 0xc101,
 789                                       USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
 790                                       USB_CDC_PROTO_NONE),
 791         .driver_info = 0,
 792 },
 793
 794 /* ASIX USB 3.1 Gen1 to 5G Multi-Gigabit Ethernet Adapter(based on AQC111U) */
 795 {
 796         USB_DEVICE_AND_INTERFACE_INFO(ASIX_VENDOR_ID, 0x2790, USB_CLASS_COMM,
 797                                       USB_CDC_SUBCLASS_ETHERNET,
 798                                       USB_CDC_PROTO_NONE),
 799         .driver_info = 0,
 800 },
 801
 802 /* ASIX USB 3.1 Gen1 to 2.5G Multi-Gigabit Ethernet Adapter(based on AQC112U) */
 803 {
 804         USB_DEVICE_AND_INTERFACE_INFO(ASIX_VENDOR_ID, 0x2791, USB_CLASS_COMM,
 805                                       USB_CDC_SUBCLASS_ETHERNET,
 806                                       USB_CDC_PROTO_NONE),
 807         .driver_info = 0,
 808 },
 809
 810 /* USB-C 3.1 to 5GBASE-T Ethernet Adapter (based on AQC111U) */
 811 {
 812         USB_DEVICE_AND_INTERFACE_INFO(0x20f4, 0xe05a, USB_CLASS_COMM,
 813                                       USB_CDC_SUBCLASS_ETHERNET,
 814                                       USB_CDC_PROTO_NONE),
 815         .driver_info = 0,
 816 },
 817
 818 /* QNAP QNA-UC5G1T USB to 5GbE Adapter (based on AQC111U) */
 819 {
 820         USB_DEVICE_AND_INTERFACE_INFO(0x1c04, 0x0015, USB_CLASS_COMM,
 821                                       USB_CDC_SUBCLASS_ETHERNET,
 822                                       USB_CDC_PROTO_NONE),
 823         .driver_info = 0,
 824 },
 825
 826 /* WHITELIST!!!
 827  *
 828  * CDC Ether uses two interfaces, not necessarily consecutive.
 829  * We match the main interface, ignoring the optional device
 830  * class so we could handle devices that aren't exclusively
 831  * CDC ether.
 832  *
 833  * NOTE:  this match must come AFTER entries blacklisting devices
 834  * because of bugs/quirks in a given product (like Zaurus, above).
 835  */
 836 {
 837         /* ZTE (Vodafone) K3805-Z */
 838         USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1003, USB_CLASS_COMM,
 839                                       USB_CDC_SUBCLASS_ETHERNET,
 840                                       USB_CDC_PROTO_NONE),
 841         .driver_info = (unsigned long)&wwan_info,
 842 }, {
 843         /* ZTE (Vodafone) K3806-Z */
 844         USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1015, USB_CLASS_COMM,
 845                                       USB_CDC_SUBCLASS_ETHERNET,
 846                                       USB_CDC_PROTO_NONE),
 847         .driver_info = (unsigned long)&wwan_info,
 848 }, {
 849         /* ZTE (Vodafone) K4510-Z */
 850         USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1173, USB_CLASS_COMM,
 851                                       USB_CDC_SUBCLASS_ETHERNET,
 852                                       USB_CDC_PROTO_NONE),
 853         .driver_info = (unsigned long)&wwan_info,
 854 }, {
 855         /* ZTE (Vodafone) K3770-Z */
 856         USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1177, USB_CLASS_COMM,
 857                                       USB_CDC_SUBCLASS_ETHERNET,
 858                                       USB_CDC_PROTO_NONE),
 859         .driver_info = (unsigned long)&wwan_info,
 860 }, {
 861         /* ZTE (Vodafone) K3772-Z */
 862         USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1181, USB_CLASS_COMM,
 863                                       USB_CDC_SUBCLASS_ETHERNET,
 864                                       USB_CDC_PROTO_NONE),
 865         .driver_info = (unsigned long)&wwan_info,
 866 }, {
 867         /* Telit modules */
 868         USB_VENDOR_AND_INTERFACE_INFO(0x1bc7, USB_CLASS_COMM,
 869                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 870         .driver_info = (kernel_ulong_t) &wwan_info,
 871 }, {
 872         /* Dell DW5580 modules */
 873         USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x81ba, USB_CLASS_COMM,
 874                         USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
 875         .driver_info = (kernel_ulong_t)&wwan_info,
 876 }, {
 877         /* Huawei ME906 and ME909 */
 878         USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, 0x15c1, USB_CLASS_COMM,
 879                                       USB_CDC_SUBCLASS_ETHERNET,
 880                                       USB_CDC_PROTO_NONE),
 881         .driver_info = (unsigned long)&wwan_info,
 882 }, {
 883         /* ZTE modules */
 884         USB_VENDOR_AND_INTERFACE_INFO(ZTE_VENDOR_ID, USB_CLASS_COMM,
 885                                       USB_CDC_SUBCLASS_ETHERNET,
 886                                       USB_CDC_PROTO_NONE),
 887         .driver_info = (unsigned long)&zte_cdc_info,
 888 }, {
 889         /* U-blox TOBY-L2 */
 890         USB_DEVICE_AND_INTERFACE_INFO(UBLOX_VENDOR_ID, 0x1143, USB_CLASS_COMM,
 891                                       USB_CDC_SUBCLASS_ETHERNET,
 892                                       USB_CDC_PROTO_NONE),
 893         .driver_info = (unsigned long)&wwan_info,
 894 }, {
 895         /* U-blox SARA-U2 */
 896         USB_DEVICE_AND_INTERFACE_INFO(UBLOX_VENDOR_ID, 0x1104, USB_CLASS_COMM,
 897                                       USB_CDC_SUBCLASS_ETHERNET,
 898                                       USB_CDC_PROTO_NONE),
 899         .driver_info = (unsigned long)&wwan_info,
 900 }, {
 901         /* U-blox LARA-R6 01B */
 902         USB_DEVICE_AND_INTERFACE_INFO(UBLOX_VENDOR_ID, 0x1313, USB_CLASS_COMM,
 903                                       USB_CDC_SUBCLASS_ETHERNET,
 904                                       USB_CDC_PROTO_NONE),
 905         .driver_info = (unsigned long)&wwan_info,
 906 }, {
 907         /* U-blox LARA-L6 */
 908         USB_DEVICE_AND_INTERFACE_INFO(UBLOX_VENDOR_ID, 0x1343, USB_CLASS_COMM,
 909                                       USB_CDC_SUBCLASS_ETHERNET,
 910                                       USB_CDC_PROTO_NONE),
 911         .driver_info = (unsigned long)&wwan_info,
 912 }, {
 913         /* Cinterion PLS8 modem by GEMALTO */
 914         USB_DEVICE_AND_INTERFACE_INFO(0x1e2d, 0x0061, USB_CLASS_COMM,
 915                                       USB_CDC_SUBCLASS_ETHERNET,
 916                                       USB_CDC_PROTO_NONE),
 917         .driver_info = (unsigned long)&wwan_info,
 918 }, {
 919         /* Cinterion AHS3 modem by GEMALTO */
 920         USB_DEVICE_AND_INTERFACE_INFO(0x1e2d, 0x0055, USB_CLASS_COMM,
 921                                       USB_CDC_SUBCLASS_ETHERNET,
 922                                       USB_CDC_PROTO_NONE),
 923         .driver_info = (unsigned long)&wwan_info,
 924 }, {
 925         /* Cinterion PLS62-W modem by GEMALTO/THALES */
 926         USB_DEVICE_AND_INTERFACE_INFO(0x1e2d, 0x005b, USB_CLASS_COMM,
 927                                       USB_CDC_SUBCLASS_ETHERNET,
 928                                       USB_CDC_PROTO_NONE),
 929         .driver_info = (unsigned long)&wwan_info,
 930 }, {
 931         /* Cinterion PLS83/PLS63 modem by GEMALTO/THALES */
 932         USB_DEVICE_AND_INTERFACE_INFO(0x1e2d, 0x0069, 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");