Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 USB Driver layer for GSM modems
4
5 Copyright (C) 2005 Matthias Urlichs <smurf@smurf.noris.de>
6
7 Portions copied from the Keyspan driver by Hugh Blemings <hugh@blemings.org>
8
9 History: see the git log.
10
11 Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
12
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
17*/
18
19#define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
20#define DRIVER_DESC "USB Driver for GSM modems"
21
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>
34#include "usb-wwan.h"
35
36/*
37 * Generate DTR/RTS signals on the port using the SET_CONTROL_LINE_STATE request
38 * in CDC ACM.
39 */
40static int usb_wwan_send_setup(struct usb_serial_port *port)
41{
42 struct usb_serial *serial = port->serial;
43 struct usb_wwan_port_private *portdata;
44 int val = 0;
45 int ifnum;
46 int res;
47
48 portdata = usb_get_serial_port_data(port);
49
50 if (portdata->dtr_state)
51 val |= 0x01;
52 if (portdata->rts_state)
53 val |= 0x02;
54
55 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
56
57 res = usb_autopm_get_interface(serial->interface);
58 if (res)
59 return res;
60
61 res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
62 0x22, 0x21, val, ifnum, NULL, 0,
63 USB_CTRL_SET_TIMEOUT);
64
65 usb_autopm_put_interface(port->serial->interface);
66
67 return res;
68}
69
70void usb_wwan_dtr_rts(struct usb_serial_port *port, int on)
71{
72 struct usb_wwan_port_private *portdata;
73 struct usb_wwan_intf_private *intfdata;
74
75 intfdata = usb_get_serial_data(port->serial);
76
77 if (!intfdata->use_send_setup)
78 return;
79
80 portdata = usb_get_serial_port_data(port);
81 /* FIXME: locking */
82 portdata->rts_state = on;
83 portdata->dtr_state = on;
84
85 usb_wwan_send_setup(port);
86}
87EXPORT_SYMBOL(usb_wwan_dtr_rts);
88
89int usb_wwan_tiocmget(struct tty_struct *tty)
90{
91 struct usb_serial_port *port = tty->driver_data;
92 unsigned int value;
93 struct usb_wwan_port_private *portdata;
94
95 portdata = usb_get_serial_port_data(port);
96
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);
103
104 return value;
105}
106EXPORT_SYMBOL(usb_wwan_tiocmget);
107
108int usb_wwan_tiocmset(struct tty_struct *tty,
109 unsigned int set, unsigned int clear)
110{
111 struct usb_serial_port *port = tty->driver_data;
112 struct usb_wwan_port_private *portdata;
113 struct usb_wwan_intf_private *intfdata;
114
115 portdata = usb_get_serial_port_data(port);
116 intfdata = usb_get_serial_data(port->serial);
117
118 if (!intfdata->use_send_setup)
119 return -EINVAL;
120
121 /* FIXME: what locks portdata fields ? */
122 if (set & TIOCM_RTS)
123 portdata->rts_state = 1;
124 if (set & TIOCM_DTR)
125 portdata->dtr_state = 1;
126
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);
132}
133EXPORT_SYMBOL(usb_wwan_tiocmset);
134
135int usb_wwan_get_serial_info(struct tty_struct *tty,
136 struct serial_struct *ss)
137{
138 struct usb_serial_port *port = tty->driver_data;
139
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 = port->port.close_delay / 10;
144 ss->closing_wait = port->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
145 ASYNC_CLOSING_WAIT_NONE :
146 port->port.closing_wait / 10;
147 return 0;
148}
149EXPORT_SYMBOL(usb_wwan_get_serial_info);
150
151int usb_wwan_set_serial_info(struct tty_struct *tty,
152 struct serial_struct *ss)
153{
154 struct usb_serial_port *port = tty->driver_data;
155 unsigned int closing_wait, close_delay;
156 int retval = 0;
157
158 close_delay = ss->close_delay * 10;
159 closing_wait = ss->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
160 ASYNC_CLOSING_WAIT_NONE : ss->closing_wait * 10;
161
162 mutex_lock(&port->port.mutex);
163
164 if (!capable(CAP_SYS_ADMIN)) {
165 if ((close_delay != port->port.close_delay) ||
166 (closing_wait != port->port.closing_wait))
167 retval = -EPERM;
168 else
169 retval = -EOPNOTSUPP;
170 } else {
171 port->port.close_delay = close_delay;
172 port->port.closing_wait = closing_wait;
173 }
174
175 mutex_unlock(&port->port.mutex);
176 return retval;
177}
178EXPORT_SYMBOL(usb_wwan_set_serial_info);
179
180int usb_wwan_write(struct tty_struct *tty, struct usb_serial_port *port,
181 const unsigned char *buf, int count)
182{
183 struct usb_wwan_port_private *portdata;
184 struct usb_wwan_intf_private *intfdata;
185 int i;
186 int left, todo;
187 struct urb *this_urb = NULL; /* spurious */
188 int err;
189 unsigned long flags;
190
191 portdata = usb_get_serial_port_data(port);
192 intfdata = usb_get_serial_data(port->serial);
193
194 dev_dbg(&port->dev, "%s: write (%d chars)\n", __func__, count);
195
196 i = 0;
197 left = count;
198 for (i = 0; left > 0 && i < N_OUT_URB; i++) {
199 todo = left;
200 if (todo > OUT_BUFLEN)
201 todo = OUT_BUFLEN;
202
203 this_urb = portdata->out_urbs[i];
204 if (test_and_set_bit(i, &portdata->out_busy)) {
205 if (time_before(jiffies,
206 portdata->tx_start_time[i] + 10 * HZ))
207 continue;
208 usb_unlink_urb(this_urb);
209 continue;
210 }
211 dev_dbg(&port->dev, "%s: endpoint %d buf %d\n", __func__,
212 usb_pipeendpoint(this_urb->pipe), i);
213
214 err = usb_autopm_get_interface_async(port->serial->interface);
215 if (err < 0) {
216 clear_bit(i, &portdata->out_busy);
217 break;
218 }
219
220 /* send the data */
221 memcpy(this_urb->transfer_buffer, buf, todo);
222 this_urb->transfer_buffer_length = todo;
223
224 spin_lock_irqsave(&intfdata->susp_lock, flags);
225 if (intfdata->suspended) {
226 usb_anchor_urb(this_urb, &portdata->delayed);
227 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
228 } else {
229 intfdata->in_flight++;
230 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
231 err = usb_submit_urb(this_urb, GFP_ATOMIC);
232 if (err) {
233 dev_err(&port->dev,
234 "%s: submit urb %d failed: %d\n",
235 __func__, i, err);
236 clear_bit(i, &portdata->out_busy);
237 spin_lock_irqsave(&intfdata->susp_lock, flags);
238 intfdata->in_flight--;
239 spin_unlock_irqrestore(&intfdata->susp_lock,
240 flags);
241 usb_autopm_put_interface_async(port->serial->interface);
242 break;
243 }
244 }
245
246 portdata->tx_start_time[i] = jiffies;
247 buf += todo;
248 left -= todo;
249 }
250
251 count -= left;
252 dev_dbg(&port->dev, "%s: wrote (did %d)\n", __func__, count);
253 return count;
254}
255EXPORT_SYMBOL(usb_wwan_write);
256
257static void usb_wwan_indat_callback(struct urb *urb)
258{
259 int err;
260 int endpoint;
261 struct usb_serial_port *port;
262 struct device *dev;
263 unsigned char *data = urb->transfer_buffer;
264 int status = urb->status;
265
266 endpoint = usb_pipeendpoint(urb->pipe);
267 port = urb->context;
268 dev = &port->dev;
269
270 if (status) {
271 dev_dbg(dev, "%s: nonzero status: %d on endpoint %02x.\n",
272 __func__, status, endpoint);
273
274 /* don't resubmit on fatal errors */
275 if (status == -ESHUTDOWN || status == -ENOENT)
276 return;
277 } else {
278 if (urb->actual_length) {
279 tty_insert_flip_string(&port->port, data,
280 urb->actual_length);
281 tty_flip_buffer_push(&port->port);
282 } else
283 dev_dbg(dev, "%s: empty read urb received\n", __func__);
284 }
285 /* Resubmit urb so we continue receiving */
286 err = usb_submit_urb(urb, GFP_ATOMIC);
287 if (err) {
288 if (err != -EPERM && err != -ENODEV) {
289 dev_err(dev, "%s: resubmit read urb failed. (%d)\n",
290 __func__, err);
291 /* busy also in error unless we are killed */
292 usb_mark_last_busy(port->serial->dev);
293 }
294 } else {
295 usb_mark_last_busy(port->serial->dev);
296 }
297}
298
299static void usb_wwan_outdat_callback(struct urb *urb)
300{
301 struct usb_serial_port *port;
302 struct usb_wwan_port_private *portdata;
303 struct usb_wwan_intf_private *intfdata;
304 unsigned long flags;
305 int i;
306
307 port = urb->context;
308 intfdata = usb_get_serial_data(port->serial);
309
310 usb_serial_port_softint(port);
311 usb_autopm_put_interface_async(port->serial->interface);
312 portdata = usb_get_serial_port_data(port);
313 spin_lock_irqsave(&intfdata->susp_lock, flags);
314 intfdata->in_flight--;
315 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
316
317 for (i = 0; i < N_OUT_URB; ++i) {
318 if (portdata->out_urbs[i] == urb) {
319 smp_mb__before_atomic();
320 clear_bit(i, &portdata->out_busy);
321 break;
322 }
323 }
324}
325
326int usb_wwan_write_room(struct tty_struct *tty)
327{
328 struct usb_serial_port *port = tty->driver_data;
329 struct usb_wwan_port_private *portdata;
330 int i;
331 int data_len = 0;
332 struct urb *this_urb;
333
334 portdata = usb_get_serial_port_data(port);
335
336 for (i = 0; i < N_OUT_URB; i++) {
337 this_urb = portdata->out_urbs[i];
338 if (this_urb && !test_bit(i, &portdata->out_busy))
339 data_len += OUT_BUFLEN;
340 }
341
342 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
343 return data_len;
344}
345EXPORT_SYMBOL(usb_wwan_write_room);
346
347int usb_wwan_chars_in_buffer(struct tty_struct *tty)
348{
349 struct usb_serial_port *port = tty->driver_data;
350 struct usb_wwan_port_private *portdata;
351 int i;
352 int data_len = 0;
353 struct urb *this_urb;
354
355 portdata = usb_get_serial_port_data(port);
356
357 for (i = 0; i < N_OUT_URB; i++) {
358 this_urb = portdata->out_urbs[i];
359 /* FIXME: This locking is insufficient as this_urb may
360 go unused during the test */
361 if (this_urb && test_bit(i, &portdata->out_busy))
362 data_len += this_urb->transfer_buffer_length;
363 }
364 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
365 return data_len;
366}
367EXPORT_SYMBOL(usb_wwan_chars_in_buffer);
368
369int usb_wwan_open(struct tty_struct *tty, struct usb_serial_port *port)
370{
371 struct usb_wwan_port_private *portdata;
372 struct usb_wwan_intf_private *intfdata;
373 struct usb_serial *serial = port->serial;
374 int i, err;
375 struct urb *urb;
376
377 portdata = usb_get_serial_port_data(port);
378 intfdata = usb_get_serial_data(serial);
379
380 if (port->interrupt_in_urb) {
381 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
382 if (err) {
383 dev_err(&port->dev, "%s: submit int urb failed: %d\n",
384 __func__, err);
385 }
386 }
387
388 /* Start reading from the IN endpoint */
389 for (i = 0; i < N_IN_URB; i++) {
390 urb = portdata->in_urbs[i];
391 if (!urb)
392 continue;
393 err = usb_submit_urb(urb, GFP_KERNEL);
394 if (err) {
395 dev_err(&port->dev,
396 "%s: submit read urb %d failed: %d\n",
397 __func__, i, err);
398 }
399 }
400
401 spin_lock_irq(&intfdata->susp_lock);
402 if (++intfdata->open_ports == 1)
403 serial->interface->needs_remote_wakeup = 1;
404 spin_unlock_irq(&intfdata->susp_lock);
405 /* this balances a get in the generic USB serial code */
406 usb_autopm_put_interface(serial->interface);
407
408 return 0;
409}
410EXPORT_SYMBOL(usb_wwan_open);
411
412static void unbusy_queued_urb(struct urb *urb,
413 struct usb_wwan_port_private *portdata)
414{
415 int i;
416
417 for (i = 0; i < N_OUT_URB; i++) {
418 if (urb == portdata->out_urbs[i]) {
419 clear_bit(i, &portdata->out_busy);
420 break;
421 }
422 }
423}
424
425void usb_wwan_close(struct usb_serial_port *port)
426{
427 int i;
428 struct usb_serial *serial = port->serial;
429 struct usb_wwan_port_private *portdata;
430 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
431 struct urb *urb;
432
433 portdata = usb_get_serial_port_data(port);
434
435 /*
436 * Need to take susp_lock to make sure port is not already being
437 * resumed, but no need to hold it due to initialized
438 */
439 spin_lock_irq(&intfdata->susp_lock);
440 if (--intfdata->open_ports == 0)
441 serial->interface->needs_remote_wakeup = 0;
442 spin_unlock_irq(&intfdata->susp_lock);
443
444 for (;;) {
445 urb = usb_get_from_anchor(&portdata->delayed);
446 if (!urb)
447 break;
448 unbusy_queued_urb(urb, portdata);
449 usb_autopm_put_interface_async(serial->interface);
450 }
451
452 for (i = 0; i < N_IN_URB; i++)
453 usb_kill_urb(portdata->in_urbs[i]);
454 for (i = 0; i < N_OUT_URB; i++)
455 usb_kill_urb(portdata->out_urbs[i]);
456 usb_kill_urb(port->interrupt_in_urb);
457
458 usb_autopm_get_interface_no_resume(serial->interface);
459}
460EXPORT_SYMBOL(usb_wwan_close);
461
462static struct urb *usb_wwan_setup_urb(struct usb_serial_port *port,
463 int endpoint,
464 int dir, void *ctx, char *buf, int len,
465 void (*callback) (struct urb *))
466{
467 struct usb_serial *serial = port->serial;
468 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
469 struct urb *urb;
470
471 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
472 if (!urb)
473 return NULL;
474
475 usb_fill_bulk_urb(urb, serial->dev,
476 usb_sndbulkpipe(serial->dev, endpoint) | dir,
477 buf, len, callback, ctx);
478
479 if (intfdata->use_zlp && dir == USB_DIR_OUT)
480 urb->transfer_flags |= URB_ZERO_PACKET;
481
482 return urb;
483}
484
485int usb_wwan_port_probe(struct usb_serial_port *port)
486{
487 struct usb_wwan_port_private *portdata;
488 struct urb *urb;
489 u8 *buffer;
490 int i;
491
492 if (!port->bulk_in_size || !port->bulk_out_size)
493 return -ENODEV;
494
495 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
496 if (!portdata)
497 return -ENOMEM;
498
499 init_usb_anchor(&portdata->delayed);
500
501 for (i = 0; i < N_IN_URB; i++) {
502 buffer = (u8 *)__get_free_page(GFP_KERNEL);
503 if (!buffer)
504 goto bail_out_error;
505 portdata->in_buffer[i] = buffer;
506
507 urb = usb_wwan_setup_urb(port, port->bulk_in_endpointAddress,
508 USB_DIR_IN, port,
509 buffer, IN_BUFLEN,
510 usb_wwan_indat_callback);
511 portdata->in_urbs[i] = urb;
512 }
513
514 for (i = 0; i < N_OUT_URB; i++) {
515 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
516 if (!buffer)
517 goto bail_out_error2;
518 portdata->out_buffer[i] = buffer;
519
520 urb = usb_wwan_setup_urb(port, port->bulk_out_endpointAddress,
521 USB_DIR_OUT, port,
522 buffer, OUT_BUFLEN,
523 usb_wwan_outdat_callback);
524 portdata->out_urbs[i] = urb;
525 }
526
527 usb_set_serial_port_data(port, portdata);
528
529 return 0;
530
531bail_out_error2:
532 for (i = 0; i < N_OUT_URB; i++) {
533 usb_free_urb(portdata->out_urbs[i]);
534 kfree(portdata->out_buffer[i]);
535 }
536bail_out_error:
537 for (i = 0; i < N_IN_URB; i++) {
538 usb_free_urb(portdata->in_urbs[i]);
539 free_page((unsigned long)portdata->in_buffer[i]);
540 }
541 kfree(portdata);
542
543 return -ENOMEM;
544}
545EXPORT_SYMBOL_GPL(usb_wwan_port_probe);
546
547int usb_wwan_port_remove(struct usb_serial_port *port)
548{
549 int i;
550 struct usb_wwan_port_private *portdata;
551
552 portdata = usb_get_serial_port_data(port);
553 usb_set_serial_port_data(port, NULL);
554
555 for (i = 0; i < N_IN_URB; i++) {
556 usb_free_urb(portdata->in_urbs[i]);
557 free_page((unsigned long)portdata->in_buffer[i]);
558 }
559 for (i = 0; i < N_OUT_URB; i++) {
560 usb_free_urb(portdata->out_urbs[i]);
561 kfree(portdata->out_buffer[i]);
562 }
563
564 kfree(portdata);
565
566 return 0;
567}
568EXPORT_SYMBOL(usb_wwan_port_remove);
569
570#ifdef CONFIG_PM
571static void stop_urbs(struct usb_serial *serial)
572{
573 int i, j;
574 struct usb_serial_port *port;
575 struct usb_wwan_port_private *portdata;
576
577 for (i = 0; i < serial->num_ports; ++i) {
578 port = serial->port[i];
579 portdata = usb_get_serial_port_data(port);
580 if (!portdata)
581 continue;
582 for (j = 0; j < N_IN_URB; j++)
583 usb_kill_urb(portdata->in_urbs[j]);
584 for (j = 0; j < N_OUT_URB; j++)
585 usb_kill_urb(portdata->out_urbs[j]);
586 usb_kill_urb(port->interrupt_in_urb);
587 }
588}
589
590int usb_wwan_suspend(struct usb_serial *serial, pm_message_t message)
591{
592 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
593
594 spin_lock_irq(&intfdata->susp_lock);
595 if (PMSG_IS_AUTO(message)) {
596 if (intfdata->in_flight) {
597 spin_unlock_irq(&intfdata->susp_lock);
598 return -EBUSY;
599 }
600 }
601 intfdata->suspended = 1;
602 spin_unlock_irq(&intfdata->susp_lock);
603
604 stop_urbs(serial);
605
606 return 0;
607}
608EXPORT_SYMBOL(usb_wwan_suspend);
609
610/* Caller must hold susp_lock. */
611static int usb_wwan_submit_delayed_urbs(struct usb_serial_port *port)
612{
613 struct usb_serial *serial = port->serial;
614 struct usb_wwan_intf_private *data = usb_get_serial_data(serial);
615 struct usb_wwan_port_private *portdata;
616 struct urb *urb;
617 int err_count = 0;
618 int err;
619
620 portdata = usb_get_serial_port_data(port);
621
622 for (;;) {
623 urb = usb_get_from_anchor(&portdata->delayed);
624 if (!urb)
625 break;
626
627 err = usb_submit_urb(urb, GFP_ATOMIC);
628 if (err) {
629 dev_err(&port->dev, "%s: submit urb failed: %d\n",
630 __func__, err);
631 err_count++;
632 unbusy_queued_urb(urb, portdata);
633 usb_autopm_put_interface_async(serial->interface);
634 continue;
635 }
636 data->in_flight++;
637 }
638
639 if (err_count)
640 return -EIO;
641
642 return 0;
643}
644
645int usb_wwan_resume(struct usb_serial *serial)
646{
647 int i, j;
648 struct usb_serial_port *port;
649 struct usb_wwan_intf_private *intfdata = usb_get_serial_data(serial);
650 struct usb_wwan_port_private *portdata;
651 struct urb *urb;
652 int err;
653 int err_count = 0;
654
655 spin_lock_irq(&intfdata->susp_lock);
656 for (i = 0; i < serial->num_ports; i++) {
657 port = serial->port[i];
658
659 if (!tty_port_initialized(&port->port))
660 continue;
661
662 portdata = usb_get_serial_port_data(port);
663
664 if (port->interrupt_in_urb) {
665 err = usb_submit_urb(port->interrupt_in_urb,
666 GFP_ATOMIC);
667 if (err) {
668 dev_err(&port->dev,
669 "%s: submit int urb failed: %d\n",
670 __func__, err);
671 err_count++;
672 }
673 }
674
675 err = usb_wwan_submit_delayed_urbs(port);
676 if (err)
677 err_count++;
678
679 for (j = 0; j < N_IN_URB; j++) {
680 urb = portdata->in_urbs[j];
681 err = usb_submit_urb(urb, GFP_ATOMIC);
682 if (err < 0) {
683 dev_err(&port->dev,
684 "%s: submit read urb %d failed: %d\n",
685 __func__, i, err);
686 err_count++;
687 }
688 }
689 }
690 intfdata->suspended = 0;
691 spin_unlock_irq(&intfdata->susp_lock);
692
693 if (err_count)
694 return -EIO;
695
696 return 0;
697}
698EXPORT_SYMBOL(usb_wwan_resume);
699#endif
700
701MODULE_AUTHOR(DRIVER_AUTHOR);
702MODULE_DESCRIPTION(DRIVER_DESC);
703MODULE_LICENSE("GPL v2");
1/*
2 USB Driver layer for GSM modems
3
4 Copyright (C) 2005 Matthias Urlichs <smurf@smurf.noris.de>
5
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.
9
10 Portions copied from the Keyspan driver by Hugh Blemings <hugh@blemings.org>
11
12 History: see the git log.
13
14 Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
15
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
20*/
21
22#define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
23#define DRIVER_DESC "USB Driver for GSM modems"
24
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"
38
39void usb_wwan_dtr_rts(struct usb_serial_port *port, int on)
40{
41 struct usb_wwan_port_private *portdata;
42 struct usb_wwan_intf_private *intfdata;
43
44 intfdata = port->serial->private;
45
46 if (!intfdata->send_setup)
47 return;
48
49 portdata = usb_get_serial_port_data(port);
50 /* FIXME: locking */
51 portdata->rts_state = on;
52 portdata->dtr_state = on;
53
54 intfdata->send_setup(port);
55}
56EXPORT_SYMBOL(usb_wwan_dtr_rts);
57
58void usb_wwan_set_termios(struct tty_struct *tty,
59 struct usb_serial_port *port,
60 struct ktermios *old_termios)
61{
62 struct usb_wwan_intf_private *intfdata = port->serial->private;
63
64 /* Doesn't support option setting */
65 tty_termios_copy_hw(&tty->termios, old_termios);
66
67 if (intfdata->send_setup)
68 intfdata->send_setup(port);
69}
70EXPORT_SYMBOL(usb_wwan_set_termios);
71
72int usb_wwan_tiocmget(struct tty_struct *tty)
73{
74 struct usb_serial_port *port = tty->driver_data;
75 unsigned int value;
76 struct usb_wwan_port_private *portdata;
77
78 portdata = usb_get_serial_port_data(port);
79
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);
86
87 return value;
88}
89EXPORT_SYMBOL(usb_wwan_tiocmget);
90
91int usb_wwan_tiocmset(struct tty_struct *tty,
92 unsigned int set, unsigned int clear)
93{
94 struct usb_serial_port *port = tty->driver_data;
95 struct usb_wwan_port_private *portdata;
96 struct usb_wwan_intf_private *intfdata;
97
98 portdata = usb_get_serial_port_data(port);
99 intfdata = port->serial->private;
100
101 if (!intfdata->send_setup)
102 return -EINVAL;
103
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;
109
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);
115}
116EXPORT_SYMBOL(usb_wwan_tiocmset);
117
118static int get_serial_info(struct usb_serial_port *port,
119 struct serial_struct __user *retinfo)
120{
121 struct serial_struct tmp;
122
123 if (!retinfo)
124 return -EFAULT;
125
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;
134
135 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
136 return -EFAULT;
137 return 0;
138}
139
140static int set_serial_info(struct usb_serial_port *port,
141 struct serial_struct __user *newinfo)
142{
143 struct serial_struct new_serial;
144 unsigned int closing_wait, close_delay;
145 int retval = 0;
146
147 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
148 return -EFAULT;
149
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;
153
154 mutex_lock(&port->port.mutex);
155
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;
165 }
166
167 mutex_unlock(&port->port.mutex);
168 return retval;
169}
170
171int usb_wwan_ioctl(struct tty_struct *tty,
172 unsigned int cmd, unsigned long arg)
173{
174 struct usb_serial_port *port = tty->driver_data;
175
176 dev_dbg(&port->dev, "%s cmd 0x%04x\n", __func__, cmd);
177
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;
187 }
188
189 dev_dbg(&port->dev, "%s arg not supported\n", __func__);
190
191 return -ENOIOCTLCMD;
192}
193EXPORT_SYMBOL(usb_wwan_ioctl);
194
195/* Write */
196int usb_wwan_write(struct tty_struct *tty, struct usb_serial_port *port,
197 const unsigned char *buf, int count)
198{
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;
206
207 portdata = usb_get_serial_port_data(port);
208 intfdata = port->serial->private;
209
210 dev_dbg(&port->dev, "%s: write (%d chars)\n", __func__, count);
211
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;
218
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;
226 }
227 dev_dbg(&port->dev, "%s: endpoint %d buf %d\n", __func__,
228 usb_pipeendpoint(this_urb->pipe), i);
229
230 err = usb_autopm_get_interface_async(port->serial->interface);
231 if (err < 0)
232 break;
233
234 /* send the data */
235 memcpy(this_urb->transfer_buffer, buf, todo);
236 this_urb->transfer_buffer_length = todo;
237
238 spin_lock_irqsave(&intfdata->susp_lock, flags);
239 if (intfdata->suspended) {
240 usb_anchor_urb(this_urb, &portdata->delayed);
241 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
242 } else {
243 intfdata->in_flight++;
244 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
245 err = usb_submit_urb(this_urb, GFP_ATOMIC);
246 if (err) {
247 dev_dbg(&port->dev,
248 "usb_submit_urb %p (write bulk) failed (%d)\n",
249 this_urb, err);
250 clear_bit(i, &portdata->out_busy);
251 spin_lock_irqsave(&intfdata->susp_lock, flags);
252 intfdata->in_flight--;
253 spin_unlock_irqrestore(&intfdata->susp_lock,
254 flags);
255 usb_autopm_put_interface_async(port->serial->interface);
256 break;
257 }
258 }
259
260 portdata->tx_start_time[i] = jiffies;
261 buf += todo;
262 left -= todo;
263 }
264
265 count -= left;
266 dev_dbg(&port->dev, "%s: wrote (did %d)\n", __func__, count);
267 return count;
268}
269EXPORT_SYMBOL(usb_wwan_write);
270
271static void usb_wwan_indat_callback(struct urb *urb)
272{
273 int err;
274 int endpoint;
275 struct usb_serial_port *port;
276 struct device *dev;
277 unsigned char *data = urb->transfer_buffer;
278 int status = urb->status;
279
280 endpoint = usb_pipeendpoint(urb->pipe);
281 port = urb->context;
282 dev = &port->dev;
283
284 if (status) {
285 dev_dbg(dev, "%s: nonzero status: %d on endpoint %02x.\n",
286 __func__, status, endpoint);
287 } else {
288 if (urb->actual_length) {
289 tty_insert_flip_string(&port->port, data,
290 urb->actual_length);
291 tty_flip_buffer_push(&port->port);
292 } else
293 dev_dbg(dev, "%s: empty read urb received\n", __func__);
294 }
295 /* Resubmit urb so we continue receiving */
296 err = usb_submit_urb(urb, GFP_ATOMIC);
297 if (err) {
298 if (err != -EPERM) {
299 dev_err(dev, "%s: resubmit read urb failed. (%d)\n",
300 __func__, err);
301 /* busy also in error unless we are killed */
302 usb_mark_last_busy(port->serial->dev);
303 }
304 } else {
305 usb_mark_last_busy(port->serial->dev);
306 }
307}
308
309static void usb_wwan_outdat_callback(struct urb *urb)
310{
311 struct usb_serial_port *port;
312 struct usb_wwan_port_private *portdata;
313 struct usb_wwan_intf_private *intfdata;
314 int i;
315
316 port = urb->context;
317 intfdata = port->serial->private;
318
319 usb_serial_port_softint(port);
320 usb_autopm_put_interface_async(port->serial->interface);
321 portdata = usb_get_serial_port_data(port);
322 spin_lock(&intfdata->susp_lock);
323 intfdata->in_flight--;
324 spin_unlock(&intfdata->susp_lock);
325
326 for (i = 0; i < N_OUT_URB; ++i) {
327 if (portdata->out_urbs[i] == urb) {
328 smp_mb__before_clear_bit();
329 clear_bit(i, &portdata->out_busy);
330 break;
331 }
332 }
333}
334
335int usb_wwan_write_room(struct tty_struct *tty)
336{
337 struct usb_serial_port *port = tty->driver_data;
338 struct usb_wwan_port_private *portdata;
339 int i;
340 int data_len = 0;
341 struct urb *this_urb;
342
343 portdata = usb_get_serial_port_data(port);
344
345 for (i = 0; i < N_OUT_URB; i++) {
346 this_urb = portdata->out_urbs[i];
347 if (this_urb && !test_bit(i, &portdata->out_busy))
348 data_len += OUT_BUFLEN;
349 }
350
351 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
352 return data_len;
353}
354EXPORT_SYMBOL(usb_wwan_write_room);
355
356int usb_wwan_chars_in_buffer(struct tty_struct *tty)
357{
358 struct usb_serial_port *port = tty->driver_data;
359 struct usb_wwan_port_private *portdata;
360 int i;
361 int data_len = 0;
362 struct urb *this_urb;
363
364 portdata = usb_get_serial_port_data(port);
365
366 for (i = 0; i < N_OUT_URB; i++) {
367 this_urb = portdata->out_urbs[i];
368 /* FIXME: This locking is insufficient as this_urb may
369 go unused during the test */
370 if (this_urb && test_bit(i, &portdata->out_busy))
371 data_len += this_urb->transfer_buffer_length;
372 }
373 dev_dbg(&port->dev, "%s: %d\n", __func__, data_len);
374 return data_len;
375}
376EXPORT_SYMBOL(usb_wwan_chars_in_buffer);
377
378int usb_wwan_open(struct tty_struct *tty, struct usb_serial_port *port)
379{
380 struct usb_wwan_port_private *portdata;
381 struct usb_wwan_intf_private *intfdata;
382 struct usb_serial *serial = port->serial;
383 int i, err;
384 struct urb *urb;
385
386 portdata = usb_get_serial_port_data(port);
387 intfdata = serial->private;
388
389 /* Start reading from the IN endpoint */
390 for (i = 0; i < N_IN_URB; i++) {
391 urb = portdata->in_urbs[i];
392 if (!urb)
393 continue;
394 err = usb_submit_urb(urb, GFP_KERNEL);
395 if (err) {
396 dev_dbg(&port->dev, "%s: submit urb %d failed (%d) %d\n",
397 __func__, i, err, urb->transfer_buffer_length);
398 }
399 }
400
401 if (intfdata->send_setup)
402 intfdata->send_setup(port);
403
404 serial->interface->needs_remote_wakeup = 1;
405 spin_lock_irq(&intfdata->susp_lock);
406 portdata->opened = 1;
407 spin_unlock_irq(&intfdata->susp_lock);
408 /* this balances a get in the generic USB serial code */
409 usb_autopm_put_interface(serial->interface);
410
411 return 0;
412}
413EXPORT_SYMBOL(usb_wwan_open);
414
415void usb_wwan_close(struct usb_serial_port *port)
416{
417 int i;
418 struct usb_serial *serial = port->serial;
419 struct usb_wwan_port_private *portdata;
420 struct usb_wwan_intf_private *intfdata = port->serial->private;
421
422 portdata = usb_get_serial_port_data(port);
423
424 /* Stop reading/writing urbs */
425 spin_lock_irq(&intfdata->susp_lock);
426 portdata->opened = 0;
427 spin_unlock_irq(&intfdata->susp_lock);
428
429 for (i = 0; i < N_IN_URB; i++)
430 usb_kill_urb(portdata->in_urbs[i]);
431 for (i = 0; i < N_OUT_URB; i++)
432 usb_kill_urb(portdata->out_urbs[i]);
433
434 /* balancing - important as an error cannot be handled*/
435 usb_autopm_get_interface_no_resume(serial->interface);
436 serial->interface->needs_remote_wakeup = 0;
437}
438EXPORT_SYMBOL(usb_wwan_close);
439
440/* Helper functions used by usb_wwan_setup_urbs */
441static struct urb *usb_wwan_setup_urb(struct usb_serial_port *port,
442 int endpoint,
443 int dir, void *ctx, char *buf, int len,
444 void (*callback) (struct urb *))
445{
446 struct usb_serial *serial = port->serial;
447 struct urb *urb;
448
449 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
450 if (!urb)
451 return NULL;
452
453 /* Fill URB using supplied data. */
454 usb_fill_bulk_urb(urb, serial->dev,
455 usb_sndbulkpipe(serial->dev, endpoint) | dir,
456 buf, len, callback, ctx);
457
458 return urb;
459}
460
461int usb_wwan_port_probe(struct usb_serial_port *port)
462{
463 struct usb_wwan_port_private *portdata;
464 struct urb *urb;
465 u8 *buffer;
466 int err;
467 int i;
468
469 if (!port->bulk_in_size || !port->bulk_out_size)
470 return -ENODEV;
471
472 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
473 if (!portdata)
474 return -ENOMEM;
475
476 init_usb_anchor(&portdata->delayed);
477
478 for (i = 0; i < N_IN_URB; i++) {
479 buffer = (u8 *)__get_free_page(GFP_KERNEL);
480 if (!buffer)
481 goto bail_out_error;
482 portdata->in_buffer[i] = buffer;
483
484 urb = usb_wwan_setup_urb(port, port->bulk_in_endpointAddress,
485 USB_DIR_IN, port,
486 buffer, IN_BUFLEN,
487 usb_wwan_indat_callback);
488 portdata->in_urbs[i] = urb;
489 }
490
491 for (i = 0; i < N_OUT_URB; i++) {
492 buffer = kmalloc(OUT_BUFLEN, GFP_KERNEL);
493 if (!buffer)
494 goto bail_out_error2;
495 portdata->out_buffer[i] = buffer;
496
497 urb = usb_wwan_setup_urb(port, port->bulk_out_endpointAddress,
498 USB_DIR_OUT, port,
499 buffer, OUT_BUFLEN,
500 usb_wwan_outdat_callback);
501 portdata->out_urbs[i] = urb;
502 }
503
504 usb_set_serial_port_data(port, portdata);
505
506 if (port->interrupt_in_urb) {
507 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
508 if (err)
509 dev_dbg(&port->dev, "%s: submit irq_in urb failed %d\n",
510 __func__, err);
511 }
512
513 return 0;
514
515bail_out_error2:
516 for (i = 0; i < N_OUT_URB; i++) {
517 usb_free_urb(portdata->out_urbs[i]);
518 kfree(portdata->out_buffer[i]);
519 }
520bail_out_error:
521 for (i = 0; i < N_IN_URB; i++) {
522 usb_free_urb(portdata->in_urbs[i]);
523 free_page((unsigned long)portdata->in_buffer[i]);
524 }
525 kfree(portdata);
526
527 return -ENOMEM;
528}
529EXPORT_SYMBOL_GPL(usb_wwan_port_probe);
530
531int usb_wwan_port_remove(struct usb_serial_port *port)
532{
533 int i;
534 struct usb_wwan_port_private *portdata;
535
536 portdata = usb_get_serial_port_data(port);
537 usb_set_serial_port_data(port, NULL);
538
539 /* Stop reading/writing urbs and free them */
540 for (i = 0; i < N_IN_URB; i++) {
541 usb_kill_urb(portdata->in_urbs[i]);
542 usb_free_urb(portdata->in_urbs[i]);
543 free_page((unsigned long)portdata->in_buffer[i]);
544 }
545 for (i = 0; i < N_OUT_URB; i++) {
546 usb_kill_urb(portdata->out_urbs[i]);
547 usb_free_urb(portdata->out_urbs[i]);
548 kfree(portdata->out_buffer[i]);
549 }
550
551 /* Now free port private data */
552 kfree(portdata);
553 return 0;
554}
555EXPORT_SYMBOL(usb_wwan_port_remove);
556
557#ifdef CONFIG_PM
558static void stop_read_write_urbs(struct usb_serial *serial)
559{
560 int i, j;
561 struct usb_serial_port *port;
562 struct usb_wwan_port_private *portdata;
563
564 /* Stop reading/writing urbs */
565 for (i = 0; i < serial->num_ports; ++i) {
566 port = serial->port[i];
567 portdata = usb_get_serial_port_data(port);
568 if (!portdata)
569 continue;
570 for (j = 0; j < N_IN_URB; j++)
571 usb_kill_urb(portdata->in_urbs[j]);
572 for (j = 0; j < N_OUT_URB; j++)
573 usb_kill_urb(portdata->out_urbs[j]);
574 }
575}
576
577int usb_wwan_suspend(struct usb_serial *serial, pm_message_t message)
578{
579 struct usb_wwan_intf_private *intfdata = serial->private;
580 int b;
581
582 if (PMSG_IS_AUTO(message)) {
583 spin_lock_irq(&intfdata->susp_lock);
584 b = intfdata->in_flight;
585 spin_unlock_irq(&intfdata->susp_lock);
586
587 if (b)
588 return -EBUSY;
589 }
590
591 spin_lock_irq(&intfdata->susp_lock);
592 intfdata->suspended = 1;
593 spin_unlock_irq(&intfdata->susp_lock);
594 stop_read_write_urbs(serial);
595
596 return 0;
597}
598EXPORT_SYMBOL(usb_wwan_suspend);
599
600static void unbusy_queued_urb(struct urb *urb, struct usb_wwan_port_private *portdata)
601{
602 int i;
603
604 for (i = 0; i < N_OUT_URB; i++) {
605 if (urb == portdata->out_urbs[i]) {
606 clear_bit(i, &portdata->out_busy);
607 break;
608 }
609 }
610}
611
612static void play_delayed(struct usb_serial_port *port)
613{
614 struct usb_wwan_intf_private *data;
615 struct usb_wwan_port_private *portdata;
616 struct urb *urb;
617 int err;
618
619 portdata = usb_get_serial_port_data(port);
620 data = port->serial->private;
621 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
622 err = usb_submit_urb(urb, GFP_ATOMIC);
623 if (!err) {
624 data->in_flight++;
625 } else {
626 /* we have to throw away the rest */
627 do {
628 unbusy_queued_urb(urb, portdata);
629 usb_autopm_put_interface_no_suspend(port->serial->interface);
630 } while ((urb = usb_get_from_anchor(&portdata->delayed)));
631 break;
632 }
633 }
634}
635
636int usb_wwan_resume(struct usb_serial *serial)
637{
638 int i, j;
639 struct usb_serial_port *port;
640 struct usb_wwan_intf_private *intfdata = serial->private;
641 struct usb_wwan_port_private *portdata;
642 struct urb *urb;
643 int err = 0;
644
645 /* get the interrupt URBs resubmitted unconditionally */
646 for (i = 0; i < serial->num_ports; i++) {
647 port = serial->port[i];
648 if (!port->interrupt_in_urb) {
649 dev_dbg(&port->dev, "%s: No interrupt URB for port\n", __func__);
650 continue;
651 }
652 err = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
653 dev_dbg(&port->dev, "Submitted interrupt URB for port (result %d)\n", err);
654 if (err < 0) {
655 dev_err(&port->dev, "%s: Error %d for interrupt URB\n",
656 __func__, err);
657 goto err_out;
658 }
659 }
660
661 for (i = 0; i < serial->num_ports; i++) {
662 /* walk all ports */
663 port = serial->port[i];
664 portdata = usb_get_serial_port_data(port);
665
666 /* skip closed ports */
667 spin_lock_irq(&intfdata->susp_lock);
668 if (!portdata || !portdata->opened) {
669 spin_unlock_irq(&intfdata->susp_lock);
670 continue;
671 }
672
673 for (j = 0; j < N_IN_URB; j++) {
674 urb = portdata->in_urbs[j];
675 err = usb_submit_urb(urb, GFP_ATOMIC);
676 if (err < 0) {
677 dev_err(&port->dev, "%s: Error %d for bulk URB %d\n",
678 __func__, err, i);
679 spin_unlock_irq(&intfdata->susp_lock);
680 goto err_out;
681 }
682 }
683 play_delayed(port);
684 spin_unlock_irq(&intfdata->susp_lock);
685 }
686 spin_lock_irq(&intfdata->susp_lock);
687 intfdata->suspended = 0;
688 spin_unlock_irq(&intfdata->susp_lock);
689err_out:
690 return err;
691}
692EXPORT_SYMBOL(usb_wwan_resume);
693#endif
694
695MODULE_AUTHOR(DRIVER_AUTHOR);
696MODULE_DESCRIPTION(DRIVER_DESC);
697MODULE_LICENSE("GPL");