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