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