2 USB Driver for GSM modems
4 Copyright (C) 2005 Matthias Urlichs <smurf@smurf.noris.de>
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.
10 Portions copied from the Keyspan driver by Hugh Blemings <hugh@blemings.org>
12 History: see the git log.
14 Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
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
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.
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
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"
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>
45 /* Function prototypes */
46 static int option_open(struct tty_struct *tty, struct usb_serial_port *port,
48 static void option_close(struct tty_struct *tty, struct usb_serial_port *port,
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);
54 static void option_instat_callback(struct urb *urb);
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);
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
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
125 #define NOVATELWIRELESS_VENDOR_ID 0x1410
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
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
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
149 /* OVATION PRODUCTS */
150 #define NOVATELWIRELESS_PRODUCT_MC727 0x4100
151 #define NOVATELWIRELESS_PRODUCT_MC950D 0x4400
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
164 #define AMOI_VENDOR_ID 0x1614
165 #define AMOI_PRODUCT_H01 0x0800
166 #define AMOI_PRODUCT_H01A 0x7002
167 #define AMOI_PRODUCT_H02 0x0802
169 #define DELL_VENDOR_ID 0x413C
171 #define KYOCERA_VENDOR_ID 0x0c88
172 #define KYOCERA_PRODUCT_KPC650 0x17da
173 #define KYOCERA_PRODUCT_KPC680 0x180a
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
180 #define AXESSTEL_VENDOR_ID 0x1726
181 #define AXESSTEL_PRODUCT_MV110H 0x1000
183 #define ONDA_VENDOR_ID 0x19d2
184 #define ONDA_PRODUCT_MSA501HS 0x0001
185 #define ONDA_PRODUCT_ET502HS 0x0002
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
198 #define BANDRICH_PRODUCT_100B 0x100b
199 #define BANDRICH_PRODUCT_100C 0x100c
200 #define BANDRICH_PRODUCT_100D 0x100d
201 #define BANDRICH_PRODUCT_100E 0x100e
203 #define BANDRICH_PRODUCT_100F 0x100f
204 #define BANDRICH_PRODUCT_1010 0x1010
205 #define BANDRICH_PRODUCT_1011 0x1011
206 #define BANDRICH_PRODUCT_1012 0x1012
208 #define AMOI_VENDOR_ID 0x1614
209 #define AMOI_PRODUCT_9508 0x0800
211 #define QUALCOMM_VENDOR_ID 0x05C6
213 #define MAXON_VENDOR_ID 0x16d8
215 #define TELIT_VENDOR_ID 0x1bc7
216 #define TELIT_PRODUCT_UC864E 0x1003
219 #define ZTE_VENDOR_ID 0x19d2
220 #define ZTE_PRODUCT_MF628 0x0015
222 static struct usb_device_id option_ids[] = {
223 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
224 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
225 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
226 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
227 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
228 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
229 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
230 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
231 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
232 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
233 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
234 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
235 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
236 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
237 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
238 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
239 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
240 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
241 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
242 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
243 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
244 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
245 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
246 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
247 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
248 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
249 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
250 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
251 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
252 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
253 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
254 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
255 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
256 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
257 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
258 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600, 0xff, 0xff, 0xff) },
259 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
260 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
261 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401, 0xff, 0xff, 0xff) },
262 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403, 0xff, 0xff, 0xff) },
263 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405, 0xff, 0xff, 0xff) },
264 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406, 0xff, 0xff, 0xff) },
265 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408, 0xff, 0xff, 0xff) },
266 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409, 0xff, 0xff, 0xff) },
267 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410, 0xff, 0xff, 0xff) },
268 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411, 0xff, 0xff, 0xff) },
269 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412, 0xff, 0xff, 0xff) },
270 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413, 0xff, 0xff, 0xff) },
271 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414, 0xff, 0xff, 0xff) },
272 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415, 0xff, 0xff, 0xff) },
273 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416, 0xff, 0xff, 0xff) },
274 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417, 0xff, 0xff, 0xff) },
275 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418, 0xff, 0xff, 0xff) },
276 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419, 0xff, 0xff, 0xff) },
277 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
278 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
279 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
280 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
281 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
282 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
283 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
284 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
285 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
286 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
287 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
288 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
289 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
290 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
291 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
292 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
293 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
294 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
295 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
296 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
297 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
298 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
299 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
300 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
301 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
302 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
303 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
305 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01) },
306 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01A) },
307 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H02) },
309 { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
310 { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
311 { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
312 { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
313 { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
314 { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
315 { USB_DEVICE(DELL_VENDOR_ID, 0x8129) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
316 { USB_DEVICE(DELL_VENDOR_ID, 0x8133) }, /* Dell Wireless 5720 == Novatel EV620 CDMA/EV-DO */
317 { USB_DEVICE(DELL_VENDOR_ID, 0x8136) }, /* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
318 { USB_DEVICE(DELL_VENDOR_ID, 0x8137) }, /* Dell Wireless HSDPA 5520 */
319 { USB_DEVICE(DELL_VENDOR_ID, 0x8138) }, /* Dell Wireless 5520 Voda I Mobile Broadband (3G HSDPA) Minicard */
320 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
321 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
322 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_620UW) },
323 { USB_DEVICE(AXESSTEL_VENDOR_ID, AXESSTEL_PRODUCT_MV110H) },
324 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_MSA501HS) },
325 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_ET502HS) },
326 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
327 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
328 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1004) },
329 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1005) },
330 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1006) },
331 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1007) },
332 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1008) },
333 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1009) },
334 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100A) },
335 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100B) },
336 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100C) },
337 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100D) },
338 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100E) },
339 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100F) },
340 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1010) },
341 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1011) },
342 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1012) },
343 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC650) },
344 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
345 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6000)}, /* ZTE AC8700 */
346 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
347 { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
348 { USB_DEVICE(TELIT_VENDOR_ID, TELIT_PRODUCT_UC864E) },
349 { USB_DEVICE(ZTE_VENDOR_ID, ZTE_PRODUCT_MF628) },
350 { } /* Terminating entry */
352 MODULE_DEVICE_TABLE(usb, option_ids);
354 static struct usb_driver option_driver = {
356 .probe = usb_serial_probe,
357 .disconnect = usb_serial_disconnect,
358 .id_table = option_ids,
362 /* The card has three separate interfaces, which the serial driver
363 * recognizes separately, thus num_port=1.
366 static struct usb_serial_driver option_1port_device = {
368 .owner = THIS_MODULE,
371 .description = "GSM modem (1-port)",
372 .usb_driver = &option_driver,
373 .id_table = option_ids,
376 .close = option_close,
377 .write = option_write,
378 .write_room = option_write_room,
379 .chars_in_buffer = option_chars_in_buffer,
380 .set_termios = option_set_termios,
381 .tiocmget = option_tiocmget,
382 .tiocmset = option_tiocmset,
383 .attach = option_startup,
384 .shutdown = option_shutdown,
385 .read_int_callback = option_instat_callback,
390 /* per port private data */
394 #define IN_BUFLEN 4096
395 #define OUT_BUFLEN 128
397 struct option_port_private {
398 /* Input endpoints and buffer for this port */
399 struct urb *in_urbs[N_IN_URB];
400 u8 *in_buffer[N_IN_URB];
401 /* Output endpoints and buffer for this port */
402 struct urb *out_urbs[N_OUT_URB];
403 u8 *out_buffer[N_OUT_URB];
404 unsigned long out_busy; /* Bit vector of URBs in use */
406 /* Settings for the port */
407 int rts_state; /* Handshaking pins (outputs) */
409 int cts_state; /* Handshaking pins (inputs) */
414 unsigned long tx_start_time[N_OUT_URB];
417 /* Functions used by new usb-serial code. */
418 static int __init option_init(void)
421 retval = usb_serial_register(&option_1port_device);
423 goto failed_1port_device_register;
424 retval = usb_register(&option_driver);
426 goto failed_driver_register;
428 info(DRIVER_DESC ": " DRIVER_VERSION);
432 failed_driver_register:
433 usb_serial_deregister(&option_1port_device);
434 failed_1port_device_register:
438 static void __exit option_exit(void)
440 usb_deregister(&option_driver);
441 usb_serial_deregister(&option_1port_device);
444 module_init(option_init);
445 module_exit(option_exit);
447 static void option_set_termios(struct tty_struct *tty,
448 struct usb_serial_port *port, struct ktermios *old_termios)
451 /* Doesn't support option setting */
452 tty_termios_copy_hw(tty->termios, old_termios);
453 option_send_setup(tty, port);
456 static int option_tiocmget(struct tty_struct *tty, struct file *file)
458 struct usb_serial_port *port = tty->driver_data;
460 struct option_port_private *portdata;
462 portdata = usb_get_serial_port_data(port);
464 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
465 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
466 ((portdata->cts_state) ? TIOCM_CTS : 0) |
467 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
468 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
469 ((portdata->ri_state) ? TIOCM_RNG : 0);
474 static int option_tiocmset(struct tty_struct *tty, struct file *file,
475 unsigned int set, unsigned int clear)
477 struct usb_serial_port *port = tty->driver_data;
478 struct option_port_private *portdata;
480 portdata = usb_get_serial_port_data(port);
482 /* FIXME: what locks portdata fields ? */
484 portdata->rts_state = 1;
486 portdata->dtr_state = 1;
488 if (clear & TIOCM_RTS)
489 portdata->rts_state = 0;
490 if (clear & TIOCM_DTR)
491 portdata->dtr_state = 0;
492 return option_send_setup(tty, port);
496 static int option_write(struct tty_struct *tty, struct usb_serial_port *port,
497 const unsigned char *buf, int count)
499 struct option_port_private *portdata;
502 struct urb *this_urb = NULL; /* spurious */
505 portdata = usb_get_serial_port_data(port);
507 dbg("%s: write (%d chars)", __func__, count);
511 for (i = 0; left > 0 && i < N_OUT_URB; i++) {
513 if (todo > OUT_BUFLEN)
516 this_urb = portdata->out_urbs[i];
517 if (test_and_set_bit(i, &portdata->out_busy)) {
518 if (time_before(jiffies,
519 portdata->tx_start_time[i] + 10 * HZ))
521 usb_unlink_urb(this_urb);
524 if (this_urb->status != 0)
525 dbg("usb_write %p failed (err=%d)",
526 this_urb, this_urb->status);
528 dbg("%s: endpoint %d buf %d", __func__,
529 usb_pipeendpoint(this_urb->pipe), i);
532 memcpy(this_urb->transfer_buffer, buf, todo);
533 this_urb->transfer_buffer_length = todo;
535 this_urb->dev = port->serial->dev;
536 err = usb_submit_urb(this_urb, GFP_ATOMIC);
538 dbg("usb_submit_urb %p (write bulk) failed "
539 "(%d, has %d)", this_urb,
540 err, this_urb->status);
541 clear_bit(i, &portdata->out_busy);
544 portdata->tx_start_time[i] = jiffies;
550 dbg("%s: wrote (did %d)", __func__, count);
554 static void option_indat_callback(struct urb *urb)
558 struct usb_serial_port *port;
559 struct tty_struct *tty;
560 unsigned char *data = urb->transfer_buffer;
561 int status = urb->status;
563 dbg("%s: %p", __func__, urb);
565 endpoint = usb_pipeendpoint(urb->pipe);
569 dbg("%s: nonzero status: %d on endpoint %02x.",
570 __func__, status, endpoint);
572 tty = port->port.tty;
573 if (urb->actual_length) {
574 tty_buffer_request_room(tty, urb->actual_length);
575 tty_insert_flip_string(tty, data, urb->actual_length);
576 tty_flip_buffer_push(tty);
578 dbg("%s: empty read urb received", __func__);
581 /* Resubmit urb so we continue receiving */
582 if (port->port.count && status != -ESHUTDOWN) {
583 err = usb_submit_urb(urb, GFP_ATOMIC);
585 printk(KERN_ERR "%s: resubmit read urb failed. "
586 "(%d)", __func__, err);
592 static void option_outdat_callback(struct urb *urb)
594 struct usb_serial_port *port;
595 struct option_port_private *portdata;
602 usb_serial_port_softint(port);
604 portdata = usb_get_serial_port_data(port);
605 for (i = 0; i < N_OUT_URB; ++i) {
606 if (portdata->out_urbs[i] == urb) {
607 smp_mb__before_clear_bit();
608 clear_bit(i, &portdata->out_busy);
614 static void option_instat_callback(struct urb *urb)
617 int status = urb->status;
618 struct usb_serial_port *port = urb->context;
619 struct option_port_private *portdata = usb_get_serial_port_data(port);
620 struct usb_serial *serial = port->serial;
623 dbg("%s: urb %p port %p has data %p", __func__, urb, port, portdata);
626 struct usb_ctrlrequest *req_pkt =
627 (struct usb_ctrlrequest *)urb->transfer_buffer;
630 dbg("%s: NULL req_pkt\n", __func__);
633 if ((req_pkt->bRequestType == 0xA1) &&
634 (req_pkt->bRequest == 0x20)) {
636 unsigned char signals = *((unsigned char *)
637 urb->transfer_buffer +
638 sizeof(struct usb_ctrlrequest));
640 dbg("%s: signal x%x", __func__, signals);
642 old_dcd_state = portdata->dcd_state;
643 portdata->cts_state = 1;
644 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
645 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
646 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
648 if (port->port.tty && !C_CLOCAL(port->port.tty) &&
649 old_dcd_state && !portdata->dcd_state)
650 tty_hangup(port->port.tty);
652 dbg("%s: type %x req %x", __func__,
653 req_pkt->bRequestType, req_pkt->bRequest);
656 dbg("%s: error %d", __func__, status);
658 /* Resubmit urb so we continue receiving IRQ data */
659 if (status != -ESHUTDOWN) {
660 urb->dev = serial->dev;
661 err = usb_submit_urb(urb, GFP_ATOMIC);
663 dbg("%s: resubmit intr urb failed. (%d)",
668 static int option_write_room(struct tty_struct *tty)
670 struct usb_serial_port *port = tty->driver_data;
671 struct option_port_private *portdata;
674 struct urb *this_urb;
676 portdata = usb_get_serial_port_data(port);
679 for (i = 0; i < N_OUT_URB; i++) {
680 this_urb = portdata->out_urbs[i];
681 if (this_urb && !test_bit(i, &portdata->out_busy))
682 data_len += OUT_BUFLEN;
685 dbg("%s: %d", __func__, data_len);
689 static int option_chars_in_buffer(struct tty_struct *tty)
691 struct usb_serial_port *port = tty->driver_data;
692 struct option_port_private *portdata;
695 struct urb *this_urb;
697 portdata = usb_get_serial_port_data(port);
699 for (i = 0; i < N_OUT_URB; i++) {
700 this_urb = portdata->out_urbs[i];
701 /* FIXME: This locking is insufficient as this_urb may
702 go unused during the test */
703 if (this_urb && test_bit(i, &portdata->out_busy))
704 data_len += this_urb->transfer_buffer_length;
706 dbg("%s: %d", __func__, data_len);
710 static int option_open(struct tty_struct *tty,
711 struct usb_serial_port *port, struct file *filp)
713 struct option_port_private *portdata;
714 struct usb_serial *serial = port->serial;
718 portdata = usb_get_serial_port_data(port);
722 /* Set some sane defaults */
723 portdata->rts_state = 1;
724 portdata->dtr_state = 1;
726 /* Reset low level data toggle and start reading from endpoints */
727 for (i = 0; i < N_IN_URB; i++) {
728 urb = portdata->in_urbs[i];
731 if (urb->dev != serial->dev) {
732 dbg("%s: dev %p != %p", __func__,
733 urb->dev, serial->dev);
738 * make sure endpoint data toggle is synchronized with the
741 usb_clear_halt(urb->dev, urb->pipe);
743 err = usb_submit_urb(urb, GFP_KERNEL);
745 dbg("%s: submit urb %d failed (%d) %d",
747 urb->transfer_buffer_length);
751 /* Reset low level data toggle on out endpoints */
752 for (i = 0; i < N_OUT_URB; i++) {
753 urb = portdata->out_urbs[i];
756 urb->dev = serial->dev;
757 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
758 usb_pipeout(urb->pipe), 0); */
762 tty->low_latency = 1;
764 option_send_setup(tty, port);
769 static void option_close(struct tty_struct *tty,
770 struct usb_serial_port *port, struct file *filp)
773 struct usb_serial *serial = port->serial;
774 struct option_port_private *portdata;
777 portdata = usb_get_serial_port_data(port);
779 portdata->rts_state = 0;
780 portdata->dtr_state = 0;
783 mutex_lock(&serial->disc_mutex);
784 if (!serial->disconnected)
785 option_send_setup(tty, port);
786 mutex_unlock(&serial->disc_mutex);
788 /* Stop reading/writing urbs */
789 for (i = 0; i < N_IN_URB; i++)
790 usb_kill_urb(portdata->in_urbs[i]);
791 for (i = 0; i < N_OUT_URB; i++)
792 usb_kill_urb(portdata->out_urbs[i]);
794 port->port.tty = NULL; /* FIXME */
797 /* Helper functions used by option_setup_urbs */
798 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
799 int dir, void *ctx, char *buf, int len,
800 void (*callback)(struct urb *))
805 return NULL; /* endpoint not needed */
807 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
809 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
813 /* Fill URB using supplied data. */
814 usb_fill_bulk_urb(urb, serial->dev,
815 usb_sndbulkpipe(serial->dev, endpoint) | dir,
816 buf, len, callback, ctx);
822 static void option_setup_urbs(struct usb_serial *serial)
825 struct usb_serial_port *port;
826 struct option_port_private *portdata;
830 for (i = 0; i < serial->num_ports; i++) {
831 port = serial->port[i];
832 portdata = usb_get_serial_port_data(port);
834 /* Do indat endpoints first */
835 for (j = 0; j < N_IN_URB; ++j) {
836 portdata->in_urbs[j] = option_setup_urb(serial,
837 port->bulk_in_endpointAddress,
839 portdata->in_buffer[j],
840 IN_BUFLEN, option_indat_callback);
843 /* outdat endpoints */
844 for (j = 0; j < N_OUT_URB; ++j) {
845 portdata->out_urbs[j] = option_setup_urb(serial,
846 port->bulk_out_endpointAddress,
848 portdata->out_buffer[j],
849 OUT_BUFLEN, option_outdat_callback);
855 /** send RTS/DTR state to the port.
857 * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
860 static int option_send_setup(struct tty_struct *tty,
861 struct usb_serial_port *port)
863 struct usb_serial *serial = port->serial;
864 struct option_port_private *portdata;
865 int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
868 portdata = usb_get_serial_port_data(port);
872 if (portdata->dtr_state)
874 if (portdata->rts_state)
877 return usb_control_msg(serial->dev,
878 usb_rcvctrlpipe(serial->dev, 0),
879 0x22, 0x21, val, ifNum, NULL, 0, USB_CTRL_SET_TIMEOUT);
884 static int option_startup(struct usb_serial *serial)
887 struct usb_serial_port *port;
888 struct option_port_private *portdata;
893 /* Now setup per port private data */
894 for (i = 0; i < serial->num_ports; i++) {
895 port = serial->port[i];
896 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
898 dbg("%s: kmalloc for option_port_private (%d) failed!.",
903 for (j = 0; j < N_IN_URB; j++) {
904 buffer = (u8 *)__get_free_page(GFP_KERNEL);
907 portdata->in_buffer[j] = buffer;
910 for (j = 0; j < N_OUT_URB; j++) {
911 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
913 goto bail_out_error2;
914 portdata->out_buffer[j] = buffer;
917 usb_set_serial_port_data(port, portdata);
919 if (!port->interrupt_in_urb)
921 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
923 dbg("%s: submit irq_in urb failed %d",
926 option_setup_urbs(serial);
930 for (j = 0; j < N_OUT_URB; j++)
931 kfree(portdata->out_buffer[j]);
933 for (j = 0; j < N_IN_URB; j++)
934 if (portdata->in_buffer[j])
935 free_page((unsigned long)portdata->in_buffer[j]);
940 static void option_shutdown(struct usb_serial *serial)
943 struct usb_serial_port *port;
944 struct option_port_private *portdata;
948 /* Stop reading/writing urbs */
949 for (i = 0; i < serial->num_ports; ++i) {
950 port = serial->port[i];
951 portdata = usb_get_serial_port_data(port);
952 for (j = 0; j < N_IN_URB; j++)
953 usb_kill_urb(portdata->in_urbs[j]);
954 for (j = 0; j < N_OUT_URB; j++)
955 usb_kill_urb(portdata->out_urbs[j]);
959 for (i = 0; i < serial->num_ports; ++i) {
960 port = serial->port[i];
961 portdata = usb_get_serial_port_data(port);
963 for (j = 0; j < N_IN_URB; j++) {
964 if (portdata->in_urbs[j]) {
965 usb_free_urb(portdata->in_urbs[j]);
966 free_page((unsigned long)
967 portdata->in_buffer[j]);
968 portdata->in_urbs[j] = NULL;
971 for (j = 0; j < N_OUT_URB; j++) {
972 if (portdata->out_urbs[j]) {
973 usb_free_urb(portdata->out_urbs[j]);
974 kfree(portdata->out_buffer[j]);
975 portdata->out_urbs[j] = NULL;
980 /* Now free per port private data */
981 for (i = 0; i < serial->num_ports; i++) {
982 port = serial->port[i];
983 kfree(usb_get_serial_port_data(port));
987 MODULE_AUTHOR(DRIVER_AUTHOR);
988 MODULE_DESCRIPTION(DRIVER_DESC);
989 MODULE_VERSION(DRIVER_VERSION);
990 MODULE_LICENSE("GPL");
992 module_param(debug, bool, S_IRUGO | S_IWUSR);
993 MODULE_PARM_DESC(debug, "Debug messages");