]>
git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - drivers/usb/serial/usb_wwan.c
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
)
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
,
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
);
308 if (err
&& err
!= -EPERM
)
309 printk(KERN_ERR
"%s: resubmit read urb failed. "
310 "(%d)", __func__
, err
);
312 usb_mark_last_busy(port
->serial
->dev
);
318 static void usb_wwan_outdat_callback(struct urb
*urb
)
320 struct usb_serial_port
*port
;
321 struct usb_wwan_port_private
*portdata
;
322 struct usb_wwan_intf_private
*intfdata
;
328 intfdata
= port
->serial
->private;
330 usb_serial_port_softint(port
);
331 usb_autopm_put_interface_async(port
->serial
->interface
);
332 portdata
= usb_get_serial_port_data(port
);
333 spin_lock(&intfdata
->susp_lock
);
334 intfdata
->in_flight
--;
335 spin_unlock(&intfdata
->susp_lock
);
337 for (i
= 0; i
< N_OUT_URB
; ++i
) {
338 if (portdata
->out_urbs
[i
] == urb
) {
339 smp_mb__before_clear_bit();
340 clear_bit(i
, &portdata
->out_busy
);
346 int usb_wwan_write_room(struct tty_struct
*tty
)
348 struct usb_serial_port
*port
= tty
->driver_data
;
349 struct usb_wwan_port_private
*portdata
;
352 struct urb
*this_urb
;
354 portdata
= usb_get_serial_port_data(port
);
356 for (i
= 0; i
< N_OUT_URB
; i
++) {
357 this_urb
= portdata
->out_urbs
[i
];
358 if (this_urb
&& !test_bit(i
, &portdata
->out_busy
))
359 data_len
+= OUT_BUFLEN
;
362 dbg("%s: %d", __func__
, data_len
);
365 EXPORT_SYMBOL(usb_wwan_write_room
);
367 int usb_wwan_chars_in_buffer(struct tty_struct
*tty
)
369 struct usb_serial_port
*port
= tty
->driver_data
;
370 struct usb_wwan_port_private
*portdata
;
373 struct urb
*this_urb
;
375 portdata
= usb_get_serial_port_data(port
);
377 for (i
= 0; i
< N_OUT_URB
; i
++) {
378 this_urb
= portdata
->out_urbs
[i
];
379 /* FIXME: This locking is insufficient as this_urb may
380 go unused during the test */
381 if (this_urb
&& test_bit(i
, &portdata
->out_busy
))
382 data_len
+= this_urb
->transfer_buffer_length
;
384 dbg("%s: %d", __func__
, data_len
);
387 EXPORT_SYMBOL(usb_wwan_chars_in_buffer
);
389 int usb_wwan_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
391 struct usb_wwan_port_private
*portdata
;
392 struct usb_wwan_intf_private
*intfdata
;
393 struct usb_serial
*serial
= port
->serial
;
397 portdata
= usb_get_serial_port_data(port
);
398 intfdata
= serial
->private;
402 /* Start reading from the IN endpoint */
403 for (i
= 0; i
< N_IN_URB
; i
++) {
404 urb
= portdata
->in_urbs
[i
];
407 err
= usb_submit_urb(urb
, GFP_KERNEL
);
409 dbg("%s: submit urb %d failed (%d) %d",
410 __func__
, i
, err
, urb
->transfer_buffer_length
);
414 if (intfdata
->send_setup
)
415 intfdata
->send_setup(port
);
417 serial
->interface
->needs_remote_wakeup
= 1;
418 spin_lock_irq(&intfdata
->susp_lock
);
419 portdata
->opened
= 1;
420 spin_unlock_irq(&intfdata
->susp_lock
);
421 usb_autopm_put_interface(serial
->interface
);
425 EXPORT_SYMBOL(usb_wwan_open
);
427 void usb_wwan_close(struct usb_serial_port
*port
)
430 struct usb_serial
*serial
= port
->serial
;
431 struct usb_wwan_port_private
*portdata
;
432 struct usb_wwan_intf_private
*intfdata
= port
->serial
->private;
435 portdata
= usb_get_serial_port_data(port
);
438 /* Stop reading/writing urbs */
439 spin_lock_irq(&intfdata
->susp_lock
);
440 portdata
->opened
= 0;
441 spin_unlock_irq(&intfdata
->susp_lock
);
443 for (i
= 0; i
< N_IN_URB
; i
++)
444 usb_kill_urb(portdata
->in_urbs
[i
]);
445 for (i
= 0; i
< N_OUT_URB
; i
++)
446 usb_kill_urb(portdata
->out_urbs
[i
]);
447 usb_autopm_get_interface(serial
->interface
);
448 serial
->interface
->needs_remote_wakeup
= 0;
451 EXPORT_SYMBOL(usb_wwan_close
);
453 /* Helper functions used by usb_wwan_setup_urbs */
454 static struct urb
*usb_wwan_setup_urb(struct usb_serial
*serial
, int endpoint
,
455 int dir
, void *ctx
, char *buf
, int len
,
456 void (*callback
) (struct urb
*))
461 return NULL
; /* endpoint not needed */
463 urb
= usb_alloc_urb(0, GFP_KERNEL
); /* No ISO */
465 dbg("%s: alloc for endpoint %d failed.", __func__
, endpoint
);
469 /* Fill URB using supplied data. */
470 usb_fill_bulk_urb(urb
, serial
->dev
,
471 usb_sndbulkpipe(serial
->dev
, endpoint
) | dir
,
472 buf
, len
, callback
, ctx
);
478 static void usb_wwan_setup_urbs(struct usb_serial
*serial
)
481 struct usb_serial_port
*port
;
482 struct usb_wwan_port_private
*portdata
;
486 for (i
= 0; i
< serial
->num_ports
; i
++) {
487 port
= serial
->port
[i
];
488 portdata
= usb_get_serial_port_data(port
);
490 /* Do indat endpoints first */
491 for (j
= 0; j
< N_IN_URB
; ++j
) {
492 portdata
->in_urbs
[j
] = usb_wwan_setup_urb(serial
,
494 bulk_in_endpointAddress
,
500 usb_wwan_indat_callback
);
503 /* outdat endpoints */
504 for (j
= 0; j
< N_OUT_URB
; ++j
) {
505 portdata
->out_urbs
[j
] = usb_wwan_setup_urb(serial
,
507 bulk_out_endpointAddress
,
514 usb_wwan_outdat_callback
);
519 int usb_wwan_startup(struct usb_serial
*serial
)
522 struct usb_serial_port
*port
;
523 struct usb_wwan_port_private
*portdata
;
528 /* Now setup per port private data */
529 for (i
= 0; i
< serial
->num_ports
; i
++) {
530 port
= serial
->port
[i
];
531 portdata
= kzalloc(sizeof(*portdata
), GFP_KERNEL
);
533 dbg("%s: kmalloc for usb_wwan_port_private (%d) failed!.",
537 init_usb_anchor(&portdata
->delayed
);
539 for (j
= 0; j
< N_IN_URB
; j
++) {
540 buffer
= (u8
*) __get_free_page(GFP_KERNEL
);
543 portdata
->in_buffer
[j
] = buffer
;
546 for (j
= 0; j
< N_OUT_URB
; j
++) {
547 buffer
= kmalloc(OUT_BUFLEN
, GFP_KERNEL
);
549 goto bail_out_error2
;
550 portdata
->out_buffer
[j
] = buffer
;
553 usb_set_serial_port_data(port
, portdata
);
555 if (!port
->interrupt_in_urb
)
557 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
559 dbg("%s: submit irq_in urb failed %d", __func__
, err
);
561 usb_wwan_setup_urbs(serial
);
565 for (j
= 0; j
< N_OUT_URB
; j
++)
566 kfree(portdata
->out_buffer
[j
]);
568 for (j
= 0; j
< N_IN_URB
; j
++)
569 if (portdata
->in_buffer
[j
])
570 free_page((unsigned long)portdata
->in_buffer
[j
]);
574 EXPORT_SYMBOL(usb_wwan_startup
);
576 static void stop_read_write_urbs(struct usb_serial
*serial
)
579 struct usb_serial_port
*port
;
580 struct usb_wwan_port_private
*portdata
;
582 /* Stop reading/writing urbs */
583 for (i
= 0; i
< serial
->num_ports
; ++i
) {
584 port
= serial
->port
[i
];
585 portdata
= usb_get_serial_port_data(port
);
586 for (j
= 0; j
< N_IN_URB
; j
++)
587 usb_kill_urb(portdata
->in_urbs
[j
]);
588 for (j
= 0; j
< N_OUT_URB
; j
++)
589 usb_kill_urb(portdata
->out_urbs
[j
]);
593 void usb_wwan_disconnect(struct usb_serial
*serial
)
597 stop_read_write_urbs(serial
);
599 EXPORT_SYMBOL(usb_wwan_disconnect
);
601 void usb_wwan_release(struct usb_serial
*serial
)
604 struct usb_serial_port
*port
;
605 struct usb_wwan_port_private
*portdata
;
610 for (i
= 0; i
< serial
->num_ports
; ++i
) {
611 port
= serial
->port
[i
];
612 portdata
= usb_get_serial_port_data(port
);
614 for (j
= 0; j
< N_IN_URB
; j
++) {
615 usb_free_urb(portdata
->in_urbs
[j
]);
616 free_page((unsigned long)
617 portdata
->in_buffer
[j
]);
618 portdata
->in_urbs
[j
] = NULL
;
620 for (j
= 0; j
< N_OUT_URB
; j
++) {
621 usb_free_urb(portdata
->out_urbs
[j
]);
622 kfree(portdata
->out_buffer
[j
]);
623 portdata
->out_urbs
[j
] = NULL
;
627 /* Now free per port private data */
628 for (i
= 0; i
< serial
->num_ports
; i
++) {
629 port
= serial
->port
[i
];
630 kfree(usb_get_serial_port_data(port
));
633 EXPORT_SYMBOL(usb_wwan_release
);
636 int usb_wwan_suspend(struct usb_serial
*serial
, pm_message_t message
)
638 struct usb_wwan_intf_private
*intfdata
= serial
->private;
641 dbg("%s entered", __func__
);
643 if (message
.event
& PM_EVENT_AUTO
) {
644 spin_lock_irq(&intfdata
->susp_lock
);
645 b
= intfdata
->in_flight
;
646 spin_unlock_irq(&intfdata
->susp_lock
);
652 spin_lock_irq(&intfdata
->susp_lock
);
653 intfdata
->suspended
= 1;
654 spin_unlock_irq(&intfdata
->susp_lock
);
655 stop_read_write_urbs(serial
);
659 EXPORT_SYMBOL(usb_wwan_suspend
);
661 static void play_delayed(struct usb_serial_port
*port
)
663 struct usb_wwan_intf_private
*data
;
664 struct usb_wwan_port_private
*portdata
;
668 portdata
= usb_get_serial_port_data(port
);
669 data
= port
->serial
->private;
670 while ((urb
= usb_get_from_anchor(&portdata
->delayed
))) {
671 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
677 int usb_wwan_resume(struct usb_serial
*serial
)
680 struct usb_serial_port
*port
;
681 struct usb_wwan_intf_private
*intfdata
= serial
->private;
682 struct usb_wwan_port_private
*portdata
;
686 dbg("%s entered", __func__
);
687 /* get the interrupt URBs resubmitted unconditionally */
688 for (i
= 0; i
< serial
->num_ports
; i
++) {
689 port
= serial
->port
[i
];
690 if (!port
->interrupt_in_urb
) {
691 dbg("%s: No interrupt URB for port %d", __func__
, i
);
694 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_NOIO
);
695 dbg("Submitted interrupt URB for port %d (result %d)", i
, err
);
697 err("%s: Error %d for interrupt URB of port%d",
703 for (i
= 0; i
< serial
->num_ports
; i
++) {
705 port
= serial
->port
[i
];
706 portdata
= usb_get_serial_port_data(port
);
708 /* skip closed ports */
709 spin_lock_irq(&intfdata
->susp_lock
);
710 if (!portdata
->opened
) {
711 spin_unlock_irq(&intfdata
->susp_lock
);
715 for (j
= 0; j
< N_IN_URB
; j
++) {
716 urb
= portdata
->in_urbs
[j
];
717 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
719 err("%s: Error %d for bulk URB %d",
721 spin_unlock_irq(&intfdata
->susp_lock
);
726 spin_unlock_irq(&intfdata
->susp_lock
);
728 spin_lock_irq(&intfdata
->susp_lock
);
729 intfdata
->suspended
= 0;
730 spin_unlock_irq(&intfdata
->susp_lock
);
734 EXPORT_SYMBOL(usb_wwan_resume
);
737 MODULE_AUTHOR(DRIVER_AUTHOR
);
738 MODULE_DESCRIPTION(DRIVER_DESC
);
739 MODULE_VERSION(DRIVER_VERSION
);
740 MODULE_LICENSE("GPL");
742 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
743 MODULE_PARM_DESC(debug
, "Debug messages");