7d0811335b9a96491dc48fbdb3d7bbfd4fa35733
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
;
46 struct usb_wwan_intf_private
*intfdata
;
48 intfdata
= port
->serial
->private;
50 if (!intfdata
->send_setup
)
53 portdata
= usb_get_serial_port_data(port
);
54 mutex_lock(&serial
->disc_mutex
);
55 portdata
->rts_state
= on
;
56 portdata
->dtr_state
= on
;
58 intfdata
->send_setup(port
);
59 mutex_unlock(&serial
->disc_mutex
);
61 EXPORT_SYMBOL(usb_wwan_dtr_rts
);
63 void usb_wwan_set_termios(struct tty_struct
*tty
,
64 struct usb_serial_port
*port
,
65 struct ktermios
*old_termios
)
67 struct usb_wwan_intf_private
*intfdata
= port
->serial
->private;
69 /* Doesn't support option setting */
70 tty_termios_copy_hw(tty
->termios
, old_termios
);
72 if (intfdata
->send_setup
)
73 intfdata
->send_setup(port
);
75 EXPORT_SYMBOL(usb_wwan_set_termios
);
77 int usb_wwan_tiocmget(struct tty_struct
*tty
)
79 struct usb_serial_port
*port
= tty
->driver_data
;
81 struct usb_wwan_port_private
*portdata
;
83 portdata
= usb_get_serial_port_data(port
);
85 value
= ((portdata
->rts_state
) ? TIOCM_RTS
: 0) |
86 ((portdata
->dtr_state
) ? TIOCM_DTR
: 0) |
87 ((portdata
->cts_state
) ? TIOCM_CTS
: 0) |
88 ((portdata
->dsr_state
) ? TIOCM_DSR
: 0) |
89 ((portdata
->dcd_state
) ? TIOCM_CAR
: 0) |
90 ((portdata
->ri_state
) ? TIOCM_RNG
: 0);
94 EXPORT_SYMBOL(usb_wwan_tiocmget
);
96 int usb_wwan_tiocmset(struct tty_struct
*tty
,
97 unsigned int set
, unsigned int clear
)
99 struct usb_serial_port
*port
= tty
->driver_data
;
100 struct usb_wwan_port_private
*portdata
;
101 struct usb_wwan_intf_private
*intfdata
;
103 portdata
= usb_get_serial_port_data(port
);
104 intfdata
= port
->serial
->private;
106 if (!intfdata
->send_setup
)
109 /* FIXME: what locks portdata fields ? */
111 portdata
->rts_state
= 1;
113 portdata
->dtr_state
= 1;
115 if (clear
& TIOCM_RTS
)
116 portdata
->rts_state
= 0;
117 if (clear
& TIOCM_DTR
)
118 portdata
->dtr_state
= 0;
119 return intfdata
->send_setup(port
);
121 EXPORT_SYMBOL(usb_wwan_tiocmset
);
123 static int get_serial_info(struct usb_serial_port
*port
,
124 struct serial_struct __user
*retinfo
)
126 struct serial_struct tmp
;
131 memset(&tmp
, 0, sizeof(tmp
));
132 tmp
.line
= port
->serial
->minor
;
133 tmp
.port
= port
->number
;
134 tmp
.baud_base
= tty_get_baud_rate(port
->port
.tty
);
135 tmp
.close_delay
= port
->port
.close_delay
/ 10;
136 tmp
.closing_wait
= port
->port
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
137 ASYNC_CLOSING_WAIT_NONE
:
138 port
->port
.closing_wait
/ 10;
140 if (copy_to_user(retinfo
, &tmp
, sizeof(*retinfo
)))
145 static int set_serial_info(struct usb_serial_port
*port
,
146 struct serial_struct __user
*newinfo
)
148 struct serial_struct new_serial
;
149 unsigned int closing_wait
, close_delay
;
152 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
155 close_delay
= new_serial
.close_delay
* 10;
156 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
157 ASYNC_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
159 mutex_lock(&port
->port
.mutex
);
161 if (!capable(CAP_SYS_ADMIN
)) {
162 if ((close_delay
!= port
->port
.close_delay
) ||
163 (closing_wait
!= port
->port
.closing_wait
))
166 retval
= -EOPNOTSUPP
;
168 port
->port
.close_delay
= close_delay
;
169 port
->port
.closing_wait
= closing_wait
;
172 mutex_unlock(&port
->port
.mutex
);
176 int usb_wwan_ioctl(struct tty_struct
*tty
,
177 unsigned int cmd
, unsigned long arg
)
179 struct usb_serial_port
*port
= tty
->driver_data
;
181 dbg("%s cmd 0x%04x", __func__
, cmd
);
185 return get_serial_info(port
,
186 (struct serial_struct __user
*) arg
);
188 return set_serial_info(port
,
189 (struct serial_struct __user
*) arg
);
194 dbg("%s arg not supported", __func__
);
198 EXPORT_SYMBOL(usb_wwan_ioctl
);
201 int usb_wwan_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
202 const unsigned char *buf
, int count
)
204 struct usb_wwan_port_private
*portdata
;
205 struct usb_wwan_intf_private
*intfdata
;
208 struct urb
*this_urb
= NULL
; /* spurious */
212 portdata
= usb_get_serial_port_data(port
);
213 intfdata
= port
->serial
->private;
215 dbg("%s: write (%d chars)", __func__
, count
);
219 for (i
= 0; left
> 0 && i
< N_OUT_URB
; i
++) {
221 if (todo
> OUT_BUFLEN
)
224 this_urb
= portdata
->out_urbs
[i
];
225 if (test_and_set_bit(i
, &portdata
->out_busy
)) {
226 if (time_before(jiffies
,
227 portdata
->tx_start_time
[i
] + 10 * HZ
))
229 usb_unlink_urb(this_urb
);
232 dbg("%s: endpoint %d buf %d", __func__
,
233 usb_pipeendpoint(this_urb
->pipe
), i
);
235 err
= usb_autopm_get_interface_async(port
->serial
->interface
);
240 memcpy(this_urb
->transfer_buffer
, buf
, todo
);
241 this_urb
->transfer_buffer_length
= todo
;
243 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
244 if (intfdata
->suspended
) {
245 usb_anchor_urb(this_urb
, &portdata
->delayed
);
246 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
248 intfdata
->in_flight
++;
249 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
250 err
= usb_submit_urb(this_urb
, GFP_ATOMIC
);
252 dbg("usb_submit_urb %p (write bulk) failed "
253 "(%d)", this_urb
, err
);
254 clear_bit(i
, &portdata
->out_busy
);
255 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
256 intfdata
->in_flight
--;
257 spin_unlock_irqrestore(&intfdata
->susp_lock
,
259 usb_autopm_put_interface_async(port
->serial
->interface
);
264 portdata
->tx_start_time
[i
] = jiffies
;
270 dbg("%s: wrote (did %d)", __func__
, count
);
273 EXPORT_SYMBOL(usb_wwan_write
);
275 static void usb_wwan_indat_callback(struct urb
*urb
)
279 struct usb_serial_port
*port
;
280 struct tty_struct
*tty
;
281 unsigned char *data
= urb
->transfer_buffer
;
282 int status
= urb
->status
;
284 endpoint
= usb_pipeendpoint(urb
->pipe
);
288 dbg("%s: nonzero status: %d on endpoint %02x.",
289 __func__
, status
, endpoint
);
291 tty
= tty_port_tty_get(&port
->port
);
293 if (urb
->actual_length
) {
294 tty_insert_flip_string(tty
, data
,
296 tty_flip_buffer_push(tty
);
298 dbg("%s: empty read urb received", __func__
);
302 /* Resubmit urb so we continue receiving */
303 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
306 printk(KERN_ERR
"%s: resubmit read urb failed. "
307 "(%d)", __func__
, err
);
308 /* busy also in error unless we are killed */
309 usb_mark_last_busy(port
->serial
->dev
);
312 usb_mark_last_busy(port
->serial
->dev
);
317 static void usb_wwan_outdat_callback(struct urb
*urb
)
319 struct usb_serial_port
*port
;
320 struct usb_wwan_port_private
*portdata
;
321 struct usb_wwan_intf_private
*intfdata
;
325 intfdata
= port
->serial
->private;
327 usb_serial_port_softint(port
);
328 usb_autopm_put_interface_async(port
->serial
->interface
);
329 portdata
= usb_get_serial_port_data(port
);
330 spin_lock(&intfdata
->susp_lock
);
331 intfdata
->in_flight
--;
332 spin_unlock(&intfdata
->susp_lock
);
334 for (i
= 0; i
< N_OUT_URB
; ++i
) {
335 if (portdata
->out_urbs
[i
] == urb
) {
336 smp_mb__before_clear_bit();
337 clear_bit(i
, &portdata
->out_busy
);
343 int usb_wwan_write_room(struct tty_struct
*tty
)
345 struct usb_serial_port
*port
= tty
->driver_data
;
346 struct usb_wwan_port_private
*portdata
;
349 struct urb
*this_urb
;
351 portdata
= usb_get_serial_port_data(port
);
353 for (i
= 0; i
< N_OUT_URB
; i
++) {
354 this_urb
= portdata
->out_urbs
[i
];
355 if (this_urb
&& !test_bit(i
, &portdata
->out_busy
))
356 data_len
+= OUT_BUFLEN
;
359 dbg("%s: %d", __func__
, data_len
);
362 EXPORT_SYMBOL(usb_wwan_write_room
);
364 int usb_wwan_chars_in_buffer(struct tty_struct
*tty
)
366 struct usb_serial_port
*port
= tty
->driver_data
;
367 struct usb_wwan_port_private
*portdata
;
370 struct urb
*this_urb
;
372 portdata
= usb_get_serial_port_data(port
);
374 for (i
= 0; i
< N_OUT_URB
; i
++) {
375 this_urb
= portdata
->out_urbs
[i
];
376 /* FIXME: This locking is insufficient as this_urb may
377 go unused during the test */
378 if (this_urb
&& test_bit(i
, &portdata
->out_busy
))
379 data_len
+= this_urb
->transfer_buffer_length
;
381 dbg("%s: %d", __func__
, data_len
);
384 EXPORT_SYMBOL(usb_wwan_chars_in_buffer
);
386 int usb_wwan_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
388 struct usb_wwan_port_private
*portdata
;
389 struct usb_wwan_intf_private
*intfdata
;
390 struct usb_serial
*serial
= port
->serial
;
394 portdata
= usb_get_serial_port_data(port
);
395 intfdata
= serial
->private;
397 /* Start reading from the IN endpoint */
398 for (i
= 0; i
< N_IN_URB
; i
++) {
399 urb
= portdata
->in_urbs
[i
];
402 err
= usb_submit_urb(urb
, GFP_KERNEL
);
404 dbg("%s: submit urb %d failed (%d) %d",
405 __func__
, i
, err
, urb
->transfer_buffer_length
);
409 if (intfdata
->send_setup
)
410 intfdata
->send_setup(port
);
412 serial
->interface
->needs_remote_wakeup
= 1;
413 spin_lock_irq(&intfdata
->susp_lock
);
414 portdata
->opened
= 1;
415 spin_unlock_irq(&intfdata
->susp_lock
);
416 /* this balances a get in the generic USB serial code */
417 usb_autopm_put_interface(serial
->interface
);
421 EXPORT_SYMBOL(usb_wwan_open
);
423 void usb_wwan_close(struct usb_serial_port
*port
)
426 struct usb_serial
*serial
= port
->serial
;
427 struct usb_wwan_port_private
*portdata
;
428 struct usb_wwan_intf_private
*intfdata
= port
->serial
->private;
430 portdata
= usb_get_serial_port_data(port
);
433 /* Stop reading/writing urbs */
434 spin_lock_irq(&intfdata
->susp_lock
);
435 portdata
->opened
= 0;
436 spin_unlock_irq(&intfdata
->susp_lock
);
438 for (i
= 0; i
< N_IN_URB
; i
++)
439 usb_kill_urb(portdata
->in_urbs
[i
]);
440 for (i
= 0; i
< N_OUT_URB
; i
++)
441 usb_kill_urb(portdata
->out_urbs
[i
]);
442 /* balancing - important as an error cannot be handled*/
443 usb_autopm_get_interface_no_resume(serial
->interface
);
444 serial
->interface
->needs_remote_wakeup
= 0;
447 EXPORT_SYMBOL(usb_wwan_close
);
449 /* Helper functions used by usb_wwan_setup_urbs */
450 static struct urb
*usb_wwan_setup_urb(struct usb_serial
*serial
, int endpoint
,
451 int dir
, void *ctx
, char *buf
, int len
,
452 void (*callback
) (struct urb
*))
457 return NULL
; /* endpoint not needed */
459 urb
= usb_alloc_urb(0, GFP_KERNEL
); /* No ISO */
461 dbg("%s: alloc for endpoint %d failed.", __func__
, endpoint
);
465 /* Fill URB using supplied data. */
466 usb_fill_bulk_urb(urb
, serial
->dev
,
467 usb_sndbulkpipe(serial
->dev
, endpoint
) | dir
,
468 buf
, len
, callback
, ctx
);
474 static void usb_wwan_setup_urbs(struct usb_serial
*serial
)
477 struct usb_serial_port
*port
;
478 struct usb_wwan_port_private
*portdata
;
480 for (i
= 0; i
< serial
->num_ports
; i
++) {
481 port
= serial
->port
[i
];
482 portdata
= usb_get_serial_port_data(port
);
484 /* Do indat endpoints first */
485 for (j
= 0; j
< N_IN_URB
; ++j
) {
486 portdata
->in_urbs
[j
] = usb_wwan_setup_urb(serial
,
488 bulk_in_endpointAddress
,
494 usb_wwan_indat_callback
);
497 /* outdat endpoints */
498 for (j
= 0; j
< N_OUT_URB
; ++j
) {
499 portdata
->out_urbs
[j
] = usb_wwan_setup_urb(serial
,
501 bulk_out_endpointAddress
,
508 usb_wwan_outdat_callback
);
513 int usb_wwan_startup(struct usb_serial
*serial
)
516 struct usb_serial_port
*port
;
517 struct usb_wwan_port_private
*portdata
;
520 /* Now setup per port private data */
521 for (i
= 0; i
< serial
->num_ports
; i
++) {
522 port
= serial
->port
[i
];
523 portdata
= kzalloc(sizeof(*portdata
), GFP_KERNEL
);
525 dbg("%s: kmalloc for usb_wwan_port_private (%d) failed!.",
529 init_usb_anchor(&portdata
->delayed
);
531 for (j
= 0; j
< N_IN_URB
; j
++) {
532 buffer
= (u8
*) __get_free_page(GFP_KERNEL
);
535 portdata
->in_buffer
[j
] = buffer
;
538 for (j
= 0; j
< N_OUT_URB
; j
++) {
539 buffer
= kmalloc(OUT_BUFLEN
, GFP_KERNEL
);
541 goto bail_out_error2
;
542 portdata
->out_buffer
[j
] = buffer
;
545 usb_set_serial_port_data(port
, portdata
);
547 if (!port
->interrupt_in_urb
)
549 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
551 dbg("%s: submit irq_in urb failed %d", __func__
, err
);
553 usb_wwan_setup_urbs(serial
);
557 for (j
= 0; j
< N_OUT_URB
; j
++)
558 kfree(portdata
->out_buffer
[j
]);
560 for (j
= 0; j
< N_IN_URB
; j
++)
561 if (portdata
->in_buffer
[j
])
562 free_page((unsigned long)portdata
->in_buffer
[j
]);
566 EXPORT_SYMBOL(usb_wwan_startup
);
568 int usb_wwan_port_remove(struct usb_serial_port
*port
)
571 struct usb_wwan_port_private
*portdata
;
573 portdata
= usb_get_serial_port_data(port
);
574 usb_set_serial_port_data(port
, NULL
);
576 /* Stop reading/writing urbs and free them */
577 for (i
= 0; i
< N_IN_URB
; i
++) {
578 usb_kill_urb(portdata
->in_urbs
[i
]);
579 usb_free_urb(portdata
->in_urbs
[i
]);
580 free_page((unsigned long)portdata
->in_buffer
[i
]);
582 for (i
= 0; i
< N_OUT_URB
; i
++) {
583 usb_kill_urb(portdata
->out_urbs
[i
]);
584 usb_free_urb(portdata
->out_urbs
[i
]);
585 kfree(portdata
->out_buffer
[i
]);
588 /* Now free port private data */
592 EXPORT_SYMBOL(usb_wwan_port_remove
);
595 static void stop_read_write_urbs(struct usb_serial
*serial
)
598 struct usb_serial_port
*port
;
599 struct usb_wwan_port_private
*portdata
;
601 /* Stop reading/writing urbs */
602 for (i
= 0; i
< serial
->num_ports
; ++i
) {
603 port
= serial
->port
[i
];
604 portdata
= usb_get_serial_port_data(port
);
605 for (j
= 0; j
< N_IN_URB
; j
++)
606 usb_kill_urb(portdata
->in_urbs
[j
]);
607 for (j
= 0; j
< N_OUT_URB
; j
++)
608 usb_kill_urb(portdata
->out_urbs
[j
]);
612 int usb_wwan_suspend(struct usb_serial
*serial
, pm_message_t message
)
614 struct usb_wwan_intf_private
*intfdata
= serial
->private;
617 if (PMSG_IS_AUTO(message
)) {
618 spin_lock_irq(&intfdata
->susp_lock
);
619 b
= intfdata
->in_flight
;
620 spin_unlock_irq(&intfdata
->susp_lock
);
626 spin_lock_irq(&intfdata
->susp_lock
);
627 intfdata
->suspended
= 1;
628 spin_unlock_irq(&intfdata
->susp_lock
);
629 stop_read_write_urbs(serial
);
633 EXPORT_SYMBOL(usb_wwan_suspend
);
635 static void unbusy_queued_urb(struct urb
*urb
, struct usb_wwan_port_private
*portdata
)
639 for (i
= 0; i
< N_OUT_URB
; i
++) {
640 if (urb
== portdata
->out_urbs
[i
]) {
641 clear_bit(i
, &portdata
->out_busy
);
647 static void play_delayed(struct usb_serial_port
*port
)
649 struct usb_wwan_intf_private
*data
;
650 struct usb_wwan_port_private
*portdata
;
654 portdata
= usb_get_serial_port_data(port
);
655 data
= port
->serial
->private;
656 while ((urb
= usb_get_from_anchor(&portdata
->delayed
))) {
657 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
661 /* we have to throw away the rest */
663 unbusy_queued_urb(urb
, portdata
);
664 usb_autopm_put_interface_no_suspend(port
->serial
->interface
);
665 } while ((urb
= usb_get_from_anchor(&portdata
->delayed
)));
671 int usb_wwan_resume(struct usb_serial
*serial
)
674 struct usb_serial_port
*port
;
675 struct usb_wwan_intf_private
*intfdata
= serial
->private;
676 struct usb_wwan_port_private
*portdata
;
680 /* get the interrupt URBs resubmitted unconditionally */
681 for (i
= 0; i
< serial
->num_ports
; i
++) {
682 port
= serial
->port
[i
];
683 if (!port
->interrupt_in_urb
) {
684 dbg("%s: No interrupt URB for port %d", __func__
, i
);
687 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_NOIO
);
688 dbg("Submitted interrupt URB for port %d (result %d)", i
, err
);
690 dev_err(&port
->dev
, "%s: Error %d for interrupt URB\n",
696 for (i
= 0; i
< serial
->num_ports
; i
++) {
698 port
= serial
->port
[i
];
699 portdata
= usb_get_serial_port_data(port
);
701 /* skip closed ports */
702 spin_lock_irq(&intfdata
->susp_lock
);
703 if (!portdata
->opened
) {
704 spin_unlock_irq(&intfdata
->susp_lock
);
708 for (j
= 0; j
< N_IN_URB
; j
++) {
709 urb
= portdata
->in_urbs
[j
];
710 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
712 dev_err(&port
->dev
, "%s: Error %d for bulk URB %d\n",
714 spin_unlock_irq(&intfdata
->susp_lock
);
719 spin_unlock_irq(&intfdata
->susp_lock
);
721 spin_lock_irq(&intfdata
->susp_lock
);
722 intfdata
->suspended
= 0;
723 spin_unlock_irq(&intfdata
->susp_lock
);
727 EXPORT_SYMBOL(usb_wwan_resume
);
730 MODULE_AUTHOR(DRIVER_AUTHOR
);
731 MODULE_DESCRIPTION(DRIVER_DESC
);
732 MODULE_VERSION(DRIVER_VERSION
);
733 MODULE_LICENSE("GPL");
735 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
736 MODULE_PARM_DESC(debug
, "Debug messages");
This page took 0.043697 seconds and 4 git commands to generate.