Loading...
1/*
2 * USB Serial Converter Generic functions
3 *
4 * Copyright (C) 2010 - 2013 Johan Hovold (jhovold@gmail.com)
5 * Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com)
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License version
9 * 2 as published by the Free Software Foundation.
10 */
11
12#include <linux/kernel.h>
13#include <linux/errno.h>
14#include <linux/slab.h>
15#include <linux/sysrq.h>
16#include <linux/tty.h>
17#include <linux/tty_flip.h>
18#include <linux/module.h>
19#include <linux/moduleparam.h>
20#include <linux/usb.h>
21#include <linux/usb/serial.h>
22#include <linux/uaccess.h>
23#include <linux/kfifo.h>
24#include <linux/serial.h>
25
26#ifdef CONFIG_USB_SERIAL_GENERIC
27
28static __u16 vendor = 0x05f9;
29static __u16 product = 0xffff;
30
31module_param(vendor, ushort, 0);
32MODULE_PARM_DESC(vendor, "User specified USB idVendor");
33
34module_param(product, ushort, 0);
35MODULE_PARM_DESC(product, "User specified USB idProduct");
36
37static struct usb_device_id generic_device_ids[2]; /* Initially all zeroes. */
38
39struct usb_serial_driver usb_serial_generic_device = {
40 .driver = {
41 .owner = THIS_MODULE,
42 .name = "generic",
43 },
44 .id_table = generic_device_ids,
45 .num_ports = 1,
46 .throttle = usb_serial_generic_throttle,
47 .unthrottle = usb_serial_generic_unthrottle,
48 .resume = usb_serial_generic_resume,
49};
50
51static struct usb_serial_driver * const serial_drivers[] = {
52 &usb_serial_generic_device, NULL
53};
54
55#endif
56
57int usb_serial_generic_register(void)
58{
59 int retval = 0;
60
61#ifdef CONFIG_USB_SERIAL_GENERIC
62 generic_device_ids[0].idVendor = vendor;
63 generic_device_ids[0].idProduct = product;
64 generic_device_ids[0].match_flags =
65 USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT;
66
67 retval = usb_serial_register_drivers(serial_drivers,
68 "usbserial_generic", generic_device_ids);
69#endif
70 return retval;
71}
72
73void usb_serial_generic_deregister(void)
74{
75#ifdef CONFIG_USB_SERIAL_GENERIC
76 usb_serial_deregister_drivers(serial_drivers);
77#endif
78}
79
80int usb_serial_generic_open(struct tty_struct *tty, struct usb_serial_port *port)
81{
82 int result = 0;
83 unsigned long flags;
84
85 spin_lock_irqsave(&port->lock, flags);
86 port->throttled = 0;
87 port->throttle_req = 0;
88 spin_unlock_irqrestore(&port->lock, flags);
89
90 if (port->bulk_in_size)
91 result = usb_serial_generic_submit_read_urbs(port, GFP_KERNEL);
92
93 return result;
94}
95EXPORT_SYMBOL_GPL(usb_serial_generic_open);
96
97void usb_serial_generic_close(struct usb_serial_port *port)
98{
99 unsigned long flags;
100 int i;
101
102 if (port->bulk_out_size) {
103 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
104 usb_kill_urb(port->write_urbs[i]);
105
106 spin_lock_irqsave(&port->lock, flags);
107 kfifo_reset_out(&port->write_fifo);
108 spin_unlock_irqrestore(&port->lock, flags);
109 }
110 if (port->bulk_in_size) {
111 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i)
112 usb_kill_urb(port->read_urbs[i]);
113 }
114}
115EXPORT_SYMBOL_GPL(usb_serial_generic_close);
116
117int usb_serial_generic_prepare_write_buffer(struct usb_serial_port *port,
118 void *dest, size_t size)
119{
120 return kfifo_out_locked(&port->write_fifo, dest, size, &port->lock);
121}
122
123/**
124 * usb_serial_generic_write_start - start writing buffered data
125 * @port: usb-serial port
126 * @mem_flags: flags to use for memory allocations
127 *
128 * Serialised using USB_SERIAL_WRITE_BUSY flag.
129 *
130 * Return: Zero on success or if busy, otherwise a negative errno value.
131 */
132int usb_serial_generic_write_start(struct usb_serial_port *port,
133 gfp_t mem_flags)
134{
135 struct urb *urb;
136 int count, result;
137 unsigned long flags;
138 int i;
139
140 if (test_and_set_bit_lock(USB_SERIAL_WRITE_BUSY, &port->flags))
141 return 0;
142retry:
143 spin_lock_irqsave(&port->lock, flags);
144 if (!port->write_urbs_free || !kfifo_len(&port->write_fifo)) {
145 clear_bit_unlock(USB_SERIAL_WRITE_BUSY, &port->flags);
146 spin_unlock_irqrestore(&port->lock, flags);
147 return 0;
148 }
149 i = (int)find_first_bit(&port->write_urbs_free,
150 ARRAY_SIZE(port->write_urbs));
151 spin_unlock_irqrestore(&port->lock, flags);
152
153 urb = port->write_urbs[i];
154 count = port->serial->type->prepare_write_buffer(port,
155 urb->transfer_buffer,
156 port->bulk_out_size);
157 urb->transfer_buffer_length = count;
158 usb_serial_debug_data(&port->dev, __func__, count, urb->transfer_buffer);
159 spin_lock_irqsave(&port->lock, flags);
160 port->tx_bytes += count;
161 spin_unlock_irqrestore(&port->lock, flags);
162
163 clear_bit(i, &port->write_urbs_free);
164 result = usb_submit_urb(urb, mem_flags);
165 if (result) {
166 dev_err_console(port, "%s - error submitting urb: %d\n",
167 __func__, result);
168 set_bit(i, &port->write_urbs_free);
169 spin_lock_irqsave(&port->lock, flags);
170 port->tx_bytes -= count;
171 spin_unlock_irqrestore(&port->lock, flags);
172
173 clear_bit_unlock(USB_SERIAL_WRITE_BUSY, &port->flags);
174 return result;
175 }
176
177 goto retry; /* try sending off another urb */
178}
179EXPORT_SYMBOL_GPL(usb_serial_generic_write_start);
180
181/**
182 * usb_serial_generic_write - generic write function
183 * @tty: tty for the port
184 * @port: usb-serial port
185 * @buf: data to write
186 * @count: number of bytes to write
187 *
188 * Return: The number of characters buffered, which may be anything from
189 * zero to @count, or a negative errno value.
190 */
191int usb_serial_generic_write(struct tty_struct *tty,
192 struct usb_serial_port *port, const unsigned char *buf, int count)
193{
194 int result;
195
196 if (!port->bulk_out_size)
197 return -ENODEV;
198
199 if (!count)
200 return 0;
201
202 count = kfifo_in_locked(&port->write_fifo, buf, count, &port->lock);
203 result = usb_serial_generic_write_start(port, GFP_ATOMIC);
204 if (result)
205 return result;
206
207 return count;
208}
209EXPORT_SYMBOL_GPL(usb_serial_generic_write);
210
211int usb_serial_generic_write_room(struct tty_struct *tty)
212{
213 struct usb_serial_port *port = tty->driver_data;
214 unsigned long flags;
215 int room;
216
217 if (!port->bulk_out_size)
218 return 0;
219
220 spin_lock_irqsave(&port->lock, flags);
221 room = kfifo_avail(&port->write_fifo);
222 spin_unlock_irqrestore(&port->lock, flags);
223
224 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
225 return room;
226}
227
228int usb_serial_generic_chars_in_buffer(struct tty_struct *tty)
229{
230 struct usb_serial_port *port = tty->driver_data;
231 unsigned long flags;
232 int chars;
233
234 if (!port->bulk_out_size)
235 return 0;
236
237 spin_lock_irqsave(&port->lock, flags);
238 chars = kfifo_len(&port->write_fifo) + port->tx_bytes;
239 spin_unlock_irqrestore(&port->lock, flags);
240
241 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
242 return chars;
243}
244EXPORT_SYMBOL_GPL(usb_serial_generic_chars_in_buffer);
245
246void usb_serial_generic_wait_until_sent(struct tty_struct *tty, long timeout)
247{
248 struct usb_serial_port *port = tty->driver_data;
249 unsigned int bps;
250 unsigned long period;
251 unsigned long expire;
252
253 bps = tty_get_baud_rate(tty);
254 if (!bps)
255 bps = 9600; /* B0 */
256 /*
257 * Use a poll-period of roughly the time it takes to send one
258 * character or at least one jiffy.
259 */
260 period = max_t(unsigned long, (10 * HZ / bps), 1);
261 if (timeout)
262 period = min_t(unsigned long, period, timeout);
263
264 dev_dbg(&port->dev, "%s - timeout = %u ms, period = %u ms\n",
265 __func__, jiffies_to_msecs(timeout),
266 jiffies_to_msecs(period));
267 expire = jiffies + timeout;
268 while (!port->serial->type->tx_empty(port)) {
269 schedule_timeout_interruptible(period);
270 if (signal_pending(current))
271 break;
272 if (timeout && time_after(jiffies, expire))
273 break;
274 }
275}
276EXPORT_SYMBOL_GPL(usb_serial_generic_wait_until_sent);
277
278static int usb_serial_generic_submit_read_urb(struct usb_serial_port *port,
279 int index, gfp_t mem_flags)
280{
281 int res;
282
283 if (!test_and_clear_bit(index, &port->read_urbs_free))
284 return 0;
285
286 dev_dbg(&port->dev, "%s - urb %d\n", __func__, index);
287
288 res = usb_submit_urb(port->read_urbs[index], mem_flags);
289 if (res) {
290 if (res != -EPERM && res != -ENODEV) {
291 dev_err(&port->dev,
292 "%s - usb_submit_urb failed: %d\n",
293 __func__, res);
294 }
295 set_bit(index, &port->read_urbs_free);
296 return res;
297 }
298
299 return 0;
300}
301
302int usb_serial_generic_submit_read_urbs(struct usb_serial_port *port,
303 gfp_t mem_flags)
304{
305 int res;
306 int i;
307
308 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i) {
309 res = usb_serial_generic_submit_read_urb(port, i, mem_flags);
310 if (res)
311 goto err;
312 }
313
314 return 0;
315err:
316 for (; i >= 0; --i)
317 usb_kill_urb(port->read_urbs[i]);
318
319 return res;
320}
321EXPORT_SYMBOL_GPL(usb_serial_generic_submit_read_urbs);
322
323void usb_serial_generic_process_read_urb(struct urb *urb)
324{
325 struct usb_serial_port *port = urb->context;
326 char *ch = (char *)urb->transfer_buffer;
327 int i;
328
329 if (!urb->actual_length)
330 return;
331 /*
332 * The per character mucking around with sysrq path it too slow for
333 * stuff like 3G modems, so shortcircuit it in the 99.9999999% of
334 * cases where the USB serial is not a console anyway.
335 */
336 if (!port->port.console || !port->sysrq) {
337 tty_insert_flip_string(&port->port, ch, urb->actual_length);
338 } else {
339 for (i = 0; i < urb->actual_length; i++, ch++) {
340 if (!usb_serial_handle_sysrq_char(port, *ch))
341 tty_insert_flip_char(&port->port, *ch, TTY_NORMAL);
342 }
343 }
344 tty_flip_buffer_push(&port->port);
345}
346EXPORT_SYMBOL_GPL(usb_serial_generic_process_read_urb);
347
348void usb_serial_generic_read_bulk_callback(struct urb *urb)
349{
350 struct usb_serial_port *port = urb->context;
351 unsigned char *data = urb->transfer_buffer;
352 unsigned long flags;
353 int i;
354
355 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i) {
356 if (urb == port->read_urbs[i])
357 break;
358 }
359 set_bit(i, &port->read_urbs_free);
360
361 dev_dbg(&port->dev, "%s - urb %d, len %d\n", __func__, i,
362 urb->actual_length);
363 switch (urb->status) {
364 case 0:
365 break;
366 case -ENOENT:
367 case -ECONNRESET:
368 case -ESHUTDOWN:
369 dev_dbg(&port->dev, "%s - urb stopped: %d\n",
370 __func__, urb->status);
371 return;
372 case -EPIPE:
373 dev_err(&port->dev, "%s - urb stopped: %d\n",
374 __func__, urb->status);
375 return;
376 default:
377 dev_dbg(&port->dev, "%s - nonzero urb status: %d\n",
378 __func__, urb->status);
379 goto resubmit;
380 }
381
382 usb_serial_debug_data(&port->dev, __func__, urb->actual_length, data);
383 port->serial->type->process_read_urb(urb);
384
385resubmit:
386 /* Throttle the device if requested by tty */
387 spin_lock_irqsave(&port->lock, flags);
388 port->throttled = port->throttle_req;
389 if (!port->throttled) {
390 spin_unlock_irqrestore(&port->lock, flags);
391 usb_serial_generic_submit_read_urb(port, i, GFP_ATOMIC);
392 } else {
393 spin_unlock_irqrestore(&port->lock, flags);
394 }
395}
396EXPORT_SYMBOL_GPL(usb_serial_generic_read_bulk_callback);
397
398void usb_serial_generic_write_bulk_callback(struct urb *urb)
399{
400 unsigned long flags;
401 struct usb_serial_port *port = urb->context;
402 int i;
403
404 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i) {
405 if (port->write_urbs[i] == urb)
406 break;
407 }
408 spin_lock_irqsave(&port->lock, flags);
409 port->tx_bytes -= urb->transfer_buffer_length;
410 set_bit(i, &port->write_urbs_free);
411 spin_unlock_irqrestore(&port->lock, flags);
412
413 switch (urb->status) {
414 case 0:
415 break;
416 case -ENOENT:
417 case -ECONNRESET:
418 case -ESHUTDOWN:
419 dev_dbg(&port->dev, "%s - urb stopped: %d\n",
420 __func__, urb->status);
421 return;
422 case -EPIPE:
423 dev_err_console(port, "%s - urb stopped: %d\n",
424 __func__, urb->status);
425 return;
426 default:
427 dev_err_console(port, "%s - nonzero urb status: %d\n",
428 __func__, urb->status);
429 goto resubmit;
430 }
431
432resubmit:
433 usb_serial_generic_write_start(port, GFP_ATOMIC);
434 usb_serial_port_softint(port);
435}
436EXPORT_SYMBOL_GPL(usb_serial_generic_write_bulk_callback);
437
438void usb_serial_generic_throttle(struct tty_struct *tty)
439{
440 struct usb_serial_port *port = tty->driver_data;
441 unsigned long flags;
442
443 spin_lock_irqsave(&port->lock, flags);
444 port->throttle_req = 1;
445 spin_unlock_irqrestore(&port->lock, flags);
446}
447EXPORT_SYMBOL_GPL(usb_serial_generic_throttle);
448
449void usb_serial_generic_unthrottle(struct tty_struct *tty)
450{
451 struct usb_serial_port *port = tty->driver_data;
452 int was_throttled;
453
454 spin_lock_irq(&port->lock);
455 was_throttled = port->throttled;
456 port->throttled = port->throttle_req = 0;
457 spin_unlock_irq(&port->lock);
458
459 if (was_throttled)
460 usb_serial_generic_submit_read_urbs(port, GFP_KERNEL);
461}
462EXPORT_SYMBOL_GPL(usb_serial_generic_unthrottle);
463
464static bool usb_serial_generic_msr_changed(struct tty_struct *tty,
465 unsigned long arg, struct async_icount *cprev)
466{
467 struct usb_serial_port *port = tty->driver_data;
468 struct async_icount cnow;
469 unsigned long flags;
470 bool ret;
471
472 /*
473 * Use tty-port initialised flag to detect all hangups including the
474 * one generated at USB-device disconnect.
475 */
476 if (!test_bit(ASYNCB_INITIALIZED, &port->port.flags))
477 return true;
478
479 spin_lock_irqsave(&port->lock, flags);
480 cnow = port->icount; /* atomic copy*/
481 spin_unlock_irqrestore(&port->lock, flags);
482
483 ret = ((arg & TIOCM_RNG) && (cnow.rng != cprev->rng)) ||
484 ((arg & TIOCM_DSR) && (cnow.dsr != cprev->dsr)) ||
485 ((arg & TIOCM_CD) && (cnow.dcd != cprev->dcd)) ||
486 ((arg & TIOCM_CTS) && (cnow.cts != cprev->cts));
487
488 *cprev = cnow;
489
490 return ret;
491}
492
493int usb_serial_generic_tiocmiwait(struct tty_struct *tty, unsigned long arg)
494{
495 struct usb_serial_port *port = tty->driver_data;
496 struct async_icount cnow;
497 unsigned long flags;
498 int ret;
499
500 spin_lock_irqsave(&port->lock, flags);
501 cnow = port->icount; /* atomic copy */
502 spin_unlock_irqrestore(&port->lock, flags);
503
504 ret = wait_event_interruptible(port->port.delta_msr_wait,
505 usb_serial_generic_msr_changed(tty, arg, &cnow));
506 if (!ret && !test_bit(ASYNCB_INITIALIZED, &port->port.flags))
507 ret = -EIO;
508
509 return ret;
510}
511EXPORT_SYMBOL_GPL(usb_serial_generic_tiocmiwait);
512
513int usb_serial_generic_get_icount(struct tty_struct *tty,
514 struct serial_icounter_struct *icount)
515{
516 struct usb_serial_port *port = tty->driver_data;
517 struct async_icount cnow;
518 unsigned long flags;
519
520 spin_lock_irqsave(&port->lock, flags);
521 cnow = port->icount; /* atomic copy */
522 spin_unlock_irqrestore(&port->lock, flags);
523
524 icount->cts = cnow.cts;
525 icount->dsr = cnow.dsr;
526 icount->rng = cnow.rng;
527 icount->dcd = cnow.dcd;
528 icount->tx = cnow.tx;
529 icount->rx = cnow.rx;
530 icount->frame = cnow.frame;
531 icount->parity = cnow.parity;
532 icount->overrun = cnow.overrun;
533 icount->brk = cnow.brk;
534 icount->buf_overrun = cnow.buf_overrun;
535
536 return 0;
537}
538EXPORT_SYMBOL_GPL(usb_serial_generic_get_icount);
539
540#ifdef CONFIG_MAGIC_SYSRQ
541int usb_serial_handle_sysrq_char(struct usb_serial_port *port, unsigned int ch)
542{
543 if (port->sysrq && port->port.console) {
544 if (ch && time_before(jiffies, port->sysrq)) {
545 handle_sysrq(ch);
546 port->sysrq = 0;
547 return 1;
548 }
549 port->sysrq = 0;
550 }
551 return 0;
552}
553#else
554int usb_serial_handle_sysrq_char(struct usb_serial_port *port, unsigned int ch)
555{
556 return 0;
557}
558#endif
559EXPORT_SYMBOL_GPL(usb_serial_handle_sysrq_char);
560
561int usb_serial_handle_break(struct usb_serial_port *port)
562{
563 if (!port->sysrq) {
564 port->sysrq = jiffies + HZ*5;
565 return 1;
566 }
567 port->sysrq = 0;
568 return 0;
569}
570EXPORT_SYMBOL_GPL(usb_serial_handle_break);
571
572/**
573 * usb_serial_handle_dcd_change - handle a change of carrier detect state
574 * @port: usb-serial port
575 * @tty: tty for the port
576 * @status: new carrier detect status, nonzero if active
577 */
578void usb_serial_handle_dcd_change(struct usb_serial_port *usb_port,
579 struct tty_struct *tty, unsigned int status)
580{
581 struct tty_port *port = &usb_port->port;
582
583 dev_dbg(&usb_port->dev, "%s - status %d\n", __func__, status);
584
585 if (tty) {
586 struct tty_ldisc *ld = tty_ldisc_ref(tty);
587
588 if (ld) {
589 if (ld->ops->dcd_change)
590 ld->ops->dcd_change(tty, status);
591 tty_ldisc_deref(ld);
592 }
593 }
594
595 if (status)
596 wake_up_interruptible(&port->open_wait);
597 else if (tty && !C_CLOCAL(tty))
598 tty_hangup(tty);
599}
600EXPORT_SYMBOL_GPL(usb_serial_handle_dcd_change);
601
602int usb_serial_generic_resume(struct usb_serial *serial)
603{
604 struct usb_serial_port *port;
605 int i, c = 0, r;
606
607 for (i = 0; i < serial->num_ports; i++) {
608 port = serial->port[i];
609 if (!test_bit(ASYNCB_INITIALIZED, &port->port.flags))
610 continue;
611
612 if (port->bulk_in_size) {
613 r = usb_serial_generic_submit_read_urbs(port,
614 GFP_NOIO);
615 if (r < 0)
616 c++;
617 }
618
619 if (port->bulk_out_size) {
620 r = usb_serial_generic_write_start(port, GFP_NOIO);
621 if (r < 0)
622 c++;
623 }
624 }
625
626 return c ? -EIO : 0;
627}
628EXPORT_SYMBOL_GPL(usb_serial_generic_resume);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * USB Serial Converter Generic functions
4 *
5 * Copyright (C) 2010 - 2013 Johan Hovold (jhovold@gmail.com)
6 * Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com)
7 */
8
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>
23
24#ifdef CONFIG_USB_SERIAL_GENERIC
25
26static __u16 vendor = 0x05f9;
27static __u16 product = 0xffff;
28
29module_param(vendor, ushort, 0);
30MODULE_PARM_DESC(vendor, "User specified USB idVendor");
31
32module_param(product, ushort, 0);
33MODULE_PARM_DESC(product, "User specified USB idProduct");
34
35static struct usb_device_id generic_device_ids[2]; /* Initially all zeroes. */
36
37static int usb_serial_generic_probe(struct usb_serial *serial,
38 const struct usb_device_id *id)
39{
40 struct device *dev = &serial->interface->dev;
41
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");
44
45 return 0;
46}
47
48static int usb_serial_generic_calc_num_ports(struct usb_serial *serial,
49 struct usb_serial_endpoints *epds)
50{
51 struct device *dev = &serial->interface->dev;
52 int num_ports;
53
54 num_ports = max(epds->num_bulk_in, epds->num_bulk_out);
55
56 if (num_ports == 0) {
57 dev_err(dev, "device has no bulk endpoints\n");
58 return -ENODEV;
59 }
60
61 return num_ports;
62}
63
64static struct usb_serial_driver usb_serial_generic_device = {
65 .driver = {
66 .name = "generic",
67 },
68 .id_table = generic_device_ids,
69 .probe = usb_serial_generic_probe,
70 .calc_num_ports = usb_serial_generic_calc_num_ports,
71 .throttle = usb_serial_generic_throttle,
72 .unthrottle = usb_serial_generic_unthrottle,
73 .resume = usb_serial_generic_resume,
74};
75
76static struct usb_serial_driver * const serial_drivers[] = {
77 &usb_serial_generic_device, NULL
78};
79
80#endif
81
82int usb_serial_generic_register(void)
83{
84 int retval = 0;
85
86#ifdef CONFIG_USB_SERIAL_GENERIC
87 generic_device_ids[0].idVendor = vendor;
88 generic_device_ids[0].idProduct = product;
89 generic_device_ids[0].match_flags =
90 USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT;
91
92 retval = usb_serial_register_drivers(serial_drivers,
93 "usbserial_generic", generic_device_ids);
94#endif
95 return retval;
96}
97
98void usb_serial_generic_deregister(void)
99{
100#ifdef CONFIG_USB_SERIAL_GENERIC
101 usb_serial_deregister_drivers(serial_drivers);
102#endif
103}
104
105int usb_serial_generic_open(struct tty_struct *tty, struct usb_serial_port *port)
106{
107 int result = 0;
108
109 clear_bit(USB_SERIAL_THROTTLED, &port->flags);
110
111 if (port->bulk_in_size)
112 result = usb_serial_generic_submit_read_urbs(port, GFP_KERNEL);
113
114 return result;
115}
116EXPORT_SYMBOL_GPL(usb_serial_generic_open);
117
118void usb_serial_generic_close(struct usb_serial_port *port)
119{
120 unsigned long flags;
121 int i;
122
123 if (port->bulk_out_size) {
124 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
125 usb_kill_urb(port->write_urbs[i]);
126
127 spin_lock_irqsave(&port->lock, flags);
128 kfifo_reset_out(&port->write_fifo);
129 spin_unlock_irqrestore(&port->lock, flags);
130 }
131 if (port->bulk_in_size) {
132 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i)
133 usb_kill_urb(port->read_urbs[i]);
134 }
135}
136EXPORT_SYMBOL_GPL(usb_serial_generic_close);
137
138int usb_serial_generic_prepare_write_buffer(struct usb_serial_port *port,
139 void *dest, size_t size)
140{
141 return kfifo_out_locked(&port->write_fifo, dest, size, &port->lock);
142}
143
144/**
145 * usb_serial_generic_write_start - start writing buffered data
146 * @port: usb-serial port
147 * @mem_flags: flags to use for memory allocations
148 *
149 * Serialised using USB_SERIAL_WRITE_BUSY flag.
150 *
151 * Return: Zero on success or if busy, otherwise a negative errno value.
152 */
153int usb_serial_generic_write_start(struct usb_serial_port *port,
154 gfp_t mem_flags)
155{
156 struct urb *urb;
157 int count, result;
158 unsigned long flags;
159 int i;
160
161 if (test_and_set_bit_lock(USB_SERIAL_WRITE_BUSY, &port->flags))
162 return 0;
163retry:
164 spin_lock_irqsave(&port->lock, flags);
165 if (!port->write_urbs_free || !kfifo_len(&port->write_fifo)) {
166 clear_bit_unlock(USB_SERIAL_WRITE_BUSY, &port->flags);
167 spin_unlock_irqrestore(&port->lock, flags);
168 return 0;
169 }
170 i = (int)find_first_bit(&port->write_urbs_free,
171 ARRAY_SIZE(port->write_urbs));
172 spin_unlock_irqrestore(&port->lock, flags);
173
174 urb = port->write_urbs[i];
175 count = port->serial->type->prepare_write_buffer(port,
176 urb->transfer_buffer,
177 port->bulk_out_size);
178 urb->transfer_buffer_length = count;
179 usb_serial_debug_data(&port->dev, __func__, count, urb->transfer_buffer);
180 spin_lock_irqsave(&port->lock, flags);
181 port->tx_bytes += count;
182 spin_unlock_irqrestore(&port->lock, flags);
183
184 clear_bit(i, &port->write_urbs_free);
185 result = usb_submit_urb(urb, mem_flags);
186 if (result) {
187 dev_err_console(port, "%s - error submitting urb: %d\n",
188 __func__, result);
189 set_bit(i, &port->write_urbs_free);
190 spin_lock_irqsave(&port->lock, flags);
191 port->tx_bytes -= count;
192 spin_unlock_irqrestore(&port->lock, flags);
193
194 clear_bit_unlock(USB_SERIAL_WRITE_BUSY, &port->flags);
195 return result;
196 }
197
198 goto retry; /* try sending off another urb */
199}
200EXPORT_SYMBOL_GPL(usb_serial_generic_write_start);
201
202/**
203 * usb_serial_generic_write - generic write function
204 * @tty: tty for the port
205 * @port: usb-serial port
206 * @buf: data to write
207 * @count: number of bytes to write
208 *
209 * Return: The number of characters buffered, which may be anything from
210 * zero to @count, or a negative errno value.
211 */
212int usb_serial_generic_write(struct tty_struct *tty,
213 struct usb_serial_port *port, const unsigned char *buf, int count)
214{
215 int result;
216
217 if (!port->bulk_out_size)
218 return -ENODEV;
219
220 if (!count)
221 return 0;
222
223 count = kfifo_in_locked(&port->write_fifo, buf, count, &port->lock);
224 result = usb_serial_generic_write_start(port, GFP_ATOMIC);
225 if (result)
226 return result;
227
228 return count;
229}
230EXPORT_SYMBOL_GPL(usb_serial_generic_write);
231
232unsigned int usb_serial_generic_write_room(struct tty_struct *tty)
233{
234 struct usb_serial_port *port = tty->driver_data;
235 unsigned long flags;
236 unsigned int room;
237
238 if (!port->bulk_out_size)
239 return 0;
240
241 spin_lock_irqsave(&port->lock, flags);
242 room = kfifo_avail(&port->write_fifo);
243 spin_unlock_irqrestore(&port->lock, flags);
244
245 dev_dbg(&port->dev, "%s - returns %u\n", __func__, room);
246 return room;
247}
248
249unsigned int usb_serial_generic_chars_in_buffer(struct tty_struct *tty)
250{
251 struct usb_serial_port *port = tty->driver_data;
252 unsigned long flags;
253 unsigned int chars;
254
255 if (!port->bulk_out_size)
256 return 0;
257
258 spin_lock_irqsave(&port->lock, flags);
259 chars = kfifo_len(&port->write_fifo) + port->tx_bytes;
260 spin_unlock_irqrestore(&port->lock, flags);
261
262 dev_dbg(&port->dev, "%s - returns %u\n", __func__, chars);
263 return chars;
264}
265EXPORT_SYMBOL_GPL(usb_serial_generic_chars_in_buffer);
266
267void usb_serial_generic_wait_until_sent(struct tty_struct *tty, long timeout)
268{
269 struct usb_serial_port *port = tty->driver_data;
270 unsigned int bps;
271 unsigned long period;
272 unsigned long expire;
273
274 bps = tty_get_baud_rate(tty);
275 if (!bps)
276 bps = 9600; /* B0 */
277 /*
278 * Use a poll-period of roughly the time it takes to send one
279 * character or at least one jiffy.
280 */
281 period = max_t(unsigned long, (10 * HZ / bps), 1);
282 if (timeout)
283 period = min_t(unsigned long, period, timeout);
284
285 dev_dbg(&port->dev, "%s - timeout = %u ms, period = %u ms\n",
286 __func__, jiffies_to_msecs(timeout),
287 jiffies_to_msecs(period));
288 expire = jiffies + timeout;
289 while (!port->serial->type->tx_empty(port)) {
290 schedule_timeout_interruptible(period);
291 if (signal_pending(current))
292 break;
293 if (timeout && time_after(jiffies, expire))
294 break;
295 }
296}
297EXPORT_SYMBOL_GPL(usb_serial_generic_wait_until_sent);
298
299static int usb_serial_generic_submit_read_urb(struct usb_serial_port *port,
300 int index, gfp_t mem_flags)
301{
302 int res;
303
304 if (!test_and_clear_bit(index, &port->read_urbs_free))
305 return 0;
306
307 dev_dbg(&port->dev, "%s - urb %d\n", __func__, index);
308
309 res = usb_submit_urb(port->read_urbs[index], mem_flags);
310 if (res) {
311 if (res != -EPERM && res != -ENODEV) {
312 dev_err(&port->dev,
313 "%s - usb_submit_urb failed: %d\n",
314 __func__, res);
315 }
316 set_bit(index, &port->read_urbs_free);
317 return res;
318 }
319
320 return 0;
321}
322
323int usb_serial_generic_submit_read_urbs(struct usb_serial_port *port,
324 gfp_t mem_flags)
325{
326 int res;
327 int i;
328
329 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i) {
330 res = usb_serial_generic_submit_read_urb(port, i, mem_flags);
331 if (res)
332 goto err;
333 }
334
335 return 0;
336err:
337 for (; i >= 0; --i)
338 usb_kill_urb(port->read_urbs[i]);
339
340 return res;
341}
342EXPORT_SYMBOL_GPL(usb_serial_generic_submit_read_urbs);
343
344void usb_serial_generic_process_read_urb(struct urb *urb)
345{
346 struct usb_serial_port *port = urb->context;
347 char *ch = urb->transfer_buffer;
348 int i;
349
350 if (!urb->actual_length)
351 return;
352 /*
353 * The per character mucking around with sysrq path it too slow for
354 * stuff like 3G modems, so shortcircuit it in the 99.9999999% of
355 * cases where the USB serial is not a console anyway.
356 */
357 if (port->sysrq) {
358 for (i = 0; i < urb->actual_length; i++, ch++) {
359 if (!usb_serial_handle_sysrq_char(port, *ch))
360 tty_insert_flip_char(&port->port, *ch, TTY_NORMAL);
361 }
362 } else {
363 tty_insert_flip_string(&port->port, ch, urb->actual_length);
364 }
365 tty_flip_buffer_push(&port->port);
366}
367EXPORT_SYMBOL_GPL(usb_serial_generic_process_read_urb);
368
369void usb_serial_generic_read_bulk_callback(struct urb *urb)
370{
371 struct usb_serial_port *port = urb->context;
372 unsigned char *data = urb->transfer_buffer;
373 bool stopped = false;
374 int status = urb->status;
375 int i;
376
377 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i) {
378 if (urb == port->read_urbs[i])
379 break;
380 }
381
382 dev_dbg(&port->dev, "%s - urb %d, len %d\n", __func__, i,
383 urb->actual_length);
384 switch (status) {
385 case 0:
386 usb_serial_debug_data(&port->dev, __func__, urb->actual_length,
387 data);
388 port->serial->type->process_read_urb(urb);
389 break;
390 case -ENOENT:
391 case -ECONNRESET:
392 case -ESHUTDOWN:
393 dev_dbg(&port->dev, "%s - urb stopped: %d\n",
394 __func__, status);
395 stopped = true;
396 break;
397 case -EPIPE:
398 dev_err(&port->dev, "%s - urb stopped: %d\n",
399 __func__, status);
400 stopped = true;
401 break;
402 default:
403 dev_dbg(&port->dev, "%s - nonzero urb status: %d\n",
404 __func__, status);
405 break;
406 }
407
408 /*
409 * Make sure URB processing is done before marking as free to avoid
410 * racing with unthrottle() on another CPU. Matches the barriers
411 * implied by the test_and_clear_bit() in
412 * usb_serial_generic_submit_read_urb().
413 */
414 smp_mb__before_atomic();
415 set_bit(i, &port->read_urbs_free);
416 /*
417 * Make sure URB is marked as free before checking the throttled flag
418 * to avoid racing with unthrottle() on another CPU. Matches the
419 * smp_mb__after_atomic() in unthrottle().
420 */
421 smp_mb__after_atomic();
422
423 if (stopped)
424 return;
425
426 if (test_bit(USB_SERIAL_THROTTLED, &port->flags))
427 return;
428
429 usb_serial_generic_submit_read_urb(port, i, GFP_ATOMIC);
430}
431EXPORT_SYMBOL_GPL(usb_serial_generic_read_bulk_callback);
432
433void usb_serial_generic_write_bulk_callback(struct urb *urb)
434{
435 unsigned long flags;
436 struct usb_serial_port *port = urb->context;
437 int status = urb->status;
438 int i;
439
440 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i) {
441 if (port->write_urbs[i] == urb)
442 break;
443 }
444 spin_lock_irqsave(&port->lock, flags);
445 port->tx_bytes -= urb->transfer_buffer_length;
446 set_bit(i, &port->write_urbs_free);
447 spin_unlock_irqrestore(&port->lock, flags);
448
449 switch (status) {
450 case 0:
451 break;
452 case -ENOENT:
453 case -ECONNRESET:
454 case -ESHUTDOWN:
455 dev_dbg(&port->dev, "%s - urb stopped: %d\n",
456 __func__, status);
457 return;
458 case -EPIPE:
459 dev_err_console(port, "%s - urb stopped: %d\n",
460 __func__, status);
461 return;
462 default:
463 dev_err_console(port, "%s - nonzero urb status: %d\n",
464 __func__, status);
465 break;
466 }
467
468 usb_serial_generic_write_start(port, GFP_ATOMIC);
469 usb_serial_port_softint(port);
470}
471EXPORT_SYMBOL_GPL(usb_serial_generic_write_bulk_callback);
472
473void usb_serial_generic_throttle(struct tty_struct *tty)
474{
475 struct usb_serial_port *port = tty->driver_data;
476
477 set_bit(USB_SERIAL_THROTTLED, &port->flags);
478}
479EXPORT_SYMBOL_GPL(usb_serial_generic_throttle);
480
481void usb_serial_generic_unthrottle(struct tty_struct *tty)
482{
483 struct usb_serial_port *port = tty->driver_data;
484
485 clear_bit(USB_SERIAL_THROTTLED, &port->flags);
486
487 /*
488 * Matches the smp_mb__after_atomic() in
489 * usb_serial_generic_read_bulk_callback().
490 */
491 smp_mb__after_atomic();
492
493 usb_serial_generic_submit_read_urbs(port, GFP_KERNEL);
494}
495EXPORT_SYMBOL_GPL(usb_serial_generic_unthrottle);
496
497static bool usb_serial_generic_msr_changed(struct tty_struct *tty,
498 unsigned long arg, struct async_icount *cprev)
499{
500 struct usb_serial_port *port = tty->driver_data;
501 struct async_icount cnow;
502 unsigned long flags;
503 bool ret;
504
505 /*
506 * Use tty-port initialised flag to detect all hangups including the
507 * one generated at USB-device disconnect.
508 */
509 if (!tty_port_initialized(&port->port))
510 return true;
511
512 spin_lock_irqsave(&port->lock, flags);
513 cnow = port->icount; /* atomic copy*/
514 spin_unlock_irqrestore(&port->lock, flags);
515
516 ret = ((arg & TIOCM_RNG) && (cnow.rng != cprev->rng)) ||
517 ((arg & TIOCM_DSR) && (cnow.dsr != cprev->dsr)) ||
518 ((arg & TIOCM_CD) && (cnow.dcd != cprev->dcd)) ||
519 ((arg & TIOCM_CTS) && (cnow.cts != cprev->cts));
520
521 *cprev = cnow;
522
523 return ret;
524}
525
526int usb_serial_generic_tiocmiwait(struct tty_struct *tty, unsigned long arg)
527{
528 struct usb_serial_port *port = tty->driver_data;
529 struct async_icount cnow;
530 unsigned long flags;
531 int ret;
532
533 spin_lock_irqsave(&port->lock, flags);
534 cnow = port->icount; /* atomic copy */
535 spin_unlock_irqrestore(&port->lock, flags);
536
537 ret = wait_event_interruptible(port->port.delta_msr_wait,
538 usb_serial_generic_msr_changed(tty, arg, &cnow));
539 if (!ret && !tty_port_initialized(&port->port))
540 ret = -EIO;
541
542 return ret;
543}
544EXPORT_SYMBOL_GPL(usb_serial_generic_tiocmiwait);
545
546int usb_serial_generic_get_icount(struct tty_struct *tty,
547 struct serial_icounter_struct *icount)
548{
549 struct usb_serial_port *port = tty->driver_data;
550 struct async_icount cnow;
551 unsigned long flags;
552
553 spin_lock_irqsave(&port->lock, flags);
554 cnow = port->icount; /* atomic copy */
555 spin_unlock_irqrestore(&port->lock, flags);
556
557 icount->cts = cnow.cts;
558 icount->dsr = cnow.dsr;
559 icount->rng = cnow.rng;
560 icount->dcd = cnow.dcd;
561 icount->tx = cnow.tx;
562 icount->rx = cnow.rx;
563 icount->frame = cnow.frame;
564 icount->parity = cnow.parity;
565 icount->overrun = cnow.overrun;
566 icount->brk = cnow.brk;
567 icount->buf_overrun = cnow.buf_overrun;
568
569 return 0;
570}
571EXPORT_SYMBOL_GPL(usb_serial_generic_get_icount);
572
573#if defined(CONFIG_USB_SERIAL_CONSOLE) && defined(CONFIG_MAGIC_SYSRQ)
574int usb_serial_handle_sysrq_char(struct usb_serial_port *port, unsigned int ch)
575{
576 if (port->sysrq) {
577 if (ch && time_before(jiffies, port->sysrq)) {
578 handle_sysrq(ch);
579 port->sysrq = 0;
580 return 1;
581 }
582 port->sysrq = 0;
583 }
584 return 0;
585}
586EXPORT_SYMBOL_GPL(usb_serial_handle_sysrq_char);
587
588int usb_serial_handle_break(struct usb_serial_port *port)
589{
590 if (!port->port.console)
591 return 0;
592
593 if (!port->sysrq) {
594 port->sysrq = jiffies + HZ*5;
595 return 1;
596 }
597 port->sysrq = 0;
598 return 0;
599}
600EXPORT_SYMBOL_GPL(usb_serial_handle_break);
601#endif
602
603/**
604 * usb_serial_handle_dcd_change - handle a change of carrier detect state
605 * @port: usb-serial port
606 * @tty: tty for the port
607 * @status: new carrier detect status, nonzero if active
608 */
609void usb_serial_handle_dcd_change(struct usb_serial_port *port,
610 struct tty_struct *tty, unsigned int status)
611{
612 dev_dbg(&port->dev, "%s - status %d\n", __func__, status);
613
614 if (tty) {
615 struct tty_ldisc *ld = tty_ldisc_ref(tty);
616
617 if (ld) {
618 if (ld->ops->dcd_change)
619 ld->ops->dcd_change(tty, status);
620 tty_ldisc_deref(ld);
621 }
622 }
623
624 if (status)
625 wake_up_interruptible(&port->port.open_wait);
626 else if (tty && !C_CLOCAL(tty))
627 tty_hangup(tty);
628}
629EXPORT_SYMBOL_GPL(usb_serial_handle_dcd_change);
630
631int usb_serial_generic_resume(struct usb_serial *serial)
632{
633 struct usb_serial_port *port;
634 int i, c = 0, r;
635
636 for (i = 0; i < serial->num_ports; i++) {
637 port = serial->port[i];
638 if (!tty_port_initialized(&port->port))
639 continue;
640
641 if (port->bulk_in_size) {
642 r = usb_serial_generic_submit_read_urbs(port,
643 GFP_NOIO);
644 if (r < 0)
645 c++;
646 }
647
648 if (port->bulk_out_size) {
649 r = usb_serial_generic_write_start(port, GFP_NOIO);
650 if (r < 0)
651 c++;
652 }
653 }
654
655 return c ? -EIO : 0;
656}
657EXPORT_SYMBOL_GPL(usb_serial_generic_resume);