UPSTREAM: net: qmi_wwan: compress device_id list using macros
[cascardo/linux.git] / drivers / net / usb / qmi_wwan.c
1 /*
2  * Copyright (c) 2012  Bjørn Mork <bjorn@mork.no>
3  *
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)
7  *
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.
11  */
12
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>
21
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
25  * management
26  *
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
33  *
34  * Alternatively, control and data functions can be combined in a
35  * single USB interface.
36  *
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
40  * handle it.
41  *
42  * These devices may alternatively/additionally be configured using AT
43  * commands on a serial interface
44  */
45
46 /* driver specific data */
47 struct qmi_wwan_state {
48         struct usb_driver *subdriver;
49         atomic_t pmcount;
50         unsigned long unused;
51         struct usb_interface *control;
52         struct usb_interface *data;
53 };
54
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)
57 {
58         struct qmi_wwan_state *info = (void *)&dev->data;
59         int rv = 0;
60
61         dev_dbg(&dev->intf->dev, "%s() pmcount=%d, on=%d\n", __func__, atomic_read(&info->pmcount), on);
62
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);
66                 if (rv < 0)
67                         goto err;
68                 dev->intf->needs_remote_wakeup = on;
69                 usb_autopm_put_interface(dev->intf);
70         }
71 err:
72         return rv;
73 }
74
75 static int qmi_wwan_cdc_wdm_manage_power(struct usb_interface *intf, int on)
76 {
77         struct usbnet *dev = usb_get_intfdata(intf);
78
79         /* can be called while disconnecting */
80         if (!dev)
81                 return 0;
82         return qmi_wwan_manage_power(dev, on);
83 }
84
85 /* collect all three endpoints and register subdriver */
86 static int qmi_wwan_register_subdriver(struct usbnet *dev)
87 {
88         int rv;
89         struct usb_driver *subdriver = NULL;
90         struct qmi_wwan_state *info = (void *)&dev->data;
91
92         /* collect bulk endpoints */
93         rv = usbnet_get_endpoints(dev, info->data);
94         if (rv < 0)
95                 goto err;
96
97         /* update status endpoint if separate control interface */
98         if (info->control != info->data)
99                 dev->status = &info->control->cur_altsetting->endpoint[0];
100
101         /* require interrupt endpoint for subdriver */
102         if (!dev->status) {
103                 rv = -EINVAL;
104                 goto err;
105         }
106
107         /* for subdriver power management */
108         atomic_set(&info->pmcount, 0);
109
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);
115                 goto err;
116         }
117
118         /* prevent usbnet from using status endpoint */
119         dev->status = NULL;
120
121         /* save subdriver struct for suspend/resume wrappers */
122         info->subdriver = subdriver;
123
124 err:
125         return rv;
126 }
127
128 static int qmi_wwan_bind(struct usbnet *dev, struct usb_interface *intf)
129 {
130         int status = -1;
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;
136         u32 found = 0;
137         struct usb_driver *driver = driver_of(intf);
138         struct qmi_wwan_state *info = (void *)&dev->data;
139
140         BUILD_BUG_ON((sizeof(((struct usbnet *)0)->data) < sizeof(struct qmi_wwan_state)));
141
142         /* require a single interrupt status endpoint for subdriver */
143         if (intf->cur_altsetting->desc.bNumEndpoints != 1)
144                 goto err;
145
146         while (len > 3) {
147                 struct usb_descriptor_header *h = (void *)buf;
148
149                 /* ignore any misplaced descriptors */
150                 if (h->bDescriptorType != USB_DT_CS_INTERFACE)
151                         goto next_desc;
152
153                 /* buf[2] is CDC descriptor subtype */
154                 switch (buf[2]) {
155                 case USB_CDC_HEADER_TYPE:
156                         if (found & 1 << USB_CDC_HEADER_TYPE) {
157                                 dev_dbg(&intf->dev, "extra CDC header\n");
158                                 goto err;
159                         }
160                         if (h->bLength != sizeof(struct usb_cdc_header_desc)) {
161                                 dev_dbg(&intf->dev, "CDC header len %u\n", h->bLength);
162                                 goto err;
163                         }
164                         break;
165                 case USB_CDC_UNION_TYPE:
166                         if (found & 1 << USB_CDC_UNION_TYPE) {
167                                 dev_dbg(&intf->dev, "extra CDC union\n");
168                                 goto err;
169                         }
170                         if (h->bLength != sizeof(struct usb_cdc_union_desc)) {
171                                 dev_dbg(&intf->dev, "CDC union len %u\n", h->bLength);
172                                 goto err;
173                         }
174                         cdc_union = (struct usb_cdc_union_desc *)buf;
175                         break;
176                 case USB_CDC_ETHERNET_TYPE:
177                         if (found & 1 << USB_CDC_ETHERNET_TYPE) {
178                                 dev_dbg(&intf->dev, "extra CDC ether\n");
179                                 goto err;
180                         }
181                         if (h->bLength != sizeof(struct usb_cdc_ether_desc)) {
182                                 dev_dbg(&intf->dev, "CDC ether len %u\n",  h->bLength);
183                                 goto err;
184                         }
185                         cdc_ether = (struct usb_cdc_ether_desc *)buf;
186                         break;
187                 }
188
189                 /*
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
193                  */
194                 if (buf[2] < 32)
195                         found |= 1 << buf[2];
196
197 next_desc:
198                 len -= h->bLength;
199                 buf += h->bLength;
200         }
201
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");
206                 goto err;
207         }
208
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);
212                 goto err;
213         }
214
215         /* need to save these for unbind */
216         info->control = intf;
217         info->data = usb_ifnum_to_if(dev->udev, cdc_union->bSlaveInterface0);
218         if (!info->data) {
219                 dev_err(&intf->dev, "bogus CDC Union: slave=%u\n", cdc_union->bSlaveInterface0);
220                 goto err;
221         }
222
223         /* errors aren't fatal - we can live with the dynamic address */
224         if (cdc_ether) {
225                 dev->hard_mtu = le16_to_cpu(cdc_ether->wMaxSegmentSize);
226                 usbnet_get_ethernet_addr(dev, cdc_ether->iMACAddress);
227         }
228
229         /* claim data interface and set it up */
230         status = usb_driver_claim_interface(driver, info->data, dev);
231         if (status < 0)
232                 goto err;
233
234         status = qmi_wwan_register_subdriver(dev);
235         if (status < 0) {
236                 usb_set_intfdata(info->data, NULL);
237                 usb_driver_release_interface(driver, info->data);
238         }
239
240 err:
241         return status;
242 }
243
244 /* Some devices combine the "control" and "data" functions into a
245  * single interface with all three endpoints: interrupt + bulk in and
246  * out
247  */
248 static int qmi_wwan_bind_shared(struct usbnet *dev, struct usb_interface *intf)
249 {
250         struct qmi_wwan_state *info = (void *)&dev->data;
251
252         /*  control and data is shared */
253         info->control = intf;
254         info->data = intf;
255         return qmi_wwan_register_subdriver(dev);
256 }
257
258 static void qmi_wwan_unbind(struct usbnet *dev, struct usb_interface *intf)
259 {
260         struct qmi_wwan_state *info = (void *)&dev->data;
261         struct usb_driver *driver = driver_of(intf);
262         struct usb_interface *other;
263
264         if (info->subdriver && info->subdriver->disconnect)
265                 info->subdriver->disconnect(info->control);
266
267         /* allow user to unbind using either control or data */
268         if (intf == info->control)
269                 other = info->data;
270         else
271                 other = info->control;
272
273         /* only if not shared */
274         if (other && intf != other) {
275                 usb_set_intfdata(other, NULL);
276                 usb_driver_release_interface(driver, other);
277         }
278
279         info->subdriver = NULL;
280         info->data = NULL;
281         info->control = NULL;
282 }
283
284 /* suspend/resume wrappers calling both usbnet and the cdc-wdm
285  * subdriver if present.
286  *
287  * NOTE: cdc-wdm also supports pre/post_reset, but we cannot provide
288  * wrappers for those without adding usbnet reset support first.
289  */
290 static int qmi_wwan_suspend(struct usb_interface *intf, pm_message_t message)
291 {
292         struct usbnet *dev = usb_get_intfdata(intf);
293         struct qmi_wwan_state *info = (void *)&dev->data;
294         int ret;
295
296         ret = usbnet_suspend(intf, message);
297         if (ret < 0)
298                 goto err;
299
300         if (info->subdriver && info->subdriver->suspend)
301                 ret = info->subdriver->suspend(intf, message);
302         if (ret < 0)
303                 usbnet_resume(intf);
304 err:
305         return ret;
306 }
307
308 static int qmi_wwan_resume(struct usb_interface *intf)
309 {
310         struct usbnet *dev = usb_get_intfdata(intf);
311         struct qmi_wwan_state *info = (void *)&dev->data;
312         int ret = 0;
313
314         if (info->subdriver && info->subdriver->resume)
315                 ret = info->subdriver->resume(intf);
316         if (ret < 0)
317                 goto err;
318         ret = usbnet_resume(intf);
319         if (ret < 0 && info->subdriver && info->subdriver->resume && info->subdriver->suspend)
320                 info->subdriver->suspend(intf, PMSG_SUSPEND);
321 err:
322         return ret;
323 }
324
325 static const struct driver_info qmi_wwan_info = {
326         .description    = "WWAN/QMI device",
327         .flags          = FLAG_WWAN,
328         .bind           = qmi_wwan_bind,
329         .unbind         = qmi_wwan_unbind,
330         .manage_power   = qmi_wwan_manage_power,
331 };
332
333 static const struct driver_info qmi_wwan_shared = {
334         .description    = "WWAN/QMI device",
335         .flags          = FLAG_WWAN,
336         .bind           = qmi_wwan_bind_shared,
337         .unbind         = qmi_wwan_unbind,
338         .manage_power   = qmi_wwan_manage_power,
339 };
340
341 #define HUAWEI_VENDOR_ID        0x12D1
342
343 /* map QMI/wwan function by a fixed interface number */
344 #define QMI_FIXED_INTF(vend, prod, num) \
345         USB_DEVICE_INTERFACE_NUMBER(vend, prod, num), \
346         .driver_info = (unsigned long)&qmi_wwan_shared
347
348 /* Gobi 1000 QMI/wwan interface number is 3 according to qcserial */
349 #define QMI_GOBI1K_DEVICE(vend, prod) \
350         QMI_FIXED_INTF(vend, prod, 3)
351
352 /* Gobi 2000/3000 QMI/wwan interface number is 0 according to qcserial */
353 #define QMI_GOBI_DEVICE(vend, prod) \
354         QMI_FIXED_INTF(vend, prod, 0)
355
356 static const struct usb_device_id products[] = {
357         /* 1. CDC ECM like devices match on the control interface */
358         {       /* Huawei E392, E398 and possibly others sharing both device id and more... */
359                 USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_VENDOR_SPEC, 1, 9),
360                 .driver_info        = (unsigned long)&qmi_wwan_info,
361         },
362         {       /* Vodafone/Huawei K5005 (12d1:14c8) and similar modems */
363                 USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_VENDOR_SPEC, 1, 57),
364                 .driver_info        = (unsigned long)&qmi_wwan_info,
365         },
366
367         /* 2. Combined interface devices matching on class+protocol */
368         {       /* Huawei E392, E398 and possibly others in "Windows mode" */
369                 USB_VENDOR_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, USB_CLASS_VENDOR_SPEC, 1, 17),
370                 .driver_info        = (unsigned long)&qmi_wwan_shared,
371         },
372         {       /* Pantech UML290 */
373                 USB_DEVICE_AND_INTERFACE_INFO(0x106c, 0x3718, USB_CLASS_VENDOR_SPEC, 0xf0, 0xff),
374                 .driver_info        = (unsigned long)&qmi_wwan_shared,
375         },
376
377         /* 3. Combined interface devices matching on interface number */
378         {QMI_FIXED_INTF(0x19d2, 0x0055, 1)},    /* ZTE (Vodafone) K3520-Z */
379         {QMI_FIXED_INTF(0x19d2, 0x0063, 4)},    /* ZTE (Vodafone) K3565-Z */
380         {QMI_FIXED_INTF(0x19d2, 0x0104, 4)},    /* ZTE (Vodafone) K4505-Z */
381         {QMI_FIXED_INTF(0x19d2, 0x0167, 4)},    /* ZTE MF820D */
382         {QMI_FIXED_INTF(0x19d2, 0x0326, 4)},    /* ZTE MF821D */
383         {QMI_FIXED_INTF(0x19d2, 0x1008, 4)},    /* ZTE (Vodafone) K3570-Z */
384         {QMI_FIXED_INTF(0x19d2, 0x1010, 4)},    /* ZTE (Vodafone) K3571-Z */
385         {QMI_FIXED_INTF(0x19d2, 0x1402, 2)},    /* ZTE MF60 */
386         {QMI_FIXED_INTF(0x19d2, 0x2002, 4)},    /* ZTE (Vodafone) K3765-Z */
387         {QMI_FIXED_INTF(0x0f3d, 0x68a2, 8)},    /* Sierra Wireless MC7700 */
388         {QMI_FIXED_INTF(0x114f, 0x68a2, 8)},    /* Sierra Wireless MC7750 */
389         {QMI_FIXED_INTF(0x1199, 0x68a2, 8)},    /* Sierra Wireless MC7710 in QMI mode */
390         {QMI_FIXED_INTF(0x1199, 0x68a2, 19)},   /* Sierra Wireless MC7710 in QMI mode */
391         {QMI_FIXED_INTF(0x1199, 0x901c, 8)},    /* Sierra Wireless EM7700 */
392
393         /* 4. Gobi 1000 devices */
394         {QMI_GOBI1K_DEVICE(0x05c6, 0x9212)},    /* Acer Gobi Modem Device */
395         {QMI_GOBI1K_DEVICE(0x03f0, 0x1f1d)},    /* HP un2400 Gobi Modem Device */
396         {QMI_GOBI1K_DEVICE(0x03f0, 0x371d)},    /* HP un2430 Mobile Broadband Module */
397         {QMI_GOBI1K_DEVICE(0x04da, 0x250d)},    /* Panasonic Gobi Modem device */
398         {QMI_GOBI1K_DEVICE(0x413c, 0x8172)},    /* Dell Gobi Modem device */
399         {QMI_GOBI1K_DEVICE(0x1410, 0xa001)},    /* Novatel Gobi Modem device */
400         {QMI_GOBI1K_DEVICE(0x0b05, 0x1776)},    /* Asus Gobi Modem device */
401         {QMI_GOBI1K_DEVICE(0x19d2, 0xfff3)},    /* ONDA Gobi Modem device */
402         {QMI_GOBI1K_DEVICE(0x05c6, 0x9001)},    /* Generic Gobi Modem device */
403         {QMI_GOBI1K_DEVICE(0x05c6, 0x9002)},    /* Generic Gobi Modem device */
404         {QMI_GOBI1K_DEVICE(0x05c6, 0x9202)},    /* Generic Gobi Modem device */
405         {QMI_GOBI1K_DEVICE(0x05c6, 0x9203)},    /* Generic Gobi Modem device */
406         {QMI_GOBI1K_DEVICE(0x05c6, 0x9222)},    /* Generic Gobi Modem device */
407         {QMI_GOBI1K_DEVICE(0x05c6, 0x9009)},    /* Generic Gobi Modem device */
408
409         /* 5. Gobi 2000 and 3000 devices */
410         {QMI_GOBI_DEVICE(0x413c, 0x8186)},      /* Dell Gobi 2000 Modem device (N0218, VU936) */
411         {QMI_GOBI_DEVICE(0x05c6, 0x920b)},      /* Generic Gobi 2000 Modem device */
412         {QMI_GOBI_DEVICE(0x05c6, 0x9225)},      /* Sony Gobi 2000 Modem device (N0279, VU730) */
413         {QMI_GOBI_DEVICE(0x05c6, 0x9245)},      /* Samsung Gobi 2000 Modem device (VL176) */
414         {QMI_GOBI_DEVICE(0x03f0, 0x251d)},      /* HP Gobi 2000 Modem device (VP412) */
415         {QMI_GOBI_DEVICE(0x05c6, 0x9215)},      /* Acer Gobi 2000 Modem device (VP413) */
416         {QMI_GOBI_DEVICE(0x05c6, 0x9265)},      /* Asus Gobi 2000 Modem device (VR305) */
417         {QMI_GOBI_DEVICE(0x05c6, 0x9235)},      /* Top Global Gobi 2000 Modem device (VR306) */
418         {QMI_GOBI_DEVICE(0x05c6, 0x9275)},      /* iRex Technologies Gobi 2000 Modem device (VR307) */
419         {QMI_GOBI_DEVICE(0x1199, 0x68a5)},      /* Sierra Wireless Modem */
420         {QMI_GOBI_DEVICE(0x1199, 0x68a9)},      /* Sierra Wireless Modem */
421         {QMI_GOBI_DEVICE(0x1199, 0x9001)},      /* Sierra Wireless Gobi 2000 Modem device (VT773) */
422         {QMI_GOBI_DEVICE(0x1199, 0x9002)},      /* Sierra Wireless Gobi 2000 Modem device (VT773) */
423         {QMI_GOBI_DEVICE(0x1199, 0x9003)},      /* Sierra Wireless Gobi 2000 Modem device (VT773) */
424         {QMI_GOBI_DEVICE(0x1199, 0x9004)},      /* Sierra Wireless Gobi 2000 Modem device (VT773) */
425         {QMI_GOBI_DEVICE(0x1199, 0x9005)},      /* Sierra Wireless Gobi 2000 Modem device (VT773) */
426         {QMI_GOBI_DEVICE(0x1199, 0x9006)},      /* Sierra Wireless Gobi 2000 Modem device (VT773) */
427         {QMI_GOBI_DEVICE(0x1199, 0x9007)},      /* Sierra Wireless Gobi 2000 Modem device (VT773) */
428         {QMI_GOBI_DEVICE(0x1199, 0x9008)},      /* Sierra Wireless Gobi 2000 Modem device (VT773) */
429         {QMI_GOBI_DEVICE(0x1199, 0x9009)},      /* Sierra Wireless Gobi 2000 Modem device (VT773) */
430         {QMI_GOBI_DEVICE(0x1199, 0x900a)},      /* Sierra Wireless Gobi 2000 Modem device (VT773) */
431         {QMI_GOBI_DEVICE(0x1199, 0x9011)},      /* Sierra Wireless Gobi 2000 Modem device (MC8305) */
432         {QMI_FIXED_INTF(0x1199, 0x9011, 5)},    /* alternate interface number!? */
433         {QMI_GOBI_DEVICE(0x16d8, 0x8002)},      /* CMDTech Gobi 2000 Modem device (VU922) */
434         {QMI_GOBI_DEVICE(0x05c6, 0x9205)},      /* Gobi 2000 Modem device */
435         {QMI_GOBI_DEVICE(0x1199, 0x9013)},      /* Sierra Wireless Gobi 3000 Modem device (MC8355) */
436         {QMI_GOBI_DEVICE(0x1199, 0x9015)},      /* Sierra Wireless Gobi 3000 Modem device */
437         {QMI_GOBI_DEVICE(0x1199, 0x9019)},      /* Sierra Wireless Gobi 3000 Modem device */
438         {QMI_GOBI_DEVICE(0x1199, 0x901b)},      /* Sierra Wireless MC7770 */
439
440         { }                                     /* END */
441 };
442 MODULE_DEVICE_TABLE(usb, products);
443
444 static int qmi_wwan_probe(struct usb_interface *intf, const struct usb_device_id *prod)
445 {
446         struct usb_device_id *id = (struct usb_device_id *)prod;
447
448         /* Workaround to enable dynamic IDs.  This disables usbnet
449          * blacklisting functionality.  Which, if required, can be
450          * reimplemented here by using a magic "blacklist" value
451          * instead of 0 in the static device id table
452          */
453         if (!id->driver_info) {
454                 dev_dbg(&intf->dev, "setting defaults for dynamic device id\n");
455                 id->driver_info = (unsigned long)&qmi_wwan_shared;
456         }
457
458         return usbnet_probe(intf, id);
459 }
460
461 static struct usb_driver qmi_wwan_driver = {
462         .name                 = "qmi_wwan",
463         .id_table             = products,
464         .probe                = qmi_wwan_probe,
465         .disconnect           = usbnet_disconnect,
466         .suspend              = qmi_wwan_suspend,
467         .resume               = qmi_wwan_resume,
468         .reset_resume         = qmi_wwan_resume,
469         .supports_autosuspend = 1,
470 };
471
472 module_usb_driver(qmi_wwan_driver);
473
474 MODULE_AUTHOR("Bjørn Mork <bjorn@mork.no>");
475 MODULE_DESCRIPTION("Qualcomm MSM Interface (QMI) WWAN driver");
476 MODULE_LICENSE("GPL");