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