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/spinlock.h>
30 #include <linux/mutex.h>
31 #include <linux/list.h>
32 #include <linux/uaccess.h>
33 #include <linux/usb.h>
34 #include <linux/usb/serial.h>
40 #define DRIVER_AUTHOR "Greg Kroah-Hartman, greg@kroah.com, http://www.kroah.com/linux/"
41 #define DRIVER_DESC "USB Serial Driver core"
43 static void port_free(struct usb_serial_port
*port
);
45 /* Driver structure we register with the USB core */
46 static struct usb_driver usb_serial_driver
= {
48 .probe
= usb_serial_probe
,
49 .disconnect
= usb_serial_disconnect
,
50 .suspend
= usb_serial_suspend
,
51 .resume
= usb_serial_resume
,
55 /* There is no MODULE_DEVICE_TABLE for usbserial.c. Instead
56 the MODULE_DEVICE_TABLE declarations in each serial driver
57 cause the "hotplug" program to pull in whatever module is necessary
58 via modprobe, and modprobe will load usbserial because the serial
63 /* initially all NULL */
64 static struct usb_serial
*serial_table
[SERIAL_TTY_MINORS
];
65 static DEFINE_MUTEX(table_lock
);
66 static LIST_HEAD(usb_serial_driver_list
);
68 struct usb_serial
*usb_serial_get_by_index(unsigned index
)
70 struct usb_serial
*serial
;
72 mutex_lock(&table_lock
);
73 serial
= serial_table
[index
];
76 kref_get(&serial
->kref
);
77 mutex_unlock(&table_lock
);
81 static struct usb_serial
*get_free_serial(struct usb_serial
*serial
,
82 int num_ports
, unsigned int *minor
)
87 dbg("%s %d", __func__
, num_ports
);
90 mutex_lock(&table_lock
);
91 for (i
= 0; i
< SERIAL_TTY_MINORS
; ++i
) {
96 for (j
= 1; j
<= num_ports
-1; ++j
)
97 if ((i
+j
>= SERIAL_TTY_MINORS
) || (serial_table
[i
+j
])) {
107 dbg("%s - minor base = %d", __func__
, *minor
);
108 for (i
= *minor
; (i
< (*minor
+ num_ports
)) && (i
< SERIAL_TTY_MINORS
); ++i
) {
109 serial_table
[i
] = serial
;
110 serial
->port
[j
++]->number
= i
;
112 mutex_unlock(&table_lock
);
115 mutex_unlock(&table_lock
);
119 static void return_serial(struct usb_serial
*serial
)
125 for (i
= 0; i
< serial
->num_ports
; ++i
)
126 serial_table
[serial
->minor
+ i
] = NULL
;
129 static void destroy_serial(struct kref
*kref
)
131 struct usb_serial
*serial
;
132 struct usb_serial_port
*port
;
135 serial
= to_usb_serial(kref
);
137 dbg("%s - %s", __func__
, serial
->type
->description
);
139 serial
->type
->shutdown(serial
);
141 /* return the minor range that this device had */
142 if (serial
->minor
!= SERIAL_TTY_NO_MINOR
)
143 return_serial(serial
);
145 for (i
= 0; i
< serial
->num_ports
; ++i
)
146 serial
->port
[i
]->port
.count
= 0;
148 /* the ports are cleaned up and released in port_release() */
149 for (i
= 0; i
< serial
->num_ports
; ++i
)
150 if (serial
->port
[i
]->dev
.parent
!= NULL
) {
151 device_unregister(&serial
->port
[i
]->dev
);
152 serial
->port
[i
] = NULL
;
155 /* If this is a "fake" port, we have to clean it up here, as it will
156 * not get cleaned up in port_release() as it was never registered with
158 if (serial
->num_ports
< serial
->num_port_pointers
) {
159 for (i
= serial
->num_ports
;
160 i
< serial
->num_port_pointers
; ++i
) {
161 port
= serial
->port
[i
];
168 usb_put_dev(serial
->dev
);
170 /* free up any memory that we allocated */
174 void usb_serial_put(struct usb_serial
*serial
)
176 mutex_lock(&table_lock
);
177 kref_put(&serial
->kref
, destroy_serial
);
178 mutex_unlock(&table_lock
);
181 /*****************************************************************************
182 * Driver tty interface functions
183 *****************************************************************************/
184 static int serial_open (struct tty_struct
*tty
, struct file
*filp
)
186 struct usb_serial
*serial
;
187 struct usb_serial_port
*port
;
188 unsigned int portNumber
;
193 /* get the serial object associated with this tty pointer */
194 serial
= usb_serial_get_by_index(tty
->index
);
196 tty
->driver_data
= NULL
;
200 portNumber
= tty
->index
- serial
->minor
;
201 port
= serial
->port
[portNumber
];
204 goto bailout_kref_put
;
207 if (mutex_lock_interruptible(&port
->mutex
)) {
208 retval
= -ERESTARTSYS
;
209 goto bailout_kref_put
;
214 /* set up our port structure making the tty driver
215 * remember our port object, and us it */
216 tty
->driver_data
= port
;
217 tty_port_tty_set(&port
->port
, tty
);
219 if (port
->port
.count
== 1) {
221 /* lock this module before we call it
222 * this may fail, which means we must bail out,
223 * safe because we are called with BKL held */
224 if (!try_module_get(serial
->type
->driver
.owner
)) {
226 goto bailout_mutex_unlock
;
229 retval
= usb_autopm_get_interface(serial
->interface
);
231 goto bailout_module_put
;
232 /* only call the device specific open if this
233 * is the first time the port is opened */
234 retval
= serial
->type
->open(tty
, port
, filp
);
236 goto bailout_interface_put
;
239 mutex_unlock(&port
->mutex
);
242 bailout_interface_put
:
243 usb_autopm_put_interface(serial
->interface
);
245 module_put(serial
->type
->driver
.owner
);
246 bailout_mutex_unlock
:
247 port
->port
.count
= 0;
248 tty
->driver_data
= NULL
;
249 tty_port_tty_set(&port
->port
, NULL
);
250 mutex_unlock(&port
->mutex
);
252 usb_serial_put(serial
);
256 static void serial_close(struct tty_struct
*tty
, struct file
*filp
)
258 struct usb_serial_port
*port
= tty
->driver_data
;
263 dbg("%s - port %d", __func__
, port
->number
);
265 mutex_lock(&port
->mutex
);
267 if (port
->port
.count
== 0) {
268 mutex_unlock(&port
->mutex
);
273 if (port
->port
.count
== 0)
274 /* only call the device specific close if this
275 * port is being closed by the last owner */
276 port
->serial
->type
->close(tty
, port
, filp
);
278 if (port
->port
.count
== (port
->console
? 1 : 0)) {
279 struct tty_struct
*tty
= tty_port_tty_get(&port
->port
);
281 if (tty
->driver_data
)
282 tty
->driver_data
= NULL
;
283 tty_port_tty_set(&port
->port
, NULL
);
288 if (port
->port
.count
== 0) {
289 mutex_lock(&port
->serial
->disc_mutex
);
290 if (!port
->serial
->disconnected
)
291 usb_autopm_put_interface(port
->serial
->interface
);
292 mutex_unlock(&port
->serial
->disc_mutex
);
293 module_put(port
->serial
->type
->driver
.owner
);
296 mutex_unlock(&port
->mutex
);
297 usb_serial_put(port
->serial
);
300 static int serial_write(struct tty_struct
*tty
, const unsigned char *buf
,
303 struct usb_serial_port
*port
= tty
->driver_data
;
304 int retval
= -ENODEV
;
306 if (port
->serial
->dev
->state
== USB_STATE_NOTATTACHED
)
309 dbg("%s - port %d, %d byte(s)", __func__
, port
->number
, count
);
311 /* count is managed under the mutex lock for the tty so cannot
312 drop to zero until after the last close completes */
313 WARN_ON(!port
->port
.count
);
315 /* pass on to the driver specific version of this function */
316 retval
= port
->serial
->type
->write(tty
, port
, buf
, count
);
322 static int serial_write_room(struct tty_struct
*tty
)
324 struct usb_serial_port
*port
= tty
->driver_data
;
325 dbg("%s - port %d", __func__
, port
->number
);
326 WARN_ON(!port
->port
.count
);
327 /* pass on to the driver specific version of this function */
328 return port
->serial
->type
->write_room(tty
);
331 static int serial_chars_in_buffer(struct tty_struct
*tty
)
333 struct usb_serial_port
*port
= tty
->driver_data
;
334 dbg("%s = port %d", __func__
, port
->number
);
336 WARN_ON(!port
->port
.count
);
337 /* pass on to the driver specific version of this function */
338 return port
->serial
->type
->chars_in_buffer(tty
);
341 static void serial_throttle(struct tty_struct
*tty
)
343 struct usb_serial_port
*port
= tty
->driver_data
;
344 dbg("%s - port %d", __func__
, port
->number
);
346 WARN_ON(!port
->port
.count
);
347 /* pass on to the driver specific version of this function */
348 if (port
->serial
->type
->throttle
)
349 port
->serial
->type
->throttle(tty
);
352 static void serial_unthrottle(struct tty_struct
*tty
)
354 struct usb_serial_port
*port
= tty
->driver_data
;
355 dbg("%s - port %d", __func__
, port
->number
);
357 WARN_ON(!port
->port
.count
);
358 /* pass on to the driver specific version of this function */
359 if (port
->serial
->type
->unthrottle
)
360 port
->serial
->type
->unthrottle(tty
);
363 static int serial_ioctl(struct tty_struct
*tty
, struct file
*file
,
364 unsigned int cmd
, unsigned long arg
)
366 struct usb_serial_port
*port
= tty
->driver_data
;
367 int retval
= -ENODEV
;
369 dbg("%s - port %d, cmd 0x%.4x", __func__
, port
->number
, cmd
);
371 WARN_ON(!port
->port
.count
);
373 /* pass on to the driver specific version of this function
374 if it is available */
375 if (port
->serial
->type
->ioctl
) {
377 retval
= port
->serial
->type
->ioctl(tty
, file
, cmd
, arg
);
380 retval
= -ENOIOCTLCMD
;
384 static void serial_set_termios(struct tty_struct
*tty
, struct ktermios
*old
)
386 struct usb_serial_port
*port
= tty
->driver_data
;
387 dbg("%s - port %d", __func__
, port
->number
);
389 WARN_ON(!port
->port
.count
);
390 /* pass on to the driver specific version of this function
391 if it is available */
392 if (port
->serial
->type
->set_termios
)
393 port
->serial
->type
->set_termios(tty
, port
, old
);
395 tty_termios_copy_hw(tty
->termios
, old
);
398 static int serial_break(struct tty_struct
*tty
, int break_state
)
400 struct usb_serial_port
*port
= tty
->driver_data
;
402 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 if it is available */
407 if (port
->serial
->type
->break_ctl
) {
409 port
->serial
->type
->break_ctl(tty
, break_state
);
415 static int serial_read_proc(char *page
, char **start
, off_t off
, int count
,
416 int *eof
, void *data
)
418 struct usb_serial
*serial
;
425 length
+= sprintf(page
, "usbserinfo:1.0 driver:2.0\n");
426 for (i
= 0; i
< SERIAL_TTY_MINORS
&& length
< PAGE_SIZE
; ++i
) {
427 serial
= usb_serial_get_by_index(i
);
431 length
+= sprintf(page
+length
, "%d:", i
);
432 if (serial
->type
->driver
.owner
)
433 length
+= sprintf(page
+length
, " module:%s",
434 module_name(serial
->type
->driver
.owner
));
435 length
+= sprintf(page
+length
, " name:\"%s\"",
436 serial
->type
->description
);
437 length
+= sprintf(page
+length
, " vendor:%04x product:%04x",
438 le16_to_cpu(serial
->dev
->descriptor
.idVendor
),
439 le16_to_cpu(serial
->dev
->descriptor
.idProduct
));
440 length
+= sprintf(page
+length
, " num_ports:%d",
442 length
+= sprintf(page
+length
, " port:%d",
443 i
- serial
->minor
+ 1);
444 usb_make_path(serial
->dev
, tmp
, sizeof(tmp
));
445 length
+= sprintf(page
+length
, " path:%s", tmp
);
447 length
+= sprintf(page
+length
, "\n");
448 if ((length
+ begin
) > (off
+ count
)) {
449 usb_serial_put(serial
);
452 if ((length
+ begin
) < off
) {
456 usb_serial_put(serial
);
460 if (off
>= (length
+ begin
))
462 *start
= page
+ (off
-begin
);
463 return (count
< begin
+length
-off
) ? count
: begin
+length
-off
;
466 static int serial_tiocmget(struct tty_struct
*tty
, struct file
*file
)
468 struct usb_serial_port
*port
= tty
->driver_data
;
470 dbg("%s - port %d", __func__
, port
->number
);
472 WARN_ON(!port
->port
.count
);
473 if (port
->serial
->type
->tiocmget
)
474 return port
->serial
->type
->tiocmget(tty
, file
);
478 static int serial_tiocmset(struct tty_struct
*tty
, struct file
*file
,
479 unsigned int set
, unsigned int clear
)
481 struct usb_serial_port
*port
= tty
->driver_data
;
483 dbg("%s - port %d", __func__
, port
->number
);
485 WARN_ON(!port
->port
.count
);
486 if (port
->serial
->type
->tiocmset
)
487 return port
->serial
->type
->tiocmset(tty
, file
, set
, clear
);
492 * We would be calling tty_wakeup here, but unfortunately some line
493 * disciplines have an annoying habit of calling tty->write from
494 * the write wakeup callback (e.g. n_hdlc.c).
496 void usb_serial_port_softint(struct usb_serial_port
*port
)
498 schedule_work(&port
->work
);
500 EXPORT_SYMBOL_GPL(usb_serial_port_softint
);
502 static void usb_serial_port_work(struct work_struct
*work
)
504 struct usb_serial_port
*port
=
505 container_of(work
, struct usb_serial_port
, work
);
506 struct tty_struct
*tty
;
508 dbg("%s - port %d", __func__
, port
->number
);
513 tty
= tty_port_tty_get(&port
->port
);
521 static void port_release(struct device
*dev
)
523 struct usb_serial_port
*port
= to_usb_serial_port(dev
);
525 dbg ("%s - %s", __func__
, dev_name(dev
));
529 static void kill_traffic(struct usb_serial_port
*port
)
531 usb_kill_urb(port
->read_urb
);
532 usb_kill_urb(port
->write_urb
);
535 * Some drivers submit the read_urb in the
536 * handler for the write_urb or vice versa
537 * this order determines the order in which
538 * usb_kill_urb() must be used to reliably
539 * kill the URBs. As it is unknown here,
540 * both orders must be used in turn.
541 * The call below is not redundant.
543 usb_kill_urb(port
->read_urb
);
544 usb_kill_urb(port
->interrupt_in_urb
);
545 usb_kill_urb(port
->interrupt_out_urb
);
548 static void port_free(struct usb_serial_port
*port
)
551 usb_free_urb(port
->read_urb
);
552 usb_free_urb(port
->write_urb
);
553 usb_free_urb(port
->interrupt_in_urb
);
554 usb_free_urb(port
->interrupt_out_urb
);
555 kfree(port
->bulk_in_buffer
);
556 kfree(port
->bulk_out_buffer
);
557 kfree(port
->interrupt_in_buffer
);
558 kfree(port
->interrupt_out_buffer
);
559 flush_scheduled_work(); /* port->work */
563 static struct usb_serial
*create_serial(struct usb_device
*dev
,
564 struct usb_interface
*interface
,
565 struct usb_serial_driver
*driver
)
567 struct usb_serial
*serial
;
569 serial
= kzalloc(sizeof(*serial
), GFP_KERNEL
);
571 dev_err(&dev
->dev
, "%s - out of memory\n", __func__
);
574 serial
->dev
= usb_get_dev(dev
);
575 serial
->type
= driver
;
576 serial
->interface
= interface
;
577 kref_init(&serial
->kref
);
578 mutex_init(&serial
->disc_mutex
);
579 serial
->minor
= SERIAL_TTY_NO_MINOR
;
584 static const struct usb_device_id
*match_dynamic_id(struct usb_interface
*intf
,
585 struct usb_serial_driver
*drv
)
587 struct usb_dynid
*dynid
;
589 spin_lock(&drv
->dynids
.lock
);
590 list_for_each_entry(dynid
, &drv
->dynids
.list
, node
) {
591 if (usb_match_one_id(intf
, &dynid
->id
)) {
592 spin_unlock(&drv
->dynids
.lock
);
596 spin_unlock(&drv
->dynids
.lock
);
600 static const struct usb_device_id
*get_iface_id(struct usb_serial_driver
*drv
,
601 struct usb_interface
*intf
)
603 const struct usb_device_id
*id
;
605 id
= usb_match_id(intf
, drv
->id_table
);
607 dbg("static descriptor matches");
610 id
= match_dynamic_id(intf
, drv
);
612 dbg("dynamic descriptor matches");
617 static struct usb_serial_driver
*search_serial_device(
618 struct usb_interface
*iface
)
620 const struct usb_device_id
*id
;
621 struct usb_serial_driver
*drv
;
623 /* Check if the usb id matches a known device */
624 list_for_each_entry(drv
, &usb_serial_driver_list
, driver_list
) {
625 id
= get_iface_id(drv
, iface
);
633 int usb_serial_probe(struct usb_interface
*interface
,
634 const struct usb_device_id
*id
)
636 struct usb_device
*dev
= interface_to_usbdev(interface
);
637 struct usb_serial
*serial
= NULL
;
638 struct usb_serial_port
*port
;
639 struct usb_host_interface
*iface_desc
;
640 struct usb_endpoint_descriptor
*endpoint
;
641 struct usb_endpoint_descriptor
*interrupt_in_endpoint
[MAX_NUM_PORTS
];
642 struct usb_endpoint_descriptor
*interrupt_out_endpoint
[MAX_NUM_PORTS
];
643 struct usb_endpoint_descriptor
*bulk_in_endpoint
[MAX_NUM_PORTS
];
644 struct usb_endpoint_descriptor
*bulk_out_endpoint
[MAX_NUM_PORTS
];
645 struct usb_serial_driver
*type
= NULL
;
650 int num_interrupt_in
= 0;
651 int num_interrupt_out
= 0;
653 int num_bulk_out
= 0;
657 lock_kernel(); /* guard against unloading a serial driver module */
658 type
= search_serial_device(interface
);
665 serial
= create_serial(dev
, interface
, type
);
668 dev_err(&interface
->dev
, "%s - out of memory\n", __func__
);
672 /* if this device type has a probe function, call it */
674 const struct usb_device_id
*id
;
676 if (!try_module_get(type
->driver
.owner
)) {
678 dev_err(&interface
->dev
,
679 "module get failed, exiting\n");
684 id
= get_iface_id(type
, interface
);
685 retval
= type
->probe(serial
, id
);
686 module_put(type
->driver
.owner
);
690 dbg("sub driver rejected device");
696 /* descriptor matches, let's find the endpoints needed */
697 /* check out the endpoints */
698 iface_desc
= interface
->cur_altsetting
;
699 for (i
= 0; i
< iface_desc
->desc
.bNumEndpoints
; ++i
) {
700 endpoint
= &iface_desc
->endpoint
[i
].desc
;
702 if (usb_endpoint_is_bulk_in(endpoint
)) {
703 /* we found a bulk in endpoint */
704 dbg("found bulk in on endpoint %d", i
);
705 bulk_in_endpoint
[num_bulk_in
] = endpoint
;
709 if (usb_endpoint_is_bulk_out(endpoint
)) {
710 /* we found a bulk out endpoint */
711 dbg("found bulk out on endpoint %d", i
);
712 bulk_out_endpoint
[num_bulk_out
] = endpoint
;
716 if (usb_endpoint_is_int_in(endpoint
)) {
717 /* we found a interrupt in endpoint */
718 dbg("found interrupt in on endpoint %d", i
);
719 interrupt_in_endpoint
[num_interrupt_in
] = endpoint
;
723 if (usb_endpoint_is_int_out(endpoint
)) {
724 /* we found an interrupt out endpoint */
725 dbg("found interrupt out on endpoint %d", i
);
726 interrupt_out_endpoint
[num_interrupt_out
] = endpoint
;
731 #if defined(CONFIG_USB_SERIAL_PL2303) || defined(CONFIG_USB_SERIAL_PL2303_MODULE)
732 /* BEGIN HORRIBLE HACK FOR PL2303 */
733 /* this is needed due to the looney way its endpoints are set up */
734 if (((le16_to_cpu(dev
->descriptor
.idVendor
) == PL2303_VENDOR_ID
) &&
735 (le16_to_cpu(dev
->descriptor
.idProduct
) == PL2303_PRODUCT_ID
)) ||
736 ((le16_to_cpu(dev
->descriptor
.idVendor
) == ATEN_VENDOR_ID
) &&
737 (le16_to_cpu(dev
->descriptor
.idProduct
) == ATEN_PRODUCT_ID
)) ||
738 ((le16_to_cpu(dev
->descriptor
.idVendor
) == ALCOR_VENDOR_ID
) &&
739 (le16_to_cpu(dev
->descriptor
.idProduct
) == ALCOR_PRODUCT_ID
)) ||
740 ((le16_to_cpu(dev
->descriptor
.idVendor
) == SIEMENS_VENDOR_ID
) &&
741 (le16_to_cpu(dev
->descriptor
.idProduct
) == SIEMENS_PRODUCT_ID_EF81
))) {
742 if (interface
!= dev
->actconfig
->interface
[0]) {
743 /* check out the endpoints of the other interface*/
744 iface_desc
= dev
->actconfig
->interface
[0]->cur_altsetting
;
745 for (i
= 0; i
< iface_desc
->desc
.bNumEndpoints
; ++i
) {
746 endpoint
= &iface_desc
->endpoint
[i
].desc
;
747 if (usb_endpoint_is_int_in(endpoint
)) {
748 /* we found a interrupt in endpoint */
749 dbg("found interrupt in for Prolific device on separate interface");
750 interrupt_in_endpoint
[num_interrupt_in
] = endpoint
;
756 /* Now make sure the PL-2303 is configured correctly.
757 * If not, give up now and hope this hack will work
758 * properly during a later invocation of usb_serial_probe
760 if (num_bulk_in
== 0 || num_bulk_out
== 0) {
762 dev_info(&interface
->dev
, "PL-2303 hack: descriptors matched but endpoints did not\n");
767 /* END HORRIBLE HACK FOR PL2303 */
770 #ifdef CONFIG_USB_SERIAL_GENERIC
771 if (type
== &usb_serial_generic_device
) {
772 num_ports
= num_bulk_out
;
773 if (num_ports
== 0) {
775 dev_err(&interface
->dev
,
776 "Generic device with no bulk out, not allowed.\n");
783 /* if this device type has a calc_num_ports function, call it */
784 if (type
->calc_num_ports
) {
785 if (!try_module_get(type
->driver
.owner
)) {
787 dev_err(&interface
->dev
,
788 "module get failed, exiting\n");
792 num_ports
= type
->calc_num_ports(serial
);
793 module_put(type
->driver
.owner
);
796 num_ports
= type
->num_ports
;
799 serial
->num_ports
= num_ports
;
800 serial
->num_bulk_in
= num_bulk_in
;
801 serial
->num_bulk_out
= num_bulk_out
;
802 serial
->num_interrupt_in
= num_interrupt_in
;
803 serial
->num_interrupt_out
= num_interrupt_out
;
805 /* found all that we need */
806 dev_info(&interface
->dev
, "%s converter detected\n",
809 /* create our ports, we need as many as the max endpoints */
810 /* we don't use num_ports here because some devices have more
811 endpoint pairs than ports */
812 max_endpoints
= max(num_bulk_in
, num_bulk_out
);
813 max_endpoints
= max(max_endpoints
, num_interrupt_in
);
814 max_endpoints
= max(max_endpoints
, num_interrupt_out
);
815 max_endpoints
= max(max_endpoints
, (int)serial
->num_ports
);
816 serial
->num_port_pointers
= max_endpoints
;
819 dbg("%s - setting up %d port structures for this device",
820 __func__
, max_endpoints
);
821 for (i
= 0; i
< max_endpoints
; ++i
) {
822 port
= kzalloc(sizeof(struct usb_serial_port
), GFP_KERNEL
);
825 tty_port_init(&port
->port
);
826 port
->serial
= serial
;
827 spin_lock_init(&port
->lock
);
828 mutex_init(&port
->mutex
);
829 INIT_WORK(&port
->work
, usb_serial_port_work
);
830 serial
->port
[i
] = port
;
833 /* set up the endpoint information */
834 for (i
= 0; i
< num_bulk_in
; ++i
) {
835 endpoint
= bulk_in_endpoint
[i
];
836 port
= serial
->port
[i
];
837 port
->read_urb
= usb_alloc_urb(0, GFP_KERNEL
);
838 if (!port
->read_urb
) {
839 dev_err(&interface
->dev
, "No free urbs available\n");
842 buffer_size
= le16_to_cpu(endpoint
->wMaxPacketSize
);
843 port
->bulk_in_size
= buffer_size
;
844 port
->bulk_in_endpointAddress
= endpoint
->bEndpointAddress
;
845 port
->bulk_in_buffer
= kmalloc(buffer_size
, GFP_KERNEL
);
846 if (!port
->bulk_in_buffer
) {
847 dev_err(&interface
->dev
,
848 "Couldn't allocate bulk_in_buffer\n");
851 usb_fill_bulk_urb(port
->read_urb
, dev
,
853 endpoint
->bEndpointAddress
),
854 port
->bulk_in_buffer
, buffer_size
,
855 serial
->type
->read_bulk_callback
, port
);
858 for (i
= 0; i
< num_bulk_out
; ++i
) {
859 endpoint
= bulk_out_endpoint
[i
];
860 port
= serial
->port
[i
];
861 port
->write_urb
= usb_alloc_urb(0, GFP_KERNEL
);
862 if (!port
->write_urb
) {
863 dev_err(&interface
->dev
, "No free urbs available\n");
866 buffer_size
= le16_to_cpu(endpoint
->wMaxPacketSize
);
867 port
->bulk_out_size
= buffer_size
;
868 port
->bulk_out_endpointAddress
= endpoint
->bEndpointAddress
;
869 port
->bulk_out_buffer
= kmalloc(buffer_size
, GFP_KERNEL
);
870 if (!port
->bulk_out_buffer
) {
871 dev_err(&interface
->dev
,
872 "Couldn't allocate bulk_out_buffer\n");
875 usb_fill_bulk_urb(port
->write_urb
, dev
,
877 endpoint
->bEndpointAddress
),
878 port
->bulk_out_buffer
, buffer_size
,
879 serial
->type
->write_bulk_callback
, port
);
882 if (serial
->type
->read_int_callback
) {
883 for (i
= 0; i
< num_interrupt_in
; ++i
) {
884 endpoint
= interrupt_in_endpoint
[i
];
885 port
= serial
->port
[i
];
886 port
->interrupt_in_urb
= usb_alloc_urb(0, GFP_KERNEL
);
887 if (!port
->interrupt_in_urb
) {
888 dev_err(&interface
->dev
,
889 "No free urbs available\n");
892 buffer_size
= le16_to_cpu(endpoint
->wMaxPacketSize
);
893 port
->interrupt_in_endpointAddress
=
894 endpoint
->bEndpointAddress
;
895 port
->interrupt_in_buffer
= kmalloc(buffer_size
,
897 if (!port
->interrupt_in_buffer
) {
898 dev_err(&interface
->dev
,
899 "Couldn't allocate interrupt_in_buffer\n");
902 usb_fill_int_urb(port
->interrupt_in_urb
, dev
,
904 endpoint
->bEndpointAddress
),
905 port
->interrupt_in_buffer
, buffer_size
,
906 serial
->type
->read_int_callback
, port
,
907 endpoint
->bInterval
);
909 } else if (num_interrupt_in
) {
910 dbg("the device claims to support interrupt in transfers, but read_int_callback is not defined");
913 if (serial
->type
->write_int_callback
) {
914 for (i
= 0; i
< num_interrupt_out
; ++i
) {
915 endpoint
= interrupt_out_endpoint
[i
];
916 port
= serial
->port
[i
];
917 port
->interrupt_out_urb
= usb_alloc_urb(0, GFP_KERNEL
);
918 if (!port
->interrupt_out_urb
) {
919 dev_err(&interface
->dev
,
920 "No free urbs available\n");
923 buffer_size
= le16_to_cpu(endpoint
->wMaxPacketSize
);
924 port
->interrupt_out_size
= buffer_size
;
925 port
->interrupt_out_endpointAddress
=
926 endpoint
->bEndpointAddress
;
927 port
->interrupt_out_buffer
= kmalloc(buffer_size
,
929 if (!port
->interrupt_out_buffer
) {
930 dev_err(&interface
->dev
,
931 "Couldn't allocate interrupt_out_buffer\n");
934 usb_fill_int_urb(port
->interrupt_out_urb
, dev
,
936 endpoint
->bEndpointAddress
),
937 port
->interrupt_out_buffer
, buffer_size
,
938 serial
->type
->write_int_callback
, port
,
939 endpoint
->bInterval
);
941 } else if (num_interrupt_out
) {
942 dbg("the device claims to support interrupt out transfers, but write_int_callback is not defined");
945 /* if this device type has an attach function, call it */
947 if (!try_module_get(type
->driver
.owner
)) {
948 dev_err(&interface
->dev
,
949 "module get failed, exiting\n");
952 retval
= type
->attach(serial
);
953 module_put(type
->driver
.owner
);
957 /* quietly accept this device, but don't bind to a
958 serial port as it's about to disappear */
963 if (get_free_serial(serial
, num_ports
, &minor
) == NULL
) {
964 dev_err(&interface
->dev
, "No more free serial devices\n");
967 serial
->minor
= minor
;
969 /* register all of the individual ports with the driver core */
970 for (i
= 0; i
< num_ports
; ++i
) {
971 port
= serial
->port
[i
];
972 port
->dev
.parent
= &interface
->dev
;
973 port
->dev
.driver
= NULL
;
974 port
->dev
.bus
= &usb_serial_bus_type
;
975 port
->dev
.release
= &port_release
;
977 dev_set_name(&port
->dev
, "ttyUSB%d", port
->number
);
978 dbg ("%s - registering %s", __func__
, dev_name(&port
->dev
));
979 retval
= device_register(&port
->dev
);
981 dev_err(&port
->dev
, "Error registering port device, "
985 usb_serial_console_init(debug
, minor
);
989 usb_set_intfdata(interface
, serial
);
993 for (i
= 0; i
< num_bulk_in
; ++i
) {
994 port
= serial
->port
[i
];
997 usb_free_urb(port
->read_urb
);
998 kfree(port
->bulk_in_buffer
);
1000 for (i
= 0; i
< num_bulk_out
; ++i
) {
1001 port
= serial
->port
[i
];
1004 usb_free_urb(port
->write_urb
);
1005 kfree(port
->bulk_out_buffer
);
1007 for (i
= 0; i
< num_interrupt_in
; ++i
) {
1008 port
= serial
->port
[i
];
1011 usb_free_urb(port
->interrupt_in_urb
);
1012 kfree(port
->interrupt_in_buffer
);
1014 for (i
= 0; i
< num_interrupt_out
; ++i
) {
1015 port
= serial
->port
[i
];
1018 usb_free_urb(port
->interrupt_out_urb
);
1019 kfree(port
->interrupt_out_buffer
);
1022 /* free up any memory that we allocated */
1023 for (i
= 0; i
< serial
->num_port_pointers
; ++i
)
1024 kfree(serial
->port
[i
]);
1028 EXPORT_SYMBOL_GPL(usb_serial_probe
);
1030 void usb_serial_disconnect(struct usb_interface
*interface
)
1033 struct usb_serial
*serial
= usb_get_intfdata(interface
);
1034 struct device
*dev
= &interface
->dev
;
1035 struct usb_serial_port
*port
;
1037 usb_serial_console_disconnect(serial
);
1038 dbg("%s", __func__
);
1040 mutex_lock(&serial
->disc_mutex
);
1041 usb_set_intfdata(interface
, NULL
);
1042 /* must set a flag, to signal subdrivers */
1043 serial
->disconnected
= 1;
1044 for (i
= 0; i
< serial
->num_ports
; ++i
) {
1045 port
= serial
->port
[i
];
1047 struct tty_struct
*tty
= tty_port_tty_get(&port
->port
);
1055 /* let the last holder of this object
1056 * cause it to be cleaned up */
1057 mutex_unlock(&serial
->disc_mutex
);
1058 usb_serial_put(serial
);
1059 dev_info(dev
, "device disconnected\n");
1061 EXPORT_SYMBOL_GPL(usb_serial_disconnect
);
1063 int usb_serial_suspend(struct usb_interface
*intf
, pm_message_t message
)
1065 struct usb_serial
*serial
= usb_get_intfdata(intf
);
1066 struct usb_serial_port
*port
;
1069 for (i
= 0; i
< serial
->num_ports
; ++i
) {
1070 port
= serial
->port
[i
];
1075 if (serial
->type
->suspend
)
1076 r
= serial
->type
->suspend(serial
, message
);
1080 EXPORT_SYMBOL(usb_serial_suspend
);
1082 int usb_serial_resume(struct usb_interface
*intf
)
1084 struct usb_serial
*serial
= usb_get_intfdata(intf
);
1086 if (serial
->type
->resume
)
1087 return serial
->type
->resume(serial
);
1090 EXPORT_SYMBOL(usb_serial_resume
);
1092 static const struct tty_operations serial_ops
= {
1093 .open
= serial_open
,
1094 .close
= serial_close
,
1095 .write
= serial_write
,
1096 .write_room
= serial_write_room
,
1097 .ioctl
= serial_ioctl
,
1098 .set_termios
= serial_set_termios
,
1099 .throttle
= serial_throttle
,
1100 .unthrottle
= serial_unthrottle
,
1101 .break_ctl
= serial_break
,
1102 .chars_in_buffer
= serial_chars_in_buffer
,
1103 .read_proc
= serial_read_proc
,
1104 .tiocmget
= serial_tiocmget
,
1105 .tiocmset
= serial_tiocmset
,
1108 struct tty_driver
*usb_serial_tty_driver
;
1110 static int __init
usb_serial_init(void)
1115 usb_serial_tty_driver
= alloc_tty_driver(SERIAL_TTY_MINORS
);
1116 if (!usb_serial_tty_driver
)
1119 /* Initialize our global data */
1120 for (i
= 0; i
< SERIAL_TTY_MINORS
; ++i
)
1121 serial_table
[i
] = NULL
;
1123 result
= bus_register(&usb_serial_bus_type
);
1125 printk(KERN_ERR
"usb-serial: %s - registering bus driver "
1126 "failed\n", __func__
);
1130 usb_serial_tty_driver
->owner
= THIS_MODULE
;
1131 usb_serial_tty_driver
->driver_name
= "usbserial";
1132 usb_serial_tty_driver
->name
= "ttyUSB";
1133 usb_serial_tty_driver
->major
= SERIAL_TTY_MAJOR
;
1134 usb_serial_tty_driver
->minor_start
= 0;
1135 usb_serial_tty_driver
->type
= TTY_DRIVER_TYPE_SERIAL
;
1136 usb_serial_tty_driver
->subtype
= SERIAL_TYPE_NORMAL
;
1137 usb_serial_tty_driver
->flags
= TTY_DRIVER_REAL_RAW
|
1138 TTY_DRIVER_DYNAMIC_DEV
;
1139 usb_serial_tty_driver
->init_termios
= tty_std_termios
;
1140 usb_serial_tty_driver
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
1142 usb_serial_tty_driver
->init_termios
.c_ispeed
= 9600;
1143 usb_serial_tty_driver
->init_termios
.c_ospeed
= 9600;
1144 tty_set_operations(usb_serial_tty_driver
, &serial_ops
);
1145 result
= tty_register_driver(usb_serial_tty_driver
);
1147 printk(KERN_ERR
"usb-serial: %s - tty_register_driver failed\n",
1149 goto exit_reg_driver
;
1152 /* register the USB driver */
1153 result
= usb_register(&usb_serial_driver
);
1155 printk(KERN_ERR
"usb-serial: %s - usb_register failed\n",
1160 /* register the generic driver, if we should */
1161 result
= usb_serial_generic_register(debug
);
1163 printk(KERN_ERR
"usb-serial: %s - registering generic "
1164 "driver failed\n", __func__
);
1168 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
1173 usb_deregister(&usb_serial_driver
);
1176 tty_unregister_driver(usb_serial_tty_driver
);
1179 bus_unregister(&usb_serial_bus_type
);
1182 printk(KERN_ERR
"usb-serial: %s - returning with error %d\n",
1184 put_tty_driver(usb_serial_tty_driver
);
1189 static void __exit
usb_serial_exit(void)
1191 usb_serial_console_exit();
1193 usb_serial_generic_deregister();
1195 usb_deregister(&usb_serial_driver
);
1196 tty_unregister_driver(usb_serial_tty_driver
);
1197 put_tty_driver(usb_serial_tty_driver
);
1198 bus_unregister(&usb_serial_bus_type
);
1202 module_init(usb_serial_init
);
1203 module_exit(usb_serial_exit
);
1205 #define set_to_generic_if_null(type, function) \
1207 if (!type->function) { \
1208 type->function = usb_serial_generic_##function; \
1209 dbg("Had to override the " #function \
1210 " usb serial operation with the generic one.");\
1214 static void fixup_generic(struct usb_serial_driver
*device
)
1216 set_to_generic_if_null(device
, open
);
1217 set_to_generic_if_null(device
, write
);
1218 set_to_generic_if_null(device
, close
);
1219 set_to_generic_if_null(device
, write_room
);
1220 set_to_generic_if_null(device
, chars_in_buffer
);
1221 set_to_generic_if_null(device
, read_bulk_callback
);
1222 set_to_generic_if_null(device
, write_bulk_callback
);
1223 set_to_generic_if_null(device
, shutdown
);
1224 set_to_generic_if_null(device
, resume
);
1227 int usb_serial_register(struct usb_serial_driver
*driver
)
1229 /* must be called with BKL held */
1232 fixup_generic(driver
);
1234 if (!driver
->description
)
1235 driver
->description
= driver
->driver
.name
;
1237 /* Add this device to our list of devices */
1238 list_add(&driver
->driver_list
, &usb_serial_driver_list
);
1240 retval
= usb_serial_bus_register(driver
);
1242 printk(KERN_ERR
"usb-serial: problem %d when registering "
1243 "driver %s\n", retval
, driver
->description
);
1244 list_del(&driver
->driver_list
);
1246 printk(KERN_INFO
"USB Serial support registered for %s\n",
1247 driver
->description
);
1251 EXPORT_SYMBOL_GPL(usb_serial_register
);
1254 void usb_serial_deregister(struct usb_serial_driver
*device
)
1256 /* must be called with BKL held */
1257 printk(KERN_INFO
"USB Serial deregistering driver %s\n",
1258 device
->description
);
1259 list_del(&device
->driver_list
);
1260 usb_serial_bus_deregister(device
);
1262 EXPORT_SYMBOL_GPL(usb_serial_deregister
);
1264 /* Module information */
1265 MODULE_AUTHOR(DRIVER_AUTHOR
);
1266 MODULE_DESCRIPTION(DRIVER_DESC
);
1267 MODULE_LICENSE("GPL");
1269 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1270 MODULE_PARM_DESC(debug
, "Debug enabled or not");