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 { } /* Terminating entry */
101 MODULE_DEVICE_TABLE (usb, id_table);
103 static struct usb_driver pl2303_driver = {
104 .owner = THIS_MODULE,
106 .probe = usb_serial_probe,
107 .disconnect = usb_serial_disconnect,
108 .id_table = id_table,
111 #define SET_LINE_REQUEST_TYPE 0x21
112 #define SET_LINE_REQUEST 0x20
114 #define SET_CONTROL_REQUEST_TYPE 0x21
115 #define SET_CONTROL_REQUEST 0x22
116 #define CONTROL_DTR 0x01
117 #define CONTROL_RTS 0x02
119 #define BREAK_REQUEST_TYPE 0x21
120 #define BREAK_REQUEST 0x23
121 #define BREAK_ON 0xffff
122 #define BREAK_OFF 0x0000
124 #define GET_LINE_REQUEST_TYPE 0xa1
125 #define GET_LINE_REQUEST 0x21
127 #define VENDOR_WRITE_REQUEST_TYPE 0x40
128 #define VENDOR_WRITE_REQUEST 0x01
130 #define VENDOR_READ_REQUEST_TYPE 0xc0
131 #define VENDOR_READ_REQUEST 0x01
133 #define UART_STATE 0x08
134 #define UART_STATE_TRANSIENT_MASK 0x74
135 #define UART_DCD 0x01
136 #define UART_DSR 0x02
137 #define UART_BREAK_ERROR 0x04
138 #define UART_RING 0x08
139 #define UART_FRAME_ERROR 0x10
140 #define UART_PARITY_ERROR 0x20
141 #define UART_OVERRUN_ERROR 0x40
142 #define UART_CTS 0x80
144 /* function prototypes for a PL2303 serial converter */
145 static int pl2303_open (struct usb_serial_port *port, struct file *filp);
146 static void pl2303_close (struct usb_serial_port *port, struct file *filp);
147 static void pl2303_set_termios (struct usb_serial_port *port,
148 struct termios *old);
149 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file,
150 unsigned int cmd, unsigned long arg);
151 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs);
152 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
153 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
154 static int pl2303_write (struct usb_serial_port *port,
155 const unsigned char *buf, int count);
156 static void pl2303_send (struct usb_serial_port *port);
157 static int pl2303_write_room(struct usb_serial_port *port);
158 static int pl2303_chars_in_buffer(struct usb_serial_port *port);
159 static void pl2303_break_ctl(struct usb_serial_port *port,int break_state);
160 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file);
161 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
162 unsigned int set, unsigned int clear);
163 static int pl2303_startup (struct usb_serial *serial);
164 static void pl2303_shutdown (struct usb_serial *serial);
165 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size);
166 static void pl2303_buf_free(struct pl2303_buf *pb);
167 static void pl2303_buf_clear(struct pl2303_buf *pb);
168 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb);
169 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb);
170 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
172 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
176 /* All of the device info needed for the PL2303 SIO serial converter */
177 static struct usb_serial_device_type pl2303_device = {
178 .owner = THIS_MODULE,
180 .id_table = id_table,
181 .num_interrupt_in = NUM_DONT_CARE,
186 .close = pl2303_close,
187 .write = pl2303_write,
188 .ioctl = pl2303_ioctl,
189 .break_ctl = pl2303_break_ctl,
190 .set_termios = pl2303_set_termios,
191 .tiocmget = pl2303_tiocmget,
192 .tiocmset = pl2303_tiocmset,
193 .read_bulk_callback = pl2303_read_bulk_callback,
194 .read_int_callback = pl2303_read_int_callback,
195 .write_bulk_callback = pl2303_write_bulk_callback,
196 .write_room = pl2303_write_room,
197 .chars_in_buffer = pl2303_chars_in_buffer,
198 .attach = pl2303_startup,
199 .shutdown = pl2303_shutdown,
203 type_0, /* don't know the difference between type 0 and */
204 type_1, /* type 1, until someone from prolific tells us... */
205 HX, /* HX version of the pl2303 chip */
208 struct pl2303_private {
210 struct pl2303_buf *buf;
211 int write_urb_in_use;
212 wait_queue_head_t delta_msr_wait;
215 u8 termios_initialized;
216 enum pl2303_type type;
220 static int pl2303_startup (struct usb_serial *serial)
222 struct pl2303_private *priv;
223 enum pl2303_type type = type_0;
226 if (serial->dev->descriptor.bDeviceClass == 0x02)
228 else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
230 else if (serial->dev->descriptor.bDeviceClass == 0x00)
232 else if (serial->dev->descriptor.bDeviceClass == 0xFF)
234 dbg("device type: %d", type);
236 for (i = 0; i < serial->num_ports; ++i) {
237 priv = kmalloc (sizeof (struct pl2303_private), GFP_KERNEL);
240 memset (priv, 0x00, sizeof (struct pl2303_private));
241 spin_lock_init(&priv->lock);
242 priv->buf = pl2303_buf_alloc(PL2303_BUF_SIZE);
243 if (priv->buf == NULL) {
247 init_waitqueue_head(&priv->delta_msr_wait);
249 usb_set_serial_port_data(serial->port[i], priv);
254 for (--i; i>=0; --i) {
255 priv = usb_get_serial_port_data(serial->port[i]);
256 pl2303_buf_free(priv->buf);
258 usb_set_serial_port_data(serial->port[i], NULL);
263 static int set_control_lines (struct usb_device *dev, u8 value)
267 retval = usb_control_msg (dev, usb_sndctrlpipe (dev, 0),
268 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
269 value, 0, NULL, 0, 100);
270 dbg("%s - value = %d, retval = %d", __FUNCTION__, value, retval);
274 static int pl2303_write (struct usb_serial_port *port, const unsigned char *buf, int count)
276 struct pl2303_private *priv = usb_get_serial_port_data(port);
279 dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count);
284 spin_lock_irqsave(&priv->lock, flags);
285 count = pl2303_buf_put(priv->buf, buf, count);
286 spin_unlock_irqrestore(&priv->lock, flags);
293 static void pl2303_send(struct usb_serial_port *port)
296 struct pl2303_private *priv = usb_get_serial_port_data(port);
299 dbg("%s - port %d", __FUNCTION__, port->number);
301 spin_lock_irqsave(&priv->lock, flags);
303 if (priv->write_urb_in_use) {
304 spin_unlock_irqrestore(&priv->lock, flags);
308 count = pl2303_buf_get(priv->buf, port->write_urb->transfer_buffer,
309 port->bulk_out_size);
312 spin_unlock_irqrestore(&priv->lock, flags);
316 priv->write_urb_in_use = 1;
318 spin_unlock_irqrestore(&priv->lock, flags);
320 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, port->write_urb->transfer_buffer);
322 port->write_urb->transfer_buffer_length = count;
323 port->write_urb->dev = port->serial->dev;
324 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
326 dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
327 priv->write_urb_in_use = 0;
328 // TODO: reschedule pl2303_send
331 schedule_work(&port->work);
334 static int pl2303_write_room(struct usb_serial_port *port)
336 struct pl2303_private *priv = usb_get_serial_port_data(port);
340 dbg("%s - port %d", __FUNCTION__, port->number);
342 spin_lock_irqsave(&priv->lock, flags);
343 room = pl2303_buf_space_avail(priv->buf);
344 spin_unlock_irqrestore(&priv->lock, flags);
346 dbg("%s - returns %d", __FUNCTION__, room);
350 static int pl2303_chars_in_buffer(struct usb_serial_port *port)
352 struct pl2303_private *priv = usb_get_serial_port_data(port);
356 dbg("%s - port %d", __FUNCTION__, port->number);
358 spin_lock_irqsave(&priv->lock, flags);
359 chars = pl2303_buf_data_avail(priv->buf);
360 spin_unlock_irqrestore(&priv->lock, flags);
362 dbg("%s - returns %d", __FUNCTION__, chars);
366 static void pl2303_set_termios (struct usb_serial_port *port, struct termios *old_termios)
368 struct usb_serial *serial = port->serial;
369 struct pl2303_private *priv = usb_get_serial_port_data(port);
377 dbg("%s - port %d", __FUNCTION__, port->number);
379 if ((!port->tty) || (!port->tty->termios)) {
380 dbg("%s - no tty structures", __FUNCTION__);
384 spin_lock_irqsave(&priv->lock, flags);
385 if (!priv->termios_initialized) {
386 *(port->tty->termios) = tty_std_termios;
387 port->tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
388 priv->termios_initialized = 1;
390 spin_unlock_irqrestore(&priv->lock, flags);
392 cflag = port->tty->termios->c_cflag;
393 /* check that they really want us to change something */
395 if ((cflag == old_termios->c_cflag) &&
396 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
397 dbg("%s - nothing to change...", __FUNCTION__);
402 buf = kmalloc (7, GFP_KERNEL);
404 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
407 memset (buf, 0x00, 0x07);
409 i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
410 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
412 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
413 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
417 switch (cflag & CSIZE) {
418 case CS5: buf[6] = 5; break;
419 case CS6: buf[6] = 6; break;
420 case CS7: buf[6] = 7; break;
422 case CS8: buf[6] = 8; break;
424 dbg("%s - data bits = %d", __FUNCTION__, buf[6]);
428 switch (cflag & CBAUD) {
429 case B0: baud = 0; break;
430 case B75: baud = 75; break;
431 case B150: baud = 150; break;
432 case B300: baud = 300; break;
433 case B600: baud = 600; break;
434 case B1200: baud = 1200; break;
435 case B1800: baud = 1800; break;
436 case B2400: baud = 2400; break;
437 case B4800: baud = 4800; break;
438 case B9600: baud = 9600; break;
439 case B19200: baud = 19200; break;
440 case B38400: baud = 38400; break;
441 case B57600: baud = 57600; break;
442 case B115200: baud = 115200; break;
443 case B230400: baud = 230400; break;
444 case B460800: baud = 460800; break;
446 dev_err(&port->dev, "pl2303 driver does not support the baudrate requested (fix it)\n");
449 dbg("%s - baud = %d", __FUNCTION__, baud);
451 buf[0] = baud & 0xff;
452 buf[1] = (baud >> 8) & 0xff;
453 buf[2] = (baud >> 16) & 0xff;
454 buf[3] = (baud >> 24) & 0xff;
457 /* For reference buf[4]=0 is 1 stop bits */
458 /* For reference buf[4]=1 is 1.5 stop bits */
459 /* For reference buf[4]=2 is 2 stop bits */
460 if (cflag & CSTOPB) {
462 dbg("%s - stop bits = 2", __FUNCTION__);
465 dbg("%s - stop bits = 1", __FUNCTION__);
468 if (cflag & PARENB) {
469 /* For reference buf[5]=0 is none parity */
470 /* For reference buf[5]=1 is odd parity */
471 /* For reference buf[5]=2 is even parity */
472 /* For reference buf[5]=3 is mark parity */
473 /* For reference buf[5]=4 is space parity */
474 if (cflag & PARODD) {
476 dbg("%s - parity = odd", __FUNCTION__);
479 dbg("%s - parity = even", __FUNCTION__);
483 dbg("%s - parity = none", __FUNCTION__);
486 i = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
487 SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
489 dbg ("0x21:0x20:0:0 %d", i);
491 /* change control lines if we are switching to or from B0 */
492 spin_lock_irqsave(&priv->lock, flags);
493 control = priv->line_control;
494 if ((cflag & CBAUD) == B0)
495 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
497 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
498 if (control != priv->line_control) {
499 control = priv->line_control;
500 spin_unlock_irqrestore(&priv->lock, flags);
501 set_control_lines(serial->dev, control);
503 spin_unlock_irqrestore(&priv->lock, flags);
506 buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;
508 i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
509 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
511 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
512 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
514 if (cflag & CRTSCTS) {
516 if (priv->type == HX)
520 i = usb_control_msg(serial->dev,
521 usb_sndctrlpipe(serial->dev, 0),
522 VENDOR_WRITE_REQUEST,
523 VENDOR_WRITE_REQUEST_TYPE,
524 0x0, index, NULL, 0, 100);
525 dbg ("0x40:0x1:0x0:0x%x %d", index, i);
531 static int pl2303_open (struct usb_serial_port *port, struct file *filp)
533 struct termios tmp_termios;
534 struct usb_serial *serial = port->serial;
535 struct pl2303_private *priv = usb_get_serial_port_data(port);
539 dbg("%s - port %d", __FUNCTION__, port->number);
541 if (priv->type != HX) {
542 usb_clear_halt(serial->dev, port->write_urb->pipe);
543 usb_clear_halt(serial->dev, port->read_urb->pipe);
546 buf = kmalloc(10, GFP_KERNEL);
550 #define FISH(a,b,c,d) \
551 result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0), \
552 b, a, c, d, buf, 1, 100); \
553 dbg("0x%x:0x%x:0x%x:0x%x %d - %x",a,b,c,d,result,buf[0]);
555 #define SOUP(a,b,c,d) \
556 result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0), \
557 b, a, c, d, NULL, 0, 100); \
558 dbg("0x%x:0x%x:0x%x:0x%x %d",a,b,c,d,result);
560 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
561 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 0);
562 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
563 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
564 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
565 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 1);
566 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
567 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
568 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0, 1);
569 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 1, 0);
571 if (priv->type == HX) {
573 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x44);
574 /* reset upstream data pipes */
575 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 8, 0);
576 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 9, 0);
578 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x24);
585 pl2303_set_termios (port, &tmp_termios);
588 //FIXME: need to assert RTS and DTR if CRTSCTS off
590 dbg("%s - submitting read urb", __FUNCTION__);
591 port->read_urb->dev = serial->dev;
592 result = usb_submit_urb (port->read_urb, GFP_KERNEL);
594 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
595 pl2303_close (port, NULL);
599 dbg("%s - submitting interrupt urb", __FUNCTION__);
600 port->interrupt_in_urb->dev = serial->dev;
601 result = usb_submit_urb (port->interrupt_in_urb, GFP_KERNEL);
603 dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n", __FUNCTION__, result);
604 pl2303_close (port, NULL);
611 static void pl2303_close (struct usb_serial_port *port, struct file *filp)
613 struct pl2303_private *priv = usb_get_serial_port_data(port);
615 unsigned int c_cflag;
620 dbg("%s - port %d", __FUNCTION__, port->number);
622 /* wait for data to drain from the buffer */
623 spin_lock_irqsave(&priv->lock, flags);
624 timeout = PL2303_CLOSING_WAIT;
625 init_waitqueue_entry(&wait, current);
626 add_wait_queue(&port->tty->write_wait, &wait);
628 set_current_state(TASK_INTERRUPTIBLE);
629 if (pl2303_buf_data_avail(priv->buf) == 0
630 || timeout == 0 || signal_pending(current)
631 || !usb_get_intfdata(port->serial->interface)) /* disconnect */
633 spin_unlock_irqrestore(&priv->lock, flags);
634 timeout = schedule_timeout(timeout);
635 spin_lock_irqsave(&priv->lock, flags);
637 set_current_state(TASK_RUNNING);
638 remove_wait_queue(&port->tty->write_wait, &wait);
639 /* clear out any remaining data in the buffer */
640 pl2303_buf_clear(priv->buf);
641 spin_unlock_irqrestore(&priv->lock, flags);
643 /* wait for characters to drain from the device */
644 /* (this is long enough for the entire 256 byte */
645 /* pl2303 hardware buffer to drain with no flow */
646 /* control for data rates of 1200 bps or more, */
647 /* for lower rates we should really know how much */
648 /* data is in the buffer to compute a delay */
649 /* that is not unnecessarily long) */
650 bps = tty_get_baud_rate(port->tty);
652 timeout = max((HZ*2560)/bps,HZ/10);
655 schedule_timeout_interruptible(timeout);
657 /* shutdown our urbs */
658 dbg("%s - shutting down urbs", __FUNCTION__);
659 usb_kill_urb(port->write_urb);
660 usb_kill_urb(port->read_urb);
661 usb_kill_urb(port->interrupt_in_urb);
664 c_cflag = port->tty->termios->c_cflag;
665 if (c_cflag & HUPCL) {
666 /* drop DTR and RTS */
667 spin_lock_irqsave(&priv->lock, flags);
668 priv->line_control = 0;
669 spin_unlock_irqrestore (&priv->lock, flags);
670 set_control_lines (port->serial->dev, 0);
675 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
676 unsigned int set, unsigned int clear)
678 struct pl2303_private *priv = usb_get_serial_port_data(port);
682 if (!usb_get_intfdata(port->serial->interface))
685 spin_lock_irqsave (&priv->lock, flags);
687 priv->line_control |= CONTROL_RTS;
689 priv->line_control |= CONTROL_DTR;
690 if (clear & TIOCM_RTS)
691 priv->line_control &= ~CONTROL_RTS;
692 if (clear & TIOCM_DTR)
693 priv->line_control &= ~CONTROL_DTR;
694 control = priv->line_control;
695 spin_unlock_irqrestore (&priv->lock, flags);
697 return set_control_lines (port->serial->dev, control);
700 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file)
702 struct pl2303_private *priv = usb_get_serial_port_data(port);
708 dbg("%s (%d)", __FUNCTION__, port->number);
710 if (!usb_get_intfdata(port->serial->interface))
713 spin_lock_irqsave (&priv->lock, flags);
714 mcr = priv->line_control;
715 status = priv->line_status;
716 spin_unlock_irqrestore (&priv->lock, flags);
718 result = ((mcr & CONTROL_DTR) ? TIOCM_DTR : 0)
719 | ((mcr & CONTROL_RTS) ? TIOCM_RTS : 0)
720 | ((status & UART_CTS) ? TIOCM_CTS : 0)
721 | ((status & UART_DSR) ? TIOCM_DSR : 0)
722 | ((status & UART_RING) ? TIOCM_RI : 0)
723 | ((status & UART_DCD) ? TIOCM_CD : 0);
725 dbg("%s - result = %x", __FUNCTION__, result);
730 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
732 struct pl2303_private *priv = usb_get_serial_port_data(port);
734 unsigned int prevstatus;
736 unsigned int changed;
738 spin_lock_irqsave (&priv->lock, flags);
739 prevstatus = priv->line_status;
740 spin_unlock_irqrestore (&priv->lock, flags);
743 interruptible_sleep_on(&priv->delta_msr_wait);
744 /* see if a signal did it */
745 if (signal_pending(current))
748 spin_lock_irqsave (&priv->lock, flags);
749 status = priv->line_status;
750 spin_unlock_irqrestore (&priv->lock, flags);
752 changed=prevstatus^status;
754 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
755 ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
756 ((arg & TIOCM_CD) && (changed & UART_DCD)) ||
757 ((arg & TIOCM_CTS) && (changed & UART_CTS)) ) {
766 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file, unsigned int cmd, unsigned long arg)
768 dbg("%s (%d) cmd = 0x%04x", __FUNCTION__, port->number, cmd);
772 dbg("%s (%d) TIOCMIWAIT", __FUNCTION__, port->number);
773 return wait_modem_info(port, arg);
776 dbg("%s not supported = 0x%04x", __FUNCTION__, cmd);
783 static void pl2303_break_ctl (struct usb_serial_port *port, int break_state)
785 struct usb_serial *serial = port->serial;
789 dbg("%s - port %d", __FUNCTION__, port->number);
791 if (break_state == 0)
795 dbg("%s - turning break %s", __FUNCTION__, state==BREAK_OFF ? "off" : "on");
797 result = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
798 BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
801 dbg("%s - error sending break = %d", __FUNCTION__, result);
805 static void pl2303_shutdown (struct usb_serial *serial)
808 struct pl2303_private *priv;
810 dbg("%s", __FUNCTION__);
812 for (i = 0; i < serial->num_ports; ++i) {
813 priv = usb_get_serial_port_data(serial->port[i]);
815 pl2303_buf_free(priv->buf);
817 usb_set_serial_port_data(serial->port[i], NULL);
822 static void pl2303_update_line_status(struct usb_serial_port *port,
824 unsigned int actual_length)
827 struct pl2303_private *priv = usb_get_serial_port_data(port);
829 u8 status_idx = UART_STATE;
830 u8 length = UART_STATE;
832 if ((le16_to_cpu(port->serial->dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
833 (le16_to_cpu(port->serial->dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_X65)) {
838 if (actual_length < length)
841 /* Save off the uart status for others to look at */
842 spin_lock_irqsave(&priv->lock, flags);
843 priv->line_status = data[status_idx];
844 spin_unlock_irqrestore(&priv->lock, flags);
850 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs)
852 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
853 unsigned char *data = urb->transfer_buffer;
854 unsigned int actual_length = urb->actual_length;
857 dbg("%s (%d)", __FUNCTION__, port->number);
859 switch (urb->status) {
866 /* this urb is terminated, clean up */
867 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
870 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
874 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
875 pl2303_update_line_status(port, data, actual_length);
878 status = usb_submit_urb (urb, GFP_ATOMIC);
880 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed with result %d\n",
881 __FUNCTION__, status);
885 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
887 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
888 struct pl2303_private *priv = usb_get_serial_port_data(port);
889 struct tty_struct *tty;
890 unsigned char *data = urb->transfer_buffer;
897 dbg("%s - port %d", __FUNCTION__, port->number);
900 dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
901 if (!port->open_count) {
902 dbg("%s - port is closed, exiting.", __FUNCTION__);
905 if (urb->status == -EPROTO) {
906 /* PL2303 mysteriously fails with -EPROTO reschedule the read */
907 dbg("%s - caught -EPROTO, resubmitting the urb", __FUNCTION__);
909 urb->dev = port->serial->dev;
910 result = usb_submit_urb(urb, GFP_ATOMIC);
912 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
915 dbg("%s - unable to handle the error, exiting.", __FUNCTION__);
919 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
921 /* get tty_flag from status */
922 tty_flag = TTY_NORMAL;
924 spin_lock_irqsave(&priv->lock, flags);
925 status = priv->line_status;
926 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
927 spin_unlock_irqrestore(&priv->lock, flags);
928 wake_up_interruptible (&priv->delta_msr_wait);
930 /* break takes precedence over parity, */
931 /* which takes precedence over framing errors */
932 if (status & UART_BREAK_ERROR )
933 tty_flag = TTY_BREAK;
934 else if (status & UART_PARITY_ERROR)
935 tty_flag = TTY_PARITY;
936 else if (status & UART_FRAME_ERROR)
937 tty_flag = TTY_FRAME;
938 dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag);
941 if (tty && urb->actual_length) {
942 /* overrun is special, not associated with a char */
943 if (status & UART_OVERRUN_ERROR)
944 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
946 for (i = 0; i < urb->actual_length; ++i) {
947 if (tty->flip.count >= TTY_FLIPBUF_SIZE) {
948 tty_flip_buffer_push(tty);
950 tty_insert_flip_char (tty, data[i], tty_flag);
952 tty_flip_buffer_push (tty);
955 /* Schedule the next read _if_ we are still open */
956 if (port->open_count) {
957 urb->dev = port->serial->dev;
958 result = usb_submit_urb(urb, GFP_ATOMIC);
960 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
968 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
970 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
971 struct pl2303_private *priv = usb_get_serial_port_data(port);
974 dbg("%s - port %d", __FUNCTION__, port->number);
976 switch (urb->status) {
983 /* this urb is terminated, clean up */
984 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
985 priv->write_urb_in_use = 0;
988 /* error in the urb, so we have to resubmit it */
989 dbg("%s - Overflow in write", __FUNCTION__);
990 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
991 port->write_urb->transfer_buffer_length = 1;
992 port->write_urb->dev = port->serial->dev;
993 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
995 dev_err(&urb->dev->dev, "%s - failed resubmitting write urb, error %d\n", __FUNCTION__, result);
1000 priv->write_urb_in_use = 0;
1002 /* send any buffered data */
1010 * Allocate a circular buffer and all associated memory.
1013 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size)
1016 struct pl2303_buf *pb;
1022 pb = (struct pl2303_buf *)kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL);
1026 pb->buf_buf = kmalloc(size, GFP_KERNEL);
1027 if (pb->buf_buf == NULL) {
1032 pb->buf_size = size;
1033 pb->buf_get = pb->buf_put = pb->buf_buf;
1043 * Free the buffer and all associated memory.
1046 static void pl2303_buf_free(struct pl2303_buf *pb)
1058 * Clear out all data in the circular buffer.
1061 static void pl2303_buf_clear(struct pl2303_buf *pb)
1064 pb->buf_get = pb->buf_put;
1065 /* equivalent to a get of all data available */
1070 * pl2303_buf_data_avail
1072 * Return the number of bytes of data available in the circular
1076 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb)
1079 return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size);
1086 * pl2303_buf_space_avail
1088 * Return the number of bytes of space available in the circular
1092 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb)
1095 return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size);
1104 * Copy data data from a user buffer and put it into the circular buffer.
1105 * Restrict to the amount of space available.
1107 * Return the number of bytes copied.
1110 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
1120 len = pl2303_buf_space_avail(pb);
1127 len = pb->buf_buf + pb->buf_size - pb->buf_put;
1129 memcpy(pb->buf_put, buf, len);
1130 memcpy(pb->buf_buf, buf+len, count - len);
1131 pb->buf_put = pb->buf_buf + count - len;
1133 memcpy(pb->buf_put, buf, count);
1135 pb->buf_put += count;
1136 else /* count == len */
1137 pb->buf_put = pb->buf_buf;
1148 * Get data from the circular buffer and copy to the given buffer.
1149 * Restrict to the amount of data available.
1151 * Return the number of bytes copied.
1154 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
1164 len = pl2303_buf_data_avail(pb);
1171 len = pb->buf_buf + pb->buf_size - pb->buf_get;
1173 memcpy(buf, pb->buf_get, len);
1174 memcpy(buf+len, pb->buf_buf, count - len);
1175 pb->buf_get = pb->buf_buf + count - len;
1177 memcpy(buf, pb->buf_get, count);
1179 pb->buf_get += count;
1180 else /* count == len */
1181 pb->buf_get = pb->buf_buf;
1188 static int __init pl2303_init (void)
1191 retval = usb_serial_register(&pl2303_device);
1193 goto failed_usb_serial_register;
1194 retval = usb_register(&pl2303_driver);
1196 goto failed_usb_register;
1197 info(DRIVER_DESC " " DRIVER_VERSION);
1199 failed_usb_register:
1200 usb_serial_deregister(&pl2303_device);
1201 failed_usb_serial_register:
1206 static void __exit pl2303_exit (void)
1208 usb_deregister (&pl2303_driver);
1209 usb_serial_deregister (&pl2303_device);
1213 module_init(pl2303_init);
1214 module_exit(pl2303_exit);
1216 MODULE_DESCRIPTION(DRIVER_DESC);
1217 MODULE_VERSION(DRIVER_VERSION);
1218 MODULE_LICENSE("GPL");
1220 module_param(debug, bool, S_IRUGO | S_IWUSR);
1221 MODULE_PARM_DESC(debug, "Debug enabled or not");