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