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/uaccess.h>
35 #include <linux/usb.h>
36 #include <linux/usb/serial.h>
37 #include <linux/serial.h>
42 void usb_wwan_dtr_rts(struct usb_serial_port
*port
, int on
)
44 struct usb_serial
*serial
= port
->serial
;
45 struct usb_wwan_port_private
*portdata
;
47 struct usb_wwan_intf_private
*intfdata
;
51 intfdata
= port
->serial
->private;
53 if (!intfdata
->send_setup
)
56 portdata
= usb_get_serial_port_data(port
);
57 mutex_lock(&serial
->disc_mutex
);
58 portdata
->rts_state
= on
;
59 portdata
->dtr_state
= on
;
61 intfdata
->send_setup(port
);
62 mutex_unlock(&serial
->disc_mutex
);
64 EXPORT_SYMBOL(usb_wwan_dtr_rts
);
66 void usb_wwan_set_termios(struct tty_struct
*tty
,
67 struct usb_serial_port
*port
,
68 struct ktermios
*old_termios
)
70 struct usb_wwan_intf_private
*intfdata
= port
->serial
->private;
74 /* Doesn't support option setting */
75 tty_termios_copy_hw(tty
->termios
, old_termios
);
77 if (intfdata
->send_setup
)
78 intfdata
->send_setup(port
);
80 EXPORT_SYMBOL(usb_wwan_set_termios
);
82 int usb_wwan_tiocmget(struct tty_struct
*tty
, struct file
*file
)
84 struct usb_serial_port
*port
= tty
->driver_data
;
86 struct usb_wwan_port_private
*portdata
;
88 portdata
= usb_get_serial_port_data(port
);
90 value
= ((portdata
->rts_state
) ? TIOCM_RTS
: 0) |
91 ((portdata
->dtr_state
) ? TIOCM_DTR
: 0) |
92 ((portdata
->cts_state
) ? TIOCM_CTS
: 0) |
93 ((portdata
->dsr_state
) ? TIOCM_DSR
: 0) |
94 ((portdata
->dcd_state
) ? TIOCM_CAR
: 0) |
95 ((portdata
->ri_state
) ? TIOCM_RNG
: 0);
99 EXPORT_SYMBOL(usb_wwan_tiocmget
);
101 int usb_wwan_tiocmset(struct tty_struct
*tty
, struct file
*file
,
102 unsigned int set
, unsigned int clear
)
104 struct usb_serial_port
*port
= tty
->driver_data
;
105 struct usb_wwan_port_private
*portdata
;
106 struct usb_wwan_intf_private
*intfdata
;
108 portdata
= usb_get_serial_port_data(port
);
109 intfdata
= port
->serial
->private;
111 if (!intfdata
->send_setup
)
114 /* FIXME: what locks portdata fields ? */
116 portdata
->rts_state
= 1;
118 portdata
->dtr_state
= 1;
120 if (clear
& TIOCM_RTS
)
121 portdata
->rts_state
= 0;
122 if (clear
& TIOCM_DTR
)
123 portdata
->dtr_state
= 0;
124 return intfdata
->send_setup(port
);
126 EXPORT_SYMBOL(usb_wwan_tiocmset
);
128 static int get_serial_info(struct usb_serial_port
*port
,
129 struct serial_struct __user
*retinfo
)
131 struct serial_struct tmp
;
136 memset(&tmp
, 0, sizeof(tmp
));
137 tmp
.line
= port
->serial
->minor
;
138 tmp
.port
= port
->number
;
139 tmp
.baud_base
= tty_get_baud_rate(port
->port
.tty
);
140 tmp
.close_delay
= port
->port
.close_delay
/ 10;
141 tmp
.closing_wait
= port
->port
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
142 ASYNC_CLOSING_WAIT_NONE
:
143 port
->port
.closing_wait
/ 10;
145 if (copy_to_user(retinfo
, &tmp
, sizeof(*retinfo
)))
150 static int set_serial_info(struct usb_serial_port
*port
,
151 struct serial_struct __user
*newinfo
)
153 struct serial_struct new_serial
;
154 unsigned int closing_wait
, close_delay
;
157 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
160 close_delay
= new_serial
.close_delay
* 10;
161 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
162 ASYNC_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
164 mutex_lock(&port
->port
.mutex
);
166 if (!capable(CAP_SYS_ADMIN
)) {
167 if ((close_delay
!= port
->port
.close_delay
) ||
168 (closing_wait
!= port
->port
.closing_wait
))
171 retval
= -EOPNOTSUPP
;
173 port
->port
.close_delay
= close_delay
;
174 port
->port
.closing_wait
= closing_wait
;
177 mutex_unlock(&port
->port
.mutex
);
181 int usb_wwan_ioctl(struct tty_struct
*tty
, struct file
*file
,
182 unsigned int cmd
, unsigned long arg
)
184 struct usb_serial_port
*port
= tty
->driver_data
;
186 dbg("%s cmd 0x%04x", __func__
, cmd
);
190 return get_serial_info(port
,
191 (struct serial_struct __user
*) arg
);
193 return set_serial_info(port
,
194 (struct serial_struct __user
*) arg
);
199 dbg("%s arg not supported", __func__
);
203 EXPORT_SYMBOL(usb_wwan_ioctl
);
206 int usb_wwan_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
207 const unsigned char *buf
, int count
)
209 struct usb_wwan_port_private
*portdata
;
210 struct usb_wwan_intf_private
*intfdata
;
213 struct urb
*this_urb
= NULL
; /* spurious */
217 portdata
= usb_get_serial_port_data(port
);
218 intfdata
= port
->serial
->private;
220 dbg("%s: write (%d chars)", __func__
, count
);
224 for (i
= 0; left
> 0 && i
< N_OUT_URB
; i
++) {
226 if (todo
> OUT_BUFLEN
)
229 this_urb
= portdata
->out_urbs
[i
];
230 if (test_and_set_bit(i
, &portdata
->out_busy
)) {
231 if (time_before(jiffies
,
232 portdata
->tx_start_time
[i
] + 10 * HZ
))
234 usb_unlink_urb(this_urb
);
237 dbg("%s: endpoint %d buf %d", __func__
,
238 usb_pipeendpoint(this_urb
->pipe
), i
);
240 err
= usb_autopm_get_interface_async(port
->serial
->interface
);
245 memcpy(this_urb
->transfer_buffer
, buf
, todo
);
246 this_urb
->transfer_buffer_length
= todo
;
248 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
249 if (intfdata
->suspended
) {
250 usb_anchor_urb(this_urb
, &portdata
->delayed
);
251 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
253 intfdata
->in_flight
++;
254 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
255 err
= usb_submit_urb(this_urb
, GFP_ATOMIC
);
257 dbg("usb_submit_urb %p (write bulk) failed "
258 "(%d)", this_urb
, err
);
259 clear_bit(i
, &portdata
->out_busy
);
260 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
261 intfdata
->in_flight
--;
262 spin_unlock_irqrestore(&intfdata
->susp_lock
,
264 usb_autopm_put_interface_async(port
->serial
->interface
);
269 portdata
->tx_start_time
[i
] = jiffies
;
275 dbg("%s: wrote (did %d)", __func__
, count
);
278 EXPORT_SYMBOL(usb_wwan_write
);
280 static void usb_wwan_indat_callback(struct urb
*urb
)
284 struct usb_serial_port
*port
;
285 struct tty_struct
*tty
;
286 unsigned char *data
= urb
->transfer_buffer
;
287 int status
= urb
->status
;
289 dbg("%s: %p", __func__
, urb
);
291 endpoint
= usb_pipeendpoint(urb
->pipe
);
295 dbg("%s: nonzero status: %d on endpoint %02x.",
296 __func__
, status
, endpoint
);
298 tty
= tty_port_tty_get(&port
->port
);
299 if (urb
->actual_length
) {
300 tty_insert_flip_string(tty
, data
, urb
->actual_length
);
301 tty_flip_buffer_push(tty
);
303 dbg("%s: empty read urb received", __func__
);
306 /* Resubmit urb so we continue receiving */
307 if (status
!= -ESHUTDOWN
) {
308 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
311 printk(KERN_ERR
"%s: resubmit read urb failed. "
312 "(%d)", __func__
, err
);
313 /* busy also in error unless we are killed */
314 usb_mark_last_busy(port
->serial
->dev
);
317 usb_mark_last_busy(port
->serial
->dev
);
324 static void usb_wwan_outdat_callback(struct urb
*urb
)
326 struct usb_serial_port
*port
;
327 struct usb_wwan_port_private
*portdata
;
328 struct usb_wwan_intf_private
*intfdata
;
334 intfdata
= port
->serial
->private;
336 usb_serial_port_softint(port
);
337 usb_autopm_put_interface_async(port
->serial
->interface
);
338 portdata
= usb_get_serial_port_data(port
);
339 spin_lock(&intfdata
->susp_lock
);
340 intfdata
->in_flight
--;
341 spin_unlock(&intfdata
->susp_lock
);
343 for (i
= 0; i
< N_OUT_URB
; ++i
) {
344 if (portdata
->out_urbs
[i
] == urb
) {
345 smp_mb__before_clear_bit();
346 clear_bit(i
, &portdata
->out_busy
);
352 int usb_wwan_write_room(struct tty_struct
*tty
)
354 struct usb_serial_port
*port
= tty
->driver_data
;
355 struct usb_wwan_port_private
*portdata
;
358 struct urb
*this_urb
;
360 portdata
= usb_get_serial_port_data(port
);
362 for (i
= 0; i
< N_OUT_URB
; i
++) {
363 this_urb
= portdata
->out_urbs
[i
];
364 if (this_urb
&& !test_bit(i
, &portdata
->out_busy
))
365 data_len
+= OUT_BUFLEN
;
368 dbg("%s: %d", __func__
, data_len
);
371 EXPORT_SYMBOL(usb_wwan_write_room
);
373 int usb_wwan_chars_in_buffer(struct tty_struct
*tty
)
375 struct usb_serial_port
*port
= tty
->driver_data
;
376 struct usb_wwan_port_private
*portdata
;
379 struct urb
*this_urb
;
381 portdata
= usb_get_serial_port_data(port
);
383 for (i
= 0; i
< N_OUT_URB
; i
++) {
384 this_urb
= portdata
->out_urbs
[i
];
385 /* FIXME: This locking is insufficient as this_urb may
386 go unused during the test */
387 if (this_urb
&& test_bit(i
, &portdata
->out_busy
))
388 data_len
+= this_urb
->transfer_buffer_length
;
390 dbg("%s: %d", __func__
, data_len
);
393 EXPORT_SYMBOL(usb_wwan_chars_in_buffer
);
395 int usb_wwan_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
397 struct usb_wwan_port_private
*portdata
;
398 struct usb_wwan_intf_private
*intfdata
;
399 struct usb_serial
*serial
= port
->serial
;
403 portdata
= usb_get_serial_port_data(port
);
404 intfdata
= serial
->private;
408 /* Start reading from the IN endpoint */
409 for (i
= 0; i
< N_IN_URB
; i
++) {
410 urb
= portdata
->in_urbs
[i
];
413 err
= usb_submit_urb(urb
, GFP_KERNEL
);
415 dbg("%s: submit urb %d failed (%d) %d",
416 __func__
, i
, err
, urb
->transfer_buffer_length
);
420 if (intfdata
->send_setup
)
421 intfdata
->send_setup(port
);
423 serial
->interface
->needs_remote_wakeup
= 1;
424 spin_lock_irq(&intfdata
->susp_lock
);
425 portdata
->opened
= 1;
426 spin_unlock_irq(&intfdata
->susp_lock
);
427 usb_autopm_put_interface(serial
->interface
);
431 EXPORT_SYMBOL(usb_wwan_open
);
433 void usb_wwan_close(struct usb_serial_port
*port
)
436 struct usb_serial
*serial
= port
->serial
;
437 struct usb_wwan_port_private
*portdata
;
438 struct usb_wwan_intf_private
*intfdata
= port
->serial
->private;
441 portdata
= usb_get_serial_port_data(port
);
444 /* Stop reading/writing urbs */
445 spin_lock_irq(&intfdata
->susp_lock
);
446 portdata
->opened
= 0;
447 spin_unlock_irq(&intfdata
->susp_lock
);
449 for (i
= 0; i
< N_IN_URB
; i
++)
450 usb_kill_urb(portdata
->in_urbs
[i
]);
451 for (i
= 0; i
< N_OUT_URB
; i
++)
452 usb_kill_urb(portdata
->out_urbs
[i
]);
453 usb_autopm_get_interface(serial
->interface
);
454 serial
->interface
->needs_remote_wakeup
= 0;
457 EXPORT_SYMBOL(usb_wwan_close
);
459 /* Helper functions used by usb_wwan_setup_urbs */
460 static struct urb
*usb_wwan_setup_urb(struct usb_serial
*serial
, int endpoint
,
461 int dir
, void *ctx
, char *buf
, int len
,
462 void (*callback
) (struct urb
*))
467 return NULL
; /* endpoint not needed */
469 urb
= usb_alloc_urb(0, GFP_KERNEL
); /* No ISO */
471 dbg("%s: alloc for endpoint %d failed.", __func__
, endpoint
);
475 /* Fill URB using supplied data. */
476 usb_fill_bulk_urb(urb
, serial
->dev
,
477 usb_sndbulkpipe(serial
->dev
, endpoint
) | dir
,
478 buf
, len
, callback
, ctx
);
484 static void usb_wwan_setup_urbs(struct usb_serial
*serial
)
487 struct usb_serial_port
*port
;
488 struct usb_wwan_port_private
*portdata
;
492 for (i
= 0; i
< serial
->num_ports
; i
++) {
493 port
= serial
->port
[i
];
494 portdata
= usb_get_serial_port_data(port
);
496 /* Do indat endpoints first */
497 for (j
= 0; j
< N_IN_URB
; ++j
) {
498 portdata
->in_urbs
[j
] = usb_wwan_setup_urb(serial
,
500 bulk_in_endpointAddress
,
506 usb_wwan_indat_callback
);
509 /* outdat endpoints */
510 for (j
= 0; j
< N_OUT_URB
; ++j
) {
511 portdata
->out_urbs
[j
] = usb_wwan_setup_urb(serial
,
513 bulk_out_endpointAddress
,
520 usb_wwan_outdat_callback
);
525 int usb_wwan_startup(struct usb_serial
*serial
)
528 struct usb_serial_port
*port
;
529 struct usb_wwan_port_private
*portdata
;
534 /* Now setup per port private data */
535 for (i
= 0; i
< serial
->num_ports
; i
++) {
536 port
= serial
->port
[i
];
537 portdata
= kzalloc(sizeof(*portdata
), GFP_KERNEL
);
539 dbg("%s: kmalloc for usb_wwan_port_private (%d) failed!.",
543 init_usb_anchor(&portdata
->delayed
);
545 for (j
= 0; j
< N_IN_URB
; j
++) {
546 buffer
= (u8
*) __get_free_page(GFP_KERNEL
);
549 portdata
->in_buffer
[j
] = buffer
;
552 for (j
= 0; j
< N_OUT_URB
; j
++) {
553 buffer
= kmalloc(OUT_BUFLEN
, GFP_KERNEL
);
555 goto bail_out_error2
;
556 portdata
->out_buffer
[j
] = buffer
;
559 usb_set_serial_port_data(port
, portdata
);
561 if (!port
->interrupt_in_urb
)
563 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
565 dbg("%s: submit irq_in urb failed %d", __func__
, err
);
567 usb_wwan_setup_urbs(serial
);
571 for (j
= 0; j
< N_OUT_URB
; j
++)
572 kfree(portdata
->out_buffer
[j
]);
574 for (j
= 0; j
< N_IN_URB
; j
++)
575 if (portdata
->in_buffer
[j
])
576 free_page((unsigned long)portdata
->in_buffer
[j
]);
580 EXPORT_SYMBOL(usb_wwan_startup
);
582 static void stop_read_write_urbs(struct usb_serial
*serial
)
585 struct usb_serial_port
*port
;
586 struct usb_wwan_port_private
*portdata
;
588 /* Stop reading/writing urbs */
589 for (i
= 0; i
< serial
->num_ports
; ++i
) {
590 port
= serial
->port
[i
];
591 portdata
= usb_get_serial_port_data(port
);
592 for (j
= 0; j
< N_IN_URB
; j
++)
593 usb_kill_urb(portdata
->in_urbs
[j
]);
594 for (j
= 0; j
< N_OUT_URB
; j
++)
595 usb_kill_urb(portdata
->out_urbs
[j
]);
599 void usb_wwan_disconnect(struct usb_serial
*serial
)
603 stop_read_write_urbs(serial
);
605 EXPORT_SYMBOL(usb_wwan_disconnect
);
607 void usb_wwan_release(struct usb_serial
*serial
)
610 struct usb_serial_port
*port
;
611 struct usb_wwan_port_private
*portdata
;
616 for (i
= 0; i
< serial
->num_ports
; ++i
) {
617 port
= serial
->port
[i
];
618 portdata
= usb_get_serial_port_data(port
);
620 for (j
= 0; j
< N_IN_URB
; j
++) {
621 usb_free_urb(portdata
->in_urbs
[j
]);
622 free_page((unsigned long)
623 portdata
->in_buffer
[j
]);
624 portdata
->in_urbs
[j
] = NULL
;
626 for (j
= 0; j
< N_OUT_URB
; j
++) {
627 usb_free_urb(portdata
->out_urbs
[j
]);
628 kfree(portdata
->out_buffer
[j
]);
629 portdata
->out_urbs
[j
] = NULL
;
633 /* Now free per port private data */
634 for (i
= 0; i
< serial
->num_ports
; i
++) {
635 port
= serial
->port
[i
];
636 kfree(usb_get_serial_port_data(port
));
639 EXPORT_SYMBOL(usb_wwan_release
);
642 int usb_wwan_suspend(struct usb_serial
*serial
, pm_message_t message
)
644 struct usb_wwan_intf_private
*intfdata
= serial
->private;
647 dbg("%s entered", __func__
);
649 if (message
.event
& PM_EVENT_AUTO
) {
650 spin_lock_irq(&intfdata
->susp_lock
);
651 b
= intfdata
->in_flight
;
652 spin_unlock_irq(&intfdata
->susp_lock
);
658 spin_lock_irq(&intfdata
->susp_lock
);
659 intfdata
->suspended
= 1;
660 spin_unlock_irq(&intfdata
->susp_lock
);
661 stop_read_write_urbs(serial
);
665 EXPORT_SYMBOL(usb_wwan_suspend
);
667 static void unbusy_queued_urb(struct urb
*urb
, struct usb_wwan_port_private
*portdata
)
671 for (i
= 0; i
< N_OUT_URB
; i
++) {
672 if (urb
== portdata
->out_urbs
[i
]) {
673 clear_bit(i
, &portdata
->out_busy
);
679 static void play_delayed(struct usb_serial_port
*port
)
681 struct usb_wwan_intf_private
*data
;
682 struct usb_wwan_port_private
*portdata
;
686 portdata
= usb_get_serial_port_data(port
);
687 data
= port
->serial
->private;
688 while ((urb
= usb_get_from_anchor(&portdata
->delayed
))) {
689 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
693 /* we have to throw away the rest */
695 unbusy_queued_urb(urb
, portdata
);
697 atomic_dec(&port
->serial
->interface
->dev
.power
.usage_count
);
698 } while ((urb
= usb_get_from_anchor(&portdata
->delayed
)));
704 int usb_wwan_resume(struct usb_serial
*serial
)
707 struct usb_serial_port
*port
;
708 struct usb_wwan_intf_private
*intfdata
= serial
->private;
709 struct usb_wwan_port_private
*portdata
;
713 dbg("%s entered", __func__
);
714 /* get the interrupt URBs resubmitted unconditionally */
715 for (i
= 0; i
< serial
->num_ports
; i
++) {
716 port
= serial
->port
[i
];
717 if (!port
->interrupt_in_urb
) {
718 dbg("%s: No interrupt URB for port %d", __func__
, i
);
721 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_NOIO
);
722 dbg("Submitted interrupt URB for port %d (result %d)", i
, err
);
724 err("%s: Error %d for interrupt URB of port%d",
730 for (i
= 0; i
< serial
->num_ports
; i
++) {
732 port
= serial
->port
[i
];
733 portdata
= usb_get_serial_port_data(port
);
735 /* skip closed ports */
736 spin_lock_irq(&intfdata
->susp_lock
);
737 if (!portdata
->opened
) {
738 spin_unlock_irq(&intfdata
->susp_lock
);
742 for (j
= 0; j
< N_IN_URB
; j
++) {
743 urb
= portdata
->in_urbs
[j
];
744 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
746 err("%s: Error %d for bulk URB %d",
748 spin_unlock_irq(&intfdata
->susp_lock
);
753 spin_unlock_irq(&intfdata
->susp_lock
);
755 spin_lock_irq(&intfdata
->susp_lock
);
756 intfdata
->suspended
= 0;
757 spin_unlock_irq(&intfdata
->susp_lock
);
761 EXPORT_SYMBOL(usb_wwan_resume
);
764 MODULE_AUTHOR(DRIVER_AUTHOR
);
765 MODULE_DESCRIPTION(DRIVER_DESC
);
766 MODULE_VERSION(DRIVER_VERSION
);
767 MODULE_LICENSE("GPL");
769 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
770 MODULE_PARM_DESC(debug
, "Debug messages");