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/usb.h>
36 #include <linux/usb/serial.h>
42 #define DRIVER_AUTHOR "Greg Kroah-Hartman, greg@kroah.com, http://www.kroah.com/linux/"
43 #define DRIVER_DESC "USB Serial Driver core"
45 static void port_free(struct usb_serial_port *port);
47 /* Driver structure we register with the USB core */
48 static struct usb_driver usb_serial_driver = {
50 .probe = usb_serial_probe,
51 .disconnect = usb_serial_disconnect,
52 .suspend = usb_serial_suspend,
53 .resume = usb_serial_resume,
57 /* There is no MODULE_DEVICE_TABLE for usbserial.c. Instead
58 the MODULE_DEVICE_TABLE declarations in each serial driver
59 cause the "hotplug" program to pull in whatever module is necessary
60 via modprobe, and modprobe will load usbserial because the serial
65 /* initially all NULL */
66 static struct usb_serial *serial_table[SERIAL_TTY_MINORS];
67 static DEFINE_MUTEX(table_lock);
68 static LIST_HEAD(usb_serial_driver_list);
70 struct usb_serial *usb_serial_get_by_index(unsigned index)
72 struct usb_serial *serial;
74 mutex_lock(&table_lock);
75 serial = serial_table[index];
78 kref_get(&serial->kref);
79 mutex_unlock(&table_lock);
83 static struct usb_serial *get_free_serial(struct usb_serial *serial,
84 int num_ports, unsigned int *minor)
89 dbg("%s %d", __func__, num_ports);
92 mutex_lock(&table_lock);
93 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
98 for (j = 1; j <= num_ports-1; ++j)
99 if ((i+j >= SERIAL_TTY_MINORS) || (serial_table[i+j])) {
109 dbg("%s - minor base = %d", __func__, *minor);
110 for (i = *minor; (i < (*minor + num_ports)) && (i < SERIAL_TTY_MINORS); ++i) {
111 serial_table[i] = serial;
112 serial->port[j++]->number = i;
114 mutex_unlock(&table_lock);
117 mutex_unlock(&table_lock);
121 static void return_serial(struct usb_serial *serial)
127 for (i = 0; i < serial->num_ports; ++i)
128 serial_table[serial->minor + i] = NULL;
131 static void destroy_serial(struct kref *kref)
133 struct usb_serial *serial;
134 struct usb_serial_port *port;
137 serial = to_usb_serial(kref);
139 dbg("%s - %s", __func__, serial->type->description);
141 /* return the minor range that this device had */
142 if (serial->minor != SERIAL_TTY_NO_MINOR)
143 return_serial(serial);
145 serial->type->release(serial);
147 for (i = 0; i < serial->num_ports; ++i) {
148 port = serial->port[i];
150 put_device(&port->dev);
153 /* If this is a "fake" port, we have to clean it up here, as it will
154 * not get cleaned up in port_release() as it was never registered with
156 if (serial->num_ports < serial->num_port_pointers) {
157 for (i = serial->num_ports;
158 i < serial->num_port_pointers; ++i) {
159 port = serial->port[i];
165 usb_put_dev(serial->dev);
167 /* free up any memory that we allocated */
171 void usb_serial_put(struct usb_serial *serial)
173 mutex_lock(&table_lock);
174 kref_put(&serial->kref, destroy_serial);
175 mutex_unlock(&table_lock);
178 /*****************************************************************************
179 * Driver tty interface functions
180 *****************************************************************************/
181 static int serial_open (struct tty_struct *tty, struct file *filp)
183 struct usb_serial *serial;
184 struct usb_serial_port *port;
185 unsigned int portNumber;
190 /* get the serial object associated with this tty pointer */
191 serial = usb_serial_get_by_index(tty->index);
193 tty->driver_data = NULL;
197 mutex_lock(&serial->disc_mutex);
198 portNumber = tty->index - serial->minor;
199 port = serial->port[portNumber];
200 if (!port || serial->disconnected)
203 get_device(&port->dev);
205 * Note: Our locking order requirement does not allow port->mutex
206 * to be acquired while serial->disc_mutex is held.
208 mutex_unlock(&serial->disc_mutex);
210 goto bailout_serial_put;
212 if (mutex_lock_interruptible(&port->mutex)) {
213 retval = -ERESTARTSYS;
214 goto bailout_port_put;
219 /* set up our port structure making the tty driver
220 * remember our port object, and us it */
221 tty->driver_data = port;
222 tty_port_tty_set(&port->port, tty);
224 /* If the console is attached, the device is already open */
225 if (port->port.count == 1 && !port->console) {
227 /* lock this module before we call it
228 * this may fail, which means we must bail out,
229 * safe because we are called with BKL held */
230 if (!try_module_get(serial->type->driver.owner)) {
232 goto bailout_mutex_unlock;
235 mutex_lock(&serial->disc_mutex);
236 if (serial->disconnected)
239 retval = usb_autopm_get_interface(serial->interface);
241 goto bailout_module_put;
243 /* only call the device specific open if this
244 * is the first time the port is opened */
245 retval = serial->type->open(tty, port, filp);
247 goto bailout_interface_put;
248 mutex_unlock(&serial->disc_mutex);
250 mutex_unlock(&port->mutex);
251 /* Now do the correct tty layer semantics */
252 retval = tty_port_block_til_ready(&port->port, tty, filp);
256 bailout_interface_put:
257 usb_autopm_put_interface(serial->interface);
259 mutex_unlock(&serial->disc_mutex);
260 module_put(serial->type->driver.owner);
261 bailout_mutex_unlock:
262 port->port.count = 0;
263 tty->driver_data = NULL;
264 tty_port_tty_set(&port->port, NULL);
265 mutex_unlock(&port->mutex);
267 put_device(&port->dev);
269 usb_serial_put(serial);
274 * serial_do_down - shut down hardware
275 * @port: port to shut down
277 * Shut down a USB port unless it is the console. We never shut down the
278 * console hardware as it will always be in use.
280 * Don't free any resources at this point
282 static void serial_do_down(struct usb_serial_port *port)
284 struct usb_serial_driver *drv = port->serial->type;
285 struct usb_serial *serial;
286 struct module *owner;
288 /* The console is magical, do not hang up the console hardware
289 or there will be tears */
293 mutex_lock(&port->mutex);
294 serial = port->serial;
295 owner = serial->type->driver.owner;
300 mutex_unlock(&port->mutex);
304 * serial_do_free - free resources post close/hangup
305 * @port: port to free up
307 * Do the resource freeing and refcount dropping for the port. We must
308 * be careful about ordering and we must avoid freeing up the console.
311 static void serial_do_free(struct usb_serial_port *port)
313 struct usb_serial *serial;
314 struct module *owner;
316 /* The console is magical, do not hang up the console hardware
317 or there will be tears */
321 serial = port->serial;
322 owner = serial->type->driver.owner;
323 put_device(&port->dev);
324 /* Mustn't dereference port any more */
325 mutex_lock(&serial->disc_mutex);
326 if (!serial->disconnected)
327 usb_autopm_put_interface(serial->interface);
328 mutex_unlock(&serial->disc_mutex);
329 usb_serial_put(serial);
330 /* Mustn't dereference serial any more */
334 static void serial_close(struct tty_struct *tty, struct file *filp)
336 struct usb_serial_port *port = tty->driver_data;
341 dbg("%s - port %d", __func__, port->number);
344 This leaves a very narrow race. Really we should do the
345 serial_do_free() on tty->shutdown(), but tty->shutdown can
346 be called from IRQ context and serial_do_free can sleep.
348 The right fix is probably to make the tty free (which is rare)
349 and thus tty->shutdown() occur via a work queue and simplify all
350 the drivers that use it.
352 if (tty_hung_up_p(filp)) {
353 /* serial_hangup already called serial_down at this point.
354 Another user may have already reopened the port but
355 serial_do_free is refcounted */
356 serial_do_free(port);
360 if (tty_port_close_start(&port->port, tty, filp) == 0)
363 serial_do_down(port);
364 tty_port_close_end(&port->port, tty);
365 tty_port_tty_set(&port->port, NULL);
366 serial_do_free(port);
369 static void serial_hangup(struct tty_struct *tty)
371 struct usb_serial_port *port = tty->driver_data;
372 serial_do_down(port);
373 tty_port_hangup(&port->port);
374 /* We must not free port yet - the USB serial layer depends on it's
375 continued existence */
378 static int serial_write(struct tty_struct *tty, const unsigned char *buf,
381 struct usb_serial_port *port = tty->driver_data;
382 int retval = -ENODEV;
384 if (port->serial->dev->state == USB_STATE_NOTATTACHED)
387 dbg("%s - port %d, %d byte(s)", __func__, port->number, count);
389 /* count is managed under the mutex lock for the tty so cannot
390 drop to zero until after the last close completes */
391 WARN_ON(!port->port.count);
393 /* pass on to the driver specific version of this function */
394 retval = port->serial->type->write(tty, port, buf, count);
400 static int serial_write_room(struct tty_struct *tty)
402 struct usb_serial_port *port = tty->driver_data;
403 dbg("%s - port %d", __func__, port->number);
404 WARN_ON(!port->port.count);
405 /* pass on to the driver specific version of this function */
406 return port->serial->type->write_room(tty);
409 static int serial_chars_in_buffer(struct tty_struct *tty)
411 struct usb_serial_port *port = tty->driver_data;
412 dbg("%s = port %d", __func__, port->number);
414 WARN_ON(!port->port.count);
415 /* if the device was unplugged then any remaining characters
416 fell out of the connector ;) */
417 if (port->serial->disconnected)
419 /* pass on to the driver specific version of this function */
420 return port->serial->type->chars_in_buffer(tty);
423 static void serial_throttle(struct tty_struct *tty)
425 struct usb_serial_port *port = tty->driver_data;
426 dbg("%s - port %d", __func__, port->number);
428 WARN_ON(!port->port.count);
429 /* pass on to the driver specific version of this function */
430 if (port->serial->type->throttle)
431 port->serial->type->throttle(tty);
434 static void serial_unthrottle(struct tty_struct *tty)
436 struct usb_serial_port *port = tty->driver_data;
437 dbg("%s - port %d", __func__, port->number);
439 WARN_ON(!port->port.count);
440 /* pass on to the driver specific version of this function */
441 if (port->serial->type->unthrottle)
442 port->serial->type->unthrottle(tty);
445 static int serial_ioctl(struct tty_struct *tty, struct file *file,
446 unsigned int cmd, unsigned long arg)
448 struct usb_serial_port *port = tty->driver_data;
449 int retval = -ENODEV;
451 dbg("%s - port %d, cmd 0x%.4x", __func__, port->number, cmd);
453 WARN_ON(!port->port.count);
455 /* pass on to the driver specific version of this function
456 if it is available */
457 if (port->serial->type->ioctl) {
458 retval = port->serial->type->ioctl(tty, file, cmd, arg);
460 retval = -ENOIOCTLCMD;
464 static void serial_set_termios(struct tty_struct *tty, struct ktermios *old)
466 struct usb_serial_port *port = tty->driver_data;
467 dbg("%s - port %d", __func__, port->number);
469 WARN_ON(!port->port.count);
470 /* pass on to the driver specific version of this function
471 if it is available */
472 if (port->serial->type->set_termios)
473 port->serial->type->set_termios(tty, port, old);
475 tty_termios_copy_hw(tty->termios, old);
478 static int serial_break(struct tty_struct *tty, int break_state)
480 struct usb_serial_port *port = tty->driver_data;
482 dbg("%s - port %d", __func__, port->number);
484 WARN_ON(!port->port.count);
485 /* pass on to the driver specific version of this function
486 if it is available */
487 if (port->serial->type->break_ctl)
488 port->serial->type->break_ctl(tty, break_state);
492 static int serial_proc_show(struct seq_file *m, void *v)
494 struct usb_serial *serial;
499 seq_puts(m, "usbserinfo:1.0 driver:2.0\n");
500 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
501 serial = usb_serial_get_by_index(i);
505 seq_printf(m, "%d:", i);
506 if (serial->type->driver.owner)
507 seq_printf(m, " module:%s",
508 module_name(serial->type->driver.owner));
509 seq_printf(m, " name:\"%s\"",
510 serial->type->description);
511 seq_printf(m, " vendor:%04x product:%04x",
512 le16_to_cpu(serial->dev->descriptor.idVendor),
513 le16_to_cpu(serial->dev->descriptor.idProduct));
514 seq_printf(m, " num_ports:%d", serial->num_ports);
515 seq_printf(m, " port:%d", i - serial->minor + 1);
516 usb_make_path(serial->dev, tmp, sizeof(tmp));
517 seq_printf(m, " path:%s", tmp);
520 usb_serial_put(serial);
525 static int serial_proc_open(struct inode *inode, struct file *file)
527 return single_open(file, serial_proc_show, NULL);
530 static const struct file_operations serial_proc_fops = {
531 .owner = THIS_MODULE,
532 .open = serial_proc_open,
535 .release = single_release,
538 static int serial_tiocmget(struct tty_struct *tty, struct file *file)
540 struct usb_serial_port *port = tty->driver_data;
542 dbg("%s - port %d", __func__, port->number);
544 WARN_ON(!port->port.count);
545 if (port->serial->type->tiocmget)
546 return port->serial->type->tiocmget(tty, file);
550 static int serial_tiocmset(struct tty_struct *tty, struct file *file,
551 unsigned int set, unsigned int clear)
553 struct usb_serial_port *port = tty->driver_data;
555 dbg("%s - port %d", __func__, port->number);
557 WARN_ON(!port->port.count);
558 if (port->serial->type->tiocmset)
559 return port->serial->type->tiocmset(tty, file, set, clear);
564 * We would be calling tty_wakeup here, but unfortunately some line
565 * disciplines have an annoying habit of calling tty->write from
566 * the write wakeup callback (e.g. n_hdlc.c).
568 void usb_serial_port_softint(struct usb_serial_port *port)
570 schedule_work(&port->work);
572 EXPORT_SYMBOL_GPL(usb_serial_port_softint);
574 static void usb_serial_port_work(struct work_struct *work)
576 struct usb_serial_port *port =
577 container_of(work, struct usb_serial_port, work);
578 struct tty_struct *tty;
580 dbg("%s - port %d", __func__, port->number);
582 tty = tty_port_tty_get(&port->port);
590 static void port_release(struct device *dev)
592 struct usb_serial_port *port = to_usb_serial_port(dev);
594 dbg ("%s - %s", __func__, dev_name(dev));
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_free(struct usb_serial_port *port)
620 * Stop all the traffic before cancelling the work, so that
621 * nobody will restart it by calling usb_serial_port_softint.
624 cancel_work_sync(&port->work);
626 usb_free_urb(port->read_urb);
627 usb_free_urb(port->write_urb);
628 usb_free_urb(port->interrupt_in_urb);
629 usb_free_urb(port->interrupt_out_urb);
630 kfree(port->bulk_in_buffer);
631 kfree(port->bulk_out_buffer);
632 kfree(port->interrupt_in_buffer);
633 kfree(port->interrupt_out_buffer);
637 static struct usb_serial *create_serial(struct usb_device *dev,
638 struct usb_interface *interface,
639 struct usb_serial_driver *driver)
641 struct usb_serial *serial;
643 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
645 dev_err(&dev->dev, "%s - out of memory\n", __func__);
648 serial->dev = usb_get_dev(dev);
649 serial->type = driver;
650 serial->interface = interface;
651 kref_init(&serial->kref);
652 mutex_init(&serial->disc_mutex);
653 serial->minor = SERIAL_TTY_NO_MINOR;
658 static const struct usb_device_id *match_dynamic_id(struct usb_interface *intf,
659 struct usb_serial_driver *drv)
661 struct usb_dynid *dynid;
663 spin_lock(&drv->dynids.lock);
664 list_for_each_entry(dynid, &drv->dynids.list, node) {
665 if (usb_match_one_id(intf, &dynid->id)) {
666 spin_unlock(&drv->dynids.lock);
670 spin_unlock(&drv->dynids.lock);
674 static const struct usb_device_id *get_iface_id(struct usb_serial_driver *drv,
675 struct usb_interface *intf)
677 const struct usb_device_id *id;
679 id = usb_match_id(intf, drv->id_table);
681 dbg("static descriptor matches");
684 id = match_dynamic_id(intf, drv);
686 dbg("dynamic descriptor matches");
691 static struct usb_serial_driver *search_serial_device(
692 struct usb_interface *iface)
694 const struct usb_device_id *id;
695 struct usb_serial_driver *drv;
697 /* Check if the usb id matches a known device */
698 list_for_each_entry(drv, &usb_serial_driver_list, driver_list) {
699 id = get_iface_id(drv, iface);
707 static int serial_carrier_raised(struct tty_port *port)
709 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
710 struct usb_serial_driver *drv = p->serial->type;
711 if (drv->carrier_raised)
712 return drv->carrier_raised(p);
713 /* No carrier control - don't block */
717 static void serial_dtr_rts(struct tty_port *port, int on)
719 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
720 struct usb_serial_driver *drv = p->serial->type;
725 static const struct tty_port_operations serial_port_ops = {
726 .carrier_raised = serial_carrier_raised,
727 .dtr_rts = serial_dtr_rts,
730 int usb_serial_probe(struct usb_interface *interface,
731 const struct usb_device_id *id)
733 struct usb_device *dev = interface_to_usbdev(interface);
734 struct usb_serial *serial = NULL;
735 struct usb_serial_port *port;
736 struct usb_host_interface *iface_desc;
737 struct usb_endpoint_descriptor *endpoint;
738 struct usb_endpoint_descriptor *interrupt_in_endpoint[MAX_NUM_PORTS];
739 struct usb_endpoint_descriptor *interrupt_out_endpoint[MAX_NUM_PORTS];
740 struct usb_endpoint_descriptor *bulk_in_endpoint[MAX_NUM_PORTS];
741 struct usb_endpoint_descriptor *bulk_out_endpoint[MAX_NUM_PORTS];
742 struct usb_serial_driver *type = NULL;
747 int num_interrupt_in = 0;
748 int num_interrupt_out = 0;
750 int num_bulk_out = 0;
754 lock_kernel(); /* guard against unloading a serial driver module */
755 type = search_serial_device(interface);
762 serial = create_serial(dev, interface, type);
765 dev_err(&interface->dev, "%s - out of memory\n", __func__);
769 /* if this device type has a probe function, call it */
771 const struct usb_device_id *id;
773 if (!try_module_get(type->driver.owner)) {
775 dev_err(&interface->dev,
776 "module get failed, exiting\n");
781 id = get_iface_id(type, interface);
782 retval = type->probe(serial, id);
783 module_put(type->driver.owner);
787 dbg("sub driver rejected device");
793 /* descriptor matches, let's find the endpoints needed */
794 /* check out the endpoints */
795 iface_desc = interface->cur_altsetting;
796 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
797 endpoint = &iface_desc->endpoint[i].desc;
799 if (usb_endpoint_is_bulk_in(endpoint)) {
800 /* we found a bulk in endpoint */
801 dbg("found bulk in on endpoint %d", i);
802 bulk_in_endpoint[num_bulk_in] = endpoint;
806 if (usb_endpoint_is_bulk_out(endpoint)) {
807 /* we found a bulk out endpoint */
808 dbg("found bulk out on endpoint %d", i);
809 bulk_out_endpoint[num_bulk_out] = endpoint;
813 if (usb_endpoint_is_int_in(endpoint)) {
814 /* we found a interrupt in endpoint */
815 dbg("found interrupt in on endpoint %d", i);
816 interrupt_in_endpoint[num_interrupt_in] = endpoint;
820 if (usb_endpoint_is_int_out(endpoint)) {
821 /* we found an interrupt out endpoint */
822 dbg("found interrupt out on endpoint %d", i);
823 interrupt_out_endpoint[num_interrupt_out] = endpoint;
828 #if defined(CONFIG_USB_SERIAL_PL2303) || defined(CONFIG_USB_SERIAL_PL2303_MODULE)
829 /* BEGIN HORRIBLE HACK FOR PL2303 */
830 /* this is needed due to the looney way its endpoints are set up */
831 if (((le16_to_cpu(dev->descriptor.idVendor) == PL2303_VENDOR_ID) &&
832 (le16_to_cpu(dev->descriptor.idProduct) == PL2303_PRODUCT_ID)) ||
833 ((le16_to_cpu(dev->descriptor.idVendor) == ATEN_VENDOR_ID) &&
834 (le16_to_cpu(dev->descriptor.idProduct) == ATEN_PRODUCT_ID)) ||
835 ((le16_to_cpu(dev->descriptor.idVendor) == ALCOR_VENDOR_ID) &&
836 (le16_to_cpu(dev->descriptor.idProduct) == ALCOR_PRODUCT_ID)) ||
837 ((le16_to_cpu(dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
838 (le16_to_cpu(dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_EF81))) {
839 if (interface != dev->actconfig->interface[0]) {
840 /* check out the endpoints of the other interface*/
841 iface_desc = dev->actconfig->interface[0]->cur_altsetting;
842 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
843 endpoint = &iface_desc->endpoint[i].desc;
844 if (usb_endpoint_is_int_in(endpoint)) {
845 /* we found a interrupt in endpoint */
846 dbg("found interrupt in for Prolific device on separate interface");
847 interrupt_in_endpoint[num_interrupt_in] = endpoint;
853 /* Now make sure the PL-2303 is configured correctly.
854 * If not, give up now and hope this hack will work
855 * properly during a later invocation of usb_serial_probe
857 if (num_bulk_in == 0 || num_bulk_out == 0) {
859 dev_info(&interface->dev, "PL-2303 hack: descriptors matched but endpoints did not\n");
864 /* END HORRIBLE HACK FOR PL2303 */
867 #ifdef CONFIG_USB_SERIAL_GENERIC
868 if (type == &usb_serial_generic_device) {
869 num_ports = num_bulk_out;
870 if (num_ports == 0) {
872 dev_err(&interface->dev,
873 "Generic device with no bulk out, not allowed.\n");
880 /* if this device type has a calc_num_ports function, call it */
881 if (type->calc_num_ports) {
882 if (!try_module_get(type->driver.owner)) {
884 dev_err(&interface->dev,
885 "module get failed, exiting\n");
889 num_ports = type->calc_num_ports(serial);
890 module_put(type->driver.owner);
893 num_ports = type->num_ports;
896 serial->num_ports = num_ports;
897 serial->num_bulk_in = num_bulk_in;
898 serial->num_bulk_out = num_bulk_out;
899 serial->num_interrupt_in = num_interrupt_in;
900 serial->num_interrupt_out = num_interrupt_out;
902 /* found all that we need */
903 dev_info(&interface->dev, "%s converter detected\n",
906 /* create our ports, we need as many as the max endpoints */
907 /* we don't use num_ports here because some devices have more
908 endpoint pairs than ports */
909 max_endpoints = max(num_bulk_in, num_bulk_out);
910 max_endpoints = max(max_endpoints, num_interrupt_in);
911 max_endpoints = max(max_endpoints, num_interrupt_out);
912 max_endpoints = max(max_endpoints, (int)serial->num_ports);
913 serial->num_port_pointers = max_endpoints;
916 dbg("%s - setting up %d port structures for this device",
917 __func__, max_endpoints);
918 for (i = 0; i < max_endpoints; ++i) {
919 port = kzalloc(sizeof(struct usb_serial_port), GFP_KERNEL);
922 tty_port_init(&port->port);
923 port->port.ops = &serial_port_ops;
924 port->serial = serial;
925 spin_lock_init(&port->lock);
926 mutex_init(&port->mutex);
927 INIT_WORK(&port->work, usb_serial_port_work);
928 serial->port[i] = port;
931 /* set up the endpoint information */
932 for (i = 0; i < num_bulk_in; ++i) {
933 endpoint = bulk_in_endpoint[i];
934 port = serial->port[i];
935 port->read_urb = usb_alloc_urb(0, GFP_KERNEL);
936 if (!port->read_urb) {
937 dev_err(&interface->dev, "No free urbs available\n");
940 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
941 port->bulk_in_size = buffer_size;
942 port->bulk_in_endpointAddress = endpoint->bEndpointAddress;
943 port->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
944 if (!port->bulk_in_buffer) {
945 dev_err(&interface->dev,
946 "Couldn't allocate bulk_in_buffer\n");
949 usb_fill_bulk_urb(port->read_urb, dev,
951 endpoint->bEndpointAddress),
952 port->bulk_in_buffer, buffer_size,
953 serial->type->read_bulk_callback, port);
956 for (i = 0; i < num_bulk_out; ++i) {
957 endpoint = bulk_out_endpoint[i];
958 port = serial->port[i];
959 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
960 if (!port->write_urb) {
961 dev_err(&interface->dev, "No free urbs available\n");
964 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
965 port->bulk_out_size = buffer_size;
966 port->bulk_out_endpointAddress = endpoint->bEndpointAddress;
967 port->bulk_out_buffer = kmalloc(buffer_size, GFP_KERNEL);
968 if (!port->bulk_out_buffer) {
969 dev_err(&interface->dev,
970 "Couldn't allocate bulk_out_buffer\n");
973 usb_fill_bulk_urb(port->write_urb, dev,
975 endpoint->bEndpointAddress),
976 port->bulk_out_buffer, buffer_size,
977 serial->type->write_bulk_callback, port);
980 if (serial->type->read_int_callback) {
981 for (i = 0; i < num_interrupt_in; ++i) {
982 endpoint = interrupt_in_endpoint[i];
983 port = serial->port[i];
984 port->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
985 if (!port->interrupt_in_urb) {
986 dev_err(&interface->dev,
987 "No free urbs available\n");
990 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
991 port->interrupt_in_endpointAddress =
992 endpoint->bEndpointAddress;
993 port->interrupt_in_buffer = kmalloc(buffer_size,
995 if (!port->interrupt_in_buffer) {
996 dev_err(&interface->dev,
997 "Couldn't allocate interrupt_in_buffer\n");
1000 usb_fill_int_urb(port->interrupt_in_urb, dev,
1002 endpoint->bEndpointAddress),
1003 port->interrupt_in_buffer, buffer_size,
1004 serial->type->read_int_callback, port,
1005 endpoint->bInterval);
1007 } else if (num_interrupt_in) {
1008 dbg("the device claims to support interrupt in transfers, but read_int_callback is not defined");
1011 if (serial->type->write_int_callback) {
1012 for (i = 0; i < num_interrupt_out; ++i) {
1013 endpoint = interrupt_out_endpoint[i];
1014 port = serial->port[i];
1015 port->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
1016 if (!port->interrupt_out_urb) {
1017 dev_err(&interface->dev,
1018 "No free urbs available\n");
1021 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
1022 port->interrupt_out_size = buffer_size;
1023 port->interrupt_out_endpointAddress =
1024 endpoint->bEndpointAddress;
1025 port->interrupt_out_buffer = kmalloc(buffer_size,
1027 if (!port->interrupt_out_buffer) {
1028 dev_err(&interface->dev,
1029 "Couldn't allocate interrupt_out_buffer\n");
1032 usb_fill_int_urb(port->interrupt_out_urb, dev,
1034 endpoint->bEndpointAddress),
1035 port->interrupt_out_buffer, buffer_size,
1036 serial->type->write_int_callback, port,
1037 endpoint->bInterval);
1039 } else if (num_interrupt_out) {
1040 dbg("the device claims to support interrupt out transfers, but write_int_callback is not defined");
1043 /* if this device type has an attach function, call it */
1045 if (!try_module_get(type->driver.owner)) {
1046 dev_err(&interface->dev,
1047 "module get failed, exiting\n");
1050 retval = type->attach(serial);
1051 module_put(type->driver.owner);
1055 /* quietly accept this device, but don't bind to a
1056 serial port as it's about to disappear */
1057 serial->num_ports = 0;
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 port->dev.parent = &interface->dev;
1072 port->dev.driver = NULL;
1073 port->dev.bus = &usb_serial_bus_type;
1074 port->dev.release = &port_release;
1076 dev_set_name(&port->dev, "ttyUSB%d", port->number);
1077 dbg ("%s - registering %s", __func__, dev_name(&port->dev));
1078 port->dev_state = PORT_REGISTERING;
1079 retval = device_register(&port->dev);
1081 dev_err(&port->dev, "Error registering port device, "
1083 port->dev_state = PORT_UNREGISTERED;
1085 port->dev_state = PORT_REGISTERED;
1089 usb_serial_console_init(debug, minor);
1093 usb_set_intfdata(interface, serial);
1097 for (i = 0; i < num_bulk_in; ++i) {
1098 port = serial->port[i];
1101 usb_free_urb(port->read_urb);
1102 kfree(port->bulk_in_buffer);
1104 for (i = 0; i < num_bulk_out; ++i) {
1105 port = serial->port[i];
1108 usb_free_urb(port->write_urb);
1109 kfree(port->bulk_out_buffer);
1111 for (i = 0; i < num_interrupt_in; ++i) {
1112 port = serial->port[i];
1115 usb_free_urb(port->interrupt_in_urb);
1116 kfree(port->interrupt_in_buffer);
1118 for (i = 0; i < num_interrupt_out; ++i) {
1119 port = serial->port[i];
1122 usb_free_urb(port->interrupt_out_urb);
1123 kfree(port->interrupt_out_buffer);
1126 /* free up any memory that we allocated */
1127 for (i = 0; i < serial->num_port_pointers; ++i)
1128 kfree(serial->port[i]);
1132 EXPORT_SYMBOL_GPL(usb_serial_probe);
1134 void usb_serial_disconnect(struct usb_interface *interface)
1137 struct usb_serial *serial = usb_get_intfdata(interface);
1138 struct device *dev = &interface->dev;
1139 struct usb_serial_port *port;
1141 usb_serial_console_disconnect(serial);
1142 dbg("%s", __func__);
1144 mutex_lock(&serial->disc_mutex);
1145 usb_set_intfdata(interface, NULL);
1146 /* must set a flag, to signal subdrivers */
1147 serial->disconnected = 1;
1148 mutex_unlock(&serial->disc_mutex);
1150 for (i = 0; i < serial->num_ports; ++i) {
1151 port = serial->port[i];
1153 struct tty_struct *tty = tty_port_tty_get(&port->port);
1155 /* The hangup will occur asynchronously but
1156 the object refcounts will sort out all the
1162 cancel_work_sync(&port->work);
1163 if (port->dev_state == PORT_REGISTERED) {
1165 /* Make sure the port is bound so that the
1166 * driver's port_remove method is called.
1168 if (!port->dev.driver) {
1172 &serial->type->driver;
1173 rc = device_bind_driver(&port->dev);
1175 port->dev_state = PORT_UNREGISTERING;
1176 device_del(&port->dev);
1177 port->dev_state = PORT_UNREGISTERED;
1181 serial->type->disconnect(serial);
1183 /* let the last holder of this object
1184 * cause it to be cleaned up */
1185 usb_serial_put(serial);
1186 dev_info(dev, "device disconnected\n");
1188 EXPORT_SYMBOL_GPL(usb_serial_disconnect);
1190 int usb_serial_suspend(struct usb_interface *intf, pm_message_t message)
1192 struct usb_serial *serial = usb_get_intfdata(intf);
1193 struct usb_serial_port *port;
1196 serial->suspending = 1;
1198 for (i = 0; i < serial->num_ports; ++i) {
1199 port = serial->port[i];
1204 if (serial->type->suspend)
1205 r = serial->type->suspend(serial, message);
1209 EXPORT_SYMBOL(usb_serial_suspend);
1211 int usb_serial_resume(struct usb_interface *intf)
1213 struct usb_serial *serial = usb_get_intfdata(intf);
1216 serial->suspending = 0;
1217 if (serial->type->resume)
1218 rv = serial->type->resume(serial);
1220 rv = usb_serial_generic_resume(serial);
1224 EXPORT_SYMBOL(usb_serial_resume);
1226 static const struct tty_operations serial_ops = {
1227 .open = serial_open,
1228 .close = serial_close,
1229 .write = serial_write,
1230 .hangup = serial_hangup,
1231 .write_room = serial_write_room,
1232 .ioctl = serial_ioctl,
1233 .set_termios = serial_set_termios,
1234 .throttle = serial_throttle,
1235 .unthrottle = serial_unthrottle,
1236 .break_ctl = serial_break,
1237 .chars_in_buffer = serial_chars_in_buffer,
1238 .tiocmget = serial_tiocmget,
1239 .tiocmset = serial_tiocmset,
1240 .proc_fops = &serial_proc_fops,
1244 struct tty_driver *usb_serial_tty_driver;
1246 static int __init usb_serial_init(void)
1251 usb_serial_tty_driver = alloc_tty_driver(SERIAL_TTY_MINORS);
1252 if (!usb_serial_tty_driver)
1255 /* Initialize our global data */
1256 for (i = 0; i < SERIAL_TTY_MINORS; ++i)
1257 serial_table[i] = NULL;
1259 result = bus_register(&usb_serial_bus_type);
1261 printk(KERN_ERR "usb-serial: %s - registering bus driver "
1262 "failed\n", __func__);
1266 usb_serial_tty_driver->owner = THIS_MODULE;
1267 usb_serial_tty_driver->driver_name = "usbserial";
1268 usb_serial_tty_driver->name = "ttyUSB";
1269 usb_serial_tty_driver->major = SERIAL_TTY_MAJOR;
1270 usb_serial_tty_driver->minor_start = 0;
1271 usb_serial_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1272 usb_serial_tty_driver->subtype = SERIAL_TYPE_NORMAL;
1273 usb_serial_tty_driver->flags = TTY_DRIVER_REAL_RAW |
1274 TTY_DRIVER_DYNAMIC_DEV;
1275 usb_serial_tty_driver->init_termios = tty_std_termios;
1276 usb_serial_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD
1278 usb_serial_tty_driver->init_termios.c_ispeed = 9600;
1279 usb_serial_tty_driver->init_termios.c_ospeed = 9600;
1280 tty_set_operations(usb_serial_tty_driver, &serial_ops);
1281 result = tty_register_driver(usb_serial_tty_driver);
1283 printk(KERN_ERR "usb-serial: %s - tty_register_driver failed\n",
1285 goto exit_reg_driver;
1288 /* register the USB driver */
1289 result = usb_register(&usb_serial_driver);
1291 printk(KERN_ERR "usb-serial: %s - usb_register failed\n",
1296 /* register the generic driver, if we should */
1297 result = usb_serial_generic_register(debug);
1299 printk(KERN_ERR "usb-serial: %s - registering generic "
1300 "driver failed\n", __func__);
1304 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1309 usb_deregister(&usb_serial_driver);
1312 tty_unregister_driver(usb_serial_tty_driver);
1315 bus_unregister(&usb_serial_bus_type);
1318 printk(KERN_ERR "usb-serial: %s - returning with error %d\n",
1320 put_tty_driver(usb_serial_tty_driver);
1325 static void __exit usb_serial_exit(void)
1327 usb_serial_console_exit();
1329 usb_serial_generic_deregister();
1331 usb_deregister(&usb_serial_driver);
1332 tty_unregister_driver(usb_serial_tty_driver);
1333 put_tty_driver(usb_serial_tty_driver);
1334 bus_unregister(&usb_serial_bus_type);
1338 module_init(usb_serial_init);
1339 module_exit(usb_serial_exit);
1341 #define set_to_generic_if_null(type, function) \
1343 if (!type->function) { \
1344 type->function = usb_serial_generic_##function; \
1345 dbg("Had to override the " #function \
1346 " usb serial operation with the generic one.");\
1350 static void fixup_generic(struct usb_serial_driver *device)
1352 set_to_generic_if_null(device, open);
1353 set_to_generic_if_null(device, write);
1354 set_to_generic_if_null(device, close);
1355 set_to_generic_if_null(device, write_room);
1356 set_to_generic_if_null(device, chars_in_buffer);
1357 set_to_generic_if_null(device, read_bulk_callback);
1358 set_to_generic_if_null(device, write_bulk_callback);
1359 set_to_generic_if_null(device, disconnect);
1360 set_to_generic_if_null(device, release);
1363 int usb_serial_register(struct usb_serial_driver *driver)
1365 /* must be called with BKL held */
1371 fixup_generic(driver);
1373 if (!driver->description)
1374 driver->description = driver->driver.name;
1376 /* Add this device to our list of devices */
1377 list_add(&driver->driver_list, &usb_serial_driver_list);
1379 retval = usb_serial_bus_register(driver);
1381 printk(KERN_ERR "usb-serial: problem %d when registering "
1382 "driver %s\n", retval, driver->description);
1383 list_del(&driver->driver_list);
1385 printk(KERN_INFO "USB Serial support registered for %s\n",
1386 driver->description);
1390 EXPORT_SYMBOL_GPL(usb_serial_register);
1393 void usb_serial_deregister(struct usb_serial_driver *device)
1395 /* must be called with BKL held */
1396 printk(KERN_INFO "USB Serial deregistering driver %s\n",
1397 device->description);
1398 list_del(&device->driver_list);
1399 usb_serial_bus_deregister(device);
1401 EXPORT_SYMBOL_GPL(usb_serial_deregister);
1403 /* Module information */
1404 MODULE_AUTHOR(DRIVER_AUTHOR);
1405 MODULE_DESCRIPTION(DRIVER_DESC);
1406 MODULE_LICENSE("GPL");
1408 module_param(debug, bool, S_IRUGO | S_IWUSR);
1409 MODULE_PARM_DESC(debug, "Debug enabled or not");