xref: /openbmc/linux/drivers/usb/serial/qcserial.c (revision d2999e1b)
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 /* standard device layouts supported by this driver */
26 enum qcserial_layouts {
27 	QCSERIAL_G2K = 0,	/* Gobi 2000 */
28 	QCSERIAL_G1K = 1,	/* Gobi 1000 */
29 	QCSERIAL_SWI = 2,	/* Sierra Wireless */
30 };
31 
32 #define DEVICE_G1K(v, p) \
33 	USB_DEVICE(v, p), .driver_info = QCSERIAL_G1K
34 #define DEVICE_SWI(v, p) \
35 	USB_DEVICE(v, p), .driver_info = QCSERIAL_SWI
36 
37 static const struct usb_device_id id_table[] = {
38 	/* Gobi 1000 devices */
39 	{DEVICE_G1K(0x05c6, 0x9211)},	/* Acer Gobi QDL device */
40 	{DEVICE_G1K(0x05c6, 0x9212)},	/* Acer Gobi Modem Device */
41 	{DEVICE_G1K(0x03f0, 0x1f1d)},	/* HP un2400 Gobi Modem Device */
42 	{DEVICE_G1K(0x03f0, 0x201d)},	/* HP un2400 Gobi QDL Device */
43 	{DEVICE_G1K(0x04da, 0x250d)},	/* Panasonic Gobi Modem device */
44 	{DEVICE_G1K(0x04da, 0x250c)},	/* Panasonic Gobi QDL device */
45 	{DEVICE_G1K(0x413c, 0x8172)},	/* Dell Gobi Modem device */
46 	{DEVICE_G1K(0x413c, 0x8171)},	/* Dell Gobi QDL device */
47 	{DEVICE_G1K(0x1410, 0xa001)},	/* Novatel/Verizon USB-1000 */
48 	{DEVICE_G1K(0x1410, 0xa002)},	/* Novatel Gobi Modem device */
49 	{DEVICE_G1K(0x1410, 0xa003)},	/* Novatel Gobi Modem device */
50 	{DEVICE_G1K(0x1410, 0xa004)},	/* Novatel Gobi Modem device */
51 	{DEVICE_G1K(0x1410, 0xa005)},	/* Novatel Gobi Modem device */
52 	{DEVICE_G1K(0x1410, 0xa006)},	/* Novatel Gobi Modem device */
53 	{DEVICE_G1K(0x1410, 0xa007)},	/* Novatel Gobi Modem device */
54 	{DEVICE_G1K(0x1410, 0xa008)},	/* Novatel Gobi QDL device */
55 	{DEVICE_G1K(0x0b05, 0x1776)},	/* Asus Gobi Modem device */
56 	{DEVICE_G1K(0x0b05, 0x1774)},	/* Asus Gobi QDL device */
57 	{DEVICE_G1K(0x19d2, 0xfff3)},	/* ONDA Gobi Modem device */
58 	{DEVICE_G1K(0x19d2, 0xfff2)},	/* ONDA Gobi QDL device */
59 	{DEVICE_G1K(0x1557, 0x0a80)},	/* OQO Gobi QDL device */
60 	{DEVICE_G1K(0x05c6, 0x9001)},   /* Generic Gobi Modem device */
61 	{DEVICE_G1K(0x05c6, 0x9002)},	/* Generic Gobi Modem device */
62 	{DEVICE_G1K(0x05c6, 0x9202)},	/* Generic Gobi Modem device */
63 	{DEVICE_G1K(0x05c6, 0x9203)},	/* Generic Gobi Modem device */
64 	{DEVICE_G1K(0x05c6, 0x9222)},	/* Generic Gobi Modem device */
65 	{DEVICE_G1K(0x05c6, 0x9008)},	/* Generic Gobi QDL device */
66 	{DEVICE_G1K(0x05c6, 0x9009)},	/* Generic Gobi Modem device */
67 	{DEVICE_G1K(0x05c6, 0x9201)},	/* Generic Gobi QDL device */
68 	{DEVICE_G1K(0x05c6, 0x9221)},	/* Generic Gobi QDL device */
69 	{DEVICE_G1K(0x05c6, 0x9231)},	/* Generic Gobi QDL device */
70 	{DEVICE_G1K(0x1f45, 0x0001)},	/* Unknown Gobi QDL device */
71 	{DEVICE_G1K(0x1bc7, 0x900e)},	/* Telit Gobi QDL device */
72 
73 	/* Gobi 2000 devices */
74 	{USB_DEVICE(0x1410, 0xa010)},	/* Novatel Gobi 2000 QDL device */
75 	{USB_DEVICE(0x1410, 0xa011)},	/* Novatel Gobi 2000 QDL device */
76 	{USB_DEVICE(0x1410, 0xa012)},	/* Novatel Gobi 2000 QDL device */
77 	{USB_DEVICE(0x1410, 0xa013)},	/* Novatel Gobi 2000 QDL device */
78 	{USB_DEVICE(0x1410, 0xa014)},	/* Novatel Gobi 2000 QDL device */
79 	{USB_DEVICE(0x413c, 0x8185)},	/* Dell Gobi 2000 QDL device (N0218, VU936) */
80 	{USB_DEVICE(0x413c, 0x8186)},	/* Dell Gobi 2000 Modem device (N0218, VU936) */
81 	{USB_DEVICE(0x05c6, 0x9208)},	/* Generic Gobi 2000 QDL device */
82 	{USB_DEVICE(0x05c6, 0x920b)},	/* Generic Gobi 2000 Modem device */
83 	{USB_DEVICE(0x05c6, 0x9224)},	/* Sony Gobi 2000 QDL device (N0279, VU730) */
84 	{USB_DEVICE(0x05c6, 0x9225)},	/* Sony Gobi 2000 Modem device (N0279, VU730) */
85 	{USB_DEVICE(0x05c6, 0x9244)},	/* Samsung Gobi 2000 QDL device (VL176) */
86 	{USB_DEVICE(0x05c6, 0x9245)},	/* Samsung Gobi 2000 Modem device (VL176) */
87 	{USB_DEVICE(0x03f0, 0x241d)},	/* HP Gobi 2000 QDL device (VP412) */
88 	{USB_DEVICE(0x03f0, 0x251d)},	/* HP Gobi 2000 Modem device (VP412) */
89 	{USB_DEVICE(0x05c6, 0x9214)},	/* Acer Gobi 2000 QDL device (VP413) */
90 	{USB_DEVICE(0x05c6, 0x9215)},	/* Acer Gobi 2000 Modem device (VP413) */
91 	{USB_DEVICE(0x05c6, 0x9264)},	/* Asus Gobi 2000 QDL device (VR305) */
92 	{USB_DEVICE(0x05c6, 0x9265)},	/* Asus Gobi 2000 Modem device (VR305) */
93 	{USB_DEVICE(0x05c6, 0x9234)},	/* Top Global Gobi 2000 QDL device (VR306) */
94 	{USB_DEVICE(0x05c6, 0x9235)},	/* Top Global Gobi 2000 Modem device (VR306) */
95 	{USB_DEVICE(0x05c6, 0x9274)},	/* iRex Technologies Gobi 2000 QDL device (VR307) */
96 	{USB_DEVICE(0x05c6, 0x9275)},	/* iRex Technologies Gobi 2000 Modem device (VR307) */
97 	{USB_DEVICE(0x1199, 0x9000)},	/* Sierra Wireless Gobi 2000 QDL device (VT773) */
98 	{USB_DEVICE(0x1199, 0x9001)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
99 	{USB_DEVICE(0x1199, 0x9002)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
100 	{USB_DEVICE(0x1199, 0x9003)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
101 	{USB_DEVICE(0x1199, 0x9004)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
102 	{USB_DEVICE(0x1199, 0x9005)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
103 	{USB_DEVICE(0x1199, 0x9006)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
104 	{USB_DEVICE(0x1199, 0x9007)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
105 	{USB_DEVICE(0x1199, 0x9008)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
106 	{USB_DEVICE(0x1199, 0x9009)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
107 	{USB_DEVICE(0x1199, 0x900a)},	/* Sierra Wireless Gobi 2000 Modem device (VT773) */
108 	{USB_DEVICE(0x1199, 0x9011)},   /* Sierra Wireless Gobi 2000 Modem device (MC8305) */
109 	{USB_DEVICE(0x16d8, 0x8001)},	/* CMDTech Gobi 2000 QDL device (VU922) */
110 	{USB_DEVICE(0x16d8, 0x8002)},	/* CMDTech Gobi 2000 Modem device (VU922) */
111 	{USB_DEVICE(0x05c6, 0x9204)},	/* Gobi 2000 QDL device */
112 	{USB_DEVICE(0x05c6, 0x9205)},	/* Gobi 2000 Modem device */
113 
114 	/* Gobi 3000 devices */
115 	{USB_DEVICE(0x03f0, 0x371d)},	/* HP un2430 Gobi 3000 QDL */
116 	{USB_DEVICE(0x05c6, 0x920c)},	/* Gobi 3000 QDL */
117 	{USB_DEVICE(0x05c6, 0x920d)},	/* Gobi 3000 Composite */
118 	{USB_DEVICE(0x1410, 0xa020)},   /* Novatel Gobi 3000 QDL */
119 	{USB_DEVICE(0x1410, 0xa021)},	/* Novatel Gobi 3000 Composite */
120 	{USB_DEVICE(0x413c, 0x8193)},	/* Dell Gobi 3000 QDL */
121 	{USB_DEVICE(0x413c, 0x8194)},	/* Dell Gobi 3000 Composite */
122 	{USB_DEVICE(0x1199, 0x68a4)},	/* Sierra Wireless QDL */
123 	{USB_DEVICE(0x1199, 0x68a5)},	/* Sierra Wireless Modem */
124 	{USB_DEVICE(0x1199, 0x68a8)},	/* Sierra Wireless QDL */
125 	{USB_DEVICE(0x1199, 0x68a9)},	/* Sierra Wireless Modem */
126 	{USB_DEVICE(0x1199, 0x9010)},	/* Sierra Wireless Gobi 3000 QDL */
127 	{USB_DEVICE(0x1199, 0x9012)},	/* Sierra Wireless Gobi 3000 QDL */
128 	{USB_DEVICE(0x1199, 0x9013)},	/* Sierra Wireless Gobi 3000 Modem device (MC8355) */
129 	{USB_DEVICE(0x1199, 0x9014)},	/* Sierra Wireless Gobi 3000 QDL */
130 	{USB_DEVICE(0x1199, 0x9015)},	/* Sierra Wireless Gobi 3000 Modem device */
131 	{USB_DEVICE(0x1199, 0x9018)},	/* Sierra Wireless Gobi 3000 QDL */
132 	{USB_DEVICE(0x1199, 0x9019)},	/* Sierra Wireless Gobi 3000 Modem device */
133 	{USB_DEVICE(0x1199, 0x901b)},	/* Sierra Wireless MC7770 */
134 	{USB_DEVICE(0x12D1, 0x14F0)},	/* Sony Gobi 3000 QDL */
135 	{USB_DEVICE(0x12D1, 0x14F1)},	/* Sony Gobi 3000 Composite */
136 	{USB_DEVICE(0x0AF0, 0x8120)},	/* Option GTM681W */
137 
138 	/* non-Gobi Sierra Wireless devices */
139 	{DEVICE_SWI(0x0f3d, 0x68a2)},	/* Sierra Wireless MC7700 */
140 	{DEVICE_SWI(0x114f, 0x68a2)},	/* Sierra Wireless MC7750 */
141 	{DEVICE_SWI(0x1199, 0x68a2)},	/* Sierra Wireless MC7710 */
142 	{DEVICE_SWI(0x1199, 0x68c0)},	/* Sierra Wireless MC73xx */
143 	{DEVICE_SWI(0x1199, 0x901c)},	/* Sierra Wireless EM7700 */
144 	{DEVICE_SWI(0x1199, 0x901f)},	/* Sierra Wireless EM7355 */
145 	{DEVICE_SWI(0x1199, 0x9040)},	/* Sierra Wireless Modem */
146 	{DEVICE_SWI(0x1199, 0x9041)},	/* Sierra Wireless MC7305/MC7355 */
147 	{DEVICE_SWI(0x1199, 0x9051)},	/* Netgear AirCard 340U */
148 	{DEVICE_SWI(0x1199, 0x9053)},	/* Sierra Wireless Modem */
149 	{DEVICE_SWI(0x1199, 0x9054)},	/* Sierra Wireless Modem */
150 	{DEVICE_SWI(0x1199, 0x9055)},	/* Netgear AirCard 341U */
151 	{DEVICE_SWI(0x1199, 0x9056)},	/* Sierra Wireless Modem */
152 	{DEVICE_SWI(0x1199, 0x9060)},	/* Sierra Wireless Modem */
153 	{DEVICE_SWI(0x1199, 0x9061)},	/* Sierra Wireless Modem */
154 	{DEVICE_SWI(0x413c, 0x81a2)},	/* Dell Wireless 5806 Gobi(TM) 4G LTE Mobile Broadband Card */
155 	{DEVICE_SWI(0x413c, 0x81a3)},	/* Dell Wireless 5570 HSPA+ (42Mbps) Mobile Broadband Card */
156 	{DEVICE_SWI(0x413c, 0x81a4)},	/* Dell Wireless 5570e HSPA+ (42Mbps) Mobile Broadband Card */
157 	{DEVICE_SWI(0x413c, 0x81a8)},	/* Dell Wireless 5808 Gobi(TM) 4G LTE Mobile Broadband Card */
158 	{DEVICE_SWI(0x413c, 0x81a9)},	/* Dell Wireless 5808e Gobi(TM) 4G LTE Mobile Broadband Card */
159 
160 	{ }				/* Terminating entry */
161 };
162 MODULE_DEVICE_TABLE(usb, id_table);
163 
164 static int qcprobe(struct usb_serial *serial, const struct usb_device_id *id)
165 {
166 	struct usb_host_interface *intf = serial->interface->cur_altsetting;
167 	struct device *dev = &serial->dev->dev;
168 	int retval = -ENODEV;
169 	__u8 nintf;
170 	__u8 ifnum;
171 	int altsetting = -1;
172 
173 	nintf = serial->dev->actconfig->desc.bNumInterfaces;
174 	dev_dbg(dev, "Num Interfaces = %d\n", nintf);
175 	ifnum = intf->desc.bInterfaceNumber;
176 	dev_dbg(dev, "This Interface = %d\n", ifnum);
177 
178 	if (nintf == 1) {
179 		/* QDL mode */
180 		/* Gobi 2000 has a single altsetting, older ones have two */
181 		if (serial->interface->num_altsetting == 2)
182 			intf = &serial->interface->altsetting[1];
183 		else if (serial->interface->num_altsetting > 2)
184 			goto done;
185 
186 		if (intf->desc.bNumEndpoints == 2 &&
187 		    usb_endpoint_is_bulk_in(&intf->endpoint[0].desc) &&
188 		    usb_endpoint_is_bulk_out(&intf->endpoint[1].desc)) {
189 			dev_dbg(dev, "QDL port found\n");
190 
191 			if (serial->interface->num_altsetting == 1)
192 				retval = 0; /* Success */
193 			else
194 				altsetting = 1;
195 		}
196 		goto done;
197 
198 	}
199 
200 	/* default to enabling interface */
201 	altsetting = 0;
202 
203 	/*
204 	 * Composite mode; don't bind to the QMI/net interface as that
205 	 * gets handled by other drivers.
206 	 */
207 
208 	switch (id->driver_info) {
209 	case QCSERIAL_G1K:
210 		/*
211 		 * Gobi 1K USB layout:
212 		 * 0: DM/DIAG (use libqcdm from ModemManager for communication)
213 		 * 1: serial port (doesn't respond)
214 		 * 2: AT-capable modem port
215 		 * 3: QMI/net
216 		 */
217 		if (nintf < 3 || nintf > 4) {
218 			dev_err(dev, "unknown number of interfaces: %d\n", nintf);
219 			altsetting = -1;
220 			goto done;
221 		}
222 
223 		if (ifnum == 0) {
224 			dev_dbg(dev, "Gobi 1K DM/DIAG interface found\n");
225 			altsetting = 1;
226 		} else if (ifnum == 2)
227 			dev_dbg(dev, "Modem port found\n");
228 		else
229 			altsetting = -1;
230 		break;
231 	case QCSERIAL_G2K:
232 		/*
233 		 * Gobi 2K+ USB layout:
234 		 * 0: QMI/net
235 		 * 1: DM/DIAG (use libqcdm from ModemManager for communication)
236 		 * 2: AT-capable modem port
237 		 * 3: NMEA
238 		 */
239 		if (nintf < 3 || nintf > 4) {
240 			dev_err(dev, "unknown number of interfaces: %d\n", nintf);
241 			altsetting = -1;
242 			goto done;
243 		}
244 
245 		switch (ifnum) {
246 		case 0:
247 			/* Don't claim the QMI/net interface */
248 			altsetting = -1;
249 			break;
250 		case 1:
251 			dev_dbg(dev, "Gobi 2K+ DM/DIAG interface found\n");
252 			break;
253 		case 2:
254 			dev_dbg(dev, "Modem port found\n");
255 			break;
256 		case 3:
257 			/*
258 			 * NMEA (serial line 9600 8N1)
259 			 * # echo "\$GPS_START" > /dev/ttyUSBx
260 			 * # echo "\$GPS_STOP"  > /dev/ttyUSBx
261 			 */
262 			dev_dbg(dev, "Gobi 2K+ NMEA GPS interface found\n");
263 			break;
264 		}
265 		break;
266 	case QCSERIAL_SWI:
267 		/*
268 		 * Sierra Wireless layout:
269 		 * 0: DM/DIAG (use libqcdm from ModemManager for communication)
270 		 * 2: NMEA
271 		 * 3: AT-capable modem port
272 		 * 8: QMI/net
273 		 */
274 		switch (ifnum) {
275 		case 0:
276 			dev_dbg(dev, "DM/DIAG interface found\n");
277 			break;
278 		case 2:
279 			dev_dbg(dev, "NMEA GPS interface found\n");
280 			break;
281 		case 3:
282 			dev_dbg(dev, "Modem port found\n");
283 			break;
284 		default:
285 			/* don't claim any unsupported interface */
286 			altsetting = -1;
287 			break;
288 		}
289 		break;
290 	default:
291 		dev_err(dev, "unsupported device layout type: %lu\n",
292 			id->driver_info);
293 		break;
294 	}
295 
296 done:
297 	if (altsetting >= 0) {
298 		retval = usb_set_interface(serial->dev, ifnum, altsetting);
299 		if (retval < 0) {
300 			dev_err(dev,
301 				"Could not set interface, error %d\n",
302 				retval);
303 			retval = -ENODEV;
304 		}
305 	}
306 
307 	return retval;
308 }
309 
310 static int qc_attach(struct usb_serial *serial)
311 {
312 	struct usb_wwan_intf_private *data;
313 
314 	data = kzalloc(sizeof(*data), GFP_KERNEL);
315 	if (!data)
316 		return -ENOMEM;
317 
318 	spin_lock_init(&data->susp_lock);
319 
320 	usb_set_serial_data(serial, data);
321 
322 	return 0;
323 }
324 
325 static void qc_release(struct usb_serial *serial)
326 {
327 	struct usb_wwan_intf_private *priv = usb_get_serial_data(serial);
328 
329 	usb_set_serial_data(serial, NULL);
330 	kfree(priv);
331 }
332 
333 static struct usb_serial_driver qcdevice = {
334 	.driver = {
335 		.owner     = THIS_MODULE,
336 		.name      = "qcserial",
337 	},
338 	.description         = "Qualcomm USB modem",
339 	.id_table            = id_table,
340 	.num_ports           = 1,
341 	.probe               = qcprobe,
342 	.open		     = usb_wwan_open,
343 	.close		     = usb_wwan_close,
344 	.write		     = usb_wwan_write,
345 	.write_room	     = usb_wwan_write_room,
346 	.chars_in_buffer     = usb_wwan_chars_in_buffer,
347 	.attach              = qc_attach,
348 	.release	     = qc_release,
349 	.port_probe          = usb_wwan_port_probe,
350 	.port_remove	     = usb_wwan_port_remove,
351 #ifdef CONFIG_PM
352 	.suspend	     = usb_wwan_suspend,
353 	.resume		     = usb_wwan_resume,
354 #endif
355 };
356 
357 static struct usb_serial_driver * const serial_drivers[] = {
358 	&qcdevice, NULL
359 };
360 
361 module_usb_serial_driver(serial_drivers, id_table);
362 
363 MODULE_AUTHOR(DRIVER_AUTHOR);
364 MODULE_DESCRIPTION(DRIVER_DESC);
365 MODULE_LICENSE("GPL v2");
366