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