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 usb_serial_port *port, struct file *filp);
47 static void option_close(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 void option_rx_throttle(struct usb_serial_port *port);
51 static void option_rx_unthrottle(struct usb_serial_port *port);
52 static int option_write_room(struct usb_serial_port *port);
54 static void option_instat_callback(struct urb *urb);
56 static int option_write(struct usb_serial_port *port,
57 const unsigned char *buf, int count);
59 static int option_chars_in_buffer(struct usb_serial_port *port);
60 static int option_ioctl(struct usb_serial_port *port, struct file *file,
61 unsigned int cmd, unsigned long arg);
62 static void option_set_termios(struct usb_serial_port *port,
63 struct ktermios *old);
64 static void option_break_ctl(struct usb_serial_port *port, int break_state);
65 static int option_tiocmget(struct usb_serial_port *port, struct file *file);
66 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
67 unsigned int set, unsigned int clear);
68 static int option_send_setup(struct usb_serial_port *port);
70 /* Vendor and product IDs */
71 #define OPTION_VENDOR_ID 0x0AF0
72 #define OPTION_PRODUCT_COLT 0x5000
73 #define OPTION_PRODUCT_RICOLA 0x6000
74 #define OPTION_PRODUCT_RICOLA_LIGHT 0x6100
75 #define OPTION_PRODUCT_RICOLA_QUAD 0x6200
76 #define OPTION_PRODUCT_RICOLA_QUAD_LIGHT 0x6300
77 #define OPTION_PRODUCT_RICOLA_NDIS 0x6050
78 #define OPTION_PRODUCT_RICOLA_NDIS_LIGHT 0x6150
79 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD 0x6250
80 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT 0x6350
81 #define OPTION_PRODUCT_COBRA 0x6500
82 #define OPTION_PRODUCT_COBRA_BUS 0x6501
83 #define OPTION_PRODUCT_VIPER 0x6600
84 #define OPTION_PRODUCT_VIPER_BUS 0x6601
85 #define OPTION_PRODUCT_GT_MAX_READY 0x6701
86 #define OPTION_PRODUCT_GT_MAX 0x6711
87 #define OPTION_PRODUCT_FUJI_MODEM_LIGHT 0x6721
88 #define OPTION_PRODUCT_FUJI_MODEM_GT 0x6741
89 #define OPTION_PRODUCT_FUJI_MODEM_EX 0x6761
90 #define OPTION_PRODUCT_FUJI_NETWORK_LIGHT 0x6731
91 #define OPTION_PRODUCT_FUJI_NETWORK_GT 0x6751
92 #define OPTION_PRODUCT_FUJI_NETWORK_EX 0x6771
93 #define OPTION_PRODUCT_KOI_MODEM 0x6800
94 #define OPTION_PRODUCT_KOI_NETWORK 0x6811
95 #define OPTION_PRODUCT_SCORPION_MODEM 0x6901
96 #define OPTION_PRODUCT_SCORPION_NETWORK 0x6911
97 #define OPTION_PRODUCT_ETNA_MODEM 0x7001
98 #define OPTION_PRODUCT_ETNA_NETWORK 0x7011
99 #define OPTION_PRODUCT_ETNA_MODEM_LITE 0x7021
100 #define OPTION_PRODUCT_ETNA_MODEM_GT 0x7041
101 #define OPTION_PRODUCT_ETNA_MODEM_EX 0x7061
102 #define OPTION_PRODUCT_ETNA_NETWORK_LITE 0x7031
103 #define OPTION_PRODUCT_ETNA_NETWORK_GT 0x7051
104 #define OPTION_PRODUCT_ETNA_NETWORK_EX 0x7071
105 #define OPTION_PRODUCT_ETNA_KOI_MODEM 0x7100
106 #define OPTION_PRODUCT_ETNA_KOI_NETWORK 0x7111
108 #define HUAWEI_VENDOR_ID 0x12D1
109 #define HUAWEI_PRODUCT_E600 0x1001
110 #define HUAWEI_PRODUCT_E220 0x1003
111 #define HUAWEI_PRODUCT_E220BIS 0x1004
112 #define HUAWEI_PRODUCT_E1401 0x1401
113 #define HUAWEI_PRODUCT_E1403 0x1403
114 #define HUAWEI_PRODUCT_E1405 0x1405
115 #define HUAWEI_PRODUCT_E1406 0x1406
116 #define HUAWEI_PRODUCT_E1408 0x1408
117 #define HUAWEI_PRODUCT_E1409 0x1409
118 #define HUAWEI_PRODUCT_E1410 0x1410
119 #define HUAWEI_PRODUCT_E1411 0x1411
120 #define HUAWEI_PRODUCT_E1412 0x1412
121 #define HUAWEI_PRODUCT_E1413 0x1413
122 #define HUAWEI_PRODUCT_E1414 0x1414
123 #define HUAWEI_PRODUCT_E1415 0x1415
124 #define HUAWEI_PRODUCT_E1416 0x1416
125 #define HUAWEI_PRODUCT_E1417 0x1417
126 #define HUAWEI_PRODUCT_E1418 0x1418
127 #define HUAWEI_PRODUCT_E1419 0x1419
129 #define NOVATELWIRELESS_VENDOR_ID 0x1410
131 /* MERLIN EVDO PRODUCTS */
132 #define NOVATELWIRELESS_PRODUCT_V640 0x1100
133 #define NOVATELWIRELESS_PRODUCT_V620 0x1110
134 #define NOVATELWIRELESS_PRODUCT_V740 0x1120
135 #define NOVATELWIRELESS_PRODUCT_V720 0x1130
137 /* MERLIN HSDPA/HSPA PRODUCTS */
138 #define NOVATELWIRELESS_PRODUCT_U730 0x1400
139 #define NOVATELWIRELESS_PRODUCT_U740 0x1410
140 #define NOVATELWIRELESS_PRODUCT_U870 0x1420
141 #define NOVATELWIRELESS_PRODUCT_XU870 0x1430
142 #define NOVATELWIRELESS_PRODUCT_X950D 0x1450
144 /* EXPEDITE PRODUCTS */
145 #define NOVATELWIRELESS_PRODUCT_EV620 0x2100
146 #define NOVATELWIRELESS_PRODUCT_ES720 0x2110
147 #define NOVATELWIRELESS_PRODUCT_E725 0x2120
148 #define NOVATELWIRELESS_PRODUCT_ES620 0x2130
149 #define NOVATELWIRELESS_PRODUCT_EU730 0x2400
150 #define NOVATELWIRELESS_PRODUCT_EU740 0x2410
151 #define NOVATELWIRELESS_PRODUCT_EU870D 0x2420
153 /* OVATION PRODUCTS */
154 #define NOVATELWIRELESS_PRODUCT_MC727 0x4100
155 #define NOVATELWIRELESS_PRODUCT_MC950D 0x4400
157 /* FUTURE NOVATEL PRODUCTS */
158 #define NOVATELWIRELESS_PRODUCT_EVDO_1 0x6000
159 #define NOVATELWIRELESS_PRODUCT_HSPA_1 0x7000
160 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_1 0x8000
161 #define NOVATELWIRELESS_PRODUCT_GLOBAL_1 0x9000
162 #define NOVATELWIRELESS_PRODUCT_EVDO_2 0x6001
163 #define NOVATELWIRELESS_PRODUCT_HSPA_2 0x7001
164 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_2 0x8001
165 #define NOVATELWIRELESS_PRODUCT_GLOBAL_2 0x9001
168 #define AMOI_VENDOR_ID 0x1614
169 #define AMOI_PRODUCT_H01 0x0800
170 #define AMOI_PRODUCT_H01A 0x7002
171 #define AMOI_PRODUCT_H02 0x0802
173 #define DELL_VENDOR_ID 0x413C
175 #define KYOCERA_VENDOR_ID 0x0c88
176 #define KYOCERA_PRODUCT_KPC680 0x180a
178 #define ANYDATA_VENDOR_ID 0x16d5
179 #define ANYDATA_PRODUCT_ADU_E100A 0x6501
180 #define ANYDATA_PRODUCT_ADU_500A 0x6502
182 #define AXESSTEL_VENDOR_ID 0x1726
183 #define AXESSTEL_PRODUCT_MV110H 0x1000
185 #define ONDA_VENDOR_ID 0x19d2
186 #define ONDA_PRODUCT_MSA501HS 0x0001
187 #define ONDA_PRODUCT_ET502HS 0x0002
189 #define BANDRICH_VENDOR_ID 0x1A8D
190 #define BANDRICH_PRODUCT_C100_1 0x1002
191 #define BANDRICH_PRODUCT_C100_2 0x1003
193 #define AMOI_VENDOR_ID 0x1614
194 #define AMOI_PRODUCT_9508 0x0800
196 #define QUALCOMM_VENDOR_ID 0x05C6
198 #define MAXON_VENDOR_ID 0x16d8
200 #define TELIT_VENDOR_ID 0x1bc7
201 #define TELIT_PRODUCT_UC864E 0x1003
203 static struct usb_device_id option_ids[] = {
204 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
205 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
206 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
207 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
208 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
209 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
210 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
211 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
212 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
213 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
214 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
215 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
216 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
217 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
218 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
219 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
220 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
221 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
222 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
223 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
224 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
225 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
226 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
227 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
228 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
229 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
230 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
231 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
232 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
233 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
234 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
235 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
236 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
237 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
238 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
239 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600, 0xff, 0xff, 0xff) },
240 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
241 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
242 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401, 0xff, 0xff, 0xff) },
243 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403, 0xff, 0xff, 0xff) },
244 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405, 0xff, 0xff, 0xff) },
245 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406, 0xff, 0xff, 0xff) },
246 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408, 0xff, 0xff, 0xff) },
247 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409, 0xff, 0xff, 0xff) },
248 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410, 0xff, 0xff, 0xff) },
249 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411, 0xff, 0xff, 0xff) },
250 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412, 0xff, 0xff, 0xff) },
251 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413, 0xff, 0xff, 0xff) },
252 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414, 0xff, 0xff, 0xff) },
253 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415, 0xff, 0xff, 0xff) },
254 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416, 0xff, 0xff, 0xff) },
255 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417, 0xff, 0xff, 0xff) },
256 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418, 0xff, 0xff, 0xff) },
257 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419, 0xff, 0xff, 0xff) },
258 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
259 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
260 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
261 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
262 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
263 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
264 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
265 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
266 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
267 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
268 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
269 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
270 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
271 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
272 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
273 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
274 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
275 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
276 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
277 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
278 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
279 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
280 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
281 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
282 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
283 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
284 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
286 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01) },
287 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01A) },
288 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H02) },
290 { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
291 { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
292 { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
293 { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
294 { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
295 { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
296 { USB_DEVICE(DELL_VENDOR_ID, 0x8129) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
297 { USB_DEVICE(DELL_VENDOR_ID, 0x8133) }, /* Dell Wireless 5720 == Novatel EV620 CDMA/EV-DO */
298 { USB_DEVICE(DELL_VENDOR_ID, 0x8136) }, /* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
299 { USB_DEVICE(DELL_VENDOR_ID, 0x8137) }, /* Dell Wireless HSDPA 5520 */
300 { USB_DEVICE(DELL_VENDOR_ID, 0x8138) }, /* Dell Wireless 5520 Voda I Mobile Broadband (3G HSDPA) Minicard */
301 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
302 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
303 { USB_DEVICE(AXESSTEL_VENDOR_ID, AXESSTEL_PRODUCT_MV110H) },
304 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_MSA501HS) },
305 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_ET502HS) },
306 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
307 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
308 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
309 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
310 { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
311 { USB_DEVICE(TELIT_VENDOR_ID, TELIT_PRODUCT_UC864E) },
312 { } /* Terminating entry */
314 MODULE_DEVICE_TABLE(usb, option_ids);
316 static struct usb_driver option_driver = {
318 .probe = usb_serial_probe,
319 .disconnect = usb_serial_disconnect,
320 .id_table = option_ids,
324 /* The card has three separate interfaces, which the serial driver
325 * recognizes separately, thus num_port=1.
328 static struct usb_serial_driver option_1port_device = {
330 .owner = THIS_MODULE,
333 .description = "GSM modem (1-port)",
334 .usb_driver = &option_driver,
335 .id_table = option_ids,
338 .close = option_close,
339 .write = option_write,
340 .write_room = option_write_room,
341 .chars_in_buffer = option_chars_in_buffer,
342 .throttle = option_rx_throttle,
343 .unthrottle = option_rx_unthrottle,
344 .ioctl = option_ioctl,
345 .set_termios = option_set_termios,
346 .break_ctl = option_break_ctl,
347 .tiocmget = option_tiocmget,
348 .tiocmset = option_tiocmset,
349 .attach = option_startup,
350 .shutdown = option_shutdown,
351 .read_int_callback = option_instat_callback,
354 #ifdef CONFIG_USB_DEBUG
360 /* per port private data */
364 #define IN_BUFLEN 4096
365 #define OUT_BUFLEN 128
367 struct option_port_private {
368 /* Input endpoints and buffer for this port */
369 struct urb *in_urbs[N_IN_URB];
370 u8 *in_buffer[N_IN_URB];
371 /* Output endpoints and buffer for this port */
372 struct urb *out_urbs[N_OUT_URB];
373 u8 *out_buffer[N_OUT_URB];
374 unsigned long out_busy; /* Bit vector of URBs in use */
376 /* Settings for the port */
377 int rts_state; /* Handshaking pins (outputs) */
379 int cts_state; /* Handshaking pins (inputs) */
384 unsigned long tx_start_time[N_OUT_URB];
387 /* Functions used by new usb-serial code. */
388 static int __init option_init(void)
391 retval = usb_serial_register(&option_1port_device);
393 goto failed_1port_device_register;
394 retval = usb_register(&option_driver);
396 goto failed_driver_register;
398 info(DRIVER_DESC ": " DRIVER_VERSION);
402 failed_driver_register:
403 usb_serial_deregister (&option_1port_device);
404 failed_1port_device_register:
408 static void __exit option_exit(void)
410 usb_deregister (&option_driver);
411 usb_serial_deregister (&option_1port_device);
414 module_init(option_init);
415 module_exit(option_exit);
417 static void option_rx_throttle(struct usb_serial_port *port)
422 static void option_rx_unthrottle(struct usb_serial_port *port)
427 static void option_break_ctl(struct usb_serial_port *port, int break_state)
429 /* Unfortunately, I don't know how to send a break */
433 static void option_set_termios(struct usb_serial_port *port,
434 struct ktermios *old_termios)
437 /* Doesn't support option setting */
438 tty_termios_copy_hw(port->tty->termios, old_termios);
439 option_send_setup(port);
442 static int option_tiocmget(struct usb_serial_port *port, struct file *file)
445 struct option_port_private *portdata;
447 portdata = usb_get_serial_port_data(port);
449 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
450 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
451 ((portdata->cts_state) ? TIOCM_CTS : 0) |
452 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
453 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
454 ((portdata->ri_state) ? TIOCM_RNG : 0);
459 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
460 unsigned int set, unsigned int clear)
462 struct option_port_private *portdata;
464 portdata = usb_get_serial_port_data(port);
466 /* FIXME: what locks portdata fields ? */
468 portdata->rts_state = 1;
470 portdata->dtr_state = 1;
472 if (clear & TIOCM_RTS)
473 portdata->rts_state = 0;
474 if (clear & TIOCM_DTR)
475 portdata->dtr_state = 0;
476 return option_send_setup(port);
479 static int option_ioctl(struct usb_serial_port *port, struct file *file,
480 unsigned int cmd, unsigned long arg)
486 static int option_write(struct usb_serial_port *port,
487 const unsigned char *buf, int count)
489 struct option_port_private *portdata;
492 struct urb *this_urb = NULL; /* spurious */
495 portdata = usb_get_serial_port_data(port);
497 dbg("%s: write (%d chars)", __func__, count);
501 for (i=0; left > 0 && i < N_OUT_URB; i++) {
503 if (todo > OUT_BUFLEN)
506 this_urb = portdata->out_urbs[i];
507 if (test_and_set_bit(i, &portdata->out_busy)) {
508 if (time_before(jiffies,
509 portdata->tx_start_time[i] + 10 * HZ))
511 usb_unlink_urb(this_urb);
514 if (this_urb->status != 0)
515 dbg("usb_write %p failed (err=%d)",
516 this_urb, this_urb->status);
518 dbg("%s: endpoint %d buf %d", __func__,
519 usb_pipeendpoint(this_urb->pipe), i);
522 memcpy (this_urb->transfer_buffer, buf, todo);
523 this_urb->transfer_buffer_length = todo;
525 this_urb->dev = port->serial->dev;
526 err = usb_submit_urb(this_urb, GFP_ATOMIC);
528 dbg("usb_submit_urb %p (write bulk) failed "
529 "(%d, has %d)", this_urb,
530 err, this_urb->status);
531 clear_bit(i, &portdata->out_busy);
534 portdata->tx_start_time[i] = jiffies;
540 dbg("%s: wrote (did %d)", __func__, count);
544 static void option_indat_callback(struct urb *urb)
548 struct usb_serial_port *port;
549 struct tty_struct *tty;
550 unsigned char *data = urb->transfer_buffer;
551 int status = urb->status;
553 dbg("%s: %p", __func__, urb);
555 endpoint = usb_pipeendpoint(urb->pipe);
559 dbg("%s: nonzero status: %d on endpoint %02x.",
560 __func__, status, endpoint);
563 if (urb->actual_length) {
564 tty_buffer_request_room(tty, urb->actual_length);
565 tty_insert_flip_string(tty, data, urb->actual_length);
566 tty_flip_buffer_push(tty);
568 dbg("%s: empty read urb received", __func__);
571 /* Resubmit urb so we continue receiving */
572 if (port->open_count && status != -ESHUTDOWN) {
573 err = usb_submit_urb(urb, GFP_ATOMIC);
575 printk(KERN_ERR "%s: resubmit read urb failed. "
576 "(%d)", __func__, err);
582 static void option_outdat_callback(struct urb *urb)
584 struct usb_serial_port *port;
585 struct option_port_private *portdata;
592 usb_serial_port_softint(port);
594 portdata = usb_get_serial_port_data(port);
595 for (i = 0; i < N_OUT_URB; ++i) {
596 if (portdata->out_urbs[i] == urb) {
597 smp_mb__before_clear_bit();
598 clear_bit(i, &portdata->out_busy);
604 static void option_instat_callback(struct urb *urb)
607 int status = urb->status;
608 struct usb_serial_port *port = urb->context;
609 struct option_port_private *portdata = usb_get_serial_port_data(port);
610 struct usb_serial *serial = port->serial;
613 dbg("%s: urb %p port %p has data %p", __func__,urb,port,portdata);
616 struct usb_ctrlrequest *req_pkt =
617 (struct usb_ctrlrequest *)urb->transfer_buffer;
620 dbg("%s: NULL req_pkt\n", __func__);
623 if ((req_pkt->bRequestType == 0xA1) &&
624 (req_pkt->bRequest == 0x20)) {
626 unsigned char signals = *((unsigned char *)
627 urb->transfer_buffer +
628 sizeof(struct usb_ctrlrequest));
630 dbg("%s: signal x%x", __func__, signals);
632 old_dcd_state = portdata->dcd_state;
633 portdata->cts_state = 1;
634 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
635 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
636 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
638 if (port->tty && !C_CLOCAL(port->tty) &&
639 old_dcd_state && !portdata->dcd_state)
640 tty_hangup(port->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 usb_serial_port *port)
660 struct option_port_private *portdata;
663 struct urb *this_urb;
665 portdata = usb_get_serial_port_data(port);
668 for (i=0; i < N_OUT_URB; i++) {
669 this_urb = portdata->out_urbs[i];
670 if (this_urb && !test_bit(i, &portdata->out_busy))
671 data_len += OUT_BUFLEN;
674 dbg("%s: %d", __func__, data_len);
678 static int option_chars_in_buffer(struct usb_serial_port *port)
680 struct option_port_private *portdata;
683 struct urb *this_urb;
685 portdata = usb_get_serial_port_data(port);
687 for (i=0; i < N_OUT_URB; i++) {
688 this_urb = portdata->out_urbs[i];
689 /* FIXME: This locking is insufficient as this_urb may
690 go unused during the test */
691 if (this_urb && test_bit(i, &portdata->out_busy))
692 data_len += this_urb->transfer_buffer_length;
694 dbg("%s: %d", __func__, data_len);
698 static int option_open(struct usb_serial_port *port, struct file *filp)
700 struct option_port_private *portdata;
701 struct usb_serial *serial = port->serial;
705 portdata = usb_get_serial_port_data(port);
709 /* Set some sane defaults */
710 portdata->rts_state = 1;
711 portdata->dtr_state = 1;
713 /* Reset low level data toggle and start reading from endpoints */
714 for (i = 0; i < N_IN_URB; i++) {
715 urb = portdata->in_urbs[i];
718 if (urb->dev != serial->dev) {
719 dbg("%s: dev %p != %p", __func__,
720 urb->dev, serial->dev);
725 * make sure endpoint data toggle is synchronized with the
728 usb_clear_halt(urb->dev, urb->pipe);
730 err = usb_submit_urb(urb, GFP_KERNEL);
732 dbg("%s: submit urb %d failed (%d) %d",
734 urb->transfer_buffer_length);
738 /* Reset low level data toggle on out endpoints */
739 for (i = 0; i < N_OUT_URB; i++) {
740 urb = portdata->out_urbs[i];
743 urb->dev = serial->dev;
744 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
745 usb_pipeout(urb->pipe), 0); */
748 port->tty->low_latency = 1;
750 option_send_setup(port);
755 static void option_close(struct usb_serial_port *port, struct file *filp)
758 struct usb_serial *serial = port->serial;
759 struct option_port_private *portdata;
762 portdata = usb_get_serial_port_data(port);
764 portdata->rts_state = 0;
765 portdata->dtr_state = 0;
768 mutex_lock(&serial->disc_mutex);
769 if (!serial->disconnected)
770 option_send_setup(port);
771 mutex_unlock(&serial->disc_mutex);
773 /* Stop reading/writing urbs */
774 for (i = 0; i < N_IN_URB; i++)
775 usb_kill_urb(portdata->in_urbs[i]);
776 for (i = 0; i < N_OUT_URB; i++)
777 usb_kill_urb(portdata->out_urbs[i]);
782 /* Helper functions used by option_setup_urbs */
783 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
784 int dir, void *ctx, char *buf, int len,
785 void (*callback)(struct urb *))
790 return NULL; /* endpoint not needed */
792 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
794 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
798 /* Fill URB using supplied data. */
799 usb_fill_bulk_urb(urb, serial->dev,
800 usb_sndbulkpipe(serial->dev, endpoint) | dir,
801 buf, len, callback, ctx);
807 static void option_setup_urbs(struct usb_serial *serial)
810 struct usb_serial_port *port;
811 struct option_port_private *portdata;
815 for (i = 0; i < serial->num_ports; i++) {
816 port = serial->port[i];
817 portdata = usb_get_serial_port_data(port);
819 /* Do indat endpoints first */
820 for (j = 0; j < N_IN_URB; ++j) {
821 portdata->in_urbs[j] = option_setup_urb (serial,
822 port->bulk_in_endpointAddress, USB_DIR_IN, port,
823 portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
826 /* outdat endpoints */
827 for (j = 0; j < N_OUT_URB; ++j) {
828 portdata->out_urbs[j] = option_setup_urb (serial,
829 port->bulk_out_endpointAddress, USB_DIR_OUT, port,
830 portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
836 /** send RTS/DTR state to the port.
838 * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
841 static int option_send_setup(struct usb_serial_port *port)
843 struct usb_serial *serial = port->serial;
844 struct option_port_private *portdata;
845 int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
848 portdata = usb_get_serial_port_data(port);
852 if (portdata->dtr_state)
854 if (portdata->rts_state)
857 return usb_control_msg(serial->dev,
858 usb_rcvctrlpipe(serial->dev, 0),
859 0x22,0x21,val,ifNum,NULL,0,USB_CTRL_SET_TIMEOUT);
865 static int option_startup(struct usb_serial *serial)
868 struct usb_serial_port *port;
869 struct option_port_private *portdata;
874 /* Now setup per port private data */
875 for (i = 0; i < serial->num_ports; i++) {
876 port = serial->port[i];
877 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
879 dbg("%s: kmalloc for option_port_private (%d) failed!.",
884 for (j = 0; j < N_IN_URB; j++) {
885 buffer = (u8 *)__get_free_page(GFP_KERNEL);
888 portdata->in_buffer[j] = buffer;
891 for (j = 0; j < N_OUT_URB; j++) {
892 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
894 goto bail_out_error2;
895 portdata->out_buffer[j] = buffer;
898 usb_set_serial_port_data(port, portdata);
900 if (! port->interrupt_in_urb)
902 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
904 dbg("%s: submit irq_in urb failed %d",
908 option_setup_urbs(serial);
913 for (j = 0; j < N_OUT_URB; j++)
914 kfree(portdata->out_buffer[j]);
916 for (j = 0; j < N_IN_URB; j++)
917 if (portdata->in_buffer[j])
918 free_page((unsigned long)portdata->in_buffer[j]);
923 static void option_shutdown(struct usb_serial *serial)
926 struct usb_serial_port *port;
927 struct option_port_private *portdata;
931 /* Stop reading/writing urbs */
932 for (i = 0; i < serial->num_ports; ++i) {
933 port = serial->port[i];
934 portdata = usb_get_serial_port_data(port);
935 for (j = 0; j < N_IN_URB; j++)
936 usb_kill_urb(portdata->in_urbs[j]);
937 for (j = 0; j < N_OUT_URB; j++)
938 usb_kill_urb(portdata->out_urbs[j]);
942 for (i = 0; i < serial->num_ports; ++i) {
943 port = serial->port[i];
944 portdata = usb_get_serial_port_data(port);
946 for (j = 0; j < N_IN_URB; j++) {
947 if (portdata->in_urbs[j]) {
948 usb_free_urb(portdata->in_urbs[j]);
949 free_page((unsigned long)portdata->in_buffer[j]);
950 portdata->in_urbs[j] = NULL;
953 for (j = 0; j < N_OUT_URB; j++) {
954 if (portdata->out_urbs[j]) {
955 usb_free_urb(portdata->out_urbs[j]);
956 kfree(portdata->out_buffer[j]);
957 portdata->out_urbs[j] = NULL;
962 /* Now free per port private data */
963 for (i = 0; i < serial->num_ports; i++) {
964 port = serial->port[i];
965 kfree(usb_get_serial_port_data(port));
969 MODULE_AUTHOR(DRIVER_AUTHOR);
970 MODULE_DESCRIPTION(DRIVER_DESC);
971 MODULE_VERSION(DRIVER_VERSION);
972 MODULE_LICENSE("GPL");
974 #ifdef CONFIG_USB_DEBUG
975 module_param(debug, bool, S_IRUGO | S_IWUSR);
976 MODULE_PARM_DESC(debug, "Debug messages");