xref: /linux/drivers/usb/serial/option.c (revision a5766f11cfd3a0c03450d99c8fe548c2940be884)
1 /*
2   USB Driver for GSM modems
3 
4   Copyright (C) 2005  Matthias Urlichs <smurf@smurf.noris.de>
5 
6   This driver is free software; you can redistribute it and/or modify
7   it under the terms of Version 2 of the GNU General Public License as
8   published by the Free Software Foundation.
9 
10   Portions copied from the Keyspan driver by Hugh Blemings <hugh@blemings.org>
11 
12   History: see the git log.
13 
14   Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
15 
16   This driver exists because the "normal" serial driver doesn't work too well
17   with GSM modems. Issues:
18   - data loss -- one single Receive URB is not nearly enough
19   - nonstandard flow (Option devices) control
20   - controlling the baud rate doesn't make sense
21 
22   This driver is named "option" because the most common device it's
23   used for is a PC-Card (with an internal OHCI-USB interface, behind
24   which the GSM interface sits), made by Option Inc.
25 
26   Some of the "one port" devices actually exhibit multiple USB instances
27   on the USB bus. This is not a bug, these ports are used for different
28   device features.
29 */
30 
31 #define DRIVER_VERSION "v0.7.2"
32 #define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
33 #define DRIVER_DESC "USB Driver for GSM modems"
34 
35 #include <linux/kernel.h>
36 #include <linux/jiffies.h>
37 #include <linux/errno.h>
38 #include <linux/tty.h>
39 #include <linux/tty_flip.h>
40 #include <linux/module.h>
41 #include <linux/bitops.h>
42 #include <linux/usb.h>
43 #include <linux/usb/serial.h>
44 
45 /* Function prototypes */
46 static int  option_open(struct tty_struct *tty, struct usb_serial_port *port,
47 							struct file *filp);
48 static void option_close(struct tty_struct *tty, struct usb_serial_port *port,
49 							struct file *filp);
50 static int  option_startup(struct usb_serial *serial);
51 static void option_shutdown(struct usb_serial *serial);
52 static int  option_write_room(struct tty_struct *tty);
53 
54 static void option_instat_callback(struct urb *urb);
55 
56 static int option_write(struct tty_struct *tty, struct usb_serial_port *port,
57 			const unsigned char *buf, int count);
58 static int  option_chars_in_buffer(struct tty_struct *tty);
59 static void option_set_termios(struct tty_struct *tty,
60 			struct usb_serial_port *port, struct ktermios *old);
61 static int  option_tiocmget(struct tty_struct *tty, struct file *file);
62 static int  option_tiocmset(struct tty_struct *tty, struct file *file,
63 				unsigned int set, unsigned int clear);
64 static int  option_send_setup(struct tty_struct *tty, struct usb_serial_port *port);
65 
66 /* Vendor and product IDs */
67 #define OPTION_VENDOR_ID			0x0AF0
68 #define OPTION_PRODUCT_COLT			0x5000
69 #define OPTION_PRODUCT_RICOLA			0x6000
70 #define OPTION_PRODUCT_RICOLA_LIGHT		0x6100
71 #define OPTION_PRODUCT_RICOLA_QUAD		0x6200
72 #define OPTION_PRODUCT_RICOLA_QUAD_LIGHT	0x6300
73 #define OPTION_PRODUCT_RICOLA_NDIS		0x6050
74 #define OPTION_PRODUCT_RICOLA_NDIS_LIGHT	0x6150
75 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD		0x6250
76 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT	0x6350
77 #define OPTION_PRODUCT_COBRA			0x6500
78 #define OPTION_PRODUCT_COBRA_BUS		0x6501
79 #define OPTION_PRODUCT_VIPER			0x6600
80 #define OPTION_PRODUCT_VIPER_BUS		0x6601
81 #define OPTION_PRODUCT_GT_MAX_READY		0x6701
82 #define OPTION_PRODUCT_GT_MAX			0x6711
83 #define OPTION_PRODUCT_FUJI_MODEM_LIGHT		0x6721
84 #define OPTION_PRODUCT_FUJI_MODEM_GT		0x6741
85 #define OPTION_PRODUCT_FUJI_MODEM_EX		0x6761
86 #define OPTION_PRODUCT_FUJI_NETWORK_LIGHT	0x6731
87 #define OPTION_PRODUCT_FUJI_NETWORK_GT		0x6751
88 #define OPTION_PRODUCT_FUJI_NETWORK_EX		0x6771
89 #define OPTION_PRODUCT_KOI_MODEM		0x6800
90 #define OPTION_PRODUCT_KOI_NETWORK		0x6811
91 #define OPTION_PRODUCT_SCORPION_MODEM		0x6901
92 #define OPTION_PRODUCT_SCORPION_NETWORK		0x6911
93 #define OPTION_PRODUCT_ETNA_MODEM		0x7001
94 #define OPTION_PRODUCT_ETNA_NETWORK		0x7011
95 #define OPTION_PRODUCT_ETNA_MODEM_LITE		0x7021
96 #define OPTION_PRODUCT_ETNA_MODEM_GT		0x7041
97 #define OPTION_PRODUCT_ETNA_MODEM_EX		0x7061
98 #define OPTION_PRODUCT_ETNA_NETWORK_LITE	0x7031
99 #define OPTION_PRODUCT_ETNA_NETWORK_GT		0x7051
100 #define OPTION_PRODUCT_ETNA_NETWORK_EX		0x7071
101 #define OPTION_PRODUCT_ETNA_KOI_MODEM		0x7100
102 #define OPTION_PRODUCT_ETNA_KOI_NETWORK		0x7111
103 
104 #define HUAWEI_VENDOR_ID			0x12D1
105 #define HUAWEI_PRODUCT_E600			0x1001
106 #define HUAWEI_PRODUCT_E220			0x1003
107 #define HUAWEI_PRODUCT_E220BIS			0x1004
108 #define HUAWEI_PRODUCT_E1401			0x1401
109 #define HUAWEI_PRODUCT_E1403			0x1403
110 #define HUAWEI_PRODUCT_E1405			0x1405
111 #define HUAWEI_PRODUCT_E1406			0x1406
112 #define HUAWEI_PRODUCT_E1408			0x1408
113 #define HUAWEI_PRODUCT_E1409			0x1409
114 #define HUAWEI_PRODUCT_E1410			0x1410
115 #define HUAWEI_PRODUCT_E1411			0x1411
116 #define HUAWEI_PRODUCT_E1412			0x1412
117 #define HUAWEI_PRODUCT_E1413			0x1413
118 #define HUAWEI_PRODUCT_E1414			0x1414
119 #define HUAWEI_PRODUCT_E1415			0x1415
120 #define HUAWEI_PRODUCT_E1416			0x1416
121 #define HUAWEI_PRODUCT_E1417			0x1417
122 #define HUAWEI_PRODUCT_E1418			0x1418
123 #define HUAWEI_PRODUCT_E1419			0x1419
124 
125 #define NOVATELWIRELESS_VENDOR_ID		0x1410
126 
127 /* MERLIN EVDO PRODUCTS */
128 #define NOVATELWIRELESS_PRODUCT_V640		0x1100
129 #define NOVATELWIRELESS_PRODUCT_V620		0x1110
130 #define NOVATELWIRELESS_PRODUCT_V740		0x1120
131 #define NOVATELWIRELESS_PRODUCT_V720		0x1130
132 
133 /* MERLIN HSDPA/HSPA PRODUCTS */
134 #define NOVATELWIRELESS_PRODUCT_U730		0x1400
135 #define NOVATELWIRELESS_PRODUCT_U740		0x1410
136 #define NOVATELWIRELESS_PRODUCT_U870		0x1420
137 #define NOVATELWIRELESS_PRODUCT_XU870		0x1430
138 #define NOVATELWIRELESS_PRODUCT_X950D		0x1450
139 
140 /* EXPEDITE PRODUCTS */
141 #define NOVATELWIRELESS_PRODUCT_EV620		0x2100
142 #define NOVATELWIRELESS_PRODUCT_ES720		0x2110
143 #define NOVATELWIRELESS_PRODUCT_E725		0x2120
144 #define NOVATELWIRELESS_PRODUCT_ES620		0x2130
145 #define NOVATELWIRELESS_PRODUCT_EU730		0x2400
146 #define NOVATELWIRELESS_PRODUCT_EU740		0x2410
147 #define NOVATELWIRELESS_PRODUCT_EU870D		0x2420
148 
149 /* OVATION PRODUCTS */
150 #define NOVATELWIRELESS_PRODUCT_MC727		0x4100
151 #define NOVATELWIRELESS_PRODUCT_MC950D		0x4400
152 
153 /* FUTURE NOVATEL PRODUCTS */
154 #define NOVATELWIRELESS_PRODUCT_EVDO_1		0x6000
155 #define NOVATELWIRELESS_PRODUCT_HSPA_1		0x7000
156 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_1	0x8000
157 #define NOVATELWIRELESS_PRODUCT_GLOBAL_1	0x9000
158 #define NOVATELWIRELESS_PRODUCT_EVDO_2		0x6001
159 #define NOVATELWIRELESS_PRODUCT_HSPA_2		0x7001
160 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_2	0x8001
161 #define NOVATELWIRELESS_PRODUCT_GLOBAL_2	0x9001
162 
163 /* AMOI PRODUCTS */
164 #define AMOI_VENDOR_ID				0x1614
165 #define AMOI_PRODUCT_H01			0x0800
166 #define AMOI_PRODUCT_H01A			0x7002
167 #define AMOI_PRODUCT_H02			0x0802
168 
169 #define DELL_VENDOR_ID				0x413C
170 
171 #define KYOCERA_VENDOR_ID			0x0c88
172 #define KYOCERA_PRODUCT_KPC650			0x17da
173 #define KYOCERA_PRODUCT_KPC680			0x180a
174 
175 #define ANYDATA_VENDOR_ID			0x16d5
176 #define ANYDATA_PRODUCT_ADU_620UW		0x6202
177 #define ANYDATA_PRODUCT_ADU_E100A		0x6501
178 #define ANYDATA_PRODUCT_ADU_500A		0x6502
179 
180 #define AXESSTEL_VENDOR_ID			0x1726
181 #define AXESSTEL_PRODUCT_MV110H			0x1000
182 
183 #define ONDA_VENDOR_ID				0x19d2
184 #define ONDA_PRODUCT_MSA501HS			0x0001
185 #define ONDA_PRODUCT_ET502HS			0x0002
186 
187 #define BANDRICH_VENDOR_ID			0x1A8D
188 #define BANDRICH_PRODUCT_C100_1			0x1002
189 #define BANDRICH_PRODUCT_C100_2			0x1003
190 #define BANDRICH_PRODUCT_1004			0x1004
191 #define BANDRICH_PRODUCT_1005			0x1005
192 #define BANDRICH_PRODUCT_1006			0x1006
193 #define BANDRICH_PRODUCT_1007			0x1007
194 #define BANDRICH_PRODUCT_1008			0x1008
195 #define BANDRICH_PRODUCT_1009			0x1009
196 #define BANDRICH_PRODUCT_100A			0x100a
197 
198 #define BANDRICH_PRODUCT_100B			0x100b
199 #define BANDRICH_PRODUCT_100C			0x100c
200 #define BANDRICH_PRODUCT_100D			0x100d
201 #define BANDRICH_PRODUCT_100E			0x100e
202 
203 #define BANDRICH_PRODUCT_100F			0x100f
204 #define BANDRICH_PRODUCT_1010			0x1010
205 #define BANDRICH_PRODUCT_1011			0x1011
206 #define BANDRICH_PRODUCT_1012			0x1012
207 
208 #define AMOI_VENDOR_ID			0x1614
209 #define AMOI_PRODUCT_9508			0x0800
210 
211 #define QUALCOMM_VENDOR_ID			0x05C6
212 
213 #define MAXON_VENDOR_ID				0x16d8
214 
215 #define TELIT_VENDOR_ID				0x1bc7
216 #define TELIT_PRODUCT_UC864E			0x1003
217 
218 /* ZTE PRODUCTS */
219 #define ZTE_VENDOR_ID				0x19d2
220 #define ZTE_PRODUCT_MF628			0x0015
221 #define ZTE_PRODUCT_CDMA_TECH			0xfffe
222 
223 static struct usb_device_id option_ids[] = {
224 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
225 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
226 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
227 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
228 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
229 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
230 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
231 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
232 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
233 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
234 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
235 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
236 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
237 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
238 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
239 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
240 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
241 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
242 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
243 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
244 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
245 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
246 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
247 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
248 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
249 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
250 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
251 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
252 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
253 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
254 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
255 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
256 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
257 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
258 	{ USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
259 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600, 0xff, 0xff, 0xff) },
260 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
261 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
262 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401, 0xff, 0xff, 0xff) },
263 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403, 0xff, 0xff, 0xff) },
264 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405, 0xff, 0xff, 0xff) },
265 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406, 0xff, 0xff, 0xff) },
266 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408, 0xff, 0xff, 0xff) },
267 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409, 0xff, 0xff, 0xff) },
268 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410, 0xff, 0xff, 0xff) },
269 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411, 0xff, 0xff, 0xff) },
270 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412, 0xff, 0xff, 0xff) },
271 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413, 0xff, 0xff, 0xff) },
272 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414, 0xff, 0xff, 0xff) },
273 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415, 0xff, 0xff, 0xff) },
274 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416, 0xff, 0xff, 0xff) },
275 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417, 0xff, 0xff, 0xff) },
276 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418, 0xff, 0xff, 0xff) },
277 	{ USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419, 0xff, 0xff, 0xff) },
278 	{ USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
279 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
280 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
281 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
282 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
283 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
284 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
285 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
286 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
287 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
288 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
289 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
290 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
291 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
292 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
293 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
294 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
295 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
296 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
297 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
298 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
299 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
300 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
301 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
302 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
303 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
304 	{ USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
305 
306 	{ USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01) },
307 	{ USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01A) },
308 	{ USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H02) },
309 
310 	{ USB_DEVICE(DELL_VENDOR_ID, 0x8114) },	/* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
311 	{ USB_DEVICE(DELL_VENDOR_ID, 0x8115) },	/* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
312 	{ USB_DEVICE(DELL_VENDOR_ID, 0x8116) },	/* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
313 	{ USB_DEVICE(DELL_VENDOR_ID, 0x8117) },	/* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
314 	{ USB_DEVICE(DELL_VENDOR_ID, 0x8118) },	/* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
315 	{ USB_DEVICE(DELL_VENDOR_ID, 0x8128) },	/* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
316 	{ USB_DEVICE(DELL_VENDOR_ID, 0x8129) },	/* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
317 	{ USB_DEVICE(DELL_VENDOR_ID, 0x8133) }, /* Dell Wireless 5720 == Novatel EV620 CDMA/EV-DO */
318 	{ USB_DEVICE(DELL_VENDOR_ID, 0x8136) },	/* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
319 	{ USB_DEVICE(DELL_VENDOR_ID, 0x8137) },	/* Dell Wireless HSDPA 5520 */
320 	{ USB_DEVICE(DELL_VENDOR_ID, 0x8138) },	/* Dell Wireless 5520 Voda I Mobile Broadband (3G HSDPA) Minicard */
321 	{ USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
322 	{ USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
323 	{ USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_620UW) },
324 	{ USB_DEVICE(AXESSTEL_VENDOR_ID, AXESSTEL_PRODUCT_MV110H) },
325 	{ USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_MSA501HS) },
326 	{ USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_ET502HS) },
327 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
328 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
329 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1004) },
330 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1005) },
331 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1006) },
332 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1007) },
333 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1008) },
334 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1009) },
335 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100A) },
336 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100B) },
337 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100C) },
338 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100D) },
339 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100E) },
340 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100F) },
341 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1010) },
342 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1011) },
343 	{ USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1012) },
344 	{ USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC650) },
345 	{ USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
346 	{ USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6000)}, /* ZTE AC8700 */
347 	{ USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
348 	{ USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
349 	{ USB_DEVICE(TELIT_VENDOR_ID, TELIT_PRODUCT_UC864E) },
350 	{ USB_DEVICE(ZTE_VENDOR_ID, ZTE_PRODUCT_MF628) },
351 	{ USB_DEVICE(ZTE_VENDOR_ID, ZTE_PRODUCT_CDMA_TECH) },
352 	{ } /* Terminating entry */
353 };
354 MODULE_DEVICE_TABLE(usb, option_ids);
355 
356 static struct usb_driver option_driver = {
357 	.name       = "option",
358 	.probe      = usb_serial_probe,
359 	.disconnect = usb_serial_disconnect,
360 	.id_table   = option_ids,
361 	.no_dynamic_id = 	1,
362 };
363 
364 /* The card has three separate interfaces, which the serial driver
365  * recognizes separately, thus num_port=1.
366  */
367 
368 static struct usb_serial_driver option_1port_device = {
369 	.driver = {
370 		.owner =	THIS_MODULE,
371 		.name =		"option1",
372 	},
373 	.description       = "GSM modem (1-port)",
374 	.usb_driver        = &option_driver,
375 	.id_table          = option_ids,
376 	.num_ports         = 1,
377 	.open              = option_open,
378 	.close             = option_close,
379 	.write             = option_write,
380 	.write_room        = option_write_room,
381 	.chars_in_buffer   = option_chars_in_buffer,
382 	.set_termios       = option_set_termios,
383 	.tiocmget          = option_tiocmget,
384 	.tiocmset          = option_tiocmset,
385 	.attach            = option_startup,
386 	.shutdown          = option_shutdown,
387 	.read_int_callback = option_instat_callback,
388 };
389 
390 static int debug;
391 
392 /* per port private data */
393 
394 #define N_IN_URB 4
395 #define N_OUT_URB 1
396 #define IN_BUFLEN 4096
397 #define OUT_BUFLEN 128
398 
399 struct option_port_private {
400 	/* Input endpoints and buffer for this port */
401 	struct urb *in_urbs[N_IN_URB];
402 	u8 *in_buffer[N_IN_URB];
403 	/* Output endpoints and buffer for this port */
404 	struct urb *out_urbs[N_OUT_URB];
405 	u8 *out_buffer[N_OUT_URB];
406 	unsigned long out_busy;		/* Bit vector of URBs in use */
407 
408 	/* Settings for the port */
409 	int rts_state;	/* Handshaking pins (outputs) */
410 	int dtr_state;
411 	int cts_state;	/* Handshaking pins (inputs) */
412 	int dsr_state;
413 	int dcd_state;
414 	int ri_state;
415 
416 	unsigned long tx_start_time[N_OUT_URB];
417 };
418 
419 /* Functions used by new usb-serial code. */
420 static int __init option_init(void)
421 {
422 	int retval;
423 	retval = usb_serial_register(&option_1port_device);
424 	if (retval)
425 		goto failed_1port_device_register;
426 	retval = usb_register(&option_driver);
427 	if (retval)
428 		goto failed_driver_register;
429 
430 	info(DRIVER_DESC ": " DRIVER_VERSION);
431 
432 	return 0;
433 
434 failed_driver_register:
435 	usb_serial_deregister(&option_1port_device);
436 failed_1port_device_register:
437 	return retval;
438 }
439 
440 static void __exit option_exit(void)
441 {
442 	usb_deregister(&option_driver);
443 	usb_serial_deregister(&option_1port_device);
444 }
445 
446 module_init(option_init);
447 module_exit(option_exit);
448 
449 static void option_set_termios(struct tty_struct *tty,
450 		struct usb_serial_port *port, struct ktermios *old_termios)
451 {
452 	dbg("%s", __func__);
453 	/* Doesn't support option setting */
454 	tty_termios_copy_hw(tty->termios, old_termios);
455 	option_send_setup(tty, port);
456 }
457 
458 static int option_tiocmget(struct tty_struct *tty, struct file *file)
459 {
460 	struct usb_serial_port *port = tty->driver_data;
461 	unsigned int value;
462 	struct option_port_private *portdata;
463 
464 	portdata = usb_get_serial_port_data(port);
465 
466 	value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
467 		((portdata->dtr_state) ? TIOCM_DTR : 0) |
468 		((portdata->cts_state) ? TIOCM_CTS : 0) |
469 		((portdata->dsr_state) ? TIOCM_DSR : 0) |
470 		((portdata->dcd_state) ? TIOCM_CAR : 0) |
471 		((portdata->ri_state) ? TIOCM_RNG : 0);
472 
473 	return value;
474 }
475 
476 static int option_tiocmset(struct tty_struct *tty, struct file *file,
477 			unsigned int set, unsigned int clear)
478 {
479 	struct usb_serial_port *port = tty->driver_data;
480 	struct option_port_private *portdata;
481 
482 	portdata = usb_get_serial_port_data(port);
483 
484 	/* FIXME: what locks portdata fields ? */
485 	if (set & TIOCM_RTS)
486 		portdata->rts_state = 1;
487 	if (set & TIOCM_DTR)
488 		portdata->dtr_state = 1;
489 
490 	if (clear & TIOCM_RTS)
491 		portdata->rts_state = 0;
492 	if (clear & TIOCM_DTR)
493 		portdata->dtr_state = 0;
494 	return option_send_setup(tty, port);
495 }
496 
497 /* Write */
498 static int option_write(struct tty_struct *tty, struct usb_serial_port *port,
499 			const unsigned char *buf, int count)
500 {
501 	struct option_port_private *portdata;
502 	int i;
503 	int left, todo;
504 	struct urb *this_urb = NULL; /* spurious */
505 	int err;
506 
507 	portdata = usb_get_serial_port_data(port);
508 
509 	dbg("%s: write (%d chars)", __func__, count);
510 
511 	i = 0;
512 	left = count;
513 	for (i = 0; left > 0 && i < N_OUT_URB; i++) {
514 		todo = left;
515 		if (todo > OUT_BUFLEN)
516 			todo = OUT_BUFLEN;
517 
518 		this_urb = portdata->out_urbs[i];
519 		if (test_and_set_bit(i, &portdata->out_busy)) {
520 			if (time_before(jiffies,
521 					portdata->tx_start_time[i] + 10 * HZ))
522 				continue;
523 			usb_unlink_urb(this_urb);
524 			continue;
525 		}
526 		if (this_urb->status != 0)
527 			dbg("usb_write %p failed (err=%d)",
528 				this_urb, this_urb->status);
529 
530 		dbg("%s: endpoint %d buf %d", __func__,
531 			usb_pipeendpoint(this_urb->pipe), i);
532 
533 		/* send the data */
534 		memcpy(this_urb->transfer_buffer, buf, todo);
535 		this_urb->transfer_buffer_length = todo;
536 
537 		this_urb->dev = port->serial->dev;
538 		err = usb_submit_urb(this_urb, GFP_ATOMIC);
539 		if (err) {
540 			dbg("usb_submit_urb %p (write bulk) failed "
541 				"(%d, has %d)", this_urb,
542 				err, this_urb->status);
543 			clear_bit(i, &portdata->out_busy);
544 			continue;
545 		}
546 		portdata->tx_start_time[i] = jiffies;
547 		buf += todo;
548 		left -= todo;
549 	}
550 
551 	count -= left;
552 	dbg("%s: wrote (did %d)", __func__, count);
553 	return count;
554 }
555 
556 static void option_indat_callback(struct urb *urb)
557 {
558 	int err;
559 	int endpoint;
560 	struct usb_serial_port *port;
561 	struct tty_struct *tty;
562 	unsigned char *data = urb->transfer_buffer;
563 	int status = urb->status;
564 
565 	dbg("%s: %p", __func__, urb);
566 
567 	endpoint = usb_pipeendpoint(urb->pipe);
568 	port =  urb->context;
569 
570 	if (status) {
571 		dbg("%s: nonzero status: %d on endpoint %02x.",
572 		    __func__, status, endpoint);
573 	} else {
574 		tty = tty_port_tty_get(&port->port);
575 		if (urb->actual_length) {
576 			tty_buffer_request_room(tty, urb->actual_length);
577 			tty_insert_flip_string(tty, data, urb->actual_length);
578 			tty_flip_buffer_push(tty);
579 		} else
580 			dbg("%s: empty read urb received", __func__);
581 		tty_kref_put(tty);
582 
583 		/* Resubmit urb so we continue receiving */
584 		if (port->port.count && status != -ESHUTDOWN) {
585 			err = usb_submit_urb(urb, GFP_ATOMIC);
586 			if (err)
587 				printk(KERN_ERR "%s: resubmit read urb failed. "
588 					"(%d)", __func__, err);
589 		}
590 	}
591 	return;
592 }
593 
594 static void option_outdat_callback(struct urb *urb)
595 {
596 	struct usb_serial_port *port;
597 	struct option_port_private *portdata;
598 	int i;
599 
600 	dbg("%s", __func__);
601 
602 	port =  urb->context;
603 
604 	usb_serial_port_softint(port);
605 
606 	portdata = usb_get_serial_port_data(port);
607 	for (i = 0; i < N_OUT_URB; ++i) {
608 		if (portdata->out_urbs[i] == urb) {
609 			smp_mb__before_clear_bit();
610 			clear_bit(i, &portdata->out_busy);
611 			break;
612 		}
613 	}
614 }
615 
616 static void option_instat_callback(struct urb *urb)
617 {
618 	int err;
619 	int status = urb->status;
620 	struct usb_serial_port *port =  urb->context;
621 	struct option_port_private *portdata = usb_get_serial_port_data(port);
622 	struct usb_serial *serial = port->serial;
623 
624 	dbg("%s", __func__);
625 	dbg("%s: urb %p port %p has data %p", __func__, urb, port, portdata);
626 
627 	if (status == 0) {
628 		struct usb_ctrlrequest *req_pkt =
629 				(struct usb_ctrlrequest *)urb->transfer_buffer;
630 
631 		if (!req_pkt) {
632 			dbg("%s: NULL req_pkt\n", __func__);
633 			return;
634 		}
635 		if ((req_pkt->bRequestType == 0xA1) &&
636 				(req_pkt->bRequest == 0x20)) {
637 			int old_dcd_state;
638 			unsigned char signals = *((unsigned char *)
639 					urb->transfer_buffer +
640 					sizeof(struct usb_ctrlrequest));
641 
642 			dbg("%s: signal x%x", __func__, signals);
643 
644 			old_dcd_state = portdata->dcd_state;
645 			portdata->cts_state = 1;
646 			portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
647 			portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
648 			portdata->ri_state = ((signals & 0x08) ? 1 : 0);
649 
650 			if (old_dcd_state && !portdata->dcd_state) {
651 				struct tty_struct *tty =
652 						tty_port_tty_get(&port->port);
653 				if (tty && !C_CLOCAL(tty))
654 					tty_hangup(tty);
655 				tty_kref_put(tty);
656 			}
657 		} else {
658 			dbg("%s: type %x req %x", __func__,
659 				req_pkt->bRequestType, req_pkt->bRequest);
660 		}
661 	} else
662 		dbg("%s: error %d", __func__, status);
663 
664 	/* Resubmit urb so we continue receiving IRQ data */
665 	if (status != -ESHUTDOWN) {
666 		urb->dev = serial->dev;
667 		err = usb_submit_urb(urb, GFP_ATOMIC);
668 		if (err)
669 			dbg("%s: resubmit intr urb failed. (%d)",
670 				__func__, err);
671 	}
672 }
673 
674 static int option_write_room(struct tty_struct *tty)
675 {
676 	struct usb_serial_port *port = tty->driver_data;
677 	struct option_port_private *portdata;
678 	int i;
679 	int data_len = 0;
680 	struct urb *this_urb;
681 
682 	portdata = usb_get_serial_port_data(port);
683 
684 
685 	for (i = 0; i < N_OUT_URB; i++) {
686 		this_urb = portdata->out_urbs[i];
687 		if (this_urb && !test_bit(i, &portdata->out_busy))
688 			data_len += OUT_BUFLEN;
689 	}
690 
691 	dbg("%s: %d", __func__, data_len);
692 	return data_len;
693 }
694 
695 static int option_chars_in_buffer(struct tty_struct *tty)
696 {
697 	struct usb_serial_port *port = tty->driver_data;
698 	struct option_port_private *portdata;
699 	int i;
700 	int data_len = 0;
701 	struct urb *this_urb;
702 
703 	portdata = usb_get_serial_port_data(port);
704 
705 	for (i = 0; i < N_OUT_URB; i++) {
706 		this_urb = portdata->out_urbs[i];
707 		/* FIXME: This locking is insufficient as this_urb may
708 		   go unused during the test */
709 		if (this_urb && test_bit(i, &portdata->out_busy))
710 			data_len += this_urb->transfer_buffer_length;
711 	}
712 	dbg("%s: %d", __func__, data_len);
713 	return data_len;
714 }
715 
716 static int option_open(struct tty_struct *tty,
717 			struct usb_serial_port *port, struct file *filp)
718 {
719 	struct option_port_private *portdata;
720 	struct usb_serial *serial = port->serial;
721 	int i, err;
722 	struct urb *urb;
723 
724 	portdata = usb_get_serial_port_data(port);
725 
726 	dbg("%s", __func__);
727 
728 	/* Set some sane defaults */
729 	portdata->rts_state = 1;
730 	portdata->dtr_state = 1;
731 
732 	/* Reset low level data toggle and start reading from endpoints */
733 	for (i = 0; i < N_IN_URB; i++) {
734 		urb = portdata->in_urbs[i];
735 		if (!urb)
736 			continue;
737 		if (urb->dev != serial->dev) {
738 			dbg("%s: dev %p != %p", __func__,
739 				urb->dev, serial->dev);
740 			continue;
741 		}
742 
743 		/*
744 		 * make sure endpoint data toggle is synchronized with the
745 		 * device
746 		 */
747 		usb_clear_halt(urb->dev, urb->pipe);
748 
749 		err = usb_submit_urb(urb, GFP_KERNEL);
750 		if (err) {
751 			dbg("%s: submit urb %d failed (%d) %d",
752 				__func__, i, err,
753 				urb->transfer_buffer_length);
754 		}
755 	}
756 
757 	/* Reset low level data toggle on out endpoints */
758 	for (i = 0; i < N_OUT_URB; i++) {
759 		urb = portdata->out_urbs[i];
760 		if (!urb)
761 			continue;
762 		urb->dev = serial->dev;
763 		/* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
764 				usb_pipeout(urb->pipe), 0); */
765 	}
766 
767 	if (tty)
768 		tty->low_latency = 1;
769 
770 	option_send_setup(tty, port);
771 
772 	return 0;
773 }
774 
775 static void option_close(struct tty_struct *tty,
776 			struct usb_serial_port *port, struct file *filp)
777 {
778 	int i;
779 	struct usb_serial *serial = port->serial;
780 	struct option_port_private *portdata;
781 
782 	dbg("%s", __func__);
783 	portdata = usb_get_serial_port_data(port);
784 
785 	portdata->rts_state = 0;
786 	portdata->dtr_state = 0;
787 
788 	if (serial->dev) {
789 		mutex_lock(&serial->disc_mutex);
790 		if (!serial->disconnected)
791 			option_send_setup(tty, port);
792 		mutex_unlock(&serial->disc_mutex);
793 
794 		/* Stop reading/writing urbs */
795 		for (i = 0; i < N_IN_URB; i++)
796 			usb_kill_urb(portdata->in_urbs[i]);
797 		for (i = 0; i < N_OUT_URB; i++)
798 			usb_kill_urb(portdata->out_urbs[i]);
799 	}
800 	tty_port_tty_set(&port->port, NULL);
801 }
802 
803 /* Helper functions used by option_setup_urbs */
804 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
805 		int dir, void *ctx, char *buf, int len,
806 		void (*callback)(struct urb *))
807 {
808 	struct urb *urb;
809 
810 	if (endpoint == -1)
811 		return NULL;		/* endpoint not needed */
812 
813 	urb = usb_alloc_urb(0, GFP_KERNEL);		/* No ISO */
814 	if (urb == NULL) {
815 		dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
816 		return NULL;
817 	}
818 
819 		/* Fill URB using supplied data. */
820 	usb_fill_bulk_urb(urb, serial->dev,
821 		      usb_sndbulkpipe(serial->dev, endpoint) | dir,
822 		      buf, len, callback, ctx);
823 
824 	return urb;
825 }
826 
827 /* Setup urbs */
828 static void option_setup_urbs(struct usb_serial *serial)
829 {
830 	int i, j;
831 	struct usb_serial_port *port;
832 	struct option_port_private *portdata;
833 
834 	dbg("%s", __func__);
835 
836 	for (i = 0; i < serial->num_ports; i++) {
837 		port = serial->port[i];
838 		portdata = usb_get_serial_port_data(port);
839 
840 		/* Do indat endpoints first */
841 		for (j = 0; j < N_IN_URB; ++j) {
842 			portdata->in_urbs[j] = option_setup_urb(serial,
843 					port->bulk_in_endpointAddress,
844 					USB_DIR_IN, port,
845 					portdata->in_buffer[j],
846 					IN_BUFLEN, option_indat_callback);
847 		}
848 
849 		/* outdat endpoints */
850 		for (j = 0; j < N_OUT_URB; ++j) {
851 			portdata->out_urbs[j] = option_setup_urb(serial,
852 					port->bulk_out_endpointAddress,
853 					USB_DIR_OUT, port,
854 					portdata->out_buffer[j],
855 					OUT_BUFLEN, option_outdat_callback);
856 		}
857 	}
858 }
859 
860 
861 /** send RTS/DTR state to the port.
862  *
863  * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
864  * CDC.
865 */
866 static int option_send_setup(struct tty_struct *tty,
867 						struct usb_serial_port *port)
868 {
869 	struct usb_serial *serial = port->serial;
870 	struct option_port_private *portdata;
871 	int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
872 	dbg("%s", __func__);
873 
874 	portdata = usb_get_serial_port_data(port);
875 
876 	if (tty) {
877 		int val = 0;
878 		if (portdata->dtr_state)
879 			val |= 0x01;
880 		if (portdata->rts_state)
881 			val |= 0x02;
882 
883 		return usb_control_msg(serial->dev,
884 			usb_rcvctrlpipe(serial->dev, 0),
885 			0x22, 0x21, val, ifNum, NULL, 0, USB_CTRL_SET_TIMEOUT);
886 	}
887 	return 0;
888 }
889 
890 static int option_startup(struct usb_serial *serial)
891 {
892 	int i, j, err;
893 	struct usb_serial_port *port;
894 	struct option_port_private *portdata;
895 	u8 *buffer;
896 
897 	dbg("%s", __func__);
898 
899 	/* Now setup per port private data */
900 	for (i = 0; i < serial->num_ports; i++) {
901 		port = serial->port[i];
902 		portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
903 		if (!portdata) {
904 			dbg("%s: kmalloc for option_port_private (%d) failed!.",
905 					__func__, i);
906 			return 1;
907 		}
908 
909 		for (j = 0; j < N_IN_URB; j++) {
910 			buffer = (u8 *)__get_free_page(GFP_KERNEL);
911 			if (!buffer)
912 				goto bail_out_error;
913 			portdata->in_buffer[j] = buffer;
914 		}
915 
916 		for (j = 0; j < N_OUT_URB; j++) {
917 			buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
918 			if (!buffer)
919 				goto bail_out_error2;
920 			portdata->out_buffer[j] = buffer;
921 		}
922 
923 		usb_set_serial_port_data(port, portdata);
924 
925 		if (!port->interrupt_in_urb)
926 			continue;
927 		err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
928 		if (err)
929 			dbg("%s: submit irq_in urb failed %d",
930 				__func__, err);
931 	}
932 	option_setup_urbs(serial);
933 	return 0;
934 
935 bail_out_error2:
936 	for (j = 0; j < N_OUT_URB; j++)
937 		kfree(portdata->out_buffer[j]);
938 bail_out_error:
939 	for (j = 0; j < N_IN_URB; j++)
940 		if (portdata->in_buffer[j])
941 			free_page((unsigned long)portdata->in_buffer[j]);
942 	kfree(portdata);
943 	return 1;
944 }
945 
946 static void option_shutdown(struct usb_serial *serial)
947 {
948 	int i, j;
949 	struct usb_serial_port *port;
950 	struct option_port_private *portdata;
951 
952 	dbg("%s", __func__);
953 
954 	/* Stop reading/writing urbs */
955 	for (i = 0; i < serial->num_ports; ++i) {
956 		port = serial->port[i];
957 		portdata = usb_get_serial_port_data(port);
958 		for (j = 0; j < N_IN_URB; j++)
959 			usb_kill_urb(portdata->in_urbs[j]);
960 		for (j = 0; j < N_OUT_URB; j++)
961 			usb_kill_urb(portdata->out_urbs[j]);
962 	}
963 
964 	/* Now free them */
965 	for (i = 0; i < serial->num_ports; ++i) {
966 		port = serial->port[i];
967 		portdata = usb_get_serial_port_data(port);
968 
969 		for (j = 0; j < N_IN_URB; j++) {
970 			if (portdata->in_urbs[j]) {
971 				usb_free_urb(portdata->in_urbs[j]);
972 				free_page((unsigned long)
973 					portdata->in_buffer[j]);
974 				portdata->in_urbs[j] = NULL;
975 			}
976 		}
977 		for (j = 0; j < N_OUT_URB; j++) {
978 			if (portdata->out_urbs[j]) {
979 				usb_free_urb(portdata->out_urbs[j]);
980 				kfree(portdata->out_buffer[j]);
981 				portdata->out_urbs[j] = NULL;
982 			}
983 		}
984 	}
985 
986 	/* Now free per port private data */
987 	for (i = 0; i < serial->num_ports; i++) {
988 		port = serial->port[i];
989 		kfree(usb_get_serial_port_data(port));
990 	}
991 }
992 
993 MODULE_AUTHOR(DRIVER_AUTHOR);
994 MODULE_DESCRIPTION(DRIVER_DESC);
995 MODULE_VERSION(DRIVER_VERSION);
996 MODULE_LICENSE("GPL");
997 
998 module_param(debug, bool, S_IRUGO | S_IWUSR);
999 MODULE_PARM_DESC(debug, "Debug messages");
1000