tty-usb-option: Coding style
[linux-2.6/mini2440.git] / drivers / usb / serial / option.c
blobe4eca95f2b0f7aa984cc8194ad0f4c755a908116
1 /*
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
28 device features.
31 #define DRIVER_VERSION "v0.7.2"
32 #define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
33 #define DRIVER_DESC "USB Driver for GSM modems"
35 #include <linux/kernel.h>
36 #include <linux/jiffies.h>
37 #include <linux/errno.h>
38 #include <linux/tty.h>
39 #include <linux/tty_flip.h>
40 #include <linux/module.h>
41 #include <linux/bitops.h>
42 #include <linux/usb.h>
43 #include <linux/usb/serial.h>
45 /* Function prototypes */
46 static int option_open(struct tty_struct *tty, struct usb_serial_port *port,
47 struct file *filp);
48 static void option_close(struct tty_struct *tty, struct usb_serial_port *port,
49 struct file *filp);
50 static int option_startup(struct usb_serial *serial);
51 static void option_shutdown(struct usb_serial *serial);
52 static int option_write_room(struct tty_struct *tty);
54 static void option_instat_callback(struct urb *urb);
56 static int option_write(struct tty_struct *tty, struct usb_serial_port *port,
57 const unsigned char *buf, int count);
58 static int option_chars_in_buffer(struct tty_struct *tty);
59 static void option_set_termios(struct tty_struct *tty,
60 struct usb_serial_port *port, struct ktermios *old);
61 static int option_tiocmget(struct tty_struct *tty, struct file *file);
62 static int option_tiocmset(struct tty_struct *tty, struct file *file,
63 unsigned int set, unsigned int clear);
64 static int option_send_setup(struct tty_struct *tty, struct usb_serial_port *port);
66 /* Vendor and product IDs */
67 #define OPTION_VENDOR_ID 0x0AF0
68 #define OPTION_PRODUCT_COLT 0x5000
69 #define OPTION_PRODUCT_RICOLA 0x6000
70 #define OPTION_PRODUCT_RICOLA_LIGHT 0x6100
71 #define OPTION_PRODUCT_RICOLA_QUAD 0x6200
72 #define OPTION_PRODUCT_RICOLA_QUAD_LIGHT 0x6300
73 #define OPTION_PRODUCT_RICOLA_NDIS 0x6050
74 #define OPTION_PRODUCT_RICOLA_NDIS_LIGHT 0x6150
75 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD 0x6250
76 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT 0x6350
77 #define OPTION_PRODUCT_COBRA 0x6500
78 #define OPTION_PRODUCT_COBRA_BUS 0x6501
79 #define OPTION_PRODUCT_VIPER 0x6600
80 #define OPTION_PRODUCT_VIPER_BUS 0x6601
81 #define OPTION_PRODUCT_GT_MAX_READY 0x6701
82 #define OPTION_PRODUCT_GT_MAX 0x6711
83 #define OPTION_PRODUCT_FUJI_MODEM_LIGHT 0x6721
84 #define OPTION_PRODUCT_FUJI_MODEM_GT 0x6741
85 #define OPTION_PRODUCT_FUJI_MODEM_EX 0x6761
86 #define OPTION_PRODUCT_FUJI_NETWORK_LIGHT 0x6731
87 #define OPTION_PRODUCT_FUJI_NETWORK_GT 0x6751
88 #define OPTION_PRODUCT_FUJI_NETWORK_EX 0x6771
89 #define OPTION_PRODUCT_KOI_MODEM 0x6800
90 #define OPTION_PRODUCT_KOI_NETWORK 0x6811
91 #define OPTION_PRODUCT_SCORPION_MODEM 0x6901
92 #define OPTION_PRODUCT_SCORPION_NETWORK 0x6911
93 #define OPTION_PRODUCT_ETNA_MODEM 0x7001
94 #define OPTION_PRODUCT_ETNA_NETWORK 0x7011
95 #define OPTION_PRODUCT_ETNA_MODEM_LITE 0x7021
96 #define OPTION_PRODUCT_ETNA_MODEM_GT 0x7041
97 #define OPTION_PRODUCT_ETNA_MODEM_EX 0x7061
98 #define OPTION_PRODUCT_ETNA_NETWORK_LITE 0x7031
99 #define OPTION_PRODUCT_ETNA_NETWORK_GT 0x7051
100 #define OPTION_PRODUCT_ETNA_NETWORK_EX 0x7071
101 #define OPTION_PRODUCT_ETNA_KOI_MODEM 0x7100
102 #define OPTION_PRODUCT_ETNA_KOI_NETWORK 0x7111
104 #define HUAWEI_VENDOR_ID 0x12D1
105 #define HUAWEI_PRODUCT_E600 0x1001
106 #define HUAWEI_PRODUCT_E220 0x1003
107 #define HUAWEI_PRODUCT_E220BIS 0x1004
108 #define HUAWEI_PRODUCT_E1401 0x1401
109 #define HUAWEI_PRODUCT_E1403 0x1403
110 #define HUAWEI_PRODUCT_E1405 0x1405
111 #define HUAWEI_PRODUCT_E1406 0x1406
112 #define HUAWEI_PRODUCT_E1408 0x1408
113 #define HUAWEI_PRODUCT_E1409 0x1409
114 #define HUAWEI_PRODUCT_E1410 0x1410
115 #define HUAWEI_PRODUCT_E1411 0x1411
116 #define HUAWEI_PRODUCT_E1412 0x1412
117 #define HUAWEI_PRODUCT_E1413 0x1413
118 #define HUAWEI_PRODUCT_E1414 0x1414
119 #define HUAWEI_PRODUCT_E1415 0x1415
120 #define HUAWEI_PRODUCT_E1416 0x1416
121 #define HUAWEI_PRODUCT_E1417 0x1417
122 #define HUAWEI_PRODUCT_E1418 0x1418
123 #define HUAWEI_PRODUCT_E1419 0x1419
125 #define NOVATELWIRELESS_VENDOR_ID 0x1410
127 /* MERLIN EVDO PRODUCTS */
128 #define NOVATELWIRELESS_PRODUCT_V640 0x1100
129 #define NOVATELWIRELESS_PRODUCT_V620 0x1110
130 #define NOVATELWIRELESS_PRODUCT_V740 0x1120
131 #define NOVATELWIRELESS_PRODUCT_V720 0x1130
133 /* MERLIN HSDPA/HSPA PRODUCTS */
134 #define NOVATELWIRELESS_PRODUCT_U730 0x1400
135 #define NOVATELWIRELESS_PRODUCT_U740 0x1410
136 #define NOVATELWIRELESS_PRODUCT_U870 0x1420
137 #define NOVATELWIRELESS_PRODUCT_XU870 0x1430
138 #define NOVATELWIRELESS_PRODUCT_X950D 0x1450
140 /* EXPEDITE PRODUCTS */
141 #define NOVATELWIRELESS_PRODUCT_EV620 0x2100
142 #define NOVATELWIRELESS_PRODUCT_ES720 0x2110
143 #define NOVATELWIRELESS_PRODUCT_E725 0x2120
144 #define NOVATELWIRELESS_PRODUCT_ES620 0x2130
145 #define NOVATELWIRELESS_PRODUCT_EU730 0x2400
146 #define NOVATELWIRELESS_PRODUCT_EU740 0x2410
147 #define NOVATELWIRELESS_PRODUCT_EU870D 0x2420
149 /* OVATION PRODUCTS */
150 #define NOVATELWIRELESS_PRODUCT_MC727 0x4100
151 #define NOVATELWIRELESS_PRODUCT_MC950D 0x4400
153 /* FUTURE NOVATEL PRODUCTS */
154 #define NOVATELWIRELESS_PRODUCT_EVDO_1 0x6000
155 #define NOVATELWIRELESS_PRODUCT_HSPA_1 0x7000
156 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_1 0x8000
157 #define NOVATELWIRELESS_PRODUCT_GLOBAL_1 0x9000
158 #define NOVATELWIRELESS_PRODUCT_EVDO_2 0x6001
159 #define NOVATELWIRELESS_PRODUCT_HSPA_2 0x7001
160 #define NOVATELWIRELESS_PRODUCT_EMBEDDED_2 0x8001
161 #define NOVATELWIRELESS_PRODUCT_GLOBAL_2 0x9001
163 /* AMOI PRODUCTS */
164 #define AMOI_VENDOR_ID 0x1614
165 #define AMOI_PRODUCT_H01 0x0800
166 #define AMOI_PRODUCT_H01A 0x7002
167 #define AMOI_PRODUCT_H02 0x0802
169 #define DELL_VENDOR_ID 0x413C
171 #define KYOCERA_VENDOR_ID 0x0c88
172 #define KYOCERA_PRODUCT_KPC650 0x17da
173 #define KYOCERA_PRODUCT_KPC680 0x180a
175 #define ANYDATA_VENDOR_ID 0x16d5
176 #define ANYDATA_PRODUCT_ADU_E100A 0x6501
177 #define ANYDATA_PRODUCT_ADU_500A 0x6502
179 #define AXESSTEL_VENDOR_ID 0x1726
180 #define AXESSTEL_PRODUCT_MV110H 0x1000
182 #define ONDA_VENDOR_ID 0x19d2
183 #define ONDA_PRODUCT_MSA501HS 0x0001
184 #define ONDA_PRODUCT_ET502HS 0x0002
186 #define BANDRICH_VENDOR_ID 0x1A8D
187 #define BANDRICH_PRODUCT_C100_1 0x1002
188 #define BANDRICH_PRODUCT_C100_2 0x1003
190 #define AMOI_VENDOR_ID 0x1614
191 #define AMOI_PRODUCT_9508 0x0800
193 #define QUALCOMM_VENDOR_ID 0x05C6
195 #define MAXON_VENDOR_ID 0x16d8
197 #define TELIT_VENDOR_ID 0x1bc7
198 #define TELIT_PRODUCT_UC864E 0x1003
200 static struct usb_device_id option_ids[] = {
201 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
202 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
203 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
204 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
205 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
206 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
207 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
208 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
209 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
210 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
211 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
212 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
213 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
214 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
215 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
216 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
217 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
218 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
219 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
220 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
221 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
222 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
223 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
224 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
225 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
226 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
227 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
228 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
229 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
230 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
231 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
232 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
233 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
234 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
235 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
236 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600, 0xff, 0xff, 0xff) },
237 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220, 0xff, 0xff, 0xff) },
238 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220BIS, 0xff, 0xff, 0xff) },
239 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1401, 0xff, 0xff, 0xff) },
240 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1403, 0xff, 0xff, 0xff) },
241 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1405, 0xff, 0xff, 0xff) },
242 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1406, 0xff, 0xff, 0xff) },
243 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1408, 0xff, 0xff, 0xff) },
244 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1409, 0xff, 0xff, 0xff) },
245 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1410, 0xff, 0xff, 0xff) },
246 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1411, 0xff, 0xff, 0xff) },
247 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1412, 0xff, 0xff, 0xff) },
248 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1413, 0xff, 0xff, 0xff) },
249 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1414, 0xff, 0xff, 0xff) },
250 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1415, 0xff, 0xff, 0xff) },
251 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1416, 0xff, 0xff, 0xff) },
252 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1417, 0xff, 0xff, 0xff) },
253 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1418, 0xff, 0xff, 0xff) },
254 { USB_DEVICE_AND_INTERFACE_INFO(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E1419, 0xff, 0xff, 0xff) },
255 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_9508) },
256 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V640) }, /* Novatel Merlin V640/XV620 */
257 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V620) }, /* Novatel Merlin V620/S620 */
258 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V740) }, /* Novatel Merlin EX720/V740/X720 */
259 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_V720) }, /* Novatel Merlin V720/S720/PC720 */
260 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U730) }, /* Novatel U730/U740 (VF version) */
261 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U740) }, /* Novatel U740 */
262 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_U870) }, /* Novatel U870 */
263 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_XU870) }, /* Novatel Merlin XU870 HSDPA/3G */
264 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_X950D) }, /* Novatel X950D */
265 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EV620) }, /* Novatel EV620/ES620 CDMA/EV-DO */
266 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES720) }, /* Novatel ES620/ES720/U720/USB720 */
267 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_E725) }, /* Novatel E725/E726 */
268 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_ES620) }, /* Novatel Merlin ES620 SM Bus */
269 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU730) }, /* Novatel EU730 and Vodafone EU740 */
270 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU740) }, /* Novatel non-Vodafone EU740 */
271 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EU870D) }, /* Novatel EU850D/EU860D/EU870D */
272 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC950D) }, /* Novatel MC930D/MC950D */
273 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_MC727) }, /* Novatel MC727/U727/USB727 */
274 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_1) }, /* Novatel EVDO product */
275 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_1) }, /* Novatel HSPA product */
276 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_1) }, /* Novatel Embedded product */
277 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_1) }, /* Novatel Global product */
278 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EVDO_2) }, /* Novatel EVDO product */
279 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_HSPA_2) }, /* Novatel HSPA product */
280 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_EMBEDDED_2) }, /* Novatel Embedded product */
281 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, NOVATELWIRELESS_PRODUCT_GLOBAL_2) }, /* Novatel Global product */
283 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01) },
284 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H01A) },
285 { USB_DEVICE(AMOI_VENDOR_ID, AMOI_PRODUCT_H02) },
287 { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
288 { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
289 { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
290 { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
291 { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
292 { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
293 { USB_DEVICE(DELL_VENDOR_ID, 0x8129) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite ET620 CDMA/EV-DO */
294 { USB_DEVICE(DELL_VENDOR_ID, 0x8133) }, /* Dell Wireless 5720 == Novatel EV620 CDMA/EV-DO */
295 { USB_DEVICE(DELL_VENDOR_ID, 0x8136) }, /* Dell Wireless HSDPA 5520 == Novatel Expedite EU860D */
296 { USB_DEVICE(DELL_VENDOR_ID, 0x8137) }, /* Dell Wireless HSDPA 5520 */
297 { USB_DEVICE(DELL_VENDOR_ID, 0x8138) }, /* Dell Wireless 5520 Voda I Mobile Broadband (3G HSDPA) Minicard */
298 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
299 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
300 { USB_DEVICE(AXESSTEL_VENDOR_ID, AXESSTEL_PRODUCT_MV110H) },
301 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_MSA501HS) },
302 { USB_DEVICE(ONDA_VENDOR_ID, ONDA_PRODUCT_ET502HS) },
303 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
304 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
305 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC650) },
306 { USB_DEVICE(KYOCERA_VENDOR_ID, KYOCERA_PRODUCT_KPC680) },
307 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6000)}, /* ZTE AC8700 */
308 { USB_DEVICE(QUALCOMM_VENDOR_ID, 0x6613)}, /* Onda H600/ZTE MF330 */
309 { USB_DEVICE(MAXON_VENDOR_ID, 0x6280) }, /* BP3-USB & BP3-EXT HSDPA */
310 { USB_DEVICE(TELIT_VENDOR_ID, TELIT_PRODUCT_UC864E) },
311 { } /* Terminating entry */
313 MODULE_DEVICE_TABLE(usb, option_ids);
315 static struct usb_driver option_driver = {
316 .name = "option",
317 .probe = usb_serial_probe,
318 .disconnect = usb_serial_disconnect,
319 .id_table = option_ids,
320 .no_dynamic_id = 1,
323 /* The card has three separate interfaces, which the serial driver
324 * recognizes separately, thus num_port=1.
327 static struct usb_serial_driver option_1port_device = {
328 .driver = {
329 .owner = THIS_MODULE,
330 .name = "option1",
332 .description = "GSM modem (1-port)",
333 .usb_driver = &option_driver,
334 .id_table = option_ids,
335 .num_ports = 1,
336 .open = option_open,
337 .close = option_close,
338 .write = option_write,
339 .write_room = option_write_room,
340 .chars_in_buffer = option_chars_in_buffer,
341 .set_termios = option_set_termios,
342 .tiocmget = option_tiocmget,
343 .tiocmset = option_tiocmset,
344 .attach = option_startup,
345 .shutdown = option_shutdown,
346 .read_int_callback = option_instat_callback,
349 #ifdef CONFIG_USB_DEBUG
350 static int debug;
351 #else
352 #define debug 0
353 #endif
355 /* per port private data */
357 #define N_IN_URB 4
358 #define N_OUT_URB 1
359 #define IN_BUFLEN 4096
360 #define OUT_BUFLEN 128
362 struct option_port_private {
363 /* Input endpoints and buffer for this port */
364 struct urb *in_urbs[N_IN_URB];
365 u8 *in_buffer[N_IN_URB];
366 /* Output endpoints and buffer for this port */
367 struct urb *out_urbs[N_OUT_URB];
368 u8 *out_buffer[N_OUT_URB];
369 unsigned long out_busy; /* Bit vector of URBs in use */
371 /* Settings for the port */
372 int rts_state; /* Handshaking pins (outputs) */
373 int dtr_state;
374 int cts_state; /* Handshaking pins (inputs) */
375 int dsr_state;
376 int dcd_state;
377 int ri_state;
379 unsigned long tx_start_time[N_OUT_URB];
382 /* Functions used by new usb-serial code. */
383 static int __init option_init(void)
385 int retval;
386 retval = usb_serial_register(&option_1port_device);
387 if (retval)
388 goto failed_1port_device_register;
389 retval = usb_register(&option_driver);
390 if (retval)
391 goto failed_driver_register;
393 info(DRIVER_DESC ": " DRIVER_VERSION);
395 return 0;
397 failed_driver_register:
398 usb_serial_deregister(&option_1port_device);
399 failed_1port_device_register:
400 return retval;
403 static void __exit option_exit(void)
405 usb_deregister(&option_driver);
406 usb_serial_deregister(&option_1port_device);
409 module_init(option_init);
410 module_exit(option_exit);
412 static void option_set_termios(struct tty_struct *tty,
413 struct usb_serial_port *port, struct ktermios *old_termios)
415 dbg("%s", __func__);
416 /* Doesn't support option setting */
417 tty_termios_copy_hw(tty->termios, old_termios);
418 option_send_setup(tty, port);
421 static int option_tiocmget(struct tty_struct *tty, struct file *file)
423 struct usb_serial_port *port = tty->driver_data;
424 unsigned int value;
425 struct option_port_private *portdata;
427 portdata = usb_get_serial_port_data(port);
429 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
430 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
431 ((portdata->cts_state) ? TIOCM_CTS : 0) |
432 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
433 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
434 ((portdata->ri_state) ? TIOCM_RNG : 0);
436 return value;
439 static int option_tiocmset(struct tty_struct *tty, struct file *file,
440 unsigned int set, unsigned int clear)
442 struct usb_serial_port *port = tty->driver_data;
443 struct option_port_private *portdata;
445 portdata = usb_get_serial_port_data(port);
447 /* FIXME: what locks portdata fields ? */
448 if (set & TIOCM_RTS)
449 portdata->rts_state = 1;
450 if (set & TIOCM_DTR)
451 portdata->dtr_state = 1;
453 if (clear & TIOCM_RTS)
454 portdata->rts_state = 0;
455 if (clear & TIOCM_DTR)
456 portdata->dtr_state = 0;
457 return option_send_setup(tty, port);
460 /* Write */
461 static int option_write(struct tty_struct *tty, struct usb_serial_port *port,
462 const unsigned char *buf, int count)
464 struct option_port_private *portdata;
465 int i;
466 int left, todo;
467 struct urb *this_urb = NULL; /* spurious */
468 int err;
470 portdata = usb_get_serial_port_data(port);
472 dbg("%s: write (%d chars)", __func__, count);
474 i = 0;
475 left = count;
476 for (i = 0; left > 0 && i < N_OUT_URB; i++) {
477 todo = left;
478 if (todo > OUT_BUFLEN)
479 todo = OUT_BUFLEN;
481 this_urb = portdata->out_urbs[i];
482 if (test_and_set_bit(i, &portdata->out_busy)) {
483 if (time_before(jiffies,
484 portdata->tx_start_time[i] + 10 * HZ))
485 continue;
486 usb_unlink_urb(this_urb);
487 continue;
489 if (this_urb->status != 0)
490 dbg("usb_write %p failed (err=%d)",
491 this_urb, this_urb->status);
493 dbg("%s: endpoint %d buf %d", __func__,
494 usb_pipeendpoint(this_urb->pipe), i);
496 /* send the data */
497 memcpy(this_urb->transfer_buffer, buf, todo);
498 this_urb->transfer_buffer_length = todo;
500 this_urb->dev = port->serial->dev;
501 err = usb_submit_urb(this_urb, GFP_ATOMIC);
502 if (err) {
503 dbg("usb_submit_urb %p (write bulk) failed "
504 "(%d, has %d)", this_urb,
505 err, this_urb->status);
506 clear_bit(i, &portdata->out_busy);
507 continue;
509 portdata->tx_start_time[i] = jiffies;
510 buf += todo;
511 left -= todo;
514 count -= left;
515 dbg("%s: wrote (did %d)", __func__, count);
516 return count;
519 static void option_indat_callback(struct urb *urb)
521 int err;
522 int endpoint;
523 struct usb_serial_port *port;
524 struct tty_struct *tty;
525 unsigned char *data = urb->transfer_buffer;
526 int status = urb->status;
528 dbg("%s: %p", __func__, urb);
530 endpoint = usb_pipeendpoint(urb->pipe);
531 port = urb->context;
533 if (status) {
534 dbg("%s: nonzero status: %d on endpoint %02x.",
535 __func__, status, endpoint);
536 } else {
537 tty = port->port.tty;
538 if (urb->actual_length) {
539 tty_buffer_request_room(tty, urb->actual_length);
540 tty_insert_flip_string(tty, data, urb->actual_length);
541 tty_flip_buffer_push(tty);
542 } else {
543 dbg("%s: empty read urb received", __func__);
546 /* Resubmit urb so we continue receiving */
547 if (port->port.count && status != -ESHUTDOWN) {
548 err = usb_submit_urb(urb, GFP_ATOMIC);
549 if (err)
550 printk(KERN_ERR "%s: resubmit read urb failed. "
551 "(%d)", __func__, err);
554 return;
557 static void option_outdat_callback(struct urb *urb)
559 struct usb_serial_port *port;
560 struct option_port_private *portdata;
561 int i;
563 dbg("%s", __func__);
565 port = urb->context;
567 usb_serial_port_softint(port);
569 portdata = usb_get_serial_port_data(port);
570 for (i = 0; i < N_OUT_URB; ++i) {
571 if (portdata->out_urbs[i] == urb) {
572 smp_mb__before_clear_bit();
573 clear_bit(i, &portdata->out_busy);
574 break;
579 static void option_instat_callback(struct urb *urb)
581 int err;
582 int status = urb->status;
583 struct usb_serial_port *port = urb->context;
584 struct option_port_private *portdata = usb_get_serial_port_data(port);
585 struct usb_serial *serial = port->serial;
587 dbg("%s", __func__);
588 dbg("%s: urb %p port %p has data %p", __func__, urb, port, portdata);
590 if (status == 0) {
591 struct usb_ctrlrequest *req_pkt =
592 (struct usb_ctrlrequest *)urb->transfer_buffer;
594 if (!req_pkt) {
595 dbg("%s: NULL req_pkt\n", __func__);
596 return;
598 if ((req_pkt->bRequestType == 0xA1) &&
599 (req_pkt->bRequest == 0x20)) {
600 int old_dcd_state;
601 unsigned char signals = *((unsigned char *)
602 urb->transfer_buffer +
603 sizeof(struct usb_ctrlrequest));
605 dbg("%s: signal x%x", __func__, signals);
607 old_dcd_state = portdata->dcd_state;
608 portdata->cts_state = 1;
609 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
610 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
611 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
613 if (port->port.tty && !C_CLOCAL(port->port.tty) &&
614 old_dcd_state && !portdata->dcd_state)
615 tty_hangup(port->port.tty);
616 } else {
617 dbg("%s: type %x req %x", __func__,
618 req_pkt->bRequestType, req_pkt->bRequest);
620 } else
621 dbg("%s: error %d", __func__, status);
623 /* Resubmit urb so we continue receiving IRQ data */
624 if (status != -ESHUTDOWN) {
625 urb->dev = serial->dev;
626 err = usb_submit_urb(urb, GFP_ATOMIC);
627 if (err)
628 dbg("%s: resubmit intr urb failed. (%d)",
629 __func__, err);
633 static int option_write_room(struct tty_struct *tty)
635 struct usb_serial_port *port = tty->driver_data;
636 struct option_port_private *portdata;
637 int i;
638 int data_len = 0;
639 struct urb *this_urb;
641 portdata = usb_get_serial_port_data(port);
644 for (i = 0; i < N_OUT_URB; i++) {
645 this_urb = portdata->out_urbs[i];
646 if (this_urb && !test_bit(i, &portdata->out_busy))
647 data_len += OUT_BUFLEN;
650 dbg("%s: %d", __func__, data_len);
651 return data_len;
654 static int option_chars_in_buffer(struct tty_struct *tty)
656 struct usb_serial_port *port = tty->driver_data;
657 struct option_port_private *portdata;
658 int i;
659 int data_len = 0;
660 struct urb *this_urb;
662 portdata = usb_get_serial_port_data(port);
664 for (i = 0; i < N_OUT_URB; i++) {
665 this_urb = portdata->out_urbs[i];
666 /* FIXME: This locking is insufficient as this_urb may
667 go unused during the test */
668 if (this_urb && test_bit(i, &portdata->out_busy))
669 data_len += this_urb->transfer_buffer_length;
671 dbg("%s: %d", __func__, data_len);
672 return data_len;
675 static int option_open(struct tty_struct *tty,
676 struct usb_serial_port *port, struct file *filp)
678 struct option_port_private *portdata;
679 struct usb_serial *serial = port->serial;
680 int i, err;
681 struct urb *urb;
683 portdata = usb_get_serial_port_data(port);
685 dbg("%s", __func__);
687 /* Set some sane defaults */
688 portdata->rts_state = 1;
689 portdata->dtr_state = 1;
691 /* Reset low level data toggle and start reading from endpoints */
692 for (i = 0; i < N_IN_URB; i++) {
693 urb = portdata->in_urbs[i];
694 if (!urb)
695 continue;
696 if (urb->dev != serial->dev) {
697 dbg("%s: dev %p != %p", __func__,
698 urb->dev, serial->dev);
699 continue;
703 * make sure endpoint data toggle is synchronized with the
704 * device
706 usb_clear_halt(urb->dev, urb->pipe);
708 err = usb_submit_urb(urb, GFP_KERNEL);
709 if (err) {
710 dbg("%s: submit urb %d failed (%d) %d",
711 __func__, i, err,
712 urb->transfer_buffer_length);
716 /* Reset low level data toggle on out endpoints */
717 for (i = 0; i < N_OUT_URB; i++) {
718 urb = portdata->out_urbs[i];
719 if (!urb)
720 continue;
721 urb->dev = serial->dev;
722 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
723 usb_pipeout(urb->pipe), 0); */
726 if (tty)
727 tty->low_latency = 1;
729 option_send_setup(tty, port);
731 return 0;
734 static void option_close(struct tty_struct *tty,
735 struct usb_serial_port *port, struct file *filp)
737 int i;
738 struct usb_serial *serial = port->serial;
739 struct option_port_private *portdata;
741 dbg("%s", __func__);
742 portdata = usb_get_serial_port_data(port);
744 portdata->rts_state = 0;
745 portdata->dtr_state = 0;
747 if (serial->dev) {
748 mutex_lock(&serial->disc_mutex);
749 if (!serial->disconnected)
750 option_send_setup(tty, port);
751 mutex_unlock(&serial->disc_mutex);
753 /* Stop reading/writing urbs */
754 for (i = 0; i < N_IN_URB; i++)
755 usb_kill_urb(portdata->in_urbs[i]);
756 for (i = 0; i < N_OUT_URB; i++)
757 usb_kill_urb(portdata->out_urbs[i]);
759 port->port.tty = NULL; /* FIXME */
762 /* Helper functions used by option_setup_urbs */
763 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
764 int dir, void *ctx, char *buf, int len,
765 void (*callback)(struct urb *))
767 struct urb *urb;
769 if (endpoint == -1)
770 return NULL; /* endpoint not needed */
772 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
773 if (urb == NULL) {
774 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
775 return NULL;
778 /* Fill URB using supplied data. */
779 usb_fill_bulk_urb(urb, serial->dev,
780 usb_sndbulkpipe(serial->dev, endpoint) | dir,
781 buf, len, callback, ctx);
783 return urb;
786 /* Setup urbs */
787 static void option_setup_urbs(struct usb_serial *serial)
789 int i, j;
790 struct usb_serial_port *port;
791 struct option_port_private *portdata;
793 dbg("%s", __func__);
795 for (i = 0; i < serial->num_ports; i++) {
796 port = serial->port[i];
797 portdata = usb_get_serial_port_data(port);
799 /* Do indat endpoints first */
800 for (j = 0; j < N_IN_URB; ++j) {
801 portdata->in_urbs[j] = option_setup_urb(serial,
802 port->bulk_in_endpointAddress,
803 USB_DIR_IN, port,
804 portdata->in_buffer[j],
805 IN_BUFLEN, option_indat_callback);
808 /* outdat endpoints */
809 for (j = 0; j < N_OUT_URB; ++j) {
810 portdata->out_urbs[j] = option_setup_urb(serial,
811 port->bulk_out_endpointAddress,
812 USB_DIR_OUT, port,
813 portdata->out_buffer[j],
814 OUT_BUFLEN, option_outdat_callback);
820 /** send RTS/DTR state to the port.
822 * This is exactly the same as SET_CONTROL_LINE_STATE from the PSTN
823 * CDC.
825 static int option_send_setup(struct tty_struct *tty,
826 struct usb_serial_port *port)
828 struct usb_serial *serial = port->serial;
829 struct option_port_private *portdata;
830 int ifNum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
831 dbg("%s", __func__);
833 portdata = usb_get_serial_port_data(port);
835 if (tty) {
836 int val = 0;
837 if (portdata->dtr_state)
838 val |= 0x01;
839 if (portdata->rts_state)
840 val |= 0x02;
842 return usb_control_msg(serial->dev,
843 usb_rcvctrlpipe(serial->dev, 0),
844 0x22, 0x21, val, ifNum, NULL, 0, USB_CTRL_SET_TIMEOUT);
846 return 0;
849 static int option_startup(struct usb_serial *serial)
851 int i, j, err;
852 struct usb_serial_port *port;
853 struct option_port_private *portdata;
854 u8 *buffer;
856 dbg("%s", __func__);
858 /* Now setup per port private data */
859 for (i = 0; i < serial->num_ports; i++) {
860 port = serial->port[i];
861 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
862 if (!portdata) {
863 dbg("%s: kmalloc for option_port_private (%d) failed!.",
864 __func__, i);
865 return 1;
868 for (j = 0; j < N_IN_URB; j++) {
869 buffer = (u8 *)__get_free_page(GFP_KERNEL);
870 if (!buffer)
871 goto bail_out_error;
872 portdata->in_buffer[j] = buffer;
875 for (j = 0; j < N_OUT_URB; j++) {
876 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
877 if (!buffer)
878 goto bail_out_error2;
879 portdata->out_buffer[j] = buffer;
882 usb_set_serial_port_data(port, portdata);
884 if (!port->interrupt_in_urb)
885 continue;
886 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
887 if (err)
888 dbg("%s: submit irq_in urb failed %d",
889 __func__, err);
891 option_setup_urbs(serial);
892 return 0;
894 bail_out_error2:
895 for (j = 0; j < N_OUT_URB; j++)
896 kfree(portdata->out_buffer[j]);
897 bail_out_error:
898 for (j = 0; j < N_IN_URB; j++)
899 if (portdata->in_buffer[j])
900 free_page((unsigned long)portdata->in_buffer[j]);
901 kfree(portdata);
902 return 1;
905 static void option_shutdown(struct usb_serial *serial)
907 int i, j;
908 struct usb_serial_port *port;
909 struct option_port_private *portdata;
911 dbg("%s", __func__);
913 /* Stop reading/writing urbs */
914 for (i = 0; i < serial->num_ports; ++i) {
915 port = serial->port[i];
916 portdata = usb_get_serial_port_data(port);
917 for (j = 0; j < N_IN_URB; j++)
918 usb_kill_urb(portdata->in_urbs[j]);
919 for (j = 0; j < N_OUT_URB; j++)
920 usb_kill_urb(portdata->out_urbs[j]);
923 /* Now free them */
924 for (i = 0; i < serial->num_ports; ++i) {
925 port = serial->port[i];
926 portdata = usb_get_serial_port_data(port);
928 for (j = 0; j < N_IN_URB; j++) {
929 if (portdata->in_urbs[j]) {
930 usb_free_urb(portdata->in_urbs[j]);
931 free_page((unsigned long)
932 portdata->in_buffer[j]);
933 portdata->in_urbs[j] = NULL;
936 for (j = 0; j < N_OUT_URB; j++) {
937 if (portdata->out_urbs[j]) {
938 usb_free_urb(portdata->out_urbs[j]);
939 kfree(portdata->out_buffer[j]);
940 portdata->out_urbs[j] = NULL;
945 /* Now free per port private data */
946 for (i = 0; i < serial->num_ports; i++) {
947 port = serial->port[i];
948 kfree(usb_get_serial_port_data(port));
952 MODULE_AUTHOR(DRIVER_AUTHOR);
953 MODULE_DESCRIPTION(DRIVER_DESC);
954 MODULE_VERSION(DRIVER_VERSION);
955 MODULE_LICENSE("GPL");
957 #ifdef CONFIG_USB_DEBUG
958 module_param(debug, bool, S_IRUGO | S_IWUSR);
959 MODULE_PARM_DESC(debug, "Debug messages");
960 #endif