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);
243 memcpy(this_urb->transfer_buffer, buf, todo);
244 this_urb->transfer_buffer_length = todo;
246 spin_lock_irqsave(&intfdata->susp_lock, flags);
247 if (intfdata->suspended) {
248 usb_anchor_urb(this_urb, &portdata->delayed);
249 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
251 intfdata->in_flight++;
252 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
253 err = usb_submit_urb(this_urb, GFP_ATOMIC);
255 dbg("usb_submit_urb %p (write bulk) failed "
256 "(%d)", this_urb, err);
257 clear_bit(i, &portdata->out_busy);
258 spin_lock_irqsave(&intfdata->susp_lock, flags);
259 intfdata->in_flight--;
260 spin_unlock_irqrestore(&intfdata->susp_lock,
262 usb_autopm_put_interface_async(port->serial->interface);
267 portdata->tx_start_time[i] = jiffies;
273 dbg("%s: wrote (did %d)", __func__, count);
276 EXPORT_SYMBOL(usb_wwan_write);
278 static void usb_wwan_indat_callback(struct urb *urb)
282 struct usb_serial_port *port;
283 struct tty_struct *tty;
284 unsigned char *data = urb->transfer_buffer;
285 int status = urb->status;
287 dbg("%s: %p", __func__, urb);
289 endpoint = usb_pipeendpoint(urb->pipe);
293 dbg("%s: nonzero status: %d on endpoint %02x.",
294 __func__, status, endpoint);
296 tty = tty_port_tty_get(&port->port);
298 if (urb->actual_length) {
299 tty_insert_flip_string(tty, data,
301 tty_flip_buffer_push(tty);
303 dbg("%s: empty read urb received", __func__);
307 /* Resubmit urb so we continue receiving */
308 if (status != -ESHUTDOWN) {
309 err = usb_submit_urb(urb, GFP_ATOMIC);
312 printk(KERN_ERR "%s: resubmit read urb failed. "
313 "(%d)", __func__, err);
314 /* busy also in error unless we are killed */
315 usb_mark_last_busy(port->serial->dev);
318 usb_mark_last_busy(port->serial->dev);
325 static void usb_wwan_outdat_callback(struct urb *urb)
327 struct usb_serial_port *port;
328 struct usb_wwan_port_private *portdata;
329 struct usb_wwan_intf_private *intfdata;
335 intfdata = port->serial->private;
337 usb_serial_port_softint(port);
338 usb_autopm_put_interface_async(port->serial->interface);
339 portdata = usb_get_serial_port_data(port);
340 spin_lock(&intfdata->susp_lock);
341 intfdata->in_flight--;
342 spin_unlock(&intfdata->susp_lock);
344 for (i = 0; i < N_OUT_URB; ++i) {
345 if (portdata->out_urbs[i] == urb) {
346 smp_mb__before_clear_bit();
347 clear_bit(i, &portdata->out_busy);
353 int usb_wwan_write_room(struct tty_struct *tty)
355 struct usb_serial_port *port = tty->driver_data;
356 struct usb_wwan_port_private *portdata;
359 struct urb *this_urb;
361 portdata = usb_get_serial_port_data(port);
363 for (i = 0; i < N_OUT_URB; i++) {
364 this_urb = portdata->out_urbs[i];
365 if (this_urb && !test_bit(i, &portdata->out_busy))
366 data_len += OUT_BUFLEN;
369 dbg("%s: %d", __func__, data_len);
372 EXPORT_SYMBOL(usb_wwan_write_room);
374 int usb_wwan_chars_in_buffer(struct tty_struct *tty)
376 struct usb_serial_port *port = tty->driver_data;
377 struct usb_wwan_port_private *portdata;
380 struct urb *this_urb;
382 portdata = usb_get_serial_port_data(port);
384 for (i = 0; i < N_OUT_URB; i++) {
385 this_urb = portdata->out_urbs[i];
386 /* FIXME: This locking is insufficient as this_urb may
387 go unused during the test */
388 if (this_urb && test_bit(i, &portdata->out_busy))
389 data_len += this_urb->transfer_buffer_length;
391 dbg("%s: %d", __func__, data_len);
394 EXPORT_SYMBOL(usb_wwan_chars_in_buffer);
396 int usb_wwan_open(struct tty_struct *tty, struct usb_serial_port *port)
398 struct usb_wwan_port_private *portdata;
399 struct usb_wwan_intf_private *intfdata;
400 struct usb_serial *serial = port->serial;
404 portdata = usb_get_serial_port_data(port);
405 intfdata = serial->private;
409 /* Start reading from the IN endpoint */
410 for (i = 0; i < N_IN_URB; i++) {
411 urb = portdata->in_urbs[i];
414 err = usb_submit_urb(urb, GFP_KERNEL);
416 dbg("%s: submit urb %d failed (%d) %d",
417 __func__, i, err, urb->transfer_buffer_length);
421 if (intfdata->send_setup)
422 intfdata->send_setup(port);
424 serial->interface->needs_remote_wakeup = 1;
425 spin_lock_irq(&intfdata->susp_lock);
426 portdata->opened = 1;
427 spin_unlock_irq(&intfdata->susp_lock);
428 /* this balances a get in the generic USB serial code */
429 usb_autopm_put_interface(serial->interface);
433 EXPORT_SYMBOL(usb_wwan_open);
435 void usb_wwan_close(struct usb_serial_port *port)
438 struct usb_serial *serial = port->serial;
439 struct usb_wwan_port_private *portdata;
440 struct usb_wwan_intf_private *intfdata = port->serial->private;
443 portdata = usb_get_serial_port_data(port);
446 /* Stop reading/writing urbs */
447 spin_lock_irq(&intfdata->susp_lock);
448 portdata->opened = 0;
449 spin_unlock_irq(&intfdata->susp_lock);
451 for (i = 0; i < N_IN_URB; i++)
452 usb_kill_urb(portdata->in_urbs[i]);
453 for (i = 0; i < N_OUT_URB; i++)
454 usb_kill_urb(portdata->out_urbs[i]);
455 /* balancing - important as an error cannot be handled*/
456 usb_autopm_get_interface_no_resume(serial->interface);
457 serial->interface->needs_remote_wakeup = 0;
460 EXPORT_SYMBOL(usb_wwan_close);
462 /* Helper functions used by usb_wwan_setup_urbs */
463 static struct urb *usb_wwan_setup_urb(struct usb_serial *serial, int endpoint,
464 int dir, void *ctx, char *buf, int len,
465 void (*callback) (struct urb *))
470 return NULL; /* endpoint not needed */
472 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
474 dbg("%s: alloc for endpoint %d failed.", __func__, endpoint);
478 /* Fill URB using supplied data. */
479 usb_fill_bulk_urb(urb, serial->dev,
480 usb_sndbulkpipe(serial->dev, endpoint) | dir,
481 buf, len, callback, ctx);
487 static void usb_wwan_setup_urbs(struct usb_serial *serial)
490 struct usb_serial_port *port;
491 struct usb_wwan_port_private *portdata;
495 for (i = 0; i < serial->num_ports; i++) {
496 port = serial->port[i];
497 portdata = usb_get_serial_port_data(port);
499 /* Do indat endpoints first */
500 for (j = 0; j < N_IN_URB; ++j) {
501 portdata->in_urbs[j] = usb_wwan_setup_urb(serial,
503 bulk_in_endpointAddress,
509 usb_wwan_indat_callback);
512 /* outdat endpoints */
513 for (j = 0; j < N_OUT_URB; ++j) {
514 portdata->out_urbs[j] = usb_wwan_setup_urb(serial,
516 bulk_out_endpointAddress,
523 usb_wwan_outdat_callback);
528 int usb_wwan_startup(struct usb_serial *serial)
531 struct usb_serial_port *port;
532 struct usb_wwan_port_private *portdata;
537 /* Now setup per port private data */
538 for (i = 0; i < serial->num_ports; i++) {
539 port = serial->port[i];
540 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
542 dbg("%s: kmalloc for usb_wwan_port_private (%d) failed!.",
546 init_usb_anchor(&portdata->delayed);
548 for (j = 0; j < N_IN_URB; j++) {
549 buffer = (u8 *) __get_free_page(GFP_KERNEL);
552 portdata->in_buffer[j] = buffer;
555 for (j = 0; j < N_OUT_URB; j++) {
556 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
558 goto bail_out_error2;
559 portdata->out_buffer[j] = buffer;
562 usb_set_serial_port_data(port, portdata);
564 if (!port->interrupt_in_urb)
566 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
568 dbg("%s: submit irq_in urb failed %d", __func__, err);
570 usb_wwan_setup_urbs(serial);
574 for (j = 0; j < N_OUT_URB; j++)
575 kfree(portdata->out_buffer[j]);
577 for (j = 0; j < N_IN_URB; j++)
578 if (portdata->in_buffer[j])
579 free_page((unsigned long)portdata->in_buffer[j]);
583 EXPORT_SYMBOL(usb_wwan_startup);
585 static void stop_read_write_urbs(struct usb_serial *serial)
588 struct usb_serial_port *port;
589 struct usb_wwan_port_private *portdata;
591 /* Stop reading/writing urbs */
592 for (i = 0; i < serial->num_ports; ++i) {
593 port = serial->port[i];
594 portdata = usb_get_serial_port_data(port);
595 for (j = 0; j < N_IN_URB; j++)
596 usb_kill_urb(portdata->in_urbs[j]);
597 for (j = 0; j < N_OUT_URB; j++)
598 usb_kill_urb(portdata->out_urbs[j]);
602 void usb_wwan_disconnect(struct usb_serial *serial)
606 stop_read_write_urbs(serial);
608 EXPORT_SYMBOL(usb_wwan_disconnect);
610 void usb_wwan_release(struct usb_serial *serial)
613 struct usb_serial_port *port;
614 struct usb_wwan_port_private *portdata;
619 for (i = 0; i < serial->num_ports; ++i) {
620 port = serial->port[i];
621 portdata = usb_get_serial_port_data(port);
623 for (j = 0; j < N_IN_URB; j++) {
624 usb_free_urb(portdata->in_urbs[j]);
625 free_page((unsigned long)
626 portdata->in_buffer[j]);
627 portdata->in_urbs[j] = NULL;
629 for (j = 0; j < N_OUT_URB; j++) {
630 usb_free_urb(portdata->out_urbs[j]);
631 kfree(portdata->out_buffer[j]);
632 portdata->out_urbs[j] = NULL;
636 /* Now free per port private data */
637 for (i = 0; i < serial->num_ports; i++) {
638 port = serial->port[i];
639 kfree(usb_get_serial_port_data(port));
642 EXPORT_SYMBOL(usb_wwan_release);
645 int usb_wwan_suspend(struct usb_serial *serial, pm_message_t message)
647 struct usb_wwan_intf_private *intfdata = serial->private;
650 dbg("%s entered", __func__);
652 if (PMSG_IS_AUTO(message)) {
653 spin_lock_irq(&intfdata->susp_lock);
654 b = intfdata->in_flight;
655 spin_unlock_irq(&intfdata->susp_lock);
661 spin_lock_irq(&intfdata->susp_lock);
662 intfdata->suspended = 1;
663 spin_unlock_irq(&intfdata->susp_lock);
664 stop_read_write_urbs(serial);
668 EXPORT_SYMBOL(usb_wwan_suspend);
670 static void unbusy_queued_urb(struct urb *urb, struct usb_wwan_port_private *portdata)
674 for (i = 0; i < N_OUT_URB; i++) {
675 if (urb == portdata->out_urbs[i]) {
676 clear_bit(i, &portdata->out_busy);
682 static void play_delayed(struct usb_serial_port *port)
684 struct usb_wwan_intf_private *data;
685 struct usb_wwan_port_private *portdata;
689 portdata = usb_get_serial_port_data(port);
690 data = port->serial->private;
691 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
692 err = usb_submit_urb(urb, GFP_ATOMIC);
696 /* we have to throw away the rest */
698 unbusy_queued_urb(urb, portdata);
699 usb_autopm_put_interface_no_suspend(port->serial->interface);
700 } while ((urb = usb_get_from_anchor(&portdata->delayed)));
706 int usb_wwan_resume(struct usb_serial *serial)
709 struct usb_serial_port *port;
710 struct usb_wwan_intf_private *intfdata = serial->private;
711 struct usb_wwan_port_private *portdata;
715 dbg("%s entered", __func__);
716 /* get the interrupt URBs resubmitted unconditionally */
717 for (i = 0; i < serial->num_ports; i++) {
718 port = serial->port[i];
719 if (!port->interrupt_in_urb) {
720 dbg("%s: No interrupt URB for port %d", __func__, i);
723 err = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
724 dbg("Submitted interrupt URB for port %d (result %d)", i, err);
726 err("%s: Error %d for interrupt URB of port%d",
732 for (i = 0; i < serial->num_ports; i++) {
734 port = serial->port[i];
735 portdata = usb_get_serial_port_data(port);
737 /* skip closed ports */
738 spin_lock_irq(&intfdata->susp_lock);
739 if (!portdata->opened) {
740 spin_unlock_irq(&intfdata->susp_lock);
744 for (j = 0; j < N_IN_URB; j++) {
745 urb = portdata->in_urbs[j];
746 err = usb_submit_urb(urb, GFP_ATOMIC);
748 err("%s: Error %d for bulk URB %d",
750 spin_unlock_irq(&intfdata->susp_lock);
755 spin_unlock_irq(&intfdata->susp_lock);
757 spin_lock_irq(&intfdata->susp_lock);
758 intfdata->suspended = 0;
759 spin_unlock_irq(&intfdata->susp_lock);
763 EXPORT_SYMBOL(usb_wwan_resume);
766 MODULE_AUTHOR(DRIVER_AUTHOR);
767 MODULE_DESCRIPTION(DRIVER_DESC);
768 MODULE_VERSION(DRIVER_VERSION);
769 MODULE_LICENSE("GPL");
771 module_param(debug, bool, S_IRUGO | S_IWUSR);
772 MODULE_PARM_DESC(debug, "Debug messages");