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, struct file *filp);
47 static void option_close(struct tty_struct *tty, struct usb_serial_port *port, struct file *filp);
48 static int option_startup(struct usb_serial *serial);
49 static void option_shutdown(struct usb_serial *serial);
50 static int option_write_room(struct tty_struct *tty);
52 static void option_instat_callback(struct urb *urb);
54 static int option_write(struct tty_struct *tty, struct usb_serial_port *port,
55 const unsigned char *buf, int count);
56 static int option_chars_in_buffer(struct tty_struct *tty);
57 static void option_set_termios(struct tty_struct *tty,
58 struct usb_serial_port *port, struct ktermios *old);
59 static int option_tiocmget(struct tty_struct *tty, struct file *file);
60 static int option_tiocmset(struct tty_struct *tty, struct file *file,
61 unsigned int set, unsigned int clear);
62 static int option_send_setup(struct tty_struct *tty, struct usb_serial_port *port);
64 /* Vendor and product IDs */
65 #define OPTION_VENDOR_ID 0x0AF0
66 #define OPTION_PRODUCT_COLT 0x5000
67 #define OPTION_PRODUCT_RICOLA 0x6000
68 #define OPTION_PRODUCT_RICOLA_LIGHT 0x6100
69 #define OPTION_PRODUCT_RICOLA_QUAD 0x6200
70 #define OPTION_PRODUCT_RICOLA_QUAD_LIGHT 0x6300
71 #define OPTION_PRODUCT_RICOLA_NDIS 0x6050
72 #define OPTION_PRODUCT_RICOLA_NDIS_LIGHT 0x6150
73 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD 0x6250
74 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT 0x6350
75 #define OPTION_PRODUCT_COBRA 0x6500
76 #define OPTION_PRODUCT_COBRA_BUS 0x6501
77 #define OPTION_PRODUCT_VIPER 0x6600
78 #define OPTION_PRODUCT_VIPER_BUS 0x6601
79 #define OPTION_PRODUCT_GT_MAX_READY 0x6701
80 #define OPTION_PRODUCT_GT_MAX 0x6711
81 #define OPTION_PRODUCT_FUJI_MODEM_LIGHT 0x6721
82 #define OPTION_PRODUCT_FUJI_MODEM_GT 0x6741
83 #define OPTION_PRODUCT_FUJI_MODEM_EX 0x6761
84 #define OPTION_PRODUCT_FUJI_NETWORK_LIGHT 0x6731
85 #define OPTION_PRODUCT_FUJI_NETWORK_GT 0x6751
86 #define OPTION_PRODUCT_FUJI_NETWORK_EX 0x6771
87 #define OPTION_PRODUCT_KOI_MODEM 0x6800
88 #define OPTION_PRODUCT_KOI_NETWORK 0x6811
89 #define OPTION_PRODUCT_SCORPION_MODEM 0x6901
90 #define OPTION_PRODUCT_SCORPION_NETWORK 0x6911
91 #define OPTION_PRODUCT_ETNA_MODEM 0x7001
92 #define OPTION_PRODUCT_ETNA_NETWORK 0x7011
93 #define OPTION_PRODUCT_ETNA_MODEM_LITE 0x7021
94 #define OPTION_PRODUCT_ETNA_MODEM_GT 0x7041
95 #define OPTION_PRODUCT_ETNA_MODEM_EX 0x7061
96 #define OPTION_PRODUCT_ETNA_NETWORK_LITE 0x7031
97 #define OPTION_PRODUCT_ETNA_NETWORK_GT 0x7051
98 #define OPTION_PRODUCT_ETNA_NETWORK_EX 0x7071
99 #define OPTION_PRODUCT_ETNA_KOI_MODEM 0x7100
100 #define OPTION_PRODUCT_ETNA_KOI_NETWORK 0x7111
102 #define HUAWEI_VENDOR_ID 0x12D1
103 #define HUAWEI_PRODUCT_E600 0x1001
104 #define HUAWEI_PRODUCT_E220 0x1003
105 #define HUAWEI_PRODUCT_E220BIS 0x1004
106 #define HUAWEI_PRODUCT_E1401 0x1401
107 #define HUAWEI_PRODUCT_E1403 0x1403
108 #define HUAWEI_PRODUCT_E1405 0x1405
109 #define HUAWEI_PRODUCT_E1406 0x1406
110 #define HUAWEI_PRODUCT_E1408 0x1408
111 #define HUAWEI_PRODUCT_E1409 0x1409
112 #define HUAWEI_PRODUCT_E1410 0x1410
113 #define HUAWEI_PRODUCT_E1411 0x1411
114 #define HUAWEI_PRODUCT_E1412 0x1412
115 #define HUAWEI_PRODUCT_E1413 0x1413
116 #define HUAWEI_PRODUCT_E1414 0x1414
117 #define HUAWEI_PRODUCT_E1415 0x1415
118 #define HUAWEI_PRODUCT_E1416 0x1416
119 #define HUAWEI_PRODUCT_E1417 0x1417
120 #define HUAWEI_PRODUCT_E1418 0x1418
121 #define HUAWEI_PRODUCT_E1419 0x1419
123 #define NOVATELWIRELESS_VENDOR_ID 0x1410
125 /* MERLIN EVDO PRODUCTS */
126 #define NOVATELWIRELESS_PRODUCT_V640 0x1100
127 #define NOVATELWIRELESS_PRODUCT_V620 0x1110
128 #define NOVATELWIRELESS_PRODUCT_V740 0x1120
129 #define NOVATELWIRELESS_PRODUCT_V720 0x1130
131 /* MERLIN HSDPA/HSPA PRODUCTS */
132 #define NOVATELWIRELESS_PRODUCT_U730 0x1400
133 #define NOVATELWIRELESS_PRODUCT_U740 0x1410
134 #define NOVATELWIRELESS_PRODUCT_U870 0x1420
135 #define NOVATELWIRELESS_PRODUCT_XU870 0x1430
136 #define NOVATELWIRELESS_PRODUCT_X950D 0x1450
138 /* EXPEDITE PRODUCTS */
139 #define NOVATELWIRELESS_PRODUCT_EV620 0x2100
140 #define NOVATELWIRELESS_PRODUCT_ES720 0x2110
141 #define NOVATELWIRELESS_PRODUCT_E725 0x2120
142 #define NOVATELWIRELESS_PRODUCT_ES620 0x2130
143 #define NOVATELWIRELESS_PRODUCT_EU730 0x2400
144 #define NOVATELWIRELESS_PRODUCT_EU740 0x2410
145 #define NOVATELWIRELESS_PRODUCT_EU870D 0x2420
147 /* OVATION PRODUCTS */
148 #define NOVATELWIRELESS_PRODUCT_MC727 0x4100
149 #define NOVATELWIRELESS_PRODUCT_MC950D 0x4400
151 /* FUTURE NOVATEL PRODUCTS */
152 #define NOVATELWIRELESS_PRODUCT_EVDO_1 0x6000
153 #define NOVATELWIRELESS_PRODUCT_HSPA_1 0x7000
154 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_1 0x8000
155 #define NOVATELWIRELESS_PRODUCT_GLOBAL_1 0x9000
156 #define NOVATELWIRELESS_PRODUCT_EVDO_2 0x6001
157 #define NOVATELWIRELESS_PRODUCT_HSPA_2 0x7001
158 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_2 0x8001
159 #define NOVATELWIRELESS_PRODUCT_GLOBAL_2 0x9001
162 #define AMOI_VENDOR_ID 0x1614
163 #define AMOI_PRODUCT_H01 0x0800
164 #define AMOI_PRODUCT_H01A 0x7002
165 #define AMOI_PRODUCT_H02 0x0802
167 #define DELL_VENDOR_ID 0x413C
169 #define KYOCERA_VENDOR_ID 0x0c88
170 #define KYOCERA_PRODUCT_KPC650 0x17da
171 #define KYOCERA_PRODUCT_KPC680 0x180a
173 #define ANYDATA_VENDOR_ID 0x16d5
174 #define ANYDATA_PRODUCT_ADU_E100A 0x6501
175 #define ANYDATA_PRODUCT_ADU_500A 0x6502
177 #define AXESSTEL_VENDOR_ID 0x1726
178 #define AXESSTEL_PRODUCT_MV110H 0x1000
180 #define ONDA_VENDOR_ID 0x19d2
181 #define ONDA_PRODUCT_MSA501HS 0x0001
182 #define ONDA_PRODUCT_ET502HS 0x0002
184 #define BANDRICH_VENDOR_ID 0x1A8D
185 #define BANDRICH_PRODUCT_C100_1 0x1002
186 #define BANDRICH_PRODUCT_C100_2 0x1003
188 #define AMOI_VENDOR_ID 0x1614
189 #define AMOI_PRODUCT_9508 0x0800
191 #define QUALCOMM_VENDOR_ID 0x05C6
193 #define MAXON_VENDOR_ID 0x16d8
195 #define TELIT_VENDOR_ID 0x1bc7
196 #define TELIT_PRODUCT_UC864E 0x1003
198 static struct usb_device_id option_ids[] = {
199 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
200 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
201 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
202 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
203 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
204 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
205 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
206 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
207 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
208 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
209 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
210 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
211 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
212 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
213 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
214 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
215 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
216 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
217 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
218 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
219 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
220 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
221 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
222 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
223 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
224 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
225 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
226 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
227 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
228 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
229 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
230 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
231 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
232 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
233 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
234 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600, 0xff, 0xff, 0xff) },
235 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
236 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
237 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401, 0xff, 0xff, 0xff) },
238 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403, 0xff, 0xff, 0xff) },
239 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405, 0xff, 0xff, 0xff) },
240 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406, 0xff, 0xff, 0xff) },
241 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408, 0xff, 0xff, 0xff) },
242 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409, 0xff, 0xff, 0xff) },
243 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410, 0xff, 0xff, 0xff) },
244 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411, 0xff, 0xff, 0xff) },
245 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412, 0xff, 0xff, 0xff) },
246 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413, 0xff, 0xff, 0xff) },
247 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414, 0xff, 0xff, 0xff) },
248 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415, 0xff, 0xff, 0xff) },
249 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416, 0xff, 0xff, 0xff) },
250 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417, 0xff, 0xff, 0xff) },
251 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418, 0xff, 0xff, 0xff) },
252 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419, 0xff, 0xff, 0xff) },
253 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
254 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
255 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
256 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
257 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
258 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
259 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
260 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
261 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
262 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
263 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
264 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
265 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
266 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
267 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
268 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
269 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
270 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
271 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
272 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
273 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
274 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
275 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
276 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
277 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
278 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
279 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
281 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01) },
282 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01A) },
283 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H02) },
285 { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
286 { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
287 { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
288 { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
289 { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
290 { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
291 { USB_DEVICE(DELL_VENDOR_ID, 0x8129) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
292 { USB_DEVICE(DELL_VENDOR_ID, 0x8133) }, /* Dell Wireless 5720 == Novatel EV620 CDMA/EV-DO */
293 { USB_DEVICE(DELL_VENDOR_ID, 0x8136) }, /* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
294 { USB_DEVICE(DELL_VENDOR_ID, 0x8137) }, /* Dell Wireless HSDPA 5520 */
295 { USB_DEVICE(DELL_VENDOR_ID, 0x8138) }, /* Dell Wireless 5520 Voda I Mobile Broadband (3G HSDPA) Minicard */
296 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
297 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
298 { USB_DEVICE(AXESSTEL_VENDOR_ID, AXESSTEL_PRODUCT_MV110H) },
299 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_MSA501HS) },
300 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_ET502HS) },
301 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
302 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
303 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC650) },
304 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
305 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6000)}, /* ZTE AC8700 */
306 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
307 { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
308 { USB_DEVICE(TELIT_VENDOR_ID, TELIT_PRODUCT_UC864E) },
309 { } /* Terminating entry */
311 MODULE_DEVICE_TABLE(usb, option_ids);
313 static struct usb_driver option_driver = {
315 .probe = usb_serial_probe,
316 .disconnect = usb_serial_disconnect,
317 .id_table = option_ids,
321 /* The card has three separate interfaces, which the serial driver
322 * recognizes separately, thus num_port=1.
325 static struct usb_serial_driver option_1port_device = {
327 .owner = THIS_MODULE,
330 .description = "GSM modem (1-port)",
331 .usb_driver = &option_driver,
332 .id_table = option_ids,
335 .close = option_close,
336 .write = option_write,
337 .write_room = option_write_room,
338 .chars_in_buffer = option_chars_in_buffer,
339 .set_termios = option_set_termios,
340 .tiocmget = option_tiocmget,
341 .tiocmset = option_tiocmset,
342 .attach = option_startup,
343 .shutdown = option_shutdown,
344 .read_int_callback = option_instat_callback,
347 #ifdef CONFIG_USB_DEBUG
353 /* per port private data */
357 #define IN_BUFLEN 4096
358 #define OUT_BUFLEN 128
360 struct option_port_private {
361 /* Input endpoints and buffer for this port */
362 struct urb *in_urbs[N_IN_URB];
363 u8 *in_buffer[N_IN_URB];
364 /* Output endpoints and buffer for this port */
365 struct urb *out_urbs[N_OUT_URB];
366 u8 *out_buffer[N_OUT_URB];
367 unsigned long out_busy; /* Bit vector of URBs in use */
369 /* Settings for the port */
370 int rts_state; /* Handshaking pins (outputs) */
372 int cts_state; /* Handshaking pins (inputs) */
377 unsigned long tx_start_time[N_OUT_URB];
380 /* Functions used by new usb-serial code. */
381 static int __init option_init(void)
384 retval = usb_serial_register(&option_1port_device);
386 goto failed_1port_device_register;
387 retval = usb_register(&option_driver);
389 goto failed_driver_register;
391 info(DRIVER_DESC ": " DRIVER_VERSION);
395 failed_driver_register:
396 usb_serial_deregister (&option_1port_device);
397 failed_1port_device_register:
401 static void __exit option_exit(void)
403 usb_deregister (&option_driver);
404 usb_serial_deregister (&option_1port_device);
407 module_init(option_init);
408 module_exit(option_exit);
410 static void option_set_termios(struct tty_struct *tty,
411 struct usb_serial_port *port, struct ktermios *old_termios)
414 /* Doesn't support option setting */
415 tty_termios_copy_hw(tty->termios, old_termios);
416 option_send_setup(tty, port);
419 static int option_tiocmget(struct tty_struct *tty, struct file *file)
421 struct usb_serial_port *port = tty->driver_data;
423 struct option_port_private *portdata;
425 portdata = usb_get_serial_port_data(port);
427 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
428 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
429 ((portdata->cts_state) ? TIOCM_CTS : 0) |
430 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
431 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
432 ((portdata->ri_state) ? TIOCM_RNG : 0);
437 static int option_tiocmset(struct tty_struct *tty, struct file *file,
438 unsigned int set, unsigned int clear)
440 struct usb_serial_port *port = tty->driver_data;
441 struct option_port_private *portdata;
443 portdata = usb_get_serial_port_data(port);
445 /* FIXME: what locks portdata fields ? */
447 portdata->rts_state = 1;
449 portdata->dtr_state = 1;
451 if (clear & TIOCM_RTS)
452 portdata->rts_state = 0;
453 if (clear & TIOCM_DTR)
454 portdata->dtr_state = 0;
455 return option_send_setup(tty, port);
459 static int option_write(struct tty_struct *tty, struct usb_serial_port *port,
460 const unsigned char *buf, int count)
462 struct option_port_private *portdata;
465 struct urb *this_urb = NULL; /* spurious */
468 portdata = usb_get_serial_port_data(port);
470 dbg("%s: write (%d chars)", __func__, count);
474 for (i=0; left > 0 && i < N_OUT_URB; i++) {
476 if (todo > OUT_BUFLEN)
479 this_urb = portdata->out_urbs[i];
480 if (test_and_set_bit(i, &portdata->out_busy)) {
481 if (time_before(jiffies,
482 portdata->tx_start_time[i] + 10 * HZ))
484 usb_unlink_urb(this_urb);
487 if (this_urb->status != 0)
488 dbg("usb_write %p failed (err=%d)",
489 this_urb, this_urb->status);
491 dbg("%s: endpoint %d buf %d", __func__,
492 usb_pipeendpoint(this_urb->pipe), i);
495 memcpy (this_urb->transfer_buffer, buf, todo);
496 this_urb->transfer_buffer_length = todo;
498 this_urb->dev = port->serial->dev;
499 err = usb_submit_urb(this_urb, GFP_ATOMIC);
501 dbg("usb_submit_urb %p (write bulk) failed "
502 "(%d, has %d)", this_urb,
503 err, this_urb->status);
504 clear_bit(i, &portdata->out_busy);
507 portdata->tx_start_time[i] = jiffies;
513 dbg("%s: wrote (did %d)", __func__, count);
517 static void option_indat_callback(struct urb *urb)
521 struct usb_serial_port *port;
522 struct tty_struct *tty;
523 unsigned char *data = urb->transfer_buffer;
524 int status = urb->status;
526 dbg("%s: %p", __func__, urb);
528 endpoint = usb_pipeendpoint(urb->pipe);
532 dbg("%s: nonzero status: %d on endpoint %02x.",
533 __func__, status, endpoint);
535 tty = port->port.tty;
536 if (urb->actual_length) {
537 tty_buffer_request_room(tty, urb->actual_length);
538 tty_insert_flip_string(tty, data, urb->actual_length);
539 tty_flip_buffer_push(tty);
541 dbg("%s: empty read urb received", __func__);
544 /* Resubmit urb so we continue receiving */
545 if (port->port.count && status != -ESHUTDOWN) {
546 err = usb_submit_urb(urb, GFP_ATOMIC);
548 printk(KERN_ERR "%s: resubmit read urb failed. "
549 "(%d)", __func__, err);
555 static void option_outdat_callback(struct urb *urb)
557 struct usb_serial_port *port;
558 struct option_port_private *portdata;
565 usb_serial_port_softint(port);
567 portdata = usb_get_serial_port_data(port);
568 for (i = 0; i < N_OUT_URB; ++i) {
569 if (portdata->out_urbs[i] == urb) {
570 smp_mb__before_clear_bit();
571 clear_bit(i, &portdata->out_busy);
577 static void option_instat_callback(struct urb *urb)
580 int status = urb->status;
581 struct usb_serial_port *port = urb->context;
582 struct option_port_private *portdata = usb_get_serial_port_data(port);
583 struct usb_serial *serial = port->serial;
586 dbg("%s: urb %p port %p has data %p", __func__,urb,port,portdata);
589 struct usb_ctrlrequest *req_pkt =
590 (struct usb_ctrlrequest *)urb->transfer_buffer;
593 dbg("%s: NULL req_pkt\n", __func__);
596 if ((req_pkt->bRequestType == 0xA1) &&
597 (req_pkt->bRequest == 0x20)) {
599 unsigned char signals = *((unsigned char *)
600 urb->transfer_buffer +
601 sizeof(struct usb_ctrlrequest));
603 dbg("%s: signal x%x", __func__, signals);
605 old_dcd_state = portdata->dcd_state;
606 portdata->cts_state = 1;
607 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
608 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
609 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
611 if (port->port.tty && !C_CLOCAL(port->port.tty) &&
612 old_dcd_state && !portdata->dcd_state)
613 tty_hangup(port->port.tty);
615 dbg("%s: type %x req %x", __func__,
616 req_pkt->bRequestType,req_pkt->bRequest);
619 dbg("%s: error %d", __func__, status);
621 /* Resubmit urb so we continue receiving IRQ data */
622 if (status != -ESHUTDOWN) {
623 urb->dev = serial->dev;
624 err = usb_submit_urb(urb, GFP_ATOMIC);
626 dbg("%s: resubmit intr urb failed. (%d)",
631 static int option_write_room(struct tty_struct *tty)
633 struct usb_serial_port *port = tty->driver_data;
634 struct option_port_private *portdata;
637 struct urb *this_urb;
639 portdata = usb_get_serial_port_data(port);
642 for (i=0; i < N_OUT_URB; i++) {
643 this_urb = portdata->out_urbs[i];
644 if (this_urb && !test_bit(i, &portdata->out_busy))
645 data_len += OUT_BUFLEN;
648 dbg("%s: %d", __func__, data_len);
652 static int option_chars_in_buffer(struct tty_struct *tty)
654 struct usb_serial_port *port = tty->driver_data;
655 struct option_port_private *portdata;
658 struct urb *this_urb;
660 portdata = usb_get_serial_port_data(port);
662 for (i=0; i < N_OUT_URB; i++) {
663 this_urb = portdata->out_urbs[i];
664 /* FIXME: This locking is insufficient as this_urb may
665 go unused during the test */
666 if (this_urb && test_bit(i, &portdata->out_busy))
667 data_len += this_urb->transfer_buffer_length;
669 dbg("%s: %d", __func__, data_len);
673 static int option_open(struct tty_struct *tty,
674 struct usb_serial_port *port, struct file *filp)
676 struct option_port_private *portdata;
677 struct usb_serial *serial = port->serial;
681 portdata = usb_get_serial_port_data(port);
685 /* Set some sane defaults */
686 portdata->rts_state = 1;
687 portdata->dtr_state = 1;
689 /* Reset low level data toggle and start reading from endpoints */
690 for (i = 0; i < N_IN_URB; i++) {
691 urb = portdata->in_urbs[i];
694 if (urb->dev != serial->dev) {
695 dbg("%s: dev %p != %p", __func__,
696 urb->dev, serial->dev);
701 * make sure endpoint data toggle is synchronized with the
704 usb_clear_halt(urb->dev, urb->pipe);
706 err = usb_submit_urb(urb, GFP_KERNEL);
708 dbg("%s: submit urb %d failed (%d) %d",
710 urb->transfer_buffer_length);
714 /* Reset low level data toggle on out endpoints */
715 for (i = 0; i < N_OUT_URB; i++) {
716 urb = portdata->out_urbs[i];
719 urb->dev = serial->dev;
720 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
721 usb_pipeout(urb->pipe), 0); */
725 tty->low_latency = 1;
727 option_send_setup(tty, port);
732 static void option_close(struct tty_struct *tty,
733 struct usb_serial_port *port, struct file *filp)
736 struct usb_serial *serial = port->serial;
737 struct option_port_private *portdata;
740 portdata = usb_get_serial_port_data(port);
742 portdata->rts_state = 0;
743 portdata->dtr_state = 0;
746 mutex_lock(&serial->disc_mutex);
747 if (!serial->disconnected)
748 option_send_setup(tty, port);
749 mutex_unlock(&serial->disc_mutex);
751 /* Stop reading/writing urbs */
752 for (i = 0; i < N_IN_URB; i++)
753 usb_kill_urb(portdata->in_urbs[i]);
754 for (i = 0; i < N_OUT_URB; i++)
755 usb_kill_urb(portdata->out_urbs[i]);
757 port->port.tty = NULL; /* FIXME */
760 /* Helper functions used by option_setup_urbs */
761 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
762 int dir, void *ctx, char *buf, int len,
763 void (*callback)(struct urb *))
768 return NULL; /* endpoint not needed */
770 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
772 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
776 /* Fill URB using supplied data. */
777 usb_fill_bulk_urb(urb, serial->dev,
778 usb_sndbulkpipe(serial->dev, endpoint) | dir,
779 buf, len, callback, ctx);
785 static void option_setup_urbs(struct usb_serial *serial)
788 struct usb_serial_port *port;
789 struct option_port_private *portdata;
793 for (i = 0; i < serial->num_ports; i++) {
794 port = serial->port[i];
795 portdata = usb_get_serial_port_data(port);
797 /* Do indat endpoints first */
798 for (j = 0; j < N_IN_URB; ++j) {
799 portdata->in_urbs[j] = option_setup_urb (serial,
800 port->bulk_in_endpointAddress, USB_DIR_IN, port,
801 portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
804 /* outdat endpoints */
805 for (j = 0; j < N_OUT_URB; ++j) {
806 portdata->out_urbs[j] = option_setup_urb (serial,
807 port->bulk_out_endpointAddress, USB_DIR_OUT, port,
808 portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
814 /** send RTS/DTR state to the port.
816 * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
819 static int option_send_setup(struct tty_struct *tty,
820 struct usb_serial_port *port)
822 struct usb_serial *serial = port->serial;
823 struct option_port_private *portdata;
824 int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
827 portdata = usb_get_serial_port_data(port);
831 if (portdata->dtr_state)
833 if (portdata->rts_state)
836 return usb_control_msg(serial->dev,
837 usb_rcvctrlpipe(serial->dev, 0),
838 0x22,0x21,val,ifNum,NULL,0,USB_CTRL_SET_TIMEOUT);
843 static int option_startup(struct usb_serial *serial)
846 struct usb_serial_port *port;
847 struct option_port_private *portdata;
852 /* Now setup per port private data */
853 for (i = 0; i < serial->num_ports; i++) {
854 port = serial->port[i];
855 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
857 dbg("%s: kmalloc for option_port_private (%d) failed!.",
862 for (j = 0; j < N_IN_URB; j++) {
863 buffer = (u8 *)__get_free_page(GFP_KERNEL);
866 portdata->in_buffer[j] = buffer;
869 for (j = 0; j < N_OUT_URB; j++) {
870 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
872 goto bail_out_error2;
873 portdata->out_buffer[j] = buffer;
876 usb_set_serial_port_data(port, portdata);
878 if (! port->interrupt_in_urb)
880 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
882 dbg("%s: submit irq_in urb failed %d",
886 option_setup_urbs(serial);
891 for (j = 0; j < N_OUT_URB; j++)
892 kfree(portdata->out_buffer[j]);
894 for (j = 0; j < N_IN_URB; j++)
895 if (portdata->in_buffer[j])
896 free_page((unsigned long)portdata->in_buffer[j]);
901 static void option_shutdown(struct usb_serial *serial)
904 struct usb_serial_port *port;
905 struct option_port_private *portdata;
909 /* Stop reading/writing urbs */
910 for (i = 0; i < serial->num_ports; ++i) {
911 port = serial->port[i];
912 portdata = usb_get_serial_port_data(port);
913 for (j = 0; j < N_IN_URB; j++)
914 usb_kill_urb(portdata->in_urbs[j]);
915 for (j = 0; j < N_OUT_URB; j++)
916 usb_kill_urb(portdata->out_urbs[j]);
920 for (i = 0; i < serial->num_ports; ++i) {
921 port = serial->port[i];
922 portdata = usb_get_serial_port_data(port);
924 for (j = 0; j < N_IN_URB; j++) {
925 if (portdata->in_urbs[j]) {
926 usb_free_urb(portdata->in_urbs[j]);
927 free_page((unsigned long)portdata->in_buffer[j]);
928 portdata->in_urbs[j] = NULL;
931 for (j = 0; j < N_OUT_URB; j++) {
932 if (portdata->out_urbs[j]) {
933 usb_free_urb(portdata->out_urbs[j]);
934 kfree(portdata->out_buffer[j]);
935 portdata->out_urbs[j] = NULL;
940 /* Now free per port private data */
941 for (i = 0; i < serial->num_ports; i++) {
942 port = serial->port[i];
943 kfree(usb_get_serial_port_data(port));
947 MODULE_AUTHOR(DRIVER_AUTHOR);
948 MODULE_DESCRIPTION(DRIVER_DESC);
949 MODULE_VERSION(DRIVER_VERSION);
950 MODULE_LICENSE("GPL");
952 #ifdef CONFIG_USB_DEBUG
953 module_param(debug, bool, S_IRUGO | S_IWUSR);
954 MODULE_PARM_DESC(debug, "Debug messages");