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.1"
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 #define NOVATELWIRELESS_PRODUCT_U727 0x5010
159 /* FUTURE NOVATEL PRODUCTS */
160 #define NOVATELWIRELESS_PRODUCT_EVDO_1 0x6000
161 #define NOVATELWIRELESS_PRODUCT_HSPA_1 0x7000
162 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_1 0x8000
163 #define NOVATELWIRELESS_PRODUCT_GLOBAL_1 0x9000
164 #define NOVATELWIRELESS_PRODUCT_EVDO_2 0x6001
165 #define NOVATELWIRELESS_PRODUCT_HSPA_2 0x7001
166 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_2 0x8001
167 #define NOVATELWIRELESS_PRODUCT_GLOBAL_2 0x9001
170 #define AMOI_VENDOR_ID 0x1614
171 #define AMOI_PRODUCT_H01 0x0800
172 #define AMOI_PRODUCT_H01A 0x7002
173 #define AMOI_PRODUCT_H02 0x0802
175 #define DELL_VENDOR_ID 0x413C
177 #define KYOCERA_VENDOR_ID 0x0c88
178 #define KYOCERA_PRODUCT_KPC680 0x180a
180 #define ANYDATA_VENDOR_ID 0x16d5
181 #define ANYDATA_PRODUCT_ADU_E100A 0x6501
182 #define ANYDATA_PRODUCT_ADU_500A 0x6502
184 #define AXESSTEL_VENDOR_ID 0x1726
185 #define AXESSTEL_PRODUCT_MV110H 0x1000
187 #define BANDRICH_VENDOR_ID 0x1A8D
188 #define BANDRICH_PRODUCT_C100_1 0x1002
189 #define BANDRICH_PRODUCT_C100_2 0x1003
191 #define AMOI_VENDOR_ID 0x1614
192 #define AMOI_PRODUCT_9508 0x0800
194 #define QUALCOMM_VENDOR_ID 0x05C6
196 #define MAXON_VENDOR_ID 0x16d8
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(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600) },
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(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401) },
238 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403) },
239 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405) },
240 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406) },
241 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408) },
242 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409) },
243 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410) },
244 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411) },
245 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412) },
246 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413) },
247 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414) },
248 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415) },
249 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416) },
250 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417) },
251 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418) },
252 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419) },
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_U727) }, /* Novatel U727 */
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(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(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
300 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
301 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
302 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
303 { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
304 { } /* Terminating entry */
306 MODULE_DEVICE_TABLE(usb, option_ids);
308 static struct usb_driver option_driver = {
310 .probe = usb_serial_probe,
311 .disconnect = usb_serial_disconnect,
312 .id_table = option_ids,
316 /* The card has three separate interfaces, which the serial driver
317 * recognizes separately, thus num_port=1.
320 static struct usb_serial_driver option_1port_device = {
322 .owner = THIS_MODULE,
325 .description = "GSM modem (1-port)",
326 .usb_driver = &option_driver,
327 .id_table = option_ids,
328 .num_interrupt_in = NUM_DONT_CARE,
329 .num_bulk_in = NUM_DONT_CARE,
330 .num_bulk_out = NUM_DONT_CARE,
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)
414 dbg("%s", __FUNCTION__);
417 static void option_rx_unthrottle(struct usb_serial_port *port)
419 dbg("%s", __FUNCTION__);
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 */
425 dbg("%s", __FUNCTION__);
428 static void option_set_termios(struct usb_serial_port *port,
429 struct ktermios *old_termios)
431 dbg("%s", __FUNCTION__);
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);
462 portdata->rts_state = 1;
464 portdata->dtr_state = 1;
466 if (clear & TIOCM_RTS)
467 portdata->rts_state = 0;
468 if (clear & TIOCM_DTR)
469 portdata->dtr_state = 0;
470 return option_send_setup(port);
473 static int option_ioctl(struct usb_serial_port *port, struct file *file,
474 unsigned int cmd, unsigned long arg)
480 static int option_write(struct usb_serial_port *port,
481 const unsigned char *buf, int count)
483 struct option_port_private *portdata;
486 struct urb *this_urb = NULL; /* spurious */
489 portdata = usb_get_serial_port_data(port);
491 dbg("%s: write (%d chars)", __FUNCTION__, count);
495 for (i=0; left > 0 && i < N_OUT_URB; i++) {
497 if (todo > OUT_BUFLEN)
500 this_urb = portdata->out_urbs[i];
501 if (test_and_set_bit(i, &portdata->out_busy)) {
502 if (time_before(jiffies,
503 portdata->tx_start_time[i] + 10 * HZ))
505 usb_unlink_urb(this_urb);
508 if (this_urb->status != 0)
509 dbg("usb_write %p failed (err=%d)",
510 this_urb, this_urb->status);
512 dbg("%s: endpoint %d buf %d", __FUNCTION__,
513 usb_pipeendpoint(this_urb->pipe), i);
516 memcpy (this_urb->transfer_buffer, buf, todo);
517 this_urb->transfer_buffer_length = todo;
519 this_urb->dev = port->serial->dev;
520 err = usb_submit_urb(this_urb, GFP_ATOMIC);
522 dbg("usb_submit_urb %p (write bulk) failed "
523 "(%d, has %d)", this_urb,
524 err, this_urb->status);
525 clear_bit(i, &portdata->out_busy);
528 portdata->tx_start_time[i] = jiffies;
534 dbg("%s: wrote (did %d)", __FUNCTION__, count);
538 static void option_indat_callback(struct urb *urb)
542 struct usb_serial_port *port;
543 struct tty_struct *tty;
544 unsigned char *data = urb->transfer_buffer;
545 int status = urb->status;
547 dbg("%s: %p", __FUNCTION__, urb);
549 endpoint = usb_pipeendpoint(urb->pipe);
550 port = (struct usb_serial_port *) urb->context;
553 dbg("%s: nonzero status: %d on endpoint %02x.",
554 __FUNCTION__, status, endpoint);
557 if (urb->actual_length) {
558 tty_buffer_request_room(tty, urb->actual_length);
559 tty_insert_flip_string(tty, data, urb->actual_length);
560 tty_flip_buffer_push(tty);
562 dbg("%s: empty read urb received", __FUNCTION__);
565 /* Resubmit urb so we continue receiving */
566 if (port->open_count && status != -ESHUTDOWN) {
567 err = usb_submit_urb(urb, GFP_ATOMIC);
569 printk(KERN_ERR "%s: resubmit read urb failed. "
570 "(%d)", __FUNCTION__, err);
576 static void option_outdat_callback(struct urb *urb)
578 struct usb_serial_port *port;
579 struct option_port_private *portdata;
582 dbg("%s", __FUNCTION__);
584 port = (struct usb_serial_port *) urb->context;
586 usb_serial_port_softint(port);
588 portdata = usb_get_serial_port_data(port);
589 for (i = 0; i < N_OUT_URB; ++i) {
590 if (portdata->out_urbs[i] == urb) {
591 smp_mb__before_clear_bit();
592 clear_bit(i, &portdata->out_busy);
598 static void option_instat_callback(struct urb *urb)
601 int status = urb->status;
602 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
603 struct option_port_private *portdata = usb_get_serial_port_data(port);
604 struct usb_serial *serial = port->serial;
606 dbg("%s", __FUNCTION__);
607 dbg("%s: urb %p port %p has data %p", __FUNCTION__,urb,port,portdata);
610 struct usb_ctrlrequest *req_pkt =
611 (struct usb_ctrlrequest *)urb->transfer_buffer;
614 dbg("%s: NULL req_pkt\n", __FUNCTION__);
617 if ((req_pkt->bRequestType == 0xA1) &&
618 (req_pkt->bRequest == 0x20)) {
620 unsigned char signals = *((unsigned char *)
621 urb->transfer_buffer +
622 sizeof(struct usb_ctrlrequest));
624 dbg("%s: signal x%x", __FUNCTION__, signals);
626 old_dcd_state = portdata->dcd_state;
627 portdata->cts_state = 1;
628 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
629 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
630 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
632 if (port->tty && !C_CLOCAL(port->tty) &&
633 old_dcd_state && !portdata->dcd_state)
634 tty_hangup(port->tty);
636 dbg("%s: type %x req %x", __FUNCTION__,
637 req_pkt->bRequestType,req_pkt->bRequest);
640 dbg("%s: error %d", __FUNCTION__, status);
642 /* Resubmit urb so we continue receiving IRQ data */
643 if (status != -ESHUTDOWN) {
644 urb->dev = serial->dev;
645 err = usb_submit_urb(urb, GFP_ATOMIC);
647 dbg("%s: resubmit intr urb failed. (%d)",
652 static int option_write_room(struct usb_serial_port *port)
654 struct option_port_private *portdata;
657 struct urb *this_urb;
659 portdata = usb_get_serial_port_data(port);
661 for (i=0; i < N_OUT_URB; i++) {
662 this_urb = portdata->out_urbs[i];
663 if (this_urb && !test_bit(i, &portdata->out_busy))
664 data_len += OUT_BUFLEN;
667 dbg("%s: %d", __FUNCTION__, data_len);
671 static int option_chars_in_buffer(struct usb_serial_port *port)
673 struct option_port_private *portdata;
676 struct urb *this_urb;
678 portdata = usb_get_serial_port_data(port);
680 for (i=0; i < N_OUT_URB; i++) {
681 this_urb = portdata->out_urbs[i];
682 if (this_urb && test_bit(i, &portdata->out_busy))
683 data_len += this_urb->transfer_buffer_length;
685 dbg("%s: %d", __FUNCTION__, data_len);
689 static int option_open(struct usb_serial_port *port, struct file *filp)
691 struct option_port_private *portdata;
692 struct usb_serial *serial = port->serial;
696 portdata = usb_get_serial_port_data(port);
698 dbg("%s", __FUNCTION__);
700 /* Set some sane defaults */
701 portdata->rts_state = 1;
702 portdata->dtr_state = 1;
704 /* Reset low level data toggle and start reading from endpoints */
705 for (i = 0; i < N_IN_URB; i++) {
706 urb = portdata->in_urbs[i];
709 if (urb->dev != serial->dev) {
710 dbg("%s: dev %p != %p", __FUNCTION__,
711 urb->dev, serial->dev);
716 * make sure endpoint data toggle is synchronized with the
719 usb_clear_halt(urb->dev, urb->pipe);
721 err = usb_submit_urb(urb, GFP_KERNEL);
723 dbg("%s: submit urb %d failed (%d) %d",
724 __FUNCTION__, i, err,
725 urb->transfer_buffer_length);
729 /* Reset low level data toggle on out endpoints */
730 for (i = 0; i < N_OUT_URB; i++) {
731 urb = portdata->out_urbs[i];
734 urb->dev = serial->dev;
735 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
736 usb_pipeout(urb->pipe), 0); */
739 port->tty->low_latency = 1;
741 option_send_setup(port);
746 static void option_close(struct usb_serial_port *port, struct file *filp)
749 struct usb_serial *serial = port->serial;
750 struct option_port_private *portdata;
752 dbg("%s", __FUNCTION__);
753 portdata = usb_get_serial_port_data(port);
755 portdata->rts_state = 0;
756 portdata->dtr_state = 0;
759 mutex_lock(&serial->disc_mutex);
760 if (!serial->disconnected)
761 option_send_setup(port);
762 mutex_unlock(&serial->disc_mutex);
764 /* Stop reading/writing urbs */
765 for (i = 0; i < N_IN_URB; i++)
766 usb_kill_urb(portdata->in_urbs[i]);
767 for (i = 0; i < N_OUT_URB; i++)
768 usb_kill_urb(portdata->out_urbs[i]);
773 /* Helper functions used by option_setup_urbs */
774 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
775 int dir, void *ctx, char *buf, int len,
776 void (*callback)(struct urb *))
781 return NULL; /* endpoint not needed */
783 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
785 dbg("%s: alloc for endpoint %d failed.", __FUNCTION__, endpoint);
789 /* Fill URB using supplied data. */
790 usb_fill_bulk_urb(urb, serial->dev,
791 usb_sndbulkpipe(serial->dev, endpoint) | dir,
792 buf, len, callback, ctx);
798 static void option_setup_urbs(struct usb_serial *serial)
801 struct usb_serial_port *port;
802 struct option_port_private *portdata;
804 dbg("%s", __FUNCTION__);
806 for (i = 0; i < serial->num_ports; i++) {
807 port = serial->port[i];
808 portdata = usb_get_serial_port_data(port);
810 /* Do indat endpoints first */
811 for (j = 0; j < N_IN_URB; ++j) {
812 portdata->in_urbs[j] = option_setup_urb (serial,
813 port->bulk_in_endpointAddress, USB_DIR_IN, port,
814 portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
817 /* outdat endpoints */
818 for (j = 0; j < N_OUT_URB; ++j) {
819 portdata->out_urbs[j] = option_setup_urb (serial,
820 port->bulk_out_endpointAddress, USB_DIR_OUT, port,
821 portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
826 static int option_send_setup(struct usb_serial_port *port)
828 struct usb_serial *serial = port->serial;
829 struct option_port_private *portdata;
831 dbg("%s", __FUNCTION__);
833 if (port->number != 0)
836 portdata = usb_get_serial_port_data(port);
840 if (portdata->dtr_state)
842 if (portdata->rts_state)
845 return usb_control_msg(serial->dev,
846 usb_rcvctrlpipe(serial->dev, 0),
847 0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
853 static int option_startup(struct usb_serial *serial)
856 struct usb_serial_port *port;
857 struct option_port_private *portdata;
860 dbg("%s", __FUNCTION__);
862 /* Now setup per port private data */
863 for (i = 0; i < serial->num_ports; i++) {
864 port = serial->port[i];
865 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
867 dbg("%s: kmalloc for option_port_private (%d) failed!.",
872 for (j = 0; j < N_IN_URB; j++) {
873 buffer = (u8 *)__get_free_page(GFP_KERNEL);
876 portdata->in_buffer[j] = buffer;
879 for (j = 0; j < N_OUT_URB; j++) {
880 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
882 goto bail_out_error2;
883 portdata->out_buffer[j] = buffer;
886 usb_set_serial_port_data(port, portdata);
888 if (! port->interrupt_in_urb)
890 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
892 dbg("%s: submit irq_in urb failed %d",
896 option_setup_urbs(serial);
901 for (j = 0; j < N_OUT_URB; j++)
902 kfree(portdata->out_buffer[j]);
904 for (j = 0; j < N_IN_URB; j++)
905 if (portdata->in_buffer[j])
906 free_page((unsigned long)portdata->in_buffer[j]);
911 static void option_shutdown(struct usb_serial *serial)
914 struct usb_serial_port *port;
915 struct option_port_private *portdata;
917 dbg("%s", __FUNCTION__);
919 /* Stop reading/writing urbs */
920 for (i = 0; i < serial->num_ports; ++i) {
921 port = serial->port[i];
922 portdata = usb_get_serial_port_data(port);
923 for (j = 0; j < N_IN_URB; j++)
924 usb_kill_urb(portdata->in_urbs[j]);
925 for (j = 0; j < N_OUT_URB; j++)
926 usb_kill_urb(portdata->out_urbs[j]);
930 for (i = 0; i < serial->num_ports; ++i) {
931 port = serial->port[i];
932 portdata = usb_get_serial_port_data(port);
934 for (j = 0; j < N_IN_URB; j++) {
935 if (portdata->in_urbs[j]) {
936 usb_free_urb(portdata->in_urbs[j]);
937 free_page((unsigned long)portdata->in_buffer[j]);
938 portdata->in_urbs[j] = NULL;
941 for (j = 0; j < N_OUT_URB; j++) {
942 if (portdata->out_urbs[j]) {
943 usb_free_urb(portdata->out_urbs[j]);
944 kfree(portdata->out_buffer[j]);
945 portdata->out_urbs[j] = NULL;
950 /* Now free per port private data */
951 for (i = 0; i < serial->num_ports; i++) {
952 port = serial->port[i];
953 kfree(usb_get_serial_port_data(port));
957 MODULE_AUTHOR(DRIVER_AUTHOR);
958 MODULE_DESCRIPTION(DRIVER_DESC);
959 MODULE_VERSION(DRIVER_VERSION);
960 MODULE_LICENSE("GPL");
962 #ifdef CONFIG_USB_DEBUG
963 module_param(debug, bool, S_IRUGO | S_IWUSR);
964 MODULE_PARM_DESC(debug, "Debug messages");