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
169 #define DELL_VENDOR_ID 0x413C
171 #define KYOCERA_VENDOR_ID 0x0c88
172 #define KYOCERA_PRODUCT_KPC680 0x180a
174 #define ANYDATA_VENDOR_ID 0x16d5
175 #define ANYDATA_PRODUCT_ADU_E100A 0x6501
176 #define ANYDATA_PRODUCT_ADU_500A 0x6502
178 #define AXESSTEL_VENDOR_ID 0x1726
179 #define AXESSTEL_PRODUCT_MV110H 0x1000
181 #define BANDRICH_VENDOR_ID 0x1A8D
182 #define BANDRICH_PRODUCT_C100_1 0x1002
183 #define BANDRICH_PRODUCT_C100_2 0x1003
185 #define AMOI_VENDOR_ID 0x1614
186 #define AMOI_PRODUCT_9508 0x0800
188 #define QUALCOMM_VENDOR_ID 0x05C6
190 #define MAXON_VENDOR_ID 0x16d8
192 static struct usb_device_id option_ids[] = {
193 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
194 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
195 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
196 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
197 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
198 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
199 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
200 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
201 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
202 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
203 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
204 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
205 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
206 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
207 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
208 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
209 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
210 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
211 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
212 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
213 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
214 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
215 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
216 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
217 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
218 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
219 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
220 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
221 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
222 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
223 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
224 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
225 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
226 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
227 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
228 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600) },
229 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
230 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
231 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401) },
232 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403) },
233 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405) },
234 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406) },
235 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408) },
236 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409) },
237 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410) },
238 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411) },
239 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412) },
240 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413) },
241 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414) },
242 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415) },
243 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416) },
244 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417) },
245 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418) },
246 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419) },
247 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
248 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
249 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
250 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
251 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
252 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
253 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
254 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
255 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
256 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
257 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
258 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
259 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
260 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
261 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
262 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
263 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
264 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
265 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
266 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U727) }, /* Novatel U727 */
267 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
268 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
269 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
270 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
271 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
272 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
273 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
274 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
276 { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
277 { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
278 { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
279 { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
280 { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
281 { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
282 { USB_DEVICE(DELL_VENDOR_ID, 0x8129) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
283 { USB_DEVICE(DELL_VENDOR_ID, 0x8133) }, /* Dell Wireless 5720 == Novatel EV620 CDMA/EV-DO */
284 { USB_DEVICE(DELL_VENDOR_ID, 0x8136) }, /* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
285 { USB_DEVICE(DELL_VENDOR_ID, 0x8137) }, /* Dell Wireless HSDPA 5520 */
286 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
287 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
288 { USB_DEVICE(AXESSTEL_VENDOR_ID, AXESSTEL_PRODUCT_MV110H) },
289 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
290 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
291 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
292 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
293 { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
294 { } /* Terminating entry */
296 MODULE_DEVICE_TABLE(usb, option_ids);
298 static struct usb_driver option_driver = {
300 .probe = usb_serial_probe,
301 .disconnect = usb_serial_disconnect,
302 .id_table = option_ids,
306 /* The card has three separate interfaces, which the serial driver
307 * recognizes separately, thus num_port=1.
310 static struct usb_serial_driver option_1port_device = {
312 .owner = THIS_MODULE,
315 .description = "GSM modem (1-port)",
316 .usb_driver = &option_driver,
317 .id_table = option_ids,
318 .num_interrupt_in = NUM_DONT_CARE,
319 .num_bulk_in = NUM_DONT_CARE,
320 .num_bulk_out = NUM_DONT_CARE,
323 .close = option_close,
324 .write = option_write,
325 .write_room = option_write_room,
326 .chars_in_buffer = option_chars_in_buffer,
327 .throttle = option_rx_throttle,
328 .unthrottle = option_rx_unthrottle,
329 .ioctl = option_ioctl,
330 .set_termios = option_set_termios,
331 .break_ctl = option_break_ctl,
332 .tiocmget = option_tiocmget,
333 .tiocmset = option_tiocmset,
334 .attach = option_startup,
335 .shutdown = option_shutdown,
336 .read_int_callback = option_instat_callback,
339 #ifdef CONFIG_USB_DEBUG
345 /* per port private data */
349 #define IN_BUFLEN 4096
350 #define OUT_BUFLEN 128
352 struct option_port_private {
353 /* Input endpoints and buffer for this port */
354 struct urb *in_urbs[N_IN_URB];
355 u8 *in_buffer[N_IN_URB];
356 /* Output endpoints and buffer for this port */
357 struct urb *out_urbs[N_OUT_URB];
358 u8 *out_buffer[N_OUT_URB];
359 unsigned long out_busy; /* Bit vector of URBs in use */
361 /* Settings for the port */
362 int rts_state; /* Handshaking pins (outputs) */
364 int cts_state; /* Handshaking pins (inputs) */
369 unsigned long tx_start_time[N_OUT_URB];
372 /* Functions used by new usb-serial code. */
373 static int __init option_init(void)
376 retval = usb_serial_register(&option_1port_device);
378 goto failed_1port_device_register;
379 retval = usb_register(&option_driver);
381 goto failed_driver_register;
383 info(DRIVER_DESC ": " DRIVER_VERSION);
387 failed_driver_register:
388 usb_serial_deregister (&option_1port_device);
389 failed_1port_device_register:
393 static void __exit option_exit(void)
395 usb_deregister (&option_driver);
396 usb_serial_deregister (&option_1port_device);
399 module_init(option_init);
400 module_exit(option_exit);
402 static void option_rx_throttle(struct usb_serial_port *port)
404 dbg("%s", __FUNCTION__);
407 static void option_rx_unthrottle(struct usb_serial_port *port)
409 dbg("%s", __FUNCTION__);
412 static void option_break_ctl(struct usb_serial_port *port, int break_state)
414 /* Unfortunately, I don't know how to send a break */
415 dbg("%s", __FUNCTION__);
418 static void option_set_termios(struct usb_serial_port *port,
419 struct ktermios *old_termios)
421 dbg("%s", __FUNCTION__);
422 /* Doesn't support option setting */
423 tty_termios_copy_hw(port->tty->termios, old_termios);
424 option_send_setup(port);
427 static int option_tiocmget(struct usb_serial_port *port, struct file *file)
430 struct option_port_private *portdata;
432 portdata = usb_get_serial_port_data(port);
434 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
435 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
436 ((portdata->cts_state) ? TIOCM_CTS : 0) |
437 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
438 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
439 ((portdata->ri_state) ? TIOCM_RNG : 0);
444 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
445 unsigned int set, unsigned int clear)
447 struct option_port_private *portdata;
449 portdata = usb_get_serial_port_data(port);
452 portdata->rts_state = 1;
454 portdata->dtr_state = 1;
456 if (clear & TIOCM_RTS)
457 portdata->rts_state = 0;
458 if (clear & TIOCM_DTR)
459 portdata->dtr_state = 0;
460 return option_send_setup(port);
463 static int option_ioctl(struct usb_serial_port *port, struct file *file,
464 unsigned int cmd, unsigned long arg)
470 static int option_write(struct usb_serial_port *port,
471 const unsigned char *buf, int count)
473 struct option_port_private *portdata;
476 struct urb *this_urb = NULL; /* spurious */
479 portdata = usb_get_serial_port_data(port);
481 dbg("%s: write (%d chars)", __FUNCTION__, count);
485 for (i=0; left > 0 && i < N_OUT_URB; i++) {
487 if (todo > OUT_BUFLEN)
490 this_urb = portdata->out_urbs[i];
491 if (test_and_set_bit(i, &portdata->out_busy)) {
492 if (time_before(jiffies,
493 portdata->tx_start_time[i] + 10 * HZ))
495 usb_unlink_urb(this_urb);
498 if (this_urb->status != 0)
499 dbg("usb_write %p failed (err=%d)",
500 this_urb, this_urb->status);
502 dbg("%s: endpoint %d buf %d", __FUNCTION__,
503 usb_pipeendpoint(this_urb->pipe), i);
506 memcpy (this_urb->transfer_buffer, buf, todo);
507 this_urb->transfer_buffer_length = todo;
509 this_urb->dev = port->serial->dev;
510 err = usb_submit_urb(this_urb, GFP_ATOMIC);
512 dbg("usb_submit_urb %p (write bulk) failed "
513 "(%d, has %d)", this_urb,
514 err, this_urb->status);
515 clear_bit(i, &portdata->out_busy);
518 portdata->tx_start_time[i] = jiffies;
524 dbg("%s: wrote (did %d)", __FUNCTION__, count);
528 static void option_indat_callback(struct urb *urb)
532 struct usb_serial_port *port;
533 struct tty_struct *tty;
534 unsigned char *data = urb->transfer_buffer;
535 int status = urb->status;
537 dbg("%s: %p", __FUNCTION__, urb);
539 endpoint = usb_pipeendpoint(urb->pipe);
540 port = (struct usb_serial_port *) urb->context;
543 dbg("%s: nonzero status: %d on endpoint %02x.",
544 __FUNCTION__, status, endpoint);
547 if (urb->actual_length) {
548 tty_buffer_request_room(tty, urb->actual_length);
549 tty_insert_flip_string(tty, data, urb->actual_length);
550 tty_flip_buffer_push(tty);
552 dbg("%s: empty read urb received", __FUNCTION__);
555 /* Resubmit urb so we continue receiving */
556 if (port->open_count && status != -ESHUTDOWN) {
557 err = usb_submit_urb(urb, GFP_ATOMIC);
559 printk(KERN_ERR "%s: resubmit read urb failed. "
560 "(%d)", __FUNCTION__, err);
566 static void option_outdat_callback(struct urb *urb)
568 struct usb_serial_port *port;
569 struct option_port_private *portdata;
572 dbg("%s", __FUNCTION__);
574 port = (struct usb_serial_port *) urb->context;
576 usb_serial_port_softint(port);
578 portdata = usb_get_serial_port_data(port);
579 for (i = 0; i < N_OUT_URB; ++i) {
580 if (portdata->out_urbs[i] == urb) {
581 smp_mb__before_clear_bit();
582 clear_bit(i, &portdata->out_busy);
588 static void option_instat_callback(struct urb *urb)
591 int status = urb->status;
592 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
593 struct option_port_private *portdata = usb_get_serial_port_data(port);
594 struct usb_serial *serial = port->serial;
596 dbg("%s", __FUNCTION__);
597 dbg("%s: urb %p port %p has data %p", __FUNCTION__,urb,port,portdata);
600 struct usb_ctrlrequest *req_pkt =
601 (struct usb_ctrlrequest *)urb->transfer_buffer;
604 dbg("%s: NULL req_pkt\n", __FUNCTION__);
607 if ((req_pkt->bRequestType == 0xA1) &&
608 (req_pkt->bRequest == 0x20)) {
610 unsigned char signals = *((unsigned char *)
611 urb->transfer_buffer +
612 sizeof(struct usb_ctrlrequest));
614 dbg("%s: signal x%x", __FUNCTION__, signals);
616 old_dcd_state = portdata->dcd_state;
617 portdata->cts_state = 1;
618 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
619 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
620 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
622 if (port->tty && !C_CLOCAL(port->tty) &&
623 old_dcd_state && !portdata->dcd_state)
624 tty_hangup(port->tty);
626 dbg("%s: type %x req %x", __FUNCTION__,
627 req_pkt->bRequestType,req_pkt->bRequest);
630 dbg("%s: error %d", __FUNCTION__, status);
632 /* Resubmit urb so we continue receiving IRQ data */
633 if (status != -ESHUTDOWN) {
634 urb->dev = serial->dev;
635 err = usb_submit_urb(urb, GFP_ATOMIC);
637 dbg("%s: resubmit intr urb failed. (%d)",
642 static int option_write_room(struct usb_serial_port *port)
644 struct option_port_private *portdata;
647 struct urb *this_urb;
649 portdata = usb_get_serial_port_data(port);
651 for (i=0; i < N_OUT_URB; i++) {
652 this_urb = portdata->out_urbs[i];
653 if (this_urb && !test_bit(i, &portdata->out_busy))
654 data_len += OUT_BUFLEN;
657 dbg("%s: %d", __FUNCTION__, data_len);
661 static int option_chars_in_buffer(struct usb_serial_port *port)
663 struct option_port_private *portdata;
666 struct urb *this_urb;
668 portdata = usb_get_serial_port_data(port);
670 for (i=0; i < N_OUT_URB; i++) {
671 this_urb = portdata->out_urbs[i];
672 if (this_urb && test_bit(i, &portdata->out_busy))
673 data_len += this_urb->transfer_buffer_length;
675 dbg("%s: %d", __FUNCTION__, data_len);
679 static int option_open(struct usb_serial_port *port, struct file *filp)
681 struct option_port_private *portdata;
682 struct usb_serial *serial = port->serial;
686 portdata = usb_get_serial_port_data(port);
688 dbg("%s", __FUNCTION__);
690 /* Set some sane defaults */
691 portdata->rts_state = 1;
692 portdata->dtr_state = 1;
694 /* Reset low level data toggle and start reading from endpoints */
695 for (i = 0; i < N_IN_URB; i++) {
696 urb = portdata->in_urbs[i];
699 if (urb->dev != serial->dev) {
700 dbg("%s: dev %p != %p", __FUNCTION__,
701 urb->dev, serial->dev);
706 * make sure endpoint data toggle is synchronized with the
709 usb_clear_halt(urb->dev, urb->pipe);
711 err = usb_submit_urb(urb, GFP_KERNEL);
713 dbg("%s: submit urb %d failed (%d) %d",
714 __FUNCTION__, i, err,
715 urb->transfer_buffer_length);
719 /* Reset low level data toggle on out endpoints */
720 for (i = 0; i < N_OUT_URB; i++) {
721 urb = portdata->out_urbs[i];
724 urb->dev = serial->dev;
725 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
726 usb_pipeout(urb->pipe), 0); */
729 port->tty->low_latency = 1;
731 option_send_setup(port);
736 static void option_close(struct usb_serial_port *port, struct file *filp)
739 struct usb_serial *serial = port->serial;
740 struct option_port_private *portdata;
742 dbg("%s", __FUNCTION__);
743 portdata = usb_get_serial_port_data(port);
745 portdata->rts_state = 0;
746 portdata->dtr_state = 0;
749 mutex_lock(&serial->disc_mutex);
750 if (!serial->disconnected)
751 option_send_setup(port);
752 mutex_unlock(&serial->disc_mutex);
754 /* Stop reading/writing urbs */
755 for (i = 0; i < N_IN_URB; i++)
756 usb_kill_urb(portdata->in_urbs[i]);
757 for (i = 0; i < N_OUT_URB; i++)
758 usb_kill_urb(portdata->out_urbs[i]);
763 /* Helper functions used by option_setup_urbs */
764 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
765 int dir, void *ctx, char *buf, int len,
766 void (*callback)(struct urb *))
771 return NULL; /* endpoint not needed */
773 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
775 dbg("%s: alloc for endpoint %d failed.", __FUNCTION__, endpoint);
779 /* Fill URB using supplied data. */
780 usb_fill_bulk_urb(urb, serial->dev,
781 usb_sndbulkpipe(serial->dev, endpoint) | dir,
782 buf, len, callback, ctx);
788 static void option_setup_urbs(struct usb_serial *serial)
791 struct usb_serial_port *port;
792 struct option_port_private *portdata;
794 dbg("%s", __FUNCTION__);
796 for (i = 0; i < serial->num_ports; i++) {
797 port = serial->port[i];
798 portdata = usb_get_serial_port_data(port);
800 /* Do indat endpoints first */
801 for (j = 0; j < N_IN_URB; ++j) {
802 portdata->in_urbs[j] = option_setup_urb (serial,
803 port->bulk_in_endpointAddress, USB_DIR_IN, port,
804 portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
807 /* outdat endpoints */
808 for (j = 0; j < N_OUT_URB; ++j) {
809 portdata->out_urbs[j] = option_setup_urb (serial,
810 port->bulk_out_endpointAddress, USB_DIR_OUT, port,
811 portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
816 static int option_send_setup(struct usb_serial_port *port)
818 struct usb_serial *serial = port->serial;
819 struct option_port_private *portdata;
821 dbg("%s", __FUNCTION__);
823 if (port->number != 0)
826 portdata = usb_get_serial_port_data(port);
830 if (portdata->dtr_state)
832 if (portdata->rts_state)
835 return usb_control_msg(serial->dev,
836 usb_rcvctrlpipe(serial->dev, 0),
837 0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
843 static int option_startup(struct usb_serial *serial)
846 struct usb_serial_port *port;
847 struct option_port_private *portdata;
850 dbg("%s", __FUNCTION__);
852 /* Now setup per port private data */
853 for (i = 0; i < serial->num_ports; i++) {
854 port = serial->port[i];
855 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
857 dbg("%s: kmalloc for option_port_private (%d) failed!.",
862 for (j = 0; j < N_IN_URB; j++) {
863 buffer = (u8 *)__get_free_page(GFP_KERNEL);
866 portdata->in_buffer[j] = buffer;
869 for (j = 0; j < N_OUT_URB; j++) {
870 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
872 goto bail_out_error2;
873 portdata->out_buffer[j] = buffer;
876 usb_set_serial_port_data(port, portdata);
878 if (! port->interrupt_in_urb)
880 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
882 dbg("%s: submit irq_in urb failed %d",
886 option_setup_urbs(serial);
891 for (j = 0; j < N_OUT_URB; j++)
892 kfree(portdata->out_buffer[j]);
894 for (j = 0; j < N_IN_URB; j++)
895 if (portdata->in_buffer[j])
896 free_page((unsigned long)portdata->in_buffer[j]);
901 static void option_shutdown(struct usb_serial *serial)
904 struct usb_serial_port *port;
905 struct option_port_private *portdata;
907 dbg("%s", __FUNCTION__);
909 /* Stop reading/writing urbs */
910 for (i = 0; i < serial->num_ports; ++i) {
911 port = serial->port[i];
912 portdata = usb_get_serial_port_data(port);
913 for (j = 0; j < N_IN_URB; j++)
914 usb_kill_urb(portdata->in_urbs[j]);
915 for (j = 0; j < N_OUT_URB; j++)
916 usb_kill_urb(portdata->out_urbs[j]);
920 for (i = 0; i < serial->num_ports; ++i) {
921 port = serial->port[i];
922 portdata = usb_get_serial_port_data(port);
924 for (j = 0; j < N_IN_URB; j++) {
925 if (portdata->in_urbs[j]) {
926 usb_free_urb(portdata->in_urbs[j]);
927 free_page((unsigned long)portdata->in_buffer[j]);
928 portdata->in_urbs[j] = NULL;
931 for (j = 0; j < N_OUT_URB; j++) {
932 if (portdata->out_urbs[j]) {
933 usb_free_urb(portdata->out_urbs[j]);
934 kfree(portdata->out_buffer[j]);
935 portdata->out_urbs[j] = NULL;
940 /* Now free per port private data */
941 for (i = 0; i < serial->num_ports; i++) {
942 port = serial->port[i];
943 kfree(usb_get_serial_port_data(port));
947 MODULE_AUTHOR(DRIVER_AUTHOR);
948 MODULE_DESCRIPTION(DRIVER_DESC);
949 MODULE_VERSION(DRIVER_VERSION);
950 MODULE_LICENSE("GPL");
952 #ifdef CONFIG_USB_DEBUG
953 module_param(debug, bool, S_IRUGO | S_IWUSR);
954 MODULE_PARM_DESC(debug, "Debug messages");