/* USB Driver layer for GSM modems Copyright (C) 2005 Matthias Urlichs This driver is free software; you can redistribute it and/or modify it under the terms of Version 2 of the GNU General Public License as published by the Free Software Foundation. Portions copied from the Keyspan driver by Hugh Blemings History: see the git log. Work sponsored by: Sigos GmbH, Germany This driver exists because the "normal" serial driver doesn't work too well with GSM modems. Issues: - data loss -- one single Receive URB is not nearly enough - controlling the baud rate doesn't make sense */ #define DRIVER_VERSION "v0.7.2" #define DRIVER_AUTHOR "Matthias Urlichs " #define DRIVER_DESC "USB Driver for GSM modems" #include #include #include #include #include #include #include #include #include #include #include #include #include "usb-wwan.h" static bool debug; void usb_wwan_dtr_rts(struct usb_serial_port *port, int on) { struct usb_serial *serial = port->serial; struct usb_wwan_port_private *portdata; struct usb_wwan_intf_private *intfdata; dbg("%s", __func__); intfdata = port->serial->private; if (!intfdata->send_setup) return; portdata = usb_get_serial_port_data(port); mutex_lock(&serial->disc_mutex); portdata->rts_state = on; portdata->dtr_state = on; if (serial->dev) intfdata->send_setup(port); mutex_unlock(&serial->disc_mutex); } EXPORT_SYMBOL(usb_wwan_dtr_rts); void usb_wwan_set_termios(struct tty_struct *tty, struct usb_serial_port *port, struct ktermios *old_termios) { struct usb_wwan_intf_private *intfdata = port->serial->private; dbg("%s", __func__); /* Doesn't support option setting */ tty_termios_copy_hw(tty->termios, old_termios); if (intfdata->send_setup) intfdata->send_setup(port); } EXPORT_SYMBOL(usb_wwan_set_termios); int usb_wwan_tiocmget(struct tty_struct *tty) { struct usb_serial_port *port = tty->driver_data; unsigned int value; struct usb_wwan_port_private *portdata; portdata = usb_get_serial_port_data(port); value = ((portdata->rts_state) ? TIOCM_RTS : 0) | ((portdata->dtr_state) ? TIOCM_DTR : 0) | ((portdata->cts_state) ? TIOCM_CTS : 0) | ((portdata->dsr_state) ? TIOCM_DSR : 0) | ((portdata->dcd_state) ? TIOCM_CAR : 0) | ((portdata->ri_state) ? TIOCM_RNG : 0); return value; } EXPORT_SYMBOL(usb_wwan_tiocmget); int usb_wwan_tiocmset(struct tty_struct *tty, unsigned int set, unsigned int clear) { struct usb_serial_port *port = tty->driver_data; struct usb_wwan_port_private *portdata; struct usb_wwan_intf_private *intfdata; portdata = usb_get_serial_port_data(port); intfdata = port->serial->private; if (!intfdata->send_setup) return -EINVAL; /* FIXME: what locks portdata fields ? */ if (set & TIOCM_RTS) portdata->rts_state = 1; if (set & TIOCM_DTR) portdata->dtr_state = 1; if (clear & TIOCM_RTS) portdata->rts_state = 0; if (clear & TIOCM_DTR) portdata->dtr_state = 0; return intfdata->send_setup(port); } EXPORT_SYMBOL(usb_wwan_tiocmset); static int get_serial_info(struct usb_serial_port *port, struct serial_struct __user *retinfo) { struct serial_struct tmp; if (!retinfo) return -EFAULT; memset(&tmp, 0, sizeof(tmp)); tmp.line = port->serial->minor; tmp.port = port->number; tmp.baud_base = tty_get_baud_rate(port->port.tty); tmp.close_delay = port->port.close_delay / 10; tmp.closing_wait = port->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ? ASYNC_CLOSING_WAIT_NONE : port->port.closing_wait / 10; if (copy_to_user(retinfo, &tmp, sizeof(*retinfo))) return -EFAULT; return 0; } static int set_serial_info(struct usb_serial_port *port, struct serial_struct __user *newinfo) { struct serial_struct new_serial; unsigned int closing_wait, close_delay; int retval = 0; if (copy_from_user(&new_serial, newinfo, sizeof(new_serial))) return -EFAULT; close_delay = new_serial.close_delay * 10; closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ? ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10; mutex_lock(&port->port.mutex); if (!capable(CAP_SYS_ADMIN)) { if ((close_delay != port->port.close_delay) || (closing_wait != port->port.closing_wait)) retval = -EPERM; else retval = -EOPNOTSUPP; } else { port->port.close_delay = close_delay; port->port.closing_wait = closing_wait; } mutex_unlock(&port->port.mutex); return retval; } int usb_wwan_ioctl(struct tty_struct *tty, unsigned int cmd, unsigned long arg) { struct usb_serial_port *port = tty->driver_data; dbg("%s cmd 0x%04x", __func__, cmd); switch (cmd) { case TIOCGSERIAL: return get_serial_info(port, (struct serial_struct __user *) arg); case TIOCSSERIAL: return set_serial_info(port, (struct serial_struct __user *) arg); default: break; } dbg("%s arg not supported", __func__); return -ENOIOCTLCMD; } EXPORT_SYMBOL(usb_wwan_ioctl); /* Write */ int usb_wwan_write(struct tty_struct *tty, struct usb_serial_port *port, const unsigned char *buf, int count) { struct usb_wwan_port_private *portdata; struct usb_wwan_intf_private *intfdata; int i; int left, todo; struct urb *this_urb = NULL; /* spurious */ int err; unsigned long flags; portdata = usb_get_serial_port_data(port); intfdata = port->serial->private; dbg("%s: write (%d chars)", __func__, count); i = 0; left = count; for (i = 0; left > 0 && i < N_OUT_URB; i++) { todo = left; if (todo > OUT_BUFLEN) todo = OUT_BUFLEN; this_urb = portdata->out_urbs[i]; if (test_and_set_bit(i, &portdata->out_busy)) { if (time_before(jiffies, portdata->tx_start_time[i] + 10 * HZ)) continue; usb_unlink_urb(this_urb); continue; } dbg("%s: endpoint %d buf %d", __func__, usb_pipeendpoint(this_urb->pipe), i); err = usb_autopm_get_interface_async(port->serial->interface); if (err < 0) break; /* send the data */ memcpy(this_urb->transfer_buffer, buf, todo); this_urb->transfer_buffer_length = todo; spin_lock_irqsave(&intfdata->susp_lock, flags); if (intfdata->suspended) { usb_anchor_urb(this_urb, &portdata->delayed); spin_unlock_irqrestore(&intfdata->susp_lock, flags); } else { intfdata->in_flight++; spin_unlock_irqrestore(&intfdata->susp_lock, flags); usb_anchor_urb(this_urb, &portdata->submitted); err = usb_submit_urb(this_urb, GFP_ATOMIC); if (err) { dbg("usb_submit_urb %p (write bulk) failed " "(%d)", this_urb, err); usb_unanchor_urb(this_urb); clear_bit(i, &portdata->out_busy); spin_lock_irqsave(&intfdata->susp_lock, flags); intfdata->in_flight--; spin_unlock_irqrestore(&intfdata->susp_lock, flags); usb_autopm_put_interface_async(port->serial->interface); break; } } portdata->tx_start_time[i] = jiffies; buf += todo; left -= todo; } count -= left; dbg("%s: wrote (did %d)", __func__, count); return count; } EXPORT_SYMBOL(usb_wwan_write); static void usb_wwan_in_work(struct work_struct *w) { struct usb_wwan_port_private *portdata = container_of(w, struct usb_wwan_port_private, in_work); struct usb_wwan_intf_private *intfdata; struct list_head *q = &portdata->in_urb_list; struct urb *urb; unsigned char *data; struct tty_struct *tty; struct usb_serial_port *port; int err; ssize_t len; ssize_t count; unsigned long flags; spin_lock_irqsave(&portdata->in_lock, flags); while (!list_empty(q)) { urb = list_first_entry(q, struct urb, urb_list); port = urb->context; if (port->throttle_req || port->throttled) break; tty = tty_port_tty_get(&port->port); if (!tty) break; /* list_empty() will still be false after this; it means * URB is still being processed */ list_del(&urb->urb_list); spin_unlock_irqrestore(&portdata->in_lock, flags); len = urb->actual_length - portdata->n_read; data = urb->transfer_buffer + portdata->n_read; count = tty_insert_flip_string(tty, data, len); tty_flip_buffer_push(tty); tty_kref_put(tty); if (count < len) { dbg("%s: len:%d count:%d n_read:%d\n", __func__, len, count, portdata->n_read); portdata->n_read += count; port->throttled = true; /* add request back to list */ spin_lock_irqsave(&portdata->in_lock, flags); list_add(&urb->urb_list, q); spin_unlock_irqrestore(&portdata->in_lock, flags); return; } /* re-init list pointer to indicate we are done with it */ INIT_LIST_HEAD(&urb->urb_list); portdata->n_read = 0; intfdata = port->serial->private; spin_lock_irqsave(&intfdata->susp_lock, flags); if (!intfdata->suspended && !urb->anchor) { usb_anchor_urb(urb, &portdata->submitted); err = usb_submit_urb(urb, GFP_ATOMIC); if (err) { usb_unanchor_urb(urb); if (err != -EPERM) pr_err("%s: submit read urb failed:%d", __func__, err); } usb_mark_last_busy(port->serial->dev); } spin_unlock_irqrestore(&intfdata->susp_lock, flags); spin_lock_irqsave(&portdata->in_lock, flags); } spin_unlock_irqrestore(&portdata->in_lock, flags); } static void usb_wwan_indat_callback(struct urb *urb) { int err; int endpoint; struct usb_wwan_port_private *portdata; struct usb_wwan_intf_private *intfdata; struct usb_serial_port *port; int status = urb->status; unsigned long flags; dbg("%s: %p", __func__, urb); endpoint = usb_pipeendpoint(urb->pipe); port = urb->context; portdata = usb_get_serial_port_data(port); intfdata = port->serial->private; usb_mark_last_busy(port->serial->dev); if ((status == -ENOENT || !status) && urb->actual_length) { spin_lock_irqsave(&portdata->in_lock, flags); list_add_tail(&urb->urb_list, &portdata->in_urb_list); spin_unlock_irqrestore(&portdata->in_lock, flags); queue_work(system_nrt_wq, &portdata->in_work); return; } dbg("%s: nonzero status: %d on endpoint %02x.", __func__, status, endpoint); spin_lock(&intfdata->susp_lock); if (intfdata->suspended || !portdata->opened) { spin_unlock(&intfdata->susp_lock); return; } spin_unlock(&intfdata->susp_lock); if (status != -ESHUTDOWN) { usb_anchor_urb(urb, &portdata->submitted); err = usb_submit_urb(urb, GFP_ATOMIC); if (err) { usb_unanchor_urb(urb); if (err != -EPERM) pr_err("%s: submit read urb failed:%d", __func__, err); } } } static void usb_wwan_outdat_callback(struct urb *urb) { struct usb_serial_port *port; struct usb_wwan_port_private *portdata; struct usb_wwan_intf_private *intfdata; int i; dbg("%s", __func__); port = urb->context; intfdata = port->serial->private; usb_serial_port_softint(port); usb_autopm_put_interface_async(port->serial->interface); portdata = usb_get_serial_port_data(port); spin_lock(&intfdata->susp_lock); intfdata->in_flight--; spin_unlock(&intfdata->susp_lock); for (i = 0; i < N_OUT_URB; ++i) { if (portdata->out_urbs[i] == urb) { smp_mb__before_clear_bit(); clear_bit(i, &portdata->out_busy); break; } } } int usb_wwan_write_room(struct tty_struct *tty) { struct usb_serial_port *port = tty->driver_data; struct usb_wwan_port_private *portdata; int i; int data_len = 0; struct urb *this_urb; portdata = usb_get_serial_port_data(port); for (i = 0; i < N_OUT_URB; i++) { this_urb = portdata->out_urbs[i]; if (this_urb && !test_bit(i, &portdata->out_busy)) data_len += OUT_BUFLEN; } dbg("%s: %d", __func__, data_len); return data_len; } EXPORT_SYMBOL(usb_wwan_write_room); int usb_wwan_chars_in_buffer(struct tty_struct *tty) { struct usb_serial_port *port = tty->driver_data; struct usb_wwan_port_private *portdata; int i; int data_len = 0; struct urb *this_urb; portdata = usb_get_serial_port_data(port); for (i = 0; i < N_OUT_URB; i++) { this_urb = portdata->out_urbs[i]; /* FIXME: This locking is insufficient as this_urb may go unused during the test */ if (this_urb && test_bit(i, &portdata->out_busy)) data_len += this_urb->transfer_buffer_length; } dbg("%s: %d", __func__, data_len); return data_len; } EXPORT_SYMBOL(usb_wwan_chars_in_buffer); void usb_wwan_throttle(struct tty_struct *tty) { struct usb_serial_port *port = tty->driver_data; port->throttle_req = true; dbg("%s:\n", __func__); } EXPORT_SYMBOL(usb_wwan_throttle); void usb_wwan_unthrottle(struct tty_struct *tty) { struct usb_serial_port *port = tty->driver_data; struct usb_wwan_port_private *portdata; portdata = usb_get_serial_port_data(port); dbg("%s:\n", __func__); port->throttle_req = false; port->throttled = false; queue_work(system_nrt_wq, &portdata->in_work); } EXPORT_SYMBOL(usb_wwan_unthrottle); int usb_wwan_open(struct tty_struct *tty, struct usb_serial_port *port) { struct usb_wwan_port_private *portdata; struct usb_wwan_intf_private *intfdata; struct usb_serial *serial = port->serial; int i, err; struct urb *urb; portdata = usb_get_serial_port_data(port); intfdata = serial->private; /* explicitly set the driver mode to raw */ tty->raw = 1; tty->real_raw = 1; tty->update_room_in_ldisc = 1; set_bit(TTY_NO_WRITE_SPLIT, &tty->flags); dbg("%s", __func__); /* Start reading from the IN endpoint */ for (i = 0; i < N_IN_URB; i++) { urb = portdata->in_urbs[i]; if (!urb) continue; usb_anchor_urb(urb, &portdata->submitted); err = usb_submit_urb(urb, GFP_KERNEL); if (err) { usb_unanchor_urb(urb); dbg("%s: submit urb %d failed (%d) %d", __func__, i, err, urb->transfer_buffer_length); } } if (intfdata->send_setup) intfdata->send_setup(port); serial->interface->needs_remote_wakeup = 1; spin_lock_irq(&intfdata->susp_lock); portdata->opened = 1; spin_unlock_irq(&intfdata->susp_lock); /* this balances a get in the generic USB serial code */ usb_autopm_put_interface(serial->interface); return 0; } EXPORT_SYMBOL(usb_wwan_open); void usb_wwan_close(struct usb_serial_port *port) { int i; struct usb_serial *serial = port->serial; struct usb_wwan_port_private *portdata; struct usb_wwan_intf_private *intfdata = port->serial->private; dbg("%s", __func__); portdata = usb_get_serial_port_data(port); if (serial->dev) { /* Stop reading/writing urbs */ spin_lock_irq(&intfdata->susp_lock); portdata->opened = 0; spin_unlock_irq(&intfdata->susp_lock); for (i = 0; i < N_IN_URB; i++) usb_kill_urb(portdata->in_urbs[i]); for (i = 0; i < N_OUT_URB; i++) usb_kill_urb(portdata->out_urbs[i]); /* balancing - important as an error cannot be handled*/ usb_autopm_get_interface_no_resume(serial->interface); serial->interface->needs_remote_wakeup = 0; } } EXPORT_SYMBOL(usb_wwan_close); /* Helper functions used by usb_wwan_setup_urbs */ static struct urb *usb_wwan_setup_urb(struct usb_serial *serial, int endpoint, int dir, void *ctx, char *buf, int len, void (*callback) (struct urb *)) { struct urb *urb; if (endpoint == -1) return NULL; /* endpoint not needed */ urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */ if (urb == NULL) { dbg("%s: alloc for endpoint %d failed.", __func__, endpoint); return NULL; } /* Fill URB using supplied data. */ usb_fill_bulk_urb(urb, serial->dev, usb_sndbulkpipe(serial->dev, endpoint) | dir, buf, len, callback, ctx); return urb; } /* Setup urbs */ static void usb_wwan_setup_urbs(struct usb_serial *serial) { int i, j; struct usb_serial_port *port; struct usb_wwan_port_private *portdata; dbg("%s", __func__); for (i = 0; i < serial->num_ports; i++) { port = serial->port[i]; portdata = usb_get_serial_port_data(port); /* Do indat endpoints first */ for (j = 0; j < N_IN_URB; ++j) { portdata->in_urbs[j] = usb_wwan_setup_urb(serial, port-> bulk_in_endpointAddress, USB_DIR_IN, port, portdata-> in_buffer[j], IN_BUFLEN, usb_wwan_indat_callback); } /* outdat endpoints */ for (j = 0; j < N_OUT_URB; ++j) { portdata->out_urbs[j] = usb_wwan_setup_urb(serial, port-> bulk_out_endpointAddress, USB_DIR_OUT, port, portdata-> out_buffer [j], OUT_BUFLEN, usb_wwan_outdat_callback); } } } int usb_wwan_startup(struct usb_serial *serial) { int i, j, err; struct usb_serial_port *port; struct usb_wwan_port_private *portdata; u8 *buffer; dbg("%s", __func__); /* Now setup per port private data */ for (i = 0; i < serial->num_ports; i++) { port = serial->port[i]; portdata = kzalloc(sizeof(*portdata), GFP_KERNEL); if (!portdata) { dbg("%s: kmalloc for usb_wwan_port_private (%d) failed!.", __func__, i); return 1; } init_usb_anchor(&portdata->delayed); init_usb_anchor(&portdata->submitted); INIT_WORK(&portdata->in_work, usb_wwan_in_work); INIT_LIST_HEAD(&portdata->in_urb_list); spin_lock_init(&portdata->in_lock); for (j = 0; j < N_IN_URB; j++) { buffer = kmalloc(IN_BUFLEN, GFP_KERNEL); if (!buffer) goto bail_out_error; portdata->in_buffer[j] = buffer; } for (j = 0; j < N_OUT_URB; j++) { buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL); if (!buffer) goto bail_out_error2; portdata->out_buffer[j] = buffer; } usb_set_serial_port_data(port, portdata); if (!port->interrupt_in_urb) continue; err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL); if (err) dbg("%s: submit irq_in urb failed %d", __func__, err); } usb_wwan_setup_urbs(serial); return 0; bail_out_error2: for (j = 0; j < N_OUT_URB; j++) kfree(portdata->out_buffer[j]); bail_out_error: for (j = 0; j < N_IN_URB; j++) kfree(portdata->in_buffer[j]); kfree(portdata); return 1; } EXPORT_SYMBOL(usb_wwan_startup); static void stop_read_write_urbs(struct usb_serial *serial) { int i; struct usb_serial_port *port; struct usb_wwan_port_private *portdata; /* Stop reading/writing urbs */ for (i = 0; i < serial->num_ports; ++i) { port = serial->port[i]; portdata = usb_get_serial_port_data(port); usb_kill_anchored_urbs(&portdata->submitted); } } void usb_wwan_disconnect(struct usb_serial *serial) { dbg("%s", __func__); stop_read_write_urbs(serial); } EXPORT_SYMBOL(usb_wwan_disconnect); void usb_wwan_release(struct usb_serial *serial) { int i, j; struct usb_serial_port *port; struct usb_wwan_port_private *portdata; struct urb *urb; struct list_head *q; unsigned long flags; /* Now free them */ for (i = 0; i < serial->num_ports; ++i) { port = serial->port[i]; portdata = usb_get_serial_port_data(port); cancel_work_sync(&portdata->in_work); /* TBD: do we really need this */ spin_lock_irqsave(&portdata->in_lock, flags); q = &portdata->in_urb_list; while (!list_empty(q)) { urb = list_first_entry(q, struct urb, urb_list); list_del_init(&urb->urb_list); } spin_unlock_irqrestore(&portdata->in_lock, flags); for (j = 0; j < N_IN_URB; j++) { usb_free_urb(portdata->in_urbs[j]); kfree(portdata->in_buffer[j]); portdata->in_urbs[j] = NULL; } for (j = 0; j < N_OUT_URB; j++) { usb_free_urb(portdata->out_urbs[j]); kfree(portdata->out_buffer[j]); portdata->out_urbs[j] = NULL; } } /* Now free per port private data */ for (i = 0; i < serial->num_ports; i++) { port = serial->port[i]; kfree(usb_get_serial_port_data(port)); } } EXPORT_SYMBOL(usb_wwan_release); #ifdef CONFIG_PM int usb_wwan_suspend(struct usb_serial *serial, pm_message_t message) { struct usb_wwan_intf_private *intfdata = serial->private; int b; dbg("%s entered", __func__); if (PMSG_IS_AUTO(message)) { spin_lock_irq(&intfdata->susp_lock); b = intfdata->in_flight; spin_unlock_irq(&intfdata->susp_lock); if (b || pm_runtime_autosuspend_expiration(&serial->dev->dev)) return -EBUSY; } spin_lock_irq(&intfdata->susp_lock); intfdata->suspended = 1; spin_unlock_irq(&intfdata->susp_lock); stop_read_write_urbs(serial); return 0; } EXPORT_SYMBOL(usb_wwan_suspend); static void unbusy_queued_urb(struct urb *urb, struct usb_wwan_port_private *portdata) { int i; for (i = 0; i < N_OUT_URB; i++) { if (urb == portdata->out_urbs[i]) { clear_bit(i, &portdata->out_busy); break; } } } static void play_delayed(struct usb_serial_port *port) { struct usb_wwan_intf_private *data; struct usb_wwan_port_private *portdata; struct urb *urb; int err; portdata = usb_get_serial_port_data(port); data = port->serial->private; while ((urb = usb_get_from_anchor(&portdata->delayed))) { usb_anchor_urb(urb, &portdata->submitted); err = usb_submit_urb(urb, GFP_ATOMIC); if (!err) { data->in_flight++; } else { usb_unanchor_urb(urb); /* we have to throw away the rest */ do { unbusy_queued_urb(urb, portdata); usb_autopm_put_interface_no_suspend(port->serial->interface); } while ((urb = usb_get_from_anchor(&portdata->delayed))); break; } } } int usb_wwan_resume(struct usb_serial *serial) { int i, j; struct usb_serial_port *port; struct usb_wwan_intf_private *intfdata = serial->private; struct usb_wwan_port_private *portdata; struct urb *urb; int err = 0; dbg("%s entered", __func__); /* get the interrupt URBs resubmitted unconditionally */ for (i = 0; i < serial->num_ports; i++) { port = serial->port[i]; if (!port->interrupt_in_urb) { dbg("%s: No interrupt URB for port %d", __func__, i); continue; } err = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO); dbg("Submitted interrupt URB for port %d (result %d)", i, err); if (err < 0) { err("%s: Error %d for interrupt URB of port%d", __func__, err, i); goto err_out; } } spin_lock_irq(&intfdata->susp_lock); intfdata->suspended = 0; for (i = 0; i < serial->num_ports; i++) { /* walk all ports */ port = serial->port[i]; portdata = usb_get_serial_port_data(port); /* skip closed ports */ if (!portdata->opened) continue; for (j = 0; j < N_IN_URB; j++) { urb = portdata->in_urbs[j]; /* don't re-submit if it already was submitted or if * it is being processed by in_work */ if (urb->anchor || !list_empty(&urb->urb_list)) continue; usb_anchor_urb(urb, &portdata->submitted); err = usb_submit_urb(urb, GFP_ATOMIC); if (err < 0) { err("%s: Error %d for bulk URB[%d]:%p %d", __func__, err, j, urb, i); usb_unanchor_urb(urb); intfdata->suspended = 1; spin_unlock_irq(&intfdata->susp_lock); goto err_out; } } play_delayed(port); } spin_unlock_irq(&intfdata->susp_lock); err_out: return err; } EXPORT_SYMBOL(usb_wwan_resume); #endif MODULE_AUTHOR(DRIVER_AUTHOR); MODULE_DESCRIPTION(DRIVER_DESC); MODULE_VERSION(DRIVER_VERSION); MODULE_LICENSE("GPL"); module_param(debug, bool, S_IRUGO | S_IWUSR); MODULE_PARM_DESC(debug, "Debug messages");