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_E100A 0x6501
177 #define ANYDATA_PRODUCT_ADU_500A 0x6502
179 #define AXESSTEL_VENDOR_ID 0x1726
180 #define AXESSTEL_PRODUCT_MV110H 0x1000
182 #define ONDA_VENDOR_ID 0x19d2
183 #define ONDA_PRODUCT_MSA501HS 0x0001
184 #define ONDA_PRODUCT_ET502HS 0x0002
186 #define BANDRICH_VENDOR_ID 0x1A8D
187 #define BANDRICH_PRODUCT_C100_1 0x1002
188 #define BANDRICH_PRODUCT_C100_2 0x1003
189 #define BANDRICH_PRODUCT_1004 0x1004
190 #define BANDRICH_PRODUCT_1005 0x1005
191 #define BANDRICH_PRODUCT_1006 0x1006
192 #define BANDRICH_PRODUCT_1007 0x1007
193 #define BANDRICH_PRODUCT_1008 0x1008
194 #define BANDRICH_PRODUCT_1009 0x1009
195 #define BANDRICH_PRODUCT_100A 0x100a
197 #define BANDRICH_PRODUCT_100B 0x100b
198 #define BANDRICH_PRODUCT_100C 0x100c
199 #define BANDRICH_PRODUCT_100D 0x100d
200 #define BANDRICH_PRODUCT_100E 0x100e
202 #define BANDRICH_PRODUCT_100F 0x100f
203 #define BANDRICH_PRODUCT_1010 0x1010
204 #define BANDRICH_PRODUCT_1011 0x1011
205 #define BANDRICH_PRODUCT_1012 0x1012
207 #define AMOI_VENDOR_ID 0x1614
208 #define AMOI_PRODUCT_9508 0x0800
210 #define QUALCOMM_VENDOR_ID 0x05C6
212 #define MAXON_VENDOR_ID 0x16d8
214 #define TELIT_VENDOR_ID 0x1bc7
215 #define TELIT_PRODUCT_UC864E 0x1003
218 #define ZTE_VENDOR_ID 0x19d2
219 #define ZTE_PRODUCT_MF628 0x0015
221 static struct usb_device_id option_ids[] = {
222 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
223 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
224 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
225 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
226 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
227 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
228 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
229 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
230 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
231 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
232 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
233 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
234 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
235 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
236 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
237 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
238 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
239 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
240 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
241 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
242 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
243 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
244 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
245 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
246 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
247 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
248 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
249 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
250 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
251 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
252 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
253 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
254 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
255 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
256 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
257 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600, 0xff, 0xff, 0xff) },
258 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
259 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
260 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401, 0xff, 0xff, 0xff) },
261 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403, 0xff, 0xff, 0xff) },
262 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405, 0xff, 0xff, 0xff) },
263 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406, 0xff, 0xff, 0xff) },
264 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408, 0xff, 0xff, 0xff) },
265 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409, 0xff, 0xff, 0xff) },
266 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410, 0xff, 0xff, 0xff) },
267 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411, 0xff, 0xff, 0xff) },
268 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412, 0xff, 0xff, 0xff) },
269 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413, 0xff, 0xff, 0xff) },
270 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414, 0xff, 0xff, 0xff) },
271 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415, 0xff, 0xff, 0xff) },
272 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416, 0xff, 0xff, 0xff) },
273 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417, 0xff, 0xff, 0xff) },
274 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418, 0xff, 0xff, 0xff) },
275 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419, 0xff, 0xff, 0xff) },
276 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
277 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
278 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
279 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
280 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
281 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
282 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
283 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
284 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
285 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
286 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
287 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
288 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
289 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
290 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
291 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
292 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
293 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
294 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
295 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
296 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
297 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
298 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
299 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
300 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
301 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
302 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
304 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01) },
305 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01A) },
306 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H02) },
308 { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
309 { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
310 { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
311 { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
312 { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
313 { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
314 { USB_DEVICE(DELL_VENDOR_ID, 0x8129) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
315 { USB_DEVICE(DELL_VENDOR_ID, 0x8133) }, /* Dell Wireless 5720 == Novatel EV620 CDMA/EV-DO */
316 { USB_DEVICE(DELL_VENDOR_ID, 0x8136) }, /* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
317 { USB_DEVICE(DELL_VENDOR_ID, 0x8137) }, /* Dell Wireless HSDPA 5520 */
318 { USB_DEVICE(DELL_VENDOR_ID, 0x8138) }, /* Dell Wireless 5520 Voda I Mobile Broadband (3G HSDPA) Minicard */
319 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
320 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
321 { USB_DEVICE(AXESSTEL_VENDOR_ID, AXESSTEL_PRODUCT_MV110H) },
322 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_MSA501HS) },
323 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_ET502HS) },
324 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
325 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
326 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1004) },
327 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1005) },
328 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1006) },
329 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1007) },
330 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1008) },
331 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1009) },
332 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100A) },
333 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100B) },
334 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100C) },
335 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100D) },
336 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100E) },
337 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100F) },
338 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1010) },
339 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1011) },
340 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1012) },
341 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC650) },
342 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
343 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6000)}, /* ZTE AC8700 */
344 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
345 { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
346 { USB_DEVICE(TELIT_VENDOR_ID, TELIT_PRODUCT_UC864E) },
347 { USB_DEVICE(ZTE_VENDOR_ID, ZTE_PRODUCT_MF628) },
348 { } /* Terminating entry */
350 MODULE_DEVICE_TABLE(usb, option_ids);
352 static struct usb_driver option_driver = {
354 .probe = usb_serial_probe,
355 .disconnect = usb_serial_disconnect,
356 .id_table = option_ids,
360 /* The card has three separate interfaces, which the serial driver
361 * recognizes separately, thus num_port=1.
364 static struct usb_serial_driver option_1port_device = {
366 .owner = THIS_MODULE,
369 .description = "GSM modem (1-port)",
370 .usb_driver = &option_driver,
371 .id_table = option_ids,
374 .close = option_close,
375 .write = option_write,
376 .write_room = option_write_room,
377 .chars_in_buffer = option_chars_in_buffer,
378 .set_termios = option_set_termios,
379 .tiocmget = option_tiocmget,
380 .tiocmset = option_tiocmset,
381 .attach = option_startup,
382 .shutdown = option_shutdown,
383 .read_int_callback = option_instat_callback,
388 /* per port private data */
392 #define IN_BUFLEN 4096
393 #define OUT_BUFLEN 128
395 struct option_port_private {
396 /* Input endpoints and buffer for this port */
397 struct urb *in_urbs[N_IN_URB];
398 u8 *in_buffer[N_IN_URB];
399 /* Output endpoints and buffer for this port */
400 struct urb *out_urbs[N_OUT_URB];
401 u8 *out_buffer[N_OUT_URB];
402 unsigned long out_busy; /* Bit vector of URBs in use */
404 /* Settings for the port */
405 int rts_state; /* Handshaking pins (outputs) */
407 int cts_state; /* Handshaking pins (inputs) */
412 unsigned long tx_start_time[N_OUT_URB];
415 /* Functions used by new usb-serial code. */
416 static int __init option_init(void)
419 retval = usb_serial_register(&option_1port_device);
421 goto failed_1port_device_register;
422 retval = usb_register(&option_driver);
424 goto failed_driver_register;
426 info(DRIVER_DESC ": " DRIVER_VERSION);
430 failed_driver_register:
431 usb_serial_deregister(&option_1port_device);
432 failed_1port_device_register:
436 static void __exit option_exit(void)
438 usb_deregister(&option_driver);
439 usb_serial_deregister(&option_1port_device);
442 module_init(option_init);
443 module_exit(option_exit);
445 static void option_set_termios(struct tty_struct *tty,
446 struct usb_serial_port *port, struct ktermios *old_termios)
449 /* Doesn't support option setting */
450 tty_termios_copy_hw(tty->termios, old_termios);
451 option_send_setup(tty, port);
454 static int option_tiocmget(struct tty_struct *tty, struct file *file)
456 struct usb_serial_port *port = tty->driver_data;
458 struct option_port_private *portdata;
460 portdata = usb_get_serial_port_data(port);
462 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
463 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
464 ((portdata->cts_state) ? TIOCM_CTS : 0) |
465 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
466 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
467 ((portdata->ri_state) ? TIOCM_RNG : 0);
472 static int option_tiocmset(struct tty_struct *tty, struct file *file,
473 unsigned int set, unsigned int clear)
475 struct usb_serial_port *port = tty->driver_data;
476 struct option_port_private *portdata;
478 portdata = usb_get_serial_port_data(port);
480 /* FIXME: what locks portdata fields ? */
482 portdata->rts_state = 1;
484 portdata->dtr_state = 1;
486 if (clear & TIOCM_RTS)
487 portdata->rts_state = 0;
488 if (clear & TIOCM_DTR)
489 portdata->dtr_state = 0;
490 return option_send_setup(tty, port);
494 static int option_write(struct tty_struct *tty, struct usb_serial_port *port,
495 const unsigned char *buf, int count)
497 struct option_port_private *portdata;
500 struct urb *this_urb = NULL; /* spurious */
503 portdata = usb_get_serial_port_data(port);
505 dbg("%s: write (%d chars)", __func__, count);
509 for (i = 0; left > 0 && i < N_OUT_URB; i++) {
511 if (todo > OUT_BUFLEN)
514 this_urb = portdata->out_urbs[i];
515 if (test_and_set_bit(i, &portdata->out_busy)) {
516 if (time_before(jiffies,
517 portdata->tx_start_time[i] + 10 * HZ))
519 usb_unlink_urb(this_urb);
522 if (this_urb->status != 0)
523 dbg("usb_write %p failed (err=%d)",
524 this_urb, this_urb->status);
526 dbg("%s: endpoint %d buf %d", __func__,
527 usb_pipeendpoint(this_urb->pipe), i);
530 memcpy(this_urb->transfer_buffer, buf, todo);
531 this_urb->transfer_buffer_length = todo;
533 this_urb->dev = port->serial->dev;
534 err = usb_submit_urb(this_urb, GFP_ATOMIC);
536 dbg("usb_submit_urb %p (write bulk) failed "
537 "(%d, has %d)", this_urb,
538 err, this_urb->status);
539 clear_bit(i, &portdata->out_busy);
542 portdata->tx_start_time[i] = jiffies;
548 dbg("%s: wrote (did %d)", __func__, count);
552 static void option_indat_callback(struct urb *urb)
556 struct usb_serial_port *port;
557 struct tty_struct *tty;
558 unsigned char *data = urb->transfer_buffer;
559 int status = urb->status;
561 dbg("%s: %p", __func__, urb);
563 endpoint = usb_pipeendpoint(urb->pipe);
567 dbg("%s: nonzero status: %d on endpoint %02x.",
568 __func__, status, endpoint);
570 tty = port->port.tty;
571 if (urb->actual_length) {
572 tty_buffer_request_room(tty, urb->actual_length);
573 tty_insert_flip_string(tty, data, urb->actual_length);
574 tty_flip_buffer_push(tty);
576 dbg("%s: empty read urb received", __func__);
579 /* Resubmit urb so we continue receiving */
580 if (port->port.count && status != -ESHUTDOWN) {
581 err = usb_submit_urb(urb, GFP_ATOMIC);
583 printk(KERN_ERR "%s: resubmit read urb failed. "
584 "(%d)", __func__, err);
590 static void option_outdat_callback(struct urb *urb)
592 struct usb_serial_port *port;
593 struct option_port_private *portdata;
600 usb_serial_port_softint(port);
602 portdata = usb_get_serial_port_data(port);
603 for (i = 0; i < N_OUT_URB; ++i) {
604 if (portdata->out_urbs[i] == urb) {
605 smp_mb__before_clear_bit();
606 clear_bit(i, &portdata->out_busy);
612 static void option_instat_callback(struct urb *urb)
615 int status = urb->status;
616 struct usb_serial_port *port = urb->context;
617 struct option_port_private *portdata = usb_get_serial_port_data(port);
618 struct usb_serial *serial = port->serial;
621 dbg("%s: urb %p port %p has data %p", __func__, urb, port, portdata);
624 struct usb_ctrlrequest *req_pkt =
625 (struct usb_ctrlrequest *)urb->transfer_buffer;
628 dbg("%s: NULL req_pkt\n", __func__);
631 if ((req_pkt->bRequestType == 0xA1) &&
632 (req_pkt->bRequest == 0x20)) {
634 unsigned char signals = *((unsigned char *)
635 urb->transfer_buffer +
636 sizeof(struct usb_ctrlrequest));
638 dbg("%s: signal x%x", __func__, signals);
640 old_dcd_state = portdata->dcd_state;
641 portdata->cts_state = 1;
642 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
643 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
644 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
646 if (port->port.tty && !C_CLOCAL(port->port.tty) &&
647 old_dcd_state && !portdata->dcd_state)
648 tty_hangup(port->port.tty);
650 dbg("%s: type %x req %x", __func__,
651 req_pkt->bRequestType, req_pkt->bRequest);
654 dbg("%s: error %d", __func__, status);
656 /* Resubmit urb so we continue receiving IRQ data */
657 if (status != -ESHUTDOWN) {
658 urb->dev = serial->dev;
659 err = usb_submit_urb(urb, GFP_ATOMIC);
661 dbg("%s: resubmit intr urb failed. (%d)",
666 static int option_write_room(struct tty_struct *tty)
668 struct usb_serial_port *port = tty->driver_data;
669 struct option_port_private *portdata;
672 struct urb *this_urb;
674 portdata = usb_get_serial_port_data(port);
677 for (i = 0; i < N_OUT_URB; i++) {
678 this_urb = portdata->out_urbs[i];
679 if (this_urb && !test_bit(i, &portdata->out_busy))
680 data_len += OUT_BUFLEN;
683 dbg("%s: %d", __func__, data_len);
687 static int option_chars_in_buffer(struct tty_struct *tty)
689 struct usb_serial_port *port = tty->driver_data;
690 struct option_port_private *portdata;
693 struct urb *this_urb;
695 portdata = usb_get_serial_port_data(port);
697 for (i = 0; i < N_OUT_URB; i++) {
698 this_urb = portdata->out_urbs[i];
699 /* FIXME: This locking is insufficient as this_urb may
700 go unused during the test */
701 if (this_urb && test_bit(i, &portdata->out_busy))
702 data_len += this_urb->transfer_buffer_length;
704 dbg("%s: %d", __func__, data_len);
708 static int option_open(struct tty_struct *tty,
709 struct usb_serial_port *port, struct file *filp)
711 struct option_port_private *portdata;
712 struct usb_serial *serial = port->serial;
716 portdata = usb_get_serial_port_data(port);
720 /* Set some sane defaults */
721 portdata->rts_state = 1;
722 portdata->dtr_state = 1;
724 /* Reset low level data toggle and start reading from endpoints */
725 for (i = 0; i < N_IN_URB; i++) {
726 urb = portdata->in_urbs[i];
729 if (urb->dev != serial->dev) {
730 dbg("%s: dev %p != %p", __func__,
731 urb->dev, serial->dev);
736 * make sure endpoint data toggle is synchronized with the
739 usb_clear_halt(urb->dev, urb->pipe);
741 err = usb_submit_urb(urb, GFP_KERNEL);
743 dbg("%s: submit urb %d failed (%d) %d",
745 urb->transfer_buffer_length);
749 /* Reset low level data toggle on out endpoints */
750 for (i = 0; i < N_OUT_URB; i++) {
751 urb = portdata->out_urbs[i];
754 urb->dev = serial->dev;
755 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
756 usb_pipeout(urb->pipe), 0); */
760 tty->low_latency = 1;
762 option_send_setup(tty, port);
767 static void option_close(struct tty_struct *tty,
768 struct usb_serial_port *port, struct file *filp)
771 struct usb_serial *serial = port->serial;
772 struct option_port_private *portdata;
775 portdata = usb_get_serial_port_data(port);
777 portdata->rts_state = 0;
778 portdata->dtr_state = 0;
781 mutex_lock(&serial->disc_mutex);
782 if (!serial->disconnected)
783 option_send_setup(tty, port);
784 mutex_unlock(&serial->disc_mutex);
786 /* Stop reading/writing urbs */
787 for (i = 0; i < N_IN_URB; i++)
788 usb_kill_urb(portdata->in_urbs[i]);
789 for (i = 0; i < N_OUT_URB; i++)
790 usb_kill_urb(portdata->out_urbs[i]);
792 port->port.tty = NULL; /* FIXME */
795 /* Helper functions used by option_setup_urbs */
796 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
797 int dir, void *ctx, char *buf, int len,
798 void (*callback)(struct urb *))
803 return NULL; /* endpoint not needed */
805 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
807 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
811 /* Fill URB using supplied data. */
812 usb_fill_bulk_urb(urb, serial->dev,
813 usb_sndbulkpipe(serial->dev, endpoint) | dir,
814 buf, len, callback, ctx);
820 static void option_setup_urbs(struct usb_serial *serial)
823 struct usb_serial_port *port;
824 struct option_port_private *portdata;
828 for (i = 0; i < serial->num_ports; i++) {
829 port = serial->port[i];
830 portdata = usb_get_serial_port_data(port);
832 /* Do indat endpoints first */
833 for (j = 0; j < N_IN_URB; ++j) {
834 portdata->in_urbs[j] = option_setup_urb(serial,
835 port->bulk_in_endpointAddress,
837 portdata->in_buffer[j],
838 IN_BUFLEN, option_indat_callback);
841 /* outdat endpoints */
842 for (j = 0; j < N_OUT_URB; ++j) {
843 portdata->out_urbs[j] = option_setup_urb(serial,
844 port->bulk_out_endpointAddress,
846 portdata->out_buffer[j],
847 OUT_BUFLEN, option_outdat_callback);
853 /** send RTS/DTR state to the port.
855 * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
858 static int option_send_setup(struct tty_struct *tty,
859 struct usb_serial_port *port)
861 struct usb_serial *serial = port->serial;
862 struct option_port_private *portdata;
863 int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
866 portdata = usb_get_serial_port_data(port);
870 if (portdata->dtr_state)
872 if (portdata->rts_state)
875 return usb_control_msg(serial->dev,
876 usb_rcvctrlpipe(serial->dev, 0),
877 0x22, 0x21, val, ifNum, NULL, 0, USB_CTRL_SET_TIMEOUT);
882 static int option_startup(struct usb_serial *serial)
885 struct usb_serial_port *port;
886 struct option_port_private *portdata;
891 /* Now setup per port private data */
892 for (i = 0; i < serial->num_ports; i++) {
893 port = serial->port[i];
894 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
896 dbg("%s: kmalloc for option_port_private (%d) failed!.",
901 for (j = 0; j < N_IN_URB; j++) {
902 buffer = (u8 *)__get_free_page(GFP_KERNEL);
905 portdata->in_buffer[j] = buffer;
908 for (j = 0; j < N_OUT_URB; j++) {
909 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
911 goto bail_out_error2;
912 portdata->out_buffer[j] = buffer;
915 usb_set_serial_port_data(port, portdata);
917 if (!port->interrupt_in_urb)
919 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
921 dbg("%s: submit irq_in urb failed %d",
924 option_setup_urbs(serial);
928 for (j = 0; j < N_OUT_URB; j++)
929 kfree(portdata->out_buffer[j]);
931 for (j = 0; j < N_IN_URB; j++)
932 if (portdata->in_buffer[j])
933 free_page((unsigned long)portdata->in_buffer[j]);
938 static void option_shutdown(struct usb_serial *serial)
941 struct usb_serial_port *port;
942 struct option_port_private *portdata;
946 /* Stop reading/writing urbs */
947 for (i = 0; i < serial->num_ports; ++i) {
948 port = serial->port[i];
949 portdata = usb_get_serial_port_data(port);
950 for (j = 0; j < N_IN_URB; j++)
951 usb_kill_urb(portdata->in_urbs[j]);
952 for (j = 0; j < N_OUT_URB; j++)
953 usb_kill_urb(portdata->out_urbs[j]);
957 for (i = 0; i < serial->num_ports; ++i) {
958 port = serial->port[i];
959 portdata = usb_get_serial_port_data(port);
961 for (j = 0; j < N_IN_URB; j++) {
962 if (portdata->in_urbs[j]) {
963 usb_free_urb(portdata->in_urbs[j]);
964 free_page((unsigned long)
965 portdata->in_buffer[j]);
966 portdata->in_urbs[j] = NULL;
969 for (j = 0; j < N_OUT_URB; j++) {
970 if (portdata->out_urbs[j]) {
971 usb_free_urb(portdata->out_urbs[j]);
972 kfree(portdata->out_buffer[j]);
973 portdata->out_urbs[j] = NULL;
978 /* Now free per port private data */
979 for (i = 0; i < serial->num_ports; i++) {
980 port = serial->port[i];
981 kfree(usb_get_serial_port_data(port));
985 MODULE_AUTHOR(DRIVER_AUTHOR);
986 MODULE_DESCRIPTION(DRIVER_DESC);
987 MODULE_VERSION(DRIVER_VERSION);
988 MODULE_LICENSE("GPL");
990 module_param(debug, bool, S_IRUGO | S_IWUSR);
991 MODULE_PARM_DESC(debug, "Debug messages");