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;
295 struct usb_serial *serial;
296 struct module *owner;
299 * The console is magical. Do not hang up the console hardware
300 * or there will be tears.
305 /* Don't call the close method if the hardware hasn't been
308 if (!test_and_clear_bit(ASYNCB_INITIALIZED, &port->port.flags))
311 mutex_lock(&port->mutex);
312 serial = port->serial;
313 owner = serial->type->driver.owner;
318 mutex_unlock(&port->mutex);
321 static void serial_hangup(struct tty_struct *tty)
323 struct usb_serial_port *port = tty->driver_data;
325 dbg("%s - port %d", __func__, port->number);
328 tty_port_hangup(&port->port);
331 static void serial_close(struct tty_struct *tty, struct file *filp)
333 struct usb_serial_port *port = tty->driver_data;
335 dbg("%s - port %d", __func__, port->number);
337 if (tty_hung_up_p(filp))
339 if (tty_port_close_start(&port->port, tty, filp) == 0)
342 tty_port_close_end(&port->port, tty);
343 tty_port_tty_set(&port->port, NULL);
347 * serial_release - free resources post close/hangup
348 * @port: port to free up
350 * Do the resource freeing and refcount dropping for the port.
351 * Avoid freeing the console.
353 * Called when the last tty kref is dropped.
355 static void serial_release(struct tty_struct *tty)
357 struct usb_serial_port *port = tty->driver_data;
358 struct usb_serial *serial;
359 struct module *owner;
361 /* The console is magical. Do not hang up the console hardware
362 * or there will be tears.
367 dbg("%s - port %d", __func__, port->number);
369 /* Standard shutdown processing */
372 tty->driver_data = NULL;
374 serial = port->serial;
375 owner = serial->type->driver.owner;
377 mutex_lock(&serial->disc_mutex);
378 if (!serial->disconnected)
379 usb_autopm_put_interface(serial->interface);
380 mutex_unlock(&serial->disc_mutex);
382 usb_serial_put(serial);
386 static int serial_write(struct tty_struct *tty, const unsigned char *buf,
389 struct usb_serial_port *port = tty->driver_data;
390 int retval = -ENODEV;
392 if (port->serial->dev->state == USB_STATE_NOTATTACHED)
395 dbg("%s - port %d, %d byte(s)", __func__, port->number, count);
397 /* count is managed under the mutex lock for the tty so cannot
398 drop to zero until after the last close completes */
399 WARN_ON(!port->port.count);
401 /* pass on to the driver specific version of this function */
402 retval = port->serial->type->write(tty, port, buf, count);
408 static int serial_write_room(struct tty_struct *tty)
410 struct usb_serial_port *port = tty->driver_data;
411 dbg("%s - port %d", __func__, port->number);
412 WARN_ON(!port->port.count);
413 /* pass on to the driver specific version of this function */
414 return port->serial->type->write_room(tty);
417 static int serial_chars_in_buffer(struct tty_struct *tty)
419 struct usb_serial_port *port = tty->driver_data;
420 dbg("%s = port %d", __func__, port->number);
422 /* if the device was unplugged then any remaining characters
423 fell out of the connector ;) */
424 if (port->serial->disconnected)
426 /* pass on to the driver specific version of this function */
427 return port->serial->type->chars_in_buffer(tty);
430 static void serial_throttle(struct tty_struct *tty)
432 struct usb_serial_port *port = tty->driver_data;
433 dbg("%s - port %d", __func__, port->number);
435 WARN_ON(!port->port.count);
436 /* pass on to the driver specific version of this function */
437 if (port->serial->type->throttle)
438 port->serial->type->throttle(tty);
441 static void serial_unthrottle(struct tty_struct *tty)
443 struct usb_serial_port *port = tty->driver_data;
444 dbg("%s - port %d", __func__, port->number);
446 WARN_ON(!port->port.count);
447 /* pass on to the driver specific version of this function */
448 if (port->serial->type->unthrottle)
449 port->serial->type->unthrottle(tty);
452 static int serial_ioctl(struct tty_struct *tty, struct file *file,
453 unsigned int cmd, unsigned long arg)
455 struct usb_serial_port *port = tty->driver_data;
456 int retval = -ENODEV;
458 dbg("%s - port %d, cmd 0x%.4x", __func__, port->number, cmd);
460 WARN_ON(!port->port.count);
462 /* pass on to the driver specific version of this function
463 if it is available */
464 if (port->serial->type->ioctl) {
465 retval = port->serial->type->ioctl(tty, file, cmd, arg);
467 retval = -ENOIOCTLCMD;
471 static void serial_set_termios(struct tty_struct *tty, struct ktermios *old)
473 struct usb_serial_port *port = tty->driver_data;
474 dbg("%s - port %d", __func__, port->number);
476 WARN_ON(!port->port.count);
477 /* pass on to the driver specific version of this function
478 if it is available */
479 if (port->serial->type->set_termios)
480 port->serial->type->set_termios(tty, port, old);
482 tty_termios_copy_hw(tty->termios, old);
485 static int serial_break(struct tty_struct *tty, int break_state)
487 struct usb_serial_port *port = tty->driver_data;
489 dbg("%s - port %d", __func__, port->number);
491 WARN_ON(!port->port.count);
492 /* pass on to the driver specific version of this function
493 if it is available */
494 if (port->serial->type->break_ctl)
495 port->serial->type->break_ctl(tty, break_state);
499 static int serial_proc_show(struct seq_file *m, void *v)
501 struct usb_serial *serial;
506 seq_puts(m, "usbserinfo:1.0 driver:2.0\n");
507 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
508 serial = usb_serial_get_by_index(i);
512 seq_printf(m, "%d:", i);
513 if (serial->type->driver.owner)
514 seq_printf(m, " module:%s",
515 module_name(serial->type->driver.owner));
516 seq_printf(m, " name:\"%s\"",
517 serial->type->description);
518 seq_printf(m, " vendor:%04x product:%04x",
519 le16_to_cpu(serial->dev->descriptor.idVendor),
520 le16_to_cpu(serial->dev->descriptor.idProduct));
521 seq_printf(m, " num_ports:%d", serial->num_ports);
522 seq_printf(m, " port:%d", i - serial->minor + 1);
523 usb_make_path(serial->dev, tmp, sizeof(tmp));
524 seq_printf(m, " path:%s", tmp);
527 usb_serial_put(serial);
528 mutex_unlock(&serial->disc_mutex);
533 static int serial_proc_open(struct inode *inode, struct file *file)
535 return single_open(file, serial_proc_show, NULL);
538 static const struct file_operations serial_proc_fops = {
539 .owner = THIS_MODULE,
540 .open = serial_proc_open,
543 .release = single_release,
546 static int serial_tiocmget(struct tty_struct *tty, struct file *file)
548 struct usb_serial_port *port = tty->driver_data;
550 dbg("%s - port %d", __func__, port->number);
552 WARN_ON(!port->port.count);
553 if (port->serial->type->tiocmget)
554 return port->serial->type->tiocmget(tty, file);
558 static int serial_tiocmset(struct tty_struct *tty, struct file *file,
559 unsigned int set, unsigned int clear)
561 struct usb_serial_port *port = tty->driver_data;
563 dbg("%s - port %d", __func__, port->number);
565 WARN_ON(!port->port.count);
566 if (port->serial->type->tiocmset)
567 return port->serial->type->tiocmset(tty, file, set, clear);
572 * We would be calling tty_wakeup here, but unfortunately some line
573 * disciplines have an annoying habit of calling tty->write from
574 * the write wakeup callback (e.g. n_hdlc.c).
576 void usb_serial_port_softint(struct usb_serial_port *port)
578 schedule_work(&port->work);
580 EXPORT_SYMBOL_GPL(usb_serial_port_softint);
582 static void usb_serial_port_work(struct work_struct *work)
584 struct usb_serial_port *port =
585 container_of(work, struct usb_serial_port, work);
586 struct tty_struct *tty;
588 dbg("%s - port %d", __func__, port->number);
590 tty = tty_port_tty_get(&port->port);
598 static void kill_traffic(struct usb_serial_port *port)
600 usb_kill_urb(port->read_urb);
601 usb_kill_urb(port->write_urb);
604 * Some drivers submit the read_urb in the
605 * handler for the write_urb or vice versa
606 * this order determines the order in which
607 * usb_kill_urb() must be used to reliably
608 * kill the URBs. As it is unknown here,
609 * both orders must be used in turn.
610 * The call below is not redundant.
612 usb_kill_urb(port->read_urb);
613 usb_kill_urb(port->interrupt_in_urb);
614 usb_kill_urb(port->interrupt_out_urb);
617 static void port_release(struct device *dev)
619 struct usb_serial_port *port = to_usb_serial_port(dev);
621 dbg ("%s - %s", __func__, dev_name(dev));
624 * Stop all the traffic before cancelling the work, so that
625 * nobody will restart it by calling usb_serial_port_softint.
628 cancel_work_sync(&port->work);
630 usb_free_urb(port->read_urb);
631 usb_free_urb(port->write_urb);
632 usb_free_urb(port->interrupt_in_urb);
633 usb_free_urb(port->interrupt_out_urb);
634 kfree(port->bulk_in_buffer);
635 kfree(port->bulk_out_buffer);
636 kfree(port->interrupt_in_buffer);
637 kfree(port->interrupt_out_buffer);
641 static struct usb_serial *create_serial(struct usb_device *dev,
642 struct usb_interface *interface,
643 struct usb_serial_driver *driver)
645 struct usb_serial *serial;
647 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
649 dev_err(&dev->dev, "%s - out of memory\n", __func__);
652 serial->dev = usb_get_dev(dev);
653 serial->type = driver;
654 serial->interface = interface;
655 kref_init(&serial->kref);
656 mutex_init(&serial->disc_mutex);
657 serial->minor = SERIAL_TTY_NO_MINOR;
662 static const struct usb_device_id *match_dynamic_id(struct usb_interface *intf,
663 struct usb_serial_driver *drv)
665 struct usb_dynid *dynid;
667 spin_lock(&drv->dynids.lock);
668 list_for_each_entry(dynid, &drv->dynids.list, node) {
669 if (usb_match_one_id(intf, &dynid->id)) {
670 spin_unlock(&drv->dynids.lock);
674 spin_unlock(&drv->dynids.lock);
678 static const struct usb_device_id *get_iface_id(struct usb_serial_driver *drv,
679 struct usb_interface *intf)
681 const struct usb_device_id *id;
683 id = usb_match_id(intf, drv->id_table);
685 dbg("static descriptor matches");
688 id = match_dynamic_id(intf, drv);
690 dbg("dynamic descriptor matches");
695 static struct usb_serial_driver *search_serial_device(
696 struct usb_interface *iface)
698 const struct usb_device_id *id;
699 struct usb_serial_driver *drv;
701 /* Check if the usb id matches a known device */
702 list_for_each_entry(drv, &usb_serial_driver_list, driver_list) {
703 id = get_iface_id(drv, iface);
711 static int serial_carrier_raised(struct tty_port *port)
713 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
714 struct usb_serial_driver *drv = p->serial->type;
715 if (drv->carrier_raised)
716 return drv->carrier_raised(p);
717 /* No carrier control - don't block */
721 static void serial_dtr_rts(struct tty_port *port, int on)
723 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
724 struct usb_serial_driver *drv = p->serial->type;
729 static const struct tty_port_operations serial_port_ops = {
730 .carrier_raised = serial_carrier_raised,
731 .dtr_rts = serial_dtr_rts,
734 int usb_serial_probe(struct usb_interface *interface,
735 const struct usb_device_id *id)
737 struct usb_device *dev = interface_to_usbdev(interface);
738 struct usb_serial *serial = NULL;
739 struct usb_serial_port *port;
740 struct usb_host_interface *iface_desc;
741 struct usb_endpoint_descriptor *endpoint;
742 struct usb_endpoint_descriptor *interrupt_in_endpoint[MAX_NUM_PORTS];
743 struct usb_endpoint_descriptor *interrupt_out_endpoint[MAX_NUM_PORTS];
744 struct usb_endpoint_descriptor *bulk_in_endpoint[MAX_NUM_PORTS];
745 struct usb_endpoint_descriptor *bulk_out_endpoint[MAX_NUM_PORTS];
746 struct usb_serial_driver *type = NULL;
751 int num_interrupt_in = 0;
752 int num_interrupt_out = 0;
754 int num_bulk_out = 0;
758 lock_kernel(); /* guard against unloading a serial driver module */
759 type = search_serial_device(interface);
766 serial = create_serial(dev, interface, type);
769 dev_err(&interface->dev, "%s - out of memory\n", __func__);
773 /* if this device type has a probe function, call it */
775 const struct usb_device_id *id;
777 if (!try_module_get(type->driver.owner)) {
779 dev_err(&interface->dev,
780 "module get failed, exiting\n");
785 id = get_iface_id(type, interface);
786 retval = type->probe(serial, id);
787 module_put(type->driver.owner);
791 dbg("sub driver rejected device");
797 /* descriptor matches, let's find the endpoints needed */
798 /* check out the endpoints */
799 iface_desc = interface->cur_altsetting;
800 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
801 endpoint = &iface_desc->endpoint[i].desc;
803 if (usb_endpoint_is_bulk_in(endpoint)) {
804 /* we found a bulk in endpoint */
805 dbg("found bulk in on endpoint %d", i);
806 bulk_in_endpoint[num_bulk_in] = endpoint;
810 if (usb_endpoint_is_bulk_out(endpoint)) {
811 /* we found a bulk out endpoint */
812 dbg("found bulk out on endpoint %d", i);
813 bulk_out_endpoint[num_bulk_out] = endpoint;
817 if (usb_endpoint_is_int_in(endpoint)) {
818 /* we found a interrupt in endpoint */
819 dbg("found interrupt in on endpoint %d", i);
820 interrupt_in_endpoint[num_interrupt_in] = endpoint;
824 if (usb_endpoint_is_int_out(endpoint)) {
825 /* we found an interrupt out endpoint */
826 dbg("found interrupt out on endpoint %d", i);
827 interrupt_out_endpoint[num_interrupt_out] = endpoint;
832 #if defined(CONFIG_USB_SERIAL_PL2303) || defined(CONFIG_USB_SERIAL_PL2303_MODULE)
833 /* BEGIN HORRIBLE HACK FOR PL2303 */
834 /* this is needed due to the looney way its endpoints are set up */
835 if (((le16_to_cpu(dev->descriptor.idVendor) == PL2303_VENDOR_ID) &&
836 (le16_to_cpu(dev->descriptor.idProduct) == PL2303_PRODUCT_ID)) ||
837 ((le16_to_cpu(dev->descriptor.idVendor) == ATEN_VENDOR_ID) &&
838 (le16_to_cpu(dev->descriptor.idProduct) == ATEN_PRODUCT_ID)) ||
839 ((le16_to_cpu(dev->descriptor.idVendor) == ALCOR_VENDOR_ID) &&
840 (le16_to_cpu(dev->descriptor.idProduct) == ALCOR_PRODUCT_ID)) ||
841 ((le16_to_cpu(dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
842 (le16_to_cpu(dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_EF81))) {
843 if (interface != dev->actconfig->interface[0]) {
844 /* check out the endpoints of the other interface*/
845 iface_desc = dev->actconfig->interface[0]->cur_altsetting;
846 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
847 endpoint = &iface_desc->endpoint[i].desc;
848 if (usb_endpoint_is_int_in(endpoint)) {
849 /* we found a interrupt in endpoint */
850 dbg("found interrupt in for Prolific device on separate interface");
851 interrupt_in_endpoint[num_interrupt_in] = endpoint;
857 /* Now make sure the PL-2303 is configured correctly.
858 * If not, give up now and hope this hack will work
859 * properly during a later invocation of usb_serial_probe
861 if (num_bulk_in == 0 || num_bulk_out == 0) {
863 dev_info(&interface->dev, "PL-2303 hack: descriptors matched but endpoints did not\n");
868 /* END HORRIBLE HACK FOR PL2303 */
871 #ifdef CONFIG_USB_SERIAL_GENERIC
872 if (type == &usb_serial_generic_device) {
873 num_ports = num_bulk_out;
874 if (num_ports == 0) {
876 dev_err(&interface->dev,
877 "Generic device with no bulk out, not allowed.\n");
884 /* if this device type has a calc_num_ports function, call it */
885 if (type->calc_num_ports) {
886 if (!try_module_get(type->driver.owner)) {
888 dev_err(&interface->dev,
889 "module get failed, exiting\n");
893 num_ports = type->calc_num_ports(serial);
894 module_put(type->driver.owner);
897 num_ports = type->num_ports;
900 serial->num_ports = num_ports;
901 serial->num_bulk_in = num_bulk_in;
902 serial->num_bulk_out = num_bulk_out;
903 serial->num_interrupt_in = num_interrupt_in;
904 serial->num_interrupt_out = num_interrupt_out;
906 /* found all that we need */
907 dev_info(&interface->dev, "%s converter detected\n",
910 /* create our ports, we need as many as the max endpoints */
911 /* we don't use num_ports here because some devices have more
912 endpoint pairs than ports */
913 max_endpoints = max(num_bulk_in, num_bulk_out);
914 max_endpoints = max(max_endpoints, num_interrupt_in);
915 max_endpoints = max(max_endpoints, num_interrupt_out);
916 max_endpoints = max(max_endpoints, (int)serial->num_ports);
917 serial->num_port_pointers = max_endpoints;
920 dbg("%s - setting up %d port structures for this device",
921 __func__, max_endpoints);
922 for (i = 0; i < max_endpoints; ++i) {
923 port = kzalloc(sizeof(struct usb_serial_port), GFP_KERNEL);
926 tty_port_init(&port->port);
927 port->port.ops = &serial_port_ops;
928 port->serial = serial;
929 spin_lock_init(&port->lock);
930 mutex_init(&port->mutex);
931 INIT_WORK(&port->work, usb_serial_port_work);
932 serial->port[i] = port;
933 port->dev.parent = &interface->dev;
934 port->dev.driver = NULL;
935 port->dev.bus = &usb_serial_bus_type;
936 port->dev.release = &port_release;
937 device_initialize(&port->dev);
940 /* set up the endpoint information */
941 for (i = 0; i < num_bulk_in; ++i) {
942 endpoint = bulk_in_endpoint[i];
943 port = serial->port[i];
944 port->read_urb = usb_alloc_urb(0, GFP_KERNEL);
945 if (!port->read_urb) {
946 dev_err(&interface->dev, "No free urbs available\n");
949 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
950 port->bulk_in_size = buffer_size;
951 port->bulk_in_endpointAddress = endpoint->bEndpointAddress;
952 port->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
953 if (!port->bulk_in_buffer) {
954 dev_err(&interface->dev,
955 "Couldn't allocate bulk_in_buffer\n");
958 usb_fill_bulk_urb(port->read_urb, dev,
960 endpoint->bEndpointAddress),
961 port->bulk_in_buffer, buffer_size,
962 serial->type->read_bulk_callback, port);
965 for (i = 0; i < num_bulk_out; ++i) {
966 endpoint = bulk_out_endpoint[i];
967 port = serial->port[i];
968 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
969 if (!port->write_urb) {
970 dev_err(&interface->dev, "No free urbs available\n");
973 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
974 port->bulk_out_size = buffer_size;
975 port->bulk_out_endpointAddress = endpoint->bEndpointAddress;
976 port->bulk_out_buffer = kmalloc(buffer_size, GFP_KERNEL);
977 if (!port->bulk_out_buffer) {
978 dev_err(&interface->dev,
979 "Couldn't allocate bulk_out_buffer\n");
982 usb_fill_bulk_urb(port->write_urb, dev,
984 endpoint->bEndpointAddress),
985 port->bulk_out_buffer, buffer_size,
986 serial->type->write_bulk_callback, port);
989 if (serial->type->read_int_callback) {
990 for (i = 0; i < num_interrupt_in; ++i) {
991 endpoint = interrupt_in_endpoint[i];
992 port = serial->port[i];
993 port->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
994 if (!port->interrupt_in_urb) {
995 dev_err(&interface->dev,
996 "No free urbs available\n");
999 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
1000 port->interrupt_in_endpointAddress =
1001 endpoint->bEndpointAddress;
1002 port->interrupt_in_buffer = kmalloc(buffer_size,
1004 if (!port->interrupt_in_buffer) {
1005 dev_err(&interface->dev,
1006 "Couldn't allocate interrupt_in_buffer\n");
1009 usb_fill_int_urb(port->interrupt_in_urb, dev,
1011 endpoint->bEndpointAddress),
1012 port->interrupt_in_buffer, buffer_size,
1013 serial->type->read_int_callback, port,
1014 endpoint->bInterval);
1016 } else if (num_interrupt_in) {
1017 dbg("the device claims to support interrupt in transfers, but read_int_callback is not defined");
1020 if (serial->type->write_int_callback) {
1021 for (i = 0; i < num_interrupt_out; ++i) {
1022 endpoint = interrupt_out_endpoint[i];
1023 port = serial->port[i];
1024 port->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
1025 if (!port->interrupt_out_urb) {
1026 dev_err(&interface->dev,
1027 "No free urbs available\n");
1030 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
1031 port->interrupt_out_size = buffer_size;
1032 port->interrupt_out_endpointAddress =
1033 endpoint->bEndpointAddress;
1034 port->interrupt_out_buffer = kmalloc(buffer_size,
1036 if (!port->interrupt_out_buffer) {
1037 dev_err(&interface->dev,
1038 "Couldn't allocate interrupt_out_buffer\n");
1041 usb_fill_int_urb(port->interrupt_out_urb, dev,
1043 endpoint->bEndpointAddress),
1044 port->interrupt_out_buffer, buffer_size,
1045 serial->type->write_int_callback, port,
1046 endpoint->bInterval);
1048 } else if (num_interrupt_out) {
1049 dbg("the device claims to support interrupt out transfers, but write_int_callback is not defined");
1052 /* if this device type has an attach function, call it */
1054 if (!try_module_get(type->driver.owner)) {
1055 dev_err(&interface->dev,
1056 "module get failed, exiting\n");
1059 retval = type->attach(serial);
1060 module_put(type->driver.owner);
1064 /* quietly accept this device, but don't bind to a
1065 serial port as it's about to disappear */
1066 serial->num_ports = 0;
1071 if (get_free_serial(serial, num_ports, &minor) == NULL) {
1072 dev_err(&interface->dev, "No more free serial devices\n");
1075 serial->minor = minor;
1077 /* register all of the individual ports with the driver core */
1078 for (i = 0; i < num_ports; ++i) {
1079 port = serial->port[i];
1080 dev_set_name(&port->dev, "ttyUSB%d", port->number);
1081 dbg ("%s - registering %s", __func__, dev_name(&port->dev));
1082 port->dev_state = PORT_REGISTERING;
1083 retval = device_add(&port->dev);
1085 dev_err(&port->dev, "Error registering port device, "
1087 port->dev_state = PORT_UNREGISTERED;
1089 port->dev_state = PORT_REGISTERED;
1093 usb_serial_console_init(debug, minor);
1097 usb_set_intfdata(interface, serial);
1101 usb_serial_put(serial);
1104 EXPORT_SYMBOL_GPL(usb_serial_probe);
1106 void usb_serial_disconnect(struct usb_interface *interface)
1109 struct usb_serial *serial = usb_get_intfdata(interface);
1110 struct device *dev = &interface->dev;
1111 struct usb_serial_port *port;
1113 usb_serial_console_disconnect(serial);
1114 dbg("%s", __func__);
1116 mutex_lock(&serial->disc_mutex);
1117 usb_set_intfdata(interface, NULL);
1118 /* must set a flag, to signal subdrivers */
1119 serial->disconnected = 1;
1120 mutex_unlock(&serial->disc_mutex);
1122 for (i = 0; i < serial->num_ports; ++i) {
1123 port = serial->port[i];
1125 struct tty_struct *tty = tty_port_tty_get(&port->port);
1131 cancel_work_sync(&port->work);
1132 if (port->dev_state == PORT_REGISTERED) {
1134 /* Make sure the port is bound so that the
1135 * driver's port_remove method is called.
1137 if (!port->dev.driver) {
1141 &serial->type->driver;
1142 rc = device_bind_driver(&port->dev);
1144 port->dev_state = PORT_UNREGISTERING;
1145 device_del(&port->dev);
1146 port->dev_state = PORT_UNREGISTERED;
1150 serial->type->disconnect(serial);
1152 /* let the last holder of this object cause it to be cleaned up */
1153 usb_serial_put(serial);
1154 dev_info(dev, "device disconnected\n");
1156 EXPORT_SYMBOL_GPL(usb_serial_disconnect);
1158 int usb_serial_suspend(struct usb_interface *intf, pm_message_t message)
1160 struct usb_serial *serial = usb_get_intfdata(intf);
1161 struct usb_serial_port *port;
1164 serial->suspending = 1;
1166 for (i = 0; i < serial->num_ports; ++i) {
1167 port = serial->port[i];
1172 if (serial->type->suspend)
1173 r = serial->type->suspend(serial, message);
1177 EXPORT_SYMBOL(usb_serial_suspend);
1179 int usb_serial_resume(struct usb_interface *intf)
1181 struct usb_serial *serial = usb_get_intfdata(intf);
1184 serial->suspending = 0;
1185 if (serial->type->resume)
1186 rv = serial->type->resume(serial);
1188 rv = usb_serial_generic_resume(serial);
1192 EXPORT_SYMBOL(usb_serial_resume);
1194 static const struct tty_operations serial_ops = {
1195 .open = serial_open,
1196 .close = serial_close,
1197 .write = serial_write,
1198 .hangup = serial_hangup,
1199 .write_room = serial_write_room,
1200 .ioctl = serial_ioctl,
1201 .set_termios = serial_set_termios,
1202 .throttle = serial_throttle,
1203 .unthrottle = serial_unthrottle,
1204 .break_ctl = serial_break,
1205 .chars_in_buffer = serial_chars_in_buffer,
1206 .tiocmget = serial_tiocmget,
1207 .tiocmset = serial_tiocmset,
1208 .shutdown = serial_release,
1209 .install = serial_install,
1210 .proc_fops = &serial_proc_fops,
1214 struct tty_driver *usb_serial_tty_driver;
1216 static int __init usb_serial_init(void)
1221 usb_serial_tty_driver = alloc_tty_driver(SERIAL_TTY_MINORS);
1222 if (!usb_serial_tty_driver)
1225 /* Initialize our global data */
1226 for (i = 0; i < SERIAL_TTY_MINORS; ++i)
1227 serial_table[i] = NULL;
1229 result = bus_register(&usb_serial_bus_type);
1231 printk(KERN_ERR "usb-serial: %s - registering bus driver "
1232 "failed\n", __func__);
1236 usb_serial_tty_driver->owner = THIS_MODULE;
1237 usb_serial_tty_driver->driver_name = "usbserial";
1238 usb_serial_tty_driver->name = "ttyUSB";
1239 usb_serial_tty_driver->major = SERIAL_TTY_MAJOR;
1240 usb_serial_tty_driver->minor_start = 0;
1241 usb_serial_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1242 usb_serial_tty_driver->subtype = SERIAL_TYPE_NORMAL;
1243 usb_serial_tty_driver->flags = TTY_DRIVER_REAL_RAW |
1244 TTY_DRIVER_DYNAMIC_DEV;
1245 usb_serial_tty_driver->init_termios = tty_std_termios;
1246 usb_serial_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD
1248 usb_serial_tty_driver->init_termios.c_ispeed = 9600;
1249 usb_serial_tty_driver->init_termios.c_ospeed = 9600;
1250 tty_set_operations(usb_serial_tty_driver, &serial_ops);
1251 result = tty_register_driver(usb_serial_tty_driver);
1253 printk(KERN_ERR "usb-serial: %s - tty_register_driver failed\n",
1255 goto exit_reg_driver;
1258 /* register the USB driver */
1259 result = usb_register(&usb_serial_driver);
1261 printk(KERN_ERR "usb-serial: %s - usb_register failed\n",
1266 /* register the generic driver, if we should */
1267 result = usb_serial_generic_register(debug);
1269 printk(KERN_ERR "usb-serial: %s - registering generic "
1270 "driver failed\n", __func__);
1274 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1279 usb_deregister(&usb_serial_driver);
1282 tty_unregister_driver(usb_serial_tty_driver);
1285 bus_unregister(&usb_serial_bus_type);
1288 printk(KERN_ERR "usb-serial: %s - returning with error %d\n",
1290 put_tty_driver(usb_serial_tty_driver);
1295 static void __exit usb_serial_exit(void)
1297 usb_serial_console_exit();
1299 usb_serial_generic_deregister();
1301 usb_deregister(&usb_serial_driver);
1302 tty_unregister_driver(usb_serial_tty_driver);
1303 put_tty_driver(usb_serial_tty_driver);
1304 bus_unregister(&usb_serial_bus_type);
1308 module_init(usb_serial_init);
1309 module_exit(usb_serial_exit);
1311 #define set_to_generic_if_null(type, function) \
1313 if (!type->function) { \
1314 type->function = usb_serial_generic_##function; \
1315 dbg("Had to override the " #function \
1316 " usb serial operation with the generic one.");\
1320 static void fixup_generic(struct usb_serial_driver *device)
1322 set_to_generic_if_null(device, open);
1323 set_to_generic_if_null(device, write);
1324 set_to_generic_if_null(device, close);
1325 set_to_generic_if_null(device, write_room);
1326 set_to_generic_if_null(device, chars_in_buffer);
1327 set_to_generic_if_null(device, read_bulk_callback);
1328 set_to_generic_if_null(device, write_bulk_callback);
1329 set_to_generic_if_null(device, disconnect);
1330 set_to_generic_if_null(device, release);
1333 int usb_serial_register(struct usb_serial_driver *driver)
1335 /* must be called with BKL held */
1341 fixup_generic(driver);
1343 if (!driver->description)
1344 driver->description = driver->driver.name;
1346 /* Add this device to our list of devices */
1347 list_add(&driver->driver_list, &usb_serial_driver_list);
1349 retval = usb_serial_bus_register(driver);
1351 printk(KERN_ERR "usb-serial: problem %d when registering "
1352 "driver %s\n", retval, driver->description);
1353 list_del(&driver->driver_list);
1355 printk(KERN_INFO "USB Serial support registered for %s\n",
1356 driver->description);
1360 EXPORT_SYMBOL_GPL(usb_serial_register);
1363 void usb_serial_deregister(struct usb_serial_driver *device)
1365 /* must be called with BKL held */
1366 printk(KERN_INFO "USB Serial deregistering driver %s\n",
1367 device->description);
1368 list_del(&device->driver_list);
1369 usb_serial_bus_deregister(device);
1371 EXPORT_SYMBOL_GPL(usb_serial_deregister);
1373 /* Module information */
1374 MODULE_AUTHOR(DRIVER_AUTHOR);
1375 MODULE_DESCRIPTION(DRIVER_DESC);
1376 MODULE_LICENSE("GPL");
1378 module_param(debug, bool, S_IRUGO | S_IWUSR);
1379 MODULE_PARM_DESC(debug, "Debug enabled or not");