2 * USB Serial Converter Generic functions
4 * Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License version
8 * 2 as published by the Free Software Foundation.
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>
28 #ifdef CONFIG_USB_SERIAL_GENERIC
30 static int generic_probe(struct usb_interface
*interface
,
31 const struct usb_device_id
*id
);
33 static __u16 vendor
= 0x05f9;
34 static __u16 product
= 0xffff;
36 module_param(vendor
, ushort
, 0);
37 MODULE_PARM_DESC(vendor
, "User specified USB idVendor");
39 module_param(product
, ushort
, 0);
40 MODULE_PARM_DESC(product
, "User specified USB idProduct");
42 static struct usb_device_id generic_device_ids
[2]; /* Initially all zeroes. */
44 /* we want to look at all devices, as the vendor/product id can change
45 * depending on the command line argument */
46 static const struct usb_device_id generic_serial_ids
[] = {
51 static struct usb_driver generic_driver
= {
52 .name
= "usbserial_generic",
53 .probe
= generic_probe
,
54 .disconnect
= usb_serial_disconnect
,
55 .id_table
= generic_serial_ids
,
59 /* All of the device info needed for the Generic Serial Converter */
60 struct usb_serial_driver usb_serial_generic_device
= {
65 .id_table
= generic_device_ids
,
66 .usb_driver
= &generic_driver
,
68 .disconnect
= usb_serial_generic_disconnect
,
69 .release
= usb_serial_generic_release
,
70 .throttle
= usb_serial_generic_throttle
,
71 .unthrottle
= usb_serial_generic_unthrottle
,
72 .resume
= usb_serial_generic_resume
,
75 static int generic_probe(struct usb_interface
*interface
,
76 const struct usb_device_id
*id
)
78 const struct usb_device_id
*id_pattern
;
80 id_pattern
= usb_match_id(interface
, generic_device_ids
);
81 if (id_pattern
!= NULL
)
82 return usb_serial_probe(interface
, id
);
87 int usb_serial_generic_register(int _debug
)
92 #ifdef CONFIG_USB_SERIAL_GENERIC
93 generic_device_ids
[0].idVendor
= vendor
;
94 generic_device_ids
[0].idProduct
= product
;
95 generic_device_ids
[0].match_flags
=
96 USB_DEVICE_ID_MATCH_VENDOR
| USB_DEVICE_ID_MATCH_PRODUCT
;
98 /* register our generic driver with ourselves */
99 retval
= usb_serial_register(&usb_serial_generic_device
);
102 retval
= usb_register(&generic_driver
);
104 usb_serial_deregister(&usb_serial_generic_device
);
110 void usb_serial_generic_deregister(void)
112 #ifdef CONFIG_USB_SERIAL_GENERIC
113 /* remove our generic driver */
114 usb_deregister(&generic_driver
);
115 usb_serial_deregister(&usb_serial_generic_device
);
119 int usb_serial_generic_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
124 dbg("%s - port %d", __func__
, port
->number
);
126 /* clear the throttle flags */
127 spin_lock_irqsave(&port
->lock
, flags
);
129 port
->throttle_req
= 0;
130 spin_unlock_irqrestore(&port
->lock
, flags
);
132 /* if we have a bulk endpoint, start reading from it */
133 if (port
->bulk_in_size
)
134 result
= usb_serial_generic_submit_read_urb(port
, GFP_KERNEL
);
138 EXPORT_SYMBOL_GPL(usb_serial_generic_open
);
140 static void generic_cleanup(struct usb_serial_port
*port
)
142 struct usb_serial
*serial
= port
->serial
;
145 dbg("%s - port %d", __func__
, port
->number
);
148 /* shutdown any bulk transfers that might be going on */
149 if (port
->bulk_out_size
) {
150 usb_kill_urb(port
->write_urb
);
152 spin_lock_irqsave(&port
->lock
, flags
);
153 kfifo_reset_out(&port
->write_fifo
);
154 spin_unlock_irqrestore(&port
->lock
, flags
);
156 if (port
->bulk_in_size
)
157 usb_kill_urb(port
->read_urb
);
161 void usb_serial_generic_close(struct usb_serial_port
*port
)
163 dbg("%s - port %d", __func__
, port
->number
);
164 generic_cleanup(port
);
166 EXPORT_SYMBOL_GPL(usb_serial_generic_close
);
168 static int usb_serial_multi_urb_write(struct tty_struct
*tty
,
169 struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
173 unsigned char *buffer
;
178 dbg("%s - port %d", __func__
, port
->number
);
181 dbg("%s - write request of 0 bytes", __func__
);
184 towrite
= (count
> port
->bulk_out_size
) ?
185 port
->bulk_out_size
: count
;
186 spin_lock_irqsave(&port
->lock
, flags
);
187 if (port
->urbs_in_flight
>
188 port
->serial
->type
->max_in_flight_urbs
) {
189 spin_unlock_irqrestore(&port
->lock
, flags
);
190 dbg("%s - write limit hit", __func__
);
193 port
->tx_bytes_flight
+= towrite
;
194 port
->urbs_in_flight
++;
195 spin_unlock_irqrestore(&port
->lock
, flags
);
197 buffer
= kmalloc(towrite
, GFP_ATOMIC
);
200 "%s ran out of kernel memory for urb ...\n", __func__
);
201 goto error_no_buffer
;
204 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
206 dev_err(&port
->dev
, "%s - no more free urbs\n",
212 memcpy(buffer
, buf
+ bwrite
, towrite
);
213 usb_serial_debug_data(debug
, &port
->dev
, __func__
,
215 /* fill the buffer and send it */
216 usb_fill_bulk_urb(urb
, port
->serial
->dev
,
217 usb_sndbulkpipe(port
->serial
->dev
,
218 port
->bulk_out_endpointAddress
),
220 usb_serial_generic_write_bulk_callback
, port
);
222 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
224 dev_err(&port
->dev
, "%s - error submitting urb: %d\n",
229 /* This urb is the responsibility of the host driver now */
231 dbg("%s write: %d", __func__
, towrite
);
242 spin_lock_irqsave(&port
->lock
, flags
);
243 port
->urbs_in_flight
--;
244 port
->tx_bytes_flight
-= towrite
;
245 spin_unlock_irqrestore(&port
->lock
, flags
);
250 * usb_serial_generic_write_start - kick off an URB write
251 * @port: Pointer to the &struct usb_serial_port data
253 * Returns the number of bytes queued on success. This will be zero if there
254 * was nothing to send. Otherwise, it returns a negative errno value
256 static int usb_serial_generic_write_start(struct usb_serial_port
*port
)
264 /* Atomically determine whether we can and need to start a USB
266 spin_lock_irqsave(&port
->lock
, flags
);
267 if (port
->write_urb_busy
)
270 start_io
= (kfifo_len(&port
->write_fifo
) != 0);
271 port
->write_urb_busy
= start_io
;
273 spin_unlock_irqrestore(&port
->lock
, flags
);
278 data
= port
->write_urb
->transfer_buffer
;
279 count
= kfifo_out_locked(&port
->write_fifo
, data
, port
->bulk_out_size
, &port
->lock
);
280 usb_serial_debug_data(debug
, &port
->dev
, __func__
, count
, data
);
282 port
->write_urb
->transfer_buffer_length
= count
;
284 /* send the data out the bulk port */
285 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
287 dev_err(&port
->dev
, "%s - error submitting urb: %d\n",
289 /* don't have to grab the lock here, as we will
291 port
->write_urb_busy
= 0;
295 spin_lock_irqsave(&port
->lock
, flags
);
296 port
->tx_bytes_flight
+= count
;
297 spin_unlock_irqrestore(&port
->lock
, flags
);
303 * usb_serial_generic_write - generic write function for serial USB devices
304 * @tty: Pointer to &struct tty_struct for the device
305 * @port: Pointer to the &usb_serial_port structure for the device
306 * @buf: Pointer to the data to write
307 * @count: Number of bytes to write
309 * Returns the number of characters actually written, which may be anything
310 * from zero to @count. If an error occurs, it returns the negative errno
313 int usb_serial_generic_write(struct tty_struct
*tty
,
314 struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
316 struct usb_serial
*serial
= port
->serial
;
319 dbg("%s - port %d", __func__
, port
->number
);
321 /* only do something if we have a bulk out endpoint */
322 if (!port
->bulk_out_size
)
328 if (serial
->type
->max_in_flight_urbs
)
329 return usb_serial_multi_urb_write(tty
, port
,
332 count
= kfifo_in_locked(&port
->write_fifo
, buf
, count
, &port
->lock
);
333 result
= usb_serial_generic_write_start(port
);
340 EXPORT_SYMBOL_GPL(usb_serial_generic_write
);
342 int usb_serial_generic_write_room(struct tty_struct
*tty
)
344 struct usb_serial_port
*port
= tty
->driver_data
;
345 struct usb_serial
*serial
= port
->serial
;
349 dbg("%s - port %d", __func__
, port
->number
);
351 if (!port
->bulk_out_size
)
354 spin_lock_irqsave(&port
->lock
, flags
);
355 if (serial
->type
->max_in_flight_urbs
) {
356 if (port
->urbs_in_flight
< serial
->type
->max_in_flight_urbs
)
357 room
= port
->bulk_out_size
*
358 (serial
->type
->max_in_flight_urbs
-
359 port
->urbs_in_flight
);
361 room
= kfifo_avail(&port
->write_fifo
);
363 spin_unlock_irqrestore(&port
->lock
, flags
);
365 dbg("%s - returns %d", __func__
, room
);
369 int usb_serial_generic_chars_in_buffer(struct tty_struct
*tty
)
371 struct usb_serial_port
*port
= tty
->driver_data
;
372 struct usb_serial
*serial
= port
->serial
;
376 dbg("%s - port %d", __func__
, port
->number
);
378 if (!port
->bulk_out_size
)
381 spin_lock_irqsave(&port
->lock
, flags
);
382 if (serial
->type
->max_in_flight_urbs
)
383 chars
= port
->tx_bytes_flight
;
385 chars
= kfifo_len(&port
->write_fifo
) + port
->tx_bytes_flight
;
386 spin_unlock_irqrestore(&port
->lock
, flags
);
388 dbg("%s - returns %d", __func__
, chars
);
392 int usb_serial_generic_submit_read_urb(struct usb_serial_port
*port
,
397 result
= usb_submit_urb(port
->read_urb
, mem_flags
);
398 if (result
&& result
!= -EPERM
) {
399 dev_err(&port
->dev
, "%s - error submitting urb: %d\n",
404 EXPORT_SYMBOL_GPL(usb_serial_generic_submit_read_urb
);
406 void usb_serial_generic_process_read_urb(struct urb
*urb
)
408 struct usb_serial_port
*port
= urb
->context
;
409 struct tty_struct
*tty
;
410 char *ch
= (char *)urb
->transfer_buffer
;
413 tty
= tty_port_tty_get(&port
->port
);
417 /* The per character mucking around with sysrq path it too slow for
418 stuff like 3G modems, so shortcircuit it in the 99.9999999% of cases
419 where the USB serial is not a console anyway */
420 if (!port
->port
.console
|| !port
->sysrq
)
421 tty_insert_flip_string(tty
, ch
, urb
->actual_length
);
423 for (i
= 0; i
< urb
->actual_length
; i
++, ch
++) {
424 if (!usb_serial_handle_sysrq_char(tty
, port
, *ch
))
425 tty_insert_flip_char(tty
, *ch
, TTY_NORMAL
);
428 tty_flip_buffer_push(tty
);
431 EXPORT_SYMBOL_GPL(usb_serial_generic_process_read_urb
);
433 void usb_serial_generic_read_bulk_callback(struct urb
*urb
)
435 struct usb_serial_port
*port
= urb
->context
;
436 unsigned char *data
= urb
->transfer_buffer
;
437 int status
= urb
->status
;
440 dbg("%s - port %d", __func__
, port
->number
);
442 if (unlikely(status
!= 0)) {
443 dbg("%s - nonzero read bulk status received: %d",
448 usb_serial_debug_data(debug
, &port
->dev
, __func__
,
449 urb
->actual_length
, data
);
450 port
->serial
->type
->process_read_urb(urb
);
452 /* Throttle the device if requested by tty */
453 spin_lock_irqsave(&port
->lock
, flags
);
454 port
->throttled
= port
->throttle_req
;
455 if (!port
->throttled
) {
456 spin_unlock_irqrestore(&port
->lock
, flags
);
457 usb_serial_generic_submit_read_urb(port
, GFP_ATOMIC
);
459 spin_unlock_irqrestore(&port
->lock
, flags
);
461 EXPORT_SYMBOL_GPL(usb_serial_generic_read_bulk_callback
);
463 void usb_serial_generic_write_bulk_callback(struct urb
*urb
)
466 struct usb_serial_port
*port
= urb
->context
;
467 int status
= urb
->status
;
469 dbg("%s - port %d", __func__
, port
->number
);
471 if (port
->serial
->type
->max_in_flight_urbs
) {
472 kfree(urb
->transfer_buffer
);
474 spin_lock_irqsave(&port
->lock
, flags
);
475 --port
->urbs_in_flight
;
476 port
->tx_bytes_flight
-= urb
->transfer_buffer_length
;
477 if (port
->urbs_in_flight
< 0)
478 port
->urbs_in_flight
= 0;
479 spin_unlock_irqrestore(&port
->lock
, flags
);
481 spin_lock_irqsave(&port
->lock
, flags
);
482 port
->tx_bytes_flight
-= urb
->transfer_buffer_length
;
483 port
->write_urb_busy
= 0;
484 spin_unlock_irqrestore(&port
->lock
, flags
);
487 spin_lock_irqsave(&port
->lock
, flags
);
488 kfifo_reset_out(&port
->write_fifo
);
489 spin_unlock_irqrestore(&port
->lock
, flags
);
491 usb_serial_generic_write_start(port
);
496 dbg("%s - non-zero urb status: %d", __func__
, status
);
498 usb_serial_port_softint(port
);
500 EXPORT_SYMBOL_GPL(usb_serial_generic_write_bulk_callback
);
502 void usb_serial_generic_throttle(struct tty_struct
*tty
)
504 struct usb_serial_port
*port
= tty
->driver_data
;
507 dbg("%s - port %d", __func__
, port
->number
);
509 /* Set the throttle request flag. It will be picked up
510 * by usb_serial_generic_read_bulk_callback(). */
511 spin_lock_irqsave(&port
->lock
, flags
);
512 port
->throttle_req
= 1;
513 spin_unlock_irqrestore(&port
->lock
, flags
);
515 EXPORT_SYMBOL_GPL(usb_serial_generic_throttle
);
517 void usb_serial_generic_unthrottle(struct tty_struct
*tty
)
519 struct usb_serial_port
*port
= tty
->driver_data
;
522 dbg("%s - port %d", __func__
, port
->number
);
524 /* Clear the throttle flags */
525 spin_lock_irq(&port
->lock
);
526 was_throttled
= port
->throttled
;
527 port
->throttled
= port
->throttle_req
= 0;
528 spin_unlock_irq(&port
->lock
);
531 usb_serial_generic_submit_read_urb(port
, GFP_KERNEL
);
533 EXPORT_SYMBOL_GPL(usb_serial_generic_unthrottle
);
535 #ifdef CONFIG_MAGIC_SYSRQ
536 int usb_serial_handle_sysrq_char(struct tty_struct
*tty
,
537 struct usb_serial_port
*port
, unsigned int ch
)
539 if (port
->sysrq
&& port
->port
.console
) {
540 if (ch
&& time_before(jiffies
, port
->sysrq
)) {
541 handle_sysrq(ch
, tty
);
550 int usb_serial_handle_sysrq_char(struct tty_struct
*tty
,
551 struct usb_serial_port
*port
, unsigned int ch
)
556 EXPORT_SYMBOL_GPL(usb_serial_handle_sysrq_char
);
558 int usb_serial_handle_break(struct usb_serial_port
*port
)
561 port
->sysrq
= jiffies
+ HZ
*5;
567 EXPORT_SYMBOL_GPL(usb_serial_handle_break
);
569 int usb_serial_generic_resume(struct usb_serial
*serial
)
571 struct usb_serial_port
*port
;
574 for (i
= 0; i
< serial
->num_ports
; i
++) {
575 port
= serial
->port
[i
];
576 if (!test_bit(ASYNCB_INITIALIZED
, &port
->port
.flags
))
579 if (port
->read_urb
) {
580 r
= usb_submit_urb(port
->read_urb
, GFP_NOIO
);
585 if (port
->write_urb
) {
586 r
= usb_serial_generic_write_start(port
);
594 EXPORT_SYMBOL_GPL(usb_serial_generic_resume
);
596 void usb_serial_generic_disconnect(struct usb_serial
*serial
)
602 /* stop reads and writes on all ports */
603 for (i
= 0; i
< serial
->num_ports
; ++i
)
604 generic_cleanup(serial
->port
[i
]);
607 void usb_serial_generic_release(struct usb_serial
*serial
)