2 * USB Serial Converter driver
4 * Copyright (C) 1999 - 2005 Greg Kroah-Hartman (greg@kroah.com)
5 * Copyright (C) 2000 Peter Berger (pberger@brimson.com)
6 * Copyright (C) 2000 Al Borchers (borchers@steinerpoint.com)
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version
10 * 2 as published by the Free Software Foundation.
12 * This driver was originally based on the ACM driver by Armin Fuerst (which was
13 * based on a driver by Brad Keryan)
15 * See Documentation/usb/usb-serial.txt for more information on using this
20 #include <linux/kernel.h>
21 #include <linux/errno.h>
22 #include <linux/init.h>
23 #include <linux/slab.h>
24 #include <linux/tty.h>
25 #include <linux/tty_driver.h>
26 #include <linux/tty_flip.h>
27 #include <linux/module.h>
28 #include <linux/moduleparam.h>
29 #include <linux/seq_file.h>
30 #include <linux/spinlock.h>
31 #include <linux/mutex.h>
32 #include <linux/list.h>
33 #include <linux/uaccess.h>
34 #include <linux/serial.h>
35 #include <linux/usb.h>
36 #include <linux/usb/serial.h>
37 #include <linux/kfifo.h>
43 #define DRIVER_AUTHOR "Greg Kroah-Hartman, greg@kroah.com, http://www.kroah.com/linux/"
44 #define DRIVER_DESC "USB Serial Driver core"
46 /* Driver structure we register with the USB core */
47 static struct usb_driver usb_serial_driver = {
49 .probe = usb_serial_probe,
50 .disconnect = usb_serial_disconnect,
51 .suspend = usb_serial_suspend,
52 .resume = usb_serial_resume,
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 if (serial->attached)
159 serial->type->release(serial);
161 /* Now that nothing is using the ports, they can be freed */
162 for (i = 0; i < serial->num_port_pointers; ++i) {
163 port = serial->port[i];
166 put_device(&port->dev);
170 usb_put_dev(serial->dev);
174 void usb_serial_put(struct usb_serial *serial)
176 kref_put(&serial->kref, destroy_serial);
179 /*****************************************************************************
180 * Driver tty interface functions
181 *****************************************************************************/
184 * serial_install - install tty
185 * @driver: the driver (USB in our case)
186 * @tty: the tty being created
188 * Create the termios objects for this tty. We use the default
189 * USB serial settings but permit them to be overridden by
190 * serial->type->init_termios.
192 * This is the first place a new tty gets used. Hence this is where we
193 * acquire references to the usb_serial structure and the driver module,
194 * where we store a pointer to the port, and where we do an autoresume.
195 * All these actions are reversed in serial_cleanup().
197 static int serial_install(struct tty_driver *driver, struct tty_struct *tty)
199 int idx = tty->index;
200 struct usb_serial *serial;
201 struct usb_serial_port *port;
202 int retval = -ENODEV;
206 serial = usb_serial_get_by_index(idx);
210 port = serial->port[idx - serial->minor];
213 if (!try_module_get(serial->type->driver.owner))
214 goto error_module_get;
216 /* perform the standard setup */
217 retval = tty_init_termios(tty);
219 goto error_init_termios;
221 retval = usb_autopm_get_interface(serial->interface);
223 goto error_get_interface;
225 mutex_unlock(&serial->disc_mutex);
227 /* allow the driver to update the settings */
228 if (serial->type->init_termios)
229 serial->type->init_termios(tty);
231 tty->driver_data = port;
233 /* Final install (we use the default method) */
234 tty_driver_kref_get(driver);
236 driver->ttys[idx] = tty;
241 module_put(serial->type->driver.owner);
244 usb_serial_put(serial);
245 mutex_unlock(&serial->disc_mutex);
249 static int serial_activate(struct tty_port *tport, struct tty_struct *tty)
251 struct usb_serial_port *port =
252 container_of(tport, struct usb_serial_port, port);
253 struct usb_serial *serial = port->serial;
256 mutex_lock(&serial->disc_mutex);
257 if (serial->disconnected)
260 retval = port->serial->type->open(tty, port);
261 mutex_unlock(&serial->disc_mutex);
265 static int serial_open(struct tty_struct *tty, struct file *filp)
267 struct usb_serial_port *port = tty->driver_data;
269 dbg("%s - port %d", __func__, port->number);
270 return tty_port_open(&port->port, tty, filp);
274 * serial_down - shut down hardware
275 * @tport: tty port to shut down
277 * Shut down a USB serial port unless it is the console. We never
278 * shut down the console hardware as it will always be in use. Serialized
279 * against activate by the tport mutex and kept to matching open/close pairs
280 * of calls by the ASYNCB_INITIALIZED flag.
282 static void serial_down(struct tty_port *tport)
284 struct usb_serial_port *port =
285 container_of(tport, struct usb_serial_port, port);
286 struct usb_serial_driver *drv = port->serial->type;
288 * The console is magical. Do not hang up the console hardware
289 * or there will be tears.
291 if (port->port.console)
297 static void serial_hangup(struct tty_struct *tty)
299 struct usb_serial_port *port = tty->driver_data;
300 dbg("%s - port %d", __func__, port->number);
301 tty_port_hangup(&port->port);
304 static void serial_close(struct tty_struct *tty, struct file *filp)
306 struct usb_serial_port *port = tty->driver_data;
307 dbg("%s - port %d", __func__, port->number);
308 tty_port_close(&port->port, tty, filp);
312 * serial_cleanup - free resources post close/hangup
313 * @port: port to free up
315 * Do the resource freeing and refcount dropping for the port.
316 * Avoid freeing the console.
318 * Called asynchronously after the last tty kref is dropped,
319 * and the tty layer has already done the tty_shutdown(tty);
321 static void serial_cleanup(struct tty_struct *tty)
323 struct usb_serial_port *port = tty->driver_data;
324 struct usb_serial *serial;
325 struct module *owner;
327 /* The console is magical. Do not hang up the console hardware
328 * or there will be tears.
330 if (port->port.console)
333 dbg("%s - port %d", __func__, port->number);
335 tty->driver_data = NULL;
337 serial = port->serial;
338 owner = serial->type->driver.owner;
340 mutex_lock(&serial->disc_mutex);
341 if (!serial->disconnected)
342 usb_autopm_put_interface(serial->interface);
343 mutex_unlock(&serial->disc_mutex);
345 usb_serial_put(serial);
349 static int serial_write(struct tty_struct *tty, const unsigned char *buf,
352 struct usb_serial_port *port = tty->driver_data;
353 int retval = -ENODEV;
355 if (port->serial->dev->state == USB_STATE_NOTATTACHED)
358 dbg("%s - port %d, %d byte(s)", __func__, port->number, count);
360 /* pass on to the driver specific version of this function */
361 retval = port->serial->type->write(tty, port, buf, count);
367 static int serial_write_room(struct tty_struct *tty)
369 struct usb_serial_port *port = tty->driver_data;
370 dbg("%s - port %d", __func__, port->number);
371 /* pass on to the driver specific version of this function */
372 return port->serial->type->write_room(tty);
375 static int serial_chars_in_buffer(struct tty_struct *tty)
377 struct usb_serial_port *port = tty->driver_data;
378 dbg("%s - port %d", __func__, port->number);
380 /* if the device was unplugged then any remaining characters
381 fell out of the connector ;) */
382 if (port->serial->disconnected)
384 /* pass on to the driver specific version of this function */
385 return port->serial->type->chars_in_buffer(tty);
388 static void serial_throttle(struct tty_struct *tty)
390 struct usb_serial_port *port = tty->driver_data;
391 dbg("%s - port %d", __func__, port->number);
393 /* pass on to the driver specific version of this function */
394 if (port->serial->type->throttle)
395 port->serial->type->throttle(tty);
398 static void serial_unthrottle(struct tty_struct *tty)
400 struct usb_serial_port *port = tty->driver_data;
401 dbg("%s - port %d", __func__, port->number);
403 /* pass on to the driver specific version of this function */
404 if (port->serial->type->unthrottle)
405 port->serial->type->unthrottle(tty);
408 static int serial_ioctl(struct tty_struct *tty, struct file *file,
409 unsigned int cmd, unsigned long arg)
411 struct usb_serial_port *port = tty->driver_data;
412 int retval = -ENODEV;
414 dbg("%s - port %d, cmd 0x%.4x", __func__, port->number, cmd);
416 /* pass on to the driver specific version of this function
417 if it is available */
418 if (port->serial->type->ioctl) {
419 retval = port->serial->type->ioctl(tty, file, cmd, arg);
421 retval = -ENOIOCTLCMD;
425 static void serial_set_termios(struct tty_struct *tty, struct ktermios *old)
427 struct usb_serial_port *port = tty->driver_data;
428 dbg("%s - port %d", __func__, port->number);
430 /* pass on to the driver specific version of this function
431 if it is available */
432 if (port->serial->type->set_termios)
433 port->serial->type->set_termios(tty, port, old);
435 tty_termios_copy_hw(tty->termios, old);
438 static int serial_break(struct tty_struct *tty, int break_state)
440 struct usb_serial_port *port = tty->driver_data;
442 dbg("%s - port %d", __func__, port->number);
444 /* pass on to the driver specific version of this function
445 if it is available */
446 if (port->serial->type->break_ctl)
447 port->serial->type->break_ctl(tty, break_state);
451 static int serial_proc_show(struct seq_file *m, void *v)
453 struct usb_serial *serial;
458 seq_puts(m, "usbserinfo:1.0 driver:2.0\n");
459 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
460 serial = usb_serial_get_by_index(i);
464 seq_printf(m, "%d:", i);
465 if (serial->type->driver.owner)
466 seq_printf(m, " module:%s",
467 module_name(serial->type->driver.owner));
468 seq_printf(m, " name:\"%s\"",
469 serial->type->description);
470 seq_printf(m, " vendor:%04x product:%04x",
471 le16_to_cpu(serial->dev->descriptor.idVendor),
472 le16_to_cpu(serial->dev->descriptor.idProduct));
473 seq_printf(m, " num_ports:%d", serial->num_ports);
474 seq_printf(m, " port:%d", i - serial->minor + 1);
475 usb_make_path(serial->dev, tmp, sizeof(tmp));
476 seq_printf(m, " path:%s", tmp);
479 usb_serial_put(serial);
480 mutex_unlock(&serial->disc_mutex);
485 static int serial_proc_open(struct inode *inode, struct file *file)
487 return single_open(file, serial_proc_show, NULL);
490 static const struct file_operations serial_proc_fops = {
491 .owner = THIS_MODULE,
492 .open = serial_proc_open,
495 .release = single_release,
498 static int serial_tiocmget(struct tty_struct *tty, struct file *file)
500 struct usb_serial_port *port = tty->driver_data;
502 dbg("%s - port %d", __func__, port->number);
504 if (port->serial->type->tiocmget)
505 return port->serial->type->tiocmget(tty, file);
509 static int serial_tiocmset(struct tty_struct *tty, struct file *file,
510 unsigned int set, unsigned int clear)
512 struct usb_serial_port *port = tty->driver_data;
514 dbg("%s - port %d", __func__, port->number);
516 if (port->serial->type->tiocmset)
517 return port->serial->type->tiocmset(tty, file, set, clear);
521 static int serial_get_icount(struct tty_struct *tty,
522 struct serial_icounter_struct *icount)
524 struct usb_serial_port *port = tty->driver_data;
526 dbg("%s - port %d", __func__, port->number);
528 if (port->serial->type->get_icount)
529 return port->serial->type->get_icount(tty, icount);
534 * We would be calling tty_wakeup here, but unfortunately some line
535 * disciplines have an annoying habit of calling tty->write from
536 * the write wakeup callback (e.g. n_hdlc.c).
538 void usb_serial_port_softint(struct usb_serial_port *port)
540 schedule_work(&port->work);
542 EXPORT_SYMBOL_GPL(usb_serial_port_softint);
544 static void usb_serial_port_work(struct work_struct *work)
546 struct usb_serial_port *port =
547 container_of(work, struct usb_serial_port, work);
548 struct tty_struct *tty;
550 dbg("%s - port %d", __func__, port->number);
552 tty = tty_port_tty_get(&port->port);
560 static void kill_traffic(struct usb_serial_port *port)
564 usb_kill_urb(port->read_urb);
565 usb_kill_urb(port->write_urb);
566 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
567 usb_kill_urb(port->write_urbs[i]);
570 * Some drivers submit the read_urb in the
571 * handler for the write_urb or vice versa
572 * this order determines the order in which
573 * usb_kill_urb() must be used to reliably
574 * kill the URBs. As it is unknown here,
575 * both orders must be used in turn.
576 * The call below is not redundant.
578 usb_kill_urb(port->read_urb);
579 usb_kill_urb(port->interrupt_in_urb);
580 usb_kill_urb(port->interrupt_out_urb);
583 static void port_release(struct device *dev)
585 struct usb_serial_port *port = to_usb_serial_port(dev);
588 dbg ("%s - %s", __func__, dev_name(dev));
591 * Stop all the traffic before cancelling the work, so that
592 * nobody will restart it by calling usb_serial_port_softint.
595 cancel_work_sync(&port->work);
597 usb_free_urb(port->read_urb);
598 usb_free_urb(port->write_urb);
599 usb_free_urb(port->interrupt_in_urb);
600 usb_free_urb(port->interrupt_out_urb);
601 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i) {
602 usb_free_urb(port->write_urbs[i]);
603 kfree(port->bulk_out_buffers[i]);
605 kfifo_free(&port->write_fifo);
606 kfree(port->bulk_in_buffer);
607 kfree(port->bulk_out_buffer);
608 kfree(port->interrupt_in_buffer);
609 kfree(port->interrupt_out_buffer);
613 static struct usb_serial *create_serial(struct usb_device *dev,
614 struct usb_interface *interface,
615 struct usb_serial_driver *driver)
617 struct usb_serial *serial;
619 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
621 dev_err(&dev->dev, "%s - out of memory\n", __func__);
624 serial->dev = usb_get_dev(dev);
625 serial->type = driver;
626 serial->interface = interface;
627 kref_init(&serial->kref);
628 mutex_init(&serial->disc_mutex);
629 serial->minor = SERIAL_TTY_NO_MINOR;
634 static const struct usb_device_id *match_dynamic_id(struct usb_interface *intf,
635 struct usb_serial_driver *drv)
637 struct usb_dynid *dynid;
639 spin_lock(&drv->dynids.lock);
640 list_for_each_entry(dynid, &drv->dynids.list, node) {
641 if (usb_match_one_id(intf, &dynid->id)) {
642 spin_unlock(&drv->dynids.lock);
646 spin_unlock(&drv->dynids.lock);
650 static const struct usb_device_id *get_iface_id(struct usb_serial_driver *drv,
651 struct usb_interface *intf)
653 const struct usb_device_id *id;
655 id = usb_match_id(intf, drv->id_table);
657 dbg("static descriptor matches");
660 id = match_dynamic_id(intf, drv);
662 dbg("dynamic descriptor matches");
667 /* Caller must hold table_lock */
668 static struct usb_serial_driver *search_serial_device(
669 struct usb_interface *iface)
671 const struct usb_device_id *id;
672 struct usb_serial_driver *drv;
674 /* Check if the usb id matches a known device */
675 list_for_each_entry(drv, &usb_serial_driver_list, driver_list) {
676 id = get_iface_id(drv, iface);
684 static int serial_carrier_raised(struct tty_port *port)
686 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
687 struct usb_serial_driver *drv = p->serial->type;
688 if (drv->carrier_raised)
689 return drv->carrier_raised(p);
690 /* No carrier control - don't block */
694 static void serial_dtr_rts(struct tty_port *port, int on)
696 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
697 struct usb_serial_driver *drv = p->serial->type;
702 static const struct tty_port_operations serial_port_ops = {
703 .carrier_raised = serial_carrier_raised,
704 .dtr_rts = serial_dtr_rts,
705 .activate = serial_activate,
706 .shutdown = serial_down,
709 int usb_serial_probe(struct usb_interface *interface,
710 const struct usb_device_id *id)
712 struct usb_device *dev = interface_to_usbdev(interface);
713 struct usb_serial *serial = NULL;
714 struct usb_serial_port *port;
715 struct usb_host_interface *iface_desc;
716 struct usb_endpoint_descriptor *endpoint;
717 struct usb_endpoint_descriptor *interrupt_in_endpoint[MAX_NUM_PORTS];
718 struct usb_endpoint_descriptor *interrupt_out_endpoint[MAX_NUM_PORTS];
719 struct usb_endpoint_descriptor *bulk_in_endpoint[MAX_NUM_PORTS];
720 struct usb_endpoint_descriptor *bulk_out_endpoint[MAX_NUM_PORTS];
721 struct usb_serial_driver *type = NULL;
726 int num_interrupt_in = 0;
727 int num_interrupt_out = 0;
729 int num_bulk_out = 0;
733 mutex_lock(&table_lock);
734 type = search_serial_device(interface);
736 mutex_unlock(&table_lock);
741 if (!try_module_get(type->driver.owner)) {
742 mutex_unlock(&table_lock);
743 dev_err(&interface->dev, "module get failed, exiting\n");
746 mutex_unlock(&table_lock);
748 serial = create_serial(dev, interface, type);
750 module_put(type->driver.owner);
751 dev_err(&interface->dev, "%s - out of memory\n", __func__);
755 /* if this device type has a probe function, call it */
757 const struct usb_device_id *id;
759 id = get_iface_id(type, interface);
760 retval = type->probe(serial, id);
763 dbg("sub driver rejected device");
765 module_put(type->driver.owner);
770 /* descriptor matches, let's find the endpoints needed */
771 /* check out the endpoints */
772 iface_desc = interface->cur_altsetting;
773 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
774 endpoint = &iface_desc->endpoint[i].desc;
776 if (usb_endpoint_is_bulk_in(endpoint)) {
777 /* we found a bulk in endpoint */
778 dbg("found bulk in on endpoint %d", i);
779 bulk_in_endpoint[num_bulk_in] = endpoint;
783 if (usb_endpoint_is_bulk_out(endpoint)) {
784 /* we found a bulk out endpoint */
785 dbg("found bulk out on endpoint %d", i);
786 bulk_out_endpoint[num_bulk_out] = endpoint;
790 if (usb_endpoint_is_int_in(endpoint)) {
791 /* we found a interrupt in endpoint */
792 dbg("found interrupt in on endpoint %d", i);
793 interrupt_in_endpoint[num_interrupt_in] = endpoint;
797 if (usb_endpoint_is_int_out(endpoint)) {
798 /* we found an interrupt out endpoint */
799 dbg("found interrupt out on endpoint %d", i);
800 interrupt_out_endpoint[num_interrupt_out] = endpoint;
805 #if defined(CONFIG_USB_SERIAL_PL2303) || defined(CONFIG_USB_SERIAL_PL2303_MODULE)
806 /* BEGIN HORRIBLE HACK FOR PL2303 */
807 /* this is needed due to the looney way its endpoints are set up */
808 if (((le16_to_cpu(dev->descriptor.idVendor) == PL2303_VENDOR_ID) &&
809 (le16_to_cpu(dev->descriptor.idProduct) == PL2303_PRODUCT_ID)) ||
810 ((le16_to_cpu(dev->descriptor.idVendor) == ATEN_VENDOR_ID) &&
811 (le16_to_cpu(dev->descriptor.idProduct) == ATEN_PRODUCT_ID)) ||
812 ((le16_to_cpu(dev->descriptor.idVendor) == ALCOR_VENDOR_ID) &&
813 (le16_to_cpu(dev->descriptor.idProduct) == ALCOR_PRODUCT_ID)) ||
814 ((le16_to_cpu(dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
815 (le16_to_cpu(dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_EF81))) {
816 if (interface != dev->actconfig->interface[0]) {
817 /* check out the endpoints of the other interface*/
818 iface_desc = dev->actconfig->interface[0]->cur_altsetting;
819 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
820 endpoint = &iface_desc->endpoint[i].desc;
821 if (usb_endpoint_is_int_in(endpoint)) {
822 /* we found a interrupt in endpoint */
823 dbg("found interrupt in for Prolific device on separate interface");
824 interrupt_in_endpoint[num_interrupt_in] = endpoint;
830 /* Now make sure the PL-2303 is configured correctly.
831 * If not, give up now and hope this hack will work
832 * properly during a later invocation of usb_serial_probe
834 if (num_bulk_in == 0 || num_bulk_out == 0) {
835 dev_info(&interface->dev, "PL-2303 hack: descriptors matched but endpoints did not\n");
837 module_put(type->driver.owner);
841 /* END HORRIBLE HACK FOR PL2303 */
844 #ifdef CONFIG_USB_SERIAL_GENERIC
845 if (type == &usb_serial_generic_device) {
846 num_ports = num_bulk_out;
847 if (num_ports == 0) {
848 dev_err(&interface->dev,
849 "Generic device with no bulk out, not allowed.\n");
851 module_put(type->driver.owner);
857 /* if this device type has a calc_num_ports function, call it */
858 if (type->calc_num_ports)
859 num_ports = type->calc_num_ports(serial);
861 num_ports = type->num_ports;
864 serial->num_ports = num_ports;
865 serial->num_bulk_in = num_bulk_in;
866 serial->num_bulk_out = num_bulk_out;
867 serial->num_interrupt_in = num_interrupt_in;
868 serial->num_interrupt_out = num_interrupt_out;
870 /* found all that we need */
871 dev_info(&interface->dev, "%s converter detected\n",
874 /* create our ports, we need as many as the max endpoints */
875 /* we don't use num_ports here because some devices have more
876 endpoint pairs than ports */
877 max_endpoints = max(num_bulk_in, num_bulk_out);
878 max_endpoints = max(max_endpoints, num_interrupt_in);
879 max_endpoints = max(max_endpoints, num_interrupt_out);
880 max_endpoints = max(max_endpoints, (int)serial->num_ports);
881 serial->num_port_pointers = max_endpoints;
883 dbg("%s - setting up %d port structures for this device",
884 __func__, max_endpoints);
885 for (i = 0; i < max_endpoints; ++i) {
886 port = kzalloc(sizeof(struct usb_serial_port), GFP_KERNEL);
889 tty_port_init(&port->port);
890 port->port.ops = &serial_port_ops;
891 port->serial = serial;
892 spin_lock_init(&port->lock);
893 /* Keep this for private driver use for the moment but
894 should probably go away */
895 INIT_WORK(&port->work, usb_serial_port_work);
896 serial->port[i] = port;
897 port->dev.parent = &interface->dev;
898 port->dev.driver = NULL;
899 port->dev.bus = &usb_serial_bus_type;
900 port->dev.release = &port_release;
901 device_initialize(&port->dev);
904 /* set up the endpoint information */
905 for (i = 0; i < num_bulk_in; ++i) {
906 endpoint = bulk_in_endpoint[i];
907 port = serial->port[i];
908 port->read_urb = usb_alloc_urb(0, GFP_KERNEL);
909 if (!port->read_urb) {
910 dev_err(&interface->dev, "No free urbs available\n");
913 buffer_size = serial->type->bulk_in_size;
915 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
916 port->bulk_in_size = buffer_size;
917 port->bulk_in_endpointAddress = endpoint->bEndpointAddress;
918 port->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
919 if (!port->bulk_in_buffer) {
920 dev_err(&interface->dev,
921 "Couldn't allocate bulk_in_buffer\n");
924 usb_fill_bulk_urb(port->read_urb, dev,
926 endpoint->bEndpointAddress),
927 port->bulk_in_buffer, buffer_size,
928 serial->type->read_bulk_callback, port);
931 for (i = 0; i < num_bulk_out; ++i) {
934 endpoint = bulk_out_endpoint[i];
935 port = serial->port[i];
936 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
937 if (!port->write_urb) {
938 dev_err(&interface->dev, "No free urbs available\n");
941 if (kfifo_alloc(&port->write_fifo, PAGE_SIZE, GFP_KERNEL))
943 buffer_size = serial->type->bulk_out_size;
945 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
946 port->bulk_out_size = buffer_size;
947 port->bulk_out_endpointAddress = endpoint->bEndpointAddress;
948 port->bulk_out_buffer = kmalloc(buffer_size, GFP_KERNEL);
949 if (!port->bulk_out_buffer) {
950 dev_err(&interface->dev,
951 "Couldn't allocate bulk_out_buffer\n");
954 usb_fill_bulk_urb(port->write_urb, dev,
956 endpoint->bEndpointAddress),
957 port->bulk_out_buffer, buffer_size,
958 serial->type->write_bulk_callback, port);
959 for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j) {
960 set_bit(j, &port->write_urbs_free);
961 port->write_urbs[j] = usb_alloc_urb(0, GFP_KERNEL);
962 if (!port->write_urbs[j]) {
963 dev_err(&interface->dev,
964 "No free urbs available\n");
967 port->bulk_out_buffers[j] = kmalloc(buffer_size,
969 if (!port->bulk_out_buffers[j]) {
970 dev_err(&interface->dev,
971 "Couldn't allocate bulk_out_buffer\n");
974 usb_fill_bulk_urb(port->write_urbs[j], dev,
976 endpoint->bEndpointAddress),
977 port->bulk_out_buffers[j], buffer_size,
978 serial->type->write_bulk_callback,
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 retval = type->attach(serial);
1051 serial->attached = 1;
1053 /* quietly accept this device, but don't bind to a
1054 serial port as it's about to disappear */
1055 serial->num_ports = 0;
1059 serial->attached = 1;
1062 if (get_free_serial(serial, num_ports, &minor) == NULL) {
1063 dev_err(&interface->dev, "No more free serial devices\n");
1066 serial->minor = minor;
1068 /* register all of the individual ports with the driver core */
1069 for (i = 0; i < num_ports; ++i) {
1070 port = serial->port[i];
1071 dev_set_name(&port->dev, "ttyUSB%d", port->number);
1072 dbg ("%s - registering %s", __func__, dev_name(&port->dev));
1073 port->dev_state = PORT_REGISTERING;
1074 device_enable_async_suspend(&port->dev);
1076 retval = device_add(&port->dev);
1078 dev_err(&port->dev, "Error registering port device, "
1080 port->dev_state = PORT_UNREGISTERED;
1082 port->dev_state = PORT_REGISTERED;
1086 usb_serial_console_init(debug, minor);
1090 usb_set_intfdata(interface, serial);
1091 module_put(type->driver.owner);
1095 usb_serial_put(serial);
1096 module_put(type->driver.owner);
1099 EXPORT_SYMBOL_GPL(usb_serial_probe);
1101 void usb_serial_disconnect(struct usb_interface *interface)
1104 struct usb_serial *serial = usb_get_intfdata(interface);
1105 struct device *dev = &interface->dev;
1106 struct usb_serial_port *port;
1108 usb_serial_console_disconnect(serial);
1109 dbg("%s", __func__);
1111 mutex_lock(&serial->disc_mutex);
1112 usb_set_intfdata(interface, NULL);
1113 /* must set a flag, to signal subdrivers */
1114 serial->disconnected = 1;
1115 mutex_unlock(&serial->disc_mutex);
1117 for (i = 0; i < serial->num_ports; ++i) {
1118 port = serial->port[i];
1120 struct tty_struct *tty = tty_port_tty_get(&port->port);
1126 cancel_work_sync(&port->work);
1127 if (port->dev_state == PORT_REGISTERED) {
1129 /* Make sure the port is bound so that the
1130 * driver's port_remove method is called.
1132 if (!port->dev.driver) {
1136 &serial->type->driver;
1137 rc = device_bind_driver(&port->dev);
1139 port->dev_state = PORT_UNREGISTERING;
1140 device_del(&port->dev);
1141 port->dev_state = PORT_UNREGISTERED;
1145 serial->type->disconnect(serial);
1147 /* let the last holder of this object cause it to be cleaned up */
1148 usb_serial_put(serial);
1149 dev_info(dev, "device disconnected\n");
1151 EXPORT_SYMBOL_GPL(usb_serial_disconnect);
1153 int usb_serial_suspend(struct usb_interface *intf, pm_message_t message)
1155 struct usb_serial *serial = usb_get_intfdata(intf);
1156 struct usb_serial_port *port;
1159 serial->suspending = 1;
1161 if (serial->type->suspend) {
1162 r = serial->type->suspend(serial, message);
1164 serial->suspending = 0;
1169 for (i = 0; i < serial->num_ports; ++i) {
1170 port = serial->port[i];
1178 EXPORT_SYMBOL(usb_serial_suspend);
1180 int usb_serial_resume(struct usb_interface *intf)
1182 struct usb_serial *serial = usb_get_intfdata(intf);
1185 serial->suspending = 0;
1186 if (serial->type->resume)
1187 rv = serial->type->resume(serial);
1189 rv = usb_serial_generic_resume(serial);
1193 EXPORT_SYMBOL(usb_serial_resume);
1195 static const struct tty_operations serial_ops = {
1196 .open = serial_open,
1197 .close = serial_close,
1198 .write = serial_write,
1199 .hangup = serial_hangup,
1200 .write_room = serial_write_room,
1201 .ioctl = serial_ioctl,
1202 .set_termios = serial_set_termios,
1203 .throttle = serial_throttle,
1204 .unthrottle = serial_unthrottle,
1205 .break_ctl = serial_break,
1206 .chars_in_buffer = serial_chars_in_buffer,
1207 .tiocmget = serial_tiocmget,
1208 .tiocmset = serial_tiocmset,
1209 .get_icount = serial_get_icount,
1210 .cleanup = serial_cleanup,
1211 .install = serial_install,
1212 .proc_fops = &serial_proc_fops,
1216 struct tty_driver *usb_serial_tty_driver;
1218 static int __init usb_serial_init(void)
1223 usb_serial_tty_driver = alloc_tty_driver(SERIAL_TTY_MINORS);
1224 if (!usb_serial_tty_driver)
1227 /* Initialize our global data */
1228 for (i = 0; i < SERIAL_TTY_MINORS; ++i)
1229 serial_table[i] = NULL;
1231 result = bus_register(&usb_serial_bus_type);
1233 printk(KERN_ERR "usb-serial: %s - registering bus driver "
1234 "failed\n", __func__);
1238 usb_serial_tty_driver->owner = THIS_MODULE;
1239 usb_serial_tty_driver->driver_name = "usbserial";
1240 usb_serial_tty_driver->name = "ttyUSB";
1241 usb_serial_tty_driver->major = SERIAL_TTY_MAJOR;
1242 usb_serial_tty_driver->minor_start = 0;
1243 usb_serial_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1244 usb_serial_tty_driver->subtype = SERIAL_TYPE_NORMAL;
1245 usb_serial_tty_driver->flags = TTY_DRIVER_REAL_RAW |
1246 TTY_DRIVER_DYNAMIC_DEV;
1247 usb_serial_tty_driver->init_termios = tty_std_termios;
1248 usb_serial_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD
1250 usb_serial_tty_driver->init_termios.c_ispeed = 9600;
1251 usb_serial_tty_driver->init_termios.c_ospeed = 9600;
1252 tty_set_operations(usb_serial_tty_driver, &serial_ops);
1253 result = tty_register_driver(usb_serial_tty_driver);
1255 printk(KERN_ERR "usb-serial: %s - tty_register_driver failed\n",
1257 goto exit_reg_driver;
1260 /* register the USB driver */
1261 result = usb_register(&usb_serial_driver);
1263 printk(KERN_ERR "usb-serial: %s - usb_register failed\n",
1268 /* register the generic driver, if we should */
1269 result = usb_serial_generic_register(debug);
1271 printk(KERN_ERR "usb-serial: %s - registering generic "
1272 "driver failed\n", __func__);
1276 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1281 usb_deregister(&usb_serial_driver);
1284 tty_unregister_driver(usb_serial_tty_driver);
1287 bus_unregister(&usb_serial_bus_type);
1290 printk(KERN_ERR "usb-serial: %s - returning with error %d\n",
1292 put_tty_driver(usb_serial_tty_driver);
1297 static void __exit usb_serial_exit(void)
1299 usb_serial_console_exit();
1301 usb_serial_generic_deregister();
1303 usb_deregister(&usb_serial_driver);
1304 tty_unregister_driver(usb_serial_tty_driver);
1305 put_tty_driver(usb_serial_tty_driver);
1306 bus_unregister(&usb_serial_bus_type);
1310 module_init(usb_serial_init);
1311 module_exit(usb_serial_exit);
1313 #define set_to_generic_if_null(type, function) \
1315 if (!type->function) { \
1316 type->function = usb_serial_generic_##function; \
1317 dbg("Had to override the " #function \
1318 " usb serial operation with the generic one.");\
1322 static void fixup_generic(struct usb_serial_driver *device)
1324 set_to_generic_if_null(device, open);
1325 set_to_generic_if_null(device, write);
1326 set_to_generic_if_null(device, close);
1327 set_to_generic_if_null(device, write_room);
1328 set_to_generic_if_null(device, chars_in_buffer);
1329 set_to_generic_if_null(device, read_bulk_callback);
1330 set_to_generic_if_null(device, write_bulk_callback);
1331 set_to_generic_if_null(device, disconnect);
1332 set_to_generic_if_null(device, release);
1333 set_to_generic_if_null(device, process_read_urb);
1334 set_to_generic_if_null(device, prepare_write_buffer);
1337 int usb_serial_register(struct usb_serial_driver *driver)
1339 /* must be called with BKL held */
1345 fixup_generic(driver);
1347 if (!driver->description)
1348 driver->description = driver->driver.name;
1350 /* Add this device to our list of devices */
1351 mutex_lock(&table_lock);
1352 list_add(&driver->driver_list, &usb_serial_driver_list);
1354 retval = usb_serial_bus_register(driver);
1356 printk(KERN_ERR "usb-serial: problem %d when registering "
1357 "driver %s\n", retval, driver->description);
1358 list_del(&driver->driver_list);
1360 printk(KERN_INFO "USB Serial support registered for %s\n",
1361 driver->description);
1363 mutex_unlock(&table_lock);
1366 EXPORT_SYMBOL_GPL(usb_serial_register);
1369 void usb_serial_deregister(struct usb_serial_driver *device)
1371 /* must be called with BKL held */
1372 printk(KERN_INFO "USB Serial deregistering driver %s\n",
1373 device->description);
1374 mutex_lock(&table_lock);
1375 list_del(&device->driver_list);
1376 usb_serial_bus_deregister(device);
1377 mutex_unlock(&table_lock);
1379 EXPORT_SYMBOL_GPL(usb_serial_deregister);
1381 /* Module information */
1382 MODULE_AUTHOR(DRIVER_AUTHOR);
1383 MODULE_DESCRIPTION(DRIVER_DESC);
1384 MODULE_LICENSE("GPL");
1386 module_param(debug, bool, S_IRUGO | S_IWUSR);
1387 MODULE_PARM_DESC(debug, "Debug enabled or not");