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 = 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);
182 int usb_wwan_write(struct tty_struct *tty, struct usb_serial_port *port,
183 const unsigned char *buf, int count)
185 struct usb_wwan_port_private *portdata;
186 struct usb_wwan_intf_private *intfdata;
189 struct urb *this_urb = NULL; /* spurious */
193 portdata = usb_get_serial_port_data(port);
194 intfdata = usb_get_serial_data(port->serial);
196 dev_dbg(&port->dev, "%s: write (%d chars)\n", __func__, count);
200 for (i = 0; left > 0 && i < N_OUT_URB; i++) {
202 if (todo > OUT_BUFLEN)
205 this_urb = portdata->out_urbs[i];
206 if (test_and_set_bit(i, &portdata->out_busy)) {
207 if (time_before(jiffies,
208 portdata->tx_start_time[i] + 10 * HZ))
210 usb_unlink_urb(this_urb);
213 dev_dbg(&port->dev, "%s: endpoint %d buf %d\n", __func__,
214 usb_pipeendpoint(this_urb->pipe), i);
216 err = usb_autopm_get_interface_async(port->serial->interface);
218 clear_bit(i, &portdata->out_busy);
223 memcpy(this_urb->transfer_buffer, buf, todo);
224 this_urb->transfer_buffer_length = todo;
226 spin_lock_irqsave(&intfdata->susp_lock, flags);
227 if (intfdata->suspended) {
228 usb_anchor_urb(this_urb, &portdata->delayed);
229 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
231 intfdata->in_flight++;
232 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
233 err = usb_submit_urb(this_urb, GFP_ATOMIC);
236 "usb_submit_urb %p (write bulk) failed (%d)\n",
238 clear_bit(i, &portdata->out_busy);
239 spin_lock_irqsave(&intfdata->susp_lock, flags);
240 intfdata->in_flight--;
241 spin_unlock_irqrestore(&intfdata->susp_lock,
243 usb_autopm_put_interface_async(port->serial->interface);
248 portdata->tx_start_time[i] = jiffies;
254 dev_dbg(&port->dev, "%s: wrote (did %d)\n", __func__, count);
257 EXPORT_SYMBOL(usb_wwan_write);
259 static void usb_wwan_indat_callback(struct urb *urb)
263 struct usb_serial_port *port;
265 unsigned char *data = urb->transfer_buffer;
266 int status = urb->status;
268 endpoint = usb_pipeendpoint(urb->pipe);
273 dev_dbg(dev, "%s: nonzero status: %d on endpoint %02x.\n",
274 __func__, status, endpoint);
276 if (urb->actual_length) {
277 tty_insert_flip_string(&port->port, data,
279 tty_flip_buffer_push(&port->port);
281 dev_dbg(dev, "%s: empty read urb received\n", __func__);
283 /* Resubmit urb so we continue receiving */
284 err = usb_submit_urb(urb, GFP_ATOMIC);
287 dev_err(dev, "%s: resubmit read urb failed. (%d)\n",
289 /* busy also in error unless we are killed */
290 usb_mark_last_busy(port->serial->dev);
293 usb_mark_last_busy(port->serial->dev);
297 static void usb_wwan_outdat_callback(struct urb *urb)
299 struct usb_serial_port *port;
300 struct usb_wwan_port_private *portdata;
301 struct usb_wwan_intf_private *intfdata;
305 intfdata = usb_get_serial_data(port->serial);
307 usb_serial_port_softint(port);
308 usb_autopm_put_interface_async(port->serial->interface);
309 portdata = usb_get_serial_port_data(port);
310 spin_lock(&intfdata->susp_lock);
311 intfdata->in_flight--;
312 spin_unlock(&intfdata->susp_lock);
314 for (i = 0; i < N_OUT_URB; ++i) {
315 if (portdata->out_urbs[i] == urb) {
316 smp_mb__before_clear_bit();
317 clear_bit(i, &portdata->out_busy);
323 int usb_wwan_write_room(struct tty_struct *tty)
325 struct usb_serial_port *port = tty->driver_data;
326 struct usb_wwan_port_private *portdata;
329 struct urb *this_urb;
331 portdata = usb_get_serial_port_data(port);
333 for (i = 0; i < N_OUT_URB; i++) {
334 this_urb = portdata->out_urbs[i];
335 if (this_urb && !test_bit(i, &portdata->out_busy))
336 data_len += OUT_BUFLEN;
339 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
342 EXPORT_SYMBOL(usb_wwan_write_room);
344 int usb_wwan_chars_in_buffer(struct tty_struct *tty)
346 struct usb_serial_port *port = tty->driver_data;
347 struct usb_wwan_port_private *portdata;
350 struct urb *this_urb;
352 portdata = usb_get_serial_port_data(port);
354 for (i = 0; i < N_OUT_URB; i++) {
355 this_urb = portdata->out_urbs[i];
356 /* FIXME: This locking is insufficient as this_urb may
357 go unused during the test */
358 if (this_urb && test_bit(i, &portdata->out_busy))
359 data_len += this_urb->transfer_buffer_length;
361 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
364 EXPORT_SYMBOL(usb_wwan_chars_in_buffer);
366 int usb_wwan_open(struct tty_struct *tty, struct usb_serial_port *port)
368 struct usb_wwan_port_private *portdata;
369 struct usb_wwan_intf_private *intfdata;
370 struct usb_serial *serial = port->serial;
374 portdata = usb_get_serial_port_data(port);
375 intfdata = usb_get_serial_data(serial);
377 if (port->interrupt_in_urb) {
378 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
380 dev_dbg(&port->dev, "%s: submit int urb failed: %d\n",
385 /* Start reading from the IN endpoint */
386 for (i = 0; i < N_IN_URB; i++) {
387 urb = portdata->in_urbs[i];
390 err = usb_submit_urb(urb, GFP_KERNEL);
392 dev_dbg(&port->dev, "%s: submit urb %d failed (%d) %d\n",
393 __func__, i, err, urb->transfer_buffer_length);
397 spin_lock_irq(&intfdata->susp_lock);
398 portdata->opened = 1;
399 if (++intfdata->open_ports == 1)
400 serial->interface->needs_remote_wakeup = 1;
401 spin_unlock_irq(&intfdata->susp_lock);
402 /* this balances a get in the generic USB serial code */
403 usb_autopm_put_interface(serial->interface);
407 EXPORT_SYMBOL(usb_wwan_open);
409 static void unbusy_queued_urb(struct urb *urb,
410 struct usb_wwan_port_private *portdata)
414 for (i = 0; i < N_OUT_URB; i++) {
415 if (urb == portdata->out_urbs[i]) {
416 clear_bit(i, &portdata->out_busy);
422 void usb_wwan_close(struct usb_serial_port *port)
425 struct usb_serial *serial = port->serial;
426 struct usb_wwan_port_private *portdata;
427 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
430 portdata = usb_get_serial_port_data(port);
432 /* Stop reading/writing urbs */
433 spin_lock_irq(&intfdata->susp_lock);
434 portdata->opened = 0;
435 if (--intfdata->open_ports == 0)
436 serial->interface->needs_remote_wakeup = 0;
437 spin_unlock_irq(&intfdata->susp_lock);
440 urb = usb_get_from_anchor(&portdata->delayed);
443 unbusy_queued_urb(urb, portdata);
444 usb_autopm_put_interface_async(serial->interface);
447 for (i = 0; i < N_IN_URB; i++)
448 usb_kill_urb(portdata->in_urbs[i]);
449 for (i = 0; i < N_OUT_URB; i++)
450 usb_kill_urb(portdata->out_urbs[i]);
451 usb_kill_urb(port->interrupt_in_urb);
453 /* balancing - important as an error cannot be handled*/
454 usb_autopm_get_interface_no_resume(serial->interface);
456 EXPORT_SYMBOL(usb_wwan_close);
458 /* Helper functions used by usb_wwan_setup_urbs */
459 static struct urb *usb_wwan_setup_urb(struct usb_serial_port *port,
461 int dir, void *ctx, char *buf, int len,
462 void (*callback) (struct urb *))
464 struct usb_serial *serial = port->serial;
467 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
471 /* Fill URB using supplied data. */
472 usb_fill_bulk_urb(urb, serial->dev,
473 usb_sndbulkpipe(serial->dev, endpoint) | dir,
474 buf, len, callback, ctx);
479 int usb_wwan_port_probe(struct usb_serial_port *port)
481 struct usb_wwan_port_private *portdata;
486 if (!port->bulk_in_size || !port->bulk_out_size)
489 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
493 init_usb_anchor(&portdata->delayed);
495 for (i = 0; i < N_IN_URB; i++) {
496 buffer = (u8 *)__get_free_page(GFP_KERNEL);
499 portdata->in_buffer[i] = buffer;
501 urb = usb_wwan_setup_urb(port, port->bulk_in_endpointAddress,
504 usb_wwan_indat_callback);
505 portdata->in_urbs[i] = urb;
508 for (i = 0; i < N_OUT_URB; i++) {
509 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
511 goto bail_out_error2;
512 portdata->out_buffer[i] = buffer;
514 urb = usb_wwan_setup_urb(port, port->bulk_out_endpointAddress,
517 usb_wwan_outdat_callback);
518 portdata->out_urbs[i] = urb;
521 usb_set_serial_port_data(port, portdata);
526 for (i = 0; i < N_OUT_URB; i++) {
527 usb_free_urb(portdata->out_urbs[i]);
528 kfree(portdata->out_buffer[i]);
531 for (i = 0; i < N_IN_URB; i++) {
532 usb_free_urb(portdata->in_urbs[i]);
533 free_page((unsigned long)portdata->in_buffer[i]);
539 EXPORT_SYMBOL_GPL(usb_wwan_port_probe);
541 int usb_wwan_port_remove(struct usb_serial_port *port)
544 struct usb_wwan_port_private *portdata;
546 portdata = usb_get_serial_port_data(port);
547 usb_set_serial_port_data(port, NULL);
549 for (i = 0; i < N_IN_URB; i++) {
550 usb_free_urb(portdata->in_urbs[i]);
551 free_page((unsigned long)portdata->in_buffer[i]);
553 for (i = 0; i < N_OUT_URB; i++) {
554 usb_free_urb(portdata->out_urbs[i]);
555 kfree(portdata->out_buffer[i]);
562 EXPORT_SYMBOL(usb_wwan_port_remove);
565 static void stop_urbs(struct usb_serial *serial)
568 struct usb_serial_port *port;
569 struct usb_wwan_port_private *portdata;
571 /* Stop reading/writing urbs */
572 for (i = 0; i < serial->num_ports; ++i) {
573 port = serial->port[i];
574 portdata = usb_get_serial_port_data(port);
577 for (j = 0; j < N_IN_URB; j++)
578 usb_kill_urb(portdata->in_urbs[j]);
579 for (j = 0; j < N_OUT_URB; j++)
580 usb_kill_urb(portdata->out_urbs[j]);
581 usb_kill_urb(port->interrupt_in_urb);
585 int usb_wwan_suspend(struct usb_serial *serial, pm_message_t message)
587 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
589 spin_lock_irq(&intfdata->susp_lock);
590 if (PMSG_IS_AUTO(message)) {
591 if (intfdata->in_flight) {
592 spin_unlock_irq(&intfdata->susp_lock);
596 intfdata->suspended = 1;
597 spin_unlock_irq(&intfdata->susp_lock);
603 EXPORT_SYMBOL(usb_wwan_suspend);
605 static int play_delayed(struct usb_serial_port *port)
607 struct usb_serial *serial = port->serial;
608 struct usb_wwan_intf_private *data = usb_get_serial_data(serial);
609 struct usb_wwan_port_private *portdata;
614 portdata = usb_get_serial_port_data(port);
616 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
617 err = usb_submit_urb(urb, GFP_ATOMIC);
620 "%s: submit write urb failed: %d\n",
623 unbusy_queued_urb(urb, portdata);
624 usb_autopm_put_interface_async(serial->interface);
636 int usb_wwan_resume(struct usb_serial *serial)
639 struct usb_serial_port *port;
640 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
641 struct usb_wwan_port_private *portdata;
646 spin_lock_irq(&intfdata->susp_lock);
647 for (i = 0; i < serial->num_ports; i++) {
649 port = serial->port[i];
650 portdata = usb_get_serial_port_data(port);
652 /* skip closed ports */
653 if (!portdata || !portdata->opened)
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 = play_delayed(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");