blob: 35a2bffe848ad150a3c6bf0e1d66365ae605ac77 [file] [log] [blame]
David Brownell4324fd42005-08-31 09:54:20 -07001/*
2 * CDC Ethernet based networking peripherals
3 * Copyright (C) 2003-2005 by David Brownell
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -08004 * Copyright (C) 2006 by Ole Andre Vadla Ravnas (ActiveSync)
David Brownell4324fd42005-08-31 09:54:20 -07005 *
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
Jeff Kirsher9cb00072013-12-06 06:28:46 -080017 * along with this program; if not, see <http://www.gnu.org/licenses/>.
David Brownell4324fd42005-08-31 09:54:20 -070018 */
19
20// #define DEBUG // error path messages, extra info
21// #define VERBOSE // more; success messages
22
David Brownell4324fd42005-08-31 09:54:20 -070023#include <linux/module.h>
David Brownell4324fd42005-08-31 09:54:20 -070024#include <linux/netdevice.h>
25#include <linux/etherdevice.h>
David Brownell4324fd42005-08-31 09:54:20 -070026#include <linux/ethtool.h>
27#include <linux/workqueue.h>
28#include <linux/mii.h>
29#include <linux/usb.h>
David Brownella8c28f22006-06-13 09:57:47 -070030#include <linux/usb/cdc.h>
Jussi Kivilinna3692e942008-01-26 00:51:45 +020031#include <linux/usb/usbnet.h>
David Brownell4324fd42005-08-31 09:54:20 -070032
33
Fabio Porcedda8857ec22013-09-16 11:47:51 +020034#if IS_ENABLED(CONFIG_USB_NET_RNDIS_HOST)
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080035
36static int is_rndis(struct usb_interface_descriptor *desc)
37{
Joe Perches8e95a202009-12-03 07:58:21 +000038 return (desc->bInterfaceClass == USB_CLASS_COMM &&
39 desc->bInterfaceSubClass == 2 &&
40 desc->bInterfaceProtocol == 0xff);
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080041}
42
43static int is_activesync(struct usb_interface_descriptor *desc)
44{
Joe Perches8e95a202009-12-03 07:58:21 +000045 return (desc->bInterfaceClass == USB_CLASS_MISC &&
46 desc->bInterfaceSubClass == 1 &&
47 desc->bInterfaceProtocol == 1);
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080048}
49
Thomas Backlund7e99eed2008-07-22 13:55:58 -070050static int is_wireless_rndis(struct usb_interface_descriptor *desc)
51{
Joe Perches8e95a202009-12-03 07:58:21 +000052 return (desc->bInterfaceClass == USB_CLASS_WIRELESS_CONTROLLER &&
53 desc->bInterfaceSubClass == 1 &&
54 desc->bInterfaceProtocol == 3);
Thomas Backlund7e99eed2008-07-22 13:55:58 -070055}
56
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080057#else
58
59#define is_rndis(desc) 0
60#define is_activesync(desc) 0
Thomas Backlund7e99eed2008-07-22 13:55:58 -070061#define is_wireless_rndis(desc) 0
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080062
63#endif
64
Jonas Sjöquist21851262010-04-23 01:07:45 +000065static 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
Olivier Blind80c6792014-10-24 19:43:01 +020070static void usbnet_cdc_update_filter(struct usbnet *dev)
71{
72 struct cdc_state *info = (void *) &dev->data;
73 struct usb_interface *intf = info->control;
Oliver Neukumf46ad732014-11-06 15:19:14 +010074 struct net_device *net = dev->net;
Olivier Blind80c6792014-10-24 19:43:01 +020075
Oliver Neukumf46ad732014-11-06 15:19:14 +010076 u16 cdc_filter = USB_CDC_PACKET_TYPE_DIRECTED
77 | USB_CDC_PACKET_TYPE_BROADCAST;
Olivier Blind80c6792014-10-24 19:43:01 +020078
Oliver Neukumf46ad732014-11-06 15:19:14 +010079 /* 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
Olivier Blind80c6792014-10-24 19:43:01 +020082 */
Oliver Neukumf46ad732014-11-06 15:19:14 +010083 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;
Olivier Blind80c6792014-10-24 19:43:01 +020087
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
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200100/* probes control interface, claims data interface, collects the bulk
David Brownell4324fd42005-08-31 09:54:20 -0700101 * 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 */
105int 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;
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000113 bool android_rndis_quirk = false;
David Brownell4324fd42005-08-31 09:54:20 -0700114 struct usb_driver *driver = driver_of(intf);
Jonas Sjöquist21851262010-04-23 01:07:45 +0000115 struct usb_cdc_mdlm_desc *desc = NULL;
116 struct usb_cdc_mdlm_detail_desc *detail = NULL;
David Brownell4324fd42005-08-31 09:54:20 -0700117
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200118 if (sizeof(dev->data) < sizeof(*info))
David Brownell4324fd42005-08-31 09:54:20 -0700119 return -EDOM;
120
121 /* expect strict spec conformance for the descriptors, but
122 * cope with firmware which stores them in the wrong place
123 */
124 if (len == 0 && dev->udev->actconfig->extralen) {
125 /* Motorola SB4100 (and others: Brad Hards says it's
126 * from a Broadcom design) put CDC descriptors here
127 */
128 buf = dev->udev->actconfig->extra;
129 len = dev->udev->actconfig->extralen;
Dan Carpenterf5260f02010-12-25 12:23:42 +0000130 dev_dbg(&intf->dev, "CDC descriptors on config\n");
David Brownell4324fd42005-08-31 09:54:20 -0700131 }
132
David Brownell4149b722007-04-29 10:09:47 -0700133 /* Maybe CDC descriptors are after the endpoint? This bug has
134 * been seen on some 2Wire Inc RNDIS-ish products.
135 */
136 if (len == 0) {
137 struct usb_host_endpoint *hep;
138
139 hep = intf->cur_altsetting->endpoint;
140 if (hep) {
141 buf = hep->extra;
142 len = hep->extralen;
143 }
144 if (len)
145 dev_dbg(&intf->dev,
146 "CDC descriptors on endpoint\n");
147 }
148
David Brownell4324fd42005-08-31 09:54:20 -0700149 /* this assumes that if there's a non-RNDIS vendor variant
150 * of cdc-acm, it'll fail RNDIS requests cleanly.
151 */
Joe Perches8e95a202009-12-03 07:58:21 +0000152 rndis = (is_rndis(&intf->cur_altsetting->desc) ||
153 is_activesync(&intf->cur_altsetting->desc) ||
154 is_wireless_rndis(&intf->cur_altsetting->desc));
David Brownell4324fd42005-08-31 09:54:20 -0700155
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200156 memset(info, 0, sizeof(*info));
David Brownell4324fd42005-08-31 09:54:20 -0700157 info->control = intf;
158 while (len > 3) {
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200159 if (buf[1] != USB_DT_CS_INTERFACE)
David Brownell4324fd42005-08-31 09:54:20 -0700160 goto next_desc;
161
162 /* use bDescriptorSubType to identify the CDC descriptors.
163 * We expect devices with CDC header and union descriptors.
164 * For CDC Ethernet we need the ethernet descriptor.
165 * For RNDIS, ignore two (pointless) CDC modem descriptors
166 * in favor of a complicated OID-based RPC scheme doing what
167 * CDC Ethernet achieves with a simple descriptor.
168 */
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200169 switch (buf[2]) {
David Brownell4324fd42005-08-31 09:54:20 -0700170 case USB_CDC_HEADER_TYPE:
171 if (info->header) {
172 dev_dbg(&intf->dev, "extra CDC header\n");
173 goto bad_desc;
174 }
175 info->header = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200176 if (info->header->bLength != sizeof(*info->header)) {
David Brownell4324fd42005-08-31 09:54:20 -0700177 dev_dbg(&intf->dev, "CDC header len %u\n",
178 info->header->bLength);
179 goto bad_desc;
180 }
181 break;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800182 case USB_CDC_ACM_TYPE:
183 /* paranoia: disambiguate a "real" vendor-specific
184 * modem interface from an RNDIS non-modem.
185 */
186 if (rndis) {
David Brownellafaee822007-07-01 11:47:59 -0700187 struct usb_cdc_acm_descriptor *acm;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800188
David Brownellafaee822007-07-01 11:47:59 -0700189 acm = (void *) buf;
190 if (acm->bmCapabilities) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800191 dev_dbg(&intf->dev,
192 "ACM capabilities %02x, "
193 "not really RNDIS?\n",
David Brownellafaee822007-07-01 11:47:59 -0700194 acm->bmCapabilities);
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800195 goto bad_desc;
196 }
197 }
198 break;
David Brownell4324fd42005-08-31 09:54:20 -0700199 case USB_CDC_UNION_TYPE:
200 if (info->u) {
201 dev_dbg(&intf->dev, "extra CDC union\n");
202 goto bad_desc;
203 }
204 info->u = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200205 if (info->u->bLength != sizeof(*info->u)) {
David Brownell4324fd42005-08-31 09:54:20 -0700206 dev_dbg(&intf->dev, "CDC union len %u\n",
207 info->u->bLength);
208 goto bad_desc;
209 }
210
211 /* we need a master/control interface (what we're
212 * probed with) and a slave/data interface; union
213 * descriptors sort this all out.
214 */
215 info->control = usb_ifnum_to_if(dev->udev,
216 info->u->bMasterInterface0);
217 info->data = usb_ifnum_to_if(dev->udev,
218 info->u->bSlaveInterface0);
219 if (!info->control || !info->data) {
220 dev_dbg(&intf->dev,
221 "master #%u/%p slave #%u/%p\n",
222 info->u->bMasterInterface0,
223 info->control,
224 info->u->bSlaveInterface0,
225 info->data);
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000226 /* fall back to hard-wiring for RNDIS */
227 if (rndis) {
228 android_rndis_quirk = true;
229 goto next_desc;
230 }
David Brownell4324fd42005-08-31 09:54:20 -0700231 goto bad_desc;
232 }
233 if (info->control != intf) {
234 dev_dbg(&intf->dev, "bogus CDC Union\n");
235 /* Ambit USB Cable Modem (and maybe others)
236 * interchanges master and slave interface.
237 */
238 if (info->data == intf) {
239 info->data = info->control;
240 info->control = intf;
241 } else
242 goto bad_desc;
243 }
244
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200245 /* some devices merge these - skip class check */
246 if (info->control == info->data)
247 goto next_desc;
248
David Brownell4324fd42005-08-31 09:54:20 -0700249 /* a data interface altsetting does the real i/o */
250 d = &info->data->cur_altsetting->desc;
251 if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
252 dev_dbg(&intf->dev, "slave class %u\n",
253 d->bInterfaceClass);
254 goto bad_desc;
255 }
256 break;
257 case USB_CDC_ETHERNET_TYPE:
258 if (info->ether) {
259 dev_dbg(&intf->dev, "extra CDC ether\n");
260 goto bad_desc;
261 }
262 info->ether = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200263 if (info->ether->bLength != sizeof(*info->ether)) {
David Brownell4324fd42005-08-31 09:54:20 -0700264 dev_dbg(&intf->dev, "CDC ether len %u\n",
265 info->ether->bLength);
266 goto bad_desc;
267 }
268 dev->hard_mtu = le16_to_cpu(
269 info->ether->wMaxSegmentSize);
270 /* because of Zaurus, we may be ignoring the host
271 * side link address we were given.
272 */
273 break;
Jonas Sjöquist21851262010-04-23 01:07:45 +0000274 case USB_CDC_MDLM_TYPE:
275 if (desc) {
276 dev_dbg(&intf->dev, "extra MDLM descriptor\n");
277 goto bad_desc;
278 }
279
280 desc = (void *)buf;
281
282 if (desc->bLength != sizeof(*desc))
283 goto bad_desc;
284
285 if (memcmp(&desc->bGUID, mbm_guid, 16))
286 goto bad_desc;
287 break;
288 case USB_CDC_MDLM_DETAIL_TYPE:
289 if (detail) {
290 dev_dbg(&intf->dev, "extra MDLM detail descriptor\n");
291 goto bad_desc;
292 }
293
294 detail = (void *)buf;
295
296 if (detail->bGuidDescriptorType == 0) {
297 if (detail->bLength < (sizeof(*detail) + 1))
298 goto bad_desc;
299 } else
300 goto bad_desc;
301 break;
David Brownell4324fd42005-08-31 09:54:20 -0700302 }
303next_desc:
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200304 len -= buf[0]; /* bLength */
305 buf += buf[0];
David Brownell4324fd42005-08-31 09:54:20 -0700306 }
307
Bjorge Dijkstra786e3df2008-01-26 00:50:44 +0200308 /* Microsoft ActiveSync based and some regular RNDIS devices lack the
309 * CDC descriptors, so we'll hard-wire the interfaces and not check
310 * for descriptors.
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000311 *
312 * Some Android RNDIS devices have a CDC Union descriptor pointing
313 * to non-existing interfaces. Ignore that and attempt the same
314 * hard-wired 0 and 1 interfaces.
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800315 */
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000316 if (rndis && (!info->u || android_rndis_quirk)) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800317 info->control = usb_ifnum_to_if(dev->udev, 0);
318 info->data = usb_ifnum_to_if(dev->udev, 1);
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000319 if (!info->control || !info->data || info->control != intf) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800320 dev_dbg(&intf->dev,
Bjorge Dijkstra786e3df2008-01-26 00:50:44 +0200321 "rndis: master #0/%p slave #1/%p\n",
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800322 info->control,
323 info->data);
324 goto bad_desc;
325 }
326
327 } else if (!info->header || !info->u || (!rndis && !info->ether)) {
David Brownell4324fd42005-08-31 09:54:20 -0700328 dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
329 info->header ? "" : "header ",
330 info->u ? "" : "union ",
331 info->ether ? "" : "ether ");
332 goto bad_desc;
333 }
334
335 /* claim data interface and set it up ... with side effects.
336 * network traffic can't flow until an altsetting is enabled.
337 */
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200338 if (info->data != info->control) {
339 status = usb_driver_claim_interface(driver, info->data, dev);
340 if (status < 0)
341 return status;
342 }
David Brownell4324fd42005-08-31 09:54:20 -0700343 status = usbnet_get_endpoints(dev, info->data);
344 if (status < 0) {
345 /* ensure immediate exit from usbnet_disconnect */
346 usb_set_intfdata(info->data, NULL);
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200347 if (info->data != info->control)
348 usb_driver_release_interface(driver, info->data);
David Brownell4324fd42005-08-31 09:54:20 -0700349 return status;
350 }
351
352 /* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200353 if (info->data != info->control)
354 dev->status = NULL;
David Brownell4324fd42005-08-31 09:54:20 -0700355 if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
356 struct usb_endpoint_descriptor *desc;
357
358 dev->status = &info->control->cur_altsetting->endpoint [0];
359 desc = &dev->status->desc;
Joe Perches8e95a202009-12-03 07:58:21 +0000360 if (!usb_endpoint_is_int_in(desc) ||
361 (le16_to_cpu(desc->wMaxPacketSize)
362 < sizeof(struct usb_cdc_notification)) ||
363 !desc->bInterval) {
David Brownell4324fd42005-08-31 09:54:20 -0700364 dev_dbg(&intf->dev, "bad notification endpoint\n");
365 dev->status = NULL;
366 }
367 }
368 if (rndis && !dev->status) {
369 dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
370 usb_set_intfdata(info->data, NULL);
371 usb_driver_release_interface(driver, info->data);
372 return -ENODEV;
373 }
Oliver Neukumc472ab62014-07-28 10:56:36 +0200374
375 /* Some devices don't initialise properly. In particular
376 * the packet filter is not reset. There are devices that
377 * don't do reset all the way. So the packet filter should
378 * be set to a sane initial value.
379 */
Olivier Blind80c6792014-10-24 19:43:01 +0200380 usbnet_cdc_update_filter(dev);
381
David Brownell4324fd42005-08-31 09:54:20 -0700382 return 0;
383
384bad_desc:
385 dev_info(&dev->udev->dev, "bad CDC descriptors\n");
386 return -ENODEV;
387}
388EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
389
390void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
391{
392 struct cdc_state *info = (void *) &dev->data;
393 struct usb_driver *driver = driver_of(intf);
394
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200395 /* combined interface - nothing to do */
396 if (info->data == info->control)
397 return;
398
David Brownell4324fd42005-08-31 09:54:20 -0700399 /* disconnect master --> disconnect slave */
400 if (intf == info->control && info->data) {
401 /* ensure immediate exit from usbnet_disconnect */
402 usb_set_intfdata(info->data, NULL);
403 usb_driver_release_interface(driver, info->data);
404 info->data = NULL;
405 }
406
407 /* and vice versa (just in case) */
408 else if (intf == info->data && info->control) {
409 /* ensure immediate exit from usbnet_disconnect */
410 usb_set_intfdata(info->control, NULL);
411 usb_driver_release_interface(driver, info->control);
412 info->control = NULL;
413 }
414}
415EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
416
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200417/* Communications Device Class, Ethernet Control model
David Brownell4324fd42005-08-31 09:54:20 -0700418 *
419 * Takes two interfaces. The DATA interface is inactive till an altsetting
420 * is selected. Configuration data includes class descriptors. There's
421 * an optional status endpoint on the control interface.
422 *
423 * This should interop with whatever the 2.4 "CDCEther.c" driver
424 * (by Brad Hards) talked with, with more functionality.
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200425 */
David Brownell4324fd42005-08-31 09:54:20 -0700426
427static void dumpspeed(struct usbnet *dev, __le32 *speeds)
428{
Joe Perchesa475f602010-02-17 10:30:24 +0000429 netif_info(dev, timer, dev->net,
430 "link speeds: %u kbps up, %u kbps down\n",
431 __le32_to_cpu(speeds[0]) / 1000,
432 __le32_to_cpu(speeds[1]) / 1000);
David Brownell4324fd42005-08-31 09:54:20 -0700433}
434
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000435void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
David Brownell4324fd42005-08-31 09:54:20 -0700436{
437 struct usb_cdc_notification *event;
438
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200439 if (urb->actual_length < sizeof(*event))
David Brownell4324fd42005-08-31 09:54:20 -0700440 return;
441
442 /* SPEED_CHANGE can get split into two 8-byte packets */
443 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
444 dumpspeed(dev, (__le32 *) urb->transfer_buffer);
445 return;
446 }
447
448 event = urb->transfer_buffer;
449 switch (event->bNotificationType) {
450 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
Joe Perchesa475f602010-02-17 10:30:24 +0000451 netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
452 event->wValue ? "on" : "off");
Bjørn Morka6bda452013-04-16 22:12:13 +0000453 usbnet_link_change(dev, !!event->wValue, 0);
David Brownell4324fd42005-08-31 09:54:20 -0700454 break;
455 case USB_CDC_NOTIFY_SPEED_CHANGE: /* tx/rx rates */
Joe Perchesa475f602010-02-17 10:30:24 +0000456 netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
457 urb->actual_length);
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200458 if (urb->actual_length != (sizeof(*event) + 8))
David Brownell4324fd42005-08-31 09:54:20 -0700459 set_bit(EVENT_STS_SPLIT, &dev->flags);
460 else
461 dumpspeed(dev, (__le32 *) &event[1]);
462 break;
463 /* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
464 * but there are no standard formats for the response data.
465 */
466 default:
Joe Perches60b86752010-02-17 10:30:23 +0000467 netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
468 event->bNotificationType);
David Brownell4324fd42005-08-31 09:54:20 -0700469 break;
470 }
471}
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000472EXPORT_SYMBOL_GPL(usbnet_cdc_status);
David Brownell4324fd42005-08-31 09:54:20 -0700473
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000474int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
David Brownell4324fd42005-08-31 09:54:20 -0700475{
476 int status;
477 struct cdc_state *info = (void *) &dev->data;
478
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800479 BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
480 < sizeof(struct cdc_state)));
481
David Brownell4324fd42005-08-31 09:54:20 -0700482 status = usbnet_generic_cdc_bind(dev, intf);
483 if (status < 0)
484 return status;
485
Peter Holik03ad0322009-04-18 07:24:17 +0000486 status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
David Brownell4324fd42005-08-31 09:54:20 -0700487 if (status < 0) {
488 usb_set_intfdata(info->data, NULL);
489 usb_driver_release_interface(driver_of(intf), info->data);
490 return status;
491 }
492
David Brownell4324fd42005-08-31 09:54:20 -0700493 return 0;
494}
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000495EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
David Brownell4324fd42005-08-31 09:54:20 -0700496
497static const struct driver_info cdc_info = {
498 .description = "CDC Ethernet Device",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700499 .flags = FLAG_ETHER | FLAG_POINTTOPOINT,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000500 .bind = usbnet_cdc_bind,
David Brownell4324fd42005-08-31 09:54:20 -0700501 .unbind = usbnet_cdc_unbind,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000502 .status = usbnet_cdc_status,
Olivier Blinb77e26d2014-10-24 19:43:02 +0200503 .set_rx_mode = usbnet_cdc_update_filter,
Oliver Neukuma5e40702012-12-18 04:46:12 +0000504 .manage_power = usbnet_manage_power,
David Brownell4324fd42005-08-31 09:54:20 -0700505};
506
Dan Williamsb3c914a2011-04-27 09:54:28 +0000507static const struct driver_info wwan_info = {
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000508 .description = "Mobile Broadband Network Device",
509 .flags = FLAG_WWAN,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000510 .bind = usbnet_cdc_bind,
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000511 .unbind = usbnet_cdc_unbind,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000512 .status = usbnet_cdc_status,
Olivier Blinb77e26d2014-10-24 19:43:02 +0200513 .set_rx_mode = usbnet_cdc_update_filter,
Oliver Neukuma5e40702012-12-18 04:46:12 +0000514 .manage_power = usbnet_manage_power,
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000515};
516
David Brownell4324fd42005-08-31 09:54:20 -0700517/*-------------------------------------------------------------------------*/
518
Dan Williamsb3c914a2011-04-27 09:54:28 +0000519#define HUAWEI_VENDOR_ID 0x12D1
Dan Williams4e6304b2012-05-07 04:24:51 +0000520#define NOVATEL_VENDOR_ID 0x1410
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000521#define ZTE_VENDOR_ID 0x19D2
Dan Williams0370acd2012-12-17 08:17:41 +0000522#define DELL_VENDOR_ID 0x413C
hayeswangac718b62013-05-02 16:01:25 +0000523#define REALTEK_VENDOR_ID 0x0bda
hayeswang43779f82014-01-02 11:25:10 +0800524#define SAMSUNG_VENDOR_ID 0x04e8
Christian Hesse347eec32015-03-31 14:10:07 +0200525#define LENOVO_VENDOR_ID 0x17ef
Zheng Liud065c3c2015-07-07 13:54:12 -0700526#define NVIDIA_VENDOR_ID 0x0955
David Brownell4324fd42005-08-31 09:54:20 -0700527
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200528static const struct usb_device_id products[] = {
529/* BLACKLIST !!
David Brownell4324fd42005-08-31 09:54:20 -0700530 *
531 * First blacklist any products that are egregiously nonconformant
532 * with the CDC Ethernet specs. Minor braindamage we cope with; when
533 * they're not even trying, needing a separate driver is only the first
534 * of the differences to show up.
535 */
536
537#define ZAURUS_MASTER_INTERFACE \
538 .bInterfaceClass = USB_CLASS_COMM, \
539 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
540 .bInterfaceProtocol = USB_CDC_PROTO_NONE
541
542/* SA-1100 based Sharp Zaurus ("collie"), or compatible;
543 * wire-incompatible with true CDC Ethernet implementations.
544 * (And, it seems, needlessly so...)
545 */
546{
547 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
548 | USB_DEVICE_ID_MATCH_DEVICE,
549 .idVendor = 0x04DD,
550 .idProduct = 0x8004,
551 ZAURUS_MASTER_INTERFACE,
552 .driver_info = 0,
553},
554
555/* PXA-25x based Sharp Zaurii. Note that it seems some of these
556 * (later models especially) may have shipped only with firmware
557 * advertising false "CDC MDLM" compatibility ... but we're not
558 * clear which models did that, so for now let's assume the worst.
559 */
560{
561 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
562 | USB_DEVICE_ID_MATCH_DEVICE,
563 .idVendor = 0x04DD,
564 .idProduct = 0x8005, /* A-300 */
565 ZAURUS_MASTER_INTERFACE,
566 .driver_info = 0,
567}, {
568 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
569 | USB_DEVICE_ID_MATCH_DEVICE,
570 .idVendor = 0x04DD,
571 .idProduct = 0x8006, /* B-500/SL-5600 */
572 ZAURUS_MASTER_INTERFACE,
573 .driver_info = 0,
574}, {
575 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200576 | USB_DEVICE_ID_MATCH_DEVICE,
David Brownell4324fd42005-08-31 09:54:20 -0700577 .idVendor = 0x04DD,
578 .idProduct = 0x8007, /* C-700 */
579 ZAURUS_MASTER_INTERFACE,
580 .driver_info = 0,
581}, {
582 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
583 | USB_DEVICE_ID_MATCH_DEVICE,
584 .idVendor = 0x04DD,
585 .idProduct = 0x9031, /* C-750 C-760 */
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 = 0x9032, /* SL-6000 */
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 /* reported with some C860 units */
600 .idProduct = 0x9050, /* C-860 */
601 ZAURUS_MASTER_INTERFACE,
602 .driver_info = 0,
603},
604
David Brownellefcaa202006-05-30 20:49:29 -0700605/* Olympus has some models with a Zaurus-compatible option.
606 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
607 */
608{
609 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
610 | USB_DEVICE_ID_MATCH_DEVICE,
611 .idVendor = 0x07B4,
612 .idProduct = 0x0F02, /* R-1000 */
613 ZAURUS_MASTER_INTERFACE,
614 .driver_info = 0,
615},
616
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000617/* LG Electronics VL600 wants additional headers on every frame */
618{
619 USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
620 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Mark Kamichoff6d74eb92011-11-09 11:48:10 +0000621 .driver_info = 0,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000622},
623
Scott Talbertee932bf2012-02-21 13:06:00 +0000624/* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
625{
626 USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
627 USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
628 .driver_info = 0,
629},
630
Dan Williamsf8295ec2012-10-24 12:10:34 +0000631/* Novatel USB551L and MC551 - handled by qmi_wwan */
632{
Dan Williamsc39ba1c2012-12-17 08:19:46 +0000633 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0xB001, USB_CLASS_COMM,
634 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Dan Williamsf8295ec2012-10-24 12:10:34 +0000635 .driver_info = 0,
636},
637
638/* Novatel E362 - handled by qmi_wwan */
639{
Dan Williamsc39ba1c2012-12-17 08:19:46 +0000640 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9010, USB_CLASS_COMM,
641 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Dan Williamsf8295ec2012-10-24 12:10:34 +0000642 .driver_info = 0,
643},
644
Dan Williams0370acd2012-12-17 08:17:41 +0000645/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
646{
647 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8195, USB_CLASS_COMM,
648 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
649 .driver_info = 0,
650},
651
652/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
653{
654 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8196, USB_CLASS_COMM,
655 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
656 .driver_info = 0,
657},
658
Dan Williams7fdb7842013-05-06 11:17:37 +0000659/* Dell Wireless 5804 (Novatel E371) - handled by qmi_wwan */
660{
661 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x819b, USB_CLASS_COMM,
662 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
663 .driver_info = 0,
664},
665
Yegor Yefremov7b5939b2014-03-28 12:07:18 +0100666/* Novatel Expedite E371 - handled by qmi_wwan */
667{
668 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9011, USB_CLASS_COMM,
669 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
670 .driver_info = 0,
671},
672
Dan Williams45d213f2013-02-18 17:25:09 +0000673/* AnyDATA ADU960S - handled by qmi_wwan */
674{
675 USB_DEVICE_AND_INTERFACE_INFO(0x16d5, 0x650a, USB_CLASS_COMM,
676 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
677 .driver_info = 0,
678},
679
Bjørn Morkc2020be2013-06-06 12:57:02 +0200680/* Huawei E1820 - handled by qmi_wwan */
681{
682 USB_DEVICE_INTERFACE_NUMBER(HUAWEI_VENDOR_ID, 0x14ac, 1),
683 .driver_info = 0,
684},
685
hayeswangac718b62013-05-02 16:01:25 +0000686/* Realtek RTL8152 Based USB 2.0 Ethernet Adapters */
hayeswangac718b62013-05-02 16:01:25 +0000687{
688 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8152, USB_CLASS_COMM,
689 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
690 .driver_info = 0,
691},
hayeswangc073f662013-07-08 10:41:21 +0800692
693/* Realtek RTL8153 Based USB 3.0 Ethernet Adapters */
694{
695 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8153, USB_CLASS_COMM,
696 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
697 .driver_info = 0,
698},
hayeswangac718b62013-05-02 16:01:25 +0000699
hayeswang10c32712014-03-04 20:47:48 +0800700/* Samsung USB Ethernet Adapters */
701{
702 USB_DEVICE_AND_INTERFACE_INFO(SAMSUNG_VENDOR_ID, 0xa101, USB_CLASS_COMM,
703 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
704 .driver_info = 0,
705},
706
Christian Hesse347eec32015-03-31 14:10:07 +0200707/* Lenovo Thinkpad USB 3.0 Ethernet Adapters (based on Realtek RTL8153) */
708{
709 USB_DEVICE_AND_INTERFACE_INFO(LENOVO_VENDOR_ID, 0x7205, USB_CLASS_COMM,
710 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
711 .driver_info = 0,
712},
713
Zheng Liud065c3c2015-07-07 13:54:12 -0700714/* NVIDIA Tegra USB 3.0 Ethernet Adapters (based on Realtek RTL8153) */
715{
716 USB_DEVICE_AND_INTERFACE_INFO(NVIDIA_VENDOR_ID, 0x09ff, USB_CLASS_COMM,
717 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
718 .driver_info = 0,
719},
720
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200721/* WHITELIST!!!
David Brownell4324fd42005-08-31 09:54:20 -0700722 *
723 * CDC Ether uses two interfaces, not necessarily consecutive.
724 * We match the main interface, ignoring the optional device
725 * class so we could handle devices that aren't exclusively
726 * CDC ether.
727 *
728 * NOTE: this match must come AFTER entries blacklisting devices
729 * because of bugs/quirks in a given product (like Zaurus, above).
730 */
731{
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000732 /* ZTE (Vodafone) K3805-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200733 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1003, USB_CLASS_COMM,
734 USB_CDC_SUBCLASS_ETHERNET,
735 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000736 .driver_info = (unsigned long)&wwan_info,
737}, {
738 /* ZTE (Vodafone) K3806-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200739 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1015, USB_CLASS_COMM,
740 USB_CDC_SUBCLASS_ETHERNET,
741 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000742 .driver_info = (unsigned long)&wwan_info,
743}, {
744 /* ZTE (Vodafone) K4510-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200745 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1173, USB_CLASS_COMM,
746 USB_CDC_SUBCLASS_ETHERNET,
747 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000748 .driver_info = (unsigned long)&wwan_info,
749}, {
750 /* ZTE (Vodafone) K3770-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200751 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1177, USB_CLASS_COMM,
752 USB_CDC_SUBCLASS_ETHERNET,
753 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000754 .driver_info = (unsigned long)&wwan_info,
755}, {
756 /* ZTE (Vodafone) K3772-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200757 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1181, USB_CLASS_COMM,
758 USB_CDC_SUBCLASS_ETHERNET,
759 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000760 .driver_info = (unsigned long)&wwan_info,
761}, {
Fabio Porcedda00928202013-09-16 11:47:50 +0200762 /* Telit modules */
763 USB_VENDOR_AND_INTERFACE_INFO(0x1bc7, USB_CLASS_COMM,
764 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
765 .driver_info = (kernel_ulong_t) &wwan_info,
766}, {
David Brownell4324fd42005-08-31 09:54:20 -0700767 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
768 USB_CDC_PROTO_NONE),
769 .driver_info = (unsigned long) &cdc_info,
Bjørn Morkcac477e2009-02-25 04:33:58 +0000770}, {
Jonas Sjöquist21851262010-04-23 01:07:45 +0000771 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
772 USB_CDC_PROTO_NONE),
Dan Williamsb3c914a2011-04-27 09:54:28 +0000773 .driver_info = (unsigned long)&wwan_info,
Jonas Sjöquist21851262010-04-23 01:07:45 +0000774
Dan Williamsb3c914a2011-04-27 09:54:28 +0000775}, {
776 /* Various Huawei modems with a network port like the UMG1831 */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200777 USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_COMM,
778 USB_CDC_SUBCLASS_ETHERNET, 255),
Dan Williamsb3c914a2011-04-27 09:54:28 +0000779 .driver_info = (unsigned long)&wwan_info,
David Brownell4324fd42005-08-31 09:54:20 -0700780},
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200781 { }, /* END */
David Brownell4324fd42005-08-31 09:54:20 -0700782};
783MODULE_DEVICE_TABLE(usb, products);
784
785static struct usb_driver cdc_driver = {
David Brownell4324fd42005-08-31 09:54:20 -0700786 .name = "cdc_ether",
787 .id_table = products,
788 .probe = usbnet_probe,
789 .disconnect = usbnet_disconnect,
790 .suspend = usbnet_suspend,
791 .resume = usbnet_resume,
Oliver Neukum7f515792009-12-03 11:41:07 +0000792 .reset_resume = usbnet_resume,
Oliver Neukum69ee472f2009-12-03 15:31:18 -0800793 .supports_autosuspend = 1,
Sarah Sharpe1f12eb2012-04-23 10:08:51 -0700794 .disable_hub_initiated_lpm = 1,
David Brownell4324fd42005-08-31 09:54:20 -0700795};
796
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800797module_usb_driver(cdc_driver);
David Brownell4324fd42005-08-31 09:54:20 -0700798
799MODULE_AUTHOR("David Brownell");
800MODULE_DESCRIPTION("USB CDC Ethernet devices");
801MODULE_LICENSE("GPL");