2 USB Driver layer 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 - controlling the baud rate doesn't make sense
22 #define DRIVER_VERSION "v0.7.2"
23 #define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
24 #define DRIVER_DESC "USB Driver for GSM modems"
26 #include <linux/kernel.h>
27 #include <linux/jiffies.h>
28 #include <linux/errno.h>
29 #include <linux/slab.h>
30 #include <linux/tty.h>
31 #include <linux/tty_flip.h>
32 #include <linux/module.h>
33 #include <linux/bitops.h>
34 #include <linux/usb.h>
35 #include <linux/usb/serial.h>
40 void usb_wwan_dtr_rts(struct usb_serial_port
*port
, int on
)
42 struct usb_serial
*serial
= port
->serial
;
43 struct usb_wwan_port_private
*portdata
;
45 struct usb_wwan_intf_private
*intfdata
;
49 intfdata
= port
->serial
->private;
51 if (!intfdata
->send_setup
)
54 portdata
= usb_get_serial_port_data(port
);
55 mutex_lock(&serial
->disc_mutex
);
56 portdata
->rts_state
= on
;
57 portdata
->dtr_state
= on
;
59 intfdata
->send_setup(port
);
60 mutex_unlock(&serial
->disc_mutex
);
62 EXPORT_SYMBOL(usb_wwan_dtr_rts
);
64 void usb_wwan_set_termios(struct tty_struct
*tty
,
65 struct usb_serial_port
*port
,
66 struct ktermios
*old_termios
)
68 struct usb_wwan_intf_private
*intfdata
= port
->serial
->private;
72 /* Doesn't support option setting */
73 tty_termios_copy_hw(tty
->termios
, old_termios
);
75 if (intfdata
->send_setup
)
76 intfdata
->send_setup(port
);
78 EXPORT_SYMBOL(usb_wwan_set_termios
);
80 int usb_wwan_tiocmget(struct tty_struct
*tty
, struct file
*file
)
82 struct usb_serial_port
*port
= tty
->driver_data
;
84 struct usb_wwan_port_private
*portdata
;
86 portdata
= usb_get_serial_port_data(port
);
88 value
= ((portdata
->rts_state
) ? TIOCM_RTS
: 0) |
89 ((portdata
->dtr_state
) ? TIOCM_DTR
: 0) |
90 ((portdata
->cts_state
) ? TIOCM_CTS
: 0) |
91 ((portdata
->dsr_state
) ? TIOCM_DSR
: 0) |
92 ((portdata
->dcd_state
) ? TIOCM_CAR
: 0) |
93 ((portdata
->ri_state
) ? TIOCM_RNG
: 0);
97 EXPORT_SYMBOL(usb_wwan_tiocmget
);
99 int usb_wwan_tiocmset(struct tty_struct
*tty
, struct file
*file
,
100 unsigned int set
, unsigned int clear
)
102 struct usb_serial_port
*port
= tty
->driver_data
;
103 struct usb_wwan_port_private
*portdata
;
104 struct usb_wwan_intf_private
*intfdata
;
106 portdata
= usb_get_serial_port_data(port
);
107 intfdata
= port
->serial
->private;
109 if (!intfdata
->send_setup
)
113 portdata
->rts_state
= 1;
115 portdata
->dtr_state
= 1;
117 if (clear
& TIOCM_RTS
)
118 portdata
->rts_state
= 0;
119 if (clear
& TIOCM_DTR
)
120 portdata
->dtr_state
= 0;
121 return intfdata
->send_setup(port
);
123 EXPORT_SYMBOL(usb_wwan_tiocmset
);
126 int usb_wwan_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
127 const unsigned char *buf
, int count
)
129 struct usb_wwan_port_private
*portdata
;
130 struct usb_wwan_intf_private
*intfdata
;
133 struct urb
*this_urb
= NULL
; /* spurious */
137 portdata
= usb_get_serial_port_data(port
);
138 intfdata
= port
->serial
->private;
140 dbg("%s: write (%d chars)", __func__
, count
);
144 for (i
= 0; left
> 0 && i
< N_OUT_URB
; i
++) {
146 if (todo
> OUT_BUFLEN
)
149 this_urb
= portdata
->out_urbs
[i
];
150 if (test_and_set_bit(i
, &portdata
->out_busy
)) {
151 if (time_before(jiffies
,
152 portdata
->tx_start_time
[i
] + 10 * HZ
))
154 usb_unlink_urb(this_urb
);
157 dbg("%s: endpoint %d buf %d", __func__
,
158 usb_pipeendpoint(this_urb
->pipe
), i
);
160 err
= usb_autopm_get_interface_async(port
->serial
->interface
);
165 memcpy(this_urb
->transfer_buffer
, buf
, todo
);
166 this_urb
->transfer_buffer_length
= todo
;
168 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
169 if (intfdata
->suspended
) {
170 usb_anchor_urb(this_urb
, &portdata
->delayed
);
171 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
173 intfdata
->in_flight
++;
174 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
175 err
= usb_submit_urb(this_urb
, GFP_ATOMIC
);
177 dbg("usb_submit_urb %p (write bulk) failed "
178 "(%d)", this_urb
, err
);
179 clear_bit(i
, &portdata
->out_busy
);
180 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
181 intfdata
->in_flight
--;
182 spin_unlock_irqrestore(&intfdata
->susp_lock
,
188 portdata
->tx_start_time
[i
] = jiffies
;
194 dbg("%s: wrote (did %d)", __func__
, count
);
197 EXPORT_SYMBOL(usb_wwan_write
);
199 static void usb_wwan_indat_callback(struct urb
*urb
)
203 struct usb_serial_port
*port
;
204 struct tty_struct
*tty
;
205 unsigned char *data
= urb
->transfer_buffer
;
206 int status
= urb
->status
;
208 dbg("%s: %p", __func__
, urb
);
210 endpoint
= usb_pipeendpoint(urb
->pipe
);
214 dbg("%s: nonzero status: %d on endpoint %02x.",
215 __func__
, status
, endpoint
);
217 tty
= tty_port_tty_get(&port
->port
);
218 if (urb
->actual_length
) {
219 tty_insert_flip_string(tty
, data
, urb
->actual_length
);
220 tty_flip_buffer_push(tty
);
222 dbg("%s: empty read urb received", __func__
);
225 /* Resubmit urb so we continue receiving */
226 if (status
!= -ESHUTDOWN
) {
227 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
228 if (err
&& err
!= -EPERM
)
229 printk(KERN_ERR
"%s: resubmit read urb failed. "
230 "(%d)", __func__
, err
);
232 usb_mark_last_busy(port
->serial
->dev
);
239 static void usb_wwan_outdat_callback(struct urb
*urb
)
241 struct usb_serial_port
*port
;
242 struct usb_wwan_port_private
*portdata
;
243 struct usb_wwan_intf_private
*intfdata
;
249 intfdata
= port
->serial
->private;
251 usb_serial_port_softint(port
);
252 usb_autopm_put_interface_async(port
->serial
->interface
);
253 portdata
= usb_get_serial_port_data(port
);
254 spin_lock(&intfdata
->susp_lock
);
255 intfdata
->in_flight
--;
256 spin_unlock(&intfdata
->susp_lock
);
258 for (i
= 0; i
< N_OUT_URB
; ++i
) {
259 if (portdata
->out_urbs
[i
] == urb
) {
260 smp_mb__before_clear_bit();
261 clear_bit(i
, &portdata
->out_busy
);
267 int usb_wwan_write_room(struct tty_struct
*tty
)
269 struct usb_serial_port
*port
= tty
->driver_data
;
270 struct usb_wwan_port_private
*portdata
;
273 struct urb
*this_urb
;
275 portdata
= usb_get_serial_port_data(port
);
277 for (i
= 0; i
< N_OUT_URB
; i
++) {
278 this_urb
= portdata
->out_urbs
[i
];
279 if (this_urb
&& !test_bit(i
, &portdata
->out_busy
))
280 data_len
+= OUT_BUFLEN
;
283 dbg("%s: %d", __func__
, data_len
);
286 EXPORT_SYMBOL(usb_wwan_write_room
);
288 int usb_wwan_chars_in_buffer(struct tty_struct
*tty
)
290 struct usb_serial_port
*port
= tty
->driver_data
;
291 struct usb_wwan_port_private
*portdata
;
294 struct urb
*this_urb
;
296 portdata
= usb_get_serial_port_data(port
);
298 for (i
= 0; i
< N_OUT_URB
; i
++) {
299 this_urb
= portdata
->out_urbs
[i
];
300 if (this_urb
&& test_bit(i
, &portdata
->out_busy
))
301 data_len
+= this_urb
->transfer_buffer_length
;
303 dbg("%s: %d", __func__
, data_len
);
306 EXPORT_SYMBOL(usb_wwan_chars_in_buffer
);
308 int usb_wwan_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
310 struct usb_wwan_port_private
*portdata
;
311 struct usb_wwan_intf_private
*intfdata
;
312 struct usb_serial
*serial
= port
->serial
;
316 portdata
= usb_get_serial_port_data(port
);
317 intfdata
= serial
->private;
321 /* Start reading from the IN endpoint */
322 for (i
= 0; i
< N_IN_URB
; i
++) {
323 urb
= portdata
->in_urbs
[i
];
326 err
= usb_submit_urb(urb
, GFP_KERNEL
);
328 dbg("%s: submit urb %d failed (%d) %d",
329 __func__
, i
, err
, urb
->transfer_buffer_length
);
333 if (intfdata
->send_setup
)
334 intfdata
->send_setup(port
);
336 serial
->interface
->needs_remote_wakeup
= 1;
337 spin_lock_irq(&intfdata
->susp_lock
);
338 portdata
->opened
= 1;
339 spin_unlock_irq(&intfdata
->susp_lock
);
340 usb_autopm_put_interface(serial
->interface
);
344 EXPORT_SYMBOL(usb_wwan_open
);
346 void usb_wwan_close(struct usb_serial_port
*port
)
349 struct usb_serial
*serial
= port
->serial
;
350 struct usb_wwan_port_private
*portdata
;
351 struct usb_wwan_intf_private
*intfdata
= port
->serial
->private;
354 portdata
= usb_get_serial_port_data(port
);
357 /* Stop reading/writing urbs */
358 spin_lock_irq(&intfdata
->susp_lock
);
359 portdata
->opened
= 0;
360 spin_unlock_irq(&intfdata
->susp_lock
);
362 for (i
= 0; i
< N_IN_URB
; i
++)
363 usb_kill_urb(portdata
->in_urbs
[i
]);
364 for (i
= 0; i
< N_OUT_URB
; i
++)
365 usb_kill_urb(portdata
->out_urbs
[i
]);
366 usb_autopm_get_interface(serial
->interface
);
367 serial
->interface
->needs_remote_wakeup
= 0;
370 EXPORT_SYMBOL(usb_wwan_close
);
372 /* Helper functions used by usb_wwan_setup_urbs */
373 static struct urb
*usb_wwan_setup_urb(struct usb_serial
*serial
, int endpoint
,
374 int dir
, void *ctx
, char *buf
, int len
,
375 void (*callback
) (struct urb
*))
380 return NULL
; /* endpoint not needed */
382 urb
= usb_alloc_urb(0, GFP_KERNEL
); /* No ISO */
384 dbg("%s: alloc for endpoint %d failed.", __func__
, endpoint
);
388 /* Fill URB using supplied data. */
389 usb_fill_bulk_urb(urb
, serial
->dev
,
390 usb_sndbulkpipe(serial
->dev
, endpoint
) | dir
,
391 buf
, len
, callback
, ctx
);
397 static void usb_wwan_setup_urbs(struct usb_serial
*serial
)
400 struct usb_serial_port
*port
;
401 struct usb_wwan_port_private
*portdata
;
405 for (i
= 0; i
< serial
->num_ports
; i
++) {
406 port
= serial
->port
[i
];
407 portdata
= usb_get_serial_port_data(port
);
409 /* Do indat endpoints first */
410 for (j
= 0; j
< N_IN_URB
; ++j
) {
411 portdata
->in_urbs
[j
] = usb_wwan_setup_urb(serial
,
413 bulk_in_endpointAddress
,
419 usb_wwan_indat_callback
);
422 /* outdat endpoints */
423 for (j
= 0; j
< N_OUT_URB
; ++j
) {
424 portdata
->out_urbs
[j
] = usb_wwan_setup_urb(serial
,
426 bulk_out_endpointAddress
,
433 usb_wwan_outdat_callback
);
438 int usb_wwan_startup(struct usb_serial
*serial
)
441 struct usb_serial_port
*port
;
442 struct usb_wwan_port_private
*portdata
;
447 /* Now setup per port private data */
448 for (i
= 0; i
< serial
->num_ports
; i
++) {
449 port
= serial
->port
[i
];
450 portdata
= kzalloc(sizeof(*portdata
), GFP_KERNEL
);
452 dbg("%s: kmalloc for usb_wwan_port_private (%d) failed!.",
456 init_usb_anchor(&portdata
->delayed
);
458 for (j
= 0; j
< N_IN_URB
; j
++) {
459 buffer
= (u8
*) __get_free_page(GFP_KERNEL
);
462 portdata
->in_buffer
[j
] = buffer
;
465 for (j
= 0; j
< N_OUT_URB
; j
++) {
466 buffer
= kmalloc(OUT_BUFLEN
, GFP_KERNEL
);
468 goto bail_out_error2
;
469 portdata
->out_buffer
[j
] = buffer
;
472 usb_set_serial_port_data(port
, portdata
);
474 if (!port
->interrupt_in_urb
)
476 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
478 dbg("%s: submit irq_in urb failed %d", __func__
, err
);
480 usb_wwan_setup_urbs(serial
);
484 for (j
= 0; j
< N_OUT_URB
; j
++)
485 kfree(portdata
->out_buffer
[j
]);
487 for (j
= 0; j
< N_IN_URB
; j
++)
488 if (portdata
->in_buffer
[j
])
489 free_page((unsigned long)portdata
->in_buffer
[j
]);
493 EXPORT_SYMBOL(usb_wwan_startup
);
495 static void stop_read_write_urbs(struct usb_serial
*serial
)
498 struct usb_serial_port
*port
;
499 struct usb_wwan_port_private
*portdata
;
501 /* Stop reading/writing urbs */
502 for (i
= 0; i
< serial
->num_ports
; ++i
) {
503 port
= serial
->port
[i
];
504 portdata
= usb_get_serial_port_data(port
);
505 for (j
= 0; j
< N_IN_URB
; j
++)
506 usb_kill_urb(portdata
->in_urbs
[j
]);
507 for (j
= 0; j
< N_OUT_URB
; j
++)
508 usb_kill_urb(portdata
->out_urbs
[j
]);
512 void usb_wwan_disconnect(struct usb_serial
*serial
)
516 stop_read_write_urbs(serial
);
518 EXPORT_SYMBOL(usb_wwan_disconnect
);
520 void usb_wwan_release(struct usb_serial
*serial
)
523 struct usb_serial_port
*port
;
524 struct usb_wwan_port_private
*portdata
;
529 for (i
= 0; i
< serial
->num_ports
; ++i
) {
530 port
= serial
->port
[i
];
531 portdata
= usb_get_serial_port_data(port
);
533 for (j
= 0; j
< N_IN_URB
; j
++) {
534 usb_free_urb(portdata
->in_urbs
[j
]);
535 free_page((unsigned long)
536 portdata
->in_buffer
[j
]);
537 portdata
->in_urbs
[j
] = NULL
;
539 for (j
= 0; j
< N_OUT_URB
; j
++) {
540 usb_free_urb(portdata
->out_urbs
[j
]);
541 kfree(portdata
->out_buffer
[j
]);
542 portdata
->out_urbs
[j
] = NULL
;
546 /* Now free per port private data */
547 for (i
= 0; i
< serial
->num_ports
; i
++) {
548 port
= serial
->port
[i
];
549 kfree(usb_get_serial_port_data(port
));
552 EXPORT_SYMBOL(usb_wwan_release
);
555 int usb_wwan_suspend(struct usb_serial
*serial
, pm_message_t message
)
557 struct usb_wwan_intf_private
*intfdata
= serial
->private;
560 dbg("%s entered", __func__
);
562 if (message
.event
& PM_EVENT_AUTO
) {
563 spin_lock_irq(&intfdata
->susp_lock
);
564 b
= intfdata
->in_flight
;
565 spin_unlock_irq(&intfdata
->susp_lock
);
571 spin_lock_irq(&intfdata
->susp_lock
);
572 intfdata
->suspended
= 1;
573 spin_unlock_irq(&intfdata
->susp_lock
);
574 stop_read_write_urbs(serial
);
578 EXPORT_SYMBOL(usb_wwan_suspend
);
580 static void play_delayed(struct usb_serial_port
*port
)
582 struct usb_wwan_intf_private
*data
;
583 struct usb_wwan_port_private
*portdata
;
587 portdata
= usb_get_serial_port_data(port
);
588 data
= port
->serial
->private;
589 while ((urb
= usb_get_from_anchor(&portdata
->delayed
))) {
590 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
596 int usb_wwan_resume(struct usb_serial
*serial
)
599 struct usb_serial_port
*port
;
600 struct usb_wwan_intf_private
*intfdata
= serial
->private;
601 struct usb_wwan_port_private
*portdata
;
605 dbg("%s entered", __func__
);
606 /* get the interrupt URBs resubmitted unconditionally */
607 for (i
= 0; i
< serial
->num_ports
; i
++) {
608 port
= serial
->port
[i
];
609 if (!port
->interrupt_in_urb
) {
610 dbg("%s: No interrupt URB for port %d", __func__
, i
);
613 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_NOIO
);
614 dbg("Submitted interrupt URB for port %d (result %d)", i
, err
);
616 err("%s: Error %d for interrupt URB of port%d",
622 for (i
= 0; i
< serial
->num_ports
; i
++) {
624 port
= serial
->port
[i
];
625 portdata
= usb_get_serial_port_data(port
);
627 /* skip closed ports */
628 spin_lock_irq(&intfdata
->susp_lock
);
629 if (!portdata
->opened
) {
630 spin_unlock_irq(&intfdata
->susp_lock
);
634 for (j
= 0; j
< N_IN_URB
; j
++) {
635 urb
= portdata
->in_urbs
[j
];
636 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
638 err("%s: Error %d for bulk URB %d",
640 spin_unlock_irq(&intfdata
->susp_lock
);
645 spin_unlock_irq(&intfdata
->susp_lock
);
647 spin_lock_irq(&intfdata
->susp_lock
);
648 intfdata
->suspended
= 0;
649 spin_unlock_irq(&intfdata
->susp_lock
);
653 EXPORT_SYMBOL(usb_wwan_resume
);
656 MODULE_AUTHOR(DRIVER_AUTHOR
);
657 MODULE_DESCRIPTION(DRIVER_DESC
);
658 MODULE_VERSION(DRIVER_VERSION
);
659 MODULE_LICENSE("GPL");
661 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
662 MODULE_PARM_DESC(debug
, "Debug messages");