2 * USB Serial Converter driver
4 * Copyright (C) 1999 - 2005 Greg Kroah-Hartman (greg@kroah.com)
5 * Copyright (C) 2000 Peter Berger (pberger@brimson.com)
6 * Copyright (C) 2000 Al Borchers (borchers@steinerpoint.com)
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version
10 * 2 as published by the Free Software Foundation.
12 * This driver was originally based on the ACM driver by Armin Fuerst (which was
13 * based on a driver by Brad Keryan)
15 * See Documentation/usb/usb-serial.txt for more information on using this
20 #include <linux/kernel.h>
21 #include <linux/errno.h>
22 #include <linux/init.h>
23 #include <linux/slab.h>
24 #include <linux/tty.h>
25 #include <linux/tty_driver.h>
26 #include <linux/tty_flip.h>
27 #include <linux/module.h>
28 #include <linux/moduleparam.h>
29 #include <linux/seq_file.h>
30 #include <linux/spinlock.h>
31 #include <linux/mutex.h>
32 #include <linux/list.h>
33 #include <linux/uaccess.h>
34 #include <linux/serial.h>
35 #include <linux/usb.h>
36 #include <linux/usb/serial.h>
37 #include <linux/kfifo.h>
43 #define DRIVER_AUTHOR "Greg Kroah-Hartman, greg@kroah.com, http://www.kroah.com/linux/"
44 #define DRIVER_DESC "USB Serial Driver core"
46 /* Driver structure we register with the USB core */
47 static struct usb_driver usb_serial_driver
= {
49 .probe
= usb_serial_probe
,
50 .disconnect
= usb_serial_disconnect
,
51 .suspend
= usb_serial_suspend
,
52 .resume
= usb_serial_resume
,
54 .supports_autosuspend
= 1,
57 /* There is no MODULE_DEVICE_TABLE for usbserial.c. Instead
58 the MODULE_DEVICE_TABLE declarations in each serial driver
59 cause the "hotplug" program to pull in whatever module is necessary
60 via modprobe, and modprobe will load usbserial because the serial
65 /* initially all NULL */
66 static struct usb_serial
*serial_table
[SERIAL_TTY_MINORS
];
67 static DEFINE_MUTEX(table_lock
);
68 static LIST_HEAD(usb_serial_driver_list
);
71 * Look up the serial structure. If it is found and it hasn't been
72 * disconnected, return with its disc_mutex held and its refcount
73 * incremented. Otherwise return NULL.
75 struct usb_serial
*usb_serial_get_by_index(unsigned index
)
77 struct usb_serial
*serial
;
79 mutex_lock(&table_lock
);
80 serial
= serial_table
[index
];
83 mutex_lock(&serial
->disc_mutex
);
84 if (serial
->disconnected
) {
85 mutex_unlock(&serial
->disc_mutex
);
88 kref_get(&serial
->kref
);
91 mutex_unlock(&table_lock
);
95 static struct usb_serial
*get_free_serial(struct usb_serial
*serial
,
96 int num_ports
, unsigned int *minor
)
101 dbg("%s %d", __func__
, num_ports
);
104 mutex_lock(&table_lock
);
105 for (i
= 0; i
< SERIAL_TTY_MINORS
; ++i
) {
110 for (j
= 1; j
<= num_ports
-1; ++j
)
111 if ((i
+j
>= SERIAL_TTY_MINORS
) || (serial_table
[i
+j
])) {
121 dbg("%s - minor base = %d", __func__
, *minor
);
122 for (i
= *minor
; (i
< (*minor
+ num_ports
)) && (i
< SERIAL_TTY_MINORS
); ++i
) {
123 serial_table
[i
] = serial
;
124 serial
->port
[j
++]->number
= i
;
126 mutex_unlock(&table_lock
);
129 mutex_unlock(&table_lock
);
133 static void return_serial(struct usb_serial
*serial
)
139 mutex_lock(&table_lock
);
140 for (i
= 0; i
< serial
->num_ports
; ++i
)
141 serial_table
[serial
->minor
+ i
] = NULL
;
142 mutex_unlock(&table_lock
);
145 static void destroy_serial(struct kref
*kref
)
147 struct usb_serial
*serial
;
148 struct usb_serial_port
*port
;
151 serial
= to_usb_serial(kref
);
153 dbg("%s - %s", __func__
, serial
->type
->description
);
155 /* return the minor range that this device had */
156 if (serial
->minor
!= SERIAL_TTY_NO_MINOR
)
157 return_serial(serial
);
159 if (serial
->attached
)
160 serial
->type
->release(serial
);
162 /* Now that nothing is using the ports, they can be freed */
163 for (i
= 0; i
< serial
->num_port_pointers
; ++i
) {
164 port
= serial
->port
[i
];
167 put_device(&port
->dev
);
171 usb_put_dev(serial
->dev
);
175 void usb_serial_put(struct usb_serial
*serial
)
177 kref_put(&serial
->kref
, destroy_serial
);
180 /*****************************************************************************
181 * Driver tty interface functions
182 *****************************************************************************/
185 * serial_install - install tty
186 * @driver: the driver (USB in our case)
187 * @tty: the tty being created
189 * Create the termios objects for this tty. We use the default
190 * USB serial settings but permit them to be overridden by
191 * serial->type->init_termios.
193 * This is the first place a new tty gets used. Hence this is where we
194 * acquire references to the usb_serial structure and the driver module,
195 * where we store a pointer to the port, and where we do an autoresume.
196 * All these actions are reversed in serial_cleanup().
198 static int serial_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
200 int idx
= tty
->index
;
201 struct usb_serial
*serial
;
202 struct usb_serial_port
*port
;
203 int retval
= -ENODEV
;
207 serial
= usb_serial_get_by_index(idx
);
211 port
= serial
->port
[idx
- serial
->minor
];
214 if (!try_module_get(serial
->type
->driver
.owner
))
215 goto error_module_get
;
217 retval
= usb_autopm_get_interface(serial
->interface
);
219 goto error_get_interface
;
221 retval
= tty_standard_install(driver
, tty
);
223 goto error_init_termios
;
225 mutex_unlock(&serial
->disc_mutex
);
227 /* allow the driver to update the settings */
228 if (serial
->type
->init_termios
)
229 serial
->type
->init_termios(tty
);
231 tty
->driver_data
= port
;
236 usb_autopm_put_interface(serial
->interface
);
238 module_put(serial
->type
->driver
.owner
);
241 usb_serial_put(serial
);
242 mutex_unlock(&serial
->disc_mutex
);
246 static int serial_activate(struct tty_port
*tport
, struct tty_struct
*tty
)
248 struct usb_serial_port
*port
=
249 container_of(tport
, struct usb_serial_port
, port
);
250 struct usb_serial
*serial
= port
->serial
;
253 mutex_lock(&serial
->disc_mutex
);
254 if (serial
->disconnected
)
257 retval
= port
->serial
->type
->open(tty
, port
);
258 mutex_unlock(&serial
->disc_mutex
);
261 retval
= usb_translate_errors(retval
);
266 static int serial_open(struct tty_struct
*tty
, struct file
*filp
)
268 struct usb_serial_port
*port
= tty
->driver_data
;
270 dbg("%s - port %d", __func__
, port
->number
);
271 return tty_port_open(&port
->port
, tty
, filp
);
275 * serial_down - shut down hardware
276 * @tport: tty port to shut down
278 * Shut down a USB serial port unless it is the console. We never
279 * shut down the console hardware as it will always be in use. Serialized
280 * against activate by the tport mutex and kept to matching open/close pairs
281 * of calls by the ASYNCB_INITIALIZED flag.
283 static void serial_down(struct tty_port
*tport
)
285 struct usb_serial_port
*port
=
286 container_of(tport
, struct usb_serial_port
, port
);
287 struct usb_serial_driver
*drv
= port
->serial
->type
;
289 * The console is magical. Do not hang up the console hardware
290 * or there will be tears.
292 if (port
->port
.console
)
298 static void serial_hangup(struct tty_struct
*tty
)
300 struct usb_serial_port
*port
= tty
->driver_data
;
301 dbg("%s - port %d", __func__
, port
->number
);
302 tty_port_hangup(&port
->port
);
305 static void serial_close(struct tty_struct
*tty
, struct file
*filp
)
307 struct usb_serial_port
*port
= tty
->driver_data
;
308 dbg("%s - port %d", __func__
, port
->number
);
309 tty_port_close(&port
->port
, tty
, filp
);
313 * serial_cleanup - free resources post close/hangup
314 * @port: port to free up
316 * Do the resource freeing and refcount dropping for the port.
317 * Avoid freeing the console.
319 * Called asynchronously after the last tty kref is dropped,
320 * and the tty layer has already done the tty_shutdown(tty);
322 static void serial_cleanup(struct tty_struct
*tty
)
324 struct usb_serial_port
*port
= tty
->driver_data
;
325 struct usb_serial
*serial
;
326 struct module
*owner
;
328 /* The console is magical. Do not hang up the console hardware
329 * or there will be tears.
331 if (port
->port
.console
)
334 dbg("%s - port %d", __func__
, port
->number
);
336 tty
->driver_data
= NULL
;
338 serial
= port
->serial
;
339 owner
= serial
->type
->driver
.owner
;
341 mutex_lock(&serial
->disc_mutex
);
342 if (!serial
->disconnected
)
343 usb_autopm_put_interface(serial
->interface
);
344 mutex_unlock(&serial
->disc_mutex
);
346 usb_serial_put(serial
);
350 static int serial_write(struct tty_struct
*tty
, const unsigned char *buf
,
353 struct usb_serial_port
*port
= tty
->driver_data
;
354 int retval
= -ENODEV
;
356 if (port
->serial
->dev
->state
== USB_STATE_NOTATTACHED
)
359 dbg("%s - port %d, %d byte(s)", __func__
, port
->number
, count
);
361 /* pass on to the driver specific version of this function */
362 retval
= port
->serial
->type
->write(tty
, port
, buf
, count
);
364 retval
= usb_translate_errors(retval
);
369 static int serial_write_room(struct tty_struct
*tty
)
371 struct usb_serial_port
*port
= tty
->driver_data
;
372 dbg("%s - port %d", __func__
, port
->number
);
373 /* pass on to the driver specific version of this function */
374 return port
->serial
->type
->write_room(tty
);
377 static int serial_chars_in_buffer(struct tty_struct
*tty
)
379 struct usb_serial_port
*port
= tty
->driver_data
;
380 dbg("%s - port %d", __func__
, port
->number
);
382 /* if the device was unplugged then any remaining characters
383 fell out of the connector ;) */
384 if (port
->serial
->disconnected
)
386 /* pass on to the driver specific version of this function */
387 return port
->serial
->type
->chars_in_buffer(tty
);
390 static void serial_throttle(struct tty_struct
*tty
)
392 struct usb_serial_port
*port
= tty
->driver_data
;
393 dbg("%s - port %d", __func__
, port
->number
);
395 /* pass on to the driver specific version of this function */
396 if (port
->serial
->type
->throttle
)
397 port
->serial
->type
->throttle(tty
);
400 static void serial_unthrottle(struct tty_struct
*tty
)
402 struct usb_serial_port
*port
= tty
->driver_data
;
403 dbg("%s - port %d", __func__
, port
->number
);
405 /* pass on to the driver specific version of this function */
406 if (port
->serial
->type
->unthrottle
)
407 port
->serial
->type
->unthrottle(tty
);
410 static int serial_ioctl(struct tty_struct
*tty
,
411 unsigned int cmd
, unsigned long arg
)
413 struct usb_serial_port
*port
= tty
->driver_data
;
414 int retval
= -ENODEV
;
416 dbg("%s - port %d, cmd 0x%.4x", __func__
, port
->number
, cmd
);
418 /* pass on to the driver specific version of this function
419 if it is available */
420 if (port
->serial
->type
->ioctl
) {
421 retval
= port
->serial
->type
->ioctl(tty
, cmd
, arg
);
423 retval
= -ENOIOCTLCMD
;
427 static void serial_set_termios(struct tty_struct
*tty
, struct ktermios
*old
)
429 struct usb_serial_port
*port
= tty
->driver_data
;
430 dbg("%s - port %d", __func__
, port
->number
);
432 /* pass on to the driver specific version of this function
433 if it is available */
434 if (port
->serial
->type
->set_termios
)
435 port
->serial
->type
->set_termios(tty
, port
, old
);
437 tty_termios_copy_hw(tty
->termios
, old
);
440 static int serial_break(struct tty_struct
*tty
, int break_state
)
442 struct usb_serial_port
*port
= tty
->driver_data
;
444 dbg("%s - port %d", __func__
, port
->number
);
446 /* pass on to the driver specific version of this function
447 if it is available */
448 if (port
->serial
->type
->break_ctl
)
449 port
->serial
->type
->break_ctl(tty
, break_state
);
453 static int serial_proc_show(struct seq_file
*m
, void *v
)
455 struct usb_serial
*serial
;
460 seq_puts(m
, "usbserinfo:1.0 driver:2.0\n");
461 for (i
= 0; i
< SERIAL_TTY_MINORS
; ++i
) {
462 serial
= usb_serial_get_by_index(i
);
466 seq_printf(m
, "%d:", i
);
467 if (serial
->type
->driver
.owner
)
468 seq_printf(m
, " module:%s",
469 module_name(serial
->type
->driver
.owner
));
470 seq_printf(m
, " name:\"%s\"",
471 serial
->type
->description
);
472 seq_printf(m
, " vendor:%04x product:%04x",
473 le16_to_cpu(serial
->dev
->descriptor
.idVendor
),
474 le16_to_cpu(serial
->dev
->descriptor
.idProduct
));
475 seq_printf(m
, " num_ports:%d", serial
->num_ports
);
476 seq_printf(m
, " port:%d", i
- serial
->minor
+ 1);
477 usb_make_path(serial
->dev
, tmp
, sizeof(tmp
));
478 seq_printf(m
, " path:%s", tmp
);
481 usb_serial_put(serial
);
482 mutex_unlock(&serial
->disc_mutex
);
487 static int serial_proc_open(struct inode
*inode
, struct file
*file
)
489 return single_open(file
, serial_proc_show
, NULL
);
492 static const struct file_operations serial_proc_fops
= {
493 .owner
= THIS_MODULE
,
494 .open
= serial_proc_open
,
497 .release
= single_release
,
500 static int serial_tiocmget(struct tty_struct
*tty
)
502 struct usb_serial_port
*port
= tty
->driver_data
;
504 dbg("%s - port %d", __func__
, port
->number
);
506 if (port
->serial
->type
->tiocmget
)
507 return port
->serial
->type
->tiocmget(tty
);
511 static int serial_tiocmset(struct tty_struct
*tty
,
512 unsigned int set
, unsigned int clear
)
514 struct usb_serial_port
*port
= tty
->driver_data
;
516 dbg("%s - port %d", __func__
, port
->number
);
518 if (port
->serial
->type
->tiocmset
)
519 return port
->serial
->type
->tiocmset(tty
, set
, clear
);
523 static int serial_get_icount(struct tty_struct
*tty
,
524 struct serial_icounter_struct
*icount
)
526 struct usb_serial_port
*port
= tty
->driver_data
;
528 dbg("%s - port %d", __func__
, port
->number
);
530 if (port
->serial
->type
->get_icount
)
531 return port
->serial
->type
->get_icount(tty
, icount
);
536 * We would be calling tty_wakeup here, but unfortunately some line
537 * disciplines have an annoying habit of calling tty->write from
538 * the write wakeup callback (e.g. n_hdlc.c).
540 void usb_serial_port_softint(struct usb_serial_port
*port
)
542 schedule_work(&port
->work
);
544 EXPORT_SYMBOL_GPL(usb_serial_port_softint
);
546 static void usb_serial_port_work(struct work_struct
*work
)
548 struct usb_serial_port
*port
=
549 container_of(work
, struct usb_serial_port
, work
);
550 struct tty_struct
*tty
;
552 dbg("%s - port %d", __func__
, port
->number
);
554 tty
= tty_port_tty_get(&port
->port
);
562 static void kill_traffic(struct usb_serial_port
*port
)
566 for (i
= 0; i
< ARRAY_SIZE(port
->read_urbs
); ++i
)
567 usb_kill_urb(port
->read_urbs
[i
]);
568 for (i
= 0; i
< ARRAY_SIZE(port
->write_urbs
); ++i
)
569 usb_kill_urb(port
->write_urbs
[i
]);
572 * Some drivers submit the read_urb in the
573 * handler for the write_urb or vice versa
574 * this order determines the order in which
575 * usb_kill_urb() must be used to reliably
576 * kill the URBs. As it is unknown here,
577 * both orders must be used in turn.
578 * The call below is not redundant.
580 usb_kill_urb(port
->read_urb
);
581 usb_kill_urb(port
->interrupt_in_urb
);
582 usb_kill_urb(port
->interrupt_out_urb
);
585 static void port_release(struct device
*dev
)
587 struct usb_serial_port
*port
= to_usb_serial_port(dev
);
590 dbg ("%s - %s", __func__
, dev_name(dev
));
593 * Stop all the traffic before cancelling the work, so that
594 * nobody will restart it by calling usb_serial_port_softint.
597 cancel_work_sync(&port
->work
);
599 usb_free_urb(port
->interrupt_in_urb
);
600 usb_free_urb(port
->interrupt_out_urb
);
601 for (i
= 0; i
< ARRAY_SIZE(port
->read_urbs
); ++i
) {
602 usb_free_urb(port
->read_urbs
[i
]);
603 kfree(port
->bulk_in_buffers
[i
]);
605 for (i
= 0; i
< ARRAY_SIZE(port
->write_urbs
); ++i
) {
606 usb_free_urb(port
->write_urbs
[i
]);
607 kfree(port
->bulk_out_buffers
[i
]);
609 kfifo_free(&port
->write_fifo
);
610 kfree(port
->interrupt_in_buffer
);
611 kfree(port
->interrupt_out_buffer
);
615 static struct usb_serial
*create_serial(struct usb_device
*dev
,
616 struct usb_interface
*interface
,
617 struct usb_serial_driver
*driver
)
619 struct usb_serial
*serial
;
621 serial
= kzalloc(sizeof(*serial
), GFP_KERNEL
);
623 dev_err(&dev
->dev
, "%s - out of memory\n", __func__
);
626 serial
->dev
= usb_get_dev(dev
);
627 serial
->type
= driver
;
628 serial
->interface
= interface
;
629 kref_init(&serial
->kref
);
630 mutex_init(&serial
->disc_mutex
);
631 serial
->minor
= SERIAL_TTY_NO_MINOR
;
636 static const struct usb_device_id
*match_dynamic_id(struct usb_interface
*intf
,
637 struct usb_serial_driver
*drv
)
639 struct usb_dynid
*dynid
;
641 spin_lock(&drv
->dynids
.lock
);
642 list_for_each_entry(dynid
, &drv
->dynids
.list
, node
) {
643 if (usb_match_one_id(intf
, &dynid
->id
)) {
644 spin_unlock(&drv
->dynids
.lock
);
648 spin_unlock(&drv
->dynids
.lock
);
652 static const struct usb_device_id
*get_iface_id(struct usb_serial_driver
*drv
,
653 struct usb_interface
*intf
)
655 const struct usb_device_id
*id
;
657 id
= usb_match_id(intf
, drv
->id_table
);
659 dbg("static descriptor matches");
662 id
= match_dynamic_id(intf
, drv
);
664 dbg("dynamic descriptor matches");
669 /* Caller must hold table_lock */
670 static struct usb_serial_driver
*search_serial_device(
671 struct usb_interface
*iface
)
673 const struct usb_device_id
*id
;
674 struct usb_serial_driver
*drv
;
676 /* Check if the usb id matches a known device */
677 list_for_each_entry(drv
, &usb_serial_driver_list
, driver_list
) {
678 id
= get_iface_id(drv
, iface
);
686 static int serial_carrier_raised(struct tty_port
*port
)
688 struct usb_serial_port
*p
= container_of(port
, struct usb_serial_port
, port
);
689 struct usb_serial_driver
*drv
= p
->serial
->type
;
691 if (drv
->carrier_raised
)
692 return drv
->carrier_raised(p
);
693 /* No carrier control - don't block */
697 static void serial_dtr_rts(struct tty_port
*port
, int on
)
699 struct usb_serial_port
*p
= container_of(port
, struct usb_serial_port
, port
);
700 struct usb_serial_driver
*drv
= p
->serial
->type
;
706 static const struct tty_port_operations serial_port_ops
= {
707 .carrier_raised
= serial_carrier_raised
,
708 .dtr_rts
= serial_dtr_rts
,
709 .activate
= serial_activate
,
710 .shutdown
= serial_down
,
713 int usb_serial_probe(struct usb_interface
*interface
,
714 const struct usb_device_id
*id
)
716 struct usb_device
*dev
= interface_to_usbdev(interface
);
717 struct usb_serial
*serial
= NULL
;
718 struct usb_serial_port
*port
;
719 struct usb_host_interface
*iface_desc
;
720 struct usb_endpoint_descriptor
*endpoint
;
721 struct usb_endpoint_descriptor
*interrupt_in_endpoint
[MAX_NUM_PORTS
];
722 struct usb_endpoint_descriptor
*interrupt_out_endpoint
[MAX_NUM_PORTS
];
723 struct usb_endpoint_descriptor
*bulk_in_endpoint
[MAX_NUM_PORTS
];
724 struct usb_endpoint_descriptor
*bulk_out_endpoint
[MAX_NUM_PORTS
];
725 struct usb_serial_driver
*type
= NULL
;
731 int num_interrupt_in
= 0;
732 int num_interrupt_out
= 0;
734 int num_bulk_out
= 0;
738 mutex_lock(&table_lock
);
739 type
= search_serial_device(interface
);
741 mutex_unlock(&table_lock
);
746 if (!try_module_get(type
->driver
.owner
)) {
747 mutex_unlock(&table_lock
);
748 dev_err(&interface
->dev
, "module get failed, exiting\n");
751 mutex_unlock(&table_lock
);
753 serial
= create_serial(dev
, interface
, type
);
755 module_put(type
->driver
.owner
);
756 dev_err(&interface
->dev
, "%s - out of memory\n", __func__
);
760 /* if this device type has a probe function, call it */
762 const struct usb_device_id
*id
;
764 id
= get_iface_id(type
, interface
);
765 retval
= type
->probe(serial
, id
);
768 dbg("sub driver rejected device");
770 module_put(type
->driver
.owner
);
775 /* descriptor matches, let's find the endpoints needed */
776 /* check out the endpoints */
777 iface_desc
= interface
->cur_altsetting
;
778 for (i
= 0; i
< iface_desc
->desc
.bNumEndpoints
; ++i
) {
779 endpoint
= &iface_desc
->endpoint
[i
].desc
;
781 if (usb_endpoint_is_bulk_in(endpoint
)) {
782 /* we found a bulk in endpoint */
783 dbg("found bulk in on endpoint %d", i
);
784 bulk_in_endpoint
[num_bulk_in
] = endpoint
;
788 if (usb_endpoint_is_bulk_out(endpoint
)) {
789 /* we found a bulk out endpoint */
790 dbg("found bulk out on endpoint %d", i
);
791 bulk_out_endpoint
[num_bulk_out
] = endpoint
;
795 if (usb_endpoint_is_int_in(endpoint
)) {
796 /* we found a interrupt in endpoint */
797 dbg("found interrupt in on endpoint %d", i
);
798 interrupt_in_endpoint
[num_interrupt_in
] = endpoint
;
802 if (usb_endpoint_is_int_out(endpoint
)) {
803 /* we found an interrupt out endpoint */
804 dbg("found interrupt out on endpoint %d", i
);
805 interrupt_out_endpoint
[num_interrupt_out
] = endpoint
;
810 #if defined(CONFIG_USB_SERIAL_PL2303) || defined(CONFIG_USB_SERIAL_PL2303_MODULE)
811 /* BEGIN HORRIBLE HACK FOR PL2303 */
812 /* this is needed due to the looney way its endpoints are set up */
813 if (((le16_to_cpu(dev
->descriptor
.idVendor
) == PL2303_VENDOR_ID
) &&
814 (le16_to_cpu(dev
->descriptor
.idProduct
) == PL2303_PRODUCT_ID
)) ||
815 ((le16_to_cpu(dev
->descriptor
.idVendor
) == ATEN_VENDOR_ID
) &&
816 (le16_to_cpu(dev
->descriptor
.idProduct
) == ATEN_PRODUCT_ID
)) ||
817 ((le16_to_cpu(dev
->descriptor
.idVendor
) == ALCOR_VENDOR_ID
) &&
818 (le16_to_cpu(dev
->descriptor
.idProduct
) == ALCOR_PRODUCT_ID
)) ||
819 ((le16_to_cpu(dev
->descriptor
.idVendor
) == SIEMENS_VENDOR_ID
) &&
820 (le16_to_cpu(dev
->descriptor
.idProduct
) == SIEMENS_PRODUCT_ID_EF81
))) {
821 if (interface
!= dev
->actconfig
->interface
[0]) {
822 /* check out the endpoints of the other interface*/
823 iface_desc
= dev
->actconfig
->interface
[0]->cur_altsetting
;
824 for (i
= 0; i
< iface_desc
->desc
.bNumEndpoints
; ++i
) {
825 endpoint
= &iface_desc
->endpoint
[i
].desc
;
826 if (usb_endpoint_is_int_in(endpoint
)) {
827 /* we found a interrupt in endpoint */
828 dbg("found interrupt in for Prolific device on separate interface");
829 interrupt_in_endpoint
[num_interrupt_in
] = endpoint
;
835 /* Now make sure the PL-2303 is configured correctly.
836 * If not, give up now and hope this hack will work
837 * properly during a later invocation of usb_serial_probe
839 if (num_bulk_in
== 0 || num_bulk_out
== 0) {
840 dev_info(&interface
->dev
, "PL-2303 hack: descriptors matched but endpoints did not\n");
842 module_put(type
->driver
.owner
);
846 /* END HORRIBLE HACK FOR PL2303 */
849 #ifdef CONFIG_USB_SERIAL_GENERIC
850 if (type
== &usb_serial_generic_device
) {
851 num_ports
= num_bulk_out
;
852 if (num_ports
== 0) {
853 dev_err(&interface
->dev
,
854 "Generic device with no bulk out, not allowed.\n");
856 module_put(type
->driver
.owner
);
862 /* if this device type has a calc_num_ports function, call it */
863 if (type
->calc_num_ports
)
864 num_ports
= type
->calc_num_ports(serial
);
866 num_ports
= type
->num_ports
;
869 serial
->num_ports
= num_ports
;
870 serial
->num_bulk_in
= num_bulk_in
;
871 serial
->num_bulk_out
= num_bulk_out
;
872 serial
->num_interrupt_in
= num_interrupt_in
;
873 serial
->num_interrupt_out
= num_interrupt_out
;
875 /* found all that we need */
876 dev_info(&interface
->dev
, "%s converter detected\n",
879 /* create our ports, we need as many as the max endpoints */
880 /* we don't use num_ports here because some devices have more
881 endpoint pairs than ports */
882 max_endpoints
= max(num_bulk_in
, num_bulk_out
);
883 max_endpoints
= max(max_endpoints
, num_interrupt_in
);
884 max_endpoints
= max(max_endpoints
, num_interrupt_out
);
885 max_endpoints
= max(max_endpoints
, (int)serial
->num_ports
);
886 serial
->num_port_pointers
= max_endpoints
;
888 dbg("%s - setting up %d port structures for this device",
889 __func__
, max_endpoints
);
890 for (i
= 0; i
< max_endpoints
; ++i
) {
891 port
= kzalloc(sizeof(struct usb_serial_port
), GFP_KERNEL
);
894 tty_port_init(&port
->port
);
895 port
->port
.ops
= &serial_port_ops
;
896 port
->serial
= serial
;
897 spin_lock_init(&port
->lock
);
898 /* Keep this for private driver use for the moment but
899 should probably go away */
900 INIT_WORK(&port
->work
, usb_serial_port_work
);
901 serial
->port
[i
] = port
;
902 port
->dev
.parent
= &interface
->dev
;
903 port
->dev
.driver
= NULL
;
904 port
->dev
.bus
= &usb_serial_bus_type
;
905 port
->dev
.release
= &port_release
;
906 device_initialize(&port
->dev
);
909 /* set up the endpoint information */
910 for (i
= 0; i
< num_bulk_in
; ++i
) {
911 endpoint
= bulk_in_endpoint
[i
];
912 port
= serial
->port
[i
];
913 buffer_size
= max_t(int, serial
->type
->bulk_in_size
,
914 usb_endpoint_maxp(endpoint
));
915 port
->bulk_in_size
= buffer_size
;
916 port
->bulk_in_endpointAddress
= endpoint
->bEndpointAddress
;
918 for (j
= 0; j
< ARRAY_SIZE(port
->read_urbs
); ++j
) {
919 set_bit(j
, &port
->read_urbs_free
);
920 port
->read_urbs
[j
] = usb_alloc_urb(0, GFP_KERNEL
);
921 if (!port
->read_urbs
[j
]) {
922 dev_err(&interface
->dev
,
923 "No free urbs available\n");
926 port
->bulk_in_buffers
[j
] = kmalloc(buffer_size
,
928 if (!port
->bulk_in_buffers
[j
]) {
929 dev_err(&interface
->dev
,
930 "Couldn't allocate bulk_in_buffer\n");
933 usb_fill_bulk_urb(port
->read_urbs
[j
], dev
,
935 endpoint
->bEndpointAddress
),
936 port
->bulk_in_buffers
[j
], buffer_size
,
937 serial
->type
->read_bulk_callback
,
941 port
->read_urb
= port
->read_urbs
[0];
942 port
->bulk_in_buffer
= port
->bulk_in_buffers
[0];
945 for (i
= 0; i
< num_bulk_out
; ++i
) {
946 endpoint
= bulk_out_endpoint
[i
];
947 port
= serial
->port
[i
];
948 if (kfifo_alloc(&port
->write_fifo
, PAGE_SIZE
, GFP_KERNEL
))
950 buffer_size
= serial
->type
->bulk_out_size
;
952 buffer_size
= usb_endpoint_maxp(endpoint
);
953 port
->bulk_out_size
= buffer_size
;
954 port
->bulk_out_endpointAddress
= endpoint
->bEndpointAddress
;
956 for (j
= 0; j
< ARRAY_SIZE(port
->write_urbs
); ++j
) {
957 set_bit(j
, &port
->write_urbs_free
);
958 port
->write_urbs
[j
] = usb_alloc_urb(0, GFP_KERNEL
);
959 if (!port
->write_urbs
[j
]) {
960 dev_err(&interface
->dev
,
961 "No free urbs available\n");
964 port
->bulk_out_buffers
[j
] = kmalloc(buffer_size
,
966 if (!port
->bulk_out_buffers
[j
]) {
967 dev_err(&interface
->dev
,
968 "Couldn't allocate bulk_out_buffer\n");
971 usb_fill_bulk_urb(port
->write_urbs
[j
], dev
,
973 endpoint
->bEndpointAddress
),
974 port
->bulk_out_buffers
[j
], buffer_size
,
975 serial
->type
->write_bulk_callback
,
979 port
->write_urb
= port
->write_urbs
[0];
980 port
->bulk_out_buffer
= port
->bulk_out_buffers
[0];
983 if (serial
->type
->read_int_callback
) {
984 for (i
= 0; i
< num_interrupt_in
; ++i
) {
985 endpoint
= interrupt_in_endpoint
[i
];
986 port
= serial
->port
[i
];
987 port
->interrupt_in_urb
= usb_alloc_urb(0, GFP_KERNEL
);
988 if (!port
->interrupt_in_urb
) {
989 dev_err(&interface
->dev
,
990 "No free urbs available\n");
993 buffer_size
= usb_endpoint_maxp(endpoint
);
994 port
->interrupt_in_endpointAddress
=
995 endpoint
->bEndpointAddress
;
996 port
->interrupt_in_buffer
= kmalloc(buffer_size
,
998 if (!port
->interrupt_in_buffer
) {
999 dev_err(&interface
->dev
,
1000 "Couldn't allocate interrupt_in_buffer\n");
1003 usb_fill_int_urb(port
->interrupt_in_urb
, dev
,
1005 endpoint
->bEndpointAddress
),
1006 port
->interrupt_in_buffer
, buffer_size
,
1007 serial
->type
->read_int_callback
, port
,
1008 endpoint
->bInterval
);
1010 } else if (num_interrupt_in
) {
1011 dbg("the device claims to support interrupt in transfers, but read_int_callback is not defined");
1014 if (serial
->type
->write_int_callback
) {
1015 for (i
= 0; i
< num_interrupt_out
; ++i
) {
1016 endpoint
= interrupt_out_endpoint
[i
];
1017 port
= serial
->port
[i
];
1018 port
->interrupt_out_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1019 if (!port
->interrupt_out_urb
) {
1020 dev_err(&interface
->dev
,
1021 "No free urbs available\n");
1024 buffer_size
= usb_endpoint_maxp(endpoint
);
1025 port
->interrupt_out_size
= buffer_size
;
1026 port
->interrupt_out_endpointAddress
=
1027 endpoint
->bEndpointAddress
;
1028 port
->interrupt_out_buffer
= kmalloc(buffer_size
,
1030 if (!port
->interrupt_out_buffer
) {
1031 dev_err(&interface
->dev
,
1032 "Couldn't allocate interrupt_out_buffer\n");
1035 usb_fill_int_urb(port
->interrupt_out_urb
, dev
,
1037 endpoint
->bEndpointAddress
),
1038 port
->interrupt_out_buffer
, buffer_size
,
1039 serial
->type
->write_int_callback
, port
,
1040 endpoint
->bInterval
);
1042 } else if (num_interrupt_out
) {
1043 dbg("the device claims to support interrupt out transfers, but write_int_callback is not defined");
1046 /* if this device type has an attach function, call it */
1048 retval
= type
->attach(serial
);
1051 serial
->attached
= 1;
1053 /* quietly accept this device, but don't bind to a
1054 serial port as it's about to disappear */
1055 serial
->num_ports
= 0;
1059 serial
->attached
= 1;
1062 if (get_free_serial(serial
, num_ports
, &minor
) == NULL
) {
1063 dev_err(&interface
->dev
, "No more free serial devices\n");
1066 serial
->minor
= minor
;
1068 /* register all of the individual ports with the driver core */
1069 for (i
= 0; i
< num_ports
; ++i
) {
1070 port
= serial
->port
[i
];
1071 dev_set_name(&port
->dev
, "ttyUSB%d", port
->number
);
1072 dbg ("%s - registering %s", __func__
, dev_name(&port
->dev
));
1073 device_enable_async_suspend(&port
->dev
);
1075 retval
= device_add(&port
->dev
);
1077 dev_err(&port
->dev
, "Error registering port device, "
1081 usb_serial_console_init(debug
, minor
);
1085 usb_set_intfdata(interface
, serial
);
1086 module_put(type
->driver
.owner
);
1090 usb_serial_put(serial
);
1091 module_put(type
->driver
.owner
);
1094 EXPORT_SYMBOL_GPL(usb_serial_probe
);
1096 void usb_serial_disconnect(struct usb_interface
*interface
)
1099 struct usb_serial
*serial
= usb_get_intfdata(interface
);
1100 struct device
*dev
= &interface
->dev
;
1101 struct usb_serial_port
*port
;
1103 usb_serial_console_disconnect(serial
);
1104 dbg("%s", __func__
);
1106 mutex_lock(&serial
->disc_mutex
);
1107 usb_set_intfdata(interface
, NULL
);
1108 /* must set a flag, to signal subdrivers */
1109 serial
->disconnected
= 1;
1110 mutex_unlock(&serial
->disc_mutex
);
1112 for (i
= 0; i
< serial
->num_ports
; ++i
) {
1113 port
= serial
->port
[i
];
1115 struct tty_struct
*tty
= tty_port_tty_get(&port
->port
);
1121 cancel_work_sync(&port
->work
);
1122 if (device_is_registered(&port
->dev
))
1123 device_del(&port
->dev
);
1126 serial
->type
->disconnect(serial
);
1128 /* let the last holder of this object cause it to be cleaned up */
1129 usb_serial_put(serial
);
1130 dev_info(dev
, "device disconnected\n");
1132 EXPORT_SYMBOL_GPL(usb_serial_disconnect
);
1134 int usb_serial_suspend(struct usb_interface
*intf
, pm_message_t message
)
1136 struct usb_serial
*serial
= usb_get_intfdata(intf
);
1137 struct usb_serial_port
*port
;
1140 serial
->suspending
= 1;
1142 if (serial
->type
->suspend
) {
1143 r
= serial
->type
->suspend(serial
, message
);
1145 serial
->suspending
= 0;
1150 for (i
= 0; i
< serial
->num_ports
; ++i
) {
1151 port
= serial
->port
[i
];
1159 EXPORT_SYMBOL(usb_serial_suspend
);
1161 int usb_serial_resume(struct usb_interface
*intf
)
1163 struct usb_serial
*serial
= usb_get_intfdata(intf
);
1166 serial
->suspending
= 0;
1167 if (serial
->type
->resume
)
1168 rv
= serial
->type
->resume(serial
);
1170 rv
= usb_serial_generic_resume(serial
);
1174 EXPORT_SYMBOL(usb_serial_resume
);
1176 static const struct tty_operations serial_ops
= {
1177 .open
= serial_open
,
1178 .close
= serial_close
,
1179 .write
= serial_write
,
1180 .hangup
= serial_hangup
,
1181 .write_room
= serial_write_room
,
1182 .ioctl
= serial_ioctl
,
1183 .set_termios
= serial_set_termios
,
1184 .throttle
= serial_throttle
,
1185 .unthrottle
= serial_unthrottle
,
1186 .break_ctl
= serial_break
,
1187 .chars_in_buffer
= serial_chars_in_buffer
,
1188 .tiocmget
= serial_tiocmget
,
1189 .tiocmset
= serial_tiocmset
,
1190 .get_icount
= serial_get_icount
,
1191 .cleanup
= serial_cleanup
,
1192 .install
= serial_install
,
1193 .proc_fops
= &serial_proc_fops
,
1197 struct tty_driver
*usb_serial_tty_driver
;
1199 static int __init
usb_serial_init(void)
1204 usb_serial_tty_driver
= alloc_tty_driver(SERIAL_TTY_MINORS
);
1205 if (!usb_serial_tty_driver
)
1208 /* Initialize our global data */
1209 for (i
= 0; i
< SERIAL_TTY_MINORS
; ++i
)
1210 serial_table
[i
] = NULL
;
1212 result
= bus_register(&usb_serial_bus_type
);
1214 printk(KERN_ERR
"usb-serial: %s - registering bus driver "
1215 "failed\n", __func__
);
1219 usb_serial_tty_driver
->driver_name
= "usbserial";
1220 usb_serial_tty_driver
->name
= "ttyUSB";
1221 usb_serial_tty_driver
->major
= SERIAL_TTY_MAJOR
;
1222 usb_serial_tty_driver
->minor_start
= 0;
1223 usb_serial_tty_driver
->type
= TTY_DRIVER_TYPE_SERIAL
;
1224 usb_serial_tty_driver
->subtype
= SERIAL_TYPE_NORMAL
;
1225 usb_serial_tty_driver
->flags
= TTY_DRIVER_REAL_RAW
|
1226 TTY_DRIVER_DYNAMIC_DEV
;
1227 usb_serial_tty_driver
->init_termios
= tty_std_termios
;
1228 usb_serial_tty_driver
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
1230 usb_serial_tty_driver
->init_termios
.c_ispeed
= 9600;
1231 usb_serial_tty_driver
->init_termios
.c_ospeed
= 9600;
1232 tty_set_operations(usb_serial_tty_driver
, &serial_ops
);
1233 result
= tty_register_driver(usb_serial_tty_driver
);
1235 printk(KERN_ERR
"usb-serial: %s - tty_register_driver failed\n",
1237 goto exit_reg_driver
;
1240 /* register the USB driver */
1241 result
= usb_register(&usb_serial_driver
);
1243 printk(KERN_ERR
"usb-serial: %s - usb_register failed\n",
1248 /* register the generic driver, if we should */
1249 result
= usb_serial_generic_register(debug
);
1251 printk(KERN_ERR
"usb-serial: %s - registering generic "
1252 "driver failed\n", __func__
);
1256 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
1261 usb_deregister(&usb_serial_driver
);
1264 tty_unregister_driver(usb_serial_tty_driver
);
1267 bus_unregister(&usb_serial_bus_type
);
1270 printk(KERN_ERR
"usb-serial: %s - returning with error %d\n",
1272 put_tty_driver(usb_serial_tty_driver
);
1277 static void __exit
usb_serial_exit(void)
1279 usb_serial_console_exit();
1281 usb_serial_generic_deregister();
1283 usb_deregister(&usb_serial_driver
);
1284 tty_unregister_driver(usb_serial_tty_driver
);
1285 put_tty_driver(usb_serial_tty_driver
);
1286 bus_unregister(&usb_serial_bus_type
);
1290 module_init(usb_serial_init
);
1291 module_exit(usb_serial_exit
);
1293 #define set_to_generic_if_null(type, function) \
1295 if (!type->function) { \
1296 type->function = usb_serial_generic_##function; \
1297 dbg("Had to override the " #function \
1298 " usb serial operation with the generic one.");\
1302 static void fixup_generic(struct usb_serial_driver
*device
)
1304 set_to_generic_if_null(device
, open
);
1305 set_to_generic_if_null(device
, write
);
1306 set_to_generic_if_null(device
, close
);
1307 set_to_generic_if_null(device
, write_room
);
1308 set_to_generic_if_null(device
, chars_in_buffer
);
1309 set_to_generic_if_null(device
, read_bulk_callback
);
1310 set_to_generic_if_null(device
, write_bulk_callback
);
1311 set_to_generic_if_null(device
, disconnect
);
1312 set_to_generic_if_null(device
, release
);
1313 set_to_generic_if_null(device
, process_read_urb
);
1314 set_to_generic_if_null(device
, prepare_write_buffer
);
1317 static int usb_serial_register(struct usb_serial_driver
*driver
)
1324 fixup_generic(driver
);
1326 if (!driver
->description
)
1327 driver
->description
= driver
->driver
.name
;
1328 if (!driver
->usb_driver
) {
1329 WARN(1, "Serial driver %s has no usb_driver\n",
1330 driver
->description
);
1333 driver
->usb_driver
->supports_autosuspend
= 1;
1335 /* Add this device to our list of devices */
1336 mutex_lock(&table_lock
);
1337 list_add(&driver
->driver_list
, &usb_serial_driver_list
);
1339 retval
= usb_serial_bus_register(driver
);
1341 printk(KERN_ERR
"usb-serial: problem %d when registering "
1342 "driver %s\n", retval
, driver
->description
);
1343 list_del(&driver
->driver_list
);
1345 printk(KERN_INFO
"USB Serial support registered for %s\n",
1346 driver
->description
);
1348 mutex_unlock(&table_lock
);
1352 static void usb_serial_deregister(struct usb_serial_driver
*device
)
1354 printk(KERN_INFO
"USB Serial deregistering driver %s\n",
1355 device
->description
);
1356 mutex_lock(&table_lock
);
1357 list_del(&device
->driver_list
);
1358 usb_serial_bus_deregister(device
);
1359 mutex_unlock(&table_lock
);
1363 * usb_serial_register_drivers - register drivers for a usb-serial module
1364 * @udriver: usb_driver used for matching devices/interfaces
1365 * @serial_drivers: NULL-terminated array of pointers to drivers to be registered
1367 * Registers @udriver and all the drivers in the @serial_drivers array.
1368 * Automatically fills in the .no_dynamic_id field in @udriver and
1369 * the .usb_driver field in each serial driver.
1371 int usb_serial_register_drivers(struct usb_driver
*udriver
,
1372 struct usb_serial_driver
* const serial_drivers
[])
1375 const struct usb_device_id
*saved_id_table
;
1376 struct usb_serial_driver
* const *sd
;
1379 * udriver must be registered before any of the serial drivers,
1380 * because the store_new_id() routine for the serial drivers (in
1381 * bus.c) probes udriver.
1383 * Performance hack: We don't want udriver to be probed until
1384 * the serial drivers are registered, because the probe would
1385 * simply fail for lack of a matching serial driver.
1386 * Therefore save off udriver's id_table until we are all set.
1388 saved_id_table
= udriver
->id_table
;
1389 udriver
->id_table
= NULL
;
1391 udriver
->no_dynamic_id
= 1;
1392 rc
= usb_register(udriver
);
1396 for (sd
= serial_drivers
; *sd
; ++sd
) {
1397 (*sd
)->usb_driver
= udriver
;
1398 rc
= usb_serial_register(*sd
);
1403 /* Now restore udriver's id_table and look for matches */
1404 udriver
->id_table
= saved_id_table
;
1405 rc
= driver_attach(&udriver
->drvwrap
.driver
);
1409 while (sd
-- > serial_drivers
)
1410 usb_serial_deregister(*sd
);
1411 usb_deregister(udriver
);
1414 EXPORT_SYMBOL_GPL(usb_serial_register_drivers
);
1417 * usb_serial_deregister_drivers - deregister drivers for a usb-serial module
1418 * @udriver: usb_driver to unregister
1419 * @serial_drivers: NULL-terminated array of pointers to drivers to be deregistered
1421 * Deregisters @udriver and all the drivers in the @serial_drivers array.
1423 void usb_serial_deregister_drivers(struct usb_driver
*udriver
,
1424 struct usb_serial_driver
* const serial_drivers
[])
1426 for (; *serial_drivers
; ++serial_drivers
)
1427 usb_serial_deregister(*serial_drivers
);
1428 usb_deregister(udriver
);
1430 EXPORT_SYMBOL_GPL(usb_serial_deregister_drivers
);
1432 /* Module information */
1433 MODULE_AUTHOR(DRIVER_AUTHOR
);
1434 MODULE_DESCRIPTION(DRIVER_DESC
);
1435 MODULE_LICENSE("GPL");
1437 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1438 MODULE_PARM_DESC(debug
, "Debug enabled or not");