xref: /openbmc/linux/drivers/usb/serial/qcserial.c (revision ce932d0c5589e9766e089c22c66890dfc48fbd94)
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 struct usb_driver qcdriver = {
116 	.name			= "qcserial",
117 	.probe			= usb_serial_probe,
118 	.disconnect		= usb_serial_disconnect,
119 	.id_table		= id_table,
120 	.suspend		= usb_serial_suspend,
121 	.resume			= usb_serial_resume,
122 	.supports_autosuspend	= true,
123 };
124 
125 static int qcprobe(struct usb_serial *serial, const struct usb_device_id *id)
126 {
127 	struct usb_wwan_intf_private *data;
128 	struct usb_host_interface *intf = serial->interface->cur_altsetting;
129 	int retval = -ENODEV;
130 	__u8 nintf;
131 	__u8 ifnum;
132 	bool is_gobi1k = id->driver_info ? true : false;
133 
134 	dbg("%s", __func__);
135 	dbg("Is Gobi 1000 = %d", is_gobi1k);
136 
137 	nintf = serial->dev->actconfig->desc.bNumInterfaces;
138 	dbg("Num Interfaces = %d", nintf);
139 	ifnum = intf->desc.bInterfaceNumber;
140 	dbg("This Interface = %d", ifnum);
141 
142 	data = kzalloc(sizeof(struct usb_wwan_intf_private),
143 					 GFP_KERNEL);
144 	if (!data)
145 		return -ENOMEM;
146 
147 	spin_lock_init(&data->susp_lock);
148 
149 	switch (nintf) {
150 	case 1:
151 		/* QDL mode */
152 		/* Gobi 2000 has a single altsetting, older ones have two */
153 		if (serial->interface->num_altsetting == 2)
154 			intf = &serial->interface->altsetting[1];
155 		else if (serial->interface->num_altsetting > 2)
156 			break;
157 
158 		if (intf->desc.bNumEndpoints == 2 &&
159 		    usb_endpoint_is_bulk_in(&intf->endpoint[0].desc) &&
160 		    usb_endpoint_is_bulk_out(&intf->endpoint[1].desc)) {
161 			dbg("QDL port found");
162 
163 			if (serial->interface->num_altsetting == 1) {
164 				retval = 0; /* Success */
165 				break;
166 			}
167 
168 			retval = usb_set_interface(serial->dev, ifnum, 1);
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 		}
177 		break;
178 
179 	case 3:
180 	case 4:
181 		/* Composite mode; don't bind to the QMI/net interface as that
182 		 * gets handled by other drivers.
183 		 */
184 
185 		/* Gobi 1K USB layout:
186 		 * 0: serial port (doesn't respond)
187 		 * 1: serial port (doesn't respond)
188 		 * 2: AT-capable modem port
189 		 * 3: QMI/net
190 		 *
191 		 * Gobi 2K+ USB layout:
192 		 * 0: QMI/net
193 		 * 1: DM/DIAG (use libqcdm from ModemManager for communication)
194 		 * 2: AT-capable modem port
195 		 * 3: NMEA
196 		 */
197 
198 		if (ifnum == 1 && !is_gobi1k) {
199 			dbg("Gobi 2K+ DM/DIAG interface found");
200 			retval = usb_set_interface(serial->dev, ifnum, 0);
201 			if (retval < 0) {
202 				dev_err(&serial->dev->dev,
203 					"Could not set interface, error %d\n",
204 					retval);
205 				retval = -ENODEV;
206 				kfree(data);
207 			}
208 		} else if (ifnum == 2) {
209 			dbg("Modem port found");
210 			retval = usb_set_interface(serial->dev, ifnum, 0);
211 			if (retval < 0) {
212 				dev_err(&serial->dev->dev,
213 					"Could not set interface, error %d\n",
214 					retval);
215 				retval = -ENODEV;
216 				kfree(data);
217 			}
218 		} else if (ifnum==3 && !is_gobi1k) {
219 			/*
220 			 * NMEA (serial line 9600 8N1)
221 			 * # echo "\$GPS_START" > /dev/ttyUSBx
222 			 * # echo "\$GPS_STOP"  > /dev/ttyUSBx
223 			 */
224 			dbg("Gobi 2K+ NMEA GPS interface found");
225 			retval = usb_set_interface(serial->dev, ifnum, 0);
226 			if (retval < 0) {
227 				dev_err(&serial->dev->dev,
228 					"Could not set interface, error %d\n",
229 					retval);
230 				retval = -ENODEV;
231 				kfree(data);
232 			}
233 		}
234 		break;
235 
236 	default:
237 		dev_err(&serial->dev->dev,
238 			"unknown number of interfaces: %d\n", nintf);
239 		kfree(data);
240 		retval = -ENODEV;
241 	}
242 
243 	/* Set serial->private if not returning -ENODEV */
244 	if (retval != -ENODEV)
245 		usb_set_serial_data(serial, data);
246 	return retval;
247 }
248 
249 static void qc_release(struct usb_serial *serial)
250 {
251 	struct usb_wwan_intf_private *priv = usb_get_serial_data(serial);
252 
253 	dbg("%s", __func__);
254 
255 	/* Call usb_wwan release & free the private data allocated in qcprobe */
256 	usb_wwan_release(serial);
257 	usb_set_serial_data(serial, NULL);
258 	kfree(priv);
259 }
260 
261 static struct usb_serial_driver qcdevice = {
262 	.driver = {
263 		.owner     = THIS_MODULE,
264 		.name      = "qcserial",
265 	},
266 	.description         = "Qualcomm USB modem",
267 	.id_table            = id_table,
268 	.num_ports           = 1,
269 	.probe               = qcprobe,
270 	.open		     = usb_wwan_open,
271 	.close		     = usb_wwan_close,
272 	.write		     = usb_wwan_write,
273 	.write_room	     = usb_wwan_write_room,
274 	.chars_in_buffer     = usb_wwan_chars_in_buffer,
275 	.attach		     = usb_wwan_startup,
276 	.disconnect	     = usb_wwan_disconnect,
277 	.release	     = qc_release,
278 #ifdef CONFIG_PM
279 	.suspend	     = usb_wwan_suspend,
280 	.resume		     = usb_wwan_resume,
281 #endif
282 };
283 
284 static struct usb_serial_driver * const serial_drivers[] = {
285 	&qcdevice, NULL
286 };
287 
288 module_usb_serial_driver(qcdriver, serial_drivers);
289 
290 MODULE_AUTHOR(DRIVER_AUTHOR);
291 MODULE_DESCRIPTION(DRIVER_DESC);
292 MODULE_LICENSE("GPL v2");
293 
294 module_param(debug, bool, S_IRUGO | S_IWUSR);
295 MODULE_PARM_DESC(debug, "Debug enabled or not");
296