2 USB Driver for GSM modems
4 Copyright (C) 2005 Matthias Urlichs <smurf@smurf.noris.de>
6 This driver is free software; you can redistribute it and/or modify
7 it under the terms of Version 2 of the GNU General Public License as
8 published by the Free Software Foundation.
10 Portions copied from the Keyspan driver by Hugh Blemings <hugh@blemings.org>
12 History: see the git log.
14 Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
16 This driver exists because the "normal" serial driver doesn't work too well
17 with GSM modems. Issues:
18 - data loss -- one single Receive URB is not nearly enough
19 - nonstandard flow (Option devices) control
20 - controlling the baud rate doesn't make sense
22 This driver is named "option" because the most common device it's
23 used for is a PC-Card (with an internal OHCI-USB interface, behind
24 which the GSM interface sits), made by Option Inc.
26 Some of the "one port" devices actually exhibit multiple USB instances
27 on the USB bus. This is not a bug, these ports are used for different
31 #define DRIVER_VERSION "v0.7.1"
32 #define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
33 #define DRIVER_DESC "USB Driver for GSM modems"
35 #include <linux/kernel.h>
36 #include <linux/jiffies.h>
37 #include <linux/errno.h>
38 #include <linux/tty.h>
39 #include <linux/tty_flip.h>
40 #include <linux/module.h>
41 #include <linux/bitops.h>
42 #include <linux/usb.h>
43 #include <linux/usb/serial.h>
45 /* Function prototypes */
46 static int option_open(struct usb_serial_port *port, struct file *filp);
47 static void option_close(struct usb_serial_port *port, struct file *filp);
48 static int option_startup(struct usb_serial *serial);
49 static void option_shutdown(struct usb_serial *serial);
50 static void option_rx_throttle(struct usb_serial_port *port);
51 static void option_rx_unthrottle(struct usb_serial_port *port);
52 static int option_write_room(struct usb_serial_port *port);
54 static void option_instat_callback(struct urb *urb);
56 static int option_write(struct usb_serial_port *port,
57 const unsigned char *buf, int count);
59 static int option_chars_in_buffer(struct usb_serial_port *port);
60 static int option_ioctl(struct usb_serial_port *port, struct file *file,
61 unsigned int cmd, unsigned long arg);
62 static void option_set_termios(struct usb_serial_port *port,
63 struct ktermios *old);
64 static void option_break_ctl(struct usb_serial_port *port, int break_state);
65 static int option_tiocmget(struct usb_serial_port *port, struct file *file);
66 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
67 unsigned int set, unsigned int clear);
68 static int option_send_setup(struct usb_serial_port *port);
70 /* Vendor and product IDs */
71 #define OPTION_VENDOR_ID 0x0AF0
72 #define OPTION_PRODUCT_COLT 0x5000
73 #define OPTION_PRODUCT_RICOLA 0x6000
74 #define OPTION_PRODUCT_RICOLA_LIGHT 0x6100
75 #define OPTION_PRODUCT_RICOLA_QUAD 0x6200
76 #define OPTION_PRODUCT_RICOLA_QUAD_LIGHT 0x6300
77 #define OPTION_PRODUCT_RICOLA_NDIS 0x6050
78 #define OPTION_PRODUCT_RICOLA_NDIS_LIGHT 0x6150
79 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD 0x6250
80 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT 0x6350
81 #define OPTION_PRODUCT_COBRA 0x6500
82 #define OPTION_PRODUCT_COBRA_BUS 0x6501
83 #define OPTION_PRODUCT_VIPER 0x6600
84 #define OPTION_PRODUCT_VIPER_BUS 0x6601
85 #define OPTION_PRODUCT_GT_MAX_READY 0x6701
86 #define OPTION_PRODUCT_GT_MAX 0x6711
87 #define OPTION_PRODUCT_FUJI_MODEM_LIGHT 0x6721
88 #define OPTION_PRODUCT_FUJI_MODEM_GT 0x6741
89 #define OPTION_PRODUCT_FUJI_MODEM_EX 0x6761
90 #define OPTION_PRODUCT_FUJI_NETWORK_LIGHT 0x6731
91 #define OPTION_PRODUCT_FUJI_NETWORK_GT 0x6751
92 #define OPTION_PRODUCT_FUJI_NETWORK_EX 0x6771
93 #define OPTION_PRODUCT_KOI_MODEM 0x6800
94 #define OPTION_PRODUCT_KOI_NETWORK 0x6811
95 #define OPTION_PRODUCT_SCORPION_MODEM 0x6901
96 #define OPTION_PRODUCT_SCORPION_NETWORK 0x6911
97 #define OPTION_PRODUCT_ETNA_MODEM 0x7001
98 #define OPTION_PRODUCT_ETNA_NETWORK 0x7011
99 #define OPTION_PRODUCT_ETNA_MODEM_LITE 0x7021
100 #define OPTION_PRODUCT_ETNA_MODEM_GT 0x7041
101 #define OPTION_PRODUCT_ETNA_MODEM_EX 0x7061
102 #define OPTION_PRODUCT_ETNA_NETWORK_LITE 0x7031
103 #define OPTION_PRODUCT_ETNA_NETWORK_GT 0x7051
104 #define OPTION_PRODUCT_ETNA_NETWORK_EX 0x7071
105 #define OPTION_PRODUCT_ETNA_KOI_MODEM 0x7100
106 #define OPTION_PRODUCT_ETNA_KOI_NETWORK 0x7111
108 #define HUAWEI_VENDOR_ID 0x12D1
109 #define HUAWEI_PRODUCT_E600 0x1001
110 #define HUAWEI_PRODUCT_E220 0x1003
112 #define NOVATELWIRELESS_VENDOR_ID 0x1410
113 #define DELL_VENDOR_ID 0x413C
115 #define ANYDATA_VENDOR_ID 0x16d5
116 #define ANYDATA_PRODUCT_ADU_E100A 0x6501
117 #define ANYDATA_PRODUCT_ADU_500A 0x6502
119 #define BANDRICH_VENDOR_ID 0x1A8D
120 #define BANDRICH_PRODUCT_C100_1 0x1002
121 #define BANDRICH_PRODUCT_C100_2 0x1003
123 static struct usb_device_id option_ids[] = {
124 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
125 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
126 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
127 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
128 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
129 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
130 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
131 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
132 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
133 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
134 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
135 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
136 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
137 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
138 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
139 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
140 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
141 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
142 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
143 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
144 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
145 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
146 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
147 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
148 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
149 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
150 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
151 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
152 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
153 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
154 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
155 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
156 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
157 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
158 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
159 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600) },
160 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220) },
161 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1100) }, /* Novatel Merlin XS620/S640 */
162 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1110) }, /* Novatel Merlin S620 */
163 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1120) }, /* Novatel Merlin EX720 */
164 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1130) }, /* Novatel Merlin S720 */
165 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1400) }, /* Novatel U730 */
166 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1410) }, /* Novatel U740 */
167 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1420) }, /* Novatel EU870 */
168 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1430) }, /* Novatel Merlin XU870 HSDPA/3G */
169 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2100) }, /* Novatel EV620 CDMA/EV-DO */
170 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2110) }, /* Novatel Merlin ES620 / Merlin ES720 / Ovation U720 */
171 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2130) }, /* Novatel Merlin ES620 SM Bus */
172 { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2410) }, /* Novatel EU740 */
173 { USB_DEVICE(DELL_VENDOR_ID, 0x8114) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite EV620 CDMA/EV-DO */
174 { USB_DEVICE(DELL_VENDOR_ID, 0x8115) }, /* Dell Wireless 5500 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
175 { USB_DEVICE(DELL_VENDOR_ID, 0x8116) }, /* Dell Wireless 5505 Mobile Broadband HSDPA Mini-Card == Novatel Expedite EU740 HSDPA/3G */
176 { USB_DEVICE(DELL_VENDOR_ID, 0x8117) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO ExpressCard == Novatel Merlin XV620 CDMA/EV-DO */
177 { USB_DEVICE(DELL_VENDOR_ID, 0x8118) }, /* Dell Wireless 5510 Mobile Broadband HSDPA ExpressCard == Novatel Merlin XU870 HSDPA/3G */
178 { USB_DEVICE(DELL_VENDOR_ID, 0x8128) }, /* Dell Wireless 5700 Mobile Broadband CDMA/EVDO Mini-Card == Novatel Expedite E720 CDMA/EV-DO */
179 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_E100A) },
180 { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ADU_500A) },
181 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
182 { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
183 { } /* Terminating entry */
185 MODULE_DEVICE_TABLE(usb, option_ids);
187 static struct usb_driver option_driver = {
189 .probe = usb_serial_probe,
190 .disconnect = usb_serial_disconnect,
191 .id_table = option_ids,
195 /* The card has three separate interfaces, which the serial driver
196 * recognizes separately, thus num_port=1.
199 static struct usb_serial_driver option_1port_device = {
201 .owner = THIS_MODULE,
204 .description = "GSM modem (1-port)",
205 .usb_driver = &option_driver,
206 .id_table = option_ids,
207 .num_interrupt_in = NUM_DONT_CARE,
208 .num_bulk_in = NUM_DONT_CARE,
209 .num_bulk_out = NUM_DONT_CARE,
212 .close = option_close,
213 .write = option_write,
214 .write_room = option_write_room,
215 .chars_in_buffer = option_chars_in_buffer,
216 .throttle = option_rx_throttle,
217 .unthrottle = option_rx_unthrottle,
218 .ioctl = option_ioctl,
219 .set_termios = option_set_termios,
220 .break_ctl = option_break_ctl,
221 .tiocmget = option_tiocmget,
222 .tiocmset = option_tiocmset,
223 .attach = option_startup,
224 .shutdown = option_shutdown,
225 .read_int_callback = option_instat_callback,
228 #ifdef CONFIG_USB_DEBUG
234 /* per port private data */
238 #define IN_BUFLEN 4096
239 #define OUT_BUFLEN 128
241 struct option_port_private {
242 /* Input endpoints and buffer for this port */
243 struct urb *in_urbs[N_IN_URB];
244 char in_buffer[N_IN_URB][IN_BUFLEN];
245 /* Output endpoints and buffer for this port */
246 struct urb *out_urbs[N_OUT_URB];
247 char out_buffer[N_OUT_URB][OUT_BUFLEN];
248 unsigned long out_busy; /* Bit vector of URBs in use */
250 /* Settings for the port */
251 int rts_state; /* Handshaking pins (outputs) */
253 int cts_state; /* Handshaking pins (inputs) */
258 unsigned long tx_start_time[N_OUT_URB];
261 /* Functions used by new usb-serial code. */
262 static int __init option_init(void)
265 retval = usb_serial_register(&option_1port_device);
267 goto failed_1port_device_register;
268 retval = usb_register(&option_driver);
270 goto failed_driver_register;
272 info(DRIVER_DESC ": " DRIVER_VERSION);
276 failed_driver_register:
277 usb_serial_deregister (&option_1port_device);
278 failed_1port_device_register:
282 static void __exit option_exit(void)
284 usb_deregister (&option_driver);
285 usb_serial_deregister (&option_1port_device);
288 module_init(option_init);
289 module_exit(option_exit);
291 static void option_rx_throttle(struct usb_serial_port *port)
293 dbg("%s", __FUNCTION__);
296 static void option_rx_unthrottle(struct usb_serial_port *port)
298 dbg("%s", __FUNCTION__);
301 static void option_break_ctl(struct usb_serial_port *port, int break_state)
303 /* Unfortunately, I don't know how to send a break */
304 dbg("%s", __FUNCTION__);
307 static void option_set_termios(struct usb_serial_port *port,
308 struct ktermios *old_termios)
310 dbg("%s", __FUNCTION__);
312 option_send_setup(port);
315 static int option_tiocmget(struct usb_serial_port *port, struct file *file)
318 struct option_port_private *portdata;
320 portdata = usb_get_serial_port_data(port);
322 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
323 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
324 ((portdata->cts_state) ? TIOCM_CTS : 0) |
325 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
326 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
327 ((portdata->ri_state) ? TIOCM_RNG : 0);
332 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
333 unsigned int set, unsigned int clear)
335 struct option_port_private *portdata;
337 portdata = usb_get_serial_port_data(port);
340 portdata->rts_state = 1;
342 portdata->dtr_state = 1;
344 if (clear & TIOCM_RTS)
345 portdata->rts_state = 0;
346 if (clear & TIOCM_DTR)
347 portdata->dtr_state = 0;
348 return option_send_setup(port);
351 static int option_ioctl(struct usb_serial_port *port, struct file *file,
352 unsigned int cmd, unsigned long arg)
358 static int option_write(struct usb_serial_port *port,
359 const unsigned char *buf, int count)
361 struct option_port_private *portdata;
364 struct urb *this_urb = NULL; /* spurious */
367 portdata = usb_get_serial_port_data(port);
369 dbg("%s: write (%d chars)", __FUNCTION__, count);
373 for (i=0; left > 0 && i < N_OUT_URB; i++) {
375 if (todo > OUT_BUFLEN)
378 this_urb = portdata->out_urbs[i];
379 if (test_and_set_bit(i, &portdata->out_busy)) {
380 if (time_before(jiffies,
381 portdata->tx_start_time[i] + 10 * HZ))
383 usb_unlink_urb(this_urb);
386 if (this_urb->status != 0)
387 dbg("usb_write %p failed (err=%d)",
388 this_urb, this_urb->status);
390 dbg("%s: endpoint %d buf %d", __FUNCTION__,
391 usb_pipeendpoint(this_urb->pipe), i);
394 memcpy (this_urb->transfer_buffer, buf, todo);
395 this_urb->transfer_buffer_length = todo;
397 this_urb->dev = port->serial->dev;
398 err = usb_submit_urb(this_urb, GFP_ATOMIC);
400 dbg("usb_submit_urb %p (write bulk) failed "
401 "(%d, has %d)", this_urb,
402 err, this_urb->status);
403 clear_bit(i, &portdata->out_busy);
406 portdata->tx_start_time[i] = jiffies;
412 dbg("%s: wrote (did %d)", __FUNCTION__, count);
416 static void option_indat_callback(struct urb *urb)
420 struct usb_serial_port *port;
421 struct tty_struct *tty;
422 unsigned char *data = urb->transfer_buffer;
423 int status = urb->status;
425 dbg("%s: %p", __FUNCTION__, urb);
427 endpoint = usb_pipeendpoint(urb->pipe);
428 port = (struct usb_serial_port *) urb->context;
431 dbg("%s: nonzero status: %d on endpoint %02x.",
432 __FUNCTION__, status, endpoint);
435 if (urb->actual_length) {
436 tty_buffer_request_room(tty, urb->actual_length);
437 tty_insert_flip_string(tty, data, urb->actual_length);
438 tty_flip_buffer_push(tty);
440 dbg("%s: empty read urb received", __FUNCTION__);
443 /* Resubmit urb so we continue receiving */
444 if (port->open_count && status != -ESHUTDOWN) {
445 err = usb_submit_urb(urb, GFP_ATOMIC);
447 printk(KERN_ERR "%s: resubmit read urb failed. "
448 "(%d)", __FUNCTION__, err);
454 static void option_outdat_callback(struct urb *urb)
456 struct usb_serial_port *port;
457 struct option_port_private *portdata;
460 dbg("%s", __FUNCTION__);
462 port = (struct usb_serial_port *) urb->context;
464 usb_serial_port_softint(port);
466 portdata = usb_get_serial_port_data(port);
467 for (i = 0; i < N_OUT_URB; ++i) {
468 if (portdata->out_urbs[i] == urb) {
469 smp_mb__before_clear_bit();
470 clear_bit(i, &portdata->out_busy);
476 static void option_instat_callback(struct urb *urb)
479 int status = urb->status;
480 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
481 struct option_port_private *portdata = usb_get_serial_port_data(port);
482 struct usb_serial *serial = port->serial;
484 dbg("%s", __FUNCTION__);
485 dbg("%s: urb %p port %p has data %p", __FUNCTION__,urb,port,portdata);
488 struct usb_ctrlrequest *req_pkt =
489 (struct usb_ctrlrequest *)urb->transfer_buffer;
492 dbg("%s: NULL req_pkt\n", __FUNCTION__);
495 if ((req_pkt->bRequestType == 0xA1) &&
496 (req_pkt->bRequest == 0x20)) {
498 unsigned char signals = *((unsigned char *)
499 urb->transfer_buffer +
500 sizeof(struct usb_ctrlrequest));
502 dbg("%s: signal x%x", __FUNCTION__, signals);
504 old_dcd_state = portdata->dcd_state;
505 portdata->cts_state = 1;
506 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
507 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
508 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
510 if (port->tty && !C_CLOCAL(port->tty) &&
511 old_dcd_state && !portdata->dcd_state)
512 tty_hangup(port->tty);
514 dbg("%s: type %x req %x", __FUNCTION__,
515 req_pkt->bRequestType,req_pkt->bRequest);
518 dbg("%s: error %d", __FUNCTION__, status);
520 /* Resubmit urb so we continue receiving IRQ data */
521 if (status != -ESHUTDOWN) {
522 urb->dev = serial->dev;
523 err = usb_submit_urb(urb, GFP_ATOMIC);
525 dbg("%s: resubmit intr urb failed. (%d)",
530 static int option_write_room(struct usb_serial_port *port)
532 struct option_port_private *portdata;
535 struct urb *this_urb;
537 portdata = usb_get_serial_port_data(port);
539 for (i=0; i < N_OUT_URB; i++) {
540 this_urb = portdata->out_urbs[i];
541 if (this_urb && !test_bit(i, &portdata->out_busy))
542 data_len += OUT_BUFLEN;
545 dbg("%s: %d", __FUNCTION__, data_len);
549 static int option_chars_in_buffer(struct usb_serial_port *port)
551 struct option_port_private *portdata;
554 struct urb *this_urb;
556 portdata = usb_get_serial_port_data(port);
558 for (i=0; i < N_OUT_URB; i++) {
559 this_urb = portdata->out_urbs[i];
560 if (this_urb && test_bit(i, &portdata->out_busy))
561 data_len += this_urb->transfer_buffer_length;
563 dbg("%s: %d", __FUNCTION__, data_len);
567 static int option_open(struct usb_serial_port *port, struct file *filp)
569 struct option_port_private *portdata;
570 struct usb_serial *serial = port->serial;
574 portdata = usb_get_serial_port_data(port);
576 dbg("%s", __FUNCTION__);
578 /* Set some sane defaults */
579 portdata->rts_state = 1;
580 portdata->dtr_state = 1;
582 /* Reset low level data toggle and start reading from endpoints */
583 for (i = 0; i < N_IN_URB; i++) {
584 urb = portdata->in_urbs[i];
587 if (urb->dev != serial->dev) {
588 dbg("%s: dev %p != %p", __FUNCTION__,
589 urb->dev, serial->dev);
594 * make sure endpoint data toggle is synchronized with the
597 usb_clear_halt(urb->dev, urb->pipe);
599 err = usb_submit_urb(urb, GFP_KERNEL);
601 dbg("%s: submit urb %d failed (%d) %d",
602 __FUNCTION__, i, err,
603 urb->transfer_buffer_length);
607 /* Reset low level data toggle on out endpoints */
608 for (i = 0; i < N_OUT_URB; i++) {
609 urb = portdata->out_urbs[i];
612 urb->dev = serial->dev;
613 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
614 usb_pipeout(urb->pipe), 0); */
617 port->tty->low_latency = 1;
619 option_send_setup(port);
624 static void option_close(struct usb_serial_port *port, struct file *filp)
627 struct usb_serial *serial = port->serial;
628 struct option_port_private *portdata;
630 dbg("%s", __FUNCTION__);
631 portdata = usb_get_serial_port_data(port);
633 portdata->rts_state = 0;
634 portdata->dtr_state = 0;
637 option_send_setup(port);
639 /* Stop reading/writing urbs */
640 for (i = 0; i < N_IN_URB; i++)
641 usb_kill_urb(portdata->in_urbs[i]);
642 for (i = 0; i < N_OUT_URB; i++)
643 usb_kill_urb(portdata->out_urbs[i]);
648 /* Helper functions used by option_setup_urbs */
649 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
650 int dir, void *ctx, char *buf, int len,
651 void (*callback)(struct urb *))
656 return NULL; /* endpoint not needed */
658 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
660 dbg("%s: alloc for endpoint %d failed.", __FUNCTION__, endpoint);
664 /* Fill URB using supplied data. */
665 usb_fill_bulk_urb(urb, serial->dev,
666 usb_sndbulkpipe(serial->dev, endpoint) | dir,
667 buf, len, callback, ctx);
673 static void option_setup_urbs(struct usb_serial *serial)
676 struct usb_serial_port *port;
677 struct option_port_private *portdata;
679 dbg("%s", __FUNCTION__);
681 for (i = 0; i < serial->num_ports; i++) {
682 port = serial->port[i];
683 portdata = usb_get_serial_port_data(port);
685 /* Do indat endpoints first */
686 for (j = 0; j < N_IN_URB; ++j) {
687 portdata->in_urbs[j] = option_setup_urb (serial,
688 port->bulk_in_endpointAddress, USB_DIR_IN, port,
689 portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
692 /* outdat endpoints */
693 for (j = 0; j < N_OUT_URB; ++j) {
694 portdata->out_urbs[j] = option_setup_urb (serial,
695 port->bulk_out_endpointAddress, USB_DIR_OUT, port,
696 portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
701 static int option_send_setup(struct usb_serial_port *port)
703 struct usb_serial *serial = port->serial;
704 struct option_port_private *portdata;
706 dbg("%s", __FUNCTION__);
708 if (port->number != 0)
711 portdata = usb_get_serial_port_data(port);
715 if (portdata->dtr_state)
717 if (portdata->rts_state)
720 return usb_control_msg(serial->dev,
721 usb_rcvctrlpipe(serial->dev, 0),
722 0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
728 static int option_startup(struct usb_serial *serial)
731 struct usb_serial_port *port;
732 struct option_port_private *portdata;
734 dbg("%s", __FUNCTION__);
736 /* Now setup per port private data */
737 for (i = 0; i < serial->num_ports; i++) {
738 port = serial->port[i];
739 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
741 dbg("%s: kmalloc for option_port_private (%d) failed!.",
746 usb_set_serial_port_data(port, portdata);
748 if (! port->interrupt_in_urb)
750 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
752 dbg("%s: submit irq_in urb failed %d",
756 option_setup_urbs(serial);
761 static void option_shutdown(struct usb_serial *serial)
764 struct usb_serial_port *port;
765 struct option_port_private *portdata;
767 dbg("%s", __FUNCTION__);
769 /* Stop reading/writing urbs */
770 for (i = 0; i < serial->num_ports; ++i) {
771 port = serial->port[i];
772 portdata = usb_get_serial_port_data(port);
773 for (j = 0; j < N_IN_URB; j++)
774 usb_kill_urb(portdata->in_urbs[j]);
775 for (j = 0; j < N_OUT_URB; j++)
776 usb_kill_urb(portdata->out_urbs[j]);
780 for (i = 0; i < serial->num_ports; ++i) {
781 port = serial->port[i];
782 portdata = usb_get_serial_port_data(port);
784 for (j = 0; j < N_IN_URB; j++) {
785 if (portdata->in_urbs[j]) {
786 usb_free_urb(portdata->in_urbs[j]);
787 portdata->in_urbs[j] = NULL;
790 for (j = 0; j < N_OUT_URB; j++) {
791 if (portdata->out_urbs[j]) {
792 usb_free_urb(portdata->out_urbs[j]);
793 portdata->out_urbs[j] = NULL;
798 /* Now free per port private data */
799 for (i = 0; i < serial->num_ports; i++) {
800 port = serial->port[i];
801 kfree(usb_get_serial_port_data(port));
805 MODULE_AUTHOR(DRIVER_AUTHOR);
806 MODULE_DESCRIPTION(DRIVER_DESC);
807 MODULE_VERSION(DRIVER_VERSION);
808 MODULE_LICENSE("GPL");
810 #ifdef CONFIG_USB_DEBUG
811 module_param(debug, bool, S_IRUGO | S_IWUSR);
812 MODULE_PARM_DESC(debug, "Debug messages");