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
,
268 portdata
->tx_start_time
[i
] = jiffies
;
274 dbg("%s: wrote (did %d)", __func__
, count
);
277 EXPORT_SYMBOL(usb_wwan_write
);
279 static void usb_wwan_indat_callback(struct urb
*urb
)
283 struct usb_serial_port
*port
;
284 struct tty_struct
*tty
;
285 unsigned char *data
= urb
->transfer_buffer
;
286 int status
= urb
->status
;
288 dbg("%s: %p", __func__
, urb
);
290 endpoint
= usb_pipeendpoint(urb
->pipe
);
294 dbg("%s: nonzero status: %d on endpoint %02x.",
295 __func__
, status
, endpoint
);
297 tty
= tty_port_tty_get(&port
->port
);
298 if (urb
->actual_length
) {
299 tty_insert_flip_string(tty
, data
, urb
->actual_length
);
300 tty_flip_buffer_push(tty
);
302 dbg("%s: empty read urb received", __func__
);
305 /* Resubmit urb so we continue receiving */
306 if (status
!= -ESHUTDOWN
) {
307 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
310 printk(KERN_ERR
"%s: resubmit read urb failed. "
311 "(%d)", __func__
, err
);
312 /* busy also in error unless we are killed */
313 usb_mark_last_busy(port
->serial
->dev
);
316 usb_mark_last_busy(port
->serial
->dev
);
323 static void usb_wwan_outdat_callback(struct urb
*urb
)
325 struct usb_serial_port
*port
;
326 struct usb_wwan_port_private
*portdata
;
327 struct usb_wwan_intf_private
*intfdata
;
333 intfdata
= port
->serial
->private;
335 usb_serial_port_softint(port
);
336 usb_autopm_put_interface_async(port
->serial
->interface
);
337 portdata
= usb_get_serial_port_data(port
);
338 spin_lock(&intfdata
->susp_lock
);
339 intfdata
->in_flight
--;
340 spin_unlock(&intfdata
->susp_lock
);
342 for (i
= 0; i
< N_OUT_URB
; ++i
) {
343 if (portdata
->out_urbs
[i
] == urb
) {
344 smp_mb__before_clear_bit();
345 clear_bit(i
, &portdata
->out_busy
);
351 int usb_wwan_write_room(struct tty_struct
*tty
)
353 struct usb_serial_port
*port
= tty
->driver_data
;
354 struct usb_wwan_port_private
*portdata
;
357 struct urb
*this_urb
;
359 portdata
= usb_get_serial_port_data(port
);
361 for (i
= 0; i
< N_OUT_URB
; i
++) {
362 this_urb
= portdata
->out_urbs
[i
];
363 if (this_urb
&& !test_bit(i
, &portdata
->out_busy
))
364 data_len
+= OUT_BUFLEN
;
367 dbg("%s: %d", __func__
, data_len
);
370 EXPORT_SYMBOL(usb_wwan_write_room
);
372 int usb_wwan_chars_in_buffer(struct tty_struct
*tty
)
374 struct usb_serial_port
*port
= tty
->driver_data
;
375 struct usb_wwan_port_private
*portdata
;
378 struct urb
*this_urb
;
380 portdata
= usb_get_serial_port_data(port
);
382 for (i
= 0; i
< N_OUT_URB
; i
++) {
383 this_urb
= portdata
->out_urbs
[i
];
384 /* FIXME: This locking is insufficient as this_urb may
385 go unused during the test */
386 if (this_urb
&& test_bit(i
, &portdata
->out_busy
))
387 data_len
+= this_urb
->transfer_buffer_length
;
389 dbg("%s: %d", __func__
, data_len
);
392 EXPORT_SYMBOL(usb_wwan_chars_in_buffer
);
394 int usb_wwan_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
396 struct usb_wwan_port_private
*portdata
;
397 struct usb_wwan_intf_private
*intfdata
;
398 struct usb_serial
*serial
= port
->serial
;
402 portdata
= usb_get_serial_port_data(port
);
403 intfdata
= serial
->private;
407 /* Start reading from the IN endpoint */
408 for (i
= 0; i
< N_IN_URB
; i
++) {
409 urb
= portdata
->in_urbs
[i
];
412 err
= usb_submit_urb(urb
, GFP_KERNEL
);
414 dbg("%s: submit urb %d failed (%d) %d",
415 __func__
, i
, err
, urb
->transfer_buffer_length
);
419 if (intfdata
->send_setup
)
420 intfdata
->send_setup(port
);
422 serial
->interface
->needs_remote_wakeup
= 1;
423 spin_lock_irq(&intfdata
->susp_lock
);
424 portdata
->opened
= 1;
425 spin_unlock_irq(&intfdata
->susp_lock
);
426 usb_autopm_put_interface(serial
->interface
);
430 EXPORT_SYMBOL(usb_wwan_open
);
432 void usb_wwan_close(struct usb_serial_port
*port
)
435 struct usb_serial
*serial
= port
->serial
;
436 struct usb_wwan_port_private
*portdata
;
437 struct usb_wwan_intf_private
*intfdata
= port
->serial
->private;
440 portdata
= usb_get_serial_port_data(port
);
443 /* Stop reading/writing urbs */
444 spin_lock_irq(&intfdata
->susp_lock
);
445 portdata
->opened
= 0;
446 spin_unlock_irq(&intfdata
->susp_lock
);
448 for (i
= 0; i
< N_IN_URB
; i
++)
449 usb_kill_urb(portdata
->in_urbs
[i
]);
450 for (i
= 0; i
< N_OUT_URB
; i
++)
451 usb_kill_urb(portdata
->out_urbs
[i
]);
452 usb_autopm_get_interface(serial
->interface
);
453 serial
->interface
->needs_remote_wakeup
= 0;
456 EXPORT_SYMBOL(usb_wwan_close
);
458 /* Helper functions used by usb_wwan_setup_urbs */
459 static struct urb
*usb_wwan_setup_urb(struct usb_serial
*serial
, int endpoint
,
460 int dir
, void *ctx
, char *buf
, int len
,
461 void (*callback
) (struct urb
*))
466 return NULL
; /* endpoint not needed */
468 urb
= usb_alloc_urb(0, GFP_KERNEL
); /* No ISO */
470 dbg("%s: alloc for endpoint %d failed.", __func__
, endpoint
);
474 /* Fill URB using supplied data. */
475 usb_fill_bulk_urb(urb
, serial
->dev
,
476 usb_sndbulkpipe(serial
->dev
, endpoint
) | dir
,
477 buf
, len
, callback
, ctx
);
483 static void usb_wwan_setup_urbs(struct usb_serial
*serial
)
486 struct usb_serial_port
*port
;
487 struct usb_wwan_port_private
*portdata
;
491 for (i
= 0; i
< serial
->num_ports
; i
++) {
492 port
= serial
->port
[i
];
493 portdata
= usb_get_serial_port_data(port
);
495 /* Do indat endpoints first */
496 for (j
= 0; j
< N_IN_URB
; ++j
) {
497 portdata
->in_urbs
[j
] = usb_wwan_setup_urb(serial
,
499 bulk_in_endpointAddress
,
505 usb_wwan_indat_callback
);
508 /* outdat endpoints */
509 for (j
= 0; j
< N_OUT_URB
; ++j
) {
510 portdata
->out_urbs
[j
] = usb_wwan_setup_urb(serial
,
512 bulk_out_endpointAddress
,
519 usb_wwan_outdat_callback
);
524 int usb_wwan_startup(struct usb_serial
*serial
)
527 struct usb_serial_port
*port
;
528 struct usb_wwan_port_private
*portdata
;
533 /* Now setup per port private data */
534 for (i
= 0; i
< serial
->num_ports
; i
++) {
535 port
= serial
->port
[i
];
536 portdata
= kzalloc(sizeof(*portdata
), GFP_KERNEL
);
538 dbg("%s: kmalloc for usb_wwan_port_private (%d) failed!.",
542 init_usb_anchor(&portdata
->delayed
);
544 for (j
= 0; j
< N_IN_URB
; j
++) {
545 buffer
= (u8
*) __get_free_page(GFP_KERNEL
);
548 portdata
->in_buffer
[j
] = buffer
;
551 for (j
= 0; j
< N_OUT_URB
; j
++) {
552 buffer
= kmalloc(OUT_BUFLEN
, GFP_KERNEL
);
554 goto bail_out_error2
;
555 portdata
->out_buffer
[j
] = buffer
;
558 usb_set_serial_port_data(port
, portdata
);
560 if (!port
->interrupt_in_urb
)
562 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
564 dbg("%s: submit irq_in urb failed %d", __func__
, err
);
566 usb_wwan_setup_urbs(serial
);
570 for (j
= 0; j
< N_OUT_URB
; j
++)
571 kfree(portdata
->out_buffer
[j
]);
573 for (j
= 0; j
< N_IN_URB
; j
++)
574 if (portdata
->in_buffer
[j
])
575 free_page((unsigned long)portdata
->in_buffer
[j
]);
579 EXPORT_SYMBOL(usb_wwan_startup
);
581 static void stop_read_write_urbs(struct usb_serial
*serial
)
584 struct usb_serial_port
*port
;
585 struct usb_wwan_port_private
*portdata
;
587 /* Stop reading/writing urbs */
588 for (i
= 0; i
< serial
->num_ports
; ++i
) {
589 port
= serial
->port
[i
];
590 portdata
= usb_get_serial_port_data(port
);
591 for (j
= 0; j
< N_IN_URB
; j
++)
592 usb_kill_urb(portdata
->in_urbs
[j
]);
593 for (j
= 0; j
< N_OUT_URB
; j
++)
594 usb_kill_urb(portdata
->out_urbs
[j
]);
598 void usb_wwan_disconnect(struct usb_serial
*serial
)
602 stop_read_write_urbs(serial
);
604 EXPORT_SYMBOL(usb_wwan_disconnect
);
606 void usb_wwan_release(struct usb_serial
*serial
)
609 struct usb_serial_port
*port
;
610 struct usb_wwan_port_private
*portdata
;
615 for (i
= 0; i
< serial
->num_ports
; ++i
) {
616 port
= serial
->port
[i
];
617 portdata
= usb_get_serial_port_data(port
);
619 for (j
= 0; j
< N_IN_URB
; j
++) {
620 usb_free_urb(portdata
->in_urbs
[j
]);
621 free_page((unsigned long)
622 portdata
->in_buffer
[j
]);
623 portdata
->in_urbs
[j
] = NULL
;
625 for (j
= 0; j
< N_OUT_URB
; j
++) {
626 usb_free_urb(portdata
->out_urbs
[j
]);
627 kfree(portdata
->out_buffer
[j
]);
628 portdata
->out_urbs
[j
] = NULL
;
632 /* Now free per port private data */
633 for (i
= 0; i
< serial
->num_ports
; i
++) {
634 port
= serial
->port
[i
];
635 kfree(usb_get_serial_port_data(port
));
638 EXPORT_SYMBOL(usb_wwan_release
);
641 int usb_wwan_suspend(struct usb_serial
*serial
, pm_message_t message
)
643 struct usb_wwan_intf_private
*intfdata
= serial
->private;
646 dbg("%s entered", __func__
);
648 if (message
.event
& PM_EVENT_AUTO
) {
649 spin_lock_irq(&intfdata
->susp_lock
);
650 b
= intfdata
->in_flight
;
651 spin_unlock_irq(&intfdata
->susp_lock
);
657 spin_lock_irq(&intfdata
->susp_lock
);
658 intfdata
->suspended
= 1;
659 spin_unlock_irq(&intfdata
->susp_lock
);
660 stop_read_write_urbs(serial
);
664 EXPORT_SYMBOL(usb_wwan_suspend
);
666 static void play_delayed(struct usb_serial_port
*port
)
668 struct usb_wwan_intf_private
*data
;
669 struct usb_wwan_port_private
*portdata
;
673 portdata
= usb_get_serial_port_data(port
);
674 data
= port
->serial
->private;
675 while ((urb
= usb_get_from_anchor(&portdata
->delayed
))) {
676 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
682 int usb_wwan_resume(struct usb_serial
*serial
)
685 struct usb_serial_port
*port
;
686 struct usb_wwan_intf_private
*intfdata
= serial
->private;
687 struct usb_wwan_port_private
*portdata
;
691 dbg("%s entered", __func__
);
692 /* get the interrupt URBs resubmitted unconditionally */
693 for (i
= 0; i
< serial
->num_ports
; i
++) {
694 port
= serial
->port
[i
];
695 if (!port
->interrupt_in_urb
) {
696 dbg("%s: No interrupt URB for port %d", __func__
, i
);
699 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_NOIO
);
700 dbg("Submitted interrupt URB for port %d (result %d)", i
, err
);
702 err("%s: Error %d for interrupt URB of port%d",
708 for (i
= 0; i
< serial
->num_ports
; i
++) {
710 port
= serial
->port
[i
];
711 portdata
= usb_get_serial_port_data(port
);
713 /* skip closed ports */
714 spin_lock_irq(&intfdata
->susp_lock
);
715 if (!portdata
->opened
) {
716 spin_unlock_irq(&intfdata
->susp_lock
);
720 for (j
= 0; j
< N_IN_URB
; j
++) {
721 urb
= portdata
->in_urbs
[j
];
722 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
724 err("%s: Error %d for bulk URB %d",
726 spin_unlock_irq(&intfdata
->susp_lock
);
731 spin_unlock_irq(&intfdata
->susp_lock
);
733 spin_lock_irq(&intfdata
->susp_lock
);
734 intfdata
->suspended
= 0;
735 spin_unlock_irq(&intfdata
->susp_lock
);
739 EXPORT_SYMBOL(usb_wwan_resume
);
742 MODULE_AUTHOR(DRIVER_AUTHOR
);
743 MODULE_DESCRIPTION(DRIVER_DESC
);
744 MODULE_VERSION(DRIVER_VERSION
);
745 MODULE_LICENSE("GPL");
747 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
748 MODULE_PARM_DESC(debug
, "Debug messages");