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 #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 ONDA_VENDOR_ID 0x19d2
188 #define ONDA_PRODUCT_ET502HS 0x0002
190 #define BANDRICH_VENDOR_ID 0x1A8D
191 #define BANDRICH_PRODUCT_C100_1 0x1002
192 #define BANDRICH_PRODUCT_C100_2 0x1003
194 #define AMOI_VENDOR_ID 0x1614
195 #define AMOI_PRODUCT_9508 0x0800
197 #define QUALCOMM_VENDOR_ID 0x05C6
199 #define MAXON_VENDOR_ID 0x16d8
201 static struct usb_device_id option_ids[] = {
202 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
203 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
204 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
205 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
206 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
207 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
208 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
209 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
210 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
211 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
212 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
213 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
214 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
215 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
216 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
217 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
218 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
219 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
220 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
221 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
222 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
223 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
224 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
225 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
226 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
227 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
228 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
229 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
230 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
231 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
232 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
233 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
234 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
235 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
236 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
237 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600) },
238 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
239 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
240 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401) },
241 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403) },
242 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405) },
243 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406) },
244 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408) },
245 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409) },
246 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410) },
247 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411) },
248 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412) },
249 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413) },
250 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414) },
251 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415) },
252 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416) },
253 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417) },
254 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418) },
255 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419) },
256 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
257 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
258 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
259 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
260 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
261 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
262 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
263 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
264 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
265 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
266 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
267 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
268 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
269 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
270 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
271 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
272 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
273 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
274 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
275 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U727) }, /* Novatel U727 */
276 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
277 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
278 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
279 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
280 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
281 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
282 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
283 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
285 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01) },
286 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01A) },
287 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H02) },
289 { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
290 { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
291 { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
292 { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
293 { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
294 { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
295 { USB_DEVICE(DELL_VENDOR_ID, 0x8129) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
296 { USB_DEVICE(DELL_VENDOR_ID, 0x8133) }, /* Dell Wireless 5720 == Novatel EV620 CDMA/EV-DO */
297 { USB_DEVICE(DELL_VENDOR_ID, 0x8136) }, /* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
298 { USB_DEVICE(DELL_VENDOR_ID, 0x8137) }, /* Dell Wireless HSDPA 5520 */
299 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
300 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
301 { USB_DEVICE(AXESSTEL_VENDOR_ID, AXESSTEL_PRODUCT_MV110H) },
302 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_ET502HS) },
303 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
304 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
305 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
306 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
307 { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
308 { USB_DEVICE(0x19d2, 0x0001) }, /* Telstra NextG CDMA */
309 { } /* Terminating entry */
311 MODULE_DEVICE_TABLE(usb, option_ids);
313 static struct usb_driver option_driver = {
315 .probe = usb_serial_probe,
316 .disconnect = usb_serial_disconnect,
317 .id_table = option_ids,
321 /* The card has three separate interfaces, which the serial driver
322 * recognizes separately, thus num_port=1.
325 static struct usb_serial_driver option_1port_device = {
327 .owner = THIS_MODULE,
330 .description = "GSM modem (1-port)",
331 .usb_driver = &option_driver,
332 .id_table = option_ids,
335 .close = option_close,
336 .write = option_write,
337 .write_room = option_write_room,
338 .chars_in_buffer = option_chars_in_buffer,
339 .throttle = option_rx_throttle,
340 .unthrottle = option_rx_unthrottle,
341 .ioctl = option_ioctl,
342 .set_termios = option_set_termios,
343 .break_ctl = option_break_ctl,
344 .tiocmget = option_tiocmget,
345 .tiocmset = option_tiocmset,
346 .attach = option_startup,
347 .shutdown = option_shutdown,
348 .read_int_callback = option_instat_callback,
351 #ifdef CONFIG_USB_DEBUG
357 /* per port private data */
361 #define IN_BUFLEN 4096
362 #define OUT_BUFLEN 128
364 struct option_port_private {
365 /* Input endpoints and buffer for this port */
366 struct urb *in_urbs[N_IN_URB];
367 u8 *in_buffer[N_IN_URB];
368 /* Output endpoints and buffer for this port */
369 struct urb *out_urbs[N_OUT_URB];
370 u8 *out_buffer[N_OUT_URB];
371 unsigned long out_busy; /* Bit vector of URBs in use */
373 /* Settings for the port */
374 int rts_state; /* Handshaking pins (outputs) */
376 int cts_state; /* Handshaking pins (inputs) */
381 unsigned long tx_start_time[N_OUT_URB];
384 /* Functions used by new usb-serial code. */
385 static int __init option_init(void)
388 retval = usb_serial_register(&option_1port_device);
390 goto failed_1port_device_register;
391 retval = usb_register(&option_driver);
393 goto failed_driver_register;
395 info(DRIVER_DESC ": " DRIVER_VERSION);
399 failed_driver_register:
400 usb_serial_deregister (&option_1port_device);
401 failed_1port_device_register:
405 static void __exit option_exit(void)
407 usb_deregister (&option_driver);
408 usb_serial_deregister (&option_1port_device);
411 module_init(option_init);
412 module_exit(option_exit);
414 static void option_rx_throttle(struct usb_serial_port *port)
419 static void option_rx_unthrottle(struct usb_serial_port *port)
424 static void option_break_ctl(struct usb_serial_port *port, int break_state)
426 /* Unfortunately, I don't know how to send a break */
430 static void option_set_termios(struct usb_serial_port *port,
431 struct ktermios *old_termios)
434 /* Doesn't support option setting */
435 tty_termios_copy_hw(port->tty->termios, old_termios);
436 option_send_setup(port);
439 static int option_tiocmget(struct usb_serial_port *port, struct file *file)
442 struct option_port_private *portdata;
444 portdata = usb_get_serial_port_data(port);
446 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
447 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
448 ((portdata->cts_state) ? TIOCM_CTS : 0) |
449 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
450 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
451 ((portdata->ri_state) ? TIOCM_RNG : 0);
456 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
457 unsigned int set, unsigned int clear)
459 struct option_port_private *portdata;
461 portdata = usb_get_serial_port_data(port);
463 /* FIXME: what locks portdata fields ? */
465 portdata->rts_state = 1;
467 portdata->dtr_state = 1;
469 if (clear & TIOCM_RTS)
470 portdata->rts_state = 0;
471 if (clear & TIOCM_DTR)
472 portdata->dtr_state = 0;
473 return option_send_setup(port);
476 static int option_ioctl(struct usb_serial_port *port, struct file *file,
477 unsigned int cmd, unsigned long arg)
483 static int option_write(struct usb_serial_port *port,
484 const unsigned char *buf, int count)
486 struct option_port_private *portdata;
489 struct urb *this_urb = NULL; /* spurious */
492 portdata = usb_get_serial_port_data(port);
494 dbg("%s: write (%d chars)", __func__, count);
498 for (i=0; left > 0 && i < N_OUT_URB; i++) {
500 if (todo > OUT_BUFLEN)
503 this_urb = portdata->out_urbs[i];
504 if (test_and_set_bit(i, &portdata->out_busy)) {
505 if (time_before(jiffies,
506 portdata->tx_start_time[i] + 10 * HZ))
508 usb_unlink_urb(this_urb);
511 if (this_urb->status != 0)
512 dbg("usb_write %p failed (err=%d)",
513 this_urb, this_urb->status);
515 dbg("%s: endpoint %d buf %d", __func__,
516 usb_pipeendpoint(this_urb->pipe), i);
519 memcpy (this_urb->transfer_buffer, buf, todo);
520 this_urb->transfer_buffer_length = todo;
522 this_urb->dev = port->serial->dev;
523 err = usb_submit_urb(this_urb, GFP_ATOMIC);
525 dbg("usb_submit_urb %p (write bulk) failed "
526 "(%d, has %d)", this_urb,
527 err, this_urb->status);
528 clear_bit(i, &portdata->out_busy);
531 portdata->tx_start_time[i] = jiffies;
537 dbg("%s: wrote (did %d)", __func__, count);
541 static void option_indat_callback(struct urb *urb)
545 struct usb_serial_port *port;
546 struct tty_struct *tty;
547 unsigned char *data = urb->transfer_buffer;
548 int status = urb->status;
550 dbg("%s: %p", __func__, urb);
552 endpoint = usb_pipeendpoint(urb->pipe);
556 dbg("%s: nonzero status: %d on endpoint %02x.",
557 __func__, status, endpoint);
560 if (urb->actual_length) {
561 tty_buffer_request_room(tty, urb->actual_length);
562 tty_insert_flip_string(tty, data, urb->actual_length);
563 tty_flip_buffer_push(tty);
565 dbg("%s: empty read urb received", __func__);
568 /* Resubmit urb so we continue receiving */
569 if (port->open_count && status != -ESHUTDOWN) {
570 err = usb_submit_urb(urb, GFP_ATOMIC);
572 printk(KERN_ERR "%s: resubmit read urb failed. "
573 "(%d)", __func__, err);
579 static void option_outdat_callback(struct urb *urb)
581 struct usb_serial_port *port;
582 struct option_port_private *portdata;
589 usb_serial_port_softint(port);
591 portdata = usb_get_serial_port_data(port);
592 for (i = 0; i < N_OUT_URB; ++i) {
593 if (portdata->out_urbs[i] == urb) {
594 smp_mb__before_clear_bit();
595 clear_bit(i, &portdata->out_busy);
601 static void option_instat_callback(struct urb *urb)
604 int status = urb->status;
605 struct usb_serial_port *port = urb->context;
606 struct option_port_private *portdata = usb_get_serial_port_data(port);
607 struct usb_serial *serial = port->serial;
610 dbg("%s: urb %p port %p has data %p", __func__,urb,port,portdata);
613 struct usb_ctrlrequest *req_pkt =
614 (struct usb_ctrlrequest *)urb->transfer_buffer;
617 dbg("%s: NULL req_pkt\n", __func__);
620 if ((req_pkt->bRequestType == 0xA1) &&
621 (req_pkt->bRequest == 0x20)) {
623 unsigned char signals = *((unsigned char *)
624 urb->transfer_buffer +
625 sizeof(struct usb_ctrlrequest));
627 dbg("%s: signal x%x", __func__, signals);
629 old_dcd_state = portdata->dcd_state;
630 portdata->cts_state = 1;
631 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
632 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
633 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
635 if (port->tty && !C_CLOCAL(port->tty) &&
636 old_dcd_state && !portdata->dcd_state)
637 tty_hangup(port->tty);
639 dbg("%s: type %x req %x", __func__,
640 req_pkt->bRequestType,req_pkt->bRequest);
643 dbg("%s: error %d", __func__, status);
645 /* Resubmit urb so we continue receiving IRQ data */
646 if (status != -ESHUTDOWN) {
647 urb->dev = serial->dev;
648 err = usb_submit_urb(urb, GFP_ATOMIC);
650 dbg("%s: resubmit intr urb failed. (%d)",
655 static int option_write_room(struct usb_serial_port *port)
657 struct option_port_private *portdata;
660 struct urb *this_urb;
662 portdata = usb_get_serial_port_data(port);
665 for (i=0; i < N_OUT_URB; i++) {
666 this_urb = portdata->out_urbs[i];
667 if (this_urb && !test_bit(i, &portdata->out_busy))
668 data_len += OUT_BUFLEN;
671 dbg("%s: %d", __func__, data_len);
675 static int option_chars_in_buffer(struct usb_serial_port *port)
677 struct option_port_private *portdata;
680 struct urb *this_urb;
682 portdata = usb_get_serial_port_data(port);
684 for (i=0; i < N_OUT_URB; i++) {
685 this_urb = portdata->out_urbs[i];
686 /* FIXME: This locking is insufficient as this_urb may
687 go unused during the test */
688 if (this_urb && test_bit(i, &portdata->out_busy))
689 data_len += this_urb->transfer_buffer_length;
691 dbg("%s: %d", __func__, data_len);
695 static int option_open(struct usb_serial_port *port, struct file *filp)
697 struct option_port_private *portdata;
698 struct usb_serial *serial = port->serial;
702 portdata = usb_get_serial_port_data(port);
706 /* Set some sane defaults */
707 portdata->rts_state = 1;
708 portdata->dtr_state = 1;
710 /* Reset low level data toggle and start reading from endpoints */
711 for (i = 0; i < N_IN_URB; i++) {
712 urb = portdata->in_urbs[i];
715 if (urb->dev != serial->dev) {
716 dbg("%s: dev %p != %p", __func__,
717 urb->dev, serial->dev);
722 * make sure endpoint data toggle is synchronized with the
725 usb_clear_halt(urb->dev, urb->pipe);
727 err = usb_submit_urb(urb, GFP_KERNEL);
729 dbg("%s: submit urb %d failed (%d) %d",
731 urb->transfer_buffer_length);
735 /* Reset low level data toggle on out endpoints */
736 for (i = 0; i < N_OUT_URB; i++) {
737 urb = portdata->out_urbs[i];
740 urb->dev = serial->dev;
741 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
742 usb_pipeout(urb->pipe), 0); */
745 port->tty->low_latency = 1;
747 option_send_setup(port);
752 static void option_close(struct usb_serial_port *port, struct file *filp)
755 struct usb_serial *serial = port->serial;
756 struct option_port_private *portdata;
759 portdata = usb_get_serial_port_data(port);
761 portdata->rts_state = 0;
762 portdata->dtr_state = 0;
765 mutex_lock(&serial->disc_mutex);
766 if (!serial->disconnected)
767 option_send_setup(port);
768 mutex_unlock(&serial->disc_mutex);
770 /* Stop reading/writing urbs */
771 for (i = 0; i < N_IN_URB; i++)
772 usb_kill_urb(portdata->in_urbs[i]);
773 for (i = 0; i < N_OUT_URB; i++)
774 usb_kill_urb(portdata->out_urbs[i]);
779 /* Helper functions used by option_setup_urbs */
780 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
781 int dir, void *ctx, char *buf, int len,
782 void (*callback)(struct urb *))
787 return NULL; /* endpoint not needed */
789 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
791 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
795 /* Fill URB using supplied data. */
796 usb_fill_bulk_urb(urb, serial->dev,
797 usb_sndbulkpipe(serial->dev, endpoint) | dir,
798 buf, len, callback, ctx);
804 static void option_setup_urbs(struct usb_serial *serial)
807 struct usb_serial_port *port;
808 struct option_port_private *portdata;
812 for (i = 0; i < serial->num_ports; i++) {
813 port = serial->port[i];
814 portdata = usb_get_serial_port_data(port);
816 /* Do indat endpoints first */
817 for (j = 0; j < N_IN_URB; ++j) {
818 portdata->in_urbs[j] = option_setup_urb (serial,
819 port->bulk_in_endpointAddress, USB_DIR_IN, port,
820 portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
823 /* outdat endpoints */
824 for (j = 0; j < N_OUT_URB; ++j) {
825 portdata->out_urbs[j] = option_setup_urb (serial,
826 port->bulk_out_endpointAddress, USB_DIR_OUT, port,
827 portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
833 /** send RTS/DTR state to the port.
835 * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
838 static int option_send_setup(struct usb_serial_port *port)
840 struct usb_serial *serial = port->serial;
841 struct option_port_private *portdata;
842 int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
845 portdata = usb_get_serial_port_data(port);
849 if (portdata->dtr_state)
851 if (portdata->rts_state)
854 return usb_control_msg(serial->dev,
855 usb_rcvctrlpipe(serial->dev, 0),
856 0x22,0x21,val,ifNum,NULL,0,USB_CTRL_SET_TIMEOUT);
862 static int option_startup(struct usb_serial *serial)
865 struct usb_serial_port *port;
866 struct option_port_private *portdata;
871 /* Now setup per port private data */
872 for (i = 0; i < serial->num_ports; i++) {
873 port = serial->port[i];
874 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
876 dbg("%s: kmalloc for option_port_private (%d) failed!.",
881 for (j = 0; j < N_IN_URB; j++) {
882 buffer = (u8 *)__get_free_page(GFP_KERNEL);
885 portdata->in_buffer[j] = buffer;
888 for (j = 0; j < N_OUT_URB; j++) {
889 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
891 goto bail_out_error2;
892 portdata->out_buffer[j] = buffer;
895 usb_set_serial_port_data(port, portdata);
897 if (! port->interrupt_in_urb)
899 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
901 dbg("%s: submit irq_in urb failed %d",
905 option_setup_urbs(serial);
910 for (j = 0; j < N_OUT_URB; j++)
911 kfree(portdata->out_buffer[j]);
913 for (j = 0; j < N_IN_URB; j++)
914 if (portdata->in_buffer[j])
915 free_page((unsigned long)portdata->in_buffer[j]);
920 static void option_shutdown(struct usb_serial *serial)
923 struct usb_serial_port *port;
924 struct option_port_private *portdata;
928 /* Stop reading/writing urbs */
929 for (i = 0; i < serial->num_ports; ++i) {
930 port = serial->port[i];
931 portdata = usb_get_serial_port_data(port);
932 for (j = 0; j < N_IN_URB; j++)
933 usb_kill_urb(portdata->in_urbs[j]);
934 for (j = 0; j < N_OUT_URB; j++)
935 usb_kill_urb(portdata->out_urbs[j]);
939 for (i = 0; i < serial->num_ports; ++i) {
940 port = serial->port[i];
941 portdata = usb_get_serial_port_data(port);
943 for (j = 0; j < N_IN_URB; j++) {
944 if (portdata->in_urbs[j]) {
945 usb_free_urb(portdata->in_urbs[j]);
946 free_page((unsigned long)portdata->in_buffer[j]);
947 portdata->in_urbs[j] = NULL;
950 for (j = 0; j < N_OUT_URB; j++) {
951 if (portdata->out_urbs[j]) {
952 usb_free_urb(portdata->out_urbs[j]);
953 kfree(portdata->out_buffer[j]);
954 portdata->out_urbs[j] = NULL;
959 /* Now free per port private data */
960 for (i = 0; i < serial->num_ports; i++) {
961 port = serial->port[i];
962 kfree(usb_get_serial_port_data(port));
966 MODULE_AUTHOR(DRIVER_AUTHOR);
967 MODULE_DESCRIPTION(DRIVER_DESC);
968 MODULE_VERSION(DRIVER_VERSION);
969 MODULE_LICENSE("GPL");
971 #ifdef CONFIG_USB_DEBUG
972 module_param(debug, bool, S_IRUGO | S_IWUSR);
973 MODULE_PARM_DESC(debug, "Debug messages");