blob: d3920b54a92ce3de23a581d3cf80e99aa7d61e72 [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;
74
75 u16 cdc_filter =
76 USB_CDC_PACKET_TYPE_ALL_MULTICAST | USB_CDC_PACKET_TYPE_DIRECTED |
77 USB_CDC_PACKET_TYPE_BROADCAST;
78
Olivier Blinb77e26d2014-10-24 19:43:02 +020079 if (dev->net->flags & IFF_PROMISC)
80 cdc_filter |= USB_CDC_PACKET_TYPE_PROMISCUOUS;
81
Olivier Blind80c6792014-10-24 19:43:01 +020082 /* FIXME cdc-ether has some multicast code too, though it complains
83 * in routine cases. info->ether describes the multicast support.
84 * Implement that here, manipulating the cdc filter as needed.
85 */
86
87 usb_control_msg(dev->udev,
88 usb_sndctrlpipe(dev->udev, 0),
89 USB_CDC_SET_ETHERNET_PACKET_FILTER,
90 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
91 cdc_filter,
92 intf->cur_altsetting->desc.bInterfaceNumber,
93 NULL,
94 0,
95 USB_CTRL_SET_TIMEOUT
96 );
97}
98
Fabio Porcedda8857ec22013-09-16 11:47:51 +020099/* probes control interface, claims data interface, collects the bulk
David Brownell4324fd42005-08-31 09:54:20 -0700100 * endpoints, activates data interface (if needed), maybe sets MTU.
101 * all pure cdc, except for certain firmware workarounds, and knowing
102 * that rndis uses one different rule.
103 */
104int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
105{
106 u8 *buf = intf->cur_altsetting->extra;
107 int len = intf->cur_altsetting->extralen;
108 struct usb_interface_descriptor *d;
109 struct cdc_state *info = (void *) &dev->data;
110 int status;
111 int rndis;
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000112 bool android_rndis_quirk = false;
David Brownell4324fd42005-08-31 09:54:20 -0700113 struct usb_driver *driver = driver_of(intf);
Jonas Sjöquist21851262010-04-23 01:07:45 +0000114 struct usb_cdc_mdlm_desc *desc = NULL;
115 struct usb_cdc_mdlm_detail_desc *detail = NULL;
David Brownell4324fd42005-08-31 09:54:20 -0700116
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200117 if (sizeof(dev->data) < sizeof(*info))
David Brownell4324fd42005-08-31 09:54:20 -0700118 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;
Dan Carpenterf5260f02010-12-25 12:23:42 +0000129 dev_dbg(&intf->dev, "CDC descriptors on config\n");
David Brownell4324fd42005-08-31 09:54:20 -0700130 }
131
David Brownell4149b722007-04-29 10:09:47 -0700132 /* 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
David Brownell4324fd42005-08-31 09:54:20 -0700148 /* this assumes that if there's a non-RNDIS vendor variant
149 * of cdc-acm, it'll fail RNDIS requests cleanly.
150 */
Joe Perches8e95a202009-12-03 07:58:21 +0000151 rndis = (is_rndis(&intf->cur_altsetting->desc) ||
152 is_activesync(&intf->cur_altsetting->desc) ||
153 is_wireless_rndis(&intf->cur_altsetting->desc));
David Brownell4324fd42005-08-31 09:54:20 -0700154
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200155 memset(info, 0, sizeof(*info));
David Brownell4324fd42005-08-31 09:54:20 -0700156 info->control = intf;
157 while (len > 3) {
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200158 if (buf[1] != USB_DT_CS_INTERFACE)
David Brownell4324fd42005-08-31 09:54:20 -0700159 goto next_desc;
160
161 /* use bDescriptorSubType to identify the CDC descriptors.
162 * We expect devices with CDC header and union descriptors.
163 * For CDC Ethernet we need the ethernet descriptor.
164 * For RNDIS, ignore two (pointless) CDC modem descriptors
165 * in favor of a complicated OID-based RPC scheme doing what
166 * CDC Ethernet achieves with a simple descriptor.
167 */
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200168 switch (buf[2]) {
David Brownell4324fd42005-08-31 09:54:20 -0700169 case USB_CDC_HEADER_TYPE:
170 if (info->header) {
171 dev_dbg(&intf->dev, "extra CDC header\n");
172 goto bad_desc;
173 }
174 info->header = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200175 if (info->header->bLength != sizeof(*info->header)) {
David Brownell4324fd42005-08-31 09:54:20 -0700176 dev_dbg(&intf->dev, "CDC header len %u\n",
177 info->header->bLength);
178 goto bad_desc;
179 }
180 break;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800181 case USB_CDC_ACM_TYPE:
182 /* paranoia: disambiguate a "real" vendor-specific
183 * modem interface from an RNDIS non-modem.
184 */
185 if (rndis) {
David Brownellafaee822007-07-01 11:47:59 -0700186 struct usb_cdc_acm_descriptor *acm;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800187
David Brownellafaee822007-07-01 11:47:59 -0700188 acm = (void *) buf;
189 if (acm->bmCapabilities) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800190 dev_dbg(&intf->dev,
191 "ACM capabilities %02x, "
192 "not really RNDIS?\n",
David Brownellafaee822007-07-01 11:47:59 -0700193 acm->bmCapabilities);
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800194 goto bad_desc;
195 }
196 }
197 break;
David Brownell4324fd42005-08-31 09:54:20 -0700198 case USB_CDC_UNION_TYPE:
199 if (info->u) {
200 dev_dbg(&intf->dev, "extra CDC union\n");
201 goto bad_desc;
202 }
203 info->u = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200204 if (info->u->bLength != sizeof(*info->u)) {
David Brownell4324fd42005-08-31 09:54:20 -0700205 dev_dbg(&intf->dev, "CDC union len %u\n",
206 info->u->bLength);
207 goto bad_desc;
208 }
209
210 /* we need a master/control interface (what we're
211 * probed with) and a slave/data interface; union
212 * descriptors sort this all out.
213 */
214 info->control = usb_ifnum_to_if(dev->udev,
215 info->u->bMasterInterface0);
216 info->data = usb_ifnum_to_if(dev->udev,
217 info->u->bSlaveInterface0);
218 if (!info->control || !info->data) {
219 dev_dbg(&intf->dev,
220 "master #%u/%p slave #%u/%p\n",
221 info->u->bMasterInterface0,
222 info->control,
223 info->u->bSlaveInterface0,
224 info->data);
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000225 /* fall back to hard-wiring for RNDIS */
226 if (rndis) {
227 android_rndis_quirk = true;
228 goto next_desc;
229 }
David Brownell4324fd42005-08-31 09:54:20 -0700230 goto bad_desc;
231 }
232 if (info->control != intf) {
233 dev_dbg(&intf->dev, "bogus CDC Union\n");
234 /* Ambit USB Cable Modem (and maybe others)
235 * interchanges master and slave interface.
236 */
237 if (info->data == intf) {
238 info->data = info->control;
239 info->control = intf;
240 } else
241 goto bad_desc;
242 }
243
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200244 /* some devices merge these - skip class check */
245 if (info->control == info->data)
246 goto next_desc;
247
David Brownell4324fd42005-08-31 09:54:20 -0700248 /* a data interface altsetting does the real i/o */
249 d = &info->data->cur_altsetting->desc;
250 if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
251 dev_dbg(&intf->dev, "slave class %u\n",
252 d->bInterfaceClass);
253 goto bad_desc;
254 }
255 break;
256 case USB_CDC_ETHERNET_TYPE:
257 if (info->ether) {
258 dev_dbg(&intf->dev, "extra CDC ether\n");
259 goto bad_desc;
260 }
261 info->ether = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200262 if (info->ether->bLength != sizeof(*info->ether)) {
David Brownell4324fd42005-08-31 09:54:20 -0700263 dev_dbg(&intf->dev, "CDC ether len %u\n",
264 info->ether->bLength);
265 goto bad_desc;
266 }
267 dev->hard_mtu = le16_to_cpu(
268 info->ether->wMaxSegmentSize);
269 /* because of Zaurus, we may be ignoring the host
270 * side link address we were given.
271 */
272 break;
Jonas Sjöquist21851262010-04-23 01:07:45 +0000273 case USB_CDC_MDLM_TYPE:
274 if (desc) {
275 dev_dbg(&intf->dev, "extra MDLM descriptor\n");
276 goto bad_desc;
277 }
278
279 desc = (void *)buf;
280
281 if (desc->bLength != sizeof(*desc))
282 goto bad_desc;
283
284 if (memcmp(&desc->bGUID, mbm_guid, 16))
285 goto bad_desc;
286 break;
287 case USB_CDC_MDLM_DETAIL_TYPE:
288 if (detail) {
289 dev_dbg(&intf->dev, "extra MDLM detail descriptor\n");
290 goto bad_desc;
291 }
292
293 detail = (void *)buf;
294
295 if (detail->bGuidDescriptorType == 0) {
296 if (detail->bLength < (sizeof(*detail) + 1))
297 goto bad_desc;
298 } else
299 goto bad_desc;
300 break;
David Brownell4324fd42005-08-31 09:54:20 -0700301 }
302next_desc:
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200303 len -= buf[0]; /* bLength */
304 buf += buf[0];
David Brownell4324fd42005-08-31 09:54:20 -0700305 }
306
Bjorge Dijkstra786e3df2008-01-26 00:50:44 +0200307 /* Microsoft ActiveSync based and some regular RNDIS devices lack the
308 * CDC descriptors, so we'll hard-wire the interfaces and not check
309 * for descriptors.
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000310 *
311 * Some Android RNDIS devices have a CDC Union descriptor pointing
312 * to non-existing interfaces. Ignore that and attempt the same
313 * hard-wired 0 and 1 interfaces.
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800314 */
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000315 if (rndis && (!info->u || android_rndis_quirk)) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800316 info->control = usb_ifnum_to_if(dev->udev, 0);
317 info->data = usb_ifnum_to_if(dev->udev, 1);
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000318 if (!info->control || !info->data || info->control != intf) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800319 dev_dbg(&intf->dev,
Bjorge Dijkstra786e3df2008-01-26 00:50:44 +0200320 "rndis: master #0/%p slave #1/%p\n",
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800321 info->control,
322 info->data);
323 goto bad_desc;
324 }
325
326 } else if (!info->header || !info->u || (!rndis && !info->ether)) {
David Brownell4324fd42005-08-31 09:54:20 -0700327 dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
328 info->header ? "" : "header ",
329 info->u ? "" : "union ",
330 info->ether ? "" : "ether ");
331 goto bad_desc;
332 }
333
334 /* claim data interface and set it up ... with side effects.
335 * network traffic can't flow until an altsetting is enabled.
336 */
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200337 if (info->data != info->control) {
338 status = usb_driver_claim_interface(driver, info->data, dev);
339 if (status < 0)
340 return status;
341 }
David Brownell4324fd42005-08-31 09:54:20 -0700342 status = usbnet_get_endpoints(dev, info->data);
343 if (status < 0) {
344 /* ensure immediate exit from usbnet_disconnect */
345 usb_set_intfdata(info->data, NULL);
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200346 if (info->data != info->control)
347 usb_driver_release_interface(driver, info->data);
David Brownell4324fd42005-08-31 09:54:20 -0700348 return status;
349 }
350
351 /* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200352 if (info->data != info->control)
353 dev->status = NULL;
David Brownell4324fd42005-08-31 09:54:20 -0700354 if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
355 struct usb_endpoint_descriptor *desc;
356
357 dev->status = &info->control->cur_altsetting->endpoint [0];
358 desc = &dev->status->desc;
Joe Perches8e95a202009-12-03 07:58:21 +0000359 if (!usb_endpoint_is_int_in(desc) ||
360 (le16_to_cpu(desc->wMaxPacketSize)
361 < sizeof(struct usb_cdc_notification)) ||
362 !desc->bInterval) {
David Brownell4324fd42005-08-31 09:54:20 -0700363 dev_dbg(&intf->dev, "bad notification endpoint\n");
364 dev->status = NULL;
365 }
366 }
367 if (rndis && !dev->status) {
368 dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
369 usb_set_intfdata(info->data, NULL);
370 usb_driver_release_interface(driver, info->data);
371 return -ENODEV;
372 }
Oliver Neukumc472ab62014-07-28 10:56:36 +0200373
374 /* Some devices don't initialise properly. In particular
375 * the packet filter is not reset. There are devices that
376 * don't do reset all the way. So the packet filter should
377 * be set to a sane initial value.
378 */
Olivier Blind80c6792014-10-24 19:43:01 +0200379 usbnet_cdc_update_filter(dev);
380
David Brownell4324fd42005-08-31 09:54:20 -0700381 return 0;
382
383bad_desc:
384 dev_info(&dev->udev->dev, "bad CDC descriptors\n");
385 return -ENODEV;
386}
387EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
388
389void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
390{
391 struct cdc_state *info = (void *) &dev->data;
392 struct usb_driver *driver = driver_of(intf);
393
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200394 /* combined interface - nothing to do */
395 if (info->data == info->control)
396 return;
397
David Brownell4324fd42005-08-31 09:54:20 -0700398 /* disconnect master --> disconnect slave */
399 if (intf == info->control && info->data) {
400 /* ensure immediate exit from usbnet_disconnect */
401 usb_set_intfdata(info->data, NULL);
402 usb_driver_release_interface(driver, info->data);
403 info->data = NULL;
404 }
405
406 /* and vice versa (just in case) */
407 else if (intf == info->data && info->control) {
408 /* ensure immediate exit from usbnet_disconnect */
409 usb_set_intfdata(info->control, NULL);
410 usb_driver_release_interface(driver, info->control);
411 info->control = NULL;
412 }
413}
414EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
415
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200416/* Communications Device Class, Ethernet Control model
David Brownell4324fd42005-08-31 09:54:20 -0700417 *
418 * Takes two interfaces. The DATA interface is inactive till an altsetting
419 * is selected. Configuration data includes class descriptors. There's
420 * an optional status endpoint on the control interface.
421 *
422 * This should interop with whatever the 2.4 "CDCEther.c" driver
423 * (by Brad Hards) talked with, with more functionality.
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200424 */
David Brownell4324fd42005-08-31 09:54:20 -0700425
426static void dumpspeed(struct usbnet *dev, __le32 *speeds)
427{
Joe Perchesa475f602010-02-17 10:30:24 +0000428 netif_info(dev, timer, dev->net,
429 "link speeds: %u kbps up, %u kbps down\n",
430 __le32_to_cpu(speeds[0]) / 1000,
431 __le32_to_cpu(speeds[1]) / 1000);
David Brownell4324fd42005-08-31 09:54:20 -0700432}
433
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000434void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
David Brownell4324fd42005-08-31 09:54:20 -0700435{
436 struct usb_cdc_notification *event;
437
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200438 if (urb->actual_length < sizeof(*event))
David Brownell4324fd42005-08-31 09:54:20 -0700439 return;
440
441 /* SPEED_CHANGE can get split into two 8-byte packets */
442 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
443 dumpspeed(dev, (__le32 *) urb->transfer_buffer);
444 return;
445 }
446
447 event = urb->transfer_buffer;
448 switch (event->bNotificationType) {
449 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
Joe Perchesa475f602010-02-17 10:30:24 +0000450 netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
451 event->wValue ? "on" : "off");
Bjørn Morka6bda452013-04-16 22:12:13 +0000452 usbnet_link_change(dev, !!event->wValue, 0);
David Brownell4324fd42005-08-31 09:54:20 -0700453 break;
454 case USB_CDC_NOTIFY_SPEED_CHANGE: /* tx/rx rates */
Joe Perchesa475f602010-02-17 10:30:24 +0000455 netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
456 urb->actual_length);
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200457 if (urb->actual_length != (sizeof(*event) + 8))
David Brownell4324fd42005-08-31 09:54:20 -0700458 set_bit(EVENT_STS_SPLIT, &dev->flags);
459 else
460 dumpspeed(dev, (__le32 *) &event[1]);
461 break;
462 /* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
463 * but there are no standard formats for the response data.
464 */
465 default:
Joe Perches60b86752010-02-17 10:30:23 +0000466 netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
467 event->bNotificationType);
David Brownell4324fd42005-08-31 09:54:20 -0700468 break;
469 }
470}
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000471EXPORT_SYMBOL_GPL(usbnet_cdc_status);
David Brownell4324fd42005-08-31 09:54:20 -0700472
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000473int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
David Brownell4324fd42005-08-31 09:54:20 -0700474{
475 int status;
476 struct cdc_state *info = (void *) &dev->data;
477
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800478 BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
479 < sizeof(struct cdc_state)));
480
David Brownell4324fd42005-08-31 09:54:20 -0700481 status = usbnet_generic_cdc_bind(dev, intf);
482 if (status < 0)
483 return status;
484
Peter Holik03ad0322009-04-18 07:24:17 +0000485 status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
David Brownell4324fd42005-08-31 09:54:20 -0700486 if (status < 0) {
487 usb_set_intfdata(info->data, NULL);
488 usb_driver_release_interface(driver_of(intf), info->data);
489 return status;
490 }
491
David Brownell4324fd42005-08-31 09:54:20 -0700492 return 0;
493}
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000494EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
David Brownell4324fd42005-08-31 09:54:20 -0700495
496static const struct driver_info cdc_info = {
497 .description = "CDC Ethernet Device",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700498 .flags = FLAG_ETHER | FLAG_POINTTOPOINT,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000499 .bind = usbnet_cdc_bind,
David Brownell4324fd42005-08-31 09:54:20 -0700500 .unbind = usbnet_cdc_unbind,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000501 .status = usbnet_cdc_status,
Olivier Blinb77e26d2014-10-24 19:43:02 +0200502 .set_rx_mode = usbnet_cdc_update_filter,
Oliver Neukuma5e40702012-12-18 04:46:12 +0000503 .manage_power = usbnet_manage_power,
David Brownell4324fd42005-08-31 09:54:20 -0700504};
505
Dan Williamsb3c914a2011-04-27 09:54:28 +0000506static const struct driver_info wwan_info = {
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000507 .description = "Mobile Broadband Network Device",
508 .flags = FLAG_WWAN,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000509 .bind = usbnet_cdc_bind,
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000510 .unbind = usbnet_cdc_unbind,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000511 .status = usbnet_cdc_status,
Olivier Blinb77e26d2014-10-24 19:43:02 +0200512 .set_rx_mode = usbnet_cdc_update_filter,
Oliver Neukuma5e40702012-12-18 04:46:12 +0000513 .manage_power = usbnet_manage_power,
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000514};
515
David Brownell4324fd42005-08-31 09:54:20 -0700516/*-------------------------------------------------------------------------*/
517
Dan Williamsb3c914a2011-04-27 09:54:28 +0000518#define HUAWEI_VENDOR_ID 0x12D1
Dan Williams4e6304b2012-05-07 04:24:51 +0000519#define NOVATEL_VENDOR_ID 0x1410
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000520#define ZTE_VENDOR_ID 0x19D2
Dan Williams0370acd2012-12-17 08:17:41 +0000521#define DELL_VENDOR_ID 0x413C
hayeswangac718b62013-05-02 16:01:25 +0000522#define REALTEK_VENDOR_ID 0x0bda
hayeswang43779f82014-01-02 11:25:10 +0800523#define SAMSUNG_VENDOR_ID 0x04e8
David Brownell4324fd42005-08-31 09:54:20 -0700524
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200525static const struct usb_device_id products[] = {
526/* BLACKLIST !!
David Brownell4324fd42005-08-31 09:54:20 -0700527 *
528 * First blacklist any products that are egregiously nonconformant
529 * with the CDC Ethernet specs. Minor braindamage we cope with; when
530 * they're not even trying, needing a separate driver is only the first
531 * of the differences to show up.
532 */
533
534#define ZAURUS_MASTER_INTERFACE \
535 .bInterfaceClass = USB_CLASS_COMM, \
536 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
537 .bInterfaceProtocol = USB_CDC_PROTO_NONE
538
539/* SA-1100 based Sharp Zaurus ("collie"), or compatible;
540 * wire-incompatible with true CDC Ethernet implementations.
541 * (And, it seems, needlessly so...)
542 */
543{
544 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
545 | USB_DEVICE_ID_MATCH_DEVICE,
546 .idVendor = 0x04DD,
547 .idProduct = 0x8004,
548 ZAURUS_MASTER_INTERFACE,
549 .driver_info = 0,
550},
551
552/* PXA-25x based Sharp Zaurii. Note that it seems some of these
553 * (later models especially) may have shipped only with firmware
554 * advertising false "CDC MDLM" compatibility ... but we're not
555 * clear which models did that, so for now let's assume the worst.
556 */
557{
558 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
559 | USB_DEVICE_ID_MATCH_DEVICE,
560 .idVendor = 0x04DD,
561 .idProduct = 0x8005, /* A-300 */
562 ZAURUS_MASTER_INTERFACE,
563 .driver_info = 0,
564}, {
565 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
566 | USB_DEVICE_ID_MATCH_DEVICE,
567 .idVendor = 0x04DD,
568 .idProduct = 0x8006, /* B-500/SL-5600 */
569 ZAURUS_MASTER_INTERFACE,
570 .driver_info = 0,
571}, {
572 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200573 | USB_DEVICE_ID_MATCH_DEVICE,
David Brownell4324fd42005-08-31 09:54:20 -0700574 .idVendor = 0x04DD,
575 .idProduct = 0x8007, /* C-700 */
576 ZAURUS_MASTER_INTERFACE,
577 .driver_info = 0,
578}, {
579 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
580 | USB_DEVICE_ID_MATCH_DEVICE,
581 .idVendor = 0x04DD,
582 .idProduct = 0x9031, /* C-750 C-760 */
583 ZAURUS_MASTER_INTERFACE,
584 .driver_info = 0,
585}, {
586 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
587 | USB_DEVICE_ID_MATCH_DEVICE,
588 .idVendor = 0x04DD,
589 .idProduct = 0x9032, /* SL-6000 */
590 ZAURUS_MASTER_INTERFACE,
591 .driver_info = 0,
592}, {
593 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
594 | USB_DEVICE_ID_MATCH_DEVICE,
595 .idVendor = 0x04DD,
596 /* reported with some C860 units */
597 .idProduct = 0x9050, /* C-860 */
598 ZAURUS_MASTER_INTERFACE,
599 .driver_info = 0,
600},
601
David Brownellefcaa202006-05-30 20:49:29 -0700602/* Olympus has some models with a Zaurus-compatible option.
603 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
604 */
605{
606 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
607 | USB_DEVICE_ID_MATCH_DEVICE,
608 .idVendor = 0x07B4,
609 .idProduct = 0x0F02, /* R-1000 */
610 ZAURUS_MASTER_INTERFACE,
611 .driver_info = 0,
612},
613
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000614/* LG Electronics VL600 wants additional headers on every frame */
615{
616 USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
617 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Mark Kamichoff6d74eb92011-11-09 11:48:10 +0000618 .driver_info = 0,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000619},
620
Scott Talbertee932bf2012-02-21 13:06:00 +0000621/* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
622{
623 USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
624 USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
625 .driver_info = 0,
626},
627
Dan Williamsf8295ec2012-10-24 12:10:34 +0000628/* Novatel USB551L and MC551 - handled by qmi_wwan */
629{
Dan Williamsc39ba1c2012-12-17 08:19:46 +0000630 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0xB001, USB_CLASS_COMM,
631 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Dan Williamsf8295ec2012-10-24 12:10:34 +0000632 .driver_info = 0,
633},
634
635/* Novatel E362 - handled by qmi_wwan */
636{
Dan Williamsc39ba1c2012-12-17 08:19:46 +0000637 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9010, USB_CLASS_COMM,
638 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Dan Williamsf8295ec2012-10-24 12:10:34 +0000639 .driver_info = 0,
640},
641
Dan Williams0370acd2012-12-17 08:17:41 +0000642/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
643{
644 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8195, USB_CLASS_COMM,
645 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
646 .driver_info = 0,
647},
648
649/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
650{
651 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8196, USB_CLASS_COMM,
652 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
653 .driver_info = 0,
654},
655
Dan Williams7fdb7842013-05-06 11:17:37 +0000656/* Dell Wireless 5804 (Novatel E371) - handled by qmi_wwan */
657{
658 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x819b, USB_CLASS_COMM,
659 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
660 .driver_info = 0,
661},
662
Yegor Yefremov7b5939b2014-03-28 12:07:18 +0100663/* Novatel Expedite E371 - handled by qmi_wwan */
664{
665 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9011, USB_CLASS_COMM,
666 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
667 .driver_info = 0,
668},
669
Dan Williams45d213f2013-02-18 17:25:09 +0000670/* AnyDATA ADU960S - handled by qmi_wwan */
671{
672 USB_DEVICE_AND_INTERFACE_INFO(0x16d5, 0x650a, USB_CLASS_COMM,
673 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
674 .driver_info = 0,
675},
676
Bjørn Morkc2020be2013-06-06 12:57:02 +0200677/* Huawei E1820 - handled by qmi_wwan */
678{
679 USB_DEVICE_INTERFACE_NUMBER(HUAWEI_VENDOR_ID, 0x14ac, 1),
680 .driver_info = 0,
681},
682
hayeswangac718b62013-05-02 16:01:25 +0000683/* Realtek RTL8152 Based USB 2.0 Ethernet Adapters */
hayeswangac718b62013-05-02 16:01:25 +0000684{
685 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8152, USB_CLASS_COMM,
686 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
687 .driver_info = 0,
688},
hayeswangc073f662013-07-08 10:41:21 +0800689
690/* Realtek RTL8153 Based USB 3.0 Ethernet Adapters */
691{
692 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8153, USB_CLASS_COMM,
693 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
694 .driver_info = 0,
695},
hayeswangac718b62013-05-02 16:01:25 +0000696
hayeswang10c32712014-03-04 20:47:48 +0800697/* Samsung USB Ethernet Adapters */
698{
699 USB_DEVICE_AND_INTERFACE_INFO(SAMSUNG_VENDOR_ID, 0xa101, USB_CLASS_COMM,
700 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
701 .driver_info = 0,
702},
703
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200704/* WHITELIST!!!
David Brownell4324fd42005-08-31 09:54:20 -0700705 *
706 * CDC Ether uses two interfaces, not necessarily consecutive.
707 * We match the main interface, ignoring the optional device
708 * class so we could handle devices that aren't exclusively
709 * CDC ether.
710 *
711 * NOTE: this match must come AFTER entries blacklisting devices
712 * because of bugs/quirks in a given product (like Zaurus, above).
713 */
714{
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000715 /* ZTE (Vodafone) K3805-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200716 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1003, USB_CLASS_COMM,
717 USB_CDC_SUBCLASS_ETHERNET,
718 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000719 .driver_info = (unsigned long)&wwan_info,
720}, {
721 /* ZTE (Vodafone) K3806-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200722 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1015, USB_CLASS_COMM,
723 USB_CDC_SUBCLASS_ETHERNET,
724 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000725 .driver_info = (unsigned long)&wwan_info,
726}, {
727 /* ZTE (Vodafone) K4510-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200728 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1173, USB_CLASS_COMM,
729 USB_CDC_SUBCLASS_ETHERNET,
730 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000731 .driver_info = (unsigned long)&wwan_info,
732}, {
733 /* ZTE (Vodafone) K3770-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200734 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1177, USB_CLASS_COMM,
735 USB_CDC_SUBCLASS_ETHERNET,
736 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000737 .driver_info = (unsigned long)&wwan_info,
738}, {
739 /* ZTE (Vodafone) K3772-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200740 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1181, USB_CLASS_COMM,
741 USB_CDC_SUBCLASS_ETHERNET,
742 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000743 .driver_info = (unsigned long)&wwan_info,
744}, {
Fabio Porcedda00928202013-09-16 11:47:50 +0200745 /* Telit modules */
746 USB_VENDOR_AND_INTERFACE_INFO(0x1bc7, USB_CLASS_COMM,
747 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
748 .driver_info = (kernel_ulong_t) &wwan_info,
749}, {
David Brownell4324fd42005-08-31 09:54:20 -0700750 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
751 USB_CDC_PROTO_NONE),
752 .driver_info = (unsigned long) &cdc_info,
Bjørn Morkcac477e2009-02-25 04:33:58 +0000753}, {
Jonas Sjöquist21851262010-04-23 01:07:45 +0000754 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
755 USB_CDC_PROTO_NONE),
Dan Williamsb3c914a2011-04-27 09:54:28 +0000756 .driver_info = (unsigned long)&wwan_info,
Jonas Sjöquist21851262010-04-23 01:07:45 +0000757
Dan Williamsb3c914a2011-04-27 09:54:28 +0000758}, {
759 /* Various Huawei modems with a network port like the UMG1831 */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200760 USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_COMM,
761 USB_CDC_SUBCLASS_ETHERNET, 255),
Dan Williamsb3c914a2011-04-27 09:54:28 +0000762 .driver_info = (unsigned long)&wwan_info,
David Brownell4324fd42005-08-31 09:54:20 -0700763},
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200764 { }, /* END */
David Brownell4324fd42005-08-31 09:54:20 -0700765};
766MODULE_DEVICE_TABLE(usb, products);
767
768static struct usb_driver cdc_driver = {
David Brownell4324fd42005-08-31 09:54:20 -0700769 .name = "cdc_ether",
770 .id_table = products,
771 .probe = usbnet_probe,
772 .disconnect = usbnet_disconnect,
773 .suspend = usbnet_suspend,
774 .resume = usbnet_resume,
Oliver Neukum7f515792009-12-03 11:41:07 +0000775 .reset_resume = usbnet_resume,
Oliver Neukum69ee472f2009-12-03 15:31:18 -0800776 .supports_autosuspend = 1,
Sarah Sharpe1f12eb2012-04-23 10:08:51 -0700777 .disable_hub_initiated_lpm = 1,
David Brownell4324fd42005-08-31 09:54:20 -0700778};
779
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800780module_usb_driver(cdc_driver);
David Brownell4324fd42005-08-31 09:54:20 -0700781
782MODULE_AUTHOR("David Brownell");
783MODULE_DESCRIPTION("USB CDC Ethernet devices");
784MODULE_LICENSE("GPL");