Linux 3.12.39
[linux/fpc-iii.git] / drivers / usb / serial / usb_wwan.c
blobad5fff4399d77ddf72916d8da58ba726c0ed6a36
1 /*
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>
37 #include "usb-wwan.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 = port->serial->private;
46 if (!intfdata->send_setup)
47 return;
49 portdata = usb_get_serial_port_data(port);
50 /* FIXME: locking */
51 portdata->rts_state = on;
52 portdata->dtr_state = on;
54 intfdata->send_setup(port);
56 EXPORT_SYMBOL(usb_wwan_dtr_rts);
58 void usb_wwan_set_termios(struct tty_struct *tty,
59 struct usb_serial_port *port,
60 struct ktermios *old_termios)
62 struct usb_wwan_intf_private *intfdata = port->serial->private;
64 /* Doesn't support option setting */
65 tty_termios_copy_hw(&tty->termios, old_termios);
67 if (intfdata->send_setup)
68 intfdata->send_setup(port);
70 EXPORT_SYMBOL(usb_wwan_set_termios);
72 int usb_wwan_tiocmget(struct tty_struct *tty)
74 struct usb_serial_port *port = tty->driver_data;
75 unsigned int value;
76 struct usb_wwan_port_private *portdata;
78 portdata = usb_get_serial_port_data(port);
80 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
81 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
82 ((portdata->cts_state) ? TIOCM_CTS : 0) |
83 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
84 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
85 ((portdata->ri_state) ? TIOCM_RNG : 0);
87 return value;
89 EXPORT_SYMBOL(usb_wwan_tiocmget);
91 int usb_wwan_tiocmset(struct tty_struct *tty,
92 unsigned int set, unsigned int clear)
94 struct usb_serial_port *port = tty->driver_data;
95 struct usb_wwan_port_private *portdata;
96 struct usb_wwan_intf_private *intfdata;
98 portdata = usb_get_serial_port_data(port);
99 intfdata = port->serial->private;
101 if (!intfdata->send_setup)
102 return -EINVAL;
104 /* FIXME: what locks portdata fields ? */
105 if (set & TIOCM_RTS)
106 portdata->rts_state = 1;
107 if (set & TIOCM_DTR)
108 portdata->dtr_state = 1;
110 if (clear & TIOCM_RTS)
111 portdata->rts_state = 0;
112 if (clear & TIOCM_DTR)
113 portdata->dtr_state = 0;
114 return intfdata->send_setup(port);
116 EXPORT_SYMBOL(usb_wwan_tiocmset);
118 static int get_serial_info(struct usb_serial_port *port,
119 struct serial_struct __user *retinfo)
121 struct serial_struct tmp;
123 if (!retinfo)
124 return -EFAULT;
126 memset(&tmp, 0, sizeof(tmp));
127 tmp.line = port->minor;
128 tmp.port = port->port_number;
129 tmp.baud_base = tty_get_baud_rate(port->port.tty);
130 tmp.close_delay = port->port.close_delay / 10;
131 tmp.closing_wait = port->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
132 ASYNC_CLOSING_WAIT_NONE :
133 port->port.closing_wait / 10;
135 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
136 return -EFAULT;
137 return 0;
140 static int set_serial_info(struct usb_serial_port *port,
141 struct serial_struct __user *newinfo)
143 struct serial_struct new_serial;
144 unsigned int closing_wait, close_delay;
145 int retval = 0;
147 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
148 return -EFAULT;
150 close_delay = new_serial.close_delay * 10;
151 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
152 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
154 mutex_lock(&port->port.mutex);
156 if (!capable(CAP_SYS_ADMIN)) {
157 if ((close_delay != port->port.close_delay) ||
158 (closing_wait != port->port.closing_wait))
159 retval = -EPERM;
160 else
161 retval = -EOPNOTSUPP;
162 } else {
163 port->port.close_delay = close_delay;
164 port->port.closing_wait = closing_wait;
167 mutex_unlock(&port->port.mutex);
168 return retval;
171 int usb_wwan_ioctl(struct tty_struct *tty,
172 unsigned int cmd, unsigned long arg)
174 struct usb_serial_port *port = tty->driver_data;
176 dev_dbg(&port->dev, "%s cmd 0x%04x\n", __func__, cmd);
178 switch (cmd) {
179 case TIOCGSERIAL:
180 return get_serial_info(port,
181 (struct serial_struct __user *) arg);
182 case TIOCSSERIAL:
183 return set_serial_info(port,
184 (struct serial_struct __user *) arg);
185 default:
186 break;
189 dev_dbg(&port->dev, "%s arg not supported\n", __func__);
191 return -ENOIOCTLCMD;
193 EXPORT_SYMBOL(usb_wwan_ioctl);
195 /* Write */
196 int usb_wwan_write(struct tty_struct *tty, struct usb_serial_port *port,
197 const unsigned char *buf, int count)
199 struct usb_wwan_port_private *portdata;
200 struct usb_wwan_intf_private *intfdata;
201 int i;
202 int left, todo;
203 struct urb *this_urb = NULL; /* spurious */
204 int err;
205 unsigned long flags;
207 portdata = usb_get_serial_port_data(port);
208 intfdata = port->serial->private;
210 dev_dbg(&port->dev, "%s: write (%d chars)\n", __func__, count);
212 i = 0;
213 left = count;
214 for (i = 0; left > 0 && i < N_OUT_URB; i++) {
215 todo = left;
216 if (todo > OUT_BUFLEN)
217 todo = OUT_BUFLEN;
219 this_urb = portdata->out_urbs[i];
220 if (test_and_set_bit(i, &portdata->out_busy)) {
221 if (time_before(jiffies,
222 portdata->tx_start_time[i] + 10 * HZ))
223 continue;
224 usb_unlink_urb(this_urb);
225 continue;
227 dev_dbg(&port->dev, "%s: endpoint %d buf %d\n", __func__,
228 usb_pipeendpoint(this_urb->pipe), i);
230 err = usb_autopm_get_interface_async(port->serial->interface);
231 if (err < 0) {
232 clear_bit(i, &portdata->out_busy);
233 break;
236 /* send the data */
237 memcpy(this_urb->transfer_buffer, buf, todo);
238 this_urb->transfer_buffer_length = todo;
240 spin_lock_irqsave(&intfdata->susp_lock, flags);
241 if (intfdata->suspended) {
242 usb_anchor_urb(this_urb, &portdata->delayed);
243 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
244 } else {
245 intfdata->in_flight++;
246 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
247 err = usb_submit_urb(this_urb, GFP_ATOMIC);
248 if (err) {
249 dev_dbg(&port->dev,
250 "usb_submit_urb %p (write bulk) failed (%d)\n",
251 this_urb, err);
252 clear_bit(i, &portdata->out_busy);
253 spin_lock_irqsave(&intfdata->susp_lock, flags);
254 intfdata->in_flight--;
255 spin_unlock_irqrestore(&intfdata->susp_lock,
256 flags);
257 usb_autopm_put_interface_async(port->serial->interface);
258 break;
262 portdata->tx_start_time[i] = jiffies;
263 buf += todo;
264 left -= todo;
267 count -= left;
268 dev_dbg(&port->dev, "%s: wrote (did %d)\n", __func__, count);
269 return count;
271 EXPORT_SYMBOL(usb_wwan_write);
273 static void usb_wwan_indat_callback(struct urb *urb)
275 int err;
276 int endpoint;
277 struct usb_serial_port *port;
278 struct device *dev;
279 unsigned char *data = urb->transfer_buffer;
280 int status = urb->status;
282 endpoint = usb_pipeendpoint(urb->pipe);
283 port = urb->context;
284 dev = &port->dev;
286 if (status) {
287 dev_dbg(dev, "%s: nonzero status: %d on endpoint %02x.\n",
288 __func__, status, endpoint);
289 } else {
290 if (urb->actual_length) {
291 tty_insert_flip_string(&port->port, data,
292 urb->actual_length);
293 tty_flip_buffer_push(&port->port);
294 } else
295 dev_dbg(dev, "%s: empty read urb received\n", __func__);
297 /* Resubmit urb so we continue receiving */
298 err = usb_submit_urb(urb, GFP_ATOMIC);
299 if (err) {
300 if (err != -EPERM) {
301 dev_err(dev, "%s: resubmit read urb failed. (%d)\n",
302 __func__, err);
303 /* busy also in error unless we are killed */
304 usb_mark_last_busy(port->serial->dev);
306 } else {
307 usb_mark_last_busy(port->serial->dev);
311 static void usb_wwan_outdat_callback(struct urb *urb)
313 struct usb_serial_port *port;
314 struct usb_wwan_port_private *portdata;
315 struct usb_wwan_intf_private *intfdata;
316 int i;
318 port = urb->context;
319 intfdata = port->serial->private;
321 usb_serial_port_softint(port);
322 usb_autopm_put_interface_async(port->serial->interface);
323 portdata = usb_get_serial_port_data(port);
324 spin_lock(&intfdata->susp_lock);
325 intfdata->in_flight--;
326 spin_unlock(&intfdata->susp_lock);
328 for (i = 0; i < N_OUT_URB; ++i) {
329 if (portdata->out_urbs[i] == urb) {
330 smp_mb__before_clear_bit();
331 clear_bit(i, &portdata->out_busy);
332 break;
337 int usb_wwan_write_room(struct tty_struct *tty)
339 struct usb_serial_port *port = tty->driver_data;
340 struct usb_wwan_port_private *portdata;
341 int i;
342 int data_len = 0;
343 struct urb *this_urb;
345 portdata = usb_get_serial_port_data(port);
347 for (i = 0; i < N_OUT_URB; i++) {
348 this_urb = portdata->out_urbs[i];
349 if (this_urb && !test_bit(i, &portdata->out_busy))
350 data_len += OUT_BUFLEN;
353 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
354 return data_len;
356 EXPORT_SYMBOL(usb_wwan_write_room);
358 int usb_wwan_chars_in_buffer(struct tty_struct *tty)
360 struct usb_serial_port *port = tty->driver_data;
361 struct usb_wwan_port_private *portdata;
362 int i;
363 int data_len = 0;
364 struct urb *this_urb;
366 portdata = usb_get_serial_port_data(port);
368 for (i = 0; i < N_OUT_URB; i++) {
369 this_urb = portdata->out_urbs[i];
370 /* FIXME: This locking is insufficient as this_urb may
371 go unused during the test */
372 if (this_urb && test_bit(i, &portdata->out_busy))
373 data_len += this_urb->transfer_buffer_length;
375 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
376 return data_len;
378 EXPORT_SYMBOL(usb_wwan_chars_in_buffer);
380 int usb_wwan_open(struct tty_struct *tty, struct usb_serial_port *port)
382 struct usb_wwan_port_private *portdata;
383 struct usb_wwan_intf_private *intfdata;
384 struct usb_serial *serial = port->serial;
385 int i, err;
386 struct urb *urb;
388 portdata = usb_get_serial_port_data(port);
389 intfdata = serial->private;
391 if (port->interrupt_in_urb) {
392 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
393 if (err) {
394 dev_dbg(&port->dev, "%s: submit int urb failed: %d\n",
395 __func__, err);
399 /* Start reading from the IN endpoint */
400 for (i = 0; i < N_IN_URB; i++) {
401 urb = portdata->in_urbs[i];
402 if (!urb)
403 continue;
404 err = usb_submit_urb(urb, GFP_KERNEL);
405 if (err) {
406 dev_dbg(&port->dev, "%s: submit urb %d failed (%d) %d\n",
407 __func__, i, err, urb->transfer_buffer_length);
411 if (intfdata->send_setup)
412 intfdata->send_setup(port);
414 serial->interface->needs_remote_wakeup = 1;
415 spin_lock_irq(&intfdata->susp_lock);
416 portdata->opened = 1;
417 spin_unlock_irq(&intfdata->susp_lock);
418 /* this balances a get in the generic USB serial code */
419 usb_autopm_put_interface(serial->interface);
421 return 0;
423 EXPORT_SYMBOL(usb_wwan_open);
425 static void unbusy_queued_urb(struct urb *urb,
426 struct usb_wwan_port_private *portdata)
428 int i;
430 for (i = 0; i < N_OUT_URB; i++) {
431 if (urb == portdata->out_urbs[i]) {
432 clear_bit(i, &portdata->out_busy);
433 break;
438 void usb_wwan_close(struct usb_serial_port *port)
440 int i;
441 struct usb_serial *serial = port->serial;
442 struct usb_wwan_port_private *portdata;
443 struct usb_wwan_intf_private *intfdata = port->serial->private;
444 struct urb *urb;
446 portdata = usb_get_serial_port_data(port);
448 /* Stop reading/writing urbs */
449 spin_lock_irq(&intfdata->susp_lock);
450 portdata->opened = 0;
451 spin_unlock_irq(&intfdata->susp_lock);
453 for (;;) {
454 urb = usb_get_from_anchor(&portdata->delayed);
455 if (!urb)
456 break;
457 unbusy_queued_urb(urb, portdata);
458 usb_autopm_put_interface_async(serial->interface);
461 for (i = 0; i < N_IN_URB; i++)
462 usb_kill_urb(portdata->in_urbs[i]);
463 for (i = 0; i < N_OUT_URB; i++)
464 usb_kill_urb(portdata->out_urbs[i]);
465 usb_kill_urb(port->interrupt_in_urb);
467 /* balancing - important as an error cannot be handled*/
468 usb_autopm_get_interface_no_resume(serial->interface);
469 serial->interface->needs_remote_wakeup = 0;
471 EXPORT_SYMBOL(usb_wwan_close);
473 /* Helper functions used by usb_wwan_setup_urbs */
474 static struct urb *usb_wwan_setup_urb(struct usb_serial_port *port,
475 int endpoint,
476 int dir, void *ctx, char *buf, int len,
477 void (*callback) (struct urb *))
479 struct usb_serial *serial = port->serial;
480 struct urb *urb;
482 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
483 if (urb == NULL) {
484 dev_dbg(&serial->interface->dev,
485 "%s: alloc for endpoint %d failed.\n", __func__,
486 endpoint);
487 return NULL;
490 /* Fill URB using supplied data. */
491 usb_fill_bulk_urb(urb, serial->dev,
492 usb_sndbulkpipe(serial->dev, endpoint) | dir,
493 buf, len, callback, ctx);
495 return urb;
498 int usb_wwan_port_probe(struct usb_serial_port *port)
500 struct usb_wwan_port_private *portdata;
501 struct urb *urb;
502 u8 *buffer;
503 int i;
505 if (!port->bulk_in_size || !port->bulk_out_size)
506 return -ENODEV;
508 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
509 if (!portdata)
510 return -ENOMEM;
512 init_usb_anchor(&portdata->delayed);
514 for (i = 0; i < N_IN_URB; i++) {
515 buffer = (u8 *)__get_free_page(GFP_KERNEL);
516 if (!buffer)
517 goto bail_out_error;
518 portdata->in_buffer[i] = buffer;
520 urb = usb_wwan_setup_urb(port, port->bulk_in_endpointAddress,
521 USB_DIR_IN, port,
522 buffer, IN_BUFLEN,
523 usb_wwan_indat_callback);
524 portdata->in_urbs[i] = urb;
527 for (i = 0; i < N_OUT_URB; i++) {
528 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
529 if (!buffer)
530 goto bail_out_error2;
531 portdata->out_buffer[i] = buffer;
533 urb = usb_wwan_setup_urb(port, port->bulk_out_endpointAddress,
534 USB_DIR_OUT, port,
535 buffer, OUT_BUFLEN,
536 usb_wwan_outdat_callback);
537 portdata->out_urbs[i] = urb;
540 usb_set_serial_port_data(port, portdata);
542 return 0;
544 bail_out_error2:
545 for (i = 0; i < N_OUT_URB; i++) {
546 usb_free_urb(portdata->out_urbs[i]);
547 kfree(portdata->out_buffer[i]);
549 bail_out_error:
550 for (i = 0; i < N_IN_URB; i++) {
551 usb_free_urb(portdata->in_urbs[i]);
552 free_page((unsigned long)portdata->in_buffer[i]);
554 kfree(portdata);
556 return -ENOMEM;
558 EXPORT_SYMBOL_GPL(usb_wwan_port_probe);
560 int usb_wwan_port_remove(struct usb_serial_port *port)
562 int i;
563 struct usb_wwan_port_private *portdata;
565 portdata = usb_get_serial_port_data(port);
566 usb_set_serial_port_data(port, NULL);
568 /* Stop reading/writing urbs and free them */
569 for (i = 0; i < N_IN_URB; i++) {
570 usb_kill_urb(portdata->in_urbs[i]);
571 usb_free_urb(portdata->in_urbs[i]);
572 free_page((unsigned long)portdata->in_buffer[i]);
574 for (i = 0; i < N_OUT_URB; i++) {
575 usb_kill_urb(portdata->out_urbs[i]);
576 usb_free_urb(portdata->out_urbs[i]);
577 kfree(portdata->out_buffer[i]);
580 /* Now free port private data */
581 kfree(portdata);
582 return 0;
584 EXPORT_SYMBOL(usb_wwan_port_remove);
586 #ifdef CONFIG_PM
587 static void stop_read_write_urbs(struct usb_serial *serial)
589 int i, j;
590 struct usb_serial_port *port;
591 struct usb_wwan_port_private *portdata;
593 /* Stop reading/writing urbs */
594 for (i = 0; i < serial->num_ports; ++i) {
595 port = serial->port[i];
596 portdata = usb_get_serial_port_data(port);
597 if (!portdata)
598 continue;
599 for (j = 0; j < N_IN_URB; j++)
600 usb_kill_urb(portdata->in_urbs[j]);
601 for (j = 0; j < N_OUT_URB; j++)
602 usb_kill_urb(portdata->out_urbs[j]);
606 int usb_wwan_suspend(struct usb_serial *serial, pm_message_t message)
608 struct usb_wwan_intf_private *intfdata = serial->private;
610 spin_lock_irq(&intfdata->susp_lock);
611 if (PMSG_IS_AUTO(message)) {
612 if (intfdata->in_flight) {
613 spin_unlock_irq(&intfdata->susp_lock);
614 return -EBUSY;
617 intfdata->suspended = 1;
618 spin_unlock_irq(&intfdata->susp_lock);
620 stop_read_write_urbs(serial);
622 return 0;
624 EXPORT_SYMBOL(usb_wwan_suspend);
626 static int play_delayed(struct usb_serial_port *port)
628 struct usb_wwan_intf_private *data;
629 struct usb_wwan_port_private *portdata;
630 struct urb *urb;
631 int err = 0;
633 portdata = usb_get_serial_port_data(port);
634 data = port->serial->private;
635 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
636 err = usb_submit_urb(urb, GFP_ATOMIC);
637 if (!err) {
638 data->in_flight++;
639 } else {
640 /* we have to throw away the rest */
641 do {
642 unbusy_queued_urb(urb, portdata);
643 usb_autopm_put_interface_no_suspend(port->serial->interface);
644 } while ((urb = usb_get_from_anchor(&portdata->delayed)));
645 break;
649 return err;
652 int usb_wwan_resume(struct usb_serial *serial)
654 int i, j;
655 struct usb_serial_port *port;
656 struct usb_wwan_intf_private *intfdata = serial->private;
657 struct usb_wwan_port_private *portdata;
658 struct urb *urb;
659 int err;
660 int err_count = 0;
662 spin_lock_irq(&intfdata->susp_lock);
663 for (i = 0; i < serial->num_ports; i++) {
664 /* walk all ports */
665 port = serial->port[i];
666 portdata = usb_get_serial_port_data(port);
668 /* skip closed ports */
669 if (!portdata || !portdata->opened)
670 continue;
672 if (port->interrupt_in_urb) {
673 err = usb_submit_urb(port->interrupt_in_urb,
674 GFP_ATOMIC);
675 if (err) {
676 dev_err(&port->dev,
677 "%s: submit int urb failed: %d\n",
678 __func__, err);
679 err_count++;
683 err = play_delayed(port);
684 if (err)
685 err_count++;
687 for (j = 0; j < N_IN_URB; j++) {
688 urb = portdata->in_urbs[j];
689 err = usb_submit_urb(urb, GFP_ATOMIC);
690 if (err < 0) {
691 dev_err(&port->dev, "%s: Error %d for bulk URB %d\n",
692 __func__, err, i);
693 err_count++;
697 intfdata->suspended = 0;
698 spin_unlock_irq(&intfdata->susp_lock);
700 if (err_count)
701 return -EIO;
703 return 0;
705 EXPORT_SYMBOL(usb_wwan_resume);
706 #endif
708 MODULE_AUTHOR(DRIVER_AUTHOR);
709 MODULE_DESCRIPTION(DRIVER_DESC);
710 MODULE_LICENSE("GPL");