blob: 03ad4dc293aa2a468f8a93f0a0d045623507a9a0 [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
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21// #define DEBUG // error path messages, extra info
22// #define VERBOSE // more; success messages
23
David Brownell4324fd42005-08-31 09:54:20 -070024#include <linux/module.h>
David Brownell4324fd42005-08-31 09:54:20 -070025#include <linux/init.h>
26#include <linux/netdevice.h>
27#include <linux/etherdevice.h>
David Brownell4324fd42005-08-31 09:54:20 -070028#include <linux/ethtool.h>
29#include <linux/workqueue.h>
30#include <linux/mii.h>
31#include <linux/usb.h>
David Brownella8c28f22006-06-13 09:57:47 -070032#include <linux/usb/cdc.h>
Jussi Kivilinna3692e942008-01-26 00:51:45 +020033#include <linux/usb/usbnet.h>
David Brownell4324fd42005-08-31 09:54:20 -070034
35
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080036#if defined(CONFIG_USB_NET_RNDIS_HOST) || defined(CONFIG_USB_NET_RNDIS_HOST_MODULE)
37
38static int is_rndis(struct usb_interface_descriptor *desc)
39{
Joe Perches8e95a202009-12-03 07:58:21 +000040 return (desc->bInterfaceClass == USB_CLASS_COMM &&
41 desc->bInterfaceSubClass == 2 &&
42 desc->bInterfaceProtocol == 0xff);
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080043}
44
45static int is_activesync(struct usb_interface_descriptor *desc)
46{
Joe Perches8e95a202009-12-03 07:58:21 +000047 return (desc->bInterfaceClass == USB_CLASS_MISC &&
48 desc->bInterfaceSubClass == 1 &&
49 desc->bInterfaceProtocol == 1);
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080050}
51
Thomas Backlund7e99eed2008-07-22 13:55:58 -070052static int is_wireless_rndis(struct usb_interface_descriptor *desc)
53{
Joe Perches8e95a202009-12-03 07:58:21 +000054 return (desc->bInterfaceClass == USB_CLASS_WIRELESS_CONTROLLER &&
55 desc->bInterfaceSubClass == 1 &&
56 desc->bInterfaceProtocol == 3);
Thomas Backlund7e99eed2008-07-22 13:55:58 -070057}
58
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080059#else
60
61#define is_rndis(desc) 0
62#define is_activesync(desc) 0
Thomas Backlund7e99eed2008-07-22 13:55:58 -070063#define is_wireless_rndis(desc) 0
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080064
65#endif
66
Jonas Sjöquist21851262010-04-23 01:07:45 +000067static const u8 mbm_guid[16] = {
68 0xa3, 0x17, 0xa8, 0x8b, 0x04, 0x5e, 0x4f, 0x01,
69 0xa6, 0x07, 0xc0, 0xff, 0xcb, 0x7e, 0x39, 0x2a,
70};
71
David Brownell4324fd42005-08-31 09:54:20 -070072/*
73 * probes control interface, claims data interface, collects the bulk
74 * endpoints, activates data interface (if needed), maybe sets MTU.
75 * all pure cdc, except for certain firmware workarounds, and knowing
76 * that rndis uses one different rule.
77 */
78int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
79{
80 u8 *buf = intf->cur_altsetting->extra;
81 int len = intf->cur_altsetting->extralen;
82 struct usb_interface_descriptor *d;
83 struct cdc_state *info = (void *) &dev->data;
84 int status;
85 int rndis;
Bjørn Mork6eddcb42012-04-26 02:35:10 +000086 bool android_rndis_quirk = false;
David Brownell4324fd42005-08-31 09:54:20 -070087 struct usb_driver *driver = driver_of(intf);
Jonas Sjöquist21851262010-04-23 01:07:45 +000088 struct usb_cdc_mdlm_desc *desc = NULL;
89 struct usb_cdc_mdlm_detail_desc *detail = NULL;
David Brownell4324fd42005-08-31 09:54:20 -070090
91 if (sizeof dev->data < sizeof *info)
92 return -EDOM;
93
94 /* expect strict spec conformance for the descriptors, but
95 * cope with firmware which stores them in the wrong place
96 */
97 if (len == 0 && dev->udev->actconfig->extralen) {
98 /* Motorola SB4100 (and others: Brad Hards says it's
99 * from a Broadcom design) put CDC descriptors here
100 */
101 buf = dev->udev->actconfig->extra;
102 len = dev->udev->actconfig->extralen;
Dan Carpenterf5260f02010-12-25 12:23:42 +0000103 dev_dbg(&intf->dev, "CDC descriptors on config\n");
David Brownell4324fd42005-08-31 09:54:20 -0700104 }
105
David Brownell4149b722007-04-29 10:09:47 -0700106 /* Maybe CDC descriptors are after the endpoint? This bug has
107 * been seen on some 2Wire Inc RNDIS-ish products.
108 */
109 if (len == 0) {
110 struct usb_host_endpoint *hep;
111
112 hep = intf->cur_altsetting->endpoint;
113 if (hep) {
114 buf = hep->extra;
115 len = hep->extralen;
116 }
117 if (len)
118 dev_dbg(&intf->dev,
119 "CDC descriptors on endpoint\n");
120 }
121
David Brownell4324fd42005-08-31 09:54:20 -0700122 /* this assumes that if there's a non-RNDIS vendor variant
123 * of cdc-acm, it'll fail RNDIS requests cleanly.
124 */
Joe Perches8e95a202009-12-03 07:58:21 +0000125 rndis = (is_rndis(&intf->cur_altsetting->desc) ||
126 is_activesync(&intf->cur_altsetting->desc) ||
127 is_wireless_rndis(&intf->cur_altsetting->desc));
David Brownell4324fd42005-08-31 09:54:20 -0700128
129 memset(info, 0, sizeof *info);
130 info->control = intf;
131 while (len > 3) {
132 if (buf [1] != USB_DT_CS_INTERFACE)
133 goto next_desc;
134
135 /* use bDescriptorSubType to identify the CDC descriptors.
136 * We expect devices with CDC header and union descriptors.
137 * For CDC Ethernet we need the ethernet descriptor.
138 * For RNDIS, ignore two (pointless) CDC modem descriptors
139 * in favor of a complicated OID-based RPC scheme doing what
140 * CDC Ethernet achieves with a simple descriptor.
141 */
142 switch (buf [2]) {
143 case USB_CDC_HEADER_TYPE:
144 if (info->header) {
145 dev_dbg(&intf->dev, "extra CDC header\n");
146 goto bad_desc;
147 }
148 info->header = (void *) buf;
149 if (info->header->bLength != sizeof *info->header) {
150 dev_dbg(&intf->dev, "CDC header len %u\n",
151 info->header->bLength);
152 goto bad_desc;
153 }
154 break;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800155 case USB_CDC_ACM_TYPE:
156 /* paranoia: disambiguate a "real" vendor-specific
157 * modem interface from an RNDIS non-modem.
158 */
159 if (rndis) {
David Brownellafaee822007-07-01 11:47:59 -0700160 struct usb_cdc_acm_descriptor *acm;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800161
David Brownellafaee822007-07-01 11:47:59 -0700162 acm = (void *) buf;
163 if (acm->bmCapabilities) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800164 dev_dbg(&intf->dev,
165 "ACM capabilities %02x, "
166 "not really RNDIS?\n",
David Brownellafaee822007-07-01 11:47:59 -0700167 acm->bmCapabilities);
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800168 goto bad_desc;
169 }
170 }
171 break;
David Brownell4324fd42005-08-31 09:54:20 -0700172 case USB_CDC_UNION_TYPE:
173 if (info->u) {
174 dev_dbg(&intf->dev, "extra CDC union\n");
175 goto bad_desc;
176 }
177 info->u = (void *) buf;
178 if (info->u->bLength != sizeof *info->u) {
179 dev_dbg(&intf->dev, "CDC union len %u\n",
180 info->u->bLength);
181 goto bad_desc;
182 }
183
184 /* we need a master/control interface (what we're
185 * probed with) and a slave/data interface; union
186 * descriptors sort this all out.
187 */
188 info->control = usb_ifnum_to_if(dev->udev,
189 info->u->bMasterInterface0);
190 info->data = usb_ifnum_to_if(dev->udev,
191 info->u->bSlaveInterface0);
192 if (!info->control || !info->data) {
193 dev_dbg(&intf->dev,
194 "master #%u/%p slave #%u/%p\n",
195 info->u->bMasterInterface0,
196 info->control,
197 info->u->bSlaveInterface0,
198 info->data);
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000199 /* fall back to hard-wiring for RNDIS */
200 if (rndis) {
201 android_rndis_quirk = true;
202 goto next_desc;
203 }
David Brownell4324fd42005-08-31 09:54:20 -0700204 goto bad_desc;
205 }
206 if (info->control != intf) {
207 dev_dbg(&intf->dev, "bogus CDC Union\n");
208 /* Ambit USB Cable Modem (and maybe others)
209 * interchanges master and slave interface.
210 */
211 if (info->data == intf) {
212 info->data = info->control;
213 info->control = intf;
214 } else
215 goto bad_desc;
216 }
217
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200218 /* some devices merge these - skip class check */
219 if (info->control == info->data)
220 goto next_desc;
221
David Brownell4324fd42005-08-31 09:54:20 -0700222 /* a data interface altsetting does the real i/o */
223 d = &info->data->cur_altsetting->desc;
224 if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
225 dev_dbg(&intf->dev, "slave class %u\n",
226 d->bInterfaceClass);
227 goto bad_desc;
228 }
229 break;
230 case USB_CDC_ETHERNET_TYPE:
231 if (info->ether) {
232 dev_dbg(&intf->dev, "extra CDC ether\n");
233 goto bad_desc;
234 }
235 info->ether = (void *) buf;
236 if (info->ether->bLength != sizeof *info->ether) {
237 dev_dbg(&intf->dev, "CDC ether len %u\n",
238 info->ether->bLength);
239 goto bad_desc;
240 }
241 dev->hard_mtu = le16_to_cpu(
242 info->ether->wMaxSegmentSize);
243 /* because of Zaurus, we may be ignoring the host
244 * side link address we were given.
245 */
246 break;
Jonas Sjöquist21851262010-04-23 01:07:45 +0000247 case USB_CDC_MDLM_TYPE:
248 if (desc) {
249 dev_dbg(&intf->dev, "extra MDLM descriptor\n");
250 goto bad_desc;
251 }
252
253 desc = (void *)buf;
254
255 if (desc->bLength != sizeof(*desc))
256 goto bad_desc;
257
258 if (memcmp(&desc->bGUID, mbm_guid, 16))
259 goto bad_desc;
260 break;
261 case USB_CDC_MDLM_DETAIL_TYPE:
262 if (detail) {
263 dev_dbg(&intf->dev, "extra MDLM detail descriptor\n");
264 goto bad_desc;
265 }
266
267 detail = (void *)buf;
268
269 if (detail->bGuidDescriptorType == 0) {
270 if (detail->bLength < (sizeof(*detail) + 1))
271 goto bad_desc;
272 } else
273 goto bad_desc;
274 break;
David Brownell4324fd42005-08-31 09:54:20 -0700275 }
276next_desc:
277 len -= buf [0]; /* bLength */
278 buf += buf [0];
279 }
280
Bjorge Dijkstra786e3df2008-01-26 00:50:44 +0200281 /* Microsoft ActiveSync based and some regular RNDIS devices lack the
282 * CDC descriptors, so we'll hard-wire the interfaces and not check
283 * for descriptors.
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000284 *
285 * Some Android RNDIS devices have a CDC Union descriptor pointing
286 * to non-existing interfaces. Ignore that and attempt the same
287 * hard-wired 0 and 1 interfaces.
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800288 */
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000289 if (rndis && (!info->u || android_rndis_quirk)) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800290 info->control = usb_ifnum_to_if(dev->udev, 0);
291 info->data = usb_ifnum_to_if(dev->udev, 1);
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000292 if (!info->control || !info->data || info->control != intf) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800293 dev_dbg(&intf->dev,
Bjorge Dijkstra786e3df2008-01-26 00:50:44 +0200294 "rndis: master #0/%p slave #1/%p\n",
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800295 info->control,
296 info->data);
297 goto bad_desc;
298 }
299
300 } else if (!info->header || !info->u || (!rndis && !info->ether)) {
David Brownell4324fd42005-08-31 09:54:20 -0700301 dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
302 info->header ? "" : "header ",
303 info->u ? "" : "union ",
304 info->ether ? "" : "ether ");
305 goto bad_desc;
306 }
307
308 /* claim data interface and set it up ... with side effects.
309 * network traffic can't flow until an altsetting is enabled.
310 */
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200311 if (info->data != info->control) {
312 status = usb_driver_claim_interface(driver, info->data, dev);
313 if (status < 0)
314 return status;
315 }
David Brownell4324fd42005-08-31 09:54:20 -0700316 status = usbnet_get_endpoints(dev, info->data);
317 if (status < 0) {
318 /* ensure immediate exit from usbnet_disconnect */
319 usb_set_intfdata(info->data, NULL);
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200320 if (info->data != info->control)
321 usb_driver_release_interface(driver, info->data);
David Brownell4324fd42005-08-31 09:54:20 -0700322 return status;
323 }
324
325 /* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200326 if (info->data != info->control)
327 dev->status = NULL;
David Brownell4324fd42005-08-31 09:54:20 -0700328 if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
329 struct usb_endpoint_descriptor *desc;
330
331 dev->status = &info->control->cur_altsetting->endpoint [0];
332 desc = &dev->status->desc;
Joe Perches8e95a202009-12-03 07:58:21 +0000333 if (!usb_endpoint_is_int_in(desc) ||
334 (le16_to_cpu(desc->wMaxPacketSize)
335 < sizeof(struct usb_cdc_notification)) ||
336 !desc->bInterval) {
David Brownell4324fd42005-08-31 09:54:20 -0700337 dev_dbg(&intf->dev, "bad notification endpoint\n");
338 dev->status = NULL;
339 }
340 }
341 if (rndis && !dev->status) {
342 dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
343 usb_set_intfdata(info->data, NULL);
344 usb_driver_release_interface(driver, info->data);
345 return -ENODEV;
346 }
347 return 0;
348
349bad_desc:
350 dev_info(&dev->udev->dev, "bad CDC descriptors\n");
351 return -ENODEV;
352}
353EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
354
355void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
356{
357 struct cdc_state *info = (void *) &dev->data;
358 struct usb_driver *driver = driver_of(intf);
359
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200360 /* combined interface - nothing to do */
361 if (info->data == info->control)
362 return;
363
David Brownell4324fd42005-08-31 09:54:20 -0700364 /* disconnect master --> disconnect slave */
365 if (intf == info->control && info->data) {
366 /* ensure immediate exit from usbnet_disconnect */
367 usb_set_intfdata(info->data, NULL);
368 usb_driver_release_interface(driver, info->data);
369 info->data = NULL;
370 }
371
372 /* and vice versa (just in case) */
373 else if (intf == info->data && info->control) {
374 /* ensure immediate exit from usbnet_disconnect */
375 usb_set_intfdata(info->control, NULL);
376 usb_driver_release_interface(driver, info->control);
377 info->control = NULL;
378 }
379}
380EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
381
David Brownell4324fd42005-08-31 09:54:20 -0700382/*-------------------------------------------------------------------------
383 *
384 * Communications Device Class, Ethernet Control model
385 *
386 * Takes two interfaces. The DATA interface is inactive till an altsetting
387 * is selected. Configuration data includes class descriptors. There's
388 * an optional status endpoint on the control interface.
389 *
390 * This should interop with whatever the 2.4 "CDCEther.c" driver
391 * (by Brad Hards) talked with, with more functionality.
392 *
393 *-------------------------------------------------------------------------*/
394
395static void dumpspeed(struct usbnet *dev, __le32 *speeds)
396{
Joe Perchesa475f602010-02-17 10:30:24 +0000397 netif_info(dev, timer, dev->net,
398 "link speeds: %u kbps up, %u kbps down\n",
399 __le32_to_cpu(speeds[0]) / 1000,
400 __le32_to_cpu(speeds[1]) / 1000);
David Brownell4324fd42005-08-31 09:54:20 -0700401}
402
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000403void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
David Brownell4324fd42005-08-31 09:54:20 -0700404{
405 struct usb_cdc_notification *event;
406
407 if (urb->actual_length < sizeof *event)
408 return;
409
410 /* SPEED_CHANGE can get split into two 8-byte packets */
411 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
412 dumpspeed(dev, (__le32 *) urb->transfer_buffer);
413 return;
414 }
415
416 event = urb->transfer_buffer;
417 switch (event->bNotificationType) {
418 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
Joe Perchesa475f602010-02-17 10:30:24 +0000419 netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
420 event->wValue ? "on" : "off");
Bjørn Morka6bda452013-04-16 22:12:13 +0000421 usbnet_link_change(dev, !!event->wValue, 0);
David Brownell4324fd42005-08-31 09:54:20 -0700422 break;
423 case USB_CDC_NOTIFY_SPEED_CHANGE: /* tx/rx rates */
Joe Perchesa475f602010-02-17 10:30:24 +0000424 netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
425 urb->actual_length);
David Brownell4324fd42005-08-31 09:54:20 -0700426 if (urb->actual_length != (sizeof *event + 8))
427 set_bit(EVENT_STS_SPLIT, &dev->flags);
428 else
429 dumpspeed(dev, (__le32 *) &event[1]);
430 break;
431 /* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
432 * but there are no standard formats for the response data.
433 */
434 default:
Joe Perches60b86752010-02-17 10:30:23 +0000435 netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
436 event->bNotificationType);
David Brownell4324fd42005-08-31 09:54:20 -0700437 break;
438 }
439}
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000440EXPORT_SYMBOL_GPL(usbnet_cdc_status);
David Brownell4324fd42005-08-31 09:54:20 -0700441
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000442int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
David Brownell4324fd42005-08-31 09:54:20 -0700443{
444 int status;
445 struct cdc_state *info = (void *) &dev->data;
446
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800447 BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
448 < sizeof(struct cdc_state)));
449
David Brownell4324fd42005-08-31 09:54:20 -0700450 status = usbnet_generic_cdc_bind(dev, intf);
451 if (status < 0)
452 return status;
453
Peter Holik03ad0322009-04-18 07:24:17 +0000454 status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
David Brownell4324fd42005-08-31 09:54:20 -0700455 if (status < 0) {
456 usb_set_intfdata(info->data, NULL);
457 usb_driver_release_interface(driver_of(intf), info->data);
458 return status;
459 }
460
461 /* FIXME cdc-ether has some multicast code too, though it complains
462 * in routine cases. info->ether describes the multicast support.
463 * Implement that here, manipulating the cdc filter as needed.
464 */
465 return 0;
466}
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000467EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
David Brownell4324fd42005-08-31 09:54:20 -0700468
469static const struct driver_info cdc_info = {
470 .description = "CDC Ethernet Device",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700471 .flags = FLAG_ETHER | FLAG_POINTTOPOINT,
David Brownell4324fd42005-08-31 09:54:20 -0700472 // .check_connect = cdc_check_connect,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000473 .bind = usbnet_cdc_bind,
David Brownell4324fd42005-08-31 09:54:20 -0700474 .unbind = usbnet_cdc_unbind,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000475 .status = usbnet_cdc_status,
Oliver Neukuma5e40702012-12-18 04:46:12 +0000476 .manage_power = usbnet_manage_power,
David Brownell4324fd42005-08-31 09:54:20 -0700477};
478
Dan Williamsb3c914a2011-04-27 09:54:28 +0000479static const struct driver_info wwan_info = {
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000480 .description = "Mobile Broadband Network Device",
481 .flags = FLAG_WWAN,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000482 .bind = usbnet_cdc_bind,
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000483 .unbind = usbnet_cdc_unbind,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000484 .status = usbnet_cdc_status,
Oliver Neukuma5e40702012-12-18 04:46:12 +0000485 .manage_power = usbnet_manage_power,
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000486};
487
David Brownell4324fd42005-08-31 09:54:20 -0700488/*-------------------------------------------------------------------------*/
489
Dan Williamsb3c914a2011-04-27 09:54:28 +0000490#define HUAWEI_VENDOR_ID 0x12D1
Dan Williams4e6304b2012-05-07 04:24:51 +0000491#define NOVATEL_VENDOR_ID 0x1410
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000492#define ZTE_VENDOR_ID 0x19D2
Dan Williams0370acd2012-12-17 08:17:41 +0000493#define DELL_VENDOR_ID 0x413C
hayeswangac718b62013-05-02 16:01:25 +0000494#define REALTEK_VENDOR_ID 0x0bda
David Brownell4324fd42005-08-31 09:54:20 -0700495
496static const struct usb_device_id products [] = {
497/*
498 * BLACKLIST !!
499 *
500 * First blacklist any products that are egregiously nonconformant
501 * with the CDC Ethernet specs. Minor braindamage we cope with; when
502 * they're not even trying, needing a separate driver is only the first
503 * of the differences to show up.
504 */
505
506#define ZAURUS_MASTER_INTERFACE \
507 .bInterfaceClass = USB_CLASS_COMM, \
508 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
509 .bInterfaceProtocol = USB_CDC_PROTO_NONE
510
511/* SA-1100 based Sharp Zaurus ("collie"), or compatible;
512 * wire-incompatible with true CDC Ethernet implementations.
513 * (And, it seems, needlessly so...)
514 */
515{
516 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
517 | USB_DEVICE_ID_MATCH_DEVICE,
518 .idVendor = 0x04DD,
519 .idProduct = 0x8004,
520 ZAURUS_MASTER_INTERFACE,
521 .driver_info = 0,
522},
523
524/* PXA-25x based Sharp Zaurii. Note that it seems some of these
525 * (later models especially) may have shipped only with firmware
526 * advertising false "CDC MDLM" compatibility ... but we're not
527 * clear which models did that, so for now let's assume the worst.
528 */
529{
530 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
531 | USB_DEVICE_ID_MATCH_DEVICE,
532 .idVendor = 0x04DD,
533 .idProduct = 0x8005, /* A-300 */
534 ZAURUS_MASTER_INTERFACE,
535 .driver_info = 0,
536}, {
537 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
538 | USB_DEVICE_ID_MATCH_DEVICE,
539 .idVendor = 0x04DD,
540 .idProduct = 0x8006, /* B-500/SL-5600 */
541 ZAURUS_MASTER_INTERFACE,
542 .driver_info = 0,
543}, {
544 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
545 | USB_DEVICE_ID_MATCH_DEVICE,
546 .idVendor = 0x04DD,
547 .idProduct = 0x8007, /* C-700 */
548 ZAURUS_MASTER_INTERFACE,
549 .driver_info = 0,
550}, {
551 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
552 | USB_DEVICE_ID_MATCH_DEVICE,
553 .idVendor = 0x04DD,
554 .idProduct = 0x9031, /* C-750 C-760 */
555 ZAURUS_MASTER_INTERFACE,
556 .driver_info = 0,
557}, {
558 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
559 | USB_DEVICE_ID_MATCH_DEVICE,
560 .idVendor = 0x04DD,
561 .idProduct = 0x9032, /* SL-6000 */
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 /* reported with some C860 units */
569 .idProduct = 0x9050, /* C-860 */
570 ZAURUS_MASTER_INTERFACE,
571 .driver_info = 0,
572},
573
David Brownellefcaa202006-05-30 20:49:29 -0700574/* Olympus has some models with a Zaurus-compatible option.
575 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
576 */
577{
578 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
579 | USB_DEVICE_ID_MATCH_DEVICE,
580 .idVendor = 0x07B4,
581 .idProduct = 0x0F02, /* R-1000 */
582 ZAURUS_MASTER_INTERFACE,
583 .driver_info = 0,
584},
585
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000586/* LG Electronics VL600 wants additional headers on every frame */
587{
588 USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
589 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Mark Kamichoff6d74eb92011-11-09 11:48:10 +0000590 .driver_info = 0,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000591},
592
Scott Talbertee932bf2012-02-21 13:06:00 +0000593/* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
594{
595 USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
596 USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
597 .driver_info = 0,
598},
599
Dan Williamsf8295ec2012-10-24 12:10:34 +0000600/* Novatel USB551L and MC551 - handled by qmi_wwan */
601{
Dan Williamsc39ba1c2012-12-17 08:19:46 +0000602 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0xB001, USB_CLASS_COMM,
603 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Dan Williamsf8295ec2012-10-24 12:10:34 +0000604 .driver_info = 0,
605},
606
607/* Novatel E362 - handled by qmi_wwan */
608{
Dan Williamsc39ba1c2012-12-17 08:19:46 +0000609 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9010, USB_CLASS_COMM,
610 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Dan Williamsf8295ec2012-10-24 12:10:34 +0000611 .driver_info = 0,
612},
613
Dan Williams0370acd2012-12-17 08:17:41 +0000614/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
615{
616 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8195, USB_CLASS_COMM,
617 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
618 .driver_info = 0,
619},
620
621/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
622{
623 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8196, USB_CLASS_COMM,
624 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
625 .driver_info = 0,
626},
627
Dan Williams7fdb7842013-05-06 11:17:37 +0000628/* Dell Wireless 5804 (Novatel E371) - handled by qmi_wwan */
629{
630 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x819b, USB_CLASS_COMM,
631 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
632 .driver_info = 0,
633},
634
Dan Williams45d213f2013-02-18 17:25:09 +0000635/* AnyDATA ADU960S - handled by qmi_wwan */
636{
637 USB_DEVICE_AND_INTERFACE_INFO(0x16d5, 0x650a, USB_CLASS_COMM,
638 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
639 .driver_info = 0,
640},
641
Bjørn Morkc2020be2013-06-06 12:57:02 +0200642/* Huawei E1820 - handled by qmi_wwan */
643{
644 USB_DEVICE_INTERFACE_NUMBER(HUAWEI_VENDOR_ID, 0x14ac, 1),
645 .driver_info = 0,
646},
647
hayeswangac718b62013-05-02 16:01:25 +0000648/* Realtek RTL8152 Based USB 2.0 Ethernet Adapters */
hayeswangac718b62013-05-02 16:01:25 +0000649{
650 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8152, USB_CLASS_COMM,
651 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
652 .driver_info = 0,
653},
hayeswangc073f662013-07-08 10:41:21 +0800654
655/* Realtek RTL8153 Based USB 3.0 Ethernet Adapters */
656{
657 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8153, USB_CLASS_COMM,
658 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
659 .driver_info = 0,
660},
hayeswangac718b62013-05-02 16:01:25 +0000661
David Brownell4324fd42005-08-31 09:54:20 -0700662/*
663 * WHITELIST!!!
664 *
665 * CDC Ether uses two interfaces, not necessarily consecutive.
666 * We match the main interface, ignoring the optional device
667 * class so we could handle devices that aren't exclusively
668 * CDC ether.
669 *
670 * NOTE: this match must come AFTER entries blacklisting devices
671 * because of bugs/quirks in a given product (like Zaurus, above).
672 */
673{
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000674 /* ZTE (Vodafone) K3805-Z */
675 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
676 | USB_DEVICE_ID_MATCH_PRODUCT
677 | USB_DEVICE_ID_MATCH_INT_INFO,
678 .idVendor = ZTE_VENDOR_ID,
679 .idProduct = 0x1003,
680 .bInterfaceClass = USB_CLASS_COMM,
681 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
682 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
683 .driver_info = (unsigned long)&wwan_info,
684}, {
685 /* ZTE (Vodafone) K3806-Z */
686 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
687 | USB_DEVICE_ID_MATCH_PRODUCT
688 | USB_DEVICE_ID_MATCH_INT_INFO,
689 .idVendor = ZTE_VENDOR_ID,
690 .idProduct = 0x1015,
691 .bInterfaceClass = USB_CLASS_COMM,
692 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
693 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
694 .driver_info = (unsigned long)&wwan_info,
695}, {
696 /* ZTE (Vodafone) K4510-Z */
697 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
698 | USB_DEVICE_ID_MATCH_PRODUCT
699 | USB_DEVICE_ID_MATCH_INT_INFO,
700 .idVendor = ZTE_VENDOR_ID,
701 .idProduct = 0x1173,
702 .bInterfaceClass = USB_CLASS_COMM,
703 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
704 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
705 .driver_info = (unsigned long)&wwan_info,
706}, {
707 /* ZTE (Vodafone) K3770-Z */
708 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
709 | USB_DEVICE_ID_MATCH_PRODUCT
710 | USB_DEVICE_ID_MATCH_INT_INFO,
711 .idVendor = ZTE_VENDOR_ID,
712 .idProduct = 0x1177,
713 .bInterfaceClass = USB_CLASS_COMM,
714 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
715 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
716 .driver_info = (unsigned long)&wwan_info,
717}, {
718 /* ZTE (Vodafone) K3772-Z */
719 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
720 | USB_DEVICE_ID_MATCH_PRODUCT
721 | USB_DEVICE_ID_MATCH_INT_INFO,
722 .idVendor = ZTE_VENDOR_ID,
723 .idProduct = 0x1181,
724 .bInterfaceClass = USB_CLASS_COMM,
725 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
726 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
727 .driver_info = (unsigned long)&wwan_info,
728}, {
David Brownell4324fd42005-08-31 09:54:20 -0700729 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
730 USB_CDC_PROTO_NONE),
731 .driver_info = (unsigned long) &cdc_info,
Bjørn Morkcac477e2009-02-25 04:33:58 +0000732}, {
Jonas Sjöquist21851262010-04-23 01:07:45 +0000733 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
734 USB_CDC_PROTO_NONE),
Dan Williamsb3c914a2011-04-27 09:54:28 +0000735 .driver_info = (unsigned long)&wwan_info,
Jonas Sjöquist21851262010-04-23 01:07:45 +0000736
Dan Williamsb3c914a2011-04-27 09:54:28 +0000737}, {
738 /* Various Huawei modems with a network port like the UMG1831 */
739 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
740 | USB_DEVICE_ID_MATCH_INT_INFO,
741 .idVendor = HUAWEI_VENDOR_ID,
742 .bInterfaceClass = USB_CLASS_COMM,
743 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
744 .bInterfaceProtocol = 255,
745 .driver_info = (unsigned long)&wwan_info,
David Brownell4324fd42005-08-31 09:54:20 -0700746},
747 { }, // END
748};
749MODULE_DEVICE_TABLE(usb, products);
750
751static struct usb_driver cdc_driver = {
David Brownell4324fd42005-08-31 09:54:20 -0700752 .name = "cdc_ether",
753 .id_table = products,
754 .probe = usbnet_probe,
755 .disconnect = usbnet_disconnect,
756 .suspend = usbnet_suspend,
757 .resume = usbnet_resume,
Oliver Neukum7f515792009-12-03 11:41:07 +0000758 .reset_resume = usbnet_resume,
Oliver Neukum69ee472f2009-12-03 15:31:18 -0800759 .supports_autosuspend = 1,
Sarah Sharpe1f12eb2012-04-23 10:08:51 -0700760 .disable_hub_initiated_lpm = 1,
David Brownell4324fd42005-08-31 09:54:20 -0700761};
762
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800763module_usb_driver(cdc_driver);
David Brownell4324fd42005-08-31 09:54:20 -0700764
765MODULE_AUTHOR("David Brownell");
766MODULE_DESCRIPTION("USB CDC Ethernet devices");
767MODULE_LICENSE("GPL");