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