blob: 2a32d9167d3b931fb82c434bb0198e27bfc1d8ae [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
Fabio Porcedda8857ec22013-09-16 11:47:51 +020070/* probes control interface, claims data interface, collects the bulk
David Brownell4324fd42005-08-31 09:54:20 -070071 * endpoints, activates data interface (if needed), maybe sets MTU.
72 * all pure cdc, except for certain firmware workarounds, and knowing
73 * that rndis uses one different rule.
74 */
75int usbnet_generic_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
76{
77 u8 *buf = intf->cur_altsetting->extra;
78 int len = intf->cur_altsetting->extralen;
79 struct usb_interface_descriptor *d;
80 struct cdc_state *info = (void *) &dev->data;
81 int status;
82 int rndis;
Bjørn Mork6eddcb42012-04-26 02:35:10 +000083 bool android_rndis_quirk = false;
David Brownell4324fd42005-08-31 09:54:20 -070084 struct usb_driver *driver = driver_of(intf);
Jonas Sjöquist21851262010-04-23 01:07:45 +000085 struct usb_cdc_mdlm_desc *desc = NULL;
86 struct usb_cdc_mdlm_detail_desc *detail = NULL;
David Brownell4324fd42005-08-31 09:54:20 -070087
Fabio Porcedda8857ec22013-09-16 11:47:51 +020088 if (sizeof(dev->data) < sizeof(*info))
David Brownell4324fd42005-08-31 09:54:20 -070089 return -EDOM;
90
91 /* expect strict spec conformance for the descriptors, but
92 * cope with firmware which stores them in the wrong place
93 */
94 if (len == 0 && dev->udev->actconfig->extralen) {
95 /* Motorola SB4100 (and others: Brad Hards says it's
96 * from a Broadcom design) put CDC descriptors here
97 */
98 buf = dev->udev->actconfig->extra;
99 len = dev->udev->actconfig->extralen;
Dan Carpenterf5260f02010-12-25 12:23:42 +0000100 dev_dbg(&intf->dev, "CDC descriptors on config\n");
David Brownell4324fd42005-08-31 09:54:20 -0700101 }
102
David Brownell4149b722007-04-29 10:09:47 -0700103 /* Maybe CDC descriptors are after the endpoint? This bug has
104 * been seen on some 2Wire Inc RNDIS-ish products.
105 */
106 if (len == 0) {
107 struct usb_host_endpoint *hep;
108
109 hep = intf->cur_altsetting->endpoint;
110 if (hep) {
111 buf = hep->extra;
112 len = hep->extralen;
113 }
114 if (len)
115 dev_dbg(&intf->dev,
116 "CDC descriptors on endpoint\n");
117 }
118
David Brownell4324fd42005-08-31 09:54:20 -0700119 /* this assumes that if there's a non-RNDIS vendor variant
120 * of cdc-acm, it'll fail RNDIS requests cleanly.
121 */
Joe Perches8e95a202009-12-03 07:58:21 +0000122 rndis = (is_rndis(&intf->cur_altsetting->desc) ||
123 is_activesync(&intf->cur_altsetting->desc) ||
124 is_wireless_rndis(&intf->cur_altsetting->desc));
David Brownell4324fd42005-08-31 09:54:20 -0700125
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200126 memset(info, 0, sizeof(*info));
David Brownell4324fd42005-08-31 09:54:20 -0700127 info->control = intf;
128 while (len > 3) {
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200129 if (buf[1] != USB_DT_CS_INTERFACE)
David Brownell4324fd42005-08-31 09:54:20 -0700130 goto next_desc;
131
132 /* use bDescriptorSubType to identify the CDC descriptors.
133 * We expect devices with CDC header and union descriptors.
134 * For CDC Ethernet we need the ethernet descriptor.
135 * For RNDIS, ignore two (pointless) CDC modem descriptors
136 * in favor of a complicated OID-based RPC scheme doing what
137 * CDC Ethernet achieves with a simple descriptor.
138 */
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200139 switch (buf[2]) {
David Brownell4324fd42005-08-31 09:54:20 -0700140 case USB_CDC_HEADER_TYPE:
141 if (info->header) {
142 dev_dbg(&intf->dev, "extra CDC header\n");
143 goto bad_desc;
144 }
145 info->header = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200146 if (info->header->bLength != sizeof(*info->header)) {
David Brownell4324fd42005-08-31 09:54:20 -0700147 dev_dbg(&intf->dev, "CDC header len %u\n",
148 info->header->bLength);
149 goto bad_desc;
150 }
151 break;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800152 case USB_CDC_ACM_TYPE:
153 /* paranoia: disambiguate a "real" vendor-specific
154 * modem interface from an RNDIS non-modem.
155 */
156 if (rndis) {
David Brownellafaee822007-07-01 11:47:59 -0700157 struct usb_cdc_acm_descriptor *acm;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800158
David Brownellafaee822007-07-01 11:47:59 -0700159 acm = (void *) buf;
160 if (acm->bmCapabilities) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800161 dev_dbg(&intf->dev,
162 "ACM capabilities %02x, "
163 "not really RNDIS?\n",
David Brownellafaee822007-07-01 11:47:59 -0700164 acm->bmCapabilities);
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800165 goto bad_desc;
166 }
167 }
168 break;
David Brownell4324fd42005-08-31 09:54:20 -0700169 case USB_CDC_UNION_TYPE:
170 if (info->u) {
171 dev_dbg(&intf->dev, "extra CDC union\n");
172 goto bad_desc;
173 }
174 info->u = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200175 if (info->u->bLength != sizeof(*info->u)) {
David Brownell4324fd42005-08-31 09:54:20 -0700176 dev_dbg(&intf->dev, "CDC union len %u\n",
177 info->u->bLength);
178 goto bad_desc;
179 }
180
181 /* we need a master/control interface (what we're
182 * probed with) and a slave/data interface; union
183 * descriptors sort this all out.
184 */
185 info->control = usb_ifnum_to_if(dev->udev,
186 info->u->bMasterInterface0);
187 info->data = usb_ifnum_to_if(dev->udev,
188 info->u->bSlaveInterface0);
189 if (!info->control || !info->data) {
190 dev_dbg(&intf->dev,
191 "master #%u/%p slave #%u/%p\n",
192 info->u->bMasterInterface0,
193 info->control,
194 info->u->bSlaveInterface0,
195 info->data);
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000196 /* fall back to hard-wiring for RNDIS */
197 if (rndis) {
198 android_rndis_quirk = true;
199 goto next_desc;
200 }
David Brownell4324fd42005-08-31 09:54:20 -0700201 goto bad_desc;
202 }
203 if (info->control != intf) {
204 dev_dbg(&intf->dev, "bogus CDC Union\n");
205 /* Ambit USB Cable Modem (and maybe others)
206 * interchanges master and slave interface.
207 */
208 if (info->data == intf) {
209 info->data = info->control;
210 info->control = intf;
211 } else
212 goto bad_desc;
213 }
214
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200215 /* some devices merge these - skip class check */
216 if (info->control == info->data)
217 goto next_desc;
218
David Brownell4324fd42005-08-31 09:54:20 -0700219 /* a data interface altsetting does the real i/o */
220 d = &info->data->cur_altsetting->desc;
221 if (d->bInterfaceClass != USB_CLASS_CDC_DATA) {
222 dev_dbg(&intf->dev, "slave class %u\n",
223 d->bInterfaceClass);
224 goto bad_desc;
225 }
226 break;
227 case USB_CDC_ETHERNET_TYPE:
228 if (info->ether) {
229 dev_dbg(&intf->dev, "extra CDC ether\n");
230 goto bad_desc;
231 }
232 info->ether = (void *) buf;
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200233 if (info->ether->bLength != sizeof(*info->ether)) {
David Brownell4324fd42005-08-31 09:54:20 -0700234 dev_dbg(&intf->dev, "CDC ether len %u\n",
235 info->ether->bLength);
236 goto bad_desc;
237 }
238 dev->hard_mtu = le16_to_cpu(
239 info->ether->wMaxSegmentSize);
240 /* because of Zaurus, we may be ignoring the host
241 * side link address we were given.
242 */
243 break;
Jonas Sjöquist21851262010-04-23 01:07:45 +0000244 case USB_CDC_MDLM_TYPE:
245 if (desc) {
246 dev_dbg(&intf->dev, "extra MDLM descriptor\n");
247 goto bad_desc;
248 }
249
250 desc = (void *)buf;
251
252 if (desc->bLength != sizeof(*desc))
253 goto bad_desc;
254
255 if (memcmp(&desc->bGUID, mbm_guid, 16))
256 goto bad_desc;
257 break;
258 case USB_CDC_MDLM_DETAIL_TYPE:
259 if (detail) {
260 dev_dbg(&intf->dev, "extra MDLM detail descriptor\n");
261 goto bad_desc;
262 }
263
264 detail = (void *)buf;
265
266 if (detail->bGuidDescriptorType == 0) {
267 if (detail->bLength < (sizeof(*detail) + 1))
268 goto bad_desc;
269 } else
270 goto bad_desc;
271 break;
David Brownell4324fd42005-08-31 09:54:20 -0700272 }
273next_desc:
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200274 len -= buf[0]; /* bLength */
275 buf += buf[0];
David Brownell4324fd42005-08-31 09:54:20 -0700276 }
277
Bjorge Dijkstra786e3df2008-01-26 00:50:44 +0200278 /* Microsoft ActiveSync based and some regular RNDIS devices lack the
279 * CDC descriptors, so we'll hard-wire the interfaces and not check
280 * for descriptors.
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000281 *
282 * Some Android RNDIS devices have a CDC Union descriptor pointing
283 * to non-existing interfaces. Ignore that and attempt the same
284 * hard-wired 0 and 1 interfaces.
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800285 */
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000286 if (rndis && (!info->u || android_rndis_quirk)) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800287 info->control = usb_ifnum_to_if(dev->udev, 0);
288 info->data = usb_ifnum_to_if(dev->udev, 1);
Bjørn Mork6eddcb42012-04-26 02:35:10 +0000289 if (!info->control || !info->data || info->control != intf) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800290 dev_dbg(&intf->dev,
Bjorge Dijkstra786e3df2008-01-26 00:50:44 +0200291 "rndis: master #0/%p slave #1/%p\n",
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800292 info->control,
293 info->data);
294 goto bad_desc;
295 }
296
297 } else if (!info->header || !info->u || (!rndis && !info->ether)) {
David Brownell4324fd42005-08-31 09:54:20 -0700298 dev_dbg(&intf->dev, "missing cdc %s%s%sdescriptor\n",
299 info->header ? "" : "header ",
300 info->u ? "" : "union ",
301 info->ether ? "" : "ether ");
302 goto bad_desc;
303 }
304
305 /* claim data interface and set it up ... with side effects.
306 * network traffic can't flow until an altsetting is enabled.
307 */
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200308 if (info->data != info->control) {
309 status = usb_driver_claim_interface(driver, info->data, dev);
310 if (status < 0)
311 return status;
312 }
David Brownell4324fd42005-08-31 09:54:20 -0700313 status = usbnet_get_endpoints(dev, info->data);
314 if (status < 0) {
315 /* ensure immediate exit from usbnet_disconnect */
316 usb_set_intfdata(info->data, NULL);
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200317 if (info->data != info->control)
318 usb_driver_release_interface(driver, info->data);
David Brownell4324fd42005-08-31 09:54:20 -0700319 return status;
320 }
321
322 /* status endpoint: optional for CDC Ethernet, not RNDIS (or ACM) */
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200323 if (info->data != info->control)
324 dev->status = NULL;
David Brownell4324fd42005-08-31 09:54:20 -0700325 if (info->control->cur_altsetting->desc.bNumEndpoints == 1) {
326 struct usb_endpoint_descriptor *desc;
327
328 dev->status = &info->control->cur_altsetting->endpoint [0];
329 desc = &dev->status->desc;
Joe Perches8e95a202009-12-03 07:58:21 +0000330 if (!usb_endpoint_is_int_in(desc) ||
331 (le16_to_cpu(desc->wMaxPacketSize)
332 < sizeof(struct usb_cdc_notification)) ||
333 !desc->bInterval) {
David Brownell4324fd42005-08-31 09:54:20 -0700334 dev_dbg(&intf->dev, "bad notification endpoint\n");
335 dev->status = NULL;
336 }
337 }
338 if (rndis && !dev->status) {
339 dev_dbg(&intf->dev, "missing RNDIS status endpoint\n");
340 usb_set_intfdata(info->data, NULL);
341 usb_driver_release_interface(driver, info->data);
342 return -ENODEV;
343 }
Oliver Neukumc472ab62014-07-28 10:56:36 +0200344
345 /* Some devices don't initialise properly. In particular
346 * the packet filter is not reset. There are devices that
347 * don't do reset all the way. So the packet filter should
348 * be set to a sane initial value.
349 */
350 usb_control_msg(dev->udev,
351 usb_sndctrlpipe(dev->udev, 0),
352 USB_CDC_SET_ETHERNET_PACKET_FILTER,
353 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
354 USB_CDC_PACKET_TYPE_ALL_MULTICAST | USB_CDC_PACKET_TYPE_DIRECTED | USB_CDC_PACKET_TYPE_BROADCAST,
355 intf->cur_altsetting->desc.bInterfaceNumber,
356 NULL,
357 0,
358 USB_CTRL_SET_TIMEOUT
359 );
David Brownell4324fd42005-08-31 09:54:20 -0700360 return 0;
361
362bad_desc:
363 dev_info(&dev->udev->dev, "bad CDC descriptors\n");
364 return -ENODEV;
365}
366EXPORT_SYMBOL_GPL(usbnet_generic_cdc_bind);
367
368void usbnet_cdc_unbind(struct usbnet *dev, struct usb_interface *intf)
369{
370 struct cdc_state *info = (void *) &dev->data;
371 struct usb_driver *driver = driver_of(intf);
372
Bjørn Mork1fc4c842013-06-29 12:03:06 +0200373 /* combined interface - nothing to do */
374 if (info->data == info->control)
375 return;
376
David Brownell4324fd42005-08-31 09:54:20 -0700377 /* disconnect master --> disconnect slave */
378 if (intf == info->control && info->data) {
379 /* ensure immediate exit from usbnet_disconnect */
380 usb_set_intfdata(info->data, NULL);
381 usb_driver_release_interface(driver, info->data);
382 info->data = NULL;
383 }
384
385 /* and vice versa (just in case) */
386 else if (intf == info->data && info->control) {
387 /* ensure immediate exit from usbnet_disconnect */
388 usb_set_intfdata(info->control, NULL);
389 usb_driver_release_interface(driver, info->control);
390 info->control = NULL;
391 }
392}
393EXPORT_SYMBOL_GPL(usbnet_cdc_unbind);
394
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200395/* Communications Device Class, Ethernet Control model
David Brownell4324fd42005-08-31 09:54:20 -0700396 *
397 * Takes two interfaces. The DATA interface is inactive till an altsetting
398 * is selected. Configuration data includes class descriptors. There's
399 * an optional status endpoint on the control interface.
400 *
401 * This should interop with whatever the 2.4 "CDCEther.c" driver
402 * (by Brad Hards) talked with, with more functionality.
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200403 */
David Brownell4324fd42005-08-31 09:54:20 -0700404
405static void dumpspeed(struct usbnet *dev, __le32 *speeds)
406{
Joe Perchesa475f602010-02-17 10:30:24 +0000407 netif_info(dev, timer, dev->net,
408 "link speeds: %u kbps up, %u kbps down\n",
409 __le32_to_cpu(speeds[0]) / 1000,
410 __le32_to_cpu(speeds[1]) / 1000);
David Brownell4324fd42005-08-31 09:54:20 -0700411}
412
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000413void usbnet_cdc_status(struct usbnet *dev, struct urb *urb)
David Brownell4324fd42005-08-31 09:54:20 -0700414{
415 struct usb_cdc_notification *event;
416
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200417 if (urb->actual_length < sizeof(*event))
David Brownell4324fd42005-08-31 09:54:20 -0700418 return;
419
420 /* SPEED_CHANGE can get split into two 8-byte packets */
421 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
422 dumpspeed(dev, (__le32 *) urb->transfer_buffer);
423 return;
424 }
425
426 event = urb->transfer_buffer;
427 switch (event->bNotificationType) {
428 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
Joe Perchesa475f602010-02-17 10:30:24 +0000429 netif_dbg(dev, timer, dev->net, "CDC: carrier %s\n",
430 event->wValue ? "on" : "off");
Bjørn Morka6bda452013-04-16 22:12:13 +0000431 usbnet_link_change(dev, !!event->wValue, 0);
David Brownell4324fd42005-08-31 09:54:20 -0700432 break;
433 case USB_CDC_NOTIFY_SPEED_CHANGE: /* tx/rx rates */
Joe Perchesa475f602010-02-17 10:30:24 +0000434 netif_dbg(dev, timer, dev->net, "CDC: speed change (len %d)\n",
435 urb->actual_length);
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200436 if (urb->actual_length != (sizeof(*event) + 8))
David Brownell4324fd42005-08-31 09:54:20 -0700437 set_bit(EVENT_STS_SPLIT, &dev->flags);
438 else
439 dumpspeed(dev, (__le32 *) &event[1]);
440 break;
441 /* USB_CDC_NOTIFY_RESPONSE_AVAILABLE can happen too (e.g. RNDIS),
442 * but there are no standard formats for the response data.
443 */
444 default:
Joe Perches60b86752010-02-17 10:30:23 +0000445 netdev_err(dev->net, "CDC: unexpected notification %02x!\n",
446 event->bNotificationType);
David Brownell4324fd42005-08-31 09:54:20 -0700447 break;
448 }
449}
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000450EXPORT_SYMBOL_GPL(usbnet_cdc_status);
David Brownell4324fd42005-08-31 09:54:20 -0700451
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000452int usbnet_cdc_bind(struct usbnet *dev, struct usb_interface *intf)
David Brownell4324fd42005-08-31 09:54:20 -0700453{
454 int status;
455 struct cdc_state *info = (void *) &dev->data;
456
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800457 BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data)
458 < sizeof(struct cdc_state)));
459
David Brownell4324fd42005-08-31 09:54:20 -0700460 status = usbnet_generic_cdc_bind(dev, intf);
461 if (status < 0)
462 return status;
463
Peter Holik03ad0322009-04-18 07:24:17 +0000464 status = usbnet_get_ethernet_addr(dev, info->ether->iMACAddress);
David Brownell4324fd42005-08-31 09:54:20 -0700465 if (status < 0) {
466 usb_set_intfdata(info->data, NULL);
467 usb_driver_release_interface(driver_of(intf), info->data);
468 return status;
469 }
470
471 /* FIXME cdc-ether has some multicast code too, though it complains
472 * in routine cases. info->ether describes the multicast support.
473 * Implement that here, manipulating the cdc filter as needed.
474 */
475 return 0;
476}
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000477EXPORT_SYMBOL_GPL(usbnet_cdc_bind);
David Brownell4324fd42005-08-31 09:54:20 -0700478
479static const struct driver_info cdc_info = {
480 .description = "CDC Ethernet Device",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700481 .flags = FLAG_ETHER | FLAG_POINTTOPOINT,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000482 .bind = usbnet_cdc_bind,
David Brownell4324fd42005-08-31 09:54:20 -0700483 .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,
David Brownell4324fd42005-08-31 09:54:20 -0700486};
487
Dan Williamsb3c914a2011-04-27 09:54:28 +0000488static const struct driver_info wwan_info = {
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000489 .description = "Mobile Broadband Network Device",
490 .flags = FLAG_WWAN,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000491 .bind = usbnet_cdc_bind,
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000492 .unbind = usbnet_cdc_unbind,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000493 .status = usbnet_cdc_status,
Oliver Neukuma5e40702012-12-18 04:46:12 +0000494 .manage_power = usbnet_manage_power,
Marcel Holtmanne1e499e2009-10-02 05:15:25 +0000495};
496
David Brownell4324fd42005-08-31 09:54:20 -0700497/*-------------------------------------------------------------------------*/
498
Dan Williamsb3c914a2011-04-27 09:54:28 +0000499#define HUAWEI_VENDOR_ID 0x12D1
Dan Williams4e6304b2012-05-07 04:24:51 +0000500#define NOVATEL_VENDOR_ID 0x1410
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000501#define ZTE_VENDOR_ID 0x19D2
Dan Williams0370acd2012-12-17 08:17:41 +0000502#define DELL_VENDOR_ID 0x413C
hayeswangac718b62013-05-02 16:01:25 +0000503#define REALTEK_VENDOR_ID 0x0bda
hayeswang43779f82014-01-02 11:25:10 +0800504#define SAMSUNG_VENDOR_ID 0x04e8
David Brownell4324fd42005-08-31 09:54:20 -0700505
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200506static const struct usb_device_id products[] = {
507/* BLACKLIST !!
David Brownell4324fd42005-08-31 09:54:20 -0700508 *
509 * First blacklist any products that are egregiously nonconformant
510 * with the CDC Ethernet specs. Minor braindamage we cope with; when
511 * they're not even trying, needing a separate driver is only the first
512 * of the differences to show up.
513 */
514
515#define ZAURUS_MASTER_INTERFACE \
516 .bInterfaceClass = USB_CLASS_COMM, \
517 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
518 .bInterfaceProtocol = USB_CDC_PROTO_NONE
519
520/* SA-1100 based Sharp Zaurus ("collie"), or compatible;
521 * wire-incompatible with true CDC Ethernet implementations.
522 * (And, it seems, needlessly so...)
523 */
524{
525 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
526 | USB_DEVICE_ID_MATCH_DEVICE,
527 .idVendor = 0x04DD,
528 .idProduct = 0x8004,
529 ZAURUS_MASTER_INTERFACE,
530 .driver_info = 0,
531},
532
533/* PXA-25x based Sharp Zaurii. Note that it seems some of these
534 * (later models especially) may have shipped only with firmware
535 * advertising false "CDC MDLM" compatibility ... but we're not
536 * clear which models did that, so for now let's assume the worst.
537 */
538{
539 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
540 | USB_DEVICE_ID_MATCH_DEVICE,
541 .idVendor = 0x04DD,
542 .idProduct = 0x8005, /* A-300 */
543 ZAURUS_MASTER_INTERFACE,
544 .driver_info = 0,
545}, {
546 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
547 | USB_DEVICE_ID_MATCH_DEVICE,
548 .idVendor = 0x04DD,
549 .idProduct = 0x8006, /* B-500/SL-5600 */
550 ZAURUS_MASTER_INTERFACE,
551 .driver_info = 0,
552}, {
553 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200554 | USB_DEVICE_ID_MATCH_DEVICE,
David Brownell4324fd42005-08-31 09:54:20 -0700555 .idVendor = 0x04DD,
556 .idProduct = 0x8007, /* C-700 */
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 = 0x9031, /* C-750 C-760 */
564 ZAURUS_MASTER_INTERFACE,
565 .driver_info = 0,
566}, {
567 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
568 | USB_DEVICE_ID_MATCH_DEVICE,
569 .idVendor = 0x04DD,
570 .idProduct = 0x9032, /* SL-6000 */
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 /* reported with some C860 units */
578 .idProduct = 0x9050, /* C-860 */
579 ZAURUS_MASTER_INTERFACE,
580 .driver_info = 0,
581},
582
David Brownellefcaa202006-05-30 20:49:29 -0700583/* Olympus has some models with a Zaurus-compatible option.
584 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
585 */
586{
587 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
588 | USB_DEVICE_ID_MATCH_DEVICE,
589 .idVendor = 0x07B4,
590 .idProduct = 0x0F02, /* R-1000 */
591 ZAURUS_MASTER_INTERFACE,
592 .driver_info = 0,
593},
594
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000595/* LG Electronics VL600 wants additional headers on every frame */
596{
597 USB_DEVICE_AND_INTERFACE_INFO(0x1004, 0x61aa, USB_CLASS_COMM,
598 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Mark Kamichoff6d74eb92011-11-09 11:48:10 +0000599 .driver_info = 0,
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000600},
601
Scott Talbertee932bf2012-02-21 13:06:00 +0000602/* Logitech Harmony 900 - uses the pseudo-MDLM (BLAN) driver */
603{
604 USB_DEVICE_AND_INTERFACE_INFO(0x046d, 0xc11f, USB_CLASS_COMM,
605 USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
606 .driver_info = 0,
607},
608
Dan Williamsf8295ec2012-10-24 12:10:34 +0000609/* Novatel USB551L and MC551 - handled by qmi_wwan */
610{
Dan Williamsc39ba1c2012-12-17 08:19:46 +0000611 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0xB001, USB_CLASS_COMM,
612 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Dan Williamsf8295ec2012-10-24 12:10:34 +0000613 .driver_info = 0,
614},
615
616/* Novatel E362 - handled by qmi_wwan */
617{
Dan Williamsc39ba1c2012-12-17 08:19:46 +0000618 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9010, USB_CLASS_COMM,
619 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
Dan Williamsf8295ec2012-10-24 12:10:34 +0000620 .driver_info = 0,
621},
622
Dan Williams0370acd2012-12-17 08:17:41 +0000623/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
624{
625 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8195, USB_CLASS_COMM,
626 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
627 .driver_info = 0,
628},
629
630/* Dell Wireless 5800 (Novatel E362) - handled by qmi_wwan */
631{
632 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x8196, USB_CLASS_COMM,
633 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
634 .driver_info = 0,
635},
636
Dan Williams7fdb7842013-05-06 11:17:37 +0000637/* Dell Wireless 5804 (Novatel E371) - handled by qmi_wwan */
638{
639 USB_DEVICE_AND_INTERFACE_INFO(DELL_VENDOR_ID, 0x819b, USB_CLASS_COMM,
640 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
641 .driver_info = 0,
642},
643
Yegor Yefremov7b5939b2014-03-28 12:07:18 +0100644/* Novatel Expedite E371 - handled by qmi_wwan */
645{
646 USB_DEVICE_AND_INTERFACE_INFO(NOVATEL_VENDOR_ID, 0x9011, USB_CLASS_COMM,
647 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
648 .driver_info = 0,
649},
650
Dan Williams45d213f2013-02-18 17:25:09 +0000651/* AnyDATA ADU960S - handled by qmi_wwan */
652{
653 USB_DEVICE_AND_INTERFACE_INFO(0x16d5, 0x650a, USB_CLASS_COMM,
654 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
655 .driver_info = 0,
656},
657
Bjørn Morkc2020be2013-06-06 12:57:02 +0200658/* Huawei E1820 - handled by qmi_wwan */
659{
660 USB_DEVICE_INTERFACE_NUMBER(HUAWEI_VENDOR_ID, 0x14ac, 1),
661 .driver_info = 0,
662},
663
hayeswangac718b62013-05-02 16:01:25 +0000664/* Realtek RTL8152 Based USB 2.0 Ethernet Adapters */
hayeswangac718b62013-05-02 16:01:25 +0000665{
666 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8152, USB_CLASS_COMM,
667 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
668 .driver_info = 0,
669},
hayeswangc073f662013-07-08 10:41:21 +0800670
671/* Realtek RTL8153 Based USB 3.0 Ethernet Adapters */
672{
673 USB_DEVICE_AND_INTERFACE_INFO(REALTEK_VENDOR_ID, 0x8153, USB_CLASS_COMM,
674 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
675 .driver_info = 0,
676},
hayeswangac718b62013-05-02 16:01:25 +0000677
hayeswang10c32712014-03-04 20:47:48 +0800678/* Samsung USB Ethernet Adapters */
679{
680 USB_DEVICE_AND_INTERFACE_INFO(SAMSUNG_VENDOR_ID, 0xa101, USB_CLASS_COMM,
681 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
682 .driver_info = 0,
683},
684
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200685/* WHITELIST!!!
David Brownell4324fd42005-08-31 09:54:20 -0700686 *
687 * CDC Ether uses two interfaces, not necessarily consecutive.
688 * We match the main interface, ignoring the optional device
689 * class so we could handle devices that aren't exclusively
690 * CDC ether.
691 *
692 * NOTE: this match must come AFTER entries blacklisting devices
693 * because of bugs/quirks in a given product (like Zaurus, above).
694 */
695{
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000696 /* ZTE (Vodafone) K3805-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200697 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1003, USB_CLASS_COMM,
698 USB_CDC_SUBCLASS_ETHERNET,
699 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000700 .driver_info = (unsigned long)&wwan_info,
701}, {
702 /* ZTE (Vodafone) K3806-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200703 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1015, USB_CLASS_COMM,
704 USB_CDC_SUBCLASS_ETHERNET,
705 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000706 .driver_info = (unsigned long)&wwan_info,
707}, {
708 /* ZTE (Vodafone) K4510-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200709 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1173, USB_CLASS_COMM,
710 USB_CDC_SUBCLASS_ETHERNET,
711 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000712 .driver_info = (unsigned long)&wwan_info,
713}, {
714 /* ZTE (Vodafone) K3770-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200715 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1177, USB_CLASS_COMM,
716 USB_CDC_SUBCLASS_ETHERNET,
717 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000718 .driver_info = (unsigned long)&wwan_info,
719}, {
720 /* ZTE (Vodafone) K3772-Z */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200721 USB_DEVICE_AND_INTERFACE_INFO(ZTE_VENDOR_ID, 0x1181, USB_CLASS_COMM,
722 USB_CDC_SUBCLASS_ETHERNET,
723 USB_CDC_PROTO_NONE),
Andrew Bird (Sphere Systems)68d83182012-05-19 03:56:07 +0000724 .driver_info = (unsigned long)&wwan_info,
725}, {
Fabio Porcedda00928202013-09-16 11:47:50 +0200726 /* Telit modules */
727 USB_VENDOR_AND_INTERFACE_INFO(0x1bc7, USB_CLASS_COMM,
728 USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
729 .driver_info = (kernel_ulong_t) &wwan_info,
730}, {
David Brownell4324fd42005-08-31 09:54:20 -0700731 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ETHERNET,
732 USB_CDC_PROTO_NONE),
733 .driver_info = (unsigned long) &cdc_info,
Bjørn Morkcac477e2009-02-25 04:33:58 +0000734}, {
Jonas Sjöquist21851262010-04-23 01:07:45 +0000735 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
736 USB_CDC_PROTO_NONE),
Dan Williamsb3c914a2011-04-27 09:54:28 +0000737 .driver_info = (unsigned long)&wwan_info,
Jonas Sjöquist21851262010-04-23 01:07:45 +0000738
Dan Williamsb3c914a2011-04-27 09:54:28 +0000739}, {
740 /* Various Huawei modems with a network port like the UMG1831 */
Fabio Porceddad82a7f52013-09-16 11:47:52 +0200741 USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_COMM,
742 USB_CDC_SUBCLASS_ETHERNET, 255),
Dan Williamsb3c914a2011-04-27 09:54:28 +0000743 .driver_info = (unsigned long)&wwan_info,
David Brownell4324fd42005-08-31 09:54:20 -0700744},
Fabio Porcedda8857ec22013-09-16 11:47:51 +0200745 { }, /* END */
David Brownell4324fd42005-08-31 09:54:20 -0700746};
747MODULE_DEVICE_TABLE(usb, products);
748
749static struct usb_driver cdc_driver = {
David Brownell4324fd42005-08-31 09:54:20 -0700750 .name = "cdc_ether",
751 .id_table = products,
752 .probe = usbnet_probe,
753 .disconnect = usbnet_disconnect,
754 .suspend = usbnet_suspend,
755 .resume = usbnet_resume,
Oliver Neukum7f515792009-12-03 11:41:07 +0000756 .reset_resume = usbnet_resume,
Oliver Neukum69ee472f2009-12-03 15:31:18 -0800757 .supports_autosuspend = 1,
Sarah Sharpe1f12eb2012-04-23 10:08:51 -0700758 .disable_hub_initiated_lpm = 1,
David Brownell4324fd42005-08-31 09:54:20 -0700759};
760
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800761module_usb_driver(cdc_driver);
David Brownell4324fd42005-08-31 09:54:20 -0700762
763MODULE_AUTHOR("David Brownell");
764MODULE_DESCRIPTION("USB CDC Ethernet devices");
765MODULE_LICENSE("GPL");