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_wwan_port_private *portdata;
46 struct usb_wwan_intf_private *intfdata;
50 intfdata = port->serial->private;
52 if (!intfdata->send_setup)
55 portdata = usb_get_serial_port_data(port);
57 portdata->rts_state = on;
58 portdata->dtr_state = on;
60 intfdata->send_setup(port);
62 EXPORT_SYMBOL(usb_wwan_dtr_rts);
64 void usb_wwan_set_termios(struct tty_struct *tty,
65 struct usb_serial_port *port,
66 struct ktermios *old_termios)
68 struct usb_wwan_intf_private *intfdata = port->serial->private;
72 /* Doesn't support option setting */
73 tty_termios_copy_hw(tty->termios, old_termios);
75 if (intfdata->send_setup)
76 intfdata->send_setup(port);
78 EXPORT_SYMBOL(usb_wwan_set_termios);
80 int usb_wwan_tiocmget(struct tty_struct *tty)
82 struct usb_serial_port *port = tty->driver_data;
84 struct usb_wwan_port_private *portdata;
86 portdata = usb_get_serial_port_data(port);
88 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
89 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
90 ((portdata->cts_state) ? TIOCM_CTS : 0) |
91 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
92 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
93 ((portdata->ri_state) ? TIOCM_RNG : 0);
97 EXPORT_SYMBOL(usb_wwan_tiocmget);
99 int usb_wwan_tiocmset(struct tty_struct *tty,
100 unsigned int set, unsigned int clear)
102 struct usb_serial_port *port = tty->driver_data;
103 struct usb_wwan_port_private *portdata;
104 struct usb_wwan_intf_private *intfdata;
106 portdata = usb_get_serial_port_data(port);
107 intfdata = port->serial->private;
109 if (!intfdata->send_setup)
112 /* FIXME: what locks portdata fields ? */
114 portdata->rts_state = 1;
116 portdata->dtr_state = 1;
118 if (clear & TIOCM_RTS)
119 portdata->rts_state = 0;
120 if (clear & TIOCM_DTR)
121 portdata->dtr_state = 0;
122 return intfdata->send_setup(port);
124 EXPORT_SYMBOL(usb_wwan_tiocmset);
126 static int get_serial_info(struct usb_serial_port *port,
127 struct serial_struct __user *retinfo)
129 struct serial_struct tmp;
134 memset(&tmp, 0, sizeof(tmp));
135 tmp.line = port->serial->minor;
136 tmp.port = port->number;
137 tmp.baud_base = tty_get_baud_rate(port->port.tty);
138 tmp.close_delay = port->port.close_delay / 10;
139 tmp.closing_wait = port->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
140 ASYNC_CLOSING_WAIT_NONE :
141 port->port.closing_wait / 10;
143 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
148 static int set_serial_info(struct usb_serial_port *port,
149 struct serial_struct __user *newinfo)
151 struct serial_struct new_serial;
152 unsigned int closing_wait, close_delay;
155 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
158 close_delay = new_serial.close_delay * 10;
159 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
160 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
162 mutex_lock(&port->port.mutex);
164 if (!capable(CAP_SYS_ADMIN)) {
165 if ((close_delay != port->port.close_delay) ||
166 (closing_wait != port->port.closing_wait))
169 retval = -EOPNOTSUPP;
171 port->port.close_delay = close_delay;
172 port->port.closing_wait = closing_wait;
175 mutex_unlock(&port->port.mutex);
179 int usb_wwan_ioctl(struct tty_struct *tty,
180 unsigned int cmd, unsigned long arg)
182 struct usb_serial_port *port = tty->driver_data;
184 dbg("%s cmd 0x%04x", __func__, cmd);
188 return get_serial_info(port,
189 (struct serial_struct __user *) arg);
191 return set_serial_info(port,
192 (struct serial_struct __user *) arg);
197 dbg("%s arg not supported", __func__);
201 EXPORT_SYMBOL(usb_wwan_ioctl);
204 int usb_wwan_write(struct tty_struct *tty, struct usb_serial_port *port,
205 const unsigned char *buf, int count)
207 struct usb_wwan_port_private *portdata;
208 struct usb_wwan_intf_private *intfdata;
211 struct urb *this_urb = NULL; /* spurious */
215 portdata = usb_get_serial_port_data(port);
216 intfdata = port->serial->private;
218 dbg("%s: write (%d chars)", __func__, count);
222 for (i = 0; left > 0 && i < N_OUT_URB; i++) {
224 if (todo > OUT_BUFLEN)
227 this_urb = portdata->out_urbs[i];
228 if (test_and_set_bit(i, &portdata->out_busy)) {
229 if (time_before(jiffies,
230 portdata->tx_start_time[i] + 10 * HZ))
232 usb_unlink_urb(this_urb);
235 dbg("%s: endpoint %d buf %d", __func__,
236 usb_pipeendpoint(this_urb->pipe), i);
238 err = usb_autopm_get_interface_async(port->serial->interface);
240 clear_bit(i, &portdata->out_busy);
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);
300 if (urb->actual_length) {
301 tty_insert_flip_string(tty, data,
303 tty_flip_buffer_push(tty);
305 dbg("%s: empty read urb received", __func__);
309 /* Resubmit urb so we continue receiving */
310 if (status != -ESHUTDOWN) {
311 err = usb_submit_urb(urb, GFP_ATOMIC);
314 printk(KERN_ERR "%s: resubmit read urb failed. "
315 "(%d)", __func__, err);
316 /* busy also in error unless we are killed */
317 usb_mark_last_busy(port->serial->dev);
320 usb_mark_last_busy(port->serial->dev);
327 static void usb_wwan_outdat_callback(struct urb *urb)
329 struct usb_serial_port *port;
330 struct usb_wwan_port_private *portdata;
331 struct usb_wwan_intf_private *intfdata;
337 intfdata = port->serial->private;
339 usb_serial_port_softint(port);
340 usb_autopm_put_interface_async(port->serial->interface);
341 portdata = usb_get_serial_port_data(port);
342 spin_lock(&intfdata->susp_lock);
343 intfdata->in_flight--;
344 spin_unlock(&intfdata->susp_lock);
346 for (i = 0; i < N_OUT_URB; ++i) {
347 if (portdata->out_urbs[i] == urb) {
348 smp_mb__before_clear_bit();
349 clear_bit(i, &portdata->out_busy);
355 int usb_wwan_write_room(struct tty_struct *tty)
357 struct usb_serial_port *port = tty->driver_data;
358 struct usb_wwan_port_private *portdata;
361 struct urb *this_urb;
363 portdata = usb_get_serial_port_data(port);
365 for (i = 0; i < N_OUT_URB; i++) {
366 this_urb = portdata->out_urbs[i];
367 if (this_urb && !test_bit(i, &portdata->out_busy))
368 data_len += OUT_BUFLEN;
371 dbg("%s: %d", __func__, data_len);
374 EXPORT_SYMBOL(usb_wwan_write_room);
376 int usb_wwan_chars_in_buffer(struct tty_struct *tty)
378 struct usb_serial_port *port = tty->driver_data;
379 struct usb_wwan_port_private *portdata;
382 struct urb *this_urb;
384 portdata = usb_get_serial_port_data(port);
386 for (i = 0; i < N_OUT_URB; i++) {
387 this_urb = portdata->out_urbs[i];
388 /* FIXME: This locking is insufficient as this_urb may
389 go unused during the test */
390 if (this_urb && test_bit(i, &portdata->out_busy))
391 data_len += this_urb->transfer_buffer_length;
393 dbg("%s: %d", __func__, data_len);
396 EXPORT_SYMBOL(usb_wwan_chars_in_buffer);
398 int usb_wwan_open(struct tty_struct *tty, struct usb_serial_port *port)
400 struct usb_wwan_port_private *portdata;
401 struct usb_wwan_intf_private *intfdata;
402 struct usb_serial *serial = port->serial;
406 portdata = usb_get_serial_port_data(port);
407 intfdata = serial->private;
411 /* Start reading from the IN endpoint */
412 for (i = 0; i < N_IN_URB; i++) {
413 urb = portdata->in_urbs[i];
416 err = usb_submit_urb(urb, GFP_KERNEL);
418 dbg("%s: submit urb %d failed (%d) %d",
419 __func__, i, err, urb->transfer_buffer_length);
423 if (intfdata->send_setup)
424 intfdata->send_setup(port);
426 serial->interface->needs_remote_wakeup = 1;
427 spin_lock_irq(&intfdata->susp_lock);
428 portdata->opened = 1;
429 spin_unlock_irq(&intfdata->susp_lock);
430 /* this balances a get in the generic USB serial code */
431 usb_autopm_put_interface(serial->interface);
435 EXPORT_SYMBOL(usb_wwan_open);
437 static void unbusy_queued_urb(struct urb *urb,
438 struct usb_wwan_port_private *portdata)
442 for (i = 0; i < N_OUT_URB; i++) {
443 if (urb == portdata->out_urbs[i]) {
444 clear_bit(i, &portdata->out_busy);
450 void usb_wwan_close(struct usb_serial_port *port)
453 struct usb_serial *serial = port->serial;
454 struct usb_wwan_port_private *portdata;
455 struct usb_wwan_intf_private *intfdata = port->serial->private;
459 portdata = usb_get_serial_port_data(port);
462 /* Stop reading/writing urbs */
463 spin_lock_irq(&intfdata->susp_lock);
464 portdata->opened = 0;
465 spin_unlock_irq(&intfdata->susp_lock);
468 urb = usb_get_from_anchor(&portdata->delayed);
471 unbusy_queued_urb(urb, portdata);
472 usb_autopm_put_interface_async(serial->interface);
475 for (i = 0; i < N_IN_URB; i++)
476 usb_kill_urb(portdata->in_urbs[i]);
477 for (i = 0; i < N_OUT_URB; i++)
478 usb_kill_urb(portdata->out_urbs[i]);
479 /* balancing - important as an error cannot be handled*/
480 usb_autopm_get_interface_no_resume(serial->interface);
481 serial->interface->needs_remote_wakeup = 0;
484 EXPORT_SYMBOL(usb_wwan_close);
486 /* Helper functions used by usb_wwan_setup_urbs */
487 static struct urb *usb_wwan_setup_urb(struct usb_serial *serial, int endpoint,
488 int dir, void *ctx, char *buf, int len,
489 void (*callback) (struct urb *))
494 return NULL; /* endpoint not needed */
496 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
498 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
502 /* Fill URB using supplied data. */
503 usb_fill_bulk_urb(urb, serial->dev,
504 usb_sndbulkpipe(serial->dev, endpoint) | dir,
505 buf, len, callback, ctx);
511 static void usb_wwan_setup_urbs(struct usb_serial *serial)
514 struct usb_serial_port *port;
515 struct usb_wwan_port_private *portdata;
519 for (i = 0; i < serial->num_ports; i++) {
520 port = serial->port[i];
521 portdata = usb_get_serial_port_data(port);
523 /* Do indat endpoints first */
524 for (j = 0; j < N_IN_URB; ++j) {
525 portdata->in_urbs[j] = usb_wwan_setup_urb(serial,
527 bulk_in_endpointAddress,
533 usb_wwan_indat_callback);
536 /* outdat endpoints */
537 for (j = 0; j < N_OUT_URB; ++j) {
538 portdata->out_urbs[j] = usb_wwan_setup_urb(serial,
540 bulk_out_endpointAddress,
547 usb_wwan_outdat_callback);
552 int usb_wwan_startup(struct usb_serial *serial)
555 struct usb_serial_port *port;
556 struct usb_wwan_port_private *portdata;
561 /* Now setup per port private data */
562 for (i = 0; i < serial->num_ports; i++) {
563 port = serial->port[i];
564 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
566 dbg("%s: kmalloc for usb_wwan_port_private (%d) failed!.",
570 init_usb_anchor(&portdata->delayed);
572 for (j = 0; j < N_IN_URB; j++) {
573 buffer = (u8 *) __get_free_page(GFP_KERNEL);
576 portdata->in_buffer[j] = buffer;
579 for (j = 0; j < N_OUT_URB; j++) {
580 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
582 goto bail_out_error2;
583 portdata->out_buffer[j] = buffer;
586 usb_set_serial_port_data(port, portdata);
588 if (!port->interrupt_in_urb)
590 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
592 dbg("%s: submit irq_in urb failed %d", __func__, err);
594 usb_wwan_setup_urbs(serial);
598 for (j = 0; j < N_OUT_URB; j++)
599 kfree(portdata->out_buffer[j]);
601 for (j = 0; j < N_IN_URB; j++)
602 if (portdata->in_buffer[j])
603 free_page((unsigned long)portdata->in_buffer[j]);
607 EXPORT_SYMBOL(usb_wwan_startup);
609 static void stop_read_write_urbs(struct usb_serial *serial)
612 struct usb_serial_port *port;
613 struct usb_wwan_port_private *portdata;
615 /* Stop reading/writing urbs */
616 for (i = 0; i < serial->num_ports; ++i) {
617 port = serial->port[i];
618 portdata = usb_get_serial_port_data(port);
619 for (j = 0; j < N_IN_URB; j++)
620 usb_kill_urb(portdata->in_urbs[j]);
621 for (j = 0; j < N_OUT_URB; j++)
622 usb_kill_urb(portdata->out_urbs[j]);
626 void usb_wwan_disconnect(struct usb_serial *serial)
630 stop_read_write_urbs(serial);
632 EXPORT_SYMBOL(usb_wwan_disconnect);
634 void usb_wwan_release(struct usb_serial *serial)
637 struct usb_serial_port *port;
638 struct usb_wwan_port_private *portdata;
643 for (i = 0; i < serial->num_ports; ++i) {
644 port = serial->port[i];
645 portdata = usb_get_serial_port_data(port);
647 for (j = 0; j < N_IN_URB; j++) {
648 usb_free_urb(portdata->in_urbs[j]);
649 free_page((unsigned long)
650 portdata->in_buffer[j]);
651 portdata->in_urbs[j] = NULL;
653 for (j = 0; j < N_OUT_URB; j++) {
654 usb_free_urb(portdata->out_urbs[j]);
655 kfree(portdata->out_buffer[j]);
656 portdata->out_urbs[j] = NULL;
660 /* Now free per port private data */
661 for (i = 0; i < serial->num_ports; i++) {
662 port = serial->port[i];
663 kfree(usb_get_serial_port_data(port));
666 EXPORT_SYMBOL(usb_wwan_release);
669 int usb_wwan_suspend(struct usb_serial *serial, pm_message_t message)
671 struct usb_wwan_intf_private *intfdata = serial->private;
673 dbg("%s entered", __func__);
675 spin_lock_irq(&intfdata->susp_lock);
676 if (PMSG_IS_AUTO(message)) {
677 if (intfdata->in_flight) {
678 spin_unlock_irq(&intfdata->susp_lock);
682 intfdata->suspended = 1;
683 spin_unlock_irq(&intfdata->susp_lock);
685 stop_read_write_urbs(serial);
689 EXPORT_SYMBOL(usb_wwan_suspend);
691 static int play_delayed(struct usb_serial_port *port)
693 struct usb_wwan_intf_private *data;
694 struct usb_wwan_port_private *portdata;
698 portdata = usb_get_serial_port_data(port);
699 data = port->serial->private;
700 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
701 err = usb_submit_urb(urb, GFP_ATOMIC);
705 /* we have to throw away the rest */
707 unbusy_queued_urb(urb, portdata);
708 usb_autopm_put_interface_no_suspend(port->serial->interface);
709 } while ((urb = usb_get_from_anchor(&portdata->delayed)));
717 int usb_wwan_resume(struct usb_serial *serial)
720 struct usb_serial_port *port;
721 struct usb_wwan_intf_private *intfdata = serial->private;
722 struct usb_wwan_port_private *portdata;
727 dbg("%s entered", __func__);
728 /* get the interrupt URBs resubmitted unconditionally */
729 for (i = 0; i < serial->num_ports; i++) {
730 port = serial->port[i];
731 if (!port->interrupt_in_urb) {
732 dbg("%s: No interrupt URB for port %d", __func__, i);
735 err = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
736 dbg("Submitted interrupt URB for port %d (result %d)", i, err);
738 err("%s: Error %d for interrupt URB of port%d",
744 spin_lock_irq(&intfdata->susp_lock);
745 for (i = 0; i < serial->num_ports; i++) {
747 port = serial->port[i];
748 portdata = usb_get_serial_port_data(port);
750 /* skip closed ports */
751 if (!portdata->opened)
754 err = play_delayed(port);
758 for (j = 0; j < N_IN_URB; j++) {
759 urb = portdata->in_urbs[j];
760 err = usb_submit_urb(urb, GFP_ATOMIC);
762 err("%s: Error %d for bulk URB %d",
768 intfdata->suspended = 0;
769 spin_unlock_irq(&intfdata->susp_lock);
776 EXPORT_SYMBOL(usb_wwan_resume);
779 MODULE_AUTHOR(DRIVER_AUTHOR);
780 MODULE_DESCRIPTION(DRIVER_DESC);
781 MODULE_VERSION(DRIVER_VERSION);
782 MODULE_LICENSE("GPL");
784 module_param(debug, bool, S_IRUGO | S_IWUSR);
785 MODULE_PARM_DESC(debug, "Debug messages");