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