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