2 * USB Serial Converter driver
4 * Copyright (C) 1999 - 2012 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 /* There is no MODULE_DEVICE_TABLE for usbserial.c. Instead
47 the MODULE_DEVICE_TABLE declarations in each serial driver
48 cause the "hotplug" program to pull in whatever module is necessary
49 via modprobe, and modprobe will load usbserial because the serial
54 /* initially all NULL */
55 static struct usb_serial *serial_table[SERIAL_TTY_MINORS];
56 static DEFINE_MUTEX(table_lock);
57 static LIST_HEAD(usb_serial_driver_list);
60 * Look up the serial structure. If it is found and it hasn't been
61 * disconnected, return with its disc_mutex held and its refcount
62 * incremented. Otherwise return NULL.
64 struct usb_serial *usb_serial_get_by_index(unsigned index)
66 struct usb_serial *serial;
68 mutex_lock(&table_lock);
69 serial = serial_table[index];
72 mutex_lock(&serial->disc_mutex);
73 if (serial->disconnected) {
74 mutex_unlock(&serial->disc_mutex);
77 kref_get(&serial->kref);
80 mutex_unlock(&table_lock);
84 static struct usb_serial *get_free_serial(struct usb_serial *serial,
85 int num_ports, unsigned int *minor)
90 dbg("%s %d", __func__, num_ports);
93 mutex_lock(&table_lock);
94 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
99 for (j = 1; j <= num_ports-1; ++j)
100 if ((i+j >= SERIAL_TTY_MINORS) || (serial_table[i+j])) {
110 dbg("%s - minor base = %d", __func__, *minor);
111 for (i = *minor; (i < (*minor + num_ports)) && (i < SERIAL_TTY_MINORS); ++i) {
112 serial_table[i] = serial;
113 serial->port[j++]->number = i;
115 mutex_unlock(&table_lock);
118 mutex_unlock(&table_lock);
122 static void return_serial(struct usb_serial *serial)
128 mutex_lock(&table_lock);
129 for (i = 0; i < serial->num_ports; ++i)
130 serial_table[serial->minor + i] = NULL;
131 mutex_unlock(&table_lock);
134 static void destroy_serial(struct kref *kref)
136 struct usb_serial *serial;
137 struct usb_serial_port *port;
140 serial = to_usb_serial(kref);
142 dbg("%s - %s", __func__, serial->type->description);
144 /* return the minor range that this device had */
145 if (serial->minor != SERIAL_TTY_NO_MINOR)
146 return_serial(serial);
148 if (serial->attached)
149 serial->type->release(serial);
151 /* Now that nothing is using the ports, they can be freed */
152 for (i = 0; i < serial->num_port_pointers; ++i) {
153 port = serial->port[i];
156 put_device(&port->dev);
160 usb_put_dev(serial->dev);
164 void usb_serial_put(struct usb_serial *serial)
166 kref_put(&serial->kref, destroy_serial);
169 /*****************************************************************************
170 * Driver tty interface functions
171 *****************************************************************************/
174 * serial_install - install tty
175 * @driver: the driver (USB in our case)
176 * @tty: the tty being created
178 * Create the termios objects for this tty. We use the default
179 * USB serial settings but permit them to be overridden by
180 * serial->type->init_termios.
182 * This is the first place a new tty gets used. Hence this is where we
183 * acquire references to the usb_serial structure and the driver module,
184 * where we store a pointer to the port, and where we do an autoresume.
185 * All these actions are reversed in serial_cleanup().
187 static int serial_install(struct tty_driver *driver, struct tty_struct *tty)
189 int idx = tty->index;
190 struct usb_serial *serial;
191 struct usb_serial_port *port;
192 int retval = -ENODEV;
196 serial = usb_serial_get_by_index(idx);
200 port = serial->port[idx - serial->minor];
203 if (!try_module_get(serial->type->driver.owner))
204 goto error_module_get;
206 retval = usb_autopm_get_interface(serial->interface);
208 goto error_get_interface;
210 retval = tty_standard_install(driver, tty);
212 goto error_init_termios;
214 mutex_unlock(&serial->disc_mutex);
216 /* allow the driver to update the settings */
217 if (serial->type->init_termios)
218 serial->type->init_termios(tty);
220 tty->driver_data = port;
225 usb_autopm_put_interface(serial->interface);
227 module_put(serial->type->driver.owner);
230 usb_serial_put(serial);
231 mutex_unlock(&serial->disc_mutex);
235 static int serial_activate(struct tty_port *tport, struct tty_struct *tty)
237 struct usb_serial_port *port =
238 container_of(tport, struct usb_serial_port, port);
239 struct usb_serial *serial = port->serial;
242 mutex_lock(&serial->disc_mutex);
243 if (serial->disconnected)
246 retval = port->serial->type->open(tty, port);
247 mutex_unlock(&serial->disc_mutex);
250 retval = usb_translate_errors(retval);
255 static int serial_open(struct tty_struct *tty, struct file *filp)
257 struct usb_serial_port *port = tty->driver_data;
259 dbg("%s - port %d", __func__, port->number);
260 return tty_port_open(&port->port, tty, filp);
264 * serial_down - shut down hardware
265 * @tport: tty port to shut down
267 * Shut down a USB serial port unless it is the console. We never
268 * shut down the console hardware as it will always be in use. Serialized
269 * against activate by the tport mutex and kept to matching open/close pairs
270 * of calls by the ASYNCB_INITIALIZED flag.
272 static void serial_down(struct tty_port *tport)
274 struct usb_serial_port *port =
275 container_of(tport, struct usb_serial_port, port);
276 struct usb_serial_driver *drv = port->serial->type;
278 * The console is magical. Do not hang up the console hardware
279 * or there will be tears.
281 if (port->port.console)
287 static void serial_hangup(struct tty_struct *tty)
289 struct usb_serial_port *port = tty->driver_data;
290 dbg("%s - port %d", __func__, port->number);
291 tty_port_hangup(&port->port);
294 static void serial_close(struct tty_struct *tty, struct file *filp)
296 struct usb_serial_port *port = tty->driver_data;
297 dbg("%s - port %d", __func__, port->number);
298 tty_port_close(&port->port, tty, filp);
302 * serial_cleanup - free resources post close/hangup
303 * @port: port to free up
305 * Do the resource freeing and refcount dropping for the port.
306 * Avoid freeing the console.
308 * Called asynchronously after the last tty kref is dropped,
309 * and the tty layer has already done the tty_shutdown(tty);
311 static void serial_cleanup(struct tty_struct *tty)
313 struct usb_serial_port *port = tty->driver_data;
314 struct usb_serial *serial;
315 struct module *owner;
317 /* The console is magical. Do not hang up the console hardware
318 * or there will be tears.
320 if (port->port.console)
323 dbg("%s - port %d", __func__, port->number);
325 tty->driver_data = NULL;
327 serial = port->serial;
328 owner = serial->type->driver.owner;
330 mutex_lock(&serial->disc_mutex);
331 if (!serial->disconnected)
332 usb_autopm_put_interface(serial->interface);
333 mutex_unlock(&serial->disc_mutex);
335 usb_serial_put(serial);
339 static int serial_write(struct tty_struct *tty, const unsigned char *buf,
342 struct usb_serial_port *port = tty->driver_data;
343 int retval = -ENODEV;
345 if (port->serial->dev->state == USB_STATE_NOTATTACHED)
348 dbg("%s - port %d, %d byte(s)", __func__, port->number, count);
350 /* pass on to the driver specific version of this function */
351 retval = port->serial->type->write(tty, port, buf, count);
353 retval = usb_translate_errors(retval);
358 static int serial_write_room(struct tty_struct *tty)
360 struct usb_serial_port *port = tty->driver_data;
361 dbg("%s - port %d", __func__, port->number);
362 /* pass on to the driver specific version of this function */
363 return port->serial->type->write_room(tty);
366 static int serial_chars_in_buffer(struct tty_struct *tty)
368 struct usb_serial_port *port = tty->driver_data;
369 dbg("%s - port %d", __func__, port->number);
371 /* if the device was unplugged then any remaining characters
372 fell out of the connector ;) */
373 if (port->serial->disconnected)
375 /* pass on to the driver specific version of this function */
376 return port->serial->type->chars_in_buffer(tty);
379 static void serial_throttle(struct tty_struct *tty)
381 struct usb_serial_port *port = tty->driver_data;
382 dbg("%s - port %d", __func__, port->number);
384 /* pass on to the driver specific version of this function */
385 if (port->serial->type->throttle)
386 port->serial->type->throttle(tty);
389 static void serial_unthrottle(struct tty_struct *tty)
391 struct usb_serial_port *port = tty->driver_data;
392 dbg("%s - port %d", __func__, port->number);
394 /* pass on to the driver specific version of this function */
395 if (port->serial->type->unthrottle)
396 port->serial->type->unthrottle(tty);
399 static int serial_ioctl(struct tty_struct *tty,
400 unsigned int cmd, unsigned long arg)
402 struct usb_serial_port *port = tty->driver_data;
403 int retval = -ENODEV;
405 dbg("%s - port %d, cmd 0x%.4x", __func__, port->number, cmd);
407 /* pass on to the driver specific version of this function
408 if it is available */
409 if (port->serial->type->ioctl) {
410 retval = port->serial->type->ioctl(tty, cmd, arg);
412 retval = -ENOIOCTLCMD;
416 static void serial_set_termios(struct tty_struct *tty, struct ktermios *old)
418 struct usb_serial_port *port = tty->driver_data;
419 dbg("%s - port %d", __func__, port->number);
421 /* pass on to the driver specific version of this function
422 if it is available */
423 if (port->serial->type->set_termios)
424 port->serial->type->set_termios(tty, port, old);
426 tty_termios_copy_hw(tty->termios, old);
429 static int serial_break(struct tty_struct *tty, int break_state)
431 struct usb_serial_port *port = tty->driver_data;
433 dbg("%s - port %d", __func__, port->number);
435 /* pass on to the driver specific version of this function
436 if it is available */
437 if (port->serial->type->break_ctl)
438 port->serial->type->break_ctl(tty, break_state);
442 static int serial_proc_show(struct seq_file *m, void *v)
444 struct usb_serial *serial;
449 seq_puts(m, "usbserinfo:1.0 driver:2.0\n");
450 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
451 serial = usb_serial_get_by_index(i);
455 seq_printf(m, "%d:", i);
456 if (serial->type->driver.owner)
457 seq_printf(m, " module:%s",
458 module_name(serial->type->driver.owner));
459 seq_printf(m, " name:\"%s\"",
460 serial->type->description);
461 seq_printf(m, " vendor:%04x product:%04x",
462 le16_to_cpu(serial->dev->descriptor.idVendor),
463 le16_to_cpu(serial->dev->descriptor.idProduct));
464 seq_printf(m, " num_ports:%d", serial->num_ports);
465 seq_printf(m, " port:%d", i - serial->minor + 1);
466 usb_make_path(serial->dev, tmp, sizeof(tmp));
467 seq_printf(m, " path:%s", tmp);
470 usb_serial_put(serial);
471 mutex_unlock(&serial->disc_mutex);
476 static int serial_proc_open(struct inode *inode, struct file *file)
478 return single_open(file, serial_proc_show, NULL);
481 static const struct file_operations serial_proc_fops = {
482 .owner = THIS_MODULE,
483 .open = serial_proc_open,
486 .release = single_release,
489 static int serial_tiocmget(struct tty_struct *tty)
491 struct usb_serial_port *port = tty->driver_data;
493 dbg("%s - port %d", __func__, port->number);
495 if (port->serial->type->tiocmget)
496 return port->serial->type->tiocmget(tty);
500 static int serial_tiocmset(struct tty_struct *tty,
501 unsigned int set, unsigned int clear)
503 struct usb_serial_port *port = tty->driver_data;
505 dbg("%s - port %d", __func__, port->number);
507 if (port->serial->type->tiocmset)
508 return port->serial->type->tiocmset(tty, set, clear);
512 static int serial_get_icount(struct tty_struct *tty,
513 struct serial_icounter_struct *icount)
515 struct usb_serial_port *port = tty->driver_data;
517 dbg("%s - port %d", __func__, port->number);
519 if (port->serial->type->get_icount)
520 return port->serial->type->get_icount(tty, icount);
525 * We would be calling tty_wakeup here, but unfortunately some line
526 * disciplines have an annoying habit of calling tty->write from
527 * the write wakeup callback (e.g. n_hdlc.c).
529 void usb_serial_port_softint(struct usb_serial_port *port)
531 schedule_work(&port->work);
533 EXPORT_SYMBOL_GPL(usb_serial_port_softint);
535 static void usb_serial_port_work(struct work_struct *work)
537 struct usb_serial_port *port =
538 container_of(work, struct usb_serial_port, work);
539 struct tty_struct *tty;
541 dbg("%s - port %d", __func__, port->number);
543 tty = tty_port_tty_get(&port->port);
551 static void kill_traffic(struct usb_serial_port *port)
555 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i)
556 usb_kill_urb(port->read_urbs[i]);
557 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
558 usb_kill_urb(port->write_urbs[i]);
561 * Some drivers submit the read_urb in the
562 * handler for the write_urb or vice versa
563 * this order determines the order in which
564 * usb_kill_urb() must be used to reliably
565 * kill the URBs. As it is unknown here,
566 * both orders must be used in turn.
567 * The call below is not redundant.
569 usb_kill_urb(port->read_urb);
570 usb_kill_urb(port->interrupt_in_urb);
571 usb_kill_urb(port->interrupt_out_urb);
574 static void port_release(struct device *dev)
576 struct usb_serial_port *port = to_usb_serial_port(dev);
579 dbg ("%s - %s", __func__, dev_name(dev));
582 * Stop all the traffic before cancelling the work, so that
583 * nobody will restart it by calling usb_serial_port_softint.
586 cancel_work_sync(&port->work);
588 usb_free_urb(port->interrupt_in_urb);
589 usb_free_urb(port->interrupt_out_urb);
590 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i) {
591 usb_free_urb(port->read_urbs[i]);
592 kfree(port->bulk_in_buffers[i]);
594 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i) {
595 usb_free_urb(port->write_urbs[i]);
596 kfree(port->bulk_out_buffers[i]);
598 kfifo_free(&port->write_fifo);
599 kfree(port->interrupt_in_buffer);
600 kfree(port->interrupt_out_buffer);
604 static struct usb_serial *create_serial(struct usb_device *dev,
605 struct usb_interface *interface,
606 struct usb_serial_driver *driver)
608 struct usb_serial *serial;
610 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
612 dev_err(&dev->dev, "%s - out of memory\n", __func__);
615 serial->dev = usb_get_dev(dev);
616 serial->type = driver;
617 serial->interface = interface;
618 kref_init(&serial->kref);
619 mutex_init(&serial->disc_mutex);
620 serial->minor = SERIAL_TTY_NO_MINOR;
625 static const struct usb_device_id *match_dynamic_id(struct usb_interface *intf,
626 struct usb_serial_driver *drv)
628 struct usb_dynid *dynid;
630 spin_lock(&drv->dynids.lock);
631 list_for_each_entry(dynid, &drv->dynids.list, node) {
632 if (usb_match_one_id(intf, &dynid->id)) {
633 spin_unlock(&drv->dynids.lock);
637 spin_unlock(&drv->dynids.lock);
641 static const struct usb_device_id *get_iface_id(struct usb_serial_driver *drv,
642 struct usb_interface *intf)
644 const struct usb_device_id *id;
646 id = usb_match_id(intf, drv->id_table);
648 dbg("static descriptor matches");
651 id = match_dynamic_id(intf, drv);
653 dbg("dynamic descriptor matches");
658 /* Caller must hold table_lock */
659 static struct usb_serial_driver *search_serial_device(
660 struct usb_interface *iface)
662 const struct usb_device_id *id = NULL;
663 struct usb_serial_driver *drv;
664 struct usb_driver *driver = to_usb_driver(iface->dev.driver);
666 /* Check if the usb id matches a known device */
667 list_for_each_entry(drv, &usb_serial_driver_list, driver_list) {
668 if (drv->usb_driver == driver)
669 id = get_iface_id(drv, iface);
677 static int serial_carrier_raised(struct tty_port *port)
679 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
680 struct usb_serial_driver *drv = p->serial->type;
682 if (drv->carrier_raised)
683 return drv->carrier_raised(p);
684 /* No carrier control - don't block */
688 static void serial_dtr_rts(struct tty_port *port, int on)
690 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
691 struct usb_serial_driver *drv = p->serial->type;
697 static const struct tty_port_operations serial_port_ops = {
698 .carrier_raised = serial_carrier_raised,
699 .dtr_rts = serial_dtr_rts,
700 .activate = serial_activate,
701 .shutdown = serial_down,
704 static int usb_serial_probe(struct usb_interface *interface,
705 const struct usb_device_id *id)
707 struct usb_device *dev = interface_to_usbdev(interface);
708 struct usb_serial *serial = NULL;
709 struct usb_serial_port *port;
710 struct usb_host_interface *iface_desc;
711 struct usb_endpoint_descriptor *endpoint;
712 struct usb_endpoint_descriptor *interrupt_in_endpoint[MAX_NUM_PORTS];
713 struct usb_endpoint_descriptor *interrupt_out_endpoint[MAX_NUM_PORTS];
714 struct usb_endpoint_descriptor *bulk_in_endpoint[MAX_NUM_PORTS];
715 struct usb_endpoint_descriptor *bulk_out_endpoint[MAX_NUM_PORTS];
716 struct usb_serial_driver *type = NULL;
722 int num_interrupt_in = 0;
723 int num_interrupt_out = 0;
725 int num_bulk_out = 0;
729 mutex_lock(&table_lock);
730 type = search_serial_device(interface);
732 mutex_unlock(&table_lock);
737 if (!try_module_get(type->driver.owner)) {
738 mutex_unlock(&table_lock);
739 dev_err(&interface->dev, "module get failed, exiting\n");
742 mutex_unlock(&table_lock);
744 serial = create_serial(dev, interface, type);
746 module_put(type->driver.owner);
747 dev_err(&interface->dev, "%s - out of memory\n", __func__);
751 /* if this device type has a probe function, call it */
753 const struct usb_device_id *id;
755 id = get_iface_id(type, interface);
756 retval = type->probe(serial, id);
759 dbg("sub driver rejected device");
760 usb_serial_put(serial);
761 module_put(type->driver.owner);
766 /* descriptor matches, let's find the endpoints needed */
767 /* check out the endpoints */
768 iface_desc = interface->cur_altsetting;
769 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
770 endpoint = &iface_desc->endpoint[i].desc;
772 if (usb_endpoint_is_bulk_in(endpoint)) {
773 /* we found a bulk in endpoint */
774 dbg("found bulk in on endpoint %d", i);
775 bulk_in_endpoint[num_bulk_in] = endpoint;
779 if (usb_endpoint_is_bulk_out(endpoint)) {
780 /* we found a bulk out endpoint */
781 dbg("found bulk out on endpoint %d", i);
782 bulk_out_endpoint[num_bulk_out] = endpoint;
786 if (usb_endpoint_is_int_in(endpoint)) {
787 /* we found a interrupt in endpoint */
788 dbg("found interrupt in on endpoint %d", i);
789 interrupt_in_endpoint[num_interrupt_in] = endpoint;
793 if (usb_endpoint_is_int_out(endpoint)) {
794 /* we found an interrupt out endpoint */
795 dbg("found interrupt out on endpoint %d", i);
796 interrupt_out_endpoint[num_interrupt_out] = endpoint;
801 #if defined(CONFIG_USB_SERIAL_PL2303) || defined(CONFIG_USB_SERIAL_PL2303_MODULE)
802 /* BEGIN HORRIBLE HACK FOR PL2303 */
803 /* this is needed due to the looney way its endpoints are set up */
804 if (((le16_to_cpu(dev->descriptor.idVendor) == PL2303_VENDOR_ID) &&
805 (le16_to_cpu(dev->descriptor.idProduct) == PL2303_PRODUCT_ID)) ||
806 ((le16_to_cpu(dev->descriptor.idVendor) == ATEN_VENDOR_ID) &&
807 (le16_to_cpu(dev->descriptor.idProduct) == ATEN_PRODUCT_ID)) ||
808 ((le16_to_cpu(dev->descriptor.idVendor) == ALCOR_VENDOR_ID) &&
809 (le16_to_cpu(dev->descriptor.idProduct) == ALCOR_PRODUCT_ID)) ||
810 ((le16_to_cpu(dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
811 (le16_to_cpu(dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_EF81))) {
812 if (interface != dev->actconfig->interface[0]) {
813 /* check out the endpoints of the other interface*/
814 iface_desc = dev->actconfig->interface[0]->cur_altsetting;
815 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
816 endpoint = &iface_desc->endpoint[i].desc;
817 if (usb_endpoint_is_int_in(endpoint)) {
818 /* we found a interrupt in endpoint */
819 dbg("found interrupt in for Prolific device on separate interface");
820 interrupt_in_endpoint[num_interrupt_in] = endpoint;
826 /* Now make sure the PL-2303 is configured correctly.
827 * If not, give up now and hope this hack will work
828 * properly during a later invocation of usb_serial_probe
830 if (num_bulk_in == 0 || num_bulk_out == 0) {
831 dev_info(&interface->dev, "PL-2303 hack: descriptors matched but endpoints did not\n");
832 usb_serial_put(serial);
833 module_put(type->driver.owner);
837 /* END HORRIBLE HACK FOR PL2303 */
840 #ifdef CONFIG_USB_SERIAL_GENERIC
841 if (type == &usb_serial_generic_device) {
842 num_ports = num_bulk_out;
843 if (num_ports == 0) {
844 dev_err(&interface->dev,
845 "Generic device with no bulk out, not allowed.\n");
846 usb_serial_put(serial);
847 module_put(type->driver.owner);
850 dev_info(&interface->dev, "The \"generic\" usb-serial driver is only for testing and one-off prototypes.\n");
851 dev_info(&interface->dev, "Tell linux-usb@vger.kernel.org to add your device to a proper driver.\n");
855 /* if this device type has a calc_num_ports function, call it */
856 if (type->calc_num_ports)
857 num_ports = type->calc_num_ports(serial);
859 num_ports = type->num_ports;
862 serial->num_ports = num_ports;
863 serial->num_bulk_in = num_bulk_in;
864 serial->num_bulk_out = num_bulk_out;
865 serial->num_interrupt_in = num_interrupt_in;
866 serial->num_interrupt_out = num_interrupt_out;
868 /* found all that we need */
869 dev_info(&interface->dev, "%s converter detected\n",
872 /* create our ports, we need as many as the max endpoints */
873 /* we don't use num_ports here because some devices have more
874 endpoint pairs than ports */
875 max_endpoints = max(num_bulk_in, num_bulk_out);
876 max_endpoints = max(max_endpoints, num_interrupt_in);
877 max_endpoints = max(max_endpoints, num_interrupt_out);
878 max_endpoints = max(max_endpoints, (int)serial->num_ports);
879 serial->num_port_pointers = max_endpoints;
881 dbg("%s - setting up %d port structures for this device",
882 __func__, max_endpoints);
883 for (i = 0; i < max_endpoints; ++i) {
884 port = kzalloc(sizeof(struct usb_serial_port), GFP_KERNEL);
887 tty_port_init(&port->port);
888 port->port.ops = &serial_port_ops;
889 port->serial = serial;
890 spin_lock_init(&port->lock);
891 /* Keep this for private driver use for the moment but
892 should probably go away */
893 INIT_WORK(&port->work, usb_serial_port_work);
894 serial->port[i] = port;
895 port->dev.parent = &interface->dev;
896 port->dev.driver = NULL;
897 port->dev.bus = &usb_serial_bus_type;
898 port->dev.release = &port_release;
899 device_initialize(&port->dev);
902 /* set up the endpoint information */
903 for (i = 0; i < num_bulk_in; ++i) {
904 endpoint = bulk_in_endpoint[i];
905 port = serial->port[i];
906 buffer_size = max_t(int, serial->type->bulk_in_size,
907 usb_endpoint_maxp(endpoint));
908 port->bulk_in_size = buffer_size;
909 port->bulk_in_endpointAddress = endpoint->bEndpointAddress;
911 for (j = 0; j < ARRAY_SIZE(port->read_urbs); ++j) {
912 set_bit(j, &port->read_urbs_free);
913 port->read_urbs[j] = usb_alloc_urb(0, GFP_KERNEL);
914 if (!port->read_urbs[j]) {
915 dev_err(&interface->dev,
916 "No free urbs available\n");
919 port->bulk_in_buffers[j] = kmalloc(buffer_size,
921 if (!port->bulk_in_buffers[j]) {
922 dev_err(&interface->dev,
923 "Couldn't allocate bulk_in_buffer\n");
926 usb_fill_bulk_urb(port->read_urbs[j], dev,
928 endpoint->bEndpointAddress),
929 port->bulk_in_buffers[j], buffer_size,
930 serial->type->read_bulk_callback,
934 port->read_urb = port->read_urbs[0];
935 port->bulk_in_buffer = port->bulk_in_buffers[0];
938 for (i = 0; i < num_bulk_out; ++i) {
939 endpoint = bulk_out_endpoint[i];
940 port = serial->port[i];
941 if (kfifo_alloc(&port->write_fifo, PAGE_SIZE, GFP_KERNEL))
943 buffer_size = serial->type->bulk_out_size;
945 buffer_size = usb_endpoint_maxp(endpoint);
946 port->bulk_out_size = buffer_size;
947 port->bulk_out_endpointAddress = endpoint->bEndpointAddress;
949 for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j) {
950 set_bit(j, &port->write_urbs_free);
951 port->write_urbs[j] = usb_alloc_urb(0, GFP_KERNEL);
952 if (!port->write_urbs[j]) {
953 dev_err(&interface->dev,
954 "No free urbs available\n");
957 port->bulk_out_buffers[j] = kmalloc(buffer_size,
959 if (!port->bulk_out_buffers[j]) {
960 dev_err(&interface->dev,
961 "Couldn't allocate bulk_out_buffer\n");
964 usb_fill_bulk_urb(port->write_urbs[j], dev,
966 endpoint->bEndpointAddress),
967 port->bulk_out_buffers[j], buffer_size,
968 serial->type->write_bulk_callback,
972 port->write_urb = port->write_urbs[0];
973 port->bulk_out_buffer = port->bulk_out_buffers[0];
976 if (serial->type->read_int_callback) {
977 for (i = 0; i < num_interrupt_in; ++i) {
978 endpoint = interrupt_in_endpoint[i];
979 port = serial->port[i];
980 port->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
981 if (!port->interrupt_in_urb) {
982 dev_err(&interface->dev,
983 "No free urbs available\n");
986 buffer_size = usb_endpoint_maxp(endpoint);
987 port->interrupt_in_endpointAddress =
988 endpoint->bEndpointAddress;
989 port->interrupt_in_buffer = kmalloc(buffer_size,
991 if (!port->interrupt_in_buffer) {
992 dev_err(&interface->dev,
993 "Couldn't allocate interrupt_in_buffer\n");
996 usb_fill_int_urb(port->interrupt_in_urb, dev,
998 endpoint->bEndpointAddress),
999 port->interrupt_in_buffer, buffer_size,
1000 serial->type->read_int_callback, port,
1001 endpoint->bInterval);
1003 } else if (num_interrupt_in) {
1004 dbg("the device claims to support interrupt in transfers, but read_int_callback is not defined");
1007 if (serial->type->write_int_callback) {
1008 for (i = 0; i < num_interrupt_out; ++i) {
1009 endpoint = interrupt_out_endpoint[i];
1010 port = serial->port[i];
1011 port->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
1012 if (!port->interrupt_out_urb) {
1013 dev_err(&interface->dev,
1014 "No free urbs available\n");
1017 buffer_size = usb_endpoint_maxp(endpoint);
1018 port->interrupt_out_size = buffer_size;
1019 port->interrupt_out_endpointAddress =
1020 endpoint->bEndpointAddress;
1021 port->interrupt_out_buffer = kmalloc(buffer_size,
1023 if (!port->interrupt_out_buffer) {
1024 dev_err(&interface->dev,
1025 "Couldn't allocate interrupt_out_buffer\n");
1028 usb_fill_int_urb(port->interrupt_out_urb, dev,
1030 endpoint->bEndpointAddress),
1031 port->interrupt_out_buffer, buffer_size,
1032 serial->type->write_int_callback, port,
1033 endpoint->bInterval);
1035 } else if (num_interrupt_out) {
1036 dbg("the device claims to support interrupt out transfers, but write_int_callback is not defined");
1039 usb_set_intfdata(interface, serial);
1041 /* if this device type has an attach function, call it */
1043 retval = type->attach(serial);
1046 serial->attached = 1;
1048 /* quietly accept this device, but don't bind to a
1049 serial port as it's about to disappear */
1050 serial->num_ports = 0;
1054 serial->attached = 1;
1057 /* Avoid race with tty_open and serial_install by setting the
1058 * disconnected flag and not clearing it until all ports have been
1061 serial->disconnected = 1;
1063 if (get_free_serial(serial, num_ports, &minor) == NULL) {
1064 dev_err(&interface->dev, "No more free serial devices\n");
1067 serial->minor = minor;
1069 /* register all of the individual ports with the driver core */
1070 for (i = 0; i < num_ports; ++i) {
1071 port = serial->port[i];
1072 dev_set_name(&port->dev, "ttyUSB%d", port->number);
1073 dbg ("%s - registering %s", __func__, dev_name(&port->dev));
1074 device_enable_async_suspend(&port->dev);
1076 retval = device_add(&port->dev);
1078 dev_err(&port->dev, "Error registering port device, "
1082 serial->disconnected = 0;
1084 usb_serial_console_init(debug, minor);
1086 module_put(type->driver.owner);
1090 usb_serial_put(serial);
1091 module_put(type->driver.owner);
1095 static void usb_serial_disconnect(struct usb_interface *interface)
1098 struct usb_serial *serial = usb_get_intfdata(interface);
1099 struct device *dev = &interface->dev;
1100 struct usb_serial_port *port;
1102 usb_serial_console_disconnect(serial);
1103 dbg("%s", __func__);
1105 mutex_lock(&serial->disc_mutex);
1106 /* must set a flag, to signal subdrivers */
1107 serial->disconnected = 1;
1108 mutex_unlock(&serial->disc_mutex);
1110 for (i = 0; i < serial->num_ports; ++i) {
1111 port = serial->port[i];
1113 struct tty_struct *tty = tty_port_tty_get(&port->port);
1119 cancel_work_sync(&port->work);
1120 if (device_is_registered(&port->dev))
1121 device_del(&port->dev);
1124 serial->type->disconnect(serial);
1126 /* let the last holder of this object cause it to be cleaned up */
1127 usb_serial_put(serial);
1128 dev_info(dev, "device disconnected\n");
1131 int usb_serial_suspend(struct usb_interface *intf, pm_message_t message)
1133 struct usb_serial *serial = usb_get_intfdata(intf);
1134 struct usb_serial_port *port;
1137 serial->suspending = 1;
1139 if (serial->type->suspend) {
1140 r = serial->type->suspend(serial, message);
1142 serial->suspending = 0;
1147 for (i = 0; i < serial->num_ports; ++i) {
1148 port = serial->port[i];
1156 EXPORT_SYMBOL(usb_serial_suspend);
1158 int usb_serial_resume(struct usb_interface *intf)
1160 struct usb_serial *serial = usb_get_intfdata(intf);
1163 serial->suspending = 0;
1164 if (serial->type->resume)
1165 rv = serial->type->resume(serial);
1167 rv = usb_serial_generic_resume(serial);
1171 EXPORT_SYMBOL(usb_serial_resume);
1173 static int usb_serial_reset_resume(struct usb_interface *intf)
1175 struct usb_serial *serial = usb_get_intfdata(intf);
1178 serial->suspending = 0;
1179 if (serial->type->reset_resume)
1180 rv = serial->type->reset_resume(serial);
1183 intf->needs_binding = 1;
1189 static const struct tty_operations serial_ops = {
1190 .open = serial_open,
1191 .close = serial_close,
1192 .write = serial_write,
1193 .hangup = serial_hangup,
1194 .write_room = serial_write_room,
1195 .ioctl = serial_ioctl,
1196 .set_termios = serial_set_termios,
1197 .throttle = serial_throttle,
1198 .unthrottle = serial_unthrottle,
1199 .break_ctl = serial_break,
1200 .chars_in_buffer = serial_chars_in_buffer,
1201 .tiocmget = serial_tiocmget,
1202 .tiocmset = serial_tiocmset,
1203 .get_icount = serial_get_icount,
1204 .cleanup = serial_cleanup,
1205 .install = serial_install,
1206 .proc_fops = &serial_proc_fops,
1210 struct tty_driver *usb_serial_tty_driver;
1212 /* Driver structure we register with the USB core */
1213 static struct usb_driver usb_serial_driver = {
1214 .name = "usbserial",
1215 .probe = usb_serial_probe,
1216 .disconnect = usb_serial_disconnect,
1217 .suspend = usb_serial_suspend,
1218 .resume = usb_serial_resume,
1220 .supports_autosuspend = 1,
1223 static int __init usb_serial_init(void)
1228 usb_serial_tty_driver = alloc_tty_driver(SERIAL_TTY_MINORS);
1229 if (!usb_serial_tty_driver)
1232 /* Initialize our global data */
1233 for (i = 0; i < SERIAL_TTY_MINORS; ++i)
1234 serial_table[i] = NULL;
1236 result = bus_register(&usb_serial_bus_type);
1238 printk(KERN_ERR "usb-serial: %s - registering bus driver "
1239 "failed\n", __func__);
1243 usb_serial_tty_driver->driver_name = "usbserial";
1244 usb_serial_tty_driver->name = "ttyUSB";
1245 usb_serial_tty_driver->major = SERIAL_TTY_MAJOR;
1246 usb_serial_tty_driver->minor_start = 0;
1247 usb_serial_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1248 usb_serial_tty_driver->subtype = SERIAL_TYPE_NORMAL;
1249 usb_serial_tty_driver->flags = TTY_DRIVER_REAL_RAW |
1250 TTY_DRIVER_DYNAMIC_DEV;
1251 usb_serial_tty_driver->init_termios = tty_std_termios;
1252 usb_serial_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD
1254 usb_serial_tty_driver->init_termios.c_ispeed = 9600;
1255 usb_serial_tty_driver->init_termios.c_ospeed = 9600;
1256 tty_set_operations(usb_serial_tty_driver, &serial_ops);
1257 result = tty_register_driver(usb_serial_tty_driver);
1259 printk(KERN_ERR "usb-serial: %s - tty_register_driver failed\n",
1261 goto exit_reg_driver;
1264 /* register the USB driver */
1265 result = usb_register(&usb_serial_driver);
1267 printk(KERN_ERR "usb-serial: %s - usb_register failed\n",
1272 /* register the generic driver, if we should */
1273 result = usb_serial_generic_register(debug);
1275 printk(KERN_ERR "usb-serial: %s - registering generic "
1276 "driver failed\n", __func__);
1280 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1285 usb_deregister(&usb_serial_driver);
1288 tty_unregister_driver(usb_serial_tty_driver);
1291 bus_unregister(&usb_serial_bus_type);
1294 printk(KERN_ERR "usb-serial: %s - returning with error %d\n",
1296 put_tty_driver(usb_serial_tty_driver);
1301 static void __exit usb_serial_exit(void)
1303 usb_serial_console_exit();
1305 usb_serial_generic_deregister();
1307 usb_deregister(&usb_serial_driver);
1308 tty_unregister_driver(usb_serial_tty_driver);
1309 put_tty_driver(usb_serial_tty_driver);
1310 bus_unregister(&usb_serial_bus_type);
1314 module_init(usb_serial_init);
1315 module_exit(usb_serial_exit);
1317 #define set_to_generic_if_null(type, function) \
1319 if (!type->function) { \
1320 type->function = usb_serial_generic_##function; \
1321 dbg("Had to override the " #function \
1322 " usb serial operation with the generic one.");\
1326 static void fixup_generic(struct usb_serial_driver *device)
1328 set_to_generic_if_null(device, open);
1329 set_to_generic_if_null(device, write);
1330 set_to_generic_if_null(device, close);
1331 set_to_generic_if_null(device, write_room);
1332 set_to_generic_if_null(device, chars_in_buffer);
1333 set_to_generic_if_null(device, read_bulk_callback);
1334 set_to_generic_if_null(device, write_bulk_callback);
1335 set_to_generic_if_null(device, disconnect);
1336 set_to_generic_if_null(device, release);
1337 set_to_generic_if_null(device, process_read_urb);
1338 set_to_generic_if_null(device, prepare_write_buffer);
1341 static int usb_serial_register(struct usb_serial_driver *driver)
1348 fixup_generic(driver);
1350 if (!driver->description)
1351 driver->description = driver->driver.name;
1352 if (!driver->usb_driver) {
1353 WARN(1, "Serial driver %s has no usb_driver\n",
1354 driver->description);
1358 /* Add this device to our list of devices */
1359 mutex_lock(&table_lock);
1360 list_add(&driver->driver_list, &usb_serial_driver_list);
1362 retval = usb_serial_bus_register(driver);
1364 printk(KERN_ERR "usb-serial: problem %d when registering "
1365 "driver %s\n", retval, driver->description);
1366 list_del(&driver->driver_list);
1368 printk(KERN_INFO "USB Serial support registered for %s\n",
1369 driver->description);
1371 mutex_unlock(&table_lock);
1375 static void usb_serial_deregister(struct usb_serial_driver *device)
1377 printk(KERN_INFO "USB Serial deregistering driver %s\n",
1378 device->description);
1379 mutex_lock(&table_lock);
1380 list_del(&device->driver_list);
1381 usb_serial_bus_deregister(device);
1382 mutex_unlock(&table_lock);
1386 * usb_serial_register_drivers - register drivers for a usb-serial module
1387 * @serial_drivers: NULL-terminated array of pointers to drivers to be registered
1388 * @name: name of the usb_driver for this set of @serial_drivers
1389 * @id_table: list of all devices this @serial_drivers set binds to
1391 * Registers all the drivers in the @serial_drivers array, and dynamically
1392 * creates a struct usb_driver with the name @name and id_table of @id_table.
1394 int usb_serial_register_drivers(struct usb_serial_driver *const serial_drivers[],
1396 const struct usb_device_id *id_table)
1399 struct usb_driver *udriver;
1400 struct usb_serial_driver * const *sd;
1403 * udriver must be registered before any of the serial drivers,
1404 * because the store_new_id() routine for the serial drivers (in
1405 * bus.c) probes udriver.
1407 * Performance hack: We don't want udriver to be probed until
1408 * the serial drivers are registered, because the probe would
1409 * simply fail for lack of a matching serial driver.
1410 * So we leave udriver's id_table set to NULL until we are all set.
1412 * Suspend/resume support is implemented in the usb-serial core,
1413 * so fill in the PM-related fields in udriver.
1415 udriver = kzalloc(sizeof(*udriver), GFP_KERNEL);
1419 udriver->name = name;
1420 udriver->no_dynamic_id = 1;
1421 udriver->supports_autosuspend = 1;
1422 udriver->suspend = usb_serial_suspend;
1423 udriver->resume = usb_serial_resume;
1424 udriver->probe = usb_serial_probe;
1425 udriver->disconnect = usb_serial_disconnect;
1427 /* we only set the reset_resume field if the serial_driver has one */
1428 for (sd = serial_drivers; *sd; ++sd) {
1429 if ((*sd)->reset_resume)
1430 udriver->reset_resume = usb_serial_reset_resume;
1434 rc = usb_register(udriver);
1438 for (sd = serial_drivers; *sd; ++sd) {
1439 (*sd)->usb_driver = udriver;
1440 rc = usb_serial_register(*sd);
1445 /* Now set udriver's id_table and look for matches */
1446 udriver->id_table = id_table;
1447 rc = driver_attach(&udriver->drvwrap.driver);
1451 while (sd-- > serial_drivers)
1452 usb_serial_deregister(*sd);
1453 usb_deregister(udriver);
1456 EXPORT_SYMBOL_GPL(usb_serial_register_drivers);
1459 * usb_serial_deregister_drivers - deregister drivers for a usb-serial module
1460 * @serial_drivers: NULL-terminated array of pointers to drivers to be deregistered
1462 * Deregisters all the drivers in the @serial_drivers array and deregisters and
1463 * frees the struct usb_driver that was created by the call to
1464 * usb_serial_register_drivers().
1466 void usb_serial_deregister_drivers(struct usb_serial_driver *const serial_drivers[])
1468 struct usb_driver *udriver = (*serial_drivers)->usb_driver;
1470 for (; *serial_drivers; ++serial_drivers)
1471 usb_serial_deregister(*serial_drivers);
1472 usb_deregister(udriver);
1475 EXPORT_SYMBOL_GPL(usb_serial_deregister_drivers);
1477 /* Module information */
1478 MODULE_AUTHOR(DRIVER_AUTHOR);
1479 MODULE_DESCRIPTION(DRIVER_DESC);
1480 MODULE_LICENSE("GPL");
1482 module_param(debug, bool, S_IRUGO | S_IWUSR);
1483 MODULE_PARM_DESC(debug, "Debug enabled or not");