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