xref: /openbmc/linux/drivers/usb/serial/qcserial.c (revision 565d76cb)
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 
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 = serial->private = 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 				return 0;
139 
140 			retval = usb_set_interface(serial->dev, ifnum, 1);
141 			if (retval < 0) {
142 				dev_err(&serial->dev->dev,
143 					"Could not set interface, error %d\n",
144 					retval);
145 				retval = -ENODEV;
146 				kfree(data);
147 			}
148 			return retval;
149 		}
150 		break;
151 
152 	case 3:
153 	case 4:
154 		/* Composite mode */
155 		/* ifnum == 0 is a broadband network adapter */
156 		if (ifnum == 1) {
157 			/*
158 			 * Diagnostics Monitor (serial line 9600 8N1)
159 			 * Qualcomm DM protocol
160 			 * use "libqcdm" (ModemManager) for communication
161 			 */
162 			dbg("Diagnostics Monitor found");
163 			retval = usb_set_interface(serial->dev, ifnum, 0);
164 			if (retval < 0) {
165 				dev_err(&serial->dev->dev,
166 					"Could not set interface, error %d\n",
167 					retval);
168 				retval = -ENODEV;
169 			}
170 		} else if (ifnum == 2) {
171 			dbg("Modem port found");
172 			retval = usb_set_interface(serial->dev, ifnum, 0);
173 			if (retval < 0) {
174 				dev_err(&serial->dev->dev,
175 					"Could not set interface, error %d\n",
176 					retval);
177 				retval = -ENODEV;
178 				kfree(data);
179 			}
180 			return retval;
181 		} else if (ifnum==3) {
182 			/*
183 			 * NMEA (serial line 9600 8N1)
184 			 * # echo "\$GPS_START" > /dev/ttyUSBx
185 			 * # echo "\$GPS_STOP"  > /dev/ttyUSBx
186 			 */
187 			dbg("NMEA GPS interface found");
188 			retval = usb_set_interface(serial->dev, ifnum, 0);
189 			if (retval < 0) {
190 				dev_err(&serial->dev->dev,
191 					"Could not set interface, error %d\n",
192 					retval);
193 				retval = -ENODEV;
194 			}
195 		}
196 		break;
197 
198 	default:
199 		dev_err(&serial->dev->dev,
200 			"unknown number of interfaces: %d\n", nintf);
201 		kfree(data);
202 		return -ENODEV;
203 	}
204 
205 	return retval;
206 }
207 
208 static struct usb_serial_driver qcdevice = {
209 	.driver = {
210 		.owner     = THIS_MODULE,
211 		.name      = "qcserial",
212 	},
213 	.description         = "Qualcomm USB modem",
214 	.id_table            = id_table,
215 	.usb_driver          = &qcdriver,
216 	.num_ports           = 1,
217 	.probe               = qcprobe,
218 	.open		     = usb_wwan_open,
219 	.close		     = usb_wwan_close,
220 	.write		     = usb_wwan_write,
221 	.write_room	     = usb_wwan_write_room,
222 	.chars_in_buffer     = usb_wwan_chars_in_buffer,
223 	.attach		     = usb_wwan_startup,
224 	.disconnect	     = usb_wwan_disconnect,
225 	.release	     = usb_wwan_release,
226 #ifdef CONFIG_PM
227 	.suspend	     = usb_wwan_suspend,
228 	.resume		     = usb_wwan_resume,
229 #endif
230 };
231 
232 static int __init qcinit(void)
233 {
234 	int retval;
235 
236 	retval = usb_serial_register(&qcdevice);
237 	if (retval)
238 		return retval;
239 
240 	retval = usb_register(&qcdriver);
241 	if (retval) {
242 		usb_serial_deregister(&qcdevice);
243 		return retval;
244 	}
245 
246 	return 0;
247 }
248 
249 static void __exit qcexit(void)
250 {
251 	usb_deregister(&qcdriver);
252 	usb_serial_deregister(&qcdevice);
253 }
254 
255 module_init(qcinit);
256 module_exit(qcexit);
257 
258 MODULE_AUTHOR(DRIVER_AUTHOR);
259 MODULE_DESCRIPTION(DRIVER_DESC);
260 MODULE_LICENSE("GPL v2");
261 
262 module_param(debug, bool, S_IRUGO | S_IWUSR);
263 MODULE_PARM_DESC(debug, "Debug enabled or not");
264