1 // SPDX-License-Identifier: GPL-2.0
3 USB Driver layer for GSM modems
5 Copyright (C) 2005 Matthias Urlichs <smurf@smurf.noris.de>
7 Portions copied from the Keyspan driver by Hugh Blemings <hugh@blemings.org>
9 History: see the git log.
11 Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
13 This driver exists because the "normal" serial driver doesn't work too well
14 with GSM modems. Issues:
15 - data loss -- one single Receive URB is not nearly enough
16 - controlling the baud rate doesn't make sense
19 #define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
20 #define DRIVER_DESC "USB Driver for GSM modems"
22 #include <linux/kernel.h>
23 #include <linux/jiffies.h>
24 #include <linux/errno.h>
25 #include <linux/slab.h>
26 #include <linux/tty.h>
27 #include <linux/tty_flip.h>
28 #include <linux/module.h>
29 #include <linux/bitops.h>
30 #include <linux/uaccess.h>
31 #include <linux/usb.h>
32 #include <linux/usb/serial.h>
33 #include <linux/serial.h>
37 * Generate DTR/RTS signals on the port using the SET_CONTROL_LINE_STATE request
40 static int usb_wwan_send_setup(struct usb_serial_port *port)
42 struct usb_serial *serial = port->serial;
43 struct usb_wwan_port_private *portdata;
48 portdata = usb_get_serial_port_data(port);
50 if (portdata->dtr_state)
52 if (portdata->rts_state)
55 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
57 res = usb_autopm_get_interface(serial->interface);
61 res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
62 0x22, 0x21, val, ifnum, NULL, 0,
63 USB_CTRL_SET_TIMEOUT);
65 usb_autopm_put_interface(port->serial->interface);
70 void usb_wwan_dtr_rts(struct usb_serial_port *port, int on)
72 struct usb_wwan_port_private *portdata;
73 struct usb_wwan_intf_private *intfdata;
75 intfdata = usb_get_serial_data(port->serial);
77 if (!intfdata->use_send_setup)
80 portdata = usb_get_serial_port_data(port);
82 portdata->rts_state = on;
83 portdata->dtr_state = on;
85 usb_wwan_send_setup(port);
87 EXPORT_SYMBOL(usb_wwan_dtr_rts);
89 int usb_wwan_tiocmget(struct tty_struct *tty)
91 struct usb_serial_port *port = tty->driver_data;
93 struct usb_wwan_port_private *portdata;
95 portdata = usb_get_serial_port_data(port);
97 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
98 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
99 ((portdata->cts_state) ? TIOCM_CTS : 0) |
100 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
101 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
102 ((portdata->ri_state) ? TIOCM_RNG : 0);
106 EXPORT_SYMBOL(usb_wwan_tiocmget);
108 int usb_wwan_tiocmset(struct tty_struct *tty,
109 unsigned int set, unsigned int clear)
111 struct usb_serial_port *port = tty->driver_data;
112 struct usb_wwan_port_private *portdata;
113 struct usb_wwan_intf_private *intfdata;
115 portdata = usb_get_serial_port_data(port);
116 intfdata = usb_get_serial_data(port->serial);
118 if (!intfdata->use_send_setup)
121 /* FIXME: what locks portdata fields ? */
123 portdata->rts_state = 1;
125 portdata->dtr_state = 1;
127 if (clear & TIOCM_RTS)
128 portdata->rts_state = 0;
129 if (clear & TIOCM_DTR)
130 portdata->dtr_state = 0;
131 return usb_wwan_send_setup(port);
133 EXPORT_SYMBOL(usb_wwan_tiocmset);
135 int usb_wwan_get_serial_info(struct tty_struct *tty,
136 struct serial_struct *ss)
138 struct usb_serial_port *port = tty->driver_data;
140 ss->line = port->minor;
141 ss->port = port->port_number;
142 ss->baud_base = tty_get_baud_rate(port->port.tty);
143 ss->close_delay = jiffies_to_msecs(port->port.close_delay) / 10;
144 ss->closing_wait = port->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
145 ASYNC_CLOSING_WAIT_NONE :
146 jiffies_to_msecs(port->port.closing_wait) / 10;
149 EXPORT_SYMBOL(usb_wwan_get_serial_info);
151 int usb_wwan_set_serial_info(struct tty_struct *tty,
152 struct serial_struct *ss)
154 struct usb_serial_port *port = tty->driver_data;
155 unsigned int closing_wait, close_delay;
158 close_delay = msecs_to_jiffies(ss->close_delay * 10);
159 closing_wait = ss->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
160 ASYNC_CLOSING_WAIT_NONE :
161 msecs_to_jiffies(ss->closing_wait * 10);
163 mutex_lock(&port->port.mutex);
165 if (!capable(CAP_SYS_ADMIN)) {
166 if ((close_delay != port->port.close_delay) ||
167 (closing_wait != port->port.closing_wait))
170 retval = -EOPNOTSUPP;
172 port->port.close_delay = close_delay;
173 port->port.closing_wait = closing_wait;
176 mutex_unlock(&port->port.mutex);
179 EXPORT_SYMBOL(usb_wwan_set_serial_info);
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 /* don't resubmit on fatal errors */
276 if (status == -ESHUTDOWN || status == -ENOENT)
279 if (urb->actual_length) {
280 tty_insert_flip_string(&port->port, data,
282 tty_flip_buffer_push(&port->port);
284 dev_dbg(dev, "%s: empty read urb received\n", __func__);
286 /* Resubmit urb so we continue receiving */
287 err = usb_submit_urb(urb, GFP_ATOMIC);
289 if (err != -EPERM && err != -ENODEV) {
290 dev_err(dev, "%s: resubmit read urb failed. (%d)\n",
292 /* busy also in error unless we are killed */
293 usb_mark_last_busy(port->serial->dev);
296 usb_mark_last_busy(port->serial->dev);
300 static void usb_wwan_outdat_callback(struct urb *urb)
302 struct usb_serial_port *port;
303 struct usb_wwan_port_private *portdata;
304 struct usb_wwan_intf_private *intfdata;
309 intfdata = usb_get_serial_data(port->serial);
311 usb_serial_port_softint(port);
312 usb_autopm_put_interface_async(port->serial->interface);
313 portdata = usb_get_serial_port_data(port);
314 spin_lock_irqsave(&intfdata->susp_lock, flags);
315 intfdata->in_flight--;
316 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
318 for (i = 0; i < N_OUT_URB; ++i) {
319 if (portdata->out_urbs[i] == urb) {
320 smp_mb__before_atomic();
321 clear_bit(i, &portdata->out_busy);
327 int usb_wwan_write_room(struct tty_struct *tty)
329 struct usb_serial_port *port = tty->driver_data;
330 struct usb_wwan_port_private *portdata;
333 struct urb *this_urb;
335 portdata = usb_get_serial_port_data(port);
337 for (i = 0; i < N_OUT_URB; i++) {
338 this_urb = portdata->out_urbs[i];
339 if (this_urb && !test_bit(i, &portdata->out_busy))
340 data_len += OUT_BUFLEN;
343 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
346 EXPORT_SYMBOL(usb_wwan_write_room);
348 int usb_wwan_chars_in_buffer(struct tty_struct *tty)
350 struct usb_serial_port *port = tty->driver_data;
351 struct usb_wwan_port_private *portdata;
354 struct urb *this_urb;
356 portdata = usb_get_serial_port_data(port);
358 for (i = 0; i < N_OUT_URB; i++) {
359 this_urb = portdata->out_urbs[i];
360 /* FIXME: This locking is insufficient as this_urb may
361 go unused during the test */
362 if (this_urb && test_bit(i, &portdata->out_busy))
363 data_len += this_urb->transfer_buffer_length;
365 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
368 EXPORT_SYMBOL(usb_wwan_chars_in_buffer);
370 int usb_wwan_open(struct tty_struct *tty, struct usb_serial_port *port)
372 struct usb_wwan_port_private *portdata;
373 struct usb_wwan_intf_private *intfdata;
374 struct usb_serial *serial = port->serial;
378 portdata = usb_get_serial_port_data(port);
379 intfdata = usb_get_serial_data(serial);
381 if (port->interrupt_in_urb) {
382 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
384 dev_err(&port->dev, "%s: submit int urb failed: %d\n",
389 /* Start reading from the IN endpoint */
390 for (i = 0; i < N_IN_URB; i++) {
391 urb = portdata->in_urbs[i];
394 err = usb_submit_urb(urb, GFP_KERNEL);
397 "%s: submit read urb %d failed: %d\n",
402 spin_lock_irq(&intfdata->susp_lock);
403 if (++intfdata->open_ports == 1)
404 serial->interface->needs_remote_wakeup = 1;
405 spin_unlock_irq(&intfdata->susp_lock);
406 /* this balances a get in the generic USB serial code */
407 usb_autopm_put_interface(serial->interface);
411 EXPORT_SYMBOL(usb_wwan_open);
413 static void unbusy_queued_urb(struct urb *urb,
414 struct usb_wwan_port_private *portdata)
418 for (i = 0; i < N_OUT_URB; i++) {
419 if (urb == portdata->out_urbs[i]) {
420 clear_bit(i, &portdata->out_busy);
426 void usb_wwan_close(struct usb_serial_port *port)
429 struct usb_serial *serial = port->serial;
430 struct usb_wwan_port_private *portdata;
431 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
434 portdata = usb_get_serial_port_data(port);
437 * Need to take susp_lock to make sure port is not already being
438 * resumed, but no need to hold it due to the tty-port initialized
441 spin_lock_irq(&intfdata->susp_lock);
442 if (--intfdata->open_ports == 0)
443 serial->interface->needs_remote_wakeup = 0;
444 spin_unlock_irq(&intfdata->susp_lock);
447 urb = usb_get_from_anchor(&portdata->delayed);
450 unbusy_queued_urb(urb, portdata);
451 usb_autopm_put_interface_async(serial->interface);
454 for (i = 0; i < N_IN_URB; i++)
455 usb_kill_urb(portdata->in_urbs[i]);
456 for (i = 0; i < N_OUT_URB; i++)
457 usb_kill_urb(portdata->out_urbs[i]);
458 usb_kill_urb(port->interrupt_in_urb);
460 usb_autopm_get_interface_no_resume(serial->interface);
462 EXPORT_SYMBOL(usb_wwan_close);
464 static struct urb *usb_wwan_setup_urb(struct usb_serial_port *port,
466 int dir, void *ctx, char *buf, int len,
467 void (*callback) (struct urb *))
469 struct usb_serial *serial = port->serial;
470 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
473 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
477 usb_fill_bulk_urb(urb, serial->dev,
478 usb_sndbulkpipe(serial->dev, endpoint) | dir,
479 buf, len, callback, ctx);
481 if (intfdata->use_zlp && dir == USB_DIR_OUT)
482 urb->transfer_flags |= URB_ZERO_PACKET;
487 int usb_wwan_port_probe(struct usb_serial_port *port)
489 struct usb_wwan_port_private *portdata;
494 if (!port->bulk_in_size || !port->bulk_out_size)
497 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
501 init_usb_anchor(&portdata->delayed);
503 for (i = 0; i < N_IN_URB; i++) {
504 buffer = (u8 *)__get_free_page(GFP_KERNEL);
507 portdata->in_buffer[i] = buffer;
509 urb = usb_wwan_setup_urb(port, port->bulk_in_endpointAddress,
512 usb_wwan_indat_callback);
513 portdata->in_urbs[i] = urb;
516 for (i = 0; i < N_OUT_URB; i++) {
517 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
519 goto bail_out_error2;
520 portdata->out_buffer[i] = buffer;
522 urb = usb_wwan_setup_urb(port, port->bulk_out_endpointAddress,
525 usb_wwan_outdat_callback);
526 portdata->out_urbs[i] = urb;
529 usb_set_serial_port_data(port, portdata);
534 for (i = 0; i < N_OUT_URB; i++) {
535 usb_free_urb(portdata->out_urbs[i]);
536 kfree(portdata->out_buffer[i]);
539 for (i = 0; i < N_IN_URB; i++) {
540 usb_free_urb(portdata->in_urbs[i]);
541 free_page((unsigned long)portdata->in_buffer[i]);
547 EXPORT_SYMBOL_GPL(usb_wwan_port_probe);
549 int usb_wwan_port_remove(struct usb_serial_port *port)
552 struct usb_wwan_port_private *portdata;
554 portdata = usb_get_serial_port_data(port);
555 usb_set_serial_port_data(port, NULL);
557 for (i = 0; i < N_IN_URB; i++) {
558 usb_free_urb(portdata->in_urbs[i]);
559 free_page((unsigned long)portdata->in_buffer[i]);
561 for (i = 0; i < N_OUT_URB; i++) {
562 usb_free_urb(portdata->out_urbs[i]);
563 kfree(portdata->out_buffer[i]);
570 EXPORT_SYMBOL(usb_wwan_port_remove);
573 static void stop_urbs(struct usb_serial *serial)
576 struct usb_serial_port *port;
577 struct usb_wwan_port_private *portdata;
579 for (i = 0; i < serial->num_ports; ++i) {
580 port = serial->port[i];
581 portdata = usb_get_serial_port_data(port);
584 for (j = 0; j < N_IN_URB; j++)
585 usb_kill_urb(portdata->in_urbs[j]);
586 for (j = 0; j < N_OUT_URB; j++)
587 usb_kill_urb(portdata->out_urbs[j]);
588 usb_kill_urb(port->interrupt_in_urb);
592 int usb_wwan_suspend(struct usb_serial *serial, pm_message_t message)
594 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
596 spin_lock_irq(&intfdata->susp_lock);
597 if (PMSG_IS_AUTO(message)) {
598 if (intfdata->in_flight) {
599 spin_unlock_irq(&intfdata->susp_lock);
603 intfdata->suspended = 1;
604 spin_unlock_irq(&intfdata->susp_lock);
610 EXPORT_SYMBOL(usb_wwan_suspend);
612 /* Caller must hold susp_lock. */
613 static int usb_wwan_submit_delayed_urbs(struct usb_serial_port *port)
615 struct usb_serial *serial = port->serial;
616 struct usb_wwan_intf_private *data = usb_get_serial_data(serial);
617 struct usb_wwan_port_private *portdata;
622 portdata = usb_get_serial_port_data(port);
625 urb = usb_get_from_anchor(&portdata->delayed);
629 err = usb_submit_urb(urb, GFP_ATOMIC);
631 dev_err(&port->dev, "%s: submit urb failed: %d\n",
634 unbusy_queued_urb(urb, portdata);
635 usb_autopm_put_interface_async(serial->interface);
647 int usb_wwan_resume(struct usb_serial *serial)
650 struct usb_serial_port *port;
651 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
652 struct usb_wwan_port_private *portdata;
657 spin_lock_irq(&intfdata->susp_lock);
658 for (i = 0; i < serial->num_ports; i++) {
659 port = serial->port[i];
661 if (!tty_port_initialized(&port->port))
664 portdata = usb_get_serial_port_data(port);
666 if (port->interrupt_in_urb) {
667 err = usb_submit_urb(port->interrupt_in_urb,
671 "%s: submit int urb failed: %d\n",
677 err = usb_wwan_submit_delayed_urbs(port);
681 for (j = 0; j < N_IN_URB; j++) {
682 urb = portdata->in_urbs[j];
683 err = usb_submit_urb(urb, GFP_ATOMIC);
686 "%s: submit read urb %d failed: %d\n",
692 intfdata->suspended = 0;
693 spin_unlock_irq(&intfdata->susp_lock);
700 EXPORT_SYMBOL(usb_wwan_resume);
703 MODULE_AUTHOR(DRIVER_AUTHOR);
704 MODULE_DESCRIPTION(DRIVER_DESC);
705 MODULE_LICENSE("GPL v2");