Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * USB Serial Converter driver
4 *
5 * Copyright (C) 2009 - 2013 Johan Hovold (jhovold@gmail.com)
6 * Copyright (C) 1999 - 2012 Greg Kroah-Hartman (greg@kroah.com)
7 * Copyright (C) 2000 Peter Berger (pberger@brimson.com)
8 * Copyright (C) 2000 Al Borchers (borchers@steinerpoint.com)
9 *
10 * This driver was originally based on the ACM driver by Armin Fuerst (which was
11 * based on a driver by Brad Keryan)
12 *
13 * See Documentation/usb/usb-serial.rst for more information on using this
14 * driver
15 */
16
17#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18
19#include <linux/kernel.h>
20#include <linux/errno.h>
21#include <linux/init.h>
22#include <linux/slab.h>
23#include <linux/tty.h>
24#include <linux/tty_driver.h>
25#include <linux/tty_flip.h>
26#include <linux/module.h>
27#include <linux/moduleparam.h>
28#include <linux/seq_file.h>
29#include <linux/spinlock.h>
30#include <linux/mutex.h>
31#include <linux/list.h>
32#include <linux/uaccess.h>
33#include <linux/serial.h>
34#include <linux/usb.h>
35#include <linux/usb/serial.h>
36#include <linux/kfifo.h>
37#include <linux/idr.h>
38
39#define DRIVER_AUTHOR "Greg Kroah-Hartman <gregkh@linuxfoundation.org>"
40#define DRIVER_DESC "USB Serial Driver core"
41
42#define USB_SERIAL_TTY_MAJOR 188
43#define USB_SERIAL_TTY_MINORS 512 /* should be enough for a while */
44
45/* There is no MODULE_DEVICE_TABLE for usbserial.c. Instead
46 the MODULE_DEVICE_TABLE declarations in each serial driver
47 cause the "hotplug" program to pull in whatever module is necessary
48 via modprobe, and modprobe will load usbserial because the serial
49 drivers depend on it.
50*/
51
52static DEFINE_IDR(serial_minors);
53static DEFINE_MUTEX(table_lock);
54static LIST_HEAD(usb_serial_driver_list);
55
56/*
57 * Look up the serial port structure. If it is found and it hasn't been
58 * disconnected, return with the parent usb_serial structure's disc_mutex held
59 * and its refcount incremented. Otherwise return NULL.
60 */
61struct usb_serial_port *usb_serial_port_get_by_minor(unsigned minor)
62{
63 struct usb_serial *serial;
64 struct usb_serial_port *port;
65
66 mutex_lock(&table_lock);
67 port = idr_find(&serial_minors, minor);
68 if (!port)
69 goto exit;
70
71 serial = port->serial;
72 mutex_lock(&serial->disc_mutex);
73 if (serial->disconnected) {
74 mutex_unlock(&serial->disc_mutex);
75 port = NULL;
76 } else {
77 kref_get(&serial->kref);
78 }
79exit:
80 mutex_unlock(&table_lock);
81 return port;
82}
83
84static int allocate_minors(struct usb_serial *serial, int num_ports)
85{
86 struct usb_serial_port *port;
87 unsigned int i, j;
88 int minor;
89
90 dev_dbg(&serial->interface->dev, "%s %d\n", __func__, num_ports);
91
92 mutex_lock(&table_lock);
93 for (i = 0; i < num_ports; ++i) {
94 port = serial->port[i];
95 minor = idr_alloc(&serial_minors, port, 0,
96 USB_SERIAL_TTY_MINORS, GFP_KERNEL);
97 if (minor < 0)
98 goto error;
99 port->minor = minor;
100 port->port_number = i;
101 }
102 serial->minors_reserved = 1;
103 mutex_unlock(&table_lock);
104 return 0;
105error:
106 /* unwind the already allocated minors */
107 for (j = 0; j < i; ++j)
108 idr_remove(&serial_minors, serial->port[j]->minor);
109 mutex_unlock(&table_lock);
110 return minor;
111}
112
113static void release_minors(struct usb_serial *serial)
114{
115 int i;
116
117 mutex_lock(&table_lock);
118 for (i = 0; i < serial->num_ports; ++i)
119 idr_remove(&serial_minors, serial->port[i]->minor);
120 mutex_unlock(&table_lock);
121 serial->minors_reserved = 0;
122}
123
124int usb_serial_claim_interface(struct usb_serial *serial, struct usb_interface *intf)
125{
126 struct usb_driver *driver = serial->type->usb_driver;
127 int ret;
128
129 if (serial->sibling)
130 return -EBUSY;
131
132 ret = usb_driver_claim_interface(driver, intf, serial);
133 if (ret) {
134 dev_err(&serial->interface->dev,
135 "failed to claim sibling interface: %d\n", ret);
136 return ret;
137 }
138
139 serial->sibling = intf;
140
141 return 0;
142}
143EXPORT_SYMBOL_GPL(usb_serial_claim_interface);
144
145static void release_sibling(struct usb_serial *serial, struct usb_interface *intf)
146{
147 struct usb_driver *driver = serial->type->usb_driver;
148 struct usb_interface *sibling;
149
150 if (!serial->sibling)
151 return;
152
153 if (intf == serial->sibling)
154 sibling = serial->interface;
155 else
156 sibling = serial->sibling;
157
158 usb_set_intfdata(sibling, NULL);
159 usb_driver_release_interface(driver, sibling);
160}
161
162static void destroy_serial(struct kref *kref)
163{
164 struct usb_serial *serial;
165 struct usb_serial_port *port;
166 int i;
167
168 serial = to_usb_serial(kref);
169
170 /* return the minor range that this device had */
171 if (serial->minors_reserved)
172 release_minors(serial);
173
174 if (serial->attached && serial->type->release)
175 serial->type->release(serial);
176
177 /* Now that nothing is using the ports, they can be freed */
178 for (i = 0; i < serial->num_port_pointers; ++i) {
179 port = serial->port[i];
180 if (port) {
181 port->serial = NULL;
182 put_device(&port->dev);
183 }
184 }
185
186 usb_put_intf(serial->interface);
187 usb_put_dev(serial->dev);
188 kfree(serial);
189}
190
191void usb_serial_put(struct usb_serial *serial)
192{
193 kref_put(&serial->kref, destroy_serial);
194}
195
196/*****************************************************************************
197 * Driver tty interface functions
198 *****************************************************************************/
199
200/**
201 * serial_install - install tty
202 * @driver: the driver (USB in our case)
203 * @tty: the tty being created
204 *
205 * Initialise the termios structure for this tty. We use the default
206 * USB serial settings but permit them to be overridden by
207 * serial->type->init_termios on first open.
208 *
209 * This is the first place a new tty gets used. Hence this is where we
210 * acquire references to the usb_serial structure and the driver module,
211 * where we store a pointer to the port. All these actions are reversed
212 * in serial_cleanup().
213 */
214static int serial_install(struct tty_driver *driver, struct tty_struct *tty)
215{
216 int idx = tty->index;
217 struct usb_serial *serial;
218 struct usb_serial_port *port;
219 bool init_termios;
220 int retval = -ENODEV;
221
222 port = usb_serial_port_get_by_minor(idx);
223 if (!port)
224 return retval;
225
226 serial = port->serial;
227 if (!try_module_get(serial->type->driver.owner))
228 goto err_put_serial;
229
230 init_termios = (driver->termios[idx] == NULL);
231
232 retval = tty_standard_install(driver, tty);
233 if (retval)
234 goto err_put_module;
235
236 mutex_unlock(&serial->disc_mutex);
237
238 /* allow the driver to update the initial settings */
239 if (init_termios && serial->type->init_termios)
240 serial->type->init_termios(tty);
241
242 tty->driver_data = port;
243
244 return retval;
245
246err_put_module:
247 module_put(serial->type->driver.owner);
248err_put_serial:
249 usb_serial_put(serial);
250 mutex_unlock(&serial->disc_mutex);
251 return retval;
252}
253
254static int serial_port_activate(struct tty_port *tport, struct tty_struct *tty)
255{
256 struct usb_serial_port *port =
257 container_of(tport, struct usb_serial_port, port);
258 struct usb_serial *serial = port->serial;
259 int retval;
260
261 mutex_lock(&serial->disc_mutex);
262 if (serial->disconnected) {
263 retval = -ENODEV;
264 goto out_unlock;
265 }
266
267 retval = usb_autopm_get_interface(serial->interface);
268 if (retval)
269 goto out_unlock;
270
271 retval = port->serial->type->open(tty, port);
272 if (retval)
273 usb_autopm_put_interface(serial->interface);
274out_unlock:
275 mutex_unlock(&serial->disc_mutex);
276
277 if (retval < 0)
278 retval = usb_translate_errors(retval);
279
280 return retval;
281}
282
283static int serial_open(struct tty_struct *tty, struct file *filp)
284{
285 struct usb_serial_port *port = tty->driver_data;
286
287 dev_dbg(&port->dev, "%s\n", __func__);
288
289 return tty_port_open(&port->port, tty, filp);
290}
291
292/**
293 * serial_port_shutdown - shut down hardware
294 * @tport: tty port to shut down
295 *
296 * Shut down a USB serial port. Serialized against activate by the
297 * tport mutex and kept to matching open/close pairs
298 * of calls by the tty-port initialized flag.
299 *
300 * Not called if tty is console.
301 */
302static void serial_port_shutdown(struct tty_port *tport)
303{
304 struct usb_serial_port *port =
305 container_of(tport, struct usb_serial_port, port);
306 struct usb_serial_driver *drv = port->serial->type;
307
308 if (drv->close)
309 drv->close(port);
310
311 usb_autopm_put_interface(port->serial->interface);
312}
313
314static void serial_hangup(struct tty_struct *tty)
315{
316 struct usb_serial_port *port = tty->driver_data;
317
318 dev_dbg(&port->dev, "%s\n", __func__);
319
320 tty_port_hangup(&port->port);
321}
322
323static void serial_close(struct tty_struct *tty, struct file *filp)
324{
325 struct usb_serial_port *port = tty->driver_data;
326
327 dev_dbg(&port->dev, "%s\n", __func__);
328
329 tty_port_close(&port->port, tty, filp);
330}
331
332/**
333 * serial_cleanup - free resources post close/hangup
334 * @tty: tty to clean up
335 *
336 * Do the resource freeing and refcount dropping for the port.
337 * Avoid freeing the console.
338 *
339 * Called asynchronously after the last tty kref is dropped.
340 */
341static void serial_cleanup(struct tty_struct *tty)
342{
343 struct usb_serial_port *port = tty->driver_data;
344 struct usb_serial *serial;
345 struct module *owner;
346
347 dev_dbg(&port->dev, "%s\n", __func__);
348
349 /* The console is magical. Do not hang up the console hardware
350 * or there will be tears.
351 */
352 if (port->port.console)
353 return;
354
355 tty->driver_data = NULL;
356
357 serial = port->serial;
358 owner = serial->type->driver.owner;
359
360 usb_serial_put(serial);
361 module_put(owner);
362}
363
364static ssize_t serial_write(struct tty_struct *tty, const u8 *buf, size_t count)
365{
366 struct usb_serial_port *port = tty->driver_data;
367 int retval = -ENODEV;
368
369 if (port->serial->dev->state == USB_STATE_NOTATTACHED)
370 goto exit;
371
372 dev_dbg(&port->dev, "%s - %zu byte(s)\n", __func__, count);
373
374 retval = port->serial->type->write(tty, port, buf, count);
375 if (retval < 0)
376 retval = usb_translate_errors(retval);
377exit:
378 return retval;
379}
380
381static unsigned int serial_write_room(struct tty_struct *tty)
382{
383 struct usb_serial_port *port = tty->driver_data;
384
385 dev_dbg(&port->dev, "%s\n", __func__);
386
387 return port->serial->type->write_room(tty);
388}
389
390static unsigned int serial_chars_in_buffer(struct tty_struct *tty)
391{
392 struct usb_serial_port *port = tty->driver_data;
393 struct usb_serial *serial = port->serial;
394
395 dev_dbg(&port->dev, "%s\n", __func__);
396
397 if (serial->disconnected)
398 return 0;
399
400 return serial->type->chars_in_buffer(tty);
401}
402
403static void serial_wait_until_sent(struct tty_struct *tty, int timeout)
404{
405 struct usb_serial_port *port = tty->driver_data;
406 struct usb_serial *serial = port->serial;
407
408 dev_dbg(&port->dev, "%s\n", __func__);
409
410 if (!port->serial->type->wait_until_sent)
411 return;
412
413 mutex_lock(&serial->disc_mutex);
414 if (!serial->disconnected)
415 port->serial->type->wait_until_sent(tty, timeout);
416 mutex_unlock(&serial->disc_mutex);
417}
418
419static void serial_throttle(struct tty_struct *tty)
420{
421 struct usb_serial_port *port = tty->driver_data;
422
423 dev_dbg(&port->dev, "%s\n", __func__);
424
425 if (port->serial->type->throttle)
426 port->serial->type->throttle(tty);
427}
428
429static void serial_unthrottle(struct tty_struct *tty)
430{
431 struct usb_serial_port *port = tty->driver_data;
432
433 dev_dbg(&port->dev, "%s\n", __func__);
434
435 if (port->serial->type->unthrottle)
436 port->serial->type->unthrottle(tty);
437}
438
439static int serial_get_serial(struct tty_struct *tty, struct serial_struct *ss)
440{
441 struct usb_serial_port *port = tty->driver_data;
442 struct tty_port *tport = &port->port;
443 unsigned int close_delay, closing_wait;
444
445 mutex_lock(&tport->mutex);
446
447 close_delay = jiffies_to_msecs(tport->close_delay) / 10;
448 closing_wait = tport->closing_wait;
449 if (closing_wait != ASYNC_CLOSING_WAIT_NONE)
450 closing_wait = jiffies_to_msecs(closing_wait) / 10;
451
452 ss->line = port->minor;
453 ss->close_delay = close_delay;
454 ss->closing_wait = closing_wait;
455
456 if (port->serial->type->get_serial)
457 port->serial->type->get_serial(tty, ss);
458
459 mutex_unlock(&tport->mutex);
460
461 return 0;
462}
463
464static int serial_set_serial(struct tty_struct *tty, struct serial_struct *ss)
465{
466 struct usb_serial_port *port = tty->driver_data;
467 struct tty_port *tport = &port->port;
468 unsigned int close_delay, closing_wait;
469 int ret = 0;
470
471 close_delay = msecs_to_jiffies(ss->close_delay * 10);
472 closing_wait = ss->closing_wait;
473 if (closing_wait != ASYNC_CLOSING_WAIT_NONE)
474 closing_wait = msecs_to_jiffies(closing_wait * 10);
475
476 mutex_lock(&tport->mutex);
477
478 if (!capable(CAP_SYS_ADMIN)) {
479 if (close_delay != tport->close_delay ||
480 closing_wait != tport->closing_wait) {
481 ret = -EPERM;
482 goto out_unlock;
483 }
484 }
485
486 if (port->serial->type->set_serial) {
487 ret = port->serial->type->set_serial(tty, ss);
488 if (ret)
489 goto out_unlock;
490 }
491
492 tport->close_delay = close_delay;
493 tport->closing_wait = closing_wait;
494out_unlock:
495 mutex_unlock(&tport->mutex);
496
497 return ret;
498}
499
500static int serial_ioctl(struct tty_struct *tty,
501 unsigned int cmd, unsigned long arg)
502{
503 struct usb_serial_port *port = tty->driver_data;
504 int retval = -ENOIOCTLCMD;
505
506 dev_dbg(&port->dev, "%s - cmd 0x%04x\n", __func__, cmd);
507
508 switch (cmd) {
509 case TIOCMIWAIT:
510 if (port->serial->type->tiocmiwait)
511 retval = port->serial->type->tiocmiwait(tty, arg);
512 break;
513 default:
514 if (port->serial->type->ioctl)
515 retval = port->serial->type->ioctl(tty, cmd, arg);
516 }
517
518 return retval;
519}
520
521static void serial_set_termios(struct tty_struct *tty,
522 const struct ktermios *old)
523{
524 struct usb_serial_port *port = tty->driver_data;
525
526 dev_dbg(&port->dev, "%s\n", __func__);
527
528 if (port->serial->type->set_termios)
529 port->serial->type->set_termios(tty, port, old);
530 else
531 tty_termios_copy_hw(&tty->termios, old);
532}
533
534static int serial_break(struct tty_struct *tty, int break_state)
535{
536 struct usb_serial_port *port = tty->driver_data;
537
538 dev_dbg(&port->dev, "%s\n", __func__);
539
540 if (port->serial->type->break_ctl)
541 return port->serial->type->break_ctl(tty, break_state);
542
543 return -ENOTTY;
544}
545
546static int serial_proc_show(struct seq_file *m, void *v)
547{
548 struct usb_serial *serial;
549 struct usb_serial_port *port;
550 int i;
551 char tmp[40];
552
553 seq_puts(m, "usbserinfo:1.0 driver:2.0\n");
554 for (i = 0; i < USB_SERIAL_TTY_MINORS; ++i) {
555 port = usb_serial_port_get_by_minor(i);
556 if (port == NULL)
557 continue;
558 serial = port->serial;
559
560 seq_printf(m, "%d:", i);
561 if (serial->type->driver.owner)
562 seq_printf(m, " module:%s",
563 module_name(serial->type->driver.owner));
564 seq_printf(m, " name:\"%s\"",
565 serial->type->description);
566 seq_printf(m, " vendor:%04x product:%04x",
567 le16_to_cpu(serial->dev->descriptor.idVendor),
568 le16_to_cpu(serial->dev->descriptor.idProduct));
569 seq_printf(m, " num_ports:%d", serial->num_ports);
570 seq_printf(m, " port:%d", port->port_number);
571 usb_make_path(serial->dev, tmp, sizeof(tmp));
572 seq_printf(m, " path:%s", tmp);
573
574 seq_putc(m, '\n');
575 usb_serial_put(serial);
576 mutex_unlock(&serial->disc_mutex);
577 }
578 return 0;
579}
580
581static int serial_tiocmget(struct tty_struct *tty)
582{
583 struct usb_serial_port *port = tty->driver_data;
584
585 dev_dbg(&port->dev, "%s\n", __func__);
586
587 if (port->serial->type->tiocmget)
588 return port->serial->type->tiocmget(tty);
589 return -ENOTTY;
590}
591
592static int serial_tiocmset(struct tty_struct *tty,
593 unsigned int set, unsigned int clear)
594{
595 struct usb_serial_port *port = tty->driver_data;
596
597 dev_dbg(&port->dev, "%s\n", __func__);
598
599 if (port->serial->type->tiocmset)
600 return port->serial->type->tiocmset(tty, set, clear);
601 return -ENOTTY;
602}
603
604static int serial_get_icount(struct tty_struct *tty,
605 struct serial_icounter_struct *icount)
606{
607 struct usb_serial_port *port = tty->driver_data;
608
609 dev_dbg(&port->dev, "%s\n", __func__);
610
611 if (port->serial->type->get_icount)
612 return port->serial->type->get_icount(tty, icount);
613 return -ENOTTY;
614}
615
616/*
617 * We would be calling tty_wakeup here, but unfortunately some line
618 * disciplines have an annoying habit of calling tty->write from
619 * the write wakeup callback (e.g. n_hdlc.c).
620 */
621void usb_serial_port_softint(struct usb_serial_port *port)
622{
623 schedule_work(&port->work);
624}
625EXPORT_SYMBOL_GPL(usb_serial_port_softint);
626
627static void usb_serial_port_work(struct work_struct *work)
628{
629 struct usb_serial_port *port =
630 container_of(work, struct usb_serial_port, work);
631
632 tty_port_tty_wakeup(&port->port);
633}
634
635static void usb_serial_port_poison_urbs(struct usb_serial_port *port)
636{
637 int i;
638
639 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i)
640 usb_poison_urb(port->read_urbs[i]);
641 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
642 usb_poison_urb(port->write_urbs[i]);
643
644 usb_poison_urb(port->interrupt_in_urb);
645 usb_poison_urb(port->interrupt_out_urb);
646}
647
648static void usb_serial_port_unpoison_urbs(struct usb_serial_port *port)
649{
650 int i;
651
652 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i)
653 usb_unpoison_urb(port->read_urbs[i]);
654 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
655 usb_unpoison_urb(port->write_urbs[i]);
656
657 usb_unpoison_urb(port->interrupt_in_urb);
658 usb_unpoison_urb(port->interrupt_out_urb);
659}
660
661static void usb_serial_port_release(struct device *dev)
662{
663 struct usb_serial_port *port = to_usb_serial_port(dev);
664 int i;
665
666 dev_dbg(dev, "%s\n", __func__);
667
668 usb_free_urb(port->interrupt_in_urb);
669 usb_free_urb(port->interrupt_out_urb);
670 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i) {
671 usb_free_urb(port->read_urbs[i]);
672 kfree(port->bulk_in_buffers[i]);
673 }
674 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i) {
675 usb_free_urb(port->write_urbs[i]);
676 kfree(port->bulk_out_buffers[i]);
677 }
678 kfifo_free(&port->write_fifo);
679 kfree(port->interrupt_in_buffer);
680 kfree(port->interrupt_out_buffer);
681 tty_port_destroy(&port->port);
682 kfree(port);
683}
684
685static struct usb_serial *create_serial(struct usb_device *dev,
686 struct usb_interface *interface,
687 struct usb_serial_driver *driver)
688{
689 struct usb_serial *serial;
690
691 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
692 if (!serial)
693 return NULL;
694 serial->dev = usb_get_dev(dev);
695 serial->type = driver;
696 serial->interface = usb_get_intf(interface);
697 kref_init(&serial->kref);
698 mutex_init(&serial->disc_mutex);
699 serial->minors_reserved = 0;
700
701 return serial;
702}
703
704static const struct usb_device_id *match_dynamic_id(struct usb_interface *intf,
705 struct usb_serial_driver *drv)
706{
707 struct usb_dynid *dynid;
708
709 guard(mutex)(&usb_dynids_lock);
710 list_for_each_entry(dynid, &drv->dynids.list, node) {
711 if (usb_match_one_id(intf, &dynid->id)) {
712 return &dynid->id;
713 }
714 }
715 return NULL;
716}
717
718static const struct usb_device_id *get_iface_id(struct usb_serial_driver *drv,
719 struct usb_interface *intf)
720{
721 const struct usb_device_id *id;
722
723 id = usb_match_id(intf, drv->id_table);
724 if (id) {
725 dev_dbg(&intf->dev, "static descriptor matches\n");
726 goto exit;
727 }
728 id = match_dynamic_id(intf, drv);
729 if (id)
730 dev_dbg(&intf->dev, "dynamic descriptor matches\n");
731exit:
732 return id;
733}
734
735/* Caller must hold table_lock */
736static struct usb_serial_driver *search_serial_device(
737 struct usb_interface *iface)
738{
739 const struct usb_device_id *id = NULL;
740 struct usb_serial_driver *drv;
741 struct usb_driver *driver = to_usb_driver(iface->dev.driver);
742
743 /* Check if the usb id matches a known device */
744 list_for_each_entry(drv, &usb_serial_driver_list, driver_list) {
745 if (drv->usb_driver == driver)
746 id = get_iface_id(drv, iface);
747 if (id)
748 return drv;
749 }
750
751 return NULL;
752}
753
754static bool serial_port_carrier_raised(struct tty_port *port)
755{
756 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
757 struct usb_serial_driver *drv = p->serial->type;
758
759 if (drv->carrier_raised)
760 return drv->carrier_raised(p);
761 /* No carrier control - don't block */
762 return true;
763}
764
765static void serial_port_dtr_rts(struct tty_port *port, bool on)
766{
767 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
768 struct usb_serial_driver *drv = p->serial->type;
769
770 if (drv->dtr_rts)
771 drv->dtr_rts(p, on);
772}
773
774static ssize_t port_number_show(struct device *dev,
775 struct device_attribute *attr, char *buf)
776{
777 struct usb_serial_port *port = to_usb_serial_port(dev);
778
779 return sprintf(buf, "%u\n", port->port_number);
780}
781static DEVICE_ATTR_RO(port_number);
782
783static struct attribute *usb_serial_port_attrs[] = {
784 &dev_attr_port_number.attr,
785 NULL
786};
787ATTRIBUTE_GROUPS(usb_serial_port);
788
789static const struct tty_port_operations serial_port_ops = {
790 .carrier_raised = serial_port_carrier_raised,
791 .dtr_rts = serial_port_dtr_rts,
792 .activate = serial_port_activate,
793 .shutdown = serial_port_shutdown,
794};
795
796static void store_endpoint(struct usb_serial *serial,
797 struct usb_serial_endpoints *epds,
798 struct usb_endpoint_descriptor *epd)
799{
800 struct device *dev = &serial->interface->dev;
801 u8 addr = epd->bEndpointAddress;
802
803 if (usb_endpoint_is_bulk_in(epd)) {
804 if (epds->num_bulk_in == ARRAY_SIZE(epds->bulk_in))
805 return;
806 dev_dbg(dev, "found bulk in endpoint %02x\n", addr);
807 epds->bulk_in[epds->num_bulk_in++] = epd;
808 } else if (usb_endpoint_is_bulk_out(epd)) {
809 if (epds->num_bulk_out == ARRAY_SIZE(epds->bulk_out))
810 return;
811 dev_dbg(dev, "found bulk out endpoint %02x\n", addr);
812 epds->bulk_out[epds->num_bulk_out++] = epd;
813 } else if (usb_endpoint_is_int_in(epd)) {
814 if (epds->num_interrupt_in == ARRAY_SIZE(epds->interrupt_in))
815 return;
816 dev_dbg(dev, "found interrupt in endpoint %02x\n", addr);
817 epds->interrupt_in[epds->num_interrupt_in++] = epd;
818 } else if (usb_endpoint_is_int_out(epd)) {
819 if (epds->num_interrupt_out == ARRAY_SIZE(epds->interrupt_out))
820 return;
821 dev_dbg(dev, "found interrupt out endpoint %02x\n", addr);
822 epds->interrupt_out[epds->num_interrupt_out++] = epd;
823 }
824}
825
826static void find_endpoints(struct usb_serial *serial,
827 struct usb_serial_endpoints *epds,
828 struct usb_interface *intf)
829{
830 struct usb_host_interface *iface_desc;
831 struct usb_endpoint_descriptor *epd;
832 unsigned int i;
833
834 iface_desc = intf->cur_altsetting;
835 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
836 epd = &iface_desc->endpoint[i].desc;
837 store_endpoint(serial, epds, epd);
838 }
839}
840
841static int setup_port_bulk_in(struct usb_serial_port *port,
842 struct usb_endpoint_descriptor *epd)
843{
844 struct usb_serial_driver *type = port->serial->type;
845 struct usb_device *udev = port->serial->dev;
846 int buffer_size;
847 int i;
848
849 buffer_size = max_t(int, type->bulk_in_size, usb_endpoint_maxp(epd));
850 port->bulk_in_size = buffer_size;
851 port->bulk_in_endpointAddress = epd->bEndpointAddress;
852
853 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i) {
854 set_bit(i, &port->read_urbs_free);
855 port->read_urbs[i] = usb_alloc_urb(0, GFP_KERNEL);
856 if (!port->read_urbs[i])
857 return -ENOMEM;
858 port->bulk_in_buffers[i] = kmalloc(buffer_size, GFP_KERNEL);
859 if (!port->bulk_in_buffers[i])
860 return -ENOMEM;
861 usb_fill_bulk_urb(port->read_urbs[i], udev,
862 usb_rcvbulkpipe(udev, epd->bEndpointAddress),
863 port->bulk_in_buffers[i], buffer_size,
864 type->read_bulk_callback, port);
865 }
866
867 port->read_urb = port->read_urbs[0];
868 port->bulk_in_buffer = port->bulk_in_buffers[0];
869
870 return 0;
871}
872
873static int setup_port_bulk_out(struct usb_serial_port *port,
874 struct usb_endpoint_descriptor *epd)
875{
876 struct usb_serial_driver *type = port->serial->type;
877 struct usb_device *udev = port->serial->dev;
878 int buffer_size;
879 int i;
880
881 if (kfifo_alloc(&port->write_fifo, PAGE_SIZE, GFP_KERNEL))
882 return -ENOMEM;
883 if (type->bulk_out_size)
884 buffer_size = type->bulk_out_size;
885 else
886 buffer_size = usb_endpoint_maxp(epd);
887 port->bulk_out_size = buffer_size;
888 port->bulk_out_endpointAddress = epd->bEndpointAddress;
889
890 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i) {
891 set_bit(i, &port->write_urbs_free);
892 port->write_urbs[i] = usb_alloc_urb(0, GFP_KERNEL);
893 if (!port->write_urbs[i])
894 return -ENOMEM;
895 port->bulk_out_buffers[i] = kmalloc(buffer_size, GFP_KERNEL);
896 if (!port->bulk_out_buffers[i])
897 return -ENOMEM;
898 usb_fill_bulk_urb(port->write_urbs[i], udev,
899 usb_sndbulkpipe(udev, epd->bEndpointAddress),
900 port->bulk_out_buffers[i], buffer_size,
901 type->write_bulk_callback, port);
902 }
903
904 port->write_urb = port->write_urbs[0];
905 port->bulk_out_buffer = port->bulk_out_buffers[0];
906
907 return 0;
908}
909
910static int setup_port_interrupt_in(struct usb_serial_port *port,
911 struct usb_endpoint_descriptor *epd)
912{
913 struct usb_serial_driver *type = port->serial->type;
914 struct usb_device *udev = port->serial->dev;
915 int buffer_size;
916
917 port->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
918 if (!port->interrupt_in_urb)
919 return -ENOMEM;
920 buffer_size = usb_endpoint_maxp(epd);
921 port->interrupt_in_endpointAddress = epd->bEndpointAddress;
922 port->interrupt_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
923 if (!port->interrupt_in_buffer)
924 return -ENOMEM;
925 usb_fill_int_urb(port->interrupt_in_urb, udev,
926 usb_rcvintpipe(udev, epd->bEndpointAddress),
927 port->interrupt_in_buffer, buffer_size,
928 type->read_int_callback, port,
929 epd->bInterval);
930
931 return 0;
932}
933
934static int setup_port_interrupt_out(struct usb_serial_port *port,
935 struct usb_endpoint_descriptor *epd)
936{
937 struct usb_serial_driver *type = port->serial->type;
938 struct usb_device *udev = port->serial->dev;
939 int buffer_size;
940
941 port->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
942 if (!port->interrupt_out_urb)
943 return -ENOMEM;
944 buffer_size = usb_endpoint_maxp(epd);
945 port->interrupt_out_size = buffer_size;
946 port->interrupt_out_endpointAddress = epd->bEndpointAddress;
947 port->interrupt_out_buffer = kmalloc(buffer_size, GFP_KERNEL);
948 if (!port->interrupt_out_buffer)
949 return -ENOMEM;
950 usb_fill_int_urb(port->interrupt_out_urb, udev,
951 usb_sndintpipe(udev, epd->bEndpointAddress),
952 port->interrupt_out_buffer, buffer_size,
953 type->write_int_callback, port,
954 epd->bInterval);
955
956 return 0;
957}
958
959static int usb_serial_probe(struct usb_interface *interface,
960 const struct usb_device_id *id)
961{
962 struct device *ddev = &interface->dev;
963 struct usb_device *dev = interface_to_usbdev(interface);
964 struct usb_serial *serial = NULL;
965 struct usb_serial_port *port;
966 struct usb_serial_endpoints *epds;
967 struct usb_serial_driver *type = NULL;
968 int retval;
969 int i;
970 int num_ports = 0;
971 unsigned char max_endpoints;
972
973 mutex_lock(&table_lock);
974 type = search_serial_device(interface);
975 if (!type) {
976 mutex_unlock(&table_lock);
977 dev_dbg(ddev, "none matched\n");
978 return -ENODEV;
979 }
980
981 if (!try_module_get(type->driver.owner)) {
982 mutex_unlock(&table_lock);
983 dev_err(ddev, "module get failed, exiting\n");
984 return -EIO;
985 }
986 mutex_unlock(&table_lock);
987
988 serial = create_serial(dev, interface, type);
989 if (!serial) {
990 retval = -ENOMEM;
991 goto err_put_module;
992 }
993
994 /* if this device type has a probe function, call it */
995 if (type->probe) {
996 const struct usb_device_id *id;
997
998 id = get_iface_id(type, interface);
999 retval = type->probe(serial, id);
1000
1001 if (retval) {
1002 dev_dbg(ddev, "sub driver rejected device\n");
1003 goto err_release_sibling;
1004 }
1005 }
1006
1007 /* descriptor matches, let's find the endpoints needed */
1008 epds = kzalloc(sizeof(*epds), GFP_KERNEL);
1009 if (!epds) {
1010 retval = -ENOMEM;
1011 goto err_release_sibling;
1012 }
1013
1014 find_endpoints(serial, epds, interface);
1015 if (serial->sibling)
1016 find_endpoints(serial, epds, serial->sibling);
1017
1018 if (epds->num_bulk_in < type->num_bulk_in ||
1019 epds->num_bulk_out < type->num_bulk_out ||
1020 epds->num_interrupt_in < type->num_interrupt_in ||
1021 epds->num_interrupt_out < type->num_interrupt_out) {
1022 dev_err(ddev, "required endpoints missing\n");
1023 retval = -ENODEV;
1024 goto err_free_epds;
1025 }
1026
1027 if (type->calc_num_ports) {
1028 retval = type->calc_num_ports(serial, epds);
1029 if (retval < 0)
1030 goto err_free_epds;
1031 num_ports = retval;
1032 }
1033
1034 if (!num_ports)
1035 num_ports = type->num_ports;
1036
1037 if (num_ports > MAX_NUM_PORTS) {
1038 dev_warn(ddev, "too many ports requested: %d\n", num_ports);
1039 num_ports = MAX_NUM_PORTS;
1040 }
1041
1042 serial->num_ports = (unsigned char)num_ports;
1043 serial->num_bulk_in = epds->num_bulk_in;
1044 serial->num_bulk_out = epds->num_bulk_out;
1045 serial->num_interrupt_in = epds->num_interrupt_in;
1046 serial->num_interrupt_out = epds->num_interrupt_out;
1047
1048 /* found all that we need */
1049 dev_info(ddev, "%s converter detected\n", type->description);
1050
1051 /* create our ports, we need as many as the max endpoints */
1052 /* we don't use num_ports here because some devices have more
1053 endpoint pairs than ports */
1054 max_endpoints = max(epds->num_bulk_in, epds->num_bulk_out);
1055 max_endpoints = max(max_endpoints, epds->num_interrupt_in);
1056 max_endpoints = max(max_endpoints, epds->num_interrupt_out);
1057 max_endpoints = max(max_endpoints, serial->num_ports);
1058 serial->num_port_pointers = max_endpoints;
1059
1060 dev_dbg(ddev, "setting up %d port structure(s)\n", max_endpoints);
1061 for (i = 0; i < max_endpoints; ++i) {
1062 port = kzalloc(sizeof(struct usb_serial_port), GFP_KERNEL);
1063 if (!port) {
1064 retval = -ENOMEM;
1065 goto err_free_epds;
1066 }
1067 tty_port_init(&port->port);
1068 port->port.ops = &serial_port_ops;
1069 port->serial = serial;
1070 spin_lock_init(&port->lock);
1071 /* Keep this for private driver use for the moment but
1072 should probably go away */
1073 INIT_WORK(&port->work, usb_serial_port_work);
1074 serial->port[i] = port;
1075 port->dev.parent = &interface->dev;
1076 port->dev.driver = NULL;
1077 port->dev.bus = &usb_serial_bus_type;
1078 port->dev.release = &usb_serial_port_release;
1079 port->dev.groups = usb_serial_port_groups;
1080 device_initialize(&port->dev);
1081 }
1082
1083 /* set up the endpoint information */
1084 for (i = 0; i < epds->num_bulk_in; ++i) {
1085 retval = setup_port_bulk_in(serial->port[i], epds->bulk_in[i]);
1086 if (retval)
1087 goto err_free_epds;
1088 }
1089
1090 for (i = 0; i < epds->num_bulk_out; ++i) {
1091 retval = setup_port_bulk_out(serial->port[i],
1092 epds->bulk_out[i]);
1093 if (retval)
1094 goto err_free_epds;
1095 }
1096
1097 if (serial->type->read_int_callback) {
1098 for (i = 0; i < epds->num_interrupt_in; ++i) {
1099 retval = setup_port_interrupt_in(serial->port[i],
1100 epds->interrupt_in[i]);
1101 if (retval)
1102 goto err_free_epds;
1103 }
1104 } else if (epds->num_interrupt_in) {
1105 dev_dbg(ddev, "The device claims to support interrupt in transfers, but read_int_callback is not defined\n");
1106 }
1107
1108 if (serial->type->write_int_callback) {
1109 for (i = 0; i < epds->num_interrupt_out; ++i) {
1110 retval = setup_port_interrupt_out(serial->port[i],
1111 epds->interrupt_out[i]);
1112 if (retval)
1113 goto err_free_epds;
1114 }
1115 } else if (epds->num_interrupt_out) {
1116 dev_dbg(ddev, "The device claims to support interrupt out transfers, but write_int_callback is not defined\n");
1117 }
1118
1119 usb_set_intfdata(interface, serial);
1120
1121 /* if this device type has an attach function, call it */
1122 if (type->attach) {
1123 retval = type->attach(serial);
1124 if (retval < 0)
1125 goto err_free_epds;
1126 serial->attached = 1;
1127 if (retval > 0) {
1128 /* quietly accept this device, but don't bind to a
1129 serial port as it's about to disappear */
1130 serial->num_ports = 0;
1131 goto exit;
1132 }
1133 } else {
1134 serial->attached = 1;
1135 }
1136
1137 retval = allocate_minors(serial, num_ports);
1138 if (retval) {
1139 dev_err(ddev, "No more free serial minor numbers\n");
1140 goto err_free_epds;
1141 }
1142
1143 /* register all of the individual ports with the driver core */
1144 for (i = 0; i < num_ports; ++i) {
1145 port = serial->port[i];
1146 dev_set_name(&port->dev, "ttyUSB%d", port->minor);
1147 dev_dbg(ddev, "registering %s\n", dev_name(&port->dev));
1148 device_enable_async_suspend(&port->dev);
1149
1150 retval = device_add(&port->dev);
1151 if (retval)
1152 dev_err(ddev, "Error registering port device, continuing\n");
1153 }
1154
1155 if (num_ports > 0)
1156 usb_serial_console_init(serial->port[0]->minor);
1157exit:
1158 kfree(epds);
1159 module_put(type->driver.owner);
1160 return 0;
1161
1162err_free_epds:
1163 kfree(epds);
1164err_release_sibling:
1165 release_sibling(serial, interface);
1166 usb_serial_put(serial);
1167err_put_module:
1168 module_put(type->driver.owner);
1169
1170 return retval;
1171}
1172
1173static void usb_serial_disconnect(struct usb_interface *interface)
1174{
1175 int i;
1176 struct usb_serial *serial = usb_get_intfdata(interface);
1177 struct device *dev = &interface->dev;
1178 struct usb_serial_port *port;
1179 struct tty_struct *tty;
1180
1181 /* sibling interface is cleaning up */
1182 if (!serial)
1183 return;
1184
1185 usb_serial_console_disconnect(serial);
1186
1187 mutex_lock(&serial->disc_mutex);
1188 /* must set a flag, to signal subdrivers */
1189 serial->disconnected = 1;
1190 mutex_unlock(&serial->disc_mutex);
1191
1192 for (i = 0; i < serial->num_ports; ++i) {
1193 port = serial->port[i];
1194 tty = tty_port_tty_get(&port->port);
1195 if (tty) {
1196 tty_vhangup(tty);
1197 tty_kref_put(tty);
1198 }
1199 usb_serial_port_poison_urbs(port);
1200 wake_up_interruptible(&port->port.delta_msr_wait);
1201 cancel_work_sync(&port->work);
1202 if (device_is_registered(&port->dev))
1203 device_del(&port->dev);
1204 }
1205 if (serial->type->disconnect)
1206 serial->type->disconnect(serial);
1207
1208 release_sibling(serial, interface);
1209
1210 /* let the last holder of this object cause it to be cleaned up */
1211 usb_serial_put(serial);
1212 dev_info(dev, "device disconnected\n");
1213}
1214
1215int usb_serial_suspend(struct usb_interface *intf, pm_message_t message)
1216{
1217 struct usb_serial *serial = usb_get_intfdata(intf);
1218 int i, r;
1219
1220 /* suspend when called for first sibling interface */
1221 if (serial->suspend_count++)
1222 return 0;
1223
1224 /*
1225 * serial->type->suspend() MUST return 0 in system sleep context,
1226 * otherwise, the resume callback has to recover device from
1227 * previous suspend failure.
1228 */
1229 if (serial->type->suspend) {
1230 r = serial->type->suspend(serial, message);
1231 if (r < 0) {
1232 serial->suspend_count--;
1233 return r;
1234 }
1235 }
1236
1237 for (i = 0; i < serial->num_ports; ++i)
1238 usb_serial_port_poison_urbs(serial->port[i]);
1239
1240 return 0;
1241}
1242EXPORT_SYMBOL(usb_serial_suspend);
1243
1244static void usb_serial_unpoison_port_urbs(struct usb_serial *serial)
1245{
1246 int i;
1247
1248 for (i = 0; i < serial->num_ports; ++i)
1249 usb_serial_port_unpoison_urbs(serial->port[i]);
1250}
1251
1252int usb_serial_resume(struct usb_interface *intf)
1253{
1254 struct usb_serial *serial = usb_get_intfdata(intf);
1255 int rv;
1256
1257 /* resume when called for last sibling interface */
1258 if (--serial->suspend_count)
1259 return 0;
1260
1261 usb_serial_unpoison_port_urbs(serial);
1262
1263 if (serial->type->resume)
1264 rv = serial->type->resume(serial);
1265 else
1266 rv = usb_serial_generic_resume(serial);
1267
1268 return rv;
1269}
1270EXPORT_SYMBOL(usb_serial_resume);
1271
1272static int usb_serial_reset_resume(struct usb_interface *intf)
1273{
1274 struct usb_serial *serial = usb_get_intfdata(intf);
1275 int rv;
1276
1277 /* resume when called for last sibling interface */
1278 if (--serial->suspend_count)
1279 return 0;
1280
1281 usb_serial_unpoison_port_urbs(serial);
1282
1283 if (serial->type->reset_resume) {
1284 rv = serial->type->reset_resume(serial);
1285 } else {
1286 rv = -EOPNOTSUPP;
1287 intf->needs_binding = 1;
1288 }
1289
1290 return rv;
1291}
1292
1293static const struct tty_operations serial_ops = {
1294 .open = serial_open,
1295 .close = serial_close,
1296 .write = serial_write,
1297 .hangup = serial_hangup,
1298 .write_room = serial_write_room,
1299 .ioctl = serial_ioctl,
1300 .set_termios = serial_set_termios,
1301 .throttle = serial_throttle,
1302 .unthrottle = serial_unthrottle,
1303 .break_ctl = serial_break,
1304 .chars_in_buffer = serial_chars_in_buffer,
1305 .wait_until_sent = serial_wait_until_sent,
1306 .tiocmget = serial_tiocmget,
1307 .tiocmset = serial_tiocmset,
1308 .get_icount = serial_get_icount,
1309 .set_serial = serial_set_serial,
1310 .get_serial = serial_get_serial,
1311 .cleanup = serial_cleanup,
1312 .install = serial_install,
1313 .proc_show = serial_proc_show,
1314};
1315
1316
1317struct tty_driver *usb_serial_tty_driver;
1318
1319static int __init usb_serial_init(void)
1320{
1321 int result;
1322
1323 usb_serial_tty_driver = tty_alloc_driver(USB_SERIAL_TTY_MINORS,
1324 TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV);
1325 if (IS_ERR(usb_serial_tty_driver))
1326 return PTR_ERR(usb_serial_tty_driver);
1327
1328 /* Initialize our global data */
1329 result = bus_register(&usb_serial_bus_type);
1330 if (result) {
1331 pr_err("%s - registering bus driver failed\n", __func__);
1332 goto err_put_driver;
1333 }
1334
1335 usb_serial_tty_driver->driver_name = "usbserial";
1336 usb_serial_tty_driver->name = "ttyUSB";
1337 usb_serial_tty_driver->major = USB_SERIAL_TTY_MAJOR;
1338 usb_serial_tty_driver->minor_start = 0;
1339 usb_serial_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1340 usb_serial_tty_driver->subtype = SERIAL_TYPE_NORMAL;
1341 usb_serial_tty_driver->init_termios = tty_std_termios;
1342 usb_serial_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD
1343 | HUPCL | CLOCAL;
1344 usb_serial_tty_driver->init_termios.c_ispeed = 9600;
1345 usb_serial_tty_driver->init_termios.c_ospeed = 9600;
1346 tty_set_operations(usb_serial_tty_driver, &serial_ops);
1347 result = tty_register_driver(usb_serial_tty_driver);
1348 if (result) {
1349 pr_err("%s - tty_register_driver failed\n", __func__);
1350 goto err_unregister_bus;
1351 }
1352
1353 /* register the generic driver, if we should */
1354 result = usb_serial_generic_register();
1355 if (result < 0) {
1356 pr_err("%s - registering generic driver failed\n", __func__);
1357 goto err_unregister_driver;
1358 }
1359
1360 return result;
1361
1362err_unregister_driver:
1363 tty_unregister_driver(usb_serial_tty_driver);
1364err_unregister_bus:
1365 bus_unregister(&usb_serial_bus_type);
1366err_put_driver:
1367 pr_err("%s - returning with error %d\n", __func__, result);
1368 tty_driver_kref_put(usb_serial_tty_driver);
1369 return result;
1370}
1371
1372
1373static void __exit usb_serial_exit(void)
1374{
1375 usb_serial_console_exit();
1376
1377 usb_serial_generic_deregister();
1378
1379 tty_unregister_driver(usb_serial_tty_driver);
1380 tty_driver_kref_put(usb_serial_tty_driver);
1381 bus_unregister(&usb_serial_bus_type);
1382 idr_destroy(&serial_minors);
1383}
1384
1385
1386module_init(usb_serial_init);
1387module_exit(usb_serial_exit);
1388
1389#define set_to_generic_if_null(type, function) \
1390 do { \
1391 if (!type->function) { \
1392 type->function = usb_serial_generic_##function; \
1393 pr_debug("%s: using generic " #function "\n", \
1394 type->driver.name); \
1395 } \
1396 } while (0)
1397
1398static void usb_serial_operations_init(struct usb_serial_driver *device)
1399{
1400 set_to_generic_if_null(device, open);
1401 set_to_generic_if_null(device, write);
1402 set_to_generic_if_null(device, close);
1403 set_to_generic_if_null(device, write_room);
1404 set_to_generic_if_null(device, chars_in_buffer);
1405 if (device->tx_empty)
1406 set_to_generic_if_null(device, wait_until_sent);
1407 set_to_generic_if_null(device, read_bulk_callback);
1408 set_to_generic_if_null(device, write_bulk_callback);
1409 set_to_generic_if_null(device, process_read_urb);
1410 set_to_generic_if_null(device, prepare_write_buffer);
1411}
1412
1413static int usb_serial_register(struct usb_serial_driver *driver)
1414{
1415 int retval;
1416
1417 if (usb_disabled())
1418 return -ENODEV;
1419
1420 if (!driver->description)
1421 driver->description = driver->driver.name;
1422 if (!driver->usb_driver) {
1423 WARN(1, "Serial driver %s has no usb_driver\n",
1424 driver->description);
1425 return -EINVAL;
1426 }
1427
1428 /* Prevent individual ports from being unbound. */
1429 driver->driver.suppress_bind_attrs = true;
1430
1431 usb_serial_operations_init(driver);
1432
1433 /* Add this device to our list of devices */
1434 mutex_lock(&table_lock);
1435 list_add(&driver->driver_list, &usb_serial_driver_list);
1436
1437 retval = usb_serial_bus_register(driver);
1438 if (retval) {
1439 pr_err("problem %d when registering driver %s\n", retval, driver->description);
1440 list_del(&driver->driver_list);
1441 } else {
1442 pr_info("USB Serial support registered for %s\n", driver->description);
1443 }
1444 mutex_unlock(&table_lock);
1445 return retval;
1446}
1447
1448static void usb_serial_deregister(struct usb_serial_driver *device)
1449{
1450 pr_info("USB Serial deregistering driver %s\n", device->description);
1451
1452 mutex_lock(&table_lock);
1453 list_del(&device->driver_list);
1454 mutex_unlock(&table_lock);
1455
1456 usb_serial_bus_deregister(device);
1457}
1458
1459/**
1460 * __usb_serial_register_drivers - register drivers for a usb-serial module
1461 * @serial_drivers: NULL-terminated array of pointers to drivers to be registered
1462 * @owner: owning module
1463 * @name: name of the usb_driver for this set of @serial_drivers
1464 * @id_table: list of all devices this @serial_drivers set binds to
1465 *
1466 * Registers all the drivers in the @serial_drivers array, and dynamically
1467 * creates a struct usb_driver with the name @name and id_table of @id_table.
1468 */
1469int __usb_serial_register_drivers(struct usb_serial_driver *const serial_drivers[],
1470 struct module *owner, const char *name,
1471 const struct usb_device_id *id_table)
1472{
1473 int rc;
1474 struct usb_driver *udriver;
1475 struct usb_serial_driver * const *sd;
1476
1477 /*
1478 * udriver must be registered before any of the serial drivers,
1479 * because the store_new_id() routine for the serial drivers (in
1480 * bus.c) probes udriver.
1481 *
1482 * Performance hack: We don't want udriver to be probed until
1483 * the serial drivers are registered, because the probe would
1484 * simply fail for lack of a matching serial driver.
1485 * So we leave udriver's id_table set to NULL until we are all set.
1486 *
1487 * Suspend/resume support is implemented in the usb-serial core,
1488 * so fill in the PM-related fields in udriver.
1489 */
1490 udriver = kzalloc(sizeof(*udriver), GFP_KERNEL);
1491 if (!udriver)
1492 return -ENOMEM;
1493
1494 udriver->name = name;
1495 udriver->no_dynamic_id = 1;
1496 udriver->supports_autosuspend = 1;
1497 udriver->suspend = usb_serial_suspend;
1498 udriver->resume = usb_serial_resume;
1499 udriver->probe = usb_serial_probe;
1500 udriver->disconnect = usb_serial_disconnect;
1501
1502 /* we only set the reset_resume field if the serial_driver has one */
1503 for (sd = serial_drivers; *sd; ++sd) {
1504 if ((*sd)->reset_resume) {
1505 udriver->reset_resume = usb_serial_reset_resume;
1506 break;
1507 }
1508 }
1509
1510 rc = usb_register(udriver);
1511 if (rc)
1512 goto err_free_driver;
1513
1514 for (sd = serial_drivers; *sd; ++sd) {
1515 (*sd)->usb_driver = udriver;
1516 (*sd)->driver.owner = owner;
1517 rc = usb_serial_register(*sd);
1518 if (rc)
1519 goto err_deregister_drivers;
1520 }
1521
1522 /* Now set udriver's id_table and look for matches */
1523 udriver->id_table = id_table;
1524 rc = driver_attach(&udriver->driver);
1525 return 0;
1526
1527err_deregister_drivers:
1528 while (sd-- > serial_drivers)
1529 usb_serial_deregister(*sd);
1530 usb_deregister(udriver);
1531err_free_driver:
1532 kfree(udriver);
1533 return rc;
1534}
1535EXPORT_SYMBOL_GPL(__usb_serial_register_drivers);
1536
1537/**
1538 * usb_serial_deregister_drivers - deregister drivers for a usb-serial module
1539 * @serial_drivers: NULL-terminated array of pointers to drivers to be deregistered
1540 *
1541 * Deregisters all the drivers in the @serial_drivers array and deregisters and
1542 * frees the struct usb_driver that was created by the call to
1543 * usb_serial_register_drivers().
1544 */
1545void usb_serial_deregister_drivers(struct usb_serial_driver *const serial_drivers[])
1546{
1547 struct usb_driver *udriver = (*serial_drivers)->usb_driver;
1548
1549 for (; *serial_drivers; ++serial_drivers)
1550 usb_serial_deregister(*serial_drivers);
1551 usb_deregister(udriver);
1552 kfree(udriver);
1553}
1554EXPORT_SYMBOL_GPL(usb_serial_deregister_drivers);
1555
1556MODULE_AUTHOR(DRIVER_AUTHOR);
1557MODULE_DESCRIPTION(DRIVER_DESC);
1558MODULE_LICENSE("GPL v2");
1/*
2 * USB Serial Converter driver
3 *
4 * Copyright (C) 1999 - 2012 Greg Kroah-Hartman (greg@kroah.com)
5 * Copyright (C) 2000 Peter Berger (pberger@brimson.com)
6 * Copyright (C) 2000 Al Borchers (borchers@steinerpoint.com)
7 *
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.
11 *
12 * This driver was originally based on the ACM driver by Armin Fuerst (which was
13 * based on a driver by Brad Keryan)
14 *
15 * See Documentation/usb/usb-serial.txt for more information on using this
16 * driver
17 *
18 */
19
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>
38#include "pl2303.h"
39
40/*
41 * Version Information
42 */
43#define DRIVER_AUTHOR "Greg Kroah-Hartman, greg@kroah.com, http://www.kroah.com/linux/"
44#define DRIVER_DESC "USB Serial Driver core"
45
46/* There is no MODULE_DEVICE_TABLE for usbserial.c. Instead
47 the MODULE_DEVICE_TABLE declarations in each serial driver
48 cause the "hotplug" program to pull in whatever module is necessary
49 via modprobe, and modprobe will load usbserial because the serial
50 drivers depend on it.
51*/
52
53static bool debug;
54/* initially all NULL */
55static struct usb_serial *serial_table[SERIAL_TTY_MINORS];
56static DEFINE_MUTEX(table_lock);
57static LIST_HEAD(usb_serial_driver_list);
58
59/*
60 * Look up the serial structure. If it is found and it hasn't been
61 * disconnected, return with its disc_mutex held and its refcount
62 * incremented. Otherwise return NULL.
63 */
64struct usb_serial *usb_serial_get_by_index(unsigned index)
65{
66 struct usb_serial *serial;
67
68 mutex_lock(&table_lock);
69 serial = serial_table[index];
70
71 if (serial) {
72 mutex_lock(&serial->disc_mutex);
73 if (serial->disconnected) {
74 mutex_unlock(&serial->disc_mutex);
75 serial = NULL;
76 } else {
77 kref_get(&serial->kref);
78 }
79 }
80 mutex_unlock(&table_lock);
81 return serial;
82}
83
84static struct usb_serial *get_free_serial(struct usb_serial *serial,
85 int num_ports, unsigned int *minor)
86{
87 unsigned int i, j;
88 int good_spot;
89
90 dbg("%s %d", __func__, num_ports);
91
92 *minor = 0;
93 mutex_lock(&table_lock);
94 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
95 if (serial_table[i])
96 continue;
97
98 good_spot = 1;
99 for (j = 1; j <= num_ports-1; ++j)
100 if ((i+j >= SERIAL_TTY_MINORS) || (serial_table[i+j])) {
101 good_spot = 0;
102 i += j;
103 break;
104 }
105 if (good_spot == 0)
106 continue;
107
108 *minor = i;
109 j = 0;
110 dbg("%s - minor base = %d", __func__, *minor);
111 for (i = *minor; (i < (*minor + num_ports)) && (i < SERIAL_TTY_MINORS); ++i) {
112 serial_table[i] = serial;
113 serial->port[j++]->number = i;
114 }
115 mutex_unlock(&table_lock);
116 return serial;
117 }
118 mutex_unlock(&table_lock);
119 return NULL;
120}
121
122static void return_serial(struct usb_serial *serial)
123{
124 int i;
125
126 dbg("%s", __func__);
127
128 mutex_lock(&table_lock);
129 for (i = 0; i < serial->num_ports; ++i)
130 serial_table[serial->minor + i] = NULL;
131 mutex_unlock(&table_lock);
132}
133
134static void destroy_serial(struct kref *kref)
135{
136 struct usb_serial *serial;
137 struct usb_serial_port *port;
138 int i;
139
140 serial = to_usb_serial(kref);
141
142 dbg("%s - %s", __func__, serial->type->description);
143
144 /* return the minor range that this device had */
145 if (serial->minor != SERIAL_TTY_NO_MINOR)
146 return_serial(serial);
147
148 if (serial->attached)
149 serial->type->release(serial);
150
151 /* Now that nothing is using the ports, they can be freed */
152 for (i = 0; i < serial->num_port_pointers; ++i) {
153 port = serial->port[i];
154 if (port) {
155 port->serial = NULL;
156 put_device(&port->dev);
157 }
158 }
159
160 usb_put_dev(serial->dev);
161 kfree(serial);
162}
163
164void usb_serial_put(struct usb_serial *serial)
165{
166 kref_put(&serial->kref, destroy_serial);
167}
168
169/*****************************************************************************
170 * Driver tty interface functions
171 *****************************************************************************/
172
173/**
174 * serial_install - install tty
175 * @driver: the driver (USB in our case)
176 * @tty: the tty being created
177 *
178 * Create the termios objects for this tty. We use the default
179 * USB serial settings but permit them to be overridden by
180 * serial->type->init_termios.
181 *
182 * This is the first place a new tty gets used. Hence this is where we
183 * acquire references to the usb_serial structure and the driver module,
184 * where we store a pointer to the port, and where we do an autoresume.
185 * All these actions are reversed in serial_cleanup().
186 */
187static int serial_install(struct tty_driver *driver, struct tty_struct *tty)
188{
189 int idx = tty->index;
190 struct usb_serial *serial;
191 struct usb_serial_port *port;
192 int retval = -ENODEV;
193
194 dbg("%s", __func__);
195
196 serial = usb_serial_get_by_index(idx);
197 if (!serial)
198 return retval;
199
200 port = serial->port[idx - serial->minor];
201 if (!port)
202 goto error_no_port;
203 if (!try_module_get(serial->type->driver.owner))
204 goto error_module_get;
205
206 retval = usb_autopm_get_interface(serial->interface);
207 if (retval)
208 goto error_get_interface;
209
210 retval = tty_standard_install(driver, tty);
211 if (retval)
212 goto error_init_termios;
213
214 mutex_unlock(&serial->disc_mutex);
215
216 /* allow the driver to update the settings */
217 if (serial->type->init_termios)
218 serial->type->init_termios(tty);
219
220 tty->driver_data = port;
221
222 return retval;
223
224 error_init_termios:
225 usb_autopm_put_interface(serial->interface);
226 error_get_interface:
227 module_put(serial->type->driver.owner);
228 error_module_get:
229 error_no_port:
230 usb_serial_put(serial);
231 mutex_unlock(&serial->disc_mutex);
232 return retval;
233}
234
235static int serial_activate(struct tty_port *tport, struct tty_struct *tty)
236{
237 struct usb_serial_port *port =
238 container_of(tport, struct usb_serial_port, port);
239 struct usb_serial *serial = port->serial;
240 int retval;
241
242 mutex_lock(&serial->disc_mutex);
243 if (serial->disconnected)
244 retval = -ENODEV;
245 else
246 retval = port->serial->type->open(tty, port);
247 mutex_unlock(&serial->disc_mutex);
248
249 if (retval < 0)
250 retval = usb_translate_errors(retval);
251
252 return retval;
253}
254
255static int serial_open(struct tty_struct *tty, struct file *filp)
256{
257 struct usb_serial_port *port = tty->driver_data;
258
259 dbg("%s - port %d", __func__, port->number);
260 return tty_port_open(&port->port, tty, filp);
261}
262
263/**
264 * serial_down - shut down hardware
265 * @tport: tty port to shut down
266 *
267 * Shut down a USB serial port unless it is the console. We never
268 * shut down the console hardware as it will always be in use. Serialized
269 * against activate by the tport mutex and kept to matching open/close pairs
270 * of calls by the ASYNCB_INITIALIZED flag.
271 */
272static void serial_down(struct tty_port *tport)
273{
274 struct usb_serial_port *port =
275 container_of(tport, struct usb_serial_port, port);
276 struct usb_serial_driver *drv = port->serial->type;
277 /*
278 * The console is magical. Do not hang up the console hardware
279 * or there will be tears.
280 */
281 if (port->port.console)
282 return;
283 if (drv->close)
284 drv->close(port);
285}
286
287static void serial_hangup(struct tty_struct *tty)
288{
289 struct usb_serial_port *port = tty->driver_data;
290 dbg("%s - port %d", __func__, port->number);
291 tty_port_hangup(&port->port);
292}
293
294static void serial_close(struct tty_struct *tty, struct file *filp)
295{
296 struct usb_serial_port *port = tty->driver_data;
297 dbg("%s - port %d", __func__, port->number);
298 tty_port_close(&port->port, tty, filp);
299}
300
301/**
302 * serial_cleanup - free resources post close/hangup
303 * @port: port to free up
304 *
305 * Do the resource freeing and refcount dropping for the port.
306 * Avoid freeing the console.
307 *
308 * Called asynchronously after the last tty kref is dropped,
309 * and the tty layer has already done the tty_shutdown(tty);
310 */
311static void serial_cleanup(struct tty_struct *tty)
312{
313 struct usb_serial_port *port = tty->driver_data;
314 struct usb_serial *serial;
315 struct module *owner;
316
317 /* The console is magical. Do not hang up the console hardware
318 * or there will be tears.
319 */
320 if (port->port.console)
321 return;
322
323 dbg("%s - port %d", __func__, port->number);
324
325 tty->driver_data = NULL;
326
327 serial = port->serial;
328 owner = serial->type->driver.owner;
329
330 mutex_lock(&serial->disc_mutex);
331 if (!serial->disconnected)
332 usb_autopm_put_interface(serial->interface);
333 mutex_unlock(&serial->disc_mutex);
334
335 usb_serial_put(serial);
336 module_put(owner);
337}
338
339static int serial_write(struct tty_struct *tty, const unsigned char *buf,
340 int count)
341{
342 struct usb_serial_port *port = tty->driver_data;
343 int retval = -ENODEV;
344
345 if (port->serial->dev->state == USB_STATE_NOTATTACHED)
346 goto exit;
347
348 dbg("%s - port %d, %d byte(s)", __func__, port->number, count);
349
350 /* pass on to the driver specific version of this function */
351 retval = port->serial->type->write(tty, port, buf, count);
352 if (retval < 0)
353 retval = usb_translate_errors(retval);
354exit:
355 return retval;
356}
357
358static int serial_write_room(struct tty_struct *tty)
359{
360 struct usb_serial_port *port = tty->driver_data;
361 dbg("%s - port %d", __func__, port->number);
362 /* pass on to the driver specific version of this function */
363 return port->serial->type->write_room(tty);
364}
365
366static int serial_chars_in_buffer(struct tty_struct *tty)
367{
368 struct usb_serial_port *port = tty->driver_data;
369 dbg("%s - port %d", __func__, port->number);
370
371 /* if the device was unplugged then any remaining characters
372 fell out of the connector ;) */
373 if (port->serial->disconnected)
374 return 0;
375 /* pass on to the driver specific version of this function */
376 return port->serial->type->chars_in_buffer(tty);
377}
378
379static void serial_throttle(struct tty_struct *tty)
380{
381 struct usb_serial_port *port = tty->driver_data;
382 dbg("%s - port %d", __func__, port->number);
383
384 /* pass on to the driver specific version of this function */
385 if (port->serial->type->throttle)
386 port->serial->type->throttle(tty);
387}
388
389static void serial_unthrottle(struct tty_struct *tty)
390{
391 struct usb_serial_port *port = tty->driver_data;
392 dbg("%s - port %d", __func__, port->number);
393
394 /* pass on to the driver specific version of this function */
395 if (port->serial->type->unthrottle)
396 port->serial->type->unthrottle(tty);
397}
398
399static int serial_ioctl(struct tty_struct *tty,
400 unsigned int cmd, unsigned long arg)
401{
402 struct usb_serial_port *port = tty->driver_data;
403 int retval = -ENODEV;
404
405 dbg("%s - port %d, cmd 0x%.4x", __func__, port->number, cmd);
406
407 /* pass on to the driver specific version of this function
408 if it is available */
409 if (port->serial->type->ioctl) {
410 retval = port->serial->type->ioctl(tty, cmd, arg);
411 } else
412 retval = -ENOIOCTLCMD;
413 return retval;
414}
415
416static void serial_set_termios(struct tty_struct *tty, struct ktermios *old)
417{
418 struct usb_serial_port *port = tty->driver_data;
419 dbg("%s - port %d", __func__, port->number);
420
421 /* pass on to the driver specific version of this function
422 if it is available */
423 if (port->serial->type->set_termios)
424 port->serial->type->set_termios(tty, port, old);
425 else
426 tty_termios_copy_hw(tty->termios, old);
427}
428
429static int serial_break(struct tty_struct *tty, int break_state)
430{
431 struct usb_serial_port *port = tty->driver_data;
432
433 dbg("%s - port %d", __func__, port->number);
434
435 /* pass on to the driver specific version of this function
436 if it is available */
437 if (port->serial->type->break_ctl)
438 port->serial->type->break_ctl(tty, break_state);
439 return 0;
440}
441
442static int serial_proc_show(struct seq_file *m, void *v)
443{
444 struct usb_serial *serial;
445 int i;
446 char tmp[40];
447
448 dbg("%s", __func__);
449 seq_puts(m, "usbserinfo:1.0 driver:2.0\n");
450 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
451 serial = usb_serial_get_by_index(i);
452 if (serial == NULL)
453 continue;
454
455 seq_printf(m, "%d:", i);
456 if (serial->type->driver.owner)
457 seq_printf(m, " module:%s",
458 module_name(serial->type->driver.owner));
459 seq_printf(m, " name:\"%s\"",
460 serial->type->description);
461 seq_printf(m, " vendor:%04x product:%04x",
462 le16_to_cpu(serial->dev->descriptor.idVendor),
463 le16_to_cpu(serial->dev->descriptor.idProduct));
464 seq_printf(m, " num_ports:%d", serial->num_ports);
465 seq_printf(m, " port:%d", i - serial->minor + 1);
466 usb_make_path(serial->dev, tmp, sizeof(tmp));
467 seq_printf(m, " path:%s", tmp);
468
469 seq_putc(m, '\n');
470 usb_serial_put(serial);
471 mutex_unlock(&serial->disc_mutex);
472 }
473 return 0;
474}
475
476static int serial_proc_open(struct inode *inode, struct file *file)
477{
478 return single_open(file, serial_proc_show, NULL);
479}
480
481static const struct file_operations serial_proc_fops = {
482 .owner = THIS_MODULE,
483 .open = serial_proc_open,
484 .read = seq_read,
485 .llseek = seq_lseek,
486 .release = single_release,
487};
488
489static int serial_tiocmget(struct tty_struct *tty)
490{
491 struct usb_serial_port *port = tty->driver_data;
492
493 dbg("%s - port %d", __func__, port->number);
494
495 if (port->serial->type->tiocmget)
496 return port->serial->type->tiocmget(tty);
497 return -EINVAL;
498}
499
500static int serial_tiocmset(struct tty_struct *tty,
501 unsigned int set, unsigned int clear)
502{
503 struct usb_serial_port *port = tty->driver_data;
504
505 dbg("%s - port %d", __func__, port->number);
506
507 if (port->serial->type->tiocmset)
508 return port->serial->type->tiocmset(tty, set, clear);
509 return -EINVAL;
510}
511
512static int serial_get_icount(struct tty_struct *tty,
513 struct serial_icounter_struct *icount)
514{
515 struct usb_serial_port *port = tty->driver_data;
516
517 dbg("%s - port %d", __func__, port->number);
518
519 if (port->serial->type->get_icount)
520 return port->serial->type->get_icount(tty, icount);
521 return -EINVAL;
522}
523
524/*
525 * We would be calling tty_wakeup here, but unfortunately some line
526 * disciplines have an annoying habit of calling tty->write from
527 * the write wakeup callback (e.g. n_hdlc.c).
528 */
529void usb_serial_port_softint(struct usb_serial_port *port)
530{
531 schedule_work(&port->work);
532}
533EXPORT_SYMBOL_GPL(usb_serial_port_softint);
534
535static void usb_serial_port_work(struct work_struct *work)
536{
537 struct usb_serial_port *port =
538 container_of(work, struct usb_serial_port, work);
539 struct tty_struct *tty;
540
541 dbg("%s - port %d", __func__, port->number);
542
543 tty = tty_port_tty_get(&port->port);
544 if (!tty)
545 return;
546
547 tty_wakeup(tty);
548 tty_kref_put(tty);
549}
550
551static void kill_traffic(struct usb_serial_port *port)
552{
553 int i;
554
555 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i)
556 usb_kill_urb(port->read_urbs[i]);
557 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
558 usb_kill_urb(port->write_urbs[i]);
559 /*
560 * This is tricky.
561 * Some drivers submit the read_urb in the
562 * handler for the write_urb or vice versa
563 * this order determines the order in which
564 * usb_kill_urb() must be used to reliably
565 * kill the URBs. As it is unknown here,
566 * both orders must be used in turn.
567 * The call below is not redundant.
568 */
569 usb_kill_urb(port->read_urb);
570 usb_kill_urb(port->interrupt_in_urb);
571 usb_kill_urb(port->interrupt_out_urb);
572}
573
574static void port_release(struct device *dev)
575{
576 struct usb_serial_port *port = to_usb_serial_port(dev);
577 int i;
578
579 dbg ("%s - %s", __func__, dev_name(dev));
580
581 /*
582 * Stop all the traffic before cancelling the work, so that
583 * nobody will restart it by calling usb_serial_port_softint.
584 */
585 kill_traffic(port);
586 cancel_work_sync(&port->work);
587
588 usb_free_urb(port->interrupt_in_urb);
589 usb_free_urb(port->interrupt_out_urb);
590 for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i) {
591 usb_free_urb(port->read_urbs[i]);
592 kfree(port->bulk_in_buffers[i]);
593 }
594 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i) {
595 usb_free_urb(port->write_urbs[i]);
596 kfree(port->bulk_out_buffers[i]);
597 }
598 kfifo_free(&port->write_fifo);
599 kfree(port->interrupt_in_buffer);
600 kfree(port->interrupt_out_buffer);
601 kfree(port);
602}
603
604static struct usb_serial *create_serial(struct usb_device *dev,
605 struct usb_interface *interface,
606 struct usb_serial_driver *driver)
607{
608 struct usb_serial *serial;
609
610 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
611 if (!serial) {
612 dev_err(&dev->dev, "%s - out of memory\n", __func__);
613 return NULL;
614 }
615 serial->dev = usb_get_dev(dev);
616 serial->type = driver;
617 serial->interface = interface;
618 kref_init(&serial->kref);
619 mutex_init(&serial->disc_mutex);
620 serial->minor = SERIAL_TTY_NO_MINOR;
621
622 return serial;
623}
624
625static const struct usb_device_id *match_dynamic_id(struct usb_interface *intf,
626 struct usb_serial_driver *drv)
627{
628 struct usb_dynid *dynid;
629
630 spin_lock(&drv->dynids.lock);
631 list_for_each_entry(dynid, &drv->dynids.list, node) {
632 if (usb_match_one_id(intf, &dynid->id)) {
633 spin_unlock(&drv->dynids.lock);
634 return &dynid->id;
635 }
636 }
637 spin_unlock(&drv->dynids.lock);
638 return NULL;
639}
640
641static const struct usb_device_id *get_iface_id(struct usb_serial_driver *drv,
642 struct usb_interface *intf)
643{
644 const struct usb_device_id *id;
645
646 id = usb_match_id(intf, drv->id_table);
647 if (id) {
648 dbg("static descriptor matches");
649 goto exit;
650 }
651 id = match_dynamic_id(intf, drv);
652 if (id)
653 dbg("dynamic descriptor matches");
654exit:
655 return id;
656}
657
658/* Caller must hold table_lock */
659static struct usb_serial_driver *search_serial_device(
660 struct usb_interface *iface)
661{
662 const struct usb_device_id *id = NULL;
663 struct usb_serial_driver *drv;
664 struct usb_driver *driver = to_usb_driver(iface->dev.driver);
665
666 /* Check if the usb id matches a known device */
667 list_for_each_entry(drv, &usb_serial_driver_list, driver_list) {
668 if (drv->usb_driver == driver)
669 id = get_iface_id(drv, iface);
670 if (id)
671 return drv;
672 }
673
674 return NULL;
675}
676
677static int serial_carrier_raised(struct tty_port *port)
678{
679 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
680 struct usb_serial_driver *drv = p->serial->type;
681
682 if (drv->carrier_raised)
683 return drv->carrier_raised(p);
684 /* No carrier control - don't block */
685 return 1;
686}
687
688static void serial_dtr_rts(struct tty_port *port, int on)
689{
690 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
691 struct usb_serial_driver *drv = p->serial->type;
692
693 if (drv->dtr_rts)
694 drv->dtr_rts(p, on);
695}
696
697static const struct tty_port_operations serial_port_ops = {
698 .carrier_raised = serial_carrier_raised,
699 .dtr_rts = serial_dtr_rts,
700 .activate = serial_activate,
701 .shutdown = serial_down,
702};
703
704static int usb_serial_probe(struct usb_interface *interface,
705 const struct usb_device_id *id)
706{
707 struct usb_device *dev = interface_to_usbdev(interface);
708 struct usb_serial *serial = NULL;
709 struct usb_serial_port *port;
710 struct usb_host_interface *iface_desc;
711 struct usb_endpoint_descriptor *endpoint;
712 struct usb_endpoint_descriptor *interrupt_in_endpoint[MAX_NUM_PORTS];
713 struct usb_endpoint_descriptor *interrupt_out_endpoint[MAX_NUM_PORTS];
714 struct usb_endpoint_descriptor *bulk_in_endpoint[MAX_NUM_PORTS];
715 struct usb_endpoint_descriptor *bulk_out_endpoint[MAX_NUM_PORTS];
716 struct usb_serial_driver *type = NULL;
717 int retval;
718 unsigned int minor;
719 int buffer_size;
720 int i;
721 int j;
722 int num_interrupt_in = 0;
723 int num_interrupt_out = 0;
724 int num_bulk_in = 0;
725 int num_bulk_out = 0;
726 int num_ports = 0;
727 int max_endpoints;
728
729 mutex_lock(&table_lock);
730 type = search_serial_device(interface);
731 if (!type) {
732 mutex_unlock(&table_lock);
733 dbg("none matched");
734 return -ENODEV;
735 }
736
737 if (!try_module_get(type->driver.owner)) {
738 mutex_unlock(&table_lock);
739 dev_err(&interface->dev, "module get failed, exiting\n");
740 return -EIO;
741 }
742 mutex_unlock(&table_lock);
743
744 serial = create_serial(dev, interface, type);
745 if (!serial) {
746 module_put(type->driver.owner);
747 dev_err(&interface->dev, "%s - out of memory\n", __func__);
748 return -ENOMEM;
749 }
750
751 /* if this device type has a probe function, call it */
752 if (type->probe) {
753 const struct usb_device_id *id;
754
755 id = get_iface_id(type, interface);
756 retval = type->probe(serial, id);
757
758 if (retval) {
759 dbg("sub driver rejected device");
760 usb_serial_put(serial);
761 module_put(type->driver.owner);
762 return retval;
763 }
764 }
765
766 /* descriptor matches, let's find the endpoints needed */
767 /* check out the endpoints */
768 iface_desc = interface->cur_altsetting;
769 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
770 endpoint = &iface_desc->endpoint[i].desc;
771
772 if (usb_endpoint_is_bulk_in(endpoint)) {
773 /* we found a bulk in endpoint */
774 dbg("found bulk in on endpoint %d", i);
775 bulk_in_endpoint[num_bulk_in] = endpoint;
776 ++num_bulk_in;
777 }
778
779 if (usb_endpoint_is_bulk_out(endpoint)) {
780 /* we found a bulk out endpoint */
781 dbg("found bulk out on endpoint %d", i);
782 bulk_out_endpoint[num_bulk_out] = endpoint;
783 ++num_bulk_out;
784 }
785
786 if (usb_endpoint_is_int_in(endpoint)) {
787 /* we found a interrupt in endpoint */
788 dbg("found interrupt in on endpoint %d", i);
789 interrupt_in_endpoint[num_interrupt_in] = endpoint;
790 ++num_interrupt_in;
791 }
792
793 if (usb_endpoint_is_int_out(endpoint)) {
794 /* we found an interrupt out endpoint */
795 dbg("found interrupt out on endpoint %d", i);
796 interrupt_out_endpoint[num_interrupt_out] = endpoint;
797 ++num_interrupt_out;
798 }
799 }
800
801#if defined(CONFIG_USB_SERIAL_PL2303) || defined(CONFIG_USB_SERIAL_PL2303_MODULE)
802 /* BEGIN HORRIBLE HACK FOR PL2303 */
803 /* this is needed due to the looney way its endpoints are set up */
804 if (((le16_to_cpu(dev->descriptor.idVendor) == PL2303_VENDOR_ID) &&
805 (le16_to_cpu(dev->descriptor.idProduct) == PL2303_PRODUCT_ID)) ||
806 ((le16_to_cpu(dev->descriptor.idVendor) == ATEN_VENDOR_ID) &&
807 (le16_to_cpu(dev->descriptor.idProduct) == ATEN_PRODUCT_ID)) ||
808 ((le16_to_cpu(dev->descriptor.idVendor) == ALCOR_VENDOR_ID) &&
809 (le16_to_cpu(dev->descriptor.idProduct) == ALCOR_PRODUCT_ID)) ||
810 ((le16_to_cpu(dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
811 (le16_to_cpu(dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_EF81))) {
812 if (interface != dev->actconfig->interface[0]) {
813 /* check out the endpoints of the other interface*/
814 iface_desc = dev->actconfig->interface[0]->cur_altsetting;
815 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
816 endpoint = &iface_desc->endpoint[i].desc;
817 if (usb_endpoint_is_int_in(endpoint)) {
818 /* we found a interrupt in endpoint */
819 dbg("found interrupt in for Prolific device on separate interface");
820 interrupt_in_endpoint[num_interrupt_in] = endpoint;
821 ++num_interrupt_in;
822 }
823 }
824 }
825
826 /* Now make sure the PL-2303 is configured correctly.
827 * If not, give up now and hope this hack will work
828 * properly during a later invocation of usb_serial_probe
829 */
830 if (num_bulk_in == 0 || num_bulk_out == 0) {
831 dev_info(&interface->dev, "PL-2303 hack: descriptors matched but endpoints did not\n");
832 usb_serial_put(serial);
833 module_put(type->driver.owner);
834 return -ENODEV;
835 }
836 }
837 /* END HORRIBLE HACK FOR PL2303 */
838#endif
839
840#ifdef CONFIG_USB_SERIAL_GENERIC
841 if (type == &usb_serial_generic_device) {
842 num_ports = num_bulk_out;
843 if (num_ports == 0) {
844 dev_err(&interface->dev,
845 "Generic device with no bulk out, not allowed.\n");
846 usb_serial_put(serial);
847 module_put(type->driver.owner);
848 return -EIO;
849 }
850 dev_info(&interface->dev, "The \"generic\" usb-serial driver is only for testing and one-off prototypes.\n");
851 dev_info(&interface->dev, "Tell linux-usb@vger.kernel.org to add your device to a proper driver.\n");
852 }
853#endif
854 if (!num_ports) {
855 /* if this device type has a calc_num_ports function, call it */
856 if (type->calc_num_ports)
857 num_ports = type->calc_num_ports(serial);
858 if (!num_ports)
859 num_ports = type->num_ports;
860 }
861
862 serial->num_ports = num_ports;
863 serial->num_bulk_in = num_bulk_in;
864 serial->num_bulk_out = num_bulk_out;
865 serial->num_interrupt_in = num_interrupt_in;
866 serial->num_interrupt_out = num_interrupt_out;
867
868 /* found all that we need */
869 dev_info(&interface->dev, "%s converter detected\n",
870 type->description);
871
872 /* create our ports, we need as many as the max endpoints */
873 /* we don't use num_ports here because some devices have more
874 endpoint pairs than ports */
875 max_endpoints = max(num_bulk_in, num_bulk_out);
876 max_endpoints = max(max_endpoints, num_interrupt_in);
877 max_endpoints = max(max_endpoints, num_interrupt_out);
878 max_endpoints = max(max_endpoints, (int)serial->num_ports);
879 serial->num_port_pointers = max_endpoints;
880
881 dbg("%s - setting up %d port structures for this device",
882 __func__, max_endpoints);
883 for (i = 0; i < max_endpoints; ++i) {
884 port = kzalloc(sizeof(struct usb_serial_port), GFP_KERNEL);
885 if (!port)
886 goto probe_error;
887 tty_port_init(&port->port);
888 port->port.ops = &serial_port_ops;
889 port->serial = serial;
890 spin_lock_init(&port->lock);
891 /* Keep this for private driver use for the moment but
892 should probably go away */
893 INIT_WORK(&port->work, usb_serial_port_work);
894 serial->port[i] = port;
895 port->dev.parent = &interface->dev;
896 port->dev.driver = NULL;
897 port->dev.bus = &usb_serial_bus_type;
898 port->dev.release = &port_release;
899 device_initialize(&port->dev);
900 }
901
902 /* set up the endpoint information */
903 for (i = 0; i < num_bulk_in; ++i) {
904 endpoint = bulk_in_endpoint[i];
905 port = serial->port[i];
906 buffer_size = max_t(int, serial->type->bulk_in_size,
907 usb_endpoint_maxp(endpoint));
908 port->bulk_in_size = buffer_size;
909 port->bulk_in_endpointAddress = endpoint->bEndpointAddress;
910
911 for (j = 0; j < ARRAY_SIZE(port->read_urbs); ++j) {
912 set_bit(j, &port->read_urbs_free);
913 port->read_urbs[j] = usb_alloc_urb(0, GFP_KERNEL);
914 if (!port->read_urbs[j]) {
915 dev_err(&interface->dev,
916 "No free urbs available\n");
917 goto probe_error;
918 }
919 port->bulk_in_buffers[j] = kmalloc(buffer_size,
920 GFP_KERNEL);
921 if (!port->bulk_in_buffers[j]) {
922 dev_err(&interface->dev,
923 "Couldn't allocate bulk_in_buffer\n");
924 goto probe_error;
925 }
926 usb_fill_bulk_urb(port->read_urbs[j], dev,
927 usb_rcvbulkpipe(dev,
928 endpoint->bEndpointAddress),
929 port->bulk_in_buffers[j], buffer_size,
930 serial->type->read_bulk_callback,
931 port);
932 }
933
934 port->read_urb = port->read_urbs[0];
935 port->bulk_in_buffer = port->bulk_in_buffers[0];
936 }
937
938 for (i = 0; i < num_bulk_out; ++i) {
939 endpoint = bulk_out_endpoint[i];
940 port = serial->port[i];
941 if (kfifo_alloc(&port->write_fifo, PAGE_SIZE, GFP_KERNEL))
942 goto probe_error;
943 buffer_size = serial->type->bulk_out_size;
944 if (!buffer_size)
945 buffer_size = usb_endpoint_maxp(endpoint);
946 port->bulk_out_size = buffer_size;
947 port->bulk_out_endpointAddress = endpoint->bEndpointAddress;
948
949 for (j = 0; j < ARRAY_SIZE(port->write_urbs); ++j) {
950 set_bit(j, &port->write_urbs_free);
951 port->write_urbs[j] = usb_alloc_urb(0, GFP_KERNEL);
952 if (!port->write_urbs[j]) {
953 dev_err(&interface->dev,
954 "No free urbs available\n");
955 goto probe_error;
956 }
957 port->bulk_out_buffers[j] = kmalloc(buffer_size,
958 GFP_KERNEL);
959 if (!port->bulk_out_buffers[j]) {
960 dev_err(&interface->dev,
961 "Couldn't allocate bulk_out_buffer\n");
962 goto probe_error;
963 }
964 usb_fill_bulk_urb(port->write_urbs[j], dev,
965 usb_sndbulkpipe(dev,
966 endpoint->bEndpointAddress),
967 port->bulk_out_buffers[j], buffer_size,
968 serial->type->write_bulk_callback,
969 port);
970 }
971
972 port->write_urb = port->write_urbs[0];
973 port->bulk_out_buffer = port->bulk_out_buffers[0];
974 }
975
976 if (serial->type->read_int_callback) {
977 for (i = 0; i < num_interrupt_in; ++i) {
978 endpoint = interrupt_in_endpoint[i];
979 port = serial->port[i];
980 port->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
981 if (!port->interrupt_in_urb) {
982 dev_err(&interface->dev,
983 "No free urbs available\n");
984 goto probe_error;
985 }
986 buffer_size = usb_endpoint_maxp(endpoint);
987 port->interrupt_in_endpointAddress =
988 endpoint->bEndpointAddress;
989 port->interrupt_in_buffer = kmalloc(buffer_size,
990 GFP_KERNEL);
991 if (!port->interrupt_in_buffer) {
992 dev_err(&interface->dev,
993 "Couldn't allocate interrupt_in_buffer\n");
994 goto probe_error;
995 }
996 usb_fill_int_urb(port->interrupt_in_urb, dev,
997 usb_rcvintpipe(dev,
998 endpoint->bEndpointAddress),
999 port->interrupt_in_buffer, buffer_size,
1000 serial->type->read_int_callback, port,
1001 endpoint->bInterval);
1002 }
1003 } else if (num_interrupt_in) {
1004 dbg("the device claims to support interrupt in transfers, but read_int_callback is not defined");
1005 }
1006
1007 if (serial->type->write_int_callback) {
1008 for (i = 0; i < num_interrupt_out; ++i) {
1009 endpoint = interrupt_out_endpoint[i];
1010 port = serial->port[i];
1011 port->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
1012 if (!port->interrupt_out_urb) {
1013 dev_err(&interface->dev,
1014 "No free urbs available\n");
1015 goto probe_error;
1016 }
1017 buffer_size = usb_endpoint_maxp(endpoint);
1018 port->interrupt_out_size = buffer_size;
1019 port->interrupt_out_endpointAddress =
1020 endpoint->bEndpointAddress;
1021 port->interrupt_out_buffer = kmalloc(buffer_size,
1022 GFP_KERNEL);
1023 if (!port->interrupt_out_buffer) {
1024 dev_err(&interface->dev,
1025 "Couldn't allocate interrupt_out_buffer\n");
1026 goto probe_error;
1027 }
1028 usb_fill_int_urb(port->interrupt_out_urb, dev,
1029 usb_sndintpipe(dev,
1030 endpoint->bEndpointAddress),
1031 port->interrupt_out_buffer, buffer_size,
1032 serial->type->write_int_callback, port,
1033 endpoint->bInterval);
1034 }
1035 } else if (num_interrupt_out) {
1036 dbg("the device claims to support interrupt out transfers, but write_int_callback is not defined");
1037 }
1038
1039 usb_set_intfdata(interface, serial);
1040
1041 /* if this device type has an attach function, call it */
1042 if (type->attach) {
1043 retval = type->attach(serial);
1044 if (retval < 0)
1045 goto probe_error;
1046 serial->attached = 1;
1047 if (retval > 0) {
1048 /* quietly accept this device, but don't bind to a
1049 serial port as it's about to disappear */
1050 serial->num_ports = 0;
1051 goto exit;
1052 }
1053 } else {
1054 serial->attached = 1;
1055 }
1056
1057 /* Avoid race with tty_open and serial_install by setting the
1058 * disconnected flag and not clearing it until all ports have been
1059 * registered.
1060 */
1061 serial->disconnected = 1;
1062
1063 if (get_free_serial(serial, num_ports, &minor) == NULL) {
1064 dev_err(&interface->dev, "No more free serial devices\n");
1065 goto probe_error;
1066 }
1067 serial->minor = minor;
1068
1069 /* register all of the individual ports with the driver core */
1070 for (i = 0; i < num_ports; ++i) {
1071 port = serial->port[i];
1072 dev_set_name(&port->dev, "ttyUSB%d", port->number);
1073 dbg ("%s - registering %s", __func__, dev_name(&port->dev));
1074 device_enable_async_suspend(&port->dev);
1075
1076 retval = device_add(&port->dev);
1077 if (retval)
1078 dev_err(&port->dev, "Error registering port device, "
1079 "continuing\n");
1080 }
1081
1082 serial->disconnected = 0;
1083
1084 usb_serial_console_init(debug, minor);
1085exit:
1086 module_put(type->driver.owner);
1087 return 0;
1088
1089probe_error:
1090 usb_serial_put(serial);
1091 module_put(type->driver.owner);
1092 return -EIO;
1093}
1094
1095static void usb_serial_disconnect(struct usb_interface *interface)
1096{
1097 int i;
1098 struct usb_serial *serial = usb_get_intfdata(interface);
1099 struct device *dev = &interface->dev;
1100 struct usb_serial_port *port;
1101
1102 usb_serial_console_disconnect(serial);
1103 dbg("%s", __func__);
1104
1105 mutex_lock(&serial->disc_mutex);
1106 /* must set a flag, to signal subdrivers */
1107 serial->disconnected = 1;
1108 mutex_unlock(&serial->disc_mutex);
1109
1110 for (i = 0; i < serial->num_ports; ++i) {
1111 port = serial->port[i];
1112 if (port) {
1113 struct tty_struct *tty = tty_port_tty_get(&port->port);
1114 if (tty) {
1115 tty_vhangup(tty);
1116 tty_kref_put(tty);
1117 }
1118 kill_traffic(port);
1119 cancel_work_sync(&port->work);
1120 if (device_is_registered(&port->dev))
1121 device_del(&port->dev);
1122 }
1123 }
1124 serial->type->disconnect(serial);
1125
1126 /* let the last holder of this object cause it to be cleaned up */
1127 usb_serial_put(serial);
1128 dev_info(dev, "device disconnected\n");
1129}
1130
1131int usb_serial_suspend(struct usb_interface *intf, pm_message_t message)
1132{
1133 struct usb_serial *serial = usb_get_intfdata(intf);
1134 struct usb_serial_port *port;
1135 int i, r = 0;
1136
1137 serial->suspending = 1;
1138
1139 if (serial->type->suspend) {
1140 r = serial->type->suspend(serial, message);
1141 if (r < 0) {
1142 serial->suspending = 0;
1143 goto err_out;
1144 }
1145 }
1146
1147 for (i = 0; i < serial->num_ports; ++i) {
1148 port = serial->port[i];
1149 if (port)
1150 kill_traffic(port);
1151 }
1152
1153err_out:
1154 return r;
1155}
1156EXPORT_SYMBOL(usb_serial_suspend);
1157
1158int usb_serial_resume(struct usb_interface *intf)
1159{
1160 struct usb_serial *serial = usb_get_intfdata(intf);
1161 int rv;
1162
1163 serial->suspending = 0;
1164 if (serial->type->resume)
1165 rv = serial->type->resume(serial);
1166 else
1167 rv = usb_serial_generic_resume(serial);
1168
1169 return rv;
1170}
1171EXPORT_SYMBOL(usb_serial_resume);
1172
1173static int usb_serial_reset_resume(struct usb_interface *intf)
1174{
1175 struct usb_serial *serial = usb_get_intfdata(intf);
1176 int rv;
1177
1178 serial->suspending = 0;
1179 if (serial->type->reset_resume)
1180 rv = serial->type->reset_resume(serial);
1181 else {
1182 rv = -EOPNOTSUPP;
1183 intf->needs_binding = 1;
1184 }
1185
1186 return rv;
1187}
1188
1189static const struct tty_operations serial_ops = {
1190 .open = serial_open,
1191 .close = serial_close,
1192 .write = serial_write,
1193 .hangup = serial_hangup,
1194 .write_room = serial_write_room,
1195 .ioctl = serial_ioctl,
1196 .set_termios = serial_set_termios,
1197 .throttle = serial_throttle,
1198 .unthrottle = serial_unthrottle,
1199 .break_ctl = serial_break,
1200 .chars_in_buffer = serial_chars_in_buffer,
1201 .tiocmget = serial_tiocmget,
1202 .tiocmset = serial_tiocmset,
1203 .get_icount = serial_get_icount,
1204 .cleanup = serial_cleanup,
1205 .install = serial_install,
1206 .proc_fops = &serial_proc_fops,
1207};
1208
1209
1210struct tty_driver *usb_serial_tty_driver;
1211
1212/* Driver structure we register with the USB core */
1213static struct usb_driver usb_serial_driver = {
1214 .name = "usbserial",
1215 .probe = usb_serial_probe,
1216 .disconnect = usb_serial_disconnect,
1217 .suspend = usb_serial_suspend,
1218 .resume = usb_serial_resume,
1219 .no_dynamic_id = 1,
1220 .supports_autosuspend = 1,
1221};
1222
1223static int __init usb_serial_init(void)
1224{
1225 int i;
1226 int result;
1227
1228 usb_serial_tty_driver = alloc_tty_driver(SERIAL_TTY_MINORS);
1229 if (!usb_serial_tty_driver)
1230 return -ENOMEM;
1231
1232 /* Initialize our global data */
1233 for (i = 0; i < SERIAL_TTY_MINORS; ++i)
1234 serial_table[i] = NULL;
1235
1236 result = bus_register(&usb_serial_bus_type);
1237 if (result) {
1238 printk(KERN_ERR "usb-serial: %s - registering bus driver "
1239 "failed\n", __func__);
1240 goto exit_bus;
1241 }
1242
1243 usb_serial_tty_driver->driver_name = "usbserial";
1244 usb_serial_tty_driver->name = "ttyUSB";
1245 usb_serial_tty_driver->major = SERIAL_TTY_MAJOR;
1246 usb_serial_tty_driver->minor_start = 0;
1247 usb_serial_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1248 usb_serial_tty_driver->subtype = SERIAL_TYPE_NORMAL;
1249 usb_serial_tty_driver->flags = TTY_DRIVER_REAL_RAW |
1250 TTY_DRIVER_DYNAMIC_DEV;
1251 usb_serial_tty_driver->init_termios = tty_std_termios;
1252 usb_serial_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD
1253 | HUPCL | CLOCAL;
1254 usb_serial_tty_driver->init_termios.c_ispeed = 9600;
1255 usb_serial_tty_driver->init_termios.c_ospeed = 9600;
1256 tty_set_operations(usb_serial_tty_driver, &serial_ops);
1257 result = tty_register_driver(usb_serial_tty_driver);
1258 if (result) {
1259 printk(KERN_ERR "usb-serial: %s - tty_register_driver failed\n",
1260 __func__);
1261 goto exit_reg_driver;
1262 }
1263
1264 /* register the USB driver */
1265 result = usb_register(&usb_serial_driver);
1266 if (result < 0) {
1267 printk(KERN_ERR "usb-serial: %s - usb_register failed\n",
1268 __func__);
1269 goto exit_tty;
1270 }
1271
1272 /* register the generic driver, if we should */
1273 result = usb_serial_generic_register(debug);
1274 if (result < 0) {
1275 printk(KERN_ERR "usb-serial: %s - registering generic "
1276 "driver failed\n", __func__);
1277 goto exit_generic;
1278 }
1279
1280 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1281
1282 return result;
1283
1284exit_generic:
1285 usb_deregister(&usb_serial_driver);
1286
1287exit_tty:
1288 tty_unregister_driver(usb_serial_tty_driver);
1289
1290exit_reg_driver:
1291 bus_unregister(&usb_serial_bus_type);
1292
1293exit_bus:
1294 printk(KERN_ERR "usb-serial: %s - returning with error %d\n",
1295 __func__, result);
1296 put_tty_driver(usb_serial_tty_driver);
1297 return result;
1298}
1299
1300
1301static void __exit usb_serial_exit(void)
1302{
1303 usb_serial_console_exit();
1304
1305 usb_serial_generic_deregister();
1306
1307 usb_deregister(&usb_serial_driver);
1308 tty_unregister_driver(usb_serial_tty_driver);
1309 put_tty_driver(usb_serial_tty_driver);
1310 bus_unregister(&usb_serial_bus_type);
1311}
1312
1313
1314module_init(usb_serial_init);
1315module_exit(usb_serial_exit);
1316
1317#define set_to_generic_if_null(type, function) \
1318 do { \
1319 if (!type->function) { \
1320 type->function = usb_serial_generic_##function; \
1321 dbg("Had to override the " #function \
1322 " usb serial operation with the generic one.");\
1323 } \
1324 } while (0)
1325
1326static void fixup_generic(struct usb_serial_driver *device)
1327{
1328 set_to_generic_if_null(device, open);
1329 set_to_generic_if_null(device, write);
1330 set_to_generic_if_null(device, close);
1331 set_to_generic_if_null(device, write_room);
1332 set_to_generic_if_null(device, chars_in_buffer);
1333 set_to_generic_if_null(device, read_bulk_callback);
1334 set_to_generic_if_null(device, write_bulk_callback);
1335 set_to_generic_if_null(device, disconnect);
1336 set_to_generic_if_null(device, release);
1337 set_to_generic_if_null(device, process_read_urb);
1338 set_to_generic_if_null(device, prepare_write_buffer);
1339}
1340
1341static int usb_serial_register(struct usb_serial_driver *driver)
1342{
1343 int retval;
1344
1345 if (usb_disabled())
1346 return -ENODEV;
1347
1348 fixup_generic(driver);
1349
1350 if (!driver->description)
1351 driver->description = driver->driver.name;
1352 if (!driver->usb_driver) {
1353 WARN(1, "Serial driver %s has no usb_driver\n",
1354 driver->description);
1355 return -EINVAL;
1356 }
1357
1358 /* Add this device to our list of devices */
1359 mutex_lock(&table_lock);
1360 list_add(&driver->driver_list, &usb_serial_driver_list);
1361
1362 retval = usb_serial_bus_register(driver);
1363 if (retval) {
1364 printk(KERN_ERR "usb-serial: problem %d when registering "
1365 "driver %s\n", retval, driver->description);
1366 list_del(&driver->driver_list);
1367 } else
1368 printk(KERN_INFO "USB Serial support registered for %s\n",
1369 driver->description);
1370
1371 mutex_unlock(&table_lock);
1372 return retval;
1373}
1374
1375static void usb_serial_deregister(struct usb_serial_driver *device)
1376{
1377 printk(KERN_INFO "USB Serial deregistering driver %s\n",
1378 device->description);
1379 mutex_lock(&table_lock);
1380 list_del(&device->driver_list);
1381 usb_serial_bus_deregister(device);
1382 mutex_unlock(&table_lock);
1383}
1384
1385/**
1386 * usb_serial_register_drivers - register drivers for a usb-serial module
1387 * @serial_drivers: NULL-terminated array of pointers to drivers to be registered
1388 * @name: name of the usb_driver for this set of @serial_drivers
1389 * @id_table: list of all devices this @serial_drivers set binds to
1390 *
1391 * Registers all the drivers in the @serial_drivers array, and dynamically
1392 * creates a struct usb_driver with the name @name and id_table of @id_table.
1393 */
1394int usb_serial_register_drivers(struct usb_serial_driver *const serial_drivers[],
1395 const char *name,
1396 const struct usb_device_id *id_table)
1397{
1398 int rc;
1399 struct usb_driver *udriver;
1400 struct usb_serial_driver * const *sd;
1401
1402 /*
1403 * udriver must be registered before any of the serial drivers,
1404 * because the store_new_id() routine for the serial drivers (in
1405 * bus.c) probes udriver.
1406 *
1407 * Performance hack: We don't want udriver to be probed until
1408 * the serial drivers are registered, because the probe would
1409 * simply fail for lack of a matching serial driver.
1410 * So we leave udriver's id_table set to NULL until we are all set.
1411 *
1412 * Suspend/resume support is implemented in the usb-serial core,
1413 * so fill in the PM-related fields in udriver.
1414 */
1415 udriver = kzalloc(sizeof(*udriver), GFP_KERNEL);
1416 if (!udriver)
1417 return -ENOMEM;
1418
1419 udriver->name = name;
1420 udriver->no_dynamic_id = 1;
1421 udriver->supports_autosuspend = 1;
1422 udriver->suspend = usb_serial_suspend;
1423 udriver->resume = usb_serial_resume;
1424 udriver->probe = usb_serial_probe;
1425 udriver->disconnect = usb_serial_disconnect;
1426
1427 /* we only set the reset_resume field if the serial_driver has one */
1428 for (sd = serial_drivers; *sd; ++sd) {
1429 if ((*sd)->reset_resume) {
1430 udriver->reset_resume = usb_serial_reset_resume;
1431 break;
1432 }
1433 }
1434
1435 rc = usb_register(udriver);
1436 if (rc)
1437 return rc;
1438
1439 for (sd = serial_drivers; *sd; ++sd) {
1440 (*sd)->usb_driver = udriver;
1441 rc = usb_serial_register(*sd);
1442 if (rc)
1443 goto failed;
1444 }
1445
1446 /* Now set udriver's id_table and look for matches */
1447 udriver->id_table = id_table;
1448 rc = driver_attach(&udriver->drvwrap.driver);
1449 return 0;
1450
1451 failed:
1452 while (sd-- > serial_drivers)
1453 usb_serial_deregister(*sd);
1454 usb_deregister(udriver);
1455 return rc;
1456}
1457EXPORT_SYMBOL_GPL(usb_serial_register_drivers);
1458
1459/**
1460 * usb_serial_deregister_drivers - deregister drivers for a usb-serial module
1461 * @serial_drivers: NULL-terminated array of pointers to drivers to be deregistered
1462 *
1463 * Deregisters all the drivers in the @serial_drivers array and deregisters and
1464 * frees the struct usb_driver that was created by the call to
1465 * usb_serial_register_drivers().
1466 */
1467void usb_serial_deregister_drivers(struct usb_serial_driver *const serial_drivers[])
1468{
1469 struct usb_driver *udriver = (*serial_drivers)->usb_driver;
1470
1471 for (; *serial_drivers; ++serial_drivers)
1472 usb_serial_deregister(*serial_drivers);
1473 usb_deregister(udriver);
1474 kfree(udriver);
1475}
1476EXPORT_SYMBOL_GPL(usb_serial_deregister_drivers);
1477
1478/* Module information */
1479MODULE_AUTHOR(DRIVER_AUTHOR);
1480MODULE_DESCRIPTION(DRIVER_DESC);
1481MODULE_LICENSE("GPL");
1482
1483module_param(debug, bool, S_IRUGO | S_IWUSR);
1484MODULE_PARM_DESC(debug, "Debug enabled or not");