2 * Prolific PL2303 USB to serial adaptor driver
4 * Copyright (C) 2001-2004 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 modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * See Documentation/usb/usb-serial.txt for more information on using this driver
17 * allowed driver to work properly if there is no tty assigned to a port
18 * (this happens for serial console devices.)
21 * Added RTS and DTR line control. Thanks to joe@bndlg.de for parts of it.
24 * Added break support.
27 * fixed oops in write_bulk_callback.
30 * reworked buffer logic to be like other usb-serial drivers. Hopefully
31 * removing some reported problems.
34 * finished porting to 2.4 format.
38 #include <linux/config.h>
39 #include <linux/kernel.h>
40 #include <linux/errno.h>
41 #include <linux/init.h>
42 #include <linux/slab.h>
43 #include <linux/tty.h>
44 #include <linux/tty_driver.h>
45 #include <linux/tty_flip.h>
46 #include <linux/serial.h>
47 #include <linux/module.h>
48 #include <linux/moduleparam.h>
49 #include <linux/spinlock.h>
50 #include <asm/uaccess.h>
51 #include <linux/usb.h>
52 #include "usb-serial.h"
58 #define DRIVER_VERSION "v0.12"
59 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
63 #define PL2303_CLOSING_WAIT (30*HZ)
65 #define PL2303_BUF_SIZE 1024
66 #define PL2303_TMP_BUF_SIZE 1024
68 static DECLARE_MUTEX(pl2303_tmp_buf_sem);
71 unsigned int buf_size;
77 static struct usb_device_id id_table [] = {
78 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
79 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
80 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
81 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
82 { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
83 { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
84 { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
85 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
86 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
87 { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
88 { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
89 { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
90 { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
91 { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
92 { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
93 { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
94 { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
95 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_PRODUCT_ID) },
96 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) },
97 { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
98 { USB_DEVICE( NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID ) },
99 { } /* Terminating entry */
102 MODULE_DEVICE_TABLE (usb, id_table);
104 static struct usb_driver pl2303_driver = {
105 .owner = THIS_MODULE,
107 .probe = usb_serial_probe,
108 .disconnect = usb_serial_disconnect,
109 .id_table = id_table,
112 #define SET_LINE_REQUEST_TYPE 0x21
113 #define SET_LINE_REQUEST 0x20
115 #define SET_CONTROL_REQUEST_TYPE 0x21
116 #define SET_CONTROL_REQUEST 0x22
117 #define CONTROL_DTR 0x01
118 #define CONTROL_RTS 0x02
120 #define BREAK_REQUEST_TYPE 0x21
121 #define BREAK_REQUEST 0x23
122 #define BREAK_ON 0xffff
123 #define BREAK_OFF 0x0000
125 #define GET_LINE_REQUEST_TYPE 0xa1
126 #define GET_LINE_REQUEST 0x21
128 #define VENDOR_WRITE_REQUEST_TYPE 0x40
129 #define VENDOR_WRITE_REQUEST 0x01
131 #define VENDOR_READ_REQUEST_TYPE 0xc0
132 #define VENDOR_READ_REQUEST 0x01
134 #define UART_STATE 0x08
135 #define UART_STATE_TRANSIENT_MASK 0x74
136 #define UART_DCD 0x01
137 #define UART_DSR 0x02
138 #define UART_BREAK_ERROR 0x04
139 #define UART_RING 0x08
140 #define UART_FRAME_ERROR 0x10
141 #define UART_PARITY_ERROR 0x20
142 #define UART_OVERRUN_ERROR 0x40
143 #define UART_CTS 0x80
145 /* function prototypes for a PL2303 serial converter */
146 static int pl2303_open (struct usb_serial_port *port, struct file *filp);
147 static void pl2303_close (struct usb_serial_port *port, struct file *filp);
148 static void pl2303_set_termios (struct usb_serial_port *port,
149 struct termios *old);
150 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file,
151 unsigned int cmd, unsigned long arg);
152 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs);
153 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
154 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
155 static int pl2303_write (struct usb_serial_port *port,
156 const unsigned char *buf, int count);
157 static void pl2303_send (struct usb_serial_port *port);
158 static int pl2303_write_room(struct usb_serial_port *port);
159 static int pl2303_chars_in_buffer(struct usb_serial_port *port);
160 static void pl2303_break_ctl(struct usb_serial_port *port,int break_state);
161 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file);
162 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
163 unsigned int set, unsigned int clear);
164 static int pl2303_startup (struct usb_serial *serial);
165 static void pl2303_shutdown (struct usb_serial *serial);
166 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size);
167 static void pl2303_buf_free(struct pl2303_buf *pb);
168 static void pl2303_buf_clear(struct pl2303_buf *pb);
169 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb);
170 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb);
171 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
173 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
177 /* All of the device info needed for the PL2303 SIO serial converter */
178 static struct usb_serial_device_type pl2303_device = {
179 .owner = THIS_MODULE,
181 .id_table = id_table,
182 .num_interrupt_in = NUM_DONT_CARE,
187 .close = pl2303_close,
188 .write = pl2303_write,
189 .ioctl = pl2303_ioctl,
190 .break_ctl = pl2303_break_ctl,
191 .set_termios = pl2303_set_termios,
192 .tiocmget = pl2303_tiocmget,
193 .tiocmset = pl2303_tiocmset,
194 .read_bulk_callback = pl2303_read_bulk_callback,
195 .read_int_callback = pl2303_read_int_callback,
196 .write_bulk_callback = pl2303_write_bulk_callback,
197 .write_room = pl2303_write_room,
198 .chars_in_buffer = pl2303_chars_in_buffer,
199 .attach = pl2303_startup,
200 .shutdown = pl2303_shutdown,
204 type_0, /* don't know the difference between type 0 and */
205 type_1, /* type 1, until someone from prolific tells us... */
206 HX, /* HX version of the pl2303 chip */
209 struct pl2303_private {
211 struct pl2303_buf *buf;
212 int write_urb_in_use;
213 wait_queue_head_t delta_msr_wait;
216 u8 termios_initialized;
217 enum pl2303_type type;
221 static int pl2303_startup (struct usb_serial *serial)
223 struct pl2303_private *priv;
224 enum pl2303_type type = type_0;
227 if (serial->dev->descriptor.bDeviceClass == 0x02)
229 else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
231 else if (serial->dev->descriptor.bDeviceClass == 0x00)
233 else if (serial->dev->descriptor.bDeviceClass == 0xFF)
235 dbg("device type: %d", type);
237 for (i = 0; i < serial->num_ports; ++i) {
238 priv = kmalloc (sizeof (struct pl2303_private), GFP_KERNEL);
241 memset (priv, 0x00, sizeof (struct pl2303_private));
242 spin_lock_init(&priv->lock);
243 priv->buf = pl2303_buf_alloc(PL2303_BUF_SIZE);
244 if (priv->buf == NULL) {
248 init_waitqueue_head(&priv->delta_msr_wait);
250 usb_set_serial_port_data(serial->port[i], priv);
255 for (--i; i>=0; --i) {
256 priv = usb_get_serial_port_data(serial->port[i]);
257 pl2303_buf_free(priv->buf);
259 usb_set_serial_port_data(serial->port[i], NULL);
264 static int set_control_lines (struct usb_device *dev, u8 value)
268 retval = usb_control_msg (dev, usb_sndctrlpipe (dev, 0),
269 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
270 value, 0, NULL, 0, 100);
271 dbg("%s - value = %d, retval = %d", __FUNCTION__, value, retval);
275 static int pl2303_write (struct usb_serial_port *port, const unsigned char *buf, int count)
277 struct pl2303_private *priv = usb_get_serial_port_data(port);
280 dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count);
285 spin_lock_irqsave(&priv->lock, flags);
286 count = pl2303_buf_put(priv->buf, buf, count);
287 spin_unlock_irqrestore(&priv->lock, flags);
294 static void pl2303_send(struct usb_serial_port *port)
297 struct pl2303_private *priv = usb_get_serial_port_data(port);
300 dbg("%s - port %d", __FUNCTION__, port->number);
302 spin_lock_irqsave(&priv->lock, flags);
304 if (priv->write_urb_in_use) {
305 spin_unlock_irqrestore(&priv->lock, flags);
309 count = pl2303_buf_get(priv->buf, port->write_urb->transfer_buffer,
310 port->bulk_out_size);
313 spin_unlock_irqrestore(&priv->lock, flags);
317 priv->write_urb_in_use = 1;
319 spin_unlock_irqrestore(&priv->lock, flags);
321 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, port->write_urb->transfer_buffer);
323 port->write_urb->transfer_buffer_length = count;
324 port->write_urb->dev = port->serial->dev;
325 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
327 dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
328 priv->write_urb_in_use = 0;
329 // TODO: reschedule pl2303_send
332 schedule_work(&port->work);
335 static int pl2303_write_room(struct usb_serial_port *port)
337 struct pl2303_private *priv = usb_get_serial_port_data(port);
341 dbg("%s - port %d", __FUNCTION__, port->number);
343 spin_lock_irqsave(&priv->lock, flags);
344 room = pl2303_buf_space_avail(priv->buf);
345 spin_unlock_irqrestore(&priv->lock, flags);
347 dbg("%s - returns %d", __FUNCTION__, room);
351 static int pl2303_chars_in_buffer(struct usb_serial_port *port)
353 struct pl2303_private *priv = usb_get_serial_port_data(port);
357 dbg("%s - port %d", __FUNCTION__, port->number);
359 spin_lock_irqsave(&priv->lock, flags);
360 chars = pl2303_buf_data_avail(priv->buf);
361 spin_unlock_irqrestore(&priv->lock, flags);
363 dbg("%s - returns %d", __FUNCTION__, chars);
367 static void pl2303_set_termios (struct usb_serial_port *port, struct termios *old_termios)
369 struct usb_serial *serial = port->serial;
370 struct pl2303_private *priv = usb_get_serial_port_data(port);
378 dbg("%s - port %d", __FUNCTION__, port->number);
380 if ((!port->tty) || (!port->tty->termios)) {
381 dbg("%s - no tty structures", __FUNCTION__);
385 spin_lock_irqsave(&priv->lock, flags);
386 if (!priv->termios_initialized) {
387 *(port->tty->termios) = tty_std_termios;
388 port->tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
389 priv->termios_initialized = 1;
391 spin_unlock_irqrestore(&priv->lock, flags);
393 cflag = port->tty->termios->c_cflag;
394 /* check that they really want us to change something */
396 if ((cflag == old_termios->c_cflag) &&
397 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
398 dbg("%s - nothing to change...", __FUNCTION__);
403 buf = kmalloc (7, GFP_KERNEL);
405 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
408 memset (buf, 0x00, 0x07);
410 i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
411 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
413 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
414 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
418 switch (cflag & CSIZE) {
419 case CS5: buf[6] = 5; break;
420 case CS6: buf[6] = 6; break;
421 case CS7: buf[6] = 7; break;
423 case CS8: buf[6] = 8; break;
425 dbg("%s - data bits = %d", __FUNCTION__, buf[6]);
429 switch (cflag & CBAUD) {
430 case B0: baud = 0; break;
431 case B75: baud = 75; break;
432 case B150: baud = 150; break;
433 case B300: baud = 300; break;
434 case B600: baud = 600; break;
435 case B1200: baud = 1200; break;
436 case B1800: baud = 1800; break;
437 case B2400: baud = 2400; break;
438 case B4800: baud = 4800; break;
439 case B9600: baud = 9600; break;
440 case B19200: baud = 19200; break;
441 case B38400: baud = 38400; break;
442 case B57600: baud = 57600; break;
443 case B115200: baud = 115200; break;
444 case B230400: baud = 230400; break;
445 case B460800: baud = 460800; break;
447 dev_err(&port->dev, "pl2303 driver does not support the baudrate requested (fix it)\n");
450 dbg("%s - baud = %d", __FUNCTION__, baud);
452 buf[0] = baud & 0xff;
453 buf[1] = (baud >> 8) & 0xff;
454 buf[2] = (baud >> 16) & 0xff;
455 buf[3] = (baud >> 24) & 0xff;
458 /* For reference buf[4]=0 is 1 stop bits */
459 /* For reference buf[4]=1 is 1.5 stop bits */
460 /* For reference buf[4]=2 is 2 stop bits */
461 if (cflag & CSTOPB) {
463 dbg("%s - stop bits = 2", __FUNCTION__);
466 dbg("%s - stop bits = 1", __FUNCTION__);
469 if (cflag & PARENB) {
470 /* For reference buf[5]=0 is none parity */
471 /* For reference buf[5]=1 is odd parity */
472 /* For reference buf[5]=2 is even parity */
473 /* For reference buf[5]=3 is mark parity */
474 /* For reference buf[5]=4 is space parity */
475 if (cflag & PARODD) {
477 dbg("%s - parity = odd", __FUNCTION__);
480 dbg("%s - parity = even", __FUNCTION__);
484 dbg("%s - parity = none", __FUNCTION__);
487 i = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
488 SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
490 dbg ("0x21:0x20:0:0 %d", i);
492 /* change control lines if we are switching to or from B0 */
493 spin_lock_irqsave(&priv->lock, flags);
494 control = priv->line_control;
495 if ((cflag & CBAUD) == B0)
496 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
498 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
499 if (control != priv->line_control) {
500 control = priv->line_control;
501 spin_unlock_irqrestore(&priv->lock, flags);
502 set_control_lines(serial->dev, control);
504 spin_unlock_irqrestore(&priv->lock, flags);
507 buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;
509 i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
510 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
512 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
513 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
515 if (cflag & CRTSCTS) {
517 if (priv->type == HX)
521 i = usb_control_msg(serial->dev,
522 usb_sndctrlpipe(serial->dev, 0),
523 VENDOR_WRITE_REQUEST,
524 VENDOR_WRITE_REQUEST_TYPE,
525 0x0, index, NULL, 0, 100);
526 dbg ("0x40:0x1:0x0:0x%x %d", index, i);
532 static int pl2303_open (struct usb_serial_port *port, struct file *filp)
534 struct termios tmp_termios;
535 struct usb_serial *serial = port->serial;
536 struct pl2303_private *priv = usb_get_serial_port_data(port);
540 dbg("%s - port %d", __FUNCTION__, port->number);
542 if (priv->type != HX) {
543 usb_clear_halt(serial->dev, port->write_urb->pipe);
544 usb_clear_halt(serial->dev, port->read_urb->pipe);
547 buf = kmalloc(10, GFP_KERNEL);
551 #define FISH(a,b,c,d) \
552 result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0), \
553 b, a, c, d, buf, 1, 100); \
554 dbg("0x%x:0x%x:0x%x:0x%x %d - %x",a,b,c,d,result,buf[0]);
556 #define SOUP(a,b,c,d) \
557 result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0), \
558 b, a, c, d, NULL, 0, 100); \
559 dbg("0x%x:0x%x:0x%x:0x%x %d",a,b,c,d,result);
561 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
562 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 0);
563 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
564 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
565 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
566 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 1);
567 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
568 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
569 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0, 1);
570 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 1, 0);
572 if (priv->type == HX) {
574 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x44);
575 /* reset upstream data pipes */
576 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 8, 0);
577 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 9, 0);
579 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x24);
586 pl2303_set_termios (port, &tmp_termios);
589 //FIXME: need to assert RTS and DTR if CRTSCTS off
591 dbg("%s - submitting read urb", __FUNCTION__);
592 port->read_urb->dev = serial->dev;
593 result = usb_submit_urb (port->read_urb, GFP_KERNEL);
595 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
596 pl2303_close (port, NULL);
600 dbg("%s - submitting interrupt urb", __FUNCTION__);
601 port->interrupt_in_urb->dev = serial->dev;
602 result = usb_submit_urb (port->interrupt_in_urb, GFP_KERNEL);
604 dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n", __FUNCTION__, result);
605 pl2303_close (port, NULL);
612 static void pl2303_close (struct usb_serial_port *port, struct file *filp)
614 struct pl2303_private *priv = usb_get_serial_port_data(port);
616 unsigned int c_cflag;
621 dbg("%s - port %d", __FUNCTION__, port->number);
623 /* wait for data to drain from the buffer */
624 spin_lock_irqsave(&priv->lock, flags);
625 timeout = PL2303_CLOSING_WAIT;
626 init_waitqueue_entry(&wait, current);
627 add_wait_queue(&port->tty->write_wait, &wait);
629 set_current_state(TASK_INTERRUPTIBLE);
630 if (pl2303_buf_data_avail(priv->buf) == 0
631 || timeout == 0 || signal_pending(current)
632 || !usb_get_intfdata(port->serial->interface)) /* disconnect */
634 spin_unlock_irqrestore(&priv->lock, flags);
635 timeout = schedule_timeout(timeout);
636 spin_lock_irqsave(&priv->lock, flags);
638 set_current_state(TASK_RUNNING);
639 remove_wait_queue(&port->tty->write_wait, &wait);
640 /* clear out any remaining data in the buffer */
641 pl2303_buf_clear(priv->buf);
642 spin_unlock_irqrestore(&priv->lock, flags);
644 /* wait for characters to drain from the device */
645 /* (this is long enough for the entire 256 byte */
646 /* pl2303 hardware buffer to drain with no flow */
647 /* control for data rates of 1200 bps or more, */
648 /* for lower rates we should really know how much */
649 /* data is in the buffer to compute a delay */
650 /* that is not unnecessarily long) */
651 bps = tty_get_baud_rate(port->tty);
653 timeout = max((HZ*2560)/bps,HZ/10);
656 schedule_timeout_interruptible(timeout);
658 /* shutdown our urbs */
659 dbg("%s - shutting down urbs", __FUNCTION__);
660 usb_kill_urb(port->write_urb);
661 usb_kill_urb(port->read_urb);
662 usb_kill_urb(port->interrupt_in_urb);
665 c_cflag = port->tty->termios->c_cflag;
666 if (c_cflag & HUPCL) {
667 /* drop DTR and RTS */
668 spin_lock_irqsave(&priv->lock, flags);
669 priv->line_control = 0;
670 spin_unlock_irqrestore (&priv->lock, flags);
671 set_control_lines (port->serial->dev, 0);
676 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
677 unsigned int set, unsigned int clear)
679 struct pl2303_private *priv = usb_get_serial_port_data(port);
683 if (!usb_get_intfdata(port->serial->interface))
686 spin_lock_irqsave (&priv->lock, flags);
688 priv->line_control |= CONTROL_RTS;
690 priv->line_control |= CONTROL_DTR;
691 if (clear & TIOCM_RTS)
692 priv->line_control &= ~CONTROL_RTS;
693 if (clear & TIOCM_DTR)
694 priv->line_control &= ~CONTROL_DTR;
695 control = priv->line_control;
696 spin_unlock_irqrestore (&priv->lock, flags);
698 return set_control_lines (port->serial->dev, control);
701 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file)
703 struct pl2303_private *priv = usb_get_serial_port_data(port);
709 dbg("%s (%d)", __FUNCTION__, port->number);
711 if (!usb_get_intfdata(port->serial->interface))
714 spin_lock_irqsave (&priv->lock, flags);
715 mcr = priv->line_control;
716 status = priv->line_status;
717 spin_unlock_irqrestore (&priv->lock, flags);
719 result = ((mcr & CONTROL_DTR) ? TIOCM_DTR : 0)
720 | ((mcr & CONTROL_RTS) ? TIOCM_RTS : 0)
721 | ((status & UART_CTS) ? TIOCM_CTS : 0)
722 | ((status & UART_DSR) ? TIOCM_DSR : 0)
723 | ((status & UART_RING) ? TIOCM_RI : 0)
724 | ((status & UART_DCD) ? TIOCM_CD : 0);
726 dbg("%s - result = %x", __FUNCTION__, result);
731 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
733 struct pl2303_private *priv = usb_get_serial_port_data(port);
735 unsigned int prevstatus;
737 unsigned int changed;
739 spin_lock_irqsave (&priv->lock, flags);
740 prevstatus = priv->line_status;
741 spin_unlock_irqrestore (&priv->lock, flags);
744 interruptible_sleep_on(&priv->delta_msr_wait);
745 /* see if a signal did it */
746 if (signal_pending(current))
749 spin_lock_irqsave (&priv->lock, flags);
750 status = priv->line_status;
751 spin_unlock_irqrestore (&priv->lock, flags);
753 changed=prevstatus^status;
755 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
756 ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
757 ((arg & TIOCM_CD) && (changed & UART_DCD)) ||
758 ((arg & TIOCM_CTS) && (changed & UART_CTS)) ) {
767 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file, unsigned int cmd, unsigned long arg)
769 dbg("%s (%d) cmd = 0x%04x", __FUNCTION__, port->number, cmd);
773 dbg("%s (%d) TIOCMIWAIT", __FUNCTION__, port->number);
774 return wait_modem_info(port, arg);
777 dbg("%s not supported = 0x%04x", __FUNCTION__, cmd);
784 static void pl2303_break_ctl (struct usb_serial_port *port, int break_state)
786 struct usb_serial *serial = port->serial;
790 dbg("%s - port %d", __FUNCTION__, port->number);
792 if (break_state == 0)
796 dbg("%s - turning break %s", __FUNCTION__, state==BREAK_OFF ? "off" : "on");
798 result = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
799 BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
802 dbg("%s - error sending break = %d", __FUNCTION__, result);
806 static void pl2303_shutdown (struct usb_serial *serial)
809 struct pl2303_private *priv;
811 dbg("%s", __FUNCTION__);
813 for (i = 0; i < serial->num_ports; ++i) {
814 priv = usb_get_serial_port_data(serial->port[i]);
816 pl2303_buf_free(priv->buf);
818 usb_set_serial_port_data(serial->port[i], NULL);
823 static void pl2303_update_line_status(struct usb_serial_port *port,
825 unsigned int actual_length)
828 struct pl2303_private *priv = usb_get_serial_port_data(port);
830 u8 status_idx = UART_STATE;
831 u8 length = UART_STATE;
833 if ((le16_to_cpu(port->serial->dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
834 (le16_to_cpu(port->serial->dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_X65)) {
839 if (actual_length < length)
842 /* Save off the uart status for others to look at */
843 spin_lock_irqsave(&priv->lock, flags);
844 priv->line_status = data[status_idx];
845 spin_unlock_irqrestore(&priv->lock, flags);
851 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs)
853 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
854 unsigned char *data = urb->transfer_buffer;
855 unsigned int actual_length = urb->actual_length;
858 dbg("%s (%d)", __FUNCTION__, port->number);
860 switch (urb->status) {
867 /* this urb is terminated, clean up */
868 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
871 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
875 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
876 pl2303_update_line_status(port, data, actual_length);
879 status = usb_submit_urb (urb, GFP_ATOMIC);
881 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed with result %d\n",
882 __FUNCTION__, status);
886 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
888 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
889 struct pl2303_private *priv = usb_get_serial_port_data(port);
890 struct tty_struct *tty;
891 unsigned char *data = urb->transfer_buffer;
898 dbg("%s - port %d", __FUNCTION__, port->number);
901 dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
902 if (!port->open_count) {
903 dbg("%s - port is closed, exiting.", __FUNCTION__);
906 if (urb->status == -EPROTO) {
907 /* PL2303 mysteriously fails with -EPROTO reschedule the read */
908 dbg("%s - caught -EPROTO, resubmitting the urb", __FUNCTION__);
910 urb->dev = port->serial->dev;
911 result = usb_submit_urb(urb, GFP_ATOMIC);
913 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
916 dbg("%s - unable to handle the error, exiting.", __FUNCTION__);
920 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
922 /* get tty_flag from status */
923 tty_flag = TTY_NORMAL;
925 spin_lock_irqsave(&priv->lock, flags);
926 status = priv->line_status;
927 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
928 spin_unlock_irqrestore(&priv->lock, flags);
929 wake_up_interruptible (&priv->delta_msr_wait);
931 /* break takes precedence over parity, */
932 /* which takes precedence over framing errors */
933 if (status & UART_BREAK_ERROR )
934 tty_flag = TTY_BREAK;
935 else if (status & UART_PARITY_ERROR)
936 tty_flag = TTY_PARITY;
937 else if (status & UART_FRAME_ERROR)
938 tty_flag = TTY_FRAME;
939 dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag);
942 if (tty && urb->actual_length) {
943 /* overrun is special, not associated with a char */
944 if (status & UART_OVERRUN_ERROR)
945 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
947 for (i = 0; i < urb->actual_length; ++i) {
948 if (tty->flip.count >= TTY_FLIPBUF_SIZE) {
949 tty_flip_buffer_push(tty);
951 tty_insert_flip_char (tty, data[i], tty_flag);
953 tty_flip_buffer_push (tty);
956 /* Schedule the next read _if_ we are still open */
957 if (port->open_count) {
958 urb->dev = port->serial->dev;
959 result = usb_submit_urb(urb, GFP_ATOMIC);
961 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
969 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
971 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
972 struct pl2303_private *priv = usb_get_serial_port_data(port);
975 dbg("%s - port %d", __FUNCTION__, port->number);
977 switch (urb->status) {
984 /* this urb is terminated, clean up */
985 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
986 priv->write_urb_in_use = 0;
989 /* error in the urb, so we have to resubmit it */
990 dbg("%s - Overflow in write", __FUNCTION__);
991 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
992 port->write_urb->transfer_buffer_length = 1;
993 port->write_urb->dev = port->serial->dev;
994 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
996 dev_err(&urb->dev->dev, "%s - failed resubmitting write urb, error %d\n", __FUNCTION__, result);
1001 priv->write_urb_in_use = 0;
1003 /* send any buffered data */
1011 * Allocate a circular buffer and all associated memory.
1014 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size)
1017 struct pl2303_buf *pb;
1023 pb = (struct pl2303_buf *)kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL);
1027 pb->buf_buf = kmalloc(size, GFP_KERNEL);
1028 if (pb->buf_buf == NULL) {
1033 pb->buf_size = size;
1034 pb->buf_get = pb->buf_put = pb->buf_buf;
1044 * Free the buffer and all associated memory.
1047 static void pl2303_buf_free(struct pl2303_buf *pb)
1059 * Clear out all data in the circular buffer.
1062 static void pl2303_buf_clear(struct pl2303_buf *pb)
1065 pb->buf_get = pb->buf_put;
1066 /* equivalent to a get of all data available */
1071 * pl2303_buf_data_avail
1073 * Return the number of bytes of data available in the circular
1077 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb)
1080 return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size);
1087 * pl2303_buf_space_avail
1089 * Return the number of bytes of space available in the circular
1093 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb)
1096 return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size);
1105 * Copy data data from a user buffer and put it into the circular buffer.
1106 * Restrict to the amount of space available.
1108 * Return the number of bytes copied.
1111 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
1121 len = pl2303_buf_space_avail(pb);
1128 len = pb->buf_buf + pb->buf_size - pb->buf_put;
1130 memcpy(pb->buf_put, buf, len);
1131 memcpy(pb->buf_buf, buf+len, count - len);
1132 pb->buf_put = pb->buf_buf + count - len;
1134 memcpy(pb->buf_put, buf, count);
1136 pb->buf_put += count;
1137 else /* count == len */
1138 pb->buf_put = pb->buf_buf;
1149 * Get data from the circular buffer and copy to the given buffer.
1150 * Restrict to the amount of data available.
1152 * Return the number of bytes copied.
1155 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
1165 len = pl2303_buf_data_avail(pb);
1172 len = pb->buf_buf + pb->buf_size - pb->buf_get;
1174 memcpy(buf, pb->buf_get, len);
1175 memcpy(buf+len, pb->buf_buf, count - len);
1176 pb->buf_get = pb->buf_buf + count - len;
1178 memcpy(buf, pb->buf_get, count);
1180 pb->buf_get += count;
1181 else /* count == len */
1182 pb->buf_get = pb->buf_buf;
1189 static int __init pl2303_init (void)
1192 retval = usb_serial_register(&pl2303_device);
1194 goto failed_usb_serial_register;
1195 retval = usb_register(&pl2303_driver);
1197 goto failed_usb_register;
1198 info(DRIVER_DESC " " DRIVER_VERSION);
1200 failed_usb_register:
1201 usb_serial_deregister(&pl2303_device);
1202 failed_usb_serial_register:
1207 static void __exit pl2303_exit (void)
1209 usb_deregister (&pl2303_driver);
1210 usb_serial_deregister (&pl2303_device);
1214 module_init(pl2303_init);
1215 module_exit(pl2303_exit);
1217 MODULE_DESCRIPTION(DRIVER_DESC);
1218 MODULE_VERSION(DRIVER_VERSION);
1219 MODULE_LICENSE("GPL");
1221 module_param(debug, bool, S_IRUGO | S_IWUSR);
1222 MODULE_PARM_DESC(debug, "Debug enabled or not");