?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Staging: strip: delete the driver
[linux/fpc-iii.git] / drivers / usb / serial / usb-serial.c
blob3873660d821776cab0d2950633cd17169b728643
1 /*
2 * USB Serial Converter driver
3 *
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)
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/smp_lock.h>
25 #include <linux/tty.h>
26 #include <linux/tty_driver.h>
27 #include <linux/tty_flip.h>
28 #include <linux/module.h>
29 #include <linux/moduleparam.h>
30 #include <linux/seq_file.h>
31 #include <linux/spinlock.h>
32 #include <linux/mutex.h>
33 #include <linux/list.h>
34 #include <linux/uaccess.h>
35 #include <linux/serial.h>
36 #include <linux/usb.h>
37 #include <linux/usb/serial.h>
38 #include <linux/kfifo.h>
39 #include "pl2303.h"
40
41 /*
42 * Version Information
43 */
44 #define DRIVER_AUTHOR "Greg Kroah-Hartman, greg@kroah.com, http://www.kroah.com/linux/"
45 #define DRIVER_DESC "USB Serial Driver core"
46
47 /* Driver structure we register with the USB core */
48 static struct usb_driver usb_serial_driver = {
49 .name = "usbserial",
50 .probe = usb_serial_probe,
51 .disconnect = usb_serial_disconnect,
52 .suspend = usb_serial_suspend,
53 .resume = usb_serial_resume,
54 .no_dynamic_id = 1,
55 };
56
57 /* There is no MODULE_DEVICE_TABLE for usbserial.c. Instead
58 the MODULE_DEVICE_TABLE declarations in each serial driver
59 cause the "hotplug" program to pull in whatever module is necessary
60 via modprobe, and modprobe will load usbserial because the serial
61 drivers depend on it.
62 */
63
64 static int debug;
65 /* initially all NULL */
66 static struct usb_serial *serial_table[SERIAL_TTY_MINORS];
67 static DEFINE_MUTEX(table_lock);
68 static LIST_HEAD(usb_serial_driver_list);
69
70 /*
71 * Look up the serial structure. If it is found and it hasn't been
72 * disconnected, return with its disc_mutex held and its refcount
73 * incremented. Otherwise return NULL.
74 */
75 struct usb_serial *usb_serial_get_by_index(unsigned index)
76 {
77 struct usb_serial *serial;
78
79 mutex_lock(&table_lock);
80 serial = serial_table[index];
81
82 if (serial) {
83 mutex_lock(&serial->disc_mutex);
84 if (serial->disconnected) {
85 mutex_unlock(&serial->disc_mutex);
86 serial = NULL;
87 } else {
88 kref_get(&serial->kref);
89 }
90 }
91 mutex_unlock(&table_lock);
92 return serial;
93 }
94
95 static struct usb_serial *get_free_serial(struct usb_serial *serial,
96 int num_ports, unsigned int *minor)
97 {
98 unsigned int i, j;
99 int good_spot;
100
101 dbg("%s %d", __func__, num_ports);
102
103 *minor = 0;
104 mutex_lock(&table_lock);
105 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
106 if (serial_table[i])
107 continue;
108
109 good_spot = 1;
110 for (j = 1; j <= num_ports-1; ++j)
111 if ((i+j >= SERIAL_TTY_MINORS) || (serial_table[i+j])) {
112 good_spot = 0;
113 i += j;
114 break;
115 }
116 if (good_spot == 0)
117 continue;
118
119 *minor = i;
120 j = 0;
121 dbg("%s - minor base = %d", __func__, *minor);
122 for (i = *minor; (i < (*minor + num_ports)) && (i < SERIAL_TTY_MINORS); ++i) {
123 serial_table[i] = serial;
124 serial->port[j++]->number = i;
125 }
126 mutex_unlock(&table_lock);
127 return serial;
128 }
129 mutex_unlock(&table_lock);
130 return NULL;
131 }
132
133 static void return_serial(struct usb_serial *serial)
134 {
135 int i;
136
137 dbg("%s", __func__);
138
139 mutex_lock(&table_lock);
140 for (i = 0; i < serial->num_ports; ++i)
141 serial_table[serial->minor + i] = NULL;
142 mutex_unlock(&table_lock);
143 }
144
145 static void destroy_serial(struct kref *kref)
146 {
147 struct usb_serial *serial;
148 struct usb_serial_port *port;
149 int i;
150
151 serial = to_usb_serial(kref);
152
153 dbg("%s - %s", __func__, serial->type->description);
154
155 /* return the minor range that this device had */
156 if (serial->minor != SERIAL_TTY_NO_MINOR)
157 return_serial(serial);
158
159 if (serial->attached)
160 serial->type->release(serial);
161
162 /* Now that nothing is using the ports, they can be freed */
163 for (i = 0; i < serial->num_port_pointers; ++i) {
164 port = serial->port[i];
165 if (port) {
166 port->serial = NULL;
167 put_device(&port->dev);
168 }
169 }
170
171 usb_put_dev(serial->dev);
172 kfree(serial);
173 }
174
175 void usb_serial_put(struct usb_serial *serial)
176 {
177 kref_put(&serial->kref, destroy_serial);
178 }
179
180 /*****************************************************************************
181 * Driver tty interface functions
182 *****************************************************************************/
183
184 /**
185 * serial_install - install tty
186 * @driver: the driver (USB in our case)
187 * @tty: the tty being created
188 *
189 * Create the termios objects for this tty. We use the default
190 * USB serial settings but permit them to be overridden by
191 * serial->type->init_termios.
192 *
193 * This is the first place a new tty gets used. Hence this is where we
194 * acquire references to the usb_serial structure and the driver module,
195 * where we store a pointer to the port, and where we do an autoresume.
196 * All these actions are reversed in serial_cleanup().
197 */
198 static int serial_install(struct tty_driver *driver, struct tty_struct *tty)
199 {
200 int idx = tty->index;
201 struct usb_serial *serial;
202 struct usb_serial_port *port;
203 int retval = -ENODEV;
204
205 dbg("%s", __func__);
206
207 serial = usb_serial_get_by_index(idx);
208 if (!serial)
209 return retval;
210
211 port = serial->port[idx - serial->minor];
212 if (!port)
213 goto error_no_port;
214 if (!try_module_get(serial->type->driver.owner))
215 goto error_module_get;
216
217 /* perform the standard setup */
218 retval = tty_init_termios(tty);
219 if (retval)
220 goto error_init_termios;
221
222 retval = usb_autopm_get_interface(serial->interface);
223 if (retval)
224 goto error_get_interface;
225
226 mutex_unlock(&serial->disc_mutex);
227
228 /* allow the driver to update the settings */
229 if (serial->type->init_termios)
230 serial->type->init_termios(tty);
231
232 tty->driver_data = port;
233
234 /* Final install (we use the default method) */
235 tty_driver_kref_get(driver);
236 tty->count++;
237 driver->ttys[idx] = tty;
238 return retval;
239
240 error_get_interface:
241 error_init_termios:
242 module_put(serial->type->driver.owner);
243 error_module_get:
244 error_no_port:
245 usb_serial_put(serial);
246 mutex_unlock(&serial->disc_mutex);
247 return retval;
248 }
249
250 static int serial_activate(struct tty_port *tport, struct tty_struct *tty)
251 {
252 struct usb_serial_port *port =
253 container_of(tport, struct usb_serial_port, port);
254 struct usb_serial *serial = port->serial;
255 int retval;
256
257 mutex_lock(&serial->disc_mutex);
258 if (serial->disconnected)
259 retval = -ENODEV;
260 else
261 retval = port->serial->type->open(tty, port);
262 mutex_unlock(&serial->disc_mutex);
263 return retval;
264 }
265
266 static int serial_open(struct tty_struct *tty, struct file *filp)
267 {
268 struct usb_serial_port *port = tty->driver_data;
269
270 dbg("%s - port %d", __func__, port->number);
271 return tty_port_open(&port->port, tty, filp);
272 }
273
274 /**
275 * serial_down - shut down hardware
276 * @tport: tty port to shut down
277 *
278 * Shut down a USB serial port unless it is the console. We never
279 * shut down the console hardware as it will always be in use. Serialized
280 * against activate by the tport mutex and kept to matching open/close pairs
281 * of calls by the ASYNCB_INITIALIZED flag.
282 */
283 static void serial_down(struct tty_port *tport)
284 {
285 struct usb_serial_port *port =
286 container_of(tport, struct usb_serial_port, port);
287 struct usb_serial_driver *drv = port->serial->type;
288 /*
289 * The console is magical. Do not hang up the console hardware
290 * or there will be tears.
291 */
292 if (port->console)
293 return;
294 if (drv->close)
295 drv->close(port);
296 }
297
298 static void serial_hangup(struct tty_struct *tty)
299 {
300 struct usb_serial_port *port = tty->driver_data;
301 dbg("%s - port %d", __func__, port->number);
302 tty_port_hangup(&port->port);
303 }
304
305 static void serial_close(struct tty_struct *tty, struct file *filp)
306 {
307 struct usb_serial_port *port = tty->driver_data;
308 dbg("%s - port %d", __func__, port->number);
309 tty_port_close(&port->port, tty, filp);
310 }
311
312 /**
313 * serial_cleanup - free resources post close/hangup
314 * @port: port to free up
315 *
316 * Do the resource freeing and refcount dropping for the port.
317 * Avoid freeing the console.
318 *
319 * Called asynchronously after the last tty kref is dropped,
320 * and the tty layer has already done the tty_shutdown(tty);
321 */
322 static void serial_cleanup(struct tty_struct *tty)
323 {
324 struct usb_serial_port *port = tty->driver_data;
325 struct usb_serial *serial;
326 struct module *owner;
327
328 /* The console is magical. Do not hang up the console hardware
329 * or there will be tears.
330 */
331 if (port->console)
332 return;
333
334 dbg("%s - port %d", __func__, port->number);
335
336 tty->driver_data = NULL;
337
338 serial = port->serial;
339 owner = serial->type->driver.owner;
340
341 mutex_lock(&serial->disc_mutex);
342 if (!serial->disconnected)
343 usb_autopm_put_interface(serial->interface);
344 mutex_unlock(&serial->disc_mutex);
345
346 usb_serial_put(serial);
347 module_put(owner);
348 }
349
350 static int serial_write(struct tty_struct *tty, const unsigned char *buf,
351 int count)
352 {
353 struct usb_serial_port *port = tty->driver_data;
354 int retval = -ENODEV;
355
356 if (port->serial->dev->state == USB_STATE_NOTATTACHED)
357 goto exit;
358
359 dbg("%s - port %d, %d byte(s)", __func__, port->number, count);
360
361 /* pass on to the driver specific version of this function */
362 retval = port->serial->type->write(tty, port, buf, count);
363
364 exit:
365 return retval;
366 }
367
368 static int serial_write_room(struct tty_struct *tty)
369 {
370 struct usb_serial_port *port = tty->driver_data;
371 dbg("%s - port %d", __func__, port->number);
372 /* pass on to the driver specific version of this function */
373 return port->serial->type->write_room(tty);
374 }
375
376 static int serial_chars_in_buffer(struct tty_struct *tty)
377 {
378 struct usb_serial_port *port = tty->driver_data;
379 dbg("%s - port %d", __func__, port->number);
380
381 /* if the device was unplugged then any remaining characters
382 fell out of the connector ;) */
383 if (port->serial->disconnected)
384 return 0;
385 /* pass on to the driver specific version of this function */
386 return port->serial->type->chars_in_buffer(tty);
387 }
388
389 static void serial_throttle(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->throttle)
396 port->serial->type->throttle(tty);
397 }
398
399 static void serial_unthrottle(struct tty_struct *tty)
400 {
401 struct usb_serial_port *port = tty->driver_data;
402 dbg("%s - port %d", __func__, port->number);
403
404 /* pass on to the driver specific version of this function */
405 if (port->serial->type->unthrottle)
406 port->serial->type->unthrottle(tty);
407 }
408
409 static int serial_ioctl(struct tty_struct *tty, struct file *file,
410 unsigned int cmd, unsigned long arg)
411 {
412 struct usb_serial_port *port = tty->driver_data;
413 int retval = -ENODEV;
414
415 dbg("%s - port %d, cmd 0x%.4x", __func__, port->number, cmd);
416
417 /* pass on to the driver specific version of this function
418 if it is available */
419 if (port->serial->type->ioctl) {
420 retval = port->serial->type->ioctl(tty, file, cmd, arg);
421 } else
422 retval = -ENOIOCTLCMD;
423 return retval;
424 }
425
426 static void serial_set_termios(struct tty_struct *tty, struct ktermios *old)
427 {
428 struct usb_serial_port *port = tty->driver_data;
429 dbg("%s - port %d", __func__, port->number);
430
431 /* pass on to the driver specific version of this function
432 if it is available */
433 if (port->serial->type->set_termios)
434 port->serial->type->set_termios(tty, port, old);
435 else
436 tty_termios_copy_hw(tty->termios, old);
437 }
438
439 static int serial_break(struct tty_struct *tty, int break_state)
440 {
441 struct usb_serial_port *port = tty->driver_data;
442
443 dbg("%s - port %d", __func__, port->number);
444
445 /* pass on to the driver specific version of this function
446 if it is available */
447 if (port->serial->type->break_ctl)
448 port->serial->type->break_ctl(tty, break_state);
449 return 0;
450 }
451
452 static int serial_proc_show(struct seq_file *m, void *v)
453 {
454 struct usb_serial *serial;
455 int i;
456 char tmp[40];
457
458 dbg("%s", __func__);
459 seq_puts(m, "usbserinfo:1.0 driver:2.0\n");
460 for (i = 0; i < SERIAL_TTY_MINORS; ++i) {
461 serial = usb_serial_get_by_index(i);
462 if (serial == NULL)
463 continue;
464
465 seq_printf(m, "%d:", i);
466 if (serial->type->driver.owner)
467 seq_printf(m, " module:%s",
468 module_name(serial->type->driver.owner));
469 seq_printf(m, " name:\"%s\"",
470 serial->type->description);
471 seq_printf(m, " vendor:%04x product:%04x",
472 le16_to_cpu(serial->dev->descriptor.idVendor),
473 le16_to_cpu(serial->dev->descriptor.idProduct));
474 seq_printf(m, " num_ports:%d", serial->num_ports);
475 seq_printf(m, " port:%d", i - serial->minor + 1);
476 usb_make_path(serial->dev, tmp, sizeof(tmp));
477 seq_printf(m, " path:%s", tmp);
478
479 seq_putc(m, '\n');
480 usb_serial_put(serial);
481 mutex_unlock(&serial->disc_mutex);
482 }
483 return 0;
484 }
485
486 static int serial_proc_open(struct inode *inode, struct file *file)
487 {
488 return single_open(file, serial_proc_show, NULL);
489 }
490
491 static const struct file_operations serial_proc_fops = {
492 .owner = THIS_MODULE,
493 .open = serial_proc_open,
494 .read = seq_read,
495 .llseek = seq_lseek,
496 .release = single_release,
497 };
498
499 static int serial_tiocmget(struct tty_struct *tty, struct file *file)
500 {
501 struct usb_serial_port *port = tty->driver_data;
502
503 dbg("%s - port %d", __func__, port->number);
504
505 if (port->serial->type->tiocmget)
506 return port->serial->type->tiocmget(tty, file);
507 return -EINVAL;
508 }
509
510 static int serial_tiocmset(struct tty_struct *tty, struct file *file,
511 unsigned int set, unsigned int clear)
512 {
513 struct usb_serial_port *port = tty->driver_data;
514
515 dbg("%s - port %d", __func__, port->number);
516
517 if (port->serial->type->tiocmset)
518 return port->serial->type->tiocmset(tty, file, set, clear);
519 return -EINVAL;
520 }
521
522 /*
523 * We would be calling tty_wakeup here, but unfortunately some line
524 * disciplines have an annoying habit of calling tty->write from
525 * the write wakeup callback (e.g. n_hdlc.c).
526 */
527 void usb_serial_port_softint(struct usb_serial_port *port)
528 {
529 schedule_work(&port->work);
530 }
531 EXPORT_SYMBOL_GPL(usb_serial_port_softint);
532
533 static void usb_serial_port_work(struct work_struct *work)
534 {
535 struct usb_serial_port *port =
536 container_of(work, struct usb_serial_port, work);
537 struct tty_struct *tty;
538
539 dbg("%s - port %d", __func__, port->number);
540
541 tty = tty_port_tty_get(&port->port);
542 if (!tty)
543 return;
544
545 tty_wakeup(tty);
546 tty_kref_put(tty);
547 }
548
549 static void kill_traffic(struct usb_serial_port *port)
550 {
551 usb_kill_urb(port->read_urb);
552 usb_kill_urb(port->write_urb);
553 /*
554 * This is tricky.
555 * Some drivers submit the read_urb in the
556 * handler for the write_urb or vice versa
557 * this order determines the order in which
558 * usb_kill_urb() must be used to reliably
559 * kill the URBs. As it is unknown here,
560 * both orders must be used in turn.
561 * The call below is not redundant.
562 */
563 usb_kill_urb(port->read_urb);
564 usb_kill_urb(port->interrupt_in_urb);
565 usb_kill_urb(port->interrupt_out_urb);
566 }
567
568 static void port_release(struct device *dev)
569 {
570 struct usb_serial_port *port = to_usb_serial_port(dev);
571
572 dbg ("%s - %s", __func__, dev_name(dev));
573
574 /*
575 * Stop all the traffic before cancelling the work, so that
576 * nobody will restart it by calling usb_serial_port_softint.
577 */
578 kill_traffic(port);
579 cancel_work_sync(&port->work);
580
581 usb_free_urb(port->read_urb);
582 usb_free_urb(port->write_urb);
583 usb_free_urb(port->interrupt_in_urb);
584 usb_free_urb(port->interrupt_out_urb);
585 kfifo_free(&port->write_fifo);
586 kfree(port->bulk_in_buffer);
587 kfree(port->bulk_out_buffer);
588 kfree(port->interrupt_in_buffer);
589 kfree(port->interrupt_out_buffer);
590 kfree(port);
591 }
592
593 static struct usb_serial *create_serial(struct usb_device *dev,
594 struct usb_interface *interface,
595 struct usb_serial_driver *driver)
596 {
597 struct usb_serial *serial;
598
599 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
600 if (!serial) {
601 dev_err(&dev->dev, "%s - out of memory\n", __func__);
602 return NULL;
603 }
604 serial->dev = usb_get_dev(dev);
605 serial->type = driver;
606 serial->interface = interface;
607 kref_init(&serial->kref);
608 mutex_init(&serial->disc_mutex);
609 serial->minor = SERIAL_TTY_NO_MINOR;
610
611 return serial;
612 }
613
614 static const struct usb_device_id *match_dynamic_id(struct usb_interface *intf,
615 struct usb_serial_driver *drv)
616 {
617 struct usb_dynid *dynid;
618
619 spin_lock(&drv->dynids.lock);
620 list_for_each_entry(dynid, &drv->dynids.list, node) {
621 if (usb_match_one_id(intf, &dynid->id)) {
622 spin_unlock(&drv->dynids.lock);
623 return &dynid->id;
624 }
625 }
626 spin_unlock(&drv->dynids.lock);
627 return NULL;
628 }
629
630 static const struct usb_device_id *get_iface_id(struct usb_serial_driver *drv,
631 struct usb_interface *intf)
632 {
633 const struct usb_device_id *id;
634
635 id = usb_match_id(intf, drv->id_table);
636 if (id) {
637 dbg("static descriptor matches");
638 goto exit;
639 }
640 id = match_dynamic_id(intf, drv);
641 if (id)
642 dbg("dynamic descriptor matches");
643 exit:
644 return id;
645 }
646
647 static struct usb_serial_driver *search_serial_device(
648 struct usb_interface *iface)
649 {
650 const struct usb_device_id *id;
651 struct usb_serial_driver *drv;
652
653 /* Check if the usb id matches a known device */
654 list_for_each_entry(drv, &usb_serial_driver_list, driver_list) {
655 id = get_iface_id(drv, iface);
656 if (id)
657 return drv;
658 }
659
660 return NULL;
661 }
662
663 static int serial_carrier_raised(struct tty_port *port)
664 {
665 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
666 struct usb_serial_driver *drv = p->serial->type;
667 if (drv->carrier_raised)
668 return drv->carrier_raised(p);
669 /* No carrier control - don't block */
670 return 1;
671 }
672
673 static void serial_dtr_rts(struct tty_port *port, int on)
674 {
675 struct usb_serial_port *p = container_of(port, struct usb_serial_port, port);
676 struct usb_serial_driver *drv = p->serial->type;
677 if (drv->dtr_rts)
678 drv->dtr_rts(p, on);
679 }
680
681 static const struct tty_port_operations serial_port_ops = {
682 .carrier_raised = serial_carrier_raised,
683 .dtr_rts = serial_dtr_rts,
684 .activate = serial_activate,
685 .shutdown = serial_down,
686 };
687
688 int usb_serial_probe(struct usb_interface *interface,
689 const struct usb_device_id *id)
690 {
691 struct usb_device *dev = interface_to_usbdev(interface);
692 struct usb_serial *serial = NULL;
693 struct usb_serial_port *port;
694 struct usb_host_interface *iface_desc;
695 struct usb_endpoint_descriptor *endpoint;
696 struct usb_endpoint_descriptor *interrupt_in_endpoint[MAX_NUM_PORTS];
697 struct usb_endpoint_descriptor *interrupt_out_endpoint[MAX_NUM_PORTS];
698 struct usb_endpoint_descriptor *bulk_in_endpoint[MAX_NUM_PORTS];
699 struct usb_endpoint_descriptor *bulk_out_endpoint[MAX_NUM_PORTS];
700 struct usb_serial_driver *type = NULL;
701 int retval;
702 unsigned int minor;
703 int buffer_size;
704 int i;
705 int num_interrupt_in = 0;
706 int num_interrupt_out = 0;
707 int num_bulk_in = 0;
708 int num_bulk_out = 0;
709 int num_ports = 0;
710 int max_endpoints;
711
712 lock_kernel(); /* guard against unloading a serial driver module */
713 type = search_serial_device(interface);
714 if (!type) {
715 unlock_kernel();
716 dbg("none matched");
717 return -ENODEV;
718 }
719
720 serial = create_serial(dev, interface, type);
721 if (!serial) {
722 unlock_kernel();
723 dev_err(&interface->dev, "%s - out of memory\n", __func__);
724 return -ENOMEM;
725 }
726
727 /* if this device type has a probe function, call it */
728 if (type->probe) {
729 const struct usb_device_id *id;
730
731 if (!try_module_get(type->driver.owner)) {
732 unlock_kernel();
733 dev_err(&interface->dev,
734 "module get failed, exiting\n");
735 kfree(serial);
736 return -EIO;
737 }
738
739 id = get_iface_id(type, interface);
740 retval = type->probe(serial, id);
741 module_put(type->driver.owner);
742
743 if (retval) {
744 unlock_kernel();
745 dbg("sub driver rejected device");
746 kfree(serial);
747 return retval;
748 }
749 }
750
751 /* descriptor matches, let's find the endpoints needed */
752 /* check out the endpoints */
753 iface_desc = interface->cur_altsetting;
754 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
755 endpoint = &iface_desc->endpoint[i].desc;
756
757 if (usb_endpoint_is_bulk_in(endpoint)) {
758 /* we found a bulk in endpoint */
759 dbg("found bulk in on endpoint %d", i);
760 bulk_in_endpoint[num_bulk_in] = endpoint;
761 ++num_bulk_in;
762 }
763
764 if (usb_endpoint_is_bulk_out(endpoint)) {
765 /* we found a bulk out endpoint */
766 dbg("found bulk out on endpoint %d", i);
767 bulk_out_endpoint[num_bulk_out] = endpoint;
768 ++num_bulk_out;
769 }
770
771 if (usb_endpoint_is_int_in(endpoint)) {
772 /* we found a interrupt in endpoint */
773 dbg("found interrupt in on endpoint %d", i);
774 interrupt_in_endpoint[num_interrupt_in] = endpoint;
775 ++num_interrupt_in;
776 }
777
778 if (usb_endpoint_is_int_out(endpoint)) {
779 /* we found an interrupt out endpoint */
780 dbg("found interrupt out on endpoint %d", i);
781 interrupt_out_endpoint[num_interrupt_out] = endpoint;
782 ++num_interrupt_out;
783 }
784 }
785
786 #if defined(CONFIG_USB_SERIAL_PL2303) || defined(CONFIG_USB_SERIAL_PL2303_MODULE)
787 /* BEGIN HORRIBLE HACK FOR PL2303 */
788 /* this is needed due to the looney way its endpoints are set up */
789 if (((le16_to_cpu(dev->descriptor.idVendor) == PL2303_VENDOR_ID) &&
790 (le16_to_cpu(dev->descriptor.idProduct) == PL2303_PRODUCT_ID)) ||
791 ((le16_to_cpu(dev->descriptor.idVendor) == ATEN_VENDOR_ID) &&
792 (le16_to_cpu(dev->descriptor.idProduct) == ATEN_PRODUCT_ID)) ||
793 ((le16_to_cpu(dev->descriptor.idVendor) == ALCOR_VENDOR_ID) &&
794 (le16_to_cpu(dev->descriptor.idProduct) == ALCOR_PRODUCT_ID)) ||
795 ((le16_to_cpu(dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
796 (le16_to_cpu(dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_EF81))) {
797 if (interface != dev->actconfig->interface[0]) {
798 /* check out the endpoints of the other interface*/
799 iface_desc = dev->actconfig->interface[0]->cur_altsetting;
800 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
801 endpoint = &iface_desc->endpoint[i].desc;
802 if (usb_endpoint_is_int_in(endpoint)) {
803 /* we found a interrupt in endpoint */
804 dbg("found interrupt in for Prolific device on separate interface");
805 interrupt_in_endpoint[num_interrupt_in] = endpoint;
806 ++num_interrupt_in;
807 }
808 }
809 }
810
811 /* Now make sure the PL-2303 is configured correctly.
812 * If not, give up now and hope this hack will work
813 * properly during a later invocation of usb_serial_probe
814 */
815 if (num_bulk_in == 0 || num_bulk_out == 0) {
816 unlock_kernel();
817 dev_info(&interface->dev, "PL-2303 hack: descriptors matched but endpoints did not\n");
818 kfree(serial);
819 return -ENODEV;
820 }
821 }
822 /* END HORRIBLE HACK FOR PL2303 */
823 #endif
824
825 #ifdef CONFIG_USB_SERIAL_GENERIC
826 if (type == &usb_serial_generic_device) {
827 num_ports = num_bulk_out;
828 if (num_ports == 0) {
829 unlock_kernel();
830 dev_err(&interface->dev,
831 "Generic device with no bulk out, not allowed.\n");
832 kfree(serial);
833 return -EIO;
834 }
835 }
836 #endif
837 if (!num_ports) {
838 /* if this device type has a calc_num_ports function, call it */
839 if (type->calc_num_ports) {
840 if (!try_module_get(type->driver.owner)) {
841 unlock_kernel();
842 dev_err(&interface->dev,
843 "module get failed, exiting\n");
844 kfree(serial);
845 return -EIO;
846 }
847 num_ports = type->calc_num_ports(serial);
848 module_put(type->driver.owner);
849 }
850 if (!num_ports)
851 num_ports = type->num_ports;
852 }
853
854 serial->num_ports = num_ports;
855 serial->num_bulk_in = num_bulk_in;
856 serial->num_bulk_out = num_bulk_out;
857 serial->num_interrupt_in = num_interrupt_in;
858 serial->num_interrupt_out = num_interrupt_out;
859
860 /* found all that we need */
861 dev_info(&interface->dev, "%s converter detected\n",
862 type->description);
863
864 /* create our ports, we need as many as the max endpoints */
865 /* we don't use num_ports here because some devices have more
866 endpoint pairs than ports */
867 max_endpoints = max(num_bulk_in, num_bulk_out);
868 max_endpoints = max(max_endpoints, num_interrupt_in);
869 max_endpoints = max(max_endpoints, num_interrupt_out);
870 max_endpoints = max(max_endpoints, (int)serial->num_ports);
871 serial->num_port_pointers = max_endpoints;
872 unlock_kernel();
873
874 dbg("%s - setting up %d port structures for this device",
875 __func__, max_endpoints);
876 for (i = 0; i < max_endpoints; ++i) {
877 port = kzalloc(sizeof(struct usb_serial_port), GFP_KERNEL);
878 if (!port)
879 goto probe_error;
880 tty_port_init(&port->port);
881 port->port.ops = &serial_port_ops;
882 port->serial = serial;
883 spin_lock_init(&port->lock);
884 /* Keep this for private driver use for the moment but
885 should probably go away */
886 INIT_WORK(&port->work, usb_serial_port_work);
887 serial->port[i] = port;
888 port->dev.parent = &interface->dev;
889 port->dev.driver = NULL;
890 port->dev.bus = &usb_serial_bus_type;
891 port->dev.release = &port_release;
892 device_initialize(&port->dev);
893 }
894
895 /* set up the endpoint information */
896 for (i = 0; i < num_bulk_in; ++i) {
897 endpoint = bulk_in_endpoint[i];
898 port = serial->port[i];
899 port->read_urb = usb_alloc_urb(0, GFP_KERNEL);
900 if (!port->read_urb) {
901 dev_err(&interface->dev, "No free urbs available\n");
902 goto probe_error;
903 }
904 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
905 port->bulk_in_size = buffer_size;
906 port->bulk_in_endpointAddress = endpoint->bEndpointAddress;
907 port->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
908 if (!port->bulk_in_buffer) {
909 dev_err(&interface->dev,
910 "Couldn't allocate bulk_in_buffer\n");
911 goto probe_error;
912 }
913 usb_fill_bulk_urb(port->read_urb, dev,
914 usb_rcvbulkpipe(dev,
915 endpoint->bEndpointAddress),
916 port->bulk_in_buffer, buffer_size,
917 serial->type->read_bulk_callback, port);
918 }
919
920 for (i = 0; i < num_bulk_out; ++i) {
921 endpoint = bulk_out_endpoint[i];
922 port = serial->port[i];
923 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
924 if (!port->write_urb) {
925 dev_err(&interface->dev, "No free urbs available\n");
926 goto probe_error;
927 }
928 if (kfifo_alloc(&port->write_fifo, PAGE_SIZE, GFP_KERNEL))
929 goto probe_error;
930 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
931 port->bulk_out_size = buffer_size;
932 port->bulk_out_endpointAddress = endpoint->bEndpointAddress;
933 port->bulk_out_buffer = kmalloc(buffer_size, GFP_KERNEL);
934 if (!port->bulk_out_buffer) {
935 dev_err(&interface->dev,
936 "Couldn't allocate bulk_out_buffer\n");
937 goto probe_error;
938 }
939 usb_fill_bulk_urb(port->write_urb, dev,
940 usb_sndbulkpipe(dev,
941 endpoint->bEndpointAddress),
942 port->bulk_out_buffer, buffer_size,
943 serial->type->write_bulk_callback, port);
944 }
945
946 if (serial->type->read_int_callback) {
947 for (i = 0; i < num_interrupt_in; ++i) {
948 endpoint = interrupt_in_endpoint[i];
949 port = serial->port[i];
950 port->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
951 if (!port->interrupt_in_urb) {
952 dev_err(&interface->dev,
953 "No free urbs available\n");
954 goto probe_error;
955 }
956 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
957 port->interrupt_in_endpointAddress =
958 endpoint->bEndpointAddress;
959 port->interrupt_in_buffer = kmalloc(buffer_size,
960 GFP_KERNEL);
961 if (!port->interrupt_in_buffer) {
962 dev_err(&interface->dev,
963 "Couldn't allocate interrupt_in_buffer\n");
964 goto probe_error;
965 }
966 usb_fill_int_urb(port->interrupt_in_urb, dev,
967 usb_rcvintpipe(dev,
968 endpoint->bEndpointAddress),
969 port->interrupt_in_buffer, buffer_size,
970 serial->type->read_int_callback, port,
971 endpoint->bInterval);
972 }
973 } else if (num_interrupt_in) {
974 dbg("the device claims to support interrupt in transfers, but read_int_callback is not defined");
975 }
976
977 if (serial->type->write_int_callback) {
978 for (i = 0; i < num_interrupt_out; ++i) {
979 endpoint = interrupt_out_endpoint[i];
980 port = serial->port[i];
981 port->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
982 if (!port->interrupt_out_urb) {
983 dev_err(&interface->dev,
984 "No free urbs available\n");
985 goto probe_error;
986 }
987 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
988 port->interrupt_out_size = buffer_size;
989 port->interrupt_out_endpointAddress =
990 endpoint->bEndpointAddress;
991 port->interrupt_out_buffer = kmalloc(buffer_size,
992 GFP_KERNEL);
993 if (!port->interrupt_out_buffer) {
994 dev_err(&interface->dev,
995 "Couldn't allocate interrupt_out_buffer\n");
996 goto probe_error;
997 }
998 usb_fill_int_urb(port->interrupt_out_urb, dev,
999 usb_sndintpipe(dev,
1000 endpoint->bEndpointAddress),
1001 port->interrupt_out_buffer, buffer_size,
1002 serial->type->write_int_callback, port,
1003 endpoint->bInterval);
1004 }
1005 } else if (num_interrupt_out) {
1006 dbg("the device claims to support interrupt out transfers, but write_int_callback is not defined");
1007 }
1008
1009 /* if this device type has an attach function, call it */
1010 if (type->attach) {
1011 if (!try_module_get(type->driver.owner)) {
1012 dev_err(&interface->dev,
1013 "module get failed, exiting\n");
1014 goto probe_error;
1015 }
1016 retval = type->attach(serial);
1017 module_put(type->driver.owner);
1018 if (retval < 0)
1019 goto probe_error;
1020 serial->attached = 1;
1021 if (retval > 0) {
1022 /* quietly accept this device, but don't bind to a
1023 serial port as it's about to disappear */
1024 serial->num_ports = 0;
1025 goto exit;
1026 }
1027 } else {
1028 serial->attached = 1;
1029 }
1030
1031 if (get_free_serial(serial, num_ports, &minor) == NULL) {
1032 dev_err(&interface->dev, "No more free serial devices\n");
1033 goto probe_error;
1034 }
1035 serial->minor = minor;
1036
1037 /* register all of the individual ports with the driver core */
1038 for (i = 0; i < num_ports; ++i) {
1039 port = serial->port[i];
1040 dev_set_name(&port->dev, "ttyUSB%d", port->number);
1041 dbg ("%s - registering %s", __func__, dev_name(&port->dev));
1042 port->dev_state = PORT_REGISTERING;
1043 retval = device_add(&port->dev);
1044 if (retval) {
1045 dev_err(&port->dev, "Error registering port device, "
1046 "continuing\n");
1047 port->dev_state = PORT_UNREGISTERED;
1048 } else {
1049 port->dev_state = PORT_REGISTERED;
1050 }
1051 }
1052
1053 usb_serial_console_init(debug, minor);
1054
1055 exit:
1056 /* success */
1057 usb_set_intfdata(interface, serial);
1058 return 0;
1059
1060 probe_error:
1061 usb_serial_put(serial);
1062 return -EIO;
1063 }
1064 EXPORT_SYMBOL_GPL(usb_serial_probe);
1065
1066 void usb_serial_disconnect(struct usb_interface *interface)
1067 {
1068 int i;
1069 struct usb_serial *serial = usb_get_intfdata(interface);
1070 struct device *dev = &interface->dev;
1071 struct usb_serial_port *port;
1072
1073 usb_serial_console_disconnect(serial);
1074 dbg("%s", __func__);
1075
1076 mutex_lock(&serial->disc_mutex);
1077 usb_set_intfdata(interface, NULL);
1078 /* must set a flag, to signal subdrivers */
1079 serial->disconnected = 1;
1080 mutex_unlock(&serial->disc_mutex);
1081
1082 for (i = 0; i < serial->num_ports; ++i) {
1083 port = serial->port[i];
1084 if (port) {
1085 struct tty_struct *tty = tty_port_tty_get(&port->port);
1086 if (tty) {
1087 tty_vhangup(tty);
1088 tty_kref_put(tty);
1089 }
1090 kill_traffic(port);
1091 cancel_work_sync(&port->work);
1092 if (port->dev_state == PORT_REGISTERED) {
1093
1094 /* Make sure the port is bound so that the
1095 * driver's port_remove method is called.
1096 */
1097 if (!port->dev.driver) {
1098 int rc;
1099
1100 port->dev.driver =
1101 &serial->type->driver;
1102 rc = device_bind_driver(&port->dev);
1103 }
1104 port->dev_state = PORT_UNREGISTERING;
1105 device_del(&port->dev);
1106 port->dev_state = PORT_UNREGISTERED;
1107 }
1108 }
1109 }
1110 serial->type->disconnect(serial);
1111
1112 /* let the last holder of this object cause it to be cleaned up */
1113 usb_serial_put(serial);
1114 dev_info(dev, "device disconnected\n");
1115 }
1116 EXPORT_SYMBOL_GPL(usb_serial_disconnect);
1117
1118 int usb_serial_suspend(struct usb_interface *intf, pm_message_t message)
1119 {
1120 struct usb_serial *serial = usb_get_intfdata(intf);
1121 struct usb_serial_port *port;
1122 int i, r = 0;
1123
1124 serial->suspending = 1;
1125
1126 if (serial->type->suspend) {
1127 r = serial->type->suspend(serial, message);
1128 if (r < 0) {
1129 serial->suspending = 0;
1130 goto err_out;
1131 }
1132 }
1133
1134 for (i = 0; i < serial->num_ports; ++i) {
1135 port = serial->port[i];
1136 if (port)
1137 kill_traffic(port);
1138 }
1139
1140 err_out:
1141 return r;
1142 }
1143 EXPORT_SYMBOL(usb_serial_suspend);
1144
1145 int usb_serial_resume(struct usb_interface *intf)
1146 {
1147 struct usb_serial *serial = usb_get_intfdata(intf);
1148 int rv;
1149
1150 serial->suspending = 0;
1151 if (serial->type->resume)
1152 rv = serial->type->resume(serial);
1153 else
1154 rv = usb_serial_generic_resume(serial);
1155
1156 return rv;
1157 }
1158 EXPORT_SYMBOL(usb_serial_resume);
1159
1160 static const struct tty_operations serial_ops = {
1161 .open = serial_open,
1162 .close = serial_close,
1163 .write = serial_write,
1164 .hangup = serial_hangup,
1165 .write_room = serial_write_room,
1166 .ioctl = serial_ioctl,
1167 .set_termios = serial_set_termios,
1168 .throttle = serial_throttle,
1169 .unthrottle = serial_unthrottle,
1170 .break_ctl = serial_break,
1171 .chars_in_buffer = serial_chars_in_buffer,
1172 .tiocmget = serial_tiocmget,
1173 .tiocmset = serial_tiocmset,
1174 .cleanup = serial_cleanup,
1175 .install = serial_install,
1176 .proc_fops = &serial_proc_fops,
1177 };
1178
1179
1180 struct tty_driver *usb_serial_tty_driver;
1181
1182 static int __init usb_serial_init(void)
1183 {
1184 int i;
1185 int result;
1186
1187 usb_serial_tty_driver = alloc_tty_driver(SERIAL_TTY_MINORS);
1188 if (!usb_serial_tty_driver)
1189 return -ENOMEM;
1190
1191 /* Initialize our global data */
1192 for (i = 0; i < SERIAL_TTY_MINORS; ++i)
1193 serial_table[i] = NULL;
1194
1195 result = bus_register(&usb_serial_bus_type);
1196 if (result) {
1197 printk(KERN_ERR "usb-serial: %s - registering bus driver "
1198 "failed\n", __func__);
1199 goto exit_bus;
1200 }
1201
1202 usb_serial_tty_driver->owner = THIS_MODULE;
1203 usb_serial_tty_driver->driver_name = "usbserial";
1204 usb_serial_tty_driver->name = "ttyUSB";
1205 usb_serial_tty_driver->major = SERIAL_TTY_MAJOR;
1206 usb_serial_tty_driver->minor_start = 0;
1207 usb_serial_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1208 usb_serial_tty_driver->subtype = SERIAL_TYPE_NORMAL;
1209 usb_serial_tty_driver->flags = TTY_DRIVER_REAL_RAW |
1210 TTY_DRIVER_DYNAMIC_DEV;
1211 usb_serial_tty_driver->init_termios = tty_std_termios;
1212 usb_serial_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD
1213 | HUPCL | CLOCAL;
1214 usb_serial_tty_driver->init_termios.c_ispeed = 9600;
1215 usb_serial_tty_driver->init_termios.c_ospeed = 9600;
1216 tty_set_operations(usb_serial_tty_driver, &serial_ops);
1217 result = tty_register_driver(usb_serial_tty_driver);
1218 if (result) {
1219 printk(KERN_ERR "usb-serial: %s - tty_register_driver failed\n",
1220 __func__);
1221 goto exit_reg_driver;
1222 }
1223
1224 /* register the USB driver */
1225 result = usb_register(&usb_serial_driver);
1226 if (result < 0) {
1227 printk(KERN_ERR "usb-serial: %s - usb_register failed\n",
1228 __func__);
1229 goto exit_tty;
1230 }
1231
1232 /* register the generic driver, if we should */
1233 result = usb_serial_generic_register(debug);
1234 if (result < 0) {
1235 printk(KERN_ERR "usb-serial: %s - registering generic "
1236 "driver failed\n", __func__);
1237 goto exit_generic;
1238 }
1239
1240 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1241
1242 return result;
1243
1244 exit_generic:
1245 usb_deregister(&usb_serial_driver);
1246
1247 exit_tty:
1248 tty_unregister_driver(usb_serial_tty_driver);
1249
1250 exit_reg_driver:
1251 bus_unregister(&usb_serial_bus_type);
1252
1253 exit_bus:
1254 printk(KERN_ERR "usb-serial: %s - returning with error %d\n",
1255 __func__, result);
1256 put_tty_driver(usb_serial_tty_driver);
1257 return result;
1258 }
1259
1260
1261 static void __exit usb_serial_exit(void)
1262 {
1263 usb_serial_console_exit();
1264
1265 usb_serial_generic_deregister();
1266
1267 usb_deregister(&usb_serial_driver);
1268 tty_unregister_driver(usb_serial_tty_driver);
1269 put_tty_driver(usb_serial_tty_driver);
1270 bus_unregister(&usb_serial_bus_type);
1271 }
1272
1273
1274 module_init(usb_serial_init);
1275 module_exit(usb_serial_exit);
1276
1277 #define set_to_generic_if_null(type, function) \
1278 do { \
1279 if (!type->function) { \
1280 type->function = usb_serial_generic_##function; \
1281 dbg("Had to override the " #function \
1282 " usb serial operation with the generic one.");\
1283 } \
1284 } while (0)
1285
1286 static void fixup_generic(struct usb_serial_driver *device)
1287 {
1288 set_to_generic_if_null(device, open);
1289 set_to_generic_if_null(device, write);
1290 set_to_generic_if_null(device, close);
1291 set_to_generic_if_null(device, write_room);
1292 set_to_generic_if_null(device, chars_in_buffer);
1293 set_to_generic_if_null(device, read_bulk_callback);
1294 set_to_generic_if_null(device, write_bulk_callback);
1295 set_to_generic_if_null(device, disconnect);
1296 set_to_generic_if_null(device, release);
1297 }
1298
1299 int usb_serial_register(struct usb_serial_driver *driver)
1300 {
1301 /* must be called with BKL held */
1302 int retval;
1303
1304 if (usb_disabled())
1305 return -ENODEV;
1306
1307 fixup_generic(driver);
1308
1309 if (!driver->description)
1310 driver->description = driver->driver.name;
1311
1312 /* Add this device to our list of devices */
1313 list_add(&driver->driver_list, &usb_serial_driver_list);
1314
1315 retval = usb_serial_bus_register(driver);
1316 if (retval) {
1317 printk(KERN_ERR "usb-serial: problem %d when registering "
1318 "driver %s\n", retval, driver->description);
1319 list_del(&driver->driver_list);
1320 } else
1321 printk(KERN_INFO "USB Serial support registered for %s\n",
1322 driver->description);
1323
1324 return retval;
1325 }
1326 EXPORT_SYMBOL_GPL(usb_serial_register);
1327
1328
1329 void usb_serial_deregister(struct usb_serial_driver *device)
1330 {
1331 /* must be called with BKL held */
1332 printk(KERN_INFO "USB Serial deregistering driver %s\n",
1333 device->description);
1334 list_del(&device->driver_list);
1335 usb_serial_bus_deregister(device);
1336 }
1337 EXPORT_SYMBOL_GPL(usb_serial_deregister);
1338
1339 /* Module information */
1340 MODULE_AUTHOR(DRIVER_AUTHOR);
1341 MODULE_DESCRIPTION(DRIVER_DESC);
1342 MODULE_LICENSE("GPL");
1343
1344 module_param(debug, bool, S_IRUGO | S_IWUSR);
1345 MODULE_PARM_DESC(debug, "Debug enabled or not");
Linux with added FPC-III support