2 USB Driver layer for GSM modems
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.
12 History: see the git log.
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
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 = usb_get_serial_data(port->serial);
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 int usb_wwan_tiocmget(struct tty_struct *tty)
60 struct usb_serial_port *port = tty->driver_data;
62 struct usb_wwan_port_private *portdata;
64 portdata = usb_get_serial_port_data(port);
66 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
67 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
68 ((portdata->cts_state) ? TIOCM_CTS : 0) |
69 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
70 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
71 ((portdata->ri_state) ? TIOCM_RNG : 0);
75 EXPORT_SYMBOL(usb_wwan_tiocmget);
77 int usb_wwan_tiocmset(struct tty_struct *tty,
78 unsigned int set, unsigned int clear)
80 struct usb_serial_port *port = tty->driver_data;
81 struct usb_wwan_port_private *portdata;
82 struct usb_wwan_intf_private *intfdata;
84 portdata = usb_get_serial_port_data(port);
85 intfdata = usb_get_serial_data(port->serial);
87 if (!intfdata->send_setup)
90 /* FIXME: what locks portdata fields ? */
92 portdata->rts_state = 1;
94 portdata->dtr_state = 1;
96 if (clear & TIOCM_RTS)
97 portdata->rts_state = 0;
98 if (clear & TIOCM_DTR)
99 portdata->dtr_state = 0;
100 return intfdata->send_setup(port);
102 EXPORT_SYMBOL(usb_wwan_tiocmset);
104 static int get_serial_info(struct usb_serial_port *port,
105 struct serial_struct __user *retinfo)
107 struct serial_struct tmp;
112 memset(&tmp, 0, sizeof(tmp));
113 tmp.line = port->minor;
114 tmp.port = port->port_number;
115 tmp.baud_base = tty_get_baud_rate(port->port.tty);
116 tmp.close_delay = port->port.close_delay / 10;
117 tmp.closing_wait = port->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
118 ASYNC_CLOSING_WAIT_NONE :
119 port->port.closing_wait / 10;
121 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
126 static int set_serial_info(struct usb_serial_port *port,
127 struct serial_struct __user *newinfo)
129 struct serial_struct new_serial;
130 unsigned int closing_wait, close_delay;
133 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
136 close_delay = new_serial.close_delay * 10;
137 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
138 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
140 mutex_lock(&port->port.mutex);
142 if (!capable(CAP_SYS_ADMIN)) {
143 if ((close_delay != port->port.close_delay) ||
144 (closing_wait != port->port.closing_wait))
147 retval = -EOPNOTSUPP;
149 port->port.close_delay = close_delay;
150 port->port.closing_wait = closing_wait;
153 mutex_unlock(&port->port.mutex);
157 int usb_wwan_ioctl(struct tty_struct *tty,
158 unsigned int cmd, unsigned long arg)
160 struct usb_serial_port *port = tty->driver_data;
162 dev_dbg(&port->dev, "%s cmd 0x%04x\n", __func__, cmd);
166 return get_serial_info(port,
167 (struct serial_struct __user *) arg);
169 return set_serial_info(port,
170 (struct serial_struct __user *) arg);
175 dev_dbg(&port->dev, "%s arg not supported\n", __func__);
179 EXPORT_SYMBOL(usb_wwan_ioctl);
181 int usb_wwan_write(struct tty_struct *tty, struct usb_serial_port *port,
182 const unsigned char *buf, int count)
184 struct usb_wwan_port_private *portdata;
185 struct usb_wwan_intf_private *intfdata;
188 struct urb *this_urb = NULL; /* spurious */
192 portdata = usb_get_serial_port_data(port);
193 intfdata = usb_get_serial_data(port->serial);
195 dev_dbg(&port->dev, "%s: write (%d chars)\n", __func__, count);
199 for (i = 0; left > 0 && i < N_OUT_URB; i++) {
201 if (todo > OUT_BUFLEN)
204 this_urb = portdata->out_urbs[i];
205 if (test_and_set_bit(i, &portdata->out_busy)) {
206 if (time_before(jiffies,
207 portdata->tx_start_time[i] + 10 * HZ))
209 usb_unlink_urb(this_urb);
212 dev_dbg(&port->dev, "%s: endpoint %d buf %d\n", __func__,
213 usb_pipeendpoint(this_urb->pipe), i);
215 err = usb_autopm_get_interface_async(port->serial->interface);
217 clear_bit(i, &portdata->out_busy);
222 memcpy(this_urb->transfer_buffer, buf, todo);
223 this_urb->transfer_buffer_length = todo;
225 spin_lock_irqsave(&intfdata->susp_lock, flags);
226 if (intfdata->suspended) {
227 usb_anchor_urb(this_urb, &portdata->delayed);
228 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
230 intfdata->in_flight++;
231 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
232 err = usb_submit_urb(this_urb, GFP_ATOMIC);
235 "%s: submit urb %d failed: %d\n",
237 clear_bit(i, &portdata->out_busy);
238 spin_lock_irqsave(&intfdata->susp_lock, flags);
239 intfdata->in_flight--;
240 spin_unlock_irqrestore(&intfdata->susp_lock,
242 usb_autopm_put_interface_async(port->serial->interface);
247 portdata->tx_start_time[i] = jiffies;
253 dev_dbg(&port->dev, "%s: wrote (did %d)\n", __func__, count);
256 EXPORT_SYMBOL(usb_wwan_write);
258 static void usb_wwan_indat_callback(struct urb *urb)
262 struct usb_serial_port *port;
264 unsigned char *data = urb->transfer_buffer;
265 int status = urb->status;
267 endpoint = usb_pipeendpoint(urb->pipe);
272 dev_dbg(dev, "%s: nonzero status: %d on endpoint %02x.\n",
273 __func__, status, endpoint);
275 if (urb->actual_length) {
276 tty_insert_flip_string(&port->port, data,
278 tty_flip_buffer_push(&port->port);
280 dev_dbg(dev, "%s: empty read urb received\n", __func__);
282 /* Resubmit urb so we continue receiving */
283 err = usb_submit_urb(urb, GFP_ATOMIC);
286 dev_err(dev, "%s: resubmit read urb failed. (%d)\n",
288 /* busy also in error unless we are killed */
289 usb_mark_last_busy(port->serial->dev);
292 usb_mark_last_busy(port->serial->dev);
296 static void usb_wwan_outdat_callback(struct urb *urb)
298 struct usb_serial_port *port;
299 struct usb_wwan_port_private *portdata;
300 struct usb_wwan_intf_private *intfdata;
304 intfdata = usb_get_serial_data(port->serial);
306 usb_serial_port_softint(port);
307 usb_autopm_put_interface_async(port->serial->interface);
308 portdata = usb_get_serial_port_data(port);
309 spin_lock(&intfdata->susp_lock);
310 intfdata->in_flight--;
311 spin_unlock(&intfdata->susp_lock);
313 for (i = 0; i < N_OUT_URB; ++i) {
314 if (portdata->out_urbs[i] == urb) {
315 smp_mb__before_atomic();
316 clear_bit(i, &portdata->out_busy);
322 int usb_wwan_write_room(struct tty_struct *tty)
324 struct usb_serial_port *port = tty->driver_data;
325 struct usb_wwan_port_private *portdata;
328 struct urb *this_urb;
330 portdata = usb_get_serial_port_data(port);
332 for (i = 0; i < N_OUT_URB; i++) {
333 this_urb = portdata->out_urbs[i];
334 if (this_urb && !test_bit(i, &portdata->out_busy))
335 data_len += OUT_BUFLEN;
338 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
341 EXPORT_SYMBOL(usb_wwan_write_room);
343 int usb_wwan_chars_in_buffer(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 /* FIXME: This locking is insufficient as this_urb may
356 go unused during the test */
357 if (this_urb && test_bit(i, &portdata->out_busy))
358 data_len += this_urb->transfer_buffer_length;
360 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
363 EXPORT_SYMBOL(usb_wwan_chars_in_buffer);
365 int usb_wwan_open(struct tty_struct *tty, struct usb_serial_port *port)
367 struct usb_wwan_port_private *portdata;
368 struct usb_wwan_intf_private *intfdata;
369 struct usb_serial *serial = port->serial;
373 portdata = usb_get_serial_port_data(port);
374 intfdata = usb_get_serial_data(serial);
376 if (port->interrupt_in_urb) {
377 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
379 dev_err(&port->dev, "%s: submit int urb failed: %d\n",
384 /* Start reading from the IN endpoint */
385 for (i = 0; i < N_IN_URB; i++) {
386 urb = portdata->in_urbs[i];
389 err = usb_submit_urb(urb, GFP_KERNEL);
392 "%s: submit read urb %d failed: %d\n",
397 spin_lock_irq(&intfdata->susp_lock);
398 if (++intfdata->open_ports == 1)
399 serial->interface->needs_remote_wakeup = 1;
400 spin_unlock_irq(&intfdata->susp_lock);
401 /* this balances a get in the generic USB serial code */
402 usb_autopm_put_interface(serial->interface);
406 EXPORT_SYMBOL(usb_wwan_open);
408 static void unbusy_queued_urb(struct urb *urb,
409 struct usb_wwan_port_private *portdata)
413 for (i = 0; i < N_OUT_URB; i++) {
414 if (urb == portdata->out_urbs[i]) {
415 clear_bit(i, &portdata->out_busy);
421 void usb_wwan_close(struct usb_serial_port *port)
424 struct usb_serial *serial = port->serial;
425 struct usb_wwan_port_private *portdata;
426 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
429 portdata = usb_get_serial_port_data(port);
432 * Need to take susp_lock to make sure port is not already being
433 * resumed, but no need to hold it due to ASYNC_INITIALIZED.
435 spin_lock_irq(&intfdata->susp_lock);
436 if (--intfdata->open_ports == 0)
437 serial->interface->needs_remote_wakeup = 0;
438 spin_unlock_irq(&intfdata->susp_lock);
441 urb = usb_get_from_anchor(&portdata->delayed);
444 unbusy_queued_urb(urb, portdata);
445 usb_autopm_put_interface_async(serial->interface);
448 for (i = 0; i < N_IN_URB; i++)
449 usb_kill_urb(portdata->in_urbs[i]);
450 for (i = 0; i < N_OUT_URB; i++)
451 usb_kill_urb(portdata->out_urbs[i]);
452 usb_kill_urb(port->interrupt_in_urb);
454 usb_autopm_get_interface_no_resume(serial->interface);
456 EXPORT_SYMBOL(usb_wwan_close);
458 static struct urb *usb_wwan_setup_urb(struct usb_serial_port *port,
460 int dir, void *ctx, char *buf, int len,
461 void (*callback) (struct urb *))
463 struct usb_serial *serial = port->serial;
466 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
470 usb_fill_bulk_urb(urb, serial->dev,
471 usb_sndbulkpipe(serial->dev, endpoint) | dir,
472 buf, len, callback, ctx);
477 int usb_wwan_port_probe(struct usb_serial_port *port)
479 struct usb_wwan_port_private *portdata;
484 if (!port->bulk_in_size || !port->bulk_out_size)
487 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
491 init_usb_anchor(&portdata->delayed);
493 for (i = 0; i < N_IN_URB; i++) {
494 buffer = (u8 *)__get_free_page(GFP_KERNEL);
497 portdata->in_buffer[i] = buffer;
499 urb = usb_wwan_setup_urb(port, port->bulk_in_endpointAddress,
502 usb_wwan_indat_callback);
503 portdata->in_urbs[i] = urb;
506 for (i = 0; i < N_OUT_URB; i++) {
507 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
509 goto bail_out_error2;
510 portdata->out_buffer[i] = buffer;
512 urb = usb_wwan_setup_urb(port, port->bulk_out_endpointAddress,
515 usb_wwan_outdat_callback);
516 portdata->out_urbs[i] = urb;
519 usb_set_serial_port_data(port, portdata);
524 for (i = 0; i < N_OUT_URB; i++) {
525 usb_free_urb(portdata->out_urbs[i]);
526 kfree(portdata->out_buffer[i]);
529 for (i = 0; i < N_IN_URB; i++) {
530 usb_free_urb(portdata->in_urbs[i]);
531 free_page((unsigned long)portdata->in_buffer[i]);
537 EXPORT_SYMBOL_GPL(usb_wwan_port_probe);
539 int usb_wwan_port_remove(struct usb_serial_port *port)
542 struct usb_wwan_port_private *portdata;
544 portdata = usb_get_serial_port_data(port);
545 usb_set_serial_port_data(port, NULL);
547 for (i = 0; i < N_IN_URB; i++) {
548 usb_free_urb(portdata->in_urbs[i]);
549 free_page((unsigned long)portdata->in_buffer[i]);
551 for (i = 0; i < N_OUT_URB; i++) {
552 usb_free_urb(portdata->out_urbs[i]);
553 kfree(portdata->out_buffer[i]);
560 EXPORT_SYMBOL(usb_wwan_port_remove);
563 static void stop_urbs(struct usb_serial *serial)
566 struct usb_serial_port *port;
567 struct usb_wwan_port_private *portdata;
569 for (i = 0; i < serial->num_ports; ++i) {
570 port = serial->port[i];
571 portdata = usb_get_serial_port_data(port);
574 for (j = 0; j < N_IN_URB; j++)
575 usb_kill_urb(portdata->in_urbs[j]);
576 for (j = 0; j < N_OUT_URB; j++)
577 usb_kill_urb(portdata->out_urbs[j]);
578 usb_kill_urb(port->interrupt_in_urb);
582 int usb_wwan_suspend(struct usb_serial *serial, pm_message_t message)
584 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
586 spin_lock_irq(&intfdata->susp_lock);
587 if (PMSG_IS_AUTO(message)) {
588 if (intfdata->in_flight) {
589 spin_unlock_irq(&intfdata->susp_lock);
593 intfdata->suspended = 1;
594 spin_unlock_irq(&intfdata->susp_lock);
600 EXPORT_SYMBOL(usb_wwan_suspend);
602 /* Caller must hold susp_lock. */
603 static int usb_wwan_submit_delayed_urbs(struct usb_serial_port *port)
605 struct usb_serial *serial = port->serial;
606 struct usb_wwan_intf_private *data = usb_get_serial_data(serial);
607 struct usb_wwan_port_private *portdata;
612 portdata = usb_get_serial_port_data(port);
615 urb = usb_get_from_anchor(&portdata->delayed);
619 err = usb_submit_urb(urb, GFP_ATOMIC);
621 dev_err(&port->dev, "%s: submit urb failed: %d\n",
624 unbusy_queued_urb(urb, portdata);
625 usb_autopm_put_interface_async(serial->interface);
637 int usb_wwan_resume(struct usb_serial *serial)
640 struct usb_serial_port *port;
641 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
642 struct usb_wwan_port_private *portdata;
647 spin_lock_irq(&intfdata->susp_lock);
648 for (i = 0; i < serial->num_ports; i++) {
649 port = serial->port[i];
651 if (!test_bit(ASYNCB_INITIALIZED, &port->port.flags))
654 portdata = usb_get_serial_port_data(port);
656 if (port->interrupt_in_urb) {
657 err = usb_submit_urb(port->interrupt_in_urb,
661 "%s: submit int urb failed: %d\n",
667 err = usb_wwan_submit_delayed_urbs(port);
671 for (j = 0; j < N_IN_URB; j++) {
672 urb = portdata->in_urbs[j];
673 err = usb_submit_urb(urb, GFP_ATOMIC);
676 "%s: submit read urb %d failed: %d\n",
682 intfdata->suspended = 0;
683 spin_unlock_irq(&intfdata->susp_lock);
690 EXPORT_SYMBOL(usb_wwan_resume);
693 MODULE_AUTHOR(DRIVER_AUTHOR);
694 MODULE_DESCRIPTION(DRIVER_DESC);
695 MODULE_LICENSE("GPL");