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