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_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
23 #define DRIVER_DESC "USB Driver for GSM modems"
25 #include <linux/kernel.h>
26 #include <linux/jiffies.h>
27 #include <linux/errno.h>
28 #include <linux/slab.h>
29 #include <linux/tty.h>
30 #include <linux/tty_flip.h>
31 #include <linux/module.h>
32 #include <linux/bitops.h>
33 #include <linux/uaccess.h>
34 #include <linux/usb.h>
35 #include <linux/usb/serial.h>
36 #include <linux/serial.h>
39 void usb_wwan_dtr_rts(struct usb_serial_port
*port
, int on
)
41 struct usb_wwan_port_private
*portdata
;
42 struct usb_wwan_intf_private
*intfdata
;
44 intfdata
= port
->serial
->private;
46 if (!intfdata
->send_setup
)
49 portdata
= usb_get_serial_port_data(port
);
51 portdata
->rts_state
= on
;
52 portdata
->dtr_state
= on
;
54 intfdata
->send_setup(port
);
56 EXPORT_SYMBOL(usb_wwan_dtr_rts
);
58 void usb_wwan_set_termios(struct tty_struct
*tty
,
59 struct usb_serial_port
*port
,
60 struct ktermios
*old_termios
)
62 struct usb_wwan_intf_private
*intfdata
= port
->serial
->private;
64 /* Doesn't support option setting */
65 tty_termios_copy_hw(&tty
->termios
, old_termios
);
67 if (intfdata
->send_setup
)
68 intfdata
->send_setup(port
);
70 EXPORT_SYMBOL(usb_wwan_set_termios
);
72 int usb_wwan_tiocmget(struct tty_struct
*tty
)
74 struct usb_serial_port
*port
= tty
->driver_data
;
76 struct usb_wwan_port_private
*portdata
;
78 portdata
= usb_get_serial_port_data(port
);
80 value
= ((portdata
->rts_state
) ? TIOCM_RTS
: 0) |
81 ((portdata
->dtr_state
) ? TIOCM_DTR
: 0) |
82 ((portdata
->cts_state
) ? TIOCM_CTS
: 0) |
83 ((portdata
->dsr_state
) ? TIOCM_DSR
: 0) |
84 ((portdata
->dcd_state
) ? TIOCM_CAR
: 0) |
85 ((portdata
->ri_state
) ? TIOCM_RNG
: 0);
89 EXPORT_SYMBOL(usb_wwan_tiocmget
);
91 int usb_wwan_tiocmset(struct tty_struct
*tty
,
92 unsigned int set
, unsigned int clear
)
94 struct usb_serial_port
*port
= tty
->driver_data
;
95 struct usb_wwan_port_private
*portdata
;
96 struct usb_wwan_intf_private
*intfdata
;
98 portdata
= usb_get_serial_port_data(port
);
99 intfdata
= port
->serial
->private;
101 if (!intfdata
->send_setup
)
104 /* FIXME: what locks portdata fields ? */
106 portdata
->rts_state
= 1;
108 portdata
->dtr_state
= 1;
110 if (clear
& TIOCM_RTS
)
111 portdata
->rts_state
= 0;
112 if (clear
& TIOCM_DTR
)
113 portdata
->dtr_state
= 0;
114 return intfdata
->send_setup(port
);
116 EXPORT_SYMBOL(usb_wwan_tiocmset
);
118 static int get_serial_info(struct usb_serial_port
*port
,
119 struct serial_struct __user
*retinfo
)
121 struct serial_struct tmp
;
126 memset(&tmp
, 0, sizeof(tmp
));
127 tmp
.line
= port
->minor
;
128 tmp
.port
= port
->port_number
;
129 tmp
.baud_base
= tty_get_baud_rate(port
->port
.tty
);
130 tmp
.close_delay
= port
->port
.close_delay
/ 10;
131 tmp
.closing_wait
= port
->port
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
132 ASYNC_CLOSING_WAIT_NONE
:
133 port
->port
.closing_wait
/ 10;
135 if (copy_to_user(retinfo
, &tmp
, sizeof(*retinfo
)))
140 static int set_serial_info(struct usb_serial_port
*port
,
141 struct serial_struct __user
*newinfo
)
143 struct serial_struct new_serial
;
144 unsigned int closing_wait
, close_delay
;
147 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
150 close_delay
= new_serial
.close_delay
* 10;
151 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
152 ASYNC_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
154 mutex_lock(&port
->port
.mutex
);
156 if (!capable(CAP_SYS_ADMIN
)) {
157 if ((close_delay
!= port
->port
.close_delay
) ||
158 (closing_wait
!= port
->port
.closing_wait
))
161 retval
= -EOPNOTSUPP
;
163 port
->port
.close_delay
= close_delay
;
164 port
->port
.closing_wait
= closing_wait
;
167 mutex_unlock(&port
->port
.mutex
);
171 int usb_wwan_ioctl(struct tty_struct
*tty
,
172 unsigned int cmd
, unsigned long arg
)
174 struct usb_serial_port
*port
= tty
->driver_data
;
176 dev_dbg(&port
->dev
, "%s cmd 0x%04x\n", __func__
, cmd
);
180 return get_serial_info(port
,
181 (struct serial_struct __user
*) arg
);
183 return set_serial_info(port
,
184 (struct serial_struct __user
*) arg
);
189 dev_dbg(&port
->dev
, "%s arg not supported\n", __func__
);
193 EXPORT_SYMBOL(usb_wwan_ioctl
);
196 int usb_wwan_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
197 const unsigned char *buf
, int count
)
199 struct usb_wwan_port_private
*portdata
;
200 struct usb_wwan_intf_private
*intfdata
;
203 struct urb
*this_urb
= NULL
; /* spurious */
207 portdata
= usb_get_serial_port_data(port
);
208 intfdata
= port
->serial
->private;
210 dev_dbg(&port
->dev
, "%s: write (%d chars)\n", __func__
, count
);
214 for (i
= 0; left
> 0 && i
< N_OUT_URB
; i
++) {
216 if (todo
> OUT_BUFLEN
)
219 this_urb
= portdata
->out_urbs
[i
];
220 if (test_and_set_bit(i
, &portdata
->out_busy
)) {
221 if (time_before(jiffies
,
222 portdata
->tx_start_time
[i
] + 10 * HZ
))
224 usb_unlink_urb(this_urb
);
227 dev_dbg(&port
->dev
, "%s: endpoint %d buf %d\n", __func__
,
228 usb_pipeendpoint(this_urb
->pipe
), i
);
230 err
= usb_autopm_get_interface_async(port
->serial
->interface
);
232 clear_bit(i
, &portdata
->out_busy
);
237 memcpy(this_urb
->transfer_buffer
, buf
, todo
);
238 this_urb
->transfer_buffer_length
= todo
;
240 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
241 if (intfdata
->suspended
) {
242 usb_anchor_urb(this_urb
, &portdata
->delayed
);
243 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
245 intfdata
->in_flight
++;
246 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
247 err
= usb_submit_urb(this_urb
, GFP_ATOMIC
);
250 "usb_submit_urb %p (write bulk) failed (%d)\n",
252 clear_bit(i
, &portdata
->out_busy
);
253 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
254 intfdata
->in_flight
--;
255 spin_unlock_irqrestore(&intfdata
->susp_lock
,
257 usb_autopm_put_interface_async(port
->serial
->interface
);
262 portdata
->tx_start_time
[i
] = jiffies
;
268 dev_dbg(&port
->dev
, "%s: wrote (did %d)\n", __func__
, count
);
271 EXPORT_SYMBOL(usb_wwan_write
);
273 static void usb_wwan_indat_callback(struct urb
*urb
)
277 struct usb_serial_port
*port
;
279 unsigned char *data
= urb
->transfer_buffer
;
280 int status
= urb
->status
;
282 endpoint
= usb_pipeendpoint(urb
->pipe
);
287 dev_dbg(dev
, "%s: nonzero status: %d on endpoint %02x.\n",
288 __func__
, status
, endpoint
);
290 if (urb
->actual_length
) {
291 tty_insert_flip_string(&port
->port
, data
,
293 tty_flip_buffer_push(&port
->port
);
295 dev_dbg(dev
, "%s: empty read urb received\n", __func__
);
297 /* Resubmit urb so we continue receiving */
298 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
301 dev_err(dev
, "%s: resubmit read urb failed. (%d)\n",
303 /* busy also in error unless we are killed */
304 usb_mark_last_busy(port
->serial
->dev
);
307 usb_mark_last_busy(port
->serial
->dev
);
311 static void usb_wwan_outdat_callback(struct urb
*urb
)
313 struct usb_serial_port
*port
;
314 struct usb_wwan_port_private
*portdata
;
315 struct usb_wwan_intf_private
*intfdata
;
319 intfdata
= port
->serial
->private;
321 usb_serial_port_softint(port
);
322 usb_autopm_put_interface_async(port
->serial
->interface
);
323 portdata
= usb_get_serial_port_data(port
);
324 spin_lock(&intfdata
->susp_lock
);
325 intfdata
->in_flight
--;
326 spin_unlock(&intfdata
->susp_lock
);
328 for (i
= 0; i
< N_OUT_URB
; ++i
) {
329 if (portdata
->out_urbs
[i
] == urb
) {
330 smp_mb__before_clear_bit();
331 clear_bit(i
, &portdata
->out_busy
);
337 int usb_wwan_write_room(struct tty_struct
*tty
)
339 struct usb_serial_port
*port
= tty
->driver_data
;
340 struct usb_wwan_port_private
*portdata
;
343 struct urb
*this_urb
;
345 portdata
= usb_get_serial_port_data(port
);
347 for (i
= 0; i
< N_OUT_URB
; i
++) {
348 this_urb
= portdata
->out_urbs
[i
];
349 if (this_urb
&& !test_bit(i
, &portdata
->out_busy
))
350 data_len
+= OUT_BUFLEN
;
353 dev_dbg(&port
->dev
, "%s: %d\n", __func__
, data_len
);
356 EXPORT_SYMBOL(usb_wwan_write_room
);
358 int usb_wwan_chars_in_buffer(struct tty_struct
*tty
)
360 struct usb_serial_port
*port
= tty
->driver_data
;
361 struct usb_wwan_port_private
*portdata
;
364 struct urb
*this_urb
;
366 portdata
= usb_get_serial_port_data(port
);
368 for (i
= 0; i
< N_OUT_URB
; i
++) {
369 this_urb
= portdata
->out_urbs
[i
];
370 /* FIXME: This locking is insufficient as this_urb may
371 go unused during the test */
372 if (this_urb
&& test_bit(i
, &portdata
->out_busy
))
373 data_len
+= this_urb
->transfer_buffer_length
;
375 dev_dbg(&port
->dev
, "%s: %d\n", __func__
, data_len
);
378 EXPORT_SYMBOL(usb_wwan_chars_in_buffer
);
380 int usb_wwan_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
382 struct usb_wwan_port_private
*portdata
;
383 struct usb_wwan_intf_private
*intfdata
;
384 struct usb_serial
*serial
= port
->serial
;
388 portdata
= usb_get_serial_port_data(port
);
389 intfdata
= serial
->private;
391 if (port
->interrupt_in_urb
) {
392 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
394 dev_dbg(&port
->dev
, "%s: submit int urb failed: %d\n",
399 /* Start reading from the IN endpoint */
400 for (i
= 0; i
< N_IN_URB
; i
++) {
401 urb
= portdata
->in_urbs
[i
];
404 err
= usb_submit_urb(urb
, GFP_KERNEL
);
406 dev_dbg(&port
->dev
, "%s: submit urb %d failed (%d) %d\n",
407 __func__
, i
, err
, urb
->transfer_buffer_length
);
411 if (intfdata
->send_setup
)
412 intfdata
->send_setup(port
);
414 serial
->interface
->needs_remote_wakeup
= 1;
415 spin_lock_irq(&intfdata
->susp_lock
);
416 portdata
->opened
= 1;
417 spin_unlock_irq(&intfdata
->susp_lock
);
418 /* this balances a get in the generic USB serial code */
419 usb_autopm_put_interface(serial
->interface
);
423 EXPORT_SYMBOL(usb_wwan_open
);
425 static void unbusy_queued_urb(struct urb
*urb
,
426 struct usb_wwan_port_private
*portdata
)
430 for (i
= 0; i
< N_OUT_URB
; i
++) {
431 if (urb
== portdata
->out_urbs
[i
]) {
432 clear_bit(i
, &portdata
->out_busy
);
438 void usb_wwan_close(struct usb_serial_port
*port
)
441 struct usb_serial
*serial
= port
->serial
;
442 struct usb_wwan_port_private
*portdata
;
443 struct usb_wwan_intf_private
*intfdata
= port
->serial
->private;
446 portdata
= usb_get_serial_port_data(port
);
448 /* Stop reading/writing urbs */
449 spin_lock_irq(&intfdata
->susp_lock
);
450 portdata
->opened
= 0;
451 spin_unlock_irq(&intfdata
->susp_lock
);
454 urb
= usb_get_from_anchor(&portdata
->delayed
);
457 unbusy_queued_urb(urb
, portdata
);
458 usb_autopm_put_interface_async(serial
->interface
);
461 for (i
= 0; i
< N_IN_URB
; i
++)
462 usb_kill_urb(portdata
->in_urbs
[i
]);
463 for (i
= 0; i
< N_OUT_URB
; i
++)
464 usb_kill_urb(portdata
->out_urbs
[i
]);
465 usb_kill_urb(port
->interrupt_in_urb
);
467 /* balancing - important as an error cannot be handled*/
468 usb_autopm_get_interface_no_resume(serial
->interface
);
469 serial
->interface
->needs_remote_wakeup
= 0;
471 EXPORT_SYMBOL(usb_wwan_close
);
473 /* Helper functions used by usb_wwan_setup_urbs */
474 static struct urb
*usb_wwan_setup_urb(struct usb_serial_port
*port
,
476 int dir
, void *ctx
, char *buf
, int len
,
477 void (*callback
) (struct urb
*))
479 struct usb_serial
*serial
= port
->serial
;
482 urb
= usb_alloc_urb(0, GFP_KERNEL
); /* No ISO */
484 dev_dbg(&serial
->interface
->dev
,
485 "%s: alloc for endpoint %d failed.\n", __func__
,
490 /* Fill URB using supplied data. */
491 usb_fill_bulk_urb(urb
, serial
->dev
,
492 usb_sndbulkpipe(serial
->dev
, endpoint
) | dir
,
493 buf
, len
, callback
, ctx
);
498 int usb_wwan_port_probe(struct usb_serial_port
*port
)
500 struct usb_wwan_port_private
*portdata
;
505 if (!port
->bulk_in_size
|| !port
->bulk_out_size
)
508 portdata
= kzalloc(sizeof(*portdata
), GFP_KERNEL
);
512 init_usb_anchor(&portdata
->delayed
);
514 for (i
= 0; i
< N_IN_URB
; i
++) {
515 buffer
= (u8
*)__get_free_page(GFP_KERNEL
);
518 portdata
->in_buffer
[i
] = buffer
;
520 urb
= usb_wwan_setup_urb(port
, port
->bulk_in_endpointAddress
,
523 usb_wwan_indat_callback
);
524 portdata
->in_urbs
[i
] = urb
;
527 for (i
= 0; i
< N_OUT_URB
; i
++) {
528 buffer
= kmalloc(OUT_BUFLEN
, GFP_KERNEL
);
530 goto bail_out_error2
;
531 portdata
->out_buffer
[i
] = buffer
;
533 urb
= usb_wwan_setup_urb(port
, port
->bulk_out_endpointAddress
,
536 usb_wwan_outdat_callback
);
537 portdata
->out_urbs
[i
] = urb
;
540 usb_set_serial_port_data(port
, portdata
);
545 for (i
= 0; i
< N_OUT_URB
; i
++) {
546 usb_free_urb(portdata
->out_urbs
[i
]);
547 kfree(portdata
->out_buffer
[i
]);
550 for (i
= 0; i
< N_IN_URB
; i
++) {
551 usb_free_urb(portdata
->in_urbs
[i
]);
552 free_page((unsigned long)portdata
->in_buffer
[i
]);
558 EXPORT_SYMBOL_GPL(usb_wwan_port_probe
);
560 int usb_wwan_port_remove(struct usb_serial_port
*port
)
563 struct usb_wwan_port_private
*portdata
;
565 portdata
= usb_get_serial_port_data(port
);
566 usb_set_serial_port_data(port
, NULL
);
568 /* Stop reading/writing urbs and free them */
569 for (i
= 0; i
< N_IN_URB
; i
++) {
570 usb_kill_urb(portdata
->in_urbs
[i
]);
571 usb_free_urb(portdata
->in_urbs
[i
]);
572 free_page((unsigned long)portdata
->in_buffer
[i
]);
574 for (i
= 0; i
< N_OUT_URB
; i
++) {
575 usb_kill_urb(portdata
->out_urbs
[i
]);
576 usb_free_urb(portdata
->out_urbs
[i
]);
577 kfree(portdata
->out_buffer
[i
]);
580 /* Now free port private data */
584 EXPORT_SYMBOL(usb_wwan_port_remove
);
587 static void stop_read_write_urbs(struct usb_serial
*serial
)
590 struct usb_serial_port
*port
;
591 struct usb_wwan_port_private
*portdata
;
593 /* Stop reading/writing urbs */
594 for (i
= 0; i
< serial
->num_ports
; ++i
) {
595 port
= serial
->port
[i
];
596 portdata
= usb_get_serial_port_data(port
);
599 for (j
= 0; j
< N_IN_URB
; j
++)
600 usb_kill_urb(portdata
->in_urbs
[j
]);
601 for (j
= 0; j
< N_OUT_URB
; j
++)
602 usb_kill_urb(portdata
->out_urbs
[j
]);
606 int usb_wwan_suspend(struct usb_serial
*serial
, pm_message_t message
)
608 struct usb_wwan_intf_private
*intfdata
= serial
->private;
610 spin_lock_irq(&intfdata
->susp_lock
);
611 if (PMSG_IS_AUTO(message
)) {
612 if (intfdata
->in_flight
) {
613 spin_unlock_irq(&intfdata
->susp_lock
);
617 intfdata
->suspended
= 1;
618 spin_unlock_irq(&intfdata
->susp_lock
);
620 stop_read_write_urbs(serial
);
624 EXPORT_SYMBOL(usb_wwan_suspend
);
626 static int play_delayed(struct usb_serial_port
*port
)
628 struct usb_wwan_intf_private
*data
;
629 struct usb_wwan_port_private
*portdata
;
633 portdata
= usb_get_serial_port_data(port
);
634 data
= port
->serial
->private;
635 while ((urb
= usb_get_from_anchor(&portdata
->delayed
))) {
636 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
640 /* we have to throw away the rest */
642 unbusy_queued_urb(urb
, portdata
);
643 usb_autopm_put_interface_no_suspend(port
->serial
->interface
);
644 } while ((urb
= usb_get_from_anchor(&portdata
->delayed
)));
652 int usb_wwan_resume(struct usb_serial
*serial
)
655 struct usb_serial_port
*port
;
656 struct usb_wwan_intf_private
*intfdata
= serial
->private;
657 struct usb_wwan_port_private
*portdata
;
662 spin_lock_irq(&intfdata
->susp_lock
);
663 for (i
= 0; i
< serial
->num_ports
; i
++) {
665 port
= serial
->port
[i
];
666 portdata
= usb_get_serial_port_data(port
);
668 /* skip closed ports */
669 if (!portdata
|| !portdata
->opened
)
672 if (port
->interrupt_in_urb
) {
673 err
= usb_submit_urb(port
->interrupt_in_urb
,
677 "%s: submit int urb failed: %d\n",
683 err
= play_delayed(port
);
687 for (j
= 0; j
< N_IN_URB
; j
++) {
688 urb
= portdata
->in_urbs
[j
];
689 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
691 dev_err(&port
->dev
, "%s: Error %d for bulk URB %d\n",
697 intfdata
->suspended
= 0;
698 spin_unlock_irq(&intfdata
->susp_lock
);
705 EXPORT_SYMBOL(usb_wwan_resume
);
708 MODULE_AUTHOR(DRIVER_AUTHOR
);
709 MODULE_DESCRIPTION(DRIVER_DESC
);
710 MODULE_LICENSE("GPL");