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