2 * Prolific PL2303 USB to serial adaptor driver
4 * Copyright (C) 2001-2007 Greg Kroah-Hartman (greg@kroah.com)
5 * Copyright (C) 2003 IBM Corp.
7 * Original driver for 2.2.x by anonymous
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License version
11 * 2 as published by the Free Software Foundation.
13 * See Documentation/usb/usb-serial.txt for more information on using this driver
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/init.h>
20 #include <linux/slab.h>
21 #include <linux/tty.h>
22 #include <linux/tty_driver.h>
23 #include <linux/tty_flip.h>
24 #include <linux/serial.h>
25 #include <linux/module.h>
26 #include <linux/moduleparam.h>
27 #include <linux/spinlock.h>
28 #include <asm/uaccess.h>
29 #include <linux/usb.h>
30 #include <linux/usb/serial.h>
36 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
40 #define PL2303_CLOSING_WAIT (30*HZ)
42 #define PL2303_BUF_SIZE 1024
43 #define PL2303_TMP_BUF_SIZE 1024
46 unsigned int buf_size;
52 static struct usb_device_id id_table [] = {
53 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
54 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
55 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_DCU11) },
56 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
57 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
58 { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
59 { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID_RSAQ5) },
60 { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
61 { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
62 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
63 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
64 { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
65 { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
66 { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
67 { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
68 { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
69 { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
70 { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
71 { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
72 { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
73 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_PRODUCT_ID) },
74 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1) },
75 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) },
76 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75) },
77 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_EF81) },
78 { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
79 { USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
80 { USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
81 { USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
82 { USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
83 { USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
84 { USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
85 { USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
86 { USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID) },
87 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_ID) },
88 { USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) },
89 { USB_DEVICE(COREGA_VENDOR_ID, COREGA_PRODUCT_ID) },
90 { } /* Terminating entry */
93 MODULE_DEVICE_TABLE(usb, id_table);
95 static struct usb_driver pl2303_driver = {
97 .probe = usb_serial_probe,
98 .disconnect = usb_serial_disconnect,
103 #define SET_LINE_REQUEST_TYPE 0x21
104 #define SET_LINE_REQUEST 0x20
106 #define SET_CONTROL_REQUEST_TYPE 0x21
107 #define SET_CONTROL_REQUEST 0x22
108 #define CONTROL_DTR 0x01
109 #define CONTROL_RTS 0x02
111 #define BREAK_REQUEST_TYPE 0x21
112 #define BREAK_REQUEST 0x23
113 #define BREAK_ON 0xffff
114 #define BREAK_OFF 0x0000
116 #define GET_LINE_REQUEST_TYPE 0xa1
117 #define GET_LINE_REQUEST 0x21
119 #define VENDOR_WRITE_REQUEST_TYPE 0x40
120 #define VENDOR_WRITE_REQUEST 0x01
122 #define VENDOR_READ_REQUEST_TYPE 0xc0
123 #define VENDOR_READ_REQUEST 0x01
125 #define UART_STATE 0x08
126 #define UART_STATE_TRANSIENT_MASK 0x74
127 #define UART_DCD 0x01
128 #define UART_DSR 0x02
129 #define UART_BREAK_ERROR 0x04
130 #define UART_RING 0x08
131 #define UART_FRAME_ERROR 0x10
132 #define UART_PARITY_ERROR 0x20
133 #define UART_OVERRUN_ERROR 0x40
134 #define UART_CTS 0x80
138 type_0, /* don't know the difference between type 0 and */
139 type_1, /* type 1, until someone from prolific tells us... */
140 HX, /* HX version of the pl2303 chip */
143 struct pl2303_private {
145 struct pl2303_buf *buf;
146 int write_urb_in_use;
147 wait_queue_head_t delta_msr_wait;
150 u8 termios_initialized;
151 enum pl2303_type type;
157 * Allocate a circular buffer and all associated memory.
159 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size)
161 struct pl2303_buf *pb;
166 pb = kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL);
170 pb->buf_buf = kmalloc(size, GFP_KERNEL);
171 if (pb->buf_buf == NULL) {
177 pb->buf_get = pb->buf_put = pb->buf_buf;
185 * Free the buffer and all associated memory.
187 static void pl2303_buf_free(struct pl2303_buf *pb)
198 * Clear out all data in the circular buffer.
200 static void pl2303_buf_clear(struct pl2303_buf *pb)
203 pb->buf_get = pb->buf_put;
204 /* equivalent to a get of all data available */
208 * pl2303_buf_data_avail
210 * Return the number of bytes of data available in the circular
213 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb)
218 return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size);
222 * pl2303_buf_space_avail
224 * Return the number of bytes of space available in the circular
227 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb)
232 return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size);
238 * Copy data data from a user buffer and put it into the circular buffer.
239 * Restrict to the amount of space available.
241 * Return the number of bytes copied.
243 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
251 len = pl2303_buf_space_avail(pb);
258 len = pb->buf_buf + pb->buf_size - pb->buf_put;
260 memcpy(pb->buf_put, buf, len);
261 memcpy(pb->buf_buf, buf+len, count - len);
262 pb->buf_put = pb->buf_buf + count - len;
264 memcpy(pb->buf_put, buf, count);
266 pb->buf_put += count;
267 else /* count == len */
268 pb->buf_put = pb->buf_buf;
277 * Get data from the circular buffer and copy to the given buffer.
278 * Restrict to the amount of data available.
280 * Return the number of bytes copied.
282 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
290 len = pl2303_buf_data_avail(pb);
297 len = pb->buf_buf + pb->buf_size - pb->buf_get;
299 memcpy(buf, pb->buf_get, len);
300 memcpy(buf+len, pb->buf_buf, count - len);
301 pb->buf_get = pb->buf_buf + count - len;
303 memcpy(buf, pb->buf_get, count);
305 pb->buf_get += count;
306 else /* count == len */
307 pb->buf_get = pb->buf_buf;
313 static int pl2303_startup(struct usb_serial *serial)
315 struct pl2303_private *priv;
316 enum pl2303_type type = type_0;
319 if (serial->dev->descriptor.bDeviceClass == 0x02)
321 else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
323 else if (serial->dev->descriptor.bDeviceClass == 0x00)
325 else if (serial->dev->descriptor.bDeviceClass == 0xFF)
327 dbg("device type: %d", type);
329 for (i = 0; i < serial->num_ports; ++i) {
330 priv = kzalloc(sizeof(struct pl2303_private), GFP_KERNEL);
333 spin_lock_init(&priv->lock);
334 priv->buf = pl2303_buf_alloc(PL2303_BUF_SIZE);
335 if (priv->buf == NULL) {
339 init_waitqueue_head(&priv->delta_msr_wait);
341 usb_set_serial_port_data(serial->port[i], priv);
346 for (--i; i>=0; --i) {
347 priv = usb_get_serial_port_data(serial->port[i]);
348 pl2303_buf_free(priv->buf);
350 usb_set_serial_port_data(serial->port[i], NULL);
355 static int set_control_lines(struct usb_device *dev, u8 value)
359 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
360 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
361 value, 0, NULL, 0, 100);
362 dbg("%s - value = %d, retval = %d", __FUNCTION__, value, retval);
366 static void pl2303_send(struct usb_serial_port *port)
369 struct pl2303_private *priv = usb_get_serial_port_data(port);
372 dbg("%s - port %d", __FUNCTION__, port->number);
374 spin_lock_irqsave(&priv->lock, flags);
376 if (priv->write_urb_in_use) {
377 spin_unlock_irqrestore(&priv->lock, flags);
381 count = pl2303_buf_get(priv->buf, port->write_urb->transfer_buffer,
382 port->bulk_out_size);
385 spin_unlock_irqrestore(&priv->lock, flags);
389 priv->write_urb_in_use = 1;
391 spin_unlock_irqrestore(&priv->lock, flags);
393 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count,
394 port->write_urb->transfer_buffer);
396 port->write_urb->transfer_buffer_length = count;
397 port->write_urb->dev = port->serial->dev;
398 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
400 dev_err(&port->dev, "%s - failed submitting write urb,"
401 " error %d\n", __FUNCTION__, result);
402 priv->write_urb_in_use = 0;
403 // TODO: reschedule pl2303_send
406 usb_serial_port_softint(port);
409 static int pl2303_write(struct usb_serial_port *port, const unsigned char *buf,
412 struct pl2303_private *priv = usb_get_serial_port_data(port);
415 dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count);
420 spin_lock_irqsave(&priv->lock, flags);
421 count = pl2303_buf_put(priv->buf, buf, count);
422 spin_unlock_irqrestore(&priv->lock, flags);
429 static int pl2303_write_room(struct usb_serial_port *port)
431 struct pl2303_private *priv = usb_get_serial_port_data(port);
435 dbg("%s - port %d", __FUNCTION__, port->number);
437 spin_lock_irqsave(&priv->lock, flags);
438 room = pl2303_buf_space_avail(priv->buf);
439 spin_unlock_irqrestore(&priv->lock, flags);
441 dbg("%s - returns %d", __FUNCTION__, room);
445 static int pl2303_chars_in_buffer(struct usb_serial_port *port)
447 struct pl2303_private *priv = usb_get_serial_port_data(port);
451 dbg("%s - port %d", __FUNCTION__, port->number);
453 spin_lock_irqsave(&priv->lock, flags);
454 chars = pl2303_buf_data_avail(priv->buf);
455 spin_unlock_irqrestore(&priv->lock, flags);
457 dbg("%s - returns %d", __FUNCTION__, chars);
461 static void pl2303_set_termios(struct usb_serial_port *port,
462 struct ktermios *old_termios)
464 struct usb_serial *serial = port->serial;
465 struct pl2303_private *priv = usb_get_serial_port_data(port);
473 dbg("%s - port %d", __FUNCTION__, port->number);
475 spin_lock_irqsave(&priv->lock, flags);
476 if (!priv->termios_initialized) {
477 *(port->tty->termios) = tty_std_termios;
478 port->tty->termios->c_cflag = B9600 | CS8 | CREAD |
480 port->tty->termios->c_ispeed = 9600;
481 port->tty->termios->c_ospeed = 9600;
482 priv->termios_initialized = 1;
484 spin_unlock_irqrestore(&priv->lock, flags);
486 cflag = port->tty->termios->c_cflag;
488 buf = kzalloc(7, GFP_KERNEL);
490 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
494 i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
495 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
497 dbg("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
498 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
501 switch (cflag & CSIZE) {
502 case CS5: buf[6] = 5; break;
503 case CS6: buf[6] = 6; break;
504 case CS7: buf[6] = 7; break;
506 case CS8: buf[6] = 8; break;
508 dbg("%s - data bits = %d", __FUNCTION__, buf[6]);
511 baud = tty_get_baud_rate(port->tty);;
512 dbg("%s - baud = %d", __FUNCTION__, baud);
514 buf[0] = baud & 0xff;
515 buf[1] = (baud >> 8) & 0xff;
516 buf[2] = (baud >> 16) & 0xff;
517 buf[3] = (baud >> 24) & 0xff;
520 /* For reference buf[4]=0 is 1 stop bits */
521 /* For reference buf[4]=1 is 1.5 stop bits */
522 /* For reference buf[4]=2 is 2 stop bits */
523 if (cflag & CSTOPB) {
525 dbg("%s - stop bits = 2", __FUNCTION__);
528 dbg("%s - stop bits = 1", __FUNCTION__);
531 if (cflag & PARENB) {
532 /* For reference buf[5]=0 is none parity */
533 /* For reference buf[5]=1 is odd parity */
534 /* For reference buf[5]=2 is even parity */
535 /* For reference buf[5]=3 is mark parity */
536 /* For reference buf[5]=4 is space parity */
537 if (cflag & PARODD) {
539 dbg("%s - parity = odd", __FUNCTION__);
542 dbg("%s - parity = even", __FUNCTION__);
546 dbg("%s - parity = none", __FUNCTION__);
549 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
550 SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
552 dbg("0x21:0x20:0:0 %d", i);
554 /* change control lines if we are switching to or from B0 */
555 spin_lock_irqsave(&priv->lock, flags);
556 control = priv->line_control;
557 if ((cflag & CBAUD) == B0)
558 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
560 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
561 if (control != priv->line_control) {
562 control = priv->line_control;
563 spin_unlock_irqrestore(&priv->lock, flags);
564 set_control_lines(serial->dev, control);
566 spin_unlock_irqrestore(&priv->lock, flags);
569 buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;
571 i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
572 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
574 dbg("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
575 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
577 if (cflag & CRTSCTS) {
579 if (priv->type == HX)
583 i = usb_control_msg(serial->dev,
584 usb_sndctrlpipe(serial->dev, 0),
585 VENDOR_WRITE_REQUEST,
586 VENDOR_WRITE_REQUEST_TYPE,
587 0x0, index, NULL, 0, 100);
588 dbg("0x40:0x1:0x0:0x%x %d", index, i);
590 i = usb_control_msg(serial->dev,
591 usb_sndctrlpipe(serial->dev, 0),
592 VENDOR_WRITE_REQUEST,
593 VENDOR_WRITE_REQUEST_TYPE,
594 0x0, 0x0, NULL, 0, 100);
595 dbg ("0x40:0x1:0x0:0x0 %d", i);
598 /* FIXME: Need to read back resulting baud rate */
600 tty_encode_baud_rate(port->tty, baud, baud);
605 static void pl2303_close(struct usb_serial_port *port, struct file *filp)
607 struct pl2303_private *priv = usb_get_serial_port_data(port);
609 unsigned int c_cflag;
614 dbg("%s - port %d", __FUNCTION__, port->number);
616 /* wait for data to drain from the buffer */
617 spin_lock_irqsave(&priv->lock, flags);
618 timeout = PL2303_CLOSING_WAIT;
619 init_waitqueue_entry(&wait, current);
620 add_wait_queue(&port->tty->write_wait, &wait);
622 set_current_state(TASK_INTERRUPTIBLE);
623 if (pl2303_buf_data_avail(priv->buf) == 0 ||
624 timeout == 0 || signal_pending(current) ||
625 !usb_get_intfdata(port->serial->interface)) /* disconnect */
627 spin_unlock_irqrestore(&priv->lock, flags);
628 timeout = schedule_timeout(timeout);
629 spin_lock_irqsave(&priv->lock, flags);
631 set_current_state(TASK_RUNNING);
632 remove_wait_queue(&port->tty->write_wait, &wait);
633 /* clear out any remaining data in the buffer */
634 pl2303_buf_clear(priv->buf);
635 spin_unlock_irqrestore(&priv->lock, flags);
637 /* wait for characters to drain from the device */
638 /* (this is long enough for the entire 256 byte */
639 /* pl2303 hardware buffer to drain with no flow */
640 /* control for data rates of 1200 bps or more, */
641 /* for lower rates we should really know how much */
642 /* data is in the buffer to compute a delay */
643 /* that is not unnecessarily long) */
644 bps = tty_get_baud_rate(port->tty);
646 timeout = max((HZ*2560)/bps,HZ/10);
649 schedule_timeout_interruptible(timeout);
651 /* shutdown our urbs */
652 dbg("%s - shutting down urbs", __FUNCTION__);
653 usb_kill_urb(port->write_urb);
654 usb_kill_urb(port->read_urb);
655 usb_kill_urb(port->interrupt_in_urb);
658 c_cflag = port->tty->termios->c_cflag;
659 if (c_cflag & HUPCL) {
660 /* drop DTR and RTS */
661 spin_lock_irqsave(&priv->lock, flags);
662 priv->line_control = 0;
663 spin_unlock_irqrestore(&priv->lock, flags);
664 set_control_lines(port->serial->dev, 0);
669 static int pl2303_open(struct usb_serial_port *port, struct file *filp)
671 struct ktermios tmp_termios;
672 struct usb_serial *serial = port->serial;
673 struct pl2303_private *priv = usb_get_serial_port_data(port);
677 dbg("%s - port %d", __FUNCTION__, port->number);
679 if (priv->type != HX) {
680 usb_clear_halt(serial->dev, port->write_urb->pipe);
681 usb_clear_halt(serial->dev, port->read_urb->pipe);
684 buf = kmalloc(10, GFP_KERNEL);
688 #define FISH(a,b,c,d) \
689 result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0), \
690 b, a, c, d, buf, 1, 100); \
691 dbg("0x%x:0x%x:0x%x:0x%x %d - %x",a,b,c,d,result,buf[0]);
693 #define SOUP(a,b,c,d) \
694 result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0), \
695 b, a, c, d, NULL, 0, 100); \
696 dbg("0x%x:0x%x:0x%x:0x%x %d",a,b,c,d,result);
698 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
699 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 0);
700 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
701 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
702 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
703 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 1);
704 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
705 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
706 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0, 1);
707 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 1, 0);
709 if (priv->type == HX) {
711 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x44);
712 /* reset upstream data pipes */
713 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 8, 0);
714 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 9, 0);
716 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x24);
723 pl2303_set_termios(port, &tmp_termios);
726 //FIXME: need to assert RTS and DTR if CRTSCTS off
728 dbg("%s - submitting read urb", __FUNCTION__);
729 port->read_urb->dev = serial->dev;
730 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
732 dev_err(&port->dev, "%s - failed submitting read urb,"
733 " error %d\n", __FUNCTION__, result);
734 pl2303_close(port, NULL);
738 dbg("%s - submitting interrupt urb", __FUNCTION__);
739 port->interrupt_in_urb->dev = serial->dev;
740 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
742 dev_err(&port->dev, "%s - failed submitting interrupt urb,"
743 " error %d\n", __FUNCTION__, result);
744 pl2303_close(port, NULL);
750 static int pl2303_tiocmset(struct usb_serial_port *port, struct file *file,
751 unsigned int set, unsigned int clear)
753 struct pl2303_private *priv = usb_get_serial_port_data(port);
757 if (!usb_get_intfdata(port->serial->interface))
760 spin_lock_irqsave(&priv->lock, flags);
762 priv->line_control |= CONTROL_RTS;
764 priv->line_control |= CONTROL_DTR;
765 if (clear & TIOCM_RTS)
766 priv->line_control &= ~CONTROL_RTS;
767 if (clear & TIOCM_DTR)
768 priv->line_control &= ~CONTROL_DTR;
769 control = priv->line_control;
770 spin_unlock_irqrestore(&priv->lock, flags);
772 return set_control_lines(port->serial->dev, control);
775 static int pl2303_tiocmget(struct usb_serial_port *port, struct file *file)
777 struct pl2303_private *priv = usb_get_serial_port_data(port);
783 dbg("%s (%d)", __FUNCTION__, port->number);
785 if (!usb_get_intfdata(port->serial->interface))
788 spin_lock_irqsave(&priv->lock, flags);
789 mcr = priv->line_control;
790 status = priv->line_status;
791 spin_unlock_irqrestore(&priv->lock, flags);
793 result = ((mcr & CONTROL_DTR) ? TIOCM_DTR : 0)
794 | ((mcr & CONTROL_RTS) ? TIOCM_RTS : 0)
795 | ((status & UART_CTS) ? TIOCM_CTS : 0)
796 | ((status & UART_DSR) ? TIOCM_DSR : 0)
797 | ((status & UART_RING) ? TIOCM_RI : 0)
798 | ((status & UART_DCD) ? TIOCM_CD : 0);
800 dbg("%s - result = %x", __FUNCTION__, result);
805 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
807 struct pl2303_private *priv = usb_get_serial_port_data(port);
809 unsigned int prevstatus;
811 unsigned int changed;
813 spin_lock_irqsave(&priv->lock, flags);
814 prevstatus = priv->line_status;
815 spin_unlock_irqrestore(&priv->lock, flags);
818 interruptible_sleep_on(&priv->delta_msr_wait);
819 /* see if a signal did it */
820 if (signal_pending(current))
823 spin_lock_irqsave(&priv->lock, flags);
824 status = priv->line_status;
825 spin_unlock_irqrestore(&priv->lock, flags);
827 changed=prevstatus^status;
829 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
830 ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
831 ((arg & TIOCM_CD) && (changed & UART_DCD)) ||
832 ((arg & TIOCM_CTS) && (changed & UART_CTS)) ) {
841 static int pl2303_ioctl(struct usb_serial_port *port, struct file *file,
842 unsigned int cmd, unsigned long arg)
844 dbg("%s (%d) cmd = 0x%04x", __FUNCTION__, port->number, cmd);
848 dbg("%s (%d) TIOCMIWAIT", __FUNCTION__, port->number);
849 return wait_modem_info(port, arg);
852 dbg("%s not supported = 0x%04x", __FUNCTION__, cmd);
859 static void pl2303_break_ctl(struct usb_serial_port *port, int break_state)
861 struct usb_serial *serial = port->serial;
865 dbg("%s - port %d", __FUNCTION__, port->number);
867 if (break_state == 0)
871 dbg("%s - turning break %s", __FUNCTION__, state==BREAK_OFF ? "off" : "on");
873 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
874 BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
877 dbg("%s - error sending break = %d", __FUNCTION__, result);
880 static void pl2303_shutdown(struct usb_serial *serial)
883 struct pl2303_private *priv;
885 dbg("%s", __FUNCTION__);
887 for (i = 0; i < serial->num_ports; ++i) {
888 priv = usb_get_serial_port_data(serial->port[i]);
890 pl2303_buf_free(priv->buf);
892 usb_set_serial_port_data(serial->port[i], NULL);
897 static void pl2303_update_line_status(struct usb_serial_port *port,
899 unsigned int actual_length)
902 struct pl2303_private *priv = usb_get_serial_port_data(port);
904 u8 status_idx = UART_STATE;
905 u8 length = UART_STATE + 1;
908 idv = le16_to_cpu(port->serial->dev->descriptor.idVendor);
909 idp = le16_to_cpu(port->serial->dev->descriptor.idProduct);
912 if (idv == SIEMENS_VENDOR_ID) {
913 if (idp == SIEMENS_PRODUCT_ID_X65 ||
914 idp == SIEMENS_PRODUCT_ID_SX1 ||
915 idp == SIEMENS_PRODUCT_ID_X75) {
922 if (actual_length < length)
925 /* Save off the uart status for others to look at */
926 spin_lock_irqsave(&priv->lock, flags);
927 priv->line_status = data[status_idx];
928 spin_unlock_irqrestore(&priv->lock, flags);
929 wake_up_interruptible(&priv->delta_msr_wait);
932 static void pl2303_read_int_callback(struct urb *urb)
934 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
935 unsigned char *data = urb->transfer_buffer;
936 unsigned int actual_length = urb->actual_length;
937 int status = urb->status;
940 dbg("%s (%d)", __FUNCTION__, port->number);
949 /* this urb is terminated, clean up */
950 dbg("%s - urb shutting down with status: %d", __FUNCTION__,
954 dbg("%s - nonzero urb status received: %d", __FUNCTION__,
959 usb_serial_debug_data(debug, &port->dev, __FUNCTION__,
960 urb->actual_length, urb->transfer_buffer);
962 pl2303_update_line_status(port, data, actual_length);
965 retval = usb_submit_urb(urb, GFP_ATOMIC);
967 dev_err(&urb->dev->dev,
968 "%s - usb_submit_urb failed with result %d\n",
969 __FUNCTION__, retval);
972 static void pl2303_read_bulk_callback(struct urb *urb)
974 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
975 struct pl2303_private *priv = usb_get_serial_port_data(port);
976 struct tty_struct *tty;
977 unsigned char *data = urb->transfer_buffer;
981 int status = urb->status;
985 dbg("%s - port %d", __FUNCTION__, port->number);
988 dbg("%s - urb status = %d", __FUNCTION__, status);
989 if (!port->open_count) {
990 dbg("%s - port is closed, exiting.", __FUNCTION__);
993 if (status == -EPROTO) {
994 /* PL2303 mysteriously fails with -EPROTO reschedule
996 dbg("%s - caught -EPROTO, resubmitting the urb",
998 urb->dev = port->serial->dev;
999 result = usb_submit_urb(urb, GFP_ATOMIC);
1001 dev_err(&urb->dev->dev, "%s - failed"
1002 " resubmitting read urb, error %d\n",
1003 __FUNCTION__, result);
1006 dbg("%s - unable to handle the error, exiting.", __FUNCTION__);
1010 usb_serial_debug_data(debug, &port->dev, __FUNCTION__,
1011 urb->actual_length, data);
1013 /* get tty_flag from status */
1014 tty_flag = TTY_NORMAL;
1016 spin_lock_irqsave(&priv->lock, flags);
1017 line_status = priv->line_status;
1018 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
1019 spin_unlock_irqrestore(&priv->lock, flags);
1020 wake_up_interruptible(&priv->delta_msr_wait);
1022 /* break takes precedence over parity, */
1023 /* which takes precedence over framing errors */
1024 if (line_status & UART_BREAK_ERROR )
1025 tty_flag = TTY_BREAK;
1026 else if (line_status & UART_PARITY_ERROR)
1027 tty_flag = TTY_PARITY;
1028 else if (line_status & UART_FRAME_ERROR)
1029 tty_flag = TTY_FRAME;
1030 dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag);
1033 if (tty && urb->actual_length) {
1034 tty_buffer_request_room(tty, urb->actual_length + 1);
1035 /* overrun is special, not associated with a char */
1036 if (line_status & UART_OVERRUN_ERROR)
1037 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
1038 for (i = 0; i < urb->actual_length; ++i)
1039 tty_insert_flip_char(tty, data[i], tty_flag);
1040 tty_flip_buffer_push(tty);
1043 /* Schedule the next read _if_ we are still open */
1044 if (port->open_count) {
1045 urb->dev = port->serial->dev;
1046 result = usb_submit_urb(urb, GFP_ATOMIC);
1048 dev_err(&urb->dev->dev, "%s - failed resubmitting"
1049 " read urb, error %d\n", __FUNCTION__, result);
1055 static void pl2303_write_bulk_callback(struct urb *urb)
1057 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
1058 struct pl2303_private *priv = usb_get_serial_port_data(port);
1060 int status = urb->status;
1062 dbg("%s - port %d", __FUNCTION__, port->number);
1071 /* this urb is terminated, clean up */
1072 dbg("%s - urb shutting down with status: %d", __FUNCTION__,
1074 priv->write_urb_in_use = 0;
1077 /* error in the urb, so we have to resubmit it */
1078 dbg("%s - Overflow in write", __FUNCTION__);
1079 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__,
1081 port->write_urb->transfer_buffer_length = 1;
1082 port->write_urb->dev = port->serial->dev;
1083 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1085 dev_err(&urb->dev->dev, "%s - failed resubmitting write"
1086 " urb, error %d\n", __FUNCTION__, result);
1091 priv->write_urb_in_use = 0;
1093 /* send any buffered data */
1097 /* All of the device info needed for the PL2303 SIO serial converter */
1098 static struct usb_serial_driver pl2303_device = {
1100 .owner = THIS_MODULE,
1103 .id_table = id_table,
1104 .usb_driver = &pl2303_driver,
1105 .num_interrupt_in = NUM_DONT_CARE,
1109 .open = pl2303_open,
1110 .close = pl2303_close,
1111 .write = pl2303_write,
1112 .ioctl = pl2303_ioctl,
1113 .break_ctl = pl2303_break_ctl,
1114 .set_termios = pl2303_set_termios,
1115 .tiocmget = pl2303_tiocmget,
1116 .tiocmset = pl2303_tiocmset,
1117 .read_bulk_callback = pl2303_read_bulk_callback,
1118 .read_int_callback = pl2303_read_int_callback,
1119 .write_bulk_callback = pl2303_write_bulk_callback,
1120 .write_room = pl2303_write_room,
1121 .chars_in_buffer = pl2303_chars_in_buffer,
1122 .attach = pl2303_startup,
1123 .shutdown = pl2303_shutdown,
1126 static int __init pl2303_init(void)
1130 retval = usb_serial_register(&pl2303_device);
1132 goto failed_usb_serial_register;
1133 retval = usb_register(&pl2303_driver);
1135 goto failed_usb_register;
1138 failed_usb_register:
1139 usb_serial_deregister(&pl2303_device);
1140 failed_usb_serial_register:
1144 static void __exit pl2303_exit(void)
1146 usb_deregister(&pl2303_driver);
1147 usb_serial_deregister(&pl2303_device);
1150 module_init(pl2303_init);
1151 module_exit(pl2303_exit);
1153 MODULE_DESCRIPTION(DRIVER_DESC);
1154 MODULE_LICENSE("GPL");
1156 module_param(debug, bool, S_IRUGO | S_IWUSR);
1157 MODULE_PARM_DESC(debug, "Debug enabled or not");