drivers/net/usb/cdc_ether.c

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