]> www.pilppa.org Git - linux-2.6-omap-h63xx.git/blob - drivers/usb/serial/option.c
8bf831b630bc0bd143173bf4282cc9d77863df87
[linux-2.6-omap-h63xx.git] / drivers / usb / serial / option.c
1 /*
2   USB Driver for GSM modems
3
4   Copyright (C) 2005  Matthias Urlichs <smurf@smurf.noris.de>
5
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.
9
10   Portions copied from the Keyspan driver by Hugh Blemings <hugh@blemings.org>
11
12   History: see the git log.
13
14   Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
15
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
21
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.
25
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
28   device features.
29 */
30
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"
34
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>
44
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);
53
54 static void option_instat_callback(struct urb *urb);
55
56 static int option_write(struct usb_serial_port *port,
57                         const unsigned char *buf, int count);
58
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);
69
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
107
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
128
129 #define NOVATELWIRELESS_VENDOR_ID               0x1410
130
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
136
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
143
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
152
153 /* OVATION PRODUCTS */
154 #define NOVATELWIRELESS_PRODUCT_MC727           0x4100
155 #define NOVATELWIRELESS_PRODUCT_MC950D          0x4400
156
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
166
167 /* AMOI PRODUCTS */
168 #define AMOI_VENDOR_ID                          0x1614
169 #define AMOI_PRODUCT_H01                        0x0800
170 #define AMOI_PRODUCT_H01A                       0x7002
171 #define AMOI_PRODUCT_H02                        0x0802
172
173 #define DELL_VENDOR_ID                          0x413C
174
175 #define KYOCERA_VENDOR_ID                       0x0c88
176 #define KYOCERA_PRODUCT_KPC680                  0x180a
177
178 #define ANYDATA_VENDOR_ID                       0x16d5
179 #define ANYDATA_PRODUCT_ADU_E100A               0x6501
180 #define ANYDATA_PRODUCT_ADU_500A                0x6502
181
182 #define AXESSTEL_VENDOR_ID                      0x1726
183 #define AXESSTEL_PRODUCT_MV110H                 0x1000
184
185 #define ONDA_VENDOR_ID                          0x19d2
186 #define ONDA_PRODUCT_ET502HS                    0x0002
187
188 #define BANDRICH_VENDOR_ID                      0x1A8D
189 #define BANDRICH_PRODUCT_C100_1                 0x1002
190 #define BANDRICH_PRODUCT_C100_2                 0x1003
191
192 #define AMOI_VENDOR_ID                  0x1614
193 #define AMOI_PRODUCT_9508                       0x0800
194
195 #define QUALCOMM_VENDOR_ID                      0x05C6
196
197 #define MAXON_VENDOR_ID                         0x16d8
198
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 */
281
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) },
285
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(ONDA_VENDOR_ID, ONDA_PRODUCT_ET502HS) },
300         { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
301         { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
302         { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
303         { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
304         { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
305         { USB_DEVICE(0x19d2, 0x0001) },         /* Telstra NextG CDMA */
306         { } /* Terminating entry */
307 };
308 MODULE_DEVICE_TABLE(usb, option_ids);
309
310 static struct usb_driver option_driver = {
311         .name       = "option",
312         .probe      = usb_serial_probe,
313         .disconnect = usb_serial_disconnect,
314         .id_table   = option_ids,
315         .no_dynamic_id =        1,
316 };
317
318 /* The card has three separate interfaces, which the serial driver
319  * recognizes separately, thus num_port=1.
320  */
321
322 static struct usb_serial_driver option_1port_device = {
323         .driver = {
324                 .owner =        THIS_MODULE,
325                 .name =         "option1",
326         },
327         .description       = "GSM modem (1-port)",
328         .usb_driver        = &option_driver,
329         .id_table          = option_ids,
330         .num_ports         = 1,
331         .open              = option_open,
332         .close             = option_close,
333         .write             = option_write,
334         .write_room        = option_write_room,
335         .chars_in_buffer   = option_chars_in_buffer,
336         .throttle          = option_rx_throttle,
337         .unthrottle        = option_rx_unthrottle,
338         .ioctl             = option_ioctl,
339         .set_termios       = option_set_termios,
340         .break_ctl         = option_break_ctl,
341         .tiocmget          = option_tiocmget,
342         .tiocmset          = option_tiocmset,
343         .attach            = option_startup,
344         .shutdown          = option_shutdown,
345         .read_int_callback = option_instat_callback,
346 };
347
348 #ifdef CONFIG_USB_DEBUG
349 static int debug;
350 #else
351 #define debug 0
352 #endif
353
354 /* per port private data */
355
356 #define N_IN_URB 4
357 #define N_OUT_URB 1
358 #define IN_BUFLEN 4096
359 #define OUT_BUFLEN 128
360
361 struct option_port_private {
362         /* Input endpoints and buffer for this port */
363         struct urb *in_urbs[N_IN_URB];
364         u8 *in_buffer[N_IN_URB];
365         /* Output endpoints and buffer for this port */
366         struct urb *out_urbs[N_OUT_URB];
367         u8 *out_buffer[N_OUT_URB];
368         unsigned long out_busy;         /* Bit vector of URBs in use */
369
370         /* Settings for the port */
371         int rts_state;  /* Handshaking pins (outputs) */
372         int dtr_state;
373         int cts_state;  /* Handshaking pins (inputs) */
374         int dsr_state;
375         int dcd_state;
376         int ri_state;
377
378         unsigned long tx_start_time[N_OUT_URB];
379 };
380
381 /* Functions used by new usb-serial code. */
382 static int __init option_init(void)
383 {
384         int retval;
385         retval = usb_serial_register(&option_1port_device);
386         if (retval)
387                 goto failed_1port_device_register;
388         retval = usb_register(&option_driver);
389         if (retval)
390                 goto failed_driver_register;
391
392         info(DRIVER_DESC ": " DRIVER_VERSION);
393
394         return 0;
395
396 failed_driver_register:
397         usb_serial_deregister (&option_1port_device);
398 failed_1port_device_register:
399         return retval;
400 }
401
402 static void __exit option_exit(void)
403 {
404         usb_deregister (&option_driver);
405         usb_serial_deregister (&option_1port_device);
406 }
407
408 module_init(option_init);
409 module_exit(option_exit);
410
411 static void option_rx_throttle(struct usb_serial_port *port)
412 {
413         dbg("%s", __func__);
414 }
415
416 static void option_rx_unthrottle(struct usb_serial_port *port)
417 {
418         dbg("%s", __func__);
419 }
420
421 static void option_break_ctl(struct usb_serial_port *port, int break_state)
422 {
423         /* Unfortunately, I don't know how to send a break */
424         dbg("%s", __func__);
425 }
426
427 static void option_set_termios(struct usb_serial_port *port,
428                         struct ktermios *old_termios)
429 {
430         dbg("%s", __func__);
431         /* Doesn't support option setting */
432         tty_termios_copy_hw(port->tty->termios, old_termios);
433         option_send_setup(port);
434 }
435
436 static int option_tiocmget(struct usb_serial_port *port, struct file *file)
437 {
438         unsigned int value;
439         struct option_port_private *portdata;
440
441         portdata = usb_get_serial_port_data(port);
442
443         value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
444                 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
445                 ((portdata->cts_state) ? TIOCM_CTS : 0) |
446                 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
447                 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
448                 ((portdata->ri_state) ? TIOCM_RNG : 0);
449
450         return value;
451 }
452
453 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
454                         unsigned int set, unsigned int clear)
455 {
456         struct option_port_private *portdata;
457
458         portdata = usb_get_serial_port_data(port);
459
460         /* FIXME: what locks portdata fields ? */
461         if (set & TIOCM_RTS)
462                 portdata->rts_state = 1;
463         if (set & TIOCM_DTR)
464                 portdata->dtr_state = 1;
465
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);
471 }
472
473 static int option_ioctl(struct usb_serial_port *port, struct file *file,
474                         unsigned int cmd, unsigned long arg)
475 {
476         return -ENOIOCTLCMD;
477 }
478
479 /* Write */
480 static int option_write(struct usb_serial_port *port,
481                         const unsigned char *buf, int count)
482 {
483         struct option_port_private *portdata;
484         int i;
485         int left, todo;
486         struct urb *this_urb = NULL; /* spurious */
487         int err;
488
489         portdata = usb_get_serial_port_data(port);
490
491         dbg("%s: write (%d chars)", __func__, count);
492
493         i = 0;
494         left = count;
495         for (i=0; left > 0 && i < N_OUT_URB; i++) {
496                 todo = left;
497                 if (todo > OUT_BUFLEN)
498                         todo = OUT_BUFLEN;
499
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))
504                                 continue;
505                         usb_unlink_urb(this_urb);
506                         continue;
507                 }
508                 if (this_urb->status != 0)
509                         dbg("usb_write %p failed (err=%d)",
510                                 this_urb, this_urb->status);
511
512                 dbg("%s: endpoint %d buf %d", __func__,
513                         usb_pipeendpoint(this_urb->pipe), i);
514
515                 /* send the data */
516                 memcpy (this_urb->transfer_buffer, buf, todo);
517                 this_urb->transfer_buffer_length = todo;
518
519                 this_urb->dev = port->serial->dev;
520                 err = usb_submit_urb(this_urb, GFP_ATOMIC);
521                 if (err) {
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);
526                         continue;
527                 }
528                 portdata->tx_start_time[i] = jiffies;
529                 buf += todo;
530                 left -= todo;
531         }
532
533         count -= left;
534         dbg("%s: wrote (did %d)", __func__, count);
535         return count;
536 }
537
538 static void option_indat_callback(struct urb *urb)
539 {
540         int err;
541         int endpoint;
542         struct usb_serial_port *port;
543         struct tty_struct *tty;
544         unsigned char *data = urb->transfer_buffer;
545         int status = urb->status;
546
547         dbg("%s: %p", __func__, urb);
548
549         endpoint = usb_pipeendpoint(urb->pipe);
550         port =  urb->context;
551
552         if (status) {
553                 dbg("%s: nonzero status: %d on endpoint %02x.",
554                     __func__, status, endpoint);
555         } else {
556                 tty = port->tty;
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);
561                 } else {
562                         dbg("%s: empty read urb received", __func__);
563                 }
564
565                 /* Resubmit urb so we continue receiving */
566                 if (port->open_count && status != -ESHUTDOWN) {
567                         err = usb_submit_urb(urb, GFP_ATOMIC);
568                         if (err)
569                                 printk(KERN_ERR "%s: resubmit read urb failed. "
570                                         "(%d)", __func__, err);
571                 }
572         }
573         return;
574 }
575
576 static void option_outdat_callback(struct urb *urb)
577 {
578         struct usb_serial_port *port;
579         struct option_port_private *portdata;
580         int i;
581
582         dbg("%s", __func__);
583
584         port =  urb->context;
585
586         usb_serial_port_softint(port);
587
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);
593                         break;
594                 }
595         }
596 }
597
598 static void option_instat_callback(struct urb *urb)
599 {
600         int err;
601         int status = urb->status;
602         struct usb_serial_port *port =  urb->context;
603         struct option_port_private *portdata = usb_get_serial_port_data(port);
604         struct usb_serial *serial = port->serial;
605
606         dbg("%s", __func__);
607         dbg("%s: urb %p port %p has data %p", __func__,urb,port,portdata);
608
609         if (status == 0) {
610                 struct usb_ctrlrequest *req_pkt =
611                                 (struct usb_ctrlrequest *)urb->transfer_buffer;
612
613                 if (!req_pkt) {
614                         dbg("%s: NULL req_pkt\n", __func__);
615                         return;
616                 }
617                 if ((req_pkt->bRequestType == 0xA1) &&
618                                 (req_pkt->bRequest == 0x20)) {
619                         int old_dcd_state;
620                         unsigned char signals = *((unsigned char *)
621                                         urb->transfer_buffer +
622                                         sizeof(struct usb_ctrlrequest));
623
624                         dbg("%s: signal x%x", __func__, signals);
625
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);
631
632                         if (port->tty && !C_CLOCAL(port->tty) &&
633                                         old_dcd_state && !portdata->dcd_state)
634                                 tty_hangup(port->tty);
635                 } else {
636                         dbg("%s: type %x req %x", __func__,
637                                 req_pkt->bRequestType,req_pkt->bRequest);
638                 }
639         } else
640                 dbg("%s: error %d", __func__, status);
641
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);
646                 if (err)
647                         dbg("%s: resubmit intr urb failed. (%d)",
648                                 __func__, err);
649         }
650 }
651
652 static int option_write_room(struct usb_serial_port *port)
653 {
654         struct option_port_private *portdata;
655         int i;
656         int data_len = 0;
657         struct urb *this_urb;
658
659         portdata = usb_get_serial_port_data(port);
660
661
662         for (i=0; i < N_OUT_URB; i++) {
663                 this_urb = portdata->out_urbs[i];
664                 if (this_urb && !test_bit(i, &portdata->out_busy))
665                         data_len += OUT_BUFLEN;
666         }
667
668         dbg("%s: %d", __func__, data_len);
669         return data_len;
670 }
671
672 static int option_chars_in_buffer(struct usb_serial_port *port)
673 {
674         struct option_port_private *portdata;
675         int i;
676         int data_len = 0;
677         struct urb *this_urb;
678
679         portdata = usb_get_serial_port_data(port);
680
681         for (i=0; i < N_OUT_URB; i++) {
682                 this_urb = portdata->out_urbs[i];
683                 /* FIXME: This locking is insufficient as this_urb may
684                    go unused during the test */
685                 if (this_urb && test_bit(i, &portdata->out_busy))
686                         data_len += this_urb->transfer_buffer_length;
687         }
688         dbg("%s: %d", __func__, data_len);
689         return data_len;
690 }
691
692 static int option_open(struct usb_serial_port *port, struct file *filp)
693 {
694         struct option_port_private *portdata;
695         struct usb_serial *serial = port->serial;
696         int i, err;
697         struct urb *urb;
698
699         portdata = usb_get_serial_port_data(port);
700
701         dbg("%s", __func__);
702
703         /* Set some sane defaults */
704         portdata->rts_state = 1;
705         portdata->dtr_state = 1;
706
707         /* Reset low level data toggle and start reading from endpoints */
708         for (i = 0; i < N_IN_URB; i++) {
709                 urb = portdata->in_urbs[i];
710                 if (! urb)
711                         continue;
712                 if (urb->dev != serial->dev) {
713                         dbg("%s: dev %p != %p", __func__,
714                                 urb->dev, serial->dev);
715                         continue;
716                 }
717
718                 /*
719                  * make sure endpoint data toggle is synchronized with the
720                  * device
721                  */
722                 usb_clear_halt(urb->dev, urb->pipe);
723
724                 err = usb_submit_urb(urb, GFP_KERNEL);
725                 if (err) {
726                         dbg("%s: submit urb %d failed (%d) %d",
727                                 __func__, i, err,
728                                 urb->transfer_buffer_length);
729                 }
730         }
731
732         /* Reset low level data toggle on out endpoints */
733         for (i = 0; i < N_OUT_URB; i++) {
734                 urb = portdata->out_urbs[i];
735                 if (! urb)
736                         continue;
737                 urb->dev = serial->dev;
738                 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
739                                 usb_pipeout(urb->pipe), 0); */
740         }
741
742         port->tty->low_latency = 1;
743
744         option_send_setup(port);
745
746         return (0);
747 }
748
749 static void option_close(struct usb_serial_port *port, struct file *filp)
750 {
751         int i;
752         struct usb_serial *serial = port->serial;
753         struct option_port_private *portdata;
754
755         dbg("%s", __func__);
756         portdata = usb_get_serial_port_data(port);
757
758         portdata->rts_state = 0;
759         portdata->dtr_state = 0;
760
761         if (serial->dev) {
762                 mutex_lock(&serial->disc_mutex);
763                 if (!serial->disconnected)
764                         option_send_setup(port);
765                 mutex_unlock(&serial->disc_mutex);
766
767                 /* Stop reading/writing urbs */
768                 for (i = 0; i < N_IN_URB; i++)
769                         usb_kill_urb(portdata->in_urbs[i]);
770                 for (i = 0; i < N_OUT_URB; i++)
771                         usb_kill_urb(portdata->out_urbs[i]);
772         }
773         port->tty = NULL;
774 }
775
776 /* Helper functions used by option_setup_urbs */
777 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
778                 int dir, void *ctx, char *buf, int len,
779                 void (*callback)(struct urb *))
780 {
781         struct urb *urb;
782
783         if (endpoint == -1)
784                 return NULL;            /* endpoint not needed */
785
786         urb = usb_alloc_urb(0, GFP_KERNEL);             /* No ISO */
787         if (urb == NULL) {
788                 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
789                 return NULL;
790         }
791
792                 /* Fill URB using supplied data. */
793         usb_fill_bulk_urb(urb, serial->dev,
794                       usb_sndbulkpipe(serial->dev, endpoint) | dir,
795                       buf, len, callback, ctx);
796
797         return urb;
798 }
799
800 /* Setup urbs */
801 static void option_setup_urbs(struct usb_serial *serial)
802 {
803         int i,j;
804         struct usb_serial_port *port;
805         struct option_port_private *portdata;
806
807         dbg("%s", __func__);
808
809         for (i = 0; i < serial->num_ports; i++) {
810                 port = serial->port[i];
811                 portdata = usb_get_serial_port_data(port);
812
813         /* Do indat endpoints first */
814                 for (j = 0; j < N_IN_URB; ++j) {
815                         portdata->in_urbs[j] = option_setup_urb (serial,
816                         port->bulk_in_endpointAddress, USB_DIR_IN, port,
817                         portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
818                 }
819
820                 /* outdat endpoints */
821                 for (j = 0; j < N_OUT_URB; ++j) {
822                         portdata->out_urbs[j] = option_setup_urb (serial,
823                         port->bulk_out_endpointAddress, USB_DIR_OUT, port,
824                         portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
825                 }
826         }
827 }
828
829
830 /** send RTS/DTR state to the port.
831  *
832  * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
833  * CDC.
834 */
835 static int option_send_setup(struct usb_serial_port *port)
836 {
837         struct usb_serial *serial = port->serial;
838         struct option_port_private *portdata;
839         int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
840         dbg("%s", __func__);
841
842         portdata = usb_get_serial_port_data(port);
843
844         if (port->tty) {
845                 int val = 0;
846                 if (portdata->dtr_state)
847                         val |= 0x01;
848                 if (portdata->rts_state)
849                         val |= 0x02;
850
851                 return usb_control_msg(serial->dev,
852                                 usb_rcvctrlpipe(serial->dev, 0),
853                                 0x22,0x21,val,ifNum,NULL,0,USB_CTRL_SET_TIMEOUT);
854         }
855
856         return 0;
857 }
858
859 static int option_startup(struct usb_serial *serial)
860 {
861         int i, j, err;
862         struct usb_serial_port *port;
863         struct option_port_private *portdata;
864         u8 *buffer;
865
866         dbg("%s", __func__);
867
868         /* Now setup per port private data */
869         for (i = 0; i < serial->num_ports; i++) {
870                 port = serial->port[i];
871                 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
872                 if (!portdata) {
873                         dbg("%s: kmalloc for option_port_private (%d) failed!.",
874                                         __func__, i);
875                         return (1);
876                 }
877
878                 for (j = 0; j < N_IN_URB; j++) {
879                         buffer = (u8 *)__get_free_page(GFP_KERNEL);
880                         if (!buffer)
881                                 goto bail_out_error;
882                         portdata->in_buffer[j] = buffer;
883                 }
884
885                 for (j = 0; j < N_OUT_URB; j++) {
886                         buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
887                         if (!buffer)
888                                 goto bail_out_error2;
889                         portdata->out_buffer[j] = buffer;
890                 }
891
892                 usb_set_serial_port_data(port, portdata);
893
894                 if (! port->interrupt_in_urb)
895                         continue;
896                 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
897                 if (err)
898                         dbg("%s: submit irq_in urb failed %d",
899                                 __func__, err);
900         }
901
902         option_setup_urbs(serial);
903
904         return (0);
905
906 bail_out_error2:
907         for (j = 0; j < N_OUT_URB; j++)
908                 kfree(portdata->out_buffer[j]);
909 bail_out_error:
910         for (j = 0; j < N_IN_URB; j++)
911                 if (portdata->in_buffer[j])
912                         free_page((unsigned long)portdata->in_buffer[j]);
913         kfree(portdata);
914         return 1;
915 }
916
917 static void option_shutdown(struct usb_serial *serial)
918 {
919         int i, j;
920         struct usb_serial_port *port;
921         struct option_port_private *portdata;
922
923         dbg("%s", __func__);
924
925         /* Stop reading/writing urbs */
926         for (i = 0; i < serial->num_ports; ++i) {
927                 port = serial->port[i];
928                 portdata = usb_get_serial_port_data(port);
929                 for (j = 0; j < N_IN_URB; j++)
930                         usb_kill_urb(portdata->in_urbs[j]);
931                 for (j = 0; j < N_OUT_URB; j++)
932                         usb_kill_urb(portdata->out_urbs[j]);
933         }
934
935         /* Now free them */
936         for (i = 0; i < serial->num_ports; ++i) {
937                 port = serial->port[i];
938                 portdata = usb_get_serial_port_data(port);
939
940                 for (j = 0; j < N_IN_URB; j++) {
941                         if (portdata->in_urbs[j]) {
942                                 usb_free_urb(portdata->in_urbs[j]);
943                                 free_page((unsigned long)portdata->in_buffer[j]);
944                                 portdata->in_urbs[j] = NULL;
945                         }
946                 }
947                 for (j = 0; j < N_OUT_URB; j++) {
948                         if (portdata->out_urbs[j]) {
949                                 usb_free_urb(portdata->out_urbs[j]);
950                                 kfree(portdata->out_buffer[j]);
951                                 portdata->out_urbs[j] = NULL;
952                         }
953                 }
954         }
955
956         /* Now free per port private data */
957         for (i = 0; i < serial->num_ports; i++) {
958                 port = serial->port[i];
959                 kfree(usb_get_serial_port_data(port));
960         }
961 }
962
963 MODULE_AUTHOR(DRIVER_AUTHOR);
964 MODULE_DESCRIPTION(DRIVER_DESC);
965 MODULE_VERSION(DRIVER_VERSION);
966 MODULE_LICENSE("GPL");
967
968 #ifdef CONFIG_USB_DEBUG
969 module_param(debug, bool, S_IRUGO | S_IWUSR);
970 MODULE_PARM_DESC(debug, "Debug messages");
971 #endif
972