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
221 #define ZTE_PRODUCT_CDMA_TECH 0xfffe
223 /* Ericsson products */
224 #define ERICSSON_VENDOR_ID 0x0bdb
225 #define ERICSSON_PRODUCT_F3507G 0x1900
227 static struct usb_device_id option_ids[] = {
228 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
229 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
230 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
231 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
232 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
233 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
234 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
235 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
236 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
237 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
238 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
239 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
240 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
241 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
242 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
243 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
244 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
245 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
246 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
247 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
248 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
249 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
250 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
251 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
252 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
253 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
254 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
255 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
256 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
257 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
258 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
259 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
260 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
261 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
262 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
263 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600, 0xff, 0xff, 0xff) },
264 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
265 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
266 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401, 0xff, 0xff, 0xff) },
267 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403, 0xff, 0xff, 0xff) },
268 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405, 0xff, 0xff, 0xff) },
269 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406, 0xff, 0xff, 0xff) },
270 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408, 0xff, 0xff, 0xff) },
271 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409, 0xff, 0xff, 0xff) },
272 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410, 0xff, 0xff, 0xff) },
273 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411, 0xff, 0xff, 0xff) },
274 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412, 0xff, 0xff, 0xff) },
275 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413, 0xff, 0xff, 0xff) },
276 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414, 0xff, 0xff, 0xff) },
277 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415, 0xff, 0xff, 0xff) },
278 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416, 0xff, 0xff, 0xff) },
279 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417, 0xff, 0xff, 0xff) },
280 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418, 0xff, 0xff, 0xff) },
281 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419, 0xff, 0xff, 0xff) },
282 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
283 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
284 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
285 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
286 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
287 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
288 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
289 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
290 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
291 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
292 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
293 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
294 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
295 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
296 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
297 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
298 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
299 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
300 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
301 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
302 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
303 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
304 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
305 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
306 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
307 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
308 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
310 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01) },
311 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01A) },
312 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H02) },
314 { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
315 { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
316 { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
317 { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
318 { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
319 { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
320 { USB_DEVICE(DELL_VENDOR_ID, 0x8129) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
321 { USB_DEVICE(DELL_VENDOR_ID, 0x8133) }, /* Dell Wireless 5720 == Novatel EV620 CDMA/EV-DO */
322 { USB_DEVICE(DELL_VENDOR_ID, 0x8136) }, /* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
323 { USB_DEVICE(DELL_VENDOR_ID, 0x8137) }, /* Dell Wireless HSDPA 5520 */
324 { USB_DEVICE(DELL_VENDOR_ID, 0x8138) }, /* Dell Wireless 5520 Voda I Mobile Broadband (3G HSDPA) Minicard */
325 { USB_DEVICE(DELL_VENDOR_ID, 0x8147) }, /* Dell Wireless 5530 Mobile Broadband (3G HSPA) Mini-Card */
326 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
327 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
328 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_620UW) },
329 { USB_DEVICE(AXESSTEL_VENDOR_ID, AXESSTEL_PRODUCT_MV110H) },
330 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_MSA501HS) },
331 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_ET502HS) },
332 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
333 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
334 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1004) },
335 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1005) },
336 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1006) },
337 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1007) },
338 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1008) },
339 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1009) },
340 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100A) },
341 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100B) },
342 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100C) },
343 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100D) },
344 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100E) },
345 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_100F) },
346 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1010) },
347 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1011) },
348 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_1012) },
349 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC650) },
350 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
351 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6000)}, /* ZTE AC8700 */
352 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
353 { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
354 { USB_DEVICE(TELIT_VENDOR_ID, TELIT_PRODUCT_UC864E) },
355 { USB_DEVICE(ZTE_VENDOR_ID, ZTE_PRODUCT_MF628) },
356 { USB_DEVICE(ZTE_VENDOR_ID, ZTE_PRODUCT_CDMA_TECH) },
357 { USB_DEVICE(ERICSSON_VENDOR_ID, ERICSSON_PRODUCT_F3507G) },
358 { } /* Terminating entry */
360 MODULE_DEVICE_TABLE(usb, option_ids);
362 static struct usb_driver option_driver = {
364 .probe = usb_serial_probe,
365 .disconnect = usb_serial_disconnect,
366 .id_table = option_ids,
370 /* The card has three separate interfaces, which the serial driver
371 * recognizes separately, thus num_port=1.
374 static struct usb_serial_driver option_1port_device = {
376 .owner = THIS_MODULE,
379 .description = "GSM modem (1-port)",
380 .usb_driver = &option_driver,
381 .id_table = option_ids,
384 .close = option_close,
385 .write = option_write,
386 .write_room = option_write_room,
387 .chars_in_buffer = option_chars_in_buffer,
388 .set_termios = option_set_termios,
389 .tiocmget = option_tiocmget,
390 .tiocmset = option_tiocmset,
391 .attach = option_startup,
392 .shutdown = option_shutdown,
393 .read_int_callback = option_instat_callback,
398 /* per port private data */
402 #define IN_BUFLEN 4096
403 #define OUT_BUFLEN 128
405 struct option_port_private {
406 /* Input endpoints and buffer for this port */
407 struct urb *in_urbs[N_IN_URB];
408 u8 *in_buffer[N_IN_URB];
409 /* Output endpoints and buffer for this port */
410 struct urb *out_urbs[N_OUT_URB];
411 u8 *out_buffer[N_OUT_URB];
412 unsigned long out_busy; /* Bit vector of URBs in use */
414 /* Settings for the port */
415 int rts_state; /* Handshaking pins (outputs) */
417 int cts_state; /* Handshaking pins (inputs) */
422 unsigned long tx_start_time[N_OUT_URB];
425 /* Functions used by new usb-serial code. */
426 static int __init option_init(void)
429 retval = usb_serial_register(&option_1port_device);
431 goto failed_1port_device_register;
432 retval = usb_register(&option_driver);
434 goto failed_driver_register;
436 info(DRIVER_DESC ": " DRIVER_VERSION);
440 failed_driver_register:
441 usb_serial_deregister(&option_1port_device);
442 failed_1port_device_register:
446 static void __exit option_exit(void)
448 usb_deregister(&option_driver);
449 usb_serial_deregister(&option_1port_device);
452 module_init(option_init);
453 module_exit(option_exit);
455 static void option_set_termios(struct tty_struct *tty,
456 struct usb_serial_port *port, struct ktermios *old_termios)
459 /* Doesn't support option setting */
460 tty_termios_copy_hw(tty->termios, old_termios);
461 option_send_setup(tty, port);
464 static int option_tiocmget(struct tty_struct *tty, struct file *file)
466 struct usb_serial_port *port = tty->driver_data;
468 struct option_port_private *portdata;
470 portdata = usb_get_serial_port_data(port);
472 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
473 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
474 ((portdata->cts_state) ? TIOCM_CTS : 0) |
475 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
476 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
477 ((portdata->ri_state) ? TIOCM_RNG : 0);
482 static int option_tiocmset(struct tty_struct *tty, struct file *file,
483 unsigned int set, unsigned int clear)
485 struct usb_serial_port *port = tty->driver_data;
486 struct option_port_private *portdata;
488 portdata = usb_get_serial_port_data(port);
490 /* FIXME: what locks portdata fields ? */
492 portdata->rts_state = 1;
494 portdata->dtr_state = 1;
496 if (clear & TIOCM_RTS)
497 portdata->rts_state = 0;
498 if (clear & TIOCM_DTR)
499 portdata->dtr_state = 0;
500 return option_send_setup(tty, port);
504 static int option_write(struct tty_struct *tty, struct usb_serial_port *port,
505 const unsigned char *buf, int count)
507 struct option_port_private *portdata;
510 struct urb *this_urb = NULL; /* spurious */
513 portdata = usb_get_serial_port_data(port);
515 dbg("%s: write (%d chars)", __func__, count);
519 for (i = 0; left > 0 && i < N_OUT_URB; i++) {
521 if (todo > OUT_BUFLEN)
524 this_urb = portdata->out_urbs[i];
525 if (test_and_set_bit(i, &portdata->out_busy)) {
526 if (time_before(jiffies,
527 portdata->tx_start_time[i] + 10 * HZ))
529 usb_unlink_urb(this_urb);
532 if (this_urb->status != 0)
533 dbg("usb_write %p failed (err=%d)",
534 this_urb, this_urb->status);
536 dbg("%s: endpoint %d buf %d", __func__,
537 usb_pipeendpoint(this_urb->pipe), i);
540 memcpy(this_urb->transfer_buffer, buf, todo);
541 this_urb->transfer_buffer_length = todo;
543 this_urb->dev = port->serial->dev;
544 err = usb_submit_urb(this_urb, GFP_ATOMIC);
546 dbg("usb_submit_urb %p (write bulk) failed "
547 "(%d, has %d)", this_urb,
548 err, this_urb->status);
549 clear_bit(i, &portdata->out_busy);
552 portdata->tx_start_time[i] = jiffies;
558 dbg("%s: wrote (did %d)", __func__, count);
562 static void option_indat_callback(struct urb *urb)
566 struct usb_serial_port *port;
567 struct tty_struct *tty;
568 unsigned char *data = urb->transfer_buffer;
569 int status = urb->status;
571 dbg("%s: %p", __func__, urb);
573 endpoint = usb_pipeendpoint(urb->pipe);
577 dbg("%s: nonzero status: %d on endpoint %02x.",
578 __func__, status, endpoint);
580 tty = tty_port_tty_get(&port->port);
581 if (urb->actual_length) {
582 tty_buffer_request_room(tty, urb->actual_length);
583 tty_insert_flip_string(tty, data, urb->actual_length);
584 tty_flip_buffer_push(tty);
586 dbg("%s: empty read urb received", __func__);
589 /* Resubmit urb so we continue receiving */
590 if (port->port.count && status != -ESHUTDOWN) {
591 err = usb_submit_urb(urb, GFP_ATOMIC);
593 printk(KERN_ERR "%s: resubmit read urb failed. "
594 "(%d)", __func__, err);
600 static void option_outdat_callback(struct urb *urb)
602 struct usb_serial_port *port;
603 struct option_port_private *portdata;
610 usb_serial_port_softint(port);
612 portdata = usb_get_serial_port_data(port);
613 for (i = 0; i < N_OUT_URB; ++i) {
614 if (portdata->out_urbs[i] == urb) {
615 smp_mb__before_clear_bit();
616 clear_bit(i, &portdata->out_busy);
622 static void option_instat_callback(struct urb *urb)
625 int status = urb->status;
626 struct usb_serial_port *port = urb->context;
627 struct option_port_private *portdata = usb_get_serial_port_data(port);
628 struct usb_serial *serial = port->serial;
631 dbg("%s: urb %p port %p has data %p", __func__, urb, port, portdata);
634 struct usb_ctrlrequest *req_pkt =
635 (struct usb_ctrlrequest *)urb->transfer_buffer;
638 dbg("%s: NULL req_pkt\n", __func__);
641 if ((req_pkt->bRequestType == 0xA1) &&
642 (req_pkt->bRequest == 0x20)) {
644 unsigned char signals = *((unsigned char *)
645 urb->transfer_buffer +
646 sizeof(struct usb_ctrlrequest));
648 dbg("%s: signal x%x", __func__, signals);
650 old_dcd_state = portdata->dcd_state;
651 portdata->cts_state = 1;
652 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
653 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
654 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
656 if (old_dcd_state && !portdata->dcd_state) {
657 struct tty_struct *tty =
658 tty_port_tty_get(&port->port);
659 if (tty && !C_CLOCAL(tty))
664 dbg("%s: type %x req %x", __func__,
665 req_pkt->bRequestType, req_pkt->bRequest);
668 dbg("%s: error %d", __func__, status);
670 /* Resubmit urb so we continue receiving IRQ data */
671 if (status != -ESHUTDOWN) {
672 urb->dev = serial->dev;
673 err = usb_submit_urb(urb, GFP_ATOMIC);
675 dbg("%s: resubmit intr urb failed. (%d)",
680 static int option_write_room(struct tty_struct *tty)
682 struct usb_serial_port *port = tty->driver_data;
683 struct option_port_private *portdata;
686 struct urb *this_urb;
688 portdata = usb_get_serial_port_data(port);
691 for (i = 0; i < N_OUT_URB; i++) {
692 this_urb = portdata->out_urbs[i];
693 if (this_urb && !test_bit(i, &portdata->out_busy))
694 data_len += OUT_BUFLEN;
697 dbg("%s: %d", __func__, data_len);
701 static int option_chars_in_buffer(struct tty_struct *tty)
703 struct usb_serial_port *port = tty->driver_data;
704 struct option_port_private *portdata;
707 struct urb *this_urb;
709 portdata = usb_get_serial_port_data(port);
711 for (i = 0; i < N_OUT_URB; i++) {
712 this_urb = portdata->out_urbs[i];
713 /* FIXME: This locking is insufficient as this_urb may
714 go unused during the test */
715 if (this_urb && test_bit(i, &portdata->out_busy))
716 data_len += this_urb->transfer_buffer_length;
718 dbg("%s: %d", __func__, data_len);
722 static int option_open(struct tty_struct *tty,
723 struct usb_serial_port *port, struct file *filp)
725 struct option_port_private *portdata;
726 struct usb_serial *serial = port->serial;
730 portdata = usb_get_serial_port_data(port);
734 /* Set some sane defaults */
735 portdata->rts_state = 1;
736 portdata->dtr_state = 1;
738 /* Reset low level data toggle and start reading from endpoints */
739 for (i = 0; i < N_IN_URB; i++) {
740 urb = portdata->in_urbs[i];
743 if (urb->dev != serial->dev) {
744 dbg("%s: dev %p != %p", __func__,
745 urb->dev, serial->dev);
750 * make sure endpoint data toggle is synchronized with the
753 usb_clear_halt(urb->dev, urb->pipe);
755 err = usb_submit_urb(urb, GFP_KERNEL);
757 dbg("%s: submit urb %d failed (%d) %d",
759 urb->transfer_buffer_length);
763 /* Reset low level data toggle on out endpoints */
764 for (i = 0; i < N_OUT_URB; i++) {
765 urb = portdata->out_urbs[i];
768 urb->dev = serial->dev;
769 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
770 usb_pipeout(urb->pipe), 0); */
774 tty->low_latency = 1;
776 option_send_setup(tty, port);
781 static void option_close(struct tty_struct *tty,
782 struct usb_serial_port *port, struct file *filp)
785 struct usb_serial *serial = port->serial;
786 struct option_port_private *portdata;
789 portdata = usb_get_serial_port_data(port);
791 portdata->rts_state = 0;
792 portdata->dtr_state = 0;
795 mutex_lock(&serial->disc_mutex);
796 if (!serial->disconnected)
797 option_send_setup(tty, port);
798 mutex_unlock(&serial->disc_mutex);
800 /* Stop reading/writing urbs */
801 for (i = 0; i < N_IN_URB; i++)
802 usb_kill_urb(portdata->in_urbs[i]);
803 for (i = 0; i < N_OUT_URB; i++)
804 usb_kill_urb(portdata->out_urbs[i]);
806 tty_port_tty_set(&port->port, NULL);
809 /* Helper functions used by option_setup_urbs */
810 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
811 int dir, void *ctx, char *buf, int len,
812 void (*callback)(struct urb *))
817 return NULL; /* endpoint not needed */
819 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
821 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
825 /* Fill URB using supplied data. */
826 usb_fill_bulk_urb(urb, serial->dev,
827 usb_sndbulkpipe(serial->dev, endpoint) | dir,
828 buf, len, callback, ctx);
834 static void option_setup_urbs(struct usb_serial *serial)
837 struct usb_serial_port *port;
838 struct option_port_private *portdata;
842 for (i = 0; i < serial->num_ports; i++) {
843 port = serial->port[i];
844 portdata = usb_get_serial_port_data(port);
846 /* Do indat endpoints first */
847 for (j = 0; j < N_IN_URB; ++j) {
848 portdata->in_urbs[j] = option_setup_urb(serial,
849 port->bulk_in_endpointAddress,
851 portdata->in_buffer[j],
852 IN_BUFLEN, option_indat_callback);
855 /* outdat endpoints */
856 for (j = 0; j < N_OUT_URB; ++j) {
857 portdata->out_urbs[j] = option_setup_urb(serial,
858 port->bulk_out_endpointAddress,
860 portdata->out_buffer[j],
861 OUT_BUFLEN, option_outdat_callback);
867 /** send RTS/DTR state to the port.
869 * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
872 static int option_send_setup(struct tty_struct *tty,
873 struct usb_serial_port *port)
875 struct usb_serial *serial = port->serial;
876 struct option_port_private *portdata;
877 int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
880 portdata = usb_get_serial_port_data(port);
884 if (portdata->dtr_state)
886 if (portdata->rts_state)
889 return usb_control_msg(serial->dev,
890 usb_rcvctrlpipe(serial->dev, 0),
891 0x22, 0x21, val, ifNum, NULL, 0, USB_CTRL_SET_TIMEOUT);
896 static int option_startup(struct usb_serial *serial)
899 struct usb_serial_port *port;
900 struct option_port_private *portdata;
905 /* Now setup per port private data */
906 for (i = 0; i < serial->num_ports; i++) {
907 port = serial->port[i];
908 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
910 dbg("%s: kmalloc for option_port_private (%d) failed!.",
915 for (j = 0; j < N_IN_URB; j++) {
916 buffer = (u8 *)__get_free_page(GFP_KERNEL);
919 portdata->in_buffer[j] = buffer;
922 for (j = 0; j < N_OUT_URB; j++) {
923 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
925 goto bail_out_error2;
926 portdata->out_buffer[j] = buffer;
929 usb_set_serial_port_data(port, portdata);
931 if (!port->interrupt_in_urb)
933 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
935 dbg("%s: submit irq_in urb failed %d",
938 option_setup_urbs(serial);
942 for (j = 0; j < N_OUT_URB; j++)
943 kfree(portdata->out_buffer[j]);
945 for (j = 0; j < N_IN_URB; j++)
946 if (portdata->in_buffer[j])
947 free_page((unsigned long)portdata->in_buffer[j]);
952 static void option_shutdown(struct usb_serial *serial)
955 struct usb_serial_port *port;
956 struct option_port_private *portdata;
960 /* Stop reading/writing urbs */
961 for (i = 0; i < serial->num_ports; ++i) {
962 port = serial->port[i];
963 portdata = usb_get_serial_port_data(port);
964 for (j = 0; j < N_IN_URB; j++)
965 usb_kill_urb(portdata->in_urbs[j]);
966 for (j = 0; j < N_OUT_URB; j++)
967 usb_kill_urb(portdata->out_urbs[j]);
971 for (i = 0; i < serial->num_ports; ++i) {
972 port = serial->port[i];
973 portdata = usb_get_serial_port_data(port);
975 for (j = 0; j < N_IN_URB; j++) {
976 if (portdata->in_urbs[j]) {
977 usb_free_urb(portdata->in_urbs[j]);
978 free_page((unsigned long)
979 portdata->in_buffer[j]);
980 portdata->in_urbs[j] = NULL;
983 for (j = 0; j < N_OUT_URB; j++) {
984 if (portdata->out_urbs[j]) {
985 usb_free_urb(portdata->out_urbs[j]);
986 kfree(portdata->out_buffer[j]);
987 portdata->out_urbs[j] = NULL;
992 /* Now free per port private data */
993 for (i = 0; i < serial->num_ports; i++) {
994 port = serial->port[i];
995 kfree(usb_get_serial_port_data(port));
999 MODULE_AUTHOR(DRIVER_AUTHOR);
1000 MODULE_DESCRIPTION(DRIVER_DESC);
1001 MODULE_VERSION(DRIVER_VERSION);
1002 MODULE_LICENSE("GPL");
1004 module_param(debug, bool, S_IRUGO | S_IWUSR);
1005 MODULE_PARM_DESC(debug, "Debug messages");