blob: bee3689beeb4aefdf8348f39e381cfdf3bb521c3 [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
79 /* FIXME cdc-ether has some multicast code too, though it complains
80 * in routine cases. info->ether describes the multicast support.
81 * Implement that here, manipulating the cdc filter as needed.
82 */
83
84 usb_control_msg(dev->udev,
85 usb_sndctrlpipe(dev->udev, 0),
86 USB_CDC_SET_ETHERNET_PACKET_FILTER,
87 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
88 cdc_filter,
89 intf->cur_altsetting->desc.bInterfaceNumber,
90 NULL,
91 0,
92 USB_CTRL_SET_TIMEOUT
93 );
94}
95
Fabio Porcedda8857ec22013-09-16 11:47:51 +020096/* probes control interface, claims data interface, collects the bulk
David Brownell4324fd42005-08-31 09:54:20 -070097 * endpoints, activates data interface (if needed), maybe sets MTU.
98 * all pure cdc, except for certain firmware workarounds, and knowing
99 * that rndis uses one different rule.
100 */
101int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
102{
103 u8 *buf = intf->cur_altsetting->extra;
104 int len = intf->cur_altsetting->extralen;
105 struct usb_interface_descriptor *d;
106 struct cdc_state *info = (void *) &dev->data;
107 int status;
108 int rndis;
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000109 bool android_rndis_quirk = false;
David Brownell4324fd42005-08-31 09:54:20 -0700110 struct usb_driver *driver = driver_of(intf);
Jonas Sjöquist21851262010-04-23 01:07:45 +0000111 struct usb_cdc_mdlm_desc *desc = NULL;
112 struct usb_cdc_mdlm_detail_desc *detail = NULL;
David Brownell4324fd42005-08-31 09:54:20 -0700113
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200114 if (sizeof(dev->data) < sizeof(*info))
David Brownell4324fd42005-08-31 09:54:20 -0700115 return -EDOM;
116
117 /* expect strict spec conformance for the descriptors, but
118 * cope with firmware which stores them in the wrong place
119 */
120 if (len == 0 && dev->udev->actconfig->extralen) {
121 /* Motorola SB4100 (and others: Brad Hards says it's
122 * from a Broadcom design) put CDC descriptors here
123 */
124 buf = dev->udev->actconfig->extra;
125 len = dev->udev->actconfig->extralen;
Dan Carpenterf5260f02010-12-25 12:23:42 +0000126 dev_dbg(&intf->dev, "CDC descriptors on config\n");
David Brownell4324fd42005-08-31 09:54:20 -0700127 }
128
David Brownell4149b722007-04-29 10:09:47 -0700129 /* Maybe CDC descriptors are after the endpoint? This bug has
130 * been seen on some 2Wire Inc RNDIS-ish products.
131 */
132 if (len == 0) {
133 struct usb_host_endpoint *hep;
134
135 hep = intf->cur_altsetting->endpoint;
136 if (hep) {
137 buf = hep->extra;
138 len = hep->extralen;
139 }
140 if (len)
141 dev_dbg(&intf->dev,
142 "CDC descriptors on endpoint\n");
143 }
144
David Brownell4324fd42005-08-31 09:54:20 -0700145 /* this assumes that if there's a non-RNDIS vendor variant
146 * of cdc-acm, it'll fail RNDIS requests cleanly.
147 */
Joe Perches8e95a202009-12-03 07:58:21 +0000148 rndis = (is_rndis(&intf->cur_altsetting->desc) ||
149 is_activesync(&intf->cur_altsetting->desc) ||
150 is_wireless_rndis(&intf->cur_altsetting->desc));
David Brownell4324fd42005-08-31 09:54:20 -0700151
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200152 memset(info, 0, sizeof(*info));
David Brownell4324fd42005-08-31 09:54:20 -0700153 info->control = intf;
154 while (len > 3) {
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200155 if (buf[1] != USB_DT_CS_INTERFACE)
David Brownell4324fd42005-08-31 09:54:20 -0700156 goto next_desc;
157
158 /* use bDescriptorSubType to identify the CDC descriptors.
159 * We expect devices with CDC header and union descriptors.
160 * For CDC Ethernet we need the ethernet descriptor.
161 * For RNDIS, ignore two (pointless) CDC modem descriptors
162 * in favor of a complicated OID-based RPC scheme doing what
163 * CDC Ethernet achieves with a simple descriptor.
164 */
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200165 switch (buf[2]) {
David Brownell4324fd42005-08-31 09:54:20 -0700166 case USB_CDC_HEADER_TYPE:
167 if (info->header) {
168 dev_dbg(&intf->dev, "extra CDC header\n");
169 goto bad_desc;
170 }
171 info->header = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200172 if (info->header->bLength != sizeof(*info->header)) {
David Brownell4324fd42005-08-31 09:54:20 -0700173 dev_dbg(&intf->dev, "CDC header len %u\n",
174 info->header->bLength);
175 goto bad_desc;
176 }
177 break;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800178 case USB_CDC_ACM_TYPE:
179 /* paranoia: disambiguate a "real" vendor-specific
180 * modem interface from an RNDIS non-modem.
181 */
182 if (rndis) {
David Brownellafaee822007-07-01 11:47:59 -0700183 struct usb_cdc_acm_descriptor *acm;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800184
David Brownellafaee822007-07-01 11:47:59 -0700185 acm = (void *) buf;
186 if (acm->bmCapabilities) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800187 dev_dbg(&intf->dev,
188 "ACM capabilities %02x, "
189 "not really RNDIS?\n",
David Brownellafaee822007-07-01 11:47:59 -0700190 acm->bmCapabilities);
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800191 goto bad_desc;
192 }
193 }
194 break;
David Brownell4324fd42005-08-31 09:54:20 -0700195 case USB_CDC_UNION_TYPE:
196 if (info->u) {
197 dev_dbg(&intf->dev, "extra CDC union\n");
198 goto bad_desc;
199 }
200 info->u = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200201 if (info->u->bLength != sizeof(*info->u)) {
David Brownell4324fd42005-08-31 09:54:20 -0700202 dev_dbg(&intf->dev, "CDC union len %u\n",
203 info->u->bLength);
204 goto bad_desc;
205 }
206
207 /* we need a master/control interface (what we're
208 * probed with) and a slave/data interface; union
209 * descriptors sort this all out.
210 */
211 info->control = usb_ifnum_to_if(dev->udev,
212 info->u->bMasterInterface0);
213 info->data = usb_ifnum_to_if(dev->udev,
214 info->u->bSlaveInterface0);
215 if (!info->control || !info->data) {
216 dev_dbg(&intf->dev,
217 "master #%u/%p slave #%u/%p\n",
218 info->u->bMasterInterface0,
219 info->control,
220 info->u->bSlaveInterface0,
221 info->data);
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000222 /* fall back to hard-wiring for RNDIS */
223 if (rndis) {
224 android_rndis_quirk = true;
225 goto next_desc;
226 }
David Brownell4324fd42005-08-31 09:54:20 -0700227 goto bad_desc;
228 }
229 if (info->control != intf) {
230 dev_dbg(&intf->dev, "bogus CDC Union\n");
231 /* Ambit USB Cable Modem (and maybe others)
232 * interchanges master and slave interface.
233 */
234 if (info->data == intf) {
235 info->data = info->control;
236 info->control = intf;
237 } else
238 goto bad_desc;
239 }
240
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200241 /* some devices merge these - skip class check */
242 if (info->control == info->data)
243 goto next_desc;
244
David Brownell4324fd42005-08-31 09:54:20 -0700245 /* a data interface altsetting does the real i/o */
246 d = &info->data->cur_altsetting->desc;
247 if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
248 dev_dbg(&intf->dev, "slave class %u\n",
249 d->bInterfaceClass);
250 goto bad_desc;
251 }
252 break;
253 case USB_CDC_ETHERNET_TYPE:
254 if (info->ether) {
255 dev_dbg(&intf->dev, "extra CDC ether\n");
256 goto bad_desc;
257 }
258 info->ether = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200259 if (info->ether->bLength != sizeof(*info->ether)) {
David Brownell4324fd42005-08-31 09:54:20 -0700260 dev_dbg(&intf->dev, "CDC ether len %u\n",
261 info->ether->bLength);
262 goto bad_desc;
263 }
264 dev->hard_mtu = le16_to_cpu(
265 info->ether->wMaxSegmentSize);
266 /* because of Zaurus, we may be ignoring the host
267 * side link address we were given.
268 */
269 break;
Jonas Sjöquist21851262010-04-23 01:07:45 +0000270 case USB_CDC_MDLM_TYPE:
271 if (desc) {
272 dev_dbg(&intf->dev, "extra MDLM descriptor\n");
273 goto bad_desc;
274 }
275
276 desc = (void *)buf;
277
278 if (desc->bLength != sizeof(*desc))
279 goto bad_desc;
280
281 if (memcmp(&desc->bGUID, mbm_guid, 16))
282 goto bad_desc;
283 break;
284 case USB_CDC_MDLM_DETAIL_TYPE:
285 if (detail) {
286 dev_dbg(&intf->dev, "extra MDLM detail descriptor\n");
287 goto bad_desc;
288 }
289
290 detail = (void *)buf;
291
292 if (detail->bGuidDescriptorType == 0) {
293 if (detail->bLength < (sizeof(*detail) + 1))
294 goto bad_desc;
295 } else
296 goto bad_desc;
297 break;
David Brownell4324fd42005-08-31 09:54:20 -0700298 }
299next_desc:
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200300 len -= buf[0]; /* bLength */
301 buf += buf[0];
David Brownell4324fd42005-08-31 09:54:20 -0700302 }
303
Bjorge Dijkstra786e3df2008-01-26 00:50:44 +0200304 /* Microsoft ActiveSync based and some regular RNDIS devices lack the
305 * CDC descriptors, so we'll hard-wire the interfaces and not check
306 * for descriptors.
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000307 *
308 * Some Android RNDIS devices have a CDC Union descriptor pointing
309 * to non-existing interfaces. Ignore that and attempt the same
310 * hard-wired 0 and 1 interfaces.
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800311 */
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000312 if (rndis && (!info->u || android_rndis_quirk)) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800313 info->control = usb_ifnum_to_if(dev->udev, 0);
314 info->data = usb_ifnum_to_if(dev->udev, 1);
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000315 if (!info->control || !info->data || info->control != intf) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800316 dev_dbg(&intf->dev,
Bjorge Dijkstra786e3df2008-01-26 00:50:44 +0200317 "rndis: master #0/%p slave #1/%p\n",
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800318 info->control,
319 info->data);
320 goto bad_desc;
321 }
322
323 } else if (!info->header || !info->u || (!rndis && !info->ether)) {
David Brownell4324fd42005-08-31 09:54:20 -0700324 dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
325 info->header ? "" : "header ",
326 info->u ? "" : "union ",
327 info->ether ? "" : "ether ");
328 goto bad_desc;
329 }
330
331 /* claim data interface and set it up ... with side effects.
332 * network traffic can't flow until an altsetting is enabled.
333 */
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200334 if (info->data != info->control) {
335 status = usb_driver_claim_interface(driver, info->data, dev);
336 if (status < 0)
337 return status;
338 }
David Brownell4324fd42005-08-31 09:54:20 -0700339 status = usbnet_get_endpoints(dev, info->data);
340 if (status < 0) {
341 /* ensure immediate exit from usbnet_disconnect */
342 usb_set_intfdata(info->data, NULL);
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200343 if (info->data != info->control)
344 usb_driver_release_interface(driver, info->data);
David Brownell4324fd42005-08-31 09:54:20 -0700345 return status;
346 }
347
348 /* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200349 if (info->data != info->control)
350 dev->status = NULL;
David Brownell4324fd42005-08-31 09:54:20 -0700351 if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
352 struct usb_endpoint_descriptor *desc;
353
354 dev->status = &info->control->cur_altsetting->endpoint [0];
355 desc = &dev->status->desc;
Joe Perches8e95a202009-12-03 07:58:21 +0000356 if (!usb_endpoint_is_int_in(desc) ||
357 (le16_to_cpu(desc->wMaxPacketSize)
358 < sizeof(struct usb_cdc_notification)) ||
359 !desc->bInterval) {
David Brownell4324fd42005-08-31 09:54:20 -0700360 dev_dbg(&intf->dev, "bad notification endpoint\n");
361 dev->status = NULL;
362 }
363 }
364 if (rndis && !dev->status) {
365 dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
366 usb_set_intfdata(info->data, NULL);
367 usb_driver_release_interface(driver, info->data);
368 return -ENODEV;
369 }
Oliver Neukumc472ab62014-07-28 10:56:36 +0200370
371 /* Some devices don't initialise properly. In particular
372 * the packet filter is not reset. There are devices that
373 * don't do reset all the way. So the packet filter should
374 * be set to a sane initial value.
375 */
Olivier Blind80c6792014-10-24 19:43:01 +0200376 usbnet_cdc_update_filter(dev);
377
David Brownell4324fd42005-08-31 09:54:20 -0700378 return 0;
379
380bad_desc:
381 dev_info(&dev->udev->dev, "bad CDC descriptors\n");
382 return -ENODEV;
383}
384EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
385
386void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
387{
388 struct cdc_state *info = (void *) &dev->data;
389 struct usb_driver *driver = driver_of(intf);
390
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200391 /* combined interface - nothing to do */
392 if (info->data == info->control)
393 return;
394
David Brownell4324fd42005-08-31 09:54:20 -0700395 /* disconnect master --> disconnect slave */
396 if (intf == info->control && info->data) {
397 /* ensure immediate exit from usbnet_disconnect */
398 usb_set_intfdata(info->data, NULL);
399 usb_driver_release_interface(driver, info->data);
400 info->data = NULL;
401 }
402
403 /* and vice versa (just in case) */
404 else if (intf == info->data && info->control) {
405 /* ensure immediate exit from usbnet_disconnect */
406 usb_set_intfdata(info->control, NULL);
407 usb_driver_release_interface(driver, info->control);
408 info->control = NULL;
409 }
410}
411EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
412
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200413/* Communications Device Class, Ethernet Control model
David Brownell4324fd42005-08-31 09:54:20 -0700414 *
415 * Takes two interfaces. The DATA interface is inactive till an altsetting
416 * is selected. Configuration data includes class descriptors. There's
417 * an optional status endpoint on the control interface.
418 *
419 * This should interop with whatever the 2.4 "CDCEther.c" driver
420 * (by Brad Hards) talked with, with more functionality.
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200421 */
David Brownell4324fd42005-08-31 09:54:20 -0700422
423static void dumpspeed(struct usbnet *dev, __le32 *speeds)
424{
Joe Perchesa475f602010-02-17 10:30:24 +0000425 netif_info(dev, timer, dev->net,
426 "link speeds: %u kbps up, %u kbps down\n",
427 __le32_to_cpu(speeds[0]) / 1000,
428 __le32_to_cpu(speeds[1]) / 1000);
David Brownell4324fd42005-08-31 09:54:20 -0700429}
430
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000431void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
David Brownell4324fd42005-08-31 09:54:20 -0700432{
433 struct usb_cdc_notification *event;
434
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200435 if (urb->actual_length < sizeof(*event))
David Brownell4324fd42005-08-31 09:54:20 -0700436 return;
437
438 /* SPEED_CHANGE can get split into two 8-byte packets */
439 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
440 dumpspeed(dev, (__le32 *) urb->transfer_buffer);
441 return;
442 }
443
444 event = urb->transfer_buffer;
445 switch (event->bNotificationType) {
446 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
Joe Perchesa475f602010-02-17 10:30:24 +0000447 netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
448 event->wValue ? "on" : "off");
Bjørn Morka6bda452013-04-16 22:12:13 +0000449 usbnet_link_change(dev, !!event->wValue, 0);
David Brownell4324fd42005-08-31 09:54:20 -0700450 break;
451 case USB_CDC_NOTIFY_SPEED_CHANGE: /* tx/rx rates */
Joe Perchesa475f602010-02-17 10:30:24 +0000452 netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
453 urb->actual_length);
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200454 if (urb->actual_length != (sizeof(*event) + 8))
David Brownell4324fd42005-08-31 09:54:20 -0700455 set_bit(EVENT_STS_SPLIT, &dev->flags);
456 else
457 dumpspeed(dev, (__le32 *) &event[1]);
458 break;
459 /* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
460 * but there are no standard formats for the response data.
461 */
462 default:
Joe Perches60b86752010-02-17 10:30:23 +0000463 netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
464 event->bNotificationType);
David Brownell4324fd42005-08-31 09:54:20 -0700465 break;
466 }
467}
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000468EXPORT_SYMBOL_GPL(usbnet_cdc_status);
David Brownell4324fd42005-08-31 09:54:20 -0700469
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000470int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
David Brownell4324fd42005-08-31 09:54:20 -0700471{
472 int status;
473 struct cdc_state *info = (void *) &dev->data;
474
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800475 BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
476 < sizeof(struct cdc_state)));
477
David Brownell4324fd42005-08-31 09:54:20 -0700478 status = usbnet_generic_cdc_bind(dev, intf);
479 if (status < 0)
480 return status;
481
Peter Holik03ad0322009-04-18 07:24:17 +0000482 status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
David Brownell4324fd42005-08-31 09:54:20 -0700483 if (status < 0) {
484 usb_set_intfdata(info->data, NULL);
485 usb_driver_release_interface(driver_of(intf), info->data);
486 return status;
487 }
488
David Brownell4324fd42005-08-31 09:54:20 -0700489 return 0;
490}
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000491EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
David Brownell4324fd42005-08-31 09:54:20 -0700492
493static const struct driver_info cdc_info = {
494 .description = "CDC Ethernet Device",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700495 .flags = FLAG_ETHER | FLAG_POINTTOPOINT,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000496 .bind = usbnet_cdc_bind,
David Brownell4324fd42005-08-31 09:54:20 -0700497 .unbind = usbnet_cdc_unbind,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000498 .status = usbnet_cdc_status,
Oliver Neukuma5e40702012-12-18 04:46:12 +0000499 .manage_power = usbnet_manage_power,
David Brownell4324fd42005-08-31 09:54:20 -0700500};
501
Dan Williamsb3c914a2011-04-27 09:54:28 +0000502static const struct driver_info wwan_info = {
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000503 .description = "Mobile Broadband Network Device",
504 .flags = FLAG_WWAN,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000505 .bind = usbnet_cdc_bind,
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000506 .unbind = usbnet_cdc_unbind,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000507 .status = usbnet_cdc_status,
Oliver Neukuma5e40702012-12-18 04:46:12 +0000508 .manage_power = usbnet_manage_power,
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000509};
510
David Brownell4324fd42005-08-31 09:54:20 -0700511/*-------------------------------------------------------------------------*/
512
Dan Williamsb3c914a2011-04-27 09:54:28 +0000513#define HUAWEI_VENDOR_ID 0x12D1
Dan Williams4e6304b2012-05-07 04:24:51 +0000514#define NOVATEL_VENDOR_ID 0x1410
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000515#define ZTE_VENDOR_ID 0x19D2
Dan Williams0370acd2012-12-17 08:17:41 +0000516#define DELL_VENDOR_ID 0x413C
hayeswangac718b62013-05-02 16:01:25 +0000517#define REALTEK_VENDOR_ID 0x0bda
hayeswang43779f82014-01-02 11:25:10 +0800518#define SAMSUNG_VENDOR_ID 0x04e8
David Brownell4324fd42005-08-31 09:54:20 -0700519
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200520static const struct usb_device_id products[] = {
521/* BLACKLIST !!
David Brownell4324fd42005-08-31 09:54:20 -0700522 *
523 * First blacklist any products that are egregiously nonconformant
524 * with the CDC Ethernet specs. Minor braindamage we cope with; when
525 * they're not even trying, needing a separate driver is only the first
526 * of the differences to show up.
527 */
528
529#define ZAURUS_MASTER_INTERFACE \
530 .bInterfaceClass = USB_CLASS_COMM, \
531 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
532 .bInterfaceProtocol = USB_CDC_PROTO_NONE
533
534/* SA-1100 based Sharp Zaurus ("collie"), or compatible;
535 * wire-incompatible with true CDC Ethernet implementations.
536 * (And, it seems, needlessly so...)
537 */
538{
539 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
540 | USB_DEVICE_ID_MATCH_DEVICE,
541 .idVendor = 0x04DD,
542 .idProduct = 0x8004,
543 ZAURUS_MASTER_INTERFACE,
544 .driver_info = 0,
545},
546
547/* PXA-25x based Sharp Zaurii. Note that it seems some of these
548 * (later models especially) may have shipped only with firmware
549 * advertising false "CDC MDLM" compatibility ... but we're not
550 * clear which models did that, so for now let's assume the worst.
551 */
552{
553 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
554 | USB_DEVICE_ID_MATCH_DEVICE,
555 .idVendor = 0x04DD,
556 .idProduct = 0x8005, /* A-300 */
557 ZAURUS_MASTER_INTERFACE,
558 .driver_info = 0,
559}, {
560 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
561 | USB_DEVICE_ID_MATCH_DEVICE,
562 .idVendor = 0x04DD,
563 .idProduct = 0x8006, /* B-500/SL-5600 */
564 ZAURUS_MASTER_INTERFACE,
565 .driver_info = 0,
566}, {
567 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200568 | USB_DEVICE_ID_MATCH_DEVICE,
David Brownell4324fd42005-08-31 09:54:20 -0700569 .idVendor = 0x04DD,
570 .idProduct = 0x8007, /* C-700 */
571 ZAURUS_MASTER_INTERFACE,
572 .driver_info = 0,
573}, {
574 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
575 | USB_DEVICE_ID_MATCH_DEVICE,
576 .idVendor = 0x04DD,
577 .idProduct = 0x9031, /* C-750 C-760 */
578 ZAURUS_MASTER_INTERFACE,
579 .driver_info = 0,
580}, {
581 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
582 | USB_DEVICE_ID_MATCH_DEVICE,
583 .idVendor = 0x04DD,
584 .idProduct = 0x9032, /* SL-6000 */
585 ZAURUS_MASTER_INTERFACE,
586 .driver_info = 0,
587}, {
588 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
589 | USB_DEVICE_ID_MATCH_DEVICE,
590 .idVendor = 0x04DD,
591 /* reported with some C860 units */
592 .idProduct = 0x9050, /* C-860 */
593 ZAURUS_MASTER_INTERFACE,
594 .driver_info = 0,
595},
596
David Brownellefcaa202006-05-30 20:49:29 -0700597/* Olympus has some models with a Zaurus-compatible option.
598 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
599 */
600{
601 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
602 | USB_DEVICE_ID_MATCH_DEVICE,
603 .idVendor = 0x07B4,
604 .idProduct = 0x0F02, /* R-1000 */
605 ZAURUS_MASTER_INTERFACE,
606 .driver_info = 0,
607},
608
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000609/* LG Electronics VL600 wants additional headers on every frame */
610{
611 USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
612 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Mark Kamichoff6d74eb92011-11-09 11:48:10 +0000613 .driver_info = 0,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000614},
615
Scott Talbertee932bf2012-02-21 13:06:00 +0000616/* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
617{
618 USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
619 USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
620 .driver_info = 0,
621},
622
Dan Williamsf8295ec2012-10-24 12:10:34 +0000623/* Novatel USB551L and MC551 - handled by qmi_wwan */
624{
Dan Williamsc39ba1c2012-12-17 08:19:46 +0000625 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0xB001, USB_CLASS_COMM,
626 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Dan Williamsf8295ec2012-10-24 12:10:34 +0000627 .driver_info = 0,
628},
629
630/* Novatel E362 - handled by qmi_wwan */
631{
Dan Williamsc39ba1c2012-12-17 08:19:46 +0000632 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9010, USB_CLASS_COMM,
633 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Dan Williamsf8295ec2012-10-24 12:10:34 +0000634 .driver_info = 0,
635},
636
Dan Williams0370acd2012-12-17 08:17:41 +0000637/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
638{
639 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8195, USB_CLASS_COMM,
640 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
641 .driver_info = 0,
642},
643
644/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
645{
646 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8196, USB_CLASS_COMM,
647 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
648 .driver_info = 0,
649},
650
Dan Williams7fdb7842013-05-06 11:17:37 +0000651/* Dell Wireless 5804 (Novatel E371) - handled by qmi_wwan */
652{
653 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x819b, USB_CLASS_COMM,
654 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
655 .driver_info = 0,
656},
657
Yegor Yefremov7b5939b2014-03-28 12:07:18 +0100658/* Novatel Expedite E371 - handled by qmi_wwan */
659{
660 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9011, USB_CLASS_COMM,
661 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
662 .driver_info = 0,
663},
664
Dan Williams45d213f2013-02-18 17:25:09 +0000665/* AnyDATA ADU960S - handled by qmi_wwan */
666{
667 USB_DEVICE_AND_INTERFACE_INFO(0x16d5, 0x650a, USB_CLASS_COMM,
668 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
669 .driver_info = 0,
670},
671
Bjørn Morkc2020be2013-06-06 12:57:02 +0200672/* Huawei E1820 - handled by qmi_wwan */
673{
674 USB_DEVICE_INTERFACE_NUMBER(HUAWEI_VENDOR_ID, 0x14ac, 1),
675 .driver_info = 0,
676},
677
hayeswangac718b62013-05-02 16:01:25 +0000678/* Realtek RTL8152 Based USB 2.0 Ethernet Adapters */
hayeswangac718b62013-05-02 16:01:25 +0000679{
680 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8152, USB_CLASS_COMM,
681 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
682 .driver_info = 0,
683},
hayeswangc073f662013-07-08 10:41:21 +0800684
685/* Realtek RTL8153 Based USB 3.0 Ethernet Adapters */
686{
687 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8153, USB_CLASS_COMM,
688 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
689 .driver_info = 0,
690},
hayeswangac718b62013-05-02 16:01:25 +0000691
hayeswang10c32712014-03-04 20:47:48 +0800692/* Samsung USB Ethernet Adapters */
693{
694 USB_DEVICE_AND_INTERFACE_INFO(SAMSUNG_VENDOR_ID, 0xa101, USB_CLASS_COMM,
695 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
696 .driver_info = 0,
697},
698
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200699/* WHITELIST!!!
David Brownell4324fd42005-08-31 09:54:20 -0700700 *
701 * CDC Ether uses two interfaces, not necessarily consecutive.
702 * We match the main interface, ignoring the optional device
703 * class so we could handle devices that aren't exclusively
704 * CDC ether.
705 *
706 * NOTE: this match must come AFTER entries blacklisting devices
707 * because of bugs/quirks in a given product (like Zaurus, above).
708 */
709{
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000710 /* ZTE (Vodafone) K3805-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200711 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1003, USB_CLASS_COMM,
712 USB_CDC_SUBCLASS_ETHERNET,
713 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000714 .driver_info = (unsigned long)&wwan_info,
715}, {
716 /* ZTE (Vodafone) K3806-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200717 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1015, USB_CLASS_COMM,
718 USB_CDC_SUBCLASS_ETHERNET,
719 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000720 .driver_info = (unsigned long)&wwan_info,
721}, {
722 /* ZTE (Vodafone) K4510-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200723 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1173, USB_CLASS_COMM,
724 USB_CDC_SUBCLASS_ETHERNET,
725 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000726 .driver_info = (unsigned long)&wwan_info,
727}, {
728 /* ZTE (Vodafone) K3770-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200729 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1177, USB_CLASS_COMM,
730 USB_CDC_SUBCLASS_ETHERNET,
731 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000732 .driver_info = (unsigned long)&wwan_info,
733}, {
734 /* ZTE (Vodafone) K3772-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200735 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1181, USB_CLASS_COMM,
736 USB_CDC_SUBCLASS_ETHERNET,
737 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000738 .driver_info = (unsigned long)&wwan_info,
739}, {
Fabio Porcedda00928202013-09-16 11:47:50 +0200740 /* Telit modules */
741 USB_VENDOR_AND_INTERFACE_INFO(0x1bc7, USB_CLASS_COMM,
742 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
743 .driver_info = (kernel_ulong_t) &wwan_info,
744}, {
David Brownell4324fd42005-08-31 09:54:20 -0700745 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
746 USB_CDC_PROTO_NONE),
747 .driver_info = (unsigned long) &cdc_info,
Bjørn Morkcac477e2009-02-25 04:33:58 +0000748}, {
Jonas Sjöquist21851262010-04-23 01:07:45 +0000749 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
750 USB_CDC_PROTO_NONE),
Dan Williamsb3c914a2011-04-27 09:54:28 +0000751 .driver_info = (unsigned long)&wwan_info,
Jonas Sjöquist21851262010-04-23 01:07:45 +0000752
Dan Williamsb3c914a2011-04-27 09:54:28 +0000753}, {
754 /* Various Huawei modems with a network port like the UMG1831 */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200755 USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_COMM,
756 USB_CDC_SUBCLASS_ETHERNET, 255),
Dan Williamsb3c914a2011-04-27 09:54:28 +0000757 .driver_info = (unsigned long)&wwan_info,
David Brownell4324fd42005-08-31 09:54:20 -0700758},
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200759 { }, /* END */
David Brownell4324fd42005-08-31 09:54:20 -0700760};
761MODULE_DEVICE_TABLE(usb, products);
762
763static struct usb_driver cdc_driver = {
David Brownell4324fd42005-08-31 09:54:20 -0700764 .name = "cdc_ether",
765 .id_table = products,
766 .probe = usbnet_probe,
767 .disconnect = usbnet_disconnect,
768 .suspend = usbnet_suspend,
769 .resume = usbnet_resume,
Oliver Neukum7f515792009-12-03 11:41:07 +0000770 .reset_resume = usbnet_resume,
Oliver Neukum69ee472f2009-12-03 15:31:18 -0800771 .supports_autosuspend = 1,
Sarah Sharpe1f12eb2012-04-23 10:08:51 -0700772 .disable_hub_initiated_lpm = 1,
David Brownell4324fd42005-08-31 09:54:20 -0700773};
774
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800775module_usb_driver(cdc_driver);
David Brownell4324fd42005-08-31 09:54:20 -0700776
777MODULE_AUTHOR("David Brownell");
778MODULE_DESCRIPTION("USB CDC Ethernet devices");
779MODULE_LICENSE("GPL");