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_write(struct tty_struct *tty, struct usb_serial_port *port,
136 const unsigned char *buf, int count)
138 struct usb_wwan_port_private *portdata;
139 struct usb_wwan_intf_private *intfdata;
142 struct urb *this_urb = NULL; /* spurious */
146 portdata = usb_get_serial_port_data(port);
147 intfdata = usb_get_serial_data(port->serial);
149 dev_dbg(&port->dev, "%s: write (%d chars)\n", __func__, count);
153 for (i = 0; left > 0 && i < N_OUT_URB; i++) {
155 if (todo > OUT_BUFLEN)
158 this_urb = portdata->out_urbs[i];
159 if (test_and_set_bit(i, &portdata->out_busy)) {
160 if (time_before(jiffies,
161 portdata->tx_start_time[i] + 10 * HZ))
163 usb_unlink_urb(this_urb);
166 dev_dbg(&port->dev, "%s: endpoint %d buf %d\n", __func__,
167 usb_pipeendpoint(this_urb->pipe), i);
169 err = usb_autopm_get_interface_async(port->serial->interface);
171 clear_bit(i, &portdata->out_busy);
176 memcpy(this_urb->transfer_buffer, buf, todo);
177 this_urb->transfer_buffer_length = todo;
179 spin_lock_irqsave(&intfdata->susp_lock, flags);
180 if (intfdata->suspended) {
181 usb_anchor_urb(this_urb, &portdata->delayed);
182 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
184 intfdata->in_flight++;
185 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
186 err = usb_submit_urb(this_urb, GFP_ATOMIC);
189 "%s: submit urb %d failed: %d\n",
191 clear_bit(i, &portdata->out_busy);
192 spin_lock_irqsave(&intfdata->susp_lock, flags);
193 intfdata->in_flight--;
194 spin_unlock_irqrestore(&intfdata->susp_lock,
196 usb_autopm_put_interface_async(port->serial->interface);
201 portdata->tx_start_time[i] = jiffies;
207 dev_dbg(&port->dev, "%s: wrote (did %d)\n", __func__, count);
210 EXPORT_SYMBOL(usb_wwan_write);
212 static void usb_wwan_indat_callback(struct urb *urb)
216 struct usb_serial_port *port;
218 unsigned char *data = urb->transfer_buffer;
219 int status = urb->status;
221 endpoint = usb_pipeendpoint(urb->pipe);
226 dev_dbg(dev, "%s: nonzero status: %d on endpoint %02x.\n",
227 __func__, status, endpoint);
229 /* don't resubmit on fatal errors */
230 if (status == -ESHUTDOWN || status == -ENOENT)
233 if (urb->actual_length) {
234 tty_insert_flip_string(&port->port, data,
236 tty_flip_buffer_push(&port->port);
238 dev_dbg(dev, "%s: empty read urb received\n", __func__);
240 /* Resubmit urb so we continue receiving */
241 err = usb_submit_urb(urb, GFP_ATOMIC);
243 if (err != -EPERM && err != -ENODEV) {
244 dev_err(dev, "%s: resubmit read urb failed. (%d)\n",
246 /* busy also in error unless we are killed */
247 usb_mark_last_busy(port->serial->dev);
250 usb_mark_last_busy(port->serial->dev);
254 static void usb_wwan_outdat_callback(struct urb *urb)
256 struct usb_serial_port *port;
257 struct usb_wwan_port_private *portdata;
258 struct usb_wwan_intf_private *intfdata;
263 intfdata = usb_get_serial_data(port->serial);
265 usb_serial_port_softint(port);
266 usb_autopm_put_interface_async(port->serial->interface);
267 portdata = usb_get_serial_port_data(port);
268 spin_lock_irqsave(&intfdata->susp_lock, flags);
269 intfdata->in_flight--;
270 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
272 for (i = 0; i < N_OUT_URB; ++i) {
273 if (portdata->out_urbs[i] == urb) {
274 smp_mb__before_atomic();
275 clear_bit(i, &portdata->out_busy);
281 unsigned int usb_wwan_write_room(struct tty_struct *tty)
283 struct usb_serial_port *port = tty->driver_data;
284 struct usb_wwan_port_private *portdata;
286 unsigned int data_len = 0;
287 struct urb *this_urb;
289 portdata = usb_get_serial_port_data(port);
291 for (i = 0; i < N_OUT_URB; i++) {
292 this_urb = portdata->out_urbs[i];
293 if (this_urb && !test_bit(i, &portdata->out_busy))
294 data_len += OUT_BUFLEN;
297 dev_dbg(&port->dev, "%s: %u\n", __func__, data_len);
300 EXPORT_SYMBOL(usb_wwan_write_room);
302 unsigned int usb_wwan_chars_in_buffer(struct tty_struct *tty)
304 struct usb_serial_port *port = tty->driver_data;
305 struct usb_wwan_port_private *portdata;
307 unsigned int data_len = 0;
308 struct urb *this_urb;
310 portdata = usb_get_serial_port_data(port);
312 for (i = 0; i < N_OUT_URB; i++) {
313 this_urb = portdata->out_urbs[i];
314 /* FIXME: This locking is insufficient as this_urb may
315 go unused during the test */
316 if (this_urb && test_bit(i, &portdata->out_busy))
317 data_len += this_urb->transfer_buffer_length;
319 dev_dbg(&port->dev, "%s: %u\n", __func__, data_len);
322 EXPORT_SYMBOL(usb_wwan_chars_in_buffer);
324 int usb_wwan_open(struct tty_struct *tty, struct usb_serial_port *port)
326 struct usb_wwan_port_private *portdata;
327 struct usb_wwan_intf_private *intfdata;
328 struct usb_serial *serial = port->serial;
332 portdata = usb_get_serial_port_data(port);
333 intfdata = usb_get_serial_data(serial);
335 if (port->interrupt_in_urb) {
336 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
338 dev_err(&port->dev, "%s: submit int urb failed: %d\n",
343 /* Start reading from the IN endpoint */
344 for (i = 0; i < N_IN_URB; i++) {
345 urb = portdata->in_urbs[i];
348 err = usb_submit_urb(urb, GFP_KERNEL);
351 "%s: submit read urb %d failed: %d\n",
356 spin_lock_irq(&intfdata->susp_lock);
357 if (++intfdata->open_ports == 1)
358 serial->interface->needs_remote_wakeup = 1;
359 spin_unlock_irq(&intfdata->susp_lock);
360 /* this balances a get in the generic USB serial code */
361 usb_autopm_put_interface(serial->interface);
365 EXPORT_SYMBOL(usb_wwan_open);
367 static void unbusy_queued_urb(struct urb *urb,
368 struct usb_wwan_port_private *portdata)
372 for (i = 0; i < N_OUT_URB; i++) {
373 if (urb == portdata->out_urbs[i]) {
374 clear_bit(i, &portdata->out_busy);
380 void usb_wwan_close(struct usb_serial_port *port)
383 struct usb_serial *serial = port->serial;
384 struct usb_wwan_port_private *portdata;
385 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
388 portdata = usb_get_serial_port_data(port);
391 * Need to take susp_lock to make sure port is not already being
392 * resumed, but no need to hold it due to the tty-port initialized
395 spin_lock_irq(&intfdata->susp_lock);
396 if (--intfdata->open_ports == 0)
397 serial->interface->needs_remote_wakeup = 0;
398 spin_unlock_irq(&intfdata->susp_lock);
401 urb = usb_get_from_anchor(&portdata->delayed);
404 unbusy_queued_urb(urb, portdata);
405 usb_autopm_put_interface_async(serial->interface);
408 for (i = 0; i < N_IN_URB; i++)
409 usb_kill_urb(portdata->in_urbs[i]);
410 for (i = 0; i < N_OUT_URB; i++)
411 usb_kill_urb(portdata->out_urbs[i]);
412 usb_kill_urb(port->interrupt_in_urb);
414 usb_autopm_get_interface_no_resume(serial->interface);
416 EXPORT_SYMBOL(usb_wwan_close);
418 static struct urb *usb_wwan_setup_urb(struct usb_serial_port *port,
420 int dir, void *ctx, char *buf, int len,
421 void (*callback) (struct urb *))
423 struct usb_serial *serial = port->serial;
424 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
427 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
431 usb_fill_bulk_urb(urb, serial->dev,
432 usb_sndbulkpipe(serial->dev, endpoint) | dir,
433 buf, len, callback, ctx);
435 if (intfdata->use_zlp && dir == USB_DIR_OUT)
436 urb->transfer_flags |= URB_ZERO_PACKET;
441 int usb_wwan_port_probe(struct usb_serial_port *port)
443 struct usb_wwan_port_private *portdata;
448 if (!port->bulk_in_size || !port->bulk_out_size)
451 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
455 init_usb_anchor(&portdata->delayed);
457 for (i = 0; i < N_IN_URB; i++) {
458 buffer = (u8 *)__get_free_page(GFP_KERNEL);
461 portdata->in_buffer[i] = buffer;
463 urb = usb_wwan_setup_urb(port, port->bulk_in_endpointAddress,
466 usb_wwan_indat_callback);
467 portdata->in_urbs[i] = urb;
470 for (i = 0; i < N_OUT_URB; i++) {
471 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
473 goto bail_out_error2;
474 portdata->out_buffer[i] = buffer;
476 urb = usb_wwan_setup_urb(port, port->bulk_out_endpointAddress,
479 usb_wwan_outdat_callback);
480 portdata->out_urbs[i] = urb;
483 usb_set_serial_port_data(port, portdata);
488 for (i = 0; i < N_OUT_URB; i++) {
489 usb_free_urb(portdata->out_urbs[i]);
490 kfree(portdata->out_buffer[i]);
493 for (i = 0; i < N_IN_URB; i++) {
494 usb_free_urb(portdata->in_urbs[i]);
495 free_page((unsigned long)portdata->in_buffer[i]);
501 EXPORT_SYMBOL_GPL(usb_wwan_port_probe);
503 void usb_wwan_port_remove(struct usb_serial_port *port)
506 struct usb_wwan_port_private *portdata;
508 portdata = usb_get_serial_port_data(port);
509 usb_set_serial_port_data(port, NULL);
511 for (i = 0; i < N_IN_URB; i++) {
512 usb_free_urb(portdata->in_urbs[i]);
513 free_page((unsigned long)portdata->in_buffer[i]);
515 for (i = 0; i < N_OUT_URB; i++) {
516 usb_free_urb(portdata->out_urbs[i]);
517 kfree(portdata->out_buffer[i]);
522 EXPORT_SYMBOL(usb_wwan_port_remove);
525 static void stop_urbs(struct usb_serial *serial)
528 struct usb_serial_port *port;
529 struct usb_wwan_port_private *portdata;
531 for (i = 0; i < serial->num_ports; ++i) {
532 port = serial->port[i];
533 portdata = usb_get_serial_port_data(port);
536 for (j = 0; j < N_IN_URB; j++)
537 usb_kill_urb(portdata->in_urbs[j]);
538 for (j = 0; j < N_OUT_URB; j++)
539 usb_kill_urb(portdata->out_urbs[j]);
540 usb_kill_urb(port->interrupt_in_urb);
544 int usb_wwan_suspend(struct usb_serial *serial, pm_message_t message)
546 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
548 spin_lock_irq(&intfdata->susp_lock);
549 if (PMSG_IS_AUTO(message)) {
550 if (intfdata->in_flight) {
551 spin_unlock_irq(&intfdata->susp_lock);
555 intfdata->suspended = 1;
556 spin_unlock_irq(&intfdata->susp_lock);
562 EXPORT_SYMBOL(usb_wwan_suspend);
564 /* Caller must hold susp_lock. */
565 static int usb_wwan_submit_delayed_urbs(struct usb_serial_port *port)
567 struct usb_serial *serial = port->serial;
568 struct usb_wwan_intf_private *data = usb_get_serial_data(serial);
569 struct usb_wwan_port_private *portdata;
574 portdata = usb_get_serial_port_data(port);
577 urb = usb_get_from_anchor(&portdata->delayed);
581 err = usb_submit_urb(urb, GFP_ATOMIC);
583 dev_err(&port->dev, "%s: submit urb failed: %d\n",
586 unbusy_queued_urb(urb, portdata);
587 usb_autopm_put_interface_async(serial->interface);
599 int usb_wwan_resume(struct usb_serial *serial)
602 struct usb_serial_port *port;
603 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
604 struct usb_wwan_port_private *portdata;
609 spin_lock_irq(&intfdata->susp_lock);
610 for (i = 0; i < serial->num_ports; i++) {
611 port = serial->port[i];
613 if (!tty_port_initialized(&port->port))
616 portdata = usb_get_serial_port_data(port);
618 if (port->interrupt_in_urb) {
619 err = usb_submit_urb(port->interrupt_in_urb,
623 "%s: submit int urb failed: %d\n",
629 err = usb_wwan_submit_delayed_urbs(port);
633 for (j = 0; j < N_IN_URB; j++) {
634 urb = portdata->in_urbs[j];
635 err = usb_submit_urb(urb, GFP_ATOMIC);
638 "%s: submit read urb %d failed: %d\n",
644 intfdata->suspended = 0;
645 spin_unlock_irq(&intfdata->susp_lock);
652 EXPORT_SYMBOL(usb_wwan_resume);
655 MODULE_AUTHOR(DRIVER_AUTHOR);
656 MODULE_DESCRIPTION(DRIVER_DESC);
657 MODULE_LICENSE("GPL v2");