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
)
110 clear_bit(USB_SERIAL_THROTTLED
, &port
->flags
);
112 if (port
->bulk_in_size
)
113 result
= usb_serial_generic_submit_read_urbs(port
, GFP_KERNEL
);
117 EXPORT_SYMBOL_GPL(usb_serial_generic_open
);
119 void usb_serial_generic_close(struct usb_serial_port
*port
)
124 if (port
->bulk_out_size
) {
125 for (i
= 0; i
< ARRAY_SIZE(port
->write_urbs
); ++i
)
126 usb_kill_urb(port
->write_urbs
[i
]);
128 spin_lock_irqsave(&port
->lock
, flags
);
129 kfifo_reset_out(&port
->write_fifo
);
130 spin_unlock_irqrestore(&port
->lock
, flags
);
132 if (port
->bulk_in_size
) {
133 for (i
= 0; i
< ARRAY_SIZE(port
->read_urbs
); ++i
)
134 usb_kill_urb(port
->read_urbs
[i
]);
137 EXPORT_SYMBOL_GPL(usb_serial_generic_close
);
139 int usb_serial_generic_prepare_write_buffer(struct usb_serial_port
*port
,
140 void *dest
, size_t size
)
142 return kfifo_out_locked(&port
->write_fifo
, dest
, size
, &port
->lock
);
146 * usb_serial_generic_write_start - start writing buffered data
147 * @port: usb-serial port
148 * @mem_flags: flags to use for memory allocations
150 * Serialised using USB_SERIAL_WRITE_BUSY flag.
152 * Return: Zero on success or if busy, otherwise a negative errno value.
154 int usb_serial_generic_write_start(struct usb_serial_port
*port
,
162 if (test_and_set_bit_lock(USB_SERIAL_WRITE_BUSY
, &port
->flags
))
165 spin_lock_irqsave(&port
->lock
, flags
);
166 if (!port
->write_urbs_free
|| !kfifo_len(&port
->write_fifo
)) {
167 clear_bit_unlock(USB_SERIAL_WRITE_BUSY
, &port
->flags
);
168 spin_unlock_irqrestore(&port
->lock
, flags
);
171 i
= (int)find_first_bit(&port
->write_urbs_free
,
172 ARRAY_SIZE(port
->write_urbs
));
173 spin_unlock_irqrestore(&port
->lock
, flags
);
175 urb
= port
->write_urbs
[i
];
176 count
= port
->serial
->type
->prepare_write_buffer(port
,
177 urb
->transfer_buffer
,
178 port
->bulk_out_size
);
179 urb
->transfer_buffer_length
= count
;
180 usb_serial_debug_data(&port
->dev
, __func__
, count
, urb
->transfer_buffer
);
181 spin_lock_irqsave(&port
->lock
, flags
);
182 port
->tx_bytes
+= count
;
183 spin_unlock_irqrestore(&port
->lock
, flags
);
185 clear_bit(i
, &port
->write_urbs_free
);
186 result
= usb_submit_urb(urb
, mem_flags
);
188 dev_err_console(port
, "%s - error submitting urb: %d\n",
190 set_bit(i
, &port
->write_urbs_free
);
191 spin_lock_irqsave(&port
->lock
, flags
);
192 port
->tx_bytes
-= count
;
193 spin_unlock_irqrestore(&port
->lock
, flags
);
195 clear_bit_unlock(USB_SERIAL_WRITE_BUSY
, &port
->flags
);
199 goto retry
; /* try sending off another urb */
201 EXPORT_SYMBOL_GPL(usb_serial_generic_write_start
);
204 * usb_serial_generic_write - generic write function
205 * @tty: tty for the port
206 * @port: usb-serial port
207 * @buf: data to write
208 * @count: number of bytes to write
210 * Return: The number of characters buffered, which may be anything from
211 * zero to @count, or a negative errno value.
213 int usb_serial_generic_write(struct tty_struct
*tty
,
214 struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
218 if (!port
->bulk_out_size
)
224 count
= kfifo_in_locked(&port
->write_fifo
, buf
, count
, &port
->lock
);
225 result
= usb_serial_generic_write_start(port
, GFP_ATOMIC
);
231 EXPORT_SYMBOL_GPL(usb_serial_generic_write
);
233 int usb_serial_generic_write_room(struct tty_struct
*tty
)
235 struct usb_serial_port
*port
= tty
->driver_data
;
239 if (!port
->bulk_out_size
)
242 spin_lock_irqsave(&port
->lock
, flags
);
243 room
= kfifo_avail(&port
->write_fifo
);
244 spin_unlock_irqrestore(&port
->lock
, flags
);
246 dev_dbg(&port
->dev
, "%s - returns %d\n", __func__
, room
);
250 int usb_serial_generic_chars_in_buffer(struct tty_struct
*tty
)
252 struct usb_serial_port
*port
= tty
->driver_data
;
256 if (!port
->bulk_out_size
)
259 spin_lock_irqsave(&port
->lock
, flags
);
260 chars
= kfifo_len(&port
->write_fifo
) + port
->tx_bytes
;
261 spin_unlock_irqrestore(&port
->lock
, flags
);
263 dev_dbg(&port
->dev
, "%s - returns %d\n", __func__
, chars
);
266 EXPORT_SYMBOL_GPL(usb_serial_generic_chars_in_buffer
);
268 void usb_serial_generic_wait_until_sent(struct tty_struct
*tty
, long timeout
)
270 struct usb_serial_port
*port
= tty
->driver_data
;
272 unsigned long period
;
273 unsigned long expire
;
275 bps
= tty_get_baud_rate(tty
);
279 * Use a poll-period of roughly the time it takes to send one
280 * character or at least one jiffy.
282 period
= max_t(unsigned long, (10 * HZ
/ bps
), 1);
284 period
= min_t(unsigned long, period
, timeout
);
286 dev_dbg(&port
->dev
, "%s - timeout = %u ms, period = %u ms\n",
287 __func__
, jiffies_to_msecs(timeout
),
288 jiffies_to_msecs(period
));
289 expire
= jiffies
+ timeout
;
290 while (!port
->serial
->type
->tx_empty(port
)) {
291 schedule_timeout_interruptible(period
);
292 if (signal_pending(current
))
294 if (timeout
&& time_after(jiffies
, expire
))
298 EXPORT_SYMBOL_GPL(usb_serial_generic_wait_until_sent
);
300 static int usb_serial_generic_submit_read_urb(struct usb_serial_port
*port
,
301 int index
, gfp_t mem_flags
)
305 if (!test_and_clear_bit(index
, &port
->read_urbs_free
))
308 dev_dbg(&port
->dev
, "%s - urb %d\n", __func__
, index
);
310 res
= usb_submit_urb(port
->read_urbs
[index
], mem_flags
);
312 if (res
!= -EPERM
&& res
!= -ENODEV
) {
314 "%s - usb_submit_urb failed: %d\n",
317 set_bit(index
, &port
->read_urbs_free
);
324 int usb_serial_generic_submit_read_urbs(struct usb_serial_port
*port
,
330 for (i
= 0; i
< ARRAY_SIZE(port
->read_urbs
); ++i
) {
331 res
= usb_serial_generic_submit_read_urb(port
, i
, mem_flags
);
339 usb_kill_urb(port
->read_urbs
[i
]);
343 EXPORT_SYMBOL_GPL(usb_serial_generic_submit_read_urbs
);
345 void usb_serial_generic_process_read_urb(struct urb
*urb
)
347 struct usb_serial_port
*port
= urb
->context
;
348 char *ch
= (char *)urb
->transfer_buffer
;
351 if (!urb
->actual_length
)
354 * The per character mucking around with sysrq path it too slow for
355 * stuff like 3G modems, so shortcircuit it in the 99.9999999% of
356 * cases where the USB serial is not a console anyway.
358 if (!port
->port
.console
|| !port
->sysrq
) {
359 tty_insert_flip_string(&port
->port
, ch
, urb
->actual_length
);
361 for (i
= 0; i
< urb
->actual_length
; i
++, ch
++) {
362 if (!usb_serial_handle_sysrq_char(port
, *ch
))
363 tty_insert_flip_char(&port
->port
, *ch
, TTY_NORMAL
);
366 tty_flip_buffer_push(&port
->port
);
368 EXPORT_SYMBOL_GPL(usb_serial_generic_process_read_urb
);
370 void usb_serial_generic_read_bulk_callback(struct urb
*urb
)
372 struct usb_serial_port
*port
= urb
->context
;
373 unsigned char *data
= urb
->transfer_buffer
;
374 bool stopped
= false;
375 int status
= urb
->status
;
378 for (i
= 0; i
< ARRAY_SIZE(port
->read_urbs
); ++i
) {
379 if (urb
== port
->read_urbs
[i
])
383 dev_dbg(&port
->dev
, "%s - urb %d, len %d\n", __func__
, i
,
387 usb_serial_debug_data(&port
->dev
, __func__
, urb
->actual_length
,
389 port
->serial
->type
->process_read_urb(urb
);
394 dev_dbg(&port
->dev
, "%s - urb stopped: %d\n",
399 dev_err(&port
->dev
, "%s - urb stopped: %d\n",
404 dev_dbg(&port
->dev
, "%s - nonzero urb status: %d\n",
410 * Make sure URB processing is done before marking as free to avoid
411 * racing with unthrottle() on another CPU. Matches the barriers
412 * implied by the test_and_clear_bit() in
413 * usb_serial_generic_submit_read_urb().
415 smp_mb__before_atomic();
416 set_bit(i
, &port
->read_urbs_free
);
418 * Make sure URB is marked as free before checking the throttled flag
419 * to avoid racing with unthrottle() on another CPU. Matches the
420 * smp_mb() in unthrottle().
422 smp_mb__after_atomic();
427 if (test_bit(USB_SERIAL_THROTTLED
, &port
->flags
))
430 usb_serial_generic_submit_read_urb(port
, i
, GFP_ATOMIC
);
432 EXPORT_SYMBOL_GPL(usb_serial_generic_read_bulk_callback
);
434 void usb_serial_generic_write_bulk_callback(struct urb
*urb
)
437 struct usb_serial_port
*port
= urb
->context
;
438 int status
= urb
->status
;
441 for (i
= 0; i
< ARRAY_SIZE(port
->write_urbs
); ++i
) {
442 if (port
->write_urbs
[i
] == urb
)
445 spin_lock_irqsave(&port
->lock
, flags
);
446 port
->tx_bytes
-= urb
->transfer_buffer_length
;
447 set_bit(i
, &port
->write_urbs_free
);
448 spin_unlock_irqrestore(&port
->lock
, flags
);
456 dev_dbg(&port
->dev
, "%s - urb stopped: %d\n",
460 dev_err_console(port
, "%s - urb stopped: %d\n",
464 dev_err_console(port
, "%s - nonzero urb status: %d\n",
469 usb_serial_generic_write_start(port
, GFP_ATOMIC
);
470 usb_serial_port_softint(port
);
472 EXPORT_SYMBOL_GPL(usb_serial_generic_write_bulk_callback
);
474 void usb_serial_generic_throttle(struct tty_struct
*tty
)
476 struct usb_serial_port
*port
= tty
->driver_data
;
478 set_bit(USB_SERIAL_THROTTLED
, &port
->flags
);
480 EXPORT_SYMBOL_GPL(usb_serial_generic_throttle
);
482 void usb_serial_generic_unthrottle(struct tty_struct
*tty
)
484 struct usb_serial_port
*port
= tty
->driver_data
;
486 clear_bit(USB_SERIAL_THROTTLED
, &port
->flags
);
489 * Matches the smp_mb__after_atomic() in
490 * usb_serial_generic_read_bulk_callback().
494 usb_serial_generic_submit_read_urbs(port
, GFP_KERNEL
);
496 EXPORT_SYMBOL_GPL(usb_serial_generic_unthrottle
);
498 static bool usb_serial_generic_msr_changed(struct tty_struct
*tty
,
499 unsigned long arg
, struct async_icount
*cprev
)
501 struct usb_serial_port
*port
= tty
->driver_data
;
502 struct async_icount cnow
;
507 * Use tty-port initialised flag to detect all hangups including the
508 * one generated at USB-device disconnect.
510 if (!tty_port_initialized(&port
->port
))
513 spin_lock_irqsave(&port
->lock
, flags
);
514 cnow
= port
->icount
; /* atomic copy*/
515 spin_unlock_irqrestore(&port
->lock
, flags
);
517 ret
= ((arg
& TIOCM_RNG
) && (cnow
.rng
!= cprev
->rng
)) ||
518 ((arg
& TIOCM_DSR
) && (cnow
.dsr
!= cprev
->dsr
)) ||
519 ((arg
& TIOCM_CD
) && (cnow
.dcd
!= cprev
->dcd
)) ||
520 ((arg
& TIOCM_CTS
) && (cnow
.cts
!= cprev
->cts
));
527 int usb_serial_generic_tiocmiwait(struct tty_struct
*tty
, unsigned long arg
)
529 struct usb_serial_port
*port
= tty
->driver_data
;
530 struct async_icount cnow
;
534 spin_lock_irqsave(&port
->lock
, flags
);
535 cnow
= port
->icount
; /* atomic copy */
536 spin_unlock_irqrestore(&port
->lock
, flags
);
538 ret
= wait_event_interruptible(port
->port
.delta_msr_wait
,
539 usb_serial_generic_msr_changed(tty
, arg
, &cnow
));
540 if (!ret
&& !tty_port_initialized(&port
->port
))
545 EXPORT_SYMBOL_GPL(usb_serial_generic_tiocmiwait
);
547 int usb_serial_generic_get_icount(struct tty_struct
*tty
,
548 struct serial_icounter_struct
*icount
)
550 struct usb_serial_port
*port
= tty
->driver_data
;
551 struct async_icount cnow
;
554 spin_lock_irqsave(&port
->lock
, flags
);
555 cnow
= port
->icount
; /* atomic copy */
556 spin_unlock_irqrestore(&port
->lock
, flags
);
558 icount
->cts
= cnow
.cts
;
559 icount
->dsr
= cnow
.dsr
;
560 icount
->rng
= cnow
.rng
;
561 icount
->dcd
= cnow
.dcd
;
562 icount
->tx
= cnow
.tx
;
563 icount
->rx
= cnow
.rx
;
564 icount
->frame
= cnow
.frame
;
565 icount
->parity
= cnow
.parity
;
566 icount
->overrun
= cnow
.overrun
;
567 icount
->brk
= cnow
.brk
;
568 icount
->buf_overrun
= cnow
.buf_overrun
;
572 EXPORT_SYMBOL_GPL(usb_serial_generic_get_icount
);
574 #ifdef CONFIG_MAGIC_SYSRQ
575 int usb_serial_handle_sysrq_char(struct usb_serial_port
*port
, unsigned int ch
)
577 if (port
->sysrq
&& port
->port
.console
) {
578 if (ch
&& time_before(jiffies
, port
->sysrq
)) {
588 int usb_serial_handle_sysrq_char(struct usb_serial_port
*port
, unsigned int ch
)
593 EXPORT_SYMBOL_GPL(usb_serial_handle_sysrq_char
);
595 int usb_serial_handle_break(struct usb_serial_port
*port
)
598 port
->sysrq
= jiffies
+ HZ
*5;
604 EXPORT_SYMBOL_GPL(usb_serial_handle_break
);
607 * usb_serial_handle_dcd_change - handle a change of carrier detect state
608 * @port: usb-serial port
609 * @tty: tty for the port
610 * @status: new carrier detect status, nonzero if active
612 void usb_serial_handle_dcd_change(struct usb_serial_port
*usb_port
,
613 struct tty_struct
*tty
, unsigned int status
)
615 struct tty_port
*port
= &usb_port
->port
;
617 dev_dbg(&usb_port
->dev
, "%s - status %d\n", __func__
, status
);
620 struct tty_ldisc
*ld
= tty_ldisc_ref(tty
);
623 if (ld
->ops
->dcd_change
)
624 ld
->ops
->dcd_change(tty
, status
);
630 wake_up_interruptible(&port
->open_wait
);
631 else if (tty
&& !C_CLOCAL(tty
))
634 EXPORT_SYMBOL_GPL(usb_serial_handle_dcd_change
);
636 int usb_serial_generic_resume(struct usb_serial
*serial
)
638 struct usb_serial_port
*port
;
641 for (i
= 0; i
< serial
->num_ports
; i
++) {
642 port
= serial
->port
[i
];
643 if (!tty_port_initialized(&port
->port
))
646 if (port
->bulk_in_size
) {
647 r
= usb_serial_generic_submit_read_urbs(port
,
653 if (port
->bulk_out_size
) {
654 r
= usb_serial_generic_write_start(port
, GFP_NOIO
);
662 EXPORT_SYMBOL_GPL(usb_serial_generic_resume
);