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/smp_lock.h>
25 #include <linux/tty.h>
26 #include <linux/tty_driver.h>
27 #include <linux/tty_flip.h>
28 #include <linux/module.h>
29 #include <linux/moduleparam.h>
30 #include <linux/seq_file.h>
31 #include <linux/spinlock.h>
32 #include <linux/mutex.h>
33 #include <linux/list.h>
34 #include <linux/uaccess.h>
35 #include <linux/serial.h>
36 #include <linux/usb.h>
37 #include <linux/usb/serial.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,
56 /* There is no MODULE_DEVICE_TABLE for usbserial.c. Instead
57 the MODULE_DEVICE_TABLE declarations in each serial driver
58 cause the "hotplug" program to pull in whatever module is necessary
59 via modprobe, and modprobe will load usbserial because the serial
64 /* initially all NULL */
65 static struct usb_serial *serial_table[SERIAL_TTY_MINORS];
66 static DEFINE_MUTEX(table_lock);
67 static LIST_HEAD(usb_serial_driver_list);
70 * Look up the serial structure. If it is found and it hasn't been
71 * disconnected, return with its disc_mutex held and its refcount
72 * incremented. Otherwise return NULL.
74 struct usb_serial *usb_serial_get_by_index(unsigned index)
76 struct usb_serial *serial;
78 mutex_lock(&table_lock);
79 serial = serial_table[index];
82 mutex_lock(&serial->disc_mutex);
83 if (serial->disconnected) {
84 mutex_unlock(&serial->disc_mutex);
87 kref_get(&serial->kref);
90 mutex_unlock(&table_lock);
94 static struct usb_serial *get_free_serial(struct usb_serial *serial,
95 int num_ports, unsigned int *minor)
100 dbg("%s %d", __func__, num_ports);
103 mutex_lock(&table_lock);
104 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
109 for (j = 1; j <= num_ports-1; ++j)
110 if ((i+j >= SERIAL_TTY_MINORS) || (serial_table[i+j])) {
120 dbg("%s - minor base = %d", __func__, *minor);
121 for (i = *minor; (i < (*minor + num_ports)) && (i < SERIAL_TTY_MINORS); ++i) {
122 serial_table[i] = serial;
123 serial->port[j++]->number = i;
125 mutex_unlock(&table_lock);
128 mutex_unlock(&table_lock);
132 static void return_serial(struct usb_serial *serial)
138 mutex_lock(&table_lock);
139 for (i = 0; i < serial->num_ports; ++i)
140 serial_table[serial->minor + i] = NULL;
141 mutex_unlock(&table_lock);
144 static void destroy_serial(struct kref *kref)
146 struct usb_serial *serial;
147 struct usb_serial_port *port;
150 serial = to_usb_serial(kref);
152 dbg("%s - %s", __func__, serial->type->description);
154 /* return the minor range that this device had */
155 if (serial->minor != SERIAL_TTY_NO_MINOR)
156 return_serial(serial);
158 serial->type->release(serial);
160 /* Now that nothing is using the ports, they can be freed */
161 for (i = 0; i < serial->num_port_pointers; ++i) {
162 port = serial->port[i];
165 put_device(&port->dev);
169 usb_put_dev(serial->dev);
173 void usb_serial_put(struct usb_serial *serial)
175 kref_put(&serial->kref, destroy_serial);
178 /*****************************************************************************
179 * Driver tty interface functions
180 *****************************************************************************/
183 * serial_install - install tty
184 * @driver: the driver (USB in our case)
185 * @tty: the tty being created
187 * Create the termios objects for this tty. We use the default
188 * USB serial settings but permit them to be overridden by
189 * serial->type->init_termios.
191 * This is the first place a new tty gets used. Hence this is where we
192 * acquire references to the usb_serial structure and the driver module,
193 * where we store a pointer to the port, and where we do an autoresume.
194 * All these actions are reversed in serial_release().
196 static int serial_install(struct tty_driver *driver, struct tty_struct *tty)
198 int idx = tty->index;
199 struct usb_serial *serial;
200 struct usb_serial_port *port;
201 int retval = -ENODEV;
205 serial = usb_serial_get_by_index(idx);
209 port = serial->port[idx - serial->minor];
212 if (!try_module_get(serial->type->driver.owner))
213 goto error_module_get;
215 /* perform the standard setup */
216 retval = tty_init_termios(tty);
218 goto error_init_termios;
220 retval = usb_autopm_get_interface(serial->interface);
222 goto error_get_interface;
224 mutex_unlock(&serial->disc_mutex);
226 /* allow the driver to update the settings */
227 if (serial->type->init_termios)
228 serial->type->init_termios(tty);
230 tty->driver_data = port;
232 /* Final install (we use the default method) */
233 tty_driver_kref_get(driver);
235 driver->ttys[idx] = tty;
240 module_put(serial->type->driver.owner);
243 usb_serial_put(serial);
244 mutex_unlock(&serial->disc_mutex);
248 static int serial_open(struct tty_struct *tty, struct file *filp)
250 struct usb_serial_port *port = tty->driver_data;
251 struct usb_serial *serial = port->serial;
254 dbg("%s - port %d", __func__, port->number);
256 spin_lock_irq(&port->port.lock);
257 if (!tty_hung_up_p(filp))
259 spin_unlock_irq(&port->port.lock);
260 tty_port_tty_set(&port->port, tty);
262 /* Do the device-specific open only if the hardware isn't
263 * already initialized.
265 if (!test_bit(ASYNCB_INITIALIZED, &port->port.flags)) {
266 if (mutex_lock_interruptible(&port->mutex))
268 mutex_lock(&serial->disc_mutex);
269 if (serial->disconnected)
272 retval = port->serial->type->open(tty, port);
273 mutex_unlock(&serial->disc_mutex);
274 mutex_unlock(&port->mutex);
277 set_bit(ASYNCB_INITIALIZED, &port->port.flags);
280 /* Now do the correct tty layer semantics */
281 retval = tty_port_block_til_ready(&port->port, tty, filp);
286 * serial_down - shut down hardware
287 * @port: port to shut down
289 * Shut down a USB serial port unless it is the console. We never
290 * shut down the console hardware as it will always be in use.
292 static void serial_down(struct usb_serial_port *port)
294 struct usb_serial_driver *drv = port->serial->type;
297 * The console is magical. Do not hang up the console hardware
298 * or there will be tears.
303 /* Don't call the close method if the hardware hasn't been
306 if (!test_and_clear_bit(ASYNCB_INITIALIZED, &port->port.flags))
309 mutex_lock(&port->mutex);
312 mutex_unlock(&port->mutex);
315 static void serial_hangup(struct tty_struct *tty)
317 struct usb_serial_port *port = tty->driver_data;
319 dbg("%s - port %d", __func__, port->number);
322 tty_port_hangup(&port->port);
325 static void serial_close(struct tty_struct *tty, struct file *filp)
327 struct usb_serial_port *port = tty->driver_data;
329 dbg("%s - port %d", __func__, port->number);
331 if (tty_hung_up_p(filp))
333 if (tty_port_close_start(&port->port, tty, filp) == 0)
336 tty_port_close_end(&port->port, tty);
337 tty_port_tty_set(&port->port, NULL);
341 * serial_release - free resources post close/hangup
342 * @port: port to free up
344 * Do the resource freeing and refcount dropping for the port.
345 * Avoid freeing the console.
347 * Called when the last tty kref is dropped.
349 static void serial_release(struct tty_struct *tty)
351 struct usb_serial_port *port = tty->driver_data;
352 struct usb_serial *serial;
353 struct module *owner;
355 /* The console is magical. Do not hang up the console hardware
356 * or there will be tears.
361 dbg("%s - port %d", __func__, port->number);
363 /* Standard shutdown processing */
366 tty->driver_data = NULL;
368 serial = port->serial;
369 owner = serial->type->driver.owner;
371 mutex_lock(&serial->disc_mutex);
372 if (!serial->disconnected)
373 usb_autopm_put_interface(serial->interface);
374 mutex_unlock(&serial->disc_mutex);
376 usb_serial_put(serial);
380 static int serial_write(struct tty_struct *tty, const unsigned char *buf,
383 struct usb_serial_port *port = tty->driver_data;
384 int retval = -ENODEV;
386 if (port->serial->dev->state == USB_STATE_NOTATTACHED)
389 dbg("%s - port %d, %d byte(s)", __func__, port->number, count);
391 /* count is managed under the mutex lock for the tty so cannot
392 drop to zero until after the last close completes */
393 WARN_ON(!port->port.count);
395 /* pass on to the driver specific version of this function */
396 retval = port->serial->type->write(tty, port, buf, count);
402 static int serial_write_room(struct tty_struct *tty)
404 struct usb_serial_port *port = tty->driver_data;
405 dbg("%s - port %d", __func__, port->number);
406 WARN_ON(!port->port.count);
407 /* pass on to the driver specific version of this function */
408 return port->serial->type->write_room(tty);
411 static int serial_chars_in_buffer(struct tty_struct *tty)
413 struct usb_serial_port *port = tty->driver_data;
414 dbg("%s = port %d", __func__, port->number);
416 /* if the device was unplugged then any remaining characters
417 fell out of the connector ;) */
418 if (port->serial->disconnected)
420 /* pass on to the driver specific version of this function */
421 return port->serial->type->chars_in_buffer(tty);
424 static void serial_throttle(struct tty_struct *tty)
426 struct usb_serial_port *port = tty->driver_data;
427 dbg("%s - port %d", __func__, port->number);
429 WARN_ON(!port->port.count);
430 /* pass on to the driver specific version of this function */
431 if (port->serial->type->throttle)
432 port->serial->type->throttle(tty);
435 static void serial_unthrottle(struct tty_struct *tty)
437 struct usb_serial_port *port = tty->driver_data;
438 dbg("%s - port %d", __func__, port->number);
440 WARN_ON(!port->port.count);
441 /* pass on to the driver specific version of this function */
442 if (port->serial->type->unthrottle)
443 port->serial->type->unthrottle(tty);
446 static int serial_ioctl(struct tty_struct *tty, struct file *file,
447 unsigned int cmd, unsigned long arg)
449 struct usb_serial_port *port = tty->driver_data;
450 int retval = -ENODEV;
452 dbg("%s - port %d, cmd 0x%.4x", __func__, port->number, cmd);
454 WARN_ON(!port->port.count);
456 /* pass on to the driver specific version of this function
457 if it is available */
458 if (port->serial->type->ioctl) {
459 retval = port->serial->type->ioctl(tty, file, cmd, arg);
461 retval = -ENOIOCTLCMD;
465 static void serial_set_termios(struct tty_struct *tty, struct ktermios *old)
467 struct usb_serial_port *port = tty->driver_data;
468 dbg("%s - port %d", __func__, port->number);
470 WARN_ON(!port->port.count);
471 /* pass on to the driver specific version of this function
472 if it is available */
473 if (port->serial->type->set_termios)
474 port->serial->type->set_termios(tty, port, old);
476 tty_termios_copy_hw(tty->termios, old);
479 static int serial_break(struct tty_struct *tty, int break_state)
481 struct usb_serial_port *port = tty->driver_data;
483 dbg("%s - port %d", __func__, port->number);
485 WARN_ON(!port->port.count);
486 /* pass on to the driver specific version of this function
487 if it is available */
488 if (port->serial->type->break_ctl)
489 port->serial->type->break_ctl(tty, break_state);
493 static int serial_proc_show(struct seq_file *m, void *v)
495 struct usb_serial *serial;
500 seq_puts(m, "usbserinfo:1.0 driver:2.0\n");
501 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
502 serial = usb_serial_get_by_index(i);
506 seq_printf(m, "%d:", i);
507 if (serial->type->driver.owner)
508 seq_printf(m, " module:%s",
509 module_name(serial->type->driver.owner));
510 seq_printf(m, " name:\"%s\"",
511 serial->type->description);
512 seq_printf(m, " vendor:%04x product:%04x",
513 le16_to_cpu(serial->dev->descriptor.idVendor),
514 le16_to_cpu(serial->dev->descriptor.idProduct));
515 seq_printf(m, " num_ports:%d", serial->num_ports);
516 seq_printf(m, " port:%d", i - serial->minor + 1);
517 usb_make_path(serial->dev, tmp, sizeof(tmp));
518 seq_printf(m, " path:%s", tmp);
521 usb_serial_put(serial);
522 mutex_unlock(&serial->disc_mutex);
527 static int serial_proc_open(struct inode *inode, struct file *file)
529 return single_open(file, serial_proc_show, NULL);
532 static const struct file_operations serial_proc_fops = {
533 .owner = THIS_MODULE,
534 .open = serial_proc_open,
537 .release = single_release,
540 static int serial_tiocmget(struct tty_struct *tty, struct file *file)
542 struct usb_serial_port *port = tty->driver_data;
544 dbg("%s - port %d", __func__, port->number);
546 WARN_ON(!port->port.count);
547 if (port->serial->type->tiocmget)
548 return port->serial->type->tiocmget(tty, file);
552 static int serial_tiocmset(struct tty_struct *tty, struct file *file,
553 unsigned int set, unsigned int clear)
555 struct usb_serial_port *port = tty->driver_data;
557 dbg("%s - port %d", __func__, port->number);
559 WARN_ON(!port->port.count);
560 if (port->serial->type->tiocmset)
561 return port->serial->type->tiocmset(tty, file, set, clear);
566 * We would be calling tty_wakeup here, but unfortunately some line
567 * disciplines have an annoying habit of calling tty->write from
568 * the write wakeup callback (e.g. n_hdlc.c).
570 void usb_serial_port_softint(struct usb_serial_port *port)
572 schedule_work(&port->work);
574 EXPORT_SYMBOL_GPL(usb_serial_port_softint);
576 static void usb_serial_port_work(struct work_struct *work)
578 struct usb_serial_port *port =
579 container_of(work, struct usb_serial_port, work);
580 struct tty_struct *tty;
582 dbg("%s - port %d", __func__, port->number);
584 tty = tty_port_tty_get(&port->port);
592 static void kill_traffic(struct usb_serial_port *port)
594 usb_kill_urb(port->read_urb);
595 usb_kill_urb(port->write_urb);
598 * Some drivers submit the read_urb in the
599 * handler for the write_urb or vice versa
600 * this order determines the order in which
601 * usb_kill_urb() must be used to reliably
602 * kill the URBs. As it is unknown here,
603 * both orders must be used in turn.
604 * The call below is not redundant.
606 usb_kill_urb(port->read_urb);
607 usb_kill_urb(port->interrupt_in_urb);
608 usb_kill_urb(port->interrupt_out_urb);
611 static void port_release(struct device *dev)
613 struct usb_serial_port *port = to_usb_serial_port(dev);
615 dbg ("%s - %s", __func__, dev_name(dev));
618 * Stop all the traffic before cancelling the work, so that
619 * nobody will restart it by calling usb_serial_port_softint.
622 cancel_work_sync(&port->work);
624 usb_free_urb(port->read_urb);
625 usb_free_urb(port->write_urb);
626 usb_free_urb(port->interrupt_in_urb);
627 usb_free_urb(port->interrupt_out_urb);
628 kfree(port->bulk_in_buffer);
629 kfree(port->bulk_out_buffer);
630 kfree(port->interrupt_in_buffer);
631 kfree(port->interrupt_out_buffer);
635 static struct usb_serial *create_serial(struct usb_device *dev,
636 struct usb_interface *interface,
637 struct usb_serial_driver *driver)
639 struct usb_serial *serial;
641 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
643 dev_err(&dev->dev, "%s - out of memory\n", __func__);
646 serial->dev = usb_get_dev(dev);
647 serial->type = driver;
648 serial->interface = interface;
649 kref_init(&serial->kref);
650 mutex_init(&serial->disc_mutex);
651 serial->minor = SERIAL_TTY_NO_MINOR;
656 static const struct usb_device_id *match_dynamic_id(struct usb_interface *intf,
657 struct usb_serial_driver *drv)
659 struct usb_dynid *dynid;
661 spin_lock(&drv->dynids.lock);
662 list_for_each_entry(dynid, &drv->dynids.list, node) {
663 if (usb_match_one_id(intf, &dynid->id)) {
664 spin_unlock(&drv->dynids.lock);
668 spin_unlock(&drv->dynids.lock);
672 static const struct usb_device_id *get_iface_id(struct usb_serial_driver *drv,
673 struct usb_interface *intf)
675 const struct usb_device_id *id;
677 id = usb_match_id(intf, drv->id_table);
679 dbg("static descriptor matches");
682 id = match_dynamic_id(intf, drv);
684 dbg("dynamic descriptor matches");
689 static struct usb_serial_driver *search_serial_device(
690 struct usb_interface *iface)
692 const struct usb_device_id *id;
693 struct usb_serial_driver *drv;
695 /* Check if the usb id matches a known device */
696 list_for_each_entry(drv, &usb_serial_driver_list, driver_list) {
697 id = get_iface_id(drv, iface);
705 static int serial_carrier_raised(struct tty_port *port)
707 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
708 struct usb_serial_driver *drv = p->serial->type;
709 if (drv->carrier_raised)
710 return drv->carrier_raised(p);
711 /* No carrier control - don't block */
715 static void serial_dtr_rts(struct tty_port *port, int on)
717 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
718 struct usb_serial_driver *drv = p->serial->type;
723 static const struct tty_port_operations serial_port_ops = {
724 .carrier_raised = serial_carrier_raised,
725 .dtr_rts = serial_dtr_rts,
728 int usb_serial_probe(struct usb_interface *interface,
729 const struct usb_device_id *id)
731 struct usb_device *dev = interface_to_usbdev(interface);
732 struct usb_serial *serial = NULL;
733 struct usb_serial_port *port;
734 struct usb_host_interface *iface_desc;
735 struct usb_endpoint_descriptor *endpoint;
736 struct usb_endpoint_descriptor *interrupt_in_endpoint[MAX_NUM_PORTS];
737 struct usb_endpoint_descriptor *interrupt_out_endpoint[MAX_NUM_PORTS];
738 struct usb_endpoint_descriptor *bulk_in_endpoint[MAX_NUM_PORTS];
739 struct usb_endpoint_descriptor *bulk_out_endpoint[MAX_NUM_PORTS];
740 struct usb_serial_driver *type = NULL;
745 int num_interrupt_in = 0;
746 int num_interrupt_out = 0;
748 int num_bulk_out = 0;
752 lock_kernel(); /* guard against unloading a serial driver module */
753 type = search_serial_device(interface);
760 serial = create_serial(dev, interface, type);
763 dev_err(&interface->dev, "%s - out of memory\n", __func__);
767 /* if this device type has a probe function, call it */
769 const struct usb_device_id *id;
771 if (!try_module_get(type->driver.owner)) {
773 dev_err(&interface->dev,
774 "module get failed, exiting\n");
779 id = get_iface_id(type, interface);
780 retval = type->probe(serial, id);
781 module_put(type->driver.owner);
785 dbg("sub driver rejected device");
791 /* descriptor matches, let's find the endpoints needed */
792 /* check out the endpoints */
793 iface_desc = interface->cur_altsetting;
794 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
795 endpoint = &iface_desc->endpoint[i].desc;
797 if (usb_endpoint_is_bulk_in(endpoint)) {
798 /* we found a bulk in endpoint */
799 dbg("found bulk in on endpoint %d", i);
800 bulk_in_endpoint[num_bulk_in] = endpoint;
804 if (usb_endpoint_is_bulk_out(endpoint)) {
805 /* we found a bulk out endpoint */
806 dbg("found bulk out on endpoint %d", i);
807 bulk_out_endpoint[num_bulk_out] = endpoint;
811 if (usb_endpoint_is_int_in(endpoint)) {
812 /* we found a interrupt in endpoint */
813 dbg("found interrupt in on endpoint %d", i);
814 interrupt_in_endpoint[num_interrupt_in] = endpoint;
818 if (usb_endpoint_is_int_out(endpoint)) {
819 /* we found an interrupt out endpoint */
820 dbg("found interrupt out on endpoint %d", i);
821 interrupt_out_endpoint[num_interrupt_out] = endpoint;
826 #if defined(CONFIG_USB_SERIAL_PL2303) || defined(CONFIG_USB_SERIAL_PL2303_MODULE)
827 /* BEGIN HORRIBLE HACK FOR PL2303 */
828 /* this is needed due to the looney way its endpoints are set up */
829 if (((le16_to_cpu(dev->descriptor.idVendor) == PL2303_VENDOR_ID) &&
830 (le16_to_cpu(dev->descriptor.idProduct) == PL2303_PRODUCT_ID)) ||
831 ((le16_to_cpu(dev->descriptor.idVendor) == ATEN_VENDOR_ID) &&
832 (le16_to_cpu(dev->descriptor.idProduct) == ATEN_PRODUCT_ID)) ||
833 ((le16_to_cpu(dev->descriptor.idVendor) == ALCOR_VENDOR_ID) &&
834 (le16_to_cpu(dev->descriptor.idProduct) == ALCOR_PRODUCT_ID)) ||
835 ((le16_to_cpu(dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
836 (le16_to_cpu(dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_EF81))) {
837 if (interface != dev->actconfig->interface[0]) {
838 /* check out the endpoints of the other interface*/
839 iface_desc = dev->actconfig->interface[0]->cur_altsetting;
840 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
841 endpoint = &iface_desc->endpoint[i].desc;
842 if (usb_endpoint_is_int_in(endpoint)) {
843 /* we found a interrupt in endpoint */
844 dbg("found interrupt in for Prolific device on separate interface");
845 interrupt_in_endpoint[num_interrupt_in] = endpoint;
851 /* Now make sure the PL-2303 is configured correctly.
852 * If not, give up now and hope this hack will work
853 * properly during a later invocation of usb_serial_probe
855 if (num_bulk_in == 0 || num_bulk_out == 0) {
857 dev_info(&interface->dev, "PL-2303 hack: descriptors matched but endpoints did not\n");
862 /* END HORRIBLE HACK FOR PL2303 */
865 #ifdef CONFIG_USB_SERIAL_GENERIC
866 if (type == &usb_serial_generic_device) {
867 num_ports = num_bulk_out;
868 if (num_ports == 0) {
870 dev_err(&interface->dev,
871 "Generic device with no bulk out, not allowed.\n");
878 /* if this device type has a calc_num_ports function, call it */
879 if (type->calc_num_ports) {
880 if (!try_module_get(type->driver.owner)) {
882 dev_err(&interface->dev,
883 "module get failed, exiting\n");
887 num_ports = type->calc_num_ports(serial);
888 module_put(type->driver.owner);
891 num_ports = type->num_ports;
894 serial->num_ports = num_ports;
895 serial->num_bulk_in = num_bulk_in;
896 serial->num_bulk_out = num_bulk_out;
897 serial->num_interrupt_in = num_interrupt_in;
898 serial->num_interrupt_out = num_interrupt_out;
900 /* found all that we need */
901 dev_info(&interface->dev, "%s converter detected\n",
904 /* create our ports, we need as many as the max endpoints */
905 /* we don't use num_ports here because some devices have more
906 endpoint pairs than ports */
907 max_endpoints = max(num_bulk_in, num_bulk_out);
908 max_endpoints = max(max_endpoints, num_interrupt_in);
909 max_endpoints = max(max_endpoints, num_interrupt_out);
910 max_endpoints = max(max_endpoints, (int)serial->num_ports);
911 serial->num_port_pointers = max_endpoints;
914 dbg("%s - setting up %d port structures for this device",
915 __func__, max_endpoints);
916 for (i = 0; i < max_endpoints; ++i) {
917 port = kzalloc(sizeof(struct usb_serial_port), GFP_KERNEL);
920 tty_port_init(&port->port);
921 port->port.ops = &serial_port_ops;
922 port->serial = serial;
923 spin_lock_init(&port->lock);
924 mutex_init(&port->mutex);
925 INIT_WORK(&port->work, usb_serial_port_work);
926 serial->port[i] = port;
927 port->dev.parent = &interface->dev;
928 port->dev.driver = NULL;
929 port->dev.bus = &usb_serial_bus_type;
930 port->dev.release = &port_release;
931 device_initialize(&port->dev);
934 /* set up the endpoint information */
935 for (i = 0; i < num_bulk_in; ++i) {
936 endpoint = bulk_in_endpoint[i];
937 port = serial->port[i];
938 port->read_urb = usb_alloc_urb(0, GFP_KERNEL);
939 if (!port->read_urb) {
940 dev_err(&interface->dev, "No free urbs available\n");
943 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
944 port->bulk_in_size = buffer_size;
945 port->bulk_in_endpointAddress = endpoint->bEndpointAddress;
946 port->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
947 if (!port->bulk_in_buffer) {
948 dev_err(&interface->dev,
949 "Couldn't allocate bulk_in_buffer\n");
952 usb_fill_bulk_urb(port->read_urb, dev,
954 endpoint->bEndpointAddress),
955 port->bulk_in_buffer, buffer_size,
956 serial->type->read_bulk_callback, port);
959 for (i = 0; i < num_bulk_out; ++i) {
960 endpoint = bulk_out_endpoint[i];
961 port = serial->port[i];
962 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
963 if (!port->write_urb) {
964 dev_err(&interface->dev, "No free urbs available\n");
967 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
968 port->bulk_out_size = buffer_size;
969 port->bulk_out_endpointAddress = endpoint->bEndpointAddress;
970 port->bulk_out_buffer = kmalloc(buffer_size, GFP_KERNEL);
971 if (!port->bulk_out_buffer) {
972 dev_err(&interface->dev,
973 "Couldn't allocate bulk_out_buffer\n");
976 usb_fill_bulk_urb(port->write_urb, dev,
978 endpoint->bEndpointAddress),
979 port->bulk_out_buffer, buffer_size,
980 serial->type->write_bulk_callback, port);
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 = le16_to_cpu(endpoint->wMaxPacketSize);
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 = le16_to_cpu(endpoint->wMaxPacketSize);
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 if (!try_module_get(type->driver.owner)) {
1049 dev_err(&interface->dev,
1050 "module get failed, exiting\n");
1053 retval = type->attach(serial);
1054 module_put(type->driver.owner);
1058 /* quietly accept this device, but don't bind to a
1059 serial port as it's about to disappear */
1060 serial->num_ports = 0;
1065 if (get_free_serial(serial, num_ports, &minor) == NULL) {
1066 dev_err(&interface->dev, "No more free serial devices\n");
1069 serial->minor = minor;
1071 /* register all of the individual ports with the driver core */
1072 for (i = 0; i < num_ports; ++i) {
1073 port = serial->port[i];
1074 dev_set_name(&port->dev, "ttyUSB%d", port->number);
1075 dbg ("%s - registering %s", __func__, dev_name(&port->dev));
1076 port->dev_state = PORT_REGISTERING;
1077 retval = device_add(&port->dev);
1079 dev_err(&port->dev, "Error registering port device, "
1081 port->dev_state = PORT_UNREGISTERED;
1083 port->dev_state = PORT_REGISTERED;
1087 usb_serial_console_init(debug, minor);
1091 usb_set_intfdata(interface, serial);
1095 usb_serial_put(serial);
1098 EXPORT_SYMBOL_GPL(usb_serial_probe);
1100 void usb_serial_disconnect(struct usb_interface *interface)
1103 struct usb_serial *serial = usb_get_intfdata(interface);
1104 struct device *dev = &interface->dev;
1105 struct usb_serial_port *port;
1107 usb_serial_console_disconnect(serial);
1108 dbg("%s", __func__);
1110 mutex_lock(&serial->disc_mutex);
1111 usb_set_intfdata(interface, NULL);
1112 /* must set a flag, to signal subdrivers */
1113 serial->disconnected = 1;
1114 mutex_unlock(&serial->disc_mutex);
1116 for (i = 0; i < serial->num_ports; ++i) {
1117 port = serial->port[i];
1119 struct tty_struct *tty = tty_port_tty_get(&port->port);
1125 cancel_work_sync(&port->work);
1126 if (port->dev_state == PORT_REGISTERED) {
1128 /* Make sure the port is bound so that the
1129 * driver's port_remove method is called.
1131 if (!port->dev.driver) {
1135 &serial->type->driver;
1136 rc = device_bind_driver(&port->dev);
1138 port->dev_state = PORT_UNREGISTERING;
1139 device_del(&port->dev);
1140 port->dev_state = PORT_UNREGISTERED;
1144 serial->type->disconnect(serial);
1146 /* let the last holder of this object cause it to be cleaned up */
1147 usb_serial_put(serial);
1148 dev_info(dev, "device disconnected\n");
1150 EXPORT_SYMBOL_GPL(usb_serial_disconnect);
1152 int usb_serial_suspend(struct usb_interface *intf, pm_message_t message)
1154 struct usb_serial *serial = usb_get_intfdata(intf);
1155 struct usb_serial_port *port;
1158 serial->suspending = 1;
1160 for (i = 0; i < serial->num_ports; ++i) {
1161 port = serial->port[i];
1166 if (serial->type->suspend)
1167 r = serial->type->suspend(serial, message);
1171 EXPORT_SYMBOL(usb_serial_suspend);
1173 int usb_serial_resume(struct usb_interface *intf)
1175 struct usb_serial *serial = usb_get_intfdata(intf);
1178 serial->suspending = 0;
1179 if (serial->type->resume)
1180 rv = serial->type->resume(serial);
1182 rv = usb_serial_generic_resume(serial);
1186 EXPORT_SYMBOL(usb_serial_resume);
1188 static const struct tty_operations serial_ops = {
1189 .open = serial_open,
1190 .close = serial_close,
1191 .write = serial_write,
1192 .hangup = serial_hangup,
1193 .write_room = serial_write_room,
1194 .ioctl = serial_ioctl,
1195 .set_termios = serial_set_termios,
1196 .throttle = serial_throttle,
1197 .unthrottle = serial_unthrottle,
1198 .break_ctl = serial_break,
1199 .chars_in_buffer = serial_chars_in_buffer,
1200 .tiocmget = serial_tiocmget,
1201 .tiocmset = serial_tiocmset,
1202 .shutdown = serial_release,
1203 .install = serial_install,
1204 .proc_fops = &serial_proc_fops,
1208 struct tty_driver *usb_serial_tty_driver;
1210 static int __init usb_serial_init(void)
1215 usb_serial_tty_driver = alloc_tty_driver(SERIAL_TTY_MINORS);
1216 if (!usb_serial_tty_driver)
1219 /* Initialize our global data */
1220 for (i = 0; i < SERIAL_TTY_MINORS; ++i)
1221 serial_table[i] = NULL;
1223 result = bus_register(&usb_serial_bus_type);
1225 printk(KERN_ERR "usb-serial: %s - registering bus driver "
1226 "failed\n", __func__);
1230 usb_serial_tty_driver->owner = THIS_MODULE;
1231 usb_serial_tty_driver->driver_name = "usbserial";
1232 usb_serial_tty_driver->name = "ttyUSB";
1233 usb_serial_tty_driver->major = SERIAL_TTY_MAJOR;
1234 usb_serial_tty_driver->minor_start = 0;
1235 usb_serial_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1236 usb_serial_tty_driver->subtype = SERIAL_TYPE_NORMAL;
1237 usb_serial_tty_driver->flags = TTY_DRIVER_REAL_RAW |
1238 TTY_DRIVER_DYNAMIC_DEV;
1239 usb_serial_tty_driver->init_termios = tty_std_termios;
1240 usb_serial_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD
1242 usb_serial_tty_driver->init_termios.c_ispeed = 9600;
1243 usb_serial_tty_driver->init_termios.c_ospeed = 9600;
1244 tty_set_operations(usb_serial_tty_driver, &serial_ops);
1245 result = tty_register_driver(usb_serial_tty_driver);
1247 printk(KERN_ERR "usb-serial: %s - tty_register_driver failed\n",
1249 goto exit_reg_driver;
1252 /* register the USB driver */
1253 result = usb_register(&usb_serial_driver);
1255 printk(KERN_ERR "usb-serial: %s - usb_register failed\n",
1260 /* register the generic driver, if we should */
1261 result = usb_serial_generic_register(debug);
1263 printk(KERN_ERR "usb-serial: %s - registering generic "
1264 "driver failed\n", __func__);
1268 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1273 usb_deregister(&usb_serial_driver);
1276 tty_unregister_driver(usb_serial_tty_driver);
1279 bus_unregister(&usb_serial_bus_type);
1282 printk(KERN_ERR "usb-serial: %s - returning with error %d\n",
1284 put_tty_driver(usb_serial_tty_driver);
1289 static void __exit usb_serial_exit(void)
1291 usb_serial_console_exit();
1293 usb_serial_generic_deregister();
1295 usb_deregister(&usb_serial_driver);
1296 tty_unregister_driver(usb_serial_tty_driver);
1297 put_tty_driver(usb_serial_tty_driver);
1298 bus_unregister(&usb_serial_bus_type);
1302 module_init(usb_serial_init);
1303 module_exit(usb_serial_exit);
1305 #define set_to_generic_if_null(type, function) \
1307 if (!type->function) { \
1308 type->function = usb_serial_generic_##function; \
1309 dbg("Had to override the " #function \
1310 " usb serial operation with the generic one.");\
1314 static void fixup_generic(struct usb_serial_driver *device)
1316 set_to_generic_if_null(device, open);
1317 set_to_generic_if_null(device, write);
1318 set_to_generic_if_null(device, close);
1319 set_to_generic_if_null(device, write_room);
1320 set_to_generic_if_null(device, chars_in_buffer);
1321 set_to_generic_if_null(device, read_bulk_callback);
1322 set_to_generic_if_null(device, write_bulk_callback);
1323 set_to_generic_if_null(device, disconnect);
1324 set_to_generic_if_null(device, release);
1327 int usb_serial_register(struct usb_serial_driver *driver)
1329 /* must be called with BKL held */
1335 fixup_generic(driver);
1337 if (!driver->description)
1338 driver->description = driver->driver.name;
1340 /* Add this device to our list of devices */
1341 list_add(&driver->driver_list, &usb_serial_driver_list);
1343 retval = usb_serial_bus_register(driver);
1345 printk(KERN_ERR "usb-serial: problem %d when registering "
1346 "driver %s\n", retval, driver->description);
1347 list_del(&driver->driver_list);
1349 printk(KERN_INFO "USB Serial support registered for %s\n",
1350 driver->description);
1354 EXPORT_SYMBOL_GPL(usb_serial_register);
1357 void usb_serial_deregister(struct usb_serial_driver *device)
1359 /* must be called with BKL held */
1360 printk(KERN_INFO "USB Serial deregistering driver %s\n",
1361 device->description);
1362 list_del(&device->driver_list);
1363 usb_serial_bus_deregister(device);
1365 EXPORT_SYMBOL_GPL(usb_serial_deregister);
1367 /* Module information */
1368 MODULE_AUTHOR(DRIVER_AUTHOR);
1369 MODULE_DESCRIPTION(DRIVER_DESC);
1370 MODULE_LICENSE("GPL");
1372 module_param(debug, bool, S_IRUGO | S_IWUSR);
1373 MODULE_PARM_DESC(debug, "Debug enabled or not");