Merge branch 'master' of /pub/scm/linux/kernel/git/torvalds/linux-2.6
[linux-2.6] / 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 #define NOVATELWIRELESS_PRODUCT_U727            0x5010
158
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
168
169 /* AMOI PRODUCTS */
170 #define AMOI_VENDOR_ID                          0x1614
171 #define AMOI_PRODUCT_H01                        0x0800
172 #define AMOI_PRODUCT_H01A                       0x7002
173 #define AMOI_PRODUCT_H02                        0x0802
174
175 #define DELL_VENDOR_ID                          0x413C
176
177 #define KYOCERA_VENDOR_ID                       0x0c88
178 #define KYOCERA_PRODUCT_KPC680                  0x180a
179
180 #define ANYDATA_VENDOR_ID                       0x16d5
181 #define ANYDATA_PRODUCT_ADU_E100A               0x6501
182 #define ANYDATA_PRODUCT_ADU_500A                0x6502
183
184 #define AXESSTEL_VENDOR_ID                      0x1726
185 #define AXESSTEL_PRODUCT_MV110H                 0x1000
186
187 #define BANDRICH_VENDOR_ID                      0x1A8D
188 #define BANDRICH_PRODUCT_C100_1                 0x1002
189 #define BANDRICH_PRODUCT_C100_2                 0x1003
190
191 #define AMOI_VENDOR_ID                  0x1614
192 #define AMOI_PRODUCT_9508                       0x0800
193
194 #define QUALCOMM_VENDOR_ID                      0x05C6
195
196 #define MAXON_VENDOR_ID                         0x16d8
197
198 static struct usb_device_id option_ids[] = {
199         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
200         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
201         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
202         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
203         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
204         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
205         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
206         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
207         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
208         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
209         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
210         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
211         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
212         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
213         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
214         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
215         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
216         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
217         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
218         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
219         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
220         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
221         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
222         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
223         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
224         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
225         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
226         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
227         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
228         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
229         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
230         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
231         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
232         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
233         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
234         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600) },
235         { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
236         { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
237         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401) },
238         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403) },
239         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405) },
240         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406) },
241         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408) },
242         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409) },
243         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410) },
244         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411) },
245         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412) },
246         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413) },
247         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414) },
248         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415) },
249         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416) },
250         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417) },
251         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418) },
252         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419) },
253         { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
254         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
255         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
256         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
257         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
258         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
259         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
260         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
261         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
262         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
263         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
264         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
265         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
266         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
267         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
268         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
269         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
270         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
271         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
272         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U727) }, /* Novatel U727 */
273         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
274         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
275         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
276         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
277         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
278         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
279         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
280         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
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(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
300         { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
301         { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
302         { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
303         { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
304         { } /* Terminating entry */
305 };
306 MODULE_DEVICE_TABLE(usb, option_ids);
307
308 static struct usb_driver option_driver = {
309         .name       = "option",
310         .probe      = usb_serial_probe,
311         .disconnect = usb_serial_disconnect,
312         .id_table   = option_ids,
313         .no_dynamic_id =        1,
314 };
315
316 /* The card has three separate interfaces, which the serial driver
317  * recognizes separately, thus num_port=1.
318  */
319
320 static struct usb_serial_driver option_1port_device = {
321         .driver = {
322                 .owner =        THIS_MODULE,
323                 .name =         "option1",
324         },
325         .description       = "GSM modem (1-port)",
326         .usb_driver        = &option_driver,
327         .id_table          = option_ids,
328         .num_ports         = 1,
329         .open              = option_open,
330         .close             = option_close,
331         .write             = option_write,
332         .write_room        = option_write_room,
333         .chars_in_buffer   = option_chars_in_buffer,
334         .throttle          = option_rx_throttle,
335         .unthrottle        = option_rx_unthrottle,
336         .ioctl             = option_ioctl,
337         .set_termios       = option_set_termios,
338         .break_ctl         = option_break_ctl,
339         .tiocmget          = option_tiocmget,
340         .tiocmset          = option_tiocmset,
341         .attach            = option_startup,
342         .shutdown          = option_shutdown,
343         .read_int_callback = option_instat_callback,
344 };
345
346 #ifdef CONFIG_USB_DEBUG
347 static int debug;
348 #else
349 #define debug 0
350 #endif
351
352 /* per port private data */
353
354 #define N_IN_URB 4
355 #define N_OUT_URB 1
356 #define IN_BUFLEN 4096
357 #define OUT_BUFLEN 128
358
359 struct option_port_private {
360         /* Input endpoints and buffer for this port */
361         struct urb *in_urbs[N_IN_URB];
362         u8 *in_buffer[N_IN_URB];
363         /* Output endpoints and buffer for this port */
364         struct urb *out_urbs[N_OUT_URB];
365         u8 *out_buffer[N_OUT_URB];
366         unsigned long out_busy;         /* Bit vector of URBs in use */
367
368         /* Settings for the port */
369         int rts_state;  /* Handshaking pins (outputs) */
370         int dtr_state;
371         int cts_state;  /* Handshaking pins (inputs) */
372         int dsr_state;
373         int dcd_state;
374         int ri_state;
375
376         unsigned long tx_start_time[N_OUT_URB];
377 };
378
379 /* Functions used by new usb-serial code. */
380 static int __init option_init(void)
381 {
382         int retval;
383         retval = usb_serial_register(&option_1port_device);
384         if (retval)
385                 goto failed_1port_device_register;
386         retval = usb_register(&option_driver);
387         if (retval)
388                 goto failed_driver_register;
389
390         info(DRIVER_DESC ": " DRIVER_VERSION);
391
392         return 0;
393
394 failed_driver_register:
395         usb_serial_deregister (&option_1port_device);
396 failed_1port_device_register:
397         return retval;
398 }
399
400 static void __exit option_exit(void)
401 {
402         usb_deregister (&option_driver);
403         usb_serial_deregister (&option_1port_device);
404 }
405
406 module_init(option_init);
407 module_exit(option_exit);
408
409 static void option_rx_throttle(struct usb_serial_port *port)
410 {
411         dbg("%s", __func__);
412 }
413
414 static void option_rx_unthrottle(struct usb_serial_port *port)
415 {
416         dbg("%s", __func__);
417 }
418
419 static void option_break_ctl(struct usb_serial_port *port, int break_state)
420 {
421         /* Unfortunately, I don't know how to send a break */
422         dbg("%s", __func__);
423 }
424
425 static void option_set_termios(struct usb_serial_port *port,
426                         struct ktermios *old_termios)
427 {
428         dbg("%s", __func__);
429         /* Doesn't support option setting */
430         tty_termios_copy_hw(port->tty->termios, old_termios);
431         option_send_setup(port);
432 }
433
434 static int option_tiocmget(struct usb_serial_port *port, struct file *file)
435 {
436         unsigned int value;
437         struct option_port_private *portdata;
438
439         portdata = usb_get_serial_port_data(port);
440
441         value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
442                 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
443                 ((portdata->cts_state) ? TIOCM_CTS : 0) |
444                 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
445                 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
446                 ((portdata->ri_state) ? TIOCM_RNG : 0);
447
448         return value;
449 }
450
451 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
452                         unsigned int set, unsigned int clear)
453 {
454         struct option_port_private *portdata;
455
456         portdata = usb_get_serial_port_data(port);
457
458         /* FIXME: what locks portdata fields ? */
459         if (set & TIOCM_RTS)
460                 portdata->rts_state = 1;
461         if (set & TIOCM_DTR)
462                 portdata->dtr_state = 1;
463
464         if (clear & TIOCM_RTS)
465                 portdata->rts_state = 0;
466         if (clear & TIOCM_DTR)
467                 portdata->dtr_state = 0;
468         return option_send_setup(port);
469 }
470
471 static int option_ioctl(struct usb_serial_port *port, struct file *file,
472                         unsigned int cmd, unsigned long arg)
473 {
474         return -ENOIOCTLCMD;
475 }
476
477 /* Write */
478 static int option_write(struct usb_serial_port *port,
479                         const unsigned char *buf, int count)
480 {
481         struct option_port_private *portdata;
482         int i;
483         int left, todo;
484         struct urb *this_urb = NULL; /* spurious */
485         int err;
486
487         portdata = usb_get_serial_port_data(port);
488
489         dbg("%s: write (%d chars)", __func__, count);
490
491         i = 0;
492         left = count;
493         for (i=0; left > 0 && i < N_OUT_URB; i++) {
494                 todo = left;
495                 if (todo > OUT_BUFLEN)
496                         todo = OUT_BUFLEN;
497
498                 this_urb = portdata->out_urbs[i];
499                 if (test_and_set_bit(i, &portdata->out_busy)) {
500                         if (time_before(jiffies,
501                                         portdata->tx_start_time[i] + 10 * HZ))
502                                 continue;
503                         usb_unlink_urb(this_urb);
504                         continue;
505                 }
506                 if (this_urb->status != 0)
507                         dbg("usb_write %p failed (err=%d)",
508                                 this_urb, this_urb->status);
509
510                 dbg("%s: endpoint %d buf %d", __func__,
511                         usb_pipeendpoint(this_urb->pipe), i);
512
513                 /* send the data */
514                 memcpy (this_urb->transfer_buffer, buf, todo);
515                 this_urb->transfer_buffer_length = todo;
516
517                 this_urb->dev = port->serial->dev;
518                 err = usb_submit_urb(this_urb, GFP_ATOMIC);
519                 if (err) {
520                         dbg("usb_submit_urb %p (write bulk) failed "
521                                 "(%d, has %d)", this_urb,
522                                 err, this_urb->status);
523                         clear_bit(i, &portdata->out_busy);
524                         continue;
525                 }
526                 portdata->tx_start_time[i] = jiffies;
527                 buf += todo;
528                 left -= todo;
529         }
530
531         count -= left;
532         dbg("%s: wrote (did %d)", __func__, count);
533         return count;
534 }
535
536 static void option_indat_callback(struct urb *urb)
537 {
538         int err;
539         int endpoint;
540         struct usb_serial_port *port;
541         struct tty_struct *tty;
542         unsigned char *data = urb->transfer_buffer;
543         int status = urb->status;
544
545         dbg("%s: %p", __func__, urb);
546
547         endpoint = usb_pipeendpoint(urb->pipe);
548         port =  urb->context;
549
550         if (status) {
551                 dbg("%s: nonzero status: %d on endpoint %02x.",
552                     __func__, status, endpoint);
553         } else {
554                 tty = port->tty;
555                 if (urb->actual_length) {
556                         tty_buffer_request_room(tty, urb->actual_length);
557                         tty_insert_flip_string(tty, data, urb->actual_length);
558                         tty_flip_buffer_push(tty);
559                 } else {
560                         dbg("%s: empty read urb received", __func__);
561                 }
562
563                 /* Resubmit urb so we continue receiving */
564                 if (port->open_count && status != -ESHUTDOWN) {
565                         err = usb_submit_urb(urb, GFP_ATOMIC);
566                         if (err)
567                                 printk(KERN_ERR "%s: resubmit read urb failed. "
568                                         "(%d)", __func__, err);
569                 }
570         }
571         return;
572 }
573
574 static void option_outdat_callback(struct urb *urb)
575 {
576         struct usb_serial_port *port;
577         struct option_port_private *portdata;
578         int i;
579
580         dbg("%s", __func__);
581
582         port =  urb->context;
583
584         usb_serial_port_softint(port);
585
586         portdata = usb_get_serial_port_data(port);
587         for (i = 0; i < N_OUT_URB; ++i) {
588                 if (portdata->out_urbs[i] == urb) {
589                         smp_mb__before_clear_bit();
590                         clear_bit(i, &portdata->out_busy);
591                         break;
592                 }
593         }
594 }
595
596 static void option_instat_callback(struct urb *urb)
597 {
598         int err;
599         int status = urb->status;
600         struct usb_serial_port *port =  urb->context;
601         struct option_port_private *portdata = usb_get_serial_port_data(port);
602         struct usb_serial *serial = port->serial;
603
604         dbg("%s", __func__);
605         dbg("%s: urb %p port %p has data %p", __func__,urb,port,portdata);
606
607         if (status == 0) {
608                 struct usb_ctrlrequest *req_pkt =
609                                 (struct usb_ctrlrequest *)urb->transfer_buffer;
610
611                 if (!req_pkt) {
612                         dbg("%s: NULL req_pkt\n", __func__);
613                         return;
614                 }
615                 if ((req_pkt->bRequestType == 0xA1) &&
616                                 (req_pkt->bRequest == 0x20)) {
617                         int old_dcd_state;
618                         unsigned char signals = *((unsigned char *)
619                                         urb->transfer_buffer +
620                                         sizeof(struct usb_ctrlrequest));
621
622                         dbg("%s: signal x%x", __func__, signals);
623
624                         old_dcd_state = portdata->dcd_state;
625                         portdata->cts_state = 1;
626                         portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
627                         portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
628                         portdata->ri_state = ((signals & 0x08) ? 1 : 0);
629
630                         if (port->tty && !C_CLOCAL(port->tty) &&
631                                         old_dcd_state && !portdata->dcd_state)
632                                 tty_hangup(port->tty);
633                 } else {
634                         dbg("%s: type %x req %x", __func__,
635                                 req_pkt->bRequestType,req_pkt->bRequest);
636                 }
637         } else
638                 dbg("%s: error %d", __func__, status);
639
640         /* Resubmit urb so we continue receiving IRQ data */
641         if (status != -ESHUTDOWN) {
642                 urb->dev = serial->dev;
643                 err = usb_submit_urb(urb, GFP_ATOMIC);
644                 if (err)
645                         dbg("%s: resubmit intr urb failed. (%d)",
646                                 __func__, err);
647         }
648 }
649
650 static int option_write_room(struct usb_serial_port *port)
651 {
652         struct option_port_private *portdata;
653         int i;
654         int data_len = 0;
655         struct urb *this_urb;
656
657         portdata = usb_get_serial_port_data(port);
658
659
660         for (i=0; i < N_OUT_URB; i++) {
661                 this_urb = portdata->out_urbs[i];
662                 if (this_urb && !test_bit(i, &portdata->out_busy))
663                         data_len += OUT_BUFLEN;
664         }
665
666         dbg("%s: %d", __func__, data_len);
667         return data_len;
668 }
669
670 static int option_chars_in_buffer(struct usb_serial_port *port)
671 {
672         struct option_port_private *portdata;
673         int i;
674         int data_len = 0;
675         struct urb *this_urb;
676
677         portdata = usb_get_serial_port_data(port);
678
679         for (i=0; i < N_OUT_URB; i++) {
680                 this_urb = portdata->out_urbs[i];
681                 /* FIXME: This locking is insufficient as this_urb may
682                    go unused during the test */
683                 if (this_urb && test_bit(i, &portdata->out_busy))
684                         data_len += this_urb->transfer_buffer_length;
685         }
686         dbg("%s: %d", __func__, data_len);
687         return data_len;
688 }
689
690 static int option_open(struct usb_serial_port *port, struct file *filp)
691 {
692         struct option_port_private *portdata;
693         struct usb_serial *serial = port->serial;
694         int i, err;
695         struct urb *urb;
696
697         portdata = usb_get_serial_port_data(port);
698
699         dbg("%s", __func__);
700
701         /* Set some sane defaults */
702         portdata->rts_state = 1;
703         portdata->dtr_state = 1;
704
705         /* Reset low level data toggle and start reading from endpoints */
706         for (i = 0; i < N_IN_URB; i++) {
707                 urb = portdata->in_urbs[i];
708                 if (! urb)
709                         continue;
710                 if (urb->dev != serial->dev) {
711                         dbg("%s: dev %p != %p", __func__,
712                                 urb->dev, serial->dev);
713                         continue;
714                 }
715
716                 /*
717                  * make sure endpoint data toggle is synchronized with the
718                  * device
719                  */
720                 usb_clear_halt(urb->dev, urb->pipe);
721
722                 err = usb_submit_urb(urb, GFP_KERNEL);
723                 if (err) {
724                         dbg("%s: submit urb %d failed (%d) %d",
725                                 __func__, i, err,
726                                 urb->transfer_buffer_length);
727                 }
728         }
729
730         /* Reset low level data toggle on out endpoints */
731         for (i = 0; i < N_OUT_URB; i++) {
732                 urb = portdata->out_urbs[i];
733                 if (! urb)
734                         continue;
735                 urb->dev = serial->dev;
736                 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
737                                 usb_pipeout(urb->pipe), 0); */
738         }
739
740         port->tty->low_latency = 1;
741
742         option_send_setup(port);
743
744         return (0);
745 }
746
747 static void option_close(struct usb_serial_port *port, struct file *filp)
748 {
749         int i;
750         struct usb_serial *serial = port->serial;
751         struct option_port_private *portdata;
752
753         dbg("%s", __func__);
754         portdata = usb_get_serial_port_data(port);
755
756         portdata->rts_state = 0;
757         portdata->dtr_state = 0;
758
759         if (serial->dev) {
760                 mutex_lock(&serial->disc_mutex);
761                 if (!serial->disconnected)
762                         option_send_setup(port);
763                 mutex_unlock(&serial->disc_mutex);
764
765                 /* Stop reading/writing urbs */
766                 for (i = 0; i < N_IN_URB; i++)
767                         usb_kill_urb(portdata->in_urbs[i]);
768                 for (i = 0; i < N_OUT_URB; i++)
769                         usb_kill_urb(portdata->out_urbs[i]);
770         }
771         port->tty = NULL;
772 }
773
774 /* Helper functions used by option_setup_urbs */
775 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
776                 int dir, void *ctx, char *buf, int len,
777                 void (*callback)(struct urb *))
778 {
779         struct urb *urb;
780
781         if (endpoint == -1)
782                 return NULL;            /* endpoint not needed */
783
784         urb = usb_alloc_urb(0, GFP_KERNEL);             /* No ISO */
785         if (urb == NULL) {
786                 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
787                 return NULL;
788         }
789
790                 /* Fill URB using supplied data. */
791         usb_fill_bulk_urb(urb, serial->dev,
792                       usb_sndbulkpipe(serial->dev, endpoint) | dir,
793                       buf, len, callback, ctx);
794
795         return urb;
796 }
797
798 /* Setup urbs */
799 static void option_setup_urbs(struct usb_serial *serial)
800 {
801         int i,j;
802         struct usb_serial_port *port;
803         struct option_port_private *portdata;
804
805         dbg("%s", __func__);
806
807         for (i = 0; i < serial->num_ports; i++) {
808                 port = serial->port[i];
809                 portdata = usb_get_serial_port_data(port);
810
811         /* Do indat endpoints first */
812                 for (j = 0; j < N_IN_URB; ++j) {
813                         portdata->in_urbs[j] = option_setup_urb (serial,
814                         port->bulk_in_endpointAddress, USB_DIR_IN, port,
815                         portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
816                 }
817
818                 /* outdat endpoints */
819                 for (j = 0; j < N_OUT_URB; ++j) {
820                         portdata->out_urbs[j] = option_setup_urb (serial,
821                         port->bulk_out_endpointAddress, USB_DIR_OUT, port,
822                         portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
823                 }
824         }
825 }
826
827
828 /** send RTS/DTR state to the port.
829  *
830  * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
831  * CDC.
832 */
833 static int option_send_setup(struct usb_serial_port *port)
834 {
835         struct usb_serial *serial = port->serial;
836         struct option_port_private *portdata;
837         int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
838         dbg("%s", __func__);
839
840         portdata = usb_get_serial_port_data(port);
841
842         if (port->tty) {
843                 int val = 0;
844                 if (portdata->dtr_state)
845                         val |= 0x01;
846                 if (portdata->rts_state)
847                         val |= 0x02;
848
849                 return usb_control_msg(serial->dev,
850                                 usb_rcvctrlpipe(serial->dev, 0),
851                                 0x22,0x21,val,ifNum,NULL,0,USB_CTRL_SET_TIMEOUT);
852         }
853
854         return 0;
855 }
856
857 static int option_startup(struct usb_serial *serial)
858 {
859         int i, j, err;
860         struct usb_serial_port *port;
861         struct option_port_private *portdata;
862         u8 *buffer;
863
864         dbg("%s", __func__);
865
866         /* Now setup per port private data */
867         for (i = 0; i < serial->num_ports; i++) {
868                 port = serial->port[i];
869                 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
870                 if (!portdata) {
871                         dbg("%s: kmalloc for option_port_private (%d) failed!.",
872                                         __func__, i);
873                         return (1);
874                 }
875
876                 for (j = 0; j < N_IN_URB; j++) {
877                         buffer = (u8 *)__get_free_page(GFP_KERNEL);
878                         if (!buffer)
879                                 goto bail_out_error;
880                         portdata->in_buffer[j] = buffer;
881                 }
882
883                 for (j = 0; j < N_OUT_URB; j++) {
884                         buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
885                         if (!buffer)
886                                 goto bail_out_error2;
887                         portdata->out_buffer[j] = buffer;
888                 }
889
890                 usb_set_serial_port_data(port, portdata);
891
892                 if (! port->interrupt_in_urb)
893                         continue;
894                 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
895                 if (err)
896                         dbg("%s: submit irq_in urb failed %d",
897                                 __func__, err);
898         }
899
900         option_setup_urbs(serial);
901
902         return (0);
903
904 bail_out_error2:
905         for (j = 0; j < N_OUT_URB; j++)
906                 kfree(portdata->out_buffer[j]);
907 bail_out_error:
908         for (j = 0; j < N_IN_URB; j++)
909                 if (portdata->in_buffer[j])
910                         free_page((unsigned long)portdata->in_buffer[j]);
911         kfree(portdata);
912         return 1;
913 }
914
915 static void option_shutdown(struct usb_serial *serial)
916 {
917         int i, j;
918         struct usb_serial_port *port;
919         struct option_port_private *portdata;
920
921         dbg("%s", __func__);
922
923         /* Stop reading/writing urbs */
924         for (i = 0; i < serial->num_ports; ++i) {
925                 port = serial->port[i];
926                 portdata = usb_get_serial_port_data(port);
927                 for (j = 0; j < N_IN_URB; j++)
928                         usb_kill_urb(portdata->in_urbs[j]);
929                 for (j = 0; j < N_OUT_URB; j++)
930                         usb_kill_urb(portdata->out_urbs[j]);
931         }
932
933         /* Now free them */
934         for (i = 0; i < serial->num_ports; ++i) {
935                 port = serial->port[i];
936                 portdata = usb_get_serial_port_data(port);
937
938                 for (j = 0; j < N_IN_URB; j++) {
939                         if (portdata->in_urbs[j]) {
940                                 usb_free_urb(portdata->in_urbs[j]);
941                                 free_page((unsigned long)portdata->in_buffer[j]);
942                                 portdata->in_urbs[j] = NULL;
943                         }
944                 }
945                 for (j = 0; j < N_OUT_URB; j++) {
946                         if (portdata->out_urbs[j]) {
947                                 usb_free_urb(portdata->out_urbs[j]);
948                                 kfree(portdata->out_buffer[j]);
949                                 portdata->out_urbs[j] = NULL;
950                         }
951                 }
952         }
953
954         /* Now free per port private data */
955         for (i = 0; i < serial->num_ports; i++) {
956                 port = serial->port[i];
957                 kfree(usb_get_serial_port_data(port));
958         }
959 }
960
961 MODULE_AUTHOR(DRIVER_AUTHOR);
962 MODULE_DESCRIPTION(DRIVER_DESC);
963 MODULE_VERSION(DRIVER_VERSION);
964 MODULE_LICENSE("GPL");
965
966 #ifdef CONFIG_USB_DEBUG
967 module_param(debug, bool, S_IRUGO | S_IWUSR);
968 MODULE_PARM_DESC(debug, "Debug messages");
969 #endif
970