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/tty.h>
16 #include <linux/tty_flip.h>
17 #include <linux/module.h>
18 #include <linux/moduleparam.h>
19 #include <linux/usb.h>
20 #include <linux/usb/serial.h>
21 #include <asm/uaccess.h>
26 #ifdef CONFIG_USB_SERIAL_GENERIC
28 static int generic_probe(struct usb_interface
*interface
,
29 const struct usb_device_id
*id
);
31 static __u16 vendor
= 0x05f9;
32 static __u16 product
= 0xffff;
34 module_param(vendor
, ushort
, 0);
35 MODULE_PARM_DESC(vendor
, "User specified USB idVendor");
37 module_param(product
, ushort
, 0);
38 MODULE_PARM_DESC(product
, "User specified USB idProduct");
40 static struct usb_device_id generic_device_ids
[2]; /* Initially all zeroes. */
42 /* we want to look at all devices, as the vendor/product id can change
43 * depending on the command line argument */
44 static struct usb_device_id generic_serial_ids
[] = {
49 static struct usb_driver generic_driver
= {
50 .name
= "usbserial_generic",
51 .probe
= generic_probe
,
52 .disconnect
= usb_serial_disconnect
,
53 .id_table
= generic_serial_ids
,
57 /* All of the device info needed for the Generic Serial Converter */
58 struct usb_serial_driver usb_serial_generic_device
= {
63 .id_table
= generic_device_ids
,
64 .usb_driver
= &generic_driver
,
66 .shutdown
= usb_serial_generic_shutdown
,
67 .throttle
= usb_serial_generic_throttle
,
68 .unthrottle
= usb_serial_generic_unthrottle
,
69 .resume
= usb_serial_generic_resume
,
72 static int generic_probe(struct usb_interface
*interface
,
73 const struct usb_device_id
*id
)
75 const struct usb_device_id
*id_pattern
;
77 id_pattern
= usb_match_id(interface
, generic_device_ids
);
78 if (id_pattern
!= NULL
)
79 return usb_serial_probe(interface
, id
);
84 int usb_serial_generic_register (int _debug
)
89 #ifdef CONFIG_USB_SERIAL_GENERIC
90 generic_device_ids
[0].idVendor
= vendor
;
91 generic_device_ids
[0].idProduct
= product
;
92 generic_device_ids
[0].match_flags
= USB_DEVICE_ID_MATCH_VENDOR
| USB_DEVICE_ID_MATCH_PRODUCT
;
94 /* register our generic driver with ourselves */
95 retval
= usb_serial_register (&usb_serial_generic_device
);
98 retval
= usb_register(&generic_driver
);
100 usb_serial_deregister(&usb_serial_generic_device
);
106 void usb_serial_generic_deregister (void)
108 #ifdef CONFIG_USB_SERIAL_GENERIC
109 /* remove our generic driver */
110 usb_deregister(&generic_driver
);
111 usb_serial_deregister (&usb_serial_generic_device
);
115 int usb_serial_generic_open (struct usb_serial_port
*port
, struct file
*filp
)
117 struct usb_serial
*serial
= port
->serial
;
121 dbg("%s - port %d", __FUNCTION__
, port
->number
);
123 /* force low_latency on so that our tty_push actually forces the data through,
124 otherwise it is scheduled, and with high data rates (like with OHCI) data
127 port
->tty
->low_latency
= 1;
129 /* clear the throttle flags */
130 spin_lock_irqsave(&port
->lock
, flags
);
132 port
->throttle_req
= 0;
133 spin_unlock_irqrestore(&port
->lock
, flags
);
135 /* if we have a bulk endpoint, start reading from it */
136 if (serial
->num_bulk_in
) {
137 /* Start reading from the device */
138 usb_fill_bulk_urb (port
->read_urb
, serial
->dev
,
139 usb_rcvbulkpipe(serial
->dev
, port
->bulk_in_endpointAddress
),
140 port
->read_urb
->transfer_buffer
,
141 port
->read_urb
->transfer_buffer_length
,
142 ((serial
->type
->read_bulk_callback
) ?
143 serial
->type
->read_bulk_callback
:
144 usb_serial_generic_read_bulk_callback
),
146 result
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
148 dev_err(&port
->dev
, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__
, result
);
153 EXPORT_SYMBOL_GPL(usb_serial_generic_open
);
155 static void generic_cleanup (struct usb_serial_port
*port
)
157 struct usb_serial
*serial
= port
->serial
;
159 dbg("%s - port %d", __FUNCTION__
, port
->number
);
162 /* shutdown any bulk reads that might be going on */
163 if (serial
->num_bulk_out
)
164 usb_kill_urb(port
->write_urb
);
165 if (serial
->num_bulk_in
)
166 usb_kill_urb(port
->read_urb
);
170 int usb_serial_generic_resume(struct usb_serial
*serial
)
172 struct usb_serial_port
*port
;
177 * If this is an autoresume, don't submit URBs.
178 * They will be submitted in the open function instead.
180 if (serial
->dev
->auto_pm
)
183 for (i
= 0; i
< serial
->num_ports
; i
++) {
184 port
= serial
->port
[i
];
185 if (port
->open_count
&& port
->read_urb
) {
186 r
= usb_submit_urb(port
->read_urb
, GFP_NOIO
);
195 void usb_serial_generic_close (struct usb_serial_port
*port
, struct file
* filp
)
197 dbg("%s - port %d", __FUNCTION__
, port
->number
);
198 generic_cleanup (port
);
201 int usb_serial_generic_write(struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
203 struct usb_serial
*serial
= port
->serial
;
207 dbg("%s - port %d", __FUNCTION__
, port
->number
);
210 dbg("%s - write request of 0 bytes", __FUNCTION__
);
214 /* only do something if we have a bulk out endpoint */
215 if (serial
->num_bulk_out
) {
217 spin_lock_irqsave(&port
->lock
, flags
);
218 if (port
->write_urb_busy
) {
219 spin_unlock_irqrestore(&port
->lock
, flags
);
220 dbg("%s - already writing", __FUNCTION__
);
223 port
->write_urb_busy
= 1;
224 spin_unlock_irqrestore(&port
->lock
, flags
);
226 count
= (count
> port
->bulk_out_size
) ? port
->bulk_out_size
: count
;
228 memcpy (port
->write_urb
->transfer_buffer
, buf
, count
);
229 data
= port
->write_urb
->transfer_buffer
;
230 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, count
, data
);
233 usb_fill_bulk_urb (port
->write_urb
, serial
->dev
,
234 usb_sndbulkpipe (serial
->dev
,
235 port
->bulk_out_endpointAddress
),
236 port
->write_urb
->transfer_buffer
, count
,
237 ((serial
->type
->write_bulk_callback
) ?
238 serial
->type
->write_bulk_callback
:
239 usb_serial_generic_write_bulk_callback
), port
);
241 /* send the data out the bulk port */
242 port
->write_urb_busy
= 1;
243 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
245 dev_err(&port
->dev
, "%s - failed submitting write urb, error %d\n", __FUNCTION__
, result
);
246 /* don't have to grab the lock here, as we will retry if != 0 */
247 port
->write_urb_busy
= 0;
254 /* no bulk out, so return 0 bytes written */
258 int usb_serial_generic_write_room (struct usb_serial_port
*port
)
260 struct usb_serial
*serial
= port
->serial
;
263 dbg("%s - port %d", __FUNCTION__
, port
->number
);
265 if (serial
->num_bulk_out
) {
266 if (!(port
->write_urb_busy
))
267 room
= port
->bulk_out_size
;
270 dbg("%s - returns %d", __FUNCTION__
, room
);
274 int usb_serial_generic_chars_in_buffer (struct usb_serial_port
*port
)
276 struct usb_serial
*serial
= port
->serial
;
279 dbg("%s - port %d", __FUNCTION__
, port
->number
);
281 if (serial
->num_bulk_out
) {
282 if (port
->write_urb_busy
)
283 chars
= port
->write_urb
->transfer_buffer_length
;
286 dbg("%s - returns %d", __FUNCTION__
, chars
);
291 static void resubmit_read_urb(struct usb_serial_port
*port
, gfp_t mem_flags
)
293 struct urb
*urb
= port
->read_urb
;
294 struct usb_serial
*serial
= port
->serial
;
297 /* Continue reading from device */
298 usb_fill_bulk_urb (urb
, serial
->dev
,
299 usb_rcvbulkpipe (serial
->dev
,
300 port
->bulk_in_endpointAddress
),
301 urb
->transfer_buffer
,
302 urb
->transfer_buffer_length
,
303 ((serial
->type
->read_bulk_callback
) ?
304 serial
->type
->read_bulk_callback
:
305 usb_serial_generic_read_bulk_callback
), port
);
306 result
= usb_submit_urb(urb
, mem_flags
);
308 dev_err(&port
->dev
, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__
, result
);
311 /* Push data to tty layer and resubmit the bulk read URB */
312 static void flush_and_resubmit_read_urb (struct usb_serial_port
*port
)
314 struct urb
*urb
= port
->read_urb
;
315 struct tty_struct
*tty
= port
->tty
;
318 /* Push data to tty */
319 if (tty
&& urb
->actual_length
) {
320 room
= tty_buffer_request_room(tty
, urb
->actual_length
);
322 tty_insert_flip_string(tty
, urb
->transfer_buffer
, room
);
323 tty_flip_buffer_push(tty
);
327 resubmit_read_urb(port
, GFP_ATOMIC
);
330 void usb_serial_generic_read_bulk_callback (struct urb
*urb
)
332 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
333 unsigned char *data
= urb
->transfer_buffer
;
334 int status
= urb
->status
;
337 dbg("%s - port %d", __FUNCTION__
, port
->number
);
339 if (unlikely(status
!= 0)) {
340 dbg("%s - nonzero read bulk status received: %d",
341 __FUNCTION__
, status
);
345 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, urb
->actual_length
, data
);
347 /* Throttle the device if requested by tty */
348 spin_lock_irqsave(&port
->lock
, flags
);
349 if (!(port
->throttled
= port
->throttle_req
)) {
350 spin_unlock_irqrestore(&port
->lock
, flags
);
351 flush_and_resubmit_read_urb(port
);
353 spin_unlock_irqrestore(&port
->lock
, flags
);
356 EXPORT_SYMBOL_GPL(usb_serial_generic_read_bulk_callback
);
358 void usb_serial_generic_write_bulk_callback (struct urb
*urb
)
360 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
361 int status
= urb
->status
;
363 dbg("%s - port %d", __FUNCTION__
, port
->number
);
365 port
->write_urb_busy
= 0;
367 dbg("%s - nonzero write bulk status received: %d",
368 __FUNCTION__
, status
);
372 usb_serial_port_softint(port
);
374 EXPORT_SYMBOL_GPL(usb_serial_generic_write_bulk_callback
);
376 void usb_serial_generic_throttle (struct usb_serial_port
*port
)
380 dbg("%s - port %d", __FUNCTION__
, port
->number
);
382 /* Set the throttle request flag. It will be picked up
383 * by usb_serial_generic_read_bulk_callback(). */
384 spin_lock_irqsave(&port
->lock
, flags
);
385 port
->throttle_req
= 1;
386 spin_unlock_irqrestore(&port
->lock
, flags
);
389 void usb_serial_generic_unthrottle (struct usb_serial_port
*port
)
394 dbg("%s - port %d", __FUNCTION__
, port
->number
);
396 /* Clear the throttle flags */
397 spin_lock_irqsave(&port
->lock
, flags
);
398 was_throttled
= port
->throttled
;
399 port
->throttled
= port
->throttle_req
= 0;
400 spin_unlock_irqrestore(&port
->lock
, flags
);
403 /* Resume reading from device */
404 resubmit_read_urb(port
, GFP_KERNEL
);
408 void usb_serial_generic_shutdown (struct usb_serial
*serial
)
412 dbg("%s", __FUNCTION__
);
414 /* stop reads and writes on all ports */
415 for (i
=0; i
< serial
->num_ports
; ++i
) {
416 generic_cleanup(serial
->port
[i
]);