1/*
2 * Qualcomm Serial USB driver
3 *
4 *	Copyright (c) 2008 QUALCOMM Incorporated.
5 *	Copyright (c) 2009 Greg Kroah-Hartman <gregkh@suse.de>
6 *	Copyright (c) 2009 Novell Inc.
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 version
10 *	2 as published by the Free Software Foundation.
11 *
12 */
13
14#include <linux/tty.h>
15#include <linux/tty_flip.h>
16#include <linux/module.h>
17#include <linux/usb.h>
18#include <linux/usb/serial.h>
19#include <linux/slab.h>
20#include "usb-wwan.h"
21
22#define DRIVER_AUTHOR "Qualcomm Inc"
23#define DRIVER_DESC "Qualcomm USB Serial driver"
24
25#define QUECTEL_EC20_PID	0x9215
26
27/* standard device layouts supported by this driver */
28enum qcserial_layouts {
29	QCSERIAL_G2K = 0,	/* Gobi 2000 */
30	QCSERIAL_G1K = 1,	/* Gobi 1000 */
31	QCSERIAL_SWI = 2,	/* Sierra Wireless */
32	QCSERIAL_HWI = 3,	/* Huawei */
33};
34
35#define DEVICE_G1K(v, p) \
36	USB_DEVICE(v, p), .driver_info = QCSERIAL_G1K
37#define DEVICE_SWI(v, p) \
38	USB_DEVICE(v, p), .driver_info = QCSERIAL_SWI
39#define DEVICE_HWI(v, p) \
40	USB_DEVICE(v, p), .driver_info = QCSERIAL_HWI
41
42static const struct usb_device_id id_table[] = {
43	/* Gobi 1000 devices */
44	{DEVICE_G1K(0x05c6, 0x9211)},	/* Acer Gobi QDL device */
45	{DEVICE_G1K(0x05c6, 0x9212)},	/* Acer Gobi Modem Device */
46	{DEVICE_G1K(0x03f0, 0x1f1d)},	/* HP un2400 Gobi Modem Device */
47	{DEVICE_G1K(0x03f0, 0x201d)},	/* HP un2400 Gobi QDL Device */
48	{DEVICE_G1K(0x04da, 0x250d)},	/* Panasonic Gobi Modem device */
49	{DEVICE_G1K(0x04da, 0x250c)},	/* Panasonic Gobi QDL device */
50	{DEVICE_G1K(0x413c, 0x8172)},	/* Dell Gobi Modem device */
51	{DEVICE_G1K(0x413c, 0x8171)},	/* Dell Gobi QDL device */
52	{DEVICE_G1K(0x1410, 0xa001)},	/* Novatel/Verizon USB-1000 */
53	{DEVICE_G1K(0x1410, 0xa002)},	/* Novatel Gobi Modem device */
54	{DEVICE_G1K(0x1410, 0xa003)},	/* Novatel Gobi Modem device */
55	{DEVICE_G1K(0x1410, 0xa004)},	/* Novatel Gobi Modem device */
56	{DEVICE_G1K(0x1410, 0xa005)},	/* Novatel Gobi Modem device */
57	{DEVICE_G1K(0x1410, 0xa006)},	/* Novatel Gobi Modem device */
58	{DEVICE_G1K(0x1410, 0xa007)},	/* Novatel Gobi Modem device */
59	{DEVICE_G1K(0x1410, 0xa008)},	/* Novatel Gobi QDL device */
60	{DEVICE_G1K(0x0b05, 0x1776)},	/* Asus Gobi Modem device */
61	{DEVICE_G1K(0x0b05, 0x1774)},	/* Asus Gobi QDL device */
62	{DEVICE_G1K(0x19d2, 0xfff3)},	/* ONDA Gobi Modem device */
63	{DEVICE_G1K(0x19d2, 0xfff2)},	/* ONDA Gobi QDL device */
64	{DEVICE_G1K(0x1557, 0x0a80)},	/* OQO Gobi QDL device */
65	{DEVICE_G1K(0x05c6, 0x9001)},   /* Generic Gobi Modem device */
66	{DEVICE_G1K(0x05c6, 0x9002)},	/* Generic Gobi Modem device */
67	{DEVICE_G1K(0x05c6, 0x9202)},	/* Generic Gobi Modem device */
68	{DEVICE_G1K(0x05c6, 0x9203)},	/* Generic Gobi Modem device */
69	{DEVICE_G1K(0x05c6, 0x9222)},	/* Generic Gobi Modem device */
70	{DEVICE_G1K(0x05c6, 0x9008)},	/* Generic Gobi QDL device */
71	{DEVICE_G1K(0x05c6, 0x9009)},	/* Generic Gobi Modem device */
72	{DEVICE_G1K(0x05c6, 0x9201)},	/* Generic Gobi QDL device */
73	{DEVICE_G1K(0x05c6, 0x9221)},	/* Generic Gobi QDL device */
74	{DEVICE_G1K(0x05c6, 0x9231)},	/* Generic Gobi QDL device */
75	{DEVICE_G1K(0x1f45, 0x0001)},	/* Unknown Gobi QDL device */
76	{DEVICE_G1K(0x1bc7, 0x900e)},	/* Telit Gobi QDL device */
77
78	/* Gobi 2000 devices */
79	{USB_DEVICE(0x1410, 0xa010)},	/* Novatel Gobi 2000 QDL device */
80	{USB_DEVICE(0x1410, 0xa011)},	/* Novatel Gobi 2000 QDL device */
81	{USB_DEVICE(0x1410, 0xa012)},	/* Novatel Gobi 2000 QDL device */
82	{USB_DEVICE(0x1410, 0xa013)},	/* Novatel Gobi 2000 QDL device */
83	{USB_DEVICE(0x1410, 0xa014)},	/* Novatel Gobi 2000 QDL device */
84	{USB_DEVICE(0x413c, 0x8185)},	/* Dell Gobi 2000 QDL device (N0218, VU936) */
85	{USB_DEVICE(0x413c, 0x8186)},	/* Dell Gobi 2000 Modem device (N0218, VU936) */
86	{USB_DEVICE(0x05c6, 0x9208)},	/* Generic Gobi 2000 QDL device */
87	{USB_DEVICE(0x05c6, 0x920b)},	/* Generic Gobi 2000 Modem device */
88	{USB_DEVICE(0x05c6, 0x9224)},	/* Sony Gobi 2000 QDL device (N0279, VU730) */
89	{USB_DEVICE(0x05c6, 0x9225)},	/* Sony Gobi 2000 Modem device (N0279, VU730) */
90	{USB_DEVICE(0x05c6, 0x9244)},	/* Samsung Gobi 2000 QDL device (VL176) */
91	{USB_DEVICE(0x05c6, 0x9245)},	/* Samsung Gobi 2000 Modem device (VL176) */
92	{USB_DEVICE(0x03f0, 0x241d)},	/* HP Gobi 2000 QDL device (VP412) */
93	{USB_DEVICE(0x03f0, 0x251d)},	/* HP Gobi 2000 Modem device (VP412) */
94	{USB_DEVICE(0x05c6, 0x9214)},	/* Acer Gobi 2000 QDL device (VP413) */
95	{USB_DEVICE(0x05c6, 0x9215)},	/* Acer Gobi 2000 Modem device (VP413) */
96	{USB_DEVICE(0x05c6, 0x9264)},	/* Asus Gobi 2000 QDL device (VR305) */
97	{USB_DEVICE(0x05c6, 0x9265)},	/* Asus Gobi 2000 Modem device (VR305) */
98	{USB_DEVICE(0x05c6, 0x9234)},	/* Top Global Gobi 2000 QDL device (VR306) */
99	{USB_DEVICE(0x05c6, 0x9235)},	/* Top Global Gobi 2000 Modem device (VR306) */
100	{USB_DEVICE(0x05c6, 0x9274)},	/* iRex Technologies Gobi 2000 QDL device (VR307) */
101	{USB_DEVICE(0x05c6, 0x9275)},	/* iRex Technologies Gobi 2000 Modem device (VR307) */
102	{USB_DEVICE(0x1199, 0x9000)},	/* Sierra Wireless Gobi 2000 QDL device (VT773) */
103	{USB_DEVICE(0x1199, 0x9001)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
104	{USB_DEVICE(0x1199, 0x9002)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
105	{USB_DEVICE(0x1199, 0x9003)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
106	{USB_DEVICE(0x1199, 0x9004)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
107	{USB_DEVICE(0x1199, 0x9005)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
108	{USB_DEVICE(0x1199, 0x9006)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
109	{USB_DEVICE(0x1199, 0x9007)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
110	{USB_DEVICE(0x1199, 0x9008)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
111	{USB_DEVICE(0x1199, 0x9009)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
112	{USB_DEVICE(0x1199, 0x900a)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
113	{USB_DEVICE(0x1199, 0x9011)},   /* Sierra Wireless Gobi 2000 Modem device (MC8305) */
114	{USB_DEVICE(0x16d8, 0x8001)},	/* CMDTech Gobi 2000 QDL device (VU922) */
115	{USB_DEVICE(0x16d8, 0x8002)},	/* CMDTech Gobi 2000 Modem device (VU922) */
116	{USB_DEVICE(0x05c6, 0x9204)},	/* Gobi 2000 QDL device */
117	{USB_DEVICE(0x05c6, 0x9205)},	/* Gobi 2000 Modem device */
118
119	/* Gobi 3000 devices */
120	{USB_DEVICE(0x03f0, 0x371d)},	/* HP un2430 Gobi 3000 QDL */
121	{USB_DEVICE(0x05c6, 0x920c)},	/* Gobi 3000 QDL */
122	{USB_DEVICE(0x05c6, 0x920d)},	/* Gobi 3000 Composite */
123	{USB_DEVICE(0x1410, 0xa020)},   /* Novatel Gobi 3000 QDL */
124	{USB_DEVICE(0x1410, 0xa021)},	/* Novatel Gobi 3000 Composite */
125	{USB_DEVICE(0x413c, 0x8193)},	/* Dell Gobi 3000 QDL */
126	{USB_DEVICE(0x413c, 0x8194)},	/* Dell Gobi 3000 Composite */
127	{USB_DEVICE(0x1199, 0x68a4)},	/* Sierra Wireless QDL */
128	{USB_DEVICE(0x1199, 0x68a5)},	/* Sierra Wireless Modem */
129	{USB_DEVICE(0x1199, 0x68a8)},	/* Sierra Wireless QDL */
130	{USB_DEVICE(0x1199, 0x68a9)},	/* Sierra Wireless Modem */
131	{USB_DEVICE(0x1199, 0x9010)},	/* Sierra Wireless Gobi 3000 QDL */
132	{USB_DEVICE(0x1199, 0x9012)},	/* Sierra Wireless Gobi 3000 QDL */
133	{USB_DEVICE(0x1199, 0x9013)},	/* Sierra Wireless Gobi 3000 Modem device (MC8355) */
134	{USB_DEVICE(0x1199, 0x9014)},	/* Sierra Wireless Gobi 3000 QDL */
135	{USB_DEVICE(0x1199, 0x9015)},	/* Sierra Wireless Gobi 3000 Modem device */
136	{USB_DEVICE(0x1199, 0x9018)},	/* Sierra Wireless Gobi 3000 QDL */
137	{USB_DEVICE(0x1199, 0x9019)},	/* Sierra Wireless Gobi 3000 Modem device */
138	{USB_DEVICE(0x1199, 0x901b)},	/* Sierra Wireless MC7770 */
139	{USB_DEVICE(0x12D1, 0x14F0)},	/* Sony Gobi 3000 QDL */
140	{USB_DEVICE(0x12D1, 0x14F1)},	/* Sony Gobi 3000 Composite */
141	{USB_DEVICE(0x0AF0, 0x8120)},	/* Option GTM681W */
142
143	/* non-Gobi Sierra Wireless devices */
144	{DEVICE_SWI(0x03f0, 0x4e1d)},	/* HP lt4111 LTE/EV-DO/HSPA+ Gobi 4G Module */
145	{DEVICE_SWI(0x0f3d, 0x68a2)},	/* Sierra Wireless MC7700 */
146	{DEVICE_SWI(0x114f, 0x68a2)},	/* Sierra Wireless MC7750 */
147	{DEVICE_SWI(0x1199, 0x68a2)},	/* Sierra Wireless MC7710 */
148	{DEVICE_SWI(0x1199, 0x901c)},	/* Sierra Wireless EM7700 */
149	{DEVICE_SWI(0x1199, 0x901f)},	/* Sierra Wireless EM7355 */
150	{DEVICE_SWI(0x1199, 0x9040)},	/* Sierra Wireless Modem */
151	{DEVICE_SWI(0x1199, 0x9051)},	/* Netgear AirCard 340U */
152	{DEVICE_SWI(0x1199, 0x9053)},	/* Sierra Wireless Modem */
153	{DEVICE_SWI(0x1199, 0x9054)},	/* Sierra Wireless Modem */
154	{DEVICE_SWI(0x1199, 0x9055)},	/* Netgear AirCard 341U */
155	{DEVICE_SWI(0x1199, 0x9056)},	/* Sierra Wireless Modem */
156	{DEVICE_SWI(0x1199, 0x9060)},	/* Sierra Wireless Modem */
157	{DEVICE_SWI(0x1199, 0x9061)},	/* Sierra Wireless Modem */
158	{DEVICE_SWI(0x1199, 0x9070)},	/* Sierra Wireless MC74xx */
159	{DEVICE_SWI(0x1199, 0x9071)},	/* Sierra Wireless MC74xx */
160	{DEVICE_SWI(0x1199, 0x9078)},	/* Sierra Wireless EM74xx */
161	{DEVICE_SWI(0x1199, 0x9079)},	/* Sierra Wireless EM74xx */
162	{DEVICE_SWI(0x413c, 0x81a2)},	/* Dell Wireless 5806 Gobi(TM) 4G LTE Mobile Broadband Card */
163	{DEVICE_SWI(0x413c, 0x81a3)},	/* Dell Wireless 5570 HSPA+ (42Mbps) Mobile Broadband Card */
164	{DEVICE_SWI(0x413c, 0x81a4)},	/* Dell Wireless 5570e HSPA+ (42Mbps) Mobile Broadband Card */
165	{DEVICE_SWI(0x413c, 0x81a8)},	/* Dell Wireless 5808 Gobi(TM) 4G LTE Mobile Broadband Card */
166	{DEVICE_SWI(0x413c, 0x81a9)},	/* Dell Wireless 5808e Gobi(TM) 4G LTE Mobile Broadband Card */
167	{DEVICE_SWI(0x413c, 0x81b1)},	/* Dell Wireless 5809e Gobi(TM) 4G LTE Mobile Broadband Card */
168	{DEVICE_SWI(0x413c, 0x81b3)},	/* Dell Wireless 5809e Gobi(TM) 4G LTE Mobile Broadband Card (rev3) */
169
170	/* Huawei devices */
171	{DEVICE_HWI(0x03f0, 0x581d)},	/* HP lt4112 LTE/HSPA+ Gobi 4G Modem (Huawei me906e) */
172
173	{ }				/* Terminating entry */
174};
175MODULE_DEVICE_TABLE(usb, id_table);
176
177static int handle_quectel_ec20(struct device *dev, int ifnum)
178{
179	int altsetting = 0;
180
181	/*
182	 * Quectel EC20 Mini PCIe LTE module layout:
183	 * 0: DM/DIAG (use libqcdm from ModemManager for communication)
184	 * 1: NMEA
185	 * 2: AT-capable modem port
186	 * 3: Modem interface
187	 * 4: NDIS
188	 */
189	switch (ifnum) {
190	case 0:
191		dev_dbg(dev, "Quectel EC20 DM/DIAG interface found\n");
192		break;
193	case 1:
194		dev_dbg(dev, "Quectel EC20 NMEA GPS interface found\n");
195		break;
196	case 2:
197	case 3:
198		dev_dbg(dev, "Quectel EC20 Modem port found\n");
199		break;
200	case 4:
201		/* Don't claim the QMI/net interface */
202		altsetting = -1;
203		break;
204	}
205
206	return altsetting;
207}
208
209static int qcprobe(struct usb_serial *serial, const struct usb_device_id *id)
210{
211	struct usb_host_interface *intf = serial->interface->cur_altsetting;
212	struct device *dev = &serial->dev->dev;
213	int retval = -ENODEV;
214	__u8 nintf;
215	__u8 ifnum;
216	int altsetting = -1;
217
218	/* we only support vendor specific functions */
219	if (intf->desc.bInterfaceClass != USB_CLASS_VENDOR_SPEC)
220		goto done;
221
222	nintf = serial->dev->actconfig->desc.bNumInterfaces;
223	dev_dbg(dev, "Num Interfaces = %d\n", nintf);
224	ifnum = intf->desc.bInterfaceNumber;
225	dev_dbg(dev, "This Interface = %d\n", ifnum);
226
227	if (nintf == 1) {
228		/* QDL mode */
229		/* Gobi 2000 has a single altsetting, older ones have two */
230		if (serial->interface->num_altsetting == 2)
231			intf = &serial->interface->altsetting[1];
232		else if (serial->interface->num_altsetting > 2)
233			goto done;
234
235		if (intf->desc.bNumEndpoints == 2 &&
236		    usb_endpoint_is_bulk_in(&intf->endpoint[0].desc) &&
237		    usb_endpoint_is_bulk_out(&intf->endpoint[1].desc)) {
238			dev_dbg(dev, "QDL port found\n");
239
240			if (serial->interface->num_altsetting == 1)
241				retval = 0; /* Success */
242			else
243				altsetting = 1;
244		}
245		goto done;
246
247	}
248
249	/* default to enabling interface */
250	altsetting = 0;
251
252	/*
253	 * Composite mode; don't bind to the QMI/net interface as that
254	 * gets handled by other drivers.
255	 */
256
257	switch (id->driver_info) {
258	case QCSERIAL_G1K:
259		/*
260		 * Gobi 1K USB layout:
261		 * 0: DM/DIAG (use libqcdm from ModemManager for communication)
262		 * 1: serial port (doesn't respond)
263		 * 2: AT-capable modem port
264		 * 3: QMI/net
265		 */
266		if (nintf < 3 || nintf > 4) {
267			dev_err(dev, "unknown number of interfaces: %d\n", nintf);
268			altsetting = -1;
269			goto done;
270		}
271
272		if (ifnum == 0) {
273			dev_dbg(dev, "Gobi 1K DM/DIAG interface found\n");
274			altsetting = 1;
275		} else if (ifnum == 2)
276			dev_dbg(dev, "Modem port found\n");
277		else
278			altsetting = -1;
279		break;
280	case QCSERIAL_G2K:
281		/* handle non-standard layouts */
282		if (nintf == 5 && id->idProduct == QUECTEL_EC20_PID) {
283			altsetting = handle_quectel_ec20(dev, ifnum);
284			goto done;
285		}
286
287		/*
288		 * Gobi 2K+ USB layout:
289		 * 0: QMI/net
290		 * 1: DM/DIAG (use libqcdm from ModemManager for communication)
291		 * 2: AT-capable modem port
292		 * 3: NMEA
293		 */
294		if (nintf < 3 || nintf > 4) {
295			dev_err(dev, "unknown number of interfaces: %d\n", nintf);
296			altsetting = -1;
297			goto done;
298		}
299
300		switch (ifnum) {
301		case 0:
302			/* Don't claim the QMI/net interface */
303			altsetting = -1;
304			break;
305		case 1:
306			dev_dbg(dev, "Gobi 2K+ DM/DIAG interface found\n");
307			break;
308		case 2:
309			dev_dbg(dev, "Modem port found\n");
310			break;
311		case 3:
312			/*
313			 * NMEA (serial line 9600 8N1)
314			 * # echo "\$GPS_START" > /dev/ttyUSBx
315			 * # echo "\$GPS_STOP"  > /dev/ttyUSBx
316			 */
317			dev_dbg(dev, "Gobi 2K+ NMEA GPS interface found\n");
318			break;
319		}
320		break;
321	case QCSERIAL_SWI:
322		/*
323		 * Sierra Wireless layout:
324		 * 0: DM/DIAG (use libqcdm from ModemManager for communication)
325		 * 2: NMEA
326		 * 3: AT-capable modem port
327		 * 8: QMI/net
328		 */
329		switch (ifnum) {
330		case 0:
331			dev_dbg(dev, "DM/DIAG interface found\n");
332			break;
333		case 2:
334			dev_dbg(dev, "NMEA GPS interface found\n");
335			break;
336		case 3:
337			dev_dbg(dev, "Modem port found\n");
338			break;
339		default:
340			/* don't claim any unsupported interface */
341			altsetting = -1;
342			break;
343		}
344		break;
345	case QCSERIAL_HWI:
346		/*
347		 * Huawei devices map functions by subclass + protocol
348		 * instead of interface numbers. The protocol identify
349		 * a specific function, while the subclass indicate a
350		 * specific firmware source
351		 *
352		 * This is a blacklist of functions known to be
353		 * non-serial.  The rest are assumed to be serial and
354		 * will be handled by this driver
355		 */
356		switch (intf->desc.bInterfaceProtocol) {
357			/* QMI combined (qmi_wwan) */
358		case 0x07:
359		case 0x37:
360		case 0x67:
361			/* QMI data (qmi_wwan) */
362		case 0x08:
363		case 0x38:
364		case 0x68:
365			/* QMI control (qmi_wwan) */
366		case 0x09:
367		case 0x39:
368		case 0x69:
369			/* NCM like (huawei_cdc_ncm) */
370		case 0x16:
371		case 0x46:
372		case 0x76:
373			altsetting = -1;
374			break;
375		default:
376			dev_dbg(dev, "Huawei type serial port found (%02x/%02x/%02x)\n",
377				intf->desc.bInterfaceClass,
378				intf->desc.bInterfaceSubClass,
379				intf->desc.bInterfaceProtocol);
380		}
381		break;
382	default:
383		dev_err(dev, "unsupported device layout type: %lu\n",
384			id->driver_info);
385		break;
386	}
387
388done:
389	if (altsetting >= 0) {
390		retval = usb_set_interface(serial->dev, ifnum, altsetting);
391		if (retval < 0) {
392			dev_err(dev,
393				"Could not set interface, error %d\n",
394				retval);
395			retval = -ENODEV;
396		}
397	}
398
399	return retval;
400}
401
402static int qc_attach(struct usb_serial *serial)
403{
404	struct usb_wwan_intf_private *data;
405
406	data = kzalloc(sizeof(*data), GFP_KERNEL);
407	if (!data)
408		return -ENOMEM;
409
410	spin_lock_init(&data->susp_lock);
411
412	usb_set_serial_data(serial, data);
413
414	return 0;
415}
416
417static void qc_release(struct usb_serial *serial)
418{
419	struct usb_wwan_intf_private *priv = usb_get_serial_data(serial);
420
421	usb_set_serial_data(serial, NULL);
422	kfree(priv);
423}
424
425static struct usb_serial_driver qcdevice = {
426	.driver = {
427		.owner     = THIS_MODULE,
428		.name      = "qcserial",
429	},
430	.description         = "Qualcomm USB modem",
431	.id_table            = id_table,
432	.num_ports           = 1,
433	.probe               = qcprobe,
434	.open		     = usb_wwan_open,
435	.close		     = usb_wwan_close,
436	.write		     = usb_wwan_write,
437	.write_room	     = usb_wwan_write_room,
438	.chars_in_buffer     = usb_wwan_chars_in_buffer,
439	.attach              = qc_attach,
440	.release	     = qc_release,
441	.port_probe          = usb_wwan_port_probe,
442	.port_remove	     = usb_wwan_port_remove,
443#ifdef CONFIG_PM
444	.suspend	     = usb_wwan_suspend,
445	.resume		     = usb_wwan_resume,
446#endif
447};
448
449static struct usb_serial_driver * const serial_drivers[] = {
450	&qcdevice, NULL
451};
452
453module_usb_serial_driver(serial_drivers, id_table);
454
455MODULE_AUTHOR(DRIVER_AUTHOR);
456MODULE_DESCRIPTION(DRIVER_DESC);
457MODULE_LICENSE("GPL v2");
458