1 // SPDX-License-Identifier: GPL-2.0
3 USB Driver layer for GSM modems
5 Copyright (C) 2005 Matthias Urlichs <smurf@smurf.noris.de>
7 Portions copied from the Keyspan driver by Hugh Blemings <hugh@blemings.org>
9 History: see the git log.
11 Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
13 This driver exists because the "normal" serial driver doesn't work too well
14 with GSM modems. Issues:
15 - data loss -- one single Receive URB is not nearly enough
16 - controlling the baud rate doesn't make sense
19 #define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
20 #define DRIVER_DESC "USB Driver for GSM modems"
22 #include <linux/kernel.h>
23 #include <linux/jiffies.h>
24 #include <linux/errno.h>
25 #include <linux/slab.h>
26 #include <linux/tty.h>
27 #include <linux/tty_flip.h>
28 #include <linux/module.h>
29 #include <linux/bitops.h>
30 #include <linux/uaccess.h>
31 #include <linux/usb.h>
32 #include <linux/usb/serial.h>
33 #include <linux/serial.h>
37 * Generate DTR/RTS signals on the port using the SET_CONTROL_LINE_STATE request
40 static int usb_wwan_send_setup(struct usb_serial_port
*port
)
42 struct usb_serial
*serial
= port
->serial
;
43 struct usb_wwan_port_private
*portdata
;
48 portdata
= usb_get_serial_port_data(port
);
50 if (portdata
->dtr_state
)
52 if (portdata
->rts_state
)
55 ifnum
= serial
->interface
->cur_altsetting
->desc
.bInterfaceNumber
;
57 res
= usb_autopm_get_interface(serial
->interface
);
61 res
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
62 0x22, 0x21, val
, ifnum
, NULL
, 0,
63 USB_CTRL_SET_TIMEOUT
);
65 usb_autopm_put_interface(port
->serial
->interface
);
70 void usb_wwan_dtr_rts(struct usb_serial_port
*port
, int on
)
72 struct usb_wwan_port_private
*portdata
;
73 struct usb_wwan_intf_private
*intfdata
;
75 intfdata
= usb_get_serial_data(port
->serial
);
77 if (!intfdata
->use_send_setup
)
80 portdata
= usb_get_serial_port_data(port
);
82 portdata
->rts_state
= on
;
83 portdata
->dtr_state
= on
;
85 usb_wwan_send_setup(port
);
87 EXPORT_SYMBOL(usb_wwan_dtr_rts
);
89 int usb_wwan_tiocmget(struct tty_struct
*tty
)
91 struct usb_serial_port
*port
= tty
->driver_data
;
93 struct usb_wwan_port_private
*portdata
;
95 portdata
= usb_get_serial_port_data(port
);
97 value
= ((portdata
->rts_state
) ? TIOCM_RTS
: 0) |
98 ((portdata
->dtr_state
) ? TIOCM_DTR
: 0) |
99 ((portdata
->cts_state
) ? TIOCM_CTS
: 0) |
100 ((portdata
->dsr_state
) ? TIOCM_DSR
: 0) |
101 ((portdata
->dcd_state
) ? TIOCM_CAR
: 0) |
102 ((portdata
->ri_state
) ? TIOCM_RNG
: 0);
106 EXPORT_SYMBOL(usb_wwan_tiocmget
);
108 int usb_wwan_tiocmset(struct tty_struct
*tty
,
109 unsigned int set
, unsigned int clear
)
111 struct usb_serial_port
*port
= tty
->driver_data
;
112 struct usb_wwan_port_private
*portdata
;
113 struct usb_wwan_intf_private
*intfdata
;
115 portdata
= usb_get_serial_port_data(port
);
116 intfdata
= usb_get_serial_data(port
->serial
);
118 if (!intfdata
->use_send_setup
)
121 /* FIXME: what locks portdata fields ? */
123 portdata
->rts_state
= 1;
125 portdata
->dtr_state
= 1;
127 if (clear
& TIOCM_RTS
)
128 portdata
->rts_state
= 0;
129 if (clear
& TIOCM_DTR
)
130 portdata
->dtr_state
= 0;
131 return usb_wwan_send_setup(port
);
133 EXPORT_SYMBOL(usb_wwan_tiocmset
);
135 static int get_serial_info(struct usb_serial_port
*port
,
136 struct serial_struct __user
*retinfo
)
138 struct serial_struct tmp
;
140 memset(&tmp
, 0, sizeof(tmp
));
141 tmp
.line
= port
->minor
;
142 tmp
.port
= port
->port_number
;
143 tmp
.baud_base
= tty_get_baud_rate(port
->port
.tty
);
144 tmp
.close_delay
= port
->port
.close_delay
/ 10;
145 tmp
.closing_wait
= port
->port
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
146 ASYNC_CLOSING_WAIT_NONE
:
147 port
->port
.closing_wait
/ 10;
149 if (copy_to_user(retinfo
, &tmp
, sizeof(*retinfo
)))
154 static int set_serial_info(struct usb_serial_port
*port
,
155 struct serial_struct __user
*newinfo
)
157 struct serial_struct new_serial
;
158 unsigned int closing_wait
, close_delay
;
161 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
164 close_delay
= new_serial
.close_delay
* 10;
165 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
166 ASYNC_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
168 mutex_lock(&port
->port
.mutex
);
170 if (!capable(CAP_SYS_ADMIN
)) {
171 if ((close_delay
!= port
->port
.close_delay
) ||
172 (closing_wait
!= port
->port
.closing_wait
))
175 retval
= -EOPNOTSUPP
;
177 port
->port
.close_delay
= close_delay
;
178 port
->port
.closing_wait
= closing_wait
;
181 mutex_unlock(&port
->port
.mutex
);
185 int usb_wwan_ioctl(struct tty_struct
*tty
,
186 unsigned int cmd
, unsigned long arg
)
188 struct usb_serial_port
*port
= tty
->driver_data
;
190 dev_dbg(&port
->dev
, "%s cmd 0x%04x\n", __func__
, cmd
);
194 return get_serial_info(port
,
195 (struct serial_struct __user
*) arg
);
197 return set_serial_info(port
,
198 (struct serial_struct __user
*) arg
);
203 dev_dbg(&port
->dev
, "%s arg not supported\n", __func__
);
207 EXPORT_SYMBOL(usb_wwan_ioctl
);
209 int usb_wwan_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
210 const unsigned char *buf
, int count
)
212 struct usb_wwan_port_private
*portdata
;
213 struct usb_wwan_intf_private
*intfdata
;
216 struct urb
*this_urb
= NULL
; /* spurious */
220 portdata
= usb_get_serial_port_data(port
);
221 intfdata
= usb_get_serial_data(port
->serial
);
223 dev_dbg(&port
->dev
, "%s: write (%d chars)\n", __func__
, count
);
227 for (i
= 0; left
> 0 && i
< N_OUT_URB
; i
++) {
229 if (todo
> OUT_BUFLEN
)
232 this_urb
= portdata
->out_urbs
[i
];
233 if (test_and_set_bit(i
, &portdata
->out_busy
)) {
234 if (time_before(jiffies
,
235 portdata
->tx_start_time
[i
] + 10 * HZ
))
237 usb_unlink_urb(this_urb
);
240 dev_dbg(&port
->dev
, "%s: endpoint %d buf %d\n", __func__
,
241 usb_pipeendpoint(this_urb
->pipe
), i
);
243 err
= usb_autopm_get_interface_async(port
->serial
->interface
);
245 clear_bit(i
, &portdata
->out_busy
);
250 memcpy(this_urb
->transfer_buffer
, buf
, todo
);
251 this_urb
->transfer_buffer_length
= todo
;
253 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
254 if (intfdata
->suspended
) {
255 usb_anchor_urb(this_urb
, &portdata
->delayed
);
256 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
258 intfdata
->in_flight
++;
259 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
260 err
= usb_submit_urb(this_urb
, GFP_ATOMIC
);
263 "%s: submit urb %d failed: %d\n",
265 clear_bit(i
, &portdata
->out_busy
);
266 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
267 intfdata
->in_flight
--;
268 spin_unlock_irqrestore(&intfdata
->susp_lock
,
270 usb_autopm_put_interface_async(port
->serial
->interface
);
275 portdata
->tx_start_time
[i
] = jiffies
;
281 dev_dbg(&port
->dev
, "%s: wrote (did %d)\n", __func__
, count
);
284 EXPORT_SYMBOL(usb_wwan_write
);
286 static void usb_wwan_indat_callback(struct urb
*urb
)
290 struct usb_serial_port
*port
;
292 unsigned char *data
= urb
->transfer_buffer
;
293 int status
= urb
->status
;
295 endpoint
= usb_pipeendpoint(urb
->pipe
);
300 dev_dbg(dev
, "%s: nonzero status: %d on endpoint %02x.\n",
301 __func__
, status
, endpoint
);
303 if (urb
->actual_length
) {
304 tty_insert_flip_string(&port
->port
, data
,
306 tty_flip_buffer_push(&port
->port
);
308 dev_dbg(dev
, "%s: empty read urb received\n", __func__
);
310 /* Resubmit urb so we continue receiving */
311 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
313 if (err
!= -EPERM
&& err
!= -ENODEV
) {
314 dev_err(dev
, "%s: resubmit read urb failed. (%d)\n",
316 /* busy also in error unless we are killed */
317 usb_mark_last_busy(port
->serial
->dev
);
320 usb_mark_last_busy(port
->serial
->dev
);
324 static void usb_wwan_outdat_callback(struct urb
*urb
)
326 struct usb_serial_port
*port
;
327 struct usb_wwan_port_private
*portdata
;
328 struct usb_wwan_intf_private
*intfdata
;
332 intfdata
= usb_get_serial_data(port
->serial
);
334 usb_serial_port_softint(port
);
335 usb_autopm_put_interface_async(port
->serial
->interface
);
336 portdata
= usb_get_serial_port_data(port
);
337 spin_lock(&intfdata
->susp_lock
);
338 intfdata
->in_flight
--;
339 spin_unlock(&intfdata
->susp_lock
);
341 for (i
= 0; i
< N_OUT_URB
; ++i
) {
342 if (portdata
->out_urbs
[i
] == urb
) {
343 smp_mb__before_atomic();
344 clear_bit(i
, &portdata
->out_busy
);
350 int usb_wwan_write_room(struct tty_struct
*tty
)
352 struct usb_serial_port
*port
= tty
->driver_data
;
353 struct usb_wwan_port_private
*portdata
;
356 struct urb
*this_urb
;
358 portdata
= usb_get_serial_port_data(port
);
360 for (i
= 0; i
< N_OUT_URB
; i
++) {
361 this_urb
= portdata
->out_urbs
[i
];
362 if (this_urb
&& !test_bit(i
, &portdata
->out_busy
))
363 data_len
+= OUT_BUFLEN
;
366 dev_dbg(&port
->dev
, "%s: %d\n", __func__
, data_len
);
369 EXPORT_SYMBOL(usb_wwan_write_room
);
371 int usb_wwan_chars_in_buffer(struct tty_struct
*tty
)
373 struct usb_serial_port
*port
= tty
->driver_data
;
374 struct usb_wwan_port_private
*portdata
;
377 struct urb
*this_urb
;
379 portdata
= usb_get_serial_port_data(port
);
381 for (i
= 0; i
< N_OUT_URB
; i
++) {
382 this_urb
= portdata
->out_urbs
[i
];
383 /* FIXME: This locking is insufficient as this_urb may
384 go unused during the test */
385 if (this_urb
&& test_bit(i
, &portdata
->out_busy
))
386 data_len
+= this_urb
->transfer_buffer_length
;
388 dev_dbg(&port
->dev
, "%s: %d\n", __func__
, data_len
);
391 EXPORT_SYMBOL(usb_wwan_chars_in_buffer
);
393 int usb_wwan_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
395 struct usb_wwan_port_private
*portdata
;
396 struct usb_wwan_intf_private
*intfdata
;
397 struct usb_serial
*serial
= port
->serial
;
401 portdata
= usb_get_serial_port_data(port
);
402 intfdata
= usb_get_serial_data(serial
);
404 if (port
->interrupt_in_urb
) {
405 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
407 dev_err(&port
->dev
, "%s: submit int urb failed: %d\n",
412 /* Start reading from the IN endpoint */
413 for (i
= 0; i
< N_IN_URB
; i
++) {
414 urb
= portdata
->in_urbs
[i
];
417 err
= usb_submit_urb(urb
, GFP_KERNEL
);
420 "%s: submit read urb %d failed: %d\n",
425 spin_lock_irq(&intfdata
->susp_lock
);
426 if (++intfdata
->open_ports
== 1)
427 serial
->interface
->needs_remote_wakeup
= 1;
428 spin_unlock_irq(&intfdata
->susp_lock
);
429 /* this balances a get in the generic USB serial code */
430 usb_autopm_put_interface(serial
->interface
);
434 EXPORT_SYMBOL(usb_wwan_open
);
436 static void unbusy_queued_urb(struct urb
*urb
,
437 struct usb_wwan_port_private
*portdata
)
441 for (i
= 0; i
< N_OUT_URB
; i
++) {
442 if (urb
== portdata
->out_urbs
[i
]) {
443 clear_bit(i
, &portdata
->out_busy
);
449 void usb_wwan_close(struct usb_serial_port
*port
)
452 struct usb_serial
*serial
= port
->serial
;
453 struct usb_wwan_port_private
*portdata
;
454 struct usb_wwan_intf_private
*intfdata
= usb_get_serial_data(serial
);
457 portdata
= usb_get_serial_port_data(port
);
460 * Need to take susp_lock to make sure port is not already being
461 * resumed, but no need to hold it due to initialized
463 spin_lock_irq(&intfdata
->susp_lock
);
464 if (--intfdata
->open_ports
== 0)
465 serial
->interface
->needs_remote_wakeup
= 0;
466 spin_unlock_irq(&intfdata
->susp_lock
);
469 urb
= usb_get_from_anchor(&portdata
->delayed
);
472 unbusy_queued_urb(urb
, portdata
);
473 usb_autopm_put_interface_async(serial
->interface
);
476 for (i
= 0; i
< N_IN_URB
; i
++)
477 usb_kill_urb(portdata
->in_urbs
[i
]);
478 for (i
= 0; i
< N_OUT_URB
; i
++)
479 usb_kill_urb(portdata
->out_urbs
[i
]);
480 usb_kill_urb(port
->interrupt_in_urb
);
482 usb_autopm_get_interface_no_resume(serial
->interface
);
484 EXPORT_SYMBOL(usb_wwan_close
);
486 static struct urb
*usb_wwan_setup_urb(struct usb_serial_port
*port
,
488 int dir
, void *ctx
, char *buf
, int len
,
489 void (*callback
) (struct urb
*))
491 struct usb_serial
*serial
= port
->serial
;
494 urb
= usb_alloc_urb(0, GFP_KERNEL
); /* No ISO */
498 usb_fill_bulk_urb(urb
, serial
->dev
,
499 usb_sndbulkpipe(serial
->dev
, endpoint
) | dir
,
500 buf
, len
, callback
, ctx
);
505 int usb_wwan_port_probe(struct usb_serial_port
*port
)
507 struct usb_wwan_port_private
*portdata
;
512 if (!port
->bulk_in_size
|| !port
->bulk_out_size
)
515 portdata
= kzalloc(sizeof(*portdata
), GFP_KERNEL
);
519 init_usb_anchor(&portdata
->delayed
);
521 for (i
= 0; i
< N_IN_URB
; i
++) {
522 buffer
= (u8
*)__get_free_page(GFP_KERNEL
);
525 portdata
->in_buffer
[i
] = buffer
;
527 urb
= usb_wwan_setup_urb(port
, port
->bulk_in_endpointAddress
,
530 usb_wwan_indat_callback
);
531 portdata
->in_urbs
[i
] = urb
;
534 for (i
= 0; i
< N_OUT_URB
; i
++) {
535 buffer
= kmalloc(OUT_BUFLEN
, GFP_KERNEL
);
537 goto bail_out_error2
;
538 portdata
->out_buffer
[i
] = buffer
;
540 urb
= usb_wwan_setup_urb(port
, port
->bulk_out_endpointAddress
,
543 usb_wwan_outdat_callback
);
544 portdata
->out_urbs
[i
] = urb
;
547 usb_set_serial_port_data(port
, portdata
);
552 for (i
= 0; i
< N_OUT_URB
; i
++) {
553 usb_free_urb(portdata
->out_urbs
[i
]);
554 kfree(portdata
->out_buffer
[i
]);
557 for (i
= 0; i
< N_IN_URB
; i
++) {
558 usb_free_urb(portdata
->in_urbs
[i
]);
559 free_page((unsigned long)portdata
->in_buffer
[i
]);
565 EXPORT_SYMBOL_GPL(usb_wwan_port_probe
);
567 int usb_wwan_port_remove(struct usb_serial_port
*port
)
570 struct usb_wwan_port_private
*portdata
;
572 portdata
= usb_get_serial_port_data(port
);
573 usb_set_serial_port_data(port
, NULL
);
575 for (i
= 0; i
< N_IN_URB
; i
++) {
576 usb_free_urb(portdata
->in_urbs
[i
]);
577 free_page((unsigned long)portdata
->in_buffer
[i
]);
579 for (i
= 0; i
< N_OUT_URB
; i
++) {
580 usb_free_urb(portdata
->out_urbs
[i
]);
581 kfree(portdata
->out_buffer
[i
]);
588 EXPORT_SYMBOL(usb_wwan_port_remove
);
591 static void stop_urbs(struct usb_serial
*serial
)
594 struct usb_serial_port
*port
;
595 struct usb_wwan_port_private
*portdata
;
597 for (i
= 0; i
< serial
->num_ports
; ++i
) {
598 port
= serial
->port
[i
];
599 portdata
= usb_get_serial_port_data(port
);
602 for (j
= 0; j
< N_IN_URB
; j
++)
603 usb_kill_urb(portdata
->in_urbs
[j
]);
604 for (j
= 0; j
< N_OUT_URB
; j
++)
605 usb_kill_urb(portdata
->out_urbs
[j
]);
606 usb_kill_urb(port
->interrupt_in_urb
);
610 int usb_wwan_suspend(struct usb_serial
*serial
, pm_message_t message
)
612 struct usb_wwan_intf_private
*intfdata
= usb_get_serial_data(serial
);
614 spin_lock_irq(&intfdata
->susp_lock
);
615 if (PMSG_IS_AUTO(message
)) {
616 if (intfdata
->in_flight
) {
617 spin_unlock_irq(&intfdata
->susp_lock
);
621 intfdata
->suspended
= 1;
622 spin_unlock_irq(&intfdata
->susp_lock
);
628 EXPORT_SYMBOL(usb_wwan_suspend
);
630 /* Caller must hold susp_lock. */
631 static int usb_wwan_submit_delayed_urbs(struct usb_serial_port
*port
)
633 struct usb_serial
*serial
= port
->serial
;
634 struct usb_wwan_intf_private
*data
= usb_get_serial_data(serial
);
635 struct usb_wwan_port_private
*portdata
;
640 portdata
= usb_get_serial_port_data(port
);
643 urb
= usb_get_from_anchor(&portdata
->delayed
);
647 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
649 dev_err(&port
->dev
, "%s: submit urb failed: %d\n",
652 unbusy_queued_urb(urb
, portdata
);
653 usb_autopm_put_interface_async(serial
->interface
);
665 int usb_wwan_resume(struct usb_serial
*serial
)
668 struct usb_serial_port
*port
;
669 struct usb_wwan_intf_private
*intfdata
= usb_get_serial_data(serial
);
670 struct usb_wwan_port_private
*portdata
;
675 spin_lock_irq(&intfdata
->susp_lock
);
676 for (i
= 0; i
< serial
->num_ports
; i
++) {
677 port
= serial
->port
[i
];
679 if (!tty_port_initialized(&port
->port
))
682 portdata
= usb_get_serial_port_data(port
);
684 if (port
->interrupt_in_urb
) {
685 err
= usb_submit_urb(port
->interrupt_in_urb
,
689 "%s: submit int urb failed: %d\n",
695 err
= usb_wwan_submit_delayed_urbs(port
);
699 for (j
= 0; j
< N_IN_URB
; j
++) {
700 urb
= portdata
->in_urbs
[j
];
701 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
704 "%s: submit read urb %d failed: %d\n",
710 intfdata
->suspended
= 0;
711 spin_unlock_irq(&intfdata
->susp_lock
);
718 EXPORT_SYMBOL(usb_wwan_resume
);
721 MODULE_AUTHOR(DRIVER_AUTHOR
);
722 MODULE_DESCRIPTION(DRIVER_DESC
);
723 MODULE_LICENSE("GPL v2");