1 // SPDX-License-Identifier: GPL-2.0
3 * USB Serial Converter Generic functions
5 * Copyright (C) 2010 - 2013 Johan Hovold (jhovold@gmail.com)
6 * Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com)
9 #include <linux/kernel.h>
10 #include <linux/sched/signal.h>
11 #include <linux/errno.h>
12 #include <linux/slab.h>
13 #include <linux/sysrq.h>
14 #include <linux/tty.h>
15 #include <linux/tty_flip.h>
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/usb.h>
19 #include <linux/usb/serial.h>
20 #include <linux/uaccess.h>
21 #include <linux/kfifo.h>
22 #include <linux/serial.h>
24 #ifdef CONFIG_USB_SERIAL_GENERIC
26 static __u16 vendor
= 0x05f9;
27 static __u16 product
= 0xffff;
29 module_param(vendor
, ushort
, 0);
30 MODULE_PARM_DESC(vendor
, "User specified USB idVendor");
32 module_param(product
, ushort
, 0);
33 MODULE_PARM_DESC(product
, "User specified USB idProduct");
35 static struct usb_device_id generic_device_ids
[2]; /* Initially all zeroes. */
37 static int usb_serial_generic_probe(struct usb_serial
*serial
,
38 const struct usb_device_id
*id
)
40 struct device
*dev
= &serial
->interface
->dev
;
42 dev_info(dev
, "The \"generic\" usb-serial driver is only for testing and one-off prototypes.\n");
43 dev_info(dev
, "Tell linux-usb@vger.kernel.org to add your device to a proper driver.\n");
48 static int usb_serial_generic_calc_num_ports(struct usb_serial
*serial
,
49 struct usb_serial_endpoints
*epds
)
51 struct device
*dev
= &serial
->interface
->dev
;
54 num_ports
= max(epds
->num_bulk_in
, epds
->num_bulk_out
);
57 dev_err(dev
, "device has no bulk endpoints\n");
64 static struct usb_serial_driver usb_serial_generic_device
= {
69 .id_table
= generic_device_ids
,
70 .probe
= usb_serial_generic_probe
,
71 .calc_num_ports
= usb_serial_generic_calc_num_ports
,
72 .throttle
= usb_serial_generic_throttle
,
73 .unthrottle
= usb_serial_generic_unthrottle
,
74 .resume
= usb_serial_generic_resume
,
77 static struct usb_serial_driver
* const serial_drivers
[] = {
78 &usb_serial_generic_device
, NULL
83 int usb_serial_generic_register(void)
87 #ifdef CONFIG_USB_SERIAL_GENERIC
88 generic_device_ids
[0].idVendor
= vendor
;
89 generic_device_ids
[0].idProduct
= product
;
90 generic_device_ids
[0].match_flags
=
91 USB_DEVICE_ID_MATCH_VENDOR
| USB_DEVICE_ID_MATCH_PRODUCT
;
93 retval
= usb_serial_register_drivers(serial_drivers
,
94 "usbserial_generic", generic_device_ids
);
99 void usb_serial_generic_deregister(void)
101 #ifdef CONFIG_USB_SERIAL_GENERIC
102 usb_serial_deregister_drivers(serial_drivers
);
106 int usb_serial_generic_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
111 spin_lock_irqsave(&port
->lock
, flags
);
113 port
->throttle_req
= 0;
114 spin_unlock_irqrestore(&port
->lock
, flags
);
116 if (port
->bulk_in_size
)
117 result
= usb_serial_generic_submit_read_urbs(port
, GFP_KERNEL
);
121 EXPORT_SYMBOL_GPL(usb_serial_generic_open
);
123 void usb_serial_generic_close(struct usb_serial_port
*port
)
128 if (port
->bulk_out_size
) {
129 for (i
= 0; i
< ARRAY_SIZE(port
->write_urbs
); ++i
)
130 usb_kill_urb(port
->write_urbs
[i
]);
132 spin_lock_irqsave(&port
->lock
, flags
);
133 kfifo_reset_out(&port
->write_fifo
);
134 spin_unlock_irqrestore(&port
->lock
, flags
);
136 if (port
->bulk_in_size
) {
137 for (i
= 0; i
< ARRAY_SIZE(port
->read_urbs
); ++i
)
138 usb_kill_urb(port
->read_urbs
[i
]);
141 EXPORT_SYMBOL_GPL(usb_serial_generic_close
);
143 int usb_serial_generic_prepare_write_buffer(struct usb_serial_port
*port
,
144 void *dest
, size_t size
)
146 return kfifo_out_locked(&port
->write_fifo
, dest
, size
, &port
->lock
);
150 * usb_serial_generic_write_start - start writing buffered data
151 * @port: usb-serial port
152 * @mem_flags: flags to use for memory allocations
154 * Serialised using USB_SERIAL_WRITE_BUSY flag.
156 * Return: Zero on success or if busy, otherwise a negative errno value.
158 int usb_serial_generic_write_start(struct usb_serial_port
*port
,
166 if (test_and_set_bit_lock(USB_SERIAL_WRITE_BUSY
, &port
->flags
))
169 spin_lock_irqsave(&port
->lock
, flags
);
170 if (!port
->write_urbs_free
|| !kfifo_len(&port
->write_fifo
)) {
171 clear_bit_unlock(USB_SERIAL_WRITE_BUSY
, &port
->flags
);
172 spin_unlock_irqrestore(&port
->lock
, flags
);
175 i
= (int)find_first_bit(&port
->write_urbs_free
,
176 ARRAY_SIZE(port
->write_urbs
));
177 spin_unlock_irqrestore(&port
->lock
, flags
);
179 urb
= port
->write_urbs
[i
];
180 count
= port
->serial
->type
->prepare_write_buffer(port
,
181 urb
->transfer_buffer
,
182 port
->bulk_out_size
);
183 urb
->transfer_buffer_length
= count
;
184 usb_serial_debug_data(&port
->dev
, __func__
, count
, urb
->transfer_buffer
);
185 spin_lock_irqsave(&port
->lock
, flags
);
186 port
->tx_bytes
+= count
;
187 spin_unlock_irqrestore(&port
->lock
, flags
);
189 clear_bit(i
, &port
->write_urbs_free
);
190 result
= usb_submit_urb(urb
, mem_flags
);
192 dev_err_console(port
, "%s - error submitting urb: %d\n",
194 set_bit(i
, &port
->write_urbs_free
);
195 spin_lock_irqsave(&port
->lock
, flags
);
196 port
->tx_bytes
-= count
;
197 spin_unlock_irqrestore(&port
->lock
, flags
);
199 clear_bit_unlock(USB_SERIAL_WRITE_BUSY
, &port
->flags
);
203 goto retry
; /* try sending off another urb */
205 EXPORT_SYMBOL_GPL(usb_serial_generic_write_start
);
208 * usb_serial_generic_write - generic write function
209 * @tty: tty for the port
210 * @port: usb-serial port
211 * @buf: data to write
212 * @count: number of bytes to write
214 * Return: The number of characters buffered, which may be anything from
215 * zero to @count, or a negative errno value.
217 int usb_serial_generic_write(struct tty_struct
*tty
,
218 struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
222 if (!port
->bulk_out_size
)
228 count
= kfifo_in_locked(&port
->write_fifo
, buf
, count
, &port
->lock
);
229 result
= usb_serial_generic_write_start(port
, GFP_ATOMIC
);
235 EXPORT_SYMBOL_GPL(usb_serial_generic_write
);
237 int usb_serial_generic_write_room(struct tty_struct
*tty
)
239 struct usb_serial_port
*port
= tty
->driver_data
;
243 if (!port
->bulk_out_size
)
246 spin_lock_irqsave(&port
->lock
, flags
);
247 room
= kfifo_avail(&port
->write_fifo
);
248 spin_unlock_irqrestore(&port
->lock
, flags
);
250 dev_dbg(&port
->dev
, "%s - returns %d\n", __func__
, room
);
254 int usb_serial_generic_chars_in_buffer(struct tty_struct
*tty
)
256 struct usb_serial_port
*port
= tty
->driver_data
;
260 if (!port
->bulk_out_size
)
263 spin_lock_irqsave(&port
->lock
, flags
);
264 chars
= kfifo_len(&port
->write_fifo
) + port
->tx_bytes
;
265 spin_unlock_irqrestore(&port
->lock
, flags
);
267 dev_dbg(&port
->dev
, "%s - returns %d\n", __func__
, chars
);
270 EXPORT_SYMBOL_GPL(usb_serial_generic_chars_in_buffer
);
272 void usb_serial_generic_wait_until_sent(struct tty_struct
*tty
, long timeout
)
274 struct usb_serial_port
*port
= tty
->driver_data
;
276 unsigned long period
;
277 unsigned long expire
;
279 bps
= tty_get_baud_rate(tty
);
283 * Use a poll-period of roughly the time it takes to send one
284 * character or at least one jiffy.
286 period
= max_t(unsigned long, (10 * HZ
/ bps
), 1);
288 period
= min_t(unsigned long, period
, timeout
);
290 dev_dbg(&port
->dev
, "%s - timeout = %u ms, period = %u ms\n",
291 __func__
, jiffies_to_msecs(timeout
),
292 jiffies_to_msecs(period
));
293 expire
= jiffies
+ timeout
;
294 while (!port
->serial
->type
->tx_empty(port
)) {
295 schedule_timeout_interruptible(period
);
296 if (signal_pending(current
))
298 if (timeout
&& time_after(jiffies
, expire
))
302 EXPORT_SYMBOL_GPL(usb_serial_generic_wait_until_sent
);
304 static int usb_serial_generic_submit_read_urb(struct usb_serial_port
*port
,
305 int index
, gfp_t mem_flags
)
309 if (!test_and_clear_bit(index
, &port
->read_urbs_free
))
312 dev_dbg(&port
->dev
, "%s - urb %d\n", __func__
, index
);
314 res
= usb_submit_urb(port
->read_urbs
[index
], mem_flags
);
316 if (res
!= -EPERM
&& res
!= -ENODEV
) {
318 "%s - usb_submit_urb failed: %d\n",
321 set_bit(index
, &port
->read_urbs_free
);
328 int usb_serial_generic_submit_read_urbs(struct usb_serial_port
*port
,
334 for (i
= 0; i
< ARRAY_SIZE(port
->read_urbs
); ++i
) {
335 res
= usb_serial_generic_submit_read_urb(port
, i
, mem_flags
);
343 usb_kill_urb(port
->read_urbs
[i
]);
347 EXPORT_SYMBOL_GPL(usb_serial_generic_submit_read_urbs
);
349 void usb_serial_generic_process_read_urb(struct urb
*urb
)
351 struct usb_serial_port
*port
= urb
->context
;
352 char *ch
= (char *)urb
->transfer_buffer
;
355 if (!urb
->actual_length
)
358 * The per character mucking around with sysrq path it too slow for
359 * stuff like 3G modems, so shortcircuit it in the 99.9999999% of
360 * cases where the USB serial is not a console anyway.
362 if (!port
->port
.console
|| !port
->sysrq
) {
363 tty_insert_flip_string(&port
->port
, ch
, urb
->actual_length
);
365 for (i
= 0; i
< urb
->actual_length
; i
++, ch
++) {
366 if (!usb_serial_handle_sysrq_char(port
, *ch
))
367 tty_insert_flip_char(&port
->port
, *ch
, TTY_NORMAL
);
370 tty_flip_buffer_push(&port
->port
);
372 EXPORT_SYMBOL_GPL(usb_serial_generic_process_read_urb
);
374 void usb_serial_generic_read_bulk_callback(struct urb
*urb
)
376 struct usb_serial_port
*port
= urb
->context
;
377 unsigned char *data
= urb
->transfer_buffer
;
379 int status
= urb
->status
;
382 for (i
= 0; i
< ARRAY_SIZE(port
->read_urbs
); ++i
) {
383 if (urb
== port
->read_urbs
[i
])
386 set_bit(i
, &port
->read_urbs_free
);
388 dev_dbg(&port
->dev
, "%s - urb %d, len %d\n", __func__
, i
,
396 dev_dbg(&port
->dev
, "%s - urb stopped: %d\n",
400 dev_err(&port
->dev
, "%s - urb stopped: %d\n",
404 dev_dbg(&port
->dev
, "%s - nonzero urb status: %d\n",
409 usb_serial_debug_data(&port
->dev
, __func__
, urb
->actual_length
, data
);
410 port
->serial
->type
->process_read_urb(urb
);
413 /* Throttle the device if requested by tty */
414 spin_lock_irqsave(&port
->lock
, flags
);
415 port
->throttled
= port
->throttle_req
;
416 if (!port
->throttled
) {
417 spin_unlock_irqrestore(&port
->lock
, flags
);
418 usb_serial_generic_submit_read_urb(port
, i
, GFP_ATOMIC
);
420 spin_unlock_irqrestore(&port
->lock
, flags
);
423 EXPORT_SYMBOL_GPL(usb_serial_generic_read_bulk_callback
);
425 void usb_serial_generic_write_bulk_callback(struct urb
*urb
)
428 struct usb_serial_port
*port
= urb
->context
;
429 int status
= urb
->status
;
432 for (i
= 0; i
< ARRAY_SIZE(port
->write_urbs
); ++i
) {
433 if (port
->write_urbs
[i
] == urb
)
436 spin_lock_irqsave(&port
->lock
, flags
);
437 port
->tx_bytes
-= urb
->transfer_buffer_length
;
438 set_bit(i
, &port
->write_urbs_free
);
439 spin_unlock_irqrestore(&port
->lock
, flags
);
447 dev_dbg(&port
->dev
, "%s - urb stopped: %d\n",
451 dev_err_console(port
, "%s - urb stopped: %d\n",
455 dev_err_console(port
, "%s - nonzero urb status: %d\n",
461 usb_serial_generic_write_start(port
, GFP_ATOMIC
);
462 usb_serial_port_softint(port
);
464 EXPORT_SYMBOL_GPL(usb_serial_generic_write_bulk_callback
);
466 void usb_serial_generic_throttle(struct tty_struct
*tty
)
468 struct usb_serial_port
*port
= tty
->driver_data
;
471 spin_lock_irqsave(&port
->lock
, flags
);
472 port
->throttle_req
= 1;
473 spin_unlock_irqrestore(&port
->lock
, flags
);
475 EXPORT_SYMBOL_GPL(usb_serial_generic_throttle
);
477 void usb_serial_generic_unthrottle(struct tty_struct
*tty
)
479 struct usb_serial_port
*port
= tty
->driver_data
;
482 spin_lock_irq(&port
->lock
);
483 was_throttled
= port
->throttled
;
484 port
->throttled
= port
->throttle_req
= 0;
485 spin_unlock_irq(&port
->lock
);
488 usb_serial_generic_submit_read_urbs(port
, GFP_KERNEL
);
490 EXPORT_SYMBOL_GPL(usb_serial_generic_unthrottle
);
492 static bool usb_serial_generic_msr_changed(struct tty_struct
*tty
,
493 unsigned long arg
, struct async_icount
*cprev
)
495 struct usb_serial_port
*port
= tty
->driver_data
;
496 struct async_icount cnow
;
501 * Use tty-port initialised flag to detect all hangups including the
502 * one generated at USB-device disconnect.
504 if (!tty_port_initialized(&port
->port
))
507 spin_lock_irqsave(&port
->lock
, flags
);
508 cnow
= port
->icount
; /* atomic copy*/
509 spin_unlock_irqrestore(&port
->lock
, flags
);
511 ret
= ((arg
& TIOCM_RNG
) && (cnow
.rng
!= cprev
->rng
)) ||
512 ((arg
& TIOCM_DSR
) && (cnow
.dsr
!= cprev
->dsr
)) ||
513 ((arg
& TIOCM_CD
) && (cnow
.dcd
!= cprev
->dcd
)) ||
514 ((arg
& TIOCM_CTS
) && (cnow
.cts
!= cprev
->cts
));
521 int usb_serial_generic_tiocmiwait(struct tty_struct
*tty
, unsigned long arg
)
523 struct usb_serial_port
*port
= tty
->driver_data
;
524 struct async_icount cnow
;
528 spin_lock_irqsave(&port
->lock
, flags
);
529 cnow
= port
->icount
; /* atomic copy */
530 spin_unlock_irqrestore(&port
->lock
, flags
);
532 ret
= wait_event_interruptible(port
->port
.delta_msr_wait
,
533 usb_serial_generic_msr_changed(tty
, arg
, &cnow
));
534 if (!ret
&& !tty_port_initialized(&port
->port
))
539 EXPORT_SYMBOL_GPL(usb_serial_generic_tiocmiwait
);
541 int usb_serial_generic_get_icount(struct tty_struct
*tty
,
542 struct serial_icounter_struct
*icount
)
544 struct usb_serial_port
*port
= tty
->driver_data
;
545 struct async_icount cnow
;
548 spin_lock_irqsave(&port
->lock
, flags
);
549 cnow
= port
->icount
; /* atomic copy */
550 spin_unlock_irqrestore(&port
->lock
, flags
);
552 icount
->cts
= cnow
.cts
;
553 icount
->dsr
= cnow
.dsr
;
554 icount
->rng
= cnow
.rng
;
555 icount
->dcd
= cnow
.dcd
;
556 icount
->tx
= cnow
.tx
;
557 icount
->rx
= cnow
.rx
;
558 icount
->frame
= cnow
.frame
;
559 icount
->parity
= cnow
.parity
;
560 icount
->overrun
= cnow
.overrun
;
561 icount
->brk
= cnow
.brk
;
562 icount
->buf_overrun
= cnow
.buf_overrun
;
566 EXPORT_SYMBOL_GPL(usb_serial_generic_get_icount
);
568 #ifdef CONFIG_MAGIC_SYSRQ
569 int usb_serial_handle_sysrq_char(struct usb_serial_port
*port
, unsigned int ch
)
571 if (port
->sysrq
&& port
->port
.console
) {
572 if (ch
&& time_before(jiffies
, port
->sysrq
)) {
582 int usb_serial_handle_sysrq_char(struct usb_serial_port
*port
, unsigned int ch
)
587 EXPORT_SYMBOL_GPL(usb_serial_handle_sysrq_char
);
589 int usb_serial_handle_break(struct usb_serial_port
*port
)
592 port
->sysrq
= jiffies
+ HZ
*5;
598 EXPORT_SYMBOL_GPL(usb_serial_handle_break
);
601 * usb_serial_handle_dcd_change - handle a change of carrier detect state
602 * @port: usb-serial port
603 * @tty: tty for the port
604 * @status: new carrier detect status, nonzero if active
606 void usb_serial_handle_dcd_change(struct usb_serial_port
*usb_port
,
607 struct tty_struct
*tty
, unsigned int status
)
609 struct tty_port
*port
= &usb_port
->port
;
611 dev_dbg(&usb_port
->dev
, "%s - status %d\n", __func__
, status
);
614 struct tty_ldisc
*ld
= tty_ldisc_ref(tty
);
617 if (ld
->ops
->dcd_change
)
618 ld
->ops
->dcd_change(tty
, status
);
624 wake_up_interruptible(&port
->open_wait
);
625 else if (tty
&& !C_CLOCAL(tty
))
628 EXPORT_SYMBOL_GPL(usb_serial_handle_dcd_change
);
630 int usb_serial_generic_resume(struct usb_serial
*serial
)
632 struct usb_serial_port
*port
;
635 for (i
= 0; i
< serial
->num_ports
; i
++) {
636 port
= serial
->port
[i
];
637 if (!tty_port_initialized(&port
->port
))
640 if (port
->bulk_in_size
) {
641 r
= usb_serial_generic_submit_read_urbs(port
,
647 if (port
->bulk_out_size
) {
648 r
= usb_serial_generic_write_start(port
, GFP_NOIO
);
656 EXPORT_SYMBOL_GPL(usb_serial_generic_resume
);