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_FUJI_MODEM_LIGHT 0x6721
83 #define OPTION_PRODUCT_FUJI_MODEM_GT 0x6741
84 #define OPTION_PRODUCT_FUJI_MODEM_EX 0x6761
85 #define OPTION_PRODUCT_KOI_MODEM 0x6800
86 #define OPTION_PRODUCT_SCORPION_MODEM 0x6901
87 #define OPTION_PRODUCT_ETNA_MODEM 0x7001
88 #define OPTION_PRODUCT_ETNA_MODEM_LITE 0x7021
89 #define OPTION_PRODUCT_ETNA_MODEM_GT 0x7041
90 #define OPTION_PRODUCT_ETNA_MODEM_EX 0x7061
91 #define OPTION_PRODUCT_ETNA_KOI_MODEM 0x7100
93 #define HUAWEI_VENDOR_ID 0x12D1
94 #define HUAWEI_PRODUCT_E600 0x1001
95 #define HUAWEI_PRODUCT_E220 0x1003
96 #define HUAWEI_PRODUCT_E220BIS 0x1004
97 #define HUAWEI_PRODUCT_E1401 0x1401
98 #define HUAWEI_PRODUCT_E1403 0x1403
99 #define HUAWEI_PRODUCT_E1405 0x1405
100 #define HUAWEI_PRODUCT_E1406 0x1406
101 #define HUAWEI_PRODUCT_E1408 0x1408
102 #define HUAWEI_PRODUCT_E1409 0x1409
103 #define HUAWEI_PRODUCT_E1410 0x1410
104 #define HUAWEI_PRODUCT_E1411 0x1411
105 #define HUAWEI_PRODUCT_E1412 0x1412
106 #define HUAWEI_PRODUCT_E1413 0x1413
107 #define HUAWEI_PRODUCT_E1414 0x1414
108 #define HUAWEI_PRODUCT_E1415 0x1415
109 #define HUAWEI_PRODUCT_E1416 0x1416
110 #define HUAWEI_PRODUCT_E1417 0x1417
111 #define HUAWEI_PRODUCT_E1418 0x1418
112 #define HUAWEI_PRODUCT_E1419 0x1419
114 #define NOVATELWIRELESS_VENDOR_ID 0x1410
116 /* MERLIN EVDO PRODUCTS */
117 #define NOVATELWIRELESS_PRODUCT_V640 0x1100
118 #define NOVATELWIRELESS_PRODUCT_V620 0x1110
119 #define NOVATELWIRELESS_PRODUCT_V740 0x1120
120 #define NOVATELWIRELESS_PRODUCT_V720 0x1130
122 /* MERLIN HSDPA/HSPA PRODUCTS */
123 #define NOVATELWIRELESS_PRODUCT_U730 0x1400
124 #define NOVATELWIRELESS_PRODUCT_U740 0x1410
125 #define NOVATELWIRELESS_PRODUCT_U870 0x1420
126 #define NOVATELWIRELESS_PRODUCT_XU870 0x1430
127 #define NOVATELWIRELESS_PRODUCT_X950D 0x1450
129 /* EXPEDITE PRODUCTS */
130 #define NOVATELWIRELESS_PRODUCT_EV620 0x2100
131 #define NOVATELWIRELESS_PRODUCT_ES720 0x2110
132 #define NOVATELWIRELESS_PRODUCT_E725 0x2120
133 #define NOVATELWIRELESS_PRODUCT_ES620 0x2130
134 #define NOVATELWIRELESS_PRODUCT_EU730 0x2400
135 #define NOVATELWIRELESS_PRODUCT_EU740 0x2410
136 #define NOVATELWIRELESS_PRODUCT_EU870D 0x2420
138 /* OVATION PRODUCTS */
139 #define NOVATELWIRELESS_PRODUCT_MC727 0x4100
140 #define NOVATELWIRELESS_PRODUCT_MC950D 0x4400
142 /* FUTURE NOVATEL PRODUCTS */
143 #define NOVATELWIRELESS_PRODUCT_EVDO_1 0x6000
144 #define NOVATELWIRELESS_PRODUCT_HSPA_1 0x7000
145 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_1 0x8000
146 #define NOVATELWIRELESS_PRODUCT_GLOBAL_1 0x9000
147 #define NOVATELWIRELESS_PRODUCT_EVDO_2 0x6001
148 #define NOVATELWIRELESS_PRODUCT_HSPA_2 0x7001
149 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_2 0x8001
150 #define NOVATELWIRELESS_PRODUCT_GLOBAL_2 0x9001
153 #define AMOI_VENDOR_ID 0x1614
154 #define AMOI_PRODUCT_H01 0x0800
155 #define AMOI_PRODUCT_H01A 0x7002
156 #define AMOI_PRODUCT_H02 0x0802
158 #define DELL_VENDOR_ID 0x413C
160 #define KYOCERA_VENDOR_ID 0x0c88
161 #define KYOCERA_PRODUCT_KPC650 0x17da
162 #define KYOCERA_PRODUCT_KPC680 0x180a
164 #define ANYDATA_VENDOR_ID 0x16d5
165 #define ANYDATA_PRODUCT_ADU_620UW 0x6202
166 #define ANYDATA_PRODUCT_ADU_E100A 0x6501
167 #define ANYDATA_PRODUCT_ADU_500A 0x6502
169 #define AXESSTEL_VENDOR_ID 0x1726
170 #define AXESSTEL_PRODUCT_MV110H 0x1000
172 #define ONDA_VENDOR_ID 0x19d2
173 #define ONDA_PRODUCT_MSA501HS 0x0001
174 #define ONDA_PRODUCT_ET502HS 0x0002
176 #define BANDRICH_VENDOR_ID 0x1A8D
177 #define BANDRICH_PRODUCT_C100_1 0x1002
178 #define BANDRICH_PRODUCT_C100_2 0x1003
179 #define BANDRICH_PRODUCT_1004 0x1004
180 #define BANDRICH_PRODUCT_1005 0x1005
181 #define BANDRICH_PRODUCT_1006 0x1006
182 #define BANDRICH_PRODUCT_1007 0x1007
183 #define BANDRICH_PRODUCT_1008 0x1008
184 #define BANDRICH_PRODUCT_1009 0x1009
185 #define BANDRICH_PRODUCT_100A 0x100a
187 #define BANDRICH_PRODUCT_100B 0x100b
188 #define BANDRICH_PRODUCT_100C 0x100c
189 #define BANDRICH_PRODUCT_100D 0x100d
190 #define BANDRICH_PRODUCT_100E 0x100e
192 #define BANDRICH_PRODUCT_100F 0x100f
193 #define BANDRICH_PRODUCT_1010 0x1010
194 #define BANDRICH_PRODUCT_1011 0x1011
195 #define BANDRICH_PRODUCT_1012 0x1012
197 #define AMOI_VENDOR_ID 0x1614
198 #define AMOI_PRODUCT_9508 0x0800
200 #define QUALCOMM_VENDOR_ID 0x05C6
202 #define MAXON_VENDOR_ID 0x16d8
204 #define TELIT_VENDOR_ID 0x1bc7
205 #define TELIT_PRODUCT_UC864E 0x1003
208 #define ZTE_VENDOR_ID 0x19d2
209 #define ZTE_PRODUCT_MF628 0x0015
210 #define ZTE_PRODUCT_CDMA_TECH 0xfffe
212 /* Ericsson products */
213 #define ERICSSON_VENDOR_ID 0x0bdb
214 #define ERICSSON_PRODUCT_F3507G 0x1900
216 static struct usb_device_id option_ids[] = {
217 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
218 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
219 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
220 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
221 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
222 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
223 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
224 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
225 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
226 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
227 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
228 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
229 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
230 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
231 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
232 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
233 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
234 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
235 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
236 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
237 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
238 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
239 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
240 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
241 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600, 0xff, 0xff, 0xff) },
242 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
243 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
244 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401, 0xff, 0xff, 0xff) },
245 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403, 0xff, 0xff, 0xff) },
246 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405, 0xff, 0xff, 0xff) },
247 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406, 0xff, 0xff, 0xff) },
248 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408, 0xff, 0xff, 0xff) },
249 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409, 0xff, 0xff, 0xff) },
250 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410, 0xff, 0xff, 0xff) },
251 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411, 0xff, 0xff, 0xff) },
252 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412, 0xff, 0xff, 0xff) },
253 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413, 0xff, 0xff, 0xff) },
254 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414, 0xff, 0xff, 0xff) },
255 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415, 0xff, 0xff, 0xff) },
256 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416, 0xff, 0xff, 0xff) },
257 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417, 0xff, 0xff, 0xff) },
258 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418, 0xff, 0xff, 0xff) },
259 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419, 0xff, 0xff, 0xff) },
260 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
261 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
262 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
263 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
264 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
265 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
266 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
267 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
268 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
269 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
270 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
271 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
272 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
273 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
274 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
275 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
276 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
277 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
278 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
279 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
280 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
281 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
282 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
283 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
284 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
285 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
286 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
288 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01) },
289 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01A) },
290 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H02) },
292 { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
293 { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
294 { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
295 { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
296 { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
297 { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
298 { USB_DEVICE(DELL_VENDOR_ID, 0x8129) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
299 { USB_DEVICE(DELL_VENDOR_ID, 0x8133) }, /* Dell Wireless 5720 == Novatel EV620 CDMA/EV-DO */
300 { USB_DEVICE(DELL_VENDOR_ID, 0x8136) }, /* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
301 { USB_DEVICE(DELL_VENDOR_ID, 0x8137) }, /* Dell Wireless HSDPA 5520 */
302 { USB_DEVICE(DELL_VENDOR_ID, 0x8138) }, /* Dell Wireless 5520 Voda I Mobile Broadband (3G HSDPA) Minicard */
303 { USB_DEVICE(DELL_VENDOR_ID, 0x8147) }, /* Dell Wireless 5530 Mobile Broadband (3G HSPA) Mini-Card */
304 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
305 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
306 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_620UW) },
307 { USB_DEVICE(AXESSTEL_VENDOR_ID, AXESSTEL_PRODUCT_MV110H) },
308 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_MSA501HS) },
309 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_ET502HS) },
310 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
311 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
312 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1004) },
313 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1005) },
314 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1006) },
315 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1007) },
316 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1008) },
317 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1009) },
318 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100A) },
319 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100B) },
320 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100C) },
321 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100D) },
322 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100E) },
323 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100F) },
324 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1010) },
325 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1011) },
326 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1012) },
327 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC650) },
328 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
329 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6000)}, /* ZTE AC8700 */
330 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
331 { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
332 { USB_DEVICE(TELIT_VENDOR_ID, TELIT_PRODUCT_UC864E) },
333 { USB_DEVICE(ZTE_VENDOR_ID, ZTE_PRODUCT_MF628) },
334 { USB_DEVICE(ZTE_VENDOR_ID, ZTE_PRODUCT_CDMA_TECH) },
335 { USB_DEVICE(ERICSSON_VENDOR_ID, ERICSSON_PRODUCT_F3507G) },
336 { } /* Terminating entry */
338 MODULE_DEVICE_TABLE(usb, option_ids);
340 static struct usb_driver option_driver = {
342 .probe = usb_serial_probe,
343 .disconnect = usb_serial_disconnect,
344 .id_table = option_ids,
348 /* The card has three separate interfaces, which the serial driver
349 * recognizes separately, thus num_port=1.
352 static struct usb_serial_driver option_1port_device = {
354 .owner = THIS_MODULE,
357 .description = "GSM modem (1-port)",
358 .usb_driver = &option_driver,
359 .id_table = option_ids,
362 .close = option_close,
363 .write = option_write,
364 .write_room = option_write_room,
365 .chars_in_buffer = option_chars_in_buffer,
366 .set_termios = option_set_termios,
367 .tiocmget = option_tiocmget,
368 .tiocmset = option_tiocmset,
369 .attach = option_startup,
370 .shutdown = option_shutdown,
371 .read_int_callback = option_instat_callback,
376 /* per port private data */
380 #define IN_BUFLEN 4096
381 #define OUT_BUFLEN 128
383 struct option_port_private {
384 /* Input endpoints and buffer for this port */
385 struct urb *in_urbs[N_IN_URB];
386 u8 *in_buffer[N_IN_URB];
387 /* Output endpoints and buffer for this port */
388 struct urb *out_urbs[N_OUT_URB];
389 u8 *out_buffer[N_OUT_URB];
390 unsigned long out_busy; /* Bit vector of URBs in use */
392 /* Settings for the port */
393 int rts_state; /* Handshaking pins (outputs) */
395 int cts_state; /* Handshaking pins (inputs) */
400 unsigned long tx_start_time[N_OUT_URB];
403 /* Functions used by new usb-serial code. */
404 static int __init option_init(void)
407 retval = usb_serial_register(&option_1port_device);
409 goto failed_1port_device_register;
410 retval = usb_register(&option_driver);
412 goto failed_driver_register;
414 info(DRIVER_DESC ": " DRIVER_VERSION);
418 failed_driver_register:
419 usb_serial_deregister(&option_1port_device);
420 failed_1port_device_register:
424 static void __exit option_exit(void)
426 usb_deregister(&option_driver);
427 usb_serial_deregister(&option_1port_device);
430 module_init(option_init);
431 module_exit(option_exit);
433 static void option_set_termios(struct tty_struct *tty,
434 struct usb_serial_port *port, struct ktermios *old_termios)
437 /* Doesn't support option setting */
438 tty_termios_copy_hw(tty->termios, old_termios);
439 option_send_setup(tty, port);
442 static int option_tiocmget(struct tty_struct *tty, struct file *file)
444 struct usb_serial_port *port = tty->driver_data;
446 struct option_port_private *portdata;
448 portdata = usb_get_serial_port_data(port);
450 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
451 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
452 ((portdata->cts_state) ? TIOCM_CTS : 0) |
453 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
454 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
455 ((portdata->ri_state) ? TIOCM_RNG : 0);
460 static int option_tiocmset(struct tty_struct *tty, struct file *file,
461 unsigned int set, unsigned int clear)
463 struct usb_serial_port *port = tty->driver_data;
464 struct option_port_private *portdata;
466 portdata = usb_get_serial_port_data(port);
468 /* FIXME: what locks portdata fields ? */
470 portdata->rts_state = 1;
472 portdata->dtr_state = 1;
474 if (clear & TIOCM_RTS)
475 portdata->rts_state = 0;
476 if (clear & TIOCM_DTR)
477 portdata->dtr_state = 0;
478 return option_send_setup(tty, port);
482 static int option_write(struct tty_struct *tty, struct usb_serial_port *port,
483 const unsigned char *buf, int count)
485 struct option_port_private *portdata;
488 struct urb *this_urb = NULL; /* spurious */
491 portdata = usb_get_serial_port_data(port);
493 dbg("%s: write (%d chars)", __func__, count);
497 for (i = 0; left > 0 && i < N_OUT_URB; i++) {
499 if (todo > OUT_BUFLEN)
502 this_urb = portdata->out_urbs[i];
503 if (test_and_set_bit(i, &portdata->out_busy)) {
504 if (time_before(jiffies,
505 portdata->tx_start_time[i] + 10 * HZ))
507 usb_unlink_urb(this_urb);
510 if (this_urb->status != 0)
511 dbg("usb_write %p failed (err=%d)",
512 this_urb, this_urb->status);
514 dbg("%s: endpoint %d buf %d", __func__,
515 usb_pipeendpoint(this_urb->pipe), i);
518 memcpy(this_urb->transfer_buffer, buf, todo);
519 this_urb->transfer_buffer_length = todo;
521 this_urb->dev = port->serial->dev;
522 err = usb_submit_urb(this_urb, GFP_ATOMIC);
524 dbg("usb_submit_urb %p (write bulk) failed "
525 "(%d, has %d)", this_urb,
526 err, this_urb->status);
527 clear_bit(i, &portdata->out_busy);
530 portdata->tx_start_time[i] = jiffies;
536 dbg("%s: wrote (did %d)", __func__, count);
540 static void option_indat_callback(struct urb *urb)
544 struct usb_serial_port *port;
545 struct tty_struct *tty;
546 unsigned char *data = urb->transfer_buffer;
547 int status = urb->status;
549 dbg("%s: %p", __func__, urb);
551 endpoint = usb_pipeendpoint(urb->pipe);
555 dbg("%s: nonzero status: %d on endpoint %02x.",
556 __func__, status, endpoint);
558 tty = tty_port_tty_get(&port->port);
559 if (urb->actual_length) {
560 tty_buffer_request_room(tty, urb->actual_length);
561 tty_insert_flip_string(tty, data, urb->actual_length);
562 tty_flip_buffer_push(tty);
564 dbg("%s: empty read urb received", __func__);
567 /* Resubmit urb so we continue receiving */
568 if (port->port.count && status != -ESHUTDOWN) {
569 err = usb_submit_urb(urb, GFP_ATOMIC);
571 printk(KERN_ERR "%s: resubmit read urb failed. "
572 "(%d)", __func__, err);
578 static void option_outdat_callback(struct urb *urb)
580 struct usb_serial_port *port;
581 struct option_port_private *portdata;
588 usb_serial_port_softint(port);
590 portdata = usb_get_serial_port_data(port);
591 for (i = 0; i < N_OUT_URB; ++i) {
592 if (portdata->out_urbs[i] == urb) {
593 smp_mb__before_clear_bit();
594 clear_bit(i, &portdata->out_busy);
600 static void option_instat_callback(struct urb *urb)
603 int status = urb->status;
604 struct usb_serial_port *port = urb->context;
605 struct option_port_private *portdata = usb_get_serial_port_data(port);
606 struct usb_serial *serial = port->serial;
609 dbg("%s: urb %p port %p has data %p", __func__, urb, port, portdata);
612 struct usb_ctrlrequest *req_pkt =
613 (struct usb_ctrlrequest *)urb->transfer_buffer;
616 dbg("%s: NULL req_pkt\n", __func__);
619 if ((req_pkt->bRequestType == 0xA1) &&
620 (req_pkt->bRequest == 0x20)) {
622 unsigned char signals = *((unsigned char *)
623 urb->transfer_buffer +
624 sizeof(struct usb_ctrlrequest));
626 dbg("%s: signal x%x", __func__, signals);
628 old_dcd_state = portdata->dcd_state;
629 portdata->cts_state = 1;
630 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
631 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
632 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
634 if (old_dcd_state && !portdata->dcd_state) {
635 struct tty_struct *tty =
636 tty_port_tty_get(&port->port);
637 if (tty && !C_CLOCAL(tty))
642 dbg("%s: type %x req %x", __func__,
643 req_pkt->bRequestType, req_pkt->bRequest);
646 dbg("%s: error %d", __func__, status);
648 /* Resubmit urb so we continue receiving IRQ data */
649 if (status != -ESHUTDOWN) {
650 urb->dev = serial->dev;
651 err = usb_submit_urb(urb, GFP_ATOMIC);
653 dbg("%s: resubmit intr urb failed. (%d)",
658 static int option_write_room(struct tty_struct *tty)
660 struct usb_serial_port *port = tty->driver_data;
661 struct option_port_private *portdata;
664 struct urb *this_urb;
666 portdata = usb_get_serial_port_data(port);
669 for (i = 0; i < N_OUT_URB; i++) {
670 this_urb = portdata->out_urbs[i];
671 if (this_urb && !test_bit(i, &portdata->out_busy))
672 data_len += OUT_BUFLEN;
675 dbg("%s: %d", __func__, data_len);
679 static int option_chars_in_buffer(struct tty_struct *tty)
681 struct usb_serial_port *port = tty->driver_data;
682 struct option_port_private *portdata;
685 struct urb *this_urb;
687 portdata = usb_get_serial_port_data(port);
689 for (i = 0; i < N_OUT_URB; i++) {
690 this_urb = portdata->out_urbs[i];
691 /* FIXME: This locking is insufficient as this_urb may
692 go unused during the test */
693 if (this_urb && test_bit(i, &portdata->out_busy))
694 data_len += this_urb->transfer_buffer_length;
696 dbg("%s: %d", __func__, data_len);
700 static int option_open(struct tty_struct *tty,
701 struct usb_serial_port *port, struct file *filp)
703 struct option_port_private *portdata;
704 struct usb_serial *serial = port->serial;
708 portdata = usb_get_serial_port_data(port);
712 /* Set some sane defaults */
713 portdata->rts_state = 1;
714 portdata->dtr_state = 1;
716 /* Reset low level data toggle and start reading from endpoints */
717 for (i = 0; i < N_IN_URB; i++) {
718 urb = portdata->in_urbs[i];
721 if (urb->dev != serial->dev) {
722 dbg("%s: dev %p != %p", __func__,
723 urb->dev, serial->dev);
728 * make sure endpoint data toggle is synchronized with the
731 usb_clear_halt(urb->dev, urb->pipe);
733 err = usb_submit_urb(urb, GFP_KERNEL);
735 dbg("%s: submit urb %d failed (%d) %d",
737 urb->transfer_buffer_length);
741 /* Reset low level data toggle on out endpoints */
742 for (i = 0; i < N_OUT_URB; i++) {
743 urb = portdata->out_urbs[i];
746 urb->dev = serial->dev;
747 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
748 usb_pipeout(urb->pipe), 0); */
752 tty->low_latency = 1;
754 option_send_setup(tty, port);
759 static void option_close(struct tty_struct *tty,
760 struct usb_serial_port *port, struct file *filp)
763 struct usb_serial *serial = port->serial;
764 struct option_port_private *portdata;
767 portdata = usb_get_serial_port_data(port);
769 portdata->rts_state = 0;
770 portdata->dtr_state = 0;
773 mutex_lock(&serial->disc_mutex);
774 if (!serial->disconnected)
775 option_send_setup(tty, port);
776 mutex_unlock(&serial->disc_mutex);
778 /* Stop reading/writing urbs */
779 for (i = 0; i < N_IN_URB; i++)
780 usb_kill_urb(portdata->in_urbs[i]);
781 for (i = 0; i < N_OUT_URB; i++)
782 usb_kill_urb(portdata->out_urbs[i]);
784 tty_port_tty_set(&port->port, NULL);
787 /* Helper functions used by option_setup_urbs */
788 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
789 int dir, void *ctx, char *buf, int len,
790 void (*callback)(struct urb *))
795 return NULL; /* endpoint not needed */
797 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
799 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
803 /* Fill URB using supplied data. */
804 usb_fill_bulk_urb(urb, serial->dev,
805 usb_sndbulkpipe(serial->dev, endpoint) | dir,
806 buf, len, callback, ctx);
812 static void option_setup_urbs(struct usb_serial *serial)
815 struct usb_serial_port *port;
816 struct option_port_private *portdata;
820 for (i = 0; i < serial->num_ports; i++) {
821 port = serial->port[i];
822 portdata = usb_get_serial_port_data(port);
824 /* Do indat endpoints first */
825 for (j = 0; j < N_IN_URB; ++j) {
826 portdata->in_urbs[j] = option_setup_urb(serial,
827 port->bulk_in_endpointAddress,
829 portdata->in_buffer[j],
830 IN_BUFLEN, option_indat_callback);
833 /* outdat endpoints */
834 for (j = 0; j < N_OUT_URB; ++j) {
835 portdata->out_urbs[j] = option_setup_urb(serial,
836 port->bulk_out_endpointAddress,
838 portdata->out_buffer[j],
839 OUT_BUFLEN, option_outdat_callback);
845 /** send RTS/DTR state to the port.
847 * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
850 static int option_send_setup(struct tty_struct *tty,
851 struct usb_serial_port *port)
853 struct usb_serial *serial = port->serial;
854 struct option_port_private *portdata;
855 int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
858 portdata = usb_get_serial_port_data(port);
862 if (portdata->dtr_state)
864 if (portdata->rts_state)
867 return usb_control_msg(serial->dev,
868 usb_rcvctrlpipe(serial->dev, 0),
869 0x22, 0x21, val, ifNum, NULL, 0, USB_CTRL_SET_TIMEOUT);
874 static int option_startup(struct usb_serial *serial)
877 struct usb_serial_port *port;
878 struct option_port_private *portdata;
883 /* Now setup per port private data */
884 for (i = 0; i < serial->num_ports; i++) {
885 port = serial->port[i];
886 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
888 dbg("%s: kmalloc for option_port_private (%d) failed!.",
893 for (j = 0; j < N_IN_URB; j++) {
894 buffer = (u8 *)__get_free_page(GFP_KERNEL);
897 portdata->in_buffer[j] = buffer;
900 for (j = 0; j < N_OUT_URB; j++) {
901 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
903 goto bail_out_error2;
904 portdata->out_buffer[j] = buffer;
907 usb_set_serial_port_data(port, portdata);
909 if (!port->interrupt_in_urb)
911 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
913 dbg("%s: submit irq_in urb failed %d",
916 option_setup_urbs(serial);
920 for (j = 0; j < N_OUT_URB; j++)
921 kfree(portdata->out_buffer[j]);
923 for (j = 0; j < N_IN_URB; j++)
924 if (portdata->in_buffer[j])
925 free_page((unsigned long)portdata->in_buffer[j]);
930 static void option_shutdown(struct usb_serial *serial)
933 struct usb_serial_port *port;
934 struct option_port_private *portdata;
938 /* Stop reading/writing urbs */
939 for (i = 0; i < serial->num_ports; ++i) {
940 port = serial->port[i];
941 portdata = usb_get_serial_port_data(port);
942 for (j = 0; j < N_IN_URB; j++)
943 usb_kill_urb(portdata->in_urbs[j]);
944 for (j = 0; j < N_OUT_URB; j++)
945 usb_kill_urb(portdata->out_urbs[j]);
949 for (i = 0; i < serial->num_ports; ++i) {
950 port = serial->port[i];
951 portdata = usb_get_serial_port_data(port);
953 for (j = 0; j < N_IN_URB; j++) {
954 if (portdata->in_urbs[j]) {
955 usb_free_urb(portdata->in_urbs[j]);
956 free_page((unsigned long)
957 portdata->in_buffer[j]);
958 portdata->in_urbs[j] = NULL;
961 for (j = 0; j < N_OUT_URB; j++) {
962 if (portdata->out_urbs[j]) {
963 usb_free_urb(portdata->out_urbs[j]);
964 kfree(portdata->out_buffer[j]);
965 portdata->out_urbs[j] = NULL;
970 /* Now free per port private data */
971 for (i = 0; i < serial->num_ports; i++) {
972 port = serial->port[i];
973 kfree(usb_get_serial_port_data(port));
977 MODULE_AUTHOR(DRIVER_AUTHOR);
978 MODULE_DESCRIPTION(DRIVER_DESC);
979 MODULE_VERSION(DRIVER_VERSION);
980 MODULE_LICENSE("GPL");
982 module_param(debug, bool, S_IRUGO | S_IWUSR);
983 MODULE_PARM_DESC(debug, "Debug messages");