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 <linux/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
=
93 USB_DEVICE_ID_MATCH_VENDOR
| USB_DEVICE_ID_MATCH_PRODUCT
;
95 /* register our generic driver with ourselves */
96 retval
= usb_serial_register(&usb_serial_generic_device
);
99 retval
= usb_register(&generic_driver
);
101 usb_serial_deregister(&usb_serial_generic_device
);
107 void usb_serial_generic_deregister(void)
109 #ifdef CONFIG_USB_SERIAL_GENERIC
110 /* remove our generic driver */
111 usb_deregister(&generic_driver
);
112 usb_serial_deregister(&usb_serial_generic_device
);
116 int usb_serial_generic_open(struct tty_struct
*tty
,
117 struct usb_serial_port
*port
, struct file
*filp
)
119 struct usb_serial
*serial
= port
->serial
;
123 dbg("%s - port %d", __func__
, port
->number
);
125 /* clear the throttle flags */
126 spin_lock_irqsave(&port
->lock
, flags
);
128 port
->throttle_req
= 0;
129 spin_unlock_irqrestore(&port
->lock
, flags
);
131 /* if we have a bulk endpoint, start reading from it */
132 if (serial
->num_bulk_in
) {
133 /* Start reading from the device */
134 usb_fill_bulk_urb(port
->read_urb
, serial
->dev
,
135 usb_rcvbulkpipe(serial
->dev
,
136 port
->bulk_in_endpointAddress
),
137 port
->read_urb
->transfer_buffer
,
138 port
->read_urb
->transfer_buffer_length
,
139 ((serial
->type
->read_bulk_callback
) ?
140 serial
->type
->read_bulk_callback
:
141 usb_serial_generic_read_bulk_callback
),
143 result
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
146 "%s - failed resubmitting read urb, error %d\n",
152 EXPORT_SYMBOL_GPL(usb_serial_generic_open
);
154 static void generic_cleanup(struct usb_serial_port
*port
)
156 struct usb_serial
*serial
= port
->serial
;
158 dbg("%s - port %d", __func__
, port
->number
);
161 /* shutdown any bulk reads that might be going on */
162 if (serial
->num_bulk_out
)
163 usb_kill_urb(port
->write_urb
);
164 if (serial
->num_bulk_in
)
165 usb_kill_urb(port
->read_urb
);
169 int usb_serial_generic_resume(struct usb_serial
*serial
)
171 struct usb_serial_port
*port
;
174 for (i
= 0; i
< serial
->num_ports
; i
++) {
175 port
= serial
->port
[i
];
176 if (port
->port
.count
&& port
->read_urb
) {
177 r
= usb_submit_urb(port
->read_urb
, GFP_NOIO
);
185 EXPORT_SYMBOL_GPL(usb_serial_generic_resume
);
187 void usb_serial_generic_close(struct usb_serial_port
*port
)
189 dbg("%s - port %d", __func__
, port
->number
);
190 generic_cleanup(port
);
193 int usb_serial_generic_write(struct tty_struct
*tty
,
194 struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
196 struct usb_serial
*serial
= port
->serial
;
200 dbg("%s - port %d", __func__
, port
->number
);
203 dbg("%s - write request of 0 bytes", __func__
);
207 /* only do something if we have a bulk out endpoint */
208 if (serial
->num_bulk_out
) {
210 spin_lock_irqsave(&port
->lock
, flags
);
211 if (port
->write_urb_busy
) {
212 spin_unlock_irqrestore(&port
->lock
, flags
);
213 dbg("%s - already writing", __func__
);
216 port
->write_urb_busy
= 1;
217 spin_unlock_irqrestore(&port
->lock
, flags
);
219 count
= (count
> port
->bulk_out_size
) ?
220 port
->bulk_out_size
: count
;
222 memcpy(port
->write_urb
->transfer_buffer
, buf
, count
);
223 data
= port
->write_urb
->transfer_buffer
;
224 usb_serial_debug_data(debug
, &port
->dev
, __func__
, count
, data
);
227 usb_fill_bulk_urb(port
->write_urb
, serial
->dev
,
228 usb_sndbulkpipe(serial
->dev
,
229 port
->bulk_out_endpointAddress
),
230 port
->write_urb
->transfer_buffer
, count
,
231 ((serial
->type
->write_bulk_callback
) ?
232 serial
->type
->write_bulk_callback
:
233 usb_serial_generic_write_bulk_callback
),
236 /* send the data out the bulk port */
237 port
->write_urb_busy
= 1;
238 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
241 "%s - failed submitting write urb, error %d\n",
243 /* don't have to grab the lock here, as we will
245 port
->write_urb_busy
= 0;
252 /* no bulk out, so return 0 bytes written */
256 int usb_serial_generic_write_room(struct tty_struct
*tty
)
258 struct usb_serial_port
*port
= tty
->driver_data
;
259 struct usb_serial
*serial
= port
->serial
;
262 dbg("%s - port %d", __func__
, 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", __func__
, room
);
274 int usb_serial_generic_chars_in_buffer(struct tty_struct
*tty
)
276 struct usb_serial_port
*port
= tty
->driver_data
;
277 struct usb_serial
*serial
= port
->serial
;
280 dbg("%s - port %d", __func__
, port
->number
);
283 if (serial
->num_bulk_out
) {
284 if (port
->write_urb_busy
)
285 chars
= port
->write_urb
->transfer_buffer_length
;
288 dbg("%s - returns %d", __func__
, chars
);
293 static void resubmit_read_urb(struct usb_serial_port
*port
, gfp_t mem_flags
)
295 struct urb
*urb
= port
->read_urb
;
296 struct usb_serial
*serial
= port
->serial
;
299 /* Continue reading from device */
300 usb_fill_bulk_urb(urb
, serial
->dev
,
301 usb_rcvbulkpipe(serial
->dev
,
302 port
->bulk_in_endpointAddress
),
303 urb
->transfer_buffer
,
304 urb
->transfer_buffer_length
,
305 ((serial
->type
->read_bulk_callback
) ?
306 serial
->type
->read_bulk_callback
:
307 usb_serial_generic_read_bulk_callback
), port
);
308 result
= usb_submit_urb(urb
, mem_flags
);
311 "%s - failed resubmitting read urb, error %d\n",
315 /* Push data to tty layer and resubmit the bulk read URB */
316 static void flush_and_resubmit_read_urb(struct usb_serial_port
*port
)
318 struct urb
*urb
= port
->read_urb
;
319 struct tty_struct
*tty
= tty_port_tty_get(&port
->port
);
322 /* Push data to tty */
323 if (tty
&& urb
->actual_length
) {
324 room
= tty_buffer_request_room(tty
, urb
->actual_length
);
326 tty_insert_flip_string(tty
, urb
->transfer_buffer
, room
);
327 tty_flip_buffer_push(tty
);
332 resubmit_read_urb(port
, GFP_ATOMIC
);
335 void usb_serial_generic_read_bulk_callback(struct urb
*urb
)
337 struct usb_serial_port
*port
= urb
->context
;
338 unsigned char *data
= urb
->transfer_buffer
;
339 int status
= urb
->status
;
342 dbg("%s - port %d", __func__
, port
->number
);
344 if (unlikely(status
!= 0)) {
345 dbg("%s - nonzero read bulk status received: %d",
350 usb_serial_debug_data(debug
, &port
->dev
, __func__
,
351 urb
->actual_length
, data
);
353 /* Throttle the device if requested by tty */
354 spin_lock_irqsave(&port
->lock
, flags
);
355 port
->throttled
= port
->throttle_req
;
356 if (!port
->throttled
) {
357 spin_unlock_irqrestore(&port
->lock
, flags
);
358 flush_and_resubmit_read_urb(port
);
360 spin_unlock_irqrestore(&port
->lock
, flags
);
362 EXPORT_SYMBOL_GPL(usb_serial_generic_read_bulk_callback
);
364 void usb_serial_generic_write_bulk_callback(struct urb
*urb
)
366 struct usb_serial_port
*port
= urb
->context
;
367 int status
= urb
->status
;
369 dbg("%s - port %d", __func__
, port
->number
);
371 port
->write_urb_busy
= 0;
373 dbg("%s - nonzero write bulk status received: %d",
377 usb_serial_port_softint(port
);
379 EXPORT_SYMBOL_GPL(usb_serial_generic_write_bulk_callback
);
381 void usb_serial_generic_throttle(struct tty_struct
*tty
)
383 struct usb_serial_port
*port
= tty
->driver_data
;
386 dbg("%s - port %d", __func__
, port
->number
);
388 /* Set the throttle request flag. It will be picked up
389 * by usb_serial_generic_read_bulk_callback(). */
390 spin_lock_irqsave(&port
->lock
, flags
);
391 port
->throttle_req
= 1;
392 spin_unlock_irqrestore(&port
->lock
, flags
);
395 void usb_serial_generic_unthrottle(struct tty_struct
*tty
)
397 struct usb_serial_port
*port
= tty
->driver_data
;
401 dbg("%s - port %d", __func__
, port
->number
);
403 /* Clear the throttle flags */
404 spin_lock_irqsave(&port
->lock
, flags
);
405 was_throttled
= port
->throttled
;
406 port
->throttled
= port
->throttle_req
= 0;
407 spin_unlock_irqrestore(&port
->lock
, flags
);
410 /* Resume reading from device */
411 resubmit_read_urb(port
, GFP_KERNEL
);
415 void usb_serial_generic_shutdown(struct usb_serial
*serial
)
421 /* stop reads and writes on all ports */
422 for (i
= 0; i
< serial
->num_ports
; ++i
)
423 generic_cleanup(serial
->port
[i
]);