2 * Copyright (c) 2012 Bjørn Mork <bjorn@mork.no>
4 * The probing code is heavily inspired by cdc_ether, which is:
5 * Copyright (C) 2003-2005 by David Brownell
6 * Copyright (C) 2006 by Ole Andre Vadla Ravnas (ActiveSync)
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/netdevice.h>
15 #include <linux/ethtool.h>
16 #include <linux/mii.h>
17 #include <linux/usb.h>
18 #include <linux/usb/cdc.h>
19 #include <linux/usb/usbnet.h>
20 #include <linux/usb/cdc-wdm.h>
22 /* This driver supports wwan (3G/LTE/?) devices using a vendor
23 * specific management protocol called Qualcomm MSM Interface (QMI) -
24 * in addition to the more common AT commands over serial interface
27 * QMI is wrapped in CDC, using CDC encapsulated commands on the
28 * control ("master") interface of a two-interface CDC Union
29 * resembling standard CDC ECM. The devices do not use the control
30 * interface for any other CDC messages. Most likely because the
31 * management protocol is used in place of the standard CDC
32 * notifications NOTIFY_NETWORK_CONNECTION and NOTIFY_SPEED_CHANGE
34 * Alternatively, control and data functions can be combined in a
35 * single USB interface.
37 * Handling a protocol like QMI is out of the scope for any driver.
38 * It is exported as a character device using the cdc-wdm driver as
39 * a subdriver, enabling userspace applications ("modem managers") to
42 * These devices may alternatively/additionally be configured using AT
43 * commands on a serial interface
46 /* driver specific data */
47 struct qmi_wwan_state {
48 struct usb_driver *subdriver;
51 struct usb_interface *control;
52 struct usb_interface *data;
55 /* using a counter to merge subdriver requests with our own into a combined state */
56 static int qmi_wwan_manage_power(struct usbnet *dev, int on)
58 struct qmi_wwan_state *info = (void *)&dev->data;
61 dev_dbg(&dev->intf->dev, "%s() pmcount=%d, on=%d\n", __func__, atomic_read(&info->pmcount), on);
63 if ((on && atomic_add_return(1, &info->pmcount) == 1) || (!on && atomic_dec_and_test(&info->pmcount))) {
64 /* need autopm_get/put here to ensure the usbcore sees the new value */
65 rv = usb_autopm_get_interface(dev->intf);
68 dev->intf->needs_remote_wakeup = on;
69 usb_autopm_put_interface(dev->intf);
75 static int qmi_wwan_cdc_wdm_manage_power(struct usb_interface *intf, int on)
77 struct usbnet *dev = usb_get_intfdata(intf);
79 /* can be called while disconnecting */
82 return qmi_wwan_manage_power(dev, on);
85 /* collect all three endpoints and register subdriver */
86 static int qmi_wwan_register_subdriver(struct usbnet *dev)
89 struct usb_driver *subdriver = NULL;
90 struct qmi_wwan_state *info = (void *)&dev->data;
92 /* collect bulk endpoints */
93 rv = usbnet_get_endpoints(dev, info->data);
97 /* update status endpoint if separate control interface */
98 if (info->control != info->data)
99 dev->status = &info->control->cur_altsetting->endpoint[0];
101 /* require interrupt endpoint for subdriver */
107 /* for subdriver power management */
108 atomic_set(&info->pmcount, 0);
110 /* register subdriver */
111 subdriver = usb_cdc_wdm_register(info->control, &dev->status->desc, 512, &qmi_wwan_cdc_wdm_manage_power);
112 if (IS_ERR(subdriver)) {
113 dev_err(&info->control->dev, "subdriver registration failed\n");
114 rv = PTR_ERR(subdriver);
118 /* prevent usbnet from using status endpoint */
121 /* save subdriver struct for suspend/resume wrappers */
122 info->subdriver = subdriver;
128 static int qmi_wwan_bind(struct usbnet *dev, struct usb_interface *intf)
131 u8 *buf = intf->cur_altsetting->extra;
132 int len = intf->cur_altsetting->extralen;
133 struct usb_interface_descriptor *desc = &intf->cur_altsetting->desc;
134 struct usb_cdc_union_desc *cdc_union = NULL;
135 struct usb_cdc_ether_desc *cdc_ether = NULL;
137 struct usb_driver *driver = driver_of(intf);
138 struct qmi_wwan_state *info = (void *)&dev->data;
140 BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data) < sizeof(struct qmi_wwan_state)));
142 /* require a single interrupt status endpoint for subdriver */
143 if (intf->cur_altsetting->desc.bNumEndpoints != 1)
147 struct usb_descriptor_header *h = (void *)buf;
149 /* ignore any misplaced descriptors */
150 if (h->bDescriptorType != USB_DT_CS_INTERFACE)
153 /* buf[2] is CDC descriptor subtype */
155 case USB_CDC_HEADER_TYPE:
156 if (found & 1 << USB_CDC_HEADER_TYPE) {
157 dev_dbg(&intf->dev, "extra CDC header\n");
160 if (h->bLength != sizeof(struct usb_cdc_header_desc)) {
161 dev_dbg(&intf->dev, "CDC header len %u\n", h->bLength);
165 case USB_CDC_UNION_TYPE:
166 if (found & 1 << USB_CDC_UNION_TYPE) {
167 dev_dbg(&intf->dev, "extra CDC union\n");
170 if (h->bLength != sizeof(struct usb_cdc_union_desc)) {
171 dev_dbg(&intf->dev, "CDC union len %u\n", h->bLength);
174 cdc_union = (struct usb_cdc_union_desc *)buf;
176 case USB_CDC_ETHERNET_TYPE:
177 if (found & 1 << USB_CDC_ETHERNET_TYPE) {
178 dev_dbg(&intf->dev, "extra CDC ether\n");
181 if (h->bLength != sizeof(struct usb_cdc_ether_desc)) {
182 dev_dbg(&intf->dev, "CDC ether len %u\n", h->bLength);
185 cdc_ether = (struct usb_cdc_ether_desc *)buf;
190 * Remember which CDC functional descriptors we've seen. Works
191 * for all types we care about, of which USB_CDC_ETHERNET_TYPE
192 * (0x0f) is the highest numbered
195 found |= 1 << buf[2];
202 /* did we find all the required ones? */
203 if (!(found & (1 << USB_CDC_HEADER_TYPE)) ||
204 !(found & (1 << USB_CDC_UNION_TYPE))) {
205 dev_err(&intf->dev, "CDC functional descriptors missing\n");
209 /* verify CDC Union */
210 if (desc->bInterfaceNumber != cdc_union->bMasterInterface0) {
211 dev_err(&intf->dev, "bogus CDC Union: master=%u\n", cdc_union->bMasterInterface0);
215 /* need to save these for unbind */
216 info->control = intf;
217 info->data = usb_ifnum_to_if(dev->udev, cdc_union->bSlaveInterface0);
219 dev_err(&intf->dev, "bogus CDC Union: slave=%u\n", cdc_union->bSlaveInterface0);
223 /* errors aren't fatal - we can live with the dynamic address */
225 dev->hard_mtu = le16_to_cpu(cdc_ether->wMaxSegmentSize);
226 usbnet_get_ethernet_addr(dev, cdc_ether->iMACAddress);
229 /* claim data interface and set it up */
230 status = usb_driver_claim_interface(driver, info->data, dev);
234 status = qmi_wwan_register_subdriver(dev);
236 usb_set_intfdata(info->data, NULL);
237 usb_driver_release_interface(driver, info->data);
244 /* Some devices combine the "control" and "data" functions into a
245 * single interface with all three endpoints: interrupt + bulk in and
248 static int qmi_wwan_bind_shared(struct usbnet *dev, struct usb_interface *intf)
250 struct qmi_wwan_state *info = (void *)&dev->data;
252 /* control and data is shared */
253 info->control = intf;
255 return qmi_wwan_register_subdriver(dev);
258 static void qmi_wwan_unbind(struct usbnet *dev, struct usb_interface *intf)
260 struct qmi_wwan_state *info = (void *)&dev->data;
261 struct usb_driver *driver = driver_of(intf);
262 struct usb_interface *other;
264 if (info->subdriver && info->subdriver->disconnect)
265 info->subdriver->disconnect(info->control);
267 /* allow user to unbind using either control or data */
268 if (intf == info->control)
271 other = info->control;
273 /* only if not shared */
274 if (other && intf != other) {
275 usb_set_intfdata(other, NULL);
276 usb_driver_release_interface(driver, other);
279 info->subdriver = NULL;
281 info->control = NULL;
284 /* suspend/resume wrappers calling both usbnet and the cdc-wdm
285 * subdriver if present.
287 * NOTE: cdc-wdm also supports pre/post_reset, but we cannot provide
288 * wrappers for those without adding usbnet reset support first.
290 static int qmi_wwan_suspend(struct usb_interface *intf, pm_message_t message)
292 struct usbnet *dev = usb_get_intfdata(intf);
293 struct qmi_wwan_state *info = (void *)&dev->data;
296 ret = usbnet_suspend(intf, message);
300 if (intf == info->control && info->subdriver && info->subdriver->suspend)
301 ret = info->subdriver->suspend(intf, message);
308 static int qmi_wwan_resume(struct usb_interface *intf)
310 struct usbnet *dev = usb_get_intfdata(intf);
311 struct qmi_wwan_state *info = (void *)&dev->data;
313 bool callsub = (intf == info->control && info->subdriver && info->subdriver->resume);
316 ret = info->subdriver->resume(intf);
319 ret = usbnet_resume(intf);
320 if (ret < 0 && callsub && info->subdriver->suspend)
321 info->subdriver->suspend(intf, PMSG_SUSPEND);
326 static const struct driver_info qmi_wwan_info = {
327 .description = "WWAN/QMI device",
329 .bind = qmi_wwan_bind,
330 .unbind = qmi_wwan_unbind,
331 .manage_power = qmi_wwan_manage_power,
334 static const struct driver_info qmi_wwan_shared = {
335 .description = "WWAN/QMI device",
337 .bind = qmi_wwan_bind_shared,
338 .unbind = qmi_wwan_unbind,
339 .manage_power = qmi_wwan_manage_power,
342 #define HUAWEI_VENDOR_ID 0x12D1
344 /* map QMI/wwan function by a fixed interface number */
345 #define QMI_FIXED_INTF(vend, prod, num) \
346 USB_DEVICE_INTERFACE_NUMBER(vend, prod, num), \
347 .driver_info = (unsigned long)&qmi_wwan_shared
349 /* Gobi 1000 QMI/wwan interface number is 3 according to qcserial */
350 #define QMI_GOBI1K_DEVICE(vend, prod) \
351 QMI_FIXED_INTF(vend, prod, 3)
353 /* Gobi 2000/3000 QMI/wwan interface number is 0 according to qcserial */
354 #define QMI_GOBI_DEVICE(vend, prod) \
355 QMI_FIXED_INTF(vend, prod, 0)
357 static const struct usb_device_id products[] = {
358 /* 1. CDC ECM like devices match on the control interface */
359 { /* Huawei E392, E398 and possibly others sharing both device id and more... */
360 USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_VENDOR_SPEC, 1, 9),
361 .driver_info = (unsigned long)&qmi_wwan_info,
363 { /* Vodafone/Huawei K5005 (12d1:14c8) and similar modems */
364 USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_VENDOR_SPEC, 1, 57),
365 .driver_info = (unsigned long)&qmi_wwan_info,
368 /* 2. Combined interface devices matching on class+protocol */
369 { /* Huawei E392, E398 and possibly others in "Windows mode" */
370 USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_VENDOR_SPEC, 1, 17),
371 .driver_info = (unsigned long)&qmi_wwan_shared,
373 { /* Pantech UML290 */
374 USB_DEVICE_AND_INTERFACE_INFO(0x106c, 0x3718, USB_CLASS_VENDOR_SPEC, 0xf0, 0xff),
375 .driver_info = (unsigned long)&qmi_wwan_shared,
377 { /* Pantech UML290 - newer firmware */
378 USB_DEVICE_AND_INTERFACE_INFO(0x106c, 0x3718, USB_CLASS_VENDOR_SPEC, 0xf1, 0xff),
379 .driver_info = (unsigned long)&qmi_wwan_shared,
382 /* 3. Combined interface devices matching on interface number */
383 {QMI_FIXED_INTF(0x19d2, 0x0055, 1)}, /* ZTE (Vodafone) K3520-Z */
384 {QMI_FIXED_INTF(0x19d2, 0x0063, 4)}, /* ZTE (Vodafone) K3565-Z */
385 {QMI_FIXED_INTF(0x19d2, 0x0104, 4)}, /* ZTE (Vodafone) K4505-Z */
386 {QMI_FIXED_INTF(0x19d2, 0x0167, 4)}, /* ZTE MF820D */
387 {QMI_FIXED_INTF(0x19d2, 0x0326, 4)}, /* ZTE MF821D */
388 {QMI_FIXED_INTF(0x19d2, 0x1008, 4)}, /* ZTE (Vodafone) K3570-Z */
389 {QMI_FIXED_INTF(0x19d2, 0x1010, 4)}, /* ZTE (Vodafone) K3571-Z */
390 {QMI_FIXED_INTF(0x19d2, 0x1018, 3)}, /* ZTE (Vodafone) K5006-Z */
391 {QMI_FIXED_INTF(0x19d2, 0x1402, 2)}, /* ZTE MF60 */
392 {QMI_FIXED_INTF(0x19d2, 0x2002, 4)}, /* ZTE (Vodafone) K3765-Z */
393 {QMI_FIXED_INTF(0x0f3d, 0x68a2, 8)}, /* Sierra Wireless MC7700 */
394 {QMI_FIXED_INTF(0x114f, 0x68a2, 8)}, /* Sierra Wireless MC7750 */
395 {QMI_FIXED_INTF(0x1199, 0x68a2, 8)}, /* Sierra Wireless MC7710 in QMI mode */
396 {QMI_FIXED_INTF(0x1199, 0x68a2, 19)}, /* Sierra Wireless MC7710 in QMI mode */
397 {QMI_FIXED_INTF(0x1199, 0x901c, 8)}, /* Sierra Wireless EM7700 */
399 /* 4. Gobi 1000 devices */
400 {QMI_GOBI1K_DEVICE(0x05c6, 0x9212)}, /* Acer Gobi Modem Device */
401 {QMI_GOBI1K_DEVICE(0x03f0, 0x1f1d)}, /* HP un2400 Gobi Modem Device */
402 {QMI_GOBI1K_DEVICE(0x04da, 0x250d)}, /* Panasonic Gobi Modem device */
403 {QMI_GOBI1K_DEVICE(0x413c, 0x8172)}, /* Dell Gobi Modem device */
404 {QMI_GOBI1K_DEVICE(0x1410, 0xa001)}, /* Novatel Gobi Modem device */
405 {QMI_GOBI1K_DEVICE(0x0b05, 0x1776)}, /* Asus Gobi Modem device */
406 {QMI_GOBI1K_DEVICE(0x19d2, 0xfff3)}, /* ONDA Gobi Modem device */
407 {QMI_GOBI1K_DEVICE(0x05c6, 0x9001)}, /* Generic Gobi Modem device */
408 {QMI_GOBI1K_DEVICE(0x05c6, 0x9002)}, /* Generic Gobi Modem device */
409 {QMI_GOBI1K_DEVICE(0x05c6, 0x9202)}, /* Generic Gobi Modem device */
410 {QMI_GOBI1K_DEVICE(0x05c6, 0x9203)}, /* Generic Gobi Modem device */
411 {QMI_GOBI1K_DEVICE(0x05c6, 0x9222)}, /* Generic Gobi Modem device */
412 {QMI_GOBI1K_DEVICE(0x05c6, 0x9009)}, /* Generic Gobi Modem device */
414 /* 5. Gobi 2000 and 3000 devices */
415 {QMI_GOBI_DEVICE(0x413c, 0x8186)}, /* Dell Gobi 2000 Modem device (N0218, VU936) */
416 {QMI_GOBI_DEVICE(0x413c, 0x8194)}, /* Dell Gobi 3000 Composite */
417 {QMI_GOBI_DEVICE(0x05c6, 0x920b)}, /* Generic Gobi 2000 Modem device */
418 {QMI_GOBI_DEVICE(0x05c6, 0x920d)}, /* Gobi 3000 Composite */
419 {QMI_GOBI_DEVICE(0x05c6, 0x9225)}, /* Sony Gobi 2000 Modem device (N0279, VU730) */
420 {QMI_GOBI_DEVICE(0x05c6, 0x9245)}, /* Samsung Gobi 2000 Modem device (VL176) */
421 {QMI_GOBI_DEVICE(0x03f0, 0x251d)}, /* HP Gobi 2000 Modem device (VP412) */
422 {QMI_GOBI_DEVICE(0x05c6, 0x9215)}, /* Acer Gobi 2000 Modem device (VP413) */
423 {QMI_GOBI_DEVICE(0x05c6, 0x9265)}, /* Asus Gobi 2000 Modem device (VR305) */
424 {QMI_GOBI_DEVICE(0x05c6, 0x9235)}, /* Top Global Gobi 2000 Modem device (VR306) */
425 {QMI_GOBI_DEVICE(0x05c6, 0x9275)}, /* iRex Technologies Gobi 2000 Modem device (VR307) */
426 {QMI_GOBI_DEVICE(0x1199, 0x68a5)}, /* Sierra Wireless Modem */
427 {QMI_GOBI_DEVICE(0x1199, 0x68a9)}, /* Sierra Wireless Modem */
428 {QMI_GOBI_DEVICE(0x1199, 0x9001)}, /* Sierra Wireless Gobi 2000 Modem device (VT773) */
429 {QMI_GOBI_DEVICE(0x1199, 0x9002)}, /* Sierra Wireless Gobi 2000 Modem device (VT773) */
430 {QMI_GOBI_DEVICE(0x1199, 0x9003)}, /* Sierra Wireless Gobi 2000 Modem device (VT773) */
431 {QMI_GOBI_DEVICE(0x1199, 0x9004)}, /* Sierra Wireless Gobi 2000 Modem device (VT773) */
432 {QMI_GOBI_DEVICE(0x1199, 0x9005)}, /* Sierra Wireless Gobi 2000 Modem device (VT773) */
433 {QMI_GOBI_DEVICE(0x1199, 0x9006)}, /* Sierra Wireless Gobi 2000 Modem device (VT773) */
434 {QMI_GOBI_DEVICE(0x1199, 0x9007)}, /* Sierra Wireless Gobi 2000 Modem device (VT773) */
435 {QMI_GOBI_DEVICE(0x1199, 0x9008)}, /* Sierra Wireless Gobi 2000 Modem device (VT773) */
436 {QMI_GOBI_DEVICE(0x1199, 0x9009)}, /* Sierra Wireless Gobi 2000 Modem device (VT773) */
437 {QMI_GOBI_DEVICE(0x1199, 0x900a)}, /* Sierra Wireless Gobi 2000 Modem device (VT773) */
438 {QMI_GOBI_DEVICE(0x1199, 0x9011)}, /* Sierra Wireless Gobi 2000 Modem device (MC8305) */
439 {QMI_FIXED_INTF(0x1199, 0x9011, 5)}, /* alternate interface number!? */
440 {QMI_GOBI_DEVICE(0x16d8, 0x8002)}, /* CMDTech Gobi 2000 Modem device (VU922) */
441 {QMI_GOBI_DEVICE(0x05c6, 0x9205)}, /* Gobi 2000 Modem device */
442 {QMI_GOBI_DEVICE(0x1199, 0x9013)}, /* Sierra Wireless Gobi 3000 Modem device (MC8355) */
443 {QMI_GOBI_DEVICE(0x03f0, 0x371d)}, /* HP un2430 Mobile Broadband Module */
444 {QMI_GOBI_DEVICE(0x1199, 0x9015)}, /* Sierra Wireless Gobi 3000 Modem device */
445 {QMI_GOBI_DEVICE(0x1199, 0x9019)}, /* Sierra Wireless Gobi 3000 Modem device */
446 {QMI_GOBI_DEVICE(0x1199, 0x901b)}, /* Sierra Wireless MC7770 */
447 {QMI_GOBI_DEVICE(0x12d1, 0x14f1)}, /* Sony Gobi 3000 Composite */
448 {QMI_GOBI_DEVICE(0x1410, 0xa021)}, /* Foxconn Gobi 3000 Modem device (Novatel E396) */
452 MODULE_DEVICE_TABLE(usb, products);
454 static int qmi_wwan_probe(struct usb_interface *intf, const struct usb_device_id *prod)
456 struct usb_device_id *id = (struct usb_device_id *)prod;
458 /* Workaround to enable dynamic IDs. This disables usbnet
459 * blacklisting functionality. Which, if required, can be
460 * reimplemented here by using a magic "blacklist" value
461 * instead of 0 in the static device id table
463 if (!id->driver_info) {
464 dev_dbg(&intf->dev, "setting defaults for dynamic device id\n");
465 id->driver_info = (unsigned long)&qmi_wwan_shared;
468 return usbnet_probe(intf, id);
471 static struct usb_driver qmi_wwan_driver = {
473 .id_table = products,
474 .probe = qmi_wwan_probe,
475 .disconnect = usbnet_disconnect,
476 .suspend = qmi_wwan_suspend,
477 .resume = qmi_wwan_resume,
478 .reset_resume = qmi_wwan_resume,
479 .supports_autosuspend = 1,
480 .disable_hub_initiated_lpm = 1,
483 module_usb_driver(qmi_wwan_driver);
485 MODULE_AUTHOR("Bjørn Mork <bjorn@mork.no>");
486 MODULE_DESCRIPTION("Qualcomm MSM Interface (QMI) WWAN driver");
487 MODULE_LICENSE("GPL");