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