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_ET502HS 0x0002
188 #define BANDRICH_VENDOR_ID 0x1A8D
189 #define BANDRICH_PRODUCT_C100_1 0x1002
190 #define BANDRICH_PRODUCT_C100_2 0x1003
192 #define AMOI_VENDOR_ID 0x1614
193 #define AMOI_PRODUCT_9508 0x0800
195 #define QUALCOMM_VENDOR_ID 0x05C6
197 #define MAXON_VENDOR_ID 0x16d8
199 static struct usb_device_id option_ids[] = {
200 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
201 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
202 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
203 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
204 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
205 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
206 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
207 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
208 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
209 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
210 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
211 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
212 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
213 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
214 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
215 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
216 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
217 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
218 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
219 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
220 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
221 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
222 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
223 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
224 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
225 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
226 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
227 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
228 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
229 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
230 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
231 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
232 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
233 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
234 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
235 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600) },
236 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
237 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
238 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401) },
239 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403) },
240 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405) },
241 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406) },
242 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408) },
243 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409) },
244 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410) },
245 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411) },
246 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412) },
247 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413) },
248 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414) },
249 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415) },
250 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416) },
251 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417) },
252 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418) },
253 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419) },
254 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
255 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
256 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
257 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
258 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
259 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
260 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
261 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
262 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
263 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
264 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
265 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
266 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
267 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
268 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
269 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
270 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
271 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
272 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
273 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
274 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
275 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
276 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
277 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
278 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
279 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
280 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
282 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01) },
283 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01A) },
284 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H02) },
286 { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
287 { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
288 { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
289 { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
290 { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
291 { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
292 { USB_DEVICE(DELL_VENDOR_ID, 0x8129) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
293 { USB_DEVICE(DELL_VENDOR_ID, 0x8133) }, /* Dell Wireless 5720 == Novatel EV620 CDMA/EV-DO */
294 { USB_DEVICE(DELL_VENDOR_ID, 0x8136) }, /* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
295 { USB_DEVICE(DELL_VENDOR_ID, 0x8137) }, /* Dell Wireless HSDPA 5520 */
296 { USB_DEVICE(DELL_VENDOR_ID, 0x8138) }, /* Dell Wireless 5520 Voda I Mobile Broadband (3G HSDPA) Minicard */
297 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
298 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
299 { USB_DEVICE(AXESSTEL_VENDOR_ID, AXESSTEL_PRODUCT_MV110H) },
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_KPC680) },
304 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
305 { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
306 { USB_DEVICE(0x19d2, 0x0001) }, /* Telstra NextG CDMA */
307 { } /* Terminating entry */
309 MODULE_DEVICE_TABLE(usb, option_ids);
311 static struct usb_driver option_driver = {
313 .probe = usb_serial_probe,
314 .disconnect = usb_serial_disconnect,
315 .id_table = option_ids,
319 /* The card has three separate interfaces, which the serial driver
320 * recognizes separately, thus num_port=1.
323 static struct usb_serial_driver option_1port_device = {
325 .owner = THIS_MODULE,
328 .description = "GSM modem (1-port)",
329 .usb_driver = &option_driver,
330 .id_table = option_ids,
333 .close = option_close,
334 .write = option_write,
335 .write_room = option_write_room,
336 .chars_in_buffer = option_chars_in_buffer,
337 .throttle = option_rx_throttle,
338 .unthrottle = option_rx_unthrottle,
339 .ioctl = option_ioctl,
340 .set_termios = option_set_termios,
341 .break_ctl = option_break_ctl,
342 .tiocmget = option_tiocmget,
343 .tiocmset = option_tiocmset,
344 .attach = option_startup,
345 .shutdown = option_shutdown,
346 .read_int_callback = option_instat_callback,
349 #ifdef CONFIG_USB_DEBUG
355 /* per port private data */
359 #define IN_BUFLEN 4096
360 #define OUT_BUFLEN 128
362 struct option_port_private {
363 /* Input endpoints and buffer for this port */
364 struct urb *in_urbs[N_IN_URB];
365 u8 *in_buffer[N_IN_URB];
366 /* Output endpoints and buffer for this port */
367 struct urb *out_urbs[N_OUT_URB];
368 u8 *out_buffer[N_OUT_URB];
369 unsigned long out_busy; /* Bit vector of URBs in use */
371 /* Settings for the port */
372 int rts_state; /* Handshaking pins (outputs) */
374 int cts_state; /* Handshaking pins (inputs) */
379 unsigned long tx_start_time[N_OUT_URB];
382 /* Functions used by new usb-serial code. */
383 static int __init option_init(void)
386 retval = usb_serial_register(&option_1port_device);
388 goto failed_1port_device_register;
389 retval = usb_register(&option_driver);
391 goto failed_driver_register;
393 info(DRIVER_DESC ": " DRIVER_VERSION);
397 failed_driver_register:
398 usb_serial_deregister (&option_1port_device);
399 failed_1port_device_register:
403 static void __exit option_exit(void)
405 usb_deregister (&option_driver);
406 usb_serial_deregister (&option_1port_device);
409 module_init(option_init);
410 module_exit(option_exit);
412 static void option_rx_throttle(struct usb_serial_port *port)
417 static void option_rx_unthrottle(struct usb_serial_port *port)
422 static void option_break_ctl(struct usb_serial_port *port, int break_state)
424 /* Unfortunately, I don't know how to send a break */
428 static void option_set_termios(struct usb_serial_port *port,
429 struct ktermios *old_termios)
432 /* Doesn't support option setting */
433 tty_termios_copy_hw(port->tty->termios, old_termios);
434 option_send_setup(port);
437 static int option_tiocmget(struct usb_serial_port *port, struct file *file)
440 struct option_port_private *portdata;
442 portdata = usb_get_serial_port_data(port);
444 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
445 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
446 ((portdata->cts_state) ? TIOCM_CTS : 0) |
447 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
448 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
449 ((portdata->ri_state) ? TIOCM_RNG : 0);
454 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
455 unsigned int set, unsigned int clear)
457 struct option_port_private *portdata;
459 portdata = usb_get_serial_port_data(port);
461 /* FIXME: what locks portdata fields ? */
463 portdata->rts_state = 1;
465 portdata->dtr_state = 1;
467 if (clear & TIOCM_RTS)
468 portdata->rts_state = 0;
469 if (clear & TIOCM_DTR)
470 portdata->dtr_state = 0;
471 return option_send_setup(port);
474 static int option_ioctl(struct usb_serial_port *port, struct file *file,
475 unsigned int cmd, unsigned long arg)
481 static int option_write(struct usb_serial_port *port,
482 const unsigned char *buf, int count)
484 struct option_port_private *portdata;
487 struct urb *this_urb = NULL; /* spurious */
490 portdata = usb_get_serial_port_data(port);
492 dbg("%s: write (%d chars)", __func__, count);
496 for (i=0; left > 0 && i < N_OUT_URB; i++) {
498 if (todo > OUT_BUFLEN)
501 this_urb = portdata->out_urbs[i];
502 if (test_and_set_bit(i, &portdata->out_busy)) {
503 if (time_before(jiffies,
504 portdata->tx_start_time[i] + 10 * HZ))
506 usb_unlink_urb(this_urb);
509 if (this_urb->status != 0)
510 dbg("usb_write %p failed (err=%d)",
511 this_urb, this_urb->status);
513 dbg("%s: endpoint %d buf %d", __func__,
514 usb_pipeendpoint(this_urb->pipe), i);
517 memcpy (this_urb->transfer_buffer, buf, todo);
518 this_urb->transfer_buffer_length = todo;
520 this_urb->dev = port->serial->dev;
521 err = usb_submit_urb(this_urb, GFP_ATOMIC);
523 dbg("usb_submit_urb %p (write bulk) failed "
524 "(%d, has %d)", this_urb,
525 err, this_urb->status);
526 clear_bit(i, &portdata->out_busy);
529 portdata->tx_start_time[i] = jiffies;
535 dbg("%s: wrote (did %d)", __func__, count);
539 static void option_indat_callback(struct urb *urb)
543 struct usb_serial_port *port;
544 struct tty_struct *tty;
545 unsigned char *data = urb->transfer_buffer;
546 int status = urb->status;
548 dbg("%s: %p", __func__, urb);
550 endpoint = usb_pipeendpoint(urb->pipe);
554 dbg("%s: nonzero status: %d on endpoint %02x.",
555 __func__, status, endpoint);
558 if (urb->actual_length) {
559 tty_buffer_request_room(tty, urb->actual_length);
560 tty_insert_flip_string(tty, data, urb->actual_length);
561 tty_flip_buffer_push(tty);
563 dbg("%s: empty read urb received", __func__);
566 /* Resubmit urb so we continue receiving */
567 if (port->open_count && status != -ESHUTDOWN) {
568 err = usb_submit_urb(urb, GFP_ATOMIC);
570 printk(KERN_ERR "%s: resubmit read urb failed. "
571 "(%d)", __func__, err);
577 static void option_outdat_callback(struct urb *urb)
579 struct usb_serial_port *port;
580 struct option_port_private *portdata;
587 usb_serial_port_softint(port);
589 portdata = usb_get_serial_port_data(port);
590 for (i = 0; i < N_OUT_URB; ++i) {
591 if (portdata->out_urbs[i] == urb) {
592 smp_mb__before_clear_bit();
593 clear_bit(i, &portdata->out_busy);
599 static void option_instat_callback(struct urb *urb)
602 int status = urb->status;
603 struct usb_serial_port *port = urb->context;
604 struct option_port_private *portdata = usb_get_serial_port_data(port);
605 struct usb_serial *serial = port->serial;
608 dbg("%s: urb %p port %p has data %p", __func__,urb,port,portdata);
611 struct usb_ctrlrequest *req_pkt =
612 (struct usb_ctrlrequest *)urb->transfer_buffer;
615 dbg("%s: NULL req_pkt\n", __func__);
618 if ((req_pkt->bRequestType == 0xA1) &&
619 (req_pkt->bRequest == 0x20)) {
621 unsigned char signals = *((unsigned char *)
622 urb->transfer_buffer +
623 sizeof(struct usb_ctrlrequest));
625 dbg("%s: signal x%x", __func__, signals);
627 old_dcd_state = portdata->dcd_state;
628 portdata->cts_state = 1;
629 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
630 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
631 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
633 if (port->tty && !C_CLOCAL(port->tty) &&
634 old_dcd_state && !portdata->dcd_state)
635 tty_hangup(port->tty);
637 dbg("%s: type %x req %x", __func__,
638 req_pkt->bRequestType,req_pkt->bRequest);
641 dbg("%s: error %d", __func__, status);
643 /* Resubmit urb so we continue receiving IRQ data */
644 if (status != -ESHUTDOWN) {
645 urb->dev = serial->dev;
646 err = usb_submit_urb(urb, GFP_ATOMIC);
648 dbg("%s: resubmit intr urb failed. (%d)",
653 static int option_write_room(struct usb_serial_port *port)
655 struct option_port_private *portdata;
658 struct urb *this_urb;
660 portdata = usb_get_serial_port_data(port);
663 for (i=0; i < N_OUT_URB; i++) {
664 this_urb = portdata->out_urbs[i];
665 if (this_urb && !test_bit(i, &portdata->out_busy))
666 data_len += OUT_BUFLEN;
669 dbg("%s: %d", __func__, data_len);
673 static int option_chars_in_buffer(struct usb_serial_port *port)
675 struct option_port_private *portdata;
678 struct urb *this_urb;
680 portdata = usb_get_serial_port_data(port);
682 for (i=0; i < N_OUT_URB; i++) {
683 this_urb = portdata->out_urbs[i];
684 /* FIXME: This locking is insufficient as this_urb may
685 go unused during the test */
686 if (this_urb && test_bit(i, &portdata->out_busy))
687 data_len += this_urb->transfer_buffer_length;
689 dbg("%s: %d", __func__, data_len);
693 static int option_open(struct usb_serial_port *port, struct file *filp)
695 struct option_port_private *portdata;
696 struct usb_serial *serial = port->serial;
700 portdata = usb_get_serial_port_data(port);
704 /* Set some sane defaults */
705 portdata->rts_state = 1;
706 portdata->dtr_state = 1;
708 /* Reset low level data toggle and start reading from endpoints */
709 for (i = 0; i < N_IN_URB; i++) {
710 urb = portdata->in_urbs[i];
713 if (urb->dev != serial->dev) {
714 dbg("%s: dev %p != %p", __func__,
715 urb->dev, serial->dev);
720 * make sure endpoint data toggle is synchronized with the
723 usb_clear_halt(urb->dev, urb->pipe);
725 err = usb_submit_urb(urb, GFP_KERNEL);
727 dbg("%s: submit urb %d failed (%d) %d",
729 urb->transfer_buffer_length);
733 /* Reset low level data toggle on out endpoints */
734 for (i = 0; i < N_OUT_URB; i++) {
735 urb = portdata->out_urbs[i];
738 urb->dev = serial->dev;
739 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
740 usb_pipeout(urb->pipe), 0); */
743 port->tty->low_latency = 1;
745 option_send_setup(port);
750 static void option_close(struct usb_serial_port *port, struct file *filp)
753 struct usb_serial *serial = port->serial;
754 struct option_port_private *portdata;
757 portdata = usb_get_serial_port_data(port);
759 portdata->rts_state = 0;
760 portdata->dtr_state = 0;
763 mutex_lock(&serial->disc_mutex);
764 if (!serial->disconnected)
765 option_send_setup(port);
766 mutex_unlock(&serial->disc_mutex);
768 /* Stop reading/writing urbs */
769 for (i = 0; i < N_IN_URB; i++)
770 usb_kill_urb(portdata->in_urbs[i]);
771 for (i = 0; i < N_OUT_URB; i++)
772 usb_kill_urb(portdata->out_urbs[i]);
777 /* Helper functions used by option_setup_urbs */
778 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
779 int dir, void *ctx, char *buf, int len,
780 void (*callback)(struct urb *))
785 return NULL; /* endpoint not needed */
787 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
789 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
793 /* Fill URB using supplied data. */
794 usb_fill_bulk_urb(urb, serial->dev,
795 usb_sndbulkpipe(serial->dev, endpoint) | dir,
796 buf, len, callback, ctx);
802 static void option_setup_urbs(struct usb_serial *serial)
805 struct usb_serial_port *port;
806 struct option_port_private *portdata;
810 for (i = 0; i < serial->num_ports; i++) {
811 port = serial->port[i];
812 portdata = usb_get_serial_port_data(port);
814 /* Do indat endpoints first */
815 for (j = 0; j < N_IN_URB; ++j) {
816 portdata->in_urbs[j] = option_setup_urb (serial,
817 port->bulk_in_endpointAddress, USB_DIR_IN, port,
818 portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
821 /* outdat endpoints */
822 for (j = 0; j < N_OUT_URB; ++j) {
823 portdata->out_urbs[j] = option_setup_urb (serial,
824 port->bulk_out_endpointAddress, USB_DIR_OUT, port,
825 portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
831 /** send RTS/DTR state to the port.
833 * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
836 static int option_send_setup(struct usb_serial_port *port)
838 struct usb_serial *serial = port->serial;
839 struct option_port_private *portdata;
840 int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
843 portdata = usb_get_serial_port_data(port);
847 if (portdata->dtr_state)
849 if (portdata->rts_state)
852 return usb_control_msg(serial->dev,
853 usb_rcvctrlpipe(serial->dev, 0),
854 0x22,0x21,val,ifNum,NULL,0,USB_CTRL_SET_TIMEOUT);
860 static int option_startup(struct usb_serial *serial)
863 struct usb_serial_port *port;
864 struct option_port_private *portdata;
869 /* Now setup per port private data */
870 for (i = 0; i < serial->num_ports; i++) {
871 port = serial->port[i];
872 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
874 dbg("%s: kmalloc for option_port_private (%d) failed!.",
879 for (j = 0; j < N_IN_URB; j++) {
880 buffer = (u8 *)__get_free_page(GFP_KERNEL);
883 portdata->in_buffer[j] = buffer;
886 for (j = 0; j < N_OUT_URB; j++) {
887 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
889 goto bail_out_error2;
890 portdata->out_buffer[j] = buffer;
893 usb_set_serial_port_data(port, portdata);
895 if (! port->interrupt_in_urb)
897 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
899 dbg("%s: submit irq_in urb failed %d",
903 option_setup_urbs(serial);
908 for (j = 0; j < N_OUT_URB; j++)
909 kfree(portdata->out_buffer[j]);
911 for (j = 0; j < N_IN_URB; j++)
912 if (portdata->in_buffer[j])
913 free_page((unsigned long)portdata->in_buffer[j]);
918 static void option_shutdown(struct usb_serial *serial)
921 struct usb_serial_port *port;
922 struct option_port_private *portdata;
926 /* Stop reading/writing urbs */
927 for (i = 0; i < serial->num_ports; ++i) {
928 port = serial->port[i];
929 portdata = usb_get_serial_port_data(port);
930 for (j = 0; j < N_IN_URB; j++)
931 usb_kill_urb(portdata->in_urbs[j]);
932 for (j = 0; j < N_OUT_URB; j++)
933 usb_kill_urb(portdata->out_urbs[j]);
937 for (i = 0; i < serial->num_ports; ++i) {
938 port = serial->port[i];
939 portdata = usb_get_serial_port_data(port);
941 for (j = 0; j < N_IN_URB; j++) {
942 if (portdata->in_urbs[j]) {
943 usb_free_urb(portdata->in_urbs[j]);
944 free_page((unsigned long)portdata->in_buffer[j]);
945 portdata->in_urbs[j] = NULL;
948 for (j = 0; j < N_OUT_URB; j++) {
949 if (portdata->out_urbs[j]) {
950 usb_free_urb(portdata->out_urbs[j]);
951 kfree(portdata->out_buffer[j]);
952 portdata->out_urbs[j] = NULL;
957 /* Now free per port private data */
958 for (i = 0; i < serial->num_ports; i++) {
959 port = serial->port[i];
960 kfree(usb_get_serial_port_data(port));
964 MODULE_AUTHOR(DRIVER_AUTHOR);
965 MODULE_DESCRIPTION(DRIVER_DESC);
966 MODULE_VERSION(DRIVER_VERSION);
967 MODULE_LICENSE("GPL");
969 #ifdef CONFIG_USB_DEBUG
970 module_param(debug, bool, S_IRUGO | S_IWUSR);
971 MODULE_PARM_DESC(debug, "Debug messages");